Edit MEV doc blurb

tradingstrategy-ai · Jul 22, 2023 · 4fe6139 · 4fe6139
1 parent d50468f
commit 4fe6139
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 9 deletions.
diff --git 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
@@ -1,14 +1,16 @@
-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`
 
 - `Malicious Extractable Value (MEV) <https://tradingstrategy.ai/glossary/mev>__` mitigations
 
 - 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 <https://ethereumnodes.com>`__
+
 .. autosummary::
  :toctree: _autosummary_provider
  :recursive:

diff --git 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) <https://tradingstrategy.ai/glossary/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