Skip to content

Commit 989f10d

Browse files
committed
docs(evm): stop naming a fixed Engine API version in ExecMeta comments
Signed-off-by: elonfliter <elonfliter@outlook.com>
1 parent de0c644 commit 989f10d

2 files changed

Lines changed: 11 additions & 8 deletions

File tree

‎execution/evm/execution.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ func (c *EngineClient) GetTxs(ctx context.Context) ([][]byte, error) {
347347
//
348348
// ExecMeta tracking (if store is configured):
349349
// - Checks for already-promoted blocks to enable idempotent execution
350-
// - Saves ExecMeta with payloadID after forkchoiceUpdatedV3 for crash recovery
350+
// - Saves ExecMeta with the payload ID returned by forkchoiceUpdated for crash recovery
351351
// - Updates ExecMeta to "promoted" after successful execution
352352
func (c *EngineClient) ExecuteTxs(ctx context.Context, txs [][]byte, blockHeight uint64, timestamp time.Time, prevStateRoot []byte) (execution.ExecuteResult, error) {
353353

‎execution/evm/store.go‎

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,21 +35,24 @@ type ExecMeta struct {
3535
Height uint64
3636
// ParentHash is the EL parent block hash used for this execution
3737
ParentHash []byte
38-
// PayloadID is the Engine API payload ID (optional, set after forkchoiceUpdatedV3)
38+
// PayloadID is the Engine API payload ID (optional, set after forkchoiceUpdated)
3939
PayloadID []byte
40-
// BlockHash is the EL block hash once built (set after getPayloadV4)
40+
// BlockHash is the EL block hash once built (set after getPayload)
4141
BlockHash []byte
4242
// StateRoot is the state root from the execution payload
4343
StateRoot []byte
4444
// TxHash is the hash of the transaction list for sanity checks
4545
TxHash []byte
4646
// Timestamp is the block timestamp
4747
Timestamp int64
48-
// Stage indicates the current execution stage:
49-
// "started" - forkchoiceUpdatedV3 called, payloadID obtained
50-
// "built" - getPayloadV4 called, payload retrieved
51-
// "submitted" - newPayloadV4 called, payload marked VALID
52-
// "promoted" - final forkchoiceUpdatedV3 called, block is head
48+
// Stage indicates the current execution stage. forkchoiceUpdated (V3/V4) and
49+
// getPayload (V4/V5/V6) negotiate their version at runtime and fall back on
50+
// "Unsupported fork"; newPayload is picked from the payload fields (V4 or V5)
51+
// and is not retried with another version:
52+
// "started" - forkchoiceUpdated returned a payload ID
53+
// "built" - getPayload returned the payload
54+
// "submitted" - newPayload accepted the payload as VALID
55+
// "promoted" - final forkchoiceUpdated made the block the head
5356
Stage string
5457
// UpdatedAtUnix is the Unix timestamp when this metadata was last updated
5558
UpdatedAtUnix int64

0 commit comments

Comments
 (0)