Skip to content

Commit

Permalink
Add more context about redeemer in tBTC redemption data
Browse files Browse the repository at this point in the history
  • Loading branch information
nkuba committed Apr 8, 2024
1 parent 06b5426 commit 5e23302
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions core/contracts/BitcoinRedeemer.sol
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,10 @@ contract BitcoinRedeemer is Ownable2StepUpgradeable, IReceiveApproval {
/// It is a scenario that is unlikely to happen with the current Bridge
/// setup. This contract remains upgradable to have flexibility to handle
/// adjustments to tBTC Bridge changes.
/// @dev Redemption data should include a `redeemer` address matching the
/// address of the staker who is redeeming the shares. In case anything
/// goes wrong during the tBTC unminting process, the redeemer will be
/// able to claim the tBTC tokens back from the tBTC Bank contract.
/// @param owner The owner of the stBTC tokens.
/// @param shares The number of stBTC tokens to redeem.
/// @param tbtcRedemptionData Additional data required for the tBTC redemption.
Expand Down

0 comments on commit 5e23302

Please sign in to comment.