refactor(abstract-utxo): remove deprecated network getter and getNetworkFromCoinName

Drop the deprecated coin.network getter from AbstractUtxoCoin and the
getNetworkFromCoinName helper from names.ts. Tests that previously called
coin.network now call the test-local getNetworkForCoinName(coin.name) from
util/utxoCoins. With this, names.ts no longer depends on utxolib.

Refs: T1-3279

Author: OttoAllmendinger

modules/abstract-utxo/src/abstractUtxoCoin.ts

@@ -75,14 +75,7 @@ import {
   ErrorImplicitExternalOutputs,
 } from './transaction/descriptor/verifyTransaction';
 import { assertDescriptorWalletAddress, getDescriptorMapFromWallet, isDescriptorWallet } from './descriptor';
-import {
-  getFullNameFromCoinName,
-  getMainnetCoinName,
-  getNetworkFromCoinName,
-  isMainnetCoin,
-  UtxoCoinName,
-  UtxoCoinNameMainnet,
-} from './names';
+import { getFullNameFromCoinName, getMainnetCoinName, isMainnetCoin, UtxoCoinName, UtxoCoinNameMainnet } from './names';
 import { assertFixedScriptWalletAddress } from './address/fixedScript';
 import { ParsedTransaction } from './transaction/types';
 import { decodeDescriptorPsbt, decodePsbt, encodeTransaction, stringToBufferTryFormats } from './transaction/decode';
@@ -413,14 +406,6 @@ export abstract class AbstractUtxoCoin extends BaseCoin implements Musig2Partici
     this.amountType = amountType;
   }
 
-  /**
-   * @deprecated - will be removed when we drop support for utxolib
-   * Use `name` property instead.
-   */
-  get network(): utxolib.Network {
-    return getNetworkFromCoinName(this.name);
-  }
-
   getChain(): UtxoCoinName {
     return this.name;
   }

modules/abstract-utxo/src/names.ts

@@ -1,5 +1,3 @@
-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',
@@ -46,107 +44,6 @@ export function getMainnetCoinName(coinName: UtxoCoinName): UtxoCoinNameMainnet
   }
 }
 
-function getNetworkName(n: utxolib.Network): utxolib.NetworkName {
-  const name = utxolib.getNetworkName(n);
-  if (!name) {
-    throw new Error('Unknown network');
-  }
-  return name;
-}
-
-/**
- * @deprecated - will be removed when we drop support for utxolib
- * @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): UtxoCoinNameMainnet {
-  switch (getNetworkName(n)) {
-    case 'bitcoin':
-    case 'testnet':
-    case 'bitcoinPublicSignet':
-    case 'bitcoinTestnet4':
-    case 'bitcoinBitGoSignet':
-      return 'btc';
-    case 'bitcoincash':
-    case 'bitcoincashTestnet':
-      return 'bch';
-    case 'ecash':
-    case 'ecashTest':
-      return 'bcha';
-    case 'bitcoingold':
-    case 'bitcoingoldTestnet':
-      return 'btg';
-    case 'bitcoinsv':
-    case 'bitcoinsvTestnet':
-      return 'bsv';
-    case 'dash':
-    case 'dashTest':
-      return 'dash';
-    case 'dogecoin':
-    case 'dogecoinTest':
-      return 'doge';
-    case 'litecoin':
-    case 'litecoinTest':
-      return 'ltc';
-    case 'zcash':
-    case 'zcashTest':
-      return 'zec';
-  }
-}
-
-/**
- * @deprecated - will be removed when we drop support for utxolib
- * Get the chain name for a network.
- * The chain is different for every network.
- */
-export function getCoinName(n: utxolib.Network): UtxoCoinName {
-  switch (getNetworkName(n)) {
-    case 'bitcoinPublicSignet':
-      return 'tbtcsig';
-    case 'bitcoinTestnet4':
-      return 'tbtc4';
-    case 'bitcoinBitGoSignet':
-      return 'tbtcbgsig';
-    case 'bitcoin':
-    case 'testnet':
-    case 'bitcoincash':
-    case 'bitcoincashTestnet':
-    case 'ecash':
-    case 'ecashTest':
-    case 'bitcoingold':
-    case 'bitcoingoldTestnet':
-    case 'bitcoinsv':
-    case 'bitcoinsvTestnet':
-    case 'dash':
-    case 'dashTest':
-    case 'dogecoin':
-    case 'dogecoinTest':
-    case 'litecoin':
-    case 'litecoinTest':
-    case 'zcash':
-    case 'zcashTest':
-      const mainnetName = getFamilyFromNetwork(n);
-      return utxolib.isTestnet(n) ? `t${mainnetName}` : mainnetName;
-  }
-}
-
-/**
- * @deprecated - will be removed when we drop support for utxolib
- * @param coinName - the name of the coin (e.g. 'btc', 'bch', 'ltc'). Also called 'chain' in some contexts.
- * @returns the network for a coin. This is the mainnet network for the coin.
- */
-export function getNetworkFromCoinName(coinName: string): utxolib.Network {
-  for (const network of utxolib.getNetworkList()) {
-    if (getCoinName(network) === coinName) {
-      return network;
-    }
-  }
-  throw new Error(`Unknown coin name ${coinName}`);
-}
-
-/** @deprecated - use getNetworkFromCoinName instead */
-export const getNetworkFromChain = getNetworkFromCoinName;
-
 function getBaseNameFromMainnet(coinName: UtxoCoinNameMainnet): string {
   switch (coinName) {
     case 'btc':
@@ -189,11 +86,6 @@ export function getFullNameFromCoinName(coinName: UtxoCoinName): string {
   return prefix + getBaseNameFromMainnet(getMainnetCoinName(coinName));
 }
 
-/** @deprecated - use getFullNameFromCoinName instead */
-export function getFullNameFromNetwork(n: utxolib.Network): string {
-  return getFullNameFromCoinName(getCoinName(n));
-}
-
 export function isTestnetCoin(coinName: UtxoCoinName): boolean {
   return isUtxoCoinNameTestnet(coinName);
 }

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

@@ -11,6 +11,7 @@ import {
   encryptKeychain,
   getDefaultWalletKeys,
   getMinUtxoCoins,
+  getNetworkForCoinName,
   getUtxoWallet,
   keychainsBase58,
   getScriptTypes,
@@ -46,12 +47,17 @@ describe('prebuildAndSign-returnLegacyFormat', function () {
     const outputAmount = BigInt(inputScripts.length) * BigInt(1e8) - fee;
     const outputScriptType: utxolib.bitgo.outputScripts.ScriptType = 'p2sh';
     const outputChain = utxolib.bitgo.getExternalChainCode(outputScriptType);
-    const outputAddress = utxolib.bitgo.getWalletAddress(rootWalletKeys, outputChain, 0, coin.network);
+    const outputAddress = utxolib.bitgo.getWalletAddress(
+      rootWalletKeys,
+      outputChain,
+      0,
+      getNetworkForCoinName(coin.name)
+    );
     recipient = { address: outputAddress, amount: outputAmount.toString() };
     prebuild = utxolib.testutil.constructPsbt(
       inputScripts.map((s) => ({ scriptType: s, value: BigInt(1e8) })),
       [{ scriptType: outputScriptType, value: outputAmount }],
-      coin.network,
+      getNetworkForCoinName(coin.name),
       rootWalletKeys,
       'unsigned'
     );

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

@@ -3,7 +3,14 @@ import nock = require('nock');
 import * as sinon from 'sinon';
 import { CustomSigningFunction, common } from '@bitgo/sdk-core';
 
-import { defaultBitGo, getDefaultWalletKeys, getUtxoCoin, getUtxoWallet, assertHasProperty } from './util';
+import {
+  defaultBitGo,
+  getDefaultWalletKeys,
+  getNetworkForCoinName,
+  getUtxoCoin,
+  getUtxoWallet,
+  assertHasProperty,
+} from './util';
 
 nock.disableNetConnect();
 
@@ -56,7 +63,7 @@ describe('UTXO Custom Signer Function', function () {
     const psbt = utxoLib.testutil.constructPsbt(
       [{ scriptType: 'taprootKeyPathSpend', value: BigInt(1000) }],
       [{ scriptType: 'p2sh', value: BigInt(900) }],
-      basecoin.network,
+      getNetworkForCoinName(basecoin.name),
       rootWalletKey,
       'unsigned'
     );
@@ -72,7 +79,7 @@ describe('UTXO Custom Signer Function', function () {
     const psbt = utxoLib.testutil.constructPsbt(
       [{ scriptType: 'p2wsh', value: BigInt(1000) }],
       [{ scriptType: 'p2sh', value: BigInt(900) }],
-      basecoin.network,
+      getNetworkForCoinName(basecoin.name),
       rootWalletKey,
       'unsigned'
     );

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

@@ -12,6 +12,7 @@ import {
   defaultBitGo,
   getDefaultWalletKeys,
   getMinUtxoCoins,
+  getNetworkForCoinName,
   getUtxoWallet,
   keychainsBase58,
   getScriptTypes,
@@ -62,7 +63,7 @@ function run(coin: AbstractUtxoCoin, inputScripts: ScriptType[]): void {
     const psbt = utxolib.testutil.constructPsbt(
       inputs as utxolib.testutil.Input[],
       outputs,
-      coin.network,
+      getNetworkForCoinName(coin.name),
       rootWalletKeys,
       'unsigned',
       {
@@ -178,7 +179,12 @@ function run(coin: AbstractUtxoCoin, inputScripts: ScriptType[]): void {
       const outputAmount = BigInt(inputScripts.length) * BigInt(1e8) - fee;
       const outputScriptType: utxolib.bitgo.outputScripts.ScriptType = 'p2sh';
       const outputChain = utxolib.bitgo.getExternalChainCode(outputScriptType);
-      const outputAddress = utxolib.bitgo.getWalletAddress(rootWalletKeys, outputChain, 0, coin.network);
+      const outputAddress = utxolib.bitgo.getWalletAddress(
+        rootWalletKeys,
+        outputChain,
+        0,
+        getNetworkForCoinName(coin.name)
+      );
 
       recipient = {
         address: outputAddress,
@@ -222,7 +228,7 @@ function run(coin: AbstractUtxoCoin, inputScripts: ScriptType[]): void {
 
       nocks.forEach((nock) => assert.ok(nock.isDone()));
 
-      assertSignable(res.txHex, inputScripts, coin.network);
+      assertSignable(res.txHex, inputScripts, getNetworkForCoinName(coin.name));
     });
 
     [true, false].forEach((selfSend) => {
@@ -254,7 +260,7 @@ function run(coin: AbstractUtxoCoin, inputScripts: ScriptType[]): void {
 
         nocks.forEach((nock) => assert.ok(nock.isDone()));
 
-        assertSignable(res.txHex, inputScripts, coin.network);
+        assertSignable(res.txHex, inputScripts, getNetworkForCoinName(coin.name));
       });
     });
   });

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

@@ -9,7 +9,14 @@ import { common, Triple } from '@bitgo/sdk-core';
 import { getReplayProtectionPubkeys, ErrorDeprecatedTxFormat } from '../../src';
 import type { Unspent } from '../../src/unspent';
 
-import { getUtxoWallet, getDefaultWalletKeys, getUtxoCoin, keychainsBase58, defaultBitGo } from './util';
+import {
+  getUtxoWallet,
+  getDefaultWalletKeys,
+  getNetworkForCoinName,
+  getUtxoCoin,
+  keychainsBase58,
+  defaultBitGo,
+} from './util';
 
 describe('signTransaction', function () {
   const bgUrl = common.Environments[defaultBitGo.getEnv()].uri;
@@ -21,7 +28,7 @@ describe('signTransaction', function () {
   const pubs = keychainsBase58.map((v) => v.pub) as Triple<string>;
 
   function validatePsbt(txHex: string, targetSigCount: 0 | 1, targetNonceCount?: 1 | 2) {
-    const psbt = utxolib.bitgo.createPsbtFromHex(txHex, coin.network);
+    const psbt = utxolib.bitgo.createPsbtFromHex(txHex, getNetworkForCoinName(coin.name));
     psbt.data.inputs.forEach((input, index) => {
       const parsed = utxolib.bitgo.parsePsbtInput(input);
       if (parsed.scriptType === 'taprootKeyPathSpend') {
@@ -38,7 +45,7 @@ describe('signTransaction', function () {
   }
 
   function validateTx(txHex: string, unspents: Unspent<bigint>[], targetSigCount: 0 | 1) {
-    const tx = utxolib.bitgo.createTransactionFromHex(txHex, coin.network);
+    const tx = utxolib.bitgo.createTransactionFromHex(txHex, getNetworkForCoinName(coin.name));
     unspents.forEach((u, i) => {
       const sigCount = utxolib.bitgo.getStrictSignatureCount(tx.ins[i]);
       const expectedSigCount = utxolib.bitgo.isWalletUnspent(u) && !!targetSigCount ? 1 : 0;
@@ -56,7 +63,7 @@ describe('signTransaction', function () {
     const txHex = tx.toHex();
 
     function nockSignPsbt(psbtHex: string): nock.Scope {
-      const psbt = utxolib.bitgo.createPsbtFromHex(psbtHex, coin.network);
+      const psbt = utxolib.bitgo.createPsbtFromHex(psbtHex, getNetworkForCoinName(coin.name));
       return nock(bgUrl)
         .post(`/api/v2/${wallet.coin()}/wallet/${wallet.id()}/tx/signpsbt`, (body) => body.psbt)
         .reply(200, { psbt: psbt.setAllInputsMusig2NonceHD(rootWalletKeys.bitgo).toHex() });
@@ -147,7 +154,7 @@ describe('signTransaction', function () {
       .map((scriptType) => ({ scriptType, value: BigInt(1000) }));
     const unspentSum = inputs.reduce((prev: bigint, curr) => prev + curr.value, BigInt(0));
     const outputs: testutil.Output[] = [{ scriptType: 'p2sh', value: unspentSum - BigInt(1000) }];
-    const psbt = testutil.constructPsbt(inputs, outputs, coin.network, rootWalletKeys, 'unsigned', {
+    const psbt = testutil.constructPsbt(inputs, outputs, getNetworkForCoinName(coin.name), rootWalletKeys, 'unsigned', {
       p2shP2pkKey: replayProtectionKey,
     });
 
@@ -163,7 +170,7 @@ describe('signTransaction', function () {
       .map((scriptType) => ({ scriptType, value: BigInt(1000) }));
     const unspentSum = inputs.reduce((prev: bigint, cur) => prev + cur.value, BigInt(0));
     const outputs: testutil.Output[] = [{ scriptType: 'p2sh', value: unspentSum - BigInt(1000) }];
-    const psbt = testutil.constructPsbt(inputs, outputs, coin.network, rootWalletKeys, 'unsigned', {
+    const psbt = testutil.constructPsbt(inputs, outputs, getNetworkForCoinName(coin.name), rootWalletKeys, 'unsigned', {
       p2shP2pkKey: replayProtectionKey,
     });
 
@@ -181,8 +188,16 @@ describe('signTransaction', function () {
       }));
     const unspentSum = inputs.reduce((prev: bigint, curr) => prev + curr.value, BigInt(0));
     const outputs: testutil.TxnOutput<bigint>[] = [{ scriptType: 'p2sh', value: unspentSum - BigInt(1000) }];
-    const txBuilder = testutil.constructTxnBuilder(inputs, outputs, coin.network, rootWalletKeys, 'unsigned');
-    const unspents = inputs.map((v, i) => testutil.toTxnUnspent(v, i, coin.network, rootWalletKeys));
+    const txBuilder = testutil.constructTxnBuilder(
+      inputs,
+      outputs,
+      getNetworkForCoinName(coin.name),
+      rootWalletKeys,
+      'unsigned'
+    );
+    const unspents = inputs.map((v, i) =>
+      testutil.toTxnUnspent(v, i, getNetworkForCoinName(coin.name), rootWalletKeys)
+    );
 
     // Legacy format transactions are now deprecated and should throw ErrorDeprecatedTxFormat
     await assert.rejects(async () => {
@@ -194,7 +209,7 @@ describe('signTransaction', function () {
     const inputs: testutil.Input[] = [{ scriptType: 'taprootKeyPathSpend', value: BigInt(1000) }];
     const unspentSum = inputs.reduce((prev: bigint, curr) => prev + curr.value, BigInt(0));
     const outputs: testutil.Output[] = [{ scriptType: 'p2sh', value: unspentSum - BigInt(1000) }];
-    const psbt = testutil.constructPsbt(inputs, outputs, coin.network, rootWalletKeys, 'unsigned');
+    const psbt = testutil.constructPsbt(inputs, outputs, getNetworkForCoinName(coin.name), rootWalletKeys, 'unsigned');
 
     await assert.rejects(
       async () => {