Initial changes + ffi workflow

.eslintrc

@@ -11,6 +11,7 @@
     "no-console": "off"
   },
   "ignorePatterns": [
-    "**/lib/*"
+    "**/lib/*",
+    "lib/*"
   ]
 }

.github/workflows/l1-contracts-ci.yaml

@@ -3,6 +3,11 @@ name: L1 contracts CI
 on:
   pull_request:
 
+# We need this permissions for this CI to work with external contributions
+permissions:
+  contents: read
+  pull-requests: write
+
 jobs:
   build:
     runs-on: ubuntu-latest
@@ -145,3 +150,73 @@ jobs:
 
       - name: Compare
         run: diff tools/data/Verifier.sol l1-contracts/contracts/state-transition/Verifier.sol
+
+  coverage:
+    defaults:
+      run:
+        working-directory: l1-contracts
+    needs: [build, lint]
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Use Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.18.0
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn
+
+      - name: Restore artifacts cache
+        uses: actions/cache/restore@v3
+        with:
+          fail-on-cache-miss: true
+          key: artifacts-l1-${{ github.sha }}
+          path: |
+            l1-contracts/artifacts
+            l1-contracts/cache
+            l1-contracts/typechain
+
+      - name: Run coverage
+        run: FOUNDRY_PROFILE=default yarn test:foundry && FOUNDRY_PROFILE=default yarn coverage:foundry --report summary --report lcov
+
+      # To ignore coverage for certain directories modify the paths in this step as needed. The
+      # below default ignores coverage results for the test and script directories. Alternatively,
+      # to include coverage in all directories, comment out this step. Note that because this
+      # filtering applies to the lcov file, the summary table generated in the previous step will
+      # still include all files and directories.
+      # The `--rc lcov_branch_coverage=1` part keeps branch info in the filtered report, since lcov
+      # defaults to removing branch info.
+      - name: Filter directories
+        run: |
+          sudo apt update && sudo apt install -y lcov
+          lcov --remove lcov.info 'test/*' 'contracts/dev-contracts/*' '../lib/forge-std/*' '../lib/murky/*' 'lib/*' '../lib/*' 'lib/' --output-file lcov.info --rc lcov_branch_coverage=1
+
+      # This step posts a detailed coverage report as a comment and deletes previous comments on
+      # each push. The below step is used to fail coverage if the specified coverage threshold is
+      # not met. The below step can post a comment (when it's `github-token` is specified) but it's
+      # not as useful, and this action cannot fail CI based on a minimum coverage threshold, which
+      # is why we use both in this way.
+      - name: Post coverage report
+        if: github.event_name == 'pull_request' # This action fails when ran outside of a pull request.
+        uses: romeovs/lcov-reporter-action@v0.3.1
+        with:
+          delete-old-comments: true
+          lcov-file: ./l1-contracts/lcov.info
+          github-token: ${{ secrets.GITHUB_TOKEN }} # Adds a coverage summary comment to the PR.
+
+      - name: Verify minimum coverage
+        uses: zgosalvez/github-actions-report-lcov@v2
+        with:
+          coverage-files: ./l1-contracts/lcov.info
+          working-directory: l1-contracts
+          minimum-coverage: 85 # Set coverage threshold.

.github/workflows/l1-contracts-foundry-ci.yaml → .github/workflows/l1-deploy-scripts-ci.yaml

@@ -1,4 +1,4 @@
-name: L1 contracts foundry CI
+name: L1 Deploy Scripts Tests CI
 
 env:
   ANVIL_PRIVATE_KEY: "0xac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80"
@@ -38,7 +38,7 @@ jobs:
       - name: Create cache
         uses: actions/cache/save@v3
         with:
-          key: artifacts-l1-contracts-foudry-${{ github.sha }}
+          key: artifacts-l1-contracts-foundry-${{ github.sha }}
           path: |
             l1-contracts/cache
             l1-contracts/out
@@ -61,7 +61,7 @@ jobs:
         uses: actions/cache/restore@v3
         with:
           fail-on-cache-miss: true
-          key: artifacts-l1-contracts-foudry-${{ github.sha }}
+          key: artifacts-l1-contracts-foundry-${{ github.sha }}
           path: |
             l1-contracts/cache
             l1-contracts/out
@@ -99,19 +99,37 @@ jobs:
             exit 1
           fi
 
-      - name: Run DeployL1 script
-        working-directory: ./l1-contracts
-        run: forge script ./deploy-scripts/DeployL1.s.sol --ffi --rpc-url $ANVIL_RPC_URL --broadcast --private-key $ANVIL_PRIVATE_KEY
+  test-ffi:
+    needs: [build]
+    runs-on: ubuntu-latest
 
-      - name: Run DeployErc20 script
-        working-directory: ./l1-contracts
-        run: forge script ./deploy-scripts/DeployErc20.s.sol --ffi --rpc-url $ANVIL_RPC_URL --broadcast --private-key $ANVIL_PRIVATE_KEY
-# TODO restore scripts verification
-#      - name: Run RegisterHyperchain script
-#        working-directory: ./l1-contracts
-#        run: |
-#          cat ./script-out/output-deploy-l1.toml >> ./script-config/register-hyperchain.toml
-#          forge script ./deploy-scripts/RegisterHyperchain.s.sol --ffi --rpc-url $ANVIL_RPC_URL --broadcast --private-key $ANVIL_PRIVATE_KEY
-#      - name: Run InitializeL2WethToken script
-#        working-directory: ./l1-contracts-foundry
-#        run: forge script ./deploy-scripts/InitializeL2WethToken.s.sol --ffi --rpc-url $ANVIL_RPC_URL --broadcast --private-key $ANVIL_PRIVATE_KEY
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Use Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.18.0
+          cache: yarn
+
+      - name: Install dependencies
+        run: yarn
+
+      - name: Restore artifacts cache
+        uses: actions/cache/restore@v3
+        with:
+          fail-on-cache-miss: true
+          key: artifacts-l1-${{ github.sha }}
+          path: |
+            l1-contracts/artifacts
+            l1-contracts/cache
+            l1-contracts/typechain
+
+      - name: Run tests
+        run: yarn l1 test:ffi

.gitignore

@@ -24,5 +24,9 @@ l1-contracts/coverage/*
 l1-contracts/out/*
 l1-contracts/broadcast/*
 l1-contracts/script-config/*
+!l1-contracts/script-config/artifacts
 l1-contracts/script-out/*
 !l1-contracts/script-out/.gitkeep
+*.timestamp
+l1-contracts/test/foundry/l1/integration/deploy-scripts/script-out/*
+l1-contracts/zkout/*

.gitmodules

@@ -1,14 +1,14 @@
-[submodule "l1-contracts/lib/forge-std"]
-	path = l1-contracts/lib/forge-std
-	url = https://github.com/foundry-rs/forge-std
-[submodule "l1-contracts/lib/murky"]
-	path = l1-contracts/lib/murky
+[submodule "lib/murky"]
+	path = lib/murky
 	url = https://github.com/dmfxyz/murky
-[submodule "l1-contracts/lib/openzeppelin-contracts-upgradeable"]
-	path = l1-contracts/lib/openzeppelin-contracts-upgradeable
+[submodule "lib/openzeppelin-contracts-upgradeable-v4"]
+	path = lib/openzeppelin-contracts-upgradeable-v4
 	url = https://github.com/Openzeppelin/openzeppelin-contracts-upgradeable
 	branch = release-v4.9
-[submodule "l1-contracts/lib/openzeppelin-contracts"]
-	path = l1-contracts/lib/openzeppelin-contracts
+[submodule "lib/openzeppelin-contracts-v4"]
+	path = lib/openzeppelin-contracts-v4
 	url = https://github.com/Openzeppelin/openzeppelin-contracts
 	branch = release-v4.9
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std

.markdownlintignore

@@ -2,7 +2,6 @@
 node_modules
 
 # l1-contracts
-l1-contracts/lib
 l1-contracts/node_modules
 
 # l1-contracts-foundry
@@ -14,3 +13,8 @@ l2-contracts/node_modules
 # system-contracts
 system-contracts/node_modules
 system-contracts/bootloader/test_infra/target
+
+l1-contracts/lib
+lib/
+l2-contracts/lib
+system-contracts/lib

.prettierignore

@@ -1,6 +1,7 @@
 tools/data
 l1-contracts/lib
 l1-contracts-foundry/lib
+lib
 system-contracts/contracts/openzeppelin
 system-contracts/contracts/Constants.sol
 system-contracts/artifacts-zk
@@ -10,3 +11,6 @@ l1-contracts/cache
 l1-contracts/cache-forge
 l1-contracts/artifacts
 l1-contracts/artifacts-forge
+l1-contracts/zkout
+l2-contracts/zkout
+system-contracts/zkout

.solhint.json

@@ -1,31 +1,40 @@
 {
   "extends": "solhint:recommended",
   "rules": {
-    "state-visibility": "off",
-    "func-visibility": ["warn", { "ignoreConstructors": true }],
-    "var-name-mixedcase": "off",
-    "avoid-call-value": "off",
-    "no-empty-blocks": "off",
-    "not-rely-on-time": "off",
+    "avoid-call-value": "error",
     "avoid-low-level-calls": "off",
-    "no-inline-assembly": "off",
+    "avoid-sha3": "error",
+    "check-send-result": "error",
+    "compiler-version": ["error", "^0.8.0"],
     "const-name-snakecase": "off",
-    "no-complex-fallback": "off",
-    "reason-string": "off",
+    "contract-name-camelcase": "off",
+    "gas-calldata-parameters": "error",
+    "gas-custom-errors": "error",
+    "gas-increment-by-one": "error",
+    "gas-length-in-loops": "error",
+    "gas-struct-packing": "error",
+    "explicit-types": "error",
     "func-name-mixedcase": "off",
-    "custom-errors": "off",
-    "no-unused-vars": "error",
+    "func-named-parameters": ["error", 4],
+    "func-visibility": ["error", { "ignoreConstructors": true }],
+    "imports-on-top": "error",
     "max-states-count": "off",
+    "modifier-name-mixedcase": "error",
+    "named-parameters-mapping": "off",
+    "no-complex-fallback": "off",
+    "no-console": "error",
+    "no-empty-blocks": "off",
     "no-global-import": "error",
+    "no-inline-assembly": "off",
     "no-unused-import": "error",
-    "explicit-types": "error",
-    "modifier-name-mixedcase": "error",
-    "imports-on-top": "error",
+    "no-unused-vars": "error",
+    "not-rely-on-time": "off",
     "quotes": "error",
-    "use-forbidden-name": "error",
-    "visibility-modifier-order": "error",
+    "reason-string": "error",
     "reentrancy": "error",
-    "func-named-parameters": ["error", 4],
-    "compiler-version": ["error", "^0.8.0"]
+    "state-visibility": "error",
+    "use-forbidden-name": "error",
+    "var-name-mixedcase": "off",
+    "visibility-modifier-order": "error"
   }
 }

.solhintignore

@@ -6,6 +6,9 @@ l1-contracts/cache
 l1-contracts/cache-forge
 l1-contracts/lib
 l1-contracts/node_modules
+l1-contracts/contracts/dev-contracts
+l1-contracts/test
+l1-contracts/deploy-scripts
 
 # l1-contracts-foundry
 l1-contracts-foundry/cache
@@ -18,3 +21,12 @@ l2-contracts/node_modules
 # system-contracts
 system-contracts/contracts/openzeppelin
 system-contracts/contracts/Constants.sol
+system-contracts/contracts/test-contracts
+system-contracts/contracts-preprocessed
+
+# gas-bound-caller
+gas-bound-caller
+
+lib/*
+l2-contracts/lib
+system-contracts/lib

CODEOWNERS

@@ -1 +1,3 @@
 * @vladbochok @StanislavBreadless
+l1-contracts/deploy-scripts @Deniallugo
+l1-contracts/deploy-script-config-template @Deniallugo

CONTRIBUTING.md

@@ -34,7 +34,7 @@ We aim to make it as easy as possible to contribute to the mission. This is stil
 and suggestions here too. Some resources to help:
 
 1. [In-repo docs aimed at developers](docs)
-2. [zkSync Era docs!](https://era.zksync.io/docs/)
+2. [ZKsync Era docs!](https://era.zksync.io/docs/)
 3. Company links can be found in the [repo's readme](README.md)
 
 ## Code of Conduct

README.md

@@ -1,13 +1,13 @@
-# zkSync Era: Smart Contracts
+# ZKsync Era: Smart Contracts
 
 [![Logo](eraLogo.svg)](https://zksync.io/)
 
-zkSync Era is a layer 2 rollup that uses zero-knowledge proofs to scale Ethereum without compromising on security or
+ZKsync Era is a layer 2 rollup that uses zero-knowledge proofs to scale Ethereum without compromising on security or
 decentralization. Since it's EVM compatible (Solidity/Vyper), 99% of Ethereum projects can redeploy without refactoring
-or re-auditing a single line of code. zkSync Era also uses an LLVM-based compiler that will eventually let developers
+or re-auditing a single line of code. ZKsync Era also uses an LLVM-based compiler that will eventually let developers
 write smart contracts in C++, Rust and other popular languages.
 
-This repository contains both L1 and L2 zkSync smart contracts. For their description see the
+This repository contains both L1 and L2 ZKsync smart contracts. For their description see the
 [system overview](docs/Overview.md).
 
 ## Disclaimer
@@ -17,7 +17,7 @@ others may not.
 
 ## License
 
-zkSync Era contracts are distributed under the terms of the MIT license.
+ZKsync Era contracts are distributed under the terms of the MIT license.
 
 See [LICENSE-MIT](LICENSE-MIT) for details.
 
@@ -33,7 +33,7 @@ See [LICENSE-MIT](LICENSE-MIT) for details.
 
 ## Disclaimer
 
-zkSync Era has been through lots of testing and audits. Although it is live, it is still in alpha state and will go
+ZKsync Era has been through lots of testing and audits. Although it is live, it is still in alpha state and will go
 through more audits and bug bounties programs. We would love to hear our community's thoughts and suggestions about it!
 It is important to state that forking it now can potentially lead to missing important security updates, critical
 features, and performance improvements.

_typos.toml

@@ -5,6 +5,7 @@ extend-exclude = [
     "/l1-contracts/out/",
     "/l1-contracts/node_modules/",
     "/l1-contracts/artifacts",
+    "/l1-contracts-foundry/lib/",
     "/l2-contracts/artifacts-zk",
     "/l2-contracts/cache-zk",
     "/l2-contracts/typechain",