@xchainjs/xchain-utxo 2.1.0 → 2.2.1

package/lib/client.d.ts

@@ -68,6 +68,15 @@ export declare abstract class Client extends BaseXChainClient {
      * @returns {UTXO[]} The UTXOs found.
      */
     protected scanUTXOs(address: string, confirmedOnly?: boolean): Promise<UTXO[]>;
+    /**
+     * Get UTXOs for a given address.
+     * Public wrapper around the protected scanUTXOs method for coin control.
+     *
+     * @param {string} address The address to get UTXOs for.
+     * @param {boolean} confirmedOnly Whether to only return confirmed UTXOs. Default: true.
+     * @returns {Promise<UTXO[]>} The UTXOs for the address.
+     */
+    getUTXOs(address: string, confirmedOnly?: boolean): Promise<UTXO[]>;
     /**
      * Get estimated fees with fee rates.
      *
@@ -194,11 +203,12 @@ export declare abstract class Client extends BaseXChainClient {
      * @param params Transaction parameters
      * @returns Prepared transaction with UTXO details
      */
-    prepareTxEnhanced({ sender, memo, amount, recipient, spendPendingUTXO, feeRate, utxoSelectionPreferences, }: TxParams & {
+    prepareTxEnhanced({ sender, memo, amount, recipient, spendPendingUTXO, feeRate, utxoSelectionPreferences, selectedUtxos, }: TxParams & {
         sender: Address;
         feeRate: FeeRate;
         spendPendingUTXO?: boolean;
         utxoSelectionPreferences?: UtxoSelectionPreferences;
+        selectedUtxos?: UTXO[];
     }): Promise<PreparedTx>;
     /**
      * Prepare maximum amount transfer (sweep transaction).
@@ -206,13 +216,14 @@ export declare abstract class Client extends BaseXChainClient {
      * @param params Send max parameters
      * @returns Prepared transaction with maximum sendable amount
      */
-    prepareMaxTx({ sender, recipient, memo, feeRate, spendPendingUTXO, utxoSelectionPreferences, }: {
+    prepareMaxTx({ sender, recipient, memo, feeRate, spendPendingUTXO, utxoSelectionPreferences, selectedUtxos, }: {
         sender: Address;
         recipient: Address;
         memo?: string;
         feeRate: FeeRate;
         spendPendingUTXO?: boolean;
         utxoSelectionPreferences?: UtxoSelectionPreferences;
+        selectedUtxos?: UTXO[];
     }): Promise<PreparedTx & {
         maxAmount: number;
         fee: number;

package/lib/index.esm.js

@@ -1126,6 +1126,19 @@ class Client extends BaseXChainClient {
             return this.roundRobinGetUnspentTxs(address, confirmedOnly);
         });
     }
+    /**
+     * Get UTXOs for a given address.
+     * Public wrapper around the protected scanUTXOs method for coin control.
+     *
+     * @param {string} address The address to get UTXOs for.
+     * @param {boolean} confirmedOnly Whether to only return confirmed UTXOs. Default: true.
+     * @returns {Promise<UTXO[]>} The UTXOs for the address.
+     */
+    getUTXOs(address_1) {
+        return __awaiter(this, arguments, void 0, function* (address, confirmedOnly = true) {
+            return this.scanUTXOs(address, confirmedOnly);
+        });
+    }
     /**
      * Get estimated fees with fee rates.
      *
@@ -1437,7 +1450,7 @@ class Client extends BaseXChainClient {
      * @returns Prepared transaction with UTXO details
      */
     prepareTxEnhanced(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ sender, memo, amount, recipient, spendPendingUTXO = true, feeRate, utxoSelectionPreferences, }) {
+        return __awaiter(this, arguments, void 0, function* ({ sender, memo, amount, recipient, spendPendingUTXO = true, feeRate, utxoSelectionPreferences, selectedUtxos, }) {
             try {
                 // Comprehensive input validation
                 this.validateTransactionInputs({
@@ -1447,9 +1460,16 @@ class Client extends BaseXChainClient {
                     sender,
                     feeRate,
                 });
-                // Get validated UTXOs
-                const confirmedOnly = !spendPendingUTXO;
-                const utxos = yield this.getValidatedUtxos(sender, confirmedOnly);
+                // Use provided UTXOs (coin control) or fetch from chain
+                let utxos;
+                if (selectedUtxos && selectedUtxos.length > 0) {
+                    UtxoTransactionValidator.validateUtxoSet(selectedUtxos);
+                    utxos = selectedUtxos;
+                }
+                else {
+                    const confirmedOnly = !spendPendingUTXO;
+                    utxos = yield this.getValidatedUtxos(sender, confirmedOnly);
+                }
                 const compiledMemo = memo ? this.compileMemo(memo) : null;
                 const targetValue = amount.amount().toNumber();
                 // Output count: recipient + change + optional memo
@@ -1482,7 +1502,7 @@ class Client extends BaseXChainClient {
      * @returns Prepared transaction with maximum sendable amount
      */
     prepareMaxTx(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ sender, recipient, memo, feeRate, spendPendingUTXO = true, utxoSelectionPreferences, }) {
+        return __awaiter(this, arguments, void 0, function* ({ sender, recipient, memo, feeRate, spendPendingUTXO = true, utxoSelectionPreferences, selectedUtxos, }) {
             try {
                 // Basic validation
                 if (!(recipient === null || recipient === void 0 ? void 0 : recipient.trim())) {
@@ -1499,9 +1519,16 @@ class Client extends BaseXChainClient {
                     throw UtxoError.invalidFeeRate(feeRate, 'Fee rate must be a positive finite number');
                 }
                 const validatedFeeRate = Math.ceil(feeRate);
-                // Get validated UTXOs
-                const confirmedOnly = !spendPendingUTXO;
-                const utxos = yield this.getValidatedUtxos(sender, confirmedOnly);
+                // Use provided UTXOs (coin control) or fetch from chain
+                let utxos;
+                if (selectedUtxos && selectedUtxos.length > 0) {
+                    UtxoTransactionValidator.validateUtxoSet(selectedUtxos);
+                    utxos = selectedUtxos;
+                }
+                else {
+                    const confirmedOnly = !spendPendingUTXO;
+                    utxos = yield this.getValidatedUtxos(sender, confirmedOnly);
+                }
                 // Calculate maximum sendable amount
                 const maxCalc = this.calculateMaxSendableAmount(utxos, validatedFeeRate, !!memo, utxoSelectionPreferences);
                 const compiledMemo = memo ? this.compileMemo(memo) : null;

package/lib/index.js

@@ -1128,6 +1128,19 @@ class Client extends xchainClient.BaseXChainClient {
             return this.roundRobinGetUnspentTxs(address, confirmedOnly);
         });
     }
+    /**
+     * Get UTXOs for a given address.
+     * Public wrapper around the protected scanUTXOs method for coin control.
+     *
+     * @param {string} address The address to get UTXOs for.
+     * @param {boolean} confirmedOnly Whether to only return confirmed UTXOs. Default: true.
+     * @returns {Promise<UTXO[]>} The UTXOs for the address.
+     */
+    getUTXOs(address_1) {
+        return __awaiter(this, arguments, void 0, function* (address, confirmedOnly = true) {
+            return this.scanUTXOs(address, confirmedOnly);
+        });
+    }
     /**
      * Get estimated fees with fee rates.
      *
@@ -1439,7 +1452,7 @@ class Client extends xchainClient.BaseXChainClient {
      * @returns Prepared transaction with UTXO details
      */
     prepareTxEnhanced(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ sender, memo, amount, recipient, spendPendingUTXO = true, feeRate, utxoSelectionPreferences, }) {
+        return __awaiter(this, arguments, void 0, function* ({ sender, memo, amount, recipient, spendPendingUTXO = true, feeRate, utxoSelectionPreferences, selectedUtxos, }) {
             try {
                 // Comprehensive input validation
                 this.validateTransactionInputs({
@@ -1449,9 +1462,16 @@ class Client extends xchainClient.BaseXChainClient {
                     sender,
                     feeRate,
                 });
-                // Get validated UTXOs
-                const confirmedOnly = !spendPendingUTXO;
-                const utxos = yield this.getValidatedUtxos(sender, confirmedOnly);
+                // Use provided UTXOs (coin control) or fetch from chain
+                let utxos;
+                if (selectedUtxos && selectedUtxos.length > 0) {
+                    UtxoTransactionValidator.validateUtxoSet(selectedUtxos);
+                    utxos = selectedUtxos;
+                }
+                else {
+                    const confirmedOnly = !spendPendingUTXO;
+                    utxos = yield this.getValidatedUtxos(sender, confirmedOnly);
+                }
                 const compiledMemo = memo ? this.compileMemo(memo) : null;
                 const targetValue = amount.amount().toNumber();
                 // Output count: recipient + change + optional memo
@@ -1484,7 +1504,7 @@ class Client extends xchainClient.BaseXChainClient {
      * @returns Prepared transaction with maximum sendable amount
      */
     prepareMaxTx(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ sender, recipient, memo, feeRate, spendPendingUTXO = true, utxoSelectionPreferences, }) {
+        return __awaiter(this, arguments, void 0, function* ({ sender, recipient, memo, feeRate, spendPendingUTXO = true, utxoSelectionPreferences, selectedUtxos, }) {
             try {
                 // Basic validation
                 if (!(recipient === null || recipient === void 0 ? void 0 : recipient.trim())) {
@@ -1501,9 +1521,16 @@ class Client extends xchainClient.BaseXChainClient {
                     throw UtxoError.invalidFeeRate(feeRate, 'Fee rate must be a positive finite number');
                 }
                 const validatedFeeRate = Math.ceil(feeRate);
-                // Get validated UTXOs
-                const confirmedOnly = !spendPendingUTXO;
-                const utxos = yield this.getValidatedUtxos(sender, confirmedOnly);
+                // Use provided UTXOs (coin control) or fetch from chain
+                let utxos;
+                if (selectedUtxos && selectedUtxos.length > 0) {
+                    UtxoTransactionValidator.validateUtxoSet(selectedUtxos);
+                    utxos = selectedUtxos;
+                }
+                else {
+                    const confirmedOnly = !spendPendingUTXO;
+                    utxos = yield this.getValidatedUtxos(sender, confirmedOnly);
+                }
                 // Calculate maximum sendable amount
                 const maxCalc = this.calculateMaxSendableAmount(utxos, validatedFeeRate, !!memo, utxoSelectionPreferences);
                 const compiledMemo = memo ? this.compileMemo(memo) : null;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-utxo",
-  "version": "2.1.0",
+  "version": "2.2.1",
   "description": "Genereic UTXO client for XChainJS",
   "keywords": [
     "XChain",
@@ -37,6 +37,6 @@
   "dependencies": {
     "@xchainjs/xchain-client": "2.0.10",
     "@xchainjs/xchain-util": "2.0.5",
-    "@xchainjs/xchain-utxo-providers": "2.0.10"
+    "@xchainjs/xchain-utxo-providers": "2.0.11"
   }
 }