Function burn

  • burn(connection, payer, account, mint, owner, amount, multiSigners?, confirmOptions?, programId?): Promise<TransactionSignature>

  • Burn tokens from an account

    Parameters

    • connection: Connection

      Connection to use

    • payer: Signer

      Payer of the transaction fees

    • account: PublicKey

      Account to burn tokens from

    • mint: PublicKey

      Mint for the account

    • owner: PublicKey | Signer

      Account owner

    • amount: number | bigint

      Amount to burn

    • multiSigners: Signer[] = []

      Signing accounts if owner is a multisig

    • Optional confirmOptions: ConfirmOptions

      Options for confirming the transaction

    • programId: PublicKey = TOKEN_PROGRAM_ID

      SPL Token program account

    Returns Promise<TransactionSignature>

    Signature of the confirmed transaction

Settings

Member Visibility

Theme

Generated using TypeDoc