Skip to content

Latest commit

 

History

History
45 lines (30 loc) · 1.85 KB

README.md

File metadata and controls

45 lines (30 loc) · 1.85 KB

Tests Coverage

Hyperdrive

Hyperdrive is an automated market maker that enables fixed-rate markets to be built on top of arbitrary yield sources.

Developing

Pre-requisites

This repository makes use of foundry to build and test the smart contracts and uses several node.js packages to lint and prettify the source code. Proceed through the following steps to set up the repository:

  • Install forge
  • Install yarn
  • Install lib/forge-std dependencies by running forge install from the project root
  • Install node.js dependencies by running yarn from the project root

Environment Variables

The test suite and migration scripts make use of several environment variables. Copy .env_template to .env and populate the file with your private key and provider URLs.

Build

To build the smart contracts, run yarn build.

Test

To test the smart contracts, run yarn test.

Lint

We have several linters. Solhint is a Solidity linter that checks for best practices and style, prettier is a Solidity formatter that checks for formatting and style, and cSpell is a spell checker. To run all three, run yarn lint. If you want to automatically format the code, run yarn prettier.

Disclaimer

The language used in this codebase is for coding convenience only, and is not intended to, and does not, have any particular legal or regulatory significance.