Type alias TokenModuleState

TokenModuleState: {
    allowList?: boolean;
    burnable?: boolean;
    denyList?: boolean;
    governanceAccount: Type;
    metadata: Type;
    mintable?: boolean;
    name: string;
    paused?: boolean;
    [key: string]: unknown;
}

The Token Module state represents global state information that is maintained by the Token Module, and is returned as part of a GetTokenInfo query. It does not include state that is managed by the Token Kernel, such as the token identifier, global supply and governance account. It also does not (typically) include account-specific state, which is returned as part of GetAccountInfo instead.

The "name" and "metadata" fields are required. Other fields are optional, and can be omitted if the module implementation does not support them. The structure supports additional fields for future extensibility. Non-standard fields (i.e. any fields that are not defined by a standard, and are specific to the module implementation) may be included, and their tags should be prefixed with an underscore ("_") to distinguish them as such.

Type declaration

  • [key: string]: unknown
  • Optional allowList?: boolean

    Whether the token supports an allow list

  • Optional burnable?: boolean

    Whether the token is burnable

  • Optional denyList?: boolean

    Whether the token supports an deny list

  • governanceAccount: Type

    The governance account for the token.

  • metadata: Type

    A URL pointing to the metadata of the token.

  • Optional mintable?: boolean

    Whether the token is mintable

  • name: string

    The name of the token.

  • Optional paused?: boolean

    Whether the token operations are paused or not.

Settings

Member Visibility

Theme

Generated using TypeDoc