Add multi RPC documentation

docs/source/tutorials/index.rst

@@ -48,6 +48,7 @@ Example tutorials
    live-swap
    aave-v3-interest-analysis
    slippage-and-price-impact
+   multi-rpc-configuration
 
 `For more examples, browse tests folder on Github <https://github.com/tradingstrategy-ai/web3-ethereum-defi/tree/master/tests>`__.
 You can also search function names in `the repository <https://github.com/tradingstrategy-ai/web3-ethereum-defi/>`__

docs/source/tutorials/multi-rpc-configuration.rst

@@ -0,0 +1,36 @@
+.. _multi rpc:
+
+Configuring multiple RPC endpoints
+==================================
+
+The package supports creating :py:class:`eth_defi.provider.multi_provider.MultiProviderWeb3`
+instances of :py:class:`Web3` core connector.
+
+These instances support multiple JSON-RPC providers, mainly
+
+- Automatic fallback to another JSON-RPC provider when one fails
+
+- Using `Malicious Extractable Value protection <https://tradingstrategy.ai/glossary/mev>`__
+  with a special endpoints when broadcasting a transaction
+
+Configuring
+-----------
+
+The multi RPC endpoints can be created with :py:func:`eth_defi.provider.multi_provider.create_multi_provider_web3`.
+
+Instead of giving a single RPC endpoint URL, you give a list URLs.
+
+- List can be newline separated or space separated
+
+- For MEV protection endpoint, you prefix your URL with `mev+`
+
+Example:
+
+.. code-block::
+
+    # Uses MEVblocker.io to broadcast transactions
+    # and two separate nodes for reading blockchain data
+    config = "mev+https://rpc.mevblocker.io https://myethereumnode1.example.com https://fallback.example.com"
+    web3 = create_multi_provider_web3(config)
+
+

eth_defi/provider/multi_provider.py

@@ -1,4 +1,7 @@
-"""Configuring and managing multiple JSON-RPC provider connections."""
+"""Configuring and managing multiple JSON-RPC provider connections.
+
+See :ref:`multi rpc` for details.
+"""
 
 import logging
 from typing import List
@@ -28,7 +31,12 @@ class MultiProviderWeb3(Web3):
 
     - There might be several providers for reading on-chain data
 
-    See :py:func:`create_multi_provider_web3`
+    See
+
+    - :ref:`multi rpc` for details
+
+    - :py:func:`create_multi_provider_web3`
+
     """
 
     def get_active_transact_provider(self) -> NamedProvider:
@@ -111,6 +119,10 @@ def create_multi_provider_web3(
         assert len(web3.get_fallback_provider().providers) == 2
         assert get_provider_name(web3.get_active_transact_provider()) == "rpc.mevblocker.io"
 
+    See
+
+    - - :ref:`multi rpc` for details
+
     :param configuration_line:
         Configuration line from an environment variable, config file or similar.
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "web3-ethereum-defi"
-version = "0.22.1"
+version = "0.22.2"
 description = "Python library for Uniswap, Aave, ChainLink, Enzyme and other protocols on BNB Chain, Polygon, Ethereum and other blockchains"
 authors = ["Mikko Ohtamaa <[email protected]>"]
 license = "MIT"