2021-08-18 23:11:38 +00:00
# The Merge -- Honest Validator
2021-03-11 12:33:36 +00:00
**Notice**: This document is a work-in-progress for researchers and implementers.
## Table of contents
<!-- TOC -->
<!-- START doctoc generated TOC please keep comment here to allow auto update -->
<!-- DON'T EDIT THIS SECTION, INSTEAD RE - RUN doctoc TO UPDATE -->
- [Introduction ](#introduction )
- [Prerequisites ](#prerequisites )
2021-05-10 13:48:37 +00:00
- [Protocols ](#protocols )
- [`ExecutionEngine` ](#executionengine )
2021-09-20 14:57:45 +00:00
- [`prepare_payload` ](#prepare_payload )
- [`get_payload` ](#get_payload )
2021-03-11 12:33:36 +00:00
- [Beacon chain responsibilities ](#beacon-chain-responsibilities )
- [Block proposal ](#block-proposal )
- [Constructing the `BeaconBlockBody` ](#constructing-the-beaconblockbody )
2021-09-20 14:57:45 +00:00
- [ExecutionPayload ](#executionpayload )
2021-03-11 12:33:36 +00:00
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
<!-- /TOC -->
## Introduction
This document represents the changes to be made in the code of an "honest validator" to implement executable beacon chain proposal.
## Prerequisites
2021-07-22 14:36:41 +00:00
This document is an extension of the [Altair -- Honest Validator ](../altair/validator.md ) guide.
All behaviors and definitions defined in this document, and documents it extends, carry over unless explicitly noted or overridden.
2021-03-11 12:33:36 +00:00
2021-07-22 14:36:41 +00:00
All terminology, constants, functions, and protocol mechanics defined in the updated Beacon Chain doc of [The Merge ](./beacon-chain.md ) are requisite for this document and used throughout.
Please see related Beacon Chain doc before continuing and use them as a reference throughout.
2021-03-11 12:33:36 +00:00
2021-05-10 13:48:37 +00:00
## Protocols
### `ExecutionEngine`
The following methods are added to the `ExecutionEngine` protocol for use as a validator:
2021-09-20 14:57:45 +00:00
#### `prepare_payload`
2021-05-10 13:48:37 +00:00
2021-09-20 14:57:45 +00:00
Given the set of execution payload attributes initiates a process of building an execution payload
on top of the execution chain tip identified by `parent_hash` .
2021-05-10 13:48:37 +00:00
2021-09-20 14:57:45 +00:00
```python
def prepare_payload(self: ExecutionEngine,
parent_hash: Hash32,
timestamp: uint64,
random: Bytes32,
fee_recipient: Bytes20) -> uint64:
"""
Returns ``payload_id`` that is used to obtain the execution payload in a subsequent ``get_payload`` call.
"""
...
```
#### `get_payload`
Given the `payload_id` returns the most recent version of the execution payload that
has been built since the corresponding call to `prepare_payload` method.
2021-05-10 13:48:37 +00:00
```python
2021-09-20 14:57:45 +00:00
def get_payload(self: ExecutionEngine, payload_id: uint64) -> ExecutionPayload:
"""
Returns ``execution_payload`` object.
"""
2021-05-10 13:48:37 +00:00
...
```
2021-09-20 14:57:45 +00:00
The body of each of these functions is implementation dependent.
The Engine API may be used to implement them with an external execution engine.
2021-03-11 12:33:36 +00:00
## Beacon chain responsibilities
2021-04-08 08:29:05 +00:00
All validator responsibilities remain unchanged other than those noted below. Namely, the transition block handling and the addition of `ExecutionPayload` .
2021-03-11 12:33:36 +00:00
### Block proposal
#### Constructing the `BeaconBlockBody`
2021-09-20 14:57:45 +00:00
##### ExecutionPayload
2021-03-11 12:33:36 +00:00
2021-09-20 14:57:45 +00:00
To obtain an execution payload a proposer of a block must take the following actions:
1. Set `payload_id = prepare_execution_payload(state, pow_chain, fee_recipient, execution_engine)` , where:
* `state` is the state for which `is_proposer(state, validator_index)` returns `True`
* `pow_chain` is a list that abstractly represents all blocks in the PoW chain
* `fee_recipient` is the value suggested to be used for the `coinbase` field of the execution payload
2021-03-11 12:33:36 +00:00
2021-07-17 06:33:06 +00:00
```python
2021-07-20 11:37:52 +00:00
def get_pow_block_at_total_difficulty(total_difficulty: uint256, pow_chain: Sequence[PowBlock]) -> Optional[PowBlock]:
2021-07-17 06:33:06 +00:00
# `pow_chain` abstractly represents all blocks in the PoW chain
for block in pow_chain:
parent = get_pow_block(block.parent_hash)
if block.total_difficulty >= total_difficulty and parent.total_difficulty < total_difficulty:
return block
return None
2021-03-11 12:33:36 +00:00
2021-09-20 14:57:45 +00:00
def prepare_execution_payload(state: BeaconState,
pow_chain: Sequence[PowBlock],
fee_recipient: Bytes20,
execution_engine: ExecutionEngine) -> Optional[uint64]:
2021-06-18 10:09:30 +00:00
if not is_merge_complete(state):
2021-09-17 10:20:25 +00:00
terminal_pow_block = get_pow_block_at_total_difficulty(TERMINAL_TOTAL_DIFFICULTY, pow_chain)
2021-07-17 06:33:06 +00:00
if terminal_pow_block is None:
2021-09-20 14:57:45 +00:00
# Pre-merge, no prepare payload call is needed
return None
2021-03-25 11:49:13 +00:00
else:
2021-03-31 09:35:55 +00:00
# Signify merge via producing on top of the last PoW block
2021-09-20 14:57:45 +00:00
parent_hash = terminal_pow_block.block_hash
else:
# Post-merge, normal payload
parent_hash = state.latest_execution_payload_header.block_hash
timestamp = compute_timestamp_at_slot(state, state.slot)
random = get_randao_mix(state, get_current_epoch(state))
return execution_engine.prepare_payload(parent_hash, timestamp, random, fee_recipient)
```
2. Set `block.body.execution_payload = get_execution_payload(payload_id, execution_engine)` , where:
2021-03-24 10:30:29 +00:00
2021-09-20 14:57:45 +00:00
```python
def get_execution_payload(payload_id: Optional[uint64], execution_engine: ExecutionEngine) -> ExecutionPayload:
if payload_id is None:
# Pre-merge, empty payload
return ExecutionPayload()
else:
return execution_engine.get_payload(payload_id)
2021-03-11 12:33:36 +00:00
```
2021-09-20 14:57:45 +00:00
*Note*: It is recommended for a validator to call `prepare_execution_payload` as soon as input parameters become known,
and make subsequent calls to this function if any of these parameters has been updated.