Hifi Protocol

An implementation of zero-coupon bonds on the Ethereum blockchain. In-depth documentation on Hifi is available at docs.hifi.finance.

The built contract artifacts can be browsed via unpkg.com.

Developers

Our contracts are written in Solidity and our tests in TypeScript.

If you want to contribute, familiarity with Hardhat, Ethers, Waffle and TypeChain is needed.

Pre Requisites

Before running any command, make sure to install dependencies:

$ yarn install

Compile

Compile the smart contracts with Hardhat:

$ yarn compile

TypeChain

Compile the smart contracts and generate TypeChain artifacts:

$ yarn typechain

Lint Solidity

Lint the Solidity code:

$ yarn lint:sol

Lint TypeScript

Lint the TypeScript code:

$ yarn lint:ts

Format Code

Run the Prettier formatter:

$ yarn prettier

Test Unit

Run the unit tests:

$ yarn test:unit

Test Integration

Run the integration tests:

$ yarn test:integration

Coverage

Generate the code coverage report:

$ yarn coverage

Clean

Delete the smart contract artifacts, the coverage reports and the Hardhat cache:

$ yarn clean

Acknowledgements

• Dan Robinson and Allan Niemerg, for their work on The Yield Protocol: On-Chain Lending With Interest Rate Discovery, which shaped many of our protocol design choices.
• Chainlink, for their Price Feeds.
• Compound Finance, for their Solidity math library.
• OpenZeppelin, for their outstanding smart contract library.

Discussion

For any concerns or feedback, open an issue or visit us on Discord to discuss.

License

Everything is released under the LGPL3.0 license.

致谢

以太坊eth区块链blockchain上零息票债券的实现。有关Hifi的深入文档可在文档.高保真.财务.

可以通过unpkg.com网站.

讨论

我们的合同是用实体写的，我们的测试是用打字的。

如果你想贡献自己的力量，需要熟悉Hardhat、Ethers、华夫饼和TypeChain。

许可证

在运行任何命令之前，请确保安装依赖项：

$ yarn install

Compile

使用Hardhat编译智能契约：

$ yarn compile

TypeChain

编译智能契约并生成TypeChain工件：

$ yarn typechain

Lint Solidity

Lint实体代码：

$ yarn lint:sol

Lint TypeScript

Lint TypeScript代码：

$ yarn lint:ts

Format Code

运行Prettier格式化程序：

$ yarn prettier

Test Unit

运行单元测试：

$ yarn test:unit

Test Integration

运行集成测试：

$ yarn test:integration

Coverage

生成代码覆盖率报告：

$ yarn coverage

Clean

删除智能合约工件、覆盖率报告和安全帽缓存：

$ yarn clean

Acknowledgements

• Dan Robinson和Allan Niemerg，感谢他们在收益率协议上的工作：具有利率发现的链上贷款，这形成了我们的许多协议设计选择。
• Chainlink，获取他们的价格提要。
• 复合金融，因为他们的数学库很坚固。
• OpenZeppelin，感谢他们杰出的智能合约库。你知道吗

Discussion

对于任何问题或反馈，请打开问题或访问我们以讨论不一致。

License

所有内容都是根据LGPL3.0许可证发布的。高保真协议干净的

致谢

讨论

许可证