Data Model Schema
TODO: explain what this page contains
Account
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AccountId |
metadata | Metadata |
AccountEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Created | Account | 0 |
Deleted | AccountId | 1 |
Asset | AssetEvent | 2 |
PermissionAdded | AccountPermissionChanged | 3 |
PermissionRemoved | AccountPermissionChanged | 4 |
RoleGranted | AccountRoleChanged | 5 |
RoleRevoked | AccountRoleChanged | 6 |
MetadataInserted | MetadataChanged<AccountId> | 7 |
MetadataRemoved | MetadataChanged<AccountId> | 8 |
AccountEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id_matcher | Option<AccountId> |
event_set | AccountEventSet |
AccountEventSet
Type: Bitmap
Repr: u32
Masks:
| Field name | Field value |
|---|---|
Created | 0x1 |
Deleted | 0x2 |
AnyAsset | 0x4 |
PermissionAdded | 0x8 |
PermissionRemoved | 0x10 |
RoleGranted | 0x20 |
RoleRevoked | 0x40 |
MetadataInserted | 0x80 |
MetadataRemoved | 0x100 |
AccountId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
domain | DomainId |
signatory | PublicKey |
AccountIdPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Equals | AccountId | 0 |
DomainId | DomainIdPredicateBox | 1 |
Signatory | PublicKeyPredicateBox | 2 |
AccountPermissionChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
account | AccountId |
permission | Permission |
AccountPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Id | AccountIdPredicateBox | 0 |
Metadata | MetadataPredicateBox | 1 |
AccountRoleChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
account | AccountId |
role | RoleId |
Action
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
executable | Executable |
repeats | Repeats |
authority | AccountId |
filter | EventFilterBox |
metadata | Metadata |
Algorithm
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Ed25519 | — | 0 |
Secp256k1 | — | 1 |
BlsNormal | — | 2 |
BlsSmall | — | 3 |
Array<u8, 32>
Type: Array
Length: 32
Value: u8
Asset
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AssetId |
value | AssetValue |
AssetChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset | AssetId |
amount | AssetValue |
AssetDefinition
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AssetDefinitionId |
type | AssetType |
mintable | Mintable |
logo | Option<IpfsPath> |
metadata | Metadata |
owned_by | AccountId |
total_quantity | Numeric |
AssetDefinitionEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Created | AssetDefinition | 0 |
Deleted | AssetDefinitionId | 1 |
MetadataInserted | MetadataChanged<AssetDefinitionId> | 2 |
MetadataRemoved | MetadataChanged<AssetDefinitionId> | 3 |
MintabilityChanged | AssetDefinitionId | 4 |
TotalQuantityChanged | AssetDefinitionTotalQuantityChanged | 5 |
OwnerChanged | AssetDefinitionOwnerChanged | 6 |
AssetDefinitionEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id_matcher | Option<AssetDefinitionId> |
event_set | AssetDefinitionEventSet |
AssetDefinitionEventSet
Type: Bitmap
Repr: u32
Masks:
| Field name | Field value |
|---|---|
Created | 0x1 |
Deleted | 0x2 |
MetadataInserted | 0x4 |
MetadataRemoved | 0x8 |
MintabilityChanged | 0x10 |
TotalQuantityChanged | 0x20 |
OwnerChanged | 0x40 |
AssetDefinitionId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
domain | DomainId |
name | Name |
AssetDefinitionIdPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Equals | AssetDefinitionId | 0 |
DomainId | DomainIdPredicateBox | 1 |
Name | StringPredicateBox | 2 |
AssetDefinitionOwnerChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset_definition | AssetDefinitionId |
new_owner | AccountId |
AssetDefinitionPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Id | AssetDefinitionIdPredicateBox | 0 |
Metadata | MetadataPredicateBox | 1 |
OwnedBy | AccountIdPredicateBox | 2 |
AssetDefinitionTotalQuantityChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset_definition | AssetDefinitionId |
total_amount | Numeric |
AssetEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Created | Asset | 0 |
Deleted | AssetId | 1 |
Added | AssetChanged | 2 |
Removed | AssetChanged | 3 |
MetadataInserted | MetadataChanged<AssetId> | 4 |
MetadataRemoved | MetadataChanged<AssetId> | 5 |
AssetEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id_matcher | Option<AssetId> |
event_set | AssetEventSet |
AssetEventSet
Type: Bitmap
Repr: u32
Masks:
| Field name | Field value |
|---|---|
Created | 0x1 |
Deleted | 0x2 |
Added | 0x4 |
Removed | 0x8 |
MetadataInserted | 0x10 |
MetadataRemoved | 0x20 |
AssetId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
account | AccountId |
definition | AssetDefinitionId |
AssetIdPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Equals | AssetId | 0 |
DefinitionId | AssetDefinitionIdPredicateBox | 1 |
AccountId | AccountIdPredicateBox | 2 |
AssetPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Id | AssetIdPredicateBox | 0 |
Value | AssetValuePredicateBox | 1 |
AssetTransferBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Numeric | Transfer<Asset, Numeric, Account> | 0 |
Store | Transfer<Asset, Metadata, Account> | 1 |
AssetType
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Numeric | NumericSpec | 0 |
Store | — | 1 |
AssetValue
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Numeric | Numeric | 0 |
Store | Metadata | 1 |
AssetValuePredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|
BlockEvent
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
header | BlockHeader |
status | BlockStatus |
BlockEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
height | Option<NonZero<u64>> |
status | Option<BlockStatus> |
BlockHashPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Equals | HashOf<BlockHeader> | 0 |
BlockHeader
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
height | NonZero<u64> |
prev_block_hash | Option<HashOf<BlockHeader>> |
transactions_hash | HashOf<MerkleTree<SignedTransaction>> |
creation_time_ms | u64 |
view_change_index | u32 |
BlockHeaderPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Hash | BlockHashPredicateBox | 0 |
BlockMessage
Type: Alias
To: SignedBlock
BlockParameter
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
MaxTransactions | NonZero<u64> | 0 |
BlockParameters
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
max_transactions | NonZero<u64> |
BlockPayload
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
header | BlockHeader |
transactions | Vec<SignedTransaction> |
BlockRejectionReason
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
ConsensusBlockRejection | — | 0 |
BlockSignature
Type: Tuple
Values: (u64, SignatureOf<BlockHeader>)
BlockStatus
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Created | — | 0 |
Approved | — | 1 |
Rejected | BlockRejectionReason | 2 |
Committed | — | 3 |
Applied | — | 4 |
BlockSubscriptionRequest
Type: Alias
To: NonZero<u64>
Burn<Numeric, Asset>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | Numeric |
destination | AssetId |
Burn<u32, Trigger>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | u32 |
destination | TriggerId |
BurnBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Asset | Burn<Numeric, Asset> | 0 |
TriggerRepetitions | Burn<u32, Trigger> | 1 |
CanBurnAsset
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset | AssetId |
CanExecuteTrigger
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
trigger | TriggerId |
CanManagePeers
Type: Zero-Size Type (unit type, null type)
CanManageRoles
Type: Zero-Size Type (unit type, null type)
CanMintAsset
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset | AssetId |
CanModifyAccountMetadata
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
account | AccountId |
CanModifyAssetDefinitionMetadata
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset_definition | AssetDefinitionId |
CanModifyAssetMetadata
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset | AssetId |
CanModifyDomainMetadata
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
domain | DomainId |
CanModifyTrigger
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
trigger | TriggerId |
CanModifyTriggerMetadata
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
trigger | TriggerId |
CanRegisterAccount
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
domain | DomainId |
CanRegisterAnyTrigger
Type: Zero-Size Type (unit type, null type)
CanRegisterAsset
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
owner | AccountId |
CanRegisterAssetDefinition
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
domain | DomainId |
CanRegisterAssetWithDefinition
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset_definition | AssetDefinitionId |
CanRegisterTrigger
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
authority | AccountId |
CanSetParameters
Type: Zero-Size Type (unit type, null type)
CanTransferAsset
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset | AssetId |
CanTransferAssetWithDefinition
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset_definition | AssetDefinitionId |
CanUnregisterAccount
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
account | AccountId |
CanUnregisterAnyTrigger
Type: Zero-Size Type (unit type, null type)
CanUnregisterAsset
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset | AssetId |
CanUnregisterAssetDefinition
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset_definition | AssetDefinitionId |
CanUnregisterAssetWithDefinition
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset_definition | AssetDefinitionId |
CanUnregisterDomain
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
domain | DomainId |
CanUnregisterTrigger
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
trigger | TriggerId |
CanUpgradeExecutor
Type: Zero-Size Type (unit type, null type)
ChainId
Type: Alias
To: String
CommittedTransaction
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
block_hash | HashOf<BlockHeader> |
value | SignedTransaction |
error | Option<TransactionRejectionReason> |
CommittedTransactionPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
BlockHash | BlockHashPredicateBox | 0 |
Value | SignedTransactionPredicateBox | 1 |
Error | TransactionErrorPredicateBox | 2 |
Compact<u128>
Type: Int
Kind: Compact
Compact<u32>
Type: Int
Kind: Compact
CompoundPredicate<AccountPredicateBox>
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Atom | AccountPredicateBox | 0 |
Not | CompoundPredicate<AccountPredicateBox> | 1 |
And | Vec<CompoundPredicate<AccountPredicateBox>> | 2 |
Or | Vec<CompoundPredicate<AccountPredicateBox>> | 3 |
CompoundPredicate<AssetDefinitionPredicateBox>
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Atom | AssetDefinitionPredicateBox | 0 |
Not | CompoundPredicate<AssetDefinitionPredicateBox> | 1 |
And | Vec<CompoundPredicate<AssetDefinitionPredicateBox>> | 2 |
Or | Vec<CompoundPredicate<AssetDefinitionPredicateBox>> | 3 |
CompoundPredicate<AssetPredicateBox>
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Atom | AssetPredicateBox | 0 |
Not | CompoundPredicate<AssetPredicateBox> | 1 |
And | Vec<CompoundPredicate<AssetPredicateBox>> | 2 |
Or | Vec<CompoundPredicate<AssetPredicateBox>> | 3 |
CompoundPredicate<BlockHeaderPredicateBox>
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Atom | BlockHeaderPredicateBox | 0 |
Not | CompoundPredicate<BlockHeaderPredicateBox> | 1 |
And | Vec<CompoundPredicate<BlockHeaderPredicateBox>> | 2 |
Or | Vec<CompoundPredicate<BlockHeaderPredicateBox>> | 3 |
CompoundPredicate<CommittedTransactionPredicateBox>
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Atom | CommittedTransactionPredicateBox | 0 |
Not | CompoundPredicate<CommittedTransactionPredicateBox> | 1 |
And | Vec<CompoundPredicate<CommittedTransactionPredicateBox>> | 2 |
Or | Vec<CompoundPredicate<CommittedTransactionPredicateBox>> | 3 |
CompoundPredicate<DomainPredicateBox>
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Atom | DomainPredicateBox | 0 |
Not | CompoundPredicate<DomainPredicateBox> | 1 |
And | Vec<CompoundPredicate<DomainPredicateBox>> | 2 |
Or | Vec<CompoundPredicate<DomainPredicateBox>> | 3 |
CompoundPredicate<PeerPredicateBox>
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Atom | PeerPredicateBox | 0 |
Not | CompoundPredicate<PeerPredicateBox> | 1 |
And | Vec<CompoundPredicate<PeerPredicateBox>> | 2 |
Or | Vec<CompoundPredicate<PeerPredicateBox>> | 3 |
CompoundPredicate<PermissionPredicateBox>
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Atom | PermissionPredicateBox | 0 |
Not | CompoundPredicate<PermissionPredicateBox> | 1 |
And | Vec<CompoundPredicate<PermissionPredicateBox>> | 2 |
Or | Vec<CompoundPredicate<PermissionPredicateBox>> | 3 |
CompoundPredicate<RoleIdPredicateBox>
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Atom | RoleIdPredicateBox | 0 |
Not | CompoundPredicate<RoleIdPredicateBox> | 1 |
And | Vec<CompoundPredicate<RoleIdPredicateBox>> | 2 |
Or | Vec<CompoundPredicate<RoleIdPredicateBox>> | 3 |
CompoundPredicate<RolePredicateBox>
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Atom | RolePredicateBox | 0 |
Not | CompoundPredicate<RolePredicateBox> | 1 |
And | Vec<CompoundPredicate<RolePredicateBox>> | 2 |
Or | Vec<CompoundPredicate<RolePredicateBox>> | 3 |
CompoundPredicate<SignedBlockPredicateBox>
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Atom | SignedBlockPredicateBox | 0 |
Not | CompoundPredicate<SignedBlockPredicateBox> | 1 |
And | Vec<CompoundPredicate<SignedBlockPredicateBox>> | 2 |
Or | Vec<CompoundPredicate<SignedBlockPredicateBox>> | 3 |
CompoundPredicate<TriggerIdPredicateBox>
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Atom | TriggerIdPredicateBox | 0 |
Not | CompoundPredicate<TriggerIdPredicateBox> | 1 |
And | Vec<CompoundPredicate<TriggerIdPredicateBox>> | 2 |
Or | Vec<CompoundPredicate<TriggerIdPredicateBox>> | 3 |
CompoundPredicate<TriggerPredicateBox>
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Atom | TriggerPredicateBox | 0 |
Not | CompoundPredicate<TriggerPredicateBox> | 1 |
And | Vec<CompoundPredicate<TriggerPredicateBox>> | 2 |
Or | Vec<CompoundPredicate<TriggerPredicateBox>> | 3 |
ConfigurationEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Changed | ParameterChanged | 0 |
ConfigurationEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
event_set | ConfigurationEventSet |
ConfigurationEventSet
Type: Bitmap
Repr: u32
Masks:
| Field name | Field value |
|---|---|
Changed | 0x1 |
CustomInstruction
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
payload | Json |
CustomParameter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | CustomParameterId |
payload | Json |
CustomParameterId
Type: Alias
To: Name
DataEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Peer | PeerEvent | 0 |
Domain | DomainEvent | 1 |
Trigger | TriggerEvent | 2 |
Role | RoleEvent | 3 |
Configuration | ConfigurationEvent | 4 |
Executor | ExecutorEvent | 5 |
DataEventFilter
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Any | — | 0 |
Peer | PeerEventFilter | 1 |
Domain | DomainEventFilter | 2 |
Account | AccountEventFilter | 3 |
Asset | AssetEventFilter | 4 |
AssetDefinition | AssetDefinitionEventFilter | 5 |
Trigger | TriggerEventFilter | 6 |
Role | RoleEventFilter | 7 |
Configuration | ConfigurationEventFilter | 8 |
Executor | ExecutorEventFilter | 9 |
Domain
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | DomainId |
logo | Option<IpfsPath> |
metadata | Metadata |
owned_by | AccountId |
DomainEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Created | Domain | 0 |
Deleted | DomainId | 1 |
AssetDefinition | AssetDefinitionEvent | 2 |
Account | AccountEvent | 3 |
MetadataInserted | MetadataChanged<DomainId> | 4 |
MetadataRemoved | MetadataChanged<DomainId> | 5 |
OwnerChanged | DomainOwnerChanged | 6 |
DomainEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id_matcher | Option<DomainId> |
event_set | DomainEventSet |
DomainEventSet
Type: Bitmap
Repr: u32
Masks:
| Field name | Field value |
|---|---|
Created | 0x1 |
Deleted | 0x2 |
AnyAssetDefinition | 0x4 |
AnyAccount | 0x8 |
MetadataInserted | 0x10 |
MetadataRemoved | 0x20 |
OwnerChanged | 0x40 |
DomainId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
name | Name |
DomainIdPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Equals | DomainId | 0 |
Name | StringPredicateBox | 1 |
DomainOwnerChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
domain | DomainId |
new_owner | AccountId |
DomainPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Id | DomainIdPredicateBox | 0 |
Metadata | MetadataPredicateBox | 1 |
EventBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Pipeline | PipelineEventBox | 0 |
Data | DataEvent | 1 |
Time | TimeEvent | 2 |
ExecuteTrigger | ExecuteTriggerEvent | 3 |
TriggerCompleted | TriggerCompletedEvent | 4 |
EventFilterBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Pipeline | PipelineEventFilterBox | 0 |
Data | DataEventFilter | 1 |
Time | TimeEventFilter | 2 |
ExecuteTrigger | ExecuteTriggerEventFilter | 3 |
TriggerCompleted | TriggerCompletedEventFilter | 4 |
EventMessage
Type: Alias
To: EventBox
EventSubscriptionRequest
Type: Alias
Executable
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Instructions | Vec<InstructionBox> | 0 |
Wasm | WasmSmartContract | 1 |
ExecuteTrigger
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
trigger | TriggerId |
args | Json |
ExecuteTriggerEvent
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
trigger_id | TriggerId |
authority | AccountId |
args | Json |
ExecuteTriggerEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
trigger_id | Option<TriggerId> |
authority | Option<AccountId> |
ExecutionTime
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
PreCommit | — | 0 |
Schedule | Schedule | 1 |
Executor
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
wasm | WasmSmartContract |
ExecutorDataModel
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
parameters | SortedMap<CustomParameterId, CustomParameter> |
instructions | SortedVec<String> |
permissions | SortedVec<String> |
schema | Json |
ExecutorEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Upgraded | ExecutorUpgrade | 0 |
ExecutorEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
event_set | ExecutorEventSet |
ExecutorEventSet
Type: Bitmap
Repr: u32
Masks:
| Field name | Field value |
|---|---|
Upgraded | 0x1 |
ExecutorUpgrade
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
new_data_model | ExecutorDataModel |
FetchSize
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
fetch_size | Option<NonZero<u64>> |
FindAccountMetadata
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AccountId |
key | Name |
FindAccounts
Type: Zero-Size Type (unit type, null type)
FindAccountsWithAsset
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset_definition | AssetDefinitionId |
FindActiveTriggerIds
Type: Zero-Size Type (unit type, null type)
FindAssetDefinitionMetadata
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AssetDefinitionId |
key | Name |
FindAssetMetadata
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AssetId |
key | Name |
FindAssetQuantityById
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AssetId |
FindAssets
Type: Zero-Size Type (unit type, null type)
FindAssetsDefinitions
Type: Zero-Size Type (unit type, null type)
FindBlockHeaders
Type: Zero-Size Type (unit type, null type)
FindBlocks
Type: Zero-Size Type (unit type, null type)
FindDomainMetadata
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | DomainId |
key | Name |
FindDomains
Type: Zero-Size Type (unit type, null type)
FindError
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Asset | AssetId | 0 |
AssetDefinition | AssetDefinitionId | 1 |
Account | AccountId | 2 |
Domain | DomainId | 3 |
MetadataKey | Name | 4 |
Block | HashOf<BlockHeader> | 5 |
Transaction | HashOf<SignedTransaction> | 6 |
Peer | PeerId | 7 |
Trigger | TriggerId | 8 |
Role | RoleId | 9 |
Permission | Permission | 10 |
PublicKey | PublicKey | 11 |
FindExecutorDataModel
Type: Zero-Size Type (unit type, null type)
FindParameters
Type: Zero-Size Type (unit type, null type)
FindPeers
Type: Zero-Size Type (unit type, null type)
FindPermissionsByAccountId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AccountId |
FindRoleIds
Type: Zero-Size Type (unit type, null type)
FindRoles
Type: Zero-Size Type (unit type, null type)
FindRolesByAccountId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AccountId |
FindTransactions
Type: Zero-Size Type (unit type, null type)
FindTriggerMetadata
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | TriggerId |
key | Name |
FindTriggers
Type: Zero-Size Type (unit type, null type)
ForwardCursor
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | String |
cursor | NonZero<u64> |
GenesisWasmAction
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
executable | String |
repeats | Repeats |
authority | AccountId |
filter | EventFilterBox |
GenesisWasmTrigger
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | TriggerId |
action | GenesisWasmAction |
Grant<Permission, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | Permission |
destination | AccountId |
Grant<Permission, Role>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | Permission |
destination | RoleId |
Grant<RoleId, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | RoleId |
destination | AccountId |
GrantBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Permission | Grant<Permission, Account> | 0 |
Role | Grant<RoleId, Account> | 1 |
RolePermission | Grant<Permission, Role> | 2 |
Hash
Type: Alias
To: Array<u8, 32>
HashOf<BlockHeader>
Type: Alias
To: Hash
HashOf<MerkleTree<SignedTransaction>>
Type: Alias
To: Hash
HashOf<SignedTransaction>
Type: Alias
To: Hash
HashOf<Vec<InstructionBox>>
Type: Alias
To: Hash
IdBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
DomainId | DomainId | 0 |
AccountId | AccountId | 1 |
AssetDefinitionId | AssetDefinitionId | 2 |
AssetId | AssetId | 3 |
PeerId | PeerId | 4 |
TriggerId | TriggerId | 5 |
RoleId | RoleId | 6 |
Permission | Permission | 7 |
CustomParameterId | CustomParameterId | 8 |
InstructionBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Register | RegisterBox | 0 |
Unregister | UnregisterBox | 1 |
Mint | MintBox | 2 |
Burn | BurnBox | 3 |
Transfer | TransferBox | 4 |
SetKeyValue | SetKeyValueBox | 5 |
RemoveKeyValue | RemoveKeyValueBox | 6 |
Grant | GrantBox | 7 |
Revoke | RevokeBox | 8 |
ExecuteTrigger | ExecuteTrigger | 9 |
SetParameter | SetParameter | 10 |
Upgrade | Upgrade | 11 |
Log | Log | 12 |
Custom | CustomInstruction | 13 |
InstructionEvaluationError
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Unsupported | InstructionType | 0 |
PermissionParameter | String | 1 |
Type | TypeError | 2 |
InstructionExecutionError
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Evaluate | InstructionEvaluationError | 0 |
Query | QueryExecutionFail | 1 |
Conversion | String | 2 |
Find | FindError | 3 |
Repetition | RepetitionError | 4 |
Mintability | MintabilityError | 5 |
Math | MathError | 6 |
InvalidParameter | InvalidParameterError | 7 |
InvariantViolation | String | 8 |
InstructionExecutionFail
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
instruction | InstructionBox |
reason | String |
InstructionType
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Register | — | 0 |
Unregister | — | 1 |
Mint | — | 2 |
Burn | — | 3 |
Transfer | — | 4 |
SetKeyValue | — | 5 |
RemoveKeyValue | — | 6 |
Grant | — | 7 |
Revoke | — | 8 |
ExecuteTrigger | — | 9 |
SetParameter | — | 10 |
Upgrade | — | 11 |
Log | — | 12 |
Custom | — | 13 |
InvalidParameterError
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Wasm | String | 0 |
TimeTriggerInThePast | — | 1 |
IpfsPath
Type: Alias
To: String
Json
Type: Alias
To: String
Level
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
TRACE | — | 0 |
DEBUG | — | 1 |
INFO | — | 2 |
WARN | — | 3 |
ERROR | — | 4 |
Log
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
level | Level |
msg | String |
MathError
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Overflow | — | 0 |
NotEnoughQuantity | — | 1 |
DivideByZero | — | 2 |
NegativeValue | — | 3 |
DomainViolation | — | 4 |
Unknown | — | 5 |
FixedPointConversion | String | 6 |
MerkleTree<SignedTransaction>
Type: Vec
Value: HashOf<SignedTransaction>
Metadata
Type: Alias
MetadataChanged<AccountId>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
target | AccountId |
key | Name |
value | Json |
MetadataChanged<AssetDefinitionId>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
target | AssetDefinitionId |
key | Name |
value | Json |
MetadataChanged<AssetId>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
target | AssetId |
key | Name |
value | Json |
MetadataChanged<DomainId>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
target | DomainId |
key | Name |
value | Json |
MetadataChanged<TriggerId>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
target | TriggerId |
key | Name |
value | Json |
MetadataPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|
Mint<Numeric, Asset>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | Numeric |
destination | AssetId |
Mint<u32, Trigger>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | u32 |
destination | TriggerId |
MintBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Asset | Mint<Numeric, Asset> | 0 |
TriggerRepetitions | Mint<u32, Trigger> | 1 |
MintabilityError
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
MintUnmintable | — | 0 |
ForbidMintOnMintable | — | 1 |
Mintable
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Infinitely | — | 0 |
Once | — | 1 |
Not | — | 2 |
Mismatch<AssetType>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
expected | AssetType |
actual | AssetType |
MultisigAccountArgs
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
account | PublicKey |
signatories | SortedMap<AccountId, u8> |
quorum | u16 |
transaction_ttl_ms | u64 |
MultisigTransactionArgs
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Propose | Vec<InstructionBox> | 0 |
Approve | HashOf<Vec<InstructionBox>> | 1 |
Name
Type: Alias
To: String
NewAccount
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AccountId |
metadata | Metadata |
NewAssetDefinition
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AssetDefinitionId |
type | AssetType |
mintable | Mintable |
logo | Option<IpfsPath> |
metadata | Metadata |
NewDomain
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | DomainId |
logo | Option<IpfsPath> |
metadata | Metadata |
NewRole
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
inner | Role |
grant_to | AccountId |
NonZero<u32>
Type: Alias
To: u32
NonZero<u64>
Type: Alias
To: u64
Numeric
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
mantissa | Compact<u128> |
scale | Compact<u32> |
NumericSpec
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
scale | Option<u32> |
Option<AccountId>
Type: Option
Some: AccountId
Option<AssetDefinitionId>
Type: Option
Some: AssetDefinitionId
Option<AssetId>
Type: Option
Some: AssetId
Option<BlockStatus>
Type: Option
Some: BlockStatus
Option<DomainId>
Type: Option
Some: DomainId
Option<ForwardCursor>
Type: Option
Some: ForwardCursor
Option<HashOf<BlockHeader>>
Type: Option
Some: HashOf<BlockHeader>
Option<HashOf<SignedTransaction>>
Type: Option
Some: HashOf<SignedTransaction>
Option<IpfsPath>
Type: Option
Some: IpfsPath
Option<Name>
Type: Option
Some: Name
Option<NonZero<u32>>
Type: Option
Some: NonZero<u32>
Option<NonZero<u64>>
Type: Option
Some: NonZero<u64>
Option<Option<NonZero<u64>>>
Type: Option
Some: Option<NonZero<u64>>
Option<Parameters>
Type: Option
Some: Parameters
Option<PeerId>
Type: Option
Some: PeerId
Option<RoleId>
Type: Option
Some: RoleId
Option<TransactionRejectionReason>
Type: Option
Some: TransactionRejectionReason
Option<TransactionStatus>
Type: Option
Some: TransactionStatus
Option<TriggerCompletedOutcomeType>
Type: Option
Some: TriggerCompletedOutcomeType
Option<TriggerId>
Type: Option
Some: TriggerId
Option<u32>
Type: Option
Some: u32
Option<u64>
Type: Option
Some: u64
Pagination
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
limit | Option<NonZero<u64>> |
offset | u64 |
Parameter
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Sumeragi | SumeragiParameter | 0 |
Block | BlockParameter | 1 |
Transaction | TransactionParameter | 2 |
SmartContract | SmartContractParameter | 3 |
Executor | SmartContractParameter | 4 |
Custom | CustomParameter | 5 |
ParameterChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
old_value | Parameter |
new_value | Parameter |
Parameters
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
sumeragi | SumeragiParameters |
block | BlockParameters |
transaction | TransactionParameters |
executor | SmartContractParameters |
smart_contract | SmartContractParameters |
custom | SortedMap<CustomParameterId, CustomParameter> |
PeerEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Added | PeerId | 0 |
Removed | PeerId | 1 |
PeerEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id_matcher | Option<PeerId> |
event_set | PeerEventSet |
PeerEventSet
Type: Bitmap
Repr: u32
Masks:
| Field name | Field value |
|---|---|
Added | 0x1 |
Removed | 0x2 |
PeerId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
public_key | PublicKey |
PeerPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|
Permission
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
name | String |
payload | Json |
PermissionPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|
PipelineEventBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Transaction | TransactionEvent | 0 |
Block | BlockEvent | 1 |
PipelineEventFilterBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Transaction | TransactionEventFilter | 0 |
Block | BlockEventFilter | 1 |
PublicKey
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
algorithm | Algorithm |
payload | Vec<u8> |
PublicKeyPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Equals | PublicKey | 0 |
QueryBox
Type: Enum
Variants:
QueryExecutionFail
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Find | FindError | 0 |
Conversion | String | 1 |
NotFound | — | 2 |
CursorMismatch | — | 3 |
CursorDone | — | 4 |
FetchSizeTooBig | — | 5 |
InvalidSingularParameters | — | 6 |
CapacityLimit | — | 7 |
QueryOutput
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
batch | QueryOutputBatchBox |
remaining_items | u64 |
continue_cursor | Option<ForwardCursor> |
QueryOutputBatchBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Domain | Vec<Domain> | 0 |
Account | Vec<Account> | 1 |
Asset | Vec<Asset> | 2 |
AssetDefinition | Vec<AssetDefinition> | 3 |
Role | Vec<Role> | 4 |
Parameter | Vec<Parameter> | 5 |
Permission | Vec<Permission> | 6 |
Transaction | Vec<CommittedTransaction> | 7 |
Peer | Vec<PeerId> | 8 |
RoleId | Vec<RoleId> | 9 |
TriggerId | Vec<TriggerId> | 10 |
Trigger | Vec<Trigger> | 11 |
Block | Vec<SignedBlock> | 12 |
BlockHeader | Vec<BlockHeader> | 13 |
QueryParams
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
pagination | Pagination |
sorting | Sorting |
fetch_size | FetchSize |
QueryRequest
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Singular | SingularQueryBox | 0 |
Start | QueryWithParams | 1 |
Continue | ForwardCursor | 2 |
QueryRequestWithAuthority
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
authority | AccountId |
request | QueryRequest |
QueryResponse
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Singular | SingularQueryOutputBox | 0 |
Iterable | QueryOutput | 1 |
QuerySignature
Type: Alias
To: SignatureOf<QueryRequestWithAuthority>
QueryWithFilter<FindAccounts, AccountPredicateBox>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | FindAccounts |
predicate | CompoundPredicate<AccountPredicateBox> |
QueryWithFilter<FindAccountsWithAsset, AccountPredicateBox>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | FindAccountsWithAsset |
predicate | CompoundPredicate<AccountPredicateBox> |
QueryWithFilter<FindActiveTriggerIds, TriggerIdPredicateBox>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | FindActiveTriggerIds |
predicate | CompoundPredicate<TriggerIdPredicateBox> |
QueryWithFilter<FindAssets, AssetPredicateBox>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | FindAssets |
predicate | CompoundPredicate<AssetPredicateBox> |
QueryWithFilter<FindAssetsDefinitions, AssetDefinitionPredicateBox>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | FindAssetsDefinitions |
predicate | CompoundPredicate<AssetDefinitionPredicateBox> |
QueryWithFilter<FindBlockHeaders, BlockHeaderPredicateBox>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | FindBlockHeaders |
predicate | CompoundPredicate<BlockHeaderPredicateBox> |
QueryWithFilter<FindBlocks, SignedBlockPredicateBox>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | FindBlocks |
predicate | CompoundPredicate<SignedBlockPredicateBox> |
QueryWithFilter<FindDomains, DomainPredicateBox>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | FindDomains |
predicate | CompoundPredicate<DomainPredicateBox> |
QueryWithFilter<FindPeers, PeerPredicateBox>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | FindPeers |
predicate | CompoundPredicate<PeerPredicateBox> |
QueryWithFilter<FindPermissionsByAccountId, PermissionPredicateBox>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | FindPermissionsByAccountId |
predicate | CompoundPredicate<PermissionPredicateBox> |
QueryWithFilter<FindRoleIds, RoleIdPredicateBox>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | FindRoleIds |
predicate | CompoundPredicate<RoleIdPredicateBox> |
QueryWithFilter<FindRoles, RolePredicateBox>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | FindRoles |
predicate | CompoundPredicate<RolePredicateBox> |
QueryWithFilter<FindRolesByAccountId, RoleIdPredicateBox>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | FindRolesByAccountId |
predicate | CompoundPredicate<RoleIdPredicateBox> |
QueryWithFilter<FindTransactions, CommittedTransactionPredicateBox>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | FindTransactions |
predicate | CompoundPredicate<CommittedTransactionPredicateBox> |
QueryWithFilter<FindTriggers, TriggerPredicateBox>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | FindTriggers |
predicate | CompoundPredicate<TriggerPredicateBox> |
QueryWithParams
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query | QueryBox |
params | QueryParams |
RawGenesisTransaction
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
chain | ChainId |
executor | String |
parameters | Option<Parameters> |
instructions | Vec<InstructionBox> |
wasm_dir | String |
wasm_triggers | Vec<GenesisWasmTrigger> |
topology | Vec<PeerId> |
Register<Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | NewAccount |
Register<Asset>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | Asset |
Register<AssetDefinition>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | NewAssetDefinition |
Register<Domain>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | NewDomain |
Register<Peer>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | PeerId |
Register<Role>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | NewRole |
Register<Trigger>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | Trigger |
RegisterBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Peer | Register<Peer> | 0 |
Domain | Register<Domain> | 1 |
Account | Register<Account> | 2 |
AssetDefinition | Register<AssetDefinition> | 3 |
Asset | Register<Asset> | 4 |
Role | Register<Role> | 5 |
Trigger | Register<Trigger> | 6 |
RemoveKeyValue<Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | AccountId |
key | Name |
RemoveKeyValue<Asset>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | AssetId |
key | Name |
RemoveKeyValue<AssetDefinition>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | AssetDefinitionId |
key | Name |
RemoveKeyValue<Domain>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | DomainId |
key | Name |
RemoveKeyValue<Trigger>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | TriggerId |
key | Name |
RemoveKeyValueBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Domain | RemoveKeyValue<Domain> | 0 |
Account | RemoveKeyValue<Account> | 1 |
AssetDefinition | RemoveKeyValue<AssetDefinition> | 2 |
Asset | RemoveKeyValue<Asset> | 3 |
Trigger | RemoveKeyValue<Trigger> | 4 |
Repeats
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Indefinitely | — | 0 |
Exactly | u32 | 1 |
RepetitionError
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
instruction | InstructionType |
id | IdBox |
Revoke<Permission, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | Permission |
destination | AccountId |
Revoke<Permission, Role>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | Permission |
destination | RoleId |
Revoke<RoleId, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | RoleId |
destination | AccountId |
RevokeBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Permission | Revoke<Permission, Account> | 0 |
Role | Revoke<RoleId, Account> | 1 |
RolePermission | Revoke<Permission, Role> | 2 |
Role
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | RoleId |
permissions | SortedVec<Permission> |
RoleEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Created | Role | 0 |
Deleted | RoleId | 1 |
PermissionAdded | RolePermissionChanged | 2 |
PermissionRemoved | RolePermissionChanged | 3 |
RoleEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id_matcher | Option<RoleId> |
event_set | RoleEventSet |
RoleEventSet
Type: Bitmap
Repr: u32
Masks:
| Field name | Field value |
|---|---|
Created | 0x1 |
Deleted | 0x2 |
PermissionAdded | 0x4 |
PermissionRemoved | 0x8 |
RoleId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
name | Name |
RoleIdPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Equals | RoleId | 0 |
Name | StringPredicateBox | 1 |
RolePermissionChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
role | RoleId |
permission | Permission |
RolePredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Id | RoleIdPredicateBox | 0 |
Schedule
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
start_ms | u64 |
period_ms | Option<u64> |
SetKeyValue<Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | AccountId |
key | Name |
value | Json |
SetKeyValue<Asset>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | AssetId |
key | Name |
value | Json |
SetKeyValue<AssetDefinition>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | AssetDefinitionId |
key | Name |
value | Json |
SetKeyValue<Domain>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | DomainId |
key | Name |
value | Json |
SetKeyValue<Trigger>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | TriggerId |
key | Name |
value | Json |
SetKeyValueBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Domain | SetKeyValue<Domain> | 0 |
Account | SetKeyValue<Account> | 1 |
AssetDefinition | SetKeyValue<AssetDefinition> | 2 |
Asset | SetKeyValue<Asset> | 3 |
Trigger | SetKeyValue<Trigger> | 4 |
SetParameter
Type: Alias
To: Parameter
Signature
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
payload | Vec<u8> |
SignatureOf<BlockHeader>
Type: Alias
To: Signature
SignatureOf<QueryRequestWithAuthority>
Type: Alias
To: Signature
SignatureOf<TransactionPayload>
Type: Alias
To: Signature
SignedBlock
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
V1 | SignedBlockV1 | 1 |
SignedBlockPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Header | BlockHeaderPredicateBox | 0 |
SignedBlockV1
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
signatures | Vec<BlockSignature> |
payload | BlockPayload |
errors | SortedMap<u64, TransactionRejectionReason> |
SignedQuery
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
V1 | SignedQueryV1 | 1 |
SignedQueryV1
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
signature | QuerySignature |
payload | QueryRequestWithAuthority |
SignedTransaction
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
V1 | SignedTransactionV1 | 1 |
SignedTransactionPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Hash | TransactionHashPredicateBox | 0 |
Authority | AccountIdPredicateBox | 1 |
SignedTransactionV1
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
signature | TransactionSignature |
payload | TransactionPayload |
SingularQueryBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
FindAssetQuantityById | FindAssetQuantityById | 0 |
FindExecutorDataModel | FindExecutorDataModel | 1 |
FindParameters | FindParameters | 2 |
FindDomainMetadata | FindDomainMetadata | 3 |
FindAccountMetadata | FindAccountMetadata | 4 |
FindAssetMetadata | FindAssetMetadata | 5 |
FindAssetDefinitionMetadata | FindAssetDefinitionMetadata | 6 |
FindTriggerMetadata | FindTriggerMetadata | 7 |
SingularQueryOutputBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Numeric | Numeric | 0 |
ExecutorDataModel | ExecutorDataModel | 1 |
Json | Json | 2 |
Trigger | Trigger | 3 |
Parameters | Parameters | 4 |
Transaction | CommittedTransaction | 5 |
BlockHeader | BlockHeader | 6 |
SmartContractParameter
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Fuel | NonZero<u64> | 0 |
Memory | NonZero<u64> | 1 |
SmartContractParameters
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
fuel | NonZero<u64> |
memory | NonZero<u64> |
SortedMap<AccountId, u8>
Type: Map
Key: AccountId
Value: u8
SortedMap<CustomParameterId, CustomParameter>
Type: Map
Key: CustomParameterId
Value: CustomParameter
SortedMap<Name, Json>
Type: Map
Key: Name
Value: Json
SortedMap<u64, TransactionRejectionReason>
Type: Map
Key: u64
Value: TransactionRejectionReason
SortedVec<Permission>
Type: Vec
Value: Permission
SortedVec<String>
Type: Vec
Value: String
Sorting
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
sort_by_metadata_key | Option<Name> |
String
Type: Alias
To: String
StringPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Equals | String | 0 |
Contains | String | 1 |
StartsWith | String | 2 |
EndsWith | String | 3 |
SumeragiParameter
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
BlockTimeMs | u64 | 0 |
CommitTimeMs | u64 | 1 |
MaxClockDriftMs | u64 | 2 |
SumeragiParameters
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
block_time_ms | u64 |
commit_time_ms | u64 |
max_clock_drift_ms | u64 |
TimeEvent
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
interval | TimeInterval |
TimeEventFilter
Type: Alias
To: ExecutionTime
TimeInterval
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
since_ms | u64 |
length_ms | u64 |
TransactionErrorPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
IsSome | — | 0 |
TransactionEvent
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
hash | HashOf<SignedTransaction> |
block_height | Option<NonZero<u64>> |
status | TransactionStatus |
TransactionEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
hash | Option<HashOf<SignedTransaction>> |
block_height | Option<Option<NonZero<u64>>> |
status | Option<TransactionStatus> |
TransactionHashPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Equals | HashOf<SignedTransaction> | 0 |
TransactionLimitError
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
reason | String |
TransactionParameter
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
MaxInstructions | NonZero<u64> | 0 |
SmartContractSize | NonZero<u64> | 1 |
TransactionParameters
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
max_instructions | NonZero<u64> |
smart_contract_size | NonZero<u64> |
TransactionPayload
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
chain | ChainId |
authority | AccountId |
creation_time_ms | u64 |
instructions | Executable |
time_to_live_ms | Option<NonZero<u64>> |
nonce | Option<NonZero<u32>> |
metadata | Metadata |
TransactionRejectionReason
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
AccountDoesNotExist | FindError | 0 |
LimitCheck | TransactionLimitError | 1 |
Validation | ValidationFail | 2 |
InstructionExecution | InstructionExecutionFail | 3 |
WasmExecution | WasmExecutionFail | 4 |
TransactionSignature
Type: Alias
To: SignatureOf<TransactionPayload>
TransactionStatus
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Queued | — | 0 |
Expired | — | 1 |
Approved | — | 2 |
Rejected | TransactionRejectionReason | 3 |
Transfer<Account, AssetDefinitionId, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
source | AccountId |
object | AssetDefinitionId |
destination | AccountId |
Transfer<Account, DomainId, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
source | AccountId |
object | DomainId |
destination | AccountId |
Transfer<Asset, Metadata, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
source | AssetId |
object | Metadata |
destination | AccountId |
Transfer<Asset, Numeric, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
source | AssetId |
object | Numeric |
destination | AccountId |
TransferBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Domain | Transfer<Account, DomainId, Account> | 0 |
AssetDefinition | Transfer<Account, AssetDefinitionId, Account> | 1 |
Asset | AssetTransferBox | 2 |
Trigger
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | TriggerId |
action | Action |
TriggerCompletedEvent
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
trigger_id | TriggerId |
outcome | TriggerCompletedOutcome |
TriggerCompletedEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
trigger_id | Option<TriggerId> |
outcome_type | Option<TriggerCompletedOutcomeType> |
TriggerCompletedOutcome
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Success | — | 0 |
Failure | String | 1 |
TriggerCompletedOutcomeType
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Success | — | 0 |
Failure | — | 1 |
TriggerEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Created | TriggerId | 0 |
Deleted | TriggerId | 1 |
Extended | TriggerNumberOfExecutionsChanged | 2 |
Shortened | TriggerNumberOfExecutionsChanged | 3 |
MetadataInserted | MetadataChanged<TriggerId> | 4 |
MetadataRemoved | MetadataChanged<TriggerId> | 5 |
TriggerEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id_matcher | Option<TriggerId> |
event_set | TriggerEventSet |
TriggerEventSet
Type: Bitmap
Repr: u32
Masks:
| Field name | Field value |
|---|---|
Created | 0x1 |
Deleted | 0x2 |
Extended | 0x4 |
Shortened | 0x8 |
MetadataInserted | 0x10 |
MetadataRemoved | 0x20 |
TriggerId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
name | Name |
TriggerIdPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Equals | TriggerId | 0 |
Name | StringPredicateBox | 1 |
TriggerNumberOfExecutionsChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
trigger | TriggerId |
by | u32 |
TriggerPredicateBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Id | TriggerIdPredicateBox | 0 |
TypeError
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
AssetType | Mismatch<AssetType> | 0 |
NumericAssetTypeExpected | AssetType | 1 |
Unregister<Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | AccountId |
Unregister<Asset>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | AssetId |
Unregister<AssetDefinition>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | AssetDefinitionId |
Unregister<Domain>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | DomainId |
Unregister<Peer>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | PeerId |
Unregister<Role>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | RoleId |
Unregister<Trigger>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | TriggerId |
UnregisterBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Peer | Unregister<Peer> | 0 |
Domain | Unregister<Domain> | 1 |
Account | Unregister<Account> | 2 |
AssetDefinition | Unregister<AssetDefinition> | 3 |
Asset | Unregister<Asset> | 4 |
Role | Unregister<Role> | 5 |
Trigger | Unregister<Trigger> | 6 |
Upgrade
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
executor | Executor |
ValidationFail
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
NotPermitted | String | 0 |
InstructionFailed | InstructionExecutionError | 1 |
QueryFailed | QueryExecutionFail | 2 |
TooComplex | — | 3 |
InternalError | — | 4 |
Vec<Account>
Type: Vec
Value: Account
Vec<Asset>
Type: Vec
Value: Asset
Vec<AssetDefinition>
Type: Vec
Value: AssetDefinition
Vec<BlockHeader>
Type: Vec
Value: BlockHeader
Vec<BlockSignature>
Type: Vec
Value: BlockSignature
Vec<CommittedTransaction>
Type: Vec
Value: CommittedTransaction
Vec<CompoundPredicate<AccountPredicateBox>>
Type: Vec
Value: CompoundPredicate<AccountPredicateBox>
Vec<CompoundPredicate<AssetDefinitionPredicateBox>>
Type: Vec
Value: CompoundPredicate<AssetDefinitionPredicateBox>
Vec<CompoundPredicate<AssetPredicateBox>>
Type: Vec
Value: CompoundPredicate<AssetPredicateBox>
Vec<CompoundPredicate<BlockHeaderPredicateBox>>
Type: Vec
Value: CompoundPredicate<BlockHeaderPredicateBox>
Vec<CompoundPredicate<CommittedTransactionPredicateBox>>
Type: Vec
Value: CompoundPredicate<CommittedTransactionPredicateBox>
Vec<CompoundPredicate<DomainPredicateBox>>
Type: Vec
Value: CompoundPredicate<DomainPredicateBox>
Vec<CompoundPredicate<PeerPredicateBox>>
Type: Vec
Value: CompoundPredicate<PeerPredicateBox>
Vec<CompoundPredicate<PermissionPredicateBox>>
Type: Vec
Value: CompoundPredicate<PermissionPredicateBox>
Vec<CompoundPredicate<RoleIdPredicateBox>>
Type: Vec
Value: CompoundPredicate<RoleIdPredicateBox>
Vec<CompoundPredicate<RolePredicateBox>>
Type: Vec
Value: CompoundPredicate<RolePredicateBox>
Vec<CompoundPredicate<SignedBlockPredicateBox>>
Type: Vec
Value: CompoundPredicate<SignedBlockPredicateBox>
Vec<CompoundPredicate<TriggerIdPredicateBox>>
Type: Vec
Value: CompoundPredicate<TriggerIdPredicateBox>
Vec<CompoundPredicate<TriggerPredicateBox>>
Type: Vec
Value: CompoundPredicate<TriggerPredicateBox>
Vec<Domain>
Type: Vec
Value: Domain
Vec<EventFilterBox>
Type: Vec
Value: EventFilterBox
Vec<GenesisWasmTrigger>
Type: Vec
Value: GenesisWasmTrigger
Vec<InstructionBox>
Type: Vec
Value: InstructionBox
Vec<Parameter>
Type: Vec
Value: Parameter
Vec<PeerId>
Type: Vec
Value: PeerId
Vec<Permission>
Type: Vec
Value: Permission
Vec<Role>
Type: Vec
Value: Role
Vec<RoleId>
Type: Vec
Value: RoleId
Vec<SignedBlock>
Type: Vec
Value: SignedBlock
Vec<SignedTransaction>
Type: Vec
Value: SignedTransaction
Vec<Trigger>
Type: Vec
Value: Trigger
Vec<TriggerId>
Type: Vec
Value: TriggerId
Vec<u8>
Type: Vec
Value: u8
WasmExecutionFail
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
reason | String |
WasmSmartContract
Type: Alias
To: Vec<u8>
u16
Type: Int
Kind: FixedWidth
u32
Type: Int
Kind: FixedWidth
u64
Type: Int
Kind: FixedWidth
u8
Type: Int
Kind: FixedWidth