Merge pull request #90 from lidofinance/develop

1.0.0-alpha release

.env.example

@@ -0,0 +1 @@
+MAINNET_RPC_URL=<your RPC url>

.github/workflows/slither.yml

@@ -0,0 +1,37 @@
+name: Slither Analysis
+
+on:
+  push:
+    branches: [develop, master]
+  pull_request:
+    branches: [develop, master]
+
+jobs:
+  analyze:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      security-events: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Run Slither
+        uses: crytic/slither-action@v0.4.0
+        id: slither
+        with:
+          sarif: results.sarif
+          fail-on: none
+
+      - name: Check results.sarif presence
+        id: results
+        if: always()
+        shell: bash
+        run: >
+          test -f results.sarif &&
+          echo 'value=present' >> $GITHUB_OUTPUT ||
+          echo 'value=not' >> $GITHUB_OUTPUT
+      
+      - name: Upload SARIF file
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: ${{ steps.slither.outputs.sarif }}

.gitignore

@@ -1,7 +1,6 @@
 node_modules/
 .env
-coverage/
-coverage.json
+coverage-report/
 .DS_Store
 
 # Hardhat files
@@ -16,3 +15,4 @@ out/
 !/broadcast
 /broadcast/*/31337/
 /broadcast/**/dry-run/
+.vscode/

.nvmrc

@@ -0,0 +1 @@
+v20.16.0

README.md

@@ -8,14 +8,47 @@ See [this research forum discussion](https://research.lido.fi/t/ldo-steth-dual-g
 
 This project uses NPM for dependency management and Forge for tests so you'll need to have Node.js, NPM, and Foundry installed.
 
-Installing the dependencies:
+* Install NVM https://github.com/nvm-sh/nvm/blob/master/README.md#install--update-script
 
-```sh
-npm install
-```
+* Install specific Node.js version
+    ```sh
+    nvm install
+    ```
+
+* Install the dependencies:
+    ```sh
+    npm ci
+    ```
+
+* Install Foundry and `forge` https://book.getfoundry.sh/getting-started/installation
+
+* Create `.env` file
+    ```sh
+    cp .env.example .env
+    ```
+
+    and specify there your `MAINNET_RPC_URL`.
+
+    > **_NOTE:_**  You may need to specify manually maximum allowed requests per second (rps) value for an API key/RPC url for some providers. In our experience max 100 rps will be enough to run tests.
 
 ## Running tests
 
 ```sh
 forge test
 ```
+
+## Test coverage HTML report generation
+
+1. Install `lcov` package in your OS
+    ```sh
+    brew install lcov
+    
+    -OR-
+
+    apt-get install lcov
+    ```
+2. Run
+    ```sh
+    npm run cov-report
+    ```
+3. Open `./coverage-report/index.html` in your browser.