Merge pull request #5441 from BitGo/BTC-1801.fix-presign-for-descriptor-wallets

fix(abstract-utxo): presign for descriptor wallets

Author: OttoAllmendinger

modules/abstract-utxo/src/abstractUtxoCoin.ts

@@ -74,7 +74,8 @@ import { toBip32Triple, UtxoKeychain, UtxoNamedKeychains } from './keychains';
 import { verifyKeySignature, verifyUserPublicKey } from './verifyKey';
 import { getPolicyForEnv } from './descriptor/validatePolicy';
 import { signTransaction } from './transaction/signTransaction';
-import { UtxoWallet } from './wallet';
+import { isUtxoWalletData, UtxoWallet } from './wallet';
+import { isDescriptorWalletData } from './descriptor/descriptorWallet';
 
 import ScriptType2Of3 = utxolib.bitgo.outputScripts.ScriptType2Of3;
 
@@ -1094,6 +1095,9 @@ export abstract class AbstractUtxoCoin extends BaseCoin {
   }
 
   async presignTransaction(params: PresignTransactionOptions): Promise<any> {
+    if (params.walletData && isUtxoWalletData(params.walletData) && isDescriptorWalletData(params.walletData)) {
+      return params;
+    }
     // In the case that we have a 'psbt-lite' transaction format, we want to indicate in signing to not fail
     const txHex = (params.txHex ?? params.txPrebuild?.txHex) as string;
     if (

modules/abstract-utxo/src/names.ts

@@ -1,5 +1,35 @@
 import * as utxolib from '@bitgo/utxo-lib';
 
+export const utxoCoinsMainnet = ['btc', 'bch', 'bcha', 'bsv', 'btg', 'dash', 'doge', 'ltc', 'zec'] as const;
+export const utxoCoinsTestnet = [
+  'tbtc',
+  'tbch',
+  'tbsv',
+  'tdash',
+  'tdoge',
+  'tltc',
+  'tzec',
+  'tbtcsig',
+  'tbtc4',
+  'tbtcbgsig',
+] as const;
+
+export type UtxoCoinNameMainnet = (typeof utxoCoinsMainnet)[number];
+export type UtxoCoinNameTestnet = (typeof utxoCoinsTestnet)[number];
+export type UtxoCoinName = UtxoCoinNameMainnet | UtxoCoinNameTestnet;
+
+export function isUtxoCoinNameMainnet(coinName: string): coinName is UtxoCoinNameMainnet {
+  return utxoCoinsMainnet.includes(coinName as UtxoCoinNameMainnet);
+}
+
+export function isUtxoCoinNameTestnet(coinName: string): coinName is UtxoCoinNameTestnet {
+  return utxoCoinsTestnet.includes(coinName as UtxoCoinNameTestnet);
+}
+
+export function isUtxoCoinName(coinName: string): coinName is UtxoCoinName {
+  return isUtxoCoinNameMainnet(coinName) || isUtxoCoinNameTestnet(coinName);
+}
+
 function getNetworkName(n: utxolib.Network): utxolib.NetworkName {
   const name = utxolib.getNetworkName(n);
   if (!name) {
@@ -12,7 +42,7 @@ function getNetworkName(n: utxolib.Network): utxolib.NetworkName {
  * @param n
  * @returns the family name for a network. Testnets and mainnets of the same coin share the same family name.
  */
-export function getFamilyFromNetwork(n: utxolib.Network): string {
+export function getFamilyFromNetwork(n: utxolib.Network): UtxoCoinNameMainnet {
   switch (getNetworkName(n)) {
     case 'bitcoin':
     case 'testnet':

modules/abstract-utxo/src/wallet.ts

@@ -1,14 +1,21 @@
 import { Wallet, WalletData } from '@bitgo/sdk-core';
 
+import { isUtxoCoinName, UtxoCoinName } from './names';
+
 // parseTransactions' return type makes use of WalletData's type but with customChangeKeySignatures as required.
 export interface UtxoWalletData extends WalletData {
+  coin: UtxoCoinName;
   customChangeKeySignatures: {
     user: string;
     backup: string;
     bitgo: string;
   };
 }
 
+export function isUtxoWalletData(obj: WalletData): obj is UtxoWalletData {
+  return isUtxoCoinName(obj.coin);
+}
+
 export interface UtxoWallet extends Wallet {
   _wallet: UtxoWalletData;
 }