@xchainjs/xchain-dash 2.0.9 → 2.1.0

package/lib/client.d.ts

@@ -1,6 +1,6 @@
 import { AssetInfo, FeeRate, TxHistoryParams } from '@xchainjs/xchain-client';
 import { Address } from '@xchainjs/xchain-util';
-import { Balance, Client as UTXOClient, Tx, TxParams, TxsPage, UTXO, UtxoClientParams } from '@xchainjs/xchain-utxo';
+import { Balance, Client as UTXOClient, PreparedTx, Tx, TxParams, TxsPage, UTXO, UtxoClientParams, UtxoSelectionPreferences } from '@xchainjs/xchain-utxo';
 import { DashPreparedTx, NodeAuth, NodeUrls } from './types';
 /**
  * Default parameters for the DASH client.
@@ -59,6 +59,7 @@ declare abstract class Client extends UTXOClient {
     private insightTxToXChainTx;
     /**
      * Asynchronously prepares a transaction for sending assets.
+     * @deprecated Use `prepareTxEnhanced` instead for better UTXO selection and error handling.
      * @param {TxParams&Address&FeeRate} params - Parameters for the transaction preparation.
      * @returns {string} A promise resolving to the prepared transaction data.
      */
@@ -80,5 +81,29 @@ declare abstract class Client extends UTXOClient {
      * @returns {number} The calculated transaction fee amount.
      */
     protected getFeeFromUtxos(inputs: UTXO[], feeRate: FeeRate, data?: Buffer | null): number;
+    /**
+     * Prepare transaction with enhanced UTXO selection.
+     * Uses base class UTXO selection logic with dashcore-lib transaction building.
+     */
+    prepareTxEnhanced({ sender, memo, amount, recipient, feeRate, spendPendingUTXO, utxoSelectionPreferences, }: TxParams & {
+        sender: Address;
+        feeRate: FeeRate;
+        spendPendingUTXO?: boolean;
+        utxoSelectionPreferences?: UtxoSelectionPreferences;
+    }): Promise<PreparedTx>;
+    /**
+     * Prepare max send transaction
+     */
+    prepareMaxTx({ sender, recipient, memo, feeRate, spendPendingUTXO, utxoSelectionPreferences, }: {
+        sender: Address;
+        recipient: Address;
+        memo?: string;
+        feeRate: FeeRate;
+        spendPendingUTXO?: boolean;
+        utxoSelectionPreferences?: UtxoSelectionPreferences;
+    }): Promise<PreparedTx & {
+        maxAmount: number;
+        fee: number;
+    }>;
 }
 export { Client };

package/lib/clientKeystore.d.ts

@@ -1,6 +1,6 @@
 import { FeeRate, TxHash } from '@xchainjs/xchain-client';
 import { Address } from '@xchainjs/xchain-util';
-import { TxParams } from '@xchainjs/xchain-utxo';
+import { TxParams, UtxoSelectionPreferences } from '@xchainjs/xchain-utxo';
 import { ECPairInterface } from 'ecpair';
 import { Client } from './client';
 export declare class ClientKeystore extends Client {
@@ -30,10 +30,34 @@ export declare class ClientKeystore extends Client {
     getDashKeys(phrase: string, index?: number): ECPairInterface;
     /**
      * Asynchronously transfers assets between addresses.
-     * @param {TxParams & { feeRate?: FeeRate }} params - Parameters for the transfer.
+     * @param {TxParams & { feeRate?: FeeRate; utxoSelectionPreferences?: UtxoSelectionPreferences }} params - Parameters for the transfer.
      * @returns {Promise<TxHash>} A promise resolving to the transaction hash.
      */
     transfer(params: TxParams & {
         feeRate?: FeeRate;
+        utxoSelectionPreferences?: UtxoSelectionPreferences;
     }): Promise<TxHash>;
+    /**
+     * Transfer the maximum amount of DASH (sweep).
+     *
+     * Calculates the maximum sendable amount after fees, signs, and broadcasts the transaction.
+     * @param {Object} params The transfer parameters.
+     * @param {string} params.recipient The recipient address.
+     * @param {string} [params.memo] Optional memo for the transaction.
+     * @param {FeeRate} [params.feeRate] Optional fee rate. Defaults to 'average' rate.
+     * @param {number} [params.walletIndex] Optional wallet index. Defaults to 0.
+     * @param {UtxoSelectionPreferences} [params.utxoSelectionPreferences] Optional UTXO selection preferences.
+     * @returns {Promise<{ hash: TxHash; maxAmount: number; fee: number }>} The transaction hash, amount sent, and fee.
+     */
+    transferMax(params: {
+        recipient: Address;
+        memo?: string;
+        feeRate?: FeeRate;
+        walletIndex?: number;
+        utxoSelectionPreferences?: UtxoSelectionPreferences;
+    }): Promise<{
+        hash: TxHash;
+        maxAmount: number;
+        fee: number;
+    }>;
 }