@aztec/aztec.js 0.0.1-commit.1bea0213 → 0.0.1-commit.217f559981

package/src/contract/deploy_method.ts

@@ -14,7 +14,7 @@ import { ExecutionPayload, mergeExecutionPayloads } from '@aztec/stdlib/tx';
 
 import { publishContractClass } from '../deployment/publish_class.js';
 import { publishInstance } from '../deployment/publish_instance.js';
-import type { SendOptions, Wallet } from '../wallet/wallet.js';
+import type { ProfileOptions, SendOptions, SimulateOptions, Wallet } from '../wallet/wallet.js';
 import { BaseContractInteraction } from './base_contract_interaction.js';
 import type { ContractBase } from './contract_base.js';
 import { ContractFunctionInteraction } from './contract_function_interaction.js';
@@ -82,7 +82,7 @@ export type DeployOptionsWithoutWait = Omit<RequestDeployOptions, 'deployer'> &
    * is mutually exclusive with "deployer"
    */
   universalDeploy?: boolean;
-} & Pick<SendInteractionOptionsWithoutWait, 'from' | 'fee'>;
+} & Pick<SendInteractionOptionsWithoutWait, 'from' | 'fee' | 'additionalScopes'>;
 
 /**
  * Extends the deployment options with the required parameters to send the transaction.
@@ -207,7 +207,7 @@ export class DeployMethod<TContract extends ContractBase = ContractBase> extends
    * @param options - Deploy options with wait parameter
    * @returns Send options with wait parameter
    */
-  private convertDeployOptionsToSendOptions<W extends DeployInteractionWaitOptions>(
+  protected convertDeployOptionsToSendOptions<W extends DeployInteractionWaitOptions>(
     options: DeployOptions<W>,
     // eslint-disable-next-line jsdoc/require-jsdoc
   ): SendOptions<W extends { returnReceipt: true } ? WaitOpts : W> {
@@ -219,6 +219,24 @@ export class DeployMethod<TContract extends ContractBase = ContractBase> extends
     } as any;
   }
 
+  /**
+   * Converts deploy simulation options into wallet-level simulate options.
+   * @param options - The deploy simulation options to convert.
+   */
+  protected convertDeployOptionsToSimulateOptions(options: SimulateDeployOptions): SimulateOptions {
+    return toSimulateOptions(options);
+  }
+
+  /**
+   * Converts deploy profile options into wallet-level profile options.
+   * @param options - The deploy profile options to convert.
+   */
+  protected convertDeployOptionsToProfileOptions(
+    options: DeployOptionsWithoutWait & ProfileInteractionOptions,
+  ): ProfileOptions {
+    return toProfileOptions(options);
+  }
+
   /**
    * Adds this contract to the wallet and returns the Contract object.
    * @param options - Deployment options.
@@ -368,7 +386,10 @@ export class DeployMethod<TContract extends ContractBase = ContractBase> extends
    */
   public async simulate(options: SimulateDeployOptions): Promise<SimulationReturn<true>> {
     const executionPayload = await this.request(this.convertDeployOptionsToRequestOptions(options));
-    const simulatedTx = await this.wallet.simulateTx(executionPayload, toSimulateOptions(options));
+    const simulatedTx = await this.wallet.simulateTx(
+      executionPayload,
+      this.convertDeployOptionsToSimulateOptions(options),
+    );
 
     const { gasLimits, teardownGasLimits } = getGasLimits(simulatedTx, options.fee?.estimatedGasPadding);
     this.log.verbose(
@@ -390,11 +411,7 @@ export class DeployMethod<TContract extends ContractBase = ContractBase> extends
    */
   public async profile(options: DeployOptionsWithoutWait & ProfileInteractionOptions): Promise<TxProfileResult> {
     const executionPayload = await this.request(this.convertDeployOptionsToRequestOptions(options));
-    return await this.wallet.profileTx(executionPayload, {
-      ...toProfileOptions(options),
-      profileMode: options.profileMode,
-      skipProofGeneration: options.skipProofGeneration,
-    });
+    return await this.wallet.profileTx(executionPayload, this.convertDeployOptionsToProfileOptions(options));
   }
 
   /** Return this deployment address. */

package/src/contract/interaction_options.ts

@@ -82,6 +82,13 @@ export type SendInteractionOptionsWithoutWait = RequestInteractionOptions & {
   from: AztecAddress;
   /** The fee options for the transaction. */
   fee?: InteractionFeeOptions;
+  /**
+   * Additional addresses whose private state and keys should be accessible during execution,
+   * beyond the sender's. Required when the transaction needs to access private state or keys
+   * belonging to an address other than `from`, e.g. withdrawing from an escrow that holds
+   * its own private notes.
+   */
+  additionalScopes?: AztecAddress[];
 };
 
 /**

package/src/contract/protocol_contracts/auth-registry.ts

@@ -41,9 +41,10 @@ const AuthRegistryContractArtifact: ContractArtifact = {
         ],
         returnTypes: [],
         errorTypes: {
-          '2754040237334517471': { error_kind: 'fmtstring', length: 92, item_types: [] },
           '7555607922535724711': { error_kind: 'string', string: 'Preimage mismatch' },
+          '9530675838293881722': { error_kind: 'string', string: 'Writer did not write all data' },
           '9894212961085021188': { error_kind: 'string', string: 'Message not authorized by account' },
+          '12327971061804302172': { error_kind: 'fmtstring', length: 98, item_types: [] },
           '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' },
@@ -100,7 +101,7 @@ const AuthRegistryContractArtifact: ContractArtifact = {
             type: {
               kind: 'struct',
               fields: [
-                { name: 'storage', type: { kind: 'array', length: 17, type: { kind: 'field' } } },
+                { name: 'storage', type: { kind: 'array', length: 15, type: { kind: 'field' } } },
                 { name: 'len', type: { kind: 'integer', sign: 'unsigned', width: 32 } },
               ],
               path: 'std::collections::bounded_vec::BoundedVec',
@@ -161,6 +162,8 @@ const AuthRegistryContractArtifact: ContractArtifact = {
           },
           '4261968856572588300': { error_kind: 'string', string: 'Value does not fit in field' },
           '4440399188109668273': { error_kind: 'string', string: 'Input length must be a multiple of 32' },
+          '5417577161503694006': { error_kind: 'fmtstring', length: 56, item_types: [{ kind: 'field' }] },
+          '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',
@@ -262,6 +265,8 @@ const AuthRegistryContractArtifact: ContractArtifact = {
           },
           '4261968856572588300': { error_kind: 'string', string: 'Value does not fit in field' },
           '4440399188109668273': { error_kind: 'string', string: 'Input length must be a multiple of 32' },
+          '5417577161503694006': { error_kind: 'fmtstring', length: 56, item_types: [{ kind: 'field' }] },
+          '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',
@@ -298,6 +303,7 @@ const AuthRegistryContractArtifact: ContractArtifact = {
             length: 133,
             item_types: [{ kind: 'integer', sign: 'unsigned', width: 32 }],
           },
+          '17655676068928457687': { error_kind: 'string', string: 'Reader did not read all data' },
         },
       },
       bytecode: Buffer.from([]),

package/src/contract/protocol_contracts/contract-class-registry.ts

@@ -19,127 +19,6 @@ import { ContractFunctionInteraction } from '../contract_function_interaction.js
 const ContractClassRegistryContractArtifact: ContractArtifact = {
   name: 'ContractClassRegistry',
   functions: [
-    {
-      ...{
-        functionType: FunctionType.PRIVATE,
-        name: 'broadcast_private_function',
-        isOnlySelf: false,
-        isStatic: false,
-        isInitializer: false,
-        parameters: [
-          {
-            name: 'contract_class_id',
-            type: {
-              kind: 'struct',
-              fields: [{ name: 'inner', type: { kind: 'field' } }],
-              path: 'aztec::protocol_types::contract_class_id::ContractClassId',
-            },
-            visibility: 'private',
-          },
-          { name: 'artifact_metadata_hash', type: { kind: 'field' }, visibility: 'private' },
-          { name: 'utility_functions_artifact_tree_root', type: { kind: 'field' }, visibility: 'private' },
-          {
-            name: 'private_function_tree_sibling_path',
-            type: { kind: 'array', length: 7, type: { kind: 'field' } },
-            visibility: 'private',
-          },
-          { name: 'private_function_tree_leaf_index', type: { kind: 'field' }, visibility: 'private' },
-          {
-            name: 'artifact_function_tree_sibling_path',
-            type: { kind: 'array', length: 7, type: { kind: 'field' } },
-            visibility: 'private',
-          },
-          { name: 'artifact_function_tree_leaf_index', type: { kind: 'field' }, visibility: 'private' },
-          {
-            name: 'function_data',
-            type: {
-              kind: 'struct',
-              fields: [
-                {
-                  name: 'selector',
-                  type: {
-                    kind: 'struct',
-                    fields: [{ name: 'inner', type: { kind: 'integer', sign: 'unsigned', width: 32 } }],
-                    path: 'aztec::protocol_types::abis::function_selector::FunctionSelector',
-                  },
-                },
-                { name: 'metadata_hash', type: { kind: 'field' } },
-                { name: 'vk_hash', type: { kind: 'field' } },
-              ],
-              path: 'events::private_function_broadcasted::InnerPrivateFunction',
-            },
-            visibility: 'private',
-          },
-        ],
-        returnTypes: [],
-        errorTypes: {
-          '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
-          '2754040237334517471': { error_kind: 'fmtstring', length: 92, item_types: [] },
-          '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' },
-        },
-      },
-      bytecode: Buffer.from([]),
-      debugSymbols: '',
-    },
-    {
-      ...{
-        functionType: FunctionType.PRIVATE,
-        name: 'broadcast_utility_function',
-        isOnlySelf: false,
-        isStatic: false,
-        isInitializer: false,
-        parameters: [
-          {
-            name: 'contract_class_id',
-            type: {
-              kind: 'struct',
-              fields: [{ name: 'inner', type: { kind: 'field' } }],
-              path: 'aztec::protocol_types::contract_class_id::ContractClassId',
-            },
-            visibility: 'private',
-          },
-          { name: 'artifact_metadata_hash', type: { kind: 'field' }, visibility: 'private' },
-          { name: 'private_functions_artifact_tree_root', type: { kind: 'field' }, visibility: 'private' },
-          {
-            name: 'artifact_function_tree_sibling_path',
-            type: { kind: 'array', length: 7, type: { kind: 'field' } },
-            visibility: 'private',
-          },
-          { name: 'artifact_function_tree_leaf_index', type: { kind: 'field' }, visibility: 'private' },
-          {
-            name: 'function_data',
-            type: {
-              kind: 'struct',
-              fields: [
-                {
-                  name: 'selector',
-                  type: {
-                    kind: 'struct',
-                    fields: [{ name: 'inner', type: { kind: 'integer', sign: 'unsigned', width: 32 } }],
-                    path: 'aztec::protocol_types::abis::function_selector::FunctionSelector',
-                  },
-                },
-                { name: 'metadata_hash', type: { kind: 'field' } },
-              ],
-              path: 'events::utility_function_broadcasted::InnerUtilityFunction',
-            },
-            visibility: 'private',
-          },
-        ],
-        returnTypes: [],
-        errorTypes: {
-          '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
-          '2754040237334517471': { error_kind: 'fmtstring', length: 92, item_types: [] },
-          '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' },
-        },
-      },
-      bytecode: Buffer.from([]),
-      debugSymbols: '',
-    },
     {
       ...{
         functionType: FunctionType.PRIVATE,
@@ -157,193 +36,19 @@ const ContractClassRegistryContractArtifact: ContractArtifact = {
           '361444214588792908': { error_kind: 'string', string: 'attempt to multiply with overflow' },
           '922421554006670918': { error_kind: 'string', string: 'num_items is greater than MAX_ITEMS' },
           '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
-          '2754040237334517471': { error_kind: 'fmtstring', length: 92, item_types: [] },
+          '9475115977882098926': { error_kind: 'string', string: 'Extra bytes in the last field of the bytecode' },
           '10965409165809799877': {
             error_kind: 'string',
             string: 'Given in_len to absorb is larger than the input array len',
           },
+          '12469291177396340830': { error_kind: 'string', string: 'call to assert_max_bit_size' },
           '14990209321349310352': { error_kind: 'string', string: 'attempt to add with overflow' },
           '15669273164684982983': { error_kind: 'string', string: 'num_permutations is greater than MAX_PERMUTATIONS' },
           '15764276373176857197': { error_kind: 'string', string: 'Stack too deep' },
+          '15835548349546956319': { error_kind: 'string', string: 'Field failed to decompose into specified 32 limbs' },
           '16431471497789672479': { error_kind: 'string', string: 'Index out of bounds' },
           '16450579948625159707': { error_kind: 'string', string: 'Sponge must be in cache_size=1' },
-        },
-      },
-      bytecode: Buffer.from([]),
-      debugSymbols: '',
-    },
-    {
-      ...{
-        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' },
-          '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.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' },
-          '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([]),
@@ -380,42 +85,6 @@ export class ContractClassRegistryContract extends ContractBase {
   }
 
   declare public methods: {
-    /** broadcast_private_function(contract_class_id: struct, artifact_metadata_hash: field, utility_functions_artifact_tree_root: field, private_function_tree_sibling_path: array, private_function_tree_leaf_index: field, artifact_function_tree_sibling_path: array, artifact_function_tree_leaf_index: field, function_data: struct) */
-    broadcast_private_function: ((
-      contract_class_id: WrappedFieldLike,
-      artifact_metadata_hash: FieldLike,
-      utility_functions_artifact_tree_root: FieldLike,
-      private_function_tree_sibling_path: FieldLike[],
-      private_function_tree_leaf_index: FieldLike,
-      artifact_function_tree_sibling_path: FieldLike[],
-      artifact_function_tree_leaf_index: FieldLike,
-      function_data: { selector: FunctionSelectorLike; metadata_hash: FieldLike; vk_hash: FieldLike },
-    ) => ContractFunctionInteraction) &
-      Pick<ContractMethod, 'selector'>;
-
-    /** broadcast_utility_function(contract_class_id: struct, artifact_metadata_hash: field, private_functions_artifact_tree_root: field, artifact_function_tree_sibling_path: array, artifact_function_tree_leaf_index: field, function_data: struct) */
-    broadcast_utility_function: ((
-      contract_class_id: WrappedFieldLike,
-      artifact_metadata_hash: FieldLike,
-      private_functions_artifact_tree_root: FieldLike,
-      artifact_function_tree_sibling_path: FieldLike[],
-      artifact_function_tree_leaf_index: FieldLike,
-      function_data: { selector: FunctionSelectorLike; metadata_hash: FieldLike },
-    ) => 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'>;
 
@@ -426,8 +95,5 @@ export class ContractClassRegistryContract extends ContractBase {
       public_bytecode_commitment: FieldLike,
     ) => ContractFunctionInteraction) &
       Pick<ContractMethod, 'selector'>;
-
-    /** sync_state() */
-    sync_state: (() => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;
   };
 }