feat(utxo-bin): add network support to fromFixedScript command

Add ability to specify different networks when converting wallet keys to
descriptors. Maps keys to the specified network when necessary.

Issue: BTC-2170

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

Author: OttoAllmendinger

modules/utxo-bin/src/commands/cmdDescriptor/fromFixedScript.ts

@@ -1,21 +1,51 @@
 import { CommandModule } from 'yargs';
+import * as utxolib from '@bitgo/utxo-lib';
 import { getNamedDescriptorsForRootWalletKeys } from '@bitgo/utxo-core/descriptor';
 
-import { FormatTreeOrJson, formatTreeOrJson, getRootWalletKeys, keyOptions, KeyOptions } from '../../args';
+import {
+  FormatTreeOrJson,
+  formatTreeOrJson,
+  getNetworkOptionsDemand,
+  getRootWalletKeys,
+  keyOptions,
+  KeyOptions,
+} from '../../args';
 import { formatObjAsTree } from '../../format';
 
+type Triple<T> = [T, T, T];
+
 type ArgsFixedScriptToDescriptor = KeyOptions & {
+  network: utxolib.Network;
   format: FormatTreeOrJson;
 };
 
+function mapKeyToNetwork(key: utxolib.BIP32Interface, network: utxolib.Network): utxolib.BIP32Interface {
+  key = utxolib.bip32.fromBase58(key.toBase58());
+  key.network = network;
+  return key;
+}
+
+function mapRootWalletKeysToNetwork(
+  rootWalletKeys: utxolib.bitgo.RootWalletKeys,
+  network: utxolib.Network
+): utxolib.bitgo.RootWalletKeys {
+  return new utxolib.bitgo.RootWalletKeys(
+    rootWalletKeys.triple.map((key) => mapKeyToNetwork(key, network)) as Triple<utxolib.BIP32Interface>,
+    rootWalletKeys.derivationPrefixes
+  );
+}
+
 export const cmdFromFixedScript: CommandModule<unknown, ArgsFixedScriptToDescriptor> = {
   command: 'fromFixedScript',
   describe: 'Convert BitGo FixedScript RootWalletKeys to output descriptors',
   builder(b) {
-    return b.options(keyOptions).options({ format: formatTreeOrJson });
+    return b.option(getNetworkOptionsDemand('bitcoin')).options(keyOptions).options({ format: formatTreeOrJson });
   },
   handler(argv): void {
-    const rootWalletKeys = getRootWalletKeys(argv);
+    let rootWalletKeys = getRootWalletKeys(argv);
+    if (argv.network !== utxolib.networks.bitcoin) {
+      rootWalletKeys = mapRootWalletKeysToNetwork(rootWalletKeys, argv.network);
+    }
     const descriptorMap = getNamedDescriptorsForRootWalletKeys(rootWalletKeys);
     const obj = Object.fromEntries(
       [...descriptorMap].map(([name, descriptor]) => [name, descriptor?.toString() ?? null])

modules/utxo-bin/test/cmdDescriptor/fromFixedScript.ts

@@ -6,44 +6,33 @@ import { getFixtureString } from '../fixtures';
 import { getKeyTriple } from '../bip32.util';
 import { captureConsole } from '../captureConsole';
 
-describe('cmdDescriptor fromFixedScript', function () {
-  it('should be a yargs command', function () {
-    assert.strictEqual(typeof cmdFromFixedScript.command, 'string');
-    assert.strictEqual(typeof cmdFromFixedScript.describe, 'string');
-    assert.strictEqual(typeof cmdFromFixedScript.builder, 'function');
-    assert.strictEqual(typeof cmdFromFixedScript.handler, 'function');
-  });
+function keyArgs(): string[] {
+  const [userKey, backupKey, bitgoKey] = getKeyTriple('generateAddress').map((k) => k.neutered().toBase58());
+  return ['--userKey', userKey, '--backupKey', backupKey, '--bitgoKey', bitgoKey, '--scriptType', 'p2sh'];
+}
 
-  it('should output expected descriptor for valid keys', async function () {
-    const [userKey, backupKey, bitgoKey] = getKeyTriple('generateAddress').map((k) => k.neutered().toBase58());
-    const argv = [
-      'fromFixedScript',
-      '--userKey',
-      userKey,
-      '--backupKey',
-      backupKey,
-      '--bitgoKey',
-      bitgoKey,
-      '--scriptType',
-      'p2sh',
-      '--network',
-      'testnet',
-    ];
+describe('cmdDescriptor fromFixedScript', function () {
+  function runTest(argv: string[], fixtureName: string) {
+    it(`should output expected descriptor (${fixtureName})`, async function () {
+      const y = yargs(argv)
+        .command(cmdFromFixedScript)
+        .exitProcess(false)
+        .fail((msg, err) => {
+          throw err || new Error(msg);
+        });
 
-    const y = yargs(argv)
-      .command(cmdFromFixedScript)
-      .exitProcess(false)
-      .fail((msg, err) => {
-        throw err || new Error(msg);
+      const { stdout, stderr } = await captureConsole(async () => {
+        await y.parse();
       });
 
-    const { stdout, stderr } = await captureConsole(async () => {
-      await y.parse();
+      // Compare output to fixture, or check for expected descriptor substring
+      const expected = await getFixtureString(`test/fixtures/fromFixedScript/${fixtureName}.txt`, stdout);
+      assert.strictEqual(stdout.trim(), expected.trim());
+      assert.strictEqual(stderr, '');
     });
+  }
+
+  runTest(['fromFixedScript', ...keyArgs()], 'default');
 
-    // Compare output to fixture, or check for expected descriptor substring
-    const expected = await getFixtureString('test/fixtures/fromFixedScript/descriptors.txt', stdout);
-    assert.strictEqual(stdout.trim(), expected.trim());
-    assert.strictEqual(stderr, '');
-  });
+  runTest(['fromFixedScript', ...keyArgs(), '--network', 'testnet'], 'network-testnet');
 });

modules/utxo-bin/test/fixtures/fromFixedScript/descriptors.txt renamed to modules/utxo-bin/test/fixtures/fromFixedScript/default.txt

@@ -0,0 +1,12 @@
+descriptors
+├── p2sh/external: "sh(multi(2,tpubD6NzVbkrYhZ4X1jAiYEZqPSavoJ15M837vb71xr4kDnoympejW4518ioDZt8wpxSyNxuFRFehfTZqCLChmwRtvL1N58WvdtRF4Y4k7suApz/0/0/0/*,tpubD6NzVbkrYhZ4XP8gD3zSDFJUfnPnVYdGHhUvAeeQaP8CwYHuGEiCMQaNhmtwvz6tA22ymCQ565HJ5Mt37a2zweFAcEYEK52JNuVT1rWz9x8/0/0/0/*,tpubD6NzVbkrYhZ4X69NJMJcJ8NqwEVeoxxVqY7oLm1ot4b9KUH8Jtp7CNcwfvXuih78QMrigstU9Qqs6sDtB3MwvdJS15cH2TzfazoP2REqXVN/0/0/0/*))#k9dvpjv5"
+├── p2sh/internal: "sh(multi(2,tpubD6NzVbkrYhZ4X1jAiYEZqPSavoJ15M837vb71xr4kDnoympejW4518ioDZt8wpxSyNxuFRFehfTZqCLChmwRtvL1N58WvdtRF4Y4k7suApz/0/0/1/*,tpubD6NzVbkrYhZ4XP8gD3zSDFJUfnPnVYdGHhUvAeeQaP8CwYHuGEiCMQaNhmtwvz6tA22ymCQ565HJ5Mt37a2zweFAcEYEK52JNuVT1rWz9x8/0/0/1/*,tpubD6NzVbkrYhZ4X69NJMJcJ8NqwEVeoxxVqY7oLm1ot4b9KUH8Jtp7CNcwfvXuih78QMrigstU9Qqs6sDtB3MwvdJS15cH2TzfazoP2REqXVN/0/0/1/*))#79yt5eua"
+├── p2shP2wsh/external: "sh(wsh(multi(2,tpubD6NzVbkrYhZ4X1jAiYEZqPSavoJ15M837vb71xr4kDnoympejW4518ioDZt8wpxSyNxuFRFehfTZqCLChmwRtvL1N58WvdtRF4Y4k7suApz/0/0/10/*,tpubD6NzVbkrYhZ4XP8gD3zSDFJUfnPnVYdGHhUvAeeQaP8CwYHuGEiCMQaNhmtwvz6tA22ymCQ565HJ5Mt37a2zweFAcEYEK52JNuVT1rWz9x8/0/0/10/*,tpubD6NzVbkrYhZ4X69NJMJcJ8NqwEVeoxxVqY7oLm1ot4b9KUH8Jtp7CNcwfvXuih78QMrigstU9Qqs6sDtB3MwvdJS15cH2TzfazoP2REqXVN/0/0/10/*)))#5l20an83"
+├── p2shP2wsh/internal: "sh(wsh(multi(2,tpubD6NzVbkrYhZ4X1jAiYEZqPSavoJ15M837vb71xr4kDnoympejW4518ioDZt8wpxSyNxuFRFehfTZqCLChmwRtvL1N58WvdtRF4Y4k7suApz/0/0/11/*,tpubD6NzVbkrYhZ4XP8gD3zSDFJUfnPnVYdGHhUvAeeQaP8CwYHuGEiCMQaNhmtwvz6tA22ymCQ565HJ5Mt37a2zweFAcEYEK52JNuVT1rWz9x8/0/0/11/*,tpubD6NzVbkrYhZ4X69NJMJcJ8NqwEVeoxxVqY7oLm1ot4b9KUH8Jtp7CNcwfvXuih78QMrigstU9Qqs6sDtB3MwvdJS15cH2TzfazoP2REqXVN/0/0/11/*)))#kvxa9rda"
+├── p2wsh/external: "wsh(multi(2,tpubD6NzVbkrYhZ4X1jAiYEZqPSavoJ15M837vb71xr4kDnoympejW4518ioDZt8wpxSyNxuFRFehfTZqCLChmwRtvL1N58WvdtRF4Y4k7suApz/0/0/20/*,tpubD6NzVbkrYhZ4XP8gD3zSDFJUfnPnVYdGHhUvAeeQaP8CwYHuGEiCMQaNhmtwvz6tA22ymCQ565HJ5Mt37a2zweFAcEYEK52JNuVT1rWz9x8/0/0/20/*,tpubD6NzVbkrYhZ4X69NJMJcJ8NqwEVeoxxVqY7oLm1ot4b9KUH8Jtp7CNcwfvXuih78QMrigstU9Qqs6sDtB3MwvdJS15cH2TzfazoP2REqXVN/0/0/20/*))#7c7n6f3u"
+├── p2wsh/internal: "wsh(multi(2,tpubD6NzVbkrYhZ4X1jAiYEZqPSavoJ15M837vb71xr4kDnoympejW4518ioDZt8wpxSyNxuFRFehfTZqCLChmwRtvL1N58WvdtRF4Y4k7suApz/0/0/21/*,tpubD6NzVbkrYhZ4XP8gD3zSDFJUfnPnVYdGHhUvAeeQaP8CwYHuGEiCMQaNhmtwvz6tA22ymCQ565HJ5Mt37a2zweFAcEYEK52JNuVT1rWz9x8/0/0/21/*,tpubD6NzVbkrYhZ4X69NJMJcJ8NqwEVeoxxVqY7oLm1ot4b9KUH8Jtp7CNcwfvXuih78QMrigstU9Qqs6sDtB3MwvdJS15cH2TzfazoP2REqXVN/0/0/21/*))#350cqv2q"
+├── p2tr/external: null
+├── p2tr/internal: null
+├── p2trMusig2/external: null
+└── p2trMusig2/internal: null
+