Internal review

.github/workflows/echidna.yml

@@ -0,0 +1,40 @@
+name: Echidna Test
+
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+
+env:
+  FOUNDRY_PROFILE: ci
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:      
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+      with:
+        submodules: recursive
+
+    - name: Install Foundry
+      uses: foundry-rs/foundry-toolchain@v1
+      with:
+        version: nightly
+
+    - name: Compile contracts
+      run: |
+        forge build --build-info
+
+    - name: Run Echidna
+      uses: crytic/echidna-action@v2
+      with:
+        files: .
+        contract: CryticERC4626TestsHarness
+        # crytic-args: --ignore-compile
+        config: test/echidna/config/echidna.config.yaml

.github/workflows/slither.yml

@@ -0,0 +1,31 @@
+name: Slither Analysis
+
+on:
+    push:
+        branches:
+            - main
+    pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  analyze:
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    - name: Run Slither
+      uses: crytic/[email protected]
+      id: slither
+      with:
+        node-version: 16
+        sarif: results.sarif
+        fail-on: high
+      continue-on-error : true

.github/workflows/test.yml

@@ -1,34 +1,42 @@
-name: test
+name: Foundry
 
-on: workflow_dispatch
-
-env:
-  FOUNDRY_PROFILE: ci
+on:
+    push:
+        branches:
+            - main
+    pull_request:
 
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
 jobs:
-  check:
-    strategy:
-      fail-fast: true
-
-    name: Foundry project
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          submodules: recursive
-
-      - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@v1
-        with:
-          version: nightly
-
-      - name: Run Forge build
-        run: |
-          forge --version
-          forge build --sizes
-        id: build
-
-      - name: Run Forge tests
-        run: |
-          forge test -vvv
-        id: test
+    build-and-test:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  submodules: recursive
+
+            - name: Install foundry
+              uses: foundry-rs/foundry-toolchain@v1
+              with:
+                  version: nightly
+
+            - name: Run foundry build
+              run: forge build --force --skip test --sizes
+
+            - name: Run foundry fmt check
+              run: forge fmt --check    
+
+            - name: Run foundry tests
+              run: FOUNDRY_PROFILE=test forge test
+
+            - name: Run foundry fuzzing
+              run: FOUNDRY_PROFILE=ci_fuzz forge test
+
+            - name: Run foundry coverage
+              run: FOUNDRY_PROFILE=coverage forge coverage --report summary
+
+            - name: Run foundry invariants
+              run: forge clean && FOUNDRY_PROFILE=invariant forge test

.gitignore

@@ -12,3 +12,17 @@ docs/
 
 # Dotenv file
 .env
+
+# coverage
+lcov.info
+coverage
+
+# gas
+.gas-snapshot
+
+# echidna
+crytic-export/
+/test/echidna/_corpus/
+
+# slither
+slither.db.json

.gitmodules

@@ -0,0 +1,25 @@
+[submodule "lib/forge-std"]
+	path = lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/ethereum-vault-connector"]
+	path = lib/ethereum-vault-connector
+	url = https://github.com/euler-xyz/ethereum-vault-connector
+[submodule "lib/euler-vault-kit"]
+	path = lib/euler-vault-kit
+	url = https://github.com/euler-xyz/euler-vault-kit
+
+[submodule "lib/reward-streams"]
+	path = lib/reward-streams
+	url = https://github.com/euler-xyz/reward-streams
+[submodule "lib/openzeppelin-contracts-upgradeable"]
+	path = lib/openzeppelin-contracts-upgradeable
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable
+[submodule "lib/openzeppelin-contracts"]
+	path = lib/openzeppelin-contracts
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts
+[submodule "lib/erc4626-tests"]
+	path = lib/erc4626-tests
+	url = https://github.com/a16z/erc4626-tests
+[submodule "lib/properties"]
+	path = lib/properties
+	url = https://github.com/crytic/properties

README.md

@@ -39,28 +39,8 @@ $ forge fmt
 $ forge snapshot
 ```
 
-### Anvil
+### Run Echidna
 
 ```shell
-$ anvil
-```
-
-### Deploy
-
-```shell
-$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
-```
-
-### Cast
-
-```shell
-$ cast <subcommand>
-```
-
-### Help
-
-```shell
-$ forge --help
-$ anvil --help
-$ cast --help
-```
+$ echidna test/echidna/CryticERC4626TestsHarness.t.sol --contract CryticERC4626TestsHarness --config test/echidna/config/echidna.config.yaml
+```

coverage.sh

@@ -0,0 +1,36 @@
+# Make sure this script is executable. On Unix based systems, run "chmod +x coverage.sh".
+# To run this script, type "./coverage.sh".
+
+#!/bin/bash
+
+set -e # exit on error
+
+# check if lcov is installed, if not, execute installation
+if ! command -v lcov &>/dev/null; then
+    echo "lcov is not installed. Installing..."
+	# check if its macos or linux.
+	if [ "$(uname)" == "Darwin" ]; then
+		brew install lcov
+
+	else
+		sudo apt-get install lcov
+	fi
+fi
+lcov --version
+
+# generates lcov.info
+FOUNDRY_PROFILE=coverage forge coverage --report lcov
+
+# Generate summary
+lcov \
+    --rc branch_coverage=1 \
+    --ignore-errors inconsistent \
+    --list lcov.info
+
+# Open more granular breakdown in browser
+genhtml \
+    --ignore-errors category \
+    --rc branch_coverage=1 \
+    --output-directory coverage \
+    lcov.info
+open coverage/index.html

foundry.toml

@@ -2,5 +2,74 @@
 src = "src"
 out = "out"
 libs = ["lib"]
+test = 'test'
+optimizer = true
+optimizer_runs = 200
+solc = "0.8.24"
+gas_reports = ["*"]
+fs_permissions = [{ access = "read", path = "./"}]
+
+[profile.default.fmt]
+line_length = 120
+tab_width = 4
+bracket_spacing = false
+int_types = "long"
+quote_style = "double"
+number_underscore = "preserve"
+override_spacing = true
+ignore = [
+    "src/core/lib/StorageLib.sol"
+]
+
+[profile.test]
+no_match_test = "(Fuzz|invariant_)"
+no_match_contract = "(Fuzz|CryticERC4626TestsHarness)"
+gas_reports = ["*"]
+
+[profile.fuzz]
+runs = 1000
+max_local_rejects = 1024
+max_global_rejects = 65536
+seed = '0x3e8'
+dictionary_weight = 100
+include_storage = true
+include_push_bytes = true
+match_test = "Fuzz"
+match_contract = "Fuzz"
+
+[profile.ci_fuzz]
+runs = 50000
+max_local_rejects = 1024
+max_global_rejects = 65536
+seed = '0x3e8'
+dictionary_weight = 100
+include_storage = true
+include_push_bytes = true
+match_test = "Fuzz"
+match_contract = "Fuzz"
+
+[profile.invariant]
+runs = 256
+depth = 500
+fail_on_revert = false
+call_override = false
+dictionary_weight = 80
+include_storage = true
+include_push_bytes = true
+match_test = "invariant_"
+
+[profile.coverage]
+via_ir = true
+no_match_test = "(invariant_)"
+no_match_contract = "(Script|CryticERC4626TestsHarness)"
+no_match_coverage= "(script|test|fuzz|e2e)"
+
+[profile.coverage.optimizer_details]
+constantOptimizer = true
+yul = true
+
+[profile.coverage.optimizer_details.yulDetails]
+stackAllocation = true
+optimizerSteps = ''
 
 # See more config options https://github.com/foundry-rs/foundry/blob/master/crates/config/README.md#all-options

remappings.txt

@@ -0,0 +1,9 @@
+erc4626-tests/=lib/erc4626-tests/
+ethereum-vault-connector/=lib/ethereum-vault-connector/src/
+forge-std/=lib/forge-std/src/
+evk/=lib/euler-vault-kit/
+reward-streams=lib/reward-streams/src
+openzeppelin-contracts/=lib/reward-streams/lib/openzeppelin-contracts/contracts
+@openzeppelin/=lib/openzeppelin-contracts/
+@openzeppelin-upgradeable/=lib/openzeppelin-contracts-upgradeable/contracts/
+crytic-properties/=lib/properties/contracts/