From 79c456b9f400d029af0883774c6e7feef5188f72 Mon Sep 17 00:00:00 2001 From: Etan Kissling Date: Tue, 11 Jan 2022 11:48:22 +0100 Subject: [PATCH] Fix light client docs to match function signature In the light client docs a mentioning of a function trigger is lacking the `genesis_validators_root` argument. This patch adds that argument to the documentation to match the real function signature. It also slightly improves the grammar. --- specs/altair/sync-protocol.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specs/altair/sync-protocol.md b/specs/altair/sync-protocol.md index c8c7c3d4dc..0cabf51b88 100644 --- a/specs/altair/sync-protocol.md +++ b/specs/altair/sync-protocol.md @@ -127,7 +127,7 @@ def get_safety_threshold(store: LightClientStore) -> uint64: ## Light client state updates -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. `process_slot_for_light_client_store` is processed every time the current slot increments. +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, genesis_validators_root)` where `current_slot` is the current slot based on a local clock. `process_slot_for_light_client_store` is triggered every time the current slot increments. #### `process_slot_for_light_client_store`