Viewing File: /home/ubuntu/efiexchange-node-base/node_modules/@solana/spl-token/src/actions/burnChecked.ts
import type { ConfirmOptions, Connection, PublicKey, Signer, TransactionSignature } from '@solana/web3.js';
import { sendAndConfirmTransaction, Transaction } from '@solana/web3.js';
import { TOKEN_PROGRAM_ID } from '../constants.js';
import { createBurnCheckedInstruction } from '../instructions/burnChecked.js';
import { getSigners } from './internal.js';
/**
* Burn tokens from an account, asserting the token mint and decimals
*
* @param connection Connection to use
* @param payer Payer of the transaction fees
* @param account Account to burn tokens from
* @param mint Mint for the account
* @param owner Account owner
* @param amount Amount to burn
* @param decimals Number of decimals in amount to burn
* @param multiSigners Signing accounts if `owner` is a multisig
* @param confirmOptions Options for confirming the transaction
* @param programId SPL Token program account
*
* @return Signature of the confirmed transaction
*/
export async function burnChecked(
connection: Connection,
payer: Signer,
account: PublicKey,
mint: PublicKey,
owner: Signer | PublicKey,
amount: number | bigint,
decimals: number,
multiSigners: Signer[] = [],
confirmOptions?: ConfirmOptions,
programId = TOKEN_PROGRAM_ID,
): Promise<TransactionSignature> {
const [ownerPublicKey, signers] = getSigners(owner, multiSigners);
const transaction = new Transaction().add(
createBurnCheckedInstruction(account, mint, ownerPublicKey, amount, decimals, multiSigners, programId),
);
return await sendAndConfirmTransaction(connection, transaction, [payer, ...signers], confirmOptions);
}
Back to Directory
File Manager