Skip to content

Commit

Permalink
Add pipeline implementation for debug_traceBlock
Browse files Browse the repository at this point in the history 
Signed-off-by: Ameziane H. <[email protected]>
  • Loading branch information
@ahamlat
ahamlat committed Jan 3, 2025
1 parent 66a9714 commit 9bcbda3
Show file tree
Hide file tree
Showing 5 changed files with 227 additions and 127 deletions.
117 changes: 95 additions & 22 deletions ...main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/DebugTraceBlock.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,15 @@
*/
package org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods;

import static org.hyperledger.besu.services.pipeline.PipelineBuilder.createPipelineFrom;

import org.hyperledger.besu.ethereum.api.jsonrpc.RpcMethod;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequestContext;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.exception.InvalidJsonRpcParameters;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.JsonRpcParameter.JsonRpcParameterException;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.TransactionTraceParams;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.BlockTrace;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.BlockTracer;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.Tracer;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.TransactionTrace;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcResponse;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcSuccessResponse;
Expand All @@ -31,32 +32,55 @@
import org.hyperledger.besu.ethereum.core.Block;
import org.hyperledger.besu.ethereum.core.BlockHeaderFunctions;
import org.hyperledger.besu.ethereum.debug.TraceOptions;
import org.hyperledger.besu.ethereum.eth.manager.EthScheduler;
import org.hyperledger.besu.ethereum.mainnet.MainnetTransactionProcessor;
import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
import org.hyperledger.besu.ethereum.mainnet.ProtocolSpec;
import org.hyperledger.besu.ethereum.mainnet.ScheduleBasedBlockHeaderFunctions;
import org.hyperledger.besu.ethereum.rlp.RLP;
import org.hyperledger.besu.ethereum.rlp.RLPException;
import org.hyperledger.besu.ethereum.vm.DebugOperationTracer;
import org.hyperledger.besu.metrics.BesuMetricCategory;
import org.hyperledger.besu.metrics.ObservableMetricsSystem;
import org.hyperledger.besu.metrics.noop.NoOpMetricsSystem;
import org.hyperledger.besu.plugin.services.metrics.Counter;
import org.hyperledger.besu.plugin.services.metrics.LabelledMetric;
import org.hyperledger.besu.services.pipeline.Pipeline;

import java.util.Collection;
import java.util.Optional;
import java.util.concurrent.CopyOnWriteArrayList;
import java.util.concurrent.ExecutionException;
import java.util.function.Supplier;

import com.google.common.base.Suppliers;
import org.apache.tuweni.bytes.Bytes;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class DebugTraceBlock implements JsonRpcMethod {

private static final Logger LOG = LoggerFactory.getLogger(DebugTraceBlock.class);
private final Supplier<BlockTracer> blockTracerSupplier;
private final BlockHeaderFunctions blockHeaderFunctions;
private final BlockchainQueries blockchainQueries;
private final Supplier<BlockchainQueries> blockchainQueries;
private final ProtocolSchedule protocolSchedule;
private final LabelledMetric<Counter> outputCounter;

public DebugTraceBlock(
final Supplier<BlockTracer> blockTracerSupplier,
final BlockHeaderFunctions blockHeaderFunctions,
final BlockchainQueries blockchainQueries) {
this.blockTracerSupplier = blockTracerSupplier;
this.blockHeaderFunctions = blockHeaderFunctions;
this.blockchainQueries = blockchainQueries;
final ProtocolSchedule protocolSchedule,
final BlockchainQueries blockchainQueries,
final ObservableMetricsSystem metricsSystem) {
this.blockHeaderFunctions = ScheduleBasedBlockHeaderFunctions.create(protocolSchedule);
this.blockchainQueries = Suppliers.ofInstance(blockchainQueries);
;
this.protocolSchedule = protocolSchedule;
this.outputCounter =
metricsSystem.createLabelledCounter(
BesuMetricCategory.BLOCKCHAIN,
"transactions_debugTraceblock_pipeline_processed_total",
"Number of transactions processed for each block",
"step",
"action");
}

@Override
Expand All @@ -70,7 +94,7 @@ public JsonRpcResponse response(final JsonRpcRequestContext requestContext) {
try {
final String input = requestContext.getRequiredParameter(0, String.class);
block = Block.readFrom(RLP.input(Bytes.fromHexString(input)), this.blockHeaderFunctions);
} catch (final RLPException e) {
} catch (final RLPException | IllegalArgumentException e) {
LOG.debug("Failed to parse block RLP (index 0)", e);
return new JsonRpcErrorResponse(
requestContext.getRequest().getId(), RpcErrorType.INVALID_BLOCK_PARAMS);
Expand All @@ -92,20 +116,69 @@ public JsonRpcResponse response(final JsonRpcRequestContext requestContext) {
e);
}

if (this.blockchainQueries.blockByHash(block.getHeader().getParentHash()).isPresent()) {
if (blockchainQueries
.get()
.getBlockchain()
.getBlockByHash(block.getHeader().getParentHash())
.isPresent()) {
final Collection<DebugTraceTransactionResult> results =
Tracer.processTracing(
blockchainQueries,
blockchainQueries.get(),
Optional.of(block.getHeader()),
mutableWorldState ->
blockTracerSupplier
.get()
.trace(
mutableWorldState,
block,
new DebugOperationTracer(traceOptions, true))
.map(BlockTrace::getTransactionTraces)
.map(DebugTraceTransactionResult::of))
traceableState -> {
Collection<DebugTraceTransactionResult> tracesList =
new CopyOnWriteArrayList<>();
final ProtocolSpec protocolSpec =
protocolSchedule.getByBlockHeader(block.getHeader());
final MainnetTransactionProcessor transactionProcessor =
protocolSpec.getTransactionProcessor();
final TraceBlock.ChainUpdater chainUpdater =
new TraceBlock.ChainUpdater(traceableState);

TransactionSource transactionSource = new TransactionSource(block);
DebugOperationTracer debugOperationTracer =
new DebugOperationTracer(traceOptions, true);
ExecuteTransactionStep executeTransactionStep =
new ExecuteTransactionStep(
chainUpdater,
transactionProcessor,
blockchainQueries.get().getBlockchain(),
debugOperationTracer,
protocolSpec,
block);
DebugTraceTransactionStep debugTraceTransactionStep =
new DebugTraceTransactionStep();
Pipeline<TransactionTrace> traceBlockPipeline =
createPipelineFrom(
"getTransactions",
transactionSource,
4,
outputCounter,
false,
"debug_trace_block_by_number")
.thenProcess("executeTransaction", executeTransactionStep)
.thenProcessAsyncOrdered(
"debugTraceTransactionStep", debugTraceTransactionStep, 4)
.andFinishWith("collect_results", tracesList::add);

try {
if (blockchainQueries.get().getEthScheduler().isPresent()) {
blockchainQueries
.get()
.getEthScheduler()
.get()
.startPipeline(traceBlockPipeline)
.get();
} else {
EthScheduler ethScheduler =
new EthScheduler(1, 1, 1, 1, new NoOpMetricsSystem());
ethScheduler.startPipeline(traceBlockPipeline).get();
}
} catch (InterruptedException | ExecutionException e) {
throw new RuntimeException(e);
}
return Optional.of(tracesList);
})
.orElse(null);
return new JsonRpcSuccessResponse(requestContext.getRequest().getId(), results);
} else {
Expand Down
6 changes: 1 addition & 5 deletions .../src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/DebugJsonRpcMethods.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,6 @@
import org.hyperledger.besu.ethereum.core.Synchronizer;
import org.hyperledger.besu.ethereum.eth.transactions.TransactionPool;
import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
import org.hyperledger.besu.ethereum.mainnet.ScheduleBasedBlockHeaderFunctions;
import org.hyperledger.besu.ethereum.transaction.TransactionSimulator;
import org.hyperledger.besu.metrics.ObservableMetricsSystem;

Expand Down Expand Up @@ -100,10 +99,7 @@ protected Map<String, JsonRpcMethod> create() {
new DebugStorageRangeAt(blockchainQueries, blockReplay),
new DebugMetrics(metricsSystem),
new DebugResyncWorldstate(protocolContext, synchronizer),
new DebugTraceBlock(
() -> new BlockTracer(blockReplay),
ScheduleBasedBlockHeaderFunctions.create(protocolSchedule),
blockchainQueries),
new DebugTraceBlock(protocolSchedule, blockchainQueries, metricsSystem),
new DebugSetHead(blockchainQueries, protocolContext),
new DebugReplayBlock(blockchainQueries, protocolContext, protocolSchedule),
new DebugTraceBlockByNumber(protocolSchedule, blockchainQueries, metricsSystem),
Expand Down
13 changes: 5 additions & 8 deletions ...org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/DebugTraceBlockByHashTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequestContext;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.exception.InvalidJsonRpcParameters;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.Tracer;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcResponse;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcSuccessResponse;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.DebugTraceTransactionResult;
import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
Expand All @@ -49,17 +50,11 @@

public class DebugTraceBlockByHashTest {
@Mock private ProtocolSchedule protocolSchedule;

@Mock private BlockchainQueries blockchainQueries;

@Mock private ObservableMetricsSystem metricsSystem;

@Mock private Blockchain blockchain;

@Mock private Block block;

private DebugTraceBlockByHash debugTraceBlockByHash;

private final Hash blockHash =
Hash.fromHexString("aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");

Expand Down Expand Up @@ -97,8 +92,10 @@ public void shouldReturnCorrectResponse() {
Tracer.processTracing(eq(blockchainQueries), eq(blockHash), any(Function.class)))
.thenReturn(Optional.of(resultList));

final JsonRpcSuccessResponse response =
(JsonRpcSuccessResponse) debugTraceBlockByHash.response(request);
final JsonRpcResponse jsonRpcResponse = debugTraceBlockByHash.response(request);
assertThat(jsonRpcResponse).isInstanceOf(JsonRpcSuccessResponse.class);
JsonRpcSuccessResponse response = (JsonRpcSuccessResponse) jsonRpcResponse;

final Collection<DebugTraceTransactionResult> traceResult = getResult(response);
assertThat(traceResult).isNotEmpty();
assertThat(traceResult).isInstanceOf(Collection.class).hasSize(2);
Expand Down
14 changes: 5 additions & 9 deletions ...g/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/DebugTraceBlockByNumberTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.JsonRpcRequestContext;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.exception.InvalidJsonRpcParameters;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.Tracer;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcResponse;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcSuccessResponse;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.DebugTraceTransactionResult;
import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
Expand All @@ -50,17 +51,11 @@
public class DebugTraceBlockByNumberTest {

@Mock private BlockchainQueries blockchainQueries;

@Mock private Blockchain blockchain;

@Mock private Block block;

@Mock private BlockHeader blockHeader;

@Mock private ProtocolSchedule protocolSchedule;

@Mock private ObservableMetricsSystem metricsSystem;

private DebugTraceBlockByNumber debugTraceBlockByNumber;

@BeforeEach
Expand Down Expand Up @@ -100,10 +95,11 @@ public void shouldReturnCorrectResponse() {
eq(blockchainQueries), eq(Optional.of(blockHeader)), any(Function.class)))
.thenReturn(Optional.of(resultList));

final JsonRpcSuccessResponse response =
(JsonRpcSuccessResponse) debugTraceBlockByNumber.response(request);
final Collection<DebugTraceTransactionResult> traceResult = getResult(response);
final JsonRpcResponse jsonRpcResponse = debugTraceBlockByNumber.response(request);
assertThat(jsonRpcResponse).isInstanceOf(JsonRpcSuccessResponse.class);
JsonRpcSuccessResponse response = (JsonRpcSuccessResponse) jsonRpcResponse;

final Collection<DebugTraceTransactionResult> traceResult = getResult(response);
assertThat(traceResult).isNotEmpty();
assertThat(traceResult).isInstanceOf(Collection.class).hasSize(2);
assertThat(traceResult).containsExactly(result1, result2);
Expand Down
Loading

0 comments on commit 9bcbda3

Please sign in to comment.