Skip to content

Commit

Permalink
Add missing docs comments
Browse files Browse the repository at this point in the history
  • Loading branch information
r-czajkowski committed Jul 11, 2023
1 parent 9776847 commit ed3e3c4
Showing 1 changed file with 29 additions and 0 deletions.
29 changes: 29 additions & 0 deletions src/threshold-ts/tbtc/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -329,18 +329,47 @@ export interface ITBTC {
redeemerOutputScript: string
): string

/**
* Gets the full transaction object for given transaction hash.
* @param transactionHash Hash of the transaction.
* @returns Transaction object.
*/
getBitcoinTransaction(transactionHash: string): Promise<BitcoinTransaction>

/**
* Gets emitted `RedemptionRequested` events.
* @param filter Filters to find emitted events by indexed params and block
* range.
* @returns Redemption requests filtered by filter params.
*/
getRedemptionRequestedEvents(
filter: RedemptionRequestedEventFilter
): Promise<RedemptionRequestedEvent[]>

/**
* Gets the redemption details from the on-chain contract by the redemption
* key. It also determines if redemption is pending or timed out.
* @param redemptionKey The redemption key.
* @returns Promise with the redemption details.
*/
getRedemptionRequest(redemptionKey: string): Promise<RedemptionRequest>

/**
* Gets emitted `RedemptionTimedOut` events.
* @param filter Filters to find emitted events by indexed params and block
* range.
* @returns Redemption timed out events filtered by filter params.
*/
getRedemptionTimedOutEvents(
filter: RedemptionTimedOutEventFilter
): Promise<RedemptionTimedOutEvent[]>

/**
* Gets emitted `RedemptionsCompleted` events.
* @param filter Filters to find emitted events by indexed params and block
* range.
* @returns Redemptions completed events filtered by filter params.
*/
getRedemptionsCompletedEvents(
filter: RedemptionsCompletedEventFilter
): Promise<RedemptionsCompletedEvent[]>
Expand Down

0 comments on commit ed3e3c4

Please sign in to comment.