Type alias TokenModuleAccountState

TokenModuleAccountState: {
    allowList?: boolean;
    available?: Type;
    denyList?: boolean;
    locks?: AccountLockAmount[];
    [key: string]: unknown;
}

The account state represents account-specific information that is maintained by the Token Module, and is returned as part of a GetAccountInfo query. It does not include state that is managed by the Token Kernel, such as the token identifier and account balance.

All 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 account is on the allow list.

  • Optional available?: Type

    The total unencumbered balance on the account. Introduced in protocol version 11.

  • Optional denyList?: boolean

    Whether the account is on the deny list.

  • Optional locks?: AccountLockAmount[]

    Locks that control funds associated with the account. Introduced in protocol version 11.

Settings

Member Visibility

Theme

Generated using TypeDoc