Skip to content
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

Feat/teleporter custom calldata #1

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Feat/teleporter custom calldata #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9a5a304
Feat: Upgrade Teleporter to call arbitrary data on L3
Jun 14, 2024
079d559
add only onlycustomfee check
godzillaba Jun 14, 2024
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
8 changes: 7 additions & 1 deletion contracts/L1Teleporter.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,8 @@ contract L1Teleporter is Pausable, AccessControl, L2ForwarderPredictor, IL1Telep
to: params.to,
gasLimit: params.gasParams.l2l3TokenBridgeGasLimit,
gasPriceBid: params.gasParams.l3GasPriceBid,
maxSubmissionCost: maxSubmissionCost
maxSubmissionCost: maxSubmissionCost,
l3Calldata: params.l3Calldata
});
}

Expand All @@ -142,6 +143,11 @@ contract L1Teleporter is Pausable, AccessControl, L2ForwarderPredictor, IL1Telep
// all teleportation types require at least these 2 retryables to L2
ethAmount = costs.l1l2TokenBridgeCost + costs.l2ForwarderFactoryCost;

// OnlyCustomFee is the only type that supports L3 calldata
if (teleportationType != TeleportationType.OnlyCustomFee && params.l3Calldata.length > 0) {
revert L3CalldataNotAllowedForType(teleportationType);
}

// in addition to the above ETH amount, more fee token and/or ETH is required depending on the teleportation type
if (teleportationType == TeleportationType.Standard) {
// standard type requires 1 retryable to L3 paid for in ETH
Expand Down
2 changes: 1 addition & 1 deletion contracts/L2Forwarder.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ contract L2Forwarder is IL2Forwarder {
gasLimit: params.gasLimit,
maxFeePerGas: params.gasPriceBid,
tokenTotalFeeAmount: tokenBalance,
data: ""
data: params.l3Calldata
});

emit BridgedToL3(callValue, totalFeeAmount);
Expand Down
4 changes: 4 additions & 0 deletions contracts/interfaces/IL1Teleporter.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ interface IL1Teleporter is IL2ForwarderPredictor {
/// @param to L3 address that will receive the tokens
/// @param amount Amount of tokens being teleported
/// @param gasParams Gas parameters for each retryable ticket
/// @param l3Calldata Calldata for the L2ForwarderFactory call on L2 to L3 retryable
struct TeleportParams {
address l1Token;
address l3FeeTokenL1Addr;
Expand All @@ -26,6 +27,7 @@ interface IL1Teleporter is IL2ForwarderPredictor {
address to;
uint256 amount;
RetryableGasParams gasParams;
bytes l3Calldata;
}

/// @notice Gas parameters for each retryable ticket.
Expand Down Expand Up @@ -74,6 +76,8 @@ interface IL1Teleporter is IL2ForwarderPredictor {
error InsufficientFeeToken(uint256 required, uint256 provided);
/// @notice Thrown when the SKIP_FEE_TOKEN magic is passed for l3FeeTokenL1Addr and at least one fee token related gas parameter is nonzero
error NonZeroFeeTokenAmount();
/// @notice Thrown when there is non empty l3Calldata but the teleportation type is not OnlyCustomFee
error L3CalldataNotAllowedForType(TeleportationType teleportationType);

/// @notice Start an L1 -> L3 transfer. msg.value sent must equal the total ETH cost of all retryables.
/// Call `determineTypeAndFees` to calculate the total cost of retryables in ETH and the L3's fee token.
Expand Down
2 changes: 2 additions & 0 deletions contracts/interfaces/IL2Forwarder.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ interface IL2Forwarder {
/// @param gasLimit Gas limit for the L2 -> L3 retryable
/// @param gasPriceBid Gas price for the L2 -> L3 retryable
/// @param maxSubmissionCost Max submission fee for the L2 -> L3 retryable. Is ignored for Standard and OnlyCustomFee teleportation types.
/// @param l3Calldata Calldata for the L2ForwarderFactory call on L2 to L3 retryable
struct L2ForwarderParams {
address owner;
address l2Token;
Expand All @@ -26,6 +27,7 @@ interface IL2Forwarder {
uint256 gasLimit;
uint256 gasPriceBid;
uint256 maxSubmissionCost;
bytes l3Calldata;
}

/// @notice Emitted after a successful call to rescue
Expand Down
15 changes: 10 additions & 5 deletions test/L2Forwarder.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,8 @@ contract L2ForwarderTest is BaseTest {
to: l3Recipient,
gasLimit: gasLimit,
gasPriceBid: gasPriceBid,
maxSubmissionCost: 0
maxSubmissionCost: 0,
l3Calldata: ""
});

// simulate A1 and B1 (bridging TOKEN to L2)
Expand Down Expand Up @@ -133,7 +134,8 @@ contract L2ForwarderTest is BaseTest {
to: l3Recipient,
gasLimit: gasLimit,
gasPriceBid: gasPriceBid,
maxSubmissionCost: 0
maxSubmissionCost: 0,
l3Calldata: ""
});

// simulate A1 and B1 (bridging TOKEN to L2)
Expand Down Expand Up @@ -202,7 +204,8 @@ contract L2ForwarderTest is BaseTest {
to: l3Recipient,
gasLimit: gasLimit,
gasPriceBid: gasPriceBid,
maxSubmissionCost: expectedSubmissionCost
maxSubmissionCost: expectedSubmissionCost,
l3Calldata: ""
});

// simulate ETH refunds from A1, A2, B1, B2
Expand Down Expand Up @@ -288,7 +291,8 @@ contract L2ForwarderTest is BaseTest {
to: l3Recipient,
gasLimit: gasLimitA,
gasPriceBid: gasPriceBidA,
maxSubmissionCost: expectedSubmissionCostA
maxSubmissionCost: expectedSubmissionCostA,
l3Calldata: ""
});

// skip simulating ETH refunds from A1, A2, B1
Expand Down Expand Up @@ -319,7 +323,8 @@ contract L2ForwarderTest is BaseTest {
to: l3Recipient,
gasLimit: gasLimitB,
gasPriceBid: gasPriceBidB,
maxSubmissionCost: expectedSubmissionCostB
maxSubmissionCost: expectedSubmissionCostB,
l3Calldata: ""
});
_expectNonFeeTokenToCustomFeeEvents(paramsB, tokenAmountB);
vm.prank(aliasedL1Teleporter);
Expand Down
27 changes: 18 additions & 9 deletions test/Teleporter.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,8 @@ contract L1TeleporterTest is BaseTest {
l2l3RouterOrInbox: l2l3RouterOrInbox,
to: address(1),
amount: 10,
gasParams: gasParams
gasParams: gasParams,
l3Calldata: ""
});
(
uint256 standardEth,
Expand Down Expand Up @@ -254,7 +255,8 @@ contract L1TeleporterTest is BaseTest {
l1l2FeeTokenBridgeMaxSubmissionCost: 8,
l1l2TokenBridgeMaxSubmissionCost: 9,
l2l3TokenBridgeMaxSubmissionCost: 10
})
}),
l3Calldata: ""
});
(
uint256 standardEth,
Expand All @@ -281,7 +283,8 @@ contract L1TeleporterTest is BaseTest {
l2l3RouterOrInbox: l2l3RouterOrInbox,
to: address(1),
amount: 10,
gasParams: gasParams
gasParams: gasParams,
l3Calldata: ""
});
(
uint256 feeTokenEth,
Expand All @@ -303,7 +306,8 @@ contract L1TeleporterTest is BaseTest {
l2l3RouterOrInbox: l2l3RouterOrInbox,
to: address(1),
amount: 10,
gasParams: gasParams
gasParams: gasParams,
l3Calldata: ""
});
(
uint256 feeTokenEth2,
Expand All @@ -328,7 +332,8 @@ contract L1TeleporterTest is BaseTest {
l2l3RouterOrInbox: l2l3RouterOrInbox,
to: address(1),
amount: 10,
gasParams: gasParams
gasParams: gasParams,
l3Calldata: ""
});
skipFeeTokenParams.gasParams.l3GasPriceBid = 0;
skipFeeTokenParams.gasParams.l2l3TokenBridgeGasLimit = 0;
Expand Down Expand Up @@ -389,7 +394,8 @@ contract L1TeleporterTest is BaseTest {
l2l3RouterOrInbox: l2l3RouterOrInbox,
to: receiver,
amount: amount,
gasParams: gasParams
gasParams: gasParams,
l3Calldata: ""
});

(uint256 requiredEth,,, IL1Teleporter.RetryableGasCosts memory retryableCosts) =
Expand Down Expand Up @@ -440,7 +446,8 @@ contract L1TeleporterTest is BaseTest {
l2l3RouterOrInbox: l2l3RouterOrInbox,
to: receiver,
amount: amount,
gasParams: gasParams
gasParams: gasParams,
l3Calldata: ""
});

(uint256 requiredEth, uint256 requiredFeeTokenAmount,, IL1Teleporter.RetryableGasCosts memory retryableCosts) =
Expand Down Expand Up @@ -498,7 +505,8 @@ contract L1TeleporterTest is BaseTest {
l2l3RouterOrInbox: l2l3RouterOrInbox,
to: receiver,
amount: amount,
gasParams: gasParams
gasParams: gasParams,
l3Calldata: ""
});

(uint256 requiredEth, uint256 requiredFeeTokenAmount,, IL1Teleporter.RetryableGasCosts memory retryableCosts) =
Expand Down Expand Up @@ -566,7 +574,8 @@ contract L1TeleporterTest is BaseTest {
l2l3RouterOrInbox: l2l3RouterOrInbox,
to: receiver,
amount: amount,
gasParams: gasParams
gasParams: gasParams,
l3Calldata: ""
});

(uint256 requiredEth,,, IL1Teleporter.RetryableGasCosts memory retryableCosts) =
Expand Down