feat(utxo-coredao): descriptor for CoreDao

davidkaplanbitgo · davidkaplanbitgo · commit daabd7510565 · 2024-10-30T14:13:54.000-04:00
TICKET: BTC-1578
diff --git a/modules/utxo-coredao/src/descriptor.ts b/modules/utxo-coredao/src/descriptor.ts
@@ -0,0 +1,47 @@
+import { BIP32Interface, bitgo } from '@bitgo/utxo-lib';
+
+/**
+ * Script type for a descriptor. This is either a p2sh (sh) or a p2sh-p2wsh (sh-wsh) script.
+ */
+export type ScriptType = 'sh' | 'sh-wsh';
+
+/**
+ * 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
+ */
+export function createMultiSigDescriptor(
+  scriptType: ScriptType,
+  locktime: number,
+  m: number,
+  orderedKeys: BIP32Interface[]
+): string {
+  if (m > orderedKeys.length || m < 1) {
+    throw new Error(
+      `m (${m}) must be less than or equal to the number of keys (${orderedKeys.length}) and greater than 0`
+    );
+  }
+  if (locktime <= 0) {
+    throw new Error(`locktime (${locktime}) must be greater than 0`);
+  }
+
+  const xpubs = orderedKeys.map((key) => key.toBase58() + '/*');
+  const inner = `and_v(r:after(${locktime}),multi(${m},${xpubs.join(',')}))`;
+  return scriptType === 'sh' ? `sh(${inner})` : `sh(wsh(${inner}))`;
+}
+
+/**
+ * Create a wallet descriptor to produce a coredao staking address for a standard BitGo wallet
+ * @param scriptType
+ * @param locktime
+ * @param rootWalletKeys
+ */
+export function createWalletDescriptor(
+  scriptType: ScriptType,
+  locktime: number,
+  rootWalletKeys: bitgo.RootWalletKeys
+): string {
+  return createMultiSigDescriptor(scriptType, locktime, 2, rootWalletKeys.triple);
+}
diff --git a/modules/utxo-coredao/test/fixtures/descriptor/sh-2of2-asm.txt b/modules/utxo-coredao/test/fixtures/descriptor/sh-2of2-asm.txt
@@ -0,0 +1 @@
+OP_PUSHBYTES_2 0008 OP_CLTV OP_DROP OP_PUSHNUM_2 OP_PUSHBYTES_33 03b6ca82c5298cba26c76a9cc5a9bb08c68b125263924ac9d58a15a60d49cf3ef3 OP_PUSHBYTES_33 02e6a4442a7efbc0f53fad6ff2a7c0940ea18c751a0b6644c03675babd731015cc OP_PUSHNUM_2 OP_CHECKMULTISIG
diff --git a/modules/utxo-coredao/test/fixtures/descriptor/sh-2of2-ast.json b/modules/utxo-coredao/test/fixtures/descriptor/sh-2of2-ast.json
@@ -0,0 +1 @@
+{"Sh":{"Ms":{"AndV":[{"Drop":{"After":{"absLockTime":2048}}},{"Multi":[2,{"XPub":"xpub661MyMwAqRbcGZfgedgcQiBJpkHoZ37k6uotUVLoC6Px4Y46Yrdmy1CUogcJMoAsosY381gPjhGe9jFx1uYAcxy2gTHh9YFP32tUWycqHnV/*"},{"XPub":"xpub661MyMwAqRbcF8FoYWukS8eTn2gVEojzwf5DYETpB8uqC8t5sqDCEFnuJ39DaPjLRerBDK9QqSMvSYpT4WSugCVbUK5HEevSKAu1wUkVWsS/*"}]}]}}}
diff --git a/modules/utxo-coredao/test/fixtures/descriptor/sh-2of2-string.txt b/modules/utxo-coredao/test/fixtures/descriptor/sh-2of2-string.txt
@@ -0,0 +1 @@
+sh(and_v(r:after(2048),multi(2,xprv9s21ZrQH143K45bDYc9c3aEaGiTK9aPtjgtHg6wBdkryBjix1KKXRCszxPcFPejLT9tdLgNe8E8AuQXK2fy8KhNPeLAZsGoX8w9KS2PkacL/*,xprv9s21ZrQH143K2eBLSVNk4zhjDzqzqM29aS9cjr4CcoNrKLYwLHtwgTURSk7RPV3cH9zNZQeR1zGw3MEwSjvARSfWEGpxfaBmduhW3TKsH5g/*)))
diff --git a/modules/utxo-coredao/test/fixtures/descriptor/sh-3of3-asm.txt b/modules/utxo-coredao/test/fixtures/descriptor/sh-3of3-asm.txt
@@ -0,0 +1 @@
+OP_PUSHBYTES_2 0008 OP_CLTV OP_DROP OP_PUSHNUM_3 OP_PUSHBYTES_33 03b6ca82c5298cba26c76a9cc5a9bb08c68b125263924ac9d58a15a60d49cf3ef3 OP_PUSHBYTES_33 02e6a4442a7efbc0f53fad6ff2a7c0940ea18c751a0b6644c03675babd731015cc OP_PUSHBYTES_33 038ce8843d1085927fdb26a26e9869d6c10dcd37aa45fdd9773ff544a7f3514c82 OP_PUSHNUM_3 OP_CHECKMULTISIG
diff --git a/modules/utxo-coredao/test/fixtures/descriptor/sh-3of3-ast.json b/modules/utxo-coredao/test/fixtures/descriptor/sh-3of3-ast.json
@@ -0,0 +1 @@
+{"Sh":{"Ms":{"AndV":[{"Drop":{"After":{"absLockTime":2048}}},{"Multi":[3,{"XPub":"xpub661MyMwAqRbcGZfgedgcQiBJpkHoZ37k6uotUVLoC6Px4Y46Yrdmy1CUogcJMoAsosY381gPjhGe9jFx1uYAcxy2gTHh9YFP32tUWycqHnV/*"},{"XPub":"xpub661MyMwAqRbcF8FoYWukS8eTn2gVEojzwf5DYETpB8uqC8t5sqDCEFnuJ39DaPjLRerBDK9QqSMvSYpT4WSugCVbUK5HEevSKAu1wUkVWsS/*"},{"XPub":"xpub661MyMwAqRbcFdScyinA4JpCViqkKsd37MQ6fwuZQQ4shdaGRRX9a8bWvR9QC1AFqKongweJJfyrm7uCoWmCw7UixwGZkZnCT2mchFr7cQb/*"}]}]}}}
diff --git a/modules/utxo-coredao/test/fixtures/descriptor/sh-3of3-string.txt b/modules/utxo-coredao/test/fixtures/descriptor/sh-3of3-string.txt
@@ -0,0 +1 @@
+sh(and_v(r:after(2048),multi(3,xprv9s21ZrQH143K45bDYc9c3aEaGiTK9aPtjgtHg6wBdkryBjix1KKXRCszxPcFPejLT9tdLgNe8E8AuQXK2fy8KhNPeLAZsGoX8w9KS2PkacL/*,xprv9s21ZrQH143K2eBLSVNk4zhjDzqzqM29aS9cjr4CcoNrKLYwLHtwgTURSk7RPV3cH9zNZQeR1zGw3MEwSjvARSfWEGpxfaBmduhW3TKsH5g/*,xprv9s21ZrQH143K39N9shF9hAsTwh1FvQuBk8UVsZVwr4XtpqF7stCu2LH358NLuqkkK6pu1Af7TJHr5FZERQoLLtnC7wkoM9sdFo1HuP7dWuv/*)))
diff --git a/modules/utxo-coredao/test/fixtures/descriptor/sh-wsh-2of2-asm.txt b/modules/utxo-coredao/test/fixtures/descriptor/sh-wsh-2of2-asm.txt
@@ -0,0 +1 @@
+OP_PUSHBYTES_2 0008 OP_CLTV OP_DROP OP_PUSHNUM_2 OP_PUSHBYTES_33 03b6ca82c5298cba26c76a9cc5a9bb08c68b125263924ac9d58a15a60d49cf3ef3 OP_PUSHBYTES_33 02e6a4442a7efbc0f53fad6ff2a7c0940ea18c751a0b6644c03675babd731015cc OP_PUSHNUM_2 OP_CHECKMULTISIG
diff --git a/modules/utxo-coredao/test/fixtures/descriptor/sh-wsh-2of2-ast.json b/modules/utxo-coredao/test/fixtures/descriptor/sh-wsh-2of2-ast.json
@@ -0,0 +1 @@
+{"Sh":{"Wsh":{"Ms":{"AndV":[{"Drop":{"After":{"absLockTime":2048}}},{"Multi":[2,{"XPub":"xpub661MyMwAqRbcGZfgedgcQiBJpkHoZ37k6uotUVLoC6Px4Y46Yrdmy1CUogcJMoAsosY381gPjhGe9jFx1uYAcxy2gTHh9YFP32tUWycqHnV/*"},{"XPub":"xpub661MyMwAqRbcF8FoYWukS8eTn2gVEojzwf5DYETpB8uqC8t5sqDCEFnuJ39DaPjLRerBDK9QqSMvSYpT4WSugCVbUK5HEevSKAu1wUkVWsS/*"}]}]}}}}
diff --git a/modules/utxo-coredao/test/fixtures/descriptor/sh-wsh-2of2-string.txt b/modules/utxo-coredao/test/fixtures/descriptor/sh-wsh-2of2-string.txt
@@ -0,0 +1 @@
+sh(wsh(and_v(r:after(2048),multi(2,xprv9s21ZrQH143K45bDYc9c3aEaGiTK9aPtjgtHg6wBdkryBjix1KKXRCszxPcFPejLT9tdLgNe8E8AuQXK2fy8KhNPeLAZsGoX8w9KS2PkacL/*,xprv9s21ZrQH143K2eBLSVNk4zhjDzqzqM29aS9cjr4CcoNrKLYwLHtwgTURSk7RPV3cH9zNZQeR1zGw3MEwSjvARSfWEGpxfaBmduhW3TKsH5g/*))))
diff --git a/modules/utxo-coredao/test/unit/descriptor.ts b/modules/utxo-coredao/test/unit/descriptor.ts
@@ -0,0 +1,110 @@
+import * as assert from 'assert';
+import * as utxolib from '@bitgo/utxo-lib';
+import { Descriptor, Psbt as WrappedPsbt } from '@bitgo/wasm-miniscript';
+
+import { createMultiSigDescriptor } from '../../src/descriptor';
+import { getFixtureString, updateInputWithDescriptor } from './utils';
+
+describe('descriptor', function () {
+  const baseFixturePath = 'test/fixtures/descriptor/';
+  const rootWalletKeys = utxolib.testutil.getDefaultWalletKeys();
+  const key1 = rootWalletKeys.triple[0];
+  const key2 = rootWalletKeys.triple[1];
+  const key3 = rootWalletKeys.triple[2];
+  const validLocktime = 2048;
+
+  it('should fail if m is longer than the number of keys or not at least 1', function () {
+    assert.throws(() => {
+      createMultiSigDescriptor('sh', validLocktime, 3, [key1, key2]);
+    });
+
+    assert.throws(() => {
+      createMultiSigDescriptor('sh', validLocktime, 0, [key1, key2]);
+    });
+  });
+
+  it('should fail if locktime is invalid', function () {
+    assert.throws(() => {
+      createMultiSigDescriptor('sh', 0, 2, [key1, key2]);
+    });
+  });
+
+  async function runTestForParams(scriptType: 'sh' | 'sh-wsh', m: number, keys: utxolib.BIP32Interface[]) {
+    const fixturePath = baseFixturePath + `${scriptType}-${m}of${keys.length}`;
+    describe(`should create a ${m} of ${keys.length} multi-sig ${scriptType} descriptor`, function () {
+      it('has expected descriptor string', async function () {
+        const descriptorString = createMultiSigDescriptor(scriptType, validLocktime, m, keys);
+        assert.strictEqual(
+          descriptorString,
+          await getFixtureString(fixturePath + `-string.txt`, descriptorString),
+          descriptorString
+        );
+      });
+
+      it('has expected AST', async function () {
+        const descriptor = Descriptor.fromString(
+          createMultiSigDescriptor(scriptType, validLocktime, m, keys),
+          'derivable'
+        );
+
+        assert.deepStrictEqual(
+          descriptor.node(),
+          JSON.parse(await getFixtureString(fixturePath + '-ast.json', JSON.stringify(descriptor.node())))
+        );
+      });
+
+      it('has expected asm', async function () {
+        const descriptor = Descriptor.fromString(
+          createMultiSigDescriptor(scriptType, validLocktime, m, keys),
+          'derivable'
+        );
+        const asmString = descriptor.atDerivationIndex(0).toAsmString();
+        assert.strictEqual(asmString, await getFixtureString(fixturePath + '-asm.txt', asmString), asmString);
+      });
+
+      it('can be signed', async function () {
+        if (true) {
+          return;
+        }
+        const descriptor = Descriptor.fromString(
+          createMultiSigDescriptor(scriptType, validLocktime, m, keys),
+          'derivable'
+        );
+        const psbt = Object.assign(new utxolib.Psbt({ network: utxolib.networks.bitcoin }), {
+          locktime: validLocktime,
+        });
+        const descriptorAt0 = descriptor.atDerivationIndex(0);
+        const script = Buffer.from(descriptorAt0.scriptPubkey());
+        psbt.addInput({
+          hash: Buffer.alloc(32),
+          index: 0,
+          sequence: 0xfffffffe,
+          witnessUtxo: { script, value: BigInt(1e8) },
+        });
+        psbt.addOutput({ script, value: BigInt(0.9e8) });
+
+        const wrappedPsbt = WrappedPsbt.deserialize(psbt.toBuffer());
+        // This is failing with the following error:
+        // The input's witness_utxo and/or non_witness_utxo were invalid or missing
+        updateInputWithDescriptor(psbt, 0, descriptorAt0);
+        psbt.data.inputs[0] = utxolib.Psbt.fromBuffer(Buffer.from(wrappedPsbt.serialize())).data.inputs[0];
+        keys.forEach((signer, i) => {
+          if (i >= m) {
+            return;
+          }
+          psbt.signAllInputsHD(signer);
+        });
+        psbt.finalizeAllInputs();
+        const signedTx = psbt.extractTransaction().toBuffer();
+        assert.strictEqual(
+          signedTx.toString('hex'),
+          await getFixtureString(fixturePath + '-tx.txt', signedTx.toString('hex'))
+        );
+      });
+    });
+  }
+
+  runTestForParams('sh', 2, [key1, key2]);
+  runTestForParams('sh-wsh', 2, [key1, key2]);
+  runTestForParams('sh', 3, [key1, key2, key3]);
+});
diff --git a/modules/utxo-coredao/test/unit/utils.ts b/modules/utxo-coredao/test/unit/utils.ts
@@ -0,0 +1,23 @@
+import { promises as fs } from 'fs';
+import { Descriptor, Psbt } from '@bitgo/wasm-miniscript';
+import * as utxolib from '@bitgo/utxo-lib';
+
+export async function getFixtureString(path: string, defaultValue: string): Promise<string> {
+  try {
+    return await fs.readFile(path, 'utf8');
+  } catch (e) {
+    if ((e as any).code === 'ENOENT') {
+      await fs.writeFile(path, defaultValue, 'utf8');
+      throw new Error(`wrote default value for ${path}`);
+    }
+    throw e;
+  }
+}
+
+export function updateInputWithDescriptor(psbt: utxolib.Psbt, inputIndex: number, descriptor: Descriptor) {
+  const wrappedPsbt = Psbt.deserialize(psbt.toBuffer());
+  wrappedPsbt.updateInputWithDescriptor(inputIndex, descriptor);
+  psbt.data.inputs[inputIndex] = utxolib.bitgo.UtxoPsbt.fromBuffer(Buffer.from(wrappedPsbt.serialize()), {
+    network: utxolib.networks.bitcoin,
+  }).data.inputs[inputIndex];
+}

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+OP_PUSHBYTES_2 0008 OP_CLTV OP_DROP OP_PUSHNUM_2 OP_PUSHBYTES_33 03b6ca82c5298cba26c76a9cc5a9bb08c68b125263924ac9d58a15a60d49cf3ef3 OP_PUSHBYTES_33 02e6a4442a7efbc0f53fad6ff2a7c0940ea18c751a0b6644c03675babd731015cc OP_PUSHNUM_2 OP_CHECKMULTISIG`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"Sh":{"Ms":{"AndV":[{"Drop":{"After":{"absLockTime":2048}}},{"Multi":[2,{"XPub":"xpub661MyMwAqRbcGZfgedgcQiBJpkHoZ37k6uotUVLoC6Px4Y46Yrdmy1CUogcJMoAsosY381gPjhGe9jFx1uYAcxy2gTHh9YFP32tUWycqHnV/"},{"XPub":"xpub661MyMwAqRbcF8FoYWukS8eTn2gVEojzwf5DYETpB8uqC8t5sqDCEFnuJ39DaPjLRerBDK9QqSMvSYpT4WSugCVbUK5HEevSKAu1wUkVWsS/"}]}]}}}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+sh(and_v(r:after(2048),multi(2,xprv9s21ZrQH143K45bDYc9c3aEaGiTK9aPtjgtHg6wBdkryBjix1KKXRCszxPcFPejLT9tdLgNe8E8AuQXK2fy8KhNPeLAZsGoX8w9KS2PkacL/,xprv9s21ZrQH143K2eBLSVNk4zhjDzqzqM29aS9cjr4CcoNrKLYwLHtwgTURSk7RPV3cH9zNZQeR1zGw3MEwSjvARSfWEGpxfaBmduhW3TKsH5g/)))`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+sh(and_v(r:after(2048),multi(3,xprv9s21ZrQH143K45bDYc9c3aEaGiTK9aPtjgtHg6wBdkryBjix1KKXRCszxPcFPejLT9tdLgNe8E8AuQXK2fy8KhNPeLAZsGoX8w9KS2PkacL/,xprv9s21ZrQH143K2eBLSVNk4zhjDzqzqM29aS9cjr4CcoNrKLYwLHtwgTURSk7RPV3cH9zNZQeR1zGw3MEwSjvARSfWEGpxfaBmduhW3TKsH5g/,xprv9s21ZrQH143K39N9shF9hAsTwh1FvQuBk8UVsZVwr4XtpqF7stCu2LH358NLuqkkK6pu1Af7TJHr5FZERQoLLtnC7wkoM9sdFo1HuP7dWuv/*)))`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"Sh":{"Wsh":{"Ms":{"AndV":[{"Drop":{"After":{"absLockTime":2048}}},{"Multi":[2,{"XPub":"xpub661MyMwAqRbcGZfgedgcQiBJpkHoZ37k6uotUVLoC6Px4Y46Yrdmy1CUogcJMoAsosY381gPjhGe9jFx1uYAcxy2gTHh9YFP32tUWycqHnV/"},{"XPub":"xpub661MyMwAqRbcF8FoYWukS8eTn2gVEojzwf5DYETpB8uqC8t5sqDCEFnuJ39DaPjLRerBDK9QqSMvSYpT4WSugCVbUK5HEevSKAu1wUkVWsS/"}]}]}}}}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+sh(wsh(and_v(r:after(2048),multi(2,xprv9s21ZrQH143K45bDYc9c3aEaGiTK9aPtjgtHg6wBdkryBjix1KKXRCszxPcFPejLT9tdLgNe8E8AuQXK2fy8KhNPeLAZsGoX8w9KS2PkacL/,xprv9s21ZrQH143K2eBLSVNk4zhjDzqzqM29aS9cjr4CcoNrKLYwLHtwgTURSk7RPV3cH9zNZQeR1zGw3MEwSjvARSfWEGpxfaBmduhW3TKsH5g/))))`