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 |
roles | SortedVec<RoleId> |
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: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
ByCreated | — | 0 |
ByDeleted | — | 1 |
ByAuthenticationAdded | — | 2 |
ByAuthenticationRemoved | — | 3 |
ByPermissionAdded | — | 4 |
ByPermissionRemoved | — | 5 |
ByRoleRevoked | — | 6 |
ByRoleGranted | — | 7 |
ByMetadataInserted | — | 8 |
ByMetadataRemoved | — | 9 |
ByAsset | FilterOpt<AssetFilter> | 10 |
AccountFilter
Type: Struct
Declarations:
Field name | Field value |
---|---|
origin_filter | FilterOpt<OriginFilter<AccountEvent>> |
event_filter | FilterOpt<AccountEventFilter> |
AccountId
Type: Struct
Declarations:
Field name | Field value |
---|---|
name | Name |
domain_id | DomainId |
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<TriggeringFilterBox, Executable>
Type: Struct
Declarations:
Field name | Field value |
---|---|
executable | Executable |
repeats | Repeats |
authority | AccountId |
filter | TriggeringFilterBox |
metadata | Metadata |
Action<TriggeringFilterBox, OptimizedExecutable>
Type: Struct
Declarations:
Field name | Field value |
---|---|
executable | OptimizedExecutable |
repeats | Repeats |
authority | AccountId |
filter | TriggeringFilterBox |
metadata | Metadata |
Add
Type: Struct
Declarations:
Field name | Field value |
---|---|
left | EvaluatesTo<NumericValue> |
right | EvaluatesTo<NumericValue> |
Algorithm
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Ed25519 | — | 0 |
Secp256k1 | — | 1 |
BlsNormal | — | 2 |
BlsSmall | — | 3 |
And
Type: Struct
Declarations:
Field name | Field value |
---|---|
left | EvaluatesTo<bool> |
right | EvaluatesTo<bool> |
Array<Interval<u16>, 8>
Type: Array
Length: 8
Value: Interval<u16>
Array<Interval<u8>, 4>
Type: Array
Length: 4
Value: Interval<u8>
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: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
ByCreated | — | 0 |
ByMintabilityChanged | — | 1 |
ByOwnerChanged | — | 2 |
ByDeleted | — | 3 |
ByMetadataInserted | — | 4 |
ByMetadataRemoved | — | 5 |
ByTotalQuantityChanged | — | 6 |
AssetDefinitionFilter
Type: Struct
Declarations:
Field name | Field value |
---|---|
origin_filter | FilterOpt<OriginFilter<AssetDefinitionEvent>> |
event_filter | FilterOpt<AssetDefinitionEventFilter> |
AssetDefinitionId
Type: Struct
Declarations:
Field name | Field value |
---|---|
name | Name |
domain_id | DomainId |
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 | NumericValue |
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: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
ByCreated | — | 0 |
ByDeleted | — | 1 |
ByAdded | — | 2 |
ByRemoved | — | 3 |
ByMetadataInserted | — | 4 |
ByMetadataRemoved | — | 5 |
AssetFilter
Type: Struct
Declarations:
Field name | Field value |
---|---|
origin_filter | FilterOpt<OriginFilter<AssetEvent>> |
event_filter | FilterOpt<AssetEventFilter> |
AssetId
Type: Struct
Declarations:
Field name | Field value |
---|---|
definition_id | AssetDefinitionId |
account_id | AccountId |
AssetValue
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Quantity | u32 | 0 |
BigQuantity | u128 | 1 |
Fixed | Fixed | 2 |
Store | Metadata | 3 |
AssetValueType
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Quantity | — | 0 |
BigQuantity | — | 1 |
Fixed | — | 2 |
Store | — | 3 |
AtIndex
Type: Struct
Declarations:
Field name | Field value |
---|---|
index | u32 |
predicate | ValuePredicate |
BatchedResponse<Value>
Type: Struct
Declarations:
Field name | Field value |
---|---|
batch | Value |
cursor | ForwardCursor |
BatchedResponse<Vec<VersionedSignedTransaction>>
Type: Struct
Declarations:
Field name | Field value |
---|---|
batch | Vec<VersionedSignedTransaction> |
cursor | ForwardCursor |
BinaryOpIncompatibleNumericValueTypesError
Type: Struct
Declarations:
Field name | Field value |
---|---|
left | NumericValue |
right | NumericValue |
BlockHeader
Type: Struct
Declarations:
Field name | Field value |
---|---|
height | u64 |
timestamp_ms | u64 |
previous_block_hash | Option<HashOf<VersionedSignedBlock>> |
transactions_hash | Option<HashOf<MerkleTree<VersionedSignedTransaction>>> |
commit_topology | Vec<PeerId> |
view_change_index | u64 |
consensus_estimation_ms | u64 |
BlockMessage
Type: Alias
BlockPayload
Type: Struct
Declarations:
Field name | Field value |
---|---|
header | BlockHeader |
transactions | Vec<TransactionValue> |
event_recommendations | Vec<Event> |
BlockRejectionReason
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
ConsensusBlockRejection | — | 0 |
BlockSubscriptionRequest
Type: Alias
To: NonZero<u64>
BurnBox
Type: Struct
Declarations:
Field name | Field value |
---|---|
object | EvaluatesTo<Value> |
destination_id | EvaluatesTo<IdBox> |
Conditional
Type: Struct
Declarations:
Field name | Field value |
---|---|
condition | EvaluatesTo<bool> |
then | InstructionBox |
otherwise | Option<InstructionBox> |
ConfigurationEvent
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Changed | ParameterId | 0 |
Created | ParameterId | 1 |
Deleted | ParameterId | 2 |
Container
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Any | ValuePredicate | 0 |
All | ValuePredicate | 1 |
AtIndex | AtIndex | 2 |
ValueOfKey | ValueOfKey | 3 |
HasKey | Name | 4 |
Contains
Type: Struct
Declarations:
Field name | Field value |
---|---|
collection | EvaluatesTo<Vec<Value>> |
element | EvaluatesTo<Value> |
ContainsAll
Type: Struct
Declarations:
Field name | Field value |
---|---|
collection | EvaluatesTo<Vec<Value>> |
elements | EvaluatesTo<Vec<Value>> |
ContainsAny
Type: Struct
Declarations:
Field name | Field value |
---|---|
collection | EvaluatesTo<Vec<Value>> |
elements | EvaluatesTo<Vec<Value>> |
ContextValue
Type: Struct
Declarations:
Field name | Field value |
---|---|
value_name | Name |
DataEntityFilter
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
ByPeer | FilterOpt<PeerFilter> | 0 |
ByDomain | FilterOpt<DomainFilter> | 1 |
ByAccount | FilterOpt<AccountFilter> | 2 |
ByAssetDefinition | FilterOpt<AssetDefinitionFilter> | 3 |
ByAsset | FilterOpt<AssetFilter> | 4 |
ByTrigger | FilterOpt<TriggerFilter> | 5 |
ByRole | FilterOpt<RoleFilter> | 6 |
DataEvent
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Peer | PeerEvent | 0 |
Domain | DomainEvent | 1 |
Account | AccountEvent | 2 |
AssetDefinition | AssetDefinitionEvent | 3 |
Asset | AssetEvent | 4 |
Trigger | TriggerEvent | 5 |
Role | RoleEvent | 6 |
PermissionToken | PermissionTokenSchemaUpdateEvent | 7 |
Configuration | ConfigurationEvent | 8 |
Validator | ValidatorEvent | 9 |
Divide
Type: Struct
Declarations:
Field name | Field value |
---|---|
left | EvaluatesTo<NumericValue> |
right | EvaluatesTo<NumericValue> |
Domain
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | DomainId |
accounts | SortedMap<AccountId, Account> |
asset_definitions | SortedMap<AssetDefinitionId, AssetDefinition> |
asset_total_quantities | SortedMap<AssetDefinitionId, NumericValue> |
logo | Option<IpfsPath> |
metadata | Metadata |
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 |
DomainEventFilter
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
ByCreated | — | 0 |
ByDeleted | — | 1 |
ByMetadataInserted | — | 2 |
ByMetadataRemoved | — | 3 |
ByAccount | FilterOpt<AccountFilter> | 4 |
ByAssetDefinition | FilterOpt<AssetDefinitionFilter> | 5 |
DomainFilter
Type: Struct
Declarations:
Field name | Field value |
---|---|
origin_filter | FilterOpt<OriginFilter<DomainEvent>> |
event_filter | FilterOpt<DomainEventFilter> |
DomainId
Type: Struct
Declarations:
Field name | Field value |
---|---|
name | Name |
Duration
Type: Tuple
Values: (u64
, u32
)
Equal
Type: Struct
Declarations:
Field name | Field value |
---|---|
left | EvaluatesTo<Value> |
right | EvaluatesTo<Value> |
EvaluatesTo<AccountId>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<AssetDefinitionId>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<AssetId>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<DomainId>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<HashOf<VersionedSignedBlock>>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<HashOf<VersionedSignedTransaction>>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<IdBox>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<Level>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<Name>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<NumericValue>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<Parameter>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<RegistrableBox>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<RoleId>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<String>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<TriggerId>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<UpgradableBox>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<Value>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<Vec<Value>>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluatesTo<bool>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | Expression |
EvaluationError
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Math | MathError | 0 |
Validation | ValidationFail | 1 |
Find | String | 2 |
Conversion | String | 3 |
Event
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Pipeline | PipelineEvent | 0 |
Data | DataEvent | 1 |
Time | TimeEvent | 2 |
ExecuteTrigger | ExecuteTriggerEvent | 3 |
Notification | NotificationEvent | 4 |
EventMessage
Type: Alias
To: Event
EventSubscriptionRequest
Type: Alias
To: FilterBox
Executable
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Instructions | Vec<InstructionBox> | 0 |
Wasm | WasmSmartContract | 1 |
ExecuteTriggerBox
Type: Struct
Declarations:
Field name | Field value |
---|---|
trigger_id | EvaluatesTo<TriggerId> |
ExecuteTriggerEvent
Type: Struct
Declarations:
Field name | Field value |
---|---|
trigger_id | TriggerId |
authority | AccountId |
ExecuteTriggerEventFilter
Type: Struct
Declarations:
Field name | Field value |
---|---|
trigger_id | TriggerId |
authority | AccountId |
ExecutionTime
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
PreCommit | — | 0 |
Schedule | Schedule | 1 |
Expression
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Add | Add | 0 |
Subtract | Subtract | 1 |
Multiply | Multiply | 2 |
Divide | Divide | 3 |
Mod | Mod | 4 |
RaiseTo | RaiseTo | 5 |
Greater | Greater | 6 |
Less | Less | 7 |
Equal | Equal | 8 |
Not | Not | 9 |
And | And | 10 |
Or | Or | 11 |
If | If | 12 |
Raw | Value | 13 |
Query | QueryBox | 14 |
Contains | Contains | 15 |
ContainsAll | ContainsAll | 16 |
ContainsAny | ContainsAny | 17 |
Where | Where | 18 |
ContextValue | ContextValue | 19 |
FailBox
Type: Struct
Declarations:
Field name | Field value |
---|---|
message | String |
FilterBox
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Pipeline | PipelineEventFilter | 0 |
Data | FilterOpt<DataEntityFilter> | 1 |
Time | TimeEventFilter | 2 |
ExecuteTrigger | ExecuteTriggerEventFilter | 3 |
Notification | NotificationEventFilter | 4 |
FilterOpt<AccountEventFilter>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | AccountEventFilter | 1 |
FilterOpt<AccountFilter>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | AccountFilter | 1 |
FilterOpt<AssetDefinitionEventFilter>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | AssetDefinitionEventFilter | 1 |
FilterOpt<AssetDefinitionFilter>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | AssetDefinitionFilter | 1 |
FilterOpt<AssetEventFilter>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | AssetEventFilter | 1 |
FilterOpt<AssetFilter>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | AssetFilter | 1 |
FilterOpt<DataEntityFilter>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | DataEntityFilter | 1 |
FilterOpt<DomainEventFilter>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | DomainEventFilter | 1 |
FilterOpt<DomainFilter>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | DomainFilter | 1 |
FilterOpt<OriginFilter<AccountEvent>>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | OriginFilter<AccountEvent> | 1 |
FilterOpt<OriginFilter<AssetDefinitionEvent>>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | OriginFilter<AssetDefinitionEvent> | 1 |
FilterOpt<OriginFilter<AssetEvent>>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | OriginFilter<AssetEvent> | 1 |
FilterOpt<OriginFilter<DomainEvent>>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | OriginFilter<DomainEvent> | 1 |
FilterOpt<OriginFilter<PeerEvent>>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | OriginFilter<PeerEvent> | 1 |
FilterOpt<OriginFilter<RoleEvent>>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | OriginFilter<RoleEvent> | 1 |
FilterOpt<OriginFilter<TriggerEvent>>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | OriginFilter<TriggerEvent> | 1 |
FilterOpt<PeerEventFilter>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | PeerEventFilter | 1 |
FilterOpt<PeerFilter>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | PeerFilter | 1 |
FilterOpt<RoleEventFilter>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | RoleEventFilter | 1 |
FilterOpt<RoleFilter>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | RoleFilter | 1 |
FilterOpt<TriggerEventFilter>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | TriggerEventFilter | 1 |
FilterOpt<TriggerFilter>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
BySome | TriggerFilter | 1 |
FindAccountById
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | EvaluatesTo<AccountId> |
FindAccountKeyValueByIdAndKey
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | EvaluatesTo<AccountId> |
key | EvaluatesTo<Name> |
FindAccountsByDomainId
Type: Struct
Declarations:
Field name | Field value |
---|---|
domain_id | EvaluatesTo<DomainId> |
FindAccountsByName
Type: Struct
Declarations:
Field name | Field value |
---|---|
name | EvaluatesTo<Name> |
FindAccountsWithAsset
Type: Struct
Declarations:
Field name | Field value |
---|---|
asset_definition_id | EvaluatesTo<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 | EvaluatesTo<AssetId> |
FindAssetDefinitionById
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | EvaluatesTo<AssetDefinitionId> |
FindAssetDefinitionKeyValueByIdAndKey
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | EvaluatesTo<AssetDefinitionId> |
key | EvaluatesTo<Name> |
FindAssetKeyValueByIdAndKey
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | EvaluatesTo<AssetId> |
key | EvaluatesTo<Name> |
FindAssetQuantityById
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | EvaluatesTo<AssetId> |
FindAssetsByAccountId
Type: Struct
Declarations:
Field name | Field value |
---|---|
account_id | EvaluatesTo<AccountId> |
FindAssetsByAssetDefinitionId
Type: Struct
Declarations:
Field name | Field value |
---|---|
asset_definition_id | EvaluatesTo<AssetDefinitionId> |
FindAssetsByDomainId
Type: Struct
Declarations:
Field name | Field value |
---|---|
domain_id | EvaluatesTo<DomainId> |
FindAssetsByDomainIdAndAssetDefinitionId
Type: Struct
Declarations:
Field name | Field value |
---|---|
domain_id | EvaluatesTo<DomainId> |
asset_definition_id | EvaluatesTo<AssetDefinitionId> |
FindAssetsByName
Type: Struct
Declarations:
Field name | Field value |
---|---|
name | EvaluatesTo<Name> |
FindBlockHeaderByHash
Type: Struct
Declarations:
Field name | Field value |
---|---|
hash | EvaluatesTo<HashOf<VersionedSignedBlock>> |
FindDomainById
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | EvaluatesTo<DomainId> |
FindDomainKeyValueByIdAndKey
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | EvaluatesTo<DomainId> |
key | EvaluatesTo<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<VersionedSignedBlock> | 5 |
Transaction | HashOf<VersionedSignedTransaction> | 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 | EvaluatesTo<AccountId> |
FindRoleByRoleId
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | EvaluatesTo<RoleId> |
FindRolesByAccountId
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | EvaluatesTo<AccountId> |
FindTotalAssetQuantityByAssetDefinitionId
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | EvaluatesTo<AssetDefinitionId> |
FindTransactionByHash
Type: Struct
Declarations:
Field name | Field value |
---|---|
hash | EvaluatesTo<HashOf<VersionedSignedTransaction>> |
FindTransactionsByAccountId
Type: Struct
Declarations:
Field name | Field value |
---|---|
account_id | EvaluatesTo<AccountId> |
FindTriggerById
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | EvaluatesTo<TriggerId> |
FindTriggerKeyValueByIdAndKey
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | EvaluatesTo<TriggerId> |
key | EvaluatesTo<Name> |
FindTriggersByDomainId
Type: Struct
Declarations:
Field name | Field value |
---|---|
domain_id | EvaluatesTo<DomainId> |
Fixed
Type: Alias
To: FixedPoint<i64>
FixedPoint<i64>
Type: Fixed Point
Base: i64
Decimal places: 9
ForwardCursor
Type: Struct
Declarations:
Field name | Field value |
---|---|
query_id | Option<String> |
cursor | Option<NonZero<u64>> |
GenericPredicateBox<ValuePredicate>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
And | NonTrivial<GenericPredicateBox<ValuePredicate>> | 0 |
Or | NonTrivial<GenericPredicateBox<ValuePredicate>> | 1 |
Not | GenericPredicateBox<ValuePredicate> | 2 |
Raw | ValuePredicate | 3 |
GrantBox
Type: Struct
Declarations:
Field name | Field value |
---|---|
object | EvaluatesTo<Value> |
destination_id | EvaluatesTo<IdBox> |
Greater
Type: Struct
Declarations:
Field name | Field value |
---|---|
left | EvaluatesTo<NumericValue> |
right | EvaluatesTo<NumericValue> |
Hash
Type: Alias
To: Array<u8, 32>
HashOf<MerkleTree<VersionedSignedTransaction>>
Type: Alias
To: Hash
HashOf<VersionedSignedBlock>
Type: Alias
To: Hash
HashOf<VersionedSignedTransaction>
Type: Alias
To: Hash
HashOf<WasmSmartContract>
Type: Alias
To: Hash
HashValue
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Transaction | HashOf<VersionedSignedTransaction> | 0 |
Block | HashOf<VersionedSignedBlock> | 1 |
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 | TriggerBox | 9 |
Role | Role | 10 |
Parameter | Parameter | 11 |
If
Type: Struct
Declarations:
Field name | Field value |
---|---|
condition | EvaluatesTo<bool> |
then | EvaluatesTo<Value> |
otherwise | EvaluatesTo<Value> |
InstructionBox
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Register | RegisterBox | 0 |
Unregister | UnregisterBox | 1 |
Mint | MintBox | 2 |
Burn | BurnBox | 3 |
Transfer | TransferBox | 4 |
If | Conditional | 5 |
Pair | Pair | 6 |
Sequence | SequenceBox | 7 |
SetKeyValue | SetKeyValueBox | 8 |
RemoveKeyValue | RemoveKeyValueBox | 9 |
Grant | GrantBox | 10 |
Revoke | RevokeBox | 11 |
ExecuteTrigger | ExecuteTriggerBox | 12 |
SetParameter | SetParameterBox | 13 |
NewParameter | NewParameterBox | 14 |
Upgrade | UpgradeBox | 15 |
Log | LogBox | 16 |
Fail | FailBox | 17 |
InstructionEvaluationError
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Expression | EvaluationError | 0 |
Unsupported | InstructionType | 1 |
PermissionParameter | String | 2 |
Type | TypeError | 3 |
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 |
If | — | 5 |
Pair | — | 6 |
Sequence | — | 7 |
SetKeyValue | — | 8 |
RemoveKeyValue | — | 9 |
Grant | — | 10 |
Revoke | — | 11 |
ExecuteTrigger | — | 12 |
SetParameter | — | 13 |
NewParameter | — | 14 |
Upgrade | — | 15 |
Log | — | 16 |
Fail | — | 17 |
Interval<u16>
Type: Struct
Declarations:
Field name | Field value |
---|---|
start | u16 |
limit | u16 |
Interval<u8>
Type: Struct
Declarations:
Field name | Field value |
---|---|
start | u8 |
limit | u8 |
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>
Ipv4Predicate
Type: Alias
Ipv6Addr
Type: Alias
To: Array<u16, 8>
Ipv6Predicate
Type: Alias
IsAssetDefinitionOwner
Type: Struct
Declarations:
Field name | Field value |
---|---|
asset_definition_id | EvaluatesTo<AssetDefinitionId> |
account_id | EvaluatesTo<AccountId> |
LengthLimits
Type: Struct
Declarations:
Field name | Field value |
---|---|
min | u32 |
max | u32 |
Less
Type: Struct
Declarations:
Field name | Field value |
---|---|
left | EvaluatesTo<NumericValue> |
right | EvaluatesTo<NumericValue> |
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 |
---|---|
max_len | u32 |
max_entry_byte_size | u32 |
LogBox
Type: Struct
Declarations:
Field name | Field value |
---|---|
level | EvaluatesTo<Level> |
msg | EvaluatesTo<String> |
MathError
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Overflow | — | 0 |
NotEnoughQuantity | — | 1 |
DivideByZero | — | 2 |
NegativeValue | — | 3 |
DomainViolation | — | 4 |
Unknown | — | 5 |
BinaryOpIncompatibleNumericValueTypes | BinaryOpIncompatibleNumericValueTypesError | 6 |
FixedPointConversion | String | 7 |
MerkleTree<VersionedSignedTransaction>
Type: Vec
Value: HashOf<VersionedSignedTransaction>
Metadata
Type: Struct
Declarations:
Field name | Field value |
---|---|
map | SortedMap<Name, Value> |
MetadataChanged<AccountId>
Type: Struct
Declarations:
Field name | Field value |
---|---|
target_id | AccountId |
key | Name |
value | Value |
MetadataChanged<AssetDefinitionId>
Type: Struct
Declarations:
Field name | Field value |
---|---|
target_id | AssetDefinitionId |
key | Name |
value | Value |
MetadataChanged<AssetId>
Type: Struct
Declarations:
Field name | Field value |
---|---|
target_id | AssetId |
key | Name |
value | Value |
MetadataChanged<DomainId>
Type: Struct
Declarations:
Field name | Field value |
---|---|
target_id | DomainId |
key | Name |
value | Value |
MetadataError
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
EntryTooBig | SizeError | 0 |
OverallSize | SizeError | 1 |
EmptyPath | — | 2 |
MissingSegment | Name | 3 |
InvalidSegment | Name | 4 |
MintBox
Type: Struct
Declarations:
Field name | Field value |
---|---|
object | EvaluatesTo<Value> |
destination_id | EvaluatesTo<IdBox> |
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<AssetDefinitionId>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expected | AssetDefinitionId |
actual | AssetDefinitionId |
Mismatch<AssetValueType>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expected | AssetValueType |
actual | AssetValueType |
Mismatch<Value>
Type: Struct
Declarations:
Field name | Field value |
---|---|
expected | Value |
actual | Value |
Mod
Type: Struct
Declarations:
Field name | Field value |
---|---|
left | EvaluatesTo<NumericValue> |
right | EvaluatesTo<NumericValue> |
Multiply
Type: Struct
Declarations:
Field name | Field value |
---|---|
left | EvaluatesTo<NumericValue> |
right | EvaluatesTo<NumericValue> |
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 |
NewParameterBox
Type: Struct
Declarations:
Field name | Field value |
---|---|
parameter | EvaluatesTo<Parameter> |
NewRole
Type: Struct
Declarations:
Field name | Field value |
---|---|
inner | Role |
NonTrivial<GenericPredicateBox<ValuePredicate>>
Type: Alias
To: Vec<GenericPredicateBox<ValuePredicate>>
NonZero<u32>
Type: Alias
To: u32
NonZero<u64>
Type: Alias
To: u64
Not
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | EvaluatesTo<bool> |
NotificationEvent
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
TriggerCompleted | TriggerCompletedEvent | 0 |
NotificationEventFilter
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AcceptAll | — | 0 |
TriggerCompleted | TriggerCompletedEventFilter | 1 |
NumericValue
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
U32 | u32 | 0 |
U64 | u64 | 1 |
U128 | u128 | 2 |
Fixed | Fixed | 3 |
OptimizedExecutable
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
WasmInternalRepr | WasmInternalRepr | 0 |
Instructions | Vec<InstructionBox> | 1 |
Option<DomainId>
Type: Option
Some: DomainId
Option<Duration>
Type: Option
Some: Duration
Option<Hash>
Type: Option
Some: Hash
Option<HashOf<MerkleTree<VersionedSignedTransaction>>>
Type: Option
Some: HashOf<MerkleTree<VersionedSignedTransaction>>
Option<HashOf<VersionedSignedBlock>>
Type: Option
Some: HashOf<VersionedSignedBlock>
Option<InstructionBox>
Type: Option
Some: InstructionBox
Option<IpfsPath>
Type: Option
Some: IpfsPath
Option<NonZero<u32>>
Type: Option
Some: NonZero<u32>
Option<NonZero<u64>>
Type: Option
Some: NonZero<u64>
Option<PipelineEntityKind>
Type: Option
Some: PipelineEntityKind
Option<PipelineStatusKind>
Type: Option
Some: PipelineStatusKind
Option<String>
Type: Option
Some: String
Option<TimeInterval>
Type: Option
Some: TimeInterval
Option<TransactionRejectionReason>
Type: Option
Some: TransactionRejectionReason
Option<TriggerCompletedOutcomeType>
Type: Option
Some: TriggerCompletedOutcomeType
Option<TriggerId>
Type: Option
Some: TriggerId
Or
Type: Struct
Declarations:
Field name | Field value |
---|---|
left | EvaluatesTo<bool> |
right | EvaluatesTo<bool> |
OriginFilter<AccountEvent>
Type: Alias
To: AccountId
OriginFilter<AssetDefinitionEvent>
Type: Alias
OriginFilter<AssetEvent>
Type: Alias
To: AssetId
OriginFilter<DomainEvent>
Type: Alias
To: DomainId
OriginFilter<PeerEvent>
Type: Alias
To: PeerId
OriginFilter<RoleEvent>
Type: Alias
To: RoleId
OriginFilter<TriggerEvent>
Type: Alias
To: TriggerId
Pair
Type: Struct
Declarations:
Field name | Field value |
---|---|
left_instruction | InstructionBox |
right_instruction | InstructionBox |
Parameter
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | ParameterId |
val | Value |
ParameterId
Type: Struct
Declarations:
Field name | Field value |
---|---|
name | Name |
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: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
ByAdded | — | 0 |
ByRemoved | — | 1 |
PeerFilter
Type: Struct
Declarations:
Field name | Field value |
---|---|
origin_filter | FilterOpt<OriginFilter<PeerEvent>> |
event_filter | FilterOpt<PeerEventFilter> |
PeerId
Type: Struct
Declarations:
Field name | Field value |
---|---|
address | SocketAddr |
public_key | PublicKey |
PermissionRemoved
Type: Struct
Declarations:
Field name | Field value |
---|---|
role_id | RoleId |
permission_token_id | Name |
PermissionToken
Type: Struct
Declarations:
Field name | Field value |
---|---|
definition_id | Name |
payload | StringWithJson |
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 |
PipelineEntityKind
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Block | — | 0 |
Transaction | — | 1 |
PipelineEvent
Type: Struct
Declarations:
Field name | Field value |
---|---|
entity_kind | PipelineEntityKind |
status | PipelineStatus |
hash | Hash |
PipelineEventFilter
Type: Struct
Declarations:
Field name | Field value |
---|---|
entity_kind | Option<PipelineEntityKind> |
status_kind | Option<PipelineStatusKind> |
hash | Option<Hash> |
PipelineRejectionReason
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Block | BlockRejectionReason | 0 |
Transaction | TransactionRejectionReason | 1 |
PipelineStatus
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Validating | — | 0 |
Rejected | PipelineRejectionReason | 1 |
Committed | — | 2 |
PipelineStatusKind
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Validating | — | 0 |
Rejected | — | 1 |
Committed | — | 2 |
PublicKey
Type: Struct
Declarations:
Field name | Field value |
---|---|
digest_function | 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 |
IsAssetDefinitionOwner | IsAssetDefinitionOwner | 17 |
FindAssetKeyValueByIdAndKey | FindAssetKeyValueByIdAndKey | 18 |
FindAssetDefinitionKeyValueByIdAndKey | FindAssetDefinitionKeyValueByIdAndKey | 19 |
FindAllDomains | FindAllDomains | 20 |
FindDomainById | FindDomainById | 21 |
FindDomainKeyValueByIdAndKey | FindDomainKeyValueByIdAndKey | 22 |
FindAllPeers | FindAllPeers | 23 |
FindAllBlocks | FindAllBlocks | 24 |
FindAllBlockHeaders | FindAllBlockHeaders | 25 |
FindBlockHeaderByHash | FindBlockHeaderByHash | 26 |
FindAllTransactions | FindAllTransactions | 27 |
FindTransactionsByAccountId | FindTransactionsByAccountId | 28 |
FindTransactionByHash | FindTransactionByHash | 29 |
FindPermissionTokensByAccountId | FindPermissionTokensByAccountId | 30 |
FindPermissionTokenSchema | FindPermissionTokenSchema | 31 |
FindAllActiveTriggerIds | FindAllActiveTriggerIds | 32 |
FindTriggerById | FindTriggerById | 33 |
FindTriggerKeyValueByIdAndKey | FindTriggerKeyValueByIdAndKey | 34 |
FindTriggersByDomainId | FindTriggersByDomainId | 35 |
FindAllRoles | FindAllRoles | 36 |
FindAllRoleIds | FindAllRoleIds | 37 |
FindRoleByRoleId | FindRoleByRoleId | 38 |
FindRolesByAccountId | FindRolesByAccountId | 39 |
FindAllParameters | FindAllParameters | 40 |
QueryExecutionFail
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Signature | String | 0 |
Evaluate | String | 1 |
Find | FindError | 2 |
Conversion | String | 3 |
Unauthorized | — | 4 |
QueryPayload
Type: Struct
Declarations:
Field name | Field value |
---|---|
authority | AccountId |
query | QueryBox |
filter | GenericPredicateBox<ValuePredicate> |
RaiseTo
Type: Struct
Declarations:
Field name | Field value |
---|---|
left | EvaluatesTo<NumericValue> |
right | EvaluatesTo<NumericValue> |
RawGenesisBlock
Type: Struct
Declarations:
Field name | Field value |
---|---|
transactions | Vec<Vec<InstructionBox>> |
validator | ValidatorMode |
RegisterBox
Type: Struct
Declarations:
Field name | Field value |
---|---|
object | EvaluatesTo<RegistrableBox> |
RegistrableBox
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Peer | Peer | 0 |
Domain | NewDomain | 1 |
Account | NewAccount | 2 |
AssetDefinition | NewAssetDefinition | 3 |
Asset | Asset | 4 |
Trigger | Trigger<TriggeringFilterBox, Executable> | 5 |
Role | NewRole | 6 |
RemoveKeyValueBox
Type: Struct
Declarations:
Field name | Field value |
---|---|
object_id | EvaluatesTo<IdBox> |
key | EvaluatesTo<Name> |
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 |
RevokeBox
Type: Struct
Declarations:
Field name | Field value |
---|---|
object | EvaluatesTo<Value> |
destination_id | EvaluatesTo<IdBox> |
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 | PermissionRemoved | 2 |
RoleEventFilter
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
ByCreated | — | 0 |
ByDeleted | — | 1 |
ByPermissionRemoved | — | 2 |
RoleFilter
Type: Struct
Declarations:
Field name | Field value |
---|---|
origin_filter | FilterOpt<OriginFilter<RoleEvent>> |
event_filter | FilterOpt<RoleEventFilter> |
RoleId
Type: Struct
Declarations:
Field name | Field value |
---|---|
name | Name |
Schedule
Type: Struct
Declarations:
Field name | Field value |
---|---|
start | Duration |
period | Option<Duration> |
SemiInterval<Fixed>
Type: Struct
Declarations:
Field name | Field value |
---|---|
start | Fixed |
limit | Fixed |
SemiInterval<u128>
Type: Struct
Declarations:
Field name | Field value |
---|---|
start | u128 |
limit | u128 |
SemiInterval<u32>
Type: Struct
Declarations:
Field name | Field value |
---|---|
start | u32 |
limit | u32 |
SemiRange
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
U32 | SemiInterval<u32> | 0 |
U128 | SemiInterval<u128> | 1 |
Fixed | SemiInterval<Fixed> | 2 |
SequenceBox
Type: Struct
Declarations:
Field name | Field value |
---|---|
instructions | Vec<InstructionBox> |
SetKeyValueBox
Type: Struct
Declarations:
Field name | Field value |
---|---|
object_id | EvaluatesTo<IdBox> |
key | EvaluatesTo<Name> |
value | EvaluatesTo<Value> |
SetParameterBox
Type: Struct
Declarations:
Field name | Field value |
---|---|
parameter | EvaluatesTo<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: Struct
Declarations:
Field name | Field value |
---|---|
signatures | SignaturesOf<BlockPayload> |
payload | BlockPayload |
SignedQuery
Type: Struct
Declarations:
Field name | Field value |
---|---|
signature | SignatureOf<QueryPayload> |
payload | QueryPayload |
SignedTransaction
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, NumericValue>
Type: Map
Key: AssetDefinitionId
Value: NumericValue
SortedMap<AssetId, Asset>
Type: Map
Key: AssetId
Value: Asset
SortedMap<Name, EvaluatesTo<Value>>
Type: Map
Key: Name
Value: EvaluatesTo<Value>
SortedMap<Name, Value>
Type: Map
Key: Name
Value: Value
SortedVec<PermissionToken>
Type: Vec
Value: PermissionToken
SortedVec<PublicKey>
Type: Vec
Value: PublicKey
SortedVec<RoleId>
Type: Vec
Value: RoleId
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 |
StringWithJson
Type: Alias
To: String
Subtract
Type: Struct
Declarations:
Field name | Field value |
---|---|
left | EvaluatesTo<NumericValue> |
right | EvaluatesTo<NumericValue> |
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 |
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 |
---|---|
creation_time_ms | u64 |
authority | AccountId |
instructions | Executable |
time_to_live_ms | Option<NonZero<u64>> |
nonce | Option<NonZero<u32>> |
metadata | SortedMap<Name, Value> |
TransactionQueryOutput
Type: Struct
Declarations:
Field name | Field value |
---|---|
transaction | TransactionValue |
block_hash | HashOf<VersionedSignedBlock> |
TransactionRejectionReason
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AccountDoesNotExist | FindError | 0 |
LimitCheck | TransactionLimitError | 1 |
Validation | ValidationFail | 2 |
InstructionExecution | InstructionExecutionFail | 3 |
WasmExecution | WasmExecutionFail | 4 |
Expired | — | 5 |
TransactionValue
Type: Struct
Declarations:
Field name | Field value |
---|---|
value | VersionedSignedTransaction |
error | Option<TransactionRejectionReason> |
TransferBox
Type: Struct
Declarations:
Field name | Field value |
---|---|
source_id | EvaluatesTo<IdBox> |
object | EvaluatesTo<Value> |
destination_id | EvaluatesTo<IdBox> |
Trigger<TriggeringFilterBox, Executable>
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | TriggerId |
action | Action<TriggeringFilterBox, Executable> |
Trigger<TriggeringFilterBox, OptimizedExecutable>
Type: Struct
Declarations:
Field name | Field value |
---|---|
id | TriggerId |
action | Action<TriggeringFilterBox, OptimizedExecutable> |
TriggerBox
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Raw | Trigger<TriggeringFilterBox, Executable> | 0 |
Optimized | Trigger<TriggeringFilterBox, OptimizedExecutable> | 1 |
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 |
TriggerEventFilter
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
ByCreated | — | 0 |
ByDeleted | — | 1 |
ByExtended | — | 2 |
ByShortened | — | 3 |
TriggerFilter
Type: Struct
Declarations:
Field name | Field value |
---|---|
origin_filter | FilterOpt<OriginFilter<TriggerEvent>> |
event_filter | FilterOpt<TriggerEventFilter> |
TriggerId
Type: Struct
Declarations:
Field name | Field value |
---|---|
name | Name |
domain_id | Option<DomainId> |
TriggerNumberOfExecutionsChanged
Type: Struct
Declarations:
Field name | Field value |
---|---|
trigger_id | TriggerId |
by | u32 |
TriggeringFilterBox
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Pipeline | PipelineEventFilter | 0 |
Data | FilterOpt<DataEntityFilter> | 1 |
Time | TimeEventFilter | 2 |
ExecuteTrigger | ExecuteTriggerEventFilter | 3 |
TypeError
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
AssetValueType | Mismatch<AssetValueType> | 0 |
ParameterValueType | Mismatch<Value> | 1 |
AssetDefinitionId | Mismatch<AssetDefinitionId> | 2 |
UnregisterBox
Type: Struct
Declarations:
Field name | Field value |
---|---|
object_id | EvaluatesTo<IdBox> |
UpgradableBox
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Validator | Validator | 0 |
UpgradeBox
Type: Struct
Declarations:
Field name | Field value |
---|---|
object | EvaluatesTo<UpgradableBox> |
ValidationFail
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
NotPermitted | String | 0 |
InstructionFailed | InstructionExecutionError | 1 |
QueryFailed | QueryExecutionFail | 2 |
TooComplex | — | 3 |
InternalError | — | 4 |
Validator
Type: Struct
Declarations:
Field name | Field value |
---|---|
wasm | WasmSmartContract |
ValidatorEvent
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Upgraded | — | 0 |
ValidatorMode
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Path | String | 0 |
Inline | Validator | 1 |
Value
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Bool | bool | 0 |
String | String | 1 |
Name | Name | 2 |
Vec | Vec<Value> | 3 |
LimitedMetadata | Metadata | 4 |
MetadataLimits | Limits | 5 |
TransactionLimits | TransactionLimits | 6 |
LengthLimits | LengthLimits | 7 |
Id | IdBox | 8 |
Identifiable | IdentifiableBox | 9 |
PublicKey | PublicKey | 10 |
SignatureCheckCondition | SignatureCheckCondition | 11 |
TransactionQueryOutput | TransactionQueryOutput | 12 |
PermissionToken | PermissionToken | 13 |
PermissionTokenSchema | PermissionTokenSchema | 14 |
Hash | HashValue | 15 |
Block | VersionedSignedBlock | 16 |
BlockHeader | BlockHeader | 17 |
Ipv4Addr | Ipv4Addr | 18 |
Ipv6Addr | Ipv6Addr | 19 |
Numeric | NumericValue | 20 |
Validator | Validator | 21 |
LogLevel | Level | 22 |
ValueOfKey
Type: Struct
Declarations:
Field name | Field value |
---|---|
key | Name |
predicate | ValuePredicate |
ValuePredicate
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
Identifiable | StringPredicate | 0 |
Container | Container | 1 |
Display | StringPredicate | 2 |
Numerical | SemiRange | 3 |
TimeStamp | SemiInterval<u128> | 4 |
Ipv4Addr | Ipv4Predicate | 5 |
Ipv6Addr | Ipv6Predicate | 6 |
Pass | — | 7 |
Vec<Event>
Type: Vec
Value: Event
Vec<GenericPredicateBox<ValuePredicate>>
Type: Vec
Value: GenericPredicateBox<ValuePredicate>
Vec<InstructionBox>
Type: Vec
Value: InstructionBox
Vec<Name>
Type: Vec
Value: Name
Vec<PeerId>
Type: Vec
Value: PeerId
Vec<PublicKey>
Type: Vec
Value: PublicKey
Vec<TransactionValue>
Type: Vec
Value: TransactionValue
Vec<Value>
Type: Vec
Value: Value
Vec<Vec<InstructionBox>>
Type: Vec
Value: Vec<InstructionBox>
Vec<VersionedSignedTransaction>
Type: Vec
Value: VersionedSignedTransaction
Vec<u8>
Type: Vec
Value: u8
VersionedBatchedResponse<Value>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
V1 | BatchedResponse<Value> | 1 |
VersionedBatchedResponse<Vec<VersionedSignedTransaction>>
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
V1 | BatchedResponse<Vec<VersionedSignedTransaction>> | 1 |
VersionedSignedBlock
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
V1 | SignedBlock | 1 |
VersionedSignedQuery
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
V1 | SignedQuery | 1 |
VersionedSignedTransaction
Type: Enum
Variants:
Variant name | Variant value | Discriminant |
---|---|---|
V1 | SignedTransaction | 1 |
WasmExecutionFail
Type: Struct
Declarations:
Field name | Field value |
---|---|
reason | String |
WasmInternalRepr
Type: Struct
Declarations:
Field name | Field value |
---|---|
serialized | Vec<u8> |
blob_hash | HashOf<WasmSmartContract> |
WasmSmartContract
Type: Alias
To: Vec<u8>
Where
Type: Struct
Declarations:
Field name | Field value |
---|---|
expression | EvaluatesTo<Value> |
values | SortedMap<Name, EvaluatesTo<Value>> |
bool
Type: Alias
To: bool
i64
Type: Int
Kind: FixedWidth
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