@aztec/aztec.js 0.0.1-commit.d431d1c → 0.0.1-commit.e3c1de76

package/src/contract/protocol_contracts/fee-juice.ts

@@ -44,7 +44,6 @@ const FeeJuiceContractArtifact: ContractArtifact = {
         errorTypes: {
           '361444214588792908': { error_kind: 'string', string: 'attempt to multiply with overflow' },
           '1998584279744703196': { error_kind: 'string', string: 'attempt to subtract with overflow' },
-          '2754040237334517471': { error_kind: 'fmtstring', length: 92, item_types: [] },
           '6609888949476313245': { error_kind: 'string', string: 'Message not in state' },
           '11019205087382408538': { error_kind: 'string', string: 'Field failed to decompose into specified 4 limbs' },
           '12370419938245003393': { error_kind: 'string', string: 'Field failed to decompose into specified 36 limbs' },
@@ -94,121 +93,6 @@ const FeeJuiceContractArtifact: ContractArtifact = {
       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',
-          },
-          '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,
@@ -247,77 +131,6 @@ const FeeJuiceContractArtifact: ContractArtifact = {
       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([]),
-      debugSymbols: '',
-    },
   ],
   nonDispatchPublicFunctions: [
     {
@@ -445,22 +258,7 @@ export class FeeJuiceContract extends ContractBase {
     ) => 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_private_state() */
-    sync_private_state: (() => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;
   };
 }

package/src/contract/protocol_contracts/multi-call-entrypoint.ts

@@ -160,22 +160,14 @@ const MultiCallEntrypointContractArtifact: 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' },
+          '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': {
@@ -204,7 +196,7 @@ const MultiCallEntrypointContractArtifact: ContractArtifact = {
     {
       ...{
         functionType: FunctionType.UTILITY,
-        name: 'sync_private_state',
+        name: 'sync_state',
         isOnlySelf: false,
         isStatic: false,
         isInitializer: false,
@@ -231,6 +223,7 @@ const MultiCallEntrypointContractArtifact: 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' },
+          '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',
@@ -267,6 +260,7 @@ const MultiCallEntrypointContractArtifact: 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([]),
@@ -332,7 +326,7 @@ export class MultiCallEntrypointContract extends ContractBase {
     /** public_dispatch(selector: field) */
     public_dispatch: ((selector: FieldLike) => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;
 
-    /** sync_private_state() */
-    sync_private_state: (() => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;
+    /** sync_state() */
+    sync_state: (() => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;
   };
 }

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

@@ -93,22 +93,14 @@ const PublicChecksContractArtifact: 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' },
+          '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': {
@@ -155,10 +147,8 @@ const PublicChecksContractArtifact: ContractArtifact = {
           },
           '12511970388699677811': { error_kind: 'fmtstring', length: 27, item_types: [{ kind: 'field' }] },
           '13950240626967988787': { error_kind: 'string', string: 'Timestamp mismatch.' },
-          '14990209321349310352': { error_kind: 'string', string: 'attempt to add with overflow' },
           '15015303112667403944': { error_kind: 'fmtstring', length: 17, item_types: [] },
           '15764276373176857197': { error_kind: 'string', string: 'Stack too deep' },
-          '16431471497789672479': { error_kind: 'string', string: 'Index out of bounds' },
         },
       },
       bytecode: Buffer.from([]),
@@ -167,7 +157,7 @@ const PublicChecksContractArtifact: ContractArtifact = {
     {
       ...{
         functionType: FunctionType.UTILITY,
-        name: 'sync_private_state',
+        name: 'sync_state',
         isOnlySelf: false,
         isStatic: false,
         isInitializer: false,
@@ -194,6 +184,7 @@ const PublicChecksContractArtifact: 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' },
+          '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',
@@ -230,6 +221,7 @@ const PublicChecksContractArtifact: 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([]),
@@ -318,7 +310,7 @@ export class PublicChecksContract extends ContractBase {
     /** public_dispatch(selector: field) */
     public_dispatch: ((selector: FieldLike) => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;
 
-    /** sync_private_state() */
-    sync_private_state: (() => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;
+    /** sync_state() */
+    sync_state: (() => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;
   };
 }

package/src/contract/wait_for_proven.ts

@@ -2,7 +2,7 @@ import { retryUntil } from '@aztec/foundation/retry';
 import type { AztecNode } from '@aztec/stdlib/interfaces/client';
 import type { TxReceipt } from '@aztec/stdlib/tx';
 
-import { DefaultWaitOpts } from './sent_tx.js';
+import { DefaultWaitOpts } from './wait_opts.js';
 
 /**
  * Options for waiting for a transaction to be proven.

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

@@ -5,16 +5,18 @@ import { type ABIParameterVisibility, type FunctionAbi, type FunctionCall, Funct
 import { AuthWitness, computeInnerAuthWitHash, computeOuterAuthWitHash } from '@aztec/stdlib/auth-witness';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 import { computeVarArgsHash } from '@aztec/stdlib/hash';
-import type { TxProfileResult } from '@aztec/stdlib/tx';
+import type { TxHash, TxProfileResult, TxReceipt } from '@aztec/stdlib/tx';
 
 import { ContractFunctionInteraction } from '../contract/contract_function_interaction.js';
 import type {
+  InteractionWaitOptions,
   ProfileInteractionOptions,
   SendInteractionOptions,
+  SendInteractionOptionsWithoutWait,
+  SendReturn,
   SimulateInteractionOptions,
   SimulationReturn,
 } from '../contract/interaction_options.js';
-import type { SentTx } from '../contract/sent_tx.js';
 import type { Wallet } from '../wallet/index.js';
 
 /** Intent with an inner hash */
@@ -286,9 +288,19 @@ export class SetPublicAuthwitContractInteraction extends ContractFunctionInterac
    * Overrides the send method, adding the sender of the authwit (authorizer) as from
    * and preventing misuse
    * @param options - An optional object containing 'fee' options information
-   * @returns A SentTx instance for tracking the transaction status and information.
+   * @returns A TxReceipt (if wait is true/undefined) or TxHash (if wait is false)
    */
-  public override send(options: Omit<SendInteractionOptions, 'from'> = {}): SentTx {
+  // Overload for when wait is not specified at all - returns TxReceipt
+  public override send(options?: Omit<SendInteractionOptionsWithoutWait, 'from'>): Promise<TxReceipt>;
+  // Generic overload for explicit wait values
+  // eslint-disable-next-line jsdoc/require-jsdoc
+  public override send<W extends InteractionWaitOptions>(
+    options?: Omit<SendInteractionOptions<W>, 'from'>,
+  ): Promise<SendReturn<W>>;
+  // eslint-disable-next-line jsdoc/require-jsdoc
+  public override send(
+    options?: Omit<SendInteractionOptions<InteractionWaitOptions>, 'from'>,
+  ): Promise<TxReceipt | TxHash> {
     return super.send({ ...options, from: this.from });
   }
 

package/src/utils/node.ts

@@ -1,6 +1,10 @@
 import type { Logger } from '@aztec/foundation/log';
 import { retryUntil } from '@aztec/foundation/retry';
 import type { AztecNode } from '@aztec/stdlib/interfaces/client';
+import type { TxHash, TxReceipt } from '@aztec/stdlib/tx';
+import { SortedTxStatuses, TxStatus } from '@aztec/stdlib/tx';
+
+import { DefaultWaitOpts, type WaitOpts } from '../contract/wait_opts.js';
 
 export const waitForNode = async (node: AztecNode, logger?: Logger) => {
   await retryUntil(async () => {
@@ -16,4 +20,62 @@ export const waitForNode = async (node: AztecNode, logger?: Logger) => {
   }, 'RPC Get Node Info');
 };
 
+/** Returns true if the receipt status is at least the desired status level. */
+function hasReachedStatus(receipt: TxReceipt, desiredStatus: TxStatus): boolean {
+  return SortedTxStatuses.indexOf(receipt.status) >= SortedTxStatuses.indexOf(desiredStatus);
+}
+
+/**
+ * Waits for a transaction to be mined and returns its receipt.
+ * @param node - The Aztec node to query for transaction status
+ * @param txHash - The hash of the transaction to wait for
+ * @param opts - Optional configuration for waiting behavior
+ * @returns The transaction receipt
+ * @throws If the transaction fails and dontThrowOnRevert is not set
+ */
+export async function waitForTx(node: AztecNode, txHash: TxHash, opts?: WaitOpts): Promise<TxReceipt> {
+  const startTime = Date.now();
+  const ignoreDroppedReceiptsFor = opts?.ignoreDroppedReceiptsFor ?? DefaultWaitOpts.ignoreDroppedReceiptsFor;
+  const waitForStatus = opts?.waitForStatus ?? TxStatus.CHECKPOINTED;
+
+  const receipt = await retryUntil(
+    async () => {
+      const txReceipt = await node.getTxReceipt(txHash);
+      // If receipt is not yet available, try again
+      if (txReceipt.isPending()) {
+        return undefined;
+      }
+      // If the tx was "dropped", either return it or ignore based on timing.
+      // We can ignore it at first because the transaction may have been sent to node 1, and now we're asking node 2 for the receipt.
+      // If we don't allow a short grace period, we could incorrectly return a TxReceipt with status DROPPED.
+      if (txReceipt.isDropped()) {
+        const elapsedSeconds = (Date.now() - startTime) / 1000;
+        if (!ignoreDroppedReceiptsFor || elapsedSeconds > ignoreDroppedReceiptsFor) {
+          return txReceipt;
+        }
+        return undefined;
+      }
+      // Check if the receipt has reached the desired status level
+      if (!hasReachedStatus(txReceipt, waitForStatus)) {
+        return undefined;
+      }
+      return txReceipt;
+    },
+    'isMined',
+    opts?.timeout ?? DefaultWaitOpts.timeout,
+    opts?.interval ?? DefaultWaitOpts.interval,
+  );
+
+  if (!receipt.isMined()) {
+    throw new Error(`Transaction ${txHash.toString()} was ${receipt.status}. Reason: ${receipt.error ?? 'unknown'}`);
+  }
+  if (!receipt.hasExecutionSucceeded() && !opts?.dontThrowOnRevert) {
+    throw new Error(
+      `Transaction ${txHash.toString()} reverted: ${receipt.executionResult}. Reason: ${receipt.error ?? 'unknown'}`,
+    );
+  }
+
+  return receipt;
+}
+
 export { createAztecNodeClient, type AztecNode } from '@aztec/stdlib/interfaces/client';