cjsaveas / badger-system

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 for more detailed documentation.

Build

The Badger contracts & tests are built around the Eth-Brownie Python framework.

If you're not familiar with brownie, see the quickstart guide.

Dependencies

• Python 3.9
• Node.js 10.x development environment (for Ganache).
• Eth-Brownie
• Ganache (v6.12.1)

Install

git clone https://github.com/Badger-Finance/badger-system
cd badger-system
yarn install --lock-file
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Compile

source venv/bin/activate
brownie compile

Test

source venv/bin/activate
brownie test

Add coverage and gas profiling

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 infura as a web3 provider through the WEB3_INFURA_PROJECT_ID env variable. Ganache will continue to run until the process is closed.

source venv/bin/activate
export TEST_ACCOUNT=<enter your account here>
export WEB3_INFURA_PROJECT_ID=<enter infura key here>
brownie run scripts/local_instance.py

Documentation

You can read more about Badger at our GitBook.

Discussion

To join the community, head over to the Discord server.