Merge pull request #5672 from BitGo/BTC-1826.use-core-output-in-utxo-staking

feat(utxo-staking): standardize CoreDAO output type

Author: OttoAllmendinger

modules/utxo-staking/src/coreDao/transaction.ts

@@ -1,7 +1,14 @@
+import { Output } from '@bitgo/utxo-core';
 import { Descriptor } from '@bitgo/wasm-miniscript';
 
 import { createCoreDaoOpReturnOutputScript, OpReturnParams } from './opReturn';
 
+type StakingParams = {
+  amount: bigint;
+  descriptor: Descriptor;
+  index?: number;
+};
+
 /**
  * Create the staking outputs for a CoreDAO staking transaction. This is the ordering
  * in which to add into the transaction.
@@ -10,14 +17,10 @@ import { createCoreDaoOpReturnOutputScript, OpReturnParams } from './opReturn';
  * If stakingParams.index is provided, then this is assumed to be a `derivable` descriptor.
  * @param opReturnParams to create the OP_RETURN output
  */
-export function createStakingOutputs(
-  stakingParams: {
-    amount: bigint;
-    descriptor: Descriptor;
-    index?: number;
-  },
+export function createStakingOutputsCore(
+  stakingParams: StakingParams,
   opReturnParams: OpReturnParams
-): { script: Buffer; amount: bigint }[] {
+): Output<bigint>[] {
   if (stakingParams.descriptor.hasWildcard() && stakingParams.index === undefined) {
     throw new Error('Cannot create staking outputs with a wildcard descriptor and no derivation index');
   }
@@ -30,7 +33,20 @@ export function createStakingOutputs(
   const opReturnScript = createCoreDaoOpReturnOutputScript(opReturnParams);
 
   return [
-    { script: outputScript, amount: stakingParams.amount },
-    { script: opReturnScript, amount: BigInt(0) },
+    { script: outputScript, value: stakingParams.amount },
+    { script: opReturnScript, value: BigInt(0) },
   ];
 }
+
+type LegacyOutput = {
+  script: Buffer;
+  amount: bigint;
+};
+
+/**
+ * @see createStakingOutputsCore
+ * @deprecated - use createStakingOutputsCore instead
+ */
+export function createStakingOutputs(stakingParams: StakingParams, opReturnParams: OpReturnParams): LegacyOutput[] {
+  return createStakingOutputsCore(stakingParams, opReturnParams).map(({ value, ...o }) => ({ ...o, amount: value }));
+}