diff --git a/docs/toc.rst b/docs/toc.rst index 99a8240049..1d7b44c7b9 100644 --- a/docs/toc.rst +++ b/docs/toc.rst @@ -40,7 +40,6 @@ Table of Contents web3.beacon web3.pm web3.net - web3.miner web3.geth web3.tracing web3.utils diff --git a/docs/web3.main.rst b/docs/web3.main.rst index 9cc082f110..f75d74508a 100644 --- a/docs/web3.main.rst +++ b/docs/web3.main.rst @@ -363,10 +363,6 @@ Each ``Web3`` instance also exposes these namespaced API modules. See :doc:`./web3.eth` -.. py:attribute:: Web3.miner - - See :doc:`./web3.miner` - .. py:attribute:: Web3.pm See :doc:`./web3.pm` diff --git a/docs/web3.miner.rst b/docs/web3.miner.rst deleted file mode 100644 index 08b3500c57..0000000000 --- a/docs/web3.miner.rst +++ /dev/null @@ -1,91 +0,0 @@ -Miner API -========= - -.. py:module:: web3.geth.miner - -The ``web3.geth.miner`` object exposes methods to interact with the RPC APIs under -the ``miner_`` namespace that are supported by the Geth client. - - -Methods -------- - -The following methods are available on the ``web3.geth.miner`` namespace. - - -.. py:method:: GethMiner.make_dag(number) - - * Delegates to ``miner_makeDag`` RPC Method - - Generate the DAG for the given block number. - - .. code-block:: python - - >>> web3.geth.miner.make_dag(10000) - - -.. py:method:: GethMiner.set_extra(extra) - - * Delegates to ``miner_setExtra`` RPC Method - - Set the 32 byte value ``extra`` as the extra data that will be included - when this node mines a block. - - .. code-block:: python - - >>> web3.geth.miner.set_extra('abcdefghijklmnopqrstuvwxyzABCDEF') - -.. py:method:: GethMiner.set_gas_price(gas_price) - - * Delegates to ``miner_setGasPrice`` RPC Method - - Sets the minimum accepted gas price that this node will accept when mining - transactions. Any transactions with a gas price below this value will be - ignored. - - .. code-block:: python - - >>> web3.geth.miner.set_gas_price(19999999999) - - -.. py:method:: GethMiner.start(num_threads) - - * Delegates to ``miner_start`` RPC Method - - Start the CPU mining process using the given number of threads. - - .. code-block:: python - - >>> web3.geth.miner.start(2) - - -.. py:method:: GethMiner.stop() - - * Delegates to ``miner_stop`` RPC Method - - Stop the CPU mining operation - - .. code-block:: python - - >>> web3.geth.miner.stop() - - -.. py:method:: GethMiner.start_auto_dag() - - * Delegates to ``miner_startAutoDag`` RPC Method - - Enable automatic DAG generation. - - .. code-block:: python - - >>> web3.geth.miner.start_auto_dag() - -.. py:method:: GethMiner.stop_auto_dag() - - * Delegates to ``miner_stopAutoDag`` RPC Method - - Disable automatic DAG generation. - - .. code-block:: python - - >>> web3.geth.miner.stop_auto_dag() diff --git a/newsfragments/3236.removal.rst b/newsfragments/3236.removal.rst new file mode 100644 index 0000000000..7972f921d5 --- /dev/null +++ b/newsfragments/3236.removal.rst @@ -0,0 +1 @@ +Remove deprecated ``geth.miner`` namespace and methods. diff --git a/tests/core/txpool-module/test_txpool_content.py b/tests/core/txpool-module/test_txpool_content.py index 8e0581dacd..4af67c14da 100644 --- a/tests/core/txpool-module/test_txpool_content.py +++ b/tests/core/txpool-module/test_txpool_content.py @@ -8,8 +8,6 @@ def test_txpool_content(web3_empty): web3 = web3_empty - web3.geth.miner.stop() - with Timeout(60) as timeout: while web3.eth.hashrate or web3.eth.mining: timeout.sleep(random.random()) diff --git a/tests/core/txpool-module/test_txpool_inspect.py b/tests/core/txpool-module/test_txpool_inspect.py index e6997e3c56..c86d654dc0 100644 --- a/tests/core/txpool-module/test_txpool_inspect.py +++ b/tests/core/txpool-module/test_txpool_inspect.py @@ -8,8 +8,6 @@ def test_txpool_inspect(web3_empty): web3 = web3_empty - web3.geth.miner.stop() - with Timeout(60) as timeout: while web3.eth.hashrate or web3.eth.mining: timeout.sleep(random.random()) diff --git a/tests/integration/go_ethereum/test_goethereum_ws_v2/conftest.py b/tests/integration/go_ethereum/test_goethereum_ws_v2/conftest.py index 87ad255c72..f0f3bd9cb7 100644 --- a/tests/integration/go_ethereum/test_goethereum_ws_v2/conftest.py +++ b/tests/integration/go_ethereum/test_goethereum_ws_v2/conftest.py @@ -28,7 +28,7 @@ def _geth_command_arguments(ws_port, base_geth_command_arguments, geth_version): "--ws.port", ws_port, "--ws.api", - "admin,eth,net,web3,personal,miner", + "admin,eth,net,web3,personal", "--ws.origins", "*", "--ipcdisable", diff --git a/web3/_utils/miner.py b/web3/_utils/miner.py deleted file mode 100644 index 2797a505b9..0000000000 --- a/web3/_utils/miner.py +++ /dev/null @@ -1,66 +0,0 @@ -from typing import ( - Callable, -) - -from eth_typing import ( - ChecksumAddress, -) - -from web3._utils.rpc_abi import ( - RPC, -) -from web3.method import ( - Method, - default_root_munger, -) -from web3.types import ( - BlockNumber, - Wei, -) - -make_dag: Method[Callable[[BlockNumber], bool]] = Method( - RPC.miner_makeDag, - mungers=[default_root_munger], -) - - -set_extra: Method[Callable[[str], bool]] = Method( - RPC.miner_setExtra, - mungers=[default_root_munger], -) - - -set_etherbase: Method[Callable[[ChecksumAddress], bool]] = Method( - RPC.miner_setEtherbase, - mungers=[default_root_munger], -) - - -set_gas_price: Method[Callable[[Wei], bool]] = Method( - RPC.miner_setGasPrice, - mungers=[default_root_munger], -) - - -start: Method[Callable[[int], bool]] = Method( - RPC.miner_start, - mungers=[default_root_munger], -) - - -stop: Method[Callable[[], bool]] = Method( - RPC.miner_stop, - is_property=True, -) - - -start_auto_dag: Method[Callable[[], bool]] = Method( - RPC.miner_startAutoDag, - is_property=True, -) - - -stop_auto_dag: Method[Callable[[], bool]] = Method( - RPC.miner_stopAutoDag, - is_property=True, -) diff --git a/web3/_utils/module_testing/module_testing_utils.py b/web3/_utils/module_testing/module_testing_utils.py index 6d66400961..629ed137da 100644 --- a/web3/_utils/module_testing/module_testing_utils.py +++ b/web3/_utils/module_testing/module_testing_utils.py @@ -1,7 +1,6 @@ from collections import ( deque, ) -import time from typing import ( TYPE_CHECKING, Any, @@ -60,17 +59,6 @@ flaky_geth_dev_mining = flaky(max_runs=3) -def mine_pending_block(w3: "Web3") -> None: - timeout = 10 - - w3.geth.miner.start() # type: ignore - start = time.time() - while time.time() < start + timeout: - if len(w3.eth.get_block("pending")["transactions"]) == 0: - break - w3.geth.miner.stop() # type: ignore - - def assert_contains_log( result: Sequence[LogReceipt], block_with_txn_with_log: BlockData, diff --git a/web3/_utils/rpc_abi.py b/web3/_utils/rpc_abi.py index 2104e95ade..774f2adcce 100644 --- a/web3/_utils/rpc_abi.py +++ b/web3/_utils/rpc_abi.py @@ -114,16 +114,6 @@ class RPC: evm_revert = RPCEndpoint("evm_revert") evm_snapshot = RPCEndpoint("evm_snapshot") - # miner - miner_makeDag = RPCEndpoint("miner_makeDag") - miner_setExtra = RPCEndpoint("miner_setExtra") - miner_setEtherbase = RPCEndpoint("miner_setEtherbase") - miner_setGasPrice = RPCEndpoint("miner_setGasPrice") - miner_start = RPCEndpoint("miner_start") - miner_stop = RPCEndpoint("miner_stop") - miner_startAutoDag = RPCEndpoint("miner_startAutoDag") - miner_stopAutoDag = RPCEndpoint("miner_stopAutoDag") - # net net_listening = RPCEndpoint("net_listening") net_peerCount = RPCEndpoint("net_peerCount") diff --git a/web3/geth.py b/web3/geth.py index 5600aa2703..09b581cb89 100644 --- a/web3/geth.py +++ b/web3/geth.py @@ -21,16 +21,6 @@ from web3._utils.compat import ( Protocol, ) -from web3._utils.miner import ( - make_dag, - set_etherbase, - set_extra, - set_gas_price, - start, - start_auto_dag, - stop, - stop_auto_dag, -) from web3._utils.rpc_abi import ( RPC, ) @@ -215,21 +205,6 @@ class GethAdmin(Module): ) -class GethMiner(Module): - """ - https://geth.ethereum.org/docs/interacting-with-geth/rpc/ns-miner - """ - - make_dag = make_dag - set_extra = set_extra - set_etherbase = set_etherbase - set_gas_price = set_gas_price - start = start - stop = stop - start_auto_dag = start_auto_dag - stop_auto_dag = stop_auto_dag - - class Geth(Module): personal: GethPersonal admin: GethAdmin diff --git a/web3/main.py b/web3/main.py index 604ea4fcdf..f2adfb79eb 100644 --- a/web3/main.py +++ b/web3/main.py @@ -95,7 +95,6 @@ AsyncGethTxPool, Geth, GethAdmin, - GethMiner, GethPersonal, GethTxPool, ) @@ -171,7 +170,6 @@ def get_default_modules() -> Dict[str, Union[Type[Module], Sequence[Any]]]: Geth, { "admin": GethAdmin, - "miner": GethMiner, "personal": GethPersonal, "txpool": GethTxPool, }, diff --git a/web3/providers/eth_tester/defaults.py b/web3/providers/eth_tester/defaults.py index 571290b1a2..7672c437c8 100644 --- a/web3/providers/eth_tester/defaults.py +++ b/web3/providers/eth_tester/defaults.py @@ -404,15 +404,6 @@ def personal_send_transaction(eth_tester: "EthereumTester", params: Any) -> HexS "writeBlockProfile": not_implemented, "writeMemProfile": not_implemented, }, - "miner": { - "make_dag": not_implemented, - "set_extra": not_implemented, - "set_gas_price": not_implemented, - "start": not_implemented, - "stop": not_implemented, - "start_auto_dag": not_implemented, - "stop_auto_dag": not_implemented, - }, "personal": { "ec_recover": not_implemented, "import_raw_key": call_eth_tester("add_account"), diff --git a/web3/providers/rpc/utils.py b/web3/providers/rpc/utils.py index e1a249dd6a..227c12efb4 100644 --- a/web3/providers/rpc/utils.py +++ b/web3/providers/rpc/utils.py @@ -13,7 +13,6 @@ REQUEST_RETRY_ALLOWLIST = [ "admin", - "miner", "net", "txpool", "testing",