Added description and renamed function

keep-network · Sep 29, 2023 · 17f4917 · 17f4917
1 parent c1d3f0f
commit 17f4917
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 12 deletions.
diff --git a/typescript/src/redemption.ts b/typescript/src/redemption.ts
@@ -155,7 +155,7 @@ export async function submitRedemptionTransaction(
   const bitcoinNetwork = await bitcoinClient.getNetwork()
 
   const { transactionHash, newMainUtxo, rawTransaction } =
-    await assembleRedemptionTransactionBitcoinJsLib(
+    await assembleRedemptionTransaction(
       bitcoinNetwork,
       walletPrivateKey,
       mainUtxoWithRaw,
@@ -239,8 +239,30 @@ async function getWalletRedemptionRequests(
   return redemptionRequests
 }
 
-// TODO: Description.
-export async function assembleRedemptionTransactionBitcoinJsLib(
+/**
+ * Assembles a Bitcoin redemption transaction.
+ * The transaction will have a single input (main UTXO of the wallet making
+ * the redemption), an output for each redemption request provided, and a change
+ * output if the redemption requests do not consume the entire amount of the
+ * single input.
+ * @dev The caller is responsible for ensuring the redemption request list is
+ *      correctly formed:
+ *        - there is at least one redemption
+ *        - the `requestedAmount` in each redemption request is greater than
+ *          the sum of its `txFee` and `treasuryFee`
+ * @param bitcoinNetwork - The target Bitcoin network (mainnet or testnet).
+ * @param walletPrivateKey - The private key of the wallet in the WIF format
+ * @param mainUtxo - The main UTXO of the wallet. Must match the main UTXO held
+ *        by the on-chain Bridge contract
+ * @param redemptionRequests - The list of redemption requests
+ * @param witness - The parameter used to decide the type of the change output.
+ *        P2WPKH if `true`, P2PKH if `false`
+ * @returns The outcome consisting of:
+ *          - the redemption transaction hash,
+ *          - the optional new wallet's main UTXO produced by this transaction.
+ *          - the redemption transaction in the raw format
+ */
+export async function assembleRedemptionTransaction(
   bitcoinNetwork: BitcoinNetwork,
   walletPrivateKey: string,
   mainUtxo: UnspentTransactionOutput & RawTransaction,

diff --git a/typescript/test/redemption.test.ts b/typescript/test/redemption.test.ts
@@ -23,7 +23,7 @@ import {
   findWalletForRedemptionData,
 } from "./data/redemption"
 import {
-  assembleRedemptionTransactionBitcoinJsLib,
+  assembleRedemptionTransaction,
   findWalletForRedemption,
   getRedemptionRequest,
   RedemptionRequest,
@@ -494,7 +494,7 @@ describe("Redemption", () => {
                     transactionHash,
                     newMainUtxo,
                     rawTransaction: transaction,
-                  } = await assembleRedemptionTransactionBitcoinJsLib(
+                  } = await assembleRedemptionTransaction(
                     BitcoinNetwork.Testnet,
                     walletPrivateKey,
                     data.mainUtxo,
@@ -608,7 +608,7 @@ describe("Redemption", () => {
                     transactionHash,
                     newMainUtxo,
                     rawTransaction: transaction,
-                  } = await assembleRedemptionTransactionBitcoinJsLib(
+                  } = await assembleRedemptionTransaction(
                     BitcoinNetwork.Testnet,
                     walletPrivateKey,
                     data.mainUtxo,
@@ -721,7 +721,7 @@ describe("Redemption", () => {
                     transactionHash,
                     newMainUtxo,
                     rawTransaction: transaction,
-                  } = await assembleRedemptionTransactionBitcoinJsLib(
+                  } = await assembleRedemptionTransaction(
                     BitcoinNetwork.Testnet,
                     walletPrivateKey,
                     data.mainUtxo,
@@ -834,7 +834,7 @@ describe("Redemption", () => {
                     transactionHash,
                     newMainUtxo,
                     rawTransaction: transaction,
-                  } = await assembleRedemptionTransactionBitcoinJsLib(
+                  } = await assembleRedemptionTransaction(
                     BitcoinNetwork.Testnet,
                     walletPrivateKey,
                     data.mainUtxo,
@@ -946,7 +946,7 @@ describe("Redemption", () => {
                 transactionHash,
                 newMainUtxo,
                 rawTransaction: transaction,
-              } = await assembleRedemptionTransactionBitcoinJsLib(
+              } = await assembleRedemptionTransaction(
                 BitcoinNetwork.Testnet,
                 walletPrivateKey,
                 data.mainUtxo,
@@ -1104,7 +1104,7 @@ describe("Redemption", () => {
               transactionHash,
               newMainUtxo,
               rawTransaction: transaction,
-            } = await assembleRedemptionTransactionBitcoinJsLib(
+            } = await assembleRedemptionTransaction(
               BitcoinNetwork.Testnet,
               walletPrivateKey,
               data.mainUtxo,
@@ -1211,7 +1211,7 @@ describe("Redemption", () => {
             transactionHash,
             newMainUtxo,
             rawTransaction: transaction,
-          } = await assembleRedemptionTransactionBitcoinJsLib(
+          } = await assembleRedemptionTransaction(
             BitcoinNetwork.Testnet,
             walletPrivateKey,
             data.mainUtxo,
@@ -1301,7 +1301,7 @@ describe("Redemption", () => {
 
       it("should revert", async () => {
         await expect(
-          assembleRedemptionTransactionBitcoinJsLib(
+          assembleRedemptionTransaction(
             BitcoinNetwork.Testnet,
             walletPrivateKey,
             data.mainUtxo,