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

package/src/services/reqresp/interface.ts

@@ -1,19 +1,25 @@
 import { Fr } from '@aztec/foundation/fields';
 import { L2Block } from '@aztec/stdlib/block';
-import { Tx, TxHash } from '@aztec/stdlib/tx';
+import { TxArray, TxHashArray } from '@aztec/stdlib/tx';
 
 import type { PeerId } from '@libp2p/interface';
 
+import type { P2PReqRespConfig } from './config.js';
+import { AuthRequest, AuthResponse } from './protocols/auth.js';
+import { BlockTxsRequest, BlockTxsResponse } from './protocols/block_txs/block_txs_reqresp.js';
+import { StatusMessage } from './protocols/status.js';
 import type { ReqRespStatus } from './status.js';
 
 /*
  * Request Response Sub Protocols
  */
-export const PING_PROTOCOL = '/aztec/req/ping/0.1.0';
-export const STATUS_PROTOCOL = '/aztec/req/status/0.1.0';
-export const GOODBYE_PROTOCOL = '/aztec/req/goodbye/0.1.0';
-export const TX_REQ_PROTOCOL = '/aztec/req/tx/0.1.0';
-export const BLOCK_REQ_PROTOCOL = '/aztec/req/block/0.1.0';
+export const PING_PROTOCOL = '/aztec/req/ping/1.0.0';
+export const STATUS_PROTOCOL = '/aztec/req/status/1.0.0';
+export const GOODBYE_PROTOCOL = '/aztec/req/goodbye/1.0.0';
+export const TX_REQ_PROTOCOL = '/aztec/req/tx/1.0.0';
+export const BLOCK_REQ_PROTOCOL = '/aztec/req/block/1.0.0';
+export const AUTH_PROTOCOL = '/aztec/req/auth/1.0.0';
+export const BLOCK_TXS_REQ_PROTOCOL = '/aztec/req/block_txs/1.0.0';
 
 export enum ReqRespSubProtocol {
   PING = PING_PROTOCOL,
@@ -21,6 +27,8 @@ export enum ReqRespSubProtocol {
   GOODBYE = GOODBYE_PROTOCOL,
   TX = TX_REQ_PROTOCOL,
   BLOCK = BLOCK_REQ_PROTOCOL,
+  AUTH = AUTH_PROTOCOL,
+  BLOCK_TXS = BLOCK_TXS_REQ_PROTOCOL,
 }
 
 /**
@@ -36,12 +44,12 @@ export type ReqRespSubProtocolRateLimits = Record<ReqRespSubProtocol, ProtocolRa
 
 /**
  * The response from the ReqResp protocol
- * Consists of a status (Error code) and data
+ * Consists of a status
+ * And, optionally, a data buffer (in case status is SUCCESS)
  */
-export interface ReqRespResponse {
-  status: ReqRespStatus;
-  data: Buffer;
-}
+export type ReqRespResponse =
+  | { status: ReqRespStatus.SUCCESS; data: Buffer }
+  | { status: Exclude<ReqRespStatus, ReqRespStatus.SUCCESS> };
 
 /**
  * A rate limit quota
@@ -91,33 +99,27 @@ export const DEFAULT_SUB_PROTOCOL_VALIDATORS: ReqRespSubProtocolValidators = {
   [ReqRespSubProtocol.TX]: noopValidator,
   [ReqRespSubProtocol.GOODBYE]: noopValidator,
   [ReqRespSubProtocol.BLOCK]: noopValidator,
+  [ReqRespSubProtocol.AUTH]: noopValidator,
+  [ReqRespSubProtocol.BLOCK_TXS]: noopValidator,
 };
 
+/*
+ * Helper class to sub-protocol validation error*/
+export class ValidationError extends Error {
+  constructor(message: string) {
+    super(message);
+  }
+}
+
 /**
  * Sub protocol map determines the request and response types for each
  * Req Resp protocol
  */
 export type SubProtocolMap = {
-  [S in ReqRespSubProtocol]: RequestResponsePair<any, any>;
-};
-
-/**
- * Default handler for unimplemented sub protocols, this SHOULD be overwritten
- * by the service, but is provided as a fallback
- */
-const defaultHandler = (_msg: any): Promise<Buffer> => {
-  return Promise.resolve(Buffer.from('unimplemented'));
-};
-
-/**
- * Default sub protocol handlers - this SHOULD be overwritten by the service,
- */
-export const DEFAULT_SUB_PROTOCOL_HANDLERS: ReqRespSubProtocolHandlers = {
-  [ReqRespSubProtocol.PING]: defaultHandler,
-  [ReqRespSubProtocol.STATUS]: defaultHandler,
-  [ReqRespSubProtocol.TX]: defaultHandler,
-  [ReqRespSubProtocol.GOODBYE]: defaultHandler,
-  [ReqRespSubProtocol.BLOCK]: defaultHandler,
+  [S in ReqRespSubProtocol]: RequestResponsePair<
+    InstanceType<(typeof subProtocolMap)[S]['request']>,
+    InstanceType<(typeof subProtocolMap)[S]['response']>
+  >;
 };
 
 /**
@@ -138,6 +140,22 @@ interface RequestResponsePair<Req extends { toBuffer(): Buffer }, Res> {
   };
 }
 
+/*
+ * Small helper function which parses buffer into specific response type
+ * It is needed to make TypeScript happy, as it cannot infer the type from the buffer
+ *
+ * @param proto - The sub protocol to parse the response for
+ * @param buffer - The buffer to parse
+ *
+ * @returns - The parsed response object
+ * */
+export function responseFromBuffer<P extends ReqRespSubProtocol>(
+  proto: P,
+  buffer: Buffer,
+): InstanceType<(typeof subProtocolMap)[P]['response']> {
+  return subProtocolMap[proto].response.fromBuffer(buffer) as InstanceType<(typeof subProtocolMap)[P]['response']>;
+}
+
 /**
  * RequestableBuffer is a wrapper around a buffer that allows it to be
  * used in generic request response protocols
@@ -161,18 +179,18 @@ export class RequestableBuffer {
  * This defines the request and response types for each sub protocol, used primarily
  * as a type rather than an object
  */
-export const subProtocolMap: SubProtocolMap = {
+export const subProtocolMap = {
   [ReqRespSubProtocol.PING]: {
     request: RequestableBuffer,
     response: RequestableBuffer,
   },
   [ReqRespSubProtocol.STATUS]: {
-    request: RequestableBuffer,
-    response: RequestableBuffer,
+    request: StatusMessage,
+    response: StatusMessage,
   },
   [ReqRespSubProtocol.TX]: {
-    request: TxHash,
-    response: Tx,
+    request: TxHashArray,
+    response: TxArray,
   },
   [ReqRespSubProtocol.GOODBYE]: {
     request: RequestableBuffer,
@@ -182,4 +200,41 @@ export const subProtocolMap: SubProtocolMap = {
     request: Fr, // block number
     response: L2Block,
   },
+  [ReqRespSubProtocol.AUTH]: {
+    request: AuthRequest,
+    response: AuthResponse,
+  },
+  [ReqRespSubProtocol.BLOCK_TXS]: {
+    request: BlockTxsRequest,
+    response: BlockTxsResponse,
+  },
 };
+
+export interface ReqRespInterface {
+  start(
+    subProtocolHandlers: Partial<ReqRespSubProtocolHandlers>,
+    subProtocolValidators: ReqRespSubProtocolValidators,
+  ): Promise<void>;
+  addSubProtocol(
+    subProtocol: ReqRespSubProtocol,
+    handler: ReqRespSubProtocolHandler,
+    validator?: ReqRespSubProtocolValidators[ReqRespSubProtocol],
+  ): Promise<void>;
+  stop(): Promise<void>;
+  sendBatchRequest<SubProtocol extends ReqRespSubProtocol>(
+    subProtocol: SubProtocol,
+    requests: InstanceType<SubProtocolMap[SubProtocol]['request']>[],
+    pinnedPeer: PeerId | undefined,
+    timeoutMs?: number,
+    maxPeers?: number,
+    maxRetryAttempts?: number,
+  ): Promise<InstanceType<SubProtocolMap[SubProtocol]['response']>[]>;
+  sendRequestToPeer(
+    peerId: PeerId,
+    subProtocol: ReqRespSubProtocol,
+    payload: Buffer,
+    dialTimeout?: number,
+  ): Promise<ReqRespResponse>;
+
+  updateConfig(config: Partial<P2PReqRespConfig>): void;
+}

package/src/services/reqresp/metrics.ts

@@ -11,7 +11,10 @@ export class ReqRespMetrics {
   private readonly failedOutboundRequests: UpDownCounter;
   private readonly failedInboundRequests: UpDownCounter;
 
-  constructor(readonly telemetryClient: TelemetryClient, name = 'ReqResp') {
+  constructor(
+    readonly telemetryClient: TelemetryClient,
+    name = 'ReqResp',
+  ) {
     this.tracer = telemetryClient.getTracer(name);
 
     const meter = telemetryClient.getMeter(name);

package/src/services/reqresp/protocols/auth.ts

@@ -0,0 +1,83 @@
+import { Buffer32 } from '@aztec/foundation/buffer';
+import { keccak256 } from '@aztec/foundation/crypto';
+import { Signature } from '@aztec/foundation/eth-signature';
+import { Fr } from '@aztec/foundation/fields';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
+
+import { StatusMessage } from './status.js';
+
+export const VALIDATOR_AUTH_DOMAIN_SEPARATOR = 'Aztec Validator Challenge:';
+export const VALIDATOR_AUTH_FULL_CHALLENGE_ENCODED_LENGTH =
+  VALIDATOR_AUTH_DOMAIN_SEPARATOR.length + Fr.random().toString().length;
+
+/*
+ * P2P Auth Message
+ * Superset of the StatusMessage, used to establish a handshake between peers and authenticate them.
+ */
+export class AuthRequest {
+  constructor(
+    readonly status: StatusMessage,
+    readonly challenge: Fr,
+  ) {}
+
+  /**
+   * Deserializes the AuthRequest object from a Buffer.
+   * @param buffer - Buffer or BufferReader object to deserialize.
+   * @returns An instance of StatusMessage.
+   */
+  static fromBuffer(buffer: Buffer | BufferReader): AuthRequest {
+    const reader = BufferReader.asReader(buffer);
+    return new AuthRequest(
+      StatusMessage.fromBuffer(reader), // Deserialize StatusMessage
+      Fr.fromBuffer(reader), // challenge
+    );
+  }
+
+  /**
+   * Serializes the AuthRequest object into a Buffer.
+   * @returns Buffer representation of the StatusMessage object.
+   */
+  toBuffer() {
+    return serializeToBuffer([this.status, this.challenge]);
+  }
+
+  getPayloadToSign(): Buffer32 {
+    const fullChallenge = VALIDATOR_AUTH_DOMAIN_SEPARATOR + this.challenge.toString();
+    return Buffer32.fromBuffer(keccak256(Buffer.from(fullChallenge, 'utf-8')));
+  }
+
+  static random(): AuthRequest {
+    return new AuthRequest(StatusMessage.random(), Fr.random());
+  }
+}
+
+export class AuthResponse {
+  constructor(
+    readonly status: StatusMessage,
+    readonly signature: Signature,
+  ) {}
+  /**
+   * Deserializes the AuthResponse object from a Buffer.
+   * @param buffer - Buffer or BufferReader object to deserialize.
+   * @returns An instance of StatusMessage.
+   */
+  static fromBuffer(buffer: Buffer | BufferReader): AuthResponse {
+    const reader = BufferReader.asReader(buffer);
+    return new AuthResponse(
+      StatusMessage.fromBuffer(reader), // Deserialize StatusMessage
+      Signature.fromBuffer(reader), // response
+    );
+  }
+
+  /**
+   * Serializes the AuthRequest object into a Buffer.
+   * @returns Buffer representation of the StatusMessage object.
+   */
+  toBuffer() {
+    return serializeToBuffer([this.status, this.signature]);
+  }
+
+  static random(): AuthResponse {
+    return new AuthResponse(StatusMessage.random(), Signature.random());
+  }
+}

package/src/services/reqresp/protocols/block.ts

@@ -4,12 +4,33 @@ import type { L2BlockSource } from '@aztec/stdlib/block';
 import type { PeerId } from '@libp2p/interface';
 
 import type { ReqRespSubProtocolHandler } from '../interface.js';
+import { ReqRespStatus, ReqRespStatusError } from '../status.js';
 
+/**
+ * Handler for L2 Block requests
+ * @param l2BlockSource - source for L2 blocks
+ * @returns the Block request handler
+ * */
 export function reqRespBlockHandler(l2BlockSource: L2BlockSource): ReqRespSubProtocolHandler {
+  /**
+   * @param peerId - the peer ID of the requester
+   * @param msg - the block request message, which is expected to contain valid block number as a Buffer
+   * @returns a Buffer containing the requested block data, or an empty Buffer if the block is not found
+   * @throws  ReqRespStatusError if the input msg is not a valid block number
+   * */
   return async (_peerId: PeerId, msg: Buffer) => {
-    const blockNumber = Fr.fromBuffer(msg);
+    let blockNumber: Fr;
+    try {
+      blockNumber = Fr.fromBuffer(msg);
+    } catch (err: any) {
+      throw new ReqRespStatusError(ReqRespStatus.BADLY_FORMED_REQUEST, { cause: err });
+    }
 
-    const foundBlock = await l2BlockSource.getBlock(Number(blockNumber));
-    return foundBlock ? foundBlock.toBuffer() : Buffer.alloc(0);
+    try {
+      const foundBlock = await l2BlockSource.getBlock(Number(blockNumber));
+      return foundBlock ? foundBlock.toBuffer() : Buffer.alloc(0);
+    } catch (err: any) {
+      throw new ReqRespStatusError(ReqRespStatus.INTERNAL_ERROR, { cause: err });
+    }
   };
 }

package/src/services/reqresp/protocols/block_txs/bitvector.ts

@@ -0,0 +1,90 @@
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
+
+/**
+ * BitVector helper class for representing and serializing bit vectors
+ */
+export class BitVector {
+  private buffer: Buffer;
+  private length: number;
+
+  constructor(buffer: Buffer, length: number) {
+    this.buffer = buffer;
+    this.length = length;
+  }
+
+  /*
+   * Creates new BitVector instance
+   * @param length - Length of the bit vector
+   * @param indices - Array of indices to set to 1 in the bit vector
+   *
+   * @returns A new BitVector instance with specified length and set indices
+   * */
+  static init(length: number, indices: number[]): BitVector {
+    if (indices.length > length) {
+      throw new Error('Indices length exceeds specified length');
+    }
+
+    const buffer = Buffer.alloc(BitVector.byteLength(length));
+
+    indices.forEach(idx => {
+      const invalidIndex = idx < 0 || idx >= length;
+      if (invalidIndex) {
+        throw new Error(`Index ${idx} is out of bounds for BitVector of length ${length}`);
+      }
+
+      const byteIndex = Math.floor(idx / 8);
+      const bitIndex = idx % 8;
+      buffer[byteIndex] |= 1 << bitIndex;
+    });
+
+    return new BitVector(buffer, length);
+  }
+
+  getLength(): number {
+    return this.length;
+  }
+
+  /*
+   * Checks if element at index is set to true
+   *
+   * @param index - Index of the bit to check
+   *
+   * @returns True if the bit at index is set, false otherwise
+   * */
+  isSet(index: number): boolean {
+    return index >= 0 && index < this.length && !!(this.buffer[Math.floor(index / 8)] & (1 << index % 8));
+  }
+
+  /**
+   * Returns all indices which are set to true
+   * */
+  getTrueIndices(): number[] {
+    return Array.from({ length: this.length }, (_, i) => i).filter(i => this.isSet(i));
+  }
+
+  /**
+   * Serializes the BitVector object into a Buffer
+   *
+   * @returns Buffer representation of the BitVector object
+   * */
+  toBuffer(): Buffer {
+    return serializeToBuffer([this.length, this.buffer]);
+  }
+
+  /**
+   * Deserializes buffer into new BitVector
+   *
+   * @returns A new BitVector instance
+   * */
+  static fromBuffer(buffer: Buffer | BufferReader): BitVector {
+    const reader = BufferReader.asReader(buffer);
+    const length = reader.readNumber();
+
+    const bitBuffer = reader.readBytes(BitVector.byteLength(length));
+    return new BitVector(bitBuffer, length);
+  }
+
+  static byteLength(length: number) {
+    return Math.ceil(length / 8);
+  }
+}

package/src/services/reqresp/protocols/block_txs/block_txs_handler.ts

@@ -0,0 +1,53 @@
+import { TxArray } from '@aztec/stdlib/tx';
+
+import type { PeerId } from '@libp2p/interface';
+
+import type { AttestationPool } from '../../../../mem_pools/attestation_pool/attestation_pool.js';
+import type { TxPool } from '../../../../mem_pools/index.js';
+import type { ReqRespSubProtocolHandler } from '../../interface.js';
+import { ReqRespStatus, ReqRespStatusError } from '../../status.js';
+import { BitVector } from './bitvector.js';
+import { BlockTxsRequest, BlockTxsResponse } from './block_txs_reqresp.js';
+
+/**
+ * Handler for block txs requests
+ * @param attestationPool - the attestation pool to check for block proposals
+ * @param mempools - the mempools containing the tx pool
+ * @returns the BlockTxs request handler
+ */
+export function reqRespBlockTxsHandler(attestationPool: AttestationPool, txPool: TxPool): ReqRespSubProtocolHandler {
+  /**
+   * Handler for block txs requests
+   * @param msg - the block txs request message
+   * @returns the block txs response message
+   * @throws if msg is not a valid block txs request
+   */
+  return async (_peerId: PeerId, msg: Buffer) => {
+    let request: BlockTxsRequest;
+    try {
+      request = BlockTxsRequest.fromBuffer(msg);
+    } catch (err: any) {
+      throw new ReqRespStatusError(ReqRespStatus.BADLY_FORMED_REQUEST, { cause: err });
+    }
+
+    const blockProposal = await attestationPool.getBlockProposal(request.blockHash.toString());
+
+    if (!blockProposal) {
+      throw new ReqRespStatusError(ReqRespStatus.NOT_FOUND);
+    }
+
+    const txsAvailableInPool = await txPool.hasTxs(blockProposal.txHashes);
+    //Map txs in the pool to their indices in the block proposal
+    const availableIndices = txsAvailableInPool.map((hasTx, idx) => (hasTx ? idx : -1)).filter(idx => idx !== -1);
+    const responseBitVector = BitVector.init(blockProposal.txHashes.length, availableIndices);
+
+    const requestedIndices = new Set(request.txIndices.getTrueIndices());
+    const requestedTxsHashes = blockProposal.txHashes.filter((_, idx) => requestedIndices.has(idx));
+
+    const responseTxs = (await txPool.getTxsByHash(requestedTxsHashes)).filter(tx => !!tx);
+
+    const response = new BlockTxsResponse(request.blockHash, new TxArray(...responseTxs), responseBitVector);
+
+    return response.toBuffer();
+  };
+}

package/src/services/reqresp/protocols/block_txs/block_txs_reqresp.ts

@@ -0,0 +1,79 @@
+import { Fr } from '@aztec/foundation/fields';
+import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
+import { TxArray } from '@aztec/stdlib/tx';
+
+import { BitVector } from './bitvector.js';
+
+/**
+ * Request message for requesting specific transactions from a block
+ */
+export class BlockTxsRequest {
+  constructor(
+    readonly blockHash: Fr, // 32 byte hash of the proposed block header
+    // BitVector indicating which txs from the proposal we are requesting
+    // 1 means we want the tx, 0 means we don't
+    readonly txIndices: BitVector,
+  ) {}
+
+  /**
+   * Deserializes the BlockTxRequest object from a Buffer
+   * @param buffer - Buffer or BufferReader object to deserialize
+   * @returns An instance of BlockTxRequest
+   */
+  static fromBuffer(buffer: Buffer | BufferReader): BlockTxsRequest {
+    const reader = BufferReader.asReader(buffer);
+    const blockHash = Fr.fromBuffer(reader);
+    const txIndices = BitVector.fromBuffer(reader);
+
+    return new BlockTxsRequest(blockHash, txIndices);
+  }
+
+  /**
+   * Serializes the BlockTxRequest object into a Buffer
+   * @returns Buffer representation of the BlockTxRequest object
+   */
+  toBuffer(): Buffer {
+    return serializeToBuffer([this.blockHash, this.txIndices.toBuffer()]);
+  }
+}
+
+/**
+ * Response message containing requested transactions from a block
+ */
+export class BlockTxsResponse {
+  constructor(
+    readonly blockHash: Fr,
+    readonly txs: TxArray, // List of transactions we requested and peer has
+    // BitVector indicating which txs from the proposal are available at the peer
+    // 1 means the tx is available, 0 means it is not
+    readonly txIndices: BitVector,
+  ) {}
+
+  /**
+   * Deserializes the BlockTxResponse object from a Buffer
+   * @param buffer - Buffer or BufferReader object to deserialize
+   * @returns An instance of BlockTxResponse
+   */
+  static fromBuffer(buffer: Buffer | BufferReader): BlockTxsResponse {
+    const reader = BufferReader.asReader(buffer);
+    const blockHash = Fr.fromBuffer(reader);
+    const txs = TxArray.fromBuffer(reader);
+    const txIndices = BitVector.fromBuffer(reader);
+
+    return new BlockTxsResponse(blockHash, txs, txIndices);
+  }
+
+  /**
+   * Serializes the BlockTxResponse object into a Buffer
+   * @dev: In current implementation, txIndices is serialized as Buffer of unknown length,
+   * thus we serialize it last
+   * @returns Buffer representation of the BlockTxResponse object
+   */
+  toBuffer(): Buffer {
+    return serializeToBuffer([this.blockHash, this.txs.toBuffer(), this.txIndices.toBuffer()]);
+  }
+
+  static empty(): BlockTxsResponse {
+    return new BlockTxsResponse(Fr.ZERO, new TxArray(), BitVector.init(0, []));
+  }
+}

package/src/services/reqresp/protocols/block_txs/index.ts

@@ -0,0 +1,3 @@
+export * from './block_txs_handler.js';
+export * from './bitvector.js';
+export * from './block_txs_reqresp.js';

package/src/services/reqresp/protocols/goodbye.ts

@@ -2,7 +2,7 @@ import { createLogger } from '@aztec/foundation/log';
 
 import type { PeerId } from '@libp2p/interface';
 
-import type { PeerManager } from '../../peer-manager/peer_manager.js';
+import type { PeerManagerInterface } from '../../peer-manager/interface.js';
 import { ReqRespSubProtocol, type ReqRespSubProtocolHandler } from '../interface.js';
 import type { ReqResp } from '../reqresp.js';
 
@@ -34,7 +34,7 @@ export function decodeGoodbyeReason(buffer: Buffer): GoodByeReason {
       throw new Error('Invalid goodbye reason buffer length');
     }
     return buffer[0] as GoodByeReason;
-  } catch (error) {
+  } catch {
     return GoodByeReason.UNKNOWN;
   }
 }
@@ -89,13 +89,15 @@ export class GoodbyeProtocolHandler {
  * @param peerManager - The peer manager.
  * @returns A resolved promise with the goodbye response.
  */
-export function reqGoodbyeHandler(peerManager: PeerManager): ReqRespSubProtocolHandler {
-  return (peerId: PeerId, _msg: Buffer) => {
-    const reason = decodeGoodbyeReason(_msg);
+export function reqGoodbyeHandler(peerManager: PeerManagerInterface): ReqRespSubProtocolHandler {
+  return (peerId: PeerId, msg: Buffer) => {
+    const reason = decodeGoodbyeReason(msg);
 
     peerManager.goodbyeReceived(peerId, reason);
 
-    // Return a buffer of length 1 as an acknowledgement: this is allowed to fail
-    return Promise.resolve(Buffer.from([0x0]));
+    // NOTE: In the current implementation this won't be sent to peer,
+    // as the connection to peer has been already closed by peerManager.goodbyeReceived
+    // We have this just to satisfy interface
+    return Promise.resolve(Buffer.alloc(0));
   };
 }

package/src/services/reqresp/protocols/index.ts

@@ -6,3 +6,5 @@ export * from './status.js';
 export * from './tx.js';
 export * from './goodbye.js';
 export * from './block.js';
+export * from './auth.js';
+export * from './block_txs/index.js';