Function createBurnInstruction

  • createBurnInstruction(account, mint, owner, amount, multiSigners?, programId?): TransactionInstruction

  • Construct a Burn instruction

    Parameters

    • account: PublicKey

      Account to burn tokens from

    • mint: PublicKey

      Mint for the account

    • owner: PublicKey

      Owner of the account

    • amount: number | bigint

      Number of tokens to burn

    • multiSigners: (PublicKey | Signer)[] = []

      Signing accounts if owner is a multisig

    • programId: PublicKey = TOKEN_PROGRAM_ID

      SPL Token program account

    Returns TransactionInstruction

    Instruction to add to a transaction

Settings

Member Visibility

Theme

Generated using TypeDoc