`-_`. .______`
-!1111r". .t96/////]%991
"1111111` ~88(. .T8?
-=11111". 488! _?
,"""'. 488a"_ .:
"d8888%x/.
+s#88888%C!_
.~/Ep8888e'
, ^e888>
.5 q88%
.ws` q88;
.e85='` `;Z84;
_!tt7!!!tt!_
Secured Finance is an Orderbook-based Rates Trading Platform on Ethereum to facilitate the lending and borrowing of digital assets so as to construct yield curves in the DeFi space. We're all about fixed-rate, fixed-term crypto asset lending and borrowing, made possible through our unique Zero-Coupon Bond instrument. Our protocol is implemented as a decentralized on-chain orderbook system.
- Use established node version by running
nvm use - Install repository dependencies by running
npm install - Run
npm run compileto compile smart contracts - Execute
npm run testto run the tests.
Please refer to .env.sample and create .env to provide secret info such as private keys.
Private keys are used in order to deploy smart contracts on one of the Ethereum networks.
In addition, depending on your target chain, the native token symbol, the native wrapped token symbol, and the native wrapped token address have to be set.
Run npm run compile to compile smart contracts.
To recompile everything, the command npm run compile:force can be used.
Run npm run deploy <NETWORK> command in order to deploy the protocol.
For example, the command will be npm run deploy hardhat to deploy the protocol on the local hardhat version.
To reset and redeploy the smart contracts again, the command npm run deploy:force <NETWORK> can be used.
- Run
npm run testto run all tests from./testdirectory in a local hardhat javascript EVM.
- Run
npx hardhat nodeornpm run ganacheto start a local blockchain node - Execute
npx hardhat test --network localhostto run tests on a local blockchain node
In order to run the specified script, the command will be npx hardhat --network <NETWORK> test "<SCRIPT PATH>".
For example, the command will be npx hardhat --network development test "scripts/zc-e2e.ts" to execute the zc-e2e script on the develop environment.
- Run
npm run flatten - Run
npm run security:mythril - Check the generated report named
secured-finance-mythril.mdin the project root
As of Oct 2023, Mythril version 0.23.22 is the latest working version for us
- Build the docker image
docker build -t sf-slither --platform linux/amd64 -f Dockerfile.slither . - Run
npm run flatten - Run
npm run security:slither - Check the generated report named
secured-finance-slither.txtin the project root
Note: You can change the target python, solc, and slither analyzer version in the Dockerfile.slither.
As of Oct 2023, Slither will refer to the flatten contracts rather than ones in build. This might affect the slither behavior: generating duplicated messages, etc.
This package is published by GitHub actions. Versioning is executed as follows
In case that current version is 0.0.1
-> prerelease: 0.0.2-beta.0
-> patch: 0.0.2
In case that current version is 0.0.1-beta.0
-> prerelease: 0.0.1-beta.1
-> patch: 0.0.1
Under the tasks folder, there are the scripts below, which are executed using the Hardhat task.
| Task Name | Description | Example of use |
|---|---|---|
| add-currency | Add a new currency | npx hardhat add-currency --network mainnet --currency USDC --haircut 0 --price-feeds "0x6da4D9E53AADF92ABb2e23FFCf8b099FeF08AB84" --heartbeats 86400 --token-address 0x839440dfF4160a8e8373d641f768741c3f3c9932 --is-collateral true |
| add-order-books | Add new order books | npx hardhat add-order-books --network mainnet --currency USDC --min-debt-unit-price 9100 --opening-date 1696464000 --pre-opening-date 1702598400 |
| change-owners | Change owners of all contracts to the new owner | npx hardhat change-owners --network mainnet |
| fork | Create a fork chain using Tenderly's API | npm run fork mainnet |
| unfork | Delete a forked chain | npm run unfork 8238aaaf-bb5a-41b6-8b3d-8c6b1e064a6db98423a5-431c-4fbc-a0cc-3c70fad0500c |
| open-markets | Execute Itayose calls and auto-rolls to open the markets | npx hardhat open-markets --network mainnet |
| register-orders | Register sample orders in the selected order book. | npx hardhat register-orders --network mainnet --collateral-currency USDC --market-currency ETH --maturity 1684316920 --mid-unit-price 9000 --amount 100000000000000000000 --order-count 5 |
| update-price-feed | Update a price feed with new parameters | npx hardhat update-price-feed --network mainnet --currency USDC --price-feeds "0x6da4D9E53AADF92ABb2e23FFCf8b099FeF08AB84" --heartbeats 86400 |
| update-pyth | Update the Pyth price feeds | npx hardhat update-pyth --network filecoin-mainnet |
| verify-contracts | Verify and register contracts on Etherscan. | npx hardhat verify-contracts --network mainnet |
Run npm run docgen in order to generate documents.
The following documents are automatically generated by the code generator under the ./docs folder from Solidity comments.
| External Contracts |
|---|
| LendingMarketReader.sol |
| Liquidator.sol |
| ItayoseCallResolver.sol |
| OrderBookRotationResolver.sol |
You can find all audit reports under the audits folder