Hifi
Monorepo implementing the Hifi fixed-rate, fixed-term lending protocol. In-depth documentation is available at docs.hifi.finance.
Packages
The Hifi monorepo is maintained with yarn workspaces. Check out the README associated to each package for detailed usage instructions.
Public
Package | Description |
---|---|
@hifi/amm |
Dedicated AMM for market-making hTokens |
@hifi/flash-swap |
Flash swap implementations for liquidating underwater accounts |
@hifi/protocol |
The core Hifi fixed-rate, fixed-term lending protocol |
@hifi/proxy-target |
DSProxy target contract with stateless scripts |
Private
Package | Description |
---|---|
@hifi/constants |
Constants shared across Hifi packages |
@hifi/errors |
Errors emitted in the Hifi protocol |
@hifi/helpers |
Helper functions shared across Hifi packages |
Contributing
Feel free to dive in! Open an issue, start a discussion or submit a PR. For any concerns or feedback, join us on Discord.
Pre Requisites
You will need the following software on your machine:
In addition, familiarity with Solidity, TypeScript and Hardhat is requisite.
Set Up
Set the version of Node to use:
$ nvm use
Install the dependencies:
$ yarn install
Build the packages:
$ yarn build
Create a .env
file and follow the .env.example
file to add the requisite environment variables, then run the watcher:
$ yarn watch:ts
Now you can start making changes.
Security
For security concerns, please email [email protected]. This repository is subject to the Hifi bug bounty program, per the terms defined here.
License
BUSL v1.1 © Mainframe Group Inc.