feat: foundry refactor

.githooks/pre-commit

@@ -6,39 +6,38 @@ if npm run lint; then
     npx hardhat compile --force
     npm run docgen
     git add docs
-    cp artifacts/contracts/PolygonZkEVMBridge.sol/PolygonZkEVMBridge.json compiled-contracts/
-    cp artifacts/contracts/PolygonZkEVMGlobalExitRoot.sol/PolygonZkEVMGlobalExitRoot.json compiled-contracts/
-    cp artifacts/contracts/PolygonZkEVMGlobalExitRootL2.sol/PolygonZkEVMGlobalExitRootL2.json compiled-contracts/
+    cp artifacts/contracts/outdated/PolygonZkEVMBridge.sol/PolygonZkEVMBridge.json compiled-contracts/
+    cp artifacts/contracts/outdated/PolygonZkEVMGlobalExitRoot.sol/PolygonZkEVMGlobalExitRoot.json compiled-contracts/
+    cp artifacts/contracts/outdated/PolygonZkEVMGlobalExitRootL2.sol/PolygonZkEVMGlobalExitRootL2.json compiled-contracts/
     cp artifacts/contracts/lib/TokenWrapped.sol/TokenWrapped.json compiled-contracts/
-    cp artifacts/contracts/mocks/PolygonZkEVMBridgeMock.sol/PolygonZkEVMBridgeMock.json compiled-contracts/
+    cp artifacts/contracts/outdated/mocks/PolygonZkEVMBridgeMock.sol/PolygonZkEVMBridgeMock.json compiled-contracts/
     cp artifacts/contracts/mocks/ERC20PermitMock.sol/ERC20PermitMock.json compiled-contracts/
-    cp artifacts/contracts/mocks/PolygonZkEVMGlobalExitRootL2Mock.sol/PolygonZkEVMGlobalExitRootL2Mock.json compiled-contracts/
-    cp artifacts/contracts/mocks/PolygonZkEVMGlobalExitRootMock.sol/PolygonZkEVMGlobalExitRootMock.json compiled-contracts/
-    cp artifacts/contracts/mocks/PolygonZkEVMMock.sol/PolygonZkEVMMock.json compiled-contracts/
+    cp artifacts/contracts/outdated/mocks/PolygonZkEVMGlobalExitRootL2Mock.sol/PolygonZkEVMGlobalExitRootL2Mock.json compiled-contracts/
+    cp artifacts/contracts/outdated/mocks/PolygonZkEVMGlobalExitRootMock.sol/PolygonZkEVMGlobalExitRootMock.json compiled-contracts/
+    cp artifacts/contracts/outdated/mocks/PolygonZkEVMMock.sol/PolygonZkEVMMock.json compiled-contracts/
     cp artifacts/contracts/mocks/VerifierRollupHelperMock.sol/VerifierRollupHelperMock.json compiled-contracts/
-    cp artifacts/contracts/PolygonZkEVM.sol/PolygonZkEVM.json compiled-contracts/
+    cp artifacts/contracts/outdated/PolygonZkEVM.sol/PolygonZkEVM.json compiled-contracts/
     cp artifacts/contracts/verifiers/FflonkVerifier.sol/FflonkVerifier.json compiled-contracts/
     cp artifacts/@openzeppelin/contracts/proxy/transparent/ProxyAdmin.sol/ProxyAdmin.json compiled-contracts/
     cp artifacts/@openzeppelin/contracts/proxy/transparent/TransparentUpgradeableProxy.sol/TransparentUpgradeableProxy.json compiled-contracts/
     cp artifacts/contracts/deployment/PolygonZkEVMDeployer.sol/PolygonZkEVMDeployer.json compiled-contracts/
     cp artifacts/contracts/PolygonZkEVMTimelock.sol/PolygonZkEVMTimelock.json compiled-contracts/
 
-    cp artifacts/contracts/v2/PolygonRollupManager.sol/PolygonRollupManager.json compiled-contracts/
-    cp artifacts/contracts/v2/mocks/PolygonRollupManagerMock.sol/PolygonRollupManagerMock.json compiled-contracts/
-    cp artifacts/contracts/v2/mocks/PolygonRollupManagerMockInternalTest.sol/PolygonRollupManagerMockInternalTest.json compiled-contracts/
+    cp artifacts/contracts/PolygonRollupManager.sol/PolygonRollupManager.json compiled-contracts/
+    cp artifacts/contracts/mocks/PolygonRollupManagerMock.sol/PolygonRollupManagerMock.json compiled-contracts/
+    cp artifacts/contracts/mocks/PolygonRollupManagerMockInternalTest.sol/PolygonRollupManagerMockInternalTest.json compiled-contracts/
 
-    cp artifacts/contracts/v2/PolygonZkEVMBridgeV2.sol/PolygonZkEVMBridgeV2.json compiled-contracts/
-    cp artifacts/contracts/v2/PolygonZkEVMGlobalExitRootV2.sol/PolygonZkEVMGlobalExitRootV2.json compiled-contracts/
+    cp artifacts/contracts/PolygonZkEVMBridgeV2.sol/PolygonZkEVMBridgeV2.json compiled-contracts/
+    cp artifacts/contracts/PolygonZkEVMGlobalExitRootV2.sol/PolygonZkEVMGlobalExitRootV2.json compiled-contracts/
 
-    cp artifacts/contracts/v2/PolygonZkEVMGlobalExitRootV2.sol/PolygonZkEVMGlobalExitRootV2.json compiled-contracts/
-    cp artifacts/contracts/v2/consensus/zkEVM/PolygonZkEVMEtrog.sol/PolygonZkEVMEtrog.json compiled-contracts/
-    cp artifacts/contracts/v2/consensus/zkEVM/PolygonZkEVMExistentEtrog.sol/PolygonZkEVMExistentEtrog.json compiled-contracts/
-    cp artifacts/contracts/v2/previousVersions/PolygonZkEVMEtrogPrevious.sol/PolygonZkEVMEtrogPrevious.json compiled-contracts/
+    cp artifacts/contracts/consensus/zkEVM/PolygonZkEVMEtrog.sol/PolygonZkEVMEtrog.json compiled-contracts/
+    cp artifacts/contracts/consensus/zkEVM/PolygonZkEVMExistentEtrog.sol/PolygonZkEVMExistentEtrog.json compiled-contracts/
+    cp artifacts/contracts/previousVersions/PolygonZkEVMEtrogPrevious.sol/PolygonZkEVMEtrogPrevious.json compiled-contracts/
 
-    cp artifacts/contracts/v2/consensus/validium/PolygonValidiumEtrog.sol/PolygonValidiumEtrog.json compiled-contracts/
-    cp artifacts/contracts/v2/consensus/validium/PolygonDataCommittee.sol/PolygonDataCommittee.json compiled-contracts/
+    cp artifacts/contracts/consensus/validium/PolygonValidiumEtrog.sol/PolygonValidiumEtrog.json compiled-contracts/
+    cp artifacts/contracts/consensus/validium/PolygonDataCommittee.sol/PolygonDataCommittee.json compiled-contracts/
 
-    cp artifacts/contracts/v2/utils/ClaimCompressor.sol/ClaimCompressor.json compiled-contracts/
+    cp artifacts/contracts/utils/ClaimCompressor.sol/ClaimCompressor.json compiled-contracts/
 
     git add compiled-contracts
     exit 0

.github/workflows/test.yml

@@ -0,0 +1,41 @@
+name: Foundry CI
+
+on:
+  push:
+      branches: [main, develop]
+  pull_request:
+      branches: [main, develop]
+
+env:
+  FOUNDRY_PROFILE: ci
+
+jobs:
+  check:
+    strategy:
+      fail-fast: true
+
+    name: Build and Test
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly
+
+      - name: Install NPM dependencies
+        run: npm ci
+
+      - name: Run Forge build
+        run: |
+          forge --version
+          forge build
+        id: build
+
+      - name: Run Forge tests
+        run: |
+          forge test -vvv
+        id: test

.gitignore

@@ -22,3 +22,22 @@ typechain-types/
 create_rollup_parameters.json
 
 docker/deploymentOutput
+
+# From foundry-template:
+
+/target
+/out
+/cache
+/coverage
+lcov.info
+.DS_Store
+.env
+.vscode
+.password
+
+broadcast/*/31337
+deployments/**/31337.*
+
+# storage layout checker library
+storage_check_cache
+storage_check_report

.gitmodules

@@ -0,0 +1,9 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/deployer-kit"]
+	path = lib/deployer-kit
+	url = https://github.com/0xPolygon/deployer-kit
+[submodule "lib/solmate"]
+	path = lib/solmate
+	url = https://github.com/transmissions11/solmate

.nvmrc

@@ -0,0 +1 @@
+18

contracts/v2/PolygonZkEVMBridgeV2.sol → contracts-ignored-originals/PolygonZkEVMBridgeV2.sol

@@ -2,15 +2,15 @@
 
 pragma solidity 0.8.20;
 
-import "./lib/DepositContractV2.sol";
-import "@openzeppelin/contracts-upgradeable/token/ERC20/utils/SafeERC20Upgradeable.sol";
+import "contracts/interfaces/IBasePolygonZkEVMGlobalExitRoot.sol";
+import "contracts/interfaces/IBridgeMessageReceiver.sol";
+import "contracts/interfaces/IPolygonZkEVMBridgeV2.sol";
+import "contracts/lib/DepositContractV2.sol";
+import "contracts/lib/EmergencyManager.sol";
+import "contracts/lib/GlobalExitRootLib.sol";
+import "contracts/lib/TokenWrapped.sol";
 import "@openzeppelin/contracts-upgradeable/token/ERC20/extensions/IERC20MetadataUpgradeable.sol";
-import "../lib/TokenWrapped.sol";
-import "../interfaces/IBasePolygonZkEVMGlobalExitRoot.sol";
-import "../interfaces/IBridgeMessageReceiver.sol";
-import "./interfaces/IPolygonZkEVMBridgeV2.sol";
-import "../lib/EmergencyManager.sol";
-import "../lib/GlobalExitRootLib.sol";
+import "@openzeppelin/contracts-upgradeable/token/ERC20/utils/SafeERC20Upgradeable.sol";
 
 /**
  * PolygonZkEVMBridge that will be deployed on Ethereum and all Polygon rollups

contracts/v2/PolygonRollupManager.sol → contracts/PolygonRollupManager.sol

@@ -4,10 +4,10 @@ pragma solidity 0.8.20;
 
 import "./interfaces/IPolygonRollupManager.sol";
 import "./interfaces/IPolygonZkEVMGlobalExitRootV2.sol";
-import "../interfaces/IPolygonZkEVMBridge.sol";
+import "./interfaces/IPolygonZkEVMBridge.sol";
 import "./interfaces/IPolygonRollupBase.sol";
-import "../interfaces/IVerifierRollup.sol";
-import "../lib/EmergencyManager.sol";
+import "./interfaces/IVerifierRollup.sol";
+import "./lib/EmergencyManager.sol";
 import "@openzeppelin/contracts-upgradeable/token/ERC20/utils/SafeERC20Upgradeable.sol";
 import "./lib/PolygonTransparentProxy.sol";
 import "./lib/PolygonAccessControlUpgradeable.sol";

contracts/v2/PolygonZkEVMGlobalExitRootV2.sol → contracts/PolygonZkEVMGlobalExitRootV2.sol

@@ -4,7 +4,7 @@ pragma solidity 0.8.20;
 
 import "./interfaces/IPolygonZkEVMGlobalExitRootV2.sol";
 import "./lib/PolygonZkEVMGlobalExitRootBaseStorage.sol";
-import "../lib/GlobalExitRootLib.sol";
+import "./lib/GlobalExitRootLib.sol";
 import "./lib/DepositContractBase.sol";
 import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
 

contracts/PolygonZkEVMTimelock.sol

@@ -2,7 +2,7 @@
 pragma solidity 0.8.20;
 
 import "@openzeppelin/contracts/governance/TimelockController.sol";
-import "./PolygonZkEVM.sol";
+import "./outdated/PolygonZkEVM.sol";
 
 /**
  * @dev Contract module which acts as a timelocked controller.

contracts/v2/interfaces/IPolygonZkEVMBridgeV2.sol → contracts/interfaces/IPolygonZkEVMBridgeV2.sol

@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: AGPL-3.0
 
 pragma solidity ^0.8.20;
-import "../../interfaces/IBasePolygonZkEVMGlobalExitRoot.sol";
+import "./IBasePolygonZkEVMGlobalExitRoot.sol";
 
 interface IPolygonZkEVMBridgeV2 {
     /**