@aztec/aztec.js 0.42.0 → 0.44.0

package/src/wallet/account_wallet.ts

@@ -1,11 +1,17 @@
-import { type AuthWitness, type FunctionCall, type PXE, type TxExecutionRequest } from '@aztec/circuit-types';
+import { type AuthWitness, type PXE, type TxExecutionRequest } from '@aztec/circuit-types';
 import { AztecAddress, CANONICAL_KEY_REGISTRY_ADDRESS, Fq, Fr, derivePublicKeyFromSecretKey } from '@aztec/circuits.js';
 import { type ABIParameterVisibility, type FunctionAbi, FunctionType } from '@aztec/foundation/abi';
+import { AuthRegistryAddress } from '@aztec/protocol-contracts/auth-registry';
 
 import { type AccountInterface } from '../account/interface.js';
 import { ContractFunctionInteraction } from '../contract/contract_function_interaction.js';
 import { type ExecutionRequestInit } from '../entrypoint/entrypoint.js';
-import { computeAuthWitMessageHash } from '../utils/authwit.js';
+import {
+  type IntentAction,
+  type IntentInnerHash,
+  computeAuthWitMessageHash,
+  computeInnerAuthWitHashFromAction,
+} from '../utils/authwit.js';
 import { BaseWallet } from './base_wallet.js';
 
 /**
@@ -29,28 +35,25 @@ export class AccountWallet extends BaseWallet {
   }
 
   /**
-   * Computes an authentication witness from either a message or a caller and an action.
-   * If a message is provided, it will create a witness for the message directly.
-   * Otherwise, it will compute the message using the caller and the action.
-   * @param messageHashOrIntent - The message or the caller and action to approve
+   * Computes an authentication witness from either a message hash or an intent.
+   *
+   * If a message hash is provided, it will create a witness for the hash directly.
+   * Otherwise, it will compute the message hash using the intent, along with the
+   * chain id and the version values provided by the wallet.
+   *
+   * @param messageHashOrIntent - The message hash of the intent to approve
    * @returns The authentication witness
    */
-  async createAuthWit(
-    messageHashOrIntent:
-      | Fr
-      | Buffer
-      | {
-          /** The caller to approve  */
-          caller: AztecAddress;
-          /** The action to approve */
-          action: ContractFunctionInteraction | FunctionCall;
-          /** The chain id to approve */
-          chainId?: Fr;
-          /** The version to approve  */
-          version?: Fr;
-        },
-  ): Promise<AuthWitness> {
-    const messageHash = this.getMessageHash(messageHashOrIntent);
+  async createAuthWit(messageHashOrIntent: Fr | Buffer | IntentAction | IntentInnerHash): Promise<AuthWitness> {
+    let messageHash: Fr;
+    if (Buffer.isBuffer(messageHashOrIntent)) {
+      messageHash = Fr.fromBuffer(messageHashOrIntent);
+    } else if (messageHashOrIntent instanceof Fr) {
+      messageHash = messageHashOrIntent;
+    } else {
+      messageHash = this.getMessageHash(messageHashOrIntent);
+    }
+
     const witness = await this.account.createAuthWit(messageHash);
     await this.pxe.addAuthWitness(witness);
     return witness;
@@ -58,111 +61,104 @@ export class AccountWallet extends BaseWallet {
 
   /**
    * Returns a function interaction to set a message hash as authorized or revoked in this account.
+   *
    * Public calls can then consume this authorization.
-   * @param messageHashOrIntent - The message or the caller and action to authorize/revoke
+   *
+   * @param messageHashOrIntent - The message hash or intent to authorize/revoke
    * @param authorized - True to authorize, false to revoke authorization.
    * @returns - A function interaction.
    */
   public setPublicAuthWit(
-    messageHashOrIntent:
-      | Fr
-      | Buffer
-      | {
-          /** The caller to approve  */
-          caller: AztecAddress;
-          /** The action to approve */
-          action: ContractFunctionInteraction | FunctionCall;
-          /** The chain id to approve */
-          chainId?: Fr;
-          /** The version to approve  */
-          version?: Fr;
-        },
+    messageHashOrIntent: Fr | Buffer | IntentInnerHash | IntentAction,
     authorized: boolean,
   ): ContractFunctionInteraction {
-    const message = this.getMessageHash(messageHashOrIntent);
-    if (authorized) {
-      return new ContractFunctionInteraction(this, this.getAddress(), this.getApprovePublicAuthwitAbi(), [message]);
+    let messageHash: Fr;
+    if (Buffer.isBuffer(messageHashOrIntent)) {
+      messageHash = Fr.fromBuffer(messageHashOrIntent);
+    } else if (messageHashOrIntent instanceof Fr) {
+      messageHash = messageHashOrIntent;
     } else {
-      return this.cancelAuthWit(message);
+      messageHash = this.getMessageHash(messageHashOrIntent);
+    }
+
+    return new ContractFunctionInteraction(this, AuthRegistryAddress, this.getSetAuthorizedAbi(), [
+      messageHash,
+      authorized,
+    ]);
+  }
+
+  private getInnerHashAndConsumer(intent: IntentInnerHash | IntentAction): {
+    /** The inner hash */
+    innerHash: Fr;
+    /** The consumer of the authwit */
+    consumer: AztecAddress;
+  } {
+    if ('caller' in intent && 'action' in intent) {
+      const action = intent.action instanceof ContractFunctionInteraction ? intent.action.request() : intent.action;
+      return {
+        innerHash: computeInnerAuthWitHashFromAction(intent.caller, action),
+        consumer: action.to,
+      };
+    } else if (Buffer.isBuffer(intent.innerHash)) {
+      return { innerHash: Fr.fromBuffer(intent.innerHash), consumer: intent.consumer };
     }
+    return { innerHash: intent.innerHash, consumer: intent.consumer };
   }
 
   /**
-   * Returns the message hash for the given message or authwit input.
-   * @param messageHashOrIntent - The message hash or the caller and action to authorize
+   * Returns the message hash for the given intent
+   *
+   * @param intent - A tuple of (consumer and inner hash) or (caller and action)
    * @returns The message hash
    */
-  private getMessageHash(
-    messageHashOrIntent:
-      | Fr
-      | Buffer
-      | {
-          /** The caller to approve  */
-          caller: AztecAddress;
-          /** The action to approve */
-          action: ContractFunctionInteraction | FunctionCall;
-          /** The chain id to approve */
-          chainId?: Fr;
-          /** The version to approve  */
-          version?: Fr;
-        },
-  ): Fr {
-    if (Buffer.isBuffer(messageHashOrIntent)) {
-      return Fr.fromBuffer(messageHashOrIntent);
-    } else if (messageHashOrIntent instanceof Fr) {
-      return messageHashOrIntent;
-    } else {
-      return computeAuthWitMessageHash(
-        messageHashOrIntent.caller,
-        messageHashOrIntent.chainId || this.getChainId(),
-        messageHashOrIntent.version || this.getVersion(),
-        messageHashOrIntent.action instanceof ContractFunctionInteraction
-          ? messageHashOrIntent.action.request()
-          : messageHashOrIntent.action,
-      );
-    }
+  private getMessageHash(intent: IntentInnerHash | IntentAction): Fr {
+    const chainId = this.getChainId();
+    const version = this.getVersion();
+    return computeAuthWitMessageHash(intent, { chainId, version });
   }
 
   /**
    * Lookup the validity of an authwit in private and public contexts.
-   * If the authwit have been consumed already (nullifier spent), will return false in both contexts.
-   * @param target - The target contract address
-   * @param messageHashOrIntent - The message hash or the caller and action to authorize/revoke
+   *
+   * Uses the chain id and version of the wallet.
+   *
+   * @param onBehalfOf - The address of the "approver"
+   * @param intent - The consumer and inner hash or the caller and action to lookup
+   *
    * @returns - A struct containing the validity of the authwit in private and public contexts.
    */
   async lookupValidity(
-    target: AztecAddress,
-    messageHashOrIntent:
-      | Fr
-      | Buffer
-      | {
-          /** The caller to approve  */
-          caller: AztecAddress;
-          /** The action to approve */
-          action: ContractFunctionInteraction | FunctionCall;
-          /** The chain id to approve */
-          chainId?: Fr;
-          /** The version to approve  */
-          version?: Fr;
-        },
+    onBehalfOf: AztecAddress,
+    intent: IntentInnerHash | IntentAction,
   ): Promise<{
     /** boolean flag indicating if the authwit is valid in private context */
     isValidInPrivate: boolean;
     /** boolean flag indicating if the authwit is valid in public context */
     isValidInPublic: boolean;
   }> {
-    const messageHash = this.getMessageHash(messageHashOrIntent);
+    const { innerHash, consumer } = this.getInnerHashAndConsumer(intent);
+
+    const messageHash = this.getMessageHash(intent);
+    const results = { isValidInPrivate: false, isValidInPublic: false };
+
+    // Check private
     const witness = await this.getAuthWitness(messageHash);
-    const blockNumber = await this.getBlockNumber();
-    const interaction = new ContractFunctionInteraction(this, target, this.getLookupValidityAbi(), [
-      target,
-      blockNumber,
-      witness != undefined,
-      messageHash,
-    ]);
+    if (witness !== undefined) {
+      results.isValidInPrivate = (await new ContractFunctionInteraction(this, onBehalfOf, this.getLookupValidityAbi(), [
+        consumer,
+        innerHash,
+      ]).simulate()) as boolean;
+    }
+
+    // check public
+    results.isValidInPublic = (await new ContractFunctionInteraction(
+      this,
+      AuthRegistryAddress,
+      this.getIsConsumableAbi(),
+      [onBehalfOf, messageHash],
+    ).simulate()) as boolean;
 
-    const [isValidInPrivate, isValidInPublic] = (await interaction.simulate()) as [boolean, boolean];
-    return { isValidInPrivate, isValidInPublic };
+    return results;
   }
 
   /**
@@ -189,31 +185,6 @@ export class AccountWallet extends BaseWallet {
     await interaction.send().wait();
   }
 
-  /**
-   * Returns a function interaction to cancel a message hash as authorized in this account.
-   * @param messageHashOrIntent - The message or the caller and action to authorize/revoke
-   * @returns - A function interaction.
-   */
-  public cancelAuthWit(
-    messageHashOrIntent:
-      | Fr
-      | Buffer
-      | {
-          /** The caller to approve  */
-          caller: AztecAddress;
-          /** The action to approve */
-          action: ContractFunctionInteraction | FunctionCall;
-          /** The chain id to approve */
-          chainId?: Fr;
-          /** The version to approve  */
-          version?: Fr;
-        },
-  ): ContractFunctionInteraction {
-    const message = this.getMessageHash(messageHashOrIntent);
-    const args = [message];
-    return new ContractFunctionInteraction(this, this.getAddress(), this.getCancelAuthwitAbi(), args);
-  }
-
   /** Returns the complete address of the account that implements this wallet. */
   public getCompleteAddress() {
     return this.account.getCompleteAddress();
@@ -224,9 +195,9 @@ export class AccountWallet extends BaseWallet {
     return this.getCompleteAddress().address;
   }
 
-  private getApprovePublicAuthwitAbi(): FunctionAbi {
+  private getSetAuthorizedAbi(): FunctionAbi {
     return {
-      name: 'approve_public_authwit',
+      name: 'set_authorized',
       isInitializer: false,
       functionType: FunctionType.PUBLIC,
       isInternal: true,
@@ -237,59 +208,48 @@ export class AccountWallet extends BaseWallet {
           type: { kind: 'field' },
           visibility: 'private' as ABIParameterVisibility,
         },
+        {
+          name: 'authorize',
+          type: { kind: 'boolean' },
+          visibility: 'private' as ABIParameterVisibility,
+        },
       ],
       returnTypes: [],
     };
   }
 
-  private getCancelAuthwitAbi(): FunctionAbi {
+  private getLookupValidityAbi(): FunctionAbi {
     return {
-      name: 'cancel_authwit',
+      name: 'lookup_validity',
       isInitializer: false,
-      functionType: FunctionType.PRIVATE,
-      isInternal: true,
+      functionType: FunctionType.UNCONSTRAINED,
+      isInternal: false,
       isStatic: false,
-      parameters: [
-        {
-          name: 'message_hash',
-          type: { kind: 'field' },
-          visibility: 'private' as ABIParameterVisibility,
-        },
-      ],
-      returnTypes: [],
+      parameters: [{ name: 'message_hash', type: { kind: 'field' }, visibility: 'private' as ABIParameterVisibility }],
+      returnTypes: [{ kind: 'boolean' }],
     };
   }
 
-  private getLookupValidityAbi(): FunctionAbi {
+  private getIsConsumableAbi(): FunctionAbi {
     return {
-      name: 'lookup_validity',
+      name: 'unconstrained_is_consumable',
       isInitializer: false,
       functionType: FunctionType.UNCONSTRAINED,
       isInternal: false,
       isStatic: false,
       parameters: [
         {
-          name: 'myself',
+          name: 'address',
           type: {
+            fields: [{ name: 'inner', type: { kind: 'field' } }],
             kind: 'struct',
             path: 'authwit::aztec::protocol_types::address::aztec_address::AztecAddress',
-            fields: [{ name: 'inner', type: { kind: 'field' } }],
           },
           visibility: 'private' as ABIParameterVisibility,
         },
-        {
-          name: 'block_number',
-          type: { kind: 'integer', sign: 'unsigned', width: 32 },
-          visibility: 'private' as ABIParameterVisibility,
-        },
-        {
-          name: 'check_private',
-          type: { kind: 'boolean' },
-          visibility: 'private' as ABIParameterVisibility,
-        },
         { name: 'message_hash', type: { kind: 'field' }, visibility: 'private' as ABIParameterVisibility },
       ],
-      returnTypes: [{ kind: 'array', length: 2, type: { kind: 'boolean' } }],
+      returnTypes: [{ kind: 'boolean' }],
     };
   }
 

package/src/wallet/base_wallet.ts

@@ -1,11 +1,12 @@
 import {
   type AuthWitness,
+  type EventMetadata,
   type ExtendedNote,
-  type FunctionCall,
   type GetUnencryptedLogsResponse,
+  type IncomingNotesFilter,
   type L2Block,
   type LogFilter,
-  type NoteFilter,
+  type OutgoingNotesFilter,
   type PXE,
   type PXEInfo,
   type SimulatedTx,
@@ -17,14 +18,21 @@ import {
   type TxReceipt,
 } from '@aztec/circuit-types';
 import { type NoteProcessorStats } from '@aztec/circuit-types/stats';
-import { type AztecAddress, type CompleteAddress, type Fq, type Fr, type PartialAddress } from '@aztec/circuits.js';
+import {
+  type AztecAddress,
+  type CompleteAddress,
+  type Fq,
+  type Fr,
+  type PartialAddress,
+  type Point,
+} from '@aztec/circuits.js';
 import { type ContractArtifact } from '@aztec/foundation/abi';
 import { type ContractClassWithId, type ContractInstanceWithAddress } from '@aztec/types/contracts';
 import { type NodeInfo } from '@aztec/types/interfaces';
 
 import { type Wallet } from '../account/wallet.js';
-import { type ContractFunctionInteraction } from '../contract/contract_function_interaction.js';
 import { type ExecutionRequestInit } from '../entrypoint/entrypoint.js';
+import { type IntentAction, type IntentInnerHash } from '../utils/authwit.js';
 
 /**
  * A base class for Wallet implementations
@@ -40,21 +48,7 @@ export abstract class BaseWallet implements Wallet {
 
   abstract createTxExecutionRequest(exec: ExecutionRequestInit): Promise<TxExecutionRequest>;
 
-  abstract createAuthWit(
-    messageHashOrIntent:
-      | Fr
-      | Buffer
-      | {
-          /** The caller to approve  */
-          caller: AztecAddress;
-          /** The action to approve */
-          action: ContractFunctionInteraction | FunctionCall;
-          /** The chain id to approve */
-          chainId?: Fr;
-          /** The version to approve  */
-          version?: Fr;
-        },
-  ): Promise<AuthWitness>;
+  abstract createAuthWit(intent: Fr | Buffer | IntentInnerHash | IntentAction): Promise<AuthWitness>;
 
   abstract rotateNullifierKeys(newNskM: Fq): Promise<void>;
 
@@ -67,6 +61,9 @@ export abstract class BaseWallet implements Wallet {
   getContractClass(id: Fr): Promise<ContractClassWithId | undefined> {
     return this.pxe.getContractClass(id);
   }
+  getContractArtifact(id: Fr): Promise<ContractArtifact | undefined> {
+    return this.pxe.getContractArtifact(id);
+  }
   addCapsule(capsule: Fr[]): Promise<void> {
     return this.pxe.addCapsule(capsule);
   }
@@ -118,8 +115,11 @@ export abstract class BaseWallet implements Wallet {
   getTxReceipt(txHash: TxHash): Promise<TxReceipt> {
     return this.pxe.getTxReceipt(txHash);
   }
-  getNotes(filter: NoteFilter): Promise<ExtendedNote[]> {
-    return this.pxe.getNotes(filter);
+  getIncomingNotes(filter: IncomingNotesFilter): Promise<ExtendedNote[]> {
+    return this.pxe.getIncomingNotes(filter);
+  }
+  getOutgoingNotes(filter: OutgoingNotesFilter): Promise<ExtendedNote[]> {
+    return this.pxe.getOutgoingNotes(filter);
   }
   // TODO(#4956): Un-expose this
   getNoteNonces(note: ExtendedNote): Promise<Fr[]> {
@@ -131,6 +131,9 @@ export abstract class BaseWallet implements Wallet {
   addNote(note: ExtendedNote): Promise<void> {
     return this.pxe.addNote(note);
   }
+  addNullifiedNote(note: ExtendedNote): Promise<void> {
+    return this.pxe.addNullifiedNote(note);
+  }
   getBlock(number: number): Promise<L2Block | undefined> {
     return this.pxe.getBlock(number);
   }
@@ -178,4 +181,12 @@ export abstract class BaseWallet implements Wallet {
   getPXEInfo(): Promise<PXEInfo> {
     return this.pxe.getPXEInfo();
   }
+  getEvents<T>(
+    from: number,
+    limit: number,
+    eventMetadata: EventMetadata<T>,
+    ivpk: Point = this.getCompleteAddress().publicKeys.masterIncomingViewingPublicKey,
+  ): Promise<T[]> {
+    return this.pxe.getEvents(from, limit, eventMetadata, ivpk);
+  }
 }

package/src/wallet/signerless_wallet.ts

@@ -3,6 +3,7 @@ import { type CompleteAddress, type Fq, type Fr } from '@aztec/circuits.js';
 
 import { DefaultEntrypoint } from '../entrypoint/default_entrypoint.js';
 import { type EntrypointInterface, type ExecutionRequestInit } from '../entrypoint/entrypoint.js';
+import { type IntentAction, type IntentInnerHash } from '../utils/authwit.js';
 import { BaseWallet } from './base_wallet.js';
 
 /**
@@ -12,7 +13,6 @@ export class SignerlessWallet extends BaseWallet {
   constructor(pxe: PXE, private entrypoint?: EntrypointInterface) {
     super(pxe);
   }
-
   async createTxExecutionRequest(execution: ExecutionRequestInit): Promise<TxExecutionRequest> {
     let entrypoint = this.entrypoint;
     if (!entrypoint) {
@@ -39,7 +39,7 @@ export class SignerlessWallet extends BaseWallet {
     throw new Error('SignerlessWallet: Method getCompleteAddress not implemented.');
   }
 
-  createAuthWit(_messageHash: Fr): Promise<AuthWitness> {
+  createAuthWit(_intent: Fr | Buffer | IntentInnerHash | IntentAction): Promise<AuthWitness> {
     throw new Error('SignerlessWallet: Method createAuthWit not implemented.');
   }