@lightprotocol/compressed-token 0.20.5 → 0.20.7

package/dist/types/index.d.ts

@@ -2562,10 +2562,37 @@ declare const IDL: LightCompressedToken;
 
 declare const ERROR_NO_ACCOUNTS_FOUND = "Could not find accounts to select for transfer.";
 /**
- * Selects the minimal number of compressed token accounts for a transfer.
+ * Selects the minimum number of compressed token accounts required for a transfer, up to a specified maximum.
  *
- * 1. Sorts accounts by amount (descending)
- * 2. Accumulates amount until it meets or exceeds transfer amount
+ * @param {ParsedTokenAccount[]} accounts - Token accounts to choose from.
+ * @param {BN} transferAmount - Amount to transfer.
+ * @param {number} [maxInputs=4] - Max accounts to select. Default is 4.
+ * @returns {[
+ *   selectedAccounts: ParsedTokenAccount[],
+ *   total: BN,
+ *   totalLamports: BN | null,
+ *   maxPossibleAmount: BN
+ * ]} - Returns:
+ *   - selectedAccounts: Accounts chosen for transfer.
+ *   - total: Total amount from selected accounts.
+ *   - totalLamports: Total lamports from selected accounts.
+ *   - maxPossibleAmount: Max transferable amount given maxInputs.
+ *
+ * @example
+ * const accounts = [
+ *   { parsed: { amount: new BN(100) }, compressedAccount: { lamports: new BN(10) } },
+ *   { parsed: { amount: new BN(50) }, compressedAccount: { lamports: new BN(5) } },
+ *   { parsed: { amount: new BN(25) }, compressedAccount: { lamports: new BN(2) } },
+ * ];
+ * const transferAmount = new BN(75);
+ * const maxInputs = 2;
+ *
+ * const [selectedAccounts, total, totalLamports, maxPossibleAmount] =
+ *   selectMinCompressedTokenAccountsForTransfer(accounts, transferAmount, maxInputs);
+ *
+ * console.log(selectedAccounts.length); // 2
+ * console.log(total.toString()); // '150'
+ * console.log(totalLamports!.toString()); // '15'
  */
 declare function selectMinCompressedTokenAccountsForTransfer(accounts: ParsedTokenAccount[], transferAmount: BN, maxInputs?: number): [
     selectedAccounts: ParsedTokenAccount[],
@@ -2590,7 +2617,39 @@ declare function selectMinCompressedTokenAccountsForTransferIdempotent(accounts:
  * if possible, up to maxInputs.
  *
  * 1. Sorts accounts by amount (desc)
- * 2. Selects accounts until transfer amount is met or cap is reached
+ * 2. Selects accounts until transfer amount is met or maxInputs is reached,
+ *    attempting to add one extra account if possible.
+ *
+ * @param {ParsedTokenAccount[]} accounts - The list of token accounts to select from.
+ * @param {BN} transferAmount - The token amount to be transferred.
+ * @param {number} [maxInputs=4] - The maximum number of accounts to select. Default: 4.
+ * @returns {[
+ *   selectedAccounts: ParsedTokenAccount[],
+ *   total: BN,
+ *   totalLamports: BN | null,
+ *   maxPossibleAmount: BN
+ * ]} - An array containing:
+ *   - selectedAccounts: The accounts selected for the transfer.
+ *   - total: The total amount accumulated from the selected accounts.
+ *   - totalLamports: The total lamports accumulated from the selected accounts.
+ *   - maxPossibleAmount: The maximum possible amount that can be transferred considering maxInputs.
+ *
+ * @example
+ * const accounts = [
+ *   { parsed: { amount: new BN(100) }, compressedAccount: { lamports: new BN(10) } },
+ *   { parsed: { amount: new BN(50) }, compressedAccount: { lamports: new BN(5) } },
+ *   { parsed: { amount: new BN(25) }, compressedAccount: { lamports: new BN(2) } },
+ * ];
+ * const transferAmount = new BN(75);
+ * const maxInputs = 2;
+ *
+ * const [selectedAccounts, total, totalLamports, maxPossibleAmount] =
+ *   selectSmartCompressedTokenAccountsForTransfer(accounts, transferAmount, maxInputs);
+ *
+ * console.log(selectedAccounts.length); // 2
+ * console.log(total.toString()); // '150'
+ * console.log(totalLamports!.toString()); // '15'
+ * console.log(maxPossibleAmount.toString()); // '150'
  */
 declare function selectSmartCompressedTokenAccountsForTransfer(accounts: ParsedTokenAccount[], transferAmount: BN, maxInputs?: number): [
     selectedAccounts: ParsedTokenAccount[],
@@ -2599,12 +2658,7 @@ declare function selectSmartCompressedTokenAccountsForTransfer(accounts: ParsedT
     maxPossibleAmount: BN
 ];
 /**
- * Idempotently selects compressed token accounts for a transfer. Picks one more
- * account than needed, up to maxInputs, with the extra being the smallest.
- *
- * 1. Sorts accounts by amount (desc)
- * 2. Selects accounts until transfer amount is met, then adds the smallest
- *    extra account if possible
+ * Idempotently runs {@link selectSmartCompressedTokenAccountsForTransfer} strategy.
  */
 declare function selectSmartCompressedTokenAccountsForTransferIdempotent(accounts: ParsedTokenAccount[], transferAmount: BN, maxInputs?: number): [
     selectedAccounts: ParsedTokenAccount[],

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lightprotocol/compressed-token",
-  "version": "0.20.5",
+  "version": "0.20.7",
   "description": "JS client to interact with the compressed-token program",
   "sideEffects": false,
   "main": "dist/cjs/node/index.cjs",
@@ -31,7 +31,7 @@
   "peerDependencies": {
     "@solana/spl-token": ">=0.3.9",
     "@solana/web3.js": ">=1.73.5",
-    "@lightprotocol/stateless.js": "0.20.5"
+    "@lightprotocol/stateless.js": "0.20.7"
   },
   "dependencies": {
     "@coral-xyz/borsh": "^0.29.0",