review comments and remove stakingOutputIndex from input

babylonlabs-io · Oct 25, 2024 · 4e8cd70 · 4e8cd70
1 parent a4ce6d7
commit 4e8cd70
Show file tree

Hide file tree

Showing 14 changed files with 212 additions and 195 deletions.
diff --git a/src/staking/index.ts b/src/staking/index.ts
@@ -10,12 +10,11 @@ import {
   withdrawEarlyUnbondedTransaction,
   withdrawTimelockUnbondedTransaction
 } from "./transactions";
-import { 
-  deriveAddressFromPkScript,
+import {
   isTaproot,
   isValidBitcoinAddress, isValidNoCoordPublicKey
 } from "../utils/btc";
-import { validateParams, validateStakingTimelock, validateStakingTxInputData, validateStakingTxOutputIndex } from "../utils/staking";
+import { deriveStakingOutputAddress, findMatchingStakingTxOutputIndex, validateParams, validateStakingTimelock, validateStakingTxInputData } from "../utils/staking";
 import { PsbtTransactionResult } from "../types/transaction";
 import { toBuffers } from "../utils/staking";
 export * from "./stakingScript";
@@ -162,11 +161,16 @@ export class Staking {
    */
   public createUnbondingTransaction(
     stakingTx: Transaction,
-    stakingOutputIndex: number,
-  ) : PsbtTransactionResult {
-    validateStakingTxOutputIndex(stakingTx, stakingOutputIndex);
+  ) : PsbtTransactionResult {    
     // Build scripts
     const scripts = this.buildScripts();
+
+    // Reconstruct the stakingOutputIndex
+    const stakingOutputIndex = findMatchingStakingTxOutputIndex(
+      stakingTx,
+      deriveStakingOutputAddress(scripts, this.network),
+      this.network,
+    )
     // Create the unbonding transaction
     try {
       const { psbt } = unbondingTransaction(
@@ -220,23 +224,28 @@ export class Staking {
   }
 
   /**
-   * Create a withdrawal transaction that spends a naturally expired staking transaction for observable staking.
+   * Create a withdrawal transaction that spends a naturally expired staking 
+   * transaction.
    * 
+   * @param {Transaction} stakingTx - The staking transaction to withdraw from.
    * @param {number} feeRate - The fee rate for the transaction in satoshis per byte.
-   * 
    * @returns {PsbtTransactionResult} - An object containing the unsigned psbt and fee
-   * 
    * @throws {StakingError} - If the delegation is invalid or the transaction cannot be built
    */
   public createWithdrawTimelockUnbondedTransaction(
     stakingTx: Transaction,
-    stakingOutputIndex: number,
     feeRate: number,
   ): PsbtTransactionResult {
-    validateStakingTxOutputIndex(stakingTx, stakingOutputIndex);
     // Build scripts
     const scripts = this.buildScripts();
 
+    // Reconstruct the stakingOutputIndex
+    const stakingOutputIndex = findMatchingStakingTxOutputIndex(
+      stakingTx,
+      deriveStakingOutputAddress(scripts, this.network),
+      this.network,
+    )
+
     // Create the timelock unbonded transaction
     try {
       return withdrawTimelockUnbondedTransaction(
@@ -256,16 +265,15 @@ export class Staking {
   }
 
   /**
-   * Create a slash timelock unbonded transaction for staking.
+   * Create a staking slashing transaction.
    * 
    * @param {Transaction} stakingTx - The staking transaction to slash.
    * without coordinates.
-   * 
    * @returns {PsbtTransactionResult} - An object containing the unsigned psbt and fee
    * 
    * @throws {StakingError} - If the delegation is invalid or the transaction cannot be built
    */
-  public createSlashTimelockUnbondedTransaction(
+  public createStakingOutputSlashingTransaction(
     stakingTx: Transaction,
   ) : PsbtTransactionResult {
     if (!this.params.slashing) {
@@ -274,9 +282,6 @@ export class Staking {
         "Slashing parameters are missing",
       );
     }
-    const slashingAddress = deriveAddressFromPkScript(
-      this.params.slashing.slashingPkScript, this.network,
-    );
 
     // Build scripts
     const scripts = this.buildScripts();
@@ -286,7 +291,7 @@ export class Staking {
       const { psbt } = slashTimelockUnbondedTransaction(
         scripts,
         stakingTx,
-        slashingAddress,
+        this.params.slashing.slashingPkScriptHex,
         this.params.slashing.slashingRate,
         this.params.slashing.minSlashingTxFeeSat,
         this.network,
@@ -301,15 +306,14 @@ export class Staking {
   }
 
   /**
-   * Create a slash early unbonded transaction for staking.
+   * Create a unbonding slashing transaction.
    * 
    * @param {Transaction} unbondingTx - The unbonding transaction to slash.
-   * 
    * @returns {PsbtTransactionResult} - An object containing the unsigned psbt and fee
    * 
    * @throws {StakingError} - If the delegation is invalid or the transaction cannot be built
    */
-  public createSlashEarlyUnbondedTransaction(
+  public createUnbondingOutputSlashingTransaction(
     unbondingTx: Transaction,
   ): PsbtTransactionResult {
     if (!this.params.slashing) {
@@ -318,10 +322,6 @@ export class Staking {
         "Slashing parameters are missing",
       );
     }
-    const slashingAddress = deriveAddressFromPkScript(
-      this.params.slashing.slashingPkScript, this.network,
-    );
-
     // Build scripts
     const scripts = this.buildScripts();
 
@@ -330,7 +330,7 @@ export class Staking {
       const { psbt } = slashEarlyUnbondedTransaction(
         scripts,
         unbondingTx,
-        slashingAddress,
+        this.params.slashing.slashingPkScriptHex,
         this.params.slashing.slashingRate,
         this.params.slashing.minSlashingTxFeeSat,
         this.network,

diff --git a/src/staking/transactions.ts b/src/staking/transactions.ts
@@ -379,7 +379,7 @@ function withdrawalTransaction(
  *
  * @param {Object} scripts - The scripts used in the transaction.
  * @param {Transaction} stakingTransaction - The original staking transaction.
- * @param {string} slashingAddress - The address to send the slashed funds to.
+ * @param {string} slashingPkScriptHex - The public key script to send the slashed funds to.
  * @param {number} slashingRate - The rate at which the funds are slashed.
  * @param {number} minimumFee - The minimum fee for the transaction in satoshis.
  * @param {networks.Network} network - The Bitcoin network.
@@ -394,7 +394,7 @@ export function slashTimelockUnbondedTransaction(
     unbondingTimelockScript: Buffer;
   },
   stakingTransaction: Transaction,
-  slashingAddress: string,
+  slashingPkScriptHex: string,
   slashingRate: number,
   minimumFee: number,
   network: networks.Network,
@@ -413,7 +413,7 @@ export function slashTimelockUnbondedTransaction(
     },
     slashingScriptTree,
     stakingTransaction,
-    slashingAddress,
+    slashingPkScriptHex,
     slashingRate,
     minimumFee,
     network,
@@ -427,26 +427,13 @@ export function slashTimelockUnbondedTransaction(
  * This transaction spends the staking output of the staking transaction and distributes the funds
  * according to the specified slashing rate.
  *
- * Outputs:
+ * Transaction outputs:
  * - The first output sends `input * slashing_rate` funds to the slashing address.
  * - The second output sends `input * (1 - slashing_rate) - fee` funds back to the user's address.
  *
- * Inputs:
- * - scripts: Scripts used to construct the taproot output.
- *   - slashingScript: Script for the slashing condition.
- *   - unbondingTimelockScript: Script for the unbonding timelock condition.
- * - transaction: The unbonding transaction.
- * - slashingAddress: The address to send the slashed funds to.
- * - slashingRate: The rate at which the funds are slashed (0 < slashingRate < 1).
- * - minimumFee: The minimum fee for the transaction in satoshis.
- * - network: The Bitcoin network.
- *
- * Returns:
- * - psbt: The partially signed transaction (PSBT).
- *
  * @param {Object} scripts - The scripts used in the transaction. e.g slashingScript, unbondingTimelockScript
  * @param {Transaction} unbondingTx - The unbonding transaction.
- * @param {string} slashingAddress - The address to send the slashed funds to.
+ * @param {string} slashingPkScriptHex - The public key script to send the slashed funds to.
  * @param {number} slashingRate - The rate at which the funds are slashed.
  * @param {number} minimumSlashingFee - The minimum fee for the transaction in satoshis.
  * @param {networks.Network} network - The Bitcoin network.
@@ -458,7 +445,7 @@ export function slashEarlyUnbondedTransaction(
     unbondingTimelockScript: Buffer;
   },
   unbondingTx: Transaction,
-  slashingAddress: string,
+  slashingPkScriptHex: string,
   slashingRate: number,
   minimumSlashingFee: number,
   network: networks.Network,
@@ -478,7 +465,7 @@ export function slashEarlyUnbondedTransaction(
     },
     unbondingScriptTree,
     unbondingTx,
-    slashingAddress,
+    slashingPkScriptHex,
     slashingRate,
     minimumSlashingFee,
     network,
@@ -492,24 +479,13 @@ export function slashEarlyUnbondedTransaction(
  * This transaction spends the staking output of the staking transaction and distributes the funds
  * according to the specified slashing rate.
  *
- * Outputs:
+ * Transaction outputs:
  * - The first output sends `input * slashing_rate` funds to the slashing address.
  * - The second output sends `input * (1 - slashing_rate) - fee` funds back to the user's address.
  *
- * Inputs:
- * - scripts: Scripts used to construct the taproot output.
- *   - slashingScript: Script for the slashing condition.
- *   - unbondingTimelockScript: Script for the unbonding timelock condition.
- * - transaction: The original staking/unbonding transaction.
- * - slashingAddress: The address to send the slashed funds to.
- * - slashingRate: The rate at which the funds are slashed (0 < slashingRate < 1).
- * - minimumFee: The minimum fee for the transaction in satoshis.
- * - network: The Bitcoin network.
- * - outputIndex: The index of the output to be spent in the original transaction (default is 0).
- *
  * @param {Object} scripts - The scripts used in the transaction. e.g slashingScript, unbondingTimelockScript
  * @param {Transaction} transaction - The original staking/unbonding transaction.
- * @param {string} slashingAddress - The address to send the slashed funds to.
+ * @param {string} slashingPkScriptHex - The public key script to send the slashed funds to.
  * @param {number} slashingRate - The rate at which the funds are slashed. Two decimal places, otherwise it will be rounded down.
  * @param {number} minimumFee - The minimum fee for the transaction in satoshis.
  * @param {networks.Network} network - The Bitcoin network.
@@ -523,7 +499,7 @@ function slashingTransaction(
   },
   scriptTree: Taptree,
   transaction: Transaction,
-  slashingAddress: string,
+  slashingPkScriptHex: string,
   slashingRate: number,
   minimumFee: number,
   network: networks.Network,
@@ -601,7 +577,7 @@ function slashingTransaction(
 
   // Add the slashing output
   psbt.addOutput({
-    address: slashingAddress,
+    script: Buffer.from(slashingPkScriptHex, "hex"),
     value: slashingAmount,
   });
 

diff --git a/src/types/params.ts b/src/types/params.ts
@@ -8,7 +8,7 @@ export interface StakingParams {
   maxStakingTimeBlocks: number;
   minStakingTimeBlocks: number;
   slashing?: {
-    slashingPkScript: string;
+    slashingPkScriptHex: string;
     slashingRate: number;
     minSlashingTxFeeSat: number;
   }

diff --git a/src/utils/btc.ts b/src/utils/btc.ts
@@ -104,21 +104,3 @@ const validateNoCoordPublicKeyBuffer = (pkBuffer: Buffer): boolean => {
     ecc.isPoint(compressedKeyEven) || ecc.isPoint(compressedKeyOdd)
   );
 };
-
-/**
- * Derive the Bitcoin address from the public key script.
- * 
- * @param {string} scriptPubKey - The public key script in hex.
- * @param {networks.Network} network - The Bitcoin network (e.g., bitcoin.networks.bitcoin).
- * 
- * @returns {string} - The Bitcoin address.
- * @throws {Error} - If the address cannot be derived from the public key script.
- */
-export const deriveAddressFromPkScript = (scriptPubKey: string, network: networks.Network): string => {
-  try {
-    const scriptPubKeyBuffer = Buffer.from(scriptPubKey, "hex");
-    return address.fromOutputScript(scriptPubKeyBuffer, network);  
-  } catch (error) {
-    throw new Error(`Failed to derive address from public key script: ${error}`);
-  }
-};