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

package/src/block/l2_block_new.ts

@@ -1,171 +0,0 @@
-import { type BlockBlobData, encodeBlockBlobData } from '@aztec/blob-lib/encoding';
-import { Fr } from '@aztec/foundation/fields';
-import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
-
-import { z } from 'zod';
-
-import { AppendOnlyTreeSnapshot } from '../trees/append_only_tree_snapshot.js';
-import { BlockHeader } from '../tx/block_header.js';
-import { Body } from './body.js';
-import type { L2BlockInfo } from './l2_block_info.js';
-
-/**
- * An L2 block with a header and a body.
- * TODO: Delete the existing `L2Block` class and rename this to `L2Block`.
- */
-export class L2BlockNew {
-  constructor(
-    /** Snapshot of archive tree after the block is applied. */
-    public archive: AppendOnlyTreeSnapshot,
-    /** Header of the block. */
-    public header: BlockHeader,
-    /** L2 block body. */
-    public body: Body,
-    private blockHash: Fr | undefined = undefined,
-  ) {}
-
-  get number(): number {
-    return this.header.globalVariables.blockNumber;
-  }
-
-  get timestamp(): bigint {
-    return this.header.globalVariables.timestamp;
-  }
-
-  static get schema() {
-    return z
-      .object({
-        archive: AppendOnlyTreeSnapshot.schema,
-        header: BlockHeader.schema,
-        body: Body.schema,
-      })
-      .transform(({ archive, header, body }) => new L2BlockNew(archive, header, body));
-  }
-
-  /**
-   * Deserializes a block from a buffer
-   * @returns A deserialized L2 block.
-   */
-  static fromBuffer(buf: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buf);
-    const header = reader.readObject(BlockHeader);
-    const archive = reader.readObject(AppendOnlyTreeSnapshot);
-    const body = reader.readObject(Body);
-
-    return new L2BlockNew(archive, header, body);
-  }
-
-  /**
-   * Serializes a block
-   * @returns A serialized L2 block as a Buffer.
-   */
-  toBuffer() {
-    return serializeToBuffer(this.header, this.archive, this.body);
-  }
-
-  /**
-   * Returns the block's hash (hash of block header).
-   * @returns The block's hash.
-   */
-  public async hash(): Promise<Fr> {
-    if (this.blockHash === undefined) {
-      this.blockHash = await this.header.hash();
-    }
-    return this.blockHash;
-  }
-
-  public toBlobFields(isFirstBlock: boolean): Fr[] {
-    const blockBlobData = this.toBlockBlobData(isFirstBlock);
-    return encodeBlockBlobData(blockBlobData);
-  }
-
-  public toBlockBlobData(isFirstBlock: boolean): BlockBlobData {
-    return {
-      blockEndMarker: {
-        numTxs: this.body.txEffects.length,
-        timestamp: this.header.globalVariables.timestamp,
-        blockNumber: this.number,
-      },
-      blockEndStateField: {
-        l1ToL2MessageNextAvailableLeafIndex: this.header.state.l1ToL2MessageTree.nextAvailableLeafIndex,
-        noteHashNextAvailableLeafIndex: this.header.state.partial.noteHashTree.nextAvailableLeafIndex,
-        nullifierNextAvailableLeafIndex: this.header.state.partial.nullifierTree.nextAvailableLeafIndex,
-        publicDataNextAvailableLeafIndex: this.header.state.partial.publicDataTree.nextAvailableLeafIndex,
-        totalManaUsed: this.header.totalManaUsed.toBigInt(),
-      },
-      lastArchiveRoot: this.header.lastArchive.root,
-      noteHashRoot: this.header.state.partial.noteHashTree.root,
-      nullifierRoot: this.header.state.partial.nullifierTree.root,
-      publicDataRoot: this.header.state.partial.publicDataTree.root,
-      l1ToL2MessageRoot: isFirstBlock ? this.header.state.l1ToL2MessageTree.root : undefined,
-      txs: this.body.toTxBlobData(),
-    };
-  }
-
-  /**
-   * Creates an L2 block containing random data.
-   * @param l2BlockNum - The number of the L2 block.
-   * @param txsPerBlock - The number of transactions to include in the block.
-   * @param numPublicCallsPerTx - The number of public function calls to include in each transaction.
-   * @param numPublicLogsPerCall - The number of public logs per 1 public function invocation.
-   * @param inHash - The hash of the L1 to L2 messages subtree which got inserted in this block.
-   * @returns The L2 block.
-   */
-  static async random(
-    blockNumber: number,
-    {
-      txsPerBlock = 1,
-      txOptions = {},
-      makeTxOptions,
-      ...blockHeaderOverrides
-    }: {
-      txsPerBlock?: number;
-      txOptions?: Partial<Parameters<typeof Body.random>[0]>;
-      makeTxOptions?: (txIndex: number) => Partial<Parameters<typeof Body.random>[0]>;
-    } & Partial<Parameters<typeof BlockHeader.random>[0]> = {},
-  ): Promise<L2BlockNew> {
-    const archive = new AppendOnlyTreeSnapshot(Fr.random(), blockNumber + 1);
-    const header = BlockHeader.random({ blockNumber, ...blockHeaderOverrides });
-    const body = await Body.random({ txsPerBlock, makeTxOptions, ...txOptions });
-    return new L2BlockNew(archive, header, body);
-  }
-
-  /**
-   * Returns stats used for logging.
-   * @returns Stats on tx count, number, and log size and count.
-   */
-  getStats() {
-    const logsStats = {
-      privateLogCount: this.body.txEffects.reduce((logCount, txEffect) => logCount + txEffect.privateLogs.length, 0),
-      publicLogCount: this.body.txEffects.reduce((logCount, txEffect) => logCount + txEffect.publicLogs.length, 0),
-      contractClassLogCount: this.body.txEffects.reduce(
-        (logCount, txEffect) => logCount + txEffect.contractClassLogs.length,
-        0,
-      ),
-      contractClassLogSize: this.body.txEffects.reduce(
-        (totalLogSize, txEffect) =>
-          totalLogSize + txEffect.contractClassLogs.reduce((acc, log) => acc + log.emittedLength, 0),
-        0,
-      ),
-    };
-
-    return {
-      txCount: this.body.txEffects.length,
-      blockNumber: this.number,
-      blockTimestamp: Number(this.header.globalVariables.timestamp),
-      ...logsStats,
-    };
-  }
-
-  toBlockInfo(): L2BlockInfo {
-    return {
-      blockHash: this.blockHash,
-      archive: this.archive.root,
-      lastArchive: this.header.lastArchive.root,
-      blockNumber: this.number,
-      slotNumber: Number(this.header.getSlot()),
-      txCount: this.body.txEffects.length,
-      timestamp: this.header.globalVariables.timestamp,
-    };
-  }
-}

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,65 +0,0 @@
-// Ignoring import issue to fix portable inferred type issue in zod schema
-import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-import { z } from 'zod';
-
-import { L1PublishedData, PublishedCheckpoint } from '../checkpoint/published_checkpoint.js';
-import { L2Block } from './l2_block.js';
-import { CommitteeAttestation } from './proposal/committee_attestation.js';
-
-/**
- * @deprecated `PublishedCheckpoint` is what will be retrieved from L1.
- * L2 blocks do not need to link to L1PublishedData directly.
- * TODO: Create another type (AttestedL2Block?) for an L2 block and its attestations.
- */
-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,
-    );
-  }
-
-  public toPublishedCheckpoint() {
-    return new PublishedCheckpoint(this.block.toCheckpoint(), this.l1, this.attestations);
-  }
-
-  static fromPublishedCheckpoint(checkpoint: PublishedCheckpoint) {
-    return new PublishedL2Block(L2Block.fromCheckpoint(checkpoint.checkpoint), checkpoint.l1, checkpoint.attestations);
-  }
-}

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