Skip to content

Commit

Permalink
use mapping for tokens in bridges
Browse files Browse the repository at this point in the history
  • Loading branch information
@kovalgek
kovalgek committed Apr 15, 2024
1 parent 0545e33 commit a55b5f0
Show file tree
Hide file tree
Showing 4 changed files with 242 additions and 259 deletions.
215 changes: 79 additions & 136 deletions contracts/optimism/L1ERC20ExtendedTokensBridge.sol
View file
Original file line number Diff line number Diff line change
@@ -1,20 +1,18 @@
// SPDX-FileCopyrightText: 2022 Lido <info@lido.fi>
// SPDX-FileCopyrightText: 2024 Lido <info@lido.fi>
// SPDX-License-Identifier: GPL-3.0

pragma solidity 0.8.10;

import {IERC20} from "@openzeppelin/contracts/token/ERC20/IERC20.sol";
import {Address} from "@openzeppelin/contracts/utils/Address.sol";
import {SafeERC20} from "@openzeppelin/contracts/token/ERC20/utils/SafeERC20.sol";

import {IL1ERC20Bridge} from "./interfaces/IL1ERC20Bridge.sol";
import {IL2ERC20Bridge} from "./interfaces/IL2ERC20Bridge.sol";
import {IERC20Wrapper} from "../token/interfaces/IERC20Wrapper.sol";
import {BridgingManager} from "../BridgingManager.sol";
import {RebasableAndNonRebasableTokens} from "./RebasableAndNonRebasableTokens.sol";
import {CrossDomainEnabled} from "./CrossDomainEnabled.sol";
import {DepositDataCodec} from "./DepositDataCodec.sol";
import {IERC20WstETH} from "../token/interfaces/IERC20WstETH.sol";
import {DepositDataCodec} from "../lib//DepositDataCodec.sol";

/// @author psirex, kovalgek
/// @notice The L1 ERC20 token bridge locks bridged tokens on the L1 side, sends deposit messages
Expand All @@ -24,12 +22,11 @@ abstract contract L1ERC20ExtendedTokensBridge is
IL1ERC20Bridge,
BridgingManager,
RebasableAndNonRebasableTokens,
CrossDomainEnabled,
DepositDataCodec
CrossDomainEnabled
{
using SafeERC20 for IERC20;

address public immutable L2_TOKEN_BRIDGE;
address private immutable L2_TOKEN_BRIDGE;

/// @param messenger_ L1 messenger address being used for cross-chain communications
/// @param l2TokenBridge_ Address of the corresponding L2 bridge
Expand All @@ -53,8 +50,24 @@ abstract contract L1ERC20ExtendedTokensBridge is
L2_TOKEN_BRIDGE = l2TokenBridge_;
}

function initialize2(
address admin_,
address l1TokenNonRebasable_,
address l1TokenRebasable_,
address l2TokenNonRebasable_,
address l2TokenRebasable_
) external {
BridgingManager.initialize(admin_);
RebasableAndNonRebasableTokens.initialize(
l1TokenNonRebasable_,
l1TokenRebasable_,
l2TokenNonRebasable_,
l2TokenRebasable_
);
}

/// @notice required to abstact a way token rate is requested.
function tokenRate() virtual internal view returns (uint256);
function tokenRate(address l1NonRebasableToken) virtual internal view returns (uint256);

/// @inheritdoc IL1ERC20Bridge
function l2TokenBridge() external view returns (address) {
Expand All @@ -71,14 +84,19 @@ abstract contract L1ERC20ExtendedTokensBridge is
)
external
whenDepositsEnabled
onlySupportedL1Token(l1Token_)
onlySupportedL2Token(l2Token_)
onlySupportedL1L2TokensPair(l1Token_, l2Token_)
{
if (Address.isContract(msg.sender)) {
revert ErrorSenderNotEOA();
}

_depositERC20To(l1Token_, l2Token_, msg.sender, amount_, l2Gas_, data_);
uint256 rate = tokenRate(_l1NonRebasableToken(l1Token_));
bytes memory encodedDepositData = DepositDataCodec.encodeDepositData(DepositDataCodec.DepositData({
rate: uint96(rate),
timestamp: uint40(block.timestamp),
data: data_
}));
_depositERC20To(l1Token_, l2Token_, msg.sender, msg.sender, amount_, l2Gas_, data_);
emit ERC20DepositInitiated(l1Token_, l2Token_, msg.sender, msg.sender, amount_, encodedDepositData);
}

/// @inheritdoc IL1ERC20Bridge
Expand All @@ -93,10 +111,18 @@ abstract contract L1ERC20ExtendedTokensBridge is
external
whenDepositsEnabled
onlyNonZeroAccount(to_)
onlySupportedL1Token(l1Token_)
onlySupportedL2Token(l2Token_)
// onlySupportedL1Token(l1Token_)
// onlySupportedL2Token(l2Token_)
onlySupportedL1L2TokensPair(l1Token_, l2Token_)
{
_depositERC20To(l1Token_, l2Token_, to_, amount_, l2Gas_, data_);
uint256 rate = tokenRate(_l1NonRebasableToken(l1Token_));
bytes memory encodedDepositData = DepositDataCodec.encodeDepositData(DepositDataCodec.DepositData({
rate: uint96(rate),
timestamp: uint40(block.timestamp),
data: data_
}));
_depositERC20To(l1Token_, l2Token_, msg.sender, to_, amount_, l2Gas_, encodedDepositData);
emit ERC20DepositInitiated(l1Token_, l2Token_, msg.sender, to_, amount_, encodedDepositData);
}

/// @inheritdoc IL1ERC20Bridge
Expand All @@ -110,154 +136,71 @@ abstract contract L1ERC20ExtendedTokensBridge is
)
external
whenWithdrawalsEnabled
onlySupportedL1Token(l1Token_)
onlySupportedL2Token(l2Token_)
onlySupportedL1L2TokensPair(l1Token_, l2Token_)
onlyFromCrossDomainAccount(L2_TOKEN_BRIDGE)
{
if (_isRebasableTokenFlow(l1Token_, l2Token_)) {
uint256 rebasableTokenAmount = IERC20Wrapper(L1_TOKEN_NON_REBASABLE).unwrap(amount_);
IERC20(L1_TOKEN_REBASABLE).safeTransfer(to_, rebasableTokenAmount);

emit ERC20WithdrawalFinalized(
L1_TOKEN_REBASABLE,
L2_TOKEN_REBASABLE,
from_,
to_,
rebasableTokenAmount,
data_
);
} else if (_isNonRebasableTokenFlow(l1Token_, l2Token_)) {
IERC20(L1_TOKEN_NON_REBASABLE).safeTransfer(to_, amount_);

emit ERC20WithdrawalFinalized(
L1_TOKEN_NON_REBASABLE,
L2_TOKEN_NON_REBASABLE,
from_,
to_,
amount_,
data_
);
}
}

function _depositERC20To(
address l1Token_,
address l2Token_,
address to_,
uint256 amount_,
uint32 l2Gas_,
bytes memory data_
) internal {
if (_isRebasableTokenFlow(l1Token_, l2Token_)) {
DepositData memory depositData = DepositData({
rate: uint96(tokenRate()),
timestamp: uint40(block.timestamp),
data: data_
});
bytes memory encodedDepositData = encodeDepositData(depositData);

if (amount_ == 0) {
_initiateERC20Deposit(
L1_TOKEN_REBASABLE,
L2_TOKEN_REBASABLE,
msg.sender,
to_,
0,
l2Gas_,
encodedDepositData
);

emit ERC20DepositInitiated(
L1_TOKEN_REBASABLE,
L2_TOKEN_REBASABLE,
msg.sender,
to_,
0,
encodedDepositData
);

return;
}

IERC20(L1_TOKEN_REBASABLE).safeTransferFrom(msg.sender, address(this), amount_);
if(!IERC20(L1_TOKEN_REBASABLE).approve(L1_TOKEN_NON_REBASABLE, amount_)) {
revert ErrorRebasableTokenApprove();
}
uint256 nonRebasableTokenAmount = IERC20Wrapper(L1_TOKEN_NON_REBASABLE).wrap(amount_);

_initiateERC20Deposit(
L1_TOKEN_REBASABLE,
L2_TOKEN_REBASABLE,
msg.sender,
to_,
nonRebasableTokenAmount,
l2Gas_,
encodedDepositData
);

emit ERC20DepositInitiated(
L1_TOKEN_REBASABLE,
L2_TOKEN_REBASABLE,
msg.sender,
to_,
amount_,
encodedDepositData
);
} else if (_isNonRebasableTokenFlow(l1Token_, l2Token_)) {
IERC20(L1_TOKEN_NON_REBASABLE).safeTransferFrom(msg.sender, address(this), amount_);

_initiateERC20Deposit(
L1_TOKEN_NON_REBASABLE,
L2_TOKEN_NON_REBASABLE,
msg.sender,
to_,
amount_,
l2Gas_,
data_
);

emit ERC20DepositInitiated(
L1_TOKEN_NON_REBASABLE,
L2_TOKEN_NON_REBASABLE,
msg.sender,
to_,
amount_,
data_
);
if(_isRebasable(l1Token_)) {
address l1NonRebasableToken = _getRebasableTokens()[l1Token_].pairedToken;
uint256 rebasableTokenAmount = IERC20Wrapper(l1NonRebasableToken).unwrap(amount_);
IERC20(l1Token_).safeTransfer(to_, rebasableTokenAmount);
emit ERC20WithdrawalFinalized(l1Token_, l2Token_, from_, to_, rebasableTokenAmount, data_);
} else {
IERC20(l1Token_).safeTransfer(to_, amount_);
emit ERC20WithdrawalFinalized(l1Token_, l2Token_, from_, to_, amount_, data_);
}
}

/// @dev Performs the logic for deposits by informing the L2 token bridge contract
/// of the deposit and calling safeTransferFrom to lock the L1 funds.

/// @param l1Token_ Address of the L1 ERC20 we are depositing
/// @param l2Token_ Address of the L1 respective L2 ERC20
/// @param from_ Account to pull the deposit from on L1
/// @param to_ Account to give the deposit to on L2
/// @param amount_ Amount of the ERC20 to deposit.
/// @param l2Gas_ Gas limit required to complete the deposit on L2.
/// @param data_ Optional data to forward to L2. This data is provided

/// @param encodedDepositData_ Optional data to forward to L2. This data is provided
/// solely as a convenience for external contracts. Aside from enforcing a maximum
/// length, these contracts provide no guarantees about its content.
function _initiateERC20Deposit(
function _depositERC20To(
address l1Token_,
address l2Token_,
address from_,
address to_,
uint256 amount_,
uint32 l2Gas_,
bytes memory data_
bytes memory encodedDepositData_
) internal {
uint256 amountToDeposit = _transferToBridge(l1Token_, from_, amount_);

bytes memory message = abi.encodeWithSelector(
IL2ERC20Bridge.finalizeDeposit.selector,
l1Token_,
l2Token_,
from_,
to_,
amount_,
data_
l1Token_, l2Token_, from_, to_, amountToDeposit, encodedDepositData_
);

sendCrossDomainMessage(L2_TOKEN_BRIDGE, l2Gas_, message);
}

function _transferToBridge(
address l1Token_,
address from_,
uint256 amount_
) internal returns (uint256) {

if (amount_ == 0) {
return amount_;
}

IERC20(l1Token_).safeTransferFrom(from_, address(this), amount_);
if(_isRebasable(l1Token_)) {
address l1NonRebasableToken = _getRebasableTokens()[l1Token_].pairedToken;
if(!IERC20(l1Token_).approve(l1NonRebasableToken, amount_)) revert ErrorRebasableTokenApprove();
return IERC20Wrapper(l1NonRebasableToken).wrap(amount_);
}
return amount_;
}

error ErrorSenderNotEOA();
error ErrorRebasableTokenApprove();
}
4 changes: 2 additions & 2 deletions contracts/optimism/L1LidoTokensBridge.sol
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ contract L1LidoTokensBridge is L1ERC20ExtendedTokensBridge {
) {
}

function tokenRate() override internal view returns (uint256) {
return IERC20WstETH(L1_TOKEN_NON_REBASABLE).stEthPerToken();
function tokenRate(address l1NonRebasableToken) override internal view returns (uint256) {
return IERC20WstETH(l1NonRebasableToken).stEthPerToken();
}
}
Loading

0 comments on commit a55b5f0

Please sign in to comment.