Skip to content
This repository was archived by the owner on Mar 5, 2025. It is now read-only.

Commit 0151821

Browse files
closes #3456" (#3679)
Co-authored-by: Frankie <[email protected]>
1 parent f056900 commit 0151821

File tree

2 files changed

+4
-2
lines changed

2 files changed

+4
-2
lines changed

docs/web3-eth-contract.rst

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -590,7 +590,7 @@ Returns
590590

591591
- ``Array`` - arguments: The arguments passed to the method before. They can be changed.
592592
- ``Function`` - :ref:`send <contract-send>`: Will deploy the contract. The promise will resolve with the new contract instance, instead of the receipt!
593-
- ``Function`` - :ref:`estimateGas <contract-estimateGas>`: Will estimate the gas used for deploying.
593+
- ``Function`` - :ref:`estimateGas <contract-estimateGas>`: Will estimate the gas used for deploying. Note: You must specify a ``from`` address otherwise you may experience odd behavior.
594594
- ``Function`` - :ref:`encodeABI <contract-encodeABI>`: Encodes the ABI of the deployment, which is contract data + constructor parameters
595595

596596
-------
@@ -688,7 +688,7 @@ Returns
688688
- ``Array`` - arguments: The arguments passed to the method before. They can be changed.
689689
- ``Function`` - :ref:`call <contract-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).
690690
- ``Function`` - :ref:`send <contract-send>`: Will send a transaction to the smart contract and execute its method (Can alter the smart contract state).
691-
- ``Function`` - :ref:`estimateGas <contract-estimateGas>`: Will estimate the gas used when the method would be executed on chain.
691+
- ``Function`` - :ref:`estimateGas <contract-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.
692692
- ``Function`` - :ref:`encodeABI <contract-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.
693693

694694
-------
@@ -937,6 +937,7 @@ methods.myMethod.estimateGas
937937
938938
Will call to estimate the gas a method execution will take when executed in the EVM.
939939
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.
940+
Note: You must specify a ``from`` address otherwise you may experience odd behavior.
940941

941942
----------
942943
Parameters

docs/web3-eth.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1722,6 +1722,7 @@ estimateGas
17221722
web3.eth.estimateGas(callObject [, callback])
17231723
17241724
Executes a message call or transaction and returns the amount of the gas used.
1725+
Note: You must specify a ``from`` address otherwise you may experience odd behavior.
17251726

17261727
----------
17271728
Parameters

0 commit comments

Comments
 (0)