@aztec/aztec.js 0.0.0-test.1 → 0.0.1-commit.023c3e5

package/src/contract/protocol_contracts/public-checks.ts

@@ -0,0 +1,316 @@
+/* Autogenerated file, do not edit! */
+/* eslint-disable */
+import { ProtocolContractAddress } from '@aztec/protocol-contracts';
+import { FunctionType } from '@aztec/stdlib/abi';
+
+import type { ContractArtifact } from '../../api/abi.js';
+import { PublicKeys } from '../../api/keys.js';
+import type {
+  AztecAddressLike,
+  EthAddressLike,
+  FieldLike,
+  FunctionSelectorLike,
+  WrappedFieldLike,
+} from '../../utils/abi_types.js';
+import type { Wallet } from '../../wallet/wallet.js';
+import { ContractBase, type ContractMethod } from '../contract_base.js';
+import { ContractFunctionInteraction } from '../contract_function_interaction.js';
+
+const PublicChecksContractArtifact: ContractArtifact = {
+  name: 'PublicChecks',
+  functions: [
+    {
+      ...{
+        functionType: FunctionType.UTILITY,
+        name: 'process_message',
+        isOnlySelf: false,
+        isStatic: false,
+        isInitializer: false,
+        parameters: [
+          {
+            name: 'message_ciphertext',
+            type: {
+              kind: 'struct',
+              fields: [
+                { name: 'storage', type: { kind: 'array', length: 17, type: { kind: 'field' } } },
+                { name: 'len', type: { kind: 'integer', sign: 'unsigned', width: 32 } },
+              ],
+              path: 'std::collections::bounded_vec::BoundedVec',
+            },
+            visibility: 'private',
+          },
+          {
+            name: 'message_context',
+            type: {
+              kind: 'struct',
+              fields: [
+                { name: 'tx_hash', type: { kind: 'field' } },
+                {
+                  name: 'unique_note_hashes_in_tx',
+                  type: {
+                    kind: 'struct',
+                    fields: [
+                      { name: 'storage', type: { kind: 'array', length: 64, type: { kind: 'field' } } },
+                      { name: 'len', type: { kind: 'integer', sign: 'unsigned', width: 32 } },
+                    ],
+                    path: 'std::collections::bounded_vec::BoundedVec',
+                  },
+                },
+                { name: 'first_nullifier_in_tx', type: { kind: 'field' } },
+                {
+                  name: 'recipient',
+                  type: {
+                    kind: 'struct',
+                    fields: [{ name: 'inner', type: { kind: 'field' } }],
+                    path: 'aztec::protocol_types::address::aztec_address::AztecAddress',
+                  },
+                },
+              ],
+              path: 'aztec::messages::processing::message_context::MessageContext',
+            },
+            visibility: 'private',
+          },
+        ],
+        returnTypes: [],
+        errorTypes: {
+          '361444214588792908': { error_kind: 'string', string: 'attempt to multiply with overflow' },
+          '992401946138144806': { error_kind: 'string', string: 'Attempted to read past end of BoundedVec' },
+          '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
+          '2967937905572420042': {
+            error_kind: 'fmtstring',
+            length: 61,
+            item_types: [{ kind: 'field' }, { kind: 'field' }],
+          },
+          '3330370348214585450': {
+            error_kind: 'fmtstring',
+            length: 48,
+            item_types: [{ kind: 'field' }, { kind: 'field' }],
+          },
+          '3670003311596808700': {
+            error_kind: 'fmtstring',
+            length: 77,
+            item_types: [{ kind: 'integer', sign: 'unsigned', width: 32 }],
+          },
+          '4261968856572588300': { error_kind: 'string', string: 'Value does not fit in field' },
+          '4440399188109668273': { error_kind: 'string', string: 'Input length must be a multiple of 32' },
+          '9530675838293881722': { error_kind: 'string', string: 'Writer did not write all data' },
+          '9791669845391776238': {
+            error_kind: 'string',
+            string: '0 has a square root; you cannot claim it is not square',
+          },
+          '10135509984888824963': { error_kind: 'fmtstring', length: 58, item_types: [{ kind: 'field' }] },
+          '10791800398362570014': { error_kind: 'string', string: 'extend_from_bounded_vec out of bounds' },
+          '11692359521570349358': { error_kind: 'fmtstring', length: 40, item_types: [] },
+          '12469291177396340830': { error_kind: 'string', string: 'call to assert_max_bit_size' },
+          '12913276134398371456': { error_kind: 'string', string: 'push out of bounds' },
+          '13557316507370296400': {
+            error_kind: 'fmtstring',
+            length: 130,
+            item_types: [{ kind: 'integer', sign: 'unsigned', width: 32 }],
+          },
+          '14938672389828944159': {
+            error_kind: 'fmtstring',
+            length: 146,
+            item_types: [{ kind: 'integer', sign: 'unsigned', width: 32 }],
+          },
+          '14990209321349310352': { error_kind: 'string', string: 'attempt to add with overflow' },
+          '15764276373176857197': { error_kind: 'string', string: 'Stack too deep' },
+          '16431471497789672479': { error_kind: 'string', string: 'Index out of bounds' },
+          '17531474008201752295': {
+            error_kind: 'fmtstring',
+            length: 133,
+            item_types: [{ kind: 'integer', sign: 'unsigned', width: 32 }],
+          },
+        },
+      },
+      bytecode: Buffer.from([]),
+      debugSymbols: '',
+    },
+    {
+      ...{
+        functionType: FunctionType.PUBLIC,
+        name: 'public_dispatch',
+        isOnlySelf: false,
+        isStatic: false,
+        isInitializer: false,
+        parameters: [{ name: 'selector', type: { kind: 'field' }, visibility: 'private' }],
+        returnTypes: [],
+        errorTypes: {
+          '3445904810750103705': { error_kind: 'string', string: 'Block number mismatch.' },
+          '6989792215391248978': {
+            error_kind: 'string',
+            string: 'Function check_timestamp can only be called statically',
+          },
+          '7259463707251703666': {
+            error_kind: 'string',
+            string: 'Function check_block_number can only be called statically',
+          },
+          '12511970388699677811': { error_kind: 'fmtstring', length: 27, item_types: [{ kind: 'field' }] },
+          '13950240626967988787': { error_kind: 'string', string: 'Timestamp mismatch.' },
+          '15015303112667403944': { error_kind: 'fmtstring', length: 17, item_types: [] },
+          '15764276373176857197': { error_kind: 'string', string: 'Stack too deep' },
+        },
+      },
+      bytecode: Buffer.from([]),
+      debugSymbols: '',
+    },
+    {
+      ...{
+        functionType: FunctionType.UTILITY,
+        name: 'sync_state',
+        isOnlySelf: false,
+        isStatic: false,
+        isInitializer: false,
+        parameters: [],
+        returnTypes: [],
+        errorTypes: {
+          '361444214588792908': { error_kind: 'string', string: 'attempt to multiply with overflow' },
+          '992401946138144806': { error_kind: 'string', string: 'Attempted to read past end of BoundedVec' },
+          '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
+          '2967937905572420042': {
+            error_kind: 'fmtstring',
+            length: 61,
+            item_types: [{ kind: 'field' }, { kind: 'field' }],
+          },
+          '3330370348214585450': {
+            error_kind: 'fmtstring',
+            length: 48,
+            item_types: [{ kind: 'field' }, { kind: 'field' }],
+          },
+          '3670003311596808700': {
+            error_kind: 'fmtstring',
+            length: 77,
+            item_types: [{ kind: 'integer', sign: 'unsigned', width: 32 }],
+          },
+          '4261968856572588300': { error_kind: 'string', string: 'Value does not fit in field' },
+          '4440399188109668273': { error_kind: 'string', string: 'Input length must be a multiple of 32' },
+          '9530675838293881722': { error_kind: 'string', string: 'Writer did not write all data' },
+          '9791669845391776238': {
+            error_kind: 'string',
+            string: '0 has a square root; you cannot claim it is not square',
+          },
+          '9885968605480832328': {
+            error_kind: 'string',
+            string: 'Attempted to read past the length of a CapsuleArray',
+          },
+          '10135509984888824963': { error_kind: 'fmtstring', length: 58, item_types: [{ kind: 'field' }] },
+          '10791800398362570014': { error_kind: 'string', string: 'extend_from_bounded_vec out of bounds' },
+          '11021520179822076911': {
+            error_kind: 'string',
+            string: 'Attempted to delete past the length of a CapsuleArray',
+          },
+          '11692359521570349358': { error_kind: 'fmtstring', length: 40, item_types: [] },
+          '12327971061804302172': { error_kind: 'fmtstring', length: 98, item_types: [] },
+          '12469291177396340830': { error_kind: 'string', string: 'call to assert_max_bit_size' },
+          '12913276134398371456': { error_kind: 'string', string: 'push out of bounds' },
+          '13557316507370296400': {
+            error_kind: 'fmtstring',
+            length: 130,
+            item_types: [{ kind: 'integer', sign: 'unsigned', width: 32 }],
+          },
+          '14938672389828944159': {
+            error_kind: 'fmtstring',
+            length: 146,
+            item_types: [{ kind: 'integer', sign: 'unsigned', width: 32 }],
+          },
+          '14990209321349310352': { error_kind: 'string', string: 'attempt to add with overflow' },
+          '15764276373176857197': { error_kind: 'string', string: 'Stack too deep' },
+          '16431471497789672479': { error_kind: 'string', string: 'Index out of bounds' },
+          '17531474008201752295': {
+            error_kind: 'fmtstring',
+            length: 133,
+            item_types: [{ kind: 'integer', sign: 'unsigned', width: 32 }],
+          },
+          '17655676068928457687': { error_kind: 'string', string: 'Reader did not read all data' },
+        },
+      },
+      bytecode: Buffer.from([]),
+      debugSymbols: '',
+    },
+  ],
+  nonDispatchPublicFunctions: [
+    {
+      functionType: FunctionType.PUBLIC,
+      name: 'check_block_number',
+      isOnlySelf: false,
+      isStatic: true,
+      isInitializer: false,
+      parameters: [
+        { name: 'operation', type: { kind: 'integer', sign: 'unsigned', width: 8 }, visibility: 'private' },
+        { name: 'value', type: { kind: 'integer', sign: 'unsigned', width: 32 }, visibility: 'private' },
+      ],
+      returnTypes: [],
+      errorTypes: {
+        '3445904810750103705': { error_kind: 'string', string: 'Block number mismatch.' },
+        '7259463707251703666': {
+          error_kind: 'string',
+          string: 'Function check_block_number can only be called statically',
+        },
+        '15015303112667403944': { error_kind: 'fmtstring', length: 17, item_types: [] },
+        '15764276373176857197': { error_kind: 'string', string: 'Stack too deep' },
+      },
+    },
+    {
+      functionType: FunctionType.PUBLIC,
+      name: 'check_timestamp',
+      isOnlySelf: false,
+      isStatic: true,
+      isInitializer: false,
+      parameters: [
+        { name: 'operation', type: { kind: 'integer', sign: 'unsigned', width: 8 }, visibility: 'private' },
+        { name: 'value', type: { kind: 'integer', sign: 'unsigned', width: 64 }, visibility: 'private' },
+      ],
+      returnTypes: [],
+      errorTypes: {
+        '6989792215391248978': {
+          error_kind: 'string',
+          string: 'Function check_timestamp can only be called statically',
+        },
+        '13950240626967988787': { error_kind: 'string', string: 'Timestamp mismatch.' },
+        '15015303112667403944': { error_kind: 'fmtstring', length: 17, item_types: [] },
+        '15764276373176857197': { error_kind: 'string', string: 'Stack too deep' },
+      },
+    },
+  ],
+  outputs: { structs: {}, globals: {} },
+  storageLayout: {},
+  fileMap: {},
+};
+
+export class PublicChecksContract extends ContractBase {
+  private constructor(wallet: Wallet) {
+    super(ProtocolContractAddress.PublicChecks, PublicChecksContractArtifact, wallet);
+  }
+
+  public static at(wallet: Wallet): PublicChecksContract {
+    return new PublicChecksContract(wallet);
+  }
+
+  declare public methods: {
+    /** check_block_number(operation: integer, value: integer) */
+    check_block_number: ((operation: bigint | number, value: bigint | number) => ContractFunctionInteraction) &
+      Pick<ContractMethod, 'selector'>;
+
+    /** check_timestamp(operation: integer, value: integer) */
+    check_timestamp: ((operation: bigint | number, value: bigint | number) => ContractFunctionInteraction) &
+      Pick<ContractMethod, 'selector'>;
+
+    /** process_message(message_ciphertext: struct, message_context: struct) */
+    process_message: ((
+      message_ciphertext: FieldLike[],
+      message_context: {
+        tx_hash: FieldLike;
+        unique_note_hashes_in_tx: FieldLike[];
+        first_nullifier_in_tx: FieldLike;
+        recipient: AztecAddressLike;
+      },
+    ) => ContractFunctionInteraction) &
+      Pick<ContractMethod, 'selector'>;
+
+    /** public_dispatch(selector: field) */
+    public_dispatch: ((selector: FieldLike) => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;
+
+    /** sync_state() */
+    sync_state: (() => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;
+  };
+}

package/src/contract/wait_for_proven.ts

@@ -0,0 +1,38 @@
+import { retryUntil } from '@aztec/foundation/retry';
+import type { AztecNode } from '@aztec/stdlib/interfaces/client';
+import type { TxReceipt } from '@aztec/stdlib/tx';
+
+import { DefaultWaitOpts } from './wait_opts.js';
+
+/**
+ * Options for waiting for a transaction to be proven.
+ */
+export type WaitForProvenOpts = {
+  /** Time to wait for the tx to be proven before timing out */
+  provenTimeout?: number;
+  /** Elapsed time between polls to the node */
+  interval?: number;
+};
+
+export const DefaultWaitForProvenOpts: WaitForProvenOpts = {
+  provenTimeout: 600,
+  interval: DefaultWaitOpts.interval,
+};
+
+/**
+ * Wait for a transaction to be proven by polling the node
+ */
+export async function waitForProven(node: AztecNode, receipt: TxReceipt, opts?: WaitForProvenOpts) {
+  if (!receipt.blockNumber) {
+    throw new Error(`Cannot wait for proven: receipt of tx ${receipt.txHash} does not have a block number`);
+  }
+  return await retryUntil(
+    async () => {
+      const provenBlock = await node.getProvenBlockNumber();
+      return provenBlock >= receipt.blockNumber! ? provenBlock : undefined;
+    },
+    'isProven',
+    opts?.provenTimeout ?? DefaultWaitForProvenOpts.provenTimeout,
+    opts?.interval ?? DefaultWaitForProvenOpts.interval,
+  );
+}

package/src/contract/wait_opts.ts

@@ -0,0 +1,21 @@
+import type { TxStatus } from '@aztec/stdlib/tx';
+
+/** Options related to waiting for a tx. */
+export type WaitOpts = {
+  /** The amount of time to ignore TxStatus.DROPPED receipts (in seconds) due to the presumption that it is being propagated by the p2p network. Defaults to 5. */
+  ignoreDroppedReceiptsFor?: number;
+  /** The maximum time (in seconds) to wait for the transaction to be mined. Defaults to 60. */
+  timeout?: number;
+  /** The time interval (in seconds) between retries to fetch the transaction receipt. Defaults to 1. */
+  interval?: number;
+  /** Whether to accept a revert as a status code for the tx when waiting for it. If false, will throw if the tx reverts. */
+  dontThrowOnRevert?: boolean;
+  /** The minimum inclusion status to wait for. If set, waits until the receipt reaches this status or higher. Defaults to CHECKPOINTED. */
+  waitForStatus?: TxStatus;
+};
+
+export const DefaultWaitOpts: WaitOpts = {
+  ignoreDroppedReceiptsFor: 5,
+  timeout: 300,
+  interval: 1,
+};

package/src/deployment/broadcast_function.ts

@@ -1,26 +1,26 @@
 import {
   ARTIFACT_FUNCTION_TREE_MAX_HEIGHT,
+  CONTRACT_CLASS_REGISTRY_BYTECODE_CAPSULE_SLOT,
   MAX_PACKED_BYTECODE_SIZE_PER_PRIVATE_FUNCTION_IN_FIELDS,
-  REGISTERER_CONTRACT_BYTECODE_CAPSULE_SLOT,
 } from '@aztec/constants';
 import { padArrayEnd } from '@aztec/foundation/collection';
-import { Fr } from '@aztec/foundation/fields';
+import { Fr } from '@aztec/foundation/curves/bn254';
 import { ProtocolContractAddress } from '@aztec/protocol-contracts';
 import { type ContractArtifact, FunctionSelector, FunctionType, bufferAsFields } from '@aztec/stdlib/abi';
 import {
   computeVerificationKeyHash,
   createPrivateFunctionMembershipProof,
-  createUnconstrainedFunctionMembershipProof,
+  createUtilityFunctionMembershipProof,
   getContractClassFromArtifact,
 } from '@aztec/stdlib/contract';
 import { Capsule } from '@aztec/stdlib/tx';
 
 import type { ContractFunctionInteraction } from '../contract/contract_function_interaction.js';
-import { getRegistererContract } from '../contract/protocol_contracts.js';
+import { ContractClassRegistryContract } from '../contract/protocol_contracts/contract-class-registry.js';
 import type { Wallet } from '../wallet/index.js';
 
 /**
- * Sets up a call to broadcast a private function's bytecode via the ClassRegisterer contract.
+ * Sets up a call to broadcast a private function's bytecode via the ClassRegistry contract.
  * Note that this is not required for users to call the function, but is rather a convenience to make
  * this code publicly available so dapps or wallets do not need to redistribute it.
  * @param wallet - Wallet to send the transaction.
@@ -51,43 +51,43 @@ export async function broadcastPrivateFunction(
     artifactTreeLeafIndex,
     artifactMetadataHash,
     functionMetadataHash,
-    unconstrainedFunctionsArtifactTreeRoot,
+    utilityFunctionsTreeRoot,
     privateFunctionTreeSiblingPath,
     privateFunctionTreeLeafIndex,
   } = await createPrivateFunctionMembershipProof(selector, artifact);
 
   const vkHash = await computeVerificationKeyHash(privateFunctionArtifact);
 
-  const registerer = await getRegistererContract(wallet);
-  const fn = registerer.methods.broadcast_private_function(
-    contractClass.id,
-    artifactMetadataHash,
-    unconstrainedFunctionsArtifactTreeRoot,
-    privateFunctionTreeSiblingPath,
-    privateFunctionTreeLeafIndex,
-    padArrayEnd(artifactTreeSiblingPath, Fr.ZERO, ARTIFACT_FUNCTION_TREE_MAX_HEIGHT),
-    artifactTreeLeafIndex,
-    // eslint-disable-next-line camelcase
-    { selector, metadata_hash: functionMetadataHash, vk_hash: vkHash },
-  );
-
+  const classRegistry = ContractClassRegistryContract.at(wallet);
   const bytecode = bufferAsFields(
     privateFunctionArtifact.bytecode,
     MAX_PACKED_BYTECODE_SIZE_PER_PRIVATE_FUNCTION_IN_FIELDS,
   );
-  fn.addCapsule(
-    new Capsule(
-      ProtocolContractAddress.ContractClassRegisterer,
-      new Fr(REGISTERER_CONTRACT_BYTECODE_CAPSULE_SLOT),
-      bytecode,
-    ),
-  );
-
-  return fn;
+  return classRegistry.methods
+    .broadcast_private_function(
+      contractClass.id,
+      artifactMetadataHash,
+      utilityFunctionsTreeRoot,
+      privateFunctionTreeSiblingPath,
+      privateFunctionTreeLeafIndex,
+      padArrayEnd(artifactTreeSiblingPath, Fr.ZERO, ARTIFACT_FUNCTION_TREE_MAX_HEIGHT),
+      artifactTreeLeafIndex,
+      // eslint-disable-next-line camelcase
+      { selector, metadata_hash: functionMetadataHash, vk_hash: vkHash },
+    )
+    .with({
+      capsules: [
+        new Capsule(
+          ProtocolContractAddress.ContractClassRegistry,
+          new Fr(CONTRACT_CLASS_REGISTRY_BYTECODE_CAPSULE_SLOT),
+          bytecode,
+        ),
+      ],
+    });
 }
 
 /**
- * Sets up a call to broadcast an unconstrained function's bytecode via the ClassRegisterer contract.
+ * Sets up a call to broadcast a utility function's bytecode via the ClassRegistry contract.
  * Note that this is not required for users to call the function, but is rather a convenience to make
  * this code publicly available so dapps or wallets do not need to redistribute it.
  * @param wallet - Wallet to send the transaction.
@@ -95,22 +95,22 @@ export async function broadcastPrivateFunction(
  * @param selector - Selector of the function to be broadcast.
  * @returns A ContractFunctionInteraction object that can be used to send the transaction.
  */
-export async function broadcastUnconstrainedFunction(
+export async function broadcastUtilityFunction(
   wallet: Wallet,
   artifact: ContractArtifact,
   selector: FunctionSelector,
 ): Promise<ContractFunctionInteraction> {
   const contractClass = await getContractClassFromArtifact(artifact);
-  const unconstrainedFunctions = artifact.functions.filter(fn => fn.functionType === FunctionType.UNCONSTRAINED);
-  const unconstrainedFunctionsAndSelectors = await Promise.all(
-    unconstrainedFunctions.map(async fn => ({
+  const utilityFunctions = artifact.functions.filter(fn => fn.functionType === FunctionType.UTILITY);
+  const utilityFunctionsAndSelectors = await Promise.all(
+    utilityFunctions.map(async fn => ({
       f: fn,
       selector: await FunctionSelector.fromNameAndParameters(fn.name, fn.parameters),
     })),
   );
-  const unconstrainedFunctionArtifact = unconstrainedFunctionsAndSelectors.find(fn => selector.equals(fn.selector))?.f;
-  if (!unconstrainedFunctionArtifact) {
-    throw new Error(`Unconstrained function with selector ${selector.toString()} not found`);
+  const utilityFunctionArtifact = utilityFunctionsAndSelectors.find(fn => selector.equals(fn.selector))?.f;
+  if (!utilityFunctionArtifact) {
+    throw new Error(`Utility function with selector ${selector.toString()} not found`);
   }
 
   const {
@@ -119,30 +119,30 @@ export async function broadcastUnconstrainedFunction(
     artifactTreeSiblingPath,
     functionMetadataHash,
     privateFunctionsArtifactTreeRoot,
-  } = await createUnconstrainedFunctionMembershipProof(selector, artifact);
-
-  const registerer = await getRegistererContract(wallet);
-  const fn = registerer.methods.broadcast_unconstrained_function(
-    contractClass.id,
-    artifactMetadataHash,
-    privateFunctionsArtifactTreeRoot,
-    padArrayEnd(artifactTreeSiblingPath, Fr.ZERO, ARTIFACT_FUNCTION_TREE_MAX_HEIGHT),
-    artifactTreeLeafIndex,
-    // eslint-disable-next-line camelcase
-    { selector, metadata_hash: functionMetadataHash },
-  );
+  } = await createUtilityFunctionMembershipProof(selector, artifact);
 
+  const classRegistry = ContractClassRegistryContract.at(wallet);
   const bytecode = bufferAsFields(
-    unconstrainedFunctionArtifact.bytecode,
+    utilityFunctionArtifact.bytecode,
     MAX_PACKED_BYTECODE_SIZE_PER_PRIVATE_FUNCTION_IN_FIELDS,
   );
-  fn.addCapsule(
-    new Capsule(
-      ProtocolContractAddress.ContractClassRegisterer,
-      new Fr(REGISTERER_CONTRACT_BYTECODE_CAPSULE_SLOT),
-      bytecode,
-    ),
-  );
-
-  return fn;
+  return classRegistry.methods
+    .broadcast_utility_function(
+      contractClass.id,
+      artifactMetadataHash,
+      privateFunctionsArtifactTreeRoot,
+      padArrayEnd(artifactTreeSiblingPath, Fr.ZERO, ARTIFACT_FUNCTION_TREE_MAX_HEIGHT),
+      artifactTreeLeafIndex,
+      // eslint-disable-next-line camelcase
+      { selector, metadata_hash: functionMetadataHash },
+    )
+    .with({
+      capsules: [
+        new Capsule(
+          ProtocolContractAddress.ContractClassRegistry,
+          new Fr(CONTRACT_CLASS_REGISTRY_BYTECODE_CAPSULE_SLOT),
+          bytecode,
+        ),
+      ],
+    });
 }

package/src/deployment/contract_deployer.ts

@@ -1,10 +1,10 @@
 import type { ContractArtifact } from '@aztec/stdlib/abi';
-import { AztecAddress } from '@aztec/stdlib/aztec-address';
+import type { ContractInstanceWithAddress } from '@aztec/stdlib/contract';
 import { PublicKeys } from '@aztec/stdlib/keys';
 
-import type { Wallet } from '../account/wallet.js';
 import { Contract } from '../contract/contract.js';
 import { DeployMethod } from '../contract/deploy_method.js';
+import type { Wallet } from '../wallet/wallet.js';
 
 /**
  * A class for deploying contract.
@@ -28,7 +28,8 @@ export class ContractDeployer {
    * @returns A DeployMethod instance configured with the ABI, PXE, and constructor arguments.
    */
   public deploy(...args: any[]) {
-    const postDeployCtor = (address: AztecAddress, wallet: Wallet) => Contract.at(address, this.artifact, wallet);
+    const postDeployCtor = (instance: ContractInstanceWithAddress, wallet: Wallet) =>
+      Contract.at(instance.address, this.artifact, wallet);
     return new DeployMethod(
       this.publicKeys ?? PublicKeys.default(),
       this.wallet,

package/src/deployment/publish_class.ts

@@ -0,0 +1,34 @@
+import {
+  CONTRACT_CLASS_REGISTRY_BYTECODE_CAPSULE_SLOT,
+  MAX_PACKED_PUBLIC_BYTECODE_SIZE_IN_FIELDS,
+} from '@aztec/constants';
+import { Fr } from '@aztec/foundation/curves/bn254';
+import { ProtocolContractAddress } from '@aztec/protocol-contracts';
+import { type ContractArtifact, bufferAsFields } from '@aztec/stdlib/abi';
+import { getContractClassFromArtifact } from '@aztec/stdlib/contract';
+import { Capsule } from '@aztec/stdlib/tx';
+
+import type { ContractFunctionInteraction } from '../contract/contract_function_interaction.js';
+import { ContractClassRegistryContract } from '../contract/protocol_contracts/contract-class-registry.js';
+import type { Wallet } from '../wallet/index.js';
+
+/** Sets up a call to publish a contract class given its artifact. */
+export async function publishContractClass(
+  wallet: Wallet,
+  artifact: ContractArtifact,
+): Promise<ContractFunctionInteraction> {
+  const { artifactHash, privateFunctionsRoot, publicBytecodeCommitment, packedBytecode } =
+    await getContractClassFromArtifact(artifact);
+  const classRegistry = ContractClassRegistryContract.at(wallet);
+
+  const encodedBytecode = bufferAsFields(packedBytecode, MAX_PACKED_PUBLIC_BYTECODE_SIZE_IN_FIELDS);
+  return classRegistry.methods.publish(artifactHash, privateFunctionsRoot, publicBytecodeCommitment).with({
+    capsules: [
+      new Capsule(
+        ProtocolContractAddress.ContractClassRegistry,
+        new Fr(CONTRACT_CLASS_REGISTRY_BYTECODE_CAPSULE_SLOT),
+        encodedBytecode,
+      ),
+    ],
+  });
+}

package/src/deployment/publish_instance.ts

@@ -0,0 +1,23 @@
+import type { ContractInstanceWithAddress } from '@aztec/stdlib/contract';
+
+import type { ContractFunctionInteraction } from '../contract/contract_function_interaction.js';
+import { ContractInstanceRegistryContract } from '../contract/protocol_contracts/contract-instance-registry.js';
+import type { Wallet } from '../wallet/wallet.js';
+
+/**
+ * Sets up a call to the canonical contract instance registry to publish a contract instance.
+ * @param wallet - The wallet to use for the publication (setup) tx.
+ * @param instance - The instance to publish.
+ */
+export function publishInstance(wallet: Wallet, instance: ContractInstanceWithAddress): ContractFunctionInteraction {
+  const contractInstanceRegistry = ContractInstanceRegistryContract.at(wallet);
+  const { salt, currentContractClassId: contractClassId, publicKeys, deployer: instanceDeployer } = instance;
+  const isUniversalDeploy = instanceDeployer.isZero();
+  return contractInstanceRegistry.methods.publish_for_public_execution(
+    salt,
+    contractClassId,
+    instance.initializationHash,
+    publicKeys,
+    isUniversalDeploy,
+  );
+}