|
Enumeration of account restriction flags.
diff --git a/source/serialization/AccountRestrictionMosaicValue.html b/source/serialization/AccountRestrictionMosaicValue.html
index 522773056..43fb50d6d 100644
--- a/source/serialization/AccountRestrictionMosaicValue.html
+++ b/source/serialization/AccountRestrictionMosaicValue.html
@@ -1,7 +1,7 @@
|
binary layout for mosaic id based account restriction
|
diff --git a/source/serialization/AccountRestrictionTransactionTypeValue.html b/source/serialization/AccountRestrictionTransactionTypeValue.html
index 0ac229de3..6e7cb32b0 100644
--- a/source/serialization/AccountRestrictionTransactionTypeValue.html
+++ b/source/serialization/AccountRestrictionTransactionTypeValue.html
@@ -1,7 +1,7 @@
|
binary layout for transaction type based account restriction
|
diff --git a/source/serialization/AccountRestrictions.html b/source/serialization/AccountRestrictions.html
index 9a508e450..57c73ae85 100644
--- a/source/serialization/AccountRestrictions.html
+++ b/source/serialization/AccountRestrictions.html
@@ -1,14 +1,13 @@
|
binary layout for account restrictions
|
-
-
+
version
diff --git a/source/serialization/AccountRestrictionsInfo.html b/source/serialization/AccountRestrictionsInfo.html
index 548699e55..3bc5e5d62 100644
--- a/source/serialization/AccountRestrictionsInfo.html
+++ b/source/serialization/AccountRestrictionsInfo.html
@@ -1,7 +1,7 @@
- | ↕ | Size: 26+ bytes = 0x1a+ (variable) |
- | schema |
+ | ↕ | Size: 2+ bytes = 0x2+ (variable) |
+ | schema |
binary layout for account restrictions
|
@@ -18,17 +18,17 @@
address_restrictions
-
+ address restrictions This field is only present if:restriction_flags in ADDRESS
mosaic_id_restrictions
- mosaic identifier restrictions
+ mosaic identifier restrictions This field is only present if:restriction_flags in MOSAIC_ID
transaction_type_restrictions
- transaction type restrictions
+ transaction type restrictions This field is only present if:restriction_flags in TRANSACTION_TYPE|
binary layout for non-historical account state
|
-
-
+
version
@@ -68,19 +67,19 @@
linked_public_key
- linked account public key
+ linked account public key This field is only present if:supplemental_public_keys_mask in LINKED
node_public_key
-
+ node public key This field is only present if:supplemental_public_keys_mask in NODE
vrf_public_key
-
+ vrf public key This field is only present if:supplemental_public_keys_mask in VRF
@@ -92,13 +91,13 @@
importance_snapshots
- current importance snapshot of the account
+ current importance snapshot of the account This field is only present if:format equals HIGH_VALUE
activity_buckets
- activity buckets of the account
+ activity buckets of the account This field is only present if:format equals HIGH_VALUE
diff --git a/source/serialization/AccountStateFormat.html b/source/serialization/AccountStateFormat.html
index e5022ba55..636362689 100644
--- a/source/serialization/AccountStateFormat.html
+++ b/source/serialization/AccountStateFormat.html
@@ -1,7 +1,7 @@
|
enumeration of account state formats
|
diff --git a/source/serialization/AccountType.html b/source/serialization/AccountType.html
index 7024623ac..7d850c6d1 100644
--- a/source/serialization/AccountType.html
+++ b/source/serialization/AccountType.html
@@ -1,7 +1,7 @@
|
enumeration of account types
diff --git a/source/serialization/AddressAliasTransactionBody.html b/source/serialization/AddressAliasTransactionBody.html
deleted file mode 100644
index def1f2abf..000000000
--- a/source/serialization/AddressAliasTransactionBody.html
+++ /dev/null
@@ -1,33 +0,0 @@
-
-
-
-
-
-
- namespace_id
-
- Identifier of the namespace that will become (or stop being) an alias for the address.
-
-
-
- address
-
-
-
-
-
- alias_action
-
-
- Included in:|
- Attach or detach a namespace (alias) to an account address..
A namespace can be assigned to any account present in the network (this is, an account which has received at least one transaction).
+Attach or detach a namespace (alias) to an account address (V1, latest).
A namespace can be assigned to any account present in the network (this is, an account which has received at least one transaction).
|
@@ -20,84 +19,79 @@
TRANSACTION_TYPE
const ADDRESS_ALIAS (0x424e)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
namespace_id
Identifier of the namespace that will become (or stop being) an alias for the address.
-
+
address
-
+
alias_action
diff --git a/source/serialization/AddressKeyValue.html b/source/serialization/AddressKeyValue.html
index 370c23226..5d3077771 100644
--- a/source/serialization/AddressKeyValue.html
+++ b/source/serialization/AddressKeyValue.html
@@ -1,7 +1,7 @@
|
layout for mosaic address restriction key-value pair
|
diff --git a/source/serialization/AddressKeyValueSet.html b/source/serialization/AddressKeyValueSet.html
index 23691c385..5137661ae 100644
--- a/source/serialization/AddressKeyValueSet.html
+++ b/source/serialization/AddressKeyValueSet.html
@@ -1,7 +1,7 @@
|
binary layout for mosaic address restriction key-value set
|
diff --git a/source/serialization/AddressResolutionEntry.html b/source/serialization/AddressResolutionEntry.html
index 050594dd2..0982143e6 100644
--- a/source/serialization/AddressResolutionEntry.html
+++ b/source/serialization/AddressResolutionEntry.html
@@ -1,7 +1,7 @@
@@ -16,7 +16,7 @@
- resolved
+ resolved_value
- | ↕ | Size: 32 bytes = 0x20 |
- | schema |
+ | ↕ | Size: 28+ bytes = 0x1c+ (variable) |
+ | schema |
An Address resolution statement links a namespace alias used in a transaction to the real address at the time of the transaction.
|
-
-
-
-
-
- size
- byte[4]
- 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
- byte[2]
-
-
-
-
- type
-
-
@@ -36,7 +16,13 @@
+ resolution_entries_count
+ byte[4]
+ Number of resolution entries.
+
+
+
resolution_entries
-
+
|
- Propose an arrangement of transactions between different accounts.
Use this transaction when not all required signatures are available when the transaction is created.
Missing signatures must be provided using a Cosignature or DetachedCosignature.
To prevent spam attacks, before trying to announce this transaction a HashLockTransaction must be successfully announced and confirmed.
+Propose an arrangement of transactions between different accounts (V1, deprecated).
Use this transaction when not all required signatures are available when the transaction is created.
Missing signatures must be provided using a Cosignature or DetachedCosignature.
To prevent spam attacks, before trying to announce this transaction a HashLockTransactionV1 must be successfully announced and confirmed.
|
@@ -20,96 +19,91 @@
TRANSACTION_TYPE
const AGGREGATE_BONDED (0x4241)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
transactions_hash
Hash of the aggregate's transaction.
-
+
payload_size
byte[4]
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
byte[4]
reserved 0Reserved 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
diff --git a/source/serialization/AggregateBondedTransactionV2.html b/source/serialization/AggregateBondedTransactionV2.html
new file mode 100644
index 000000000..0601a4cd4
--- /dev/null
+++ b/source/serialization/AggregateBondedTransactionV2.html
@@ -0,0 +1,112 @@
+
+
+ | ↕ | Size: 171+ bytes = 0xab+ (variable) |
+ | schema |
+ Propose an arrangement of transactions between different accounts (V2, deprecated).
Use this transaction when not all required signatures are available when the transaction is created.
Missing signatures must be provided using a Cosignature or DetachedCosignature.
To prevent spam attacks, before trying to announce this transaction a HashLockTransactionV1 must be successfully announced and confirmed.
+ |
+
+
+
+
+
+ TRANSACTION_VERSION
+ byte[1]
+ const 2
+
+
+
+ TRANSACTION_TYPE
+
+ const AGGREGATE_BONDED (0x4241)
+
+
+
+ size
+ byte[4]
+ 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
+ byte[4]
+ reserved 0Reserved padding to align Signature to an 8-byte boundary.
+
+
+
+ signature
+
+ Entity's signature generated by the signing account.
+
+
+
+ signer_public_key
+
+ Public key of the signer of the entity.
+
+
+
+ entity_body_reserved_1
+ byte[4]
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
+
+ version
+ byte[1]
+ Version of this structure.
+
+
+
+ network
+
+ Network on which this entity was created.
+
+
+
+ type
+
+
+
+
+
+ fee
+
+
+
+
+
+ deadline
+
+
+
+
+
+ transactions_hash
+
+ Hash of the aggregate's transaction.
+
+
+
+ payload_size
+ byte[4]
+ 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
+ byte[4]
+ reserved 0Reserved 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.
+
diff --git a/source/serialization/AggregateBondedTransactionV3.html b/source/serialization/AggregateBondedTransactionV3.html
new file mode 100644
index 000000000..8f1a4053a
--- /dev/null
+++ b/source/serialization/AggregateBondedTransactionV3.html
@@ -0,0 +1,112 @@
+
+
+ | ↕ | Size: 171+ bytes = 0xab+ (variable) |
+ | schema |
+ Propose an arrangement of transactions between different accounts (V3, latest).
Use this transaction when not all required signatures are available when the transaction is created.
Missing signatures must be provided using a Cosignature or DetachedCosignature.
To prevent spam attacks, before trying to announce this transaction a HashLockTransactionV1 must be successfully announced and confirmed.
+ |
+
+
+
+
+
+ TRANSACTION_VERSION
+ byte[1]
+ const 3
+
+
+
+ TRANSACTION_TYPE
+
+ const AGGREGATE_BONDED (0x4241)
+
+
+
+ size
+ byte[4]
+ 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
+ byte[4]
+ reserved 0Reserved padding to align Signature to an 8-byte boundary.
+
+
+
+ signature
+
+ Entity's signature generated by the signing account.
+
+
+
+ signer_public_key
+
+ Public key of the signer of the entity.
+
+
+
+ entity_body_reserved_1
+ byte[4]
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
+
+ version
+ byte[1]
+ Version of this structure.
+
+
+
+ network
+
+ Network on which this entity was created.
+
+
+
+ type
+
+
+
+
+
+ fee
+
+
+
+
+
+ deadline
+
+
+
+
+
+ transactions_hash
+
+ Hash of the aggregate's transaction.
+
+
+
+ payload_size
+ byte[4]
+ 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
+ byte[4]
+ reserved 0Reserved 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.
+
diff --git a/source/serialization/AggregateCompleteTransaction.html b/source/serialization/AggregateCompleteTransactionV1.html
similarity index 65%
rename from source/serialization/AggregateCompleteTransaction.html
rename to source/serialization/AggregateCompleteTransactionV1.html
index b4012be41..471427995 100644
--- a/source/serialization/AggregateCompleteTransaction.html
+++ b/source/serialization/AggregateCompleteTransactionV1.html
@@ -1,10 +1,9 @@
|
- Send transactions in batches to different accounts.
Use this transaction when all required signatures are available when the transaction is created.
+Send transactions in batches to different accounts (V1, deprecated).
Use this transaction when all required signatures are available when the transaction is created.
|
@@ -20,96 +19,91 @@
TRANSACTION_TYPE
const AGGREGATE_COMPLETE (0x4141)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
transactions_hash
Hash of the aggregate's transaction.
-
+
payload_size
byte[4]
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
byte[4]
reserved 0Reserved 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
diff --git a/source/serialization/AggregateCompleteTransactionV2.html b/source/serialization/AggregateCompleteTransactionV2.html
new file mode 100644
index 000000000..41e395a62
--- /dev/null
+++ b/source/serialization/AggregateCompleteTransactionV2.html
@@ -0,0 +1,112 @@
+
+
+ | ↕ | Size: 171+ bytes = 0xab+ (variable) |
+ | schema |
+ Send transactions in batches to different accounts (V2, deprecated).
Use this transaction when all required signatures are available when the transaction is created.
+ |
+
+
+
+
+
+ TRANSACTION_VERSION
+ byte[1]
+ const 2
+
+
+
+ TRANSACTION_TYPE
+
+ const AGGREGATE_COMPLETE (0x4141)
+
+
+
+ size
+ byte[4]
+ 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
+ byte[4]
+ reserved 0Reserved padding to align Signature to an 8-byte boundary.
+
+
+
+ signature
+
+ Entity's signature generated by the signing account.
+
+
+
+ signer_public_key
+
+ Public key of the signer of the entity.
+
+
+
+ entity_body_reserved_1
+ byte[4]
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
+
+ version
+ byte[1]
+ Version of this structure.
+
+
+
+ network
+
+ Network on which this entity was created.
+
+
+
+ type
+
+
+
+
+
+ fee
+
+
+
+
+
+ deadline
+
+
+
+
+
+ transactions_hash
+
+ Hash of the aggregate's transaction.
+
+
+
+ payload_size
+ byte[4]
+ 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
+ byte[4]
+ reserved 0Reserved 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.
+
diff --git a/source/serialization/AggregateCompleteTransactionV3.html b/source/serialization/AggregateCompleteTransactionV3.html
new file mode 100644
index 000000000..f87340719
--- /dev/null
+++ b/source/serialization/AggregateCompleteTransactionV3.html
@@ -0,0 +1,112 @@
+
+
+ | ↕ | Size: 171+ bytes = 0xab+ (variable) |
+ | schema |
+ Send transactions in batches to different accounts (V3, latest).
Use this transaction when all required signatures are available when the transaction is created.
+ |
+
+
+
+
+
+ TRANSACTION_VERSION
+ byte[1]
+ const 3
+
+
+
+ TRANSACTION_TYPE
+
+ const AGGREGATE_COMPLETE (0x4141)
+
+
+
+ size
+ byte[4]
+ 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
+ byte[4]
+ reserved 0Reserved padding to align Signature to an 8-byte boundary.
+
+
+
+ signature
+
+ Entity's signature generated by the signing account.
+
+
+
+ signer_public_key
+
+ Public key of the signer of the entity.
+
+
+
+ entity_body_reserved_1
+ byte[4]
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
+
+ version
+ byte[1]
+ Version of this structure.
+
+
+
+ network
+
+ Network on which this entity was created.
+
+
+
+ type
+
+
+
+
+
+ fee
+
+
+
+
+
+ deadline
+
+
+
+
+
+ transactions_hash
+
+ Hash of the aggregate's transaction.
+
+
+
+ payload_size
+ byte[4]
+ 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
+ byte[4]
+ reserved 0Reserved 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.
+
diff --git a/source/serialization/AggregateTransactionBody.html b/source/serialization/AggregateTransactionBody.html
deleted file mode 100644
index ed3e815c2..000000000
--- a/source/serialization/AggregateTransactionBody.html
+++ /dev/null
@@ -1,44 +0,0 @@
-
-
-
-
-
-
- transactions_hash
-
- Hash of the aggregate's transaction.
-
-
-
- payload_size
- byte[4]
- 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
- byte[4]
- reserved 0Reserved 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.
-
- Included in:
-
diff --git a/source/serialization/AliasAction.html b/source/serialization/AliasAction.html
index d437ae941..3bfae812c 100644
--- a/source/serialization/AliasAction.html
+++ b/source/serialization/AliasAction.html
@@ -1,7 +1,7 @@
|
Enumeration of alias actions.
diff --git a/source/serialization/BlockHeader.html b/source/serialization/Block.html
similarity index 75%
rename from source/serialization/BlockHeader.html
rename to source/serialization/Block.html
index 2c57654a6..cf19b731e 100644
--- a/source/serialization/BlockHeader.html
+++ b/source/serialization/Block.html
@@ -1,53 +1,49 @@
|
- binary layout for a block header
+binary layout for a block
|
-
-
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
+
signature
Entity's signature generated by the signing account.
-
-
+
signer_public_key
Public key of the signer of the entity.
-
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
version
byte[1]
Version of this structure.
-
+
network
@@ -120,7 +116,3 @@
fee multiplier applied to block transactions Included in:|
+
+ Collection of statements scoped to a block.
+ |
+
+
+
+
+
+ transaction_statement_count
+ byte[4]
+ Number of transaction statements.
+
+
+
+ transaction_statements
+
+
+
+
+
+ address_resolution_statement_count
+ byte[4]
+ Number of address resolution statements.
+
+
+
+ address_resolution_statements
+
+
+
+
+
+ mosaic_resolution_statement_count
+ byte[4]
+ Number of mosaic resolution statements.
+
+
+
+ mosaic_resolution_statements
+
+
+ |
enumeration of block types
|
diff --git a/source/serialization/Cosignature.html b/source/serialization/Cosignature.html
index eb9800105..e84afffa1 100644
--- a/source/serialization/Cosignature.html
+++ b/source/serialization/Cosignature.html
@@ -1,10 +1,10 @@
-Included in:
-
-
+
version
byte[8]
-
+
signer_public_key
-
+
signature
@@ -32,5 +31,5 @@
parent_hash
-
+
@@ -20,84 +19,79 @@
TRANSACTION_TYPE
const ACCOUNT_ADDRESS_RESTRICTION (0x4150)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
restriction_flags
Type of restriction being applied to the listed addresses.
-
+
restriction_additions_count
byte[1]
Number of addresses being added.
-
+
restriction_deletions_count
byte[1]
Number of addresses being removed.
-
+
account_restriction_transaction_body_reserved_1
byte[4]
reserved 0Reserved padding to align restriction_additions to an 8-byte boundary.
-
+
restriction_additions
Array of account addresses being added to the restricted list.
-
+
restriction_deletions
diff --git a/source/serialization/EmbeddedAccountKeyLinkTransaction.html b/source/serialization/EmbeddedAccountKeyLinkTransactionV1.html
similarity index 51%
rename from source/serialization/EmbeddedAccountKeyLinkTransaction.html
rename to source/serialization/EmbeddedAccountKeyLinkTransactionV1.html
index bea166716..92324653a 100644
--- a/source/serialization/EmbeddedAccountKeyLinkTransaction.html
+++ b/source/serialization/EmbeddedAccountKeyLinkTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,60 +19,55 @@
TRANSACTION_TYPE
const ACCOUNT_KEY_LINK (0x414c)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
linked_public_key
-
+
link_action
diff --git a/source/serialization/EmbeddedAccountMetadataTransaction.html b/source/serialization/EmbeddedAccountMetadataTransactionV1.html
similarity index 57%
rename from source/serialization/EmbeddedAccountMetadataTransaction.html
rename to source/serialization/EmbeddedAccountMetadataTransactionV1.html
index 0ed27abb1..cd467b5ba 100644
--- a/source/serialization/EmbeddedAccountMetadataTransaction.html
+++ b/source/serialization/EmbeddedAccountMetadataTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,78 +19,73 @@
TRANSACTION_TYPE
const ACCOUNT_METADATA (0x4144)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
target_address
Account whose metadata should be modified.
-
+
scoped_metadata_key
byte[8]
Metadata key scoped to source, target and type.
-
+
value_size_delta
byte[2]
Change in value size in bytes, compared to previous size.
-
+
value_size
byte[2]
Size in bytes of the value array.
-
+
value
diff --git a/source/serialization/EmbeddedAccountMosaicRestrictionTransaction.html b/source/serialization/EmbeddedAccountMosaicRestrictionTransactionV1.html
similarity index 58%
rename from source/serialization/EmbeddedAccountMosaicRestrictionTransaction.html
rename to source/serialization/EmbeddedAccountMosaicRestrictionTransactionV1.html
index 1804aa2a5..509cd0499 100644
--- a/source/serialization/EmbeddedAccountMosaicRestrictionTransaction.html
+++ b/source/serialization/EmbeddedAccountMosaicRestrictionTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,84 +19,79 @@
TRANSACTION_TYPE
const ACCOUNT_MOSAIC_RESTRICTION (0x4250)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
restriction_flags
Type of restriction being applied to the listed mosaics.
-
+
restriction_additions_count
byte[1]
Number of mosaics being added.
-
+
restriction_deletions_count
byte[1]
Number of mosaics being removed.
-
+
account_restriction_transaction_body_reserved_1
byte[4]
reserved 0Reserved padding to align restriction_additions to an 8-byte boundary.
-
+
restriction_additions
Array of mosaics being added to the restricted list.
-
+
restriction_deletions
diff --git a/source/serialization/EmbeddedAccountOperationRestrictionTransaction.html b/source/serialization/EmbeddedAccountOperationRestrictionTransactionV1.html
similarity index 58%
rename from source/serialization/EmbeddedAccountOperationRestrictionTransaction.html
rename to source/serialization/EmbeddedAccountOperationRestrictionTransactionV1.html
index 8afebfe05..79cf20443 100644
--- a/source/serialization/EmbeddedAccountOperationRestrictionTransaction.html
+++ b/source/serialization/EmbeddedAccountOperationRestrictionTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,84 +19,79 @@
TRANSACTION_TYPE
const ACCOUNT_OPERATION_RESTRICTION (0x4350)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
restriction_flags
Type of restriction being applied to the listed transaction types.
-
+
restriction_additions_count
byte[1]
Number of transaction types being added.
-
+
restriction_deletions_count
byte[1]
Number of transaction types being removed.
-
+
account_restriction_transaction_body_reserved_1
byte[4]
reserved 0Reserved padding to align restriction_additions to an 8-byte boundary.
-
+
restriction_additions
Array of transaction types being added to the restricted list.
-
+
restriction_deletions
diff --git a/source/serialization/EmbeddedAddressAliasTransaction.html b/source/serialization/EmbeddedAddressAliasTransactionV1.html
similarity index 54%
rename from source/serialization/EmbeddedAddressAliasTransaction.html
rename to source/serialization/EmbeddedAddressAliasTransactionV1.html
index 61b5fdc19..287ee33a6 100644
--- a/source/serialization/EmbeddedAddressAliasTransaction.html
+++ b/source/serialization/EmbeddedAddressAliasTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,66 +19,61 @@
TRANSACTION_TYPE
const ADDRESS_ALIAS (0x424e)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
namespace_id
Identifier of the namespace that will become (or stop being) an alias for the address.
-
+
address
-
+
alias_action
diff --git a/source/serialization/EmbeddedHashLockTransaction.html b/source/serialization/EmbeddedHashLockTransactionV1.html
similarity index 53%
rename from source/serialization/EmbeddedHashLockTransaction.html
rename to source/serialization/EmbeddedHashLockTransactionV1.html
index 5eb9c4bde..8709c3148 100644
--- a/source/serialization/EmbeddedHashLockTransaction.html
+++ b/source/serialization/EmbeddedHashLockTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,69 +19,64 @@
TRANSACTION_TYPE
const HASH_LOCK (0x4148)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
mosaic
-
+
duration
Number of blocks for which a lock should be valid.
The default maximum is 48h (See the maxHashLockDuration network property).
-
+
hash
-
+
diff --git a/source/serialization/EmbeddedMosaicAddressRestrictionTransaction.html b/source/serialization/EmbeddedMosaicAddressRestrictionTransactionV1.html
similarity index 57%
rename from source/serialization/EmbeddedMosaicAddressRestrictionTransaction.html
rename to source/serialization/EmbeddedMosaicAddressRestrictionTransactionV1.html
index 1fe9f91b8..22bf2eb12 100644
--- a/source/serialization/EmbeddedMosaicAddressRestrictionTransaction.html
+++ b/source/serialization/EmbeddedMosaicAddressRestrictionTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,78 +19,73 @@
TRANSACTION_TYPE
const MOSAIC_ADDRESS_RESTRICTION (0x4251)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
mosaic_id
Identifier of the mosaic to which the restriction applies.
-
+
restriction_key
byte[8]
-
+
previous_restriction_value
byte[8]
Previous 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_value
byte[8]
-
+
target_address
diff --git a/source/serialization/EmbeddedMosaicAliasTransaction.html b/source/serialization/EmbeddedMosaicAliasTransactionV1.html
similarity index 54%
rename from source/serialization/EmbeddedMosaicAliasTransaction.html
rename to source/serialization/EmbeddedMosaicAliasTransactionV1.html
index 8b31f5b22..cb55b44e0 100644
--- a/source/serialization/EmbeddedMosaicAliasTransaction.html
+++ b/source/serialization/EmbeddedMosaicAliasTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,66 +19,61 @@
TRANSACTION_TYPE
const MOSAIC_ALIAS (0x434e)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
namespace_id
Identifier of the namespace that will become (or stop being) an alias for the Mosaic.
-
+
mosaic_id
Aliased mosaic identifier.
-
+
alias_action
diff --git a/source/serialization/EmbeddedMosaicDefinitionTransaction.html b/source/serialization/EmbeddedMosaicDefinitionTransactionV1.html
similarity index 58%
rename from source/serialization/EmbeddedMosaicDefinitionTransaction.html
rename to source/serialization/EmbeddedMosaicDefinitionTransactionV1.html
index 685f4e91f..1035d6e17 100644
--- a/source/serialization/EmbeddedMosaicDefinitionTransaction.html
+++ b/source/serialization/EmbeddedMosaicDefinitionTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,78 +19,73 @@
TRANSACTION_TYPE
const MOSAIC_DEFINITION (0x414d)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
id
Unique 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.
-
+
duration
Mosaic duration expressed in blocks. If set to 0, the mosaic never expires.
-
+
nonce
Random nonce used to generate the mosaic id.
-
+
flags
-
+
divisibility
diff --git a/source/serialization/EmbeddedMosaicGlobalRestrictionTransaction.html b/source/serialization/EmbeddedMosaicGlobalRestrictionTransactionV1.html
similarity index 60%
rename from source/serialization/EmbeddedMosaicGlobalRestrictionTransaction.html
rename to source/serialization/EmbeddedMosaicGlobalRestrictionTransactionV1.html
index 67181d11e..67f312a97 100644
--- a/source/serialization/EmbeddedMosaicGlobalRestrictionTransaction.html
+++ b/source/serialization/EmbeddedMosaicGlobalRestrictionTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,90 +19,85 @@
TRANSACTION_TYPE
const MOSAIC_GLOBAL_RESTRICTION (0x4151)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
mosaic_id
Identifier of the mosaic being restricted. The mosaic creator must be the signer of the transaction.
-
+
reference_mosaic_id
Identifier 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_key
byte[8]
Restriction key relative to the reference mosaic identifier.
-
+
previous_restriction_value
byte[8]
Previous restriction value.
-
+
new_restriction_value
byte[8]
-
+
previous_restriction_type
Previous restriction type.
-
+
new_restriction_type
diff --git a/source/serialization/EmbeddedMosaicMetadataTransaction.html b/source/serialization/EmbeddedMosaicMetadataTransactionV1.html
similarity index 59%
rename from source/serialization/EmbeddedMosaicMetadataTransaction.html
rename to source/serialization/EmbeddedMosaicMetadataTransactionV1.html
index 77aff3747..492f41b31 100644
--- a/source/serialization/EmbeddedMosaicMetadataTransaction.html
+++ b/source/serialization/EmbeddedMosaicMetadataTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,84 +19,79 @@
TRANSACTION_TYPE
const MOSAIC_METADATA (0x4244)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
target_address
Account owning the mosaic whose metadata should be modified.
-
+
scoped_metadata_key
byte[8]
Metadata key scoped to source, target and type.
-
+
target_mosaic_id
Mosaic whose metadata should be modified.
-
+
value_size_delta
byte[2]
Change in value size in bytes, compared to previous size.
-
+
value_size
byte[2]
Size in bytes of the value array.
-
+
value
diff --git a/source/serialization/EmbeddedMosaicSupplyChangeTransaction.html b/source/serialization/EmbeddedMosaicSupplyChangeTransactionV1.html
similarity index 55%
rename from source/serialization/EmbeddedMosaicSupplyChangeTransaction.html
rename to source/serialization/EmbeddedMosaicSupplyChangeTransactionV1.html
index 008ae4f53..a749fb7f7 100644
--- a/source/serialization/EmbeddedMosaicSupplyChangeTransaction.html
+++ b/source/serialization/EmbeddedMosaicSupplyChangeTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,66 +19,61 @@
TRANSACTION_TYPE
const MOSAIC_SUPPLY_CHANGE (0x424d)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
mosaic_id
Affected mosaic 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
diff --git a/source/serialization/EmbeddedMosaicSupplyRevocationTransaction.html b/source/serialization/EmbeddedMosaicSupplyRevocationTransactionV1.html
similarity index 55%
rename from source/serialization/EmbeddedMosaicSupplyRevocationTransaction.html
rename to source/serialization/EmbeddedMosaicSupplyRevocationTransactionV1.html
index 6f3936210..771cc8b83 100644
--- a/source/serialization/EmbeddedMosaicSupplyRevocationTransaction.html
+++ b/source/serialization/EmbeddedMosaicSupplyRevocationTransactionV1.html
@@ -1,9 +1,9 @@
@@ -19,60 +19,55 @@
TRANSACTION_TYPE
const MOSAIC_SUPPLY_REVOCATION (0x434d)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
source_address
Address from which tokens should be revoked.
-
+
mosaic
diff --git a/source/serialization/EmbeddedMultisigAccountModificationTransaction.html b/source/serialization/EmbeddedMultisigAccountModificationTransactionV1.html
similarity index 63%
rename from source/serialization/EmbeddedMultisigAccountModificationTransaction.html
rename to source/serialization/EmbeddedMultisigAccountModificationTransactionV1.html
index c614256e5..9dad47c99 100644
--- a/source/serialization/EmbeddedMultisigAccountModificationTransaction.html
+++ b/source/serialization/EmbeddedMultisigAccountModificationTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,90 +19,85 @@
TRANSACTION_TYPE
const MULTISIG_ACCOUNT_MODIFICATION (0x4155)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
min_removal_delta
byte[1]
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
byte[1]
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
byte[1]
Number of cosignatory address additions.
-
+
address_deletions_count
byte[1]
Number of cosignatory address deletions.
-
+
multisig_account_modification_transaction_body_reserved_1
byte[4]
reserved 0Reserved 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
diff --git a/source/serialization/EmbeddedNamespaceMetadataTransaction.html b/source/serialization/EmbeddedNamespaceMetadataTransactionV1.html
similarity index 58%
rename from source/serialization/EmbeddedNamespaceMetadataTransaction.html
rename to source/serialization/EmbeddedNamespaceMetadataTransactionV1.html
index d43c9fb9e..26bba89f5 100644
--- a/source/serialization/EmbeddedNamespaceMetadataTransaction.html
+++ b/source/serialization/EmbeddedNamespaceMetadataTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,84 +19,79 @@
TRANSACTION_TYPE
const NAMESPACE_METADATA (0x4344)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
target_address
Account owning the namespace whose metadata should be modified.
-
+
scoped_metadata_key
byte[8]
Metadata key scoped to source, target and type.
-
+
target_namespace_id
Namespace whose metadata should be modified.
-
+
value_size_delta
byte[2]
Change in value size in bytes, compared to previous size.
-
+
value_size
byte[2]
Size in bytes of the value array.
-
+
value
diff --git a/source/serialization/EmbeddedNamespaceRegistrationTransaction.html b/source/serialization/EmbeddedNamespaceRegistrationTransactionV1.html
similarity index 55%
rename from source/serialization/EmbeddedNamespaceRegistrationTransaction.html
rename to source/serialization/EmbeddedNamespaceRegistrationTransactionV1.html
index 040facbf6..172858531 100644
--- a/source/serialization/EmbeddedNamespaceRegistrationTransaction.html
+++ b/source/serialization/EmbeddedNamespaceRegistrationTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,84 +19,79 @@
TRANSACTION_TYPE
const NAMESPACE_REGISTRATION (0x414e)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
duration
- Number of confirmed blocks you would like to rent the namespace for. Required for root namespaces.
-
+ Number of confirmed blocks you would like to rent the namespace for. Required for root namespaces. This field is only present if:registration_type equals ROOT
+
parent_id
- Parent namespace identifier. Required for sub-namespaces.
-
+ Parent namespace identifier. Required for sub-namespaces. This field is only present if:registration_type equals CHILD
+
id
-
+
registration_type
Namespace registration type.
-
+
name_size
byte[1]
Namespace name size in bytes.
-
+
name
diff --git a/source/serialization/EmbeddedNodeKeyLinkTransaction.html b/source/serialization/EmbeddedNodeKeyLinkTransactionV1.html
similarity index 52%
rename from source/serialization/EmbeddedNodeKeyLinkTransaction.html
rename to source/serialization/EmbeddedNodeKeyLinkTransactionV1.html
index 97b68cbe6..d85a246ea 100644
--- a/source/serialization/EmbeddedNodeKeyLinkTransaction.html
+++ b/source/serialization/EmbeddedNodeKeyLinkTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,60 +19,55 @@
TRANSACTION_TYPE
const NODE_KEY_LINK (0x424c)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
linked_public_key
-
+
link_action
diff --git a/source/serialization/EmbeddedSecretLockTransaction.html b/source/serialization/EmbeddedSecretLockTransactionV1.html
similarity index 55%
rename from source/serialization/EmbeddedSecretLockTransaction.html
rename to source/serialization/EmbeddedSecretLockTransactionV1.html
index 3133c246f..461d0bafd 100644
--- a/source/serialization/EmbeddedSecretLockTransaction.html
+++ b/source/serialization/EmbeddedSecretLockTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,78 +19,73 @@
TRANSACTION_TYPE
const SECRET_LOCK (0x4152)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
recipient_address
-
-
+
+
secret
-
+
mosaic
-
+
duration
-
-
+
+
hash_algorithm
diff --git a/source/serialization/EmbeddedSecretProofTransaction.html b/source/serialization/EmbeddedSecretProofTransactionV1.html
similarity index 56%
rename from source/serialization/EmbeddedSecretProofTransaction.html
rename to source/serialization/EmbeddedSecretProofTransactionV1.html
index f25328763..dc7cd509a 100644
--- a/source/serialization/EmbeddedSecretProofTransaction.html
+++ b/source/serialization/EmbeddedSecretProofTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,78 +19,73 @@
TRANSACTION_TYPE
const SECRET_PROOF (0x4252)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
recipient_address
Address that receives the funds once unlocked.
-
+
secret
-
+
proof_size
byte[2]
-
+
hash_algorithm
Algorithm used to hash the proof.
-
+
proof
diff --git a/source/serialization/EmbeddedTransaction.html b/source/serialization/EmbeddedTransaction.html
index 7bcfd25f3..b814f53e1 100644
--- a/source/serialization/EmbeddedTransaction.html
+++ b/source/serialization/EmbeddedTransaction.html
@@ -1,47 +1,43 @@
|
binary layout for an embedded transaction
|
-
-
-
-
+
+
size
byte[4]
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
byte[4]
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
signer_public_key
Public key of the signer of the entity.
-
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
version
byte[1]
Version of this structure.
-
+
network
@@ -54,7 +50,3 @@
- Included in:
-
diff --git a/source/serialization/EmbeddedTransactionHeader.html b/source/serialization/EmbeddedTransactionHeader.html
deleted file mode 100644
index e0e96c130..000000000
--- a/source/serialization/EmbeddedTransactionHeader.html
+++ /dev/null
@@ -1,28 +0,0 @@
- |
-
- binary layout for an embedded transaction header
- |
-
-
-
-
-
-
- size
- byte[4]
- 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
- byte[4]
-
-
- Included in:
-
diff --git a/source/serialization/EmbeddedTransferTransaction.html b/source/serialization/EmbeddedTransferTransactionV1.html
similarity index 59%
rename from source/serialization/EmbeddedTransferTransaction.html
rename to source/serialization/EmbeddedTransferTransactionV1.html
index f2831ec98..8582a66ab 100644
--- a/source/serialization/EmbeddedTransferTransaction.html
+++ b/source/serialization/EmbeddedTransferTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,90 +19,85 @@
TRANSACTION_TYPE
const TRANSFER (0x4154)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
recipient_address
-
+
message_size
byte[2]
-
+
mosaics_count
byte[1]
number of attached mosaics
-
+
transfer_transaction_body_reserved_1
- byte[4]
+ byte[1]
reserved 0reserved padding to align mosaics on 8-byte boundary
-
+
transfer_transaction_body_reserved_2
- byte[1]
+ byte[4]
reserved 0reserved padding to align mosaics on 8-byte boundary
-
+
mosaics
-
+
message
diff --git a/source/serialization/EmbeddedVotingKeyLinkTransaction.html b/source/serialization/EmbeddedVotingKeyLinkTransactionV1.html
similarity index 55%
rename from source/serialization/EmbeddedVotingKeyLinkTransaction.html
rename to source/serialization/EmbeddedVotingKeyLinkTransactionV1.html
index 8843f2f85..9c8e26969 100644
--- a/source/serialization/EmbeddedVotingKeyLinkTransaction.html
+++ b/source/serialization/EmbeddedVotingKeyLinkTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,72 +19,67 @@
TRANSACTION_TYPE
const VOTING_KEY_LINK (0x4143)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
linked_public_key
Linked voting public key.
-
+
start_epoch
Starting finalization epoch.
-
+
end_epoch
Ending finalization epoch.
-
+
link_action
diff --git a/source/serialization/EmbeddedVrfKeyLinkTransaction.html b/source/serialization/EmbeddedVrfKeyLinkTransactionV1.html
similarity index 52%
rename from source/serialization/EmbeddedVrfKeyLinkTransaction.html
rename to source/serialization/EmbeddedVrfKeyLinkTransactionV1.html
index f16272347..bdb919b9b 100644
--- a/source/serialization/EmbeddedVrfKeyLinkTransaction.html
+++ b/source/serialization/EmbeddedVrfKeyLinkTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,60 +19,55 @@
TRANSACTION_TYPE
const VRF_KEY_LINK (0x4243)
-
-
-
-
-
-
+
+
+
size
byte[4]
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
byte[4]
-
-
-
-
+ reserved 0reserved padding to align end of EmbeddedTransactionHeader on 8-byte boundary
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
-
+
linked_public_key
-
+
link_action
diff --git a/source/serialization/EntityBody.html b/source/serialization/EntityBody.html
deleted file mode 100644
index f849109ab..000000000
--- a/source/serialization/EntityBody.html
+++ /dev/null
@@ -1,39 +0,0 @@
-
-
-
-
-
-
- signer_public_key
-
- Public key of the signer of the entity.
-
-
-
- entity_body_reserved_1
- byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
-
- version
- byte[1]
- Version of this structure.
-
-
-
- network
-
- Network on which this entity was created.
-
- Included in:
-
diff --git a/source/serialization/FinalizationRound.html b/source/serialization/FinalizationRound.html
index 9772c74c7..d5c386c74 100644
--- a/source/serialization/FinalizationRound.html
+++ b/source/serialization/FinalizationRound.html
@@ -1,7 +1,7 @@
|
binary layout for finalization round
diff --git a/source/serialization/FinalizedBlockHeader.html b/source/serialization/FinalizedBlockHeader.html
index 73b398f83..e90172737 100644
--- a/source/serialization/FinalizedBlockHeader.html
+++ b/source/serialization/FinalizedBlockHeader.html
@@ -1,7 +1,7 @@
|
binary layout for finalized block header
|
diff --git a/source/serialization/GlobalKeyValue.html b/source/serialization/GlobalKeyValue.html
index 2e1d3b9be..60e1b64fc 100644
--- a/source/serialization/GlobalKeyValue.html
+++ b/source/serialization/GlobalKeyValue.html
@@ -1,7 +1,7 @@
|
binary layout for a global key-value
|
diff --git a/source/serialization/GlobalKeyValueSet.html b/source/serialization/GlobalKeyValueSet.html
index a34dd27c0..68537e55d 100644
--- a/source/serialization/GlobalKeyValueSet.html
+++ b/source/serialization/GlobalKeyValueSet.html
@@ -1,7 +1,7 @@
|
binary layout for a global restriction key-value set
|
diff --git a/source/serialization/BalanceChangeReceipt.html b/source/serialization/HarvestFeeReceipt.html
similarity index 62%
rename from source/serialization/BalanceChangeReceipt.html
rename to source/serialization/HarvestFeeReceipt.html
index 14a7aa7f9..f52af631b 100644
--- a/source/serialization/BalanceChangeReceipt.html
+++ b/source/serialization/HarvestFeeReceipt.html
@@ -1,28 +1,31 @@
|
- An invisible state change modified an account's balance.
+Receipt generated when transaction fees are credited to a block harvester.
|
-
-
-
-
+
+
+
+ RECEIPT_TYPE
+
+ const HARVEST_FEE (0x2143)
+
+
size
byte[4]
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
byte[2]
-
+
type
diff --git a/source/serialization/HashLockInfo.html b/source/serialization/HashLockInfo.html
index 373e002ff..3c65ccf69 100644
--- a/source/serialization/HashLockInfo.html
+++ b/source/serialization/HashLockInfo.html
@@ -1,15 +1,14 @@
|
binary layout for hash lock transaction info
|
-
-
+
version
diff --git a/source/serialization/HashLockTransaction.html b/source/serialization/HashLockTransaction.html
deleted file mode 100644
index 850387875..000000000
--- a/source/serialization/HashLockTransaction.html
+++ /dev/null
@@ -1,106 +0,0 @@
- |
-
- Lock a deposit needed to announce an AggregateBondedTransaction.
An AggregateBondedTransaction consumes network resources as it is stored in every node's partial cache while it waits to be fully signed. To avoid spam attacks a HashLockTransaction must be announced and confirmed before an AggregateBondedTransaction can be announced. The HashLockTransaction locks a certain amount of funds (10 XYM by default) until the aggregate is signed.
Upon completion of the aggregate, the locked funds become available again to the account that signed the HashLockTransaction.
If the lock expires before the aggregate is signed by all cosignatories (**48h by default), the locked funds become a reward collected by the block harvester at the height where the lock expires.
Note: It is not necessary to sign the aggregate and its HashLockTransaction with the same account. For example, if Bob wants to announce an aggregate and does not have enough funds to announce a HashLockTransaction, he can ask Alice to announce the lock transaction for him by sharing the signed AggregateTransaction hash.
- |
-
-
-
-
-
- TRANSACTION_VERSION
- byte[1]
- const 1
-
-
-
- TRANSACTION_TYPE
-
- const HASH_LOCK (0x4148)
-
-
-
-
-
- size
- byte[4]
- 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
- byte[4]
- reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
-
- signature
-
- Entity's signature generated by the signing account.
-
-
-
-
- signer_public_key
-
- Public key of the signer of the entity.
-
-
-
- entity_body_reserved_1
- byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
-
- version
- byte[1]
- Version of this structure.
-
-
-
- network
-
- Network on which this entity was created.
-
-
-
- type
-
-
-
-
-
- fee
-
-
-
-
-
- deadline
-
-
-
-
-
-
- mosaic
-
-
-
-
-
- duration
-
- Number of blocks for which a lock should be valid.
The default maximum is 48h (See the maxHashLockDuration network property).
-
-
-
- hash
-
-
-
diff --git a/source/serialization/HashLockTransactionBody.html b/source/serialization/HashLockTransactionBody.html
deleted file mode 100644
index 907f7df59..000000000
--- a/source/serialization/HashLockTransactionBody.html
+++ /dev/null
@@ -1,33 +0,0 @@
-
-
-
-
-
-
- mosaic
-
-
-
-
-
- duration
-
- Number of blocks for which a lock should be valid.
The default maximum is 48h (See the maxHashLockDuration network property).
-
-
-
- hash
-
-
-
- Included in:
-
diff --git a/source/serialization/HashLockTransactionV1.html b/source/serialization/HashLockTransactionV1.html
new file mode 100644
index 000000000..87c817749
--- /dev/null
+++ b/source/serialization/HashLockTransactionV1.html
@@ -0,0 +1,100 @@
+
+
+ | ↕ | Size: 187 bytes = 0xbb |
+ | schema |
+ Lock a deposit needed to announce an AggregateBondedTransactionV1 (V1, latest).
An AggregateBondedTransactionV1 consumes network resources as it is stored in every node's partial cache while it waits to be fully signed. To avoid spam attacks a HashLockTransactionV1 must be announced and confirmed before an AggregateBondedTransactionV1 can be announced. The HashLockTransactionV1 locks a certain amount of funds (10 XYM by default) until the aggregate is signed.
Upon completion of the aggregate, the locked funds become available again to the account that signed the HashLockTransactionV1.
If the lock expires before the aggregate is signed by all cosignatories (**48h by default), the locked funds become a reward collected by the block harvester at the height where the lock expires.
Note: It is not necessary to sign the aggregate and its HashLockTransactionV1 with the same account. For example, if Bob wants to announce an aggregate and does not have enough funds to announce a HashLockTransactionV1, he can ask Alice to announce the lock transaction for him by sharing the signed AggregateTransaction hash.
+ |
+
+
+
+
+
+ TRANSACTION_VERSION
+ byte[1]
+ const 1
+
+
+
+ TRANSACTION_TYPE
+
+ const HASH_LOCK (0x4148)
+
+
+
+ size
+ byte[4]
+ 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
+ byte[4]
+ reserved 0Reserved padding to align Signature to an 8-byte boundary.
+
+
+
+ signature
+
+ Entity's signature generated by the signing account.
+
+
+
+ signer_public_key
+
+ Public key of the signer of the entity.
+
+
+
+ entity_body_reserved_1
+ byte[4]
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
+
+ version
+ byte[1]
+ Version of this structure.
+
+
+
+ network
+
+ Network on which this entity was created.
+
+
+
+ type
+
+
+
+
+
+ fee
+
+
+
+
+
+ deadline
+
+
+
+
+
+ mosaic
+
+
+
+
+
+ duration
+
+ Number of blocks for which a lock should be valid.
The default maximum is 48h (See the maxHashLockDuration network property).
+
+
+
+ hash
+
+
+
diff --git a/source/serialization/HeightActivityBucket.html b/source/serialization/HeightActivityBucket.html
index ced1762fc..ea03e2948 100644
--- a/source/serialization/HeightActivityBucket.html
+++ b/source/serialization/HeightActivityBucket.html
@@ -1,7 +1,7 @@
diff --git a/source/serialization/HeightActivityBuckets.html b/source/serialization/HeightActivityBuckets.html
index bde0a7c65..8cc9a43a2 100644
--- a/source/serialization/HeightActivityBuckets.html
+++ b/source/serialization/HeightActivityBuckets.html
@@ -1,7 +1,7 @@
diff --git a/source/serialization/ImportanceBlockFooter.html b/source/serialization/ImportanceBlockFooter.html
deleted file mode 100644
index ddc05b1ac..000000000
--- a/source/serialization/ImportanceBlockFooter.html
+++ /dev/null
@@ -1,39 +0,0 @@
- |
-
- binary layout for an importance block footer
- |
-
-
-
-
-
- voting_eligible_accounts_count
- byte[4]
- number of voting eligible accounts
-
-
-
- harvesting_eligible_accounts_count
- byte[8]
- number of harvesting eligible accounts
-
-
-
- total_voting_balance
-
- total balance eligible for voting
-
-
-
- previous_importance_block_hash
-
- previous importance block hash
-
- Included in:
-
diff --git a/source/serialization/ImportanceBlockHeader.html b/source/serialization/ImportanceBlockV1.html
similarity index 71%
rename from source/serialization/ImportanceBlockHeader.html
rename to source/serialization/ImportanceBlockV1.html
index 03c5a3b77..71907ee38 100644
--- a/source/serialization/ImportanceBlockHeader.html
+++ b/source/serialization/ImportanceBlockV1.html
@@ -1,7 +1,7 @@
|
binary layout for an importance block header
|
@@ -19,141 +19,142 @@
BLOCK_TYPE
const IMPORTANCE (0x8243)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
height
-
+
timestamp
number of milliseconds elapsed since creation of nemesis block
-
+
difficulty
-
+
generation_hash_proof
-
+
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
byte[4]
number of voting eligible accounts
-
+
harvesting_eligible_accounts_count
byte[8]
number of harvesting eligible accounts
-
+
total_voting_balance
total balance eligible for voting
-
+
previous_importance_block_hash
previous importance block hash
+
+
+
+ transactions
+
+ variable sized transaction data
diff --git a/source/serialization/ImportanceSnapshot.html b/source/serialization/ImportanceSnapshot.html
index 8c5b980c5..d41703acc 100644
--- a/source/serialization/ImportanceSnapshot.html
+++ b/source/serialization/ImportanceSnapshot.html
@@ -1,7 +1,7 @@
|
temporal importance information
diff --git a/source/serialization/InflationReceipt.html b/source/serialization/InflationReceipt.html
index ca02298c4..2bad557c7 100644
--- a/source/serialization/InflationReceipt.html
+++ b/source/serialization/InflationReceipt.html
@@ -1,28 +1,32 @@
|
Network currency mosaics were created due to inflation.
|
-
-
-
-
+
+
+
+ RECEIPT_TYPE
+
+ const INFLATION (0x5143)
+
+
size
byte[4]
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
byte[2]
-
+
type
diff --git a/source/serialization/LinkAction.html b/source/serialization/LinkAction.html
index 0a237bf86..23b15ed53 100644
--- a/source/serialization/LinkAction.html
+++ b/source/serialization/LinkAction.html
@@ -1,7 +1,7 @@
|
Link actions.
diff --git a/source/serialization/LockHashAlgorithm.html b/source/serialization/LockHashAlgorithm.html
index a02e6036a..88b7fb090 100644
--- a/source/serialization/LockHashAlgorithm.html
+++ b/source/serialization/LockHashAlgorithm.html
@@ -1,7 +1,7 @@
|
Enumeration of lock hash algorithms.
diff --git a/source/serialization/LockHashCompletedFeeReceipt.html b/source/serialization/LockHashCompletedFeeReceipt.html
new file mode 100644
index 000000000..ca70291d9
--- /dev/null
+++ b/source/serialization/LockHashCompletedFeeReceipt.html
@@ -0,0 +1,46 @@
+
+
+ | ↕ | Size: 50 bytes = 0x32 |
+ | schema |
+ Receipt generated when hash lock is completed.
+ |
+
+
+
+
+
+ RECEIPT_TYPE
+
+ const LOCK_HASH_COMPLETED (0x2248)
+
+
+
+ size
+ byte[4]
+ 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
+ byte[2]
+
+
+
+
+ type
+
+
+
+
+
+ mosaic
+
+
+
+
+
+ target_address
+
+
+
+
+ | ↕ | Size: 50 bytes = 0x32 |
+ | schema |
+ Receipt generated when hash lock is created.
+ |
+
+
+
+
+
+ RECEIPT_TYPE
+
+ const LOCK_HASH_CREATED (0x3148)
+
+
+
+ size
+ byte[4]
+ 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
+ byte[2]
+
+
+
+
+ type
+
+
+
+
+
+ mosaic
+
+
+
+
+
+ target_address
+
+
+
+
+ | ↕ | Size: 50 bytes = 0x32 |
+ | schema |
+ Receipt generated when hash lock is expired.
+ |
+
+
+
+
+
+ RECEIPT_TYPE
+
+ const LOCK_HASH_EXPIRED (0x2348)
+
+
+
+ size
+ byte[4]
+ 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
+ byte[2]
+
+
+
+
+ type
+
+
+
+
+
+ mosaic
+
+
+
+
+
+ target_address
+
+
+
+
+ | ↕ | Size: 50 bytes = 0x32 |
+ | schema |
+ Receipt generated when secret lock is completed.
+ |
+
+
+
+
+
+ RECEIPT_TYPE
+
+ const LOCK_SECRET_COMPLETED (0x2252)
+
+
+
+ size
+ byte[4]
+ 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
+ byte[2]
+
+
+
+
+ type
+
+
+
+
+
+ mosaic
+
+
+
+
+
+ target_address
+
+
+
+
+ | ↕ | Size: 50 bytes = 0x32 |
+ | schema |
+ Receipt generated when secret lock is created.
+ |
+
+
+
+
+
+ RECEIPT_TYPE
+
+ const LOCK_SECRET_CREATED (0x3152)
+
+
+
+ size
+ byte[4]
+ 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
+ byte[2]
+
+
+
+
+ type
+
+
+
+
+
+ mosaic
+
+
+
+
+
+ target_address
+
+
+
+
+ | ↕ | Size: 50 bytes = 0x32 |
+ | schema |
+ Receipt generated when secret lock is expired.
+ |
+
+
+
+
+
+ RECEIPT_TYPE
+
+ const LOCK_SECRET_EXPIRED (0x2352)
+
+
+
+ size
+ byte[4]
+ 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
+ byte[2]
+
+
+
+
+ type
+
+
+
+
+
+ mosaic
+
+
+
+
+
+ target_address
+
+
+ |
lock status for lock transaction
diff --git a/source/serialization/MetadataEntry.html b/source/serialization/MetadataEntry.html
index bf4238710..d4b520d25 100644
--- a/source/serialization/MetadataEntry.html
+++ b/source/serialization/MetadataEntry.html
@@ -1,14 +1,13 @@
|
binary layout of a metadata entry
|
-
-
+
version
diff --git a/source/serialization/MetadataType.html b/source/serialization/MetadataType.html
index f02c24e0e..d9d37acd2 100644
--- a/source/serialization/MetadataType.html
+++ b/source/serialization/MetadataType.html
@@ -1,7 +1,7 @@
|
enum for the different types of metadata
diff --git a/source/serialization/MetadataValue.html b/source/serialization/MetadataValue.html
index c7a4626c1..080ed335e 100644
--- a/source/serialization/MetadataValue.html
+++ b/source/serialization/MetadataValue.html
@@ -1,7 +1,7 @@
|
binary layout of a metadata entry value
|
diff --git a/source/serialization/Mosaic.html b/source/serialization/Mosaic.html
index 84b9cef43..9fcb8884d 100644
--- a/source/serialization/Mosaic.html
+++ b/source/serialization/Mosaic.html
@@ -1,7 +1,7 @@
|
A quantity of a certain mosaic.
|
diff --git a/source/serialization/MosaicAddressRestrictionEntry.html b/source/serialization/MosaicAddressRestrictionEntry.html
index 33c71fc31..efa586dd3 100644
--- a/source/serialization/MosaicAddressRestrictionEntry.html
+++ b/source/serialization/MosaicAddressRestrictionEntry.html
@@ -1,7 +1,7 @@
|
binary layout for a mosaic restriction
|
diff --git a/source/serialization/MosaicAddressRestrictionTransactionBody.html b/source/serialization/MosaicAddressRestrictionTransactionBody.html
deleted file mode 100644
index 0ac24a3e4..000000000
--- a/source/serialization/MosaicAddressRestrictionTransactionBody.html
+++ /dev/null
@@ -1,45 +0,0 @@
-
-
-
-
-
-
- mosaic_id
-
- Identifier of the mosaic to which the restriction applies.
-
-
-
- restriction_key
- byte[8]
-
-
-
-
- previous_restriction_value
- byte[8]
- Previous 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_value
- byte[8]
-
-
-
-
- target_address
-
-
- Included in:|
- Set address specific rules to transfer a restrictable mosaic.
+Set address specific rules to transfer a restrictable mosaic (V1, latest).
|
@@ -20,96 +19,91 @@
TRANSACTION_TYPE
const MOSAIC_ADDRESS_RESTRICTION (0x4251)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
mosaic_id
Identifier of the mosaic to which the restriction applies.
-
+
restriction_key
byte[8]
-
+
previous_restriction_value
byte[8]
Previous 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_value
byte[8]
-
+
target_address
diff --git a/source/serialization/MosaicAliasTransactionBody.html b/source/serialization/MosaicAliasTransactionBody.html
deleted file mode 100644
index cf5c3a4f4..000000000
--- a/source/serialization/MosaicAliasTransactionBody.html
+++ /dev/null
@@ -1,33 +0,0 @@
-
-
-
-
-
-
- namespace_id
-
- Identifier of the namespace that will become (or stop being) an alias for the Mosaic.
-
-
-
- mosaic_id
-
- Aliased mosaic identifier.
-
-
-
- alias_action
-
-
-
- Included in:
-
diff --git a/source/serialization/MosaicAliasTransaction.html b/source/serialization/MosaicAliasTransactionV1.html
similarity index 62%
rename from source/serialization/MosaicAliasTransaction.html
rename to source/serialization/MosaicAliasTransactionV1.html
index 86a749a39..b872e0bd4 100644
--- a/source/serialization/MosaicAliasTransaction.html
+++ b/source/serialization/MosaicAliasTransactionV1.html
@@ -1,10 +1,9 @@
|
- Attach or detach a namespace to a Mosaic.
Setting an alias to a mosaic is only possible if the account announcing this transaction has also created the namespace and the mosaic involved.
+Attach or detach a namespace to a Mosaic.(V1, latest)
Setting an alias to a mosaic is only possible if the account announcing this transaction has also created the namespace and the mosaic involved.
|
@@ -20,84 +19,79 @@
TRANSACTION_TYPE
const MOSAIC_ALIAS (0x434e)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
namespace_id
Identifier of the namespace that will become (or stop being) an alias for the Mosaic.
-
+
mosaic_id
Aliased mosaic identifier.
-
+
alias_action
diff --git a/source/serialization/MosaicDefinition.html b/source/serialization/MosaicDefinition.html
index 90370650c..931c9228f 100644
--- a/source/serialization/MosaicDefinition.html
+++ b/source/serialization/MosaicDefinition.html
@@ -1,7 +1,7 @@
|
binary layout for mosaic definition
|
diff --git a/source/serialization/MosaicDefinitionTransactionBody.html b/source/serialization/MosaicDefinitionTransactionBody.html
deleted file mode 100644
index d775baff9..000000000
--- a/source/serialization/MosaicDefinitionTransactionBody.html
+++ /dev/null
@@ -1,45 +0,0 @@
-
-
-
-
-
-
- id
-
- Unique 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.
-
-
-
- duration
-
- Mosaic duration expressed in blocks. If set to 0, the mosaic never expires.
-
-
-
- nonce
-
- Random nonce used to generate the mosaic id.
-
-
-
- flags
-
-
-
-
-
- divisibility
- byte[1]
-
-
- Included in:
-
diff --git a/source/serialization/MosaicDefinitionTransaction.html b/source/serialization/MosaicDefinitionTransactionV1.html
similarity index 65%
rename from source/serialization/MosaicDefinitionTransaction.html
rename to source/serialization/MosaicDefinitionTransactionV1.html
index ab5e7e446..6e98ce34e 100644
--- a/source/serialization/MosaicDefinitionTransaction.html
+++ b/source/serialization/MosaicDefinitionTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,96 +19,91 @@
TRANSACTION_TYPE
const MOSAIC_DEFINITION (0x414d)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
id
Unique 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.
-
+
duration
Mosaic duration expressed in blocks. If set to 0, the mosaic never expires.
-
+
nonce
Random nonce used to generate the mosaic id.
-
+
flags
-
+
divisibility
diff --git a/source/serialization/MosaicEntry.html b/source/serialization/MosaicEntry.html
index 8975f35c9..ab651df1d 100644
--- a/source/serialization/MosaicEntry.html
+++ b/source/serialization/MosaicEntry.html
@@ -1,14 +1,13 @@
|
binary layout for mosaic entry
|
-
-
+
version
diff --git a/source/serialization/MosaicExpiryReceipt.html b/source/serialization/MosaicExpiredReceipt.html
similarity index 61%
rename from source/serialization/MosaicExpiryReceipt.html
rename to source/serialization/MosaicExpiredReceipt.html
index 901b691bd..9cec43030 100644
--- a/source/serialization/MosaicExpiryReceipt.html
+++ b/source/serialization/MosaicExpiredReceipt.html
@@ -1,27 +1,31 @@
- | ↕ | Size: 16 bytes = 0x10 |
- | schema |
+ | ↕ | Size: 18 bytes = 0x12 |
+ | schema |
An mosaic expired.
+Receipt generated when a mosaic expires.
|
-
-
-
-
+
+
+
+ RECEIPT_TYPE
+
+ const MOSAIC_EXPIRED (0x414d)
+
+
size
byte[4]
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
byte[2]
-
+
type
diff --git a/source/serialization/MosaicFlags.html b/source/serialization/MosaicFlags.html
index a96a61290..f79972724 100644
--- a/source/serialization/MosaicFlags.html
+++ b/source/serialization/MosaicFlags.html
@@ -1,7 +1,7 @@
|
Enumeration of mosaic property flags.
@@ -13,13 +13,13 @@
0x1
SUPPLY_MUTABLE
-Mosaic supports supply changes through a MosaicSupplyChangeTransaction 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. Mosaic 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. 0x2
TRANSFERABLE
-Mosaic supports TransferTransaction between arbitrary accounts. When not set, this mosaic can only be transferred to or from the mosaic creator. Mosaic supports TransferTransactionV1 between arbitrary accounts. When not set, this mosaic can only be transferred to or from the mosaic creator. 0x4
RESTRICTABLE
-
+
0x8
REVOKABLE
Mosaic supports revocation of tokens by the mosaic creator. |
binary layout for a mosaic restriction
|
diff --git a/source/serialization/MosaicGlobalRestrictionTransactionBody.html b/source/serialization/MosaicGlobalRestrictionTransactionBody.html
deleted file mode 100644
index eaf56bc17..000000000
--- a/source/serialization/MosaicGlobalRestrictionTransactionBody.html
+++ /dev/null
@@ -1,57 +0,0 @@
-
-
-
-
-
-
- mosaic_id
-
- Identifier of the mosaic being restricted. The mosaic creator must be the signer of the transaction.
-
-
-
- reference_mosaic_id
-
- Identifier 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_key
- byte[8]
- Restriction key relative to the reference mosaic identifier.
-
-
-
- previous_restriction_value
- byte[8]
- Previous restriction value.
-
-
-
- new_restriction_value
- byte[8]
-
-
-
-
- previous_restriction_type
-
- Previous restriction type.
-
-
-
- new_restriction_type
-
-
- Included in:|
- Set global rules to transfer a restrictable mosaic.
+Set global rules to transfer a restrictable mosaic (V1, latest).
|
@@ -20,108 +19,103 @@
TRANSACTION_TYPE
const MOSAIC_GLOBAL_RESTRICTION (0x4151)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
mosaic_id
Identifier of the mosaic being restricted. The mosaic creator must be the signer of the transaction.
-
+
reference_mosaic_id
Identifier 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_key
byte[8]
Restriction key relative to the reference mosaic identifier.
-
+
previous_restriction_value
byte[8]
Previous restriction value.
-
+
new_restriction_value
byte[8]
-
+
previous_restriction_type
Previous restriction type.
-
+
new_restriction_type
diff --git a/source/serialization/MosaicMetadataTransactionBody.html b/source/serialization/MosaicMetadataTransactionBody.html
deleted file mode 100644
index 6d3656276..000000000
--- a/source/serialization/MosaicMetadataTransactionBody.html
+++ /dev/null
@@ -1,51 +0,0 @@
-
-
-
-
-
-
- target_address
-
- Account owning the mosaic whose metadata should be modified.
-
-
-
- scoped_metadata_key
- byte[8]
- Metadata key scoped to source, target and type.
-
-
-
- target_mosaic_id
-
- Mosaic whose metadata should be modified.
-
-
-
- value_size_delta
- byte[2]
- Change in value size in bytes, compared to previous size.
-
-
-
- value_size
- byte[2]
- Size in bytes of the value array.
-
-
-
- value
- byte[value_size]
- 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.
-
- Included in:
-
diff --git a/source/serialization/MosaicMetadataTransaction.html b/source/serialization/MosaicMetadataTransactionV1.html
similarity index 63%
rename from source/serialization/MosaicMetadataTransaction.html
rename to source/serialization/MosaicMetadataTransactionV1.html
index 029e7bec8..d74e13429 100644
--- a/source/serialization/MosaicMetadataTransaction.html
+++ b/source/serialization/MosaicMetadataTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,102 +19,97 @@
TRANSACTION_TYPE
const MOSAIC_METADATA (0x4244)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
target_address
Account owning the mosaic whose metadata should be modified.
-
+
scoped_metadata_key
byte[8]
Metadata key scoped to source, target and type.
-
+
target_mosaic_id
Mosaic whose metadata should be modified.
-
+
value_size_delta
byte[2]
Change in value size in bytes, compared to previous size.
-
+
value_size
byte[2]
Size in bytes of the value array.
-
+
value
diff --git a/source/serialization/MosaicProperties.html b/source/serialization/MosaicProperties.html
index 4780b48ff..4abdf3261 100644
--- a/source/serialization/MosaicProperties.html
+++ b/source/serialization/MosaicProperties.html
@@ -1,7 +1,7 @@
|
binary layout for mosaic properties
|
diff --git a/source/serialization/BalanceTransferReceipt.html b/source/serialization/MosaicRentalFeeReceipt.html
similarity index 67%
rename from source/serialization/BalanceTransferReceipt.html
rename to source/serialization/MosaicRentalFeeReceipt.html
index 5c9233216..cb61e57f9 100644
--- a/source/serialization/BalanceTransferReceipt.html
+++ b/source/serialization/MosaicRentalFeeReceipt.html
@@ -1,28 +1,31 @@
|
- An invisible state change triggered a mosaic transfer.
+Receipt generated when a mosaic rental fee is paid.
|
-
-
-
-
+
+
+
+ RECEIPT_TYPE
+
+ const MOSAIC_RENTAL_FEE (0x124d)
+
+
size
byte[4]
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
byte[2]
-
+
type
diff --git a/source/serialization/MosaicResolutionEntry.html b/source/serialization/MosaicResolutionEntry.html
index a9e7e2c16..df5ff2585 100644
--- a/source/serialization/MosaicResolutionEntry.html
+++ b/source/serialization/MosaicResolutionEntry.html
@@ -1,7 +1,7 @@
@@ -16,7 +16,7 @@
- resolved
+ resolved_value
diff --git a/source/serialization/MosaicResolutionStatement.html b/source/serialization/MosaicResolutionStatement.html
index 98a841312..987e09b64 100644
--- a/source/serialization/MosaicResolutionStatement.html
+++ b/source/serialization/MosaicResolutionStatement.html
@@ -1,32 +1,12 @@
- | ↕ | Size: 16 bytes = 0x10 |
- | schema |
+ | ↕ | Size: 12+ bytes = 0xc+ (variable) |
+ | schema |
A Mosaic resolution statement links a namespace alias used in a transaction to the real mosaic id at the time of the transaction.
|
-
-
-
-
-
- size
- byte[4]
- 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
- byte[2]
-
-
-
-
- type
-
-
@@ -36,7 +16,13 @@
+ resolution_entries_count
+ byte[4]
+ Number of resolution entries.
+
+
+
resolution_entries
-
+
diff --git a/source/serialization/MosaicRestrictionEntry.html b/source/serialization/MosaicRestrictionEntry.html
index 5c64e2941..a7fd62441 100644
--- a/source/serialization/MosaicRestrictionEntry.html
+++ b/source/serialization/MosaicRestrictionEntry.html
@@ -1,14 +1,13 @@
- | ↕ | Size: 45+ bytes = 0x2d+ (variable) |
- | schema |
+ | ↕ | Size: 3+ bytes = 0x3+ (variable) |
+ | schema |
binary layout for a mosaic restriction
|
-
-
+
version
@@ -25,11 +24,11 @@
address_entry
-
+ address restriction rule This field is only present if:entry_type equals ADDRESS
global_entry
-
+ global mosaic rule This field is only present if:entry_type equals GLOBAL
diff --git a/source/serialization/MosaicRestrictionEntryType.html b/source/serialization/MosaicRestrictionEntryType.html
index 0d365c89b..30413cb9f 100644
--- a/source/serialization/MosaicRestrictionEntryType.html
+++ b/source/serialization/MosaicRestrictionEntryType.html
@@ -1,7 +1,7 @@
|
type of mosaic restriction entry
|
diff --git a/source/serialization/MosaicRestrictionType.html b/source/serialization/MosaicRestrictionType.html
index a577fb2ec..381c6e47e 100644
--- a/source/serialization/MosaicRestrictionType.html
+++ b/source/serialization/MosaicRestrictionType.html
@@ -1,7 +1,7 @@
|
Enumeration of mosaic restriction types.
diff --git a/source/serialization/MosaicSupplyChangeAction.html b/source/serialization/MosaicSupplyChangeAction.html
index 4b0e32478..e74774ab8 100644
--- a/source/serialization/MosaicSupplyChangeAction.html
+++ b/source/serialization/MosaicSupplyChangeAction.html
@@ -1,7 +1,7 @@
|
Enumeration of mosaic supply change actions.
diff --git a/source/serialization/MosaicSupplyChangeTransactionBody.html b/source/serialization/MosaicSupplyChangeTransactionBody.html
deleted file mode 100644
index e1503176c..000000000
--- a/source/serialization/MosaicSupplyChangeTransactionBody.html
+++ /dev/null
@@ -1,33 +0,0 @@
-
-
-
-
-
-
- mosaic_id
-
- Affected mosaic 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
-
-
- Included in:|
- Change the total supply of a mosaic.
+Change the total supply of a mosaic (V1, latest).
|
@@ -20,84 +19,79 @@
TRANSACTION_TYPE
const MOSAIC_SUPPLY_CHANGE (0x424d)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
mosaic_id
Affected mosaic 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
diff --git a/source/serialization/MosaicSupplyRevocationTransactionBody.html b/source/serialization/MosaicSupplyRevocationTransactionBody.html
deleted file mode 100644
index fc4dcd66a..000000000
--- a/source/serialization/MosaicSupplyRevocationTransactionBody.html
+++ /dev/null
@@ -1,26 +0,0 @@
-
-
-
-
-
-
- source_address
-
- Address from which tokens should be revoked.
-
-
-
- mosaic
-
- Revoked mosaic and amount.
-
- Included in:
-
diff --git a/source/serialization/MosaicSupplyRevocationTransaction.html b/source/serialization/MosaicSupplyRevocationTransactionV1.html
similarity index 63%
rename from source/serialization/MosaicSupplyRevocationTransaction.html
rename to source/serialization/MosaicSupplyRevocationTransactionV1.html
index c9b88d955..4f100c5f3 100644
--- a/source/serialization/MosaicSupplyRevocationTransaction.html
+++ b/source/serialization/MosaicSupplyRevocationTransactionV1.html
@@ -1,9 +1,9 @@
|
- Revoke mosaic.
+Revoke mosaic (V1, latest).
|
@@ -19,78 +19,73 @@
TRANSACTION_TYPE
const MOSAIC_SUPPLY_REVOCATION (0x434d)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
source_address
Address from which tokens should be revoked.
-
+
mosaic
diff --git a/source/serialization/MultisigAccountModificationTransactionBody.html b/source/serialization/MultisigAccountModificationTransactionBody.html
deleted file mode 100644
index 88a63d6c1..000000000
--- a/source/serialization/MultisigAccountModificationTransactionBody.html
+++ /dev/null
@@ -1,57 +0,0 @@
-
-
-
-
-
-
- min_removal_delta
- byte[1]
- 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
- byte[1]
- 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
- byte[1]
- Number of cosignatory address additions.
-
-
-
- address_deletions_count
- byte[1]
- Number of cosignatory address deletions.
-
-
-
- multisig_account_modification_transaction_body_reserved_1
- byte[4]
- reserved 0Reserved 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.
-
- Included in:
-
diff --git a/source/serialization/MultisigAccountModificationTransaction.html b/source/serialization/MultisigAccountModificationTransactionV1.html
similarity index 66%
rename from source/serialization/MultisigAccountModificationTransaction.html
rename to source/serialization/MultisigAccountModificationTransactionV1.html
index 257492dd4..3402c1825 100644
--- a/source/serialization/MultisigAccountModificationTransaction.html
+++ b/source/serialization/MultisigAccountModificationTransactionV1.html
@@ -1,10 +1,9 @@
|
- Create or modify a multi-signature account.
This transaction allows you to: - Transform a regular account into a multisig account. - Change the configurable properties of a multisig account. - Add or delete cosignatories from a multisig account (removing all cosignatories turns a multisig account into a regular account again).
+Create or modify a multi-signature account (V1, latest).
This transaction allows you to: - Transform a regular account into a multisig account. - Change the configurable properties of a multisig account. - Add or delete cosignatories from a multisig account (removing all cosignatories turns a multisig account into a regular account again).
|
@@ -20,108 +19,103 @@
TRANSACTION_TYPE
const MULTISIG_ACCOUNT_MODIFICATION (0x4155)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
min_removal_delta
byte[1]
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
byte[1]
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
byte[1]
Number of cosignatory address additions.
-
+
address_deletions_count
byte[1]
Number of cosignatory address deletions.
-
+
multisig_account_modification_transaction_body_reserved_1
byte[4]
reserved 0Reserved 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
diff --git a/source/serialization/MultisigEntry.html b/source/serialization/MultisigEntry.html
index 8ae4f4e7d..17cb0359e 100644
--- a/source/serialization/MultisigEntry.html
+++ b/source/serialization/MultisigEntry.html
@@ -1,14 +1,13 @@
|
binary layout for a multisig entry
|
-
-
+
version
diff --git a/source/serialization/NamespaceAlias.html b/source/serialization/NamespaceAlias.html
index 45e37a533..a275b84fb 100644
--- a/source/serialization/NamespaceAlias.html
+++ b/source/serialization/NamespaceAlias.html
@@ -1,7 +1,7 @@
- | ↕ | Size: 33 bytes = 0x21 |
- | schema |
+ | ↕ | Size: 1+ byte = 0x1+ (variable) |
+ | schema |
binary layout for alias
|
@@ -18,11 +18,11 @@
mosaic_alias
-
+ mosaic alias This field is only present if:namespace_alias_type equals MOSAIC_ID
address_alias
-
+ address alias This field is only present if:namespace_alias_type equals ADDRESS
diff --git a/source/serialization/NamespaceAliasType.html b/source/serialization/NamespaceAliasType.html
index 7420328f2..b094edb0f 100644
--- a/source/serialization/NamespaceAliasType.html
+++ b/source/serialization/NamespaceAliasType.html
@@ -1,7 +1,7 @@
diff --git a/source/serialization/NamespaceDeletedReceipt.html b/source/serialization/NamespaceDeletedReceipt.html
new file mode 100644
index 000000000..64ceec87c
--- /dev/null
+++ b/source/serialization/NamespaceDeletedReceipt.html
@@ -0,0 +1,40 @@
+
+
+
+
+
+
+ RECEIPT_TYPE
+
+ const NAMESPACE_DELETED (0x424e)
+
+
+
+ size
+ byte[4]
+ 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
+ byte[2]
+
+
+
+
+ type
+
+
+
+
+
+ artifact_id
+
+ Deleted namespace identifier.
+
diff --git a/source/serialization/NamespaceExpiryReceipt.html b/source/serialization/NamespaceExpiredReceipt.html
similarity index 59%
rename from source/serialization/NamespaceExpiryReceipt.html
rename to source/serialization/NamespaceExpiredReceipt.html
index 6f49c290f..4092d3c61 100644
--- a/source/serialization/NamespaceExpiryReceipt.html
+++ b/source/serialization/NamespaceExpiredReceipt.html
@@ -1,27 +1,31 @@
-
-
-
-
+
+
+
+ RECEIPT_TYPE
+
+ const NAMESPACE_EXPIRED (0x414e)
+
+
size
byte[4]
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
byte[2]
-
+
type
@@ -32,5 +36,5 @@
artifact_id
- Expiring namespace identifier.
+ Expired namespace identifier.
diff --git a/source/serialization/NamespaceLifetime.html b/source/serialization/NamespaceLifetime.html
index f84d332ed..790c91f62 100644
--- a/source/serialization/NamespaceLifetime.html
+++ b/source/serialization/NamespaceLifetime.html
@@ -1,7 +1,7 @@
|
binary layout for namespace lifetime
diff --git a/source/serialization/NamespaceMetadataTransactionBody.html b/source/serialization/NamespaceMetadataTransactionBody.html
deleted file mode 100644
index 158e88f0b..000000000
--- a/source/serialization/NamespaceMetadataTransactionBody.html
+++ /dev/null
@@ -1,51 +0,0 @@
-
-
-
-
-
-
- target_address
-
- Account owning the namespace whose metadata should be modified.
-
-
-
- scoped_metadata_key
- byte[8]
- Metadata key scoped to source, target and type.
-
-
-
- target_namespace_id
-
- Namespace whose metadata should be modified.
-
-
-
- value_size_delta
- byte[2]
- Change in value size in bytes, compared to previous size.
-
-
-
- value_size
- byte[2]
- Size in bytes of the value array.
-
-
-
- value
- byte[value_size]
- 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.
- Included in:
@@ -20,102 +19,97 @@
TRANSACTION_TYPE
const NAMESPACE_METADATA (0x4344)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
target_address
Account owning the namespace whose metadata should be modified.
-
+
scoped_metadata_key
byte[8]
Metadata key scoped to source, target and type.
-
+
target_namespace_id
Namespace whose metadata should be modified.
-
+
value_size_delta
byte[2]
Change in value size in bytes, compared to previous size.
-
+
value_size
byte[2]
Size in bytes of the value array.
-
+
value
diff --git a/source/serialization/NamespacePath.html b/source/serialization/NamespacePath.html
index 4e580585e..4652a5f22 100644
--- a/source/serialization/NamespacePath.html
+++ b/source/serialization/NamespacePath.html
@@ -1,7 +1,7 @@
- | ↕ | Size: 34+ bytes = 0x22+ (variable) |
- | schema |
+ | ↕ | Size: 2+ bytes = 0x2+ (variable) |
+ | schema |
binary layout for a namespace path
|
diff --git a/source/serialization/NamespaceRegistrationTransactionBody.html b/source/serialization/NamespaceRegistrationTransactionBody.html
deleted file mode 100644
index d8940ea48..000000000
--- a/source/serialization/NamespaceRegistrationTransactionBody.html
+++ /dev/null
@@ -1,51 +0,0 @@
-
-
-
-
-
-
- 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
-
-
-
-
-
- registration_type
-
- Namespace registration type.
-
-
-
- name_size
- byte[1]
- Namespace name size in bytes.
-
-
-
- name
- byte[name_size]
-
-
- Included in:
-
diff --git a/source/serialization/NamespaceRegistrationTransaction.html b/source/serialization/NamespaceRegistrationTransactionV1.html
similarity index 62%
rename from source/serialization/NamespaceRegistrationTransaction.html
rename to source/serialization/NamespaceRegistrationTransactionV1.html
index f0623de9b..8c4cb4f7e 100644
--- a/source/serialization/NamespaceRegistrationTransaction.html
+++ b/source/serialization/NamespaceRegistrationTransactionV1.html
@@ -1,10 +1,9 @@
|
- Register (or renew a registration for) a namespace.
Namespaces help keep assets organized.
+Register (or renew a registration for) a namespace (V1, latest).
Namespaces help keep assets organized.
|
@@ -20,102 +19,97 @@
TRANSACTION_TYPE
const NAMESPACE_REGISTRATION (0x414e)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
duration
- Number of confirmed blocks you would like to rent the namespace for. Required for root namespaces.
-
+ Number of confirmed blocks you would like to rent the namespace for. Required for root namespaces. This field is only present if:registration_type equals ROOT
+
parent_id
- Parent namespace identifier. Required for sub-namespaces.
-
+ Parent namespace identifier. Required for sub-namespaces. This field is only present if:registration_type equals CHILD
+
id
-
+
registration_type
Namespace registration type.
-
+
name_size
byte[1]
Namespace name size in bytes.
-
+
name
diff --git a/source/serialization/NamespaceRegistrationType.html b/source/serialization/NamespaceRegistrationType.html
index 21a1e95d0..4c6a2554c 100644
--- a/source/serialization/NamespaceRegistrationType.html
+++ b/source/serialization/NamespaceRegistrationType.html
@@ -1,7 +1,7 @@
|
Enumeration of namespace registration types.
diff --git a/source/serialization/NamespaceRentalFeeReceipt.html b/source/serialization/NamespaceRentalFeeReceipt.html
new file mode 100644
index 000000000..05e0b37bb
--- /dev/null
+++ b/source/serialization/NamespaceRentalFeeReceipt.html
@@ -0,0 +1,52 @@
+
+
+ | ↕ | Size: 74 bytes = 0x4a |
+ | schema |
+ Receipt generated when a namespace rental fee is paid.
+ |
+
+
+
+
+
+ RECEIPT_TYPE
+
+ const NAMESPACE_RENTAL_FEE (0x134e)
+
+
+
+ size
+ byte[4]
+ 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
+ byte[2]
+
+
+
+
+ type
+
+
+
+
+
+ mosaic
+
+
+
+
+
+ sender_address
+
+
+
+
+
+ recipient_address
+
+
+ |
binary layout for a nemesis block header
|
@@ -19,141 +19,142 @@
BLOCK_TYPE
const NEMESIS (0x8043)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
+
+
signer_public_key
Public key of the signer of the entity.
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
+
+
network
Network on which this entity was created.
+
type
-
+
height
-
+
timestamp
number of milliseconds elapsed since creation of nemesis block
+
difficulty
-
+
generation_hash_proof
-
+
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
byte[4]
number of voting eligible accounts
+
harvesting_eligible_accounts_count
byte[8]
number of harvesting eligible accounts
+
total_voting_balance
total balance eligible for voting
+
previous_importance_block_hash
previous importance block hash
+
+
+ transactions
+
+ variable sized transaction data |
Enumeration of network types.
|
diff --git a/source/serialization/NodeKeyLinkTransactionBody.html b/source/serialization/NodeKeyLinkTransactionBody.html
deleted file mode 100644
index 852f9df25..000000000
--- a/source/serialization/NodeKeyLinkTransactionBody.html
+++ /dev/null
@@ -1,27 +0,0 @@
-
-
-
-
-
-
- linked_public_key
-
-
-
-
-
- link_action
-
-
- Included in:|
- This transaction is required for all accounts willing to activate delegated harvesting.
Announce a NodeKeyLinkTransaction to link an account with a public key used by TLS to create sessions.
+This transaction is required for all accounts willing to activate delegated harvesting (V1, latest).
Announce a NodeKeyLinkTransactionV1 to link an account with a public key used by TLS to create sessions.
|
@@ -20,78 +19,73 @@
TRANSACTION_TYPE
const NODE_KEY_LINK (0x424c)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
linked_public_key
-
+
link_action
diff --git a/source/serialization/NormalBlockHeader.html b/source/serialization/NormalBlockV1.html
similarity index 70%
rename from source/serialization/NormalBlockHeader.html
rename to source/serialization/NormalBlockV1.html
index 317ec7a07..08a008b2d 100644
--- a/source/serialization/NormalBlockHeader.html
+++ b/source/serialization/NormalBlockV1.html
@@ -1,7 +1,7 @@
|
binary layout for a normal block header
|
@@ -19,113 +19,109 @@
BLOCK_TYPE
const NORMAL (0x8143)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
height
-
+
timestamp
number of milliseconds elapsed since creation of nemesis block
-
+
difficulty
-
+
generation_hash_proof
-
+
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
@@ -136,5 +132,11 @@
block_header_reserved_1
byte[4]
- reserved 0reserved padding to align end of BlockHeader on 8-byte boundary
+ reserved 0reserved padding to align end of BlockHeader on 8-byte boundary
+
+
+
+ transactions
+
+ variable sized transaction data |
pinned voting key
diff --git a/source/serialization/Receipt.html b/source/serialization/Receipt.html
index c0ae58b6c..3bcdced8f 100644
--- a/source/serialization/Receipt.html
+++ b/source/serialization/Receipt.html
@@ -1,15 +1,13 @@
|
Receipts provide proof for every state change not retrievable from the block.
|
-
-
+
size
@@ -28,7 +26,3 @@
Included in:|
The transaction inside the block that triggered the receipt.
diff --git a/source/serialization/ReceiptType.html b/source/serialization/ReceiptType.html
index 6beb70610..0b8fd89de 100644
--- a/source/serialization/ReceiptType.html
+++ b/source/serialization/ReceiptType.html
@@ -1,16 +1,13 @@
|
Enumeration of receipt types.
|
- 0x0
- RESERVED
-
0x124d
MOSAIC_RENTAL_FEE
diff --git a/source/serialization/RestrictionRule.html b/source/serialization/RestrictionRule.html
index b906776ab..b331af135 100644
--- a/source/serialization/RestrictionRule.html
+++ b/source/serialization/RestrictionRule.html
@@ -1,7 +1,7 @@
|
binary layout of restriction rule being applied
diff --git a/source/serialization/RootNamespaceHistory.html b/source/serialization/RootNamespaceHistory.html
index 32d11cb4a..879604882 100644
--- a/source/serialization/RootNamespaceHistory.html
+++ b/source/serialization/RootNamespaceHistory.html
@@ -1,14 +1,13 @@
- | ↕ | Size: 91+ bytes = 0x5b+ (variable) |
- | schema |
+ | ↕ | Size: 59+ bytes = 0x3b+ (variable) |
+ | schema |
binary layout for non-historical root namespace history
|
-
-
+
version
diff --git a/source/serialization/SecretLockInfo.html b/source/serialization/SecretLockInfo.html
index ebac109cd..8623a8027 100644
--- a/source/serialization/SecretLockInfo.html
+++ b/source/serialization/SecretLockInfo.html
@@ -1,15 +1,14 @@
|
binary layout for serialized lock transaction
|
-
-
+
version
diff --git a/source/serialization/SecretLockTransactionBody.html b/source/serialization/SecretLockTransactionBody.html
deleted file mode 100644
index 7ef7c3194..000000000
--- a/source/serialization/SecretLockTransactionBody.html
+++ /dev/null
@@ -1,45 +0,0 @@
-
-
-
-
-
-
- recipient_address
-
-
-
-
-
- secret
-
-
-
-
-
- mosaic
-
-
-
-
-
- duration
-
-
-
-
-
- hash_algorithm
-
- Algorithm used to hash the proof.
-
- Included in:
-
diff --git a/source/serialization/SecretLockTransaction.html b/source/serialization/SecretLockTransactionV1.html
similarity index 57%
rename from source/serialization/SecretLockTransaction.html
rename to source/serialization/SecretLockTransactionV1.html
index 39b746796..e7669df23 100644
--- a/source/serialization/SecretLockTransaction.html
+++ b/source/serialization/SecretLockTransactionV1.html
@@ -1,10 +1,9 @@
|
- Start a token swap between different chains.
Use a SecretLockTransaction to transfer mosaics between two accounts. The mosaics sent remain locked until a valid SecretProofTransaction unlocks them.
The default expiration date is 365 days after announcement (See the maxSecretLockDuration network property). If the lock expires before a valid SecretProofTransaction is announced the locked amount goes back to the initiator of the SecretLockTransaction.
+Start a token swap between different chains (V1, latest).
Use a SecretLockTransactionV1 to transfer mosaics between two accounts. The mosaics sent remain locked until a valid SecretProofTransactionV1 unlocks them.
The default expiration date is 365 days after announcement (See the maxSecretLockDuration network property). If the lock expires before a valid SecretProofTransactionV1 is announced the locked amount goes back to the initiator of the SecretLockTransactionV1.
|
@@ -20,96 +19,91 @@
TRANSACTION_TYPE
const SECRET_LOCK (0x4152)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
recipient_address
-
-
+
+
secret
-
+
mosaic
-
+
duration
-
-
+
+
hash_algorithm
diff --git a/source/serialization/SecretProofTransactionBody.html b/source/serialization/SecretProofTransactionBody.html
deleted file mode 100644
index ae15ef419..000000000
--- a/source/serialization/SecretProofTransactionBody.html
+++ /dev/null
@@ -1,45 +0,0 @@
-
-
-
-
-
-
- recipient_address
-
- Address that receives the funds once unlocked.
-
-
-
- secret
-
-
-
-
-
- proof_size
- byte[2]
-
-
-
-
- hash_algorithm
-
- Algorithm used to hash the proof.
-
-
-
- proof
- byte[proof_size]
- Original random set of bytes that were hashed.
-
- Included in:
-
diff --git a/source/serialization/SecretProofTransaction.html b/source/serialization/SecretProofTransactionV1.html
similarity index 61%
rename from source/serialization/SecretProofTransaction.html
rename to source/serialization/SecretProofTransactionV1.html
index ce306ac6f..4d3a0b750 100644
--- a/source/serialization/SecretProofTransaction.html
+++ b/source/serialization/SecretProofTransactionV1.html
@@ -1,10 +1,9 @@
@@ -20,96 +19,91 @@
TRANSACTION_TYPE
const SECRET_PROOF (0x4252)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
recipient_address
Address that receives the funds once unlocked.
-
+
secret
-
+
proof_size
byte[2]
-
+
hash_algorithm
Algorithm used to hash the proof.
-
+
proof
diff --git a/source/serialization/SizePrefixedEntity.html b/source/serialization/SizePrefixedEntity.html
deleted file mode 100644
index c0050195d..000000000
--- a/source/serialization/SizePrefixedEntity.html
+++ /dev/null
@@ -1,21 +0,0 @@
- |
-
- Serialization of an entity that has its size stated as a prefix (header).
- |
-
-
-
-
-
- size
- byte[4]
- 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).
-
- Included in:
-
diff --git a/source/serialization/StateHeader.html b/source/serialization/StateHeader.html
deleted file mode 100644
index 1bf3b6439..000000000
--- a/source/serialization/StateHeader.html
+++ /dev/null
@@ -1,20 +0,0 @@
-
-
- | ↕ | Size: 2 bytes = 0x2 |
- | schema |
- header common to all serialized states
- |
-
-
-
-
-
- version
- byte[2]
-
-
- Included in:
-
diff --git a/source/serialization/Transaction.html b/source/serialization/Transaction.html
index 9c5319ff1..a5fe600b6 100644
--- a/source/serialization/Transaction.html
+++ b/source/serialization/Transaction.html
@@ -1,53 +1,49 @@
|
binary layout for a transaction
|
-
-
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
+
signature
Entity's signature generated by the signing account.
-
-
+
signer_public_key
Public key of the signer of the entity.
-
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
version
byte[1]
Version of this structure.
-
+
network
@@ -72,7 +68,3 @@
- Included in:
-
diff --git a/source/serialization/TransactionStatement.html b/source/serialization/TransactionStatement.html
new file mode 100644
index 000000000..abaefd673
--- /dev/null
+++ b/source/serialization/TransactionStatement.html
@@ -0,0 +1,34 @@
+
+
+ | ↕ | Size: 12+ bytes = 0xc+ (variable) |
+ | schema |
+ Collection of receipts scoped to a single source (transaction or block).
+ |
+
+
+
+
+
+ primary_id
+ byte[4]
+ Transaction primary source (e.g. index within the block).
+
+
+
+ secondary_id
+ byte[4]
+ Transaction secondary source (e.g. index within aggregate).
+
+
+
+ receipt_count
+ byte[4]
+
+
+
+
+ receipts
+
+
+
diff --git a/source/serialization/TransactionType.html b/source/serialization/TransactionType.html
index 93d5bed20..3b167bc7b 100644
--- a/source/serialization/TransactionType.html
+++ b/source/serialization/TransactionType.html
@@ -1,7 +1,7 @@
@@ -9,77 +9,77 @@
0x414c
ACCOUNT_KEY_LINK
-
+
0x424c
NODE_KEY_LINK
-
+
0x4141
AGGREGATE_COMPLETE
-
+
0x4241
AGGREGATE_BONDED
-
+
0x4143
VOTING_KEY_LINK
-
+
0x4243
VRF_KEY_LINK
-
+
0x4148
HASH_LOCK
-
+
0x4152
SECRET_LOCK
-
+
0x4252
SECRET_PROOF
-
+
0x4144
ACCOUNT_METADATA
-
+
0x4244
MOSAIC_METADATA
-
+
0x4344
NAMESPACE_METADATA
-
+
0x414d
MOSAIC_DEFINITION
-
+
0x424d
MOSAIC_SUPPLY_CHANGE
-
+
0x434d
MOSAIC_SUPPLY_REVOCATION
-
+
0x4155
MULTISIG_ACCOUNT_MODIFICATION
-
+
0x424e
ADDRESS_ALIAS
-
+
0x434e
MOSAIC_ALIAS
-
+
0x414e
NAMESPACE_REGISTRATION
-
+
0x4150
ACCOUNT_ADDRESS_RESTRICTION
-
+
0x4250
ACCOUNT_MOSAIC_RESTRICTION
-
+
0x4350
ACCOUNT_OPERATION_RESTRICTION
-
+
0x4251
MOSAIC_ADDRESS_RESTRICTION
-
+
0x4151
MOSAIC_GLOBAL_RESTRICTION
-
+
0x4154
TRANSFER
-
+
diff --git a/source/serialization/TransferTransactionBody.html b/source/serialization/TransferTransactionBody.html
deleted file mode 100644
index f118c5d07..000000000
--- a/source/serialization/TransferTransactionBody.html
+++ /dev/null
@@ -1,57 +0,0 @@
-
-
-
-
-
-
- recipient_address
-
-
-
-
-
- message_size
- byte[2]
-
-
-
-
- mosaics_count
- byte[1]
- number of attached mosaics
-
-
-
- transfer_transaction_body_reserved_1
- byte[4]
- reserved 0reserved padding to align mosaics on 8-byte boundary
-
-
-
- transfer_transaction_body_reserved_2
- byte[1]
- reserved 0reserved padding to align mosaics on 8-byte boundary
-
-
-
- mosaics
-
-
-
-
-
- message
- byte[message_size]
-
-
- Included in:
-
diff --git a/source/serialization/TransferTransaction.html b/source/serialization/TransferTransactionV1.html
similarity index 65%
rename from source/serialization/TransferTransaction.html
rename to source/serialization/TransferTransactionV1.html
index a81e691e8..c322e0dab 100644
--- a/source/serialization/TransferTransaction.html
+++ b/source/serialization/TransferTransactionV1.html
@@ -1,10 +1,9 @@
|
- Send mosaics and messages between two accounts.
+Send mosaics and messages between two accounts (V1, latest).
|
@@ -20,108 +19,103 @@
TRANSACTION_TYPE
const TRANSFER (0x4154)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
recipient_address
-
+
message_size
byte[2]
-
+
mosaics_count
byte[1]
number of attached mosaics
-
+
transfer_transaction_body_reserved_1
- byte[4]
+ byte[1]
reserved 0reserved padding to align mosaics on 8-byte boundary
-
+
transfer_transaction_body_reserved_2
- byte[1]
+ byte[4]
reserved 0reserved padding to align mosaics on 8-byte boundary
-
+
mosaics
-
+
message
diff --git a/source/serialization/UnresolvedMosaic.html b/source/serialization/UnresolvedMosaic.html
index 011467215..b966f9ece 100644
--- a/source/serialization/UnresolvedMosaic.html
+++ b/source/serialization/UnresolvedMosaic.html
@@ -1,7 +1,7 @@
|
A quantity of a certain mosaic, specified either through a MosaicId or an alias.
|
diff --git a/source/serialization/VerifiableEntity.html b/source/serialization/VerifiableEntity.html
deleted file mode 100644
index bfdb92fe9..000000000
--- a/source/serialization/VerifiableEntity.html
+++ /dev/null
@@ -1,27 +0,0 @@
- |
-
- Serialization of an entity that should be signed by an account.
- |
-
-
-
-
-
- verifiable_entity_header_reserved_1
- byte[4]
- reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
-
- signature
-
- Entity's signature generated by the signing account.
-
- Included in:
-
diff --git a/source/serialization/VotingKeyLinkTransactionBody.html b/source/serialization/VotingKeyLinkTransactionBody.html
deleted file mode 100644
index fbfee6ac4..000000000
--- a/source/serialization/VotingKeyLinkTransactionBody.html
+++ /dev/null
@@ -1,39 +0,0 @@
-
-
-
-
-
-
- linked_public_key
-
- Linked voting public key.
-
-
-
- start_epoch
-
- Starting finalization epoch.
-
-
-
- end_epoch
-
- Ending finalization epoch.
-
-
-
- link_action
-
-
-
- Included in:
-
diff --git a/source/serialization/VotingKeyLinkTransaction.html b/source/serialization/VotingKeyLinkTransactionV1.html
similarity index 57%
rename from source/serialization/VotingKeyLinkTransaction.html
rename to source/serialization/VotingKeyLinkTransactionV1.html
index 3652010f3..14827d1ba 100644
--- a/source/serialization/VotingKeyLinkTransaction.html
+++ b/source/serialization/VotingKeyLinkTransactionV1.html
@@ -1,10 +1,9 @@
|
- Link an account with a BLS public key required for finalization voting.
This transaction is required for node operators wanting to vote for finalization.
Announce a VotingKeyLinkTransaction to associate a voting key with an account during a fixed period. An account can be linked to up to 3 different voting keys at the same time.
The recommended production setting is to always have at least 2 linked keys with different endPoint values to ensure a key is registered after the first one expires.
See more details in the manual node setup guide.
+Link an account with a public key required for finalization voting (V1, latest).
This transaction is required for node operators wanting to vote for finalization.
Announce a VotingKeyLinkTransactionV1 to associate a voting key with an account during a fixed period. An account can be linked to up to 3 different voting keys at the same time.
The recommended production setting is to always have at least 2 linked keys with different endPoint values to ensure a key is registered after the first one expires.
See more details in the manual node setup guide.
|
@@ -20,90 +19,85 @@
TRANSACTION_TYPE
const VOTING_KEY_LINK (0x4143)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
linked_public_key
Linked voting public key.
-
+
start_epoch
Starting finalization epoch.
-
+
end_epoch
Ending finalization epoch.
-
+
link_action
diff --git a/source/serialization/VrfKeyLinkTransactionBody.html b/source/serialization/VrfKeyLinkTransactionBody.html
deleted file mode 100644
index aa00617e1..000000000
--- a/source/serialization/VrfKeyLinkTransactionBody.html
+++ /dev/null
@@ -1,27 +0,0 @@
-
-
-
-
-
-
- linked_public_key
-
-
-
-
-
- link_action
-
-
-
- Included in:
-
diff --git a/source/serialization/VrfKeyLinkTransaction.html b/source/serialization/VrfKeyLinkTransactionV1.html
similarity index 58%
rename from source/serialization/VrfKeyLinkTransaction.html
rename to source/serialization/VrfKeyLinkTransactionV1.html
index 7d8932da5..7bc6c867f 100644
--- a/source/serialization/VrfKeyLinkTransaction.html
+++ b/source/serialization/VrfKeyLinkTransactionV1.html
@@ -1,10 +1,9 @@
|
- Link an account with a VRF public key required for harvesting.
Announce a VrfKeyLinkTransaction to link an account with a VRF public key. The linked key is used to randomize block production and leader/participant selection.
This transaction is required for all accounts wishing to harvest.
+Link an account with a VRF public key required for harvesting (V1, latest).
Announce a VrfKeyLinkTransactionV1 to link an account with a VRF public key. The linked key is used to randomize block production and leader/participant selection.
This transaction is required for all accounts wishing to harvest.
|
@@ -20,78 +19,73 @@
TRANSACTION_TYPE
const VRF_KEY_LINK (0x4243)
-
-
-
-
+
+
size
byte[4]
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
byte[4]
reserved 0Reserved padding to align Signature to an 8-byte boundary.
-
-
+
+
signature
Entity's signature generated by the signing account.
-
-
-
+
+
signer_public_key
Public key of the signer of the entity.
-
-
+
+
entity_body_reserved_1
byte[4]
- reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
-
-
+ reserved 0Reserved padding to align end of EntityBody to an 8-byte boundary.
+
+
version
byte[1]
Version of this structure.
-
-
+
+
network
Network on which this entity was created.
-
+
type
-
+
fee
-
+
deadline
-
-
+
linked_public_key
-
+
link_action
diff --git a/source/serialization/VrfProof.html b/source/serialization/VrfProof.html
index dd12695d3..9ca51ffe3 100644
--- a/source/serialization/VrfProof.html
+++ b/source/serialization/VrfProof.html
@@ -1,7 +1,7 @@
|
verfiable random function proof
diff --git a/source/serialization/index.rst b/source/serialization/index.rst
index 5539b9500..28bdf3c9e 100644
--- a/source/serialization/index.rst
+++ b/source/serialization/index.rst
@@ -2,9 +2,7 @@
Serialization
#############
-The `catbuffer schemas `_ repository defines how the different Symbol
-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.
+The `catbuffer schemas `_ repository defines how the different Symbol 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.
.. raw:: html
@@ -19,7 +17,7 @@ Basic Types
Amount
8 ubytes
-
+
BlockDuration
8 ubytes
A time lapse, expressed in number of blocks.
@@ -43,7 +41,7 @@ Basic Types
ImportanceHeight
8 ubytes
- Block height at which an Importance was calculated.
+
UnresolvedMosaicId
8 ubytes
@@ -86,15 +84,15 @@ Basic Types
NamespaceId
8 ubytes
- ScopedMetadataKey
- 8 ubytes
-
MosaicNonce
4 ubytes
MosaicRestrictionKey
8 ubytes
+ ScopedMetadataKey
+ 8 ubytes
+
Enumerations
@@ -116,6 +114,14 @@ NetworkType
.. raw:: html
:file: NetworkType.html
+.. _transactiontype:
+
+TransactionType
+===============
+
+.. raw:: html
+ :file: TransactionType.html
+
.. _blocktype:
BlockType
@@ -148,6 +154,46 @@ AliasAction
.. raw:: html
:file: AliasAction.html
+.. _lockhashalgorithm:
+
+LockHashAlgorithm
+=================
+
+.. raw:: html
+ :file: LockHashAlgorithm.html
+
+.. _mosaicflags:
+
+MosaicFlags
+===========
+
+.. raw:: html
+ :file: MosaicFlags.html
+
+.. _mosaicsupplychangeaction:
+
+MosaicSupplyChangeAction
+========================
+
+.. raw:: html
+ :file: MosaicSupplyChangeAction.html
+
+.. _accountrestrictionflags:
+
+AccountRestrictionFlags
+=======================
+
+.. raw:: html
+ :file: AccountRestrictionFlags.html
+
+.. _mosaicrestrictiontype:
+
+MosaicRestrictionType
+=====================
+
+.. raw:: html
+ :file: MosaicRestrictionType.html
+
.. _accounttype:
AccountType
@@ -188,22 +234,6 @@ MetadataType
.. raw:: html
:file: MetadataType.html
-.. _mosaicflags:
-
-MosaicFlags
-===========
-
-.. raw:: html
- :file: MosaicFlags.html
-
-.. _mosaicsupplychangeaction:
-
-MosaicSupplyChangeAction
-========================
-
-.. raw:: html
- :file: MosaicSupplyChangeAction.html
-
.. _namespacealiastype:
NamespaceAliasType
@@ -212,30 +242,6 @@ NamespaceAliasType
.. raw:: html
:file: NamespaceAliasType.html
-.. _accountrestrictionflags:
-
-AccountRestrictionFlags
-=======================
-
-.. raw:: html
- :file: AccountRestrictionFlags.html
-
-.. _transactiontype:
-
-TransactionType
-===============
-
-.. raw:: html
- :file: TransactionType.html
-
-.. _mosaicrestrictiontype:
-
-MosaicRestrictionType
-=====================
-
-.. raw:: html
- :file: MosaicRestrictionType.html
-
.. _mosaicrestrictionentrytype:
MosaicRestrictionEntryType
@@ -244,14 +250,6 @@ MosaicRestrictionEntryType
.. raw:: html
:file: MosaicRestrictionEntryType.html
-.. _lockhashalgorithm:
-
-LockHashAlgorithm
-=================
-
-.. raw:: html
- :file: LockHashAlgorithm.html
-
Structures
**********
@@ -271,6 +269,22 @@ UnresolvedMosaic
.. raw:: html
:file: UnresolvedMosaic.html
+.. _transaction:
+
+Transaction
+===========
+
+.. raw:: html
+ :file: Transaction.html
+
+.. _embeddedtransaction:
+
+EmbeddedTransaction
+===================
+
+.. raw:: html
+ :file: EmbeddedTransaction.html
+
.. _vrfproof:
VrfProof
@@ -279,29 +293,40 @@ VrfProof
.. raw:: html
:file: VrfProof.html
-.. _nemesisblockheader:
+.. _block:
-NemesisBlockHeader
-==================
+Block
+=====
.. raw:: html
- :file: NemesisBlockHeader.html
+ :file: Block.html
-.. _normalblockheader:
+.. _nemesisblockv1:
+.. _nemesisblock:
-NormalBlockHeader
-=================
+NemesisBlockV1
+==============
.. raw:: html
- :file: NormalBlockHeader.html
+ :file: NemesisBlockV1.html
-.. _importanceblockheader:
+.. _normalblockv1:
+.. _normalblock:
-ImportanceBlockHeader
-=====================
+NormalBlockV1
+=============
+
+.. raw:: html
+ :file: NormalBlockV1.html
+
+.. _importanceblockv1:
+.. _importanceblock:
+
+ImportanceBlockV1
+=================
.. raw:: html
- :file: ImportanceBlockHeader.html
+ :file: ImportanceBlockV1.html
.. _finalizationround:
@@ -319,21 +344,21 @@ FinalizedBlockHeader
.. raw:: html
:file: FinalizedBlockHeader.html
-.. _balancetransferreceipt:
+.. _receipt:
-BalanceTransferReceipt
-======================
+Receipt
+=======
.. raw:: html
- :file: BalanceTransferReceipt.html
+ :file: Receipt.html
-.. _balancechangereceipt:
+.. _harvestfeereceipt:
-BalanceChangeReceipt
-====================
+HarvestFeeReceipt
+=================
.. raw:: html
- :file: BalanceChangeReceipt.html
+ :file: HarvestFeeReceipt.html
.. _inflationreceipt:
@@ -343,979 +368,875 @@ InflationReceipt
.. raw:: html
:file: InflationReceipt.html
-.. _mosaicexpiryreceipt:
-
-MosaicExpiryReceipt
-===================
-
-.. raw:: html
- :file: MosaicExpiryReceipt.html
-
-.. _namespaceexpiryreceipt:
-
-NamespaceExpiryReceipt
-======================
-
-.. raw:: html
- :file: NamespaceExpiryReceipt.html
-
-.. _receiptsource:
-
-ReceiptSource
-=============
-
-.. raw:: html
- :file: ReceiptSource.html
-
-.. _addressresolutionentry:
+.. _lockhashcreatedfeereceipt:
-AddressResolutionEntry
-======================
+LockHashCreatedFeeReceipt
+=========================
.. raw:: html
- :file: AddressResolutionEntry.html
+ :file: LockHashCreatedFeeReceipt.html
-.. _mosaicresolutionentry:
+.. _lockhashcompletedfeereceipt:
-MosaicResolutionEntry
-=====================
+LockHashCompletedFeeReceipt
+===========================
.. raw:: html
- :file: MosaicResolutionEntry.html
+ :file: LockHashCompletedFeeReceipt.html
-.. _mosaicresolutionstatement:
+.. _lockhashexpiredfeereceipt:
-MosaicResolutionStatement
+LockHashExpiredFeeReceipt
=========================
.. raw:: html
- :file: MosaicResolutionStatement.html
+ :file: LockHashExpiredFeeReceipt.html
-.. _addressresolutionstatement:
+.. _locksecretcreatedfeereceipt:
-AddressResolutionStatement
-==========================
+LockSecretCreatedFeeReceipt
+===========================
.. raw:: html
- :file: AddressResolutionStatement.html
+ :file: LockSecretCreatedFeeReceipt.html
-.. _pinnedvotingkey:
+.. _locksecretcompletedfeereceipt:
-PinnedVotingKey
-===============
+LockSecretCompletedFeeReceipt
+=============================
.. raw:: html
- :file: PinnedVotingKey.html
+ :file: LockSecretCompletedFeeReceipt.html
-.. _importancesnapshot:
+.. _locksecretexpiredfeereceipt:
-ImportanceSnapshot
-==================
+LockSecretExpiredFeeReceipt
+===========================
.. raw:: html
- :file: ImportanceSnapshot.html
+ :file: LockSecretExpiredFeeReceipt.html
-.. _heightactivitybucket:
+.. _mosaicexpiredreceipt:
-HeightActivityBucket
+MosaicExpiredReceipt
====================
.. raw:: html
- :file: HeightActivityBucket.html
+ :file: MosaicExpiredReceipt.html
-.. _heightactivitybuckets:
+.. _mosaicrentalfeereceipt:
-HeightActivityBuckets
-=====================
+MosaicRentalFeeReceipt
+======================
.. raw:: html
- :file: HeightActivityBuckets.html
+ :file: MosaicRentalFeeReceipt.html
-.. _accountstate:
+.. _namespaceexpiredreceipt:
-AccountState
-============
+NamespaceExpiredReceipt
+=======================
.. raw:: html
- :file: AccountState.html
+ :file: NamespaceExpiredReceipt.html
-.. _hashlockinfo:
+.. _namespacedeletedreceipt:
-HashLockInfo
-============
+NamespaceDeletedReceipt
+=======================
.. raw:: html
- :file: HashLockInfo.html
+ :file: NamespaceDeletedReceipt.html
-.. _metadatavalue:
+.. _namespacerentalfeereceipt:
-MetadataValue
-=============
+NamespaceRentalFeeReceipt
+=========================
.. raw:: html
- :file: MetadataValue.html
+ :file: NamespaceRentalFeeReceipt.html
-.. _metadataentry:
+.. _receiptsource:
-MetadataEntry
+ReceiptSource
=============
.. raw:: html
- :file: MetadataEntry.html
-
-.. _mosaicproperties:
-
-MosaicProperties
-================
-
-.. raw:: html
- :file: MosaicProperties.html
-
-.. _mosaicdefinition:
-
-MosaicDefinition
-================
-
-.. raw:: html
- :file: MosaicDefinition.html
-
-.. _mosaicentry:
-
-MosaicEntry
-===========
-
-.. raw:: html
- :file: MosaicEntry.html
+ :file: ReceiptSource.html
-.. _multisigentry:
+.. _addressresolutionentry:
-MultisigEntry
-=============
+AddressResolutionEntry
+======================
.. raw:: html
- :file: MultisigEntry.html
+ :file: AddressResolutionEntry.html
-.. _namespacelifetime:
+.. _addressresolutionstatement:
-NamespaceLifetime
-=================
+AddressResolutionStatement
+==========================
.. raw:: html
- :file: NamespaceLifetime.html
+ :file: AddressResolutionStatement.html
-.. _namespacealias:
+.. _mosaicresolutionentry:
-NamespaceAlias
-==============
+MosaicResolutionEntry
+=====================
.. raw:: html
- :file: NamespaceAlias.html
+ :file: MosaicResolutionEntry.html
-.. _namespacepath:
+.. _mosaicresolutionstatement:
-NamespacePath
-=============
+MosaicResolutionStatement
+=========================
.. raw:: html
- :file: NamespacePath.html
+ :file: MosaicResolutionStatement.html
-.. _rootnamespacehistory:
+.. _transactionstatement:
-RootNamespaceHistory
+TransactionStatement
====================
.. raw:: html
- :file: RootNamespaceHistory.html
-
-.. _accountrestrictionaddressvalue:
-
-AccountRestrictionAddressValue
-==============================
-
-.. raw:: html
- :file: AccountRestrictionAddressValue.html
-
-.. _accountrestrictionmosaicvalue:
-
-AccountRestrictionMosaicValue
-=============================
-
-.. raw:: html
- :file: AccountRestrictionMosaicValue.html
-
-.. _accountrestrictiontransactiontypevalue:
-
-AccountRestrictionTransactionTypeValue
-======================================
+ :file: TransactionStatement.html
-.. raw:: html
- :file: AccountRestrictionTransactionTypeValue.html
-
-.. _accountrestrictionsinfo:
-
-AccountRestrictionsInfo
-=======================
-
-.. raw:: html
- :file: AccountRestrictionsInfo.html
-
-.. _accountrestrictions:
+.. _blockstatement:
-AccountRestrictions
-===================
-
-.. raw:: html
- :file: AccountRestrictions.html
-
-.. _addresskeyvalue:
-
-AddressKeyValue
-===============
-
-.. raw:: html
- :file: AddressKeyValue.html
-
-.. _addresskeyvalueset:
-
-AddressKeyValueSet
-==================
-
-.. raw:: html
- :file: AddressKeyValueSet.html
-
-.. _restrictionrule:
-
-RestrictionRule
-===============
-
-.. raw:: html
- :file: RestrictionRule.html
-
-.. _globalkeyvalue:
-
-GlobalKeyValue
+BlockStatement
==============
.. raw:: html
- :file: GlobalKeyValue.html
+ :file: BlockStatement.html
-.. _globalkeyvalueset:
+.. _accountkeylinktransactionv1:
+.. _accountkeylinktransaction:
-GlobalKeyValueSet
-=================
+AccountKeyLinkTransactionV1
+===========================
.. raw:: html
- :file: GlobalKeyValueSet.html
+ :file: AccountKeyLinkTransactionV1.html
-.. _mosaicaddressrestrictionentry:
+.. _embeddedaccountkeylinktransactionv1:
+.. _embeddedaccountkeylinktransaction:
-MosaicAddressRestrictionEntry
-=============================
+EmbeddedAccountKeyLinkTransactionV1
+===================================
.. raw:: html
- :file: MosaicAddressRestrictionEntry.html
+ :file: EmbeddedAccountKeyLinkTransactionV1.html
-.. _mosaicglobalrestrictionentry:
+.. _nodekeylinktransactionv1:
+.. _nodekeylinktransaction:
-MosaicGlobalRestrictionEntry
-============================
+NodeKeyLinkTransactionV1
+========================
.. raw:: html
- :file: MosaicGlobalRestrictionEntry.html
+ :file: NodeKeyLinkTransactionV1.html
-.. _mosaicrestrictionentry:
+.. _embeddednodekeylinktransactionv1:
+.. _embeddednodekeylinktransaction:
-MosaicRestrictionEntry
-======================
+EmbeddedNodeKeyLinkTransactionV1
+================================
.. raw:: html
- :file: MosaicRestrictionEntry.html
+ :file: EmbeddedNodeKeyLinkTransactionV1.html
-.. _secretlockinfo:
+.. _cosignature:
-SecretLockInfo
-==============
+Cosignature
+===========
.. raw:: html
- :file: SecretLockInfo.html
+ :file: Cosignature.html
-.. _accountkeylinktransaction:
+.. _detachedcosignature:
-AccountKeyLinkTransaction
-=========================
+DetachedCosignature
+===================
.. raw:: html
- :file: AccountKeyLinkTransaction.html
+ :file: DetachedCosignature.html
-.. _embeddedaccountkeylinktransaction:
+.. _aggregatecompletetransactionv1:
+.. _aggregatecompletetransaction:
-EmbeddedAccountKeyLinkTransaction
-=================================
+AggregateCompleteTransactionV1
+==============================
.. raw:: html
- :file: EmbeddedAccountKeyLinkTransaction.html
+ :file: AggregateCompleteTransactionV1.html
-.. _nodekeylinktransaction:
+.. _aggregatecompletetransactionv2:
-NodeKeyLinkTransaction
-======================
+AggregateCompleteTransactionV2
+==============================
.. raw:: html
- :file: NodeKeyLinkTransaction.html
+ :file: AggregateCompleteTransactionV2.html
-.. _embeddednodekeylinktransaction:
+.. _aggregatecompletetransactionv3:
-EmbeddedNodeKeyLinkTransaction
+AggregateCompleteTransactionV3
==============================
.. raw:: html
- :file: EmbeddedNodeKeyLinkTransaction.html
+ :file: AggregateCompleteTransactionV3.html
-.. _detachedcosignature:
+.. _aggregatebondedtransactionv1:
+.. _aggregatebondedtransaction:
-DetachedCosignature
-===================
+AggregateBondedTransactionV1
+============================
.. raw:: html
- :file: DetachedCosignature.html
+ :file: AggregateBondedTransactionV1.html
-.. _aggregatecompletetransaction:
+.. _aggregatebondedtransactionv2:
-AggregateCompleteTransaction
+AggregateBondedTransactionV2
============================
.. raw:: html
- :file: AggregateCompleteTransaction.html
+ :file: AggregateBondedTransactionV2.html
-.. _aggregatebondedtransaction:
+.. _aggregatebondedtransactionv3:
-AggregateBondedTransaction
-==========================
+AggregateBondedTransactionV3
+============================
.. raw:: html
- :file: AggregateBondedTransaction.html
+ :file: AggregateBondedTransactionV3.html
+.. _votingkeylinktransactionv1:
.. _votingkeylinktransaction:
-VotingKeyLinkTransaction
-========================
+VotingKeyLinkTransactionV1
+==========================
.. raw:: html
- :file: VotingKeyLinkTransaction.html
+ :file: VotingKeyLinkTransactionV1.html
+.. _embeddedvotingkeylinktransactionv1:
.. _embeddedvotingkeylinktransaction:
-EmbeddedVotingKeyLinkTransaction
-================================
+EmbeddedVotingKeyLinkTransactionV1
+==================================
.. raw:: html
- :file: EmbeddedVotingKeyLinkTransaction.html
+ :file: EmbeddedVotingKeyLinkTransactionV1.html
+.. _vrfkeylinktransactionv1:
.. _vrfkeylinktransaction:
-VrfKeyLinkTransaction
-=====================
+VrfKeyLinkTransactionV1
+=======================
.. raw:: html
- :file: VrfKeyLinkTransaction.html
+ :file: VrfKeyLinkTransactionV1.html
+.. _embeddedvrfkeylinktransactionv1:
.. _embeddedvrfkeylinktransaction:
-EmbeddedVrfKeyLinkTransaction
-=============================
+EmbeddedVrfKeyLinkTransactionV1
+===============================
.. raw:: html
- :file: EmbeddedVrfKeyLinkTransaction.html
+ :file: EmbeddedVrfKeyLinkTransactionV1.html
+.. _hashlocktransactionv1:
.. _hashlocktransaction:
-HashLockTransaction
-===================
+HashLockTransactionV1
+=====================
.. raw:: html
- :file: HashLockTransaction.html
+ :file: HashLockTransactionV1.html
+.. _embeddedhashlocktransactionv1:
.. _embeddedhashlocktransaction:
-EmbeddedHashLockTransaction
-===========================
+EmbeddedHashLockTransactionV1
+=============================
.. raw:: html
- :file: EmbeddedHashLockTransaction.html
+ :file: EmbeddedHashLockTransactionV1.html
+.. _secretlocktransactionv1:
.. _secretlocktransaction:
-SecretLockTransaction
-=====================
+SecretLockTransactionV1
+=======================
.. raw:: html
- :file: SecretLockTransaction.html
+ :file: SecretLockTransactionV1.html
+.. _embeddedsecretlocktransactionv1:
.. _embeddedsecretlocktransaction:
-EmbeddedSecretLockTransaction
-=============================
+EmbeddedSecretLockTransactionV1
+===============================
.. raw:: html
- :file: EmbeddedSecretLockTransaction.html
+ :file: EmbeddedSecretLockTransactionV1.html
+.. _secretprooftransactionv1:
.. _secretprooftransaction:
-SecretProofTransaction
-======================
+SecretProofTransactionV1
+========================
.. raw:: html
- :file: SecretProofTransaction.html
+ :file: SecretProofTransactionV1.html
+.. _embeddedsecretprooftransactionv1:
.. _embeddedsecretprooftransaction:
-EmbeddedSecretProofTransaction
-==============================
+EmbeddedSecretProofTransactionV1
+================================
.. raw:: html
- :file: EmbeddedSecretProofTransaction.html
+ :file: EmbeddedSecretProofTransactionV1.html
+.. _accountmetadatatransactionv1:
.. _accountmetadatatransaction:
-AccountMetadataTransaction
-==========================
+AccountMetadataTransactionV1
+============================
.. raw:: html
- :file: AccountMetadataTransaction.html
+ :file: AccountMetadataTransactionV1.html
+.. _embeddedaccountmetadatatransactionv1:
.. _embeddedaccountmetadatatransaction:
-EmbeddedAccountMetadataTransaction
-==================================
+EmbeddedAccountMetadataTransactionV1
+====================================
.. raw:: html
- :file: EmbeddedAccountMetadataTransaction.html
+ :file: EmbeddedAccountMetadataTransactionV1.html
+.. _mosaicmetadatatransactionv1:
.. _mosaicmetadatatransaction:
-MosaicMetadataTransaction
-=========================
+MosaicMetadataTransactionV1
+===========================
.. raw:: html
- :file: MosaicMetadataTransaction.html
+ :file: MosaicMetadataTransactionV1.html
+.. _embeddedmosaicmetadatatransactionv1:
.. _embeddedmosaicmetadatatransaction:
-EmbeddedMosaicMetadataTransaction
-=================================
+EmbeddedMosaicMetadataTransactionV1
+===================================
.. raw:: html
- :file: EmbeddedMosaicMetadataTransaction.html
+ :file: EmbeddedMosaicMetadataTransactionV1.html
+.. _namespacemetadatatransactionv1:
.. _namespacemetadatatransaction:
-NamespaceMetadataTransaction
-============================
+NamespaceMetadataTransactionV1
+==============================
.. raw:: html
- :file: NamespaceMetadataTransaction.html
+ :file: NamespaceMetadataTransactionV1.html
+.. _embeddednamespacemetadatatransactionv1:
.. _embeddednamespacemetadatatransaction:
-EmbeddedNamespaceMetadataTransaction
-====================================
+EmbeddedNamespaceMetadataTransactionV1
+======================================
.. raw:: html
- :file: EmbeddedNamespaceMetadataTransaction.html
+ :file: EmbeddedNamespaceMetadataTransactionV1.html
+.. _mosaicdefinitiontransactionv1:
.. _mosaicdefinitiontransaction:
-MosaicDefinitionTransaction
-===========================
+MosaicDefinitionTransactionV1
+=============================
.. raw:: html
- :file: MosaicDefinitionTransaction.html
+ :file: MosaicDefinitionTransactionV1.html
+.. _embeddedmosaicdefinitiontransactionv1:
.. _embeddedmosaicdefinitiontransaction:
-EmbeddedMosaicDefinitionTransaction
-===================================
+EmbeddedMosaicDefinitionTransactionV1
+=====================================
.. raw:: html
- :file: EmbeddedMosaicDefinitionTransaction.html
+ :file: EmbeddedMosaicDefinitionTransactionV1.html
+.. _mosaicsupplychangetransactionv1:
.. _mosaicsupplychangetransaction:
-MosaicSupplyChangeTransaction
-=============================
+MosaicSupplyChangeTransactionV1
+===============================
.. raw:: html
- :file: MosaicSupplyChangeTransaction.html
+ :file: MosaicSupplyChangeTransactionV1.html
+.. _embeddedmosaicsupplychangetransactionv1:
.. _embeddedmosaicsupplychangetransaction:
-EmbeddedMosaicSupplyChangeTransaction
-=====================================
+EmbeddedMosaicSupplyChangeTransactionV1
+=======================================
.. raw:: html
- :file: EmbeddedMosaicSupplyChangeTransaction.html
+ :file: EmbeddedMosaicSupplyChangeTransactionV1.html
+.. _mosaicsupplyrevocationtransactionv1:
.. _mosaicsupplyrevocationtransaction:
-MosaicSupplyRevocationTransaction
-=================================
+MosaicSupplyRevocationTransactionV1
+===================================
.. raw:: html
- :file: MosaicSupplyRevocationTransaction.html
+ :file: MosaicSupplyRevocationTransactionV1.html
+.. _embeddedmosaicsupplyrevocationtransactionv1:
.. _embeddedmosaicsupplyrevocationtransaction:
-EmbeddedMosaicSupplyRevocationTransaction
-=========================================
+EmbeddedMosaicSupplyRevocationTransactionV1
+===========================================
.. raw:: html
- :file: EmbeddedMosaicSupplyRevocationTransaction.html
+ :file: EmbeddedMosaicSupplyRevocationTransactionV1.html
+.. _multisigaccountmodificationtransactionv1:
.. _multisigaccountmodificationtransaction:
-MultisigAccountModificationTransaction
-======================================
+MultisigAccountModificationTransactionV1
+========================================
.. raw:: html
- :file: MultisigAccountModificationTransaction.html
+ :file: MultisigAccountModificationTransactionV1.html
+.. _embeddedmultisigaccountmodificationtransactionv1:
.. _embeddedmultisigaccountmodificationtransaction:
-EmbeddedMultisigAccountModificationTransaction
-==============================================
+EmbeddedMultisigAccountModificationTransactionV1
+================================================
.. raw:: html
- :file: EmbeddedMultisigAccountModificationTransaction.html
+ :file: EmbeddedMultisigAccountModificationTransactionV1.html
+.. _addressaliastransactionv1:
.. _addressaliastransaction:
-AddressAliasTransaction
-=======================
+AddressAliasTransactionV1
+=========================
.. raw:: html
- :file: AddressAliasTransaction.html
+ :file: AddressAliasTransactionV1.html
+.. _embeddedaddressaliastransactionv1:
.. _embeddedaddressaliastransaction:
-EmbeddedAddressAliasTransaction
-===============================
+EmbeddedAddressAliasTransactionV1
+=================================
.. raw:: html
- :file: EmbeddedAddressAliasTransaction.html
+ :file: EmbeddedAddressAliasTransactionV1.html
+.. _mosaicaliastransactionv1:
.. _mosaicaliastransaction:
-MosaicAliasTransaction
-======================
+MosaicAliasTransactionV1
+========================
.. raw:: html
- :file: MosaicAliasTransaction.html
+ :file: MosaicAliasTransactionV1.html
+.. _embeddedmosaicaliastransactionv1:
.. _embeddedmosaicaliastransaction:
-EmbeddedMosaicAliasTransaction
-==============================
+EmbeddedMosaicAliasTransactionV1
+================================
.. raw:: html
- :file: EmbeddedMosaicAliasTransaction.html
+ :file: EmbeddedMosaicAliasTransactionV1.html
+.. _namespaceregistrationtransactionv1:
.. _namespaceregistrationtransaction:
-NamespaceRegistrationTransaction
-================================
+NamespaceRegistrationTransactionV1
+==================================
.. raw:: html
- :file: NamespaceRegistrationTransaction.html
+ :file: NamespaceRegistrationTransactionV1.html
+.. _embeddednamespaceregistrationtransactionv1:
.. _embeddednamespaceregistrationtransaction:
-EmbeddedNamespaceRegistrationTransaction
-========================================
+EmbeddedNamespaceRegistrationTransactionV1
+==========================================
.. raw:: html
- :file: EmbeddedNamespaceRegistrationTransaction.html
+ :file: EmbeddedNamespaceRegistrationTransactionV1.html
+.. _accountaddressrestrictiontransactionv1:
.. _accountaddressrestrictiontransaction:
-AccountAddressRestrictionTransaction
-====================================
+AccountAddressRestrictionTransactionV1
+======================================
.. raw:: html
- :file: AccountAddressRestrictionTransaction.html
+ :file: AccountAddressRestrictionTransactionV1.html
+.. _embeddedaccountaddressrestrictiontransactionv1:
.. _embeddedaccountaddressrestrictiontransaction:
-EmbeddedAccountAddressRestrictionTransaction
-============================================
+EmbeddedAccountAddressRestrictionTransactionV1
+==============================================
.. raw:: html
- :file: EmbeddedAccountAddressRestrictionTransaction.html
+ :file: EmbeddedAccountAddressRestrictionTransactionV1.html
+.. _accountmosaicrestrictiontransactionv1:
.. _accountmosaicrestrictiontransaction:
-AccountMosaicRestrictionTransaction
-===================================
+AccountMosaicRestrictionTransactionV1
+=====================================
.. raw:: html
- :file: AccountMosaicRestrictionTransaction.html
+ :file: AccountMosaicRestrictionTransactionV1.html
+.. _embeddedaccountmosaicrestrictiontransactionv1:
.. _embeddedaccountmosaicrestrictiontransaction:
-EmbeddedAccountMosaicRestrictionTransaction
-===========================================
+EmbeddedAccountMosaicRestrictionTransactionV1
+=============================================
.. raw:: html
- :file: EmbeddedAccountMosaicRestrictionTransaction.html
+ :file: EmbeddedAccountMosaicRestrictionTransactionV1.html
+.. _accountoperationrestrictiontransactionv1:
.. _accountoperationrestrictiontransaction:
-AccountOperationRestrictionTransaction
-======================================
+AccountOperationRestrictionTransactionV1
+========================================
.. raw:: html
- :file: AccountOperationRestrictionTransaction.html
+ :file: AccountOperationRestrictionTransactionV1.html
+.. _embeddedaccountoperationrestrictiontransactionv1:
.. _embeddedaccountoperationrestrictiontransaction:
-EmbeddedAccountOperationRestrictionTransaction
-==============================================
+EmbeddedAccountOperationRestrictionTransactionV1
+================================================
.. raw:: html
- :file: EmbeddedAccountOperationRestrictionTransaction.html
+ :file: EmbeddedAccountOperationRestrictionTransactionV1.html
+.. _mosaicaddressrestrictiontransactionv1:
.. _mosaicaddressrestrictiontransaction:
-MosaicAddressRestrictionTransaction
-===================================
+MosaicAddressRestrictionTransactionV1
+=====================================
.. raw:: html
- :file: MosaicAddressRestrictionTransaction.html
+ :file: MosaicAddressRestrictionTransactionV1.html
+.. _embeddedmosaicaddressrestrictiontransactionv1:
.. _embeddedmosaicaddressrestrictiontransaction:
-EmbeddedMosaicAddressRestrictionTransaction
-===========================================
+EmbeddedMosaicAddressRestrictionTransactionV1
+=============================================
.. raw:: html
- :file: EmbeddedMosaicAddressRestrictionTransaction.html
+ :file: EmbeddedMosaicAddressRestrictionTransactionV1.html
+.. _mosaicglobalrestrictiontransactionv1:
.. _mosaicglobalrestrictiontransaction:
-MosaicGlobalRestrictionTransaction
-==================================
+MosaicGlobalRestrictionTransactionV1
+====================================
.. raw:: html
- :file: MosaicGlobalRestrictionTransaction.html
+ :file: MosaicGlobalRestrictionTransactionV1.html
+.. _embeddedmosaicglobalrestrictiontransactionv1:
.. _embeddedmosaicglobalrestrictiontransaction:
-EmbeddedMosaicGlobalRestrictionTransaction
-==========================================
+EmbeddedMosaicGlobalRestrictionTransactionV1
+============================================
.. raw:: html
- :file: EmbeddedMosaicGlobalRestrictionTransaction.html
+ :file: EmbeddedMosaicGlobalRestrictionTransactionV1.html
+.. _transfertransactionv1:
.. _transfertransaction:
-TransferTransaction
-===================
+TransferTransactionV1
+=====================
.. raw:: html
- :file: TransferTransaction.html
+ :file: TransferTransactionV1.html
+.. _embeddedtransfertransactionv1:
.. _embeddedtransfertransaction:
-EmbeddedTransferTransaction
-===========================
-
-.. raw:: html
- :file: EmbeddedTransferTransaction.html
-
-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.
-
-.. _sizeprefixedentity:
-
-SizePrefixedEntity
-==================
+EmbeddedTransferTransactionV1
+=============================
.. raw:: html
- :file: SizePrefixedEntity.html
+ :file: EmbeddedTransferTransactionV1.html
-.. _verifiableentity:
+.. _pinnedvotingkey:
-VerifiableEntity
-================
+PinnedVotingKey
+===============
.. raw:: html
- :file: VerifiableEntity.html
+ :file: PinnedVotingKey.html
-.. _entitybody:
+.. _importancesnapshot:
-EntityBody
-==========
+ImportanceSnapshot
+==================
.. raw:: html
- :file: EntityBody.html
+ :file: ImportanceSnapshot.html
-.. _blockheader:
+.. _heightactivitybucket:
-BlockHeader
-===========
+HeightActivityBucket
+====================
.. raw:: html
- :file: BlockHeader.html
+ :file: HeightActivityBucket.html
-.. _importanceblockfooter:
+.. _heightactivitybuckets:
-ImportanceBlockFooter
+HeightActivityBuckets
=====================
.. raw:: html
- :file: ImportanceBlockFooter.html
-
-.. _receipt:
-
-Receipt
-=======
-
-.. raw:: html
- :file: Receipt.html
+ :file: HeightActivityBuckets.html
-.. _stateheader:
+.. _accountstate:
-StateHeader
-===========
+AccountState
+============
.. raw:: html
- :file: StateHeader.html
+ :file: AccountState.html
-.. _transaction:
+.. _hashlockinfo:
-Transaction
-===========
+HashLockInfo
+============
.. raw:: html
- :file: Transaction.html
+ :file: HashLockInfo.html
-.. _embeddedtransactionheader:
+.. _metadatavalue:
-EmbeddedTransactionHeader
-=========================
+MetadataValue
+=============
.. raw:: html
- :file: EmbeddedTransactionHeader.html
+ :file: MetadataValue.html
-.. _embeddedtransaction:
+.. _metadataentry:
-EmbeddedTransaction
-===================
+MetadataEntry
+=============
.. raw:: html
- :file: EmbeddedTransaction.html
+ :file: MetadataEntry.html
-.. _accountkeylinktransactionbody:
+.. _mosaicproperties:
-AccountKeyLinkTransactionBody
-=============================
+MosaicProperties
+================
.. raw:: html
- :file: AccountKeyLinkTransactionBody.html
+ :file: MosaicProperties.html
-.. _nodekeylinktransactionbody:
+.. _mosaicdefinition:
-NodeKeyLinkTransactionBody
-==========================
+MosaicDefinition
+================
.. raw:: html
- :file: NodeKeyLinkTransactionBody.html
+ :file: MosaicDefinition.html
-.. _cosignature:
+.. _mosaicentry:
-Cosignature
+MosaicEntry
===========
.. raw:: html
- :file: Cosignature.html
-
-.. _aggregatetransactionbody:
-
-AggregateTransactionBody
-========================
-
-.. raw:: html
- :file: AggregateTransactionBody.html
+ :file: MosaicEntry.html
-.. _votingkeylinktransactionbody:
+.. _multisigentry:
-VotingKeyLinkTransactionBody
-============================
+MultisigEntry
+=============
.. raw:: html
- :file: VotingKeyLinkTransactionBody.html
+ :file: MultisigEntry.html
-.. _vrfkeylinktransactionbody:
+.. _namespacelifetime:
-VrfKeyLinkTransactionBody
-=========================
+NamespaceLifetime
+=================
.. raw:: html
- :file: VrfKeyLinkTransactionBody.html
+ :file: NamespaceLifetime.html
-.. _hashlocktransactionbody:
+.. _namespacealias:
-HashLockTransactionBody
-=======================
+NamespaceAlias
+==============
.. raw:: html
- :file: HashLockTransactionBody.html
+ :file: NamespaceAlias.html
-.. _secretlocktransactionbody:
+.. _namespacepath:
-SecretLockTransactionBody
-=========================
+NamespacePath
+=============
.. raw:: html
- :file: SecretLockTransactionBody.html
+ :file: NamespacePath.html
-.. _secretprooftransactionbody:
+.. _rootnamespacehistory:
-SecretProofTransactionBody
-==========================
+RootNamespaceHistory
+====================
.. raw:: html
- :file: SecretProofTransactionBody.html
+ :file: RootNamespaceHistory.html
-.. _accountmetadatatransactionbody:
+.. _accountrestrictionaddressvalue:
-AccountMetadataTransactionBody
+AccountRestrictionAddressValue
==============================
.. raw:: html
- :file: AccountMetadataTransactionBody.html
+ :file: AccountRestrictionAddressValue.html
-.. _mosaicmetadatatransactionbody:
+.. _accountrestrictionmosaicvalue:
-MosaicMetadataTransactionBody
+AccountRestrictionMosaicValue
=============================
.. raw:: html
- :file: MosaicMetadataTransactionBody.html
-
-.. _namespacemetadatatransactionbody:
-
-NamespaceMetadataTransactionBody
-================================
-
-.. raw:: html
- :file: NamespaceMetadataTransactionBody.html
+ :file: AccountRestrictionMosaicValue.html
-.. _mosaicdefinitiontransactionbody:
+.. _accountrestrictiontransactiontypevalue:
-MosaicDefinitionTransactionBody
-===============================
+AccountRestrictionTransactionTypeValue
+======================================
.. raw:: html
- :file: MosaicDefinitionTransactionBody.html
+ :file: AccountRestrictionTransactionTypeValue.html
-.. _mosaicsupplychangetransactionbody:
+.. _accountrestrictionsinfo:
-MosaicSupplyChangeTransactionBody
-=================================
+AccountRestrictionsInfo
+=======================
.. raw:: html
- :file: MosaicSupplyChangeTransactionBody.html
+ :file: AccountRestrictionsInfo.html
-.. _mosaicsupplyrevocationtransactionbody:
+.. _accountrestrictions:
-MosaicSupplyRevocationTransactionBody
-=====================================
+AccountRestrictions
+===================
.. raw:: html
- :file: MosaicSupplyRevocationTransactionBody.html
+ :file: AccountRestrictions.html
-.. _multisigaccountmodificationtransactionbody:
+.. _addresskeyvalue:
-MultisigAccountModificationTransactionBody
-==========================================
+AddressKeyValue
+===============
.. raw:: html
- :file: MultisigAccountModificationTransactionBody.html
+ :file: AddressKeyValue.html
-.. _addressaliastransactionbody:
+.. _addresskeyvalueset:
-AddressAliasTransactionBody
-===========================
+AddressKeyValueSet
+==================
.. raw:: html
- :file: AddressAliasTransactionBody.html
+ :file: AddressKeyValueSet.html
-.. _mosaicaliastransactionbody:
+.. _restrictionrule:
-MosaicAliasTransactionBody
-==========================
+RestrictionRule
+===============
.. raw:: html
- :file: MosaicAliasTransactionBody.html
+ :file: RestrictionRule.html
-.. _namespaceregistrationtransactionbody:
+.. _globalkeyvalue:
-NamespaceRegistrationTransactionBody
-====================================
+GlobalKeyValue
+==============
.. raw:: html
- :file: NamespaceRegistrationTransactionBody.html
+ :file: GlobalKeyValue.html
-.. _accountaddressrestrictiontransactionbody:
+.. _globalkeyvalueset:
-AccountAddressRestrictionTransactionBody
-========================================
+GlobalKeyValueSet
+=================
.. raw:: html
- :file: AccountAddressRestrictionTransactionBody.html
+ :file: GlobalKeyValueSet.html
-.. _accountmosaicrestrictiontransactionbody:
+.. _mosaicaddressrestrictionentry:
-AccountMosaicRestrictionTransactionBody
-=======================================
+MosaicAddressRestrictionEntry
+=============================
.. raw:: html
- :file: AccountMosaicRestrictionTransactionBody.html
+ :file: MosaicAddressRestrictionEntry.html
-.. _accountoperationrestrictiontransactionbody:
+.. _mosaicglobalrestrictionentry:
-AccountOperationRestrictionTransactionBody
-==========================================
+MosaicGlobalRestrictionEntry
+============================
.. raw:: html
- :file: AccountOperationRestrictionTransactionBody.html
+ :file: MosaicGlobalRestrictionEntry.html
-.. _mosaicaddressrestrictiontransactionbody:
+.. _mosaicrestrictionentry:
-MosaicAddressRestrictionTransactionBody
-=======================================
+MosaicRestrictionEntry
+======================
.. raw:: html
- :file: MosaicAddressRestrictionTransactionBody.html
+ :file: MosaicRestrictionEntry.html
-.. _mosaicglobalrestrictiontransactionbody:
+.. _secretlockinfo:
-MosaicGlobalRestrictionTransactionBody
-======================================
+SecretLockInfo
+==============
.. raw:: html
- :file: MosaicGlobalRestrictionTransactionBody.html
-
-.. _transfertransactionbody:
+ :file: SecretLockInfo.html
-TransferTransactionBody
-=======================
+Inner Structures
+****************
-.. raw:: html
- :file: TransferTransactionBody.html
+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.
.. raw:: html
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|