@aztec/stdlib 0.0.1-commit.2eb6648a → 0.0.1-commit.2f68f620

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/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/contract/private_function_membership_proof.ts

@@ -1,167 +0,0 @@
-import { poseidon2Hash } from '@aztec/foundation/crypto/poseidon';
-import { Fr } from '@aztec/foundation/curves/bn254';
-import { createLogger } from '@aztec/foundation/log';
-import { computeRootFromSiblingPath } from '@aztec/foundation/trees';
-
-import { type ContractArtifact, FunctionSelector, FunctionType } from '../abi/index.js';
-import {
-  computeArtifactFunctionTree,
-  computeArtifactHash,
-  computeArtifactHashPreimage,
-  computeFunctionArtifactHash,
-  computeFunctionMetadataHash,
-  getArtifactMerkleTreeHasher,
-} from './artifact_hash.js';
-import { getContractClassPrivateFunctionFromArtifact } from './contract_class.js';
-import type {
-  ContractClassPublic,
-  ExecutablePrivateFunctionWithMembershipProof,
-  PrivateFunctionMembershipProof,
-} from './interfaces/index.js';
-import { computePrivateFunctionLeaf, computePrivateFunctionsTree } from './private_function.js';
-
-/**
- * Creates a membership proof for a private function in a contract class, to be verified via `isValidPrivateFunctionMembershipProof`.
- * @param selector - Selector of the function to create the proof for.
- * @param artifact - Artifact of the contract class where the function is defined.
- */
-export async function createPrivateFunctionMembershipProof(
-  selector: FunctionSelector,
-  artifact: ContractArtifact,
-): Promise<PrivateFunctionMembershipProof> {
-  const log = createLogger('circuits:function_membership_proof');
-
-  // Locate private function definition and artifact
-  const privateFunctions = artifact.functions.filter(fn => fn.functionType === FunctionType.PRIVATE);
-  const privateFunctionsFromArtifact = await Promise.all(
-    privateFunctions.map(getContractClassPrivateFunctionFromArtifact),
-  );
-  const privateFunction = privateFunctionsFromArtifact.find(fn => fn.selector.equals(selector));
-  const privateFunctionsAndSelectors = await Promise.all(
-    privateFunctions.map(async fn => ({
-      fn,
-      selector: await FunctionSelector.fromNameAndParameters(fn.name, fn.parameters),
-    })),
-  );
-  const privateFunctionArtifact = privateFunctionsAndSelectors.find(fnAndSelector =>
-    selector.equals(fnAndSelector.selector),
-  )?.fn;
-  if (!privateFunction || !privateFunctionArtifact) {
-    throw new Error(`Private function with selector ${selector.toString()} not found`);
-  }
-
-  // Compute preimage for the artifact hash
-  const { utilityFunctionRoot: utilityFunctionsTreeRoot, metadataHash: artifactMetadataHash } =
-    await computeArtifactHashPreimage(artifact);
-
-  // We need two sibling paths because private function information is split across two trees:
-  // The "private function tree" captures the selectors and verification keys, and is used in the kernel circuit for verifying the proof generated by the app circuit.
-  const functionLeaf = await computePrivateFunctionLeaf(privateFunction);
-  const functionsTree = await computePrivateFunctionsTree(privateFunctionsFromArtifact);
-  const functionsTreeLeafIndex = functionsTree.getIndex(functionLeaf);
-  const functionsTreeSiblingPath = functionsTree.getSiblingPath(functionsTreeLeafIndex).map(Fr.fromBuffer);
-
-  // And the "artifact tree" captures function bytecode and metadata, and is used by the pxe to check that its executing the code it's supposed to be executing, but it never goes into circuits.
-  const functionMetadataHash = computeFunctionMetadataHash(privateFunctionArtifact);
-  const functionArtifactHash = await computeFunctionArtifactHash({ ...privateFunctionArtifact, functionMetadataHash });
-  const artifactTree = (await computeArtifactFunctionTree(artifact, FunctionType.PRIVATE))!;
-  const artifactTreeLeafIndex = artifactTree.getIndex(functionArtifactHash.toBuffer());
-  const artifactTreeSiblingPath = artifactTree.getSiblingPath(artifactTreeLeafIndex).map(Fr.fromBuffer);
-
-  log.debug(`Computed proof for private function with selector ${selector.toString()}`, {
-    functionArtifactHash,
-    functionMetadataHash,
-    functionLeaf: '0x' + functionLeaf.toString('hex'),
-    artifactMetadataHash,
-    privateFunctionsTreeRoot: '0x' + functionsTree.root.toString('hex'),
-    utilityFunctionsTreeRoot,
-    artifactFunctionTreeSiblingPath: artifactTreeSiblingPath.map(fr => fr.toString()).join(','),
-    privateFunctionTreeSiblingPath: functionsTreeSiblingPath.map(fr => fr.toString()).join(','),
-  });
-
-  return {
-    artifactTreeSiblingPath,
-    artifactTreeLeafIndex,
-    artifactMetadataHash,
-    functionMetadataHash,
-    utilityFunctionsTreeRoot,
-    privateFunctionTreeSiblingPath: functionsTreeSiblingPath,
-    privateFunctionTreeLeafIndex: functionsTreeLeafIndex,
-  };
-}
-
-/**
- * Verifies that a private function with a membership proof as emitted by the ClassRegistry contract is valid,
- * as defined in the protocol specs at contract-deployment/classes:
- *
- * ```
- * // Load contract class from local db
- * contract_class = db.get_contract_class(contract_class_id)
- *
- * // Compute function leaf and assert it belongs to the private functions tree
- * function_leaf = pedersen([selector as Field, vk_hash], GENERATOR__PRIVATE_FUNCTION_LEAF)
- * computed_private_function_tree_root = compute_root(function_leaf, private_function_tree_sibling_path)
- * assert computed_private_function_tree_root == contract_class.private_functions_root
- *
- * // Compute artifact leaf and assert it belongs to the artifact
- * artifact_function_leaf = sha256(selector, metadata_hash, sha256(bytecode))
- * computed_artifact_private_function_tree_root = compute_root(artifact_function_leaf, artifact_function_tree_sibling_path)
- * computed_artifact_hash = sha256(computed_artifact_private_function_tree_root, utility_functions_artifact_tree_root, artifact_metadata_hash)
- * assert computed_artifact_hash == contract_class.artifact_hash
- * ```
- * @param fn - Function to check membership proof for.
- * @param contractClass - In which contract class the function is expected to be.
- */
-export async function isValidPrivateFunctionMembershipProof(
-  fn: ExecutablePrivateFunctionWithMembershipProof,
-  contractClass: Pick<ContractClassPublic, 'privateFunctionsRoot' | 'artifactHash'>,
-) {
-  const log = createLogger('circuits:function_membership_proof');
-
-  // Check private function tree membership
-  const functionLeaf = await computePrivateFunctionLeaf(fn);
-  const rootBuffer = await computeRootFromSiblingPath(
-    functionLeaf,
-    fn.privateFunctionTreeSiblingPath.map(fr => fr.toBuffer()),
-    fn.privateFunctionTreeLeafIndex,
-    async (left, right) => (await poseidon2Hash([left, right])).toBuffer(),
-  );
-  const computedPrivateFunctionTreeRoot = Fr.fromBuffer(rootBuffer);
-  if (!contractClass.privateFunctionsRoot.equals(computedPrivateFunctionTreeRoot)) {
-    log.debug(`Private function tree root mismatch`, {
-      expectedPrivateFunctionTreeRoot: contractClass.privateFunctionsRoot,
-      computedPrivateFunctionTreeRoot: computedPrivateFunctionTreeRoot,
-      computedFunctionLeaf: '0x' + functionLeaf.toString('hex'),
-    });
-    return false;
-  }
-
-  // Check artifact hash
-  const functionArtifactHash = await computeFunctionArtifactHash(fn);
-  const computedArtifactPrivateFunctionTreeRootBuffer = await computeRootFromSiblingPath(
-    functionArtifactHash.toBuffer(),
-    fn.artifactTreeSiblingPath.map(fr => fr.toBuffer()),
-    fn.artifactTreeLeafIndex,
-    getArtifactMerkleTreeHasher(),
-  );
-  const computedArtifactPrivateFunctionTreeRoot = Fr.fromBuffer(computedArtifactPrivateFunctionTreeRootBuffer);
-  const computedArtifactHash = await computeArtifactHash({
-    privateFunctionRoot: computedArtifactPrivateFunctionTreeRoot,
-    utilityFunctionRoot: fn.utilityFunctionsTreeRoot,
-    metadataHash: fn.artifactMetadataHash,
-  });
-  if (!contractClass.artifactHash.equals(computedArtifactHash)) {
-    log.debug(`Artifact hash mismatch`, {
-      expected: contractClass.artifactHash,
-      computedArtifactHash,
-      computedFunctionArtifactHash: functionArtifactHash,
-      computedArtifactPrivateFunctionTreeRoot,
-      utilityFunctionRoot: fn.utilityFunctionsTreeRoot,
-      metadataHash: fn.artifactMetadataHash,
-      artifactFunctionTreeSiblingPath: fn.artifactTreeSiblingPath.map(fr => fr.toString()).join(','),
-    });
-    return false;
-  }
-
-  return true;
-}

package/src/contract/utility_function_membership_proof.ts

@@ -1,118 +0,0 @@
-import { Fr } from '@aztec/foundation/curves/bn254';
-import { createLogger } from '@aztec/foundation/log';
-import { computeRootFromSiblingPath } from '@aztec/foundation/trees';
-
-import { type ContractArtifact, FunctionSelector, FunctionType } from '../abi/index.js';
-import {
-  computeArtifactFunctionTree,
-  computeArtifactHash,
-  computeArtifactHashPreimage,
-  computeFunctionArtifactHash,
-  computeFunctionMetadataHash,
-  getArtifactMerkleTreeHasher,
-} from './artifact_hash.js';
-import type {
-  ContractClassPublic,
-  UtilityFunctionMembershipProof,
-  UtilityFunctionWithMembershipProof,
-} from './interfaces/index.js';
-
-/**
- * Creates a membership proof for a utility  function in a contract class, to be verified via `isValidUtilityFunctionMembershipProof`.
- * @param selector - Selector of the function to create the proof for.
- * @param artifact - Artifact of the contract class where the function is defined.
- */
-export async function createUtilityFunctionMembershipProof(
-  selector: FunctionSelector,
-  artifact: ContractArtifact,
-): Promise<UtilityFunctionMembershipProof> {
-  const log = createLogger('circuits:function_membership_proof');
-
-  // Locate function artifact
-  const utilityFunctions = artifact.functions.filter(fn => fn.functionType === FunctionType.UTILITY);
-  const utilityFunctionsAndSelectors = await Promise.all(
-    utilityFunctions.map(async fn => ({ fn, selector: await FunctionSelector.fromNameAndParameters(fn) })),
-  );
-  const fn = utilityFunctionsAndSelectors.find(fnAndSelector => selector.equals(fnAndSelector.selector))?.fn;
-  if (!fn) {
-    throw new Error(`Utility function with selector ${selector.toString()} not found`);
-  }
-  // Compute preimage for the artifact hash
-  const { privateFunctionRoot: privateFunctionsArtifactTreeRoot, metadataHash: artifactMetadataHash } =
-    await computeArtifactHashPreimage(artifact);
-
-  // Compute the sibling path for the "artifact tree"
-  const functionMetadataHash = computeFunctionMetadataHash(fn);
-  const functionArtifactHash = await computeFunctionArtifactHash({ ...fn, functionMetadataHash });
-  const artifactTree = (await computeArtifactFunctionTree(artifact, FunctionType.UTILITY))!;
-  const artifactTreeLeafIndex = artifactTree.getIndex(functionArtifactHash.toBuffer());
-  const artifactTreeSiblingPath = artifactTree.getSiblingPath(artifactTreeLeafIndex).map(Fr.fromBuffer);
-
-  log.debug(`Computed proof for utility function with selector ${selector.toString()}`, {
-    functionArtifactHash,
-    functionMetadataHash,
-    artifactMetadataHash,
-    artifactFunctionTreeSiblingPath: artifactTreeSiblingPath.map(fr => fr.toString()).join(','),
-    privateFunctionsArtifactTreeRoot,
-  });
-
-  return {
-    artifactTreeSiblingPath,
-    artifactTreeLeafIndex,
-    artifactMetadataHash,
-    functionMetadataHash,
-    privateFunctionsArtifactTreeRoot,
-  };
-}
-
-/**
- * Verifies that a utility  function with a membership proof as emitted by the ClassRegistry contract is valid,
- * as defined in the protocol specs at contract-deployment/classes:
- *
- * ```
- * // Load contract class from local db
- * contract_class = db.get_contract_class(contract_class_id)
- *
- * // Compute artifact leaf and assert it belongs to the artifact
- * artifact_function_leaf = sha256(selector, metadata_hash, sha256(bytecode))
- * computed_artifact_utility_function_tree_root = compute_root(artifact_function_leaf, artifact_function_tree_sibling_path, artifact_function_tree_leaf_index)
- * computed_artifact_hash = sha256(private_functions_artifact_tree_root, computed_artifact_utility_function_tree_root, artifact_metadata_hash)
- * assert computed_artifact_hash == contract_class.artifact_hash
- * ```
- * @param fn - Function to check membership proof for.
- * @param contractClass - In which contract class the function is expected to be.
- */
-export async function isValidUtilityFunctionMembershipProof(
-  fn: UtilityFunctionWithMembershipProof,
-  contractClass: Pick<ContractClassPublic, 'artifactHash'>,
-) {
-  const log = createLogger('circuits:function_membership_proof');
-
-  const functionArtifactHash = await computeFunctionArtifactHash(fn);
-  const computedArtifactFunctionTreeRootBuffer = await computeRootFromSiblingPath(
-    functionArtifactHash.toBuffer(),
-    fn.artifactTreeSiblingPath.map(fr => fr.toBuffer()),
-    fn.artifactTreeLeafIndex,
-    getArtifactMerkleTreeHasher(),
-  );
-  const computedArtifactFunctionTreeRoot = Fr.fromBuffer(computedArtifactFunctionTreeRootBuffer);
-  const computedArtifactHash = await computeArtifactHash({
-    privateFunctionRoot: fn.privateFunctionsArtifactTreeRoot,
-    utilityFunctionRoot: computedArtifactFunctionTreeRoot,
-    metadataHash: fn.artifactMetadataHash,
-  });
-  if (!contractClass.artifactHash.equals(computedArtifactHash)) {
-    log.debug(`Artifact hash mismatch`, {
-      expected: contractClass.artifactHash,
-      computedArtifactHash,
-      computedFunctionArtifactHash: functionArtifactHash,
-      computedArtifactFunctionTreeRoot,
-      privateFunctionsArtifactTreeRoot: fn.privateFunctionsArtifactTreeRoot,
-      metadataHash: fn.artifactMetadataHash,
-      artifactFunctionTreeSiblingPath: fn.artifactTreeSiblingPath.map(fr => fr.toString()).join(','),
-    });
-    return false;
-  }
-
-  return true;
-}

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/utils/optional_number.ts

@@ -1,50 +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';
-
-export class OptionalNumber {
-  constructor(
-    /**
-     * Whether a value was set.
-     */
-    public isSome: boolean,
-    /**
-     * The actual number, if isSome is true.
-     */
-    public value: number,
-  ) {}
-
-  getSize() {
-    return this.toBuffer().length;
-  }
-
-  static getFields(fields: FieldsOf<OptionalNumber>) {
-    return [fields.isSome, fields.value] as const;
-  }
-
-  toBuffer() {
-    return serializeToBuffer(...OptionalNumber.getFields(this));
-  }
-
-  static fromBuffer(buffer: Buffer | BufferReader): OptionalNumber {
-    const reader = BufferReader.asReader(buffer);
-    return new OptionalNumber(reader.readBoolean(), reader.readNumber());
-  }
-
-  toFields(): Fr[] {
-    return serializeToFields(...OptionalNumber.getFields(this));
-  }
-
-  static fromFields(fields: Fr[] | FieldReader): OptionalNumber {
-    const reader = FieldReader.asReader(fields);
-    return new OptionalNumber(reader.readBoolean(), reader.readU32());
-  }
-
-  isEmpty(): boolean {
-    return !this.isSome && !this.value;
-  }
-
-  static empty() {
-    return new OptionalNumber(false, 0);
-  }
-}