Feature/trace callmany

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/RpcMethod.java

@@ -158,6 +158,7 @@ public enum RpcMethod {
  TRACE_REPLAY_BLOCK_TRANSACTIONS("trace_replayBlockTransactions"),
  TRACE_BLOCK("trace_block"),
  TRACE_CALL("trace_call"),
+ TRACE_CALL_MANY("trace_callMany"),
  TRACE_TRANSACTION("trace_transaction"),
  TRACE_FILTER("trace_filter"),
  TX_POOL_BESU_STATISTICS("txpool_besuStatistics"),

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/TraceCall.java

@@ -36,7 +36,12 @@
 import java.util.Optional;
 import java.util.Set;
 
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
 public class TraceCall extends AbstractTraceByBlock implements JsonRpcMethod {
+ private static final Logger LOG = LoggerFactory.getLogger(TraceCall.class);
+
  public TraceCall(
  final BlockchainQueries blockchainQueries,
  final ProtocolSchedule protocolSchedule,
@@ -86,6 +91,15 @@ protected Object resultByBlockNumber(
  maybeBlockHeader.get());
 
  if (maybeSimulatorResult.isEmpty()) {
+ LOG.error(
+ "Empty simulator result, call params: {}, blockHeader: {} ",
+ JsonCallParameterUtil.validateAndGetCallParams(requestContext),
+ maybeBlockHeader.get());
+ return new JsonRpcErrorResponse(requestContext.getRequest().getId(), INTERNAL_ERROR);
+ }
+
+ if (maybeSimulatorResult.get().isInvalid()) {
+ LOG.error("Invalid simulator result: " + maybeSimulatorResult);
  return new JsonRpcErrorResponse(requestContext.getRequest().getId(), INTERNAL_ERROR);
  }
 

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/methods/TraceCallMany.java

@@ -0,0 +1,185 @@
+/*
+ * Copyright Hyperledger Besu Contributors.
+ *
+ * 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.response.JsonRpcError.BLOCK_NOT_FOUND;
+import static org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcError.INTERNAL_ERROR;
+
+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.parameters.BlockParameter;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.JsonCallParameter;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.parameters.TraceCallManyParameter;
+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.response.JsonRpcError;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcErrorResponse;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.tracing.flat.FlatTrace;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.tracing.flat.MixInIgnoreRevertReason;
+import org.hyperledger.besu.ethereum.api.query.BlockchainQueries;
+import org.hyperledger.besu.ethereum.core.Block;
+import org.hyperledger.besu.ethereum.core.BlockHeader;
+import org.hyperledger.besu.ethereum.mainnet.ProtocolSchedule;
+import org.hyperledger.besu.ethereum.transaction.TransactionSimulator;
+import org.hyperledger.besu.ethereum.transaction.TransactionSimulatorResult;
+import org.hyperledger.besu.ethereum.vm.DebugOperationTracer;
+import org.hyperledger.besu.evm.worldstate.WorldUpdater;
+
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Optional;
+import java.util.Set;
+
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+public class TraceCallMany extends TraceCall implements JsonRpcMethod {
+
+ private static final Logger LOG = LoggerFactory.getLogger(TraceCallMany.class);
+ private static final ObjectMapper MAPPER_IGNORE_REVERT_REASON = new ObjectMapper();
+
+ public TraceCallMany(
+ final BlockchainQueries blockchainQueries,
+ final ProtocolSchedule protocolSchedule,
+ final TransactionSimulator transactionSimulator) {
+ super(blockchainQueries, protocolSchedule, transactionSimulator);
+
+ // The trace_call specification does not output the revert reason, so we have to remove it
+ MAPPER_IGNORE_REVERT_REASON.addMixIn(FlatTrace.class, MixInIgnoreRevertReason.class);
+ }
+
+ @Override
+ public String getName() {
+ return transactionSimulator != null ? RpcMethod.TRACE_CALL_MANY.getMethodName() : null;
+ }
+
+ @Override
+ protected BlockParameter blockParameter(final JsonRpcRequestContext request) {
+ final Optional<BlockParameter> maybeBlockParameter =
+ request.getOptionalParameter(2, BlockParameter.class);
+
+ if (maybeBlockParameter.isPresent()) {
+ return maybeBlockParameter.get();
+ }
+
+ return BlockParameter.LATEST;
+ }
+
+ @Override
+ protected Object resultByBlockNumber(
+ final JsonRpcRequestContext requestContext, final long blockNumber) {
+
+ if (requestContext.getRequest().getParamLength() != 2) {
+ return new JsonRpcErrorResponse(
+ requestContext.getRequest().getId(), JsonRpcError.INVALID_PARAMS);
+ }
+
+ final TraceCallManyParameter[] transactionsAndTraceTypeParameters;
+ try {
+ transactionsAndTraceTypeParameters =
+ requestContext.getRequiredParameter(0, TraceCallManyParameter[].class);
+ } catch (final Exception e) {
+ LOG.error("Error parsing trace call many parameter: {}", e.getLocalizedMessage());
+ return new JsonRpcErrorResponse(
+ requestContext.getRequest().getId(), JsonRpcError.INVALID_PARAMS);
+ }
+
+ final Optional<BlockHeader> maybeBlockHeader =
+ blockchainQueries.get().getBlockHeaderByNumber(blockNumber);
+
+ if (maybeBlockHeader.isEmpty()) {
+ return new JsonRpcErrorResponse(requestContext.getRequest().getId(), BLOCK_NOT_FOUND);
+ }
+
+ final List<JsonNode> traceCallResults = new ArrayList<>();
+
+ final WorldUpdater updater = transactionSimulator.getWorldUpdater(maybeBlockHeader.get());
+ try {
+ Arrays.stream(transactionsAndTraceTypeParameters)
+ .forEachOrdered(
+ param -> {
+ final WorldUpdater finalUpdater = updater.updater();
+ try {
+ traceCallResults.add(
+ getSingleCallResult(
+ param.getTuple().getJsonCallParameter(),
+ param.getTuple().getTraceTypeParameter(),
+ maybeBlockHeader.get(),
+ finalUpdater));
+ } catch (final TransactionInvalidException e) {
+ LOG.error("Invalid transaction simulator result");
+ throw new RuntimeException();
+ } catch (final EmptySimulatorResultException e) {
+ LOG.error(
+ "Empty simulator result, call params: {}, blockHeader: {} ",
+ JsonCallParameterUtil.validateAndGetCallParams(requestContext),
+ maybeBlockHeader.get());
+ throw new RuntimeException();
+ }
+ finalUpdater.commit();
+ });
+ } catch (final Exception e) {
+ return new JsonRpcErrorResponse(requestContext.getRequest().getId(), INTERNAL_ERROR);
+ }
+
+ return traceCallResults;
+ }
+
+ private JsonNode getSingleCallResult(
+ final JsonCallParameter callParameter,
+ final TraceTypeParameter traceTypeParameter,
+ final BlockHeader header,
+ final WorldUpdater worldUpdater) {
+ final Set<TraceTypeParameter.TraceType> traceTypes = traceTypeParameter.getTraceTypes();
+ final DebugOperationTracer tracer = new DebugOperationTracer(buildTraceOptions(traceTypes));
+ final Optional<TransactionSimulatorResult> maybeSimulatorResult =
+ transactionSimulator.processWithWorldUpdater(
+ callParameter, buildTransactionValidationParams(), tracer, header, worldUpdater);
+
+ LOG.trace("Executing {} call for transaction {}", traceTypeParameter, callParameter);
+ if (maybeSimulatorResult.isEmpty()) {
+ throw new EmptySimulatorResultException();
+ }
+ if (maybeSimulatorResult.get().isInvalid()) {
+ throw new TransactionInvalidException();
+ }
+
+ final TransactionTrace transactionTrace =
+ new TransactionTrace(
+ maybeSimulatorResult.get().getTransaction(),
+ maybeSimulatorResult.get().getResult(),
+ tracer.getTraceFrames());
+
+ final Block block = blockchainQueries.get().getBlockchain().getChainHeadBlock();
+
+ return getTraceCallResult(
+ protocolSchedule, traceTypes, maybeSimulatorResult, transactionTrace, block);
+ }
+
+ private static class TransactionInvalidException extends RuntimeException {
+ TransactionInvalidException() {
+ super();
+ }
+ }
+
+ private static class EmptySimulatorResultException extends RuntimeException {
+ EmptySimulatorResultException() {
+ super();
+ }
+ }
+}

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/parameters/TraceCallManyParameter.java

@@ -0,0 +1,61 @@
+/*
+ * 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.parameters;
+
+import java.io.IOException;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.core.JsonParser;
+import com.fasterxml.jackson.databind.DeserializationContext;
+import com.fasterxml.jackson.databind.JsonNode;
+import com.fasterxml.jackson.databind.ObjectMapper;
+import com.fasterxml.jackson.databind.annotation.JsonDeserialize;
+import com.fasterxml.jackson.databind.deser.std.StdDeserializer;
+
+public class TraceCallManyParameter {
+ TraceCallParamterTuple params;
+
+ @JsonCreator
+ public TraceCallManyParameter(
+ @JsonDeserialize(using = TraceCallParameterDeserializer.class)
+ final TraceCallParamterTuple parameters) {
+ this.params = parameters;
+ }
+
+ public TraceCallParamterTuple getTuple() {
+ return this.params;
+ }
+}
+
+class TraceCallParameterDeserializer extends StdDeserializer<TraceCallParamterTuple> {
+
+ public TraceCallParameterDeserializer(final Class<?> vc) {
+ super(vc);
+ }
+
+ public TraceCallParameterDeserializer() {
+ this(null);
+ }
+
+ @Override
+ public TraceCallParamterTuple deserialize(final JsonParser p, final DeserializationContext ctxt)
+ throws IOException {
+ final ObjectMapper mapper = new ObjectMapper();
+ final JsonNode tupleNode = p.getCodec().readTree(p);
+ return new TraceCallParamterTuple(
+ mapper.readValue(tupleNode.get(0).toString(), JsonCallParameter.class),
+ mapper.readValue(tupleNode.get(1).toString(), TraceTypeParameter.class));
+ }
+}

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/internal/parameters/TraceCallParamterTuple.java

@@ -0,0 +1,34 @@
+/*
+ * 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.parameters;
+
+public class TraceCallParamterTuple {
+ private final JsonCallParameter jsonCallParameter;
+ private final TraceTypeParameter traceTypeParameter;
+
+ public TraceCallParamterTuple(
+ final JsonCallParameter callParameter, final TraceTypeParameter traceTypeParameter) {
+ this.jsonCallParameter = callParameter;
+ this.traceTypeParameter = traceTypeParameter;
+ }
+
+ public JsonCallParameter getJsonCallParameter() {
+ return jsonCallParameter;
+ }
+
+ public TraceTypeParameter getTraceTypeParameter() {
+ return traceTypeParameter;
+ }
+}

ethereum/api/src/main/java/org/hyperledger/besu/ethereum/api/jsonrpc/methods/TraceJsonRpcMethods.java

@@ -18,6 +18,7 @@
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.JsonRpcMethod;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.TraceBlock;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.TraceCall;
+import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.TraceCallMany;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.TraceFilter;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.TraceReplayBlockTransactions;
 import org.hyperledger.besu.ethereum.api.jsonrpc.internal.methods.TraceTransaction;
@@ -66,6 +67,14 @@ protected Map<String, JsonRpcMethod> create() {
  () -> new BlockTracer(blockReplay), protocolSchedule, blockchainQueries),
  new TraceBlock(() -> new BlockTracer(blockReplay), protocolSchedule, blockchainQueries),
  new TraceCall(
+ blockchainQueries,
+ protocolSchedule,
+ new TransactionSimulator(
+ blockchainQueries.getBlockchain(),
+ blockchainQueries.getWorldStateArchive(),
+ protocolSchedule,
+ privacyParameters)),
+ new TraceCallMany(
  blockchainQueries,
  protocolSchedule,
  new TransactionSimulator(