Web3-Ethereum-DeFi is a library for smart contracts, DeFi trading (Uniswap, PancakeSwap), Ethereum JSON-RPC, EVM transactions and automated test suites.
Project description
Web3-Ethereum-Defi
This project contains common Ethereum smart contracts and utilities, for trading, wallets,automated test suites and backend integrations for EVM based blockchains.
- Features
- Precompiled ABI file distribution
- Python usage
- Documentation
- Development and contributing
- Version history
- Social media
- Notes
- History
Pepe chooses web3-ethereum-defi and Python.
Features
Features include
- Made for 99% developers
- High-quality API documentation
- Fully type hinted for good developer experience
- ERC-20 token issuance and manipulation
- Uniswap v2 tools: deployment, trading, price estimation for Sushiswap, PancakeSwape, QuickSwap, Trader Joe, others
- Parallel transaction execution
- Mainnet forking with ganache-cli
- As opposite to slower and messier mainnet forking workflows, this project aims to explicit clean deployments and very fast test execution.
- (More integrations to come)
Precompiled ABI file distribution
The project provides a precompiled smart contract bundle, including ABI files, full source and debug maps, to make deploying test instances trivial.
This package primarly supports Python, Web3.p3 and Brownie developers. For other programming languages and frameworks, you can find precompiled Solidity smart contracts in abi folder.
These files are good to go with any framework:
- Web3.js
- Ethers.js
- Hardhat
- Truffle
- Web3j
Each JSON file has abi and bytecode keys you need to deploy a contract.
Just download and embed in your project. The compiled source code files are mixture of MIT and GPL v2 license.
Python usage
The Python support is available as web3-ethereum-defi Python package.
The package depends only on web3.py and not others, like Brownie. It grabs popular ABI files with their bytecode and compilation artifacts so that the contracts are easily deployable on any Ethereum tester interface. No Ganache is needed and everything can be executed on faster eth-tester enginer.
Unlike Brownie, which is a framework, web3-ethereum-defi is a library. It is designed
to be included in any other Python application and you can only use bits of its that you need.
There are no expectations on configuration files or folder structure.
[Read the full API documentation](High-quality API documentation](https://web3-ethereum-defi.readthedocs.io/)). For code examples please see below.
Prerequisites
- Python 3.9 or higher
- Proficient in Python programming
- Understanding of Web3.py library
- pytest basics
ERC-20 token example
To use the package to deploy a simple ERC-20 token in pytest testing:
import pytest
from web3 import Web3, EthereumTesterProvider
from eth_defi.token import create_token
@pytest.fixture
def tester_provider():
return EthereumTesterProvider()
@pytest.fixture
def eth_tester(tester_provider):
return tester_provider.ethereum_tester
@pytest.fixture
def web3(tester_provider):
return Web3(tester_provider)
@pytest.fixture()
def deployer(web3) -> str:
"""Deploy account."""
return web3.eth.accounts[0]
@pytest.fixture()
def user_1(web3) -> str:
"""User account."""
return web3.eth.accounts[1]
@pytest.fixture()
def user_2(web3) -> str:
"""User account."""
return web3.eth.accounts[2]
def test_deploy_token(web3: Web3, deployer: str):
"""Deploy mock ERC-20."""
token = create_token(web3, deployer, "Hentai books token", "HENTAI", 100_000 * 10**18)
assert token.functions.name().call() == "Hentai books token"
assert token.functions.symbol().call() == "HENTAI"
assert token.functions.totalSupply().call() == 100_000 * 10**18
assert token.functions.decimals().call() == 18
def test_tranfer_tokens_between_users(web3: Web3, deployer: str, user_1: str, user_2: str):
"""Transfer tokens between users."""
token = create_token(web3, deployer, "Telos EVM rocks", "TELOS", 100_000 * 10**18)
# Move 10 tokens from deployer to user1
token.functions.transfer(user_1, 10 * 10**18).transact({"from": deployer})
assert token.functions.balanceOf(user_1).call() == 10 * 10**18
# Move 10 tokens from deployer to user1
token.functions.transfer(user_2, 6 * 10**18).transact({"from": user_1})
assert token.functions.balanceOf(user_1).call() == 4 * 10**18
assert token.functions.balanceOf(user_2).call() == 6 * 10**18
For more information how to user Web3.py in testing, see Web3.py documentation.
Uniswap v2 trade example
import pytest
from web3 import Web3
from web3.contract import Contract
from eth_defi.uniswap_v2.deployment import UniswapV2Deployment, deploy_trading_pair, FOREVER_DEADLINE
def test_swap(web3: Web3, deployer: str, user_1: str, uniswap_v2: UniswapV2Deployment, weth: Contract, usdc: Contract):
"""User buys WETH on Uniswap v2 using mock USDC."""
# Create the trading pair and add initial liquidity
deploy_trading_pair(
web3,
deployer,
uniswap_v2,
weth,
usdc,
10 * 10**18, # 10 ETH liquidity
17_000 * 10**18, # 17000 USDC liquidity
)
router = uniswap_v2.router
# Give user_1 500 dollars to buy ETH and approve it on the router
usdc_amount_to_pay = 500 * 10**18
usdc.functions.transfer(user_1, usdc_amount_to_pay).transact({"from": deployer})
usdc.functions.approve(router.address, usdc_amount_to_pay).transact({"from": user_1})
# Perform a swap USDC->WETH
path = [usdc.address, weth.address] # Path tell how the swap is routed
# https://docs.uniswap.org/protocol/V2/reference/smart-contracts/router-02#swapexacttokensfortokens
router.functions.swapExactTokensForTokens(
usdc_amount_to_pay,
0,
path,
user_1,
FOREVER_DEADLINE,
).transact({
"from": user_1
})
# Check the user_1 received ~0.284 ethers
assert weth.functions.balanceOf(user_1).call() / 1e18 == pytest.approx(0.28488156127668085)
Uniswap v2 price estimation example
# Create the trading pair and add initial liquidity
deploy_trading_pair(
web3,
deployer,
uniswap_v2,
weth,
usdc,
1_000 * 10**18, # 1000 ETH liquidity
1_700_000 * 10**18, # 1.7M USDC liquidity
)
# Estimate the price of buying 1 ETH
usdc_per_eth = estimate_buy_price_decimals(
uniswap_v2,
weth.address,
usdc.address,
Decimal(1.0),
)
assert usdc_per_eth == pytest.approx(Decimal(1706.82216820632059904))
How to use the library in your Python project
Add web3-ethereum-defi as a development dependency:
Using Poetry:
# Data optional dependencies include pandas and gql, needed to fetch Uniswap v3 data
poetry add -D "web3-ethereum-defi[data]"
Documentation
Development and contributing
Version history
Social media
Notes
Currently there is no Brownie support. To support Brownie, one would need to figure out how to import an existing Hardhat based project (Sushiswap) to Brownie project format.
History
Originally created for Trading Strategy. Originally the package was known as eth-hentai.
License
MIT
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 web3_ethereum_defi-0.10-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 223a83189a25c96a371d6c89f26f92fe8396894798bcc36e4cd1285492391ac8 |
|
| MD5 | 35c404ee1c066183bbcb57db043cb42f |
|
| BLAKE2b-256 | 6d8cec9be8be9474f076e3c84fc0277fad26bf7c80660dab437cfa822e9fa337 |
