Function validateBurn

  • Validates a token burn.

    Returns

    A promise that resolves to true if the burning is valid.

    Throws

    If any token amount is not compatible with the token.

    Throws

    If the token is paused.

    Throws

    If the the token if not burnable.

    Throws

    If the sender has insufficent amount of tokens for the burn.

    Parameters

    • token: Token

      The token to burn.

    • amounts: TokenAmount | TokenAmount[]

      The amounts of tokens to burn.

    • sender: AccountAddress | AccountInfo

    Returns Promise<true>

Generated using TypeDoc