@aztec/aztec.js 0.0.1-commit.f295ac2 → 0.0.1-commit.f8ca9b2f3

package/src/contract/interaction_options.ts

@@ -2,10 +2,11 @@ import type { FieldsOf } from '@aztec/foundation/types';
 import type { AuthWitness } from '@aztec/stdlib/auth-witness';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 import type { GasSettings } from '@aztec/stdlib/gas';
-import type { Capsule, OffchainEffect, SimulationStats } from '@aztec/stdlib/tx';
+import type { Capsule, OffchainEffect, SimulationStats, TxHash, TxReceipt } from '@aztec/stdlib/tx';
 
 import type { FeePaymentMethod } from '../fee/fee_payment_method.js';
 import type { ProfileOptions, SendOptions, SimulateOptions } from '../wallet/index.js';
+import type { WaitOpts } from './wait_opts.js';
 
 /**
  * Options used to tweak the simulation and add gas estimation capabilities
@@ -55,15 +56,47 @@ export type RequestInteractionOptions = {
 };
 
 /**
- * Represents options for calling a (constrained) function in a contract.
+ * Constant for explicitly not waiting for transaction confirmation.
+ * We use this instead of false to avoid confusion with falsy checks.
+ */
+export const NO_WAIT = 'NO_WAIT' as const;
+
+/**
+ * Type for the NO_WAIT constant.
+ */
+export type NoWait = typeof NO_WAIT;
+
+/**
+ * Type for wait options in interactions.
+ * - NO_WAIT symbol: Don't wait for confirmation, return TxHash immediately
+ * - WaitOpts object: Wait with custom options and return receipt/result
+ * - undefined: Wait with default options and return receipt/result
+ */
+export type InteractionWaitOptions = NoWait | WaitOpts | undefined;
+
+/**
+ * Base options for calling a (constrained) function in a contract, without wait parameter.
  */
-export type SendInteractionOptions = RequestInteractionOptions & {
+export type SendInteractionOptionsWithoutWait = RequestInteractionOptions & {
   /** The sender's Aztec address. */
   from: AztecAddress;
   /** The fee options for the transaction. */
   fee?: InteractionFeeOptions;
 };
 
+/**
+ * Represents options for calling a (constrained) function in a contract.
+ */
+export type SendInteractionOptions<W extends InteractionWaitOptions = undefined> = SendInteractionOptionsWithoutWait & {
+  /**
+   * Whether to wait for the transaction to be mined.
+   * - undefined (default): wait with default options and return TxReceipt
+   * - WaitOpts object: wait with custom options and return TxReceipt
+   * - NO_WAIT: return txHash immediately without waiting
+   */
+  wait?: W;
+};
+
 /**
  * Represents the options for simulating a contract function interaction.
  * Allows specifying the address from which the method should be called.
@@ -110,11 +143,22 @@ export type SimulationReturn<T extends boolean | undefined> = T extends true
     }
   : any;
 
+/**
+ * Represents the result type of sending a transaction.
+ * If `wait` is NO_WAIT, returns TxHash immediately without waiting.
+ * If `wait` is undefined or WaitOpts, returns TReturn (defaults to TxReceipt) after waiting.
+ */
+export type SendReturn<T extends InteractionWaitOptions, TReturn = TxReceipt> = T extends NoWait ? TxHash : TReturn;
+
 /**
  * Transforms and cleans up the higher level SendInteractionOptions defined by the interaction into
  * SendOptions, which are the ones that can be serialized and forwarded to the wallet
+ * @param options - The send interaction options with optional wait parameter
+ * @returns The send options to forward to the wallet
  */
-export function toSendOptions(options: SendInteractionOptions): SendOptions {
+export function toSendOptions<W extends InteractionWaitOptions = undefined>(
+  options: SendInteractionOptions<W>,
+): SendOptions<W> {
   return {
     ...options,
     fee: {
@@ -126,6 +170,7 @@ export function toSendOptions(options: SendInteractionOptions): SendOptions {
         ...options.fee?.gasSettings,
       },
     },
+    wait: options.wait, // Pass through wait option
   };
 }
 

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

@@ -21,32 +21,38 @@ const AuthRegistryContractArtifact: ContractArtifact = {
   functions: [
     {
       ...{
-        functionType: FunctionType.PRIVATE,
-        name: 'set_authorized_private',
+        functionType: FunctionType.PUBLIC,
+        name: 'public_dispatch',
         isOnlySelf: false,
         isStatic: false,
         isInitializer: false,
-        parameters: [
-          {
-            name: 'approver',
-            type: {
-              kind: 'struct',
-              fields: [{ name: 'inner', type: { kind: 'field' } }],
-              path: 'aztec::protocol_types::address::aztec_address::AztecAddress',
-            },
-            visibility: 'private',
-          },
-          { name: 'message_hash', type: { kind: 'field' }, visibility: 'private' },
-          { name: 'authorize', type: { kind: 'boolean' }, visibility: 'private' },
-        ],
+        parameters: [{ name: 'selector', type: { kind: 'field' }, visibility: 'private' }],
         returnTypes: [],
         errorTypes: {
-          '2754040237334517471': { error_kind: 'fmtstring', length: 92, item_types: [] },
-          '7555607922535724711': { error_kind: 'string', string: 'Preimage mismatch' },
-          '9894212961085021188': { error_kind: 'string', string: 'Message not authorized by account' },
+          '361444214588792908': { error_kind: 'string', string: 'attempt to multiply with overflow' },
+          '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
+          '5525725861591553972': { error_kind: 'string', string: 'rejecting all' },
+          '11691217184967371519': {
+            error_kind: 'string',
+            string: 'Function is_reject_all can only be called statically',
+          },
+          '12511970388699677811': { error_kind: 'fmtstring', length: 27, item_types: [{ kind: 'field' }] },
+          '13455385521185560676': {
+            error_kind: 'string',
+            string: 'Storage slot 0 not allowed. Storage slots must start from 1.',
+          },
+          '13929691561421487185': {
+            error_kind: 'string',
+            string: 'Function _set_authorized can only be called by the same contract',
+          },
           '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' },
+          '17089945683942782951': { error_kind: 'string', string: 'unauthorized' },
+          '17312933876399746100': {
+            error_kind: 'string',
+            string: 'Function is_consumable can only be called statically',
+          },
         },
       },
       bytecode: Buffer.from([]),
@@ -54,14 +60,14 @@ const AuthRegistryContractArtifact: ContractArtifact = {
     },
     {
       ...{
-        functionType: FunctionType.UTILITY,
-        name: 'utility_is_consumable',
+        functionType: FunctionType.PRIVATE,
+        name: 'set_authorized_private',
         isOnlySelf: false,
         isStatic: false,
         isInitializer: false,
         parameters: [
           {
-            name: 'on_behalf_of',
+            name: 'approver',
             type: {
               kind: 'struct',
               fields: [{ name: 'inner', type: { kind: 'field' } }],
@@ -70,16 +76,14 @@ const AuthRegistryContractArtifact: ContractArtifact = {
             visibility: 'private',
           },
           { name: 'message_hash', type: { kind: 'field' }, visibility: 'private' },
+          { name: 'authorize', type: { kind: 'boolean' }, visibility: 'private' },
         ],
-        returnTypes: [{ kind: 'boolean' }],
+        returnTypes: [],
         errorTypes: {
-          '13455385521185560676': {
-            error_kind: 'string',
-            string: 'Storage slot 0 not allowed. Storage slots must start from 1.',
-          },
+          '7555607922535724711': { error_kind: 'string', string: 'Preimage mismatch' },
+          '9894212961085021188': { error_kind: 'string', string: 'Message not authorized by account' },
           '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([]),
@@ -88,221 +92,33 @@ const AuthRegistryContractArtifact: ContractArtifact = {
     {
       ...{
         functionType: FunctionType.UTILITY,
-        name: 'process_message',
+        name: 'utility_is_consumable',
         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',
+            name: 'on_behalf_of',
             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',
+              fields: [{ name: 'inner', type: { kind: 'field' } }],
+              path: 'aztec::protocol_types::address::aztec_address::AztecAddress',
             },
             visibility: 'private',
           },
+          { name: 'message_hash', type: { kind: 'field' }, visibility: 'private' },
         ],
-        returnTypes: [],
+        returnTypes: [{ kind: 'boolean' }],
         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 }],
-          },
-        },
-      },
-      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: {
-          '5525725861591553972': { error_kind: 'string', string: 'rejecting all' },
-          '11691217184967371519': {
-            error_kind: 'string',
-            string: 'Function is_reject_all can only be called statically',
-          },
-          '12511970388699677811': { error_kind: 'fmtstring', length: 27, item_types: [{ kind: 'field' }] },
           '13455385521185560676': {
             error_kind: 'string',
             string: 'Storage slot 0 not allowed. Storage slots must start from 1.',
           },
-          '13929691561421487185': {
-            error_kind: 'string',
-            string: 'Function _set_authorized can only be called by the same contract',
-          },
           '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' },
-          '17089945683942782951': { error_kind: 'string', string: 'unauthorized' },
-          '17312933876399746100': {
-            error_kind: 'string',
-            string: 'Function is_consumable can only be called statically',
-          },
-        },
-      },
-      bytecode: Buffer.from([]),
-      debugSymbols: '',
-    },
-    {
-      ...{
-        functionType: FunctionType.UTILITY,
-        name: 'sync_private_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 }],
-          },
         },
       },
       bytecode: Buffer.from([]),
@@ -331,6 +147,8 @@ const AuthRegistryContractArtifact: ContractArtifact = {
       ],
       returnTypes: [],
       errorTypes: {
+        '361444214588792908': { error_kind: 'string', string: 'attempt to multiply with overflow' },
+        '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
         '13455385521185560676': {
           error_kind: 'string',
           string: 'Storage slot 0 not allowed. Storage slots must start from 1.',
@@ -364,6 +182,8 @@ const AuthRegistryContractArtifact: ContractArtifact = {
       ],
       returnTypes: [{ kind: 'field' }],
       errorTypes: {
+        '361444214588792908': { error_kind: 'string', string: 'attempt to multiply with overflow' },
+        '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
         '5525725861591553972': { error_kind: 'string', string: 'rejecting all' },
         '13455385521185560676': {
           error_kind: 'string',
@@ -395,6 +215,8 @@ const AuthRegistryContractArtifact: ContractArtifact = {
       ],
       returnTypes: [{ kind: 'boolean' }],
       errorTypes: {
+        '361444214588792908': { error_kind: 'string', string: 'attempt to multiply with overflow' },
+        '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
         '13455385521185560676': {
           error_kind: 'string',
           string: 'Storage slot 0 not allowed. Storage slots must start from 1.',
@@ -450,6 +272,8 @@ const AuthRegistryContractArtifact: ContractArtifact = {
       ],
       returnTypes: [],
       errorTypes: {
+        '361444214588792908': { error_kind: 'string', string: 'attempt to multiply with overflow' },
+        '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
         '13455385521185560676': {
           error_kind: 'string',
           string: 'Storage slot 0 not allowed. Storage slots must start from 1.',
@@ -502,18 +326,6 @@ export class AuthRegistryContract extends ContractBase {
     /** is_reject_all(on_behalf_of: struct) */
     is_reject_all: ((on_behalf_of: AztecAddressLike) => 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'>;
 
@@ -532,9 +344,6 @@ export class AuthRegistryContract extends ContractBase {
     /** set_reject_all(reject: boolean) */
     set_reject_all: ((reject: boolean) => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;
 
-    /** sync_private_state() */
-    sync_private_state: (() => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;
-
     /** utility_is_consumable(on_behalf_of: struct, message_hash: field) */
     utility_is_consumable: ((on_behalf_of: AztecAddressLike, message_hash: FieldLike) => ContractFunctionInteraction) &
       Pick<ContractMethod, 'selector'>;