feat(abstract-utxo): move utxo test files to abstract-utxo module

This makes the development cycle more pleasant because we don't have to go to
some other module to test the `abstract-utxo` implementation.

Replaced imports of `BitGo` which pull in the full cursed deptree with imports
of the more modern TestBitGo which has a much lighter deptree.

Issue: BTC-2652

Co-authored-by: llm-git <[email protected]>

Author: OttoAllmendinger

modules/bitgo/test/v2/unit/coins/abstractUtxoCoin.ts renamed to modules/abstract-utxo/test/unit/abstractUtxoCoin.ts

@@ -2,16 +2,16 @@ import * as utxolib from '@bitgo/utxo-lib';
 import should = require('should');
 import * as sinon from 'sinon';
 import { Wallet, UnexpectedAddressError, VerificationOptions, Triple } from '@bitgo/sdk-core';
-import { TestBitGo } from '@bitgo/sdk-test';
-import { BitGo } from '../../../../src/bitgo';
-import { psbtTxHex } from './payGoPSBTHexFixture/psbtHexProof';
-import { bip322Fixtures } from '../../fixtures/bip322/fixtures';
-import { AbstractUtxoCoin, UtxoWallet, Output, TransactionExplanation, TransactionParams } from '@bitgo/abstract-utxo';
+
+import { UtxoWallet, Output, TransactionExplanation, TransactionParams } from '../../src';
+
+import { bip322Fixtures } from './fixtures/bip322/fixtures';
+import { psbtTxHex } from './fixtures/psbtHexProof';
+import { defaultBitGo, getUtxoCoin } from './util';
 
 describe('Abstract UTXO Coin:', () => {
   describe('Parse Transaction:', () => {
-    const bitgo: BitGo = TestBitGo.decorate(BitGo, { env: 'mock' });
-    const coin = bitgo.coin('tbtc') as AbstractUtxoCoin;
+    const coin = getUtxoCoin('tbtc');
 
     /*
      * mock objects which get passed into parse transaction.
@@ -117,8 +117,7 @@ describe('Abstract UTXO Coin:', () => {
   });
 
   describe('Custom Change Wallets', () => {
-    const bitgo: BitGo = TestBitGo.decorate(BitGo, { env: 'mock' });
-    const coin = bitgo.coin('tbtc') as AbstractUtxoCoin;
+    const coin = getUtxoCoin('tbtc');
 
     const keys = {
       send: {
@@ -249,8 +248,7 @@ describe('Abstract UTXO Coin:', () => {
   });
 
   describe('Verify Transaction', () => {
-    const bitgo: BitGo = TestBitGo.decorate(BitGo, { env: 'mock' });
-    const coin = bitgo.coin('tbtc') as AbstractUtxoCoin;
+    const coin = getUtxoCoin('tbtc');
 
     const userKeychain = coin.keychains().create();
     const otherKeychain = coin.keychains().create();
@@ -277,7 +275,7 @@ describe('Abstract UTXO Coin:', () => {
             // user public key swapped out
             user: {
               pub: otherKeychain.pub,
-              encryptedPrv: bitgo.encrypt({
+              encryptedPrv: defaultBitGo.encrypt({
                 input: userKeychain.prv,
                 password: passphrase,
               }),
@@ -547,7 +545,7 @@ describe('Abstract UTXO Coin:', () => {
 
     it('should work with bigint amounts', async () => {
       // need a coin that uses bigint
-      const bigintCoin = bitgo.coin('tdoge') as AbstractUtxoCoin;
+      const bigintCoin = getUtxoCoin('tdoge');
 
       const coinMock = sinon.stub(bigintCoin, 'parseTransaction').resolves({
         keychains: {} as any,
@@ -596,12 +594,7 @@ describe('Abstract UTXO Coin:', () => {
 
   describe('Explain Transaction', function () {
     describe('Verify paygo output when explaining psbt transaction', function () {
-      const bitgo: BitGo = TestBitGo.decorate(BitGo, { env: 'mock' });
-      let coin: AbstractUtxoCoin;
-
-      beforeEach(() => {
-        coin = bitgo.coin('tbtc4') as AbstractUtxoCoin;
-      });
+      const coin = getUtxoCoin('tbtc4');
 
       it('should detect and verify paygo address proof in PSBT', async function () {
         // Call explainTransaction
@@ -610,14 +603,9 @@ describe('Abstract UTXO Coin:', () => {
     });
 
     describe('BIP322 Proof', function () {
-      const bitgo: BitGo = TestBitGo.decorate(BitGo, { env: 'mock' });
-      let coin: AbstractUtxoCoin;
+      const coin = getUtxoCoin('btc');
       const pubs = bip322Fixtures.valid.rootWalletKeys.triple.map((b) => b.neutered().toBase58()) as Triple<string>;
 
-      beforeEach(() => {
-        coin = bitgo.coin('btc') as AbstractUtxoCoin;
-      });
-
       it('should successfully run with a user nonce', async function () {
         const psbtHex = bip322Fixtures.valid.userNonce;
         const result = await coin.explainTransaction({ txHex: psbtHex, pubs });

modules/bitgo/test/v2/unit/coins/utxo/address.ts renamed to modules/abstract-utxo/test/unit/address.ts

@@ -1,12 +1,10 @@
-/**
- * @prettier
- */
 import 'should';
 import * as assert from 'assert';
+
 import * as utxolib from '@bitgo/utxo-lib';
 const { chainCodes } = utxolib.bitgo;
 
-import { AbstractUtxoCoin, GenerateFixedScriptAddressOptions } from '@bitgo/abstract-utxo';
+import { AbstractUtxoCoin, GenerateFixedScriptAddressOptions } from '../../src';
 
 import { utxoCoins, keychains as keychainsBip32, getFixture, shouldEqualJSON } from './util';
 

modules/bitgo/test/v2/unit/coins/utxo/coins.ts renamed to modules/abstract-utxo/test/unit/coins.ts

@@ -1,4 +1,5 @@
 import * as assert from 'assert';
+
 import * as utxolib from '@bitgo/utxo-lib';
 
 import { getUtxoCoinForNetwork, utxoCoins } from './util';

modules/abstract-utxo/test/unit/customSigner.ts

@@ -0,0 +1,103 @@
+import * as utxoLib from '@bitgo/utxo-lib';
+import 'should';
+import 'should-sinon';
+import nock = require('nock');
+import * as sinon from 'sinon';
+import { CustomSigningFunction, common } from '@bitgo/sdk-core';
+
+import { defaultBitGo, getDefaultWalletKeys, getUtxoCoin, getUtxoWallet } from './util';
+
+nock.disableNetConnect();
+
+const bgUrl = common.Environments[defaultBitGo.getEnv()].uri;
+const basecoin = getUtxoCoin('tbtc');
+const wallet = getUtxoWallet(basecoin, {
+  id: '5b34252f1bf349930e34020a',
+  coin: 'tbtc',
+  keys: ['5b3424f91bf349930e340175', '5b3424f91bf349930e340176', '5b3424f91bf349930e340177'],
+});
+
+describe('UTXO Custom Signer Function', function () {
+  const recipients = [
+    { address: 'abc', amount: 123 },
+    { address: 'def', amount: 456 },
+  ];
+  const rootWalletKey = getDefaultWalletKeys();
+  let customSigningFunction: CustomSigningFunction;
+  let stubs: sinon.SinonStub[];
+
+  beforeEach(function () {
+    customSigningFunction = sinon.stub().returns({
+      txHex: 'this-is-a-tx',
+    });
+    stubs = [
+      sinon.stub(wallet.baseCoin, 'postProcessPrebuild').returnsArg(0),
+      sinon.stub(wallet.baseCoin, 'verifyTransaction').resolves(true),
+      sinon.stub(wallet.baseCoin, 'signTransaction').resolves({ txHex: 'this-is-a-tx' }),
+    ];
+  });
+
+  afterEach(function () {
+    stubs.forEach((s) => s.restore());
+    nock.cleanAll();
+  });
+
+  function nocks(txPrebuild: { txHex: string }) {
+    nock(bgUrl)
+      .post(`/api/v2/${wallet.coin()}/wallet/${wallet.id()}/tx/build`)
+      .reply(200, { ...txPrebuild, txInfo: {} });
+    nock(bgUrl).get(`/api/v2/${wallet.coin()}/public/block/latest`).reply(200, { height: 1000 });
+    nock(bgUrl).persist().get(`/api/v2/${wallet.coin()}/key/${wallet.keyIds()[0]}`).reply(200, { pub: 'pub' });
+    nock(bgUrl).persist().get(`/api/v2/${wallet.coin()}/key/${wallet.keyIds()[1]}`).reply(200, { pub: 'pub' });
+    nock(bgUrl).persist().get(`/api/v2/${wallet.coin()}/key/${wallet.keyIds()[2]}`).reply(200, { pub: 'pub' });
+    return nock(bgUrl).post(`/api/v2/${wallet.coin()}/wallet/${wallet.id()}/tx/send`).reply(200, { ok: true });
+  }
+
+  it('should use a custom signing function if provided for PSBT with taprootKeyPathSpend input', async function () {
+    const psbt = utxoLib.testutil.constructPsbt(
+      [{ scriptType: 'taprootKeyPathSpend', value: BigInt(1000) }],
+      [{ scriptType: 'p2sh', value: BigInt(900) }],
+      basecoin.network,
+      rootWalletKey,
+      'unsigned'
+    );
+    const scope = nocks({ txHex: psbt.toHex() });
+    const result = await wallet.sendMany({ recipients, customSigningFunction });
+
+    result.should.have.property('ok', true);
+    customSigningFunction.should.have.been.calledTwice();
+    scope.done();
+  });
+
+  it('should use a custom signing function if provided for PSBT without taprootKeyPathSpend input', async function () {
+    const psbt = utxoLib.testutil.constructPsbt(
+      [{ scriptType: 'p2wsh', value: BigInt(1000) }],
+      [{ scriptType: 'p2sh', value: BigInt(900) }],
+      basecoin.network,
+      rootWalletKey,
+      'unsigned'
+    );
+    const scope = nocks({ txHex: psbt.toHex() });
+    const result = await wallet.sendMany({ recipients, customSigningFunction });
+
+    result.should.have.property('ok', true);
+    customSigningFunction.should.have.been.calledOnce();
+    scope.done();
+  });
+
+  it('should use a custom signing function if provided for Tx without taprootKeyPathSpend input', async function () {
+    const tx = utxoLib.testutil.constructTxnBuilder(
+      [{ scriptType: 'p2wsh', value: BigInt(1000) }],
+      [{ scriptType: 'p2sh', value: BigInt(900) }],
+      basecoin.network,
+      rootWalletKey,
+      'unsigned'
+    );
+    const scope = nocks({ txHex: tx.buildIncomplete().toHex() });
+    const result = await wallet.sendMany({ recipients, customSigningFunction });
+
+    result.should.have.property('ok', true);
+    customSigningFunction.should.have.been.calledOnce();
+    scope.done();
+  });
+});

modules/bitgo/test/v2/unit/coins/utxo/descriptorAddress.ts renamed to modules/abstract-utxo/test/unit/descriptorAddress.ts

@@ -1,11 +1,11 @@
 import * as assert from 'node:assert';
 
-import { TestBitGo } from '@bitgo/sdk-test';
-import { AbstractUtxoCoin, descriptor as utxod } from '@bitgo/abstract-utxo';
 import * as utxolib from '@bitgo/utxo-lib';
 import { IWallet, WalletCoinSpecific } from '@bitgo/sdk-core';
 
-import { BitGo } from '../../../../../src';
+import { descriptor as utxod } from '../../src';
+
+import { getUtxoCoin } from './util';
 
 export function getDescriptorAddress(d: string, index: number, network: utxolib.Network): string {
   const derivedScript = Buffer.from(
@@ -15,8 +15,7 @@ export function getDescriptorAddress(d: string, index: number, network: utxolib.
 }
 
 describe('descriptor wallets', function () {
-  const bitgo: BitGo = TestBitGo.decorate(BitGo, { env: 'mock' });
-  const coin = bitgo.coin('tbtc') as AbstractUtxoCoin;
+  const coin = getUtxoCoin('tbtc');
   const xpubs = utxolib.testutil.getKeyTriple('setec astronomy').map((k) => k.neutered().toBase58());
 
   function withChecksum(descriptor: string): string {