Namespace Schemas

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.

Address Alias

AddressAliasTransaction

Announce an AliasTransaction to attach a namespace to an account. A namespace can be assigned to any account present in the network.

Version: 0x01

EntityType: 0x424E

Inlines:

Property Type Description
namespaceId NamespaceId Identifier of the namespace that will become an alias.
address Address Aliased address.
aliasAction AliasAction Alias action.

Mosaic Alias

MosaicAliasTransaction

Announce an AliasTransaction to attach a namespace to a mosaic. Setting an alias to a mosaic is only possible if the account announcing the transaction has created the namespace and mosaic involved.

Version: 0x01

EntityType: 0x434E

Inlines:

Property Type Description
namespaceId NamespaceId Identifier of the namespace that will become an alias.
mosaicId MosaicId Aliased mosaic identifier.
aliasAction AliasAction Alias action.

Namespace Receipts

NamespaceExpiryReceipt

A namespace expired.

  • version: 0x1
  • basicType: 0x4

Inlines:

Property Type Description
artifactId NamespaceId Namespace identifier.

Namespace Registration

NamespaceRegistrationTransaction

Announce a NamespaceRegistrationTransaction to register and re-rent a namespace.

Version: 0x01

EntityType: 0x414E

Inlines:

Property Type Description
duration BlockDuration Number of confirmed blocks you would like to rent the namespace for. Required for root namespaces.
parentId NamespaceId Parent namespace identifier. Required for subnamespaces.
id NamespaceId Namespace identifier.
registrationType NamespaceRegistrationType Namespace registration type.
nameSize uint8 Namespace name size in bytes.
name array(bytes, namespaceNameSize) Namespace name.

Namespace Types

NamespaceRegistrationType

Enumeration: uint8

Id Description
0 Root namespace.
1 Child namespace.

AliasAction

Enumeration: uint8

Id Description
0x00 Link alias.
0x01 Unlink alias.