@xchainjs/xchain-doge 2.1.0 → 2.2.0

package/lib/client.d.ts

@@ -94,11 +94,12 @@ declare abstract class Client extends UTXOClient {
      * Build transaction with enhanced UTXO selection
      * Note: Doge uses legacy P2PKH addresses (nonWitnessUtxo)
      */
-    buildTxEnhanced({ amount, recipient, memo, feeRate, sender, spendPendingUTXO, utxoSelectionPreferences, }: TxParams & {
+    buildTxEnhanced({ amount, recipient, memo, feeRate, sender, spendPendingUTXO, utxoSelectionPreferences, selectedUtxos, }: TxParams & {
         feeRate: FeeRate;
         sender: Address;
         spendPendingUTXO?: boolean;
         utxoSelectionPreferences?: UtxoSelectionPreferences;
+        selectedUtxos?: UTXO[];
     }): Promise<{
         psbt: Dogecoin.Psbt;
         utxos: UTXO[];
@@ -107,22 +108,24 @@ declare abstract class Client extends UTXOClient {
     /**
      * Prepare transaction with enhanced UTXO selection
      */
-    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>;
     /**
      * Send maximum possible amount (sweep)
      */
-    sendMax({ sender, recipient, memo, feeRate, spendPendingUTXO, utxoSelectionPreferences, }: {
+    sendMax({ sender, recipient, memo, feeRate, spendPendingUTXO, utxoSelectionPreferences, selectedUtxos, }: {
         sender: Address;
         recipient: Address;
         memo?: string;
         feeRate: FeeRate;
         spendPendingUTXO?: boolean;
         utxoSelectionPreferences?: UtxoSelectionPreferences;
+        selectedUtxos?: UTXO[];
     }): Promise<{
         psbt: Dogecoin.Psbt;
         utxos: UTXO[];
@@ -133,13 +136,14 @@ declare abstract class Client extends UTXOClient {
     /**
      * Prepare max send transaction
      */
-    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/clientKeystore.d.ts

@@ -1,6 +1,6 @@
 import { FeeRate, TxHash } from '@xchainjs/xchain-client';
 import { Address } from '@xchainjs/xchain-util';
-import { TxParams, UtxoSelectionPreferences } from '@xchainjs/xchain-utxo';
+import { TxParams, UTXO, UtxoSelectionPreferences } from '@xchainjs/xchain-utxo';
 import { Client } from './client';
 /**
  * Custom Doge client extended to support keystore functionality
@@ -51,6 +51,7 @@ declare class ClientKeystore extends Client {
     transfer(params: TxParams & {
         feeRate?: FeeRate;
         utxoSelectionPreferences?: UtxoSelectionPreferences;
+        selectedUtxos?: UTXO[];
     }): Promise<TxHash>;
     /**
      * Transfer the maximum amount of Dogecoin (sweep).
@@ -70,6 +71,7 @@ declare class ClientKeystore extends Client {
         feeRate?: FeeRate;
         walletIndex?: number;
         utxoSelectionPreferences?: UtxoSelectionPreferences;
+        selectedUtxos?: UTXO[];
     }): Promise<{
         hash: TxHash;
         maxAmount: number;

package/lib/clientLedger.d.ts

@@ -1,7 +1,7 @@
 import AppBtc from '@ledgerhq/hw-app-btc';
 import { FeeRate, TxHash } from '@xchainjs/xchain-client';
 import { Address } from '@xchainjs/xchain-util';
-import { TxParams, UtxoClientParams } from '@xchainjs/xchain-utxo';
+import { TxParams, UTXO, UtxoClientParams, UtxoSelectionPreferences } from '@xchainjs/xchain-utxo';
 import { Client } from './client';
 /**
  * Custom Ledger Bitcoin client
@@ -18,5 +18,17 @@ declare class ClientLedger extends Client {
     transfer(params: TxParams & {
         feeRate?: FeeRate;
     }): Promise<TxHash>;
+    transferMax(params: {
+        recipient: Address;
+        memo?: string;
+        feeRate?: FeeRate;
+        walletIndex?: number;
+        utxoSelectionPreferences?: UtxoSelectionPreferences;
+        selectedUtxos?: UTXO[];
+    }): Promise<{
+        hash: TxHash;
+        maxAmount: number;
+        fee: number;
+    }>;
 }
 export { ClientLedger };

package/lib/index.esm.js

@@ -4,7 +4,7 @@ import { getSeed } from '@xchainjs/xchain-crypto';
 import * as Dogecoin from 'bitcoinjs-lib';
 import { ECPairFactory } from 'ecpair';
 import { HDKey } from '@scure/bip32';
-import { toBitcoinJS, Client as Client$1, UtxoError } from '@xchainjs/xchain-utxo';
+import { toBitcoinJS, Client as Client$1, UtxoTransactionValidator, UtxoError } from '@xchainjs/xchain-utxo';
 import accumulative from 'coinselect/accumulative.js';
 import { AssetType } from '@xchainjs/xchain-util';
 import { SochainProvider, SochainNetwork, BlockcypherProvider, BlockcypherNetwork, BitgoProvider } from '@xchainjs/xchain-utxo-providers';
@@ -405,7 +405,7 @@ class Client extends Client$1 {
      * Note: Doge uses legacy P2PKH addresses (nonWitnessUtxo)
      */
     buildTxEnhanced(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ amount, recipient, memo, feeRate, sender, spendPendingUTXO = true, utxoSelectionPreferences, }) {
+        return __awaiter(this, arguments, void 0, function* ({ amount, recipient, memo, feeRate, sender, spendPendingUTXO = true, utxoSelectionPreferences, selectedUtxos, }) {
             try {
                 this.validateTransactionInputs({
                     amount,
@@ -414,8 +414,15 @@ class Client extends Client$1 {
                     sender,
                     feeRate,
                 });
-                const confirmedOnly = !spendPendingUTXO;
-                const utxos = yield this.getValidatedUtxos(sender, confirmedOnly);
+                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();
                 const extraOutputs = 1 + (compiledMemo ? 1 : 0);
@@ -460,7 +467,7 @@ class Client extends Client$1 {
      * Prepare transaction with enhanced UTXO selection
      */
     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 {
                 const { psbt, utxos, inputs } = yield this.buildTxEnhanced({
                     sender,
@@ -470,6 +477,7 @@ class Client extends Client$1 {
                     memo,
                     spendPendingUTXO,
                     utxoSelectionPreferences,
+                    selectedUtxos,
                 });
                 return { rawUnsignedTx: psbt.toBase64(), utxos, inputs };
             }
@@ -485,7 +493,7 @@ class Client extends Client$1 {
      * Send maximum possible amount (sweep)
      */
     sendMax(_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 {
                 if (!this.validateAddress(recipient)) {
                     throw UtxoError.invalidAddress(recipient, this.network);
@@ -493,8 +501,15 @@ class Client extends Client$1 {
                 if (!this.validateAddress(sender)) {
                     throw UtxoError.invalidAddress(sender, this.network);
                 }
-                const confirmedOnly = !spendPendingUTXO;
-                const utxos = yield this.getValidatedUtxos(sender, confirmedOnly);
+                let utxos;
+                if (selectedUtxos && selectedUtxos.length > 0) {
+                    UtxoTransactionValidator.validateUtxoSet(selectedUtxos);
+                    utxos = selectedUtxos;
+                }
+                else {
+                    const confirmedOnly = !spendPendingUTXO;
+                    utxos = yield this.getValidatedUtxos(sender, confirmedOnly);
+                }
                 const maxCalc = this.calculateMaxSendableAmount(utxos, Math.ceil(feeRate), !!memo, utxoSelectionPreferences);
                 const compiledMemo = memo ? this.compileMemo(memo) : null;
                 const psbt = new Dogecoin.Psbt({ network: dogeNetwork(this.network) });
@@ -534,7 +549,7 @@ class Client extends Client$1 {
      * Prepare max send transaction
      */
     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 {
                 const { psbt, utxos, inputs, maxAmount, fee } = yield this.sendMax({
                     sender,
@@ -543,6 +558,7 @@ class Client extends Client$1 {
                     feeRate,
                     spendPendingUTXO,
                     utxoSelectionPreferences,
+                    selectedUtxos,
                 });
                 return {
                     rawUnsignedTx: psbt.toBase64(),
@@ -649,7 +665,7 @@ class ClientKeystore extends Client {
             const dogeKeys = this.getDogeKeys(this.phrase, fromAddressIndex);
             const mergedPreferences = Object.assign({ minimizeFee: true, avoidDust: true, minimizeInputs: false }, params.utxoSelectionPreferences);
             const { rawUnsignedTx } = yield this.prepareTxEnhanced(Object.assign(Object.assign({}, params), { feeRate,
-                sender, utxoSelectionPreferences: mergedPreferences }));
+                sender, utxoSelectionPreferences: mergedPreferences, selectedUtxos: params.selectedUtxos }));
             const psbt = Dogecoin.Psbt.fromBase64(rawUnsignedTx, { maximumFeeRate: 7500000 });
             psbt.signAllInputs(dogeKeys);
             psbt.finalizeAllInputs();
@@ -681,6 +697,7 @@ class ClientKeystore extends Client {
                 memo: params.memo,
                 feeRate,
                 utxoSelectionPreferences: params.utxoSelectionPreferences,
+                selectedUtxos: params.selectedUtxos,
             });
             const dogeKeys = this.getDogeKeys(this.phrase, fromAddressIndex);
             psbt.signAllInputs(dogeKeys);
@@ -770,6 +787,47 @@ class ClientLedger extends Client {
             return txHash;
         });
     }
+    // Transfer max DOGE from Ledger (sweep transaction)
+    transferMax(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const app = yield this.getApp();
+            const fromAddressIndex = (params === null || params === void 0 ? void 0 : params.walletIndex) || 0;
+            const feeRate = params.feeRate || (yield this.getFeeRates())[FeeOption.Fast];
+            checkFeeBounds(this.feeBounds, feeRate);
+            const sender = yield this.getAddressAsync(fromAddressIndex);
+            const { rawUnsignedTx, inputs, maxAmount, fee } = yield this.prepareMaxTx({
+                sender,
+                recipient: params.recipient,
+                memo: params.memo,
+                feeRate,
+                utxoSelectionPreferences: params.utxoSelectionPreferences,
+                selectedUtxos: params.selectedUtxos,
+            });
+            const psbt = Dogecoin.Psbt.fromBase64(rawUnsignedTx);
+            const ledgerInputs = inputs.map(({ txHex, hash, index }) => {
+                if (!txHex) {
+                    throw Error(`Missing 'txHex' for UTXO (txHash ${hash})`);
+                }
+                const splittedTx = app.splitTransaction(txHex, false /* no segwit support */);
+                return [splittedTx, index, null, null];
+            });
+            const associatedKeysets = ledgerInputs.map(() => this.getFullDerivationPath(fromAddressIndex));
+            const unsignedHex = psbt.data.globalMap.unsignedTx.toBuffer().toString('hex');
+            const newTx = app.splitTransaction(unsignedHex, true);
+            const outputScriptHex = app.serializeTransactionOutputs(newTx).toString('hex');
+            const txHex = yield app.createPaymentTransaction({
+                inputs: ledgerInputs,
+                associatedKeysets,
+                outputScriptHex,
+                additionals: [],
+            });
+            const hash = yield this.broadcastTx(txHex);
+            if (!hash) {
+                throw Error('No Tx hash');
+            }
+            return { hash, maxAmount, fee };
+        });
+    }
 }
 
 /**

package/lib/index.js

@@ -432,7 +432,7 @@ class Client extends xchainUtxo.Client {
      * Note: Doge uses legacy P2PKH addresses (nonWitnessUtxo)
      */
     buildTxEnhanced(_a) {
-        return __awaiter(this, arguments, void 0, function* ({ amount, recipient, memo, feeRate, sender, spendPendingUTXO = true, utxoSelectionPreferences, }) {
+        return __awaiter(this, arguments, void 0, function* ({ amount, recipient, memo, feeRate, sender, spendPendingUTXO = true, utxoSelectionPreferences, selectedUtxos, }) {
             try {
                 this.validateTransactionInputs({
                     amount,
@@ -441,8 +441,15 @@ class Client extends xchainUtxo.Client {
                     sender,
                     feeRate,
                 });
-                const confirmedOnly = !spendPendingUTXO;
-                const utxos = yield this.getValidatedUtxos(sender, confirmedOnly);
+                let utxos;
+                if (selectedUtxos && selectedUtxos.length > 0) {
+                    xchainUtxo.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();
                 const extraOutputs = 1 + (compiledMemo ? 1 : 0);
@@ -487,7 +494,7 @@ class Client extends xchainUtxo.Client {
      * Prepare transaction with enhanced UTXO selection
      */
     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 {
                 const { psbt, utxos, inputs } = yield this.buildTxEnhanced({
                     sender,
@@ -497,6 +504,7 @@ class Client extends xchainUtxo.Client {
                     memo,
                     spendPendingUTXO,
                     utxoSelectionPreferences,
+                    selectedUtxos,
                 });
                 return { rawUnsignedTx: psbt.toBase64(), utxos, inputs };
             }
@@ -512,7 +520,7 @@ class Client extends xchainUtxo.Client {
      * Send maximum possible amount (sweep)
      */
     sendMax(_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 {
                 if (!this.validateAddress(recipient)) {
                     throw xchainUtxo.UtxoError.invalidAddress(recipient, this.network);
@@ -520,8 +528,15 @@ class Client extends xchainUtxo.Client {
                 if (!this.validateAddress(sender)) {
                     throw xchainUtxo.UtxoError.invalidAddress(sender, this.network);
                 }
-                const confirmedOnly = !spendPendingUTXO;
-                const utxos = yield this.getValidatedUtxos(sender, confirmedOnly);
+                let utxos;
+                if (selectedUtxos && selectedUtxos.length > 0) {
+                    xchainUtxo.UtxoTransactionValidator.validateUtxoSet(selectedUtxos);
+                    utxos = selectedUtxos;
+                }
+                else {
+                    const confirmedOnly = !spendPendingUTXO;
+                    utxos = yield this.getValidatedUtxos(sender, confirmedOnly);
+                }
                 const maxCalc = this.calculateMaxSendableAmount(utxos, Math.ceil(feeRate), !!memo, utxoSelectionPreferences);
                 const compiledMemo = memo ? this.compileMemo(memo) : null;
                 const psbt = new Dogecoin__namespace.Psbt({ network: dogeNetwork(this.network) });
@@ -561,7 +576,7 @@ class Client extends xchainUtxo.Client {
      * Prepare max send transaction
      */
     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 {
                 const { psbt, utxos, inputs, maxAmount, fee } = yield this.sendMax({
                     sender,
@@ -570,6 +585,7 @@ class Client extends xchainUtxo.Client {
                     feeRate,
                     spendPendingUTXO,
                     utxoSelectionPreferences,
+                    selectedUtxos,
                 });
                 return {
                     rawUnsignedTx: psbt.toBase64(),
@@ -676,7 +692,7 @@ class ClientKeystore extends Client {
             const dogeKeys = this.getDogeKeys(this.phrase, fromAddressIndex);
             const mergedPreferences = Object.assign({ minimizeFee: true, avoidDust: true, minimizeInputs: false }, params.utxoSelectionPreferences);
             const { rawUnsignedTx } = yield this.prepareTxEnhanced(Object.assign(Object.assign({}, params), { feeRate,
-                sender, utxoSelectionPreferences: mergedPreferences }));
+                sender, utxoSelectionPreferences: mergedPreferences, selectedUtxos: params.selectedUtxos }));
             const psbt = Dogecoin__namespace.Psbt.fromBase64(rawUnsignedTx, { maximumFeeRate: 7500000 });
             psbt.signAllInputs(dogeKeys);
             psbt.finalizeAllInputs();
@@ -708,6 +724,7 @@ class ClientKeystore extends Client {
                 memo: params.memo,
                 feeRate,
                 utxoSelectionPreferences: params.utxoSelectionPreferences,
+                selectedUtxos: params.selectedUtxos,
             });
             const dogeKeys = this.getDogeKeys(this.phrase, fromAddressIndex);
             psbt.signAllInputs(dogeKeys);
@@ -797,6 +814,47 @@ class ClientLedger extends Client {
             return txHash;
         });
     }
+    // Transfer max DOGE from Ledger (sweep transaction)
+    transferMax(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const app = yield this.getApp();
+            const fromAddressIndex = (params === null || params === void 0 ? void 0 : params.walletIndex) || 0;
+            const feeRate = params.feeRate || (yield this.getFeeRates())[xchainClient.FeeOption.Fast];
+            xchainClient.checkFeeBounds(this.feeBounds, feeRate);
+            const sender = yield this.getAddressAsync(fromAddressIndex);
+            const { rawUnsignedTx, inputs, maxAmount, fee } = yield this.prepareMaxTx({
+                sender,
+                recipient: params.recipient,
+                memo: params.memo,
+                feeRate,
+                utxoSelectionPreferences: params.utxoSelectionPreferences,
+                selectedUtxos: params.selectedUtxos,
+            });
+            const psbt = Dogecoin__namespace.Psbt.fromBase64(rawUnsignedTx);
+            const ledgerInputs = inputs.map(({ txHex, hash, index }) => {
+                if (!txHex) {
+                    throw Error(`Missing 'txHex' for UTXO (txHash ${hash})`);
+                }
+                const splittedTx = app.splitTransaction(txHex, false /* no segwit support */);
+                return [splittedTx, index, null, null];
+            });
+            const associatedKeysets = ledgerInputs.map(() => this.getFullDerivationPath(fromAddressIndex));
+            const unsignedHex = psbt.data.globalMap.unsignedTx.toBuffer().toString('hex');
+            const newTx = app.splitTransaction(unsignedHex, true);
+            const outputScriptHex = app.serializeTransactionOutputs(newTx).toString('hex');
+            const txHex = yield app.createPaymentTransaction({
+                inputs: ledgerInputs,
+                associatedKeysets,
+                outputScriptHex,
+                additionals: [],
+            });
+            const hash = yield this.broadcastTx(txHex);
+            if (!hash) {
+                throw Error('No Tx hash');
+            }
+            return { hash, maxAmount, fee };
+        });
+    }
 }
 
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@xchainjs/xchain-doge",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "description": "Custom Doge client and utilities used by XChain clients",
   "keywords": [
     "Xchain",
@@ -39,7 +39,7 @@
     "@xchainjs/xchain-client": "2.0.10",
     "@xchainjs/xchain-crypto": "1.0.6",
     "@xchainjs/xchain-util": "2.0.5",
-    "@xchainjs/xchain-utxo": "2.1.0",
+    "@xchainjs/xchain-utxo": "2.2.0",
     "@xchainjs/xchain-utxo-providers": "2.0.10",
     "bitcoinjs-lib": "^6.1.7",
     "coinselect": "3.1.12",