Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/badger-finance/aurabal-staker
https://github.com/badger-finance/aurabal-staker
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/badger-finance/aurabal-staker
- Owner: Badger-Finance
- Created: 2022-06-27T22:24:31.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-19T16:02:50.000Z (almost 2 years ago)
- Last Synced: 2023-03-06T01:13:44.708Z (over 1 year ago)
- Language: Python
- Size: 123 KB
- Stars: 2
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Badger Strategy V1.5 Brownie Mix
See Vaults 1.5 Repo for Audit Reports
- Video Introduction: https://youtu.be/b5NptGHm8gw
- Example Project: [Avalanche wBTC AAVE Simple Deposit Strategy](https://github.com/GalloDaSballo/avalance-wbtc-aave-1.5)
## What you'll find here
- Basic Solidity Smart Contract for creating your own Badger Strategy ([`contracts/MyStrategy.sol`](contracts/MyStrategy.sol))
- Sample test suite that runs on mainnet fork. ([`tests`](tests))
- Set of scripts for production ([`scripts`](scripts))
This mix is configured for use with [Ganache](https://github.com/trufflesuite/ganache-cli) on a [forked mainnet](https://eth-brownie.readthedocs.io/en/stable/network-management.html#using-a-forked-development-network).
At BadgerDAO we also fork any other environment, feel free to reach out for help
## Installation and Setup
1. Use this code by clicking on Use This Template
2. Download the code with `git clone URL_FROM_GITHUB`
3. [Install Brownie](https://eth-brownie.readthedocs.io/en/stable/install.html) & [Ganache-CLI](https://github.com/trufflesuite/ganache-cli), if you haven't already.
4. Copy the `.env.example` file, and rename it to `.env`
5. Sign up for [Infura](https://infura.io/) and generate an API key. Store it in the `WEB3_INFURA_PROJECT_ID` environment variable.
6. Sign up for [Etherscan](www.etherscan.io) and generate an API key. This is required for fetching source codes of the mainnet contracts we will be interacting with. Store the API key in the `ETHERSCAN_TOKEN` environment variable.
7. Install the dependencies in the package
```
## Javascript dependencies
npm i
## Python Dependencies
pip install virtualenv
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
```
## Basic Use
To deploy the demo Badger Strategy in a development environment:
1. Open the Brownie console. This automatically launches Ganache on a forked mainnet.
```bash
brownie console
```
2. Run Scripts for Deployment
```
brownie run 1_production_deploy.py
```
Deployment will set up a Vault, Controller and deploy your strategy
## Basic Professional Workflow
1. Write your Tests see `/tests`
2. Modify the `/_setup` folder for basic config as well as the StrategyResolver
3. Write you `MyStrategy`
4. Run tests: `brownie test --interactive` and debug anytime you get an error
## Adding Configuration
To ship a valid strategy, that will be evaluated to deploy on mainnet, with potentially $100M + in TVL, you need to:
1. Add custom config in `/_setup_/config.py`
2. Write the Strategy Code in MyStrategy.sol
3. Customize the StrategyResolver in `/_setup/StrategyResolver.py` so that snapshot testing can verify that operations happened correctly
4. Write any extra test to confirm that the strategy is working properly
## Add a custom want configuration
Most strategies have a:
- **want** the token you want to increase the balance of
- **rewards** a set of tokens you're farming
- **protectedTokens** Token that can't be rugged via sweep
## Implementing Strategy Logic
[`contracts/MyStrategy.sol`](contracts/MyStrategy.sol) is where you implement your own logic for your strategy. In particular:
- Customize the `initialize` Method
- Set a name in `MyStrategy.getName()`
- Make a list of all position tokens that should be protected against movements via `Strategy.protectedTokens()`.
- Write a way to calculate the want invested in `MyStrategy.balanceOfPool()`
- Write a way to calculate the rewards accrued in `MyStrategy.balanceOfRewards()`
- Write a method that returns true if the Strategy should be tended in `MyStrategy.isTendable()`
- Invest your want tokens via `Strategy._deposit()`.
- Take profits and repay debt via `Strategy._harvest()`.
- Unwind enough of your position to payback withdrawals via `Strategy._withdrawSome()`.
- Unwind all of your positions via `Strategy._withdrawAll()`.
- Rebalance the Strategy positions via `Strategy._tend()`.
## Specifying checks for ordinary operations in config/StrategyResolver
In order to snapshot certain balances, we use the Snapshot manager.
This class helps with verifying that ordinary procedures (deposit, withdraw, harvest), happened correctly.
See `/helpers/StrategyCoreResolver.py` for the base resolver that all strategies use
Edit `/config/StrategyResolver.py` to specify and verify how an ordinary harvest should behave
### StrategyResolver
- Add Contract to check balances for in `get_strategy_destinations` (e.g. deposit pool, gauge, lpTokens)
- Write `confirm_harvest` to verify that the harvest was profitable
- Write `confirm_tend` to verify that tending will properly rebalance the strategy
- Specify custom checks for ordinary deposits, withdrawals and calls to `earn` by setting up `hook_after_confirm_withdraw`, `hook_after_confirm_deposit`, `hook_after_earn`
## Add your custom testing
Check the various tests under `/tests`
The file `/tests/test_custom` is already set up for you to write custom tests there
See example tests in `/tests/examples`
All of the tests need to pass!
If a test doesn't pass, you better have a great reason for it!
## Testing
To run the tests:
```
brownie test
```
## Debugging Failed Transactions
Use the `--interactive` flag to open a console immediatly after each failing test:
```
brownie test --interactive
```
Within the console, transaction data is available in the [`history`](https://eth-brownie.readthedocs.io/en/stable/api-network.html#txhistory) container:
```python
>>> history
[,
]
```
Examine the [`TransactionReceipt`](https://eth-brownie.readthedocs.io/en/stable/api-network.html#transactionreceipt) for the failed test to determine what went wrong. For example, to view a traceback:
```python
>>> tx = history[-1]
>>> tx.traceback()
```
To view a tree map of how the transaction executed:
```python
>>> tx.call_trace()
```
See the [Brownie documentation](https://eth-brownie.readthedocs.io/en/stable/core-transactions.html) for more detailed information on debugging failed transactions.
## Deployment
When you are finished testing and ready to deploy to the mainnet:
1. [Import a keystore](https://eth-brownie.readthedocs.io/en/stable/account-management.html#importing-from-a-private-key) into Brownie for the account you wish to deploy from.
2. Run [`scripts/production_deploy.py`](scripts/production_deploy.py) with the following command:
```bash
$ brownie run scripts/production_deploy.py --network mainnet
```
You will be prompted to enter your desired deployer account and keystore password, and then the contracts will be deployed.
3. This script will deploy a Controller, a SettV4 and your strategy under upgradable proxies. It will also set your deployer account as the governance for the three of them so that you can configure them and control them during testing stage. The script will also set the rest of the permissioned actors based on the latest entries from the Badger Registry.
## Production Parameters Verification
When you are done testing your contracts in production and they are ready for incorporation to the Badger ecosystem, the `production_setup` script can be ran to ensure that all parameters are set in compliance to Badger's production entities and contracts. You can run this script by doing the following:
1. Open the [`scripts/production_setup.py`](scripts/production_setup.py) file and change the addresses for your strategy and vault mainnet addresses on lines 29 and 30.
2. [Import a keystore](https://eth-brownie.readthedocs.io/en/stable/account-management.html#importing-from-a-private-key) into Brownie for the account currently set as `governance` for your contracts.
3. Run [`scripts/production_setup.py`](scripts/production_setup.py) with the following command:
```bash
$ brownie run scripts/production_setup.py --network mainnet
```
You will be prompted to enter your governance account and keystore password, and then the the parameter verification and setup process will be executed.
4. This script will compare all existing parameters against the latest production parameters stored on the Badger Registry. In case of a mismatch, the script will execute a transaction to change the parameter to the proper one. Notice that, as a final step, the script will change the governance address to Badger's Governance Multisig; this will effectively relinquish the contract control from your account to the Badger Governance. Additionally, the script performs a final check of all parameters against the registry parameters.
## Known issues
### No access to archive state errors
If you are using Ganache to fork a network, then you may have issues with the blockchain archive state every 30 minutes. This is due to your node provider (i.e. Infura) only allowing free users access to 30 minutes of archive state. To solve this, upgrade to a paid plan, or simply restart your ganache instance and redploy your contracts.
# Resources - OLD / TODO
- Example Strategy https://github.com/Badger-Finance/wBTC-AAVE-Rewards-Farm-Badger-V1-Strategy
- Badger [Discord channel](https://discord.gg/badgerdao)
- Alex The Entreprenerd on [Twitter](https://twitter.com/GalloDaSballo)