eth2.0-specs/specs/phase0/fork-choice.md

728 lines
30 KiB
Markdown
Raw Normal View History

# Phase 0 -- Beacon Chain Fork Choice
2019-04-22 13:20:48 +00:00
## 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 -->
2022-05-09 13:05:05 +00:00
- [Introduction](#introduction)
- [Fork choice](#fork-choice)
- [Constant](#constant)
- [Configuration](#configuration)
- [Helpers](#helpers)
- [`LatestMessage`](#latestmessage)
- [`Store`](#store)
2023-04-21 08:16:51 +00:00
- [`is_previous_epoch_justified`](#is_previous_epoch_justified)
2022-05-09 13:05:05 +00:00
- [`get_forkchoice_store`](#get_forkchoice_store)
- [`get_slots_since_genesis`](#get_slots_since_genesis)
- [`get_current_slot`](#get_current_slot)
- [`compute_slots_since_epoch_start`](#compute_slots_since_epoch_start)
- [`get_ancestor`](#get_ancestor)
- [`calculate_committee_fraction`](#calculate_committee_fraction)
- [`get_checkpoint_block`](#get_checkpoint_block)
- [`get_weight`](#get_weight)
2023-03-09 23:17:11 +00:00
- [`get_voting_source`](#get_voting_source)
2022-05-09 13:05:05 +00:00
- [`filter_block_tree`](#filter_block_tree)
- [`get_filtered_block_tree`](#get_filtered_block_tree)
- [`get_head`](#get_head)
- [`update_checkpoints`](#update_checkpoints)
- [`update_unrealized_checkpoints`](#update_unrealized_checkpoints)
2023-10-19 11:15:49 +00:00
- [Proposer head and reorg helpers](#proposer-head-and-reorg-helpers)
- [`is_head_late`](#is_head_late)
- [`is_shuffling_stable`](#is_shuffling_stable)
- [`is_ffg_competitive`](#is_ffg_competitive)
- [`is_finalization_ok`](#is_finalization_ok)
- [`is_proposing_on_time`](#is_proposing_on_time)
- [`is_head_weak`](#is_head_weak)
- [`is_parent_strong`](#is_parent_strong)
- [`get_proposer_head`](#get_proposer_head)
2023-03-09 23:17:11 +00:00
- [Pull-up tip helpers](#pull-up-tip-helpers)
- [`compute_pulled_up_tip`](#compute_pulled_up_tip)
- [`on_tick` helpers](#on_tick-helpers)
- [`on_tick_per_slot`](#on_tick_per_slot)
2022-05-09 13:05:05 +00:00
- [`on_attestation` helpers](#on_attestation-helpers)
- [`validate_target_epoch_against_current_time`](#validate_target_epoch_against_current_time)
- [`validate_on_attestation`](#validate_on_attestation)
- [`store_target_checkpoint_state`](#store_target_checkpoint_state)
- [`update_latest_messages`](#update_latest_messages)
- [Handlers](#handlers)
- [`on_tick`](#on_tick)
- [`on_block`](#on_block)
- [`on_attestation`](#on_attestation)
- [`on_attester_slashing`](#on_attester_slashing)
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
2019-04-22 13:20:48 +00:00
<!-- /TOC -->
## Introduction
This document is the beacon chain fork choice spec, part of Phase 0. It assumes the [beacon chain state transition function spec](./beacon-chain.md).
2019-06-15 22:42:03 +00:00
## Fork choice
The head block root associated with a `store` is defined as `get_head(store)`. At genesis, let `store = get_forkchoice_store(genesis_state, genesis_block)` and update `store` by running:
2019-06-15 22:42:03 +00:00
- `on_tick(store, time)` whenever `time > store.time` where `time` is the current Unix time
- `on_block(store, block)` whenever a block `block: SignedBeaconBlock` is received
- `on_attestation(store, attestation)` whenever an attestation `attestation` is received
- `on_attester_slashing(store, attester_slashing)` whenever an attester slashing `attester_slashing` is received
Any of the above handlers that trigger an unhandled exception (e.g. a failed assert or an out-of-range list access) are considered invalid. Invalid calls to handlers must not modify `store`.
2019-06-15 22:42:03 +00:00
*Notes*:
1) **Leap seconds**: Slots will last `SECONDS_PER_SLOT + 1` or `SECONDS_PER_SLOT - 1` seconds around leap seconds. This is automatically handled by [UNIX time](https://en.wikipedia.org/wiki/Unix_time).
2019-06-15 22:42:03 +00:00
2) **Honest clocks**: Honest nodes are assumed to have clocks synchronized within `SECONDS_PER_SLOT` seconds of each other.
3) **Eth1 data**: The large `ETH1_FOLLOW_DISTANCE` specified in the [honest validator document](./validator.md) should ensure that `state.latest_eth1_data` of the canonical beacon chain remains consistent with the canonical Ethereum proof-of-work chain. If not, emergency manual intervention will be required.
2019-06-20 10:58:05 +00:00
4) **Manual forks**: Manual forks may arbitrarily change the fork choice rule but are expected to be enacted at epoch transitions, with the fork details reflected in `state.fork`.
2019-06-21 17:18:24 +00:00
5) **Implementation**: The implementation found in this specification is constructed for ease of understanding rather than for optimization in computation, space, or any other resource. A number of optimized alternatives can be found [here](https://github.com/protolambda/lmd-ghost).
2019-06-15 22:42:03 +00:00
2021-11-22 18:29:12 +00:00
### Constant
| Name | Value |
| -------------------- | ----------- |
2021-11-22 18:29:12 +00:00
| `INTERVALS_PER_SLOT` | `uint64(3)` |
2021-11-20 02:27:47 +00:00
### Configuration
| Name | Value |
| ------------------------------------- | ------------ |
| `PROPOSER_SCORE_BOOST` | `uint64(40)` |
| `REORG_WEIGHT_THRESHOLD` | `uint64(20)` |
| `REORG_PARENT_WEIGHT_THRESHOLD` | `uint64(160)`|
| `REORG_MAX_EPOCHS_SINCE_FINALIZATION` | `Epoch(2)` |
- The proposer score boost and re-org weight threshold are percentage
values that are measured with respect to the weight of a single committee. See
`calculate_committee_fraction`.
2021-11-20 02:27:47 +00:00
2019-06-20 10:58:05 +00:00
### Helpers
2019-04-22 13:20:48 +00:00
2019-06-25 20:42:37 +00:00
#### `LatestMessage`
```python
@dataclass(eq=True, frozen=True)
class LatestMessage(object):
epoch: Epoch
root: Root
2019-06-25 20:42:37 +00:00
```
2019-06-15 22:42:03 +00:00
#### `Store`
2023-03-09 23:17:11 +00:00
The `Store` is responsible for tracking information required for the fork choice algorithm. The important fields being tracked are described below:
- `justified_checkpoint`: the justified checkpoint used as the starting point for the LMD GHOST fork choice algorithm.
- `finalized_checkpoint`: the highest known finalized checkpoint. The fork choice only considers blocks that are not conflicting with this checkpoint.
- `unrealized_justified_checkpoint` & `unrealized_finalized_checkpoint`: these track the highest justified & finalized checkpoints resp., without regard to whether on-chain ***realization*** has occurred, i.e. FFG processing of new attestations within the state transition function. This is an important distinction from `justified_checkpoint` & `finalized_checkpoint`, because they will only track the checkpoints that are realized on-chain. Note that on-chain processing of FFG information only happens at epoch boundaries.
2023-03-09 23:17:11 +00:00
- `unrealized_justifications`: stores a map of block root to the unrealized justified checkpoint observed in that block.
2019-06-15 22:42:03 +00:00
```python
@dataclass
class Store(object):
time: uint64
genesis_time: uint64
2019-06-25 03:01:15 +00:00
justified_checkpoint: Checkpoint
finalized_checkpoint: Checkpoint
2023-03-09 23:17:11 +00:00
unrealized_justified_checkpoint: Checkpoint
unrealized_finalized_checkpoint: Checkpoint
proposer_boost_root: Root
2022-03-03 19:43:52 +00:00
equivocating_indices: Set[ValidatorIndex]
blocks: Dict[Root, BeaconBlock] = field(default_factory=dict)
block_states: Dict[Root, BeaconState] = field(default_factory=dict)
block_timeliness: Dict[Root, boolean] = field(default_factory=dict)
2019-06-21 18:55:55 +00:00
checkpoint_states: Dict[Checkpoint, BeaconState] = field(default_factory=dict)
2019-06-25 20:42:37 +00:00
latest_messages: Dict[ValidatorIndex, LatestMessage] = field(default_factory=dict)
2023-03-09 23:17:11 +00:00
unrealized_justifications: Dict[Root, Checkpoint] = field(default_factory=dict)
2019-06-15 22:42:03 +00:00
```
2019-04-22 13:20:48 +00:00
2023-04-21 08:16:51 +00:00
#### `is_previous_epoch_justified`
```python
def is_previous_epoch_justified(store: Store) -> bool:
current_slot = get_current_slot(store)
current_epoch = compute_epoch_at_slot(current_slot)
return store.justified_checkpoint.epoch + 1 == current_epoch
```
#### `get_forkchoice_store`
The provided anchor-state will be regarded as a trusted state, to not roll back beyond.
This should be the genesis state for a full client.
2019-04-22 13:20:48 +00:00
2020-03-11 22:41:27 +00:00
*Note* With regards to fork choice, block headers are interchangeable with blocks. The spec is likely to move to headers for reduced overhead in test vectors and better encapsulation. Full implementations store blocks as part of their database and will often use full blocks when dealing with production fork choice.
2019-06-15 22:42:03 +00:00
```python
def get_forkchoice_store(anchor_state: BeaconState, anchor_block: BeaconBlock) -> Store:
assert anchor_block.state_root == hash_tree_root(anchor_state)
anchor_root = hash_tree_root(anchor_block)
anchor_epoch = get_current_epoch(anchor_state)
justified_checkpoint = Checkpoint(epoch=anchor_epoch, root=anchor_root)
finalized_checkpoint = Checkpoint(epoch=anchor_epoch, root=anchor_root)
proposer_boost_root = Root()
return Store(
2020-04-23 15:46:27 +00:00
time=uint64(anchor_state.genesis_time + SECONDS_PER_SLOT * anchor_state.slot),
genesis_time=anchor_state.genesis_time,
2019-06-21 18:55:55 +00:00
justified_checkpoint=justified_checkpoint,
finalized_checkpoint=finalized_checkpoint,
2023-03-09 23:17:11 +00:00
unrealized_justified_checkpoint=justified_checkpoint,
unrealized_finalized_checkpoint=finalized_checkpoint,
proposer_boost_root=proposer_boost_root,
2022-03-03 19:43:52 +00:00
equivocating_indices=set(),
blocks={anchor_root: copy(anchor_block)},
block_states={anchor_root: copy(anchor_state)},
checkpoint_states={justified_checkpoint: copy(anchor_state)},
2023-03-09 23:17:11 +00:00
unrealized_justifications={anchor_root: justified_checkpoint}
)
2019-06-15 22:42:03 +00:00
```
2019-04-22 13:20:48 +00:00
#### `get_slots_since_genesis`
```python
2019-12-10 17:12:51 +00:00
def get_slots_since_genesis(store: Store) -> int:
return (store.time - store.genesis_time) // SECONDS_PER_SLOT
```
2019-11-07 00:20:21 +00:00
#### `get_current_slot`
```python
def get_current_slot(store: Store) -> Slot:
2019-12-10 17:12:51 +00:00
return Slot(GENESIS_SLOT + get_slots_since_genesis(store))
```
2019-11-07 00:20:21 +00:00
#### `compute_slots_since_epoch_start`
```python
def compute_slots_since_epoch_start(slot: Slot) -> int:
return slot - compute_start_slot_at_epoch(compute_epoch_at_slot(slot))
```
2019-06-15 22:42:03 +00:00
#### `get_ancestor`
2019-04-22 13:20:48 +00:00
2019-06-15 22:42:03 +00:00
```python
def get_ancestor(store: Store, root: Root, slot: Slot) -> Root:
2019-06-15 22:42:03 +00:00
block = store.blocks[root]
if block.slot > slot:
return get_ancestor(store, block.parent_root, slot)
2023-03-14 21:49:41 +00:00
return root
2019-06-15 22:42:03 +00:00
```
2019-04-22 13:20:48 +00:00
#### `calculate_committee_fraction`
```python
def calculate_committee_fraction(state: BeaconState, committee_percent: uint64) -> Gwei:
committee_weight = get_total_active_balance(state) // SLOTS_PER_EPOCH
return Gwei((committee_weight * committee_percent) // 100)
```
#### `get_checkpoint_block`
2023-03-28 04:27:13 +00:00
```python
def get_checkpoint_block(store: Store, root: Root, epoch: Epoch) -> Root:
2023-03-28 04:27:13 +00:00
"""
2023-04-18 06:03:10 +00:00
Compute the checkpoint block for epoch ``epoch`` in the chain of block ``root``
2023-03-28 04:27:13 +00:00
"""
epoch_first_slot = compute_start_slot_at_epoch(epoch)
return get_ancestor(store, root, epoch_first_slot)
```
#### `get_weight`
2019-04-22 13:20:48 +00:00
```python
def get_weight(store: Store, root: Root) -> Gwei:
2019-06-21 18:55:55 +00:00
state = store.checkpoint_states[store.justified_checkpoint]
2023-03-09 23:17:11 +00:00
unslashed_and_active_indices = [
i for i in get_active_validator_indices(state, get_current_epoch(state))
if not state.validators[i].slashed
]
attestation_score = Gwei(sum(
2023-03-09 23:17:11 +00:00
state.validators[i].effective_balance for i in unslashed_and_active_indices
if (i in store.latest_messages
2022-03-03 19:43:52 +00:00
and i not in store.equivocating_indices
2019-06-30 20:59:12 +00:00
and get_ancestor(store, store.latest_messages[i].root, store.blocks[root].slot) == root)
))
2021-12-02 17:57:28 +00:00
if store.proposer_boost_root == Root():
# Return only attestation score if ``proposer_boost_root`` is not set
return attestation_score
2021-12-02 21:00:06 +00:00
2021-12-02 17:57:28 +00:00
# Calculate proposer score if ``proposer_boost_root`` is set
proposer_score = Gwei(0)
2021-12-02 17:57:28 +00:00
# Boost is applied if ``root`` is an ancestor of ``proposer_boost_root``
if get_ancestor(store, store.proposer_boost_root, store.blocks[root].slot) == root:
proposer_score = calculate_committee_fraction(state, PROPOSER_SCORE_BOOST)
return attestation_score + proposer_score
2019-04-22 13:20:48 +00:00
```
2023-03-09 23:17:11 +00:00
#### `get_voting_source`
```python
def get_voting_source(store: Store, block_root: Root) -> Checkpoint:
"""
Compute the voting source checkpoint in event that block with root ``block_root`` is the head block
2023-03-13 20:48:34 +00:00
"""
2023-03-09 23:17:11 +00:00
block = store.blocks[block_root]
current_epoch = compute_epoch_at_slot(get_current_slot(store))
2023-03-13 20:48:34 +00:00
block_epoch = compute_epoch_at_slot(block.slot)
2023-03-09 23:17:11 +00:00
if current_epoch > block_epoch:
# The block is from a prior epoch, the voting source will be pulled-up
2023-03-09 23:17:11 +00:00
return store.unrealized_justifications[block_root]
else:
# The block is not from a prior epoch, therefore the voting source is not pulled up
2023-03-09 23:17:11 +00:00
head_state = store.block_states[block_root]
2023-03-13 20:48:34 +00:00
return head_state.current_justified_checkpoint
2023-03-09 23:17:11 +00:00
```
2019-11-25 22:06:33 +00:00
#### `filter_block_tree`
*Note*: External calls to `filter_block_tree` (i.e., any calls that are not made by the recursive logic in this function) MUST set `block_root` to `store.justified_checkpoint`.
2023-03-09 23:17:11 +00:00
2019-11-25 22:06:33 +00:00
```python
def filter_block_tree(store: Store, block_root: Root, blocks: Dict[Root, BeaconBlock]) -> bool:
2019-11-25 22:06:33 +00:00
block = store.blocks[block_root]
children = [
root for root in store.blocks.keys()
if store.blocks[root].parent_root == block_root
2019-11-25 22:06:33 +00:00
]
# If any children branches contain expected finalized/justified checkpoints,
# add to filtered block-tree and signal viability to parent.
if any(children):
filter_block_tree_result = [filter_block_tree(store, child, blocks) for child in children]
if any(filter_block_tree_result):
2019-11-25 22:06:33 +00:00
blocks[block_root] = block
return True
return False
2023-03-09 23:17:11 +00:00
current_epoch = compute_epoch_at_slot(get_current_slot(store))
voting_source = get_voting_source(store, block_root)
# The voting source should be at the same height as the store's justified checkpoint
2019-12-04 23:50:48 +00:00
correct_justified = (
store.justified_checkpoint.epoch == GENESIS_EPOCH
2023-03-09 23:17:11 +00:00
or voting_source.epoch == store.justified_checkpoint.epoch
2019-12-04 23:50:48 +00:00
)
2023-03-09 23:17:11 +00:00
2023-03-14 21:49:41 +00:00
# If the previous epoch is justified, the block should be pulled-up. In this case, check that unrealized
# justification is higher than the store and that the voting source is not more than two epochs ago
2023-03-09 23:17:11 +00:00
if not correct_justified and is_previous_epoch_justified(store):
correct_justified = (
store.unrealized_justifications[block_root].epoch >= store.justified_checkpoint.epoch and
voting_source.epoch + 2 >= current_epoch
)
finalized_checkpoint_block = get_checkpoint_block(
store,
2023-04-18 03:49:08 +00:00
block_root,
store.finalized_checkpoint.epoch,
)
2019-12-04 23:50:48 +00:00
correct_finalized = (
store.finalized_checkpoint.epoch == GENESIS_EPOCH
or store.finalized_checkpoint.root == finalized_checkpoint_block
2019-12-04 23:50:48 +00:00
)
2023-03-09 23:17:11 +00:00
2019-12-04 23:50:48 +00:00
# If expected finalized/justified, add to viable block-tree and signal viability to parent.
if correct_justified and correct_finalized:
2019-11-25 22:06:33 +00:00
blocks[block_root] = block
return True
2019-12-04 23:50:48 +00:00
# Otherwise, branch not viable
2019-11-25 22:06:33 +00:00
return False
```
#### `get_filtered_block_tree`
```python
def get_filtered_block_tree(store: Store) -> Dict[Root, BeaconBlock]:
2019-12-04 23:50:48 +00:00
"""
2019-12-25 17:51:29 +00:00
Retrieve a filtered block tree from ``store``, only returning branches
2019-12-04 23:50:48 +00:00
whose leaf state's justified/finalized info agrees with that in ``store``.
"""
base = store.justified_checkpoint.root
blocks: Dict[Root, BeaconBlock] = {}
2019-12-04 23:50:48 +00:00
filter_block_tree(store, base, blocks)
2019-11-25 22:06:33 +00:00
return blocks
```
2019-06-15 22:42:03 +00:00
#### `get_head`
2019-04-22 13:20:48 +00:00
```python
def get_head(store: Store) -> Root:
2019-12-04 23:50:48 +00:00
# Get filtered block tree that only includes viable branches
2019-11-25 22:06:33 +00:00
blocks = get_filtered_block_tree(store)
2019-06-15 22:42:03 +00:00
# Execute the LMD-GHOST fork choice
2019-06-21 18:55:55 +00:00
head = store.justified_checkpoint.root
2019-06-15 22:42:03 +00:00
while True:
children = [
2019-11-25 22:06:33 +00:00
root for root in blocks.keys()
if blocks[root].parent_root == head
]
2019-04-22 13:20:48 +00:00
if len(children) == 0:
return head
2019-06-20 10:58:05 +00:00
# Sort by latest attesting balance with ties broken lexicographically
# Ties broken by favoring block with lexicographically higher root
head = max(children, key=lambda root: (get_weight(store, root), root))
2019-06-15 22:42:03 +00:00
```
#### `update_checkpoints`
```python
def update_checkpoints(store: Store, justified_checkpoint: Checkpoint, finalized_checkpoint: Checkpoint) -> None:
"""
Update checkpoints in store if necessary
"""
# Update justified checkpoint
if justified_checkpoint.epoch > store.justified_checkpoint.epoch:
store.justified_checkpoint = justified_checkpoint
# Update finalized checkpoint
if finalized_checkpoint.epoch > store.finalized_checkpoint.epoch:
store.finalized_checkpoint = finalized_checkpoint
```
#### `update_unrealized_checkpoints`
```python
def update_unrealized_checkpoints(store: Store, unrealized_justified_checkpoint: Checkpoint,
unrealized_finalized_checkpoint: Checkpoint) -> None:
"""
Update unrealized checkpoints in store if necessary
"""
# Update unrealized justified checkpoint
if unrealized_justified_checkpoint.epoch > store.unrealized_justified_checkpoint.epoch:
store.unrealized_justified_checkpoint = unrealized_justified_checkpoint
# Update unrealized finalized checkpoint
if unrealized_finalized_checkpoint.epoch > store.unrealized_finalized_checkpoint.epoch:
store.unrealized_finalized_checkpoint = unrealized_finalized_checkpoint
```
2023-10-19 11:15:49 +00:00
#### Proposer head and reorg helpers
2023-10-19 11:15:49 +00:00
_Implementing these helpers is optional_.
2023-10-19 11:15:49 +00:00
##### `is_head_late`
```python
2023-10-19 11:15:49 +00:00
def is_head_late(store: Store, head_root: Root) -> bool:
return not store.block_timeliness[head_root]
2023-10-19 11:15:49 +00:00
```
##### `is_shuffling_stable`
```python
def is_shuffling_stable(slot: Slot) -> bool:
return slot % SLOTS_PER_EPOCH != 0
```
##### `is_ffg_competitive`
```python
def is_ffg_competitive(store: Store, head_root: Root, parent_root: Root) -> bool:
return (store.unrealized_justifications[head_root] == store.unrealized_justifications[parent_root])
```
##### `is_finalization_ok`
```python
def is_finalization_ok(store: Store, slot: Slot) -> bool:
epochs_since_finalization = compute_epoch_at_slot(slot) - store.finalized_checkpoint.epoch
return epochs_since_finalization <= REORG_MAX_EPOCHS_SINCE_FINALIZATION
```
##### `is_proposing_on_time`
```python
def is_proposing_on_time(store: Store) -> bool:
time_into_slot = (store.time - store.genesis_time) % SECONDS_PER_SLOT
proposer_reorg_cutoff = SECONDS_PER_SLOT // INTERVALS_PER_SLOT // 2
return time_into_slot <= proposer_reorg_cutoff
```
##### `is_head_weak`
```python
def is_head_weak(store: Store, head_root: Root) -> bool:
justified_state = store.checkpoint_states[store.justified_checkpoint]
2023-10-19 11:15:49 +00:00
reorg_threshold = calculate_committee_fraction(justified_state, REORG_WEIGHT_THRESHOLD)
head_weight = get_weight(store, head_root)
return head_weight < reorg_threshold
```
##### `is_parent_strong`
```python
def is_parent_strong(store: Store, parent_root: Root) -> bool:
justified_state = store.checkpoint_states[store.justified_checkpoint]
parent_threshold = calculate_committee_fraction(justified_state, REORG_PARENT_WEIGHT_THRESHOLD)
parent_weight = get_weight(store, parent_root)
return parent_weight > parent_threshold
```
##### `get_proposer_head`
```python
def get_proposer_head(store: Store, head_root: Root, slot: Slot) -> Root:
head_block = store.blocks[head_root]
parent_root = head_block.parent_root
parent_block = store.blocks[parent_root]
# Only re-org the head block if it arrived later than the attestation deadline.
2023-10-19 11:15:49 +00:00
head_late = is_head_late(store, head_root)
2023-10-19 11:15:49 +00:00
# Do not re-org on an epoch boundary where the proposer shuffling could change.
shuffling_stable = is_shuffling_stable(slot)
2023-10-19 11:15:49 +00:00
# Ensure that the FFG information of the new head will be competitive with the current head.
ffg_competitive = is_ffg_competitive(store, head_root, parent_root)
2023-10-19 11:15:49 +00:00
# Do not re-org if the chain is not finalizing with acceptable frequency.
finalization_ok = is_finalization_ok(store, slot)
2023-10-19 11:15:49 +00:00
# Only re-org if we are proposing on-time.
proposing_on_time = is_proposing_on_time(store)
2023-10-19 11:15:49 +00:00
# Only re-org a single slot at most.
parent_slot_ok = parent_block.slot + 1 == head_block.slot
current_time_ok = head_block.slot + 1 == slot
single_slot_reorg = parent_slot_ok and current_time_ok
# Check that the head has few enough votes to be overpowered by our proposer boost.
assert store.proposer_boost_root != head_root # ensure boost has worn off
2023-10-19 11:15:49 +00:00
head_weak = is_head_weak(store, head_root)
# Check that the missing votes are assigned to the parent and not being hoarded.
2023-10-19 11:15:49 +00:00
parent_strong = is_parent_strong(store, parent_root)
2023-10-19 11:15:49 +00:00
if all([head_late, shuffling_stable, ffg_competitive, finalization_ok,
proposing_on_time, single_slot_reorg, head_weak, parent_strong]):
# We can re-org the current head by building upon its parent block.
return parent_root
else:
return head_root
```
2023-10-19 11:15:49 +00:00
*Note*: The ordering of conditions is a suggestion only. Implementations are free to
optimize by re-ordering the conditions from least to most expensive and by returning early if
any of the early conditions are `False`.
2023-03-09 23:17:11 +00:00
#### Pull-up tip helpers
##### `compute_pulled_up_tip`
```python
def compute_pulled_up_tip(store: Store, block_root: Root) -> None:
state = store.block_states[block_root].copy()
# Pull up the post-state of the block to the next epoch boundary
process_justification_and_finalization(state)
store.unrealized_justifications[block_root] = state.current_justified_checkpoint
update_unrealized_checkpoints(store, state.current_justified_checkpoint, state.finalized_checkpoint)
# If the block is from a prior epoch, apply the realized values
2023-03-09 23:17:11 +00:00
block_epoch = compute_epoch_at_slot(store.blocks[block_root].slot)
current_epoch = compute_epoch_at_slot(get_current_slot(store))
if block_epoch < current_epoch:
update_checkpoints(store, state.current_justified_checkpoint, state.finalized_checkpoint)
```
#### `on_tick` helpers
##### `on_tick_per_slot`
```python
def on_tick_per_slot(store: Store, time: uint64) -> None:
previous_slot = get_current_slot(store)
# Update store time
2023-03-09 23:17:11 +00:00
store.time = time
current_slot = get_current_slot(store)
# If this is a new slot, reset store.proposer_boost_root
2023-03-09 23:17:11 +00:00
if current_slot > previous_slot:
store.proposer_boost_root = Root()
# If a new epoch, pull-up justification and finalization from previous epoch
2023-03-14 21:49:41 +00:00
if current_slot > previous_slot and compute_slots_since_epoch_start(current_slot) == 0:
update_checkpoints(store, store.unrealized_justified_checkpoint, store.unrealized_finalized_checkpoint)
```
#### `on_attestation` helpers
2021-11-18 01:15:12 +00:00
##### `validate_target_epoch_against_current_time`
```python
2021-11-18 01:15:12 +00:00
def validate_target_epoch_against_current_time(store: Store, attestation: Attestation) -> None:
target = attestation.data.target
# Attestations must be from the current or previous epoch
current_epoch = compute_epoch_at_slot(get_current_slot(store))
# Use GENESIS_EPOCH for previous when genesis to avoid underflow
previous_epoch = current_epoch - 1 if current_epoch > GENESIS_EPOCH else GENESIS_EPOCH
# If attestation target is from a future epoch, delay consideration until the epoch arrives
assert target.epoch in [current_epoch, previous_epoch]
```
##### `validate_on_attestation`
```python
2021-11-13 10:38:53 +00:00
def validate_on_attestation(store: Store, attestation: Attestation, is_from_block: bool) -> None:
target = attestation.data.target
2021-11-13 10:38:53 +00:00
# If the given attestation is not from a beacon block message, we have to check the target epoch scope.
if not is_from_block:
2021-11-18 01:15:12 +00:00
validate_target_epoch_against_current_time(store, attestation)
2021-11-13 10:38:53 +00:00
# Check that the epoch number and slot number are matching
assert target.epoch == compute_epoch_at_slot(attestation.data.slot)
# Attestation target must be for a known block. If target block is unknown, delay consideration until block is found
assert target.root in store.blocks
# Attestations must be for a known block. If block is unknown, delay consideration until the block is found
assert attestation.data.beacon_block_root in store.blocks
# Attestations must not be for blocks in the future. If not, the attestation should not be considered
assert store.blocks[attestation.data.beacon_block_root].slot <= attestation.data.slot
2020-06-02 07:22:33 +00:00
# LMD vote must be consistent with FFG vote target
assert target.root == get_checkpoint_block(store, attestation.data.beacon_block_root, target.epoch)
# Attestations can only affect the fork choice of subsequent slots.
# Delay consideration in the fork choice until their slot is in the past.
assert get_current_slot(store) >= attestation.data.slot + 1
```
##### `store_target_checkpoint_state`
```python
def store_target_checkpoint_state(store: Store, target: Checkpoint) -> None:
# Store target checkpoint state if not yet seen
if target not in store.checkpoint_states:
base_state = copy(store.block_states[target.root])
if base_state.slot < compute_start_slot_at_epoch(target.epoch):
process_slots(base_state, compute_start_slot_at_epoch(target.epoch))
store.checkpoint_states[target] = base_state
```
##### `update_latest_messages`
```python
2023-03-14 21:49:41 +00:00
def update_latest_messages(store: Store, attesting_indices: Sequence[ValidatorIndex], attestation: Attestation) -> None:
target = attestation.data.target
beacon_block_root = attestation.data.beacon_block_root
2022-03-03 19:43:52 +00:00
non_equivocating_attesting_indices = [i for i in attesting_indices if i not in store.equivocating_indices]
for i in non_equivocating_attesting_indices:
if i not in store.latest_messages or target.epoch > store.latest_messages[i].epoch:
store.latest_messages[i] = LatestMessage(epoch=target.epoch, root=beacon_block_root)
```
2019-06-15 22:42:03 +00:00
### Handlers
#### `on_tick`
```python
def on_tick(store: Store, time: uint64) -> None:
# If the ``store.time`` falls behind, while loop catches up slot by slot
# to ensure that every previous slot is processed with ``on_tick_per_slot``
2023-03-09 23:17:11 +00:00
tick_slot = (time - store.genesis_time) // SECONDS_PER_SLOT
while get_current_slot(store) < tick_slot:
previous_time = store.genesis_time + (get_current_slot(store) + 1) * SECONDS_PER_SLOT
on_tick_per_slot(store, previous_time)
on_tick_per_slot(store, time)
2019-04-22 13:20:48 +00:00
```
2019-06-15 22:42:03 +00:00
#### `on_block`
2019-06-15 22:42:03 +00:00
```python
2019-11-21 22:13:45 +00:00
def on_block(store: Store, signed_block: SignedBeaconBlock) -> None:
block = signed_block.message
2020-06-11 01:51:18 +00:00
# Parent block must be known
2019-06-25 03:09:57 +00:00
assert block.parent_root in store.block_states
# Make a copy of the state to avoid mutability issues
pre_state = copy(store.block_states[block.parent_root])
2022-07-29 07:13:32 +00:00
# Blocks cannot be in the future. If they are, their consideration must be delayed until they are in the past.
2019-12-10 17:12:51 +00:00
assert get_current_slot(store) >= block.slot
# Check that block is later than the finalized epoch slot (optimization to reduce calls to get_ancestor)
finalized_slot = compute_start_slot_at_epoch(store.finalized_checkpoint.epoch)
assert block.slot > finalized_slot
# Check block is a descendant of the finalized block at the checkpoint finalized slot
finalized_checkpoint_block = get_checkpoint_block(
2023-04-05 03:38:20 +00:00
store,
block.parent_root,
store.finalized_checkpoint.epoch,
)
assert store.finalized_checkpoint.root == finalized_checkpoint_block
2019-06-15 22:42:03 +00:00
# Check the block is valid and compute the post-state
state = pre_state.copy()
2023-03-09 23:17:11 +00:00
block_root = hash_tree_root(block)
state_transition(state, signed_block, True)
# Add new block to the store
2023-03-09 23:17:11 +00:00
store.blocks[block_root] = block
# Add new state for this block to the store
2023-03-09 23:17:11 +00:00
store.block_states[block_root] = state
2019-06-21 18:55:55 +00:00
# Add block timeliness to the store
time_into_slot = (store.time - store.genesis_time) % SECONDS_PER_SLOT
is_before_attesting_interval = time_into_slot < SECONDS_PER_SLOT // INTERVALS_PER_SLOT
is_timely = get_current_slot(store) == block.slot and is_before_attesting_interval
store.block_timeliness[hash_tree_root(block)] = is_timely
# Add proposer score boost if the block is timely and not conflicting with an existing block
is_first_block = store.proposer_boost_root == Root()
if is_timely and is_first_block:
store.proposer_boost_root = hash_tree_root(block)
2023-03-09 23:17:11 +00:00
# Update checkpoints in store if necessary
update_checkpoints(store, state.current_justified_checkpoint, state.finalized_checkpoint)
2019-06-21 18:55:55 +00:00
# Eagerly compute unrealized justification and finality
2023-03-09 23:17:11 +00:00
compute_pulled_up_tip(store, block_root)
2019-06-15 22:42:03 +00:00
```
2019-06-15 22:42:03 +00:00
#### `on_attestation`
```python
def on_attestation(store: Store, attestation: Attestation, is_from_block: bool=False) -> None:
2019-11-12 23:24:33 +00:00
"""
Run ``on_attestation`` upon receiving a new ``attestation`` from either within a block or directly on the wire.
An ``attestation`` that is asserted as invalid may be valid at a later time,
consider scheduling it for later processing in such case.
"""
2021-11-13 10:38:53 +00:00
validate_on_attestation(store, attestation, is_from_block)
store_target_checkpoint_state(store, attestation.data.target)
# Get state at the `target` to fully validate attestation
target_state = store.checkpoint_states[attestation.data.target]
2019-06-30 09:02:18 +00:00
indexed_attestation = get_indexed_attestation(target_state, attestation)
assert is_valid_indexed_attestation(target_state, indexed_attestation)
# Update latest messages for attesting indices
update_latest_messages(store, indexed_attestation.attesting_indices, attestation)
2019-06-15 22:42:03 +00:00
```
#### `on_attester_slashing`
2022-03-08 18:33:59 +00:00
*Note*: `on_attester_slashing` should be called while syncing and a client MUST maintain the equivocation set of `AttesterSlashing`s from at least the latest finalized checkpoint.
2022-03-08 14:52:03 +00:00
```python
def on_attester_slashing(store: Store, attester_slashing: AttesterSlashing) -> None:
"""
2022-03-03 20:50:05 +00:00
Run ``on_attester_slashing`` immediately upon receiving a new ``AttesterSlashing``
from either within a block or directly on the wire.
"""
attestation_1 = attester_slashing.attestation_1
attestation_2 = attester_slashing.attestation_2
assert is_slashable_attestation_data(attestation_1.data, attestation_2.data)
state = store.block_states[store.justified_checkpoint.root]
assert is_valid_indexed_attestation(state, attestation_1)
assert is_valid_indexed_attestation(state, attestation_2)
indices = set(attestation_1.attesting_indices).intersection(attestation_2.attesting_indices)
2022-03-03 19:43:52 +00:00
for index in indices:
store.equivocating_indices.add(index)
```