From 145876bfdfd37fc004a48ada8b2f4bcfb4ee3ea1 Mon Sep 17 00:00:00 2001 From: zero <234838951+zero4862@users.noreply.github.com> Date: Tue, 26 May 2026 22:05:57 +0200 Subject: [PATCH] [mkdocs] docs: add serialization reference --- mkdocs/config/mkdocs.base.yml | 2 +- .../devbook/reference/serialization/index.md | 207 ++++++++++++++++++ .../AccountKeyLinkTransactionV1.html | 106 +++++++++ .../reference/serialization/Block.html | 100 +++++++++ .../reference/serialization/BlockType.html | 16 ++ .../serialization/CosignatureV1.html | 118 ++++++++++ .../serialization/CosignatureV1Body.html | 52 +++++ .../reference/serialization/LinkAction.html | 16 ++ .../reference/serialization/Message.html | 28 +++ .../reference/serialization/MessageType.html | 16 ++ .../reference/serialization/Mosaic.html | 28 +++ .../serialization/MosaicDefinition.html | 70 ++++++ .../MosaicDefinitionTransactionV1.html | 118 ++++++++++ .../reference/serialization/MosaicId.html | 28 +++ .../reference/serialization/MosaicLevy.html | 46 ++++ .../serialization/MosaicProperty.html | 34 +++ .../MosaicSupplyChangeAction.html | 16 ++ .../MosaicSupplyChangeTransactionV1.html | 112 ++++++++++ .../serialization/MosaicTransferFeeType.html | 16 ++ .../MultisigAccountModification.html | 28 +++ ...tisigAccountModificationTransactionV1.html | 100 +++++++++ ...tisigAccountModificationTransactionV2.html | 112 ++++++++++ .../MultisigAccountModificationType.html | 16 ++ .../serialization/MultisigTransactionV1.html | 112 ++++++++++ .../reference/serialization/NamespaceId.html | 22 ++ .../NamespaceRegistrationTransactionV1.html | 130 +++++++++++ .../reference/serialization/NetworkType.html | 16 ++ ...VerifiableAccountKeyLinkTransactionV1.html | 94 ++++++++ .../NonVerifiableCosignatureV1.html | 106 +++++++++ ...rifiableMosaicDefinitionTransactionV1.html | 106 +++++++++ ...fiableMosaicSupplyChangeTransactionV1.html | 100 +++++++++ ...tisigAccountModificationTransactionV1.html | 88 ++++++++ ...tisigAccountModificationTransactionV2.html | 100 +++++++++ .../NonVerifiableMultisigTransactionV1.html | 88 ++++++++ ...bleNamespaceRegistrationTransactionV1.html | 118 ++++++++++ .../NonVerifiableTransaction.html | 63 ++++++ .../NonVerifiableTransferTransactionV1.html | 106 +++++++++ .../NonVerifiableTransferTransactionV2.html | 118 ++++++++++ .../SizePrefixedCosignatureV1.html | 22 ++ .../serialization/SizePrefixedMosaic.html | 22 ++ .../SizePrefixedMosaicProperty.html | 22 ++ ...zePrefixedMultisigAccountModification.html | 22 ++ .../reference/serialization/Transaction.html | 75 +++++++ .../serialization/TransactionType.html | 34 +++ .../serialization/TransferTransactionV1.html | 118 ++++++++++ .../serialization/TransferTransactionV2.html | 130 +++++++++++ 46 files changed, 3196 insertions(+), 1 deletion(-) create mode 100644 mkdocs/snippets/devbook/reference/serialization/AccountKeyLinkTransactionV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/Block.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/BlockType.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/CosignatureV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/CosignatureV1Body.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/LinkAction.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/Message.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/MessageType.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/Mosaic.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/MosaicDefinition.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/MosaicDefinitionTransactionV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/MosaicId.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/MosaicLevy.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/MosaicProperty.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/MosaicSupplyChangeAction.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/MosaicSupplyChangeTransactionV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/MosaicTransferFeeType.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/MultisigAccountModification.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/MultisigAccountModificationTransactionV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/MultisigAccountModificationTransactionV2.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/MultisigAccountModificationType.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/MultisigTransactionV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/NamespaceId.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/NamespaceRegistrationTransactionV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/NetworkType.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/NonVerifiableAccountKeyLinkTransactionV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/NonVerifiableCosignatureV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/NonVerifiableMosaicDefinitionTransactionV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/NonVerifiableMosaicSupplyChangeTransactionV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/NonVerifiableMultisigAccountModificationTransactionV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/NonVerifiableMultisigAccountModificationTransactionV2.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/NonVerifiableMultisigTransactionV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/NonVerifiableNamespaceRegistrationTransactionV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/NonVerifiableTransaction.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/NonVerifiableTransferTransactionV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/NonVerifiableTransferTransactionV2.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/SizePrefixedCosignatureV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/SizePrefixedMosaic.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/SizePrefixedMosaicProperty.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/SizePrefixedMultisigAccountModification.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/Transaction.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/TransactionType.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/TransferTransactionV1.html create mode 100644 mkdocs/snippets/devbook/reference/serialization/TransferTransactionV2.html diff --git a/mkdocs/config/mkdocs.base.yml b/mkdocs/config/mkdocs.base.yml index 2d09b3ec7..f136d069b 100644 --- a/mkdocs/config/mkdocs.base.yml +++ b/mkdocs/config/mkdocs.base.yml @@ -72,7 +72,7 @@ markdown_extensions: line_spans: __span pymdownx.inlinehilite: {} pymdownx.snippets: - base_path: !relative $config_dir/../overrides + base_path: !relative $config_dir/../snippets check_paths: true pymdownx.superfences: {} pymdownx.tabbed: diff --git a/mkdocs/pages/en/devbook/reference/serialization/index.md b/mkdocs/pages/en/devbook/reference/serialization/index.md index ee2bb4eb9..7d855c579 100644 --- a/mkdocs/pages/en/devbook/reference/serialization/index.md +++ b/mkdocs/pages/en/devbook/reference/serialization/index.md @@ -5,6 +5,212 @@ hide: # Serialization +## Basic Types + +
+
Amount
+
8 ubytes
+

A quantity of mosaics in absolute units. It can only be positive or zero.

+
Height
+
8 ubytes
+

Index of a block in the blockchain. The first block (the Nemesis block) has height 1 and each subsequent block increases height by 1.

+
Timestamp
+
4 ubytes
+

Number of seconds elapsed since the creation of the Nemesis block.

+
Address
+
40 ubytes
+

An address identifies an account and is derived from its PublicKey. The 40 bytes correspond to its Base32-encoded form.

+
Hash256
+
32 ubytes
+

A 32-byte (256 bit) hash. The exact algorithm is unspecified as it can change depending on where it is used.

+
PublicKey
+
32 ubytes
+

A 32-byte (256 bit) integer derived from a private key. It serves as the public identifier of the key pair and can be disseminated widely. It is used to prove that an entity was signed with the paired private key.

+
Signature
+
64 ubytes
+

A 64-byte (512 bit) array certifying that the signed data has not been modified. NEM uses Ed25519 signatures with the Keccak-512 hash function.

+
+ +## Enumerations + + + +--8<-- 'devbook/reference/serialization/NetworkType.html' + + + +--8<-- 'devbook/reference/serialization/TransactionType.html' + + + +--8<-- 'devbook/reference/serialization/LinkAction.html' + + + +--8<-- 'devbook/reference/serialization/MosaicTransferFeeType.html' + + + +--8<-- 'devbook/reference/serialization/MosaicSupplyChangeAction.html' + + + +--8<-- 'devbook/reference/serialization/MultisigAccountModificationType.html' + + + +--8<-- 'devbook/reference/serialization/MessageType.html' + + + +--8<-- 'devbook/reference/serialization/BlockType.html' + +## Structures + + + +--8<-- 'devbook/reference/serialization/Transaction.html' + + + +--8<-- 'devbook/reference/serialization/NonVerifiableTransaction.html' + + + +--8<-- 'devbook/reference/serialization/AccountKeyLinkTransactionV1.html' + + + +--8<-- 'devbook/reference/serialization/NonVerifiableAccountKeyLinkTransactionV1.html' + + + +--8<-- 'devbook/reference/serialization/NamespaceId.html' + + + +--8<-- 'devbook/reference/serialization/MosaicId.html' + + + +--8<-- 'devbook/reference/serialization/Mosaic.html' + + + +--8<-- 'devbook/reference/serialization/SizePrefixedMosaic.html' + + + +--8<-- 'devbook/reference/serialization/MosaicLevy.html' + + + +--8<-- 'devbook/reference/serialization/MosaicProperty.html' + + + +--8<-- 'devbook/reference/serialization/SizePrefixedMosaicProperty.html' + + + +--8<-- 'devbook/reference/serialization/MosaicDefinition.html' + + + +--8<-- 'devbook/reference/serialization/MosaicDefinitionTransactionV1.html' + + + +--8<-- 'devbook/reference/serialization/NonVerifiableMosaicDefinitionTransactionV1.html' + + + +--8<-- 'devbook/reference/serialization/MosaicSupplyChangeTransactionV1.html' + + + +--8<-- 'devbook/reference/serialization/NonVerifiableMosaicSupplyChangeTransactionV1.html' + + + +--8<-- 'devbook/reference/serialization/MultisigAccountModification.html' + + + +--8<-- 'devbook/reference/serialization/SizePrefixedMultisigAccountModification.html' + + + +--8<-- 'devbook/reference/serialization/MultisigAccountModificationTransactionV1.html' + + + +--8<-- 'devbook/reference/serialization/NonVerifiableMultisigAccountModificationTransactionV1.html' + + + +--8<-- 'devbook/reference/serialization/MultisigAccountModificationTransactionV2.html' + + + +--8<-- 'devbook/reference/serialization/NonVerifiableMultisigAccountModificationTransactionV2.html' + + + +--8<-- 'devbook/reference/serialization/CosignatureV1Body.html' + + + +--8<-- 'devbook/reference/serialization/CosignatureV1.html' + + + +--8<-- 'devbook/reference/serialization/NonVerifiableCosignatureV1.html' + + + +--8<-- 'devbook/reference/serialization/SizePrefixedCosignatureV1.html' + + + +--8<-- 'devbook/reference/serialization/MultisigTransactionV1.html' + + + +--8<-- 'devbook/reference/serialization/NonVerifiableMultisigTransactionV1.html' + + + +--8<-- 'devbook/reference/serialization/NamespaceRegistrationTransactionV1.html' + + + +--8<-- 'devbook/reference/serialization/NonVerifiableNamespaceRegistrationTransactionV1.html' + + + +--8<-- 'devbook/reference/serialization/Message.html' + + + +--8<-- 'devbook/reference/serialization/TransferTransactionV1.html' + + + +--8<-- 'devbook/reference/serialization/NonVerifiableTransferTransactionV1.html' + + + +--8<-- 'devbook/reference/serialization/TransferTransactionV2.html' + + + +--8<-- 'devbook/reference/serialization/NonVerifiableTransferTransactionV2.html' + + + +--8<-- 'devbook/reference/serialization/Block.html' +