Asset Descriptor v1.0

Abstract

The assets are described here

This document's purpose is to specify the asset metadata, to enable 3rd party tools to consume and display the subset of asset-related information in a simple and well-standardized manner.

General notes

• The metadata should be serialized as a simple name=value set of pairs, delimited with ;
• The keyN=valueN; sequence must be preceded with STD: prefix, there is no need for ; at the sequence end
• The total size of the metadata cannot exceed 16 Kbytes
• Every description should be in English

Each asset has 2 groups of properties:

• Standard properties
• Optional properties

WARNING: Both types of properties are immutable and can't be changed after the asset is created. Therefore, it is strongly recommended to double-check the values before starting the asset distribution.

Standard properties, mandatory

• N= Human-readable asset name, for example Beam Coin
• SN= Human-readable short name/asset code, for example BEAM
• UN= Human-readable asset unit name, for example Beam
• NTHUN= Human-readable smallest asset unit name (nth-unit name), for example Groth

Optional properties

• OPT_SCHEMA_VERSION= numeric values, separated by dots. Currently, the only value allowed is 1.0, specified in this document
• OPT_SHORT_DESCRIPTION= a one-liner, should not exceed 128 characters
• OPT_LONG_DESCRIPTION= a paragraph, should not exceed 1024 characters
• OPT_SMALLEST_TO_REGULAR_RATIO= the number that represents the ratio of the smallest asset unit to regular unit (example: 100000000)
• OPT_WEBSITE_URL= a URL of the asset website
• OPT_PDF_URL= URL for the description paper
• OPT_FAVICON_ICO_URL= URL of the favicon
• OPT_LOGO_SVG= URL of the logo in vector format