@w3lib/solana-batch-call 0.5.0 → 0.6.0

package/src/subpaths/reclaim.ts

@@ -0,0 +1,57 @@
+/**
+ * 账户回收（子路径 `@w3lib/solana-batch-call/reclaim`）：扫描钱包里关闭后能退回租金（SOL）的账户并批量关闭：空的代币账户、垃圾币（销毁后关闭）、
+ * Wrapped SOL（解包）、已清空的 Orca Whirlpool / Raydium CLMM 仓位。给出每项和合计能拿回多少 lamports，发送前用 /simulate 模拟。
+ * 不放在主入口，不用时打包不会带上这部分代码；发送的代码按需加载。
+ *
+ * ```ts
+ * import { getReclaimable, reclaim } from '@w3lib/solana-batch-call/reclaim'
+ *
+ * const r = await getReclaimable(owner, { provider: 'https://my-rpc…' })
+ * r.totalLamports                                          // 全部能拿回的 lamports
+ * const { simulation, results } = await reclaim(client, key, r.items.filter((i) => i.selected))
+ * ```
+ */
+import { reclaimable, type Reclaimable, type ReclaimQuery } from '../reclaim.js'
+import { resolve, type ShortcutOptions } from '../shortcuts.js'
+
+export {
+  buildReclaim,
+  reclaim,
+  reclaimable,
+  simulateReclaim,
+  type BuildReclaimOptions,
+  type JunkContext,
+  type ReclaimBlocker,
+  type ReclaimCall,
+  type ReclaimCallResult,
+  type ReclaimItem,
+  type ReclaimKind,
+  type ReclaimOptions,
+  type ReclaimPlan,
+  type ReclaimQuery,
+  type ReclaimResult,
+  type ReclaimSimulation,
+  type ReclaimSimulationOptions,
+  type Reclaimable,
+} from '../reclaim.js'
+export type { PlanSimulation } from '../batchPlan.js'
+export { burnChecked, closeAccount, harvestWithheldTokensToMint } from '../write/instructions.js'
+
+export interface GetReclaimableOptions extends ReclaimQuery, ShortcutOptions {}
+
+/**
+ * 扫描钱包里能回收租金的账户，节点参数与 getBalances 相同。默认列出全部代币账户（需要支持 getTokenAccountsByOwner 的节点），
+ * 免费公共节点传 `mints` 只看指定代币的 ATA。
+ *
+ * ```ts
+ * const r = await getReclaimable(owner, { provider: 'https://my-rpc…' })
+ * // { totalLamports: '45862080', selectedLamports: '41302080',
+ * //   items: [{ kind: 'empty-token', account, mint, lamports: '2039280', selected: true, reasons: ['empty'] },
+ * //           { kind: 'junk-token', symbol: 'claim-rewards.xyz', lamports: '2039280', selected: true, reasons: ['no-price', 'spam-name'] }, …],
+ * //   blocked: [{ kind: 'empty-token', blocker: 'frozen', … }] }
+ * ```
+ */
+export function getReclaimable(owner: string, options: GetReclaimableOptions = {}): Promise<Reclaimable> {
+  const { client, own } = resolve(options, ['mints', 'junk', 'positions', 'prices', 'maxJunkUsd', 'risk', 'isJunk', 'signal'])
+  return reclaimable(client, owner, { ...own, ...(options.fetch ? { fetch: options.fetch } : {}) })
+}

package/src/subpaths/simulate.ts

@@ -0,0 +1,37 @@
+/**
+ * 交易模拟（子路径 `@w3lib/solana-batch-call/simulate`）：不签名、不发送，在主网模拟一笔交易，给出余额变化、授权变化（delegate / SetAuthority / 关闭账户）、
+ * 指令说明、程序错误、手续费和警告。输入可以是 base64 的交易，也可以直接是本库构建器的输出。不放在主入口，不用时打包不会带上这部分代码；价格、风险检查按需加载。
+ *
+ * ```ts
+ * import { buildSwap } from '@w3lib/solana-batch-call/swap'
+ * import { getSimulation } from '@w3lib/solana-batch-call/simulate'
+ *
+ * const plan = await getSwapQuote(owner, { tokenIn: NATIVE_MINT, tokenOut: USDC, amountInFormatted: '0.5' })
+ * const sim = await getSimulation(plan)            // 或 getSimulation(base64Tx, { owner })
+ * if (!sim.success || sim.warnings.some((w) => w.severity === 'danger')) throw new Error(sim.error ?? sim.warnings[0].message)
+ * ```
+ */
+import { resolve, type ShortcutOptions } from '../shortcuts.js'
+import { simulate, type SimulateInput, type SimulateOptions, type SimulationResult } from '../simulate.js'
+
+export {
+  failureText,
+  simulate,
+  type ApprovalChange,
+  type ApprovalChangeKind,
+  type SimulateInput,
+  type SimulateOptions,
+  type SimulatedBalanceChange,
+  type SimulationResult,
+  type SimulationWarning,
+  type WarningSeverity,
+} from '../simulate.js'
+export { decodeInstruction, type DecodedInstruction } from '../decode.js'
+
+export interface GetSimulationOptions extends SimulateOptions, ShortcutOptions {}
+
+/** 模拟一笔交易，节点参数与 getBalances 相同 */
+export function getSimulation(input: SimulateInput, options: GetSimulationOptions = {}): Promise<SimulationResult> {
+  const { client, own } = resolve(options, ['owner', 'signers', 'watch', 'step', 'prices', 'risk', 'fetch', 'signal'])
+  return simulate(client, input, own)
+}

package/src/write/instructions.ts

@@ -74,6 +74,23 @@ export function closeAccount(account: string, destination: string, owner: string
   }
 }
 
+/** SPL Token / Token-2022 BurnChecked：销毁代币账户里的代币（校验 mint 和精度），owner 签名 */
+export function burnChecked(account: string, mint: string, owner: string, amount: bigint, decimals: number, tokenProgram: string): Instruction {
+  return {
+    programId: tokenProgram,
+    keys: [
+      { pubkey: account, isSigner: false, isWritable: true },
+      { pubkey: mint, isSigner: false, isWritable: true },
+      { pubkey: owner, isSigner: true, isWritable: false },
+    ],
+    data: bytes(10, (v) => {
+      v.setUint8(0, 15)
+      v.setBigUint64(1, amount, true)
+      v.setUint8(9, decimals)
+    }),
+  }
+}
+
 /** 撤销代币账户的授权（Approve 设置的 delegate），owner 签名 */
 export function revoke(account: string, owner: string, tokenProgram: string): Instruction {
   return {