[DEPLOY-512]: Adds L2EP Foundry Tests

[chris-de-leon-cll]

Overview

• This PR adds Foundry test cases for the L2EP contracts (previously we were relying on Hardhat tests)
• This PR is one of a few related to the L2EP modernization effort - the effort consists of the following components:
  • Migrate old L2EP hardhat tests to Foundry tests
  • Refactor the L2EP contracts such that:
    • They comply with the style guide
    • They are more extensible to other chains
    • They include the gas optimizations and other QoL improvements made for Scroll

Important Note(s)

• The Foundry tests have been written such that they test the same scenarios as the Hardhat tests - the intention behind this was to reduce overhead and avoid having to reinvent the wheel
• The Scroll and Optimism Foundry tests are almost identical - the only changes include the imports and contract names. Arbitrum is slightly different, and the test cases are not identical to Scroll and Optimism
• If we expect future L2EP solutions will be similar to that of Scroll and Optimism, we may want to consider revising the these test cases such that we don't need to copy-paste the same code each time we integrate a new chain
• The Hardhat testing suite included some test scenarios that manually measured gas usage. These have also been migrated to Foundry, but they might be unnecessary since Foundry already collects gas usage metrics. Any clarity on whether we should still include gas measuring tests in Foundry would be much appreciated!

Primary Change(s)

Here's a breakdown of some of the primary changes included in this PR:

• Adds Foundry configs for L2EP
• Adds ScrollValidator test
• Adds ScrollSequencerUptimeFeed test
• Adds ScrollCrossDomainGovernor test
• Adds ScrollCrossDomainForwarder test
• Adds OptimismValidator test
• Adds OptimismSequencerUptimeFeed test
• Adds OptimismCrossDomainGovernor test
• Adds OptimismCrossDomainForwarder test
• Adds ArbitrumValidator test
• Adds ArbitrtumSequencerUptimeFeed test
• Adds ArbitrumDomainGovernor test
• Adds ArbitrumDomainForwarder test
• Adds additional testing mocks
• Adds documentation (see the README.md file in contracts/src/v0.8/l2ep/README.md)
• Ensures Foundry tests comply with style guide

[github-actions]

I see that you haven't updated any CHANGELOG files. Would it make sense to do so?

[RensR]

You probably want to add l2ep to the Foundry-using-projects list at the top of contracts/GNUmakefile and in CI .github/workflows/solidity-foundry.yml line 35. This will make CI run your new tests. You should also create a snapshot with

make snapshot

with export FOUNDRY_PROFILE=l2ep set. With that set you can run make snapshot and make wrappers for just l2ep, so it's very quick.

[RensR]

I think we can also move this one, just like the stranger

[RensR]

Deployer address also seems to be useful in the higher level one

[cl-sonarqube-production]

SonarQube Quality Gate

0 Bugs
0 Vulnerabilities
0 Security Hotspots
0 Code Smells

No Coverage information
0.0% Duplication