@unclaimedsol/spl-burn-close-sdk 1.2.0 → 1.2.2

package/README.md

@@ -1,14 +1,16 @@
 # Burn and Close Solana SPL Tokens SDK
 
-A lightweight Solana SDK to **burn SPL tokens and close token accounts** with a **fixed 5%** protocol fee.
+A lightweight Solana SDK to **burn SPL tokens and close token accounts** with the June 2026 Unclaimed SOL token cleanup fee policy.
 This library only **builds unsigned transactions** – you handle signing and sending them, whether in the browser (Wallet Adapter) or server (Keypair).
 
 ## ✨ Features
 
 - 🔥 Burn all tokens in provided ATAs.
 - 🧹 Close token accounts, reclaiming rent to the user.
-- 💸 Automatic 5% protocol fee (hardcoded in program).
+- 💸 On-chain fee recipient is enforced by the program.
+- 🧾 Standard token cleanup lets the user keep up to 0.002 SOL per closed account; normal-account fee is 39,280 lamports.
 - ⚡ Automatic batching (default 12 ATAs per transaction).
+- 🪙 Supports SPL Token and Token-2022.
 - 🔐 Supports **frontend partial signing** and **backend full signing** workflows.
 - 🚀 No hidden config: single function to integrate.
 
@@ -18,7 +20,7 @@ This library only **builds unsigned transactions** – you handle signing and se
 
 1. The SDK prepares TransactionInstructions for your on-chain burn+close program.
 2. Program burns tokens in each ATA, then closes it, sending rent back to the owner.
-3. A 5% fee is enforced on-chain and sent to the hardcoded recipient.
+3. The program sends recovered rent above 2,000,000 lamports per successfully closed account to the hardcoded fee recipient.
 4. The SDK never asks for private keys — you sign & send transactions yourself.
 
 ---
@@ -29,7 +31,7 @@ This library only **builds unsigned transactions** – you handle signing and se
 npm i @unclaimedsol/spl-burn-close-sdk
 ```
 
-We use @solana/web3.js in peerDependencies to avoid version conflicts. So, make sure you already have it installed.
+We use @solana/web3.js in peerDependencies to avoid version conflicts, so make sure you already have it installed.
 
 Requires Node 18+.
 
@@ -40,7 +42,7 @@ Requires Node 18+.
 ### Signing with Keypair
 
 ```typescript
-import { Connection, Keypair } from "@solana/web3.js";
+import { Connection, Keypair, PublicKey } from "@solana/web3.js";
 import {
   buildBurnAndCloseTransactions,
   PROGRAM_ID,
@@ -82,6 +84,7 @@ import { Connection, PublicKey } from "@solana/web3.js";
 import {
   buildBurnAndCloseTransactions,
   PROGRAM_ID,
+  TOKEN_2022_PROGRAM_ID,
 } from "@unclaimedsol/spl-burn-close-sdk";
 
 const connection = new Connection("https://api.mainnet-beta.solana.com");
@@ -100,6 +103,16 @@ const txs = await buildBurnAndCloseTransactions(
   pairs
 );
 
+// For Token-2022 accounts, pass TOKEN_2022_PROGRAM_ID and consider using a smaller chunkSize:
+// const txs = await buildBurnAndCloseTransactions(
+//   connection,
+//   PROGRAM_ID,
+//   user,
+//   pairs,
+//   { chunkSize: 2 },
+//   TOKEN_2022_PROGRAM_ID
+// );
+
 // Sign
 const signed = wallet.signAllTransactions
   ? await wallet.signAllTransactions(txs)
@@ -107,7 +120,7 @@ const signed = wallet.signAllTransactions
 
 // Send
 for (const stx of signed) {
-  const sig = await connection.sendRawTransaction(tx.serialize());
+  const sig = await connection.sendRawTransaction(stx.serialize());
   let latestBlockhash = await connection.getLatestBlockhash(
     connection.commitment
   );
@@ -122,6 +135,13 @@ for (const stx of signed) {
 
 ---
 
+## 🌐 Cluster support
+
+This SDK targets the Unclaimed SOL mainnet program (`PROGRAM_ID`) and fee recipient (`FEE_RECIPIENT`).
+Transactions will only succeed on a cluster where that program is deployed.
+
+---
+
 ## 💻 Demo
 
 There is a nice tutorial guide with a demo repository that shows the usage of the SDK to burn and close all token accounts for the wallet. You can find it [here](https://blog.unclaimedsol.com/close-burn-solana-tokens-web3js-sdk/).

package/dist/index.cjs

@@ -1,9 +1,15 @@
-import { PublicKey, SystemProgram, Transaction, TransactionInstruction, } from "@solana/web3.js";
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TOKEN_2022_PROGRAM_ID = exports.TOKEN_PROGRAM_ID = exports.FEE_RECIPIENT = exports.PROGRAM_ID = void 0;
+exports.buildBurnAndCloseTransactions = buildBurnAndCloseTransactions;
+exports.buildBurnAndCloseInstruction = buildBurnAndCloseInstruction;
+const web3_js_1 = require("@solana/web3.js");
 /** Exporting on-chain program ID for convenience */
-const PROGRAM_ID = new PublicKey("UNCaXzXkR3vp8mbCJyxWUvwuRk5uHgzrwe6jcWPfiUR");
+exports.PROGRAM_ID = new web3_js_1.PublicKey("UNCaXzXkR3vp8mbCJyxWUvwuRk5uHgzrwe6jcWPfiUR");
 /** Hardcoded fee recipient on-chain expectation */
-const FEE_RECIPIENT = new PublicKey("uncNCRycMtNPj2kXHfwiCgNrzCTnC9xU5FS8ZeWyn3M");
-const TOKEN_PROGRAM_ID = new PublicKey("TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA");
+exports.FEE_RECIPIENT = new web3_js_1.PublicKey("uncNCRycMtNPj2kXHfwiCgNrzCTnC9xU5FS8ZeWyn3M");
+exports.TOKEN_PROGRAM_ID = new web3_js_1.PublicKey("TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA");
+exports.TOKEN_2022_PROGRAM_ID = new web3_js_1.PublicKey("TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb");
 /**
  * Build *unsigned* transactions that call the on-chain burn+close program.
  * You sign and send them yourself (frontend wallet or backend keypair).
@@ -16,11 +22,11 @@ const TOKEN_PROGRAM_ID = new PublicKey("TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ
  * @param tokenProgramId  Support for multiple Token programs
  * @returns               Array of *unsigned* Transaction objects
  */
-export async function buildBurnAndCloseTransactions(connection, programId, user, pairs, options = {}, tokenProgramId = TOKEN_PROGRAM_ID) {
+async function buildBurnAndCloseTransactions(connection, programId, user, pairs, options = {}, tokenProgramId = exports.TOKEN_PROGRAM_ID) {
     if (!pairs.length)
         return [];
     const chunkSize = Math.max(1, options.chunkSize ?? 12);
-    const commitment = options.commitment ?? "processed";
+    const commitment = options.commitment ?? "confirmed";
     const feePayer = options.feePayer ?? user;
     // Split into chunks so we stay under CU / account limits
     const chunks = [];
@@ -28,35 +34,31 @@ export async function buildBurnAndCloseTransactions(connection, programId, user,
         chunks.push(pairs.slice(i, i + chunkSize));
     }
     // Instruction data: [selector=0]
-    const data = Buffer.from([0]);
+    // Use Uint8Array (browser-safe) and cast for web3.js' Buffer typing.
+    const data = new Uint8Array([0]);
+    const recentBlockhash = options.recentBlockhash ??
+        (await connection.getLatestBlockhash({ commitment })).blockhash;
     const txs = [];
     for (const chunk of chunks) {
         const keys = [
             // NOTE: Mark the user as signer in the instruction meta;
             // the caller must actually sign the Transaction later.
-            { pubkey: FEE_RECIPIENT, isSigner: false, isWritable: true },
+            { pubkey: exports.FEE_RECIPIENT, isSigner: false, isWritable: true },
             { pubkey: user, isSigner: true, isWritable: true },
             { pubkey: tokenProgramId, isSigner: false, isWritable: false },
-            { pubkey: SystemProgram.programId, isSigner: false, isWritable: false },
+            { pubkey: web3_js_1.SystemProgram.programId, isSigner: false, isWritable: false },
         ];
         for (const { mint, ata } of chunk) {
             keys.push({ pubkey: mint, isSigner: false, isWritable: true }, { pubkey: ata, isSigner: false, isWritable: true });
         }
-        const ix = new TransactionInstruction({
+        const ix = new web3_js_1.TransactionInstruction({
             programId,
             keys,
             data,
         });
-        const tx = new Transaction().add(ix);
+        const tx = new web3_js_1.Transaction().add(ix);
         tx.feePayer = feePayer;
-        // Use provided blockhash or fetch one
-        if (options.recentBlockhash) {
-            tx.recentBlockhash = options.recentBlockhash;
-        }
-        else {
-            const { blockhash } = await connection.getLatestBlockhash({ commitment });
-            tx.recentBlockhash = blockhash;
-        }
+        tx.recentBlockhash = recentBlockhash;
         txs.push(tx);
     }
     return txs;
@@ -69,28 +71,28 @@ export async function buildBurnAndCloseTransactions(connection, programId, user,
  * create or sign full transactions — it only constructs one
  * instruction for a batch of (mint, ATA) pairs.
  */
-export async function buildBurnAndCloseInstruction(programId, user, pairs, tokenProgramId) {
+async function buildBurnAndCloseInstruction(programId, user, pairs, tokenProgramId) {
     if (!pairs.length) {
         return null;
     }
     // instruction data selector: 0 = burn_and_close_token_accounts
-    const data = Buffer.from([0]);
+    const data = new Uint8Array([0]);
     // accounts order MUST match the on-chain program's expectation:
-    // [0] fee_payer_account (your fee recipient)
+    // [0] fee_recipient_account (your fee recipient)
     // [1] user_wallet_account (the signer)
     // [2] token_program_account (SPL Token program or Token-2022 program)
     // [3] system_program_account
     // then repeating (mint, ata) pairs, both writable
     const keys = [
-        { pubkey: FEE_RECIPIENT, isSigner: false, isWritable: true },
+        { pubkey: exports.FEE_RECIPIENT, isSigner: false, isWritable: true },
         { pubkey: user, isSigner: true, isWritable: true },
         { pubkey: tokenProgramId, isSigner: false, isWritable: false },
-        { pubkey: SystemProgram.programId, isSigner: false, isWritable: false },
+        { pubkey: web3_js_1.SystemProgram.programId, isSigner: false, isWritable: false },
     ];
     for (const { mint, ata } of pairs) {
         keys.push({ pubkey: mint, isSigner: false, isWritable: true }, { pubkey: ata, isSigner: false, isWritable: true });
     }
-    return new TransactionInstruction({
+    return new web3_js_1.TransactionInstruction({
         programId,
         keys,
         data,

package/dist/index.d.ts

@@ -4,6 +4,7 @@ export declare const PROGRAM_ID: PublicKey;
 /** Hardcoded fee recipient on-chain expectation */
 export declare const FEE_RECIPIENT: PublicKey;
 export declare const TOKEN_PROGRAM_ID: PublicKey;
+export declare const TOKEN_2022_PROGRAM_ID: PublicKey;
 export type Pair = {
     mint: PublicKey;
     ata: PublicKey;
@@ -20,7 +21,7 @@ export type BuildOptions = {
     feePayer?: PublicKey;
     /**
      * Provide your own recent blockhash (advanced). If omitted,
-     * we fetch a fresh one per transaction.
+     * we fetch a fresh one and reuse it for all built transactions.
      */
     recentBlockhash?: string;
 };

package/dist/index.js

@@ -4,6 +4,7 @@ export const PROGRAM_ID = new PublicKey("UNCaXzXkR3vp8mbCJyxWUvwuRk5uHgzrwe6jcWP
 /** Hardcoded fee recipient on-chain expectation */
 export const FEE_RECIPIENT = new PublicKey("uncNCRycMtNPj2kXHfwiCgNrzCTnC9xU5FS8ZeWyn3M");
 export const TOKEN_PROGRAM_ID = new PublicKey("TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA");
+export const TOKEN_2022_PROGRAM_ID = new PublicKey("TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb");
 /**
  * Build *unsigned* transactions that call the on-chain burn+close program.
  * You sign and send them yourself (frontend wallet or backend keypair).
@@ -20,7 +21,7 @@ export async function buildBurnAndCloseTransactions(connection, programId, user,
     if (!pairs.length)
         return [];
     const chunkSize = Math.max(1, options.chunkSize ?? 12);
-    const commitment = options.commitment ?? "processed";
+    const commitment = options.commitment ?? "confirmed";
     const feePayer = options.feePayer ?? user;
     // Split into chunks so we stay under CU / account limits
     const chunks = [];
@@ -28,7 +29,10 @@ export async function buildBurnAndCloseTransactions(connection, programId, user,
         chunks.push(pairs.slice(i, i + chunkSize));
     }
     // Instruction data: [selector=0]
-    const data = Buffer.from([0]);
+    // Use Uint8Array (browser-safe) and cast for web3.js' Buffer typing.
+    const data = new Uint8Array([0]);
+    const recentBlockhash = options.recentBlockhash ??
+        (await connection.getLatestBlockhash({ commitment })).blockhash;
     const txs = [];
     for (const chunk of chunks) {
         const keys = [
@@ -49,14 +53,7 @@ export async function buildBurnAndCloseTransactions(connection, programId, user,
         });
         const tx = new Transaction().add(ix);
         tx.feePayer = feePayer;
-        // Use provided blockhash or fetch one
-        if (options.recentBlockhash) {
-            tx.recentBlockhash = options.recentBlockhash;
-        }
-        else {
-            const { blockhash } = await connection.getLatestBlockhash({ commitment });
-            tx.recentBlockhash = blockhash;
-        }
+        tx.recentBlockhash = recentBlockhash;
         txs.push(tx);
     }
     return txs;
@@ -74,9 +71,9 @@ export async function buildBurnAndCloseInstruction(programId, user, pairs, token
         return null;
     }
     // instruction data selector: 0 = burn_and_close_token_accounts
-    const data = Buffer.from([0]);
+    const data = new Uint8Array([0]);
     // accounts order MUST match the on-chain program's expectation:
-    // [0] fee_payer_account (your fee recipient)
+    // [0] fee_recipient_account (your fee recipient)
     // [1] user_wallet_account (the signer)
     // [2] token_program_account (SPL Token program or Token-2022 program)
     // [3] system_program_account

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@unclaimedsol/spl-burn-close-sdk",
-  "version": "1.2.0",
-  "description": "SDK to burn and close SPL token accounts via the Unclaimed SOL program (with a built-in 5% fee).",
+  "version": "1.2.2",
+  "description": "SDK to burn and close SPL token accounts via the Unclaimed SOL program with benchmarked rent cleanup fees.",
   "license": "MIT",
   "author": "Unclaimed SOL",
   "type": "module",
@@ -28,13 +28,14 @@
     "README.md"
   ],
   "scripts": {
-    "build": "tsc -p tsconfig.json && node ./scripts/build-cjs.js",
+    "build": "tsc -p tsconfig.json && tsc -p tsconfig.cjs.json && node ./scripts/build-cjs.js",
     "prepublishOnly": "npm run build"
   },
-  "dependencies": {
+  "peerDependencies": {
     "@solana/web3.js": "^1.98.4"
   },
   "devDependencies": {
+    "@solana/web3.js": "^1.98.4",
     "typescript": "^5.6.3"
   },
   "engines": {