Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hifi-finance/hifi
Monorepo implementing the Hifi fixed-rate, fixed-term lending protocol
https://github.com/hifi-finance/hifi
blockchain decentralized-finance defi ethereum hifi lending smart-contracts
Last synced: 5 days ago
JSON representation
Monorepo implementing the Hifi fixed-rate, fixed-term lending protocol
- Host: GitHub
- URL: https://github.com/hifi-finance/hifi
- Owner: hifi-finance
- License: other
- Created: 2021-08-06T21:08:53.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-12T20:57:34.000Z (about 1 year ago)
- Last Synced: 2025-01-10T07:31:15.960Z (12 days ago)
- Topics: blockchain, decentralized-finance, defi, ethereum, hifi, lending, smart-contracts
- Language: TypeScript
- Homepage: https://app.hifi.finance
- Size: 11.9 MB
- Stars: 105
- Watchers: 10
- Forks: 15
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Audit: audits/Quantstamp Audit Report.pdf
Awesome Lists containing this project
README
# Hifi [](https://coveralls.io/github/hifi-finance/hifi?branch=main) [](https://yarnpkg.com/) [](https://prettier.io) [](http://commitizen.github.io/cz-cli/) [](https://spdx.org/licenses/BUSL-1.1.html)
Monorepo implementing the Hifi fixed-rate, fixed-term lending protocol. In-depth documentation is available at [docs.hifi.finance](https://docs.hifi.finance).
## Packages
The Hifi monorepo is maintained with [yarn workspaces](https://yarnpkg.com/features/workspaces). Check out the README
associated to each package for detailed usage instructions.
### Public
| Package | Description |
| ---------------------------------------------- | -------------------------------------------------------------- |
| [`@hifi/amm`](/packages/amm) | Dedicated AMM for market-making hTokens |
| [`@hifi/flash-swap`](/packages/flash-swap) | Flash swap implementations for liquidating underwater accounts |
| [`@hifi/protocol`](/packages/protocol) | The core Hifi fixed-rate, fixed-term lending protocol |
| [`@hifi/proxy-target`](/packages/proxy-target) | DSProxy target contract with stateless scripts |
### Private
| Package | Description |
| ---------------------------------------- | -------------------------------------------- |
| [`@hifi/constants`](/packages/constants) | Constants shared across Hifi packages |
| [`@hifi/errors`](/packages/errors) | Errors emitted in the Hifi protocol |
| [`@hifi/helpers`](/packages/helpers) | Helper functions shared across Hifi packages |
## Contributing
Feel free to dive in! [Open](https://github.com/hifi-finance/hifi/issues/new) an issue,
[start](https://github.com/hifi-finance/hifi/discussions/new) a discussion or submit a PR. For any concerns or
feedback, join us on [Discord](https://discord.gg/mhtSRz6).
### Pre Requisites
You will need the following software on your machine:
- [Git](https://git-scm.com/downloads)
- [Node.Js](https://nodejs.org/en/download/)
- [Yarn](https://yarnpkg.com/getting-started/install)
In addition, familiarity with [Solidity](https://soliditylang.org/), [TypeScript](https://typescriptlang.org/) and [Hardhat](https://hardhat.org) is requisite.
### Set Up
Set the version of Node to use:
```bash
$ nvm use
```
Install the dependencies:
```bash
$ yarn install
```
Build the packages:
```bash
$ yarn build
```
Create a `.env` file and follow the `.env.example` file to add the requisite environment variables, then run the watcher:
```bash
$ yarn watch:ts
```
Now you can start making changes.
## Security
For security concerns, please email [[email protected]](mailto:[email protected]). This repository is subject to the Hifi bug bounty program, per the terms defined [here](https://docs.hifi.finance/protocol/overview/security/#bug-bounty).
## License
[BUSL v1.1](./LICENSE.md) © Mainframe Group Inc.