Skip to content

Commit 6f923ee

Browse files
committed
update EthereumTesterProvider docs
1 parent 283b536 commit 6f923ee

File tree

2 files changed

+16
-11
lines changed

2 files changed

+16
-11
lines changed

docs/providers.rst

Lines changed: 15 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -568,22 +568,26 @@ explicitly.
568568
EthereumTesterProvider
569569
~~~~~~~~~~~~~~~~~~~~~~
570570

571-
.. warning:: Experimental: This provider is experimental. There are still significant gaps in
572-
functionality. However it is being actively developed and supported.
571+
.. warning:: Experimental: This provider is experimental. There are still significant
572+
gaps in functionality. However it is being actively developed and supported.
573573

574-
.. py:class:: EthereumTesterProvider(eth_tester=None)
574+
.. py:class:: EthereumTesterProvider(ethereum_tester=None, api_endpoints=None)
575+
.. py:class:: AsyncEthereumTesterProvider(ethereum_tester=None, api_endpoints=None)
575576
576-
This provider integrates with the ``eth-tester`` library. The ``eth_tester`` constructor
577-
argument should be an instance of the :class:`~eth_tester.EthereumTester` or a subclass of
578-
:class:`~eth_tester.backends.base.BaseChainBackend` class provided by the ``eth-tester`` library.
579-
If you would like a custom eth-tester instance to test with, see the
580-
``eth-tester`` library `documentation <https://github.com/ethereum/eth-tester>`_ for details.
577+
This provider integrates with the ``eth-tester`` library. The ``ethereum_tester``
578+
constructor argument should be an instance of the :class:`~eth_tester.EthereumTester`
579+
or a subclass of :class:`~eth_tester.backends.base.BaseChainBackend` class provided
580+
by the ``eth-tester`` library. The ``api_endpoints`` argument should be a ``dict``
581+
of RPC endpoints. You can see the structure and defaults `here <https://github.com/ethereum/web3.py/blob/283b536c7d53e605c61468941e3fc07a6c5d0c09/web3/providers/eth_tester/defaults.py#L228>`_.
582+
If you would like a custom ``eth-tester`` instance to test with, see the
583+
``eth-tester`` library `documentation <https://github.com/ethereum/eth-tester>`_
584+
for details.
581585

582586
.. code-block:: python
583587
584588
>>> from web3 import Web3, EthereumTesterProvider
585589
>>> w3 = Web3(EthereumTesterProvider())
586590
587-
.. NOTE:: To install the needed dependencies to use EthereumTesterProvider, you can install the
588-
pip extras package that has the correct interoperable versions of the ``eth-tester``
589-
and ``py-evm`` dependencies needed: e.g. ``pip install web3[tester]``
591+
.. NOTE:: To install the needed dependencies to use EthereumTesterProvider, you can
592+
install the pip extras package that has the correct interoperable versions of the
593+
``eth-tester`` and ``py-evm`` dependencies needed: e.g. ``pip install "web3[tester]"``

newsfragments/3500.docs.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Fix ``EthereumTesterProvider`` signature in docs, added an ``eth_tester`` example.

0 commit comments

Comments
 (0)