@suilend/sui-fe 3.0.2 → 3.0.4

package/lib/transactions.d.ts

@@ -1,7 +1,7 @@
 import { SuiGrpcClient } from "@mysten/sui/grpc";
 import { SuiGraphQLClient } from "@mysten/sui/graphql";
 import { SuiClientTypes } from "@mysten/sui/client";
-import { Transaction } from "@mysten/sui/transactions";
+import { Transaction, TransactionObjectArgument } from "@mysten/sui/transactions";
 import BigNumber from "bignumber.js";
 import { Token } from "./coinMetadata";
 export type GraphQLTransaction = {
@@ -28,3 +28,4 @@ export declare const getAllOwnedObjects: (suiGrpcClient: SuiGrpcClient, address:
 export declare const getAllCoins: (suiGrpcClient: SuiGrpcClient, address: string, coinType: string) => Promise<SuiClientTypes.Coin[]>;
 export declare const getMostRecentAddressTransaction: (suiGraphQLClient: SuiGraphQLClient, address: string, direction: "from" | "to") => Promise<GraphQLTransaction | undefined>;
 export declare const mergeAllCoins: (coinType: string, transaction: Transaction, allCoins: SuiClientTypes.Coin[]) => SuiClientTypes.Coin;
+export declare const getSpendableCoin: (suiGrpcClient: SuiGrpcClient, address: string, coinType: string, value: string, transaction: Transaction, mergeCoins?: boolean) => Promise<TransactionObjectArgument>;

package/lib/transactions.js

@@ -100,3 +100,68 @@ export const mergeAllCoins = (coinType, transaction, allCoins) => {
     }
     return mergeCoin;
 };
+// Build a spendable coin using owned coin objects, address balance, or both.
+export const getSpendableCoin = (suiGrpcClient_1, address_1, coinType_1, value_1, transaction_1, ...args_1) => __awaiter(void 0, [suiGrpcClient_1, address_1, coinType_1, value_1, transaction_1, ...args_1], void 0, function* (suiGrpcClient, address, coinType, value, transaction, mergeCoins = true) {
+    var _a;
+    const spendValue = BigInt(value);
+    if (spendValue <= BigInt(0)) {
+        throw new Error("Spend amount must be positive");
+    }
+    // Address-balance withdrawals resolve against the transaction sender.
+    transaction.setSenderIfNotSet(address);
+    const [coins, balanceRes] = yield Promise.all([
+        getAllCoins(suiGrpcClient, address, coinType),
+        suiGrpcClient.getBalance({ owner: address, coinType }),
+    ]);
+    const nonZeroCoins = coins.filter((c) => BigInt(c.balance) > BigInt(0));
+    const objectCoinBalance = nonZeroCoins.reduce((sum, c) => sum + BigInt(c.balance), BigInt(0));
+    const addressBalanceAvailable = BigInt((_a = balanceRes.balance.addressBalance) !== null && _a !== void 0 ? _a : "0");
+    const totalAvailable = BigInt(balanceRes.balance.balance);
+    if (totalAvailable < spendValue) {
+        throw new Error(`Insufficient ${coinType} balance: need ${value}, have ${balanceRes.balance.balance} (${objectCoinBalance.toString()} in coins, ${addressBalanceAvailable.toString()} in address)`);
+    }
+    const objectCoinSpend = objectCoinBalance >= spendValue ? spendValue : objectCoinBalance;
+    const addressBalanceSpend = spendValue - objectCoinSpend;
+    console.log(`[getSpendableCoin] ${coinType} requested=${value} coinObjects=${objectCoinSpend.toString()} addressBalance=${addressBalanceSpend.toString()}`);
+    // Address balance only.
+    if (objectCoinSpend === BigInt(0)) {
+        return transaction.moveCall({
+            target: "0x2::coin::redeem_funds",
+            typeArguments: [coinType],
+            arguments: [transaction.withdrawal({ amount: value, type: coinType })],
+        });
+    }
+    let coinSource;
+    if (mergeCoins) {
+        const mergedCoin = mergeAllCoins(coinType, transaction, nonZeroCoins);
+        coinSource = isSui(coinType)
+            ? transaction.gas
+            : transaction.object(mergedCoin.objectId);
+    }
+    else {
+        coinSource = isSui(coinType)
+            ? transaction.gas
+            : transaction.object(nonZeroCoins[0].objectId);
+    }
+    // Coin objects only.
+    if (addressBalanceSpend === BigInt(0)) {
+        const [sendCoin] = transaction.splitCoins(coinSource, [value]);
+        return sendCoin;
+    }
+    // Mixed: split from coin objects, redeem the rest from address balance, merge.
+    const [objectCoin] = transaction.splitCoins(coinSource, [
+        objectCoinSpend.toString(),
+    ]);
+    const addressCoin = transaction.moveCall({
+        target: "0x2::coin::redeem_funds",
+        typeArguments: [coinType],
+        arguments: [
+            transaction.withdrawal({
+                amount: addressBalanceSpend.toString(),
+                type: coinType,
+            }),
+        ],
+    });
+    transaction.mergeCoins(objectCoin, [addressCoin]);
+    return objectCoin;
+});

package/package.json

@@ -1 +1 @@
-{"name":"@suilend/sui-fe","version":"3.0.2","private":false,"description":"A collection of TypeScript frontend libraries","author":"Suilend","license":"MIT","main":"./index.js","exports":{".":"./index.js","./lib/constants":"./lib/constants.js","./lib/transactions":"./lib/transactions.js","./lib/format":"./lib/format.js","./lib/ledger":"./lib/ledger.js","./lib/coinMetadata":"./lib/coinMetadata.js","./lib":"./lib/index.js","./lib/indexedDB":"./lib/indexedDB.js","./lib/coinType":"./lib/coinType.js","./lib/coin":"./lib/coin.js","./lib/msafe":"./lib/msafe.js","./lib/keypair":"./lib/keypair.js","./lib/api":"./lib/api.js"},"types":"./index.js","scripts":{"build":"rm -rf ./dist && bun tsc","eslint":"eslint --fix src/","prettier":"prettier --write src/","lint":"bun eslint && bun prettier && bun tsc --noEmit","release":"bun run build && bun ./release.js && cd ./dist && npm publish --access public"},"repository":{"type":"git","url":"git+https://github.com/suilend/sui-fe.git"},"bugs":{"url":"https://github.com/suilend/sui-fe/issues"},"dependencies":{"@mysten/wallet-standard":"0.20.0","bignumber.js":"^9.1.2","blake2b":"^2.1.4","lodash":"^4.17.21","p-limit":"3.1.0"},"devDependencies":{"@tsconfig/recommended":"^1.0.8","@types/blake2b":"^2.1.3","@types/lodash":"^4.17.13","@types/node":"^22.9.0","@typescript-eslint/eslint-plugin":"^8.14.0","@typescript-eslint/parser":"^8.14.0","eslint":"^9.14.0","eslint-config-prettier":"^9.1.0","eslint-plugin-import":"^2.31.0","eslint-plugin-prettier":"^5.2.1","prettier":"^3.3.3","ts-node":"^10.9.2","typescript":"^5.6.3"},"peerDependencies":{"@mysten/sui":"2.15.0"}}
+{"name":"@suilend/sui-fe","version":"3.0.4","private":false,"description":"A collection of TypeScript frontend libraries","author":"Suilend","license":"MIT","main":"./index.js","exports":{".":"./index.js","./lib/constants":"./lib/constants.js","./lib/transactions":"./lib/transactions.js","./lib/format":"./lib/format.js","./lib/ledger":"./lib/ledger.js","./lib/coinMetadata":"./lib/coinMetadata.js","./lib":"./lib/index.js","./lib/indexedDB":"./lib/indexedDB.js","./lib/coinType":"./lib/coinType.js","./lib/coin":"./lib/coin.js","./lib/msafe":"./lib/msafe.js","./lib/keypair":"./lib/keypair.js","./lib/api":"./lib/api.js"},"types":"./index.js","scripts":{"build":"rm -rf ./dist && bun tsc","eslint":"eslint --fix src/","prettier":"prettier --write src/","lint":"bun eslint && bun prettier && bun tsc --noEmit","release":"bun run build && bun ./release.js && cd ./dist && npm publish --access public"},"repository":{"type":"git","url":"git+https://github.com/suilend/sui-fe.git"},"bugs":{"url":"https://github.com/suilend/sui-fe/issues"},"dependencies":{"@mysten/wallet-standard":"0.20.0","bignumber.js":"^9.1.2","blake2b":"^2.1.4","lodash":"^4.17.21","p-limit":"3.1.0"},"devDependencies":{"@tsconfig/recommended":"^1.0.8","@types/blake2b":"^2.1.3","@types/lodash":"^4.17.13","@types/node":"^22.9.0","@typescript-eslint/eslint-plugin":"^8.14.0","@typescript-eslint/parser":"^8.14.0","eslint":"^9.14.0","eslint-config-prettier":"^9.1.0","eslint-plugin-import":"^2.31.0","eslint-plugin-prettier":"^5.2.1","prettier":"^3.3.3","ts-node":"^10.9.2","typescript":"^5.6.3"},"peerDependencies":{"@mysten/sui":"2.15.0"}}