nimbus-eth1/nimbus/sync/beacon.nim
Jordan Hrycaj 070f117d3c
Suppress beacon sync unless potential actions (#2765)
* Update comments & logs

* Do not start beacon sync unless there is possibly something to do

why:
  It would continue polling without having any effect other than
  logging. Now it will not start unless there is RPC available
  or there was a previously interrupted sync to be resumed.
2024-10-21 18:01:45 +00:00

83 lines
2.4 KiB
Nim

# Nimbus
# Copyright (c) 2023-2024 Status Research & Development GmbH
# Licensed under either of
# * Apache License, version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or
# http://www.apache.org/licenses/LICENSE-2.0)
# * MIT license ([LICENSE-MIT](LICENSE-MIT) or
# http://opensource.org/licenses/MIT)
# at your option. This file may not be copied, modified, or distributed
# except according to those terms.
{.push raises: [].}
import
pkg/[chronicles, chronos, eth/p2p, results],
pkg/stew/[interval_set, sorted_set],
../core/chain,
./beacon/[worker, worker_desc, worker/db],
"."/[sync_desc, sync_sched, protocol]
logScope:
topics = "beacon"
type
BeaconSyncRef* = RunnerSyncRef[BeaconCtxData,BeaconBuddyData]
# ------------------------------------------------------------------------------
# Virtual methods/interface, `mixin` functions
# ------------------------------------------------------------------------------
proc runSetup(ctx: BeaconCtxRef): bool =
worker.setup(ctx)
proc runRelease(ctx: BeaconCtxRef) =
worker.release(ctx)
proc runDaemon(ctx: BeaconCtxRef) {.async.} =
await worker.runDaemon(ctx)
proc runStart(buddy: BeaconBuddyRef): bool =
worker.start(buddy)
proc runStop(buddy: BeaconBuddyRef) =
worker.stop(buddy)
proc runPool(buddy: BeaconBuddyRef; last: bool; laps: int): bool =
worker.runPool(buddy, last, laps)
proc runPeer(buddy: BeaconBuddyRef) {.async.} =
await worker.runPeer(buddy)
# ------------------------------------------------------------------------------
# Public functions
# ------------------------------------------------------------------------------
proc init*(
T: type BeaconSyncRef;
ethNode: EthereumNode;
chain: ForkedChainRef;
maxPeers: int;
chunkSize: int;
): T =
var desc = T()
desc.initSync(ethNode, maxPeers)
desc.ctx.pool.nBodiesBatch = chunkSize
desc.ctx.pool.chain = chain
desc
proc start*(desc: BeaconSyncRef; resumeOnly = false): bool =
## Start beacon sync. If `resumeOnly` is set `true` the syncer will only
## start up if it can resume work, e.g. after being previously interrupted.
if resumeOnly:
desc.ctx.dbLoadSyncStateLayout()
if not desc.ctx.layout.headLocked:
return false
desc.startSync()
proc stop*(desc: BeaconSyncRef) =
desc.stopSync()
# ------------------------------------------------------------------------------
# End
# ------------------------------------------------------------------------------