feat(abstract-utxo): always use wasm-utxo backend for recovery

Remove utxolib PSBT backend option and always use wasm-utxo for all
recoveries. This simplifies the code and ensures consistency across
all environments.

Issue: BTC-2891

Co-authored-by: llm-git <llm-git@ttll.de>

Author: OttoAllmendinger

modules/abstract-utxo/src/recovery/backupKeyRecovery.ts

@@ -18,13 +18,13 @@ import { signAndVerifyPsbt } from '../transaction/fixedScript/signTransaction';
 import { generateAddressWithChainAndIndex } from '../address';
 import { encodeTransaction } from '../transaction/decode';
 import { getReplayProtectionPubkeys } from '../transaction/fixedScript/replayProtection';
-import { isTestnetCoin, UtxoCoinName } from '../names';
+import { UtxoCoinName } from '../names';
 import type { WalletUnspent } from '../unspent';
 
 import { forCoin, RecoveryProvider } from './RecoveryProvider';
 import { MempoolApi } from './mempoolApi';
 import { CoingeckoApi } from './coingeckoApi';
-import { createBackupKeyRecoveryPsbt, getRecoveryAmount, PsbtBackend, toPsbtToUtxolibPsbt } from './psbt';
+import { createBackupKeyRecoveryPsbt, getRecoveryAmount, toPsbtToUtxolibPsbt } from './psbt';
 
 type ScriptType2Of3 = utxolib.bitgo.outputScripts.ScriptType2Of3;
 type ChainCode = utxolib.bitgo.ChainCode;
@@ -370,20 +370,12 @@ export async function backupKeyRecovery(
     }
   }
 
-  // Use wasm-utxo for testnet coins only, utxolib for mainnet
-  const backend: PsbtBackend = isTestnetCoin(coin.name) ? 'wasm-utxo' : 'utxolib';
-  let psbt = createBackupKeyRecoveryPsbt(
-    coin.getChain(),
-    walletKeys,
-    unspents,
-    {
-      feeRateSatVB: feePerByte,
-      recoveryDestination: params.recoveryDestination,
-      keyRecoveryServiceFee: krsFee,
-      keyRecoveryServiceFeeAddress: krsFeeAddress,
-    },
-    backend
-  );
+  let psbt = createBackupKeyRecoveryPsbt(coin.getChain(), walletKeys, unspents, {
+    feeRateSatVB: feePerByte,
+    recoveryDestination: params.recoveryDestination,
+    keyRecoveryServiceFee: krsFee,
+    keyRecoveryServiceFeeAddress: krsFeeAddress,
+  });
 
   if (isUnsignedSweep) {
     return {
@@ -414,13 +406,7 @@ export async function backupKeyRecovery(
     psbt = signAndVerifyPsbt(psbt, walletKeys.backup, rootWalletKeysWasm, replayProtection);
     // Finalize and extract transaction
     psbt.finalizeAllInputs();
-    if (psbt instanceof utxolib.bitgo.UtxoPsbt) {
-      txInfo.transactionHex = psbt.extractTransaction().toBuffer().toString('hex');
-    } else if (psbt instanceof fixedScriptWallet.BitGoPsbt) {
-      txInfo.transactionHex = Buffer.from(psbt.extractTransaction().toBytes()).toString('hex');
-    } else {
-      throw new Error('expected a UtxoPsbt or BitGoPsbt object');
-    }
+    txInfo.transactionHex = Buffer.from(psbt.extractTransaction().toBytes()).toString('hex');
   }
 
   if (isKrsRecovery) {

modules/abstract-utxo/src/recovery/crossChainRecovery.ts

@@ -1,25 +1,18 @@
 import * as utxolib from '@bitgo/utxo-lib';
 import { BIP32Interface, bip32 } from '@bitgo/secp256k1';
-import { Dimensions } from '@bitgo/unspents';
 import { CoinName, fixedScriptWallet } from '@bitgo/wasm-utxo';
 import { BitGoBase, IWallet, Keychain, Triple, Wallet } from '@bitgo/sdk-core';
 import { decrypt } from '@bitgo/sdk-api';
 
 import { AbstractUtxoCoin, TransactionInfo } from '../abstractUtxoCoin';
 import { signAndVerifyPsbt } from '../transaction/fixedScript/signTransaction';
-import { getNetworkFromCoinName, isTestnetCoin, UtxoCoinName } from '../names';
+import { getNetworkFromCoinName, UtxoCoinName } from '../names';
 import { encodeTransaction } from '../transaction/decode';
 import { getReplayProtectionPubkeys } from '../transaction/fixedScript/replayProtection';
 import { toTNumber } from '../tnumber';
 import type { Unspent, WalletUnspent } from '../unspent';
 
-import {
-  PsbtBackend,
-  createEmptyWasmPsbt,
-  addWalletInputsToWasmPsbt,
-  addOutputToWasmPsbt,
-  getRecoveryAmount,
-} from './psbt';
+import { createEmptyWasmPsbt, addWalletInputsToWasmPsbt, addOutputToWasmPsbt, getRecoveryAmount } from './psbt';
 
 const { unspentSum } = utxolib.bitgo;
 type RootWalletKeys = utxolib.bitgo.RootWalletKeys;
@@ -337,66 +330,16 @@ async function getPrv(xprv?: string, passphrase?: string, wallet?: IWallet | Wal
   return getPrv(decrypt(passphrase, encryptedPrv));
 }
 
-/**
- * Create a sweep transaction for cross-chain recovery using PSBT (utxolib implementation)
- * @param network
- * @param walletKeys
- * @param unspents
- * @param targetAddress
- * @param feeRateSatVB
- * @return unsigned PSBT
- */
-function createSweepTransactionUtxolib<TNumber extends number | bigint = number>(
-  coinName: CoinName,
-  walletKeys: RootWalletKeys,
-  unspents: WalletUnspent<TNumber>[],
-  targetAddress: string,
-  feeRateSatVB: number
-): utxolib.bitgo.UtxoPsbt {
-  const network = getNetworkFromCoinName(coinName);
-  const inputValue = unspentSum<bigint>(
-    unspents.map((u) => ({ ...u, value: BigInt(u.value) })),
-    'bigint'
-  );
-  const vsize = Dimensions.fromUnspents(unspents, {
-    p2tr: { scriptPathLevel: 1 },
-    p2trMusig2: { scriptPathLevel: undefined },
-  })
-    .plus(Dimensions.fromOutput({ script: utxolib.address.toOutputScript(targetAddress, network) }))
-    .getVSize();
-  const fee = BigInt(Math.round(vsize * feeRateSatVB));
-
-  const psbt = utxolib.bitgo.createPsbtForNetwork({ network });
-  utxolib.bitgo.addXpubsToPsbt(psbt, walletKeys);
-
-  unspents.forEach((unspent) => {
-    utxolib.bitgo.addWalletUnspentToPsbt(
-      psbt,
-      { ...unspent, value: BigInt(unspent.value) },
-      walletKeys,
-      'user',
-      'backup',
-      { skipNonWitnessUtxo: true }
-    );
-  });
-
-  const recoveryOutputScript = utxolib.address.toOutputScript(targetAddress, network);
-  psbt.addOutput({ script: recoveryOutputScript, value: inputValue - fee });
-
-  return psbt;
-}
-
 /**
  * Create a sweep transaction for cross-chain recovery using wasm-utxo
- * @param network
+ * @param coinName - BitGo coin name (e.g. 'btc', 'tbtc', 'ltc')
  * @param walletKeys
  * @param unspents
  * @param targetAddress
  * @param feeRateSatVB
- * @param coinName - BitGo coin name (e.g. 'btc', 'tbtc', 'ltc')
  * @return unsigned PSBT
  */
-function createSweepTransactionWasm<TNumber extends number | bigint = number>(
+function createSweepTransaction<TNumber extends number | bigint = number>(
   coinName: CoinName,
   walletKeys: RootWalletKeys,
   unspents: WalletUnspent<TNumber>[],
@@ -422,36 +365,9 @@ function createSweepTransactionWasm<TNumber extends number | bigint = number>(
   // Add output to wasm PSBT
   addOutputToWasmPsbt(wasmPsbt, targetAddress, inputValue - fee, coinName);
 
-  // Convert to utxolib PSBT for signing and return
   return wasmPsbt;
 }
 
-/**
- * Create a sweep transaction for cross-chain recovery using PSBT
- * @param network
- * @param walletKeys
- * @param unspents
- * @param targetAddress
- * @param feeRateSatVB
- * @param backend - Which backend to use for PSBT creation (default: 'wasm-utxo')
- * @param coinName - BitGo coin name (required for wasm-utxo backend)
- * @return unsigned PSBT
- */
-function createSweepTransaction<TNumber extends number | bigint = number>(
-  coinName: CoinName,
-  walletKeys: RootWalletKeys,
-  unspents: WalletUnspent<TNumber>[],
-  targetAddress: string,
-  feeRateSatVB: number,
-  backend: PsbtBackend = 'wasm-utxo'
-): utxolib.bitgo.UtxoPsbt | fixedScriptWallet.BitGoPsbt {
-  if (backend === 'wasm-utxo') {
-    return createSweepTransactionWasm(coinName, walletKeys, unspents, targetAddress, feeRateSatVB);
-  } else {
-    return createSweepTransactionUtxolib(coinName, walletKeys, unspents, targetAddress, feeRateSatVB);
-  }
-}
-
 type RecoverParams = {
   /** Wallet ID (can be v1 wallet or v2 wallet) */
   walletId: string;
@@ -500,15 +416,12 @@ export async function recoverCrossChain<TNumber extends number | bigint = number
   const feeRateSatVB = await getFeeRateSatVB(params.sourceCoin);
 
   // Create PSBT for both signed and unsigned recovery
-  // Use wasm-utxo for testnet coins only, utxolib for mainnet
-  const backend: PsbtBackend = isTestnetCoin(params.sourceCoin.name) ? 'wasm-utxo' : 'utxolib';
   let psbt = createSweepTransaction<TNumber>(
     params.sourceCoin.getChain(),
     walletKeys,
     walletUnspents,
     params.recoveryAddress,
-    feeRateSatVB,
-    backend
+    feeRateSatVB
   );
 
   // For unsigned recovery, return unsigned PSBT hex

modules/abstract-utxo/src/recovery/psbt.ts

@@ -1,8 +1,7 @@
 import * as utxolib from '@bitgo/utxo-lib';
-import { Dimensions } from '@bitgo/unspents';
-import { CoinName, fixedScriptWallet, utxolibCompat, address as wasmAddress } from '@bitgo/wasm-utxo';
+import { CoinName, fixedScriptWallet, address as wasmAddress } from '@bitgo/wasm-utxo';
 
-import { getNetworkFromCoinName, UtxoCoinName } from '../names';
+import { getNetworkFromCoinName } from '../names';
 import type { WalletUnspent } from '../unspent';
 
 type RootWalletKeys = utxolib.bitgo.RootWalletKeys;
@@ -11,13 +10,6 @@ const { chainCodesP2tr, chainCodesP2trMusig2 } = utxolib.bitgo;
 
 type ChainCode = utxolib.bitgo.ChainCode;
 
-/**
- * Backend to use for PSBT creation.
- * - 'wasm-utxo': Use wasm-utxo for PSBT creation (default)
- * - 'utxolib': Use utxolib for PSBT creation (legacy)
- */
-export type PsbtBackend = 'wasm-utxo' | 'utxolib';
-
 /**
  * Check if a chain code is for a taproot script type
  */
@@ -27,18 +19,6 @@ export function isTaprootChain(chain: ChainCode): boolean {
   );
 }
 
-/**
- * Convert coin name to wasm-utxo network name
- */
-export function toNetworkName(coinName: UtxoCoinName): utxolibCompat.UtxolibName {
-  const network = getNetworkFromCoinName(coinName);
-  const networkName = utxolib.getNetworkName(network);
-  if (!networkName) {
-    throw new Error(`Invalid coinName: ${coinName}`);
-  }
-  return networkName;
-}
-
 class InsufficientFundsError extends Error {
   constructor(
     public totalInputAmount: bigint,
@@ -65,56 +45,6 @@ interface CreateBackupKeyRecoveryPsbtOptions {
   blockHeight?: number;
 }
 
-/**
- * Create a backup key recovery PSBT using utxolib (legacy implementation)
- */
-function createBackupKeyRecoveryPsbtUtxolib(
-  coinName: CoinName,
-  rootWalletKeys: RootWalletKeys,
-  unspents: WalletUnspent<bigint>[],
-  options: CreateBackupKeyRecoveryPsbtOptions
-): utxolib.bitgo.UtxoPsbt {
-  const network = getNetworkFromCoinName(coinName);
-  const { feeRateSatVB, recoveryDestination, keyRecoveryServiceFee, keyRecoveryServiceFeeAddress } = options;
-
-  const psbt = utxolib.bitgo.createPsbtForNetwork({ network });
-  utxolib.bitgo.addXpubsToPsbt(psbt, rootWalletKeys);
-  unspents.forEach((unspent) => {
-    utxolib.bitgo.addWalletUnspentToPsbt(psbt, unspent, rootWalletKeys, 'user', 'backup');
-  });
-
-  let dimensions = Dimensions.fromPsbt(psbt).plus(
-    Dimensions.fromOutput({ script: utxolib.address.toOutputScript(recoveryDestination, network) })
-  );
-
-  if (keyRecoveryServiceFeeAddress) {
-    dimensions = dimensions.plus(
-      Dimensions.fromOutput({
-        script: utxolib.address.toOutputScript(keyRecoveryServiceFeeAddress, network),
-      })
-    );
-  }
-
-  const approximateFee = BigInt(dimensions.getVSize() * feeRateSatVB);
-  const totalInputAmount = utxolib.bitgo.unspentSum(unspents, 'bigint');
-  const recoveryAmount = totalInputAmount - approximateFee - keyRecoveryServiceFee;
-
-  if (recoveryAmount < BigInt(0)) {
-    throw new InsufficientFundsError(totalInputAmount, approximateFee, keyRecoveryServiceFee, recoveryAmount);
-  }
-
-  psbt.addOutput({ script: utxolib.address.toOutputScript(recoveryDestination, network), value: recoveryAmount });
-
-  if (keyRecoveryServiceFeeAddress) {
-    psbt.addOutput({
-      script: utxolib.address.toOutputScript(keyRecoveryServiceFeeAddress, network),
-      value: keyRecoveryServiceFee,
-    });
-  }
-
-  return psbt;
-}
-
 /**
  * Check if the network is a Zcash network
  */
@@ -279,57 +209,39 @@ function createBackupKeyRecoveryPsbtWasm(
     addOutputToWasmPsbt(wasmPsbt, keyRecoveryServiceFeeAddress, keyRecoveryServiceFee, coinName);
   }
 
-  // Convert to utxolib PSBT for signing and return
   return wasmPsbt;
 }
 
 /**
  * Create a backup key recovery PSBT.
  *
- * @param network - The network for the PSBT
+ * @param coinName - The coin name for the PSBT
  * @param rootWalletKeys - The wallet keys
  * @param unspents - The unspents to include in the PSBT
  * @param options - Options for creating the PSBT
- * @param backend - Which backend to use for PSBT creation (default: 'wasm-utxo')
  */
 export function createBackupKeyRecoveryPsbt(
   coinName: CoinName,
   rootWalletKeys: RootWalletKeys,
   unspents: WalletUnspent<bigint>[],
-  options: CreateBackupKeyRecoveryPsbtOptions,
-  backend: PsbtBackend = 'wasm-utxo'
-): utxolib.bitgo.UtxoPsbt | fixedScriptWallet.BitGoPsbt {
+  options: CreateBackupKeyRecoveryPsbtOptions
+): fixedScriptWallet.BitGoPsbt {
   if (options.keyRecoveryServiceFee > 0 && !options.keyRecoveryServiceFeeAddress) {
     throw new Error('keyRecoveryServiceFeeAddress is required when keyRecoveryServiceFee is provided');
   }
 
-  if (backend === 'wasm-utxo') {
-    return createBackupKeyRecoveryPsbtWasm(coinName, rootWalletKeys, unspents, options);
-  } else {
-    return createBackupKeyRecoveryPsbtUtxolib(coinName, rootWalletKeys, unspents, options);
-  }
+  return createBackupKeyRecoveryPsbtWasm(coinName, rootWalletKeys, unspents, options);
 }
 
 export function getRecoveryAmount(
-  psbt: utxolib.bitgo.UtxoPsbt | fixedScriptWallet.BitGoPsbt,
+  psbt: fixedScriptWallet.BitGoPsbt,
   walletKeys: RootWalletKeys,
   address: string
 ): bigint {
-  if (psbt instanceof utxolib.bitgo.UtxoPsbt) {
-    const recoveryOutputScript = utxolib.address.toOutputScript(address, psbt.network);
-    const output = psbt.txOutputs.find((o) => o.script.equals(recoveryOutputScript));
-    if (!output) {
-      throw new Error(`Recovery destination output not found in PSBT: ${address}`);
-    }
-    return output.value;
-  }
-  if (psbt instanceof fixedScriptWallet.BitGoPsbt) {
-    const parsedOutputs = psbt.parseOutputsWithWalletKeys(walletKeys);
-    const recoveryOutput = parsedOutputs.find((o) => o.address === address);
-    if (!recoveryOutput) {
-      throw new Error(`Recovery destination output not found in PSBT: ${address}`);
-    }
-    return recoveryOutput.value;
+  const parsedOutputs = psbt.parseOutputsWithWalletKeys(walletKeys);
+  const recoveryOutput = parsedOutputs.find((o) => o.address === address);
+  if (!recoveryOutput) {
+    throw new Error(`Recovery destination output not found in PSBT: ${address}`);
   }
-  throw new Error('Invalid PSBT type');
+  return BigInt(recoveryOutput.value);
 }

modules/abstract-utxo/test/unit/fixtures/bch/recovery/backupKeyRecovery-fullSignedRecovery-customUserKeyPath-p2sh.json

@@ -25,6 +25,6 @@
       "valueString": "300000000"
     }
   ],
-  "transactionHex": "02000000038bb70cc33ba011c71d725c686a81b1f19d2955d204300f384838725f076edd9800000000fdfe0000483045022100e68d7057fdad1fd9e7da1dd0d2745600cd7ebc6b3bdfdc8c977c27f117dec1ee022014a862be7e83b092cea8c4791d47d9ea87bc3a7e4d7851fad30e9da0a8933efc41483045022100d4295855382edd094687ade706ccf51375c716e3acd2156cb0d7403f857a795f0220409c5b8f8ed66f43e563c2c4e401b8ca0cfab3c89452645c92c4010ee07d74d5414c69522102587d7749d1ed2a3d3d300b969e68cbedb042ea19e3ee90c4131e2092f5e1181e21030795af84ecc10252d8a894f54845beeb5624a1c24c3747cc654bd430539dee3521029b30ebe8eb23f8cec82f25a80e3b423979ec3ba1fe07d9d4ed9f6361258bc31d53aeffffffffeec68db14dcb1f1340f46c6f9d9a7303915ccd9022d59e7c9e13dae7c91ffe9b00000000fc004730440220487d165adcc526d5bf659e5dfec94e07c8eaa6567308d29a7b4676456e71288802204172d68f63bcc29141095b81a9366056b6d11260d86c6f1dfa8a154953b0a7854147304402205d3c5b6105a2fa1819973ef6b83c1575468be0bce6757992b365583c11690fa902200134cc5b58d6590664f45e797990334b4fa989b21ef2ec5194a9d3ae262855ad414c69522102587d7749d1ed2a3d3d300b969e68cbedb042ea19e3ee90c4131e2092f5e1181e21030795af84ecc10252d8a894f54845beeb5624a1c24c3747cc654bd430539dee3521029b30ebe8eb23f8cec82f25a80e3b423979ec3ba1fe07d9d4ed9f6361258bc31d53aeffffffffe3ad05836997543b105275534081e8eac637e0e4d2a5bc544d7b0d22f32d49de00000000fc00473044022025d60881a0bf878533362094e8a531f1a066fa2f85ac92d5965f20d7227682c20220685efc33bb4e3a81963f4ebd0a18ec088db96f20432e1c943228e2c1fff2996141473044022065fb4062083c3cbf12638cf087b36512d22458cdf76e5f92582992885efab050022039885486cc1b912d0843cf8227a7473b5938c8927a9b7f41efd03af87752fffe414c69522102587d7749d1ed2a3d3d300b969e68cbedb042ea19e3ee90c4131e2092f5e1181e21030795af84ecc10252d8a894f54845beeb5624a1c24c3747cc654bd430539dee3521029b30ebe8eb23f8cec82f25a80e3b423979ec3ba1fe07d9d4ed9f6361258bc31d53aeffffffff0160d8c1230000000017a91439c65a0d0072a140694d6b13ec5f5f2437de99ff8700000000",
-  "txid": "b50d92e5be1c143941ad3ce4aa176c69c6299cd4c689d5caceeff5f943f8ddb3"
+  "transactionHex": "02000000038bb70cc33ba011c71d725c686a81b1f19d2955d204300f384838725f076edd9800000000fdfd0000483045022100a8fdd2a692da1daba4cbf1915d3193dcc29ecae91525750cd84277aa5a0baa91022046cabd7460db3ac554ea35173c9077fe4286d78a0a4205bc91422d4b834e6fa14147304402200104623fc6c7dbe8c027fe71e677d3be2c7f73adf94d07d00cbe1bee96f6508102204a38a8fcaa50cb2028e95fa51dcd33058b077f548291a61a7ff6d6d56c5a5684414c69522102587d7749d1ed2a3d3d300b969e68cbedb042ea19e3ee90c4131e2092f5e1181e21030795af84ecc10252d8a894f54845beeb5624a1c24c3747cc654bd430539dee3521029b30ebe8eb23f8cec82f25a80e3b423979ec3ba1fe07d9d4ed9f6361258bc31d53aefeffffffeec68db14dcb1f1340f46c6f9d9a7303915ccd9022d59e7c9e13dae7c91ffe9b00000000fc0047304402200a223a6d23dcec4be36563f2fb9e6ae5c65db38961dd1fc33fa12c1f8f88c5a802204696d4ff62512c0262161efd751bb717b32ad97c83a8a692f7811f68d0c22a6741473044022023b2cb674c502085b9c351c5386c73c0a9e422ea4d08cd7b395cd374ad4b94d302201110faeaba5ea428769b182ceb0868efd09b60659a62e235a8f6155ca6e4bef2414c69522102587d7749d1ed2a3d3d300b969e68cbedb042ea19e3ee90c4131e2092f5e1181e21030795af84ecc10252d8a894f54845beeb5624a1c24c3747cc654bd430539dee3521029b30ebe8eb23f8cec82f25a80e3b423979ec3ba1fe07d9d4ed9f6361258bc31d53aefeffffffe3ad05836997543b105275534081e8eac637e0e4d2a5bc544d7b0d22f32d49de00000000fc0047304402200597e97b2a4134ca16ffe54d9edfe990078ebf8d06dce9fc50debf5fb6317c4802202c6f89584a4490e2a251f5a5c0a9287613f151bcea59ac9d87e36249c0b087d04147304402205a83d823d1d8c5633a452f18113073a9a2a96995d14dec3e1ad8e18cc2b01a8802206b2d6b28a1531148526f45ad04d5449271a70c1b21ab7141f9a76ef25035e18d414c69522102587d7749d1ed2a3d3d300b969e68cbedb042ea19e3ee90c4131e2092f5e1181e21030795af84ecc10252d8a894f54845beeb5624a1c24c3747cc654bd430539dee3521029b30ebe8eb23f8cec82f25a80e3b423979ec3ba1fe07d9d4ed9f6361258bc31d53aefeffffff0134d7c1230000000017a91439c65a0d0072a140694d6b13ec5f5f2437de99ff8700000000",
+  "txid": "d3df089c810a80589df88c6b5a7df6df9ee4e29a50c391a8ca1aace7927ab72f"
 }