feat(utxo-bin): add descriptor fromFixedScript command

Add capability to convert BitGo FixedScript RootWalletKeys to output
descriptors. The new command allows users to generate descriptors from
wallet keys with proper formatting options.

Issue: BTC-2170

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

Author: OttoAllmendinger

modules/utxo-bin/bin/index.ts

@@ -1,11 +1,12 @@
 #!/usr/bin/env node
 import * as yargs from 'yargs';
 
-import { cmdParseTx, cmdParseScript, cmdBip32, cmdPsbt, cmdAddress } from '../src/commands';
+import { cmdParseTx, cmdParseScript, cmdBip32, cmdPsbt, cmdAddress, cmdDescriptor } from '../src/commands';
 
 yargs
   .command(cmdParseTx)
   .command(cmdAddress)
+  .command(cmdDescriptor)
   .command(cmdParseScript)
   .command(cmdPsbt)
   .command(cmdBip32)

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

@@ -0,0 +1,31 @@
+import { CommandModule } from 'yargs';
+import { getNamedDescriptorsForRootWalletKeys } from '@bitgo/utxo-core/descriptor';
+
+import { FormatTreeOrJson, formatTreeOrJson, getRootWalletKeys, keyOptions, KeyOptions } from '../../args';
+import { formatObjAsTree } from '../../format';
+
+type ArgsFixedScriptToDescriptor = KeyOptions & {
+  format: FormatTreeOrJson;
+};
+
+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 });
+  },
+  handler(argv): void {
+    const rootWalletKeys = getRootWalletKeys(argv);
+    const descriptorMap = getNamedDescriptorsForRootWalletKeys(rootWalletKeys);
+    const obj = Object.fromEntries(
+      [...descriptorMap].map(([name, descriptor]) => [name, descriptor?.toString() ?? null])
+    );
+    if (argv.format === 'tree') {
+      console.log(formatObjAsTree('descriptors', obj));
+    } else if (argv.format === 'json') {
+      console.log(JSON.stringify(obj, null, 2));
+    } else {
+      throw new Error(`Invalid format: ${argv.format}. Expected 'tree' or 'json'.`);
+    }
+  },
+};

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

@@ -0,0 +1,15 @@
+import { CommandModule } from 'yargs';
+import { cmdFromFixedScript } from './fromFixedScript';
+
+export * from './fromFixedScript';
+
+export const cmdDescriptor: CommandModule<unknown, unknown> = {
+  command: 'descriptor <command>',
+  describe: 'descriptor commands',
+  builder(b) {
+    return b.strict().command(cmdFromFixedScript).demandCommand();
+  },
+  handler() {
+    // do nothing
+  },
+};

modules/utxo-bin/src/commands/index.ts

@@ -1,5 +1,6 @@
 export * from './cmdParseTx';
 export * from './cmdAddress';
+export * from './cmdDescriptor';
 export * from './cmdParseScript';
 export * from './cmdBip32';
 export * from './cmdPsbt';

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

@@ -0,0 +1,49 @@
+import * as assert from 'assert';
+import yargs from 'yargs';
+
+import { cmdFromFixedScript } from '../../src/commands/cmdDescriptor';
+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');
+  });
+
+  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',
+    ];
+
+    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();
+    });
+
+    // 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, '');
+  });
+});

modules/utxo-bin/test/fixtures/fromFixedScript/descriptors.txt

@@ -0,0 +1,12 @@
+descriptors
+├── p2sh/external: "sh(multi(2,xpub661MyMwAqRbcFDYKGMFUdU7DbgCM5xcyaHzofQnvQK2vEV9wfHCyrh3xyXoMRL1DBURzdqjnAZdX91qbJv6C1UsiJUPDF7EBf6wez7VrEJR/0/0/0/*,xpub661MyMwAqRbcFawpks1M1Ky7LfJ8WA8Ck4tcp6bGEUNKCFdCC1s7CxuYTjpAQV9eN7W59ctCYyTFPBPRiiBm4CnsYdnvdYN4nwu3FsCKnDw/0/0/0/*,xpub661MyMwAqRbcFHxWrAKX6D3Uc7PzpaTSHuXVzCxfY9qFaBcREfy23vx7RtT8CC9tcTKp5JNbcK1pQgjGnBWi3Br8wUryLwLS13CyGREyFs3/0/0/0/*))#5npd8z8f"
+├── p2sh/internal: "sh(multi(2,xpub661MyMwAqRbcFDYKGMFUdU7DbgCM5xcyaHzofQnvQK2vEV9wfHCyrh3xyXoMRL1DBURzdqjnAZdX91qbJv6C1UsiJUPDF7EBf6wez7VrEJR/0/0/1/*,xpub661MyMwAqRbcFawpks1M1Ky7LfJ8WA8Ck4tcp6bGEUNKCFdCC1s7CxuYTjpAQV9eN7W59ctCYyTFPBPRiiBm4CnsYdnvdYN4nwu3FsCKnDw/0/0/1/*,xpub661MyMwAqRbcFHxWrAKX6D3Uc7PzpaTSHuXVzCxfY9qFaBcREfy23vx7RtT8CC9tcTKp5JNbcK1pQgjGnBWi3Br8wUryLwLS13CyGREyFs3/0/0/1/*))#ung2jfhq"
+├── p2shP2wsh/external: "sh(wsh(multi(2,xpub661MyMwAqRbcFDYKGMFUdU7DbgCM5xcyaHzofQnvQK2vEV9wfHCyrh3xyXoMRL1DBURzdqjnAZdX91qbJv6C1UsiJUPDF7EBf6wez7VrEJR/0/0/10/*,xpub661MyMwAqRbcFawpks1M1Ky7LfJ8WA8Ck4tcp6bGEUNKCFdCC1s7CxuYTjpAQV9eN7W59ctCYyTFPBPRiiBm4CnsYdnvdYN4nwu3FsCKnDw/0/0/10/*,xpub661MyMwAqRbcFHxWrAKX6D3Uc7PzpaTSHuXVzCxfY9qFaBcREfy23vx7RtT8CC9tcTKp5JNbcK1pQgjGnBWi3Br8wUryLwLS13CyGREyFs3/0/0/10/*)))#nlkef9fp"
+├── p2shP2wsh/internal: "sh(wsh(multi(2,xpub661MyMwAqRbcFDYKGMFUdU7DbgCM5xcyaHzofQnvQK2vEV9wfHCyrh3xyXoMRL1DBURzdqjnAZdX91qbJv6C1UsiJUPDF7EBf6wez7VrEJR/0/0/11/*,xpub661MyMwAqRbcFawpks1M1Ky7LfJ8WA8Ck4tcp6bGEUNKCFdCC1s7CxuYTjpAQV9eN7W59ctCYyTFPBPRiiBm4CnsYdnvdYN4nwu3FsCKnDw/0/0/11/*,xpub661MyMwAqRbcFHxWrAKX6D3Uc7PzpaTSHuXVzCxfY9qFaBcREfy23vx7RtT8CC9tcTKp5JNbcK1pQgjGnBWi3Br8wUryLwLS13CyGREyFs3/0/0/11/*)))#3v6t34rd"
+├── p2wsh/external: "wsh(multi(2,xpub661MyMwAqRbcFDYKGMFUdU7DbgCM5xcyaHzofQnvQK2vEV9wfHCyrh3xyXoMRL1DBURzdqjnAZdX91qbJv6C1UsiJUPDF7EBf6wez7VrEJR/0/0/20/*,xpub661MyMwAqRbcFawpks1M1Ky7LfJ8WA8Ck4tcp6bGEUNKCFdCC1s7CxuYTjpAQV9eN7W59ctCYyTFPBPRiiBm4CnsYdnvdYN4nwu3FsCKnDw/0/0/20/*,xpub661MyMwAqRbcFHxWrAKX6D3Uc7PzpaTSHuXVzCxfY9qFaBcREfy23vx7RtT8CC9tcTKp5JNbcK1pQgjGnBWi3Br8wUryLwLS13CyGREyFs3/0/0/20/*))#2sputcy5"
+├── p2wsh/internal: "wsh(multi(2,xpub661MyMwAqRbcFDYKGMFUdU7DbgCM5xcyaHzofQnvQK2vEV9wfHCyrh3xyXoMRL1DBURzdqjnAZdX91qbJv6C1UsiJUPDF7EBf6wez7VrEJR/0/0/21/*,xpub661MyMwAqRbcFawpks1M1Ky7LfJ8WA8Ck4tcp6bGEUNKCFdCC1s7CxuYTjpAQV9eN7W59ctCYyTFPBPRiiBm4CnsYdnvdYN4nwu3FsCKnDw/0/0/21/*,xpub661MyMwAqRbcFHxWrAKX6D3Uc7PzpaTSHuXVzCxfY9qFaBcREfy23vx7RtT8CC9tcTKp5JNbcK1pQgjGnBWi3Br8wUryLwLS13CyGREyFs3/0/0/21/*))#9ush3alg"
+├── p2tr/external: null
+├── p2tr/internal: null
+├── p2trMusig2/external: null
+└── p2trMusig2/internal: null
+