Skip to content

Commit

Permalink
document call state overrides
Browse files Browse the repository at this point in the history
  • Loading branch information
wolovim committed Apr 26, 2021
1 parent f47f4f6 commit da9ad32
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/web3.eth.rst
Original file line number Diff line number Diff line change
Expand Up @@ -938,7 +938,7 @@ The following methods are available on the ``web3.eth`` namespace.
.. warning:: Deprecated: This property is deprecated in favor of
:meth:`~web3.eth.Eth.sign_typed_data()`

.. py:method:: Eth.call(transaction, block_identifier=web3.eth.default_block)
.. py:method:: Eth.call(transaction, block_identifier=web3.eth.default_block, state_override=None)
* Delegates to ``eth_call`` RPC Method

Expand All @@ -960,6 +960,10 @@ The following methods are available on the ``web3.eth`` namespace.
In most cases it is better to make contract function call through the :py:class:`web3.contract.Contract` interface.

Overriding state is a debugging feature available in Geth clients.
View their `usage documentation <https://geth.ethereum.org/docs/rpc/ns-eth#3-object---state-override-set>`_
for a list of possible parameters.


.. py:method:: Eth.estimate_gas(transaction, block_identifier=None)
Expand Down
1 change: 1 addition & 0 deletions newsfragments/1965.doc.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document ``eth_call`` state overrides.

0 comments on commit da9ad32

Please sign in to comment.