brkntshn / hyperdrive

An automated market maker for fixed and variable yield with on-demand terms.

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 make build.

Test

To test the smart contracts, run make 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 make lint. If you want to automatically format the code, run make prettier.

Yield Sources

The current suggested way of integrating your yield source with hyperdrive is through the ERC-4626 standard although accomodations can be made if this is not possible.

Disclaimer

The language used in this code and documentation is not intended to, and does not, have any particular financial, legal, or regulatory significance.

---

Copyright © 2024 DELV

Licensed under the Apache License, Version 2.0 (the "OSS License").

By accessing or using this code, you signify that you have read, understand and agree to be bound by and to comply with the OSS License and DELV's Terms of Service. If you do not agree to those terms, you are prohibited from accessing or using this code.

Unless required by applicable law or agreed to in writing, software distributed under the OSS License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the OSS License and the DELV Terms of Service for the specific language governing permissions and limitations.