Merge pull request #1926 from tmckenzie51/tiffany/submitHashRate-to-snakecase

deprecate submitHashrate in favor of submit_hashrate

Author: tmckenzie51

docs/web3.eth.rst

@@ -1129,16 +1129,20 @@ with the filtering API.
     .. warning:: Deprecated: This property is deprecated in favor of
       :attr:`~web3.eth.Eth.get_logs()`
 
-.. py:method:: Eth.submitHashrate(hashrate, nodeid)
+.. py:method:: Eth.submit_hashrate(hashrate, nodeid)
 
     * Delegates to ``eth_submitHashrate`` RPC Method
 
     .. code-block:: python
 
        >>> node_id = '59daa26581d0acd1fce254fb7e85952f4c09d0915afd33d3886cd914bc7d283c'
-       >>> web3.eth.submitHashrate(5000, node_id)
+       >>> web3.eth.submit_hashrate(5000, node_id)
        True
 
+.. py:method:: Eth.submitHashrate(hashrate, nodeid)
+
+    .. warning:: Deprecated: This property is deprecated in favor of
+      :attr:`~web3.eth.Eth.submit_hashrate()`
 
 .. py:method:: Eth.submit_work(nonce, pow_hash, mix_digest)
 

newsfragments/1926.feature.rst

@@ -0,0 +1 @@
+Add ``w3.eth.submit_hashrate`` deprecate ``w3.eth.submitHashrate``

tests/integration/go_ethereum/common.py

@@ -20,9 +20,14 @@ def _check_web3_clientVersion(self, client_version):
 
 class GoEthereumEthModuleTest(EthModuleTest):
     @pytest.mark.xfail(reason='eth_submitHashrate deprecated in 1.8.22 for ethash_submitHashRate')
-    def test_eth_submitHashrate(self, web3):
+    def test_eth_submit_hashrate(self, web3):
         # https://github.com/ethereum/go-ethereum/commit/51db5975cc5fb88db6a0dba1826b534fd4df29d7
-        super().test_eth_submitHashrate(web3)
+        super().test_eth_submit_hashrate(web3)
+
+    @pytest.mark.xfail(reason='eth_submitHashrate deprecated in 1.8.22 for ethash_submitHashRate')
+    def test_eth_submitHashrate_deprecated(self, web3):
+        # https://github.com/ethereum/go-ethereum/commit/51db5975cc5fb88db6a0dba1826b534fd4df29d7
+        super().test_eth_submitHashrate_deprecated(web3)
 
     @pytest.mark.xfail(
         strict=False,

tests/integration/test_ethereum_tester.py

@@ -251,7 +251,9 @@ class TestEthereumTesterEthModule(EthModuleTest):
     test_eth_sign_transaction_ens_names = not_implemented(
         EthModuleTest.test_eth_sign_transaction_ens_names, ValueError
     )
-    test_eth_submitHashrate = not_implemented(EthModuleTest.test_eth_submitHashrate, ValueError)
+    test_eth_submitHashrate_deprecated = not_implemented(
+        EthModuleTest.test_eth_submitHashrate_deprecated, ValueError)
+    test_eth_submit_hashrate = not_implemented(EthModuleTest.test_eth_submit_hashrate, ValueError)
     test_eth_submitWork_deprecated = not_implemented(
         EthModuleTest.test_eth_submitWork_deprecated, ValueError)
     test_eth_submit_work = not_implemented(EthModuleTest.test_eth_submit_work, ValueError)

web3/_utils/module_testing/eth_module.py

@@ -1470,7 +1470,13 @@ def test_eth_getCompilers_deprecation(self, web3: "Web3") -> None:
         with pytest.raises(DeprecationWarning):
             web3.eth.getCompilers()
 
-    def test_eth_submitHashrate(self, web3: "Web3") -> None:
+    def test_eth_submit_hashrate(self, web3: "Web3") -> None:
+        # node_id from EIP 1474: https://github.com/ethereum/EIPs/pull/1474/files
+        node_id = HexStr('59daa26581d0acd1fce254fb7e85952f4c09d0915afd33d3886cd914bc7d283c')
+        result = web3.eth.submit_hashrate(5000, node_id)
+        assert result is True
+
+    def test_eth_submitHashrate_deprecated(self, web3: "Web3") -> None:
         # node_id from EIP 1474: https://github.com/ethereum/EIPs/pull/1474/files
         node_id = HexStr('59daa26581d0acd1fce254fb7e85952f4c09d0915afd33d3886cd914bc7d283c')
         result = web3.eth.submitHashrate(5000, node_id)

web3/eth.py

@@ -609,7 +609,7 @@ def filter_munger(
         mungers=[default_root_munger]
     )
 
-    submitHashrate: Method[Callable[[int, _Hash32], bool]] = Method(
+    submit_hashrate: Method[Callable[[int, _Hash32], bool]] = Method(
         RPC.eth_submitHashrate,
         mungers=[default_root_munger],
     )
@@ -689,6 +689,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')
+    submitHashrate = DeprecatedMethod(submit_hashrate, 'submitHashrate', 'submit_hashrate')
     submitWork = DeprecatedMethod(submit_work, 'submitWork', 'submit_work')
     getLogs = DeprecatedMethod(get_logs, 'getLogs', 'get_logs')
     sendRawTransaction = DeprecatedMethod(send_raw_transaction,