Merge pull request #7544 from BitGo/BTC-2732.testnet-prohibit-legacy-txformat

feat(abstract-utxo): prohibit legacy tx format on testnet

Author: OttoAllmendinger

modules/abstract-utxo/src/abstractUtxoCoin.ts

@@ -97,6 +97,12 @@ export type TxFormat =
   // While this prevents us to fully verify the transaction fee, we have other checks in place to ensure the fee is within bounds.
   | 'psbt-lite';
 
+export class ErrorDeprecatedTxFormat extends Error {
+  constructor(txFormat: TxFormat) {
+    super(`SDK support for txFormat=${txFormat} is deprecated on this environment. Please use psbt instead.`);
+  }
+}
+
 type UtxoCustomSigningFunction<TNumber extends number | bigint> = {
   (params: {
     coin: IBaseCoin;
@@ -921,6 +927,10 @@ export abstract class AbstractUtxoCoin extends BaseCoin {
   getDefaultTxFormat(wallet: Wallet, requestedFormat?: TxFormat): TxFormat | undefined {
     // If format is explicitly requested, use it
     if (requestedFormat !== undefined) {
+      if (isTestnet(this.network) && requestedFormat === 'legacy') {
+        throw new ErrorDeprecatedTxFormat(requestedFormat);
+      }
+
       return requestedFormat;
     }
 

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

@@ -3,7 +3,7 @@ import * as assert from 'assert';
 import * as utxolib from '@bitgo/utxo-lib';
 import { Wallet } from '@bitgo/sdk-core';
 
-import { AbstractUtxoCoin, TxFormat } from '../../src';
+import { AbstractUtxoCoin, ErrorDeprecatedTxFormat, TxFormat } from '../../src';
 
 import { utxoCoins, defaultBitGo } from './util';
 
@@ -151,7 +151,8 @@ describe('txFormat', function () {
 
     // Test explicitly requested formats
     runTest({
-      description: 'should respect explicitly requested legacy format',
+      description: 'should respect explicitly requested legacy format on mainnet',
+      coinFilter: (coin) => utxolib.isMainnet(coin.network),
       expectedTxFormat: 'legacy',
       requestedTxFormat: 'legacy',
     });
@@ -167,5 +168,21 @@ describe('txFormat', function () {
       expectedTxFormat: 'psbt-lite',
       requestedTxFormat: 'psbt-lite',
     });
+
+    // Test that legacy format is prohibited on testnet
+    it('should throw ErrorDeprecatedTxFormat when legacy format is requested on testnet', function () {
+      for (const coin of utxoCoins) {
+        if (!utxolib.isTestnet(coin.network)) {
+          continue;
+        }
+
+        const wallet = createMockWallet(coin, { type: 'hot' });
+        assert.throws(
+          () => getTxFormat(coin, wallet, 'legacy'),
+          ErrorDeprecatedTxFormat,
+          `Expected ErrorDeprecatedTxFormat for ${coin.getChain()}`
+        );
+      }
+    });
   });
 });