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

Clarify estimateGas docs #3679

Merged
merged 2 commits into from
Aug 11, 2020
Merged

Clarify estimateGas docs #3679

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b9111df
closes #3456"
GregTheGreek Aug 10, 2020
630558f
Merge branch '1.x' into greg/fix-docs
frankiebee Aug 11, 2020
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
5 changes: 3 additions & 2 deletions docs/web3-eth-contract.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -590,7 +590,7 @@ Returns

- ``Array`` - arguments: The arguments passed to the method before. They can be changed.
- ``Function`` - :ref:`send <contract-send>`: Will deploy the contract. The promise will resolve with the new contract instance, instead of the receipt!
- ``Function`` - :ref:`estimateGas <contract-estimateGas>`: Will estimate the gas used for deploying.
- ``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.
- ``Function`` - :ref:`encodeABI <contract-encodeABI>`: Encodes the ABI of the deployment, which is contract data + constructor parameters

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

-------
Expand Down Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions docs/web3-eth.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down