Merge pull request #5087 from BitGo/BTC-1578-descriptor

chore(utxo-coredao): add fixture from testnet3

Author: davidkaplanbitgo

modules/utxo-coredao/src/descriptor.ts

@@ -5,19 +5,27 @@ import { BIP32Interface } from '@bitgo/utxo-lib';
  */
 export type ScriptType = 'sh' | 'sh-wsh';
 
+function asDescriptorKey(key: BIP32Interface | Buffer, neutered: boolean): string {
+  if (Buffer.isBuffer(key)) {
+    return key.toString('hex');
+  }
+  return (neutered ? key.neutered() : key).toBase58() + '/*';
+}
+
 /**
  * Create a multi-sig descriptor to produce a coredao staking address
  * @param scriptType segwit or legacy
  * @param locktime locktime for CLTV
  * @param m Total number of keys required to unlock
- * @param orderedKeys
+ * @param orderedKeys If Bip32Interfaces, these are xprvs or xpubs and are derivable.
+ *                    If they are buffers, then they are pub/prv keys and are not derivable.
  * @param neutered If true, neuter the keys. Default to true
  */
 export function createMultiSigDescriptor(
   scriptType: ScriptType,
   locktime: number,
   m: number,
-  orderedKeys: BIP32Interface[],
+  orderedKeys: (BIP32Interface | Buffer)[],
   neutered = true
 ): string {
   if (m > orderedKeys.length || m < 1) {
@@ -28,8 +36,7 @@ export function createMultiSigDescriptor(
   if (locktime <= 0) {
     throw new Error(`locktime (${locktime}) must be greater than 0`);
   }
-
-  const xpubs = orderedKeys.map((key) => (neutered ? key.neutered() : key).toBase58() + '/*');
-  const inner = `and_v(r:after(${locktime}),multi(${m},${xpubs.join(',')}))`;
+  const keys = orderedKeys.map((key) => asDescriptorKey(key, neutered));
+  const inner = `and_v(r:after(${locktime}),multi(${m},${keys.join(',')}))`;
   return scriptType === 'sh' ? `sh(${inner})` : `sh(wsh(${inner}))`;
 }

modules/utxo-coredao/src/index.ts

@@ -1 +1,2 @@
 export * from './opReturn';
+export * from './descriptor';

modules/utxo-coredao/src/opReturn.ts

@@ -194,3 +194,15 @@ export function parseCoreDaoOpReturnOutputScript(script: Buffer): OpReturnParams
     return { ...baseParams, redeemScript: Buffer.from(dataBuffer.subarray(offset)) };
   }
 }
+
+export function toString(params: OpReturnParams): string {
+  return JSON.stringify({
+    version: params.version,
+    chainId: params.chainId.toString('hex'),
+    delegator: params.delegator.toString('hex'),
+    validator: params.validator.toString('hex'),
+    fee: params.fee,
+    ...('redeemScript' in params ? { redeemScript: params.redeemScript.toString('hex') } : {}),
+    ...('timelock' in params ? { timelock: params.timelock } : {}),
+  });
+}

modules/utxo-coredao/test/fixtures/opReturn/66ed4cea26a410248a6d87f14b2bca514f33920c54d4af63ed46a903793115d5.json

@@ -0,0 +1,8 @@
+{
+  "version": 1,
+  "chainId": "045b",
+  "delegator": "2dda5d5d3bec673033b5f21ca07c77695404f491",
+  "validator": "2953559db5cc88ab20b1960faa9793803d070337",
+  "fee": 0,
+  "timelock": 1725503428
+}

modules/utxo-coredao/test/fixtures/opReturn/66ed4cea26a410248a6d87f14b2bca514f33920c54d4af63ed46a903793115d5.txt

@@ -0,0 +1 @@
+6a345341542b01045b2dda5d5d3bec673033b5f21ca07c77695404f4912953559db5cc88ab20b1960faa9793803d07033700c417d966

modules/utxo-coredao/test/fixtures/opReturn/documentation.txt

@@ -0,0 +1 @@
+6a4c505341542b01045bde60b7d0e6b758ca5dd8c61d377a2c5f1af51ec1a9e209f5ea0036c8c2f41078a3cebee57d8a47d501041f5e0e66b17576a914c4b8ae927ff2b9ce218e20bf06d425d6b68424fd88ac

modules/utxo-coredao/test/unit/descriptor.ts

@@ -4,6 +4,7 @@ import { Descriptor } from '@bitgo/wasm-miniscript';
 
 import { createMultiSigDescriptor } from '../../src/descriptor';
 import { finalizePsbt, getFixture, updateInputWithDescriptor } from './utils';
+import { decodeTimelock } from '../../src';
 
 describe('descriptor', function () {
   const baseFixturePath = 'test/fixtures/descriptor/';
@@ -114,4 +115,36 @@ describe('descriptor', function () {
   runTestForParams('sh', 2, [key1, key2]);
   runTestForParams('sh-wsh', 2, [key1, key2]);
   runTestForParams('sh', 3, [key1, key2, key3]);
+
+  it('should recreate the script used in testnet staking transaction', function () {
+    // Source: https://mempool.space/testnet/address/2MxTi2EhHKgdJFKRTBttVGGxir9ZzjmKCXw
+    // 2 of 2 multisig
+    const timelock = 'fce4cb66';
+    const pubkey1 = '03ecb6d4b7f5d56962e547fc52dd588359f5729c0ba856d6978b84723895a16691';
+    const pubkey2 = '024aaea25d82b1db2be030a05b641d6302e48ed652b1ca9cb08a67267fcbb56747';
+    const redeemScriptASM = [
+      'OP_PUSHBYTES_4',
+      timelock,
+      'OP_CLTV',
+      'OP_DROP',
+      'OP_PUSHNUM_2',
+      'OP_PUSHBYTES_33',
+      pubkey1,
+      'OP_PUSHBYTES_33',
+      pubkey2,
+      'OP_PUSHNUM_2',
+      'OP_CHECKMULTISIG',
+    ].join(' ');
+
+    const decodedTimelock = decodeTimelock(Buffer.from(timelock, 'hex'));
+    const descriptor = createMultiSigDescriptor(
+      'sh',
+      decodedTimelock,
+      2,
+      [Buffer.from(pubkey1, 'hex'), Buffer.from(pubkey2, 'hex')],
+      false
+    );
+    const descriptorASM = Descriptor.fromString(descriptor, 'definite').toAsmString();
+    assert.deepStrictEqual(redeemScriptASM, descriptorASM);
+  });
 });

modules/utxo-coredao/test/unit/opReturn.ts

@@ -6,8 +6,10 @@ import {
   decodeTimelock,
   encodeTimelock,
   parseCoreDaoOpReturnOutputScript,
+  toString,
 } from '../../src';
 import { testutil } from '@bitgo/utxo-lib';
+import { getFixture } from './utils';
 
 describe('OP_RETURN', function () {
   const validVersion = 2;
@@ -18,9 +20,14 @@ describe('OP_RETURN', function () {
   const validFee = 1;
   const validRedeemScript = Buffer.from('522103a8295453660d5e212d55556666666666666666666666666666666666', 'hex');
   const validTimelock = 800800;
-  // https://docs.coredao.org/docs/Learn/products/btc-staking/design#op_return-output-1
-  const defaultScript =
-    '6a4c505341542b01045bde60b7d0e6b758ca5dd8c61d377a2c5f1af51ec1a9e209f5ea0036c8c2f41078a3cebee57d8a47d501041f5e0e66b17576a914c4b8ae927ff2b9ce218e20bf06d425d6b68424fd88ac';
+  let defaultScript: string;
+
+  before(async function () {
+    // https://docs.coredao.org/docs/Learn/products/btc-staking/design#op_return-output-1
+    const script = await getFixture('test/fixtures/opReturn/documentation.txt', undefined);
+    assert(typeof script === 'string');
+    defaultScript = script;
+  });
 
   describe('createCoreDaoOpReturnOutputScript', function () {
     it('should throw if invalid parameters are passed', function () {
@@ -201,7 +208,6 @@ describe('OP_RETURN', function () {
           fee: 1,
           redeemScript: Buffer.from('041f5e0e66b17576a914c4b8ae927ff2b9ce218e20bf06d425d6b68424fd88ac', 'hex'),
         }).toString('hex'),
-        // Source: https://docs.coredao.org/docs/Learn/products/btc-staking/design#op_return-output-1
         defaultScript
       );
     });
@@ -246,6 +252,16 @@ describe('OP_RETURN', function () {
       assert.deepStrictEqual(parsed.redeemScript, validRedeemScript);
     });
 
+    it('should parse valid opreturn script from testnet', async function () {
+      // Source: https://mempool.space/testnet/tx/66ed4cea26a410248a6d87f14b2bca514f33920c54d4af63ed46a903793115d5
+      const baseFixturePath = 'test/fixtures/opReturn/66ed4cea26a410248a6d87f14b2bca514f33920c54d4af63ed46a903793115d5';
+      const opReturnHex = await getFixture(baseFixturePath + '.txt', undefined);
+      assert(typeof opReturnHex === 'string');
+      const parsed = parseCoreDaoOpReturnOutputScript(Buffer.from(opReturnHex, 'hex'));
+      const parsedFixture = await getFixture(baseFixturePath + '.json', JSON.parse(toString(parsed)));
+      assert.deepStrictEqual(toString(parsed), JSON.stringify(parsedFixture));
+    });
+
     it('should fail if there is an invalid op-return', function () {
       const script = defaultScript.replace('6a4c50', '6b4c50');
       assert.throws(() => parseCoreDaoOpReturnOutputScript(Buffer.from(script, 'hex')));

modules/utxo-coredao/test/unit/utils.ts

@@ -7,7 +7,7 @@ function encode(path: string, defaultValue: unknown): string {
     return String(defaultValue);
   }
   if (path.endsWith('.json')) {
-    return JSON.stringify(defaultValue, null, 2);
+    return JSON.stringify(defaultValue, null, 2) + '\n';
   }
   throw new Error(`unrecognized path ${path}`);
 }