@aztec/p2p 0.66.0 → 0.67.1-devnet

package/src/mem_pools/attestation_pool/kv_attestation_pool.ts

@@ -0,0 +1,153 @@
+import { BlockAttestation } from '@aztec/circuit-types';
+import { Fr } from '@aztec/foundation/fields';
+import { createLogger } from '@aztec/foundation/log';
+import { type AztecKVStore, type AztecMapWithSize, type AztecMultiMap } from '@aztec/kv-store';
+import { type TelemetryClient } from '@aztec/telemetry-client';
+
+import { PoolInstrumentation, PoolName } from '../instrumentation.js';
+import { type AttestationPool } from './attestation_pool.js';
+
+export class KvAttestationPool implements AttestationPool {
+  private metrics: PoolInstrumentation<BlockAttestation>;
+
+  // Index of all proposal ids in a slot
+  private attestations: AztecMultiMap<string, string>;
+
+  constructor(
+    private store: AztecKVStore,
+    telemetry: TelemetryClient,
+    private log = createLogger('aztec:attestation_pool'),
+  ) {
+    this.attestations = store.openMultiMap('attestations');
+    this.metrics = new PoolInstrumentation(telemetry, PoolName.ATTESTATION_POOL);
+  }
+
+  private getProposalMapKey(slot: string, proposalId: string): string {
+    return `proposal-${slot}-${proposalId}`;
+  }
+
+  /**
+   * Get the proposal map for a given slot and proposalId
+   *
+   * Essentially a nested mapping of address -> attestation
+   *
+   * @param slot - The slot to get the proposal map for
+   * @param proposalId - The proposalId to get the map for
+   * @returns The proposal map
+   */
+  private getProposalMap(slot: string, proposalId: string): AztecMapWithSize<string, Buffer> {
+    const mapKey = this.getProposalMapKey(slot, proposalId);
+    return this.store.openMapWithSize(mapKey);
+  }
+
+  public async addAttestations(attestations: BlockAttestation[]): Promise<void> {
+    for (const attestation of attestations) {
+      const slotNumber = attestation.payload.header.globalVariables.slotNumber.toString();
+      const proposalId = attestation.archive.toString();
+      const address = attestation.getSender().toString();
+
+      // Index the proposalId in the slot map
+      await this.attestations.set(slotNumber, proposalId);
+
+      // Store the actual attestation in the proposal map
+      const proposalMap = this.getProposalMap(slotNumber, proposalId);
+      await proposalMap.set(address, attestation.toBuffer());
+
+      this.log.verbose(`Added attestation for slot ${slotNumber} from ${address}`);
+    }
+
+    this.metrics.recordAddedObjects(attestations.length);
+  }
+
+  public getAttestationsForSlot(slot: bigint, proposalId: string): Promise<BlockAttestation[]> {
+    const slotNumber = new Fr(slot).toString();
+    const proposalMap = this.getProposalMap(slotNumber, proposalId);
+    const attestations = proposalMap.values();
+    const attestationsArray = Array.from(attestations).map(attestation => BlockAttestation.fromBuffer(attestation));
+    return Promise.resolve(attestationsArray);
+  }
+
+  public async deleteAttestationsOlderThan(oldestSlot: bigint): Promise<void> {
+    const olderThan = [];
+
+    const slots = this.attestations.keys();
+    for (const slot of slots) {
+      if (BigInt(slot) < oldestSlot) {
+        olderThan.push(slot);
+      }
+    }
+
+    await Promise.all(olderThan.map(oldSlot => this.deleteAttestationsForSlot(BigInt(oldSlot))));
+    return Promise.resolve();
+  }
+
+  public async deleteAttestationsForSlot(slot: bigint): Promise<void> {
+    const deletionPromises = [];
+
+    const slotString = new Fr(slot).toString();
+    let numberOfAttestations = 0;
+    const proposalIds = this.attestations.getValues(slotString);
+
+    if (proposalIds) {
+      for (const proposalId of proposalIds) {
+        const proposalMap = this.getProposalMap(slotString, proposalId);
+        numberOfAttestations += proposalMap.size();
+        deletionPromises.push(proposalMap.clear());
+      }
+    }
+
+    await Promise.all(deletionPromises);
+
+    this.log.verbose(`Removed ${numberOfAttestations} attestations for slot ${slot}`);
+    this.metrics.recordRemovedObjects(numberOfAttestations);
+    return Promise.resolve();
+  }
+
+  public async deleteAttestationsForSlotAndProposal(slot: bigint, proposalId: string): Promise<void> {
+    const deletionPromises = [];
+
+    const slotString = new Fr(slot).toString();
+    const exists = this.attestations.get(slotString);
+
+    if (exists) {
+      // Remove the proposalId from the slot index
+      deletionPromises.push(this.attestations.deleteValue(slotString, proposalId));
+
+      // Delete all attestations for the proposalId
+      const proposalMap = this.getProposalMap(slotString, proposalId);
+      const numberOfAttestations = proposalMap.size();
+      deletionPromises.push(proposalMap.clear());
+
+      this.log.verbose(`Removed ${numberOfAttestations} attestations for slot ${slot} and proposal ${proposalId}`);
+      this.metrics.recordRemovedObjects(numberOfAttestations);
+    }
+
+    await Promise.all(deletionPromises);
+    return Promise.resolve();
+  }
+
+  public async deleteAttestations(attestations: BlockAttestation[]): Promise<void> {
+    const deletionPromises = [];
+
+    for (const attestation of attestations) {
+      const slotNumber = attestation.payload.header.globalVariables.slotNumber.toString();
+      const proposalId = attestation.archive.toString();
+      const proposalMap = this.getProposalMap(slotNumber, proposalId);
+
+      if (proposalMap) {
+        const address = attestation.getSender().toString();
+        deletionPromises.push(proposalMap.delete(address));
+        this.log.debug(`Deleted attestation for slot ${slotNumber} from ${address}`);
+      }
+
+      if (proposalMap.size() === 0) {
+        deletionPromises.push(this.attestations.deleteValue(slotNumber, proposalId));
+      }
+    }
+
+    await Promise.all(deletionPromises);
+
+    this.metrics.recordRemovedObjects(attestations.length);
+    return Promise.resolve();
+  }
+}

package/src/mem_pools/attestation_pool/memory_attestation_pool.ts

@@ -1,5 +1,5 @@
 import { type BlockAttestation } from '@aztec/circuit-types';
-import { createDebugLogger } from '@aztec/foundation/log';
+import { createLogger } from '@aztec/foundation/log';
 import { type TelemetryClient } from '@aztec/telemetry-client';
 
 import { PoolInstrumentation, PoolName } from '../instrumentation.js';
@@ -10,7 +10,7 @@ export class InMemoryAttestationPool implements AttestationPool {
 
   private attestations: Map</*slot=*/ bigint, Map</*proposalId*/ string, Map</*address=*/ string, BlockAttestation>>>;
 
-  constructor(telemetry: TelemetryClient, private log = createDebugLogger('aztec:attestation_pool')) {
+  constructor(telemetry: TelemetryClient, private log = createLogger('p2p:attestation_pool')) {
     this.attestations = new Map();
     this.metrics = new PoolInstrumentation(telemetry, PoolName.ATTESTATION_POOL);
   }

package/src/mem_pools/instrumentation.ts

@@ -72,32 +72,12 @@ export class PoolInstrumentation<PoolObject extends Gossipable> {
     this.objectSize = meter.createHistogram(metricsLabels.objectSize, {
       unit: 'By',
       description: 'The size of transactions in the mempool',
-      advice: {
-        explicitBucketBoundaries: [
-          5_000, // 5KB
-          10_000,
-          20_000,
-          50_000,
-          75_000,
-          100_000, // 100KB
-          200_000,
-        ],
-      },
     });
 
     this.dbMetrics = new LmdbMetrics(
       meter,
       {
-        name: Metrics.MEMPOOL_DB_MAP_SIZE,
-        description: 'Database map size for the Tx mempool',
-      },
-      {
-        name: Metrics.MEMPOOL_DB_USED_SIZE,
-        description: 'Database used size for the Tx mempool',
-      },
-      {
-        name: Metrics.MEMPOOL_DB_NUM_ITEMS,
-        description: 'Num items in database for the Tx mempool',
+        [Attributes.DB_DATA_TYPE]: 'tx-pool',
       },
       dbStats,
     );

package/src/mem_pools/interface.ts

@@ -1,3 +1,5 @@
+import { type P2PClientType } from '@aztec/circuit-types';
+
 import { type AttestationPool } from './attestation_pool/attestation_pool.js';
 import { type EpochProofQuotePool } from './epoch_proof_quote_pool/epoch_proof_quote_pool.js';
 import { type TxPool } from './tx_pool/tx_pool.js';
@@ -5,8 +7,8 @@ import { type TxPool } from './tx_pool/tx_pool.js';
 /**
  * A interface the combines all mempools
  */
-export interface MemPools {
+export type MemPools<T extends P2PClientType = P2PClientType.Full> = {
   txPool: TxPool;
-  attestationPool: AttestationPool;
+  attestationPool?: T extends P2PClientType.Full ? AttestationPool : undefined;
   epochProofQuotePool: EpochProofQuotePool;
-}
+};

package/src/mem_pools/tx_pool/aztec_kv_tx_pool.ts

@@ -1,6 +1,6 @@
 import { Tx, TxHash } from '@aztec/circuit-types';
 import { type TxAddedToPoolStats } from '@aztec/circuit-types/stats';
-import { type Logger, createDebugLogger } from '@aztec/foundation/log';
+import { type Logger, createLogger } from '@aztec/foundation/log';
 import { type AztecKVStore, type AztecMap, type AztecSet } from '@aztec/kv-store';
 import { type TelemetryClient } from '@aztec/telemetry-client';
 
@@ -30,7 +30,7 @@ export class AztecKVTxPool implements TxPool {
    * @param store - A KV store.
    * @param log - A logger.
    */
-  constructor(store: AztecKVStore, telemetry: TelemetryClient, log = createDebugLogger('aztec:tx_pool')) {
+  constructor(store: AztecKVStore, telemetry: TelemetryClient, log = createLogger('p2p:tx_pool')) {
     this.#txs = store.openMap('txs');
     this.#minedTxs = store.openMap('minedTxs');
     this.#pendingTxs = store.openSet('pendingTxs');
@@ -125,7 +125,7 @@ export class AztecKVTxPool implements TxPool {
       let pendingCount = 0;
       for (const [i, tx] of txs.entries()) {
         const txHash = txHashes[i];
-        this.#log.info(`Adding tx with id ${txHash.toString()}`, {
+        this.#log.verbose(`Adding tx ${txHash.toString()} to pool`, {
           eventName: 'tx-added-to-pool',
           ...tx.getStats(),
         } satisfies TxAddedToPoolStats);

package/src/mem_pools/tx_pool/memory_tx_pool.ts

@@ -1,6 +1,6 @@
 import { Tx, TxHash } from '@aztec/circuit-types';
 import { type TxAddedToPoolStats } from '@aztec/circuit-types/stats';
-import { createDebugLogger } from '@aztec/foundation/log';
+import { createLogger } from '@aztec/foundation/log';
 import { type TelemetryClient } from '@aztec/telemetry-client';
 
 import { PoolInstrumentation, PoolName } from '../instrumentation.js';
@@ -23,7 +23,7 @@ export class InMemoryTxPool implements TxPool {
    * Class constructor for in-memory TxPool. Initiates our transaction pool as a JS Map.
    * @param log - A logger.
    */
-  constructor(telemetry: TelemetryClient, private log = createDebugLogger('aztec:tx_pool')) {
+  constructor(telemetry: TelemetryClient, private log = createLogger('p2p:tx_pool')) {
     this.txs = new Map<bigint, Tx>();
     this.minedTxs = new Map();
     this.pendingTxs = new Set();
@@ -105,7 +105,7 @@ export class InMemoryTxPool implements TxPool {
     let pending = 0;
     for (const tx of txs) {
       const txHash = tx.getTxHash();
-      this.log.debug(`Adding tx with id ${txHash.toString()}`, {
+      this.log.verbose(`Adding tx ${txHash.toString()} to pool`, {
         eventName: 'tx-added-to-pool',
         ...tx.getStats(),
       } satisfies TxAddedToPoolStats);

package/src/mocks/index.ts

@@ -1,11 +1,12 @@
 import {
   type ClientProtocolCircuitVerifier,
   type L2BlockSource,
+  type P2PClientType,
   type Tx,
   type WorldStateSynchronizer,
 } from '@aztec/circuit-types';
 import { type DataStoreConfig } from '@aztec/kv-store/config';
-import { openTmpStore } from '@aztec/kv-store/utils';
+import { openTmpStore } from '@aztec/kv-store/lmdb';
 import { type TelemetryClient } from '@aztec/telemetry-client';
 import { NoopTelemetryClient } from '@aztec/telemetry-client/noop';
 
@@ -23,11 +24,11 @@ import { type Libp2p, type Libp2pOptions, createLibp2p } from 'libp2p';
 import { BootstrapNode } from '../bootstrap/bootstrap.js';
 import { type BootnodeConfig, type P2PConfig } from '../config.js';
 import { type MemPools } from '../mem_pools/interface.js';
-import { DiscV5Service } from '../service/discV5_service.js';
-import { LibP2PService } from '../service/libp2p_service.js';
-import { type PeerManager } from '../service/peer_manager.js';
-import { type P2PReqRespConfig } from '../service/reqresp/config.js';
-import { pingHandler, statusHandler } from '../service/reqresp/handlers.js';
+import { DiscV5Service } from '../services/discv5/discV5_service.js';
+import { LibP2PService } from '../services/libp2p/libp2p_service.js';
+import { type PeerManager } from '../services/peer_manager.js';
+import { type P2PReqRespConfig } from '../services/reqresp/config.js';
+import { pingHandler, statusHandler } from '../services/reqresp/handlers.js';
 import {
   PING_PROTOCOL,
   type ReqRespSubProtocolHandlers,
@@ -35,8 +36,8 @@ import {
   STATUS_PROTOCOL,
   TX_REQ_PROTOCOL,
   noopValidator,
-} from '../service/reqresp/interface.js';
-import { ReqResp } from '../service/reqresp/reqresp.js';
+} from '../services/reqresp/interface.js';
+import { ReqResp } from '../services/reqresp/reqresp.js';
 import { type PubSubLibp2p } from '../util.js';
 
 /**
@@ -95,11 +96,12 @@ export async function createLibp2pNode(
  *
  *
  */
-export async function createTestLibP2PService(
+export async function createTestLibP2PService<T extends P2PClientType>(
+  clientType: T,
   boostrapAddrs: string[] = [],
   l2BlockSource: L2BlockSource,
   worldStateSynchronizer: WorldStateSynchronizer,
-  mempools: MemPools,
+  mempools: MemPools<T>,
   telemetry: TelemetryClient,
   port: number = 0,
   peerId?: PeerId,
@@ -123,7 +125,8 @@ export async function createTestLibP2PService(
   // No bootstrap nodes provided as the libp2p service will register them in the constructor
   const p2pNode = await createLibp2pNode([], peerId, port, /*enable gossip */ true, /**start */ false);
 
-  return new LibP2PService(
+  return new LibP2PService<T>(
+    clientType,
     config,
     p2pNode as PubSubLibp2p,
     discoveryService,

package/src/{service → services/discv5}/discV5_service.ts

@@ -1,16 +1,16 @@
-import { createDebugLogger } from '@aztec/foundation/log';
+import { createLogger } from '@aztec/foundation/log';
 import { sleep } from '@aztec/foundation/sleep';
 import { OtelMetricsAdapter, type TelemetryClient } from '@aztec/telemetry-client';
 
 import { Discv5, type Discv5EventEmitter } from '@chainsafe/discv5';
 import { ENR, SignableENR } from '@chainsafe/enr';
 import type { PeerId } from '@libp2p/interface';
-import { multiaddr } from '@multiformats/multiaddr';
+import { type Multiaddr, multiaddr } from '@multiformats/multiaddr';
 import EventEmitter from 'events';
 
-import type { P2PConfig } from '../config.js';
-import { convertToMultiaddr } from '../util.js';
-import { type PeerDiscoveryService, PeerDiscoveryState } from './service.js';
+import type { P2PConfig } from '../../config.js';
+import { convertToMultiaddr } from '../../util.js';
+import { type PeerDiscoveryService, PeerDiscoveryState } from '../service.js';
 
 export const AZTEC_ENR_KEY = 'aztec_network';
 
@@ -35,6 +35,9 @@ export class DiscV5Service extends EventEmitter implements PeerDiscoveryService
   /** This instance's ENR */
   private enr: SignableENR;
 
+  /** UDP listen addr */
+  private listenMultiAddrUdp: Multiaddr;
+
   private currentState = PeerDiscoveryState.STOPPED;
 
   private bootstrapNodes: string[];
@@ -46,7 +49,7 @@ export class DiscV5Service extends EventEmitter implements PeerDiscoveryService
     private peerId: PeerId,
     config: P2PConfig,
     telemetry: TelemetryClient,
-    private logger = createDebugLogger('aztec:discv5_service'),
+    private logger = createLogger('p2p:discv5_service'),
   ) {
     super();
     const { tcpAnnounceAddress, udpAnnounceAddress, udpListenAddress, bootstrapNodes } = config;
@@ -66,7 +69,7 @@ export class DiscV5Service extends EventEmitter implements PeerDiscoveryService
       `${convertToMultiaddr(udpAnnounceAddress || tcpAnnounceAddress, 'udp')}/p2p/${peerId.toString()}`,
     );
 
-    const listenMultiAddrUdp = multiaddr(convertToMultiaddr(udpListenAddress, 'udp'));
+    this.listenMultiAddrUdp = multiaddr(convertToMultiaddr(udpListenAddress, 'udp'));
 
     // set location multiaddr in ENR record
     this.enr.setLocationMultiaddr(multiAddrUdp);
@@ -76,7 +79,7 @@ export class DiscV5Service extends EventEmitter implements PeerDiscoveryService
     this.discv5 = Discv5.create({
       enr: this.enr,
       peerId,
-      bindAddrs: { ip4: listenMultiAddrUdp },
+      bindAddrs: { ip4: this.listenMultiAddrUdp },
       config: {
         lookupTimeout: 2000,
         requestTimeout: 2000,
@@ -85,14 +88,11 @@ export class DiscV5Service extends EventEmitter implements PeerDiscoveryService
       metricsRegistry,
     });
 
-    this.logger.info(`ENR NodeId: ${this.enr.nodeId}`);
-    this.logger.info(`ENR UDP: ${multiAddrUdp.toString()}`);
-
     (this.discv5 as Discv5EventEmitter).on('discovered', (enr: ENR) => this.onDiscovered(enr));
     (this.discv5 as Discv5EventEmitter).on('enrAdded', async (enr: ENR) => {
       const multiAddrTcp = await enr.getFullMultiaddr('tcp');
       const multiAddrUdp = await enr.getFullMultiaddr('udp');
-      this.logger.debug(`ENR multiaddr: ${multiAddrTcp?.toString()}, ${multiAddrUdp?.toString()}`);
+      this.logger.debug(`Added ENR ${enr.encodeTxt()}`, { multiAddrTcp, multiAddrUdp, nodeId: enr.nodeId });
       this.onDiscovered(enr);
     });
   }
@@ -101,18 +101,23 @@ export class DiscV5Service extends EventEmitter implements PeerDiscoveryService
     if (this.currentState === PeerDiscoveryState.RUNNING) {
       throw new Error('DiscV5Service already started');
     }
-    this.logger.info('Starting DiscV5');
+    this.logger.debug('Starting DiscV5');
     await this.discv5.start();
     this.startTime = Date.now();
 
-    this.logger.info('DiscV5 started');
+    this.logger.info(`DiscV5 service started`, {
+      nodeId: this.enr.nodeId,
+      peerId: this.peerId,
+      enrUdp: await this.enr.getFullMultiaddr('udp'),
+      enrTcp: await this.enr.getFullMultiaddr('tcp'),
+    });
     this.currentState = PeerDiscoveryState.RUNNING;
 
     // Add bootnode ENR if provided
     if (this.bootstrapNodes?.length) {
       // Do this conversion once since it involves an async function call
       this.bootstrapNodePeerIds = await Promise.all(this.bootstrapNodes.map(enr => ENR.decodeTxt(enr).peerId()));
-      this.logger.info(`Adding bootstrap ENRs: ${this.bootstrapNodes.join(', ')}`);
+      this.logger.info(`Adding bootstrap nodes ENRs: ${this.bootstrapNodes.join(', ')}`);
       try {
         this.bootstrapNodes.forEach(enr => {
           this.discv5.addEnr(enr);

package/src/{service → services}/dummy_service.ts

@@ -1,4 +1,4 @@
-import type { BlockAttestation, BlockProposal, Gossipable, TxHash } from '@aztec/circuit-types';
+import type { BlockAttestation, BlockProposal, Gossipable, PeerInfo, TxHash } from '@aztec/circuit-types';
 
 import type { PeerId } from '@libp2p/interface';
 import EventEmitter from 'events';
@@ -10,6 +10,11 @@ import { type P2PService, type PeerDiscoveryService, PeerDiscoveryState } from '
  * A dummy implementation of the P2P Service.
  */
 export class DummyP2PService implements P2PService {
+  /** Returns an empty array for peers. */
+  getPeers(): PeerInfo[] {
+    return [];
+  }
+
   /**
    * Starts the dummy implementation.
    * @returns A resolved promise.

package/src/{service → services}/encoding.ts

@@ -49,13 +49,31 @@ export function getMsgIdFn(message: Message) {
   return sha256(Buffer.concat(vec)).subarray(0, 20);
 }
 
+/**
+ * Snappy transform for libp2p gossipsub
+ */
 export class SnappyTransform implements DataTransform {
+  // Topic string included to satisfy DataTransform interface
   inboundTransform(_topicStr: string, data: Uint8Array): Uint8Array {
-    const uncompressed = Buffer.from(uncompressSync(Buffer.from(data), { asBuffer: true }));
-    return new Uint8Array(uncompressed);
+    return this.inboundTransformNoTopic(Buffer.from(data));
+  }
+
+  public inboundTransformNoTopic(data: Buffer): Buffer {
+    if (data.length === 0) {
+      return data;
+    }
+    return Buffer.from(uncompressSync(data, { asBuffer: true }));
   }
 
+  // Topic string included to satisfy DataTransform interface
   outboundTransform(_topicStr: string, data: Uint8Array): Uint8Array {
-    return new Uint8Array(compressSync(Buffer.from(data)));
+    return this.outboundTransformNoTopic(Buffer.from(data));
+  }
+
+  public outboundTransformNoTopic(data: Buffer): Buffer {
+    if (data.length === 0) {
+      return data;
+    }
+    return Buffer.from(compressSync(data));
   }
 }

package/src/services/index.ts

@@ -0,0 +1,2 @@
+export * from './service.js';
+export * from './libp2p/libp2p_service.js';