Update sync test documentation

This commit is contained in:
Etan Kissling 2023-01-12 19:01:57 +01:00
parent 82d6267951
commit b7205813fd
No known key found for this signature in database
GPG Key ID: B21DA824C5A3D03D

View File

@ -17,7 +17,7 @@ store_fork_digest: string -- Encoded `ForkDigest`-context of `store` obj
An SSZ-snappy encoded `bootstrap` object of type `LightClientBootstrap` to initialize a local `store` object of type `LightClientStore` with `store_fork_digest` using `initialize_light_client_store(trusted_block_rooot, bootstrap)`. The SSZ type can be determined from `bootstrap_fork_digest`.
If `store_fork_digest` differs from `bootstrap_fork_digest`, the `bootstrap` object may need upgrading before initializing the store.
If `store_fork_digest` differs from `bootstrap_fork_digest`, the `bootstrap` object may need to be upgraded before initializing the store.
### `steps.yaml`
@ -68,7 +68,7 @@ The function `process_light_client_update(store, update, current_slot, genesis_v
}
```
If `store_fork_digest` differs from `update_fork_digest`, the `update` object may need upgrading before initializing the store.
If `store_fork_digest` differs from `update_fork_digest`, the `update` object may need to be upgraded before processing the update.
After this step, the `store` object may have been updated.
@ -85,7 +85,6 @@ The `store` should be upgraded to reflect the new `store_fork_digest`:
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`.