@aztec/stdlib 0.0.1-commit.b655e406 → 0.0.1-commit.c2595eba

package/src/block/l2_block_header.ts

@@ -1,232 +0,0 @@
-import { Fr } from '@aztec/foundation/fields';
-import { type ZodFor, schemas } from '@aztec/foundation/schemas';
-import { BufferReader, FieldReader, serializeToBuffer, serializeToFields } from '@aztec/foundation/serialize';
-import { bufferToHex, hexToBuffer } from '@aztec/foundation/string';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-import { inspect } from 'util';
-import { z } from 'zod';
-
-import { CheckpointHeader } from '../rollup/checkpoint_header.js';
-import { AppendOnlyTreeSnapshot } from '../trees/append_only_tree_snapshot.js';
-import { BlockHeader, ContentCommitment, GlobalVariables, StateReference } from '../tx/index.js';
-
-/**
- * TO BE DELETED
- *
- * A header of an L2 block combining the block header and the checkpoint header.
- * This is a temporary workaround to avoid changing too many things before building in chunks is properly implemented.
- * This works for now because we only have one block per checkpoint.
- *
- * @deprecated Use BlockHeader or CheckpointHeader instead.
- */
-export class L2BlockHeader {
-  constructor(
-    /** Snapshot of archive before the block is applied. */
-    public lastArchive: AppendOnlyTreeSnapshot,
-    /** Hash of the body of an L2 block. */
-    public contentCommitment: ContentCommitment,
-    /** State reference. */
-    public state: StateReference,
-    /** Global variables of an L2 block. */
-    public globalVariables: GlobalVariables,
-    /** Total fees in the block, computed by the root rollup circuit */
-    public totalFees: Fr,
-    /** Total mana used in the block, computed by the root rollup circuit */
-    public totalManaUsed: Fr,
-    /** Hash of the sponge blob of the block. */
-    public spongeBlobHash: Fr,
-  ) {}
-
-  static get schema(): ZodFor<L2BlockHeader> {
-    return z
-      .object({
-        lastArchive: AppendOnlyTreeSnapshot.schema,
-        contentCommitment: ContentCommitment.schema,
-        state: StateReference.schema,
-        globalVariables: GlobalVariables.schema,
-        totalFees: schemas.Fr,
-        totalManaUsed: schemas.Fr,
-        spongeBlobHash: schemas.Fr,
-      })
-      .transform(L2BlockHeader.from);
-  }
-
-  static getFields(fields: FieldsOf<L2BlockHeader>) {
-    return [
-      fields.lastArchive,
-      fields.contentCommitment,
-      fields.state,
-      fields.globalVariables,
-      fields.totalFees,
-      fields.totalManaUsed,
-      fields.spongeBlobHash,
-    ] as const;
-  }
-
-  static from(fields: FieldsOf<L2BlockHeader>) {
-    return new L2BlockHeader(...L2BlockHeader.getFields(fields));
-  }
-
-  getSlot() {
-    return this.globalVariables.slotNumber.toBigInt();
-  }
-
-  getBlockNumber() {
-    return this.globalVariables.blockNumber;
-  }
-
-  getSize() {
-    return (
-      this.lastArchive.getSize() +
-      this.contentCommitment.getSize() +
-      this.state.getSize() +
-      this.globalVariables.getSize() +
-      this.totalFees.size +
-      this.totalManaUsed.size +
-      this.spongeBlobHash.size
-    );
-  }
-
-  toBuffer() {
-    return serializeToBuffer(...L2BlockHeader.getFields(this));
-  }
-
-  toFields(): Fr[] {
-    return serializeToFields(...L2BlockHeader.getFields(this));
-  }
-
-  clone() {
-    return L2BlockHeader.fromBuffer(this.toBuffer());
-  }
-
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-
-    return new L2BlockHeader(
-      reader.readObject(AppendOnlyTreeSnapshot),
-      reader.readObject(ContentCommitment),
-      reader.readObject(StateReference),
-      reader.readObject(GlobalVariables),
-      reader.readObject(Fr),
-      reader.readObject(Fr),
-      reader.readObject(Fr),
-    );
-  }
-
-  static fromFields(fields: Fr[] | FieldReader) {
-    const reader = FieldReader.asReader(fields);
-
-    return new L2BlockHeader(
-      AppendOnlyTreeSnapshot.fromFields(reader),
-      ContentCommitment.fromFields(reader),
-      StateReference.fromFields(reader),
-      GlobalVariables.fromFields(reader),
-      reader.readField(),
-      reader.readField(),
-      reader.readField(),
-    );
-  }
-
-  static empty(fields: Partial<FieldsOf<L2BlockHeader>> = {}) {
-    return L2BlockHeader.from({
-      lastArchive: AppendOnlyTreeSnapshot.empty(),
-      contentCommitment: ContentCommitment.empty(),
-      state: StateReference.empty(),
-      globalVariables: GlobalVariables.empty(),
-      totalFees: Fr.ZERO,
-      totalManaUsed: Fr.ZERO,
-      spongeBlobHash: Fr.ZERO,
-      ...fields,
-    });
-  }
-
-  isEmpty(): boolean {
-    return (
-      this.lastArchive.isEmpty() &&
-      this.contentCommitment.isEmpty() &&
-      this.state.isEmpty() &&
-      this.globalVariables.isEmpty() &&
-      this.totalFees.isZero() &&
-      this.totalManaUsed.isZero() &&
-      this.spongeBlobHash.isZero()
-    );
-  }
-
-  /**
-   * Serializes this instance into a string.
-   * @returns Encoded string.
-   */
-  public toString() {
-    return bufferToHex(this.toBuffer());
-  }
-
-  static fromString(str: string) {
-    return L2BlockHeader.fromBuffer(hexToBuffer(str));
-  }
-
-  toCheckpointHeader() {
-    return new CheckpointHeader(
-      this.lastArchive.root,
-      this.contentCommitment,
-      this.globalVariables.slotNumber,
-      this.globalVariables.timestamp,
-      this.globalVariables.coinbase,
-      this.globalVariables.feeRecipient,
-      this.globalVariables.gasFees,
-      this.totalManaUsed,
-    );
-  }
-
-  toBlockHeader() {
-    return new BlockHeader(
-      this.lastArchive,
-      this.state,
-      this.spongeBlobHash,
-      this.globalVariables,
-      this.totalFees,
-      this.totalManaUsed,
-    );
-  }
-
-  toInspect() {
-    return {
-      lastArchive: this.lastArchive.root.toString(),
-      contentCommitment: this.contentCommitment.toInspect(),
-      state: this.state.toInspect(),
-      globalVariables: this.globalVariables.toInspect(),
-      totalFees: this.totalFees.toBigInt(),
-      totalManaUsed: this.totalManaUsed.toBigInt(),
-      spongeBlobHash: this.spongeBlobHash.toString(),
-    };
-  }
-
-  [inspect.custom]() {
-    return `L2BlockHeader {
-  lastArchive: ${inspect(this.lastArchive)},
-  contentCommitment.blobsHash: ${inspect(this.contentCommitment.blobsHash)},
-  contentCommitment.inHash: ${inspect(this.contentCommitment.inHash)},
-  contentCommitment.outHash: ${inspect(this.contentCommitment.outHash)},
-  state.l1ToL2MessageTree: ${inspect(this.state.l1ToL2MessageTree)},
-  state.noteHashTree: ${inspect(this.state.partial.noteHashTree)},
-  state.nullifierTree: ${inspect(this.state.partial.nullifierTree)},
-  state.publicDataTree: ${inspect(this.state.partial.publicDataTree)},
-  globalVariables: ${inspect(this.globalVariables)},
-  totalFees: ${this.totalFees},
-  totalManaUsed: ${this.totalManaUsed},
-  spongeBlobHash: ${this.spongeBlobHash},
-}`;
-  }
-
-  public equals(other: this): boolean {
-    return (
-      this.contentCommitment.equals(other.contentCommitment) &&
-      this.state.equals(other.state) &&
-      this.globalVariables.equals(other.globalVariables) &&
-      this.totalFees.equals(other.totalFees) &&
-      this.totalManaUsed.equals(other.totalManaUsed) &&
-      this.lastArchive.equals(other.lastArchive) &&
-      this.spongeBlobHash.equals(other.spongeBlobHash)
-    );
-  }
-}

package/src/block/l2_block_number.ts

@@ -1,8 +0,0 @@
-import { z } from 'zod';
-
-import { schemas } from '../schemas/index.js';
-
-export const L2BlockNumberSchema = z.union([schemas.Integer, z.literal('latest')]);
-
-/** Helper type for a specific L2 block number or the latest block number */
-export type L2BlockNumber = z.infer<typeof L2BlockNumberSchema>;

package/src/block/published_l2_block.ts

@@ -1,82 +0,0 @@
-// Ignoring import issue to fix portable inferred type issue in zod schema
-import { Buffer32 } from '@aztec/foundation/buffer';
-import { randomBigInt } from '@aztec/foundation/crypto';
-import { schemas } from '@aztec/foundation/schemas';
-import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-import { z } from 'zod';
-
-import { L2Block } from './l2_block.js';
-import { CommitteeAttestation } from './proposal/committee_attestation.js';
-
-export class L1PublishedData {
-  constructor(
-    public blockNumber: bigint,
-    public timestamp: bigint,
-    public blockHash: string,
-  ) {}
-
-  static get schema() {
-    return z.object({
-      blockNumber: schemas.BigInt,
-      timestamp: schemas.BigInt,
-      blockHash: z.string(),
-    });
-  }
-
-  static random() {
-    return new L1PublishedData(
-      randomBigInt(1000n) + 1n,
-      BigInt(Math.floor(Date.now() / 1000)),
-      Buffer32.random().toString(),
-    );
-  }
-
-  static fromFields(fields: FieldsOf<L1PublishedData>) {
-    return new L1PublishedData(fields.blockNumber, fields.timestamp, fields.blockHash);
-  }
-}
-
-export class PublishedL2Block {
-  constructor(
-    public block: L2Block,
-    public l1: L1PublishedData,
-    public attestations: CommitteeAttestation[],
-  ) {}
-
-  static get schema() {
-    return z
-      .object({
-        block: L2Block.schema,
-        l1: L1PublishedData.schema,
-        attestations: z.array(CommitteeAttestation.schema),
-      })
-      .transform(obj => PublishedL2Block.fromFields(obj));
-  }
-
-  static fromBuffer(bufferOrReader: Buffer | BufferReader): PublishedL2Block {
-    const reader = BufferReader.asReader(bufferOrReader);
-    const block = reader.readObject(L2Block);
-    const l1BlockNumber = reader.readBigInt();
-    const l1BlockHash = reader.readString();
-    const l1Timestamp = reader.readBigInt();
-    const attestations = reader.readVector(CommitteeAttestation);
-    return new PublishedL2Block(block, new L1PublishedData(l1BlockNumber, l1Timestamp, l1BlockHash), attestations);
-  }
-
-  static fromFields(fields: FieldsOf<PublishedL2Block>) {
-    return new PublishedL2Block(fields.block, fields.l1, fields.attestations);
-  }
-
-  public toBuffer(): Buffer {
-    return serializeToBuffer(
-      this.block,
-      this.l1.blockNumber,
-      this.l1.blockHash,
-      this.l1.timestamp,
-      this.attestations.length,
-      this.attestations,
-    );
-  }
-}

package/src/checkpoint/checkpoint_body.ts

@@ -1,10 +0,0 @@
-import { Fr } from '@aztec/foundation/fields';
-
-import { getBlockBlobFields } from '../block/body.js';
-import type { TxEffect } from '../tx/tx_effect.js';
-
-export function getCheckpointBlobFields(txEffectsInBlocks: TxEffect[][]) {
-  const blockBlobFields = txEffectsInBlocks.map(blockTxEffects => getBlockBlobFields(blockTxEffects)).flat();
-  const totalNumBlobFields = blockBlobFields.length + 1; // +1 for the prefix indicating the number of total blob fields in a checkpoint.
-  return [new Fr(totalNumBlobFields)].concat(blockBlobFields);
-}

package/src/contract/contract_class_metadata.ts

@@ -1,8 +0,0 @@
-import type { ContractArtifact } from '../abi/abi.js';
-import type { ContractClassWithId } from './interfaces/contract_class.js';
-
-export interface ContractClassMetadata {
-  contractClass?: ContractClassWithId | undefined;
-  isContractClassPubliclyRegistered: boolean;
-  artifact?: ContractArtifact | undefined;
-}

package/src/contract/contract_metadata.ts

@@ -1,7 +0,0 @@
-import type { ContractInstanceWithAddress } from './interfaces/contract_instance.js';
-
-export interface ContractMetadata {
-  contractInstance?: ContractInstanceWithAddress | undefined;
-  isContractInitialized: boolean;
-  isContractPublished: boolean;
-}

package/src/logs/log_with_tx_data.ts

@@ -1,46 +0,0 @@
-import { MAX_NOTE_HASHES_PER_TX, PRIVATE_LOG_CIPHERTEXT_LEN } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/fields';
-import { TxHash } from '@aztec/stdlib/tx';
-
-// This is used as a response for PXE's custom getPublicLogByTag oracle.
-export class PublicLogWithTxData {
-  constructor(
-    public logPayload: Fr[],
-    public txHash: TxHash,
-    public uniqueNoteHashesInTx: Fr[],
-    public firstNullifierInTx: Fr,
-  ) {}
-}
-
-// This is used as a response for PXE's custom getPrivateLogByTag oracle.
-export class PrivateLogWithTxData {
-  constructor(
-    public logPayload: Fr[],
-    public txHash: TxHash,
-    public uniqueNoteHashesInTx: Fr[],
-    public firstNullifierInTx: Fr,
-  ) {}
-
-  toNoirSerialization(): (Fr | Fr[])[] {
-    return [
-      ...toBoundedVecSerialization(this.logPayload, PRIVATE_LOG_CIPHERTEXT_LEN),
-      this.txHash.hash,
-      ...toBoundedVecSerialization(this.uniqueNoteHashesInTx, MAX_NOTE_HASHES_PER_TX),
-      this.firstNullifierInTx,
-    ];
-  }
-
-  static noirSerializationOfEmpty(): (Fr | Fr[])[] {
-    return new PrivateLogWithTxData([], TxHash.zero(), [], 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/note/unique_note.ts

@@ -1,88 +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 { 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 and a nonce that makes it unique.
- */
-export class UniqueNote {
-  constructor(
-    /** The note as emitted from the Noir contract. */
-    public note: Note,
-    /** The recipient whose public key was used to encrypt the note. */
-    public recipient: 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 hash of the tx the note was created in. */
-    public txHash: TxHash,
-    /** The nonce that was injected into the note hash preimage in order to guarantee uniqueness. */
-    public noteNonce: Fr,
-  ) {}
-
-  static get schema(): ZodFor<UniqueNote> {
-    return z
-      .object({
-        note: Note.schema,
-        recipient: schemas.AztecAddress,
-        contractAddress: schemas.AztecAddress,
-        storageSlot: schemas.Fr,
-        txHash: TxHash.schema,
-        noteNonce: schemas.Fr,
-      })
-      .transform(({ note, recipient, contractAddress, storageSlot, txHash, noteNonce }) => {
-        return new UniqueNote(note, recipient, contractAddress, storageSlot, txHash, noteNonce);
-      });
-  }
-
-  toBuffer(): Buffer {
-    return serializeToBuffer([
-      this.note,
-      this.recipient,
-      this.contractAddress,
-      this.storageSlot,
-      this.txHash,
-      this.noteNonce,
-    ]);
-  }
-
-  static async random() {
-    return new UniqueNote(
-      Note.random(),
-      await AztecAddress.random(),
-      await AztecAddress.random(),
-      Fr.random(),
-      TxHash.random(),
-      Fr.random(),
-    );
-  }
-
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-
-    const note = reader.readObject(Note);
-    const recipient = reader.readObject(AztecAddress);
-    const contractAddress = reader.readObject(AztecAddress);
-    const storageSlot = reader.readObject(Fr);
-    const txHash = reader.readObject(TxHash);
-    const noteNonce = reader.readObject(Fr);
-
-    return new UniqueNote(note, recipient, contractAddress, storageSlot, txHash, noteNonce);
-  }
-
-  static fromString(str: string) {
-    return UniqueNote.fromBuffer(hexToBuffer(str));
-  }
-
-  toString() {
-    return bufferToHex(this.toBuffer());
-  }
-}

package/src/tx/content_commitment.ts

@@ -1,104 +0,0 @@
-import type { ViemContentCommitment } from '@aztec/ethereum';
-import { Fr } from '@aztec/foundation/fields';
-import { schemas } from '@aztec/foundation/schemas';
-import { BufferReader, FieldReader, serializeToBuffer, serializeToFields } from '@aztec/foundation/serialize';
-import { bufferToHex } from '@aztec/foundation/string';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-import { z } from 'zod';
-
-export class ContentCommitment {
-  constructor(
-    public blobsHash: Fr,
-    public inHash: Fr,
-    public outHash: Fr,
-  ) {}
-
-  static get schema() {
-    return z
-      .object({
-        blobsHash: schemas.Fr,
-        inHash: schemas.Fr,
-        outHash: schemas.Fr,
-      })
-      .transform(({ blobsHash, inHash, outHash }) => new ContentCommitment(blobsHash, inHash, outHash));
-  }
-
-  static getFields(fields: FieldsOf<ContentCommitment>) {
-    return [fields.blobsHash, fields.inHash, fields.outHash] as const;
-  }
-
-  getSize() {
-    return this.toBuffer().length;
-  }
-
-  toBuffer() {
-    return serializeToBuffer(...ContentCommitment.getFields(this));
-  }
-
-  static fromBuffer(buffer: Buffer | BufferReader): ContentCommitment {
-    const reader = BufferReader.asReader(buffer);
-
-    return new ContentCommitment(reader.readObject(Fr), reader.readObject(Fr), reader.readObject(Fr));
-  }
-
-  toInspect() {
-    return {
-      blobsHash: this.blobsHash.toString(),
-      inHash: this.inHash.toString(),
-      outHash: this.outHash.toString(),
-    };
-  }
-
-  toViem(): ViemContentCommitment {
-    return {
-      blobsHash: this.blobsHash.toString(),
-      inHash: this.inHash.toString(),
-      outHash: this.outHash.toString(),
-    };
-  }
-
-  static fromViem(contentCommitment: ViemContentCommitment) {
-    return new ContentCommitment(
-      Fr.fromString(contentCommitment.blobsHash),
-      Fr.fromString(contentCommitment.inHash),
-      Fr.fromString(contentCommitment.outHash),
-    );
-  }
-
-  toFields(): Fr[] {
-    return serializeToFields(...ContentCommitment.getFields(this));
-  }
-
-  static fromFields(fields: Fr[] | FieldReader): ContentCommitment {
-    const reader = FieldReader.asReader(fields);
-    return new ContentCommitment(reader.readField(), reader.readField(), reader.readField());
-  }
-
-  static random(): ContentCommitment {
-    return new ContentCommitment(Fr.random(), Fr.random(), Fr.random());
-  }
-
-  static empty(): ContentCommitment {
-    return new ContentCommitment(Fr.zero(), Fr.zero(), Fr.zero());
-  }
-
-  isEmpty(): boolean {
-    return this.blobsHash.isZero() && this.inHash.isZero() && this.outHash.isZero();
-  }
-
-  public toString(): string {
-    return bufferToHex(this.toBuffer());
-  }
-
-  static fromString(str: string): ContentCommitment {
-    const buffer = Buffer.from(str.replace(/^0x/i, ''), 'hex');
-    return ContentCommitment.fromBuffer(buffer);
-  }
-
-  public equals(other: this): boolean {
-    return (
-      this.blobsHash.equals(other.blobsHash) && this.inHash.equals(other.inHash) && this.outHash.equals(other.outHash)
-    );
-  }
-}