Skip to content

Data Model Schema

TODO: explain what this page contains

Account

Type: Struct

Declarations:

Field nameField value
idAccountId
assetsSortedMap<AssetId, Asset>
signatoriesSortedVec<PublicKey>
signature_check_conditionSignatureCheckCondition
metadataMetadata

AccountEvent

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
AssetAssetEvent0
CreatedAccount1
DeletedAccountId2
AuthenticationAddedAccountId3
AuthenticationRemovedAccountId4
PermissionAddedAccountPermissionChanged5
PermissionRemovedAccountPermissionChanged6
RoleRevokedAccountRoleChanged7
RoleGrantedAccountRoleChanged8
MetadataInsertedMetadataChanged<AccountId>9
MetadataRemovedMetadataChanged<AccountId>10

AccountEventFilter

Type: Struct

Declarations:

Field nameField value
id_matcherOption<AccountId>
event_setAccountEventSet

AccountEventSet

Type: Bitmap

Repr: u32

Masks:

Field nameField value
AnyAsset0x1
Created0x2
Deleted0x4
AuthenticationAdded0x8
AuthenticationRemoved0x10
PermissionAdded0x20
PermissionRemoved0x40
RoleRevoked0x80
RoleGranted0x100
MetadataInserted0x200
MetadataRemoved0x400

AccountId

Type: Struct

Declarations:

Field nameField value
domain_idDomainId
nameName

AccountMintBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
PublicKeyMint<PublicKey, Account>0
SignatureCheckConditionMint<SignatureCheckCondition, Account>1

AccountPermissionChanged

Type: Struct

Declarations:

Field nameField value
account_idAccountId
permission_idName

AccountRoleChanged

Type: Struct

Declarations:

Field nameField value
account_idAccountId
role_idRoleId

Action

Type: Struct

Declarations:

Field nameField value
executableExecutable
repeatsRepeats
authorityAccountId
filterTriggeringEventFilterBox
metadataMetadata

Algorithm

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
Ed255190
Secp256k11
BlsNormal2
BlsSmall3

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 nameField value
idAssetId
valueAssetValue

AssetChanged

Type: Struct

Declarations:

Field nameField value
asset_idAssetId
amountAssetValue

AssetDefinition

Type: Struct

Declarations:

Field nameField value
idAssetDefinitionId
value_typeAssetValueType
mintableMintable
logoOption<IpfsPath>
metadataMetadata
owned_byAccountId

AssetDefinitionEvent

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
CreatedAssetDefinition0
MintabilityChangedAssetDefinitionId1
OwnerChangedAssetDefinitionOwnerChanged2
DeletedAssetDefinitionId3
MetadataInsertedMetadataChanged<AssetDefinitionId>4
MetadataRemovedMetadataChanged<AssetDefinitionId>5
TotalQuantityChangedAssetDefinitionTotalQuantityChanged6

AssetDefinitionEventFilter

Type: Struct

Declarations:

Field nameField value
id_matcherOption<AssetDefinitionId>
event_setAssetDefinitionEventSet

AssetDefinitionEventSet

Type: Bitmap

Repr: u32

Masks:

Field nameField value
Created0x1
MintabilityChanged0x2
OwnerChanged0x4
Deleted0x8
MetadataInserted0x10
MetadataRemoved0x20
TotalQuantityChanged0x40

AssetDefinitionId

Type: Struct

Declarations:

Field nameField value
domain_idDomainId
nameName

AssetDefinitionOwnerChanged

Type: Struct

Declarations:

Field nameField value
asset_definition_idAssetDefinitionId
new_ownerAccountId

AssetDefinitionTotalQuantityChanged

Type: Struct

Declarations:

Field nameField value
asset_definition_idAssetDefinitionId
total_amountNumeric

AssetEvent

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
CreatedAsset0
DeletedAssetId1
AddedAssetChanged2
RemovedAssetChanged3
MetadataInsertedMetadataChanged<AssetId>4
MetadataRemovedMetadataChanged<AssetId>5

AssetEventFilter

Type: Struct

Declarations:

Field nameField value
id_matcherOption<AssetId>
event_setAssetEventSet

AssetEventSet

Type: Bitmap

Repr: u32

Masks:

Field nameField value
Created0x1
Deleted0x2
Added0x4
Removed0x8
MetadataInserted0x10
MetadataRemoved0x20

AssetId

Type: Struct

Declarations:

Field nameField value
definition_idAssetDefinitionId
account_idAccountId

AssetTransferBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
NumericTransfer<Asset, Numeric, Account>0
StoreTransfer<Asset, Metadata, Account>1

AssetValue

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
NumericNumeric0
StoreMetadata1

AssetValueType

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
NumericNumericSpec0
Store1

AtIndex

Type: Struct

Declarations:

Field nameField value
indexu32
predicateQueryOutputPredicate

BatchedResponse<QueryOutputBox>

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
V1BatchedResponseV1<QueryOutputBox>1

BatchedResponseV1<QueryOutputBox>

Type: Struct

Declarations:

Field nameField value
batchQueryOutputBox
cursorForwardCursor

BlockEvent

Type: Struct

Declarations:

Field nameField value
headerBlockHeader
hashHashOf<SignedBlock>
statusBlockStatus

BlockEventFilter

Type: Struct

Declarations:

Field nameField value
heightOption<u64>
statusOption<BlockStatus>

BlockHeader

Type: Struct

Declarations:

Field nameField value
heightu64
previous_block_hashOption<HashOf<SignedBlock>>
transactions_hashOption<HashOf<MerkleTree<SignedTransaction>>>
timestamp_msu64
view_change_indexu64
consensus_estimation_msu64

BlockMessage

Type: Alias

To: SignedBlock

BlockPayload

Type: Struct

Declarations:

Field nameField value
headerBlockHeader
commit_topologyVec<PeerId>
transactionsVec<TransactionValue>
event_recommendationsVec<EventBox>

BlockRejectionReason

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
ConsensusBlockRejection0

BlockStatus

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
Approved0
RejectedBlockRejectionReason1
Committed2
Applied3

BlockSubscriptionRequest

Type: Alias

To: NonZero<u64>

Burn<Numeric, Asset>

Type: Struct

Declarations:

Field nameField value
objectNumeric
destination_idAssetId

Burn<PublicKey, Account>

Type: Struct

Declarations:

Field nameField value
objectPublicKey
destination_idAccountId

Burn<u32, Trigger>

Type: Struct

Declarations:

Field nameField value
objectu32
destination_idTriggerId

BurnBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
AccountPublicKeyBurn<PublicKey, Account>0
AssetBurn<Numeric, Asset>1
TriggerRepetitionsBurn<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 nameVariant valueDiscriminant
ChangedParameterId0
CreatedParameterId1
DeletedParameterId2

ConfigurationEventFilter

Type: Struct

Declarations:

Field nameField value
id_matcherOption<ParameterId>
event_setConfigurationEventSet

ConfigurationEventSet

Type: Bitmap

Repr: u32

Masks:

Field nameField value
Changed0x1
Created0x2
Deleted0x4

Container

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
AnyQueryOutputPredicate0
AllQueryOutputPredicate1
AtIndexAtIndex2

DataEvent

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
PeerPeerEvent0
DomainDomainEvent1
TriggerTriggerEvent2
RoleRoleEvent3
PermissionTokenPermissionTokenSchemaUpdateEvent4
ConfigurationConfigurationEvent5
ExecutorExecutorEvent6

DataEventFilter

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
Any0
PeerPeerEventFilter1
DomainDomainEventFilter2
AccountAccountEventFilter3
AssetAssetEventFilter4
AssetDefinitionAssetDefinitionEventFilter5
TriggerTriggerEventFilter6
RoleRoleEventFilter7
PermissionTokenSchemaUpdate8
ConfigurationConfigurationEventFilter9
ExecutorExecutorEventFilter10

Domain

Type: Struct

Declarations:

Field nameField value
idDomainId
accountsSortedMap<AccountId, Account>
asset_definitionsSortedMap<AssetDefinitionId, AssetDefinition>
asset_total_quantitiesSortedMap<AssetDefinitionId, Numeric>
logoOption<IpfsPath>
metadataMetadata
owned_byAccountId

DomainEvent

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
AccountAccountEvent0
AssetDefinitionAssetDefinitionEvent1
CreatedDomain2
DeletedDomainId3
MetadataInsertedMetadataChanged<DomainId>4
MetadataRemovedMetadataChanged<DomainId>5
OwnerChangedDomainOwnerChanged6

DomainEventFilter

Type: Struct

Declarations:

Field nameField value
id_matcherOption<DomainId>
event_setDomainEventSet

DomainEventSet

Type: Bitmap

Repr: u32

Masks:

Field nameField value
AnyAccount0x1
AnyAssetDefinition0x2
Created0x4
Deleted0x8
MetadataInserted0x10
MetadataRemoved0x20
OwnerChanged0x40

DomainId

Type: Struct

Declarations:

Field nameField value
nameName

DomainOwnerChanged

Type: Struct

Declarations:

Field nameField value
domain_idDomainId
new_ownerAccountId

Duration

Type: Tuple

Values: (u64, u32)

EventBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
PipelinePipelineEventBox0
DataDataEvent1
TimeTimeEvent2
ExecuteTriggerExecuteTriggerEvent3
TriggerCompletedTriggerCompletedEvent4

EventFilterBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
PipelinePipelineEventFilterBox0
DataDataEventFilter1
TimeTimeEventFilter2
ExecuteTriggerExecuteTriggerEventFilter3
TriggerCompletedTriggerCompletedEventFilter4

EventMessage

Type: Alias

To: EventBox

EventSubscriptionRequest

Type: Alias

To: Vec<EventFilterBox>

Executable

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
InstructionsVec<InstructionBox>0
WasmWasmSmartContract1

ExecuteTrigger

Type: Struct

Declarations:

Field nameField value
trigger_idTriggerId

ExecuteTriggerEvent

Type: Struct

Declarations:

Field nameField value
trigger_idTriggerId
authorityAccountId

ExecuteTriggerEventFilter

Type: Struct

Declarations:

Field nameField value
trigger_idOption<TriggerId>
authorityOption<AccountId>

ExecutionTime

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
PreCommit0
ScheduleSchedule1

Executor

Type: Struct

Declarations:

Field nameField value
wasmWasmSmartContract

ExecutorEvent

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
Upgraded0

ExecutorEventFilter

Type: Struct

Declarations:

Field nameField value
event_setExecutorEventSet

ExecutorEventSet

Type: Bitmap

Repr: u32

Masks:

Field nameField value
Upgraded0x1

Fail

Type: Struct

Declarations:

Field nameField value
messageString

FindAccountById

Type: Struct

Declarations:

Field nameField value
idAccountId

FindAccountKeyValueByIdAndKey

Type: Struct

Declarations:

Field nameField value
idAccountId
keyName

FindAccountsByDomainId

Type: Struct

Declarations:

Field nameField value
domain_idDomainId

FindAccountsByName

Type: Struct

Declarations:

Field nameField value
nameName

FindAccountsWithAsset

Type: Struct

Declarations:

Field nameField value
asset_definition_idAssetDefinitionId

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 nameField value
idAssetId

FindAssetDefinitionById

Type: Struct

Declarations:

Field nameField value
idAssetDefinitionId

FindAssetDefinitionKeyValueByIdAndKey

Type: Struct

Declarations:

Field nameField value
idAssetDefinitionId
keyName

FindAssetKeyValueByIdAndKey

Type: Struct

Declarations:

Field nameField value
idAssetId
keyName

FindAssetQuantityById

Type: Struct

Declarations:

Field nameField value
idAssetId

FindAssetsByAccountId

Type: Struct

Declarations:

Field nameField value
account_idAccountId

FindAssetsByAssetDefinitionId

Type: Struct

Declarations:

Field nameField value
asset_definition_idAssetDefinitionId

FindAssetsByDomainId

Type: Struct

Declarations:

Field nameField value
domain_idDomainId

FindAssetsByDomainIdAndAssetDefinitionId

Type: Struct

Declarations:

Field nameField value
domain_idDomainId
asset_definition_idAssetDefinitionId

FindAssetsByName

Type: Struct

Declarations:

Field nameField value
nameName

FindBlockHeaderByHash

Type: Struct

Declarations:

Field nameField value
hashHashOf<SignedBlock>

FindDomainById

Type: Struct

Declarations:

Field nameField value
idDomainId

FindDomainKeyValueByIdAndKey

Type: Struct

Declarations:

Field nameField value
idDomainId
keyName

FindError

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
AssetAssetId0
AssetDefinitionAssetDefinitionId1
AccountAccountId2
DomainDomainId3
MetadataKeyName4
BlockHashOf<SignedBlock>5
TransactionHashOf<SignedTransaction>6
PeerPeerId7
TriggerTriggerId8
RoleRoleId9
PermissionTokenName10
ParameterParameterId11
PublicKeyPublicKey12

FindPermissionTokenSchema

Type: Zero-Size Type (unit type, null type)

FindPermissionTokensByAccountId

Type: Struct

Declarations:

Field nameField value
idAccountId

FindRoleByRoleId

Type: Struct

Declarations:

Field nameField value
idRoleId

FindRolesByAccountId

Type: Struct

Declarations:

Field nameField value
idAccountId

FindTotalAssetQuantityByAssetDefinitionId

Type: Struct

Declarations:

Field nameField value
idAssetDefinitionId

FindTransactionByHash

Type: Struct

Declarations:

Field nameField value
hashHashOf<SignedTransaction>

FindTransactionsByAccountId

Type: Struct

Declarations:

Field nameField value
account_idAccountId

FindTriggerById

Type: Struct

Declarations:

Field nameField value
idTriggerId

FindTriggerKeyValueByIdAndKey

Type: Struct

Declarations:

Field nameField value
idTriggerId
keyName

FindTriggersByDomainId

Type: Struct

Declarations:

Field nameField value
domain_idDomainId

ForwardCursor

Type: Struct

Declarations:

Field nameField value
query_idOption<String>
cursorOption<NonZero<u64>>

GenericPredicateBox<QueryOutputPredicate>

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
AndNonTrivial<GenericPredicateBox<QueryOutputPredicate>>0
OrNonTrivial<GenericPredicateBox<QueryOutputPredicate>>1
NotGenericPredicateBox<QueryOutputPredicate>2
RawQueryOutputPredicate3

Grant<PermissionToken, Account>

Type: Struct

Declarations:

Field nameField value
objectPermissionToken
destination_idAccountId

Grant<PermissionToken, Role>

Type: Struct

Declarations:

Field nameField value
objectPermissionToken
destination_idRoleId

Grant<RoleId, Account>

Type: Struct

Declarations:

Field nameField value
objectRoleId
destination_idAccountId

GrantBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
PermissionTokenGrant<PermissionToken, Account>0
RoleGrant<RoleId, Account>1
RolePermissionTokenGrant<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 nameVariant valueDiscriminant
DomainIdDomainId0
AccountIdAccountId1
AssetDefinitionIdAssetDefinitionId2
AssetIdAssetId3
PeerIdPeerId4
TriggerIdTriggerId5
RoleIdRoleId6
PermissionTokenIdName7
ParameterIdParameterId8

IdentifiableBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
NewDomainNewDomain0
NewAccountNewAccount1
NewAssetDefinitionNewAssetDefinition2
NewRoleNewRole3
PeerPeer4
DomainDomain5
AccountAccount6
AssetDefinitionAssetDefinition7
AssetAsset8
TriggerTrigger9
RoleRole10
ParameterParameter11

InstructionBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
RegisterRegisterBox0
UnregisterUnregisterBox1
MintMintBox2
BurnBurnBox3
TransferTransferBox4
SetKeyValueSetKeyValueBox5
RemoveKeyValueRemoveKeyValueBox6
GrantGrantBox7
RevokeRevokeBox8
ExecuteTriggerExecuteTrigger9
SetParameterSetParameter10
NewParameterNewParameter11
UpgradeUpgrade12
LogLog13
FailFail14

InstructionEvaluationError

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
UnsupportedInstructionType0
PermissionParameterString1
TypeTypeError2

InstructionExecutionError

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
EvaluateInstructionEvaluationError0
QueryQueryExecutionFail1
ConversionString2
FindFindError3
RepetitionRepetitionError4
MintabilityMintabilityError5
MathMathError6
MetadataMetadataError7
FailString8
InvalidParameterInvalidParameterError9
InvariantViolationString10

InstructionExecutionFail

Type: Struct

Declarations:

Field nameField value
instructionInstructionBox
reasonString

InstructionType

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
Register0
Unregister1
Mint2
Burn3
Transfer4
SetKeyValue5
RemoveKeyValue6
Grant7
Revoke8
ExecuteTrigger9
SetParameter10
NewParameter11
Upgrade12
Log13
Fail14

InvalidParameterError

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
WasmString0
NameLength1

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 nameField value
minu32
maxu32

Level

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
TRACE0
DEBUG1
INFO2
WARN3
ERROR4

Limits

Type: Struct

Declarations:

Field nameField value
capacityu32
max_entry_lenu32

Log

Type: Struct

Declarations:

Field nameField value
levelLevel
msgString

MathError

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
Overflow0
NotEnoughQuantity1
DivideByZero2
NegativeValue3
DomainViolation4
Unknown5
FixedPointConversionString6

MerkleTree<SignedTransaction>

Type: Vec

Value: HashOf<SignedTransaction>

Metadata

Type: Alias

To: SortedMap<Name, MetadataValueBox>

MetadataChanged<AccountId>

Type: Struct

Declarations:

Field nameField value
target_idAccountId
keyName
valueMetadataValueBox

MetadataChanged<AssetDefinitionId>

Type: Struct

Declarations:

Field nameField value
target_idAssetDefinitionId
keyName
valueMetadataValueBox

MetadataChanged<AssetId>

Type: Struct

Declarations:

Field nameField value
target_idAssetId
keyName
valueMetadataValueBox

MetadataChanged<DomainId>

Type: Struct

Declarations:

Field nameField value
target_idDomainId
keyName
valueMetadataValueBox

MetadataChanged<TriggerId>

Type: Struct

Declarations:

Field nameField value
target_idTriggerId
keyName
valueMetadataValueBox

MetadataError

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
EmptyPath0
EntryTooBigSizeError1
MaxCapacitySizeError2
MissingSegmentName3
InvalidSegmentName4

MetadataValueBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
Boolbool0
StringString1
NameName2
BytesVec<u8>3
NumericNumeric4
LimitedMetadataMetadata5
VecVec<MetadataValueBox>6

Mint<Numeric, Asset>

Type: Struct

Declarations:

Field nameField value
objectNumeric
destination_idAssetId

Mint<PublicKey, Account>

Type: Struct

Declarations:

Field nameField value
objectPublicKey
destination_idAccountId

Mint<SignatureCheckCondition, Account>

Type: Struct

Declarations:

Field nameField value
objectSignatureCheckCondition
destination_idAccountId

Mint<u32, Trigger>

Type: Struct

Declarations:

Field nameField value
objectu32
destination_idTriggerId

MintBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
AccountAccountMintBox0
AssetMint<Numeric, Asset>1
TriggerRepetitionsMint<u32, Trigger>2

MintabilityError

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
MintUnmintable0
ForbidMintOnMintable1

Mintable

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
Infinitely0
Once1
Not2

Mismatch<AssetValueType>

Type: Struct

Declarations:

Field nameField value
expectedAssetValueType
actualAssetValueType

Name

Type: Alias

To: String

NewAccount

Type: Struct

Declarations:

Field nameField value
idAccountId
signatoriesSortedVec<PublicKey>
metadataMetadata

NewAssetDefinition

Type: Struct

Declarations:

Field nameField value
idAssetDefinitionId
value_typeAssetValueType
mintableMintable
logoOption<IpfsPath>
metadataMetadata

NewDomain

Type: Struct

Declarations:

Field nameField value
idDomainId
logoOption<IpfsPath>
metadataMetadata

NewParameter

Type: Struct

Declarations:

Field nameField value
parameterParameter

NewRole

Type: Struct

Declarations:

Field nameField value
innerRole

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 nameField value
mantissaCompact<u128>
scaleCompact<u32>

NumericSpec

Type: Struct

Declarations:

Field nameField value
scaleOption<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 nameField value
idParameterId
valParameterValueBox

ParameterId

Type: Struct

Declarations:

Field nameField value
nameName

ParameterValueBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
TransactionLimitsTransactionLimits0
MetadataLimitsLimits1
LengthLimitsLengthLimits2
NumericNumeric3

Peer

Type: Struct

Declarations:

Field nameField value
idPeerId

PeerEvent

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
AddedPeerId0
RemovedPeerId1

PeerEventFilter

Type: Struct

Declarations:

Field nameField value
id_matcherOption<PeerId>
event_setPeerEventSet

PeerEventSet

Type: Bitmap

Repr: u32

Masks:

Field nameField value
Added0x1
Removed0x2

PeerId

Type: Struct

Declarations:

Field nameField value
addressSocketAddr
public_keyPublicKey

PermissionToken

Type: Struct

Declarations:

Field nameField value
definition_idName
payloadJsonString

PermissionTokenSchema

Type: Struct

Declarations:

Field nameField value
token_idsVec<Name>
schemaString

PermissionTokenSchemaUpdateEvent

Type: Struct

Declarations:

Field nameField value
old_schemaPermissionTokenSchema
new_schemaPermissionTokenSchema

PipelineEventBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
TransactionTransactionEvent0
BlockBlockEvent1

PipelineEventFilterBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
TransactionTransactionEventFilter0
BlockBlockEventFilter1

PublicKey

Type: Struct

Declarations:

Field nameField value
algorithmAlgorithm
payloadVec<u8>

QueryBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
FindAllAccountsFindAllAccounts0
FindAccountByIdFindAccountById1
FindAccountKeyValueByIdAndKeyFindAccountKeyValueByIdAndKey2
FindAccountsByNameFindAccountsByName3
FindAccountsByDomainIdFindAccountsByDomainId4
FindAccountsWithAssetFindAccountsWithAsset5
FindAllAssetsFindAllAssets6
FindAllAssetsDefinitionsFindAllAssetsDefinitions7
FindAssetByIdFindAssetById8
FindAssetDefinitionByIdFindAssetDefinitionById9
FindAssetsByNameFindAssetsByName10
FindAssetsByAccountIdFindAssetsByAccountId11
FindAssetsByAssetDefinitionIdFindAssetsByAssetDefinitionId12
FindAssetsByDomainIdFindAssetsByDomainId13
FindAssetsByDomainIdAndAssetDefinitionIdFindAssetsByDomainIdAndAssetDefinitionId14
FindAssetQuantityByIdFindAssetQuantityById15
FindTotalAssetQuantityByAssetDefinitionIdFindTotalAssetQuantityByAssetDefinitionId16
FindAssetKeyValueByIdAndKeyFindAssetKeyValueByIdAndKey17
FindAssetDefinitionKeyValueByIdAndKeyFindAssetDefinitionKeyValueByIdAndKey18
FindAllDomainsFindAllDomains19
FindDomainByIdFindDomainById20
FindDomainKeyValueByIdAndKeyFindDomainKeyValueByIdAndKey21
FindAllPeersFindAllPeers22
FindAllBlocksFindAllBlocks23
FindAllBlockHeadersFindAllBlockHeaders24
FindBlockHeaderByHashFindBlockHeaderByHash25
FindAllTransactionsFindAllTransactions26
FindTransactionsByAccountIdFindTransactionsByAccountId27
FindTransactionByHashFindTransactionByHash28
FindPermissionTokensByAccountIdFindPermissionTokensByAccountId29
FindPermissionTokenSchemaFindPermissionTokenSchema30
FindAllActiveTriggerIdsFindAllActiveTriggerIds31
FindTriggerByIdFindTriggerById32
FindTriggerKeyValueByIdAndKeyFindTriggerKeyValueByIdAndKey33
FindTriggersByDomainIdFindTriggersByDomainId34
FindAllRolesFindAllRoles35
FindAllRoleIdsFindAllRoleIds36
FindRoleByRoleIdFindRoleByRoleId37
FindRolesByAccountIdFindRolesByAccountId38
FindAllParametersFindAllParameters39

QueryExecutionFail

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
SignatureString0
FindFindError1
ConversionString2
UnknownCursor3
FetchSizeTooBig4

QueryOutputBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
IdIdBox0
IdentifiableIdentifiableBox1
TransactionTransactionQueryOutput2
PermissionTokenPermissionToken3
PermissionTokenSchemaPermissionTokenSchema4
LimitedMetadataMetadataValueBox5
NumericNumeric6
BlockHeaderBlockHeader7
BlockSignedBlock8
VecVec<QueryOutputBox>9

QueryOutputPredicate

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
IdentifiableStringPredicate0
ContainerContainer1
DisplayStringPredicate2
NumericalSemiRange3
TimeStampSemiInterval<u128>4
Pass5

QueryPayload

Type: Struct

Declarations:

Field nameField value
authorityAccountId
queryQueryBox
filterGenericPredicateBox<QueryOutputPredicate>

Register<Account>

Type: Struct

Declarations:

Field nameField value
objectNewAccount

Register<Asset>

Type: Struct

Declarations:

Field nameField value
objectAsset

Register<AssetDefinition>

Type: Struct

Declarations:

Field nameField value
objectNewAssetDefinition

Register<Domain>

Type: Struct

Declarations:

Field nameField value
objectNewDomain

Register<Peer>

Type: Struct

Declarations:

Field nameField value
objectPeer

Register<Role>

Type: Struct

Declarations:

Field nameField value
objectNewRole

Register<Trigger>

Type: Struct

Declarations:

Field nameField value
objectTrigger

RegisterBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
PeerRegister<Peer>0
DomainRegister<Domain>1
AccountRegister<Account>2
AssetDefinitionRegister<AssetDefinition>3
AssetRegister<Asset>4
RoleRegister<Role>5
TriggerRegister<Trigger>6

RemoveKeyValue<Account>

Type: Struct

Declarations:

Field nameField value
object_idAccountId
keyName

RemoveKeyValue<Asset>

Type: Struct

Declarations:

Field nameField value
object_idAssetId
keyName

RemoveKeyValue<AssetDefinition>

Type: Struct

Declarations:

Field nameField value
object_idAssetDefinitionId
keyName

RemoveKeyValue<Domain>

Type: Struct

Declarations:

Field nameField value
object_idDomainId
keyName

RemoveKeyValue<Trigger>

Type: Struct

Declarations:

Field nameField value
object_idTriggerId
keyName

RemoveKeyValueBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
DomainRemoveKeyValue<Domain>0
AccountRemoveKeyValue<Account>1
AssetDefinitionRemoveKeyValue<AssetDefinition>2
AssetRemoveKeyValue<Asset>3
TriggerRemoveKeyValue<Trigger>4

Repeats

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
Indefinitely0
Exactlyu321

RepetitionError

Type: Struct

Declarations:

Field nameField value
instruction_typeInstructionType
idIdBox

Revoke<PermissionToken, Account>

Type: Struct

Declarations:

Field nameField value
objectPermissionToken
destination_idAccountId

Revoke<PermissionToken, Role>

Type: Struct

Declarations:

Field nameField value
objectPermissionToken
destination_idRoleId

Revoke<RoleId, Account>

Type: Struct

Declarations:

Field nameField value
objectRoleId
destination_idAccountId

RevokeBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
PermissionTokenRevoke<PermissionToken, Account>0
RoleRevoke<RoleId, Account>1
RolePermissionTokenRevoke<PermissionToken, Role>2

Role

Type: Struct

Declarations:

Field nameField value
idRoleId
permissionsSortedVec<PermissionToken>

RoleEvent

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
CreatedRole0
DeletedRoleId1
PermissionRemovedRolePermissionChanged2
PermissionAddedRolePermissionChanged3

RoleEventFilter

Type: Struct

Declarations:

Field nameField value
id_matcherOption<RoleId>
event_setRoleEventSet

RoleEventSet

Type: Bitmap

Repr: u32

Masks:

Field nameField value
Created0x1
Deleted0x2
PermissionRemoved0x4
PermissionAdded0x8

RoleId

Type: Struct

Declarations:

Field nameField value
nameName

RolePermissionChanged

Type: Struct

Declarations:

Field nameField value
role_idRoleId
permission_token_idName

Schedule

Type: Struct

Declarations:

Field nameField value
startDuration
periodOption<Duration>

SemiInterval<Numeric>

Type: Struct

Declarations:

Field nameField value
startNumeric
limitNumeric

SemiInterval<u128>

Type: Struct

Declarations:

Field nameField value
startu128
limitu128

SemiRange

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
NumericSemiInterval<Numeric>0

SetKeyValue<Account>

Type: Struct

Declarations:

Field nameField value
object_idAccountId
keyName
valueMetadataValueBox

SetKeyValue<Asset>

Type: Struct

Declarations:

Field nameField value
object_idAssetId
keyName
valueMetadataValueBox

SetKeyValue<AssetDefinition>

Type: Struct

Declarations:

Field nameField value
object_idAssetDefinitionId
keyName
valueMetadataValueBox

SetKeyValue<Domain>

Type: Struct

Declarations:

Field nameField value
object_idDomainId
keyName
valueMetadataValueBox

SetKeyValue<Trigger>

Type: Struct

Declarations:

Field nameField value
object_idTriggerId
keyName
valueMetadataValueBox

SetKeyValueBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
DomainSetKeyValue<Domain>0
AccountSetKeyValue<Account>1
AssetDefinitionSetKeyValue<AssetDefinition>2
AssetSetKeyValue<Asset>3
TriggerSetKeyValue<Trigger>4

SetParameter

Type: Struct

Declarations:

Field nameField value
parameterParameter

Signature

Type: Struct

Declarations:

Field nameField value
public_keyPublicKey
payloadVec<u8>

SignatureCheckCondition

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
AnyAccountSignatureOrVec<PublicKey>0
AllAccountSignaturesAndVec<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 nameField value
signaturesSortedVec<SignatureOf<BlockPayload>>

SignaturesOf<TransactionPayload>

Type: Struct

Declarations:

Field nameField value
signaturesSortedVec<SignatureOf<TransactionPayload>>

SignedBlock

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
V1SignedBlockV11

SignedBlockV1

Type: Struct

Declarations:

Field nameField value
signaturesSignaturesOf<BlockPayload>
payloadBlockPayload

SignedQuery

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
V1SignedQueryV11

SignedQueryV1

Type: Struct

Declarations:

Field nameField value
signatureSignatureOf<QueryPayload>
payloadQueryPayload

SignedTransaction

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
V1SignedTransactionV11

SignedTransactionV1

Type: Struct

Declarations:

Field nameField value
signaturesSignaturesOf<TransactionPayload>
payloadTransactionPayload

SizeError

Type: Struct

Declarations:

Field nameField value
limitsLimits
actualu64

SocketAddr

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
Ipv4SocketAddrV40
Ipv6SocketAddrV61
HostSocketAddrHost2

SocketAddrHost

Type: Struct

Declarations:

Field nameField value
hostString
portu16

SocketAddrV4

Type: Struct

Declarations:

Field nameField value
ipIpv4Addr
portu16

SocketAddrV6

Type: Struct

Declarations:

Field nameField value
ipIpv6Addr
portu16

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 nameVariant valueDiscriminant
ContainsString0
StartsWithString1
EndsWithString2
IsString3

TimeEvent

Type: Struct

Declarations:

Field nameField value
prev_intervalOption<TimeInterval>
intervalTimeInterval

TimeEventFilter

Type: Alias

To: ExecutionTime

TimeInterval

Type: Struct

Declarations:

Field nameField value
sinceDuration
lengthDuration

TransactionEvent

Type: Struct

Declarations:

Field nameField value
hashHashOf<SignedTransaction>
block_heightOption<u64>
statusTransactionStatus

TransactionEventFilter

Type: Struct

Declarations:

Field nameField value
hashOption<HashOf<SignedTransaction>>
block_heightOption<Option<u64>>
statusOption<TransactionStatus>

TransactionLimitError

Type: Struct

Declarations:

Field nameField value
reasonString

TransactionLimits

Type: Struct

Declarations:

Field nameField value
max_instruction_numberu64
max_wasm_size_bytesu64

TransactionPayload

Type: Struct

Declarations:

Field nameField value
chain_idChainId
authorityAccountId
creation_time_msu64
instructionsExecutable
time_to_live_msOption<NonZero<u64>>
nonceOption<NonZero<u32>>
metadataSortedMap<Name, MetadataValueBox>

TransactionQueryOutput

Type: Struct

Declarations:

Field nameField value
block_hashHashOf<SignedBlock>
transactionTransactionValue

TransactionRejectionReason

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
AccountDoesNotExistFindError0
LimitCheckTransactionLimitError1
ValidationValidationFail2
InstructionExecutionInstructionExecutionFail3
WasmExecutionWasmExecutionFail4

TransactionStatus

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
Queued0
Expired1
Approved2
RejectedTransactionRejectionReason3

TransactionValue

Type: Struct

Declarations:

Field nameField value
valueSignedTransaction
errorOption<TransactionRejectionReason>

Transfer<Account, AssetDefinitionId, Account>

Type: Struct

Declarations:

Field nameField value
source_idAccountId
objectAssetDefinitionId
destination_idAccountId

Transfer<Account, DomainId, Account>

Type: Struct

Declarations:

Field nameField value
source_idAccountId
objectDomainId
destination_idAccountId

Transfer<Asset, Metadata, Account>

Type: Struct

Declarations:

Field nameField value
source_idAssetId
objectMetadata
destination_idAccountId

Transfer<Asset, Numeric, Account>

Type: Struct

Declarations:

Field nameField value
source_idAssetId
objectNumeric
destination_idAccountId

TransferBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
DomainTransfer<Account, DomainId, Account>0
AssetDefinitionTransfer<Account, AssetDefinitionId, Account>1
AssetAssetTransferBox2

Trigger

Type: Struct

Declarations:

Field nameField value
idTriggerId
actionAction

TriggerCompletedEvent

Type: Struct

Declarations:

Field nameField value
trigger_idTriggerId
outcomeTriggerCompletedOutcome

TriggerCompletedEventFilter

Type: Struct

Declarations:

Field nameField value
trigger_idOption<TriggerId>
outcome_typeOption<TriggerCompletedOutcomeType>

TriggerCompletedOutcome

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
Success0
FailureString1

TriggerCompletedOutcomeType

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
Success0
Failure1

TriggerEvent

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
CreatedTriggerId0
DeletedTriggerId1
ExtendedTriggerNumberOfExecutionsChanged2
ShortenedTriggerNumberOfExecutionsChanged3
MetadataInsertedMetadataChanged<TriggerId>4
MetadataRemovedMetadataChanged<TriggerId>5

TriggerEventFilter

Type: Struct

Declarations:

Field nameField value
id_matcherOption<TriggerId>
event_setTriggerEventSet

TriggerEventSet

Type: Bitmap

Repr: u32

Masks:

Field nameField value
Created0x1
Deleted0x2
Extended0x4
Shortened0x8
MetadataInserted0x10
MetadataRemoved0x20

TriggerId

Type: Struct

Declarations:

Field nameField value
domain_idOption<DomainId>
nameName

TriggerNumberOfExecutionsChanged

Type: Struct

Declarations:

Field nameField value
trigger_idTriggerId
byu32

TriggeringEventFilterBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
PipelinePipelineEventFilterBox0
DataDataEventFilter1
TimeTimeEventFilter2
ExecuteTriggerExecuteTriggerEventFilter3

TypeError

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
AssetValueTypeMismatch<AssetValueType>0
NumericAssetValueTypeExpectedAssetValueType1
StoreAssetValueTypeExpectedAssetValueType2

Unregister<Account>

Type: Struct

Declarations:

Field nameField value
object_idAccountId

Unregister<Asset>

Type: Struct

Declarations:

Field nameField value
object_idAssetId

Unregister<AssetDefinition>

Type: Struct

Declarations:

Field nameField value
object_idAssetDefinitionId

Unregister<Domain>

Type: Struct

Declarations:

Field nameField value
object_idDomainId

Unregister<Peer>

Type: Struct

Declarations:

Field nameField value
object_idPeerId

Unregister<Role>

Type: Struct

Declarations:

Field nameField value
object_idRoleId

Unregister<Trigger>

Type: Struct

Declarations:

Field nameField value
object_idTriggerId

UnregisterBox

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
PeerUnregister<Peer>0
DomainUnregister<Domain>1
AccountUnregister<Account>2
AssetDefinitionUnregister<AssetDefinition>3
AssetUnregister<Asset>4
RoleUnregister<Role>5
TriggerUnregister<Trigger>6

Upgrade

Type: Struct

Declarations:

Field nameField value
executorExecutor

ValidationFail

Type: Enum

Variants:

Variant nameVariant valueDiscriminant
NotPermittedString0
InstructionFailedInstructionExecutionError1
QueryFailedQueryExecutionFail2
TooComplex3
InternalError4

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 nameField value
reasonString

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