From b7205813fd07c8f0e2038fe51364c2da16bdf94a Mon Sep 17 00:00:00 2001 From: Etan Kissling Date: Thu, 12 Jan 2023 19:01:57 +0100 Subject: [PATCH] Update sync test documentation --- tests/formats/light_client/sync.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/tests/formats/light_client/sync.md b/tests/formats/light_client/sync.md index c42486c5c..2f17dbe7a 100644 --- a/tests/formats/light_client/sync.md +++ b/tests/formats/light_client/sync.md @@ -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`.