From 3102b7227c91b91818dfdcff0ce1249efdc07b20 Mon Sep 17 00:00:00 2001 From: tmckenzie51 <25855566+tmckenzie51@users.noreply.github.com> Date: Mon, 26 Apr 2021 16:15:01 -0500 Subject: [PATCH] Add trace_replay_block_transactions, deprecate traceReplayBlockTransactions (#1962) * snakecase traceReplayBlockTransactions * add release note --- newsfragments/1962.feature.rst | 1 + web3/_utils/module_testing/parity_module.py | 17 ++++++++++++++--- web3/parity.py | 5 ++++- 3 files changed, 19 insertions(+), 4 deletions(-) create mode 100644 newsfragments/1962.feature.rst diff --git a/newsfragments/1962.feature.rst b/newsfragments/1962.feature.rst new file mode 100644 index 0000000000..3b2db1b529 --- /dev/null +++ b/newsfragments/1962.feature.rst @@ -0,0 +1 @@ +Add trace_replay_block_transactions, deprecate traceReplayBlockTransactions diff --git a/web3/_utils/module_testing/parity_module.py b/web3/_utils/module_testing/parity_module.py index 61b3e7e46b..014ebad67a 100644 --- a/web3/_utils/module_testing/parity_module.py +++ b/web3/_utils/module_testing/parity_module.py @@ -56,10 +56,21 @@ def test_trace_replay_transaction( HexStr(parity_fixture_data['coinbase']), ) - def test_trace_replay_block_with_transactions( + def test_trace_replay_block_transactions( self, web3: "Web3", block_with_txn: BlockData, parity_fixture_data: Dict[str, str] ) -> None: - trace = web3.parity.traceReplayBlockTransactions(block_with_txn['number']) + trace = web3.parity.trace_replay_block_transactions(block_with_txn['number']) + assert len(trace) > 0 + trace_0_action = trace[0]['trace'][0]['action'] + assert trace_0_action['from'] == add_0x_prefix(HexStr(parity_fixture_data['coinbase'])) + + def test_traceReplayBlockTransactions_deprecated( + self, web3: "Web3", block_with_txn: BlockData, parity_fixture_data: Dict[str, str] + ) -> None: + with pytest.warns(DeprecationWarning, + match='traceReplayBlockTransactions is deprecated in favor of ' + 'trace_replay_block_transactions'): + trace = web3.parity.traceReplayBlockTransactions(block_with_txn['number']) assert len(trace) > 0 trace_0_action = trace[0]['trace'][0]['action'] assert trace_0_action['from'] == add_0x_prefix(HexStr(parity_fixture_data['coinbase'])) @@ -67,7 +78,7 @@ def test_trace_replay_block_with_transactions( def test_trace_replay_block_without_transactions( self, web3: "Web3", empty_block: BlockData ) -> None: - trace = web3.parity.traceReplayBlockTransactions(empty_block['number']) + trace = web3.parity.trace_replay_block_transactions(empty_block['number']) assert len(trace) == 0 def test_trace_block(self, web3: "Web3", block_with_txn: BlockData) -> None: diff --git a/web3/parity.py b/web3/parity.py index a0507faf90..1a5696d60d 100644 --- a/web3/parity.py +++ b/web3/parity.py @@ -159,7 +159,7 @@ def trace_replay_transaction_munger( mungers=[trace_replay_transaction_munger], ) - traceReplayBlockTransactions: Method[Callable[..., List[ParityBlockTrace]]] = Method( + trace_replay_block_transactions: Method[Callable[..., List[ParityBlockTrace]]] = Method( RPC.trace_replayBlockTransactions, mungers=[trace_replay_transaction_munger] ) @@ -225,3 +225,6 @@ def trace_transactions_munger( traceReplayTransaction = DeprecatedMethod(trace_replay_transaction, 'traceReplayTransaction', 'trace_replay_transaction') netPeers = DeprecatedMethod(net_peers, 'netPeers', 'net_peers') + traceReplayBlockTransactions = DeprecatedMethod(trace_replay_block_transactions, + 'traceReplayBlockTransactions', + 'trace_replay_block_transactions')