Batteries-included client to interact with blockchains and smart contracts
Project description
Batteries-included client to interact with blockchains and smart contracts.
Features
- Easily create a client to interact with EVM-compatible chains.
- Support for ERC20 operations, using the token name (e.g. USDC) instead of address.
- Preconfigured for the most popular chains: Ethereum, Binance, Avalanche and more to come!
- Exposes the underlying web3.py client to allow for more flexibility
Examples
Get the latest block on both Ethereum, BNB Chain and Avalanche:
from web3factory.factory import make_client
eth_block = make_client('ethereum').getLatestBlock()
bnb_block = make_client('binance').getLatestBlock()
avax_block = make_client('avalanche').getLatestBlock()
Get the ETH and USDC balances of the Ethereum foundation:
from web3factory.factory import make_client, make_erc20_client
address = "0xde0b295669a9fd93d5f28d9ec85e40f4cb697bae"
eth = make_client("ethereum").getBalanceInEth(address)
usdc = make_erc20_client("USDC", "ethereum").balanceOf(address) / 10**6
Get the BNB and BUSD balances of Binance's hot wallet:
from web3factory.factory import make_client, make_erc20_client
address = "0x8894e0a0c962cb723c1976a4421c95949be2d4e3"
bnb = make_client("binance").getBalanceInEth(address)
busd = make_erc20_client("BUSD", "binance").balanceOf(address) / 10**18
More examples
Please have a look at the examples folder 🙂
Install
pip3 install -U web3client
It doesn't work 😡
Don't panic! Instead...
- Please check if your issue is listed in the Issues tab.
- If not, consider writing a new issue 🙂
Contribute ❤️
Pull requests are welcome!
- Install and configure PDM:
curl -sSL https://raw.githubusercontent.com/pdm-project/pdm/main/install-pdm.py | python3 -
- Install dependencies:
pdm install
- To run the CLI against your changes:
pdm web3client
- To run tests:
pdm test
TO DO
- Test ERC20 read functions
- Automatically convert addresses to checksum
- Harmonize between camel case and snake case
- Easy accessors for token and network props
- Add write examples and tests
- Add Uniswap V2 LP contracts
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
web3client-0.4.1.tar.gz
(14.8 kB
view hashes)
Built Distribution
web3client-0.4.1-py3-none-any.whl
(16.0 kB
view hashes)
Close
Hashes for web3client-0.4.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b09034ef408ecdc2cb968e468b94c3a2dd0eaa7b0b8f60a4ecf980ad726b27c6 |
|
MD5 | b818696b91569e19e708fa80695050e9 |
|
BLAKE2b-256 | a47bb5b747225c66c74ae460f3f672d0dd68f76812a804f8f2e4b5c717254549 |