"""Web3 connection configuration."""
import logging
from dataclasses import field, dataclass
from typing import Dict, Optional, List
from eth_defi.gas import GasPriceMethod, node_default_gas_price_strategy
from eth_defi.hotwallet import HotWallet
from eth_defi.middleware import http_retry_request_with_sleep_middleware
from eth_defi.provider.broken_provider import set_block_tip_latency
from eth_defi.provider.multi_provider import MultiProviderWeb3, create_multi_provider_web3
from tradeexecutor.monkeypatch.web3 import construct_sign_and_send_raw_middleware
from tradingstrategy.chain import ChainId
from web3 import Web3, HTTPProvider
from web3.middleware import geth_poa_middleware
from tradeexecutor.utils.url import get_url_domain
#: List of currently supportd EVM blockchains
SUPPORTED_CHAINS = [
ChainId.ethereum,
ChainId.avalanche,
ChainId.polygon,
ChainId.bsc,
ChainId.arbitrum,
ChainId.anvil
]
#: Funny chain ids used. e.g. with mainnet forks
TEST_CHAIN_IDS: List[ChainId] = [
ChainId.ethereum_tester,
ChainId.anvil,
]
logger = logging.getLogger(__name__)
[docs]@dataclass
class Web3Config:
"""Advanced Web3 connection manager.
Supports multiple blockchain connections.
"""
#: Mapping of different connections for different chains
connections: Dict[ChainId, MultiProviderWeb3] = field(default_factory=dict)
#: How do we price our txs
gas_price_method: Optional[GasPriceMethod] = None
#: Chain id for single chain strategies
default_chain_id: Optional[ChainId] = None
[docs] @staticmethod
def create_web3(
configuration_line: str,
gas_price_method: Optional[GasPriceMethod] = None,
unit_testing: bool=False,
) -> MultiProviderWeb3:
"""Create a new Web3.py connection.
:param configuration_line:
JSON-RPC configuration line.
May contain several space separated entries.
:param gas_price_method:
How do we estimate gas for a transaction
If not given autodetect the method.
:parma unit_testing:
Are we executing against unit testing JSON-RPC endpoints.
If so set latency to zero.
"""
assert type(configuration_line) == str, f"Got: {configuration_line.__class__}"
web3 = create_multi_provider_web3(configuration_line)
# Read numeric chain id from JSON-RPC
chain_id = web3.eth.chain_id
if gas_price_method is None:
if chain_id in (ChainId.ethereum.value, ChainId.ganache.value, ChainId.avalanche.value, ChainId.polygon.value, ChainId.anvil.value, ChainId.arbitrum.value):
# Ethereum supports maxBaseFee method (London hard fork)
# Same for Avalanche C-chain https://twitter.com/avalancheavax/status/1389763933448323073
gas_price_method = GasPriceMethod.london
else:
# Other nodes have the legacy method
#
# File "/Users/moo/Library/Caches/pypoetry/virtualenvs/trade-executor-8Oz1GdY1-py3.10/lib/python3.10/site-packages/web3/contract.py", line 1672, in build_transaction_for_function
# prepared_transaction = fill_transaction_defaults(web3, prepared_transaction)
# File "cytoolz/functoolz.pyx", line 249, in cytoolz.functoolz.curry.__call__
# File "/Users/moo/Library/Caches/pypoetry/virtualenvs/trade-executor-8Oz1GdY1-py3.10/lib/python3.10/site-packages/web3/_utils/transactions.py", line 114, in fill_transaction_defaults
# default_val = default_getter(web3, transaction)
# File "/Users/moo/Library/Caches/pypoetry/virtualenvs/trade-executor-8Oz1GdY1-py3.10/lib/python3.10/site-packages/web3/_utils/transactions.py", line 64, in <lambda>
# web3.eth.max_priority_fee + (2 * web3.eth.get_block('latest')['baseFeePerGas'])
# File "/Users/moo/Library/Caches/pypoetry/virtualenvs/trade-executor-8Oz1GdY1-py3.10/lib/python3.10/site-packages/web3/datastructures.py", line 51, in __getitem__
# return self.__dict__[key] # type: ignore
# KeyError: 'baseFeePerGas'
gas_price_method = GasPriceMethod.legacy
assert isinstance(gas_price_method, GasPriceMethod)
chain_id_obj = ChainId(chain_id)
rpc_urls = [get_url_domain(rpc) for rpc in configuration_line.split()]
logger.info("Chain %s connects using %s", chain_id_obj.name, rpc_urls)
logger.trade("Connected to chain: %s, gas pricing method: %s, providers %s",
chain_id_obj.name,
gas_price_method.name,
rpc_urls,
)
# London is the default method
if gas_price_method == GasPriceMethod.legacy:
logger.info("Setting up gas price middleware for Web3")
web3.eth.set_gas_price_strategy(node_default_gas_price_strategy)
if unit_testing:
set_block_tip_latency(web3, 0)
return web3
[docs] def close(self):
"""Close all connections."""
# Web3.py does not offer close
pass
[docs] def choose_single_chain(self):
"""Set the default chain we are connected to.
Ensure we have exactly 1 JSON-RPC endpoint configured.
"""
assert len(self.connections) == 1, f"Expected a single web3 connection, got JSON-RPC for chains {list(self.connections.keys())}"
default_chain_id = next(iter(self.connections.keys()))
self.set_default_chain(default_chain_id)
self.check_default_chain_id()
[docs] def set_default_chain(self, chain_id: ChainId):
"""Set the default chain our strategy runs on.
Most strategies are single chain strategies.
Set the chain id we expect these strategies to run on.
"""
assert isinstance(chain_id, ChainId), f"Attempt to set null chain as the default: {chain_id}"
self.default_chain_id = chain_id
[docs] def get_connection(self, chain_id: ChainId) -> Optional[Web3]:
"""Get a connection to a specific network."""
return self.connections[chain_id]
[docs] def get_default(self) -> Web3:
"""Getst the default connection.
Assumes exactly 1 node connection available.
"""
assert self.default_chain_id, "No default chain id set"
try:
return self.connections[self.default_chain_id]
except KeyError:
raise RuntimeError(f"We have {self.default_chain_id.name} configured as the default blockchain, but we do not have a connection for it in the connection pool. Did you pass right RPC configuration?")
[docs] def check_default_chain_id(self):
"""Check that we are connected to the correct chain.
The JSON-RPC node chain id should be the same as in the strategy module.
"""
assert self.default_chain_id, "default_chain_id not set"
web3 = self.get_default()
if self.default_chain_id not in TEST_CHAIN_IDS:
assert web3.eth.chain_id == self.default_chain_id.value, f"Expected chain id {self.default_chain_id}, got {web3.eth.chain_id}"
[docs] @classmethod
def setup_from_environment(cls,
gas_price_method: Optional[GasPriceMethod],
unit_testing: bool=False,
**kwargs) -> "Web3Config":
"""Setup connections based on given RPC URLs.
Read `JSON_RPC_BINANCE`, `JSON_RPC_POLYGON`, etc.
environment variables.
:param kwargs:
{json_rpc_xxx: rpc URL} dict, as parsed by Typer.
"""
web3config = Web3Config()
web3config.gas_price_method = gas_price_method
# Lowercase all key names
kwargs = {k.lower(): v for k, v in kwargs.items()}
for chain_id in SUPPORTED_CHAINS:
key = f"json_rpc_{chain_id.get_slug()}"
configuration_line = kwargs.get(key)
if configuration_line:
web3config.connections[chain_id] = Web3Config.create_web3(configuration_line, gas_price_method, unit_testing=unit_testing)
return web3config
def has_any_connection(self):
return len(self.connections) > 0
[docs] def is_mainnet_fork(self) -> bool:
"""Is this connection a testing fork of a mainnet."""
return len(self.connections) and self.connections.get(ChainId.anvil.value) is not None
[docs] def add_hot_wallet_signing(self, hot_wallet: HotWallet):
"""Make web3.py native signing available in the console."""
assert isinstance(hot_wallet, HotWallet)
for web3 in self.connections.values():
web3.middleware_onion.add(construct_sign_and_send_raw_middleware(hot_wallet.account))
hot_wallet.sync_nonce(web3)