@aztec/stdlib 0.79.0 → 0.81.0

package/dest/logs/l1_payload/l1_note_payload.d.ts

@@ -1,82 +0,0 @@
-/// <reference types="node" resolution-mode="require"/>
-/// <reference types="node" resolution-mode="require"/>
-import { type Fq, Fr } from '@aztec/foundation/fields';
-import { BufferReader } from '@aztec/foundation/serialize';
-import { NoteSelector } from '../../abi/note_selector.js';
-import { AztecAddress } from '../../aztec-address/index.js';
-import type { PrivateLog } from '../private_log.js';
-import { PublicLog } from '../public_log.js';
-/**
- * A class which wraps note data which is pushed on L1.
- * @remarks This data is required to compute a nullifier/to spend a note. Along with that this class contains
- * the necessary functionality to encrypt and decrypt the data.
- */
-export declare class L1NotePayload {
-    /**
-     * Address of the contract this tx is interacting with.
-     */
-    contractAddress: AztecAddress;
-    /**
-     * Storage slot of the underlying note.
-     */
-    storageSlot: Fr;
-    /**
-     * Type identifier for the underlying note, required to determine how to compute its hash and nullifier.
-     */
-    noteTypeId: NoteSelector;
-    /**
-     * Note values delivered encrypted.
-     * @dev Note that to recreate the correct note we need to merge privateNoteValues and publicNoteValues. To do that
-     * we need access to the contract ABI (that is done in the NoteProcessor).
-     */
-    privateNoteValues: Fr[];
-    /**
-     * Note values delivered in plaintext.
-     * @dev Note that to recreate the correct note we need to merge privateNoteValues and publicNoteValues. To do that
-     * we need access to the contract ABI (that is done in the NoteProcessor).
-     */
-    publicNoteValues: Fr[];
-    constructor(
-    /**
-     * Address of the contract this tx is interacting with.
-     */
-    contractAddress: AztecAddress, 
-    /**
-     * Storage slot of the underlying note.
-     */
-    storageSlot: Fr, 
-    /**
-     * Type identifier for the underlying note, required to determine how to compute its hash and nullifier.
-     */
-    noteTypeId: NoteSelector, 
-    /**
-     * Note values delivered encrypted.
-     * @dev Note that to recreate the correct note we need to merge privateNoteValues and publicNoteValues. To do that
-     * we need access to the contract ABI (that is done in the NoteProcessor).
-     */
-    privateNoteValues: Fr[], 
-    /**
-     * Note values delivered in plaintext.
-     * @dev Note that to recreate the correct note we need to merge privateNoteValues and publicNoteValues. To do that
-     * we need access to the contract ABI (that is done in the NoteProcessor).
-     */
-    publicNoteValues: Fr[]);
-    static fromIncomingBodyPlaintextContractAndPublicValues(plaintext: Buffer, contractAddress: AztecAddress, publicNoteValues: Fr[]): L1NotePayload | undefined;
-    static decryptAsIncoming(log: PrivateLog, sk: Fq): Promise<L1NotePayload | undefined>;
-    static decryptAsIncomingFromPublic(log: PublicLog, sk: Fq): Promise<L1NotePayload | undefined>;
-    /**
-     * Serializes the L1NotePayload object into a Buffer.
-     * @returns Buffer representation of the L1NotePayload object.
-     */
-    toIncomingBodyPlaintext(): Buffer;
-    /**
-     * Create a random L1NotePayload object (useful for testing purposes).
-     * @param contract - The address of a contract the note was emitted from.
-     * @returns A random L1NotePayload object.
-     */
-    static random(contract?: AztecAddress): Promise<L1NotePayload>;
-    equals(other: L1NotePayload): boolean;
-    toBuffer(): Buffer;
-    static fromBuffer(buffer: Buffer | BufferReader): L1NotePayload;
-}
-//# sourceMappingURL=l1_note_payload.d.ts.map

package/dest/logs/l1_payload/l1_note_payload.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"l1_note_payload.d.ts","sourceRoot":"","sources":["../../../src/logs/l1_payload/l1_note_payload.ts"],"names":[],"mappings":";;AACA,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,EAAE,MAAM,0BAA0B,CAAC;AACvD,OAAO,EAAE,YAAY,EAAqB,MAAM,6BAA6B,CAAC;AAE9E,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AAE5D,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAG7C;;;;GAIG;AACH,qBAAa,aAAa;IAEtB;;OAEG;IACI,eAAe,EAAE,YAAY;IACpC;;OAEG;IACI,WAAW,EAAE,EAAE;IACtB;;OAEG;IACI,UAAU,EAAE,YAAY;IAC/B;;;;OAIG;IACI,iBAAiB,EAAE,EAAE,EAAE;IAC9B;;;;OAIG;IACI,gBAAgB,EAAE,EAAE,EAAE;;IAvB7B;;OAEG;IACI,eAAe,EAAE,YAAY;IACpC;;OAEG;IACI,WAAW,EAAE,EAAE;IACtB;;OAEG;IACI,UAAU,EAAE,YAAY;IAC/B;;;;OAIG;IACI,iBAAiB,EAAE,EAAE,EAAE;IAC9B;;;;OAIG;IACI,gBAAgB,EAAE,EAAE,EAAE;IAG/B,MAAM,CAAC,gDAAgD,CACrD,SAAS,EAAE,MAAM,EACjB,eAAe,EAAE,YAAY,EAC7B,gBAAgB,EAAE,EAAE,EAAE,GACrB,aAAa,GAAG,SAAS;WAgBf,iBAAiB,CAAC,GAAG,EAAE,UAAU,EAAE,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;WAa9E,2BAA2B,CAAC,GAAG,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,GAAG,OAAO,CAAC,aAAa,GAAG,SAAS,CAAC;IAkBpG;;;OAGG;IACH,uBAAuB;IAKvB;;;;OAIG;WACU,MAAM,CAAC,QAAQ,CAAC,EAAE,YAAY;IAgBpC,MAAM,CAAC,KAAK,EAAE,aAAa;IAUlC,QAAQ;IAUR,MAAM,CAAC,UAAU,CAAC,MAAM,EAAE,MAAM,GAAG,YAAY;CAUhD"}

package/dest/logs/l1_payload/l1_note_payload.js

@@ -1,129 +0,0 @@
-import { randomInt } from '@aztec/foundation/crypto';
-import { Fr } from '@aztec/foundation/fields';
-import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
-import { NoteSelector } from '../../abi/note_selector.js';
-import { AztecAddress } from '../../aztec-address/index.js';
-import { Vector } from '../../types/index.js';
-import { EncryptedLogPayload } from './encrypted_log_payload.js';
-/**
- * A class which wraps note data which is pushed on L1.
- * @remarks This data is required to compute a nullifier/to spend a note. Along with that this class contains
- * the necessary functionality to encrypt and decrypt the data.
- */ export class L1NotePayload {
-    contractAddress;
-    storageSlot;
-    noteTypeId;
-    privateNoteValues;
-    publicNoteValues;
-    constructor(/**
-     * Address of the contract this tx is interacting with.
-     */ contractAddress, /**
-     * Storage slot of the underlying note.
-     */ storageSlot, /**
-     * Type identifier for the underlying note, required to determine how to compute its hash and nullifier.
-     */ noteTypeId, /**
-     * Note values delivered encrypted.
-     * @dev Note that to recreate the correct note we need to merge privateNoteValues and publicNoteValues. To do that
-     * we need access to the contract ABI (that is done in the NoteProcessor).
-     */ privateNoteValues, /**
-     * Note values delivered in plaintext.
-     * @dev Note that to recreate the correct note we need to merge privateNoteValues and publicNoteValues. To do that
-     * we need access to the contract ABI (that is done in the NoteProcessor).
-     */ publicNoteValues){
-        this.contractAddress = contractAddress;
-        this.storageSlot = storageSlot;
-        this.noteTypeId = noteTypeId;
-        this.privateNoteValues = privateNoteValues;
-        this.publicNoteValues = publicNoteValues;
-    }
-    static fromIncomingBodyPlaintextContractAndPublicValues(plaintext, contractAddress, publicNoteValues) {
-        try {
-            const reader = BufferReader.asReader(plaintext);
-            const fields = reader.readArray(plaintext.length / Fr.SIZE_IN_BYTES, Fr);
-            const storageSlot = fields[0];
-            const noteTypeId = NoteSelector.fromField(fields[1]);
-            const privateNoteValues = fields.slice(2);
-            return new L1NotePayload(contractAddress, storageSlot, noteTypeId, privateNoteValues, publicNoteValues);
-        } catch (e) {
-            return undefined;
-        }
-    }
-    static async decryptAsIncoming(log, sk) {
-        const decryptedLog = await EncryptedLogPayload.decryptAsIncoming(log.fields, sk);
-        if (!decryptedLog) {
-            return undefined;
-        }
-        return this.fromIncomingBodyPlaintextContractAndPublicValues(decryptedLog.incomingBodyPlaintext, decryptedLog.contractAddress, /* publicValues */ []);
-    }
-    static async decryptAsIncomingFromPublic(log, sk) {
-        const { privateValues, publicValues } = parseLogFromPublic(log);
-        if (!privateValues) {
-            return undefined;
-        }
-        const decryptedLog = await EncryptedLogPayload.decryptAsIncoming(privateValues, sk);
-        if (!decryptedLog) {
-            return undefined;
-        }
-        return this.fromIncomingBodyPlaintextContractAndPublicValues(decryptedLog.incomingBodyPlaintext, decryptedLog.contractAddress, publicValues);
-    }
-    /**
-   * Serializes the L1NotePayload object into a Buffer.
-   * @returns Buffer representation of the L1NotePayload object.
-   */ toIncomingBodyPlaintext() {
-        const fields = [
-            this.storageSlot,
-            this.noteTypeId.toField(),
-            ...this.privateNoteValues
-        ];
-        return serializeToBuffer(fields);
-    }
-    /**
-   * Create a random L1NotePayload object (useful for testing purposes).
-   * @param contract - The address of a contract the note was emitted from.
-   * @returns A random L1NotePayload object.
-   */ static async random(contract) {
-        const numPrivateNoteValues = randomInt(2) + 1;
-        const privateNoteValues = Array.from({
-            length: numPrivateNoteValues
-        }, ()=>Fr.random());
-        const numPublicNoteValues = randomInt(2) + 1;
-        const publicNoteValues = Array.from({
-            length: numPublicNoteValues
-        }, ()=>Fr.random());
-        return new L1NotePayload(contract ?? await AztecAddress.random(), Fr.random(), NoteSelector.random(), privateNoteValues, publicNoteValues);
-    }
-    equals(other) {
-        return this.contractAddress.equals(other.contractAddress) && this.storageSlot.equals(other.storageSlot) && this.noteTypeId.equals(other.noteTypeId) && this.privateNoteValues.every((value, index)=>value.equals(other.privateNoteValues[index])) && this.publicNoteValues.every((value, index)=>value.equals(other.publicNoteValues[index]));
-    }
-    toBuffer() {
-        return serializeToBuffer(this.contractAddress, this.storageSlot, this.noteTypeId, new Vector(this.privateNoteValues), new Vector(this.publicNoteValues));
-    }
-    static fromBuffer(buffer) {
-        const reader = BufferReader.asReader(buffer);
-        return new L1NotePayload(reader.readObject(AztecAddress), reader.readObject(Fr), reader.readObject(NoteSelector), reader.readVector(Fr), reader.readVector(Fr));
-    }
-}
-/**
- * Parse the given log into an array of public values and an encrypted log.
- *
- * @param log - Log to be parsed.
- * @returns An object containing the public values, encrypted log, and ciphertext length.
- */ function parseLogFromPublic(log) {
-    // Extract lengths from the log
-    // See aztec_nr/aztec/src/macros/note/mod.nr to see how the "finalization_log" is encoded.
-    // Each length is stored in 2 bytes with a 0 separator byte between them:
-    // [ publicLen[0], publicLen[1], 0, privateLen[0], privateLen[1] ]
-    // Search the codebase for "disgusting encoding" to see other hardcoded instances of this encoding, that you might need to change if you ever find yourself here.
-    const lengths = log.log[0].toBuffer().subarray(-5);
-    const publicValuesLength = lengths.readUint16BE();
-    const privateValuesLength = lengths.readUint16BE(3);
-    // Now we get the fields corresponding to the values generated from private.
-    // Note: +1 for the length values in position 0
-    const privateValues = log.log.slice(1, 1 + privateValuesLength);
-    // At last we load the public values
-    const publicValues = log.log.slice(1 + privateValuesLength, 1 + privateValuesLength + publicValuesLength);
-    return {
-        publicValues,
-        privateValues
-    };
-}

package/src/logs/l1_payload/l1_note_payload.ts

@@ -1,182 +0,0 @@
-import { randomInt } from '@aztec/foundation/crypto';
-import { type Fq, Fr } from '@aztec/foundation/fields';
-import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
-
-import { NoteSelector } from '../../abi/note_selector.js';
-import { AztecAddress } from '../../aztec-address/index.js';
-import { Vector } from '../../types/index.js';
-import type { PrivateLog } from '../private_log.js';
-import { PublicLog } from '../public_log.js';
-import { EncryptedLogPayload } from './encrypted_log_payload.js';
-
-/**
- * A class which wraps note data which is pushed on L1.
- * @remarks This data is required to compute a nullifier/to spend a note. Along with that this class contains
- * the necessary functionality to encrypt and decrypt the data.
- */
-export class L1NotePayload {
-  constructor(
-    /**
-     * Address of the contract this tx is interacting with.
-     */
-    public contractAddress: AztecAddress,
-    /**
-     * Storage slot of the underlying note.
-     */
-    public storageSlot: Fr,
-    /**
-     * Type identifier for the underlying note, required to determine how to compute its hash and nullifier.
-     */
-    public noteTypeId: NoteSelector,
-    /**
-     * Note values delivered encrypted.
-     * @dev Note that to recreate the correct note we need to merge privateNoteValues and publicNoteValues. To do that
-     * we need access to the contract ABI (that is done in the NoteProcessor).
-     */
-    public privateNoteValues: Fr[],
-    /**
-     * Note values delivered in plaintext.
-     * @dev Note that to recreate the correct note we need to merge privateNoteValues and publicNoteValues. To do that
-     * we need access to the contract ABI (that is done in the NoteProcessor).
-     */
-    public publicNoteValues: Fr[],
-  ) {}
-
-  static fromIncomingBodyPlaintextContractAndPublicValues(
-    plaintext: Buffer,
-    contractAddress: AztecAddress,
-    publicNoteValues: Fr[],
-  ): L1NotePayload | undefined {
-    try {
-      const reader = BufferReader.asReader(plaintext);
-      const fields = reader.readArray(plaintext.length / Fr.SIZE_IN_BYTES, Fr);
-
-      const storageSlot = fields[0];
-      const noteTypeId = NoteSelector.fromField(fields[1]);
-
-      const privateNoteValues = fields.slice(2);
-
-      return new L1NotePayload(contractAddress, storageSlot, noteTypeId, privateNoteValues, publicNoteValues);
-    } catch (e) {
-      return undefined;
-    }
-  }
-
-  static async decryptAsIncoming(log: PrivateLog, sk: Fq): Promise<L1NotePayload | undefined> {
-    const decryptedLog = await EncryptedLogPayload.decryptAsIncoming(log.fields, sk);
-    if (!decryptedLog) {
-      return undefined;
-    }
-
-    return this.fromIncomingBodyPlaintextContractAndPublicValues(
-      decryptedLog.incomingBodyPlaintext,
-      decryptedLog.contractAddress,
-      /* publicValues */ [],
-    );
-  }
-
-  static async decryptAsIncomingFromPublic(log: PublicLog, sk: Fq): Promise<L1NotePayload | undefined> {
-    const { privateValues, publicValues } = parseLogFromPublic(log);
-    if (!privateValues) {
-      return undefined;
-    }
-
-    const decryptedLog = await EncryptedLogPayload.decryptAsIncoming(privateValues, sk);
-    if (!decryptedLog) {
-      return undefined;
-    }
-
-    return this.fromIncomingBodyPlaintextContractAndPublicValues(
-      decryptedLog.incomingBodyPlaintext,
-      decryptedLog.contractAddress,
-      publicValues,
-    );
-  }
-
-  /**
-   * Serializes the L1NotePayload object into a Buffer.
-   * @returns Buffer representation of the L1NotePayload object.
-   */
-  toIncomingBodyPlaintext() {
-    const fields = [this.storageSlot, this.noteTypeId.toField(), ...this.privateNoteValues];
-    return serializeToBuffer(fields);
-  }
-
-  /**
-   * Create a random L1NotePayload object (useful for testing purposes).
-   * @param contract - The address of a contract the note was emitted from.
-   * @returns A random L1NotePayload object.
-   */
-  static async random(contract?: AztecAddress) {
-    const numPrivateNoteValues = randomInt(2) + 1;
-    const privateNoteValues = Array.from({ length: numPrivateNoteValues }, () => Fr.random());
-
-    const numPublicNoteValues = randomInt(2) + 1;
-    const publicNoteValues = Array.from({ length: numPublicNoteValues }, () => Fr.random());
-
-    return new L1NotePayload(
-      contract ?? (await AztecAddress.random()),
-      Fr.random(),
-      NoteSelector.random(),
-      privateNoteValues,
-      publicNoteValues,
-    );
-  }
-
-  public equals(other: L1NotePayload) {
-    return (
-      this.contractAddress.equals(other.contractAddress) &&
-      this.storageSlot.equals(other.storageSlot) &&
-      this.noteTypeId.equals(other.noteTypeId) &&
-      this.privateNoteValues.every((value, index) => value.equals(other.privateNoteValues[index])) &&
-      this.publicNoteValues.every((value, index) => value.equals(other.publicNoteValues[index]))
-    );
-  }
-
-  toBuffer() {
-    return serializeToBuffer(
-      this.contractAddress,
-      this.storageSlot,
-      this.noteTypeId,
-      new Vector(this.privateNoteValues),
-      new Vector(this.publicNoteValues),
-    );
-  }
-
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new L1NotePayload(
-      reader.readObject(AztecAddress),
-      reader.readObject(Fr),
-      reader.readObject(NoteSelector),
-      reader.readVector(Fr),
-      reader.readVector(Fr),
-    );
-  }
-}
-
-/**
- * Parse the given log into an array of public values and an encrypted log.
- *
- * @param log - Log to be parsed.
- * @returns An object containing the public values, encrypted log, and ciphertext length.
- */
-function parseLogFromPublic(log: PublicLog) {
-  // Extract lengths from the log
-  // See aztec_nr/aztec/src/macros/note/mod.nr to see how the "finalization_log" is encoded.
-  // Each length is stored in 2 bytes with a 0 separator byte between them:
-  // [ publicLen[0], publicLen[1], 0, privateLen[0], privateLen[1] ]
-  // Search the codebase for "disgusting encoding" to see other hardcoded instances of this encoding, that you might need to change if you ever find yourself here.
-  const lengths = log.log[0].toBuffer().subarray(-5);
-  const publicValuesLength = lengths.readUint16BE();
-  const privateValuesLength = lengths.readUint16BE(3);
-
-  // Now we get the fields corresponding to the values generated from private.
-  // Note: +1 for the length values in position 0
-  const privateValues = log.log.slice(1, 1 + privateValuesLength);
-
-  // At last we load the public values
-  const publicValues = log.log.slice(1 + privateValuesLength, 1 + privateValuesLength + publicValuesLength);
-
-  return { publicValues, privateValues };
-}