Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/badger-finance/badger-system
https://github.com/badger-finance/badger-system
Last synced: 4 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/badger-finance/badger-system
- Owner: Badger-Finance
- License: mit
- Created: 2020-11-16T18:40:32.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2022-09-16T21:07:10.000Z (about 2 years ago)
- Last Synced: 2023-10-20T18:04:33.671Z (about 1 year ago)
- Language: Python
- Size: 118 MB
- Stars: 100
- Watchers: 19
- Forks: 53
- Open Issues: 93
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Badger Finance
Badger Finance is a community DAO, focused on bringing Bitcoin to DeFi. The DAO's debut products are Sett, a yield aggregator, and Digg, a BTC-pegged elastic supply currency.
Visit our [GitBook](https://app.gitbook.com/@badger-finance/s/badger-finance/) for more detailed documentation.
## Build
The Badger contracts & tests are built around the [Eth-Brownie](https://eth-brownie.readthedocs.io/en/stable/install.html) Python framework.
If you're not familiar with brownie, see the [quickstart guide](https://eth-brownie.readthedocs.io/en/stable/quickstart.html).
### Dependencies
- Python 3.9
- Node.js 10.x development environment (for Ganache).
- [Eth-Brownie](https://eth-brownie.readthedocs.io/en/stable/install.html)
- Ganache (v6.12.1)
### Install
This repository is currently only supported on Linux based systems. For Windows 10 users, it is recommended to use the Windows Subsystem for Linux 2 (WSL2) in order to run Linux executables natively and interact with the system in a convenient way. Instructions on how to quickly setup WSL2 can be found [here](https://docs.microsoft.com/en-us/windows/wsl/install-win10).
For Ubuntu, you can install the prerequisite packages with the following command:
```
sudo apt-get install -y python3 python3-virtualenv python3-pip
```
For other systems, install Python 3.9, Pip, and use pip to install virtualenv with
```
pip install virtualenv
```
To install NodeJS and yarn on UNIX based systems, it is recommended to use the following commands:
```
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.38.0/install.sh | bash
nvm install v14.16.1
npm install -g yarn
```
With prerequisites installed, install the project with:
```bash
git clone https://github.com/Badger-Finance/badger-system
cd badger-system
yarn install --lock-file
virtualenv venv
source venv/bin/activate
pip install -r requirements.txt
```
### Compile
```bash
source venv/bin/activate
brownie compile
```
### Test
```bash
source venv/bin/activate
brownie test
```
### Add coverage and gas profiling
```bash
source venv/bin/activate
brownie test --coverage --gas
```
### Local Instance
Run a local ganache instance connected to badger contracts, with all Sett-related assets distributed to a test account specified in the TEST_ACCOUNT env variable. Assumes the default network is mainnet-fork in the brownie config and uses Alchemy as a web3 provider through the ALCHEMYAPI_TOKEN env variable. Ganache will continue to run until the process is closed.
```bash
source venv/bin/activate
export TEST_ACCOUNT=
export ALCHEMYAPI_TOKEN=
brownie run scripts/local_instance.py
```
### Running Scripts on non-Ethereum chains
The included brownie-config.yaml has configurations for running forked environments on non-ethereum chains where Badger contracts are deployed. To run scripts against another chain, append the appropriate `--network` parameter to any `brownie run` or `brownie test` command.
The appropriate live Badger deploy for that chain will automatically be read.
As an example, `bsc-fork` is the networkID for a Binance Smart Chain forked environment.
```bash
brownie run scripts/local_instance.py --network bsc-fork
```
### Badger Deploy Files
These files maintain a registry of all live Badger contracts on a given chain.
* Ethereum Mainnet: [deploy-final.json](https://github.com/Badger-Finance/badger-system/blob/develop/deploy-final.json)
* Binance Smart Chain: [badger-deploy-bsc.json](https://github.com/Badger-Finance/badger-system/blob/develop/badger-deploy-bsc.json)
### Post-Update
- Set boost flag to false to upload boosts to production instead of staging
- Run scripts with --network mainnet instead of --network mainnet-fork
### Documentation
You can read more about Badger at our [GitBook](https://app.gitbook.com/@badger-finance/s/badger-finance/).
### Discussion
To join the community, head over to the [Discord server](https://discord.gg/badgerdao).