diff --git a/docs/source/api/index.rst b/docs/source/api/index.rst index 8d50de81..30c78ff3 100644 --- a/docs/source/api/index.rst +++ b/docs/source/api/index.rst @@ -14,7 +14,7 @@ API documentation :maxdepth: 1 core/index - provier/index + provider/index usdc/index uniswap_v2/index uniswap_v3/index diff --git a/docs/source/api/provider/index.rst b/docs/source/api/provider/index.rst index 2c3fdae4..ccc94d00 100644 --- a/docs/source/api/provider/index.rst +++ b/docs/source/api/provider/index.rst @@ -1,7 +1,7 @@ -JSON-RPC API provider integrations ----------------------------------- +JSON-RPC provider API +--------------------- -This submodule offers functionality to connect and enhance robustness of various EVM JSON-RPC APIs. +This submodule offers functionality to connect and enhance robustness of various EVM JSON-RPC API providers.. - Support for test and mainnet fork backends like :py:mod:`eth_defi.provider.anvil` and :py:mod:`eth_defi.provider.ganache` @@ -9,6 +9,8 @@ This submodule offers functionality to connect and enhance robustness of various - Using multiple JSON-APRC providers and fallback providers +- For the list of available Ethereum, Binance Smart Chain and such API providers please see `ethereumnodes.com `__ + .. autosummary:: :toctree: _autosummary_provider :recursive: diff --git a/eth_defi/provider/mev_blocker.py b/eth_defi/provider/mev_blocker.py index c1dc7e37..4ed4baae 100644 --- a/eth_defi/provider/mev_blocker.py +++ b/eth_defi/provider/mev_blocker.py @@ -1,12 +1,17 @@ """MEV blocking RPC provider functionality. -Malicious Extractable Value (MEV) is a nuisance on all -EVM-based blockchains. It can be mitigated by using a special +`Malicious Extractable Value (MEV) `__ +is a problem for all trading activity on EVM-based blockchains. + +It can be mitigated by using a special JSON-RPC node that provides a private mempool. + This module provides methods to create special -:py:class:`web3.Web3` instances that use MEV blocking -JSON-RPC endpoint for all transactions, but a normal JSON-RPC -node for reading data from the blockchain. +:py:class:`web3.Web3` instances that + +- Use MEV blocking JSON-RPC endpoint for all transactions + +- Normal JSON-RPC node for reading data from the blockchain """ from collections import Counter