Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document call state overrides #1965

Merged
merged 1 commit into from
Apr 28, 2021
Merged

Document call state overrides #1965

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion docs/web3.eth.rst
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Document ``eth_call`` state overrides.