web3-ethereum-defi

Web3-Ethereum-Defi

Web-Ethereum-DeFi (eth_defi) allows you to integrate EVM-compatible Web3 and DeFi protocols into your Python application.

• Use cases
• Supported protocols, chains and integrations
• Prerequisites
• Install
• Example code
  • Uniswap swap example
• How to use the library in your Python project
• Documentation
• Development and contributing
• Version history
• Support
• Social media
• License

Use cases

Use cases for this package include

• Trading and bots
• Data research, extraction, transformation and loading
• Portfolio management and accounting
• System integrations and backends
• AI agent interaction for EVM chains

Supported protocols, chains and integrations

Protocol	Actions	Tutorial and API links
Uniswap	Token swaps, data research	Tutorial
Gnosis Safe	Safe deployment customisation and modules	API
Circle USDC	USDC interactions	API
Circle CCTP V2	Cross-chain USDC transfers (burn-and-mint)	API
LI.FI	Cross-chain bridge, gas feeding	API Tutorial
ChainLink	Read oracle prices, set up oracles	Tutorial
CoW Swap	Swaps, vault integration	Tutorial
PancakeSwap	Token swaps, data research	Tutorial
GMX	Leveraged trading, spot trading	API Tutorial
Derive	Perpetuals, options trading	API
gTrade	Leveraged trading, vaults	API Listing
Ostium	Leveraged trading, vaults	API Listing
LFG	Token swaps, data research	API
Aave	Credit, borrow, read rates	Tutorial
BENQI	Credit, borrow, read rates	API
Lendle	Credit, borrow, read rates	API
Sky (MakerDAO)	Savings vaults	API Listing
Enzyme	Deposit to vaults, deploy, read vault data	Tutorial
Lagoon	Deposit to vaults, deploy, read vault data	API Listing
Velvet	Deposit to vaults, deploy, read vault data	API
Morpho	Read vault data	Tutorial
Euler	Read vault data	API Listing
Ethena	Read vault data	API Listing
IPOR	Read vault data	API Listing
1delta	Open/close leveraged long/short positions	API
Yearn	Read vault data	API Listing
NashPoint	Read vault data	API Listing
Untangle Finance	Read vault data	API Listing
Atoma	Read data, deposit, request and claim withdrawals through Guard/Safe	API Listing
Plutus	Read vault data	API Listing
D2 Finance	Read vault data	API Listing
Umami Finance	Read vault data	API Listing
Harvest Finance	Read vault data	API Listing
USDAi	Read vault data	API Listing
AUTO Finance	Read vault data	API Listing
Goat Protocol	Read vault data	API Listing
Cap	Read vault data	API Listing
Centrifuge	Read vault data	API Listing
C-Sigma	Read vault data	API Listing
Deltr	Read vault data	API
Foxify	Read vault data	API Listing
Liquid Royalty	Read vault data	API Listing
LLamma	Read vault data	API Listing
Maple	Read vault data	API Listing
Silo	Read vault data	API Listing
Spark	Read vault data	API Listing
Summer	Read vault data	API Listing
Superform	Read vault data	API Listing
Teller	Read vault data	API Listing
Term Finance	Read vault data	API Listing
TrueFi	Read vault data	API Listing
Upshift	Read vault data	API Listing
USDD	Read vault data	API
Aarna	Read vault data	API
Accountable	Read vault data	API
Altura	Read vault data	API
Avant	Read vault data	API
Brink	Read vault data	API
Curvance	Read vault data	API
Dolomite	Read vault data	API
Eth Strategy	Read vault data	API
Fluid	Read vault data	API
Frax	Read vault data	API
Gearbox	Read vault data	API
Hyperlend	Read vault data	API
HypurrFi	Read vault data	API
InfiniFi	Read vault data	API
Mainstreet	Read vault data	API
Renalta	Read vault data	API
Resolv	Read vault data	API
Royco	Read vault data	API
Sentiment	Read vault data	API
Singularity	Read vault data	API
Spectra	Read vault data	API
USDx Money	Read vault data	API
YieldFi	Read vault data	API
YieldNest	Read vault data	API
YO	Read vault data	API
Yuzu Money	Read vault data	API
ZeroLend	Read vault data	API
BaseVol	Read vault data	API Listing
Hypersync	Read historical data fast	API
Token Risk	Glider Token Risk API by Hexens	API
TokenSniffer	Read token risk core and metricws	API
Foundry	Compile, deploy and verify smart contracts	API
Etherscan	Deploy and verify smart contracts	API
MEVBlocker	Frontrun protection	Tutorial
Ethereum mainnet	Frontrun protection, token mapping	Tutorial
Base	Frontrun protection, token mapping	Tutorial
Arbitrum	Frontrun protection, token mapping	Tutorial
Avalanche	Token mapping	API
BNB chain	Token mapping	API
Polygon	Token mapping	API
BNB Chain	Token mapping	API
Berachain	Token mapping	API
Avalanche	Token mapping	API
Hyperliquid	Token mapping	API
Mode	Token mapping	API
Unichain	Token mapping	API
ZKSync	Token mapping	API
Soneium	Token mapping	API
Google GCloud	Support hardware security module wallets	API
Hot wallet	Secure hot wallet handling	API
Multicall3	Chunked and historical data reading	Tutorial
Gas	Ethereum gas management	API
EIP-4626	Vault analysis	Tutorial
EIP-726	Message signing and decoding	API
ERC-20	High performance reading, data mappings	API
ABI	High performance smart contract ABI management	API
Transactions	Stack traces and symbolic revert reasons	API
Anvil	Mainnet works and local unit testing	API
LlamaNodes	Special RPC support	API
Ankr	Special RPC support	API
dRPC	Special RPC support	API

👉 Read the full API documentation.

This is a MIT-licensed open source project. Those who sponsor and contribute get integrations.

Prerequisites

To use this package you need to

• Have Python 3.10 or newer. Python 3.14 is supported when installing the HyperSync extra through the temporary upstream package hypersync-temp.
• macOS, Linux or Windows Subsystem for Linux (WSL) needed, Microsoft Windows is not officially supported
  • For WSL, make sure you have gcc and other tools installed
• Be proficient in Python programming
• Understand of Web3.py library
• Understand Pytest basics

Install

With uv:

uv pip install "web3-ethereum-defi" --all-extras

With pip:

pip install "web3-ethereum-defi[data,test,docs,hypersync,ccxt,cloudflare_r2,duckdb]"

With poetry:

poetry add --extras "data test docs hypersync ccxt cloudflare_r2 duckdb" web3-ethereum-defi

From master Git branch:

git clone [email protected]:tradingstrategy-ai/web3-ethereum-defi.git
cd web3-ethereum-defi
poetry shell
poetry install --all-extras

Example code

See the tutorials section in the documentation for full code examples.

Uniswap swap example

• This example shows how to make a trade on Uniswap v3.
• The example is for Polygon, but works on other chains.
• See tutorials for more Uniswap and other DEX examples

import datetime
import decimal
import os
import sys
from decimal import Decimal

from eth_account import Account
from eth_account.signers.local import LocalAccount
from eth_defi.compat import construct_sign_and_send_raw_middleware

from eth_defi.provider.multi_provider import create_multi_provider_web3
from eth_defi.revert_reason import fetch_transaction_revert_reason
from eth_defi.token import fetch_erc20_details
from eth_defi.confirmation import wait_transactions_to_complete
from eth_defi.uniswap_v3.constants import UNISWAP_V3_DEPLOYMENTS
from eth_defi.uniswap_v3.deployment import fetch_deployment
from eth_defi.uniswap_v3.swap import swap_with_slippage_protection

# The address of a token we are going to swap out
#
# Use https://tradingstrategy.ai/search to find your token
#
# For quote terminology see https://tradingstrategy.ai/glossary/quote-token
#
QUOTE_TOKEN_ADDRESS = "0x3c499c542cef5e3811e1192ce70d8cc03d5c3359"  # USDC (native)

# The address of a token we are going to receive
#
# Use https://tradingstrategy.ai/search to find your token
#
# For base terminology see https://tradingstrategy.ai/glossary/base-token
BASE_TOKEN_ADDRESS = "0x7ceb23fd6bc0add59e62ac25578270cff1b9f619"  # WETH


# Connect to JSON-RPC node
rpc_env_var_name = "JSON_RPC_POLYGON"
json_rpc_url = os.environ.get(rpc_env_var_name)
assert json_rpc_url, f"You need to give {rpc_env_var_name} node URL. Check ethereumnodes.com for options"

# Create a Web3 provider with ability to retry failed requests
# and supporting fallback JSON-RPC nodes. RPC connections
# are extremely flaky and for production grade usage you need to use multiple
# JSON-RPC nodes.
# create_multi_provider_web3() will also take care of any chain-specific
# RPC setup.
web3 = create_multi_provider_web3(json_rpc_url)

print(f"Connected to blockchain, chain id is {web3.eth.chain_id}. the latest block is {web3.eth.block_number:,}")

# Grab Uniswap v3 smart contract addreses for Polygon.
#
deployment_data = UNISWAP_V3_DEPLOYMENTS["polygon"]
uniswap_v3 = fetch_deployment(
    web3,
    factory_address=deployment_data["factory"],
    router_address=deployment_data["router"],
    position_manager_address=deployment_data["position_manager"],
    quoter_address=deployment_data["quoter"],
)

print(f"Using Uniwap v3 compatible router at {uniswap_v3.swap_router.address}")

# Read and setup a local private key
private_key = os.environ.get("PRIVATE_KEY")
assert private_key is not None, "You must set PRIVATE_KEY environment variable"
assert private_key.startswith("0x"), "Private key must start with 0x hex prefix"
account: LocalAccount = Account.from_key(private_key)
my_address = account.address

# Enable eth_sendTransaction using this private key
web3.middleware_onion.add(construct_sign_and_send_raw_middleware(account))

# Read on-chain ERC-20 token data (name, symbol, etc.)
base = fetch_erc20_details(web3, BASE_TOKEN_ADDRESS)
quote = fetch_erc20_details(web3, QUOTE_TOKEN_ADDRESS)

# Native token balance
# See https://tradingstrategy.ai/glossary/native-token
gas_balance = web3.eth.get_balance(account.address)

print(f"Your address is {my_address}")
print(f"Your have {base.fetch_balance_of(my_address)} {base.symbol}")
print(f"Your have {quote.fetch_balance_of(my_address)} {quote.symbol}")
print(f"Your have {gas_balance / (10 ** 18)} for gas fees")

assert quote.fetch_balance_of(my_address) > 0, f"Cannot perform swap, as you have zero {quote.symbol} needed to swap"

# Ask for transfer details
decimal_amount = input(f"How many {quote.symbol} tokens you wish to swap to {base.symbol}? ")

# Some input validation
try:
    decimal_amount = Decimal(decimal_amount)
except (ValueError, decimal.InvalidOperation) as e:
    raise AssertionError(f"Not a good decimal amount: {decimal_amount}") from e

# Fat-fingering check
print(f"Confirm swap amount {decimal_amount} {quote.symbol} to {base.symbol}")
confirm = input("Ok [y/n]?")
if not confirm.lower().startswith("y"):
    print("Aborted")
    sys.exit(1)

# Convert a human-readable number to fixed decimal with 18 decimal places
raw_amount = quote.convert_to_raw(decimal_amount)

# Each DEX trade is two transactions
# - ERC-20.approve()
# - swap (various functions)
# This is due to bad design of ERC-20 tokens,
# more here https://twitter.com/moo9000/status/1619319039230197760

# Uniswap router must be allowed to spent our quote token
# and we do this by calling ERC20.approve() from our account
# to the token contract.
approve = quote.contract.functions.approve(uniswap_v3.swap_router.address, raw_amount)
tx_1 = approve.build_transaction(
    {
        # approve() may take more than 500,000 gas on Arbitrum One
        "gas": 850_000,
        "from": my_address,
    }
)

#
# Uniswap v3 may have multiple pools per
# trading pair differetiated by the fee tier. For example
# WETH-USDC has pools of 0.05%, 0.30% and 1%
# fees. Check for different options
# in https://tradingstrategy.ai/search
#
# Here we use 5 BPS fee pool (5/10,000).
#
#
# Build a swap tran

提示：代码过长已自动截断

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

• Browse API documentation.
• Browse tutorials.

Development and contributing

• Read development instructions.

Vault database maintenance

Use the numbered migration system to discover, preview and apply database repairs and persisted accessor refreshes. Standalone ad hoc repair scripts are legacy format and must not be used for these tasks anymore; port the reviewed operation into a new numbered script. The looped scanner must be stopped for previews and writes; restarting it performs normal publication.

Production uses the one-shot Compose service and reads the git commit stamped inside the image. No Docker image hash is needed:

source ../vault-rpc.env && docker compose run --rm --no-deps -e DRY_RUN=false --entrypoint vault-migrate vault-scanner-oneshot run

Version history

• Read changelog.
• See releases.

Support

• Join Discord for any questions.

Social media

• Watch tutorials on YouTube
• Follow on Twitter
• Follow on Telegram
• Follow on LinkedIn

License

MIT.

Created by Trading Strategy.