diff --git a/_symbol b/_symbol index 7f5dbd3fc..ce545a6f9 160000 --- a/_symbol +++ b/_symbol @@ -1 +1 @@ -Subproject commit 7f5dbd3fc5be2edf633e08a8798252dd07d9712f +Subproject commit ce545a6f9faa8fa0fcac1fc9b7abca784e7bd353 diff --git a/scripts/ci/build.sh b/scripts/ci/build.sh index 662247450..9e0ac9a40 100755 --- a/scripts/ci/build.sh +++ b/scripts/ci/build.sh @@ -3,3 +3,10 @@ set -ex make gettext + +echo "Building docs..." +make alldocs + +echo "Linking Check..." +make linkcheck + diff --git a/scripts/ci/deploy.sh b/scripts/ci/deploy.sh index 2221694b2..cce10274b 100755 --- a/scripts/ci/deploy.sh +++ b/scripts/ci/deploy.sh @@ -2,12 +2,6 @@ set -ex -echo "Building docs..." -make alldocs - -echo "Linking Check..." -make linkcheck - echo "Publishing..." git remote add github "https://${GITHUB_ACCESS_TOKEN}@github.com/symbol/symbol-docs.git" > /dev/null 2>&1 diff --git a/source/compatibility.rst b/source/compatibility.rst index fc1e61034..6eba6a687 100644 --- a/source/compatibility.rst +++ b/source/compatibility.rst @@ -12,20 +12,20 @@ APIs :header: "Milestone", "OpenAPI", "Rest", "SDK TS", "SDK Java" :delim: ; - `v1.0.1.0 `_; v1.0.0; v2.3.6; v1.0.1; v1.0.1 - `v1.0.0.0 `_; v1.0.0; v2.3.5; v1.0.0; v1.0.0 - `v0.10.0.7 `_; v0.11.2; v2.3.3; v0.23.2; v0.23.1 - `v0.10.0.6 `_; v0.11.2; v2.3.2; v0.23.1; v0.23.1 - `v0.10.0.5 `_; v0.11.1; v2.3.0; v0.23.0; v0.23.0 - `v0.10.0.4 `_; v0.10.5; v2.2.0; v0.22.2; v0.22.2 - `v0.10.0.3 `_; v0.10.0; v2.1.0; v0.21.0; v0.21.0 - `v0.9.6.4 `_; v0.9.6; v1.2.1; v0.20.7; v0.20.3 - `v0.9.6.3 `_; v0.9.4; v1.1.3; v0.20.6; v0.20.2 - `v0.9.5.1 `_; v0.8.11; v1.0.20.50; v0.19.2; v0.19.0 - `v0.9.4.1 `_; v0.8.11; v1.0.20.31; v0.18.0; v0.17.2 + `v1.0.1.0 `_; v1.0.0; v2.3.6; v1.0.1; v1.0.1 + `v1.0.0.0 `_; v1.0.0; v2.3.5; v1.0.0; v1.0.0 + `v0.10.0.7 `_; v0.11.2; v2.3.3; v0.23.2; v0.23.1 + `v0.10.0.6 `_; v0.11.2; v2.3.2; v0.23.1; v0.23.1 + `v0.10.0.5 `_; v0.11.1; v2.3.0; v0.23.0; v0.23.0 + `v0.10.0.4 `_; v0.10.5; v2.2.0; v0.22.2; v0.22.2 + `v0.10.0.3 `_; v0.10.0; v2.1.0; v0.21.0; v0.21.0 + `v0.9.6.4 `_; v0.9.6; v1.2.1; v0.20.7; v0.20.3 + `v0.9.6.3 `_; v0.9.4; v1.1.3; v0.20.6; v0.20.2 + `v0.9.5.1 `_; v0.8.11; v1.0.20.50; v0.19.2; v0.19.0 + `v0.9.4.1 `_; v0.8.11; v1.0.20.31; v0.18.0; v0.17.2 - `OpenAPI CHANGELOG `_ -- `REST CHANGELOG `_ +- `REST CHANGELOG `_ - `SDK TS CHANGELOG `_ - `SDK Java CHANGELOG `_ @@ -51,4 +51,4 @@ Tools - `Desktop Wallet CHANGELOG `_ - `symbol-cli CHANGELOG `_ -- `symbol-bootstrap CHANGELOG `_ +- `symbol-bootstrap CHANGELOG `_ diff --git a/source/concepts/inflation.rst b/source/concepts/inflation.rst index 5eaa1500f..82f8f1aa1 100644 --- a/source/concepts/inflation.rst +++ b/source/concepts/inflation.rst @@ -32,7 +32,7 @@ The previous configuration example inflates 500 currency mosaics per block from Between the blocks 100 and 1250, the currency mosaic supply increases by 400 units per block. Starting at height 1250, new blocks will not trigger the creation of mosaics. -The `network configuration `_ also describes the initial and **maximum supply** of the native currency mosaic. The maximum supply takes into account the inflation generated per-block. +The `network configuration `_ also describes the initial and **maximum supply** of the native currency mosaic. The maximum supply takes into account the inflation generated per-block. .. code-block:: bash diff --git a/source/concepts/transaction.rst b/source/concepts/transaction.rst index d77335a2a..43706ab9f 100644 --- a/source/concepts/transaction.rst +++ b/source/concepts/transaction.rst @@ -36,7 +36,7 @@ All transactions should define a deadline and a max_fee: * ``max_fee``: The maximum amount of network currency that the sender of the transaction is willing to pay to get the transaction accepted. :doc:`The next documentation ` shows you how to set the optimal max_fee value. -.. note:: The `catbuffer schemas `_ repository defines how each transaction type should be serialized. In combination with the `catbuffer-generators `_ project, developers can generate builder classes for a given set of programming languages. +.. note:: The `catbuffer schemas `_ repository defines how each transaction type should be serialized. In combination with the catbuffer generators, developers can generate builder classes for a given set of programming languages. We recommend using the :doc:`SDK <../sdk>` to define new transactions. diff --git a/source/conf.py b/source/conf.py index b04b126a9..13a4a1fd5 100644 --- a/source/conf.py +++ b/source/conf.py @@ -290,7 +290,7 @@ def setup(app): .. |symbol-bootstrap| raw:: html - Symbol Bootstrap + Symbol Bootstrap .. |techref| raw:: html @@ -352,8 +352,6 @@ def setup(app): r'/_static/.*', # Ignore things we put there manually, linkcheck does not know they will be deployed r'/guides/.*', # Mysterious autogenerated page, not available at linkcheck time r'https://hackmd.io/.*', # You need to login to access some of the pages - r'https://arxiv.org/.*', # Sometimes returns 403 on Travis (rate limit?) - r'https://www.researchgate.net/.*', # Started returning 403 on Travis ] linkcheck_anchors_ignore = [r'L\d+'] @@ -375,8 +373,8 @@ def viewsource_resolve_link(file_path, language=None): # -- Custom extlinks ----------------------------------------------------- -extlinks = {'schema': ('https://github.com/symbol/catbuffer-schemas/blob/main/symbol/%s', 'file '), - 'properties': ('https://github.com/symbol/catapult-client/blob/main/resources/%s', 'file ')} +extlinks = {'schema': ('https://github.com/symbol/blob/main/catbuffer/schemas/symbol/%s', 'file '), + 'properties': ('https://github.com/symbol/symbol/blob/main/client/catapult/resources/%s', 'file ')} # -- Custom Pygments lexers ---------------------------------------------- @@ -421,4 +419,6 @@ class BootstrapLexer(BashLexer): ] } -lexers['symbol-bootstrap'] = BootstrapLexer() \ No newline at end of file +lexers['symbol-bootstrap'] = BootstrapLexer() + +user_agent = 'Mozilla/5.0 (X11; Linux x86_64; rv:25.0) Gecko/20100101 Firefox/25.0' \ No newline at end of file diff --git a/source/contribute/index.rst b/source/contribute/index.rst index e8810c63c..02ded6907 100644 --- a/source/contribute/index.rst +++ b/source/contribute/index.rst @@ -11,7 +11,7 @@ There are plenty of things you can do to help improve |codename|! |codename| is **Open Source**. Visit the |github| repositories and check if there is any project where you want to contribute. -There is the C++ `Catapult client `__ but also Typescript tools like the `Wallets `__, the `Explorer `__, `Bootstrap `__ and many more. Each repository's ``README`` and ``CONTRIBUTING`` files will tell you how to submit your code! +There is the C++ `Catapult client `__ but also Typescript tools like the `Wallets `__, the `Explorer `__, `Bootstrap `__ and many more. Each repository's ``README`` and ``CONTRIBUTING`` files will tell you how to submit your code! πŸ‘¨β€πŸ« Can you write? ******************** diff --git a/source/guidelines/generating-transaction-builders.rst b/source/guidelines/generating-transaction-builders.rst index 3ba7b5716..0bac93f68 100644 --- a/source/guidelines/generating-transaction-builders.rst +++ b/source/guidelines/generating-transaction-builders.rst @@ -8,7 +8,7 @@ Learn how to generate transaction builders for your target SDK language. Background ********** -The `catbuffer library `_ defines the protocol to serialize and deserialize |codename| entities. +The `catbuffer library `_ defines the protocol to serialize and deserialize |codename| entities. The library comes with code generators for different languages. SDKs and applications use the generated code to interact with REST transaction endpoint. @@ -37,7 +37,7 @@ These endpoints allow the addition of new functionality to the client-side witho Applications can embed the generated code without managing dependencies, which is particularly desirable in highly-secure environments. Besides, sharing a common codebase enables the addition of new features with less effort. -The `schemas `_ define the entities' data structure. +The `schemas `_ define the entities' data structure. The library generates the leanest code necessary to serialize and deserialize defined entities. ************ @@ -60,7 +60,7 @@ Installation .. code-block:: bash - git clone https://github.com/symbol/catbuffer-schemas + git clone https://github.com/symbol/symbol/tree/main/catbuffer/schemas ***** Usage diff --git a/source/guidelines/sdk-development.rst b/source/guidelines/sdk-development.rst index 94f82bd23..8b5787ba7 100644 --- a/source/guidelines/sdk-development.rst +++ b/source/guidelines/sdk-development.rst @@ -167,12 +167,12 @@ Particular decisions we considered: Transaction Serialization ========================= -The `catbuffer-schemas library `_ defines the protocol to serialize and deserialize |codename| entities. +The `catbuffer-schemas library `_ defines the protocol to serialize and deserialize |codename| entities. -In combination with the `catbuffer-generators project `_, developers can generate builder classes for a given set of programming languages. +In combination with the catbuffer generators project, developers can generate builder classes for a given set of programming languages. For example, the |sdk| uses the generated code to operate with the entities in binary form. -.. note:: If there is no generator for the programming language selected, you will need to develop it first. You can base your work on the `generator `_ for TypeScript. +.. note:: If there is no generator for the programming language selected, you will need to develop it first. You can base your work on the `generator `_ for TypeScript. If there is a generator, follow the next steps to generate the builders for all the existent entities: diff --git a/source/guidelines/writing-a-schema.rst b/source/guidelines/writing-a-schema.rst index 7dabf4259..90174c15f 100644 --- a/source/guidelines/writing-a-schema.rst +++ b/source/guidelines/writing-a-schema.rst @@ -4,7 +4,7 @@ Writing a Schema Are you writing a new catapult plugin that includes a new transaction type? -In this guide, we examine how the `transfer.cats `_ was constructed. +In this guide, we examine how the `transfer.cats `_ was constructed. You can adapt the same steps to define a new schema. ************ @@ -15,16 +15,16 @@ Instructions .. code-block:: bash - git clone https://github.com/symbol/catbuffer-schemas.git + git clone https://github.com/symbol/symbol.git -2. Create a new file under the ``schemas`` folder. In our case, we have named the file ``transfer.cats``. +2. Create a new file under the ``catbuffer/schemas`` folder. In our case, we have named the file ``transfer.cats``. 3. Define the struct for the transaction body. Think of a struct as a set of properties that we want to store in the same block of memory. The transaction body contains the extra properties which differ from a basic transaction. - Each attribute can have one of the types defined in `types.cats `_. + Each attribute can have one of the types defined in `types.cats `_. .. code-block:: python diff --git a/source/guides/harvesting/activating-remote-harvesting.rst b/source/guides/harvesting/activating-remote-harvesting.rst index 443bd0029..78db5b133 100644 --- a/source/guides/harvesting/activating-remote-harvesting.rst +++ b/source/guides/harvesting/activating-remote-harvesting.rst @@ -41,9 +41,9 @@ To clarify, |symbol-bootstrap| automatically creates a remote account (labelled Manual activation ***************** -If you have deployed a node yourself, for example by following `the catapult-client instructions `__, then you have to **enable harvesting manually**. +If you have deployed a node yourself, for example by following `the catapult-client instructions `__, then you have to **enable harvesting manually**. -The `catapult-client documentation `__ explains how to enable :ref:`local harvesting `, which stores your main account's private key on the client. This section explains how to enable :ref:`remote harvesting ` instead, which uses a proxy account and is therefore **much more secure**. +The `catapult-client documentation `__ explains how to enable :ref:`local harvesting `, which stores your main account's private key on the client. This section explains how to enable :ref:`remote harvesting ` instead, which uses a proxy account and is therefore **much more secure**. This will be done using the :doc:`symbol-cli ` tool. The required steps are: @@ -74,7 +74,7 @@ Run this from a terminal: Note the **public** and **private** keys for this new account. -Now edit the ``config-harvesting.properties`` file (it should be in a ``resources`` directory if you followed `the catapult-client instructions `__). Look for the ``harvesterSigningPrivateKey`` field and write the remote account's private key. +Now edit the ``config-harvesting.properties`` file (it should be in a ``resources`` directory if you followed `the catapult-client instructions `__). Look for the ``harvesterSigningPrivateKey`` field and write the remote account's private key. Step 2: Link the remote and main accounts ========================================= diff --git a/source/guides/migration/migrating-from-nem-to-symbol.rst b/source/guides/migration/migrating-from-nem-to-symbol.rst index c4aa5ad09..2e7f68403 100644 --- a/source/guides/migration/migrating-from-nem-to-symbol.rst +++ b/source/guides/migration/migrating-from-nem-to-symbol.rst @@ -201,7 +201,7 @@ Then, the minimum number of cosignatories defined in the multisignature will hav .. |catapult-schemas| raw:: html - Serialization schemas + Serialization schemas .. |stack-overflow| raw:: html diff --git a/source/guides/network/maintaining-a-symbol-node.rst b/source/guides/network/maintaining-a-symbol-node.rst index f1a0b6268..73ed908cf 100644 --- a/source/guides/network/maintaining-a-symbol-node.rst +++ b/source/guides/network/maintaining-a-symbol-node.rst @@ -103,7 +103,7 @@ If you followed the :doc:`running-a-symbol-node-manually` guide, you need to reb In summary, you need to: - Stop the running Catapult client with ``Ctrl+C``. -- Update the Catapult client source repository with the latest version and build it again following the `Catapult client `__ instructions. +- Update the Catapult client source repository with the latest version and build it again following the `Catapult client `__ instructions. - Restart the client from the same folder it was initially launched. Data and configuration files will be reused. .. note:: diff --git a/source/guides/network/running-a-secure-symbol-node.rst b/source/guides/network/running-a-secure-symbol-node.rst index 1be6cf4a5..cb5684d33 100644 --- a/source/guides/network/running-a-secure-symbol-node.rst +++ b/source/guides/network/running-a-secure-symbol-node.rst @@ -134,7 +134,7 @@ Preset - mainPrivateKey: ●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●●● -You can read more about these properties in the `security mode section `__ in Symbol Bootstrap's documentation. +You can read more about these properties in the `security mode section `__ in Symbol Bootstrap's documentation. If you have customizations to make, like enabling :ref:`voting `, you can provide them too: diff --git a/source/guides/network/running-a-symbol-node-manually.rst b/source/guides/network/running-a-symbol-node-manually.rst index ba8a0f63c..835c22f94 100644 --- a/source/guides/network/running-a-symbol-node-manually.rst +++ b/source/guides/network/running-a-symbol-node-manually.rst @@ -22,7 +22,7 @@ Build a Peer node Build the client ================ -Follow the `Catapult client `__ instructions to **build** its binaries, either `manually `__ or using `Conan `__. +Follow the `Catapult client `__ instructions to **build** its binaries, either `manually `__ or using `Conan `__. Generate keys ============= @@ -120,7 +120,7 @@ Configuration |codename| is **highly customizable** and this means there are a lot of parameters that can be adjusted to suit your node's needs. Some of these parameters are **network-related** and must match the rest of nodes in the network (for example ``currencyMosaicId``) whereas some others are **node-related** and you can set freely (for example ``friendlyName``). -You can edit these files manually (Take a look at `these templates `__ to know how they look) but it is more convenient to use the `Symbol Node Configurator tool `__ as shown next. +You can edit these files manually (Take a look at `these templates `__ to know how they look) but it is more convenient to use the `Symbol Node Configurator tool `__ as shown next. **The Configuration step can be performed on an offline machine for added security.** @@ -408,7 +408,7 @@ Run the database 3. **Build indices** to optimize database accesses. - The ``catapult-client`` repository you cloned to build the client in the first step contains `a folder with mongo scripts `__. Run this one: + The ``catapult-client`` repository you cloned to build the client in the first step contains `a folder with mongo scripts `__. Run this one: .. code-block:: bash diff --git a/source/guides/network/running-a-symbol-node.rst b/source/guides/network/running-a-symbol-node.rst index cd3b9153b..52dd20a5e 100644 --- a/source/guides/network/running-a-symbol-node.rst +++ b/source/guides/network/running-a-symbol-node.rst @@ -138,7 +138,7 @@ Use the information in the ``main`` section to access the node's account. When a .. topic:: Encrypted private keys - By default Symbol Bootstrap encrypts all private keys in ``addresses.yml`` so they are not visible (see the `security mode section `__ for more details). + By default Symbol Bootstrap encrypts all private keys in ``addresses.yml`` so they are not visible (see the `security mode section `__ for more details). To access the private keys (to **withdraw** funds from the main account, for example) you will need to use the ``symbol-bootstrap decrypt`` command: @@ -230,7 +230,7 @@ Just like in the harvesting case, this creates the required :ref:`votingkeylinkt symbol-bootstrap updateVotingKeys symbol-bootstrap link - The current keys will be examined and if any is close to expiration it will be renewed. If no action is needed the ``link`` command will do nothing, so no transaction fees will be paid (see `Symbol Bootstrap's manual `__ for more information). + The current keys will be examined and if any is close to expiration it will be renewed. If no action is needed the ``link`` command will do nothing, so no transaction fees will be paid (see `Symbol Bootstrap's manual `__ for more information). Therefore, running the above commands once a month guarantees that your voting keys will always be up to date. diff --git a/source/guides/network/using-symbol-bootstrap.rst b/source/guides/network/using-symbol-bootstrap.rst index 710673953..b91009326 100644 --- a/source/guides/network/using-symbol-bootstrap.rst +++ b/source/guides/network/using-symbol-bootstrap.rst @@ -95,9 +95,9 @@ Node configuration is done through a **YAML configuration file** which specifies :delim: ; :widths: 20, 80 - ``mainnet``; A **single node** that connects to the current public **main** network. Nemesis block is copied over. Requires an ``assembly``, as shown below (`configuration file `__). - ``bootstrap``; **Autonomous network** with 1 mongo database, 2 peers, 1 api and 1 rest gateway. Nemesis block is generated (`configuration file `__). This is the default preset. - ``testnet``; A **single node** that connects to the current public **test** network. Nemesis block is copied over. Requires an ``assembly``, as shown below (`configuration file `__). + ``mainnet``; A **single node** that connects to the current public **main** network. Nemesis block is copied over. Requires an ``assembly``, as shown below (`configuration file `__). + ``bootstrap``; **Autonomous network** with 1 mongo database, 2 peers, 1 api and 1 rest gateway. Nemesis block is generated (`configuration file `__). This is the default preset. + ``testnet``; A **single node** that connects to the current public **test** network. Nemesis block is copied over. Requires an ``assembly``, as shown below (`configuration file `__). Presets can be further customized by indicating an **assembly** (or flavor) which provides additional parameters. Specify the assembly with the ``‑‑assembly`` or ``‑a`` parameters. @@ -106,14 +106,12 @@ Presets can be further customized by indicating an **assembly** (or flavor) whic :delim: ; :widths: 20, 20, 60 - ``mainnet``; ``peer``; The node is a :ref:`peer-node` (`configuration file `__). - ``mainnet``; ``api``; The node is an :ref:`api-node` (`configuration file `__). - ``mainnet``; ``dual``; The node is both a :ref:`peer-node` and an :ref:`api-node` (`configuration file `__). - ``bootstrap``; ``light``; It's a **lighter version** of ``bootstrap`` with 1 mongo database, 1 dual peer and 1 rest gateway. Great for faster light e2e automatic testing. Nemesis block is generated (`configuration file `__). - ``bootstrap``; ``full``; It's the default ``bootstrap`` preset plus 1 wallet, 1 explorer and 1 faucet. Great for demonstration purposes. Nemesis block is generated (`configuration file `__). - ``testnet``; ``peer``; The node is a :ref:`peer-node` (`configuration file `__). - ``testnet``; ``api``; The node runs is an :ref:`api-node` (`configuration file `__). - ``testnet``; ``dual``; The node is both a :ref:`peer-node` and an :ref:`api-node` (`configuration file `__). + ``mainnet``; ``peer``; The node is a :ref:`peer-node` (`configuration file `__). + ``mainnet``; ``api``; The node is an :ref:`api-node` (`configuration file `__). + ``mainnet``; ``dual``; The node is both a :ref:`peer-node` and an :ref:`api-node` (`configuration file `__). + ``testnet``; ``peer``; The node is a :ref:`peer-node` (`configuration file `__). + ``testnet``; ``api``; The node runs is an :ref:`api-node` (`configuration file `__). + ``testnet``; ``dual``; The node is both a :ref:`peer-node` and an :ref:`api-node` (`configuration file `__). ============== Custom presets @@ -131,7 +129,7 @@ Specify a custom preset file with the ``‑‑customPreset`` or ``‑c`` paramet The ``config`` command ********************** -Before building the node or network a full configuration file has to be created by using the `symbol-bootstrap config `_ command: +Before building the node or network a full configuration file has to be created by using the `symbol-bootstrap config `_ command: .. code-block:: bash @@ -270,7 +268,7 @@ You need to own the domain ``awesomenode.mycompany.net`` and it needs to resolve Next steps ********** -- Read the `complete list `_ of ``symbol-bootstrap`` commands. +- Read the `complete list `_ of ``symbol-bootstrap`` commands. - Go ahead and create a node following the :doc:`running-a-symbol-node` guide. diff --git a/source/serialization/AccountAddressRestrictionTransaction.html b/source/serialization/AccountAddressRestrictionTransaction.html index f9e586e8f..03a990d1c 100644 --- a/source/serialization/AccountAddressRestrictionTransaction.html +++ b/source/serialization/AccountAddressRestrictionTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 139+ bytes = 0x8b+ (variable)
schema
catapult model
schema
catapult model

Allow or block incoming and outgoing transactions for a given a set of addresses.

diff --git a/source/serialization/AccountAddressRestrictionTransactionBody.html b/source/serialization/AccountAddressRestrictionTransactionBody.html index 8d25f1c3d..a742882be 100644 --- a/source/serialization/AccountAddressRestrictionTransactionBody.html +++ b/source/serialization/AccountAddressRestrictionTransactionBody.html @@ -1,7 +1,7 @@
- +
↕Size: 8+ bytes = 0x8+ (variable)
schema
schema

Shared content between AccountAddressRestrictionTransaction and EmbeddedAccountAddressRestrictionTransaction.

diff --git a/source/serialization/AccountKeyLinkTransaction.html b/source/serialization/AccountKeyLinkTransaction.html index a7b3b6860..9fd1114b6 100644 --- a/source/serialization/AccountKeyLinkTransaction.html +++ b/source/serialization/AccountKeyLinkTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 164 bytes = 0xa4
schema
catapult model
schema
catapult model

This transaction is required for all accounts wanting to activate remote or delegated harvesting.
Announce an AccountKeyLinkTransaction to delegate the account importance score to a proxy account.

diff --git a/source/serialization/AccountKeyLinkTransactionBody.html b/source/serialization/AccountKeyLinkTransactionBody.html index a0421599b..27c6d98f4 100644 --- a/source/serialization/AccountKeyLinkTransactionBody.html +++ b/source/serialization/AccountKeyLinkTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 33 bytes = 0x21
schema
catapult model
schema
catapult model

Shared content between AccountKeyLinkTransactionBody and EmbeddedAccountKeyLinkTransaction.

diff --git a/source/serialization/AccountKeyTypeFlags.html b/source/serialization/AccountKeyTypeFlags.html index 20ed9f243..136c54f37 100644 --- a/source/serialization/AccountKeyTypeFlags.html +++ b/source/serialization/AccountKeyTypeFlags.html @@ -1,7 +1,7 @@
- +
↕Size: 1 byte = 0x1
schema
schema

enumeration of account key type flags

diff --git a/source/serialization/AccountMetadataTransaction.html b/source/serialization/AccountMetadataTransaction.html index ef57c021d..1bfb7abe9 100644 --- a/source/serialization/AccountMetadataTransaction.html +++ b/source/serialization/AccountMetadataTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 167+ bytes = 0xa7+ (variable)
schema
catapult model
schema
catapult model

Associate a key-value state (metadata) to an account.

Note: This transaction must always be wrapped in an AggregateTransaction so that a cosignature from target_address can be provided. Without this cosignature the transaction is invalid.
Compare to MosaicMetadataTransaction and NamespaceMetadataTransaction.

diff --git a/source/serialization/AccountMetadataTransactionBody.html b/source/serialization/AccountMetadataTransactionBody.html index ced433233..eaf464998 100644 --- a/source/serialization/AccountMetadataTransactionBody.html +++ b/source/serialization/AccountMetadataTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 36+ bytes = 0x24+ (variable)
schema
catapult model
schema
catapult model

Shared content between AccountMetadataTransaction and EmbeddedAccountMetadataTransaction.

diff --git a/source/serialization/AccountMosaicRestrictionTransaction.html b/source/serialization/AccountMosaicRestrictionTransaction.html index c1be4e231..cf1eef4d2 100644 --- a/source/serialization/AccountMosaicRestrictionTransaction.html +++ b/source/serialization/AccountMosaicRestrictionTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 139+ bytes = 0x8b+ (variable)
schema
catapult model
schema
catapult model

Allow or block incoming transactions containing a given set of mosaics.

diff --git a/source/serialization/AccountMosaicRestrictionTransactionBody.html b/source/serialization/AccountMosaicRestrictionTransactionBody.html index bef6b7579..c81a5db12 100644 --- a/source/serialization/AccountMosaicRestrictionTransactionBody.html +++ b/source/serialization/AccountMosaicRestrictionTransactionBody.html @@ -1,7 +1,7 @@
- +
↕Size: 8+ bytes = 0x8+ (variable)
schema
schema

Shared content between AccountMosaicRestrictionTransaction and EmbeddedAccountMosaicRestrictionTransaction.

diff --git a/source/serialization/AccountOperationRestrictionTransaction.html b/source/serialization/AccountOperationRestrictionTransaction.html index 8fc9f3a97..912319381 100644 --- a/source/serialization/AccountOperationRestrictionTransaction.html +++ b/source/serialization/AccountOperationRestrictionTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 139+ bytes = 0x8b+ (variable)
schema
catapult model
schema
catapult model

Allow or block outgoing transactions depending on their transaction type.

diff --git a/source/serialization/AccountOperationRestrictionTransactionBody.html b/source/serialization/AccountOperationRestrictionTransactionBody.html index 051e67f99..08a5744e2 100644 --- a/source/serialization/AccountOperationRestrictionTransactionBody.html +++ b/source/serialization/AccountOperationRestrictionTransactionBody.html @@ -1,7 +1,7 @@
- +
↕Size: 8+ bytes = 0x8+ (variable)
schema
schema

Shared content between AccountOperationRestrictionTransaction and EmbeddedAccountOperationRestrictionTransaction.

diff --git a/source/serialization/AccountRestrictionAddressValue.html b/source/serialization/AccountRestrictionAddressValue.html index 849fb3443..291f58c37 100644 --- a/source/serialization/AccountRestrictionAddressValue.html +++ b/source/serialization/AccountRestrictionAddressValue.html @@ -1,7 +1,7 @@
- +
↕Size: 8+ bytes = 0x8+ (variable)
schema
schema

binary layout for address based account restriction

diff --git a/source/serialization/AccountRestrictionFlags.html b/source/serialization/AccountRestrictionFlags.html index ebd67f4a9..d76a9736b 100644 --- a/source/serialization/AccountRestrictionFlags.html +++ b/source/serialization/AccountRestrictionFlags.html @@ -1,8 +1,8 @@
- - + +
↕Size: 2 bytes = 0x2
schema
catapult model
schema
catapult model

Enumeration of account restriction flags.

diff --git a/source/serialization/AccountRestrictionMosaicValue.html b/source/serialization/AccountRestrictionMosaicValue.html index 388570777..522773056 100644 --- a/source/serialization/AccountRestrictionMosaicValue.html +++ b/source/serialization/AccountRestrictionMosaicValue.html @@ -1,7 +1,7 @@
- +
↕Size: 8+ bytes = 0x8+ (variable)
schema
schema

binary layout for mosaic id based account restriction

diff --git a/source/serialization/AccountRestrictionTransactionTypeValue.html b/source/serialization/AccountRestrictionTransactionTypeValue.html index be7619fb0..0ac229de3 100644 --- a/source/serialization/AccountRestrictionTransactionTypeValue.html +++ b/source/serialization/AccountRestrictionTransactionTypeValue.html @@ -1,7 +1,7 @@
- +
↕Size: 8+ bytes = 0x8+ (variable)
schema
schema

binary layout for transaction type based account restriction

diff --git a/source/serialization/AccountRestrictions.html b/source/serialization/AccountRestrictions.html index 38f5b7b17..9a508e450 100644 --- a/source/serialization/AccountRestrictions.html +++ b/source/serialization/AccountRestrictions.html @@ -1,7 +1,7 @@
- +
↕Size: 34+ bytes = 0x22+ (variable)
schema
schema

binary layout for account restrictions

diff --git a/source/serialization/AccountRestrictionsInfo.html b/source/serialization/AccountRestrictionsInfo.html index 1a9e5114b..548699e55 100644 --- a/source/serialization/AccountRestrictionsInfo.html +++ b/source/serialization/AccountRestrictionsInfo.html @@ -1,7 +1,7 @@
- +
↕Size: 26+ bytes = 0x1a+ (variable)
schema
schema

binary layout for account restrictions

diff --git a/source/serialization/AccountState.html b/source/serialization/AccountState.html index 84ebcee25..5746e888d 100644 --- a/source/serialization/AccountState.html +++ b/source/serialization/AccountState.html @@ -1,8 +1,8 @@
- - + +
↕Size: 332+ bytes = 0x14c+ (variable)
schema
catapult model
schema
catapult model

binary layout for non-historical account state

diff --git a/source/serialization/AccountStateFormat.html b/source/serialization/AccountStateFormat.html index c41f49d2b..e5022ba55 100644 --- a/source/serialization/AccountStateFormat.html +++ b/source/serialization/AccountStateFormat.html @@ -1,7 +1,7 @@
- +
↕Size: 1 byte = 0x1
schema
schema

enumeration of account state formats

diff --git a/source/serialization/AccountType.html b/source/serialization/AccountType.html index 87c85d486..7024623ac 100644 --- a/source/serialization/AccountType.html +++ b/source/serialization/AccountType.html @@ -1,8 +1,8 @@
- - + +
↕Size: 1 byte = 0x1
schema
catapult model
schema
catapult model

enumeration of account types

diff --git a/source/serialization/AddressAliasTransaction.html b/source/serialization/AddressAliasTransaction.html index b16f620ef..a9889fa89 100644 --- a/source/serialization/AddressAliasTransaction.html +++ b/source/serialization/AddressAliasTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 164 bytes = 0xa4
schema
catapult model
schema
catapult model

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).

diff --git a/source/serialization/AddressAliasTransactionBody.html b/source/serialization/AddressAliasTransactionBody.html index 74c590f79..def1f2abf 100644 --- a/source/serialization/AddressAliasTransactionBody.html +++ b/source/serialization/AddressAliasTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 33 bytes = 0x21
schema
catapult model
schema
catapult model

Shared content between AddressAliasTransaction and EmbeddedAddressAliasTransaction.

diff --git a/source/serialization/AddressKeyValue.html b/source/serialization/AddressKeyValue.html index 10142d7d3..370c23226 100644 --- a/source/serialization/AddressKeyValue.html +++ b/source/serialization/AddressKeyValue.html @@ -1,7 +1,7 @@
- +
↕Size: 16 bytes = 0x10
schema
schema

layout for mosaic address restriction key-value pair

diff --git a/source/serialization/AddressKeyValueSet.html b/source/serialization/AddressKeyValueSet.html index 28a9aa5c6..23691c385 100644 --- a/source/serialization/AddressKeyValueSet.html +++ b/source/serialization/AddressKeyValueSet.html @@ -1,7 +1,7 @@
- +
↕Size: 1+ byte = 0x1+ (variable)
schema
schema

binary layout for mosaic address restriction key-value set

diff --git a/source/serialization/AddressResolutionEntry.html b/source/serialization/AddressResolutionEntry.html index 41eabee2f..050594dd2 100644 --- a/source/serialization/AddressResolutionEntry.html +++ b/source/serialization/AddressResolutionEntry.html @@ -1,7 +1,7 @@
- +
↕Size: 32 bytes = 0x20
schema
schema

Actual Address behind a NamespaceId at the time a transaction was confirmed.

diff --git a/source/serialization/AddressResolutionStatement.html b/source/serialization/AddressResolutionStatement.html index f681906fd..5bf9e2a4b 100644 --- a/source/serialization/AddressResolutionStatement.html +++ b/source/serialization/AddressResolutionStatement.html @@ -1,7 +1,7 @@
- +
↕Size: 32 bytes = 0x20
schema
schema

An Address resolution statement links a namespace alias used in a transaction to the real address at the time of the transaction.

diff --git a/source/serialization/AggregateBondedTransaction.html b/source/serialization/AggregateBondedTransaction.html index caa06da61..d984b1e90 100644 --- a/source/serialization/AggregateBondedTransaction.html +++ b/source/serialization/AggregateBondedTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 171+ bytes = 0xab+ (variable)
schema
catapult model
schema
catapult model

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.

diff --git a/source/serialization/AggregateCompleteTransaction.html b/source/serialization/AggregateCompleteTransaction.html index 63ec44dda..b4012be41 100644 --- a/source/serialization/AggregateCompleteTransaction.html +++ b/source/serialization/AggregateCompleteTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 171+ bytes = 0xab+ (variable)
schema
catapult model
schema
catapult model

Send transactions in batches to different accounts.
Use this transaction when all required signatures are available when the transaction is created.

diff --git a/source/serialization/AggregateTransactionBody.html b/source/serialization/AggregateTransactionBody.html index 3d466d673..ed3e815c2 100644 --- a/source/serialization/AggregateTransactionBody.html +++ b/source/serialization/AggregateTransactionBody.html @@ -1,7 +1,7 @@
- +
↕Size: 40+ bytes = 0x28+ (variable)
schema
schema

Shared content between AggregateCompleteTransaction and AggregateBondedTransaction.

diff --git a/source/serialization/AliasAction.html b/source/serialization/AliasAction.html index d4d3b337f..d437ae941 100644 --- a/source/serialization/AliasAction.html +++ b/source/serialization/AliasAction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 1 byte = 0x1
schema
catapult model
schema
catapult model

Enumeration of alias actions.

diff --git a/source/serialization/BalanceChangeReceipt.html b/source/serialization/BalanceChangeReceipt.html index 94c9f1b88..14a7aa7f9 100644 --- a/source/serialization/BalanceChangeReceipt.html +++ b/source/serialization/BalanceChangeReceipt.html @@ -1,8 +1,8 @@
- - + +
↕Size: 48 bytes = 0x30
schema
catapult model
schema
catapult model

An invisible state change modified an account's balance.

diff --git a/source/serialization/BalanceTransferReceipt.html b/source/serialization/BalanceTransferReceipt.html index 4da9aa394..5c9233216 100644 --- a/source/serialization/BalanceTransferReceipt.html +++ b/source/serialization/BalanceTransferReceipt.html @@ -1,8 +1,8 @@
- - + +
↕Size: 72 bytes = 0x48
schema
catapult model
schema
catapult model

An invisible state change triggered a mosaic transfer.

diff --git a/source/serialization/BlockHeader.html b/source/serialization/BlockHeader.html index 1aa5bfd69..2c57654a6 100644 --- a/source/serialization/BlockHeader.html +++ b/source/serialization/BlockHeader.html @@ -1,8 +1,8 @@
- - + +
↕Size: 372 bytes = 0x174
schema
catapult model
schema
catapult model

binary layout for a block header

diff --git a/source/serialization/BlockType.html b/source/serialization/BlockType.html index da17d6163..e9aff459a 100644 --- a/source/serialization/BlockType.html +++ b/source/serialization/BlockType.html @@ -1,7 +1,7 @@
- +
↕Size: 2 bytes = 0x2
schema
schema

enumeration of block types

diff --git a/source/serialization/Cosignature.html b/source/serialization/Cosignature.html index 0623a7f2e..eb9800105 100644 --- a/source/serialization/Cosignature.html +++ b/source/serialization/Cosignature.html @@ -1,8 +1,8 @@
- - + +
↕Size: 104 bytes = 0x68
schema
catapult model
schema
catapult model

Cosignature attached to an AggregateCompleteTransaction or AggregateBondedTransaction.

diff --git a/source/serialization/DetachedCosignature.html b/source/serialization/DetachedCosignature.html index 99935fc50..1312e99df 100644 --- a/source/serialization/DetachedCosignature.html +++ b/source/serialization/DetachedCosignature.html @@ -1,8 +1,8 @@
- - + +
↕Size: 136 bytes = 0x88
schema
catapult model
schema
catapult model

Cosignature detached from an AggregateCompleteTransaction or AggregateBondedTransaction.

diff --git a/source/serialization/EmbeddedAccountAddressRestrictionTransaction.html b/source/serialization/EmbeddedAccountAddressRestrictionTransaction.html index 453218c92..bf18b9db2 100644 --- a/source/serialization/EmbeddedAccountAddressRestrictionTransaction.html +++ b/source/serialization/EmbeddedAccountAddressRestrictionTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 59+ bytes = 0x3b+ (variable)
schema
catapult model
schema
catapult model

Embedded version of AccountAddressRestrictionTransaction.

diff --git a/source/serialization/EmbeddedAccountKeyLinkTransaction.html b/source/serialization/EmbeddedAccountKeyLinkTransaction.html index 6ec462e72..bea166716 100644 --- a/source/serialization/EmbeddedAccountKeyLinkTransaction.html +++ b/source/serialization/EmbeddedAccountKeyLinkTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 84 bytes = 0x54
schema
catapult model
schema
catapult model

Embedded version of AccountKeyLinkTransaction.

diff --git a/source/serialization/EmbeddedAccountMetadataTransaction.html b/source/serialization/EmbeddedAccountMetadataTransaction.html index b10f4f0ae..0ed27abb1 100644 --- a/source/serialization/EmbeddedAccountMetadataTransaction.html +++ b/source/serialization/EmbeddedAccountMetadataTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 87+ bytes = 0x57+ (variable)
schema
catapult model
schema
catapult model

Embedded version of AccountMetadataTransaction.

diff --git a/source/serialization/EmbeddedAccountMosaicRestrictionTransaction.html b/source/serialization/EmbeddedAccountMosaicRestrictionTransaction.html index 278e186b2..1804aa2a5 100644 --- a/source/serialization/EmbeddedAccountMosaicRestrictionTransaction.html +++ b/source/serialization/EmbeddedAccountMosaicRestrictionTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 59+ bytes = 0x3b+ (variable)
schema
catapult model
schema
catapult model

Embedded version of AccountMosaicRestrictionTransaction.

diff --git a/source/serialization/EmbeddedAccountOperationRestrictionTransaction.html b/source/serialization/EmbeddedAccountOperationRestrictionTransaction.html index 175a93e80..8afebfe05 100644 --- a/source/serialization/EmbeddedAccountOperationRestrictionTransaction.html +++ b/source/serialization/EmbeddedAccountOperationRestrictionTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 59+ bytes = 0x3b+ (variable)
schema
catapult model
schema
catapult model

Embedded version of AccountOperationRestrictionTransaction.

diff --git a/source/serialization/EmbeddedAddressAliasTransaction.html b/source/serialization/EmbeddedAddressAliasTransaction.html index 05aec5e4c..61b5fdc19 100644 --- a/source/serialization/EmbeddedAddressAliasTransaction.html +++ b/source/serialization/EmbeddedAddressAliasTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 84 bytes = 0x54
schema
catapult model
schema
catapult model

Embedded version of AddressAliasTransaction.

diff --git a/source/serialization/EmbeddedHashLockTransaction.html b/source/serialization/EmbeddedHashLockTransaction.html index 788a2b4fa..5eb9c4bde 100644 --- a/source/serialization/EmbeddedHashLockTransaction.html +++ b/source/serialization/EmbeddedHashLockTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 107 bytes = 0x6b
schema
catapult model
schema
catapult model

Embedded version of HashLockTransaction.

diff --git a/source/serialization/EmbeddedMosaicAddressRestrictionTransaction.html b/source/serialization/EmbeddedMosaicAddressRestrictionTransaction.html index 78c8521c0..1fe9f91b8 100644 --- a/source/serialization/EmbeddedMosaicAddressRestrictionTransaction.html +++ b/source/serialization/EmbeddedMosaicAddressRestrictionTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 107 bytes = 0x6b
schema
catapult model
schema
catapult model

Embedded version of MosaicAddressRestrictionTransaction.

diff --git a/source/serialization/EmbeddedMosaicAliasTransaction.html b/source/serialization/EmbeddedMosaicAliasTransaction.html index c53f05a88..8b31f5b22 100644 --- a/source/serialization/EmbeddedMosaicAliasTransaction.html +++ b/source/serialization/EmbeddedMosaicAliasTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 68 bytes = 0x44
schema
catapult model
schema
catapult model

Embedded version of MosaicAliasTransaction

diff --git a/source/serialization/EmbeddedMosaicDefinitionTransaction.html b/source/serialization/EmbeddedMosaicDefinitionTransaction.html index bc566160b..685f4e91f 100644 --- a/source/serialization/EmbeddedMosaicDefinitionTransaction.html +++ b/source/serialization/EmbeddedMosaicDefinitionTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 73 bytes = 0x49
schema
catapult model
schema
catapult model

Embedded version of MosaicDefinitionTransaction.

diff --git a/source/serialization/EmbeddedMosaicGlobalRestrictionTransaction.html b/source/serialization/EmbeddedMosaicGlobalRestrictionTransaction.html index d0b4c2d41..67181d11e 100644 --- a/source/serialization/EmbeddedMosaicGlobalRestrictionTransaction.html +++ b/source/serialization/EmbeddedMosaicGlobalRestrictionTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 93 bytes = 0x5d
schema
catapult model
schema
catapult model

Embedded version of MosaicGlobalRestrictionTransaction.

diff --git a/source/serialization/EmbeddedMosaicMetadataTransaction.html b/source/serialization/EmbeddedMosaicMetadataTransaction.html index 91b6887fc..77aff3747 100644 --- a/source/serialization/EmbeddedMosaicMetadataTransaction.html +++ b/source/serialization/EmbeddedMosaicMetadataTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 95+ bytes = 0x5f+ (variable)
schema
catapult model
schema
catapult model

Embedded version of MosaicMetadataTransaction.

diff --git a/source/serialization/EmbeddedMosaicSupplyChangeTransaction.html b/source/serialization/EmbeddedMosaicSupplyChangeTransaction.html index 1476b7435..008ae4f53 100644 --- a/source/serialization/EmbeddedMosaicSupplyChangeTransaction.html +++ b/source/serialization/EmbeddedMosaicSupplyChangeTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 68 bytes = 0x44
schema
catapult model
schema
catapult model

Embedded version of MosaicSupplyChangeTransaction.

diff --git a/source/serialization/EmbeddedMosaicSupplyRevocationTransaction.html b/source/serialization/EmbeddedMosaicSupplyRevocationTransaction.html index b6a1c5845..6f3936210 100644 --- a/source/serialization/EmbeddedMosaicSupplyRevocationTransaction.html +++ b/source/serialization/EmbeddedMosaicSupplyRevocationTransaction.html @@ -1,7 +1,7 @@
- +
↕Size: 91 bytes = 0x5b
schema
schema

Embedded version of MosaicSupplyRevocationTransaction.

diff --git a/source/serialization/EmbeddedMultisigAccountModificationTransaction.html b/source/serialization/EmbeddedMultisigAccountModificationTransaction.html index 8ad74c19d..c614256e5 100644 --- a/source/serialization/EmbeddedMultisigAccountModificationTransaction.html +++ b/source/serialization/EmbeddedMultisigAccountModificationTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 59+ bytes = 0x3b+ (variable)
schema
catapult model
schema
catapult model

Embedded version of MultisigAccountModificationTransaction.

diff --git a/source/serialization/EmbeddedNamespaceMetadataTransaction.html b/source/serialization/EmbeddedNamespaceMetadataTransaction.html index 5c34b679d..d43c9fb9e 100644 --- a/source/serialization/EmbeddedNamespaceMetadataTransaction.html +++ b/source/serialization/EmbeddedNamespaceMetadataTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 95+ bytes = 0x5f+ (variable)
schema
catapult model
schema
catapult model

Embedded version of NamespaceMetadataTransaction.

diff --git a/source/serialization/EmbeddedNamespaceRegistrationTransaction.html b/source/serialization/EmbeddedNamespaceRegistrationTransaction.html index 03e6c22c3..040facbf6 100644 --- a/source/serialization/EmbeddedNamespaceRegistrationTransaction.html +++ b/source/serialization/EmbeddedNamespaceRegistrationTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 77+ bytes = 0x4d+ (variable)
schema
catapult model
schema
catapult model

Embedded version of NamespaceRegistrationTransaction.

diff --git a/source/serialization/EmbeddedNodeKeyLinkTransaction.html b/source/serialization/EmbeddedNodeKeyLinkTransaction.html index b7962df03..97b68cbe6 100644 --- a/source/serialization/EmbeddedNodeKeyLinkTransaction.html +++ b/source/serialization/EmbeddedNodeKeyLinkTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 84 bytes = 0x54
schema
catapult model
schema
catapult model

Embedded version of NodeKeyLinkTransaction.

diff --git a/source/serialization/EmbeddedSecretLockTransaction.html b/source/serialization/EmbeddedSecretLockTransaction.html index 8c994138a..3133c246f 100644 --- a/source/serialization/EmbeddedSecretLockTransaction.html +++ b/source/serialization/EmbeddedSecretLockTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 132 bytes = 0x84
schema
catapult model
schema
catapult model

Embedded version of SecretLockTransaction.

diff --git a/source/serialization/EmbeddedSecretProofTransaction.html b/source/serialization/EmbeddedSecretProofTransaction.html index d126acfcd..f25328763 100644 --- a/source/serialization/EmbeddedSecretProofTransaction.html +++ b/source/serialization/EmbeddedSecretProofTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 110+ bytes = 0x6e+ (variable)
schema
catapult model
schema
catapult model

Embedded version of SecretProofTransaction.

diff --git a/source/serialization/EmbeddedTransaction.html b/source/serialization/EmbeddedTransaction.html index 58aac6000..7bcfd25f3 100644 --- a/source/serialization/EmbeddedTransaction.html +++ b/source/serialization/EmbeddedTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 48 bytes = 0x30
schema
catapult model
schema
catapult model

binary layout for an embedded transaction

diff --git a/source/serialization/EmbeddedTransactionHeader.html b/source/serialization/EmbeddedTransactionHeader.html index 60ca6af34..e0e96c130 100644 --- a/source/serialization/EmbeddedTransactionHeader.html +++ b/source/serialization/EmbeddedTransactionHeader.html @@ -1,8 +1,8 @@
- - + +
↕Size: 8 bytes = 0x8
schema
catapult model
schema
catapult model

binary layout for an embedded transaction header

diff --git a/source/serialization/EmbeddedTransferTransaction.html b/source/serialization/EmbeddedTransferTransaction.html index 9138c56de..f2831ec98 100644 --- a/source/serialization/EmbeddedTransferTransaction.html +++ b/source/serialization/EmbeddedTransferTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 83+ bytes = 0x53+ (variable)
schema
catapult model
schema
catapult model

Embedded version of TransferTransaction.

diff --git a/source/serialization/EmbeddedVotingKeyLinkTransaction.html b/source/serialization/EmbeddedVotingKeyLinkTransaction.html index e47ba3689..8843f2f85 100644 --- a/source/serialization/EmbeddedVotingKeyLinkTransaction.html +++ b/source/serialization/EmbeddedVotingKeyLinkTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 92 bytes = 0x5c
schema
catapult model
schema
catapult model

Embedded version of VotingKeyLinkTransaction.

diff --git a/source/serialization/EmbeddedVrfKeyLinkTransaction.html b/source/serialization/EmbeddedVrfKeyLinkTransaction.html index 3076ff1cb..f16272347 100644 --- a/source/serialization/EmbeddedVrfKeyLinkTransaction.html +++ b/source/serialization/EmbeddedVrfKeyLinkTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 84 bytes = 0x54
schema
catapult model
schema
catapult model

Embedded version of VrfKeyLinkTransaction.

diff --git a/source/serialization/EntityBody.html b/source/serialization/EntityBody.html index f34130701..f849109ab 100644 --- a/source/serialization/EntityBody.html +++ b/source/serialization/EntityBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 38 bytes = 0x26
schema
catapult model
schema
catapult model

Serialization of an entity.
An entity could be a Block or a Transaction.

diff --git a/source/serialization/FinalizationRound.html b/source/serialization/FinalizationRound.html index a22563f42..9772c74c7 100644 --- a/source/serialization/FinalizationRound.html +++ b/source/serialization/FinalizationRound.html @@ -1,8 +1,8 @@
- - + +
↕Size: 8 bytes = 0x8
schema
catapult model
schema
catapult model

binary layout for finalization round

diff --git a/source/serialization/FinalizedBlockHeader.html b/source/serialization/FinalizedBlockHeader.html index 3b7540396..73b398f83 100644 --- a/source/serialization/FinalizedBlockHeader.html +++ b/source/serialization/FinalizedBlockHeader.html @@ -1,7 +1,7 @@
- +
↕Size: 48 bytes = 0x30
schema
schema

binary layout for finalized block header

diff --git a/source/serialization/GlobalKeyValue.html b/source/serialization/GlobalKeyValue.html index b4a56da80..2e1d3b9be 100644 --- a/source/serialization/GlobalKeyValue.html +++ b/source/serialization/GlobalKeyValue.html @@ -1,7 +1,7 @@
- +
↕Size: 25 bytes = 0x19
schema
schema

binary layout for a global key-value

diff --git a/source/serialization/GlobalKeyValueSet.html b/source/serialization/GlobalKeyValueSet.html index 53228a707..a34dd27c0 100644 --- a/source/serialization/GlobalKeyValueSet.html +++ b/source/serialization/GlobalKeyValueSet.html @@ -1,7 +1,7 @@
- +
↕Size: 1+ byte = 0x1+ (variable)
schema
schema

binary layout for a global restriction key-value set

diff --git a/source/serialization/HashLockInfo.html b/source/serialization/HashLockInfo.html index 280d11e42..373e002ff 100644 --- a/source/serialization/HashLockInfo.html +++ b/source/serialization/HashLockInfo.html @@ -1,8 +1,8 @@
- - + +
↕Size: 83 bytes = 0x53
schema
catapult model
schema
catapult model

binary layout for hash lock transaction info

diff --git a/source/serialization/HashLockTransaction.html b/source/serialization/HashLockTransaction.html index 8db67d105..850387875 100644 --- a/source/serialization/HashLockTransaction.html +++ b/source/serialization/HashLockTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 187 bytes = 0xbb
schema
catapult model
schema
catapult model

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.

diff --git a/source/serialization/HashLockTransactionBody.html b/source/serialization/HashLockTransactionBody.html index ade59b491..907f7df59 100644 --- a/source/serialization/HashLockTransactionBody.html +++ b/source/serialization/HashLockTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 56 bytes = 0x38
schema
catapult model
schema
catapult model

Shared content between HashLockTransaction and EmbeddedHashLockTransaction.

diff --git a/source/serialization/HeightActivityBucket.html b/source/serialization/HeightActivityBucket.html index 6c7194fee..ced1762fc 100644 --- a/source/serialization/HeightActivityBucket.html +++ b/source/serialization/HeightActivityBucket.html @@ -1,7 +1,7 @@
- +
↕Size: 28 bytes = 0x1c
schema
schema

account activity bucket

diff --git a/source/serialization/HeightActivityBuckets.html b/source/serialization/HeightActivityBuckets.html index 6abe5e776..bde0a7c65 100644 --- a/source/serialization/HeightActivityBuckets.html +++ b/source/serialization/HeightActivityBuckets.html @@ -1,7 +1,7 @@
- +
↕Size: 140 bytes = 0x8c
schema
schema

account activity buckets

diff --git a/source/serialization/ImportanceBlockFooter.html b/source/serialization/ImportanceBlockFooter.html index dbf5b4a4d..ddc05b1ac 100644 --- a/source/serialization/ImportanceBlockFooter.html +++ b/source/serialization/ImportanceBlockFooter.html @@ -1,8 +1,8 @@
- - + +
↕Size: 52 bytes = 0x34
schema
catapult model
schema
catapult model

binary layout for an importance block footer

diff --git a/source/serialization/ImportanceBlockHeader.html b/source/serialization/ImportanceBlockHeader.html index c7656a047..03c5a3b77 100644 --- a/source/serialization/ImportanceBlockHeader.html +++ b/source/serialization/ImportanceBlockHeader.html @@ -1,7 +1,7 @@
- +
↕Size: 427 bytes = 0x1ab
schema
schema

binary layout for an importance block header

diff --git a/source/serialization/ImportanceSnapshot.html b/source/serialization/ImportanceSnapshot.html index 70c3931c9..8c5b980c5 100644 --- a/source/serialization/ImportanceSnapshot.html +++ b/source/serialization/ImportanceSnapshot.html @@ -1,8 +1,8 @@
- - + +
↕Size: 16 bytes = 0x10
schema
catapult model
schema
catapult model

temporal importance information

diff --git a/source/serialization/InflationReceipt.html b/source/serialization/InflationReceipt.html index 86f760a62..ca02298c4 100644 --- a/source/serialization/InflationReceipt.html +++ b/source/serialization/InflationReceipt.html @@ -1,8 +1,8 @@
- - + +
↕Size: 24 bytes = 0x18
schema
catapult model
schema
catapult model

Network currency mosaics were created due to inflation.

diff --git a/source/serialization/LinkAction.html b/source/serialization/LinkAction.html index 7c204bb49..0a237bf86 100644 --- a/source/serialization/LinkAction.html +++ b/source/serialization/LinkAction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 1 byte = 0x1
schema
catapult model
schema
catapult model

Link actions.

diff --git a/source/serialization/LockHashAlgorithm.html b/source/serialization/LockHashAlgorithm.html index 391658904..a02e6036a 100644 --- a/source/serialization/LockHashAlgorithm.html +++ b/source/serialization/LockHashAlgorithm.html @@ -1,8 +1,8 @@
- - + +
↕Size: 1 byte = 0x1
schema
catapult model
schema
catapult model

Enumeration of lock hash algorithms.

diff --git a/source/serialization/LockStatus.html b/source/serialization/LockStatus.html index db6bd0576..dd2856b1f 100644 --- a/source/serialization/LockStatus.html +++ b/source/serialization/LockStatus.html @@ -1,8 +1,8 @@
- - + +
↕Size: 1 byte = 0x1
schema
catapult model
schema
catapult model

lock status for lock transaction

diff --git a/source/serialization/MetadataEntry.html b/source/serialization/MetadataEntry.html index 026c1e1d9..bf4238710 100644 --- a/source/serialization/MetadataEntry.html +++ b/source/serialization/MetadataEntry.html @@ -1,7 +1,7 @@
- +
↕Size: 69+ bytes = 0x45+ (variable)
schema
schema

binary layout of a metadata entry

diff --git a/source/serialization/MetadataType.html b/source/serialization/MetadataType.html index d6884ba82..f02c24e0e 100644 --- a/source/serialization/MetadataType.html +++ b/source/serialization/MetadataType.html @@ -1,8 +1,8 @@
- - + +
↕Size: 1 byte = 0x1
schema
catapult model
schema
catapult model

enum for the different types of metadata

diff --git a/source/serialization/MetadataValue.html b/source/serialization/MetadataValue.html index 6b0c2ad73..c7a4626c1 100644 --- a/source/serialization/MetadataValue.html +++ b/source/serialization/MetadataValue.html @@ -1,7 +1,7 @@
- +
↕Size: 2+ bytes = 0x2+ (variable)
schema
schema

binary layout of a metadata entry value

diff --git a/source/serialization/Mosaic.html b/source/serialization/Mosaic.html index 309939296..84b9cef43 100644 --- a/source/serialization/Mosaic.html +++ b/source/serialization/Mosaic.html @@ -1,7 +1,7 @@
- +
↕Size: 16 bytes = 0x10
schema
schema

A quantity of a certain mosaic.

diff --git a/source/serialization/MosaicAddressRestrictionEntry.html b/source/serialization/MosaicAddressRestrictionEntry.html index 51472a74a..33c71fc31 100644 --- a/source/serialization/MosaicAddressRestrictionEntry.html +++ b/source/serialization/MosaicAddressRestrictionEntry.html @@ -1,7 +1,7 @@
- +
↕Size: 33+ bytes = 0x21+ (variable)
schema
schema

binary layout for a mosaic restriction

diff --git a/source/serialization/MosaicAddressRestrictionTransaction.html b/source/serialization/MosaicAddressRestrictionTransaction.html index 52eda54f3..632b374ab 100644 --- a/source/serialization/MosaicAddressRestrictionTransaction.html +++ b/source/serialization/MosaicAddressRestrictionTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 187 bytes = 0xbb
schema
catapult model
schema
catapult model

Set address specific rules to transfer a restrictable mosaic.

diff --git a/source/serialization/MosaicAddressRestrictionTransactionBody.html b/source/serialization/MosaicAddressRestrictionTransactionBody.html index ad0ea0f66..0ac24a3e4 100644 --- a/source/serialization/MosaicAddressRestrictionTransactionBody.html +++ b/source/serialization/MosaicAddressRestrictionTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 56 bytes = 0x38
schema
catapult model
schema
catapult model

Shared content between MosaicAddressRestrictionTransaction and EmbeddedMosaicAddressRestrictionTransaction.

diff --git a/source/serialization/MosaicAliasTransaction.html b/source/serialization/MosaicAliasTransaction.html index 3a4f25903..86a749a39 100644 --- a/source/serialization/MosaicAliasTransaction.html +++ b/source/serialization/MosaicAliasTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 148 bytes = 0x94
schema
catapult model
schema
catapult model

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.

diff --git a/source/serialization/MosaicAliasTransactionBody.html b/source/serialization/MosaicAliasTransactionBody.html index f7c4dabf7..cf5c3a4f4 100644 --- a/source/serialization/MosaicAliasTransactionBody.html +++ b/source/serialization/MosaicAliasTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 17 bytes = 0x11
schema
catapult model
schema
catapult model

Shared content between MosaicAliasTransaction and EmbeddedMosaicAliasTransaction

diff --git a/source/serialization/MosaicDefinition.html b/source/serialization/MosaicDefinition.html index 63558c8f1..90370650c 100644 --- a/source/serialization/MosaicDefinition.html +++ b/source/serialization/MosaicDefinition.html @@ -1,7 +1,7 @@
- +
↕Size: 46 bytes = 0x2e
schema
schema

binary layout for mosaic definition

diff --git a/source/serialization/MosaicDefinitionTransaction.html b/source/serialization/MosaicDefinitionTransaction.html index d6bf6c883..ab5e7e446 100644 --- a/source/serialization/MosaicDefinitionTransaction.html +++ b/source/serialization/MosaicDefinitionTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 153 bytes = 0x99
schema
catapult model
schema
catapult model

Create a new mosaic.

diff --git a/source/serialization/MosaicDefinitionTransactionBody.html b/source/serialization/MosaicDefinitionTransactionBody.html index fa7949f8c..d775baff9 100644 --- a/source/serialization/MosaicDefinitionTransactionBody.html +++ b/source/serialization/MosaicDefinitionTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 22 bytes = 0x16
schema
catapult model
schema
catapult model

Shared content between MosaicDefinitionTransaction and Embedded MosaicDefinitionTransaction.

diff --git a/source/serialization/MosaicEntry.html b/source/serialization/MosaicEntry.html index b34c381b4..8975f35c9 100644 --- a/source/serialization/MosaicEntry.html +++ b/source/serialization/MosaicEntry.html @@ -1,7 +1,7 @@
- +
↕Size: 64 bytes = 0x40
schema
schema

binary layout for mosaic entry

diff --git a/source/serialization/MosaicExpiryReceipt.html b/source/serialization/MosaicExpiryReceipt.html index 9eb828200..901b691bd 100644 --- a/source/serialization/MosaicExpiryReceipt.html +++ b/source/serialization/MosaicExpiryReceipt.html @@ -1,7 +1,7 @@
- +
↕Size: 16 bytes = 0x10
schema
schema

An mosaic expired.

diff --git a/source/serialization/MosaicFlags.html b/source/serialization/MosaicFlags.html index b582f8245..a96a61290 100644 --- a/source/serialization/MosaicFlags.html +++ b/source/serialization/MosaicFlags.html @@ -1,8 +1,8 @@
- - + +
↕Size: 1 byte = 0x1
schema
catapult model
schema
catapult model

Enumeration of mosaic property flags.

diff --git a/source/serialization/MosaicGlobalRestrictionEntry.html b/source/serialization/MosaicGlobalRestrictionEntry.html index 642a11f39..3238f151c 100644 --- a/source/serialization/MosaicGlobalRestrictionEntry.html +++ b/source/serialization/MosaicGlobalRestrictionEntry.html @@ -1,7 +1,7 @@
- +
↕Size: 9+ bytes = 0x9+ (variable)
schema
schema

binary layout for a mosaic restriction

diff --git a/source/serialization/MosaicGlobalRestrictionTransaction.html b/source/serialization/MosaicGlobalRestrictionTransaction.html index c3c73dbf6..25665a34d 100644 --- a/source/serialization/MosaicGlobalRestrictionTransaction.html +++ b/source/serialization/MosaicGlobalRestrictionTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 173 bytes = 0xad
schema
catapult model
schema
catapult model

Set global rules to transfer a restrictable mosaic.

diff --git a/source/serialization/MosaicGlobalRestrictionTransactionBody.html b/source/serialization/MosaicGlobalRestrictionTransactionBody.html index 92c4adec9..eaf56bc17 100644 --- a/source/serialization/MosaicGlobalRestrictionTransactionBody.html +++ b/source/serialization/MosaicGlobalRestrictionTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 42 bytes = 0x2a
schema
catapult model
schema
catapult model

Shared content between MosaicGlobalRestrictionTransaction and EmbeddedMosaicGlobalRestrictionTransaction.

diff --git a/source/serialization/MosaicMetadataTransaction.html b/source/serialization/MosaicMetadataTransaction.html index be0115275..029e7bec8 100644 --- a/source/serialization/MosaicMetadataTransaction.html +++ b/source/serialization/MosaicMetadataTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 175+ bytes = 0xaf+ (variable)
schema
catapult model
schema
catapult model

Associate a key-value state (metadata) to a mosaic.
Compare to AccountMetadataTransaction and NamespaceMetadataTransaction.

diff --git a/source/serialization/MosaicMetadataTransactionBody.html b/source/serialization/MosaicMetadataTransactionBody.html index 1dd075a3f..6d3656276 100644 --- a/source/serialization/MosaicMetadataTransactionBody.html +++ b/source/serialization/MosaicMetadataTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 44+ bytes = 0x2c+ (variable)
schema
catapult model
schema
catapult model

Shared content between MosaicMetadataTransaction and EmbeddedMosaicMetadataTransaction.

diff --git a/source/serialization/MosaicProperties.html b/source/serialization/MosaicProperties.html index bc0acd11e..4780b48ff 100644 --- a/source/serialization/MosaicProperties.html +++ b/source/serialization/MosaicProperties.html @@ -1,7 +1,7 @@
- +
↕Size: 10 bytes = 0xa
schema
schema

binary layout for mosaic properties

diff --git a/source/serialization/MosaicResolutionEntry.html b/source/serialization/MosaicResolutionEntry.html index 48561b9e8..a9e7e2c16 100644 --- a/source/serialization/MosaicResolutionEntry.html +++ b/source/serialization/MosaicResolutionEntry.html @@ -1,7 +1,7 @@
- +
↕Size: 16 bytes = 0x10
schema
schema

Actual MosaicId behind a NamespaceId at the time a transaction was confirmed.

diff --git a/source/serialization/MosaicResolutionStatement.html b/source/serialization/MosaicResolutionStatement.html index a26d1e469..98a841312 100644 --- a/source/serialization/MosaicResolutionStatement.html +++ b/source/serialization/MosaicResolutionStatement.html @@ -1,7 +1,7 @@
- +
↕Size: 16 bytes = 0x10
schema
schema

A Mosaic resolution statement links a namespace alias used in a transaction to the real mosaic id at the time of the transaction.

diff --git a/source/serialization/MosaicRestrictionEntry.html b/source/serialization/MosaicRestrictionEntry.html index 2c19b02ac..5c64e2941 100644 --- a/source/serialization/MosaicRestrictionEntry.html +++ b/source/serialization/MosaicRestrictionEntry.html @@ -1,7 +1,7 @@
- +
↕Size: 45+ bytes = 0x2d+ (variable)
schema
schema

binary layout for a mosaic restriction

diff --git a/source/serialization/MosaicRestrictionEntryType.html b/source/serialization/MosaicRestrictionEntryType.html index 7d87c2365..0d365c89b 100644 --- a/source/serialization/MosaicRestrictionEntryType.html +++ b/source/serialization/MosaicRestrictionEntryType.html @@ -1,7 +1,7 @@
- +
↕Size: 1 byte = 0x1
schema
schema

type of mosaic restriction entry

diff --git a/source/serialization/MosaicRestrictionType.html b/source/serialization/MosaicRestrictionType.html index 20ae94282..a577fb2ec 100644 --- a/source/serialization/MosaicRestrictionType.html +++ b/source/serialization/MosaicRestrictionType.html @@ -1,8 +1,8 @@
- - + +
↕Size: 1 byte = 0x1
schema
catapult model
schema
catapult model

Enumeration of mosaic restriction types.

diff --git a/source/serialization/MosaicSupplyChangeAction.html b/source/serialization/MosaicSupplyChangeAction.html index 611a7dbdd..4b0e32478 100644 --- a/source/serialization/MosaicSupplyChangeAction.html +++ b/source/serialization/MosaicSupplyChangeAction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 1 byte = 0x1
schema
catapult model
schema
catapult model

Enumeration of mosaic supply change actions.

diff --git a/source/serialization/MosaicSupplyChangeTransaction.html b/source/serialization/MosaicSupplyChangeTransaction.html index 33faa473f..f9837139d 100644 --- a/source/serialization/MosaicSupplyChangeTransaction.html +++ b/source/serialization/MosaicSupplyChangeTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 148 bytes = 0x94
schema
catapult model
schema
catapult model

Change the total supply of a mosaic.

diff --git a/source/serialization/MosaicSupplyChangeTransactionBody.html b/source/serialization/MosaicSupplyChangeTransactionBody.html index f5608469d..e1503176c 100644 --- a/source/serialization/MosaicSupplyChangeTransactionBody.html +++ b/source/serialization/MosaicSupplyChangeTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 17 bytes = 0x11
schema
catapult model
schema
catapult model

Shared content between MosaicSupplyChangeTransaction and EmbeddedMosaicSupplyChangeTransaction.

diff --git a/source/serialization/MosaicSupplyRevocationTransaction.html b/source/serialization/MosaicSupplyRevocationTransaction.html index 7123dc506..c9b88d955 100644 --- a/source/serialization/MosaicSupplyRevocationTransaction.html +++ b/source/serialization/MosaicSupplyRevocationTransaction.html @@ -1,7 +1,7 @@
- +
↕Size: 171 bytes = 0xab
schema
schema

Revoke mosaic.

diff --git a/source/serialization/MosaicSupplyRevocationTransactionBody.html b/source/serialization/MosaicSupplyRevocationTransactionBody.html index 092f347c2..fc4dcd66a 100644 --- a/source/serialization/MosaicSupplyRevocationTransactionBody.html +++ b/source/serialization/MosaicSupplyRevocationTransactionBody.html @@ -1,7 +1,7 @@
- +
↕Size: 40 bytes = 0x28
schema
schema

Shared content between MosaicSupplyRevocationTransaction and EmbeddedMosaicSupplyRevocationTransaction.

diff --git a/source/serialization/MultisigAccountModificationTransaction.html b/source/serialization/MultisigAccountModificationTransaction.html index eab76d317..257492dd4 100644 --- a/source/serialization/MultisigAccountModificationTransaction.html +++ b/source/serialization/MultisigAccountModificationTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 139+ bytes = 0x8b+ (variable)
schema
catapult model
schema
catapult model

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).

diff --git a/source/serialization/MultisigAccountModificationTransactionBody.html b/source/serialization/MultisigAccountModificationTransactionBody.html index 31f85311b..88a63d6c1 100644 --- a/source/serialization/MultisigAccountModificationTransactionBody.html +++ b/source/serialization/MultisigAccountModificationTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 8+ bytes = 0x8+ (variable)
schema
catapult model
schema
catapult model

Shared content between MultisigAccountModificationTransaction and EmbeddedMultisigAccountModificationTransaction.

diff --git a/source/serialization/MultisigEntry.html b/source/serialization/MultisigEntry.html index 4b55c4265..8ae4f4e7d 100644 --- a/source/serialization/MultisigEntry.html +++ b/source/serialization/MultisigEntry.html @@ -1,7 +1,7 @@
- +
↕Size: 50+ bytes = 0x32+ (variable)
schema
schema

binary layout for a multisig entry

diff --git a/source/serialization/NamespaceAlias.html b/source/serialization/NamespaceAlias.html index 3bc899eef..45e37a533 100644 --- a/source/serialization/NamespaceAlias.html +++ b/source/serialization/NamespaceAlias.html @@ -1,7 +1,7 @@
- +
↕Size: 33 bytes = 0x21
schema
schema

binary layout for alias

diff --git a/source/serialization/NamespaceAliasType.html b/source/serialization/NamespaceAliasType.html index 5f8224a03..7420328f2 100644 --- a/source/serialization/NamespaceAliasType.html +++ b/source/serialization/NamespaceAliasType.html @@ -1,7 +1,7 @@
- +
↕Size: 1 byte = 0x1
schema
schema

namespace alias type

diff --git a/source/serialization/NamespaceExpiryReceipt.html b/source/serialization/NamespaceExpiryReceipt.html index 5d44017dc..6f49c290f 100644 --- a/source/serialization/NamespaceExpiryReceipt.html +++ b/source/serialization/NamespaceExpiryReceipt.html @@ -1,7 +1,7 @@
- +
↕Size: 16 bytes = 0x10
schema
schema

Receipt generated when a namespace expires.

diff --git a/source/serialization/NamespaceLifetime.html b/source/serialization/NamespaceLifetime.html index 480304379..f84d332ed 100644 --- a/source/serialization/NamespaceLifetime.html +++ b/source/serialization/NamespaceLifetime.html @@ -1,8 +1,8 @@
- - + +
↕Size: 16 bytes = 0x10
schema
catapult model
schema
catapult model

binary layout for namespace lifetime

diff --git a/source/serialization/NamespaceMetadataTransaction.html b/source/serialization/NamespaceMetadataTransaction.html index 8f61eb70d..16bf06d72 100644 --- a/source/serialization/NamespaceMetadataTransaction.html +++ b/source/serialization/NamespaceMetadataTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 175+ bytes = 0xaf+ (variable)
schema
catapult model
schema
catapult model

Associate a key-value state (metadata) to a namespace.
Compare to AccountMetadataTransaction and MosaicMetadataTransaction.

diff --git a/source/serialization/NamespaceMetadataTransactionBody.html b/source/serialization/NamespaceMetadataTransactionBody.html index 6b9e5dca3..158e88f0b 100644 --- a/source/serialization/NamespaceMetadataTransactionBody.html +++ b/source/serialization/NamespaceMetadataTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 44+ bytes = 0x2c+ (variable)
schema
catapult model
schema
catapult model

Shared content between NamespaceMetadataTransaction and EmbeddedNamespaceMetadataTransaction.

diff --git a/source/serialization/NamespacePath.html b/source/serialization/NamespacePath.html index 85579d174..4e580585e 100644 --- a/source/serialization/NamespacePath.html +++ b/source/serialization/NamespacePath.html @@ -1,7 +1,7 @@
- +
↕Size: 34+ bytes = 0x22+ (variable)
schema
schema

binary layout for a namespace path

diff --git a/source/serialization/NamespaceRegistrationTransaction.html b/source/serialization/NamespaceRegistrationTransaction.html index 10abd1833..f0623de9b 100644 --- a/source/serialization/NamespaceRegistrationTransaction.html +++ b/source/serialization/NamespaceRegistrationTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 157+ bytes = 0x9d+ (variable)
schema
catapult model
schema
catapult model

Register (or renew a registration for) a namespace.
Namespaces help keep assets organized.

diff --git a/source/serialization/NamespaceRegistrationTransactionBody.html b/source/serialization/NamespaceRegistrationTransactionBody.html index 3b58333d6..d8940ea48 100644 --- a/source/serialization/NamespaceRegistrationTransactionBody.html +++ b/source/serialization/NamespaceRegistrationTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 26+ bytes = 0x1a+ (variable)
schema
catapult model
schema
catapult model

Shared content between NamespaceRegistrationTransaction and EmbeddedNamespaceRegistrationTransaction.

diff --git a/source/serialization/NamespaceRegistrationType.html b/source/serialization/NamespaceRegistrationType.html index d080dee8e..21a1e95d0 100644 --- a/source/serialization/NamespaceRegistrationType.html +++ b/source/serialization/NamespaceRegistrationType.html @@ -1,8 +1,8 @@
- - + +
↕Size: 1 byte = 0x1
schema
catapult model
schema
catapult model

Enumeration of namespace registration types.

diff --git a/source/serialization/NemesisBlockHeader.html b/source/serialization/NemesisBlockHeader.html index 75a05b450..390681327 100644 --- a/source/serialization/NemesisBlockHeader.html +++ b/source/serialization/NemesisBlockHeader.html @@ -1,7 +1,7 @@
- +
↕Size: 427 bytes = 0x1ab
schema
schema

binary layout for a nemesis block header

diff --git a/source/serialization/NetworkType.html b/source/serialization/NetworkType.html index b8f6a7186..625c78069 100644 --- a/source/serialization/NetworkType.html +++ b/source/serialization/NetworkType.html @@ -1,7 +1,7 @@
- +
↕Size: 1 byte = 0x1
schema
schema

Enumeration of network types.

diff --git a/source/serialization/NodeKeyLinkTransaction.html b/source/serialization/NodeKeyLinkTransaction.html index 13c35cc45..96ba6ab6f 100644 --- a/source/serialization/NodeKeyLinkTransaction.html +++ b/source/serialization/NodeKeyLinkTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 164 bytes = 0xa4
schema
catapult model
schema
catapult model

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.

diff --git a/source/serialization/NodeKeyLinkTransactionBody.html b/source/serialization/NodeKeyLinkTransactionBody.html index cbce2b35b..852f9df25 100644 --- a/source/serialization/NodeKeyLinkTransactionBody.html +++ b/source/serialization/NodeKeyLinkTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 33 bytes = 0x21
schema
catapult model
schema
catapult model

Shared content between NodeKeyLinkTransaction and EmbeddedNodeKeyLinkTransaction.

diff --git a/source/serialization/NormalBlockHeader.html b/source/serialization/NormalBlockHeader.html index ec92ff3f9..317ec7a07 100644 --- a/source/serialization/NormalBlockHeader.html +++ b/source/serialization/NormalBlockHeader.html @@ -1,7 +1,7 @@
- +
↕Size: 379 bytes = 0x17b
schema
schema

binary layout for a normal block header

diff --git a/source/serialization/PinnedVotingKey.html b/source/serialization/PinnedVotingKey.html index 61bbfb131..d333231ba 100644 --- a/source/serialization/PinnedVotingKey.html +++ b/source/serialization/PinnedVotingKey.html @@ -1,8 +1,8 @@
- - + +
↕Size: 40 bytes = 0x28
schema
catapult model
schema
catapult model

pinned voting key

diff --git a/source/serialization/Receipt.html b/source/serialization/Receipt.html index 6bb105e89..c0ae58b6c 100644 --- a/source/serialization/Receipt.html +++ b/source/serialization/Receipt.html @@ -1,8 +1,8 @@
- - + +
↕Size: 8 bytes = 0x8
schema
catapult model
schema
catapult model

Receipts provide proof for every state change not retrievable from the block.

diff --git a/source/serialization/ReceiptSource.html b/source/serialization/ReceiptSource.html index 89d426274..0b006a976 100644 --- a/source/serialization/ReceiptSource.html +++ b/source/serialization/ReceiptSource.html @@ -1,8 +1,8 @@
- - + +
↕Size: 8 bytes = 0x8
schema
catapult model
schema
catapult model

The transaction inside the block that triggered the receipt.

diff --git a/source/serialization/ReceiptType.html b/source/serialization/ReceiptType.html index 4d38e302d..6beb70610 100644 --- a/source/serialization/ReceiptType.html +++ b/source/serialization/ReceiptType.html @@ -1,8 +1,8 @@
- - + +
↕Size: 2 bytes = 0x2
schema
catapult model
schema
catapult model

Enumeration of receipt types.

diff --git a/source/serialization/RestrictionRule.html b/source/serialization/RestrictionRule.html index 8663b2810..b906776ab 100644 --- a/source/serialization/RestrictionRule.html +++ b/source/serialization/RestrictionRule.html @@ -1,8 +1,8 @@
- - + +
↕Size: 17 bytes = 0x11
schema
catapult model
schema
catapult model

binary layout of restriction rule being applied

diff --git a/source/serialization/RootNamespaceHistory.html b/source/serialization/RootNamespaceHistory.html index bbf753c88..32d11cb4a 100644 --- a/source/serialization/RootNamespaceHistory.html +++ b/source/serialization/RootNamespaceHistory.html @@ -1,7 +1,7 @@
- +
↕Size: 91+ bytes = 0x5b+ (variable)
schema
schema

binary layout for non-historical root namespace history

diff --git a/source/serialization/SecretLockInfo.html b/source/serialization/SecretLockInfo.html index 917273295..ebac109cd 100644 --- a/source/serialization/SecretLockInfo.html +++ b/source/serialization/SecretLockInfo.html @@ -1,8 +1,8 @@
- - + +
↕Size: 108 bytes = 0x6c
schema
catapult model
schema
catapult model

binary layout for serialized lock transaction

diff --git a/source/serialization/SecretLockTransaction.html b/source/serialization/SecretLockTransaction.html index 0dd608925..39b746796 100644 --- a/source/serialization/SecretLockTransaction.html +++ b/source/serialization/SecretLockTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 212 bytes = 0xd4
schema
catapult model
schema
catapult model

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.

diff --git a/source/serialization/SecretLockTransactionBody.html b/source/serialization/SecretLockTransactionBody.html index 850bf7439..7ef7c3194 100644 --- a/source/serialization/SecretLockTransactionBody.html +++ b/source/serialization/SecretLockTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 81 bytes = 0x51
schema
catapult model
schema
catapult model

Shared content between SecretLockTransaction and EmbeddedSecretLockTransaction.

diff --git a/source/serialization/SecretProofTransaction.html b/source/serialization/SecretProofTransaction.html index 6a1a1cbeb..ce306ac6f 100644 --- a/source/serialization/SecretProofTransaction.html +++ b/source/serialization/SecretProofTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 190+ bytes = 0xbe+ (variable)
schema
catapult model
schema
catapult model

Conclude a token swap between different chains.
Use a SecretProofTransaction to unlock the funds locked by a SecretLockTransaction.
The transaction must prove knowing the proof that unlocks the mosaics.

diff --git a/source/serialization/SecretProofTransactionBody.html b/source/serialization/SecretProofTransactionBody.html index 94f022ab5..ae15ef419 100644 --- a/source/serialization/SecretProofTransactionBody.html +++ b/source/serialization/SecretProofTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 59+ bytes = 0x3b+ (variable)
schema
catapult model
schema
catapult model

Shared content between SecretProofTransaction and EmbeddedSecretProofTransaction.

diff --git a/source/serialization/SizePrefixedEntity.html b/source/serialization/SizePrefixedEntity.html index e73c46803..c0050195d 100644 --- a/source/serialization/SizePrefixedEntity.html +++ b/source/serialization/SizePrefixedEntity.html @@ -1,8 +1,8 @@
- - + +
↕Size: 4 bytes = 0x4
schema
catapult model
schema
catapult model

Serialization of an entity that has its size stated as a prefix (header).

diff --git a/source/serialization/StateHeader.html b/source/serialization/StateHeader.html index abb40a7d6..1bf3b6439 100644 --- a/source/serialization/StateHeader.html +++ b/source/serialization/StateHeader.html @@ -1,7 +1,7 @@
- +
↕Size: 2 bytes = 0x2
schema
schema

header common to all serialized states

diff --git a/source/serialization/Transaction.html b/source/serialization/Transaction.html index 7fd4094df..9c5319ff1 100644 --- a/source/serialization/Transaction.html +++ b/source/serialization/Transaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 128 bytes = 0x80
schema
catapult model
schema
catapult model

binary layout for a transaction

diff --git a/source/serialization/TransactionType.html b/source/serialization/TransactionType.html index 4be135ae7..93d5bed20 100644 --- a/source/serialization/TransactionType.html +++ b/source/serialization/TransactionType.html @@ -1,7 +1,7 @@
- +
↕Size: 2 bytes = 0x2
schema
schema

Enumeration of Transaction types

diff --git a/source/serialization/TransferTransaction.html b/source/serialization/TransferTransaction.html index 2fe37ac1d..a81e691e8 100644 --- a/source/serialization/TransferTransaction.html +++ b/source/serialization/TransferTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 163+ bytes = 0xa3+ (variable)
schema
catapult model
schema
catapult model

Send mosaics and messages between two accounts.

diff --git a/source/serialization/TransferTransactionBody.html b/source/serialization/TransferTransactionBody.html index 5724c6966..f118c5d07 100644 --- a/source/serialization/TransferTransactionBody.html +++ b/source/serialization/TransferTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 32+ bytes = 0x20+ (variable)
schema
catapult model
schema
catapult model

Shared content between TransferTransaction and EmbeddedTransferTransaction.

diff --git a/source/serialization/UnresolvedMosaic.html b/source/serialization/UnresolvedMosaic.html index b6faaf4af..011467215 100644 --- a/source/serialization/UnresolvedMosaic.html +++ b/source/serialization/UnresolvedMosaic.html @@ -1,7 +1,7 @@
- +
↕Size: 16 bytes = 0x10
schema
schema

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 index 7fe89a79a..bfdb92fe9 100644 --- a/source/serialization/VerifiableEntity.html +++ b/source/serialization/VerifiableEntity.html @@ -1,8 +1,8 @@
- - + +
↕Size: 68 bytes = 0x44
schema
catapult model
schema
catapult model

Serialization of an entity that should be signed by an account.

diff --git a/source/serialization/VotingKeyLinkTransaction.html b/source/serialization/VotingKeyLinkTransaction.html index 1d9db994e..3652010f3 100644 --- a/source/serialization/VotingKeyLinkTransaction.html +++ b/source/serialization/VotingKeyLinkTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 172 bytes = 0xac
schema
catapult model
schema
catapult model

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.

diff --git a/source/serialization/VotingKeyLinkTransactionBody.html b/source/serialization/VotingKeyLinkTransactionBody.html index 8834b737d..fbfee6ac4 100644 --- a/source/serialization/VotingKeyLinkTransactionBody.html +++ b/source/serialization/VotingKeyLinkTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 41 bytes = 0x29
schema
catapult model
schema
catapult model

Shared content between VotingKeyLinkTransaction and EmbeddedVotingKeyLinkTransaction.

diff --git a/source/serialization/VrfKeyLinkTransaction.html b/source/serialization/VrfKeyLinkTransaction.html index f9ecdb5b8..7d8932da5 100644 --- a/source/serialization/VrfKeyLinkTransaction.html +++ b/source/serialization/VrfKeyLinkTransaction.html @@ -1,8 +1,8 @@
- - + +
↕Size: 164 bytes = 0xa4
schema
catapult model
schema
catapult model

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.

diff --git a/source/serialization/VrfKeyLinkTransactionBody.html b/source/serialization/VrfKeyLinkTransactionBody.html index c849af99e..aa00617e1 100644 --- a/source/serialization/VrfKeyLinkTransactionBody.html +++ b/source/serialization/VrfKeyLinkTransactionBody.html @@ -1,8 +1,8 @@
- - + +
↕Size: 33 bytes = 0x21
schema
catapult model
schema
catapult model

Shared content between VrfKeyLinkTransaction and EmbeddedVrfKeyLinkTransaction.

diff --git a/source/serialization/VrfProof.html b/source/serialization/VrfProof.html index c554a1ec5..dd12695d3 100644 --- a/source/serialization/VrfProof.html +++ b/source/serialization/VrfProof.html @@ -1,8 +1,8 @@
- - + +
↕Size: 80 bytes = 0x50
schema
catapult model
schema
catapult model

verfiable random function proof

diff --git a/source/serialization/index.rst b/source/serialization/index.rst index 70969d7cb..5539b9500 100644 --- a/source/serialization/index.rst +++ b/source/serialization/index.rst @@ -2,7 +2,9 @@ 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 diff --git a/source/server.rst b/source/server.rst index 8e10f2bca..f68644e11 100644 --- a/source/server.rst +++ b/source/server.rst @@ -47,5 +47,5 @@ Instructions on how to launch a secure and production-ready private chain will b .. |instructions| raw:: html - instructions + instructions