Serialization⚓︎
Basic Types⚓︎
A quantity of mosaics in absolute units.
It can only be positive or zero. Negative quantities must be indicated by other means (See for example MosaicSupplyChangeTransactionV1 and MosaicSupplyChangeAction).
A time lapse, expressed in number of blocks.
Multiplier applied to the size of a transaction to obtain its fee, in absolute units.
See the fees documentation.
How hard it was to harvest this block.
The initial value is 1e14 and it will remain like this as long as blocks are generated every blockGenerationTargetTime seconds (network property).
If blocks start taking more or less time than the configured value, the difficulty will be adjusted (in the range of 1e13 to 1e15) to try to hit the target time.
See the Technical Reference section 8.1.
Index of a finalization epoch.
The first epoch is number 1 and contains only the first block (the Nemesis block). Epoch duration (in blocks) is defined by the votingSetGrouping network property.
A particular point in time inside a finalization epoch.
See the Technical Reference section 15.2.
Index of a block in the blockchain.
The first block (the Nemesis block) has height 1 and each subsequent block increases height by 1.
Importance score for an account.
See also ImportanceHeight and ImportanceSnapshot.
Block height at which an Importance was calculated.
Either a MosaicId or a NamespaceId.
The most-significant bit of the first byte is 0 for MosaicId's and 1 for NamespaceId's.
A Mosaic identifier.
Number of milliseconds elapsed since the creation of the Nemesis block.
The Nemesis block creation time can be found in the epochAdjustment field returned by the /network/properties REST endpoint. This is the number of seconds elapsed since the UNIX epoch and it is always 1615853185 for Symbol's MAINNET.
Either an Address or a NamespaceId.
The least-significant bit of the first byte is 0 for Addresses and 1 for NamespaceId's.
An address identifies an account and is derived from its PublicKey.
A 32-byte (256 bit) hash.
The exact algorithm is unspecified as it can change depending on where it is used.
A 64-byte (512 bit) hash.
The exact algorithm is unspecified as it can change depending on where it is used.
A 32-byte (256 bit) integer derived from a private key.
It serves as the public identifier of the key pair and can be disseminated widely. It is used to prove that an entity was signed with the paired private key.
A PublicKey used for voting during the finalization process.
A 64-byte (512 bit) array certifying that the signed data has not been modified.
Symbol currently uses Ed25519 signatures.
Enumerations⚓︎
|
UNLINKUnlink an account.
LINKLink an account.
|
MAINNETPublic network.
TESTNETPublic test network.
|
ACCOUNT_KEY_LINKNODE_KEY_LINKAGGREGATE_COMPLETEAGGREGATE_BONDEDVOTING_KEY_LINKVRF_KEY_LINKHASH_LOCKSECRET_LOCKSECRET_PROOFACCOUNT_METADATAMOSAIC_METADATANAMESPACE_METADATAMOSAIC_DEFINITIONMOSAIC_SUPPLY_CHANGEMOSAIC_SUPPLY_REVOCATIONMULTISIG_ACCOUNT_MODIFICATIONADDRESS_ALIASMOSAIC_ALIASNAMESPACE_REGISTRATIONACCOUNT_ADDRESS_RESTRICTIONACCOUNT_MOSAIC_RESTRICTIONACCOUNT_OPERATION_RESTRICTIONMOSAIC_ADDRESS_RESTRICTIONMOSAIC_GLOBAL_RESTRICTIONTRANSFER
|
NEMESISnemesis block
NORMALnormal block
IMPORTANCEimportance block
|
MOSAIC_RENTAL_FEEMosaic rental fee receipt.
NAMESPACE_RENTAL_FEENamespace rental fee receipt.
HARVEST_FEEHarvest fee receipt.
LOCK_HASH_COMPLETEDHash lock completed receipt.
LOCK_HASH_EXPIREDHash lock expired receipt.
LOCK_SECRET_COMPLETEDSecret lock completed receipt.
LOCK_SECRET_EXPIREDSecret lock expired receipt.
LOCK_HASH_CREATEDHash lock created receipt.
LOCK_SECRET_CREATEDSecret lock created receipt.
MOSAIC_EXPIREDMosaic expired receipt.
NAMESPACE_EXPIREDNamespace expired receipt.
NAMESPACE_DELETEDNamespace deleted receipt.
INFLATIONInflation receipt.
TRANSACTION_GROUPTransaction group receipt.
ADDRESS_ALIAS_RESOLUTIONAddress alias resolution receipt.
MOSAIC_ALIAS_RESOLUTIONMosaic alias resolution receipt.
|
ROOTRoot namespace.
CHILDChild namespace.
|
UNLINKUnlink a namespace, removing the alias.
LINKLink a namespace, creating an alias.
|
SHA3_256Input is hashed using SHA-3 256.
HASH_160Input is hashed twice: first with SHA-256 and then with RIPEMD-160 (bitcoin's OP_HASH160).
HASH_256Input is hashed twice with SHA-256 (bitcoin's OP_HASH256).
|
NONENo flags present.
SUPPLY_MUTABLEMosaic supports supply changes through a MosaicSupplyChangeTransactionV1 even when mosaic creator only owns a partial supply.
If the mosaic creator owns the totality of the supply, it can be changed even if this flag is not set.
TRANSFERABLEMosaic supports TransferTransactionV1 between arbitrary accounts. When not set, this mosaic can only be transferred to or from the mosaic creator.
RESTRICTABLEMosaic supports custom restrictions configured by the mosaic creator.
See MosaicAddressRestrictionTransactionV1 and MosaicGlobalRestrictionTransactionV1.
REVOKABLEMosaic supports revocation of tokens by the mosaic creator.
|
DECREASEDecreases the supply.
INCREASEIncreases the supply.
|
ADDRESSRestriction type is an address.
MOSAIC_IDRestriction type is a mosaic identifier.
TRANSACTION_TYPERestriction type is a transaction type.
OUTGOINGRestriction is interpreted as outgoing.
BLOCKRestriction is interpreted as blocking (instead of allowing) operation.
|
NONEUninitialized value indicating no restriction.
EQAllow if equal.
NEAllow if not equal.
LTAllow if less than.
LEAllow if less than or equal.
GTAllow if greater than.
GEAllow if greater than or equal.
|
UNLINKEDaccount is not linked to another account
MAINaccount is a balance-holding account that is linked to a remote harvester account
REMOTEaccount is a remote harvester account that is linked to a balance-holding account
REMOTE_UNLINKEDaccount is a remote harvester eligible account that is unlinked
Note: this allows an account that has previously been used as remote to be reused as a remote
|
UNSETunset key
LINKEDlinked account public key
Note: this can be either a remote or main account public key depending on context
NODEnode public key on which remote is allowed to harvest
VRFVRF public key
|
REGULARregular account
HIGH_VALUEhigh value account eligible to harvest
|
UNUSEDlock is unused
USEDlock was already used
|
ACCOUNTaccount metadata
MOSAICmosaic metadata
NAMESPACEnamespace metadata
|
NONEno alias
MOSAIC_IDif alias is mosaicId
ADDRESSif alias is address
|
ADDRESSaddress restriction
GLOBALglobal (mosaic) restriction
Structures⚓︎
|
|
|
sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
|
sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
|
gammagamma
verification_hashverification hash
scalarscalar
|
sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typeblock type
heightblock height
timestampnumber of milliseconds elapsed since creation of nemesis block
difficultyblock difficulty
generation_hash_proofgeneration hash proof
previous_block_hashprevious block hash
transactions_hashhash of the transactions in this block
receipts_hashhash of the receipts generated by this block
state_hashhash of the global chain state at this block
beneficiary_addressbeneficiary address designated by harvester
fee_multiplierfee multiplier applied to block transactions
|
BLOCK_VERSION1BLOCK_TYPENEMESIS (0x8043)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typeblock type
heightblock height
timestampnumber of milliseconds elapsed since creation of nemesis block
difficultyblock difficulty
generation_hash_proofgeneration hash proof
previous_block_hashprevious block hash
transactions_hashhash of the transactions in this block
receipts_hashhash of the receipts generated by this block
state_hashhash of the global chain state at this block
beneficiary_addressbeneficiary address designated by harvester
fee_multiplierfee multiplier applied to block transactions
voting_eligible_accounts_countnumber of voting eligible accounts
harvesting_​eligible_​accounts_​countnumber of harvesting eligible accounts
total_voting_balancetotal balance eligible for voting
previous_importance_block_hashprevious importance block hash
transactionsvariable sized transaction data
|
BLOCK_VERSION1BLOCK_TYPENORMAL (0x8143)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typeblock type
heightblock height
timestampnumber of milliseconds elapsed since creation of nemesis block
difficultyblock difficulty
generation_hash_proofgeneration hash proof
previous_block_hashprevious block hash
transactions_hashhash of the transactions in this block
receipts_hashhash of the receipts generated by this block
state_hashhash of the global chain state at this block
beneficiary_addressbeneficiary address designated by harvester
fee_multiplierfee multiplier applied to block transactions
block_header_reserved_10reserved padding to align end of BlockHeader on 8-byte boundary
transactionsvariable sized transaction data
|
BLOCK_VERSION1BLOCK_TYPEIMPORTANCE (0x8243)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typeblock type
heightblock height
timestampnumber of milliseconds elapsed since creation of nemesis block
difficultyblock difficulty
generation_hash_proofgeneration hash proof
previous_block_hashprevious block hash
transactions_hashhash of the transactions in this block
receipts_hashhash of the receipts generated by this block
state_hashhash of the global chain state at this block
beneficiary_addressbeneficiary address designated by harvester
fee_multiplierfee multiplier applied to block transactions
voting_eligible_accounts_countnumber of voting eligible accounts
harvesting_​eligible_​accounts_​countnumber of harvesting eligible accounts
total_voting_balancetotal balance eligible for voting
previous_importance_block_hashprevious importance block hash
transactionsvariable sized transaction data
|
|
roundfinalization round
heightfinalization height
hashfinalization hash
|
sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
versionReceipt version.
typeType of receipt.
|
RECEIPT_TYPEHARVEST_FEE (0x2143)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
versionReceipt version.
typeType of receipt.
mosaicModified mosaic.
target_addressAddress of the affected account.
|
RECEIPT_TYPEINFLATION (0x5143)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
versionReceipt version.
typeType of receipt.
mosaicCreated mosaic.
|
RECEIPT_TYPELOCK_HASH_CREATED (0x3148)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
versionReceipt version.
typeType of receipt.
mosaicModified mosaic.
target_addressAddress of the affected account.
|
RECEIPT_TYPELOCK_HASH_COMPLETED (0x2248)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
versionReceipt version.
typeType of receipt.
mosaicModified mosaic.
target_addressAddress of the affected account.
|
RECEIPT_TYPELOCK_HASH_EXPIRED (0x2348)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
versionReceipt version.
typeType of receipt.
mosaicModified mosaic.
target_addressAddress of the affected account.
|
RECEIPT_TYPELOCK_SECRET_CREATED (0x3152)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
versionReceipt version.
typeType of receipt.
mosaicModified mosaic.
target_addressAddress of the affected account.
|
RECEIPT_TYPELOCK_SECRET_COMPLETED (0x2252)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
versionReceipt version.
typeType of receipt.
mosaicModified mosaic.
target_addressAddress of the affected account.
|
RECEIPT_TYPELOCK_SECRET_EXPIRED (0x2352)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
versionReceipt version.
typeType of receipt.
mosaicModified mosaic.
target_addressAddress of the affected account.
|
RECEIPT_TYPEMOSAIC_EXPIRED (0x414d)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
versionReceipt version.
typeType of receipt.
artifact_idExpiring mosaic id.
|
RECEIPT_TYPEMOSAIC_RENTAL_FEE (0x124d)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
versionReceipt version.
typeType of receipt.
mosaicTransferred mosaic
sender_addressAddress of the sender account.
recipient_addressAddress of the recipient account.
|
RECEIPT_TYPENAMESPACE_EXPIRED (0x414e)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
versionReceipt version.
typeType of receipt.
artifact_idExpired namespace identifier.
|
RECEIPT_TYPENAMESPACE_DELETED (0x424e)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
versionReceipt version.
typeType of receipt.
artifact_idDeleted namespace identifier.
|
RECEIPT_TYPENAMESPACE_RENTAL_FEE (0x134e)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
versionReceipt version.
typeType of receipt.
mosaicTransferred mosaic
sender_addressAddress of the sender account.
recipient_addressAddress of the recipient account.
|
primary_idTransaction primary source (e.g. index within the block).
secondary_idTransaction secondary source (e.g. index within aggregate).
|
sourceInformation about the transaction that triggered the receipt.
resolved_valueResolved Address.
|
unresolvedUnresolved address.
resolution_entries_countNumber of resolution entries.
resolution_entriesResolution entries.
|
sourceInformation about the transaction that triggered the receipt.
resolved_valueResolved MosaicId.
|
unresolvedUnresolved mosaic.
resolution_entries_countNumber of resolution entries.
resolution_entriesResolution entries.
|
primary_idTransaction primary source (e.g. index within the block).
secondary_idTransaction secondary source (e.g. index within aggregate).
receipt_countNumber of receipts.
receiptsReceipts.
|
transaction_statement_countNumber of transaction statements.
transaction_statementsTransaction statements.
address_​resolution_​statement_​countNumber of address resolution statements.
address_resolution_statementsAddress resolution statements.
mosaic_​resolution_​statement_​countNumber of mosaic resolution statements.
mosaic_resolution_statementsMosaic resolution statements.
|
TRANSACTION_VERSION1TRANSACTION_TYPEACCOUNT_KEY_LINK (0x414c)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
linked_public_keyLinked public key.
link_actionAccount link action.
|
TRANSACTION_VERSION1TRANSACTION_TYPEACCOUNT_KEY_LINK (0x414c)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
linked_public_keyLinked public key.
link_actionAccount link action.
|
TRANSACTION_VERSION1TRANSACTION_TYPENODE_KEY_LINK (0x424c)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
linked_public_keyLinked public key.
link_actionAccount link action.
|
TRANSACTION_VERSION1TRANSACTION_TYPENODE_KEY_LINK (0x424c)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
linked_public_keyLinked public key.
link_actionAccount link action.
|
|
versionVersion.
signer_public_keyCosigner public key.
signatureTransaction signature.
parent_hashHash of the AggregateBondedTransactionV1 that is signed by this cosignature.
|
TRANSACTION_VERSION1TRANSACTION_TYPEAGGREGATE_COMPLETE (0x4141)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
transactions_hashHash of the aggregate's transaction.
payload_sizeTransaction payload size in bytes.
This is the total number of bytes occupied by all embedded transactions, including any padding present.
aggregate_​transaction_​header_​reserved_​10Reserved padding to align end of AggregateTransactionHeader to an 8-byte boundary.
transactionsEmbedded transaction data.
Transactions are variable-sized and the total payload size is in bytes.
Embedded transactions cannot be aggregates.
cosignaturesCosignatures data.
Fills up remaining body space after transactions.
|
TRANSACTION_VERSION2TRANSACTION_TYPEAGGREGATE_COMPLETE (0x4141)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
transactions_hashHash of the aggregate's transaction.
payload_sizeTransaction payload size in bytes.
This is the total number of bytes occupied by all embedded transactions, including any padding present.
aggregate_​transaction_​header_​reserved_​10Reserved padding to align end of AggregateTransactionHeader to an 8-byte boundary.
transactionsEmbedded transaction data.
Transactions are variable-sized and the total payload size is in bytes.
Embedded transactions cannot be aggregates.
cosignaturesCosignatures data.
Fills up remaining body space after transactions.
|
TRANSACTION_VERSION3TRANSACTION_TYPEAGGREGATE_COMPLETE (0x4141)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
transactions_hashHash of the aggregate's transaction.
payload_sizeTransaction payload size in bytes.
This is the total number of bytes occupied by all embedded transactions, including any padding present.
aggregate_​transaction_​header_​reserved_​10Reserved padding to align end of AggregateTransactionHeader to an 8-byte boundary.
transactionsEmbedded transaction data.
Transactions are variable-sized and the total payload size is in bytes.
Embedded transactions cannot be aggregates.
cosignaturesCosignatures data.
Fills up remaining body space after transactions.
|
TRANSACTION_VERSION1TRANSACTION_TYPEAGGREGATE_BONDED (0x4241)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
transactions_hashHash of the aggregate's transaction.
payload_sizeTransaction payload size in bytes.
This is the total number of bytes occupied by all embedded transactions, including any padding present.
aggregate_​transaction_​header_​reserved_​10Reserved padding to align end of AggregateTransactionHeader to an 8-byte boundary.
transactionsEmbedded transaction data.
Transactions are variable-sized and the total payload size is in bytes.
Embedded transactions cannot be aggregates.
cosignaturesCosignatures data.
Fills up remaining body space after transactions.
|
TRANSACTION_VERSION2TRANSACTION_TYPEAGGREGATE_BONDED (0x4241)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
transactions_hashHash of the aggregate's transaction.
payload_sizeTransaction payload size in bytes.
This is the total number of bytes occupied by all embedded transactions, including any padding present.
aggregate_​transaction_​header_​reserved_​10Reserved padding to align end of AggregateTransactionHeader to an 8-byte boundary.
transactionsEmbedded transaction data.
Transactions are variable-sized and the total payload size is in bytes.
Embedded transactions cannot be aggregates.
cosignaturesCosignatures data.
Fills up remaining body space after transactions.
|
TRANSACTION_VERSION3TRANSACTION_TYPEAGGREGATE_BONDED (0x4241)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
transactions_hashHash of the aggregate's transaction.
payload_sizeTransaction payload size in bytes.
This is the total number of bytes occupied by all embedded transactions, including any padding present.
aggregate_​transaction_​header_​reserved_​10Reserved padding to align end of AggregateTransactionHeader to an 8-byte boundary.
transactionsEmbedded transaction data.
Transactions are variable-sized and the total payload size is in bytes.
Embedded transactions cannot be aggregates.
cosignaturesCosignatures data.
Fills up remaining body space after transactions.
|
TRANSACTION_VERSION1TRANSACTION_TYPEVOTING_KEY_LINK (0x4143)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
linked_public_keyLinked voting public key.
start_epochStarting finalization epoch.
end_epochEnding finalization epoch.
link_actionAccount link action.
|
TRANSACTION_VERSION1TRANSACTION_TYPEVOTING_KEY_LINK (0x4143)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
linked_public_keyLinked voting public key.
start_epochStarting finalization epoch.
end_epochEnding finalization epoch.
link_actionAccount link action.
|
TRANSACTION_VERSION1TRANSACTION_TYPEVRF_KEY_LINK (0x4243)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
linked_public_keyLinked VRF public key.
link_actionAccount link action.
|
TRANSACTION_VERSION1TRANSACTION_TYPEVRF_KEY_LINK (0x4243)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
linked_public_keyLinked VRF public key.
link_actionAccount link action.
|
TRANSACTION_VERSION1TRANSACTION_TYPEHASH_LOCK (0x4148)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
mosaicLocked mosaic.
durationNumber of blocks for which a lock should be valid.
The default maximum is 48h (See the maxHashLockDuration network property).
hashHash of the AggregateBondedTransactionV1 to be confirmed before unlocking the mosaics.
|
TRANSACTION_VERSION1TRANSACTION_TYPEHASH_LOCK (0x4148)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
mosaicLocked mosaic.
durationNumber of blocks for which a lock should be valid.
The default maximum is 48h (See the maxHashLockDuration network property).
hashHash of the AggregateBondedTransactionV1 to be confirmed before unlocking the mosaics.
|
TRANSACTION_VERSION1TRANSACTION_TYPESECRET_LOCK (0x4152)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
recipient_addressAddress that receives the funds once successfully unlocked by a SecretProofTransactionV1.
secretHashed proof.
mosaicLocked mosaics.
durationNumber of blocks to wait for the SecretProofTransactionV1.
hash_algorithmAlgorithm used to hash the proof.
|
TRANSACTION_VERSION1TRANSACTION_TYPESECRET_LOCK (0x4152)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
recipient_addressAddress that receives the funds once successfully unlocked by a SecretProofTransactionV1.
secretHashed proof.
mosaicLocked mosaics.
durationNumber of blocks to wait for the SecretProofTransactionV1.
hash_algorithmAlgorithm used to hash the proof.
|
TRANSACTION_VERSION1TRANSACTION_TYPESECRET_PROOF (0x4252)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
recipient_addressAddress that receives the funds once unlocked.
secretHashed proof.
proof_sizeProof size in bytes
hash_algorithmAlgorithm used to hash the proof.
proofOriginal random set of bytes that were hashed.
|
TRANSACTION_VERSION1TRANSACTION_TYPESECRET_PROOF (0x4252)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
recipient_addressAddress that receives the funds once unlocked.
secretHashed proof.
proof_sizeProof size in bytes
hash_algorithmAlgorithm used to hash the proof.
proofOriginal random set of bytes that were hashed.
|
TRANSACTION_VERSION1TRANSACTION_TYPEACCOUNT_METADATA (0x4144)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
target_addressAccount whose metadata should be modified.
scoped_metadata_keyMetadata key scoped to source, target and type.
value_size_deltaChange in value size in bytes, compared to previous size.
value_sizeSize in bytes of the value array.
valueDifference between existing value and new value.
Note: When there is no existing value, this array is directly used and value_size_delta==value_size.
Note: When there is an existing value, the new value is the byte-wise XOR of the previous value and this array.
|
TRANSACTION_VERSION1TRANSACTION_TYPEACCOUNT_METADATA (0x4144)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
target_addressAccount whose metadata should be modified.
scoped_metadata_keyMetadata key scoped to source, target and type.
value_size_deltaChange in value size in bytes, compared to previous size.
value_sizeSize in bytes of the value array.
valueDifference between existing value and new value.
Note: When there is no existing value, this array is directly used and value_size_delta==value_size.
Note: When there is an existing value, the new value is the byte-wise XOR of the previous value and this array.
|
TRANSACTION_VERSION1TRANSACTION_TYPEMOSAIC_METADATA (0x4244)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
target_addressAccount owning the mosaic whose metadata should be modified.
scoped_metadata_keyMetadata key scoped to source, target and type.
target_mosaic_idMosaic whose metadata should be modified.
value_size_deltaChange in value size in bytes, compared to previous size.
value_sizeSize in bytes of the value array.
valueDifference between existing value and new value.
Note: When there is no existing value, this array is directly used and value_size_delta==value_size.
Note: When there is an existing value, the new value is the byte-wise XOR of the previous value and this array.
|
TRANSACTION_VERSION1TRANSACTION_TYPEMOSAIC_METADATA (0x4244)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
target_addressAccount owning the mosaic whose metadata should be modified.
scoped_metadata_keyMetadata key scoped to source, target and type.
target_mosaic_idMosaic whose metadata should be modified.
value_size_deltaChange in value size in bytes, compared to previous size.
value_sizeSize in bytes of the value array.
valueDifference between existing value and new value.
Note: When there is no existing value, this array is directly used and value_size_delta==value_size.
Note: When there is an existing value, the new value is the byte-wise XOR of the previous value and this array.
|
TRANSACTION_VERSION1TRANSACTION_TYPENAMESPACE_METADATA (0x4344)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
target_addressAccount owning the namespace whose metadata should be modified.
scoped_metadata_keyMetadata key scoped to source, target and type.
target_namespace_idNamespace whose metadata should be modified.
value_size_deltaChange in value size in bytes, compared to previous size.
value_sizeSize in bytes of the value array.
valueDifference between existing value and new value.
Note: When there is no existing value, this array is directly used and value_size_delta==value_size.
Note: When there is an existing value, the new value is the byte-wise XOR of the previous value and this array.
|
TRANSACTION_VERSION1TRANSACTION_TYPENAMESPACE_METADATA (0x4344)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
target_addressAccount owning the namespace whose metadata should be modified.
scoped_metadata_keyMetadata key scoped to source, target and type.
target_namespace_idNamespace whose metadata should be modified.
value_size_deltaChange in value size in bytes, compared to previous size.
value_sizeSize in bytes of the value array.
valueDifference between existing value and new value.
Note: When there is no existing value, this array is directly used and value_size_delta==value_size.
Note: When there is an existing value, the new value is the byte-wise XOR of the previous value and this array.
|
TRANSACTION_VERSION1TRANSACTION_TYPEMOSAIC_DEFINITION (0x414d)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
idUnique mosaic identifier obtained from the generator account's public key and the nonce.
The SDK's can take care of generating this ID for you.
durationMosaic duration expressed in blocks. If set to 0, the mosaic never expires.
nonceRandom nonce used to generate the mosaic id.
flagsMosaic flags.
divisibilityMosaic divisibility.
|
TRANSACTION_VERSION1TRANSACTION_TYPEMOSAIC_DEFINITION (0x414d)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
idUnique mosaic identifier obtained from the generator account's public key and the nonce.
The SDK's can take care of generating this ID for you.
durationMosaic duration expressed in blocks. If set to 0, the mosaic never expires.
nonceRandom nonce used to generate the mosaic id.
flagsMosaic flags.
divisibilityMosaic divisibility.
|
TRANSACTION_VERSION1TRANSACTION_TYPEMOSAIC_SUPPLY_CHANGE (0x424d)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
mosaic_idAffected mosaic identifier.
deltaChange amount. It cannot be negative, use the action field to indicate if this amount should be added or subtracted from the current supply.
actionSupply change action.
|
TRANSACTION_VERSION1TRANSACTION_TYPEMOSAIC_SUPPLY_CHANGE (0x424d)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
mosaic_idAffected mosaic identifier.
deltaChange amount. It cannot be negative, use the action field to indicate if this amount should be added or subtracted from the current supply.
actionSupply change action.
|
TRANSACTION_VERSION1TRANSACTION_TYPEMOSAIC_SUPPLY_REVOCATION (0x434d)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
source_addressAddress from which tokens should be revoked.
mosaicRevoked mosaic and amount.
|
TRANSACTION_VERSION1TRANSACTION_TYPEMOSAIC_SUPPLY_REVOCATION (0x434d)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
source_addressAddress from which tokens should be revoked.
mosaicRevoked mosaic and amount.
|
TRANSACTION_VERSION1TRANSACTION_TYPEMULTISIG_ACCOUNT_MODIFICATION (0x4155)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
min_removal_deltaRelative change to the minimum number of cosignatures required when removing a cosignatory.
E.g., when moving from 0 to 2 cosignatures this number would be 2. When moving from 4 to 3 cosignatures, the number would be -1.
min_approval_deltaRelative change to the minimum number of cosignatures required when approving a transaction.
E.g., when moving from 0 to 2 cosignatures this number would be 2. When moving from 4 to 3 cosignatures, the number would be -1.
address_additions_countNumber of cosignatory address additions.
address_deletions_countNumber of cosignatory address deletions.
multisig_​account_​modification_​transaction_​body_​reserved_​10Reserved padding to align addressAdditions to an 8-byte boundary.
address_additionsCosignatory address additions.
All accounts in this list will be able to cosign transactions on behalf of the multisig account. The number of required cosignatures depends on the configured minimum approval and minimum removal values.
address_deletionsCosignatory address deletions.
All accounts in this list will stop being able to cosign transactions on behalf of the multisig account. A transaction containing any address in this array requires a number of cosignatures at least equal to the minimum removal value.
|
TRANSACTION_VERSION1TRANSACTION_TYPEMULTISIG_ACCOUNT_MODIFICATION (0x4155)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
min_removal_deltaRelative change to the minimum number of cosignatures required when removing a cosignatory.
E.g., when moving from 0 to 2 cosignatures this number would be 2. When moving from 4 to 3 cosignatures, the number would be -1.
min_approval_deltaRelative change to the minimum number of cosignatures required when approving a transaction.
E.g., when moving from 0 to 2 cosignatures this number would be 2. When moving from 4 to 3 cosignatures, the number would be -1.
address_additions_countNumber of cosignatory address additions.
address_deletions_countNumber of cosignatory address deletions.
multisig_​account_​modification_​transaction_​body_​reserved_​10Reserved padding to align addressAdditions to an 8-byte boundary.
address_additionsCosignatory address additions.
All accounts in this list will be able to cosign transactions on behalf of the multisig account. The number of required cosignatures depends on the configured minimum approval and minimum removal values.
address_deletionsCosignatory address deletions.
All accounts in this list will stop being able to cosign transactions on behalf of the multisig account. A transaction containing any address in this array requires a number of cosignatures at least equal to the minimum removal value.
|
TRANSACTION_VERSION1TRANSACTION_TYPEADDRESS_ALIAS (0x424e)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
namespace_idIdentifier of the namespace that will become (or stop being) an alias for the address.
addressAliased address.
alias_actionAlias action.
|
TRANSACTION_VERSION1TRANSACTION_TYPEADDRESS_ALIAS (0x424e)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
namespace_idIdentifier of the namespace that will become (or stop being) an alias for the address.
addressAliased address.
alias_actionAlias action.
|
TRANSACTION_VERSION1TRANSACTION_TYPEMOSAIC_ALIAS (0x434e)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
namespace_idIdentifier of the namespace that will become (or stop being) an alias for the Mosaic.
mosaic_idAliased mosaic identifier.
alias_actionAlias action.
|
TRANSACTION_VERSION1TRANSACTION_TYPEMOSAIC_ALIAS (0x434e)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
namespace_idIdentifier of the namespace that will become (or stop being) an alias for the Mosaic.
mosaic_idAliased mosaic identifier.
alias_actionAlias action.
|
TRANSACTION_VERSION1TRANSACTION_TYPENAMESPACE_REGISTRATION (0x414e)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
durationNumber of confirmed blocks you would like to rent the namespace for. Required for root namespaces.
This field is only present if:registration_type equals ROOTparent_idParent namespace identifier. Required for sub-namespaces.
This field is only present if:registration_type equals CHILDidNamespace identifier.
registration_typeNamespace registration type.
name_sizeNamespace name size in bytes.
nameNamespace name.
|
TRANSACTION_VERSION1TRANSACTION_TYPENAMESPACE_REGISTRATION (0x414e)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
durationNumber of confirmed blocks you would like to rent the namespace for. Required for root namespaces.
This field is only present if:registration_type equals ROOTparent_idParent namespace identifier. Required for sub-namespaces.
This field is only present if:registration_type equals CHILDidNamespace identifier.
registration_typeNamespace registration type.
name_sizeNamespace name size in bytes.
nameNamespace name.
|
TRANSACTION_VERSION1TRANSACTION_TYPEACCOUNT_ADDRESS_RESTRICTION (0x4150)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
restriction_flagsType of restriction being applied to the listed addresses.
restriction_additions_countNumber of addresses being added.
restriction_deletions_countNumber of addresses being removed.
account_​restriction_​transaction_​body_​reserved_​10Reserved padding to align restriction_additions to an 8-byte boundary.
restriction_additionsArray of account addresses being added to the restricted list.
restriction_deletionsArray of account addresses being removed from the restricted list.
|
TRANSACTION_VERSION1TRANSACTION_TYPEACCOUNT_ADDRESS_RESTRICTION (0x4150)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
restriction_flagsType of restriction being applied to the listed addresses.
restriction_additions_countNumber of addresses being added.
restriction_deletions_countNumber of addresses being removed.
account_​restriction_​transaction_​body_​reserved_​10Reserved padding to align restriction_additions to an 8-byte boundary.
restriction_additionsArray of account addresses being added to the restricted list.
restriction_deletionsArray of account addresses being removed from the restricted list.
|
TRANSACTION_VERSION1TRANSACTION_TYPEACCOUNT_MOSAIC_RESTRICTION (0x4250)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
restriction_flagsType of restriction being applied to the listed mosaics.
restriction_additions_countNumber of mosaics being added.
restriction_deletions_countNumber of mosaics being removed.
account_​restriction_​transaction_​body_​reserved_​10Reserved padding to align restriction_additions to an 8-byte boundary.
restriction_additionsArray of mosaics being added to the restricted list.
restriction_deletionsArray of mosaics being removed from the restricted list.
|
TRANSACTION_VERSION1TRANSACTION_TYPEACCOUNT_MOSAIC_RESTRICTION (0x4250)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
restriction_flagsType of restriction being applied to the listed mosaics.
restriction_additions_countNumber of mosaics being added.
restriction_deletions_countNumber of mosaics being removed.
account_​restriction_​transaction_​body_​reserved_​10Reserved padding to align restriction_additions to an 8-byte boundary.
restriction_additionsArray of mosaics being added to the restricted list.
restriction_deletionsArray of mosaics being removed from the restricted list.
|
TRANSACTION_VERSION1TRANSACTION_TYPEACCOUNT_OPERATION_RESTRICTION (0x4350)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
restriction_flagsType of restriction being applied to the listed transaction types.
restriction_additions_countNumber of transaction types being added.
restriction_deletions_countNumber of transaction types being removed.
account_​restriction_​transaction_​body_​reserved_​10Reserved padding to align restriction_additions to an 8-byte boundary.
restriction_additionsArray of transaction types being added to the restricted list.
restriction_deletionsArray of transaction types being rtemoved from the restricted list.
|
TRANSACTION_VERSION1TRANSACTION_TYPEACCOUNT_OPERATION_RESTRICTION (0x4350)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
restriction_flagsType of restriction being applied to the listed transaction types.
restriction_additions_countNumber of transaction types being added.
restriction_deletions_countNumber of transaction types being removed.
account_​restriction_​transaction_​body_​reserved_​10Reserved padding to align restriction_additions to an 8-byte boundary.
restriction_additionsArray of transaction types being added to the restricted list.
restriction_deletionsArray of transaction types being rtemoved from the restricted list.
|
TRANSACTION_VERSION1TRANSACTION_TYPEMOSAIC_ADDRESS_RESTRICTION (0x4251)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
mosaic_idIdentifier of the mosaic to which the restriction applies.
restriction_keyRestriction key.
previous_restriction_valuePrevious restriction value. Set previousRestrictionValue to FFFFFFFFFFFFFFFF if the target address does not have a previous restriction value for this mosaic id and restriction key.
new_restriction_valueNew restriction value.
target_addressAddress being restricted.
|
TRANSACTION_VERSION1TRANSACTION_TYPEMOSAIC_ADDRESS_RESTRICTION (0x4251)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
mosaic_idIdentifier of the mosaic to which the restriction applies.
restriction_keyRestriction key.
previous_restriction_valuePrevious restriction value. Set previousRestrictionValue to FFFFFFFFFFFFFFFF if the target address does not have a previous restriction value for this mosaic id and restriction key.
new_restriction_valueNew restriction value.
target_addressAddress being restricted.
|
TRANSACTION_VERSION1TRANSACTION_TYPEMOSAIC_GLOBAL_RESTRICTION (0x4151)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
mosaic_idIdentifier of the mosaic being restricted. The mosaic creator must be the signer of the transaction.
reference_mosaic_idIdentifier of the mosaic providing the restriction key. The mosaic global restriction for the mosaic identifier depends on global restrictions set on the reference mosaic. Set reference_mosaic_id to 0 if the mosaic giving the restriction equals the mosaic_id.
restriction_keyRestriction key relative to the reference mosaic identifier.
previous_restriction_valuePrevious restriction value.
new_restriction_valueNew restriction value.
previous_restriction_typePrevious restriction type.
new_restriction_typeNew restriction type.
|
TRANSACTION_VERSION1TRANSACTION_TYPEMOSAIC_GLOBAL_RESTRICTION (0x4151)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
mosaic_idIdentifier of the mosaic being restricted. The mosaic creator must be the signer of the transaction.
reference_mosaic_idIdentifier of the mosaic providing the restriction key. The mosaic global restriction for the mosaic identifier depends on global restrictions set on the reference mosaic. Set reference_mosaic_id to 0 if the mosaic giving the restriction equals the mosaic_id.
restriction_keyRestriction key relative to the reference mosaic identifier.
previous_restriction_valuePrevious restriction value.
new_restriction_valueNew restriction value.
previous_restriction_typePrevious restriction type.
new_restriction_typeNew restriction type.
|
TRANSACTION_VERSION1TRANSACTION_TYPETRANSFER (0x4154)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
verifiable_​entity_​header_​reserved_​1signatureEntity's signature generated by the signing account.
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
feetransaction fee
deadlinetransaction deadline
recipient_addressrecipient address
message_sizesize of attached message
mosaics_countnumber of attached mosaics
transfer_​transaction_​body_​reserved_​10reserved padding to align mosaics on 8-byte boundary
transfer_​transaction_​body_​reserved_​20reserved padding to align mosaics on 8-byte boundary
mosaicsattached mosaics
messageattached message
|
TRANSACTION_VERSION1TRANSACTION_TYPETRANSFER (0x4154)sizeEntity size in bytes.
This size includes the header and the full payload of the entity. I.e, the size field matches the size reported in the structure documentation (plus the variable part, if there is any).
embedded_​transaction_​header_​reserved_​10reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
signer_public_keyPublic key of the signer of the entity.
entity_body_reserved_10Reserved padding to align end of EntityBody to an 8-byte boundary.
versionVersion of this structure.
networkNetwork on which this entity was created.
typetransaction type
recipient_addressrecipient address
message_sizesize of attached message
mosaics_countnumber of attached mosaics
transfer_​transaction_​body_​reserved_​10reserved padding to align mosaics on 8-byte boundary
transfer_​transaction_​body_​reserved_​20reserved padding to align mosaics on 8-byte boundary
mosaicsattached mosaics
messageattached message
|
voting_keyvoting key
start_epochstart finalization epoch
end_epochend finalization epoch
|
|
start_heightactivity start height
total_fees_paidtotal fees paid by account
beneficiary_countnumber of times account has been used as a beneficiary
raw_scoreraw importance score
|
|
versionserialization version
addressaddress of account
address_heightheight at which address has been obtained
public_keypublic key of account
public_key_heightheight at which public key has been obtained
account_typetype of account
formataccount format
supplemental_public_keys_maskmask of supplemental public key flags
voting_public_keys_countnumber of voting public keys
linked_public_keylinked account public key
This field is only present if:supplemental_public_keys_mask in LINKEDnode_public_keynode public key
This field is only present if:supplemental_public_keys_mask in NODEvrf_public_keyvrf public key
This field is only present if:supplemental_public_keys_mask in VRFvoting_public_keysvoting public keys
importance_snapshotscurrent importance snapshot of the account
This field is only present if:format equals HIGH_VALUEactivity_bucketsactivity buckets of the account
This field is only present if:format equals HIGH_VALUEbalances_countnumber of total balances (mosaics)
balancesbalances of account
|
versionserialization version
owner_addressowner address
mosaicmosaic associated with lock
end_heightheight at which the lock expires
statusflag indicating whether or not the lock was already used
hashhash
|
sizesize of the value
datadata of the value
|
versionserialization version
source_addressmetadata source address (provider)
target_addressmetadata target address
scoped_metadata_keymetadata key scoped to source, target and type
target_idtarget id
metadata_typemetadata type
valuevalue
|
flagsmosaic flags
divisibilitymosaic divisibility
durationmosaic duration
|
start_heightblock height
owner_addressmosaic owner
revisionrevision
propertiesproperties
|
versionserialization version
mosaic_identry id
supplytotal supply amount
definitiondefinition comprised of entry properties
|
versionserialization version
min_approvalminimum approval for modifications
min_removalminimum approval for removal
account_addressaccount address
cosignatory_addresses_countnumber of cosignatories
cosignatory_addressescosignatories for account
multisig_addresses_countnumber of other accounts for which the entry is cosignatory
multisig_addressesaccounts for which the entry is cosignatory
|
|
namespace_alias_typenamespace alias type
mosaic_aliasmosaic alias
This field is only present if:namespace_alias_type equals MOSAIC_IDaddress_aliasaddress alias
This field is only present if:namespace_alias_type equals ADDRESS
|
path_sizenumber of paths (excluding root id)
pathnamespace path (excluding root id)
aliasnamespace alias
|
versionserialization version
idid of the root namespace history
owner_addressnamespace owner address
lifetimelifetime in blocks
root_aliasroot namespace alias
children_countnumber of children
pathssave child sub-namespace paths
|
restriction_values_countnumber of restrictions for a particular account
restriction_valuesrestriction values
|
restriction_values_countnumber of restrictions for a particular account
restriction_valuesrestriction values
|
restriction_values_countnumber of restrictions for a particular account
restriction_valuesrestriction values
|
restriction_flagsraw restriction flags
address_restrictionsaddress restrictions
This field is only present if:restriction_flags in ADDRESSmosaic_id_restrictionsmosaic identifier restrictions
This field is only present if:restriction_flags in MOSAIC_IDtransaction_type_restrictionstransaction type restrictions
This field is only present if:restriction_flags in TRANSACTION_TYPE
|
versionserialization version
addressaddress on which restrictions are placed
restrictions_countnumber of restrictions
restrictionsaccount restrictions
|
|
key_value_countnumber of key value pairs
keyskey value array
|
reference_mosaic_ididentifier of the mosaic providing the restriction key
restriction_valuerestriction value
restriction_typerestriction type
|
keykey associated with a restriction rule
restriction_rulerestriction rule (the value) associated with a key
|
key_value_countnumber of key value pairs
keyskey value array
|
mosaic_ididentifier of the mosaic to which the restriction applies
addressaddress being restricted
key_pairsaddress key value restriction set
|
mosaic_ididentifier of the mosaic to which the restriction applies
key_pairsglobal key value restriction set
|
versionserialization version
entry_typetype of restriction being placed upon the entity
address_entryaddress restriction rule
This field is only present if:entry_type equals ADDRESSglobal_entryglobal mosaic rule
This field is only present if:entry_type equals GLOBAL
|
versionserialization version
owner_addressowner address
mosaicmosaic associated with lock
end_heightheight at which the lock expires
statusflag indicating whether or not the lock was already used
hash_algorithmhash algorithm
secrettransaction secret
recipienttransaction recipient
Inner Structures⚓︎
These are structures only meant to be included inside other structures. Their description is already present in the containing structures above and is only repeated here for completeness.