feat: add insturmentation to attestation and epoch quote mem pools (#9055)

Author: Maddiaa0

yarn-project/circuit-types/src/p2p/block_attestation.test.ts

@@ -5,23 +5,27 @@ import { BlockAttestation } from './block_attestation.js';
 import { makeBlockAttestation } from './mocks.js';
 
 describe('Block Attestation serialization / deserialization', () => {
+  const checkEquivalence = (serialized: BlockAttestation, deserialized: BlockAttestation) => {
+    expect(deserialized.getSize()).toEqual(serialized.getSize());
+    expect(deserialized).toEqual(serialized);
+  };
+
   it('Should serialize / deserialize', () => {
     const attestation = makeBlockAttestation();
 
     const serialized = attestation.toBuffer();
     const deserialized = BlockAttestation.fromBuffer(serialized);
-
-    expect(deserialized).toEqual(attestation);
+    checkEquivalence(attestation, deserialized);
   });
 
   it('Should serialize / deserialize + recover sender', () => {
     const account = Secp256k1Signer.random();
 
-    const proposal = makeBlockAttestation(account);
-    const serialized = proposal.toBuffer();
+    const attestation = makeBlockAttestation(account);
+    const serialized = attestation.toBuffer();
     const deserialized = BlockAttestation.fromBuffer(serialized);
 
-    expect(deserialized).toEqual(proposal);
+    checkEquivalence(attestation, deserialized);
 
     // Recover signature
     const sender = deserialized.getSender();

yarn-project/circuit-types/src/p2p/block_attestation.ts

@@ -72,4 +72,8 @@ export class BlockAttestation extends Gossipable {
   static empty(): BlockAttestation {
     return new BlockAttestation(ConsensusPayload.empty(), Signature.empty());
   }
+
+  getSize(): number {
+    return this.payload.getSize() + this.signature.getSize();
+  }
 }

yarn-project/circuit-types/src/p2p/block_proposal.test.ts

@@ -5,13 +5,17 @@ import { BlockProposal } from './block_proposal.js';
 import { makeBlockProposal } from './mocks.js';
 
 describe('Block Proposal serialization / deserialization', () => {
+  const checkEquivalence = (serialized: BlockProposal, deserialized: BlockProposal) => {
+    expect(deserialized.getSize()).toEqual(serialized.getSize());
+    expect(deserialized).toEqual(serialized);
+  };
+
   it('Should serialize / deserialize', () => {
     const proposal = makeBlockProposal();
 
     const serialized = proposal.toBuffer();
     const deserialized = BlockProposal.fromBuffer(serialized);
-
-    expect(deserialized).toEqual(proposal);
+    checkEquivalence(proposal, deserialized);
   });
 
   it('Should serialize / deserialize + recover sender', () => {
@@ -21,7 +25,7 @@ describe('Block Proposal serialization / deserialization', () => {
     const serialized = proposal.toBuffer();
     const deserialized = BlockProposal.fromBuffer(serialized);
 
-    expect(deserialized).toEqual(proposal);
+    checkEquivalence(proposal, deserialized);
 
     // Recover signature
     const sender = deserialized.getSender();

yarn-project/circuit-types/src/p2p/block_proposal.ts

@@ -75,4 +75,8 @@ export class BlockProposal extends Gossipable {
     const reader = BufferReader.asReader(buf);
     return new BlockProposal(reader.readObject(ConsensusPayload), reader.readObject(Signature));
   }
+
+  getSize(): number {
+    return this.payload.getSize() + this.signature.getSize();
+  }
 }

yarn-project/circuit-types/src/p2p/consensus_payload.ts

@@ -9,6 +9,8 @@ import { TxHash } from '../tx/tx_hash.js';
 import { type Signable } from './signature_utils.js';
 
 export class ConsensusPayload implements Signable {
+  private size: number | undefined;
+
   constructor(
     /** The block header the attestation is made over */
     public readonly header: Header,
@@ -31,7 +33,9 @@ export class ConsensusPayload implements Signable {
   }
 
   toBuffer(): Buffer {
-    return serializeToBuffer([this.header, this.archive, this.txHashes.length, this.txHashes]);
+    const buffer = serializeToBuffer([this.header, this.archive, this.txHashes.length, this.txHashes]);
+    this.size = buffer.length;
+    return buffer;
   }
 
   static fromBuffer(buf: Buffer | BufferReader): ConsensusPayload {
@@ -50,4 +54,17 @@ export class ConsensusPayload implements Signable {
   static empty(): ConsensusPayload {
     return new ConsensusPayload(Header.empty(), Fr.ZERO, []);
   }
+
+  /**
+   * Get the size of the consensus payload in bytes.
+   * @returns The size of the consensus payload.
+   */
+  getSize(): number {
+    // We cache size to avoid recalculating it
+    if (this.size) {
+      return this.size;
+    }
+    this.size = this.toBuffer().length;
+    return this.size;
+  }
 }

yarn-project/circuit-types/src/p2p/gossipable.ts

@@ -23,4 +23,11 @@ export abstract class Gossipable {
    * - Serialization method
    */
   abstract toBuffer(): Buffer;
+
+  /**
+   * Get the size of the gossipable object.
+   *
+   * This is used for metrics recording.
+   */
+  abstract getSize(): number;
 }

yarn-project/circuit-types/src/prover_coordination/epoch_proof_quote.test.ts

@@ -19,11 +19,18 @@ describe('epoch proof quote', () => {
     quote = new EpochProofQuote(payload, Signature.random());
   });
 
+  const checkEquivalence = (serialized: EpochProofQuote, deserialized: EpochProofQuote) => {
+    expect(deserialized.getSize()).toEqual(serialized.getSize());
+    expect(deserialized).toEqual(serialized);
+  };
+
   it('should serialize and deserialize from buffer', () => {
-    expect(EpochProofQuote.fromBuffer(quote.toBuffer())).toEqual(quote);
+    const deserialised = EpochProofQuote.fromBuffer(quote.toBuffer());
+    checkEquivalence(quote, deserialised);
   });
 
   it('should serialize and deserialize from JSON', () => {
-    expect(EpochProofQuote.fromJSON(quote.toJSON())).toEqual(quote);
+    const deserialised = EpochProofQuote.fromJSON(quote.toJSON());
+    checkEquivalence(quote, deserialised);
   });
 });

yarn-project/circuit-types/src/prover_coordination/epoch_proof_quote.ts

@@ -69,4 +69,12 @@ export class EpochProofQuote extends Gossipable {
       signature: this.signature.toViemSignature(),
     };
   }
+
+  /**
+   * Get the size of the epoch proof quote in bytes.
+   * @returns The size of the epoch proof quote in bytes.
+   */
+  getSize(): number {
+    return this.payload.getSize() + this.signature.getSize();
+  }
 }

yarn-project/circuit-types/src/prover_coordination/epoch_proof_quote_payload.ts

@@ -5,6 +5,10 @@ import { type FieldsOf } from '@aztec/foundation/types';
 import { inspect } from 'util';
 
 export class EpochProofQuotePayload {
+  // Cached values
+  private asBuffer: Buffer | undefined;
+  private size: number | undefined;
+
   constructor(
     public readonly epochToProve: bigint,
     public readonly validUntilSlot: bigint,
@@ -24,7 +28,13 @@ export class EpochProofQuotePayload {
   }
 
   toBuffer(): Buffer {
-    return serializeToBuffer(...EpochProofQuotePayload.getFields(this));
+    // We cache the buffer to avoid recalculating it
+    if (this.asBuffer) {
+      return this.asBuffer;
+    }
+    this.asBuffer = serializeToBuffer(...EpochProofQuotePayload.getFields(this));
+    this.size = this.asBuffer.length;
+    return this.asBuffer;
   }
 
   static fromBuffer(buf: Buffer | BufferReader): EpochProofQuotePayload {
@@ -84,6 +94,16 @@ export class EpochProofQuotePayload {
     };
   }
 
+  getSize(): number {
+    // We cache size to avoid recalculating it
+    if (this.size) {
+      return this.size;
+    }
+    // Size is cached when calling toBuffer
+    this.toBuffer();
+    return this.size!;
+  }
+
   [inspect.custom](): string {
     return `EpochProofQuotePayload { epochToProve: ${this.epochToProve}, validUntilSlot: ${this.validUntilSlot}, bondAmount: ${this.bondAmount}, prover: ${this.prover}, basisPointFee: ${this.basisPointFee} }`;
   }

yarn-project/foundation/src/eth-signature/eth_signature.test.ts

@@ -20,16 +20,21 @@ describe('eth signature', () => {
     signature = signer.sign(message);
   });
 
+  const checkEquivalence = (serialized: Signature, deserialized: Signature) => {
+    expect(deserialized.getSize()).toEqual(serialized.getSize());
+    expect(deserialized).toEqual(serialized);
+  };
+
   it('should serialize / deserialize to buffer', () => {
     const serialized = signature.toBuffer();
     const deserialized = Signature.fromBuffer(serialized);
-    expect(deserialized).toEqual(signature);
+    checkEquivalence(signature, deserialized);
   });
 
   it('should serialize / deserialize real signature to hex string', () => {
     const serialized = signature.to0xString();
     const deserialized = Signature.from0xString(serialized);
-    expect(deserialized).toEqual(signature);
+    checkEquivalence(signature, deserialized);
   });
 
   it('should recover signer from signature', () => {
@@ -41,13 +46,13 @@ describe('eth signature', () => {
     const signature = new Signature(Buffer32.random(), Buffer32.random(), 1, false);
     const serialized = signature.to0xString();
     const deserialized = Signature.from0xString(serialized);
-    expect(deserialized).toEqual(signature);
+    checkEquivalence(signature, deserialized);
   });
 
   it('should serialize / deserialize to hex string with 2-digit v', () => {
     const signature = new Signature(Buffer32.random(), Buffer32.random(), 26, false);
     const serialized = signature.to0xString();
     const deserialized = Signature.from0xString(serialized);
-    expect(deserialized).toEqual(signature);
+    checkEquivalence(signature, deserialized);
   });
 });