This repo includes the contracts for the Savor Cross chain yield aggregaor being submitted for the Chainklink spring 22 hackathon.
Savor strives to be the first cross chain yield aggregator. With one deposit on any of the supported chain users are automatically earning the highest yields available across all supported chains.
This repository is built using hardhat.
To Setup: 1. Clone Repo on to your local device 2. run "npm install" to install dependencies 3. Create an .env file and copy .en.example in filling in the info for each variable 4. Run "npx hardhat compile"
The master vault (SavorVault.sol) uses the ERC4626 token standard and is an adaptation of the Rari Capital vaults that can be found here. https://github.com/Rari-Capital/vaults.
The Bridgerton.sol contract utilizies the Stargate router to send funds between multiple chains.
The Strategies for each vault (StratExample.sol) are adapted from Yearn.Finance strategies used for their vaults.
To submit contributions create a fork on your own Github with all changes proposed and submit a Pull Request on to the main branch
Pull Requests will be reviewed by team members and merged if approved
Make sure to 'Git Pull origin main' before working on any updates to make sure your branch is up to date
Try running some of the following tasks:
npx hardhat accounts
npx hardhat compile
npx hardhat clean
npx hardhat test
npx hardhat node
node scripts/sample-script.js
npx hardhat help
For more information on Hardhat https://hardhat.org/getting-started/