diff --git a/docs/web3.eth.rst b/docs/web3.eth.rst index eca95996c5..ca56ac2534 100644 --- a/docs/web3.eth.rst +++ b/docs/web3.eth.rst @@ -1140,19 +1140,23 @@ with the filtering API. True -.. py:method:: Eth.submitWork(nonce, pow_hash, mix_digest) +.. py:method:: Eth.submit_work(nonce, pow_hash, mix_digest) * Delegates to ``eth_submitWork`` RPC Method. .. code-block:: python - >>> web3.eth.submitWork( + >>> web3.eth.submit_work( 1, '0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef', '0xD1FE5700000000000000000000000000D1FE5700000000000000000000000000', ) True +.. py:method:: Eth.submitWork(nonce, pow_hash, mix_digest) + + .. warning:: Deprecated: This property is deprecated in favor of + :attr:`~web3.eth.Eth.submit_work()` Contracts --------- diff --git a/newsfragments/1927.feature.rst b/newsfragments/1927.feature.rst new file mode 100644 index 0000000000..bc0d8fb393 --- /dev/null +++ b/newsfragments/1927.feature.rst @@ -0,0 +1 @@ +Add ``w3.eth.submit_work`` deprecate ``w3.eth.submitWork`` diff --git a/tests/integration/test_ethereum_tester.py b/tests/integration/test_ethereum_tester.py index b0be994d15..e8e4f151b4 100644 --- a/tests/integration/test_ethereum_tester.py +++ b/tests/integration/test_ethereum_tester.py @@ -252,7 +252,9 @@ class TestEthereumTesterEthModule(EthModuleTest): EthModuleTest.test_eth_sign_transaction_ens_names, ValueError ) test_eth_submitHashrate = not_implemented(EthModuleTest.test_eth_submitHashrate, ValueError) - test_eth_submitWork = not_implemented(EthModuleTest.test_eth_submitWork, 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) def test_eth_getBlockByHash_pending( self, web3: "Web3" diff --git a/web3/_utils/module_testing/eth_module.py b/web3/_utils/module_testing/eth_module.py index 44715c034c..3c8e8cfa08 100644 --- a/web3/_utils/module_testing/eth_module.py +++ b/web3/_utils/module_testing/eth_module.py @@ -1476,9 +1476,18 @@ def test_eth_submitHashrate(self, web3: "Web3") -> None: result = web3.eth.submitHashrate(5000, node_id) assert result is True - def test_eth_submitWork(self, web3: "Web3") -> None: + def test_eth_submit_work(self, web3: "Web3") -> None: nonce = 1 pow_hash = HexStr('0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef') mix_digest = HexStr('0xD1FE5700000000000000000000000000D1FE5700000000000000000000000000') - result = web3.eth.submitWork(nonce, pow_hash, mix_digest) + result = web3.eth.submit_work(nonce, pow_hash, mix_digest) + assert result is False + + def test_eth_submitWork_deprecated(self, web3: "Web3") -> None: + nonce = 1 + pow_hash = HexStr('0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef') + mix_digest = HexStr('0xD1FE5700000000000000000000000000D1FE5700000000000000000000000000') + with pytest.warns(DeprecationWarning, + match="submitWork is deprecated in favor of submit_work"): + result = web3.eth.submitWork(nonce, pow_hash, mix_digest) assert result is False diff --git a/web3/eth.py b/web3/eth.py index 876ff5c794..ebee33cfd7 100644 --- a/web3/eth.py +++ b/web3/eth.py @@ -614,7 +614,7 @@ def filter_munger( mungers=[default_root_munger], ) - submitWork: Method[Callable[[int, _Hash32, _Hash32], bool]] = Method( + submit_work: Method[Callable[[int, _Hash32, _Hash32], bool]] = Method( RPC.eth_submitWork, 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') + submitWork = DeprecatedMethod(submit_work, 'submitWork', 'submit_work') getLogs = DeprecatedMethod(get_logs, 'getLogs', 'get_logs') sendRawTransaction = DeprecatedMethod(send_raw_transaction, 'sendRawTransaction',