Skip to content

Latest commit

 

History

History
53 lines (30 loc) · 1.44 KB

RedeemerProxy.md

File metadata and controls

53 lines (30 loc) · 1.44 KB

Interface: RedeemerProxy

Interface defining functions required to route tBTC redemption requests through the tBTC bridge by custom integrators.

Table of contents

Methods

Methods

redeemerAddress

redeemerAddress(): ChainIdentifier

Chain identifier of the redeemer. This is the address that will be able to claim the tBTC tokens if anything goes wrong during the redemption process.

Returns

ChainIdentifier

Defined in

src/services/redemptions/redeemer-proxy.ts:13


requestRedemption

requestRedemption(redemptionData): Promise<Hex>

Requests redemption of tBTC token with determined redemption data.

Parameters

Name Type Description
redemptionData Hex Data required to redeem the tBTC tokens.

Returns

Promise<Hex>

Target chain hash of the request redemption transaction (for example, Ethereum transaction hash)

Defined in

src/services/redemptions/redeemer-proxy.ts:21