feat(utxo-lib): add AcidTest.suite() for testing utilities

Adds a utility function to generate a comprehensive test suite for PSBT
functionality across networks, sign stages, and tx formats. Improves test
organization by using const arrays and type refinements, and adds a name
getter to AcidTest for better test reporting.

Issue: BTC-2732

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

Author: OttoAllmendinger

modules/utxo-lib/src/testutil/psbt.ts

@@ -29,7 +29,7 @@ import {
   addXpubsToPsbt,
   clonePsbtWithoutNonWitnessUtxo,
 } from '../bitgo';
-import { Network } from '../networks';
+import { getNetworkList, getNetworkName, isMainnet, Network, networks } from '../networks';
 import { mockReplayProtectionUnspent, mockWalletUnspent } from './mock';
 import { toOutputScript } from '../address';
 import { getDefaultWalletKeys, getWalletKeysForSeed } from './keys';
@@ -51,7 +51,8 @@ export type Input = {
   value: bigint;
 };
 
-export type SignStage = 'unsigned' | 'halfsigned' | 'fullsigned';
+export const signStages = ['unsigned', 'halfsigned', 'fullsigned'] as const;
+export type SignStage = (typeof signStages)[number];
 
 /**
  * Set isInternalAddress=true for internal output address
@@ -254,7 +255,8 @@ export function constructPsbt(
   return psbt;
 }
 
-export type TxFormat = 'psbt' | 'psbt-lite';
+export const txFormats = ['psbt', 'psbt-lite'] as const;
+export type TxFormat = (typeof txFormats)[number];
 
 /**
  * Creates a valid PSBT with as many features as possible.
@@ -321,6 +323,11 @@ export class AcidTest {
     return new AcidTest(network, signStage, txFormat, rootWalletKeys, otherWalletKeys, inputs, outputs);
   }
 
+  get name(): string {
+    const networkName = getNetworkName(this.network);
+    return `${networkName} ${this.signStage} ${this.txFormat}`;
+  }
+
   createPsbt(): UtxoPsbt {
     const psbt = constructPsbt(this.inputs, this.outputs, this.network, this.rootWalletKeys, this.signStage, {
       deterministic: true,
@@ -331,6 +338,16 @@ export class AcidTest {
     }
     return psbt;
   }
+
+  static suite(): AcidTest[] {
+    return getNetworkList()
+      .filter((network) => isMainnet(network) && network !== networks.bitcoinsv)
+      .flatMap((network) =>
+        signStages.flatMap((signStage) =>
+          txFormats.flatMap((txFormat) => AcidTest.withDefaults(network, signStage, txFormat))
+        )
+      );
+  }
 }
 
 /**

modules/utxo-lib/test/bitgo/psbt/SignVerifyLegacy.ts

@@ -3,9 +3,7 @@ import * as assert from 'assert';
 import { getStrictSignatureCount, getStrictSignatureCounts } from '../../../src/bitgo';
 import { constructTxnBuilder, TxnInput } from '../../../src/testutil';
 import { AcidTest, SignStage } from '../../../src/testutil/psbt';
-import { getNetworkList, getNetworkName, isMainnet, networks } from '../../../src';
-
-const signs = ['unsigned', 'halfsigned', 'fullsigned'] as const;
+import { getNetworkName } from '../../../src';
 
 function signCount(signStage: SignStage) {
   return signStage === 'unsigned' ? 0 : signStage === 'halfsigned' ? 1 : 2;
@@ -47,10 +45,8 @@ function runTx(acidTest: AcidTest) {
   });
 }
 
-signs.forEach((sign) => {
-  getNetworkList()
-    .filter((v) => isMainnet(v) && v !== networks.bitcoinsv)
-    .forEach((network) => {
-      runTx(AcidTest.withDefaults(network, sign, 'psbt'));
-    });
-});
+AcidTest.suite()
+  .filter((acidTest) => acidTest.txFormat === 'psbt')
+  .forEach((acidTest) => {
+    runTx(acidTest);
+  });

modules/utxo-lib/test/bitgo/psbt/SignVerifyPsbt.ts

@@ -14,16 +14,14 @@ import {
 } from '../../../src/bitgo';
 import { Input as TestUtilInput } from '../../../src/testutil';
 import { AcidTest, InputScriptType, SignStage } from '../../../src/testutil/psbt';
-import { getNetworkList, getNetworkName, isMainnet, networks } from '../../../src';
+import { getNetworkName } from '../../../src';
 import {
   parsePsbtMusig2Nonces,
   parsePsbtMusig2PartialSigs,
   parsePsbtMusig2Participants,
 } from '../../../src/bitgo/Musig2';
 import { getFixture } from '../../fixture.util';
 
-const signs = ['unsigned', 'halfsigned', 'fullsigned'] as const;
-
 function getSigValidArray(scriptType: InputScriptType, signStage: SignStage): Triple<boolean> {
   if (scriptType === 'p2shP2pk' || signStage === 'unsigned') {
     return [false, false, false];
@@ -83,7 +81,7 @@ function runPsbt(acidTest: AcidTest) {
   const coin = getNetworkName(acidTest.network);
   const signatureCount = signCount(acidTest.signStage);
 
-  describe(`psbt build, sign and verify for ${coin} ${acidTest.signStage}`, function () {
+  describe(`psbt suite for ${acidTest.name}`, function () {
     let psbt: UtxoPsbt;
 
     before(function () {
@@ -94,20 +92,6 @@ function runPsbt(acidTest: AcidTest) {
       assert.deepStrictEqual(psbt.toBuffer(), createPsbtFromBuffer(psbt.toBuffer(), acidTest.network).toBuffer());
     });
 
-    it(`getSignatureValidationArray with globalXpub ${coin} ${acidTest.signStage}`, function () {
-      psbt.data.inputs.forEach((input, inputIndex) => {
-        const isP2shP2pk = acidTest.inputs[inputIndex].scriptType === 'p2shP2pk';
-        const expectedSigValid = getSigValidArray(acidTest.inputs[inputIndex].scriptType, acidTest.signStage);
-        psbt.getSignatureValidationArray(inputIndex, { rootNodes: acidTest.rootWalletKeys.triple }).forEach((sv, i) => {
-          if (isP2shP2pk && acidTest.signStage !== 'unsigned' && i === 0) {
-            assert.strictEqual(sv, true);
-          } else {
-            assert.strictEqual(sv, expectedSigValid[i]);
-          }
-        });
-      });
-    });
-
     it('matches fixture', async function () {
       let finalizedPsbt: UtxoPsbt | undefined;
       let extractedTransaction: Buffer | undefined;
@@ -130,7 +114,7 @@ function runPsbt(acidTest: AcidTest) {
       assert.deepStrictEqual(fixture, await getFixture(`${__dirname}/../fixtures/psbt/${filename}`, fixture));
     });
 
-    it(`getSignatureValidationArray with rootNodes ${coin} ${acidTest.signStage}`, function () {
+    it(`getSignatureValidationArray`, function () {
       psbt.data.inputs.forEach((input, inputIndex) => {
         const isP2shP2pk = acidTest.inputs[inputIndex].scriptType === 'p2shP2pk';
         const expectedSigValid = getSigValidArray(acidTest.inputs[inputIndex].scriptType, acidTest.signStage);
@@ -144,7 +128,7 @@ function runPsbt(acidTest: AcidTest) {
       });
     });
 
-    it(`getSignatureValidationArrayPsbt  ${coin} ${acidTest.signStage}`, function () {
+    it(`getSignatureValidationArrayPsbt`, function () {
       const sigValidations = getSignatureValidationArrayPsbt(psbt, acidTest.rootWalletKeys);
       psbt.data.inputs.forEach((input, inputIndex) => {
         const expectedSigValid = getSigValidArray(acidTest.inputs[inputIndex].scriptType, acidTest.signStage);
@@ -154,7 +138,7 @@ function runPsbt(acidTest: AcidTest) {
       });
     });
 
-    it(`psbt signature counts ${coin} ${acidTest.signStage}`, function () {
+    it(`psbt signature counts`, function () {
       const counts = getStrictSignatureCounts(psbt);
       const countsFromInputs = getStrictSignatureCounts(psbt.data.inputs);
 
@@ -186,11 +170,6 @@ function runPsbt(acidTest: AcidTest) {
   });
 }
 
-signs.forEach((sign) => {
-  getNetworkList()
-    .filter((v) => isMainnet(v) && v !== networks.bitcoinsv)
-    .forEach((network) => {
-      runPsbt(AcidTest.withDefaults(network, sign, 'psbt'));
-      runPsbt(AcidTest.withDefaults(network, sign, 'psbt-lite'));
-    });
+AcidTest.suite().forEach((acidTest) => {
+  runPsbt(acidTest);
 });