Merge pull request #5908 from BitGo/BTC-1966.babylon-unstaking-tx

feat(utxo-staking): implement babylon unstaking tests

Author: OttoAllmendinger

modules/utxo-core/src/descriptor/psbt/createPsbt.ts

@@ -48,15 +48,19 @@ export type PsbtParams = {
   sequence?: number;
 };
 
+export type DerivedDescriptorTransactionInput = DerivedDescriptorWalletOutput & {
+  sequence?: number;
+};
+
 export function createPsbt(
   params: PsbtParams,
-  inputs: DerivedDescriptorWalletOutput[],
+  inputs: DerivedDescriptorTransactionInput[],
   outputs: WithOptDescriptor<Output>[]
 ): utxolib.bitgo.UtxoPsbt {
   const psbt = utxolib.bitgo.UtxoPsbt.createPsbt({ network: params.network });
   psbt.setVersion(params.version ?? 2);
   psbt.setLocktime(params.locktime ?? 0);
-  psbt.addInputs(inputs.map((i) => ({ ...i, sequence: params.sequence ?? MAX_BIP125_RBF_SEQUENCE })));
+  psbt.addInputs(inputs.map((i) => ({ ...i, sequence: i.sequence ?? params.sequence ?? MAX_BIP125_RBF_SEQUENCE })));
   psbt.addOutputs(outputs);
   updateInputsWithDescriptors(
     psbt,

modules/utxo-core/src/descriptor/psbt/index.ts

@@ -3,3 +3,4 @@ export * from './createPsbt';
 export * from './parse';
 export * from './findDescriptors';
 export * from './wrap';
+export * from './sign';

modules/utxo-core/src/descriptor/psbt/sign.ts

@@ -0,0 +1,47 @@
+import assert from 'assert';
+
+import * as utxolib from '@bitgo/utxo-lib';
+import { Psbt as WasmPsbt } from '@bitgo/wasm-miniscript';
+
+/** These can be replaced when @bitgo/wasm-miniscript is updated */
+export type SignPsbtInputResult = { Schnorr: string[] } | { Ecdsa: string[] };
+export type SignPsbtResult = {
+  [inputIndex: number]: SignPsbtInputResult;
+};
+
+/**
+ * @param signResult
+ * @return the number of new signatures created by the signResult for a single input
+ */
+export function getNewSignatureCountForInput(signResult: SignPsbtInputResult): number {
+  if ('Schnorr' in signResult) {
+    return signResult.Schnorr.length;
+  }
+  if ('Ecdsa' in signResult) {
+    return signResult.Ecdsa.length;
+  }
+  throw new Error(`Unknown signature type ${Object.keys(signResult).join(', ')}`);
+}
+
+/**
+ * @param signResult
+ * @return the number of new signatures created by the signResult
+ */
+export function getNewSignatureCount(signResult: SignPsbtResult): number {
+  return Object.values(signResult).reduce((sum, signatures) => sum + getNewSignatureCountForInput(signatures), 0);
+}
+
+type Key = Buffer | utxolib.BIP32Interface | utxolib.ECPairInterface;
+
+/** Convenience function to sign a PSBT with a key */
+export function signWithKey(psbt: WasmPsbt, key: Key): SignPsbtResult {
+  // we need to do casting here because the type definitions in wasm-miniscript are a little bit buggy
+  if (Buffer.isBuffer(key)) {
+    return psbt.signWithPrv(key) as unknown as SignPsbtResult;
+  }
+  if ('toBase58' in key) {
+    return psbt.signWithXprv(key.toBase58()) as unknown as SignPsbtResult;
+  }
+  assert(key.privateKey);
+  return psbt.signWithPrv(key.privateKey) as unknown as SignPsbtResult;
+}

modules/utxo-core/src/testutil/descriptor/mock.utils.ts

@@ -1,8 +1,12 @@
 import { Descriptor } from '@bitgo/wasm-miniscript';
 import * as utxolib from '@bitgo/utxo-lib';
 
-import { PsbtParams, createPsbt, createScriptPubKeyFromDescriptor } from '../../descriptor';
-import { DerivedDescriptorWalletOutput } from '../../descriptor/Output';
+import {
+  PsbtParams,
+  createPsbt,
+  createScriptPubKeyFromDescriptor,
+  DerivedDescriptorTransactionInput,
+} from '../../descriptor';
 
 import { DescriptorTemplate, getDefaultXPubs, getDescriptor } from './descriptors';
 
@@ -12,6 +16,7 @@ type BaseMockDescriptorOutputParams = {
   id?: MockOutputIdParams;
   index?: number;
   value?: bigint;
+  sequence?: number;
 };
 
 function mockOutputId(id?: MockOutputIdParams): {
@@ -26,7 +31,7 @@ function mockOutputId(id?: MockOutputIdParams): {
 export function mockDerivedDescriptorWalletOutput(
   descriptor: Descriptor,
   outputParams: BaseMockDescriptorOutputParams = {}
-): DerivedDescriptorWalletOutput {
+): DerivedDescriptorTransactionInput {
   const { value = BigInt(1e6) } = outputParams;
   const { hash, vout } = mockOutputId(outputParams.id);
   return {
@@ -37,6 +42,7 @@ export function mockDerivedDescriptorWalletOutput(
       value,
     },
     descriptor,
+    sequence: outputParams.sequence,
   };
 }