feat: add strategy support for state archives #7170
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| import {Logger} from "@lodestar/utils"; | ||
| import {CheckpointWithHex} from "@lodestar/fork-choice"; | ||
| import {IBeaconDb} from "../../db/index.js"; | ||
| import {JobItemQueue} from "../../util/queue/index.js"; | ||
| import {IBeaconChain} from "../interface.js"; | ||
| import {ChainEvent} from "../emitter.js"; | ||
| import {Metrics} from "../../metrics/metrics.js"; | ||
| import {FullStateArchiveStrategy} from "./strategies/fullStateArchiveStrategy.js"; | ||
| import {archiveBlocks} from "./archiveBlocks.js"; | ||
| import {ArchiveMode, ArchiverOpts, StateArchiveStrategy} from "./interface.js"; | ||
| import {PROCESS_FINALIZED_CHECKPOINT_QUEUE_LEN} from "./constants.js"; | ||
|
|
||
| /** | ||
| * Used for running tasks that depends on some events or are executed | ||
| * periodically. | ||
| */ | ||
| export class Archiver { | ||
| private archiveMode: ArchiveMode; | ||
| private jobQueue: JobItemQueue<[CheckpointWithHex], void>; | ||
|
|
||
| private prevFinalized: CheckpointWithHex; | ||
| private readonly statesArchiverStrategy: StateArchiveStrategy; | ||
| private archiveBlobEpochs?: number; | ||
|
|
||
| constructor( | ||
| private readonly db: IBeaconDb, | ||
| private readonly chain: IBeaconChain, | ||
| private readonly logger: Logger, | ||
| signal: AbortSignal, | ||
| opts: ArchiverOpts, | ||
| private readonly metrics?: Metrics | null | ||
| ) { | ||
| if (opts.archiveMode === ArchiveMode.Full) { | ||
| this.statesArchiverStrategy = new FullStateArchiveStrategy(chain.regen, db, logger, opts, chain.bufferPool); | ||
| } else { | ||
| throw new Error(`State archive strategy "${opts.archiveMode}" currently not supported.`); | ||
| } | ||
|
|
||
| this.archiveMode = opts.archiveMode; | ||
| this.archiveBlobEpochs = opts.archiveBlobEpochs; | ||
| this.prevFinalized = chain.forkChoice.getFinalizedCheckpoint(); | ||
| this.jobQueue = new JobItemQueue<[CheckpointWithHex], void>(this.processFinalizedCheckpoint, { | ||
| maxLength: PROCESS_FINALIZED_CHECKPOINT_QUEUE_LEN, | ||
| signal, | ||
| }); | ||
|
|
||
| if (!opts.disableArchiveOnCheckpoint) { | ||
| this.chain.emitter.on(ChainEvent.forkChoiceFinalized, this.onFinalizedCheckpoint); | ||
| this.chain.emitter.on(ChainEvent.checkpoint, this.onCheckpoint); | ||
|
|
||
| signal.addEventListener( | ||
| "abort", | ||
| () => { | ||
| this.chain.emitter.off(ChainEvent.forkChoiceFinalized, this.onFinalizedCheckpoint); | ||
| this.chain.emitter.off(ChainEvent.checkpoint, this.onCheckpoint); | ||
| }, | ||
| {once: true} | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| /** Archive latest finalized state */ | ||
| async persistToDisk(): Promise<void> { | ||
| await this.statesArchiverStrategy.maybeArchiveState(this.chain.forkChoice.getFinalizedCheckpoint()); | ||
nazarhussain marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| private onFinalizedCheckpoint = async (finalized: CheckpointWithHex): Promise<void> => { | ||
| return this.jobQueue.push(finalized); | ||
| }; | ||
|
|
||
| private onCheckpoint = (): void => { | ||
| const headStateRoot = this.chain.forkChoice.getHead().stateRoot; | ||
| this.chain.regen.pruneOnCheckpoint( | ||
| this.chain.forkChoice.getFinalizedCheckpoint().epoch, | ||
| this.chain.forkChoice.getJustifiedCheckpoint().epoch, | ||
| headStateRoot | ||
| ); | ||
|
|
||
| this.statesArchiverStrategy.onCheckpoint(headStateRoot, this.metrics).catch((err) => { | ||
| this.logger.error("Error during state archive", {archiveMode: this.archiveMode}, err); | ||
| }); | ||
| }; | ||
|
|
||
| private processFinalizedCheckpoint = async (finalized: CheckpointWithHex): Promise<void> => { | ||
| try { | ||
| const finalizedEpoch = finalized.epoch; | ||
| this.logger.verbose("Start processing finalized checkpoint", {epoch: finalizedEpoch, rootHex: finalized.rootHex}); | ||
| await archiveBlocks( | ||
| this.chain.config, | ||
| this.db, | ||
| this.chain.forkChoice, | ||
| this.chain.lightClientServer, | ||
| this.logger, | ||
| finalized, | ||
| this.chain.clock.currentEpoch, | ||
| this.archiveBlobEpochs | ||
| ); | ||
| this.prevFinalized = finalized; | ||
|
|
||
| await this.statesArchiverStrategy.onFinalizedCheckpoint(finalized, this.metrics); | ||
|
|
||
| // should be after ArchiveBlocksTask to handle restart cleanly | ||
| await this.statesArchiverStrategy.maybeArchiveState(finalized, this.metrics); | ||
|
|
||
| this.chain.regen.pruneOnFinalized(finalizedEpoch); | ||
|
|
||
| // tasks rely on extended fork choice | ||
| const prunedBlocks = this.chain.forkChoice.prune(finalized.rootHex); | ||
| await this.updateBackfillRange(finalized); | ||
|
|
||
| this.logger.verbose("Finish processing finalized checkpoint", { | ||
| epoch: finalizedEpoch, | ||
| rootHex: finalized.rootHex, | ||
| prunedBlocks: prunedBlocks.length, | ||
| }); | ||
| } catch (e) { | ||
| this.logger.error("Error processing finalized checkpoint", {epoch: finalized.epoch}, e as Error); | ||
| } | ||
| }; | ||
|
|
||
| /** | ||
| * Backfill sync relies on verified connected ranges (which are represented as key,value | ||
| * with a verified jump from a key back to value). Since the node could have progressed | ||
| * ahead from, we need to save the forward progress of this node as another backfill | ||
| * range entry, that backfill sync will use to jump back if this node is restarted | ||
| * for any reason. | ||
| * The current backfill has its own backfill entry from anchor slot to last backfilled | ||
| * slot. And this would create the entry from the current finalized slot to the anchor | ||
| * slot. | ||
| */ | ||
| private updateBackfillRange = async (finalized: CheckpointWithHex): Promise<void> => { | ||
| try { | ||
| // Mark the sequence in backfill db from finalized block's slot till anchor slot as | ||
| // filled. | ||
| const finalizedBlockFC = this.chain.forkChoice.getBlockHex(finalized.rootHex); | ||
| if (finalizedBlockFC && finalizedBlockFC.slot > this.chain.anchorStateLatestBlockSlot) { | ||
| await this.db.backfilledRanges.put(finalizedBlockFC.slot, this.chain.anchorStateLatestBlockSlot); | ||
|
|
||
| // Clear previously marked sequence till anchorStateLatestBlockSlot, without | ||
| // touching backfill sync process sequence which are at | ||
| // <=anchorStateLatestBlockSlot i.e. clear >anchorStateLatestBlockSlot | ||
| // and < currentSlot | ||
| const filteredSeqs = await this.db.backfilledRanges.entries({ | ||
| gt: this.chain.anchorStateLatestBlockSlot, | ||
| lt: finalizedBlockFC.slot, | ||
| }); | ||
| this.logger.debug("updated backfilledRanges", { | ||
| key: finalizedBlockFC.slot, | ||
| value: this.chain.anchorStateLatestBlockSlot, | ||
| }); | ||
| if (filteredSeqs.length > 0) { | ||
| await this.db.backfilledRanges.batchDelete(filteredSeqs.map((entry) => entry.key)); | ||
| this.logger.debug( | ||
| `Forward Sync - cleaned up backfilledRanges between ${finalizedBlockFC.slot},${this.chain.anchorStateLatestBlockSlot}`, | ||
| {seqs: JSON.stringify(filteredSeqs)} | ||
| ); | ||
| } | ||
| } | ||
| } catch (e) { | ||
| this.logger.error("Error updating backfilledRanges on finalization", {epoch: finalized.epoch}, e as Error); | ||
| } | ||
| }; | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import {ArchiveMode} from "./interface.js"; | ||
|
|
||
| /** | ||
| * Minimum number of epochs between single temp archived states | ||
| * These states will be pruned once a new state is persisted | ||
| */ | ||
| export const PERSIST_TEMP_STATE_EVERY_EPOCHS = 32; | ||
|
|
||
| export const PROCESS_FINALIZED_CHECKPOINT_QUEUE_LEN = 256; | ||
|
|
||
| export const DEFAULT_ARCHIVE_MODE = ArchiveMode.Full; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,170 +1,3 @@ | ||
| export * from "./archiver.js"; | ||
| export * from "./interface.js"; | ||
| export * from "./constants.js"; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| import {CheckpointWithHex} from "@lodestar/fork-choice"; | ||
| import {Metrics} from "../../metrics/metrics.js"; | ||
| import {RootHex} from "@lodestar/types"; | ||
|
There was a problem hiding this comment. the new linter does not enforce import order anymore? There was a problem hiding this comment. There is a caveat related to import order, not yet enabled. #7182 |
||
|
|
||
| export enum ArchiveMode { | ||
| Full = "full", | ||
|
There was a problem hiding this comment. If you think of a better name for current archiver strategy we use, please suggest. There was a problem hiding this comment. More of a general question, once we have differential archive mode implemented, will there be any advantage to use our current (full) archiving strategy? If not, we should probably not make it overly generic / switchable There was a problem hiding this comment. My idea is to get the differential strategy released as experimental first. As I am a bit skeptical about it's memory implication. So during that time user can choose which strategy to use. |
||
| Differential = "diff", | ||
| } | ||
|
|
||
| export interface StatesArchiverOpts { | ||
| /** | ||
| * Minimum number of epochs between archived states | ||
| */ | ||
| archiveStateEpochFrequency: number; | ||
| /** | ||
| * Strategy to store archive states | ||
| */ | ||
| archiveMode: ArchiveMode; | ||
| } | ||
|
|
||
| export type ArchiverOpts = StatesArchiverOpts & { | ||
| disableArchiveOnCheckpoint?: boolean; | ||
| archiveBlobEpochs?: number; | ||
| }; | ||
|
|
||
| export type ProposalStats = { | ||
| total: number; | ||
| finalized: number; | ||
| orphaned: number; | ||
| missed: number; | ||
| }; | ||
|
|
||
| export type FinalizedStats = { | ||
| allValidators: ProposalStats; | ||
| attachedValidators: ProposalStats; | ||
| finalizedCanonicalCheckpointsCount: number; | ||
| finalizedFoundCheckpointsInStateCache: number; | ||
| finalizedAttachedValidatorsCount: number; | ||
| }; | ||
|
|
||
| export interface StateArchiveStrategy { | ||
| onCheckpoint(stateRoot: RootHex, metrics?: Metrics | null): Promise<void>; | ||
| onFinalizedCheckpoint(finalized: CheckpointWithHex, metrics?: Metrics | null): Promise<void>; | ||
| maybeArchiveState(finalized: CheckpointWithHex, metrics?: Metrics | null): Promise<void>; | ||
| } | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This file is actually old
index.tsfile, with only strategy specific changes.