Skip to content

Asset Descriptor v1.0

Sasha edited this page Jun 16, 2020 · 19 revisions

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.

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

  • Each standard property should be specified in English letters, serialized as a simple name=value set of pairs, delimited with ;

Standard properties list

  • 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 metadata

  • The metadata should be serialized as a simple name=value set of pairs, delimited with ;
  • The total size of the metadata cannot exceed 16 Kbytes
  • Every description should be in English

Optional properties list

  • schema-version: numeric values, separated by dots. Currently, the only value allowed is 1.0, specified in this document,
  • short-description: a one-liner, should not exceed 128 characters.
  • long-description: a paragraph, should not exceed 512 characters.
  • emission-type: should be either fixed or variable
  • smallest-to-regular-ratio: the number that represents the ratio of the smallest asset unit to regular unit (example: 100000000).
  • website-url: a URL of the asset website
  • pdf-url: URL for the description paper
  • favicon-ico-url: URL of the favicon
  • logo-svg: URL of the logo in vector format
Clone this wiki locally