Function burn

  • Burns a specified amount of tokens.

    Returns

    A promise that resolves to the transaction hash.

    Throws

    If opts.validate and the token amount is not compatible with the token.

    Throws

    If opts.validate and the token is paused.

    Throws

    If opts.validate and the token is not burnable.

    Throws

    If opts.validate and the sender has insufficent amount of tokens for the burn.

    Parameters

    • token: Token

      The token to burn.

    • sender: AccountAddress

      The account address of the sender.

    • amounts: TokenAmount | TokenAmount[]

      The amount(s) of tokens to burn.

    • signer: AccountSigner

      The signer responsible for signing the transaction.

    • Optional metadata: TokenUpdateMetadata
    • Optional [opts={: SupplyUpdateOptions = {}

      autoScale: true, validate: false }] - Options for supply update operations.

    Returns Promise<Type>

Settings

Member Visibility

Theme

Generated using TypeDoc