RPCProxyConfig

Documentation for eth_defi.provider.rpc_proxy.RPCProxyConfig Python class.

class RPCProxyConfig

Bases: object

Configuration for the JSON-RPC failover proxy.

Collects all tuneable parameters of start_rpc_proxy() into a single object with sensible defaults. Every field has a docstring explaining its purpose, default value, and interaction with other fields.

You can construct this directly and pass it to start_rpc_proxy(), or pass it as the proxy_multiple_upstream argument to launch_anvil().

Example — standalone proxy with custom configuration:

from eth_defi.provider.rpc_proxy import RPCProxyConfig, start_rpc_proxy

config = RPCProxyConfig(
    timeout=15.0,
    retries=5,
    auto_switch_request_count=50,
)
proxy = start_rpc_proxy(
    ["https://rpc-a.example.com", "https://rpc-b.example.com"],
    config=config,
)

Example — passing to launch_anvil:

from eth_defi.provider.anvil import launch_anvil
from eth_defi.provider.rpc_proxy import RPCProxyConfig

config = RPCProxyConfig(timeout=10.0, retries=4)
launch = launch_anvil(
    fork_url="https://rpc-a.example.com https://rpc-b.example.com",
    proxy_multiple_upstream=config,
)

See also RPCProxy, start_rpc_proxy(), default_failure_handler().

Attributes summary

name
timeout
retries
backoff
auto_switch_request_count
switchover_log_level
request_log_level
log_max_size
pool_maxsize
max_error_replies
failure_handler

Methods summary

__init__([name, timeout, retries, backoff, ...])
describe()	Return a human-readable summary of the configuration for logging.

__init__(name=None, timeout=30.0, retries=3, backoff=0.5, auto_switch_request_count=0, switchover_log_level=20, request_log_level=10, log_max_size=2048, pool_maxsize=50, max_error_replies=100, failure_handler=None)

Parameters

• name (Optional[str]) –

• timeout (float) –

• retries (int) –

• backoff (float) –

• auto_switch_request_count (int) –

• switchover_log_level (int) –

• request_log_level (int) –

• log_max_size (int) –

• pool_maxsize (int) –

• max_error_replies (int) –

• failure_handler (Callable[[int, Optional[dict]], bool]) –

Return type

None

describe()

Return a human-readable summary of the configuration for logging.

Includes all tuneable numeric fields for full visibility.

Example output:

timeout=30.0, retries=3, backoff=0.5, auto_switch_request_count=0, pool_maxsize=50, max_error_replies=100, log_max_size=2048

Return type

str