-
Notifications
You must be signed in to change notification settings - Fork 864
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* abstract trace classes Signed-off-by: Frank Li <b439988l@gmail.com> * add spdx headers Signed-off-by: Frank Li <b439988l@gmail.com>
- Loading branch information
1 parent
58dfe3a
commit b73f5f9
Showing
4 changed files
with
215 additions
and
135 deletions.
There are no files selected for viewing
112 changes: 112 additions & 0 deletions
112
...java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/AbstractTraceByBlock.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| /* | ||
| * Copyright Hyperledger Besu. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on | ||
| * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations under the License. | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
| package org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods; | ||
|
|
||
| import static org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.TraceTypeParameter.TraceType; | ||
|
|
||
| import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.TraceTypeParameter; | ||
| import org.hyperledger.besu.ethereum.api.jsonrpc.internal.processor.TransactionTrace; | ||
| import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.TraceCallResult; | ||
| import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.tracing.diff.StateDiffGenerator; | ||
| import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.tracing.diff.StateDiffTrace; | ||
| import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.tracing.flat.FlatTrace; | ||
| import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.tracing.flat.FlatTraceGenerator; | ||
| import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.tracing.flat.MixInIgnoreRevertReason; | ||
| import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.tracing.vm.VmTrace; | ||
| import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.tracing.vm.VmTraceGenerator; | ||
| import org.hyperledger.besu.ethereum.api.query.BlockchainQueries; | ||
| import org.hyperledger.besu.ethereum.core.Block; | ||
| import org.hyperledger.besu.ethereum.debug.TraceOptions; | ||
| import org.hyperledger.besu.ethereum.mainnet.ImmutableTransactionValidationParams; | ||
| import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule; | ||
| import org.hyperledger.besu.ethereum.mainnet.TransactionValidationParams; | ||
| import org.hyperledger.besu.ethereum.transaction.TransactionSimulator; | ||
| import org.hyperledger.besu.ethereum.transaction.TransactionSimulatorResult; | ||
|
|
||
| import java.util.Optional; | ||
| import java.util.Set; | ||
| import java.util.concurrent.atomic.AtomicInteger; | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
|
|
||
| public abstract class AbstractTraceByBlock extends AbstractBlockParameterMethod | ||
| implements JsonRpcMethod { | ||
| protected final ProtocolSchedule protocolSchedule; | ||
| protected final TransactionSimulator transactionSimulator; | ||
|
|
||
| protected static final ObjectMapper mapper = new ObjectMapper(); | ||
|
|
||
| protected AbstractTraceByBlock( | ||
| final BlockchainQueries blockchainQueries, | ||
| final ProtocolSchedule protocolSchedule, | ||
| final TransactionSimulator transactionSimulator) { | ||
| super(blockchainQueries); | ||
|
|
||
| this.protocolSchedule = protocolSchedule; | ||
| this.transactionSimulator = transactionSimulator; | ||
| } | ||
|
|
||
| protected JsonNode getTraceCallResult( | ||
| final ProtocolSchedule protocolSchedule, | ||
| final Set<TraceTypeParameter.TraceType> traceTypes, | ||
| final Optional<TransactionSimulatorResult> maybeSimulatorResult, | ||
| final TransactionTrace transactionTrace, | ||
| final Block block) { | ||
| final TraceCallResult.Builder builder = TraceCallResult.builder(); | ||
| // The trace_call specification does not output the revert reason, so we have to remove it | ||
| mapper.addMixIn(FlatTrace.class, MixInIgnoreRevertReason.class); | ||
|
|
||
| transactionTrace | ||
| .getResult() | ||
| .getRevertReason() | ||
| .ifPresentOrElse( | ||
| revertReason -> builder.output(revertReason.toHexString()), | ||
| () -> builder.output(maybeSimulatorResult.get().getOutput().toString())); | ||
|
|
||
| if (traceTypes.contains(TraceType.STATE_DIFF)) { | ||
| new StateDiffGenerator() | ||
| .generateStateDiff(transactionTrace) | ||
| .forEachOrdered(stateDiff -> builder.stateDiff((StateDiffTrace) stateDiff)); | ||
| } | ||
|
|
||
| if (traceTypes.contains(TraceType.TRACE)) { | ||
| FlatTraceGenerator.generateFromTransactionTrace( | ||
| protocolSchedule, transactionTrace, block, new AtomicInteger(), false) | ||
| .forEachOrdered(trace -> builder.addTrace((FlatTrace) trace)); | ||
| } | ||
|
|
||
| if (traceTypes.contains(TraceType.VM_TRACE)) { | ||
| new VmTraceGenerator(transactionTrace) | ||
| .generateTraceStream() | ||
| .forEachOrdered(vmTrace -> builder.vmTrace((VmTrace) vmTrace)); | ||
| } | ||
|
|
||
| return mapper.valueToTree(builder.build()); | ||
| } | ||
|
|
||
| protected TransactionValidationParams buildTransactionValidationParams() { | ||
| return ImmutableTransactionValidationParams.builder() | ||
| .from(TransactionValidationParams.transactionSimulator()) | ||
| .build(); | ||
| } | ||
|
|
||
| protected TraceOptions buildTraceOptions(final Set<TraceTypeParameter.TraceType> traceTypes) { | ||
| return new TraceOptions( | ||
| traceTypes.contains(TraceType.STATE_DIFF), | ||
| false, | ||
| traceTypes.contains(TraceType.TRACE) || traceTypes.contains(TraceType.VM_TRACE)); | ||
| } | ||
| } |
94 changes: 94 additions & 0 deletions
94
.../java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/AbstractTraceByHash.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| /* | ||
| * Copyright Hyperledger Besu. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on | ||
| * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations under the License. | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
| package org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods; | ||
|
|
||
| import org.hyperledger.besu.datatypes.Hash; | ||
| 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.TransactionTrace; | ||
| import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.tracing.flat.FlatTrace; | ||
| import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.tracing.flat.FlatTraceGenerator; | ||
| import org.hyperledger.besu.ethereum.api.query.BlockchainQueries; | ||
| import org.hyperledger.besu.ethereum.api.query.TransactionWithMetadata; | ||
| import org.hyperledger.besu.ethereum.core.Block; | ||
| import org.hyperledger.besu.ethereum.debug.TraceOptions; | ||
| import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule; | ||
| import org.hyperledger.besu.ethereum.vm.DebugOperationTracer; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.function.Supplier; | ||
| import java.util.stream.Stream; | ||
|
|
||
| import com.fasterxml.jackson.databind.JsonNode; | ||
| import com.fasterxml.jackson.databind.ObjectMapper; | ||
| import com.fasterxml.jackson.databind.node.ArrayNode; | ||
|
|
||
| public abstract class AbstractTraceByHash implements JsonRpcMethod { | ||
| protected final Supplier<BlockTracer> blockTracerSupplier; | ||
| protected final BlockchainQueries blockchainQueries; | ||
| protected final ProtocolSchedule protocolSchedule; | ||
|
|
||
| protected AbstractTraceByHash( | ||
| final Supplier<BlockTracer> blockTracerSupplier, | ||
| final BlockchainQueries blockchainQueries, | ||
| final ProtocolSchedule protocolSchedule) { | ||
| this.blockTracerSupplier = blockTracerSupplier; | ||
| this.blockchainQueries = blockchainQueries; | ||
| this.protocolSchedule = protocolSchedule; | ||
| } | ||
|
|
||
| public Stream<FlatTrace> resultByTransactionHash(final Hash transactionHash) { | ||
| return blockchainQueries | ||
| .transactionByHash(transactionHash) | ||
| .flatMap(TransactionWithMetadata::getBlockNumber) | ||
| .flatMap(blockNumber -> blockchainQueries.getBlockchain().getBlockByNumber(blockNumber)) | ||
| .map((block) -> getTraceBlock(block, transactionHash)) | ||
| .orElse(Stream.empty()); | ||
| } | ||
|
|
||
| private Stream<FlatTrace> getTraceBlock(final Block block, final Hash transactionHash) { | ||
| if (block == null || block.getBody().getTransactions().isEmpty()) { | ||
| return Stream.empty(); | ||
| } | ||
| final TransactionTrace transactionTrace = getTransactionTrace(block, transactionHash); | ||
| return getTraceStream(transactionTrace, block); | ||
| } | ||
|
|
||
| private TransactionTrace getTransactionTrace(final Block block, final Hash transactionHash) { | ||
| return blockTracerSupplier | ||
| .get() | ||
| .trace(block, new DebugOperationTracer(new TraceOptions(false, false, true))) | ||
| .map(BlockTrace::getTransactionTraces) | ||
| .orElse(Collections.emptyList()) | ||
| .stream() | ||
| .filter(trxTrace -> trxTrace.getTransaction().getHash().equals(transactionHash)) | ||
| .findFirst() | ||
| .orElseThrow(); | ||
| } | ||
|
|
||
| private Stream<FlatTrace> getTraceStream( | ||
| final TransactionTrace transactionTrace, final Block block) { | ||
| return FlatTraceGenerator.generateFromTransactionTraceAndBlock( | ||
| this.protocolSchedule, transactionTrace, block) | ||
| .map(trace -> (FlatTrace) trace); | ||
| } | ||
|
|
||
| protected JsonNode arrayNodeFromTraceStream(final Stream<FlatTrace> traceStream) { | ||
| final ObjectMapper mapper = new ObjectMapper(); | ||
| final ArrayNode resultArrayNode = mapper.createArrayNode(); | ||
| traceStream.forEachOrdered(resultArrayNode::addPOJO); | ||
| return resultArrayNode; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.