@aztec/protocol-contracts 5.0.0-private.20260318 → 5.0.0-rc.1

package/src/class-registry/utility_function_broadcasted_event.ts

@@ -1,103 +0,0 @@
-import {
-  ARTIFACT_FUNCTION_TREE_MAX_HEIGHT,
-  CONTRACT_CLASS_REGISTRY_UTILITY_FUNCTION_BROADCASTED_MAGIC_VALUE,
-  MAX_PACKED_BYTECODE_SIZE_PER_UTILITY_FUNCTION_IN_FIELDS,
-} from '@aztec/constants';
-import { removeArrayPaddingEnd } from '@aztec/foundation/collection';
-import { Fr } from '@aztec/foundation/curves/bn254';
-import type { Tuple } from '@aztec/foundation/serialize';
-import { FieldReader } from '@aztec/foundation/serialize';
-import { FunctionSelector, bufferFromFields } from '@aztec/stdlib/abi';
-import type { UtilityFunction, UtilityFunctionWithMembershipProof } from '@aztec/stdlib/contract';
-import type { ContractClassLog } from '@aztec/stdlib/logs';
-
-import { ProtocolContractAddress } from '../protocol_contract_data.js';
-
-/** Event emitted from the ContractClassRegistry. */
-export class UtilityFunctionBroadcastedEvent {
-  constructor(
-    public readonly contractClassId: Fr,
-    public readonly artifactMetadataHash: Fr,
-    public readonly privateFunctionsArtifactTreeRoot: Fr,
-    public readonly artifactFunctionTreeSiblingPath: Tuple<Fr, typeof ARTIFACT_FUNCTION_TREE_MAX_HEIGHT>,
-    public readonly artifactFunctionTreeLeafIndex: number,
-    public readonly utilityFunction: BroadcastedUtilityFunction,
-  ) {}
-
-  static isUtilityFunctionBroadcastedEvent(log: ContractClassLog) {
-    return (
-      log.contractAddress.equals(ProtocolContractAddress.ContractClassRegistry) &&
-      log.fields.fields[0].toBigInt() === CONTRACT_CLASS_REGISTRY_UTILITY_FUNCTION_BROADCASTED_MAGIC_VALUE
-    );
-  }
-
-  static fromLog(log: ContractClassLog) {
-    const reader = new FieldReader(log.fields.fields.slice(1));
-    const event = UtilityFunctionBroadcastedEvent.fromFields(reader);
-    while (!reader.isFinished()) {
-      const field = reader.readField();
-      if (!field.isZero()) {
-        throw new Error(`Unexpected data after parsing UtilityFunctionBroadcastedEvent: ${field.toString()}`);
-      }
-    }
-
-    return event;
-  }
-
-  static fromFields(fields: Fr[] | FieldReader) {
-    const reader = FieldReader.asReader(fields);
-    const contractClassId = reader.readField();
-    const artifactMetadataHash = reader.readField();
-    const privateFunctionsArtifactTreeRoot = reader.readField();
-    const artifactFunctionTreeSiblingPath = reader.readFieldArray(ARTIFACT_FUNCTION_TREE_MAX_HEIGHT);
-    const artifactFunctionTreeLeafIndex = reader.readField().toNumber();
-    const utilityFunction = BroadcastedUtilityFunction.fromFields(reader);
-
-    return new UtilityFunctionBroadcastedEvent(
-      contractClassId,
-      artifactMetadataHash,
-      privateFunctionsArtifactTreeRoot,
-      artifactFunctionTreeSiblingPath,
-      artifactFunctionTreeLeafIndex,
-      utilityFunction,
-    );
-  }
-
-  toFunctionWithMembershipProof(): UtilityFunctionWithMembershipProof {
-    // We should be able to safely remove the zero elements that pad the variable-length sibling path,
-    // since a sibling with value zero can only occur on the tree leaves, so the sibling path will never end
-    // in a zero. The only exception is a tree with depth 2 with one non-zero leaf, where the sibling path would
-    // be a single zero element, but in that case the artifact tree should be just the single leaf.
-    const artifactTreeSiblingPath = removeArrayPaddingEnd(this.artifactFunctionTreeSiblingPath, Fr.isZero);
-    return {
-      ...this.utilityFunction,
-      bytecode: this.utilityFunction.bytecode,
-      functionMetadataHash: this.utilityFunction.metadataHash,
-      artifactMetadataHash: this.artifactMetadataHash,
-      privateFunctionsArtifactTreeRoot: this.privateFunctionsArtifactTreeRoot,
-      artifactTreeSiblingPath,
-      artifactTreeLeafIndex: this.artifactFunctionTreeLeafIndex,
-    };
-  }
-}
-
-export class BroadcastedUtilityFunction implements UtilityFunction {
-  constructor(
-    /** Selector of the function. Calculated as the hash of the method name and parameters. The specification of this is not enforced by the protocol. */
-    public readonly selector: FunctionSelector,
-    /** Artifact metadata hash */
-    public readonly metadataHash: Fr,
-    /** Brillig bytecode */
-    public readonly bytecode: Buffer,
-  ) {}
-
-  static fromFields(fields: Fr[] | FieldReader) {
-    const reader = FieldReader.asReader(fields);
-    const selector = FunctionSelector.fromField(reader.readField());
-    const metadataHash = reader.readField();
-    // The '* 1' removes the 'Type instantiation is excessively deep and possibly infinite. ts(2589)' err
-    const encodedBytecode = reader.readFieldArray(MAX_PACKED_BYTECODE_SIZE_PER_UTILITY_FUNCTION_IN_FIELDS * 1);
-    const bytecode = bufferFromFields(encodedBytecode);
-    return new BroadcastedUtilityFunction(selector, metadataHash, bytecode);
-  }
-}

package/src/multi-call-entrypoint/index.ts

@@ -1,18 +0,0 @@
-import { loadContractArtifact } from '@aztec/stdlib/abi';
-import type { NoirCompiledContract } from '@aztec/stdlib/noir';
-
-import MultiCallEntrypointJson from '../../artifacts/MultiCallEntrypoint.json' with { type: 'json' };
-import { makeProtocolContract } from '../make_protocol_contract.js';
-import type { ProtocolContract } from '../protocol_contract.js';
-
-export const MultiCallEntrypointArtifact = loadContractArtifact(MultiCallEntrypointJson as NoirCompiledContract);
-
-let protocolContract: ProtocolContract;
-
-/** Returns the canonical deployment of the contract. */
-export function getCanonicalMultiCallEntrypoint(): Promise<ProtocolContract> {
-  if (!protocolContract) {
-    protocolContract = makeProtocolContract('MultiCallEntrypoint', MultiCallEntrypointArtifact);
-  }
-  return Promise.resolve(protocolContract);
-}

package/src/multi-call-entrypoint/lazy.ts

@@ -1,29 +0,0 @@
-import { type ContractArtifact, loadContractArtifact } from '@aztec/stdlib/abi';
-
-import { makeProtocolContract } from '../make_protocol_contract.js';
-import type { ProtocolContract } from '../protocol_contract.js';
-
-let protocolContract: ProtocolContract;
-let protocolContractArtifact: ContractArtifact;
-
-export async function getMultiCallEntrypointArtifact(): Promise<ContractArtifact> {
-  if (!protocolContractArtifact) {
-    // Cannot assert this import as it's incompatible with bundlers like vite
-    // https://github.com/vitejs/vite/issues/19095#issuecomment-2566074352
-    // Even if now supported by al major browsers, the MIME type is replaced with
-    // "text/javascript"
-    // In the meantime, this lazy import is INCOMPATIBLE WITH NODEJS
-    const { default: multiCallEntrypointJson } = await import('../../artifacts/MultiCallEntrypoint.json');
-    protocolContractArtifact = loadContractArtifact(multiCallEntrypointJson);
-  }
-  return protocolContractArtifact;
-}
-
-/** Returns the canonical deployment of the auth registry. */
-export async function getCanonicalMultiCallEntrypoint(): Promise<ProtocolContract> {
-  if (!protocolContract) {
-    const multiCallEntrypointArtifact = await getMultiCallEntrypointArtifact();
-    protocolContract = makeProtocolContract('MultiCallEntrypoint', multiCallEntrypointArtifact);
-  }
-  return protocolContract;
-}

package/src/public-checks/index.ts

@@ -1,18 +0,0 @@
-import { loadContractArtifact } from '@aztec/stdlib/abi';
-import type { NoirCompiledContract } from '@aztec/stdlib/noir';
-
-import PublicChecksJson from '../../artifacts/PublicChecks.json' with { type: 'json' };
-import { makeProtocolContract } from '../make_protocol_contract.js';
-import type { ProtocolContract } from '../protocol_contract.js';
-
-export const PublicChecksArtifact = loadContractArtifact(PublicChecksJson as NoirCompiledContract);
-
-let protocolContract: ProtocolContract;
-
-/** Returns the canonical deployment of the contract. */
-export function getCanonicalPublicChecks(): Promise<ProtocolContract> {
-  if (!protocolContract) {
-    protocolContract = makeProtocolContract('PublicChecks', PublicChecksArtifact);
-  }
-  return Promise.resolve(protocolContract);
-}

package/src/public-checks/lazy.ts

@@ -1,29 +0,0 @@
-import { type ContractArtifact, loadContractArtifact } from '@aztec/stdlib/abi';
-
-import { makeProtocolContract } from '../make_protocol_contract.js';
-import type { ProtocolContract } from '../protocol_contract.js';
-
-let protocolContract: ProtocolContract;
-let protocolContractArtifact: ContractArtifact;
-
-export async function getPublicChecksArtifact(): Promise<ContractArtifact> {
-  if (!protocolContractArtifact) {
-    // Cannot assert this import as it's incompatible with bundlers like vite
-    // https://github.com/vitejs/vite/issues/19095#issuecomment-2566074352
-    // Even if now supported by al major browsers, the MIME type is replaced with
-    // "text/javascript"
-    // In the meantime, this lazy import is INCOMPATIBLE WITH NODEJS
-    const { default: publicChecksJson } = await import('../../artifacts/PublicChecks.json');
-    protocolContractArtifact = loadContractArtifact(publicChecksJson);
-  }
-  return protocolContractArtifact;
-}
-
-/** Returns the canonical deployment of the public checks contract. */
-export async function getCanonicalPublicChecks(): Promise<ProtocolContract> {
-  if (!protocolContract) {
-    const publicChecksArtifact = await getPublicChecksArtifact();
-    protocolContract = makeProtocolContract('PublicChecks', publicChecksArtifact);
-  }
-  return protocolContract;
-}