From da9ad3299649ad80bb39346683e82d1aa6abe708 Mon Sep 17 00:00:00 2001 From: Marc Garreau <3621728+marcgarreau@users.noreply.github.com> Date: Mon, 26 Apr 2021 16:50:32 -0600 Subject: [PATCH] document call state overrides --- docs/web3.eth.rst | 6 +++++- newsfragments/1965.doc.rst | 1 + 2 files changed, 6 insertions(+), 1 deletion(-) create mode 100644 newsfragments/1965.doc.rst diff --git a/docs/web3.eth.rst b/docs/web3.eth.rst index 94c1d80f42..dfe8ff695b 100644 --- a/docs/web3.eth.rst +++ b/docs/web3.eth.rst @@ -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 @@ -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 `_ + for a list of possible parameters. + .. py:method:: Eth.estimate_gas(transaction, block_identifier=None) diff --git a/newsfragments/1965.doc.rst b/newsfragments/1965.doc.rst new file mode 100644 index 0000000000..942a7bdaf6 --- /dev/null +++ b/newsfragments/1965.doc.rst @@ -0,0 +1 @@ +Document ``eth_call`` state overrides.