snakecase EstimateGas to estimate_gas

Author: tmckenzie51

docs/contracts.rst

@@ -229,7 +229,7 @@ Each Contract Factory exposes the following methods.
     will accept ENS names.
 
     If a ``gas`` value is not provided, then the ``gas`` value for the
-    deployment transaction will be created using the ``web3.eth.estimateGas()``
+    deployment transaction will be created using the ``web3.eth.estimate_gas()``
     method.
 
     Returns the transaction hash for the deploy transaction.
@@ -241,7 +241,7 @@ Each Contract Factory exposes the following methods.
         >>> txn_receipt['contractAddress']
         '0x4c0883a69102937d6231471b5dbb6204fe5129617082792ae468d01a3f362318'
 
-.. py:classmethod:: Contract.constructor(*args, **kwargs).estimateGas(transaction=None, block_identifier=None)
+.. py:classmethod:: Contract.constructor(*args, **kwargs).estimate_gas(transaction=None,block_identifier=None)
 
     Estimate gas for constructing and deploying the contract.
 
@@ -260,7 +260,7 @@ Each Contract Factory exposes the following methods.
 
     .. code-block:: python
 
-        >>> token_contract.constructor(web3.eth.coinbase, 12345).estimateGas()
+        >>> token_contract.constructor(web3.eth.coinbase, 12345).estimate_gas()
         12563
 
 .. py:classmethod:: Contract.constructor(*args, **kwargs).buildTransaction(transaction=None)
@@ -343,7 +343,7 @@ Each Contract Factory exposes the following methods.
     will accept ENS names.
 
     If a ``gas`` value is not provided, then the ``gas`` value for the
-    deployment transaction will be created using the ``web3.eth.estimateGas()``
+    deployment transaction will be created using the ``web3.eth.estimate_gas()``
     method.
 
     Returns the transaction hash for the deploy transaction.
@@ -765,7 +765,7 @@ Methods
     will accept ENS names.
 
     If a ``gas`` value is not provided, then the ``gas`` value for the
-    method transaction will be created using the ``web3.eth.estimateGas()``
+    method transaction will be created using the ``web3.eth.estimate_gas()``
     method.
 
     Returns the transaction hash.
@@ -823,7 +823,7 @@ Methods
         # You can check the state after your pending transactions (if supported by your node):
         >>> token_contract.functions.myBalance().call(block_identifier='pending')
 
-.. py:method:: ContractFunction.estimateGas(transaction, block_identifier=None)
+.. py:method:: ContractFunction.estimate_gas(transaction, block_identifier=None)
 
     Call a contract function, executing the transaction locally using the
     ``eth_call`` API.  This will not create a new public transaction.
@@ -832,7 +832,7 @@ Methods
 
     .. code-block:: python
 
-        myContract.functions.myMethod(*args, **kwargs).estimateGas(transaction)
+        myContract.functions.myMethod(*args, **kwargs).estimate_gas(transaction)
 
     This method behaves the same as the :py:meth:`ContractFunction.transact` method,
     with transaction details being passed into the end portion of the
@@ -843,7 +843,7 @@ Methods
 
     .. code-block:: python
 
-        >>> my_contract.functions.multiply7(3).estimateGas()
+        >>> my_contract.functions.multiply7(3).estimate_gas()
         42650
 
     .. note::
@@ -912,7 +912,7 @@ Fallback Function
     Call fallback function, executing the transaction locally using the
     ``eth_call`` API.  This will not create a new public transaction.
 
-.. py:method:: Contract.fallback.estimateGas(transaction)
+.. py:method:: Contract.fallback.estimate_gas(transaction)
 
     Call fallback function and return the gas estimation.
 

docs/examples.rst

@@ -333,7 +333,7 @@ The following example demonstrates a few things:
 
     store_var_contract = w3.eth.contract(address=address, abi=contract_interface["abi"])
 
-    gas_estimate = store_var_contract.functions.setVar(255).estimateGas()
+    gas_estimate = store_var_contract.functions.setVar(255).estimate_gas()
     print(f'Gas estimate to transact with setVar: {gas_estimate}')
 
     if gas_estimate < 100000:

docs/overview.rst

@@ -179,7 +179,7 @@ API
 - :meth:`web3.eth.get_transaction_receipt() <web3.eth.Eth.get_transaction_receipt>`
 - :meth:`web3.eth.sign() <web3.eth.Eth.sign>`
 - :meth:`web3.eth.signTypedData() <web3.eth.Eth.signTypedData>`
-- :meth:`web3.eth.estimateGas() <web3.eth.Eth.estimateGas>`
+- :meth:`web3.eth.estimate_gas() <web3.eth.Eth.estimate_gas>`
 - :meth:`web3.eth.generateGasPrice() <web3.eth.Eth.generateGasPrice>`
 - :meth:`web3.eth.setGasPriceStrategy() <web3.eth.Eth.setGasPriceStrategy>`
 

docs/web3.eth.rst

@@ -727,9 +727,9 @@ The following methods are available on the ``web3.eth`` namespace.
 
     If the ``transaction`` specifies a ``data`` value but does not specify
     ``gas`` then the ``gas`` value will be populated using the
-    :meth:`~web3.eth.Eth.estimateGas()` function with an additional buffer of ``100000``
+    :meth:`~web3.eth.Eth.estimate_gas()` function with an additional buffer of ``100000``
     gas up to the ``gasLimit`` of the latest block.  In the event that the
-    value returned by :meth:`~web3.eth.Eth.estimateGas()` method is greater than the
+    value returned by :meth:`~web3.eth.Eth.estimate_gas()` method is greater than the
     ``gasLimit`` a ``ValueError`` will be raised.
 
 
@@ -938,9 +938,9 @@ 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.
 
 
-.. py:method:: Eth.estimateGas(transaction, block_identifier=None)
+.. py:method:: Eth.estimate_gas(transaction, block_identifier=None)
 
-    * Delegates to ``eth_estimateGas`` RPC Method
+    * Delegates to ``eth_estimate_gas`` RPC Method
 
     Executes the given transaction locally without creating a new transaction
     on the blockchain.  Returns amount of gas consumed by execution which can
@@ -951,14 +951,19 @@ The following methods are available on the ``web3.eth`` namespace.
 
     .. code-block:: python
 
-        >>> web3.eth.estimateGas({'to': '0xd3CdA913deB6f67967B99D67aCDFa1712C293601', 'from': web3.eth.coinbase, 'value': 12345})
+        >>> web3.eth.estimate_gas({'to': '0xd3CdA913deB6f67967B99D67aCDFa1712C293601', 'from':
+        web3.eth.coinbase, 'value': 12345})
         21000
 
     .. note::
         The parameter ``block_identifier`` is not enabled in geth nodes,
         hence passing a value of ``block_identifier`` when connected to a geth
         nodes would result in an error like:  ``ValueError: {'code': -32602, 'message': 'too many arguments, want at most 1'}``
 
+.. py:method:: Eth.estimateGas(transaction, block_identifier=None)
+
+    .. warning:: Deprecated: This property is deprecated in favor of
+      :attr:`~web3.eth.Eth.estimate_gas()`
 
 .. py:method:: Eth.generateGasPrice(transaction_params=None)
 

tests/integration/go_ethereum/common.py

@@ -35,10 +35,10 @@ def test_eth_replace_transaction_already_mined(self, web3, unlocked_account_dual
         web3.geth.miner.stop()
 
     @pytest.mark.xfail(reason='Block identifier has not been implemented in geth')
-    def test_eth_estimateGas_with_block(self,
-                                        web3,
-                                        unlocked_account_dual_type):
-        super().test_eth_estimateGas_with_block(
+    def test_eth_estimate_gas_with_block(self,
+                                         web3,
+                                         unlocked_account_dual_type):
+        super().test_eth_estimate_gas_with_block(
             web3, unlocked_account_dual_type
         )
 

tests/integration/parity/common.py

@@ -27,10 +27,10 @@ def _check_web3_clientVersion(self, client_version):
 
 class ParityEthModuleTest(EthModuleTest):
     @pytest.mark.xfail(reason='Parity returns a gas value even when a function will revert')
-    def test_eth_estimateGas_revert_with_msg(self, web3, revert_contract, unlocked_account):
-        super().test_eth_estimateGas_revert_with_msg(web3, revert_contract, unlocked_account)
+    def test_eth_estimate_gas_revert_with_msg(self, web3, revert_contract, unlocked_account):
+        super().test_eth_estimate_gas_revert_with_msg(web3, revert_contract, unlocked_account)
 
-    def test_eth_estimateGas_revert_without_msg(
+    def test_eth_estimate_gas_revert_without_msg(
         self,
         web3,
         revert_contract,
@@ -44,7 +44,7 @@ def test_eth_estimateGas_revert_without_msg(
                     "to": revert_contract.address,
                 },
             )
-            web3.eth.estimateGas(txn_params)
+            web3.eth.estimate_gas(txn_params)
 
     @pytest.mark.xfail(reason='Parity dropped "pending" option in 1.11.1')
     def test_eth_getBlockByNumber_pending(self, web3):

tests/integration/test_ethereum_tester.py

@@ -339,10 +339,10 @@ def test_eth_getStorageAt_deprecated(self, web3, emitter_contract_address):
     def test_eth_get_storage_at_ens_name(self, web3, emitter_contract_address):
         super().test_eth_get_storage_at_ens_name(web3, emitter_contract_address)
 
-    def test_eth_estimateGas_with_block(self,
-                                        web3,
-                                        unlocked_account_dual_type):
-        super().test_eth_estimateGas_with_block(
+    def test_eth_estimate_gas_with_block(self,
+                                         web3,
+                                         unlocked_account_dual_type):
+        super().test_eth_estimate_gas_with_block(
             web3, unlocked_account_dual_type
         )
 
@@ -390,7 +390,7 @@ def test_eth_call_revert_without_msg(self, web3, revert_contract, unlocked_accou
             )
             web3.eth.call(txn_params)
 
-    def test_eth_estimateGas_revert_with_msg(self, web3, revert_contract, unlocked_account):
+    def test_eth_estimate_gas_revert_with_msg(self, web3, revert_contract, unlocked_account):
         with pytest.raises(TransactionFailed,
                            match='execution reverted: Function has been reverted'):
             txn_params = revert_contract._prepare_transaction(
@@ -400,9 +400,9 @@ def test_eth_estimateGas_revert_with_msg(self, web3, revert_contract, unlocked_a
                     "to": revert_contract.address,
                 },
             )
-            web3.eth.estimateGas(txn_params)
+            web3.eth.estimate_gas(txn_params)
 
-    def test_eth_estimateGas_revert_without_msg(self, web3, revert_contract, unlocked_account):
+    def test_eth_estimate_gas_revert_without_msg(self, web3, revert_contract, unlocked_account):
         with pytest.raises(TransactionFailed, match="execution reverted"):
             txn_params = revert_contract._prepare_transaction(
                 fn_name="revertWithoutMessage",
@@ -411,7 +411,7 @@ def test_eth_estimateGas_revert_without_msg(self, web3, revert_contract, unlocke
                     "to": revert_contract.address,
                 },
             )
-            web3.eth.estimateGas(txn_params)
+            web3.eth.estimate_gas(txn_params)
 
 
 class TestEthereumTesterVersionModule(VersionModuleTest):

web3/_utils/module_testing/eth_module.py

@@ -973,7 +973,7 @@ def test_eth_call_revert_without_msg(
             )
             web3.eth.call(txn_params)
 
-    def test_eth_estimateGas_revert_with_msg(
+    def test_eth_estimate_gas_revert_with_msg(
         self,
         web3: "Web3",
         revert_contract: "Contract",
@@ -988,9 +988,9 @@ def test_eth_estimateGas_revert_with_msg(
                     "to": revert_contract.address,
                 },
             )
-            web3.eth.estimateGas(txn_params)
+            web3.eth.estimate_gas(txn_params)
 
-    def test_eth_estimateGas_revert_without_msg(
+    def test_eth_estimate_gas_revert_without_msg(
         self,
         web3: "Web3",
         revert_contract: "Contract",
@@ -1004,26 +1004,37 @@ def test_eth_estimateGas_revert_without_msg(
                     "to": revert_contract.address,
                 },
             )
-            web3.eth.estimateGas(txn_params)
+            web3.eth.estimate_gas(txn_params)
 
-    def test_eth_estimateGas(
+    def test_eth_estimate_gas(
         self, web3: "Web3", unlocked_account_dual_type: ChecksumAddress
     ) -> None:
-        gas_estimate = web3.eth.estimateGas({
+        gas_estimate = web3.eth.estimate_gas({
             'from': unlocked_account_dual_type,
             'to': unlocked_account_dual_type,
             'value': Wei(1),
         })
         assert is_integer(gas_estimate)
         assert gas_estimate > 0
 
-    def test_eth_estimateGas_with_block(
+    def test_eth_estimateGas_deprecated(
         self, web3: "Web3", unlocked_account_dual_type: ChecksumAddress
     ) -> None:
         gas_estimate = web3.eth.estimateGas({
             'from': unlocked_account_dual_type,
             'to': unlocked_account_dual_type,
             'value': Wei(1),
+        })
+        assert is_integer(gas_estimate)
+        assert gas_estimate > 0
+
+    def test_eth_estimate_gas_with_block(
+        self, web3: "Web3", unlocked_account_dual_type: ChecksumAddress
+    ) -> None:
+        gas_estimate = web3.eth.estimate_gas({
+            'from': unlocked_account_dual_type,
+            'to': unlocked_account_dual_type,
+            'value': Wei(1),
         }, 'latest')
         assert is_integer(gas_estimate)
         assert gas_estimate > 0

web3/_utils/transactions.py

@@ -52,7 +52,7 @@
 TRANSACTION_DEFAULTS = {
     'value': 0,
     'data': b'',
-    'gas': lambda web3, tx: web3.eth.estimateGas(tx),
+    'gas': lambda web3, tx: web3.eth.estimate_gas(tx),
     'gasPrice': lambda web3, tx: web3.eth.generateGasPrice(tx) or web3.eth.gas_price,
     'chainId': lambda web3, tx: web3.eth.chain_id,
 }
@@ -124,7 +124,7 @@ def get_buffered_gas_estimate(
 ) -> Wei:
     gas_estimate_transaction = cast(TxParams, dict(**transaction))
 
-    gas_estimate = web3.eth.estimateGas(gas_estimate_transaction)
+    gas_estimate = web3.eth.estimate_gas(gas_estimate_transaction)
 
     gas_limit = get_block_gas_limit(web3)
 

web3/eth.py

@@ -549,7 +549,7 @@ def estimate_gas_munger(
 
         return params
 
-    estimateGas: Method[Callable[..., Wei]] = Method(
+    estimate_gas: Method[Callable[..., Wei]] = Method(
         RPC.eth_estimateGas,
         mungers=[estimate_gas_munger]
     )
@@ -685,6 +685,7 @@ def setGasPriceStrategy(self, gas_price_strategy: GasPriceStrategy) -> None:
     getUncleCount = DeprecatedMethod(get_uncle_count, 'getUncleCount', 'get_uncle_count')
     sendTransaction = DeprecatedMethod(send_transaction, 'sendTransaction', 'send_transaction')
     signTransaction = DeprecatedMethod(sign_transaction, 'signTransaction', 'sign_transaction')
+    estimateGas = DeprecatedMethod(estimate_gas, 'estimateGas', 'estimate_gas')
     sendRawTransaction = DeprecatedMethod(send_raw_transaction,
                                           'sendRawTransaction',
                                           'send_raw_transaction')