@aztec/stdlib 0.0.0-test.1 → 0.0.1-commit.017a351

package/src/logs/log_cursor.ts

@@ -0,0 +1,110 @@
+import { BlockNumber, BlockNumberSchema } from '@aztec/foundation/branded-types';
+import { BufferReader, numToUInt32BE } from '@aztec/foundation/serialize';
+
+import { z } from 'zod';
+
+import { schemas } from '../schemas/schemas.js';
+import type { LogResultBase } from './log_result.js';
+
+/**
+ * Cursor identifying a position in a tag's ordered log stream. Used as `afterLog` on `TagQuery` to resume
+ * pagination strictly after a previously-seen log.
+ *
+ * `(blockNumber, txIndexWithinBlock, logIndexWithinTx)` is sufficient to uniquely identify a position
+ * and matches the composite-key ordering of the archiver's log index, so the cursor maps directly to a
+ * key without a tx-hash lookup. All three fields are always present on {@link LogResult}, so a cursor is
+ * constructible from any returned log.
+ */
+export class LogCursor {
+  constructor(
+    /** The block the cursor points to. */
+    public readonly blockNumber: BlockNumber,
+    /** The tx index within the block the cursor points to. */
+    public readonly txIndexWithinBlock: number,
+    /** The log index within the tx the cursor points to. */
+    public readonly logIndexWithinTx: number,
+  ) {}
+
+  static get schema() {
+    return z
+      .object({
+        blockNumber: BlockNumberSchema,
+        txIndexWithinBlock: schemas.Integer,
+        logIndexWithinTx: schemas.Integer,
+      })
+      .transform(
+        ({ blockNumber, txIndexWithinBlock, logIndexWithinTx }) =>
+          new LogCursor(blockNumber, txIndexWithinBlock, logIndexWithinTx),
+      );
+  }
+
+  /** Builds a cursor that points at the given log. Pagination resumes strictly after this position. */
+  static fromLog(log: Pick<LogResultBase, 'blockNumber' | 'txIndexWithinBlock' | 'logIndexWithinTx'>): LogCursor {
+    return new LogCursor(log.blockNumber, log.txIndexWithinBlock, log.logIndexWithinTx);
+  }
+
+  static random(): LogCursor {
+    return new LogCursor(
+      BlockNumber(Math.floor(Math.random() * 100000) + 1),
+      Math.floor(Math.random() * 100),
+      Math.floor(Math.random() * 100),
+    );
+  }
+
+  toBuffer(): Buffer {
+    return Buffer.concat([
+      numToUInt32BE(this.blockNumber),
+      numToUInt32BE(this.txIndexWithinBlock),
+      numToUInt32BE(this.logIndexWithinTx),
+    ]);
+  }
+
+  static fromBuffer(buffer: Buffer | BufferReader): LogCursor {
+    const reader = BufferReader.asReader(buffer);
+    const blockNumber = BlockNumber(reader.readNumber());
+    const txIndexWithinBlock = reader.readNumber();
+    const logIndexWithinTx = reader.readNumber();
+    return new LogCursor(blockNumber, txIndexWithinBlock, logIndexWithinTx);
+  }
+
+  equals(other: LogCursor): boolean {
+    return (
+      this.blockNumber === other.blockNumber &&
+      this.txIndexWithinBlock === other.txIndexWithinBlock &&
+      this.logIndexWithinTx === other.logIndexWithinTx
+    );
+  }
+
+  toString(): string {
+    return `${this.blockNumber}-${this.txIndexWithinBlock}-${this.logIndexWithinTx}`;
+  }
+
+  /**
+   * Parses a `<blockNumber>-<txIndexWithinBlock>-<logIndexWithinTx>` triple into a {@link LogCursor}.
+   * Throws on malformed input. Returns `undefined` for an empty / missing value so callers can use
+   * this directly as an optional CLI option parser.
+   */
+  static parseOptional(value: string): LogCursor | undefined {
+    if (!value) {
+      return undefined;
+    }
+    const parts = value.split('-');
+    if (parts.length !== 3) {
+      throw new Error(`Invalid log cursor "${value}". Expected <blockNumber>-<txIndexWithinBlock>-<logIndexWithinTx>.`);
+    }
+    const [blockNumberStr, txIndexStr, logIndexStr] = parts;
+    const blockNumber = Number(blockNumberStr);
+    const txIndexWithinBlock = Number(txIndexStr);
+    const logIndexWithinTx = Number(logIndexStr);
+    if (!Number.isInteger(blockNumber) || blockNumber < 1) {
+      throw new Error(`Invalid log cursor block number: ${blockNumberStr}`);
+    }
+    if (!Number.isInteger(txIndexWithinBlock) || txIndexWithinBlock < 0) {
+      throw new Error(`Invalid log cursor tx index: ${txIndexStr}`);
+    }
+    if (!Number.isInteger(logIndexWithinTx) || logIndexWithinTx < 0) {
+      throw new Error(`Invalid log cursor log index: ${logIndexStr}`);
+    }
+    return new LogCursor(BlockNumber(blockNumber), txIndexWithinBlock, logIndexWithinTx);
+  }
+}

package/src/logs/log_result.ts

@@ -0,0 +1,104 @@
+import { BlockNumber, BlockNumberSchema } from '@aztec/foundation/branded-types';
+import { times } from '@aztec/foundation/collection';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { schemas as foundationSchemas } from '@aztec/foundation/schemas';
+import type { PickIfFlag, Prettify } from '@aztec/foundation/types';
+
+import { z } from 'zod';
+
+import { BlockHash } from '../block/block_hash.js';
+import { schemas } from '../schemas/schemas.js';
+import { TxHash } from '../tx/tx_hash.js';
+import type { UInt64 } from '../types/shared.js';
+
+/** Options for narrowing the shape of a {@link LogResult}. */
+export type LogIncludeOptions = {
+  /** When set, the log carries `noteHashes` + all `nullifiers` from its tx effect. Off by default. */
+  includeEffects?: boolean;
+};
+
+export const LogIncludeOptionsSchema: z.ZodType<LogIncludeOptions> = z.object({
+  includeEffects: z.boolean().optional(),
+});
+
+/** Required metadata always present on a {@link LogResult}. */
+export type LogResultBase = {
+  /** The data contents of the log, with the tag as the first field. */
+  logData: Fr[];
+  /** The block this log was emitted in. */
+  blockNumber: BlockNumber;
+  /** The hash of the block this log was emitted in. */
+  blockHash: BlockHash;
+  /** The timestamp of the block this log was emitted in. */
+  blockTimestamp: UInt64;
+  /** The hash of the tx this log was emitted in. */
+  txHash: TxHash;
+  /** The 0-based index of this log's tx within its block. */
+  txIndexWithinBlock: number;
+  /** The 0-based index of this log within its tx (across both private and public logs for the tx). */
+  logIndexWithinTx: number;
+};
+
+/**
+ * A single log returned from {@link L2LogsSource.getPrivateLogsByTags} or {@link L2LogsSource.getPublicLogsByTags}.
+ *
+ * Generic over the include-options so that flagged fields become required when the caller passes a
+ * literal `true`. The default type argument ({@link LogIncludeOptions}) yields the widest shape
+ * (all include-fields optional) — this is what the JSON-RPC wire layer validates against.
+ *
+ * `logData` is the raw field-element payload, with the tag in field 0 (consumers slice it off).
+ *
+ * @example
+ * const l: LogResult<{ includeEffects: true }> = (await node.getPrivateLogsByTags({ tags, includeEffects: true }))[0][0];
+ * l.nullifiers; // required, not optional
+ */
+export type LogResult<Opts extends LogIncludeOptions = LogIncludeOptions> = Prettify<
+  LogResultBase & PickIfFlag<LogIncludeOptions, Opts, 'includeEffects', { noteHashes: Fr[]; nullifiers: Fr[] }>
+>;
+
+/** Zod schema for the widest {@link LogResult} shape (all include-gated fields optional). */
+export const LogResultSchema: z.ZodType<LogResult> = z.object({
+  logData: z.array(foundationSchemas.Fr),
+  blockNumber: BlockNumberSchema,
+  blockHash: BlockHash.schema,
+  blockTimestamp: schemas.UInt64,
+  txHash: TxHash.schema,
+  txIndexWithinBlock: schemas.Integer,
+  logIndexWithinTx: schemas.Integer,
+  noteHashes: z.array(foundationSchemas.Fr).optional(),
+  nullifiers: z.array(foundationSchemas.Fr).optional(),
+});
+
+/** Builds a random {@link LogResult} for tests. `includeEffects` populates `noteHashes` + `nullifiers`. */
+export function randomLogResult(includeEffects = false): LogResult {
+  const base: LogResultBase = {
+    logData: times(3, Fr.random),
+    blockNumber: BlockNumber(Math.floor(Math.random() * 100000) + 1),
+    blockHash: BlockHash.random(),
+    blockTimestamp: BigInt(Math.floor(Date.now() / 1000)),
+    txHash: TxHash.random(),
+    txIndexWithinBlock: Math.floor(Math.random() * 100),
+    logIndexWithinTx: Math.floor(Math.random() * 100),
+  };
+  if (includeEffects) {
+    return { ...base, noteHashes: times(3, Fr.random), nullifiers: times(3, Fr.random) };
+  }
+  return base;
+}
+
+/** Human-readable single-line representation, primarily for the CLI `get-logs` command. */
+export function logResultToHumanReadable(log: LogResult): string {
+  const head =
+    `block ${log.blockNumber} (${log.blockHash.toString()}) ` +
+    `tx ${log.txHash.toString()} txIndex ${log.txIndexWithinBlock} logIndex ${log.logIndexWithinTx} ` +
+    `ts ${log.blockTimestamp}`;
+  const data = `data [${log.logData.map(f => f.toString()).join(', ')}]`;
+  const parts = [head, data];
+  if (log.noteHashes !== undefined) {
+    parts.push(`noteHashes [${log.noteHashes.map(f => f.toString()).join(', ')}]`);
+  }
+  if (log.nullifiers !== undefined) {
+    parts.push(`nullifiers [${log.nullifiers.map(f => f.toString()).join(', ')}]`);
+  }
+  return parts.join(' | ');
+}

package/src/logs/logs_query.ts

@@ -0,0 +1,138 @@
+import { BlockNumberSchema } from '@aztec/foundation/branded-types';
+import type { BlockNumber } from '@aztec/foundation/branded-types';
+
+import { z } from 'zod';
+
+import type { AztecAddress } from '../aztec-address/index.js';
+import { BlockHash } from '../block/block_hash.js';
+import { MAX_LOGS_PER_TAG, MAX_RPC_LEN } from '../interfaces/api_limit.js';
+import { type ZodFor, schemas, zodFor } from '../schemas/index.js';
+import { TxHash } from '../tx/tx_hash.js';
+import { LogCursor } from './log_cursor.js';
+import { SiloedTag } from './siloed_tag.js';
+import { Tag } from './tag.js';
+
+/**
+ * A tag to query in {@link PrivateLogsQuery} / {@link PublicLogsQuery}, optionally resuming strictly
+ * after a previously-seen log via `afterLog`. The bare `T` form means "from the beginning".
+ */
+export type TagQuery<T extends Tag | SiloedTag> = T | { tag: T; afterLog?: LogCursor };
+
+/**
+ * Shared fields for {@link PrivateLogsQuery} and {@link PublicLogsQuery}.
+ */
+export type LogsQueryBase = {
+  /** Lower block bound, inclusive. */
+  fromBlock?: BlockNumber;
+  /** Upper block bound, exclusive. */
+  toBlock?: BlockNumber;
+  /**
+   * Restrict results to logs emitted in this transaction. Mutually exclusive with `fromBlock`/`toBlock`
+   * (a txHash already pins a block). `txHash` + `afterLog` is allowed and paginates within the tx's logs
+   * for that tag.
+   */
+  txHash?: TxHash;
+  /**
+   * Reorg-safety anchor: the latest block hash the caller has synced to. If set and the block is no
+   * longer present, the call throws. Distinct from `toBlock`, which is a filter, not a safety check.
+   */
+  referenceBlock?: BlockHash;
+  /** When set, each log also carries `noteHashes` and all `nullifiers` for note-nonce discovery. */
+  includeEffects?: boolean;
+  /**
+   * Maximum number of logs returned per tag. Capped at {@link MAX_LOGS_PER_TAG} (rejected if higher).
+   * Defaults to {@link MAX_LOGS_PER_TAG} when unset. Mainly useful for tests that need to force
+   * pagination at a small page size.
+   */
+  limitPerTag?: number;
+};
+
+/**
+ * Query for {@link L2LogsSource.getPrivateLogsByTags}. Returns one inner array per element of `tags`,
+ * in input order.
+ */
+export type PrivateLogsQuery = LogsQueryBase & {
+  /** Tags to query. Between 1 and {@link MAX_RPC_LEN} entries (inclusive). */
+  tags: TagQuery<SiloedTag>[];
+};
+
+/**
+ * Query for {@link L2LogsSource.getPublicLogsByTags}. Returns one inner array per element of `tags`,
+ * in input order.
+ */
+export type PublicLogsQuery = LogsQueryBase & {
+  /** Contract address that emitted the logs. Required for public queries. */
+  contractAddress: AztecAddress;
+  /** Tags to query. Between 1 and {@link MAX_RPC_LEN} entries (inclusive). */
+  tags: TagQuery<Tag>[];
+};
+
+function tagQuerySchema<T extends Tag | SiloedTag>(tagSchema: ZodFor<T>) {
+  return z.union([
+    tagSchema,
+    z.object({
+      tag: tagSchema,
+      afterLog: LogCursor.schema.optional(),
+    }),
+  ]) as ZodFor<TagQuery<T>>;
+}
+
+const logsQueryBaseShape = {
+  fromBlock: BlockNumberSchema.optional(),
+  toBlock: BlockNumberSchema.optional(),
+  txHash: TxHash.schema.optional(),
+  referenceBlock: BlockHash.schema.optional(),
+  includeEffects: z.boolean().optional(),
+  limitPerTag: z
+    .number()
+    .int()
+    .positive()
+    .max(MAX_LOGS_PER_TAG, { message: `limitPerTag must be <= ${MAX_LOGS_PER_TAG}` })
+    .optional(),
+};
+
+/** Minimal shape required by {@link refineTxHashAndRange}. */
+type TxHashAndRangeFields = {
+  /** Tx hash filter. */
+  txHash?: TxHash;
+  /** Lower block bound. */
+  fromBlock?: BlockNumber;
+  /** Upper block bound (exclusive). */
+  toBlock?: BlockNumber;
+};
+
+/**
+ * Refinement: a `txHash` already pins a block, so combining it with a block range is contradictory.
+ * (`txHash` + `afterLog` is still allowed and is enforced per-tag inside `TagQuery`.) Exported so
+ * `aztec.js`'s wallet event-filter schemas can reuse the same rule.
+ */
+export function refineTxHashAndRange<T extends TxHashAndRangeFields>(schema: z.ZodType<T>) {
+  return schema.refine(q => !(q.txHash !== undefined && (q.fromBlock !== undefined || q.toBlock !== undefined)), {
+    message: '`txHash` is mutually exclusive with `fromBlock`/`toBlock`',
+  });
+}
+
+export const PrivateLogsQuerySchema: ZodFor<PrivateLogsQuery> = refineTxHashAndRange(
+  zodFor<PrivateLogsQuery>()(
+    z.object({
+      ...logsQueryBaseShape,
+      tags: z
+        .array(tagQuerySchema(SiloedTag.schema))
+        .min(1)
+        .max(MAX_RPC_LEN, { message: `tags must have at most ${MAX_RPC_LEN} entries` }),
+    }),
+  ),
+);
+
+export const PublicLogsQuerySchema: ZodFor<PublicLogsQuery> = refineTxHashAndRange(
+  zodFor<PublicLogsQuery>()(
+    z.object({
+      ...logsQueryBaseShape,
+      contractAddress: schemas.AztecAddress,
+      tags: z
+        .array(tagQuerySchema(Tag.schema))
+        .min(1)
+        .max(MAX_RPC_LEN, { message: `tags must have at most ${MAX_RPC_LEN} entries` }),
+    }),
+  ),
+);

package/src/logs/message_context.ts

@@ -0,0 +1,76 @@
+import { MAX_NOTE_HASHES_PER_TX } from '@aztec/constants';
+import { range } from '@aztec/foundation/array';
+import { Fr } from '@aztec/foundation/curves/bn254';
+
+import { TxHash } from '../tx/tx_hash.js';
+
+/**
+ * Additional information needed to process a message.
+ *
+ * All messages exist in the context of a transaction, and information about that transaction is typically required
+ * in order to perform validation, store results, etc. For example, messages containing notes require knowledge of note
+ * hashes and the first nullifier in order to find the note's nonce.
+ *
+ * A TS version of `message_context.nr`.
+ */
+export class MessageContext {
+  constructor(
+    public txHash: TxHash,
+    public uniqueNoteHashesInTx: Fr[],
+    public firstNullifierInTx: Fr,
+  ) {}
+
+  toFields(): Fr[] {
+    return [
+      this.txHash.hash,
+      ...serializeBoundedVec(this.uniqueNoteHashesInTx, MAX_NOTE_HASHES_PER_TX),
+      this.firstNullifierInTx,
+    ];
+  }
+
+  toNoirStruct() {
+    /* eslint-disable camelcase */
+    return {
+      tx_hash: this.txHash.hash,
+      unique_note_hashes_in_tx: this.uniqueNoteHashesInTx,
+      first_nullifier_in_tx: this.firstNullifierInTx,
+    };
+    /* eslint-enable camelcase */
+  }
+
+  static empty(): MessageContext {
+    return new MessageContext(TxHash.zero(), [], Fr.ZERO);
+  }
+
+  static toEmptyFields(): Fr[] {
+    const serializationLen =
+      1 /* txHash */ + MAX_NOTE_HASHES_PER_TX + 1 /* uniqueNoteHashesInTx BVec */ + 1; /* firstNullifierInTx */
+    return range(serializationLen).map(_ => Fr.zero());
+  }
+
+  static toSerializedOption(response: MessageContext | null): Fr[] {
+    if (response) {
+      return [new Fr(1), ...response.toFields()];
+    } else {
+      return [new Fr(0), ...MessageContext.toEmptyFields()];
+    }
+  }
+}
+
+/**
+ * Helper function to serialize a bounded vector according to Noir's BoundedVec format
+ * @param values - The values to serialize
+ * @param maxLength - The maximum length of the bounded vector
+ * @returns The serialized bounded vector as Fr[]
+ * @dev Copied over from pending_tagged_log.ts.
+ */
+function serializeBoundedVec(values: Fr[], maxLength: number): Fr[] {
+  if (values.length > maxLength) {
+    throw new Error(`Attempted to serialize ${values} values into a BoundedVec with max length ${maxLength}`);
+  }
+
+  const lengthDiff = maxLength - values.length;
+  const zeroPaddingArray = Array(lengthDiff).fill(Fr.ZERO);
+  const storage = values.concat(zeroPaddingArray);
+  return [...storage, new Fr(values.length)];
+}

package/src/logs/pending_tagged_log.ts

@@ -0,0 +1,39 @@
+import { PRIVATE_LOG_SIZE_IN_FIELDS } from '@aztec/constants';
+import { Fr } from '@aztec/foundation/curves/bn254';
+
+import type { TxHash } from '../tx/tx_hash.js';
+import { MessageContext } from './message_context.js';
+
+/**
+ * Represents a pending tagged log as it is stored in the pending tagged log array to which the fetchTaggedLogs oracle
+ * inserts found private logs. A TS version of `pending_tagged_log.nr`.
+ */
+export class PendingTaggedLog {
+  private context: MessageContext;
+
+  constructor(
+    public log: Fr[],
+    txHash: TxHash,
+    uniqueNoteHashesInTx: Fr[],
+    firstNullifierInTx: Fr,
+  ) {
+    this.context = new MessageContext(txHash, uniqueNoteHashesInTx, firstNullifierInTx);
+  }
+
+  toFields(): Fr[] {
+    return [...serializeBoundedVec(this.log, PRIVATE_LOG_SIZE_IN_FIELDS), ...this.context.toFields()];
+  }
+}
+
+/**
+ * Helper function to serialize a bounded vector according to Noir's BoundedVec format
+ * @param values - The values to serialize
+ * @param maxLength - The maximum length of the bounded vector
+ * @returns The serialized bounded vector as Fr[]
+ */
+function serializeBoundedVec(values: Fr[], maxLength: number): Fr[] {
+  const lengthDiff = maxLength - values.length;
+  const zeroPaddingArray = Array(lengthDiff).fill(Fr.ZERO);
+  const storage = values.concat(zeroPaddingArray);
+  return [...storage, new Fr(values.length)];
+}

package/src/logs/pre_tag.ts

@@ -0,0 +1,22 @@
+import { schemas } from '@aztec/foundation/schemas';
+
+import { z } from 'zod';
+
+import { type AppTaggingSecret, AppTaggingSecretSchema } from './app_tagging_secret.js';
+
+/**
+ * Represents a preimage of a private log tag (see `Tag` in `pxe/src/tagging`).
+ *
+ * Note: It's a bit unfortunate that this type resides in `stdlib` as the rest of the tagging functionality resides
+ * in `pxe/src/tagging`. But this type is used by other types in stdlib hence there doesn't seem to be a good way
+ * around this.
+ */
+export type PreTag = {
+  extendedSecret: AppTaggingSecret;
+  index: number;
+};
+
+export const PreTagSchema = z.object({
+  extendedSecret: AppTaggingSecretSchema,
+  index: schemas.Integer,
+});

package/src/logs/private_log.ts

@@ -1,69 +1,128 @@
-import { PRIVATE_LOG_SIZE_IN_FIELDS } from '@aztec/constants';
-import { makeTuple } from '@aztec/foundation/array';
-import { Fr } from '@aztec/foundation/fields';
+import { PRIVATE_LOG_LENGTH, PRIVATE_LOG_SIZE_IN_FIELDS } from '@aztec/constants';
+import { type FieldsOf, makeTuple } from '@aztec/foundation/array';
+import { padArrayEnd } from '@aztec/foundation/collection';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { schemas } from '@aztec/foundation/schemas';
-import { BufferReader, FieldReader, type Tuple, serializeToBuffer } from '@aztec/foundation/serialize';
+import {
+  BufferReader,
+  BufferSink,
+  FieldReader,
+  type Tuple,
+  serializeToFields,
+  serializeToSink,
+} from '@aztec/foundation/serialize';
 
 import { inspect } from 'util';
 import { z } from 'zod';
 
 export class PrivateLog {
-  static SIZE_IN_BYTES = Fr.SIZE_IN_BYTES * PRIVATE_LOG_SIZE_IN_FIELDS;
+  static SIZE_IN_BYTES = Fr.SIZE_IN_BYTES * PRIVATE_LOG_LENGTH;
 
-  constructor(public fields: Tuple<Fr, typeof PRIVATE_LOG_SIZE_IN_FIELDS>) {}
+  constructor(
+    public fields: Tuple<Fr, typeof PRIVATE_LOG_SIZE_IN_FIELDS>,
+    // Named `emittedLength` instead of `length` to avoid being confused with fields.length.
+    public emittedLength: number,
+  ) {}
+
+  static from(fields: FieldsOf<PrivateLog>) {
+    return new PrivateLog(...PrivateLog.getFields(fields));
+  }
+
+  static getFields(fields: FieldsOf<PrivateLog>) {
+    return [fields.fields, fields.emittedLength] as const;
+  }
 
   toFields(): Fr[] {
-    return this.fields;
+    return serializeToFields(...PrivateLog.getFields(this));
   }
 
   static fromFields(fields: Fr[] | FieldReader) {
     const reader = FieldReader.asReader(fields);
-    return new PrivateLog(reader.readFieldArray(PRIVATE_LOG_SIZE_IN_FIELDS));
+    return new PrivateLog(reader.readFieldArray(PRIVATE_LOG_SIZE_IN_FIELDS), reader.readU32());
   }
 
-  isEmpty() {
-    return this.fields.every(f => f.isZero());
+  getEmittedFields() {
+    return this.fields.slice(0, this.emittedLength);
   }
 
-  static empty() {
-    return new PrivateLog(makeTuple(PRIVATE_LOG_SIZE_IN_FIELDS, Fr.zero));
+  getEmittedFieldsWithoutTag() {
+    return this.fields.slice(1, this.emittedLength);
   }
 
-  toBuffer(): Buffer {
-    return serializeToBuffer(this.fields);
+  toBlobFields(): Fr[] {
+    return this.getEmittedFields();
   }
 
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new PrivateLog(reader.readArray(PRIVATE_LOG_SIZE_IN_FIELDS, Fr));
+  static fromBlobFields(emittedLength: number, fields: Fr[] | FieldReader) {
+    const reader = FieldReader.asReader(fields);
+    const emittedFields = reader.readFieldArray(emittedLength);
+    return new PrivateLog(padArrayEnd(emittedFields, Fr.ZERO, PRIVATE_LOG_SIZE_IN_FIELDS), emittedLength);
   }
 
-  static random() {
-    return new PrivateLog(makeTuple(PRIVATE_LOG_SIZE_IN_FIELDS, Fr.random));
+  isEmpty() {
+    // Faster to check emittedLength than compare all fields against zero
+    return this.emittedLength === 0;
   }
 
-  getEmittedLength() {
-    // This assumes that we cut trailing zeroes from the end of the log. In ts, these will always be added back.
-    // Does not include length prefix.
-    return this.getEmittedFields().length;
+  static empty() {
+    return new PrivateLog(makeTuple(PRIVATE_LOG_SIZE_IN_FIELDS, Fr.zero), 0);
   }
 
-  getEmittedFields() {
-    const lastNonZeroIndex = this.fields.findLastIndex(f => !f.isZero());
-    return this.fields.slice(0, lastNonZeroIndex + 1);
+  toBuffer(): Buffer;
+  toBuffer(sink: BufferSink): void;
+  toBuffer(sink?: BufferSink): Buffer | void {
+    if (!sink) {
+      return BufferSink.serialize(this);
+    }
+    serializeToSink(sink, this.fields, this.emittedLength);
+  }
+
+  static fromBuffer(buffer: Buffer | BufferReader) {
+    const reader = BufferReader.asReader(buffer);
+    return new PrivateLog(reader.readArray(PRIVATE_LOG_SIZE_IN_FIELDS, Fr), reader.readNumber());
+  }
+
+  static random(tag = Fr.random()) {
+    const fields = makeTuple(PRIVATE_LOG_SIZE_IN_FIELDS, Fr.random);
+    fields[0] = tag;
+    return new PrivateLog(fields, PRIVATE_LOG_SIZE_IN_FIELDS);
   }
 
   static get schema() {
     return z
       .object({
         fields: z.array(schemas.Fr),
+        emittedLength: z.number(),
       })
-      .transform(({ fields }) => PrivateLog.fromFields(fields));
+      .strict()
+      .transform(({ fields, emittedLength }) => PrivateLog.fromFields(fields.concat(new Fr(emittedLength))));
+  }
+
+  /**
+   * Creates a PrivateLog from a plain object without Zod validation.
+   * This method is optimized for performance and skips validation, making it suitable
+   * for deserializing trusted data (e.g., from C++ via MessagePack).
+   * @param obj - Plain object containing PrivateLog fields
+   * @returns A PrivateLog instance
+   */
+  static fromPlainObject(obj: any): PrivateLog {
+    if (obj instanceof PrivateLog) {
+      return obj;
+    }
+    return new PrivateLog(
+      obj.fields.map((f: any) => Fr.fromPlainObject(f)),
+      obj.emittedLength,
+    );
+  }
+
+  equals(other: PrivateLog) {
+    return this.fields.every((field, i) => field.equals(other.fields[i])) && this.emittedLength === other.emittedLength;
   }
 
   [inspect.custom](): string {
     return `PrivateLog {
       fields: [${this.fields.map(x => inspect(x)).join(', ')}],
+      emittedLength: ${this.emittedLength},
     }`;
   }
 }