The catbuffer schemas repository defines how the different Bitxor entities type should be serialized (for example, Transactions). In combination with the catbuffer generators project, developers can generate builder classes for a given set of programming languages.
A quantity of tokens in absolute units.
It can only be positive or zero. Negative quantities must be indicated by other means (See for example TokenSupplyChangeTransaction and TokenSupplyChangeAction).
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 Genesis 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 Genesis 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 TokenId or a NamespaceId.
The most-significant bit of the first byte is 0 for TokenId's and 1 for NamespaceId's.
A Token identifier.
Number of milliseconds elapsed since the creation of the Genesis block.
The Genesis 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 Bitxor'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.
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.
Bitxor currently uses Ed25519 signatures.
Link actions. |
UNLINK
Unlink an account.
LINK
Link an account.
Enumeration of network types. |
MAINNET
Public network.
TESTNET
Public test network.
enumeration of block types |
GENESIS
genesis block
NORMAL
normal block
IMPORTANCE
importance block
Enumeration of receipt types. |
RESERVED
Reserved.
TOKEN_RENTAL_FEE
Token rental fee receipt.
NAMESPACE_RENTAL_FEE
Namespace rental fee receipt.
HARVEST_FEE
Harvest fee receipt.
LOCK_HASH_COMPLETED
Hash lock completed receipt.
LOCK_HASH_EXPIRED
Hash lock expired receipt.
LOCK_SECRET_COMPLETED
Secret lock completed receipt.
LOCK_SECRET_EXPIRED
Secret lock expired receipt.
LOCK_HASH_CREATED
Hash lock created receipt.
LOCK_SECRET_CREATED
Secret lock created receipt.
TOKEN_EXPIRED
Token expired receipt.
NAMESPACE_EXPIRED
Namespace expired receipt.
NAMESPACE_DELETED
Namespace deleted receipt.
INFLATION
Inflation receipt.
TRANSACTION_GROUP
Transaction group receipt.
ADDRESS_ALIAS_RESOLUTION
Address alias resolution receipt.
TOKEN_ALIAS_RESOLUTION
Token alias resolution receipt.
Enumeration of namespace registration types. |
ROOT
Root namespace.
CHILD
Child namespace.
Enumeration of alias actions. |
UNLINK
Unlink a namespace, removing the alias.
LINK
Link a namespace, creating an alias.
enumeration of account types |
UNLINKED
account is not linked to another account
MAIN
account is a balance-holding account that is linked to a remote harvester account
REMOTE
account is a remote harvester account that is linked to a balance-holding account
REMOTE_UNLINKED
account 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
enumeration of account key type flags |
UNSET
unset key
LINKED
linked account public key
Note: this can be either a remote or main account public key depending on context
NODE
node public key on which remote is allowed to harvest
VRF
VRF public key
enumeration of account state formats |
REGULAR
regular account
HIGH_VALUE
high value account eligible to harvest
lock status for lock transaction |
UNUSED
lock is unused
USED
lock was already used
enum for the different types of metadata |
ACCOUNT
account metadata
TOKEN
token metadata
NAMESPACE
namespace metadata
Enumeration of token property flags. |
NONE
No flags present.
SUPPLY_MUTABLE
Token supports supply changes through a TokenSupplyChangeTransaction even when token creator only owns a partial supply.
If the token creator owns the totality of the supply, it can be changed even if this flag is not set.
TRANSFERABLE
Token supports TransferTransaction between arbitrary accounts. When not set, this token can only be transferred to or from the token creator.
RESTRICTABLE
Token supports custom restrictions configured by the token creator.
See TokenAddressRestrictionTransaction and TokenGlobalRestrictionTransaction.
REVOKABLE
Token supports revocation of tokens by the token creator.
Enumeration of token supply change actions. |
DECREASE
Decreases the supply.
INCREASE
Increases the supply.
namespace alias type |
NONE
no alias
TOKEN_ID
if alias is tokenId
ADDRESS
if alias is address
Enumeration of account restriction flags. |
ADDRESS
Restriction type is an address.
TOKEN_ID
Restriction type is a token identifier.
TRANSACTION_TYPE
Restriction type is a transaction type.
OUTGOING
Restriction is interpreted as outgoing.
BLOCK
Restriction is interpreted as blocking (instead of allowing) operation.
Enumeration of Transaction types |
ACCOUNT_KEY_LINK
NODE_KEY_LINK
AGGREGATE_COMPLETE
AGGREGATE_BONDED
VOTING_KEY_LINK
VRF_KEY_LINK
HASH_LOCK
SECRET_LOCK
SECRET_PROOF
ACCOUNT_METADATA
TOKEN_METADATA
NAMESPACE_METADATA
TOKEN_DEFINITION
TOKEN_SUPPLY_CHANGE
TOKEN_SUPPLY_REVOCATION
MULTISIG_ACCOUNT_MODIFICATION
ADDRESS_ALIAS
TOKEN_ALIAS
NAMESPACE_REGISTRATION
ACCOUNT_ADDRESS_RESTRICTION
ACCOUNT_TOKEN_RESTRICTION
ACCOUNT_OPERATION_RESTRICTION
TOKEN_ADDRESS_RESTRICTION
TOKEN_GLOBAL_RESTRICTION
TRANSFER
Enumeration of token restriction types. |
NONE
Uninitialized value indicating no restriction.
EQ
Allow if equal.
NE
Allow if not equal.
LT
Allow if less than.
LE
Allow if less than or equal.
GT
Allow if greater than.
GE
Allow if greater than or equal.
type of token restriction entry |
ADDRESS
address restriction
GLOBAL
global (token) restriction
Enumeration of lock hash algorithms. |
SHA3_256
Input is hashed using SHA-3 256.
HASH_160
Input is hashed twice: first with SHA-256 and then with RIPEMD-160 (bitcoin's OP_HASH160).
HASH_256
Input is hashed twice with SHA-256 (bitcoin's OP_HASH256).
A quantity of a certain token. |
A quantity of a certain token, specified either through a TokenId or an alias. |
verfiable random function proof |
gamma
gamma
verification_hash
verification hash
scalar
scalar
binary layout for a normal block header |
BLOCK_VERSION
1
BLOCK_TYPE
NORMAL
(0x8143
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
block type
height
block height
timestamp
number of milliseconds elapsed since creation of genesis block
difficulty
block difficulty
generation_hash_proof
generation hash proof
previous_block_hash
previous block hash
transactions_hash
hash of the transactions in this block
receipts_hash
hash of the receipts generated by this block
state_hash
hash of the global chain state at this block
beneficiary_address
beneficiary address designated by harvester
fee_multiplier
fee multiplier applied to block transactions
block_header_reserved_1
binary layout for an importance block header |
BLOCK_VERSION
1
BLOCK_TYPE
IMPORTANCE
(0x8243
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
block type
height
block height
timestamp
number of milliseconds elapsed since creation of genesis block
difficulty
block difficulty
generation_hash_proof
generation hash proof
previous_block_hash
previous block hash
transactions_hash
hash of the transactions in this block
receipts_hash
hash of the receipts generated by this block
state_hash
hash of the global chain state at this block
beneficiary_address
beneficiary address designated by harvester
fee_multiplier
fee multiplier applied to block transactions
voting_eligible_accounts_count
number of voting eligible accounts
harvesting_​eligible_​accounts_​count
number of harvesting eligible accounts
total_voting_balance
total balance eligible for voting
previous_importance_block_hash
previous importance block hash
binary layout for finalization round |
binary layout for finalized block header |
round
finalization round
height
finalization height
hash
finalization hash
An invisible state change triggered a token transfer. |
size
Entity 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).
version
Receipt version.
type
Type of receipt.
token
Transferred token
sender_address
Address of the sender account.
recipient_address
Address of the recipient account.
An invisible state change modified an account's balance. |
size
Entity 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).
version
Receipt version.
type
Type of receipt.
token
Modified token.
target_address
Address of the affected account.
Network currency tokens were created due to inflation. |
size
Entity 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).
version
Receipt version.
type
Type of receipt.
token
Created token.
An token expired. |
size
Entity 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).
version
Receipt version.
type
Type of receipt.
artifact_id
Expiring token id.
|
size
Entity 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).
version
Receipt version.
type
Type of receipt.
artifact_id
Expiring namespace identifier.
The transaction inside the block that triggered the receipt. |
primary_id
Transaction primary source (e.g. index within the block).
secondary_id
Transaction secondary source (e.g. index within aggregate).
Actual Address behind a NamespaceId at the time a transaction was confirmed. |
Actual TokenId behind a NamespaceId at the time a transaction was confirmed. |
A Token resolution statement links a namespace alias used in a transaction to the real token id at the time of the transaction. |
size
Entity 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).
version
Receipt version.
type
Type of receipt.
unresolved
Unresolved token.
resolution_entries
Resolution entries.
An Address resolution statement links a namespace alias used in a transaction to the real address at the time of the transaction. |
size
Entity 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).
version
Receipt version.
type
Type of receipt.
unresolved
Unresolved address.
resolution_entries
Resolution entries.
pinned voting key |
voting_key
voting key
start_epoch
start finalization epoch
end_epoch
end finalization epoch
temporal importance information |
account activity bucket |
start_height
activity start height
total_fees_paid
total fees paid by account
beneficiary_count
number of times account has been used as a beneficiary
raw_score
raw importance score
account activity buckets |
binary layout for non-historical account state |
version
serialization version
address
address of account
address_height
height at which address has been obtained
public_key
public key of account
public_key_height
height at which public key has been obtained
account_type
type of account
format
account format
supplemental_public_keys_mask
mask of supplemental public key flags
voting_public_keys_count
number of voting public keys
linked_public_key
linked account public key
node_public_key
node public key
vrf_public_key
vrf public key
voting_public_keys
voting public keys
importance_snapshots
current importance snapshot of the account
activity_buckets
activity buckets of the account
balances_count
number of total balances (tokens)
balances
balances of account
binary layout for hash lock transaction info |
version
serialization version
owner_address
owner address
token
token associated with lock
end_height
height at which the lock expires
status
flag indicating whether or not the lock was already used
hash
hash
binary layout of a metadata entry value |
size
size of the value
data
data of the value
binary layout of a metadata entry |
version
serialization version
source_address
metadata source address (provider)
target_address
metadata target address
scoped_metadata_key
metadata key scoped to source, target and type
target_id
target id
metadata_type
metadata type
value
value
binary layout for token properties |
flags
token flags
divisibility
token divisibility
duration
token duration
binary layout for token definition |
start_height
block height
owner_address
token owner
revision
revision
properties
properties
binary layout for token entry |
version
serialization version
token_id
entry id
supply
total supply amount
definition
definition comprised of entry properties
binary layout for a multisig entry |
version
serialization version
min_approval
minimum approval for modifications
min_removal
minimum approval for removal
account_address
account address
cosignatory_addresses_count
number of cosignatories
cosignatory_addresses
cosignatories for account
multisig_addresses_count
number of other accounts for which the entry is cosignatory
multisig_addresses
accounts for which the entry is cosignatory
binary layout for namespace lifetime |
binary layout for alias |
namespace_alias_type
namespace alias type
token_alias
token alias
address_alias
address alias
binary layout for a namespace path |
path_size
number of paths (excluding root id)
path
namespace path (excluding root id)
alias
namespace alias
binary layout for non-historical root namespace history |
version
serialization version
id
id of the root namespace history
owner_address
namespace owner address
lifetime
lifetime in blocks
root_alias
root namespace alias
children_count
number of children
paths
save child sub-namespace paths
binary layout for address based account restriction |
restriction_values_count
number of restrictions for a particular account
restriction_values
restriction values
binary layout for token id based account restriction |
restriction_values_count
number of restrictions for a particular account
restriction_values
restriction values
binary layout for transaction type based account restriction |
restriction_values_count
number of restrictions for a particular account
restriction_values
restriction values
binary layout for account restrictions |
restriction_flags
raw restriction flags
address_restrictions
address restrictions
token_id_restrictions
token identifier restrictions
transaction_type_restrictions
transaction type restrictions
binary layout for account restrictions |
version
serialization version
address
address on which restrictions are placed
restrictions_count
number of restrictions
restrictions
account restrictions
layout for token address restriction key-value pair |
binary layout for token address restriction key-value set |
key_value_count
number of key value pairs
keys
key value array
binary layout of restriction rule being applied |
reference_token_id
identifier of the token providing the restriction key
restriction_value
restriction value
restriction_type
restriction type
binary layout for a global key-value |
key
key associated with a restriction rule
restriction_rule
restriction rule (the value) associated with a key
binary layout for a global restriction key-value set |
key_value_count
number of key value pairs
keys
key value array
binary layout for a token restriction |
token_id
identifier of the token to which the restriction applies
address
address being restricted
key_pairs
address key value restriction set
binary layout for a token restriction |
token_id
identifier of the token to which the restriction applies
key_pairs
global key value restriction set
binary layout for a token restriction |
version
serialization version
entry_type
type of restriction being placed upon the entity
address_entry
address restriction rule
global_entry
global token rule
binary layout for serialized lock transaction |
version
serialization version
owner_address
owner address
token
token associated with lock
end_height
height at which the lock expires
status
flag indicating whether or not the lock was already used
hash_algorithm
hash algorithm
secret
transaction secret
recipient
transaction recipient
This transaction is required for all accounts wanting to activate remote or delegated harvesting. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
ACCOUNT_KEY_LINK
(0x414c
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
linked_public_key
Linked public key.
link_action
Account link action.
Embedded version of AccountKeyLinkTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
ACCOUNT_KEY_LINK
(0x414c
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
linked_public_key
Linked public key.
link_action
Account link action.
This transaction is required for all accounts willing to activate delegated harvesting. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
NODE_KEY_LINK
(0x424c
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
linked_public_key
Linked public key.
link_action
Account link action.
Embedded version of NodeKeyLinkTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
NODE_KEY_LINK
(0x424c
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
linked_public_key
Linked public key.
link_action
Account link action.
Cosignature detached from an AggregateCompleteTransaction or AggregateBondedTransaction. |
version
Version.
signer_public_key
Cosigner public key.
signature
Transaction signature.
parent_hash
Hash of the AggregateBondedTransaction that is signed by this cosignature.
Send transactions in batches to different accounts. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
AGGREGATE_COMPLETE
(0x4141
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
transactions_hash
Hash of the aggregate's transaction.
payload_size
Transaction payload size in bytes.
This is the total number of bytes occupied by all embedded transactions, including any padding present.
aggregate_​transaction_​header_​reserved_​1
0
Reserved padding to align end of AggregateTransactionHeader to an 8-byte boundary.
transactions
Embedded transaction data.
Transactions are variable-sized and the total payload size is in bytes.
Embedded transactions cannot be aggregates.
cosignatures
Cosignatures data.
Fills up remaining body space after transactions.
Propose an arrangement of transactions between different accounts. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
AGGREGATE_BONDED
(0x4241
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
transactions_hash
Hash of the aggregate's transaction.
payload_size
Transaction payload size in bytes.
This is the total number of bytes occupied by all embedded transactions, including any padding present.
aggregate_​transaction_​header_​reserved_​1
0
Reserved padding to align end of AggregateTransactionHeader to an 8-byte boundary.
transactions
Embedded transaction data.
Transactions are variable-sized and the total payload size is in bytes.
Embedded transactions cannot be aggregates.
cosignatures
Cosignatures data.
Fills up remaining body space after transactions.
Link an account with a BLS public key required for finalization voting. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
VOTING_KEY_LINK
(0x4143
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
linked_public_key
Linked voting public key.
start_epoch
Starting finalization epoch.
end_epoch
Ending finalization epoch.
link_action
Account link action.
Embedded version of VotingKeyLinkTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
VOTING_KEY_LINK
(0x4143
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
linked_public_key
Linked voting public key.
start_epoch
Starting finalization epoch.
end_epoch
Ending finalization epoch.
link_action
Account link action.
Link an account with a VRF public key required for harvesting. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
VRF_KEY_LINK
(0x4243
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
linked_public_key
Linked VRF public key.
link_action
Account link action.
Embedded version of VrfKeyLinkTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
VRF_KEY_LINK
(0x4243
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
linked_public_key
Linked VRF public key.
link_action
Account link action.
Lock a deposit needed to announce an AggregateBondedTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
HASH_LOCK
(0x4148
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
token
Locked token.
duration
Number of blocks for which a lock should be valid.
The default maximum is 48h (See the maxHashLockDuration
network property).
hash
Hash of the AggregateBondedTransaction to be confirmed before unlocking the tokens.
Embedded version of HashLockTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
HASH_LOCK
(0x4148
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
token
Locked token.
duration
Number of blocks for which a lock should be valid.
The default maximum is 48h (See the maxHashLockDuration
network property).
hash
Hash of the AggregateBondedTransaction to be confirmed before unlocking the tokens.
Start a token swap between different chains. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
SECRET_LOCK
(0x4152
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
recipient_address
Address that receives the funds once successfully unlocked by a SecretProofTransaction.
secret
Hashed proof.
token
Locked tokens.
duration
Number of blocks to wait for the SecretProofTransaction.
hash_algorithm
Algorithm used to hash the proof.
Embedded version of SecretLockTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
SECRET_LOCK
(0x4152
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
recipient_address
Address that receives the funds once successfully unlocked by a SecretProofTransaction.
secret
Hashed proof.
token
Locked tokens.
duration
Number of blocks to wait for the SecretProofTransaction.
hash_algorithm
Algorithm used to hash the proof.
Conclude a token swap between different chains. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
SECRET_PROOF
(0x4252
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
recipient_address
Address that receives the funds once unlocked.
secret
Hashed proof.
proof_size
Proof size in bytes
hash_algorithm
Algorithm used to hash the proof.
proof
Original random set of bytes that were hashed.
Embedded version of SecretProofTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
SECRET_PROOF
(0x4252
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
recipient_address
Address that receives the funds once unlocked.
secret
Hashed proof.
proof_size
Proof size in bytes
hash_algorithm
Algorithm used to hash the proof.
proof
Original random set of bytes that were hashed.
Associate a key-value state (metadata) to an account. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
ACCOUNT_METADATA
(0x4144
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
target_address
Account whose metadata should be modified.
scoped_metadata_key
Metadata key scoped to source, target and type.
value_size_delta
Change in value size in bytes, compared to previous size.
value_size
Size in bytes of the value
array.
value
Difference 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.
Embedded version of AccountMetadataTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
ACCOUNT_METADATA
(0x4144
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
target_address
Account whose metadata should be modified.
scoped_metadata_key
Metadata key scoped to source, target and type.
value_size_delta
Change in value size in bytes, compared to previous size.
value_size
Size in bytes of the value
array.
value
Difference 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.
Associate a key-value state (metadata) to a token. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
TOKEN_METADATA
(0x4244
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
target_address
Account owning the token whose metadata should be modified.
scoped_metadata_key
Metadata key scoped to source, target and type.
target_token_id
Token whose metadata should be modified.
value_size_delta
Change in value size in bytes, compared to previous size.
value_size
Size in bytes of the value
array.
value
Difference 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.
Embedded version of TokenMetadataTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
TOKEN_METADATA
(0x4244
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
target_address
Account owning the token whose metadata should be modified.
scoped_metadata_key
Metadata key scoped to source, target and type.
target_token_id
Token whose metadata should be modified.
value_size_delta
Change in value size in bytes, compared to previous size.
value_size
Size in bytes of the value
array.
value
Difference 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.
Associate a key-value state (metadata) to a namespace. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
NAMESPACE_METADATA
(0x4344
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
target_address
Account owning the namespace whose metadata should be modified.
scoped_metadata_key
Metadata key scoped to source, target and type.
target_namespace_id
Namespace whose metadata should be modified.
value_size_delta
Change in value size in bytes, compared to previous size.
value_size
Size in bytes of the value
array.
value
Difference 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.
Embedded version of NamespaceMetadataTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
NAMESPACE_METADATA
(0x4344
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
target_address
Account owning the namespace whose metadata should be modified.
scoped_metadata_key
Metadata key scoped to source, target and type.
target_namespace_id
Namespace whose metadata should be modified.
value_size_delta
Change in value size in bytes, compared to previous size.
value_size
Size in bytes of the value
array.
value
Difference 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.
Create a new token. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
TOKEN_DEFINITION
(0x414d
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
id
Unique token identifier obtained from the generator account's public key and the nonce
.
The SDK's can take care of generating this ID for you.
duration
Token duration expressed in blocks. If set to 0, the token never expires.
nonce
Random nonce used to generate the token id.
flags
Token flags.
divisibility
Token divisibility.
Embedded version of TokenDefinitionTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
TOKEN_DEFINITION
(0x414d
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
id
Unique token identifier obtained from the generator account's public key and the nonce
.
The SDK's can take care of generating this ID for you.
duration
Token duration expressed in blocks. If set to 0, the token never expires.
nonce
Random nonce used to generate the token id.
flags
Token flags.
divisibility
Token divisibility.
Change the total supply of a token. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
TOKEN_SUPPLY_CHANGE
(0x424d
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
token_id
Affected token identifier.
delta
Change amount. It cannot be negative, use the action
field to indicate if this amount should be added or subtracted from the current supply.
action
Supply change action.
Embedded version of TokenSupplyChangeTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
TOKEN_SUPPLY_CHANGE
(0x424d
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
token_id
Affected token identifier.
delta
Change amount. It cannot be negative, use the action
field to indicate if this amount should be added or subtracted from the current supply.
action
Supply change action.
Revoke token. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
TOKEN_SUPPLY_REVOCATION
(0x434d
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
source_address
Address from which tokens should be revoked.
token
Revoked token and amount.
Embedded version of TokenSupplyRevocationTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
TOKEN_SUPPLY_REVOCATION
(0x434d
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
source_address
Address from which tokens should be revoked.
token
Revoked token and amount.
Create or modify a multi-signature account. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
MULTISIG_ACCOUNT_MODIFICATION
(0x4155
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
min_removal_delta
Relative 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_delta
Relative 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_count
Number of cosignatory address additions.
address_deletions_count
Number of cosignatory address deletions.
multisig_​account_​modification_​transaction_​body_​reserved_​1
0
Reserved padding to align addressAdditions to an 8-byte boundary.
address_additions
Cosignatory 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_deletions
Cosignatory 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.
Embedded version of MultisigAccountModificationTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
MULTISIG_ACCOUNT_MODIFICATION
(0x4155
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
min_removal_delta
Relative 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_delta
Relative 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_count
Number of cosignatory address additions.
address_deletions_count
Number of cosignatory address deletions.
multisig_​account_​modification_​transaction_​body_​reserved_​1
0
Reserved padding to align addressAdditions to an 8-byte boundary.
address_additions
Cosignatory 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_deletions
Cosignatory 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.
Attach or detach a namespace (alias) to an account address.. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
ADDRESS_ALIAS
(0x424e
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
namespace_id
Identifier of the namespace that will become (or stop being) an alias for the address.
address
Aliased address.
alias_action
Alias action.
Embedded version of AddressAliasTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
ADDRESS_ALIAS
(0x424e
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
namespace_id
Identifier of the namespace that will become (or stop being) an alias for the address.
address
Aliased address.
alias_action
Alias action.
Attach or detach a namespace to a Token. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
TOKEN_ALIAS
(0x434e
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
namespace_id
Identifier of the namespace that will become (or stop being) an alias for the Token.
token_id
Aliased token identifier.
alias_action
Alias action.
Embedded version of TokenAliasTransaction |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
TOKEN_ALIAS
(0x434e
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
namespace_id
Identifier of the namespace that will become (or stop being) an alias for the Token.
token_id
Aliased token identifier.
alias_action
Alias action.
Register (or renew a registration for) a namespace. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
NAMESPACE_REGISTRATION
(0x414e
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
duration
Number of confirmed blocks you would like to rent the namespace for. Required for root namespaces.
parent_id
Parent namespace identifier. Required for sub-namespaces.
id
Namespace identifier.
registration_type
Namespace registration type.
name_size
Namespace name size in bytes.
name
Namespace name.
Embedded version of NamespaceRegistrationTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
NAMESPACE_REGISTRATION
(0x414e
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
duration
Number of confirmed blocks you would like to rent the namespace for. Required for root namespaces.
parent_id
Parent namespace identifier. Required for sub-namespaces.
id
Namespace identifier.
registration_type
Namespace registration type.
name_size
Namespace name size in bytes.
name
Namespace name.
Allow or block incoming and outgoing transactions for a given a set of addresses. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
ACCOUNT_ADDRESS_RESTRICTION
(0x4150
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
restriction_flags
Type of restriction being applied to the listed addresses.
restriction_additions_count
Number of addresses being added.
restriction_deletions_count
Number of addresses being removed.
account_​restriction_​transaction_​body_​reserved_​1
0
Reserved padding to align restriction_additions to an 8-byte boundary.
restriction_additions
Array of account addresses being added to the restricted list.
restriction_deletions
Array of account addresses being removed from the restricted list.
Embedded version of AccountAddressRestrictionTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
ACCOUNT_ADDRESS_RESTRICTION
(0x4150
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
restriction_flags
Type of restriction being applied to the listed addresses.
restriction_additions_count
Number of addresses being added.
restriction_deletions_count
Number of addresses being removed.
account_​restriction_​transaction_​body_​reserved_​1
0
Reserved padding to align restriction_additions to an 8-byte boundary.
restriction_additions
Array of account addresses being added to the restricted list.
restriction_deletions
Array of account addresses being removed from the restricted list.
Allow or block incoming transactions containing a given set of tokens. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
ACCOUNT_TOKEN_RESTRICTION
(0x4250
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
restriction_flags
Type of restriction being applied to the listed tokens.
restriction_additions_count
Number of tokens being added.
restriction_deletions_count
Number of tokens being removed.
account_​restriction_​transaction_​body_​reserved_​1
0
Reserved padding to align restriction_additions to an 8-byte boundary.
restriction_additions
Array of tokens being added to the restricted list.
restriction_deletions
Array of tokens being removed from the restricted list.
Embedded version of AccountTokenRestrictionTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
ACCOUNT_TOKEN_RESTRICTION
(0x4250
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
restriction_flags
Type of restriction being applied to the listed tokens.
restriction_additions_count
Number of tokens being added.
restriction_deletions_count
Number of tokens being removed.
account_​restriction_​transaction_​body_​reserved_​1
0
Reserved padding to align restriction_additions to an 8-byte boundary.
restriction_additions
Array of tokens being added to the restricted list.
restriction_deletions
Array of tokens being removed from the restricted list.
Allow or block outgoing transactions depending on their transaction type. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
ACCOUNT_OPERATION_RESTRICTION
(0x4350
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
restriction_flags
Type of restriction being applied to the listed transaction types.
restriction_additions_count
Number of transaction types being added.
restriction_deletions_count
Number of transaction types being removed.
account_​restriction_​transaction_​body_​reserved_​1
0
Reserved padding to align restriction_additions to an 8-byte boundary.
restriction_additions
Array of transaction types being added to the restricted list.
restriction_deletions
Array of transaction types being rtemoved from the restricted list.
Embedded version of AccountOperationRestrictionTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
ACCOUNT_OPERATION_RESTRICTION
(0x4350
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
restriction_flags
Type of restriction being applied to the listed transaction types.
restriction_additions_count
Number of transaction types being added.
restriction_deletions_count
Number of transaction types being removed.
account_​restriction_​transaction_​body_​reserved_​1
0
Reserved padding to align restriction_additions to an 8-byte boundary.
restriction_additions
Array of transaction types being added to the restricted list.
restriction_deletions
Array of transaction types being rtemoved from the restricted list.
Set address specific rules to transfer a restrictable token. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
TOKEN_ADDRESS_RESTRICTION
(0x4251
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
token_id
Identifier of the token to which the restriction applies.
restriction_key
Restriction key.
previous_restriction_value
Previous restriction value. Set previousRestrictionValue
to FFFFFFFFFFFFFFFF
if the target address does not have a previous restriction value for this token id and restriction key.
new_restriction_value
New restriction value.
target_address
Address being restricted.
Embedded version of TokenAddressRestrictionTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
TOKEN_ADDRESS_RESTRICTION
(0x4251
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
token_id
Identifier of the token to which the restriction applies.
restriction_key
Restriction key.
previous_restriction_value
Previous restriction value. Set previousRestrictionValue
to FFFFFFFFFFFFFFFF
if the target address does not have a previous restriction value for this token id and restriction key.
new_restriction_value
New restriction value.
target_address
Address being restricted.
Set global rules to transfer a restrictable token. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
TOKEN_GLOBAL_RESTRICTION
(0x4151
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
token_id
Identifier of the token being restricted. The token creator must be the signer of the transaction.
reference_token_id
Identifier of the token providing the restriction key. The token global restriction for the token identifier depends on global restrictions set on the reference token. Set reference_token_id
to 0 if the token giving the restriction equals the token_id
.
restriction_key
Restriction key relative to the reference token identifier.
previous_restriction_value
Previous restriction value.
new_restriction_value
New restriction value.
previous_restriction_type
Previous restriction type.
new_restriction_type
New restriction type.
Embedded version of TokenGlobalRestrictionTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
TOKEN_GLOBAL_RESTRICTION
(0x4151
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
token_id
Identifier of the token being restricted. The token creator must be the signer of the transaction.
reference_token_id
Identifier of the token providing the restriction key. The token global restriction for the token identifier depends on global restrictions set on the reference token. Set reference_token_id
to 0 if the token giving the restriction equals the token_id
.
restriction_key
Restriction key relative to the reference token identifier.
previous_restriction_value
Previous restriction value.
new_restriction_value
New restriction value.
previous_restriction_type
Previous restriction type.
new_restriction_type
New restriction type.
Send tokens and messages between two accounts. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
TRANSFER
(0x4154
)size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
recipient_address
recipient address
message_size
size of attached message
tokens_count
number of attached tokens
transfer_​transaction_​body_​reserved_​1
0
reserved padding to align tokens on 8-byte boundary
transfer_​transaction_​body_​reserved_​2
0
reserved padding to align tokens on 8-byte boundary
tokens
attached tokens
message
attached message
Embedded version of TransferTransaction. |
TRANSACTION_VERSION
1
TRANSACTION_TYPE
TRANSFER
(0x4154
)size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
recipient_address
recipient address
message_size
size of attached message
tokens_count
number of attached tokens
transfer_​transaction_​body_​reserved_​1
0
reserved padding to align tokens on 8-byte boundary
transfer_​transaction_​body_​reserved_​2
0
reserved padding to align tokens on 8-byte boundary
tokens
attached tokens
message
attached message
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.
Serialization of an entity that has its size stated as a prefix (header). |
size
Entity 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).
Serialization of an entity that should be signed by an account. |
verifiable_​entity_​header_​reserved_​1
signature
Entity's signature generated by the signing account.
Serialization of an entity. |
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
binary layout for a block header |
size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
block type
height
block height
timestamp
number of milliseconds elapsed since creation of genesis block
difficulty
block difficulty
generation_hash_proof
generation hash proof
previous_block_hash
previous block hash
transactions_hash
hash of the transactions in this block
receipts_hash
hash of the receipts generated by this block
state_hash
hash of the global chain state at this block
beneficiary_address
beneficiary address designated by harvester
fee_multiplier
fee multiplier applied to block transactions
Receipts provide proof for every state change not retrievable from the block. |
size
Entity 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).
version
Receipt version.
type
Type of receipt.
header common to all serialized states |
version
serialization version
binary layout for a transaction |
size
Entity 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_​1
signature
Entity's signature generated by the signing account.
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
fee
transaction fee
deadline
transaction deadline
binary layout for an embedded transaction header |
size
Entity 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_​1
binary layout for an embedded transaction |
size
Entity 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_​1
signer_public_key
Public key of the signer of the entity.
entity_body_reserved_1
version
Version of this structure.
network
Network on which this entity was created.
type
transaction type
Shared content between AccountKeyLinkTransactionBody and EmbeddedAccountKeyLinkTransaction. |
Shared content between NodeKeyLinkTransaction and EmbeddedNodeKeyLinkTransaction. |
Cosignature attached to an AggregateCompleteTransaction or AggregateBondedTransaction. |
Shared content between AggregateCompleteTransaction and AggregateBondedTransaction. |
transactions_hash
Hash of the aggregate's transaction.
payload_size
Transaction payload size in bytes.
This is the total number of bytes occupied by all embedded transactions, including any padding present.
aggregate_​transaction_​header_​reserved_​1
0
Reserved padding to align end of AggregateTransactionHeader to an 8-byte boundary.
transactions
Embedded transaction data.
Transactions are variable-sized and the total payload size is in bytes.
Embedded transactions cannot be aggregates.
cosignatures
Cosignatures data.
Fills up remaining body space after transactions.
Shared content between VotingKeyLinkTransaction and EmbeddedVotingKeyLinkTransaction. |
linked_public_key
Linked voting public key.
start_epoch
Starting finalization epoch.
end_epoch
Ending finalization epoch.
link_action
Account link action.
Shared content between VrfKeyLinkTransaction and EmbeddedVrfKeyLinkTransaction. |
Shared content between HashLockTransaction and EmbeddedHashLockTransaction. |
token
Locked token.
duration
Number of blocks for which a lock should be valid.
The default maximum is 48h (See the maxHashLockDuration
network property).
hash
Hash of the AggregateBondedTransaction to be confirmed before unlocking the tokens.
Shared content between SecretLockTransaction and EmbeddedSecretLockTransaction. |
recipient_address
Address that receives the funds once successfully unlocked by a SecretProofTransaction.
secret
Hashed proof.
token
Locked tokens.
duration
Number of blocks to wait for the SecretProofTransaction.
hash_algorithm
Algorithm used to hash the proof.
Shared content between SecretProofTransaction and EmbeddedSecretProofTransaction. |
recipient_address
Address that receives the funds once unlocked.
secret
Hashed proof.
proof_size
Proof size in bytes
hash_algorithm
Algorithm used to hash the proof.
proof
Original random set of bytes that were hashed.
Shared content between AccountMetadataTransaction and EmbeddedAccountMetadataTransaction. |
target_address
Account whose metadata should be modified.
scoped_metadata_key
Metadata key scoped to source, target and type.
value_size_delta
Change in value size in bytes, compared to previous size.
value_size
Size in bytes of the value
array.
value
Difference 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.
Shared content between TokenMetadataTransaction and EmbeddedTokenMetadataTransaction. |
target_address
Account owning the token whose metadata should be modified.
scoped_metadata_key
Metadata key scoped to source, target and type.
target_token_id
Token whose metadata should be modified.
value_size_delta
Change in value size in bytes, compared to previous size.
value_size
Size in bytes of the value
array.
value
Difference 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.
Shared content between NamespaceMetadataTransaction and EmbeddedNamespaceMetadataTransaction. |
target_address
Account owning the namespace whose metadata should be modified.
scoped_metadata_key
Metadata key scoped to source, target and type.
target_namespace_id
Namespace whose metadata should be modified.
value_size_delta
Change in value size in bytes, compared to previous size.
value_size
Size in bytes of the value
array.
value
Difference 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.
Shared content between TokenDefinitionTransaction and Embedded TokenDefinitionTransaction. |
id
Unique token identifier obtained from the generator account's public key and the nonce
.
The SDK's can take care of generating this ID for you.
duration
Token duration expressed in blocks. If set to 0, the token never expires.
nonce
Random nonce used to generate the token id.
flags
Token flags.
divisibility
Token divisibility.
Shared content between TokenSupplyChangeTransaction and EmbeddedTokenSupplyChangeTransaction. |
token_id
Affected token identifier.
delta
Change amount. It cannot be negative, use the action
field to indicate if this amount should be added or subtracted from the current supply.
action
Supply change action.
Shared content between TokenSupplyRevocationTransaction and EmbeddedTokenSupplyRevocationTransaction. |
Shared content between MultisigAccountModificationTransaction and EmbeddedMultisigAccountModificationTransaction. |
min_removal_delta
Relative 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_delta
Relative 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_count
Number of cosignatory address additions.
address_deletions_count
Number of cosignatory address deletions.
multisig_​account_​modification_​transaction_​body_​reserved_​1
0
Reserved padding to align addressAdditions to an 8-byte boundary.
address_additions
Cosignatory 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_deletions
Cosignatory 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.
Shared content between AddressAliasTransaction and EmbeddedAddressAliasTransaction. |
namespace_id
Identifier of the namespace that will become (or stop being) an alias for the address.
address
Aliased address.
alias_action
Alias action.
Shared content between TokenAliasTransaction and EmbeddedTokenAliasTransaction |
namespace_id
Identifier of the namespace that will become (or stop being) an alias for the Token.
token_id
Aliased token identifier.
alias_action
Alias action.
Shared content between NamespaceRegistrationTransaction and EmbeddedNamespaceRegistrationTransaction. |
duration
Number of confirmed blocks you would like to rent the namespace for. Required for root namespaces.
parent_id
Parent namespace identifier. Required for sub-namespaces.
id
Namespace identifier.
registration_type
Namespace registration type.
name_size
Namespace name size in bytes.
name
Namespace name.
Shared content between AccountAddressRestrictionTransaction and EmbeddedAccountAddressRestrictionTransaction. |
restriction_flags
Type of restriction being applied to the listed addresses.
restriction_additions_count
Number of addresses being added.
restriction_deletions_count
Number of addresses being removed.
account_​restriction_​transaction_​body_​reserved_​1
0
Reserved padding to align restriction_additions to an 8-byte boundary.
restriction_additions
Array of account addresses being added to the restricted list.
restriction_deletions
Array of account addresses being removed from the restricted list.
Shared content between AccountTokenRestrictionTransaction and EmbeddedAccountTokenRestrictionTransaction. |
restriction_flags
Type of restriction being applied to the listed tokens.
restriction_additions_count
Number of tokens being added.
restriction_deletions_count
Number of tokens being removed.
account_​restriction_​transaction_​body_​reserved_​1
0
Reserved padding to align restriction_additions to an 8-byte boundary.
restriction_additions
Array of tokens being added to the restricted list.
restriction_deletions
Array of tokens being removed from the restricted list.
Shared content between AccountOperationRestrictionTransaction and EmbeddedAccountOperationRestrictionTransaction. |
restriction_flags
Type of restriction being applied to the listed transaction types.
restriction_additions_count
Number of transaction types being added.
restriction_deletions_count
Number of transaction types being removed.
account_​restriction_​transaction_​body_​reserved_​1
0
Reserved padding to align restriction_additions to an 8-byte boundary.
restriction_additions
Array of transaction types being added to the restricted list.
restriction_deletions
Array of transaction types being rtemoved from the restricted list.
Shared content between TokenAddressRestrictionTransaction and EmbeddedTokenAddressRestrictionTransaction. |
token_id
Identifier of the token to which the restriction applies.
restriction_key
Restriction key.
previous_restriction_value
Previous restriction value. Set previousRestrictionValue
to FFFFFFFFFFFFFFFF
if the target address does not have a previous restriction value for this token id and restriction key.
new_restriction_value
New restriction value.
target_address
Address being restricted.
Shared content between TokenGlobalRestrictionTransaction and EmbeddedTokenGlobalRestrictionTransaction. |
token_id
Identifier of the token being restricted. The token creator must be the signer of the transaction.
reference_token_id
Identifier of the token providing the restriction key. The token global restriction for the token identifier depends on global restrictions set on the reference token. Set reference_token_id
to 0 if the token giving the restriction equals the token_id
.
restriction_key
Restriction key relative to the reference token identifier.
previous_restriction_value
Previous restriction value.
new_restriction_value
New restriction value.
previous_restriction_type
Previous restriction type.
new_restriction_type
New restriction type.
Shared content between TransferTransaction and EmbeddedTransferTransaction. |
recipient_address
recipient address
message_size
size of attached message
tokens_count
number of attached tokens
transfer_​transaction_​body_​reserved_​1
0
reserved padding to align tokens on 8-byte boundary
transfer_​transaction_​body_​reserved_​2
0
reserved padding to align tokens on 8-byte boundary
tokens
attached tokens
message
attached message