@aztec/stdlib 0.0.1-commit.fce3e4f → 0.0.1-commit.fffb133c

package/src/logs/private_log.ts

@@ -1,7 +1,7 @@
 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/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { schemas } from '@aztec/foundation/schemas';
 import {
   BufferReader,
@@ -59,7 +59,8 @@ export class PrivateLog {
   }
 
   isEmpty() {
-    return this.fields.every(f => f.isZero());
+    // Faster to check emittedLength than compare all fields against zero
+    return this.emittedLength === 0;
   }
 
   static empty() {

package/src/logs/public_log.ts

@@ -1,6 +1,6 @@
 import { FLAT_PUBLIC_LOGS_PAYLOAD_LENGTH, PUBLIC_LOG_HEADER_LENGTH } from '@aztec/constants';
 import type { FieldsOf } from '@aztec/foundation/array';
-import { Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { type ZodFor, schemas } from '@aztec/foundation/schemas';
 import { BufferReader, FieldReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
@@ -172,6 +172,13 @@ export class PublicLog {
     return new PublicLog(reader.readObject(AztecAddress), reader.readArray(fieldsLength, Fr));
   }
 
+  static fromPlainObject(obj: any): PublicLog {
+    return new PublicLog(
+      AztecAddress.fromPlainObject(obj.contractAddress),
+      obj.fields.map((f: any) => Fr.fromPlainObject(f)),
+    );
+  }
+
   static async random() {
     return new PublicLog(
       await AztecAddress.random(),

package/src/logs/shared_secret_derivation.ts

@@ -1,5 +1,5 @@
-import { Grumpkin } from '@aztec/foundation/crypto';
-import type { GrumpkinScalar, Point } from '@aztec/foundation/fields';
+import { Grumpkin } from '@aztec/foundation/crypto/grumpkin';
+import type { GrumpkinScalar, Point } from '@aztec/foundation/curves/grumpkin';
 
 import type { PublicKey } from '../keys/public_key.js';
 

package/src/logs/siloed_tag.ts

@@ -0,0 +1,44 @@
+import { poseidon2Hash } from '@aztec/foundation/crypto/poseidon';
+import type { Fr } from '@aztec/foundation/curves/bn254';
+import type { ZodFor } from '@aztec/foundation/schemas';
+
+import type { AztecAddress } from '../aztec-address/index.js';
+import { schemas } from '../schemas/schemas.js';
+import type { Tag } from './tag.js';
+
+/* eslint-disable @typescript-eslint/no-unsafe-declaration-merging */
+
+/** Branding to ensure fields are not interchangeable types. */
+export interface SiloedTag {
+  /** Brand. */
+  _branding: 'SiloedTag';
+}
+
+/**
+ * Represents a tag used in private log as it "appears on the chain" - that is the tag is siloed with a contract
+ * address that emitted the log.
+ */
+export class SiloedTag {
+  constructor(public readonly value: Fr) {}
+
+  static async compute(tag: Tag, app: AztecAddress): Promise<SiloedTag> {
+    const siloedTag = await poseidon2Hash([app, tag.value]);
+    return new SiloedTag(siloedTag);
+  }
+
+  toString(): string {
+    return this.value.toString();
+  }
+
+  toJSON(): string {
+    return this.value.toString();
+  }
+
+  equals(other: SiloedTag): boolean {
+    return this.value.equals(other.value);
+  }
+
+  static get schema(): ZodFor<SiloedTag> {
+    return schemas.Fr.transform((fr: Fr) => new SiloedTag(fr));
+  }
+}

package/src/logs/tag.ts

@@ -0,0 +1,42 @@
+import { poseidon2Hash } from '@aztec/foundation/crypto/poseidon';
+import type { Fr } from '@aztec/foundation/curves/bn254';
+import type { ZodFor } from '@aztec/foundation/schemas';
+
+import { schemas } from '../schemas/schemas.js';
+import type { PreTag } from './pre_tag.js';
+
+/* eslint-disable @typescript-eslint/no-unsafe-declaration-merging */
+
+export interface Tag {
+  /** Brand. */
+  _branding: 'Tag';
+}
+
+/**
+ * Represents a tag of a private log. This is not the tag that "appears" on the chain as this tag is first siloed
+ * with a contract address by kernels before being included in the final log.
+ */
+export class Tag {
+  constructor(public readonly value: Fr) {}
+
+  static async compute(preTag: PreTag): Promise<Tag> {
+    const tag = await poseidon2Hash([preTag.secret.value, preTag.index]);
+    return new Tag(tag);
+  }
+
+  toString(): string {
+    return this.value.toString();
+  }
+
+  toJSON(): string {
+    return this.value.toString();
+  }
+
+  equals(other: Tag): boolean {
+    return this.value.equals(other.value);
+  }
+
+  static get schema(): ZodFor<Tag> {
+    return schemas.Fr.transform((fr: Fr) => new Tag(fr));
+  }
+}

package/src/logs/tx_scoped_l2_log.ts

@@ -1,12 +1,19 @@
-import { BufferReader, boolToBuffer, numToUInt32BE } from '@aztec/foundation/serialize';
+import { BlockNumber, BlockNumberSchema } from '@aztec/foundation/branded-types';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { schemas as foundationSchemas } from '@aztec/foundation/schemas';
+import {
+  BufferReader,
+  bigintToUInt64BE,
+  numToUInt32BE,
+  serializeArrayOfBufferableToVector,
+} from '@aztec/foundation/serialize';
 
 import { z } from 'zod';
 
+import { schemas } from '../schemas/schemas.js';
 import { TxHash } from '../tx/tx_hash.js';
-import { PrivateLog } from './private_log.js';
-import { PublicLog } from './public_log.js';
+import type { UInt64 } from '../types/shared.js';
 
-// TODO(#14460): Split to private and public versions instead of having this weird mix.
 export class TxScopedL2Log {
   constructor(
     /*
@@ -14,82 +21,78 @@ export class TxScopedL2Log {
      */
     public txHash: TxHash,
     /*
-     * The next available leaf index for the note hash tree for this transaction. It is stored
-     * with the log so the noteHashIndex can be reconstructed after decryption.
+     * The block this log is included in
      */
-    public dataStartIndexForTx: number,
+    public blockNumber: BlockNumber,
     /*
-     * The index of the log in the transaction. Note that public and private logs are in separate arrays in the tx
-     * effect and for this reason these indices are independent (a private and public log can have the same index).
+     * The timestamp of the block this log is included in
      */
-    public logIndexInTx: number,
+    public blockTimestamp: UInt64,
     /*
-     * The block this log is included in
+     * The log data as an array of field elements
+     */
+    public logData: Fr[],
+    /*
+     * The note hashes from the tx effect
      */
-    public blockNumber: number,
+    public noteHashes: Fr[],
     /*
-     * The log data as either a PrivateLog or PublicLog
+     * The first nullifier from the tx effect. Used for nonce discovery when processing notes from logs.
+     *
+     * (Note nonces are computed as `hash(firstNullifier, noteIndexInTx)`.)
      */
-    public log: PrivateLog | PublicLog,
+    public firstNullifier: Fr,
   ) {}
 
-  get isFromPublic() {
-    return this.log instanceof PublicLog;
-  }
-
   static get schema() {
     return z
       .object({
         txHash: TxHash.schema,
-        dataStartIndexForTx: z.number(),
-        logIndexInTx: z.number(),
-        blockNumber: z.number(),
-        log: z.union([PrivateLog.schema, PublicLog.schema]),
+        blockNumber: BlockNumberSchema,
+        blockTimestamp: schemas.UInt64,
+        logData: z.array(foundationSchemas.Fr),
+        noteHashes: z.array(foundationSchemas.Fr),
+        firstNullifier: foundationSchemas.Fr,
       })
       .transform(
-        ({ txHash, dataStartIndexForTx, logIndexInTx, blockNumber, log }) =>
-          new TxScopedL2Log(txHash, dataStartIndexForTx, logIndexInTx, blockNumber, log),
+        ({ txHash, blockNumber, blockTimestamp, logData, noteHashes, firstNullifier }) =>
+          new TxScopedL2Log(txHash, blockNumber, blockTimestamp, logData, noteHashes, firstNullifier),
       );
   }
 
   toBuffer() {
-    const isFromPublic = this.log instanceof PublicLog;
     return Buffer.concat([
       this.txHash.toBuffer(),
-      numToUInt32BE(this.dataStartIndexForTx),
-      numToUInt32BE(this.logIndexInTx),
       numToUInt32BE(this.blockNumber),
-      boolToBuffer(isFromPublic),
-      this.log.toBuffer(),
+      bigintToUInt64BE(this.blockTimestamp),
+      serializeArrayOfBufferableToVector(this.logData),
+      serializeArrayOfBufferableToVector(this.noteHashes),
+      this.firstNullifier.toBuffer(),
     ]);
   }
 
   static fromBuffer(buffer: Buffer) {
     const reader = BufferReader.asReader(buffer);
     const txHash = reader.readObject(TxHash);
-    const dataStartIndexForTx = reader.readNumber();
-    const logIndexInTx = reader.readNumber();
-    const blockNumber = reader.readNumber();
-    const isFromPublic = reader.readBoolean();
-    const log = isFromPublic ? PublicLog.fromBuffer(reader) : PrivateLog.fromBuffer(reader);
-
-    return new TxScopedL2Log(txHash, dataStartIndexForTx, logIndexInTx, blockNumber, log);
-  }
+    const blockNumber = BlockNumber(reader.readNumber());
+    const blockTimestamp = reader.readUInt64();
+    const logData = reader.readVector(Fr);
+    const noteHashes = reader.readVector(Fr);
+    const firstNullifier = reader.readObject(Fr);
 
-  static async random(isFromPublic = Math.random() < 0.5) {
-    const log = isFromPublic ? await PublicLog.random() : PrivateLog.random();
-    return new TxScopedL2Log(TxHash.random(), 1, 1, 1, log);
+    return new TxScopedL2Log(txHash, blockNumber, blockTimestamp, logData, noteHashes, firstNullifier);
   }
 
   equals(other: TxScopedL2Log) {
     return (
       this.txHash.equals(other.txHash) &&
-      this.dataStartIndexForTx === other.dataStartIndexForTx &&
-      this.logIndexInTx === other.logIndexInTx &&
       this.blockNumber === other.blockNumber &&
-      ((this.log instanceof PublicLog && other.log instanceof PublicLog) ||
-        (this.log instanceof PrivateLog && other.log instanceof PrivateLog)) &&
-      this.log.equals(other.log as any)
+      this.blockTimestamp === other.blockTimestamp &&
+      this.logData.length === other.logData.length &&
+      this.logData.every((f, i) => f.equals(other.logData[i])) &&
+      this.noteHashes.length === other.noteHashes.length &&
+      this.noteHashes.every((h, i) => h.equals(other.noteHashes[i])) &&
+      this.firstNullifier.equals(other.firstNullifier)
     );
   }
 }

package/src/messaging/in_hash.ts

@@ -1,9 +1,11 @@
 import { NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP } from '@aztec/constants';
 import { padArrayEnd } from '@aztec/foundation/collection';
-import { Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { computeBalancedShaRoot } from '@aztec/foundation/trees';
 
-/** Computes the inHash for a block's ContentCommitment given its l1 to l2 messages. */
+/**
+ * Computes the inHash for a checkpoint (or the first block in a checkpoint) given its l1 to l2 messages.
+ */
 export function computeInHashFromL1ToL2Messages(unpaddedL1ToL2Messages: Fr[]): Fr {
   const l1ToL2Messages = padArrayEnd<Fr, number>(unpaddedL1ToL2Messages, Fr.ZERO, NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP);
   return new Fr(computeBalancedShaRoot(l1ToL2Messages.map(msg => msg.toBuffer())));

package/src/messaging/inbox_leaf.ts

@@ -1,6 +1,7 @@
-import { INITIAL_L2_BLOCK_NUM, NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP } from '@aztec/constants';
+import { INITIAL_CHECKPOINT_NUMBER, NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP } from '@aztec/constants';
 import { toBigIntBE } from '@aztec/foundation/bigint-buffer';
-import { Fr } from '@aztec/foundation/fields';
+import { CheckpointNumber } from '@aztec/foundation/branded-types';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
 export class InboxLeaf {
@@ -22,22 +23,22 @@ export class InboxLeaf {
     return new InboxLeaf(index, leaf);
   }
 
-  static smallestIndexFromL2Block(l2blockNumber: number): bigint {
-    return BigInt(l2blockNumber - INITIAL_L2_BLOCK_NUM) * BigInt(NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP);
+  static smallestIndexForCheckpoint(checkpointNumber: CheckpointNumber): bigint {
+    return BigInt(checkpointNumber - INITIAL_CHECKPOINT_NUMBER) * BigInt(NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP);
   }
 
   /**
-   * Returns the range of valid indices for a given L2 block.
+   * Returns the range of valid indices for a given checkpoint.
    * Start index is inclusive, end index is exclusive.
    */
-  static indexRangeFromL2Block(l2blockNumber: number): [bigint, bigint] {
-    const start = this.smallestIndexFromL2Block(l2blockNumber);
+  static indexRangeForCheckpoint(checkpointNumber: CheckpointNumber): [bigint, bigint] {
+    const start = this.smallestIndexForCheckpoint(checkpointNumber);
     const end = start + BigInt(NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP);
     return [start, end];
   }
 
-  /** Returns the L2 block number for a given leaf index */
-  static l2BlockFromIndex(index: bigint): number {
-    return Number(index / BigInt(NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP)) + INITIAL_L2_BLOCK_NUM;
+  /** Returns the checkpoint number for a given leaf index */
+  static checkpointNumberFromIndex(index: bigint): CheckpointNumber {
+    return CheckpointNumber(Number(index / BigInt(NUMBER_OF_L1_L2_MESSAGES_PER_ROLLUP)) + INITIAL_CHECKPOINT_NUMBER);
   }
 }

package/src/messaging/l1_actor.ts

@@ -1,6 +1,6 @@
-import { randomInt } from '@aztec/foundation/crypto';
+import { randomInt } from '@aztec/foundation/crypto/random';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { EthAddress } from '@aztec/foundation/eth-address';
-import { Fr } from '@aztec/foundation/fields';
 import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
 /**

package/src/messaging/l1_to_l2_message.ts

@@ -1,6 +1,6 @@
 import type { L1_TO_L2_MSG_TREE_HEIGHT } from '@aztec/constants';
-import { sha256ToField } from '@aztec/foundation/crypto';
-import { Fr } from '@aztec/foundation/fields';
+import { sha256ToField } from '@aztec/foundation/crypto/sha256';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 import { bufferToHex } from '@aztec/foundation/string';
 import { SiblingPath } from '@aztec/foundation/trees';
@@ -84,6 +84,7 @@ export async function getNonNullifiedL1ToL2MessageWitness(
   if (!response) {
     throw new Error(`No L1 to L2 message found for message hash ${messageHash.toString()}`);
   }
+
   const [messageIndex, siblingPath] = response;
 
   const messageNullifier = await computeL1ToL2MessageNullifier(contractAddress, messageHash, secret);

package/src/messaging/l1_to_l2_message_source.ts

@@ -1,4 +1,5 @@
-import type { Fr } from '@aztec/foundation/fields';
+import type { CheckpointNumber } from '@aztec/foundation/branded-types';
+import type { Fr } from '@aztec/foundation/curves/bn254';
 
 import type { L2Tips } from '../block/l2_block_source.js';
 
@@ -7,11 +8,11 @@ import type { L2Tips } from '../block/l2_block_source.js';
  */
 export interface L1ToL2MessageSource {
   /**
-   * Gets new L1 to L2 message (to be) included in a given block.
-   * @param blockNumber - L2 block number to get messages for.
+   * Gets new L1 to L2 message (to be) included in a given checkpoint.
+   * @param checkpointNumber - Checkpoint number to get messages for.
    * @returns The L1 to L2 messages/leaves of the messages subtree (throws if not found).
    */
-  getL1ToL2Messages(blockNumber: number): Promise<Fr[]>;
+  getL1ToL2Messages(checkpointNumber: CheckpointNumber): Promise<Fr[]>;
 
   /**
    * Gets the L1 to L2 message index in the L1 to L2 message tree.
@@ -20,12 +21,6 @@ export interface L1ToL2MessageSource {
    */
   getL1ToL2MessageIndex(l1ToL2Message: Fr): Promise<bigint | undefined>;
 
-  /**
-   * Gets the number of the latest L2 block processed by the implementation.
-   * @returns The number of the latest L2 block processed by the implementation.
-   */
-  getBlockNumber(): Promise<number>;
-
   /**
    * Returns the tips of the L2 chain.
    */

package/src/messaging/l2_actor.ts

@@ -1,5 +1,5 @@
-import { randomInt } from '@aztec/foundation/crypto';
-import { Fr } from '@aztec/foundation/fields';
+import { randomInt } from '@aztec/foundation/crypto/random';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
 
 import { AztecAddress } from '../aztec-address/index.js';