Merge pull request #5267 from BitGo/BTC-1450.refactor-abstract-utxo-wallet

refactor(abstract-utxo): AbstractUtxoCoinWallet

Author: lcovar

modules/abstract-utxo/src/abstractUtxoCoin.ts

@@ -57,30 +57,30 @@ import {
   VerifyAddressOptions as BaseVerifyAddressOptions,
   VerifyTransactionOptions as BaseVerifyTransactionOptions,
   Wallet,
-  WalletData,
 } from '@bitgo/sdk-core';
 import { isReplayProtectionUnspent } from './replayProtection';
 import { signAndVerifyPsbt, signAndVerifyWalletTransaction } from './sign';
 import { supportedCrossChainRecoveries } from './config';
 import {
   assertValidTransactionRecipient,
   explainTx,
-  parseTransaction,
-  verifyTransaction,
   fromExtendedAddressFormat,
   isScriptRecipient,
+  parseTransaction,
+  verifyTransaction,
 } from './transaction';
 import { assertDescriptorWalletAddress, getDescriptorMapFromWallet, isDescriptorWallet } from './descriptor';
 
 import { getChainFromNetwork, getFamilyFromNetwork, getFullNameFromNetwork } from './names';
 import { CustomChangeOptions } from './transaction/fixedScript';
 import { toBip32Triple, UtxoKeychain, UtxoNamedKeychains } from './keychains';
+import { verifyKeySignature, verifyUserPublicKey } from './verifyKey';
+import { getPolicyForEnv } from './descriptor/validatePolicy';
+import { UtxoWallet } from './wallet';
 
 const debug = debugLib('bitgo:v2:utxo');
 
 import ScriptType2Of3 = utxolib.bitgo.outputScripts.ScriptType2Of3;
-import { verifyKeySignature, verifyUserPublicKey } from './verifyKey';
-import { getPolicyForEnv } from './descriptor/validatePolicy';
 
 type UtxoCustomSigningFunction<TNumber extends number | bigint> = {
   (params: {
@@ -198,27 +198,10 @@ export interface TransactionParams extends BaseTransactionParams {
   rbfTxIds?: string[];
 }
 
-// parseTransactions' return type makes use of WalletData's type but with customChangeKeySignatures as required.
-export interface AbstractUtxoCoinWalletData extends WalletData {
-  customChangeKeySignatures: {
-    user: string;
-    backup: string;
-    bitgo: string;
-  };
-}
-
-export class AbstractUtxoCoinWallet extends Wallet {
-  public _wallet: AbstractUtxoCoinWalletData;
-
-  constructor(bitgo: BitGoBase, baseCoin: IBaseCoin, walletData: any) {
-    super(bitgo, baseCoin, walletData);
-  }
-}
-
 export interface ParseTransactionOptions<TNumber extends number | bigint = number> extends BaseParseTransactionOptions {
   txParams: TransactionParams;
   txPrebuild: TransactionPrebuild<TNumber>;
-  wallet: AbstractUtxoCoinWallet;
+  wallet: UtxoWallet;
   verification?: VerificationOptions;
   reqId?: IRequestTracer;
 }
@@ -346,7 +329,7 @@ export interface VerifyTransactionOptions<TNumber extends number | bigint = numb
   extends BaseVerifyTransactionOptions {
   txPrebuild: TransactionPrebuild<TNumber>;
   txParams: TransactionParams;
-  wallet: AbstractUtxoCoinWallet;
+  wallet: UtxoWallet;
 }
 
 export interface SignPsbtRequest {

modules/abstract-utxo/src/descriptor/descriptorWallet.ts

@@ -3,8 +3,8 @@ import { IWallet, WalletCoinSpecific } from '@bitgo/sdk-core';
 
 import { NamedDescriptor } from './NamedDescriptor';
 import { DescriptorMap } from '../core/descriptor';
-import { AbstractUtxoCoinWalletData } from '../abstractUtxoCoin';
 import { DescriptorValidationPolicy, KeyTriple, toDescriptorMapValidate } from './validatePolicy';
+import { UtxoWalletData } from '../wallet';
 
 type DescriptorWalletCoinSpecific = {
   descriptors: NamedDescriptor[];
@@ -16,15 +16,15 @@ function isDescriptorWalletCoinSpecific(obj: unknown): obj is DescriptorWalletCo
   );
 }
 
-type DescriptorWalletData = AbstractUtxoCoinWalletData & {
+type DescriptorWalletData = UtxoWalletData & {
   coinSpecific: DescriptorWalletCoinSpecific;
 };
 
 interface IDescriptorWallet extends IWallet {
   coinSpecific(): WalletCoinSpecific & DescriptorWalletCoinSpecific;
 }
 
-export function isDescriptorWalletData(obj: AbstractUtxoCoinWalletData): obj is DescriptorWalletData {
+export function isDescriptorWalletData(obj: UtxoWalletData): obj is DescriptorWalletData {
   return isDescriptorWalletCoinSpecific(obj.coinSpecific);
 }
 

modules/abstract-utxo/src/index.ts

@@ -4,4 +4,5 @@ export * from './recovery';
 export * from './replayProtection';
 export * from './sign';
 
+export { UtxoWallet } from './wallet';
 export * as descriptor from './descriptor';

modules/abstract-utxo/src/wallet.ts

@@ -0,0 +1,14 @@
+import { Wallet, WalletData } from '@bitgo/sdk-core';
+
+// parseTransactions' return type makes use of WalletData's type but with customChangeKeySignatures as required.
+export interface UtxoWalletData extends WalletData {
+  customChangeKeySignatures: {
+    user: string;
+    backup: string;
+    bitgo: string;
+  };
+}
+
+export interface UtxoWallet extends Wallet {
+  _wallet: UtxoWalletData;
+}

modules/abstract-utxo/test/descriptor/descriptorWallet.ts

@@ -1,13 +1,13 @@
 import assert from 'assert';
 import { getDescriptorMapFromWallet, isDescriptorWallet } from '../../src/descriptor';
-import { AbstractUtxoCoinWallet } from '../../src';
+import { UtxoWallet } from '../../src/wallet';
 import { getDefaultXPubs, getDescriptorMap } from '../core/descriptor/descriptor.utils';
 import { toBip32Triple } from '../../src/keychains';
 
 describe('isDescriptorWalletData', function () {
   const descriptorMap = getDescriptorMap('Wsh2Of3');
   it('should return true for valid DescriptorWalletData', function () {
-    const wallet: AbstractUtxoCoinWallet = {
+    const wallet: UtxoWallet = {
       coinSpecific() {
         return {
           descriptors: [...descriptorMap.entries()].map(([name, descriptor]) => ({
@@ -16,7 +16,7 @@ describe('isDescriptorWalletData', function () {
           })),
         };
       },
-    } as unknown as AbstractUtxoCoinWallet;
+    } as unknown as UtxoWallet;
 
     assert(isDescriptorWallet(wallet));
     assert.strictEqual(

modules/bitgo/test/v2/unit/coins/abstractUtxoCoin.ts

@@ -1,16 +1,10 @@
 import * as utxolib from '@bitgo/utxo-lib';
 import * as should from 'should';
 import * as sinon from 'sinon';
-import { UnexpectedAddressError, VerificationOptions } from '@bitgo/sdk-core';
+import { Wallet, UnexpectedAddressError, VerificationOptions } from '@bitgo/sdk-core';
 import { TestBitGo } from '@bitgo/sdk-test';
 import { BitGo } from '../../../../src/bitgo';
-import {
-  AbstractUtxoCoin,
-  AbstractUtxoCoinWallet,
-  Output,
-  TransactionExplanation,
-  TransactionParams,
-} from '@bitgo/abstract-utxo';
+import { AbstractUtxoCoin, UtxoWallet, Output, TransactionExplanation, TransactionParams } from '@bitgo/abstract-utxo';
 
 describe('Abstract UTXO Coin:', () => {
   describe('Parse Transaction:', () => {
@@ -31,7 +25,7 @@ describe('Abstract UTXO Coin:', () => {
       },
     };
 
-    const wallet = sinon.createStubInstance(AbstractUtxoCoinWallet, {
+    const wallet = sinon.createStubInstance(Wallet, {
       migratedFrom: 'v1_wallet_base_address',
     });
 
@@ -60,7 +54,7 @@ describe('Abstract UTXO Coin:', () => {
       const parsedTransaction = await coin.parseTransaction({
         txParams,
         txPrebuild: { txHex: '' },
-        wallet: wallet as any,
+        wallet: wallet as unknown as UtxoWallet,
         verification,
       });
 
@@ -177,8 +171,8 @@ describe('Abstract UTXO Coin:', () => {
     });
 
     it('should consider addresses derived from the custom change keys as internal spends', async () => {
-      const signedSendingWallet = sinon.createStubInstance(AbstractUtxoCoinWallet, stubData.signedSendingWallet as any);
-      const changeWallet = sinon.createStubInstance(AbstractUtxoCoinWallet, stubData.changeWallet as any);
+      const signedSendingWallet = sinon.createStubInstance(Wallet, stubData.signedSendingWallet as any);
+      const changeWallet = sinon.createStubInstance(Wallet, stubData.changeWallet as any);
 
       sinon.stub(coin, 'keychains').returns({
         get: sinon.stub().callsFake(({ id }) => {
@@ -319,14 +313,11 @@ describe('Abstract UTXO Coin:', () => {
       },
     };
 
-    const unsignedSendingWallet = sinon.createStubInstance(
-      AbstractUtxoCoinWallet,
-      stubData.unsignedSendingWallet as any
-    );
+    const unsignedSendingWallet = sinon.createStubInstance(Wallet, stubData.unsignedSendingWallet as any);
 
     it('should fail if the user private key cannot be verified to match the user public key', async () => {
       sinon.stub(coin, 'parseTransaction').resolves(stubData.parseTransactionData.badKey as any);
-      const verifyWallet = sinon.createStubInstance(AbstractUtxoCoinWallet, {});
+      const verifyWallet = sinon.createStubInstance(Wallet, {});
 
       await coin
         .verifyTransaction({