Skip to content

[mkdocs] docs: add serialization reference #869

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
segfaultxavi merged 1 commit into from
May 27, 2026
Merged

[mkdocs] docs: add serialization reference #869

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion mkdocs/config/mkdocs.base.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
207 changes: 207 additions & 0 deletions mkdocs/pages/en/devbook/reference/serialization/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,212 @@ hide:

# Serialization

## Basic Types

<div class="big-table3">
<div id="amount"><b>Amount</b></div>
<div>8&nbsp;ubytes</div>
<div class="description"><p>A quantity of mosaics in absolute units. It can only be positive or zero. </p></div>
<div id="height"><b>Height</b></div>
<div>8&nbsp;ubytes</div>
<div class="description"><p>Index of a block in the blockchain. The first block (the Nemesis block) has height 1 and each subsequent block increases height by 1. </p></div>
<div id="timestamp"><b>Timestamp</b></div>
<div>4&nbsp;ubytes</div>
<div class="description"><p>Number of seconds elapsed since the creation of the Nemesis block. </p></div>
<div id="address"><b>Address</b></div>
<div>40&nbsp;ubytes</div>
<div class="description"><p>An address identifies an account and is derived from its <a href="#publickey" title="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.">PublicKey</a>. The 40 bytes correspond to its Base32-encoded form. </p></div>
<div id="hash256"><b>Hash256</b></div>
<div>32&nbsp;ubytes</div>
<div class="description"><p>A 32-byte (256 bit) hash. The exact algorithm is unspecified as it can change depending on where it is used. </p></div>
<div id="publickey"><b>PublicKey</b></div>
<div>32&nbsp;ubytes</div>
<div class="description"><p>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. </p></div>
<div id="signature"><b>Signature</b></div>
<div>64&nbsp;ubytes</div>
<div class="description"><p>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. </p></div>
</div>

## Enumerations

<a id="networktype"></a>

--8<-- 'devbook/reference/serialization/NetworkType.html'

<a id="transactiontype"></a>

--8<-- 'devbook/reference/serialization/TransactionType.html'

<a id="linkaction"></a>

--8<-- 'devbook/reference/serialization/LinkAction.html'

<a id="mosaictransferfeetype"></a>

--8<-- 'devbook/reference/serialization/MosaicTransferFeeType.html'

<a id="mosaicsupplychangeaction"></a>

--8<-- 'devbook/reference/serialization/MosaicSupplyChangeAction.html'

<a id="multisigaccountmodificationtype"></a>

--8<-- 'devbook/reference/serialization/MultisigAccountModificationType.html'

<a id="messagetype"></a>

--8<-- 'devbook/reference/serialization/MessageType.html'

<a id="blocktype"></a>

--8<-- 'devbook/reference/serialization/BlockType.html'

## Structures

<a id="transaction"></a>

--8<-- 'devbook/reference/serialization/Transaction.html'

<a id="nonverifiabletransaction"></a>

--8<-- 'devbook/reference/serialization/NonVerifiableTransaction.html'

<a id="accountkeylinktransactionv1"></a>

--8<-- 'devbook/reference/serialization/AccountKeyLinkTransactionV1.html'

<a id="nonverifiableaccountkeylinktransactionv1"></a>

--8<-- 'devbook/reference/serialization/NonVerifiableAccountKeyLinkTransactionV1.html'

<a id="namespaceid"></a>

--8<-- 'devbook/reference/serialization/NamespaceId.html'

<a id="mosaicid"></a>

--8<-- 'devbook/reference/serialization/MosaicId.html'

<a id="mosaic"></a>

--8<-- 'devbook/reference/serialization/Mosaic.html'

<a id="sizeprefixedmosaic"></a>

--8<-- 'devbook/reference/serialization/SizePrefixedMosaic.html'

<a id="mosaiclevy"></a>

--8<-- 'devbook/reference/serialization/MosaicLevy.html'

<a id="mosaicproperty"></a>

--8<-- 'devbook/reference/serialization/MosaicProperty.html'

<a id="sizeprefixedmosaicproperty"></a>

--8<-- 'devbook/reference/serialization/SizePrefixedMosaicProperty.html'

<a id="mosaicdefinition"></a>

--8<-- 'devbook/reference/serialization/MosaicDefinition.html'

<a id="mosaicdefinitiontransactionv1"></a>

--8<-- 'devbook/reference/serialization/MosaicDefinitionTransactionV1.html'

<a id="nonverifiablemosaicdefinitiontransactionv1"></a>

--8<-- 'devbook/reference/serialization/NonVerifiableMosaicDefinitionTransactionV1.html'

<a id="mosaicsupplychangetransactionv1"></a>

--8<-- 'devbook/reference/serialization/MosaicSupplyChangeTransactionV1.html'

<a id="nonverifiablemosaicsupplychangetransactionv1"></a>

--8<-- 'devbook/reference/serialization/NonVerifiableMosaicSupplyChangeTransactionV1.html'

<a id="multisigaccountmodification"></a>

--8<-- 'devbook/reference/serialization/MultisigAccountModification.html'

<a id="sizeprefixedmultisigaccountmodification"></a>

--8<-- 'devbook/reference/serialization/SizePrefixedMultisigAccountModification.html'

<a id="multisigaccountmodificationtransactionv1"></a>

--8<-- 'devbook/reference/serialization/MultisigAccountModificationTransactionV1.html'

<a id="nonverifiablemultisigaccountmodificationtransactionv1"></a>

--8<-- 'devbook/reference/serialization/NonVerifiableMultisigAccountModificationTransactionV1.html'

<a id="multisigaccountmodificationtransactionv2"></a>

--8<-- 'devbook/reference/serialization/MultisigAccountModificationTransactionV2.html'

<a id="nonverifiablemultisigaccountmodificationtransactionv2"></a>

--8<-- 'devbook/reference/serialization/NonVerifiableMultisigAccountModificationTransactionV2.html'

<a id="cosignaturev1body"></a>

--8<-- 'devbook/reference/serialization/CosignatureV1Body.html'

<a id="cosignaturev1"></a>

--8<-- 'devbook/reference/serialization/CosignatureV1.html'

<a id="nonverifiablecosignaturev1"></a>

--8<-- 'devbook/reference/serialization/NonVerifiableCosignatureV1.html'

<a id="sizeprefixedcosignaturev1"></a>

--8<-- 'devbook/reference/serialization/SizePrefixedCosignatureV1.html'

<a id="multisigtransactionv1"></a>

--8<-- 'devbook/reference/serialization/MultisigTransactionV1.html'

<a id="nonverifiablemultisigtransactionv1"></a>

--8<-- 'devbook/reference/serialization/NonVerifiableMultisigTransactionV1.html'

<a id="namespaceregistrationtransactionv1"></a>

--8<-- 'devbook/reference/serialization/NamespaceRegistrationTransactionV1.html'

<a id="nonverifiablenamespaceregistrationtransactionv1"></a>

--8<-- 'devbook/reference/serialization/NonVerifiableNamespaceRegistrationTransactionV1.html'

<a id="message"></a>

--8<-- 'devbook/reference/serialization/Message.html'

<a id="transfertransactionv1"></a>

--8<-- 'devbook/reference/serialization/TransferTransactionV1.html'

<a id="nonverifiabletransfertransactionv1"></a>

--8<-- 'devbook/reference/serialization/NonVerifiableTransferTransactionV1.html'

<a id="transfertransactionv2"></a>

--8<-- 'devbook/reference/serialization/TransferTransactionV2.html'

<a id="nonverifiabletransfertransactionv2"></a>

--8<-- 'devbook/reference/serialization/NonVerifiableTransferTransactionV2.html'

<a id="block"></a>

--8<-- 'devbook/reference/serialization/Block.html'

Comment thread
segfaultxavi marked this conversation as resolved.
<style>
.md-typeset h3 {
background: var(--md-accent-fg-color--light);
Expand Down Expand Up @@ -58,6 +264,7 @@ hide:
}

.md-typeset table:not([class]) {
background: transparent;
border: none;
}
.md-typeset table:not([class]) td {
Expand Down
106 changes: 106 additions & 0 deletions mkdocs/snippets/devbook/reference/serialization/AccountKeyLinkTransactionV1.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
<table style="width: 100%;"><tr><td>
<div class="side-info"><table>
<tr><td class="side-info-icon">&varr;</td><td>Size: 173 bytes = 0xad</td></tr>
<tr><td class="side-info-icon"><i class="fab fa-github"></i></td><td><a href="https://github.com/symbol/symbol/blob/main/catbuffer/schemas/nem/account_key_link/account_key_link.cats#L25">schema</a></td></tr>
</table></div>
<dl markdown><dt><code>ser:AccountKeyLinkTransactionV1</code></dt><dd>binary layout for an account key link transaction (V1, latest) </dd></dl>
</td></tr></table>

<div class="big-table6">
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><code class="docutils literal">type</code></div>
<div><a href="#transactiontype" title="enumeration of transaction types">TransactionType</a></div>
<div class="description"><p>transaction type </p></div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><code class="docutils literal">version</code></div>
<div>byte[1]</div>
<div class="description"><p>entity version </p></div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><code class="docutils literal">entity_body_reserved_1</code></div>
<div>byte[2]</div>
<div class="description"><b>reserved</b> <code class="docutils literal">0</code><br/><p>reserved padding between version and network type </p></div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><code class="docutils literal">network</code></div>
<div><a href="#networktype" title="enumeration of network types">NetworkType</a></div>
<div class="description"><p>entity network </p></div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><code class="docutils literal">timestamp</code></div>
<div><a href="#timestamp" title="">Timestamp</a></div>
<div class="description"><p>entity timestamp </p></div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><code class="docutils literal">signer_public_key_size</code></div>
<div>byte[4]</div>
<div class="description"><b>reserved</b> <code class="docutils literal">32</code><br/><p>entity signer public key size </p></div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><code class="docutils literal">signer_public_key</code></div>
<div><a href="#publickey" title="">PublicKey</a></div>
<div class="description"><p>entity signer public key </p></div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><code class="docutils literal">signature_size</code></div>
<div>byte[4]</div>
<div class="description"><b>reserved</b> <code class="docutils literal">64</code><br/><p>entity signature size </p></div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><code class="docutils literal">signature</code></div>
<div><a href="#signature" title="">Signature</a></div>
<div class="description"><p>entity signature </p></div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><code class="docutils literal">fee</code></div>
<div><a href="#amount" title="">Amount</a></div>
<div class="description"><p>transaction fee </p></div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><code class="docutils literal">deadline</code></div>
<div><a href="#timestamp" title="">Timestamp</a></div>
<div class="description"><p>transaction deadline </p></div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><code class="docutils literal">TRANSACTION_VERSION</code></div>
<div>byte[1]</div>
<div class="description"><b>const</b> <code class="docutils literal">1</code><br/></div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><code class="docutils literal">TRANSACTION_TYPE</code></div>
<div><a href="#transactiontype" title="enumeration of transaction types">TransactionType</a></div>
<div class="description"><b>const</b> <code class="docutils literal">ACCOUNT_KEY_LINK</code> (<code class="docutils literal">0x801</code>)<br/></div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><code class="docutils literal">link_action</code></div>
<div><a href="#linkaction" title="enumeration of link actions">LinkAction</a></div>
<div class="description"><p>link action </p></div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><code class="docutils literal">remote_public_key_size</code></div>
<div>byte[4]</div>
<div class="description"><b>reserved</b> <code class="docutils literal">32</code><br/><p>remote account public key size </p></div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div>&nbsp;</div>
<div><code class="docutils literal">remote_public_key</code></div>
<div><a href="#publickey" title="">PublicKey</a></div>
<div class="description"><p>public key of remote account to which importance should be transferred </p></div>
</div>
Loading