[DEPLOY-295]: Refactors L2EP Contracts #11758
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…ses, and refactors test cases by using a L2EPTest helper
…erUptimeFeed test cases, adds ScrollCrossDomainForwarder skeleton
…st case grouping and more comments
…o ScrollCrossDomainForwarder helper function
…ndry import path for Example test
…rs script for L2EP, updates README
|
I see that you haven't updated any CHANGELOG files. Would it make sense to do so? |
chris-de-leon-cll
dismissed stale reviews from mohamed-mehany and RensR
via
ab8757e
|
I see you updated files related to |
chris-de-leon-cll
requested review from
archseer,
bolekk,
patrick-dowell and
a team
as code owners
chris-de-leon-cll
removed request for
a team,
archseer,
bolekk and
patrick-dowell
|
|
Closing this as it appears to be stale. Feel free to re-open if it's still needed. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
L2EP currently requires 4 Solidity smart contracts to be developed and deployed on the target chain. These contracts are:
CrossDomainForwarderCrossDomainGovernorSequencerUptimeFeedValidatorEach of these contracts share an almost identical implementation per chain. In fact, the code between Scroll and Optimism is nearly identical and by extension contains a lot of duplication. This current trajectory will be unsustainable to maintain as we expand L2EP to other chains.
Overview
This PR refactors the L2EP Solidity contracts such that:
Methodology
Instead of each chain having to define separate Validator, Governor, Forwarder, and Sequencer contracts with nearly identical code, this PR adds an abstract class for each of them. These abstract classes contain the functionality that is shared/duplicated for each chain. The result is that all shared code now exists in a centralized location making it easier to reuse and debug while cutting down on the size of existing contracts. Each chain will still need its own Validator, Governor, etc. contracts, but unlike before, they can now inherit from their corresponding abstract contracts and override methods as needed to account for any chain-specific differences. The effect: code that is specific to a particular chain now lives in the folder belonging to that chain.
This PR maintains full backwards compatibility with the existing L2EP design. Additionally, these new changes do not introduce any extra deployment steps. However, gas consumption is not the same. Some methods have experienced an increase in gas usage whereas others have experienced a decline. The gas snapshot included in the PR can be used to view the differences.
Summary of Notable Changes
CrossDomainForwader.solCrossDomainGovernor.solSequencerUptimeFeed.solGasLimitValidator.sol(needed for Optimism and Scroll, but not Arbitrum)Validator.solAdditional Note(s)