README.md

Lido Dual Governance contracts

WARNING: this code is an early draft and is not functional yet.

See this research forum discussion for the relevant context.

Setup

This project uses NPM for dependency management and Forge for tests so you'll need to have Node.js, NPM, and Foundry installed.

• Install NVM https://github.com/nvm-sh/nvm/blob/master/README.md#install--update-script

• Install specific Node.js version

  nvm install

• Install the dependencies:

  npm ci

• Install Foundry and forge https://book.getfoundry.sh/getting-started/installation

• Create .env file

  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

forge test

Test coverage HTML report generation

1. Install lcov package in your OS

   brew install lcov
   
   -OR-
   
   apt-get install lcov

2. Run

   npm run cov-report

3. Open ./coverage-report/index.html in your browser.