Skip to content

Commit

Permalink
Updated docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
tomaszslabon committed Oct 3, 2023
1 parent ba335fb commit ac2f64d
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions typescript/src/deposit.ts
Original file line number Diff line number Diff line change
Expand Up @@ -187,9 +187,6 @@ export async function submitDepositTransaction(

/**
* Assembles a Bitcoin P2(W)SH deposit transaction.
* @dev UTXOs are selected for transaction funding based on their types. UTXOs
* with unsupported types are skipped. The selection process stops once
* the sum of the chosen UTXOs meets the required funding amount.
* @param bitcoinNetwork - The target Bitcoin network (mainnet or testnet).
* @param deposit - Details of the deposit.
* @param depositorPrivateKey - Bitcoin private key of the depositor.
Expand All @@ -202,6 +199,9 @@ export async function submitDepositTransaction(
* - the deposit transaction hash,
* - the deposit UTXO produced by this transaction.
* - the deposit transaction in the raw format
* @dev UTXOs are selected for transaction funding based on their types. UTXOs

Check failure on line 202 in typescript/src/deposit.ts

View workflow job for this annotation

GitHub Actions / typescript-format

Insert `·`
* with unsupported types are skipped. The selection process stops once
* the sum of the chosen UTXOs meets the required funding amount.
* @throws {Error} When the sum of the selected UTXOs is insufficient to cover
* the deposit amount and transaction fee.
*/
Expand Down

0 comments on commit ac2f64d

Please sign in to comment.