forked from cerc-io/plugeth
a8a87586c1
GetPayloadVX should only return payloads which match its version. GetPayloadV2 is a special snowflake that supports v1 and v2 payloads. This change uses a a version-specific prefix within in the payload id, basically a namespace for the version number.
306 lines
12 KiB
Go
306 lines
12 KiB
Go
// Copyright 2022 The go-ethereum Authors
|
|
// This file is part of the go-ethereum library.
|
|
//
|
|
// The go-ethereum library is free software: you can redistribute it and/or modify
|
|
// it under the terms of the GNU Lesser General Public License as published by
|
|
// the Free Software Foundation, either version 3 of the License, or
|
|
// (at your option) any later version.
|
|
//
|
|
// The go-ethereum library is distributed in the hope that it will be useful,
|
|
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
// GNU Lesser General Public License for more details.
|
|
//
|
|
// You should have received a copy of the GNU Lesser General Public License
|
|
// along with the go-ethereum library. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
package engine
|
|
|
|
import (
|
|
"fmt"
|
|
"math/big"
|
|
|
|
"github.com/ethereum/go-ethereum/common"
|
|
"github.com/ethereum/go-ethereum/common/hexutil"
|
|
"github.com/ethereum/go-ethereum/core/types"
|
|
"github.com/ethereum/go-ethereum/trie"
|
|
)
|
|
|
|
// PayloadVersion denotes the version of PayloadAttributes used to request the
|
|
// building of the payload to commence.
|
|
type PayloadVersion byte
|
|
|
|
var (
|
|
PayloadV1 PayloadVersion = 0x1
|
|
PayloadV2 PayloadVersion = 0x2
|
|
PayloadV3 PayloadVersion = 0x3
|
|
)
|
|
|
|
//go:generate go run github.com/fjl/gencodec -type PayloadAttributes -field-override payloadAttributesMarshaling -out gen_blockparams.go
|
|
|
|
// PayloadAttributes describes the environment context in which a block should
|
|
// be built.
|
|
type PayloadAttributes struct {
|
|
Timestamp uint64 `json:"timestamp" gencodec:"required"`
|
|
Random common.Hash `json:"prevRandao" gencodec:"required"`
|
|
SuggestedFeeRecipient common.Address `json:"suggestedFeeRecipient" gencodec:"required"`
|
|
Withdrawals []*types.Withdrawal `json:"withdrawals"`
|
|
BeaconRoot *common.Hash `json:"parentBeaconBlockRoot"`
|
|
}
|
|
|
|
// JSON type overrides for PayloadAttributes.
|
|
type payloadAttributesMarshaling struct {
|
|
Timestamp hexutil.Uint64
|
|
}
|
|
|
|
//go:generate go run github.com/fjl/gencodec -type ExecutableData -field-override executableDataMarshaling -out gen_ed.go
|
|
|
|
// ExecutableData is the data necessary to execute an EL payload.
|
|
type ExecutableData struct {
|
|
ParentHash common.Hash `json:"parentHash" gencodec:"required"`
|
|
FeeRecipient common.Address `json:"feeRecipient" gencodec:"required"`
|
|
StateRoot common.Hash `json:"stateRoot" gencodec:"required"`
|
|
ReceiptsRoot common.Hash `json:"receiptsRoot" gencodec:"required"`
|
|
LogsBloom []byte `json:"logsBloom" gencodec:"required"`
|
|
Random common.Hash `json:"prevRandao" gencodec:"required"`
|
|
Number uint64 `json:"blockNumber" gencodec:"required"`
|
|
GasLimit uint64 `json:"gasLimit" gencodec:"required"`
|
|
GasUsed uint64 `json:"gasUsed" gencodec:"required"`
|
|
Timestamp uint64 `json:"timestamp" gencodec:"required"`
|
|
ExtraData []byte `json:"extraData" gencodec:"required"`
|
|
BaseFeePerGas *big.Int `json:"baseFeePerGas" gencodec:"required"`
|
|
BlockHash common.Hash `json:"blockHash" gencodec:"required"`
|
|
Transactions [][]byte `json:"transactions" gencodec:"required"`
|
|
Withdrawals []*types.Withdrawal `json:"withdrawals"`
|
|
BlobGasUsed *uint64 `json:"blobGasUsed"`
|
|
ExcessBlobGas *uint64 `json:"excessBlobGas"`
|
|
}
|
|
|
|
// JSON type overrides for executableData.
|
|
type executableDataMarshaling struct {
|
|
Number hexutil.Uint64
|
|
GasLimit hexutil.Uint64
|
|
GasUsed hexutil.Uint64
|
|
Timestamp hexutil.Uint64
|
|
BaseFeePerGas *hexutil.Big
|
|
ExtraData hexutil.Bytes
|
|
LogsBloom hexutil.Bytes
|
|
Transactions []hexutil.Bytes
|
|
BlobGasUsed *hexutil.Uint64
|
|
ExcessBlobGas *hexutil.Uint64
|
|
}
|
|
|
|
//go:generate go run github.com/fjl/gencodec -type ExecutionPayloadEnvelope -field-override executionPayloadEnvelopeMarshaling -out gen_epe.go
|
|
|
|
type ExecutionPayloadEnvelope struct {
|
|
ExecutionPayload *ExecutableData `json:"executionPayload" gencodec:"required"`
|
|
BlockValue *big.Int `json:"blockValue" gencodec:"required"`
|
|
BlobsBundle *BlobsBundleV1 `json:"blobsBundle"`
|
|
Override bool `json:"shouldOverrideBuilder"`
|
|
}
|
|
|
|
type BlobsBundleV1 struct {
|
|
Commitments []hexutil.Bytes `json:"commitments"`
|
|
Proofs []hexutil.Bytes `json:"proofs"`
|
|
Blobs []hexutil.Bytes `json:"blobs"`
|
|
}
|
|
|
|
// JSON type overrides for ExecutionPayloadEnvelope.
|
|
type executionPayloadEnvelopeMarshaling struct {
|
|
BlockValue *hexutil.Big
|
|
}
|
|
|
|
type PayloadStatusV1 struct {
|
|
Status string `json:"status"`
|
|
LatestValidHash *common.Hash `json:"latestValidHash"`
|
|
ValidationError *string `json:"validationError"`
|
|
}
|
|
|
|
type TransitionConfigurationV1 struct {
|
|
TerminalTotalDifficulty *hexutil.Big `json:"terminalTotalDifficulty"`
|
|
TerminalBlockHash common.Hash `json:"terminalBlockHash"`
|
|
TerminalBlockNumber hexutil.Uint64 `json:"terminalBlockNumber"`
|
|
}
|
|
|
|
// PayloadID is an identifier of the payload build process
|
|
type PayloadID [8]byte
|
|
|
|
// Version returns the payload version associated with the identifier.
|
|
func (b PayloadID) Version() PayloadVersion {
|
|
return PayloadVersion(b[0])
|
|
}
|
|
|
|
// Is returns whether the identifier matches any of provided payload versions.
|
|
func (b PayloadID) Is(versions ...PayloadVersion) bool {
|
|
for _, v := range versions {
|
|
if v == b.Version() {
|
|
return true
|
|
}
|
|
}
|
|
return false
|
|
}
|
|
|
|
func (b PayloadID) String() string {
|
|
return hexutil.Encode(b[:])
|
|
}
|
|
|
|
func (b PayloadID) MarshalText() ([]byte, error) {
|
|
return hexutil.Bytes(b[:]).MarshalText()
|
|
}
|
|
|
|
func (b *PayloadID) UnmarshalText(input []byte) error {
|
|
err := hexutil.UnmarshalFixedText("PayloadID", input, b[:])
|
|
if err != nil {
|
|
return fmt.Errorf("invalid payload id %q: %w", input, err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
type ForkChoiceResponse struct {
|
|
PayloadStatus PayloadStatusV1 `json:"payloadStatus"`
|
|
PayloadID *PayloadID `json:"payloadId"`
|
|
}
|
|
|
|
type ForkchoiceStateV1 struct {
|
|
HeadBlockHash common.Hash `json:"headBlockHash"`
|
|
SafeBlockHash common.Hash `json:"safeBlockHash"`
|
|
FinalizedBlockHash common.Hash `json:"finalizedBlockHash"`
|
|
}
|
|
|
|
func encodeTransactions(txs []*types.Transaction) [][]byte {
|
|
var enc = make([][]byte, len(txs))
|
|
for i, tx := range txs {
|
|
enc[i], _ = tx.MarshalBinary()
|
|
}
|
|
return enc
|
|
}
|
|
|
|
func decodeTransactions(enc [][]byte) ([]*types.Transaction, error) {
|
|
var txs = make([]*types.Transaction, len(enc))
|
|
for i, encTx := range enc {
|
|
var tx types.Transaction
|
|
if err := tx.UnmarshalBinary(encTx); err != nil {
|
|
return nil, fmt.Errorf("invalid transaction %d: %v", i, err)
|
|
}
|
|
txs[i] = &tx
|
|
}
|
|
return txs, nil
|
|
}
|
|
|
|
// ExecutableDataToBlock constructs a block from executable data.
|
|
// It verifies that the following fields:
|
|
//
|
|
// len(extraData) <= 32
|
|
// uncleHash = emptyUncleHash
|
|
// difficulty = 0
|
|
// if versionedHashes != nil, versionedHashes match to blob transactions
|
|
//
|
|
// and that the blockhash of the constructed block matches the parameters. Nil
|
|
// Withdrawals value will propagate through the returned block. Empty
|
|
// Withdrawals value must be passed via non-nil, length 0 value in params.
|
|
func ExecutableDataToBlock(params ExecutableData, versionedHashes []common.Hash, beaconRoot *common.Hash) (*types.Block, error) {
|
|
txs, err := decodeTransactions(params.Transactions)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
if len(params.ExtraData) > 32 {
|
|
return nil, fmt.Errorf("invalid extradata length: %v", len(params.ExtraData))
|
|
}
|
|
if len(params.LogsBloom) != 256 {
|
|
return nil, fmt.Errorf("invalid logsBloom length: %v", len(params.LogsBloom))
|
|
}
|
|
// Check that baseFeePerGas is not negative or too big
|
|
if params.BaseFeePerGas != nil && (params.BaseFeePerGas.Sign() == -1 || params.BaseFeePerGas.BitLen() > 256) {
|
|
return nil, fmt.Errorf("invalid baseFeePerGas: %v", params.BaseFeePerGas)
|
|
}
|
|
var blobHashes []common.Hash
|
|
for _, tx := range txs {
|
|
blobHashes = append(blobHashes, tx.BlobHashes()...)
|
|
}
|
|
if len(blobHashes) != len(versionedHashes) {
|
|
return nil, fmt.Errorf("invalid number of versionedHashes: %v blobHashes: %v", versionedHashes, blobHashes)
|
|
}
|
|
for i := 0; i < len(blobHashes); i++ {
|
|
if blobHashes[i] != versionedHashes[i] {
|
|
return nil, fmt.Errorf("invalid versionedHash at %v: %v blobHashes: %v", i, versionedHashes, blobHashes)
|
|
}
|
|
}
|
|
// Only set withdrawalsRoot if it is non-nil. This allows CLs to use
|
|
// ExecutableData before withdrawals are enabled by marshaling
|
|
// Withdrawals as the json null value.
|
|
var withdrawalsRoot *common.Hash
|
|
if params.Withdrawals != nil {
|
|
h := types.DeriveSha(types.Withdrawals(params.Withdrawals), trie.NewStackTrie(nil))
|
|
withdrawalsRoot = &h
|
|
}
|
|
header := &types.Header{
|
|
ParentHash: params.ParentHash,
|
|
UncleHash: types.EmptyUncleHash,
|
|
Coinbase: params.FeeRecipient,
|
|
Root: params.StateRoot,
|
|
TxHash: types.DeriveSha(types.Transactions(txs), trie.NewStackTrie(nil)),
|
|
ReceiptHash: params.ReceiptsRoot,
|
|
Bloom: types.BytesToBloom(params.LogsBloom),
|
|
Difficulty: common.Big0,
|
|
Number: new(big.Int).SetUint64(params.Number),
|
|
GasLimit: params.GasLimit,
|
|
GasUsed: params.GasUsed,
|
|
Time: params.Timestamp,
|
|
BaseFee: params.BaseFeePerGas,
|
|
Extra: params.ExtraData,
|
|
MixDigest: params.Random,
|
|
WithdrawalsHash: withdrawalsRoot,
|
|
ExcessBlobGas: params.ExcessBlobGas,
|
|
BlobGasUsed: params.BlobGasUsed,
|
|
ParentBeaconRoot: beaconRoot,
|
|
}
|
|
block := types.NewBlockWithHeader(header).WithBody(txs, nil /* uncles */).WithWithdrawals(params.Withdrawals)
|
|
if block.Hash() != params.BlockHash {
|
|
return nil, fmt.Errorf("blockhash mismatch, want %x, got %x", params.BlockHash, block.Hash())
|
|
}
|
|
return block, nil
|
|
}
|
|
|
|
// BlockToExecutableData constructs the ExecutableData structure by filling the
|
|
// fields from the given block. It assumes the given block is post-merge block.
|
|
func BlockToExecutableData(block *types.Block, fees *big.Int, sidecars []*types.BlobTxSidecar) *ExecutionPayloadEnvelope {
|
|
data := &ExecutableData{
|
|
BlockHash: block.Hash(),
|
|
ParentHash: block.ParentHash(),
|
|
FeeRecipient: block.Coinbase(),
|
|
StateRoot: block.Root(),
|
|
Number: block.NumberU64(),
|
|
GasLimit: block.GasLimit(),
|
|
GasUsed: block.GasUsed(),
|
|
BaseFeePerGas: block.BaseFee(),
|
|
Timestamp: block.Time(),
|
|
ReceiptsRoot: block.ReceiptHash(),
|
|
LogsBloom: block.Bloom().Bytes(),
|
|
Transactions: encodeTransactions(block.Transactions()),
|
|
Random: block.MixDigest(),
|
|
ExtraData: block.Extra(),
|
|
Withdrawals: block.Withdrawals(),
|
|
BlobGasUsed: block.BlobGasUsed(),
|
|
ExcessBlobGas: block.ExcessBlobGas(),
|
|
}
|
|
bundle := BlobsBundleV1{
|
|
Commitments: make([]hexutil.Bytes, 0),
|
|
Blobs: make([]hexutil.Bytes, 0),
|
|
Proofs: make([]hexutil.Bytes, 0),
|
|
}
|
|
for _, sidecar := range sidecars {
|
|
for j := range sidecar.Blobs {
|
|
bundle.Blobs = append(bundle.Blobs, hexutil.Bytes(sidecar.Blobs[j][:]))
|
|
bundle.Commitments = append(bundle.Commitments, hexutil.Bytes(sidecar.Commitments[j][:]))
|
|
bundle.Proofs = append(bundle.Proofs, hexutil.Bytes(sidecar.Proofs[j][:]))
|
|
}
|
|
}
|
|
return &ExecutionPayloadEnvelope{ExecutionPayload: data, BlockValue: fees, BlobsBundle: &bundle, Override: false}
|
|
}
|
|
|
|
// ExecutionPayloadBodyV1 is used in the response to GetPayloadBodiesByHashV1 and GetPayloadBodiesByRangeV1
|
|
type ExecutionPayloadBodyV1 struct {
|
|
TransactionData []hexutil.Bytes `json:"transactions"`
|
|
Withdrawals []*types.Withdrawal `json:"withdrawals"`
|
|
}
|