Badger utils and shared code
Project description
badger-utils library
This is the library for all badger utils that were moved from badger-system repo.
Build | Coverage | PYPI |
---|---|---|
Requirements
To make use of library you would need some interfaces and contracts to be compiled and injected by brownie into your brownie project. List of required interfaces can be found here
You also need some contracts to be compiled as well:
ForceEther, SafeMath, Token, BadgerRegistry
Installing library
pip install badger-utils
To run tests:
$ virtualenv venv
$ source venv/bin/activate
$ make
$ brownie test
Using library
Giving some examples on library usage:
Using coingecko utils:
from badger_utils.coingecko_utils import fetch_usd_price
some_erc_token = interface.IERC20(Token)
usd_price = fetch_usd_price(some_erc_token.address)
Using gas_utils module:
from badger_utils.gas_utils import GasStrategies
# Class initialization will initialize everything and fetch gas prices
strategies = GasStrategies()
price = strategies.optimal_price()
# check gas cost:
strategies.gas_cost(gas_estimate=21000)
# Set default strategy:
strategies.set_default_for_active_chain()
NOTE: If you want to use Anyblock historical data in gas analysis, consider adding auth keys from anyblock account:
export ANYBLOCK_EMAIL=email@gmail.com
export ANYBLOCK_KEY=<YOU ANYBLOCK API KEY>
otherwise def analyze_gas
function will always return static data:
DotMap(mode=999999999999999999, median=999999999999999999, std=999999999999999999)
Using network utils
from badger_utils.network_manager import network_manager
network = network_manager.get_active_network()
badger_deploy_file = network_manager.get_active_network_badger_deploy()
Using proxy utils
from badger_utils.proxy_utils import deploy_proxy_admin
from brownie import accounts
contract = deploy_proxy_admin(accounts[0])
assert contract.address is not None
Using token utils
import token # some deployed token
from brownie import accounts
from badger_utils.token_utils import distribute_from_whales
token.transfer(
"0x19d099670a21bC0a8211a89B84cEdF59AbB4377F", 100000, {'from': accounts[0]}
)
distribute_from_whales(accounts[1], percentage=0.8)
Using constants
from badger_utils.constants import AddressZero
from badger_utils.constants import TOKEN_LOCKER_ROLE
from badger_utils.constants import ContractSystems
Using tx timer
from badger_utils.tx_timer import tx_timer
from brownie import accounts
tx_timer.prepare_timer(accounts[0], "Harvest")
tx_timer.start_timer(accounts[0], 'Harvest')
tx_timer.end_timer()
Using artifacts
from badger_utils.registry.artifacts import artifacts
timelock_abi = artifacts.open_zeppelin["TokenTimelock"]["abi"]
Using registries
On chain registry:
from badger_utils.registry import chain_registries
chain_registries.initialize()
chain_registries.get("badgerTree")
Locally defined registry
NOTE: This is legacy way of working with registries
from brownie import web3
from badger_utils.registry import registry
checksummed = web3.toChecksumAddress(registry.tokens.wbtc)
Using systems
from badger_utils.systems import SushiswapSystem
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for badger_utils-0.2.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 31b7b989c3e5eeece349f55cb3549fbcca9ebf0ab2954208ff017cf2ef9775fe |
|
MD5 | 8b36adf70e0a2dfe97cd641dd18aa497 |
|
BLAKE2b-256 | a4891b8ad7d0aca8c037062841235abc5a8e3d5d4b40bd744269a42e037cdc33 |