Beacon sync maint update (#3867)

mjfh · web-flow · commit 1bf5ca30bf8a · 2025-12-08T20:39:00.000Z
* Un-export `helpers` from `worker_desc` source

why
  Exporting `helpers` makes the import logic too brittle when imported
  by the upcoming `snap` syncer. This is due to the fact that the latter
  will use a similar basic framework so that a clash of similar
  functions would be cumbersome to avoid.

* Update `stand-by` mode

why
  Setting `stand-by` mode as `start()` function argument seems top make
  more sense than using it as a general config option.
diff --git a/execution_chain/sync/beacon.nim b/execution_chain/sync/beacon.nim
@@ -86,7 +86,6 @@ proc config*(
     ethNode: EthereumNode;
     chain: ForkedChainRef;
     maxPeers: int;
-    standByMode = false;
       ) =
   ## Complete `BeaconSyncRef` descriptor initialisation.
   ##
@@ -103,8 +102,6 @@ proc config*(
   desc.addBeaconSyncProtocol(eth68)
 
   desc.ctx.pool.chain = chain
-  if standByMode:
-    desc.ctx.pool.syncState = SyncState.standByMode
 
   if not desc.lazyConfigHook.isNil:
     desc.lazyConfigHook(desc)
@@ -128,10 +125,23 @@ proc activate*(desc: BeaconSyncRef) =
   if desc.ctx.pool.syncState == SyncState.standByMode:
     desc.ctx.pool.syncState = SyncState.idle
 
-proc start*(desc: BeaconSyncRef): bool =
+proc start*(desc: BeaconSyncRef; standByMode = false): bool =
+  ## This function returns `true` exactly if the run state could be changed.
+  ## The following expressions are equivalent:
+  ## * desc.start(true)
+  ## * desc.start(false) and desc.start(true)
+  ##
   doAssert not desc.ctx.isNil
-  if not desc.isRunning and desc.startSync():
-    return true
+  if desc.isRunning:
+    # Correct state to stand-by mode if possible
+    if standByMode and desc.ctx.pool.syncState == SyncState.idle:
+      desc.ctx.pool.syncState = SyncState.standByMode
+      return true
+  else:
+    if standByMode:
+      desc.ctx.pool.syncState = SyncState.standByMode
+    if desc.startSync():
+      return true
   # false
 
 proc stop*(desc: BeaconSyncRef) {.async.} =
diff --git a/execution_chain/sync/beacon/worker.nim b/execution_chain/sync/beacon/worker.nim
@@ -17,7 +17,7 @@ import
   ../../common,
   ../../networking/p2p,
   ./worker/headers/headers_target,
-  ./worker/[blocks, classify, headers, start_stop, update, worker_desc]
+  ./worker/[blocks, classify, headers, helpers, start_stop, update, worker_desc]
 
 # ------------------------------------------------------------------------------
 # Public start/stop and admin functions
diff --git a/execution_chain/sync/beacon/worker/blocks.nim b/execution_chain/sync/beacon/worker/blocks.nim
@@ -16,7 +16,7 @@ import
   pkg/stew/[interval_set, sorted_set],
   ../../../networking/p2p,
   ./blocks/[blocks_blocks, blocks_helpers, blocks_queue, blocks_unproc],
-  ./worker_desc
+  ./[helpers, worker_desc]
 
 export
   blocks_queue, blocks_unproc
diff --git a/execution_chain/sync/beacon/worker/blocks/blocks_blocks.nim b/execution_chain/sync/beacon/worker/blocks/blocks_blocks.nim
@@ -16,7 +16,7 @@ import
   pkg/stew/interval_set,
   ../../../../networking/p2p,
   ../../../wire_protocol/types,
-  ../[update, worker_desc],
+  ../[helpers, update, worker_desc],
   ./[blocks_fetch, blocks_helpers, blocks_import, blocks_unproc]
 
 # ------------------------------------------------------------------------------
diff --git a/execution_chain/sync/beacon/worker/blocks/blocks_fetch.nim b/execution_chain/sync/beacon/worker/blocks/blocks_fetch.nim
@@ -15,7 +15,7 @@ import
   pkg/eth/[common, rlp],
   pkg/stew/interval_set,
   ../../../wire_protocol,
-  ../worker_desc,
+  ../[helpers, worker_desc],
   ./blocks_helpers
 
 # ------------------------------------------------------------------------------
diff --git a/execution_chain/sync/beacon/worker/blocks/blocks_helpers.nim b/execution_chain/sync/beacon/worker/blocks/blocks_helpers.nim
@@ -13,7 +13,7 @@
 import
   pkg/chronos,
   ../update/update_eta,
-  ../worker_desc
+  ../[helpers, worker_desc]
 
 # ------------------------------------------------------------------------------
 # Public functions
diff --git a/execution_chain/sync/beacon/worker/headers.nim b/execution_chain/sync/beacon/worker/headers.nim
@@ -16,7 +16,7 @@ import
   pkg/eth/common,
   pkg/stew/[interval_set, sorted_set],
   ./headers/[headers_headers, headers_helpers, headers_queue, headers_unproc],
-  ./worker_desc
+  ./[helpers, worker_desc]
 
 export
   headers_queue, headers_unproc
diff --git a/execution_chain/sync/beacon/worker/headers/headers_fetch.nim b/execution_chain/sync/beacon/worker/headers/headers_fetch.nim
@@ -15,7 +15,7 @@ import
   pkg/eth/[common, rlp],
   pkg/stew/interval_set,
   ../../../wire_protocol,
-  ../worker_desc,
+  ../[helpers, worker_desc],
   ./headers_helpers
 
 # ------------------------------------------------------------------------------
diff --git a/execution_chain/sync/beacon/worker/headers/headers_headers.nim b/execution_chain/sync/beacon/worker/headers/headers_headers.nim
@@ -16,7 +16,7 @@ import
   pkg/stew/interval_set,
   ../../../../networking/p2p,
   ../update/update_eta,
-  ../worker_desc,
+  ../[helpers, worker_desc],
   ./[headers_fetch, headers_helpers, headers_unproc]
 
 # ------------------------------------------------------------------------------
diff --git a/execution_chain/sync/beacon/worker/headers/headers_helpers.nim b/execution_chain/sync/beacon/worker/headers/headers_helpers.nim
@@ -13,7 +13,7 @@
 import
   pkg/chronos,
   ../update/update_eta,
-  ../worker_desc
+  ../[helpers, worker_desc]
 
 # ------------------------------------------------------------------------------
 # Private helpers
diff --git a/execution_chain/sync/beacon/worker/worker_desc.nim b/execution_chain/sync/beacon/worker/worker_desc.nim
@@ -19,7 +19,7 @@ import
   ./[helpers, worker_const]
 
 export
-  helpers, sync_desc, worker_const, chain
+  sync_desc, worker_const, chain
 
 type
   BeaconPeerRef* = SyncPeerRef[BeaconCtxData,BeaconPeerData]
