@aztec/aztec.js 0.0.1-commit.6d63667d → 0.0.1-commit.7cf39cb55

package/src/api/events.ts

@@ -1,44 +1,52 @@
 import { type EventMetadataDefinition, EventSelector, decodeFromAbi } from '@aztec/stdlib/abi';
 import type { AztecNode } from '@aztec/stdlib/interfaces/client';
 
+import type { PublicEvent, PublicEventFilter } from '../wallet/wallet.js';
+
 /**
  * Returns decoded public events given search parameters.
  * @param node - The node to request events from
- * @param eventMetadata - Metadata of the event. This should be the class generated from the contract. e.g. Contract.events.Event
- * @param from - The block number to search from.
- * @param limit - The amount of blocks to search.
- * @returns - The deserialized events.
+ * @param eventMetadataDef - Metadata of the event. This should be the class generated from the contract. e.g. Contract.events.Event
+ * @param filter - Filter options for the event query:
+ *   - `contractAddress`: The address of the contract that emitted the events.
+ *   - `txHash`: Transaction in which the events were emitted.
+ *   - `fromBlock`: The block number from which to start fetching events (inclusive). Defaults to 1.
+ *   - `toBlock`: The block number until which to fetch events (not inclusive). Defaults to latest + 1.
+ * @returns - The decoded events with metadata.
  */
-export async function getDecodedPublicEvents<T>(
+export async function getPublicEvents<T>(
   node: AztecNode,
   eventMetadataDef: EventMetadataDefinition,
-  from: number,
-  limit: number,
-): Promise<T[]> {
+  filter: PublicEventFilter,
+): Promise<PublicEvent<T>[]> {
   const { logs } = await node.getPublicLogs({
-    fromBlock: from,
-    toBlock: from + limit,
+    fromBlock: filter.fromBlock ? Number(filter.fromBlock) : undefined,
+    toBlock: filter.toBlock ? Number(filter.toBlock) : undefined,
+    txHash: filter.txHash,
+    contractAddress: filter.contractAddress,
   });
 
-  const decodedEvents = logs
-    .map(log => {
-      // +1 for the event selector
-      const expectedLength = eventMetadataDef.fieldNames.length + 1;
-      if (log.log.fields.length !== expectedLength) {
-        throw new Error(
-          `Something is weird here, we have matching EventSelectors, but the actual payload has mismatched length. Expected ${expectedLength}. Got ${log.log.fields.length}.`,
-        );
-      }
+  const decodedEvents: PublicEvent<T>[] = [];
+
+  for (const log of logs) {
+    const logFields = log.log.getEmittedFields();
+    // Event selector is at the last position of the emitted fields
+    const logEventSelector = EventSelector.fromField(logFields[logFields.length - 1]);
 
-      const logFields = log.log.getEmittedFields();
-      // We are assuming here that event logs are the last 4 bytes of the event. This is not enshrined but is a function of aztec.nr raw log emission.
-      if (!EventSelector.fromField(logFields[logFields.length - 1]).equals(eventMetadataDef.eventSelector)) {
-        return undefined;
-      }
+    if (!logEventSelector.equals(eventMetadataDef.eventSelector)) {
+      continue;
+    }
 
-      return decodeFromAbi([eventMetadataDef.abiType], log.log.fields) as T;
-    })
-    .filter(log => log !== undefined) as T[];
+    decodedEvents.push({
+      event: decodeFromAbi([eventMetadataDef.abiType], log.log.fields) as T,
+      metadata: {
+        l2BlockNumber: log.id.blockNumber,
+        l2BlockHash: log.id.blockHash,
+        txHash: log.id.txHash,
+        contractAddress: log.log.contractAddress,
+      },
+    });
+  }
 
   return decodedEvents;
 }

package/src/api/fields.ts

@@ -1,2 +1,3 @@
 export { Fr, Fq } from '@aztec/foundation/curves/bn254';
 export { GrumpkinScalar, Point } from '@aztec/foundation/curves/grumpkin';
+export { BlockNumber } from '@aztec/foundation/branded-types';

package/src/api/wallet.ts

@@ -1,6 +1,7 @@
 export {
   type Aliased,
   type SimulateOptions,
+  type SimulateUtilityOptions,
   type ProfileOptions,
   type SendOptions,
   type BatchableMethods,
@@ -11,11 +12,12 @@ export {
   type Wallet,
   type PrivateEvent,
   type PrivateEventFilter,
+  type PublicEvent,
+  type PublicEventFilter,
   type ContractMetadata,
   type ContractClassMetadata,
   AppCapabilitiesSchema,
   WalletCapabilitiesSchema,
-  FunctionCallSchema,
   ExecutionPayloadSchema,
   GasSettingsOptionSchema,
   WalletSimulationFeeOptionSchema,
@@ -28,6 +30,8 @@ export {
   EventMetadataDefinitionSchema,
   PrivateEventSchema,
   PrivateEventFilterSchema,
+  PublicEventSchema,
+  PublicEventFilterSchema,
   ContractClassMetadataSchema,
   ContractMetadataSchema,
   WalletSchema,

package/src/contract/batch_call.ts

@@ -82,7 +82,7 @@ export class BatchCall extends BaseContractInteraction {
     for (const [call] of utility) {
       batchRequests.push({
         name: 'simulateUtility' as const,
-        args: [call, options?.authWitnesses],
+        args: [call, { scope: options.from, authWitnesses: options.authWitnesses }],
       });
     }
 

package/src/contract/contract_function_interaction.ts

@@ -1,4 +1,11 @@
-import { type FunctionAbi, FunctionSelector, FunctionType, decodeFromAbi, encodeArguments } from '@aztec/stdlib/abi';
+import {
+  type FunctionAbi,
+  FunctionCall,
+  FunctionSelector,
+  FunctionType,
+  decodeFromAbi,
+  encodeArguments,
+} from '@aztec/stdlib/abi';
 import type { AuthWitness } from '@aztec/stdlib/auth-witness';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import { type Capsule, type HashedValues, type TxProfileResult, collectOffchainEffects } from '@aztec/stdlib/tx';
@@ -43,16 +50,16 @@ export class ContractFunctionInteraction extends BaseContractInteraction {
    */
   public async getFunctionCall() {
     const args = encodeArguments(this.functionDao, this.args);
-    return {
+    return FunctionCall.from({
       name: this.functionDao.name,
-      args,
+      to: this.contractAddress,
       selector: await FunctionSelector.fromNameAndParameters(this.functionDao.name, this.functionDao.parameters),
       type: this.functionDao.functionType,
-      to: this.contractAddress,
-      isStatic: this.functionDao.isStatic,
       hideMsgSender: false /** Only set to `true` for enqueued public function calls */,
+      isStatic: this.functionDao.isStatic,
+      args,
       returnTypes: this.functionDao.returnTypes,
-    };
+    });
   }
 
   /**
@@ -104,7 +111,10 @@ export class ContractFunctionInteraction extends BaseContractInteraction {
     // docs:end:simulate
     if (this.functionDao.functionType == FunctionType.UTILITY) {
       const call = await this.getFunctionCall();
-      const utilityResult = await this.wallet.simulateUtility(call, options.authWitnesses ?? []);
+      const utilityResult = await this.wallet.simulateUtility(call, {
+        scope: options.from,
+        authWitnesses: options.authWitnesses,
+      });
 
       // Decode the raw field elements to the actual return type
       const returnValue = utilityResult.result ? decodeFromAbi(this.functionDao.returnTypes, utilityResult.result) : [];

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' },
-          '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' },
-          '17655676068928457687': { error_kind: 'string', string: 'Reader did not read all data' },
-        },
-      },
-      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' },
-          '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' },
-          '17655676068928457687': { error_kind: 'string', string: 'Reader did not read all data' },
-        },
-      },
-      bytecode: Buffer.from([]),
-      debugSymbols: '',
-    },
     {
       ...{
         functionType: FunctionType.PRIVATE,
@@ -157,13 +36,16 @@ 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' },
+          '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' },
           '17655676068928457687': { error_kind: 'string', string: 'Reader did not read all data' },
@@ -203,30 +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'>;
-
     /** public_dispatch(selector: field) */
     public_dispatch: ((selector: FieldLike) => ContractFunctionInteraction) & Pick<ContractMethod, 'selector'>;
 

package/src/fee/fee_juice_payment_method_with_claim.ts

@@ -1,6 +1,6 @@
 import { Fr } from '@aztec/foundation/curves/bn254';
 import { ProtocolContractAddress } from '@aztec/protocol-contracts';
-import { FunctionSelector, FunctionType } from '@aztec/stdlib/abi';
+import { FunctionCall, FunctionSelector, FunctionType } from '@aztec/stdlib/abi';
 import type { AztecAddress } from '@aztec/stdlib/aztec-address';
 import type { GasSettings } from '@aztec/stdlib/gas';
 import { ExecutionPayload } from '@aztec/stdlib/tx';
@@ -27,10 +27,11 @@ export class FeeJuicePaymentMethodWithClaim implements FeePaymentMethod {
 
     return new ExecutionPayload(
       [
-        {
-          to: ProtocolContractAddress.FeeJuice,
+        FunctionCall.from({
           name: 'claim_and_end_setup',
+          to: ProtocolContractAddress.FeeJuice,
           selector,
+          type: FunctionType.PRIVATE,
           hideMsgSender: false,
           isStatic: false,
           args: [
@@ -40,8 +41,7 @@ export class FeeJuicePaymentMethodWithClaim implements FeePaymentMethod {
             new Fr(this.claim.messageLeafIndex),
           ],
           returnTypes: [],
-          type: FunctionType.PRIVATE,
-        },
+        }),
       ],
       [],
       [],

package/src/fee/private_fee_payment_method.ts

@@ -1,5 +1,5 @@
 import { Fr } from '@aztec/foundation/curves/bn254';
-import { type FunctionAbi, FunctionSelector, FunctionType, decodeFromAbi } from '@aztec/stdlib/abi';
+import { type FunctionAbi, FunctionCall, FunctionSelector, FunctionType, decodeFromAbi } from '@aztec/stdlib/abi';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import type { GasSettings } from '@aztec/stdlib/gas';
 import { ExecutionPayload } from '@aztec/stdlib/tx';
@@ -102,21 +102,21 @@ export class PrivateFeePaymentMethod implements FeePaymentMethod {
 
     const witness = await this.wallet.createAuthWit(this.sender, {
       caller: this.paymentContract,
-      call: {
+      call: FunctionCall.from({
         name: 'transfer_to_public',
-        args: [this.sender.toField(), this.paymentContract.toField(), maxFee, txNonce],
+        to: await this.getAsset(),
         selector: await FunctionSelector.fromSignature('transfer_to_public((Field),(Field),u128,Field)'),
         type: FunctionType.PRIVATE,
         hideMsgSender: false,
         isStatic: false,
-        to: await this.getAsset(),
+        args: [this.sender.toField(), this.paymentContract.toField(), maxFee, txNonce],
         returnTypes: [],
-      },
+      }),
     });
 
     return new ExecutionPayload(
       [
-        {
+        FunctionCall.from({
           name: 'fee_entrypoint_private',
           to: this.paymentContract,
           selector: await FunctionSelector.fromSignature('fee_entrypoint_private(u128,Field)'),
@@ -125,7 +125,7 @@ export class PrivateFeePaymentMethod implements FeePaymentMethod {
           isStatic: false,
           args: [maxFee, txNonce],
           returnTypes: [],
-        },
+        }),
       ],
       [witness],
       [],

package/src/fee/public_fee_payment_method.ts

@@ -1,5 +1,5 @@
 import { Fr } from '@aztec/foundation/curves/bn254';
-import { type FunctionAbi, FunctionSelector, FunctionType, decodeFromAbi } from '@aztec/stdlib/abi';
+import { type FunctionAbi, FunctionCall, FunctionSelector, FunctionType, decodeFromAbi } from '@aztec/stdlib/abi';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import { GasSettings } from '@aztec/stdlib/gas';
 import { ExecutionPayload } from '@aztec/stdlib/tx';
@@ -94,16 +94,16 @@ export class PublicFeePaymentMethod implements FeePaymentMethod {
 
     const intent = {
       caller: this.paymentContract,
-      call: {
+      call: FunctionCall.from({
         name: 'transfer_in_public',
-        args: [this.sender.toField(), this.paymentContract.toField(), maxFee, txNonce],
+        to: await this.getAsset(),
         selector: await FunctionSelector.fromSignature('transfer_in_public((Field),(Field),u128,Field)'),
         type: FunctionType.PUBLIC,
-        isStatic: false,
         hideMsgSender: false /** The target function performs an authwit check, so msg_sender is needed */,
-        to: await this.getAsset(),
+        isStatic: false,
+        args: [this.sender.toField(), this.paymentContract.toField(), maxFee, txNonce],
         returnTypes: [],
-      },
+      }),
     };
 
     const setPublicAuthWitInteraction = await SetPublicAuthwitContractInteraction.create(
@@ -116,7 +116,7 @@ export class PublicFeePaymentMethod implements FeePaymentMethod {
     return new ExecutionPayload(
       [
         ...(await setPublicAuthWitInteraction.request()).calls,
-        {
+        FunctionCall.from({
           name: 'fee_entrypoint_public',
           to: this.paymentContract,
           selector: await FunctionSelector.fromSignature('fee_entrypoint_public(u128,Field)'),
@@ -125,7 +125,7 @@ export class PublicFeePaymentMethod implements FeePaymentMethod {
           isStatic: false,
           args: [maxFee, txNonce],
           returnTypes: [],
-        },
+        }),
       ],
       [],
       [],

package/src/fee/sponsored_fee_payment.ts

@@ -1,5 +1,5 @@
 import type { FeePaymentMethod } from '@aztec/aztec.js/fee';
-import { FunctionSelector, FunctionType } from '@aztec/stdlib/abi';
+import { FunctionCall, FunctionSelector, FunctionType } from '@aztec/stdlib/abi';
 import { AztecAddress } from '@aztec/stdlib/aztec-address';
 import type { GasSettings } from '@aztec/stdlib/gas';
 import { ExecutionPayload } from '@aztec/stdlib/tx';
@@ -22,7 +22,7 @@ export class SponsoredFeePaymentMethod implements FeePaymentMethod {
   async getExecutionPayload(): Promise<ExecutionPayload> {
     return new ExecutionPayload(
       [
-        {
+        FunctionCall.from({
           name: 'sponsor_unconditionally',
           to: this.paymentContract,
           selector: await FunctionSelector.fromSignature('sponsor_unconditionally()'),
@@ -31,7 +31,7 @@ export class SponsoredFeePaymentMethod implements FeePaymentMethod {
           isStatic: false,
           args: [],
           returnTypes: [],
-        },
+        }),
       ],
       [],
       [],