@aztec/stdlib 0.0.0-test.1 → 0.0.1-commit.0b941701

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 };
-}

package/src/logs/l1_payload/payload.ts

@@ -1,73 +0,0 @@
-import { randomInt } from '@aztec/foundation/crypto';
-import { Fr } from '@aztec/foundation/fields';
-import { BufferReader } from '@aztec/foundation/serialize';
-import { bufferToHex, hexToBuffer } from '@aztec/foundation/string';
-
-import { schemas } from '../../schemas/index.js';
-import { Vector } from '../../types/index.js';
-
-/**
- * The Note class represents a Note emitted from a Noir contract as a vector of Fr (finite field) elements.
- * This data also represents a preimage to a note hash. This class extends the Vector class, which allows for
- * additional operations on the underlying field elements.
- */
-export class Payload extends Vector<Fr> {
-  toJSON() {
-    return this.toBuffer();
-  }
-
-  static get schema() {
-    return schemas.Buffer.transform(Payload.fromBuffer);
-  }
-
-  /**
-   * Create a Note instance from a Buffer or BufferReader.
-   * The input 'buffer' can be either a Buffer containing the serialized Fr elements or a BufferReader instance.
-   * This function reads the Fr elements in the buffer and constructs a Note with them.
-   *
-   * @param buffer - The Buffer or BufferReader containing the serialized Fr elements.
-   * @returns A Note instance containing the deserialized Fr elements.
-   */
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new Payload(reader.readVector(Fr));
-  }
-
-  /**
-   * Generates a random Note instance with a variable number of items.
-   * The number of items is determined by a random value between 1 and 10 (inclusive).
-   * Each item in the Note is generated using the Fr.random() method.
-   *
-   * @returns A randomly generated Note instance.
-   */
-  static random() {
-    const numItems = randomInt(10) + 1;
-    const items = Array.from({ length: numItems }, () => Fr.random());
-    return new Payload(items);
-  }
-
-  /**
-   * Returns a hex representation of the note.
-   * @returns A hex string with the vector length as first element.
-   */
-  override toString() {
-    return bufferToHex(this.toBuffer());
-  }
-
-  /**
-   * Creates a new Note instance from a hex string.
-   * @param str - Hex representation.
-   * @returns A Note instance.
-   */
-  static fromString(str: string) {
-    return Payload.fromBuffer(hexToBuffer(str));
-  }
-
-  get length() {
-    return this.items.length;
-  }
-
-  equals(other: Payload) {
-    return this.items.every((item, index) => item.equals(other.items[index]));
-  }
-}

package/src/logs/l1_payload/shared_secret_derivation.ts

@@ -1,35 +0,0 @@
-import { Grumpkin } from '@aztec/foundation/crypto';
-import type { GrumpkinScalar, Point } from '@aztec/foundation/fields';
-
-import type { AztecAddress } from '../../aztec-address/index.js';
-import type { PublicKey } from '../../keys/public_key.js';
-
-/**
- * Derive an Elliptic Curve Diffie-Hellman (ECDH) Shared Secret.
- * The function takes in an ECDH public key, a private key, and a Grumpkin instance to compute
- * the shared secret.
- *
- * @param secretKey - The secret key used to derive shared secret.
- * @param publicKey - The public key used to derive shared secret.
- * @returns A derived shared secret.
- * @throws If the publicKey is zero.
- */
-export async function deriveEcdhSharedSecret(secretKey: GrumpkinScalar, publicKey: PublicKey): Promise<Point> {
-  if (publicKey.isZero()) {
-    throw new Error(
-      `Attempting to derive a shared secret with a zero public key. You have probably passed a zero public key in your Noir code somewhere thinking that the note won't be broadcast... but it was.`,
-    );
-  }
-  const curve = new Grumpkin();
-  const sharedSecret = await curve.mul(publicKey, secretKey);
-  return sharedSecret;
-}
-
-export async function deriveEcdhSharedSecretUsingAztecAddress(
-  secretKey: GrumpkinScalar,
-  address: AztecAddress,
-): Promise<Point> {
-  const addressPoint = await address.toAddressPoint();
-  const sharedSecret = await deriveEcdhSharedSecret(secretKey, addressPoint);
-  return sharedSecret;
-}

package/src/logs/log_with_tx_data.ts

@@ -1,36 +0,0 @@
-import { MAX_NOTE_HASHES_PER_TX, PUBLIC_LOG_DATA_SIZE_IN_FIELDS } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/fields';
-
-// TypeScript representation of the Noir aztec::oracle::note_discovery::LogWithTxData struct. This is used as a response
-// for PXE's custom getLogByTag oracle.
-export class LogWithTxData {
-  constructor(
-    public logContent: Fr[],
-    public txHash: Fr,
-    public uniqueNoteHashesInTx: Fr[],
-    public firstNullifierInTx: Fr,
-  ) {}
-
-  toNoirSerialization(): (Fr | Fr[])[] {
-    return [
-      ...toBoundedVecSerialization(this.logContent, PUBLIC_LOG_DATA_SIZE_IN_FIELDS),
-      this.txHash,
-      ...toBoundedVecSerialization(this.uniqueNoteHashesInTx, MAX_NOTE_HASHES_PER_TX),
-      this.firstNullifierInTx,
-    ];
-  }
-
-  static noirSerializationOfEmpty(): (Fr | Fr[])[] {
-    return new LogWithTxData([], new Fr(0), [], new Fr(0)).toNoirSerialization();
-  }
-}
-
-function toBoundedVecSerialization(array: Fr[], maxLength: number) {
-  if (array.length > maxLength) {
-    throw new Error(
-      `An array of length ${array.length} cannot be converted to a BoundedVec of max length ${maxLength}`,
-    );
-  }
-
-  return [array.concat(Array(maxLength - array.length).fill(new Fr(0))), new Fr(array.length)];
-}

package/src/network/index.ts

@@ -1,32 +0,0 @@
-/**
- * Deployed aztec networks & their names.
- */
-export enum Network {
-  DEVNET = 'devnet',
-  PROVERNET = 'provernet',
-  ALPHANET = 'alphanet',
-}
-
-/**
- * Map of basic contracts deployed for each network.
- */
-export const L2BasicContractsMap = {
-  [Network.DEVNET]: {
-    devCoin: 'TokenContract',
-    devCoinBridge: 'TokenBridgeContract',
-    devCoinFpc: 'FPCContract',
-    counter: 'CounterContract',
-  },
-  [Network.PROVERNET]: {
-    devCoin: 'TokenContract',
-    devCoinBridge: 'TokenBridgeContract',
-    devCoinFpc: 'FPCContract',
-    counter: 'CounterContract',
-  },
-  [Network.ALPHANET]: {
-    devCoin: 'TokenContract',
-    devCoinBridge: 'TokenBridgeContract',
-    devCoinFpc: 'FPCContract',
-    counter: 'CounterContract',
-  },
-};

package/src/note/extended_note.ts

@@ -1,168 +0,0 @@
-import { Fr } from '@aztec/foundation/fields';
-import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
-import { bufferToHex, hexToBuffer } from '@aztec/foundation/string';
-
-import { z } from 'zod';
-
-import { NoteSelector } from '../abi/note_selector.js';
-import { AztecAddress } from '../aztec-address/index.js';
-import { type ZodFor, schemas } from '../schemas/index.js';
-import { TxHash } from '../tx/tx_hash.js';
-import { Note } from './note.js';
-
-/**
- * A note with contextual data.
- */
-export class ExtendedNote {
-  constructor(
-    /** The note as emitted from the Noir contract. */
-    public note: Note,
-    /** The owner whose public key was used to encrypt the note. */
-    public owner: AztecAddress,
-    /** The contract address this note is created in. */
-    public contractAddress: AztecAddress,
-    /** The specific storage location of the note on the contract. */
-    public storageSlot: Fr,
-    /** The type identifier of the note on the contract. */
-    public noteTypeId: NoteSelector,
-    /** The hash of the tx the note was created in. */
-    public txHash: TxHash,
-  ) {}
-
-  toBuffer(): Buffer {
-    return serializeToBuffer([
-      this.note,
-      this.owner,
-      this.contractAddress,
-      this.storageSlot,
-      this.noteTypeId,
-      this.txHash,
-    ]);
-  }
-
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-
-    const note = reader.readObject(Note);
-    const owner = reader.readObject(AztecAddress);
-    const contractAddress = reader.readObject(AztecAddress);
-    const storageSlot = reader.readObject(Fr);
-    const noteTypeId = reader.readObject(NoteSelector);
-    const txHash = reader.readObject(TxHash);
-
-    return new this(note, owner, contractAddress, storageSlot, noteTypeId, txHash);
-  }
-
-  static get schema(): ZodFor<ExtendedNote> {
-    return z
-      .object({
-        note: Note.schema,
-        owner: schemas.AztecAddress,
-        contractAddress: schemas.AztecAddress,
-        storageSlot: schemas.Fr,
-        noteTypeId: schemas.NoteSelector,
-        txHash: TxHash.schema,
-      })
-      .transform(({ note, owner, contractAddress, storageSlot, noteTypeId, txHash }) => {
-        return new ExtendedNote(note, owner, contractAddress, storageSlot, noteTypeId, txHash);
-      });
-  }
-
-  toString() {
-    return bufferToHex(this.toBuffer());
-  }
-
-  static fromString(str: string) {
-    return ExtendedNote.fromBuffer(hexToBuffer(str));
-  }
-
-  static async random() {
-    return new ExtendedNote(
-      Note.random(),
-      await AztecAddress.random(),
-      await AztecAddress.random(),
-      Fr.random(),
-      NoteSelector.random(),
-      TxHash.random(),
-    );
-  }
-}
-
-export class UniqueNote extends ExtendedNote {
-  constructor(
-    /** The note as emitted from the Noir contract. */
-    note: Note,
-    /** The owner whose public key was used to encrypt the note. */
-    owner: AztecAddress,
-    /** The contract address this note is created in. */
-    contractAddress: AztecAddress,
-    /** The specific storage location of the note on the contract. */
-    storageSlot: Fr,
-    /** The type identifier of the note on the contract. */
-    noteTypeId: NoteSelector,
-    /** The hash of the tx the note was created in. */
-    txHash: TxHash,
-    /** The nonce of the note. */
-    public nonce: Fr,
-  ) {
-    super(note, owner, contractAddress, storageSlot, noteTypeId, txHash);
-  }
-
-  static override get schema() {
-    return z
-      .object({
-        note: Note.schema,
-        owner: schemas.AztecAddress,
-        contractAddress: schemas.AztecAddress,
-        storageSlot: schemas.Fr,
-        noteTypeId: schemas.NoteSelector,
-        txHash: TxHash.schema,
-        nonce: schemas.Fr,
-      })
-      .transform(({ note, owner, contractAddress, storageSlot, noteTypeId, txHash, nonce }) => {
-        return new UniqueNote(note, owner, contractAddress, storageSlot, noteTypeId, txHash, nonce);
-      });
-  }
-
-  override toBuffer(): Buffer {
-    return serializeToBuffer([
-      this.note,
-      this.owner,
-      this.contractAddress,
-      this.storageSlot,
-      this.noteTypeId,
-      this.txHash,
-      this.nonce,
-    ]);
-  }
-
-  static override async random() {
-    return new UniqueNote(
-      Note.random(),
-      await AztecAddress.random(),
-      await AztecAddress.random(),
-      Fr.random(),
-      NoteSelector.random(),
-      TxHash.random(),
-      Fr.random(),
-    );
-  }
-
-  static override fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-
-    const note = reader.readObject(Note);
-    const owner = reader.readObject(AztecAddress);
-    const contractAddress = reader.readObject(AztecAddress);
-    const storageSlot = reader.readObject(Fr);
-    const noteTypeId = reader.readObject(NoteSelector);
-    const txHash = reader.readObject(TxHash);
-    const nonce = reader.readObject(Fr);
-
-    return new this(note, owner, contractAddress, storageSlot, noteTypeId, txHash, nonce);
-  }
-
-  static override fromString(str: string) {
-    return UniqueNote.fromBuffer(hexToBuffer(str));
-  }
-}

package/src/p2p/block_attestation.ts

@@ -1,107 +0,0 @@
-import { Buffer32 } from '@aztec/foundation/buffer';
-import { keccak256, recoverAddress } from '@aztec/foundation/crypto';
-import type { EthAddress } from '@aztec/foundation/eth-address';
-import { Signature } from '@aztec/foundation/eth-signature';
-import type { Fr } from '@aztec/foundation/fields';
-import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
-
-import { z } from 'zod';
-
-import type { ZodFor } from '../schemas/index.js';
-import { ConsensusPayload } from './consensus_payload.js';
-import { Gossipable } from './gossipable.js';
-import { SignatureDomainSeparator, getHashedSignaturePayloadEthSignedMessage } from './signature_utils.js';
-import { TopicType, createTopicString } from './topic_type.js';
-
-export class BlockAttestationHash extends Buffer32 {
-  constructor(hash: Buffer) {
-    super(hash);
-  }
-}
-
-/**
- * BlockAttestation
- *
- * A validator that has attested to seeing the contents of a block
- * will produce a block attestation over the header of the block
- */
-export class BlockAttestation extends Gossipable {
-  static override p2pTopic = createTopicString(TopicType.block_attestation);
-
-  private sender: EthAddress | undefined;
-
-  constructor(
-    /** The payload of the message, and what the signature is over */
-    public readonly payload: ConsensusPayload,
-
-    /** The signature of the block attester */
-    public readonly signature: Signature,
-  ) {
-    super();
-  }
-
-  static get schema(): ZodFor<BlockAttestation> {
-    return z
-      .object({
-        payload: ConsensusPayload.schema,
-        signature: Signature.schema,
-      })
-      .transform(obj => new BlockAttestation(obj.payload, obj.signature));
-  }
-
-  override p2pMessageIdentifier(): Promise<Buffer32> {
-    return Promise.resolve(new BlockAttestationHash(keccak256(this.signature.toBuffer())));
-  }
-
-  get archive(): Fr {
-    return this.payload.archive;
-  }
-
-  get slotNumber(): Fr {
-    return this.payload.header.globalVariables.slotNumber;
-  }
-
-  get blockNumber(): Fr {
-    return this.payload.header.globalVariables.blockNumber;
-  }
-
-  /**Get sender
-   *
-   * Lazily evaluate and cache the sender of the attestation
-   * @returns The sender of the attestation
-   */
-  async getSender(): Promise<EthAddress> {
-    if (!this.sender) {
-      // Recover the sender from the attestation
-      const hashed = await getHashedSignaturePayloadEthSignedMessage(
-        this.payload,
-        SignatureDomainSeparator.blockAttestation,
-      );
-      // Cache the sender for later use
-      this.sender = recoverAddress(hashed, this.signature);
-    }
-
-    return this.sender;
-  }
-
-  getPayload(): Promise<Buffer> {
-    return this.payload.getPayloadToSign(SignatureDomainSeparator.blockAttestation);
-  }
-
-  toBuffer(): Buffer {
-    return serializeToBuffer([this.payload, this.signature]);
-  }
-
-  static fromBuffer(buf: Buffer | BufferReader): BlockAttestation {
-    const reader = BufferReader.asReader(buf);
-    return new BlockAttestation(reader.readObject(ConsensusPayload), reader.readObject(Signature));
-  }
-
-  static empty(): BlockAttestation {
-    return new BlockAttestation(ConsensusPayload.empty(), Signature.empty());
-  }
-
-  getSize(): number {
-    return this.payload.getSize() + this.signature.getSize();
-  }
-}