@aztec/stdlib 0.0.1-commit.c2eed6949 → 0.0.1-commit.c52d6e7

package/src/avm/public_call_stack_item_compressed.ts

@@ -1,113 +0,0 @@
-import { PUBLIC_CALL_STACK_ITEM_COMPRESSED_LENGTH } from '@aztec/constants';
-import { Fr } from '@aztec/foundation/curves/bn254';
-import { BufferReader, FieldReader, serializeToBuffer, serializeToFields } from '@aztec/foundation/serialize';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-import { AztecAddress } from '../aztec-address/index.js';
-import { Gas } from '../gas/gas.js';
-import { CallContext } from '../tx/call_context.js';
-import { RevertCode } from './revert_code.js';
-
-// TO BE REMOVED
-/**
- * Compressed call stack item on a public call.
- */
-export class PublicCallStackItemCompressed {
-  constructor(
-    public contractAddress: AztecAddress,
-    public callContext: CallContext,
-    public argsHash: Fr,
-    public returnsHash: Fr,
-    public revertCode: RevertCode,
-    /** How much gas was available for execution. */
-    public startGasLeft: Gas,
-    /** How much gas was left after execution. */
-    public endGasLeft: Gas,
-  ) {}
-
-  static getFields(fields: FieldsOf<PublicCallStackItemCompressed>) {
-    return [
-      fields.contractAddress,
-      fields.callContext,
-      fields.argsHash,
-      fields.returnsHash,
-      fields.revertCode,
-      fields.startGasLeft,
-      fields.endGasLeft,
-    ] as const;
-  }
-
-  toFields(): Fr[] {
-    const fields = serializeToFields(...PublicCallStackItemCompressed.getFields(this));
-    if (fields.length !== PUBLIC_CALL_STACK_ITEM_COMPRESSED_LENGTH) {
-      throw new Error(
-        `Invalid number of fields for PublicCallStackItemCompressed. Expected ${PUBLIC_CALL_STACK_ITEM_COMPRESSED_LENGTH}, got ${fields.length}`,
-      );
-    }
-    return fields;
-  }
-
-  toBuffer() {
-    return serializeToBuffer(...PublicCallStackItemCompressed.getFields(this));
-  }
-
-  /**
-   * Deserializes from a buffer or reader.
-   * @param buffer - Buffer or reader to read from.
-   * @returns The deserialized instance.
-   */
-  static fromBuffer(buffer: Buffer | BufferReader): PublicCallStackItemCompressed {
-    const reader = BufferReader.asReader(buffer);
-    return new PublicCallStackItemCompressed(
-      reader.readObject(AztecAddress),
-      reader.readObject(CallContext),
-      reader.readObject(Fr),
-      reader.readObject(Fr),
-      reader.readObject(RevertCode),
-      reader.readObject(Gas),
-      reader.readObject(Gas),
-    );
-  }
-
-  static fromFields(fields: Fr[] | FieldReader): PublicCallStackItemCompressed {
-    const reader = FieldReader.asReader(fields);
-
-    return new PublicCallStackItemCompressed(
-      AztecAddress.fromFields(reader),
-      CallContext.fromFields(reader),
-      reader.readField(),
-      reader.readField(),
-      RevertCode.fromFields(reader),
-      Gas.fromFields(reader),
-      Gas.fromFields(reader),
-    );
-  }
-
-  /**
-   * Returns a new instance of PublicCallStackItem with zero contract address, function data and public inputs.
-   * @returns A new instance of PublicCallStackItem with zero contract address, function data and public inputs.
-   */
-  public static empty(): PublicCallStackItemCompressed {
-    return new PublicCallStackItemCompressed(
-      AztecAddress.ZERO,
-      CallContext.empty(),
-      Fr.ZERO,
-      Fr.ZERO,
-      RevertCode.OK,
-      Gas.empty(),
-      Gas.empty(),
-    );
-  }
-
-  isEmpty() {
-    return (
-      this.contractAddress.isZero() &&
-      this.callContext.isEmpty() &&
-      this.argsHash.isEmpty() &&
-      this.returnsHash.isEmpty() &&
-      this.revertCode.equals(RevertCode.OK) &&
-      this.startGasLeft.isEmpty() &&
-      this.endGasLeft.isEmpty()
-    );
-  }
-}

package/src/avm/public_data_update_request.ts

@@ -1,106 +0,0 @@
-import { Fr } from '@aztec/foundation/curves/bn254';
-import { BufferReader, FieldReader, serializeToBuffer } from '@aztec/foundation/serialize';
-
-import { inspect } from 'util';
-
-import type { AztecAddress } from '../aztec-address/index.js';
-import { computePublicDataTreeLeafSlot } from '../hash/hash.js';
-import type { ContractStorageUpdateRequest } from './contract_storage_update_request.js';
-
-// TO BE REMOVED.
-/**
- * Write operations on the public data tree including the previous value.
- */
-export class PublicDataUpdateRequest {
-  constructor(
-    /**
-     * Index of the leaf in the public data tree which is to be updated.
-     */
-    public readonly leafSlot: Fr,
-    /**
-     * New value of the leaf.
-     */
-    public readonly newValue: Fr,
-    /**
-     * Side effect counter tracking position of this event in tx execution.
-     */
-    public readonly sideEffectCounter: number,
-  ) {}
-
-  static from(args: {
-    /**
-     * Index of the leaf in the public data tree which is to be updated.
-     */
-    leafIndex: Fr;
-    /**
-     * New value of the leaf.
-     */
-    newValue: Fr;
-
-    /**
-     * Side effect counter tracking position of this event in tx execution.
-     */
-    sideEffectCounter: number;
-  }) {
-    return new PublicDataUpdateRequest(args.leafIndex, args.newValue, args.sideEffectCounter);
-  }
-
-  get counter() {
-    return this.sideEffectCounter;
-  }
-
-  get position() {
-    return this.leafSlot;
-  }
-
-  toBuffer() {
-    return serializeToBuffer(this.leafSlot, this.newValue, this.sideEffectCounter);
-  }
-
-  isEmpty() {
-    return this.leafSlot.isZero() && this.newValue.isZero();
-  }
-
-  static fromFields(fields: Fr[] | FieldReader) {
-    const reader = FieldReader.asReader(fields);
-    return new PublicDataUpdateRequest(reader.readField(), reader.readField(), reader.readU32());
-  }
-
-  static isEmpty(x: PublicDataUpdateRequest) {
-    return x.isEmpty();
-  }
-
-  equals(other: PublicDataUpdateRequest) {
-    return this.leafSlot.equals(other.leafSlot) && this.newValue.equals(other.newValue);
-  }
-
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new PublicDataUpdateRequest(Fr.fromBuffer(reader), Fr.fromBuffer(reader), reader.readNumber());
-  }
-
-  static async fromContractStorageUpdateRequest(
-    contractAddress: AztecAddress,
-    updateRequest: ContractStorageUpdateRequest,
-  ) {
-    const leafSlot = await computePublicDataTreeLeafSlot(contractAddress, updateRequest.storageSlot);
-
-    return new PublicDataUpdateRequest(leafSlot, updateRequest.newValue, updateRequest.counter);
-  }
-
-  static empty() {
-    return new PublicDataUpdateRequest(Fr.ZERO, Fr.ZERO, 0);
-  }
-
-  toFriendlyJSON() {
-    return `Leaf=${this.leafSlot.toFriendlyJSON()}: ${this.newValue.toFriendlyJSON()}, SideEffectCounter=${
-      this.sideEffectCounter
-    }`;
-  }
-
-  [inspect.custom]() {
-    return `PublicDataUpdateRequest { leafSlot: ${this.leafSlot.toFriendlyJSON()}, newValue: ${this.newValue.toFriendlyJSON()}, sideEffectCounter: ${
-      this.sideEffectCounter
-    } }`;
-  }
-}

package/src/avm/public_inner_call_request.ts

@@ -1,85 +0,0 @@
-import type { Fr } from '@aztec/foundation/curves/bn254';
-import { BufferReader, FieldReader, serializeToBuffer, serializeToFields } from '@aztec/foundation/serialize';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-import { inspect } from 'util';
-
-import { PublicCallStackItemCompressed } from './public_call_stack_item_compressed.js';
-
-// TO BE REMOVED
-/**
- * Represents a request to call a public function.
- */
-export class PublicInnerCallRequest {
-  constructor(
-    public item: PublicCallStackItemCompressed,
-    /**
-     * The counter for this call request.
-     */
-    public counter: number,
-  ) {}
-
-  getSize() {
-    return this.isEmpty() ? 0 : this.toBuffer().length;
-  }
-
-  /**
-   * Serialize this as a buffer.
-   * @returns The buffer.
-   */
-  toBuffer() {
-    return serializeToBuffer(this.item, this.counter);
-  }
-
-  /**
-   * Deserialize this from a buffer.
-   * @param buffer - The bufferable type from which to deserialize.
-   * @returns The deserialized instance of PublicInnerCallRequest.
-   */
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new PublicInnerCallRequest(PublicCallStackItemCompressed.fromBuffer(reader), reader.readNumber());
-  }
-
-  /**
-   * Create PublicInnerCallRequest from a fields dictionary.
-   * @param fields - The dictionary.
-   * @returns A PublicInnerCallRequest object.
-   */
-  static from(fields: FieldsOf<PublicInnerCallRequest>): PublicInnerCallRequest {
-    return new PublicInnerCallRequest(...PublicInnerCallRequest.getFields(fields));
-  }
-
-  /**
-   * Serialize into a field array. Low-level utility.
-   * @param fields - Object with fields.
-   * @returns The array.
-   */
-  static getFields(fields: FieldsOf<PublicInnerCallRequest>) {
-    return [fields.item, fields.counter] as const;
-  }
-
-  toFields(): Fr[] {
-    return serializeToFields([this.item, this.counter]);
-  }
-
-  static fromFields(fields: Fr[] | FieldReader): PublicInnerCallRequest {
-    const reader = FieldReader.asReader(fields);
-    return new PublicInnerCallRequest(PublicCallStackItemCompressed.fromFields(reader), reader.readU32());
-  }
-
-  static empty() {
-    return new PublicInnerCallRequest(PublicCallStackItemCompressed.empty(), 0);
-  }
-
-  isEmpty(): boolean {
-    return this.item.isEmpty() && this.counter == 0;
-  }
-
-  [inspect.custom]() {
-    return `PublicInnerCallRequest {
-      item: ${this.item.toFields()}
-      counter: ${this.counter}
-    }`;
-  }
-}

package/src/block/checkpointed_l2_block.ts

@@ -1,70 +0,0 @@
-// Ignoring import issue to fix portable inferred type issue in zod schema
-import { CheckpointNumber, CheckpointNumberSchema } from '@aztec/foundation/branded-types';
-import { BufferReader, serializeToBuffer } from '@aztec/foundation/serialize';
-import type { FieldsOf } from '@aztec/foundation/types';
-
-import { z } from 'zod';
-
-import { L1PublishedData } from '../checkpoint/published_checkpoint.js';
-import { MAX_BLOCK_HASH_STRING_LENGTH, MAX_COMMITTEE_SIZE } from '../deserialization/index.js';
-import { L2Block } from './l2_block.js';
-import { CommitteeAttestation } from './proposal/committee_attestation.js';
-
-/**
- * Encapsulates an L2 Block along with the checkpoint data associated with it.
- */
-export class CheckpointedL2Block {
-  constructor(
-    public checkpointNumber: CheckpointNumber,
-    public block: L2Block,
-    public l1: L1PublishedData,
-    public attestations: CommitteeAttestation[],
-  ) {}
-  static get schema() {
-    return z
-      .object({
-        checkpointNumber: CheckpointNumberSchema,
-        block: L2Block.schema,
-        l1: L1PublishedData.schema,
-        attestations: z.array(CommitteeAttestation.schema),
-      })
-      .transform(obj => CheckpointedL2Block.fromFields(obj));
-  }
-
-  static fromBuffer(bufferOrReader: Buffer | BufferReader): CheckpointedL2Block {
-    const reader = BufferReader.asReader(bufferOrReader);
-    const checkpointNumber = reader.readNumber();
-    const block = reader.readObject(L2Block);
-    const l1BlockNumber = reader.readBigInt();
-    const l1BlockHash = reader.readString(MAX_BLOCK_HASH_STRING_LENGTH);
-    const l1Timestamp = reader.readBigInt();
-    const attestations = reader.readVector(CommitteeAttestation, MAX_COMMITTEE_SIZE);
-    return new CheckpointedL2Block(
-      CheckpointNumber(checkpointNumber),
-      block,
-      new L1PublishedData(l1BlockNumber, l1Timestamp, l1BlockHash),
-      attestations,
-    );
-  }
-
-  static fromFields(fields: FieldsOf<CheckpointedL2Block>) {
-    return new CheckpointedL2Block(
-      CheckpointNumber(fields.checkpointNumber),
-      fields.block,
-      fields.l1,
-      fields.attestations,
-    );
-  }
-
-  public toBuffer(): Buffer {
-    return serializeToBuffer(
-      this.checkpointNumber,
-      this.block,
-      this.l1.blockNumber,
-      this.l1.blockHash,
-      this.l1.timestamp,
-      this.attestations.length,
-      this.attestations,
-    );
-  }
-}

package/src/config/pipelining-config.ts

@@ -1,31 +0,0 @@
-import { type ConfigMappingsType, booleanConfigHelper, getConfigFromMappings } from '@aztec/foundation/config';
-
-import { z } from 'zod';
-
-import { zodFor } from '../schemas/index.js';
-
-export type PipelineConfig = {
-  /** Whether to enable build-ahead proposer pipelining. */
-  enableProposerPipelining: boolean;
-};
-
-/**
- * Pipelining config mappings for fields that need to be shared across packages.
- */
-export const pipelineConfigMappings: ConfigMappingsType<PipelineConfig> = {
-  enableProposerPipelining: {
-    env: 'SEQ_ENABLE_PROPOSER_PIPELINING',
-    description: 'Whether to enable build-ahead proposer pipelining.',
-    ...booleanConfigHelper(false),
-  },
-};
-
-export const PipelineConfigSchema = zodFor<PipelineConfig>()(
-  z.object({
-    enableProposerPipelining: z.boolean(),
-  }),
-);
-
-export function getPipelineConfigEnvVars(): PipelineConfig {
-  return getConfigFromMappings(pipelineConfigMappings);
-}

package/src/contract/deployment_info.ts

@@ -1,25 +0,0 @@
-import type { Fr } from '@aztec/foundation/curves/bn254';
-
-import type { CompleteAddress } from './complete_address.js';
-
-/**
- * Represents the data generated as part of contract deployment.
- */
-export type DeploymentInfo = {
-  /**
-   * The complete address of the deployed contract.
-   */
-  completeAddress: CompleteAddress;
-  /**
-   * The contract's constructor verification key hash.
-   */
-  constructorVkHash: Fr;
-  /**
-   * The contract's constructor hash.
-   */
-  constructorHash: Fr;
-  /**
-   * The root of the contract's function tree.
-   */
-  functionTreeRoot: Fr;
-};

package/src/interfaces/epoch-prover.ts

@@ -1,72 +0,0 @@
-import type { BatchedBlob, FinalBlobBatchingChallenges } from '@aztec/blob-lib/types';
-import type { BlockNumber, EpochNumber } from '@aztec/foundation/branded-types';
-import type { Fr } from '@aztec/foundation/curves/bn254';
-import type { EthAddress } from '@aztec/foundation/eth-address';
-
-import type { Proof } from '../proofs/proof.js';
-import type { CheckpointConstantData } from '../rollup/checkpoint_constant_data.js';
-import type { RootRollupPublicInputs } from '../rollup/root_rollup_public_inputs.js';
-import type { BlockHeader } from '../tx/block_header.js';
-import type { Tx } from '../tx/tx.js';
-import type { UInt64 } from '../types/index.js';
-import type { IBlockFactory } from './block-builder.js';
-
-/** Coordinates the proving of an entire epoch. */
-export interface EpochProver extends Omit<IBlockFactory, 'setBlockCompleted' | 'startNewBlock'> {
-  /**
-   * Starts a new epoch. Must be the first method to be called.
-   * @param epochNumber - The epoch number.
-   * @param totalNumCheckpoints - The total number of checkpoints expected in the epoch (must be at least one).
-   * @param finalBlobBatchingChallenges - The final blob batching challenges for the epoch.
-   **/
-  startNewEpoch(
-    epochNumber: EpochNumber,
-    totalNumCheckpoints: number,
-    finalBlobBatchingChallenges: FinalBlobBatchingChallenges,
-  ): void;
-
-  /**
-   * Starts a new checkpoint.
-   * @param checkpointIndex - The index of the checkpoint in the epoch.
-   * @param constants - The constants for this checkpoint.
-   * @param l1ToL2Messages - The set of L1 to L2 messages to be included in this checkpoint.
-   * @param totalNumBlocks - The total number of blocks expected in the checkpoint (must be at least one).
-   * @param headerOfLastBlockInPreviousCheckpoint - The header of the last block in the previous checkpoint.
-   */
-  startNewCheckpoint(
-    checkpointIndex: number,
-    constants: CheckpointConstantData,
-    l1ToL2Messages: Fr[],
-    totalNumBlocks: number,
-    headerOfLastBlockInPreviousCheckpoint: BlockHeader,
-  ): Promise<void>;
-
-  /**
-   * Starts a new block.
-   * @param blockNumber - The block number.
-   * @param timestamp - The timestamp of the block.
-   * @param totalNumTxs - The total number of txs in the block.
-   */
-  startNewBlock(blockNumber: BlockNumber, timestamp: UInt64, totalNumTxs: number): Promise<void>;
-
-  /**
-   * Kickstarts chonk verifier circuits for the specified txs. These will be used during epoch proving.
-   * Note that if the chonk verifier circuits are not started this way, they will be started nonetheless after processing.
-   */
-  startChonkVerifierCircuits(txs: Tx[]): Promise<void>;
-
-  /** Returns the block. */
-  setBlockCompleted(blockNumber: BlockNumber, expectedBlockHeader?: BlockHeader): Promise<BlockHeader>;
-
-  /** Pads the epoch with empty block roots if needed and blocks until proven. Throws if proving has failed. */
-  finalizeEpoch(): Promise<{ publicInputs: RootRollupPublicInputs; proof: Proof; batchedBlobInputs: BatchedBlob }>;
-
-  /** Cancels all proving jobs. */
-  cancel(): void;
-
-  /** Returns an identifier for the prover or zero if not set. */
-  getProverId(): EthAddress;
-
-  /** Called when no longer required, cleans up internal resources */
-  stop(): Promise<void>;
-}

package/src/interfaces/get_logs_response.ts

@@ -1,35 +0,0 @@
-import { z } from 'zod';
-
-import { ExtendedContractClassLog } from '../logs/extended_contract_class_log.js';
-import { ExtendedPublicLog } from '../logs/extended_public_log.js';
-import { zodFor } from '../schemas/index.js';
-
-/** Response for the getContractClassLogs archiver call. */
-export type GetContractClassLogsResponse = {
-  /** An array of ExtendedContractClassLog elements. */
-  logs: ExtendedContractClassLog[];
-  /** Indicates if a limit has been reached. */
-  maxLogsHit: boolean;
-};
-
-export const GetContractClassLogsResponseSchema = zodFor<GetContractClassLogsResponse>()(
-  z.object({
-    logs: z.array(ExtendedContractClassLog.schema),
-    maxLogsHit: z.boolean(),
-  }),
-);
-
-/** Response for the getPublicLogs archiver call. */
-export type GetPublicLogsResponse = {
-  /** An array of ExtendedPublicLog elements. */
-  logs: ExtendedPublicLog[];
-  /** Indicates if a limit has been reached. */
-  maxLogsHit: boolean;
-};
-
-export const GetPublicLogsResponseSchema = zodFor<GetPublicLogsResponse>()(
-  z.object({
-    logs: z.array(ExtendedPublicLog.schema),
-    maxLogsHit: z.boolean(),
-  }),
-);

package/src/interfaces/prover-coordination.ts

@@ -1,17 +0,0 @@
-import { Tx } from '../tx/tx.js';
-import { TxHash } from '../tx/tx_hash.js';
-import type { P2PClient } from './p2p.js';
-
-/** Provides basic operations for ProverNodes to interact with other nodes in the network. */
-export interface ProverCoordination {
-  /**
-   * Returns a set of transactions given their hashes if available.
-   * @param txHashes - The hashes of the transactions, used as an ID.
-   * @returns The transactions found, no necessarily in the same order as the hashes.
-   */
-  getTxsByHash(txHashes: TxHash[]): Promise<Tx[]>;
-
-  gatherTxs(txHashes: TxHash[]): Promise<void>;
-
-  getP2PClient(): P2PClient | undefined;
-}

package/src/kernel/hints/tree_leaf_read_request.ts

@@ -1,35 +0,0 @@
-import { Fr } from '@aztec/foundation/curves/bn254';
-import { BufferReader, FieldReader, serializeToBuffer } from '@aztec/foundation/serialize';
-
-export class TreeLeafReadRequest {
-  constructor(
-    public value: Fr,
-    public leafIndex: Fr,
-  ) {}
-
-  toBuffer(): Buffer {
-    return serializeToBuffer(this.value, this.leafIndex);
-  }
-
-  static fromBuffer(buffer: Buffer | BufferReader) {
-    const reader = BufferReader.asReader(buffer);
-    return new TreeLeafReadRequest(Fr.fromBuffer(reader), Fr.fromBuffer(reader));
-  }
-
-  toFields(): Fr[] {
-    return [this.value, this.leafIndex];
-  }
-
-  static fromFields(fields: Fr[] | FieldReader) {
-    const reader = FieldReader.asReader(fields);
-    return new TreeLeafReadRequest(reader.readField(), reader.readField());
-  }
-
-  isEmpty() {
-    return this.value.isZero() && this.leafIndex.isZero();
-  }
-
-  static empty() {
-    return new TreeLeafReadRequest(Fr.zero(), Fr.zero());
-  }
-}

package/src/kernel/private_kernel_tail_circuit_private_inputs.ts

@@ -1,58 +0,0 @@
-import { BufferReader, bigintToUInt64BE, serializeToBuffer } from '@aztec/foundation/serialize';
-
-import type { UInt64 } from '../types/shared.js';
-import { PaddedSideEffectAmounts } from './padded_side_effects.js';
-import { PrivateKernelData } from './private_kernel_data.js';
-
-/**
- * Input to the private kernel circuit - tail call.
- */
-export class PrivateKernelTailCircuitPrivateInputs {
-  constructor(
-    /**
-     * The previous kernel data
-     */
-    public previousKernel: PrivateKernelData,
-    /**
-     * The number of the padded side effects.
-     */
-    public paddedSideEffectAmounts: PaddedSideEffectAmounts,
-    /**
-     * The timestamp by which the transaction must be included in a block.
-     */
-    public expirationTimestampUpperBound: UInt64,
-  ) {}
-
-  isForPublic() {
-    return (
-      this.previousKernel.publicInputs.end.publicCallRequests.claimedLength > 0 ||
-      !this.previousKernel.publicInputs.publicTeardownCallRequest.isEmpty()
-    );
-  }
-
-  /**
-   * Serialize this as a buffer.
-   * @returns The buffer.
-   */
-  toBuffer() {
-    return serializeToBuffer(
-      this.previousKernel,
-      this.paddedSideEffectAmounts,
-      bigintToUInt64BE(this.expirationTimestampUpperBound),
-    );
-  }
-
-  /**
-   * Deserializes from a buffer or reader.
-   * @param buffer - Buffer or reader to read from.
-   * @returns The deserialized instance.
-   */
-  static fromBuffer(buffer: Buffer | BufferReader): PrivateKernelTailCircuitPrivateInputs {
-    const reader = BufferReader.asReader(buffer);
-    return new PrivateKernelTailCircuitPrivateInputs(
-      reader.readObject(PrivateKernelData),
-      reader.readObject(PaddedSideEffectAmounts),
-      reader.readUInt64(),
-    );
-  }
-}