libp2p-gossipsub/src/score/peer-stats.d.ts

A typescript implementation of gossipsub

import { PeerScoreParams } from './peer-score-params';
export interface PeerStats {
    /**
     * true if the peer is currently connected
     */
    connected: boolean;
    /**
     * expiration time of the score stats for disconnected peers
     */
    expire: number;
    /**
     * per topic stats
     */
    topics: Record<string, TopicStats>;
    /**
     * IP tracking; store as string for easy processing
     */
    ips: string[];
    /**
     * behavioural pattern penalties (applied by the router)
     */
    behaviourPenalty: number;
}
export interface TopicStats {
    /**
     * true if the peer is in the mesh
     */
    inMesh: boolean;
    /**
     * time when the peer was (last) GRAFTed; valid only when in mesh
     */
    graftTime: number;
    /**
     * time in mesh (updated during refresh/decay to avoid calling gettimeofday on
     * every score invocation)
     */
    meshTime: number;
    /**
     * first message deliveries
     */
    firstMessageDeliveries: number;
    /**
     * mesh message deliveries
     */
    meshMessageDeliveries: number;
    /**
     * true if the peer has been enough time in the mesh to activate mess message deliveries
     */
    meshMessageDeliveriesActive: boolean;
    /**
     * sticky mesh rate failure penalty counter
     */
    meshFailurePenalty: number;
    /**
     * invalid message counter
     */
    invalidMessageDeliveries: number;
}
export declare function createPeerStats(ps?: Partial<PeerStats>): PeerStats;
export declare function createTopicStats(ts?: Partial<TopicStats>): TopicStats;
export declare function ensureTopicStats(topic: string, ps: PeerStats, params: PeerScoreParams): TopicStats | undefined;