consensus-specs/tests/formats/light_client/sync.md

Light client sync tests

This series of tests provides reference test vectors for validating that a light client implementing the sync protocol can sync to the latest block header.

Test case format

meta.yaml

genesis_validators_root: Bytes32  -- string, hex encoded, with 0x prefix
trusted_block_root: Bytes32       -- string, hex encoded, with 0x prefix

bootstrap.ssz_snappy

An SSZ-snappy encoded bootstrap object of type LightClientBootstrap to initialize a local store object of type LightClientStore using initialize_light_client_store(trusted_block_rooot, bootstrap).

steps.yaml

The steps to execute in sequence.

Checks to run after each step

Each step includes checks to verify the expected impact on the store object.

finalized_header: {
    slot: int,                -- Integer value from store.finalized_header.slot
    root: string,             -- Encoded 32-byte value from store.finalized_header.hash_tree_root()
}
optimistic_header: {
    slot: int,                -- Integer value from store.optimistic_header.slot
    root: string,             -- Encoded 32-byte value from store.optimistic_header.hash_tree_root()
}

force_update execution step

The function process_light_client_store_force_update(store, current_slot) should be executed with the specified parameters:

{
    current_slot: int                  -- integer, decimal
    checks: {<store_attibute>: value}  -- the assertions.
}

After this step, the store object may have been updated.

process_update execution step

The function process_light_client_update(store, update, current_slot, genesis_validators_root) should be executed with the specified parameters:

{
    update: string                     -- name of the `*.ssz_snappy` file to load
                                          as a `LightClientUpdate` object
    current_slot: int                  -- integer, decimal
    checks: {<store_attibute>: value}  -- the assertions.
}

After this step, the store object may have been updated.

Condition

A test-runner should initialize a local LightClientStore using the provided bootstrap object. It should then proceed to execute all the test steps in sequence. After each step, it should verify that the resulting store verifies against the provided checks.