eq-lab/warden-yield

Warden Yield

Contracts

All the contracts and their descriptions can be found in contracts directory

Deployments

All deployed contracts addresses can be found in deploy/data/contracts

Development

Installing

Installation is local and doesn't require root privileges.

If you have yarn installed globally:

yarn

otherwise:

npx yarn

Build & test

Run unit tests:

yarn test

Run integration tests:

yarn test:int

Run unit tests and report gas used by each Solidity function:

yarn test:gas

Generate unit test coverage report:

yarn test:coverage

Deploying

Example of deploy command:

hardhat --network holesky \
  task:deploy \
  --network-name <network> \
  --creator-private-key <private_key>

To dry-run deploy on a local fork, you need to create and use a hardhat config with hardhat.forking settings:

hardhat --config holesky-fork.config.ts \
  task:deploy \
  --network-name <network> \
  --creator-private-key <private_key>

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 3 of the License, or any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.