fix(express): consolidateUnspents v1 type codec

Ticket: WP-6717

Author: lokesh-bitgo

modules/express/src/typedRoutes/api/v1/consolidateUnspents.ts

@@ -12,57 +12,86 @@ export const ConsolidateUnspentsRequestParams = {
 
 /**
  * Request body for consolidating unspents in a wallet
+ *
+ * Parameters match SDK's ConsolidateUnspentsOptions interface.
+ * Handler passes request body directly to wallet.consolidateUnspents().
  */
 export const ConsolidateUnspentsRequestBody = {
   /** The wallet passphrase to decrypt the user key */
   walletPassphrase: optional(t.string),
   /** The extended private key (alternative to walletPassphrase) */
   xprv: optional(t.string),
-  /** Whether to validate addresses (defaults to true) */
-  validate: optional(t.boolean),
-  /** Target number of unspents to maintain (defaults to 1) */
-  target: optional(t.number),
-  /** Minimum size of unspents to consolidate */
-  minSize: optional(t.union([t.number, t.string])),
-  /** Maximum size of unspents to consolidate */
-  maxSize: optional(t.union([t.number, t.string])),
-  /** Maximum number of inputs per consolidation transaction (defaults to 200, must be ≥ 2) */
-  maxInputCountPerConsolidation: optional(t.number),
-  /** Maximum number of consolidation iterations (defaults to -1) */
-  maxIterationCount: optional(t.number),
-  /** Minimum number of confirmations needed for an unspent to be included (defaults to 1) */
-  minConfirms: optional(t.number),
   /** Custom fee rate in satoshis per kilobyte */
   feeRate: optional(t.number),
+  /** Upper limit for fee rate in satoshis per kilobyte */
+  maxFeeRate: optional(t.number),
+  /** Maximum relative portion willing to spend on fees (as decimal, e.g., 0.1 for 10%) */
+  maxFeePercentage: optional(t.number),
+  /** Target number of blocks for fee estimation */
+  feeTxConfirmTarget: optional(t.number),
+  /** Minimum value of unspents to consolidate (in base units) */
+  minValue: optional(t.union([t.number, t.string])),
+  /** Maximum value of unspents to consolidate (in base units) */
+  maxValue: optional(t.union([t.number, t.string])),
+  /** Minimum blockchain height for unspents to be included */
+  minHeight: optional(t.number),
+  /** Minimum number of confirmations needed for an unspent (defaults to 1) */
+  minConfirms: optional(t.number),
+  /** Whether minConfirms also applies to change outputs */
+  enforceMinConfirmsForChange: optional(t.boolean),
+  /** Maximum number of unspents to use in a single transaction */
+  limit: optional(t.number),
+  /** Number of new unspents to create */
+  numUnspentsToMake: optional(t.number),
+  /** Target address for consolidated funds */
+  targetAddress: optional(t.string),
+  /** Transaction format type */
+  txFormat: optional(t.union([t.literal('legacy'), t.literal('psbt'), t.literal('psbt-lite')])),
+  /** Enable bulk consolidation (creates multiple transactions if needed) */
+  bulk: optional(t.boolean),
+  /** Transaction comment */
+  comment: optional(t.string),
+  /** One-time password for additional security */
+  otp: optional(t.string),
 };
 
+/**
+ * Single transaction response object
+ */
+const ConsolidateUnspentsSingleTxResponse = t.type({
+  /** The status of the transaction ('accepted', 'pendingApproval', or 'otp') */
+  status: t.string,
+  /** The transaction hex */
+  tx: t.string,
+  /** The transaction hash/ID */
+  hash: t.string,
+  /** Whether the transaction is instant */
+  instant: t.boolean,
+  /** The instant ID (if applicable) */
+  instantId: optional(t.string),
+  /** The fee amount in base units */
+  fee: t.number,
+  /** The fee rate in base units per kilobyte */
+  feeRate: t.number,
+  /** Travel rule information */
+  travelInfos: t.unknown,
+  /** BitGo fee information (if applicable) */
+  bitgoFee: optional(t.unknown),
+  /** Travel rule result (if applicable) */
+  travelResult: optional(t.unknown),
+});
+
 /**
  * Response for consolidating unspents in a wallet
+ *
+ * SDK returns a single transaction object when consolidating normally,
+ * or an array of transaction objects when bulk consolidation is used.
+ * Handler returns SDK result directly without transformation.
  */
-export const ConsolidateUnspentsResponse = t.array(
-  t.type({
-    /** The status of the transaction ('accepted', 'pendingApproval', or 'otp') */
-    status: t.string,
-    /** The transaction hex */
-    tx: t.string,
-    /** The transaction hash/ID */
-    hash: t.string,
-    /** Whether the transaction is instant */
-    instant: t.boolean,
-    /** The instant ID (if applicable) */
-    instantId: optional(t.string),
-    /** The fee amount in satoshis */
-    fee: t.number,
-    /** The fee rate in satoshis per kilobyte */
-    feeRate: t.number,
-    /** Travel rule information */
-    travelInfos: t.unknown,
-    /** BitGo fee information (if applicable) */
-    bitgoFee: optional(t.unknown),
-    /** Travel rule result (if applicable) */
-    travelResult: optional(t.unknown),
-  })
-);
+export const ConsolidateUnspentsResponse = t.union([
+  ConsolidateUnspentsSingleTxResponse, // Single transaction
+  t.array(ConsolidateUnspentsSingleTxResponse), // Multiple transactions (bulk mode)
+]);
 
 /**
  * Consolidate unspents in a wallet