@lodestar/beacon-node/lib/network/peers/score/interface.d.ts

A Typescript implementation of the beacon chain

import { PeerId } from "@libp2p/interface";
import { GoodByeReasonCode } from "../../../constants/network.js";
import { PeerIdStr } from "../../../util/peerId.js";
import { NetworkCoreMetrics } from "../../core/metrics.js";
export type PeerRpcScoreOpts = {
    disablePeerScoring?: boolean;
};
export interface IPeerRpcScoreStore {
    getScore(peer: PeerId): number;
    getGossipScore(peer: PeerId): number;
    getScoreState(peer: PeerId): ScoreState;
    isCoolingDown(peer: PeerIdStr): boolean;
    dumpPeerScoreStats(): PeerScoreStats;
    applyAction(peer: PeerId, action: PeerAction, actionName: string): void;
    applyReconnectionCoolDown(peer: PeerIdStr, reason: GoodByeReasonCode): number;
    update(): void;
    updateGossipsubScore(peerId: PeerIdStr, newScore: number, ignore: boolean): void;
}
export interface IPeerScore {
    getScore(): number;
    getGossipScore(): number;
    isCoolingDown(): boolean;
    add(scoreDelta: number): number;
    update(): number;
    updateGossipsubScore(newScore: number, ignore: boolean): void;
    getStat(): PeerScoreStat;
    applyReconnectionCoolDown(reason: GoodByeReasonCode): number;
}
export declare enum ScoreState {
    /** We are content with the peers performance. We permit connections and messages. */
    Healthy = "Healthy",
    /** The peer should be disconnected. We allow re-connections if the peer is persistent */
    Disconnected = "Disconnected",
    /** The peer is banned. We disallow new connections until it's score has decayed into a tolerable threshold */
    Banned = "Banned"
}
export type PeerRpcScoreStoreModules = {
    metrics: NetworkCoreMetrics | null;
};
export type PeerScoreStats = ({
    peerId: PeerIdStr;
} & PeerScoreStat)[];
export type PeerScoreStat = {
    lodestarScore: number;
    gossipScore: number;
    ignoreNegativeGossipScore: boolean;
    score: number;
    lastUpdate: number;
};
export declare enum PeerAction {
    /** Immediately ban peer */
    Fatal = "Fatal",
    /**
     * Not malicious action, but it must not be tolerated
     * ~5 occurrences will get the peer banned
     */
    LowToleranceError = "LowToleranceError",
    /**
     * Negative action that can be tolerated only sometimes
     * ~10 occurrences will get the peer banned
     */
    MidToleranceError = "MidToleranceError",
    /**
     * Some error that can be tolerated multiple times
     * ~50 occurrences will get the peer banned
     */
    HighToleranceError = "HighToleranceError"
}
//# sourceMappingURL=interface.d.ts.map