@lodestar/beacon-node/lib/sync/interface.d.ts

A Typescript implementation of the beacon chain

import { routes } from "@lodestar/api";
import { BeaconConfig } from "@lodestar/config";
import { Slot, phase0 } from "@lodestar/types";
import { Logger } from "@lodestar/utils";
import { IBeaconChain } from "../chain/index.js";
import { IBeaconDb } from "../db/index.js";
import { Metrics } from "../metrics/index.js";
import { INetwork } from "../network/index.js";
import { SyncChainDebugState } from "./range/chain.js";
export type { SyncChainDebugState };
export type SyncingStatus = routes.node.SyncingStatus;
export interface IBeaconSync {
    state: SyncState;
    close(): void;
    getSyncStatus(): SyncingStatus;
    isSynced(): boolean;
    isSyncing(): boolean;
    getSyncChainsDebugState(): SyncChainDebugState[];
}
export declare enum SyncState {
    /** No useful peers are connected */
    Stalled = "Stalled",
    /** The node is performing a long-range sync over a finalized chain */
    SyncingFinalized = "SyncingFinalized",
    /** The node is performing a long-range sync over head chains */
    SyncingHead = "SyncingHead",
    /** The node is up to date with all known peers */
    Synced = "Synced"
}
/** Map a SyncState to an integer for rendering in Grafana */
export declare const syncStateMetric: {
    [K in SyncState]: number;
};
export type SlotRange = {
    start: Slot;
    end: Slot;
};
export interface SyncModules {
    config: BeaconConfig;
    network: INetwork;
    db: IBeaconDb;
    metrics: Metrics | null;
    logger: Logger;
    chain: IBeaconChain;
    wsCheckpoint?: phase0.Checkpoint;
}
//# sourceMappingURL=interface.d.ts.map