Nexus covered vaults

Pre-requirements

The following prerequisites are required:

• Node.js
• Yarn

Install dependencies

Before running any command, make sure to install dependencies:

yarn

Compile contracts

Compile the smart contracts with Hardhat:

yarn compile

Test

Run unit tests:

yarn test

Integration Test

Runs integration tests with Nexus Mutual V2 on a Mainnet fork.

Complete FORK_URL in .env file

Run tests

$ yarn test:fork

Coverage

Run unit tests coverage:

yarn coverage

Gas Report

Run unit tests with gas report:

yarn gas-report

Linter

Run typescript and solidity linters:

yarn lint

Deployment

Create .env file and complete the variables:

cp .env.example .env

Deploy the contracts to Mainnet Network

Deploy covered vault factory contract:

yarn deploy:factory:mainnet

Deploy cover manager contract:

yarn deploy:cover-manager:mainnet

Deploy a new covered vault contract:

yarn deploy:covered-vault:mainnet

Deploy the contracts to Goerli Network

Deploy mock contracts:

yarn deploy:mocks:goerli

Deploy covered vault factory contract:

yarn deploy:factory:goerli

Deploy cover manager contract:

yarn deploy:cover-manager:goerli

Deploy a new covered vault contract:

yarn deploy:covered-vault:goerli