Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Initial implementation of EngineGetPayloadV2 #4833

Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,7 @@ public enum RpcMethod {
DEBUG_GET_BAD_BLOCKS("debug_getBadBlocks"),

ENGINE_GET_PAYLOAD("engine_getPayloadV1"),
ENGINE_GET_PAYLOAD_V2("engine_getPayloadV2"),
ENGINE_EXECUTE_PAYLOAD("engine_executePayloadV1"),
ENGINE_NEW_PAYLOAD("engine_newPayloadV1"),
ENGINE_FORKCHOICE_UPDATED("engine_forkchoiceUpdatedV1"),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,13 +20,11 @@
import org.hyperledger.besu.consensus.merge.blockcreation.MergeMiningCoordinator;
import org.hyperledger.besu.consensus.merge.blockcreation.PayloadIdentifier;
import org.hyperledger.besu.ethereum.ProtocolContext;
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.methods.ExecutionEngineJsonRpcMethod;
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.response.JsonRpcResponse;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcSuccessResponse;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.BlockResultFactory;
import org.hyperledger.besu.ethereum.core.Block;

Expand All @@ -36,13 +34,13 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class EngineGetPayload extends ExecutionEngineJsonRpcMethod {
public abstract class AbstractEngineGetPayload extends ExecutionEngineJsonRpcMethod {

private final MergeMiningCoordinator mergeMiningCoordinator;
private final BlockResultFactory blockResultFactory;
private static final Logger LOG = LoggerFactory.getLogger(EngineGetPayload.class);
protected final BlockResultFactory blockResultFactory;
private static final Logger LOG = LoggerFactory.getLogger(AbstractEngineGetPayload.class);

public EngineGetPayload(
public AbstractEngineGetPayload(
final Vertx vertx,
final ProtocolContext protocolContext,
final MergeMiningCoordinator mergeMiningCoordinator,
Expand All @@ -53,11 +51,6 @@ public EngineGetPayload(
this.blockResultFactory = blockResultFactory;
}

@Override
public String getName() {
return RpcMethod.ENGINE_GET_PAYLOAD.getMethodName();
}

@Override
public JsonRpcResponse syncResponse(final JsonRpcRequestContext request) {
engineCallListener.executionEngineCalled();
Expand All @@ -66,21 +59,22 @@ public JsonRpcResponse syncResponse(final JsonRpcRequestContext request) {
mergeMiningCoordinator.finalizeProposalById(payloadId);
final Optional<Block> block = mergeContext.get().retrieveBlockById(payloadId);
if (block.isPresent()) {
var proposal = block.get();
var proposalHeader = proposal.getHeader();
final var proposal = block.get();
final var proposalHeader = proposal.getHeader();
infoLambda(
LOG,
"Fetch block proposal by identifier: {}, hash: {}, number: {}, coinbase: {}, transaction count: {}",
() -> payloadId.toHexString(),
() -> proposalHeader.getHash(),
() -> proposalHeader.getNumber(),
() -> proposalHeader.getCoinbase(),
payloadId::toHexString,
proposalHeader::getHash,
proposalHeader::getNumber,
proposalHeader::getCoinbase,
() -> proposal.getBody().getTransactions().size());
debugLambda(LOG, "assembledBlock {}", () -> block.map(Block::toString).get());
return new JsonRpcSuccessResponse(
request.getRequest().getId(),
blockResultFactory.enginePayloadTransactionComplete(block.get()));
return createResponse(request, block.get());
}
return new JsonRpcErrorResponse(request.getRequest().getId(), JsonRpcError.UNKNOWN_PAYLOAD);
}

protected abstract JsonRpcResponse createResponse(
final JsonRpcRequestContext request, final Block block);
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/*
* 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.engine;

import org.hyperledger.besu.consensus.merge.blockcreation.MergeMiningCoordinator;
import org.hyperledger.besu.ethereum.ProtocolContext;
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.response.JsonRpcResponse;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcSuccessResponse;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.BlockResultFactory;
import org.hyperledger.besu.ethereum.core.Block;

import io.vertx.core.Vertx;

public class EngineGetPayloadV1 extends AbstractEngineGetPayload {

public EngineGetPayloadV1(
final Vertx vertx,
final ProtocolContext protocolContext,
final MergeMiningCoordinator mergeMiningCoordinator,
final BlockResultFactory blockResultFactory,
final EngineCallListener engineCallListener) {
super(vertx, protocolContext, mergeMiningCoordinator, blockResultFactory, engineCallListener);
}

@Override
public String getName() {
return RpcMethod.ENGINE_GET_PAYLOAD.getMethodName();
}

@Override
protected JsonRpcResponse createResponse(final JsonRpcRequestContext request, final Block block) {
return new JsonRpcSuccessResponse(
request.getRequest().getId(), blockResultFactory.payloadTransactionCompleteV1(block));
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
/*
* 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.engine;

import org.hyperledger.besu.consensus.merge.blockcreation.MergeMiningCoordinator;
import org.hyperledger.besu.ethereum.ProtocolContext;
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.response.JsonRpcResponse;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.response.JsonRpcSuccessResponse;
import org.hyperledger.besu.ethereum.api.jsonrpc.internal.results.BlockResultFactory;
import org.hyperledger.besu.ethereum.core.Block;

import io.vertx.core.Vertx;

public class EngineGetPayloadV2 extends AbstractEngineGetPayload {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is better than extending EngineGetPayload 👍


public EngineGetPayloadV2(
final Vertx vertx,
final ProtocolContext protocolContext,
final MergeMiningCoordinator mergeMiningCoordinator,
final BlockResultFactory blockResultFactory,
final EngineCallListener engineCallListener) {
super(vertx, protocolContext, mergeMiningCoordinator, blockResultFactory, engineCallListener);
}

@Override
public String getName() {
return RpcMethod.ENGINE_GET_PAYLOAD_V2.getMethodName();
}

@Override
protected JsonRpcResponse createResponse(final JsonRpcRequestContext request, final Block block) {
return new JsonRpcSuccessResponse(
request.getRequest().getId(), blockResultFactory.payloadTransactionCompleteV2(block));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -85,14 +85,29 @@ public BlockResult transactionComplete(final Block block) {
block.getHeader(), txs, ommers, block.getHeader().getDifficulty(), block.calculateSize());
}

public EngineGetPayloadResult enginePayloadTransactionComplete(final Block block) {
public EngineGetPayloadResultV1 payloadTransactionCompleteV1(final Block block) {
final List<String> txs =
block.getBody().getTransactions().stream()
.map(TransactionEncoder::encodeOpaqueBytes)
.map(Bytes::toHexString)
.collect(Collectors.toList());

return new EngineGetPayloadResult(block.getHeader(), txs);
return new EngineGetPayloadResultV1(block.getHeader(), txs);
}

public EngineGetPayloadResultV2 payloadTransactionCompleteV2(final Block block) {
final List<String> txs =
block.getBody().getTransactions().stream()
.map(TransactionEncoder::encodeOpaqueBytes)
.map(Bytes::toHexString)
.collect(Collectors.toList());

final long blockValue = calculateBlockValue(txs);
return new EngineGetPayloadResultV2(block.getHeader(), txs, Quantity.create(blockValue));
}

private long calculateBlockValue(final List<String> ignored) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good idea to separate out for later implementation 👍

Check notice

Code scanning / CodeQL

Useless parameter

The parameter 'ignored' is never used.
return 0L;
}

public BlockResult transactionHash(final BlockWithMetadata<Hash, Hash> blockWithMetadata) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
"blockHash",
"transactions"
})
public class EngineGetPayloadResult {
public class EngineGetPayloadResultV1 {
protected final String blockHash;
private final String parentHash;
private final String feeRecipient;
Expand All @@ -55,7 +55,7 @@ public class EngineGetPayloadResult {
private final String baseFeePerGas;
protected final List<String> transactions;

public EngineGetPayloadResult(final BlockHeader header, final List<String> transactions) {
public EngineGetPayloadResultV1(final BlockHeader header, final List<String> transactions) {
this.blockNumber = Quantity.create(header.getNumber());
this.blockHash = header.getHash().toString();
this.parentHash = header.getParentHash().toString();
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,155 @@
/*
* 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.results;

import org.hyperledger.besu.ethereum.core.BlockHeader;

import java.util.List;

import com.fasterxml.jackson.annotation.JsonGetter;
import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonPropertyOrder;
import org.apache.tuweni.bytes.Bytes32;

@JsonPropertyOrder({
"executionPayload",
"blockValue",
})
public class EngineGetPayloadResultV2 {
protected final PayloadResult executionPayload;
private final String blockValue;

public EngineGetPayloadResultV2(
final BlockHeader header, final List<String> transactions, final String blockValue) {
this.executionPayload = new PayloadResult(header, transactions);
this.blockValue = blockValue;
}

@JsonGetter(value = "executionPayload")
public PayloadResult getExecutionPayload() {
return executionPayload;
}

@JsonGetter(value = "blockValue")
public String getBlockValue() {
return blockValue;
}

public static class PayloadResult {

protected final String blockHash;
private final String parentHash;
private final String feeRecipient;
private final String stateRoot;
private final String receiptsRoot;
private final String logsBloom;
private final String prevRandao;
private final String blockNumber;
private final String gasLimit;
private final String gasUsed;
private final String timestamp;
private final String extraData;
private final String baseFeePerGas;
protected final List<String> transactions;

public PayloadResult(final BlockHeader header, final List<String> transactions) {
this.blockNumber = Quantity.create(header.getNumber());
this.blockHash = header.getHash().toString();
this.parentHash = header.getParentHash().toString();
this.logsBloom = header.getLogsBloom().toString();
this.stateRoot = header.getStateRoot().toString();
this.receiptsRoot = header.getReceiptsRoot().toString();
this.extraData = header.getExtraData().toString();
this.baseFeePerGas = header.getBaseFee().map(Quantity::create).orElse(null);
this.gasLimit = Quantity.create(header.getGasLimit());
this.gasUsed = Quantity.create(header.getGasUsed());
this.timestamp = Quantity.create(header.getTimestamp());
this.transactions = transactions;
this.feeRecipient = header.getCoinbase().toString();
this.prevRandao = header.getPrevRandao().map(Bytes32::toHexString).orElse(null);
}

@JsonGetter(value = "blockNumber")
public String getNumber() {
return blockNumber;
}

@JsonGetter(value = "blockHash")
public String getHash() {
return blockHash;
}

@JsonGetter(value = "parentHash")
public String getParentHash() {
return parentHash;
}

@JsonGetter(value = "logsBloom")
public String getLogsBloom() {
return logsBloom;
}

@JsonGetter(value = "prevRandao")
public String getPrevRandao() {
return prevRandao;
}

@JsonGetter(value = "stateRoot")
public String getStateRoot() {
return stateRoot;
}

@JsonGetter(value = "receiptsRoot")
public String getReceiptRoot() {
return receiptsRoot;
}

@JsonGetter(value = "extraData")
public String getExtraData() {
return extraData;
}

@JsonGetter(value = "baseFeePerGas")
public String getBaseFeePerGas() {
return baseFeePerGas;
}

@JsonGetter(value = "gasLimit")
public String getGasLimit() {
return gasLimit;
}

@JsonGetter(value = "gasUsed")
public String getGasUsed() {
return gasUsed;
}

@JsonGetter(value = "timestamp")
public String getTimestamp() {
return timestamp;
}

@JsonGetter(value = "transactions")
public List<String> getTransactions() {
return transactions;
}

@JsonGetter(value = "feeRecipient")
@JsonInclude(JsonInclude.Include.NON_NULL)
public String getFeeRecipient() {
return feeRecipient;
}
}
}
Loading