Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beefyfinance/beefy-contracts
Public repo for the community devs to advance the Beefy protocol.
https://github.com/beefyfinance/beefy-contracts
Last synced: 3 months ago
JSON representation
Public repo for the community devs to advance the Beefy protocol.
- Host: GitHub
- URL: https://github.com/beefyfinance/beefy-contracts
- Owner: beefyfinance
- Created: 2021-01-06T01:34:11.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-22T19:20:04.000Z (7 months ago)
- Last Synced: 2024-04-23T02:27:46.980Z (7 months ago)
- Language: Solidity
- Homepage: https://app.beefy.finance
- Size: 4.36 MB
- Stars: 167
- Watchers: 13
- Forks: 157
- Open Issues: 5
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
- awesome-foundry - Beefy Finance - Official repo for strategies and vaults from the Beefy yield optimizer. (Projects Using Foundry)
README
# Beefy Contracts
Official repo for strategies and vaults from Beefy. Community strategists can contribute here to grow the ecosystem.
## Vault Deployment Process
### 1. Select a farm
The first step to have a vault deployed on Beefy is to select a farm to deploy a vault around. At the moment the rewards for a strategist are:
- 0.5% of all rewards earned by a vault they deployed.
This means that you want to select a farm with:
1. High APR
2. High expected TVL
3. Long farm life
First time strategists must deploy contracts for farms on existing platforms on Beefy first. New platforms must undergo an audit by Beefy dev team before development can begin.
### 2. Prepare the smart contracts
If you decided to do a simple LP vault, or a single asset vault, the most likely thing is that there is a working template that you can use. Most farms work under a version of the [Masterchef](https://bscscan.com/address/0xe70E9185F5ea7Ba3C5d63705784D8563017f2E57#code) contract (like Goose Finance), or [Reward Pool](https://arbiscan.io/address/0x48f4634c8383af01bf71aefbc125eb582eb3c74d#code) contract (like Beefy Reward Pool).
### 3. Test the contracts
If you're doing something completely custom you should add automated tests to facilitate review and diminish risks. If it's a copy/paste from another strategy you can get by with manual testing for now as everything has been battle tested tested quite a bit.
For extra help in debugging a deployed vault during development, you can use the [ProdVaultTest.t.sol](./forge/test/ProdVaultTest.t.sol), which is written using the `forge` framework. Run `yarn installForge` to install if you don't have `forge` installed.
To prep to run the test suite, input the correct vault address, vaultOwner and stratOwner for the chain your testing in `ProdVaultTest.t.sol`, and modify the `yarn forgeTest:vault` script in package.json to pass in the correct RPC url of the chain your vault is on. Then run `yarn forgeTest:vault` to execute the test run. You can use `console.log` within the tests in `ProdVaultTest.t.sol` to output to the console.
### 4. Deploy the smart contracts
Once you are confident that everything works as expected you can do the official deploy of the vault + strategy contracts. There are [some scripts](https://github.com/beefyfinance/beefy-contracts/blob/master/scripts/) to help make deploying easier.
Make sure the strategy is verified in the scanner. A fool-proof way to verify is to flatten the strategy file using the `yarn flat-hardhat` command and removing the excess licenses from the flattened file. Verify the strategy contract using the flattened file as the source code, solidity version is typically 0.6.12 and is optimized to 200 runs. Constructor arguments can be found from the end of the input data in the contract creation transaction; they are padded out with a large number of 0s (include the 0s).
### 5. Update the app
The only file you really need to touch on the app is the respective json file located in the [vault](https://github.com/beefyfinance/beefy-v2/tree/main/src/config/vault) folder. This is the config file with all the live pools. Just copy one of the other pools as template, paste it at the top (below the BIFI Maxi and boosted vaults) and fill it out with your data. `earnedTokenAddress`and `earnedContractAddress` should both be the address of the vault contract. These addresses must be checksummed. Use the `getPoolCreationTimestamp.js` script to get creation dates. You will also need to update the addressBook to the current version in package.json in order for Zap to work if the tokens are new to the address book.
### 6. Test the vault
Run `yarn start` on the local app terminal and test the vault as if you were a user on the `localhost` page.
**Manual Testing Is Required for All Live Vaults**
0. Give vault approval to spend your want tokens.
1. Deposit a small amount to test deposit functionality.
2. Withdraw, to test withdraw functionality.
3. Deposit a larger amount wait 30 seconds to a minute and harvest. Check harvest transaction to make sure things are going to the right places.
4. Panic the vault. Funds should be in the strategy.
5. Withdraw 50%.
6. Try to deposit, once you recieve the error message pop up in metamask you can stop. No need to send the transaction through.
7. Unpause.
8. Deposit the withdrawn amount.
9. Harvest again.
10. Switch harvest-on-deposit to `true` for low-cost chains (Polygon, Fantom, Harmony, Celo, Cronos, Moonriver, Moonbeam, Fuse, Syscoin, Emerald).
11. Check that `callReward` is not 0, if needed set `pendingRewardsFunctionName` to the relevant function name from the masterchef.
12. Transfer ownership of the vault and strategy contracts to the owner addresses for the respective chains found in the [address book](https://github.com/beefyfinance/beefy-api/tree/master/packages/address-book).
13. Leave some funds in the vault until users have deposited after going live, empty vaults will fail validation checks.
14. Run `yarn validate` to ensure that the validation checks will succeed when opening a pull request.
This is required so that maintainers can review everything before the vault is actually live on the app and manage it after its live.
### 7. Update the API
#### Existing platform
If you're deploying a vault for a platform where we already have live vaults, you will probably only need to add some data to the respective config file in the [data](https://github.com/beefyfinance/beefy-api/tree/master/src/data) folder. For example if you're doing a new Pancakeswap LP vault, you only need to add the relevant data at [cakeLpPools.json](https://github.com/beefyfinance/beefy-api/blob/master/src/data/cakeLpPools.json)
Simpler than that is to use the scripts available to add existing protocol farms.
- `yarn bsc:pancake:add --pool ` will add the new pancake farm.
- `yarn polygon:quick:add --pool ` will add the new quickswap reward pool.
#### New platform
If it's a new platform you're going to have to add code to a few files.
1. Create a data file for the platform in the relevant chain's folder in [data](https://github.com/beefyfinance/beefy-api/tree/master/src/data) and fill out the farm data.
2. Create a folder under /api/stats in the relevant chain and add code to get the APYs. You will probably be able to use the template for MasterChefs i.e. in [getJetswapApys.js](https://github.com/beefyfinance/beefy-api/blob/master/src/api/stats/fantom/getJetswapApys.js).
3. Import the new getApys file to the chain folder's index i.e. [index.js](https://github.com/beefyfinance/beefy-api/blob/master/src/api/stats/bsc/degens/index.js).
4. Lastly, add a route handler to [getAmmPrices.ts](https://github.com/beefyfinance/beefy-api/blob/master/src/api/stats/getAmmPrices.ts) so that API and the app can access token and LP prices.
#### Token not in address book
If any of the relevant tokens do not exist in token.ts in the [address book](https://github.com/beefyfinance/beefy-api/tree/master/packages/address-book) for the network the vault will be deployed on, you will need to add them. Example below.
```
SUSHI: {
name: 'Sushi',
address: '0xd4d42F0b6DEF4CE0383636770eF773390d85c61A',
symbol: 'SUSHI',
decimals: 18,
chainId: 42161,
website: 'https://sushi.com/',
description:
'SushiSwap is an automated market-making (AMM) decentralized exchange (DEX) currently on the Ethereum blockchain.',
logoURI: 'https://ftmscan.com/token/images/sushiswap_32.png',
},
```
### Done!
Another Beefy dev will review everything, merge the PRs and ship it to production.
## Environment variables
bsc-rpc: "https://bsc-dataseed2.defibit.io/",
heco-rpc:"https://http-mainnet-node.huobichain.com",
avax-rpc: "https://api.avax.network/ext/bc/C/rpc",
polygon-rpc: "https://polygon-rpc.com/",
fantom-rpc: "https://rpc.ftm.tools",
one-rpc: "https://api.s0.t.hmny.io/",
arbitrum-rpc: "https://arb1.arbitrum.io/rpc",
## Troubleshooting
- If you get the following error when testing or deploying on a forked chain: `Error: VM Exception while processing transaction: reverted with reason string 'Address: low-level delegate call failed'`, you are probably using `hardhat` network rather than `localhost`. Make sure you are using `--network localhost` flag for your test or deploy yarn commands.
- If you get the following error when running the fork command i.e. `yarn net bsc`: `FATAL ERROR: Reached heap limit Allocation failed - JavaScript heap out of memory`. Run this command to increase heap memory limit: `export NODE_OPTIONS=--max_old_space_size=4096`
- If you are getting hanging deployments on polygon when you run `yarn deploy-strat:polygon`, try manually adding `{gasPrice: 8000000000 * 5}` as the last arg in the deploy commands, i.e. `const vault = await Vault.deploy(predictedAddresses.strategy, vaultParams.mooName, vaultParams.mooSymbol, vaultParams.delay, {gasPrice: 8000000000 * 5}); `