@aztec/p2p 0.0.0-test.1 → 0.0.1-commit.21caa21

package/src/services/peer-manager/interface.ts

@@ -0,0 +1,29 @@
+import type { EthAddress } from '@aztec/foundation/eth-address';
+import type { PeerInfo } from '@aztec/stdlib/interfaces/server';
+import type { PeerErrorSeverity } from '@aztec/stdlib/p2p';
+
+import type { PeerId } from '@libp2p/interface';
+
+import type { AuthRequest, StatusMessage } from '../reqresp/index.js';
+import type { GoodByeReason } from '../reqresp/protocols/goodbye.js';
+
+export interface PeerManagerInterface {
+  getPeers(_includePending?: boolean): PeerInfo[];
+
+  initializePeers(): Promise<void>;
+  heartbeat(): Promise<void>;
+  addTrustedPeer(peerId: PeerId): void;
+  addPrivatePeer(peerId: PeerId): void;
+  addPreferredPeer(peerId: PeerId): void;
+  goodbyeReceived(peerId: PeerId, reason: GoodByeReason): void;
+  penalizePeer(peerId: PeerId, penalty: PeerErrorSeverity): void;
+  handleAuthRequestFromPeer(authRequest: AuthRequest, peerId: PeerId): Promise<StatusMessage>;
+
+  getPeerScore(peerId: string): number;
+  shouldDisableP2PGossip(peerId: string): boolean;
+
+  stop(): Promise<void>;
+
+  /** If node running this P2P stack is validator, passes in validator address to P2P layer */
+  registerThisValidatorAddresses(address: EthAddress[]): void;
+}

package/src/services/peer-manager/metrics.ts

@@ -1,10 +1,12 @@
 import {
   Attributes,
+  type Gauge,
   Metrics,
   type TelemetryClient,
   type Tracer,
   type UpDownCounter,
   ValueType,
+  getTelemetryClient,
 } from '@aztec/telemetry-client';
 
 import { type GoodByeReason, prettyGoodbyeReason } from '../reqresp/protocols/index.js';
@@ -12,10 +14,15 @@ import { type GoodByeReason, prettyGoodbyeReason } from '../reqresp/protocols/in
 export class PeerManagerMetrics {
   private sentGoodbyes: UpDownCounter;
   private receivedGoodbyes: UpDownCounter;
+  private peerCount: Gauge;
+  private lowScoreDisconnects: UpDownCounter;
 
   public readonly tracer: Tracer;
 
-  constructor(public readonly telemetryClient: TelemetryClient, name = 'PeerManager') {
+  constructor(
+    public readonly telemetryClient: TelemetryClient = getTelemetryClient(),
+    name = 'PeerManager',
+  ) {
     this.tracer = telemetryClient.getTracer(name);
 
     const meter = telemetryClient.getMeter(name);
@@ -29,6 +36,16 @@ export class PeerManagerMetrics {
       unit: 'peers',
       valueType: ValueType.INT,
     });
+    this.peerCount = meter.createGauge(Metrics.PEER_MANAGER_PEER_COUNT, {
+      description: 'Number of peers',
+      unit: 'peers',
+      valueType: ValueType.INT,
+    });
+    this.lowScoreDisconnects = meter.createUpDownCounter(Metrics.PEER_MANAGER_LOW_SCORE_DISCONNECTS, {
+      description: 'Number of peers disconnected due to low score',
+      unit: 'peers',
+      valueType: ValueType.INT,
+    });
   }
 
   public recordGoodbyeSent(reason: GoodByeReason) {
@@ -38,4 +55,12 @@ export class PeerManagerMetrics {
   public recordGoodbyeReceived(reason: GoodByeReason) {
     this.receivedGoodbyes.add(1, { [Attributes.P2P_GOODBYE_REASON]: prettyGoodbyeReason(reason) });
   }
+
+  public recordPeerCount(count: number) {
+    this.peerCount.record(count);
+  }
+
+  public recordLowScoreDisconnect(scoreState: 'Banned' | 'Disconnect') {
+    this.lowScoreDisconnects.add(1, { [Attributes.P2P_PEER_SCORE_STATE]: scoreState });
+  }
 }