2020-11-17 12:42:09 +00:00
# Minimal Light Client
2020-11-16 07:02:11 +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 )
- [Constants ](#constants )
2020-11-17 12:42:09 +00:00
- [Configuration ](#configuration )
- [Misc ](#misc )
2020-11-16 07:02:11 +00:00
- [Containers ](#containers )
2021-03-11 06:27:23 +00:00
- [`LightClientSnapshot` ](#lightclientsnapshot )
- [`LightClientUpdate` ](#lightclientupdate )
- [`LightClientStore` ](#lightclientstore )
2020-12-10 09:04:11 +00:00
- [Helper functions ](#helper-functions )
- [`get_subtree_index` ](#get_subtree_index )
2020-11-16 07:02:11 +00:00
- [Light client state updates ](#light-client-state-updates )
2021-01-19 12:44:21 +00:00
- [`validate_light_client_update` ](#validate_light_client_update )
2020-11-18 10:33:42 +00:00
- [`apply_light_client_update` ](#apply_light_client_update )
2020-11-17 12:42:09 +00:00
- [`process_light_client_update` ](#process_light_client_update )
2020-11-16 07:02:11 +00:00
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
<!-- /TOC -->
## Introduction
2020-12-07 15:10:39 +00:00
Eth2 is designed to be light client friendly for constrained environments to
access Eth2 with reasonable safety and liveness.
Such environments include resource-constrained devices (e.g. phones for trust-minimised wallets)
and metered VMs (e.g. blockchain VMs for cross-chain bridges).
2020-11-17 12:42:09 +00:00
2020-12-07 15:10:39 +00:00
This document suggests a minimal light client design for the beacon chain that
uses sync committees introduced in [this beacon chain extension ](./beacon-chain.md ).
2020-11-16 07:02:11 +00:00
## Constants
| Name | Value |
| - | - |
2020-12-09 09:35:22 +00:00
| `FINALIZED_ROOT_INDEX` | `get_generalized_index(BeaconState, 'finalized_checkpoint', 'root')` |
| `NEXT_SYNC_COMMITTEE_INDEX` | `get_generalized_index(BeaconState, 'next_sync_committee')` |
2020-11-17 12:42:09 +00:00
## Configuration
### Misc
| Name | Value |
| - | - |
2020-11-17 15:30:09 +00:00
| `MIN_SYNC_COMMITTEE_PARTICIPANTS` | `1` |
2020-11-17 12:42:09 +00:00
2020-11-16 07:02:11 +00:00
## Containers
2021-03-11 06:27:23 +00:00
### `LightClientSnapshot`
2020-11-16 07:02:11 +00:00
```python
2020-11-17 12:42:09 +00:00
class LightClientSnapshot(Container):
# Beacon block header
2020-11-16 07:02:11 +00:00
header: BeaconBlockHeader
2020-11-17 12:42:09 +00:00
# Sync committees corresponding to the header
current_sync_committee: SyncCommittee
next_sync_committee: SyncCommittee
2020-11-16 07:02:11 +00:00
```
2021-03-11 06:27:23 +00:00
### `LightClientUpdate`
2020-11-16 07:02:11 +00:00
2020-11-17 12:42:09 +00:00
```python
class LightClientUpdate(Container):
2020-11-18 10:33:42 +00:00
# Update beacon block header
header: BeaconBlockHeader
# Next sync committee corresponding to the header
next_sync_committee: SyncCommittee
2020-12-16 07:00:06 +00:00
next_sync_committee_branch: Vector[Bytes32, floorlog2(NEXT_SYNC_COMMITTEE_INDEX)]
2020-11-18 10:33:42 +00:00
# Finality proof for the update header
finality_header: BeaconBlockHeader
2020-12-16 07:00:06 +00:00
finality_branch: Vector[Bytes32, floorlog2(FINALIZED_ROOT_INDEX)]
2020-11-17 12:42:09 +00:00
# Sync committee aggregate signature
2020-11-18 09:31:41 +00:00
sync_committee_bits: Bitvector[SYNC_COMMITTEE_SIZE]
2020-11-17 12:42:09 +00:00
sync_committee_signature: BLSSignature
2020-11-17 15:30:09 +00:00
# Fork version for the aggregate signature
2020-11-18 08:27:19 +00:00
fork_version: Version
2020-11-17 12:42:09 +00:00
```
2021-03-11 06:27:23 +00:00
### `LightClientStore`
2020-11-16 07:02:11 +00:00
```python
2021-05-06 17:00:04 +00:00
@dataclass
class LightClientStore(object):
2020-11-17 12:42:09 +00:00
snapshot: LightClientSnapshot
2021-05-06 17:00:04 +00:00
valid_updates: Set[LightClientUpdate]
2020-11-16 07:02:11 +00:00
```
2020-12-10 09:04:11 +00:00
## Helper functions
### `get_subtree_index`
```python
def get_subtree_index(generalized_index: GeneralizedIndex) -> uint64:
2020-12-16 07:00:06 +00:00
return uint64(generalized_index % 2**(floorlog2(generalized_index)))
2020-12-10 09:04:11 +00:00
```
2020-11-16 07:02:11 +00:00
## Light client state updates
2020-12-15 05:18:20 +00:00
A light client maintains its state in a `store` object of type `LightClientStore` and receives `update` objects of type `LightClientUpdate` . Every `update` triggers `process_light_client_update(store, update, current_slot)` where `current_slot` is the current slot based on some local clock.
2020-11-16 07:02:11 +00:00
2021-01-19 12:44:21 +00:00
#### `validate_light_client_update`
2020-11-16 07:02:11 +00:00
```python
2021-05-04 13:39:22 +00:00
def validate_light_client_update(snapshot: LightClientSnapshot,
update: LightClientUpdate,
2021-03-11 13:02:05 +00:00
genesis_validators_root: Root) -> None:
2020-11-18 10:33:42 +00:00
# Verify update slot is larger than snapshot slot
assert update.header.slot > snapshot.header.slot
2020-11-17 12:42:09 +00:00
# Verify update does not skip a sync committee period
2020-11-18 10:33:42 +00:00
snapshot_period = compute_epoch_at_slot(snapshot.header.slot) // EPOCHS_PER_SYNC_COMMITTEE_PERIOD
update_period = compute_epoch_at_slot(update.header.slot) // EPOCHS_PER_SYNC_COMMITTEE_PERIOD
assert update_period in (snapshot_period, snapshot_period + 1)
# Verify update header root is the finalized root of the finality header, if specified
if update.finality_header == BeaconBlockHeader():
signed_header = update.header
2020-12-16 07:00:06 +00:00
assert update.finality_branch == [Bytes32() for _ in range(floorlog2(FINALIZED_ROOT_INDEX))]
2020-11-18 08:27:19 +00:00
else:
2020-11-18 10:33:42 +00:00
signed_header = update.finality_header
2020-11-18 08:27:19 +00:00
assert is_valid_merkle_branch(
2020-11-18 10:33:42 +00:00
leaf=hash_tree_root(update.header),
branch=update.finality_branch,
2020-12-16 07:00:06 +00:00
depth=floorlog2(FINALIZED_ROOT_INDEX),
2020-12-10 09:04:11 +00:00
index=get_subtree_index(FINALIZED_ROOT_INDEX),
2020-11-18 10:33:42 +00:00
root=update.finality_header.state_root,
)
2020-11-17 12:42:09 +00:00
2020-11-18 10:33:42 +00:00
# Verify update next sync committee if the update period incremented
if update_period == snapshot_period:
sync_committee = snapshot.current_sync_committee
2020-12-16 07:00:06 +00:00
assert update.next_sync_committee_branch == [Bytes32() for _ in range(floorlog2(NEXT_SYNC_COMMITTEE_INDEX))]
2020-11-18 09:31:41 +00:00
else:
2020-11-18 10:33:42 +00:00
sync_committee = snapshot.next_sync_committee
2020-11-17 12:42:09 +00:00
assert is_valid_merkle_branch(
2020-11-18 10:33:42 +00:00
leaf=hash_tree_root(update.next_sync_committee),
2020-11-17 12:42:09 +00:00
branch=update.next_sync_committee_branch,
2020-12-16 07:00:06 +00:00
depth=floorlog2(NEXT_SYNC_COMMITTEE_INDEX),
2020-12-10 09:04:11 +00:00
index=get_subtree_index(NEXT_SYNC_COMMITTEE_INDEX),
2020-11-18 10:33:42 +00:00
root=update.header.state_root,
2020-11-17 12:42:09 +00:00
)
2020-11-18 10:33:42 +00:00
# Verify sync committee has sufficient participants
2020-11-18 09:31:41 +00:00
assert sum(update.sync_committee_bits) >= MIN_SYNC_COMMITTEE_PARTICIPANTS
2020-11-17 12:42:09 +00:00
# Verify sync committee aggregate signature
participant_pubkeys = [pubkey for (bit, pubkey) in zip(update.sync_committee_bits, sync_committee.pubkeys) if bit]
2021-03-11 13:02:05 +00:00
domain = compute_domain(DOMAIN_SYNC_COMMITTEE, update.fork_version, genesis_validators_root)
2020-11-18 10:33:42 +00:00
signing_root = compute_signing_root(signed_header, domain)
2020-11-17 12:42:09 +00:00
assert bls.FastAggregateVerify(participant_pubkeys, signing_root, update.sync_committee_signature)
2020-11-16 07:02:11 +00:00
```
2020-11-18 10:33:42 +00:00
#### `apply_light_client_update`
```python
def apply_light_client_update(snapshot: LightClientSnapshot, update: LightClientUpdate) -> None:
snapshot_period = compute_epoch_at_slot(snapshot.header.slot) // EPOCHS_PER_SYNC_COMMITTEE_PERIOD
update_period = compute_epoch_at_slot(update.header.slot) // EPOCHS_PER_SYNC_COMMITTEE_PERIOD
if update_period == snapshot_period + 1:
snapshot.current_sync_committee = snapshot.next_sync_committee
snapshot.next_sync_committee = update.next_sync_committee
snapshot.header = update.header
```
#### `process_light_client_update`
2020-11-16 07:02:11 +00:00
2020-11-16 07:07:40 +00:00
```python
2021-03-11 13:02:05 +00:00
def process_light_client_update(store: LightClientStore, update: LightClientUpdate, current_slot: Slot,
genesis_validators_root: Root) -> None:
validate_light_client_update(store.snapshot, update, genesis_validators_root)
2021-05-06 17:00:04 +00:00
store.valid_updates.add(update)
2020-11-18 10:33:42 +00:00
2021-05-04 20:42:02 +00:00
update_timeout = SLOTS_PER_EPOCH * EPOCHS_PER_SYNC_COMMITTEE_PERIOD
2020-12-09 09:35:22 +00:00
if (
2021-05-04 20:25:34 +00:00
sum(update.sync_committee_bits) * 3 >= len(update.sync_committee_bits) * 2
2021-01-19 12:12:36 +00:00
and update.finality_header != BeaconBlockHeader()
2020-12-09 09:35:22 +00:00
):
2021-01-19 12:12:36 +00:00
# Apply update if (1) 2/3 quorum is reached and (2) we have a finality proof.
# Note that (2) means that the current light client design needs finality.
# It may be changed to re-organizable light client design. See the on-going issue eth2.0-specs#2182.
2021-03-11 06:27:23 +00:00
apply_light_client_update(store.snapshot, update)
2021-05-06 17:00:04 +00:00
store.valid_updates = set()
2021-05-04 20:42:02 +00:00
elif current_slot > store.snapshot.header.slot + update_timeout:
2020-11-17 15:30:09 +00:00
# Forced best update when the update timeout has elapsed
2021-03-11 06:27:23 +00:00
apply_light_client_update(store.snapshot,
max(store.valid_updates, key=lambda update: sum(update.sync_committee_bits)))
2021-05-06 17:00:04 +00:00
store.valid_updates = set()
2020-11-16 07:02:11 +00:00
```