From 01518219cd74fc1a016ca6615158fe52daa94722 Mon Sep 17 00:00:00 2001 From: Gregory Markou <16929357+GregTheGreek@users.noreply.github.com> Date: Tue, 11 Aug 2020 12:00:08 +0300 Subject: [PATCH] closes #3456" (#3679) Co-authored-by: Frankie --- docs/web3-eth-contract.rst | 5 +++-- docs/web3-eth.rst | 1 + 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/docs/web3-eth-contract.rst b/docs/web3-eth-contract.rst index db72e3c122d..a15a9b1025b 100644 --- a/docs/web3-eth-contract.rst +++ b/docs/web3-eth-contract.rst @@ -590,7 +590,7 @@ Returns - ``Array`` - arguments: The arguments passed to the method before. They can be changed. - ``Function`` - :ref:`send `: Will deploy the contract. The promise will resolve with the new contract instance, instead of the receipt! -- ``Function`` - :ref:`estimateGas `: Will estimate the gas used for deploying. +- ``Function`` - :ref:`estimateGas `: Will estimate the gas used for deploying. Note: You must specify a ``from`` address otherwise you may experience odd behavior. - ``Function`` - :ref:`encodeABI `: Encodes the ABI of the deployment, which is contract data + constructor parameters ------- @@ -688,7 +688,7 @@ Returns - ``Array`` - arguments: The arguments passed to the method before. They can be changed. - ``Function`` - :ref:`call `: Will call the "constant" method and execute its smart contract method in the EVM without sending a transaction (Can't alter the smart contract state). - ``Function`` - :ref:`send `: Will send a transaction to the smart contract and execute its method (Can alter the smart contract state). -- ``Function`` - :ref:`estimateGas `: Will estimate the gas used when the method would be executed on chain. +- ``Function`` - :ref:`estimateGas `: Will estimate the gas used when the method would be executed on chain. Note: You must specify a ``from`` address otherwise you may experience odd behavior. - ``Function`` - :ref:`encodeABI `: Encodes the ABI for this method. This can be send using a transaction, call the method or passing into another smart contracts method as argument. ------- @@ -937,6 +937,7 @@ methods.myMethod.estimateGas Will call to estimate the gas a method execution will take when executed in the EVM. The estimation can differ from the actual gas used when later sending a transaction, as the state of the smart contract can be different at that time. +Note: You must specify a ``from`` address otherwise you may experience odd behavior. ---------- Parameters diff --git a/docs/web3-eth.rst b/docs/web3-eth.rst index 7f3cdce4844..bd7a8906619 100644 --- a/docs/web3-eth.rst +++ b/docs/web3-eth.rst @@ -1722,6 +1722,7 @@ estimateGas web3.eth.estimateGas(callObject [, callback]) Executes a message call or transaction and returns the amount of the gas used. +Note: You must specify a ``from`` address otherwise you may experience odd behavior. ---------- Parameters