Data Model Schema
TODO: explain what this page contains
Account
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AccountId |
assets | SortedMap<AssetId, Asset> |
signatories | SortedVec<PublicKey> |
signature_check_condition | SignatureCheckCondition |
metadata | Metadata |
AccountEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Asset | AssetEvent | 0 |
Created | Account | 1 |
Deleted | AccountId | 2 |
AuthenticationAdded | AccountId | 3 |
AuthenticationRemoved | AccountId | 4 |
PermissionAdded | AccountPermissionChanged | 5 |
PermissionRemoved | AccountPermissionChanged | 6 |
RoleRevoked | AccountRoleChanged | 7 |
RoleGranted | AccountRoleChanged | 8 |
MetadataInserted | MetadataChanged<AccountId> | 9 |
MetadataRemoved | MetadataChanged<AccountId> | 10 |
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 |
|---|---|
AnyAsset | 0x1 |
Created | 0x2 |
Deleted | 0x4 |
AuthenticationAdded | 0x8 |
AuthenticationRemoved | 0x10 |
PermissionAdded | 0x20 |
PermissionRemoved | 0x40 |
RoleRevoked | 0x80 |
RoleGranted | 0x100 |
MetadataInserted | 0x200 |
MetadataRemoved | 0x400 |
AccountId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
domain_id | DomainId |
name | Name |
AccountMintBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
PublicKey | Mint<PublicKey, Account> | 0 |
SignatureCheckCondition | Mint<SignatureCheckCondition, Account> | 1 |
AccountPermissionChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
account_id | AccountId |
permission_id | Name |
AccountRoleChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
account_id | AccountId |
role_id | RoleId |
Action
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
executable | Executable |
repeats | Repeats |
authority | AccountId |
filter | TriggeringEventFilterBox |
metadata | Metadata |
Algorithm
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Ed25519 | — | 0 |
Secp256k1 | — | 1 |
BlsNormal | — | 2 |
BlsSmall | — | 3 |
Array<u16, 8>
Type: Array
Length: 8
Value: u16
Array<u8, 32>
Type: Array
Length: 32
Value: u8
Array<u8, 4>
Type: Array
Length: 4
Value: u8
Asset
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AssetId |
value | AssetValue |
AssetChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset_id | AssetId |
amount | AssetValue |
AssetDefinition
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AssetDefinitionId |
value_type | AssetValueType |
mintable | Mintable |
logo | Option<IpfsPath> |
metadata | Metadata |
owned_by | AccountId |
AssetDefinitionEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Created | AssetDefinition | 0 |
MintabilityChanged | AssetDefinitionId | 1 |
OwnerChanged | AssetDefinitionOwnerChanged | 2 |
Deleted | AssetDefinitionId | 3 |
MetadataInserted | MetadataChanged<AssetDefinitionId> | 4 |
MetadataRemoved | MetadataChanged<AssetDefinitionId> | 5 |
TotalQuantityChanged | AssetDefinitionTotalQuantityChanged | 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 |
MintabilityChanged | 0x2 |
OwnerChanged | 0x4 |
Deleted | 0x8 |
MetadataInserted | 0x10 |
MetadataRemoved | 0x20 |
TotalQuantityChanged | 0x40 |
AssetDefinitionId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
domain_id | DomainId |
name | Name |
AssetDefinitionOwnerChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset_definition_id | AssetDefinitionId |
new_owner | AccountId |
AssetDefinitionTotalQuantityChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset_definition_id | 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 |
|---|---|
definition_id | AssetDefinitionId |
account_id | AccountId |
AssetTransferBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Numeric | Transfer<Asset, Numeric, Account> | 0 |
Store | Transfer<Asset, Metadata, Account> | 1 |
AssetValue
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Numeric | Numeric | 0 |
Store | Metadata | 1 |
AssetValueType
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Numeric | NumericSpec | 0 |
Store | — | 1 |
AtIndex
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
index | u32 |
predicate | QueryOutputPredicate |
BatchedResponse<QueryOutputBox>
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
V1 | BatchedResponseV1<QueryOutputBox> | 1 |
BatchedResponseV1<QueryOutputBox>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
batch | QueryOutputBox |
cursor | ForwardCursor |
BlockEvent
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
header | BlockHeader |
hash | HashOf<SignedBlock> |
status | BlockStatus |
BlockEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
height | Option<u64> |
status | Option<BlockStatus> |
BlockHeader
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
height | u64 |
previous_block_hash | Option<HashOf<SignedBlock>> |
transactions_hash | Option<HashOf<MerkleTree<SignedTransaction>>> |
timestamp_ms | u64 |
view_change_index | u64 |
consensus_estimation_ms | u64 |
BlockMessage
Type: Alias
To: SignedBlock
BlockPayload
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
header | BlockHeader |
commit_topology | Vec<PeerId> |
transactions | Vec<TransactionValue> |
event_recommendations | Vec<EventBox> |
BlockRejectionReason
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
ConsensusBlockRejection | — | 0 |
BlockStatus
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Approved | — | 0 |
Rejected | BlockRejectionReason | 1 |
Committed | — | 2 |
Applied | — | 3 |
BlockSubscriptionRequest
Type: Alias
To: NonZero<u64>
Burn<Numeric, Asset>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | Numeric |
destination_id | AssetId |
Burn<PublicKey, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | PublicKey |
destination_id | AccountId |
Burn<u32, Trigger>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | u32 |
destination_id | TriggerId |
BurnBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
AccountPublicKey | Burn<PublicKey, Account> | 0 |
Asset | Burn<Numeric, Asset> | 1 |
TriggerRepetitions | Burn<u32, Trigger> | 2 |
ChainId
Type: Alias
To: String
Compact<u128>
Type: Int
Kind: Compact
Compact<u32>
Type: Int
Kind: Compact
ConfigurationEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Changed | ParameterId | 0 |
Created | ParameterId | 1 |
Deleted | ParameterId | 2 |
ConfigurationEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id_matcher | Option<ParameterId> |
event_set | ConfigurationEventSet |
ConfigurationEventSet
Type: Bitmap
Repr: u32
Masks:
| Field name | Field value |
|---|---|
Changed | 0x1 |
Created | 0x2 |
Deleted | 0x4 |
Container
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Any | QueryOutputPredicate | 0 |
All | QueryOutputPredicate | 1 |
AtIndex | AtIndex | 2 |
DataEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Peer | PeerEvent | 0 |
Domain | DomainEvent | 1 |
Trigger | TriggerEvent | 2 |
Role | RoleEvent | 3 |
PermissionToken | PermissionTokenSchemaUpdateEvent | 4 |
Configuration | ConfigurationEvent | 5 |
Executor | ExecutorEvent | 6 |
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 |
PermissionTokenSchemaUpdate | — | 8 |
Configuration | ConfigurationEventFilter | 9 |
Executor | ExecutorEventFilter | 10 |
Domain
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | DomainId |
accounts | SortedMap<AccountId, Account> |
asset_definitions | SortedMap<AssetDefinitionId, AssetDefinition> |
asset_total_quantities | SortedMap<AssetDefinitionId, Numeric> |
logo | Option<IpfsPath> |
metadata | Metadata |
owned_by | AccountId |
DomainEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Account | AccountEvent | 0 |
AssetDefinition | AssetDefinitionEvent | 1 |
Created | Domain | 2 |
Deleted | DomainId | 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 |
|---|---|
AnyAccount | 0x1 |
AnyAssetDefinition | 0x2 |
Created | 0x4 |
Deleted | 0x8 |
MetadataInserted | 0x10 |
MetadataRemoved | 0x20 |
OwnerChanged | 0x40 |
DomainId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
name | Name |
DomainOwnerChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
domain_id | DomainId |
new_owner | AccountId |
Duration
Type: Tuple
Values: (u64, u32)
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_id | TriggerId |
ExecuteTriggerEvent
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
trigger_id | TriggerId |
authority | AccountId |
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 |
ExecutorEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Upgraded | — | 0 |
ExecutorEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
event_set | ExecutorEventSet |
ExecutorEventSet
Type: Bitmap
Repr: u32
Masks:
| Field name | Field value |
|---|---|
Upgraded | 0x1 |
Fail
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
message | String |
FindAccountById
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AccountId |
FindAccountKeyValueByIdAndKey
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AccountId |
key | Name |
FindAccountsByDomainId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
domain_id | DomainId |
FindAccountsByName
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
name | Name |
FindAccountsWithAsset
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset_definition_id | AssetDefinitionId |
FindAllAccounts
Type: Zero-Size Type (unit type, null type)
FindAllActiveTriggerIds
Type: Zero-Size Type (unit type, null type)
FindAllAssets
Type: Zero-Size Type (unit type, null type)
FindAllAssetsDefinitions
Type: Zero-Size Type (unit type, null type)
FindAllBlockHeaders
Type: Zero-Size Type (unit type, null type)
FindAllBlocks
Type: Zero-Size Type (unit type, null type)
FindAllDomains
Type: Zero-Size Type (unit type, null type)
FindAllParameters
Type: Zero-Size Type (unit type, null type)
FindAllPeers
Type: Zero-Size Type (unit type, null type)
FindAllRoleIds
Type: Zero-Size Type (unit type, null type)
FindAllRoles
Type: Zero-Size Type (unit type, null type)
FindAllTransactions
Type: Zero-Size Type (unit type, null type)
FindAssetById
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AssetId |
FindAssetDefinitionById
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AssetDefinitionId |
FindAssetDefinitionKeyValueByIdAndKey
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AssetDefinitionId |
key | Name |
FindAssetKeyValueByIdAndKey
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AssetId |
key | Name |
FindAssetQuantityById
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AssetId |
FindAssetsByAccountId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
account_id | AccountId |
FindAssetsByAssetDefinitionId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
asset_definition_id | AssetDefinitionId |
FindAssetsByDomainId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
domain_id | DomainId |
FindAssetsByDomainIdAndAssetDefinitionId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
domain_id | DomainId |
asset_definition_id | AssetDefinitionId |
FindAssetsByName
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
name | Name |
FindBlockHeaderByHash
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
hash | HashOf<SignedBlock> |
FindDomainById
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | DomainId |
FindDomainKeyValueByIdAndKey
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | DomainId |
key | Name |
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<SignedBlock> | 5 |
Transaction | HashOf<SignedTransaction> | 6 |
Peer | PeerId | 7 |
Trigger | TriggerId | 8 |
Role | RoleId | 9 |
PermissionToken | Name | 10 |
Parameter | ParameterId | 11 |
PublicKey | PublicKey | 12 |
FindPermissionTokenSchema
Type: Zero-Size Type (unit type, null type)
FindPermissionTokensByAccountId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AccountId |
FindRoleByRoleId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | RoleId |
FindRolesByAccountId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AccountId |
FindTotalAssetQuantityByAssetDefinitionId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AssetDefinitionId |
FindTransactionByHash
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
hash | HashOf<SignedTransaction> |
FindTransactionsByAccountId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
account_id | AccountId |
FindTriggerById
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | TriggerId |
FindTriggerKeyValueByIdAndKey
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | TriggerId |
key | Name |
FindTriggersByDomainId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
domain_id | DomainId |
ForwardCursor
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
query_id | Option<String> |
cursor | Option<NonZero<u64>> |
GenericPredicateBox<QueryOutputPredicate>
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
And | NonTrivial<GenericPredicateBox<QueryOutputPredicate>> | 0 |
Or | NonTrivial<GenericPredicateBox<QueryOutputPredicate>> | 1 |
Not | GenericPredicateBox<QueryOutputPredicate> | 2 |
Raw | QueryOutputPredicate | 3 |
Grant<PermissionToken, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | PermissionToken |
destination_id | AccountId |
Grant<PermissionToken, Role>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | PermissionToken |
destination_id | RoleId |
Grant<RoleId, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | RoleId |
destination_id | AccountId |
GrantBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
PermissionToken | Grant<PermissionToken, Account> | 0 |
Role | Grant<RoleId, Account> | 1 |
RolePermissionToken | Grant<PermissionToken, Role> | 2 |
Hash
Type: Alias
To: Array<u8, 32>
HashOf<MerkleTree<SignedTransaction>>
Type: Alias
To: Hash
HashOf<SignedBlock>
Type: Alias
To: Hash
HashOf<SignedTransaction>
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 |
PermissionTokenId | Name | 7 |
ParameterId | ParameterId | 8 |
IdentifiableBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
NewDomain | NewDomain | 0 |
NewAccount | NewAccount | 1 |
NewAssetDefinition | NewAssetDefinition | 2 |
NewRole | NewRole | 3 |
Peer | Peer | 4 |
Domain | Domain | 5 |
Account | Account | 6 |
AssetDefinition | AssetDefinition | 7 |
Asset | Asset | 8 |
Trigger | Trigger | 9 |
Role | Role | 10 |
Parameter | Parameter | 11 |
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 |
NewParameter | NewParameter | 11 |
Upgrade | Upgrade | 12 |
Log | Log | 13 |
Fail | Fail | 14 |
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 |
Metadata | MetadataError | 7 |
Fail | String | 8 |
InvalidParameter | InvalidParameterError | 9 |
InvariantViolation | String | 10 |
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 |
NewParameter | — | 11 |
Upgrade | — | 12 |
Log | — | 13 |
Fail | — | 14 |
InvalidParameterError
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Wasm | String | 0 |
NameLength | — | 1 |
IpfsPath
Type: Alias
To: String
Ipv4Addr
Type: Alias
To: Array<u8, 4>
Ipv6Addr
Type: Alias
To: Array<u16, 8>
JsonString
Type: Alias
To: String
LengthLimits
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
min | u32 |
max | u32 |
Level
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
TRACE | — | 0 |
DEBUG | — | 1 |
INFO | — | 2 |
WARN | — | 3 |
ERROR | — | 4 |
Limits
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
capacity | u32 |
max_entry_len | u32 |
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
To: SortedMap<Name, MetadataValueBox>
MetadataChanged<AccountId>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
target_id | AccountId |
key | Name |
value | MetadataValueBox |
MetadataChanged<AssetDefinitionId>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
target_id | AssetDefinitionId |
key | Name |
value | MetadataValueBox |
MetadataChanged<AssetId>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
target_id | AssetId |
key | Name |
value | MetadataValueBox |
MetadataChanged<DomainId>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
target_id | DomainId |
key | Name |
value | MetadataValueBox |
MetadataChanged<TriggerId>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
target_id | TriggerId |
key | Name |
value | MetadataValueBox |
MetadataError
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
EmptyPath | — | 0 |
EntryTooBig | SizeError | 1 |
MaxCapacity | SizeError | 2 |
MissingSegment | Name | 3 |
InvalidSegment | Name | 4 |
MetadataValueBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Bool | bool | 0 |
String | String | 1 |
Name | Name | 2 |
Bytes | Vec<u8> | 3 |
Numeric | Numeric | 4 |
LimitedMetadata | Metadata | 5 |
Vec | Vec<MetadataValueBox> | 6 |
Mint<Numeric, Asset>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | Numeric |
destination_id | AssetId |
Mint<PublicKey, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | PublicKey |
destination_id | AccountId |
Mint<SignatureCheckCondition, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | SignatureCheckCondition |
destination_id | AccountId |
Mint<u32, Trigger>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | u32 |
destination_id | TriggerId |
MintBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Account | AccountMintBox | 0 |
Asset | Mint<Numeric, Asset> | 1 |
TriggerRepetitions | Mint<u32, Trigger> | 2 |
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<AssetValueType>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
expected | AssetValueType |
actual | AssetValueType |
Name
Type: Alias
To: String
NewAccount
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AccountId |
signatories | SortedVec<PublicKey> |
metadata | Metadata |
NewAssetDefinition
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | AssetDefinitionId |
value_type | AssetValueType |
mintable | Mintable |
logo | Option<IpfsPath> |
metadata | Metadata |
NewDomain
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | DomainId |
logo | Option<IpfsPath> |
metadata | Metadata |
NewParameter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
parameter | Parameter |
NewRole
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
inner | Role |
NonTrivial<GenericPredicateBox<QueryOutputPredicate>>
Type: Alias
To: Vec<GenericPredicateBox<QueryOutputPredicate>>
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<Duration>
Type: Option
Some: Duration
Option<HashOf<MerkleTree<SignedTransaction>>>
Type: Option
Some: HashOf<MerkleTree<SignedTransaction>>
Option<HashOf<SignedBlock>>
Type: Option
Some: HashOf<SignedBlock>
Option<HashOf<SignedTransaction>>
Type: Option
Some: HashOf<SignedTransaction>
Option<IpfsPath>
Type: Option
Some: IpfsPath
Option<NonZero<u32>>
Type: Option
Some: NonZero<u32>
Option<NonZero<u64>>
Type: Option
Some: NonZero<u64>
Option<Option<u64>>
Type: Option
Some: Option<u64>
Option<ParameterId>
Type: Option
Some: ParameterId
Option<PeerId>
Type: Option
Some: PeerId
Option<RoleId>
Type: Option
Some: RoleId
Option<String>
Type: Option
Some: String
Option<TimeInterval>
Type: Option
Some: TimeInterval
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
Parameter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | ParameterId |
val | ParameterValueBox |
ParameterId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
name | Name |
ParameterValueBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
TransactionLimits | TransactionLimits | 0 |
MetadataLimits | Limits | 1 |
LengthLimits | LengthLimits | 2 |
Numeric | Numeric | 3 |
Peer
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | PeerId |
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 |
|---|---|
address | SocketAddr |
public_key | PublicKey |
PermissionToken
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
definition_id | Name |
payload | JsonString |
PermissionTokenSchema
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
token_ids | Vec<Name> |
schema | String |
PermissionTokenSchemaUpdateEvent
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
old_schema | PermissionTokenSchema |
new_schema | PermissionTokenSchema |
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> |
QueryBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
FindAllAccounts | FindAllAccounts | 0 |
FindAccountById | FindAccountById | 1 |
FindAccountKeyValueByIdAndKey | FindAccountKeyValueByIdAndKey | 2 |
FindAccountsByName | FindAccountsByName | 3 |
FindAccountsByDomainId | FindAccountsByDomainId | 4 |
FindAccountsWithAsset | FindAccountsWithAsset | 5 |
FindAllAssets | FindAllAssets | 6 |
FindAllAssetsDefinitions | FindAllAssetsDefinitions | 7 |
FindAssetById | FindAssetById | 8 |
FindAssetDefinitionById | FindAssetDefinitionById | 9 |
FindAssetsByName | FindAssetsByName | 10 |
FindAssetsByAccountId | FindAssetsByAccountId | 11 |
FindAssetsByAssetDefinitionId | FindAssetsByAssetDefinitionId | 12 |
FindAssetsByDomainId | FindAssetsByDomainId | 13 |
FindAssetsByDomainIdAndAssetDefinitionId | FindAssetsByDomainIdAndAssetDefinitionId | 14 |
FindAssetQuantityById | FindAssetQuantityById | 15 |
FindTotalAssetQuantityByAssetDefinitionId | FindTotalAssetQuantityByAssetDefinitionId | 16 |
FindAssetKeyValueByIdAndKey | FindAssetKeyValueByIdAndKey | 17 |
FindAssetDefinitionKeyValueByIdAndKey | FindAssetDefinitionKeyValueByIdAndKey | 18 |
FindAllDomains | FindAllDomains | 19 |
FindDomainById | FindDomainById | 20 |
FindDomainKeyValueByIdAndKey | FindDomainKeyValueByIdAndKey | 21 |
FindAllPeers | FindAllPeers | 22 |
FindAllBlocks | FindAllBlocks | 23 |
FindAllBlockHeaders | FindAllBlockHeaders | 24 |
FindBlockHeaderByHash | FindBlockHeaderByHash | 25 |
FindAllTransactions | FindAllTransactions | 26 |
FindTransactionsByAccountId | FindTransactionsByAccountId | 27 |
FindTransactionByHash | FindTransactionByHash | 28 |
FindPermissionTokensByAccountId | FindPermissionTokensByAccountId | 29 |
FindPermissionTokenSchema | FindPermissionTokenSchema | 30 |
FindAllActiveTriggerIds | FindAllActiveTriggerIds | 31 |
FindTriggerById | FindTriggerById | 32 |
FindTriggerKeyValueByIdAndKey | FindTriggerKeyValueByIdAndKey | 33 |
FindTriggersByDomainId | FindTriggersByDomainId | 34 |
FindAllRoles | FindAllRoles | 35 |
FindAllRoleIds | FindAllRoleIds | 36 |
FindRoleByRoleId | FindRoleByRoleId | 37 |
FindRolesByAccountId | FindRolesByAccountId | 38 |
FindAllParameters | FindAllParameters | 39 |
QueryExecutionFail
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Signature | String | 0 |
Find | FindError | 1 |
Conversion | String | 2 |
UnknownCursor | — | 3 |
FetchSizeTooBig | — | 4 |
QueryOutputBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Id | IdBox | 0 |
Identifiable | IdentifiableBox | 1 |
Transaction | TransactionQueryOutput | 2 |
PermissionToken | PermissionToken | 3 |
PermissionTokenSchema | PermissionTokenSchema | 4 |
LimitedMetadata | MetadataValueBox | 5 |
Numeric | Numeric | 6 |
BlockHeader | BlockHeader | 7 |
Block | SignedBlock | 8 |
Vec | Vec<QueryOutputBox> | 9 |
QueryOutputPredicate
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Identifiable | StringPredicate | 0 |
Container | Container | 1 |
Display | StringPredicate | 2 |
Numerical | SemiRange | 3 |
TimeStamp | SemiInterval<u128> | 4 |
Pass | — | 5 |
QueryPayload
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
authority | AccountId |
query | QueryBox |
filter | GenericPredicateBox<QueryOutputPredicate> |
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 | Peer |
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_id | AccountId |
key | Name |
RemoveKeyValue<Asset>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object_id | AssetId |
key | Name |
RemoveKeyValue<AssetDefinition>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object_id | AssetDefinitionId |
key | Name |
RemoveKeyValue<Domain>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object_id | DomainId |
key | Name |
RemoveKeyValue<Trigger>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object_id | 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_type | InstructionType |
id | IdBox |
Revoke<PermissionToken, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | PermissionToken |
destination_id | AccountId |
Revoke<PermissionToken, Role>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | PermissionToken |
destination_id | RoleId |
Revoke<RoleId, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object | RoleId |
destination_id | AccountId |
RevokeBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
PermissionToken | Revoke<PermissionToken, Account> | 0 |
Role | Revoke<RoleId, Account> | 1 |
RolePermissionToken | Revoke<PermissionToken, Role> | 2 |
Role
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
id | RoleId |
permissions | SortedVec<PermissionToken> |
RoleEvent
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Created | Role | 0 |
Deleted | RoleId | 1 |
PermissionRemoved | RolePermissionChanged | 2 |
PermissionAdded | 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 |
PermissionRemoved | 0x4 |
PermissionAdded | 0x8 |
RoleId
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
name | Name |
RolePermissionChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
role_id | RoleId |
permission_token_id | Name |
Schedule
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
start | Duration |
period | Option<Duration> |
SemiInterval<Numeric>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
start | Numeric |
limit | Numeric |
SemiInterval<u128>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
start | u128 |
limit | u128 |
SemiRange
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Numeric | SemiInterval<Numeric> | 0 |
SetKeyValue<Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object_id | AccountId |
key | Name |
value | MetadataValueBox |
SetKeyValue<Asset>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object_id | AssetId |
key | Name |
value | MetadataValueBox |
SetKeyValue<AssetDefinition>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object_id | AssetDefinitionId |
key | Name |
value | MetadataValueBox |
SetKeyValue<Domain>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object_id | DomainId |
key | Name |
value | MetadataValueBox |
SetKeyValue<Trigger>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object_id | TriggerId |
key | Name |
value | MetadataValueBox |
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: Struct
Declarations:
| Field name | Field value |
|---|---|
parameter | Parameter |
Signature
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
public_key | PublicKey |
payload | Vec<u8> |
SignatureCheckCondition
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
AnyAccountSignatureOr | Vec<PublicKey> | 0 |
AllAccountSignaturesAnd | Vec<PublicKey> | 1 |
SignatureOf<BlockPayload>
Type: Alias
To: Signature
SignatureOf<QueryPayload>
Type: Alias
To: Signature
SignatureOf<TransactionPayload>
Type: Alias
To: Signature
SignaturesOf<BlockPayload>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
signatures | SortedVec<SignatureOf<BlockPayload>> |
SignaturesOf<TransactionPayload>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
signatures | SortedVec<SignatureOf<TransactionPayload>> |
SignedBlock
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
V1 | SignedBlockV1 | 1 |
SignedBlockV1
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
signatures | SignaturesOf<BlockPayload> |
payload | BlockPayload |
SignedQuery
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
V1 | SignedQueryV1 | 1 |
SignedQueryV1
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
signature | SignatureOf<QueryPayload> |
payload | QueryPayload |
SignedTransaction
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
V1 | SignedTransactionV1 | 1 |
SignedTransactionV1
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
signatures | SignaturesOf<TransactionPayload> |
payload | TransactionPayload |
SizeError
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
limits | Limits |
actual | u64 |
SocketAddr
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Ipv4 | SocketAddrV4 | 0 |
Ipv6 | SocketAddrV6 | 1 |
Host | SocketAddrHost | 2 |
SocketAddrHost
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
host | String |
port | u16 |
SocketAddrV4
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
ip | Ipv4Addr |
port | u16 |
SocketAddrV6
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
ip | Ipv6Addr |
port | u16 |
SortedMap<AccountId, Account>
Type: Map
Key: AccountId
Value: Account
SortedMap<AssetDefinitionId, AssetDefinition>
Type: Map
Key: AssetDefinitionId
Value: AssetDefinition
SortedMap<AssetDefinitionId, Numeric>
Type: Map
Key: AssetDefinitionId
Value: Numeric
SortedMap<AssetId, Asset>
Type: Map
Key: AssetId
Value: Asset
SortedMap<Name, MetadataValueBox>
Type: Map
Key: Name
Value: MetadataValueBox
SortedVec<PermissionToken>
Type: Vec
Value: PermissionToken
SortedVec<PublicKey>
Type: Vec
Value: PublicKey
SortedVec<SignatureOf<BlockPayload>>
Type: Vec
Value: SignatureOf<BlockPayload>
SortedVec<SignatureOf<TransactionPayload>>
Type: Vec
Value: SignatureOf<TransactionPayload>
String
Type: Alias
To: String
StringPredicate
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Contains | String | 0 |
StartsWith | String | 1 |
EndsWith | String | 2 |
Is | String | 3 |
TimeEvent
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
prev_interval | Option<TimeInterval> |
interval | TimeInterval |
TimeEventFilter
Type: Alias
To: ExecutionTime
TimeInterval
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
since | Duration |
length | Duration |
TransactionEvent
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
hash | HashOf<SignedTransaction> |
block_height | Option<u64> |
status | TransactionStatus |
TransactionEventFilter
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
hash | Option<HashOf<SignedTransaction>> |
block_height | Option<Option<u64>> |
status | Option<TransactionStatus> |
TransactionLimitError
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
reason | String |
TransactionLimits
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
max_instruction_number | u64 |
max_wasm_size_bytes | u64 |
TransactionPayload
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
chain_id | ChainId |
authority | AccountId |
creation_time_ms | u64 |
instructions | Executable |
time_to_live_ms | Option<NonZero<u64>> |
nonce | Option<NonZero<u32>> |
metadata | SortedMap<Name, MetadataValueBox> |
TransactionQueryOutput
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
block_hash | HashOf<SignedBlock> |
transaction | TransactionValue |
TransactionRejectionReason
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
AccountDoesNotExist | FindError | 0 |
LimitCheck | TransactionLimitError | 1 |
Validation | ValidationFail | 2 |
InstructionExecution | InstructionExecutionFail | 3 |
WasmExecution | WasmExecutionFail | 4 |
TransactionStatus
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Queued | — | 0 |
Expired | — | 1 |
Approved | — | 2 |
Rejected | TransactionRejectionReason | 3 |
TransactionValue
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
value | SignedTransaction |
error | Option<TransactionRejectionReason> |
Transfer<Account, AssetDefinitionId, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
source_id | AccountId |
object | AssetDefinitionId |
destination_id | AccountId |
Transfer<Account, DomainId, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
source_id | AccountId |
object | DomainId |
destination_id | AccountId |
Transfer<Asset, Metadata, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
source_id | AssetId |
object | Metadata |
destination_id | AccountId |
Transfer<Asset, Numeric, Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
source_id | AssetId |
object | Numeric |
destination_id | 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 |
|---|---|
domain_id | Option<DomainId> |
name | Name |
TriggerNumberOfExecutionsChanged
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
trigger_id | TriggerId |
by | u32 |
TriggeringEventFilterBox
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
Pipeline | PipelineEventFilterBox | 0 |
Data | DataEventFilter | 1 |
Time | TimeEventFilter | 2 |
ExecuteTrigger | ExecuteTriggerEventFilter | 3 |
TypeError
Type: Enum
Variants:
| Variant name | Variant value | Discriminant |
|---|---|---|
AssetValueType | Mismatch<AssetValueType> | 0 |
NumericAssetValueTypeExpected | AssetValueType | 1 |
StoreAssetValueTypeExpected | AssetValueType | 2 |
Unregister<Account>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object_id | AccountId |
Unregister<Asset>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object_id | AssetId |
Unregister<AssetDefinition>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object_id | AssetDefinitionId |
Unregister<Domain>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object_id | DomainId |
Unregister<Peer>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object_id | PeerId |
Unregister<Role>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object_id | RoleId |
Unregister<Trigger>
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
object_id | 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<EventBox>
Type: Vec
Value: EventBox
Vec<EventFilterBox>
Type: Vec
Value: EventFilterBox
Vec<GenericPredicateBox<QueryOutputPredicate>>
Type: Vec
Value: GenericPredicateBox<QueryOutputPredicate>
Vec<InstructionBox>
Type: Vec
Value: InstructionBox
Vec<MetadataValueBox>
Type: Vec
Value: MetadataValueBox
Vec<Name>
Type: Vec
Value: Name
Vec<PeerId>
Type: Vec
Value: PeerId
Vec<PublicKey>
Type: Vec
Value: PublicKey
Vec<QueryOutputBox>
Type: Vec
Value: QueryOutputBox
Vec<TransactionValue>
Type: Vec
Value: TransactionValue
Vec<u8>
Type: Vec
Value: u8
WasmExecutionFail
Type: Struct
Declarations:
| Field name | Field value |
|---|---|
reason | String |
WasmSmartContract
Type: Alias
To: Vec<u8>
bool
Type: Alias
To: bool
u128
Type: Int
Kind: FixedWidth
u16
Type: Int
Kind: FixedWidth
u32
Type: Int
Kind: FixedWidth
u64
Type: Int
Kind: FixedWidth
u8
Type: Int
Kind: FixedWidth