Skip to content

ENG-515: add rescue bank feat #920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
RobertoMSousa wants to merge 1 commit into
base: main
Choose a base branch
from
Open

ENG-515: add rescue bank feat #920

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 37 additions & 0 deletions solidity/contracts/cross-chain/wormhole/L1BTCRedeemerWormhole.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,8 @@ contract L1BTCRedeemerWormhole is
error CallerNotOwner();
error SourceAddressNotAuthorized();
error WormholeTokenBridgeAlreadySet();
error RecoveryAddressNotSet();
error RecipientNotRecoveryAddress();

/// @notice Reference to the Wormhole Token Bridge contract.
IWormholeTokenBridge public wormholeTokenBridge;
Expand All @@ -70,6 +72,10 @@ contract L1BTCRedeemerWormhole is
/// in Wormhole format (bytes32).
mapping(bytes32 => bool) public allowedSenders;

/// @notice Address that receives rescued Bank balances (e.g. a recovery/ops address)
/// used to return funds for failed cross-chain redemptions.
address public recoveryAddress;

event RedemptionRequested(
uint256 indexed redemptionKey,
bytes20 indexed walletPubKeyHash,
Expand All @@ -87,6 +93,10 @@ contract L1BTCRedeemerWormhole is

event AllowedSenderUpdated(bytes32 indexed sender, bool allowed);

event RecoveryAddressUpdated(address indexed recoveryAddress);

event BankBalanceRescued(address indexed recipient, uint256 amount);

/// @dev This modifier comes from the `Reimbursable` base contract and
/// must be overridden to protect the `updateReimbursementPool` call.
modifier onlyReimbursableAdmin() override {
Expand Down Expand Up @@ -165,6 +175,33 @@ contract L1BTCRedeemerWormhole is
emit AllowedSenderUpdated(_sender, _allowed);
}

/// @notice Updates the recovery address used by `rescueBankBalance`.
/// @dev Can be called only by the contract owner.
/// @param _recoveryAddress New recovery address.
function setRecoveryAddress(address _recoveryAddress) external onlyOwner {
if (_recoveryAddress == address(0)) revert ZeroAddress();

recoveryAddress = _recoveryAddress;
emit RecoveryAddressUpdated(_recoveryAddress);
}

/// @notice Transfers this contract's Bank balance to the configured recovery address.
/// @dev Can be called only by the contract owner.
/// This is intended to recover funds returned to this contract as part of
/// failed cross-chain redemption flows.
/// @param recipient Must match the configured `recoveryAddress`.
/// @param amount Amount of Bank balance to transfer.
function rescueBankBalance(address recipient, uint256 amount)
external
onlyOwner
{
if (recoveryAddress == address(0)) revert RecoveryAddressNotSet();
if (recipient != recoveryAddress) revert RecipientNotRecoveryAddress();

bank.transferBalance(recipient, amount);
emit BankBalanceRescued(recipient, amount);
}

/// @notice Initiates a redemption on L1 using tBTC received from another chain (e.g., L2)
/// via a Wormhole VAA. The tBTC is then used to request a Bitcoin redemption
/// from the main tBTC Bridge.
Expand Down
Loading