-
Notifications
You must be signed in to change notification settings - Fork 206
Asset Descriptor v1.0
Sasha edited this page Jun 16, 2020
·
19 revisions
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.
- 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.
Each standard property is stored in the dedicated field.
Currency name
Small coin name
Small to currency ratio
- The metadata should be serialized in a JSON format as a series of optional properties (see the list below)
- The total size of the metadata cannot exceed 16 Kbytes
The optional properties are:
-
json-schema-version
: numeric values, separated by dots. Currently, the only value allowed is1.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 eitherfixed
orvariable
-
website-url
: a URL of the asset website -
pdf-url
: URL for the description paper -
large-logo-png-url
: URL of the 1024x1024 pixels logo (can be used for printing) -
medium-logo-png-url
: URL of the 512x512 pixels logo (can be used for website banners) -
small-logo-png-url
: URL of the 128x128 pixels logo (can be used for icons) -
favicon-ico-url
: URL of the favicon -
large-logo-svg
: URL of the logo in vector format