Type alias TokenCategory

TokenCategory: {
    category: string;
    decimals?: number;
    nfts?: NftCategory;
    symbol: string;
}

A definition specifying information about an identity's token category.

Type declaration

  • category: string

    The current token category used by this identity. Often, this will be equal to the identity's authbase, but some token identities must migrate to new categories for technical reasons.

  • Optional decimals?: number

    An integer between 0 and 18 (inclusive) indicating the divisibility of the primary unit of this token category.

    This is the number of digits that can appear after the decimal separator in fungible token amounts. For a token category with a symbol of SYMBOL and a decimals of 2, a fungible token amount of 12345 should be displayed as 123.45 SYMBOL.

    If omitted, defaults to 0.

  • Optional nfts?: NftCategory

    Display information for non-fungible tokens (NFTs) of this identity. Omitted for token categories without NFTs.

  • symbol: string

    An abbreviation used to uniquely identity this token category.

    Symbols must be comprised only of capital letters, numbers, and dashes (-). This can be validated with the regular expression: /^[-A-Z0-9]+$/.

Generated using TypeDoc