Revamp tooling (#83)

* build: move deps to node_modules

* build: bump solidity version

* chore: update foundry.toml

* docs: update README.md

.github/workflows/test.yml

@@ -14,49 +14,98 @@ jobs:
   actions:
     uses: lidofinance/linters/.github/workflows/actions.yml@master
 
+  # Maybe to make it reusable workflow instead?
+  bootstrap:
+    name: Bootstrap environment
+    runs-on: ubuntu-latest
+    outputs:
+      cache-path: ${{ steps.cache.outputs.path }}
+      cache-key: ${{ steps.cache.outputs.key }}
+    env:
+      FORGE_REV: d58ab7f
+      JUST_TAG: 1.24.0
+    steps:
+      - name: Build cache params
+        id: cache
+        run: |
+          echo "path=$CACHE_PATH" >> "$GITHUB_OUTPUT"
+          echo "$KEY_INPUT" | md5sum | awk '{print $1}' | xargs -I% echo "key=cargobin-%-${RUNNER_OS}" >> "$GITHUB_OUTPUT"
+        env:
+          CACHE_PATH: |
+            ~/.cargo/bin/
+          KEY_INPUT: |
+            forge:${FORGE_REV}
+            just:${JUST_TAG}
+
+      - uses: actions/cache@v3
+        id: get-cache
+        with:
+          path: ${{ steps.cache.outputs.path }}
+          key: ${{ steps.cache.outputs.key }}
+
+      - name: Install just
+        run: cargo install "just@$JUST_TAG"
+        if: steps.get-cache.outputs.cache-hit != 'true'
+
+      - name: Install forge
+        run: cargo install --git https://github.com/foundry-rs/foundry --rev "$FORGE_REV" --profile local forge
+        if: steps.get-cache.outputs.cache-hit != 'true'
+
   linters:
     name: Linters
     runs-on: ubuntu-latest
+    needs: bootstrap
     steps:
       - uses: actions/checkout@v3
         with:
-          submodules: recursive
           persist-credentials: false
 
+      - uses: actions/cache@v3
+        with:
+          path: ${{ needs.bootstrap.outputs.cache-path }}
+          key: ${{ needs.bootstrap.outputs.cache-key }}
+
       - name: Install node
         uses: actions/setup-node@v3
         with:
           node-version-file: ".nvmrc"
           cache: yarn
           cache-dependency-path: "**/yarn.lock"
 
-      - name: Install Node dependencies
-        run: yarn install --immutable
+      - name: Install dependencies
+        run: just deps
 
       - name: Linters check
-        run: yarn lint:check
+        run: just lint
 
   foundry:
     name: Foundry project
     runs-on: ubuntu-latest
+    needs: bootstrap
     steps:
       - uses: actions/checkout@v3
         with:
-          submodules: recursive
           persist-credentials: false
 
-      - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@v1
+      - uses: actions/cache@v3
         with:
-          version: nightly
+          path: ${{ needs.bootstrap.outputs.cache-path }}
+          key: ${{ needs.bootstrap.outputs.cache-key }}
 
-      - name: Run Forge build
-        run: |
-          forge --version
-          forge build --sizes
+      - name: Install node
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: ".nvmrc"
+          cache: yarn
+          cache-dependency-path: "**/yarn.lock"
 
-      - name: Run Forge tests
-        run: |
-          forge test -vvv
+      - name: Install dependencies
+        run: just deps
+
+      - name: Build
+        run: just build --sizes
+
+      - name: Run tests
+        run: just test
         env:
           RPC_URL: ${{ secrets.RPC_URL }}

.gitmodules

@@ -1,9 +0,0 @@
-[submodule "lib/forge-std"]
-	path = lib/forge-std
-	url = https://github.com/foundry-rs/forge-std
-[submodule "lib/openzeppelin-contracts-v4.4"]
-	path = lib/openzeppelin-contracts-v4.4
-	url = https://github.com/OpenZeppelin/openzeppelin-contracts
-[submodule "lib/openzeppelin-contracts"]
-	path = lib/openzeppelin-contracts
-	url = https://github.com/OpenZeppelin/openzeppelin-contracts

.solhint.json

@@ -2,7 +2,7 @@
   "extends": "solhint:recommended",
   "plugins": ["lido-csm"],
   "rules": {
-    "compiler-version": ["error", "0.8.21"],
+    "compiler-version": ["error", "0.8.24"],
     "no-inline-assembly": "off",
     "no-unused-import": "error",
     "func-named-parameters": "error",

Justfile

@@ -14,24 +14,27 @@ deploy_script_path := if chain == "mainnet" {
 anvil_host := env_var_or_default("ANVIL_IP_ADDR", "127.0.0.1")
 anvil_port := "8545"
 
-default: clean build test-all
+default: clean deps build test-all
 
-build:
-	forge build --force
+build *args:
+	forge build --force {{args}}
 
 clean:
 	forge clean
-	rm -rf cache broadcast out
+	rm -rf cache broadcast out node_modules
+
+deps:
+	yarn install --immutable
 
 lint-solhint:
 	yarn lint:solhint
 
-lint-check:
-	yarn lint:check
-
 lint-fix:
 	yarn lint:fix
 
+lint:
+	yarn lint:check
+
 test-all:
 	just test-unit &
 	just test-integration

README.md

@@ -7,10 +7,12 @@
 
 - Install [Foundry tools](https://book.getfoundry.sh/getting-started/installation)
 
+- Install [Just](https://github.com/casey/just)
+
 - Install project dependencies
 
 ```bash
-forge install
+just deps
 ```
 
 - Config environment variables
@@ -21,35 +23,44 @@ cp .env.sample .env
 
 Fill vars in the `.env` file with your own values
 
+- Build and test contracts
+
+```bash
+just
+```
+
 ### Features
 
 - Run tests
 
 ```bash
-make test # run all tests
-make test-unit
-make test-inegration
+just test # run all tests
+# or run specific tests
+just test-unit
+just test-inegration
 ```
 
-- Install libraries
+- Install dependencies
+
+Dependencies are managed using yarn. To install new dependencies, run:
 
 ```bash
-forge install rari-capital/solmate
+yarn add <package-name>
 ```
 
 - Deploy to local fork
 
 ```bash
-make deploy-local
+just deploy-local
 ```
 
 - Deploy to local fork of non-mainnet chain
 
 ```bash
-CHAIN=holesky make deploy-local
+CHAIN=holesky just deploy-local
 ```
 
 ### Notes
 
-Whenever you install new libraries using Foundry, make sure to update your
-`remappings.txt` file by running `forge remappings > remappings.txt`
+Whenever you install new libraries using yarn, make sure to update your
+`remappings.txt`.

foundry.toml

@@ -1,17 +1,25 @@
 [profile.default]
+solc = "0.8.24"
+evm_version = "cancun"
+optimizer = true
+optimizer_runs = 1_000
+bytecode_hash = "none" # The metadata hash removed from the bytecode (not the metadata itself).
+
 src = "src"
 out = "out"
-libs = ["lib"]
+libs = ["lib", "node_modules"]
 cache_path  = "cache"
-optimizer = true
-optimizer_runs = 1_000
-evm_version = "shanghai"
+
 block_gas_limit = 30_000_000
-fs_permissions = [{ access = "write", path = "./out" }, { access = "read", path = "./test/fixtures" }]
+fuzz = { runs = 256 }
+
+fs_permissions = [
+    { access = "write", path = "./out" },
+    { access = "read", path = "./test/fixtures" }
+]
 
-[fmt]
-line_length = 80
-tab_width = 4
-bracket_spacing = true
+[profile.ci]
+verbosity = 3
+fuzz = { runs = 10_000 }
 
-# See more config options https://github.com/foundry-rs/foundry/tree/master/config
+# See more config options https://github.com/foundry-rs/foundry/tree/master/crates/config

package.json

@@ -13,6 +13,10 @@
     "postinstall": "husky install"
   },
   "devDependencies": {
+    "@openzeppelin/contracts": "5.0.1",
+    "@openzeppelin/contracts-v4.4": "npm:@openzeppelin/[email protected]",
+    "ds-test": "https://github.com/dapphub/ds-test",
+    "forge-std": "https://github.com/foundry-rs/forge-std.git#v1.7.6",
     "husky": "^8.0.3",
     "lint-staged": "^14.0.1",
     "prettier": "^3.0.3",

remappings.txt

@@ -1,4 +1,4 @@
-@openzeppelin/contracts=lib/openzeppelin-contracts/contracts/
-ds-test/=lib/forge-std/lib/ds-test/src/
-forge-std/=lib/forge-std/src/
-@openzeppelin/contracts-v4.4=lib/openzeppelin-contracts-v4.4/contracts/
+@openzeppelin/contracts-v4.4/=node_modules/@openzeppelin/contracts-v4.4/
+@openzeppelin/contracts/=node_modules/@openzeppelin/contracts/
+forge-std/=node_modules/forge-std/src/
+ds-test/=node_modules/ds-test/src/

script/DeployBase.s.sol

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
-pragma solidity 0.8.21;
+pragma solidity 0.8.24;
 
 import "forge-std/Script.sol";
 

script/DeployGoerli.s.sol

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
-pragma solidity 0.8.21;
+pragma solidity 0.8.24;
 
 import { DeployBase } from "./DeployBase.s.sol";
 

script/DeployHolesky.s.sol

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
-pragma solidity 0.8.21;
+pragma solidity 0.8.24;
 
 import { DeployBase } from "./DeployBase.s.sol";
 

script/DeployMainnetish.s.sol

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
-pragma solidity 0.8.21;
+pragma solidity 0.8.24;
 
 import { DeployBase } from "./DeployBase.s.sol";
 

script/utils/Json.sol

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
-pragma solidity 0.8.21;
+pragma solidity 0.8.24;
 
 import { Vm } from "forge-std/Vm.sol";
 

src/CSAccounting.sol

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: GPL-3.0
 
 // solhint-disable-next-line one-contract-per-file
-pragma solidity 0.8.21;
+pragma solidity 0.8.24;
 
 import { PausableUntil } from "base-oracle/utils/PausableUntil.sol";
 import { AccessControlEnumerable } from "@openzeppelin/contracts/access/extensions/AccessControlEnumerable.sol";

src/CSBondCore.sol

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: GPL-3.0
 
 // solhint-disable-next-line one-contract-per-file
-pragma solidity 0.8.21;
+pragma solidity 0.8.24;
 
 import { ILidoLocator } from "./interfaces/ILidoLocator.sol";
 import { ILido } from "./interfaces/ILido.sol";

src/CSBondCurve.sol

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: GPL-3.0
 
 // solhint-disable-next-line one-contract-per-file
-pragma solidity 0.8.21;
+pragma solidity 0.8.24;
 
 abstract contract CSBondCurveBase {
     event BondCurveAdded(uint256[] bondCurve);

src/CSBondLock.sol

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: GPL-3.0
 
 // solhint-disable-next-line one-contract-per-file
-pragma solidity 0.8.21;
+pragma solidity 0.8.24;
 
 abstract contract CSBondLockBase {
     event BondLockChanged(

src/CSFeeDistributor.sol

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: GPL-3.0
 
 // solhint-disable-next-line one-contract-per-file
-pragma solidity 0.8.21;
+pragma solidity 0.8.24;
 
 import { MerkleProof } from "@openzeppelin/contracts/utils/cryptography/MerkleProof.sol";
 import { SafeCast } from "@openzeppelin/contracts/utils/math/SafeCast.sol";

src/CSFeeOracle.sol

@@ -1,7 +1,7 @@
 // SPDX-FileCopyrightText: 2023 Lido <[email protected]>
 // SPDX-License-Identifier: GPL-3.0
 
-pragma solidity 0.8.21;
+pragma solidity 0.8.24;
 
 import { PausableUntil } from "base-oracle/utils/PausableUntil.sol";
 import { BaseOracle } from "base-oracle/oracle/BaseOracle.sol";