feat(abstract-utxo): move generateAddress to a separate file

Move the generateAddress function to its own module and update imports
across the codebase to maintain functionality.

Issue: BTC-2652

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

Author: OttoAllmendinger

modules/abstract-utxo/src/index.ts

@@ -1,4 +1,5 @@
 export * from './abstractUtxoCoin';
+export * from './address';
 export * from './config';
 export * from './recovery';
 export * from './replayProtection';

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

@@ -3,7 +3,7 @@ import should = require('should');
 import * as sinon from 'sinon';
 import { Wallet, UnexpectedAddressError, VerificationOptions, Triple } from '@bitgo/sdk-core';
 
-import { UtxoWallet, Output, TransactionExplanation, TransactionParams } from '../../src';
+import { UtxoWallet, Output, TransactionExplanation, TransactionParams, generateAddress } from '../../src';
 
 import { bip322Fixtures } from './fixtures/bip322/fixtures';
 import { psbtTxHex } from './fixtures/psbtHexProof';
@@ -151,7 +151,7 @@ describe('Abstract UTXO Coin:', () => {
       threshold: 2,
     };
 
-    const { address: changeAddress, coinSpecific } = coin.generateAddress(addressData);
+    const { address: changeAddress, coinSpecific } = generateAddress(coin.network, coin.getChain(), addressData);
 
     const changeWalletId = 'changeWalletId';
     const stubData = {

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

@@ -4,7 +4,7 @@ import * as assert from 'assert';
 import * as utxolib from '@bitgo/utxo-lib';
 const { chainCodes } = utxolib.bitgo;
 
-import { AbstractUtxoCoin, GenerateFixedScriptAddressOptions } from '../../src';
+import { AbstractUtxoCoin, GenerateFixedScriptAddressOptions, generateAddress } from '../../src';
 
 import { utxoCoins, keychains as keychainsBip32, getFixture, shouldEqualJSON } from './util';
 
@@ -82,7 +82,7 @@ function run(coin: AbstractUtxoCoin) {
       const addresses = getParameters().map((p) => {
         const label = { chain: p.chain === undefined ? 'default' : p.chain };
         try {
-          return [label, coin.generateAddress(p)];
+          return [label, generateAddress(coin.network, coin.getChain(), p)];
         } catch (e) {
           return [label, { error: e.message }];
         }
@@ -94,11 +94,11 @@ function run(coin: AbstractUtxoCoin) {
     it('validates and verifies generated addresses', function () {
       getParameters().forEach((p) => {
         if (p.chain && !coin.supportsAddressChain(p.chain)) {
-          assert.throws(() => coin.generateAddress(p));
+          assert.throws(() => generateAddress(coin.network, coin.getChain(), p));
           return;
         }
 
-        const a = coin.generateAddress(p);
+        const a = generateAddress(coin.network, coin.getChain(), p);
         coin.isValidAddress(a.address).should.eql(true);
         if (a.address !== a.address.toUpperCase()) {
           coin.isValidAddress(a.address.toUpperCase()).should.eql(false);
@@ -110,7 +110,7 @@ function run(coin: AbstractUtxoCoin) {
     it('defaults to canonical address', function () {
       getParameters().forEach((p) => {
         if (!p.chain || coin.supportsAddressChain(p.chain)) {
-          const address = coin.generateAddress(p).address;
+          const address = generateAddress(coin.network, coin.getChain(), p).address;
           coin.canonicalAddress(address).should.eql(address);
         }
       });
@@ -122,8 +122,8 @@ function run(coin: AbstractUtxoCoin) {
           if (p.chain && (!coin.supportsAddressChain(p.chain) || !otherCoin.supportsAddressChain(p.chain))) {
             return;
           }
-          const address = coin.generateAddress(p);
-          const otherAddress = otherCoin.generateAddress(p);
+          const address = generateAddress(coin.network, coin.getChain(), p);
+          const otherAddress = generateAddress(otherCoin.network, otherCoin.getChain(), p);
           (address.address === otherAddress.address).should.eql(isCompatibleAddress(coin, otherCoin));
           coin.isValidAddress(otherAddress.address).should.eql(isCompatibleAddress(coin, otherCoin));
         });

modules/abstract-utxo/test/unit/recovery/crossChainRecovery.ts

@@ -13,6 +13,7 @@ import {
   CrossChainRecoveryUnsigned,
   getWallet,
   supportedCrossChainRecoveries,
+  generateAddress,
 } from '../../../src';
 import {
   getFixture,
@@ -100,10 +101,13 @@ function run<TNumber extends number | bigint = number>(sourceCoin: AbstractUtxoC
     const recoveryWalletId = '5abacebe28d72fbd07e0b8cbba0ff39e';
     // the address the accidental deposit went to, in both sourceCoin and addressCoin formats
     const [depositAddressSourceCoin, depositAddressRecoveryCoin] = [sourceCoin, recoveryCoin].map((coin) =>
-      coin.generateAddress({ keychains: keychainsBase58, index: 0 })
+      generateAddress(coin.network, coin.getChain(), { keychains: keychainsBase58, index: 0 })
     );
     // the address where we want to recover our funds to
-    const recoveryAddress = sourceCoin.generateAddress({ keychains: keychainsBase58, index: 1 }).address;
+    const recoveryAddress = generateAddress(sourceCoin.network, sourceCoin.getChain(), {
+      keychains: keychainsBase58,
+      index: 1,
+    }).address;
     const nocks: nock.Scope[] = [];
 
     let depositTx: utxolib.bitgo.UtxoTransaction<TNumber>;

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

@@ -13,7 +13,7 @@ import {
   WalletSignTransactionOptions,
 } from '@bitgo/sdk-core';
 
-import { AbstractUtxoCoin, getReplayProtectionAddresses } from '../../src';
+import { AbstractUtxoCoin, getReplayProtectionAddresses, generateAddress } from '../../src';
 
 import {
   utxoCoins,
@@ -311,7 +311,7 @@ function run<TNumber extends number | bigint = number>(
     }
 
     function getOutputAddress(rootWalletKeys: utxolib.bitgo.RootWalletKeys): string {
-      return coin.generateAddress({
+      return generateAddress(coin.network, coin.getChain(), {
         keychains: rootWalletKeys.triple.map((k) => ({ pub: k.neutered().toBase58() })),
       }).address;
     }