@aztec/aztec.js 0.40.1 → 0.42.0

package/src/fee/private_fee_payment_method.ts

@@ -1,7 +1,7 @@
 import { type FunctionCall } from '@aztec/circuit-types';
-import { FunctionData, type GasSettings } from '@aztec/circuits.js';
+import { type GasSettings } from '@aztec/circuits.js';
 import { computeSecretHash } from '@aztec/circuits.js/hash';
-import { FunctionSelector } from '@aztec/foundation/abi';
+import { FunctionSelector, FunctionType } from '@aztec/foundation/abi';
 import { type AztecAddress } from '@aztec/foundation/aztec-address';
 import { Fr } from '@aztec/foundation/fields';
 
@@ -43,12 +43,8 @@ export class PrivateFeePaymentMethod implements FeePaymentMethod {
     return this.asset;
   }
 
-  /**
-   * The address which will facilitate the fee payment.
-   * @returns The contract address responsible for holding the fee payment.
-   */
-  getPaymentContract() {
-    return this.paymentContract;
+  getFeePayer(): Promise<AztecAddress> {
+    return Promise.resolve(this.paymentContract);
   }
 
   /**
@@ -64,9 +60,13 @@ export class PrivateFeePaymentMethod implements FeePaymentMethod {
       this.wallet.getChainId(),
       this.wallet.getVersion(),
       {
+        name: 'unshield',
         args: [this.wallet.getCompleteAddress().address, this.paymentContract, maxFee, nonce],
-        functionData: new FunctionData(FunctionSelector.fromSignature('unshield((Field),(Field),Field,Field)'), true),
+        selector: FunctionSelector.fromSignature('unshield((Field),(Field),Field,Field)'),
+        type: FunctionType.PRIVATE,
+        isStatic: false,
         to: this.asset,
+        returnTypes: [],
       },
     );
     await this.wallet.createAuthWit(messageHash);
@@ -75,12 +75,13 @@ export class PrivateFeePaymentMethod implements FeePaymentMethod {
 
     return [
       {
-        to: this.getPaymentContract(),
-        functionData: new FunctionData(
-          FunctionSelector.fromSignature('fee_entrypoint_private(Field,(Field),Field,Field)'),
-          true,
-        ),
+        name: 'fee_entrypoint_private',
+        to: this.paymentContract,
+        selector: FunctionSelector.fromSignature('fee_entrypoint_private(Field,(Field),Field,Field)'),
+        type: FunctionType.PRIVATE,
+        isStatic: false,
         args: [maxFee, this.asset, secretHashForRebate, nonce],
+        returnTypes: [],
       },
     ];
   }

package/src/fee/public_fee_payment_method.ts

@@ -1,6 +1,6 @@
 import { type FunctionCall } from '@aztec/circuit-types';
-import { FunctionData, type GasSettings } from '@aztec/circuits.js';
-import { FunctionSelector } from '@aztec/foundation/abi';
+import { type GasSettings } from '@aztec/circuits.js';
+import { FunctionSelector, FunctionType } from '@aztec/foundation/abi';
 import { type AztecAddress } from '@aztec/foundation/aztec-address';
 import { Fr } from '@aztec/foundation/fields';
 
@@ -21,7 +21,6 @@ export class PublicFeePaymentMethod implements FeePaymentMethod {
      * Address which will hold the fee payment.
      */
     protected paymentContract: AztecAddress,
-
     /**
      * An auth witness provider to authorize fee payments
      */
@@ -36,12 +35,8 @@ export class PublicFeePaymentMethod implements FeePaymentMethod {
     return this.asset;
   }
 
-  /**
-   * The address which will facilitate the fee payment.
-   * @returns The contract address responsible for holding the fee payment.
-   */
-  getPaymentContract() {
-    return this.paymentContract;
+  getFeePayer(): Promise<AztecAddress> {
+    return Promise.resolve(this.paymentContract);
   }
 
   /**
@@ -57,24 +52,26 @@ export class PublicFeePaymentMethod implements FeePaymentMethod {
       this.wallet.getChainId(),
       this.wallet.getVersion(),
       {
+        name: 'transfer_public',
         args: [this.wallet.getAddress(), this.paymentContract, maxFee, nonce],
-        functionData: new FunctionData(
-          FunctionSelector.fromSignature('transfer_public((Field),(Field),Field,Field)'),
-          false,
-        ),
+        selector: FunctionSelector.fromSignature('transfer_public((Field),(Field),Field,Field)'),
+        type: FunctionType.PUBLIC,
+        isStatic: false,
         to: this.asset,
+        returnTypes: [],
       },
     );
 
     return Promise.resolve([
       this.wallet.setPublicAuthWit(messageHash, true).request(),
       {
-        to: this.getPaymentContract(),
-        functionData: new FunctionData(
-          FunctionSelector.fromSignature('fee_entrypoint_public(Field,(Field),Field)'),
-          true,
-        ),
+        name: 'fee_entrypoint_public',
+        to: this.paymentContract,
+        selector: FunctionSelector.fromSignature('fee_entrypoint_public(Field,(Field),Field)'),
+        type: FunctionType.PRIVATE,
+        isStatic: false,
         args: [maxFee, this.asset, nonce],
+        returnTypes: [],
       },
     ]);
   }

package/src/index.ts

@@ -20,35 +20,36 @@
  * TODO: Ultimately reimplement this mega exporter by mega exporting a granular api (then deprecate it).
  */
 export {
-  WaitOpts,
-  ContractFunctionInteraction,
+  BatchCall,
   Contract,
   ContractBase,
-  ContractMethod,
-  ContractStorageLayout,
-  ContractNotes,
-  SentTx,
-  BatchCall,
+  ContractFunctionInteraction,
+  type ContractMethod,
+  type ContractNotes,
+  type ContractStorageLayout,
   DeployMethod,
   DeploySentTx,
+  type SendMethodOptions,
+  SentTx,
+  type WaitOpts,
 } from './contract/index.js';
 
 export { ContractDeployer } from './deployment/index.js';
 
 export {
-  generatePublicKey,
-  FieldLike,
-  EthAddressLike,
-  CheatCodes,
   AztecAddressLike,
+  CheatCodes,
+  EthAddressLike,
+  EthCheatCodes,
+  FieldLike,
   FunctionSelectorLike,
   WrappedFieldLike,
-  EthCheatCodes,
   computeAuthWitMessageHash,
   computeInnerAuthWitHash,
   computeOuterAuthWitHash,
-  waitForPXE,
+  generatePublicKey,
   waitForAccountSynch,
+  waitForPXE,
 } from './utils/index.js';
 
 export { createPXEClient } from './rpc_clients/index.js';
@@ -58,21 +59,21 @@ export { AuthWitnessProvider } from './account/index.js';
 export { AccountContract } from './account/index.js';
 export { AccountManager } from './account_manager/index.js';
 
-export { AccountWalletWithSecretKey, AccountWallet, Wallet, SignerlessWallet } from './wallet/index.js';
+export { AccountWallet, AccountWalletWithSecretKey, SignerlessWallet, Wallet } from './wallet/index.js';
 
 // // TODO https://github.com/AztecProtocol/aztec-packages/issues/2632 --> FunctionSelector might not need to be exposed
 // // here once the issue is resolved.
 export {
   AztecAddress,
   EthAddress,
-  Fr,
   Fq,
+  Fr,
   GlobalVariables,
   GrumpkinScalar,
+  INITIAL_L2_BLOCK_NUM,
   Point,
-  getContractInstanceFromDeployParams, // TODO(@spalladino) This method should be used from within the DeployMethod but not exposed in aztec.js
   getContractClassFromArtifact,
-  INITIAL_L2_BLOCK_NUM,
+  getContractInstanceFromDeployParams,
 } from '@aztec/circuits.js';
 
 export { computeSecretHash } from '@aztec/circuits.js/hash';
@@ -90,17 +91,21 @@ export {
   AuthWitness,
   AztecNode,
   Body,
+  Comparator,
   CompleteAddress,
+  EncryptedL2BlockL2Logs,
+  EncryptedLogHeader,
+  EncryptedLogIncomingBody,
+  EncryptedLogOutgoingBody,
   ExtendedNote,
-  type FunctionCall,
+  FunctionCall,
   GrumpkinPrivateKey,
-  L1ToL2Message,
   L1Actor,
+  L1ToL2Message,
   L2Actor,
   L2Block,
   L2BlockL2Logs,
-  EncryptedL2BlockL2Logs,
-  UnencryptedL2BlockL2Logs,
+  EncryptedNoteL2BlockL2Logs,
   LogFilter,
   LogId,
   LogType,
@@ -110,40 +115,37 @@ export {
   PackedValues,
   PartialAddress,
   PublicKey,
+  SiblingPath,
   SyncStatus,
   Tx,
   TxExecutionRequest,
   TxHash,
   TxReceipt,
   TxStatus,
+  UnencryptedL2BlockL2Logs,
   UnencryptedL2Log,
   createAztecNodeClient,
-  emptyFunctionCall,
   merkleTreeIds,
   mockTx,
-  Comparator,
-  SiblingPath,
-  EncryptedLogHeader,
-  EncryptedLogBody,
 } from '@aztec/circuit-types';
 export { NodeInfo } from '@aztec/types/interfaces';
 
-export { ContractInstanceWithAddress, ContractClassWithId } from '@aztec/types/contracts';
+export { ContractClassWithId, ContractInstanceWithAddress } from '@aztec/types/contracts';
 
 // TODO: These kinds of things have no place on our public api.
 // External devs will almost certainly have their own methods of doing these things.
 // If we want to use them in our own "aztec.js consuming code", import them from foundation as needed.
 export { encodeArguments } from '@aztec/foundation/abi';
+export { toBigIntBE } from '@aztec/foundation/bigint-buffer';
 export { sha256 } from '@aztec/foundation/crypto';
+export { makeFetch } from '@aztec/foundation/json-rpc/client';
 export { DebugLogger, createDebugLogger, onLog } from '@aztec/foundation/log';
 export { retry, retryUntil } from '@aztec/foundation/retry';
+export { to2Fields, toBigInt } from '@aztec/foundation/serialize';
 export { sleep } from '@aztec/foundation/sleep';
 export { elapsed } from '@aztec/foundation/timer';
-export { fileURLToPath } from '@aztec/foundation/url';
-export { to2Fields, toBigInt } from '@aztec/foundation/serialize';
-export { toBigIntBE } from '@aztec/foundation/bigint-buffer';
-export { makeFetch } from '@aztec/foundation/json-rpc/client';
 export { FieldsOf } from '@aztec/foundation/types';
+export { fileURLToPath } from '@aztec/foundation/url';
 
 export {
   DeployL1Contracts,
@@ -155,6 +157,6 @@ export {
 // Start of section that exports public api via granular api.
 // Here you *can* do `export *` as the granular api defacto exports things explicitly.
 // This entire index file will be deprecated at some point after we're satisfied.
-export * from './api/init.js';
 export * from './api/abi.js';
 export * from './api/fee.js';
+export * from './api/init.js';

package/src/rpc_clients/pxe_client.ts

@@ -1,6 +1,6 @@
 import {
   AuthWitness,
-  EncryptedL2BlockL2Logs,
+  EncryptedNoteL2BlockL2Logs,
   ExtendedNote,
   ExtendedUnencryptedL2Log,
   L2Block,
@@ -54,7 +54,7 @@ export const createPXEClient = (url: string, fetch = makeFetch([1, 2, 3], false)
       TxExecutionRequest,
       TxHash,
     },
-    { Tx, SimulatedTx, TxReceipt, EncryptedL2BlockL2Logs, UnencryptedL2BlockL2Logs, NullifierMembershipWitness },
+    { Tx, SimulatedTx, TxReceipt, EncryptedNoteL2BlockL2Logs, UnencryptedL2BlockL2Logs, NullifierMembershipWitness },
     false,
     'pxe',
     fetch,

package/src/utils/authwit.ts

@@ -22,11 +22,7 @@ export const computeAuthWitMessageHash = (caller: AztecAddress, chainId: Fr, ver
     action.to.toField(),
     chainId,
     version,
-    computeInnerAuthWitHash([
-      caller.toField(),
-      action.functionData.selector.toField(),
-      PackedValues.fromValues(action.args).hash,
-    ]),
+    computeInnerAuthWitHash([caller.toField(), action.selector.toField(), PackedValues.fromValues(action.args).hash]),
   );
 };
 // docs:end:authwit_computeAuthWitMessageHash

package/src/utils/cheat_codes.ts

@@ -265,11 +265,11 @@ export class AztecCheatCodes {
   public async warp(to: number): Promise<void> {
     const rollupContract = (await this.pxe.getNodeInfo()).l1ContractAddresses.rollupAddress;
     await this.eth.setNextBlockTimestamp(to);
-    // also store this time on the rollup contract (slot 1 tracks `lastBlockTs`).
+    // also store this time on the rollup contract (slot 2 tracks `lastBlockTs`).
     // This is because when the sequencer executes public functions, it uses the timestamp stored in the rollup contract.
-    await this.eth.store(rollupContract, 1n, BigInt(to));
-    // also store this on slot 2 of the rollup contract (`lastWarpedBlockTs`) which tracks the last time warp was used.
     await this.eth.store(rollupContract, 2n, BigInt(to));
+    // also store this on slot 3 of the rollup contract (`lastWarpedBlockTs`) which tracks the last time warp was used.
+    await this.eth.store(rollupContract, 3n, BigInt(to));
   }
 
   /**

package/src/wallet/account_wallet.ts

@@ -1,5 +1,5 @@
 import { type AuthWitness, type FunctionCall, type PXE, type TxExecutionRequest } from '@aztec/circuit-types';
-import { type AztecAddress, Fr } from '@aztec/circuits.js';
+import { AztecAddress, CANONICAL_KEY_REGISTRY_ADDRESS, Fq, Fr, derivePublicKeyFromSecretKey } from '@aztec/circuits.js';
 import { type ABIParameterVisibility, type FunctionAbi, FunctionType } from '@aztec/foundation/abi';
 
 import { type AccountInterface } from '../account/interface.js';
@@ -165,6 +165,30 @@ export class AccountWallet extends BaseWallet {
     return { isValidInPrivate, isValidInPublic };
   }
 
+  /**
+   * Rotates the account master nullifier key pair.
+   * @param newNskM - The new master nullifier secret key we want to use.
+   * @remarks - This function also calls the canonical key registry with the account's new derived master nullifier public key.
+   * We are doing it this way to avoid user error, in the case that a user rotates their keys in the key registry,
+   * but fails to do so in the key store. This leads to unspendable notes.
+   *
+   * This does not hinder our ability to spend notes tied to a previous master nullifier public key, provided we have the master nullifier secret key for it.
+   */
+  public async rotateNullifierKeys(newNskM: Fq = Fq.random()): Promise<void> {
+    // We rotate our secret key in the keystore first, because if the subsequent interaction fails, there are no bad side-effects.
+    // If vice versa (the key registry is called first), but the call to the PXE fails, we will end up in a situation with unspendable notes, as we have not committed our
+    // nullifier secret key to our wallet.
+    await this.pxe.rotateNskM(this.getAddress(), newNskM);
+    const interaction = new ContractFunctionInteraction(
+      this,
+      AztecAddress.fromBigInt(CANONICAL_KEY_REGISTRY_ADDRESS),
+      this.getRotateNpkMAbi(),
+      [this.getAddress(), derivePublicKeyFromSecretKey(newNskM), Fr.ZERO],
+    );
+
+    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
@@ -204,8 +228,9 @@ export class AccountWallet extends BaseWallet {
     return {
       name: 'approve_public_authwit',
       isInitializer: false,
-      functionType: FunctionType.OPEN,
+      functionType: FunctionType.PUBLIC,
       isInternal: true,
+      isStatic: false,
       parameters: [
         {
           name: 'message_hash',
@@ -221,8 +246,9 @@ export class AccountWallet extends BaseWallet {
     return {
       name: 'cancel_authwit',
       isInitializer: false,
-      functionType: FunctionType.SECRET,
+      functionType: FunctionType.PRIVATE,
       isInternal: true,
+      isStatic: false,
       parameters: [
         {
           name: 'message_hash',
@@ -240,6 +266,7 @@ export class AccountWallet extends BaseWallet {
       isInitializer: false,
       functionType: FunctionType.UNCONSTRAINED,
       isInternal: false,
+      isStatic: false,
       parameters: [
         {
           name: 'myself',
@@ -265,4 +292,39 @@ export class AccountWallet extends BaseWallet {
       returnTypes: [{ kind: 'array', length: 2, type: { kind: 'boolean' } }],
     };
   }
+
+  private getRotateNpkMAbi(): FunctionAbi {
+    return {
+      name: 'rotate_npk_m',
+      isInitializer: false,
+      functionType: FunctionType.PUBLIC,
+      isInternal: false,
+      isStatic: false,
+      parameters: [
+        {
+          name: 'address',
+          type: {
+            fields: [{ name: 'inner', type: { kind: 'field' } }],
+            kind: 'struct',
+            path: 'authwit::aztec::protocol_types::address::aztec_address::AztecAddress',
+          },
+          visibility: 'private' as ABIParameterVisibility,
+        },
+        {
+          name: 'new_npk_m',
+          type: {
+            fields: [
+              { name: 'x', type: { kind: 'field' } },
+              { name: 'y', type: { kind: 'field' } },
+            ],
+            kind: 'struct',
+            path: 'authwit::aztec::protocol_types::grumpkin_point::GrumpkinPoint',
+          },
+          visibility: 'private' as ABIParameterVisibility,
+        },
+        { name: 'nonce', type: { kind: 'field' }, visibility: 'private' as ABIParameterVisibility },
+      ],
+      returnTypes: [],
+    };
+  }
 }

package/src/wallet/base_wallet.ts

@@ -7,6 +7,7 @@ import {
   type LogFilter,
   type NoteFilter,
   type PXE,
+  type PXEInfo,
   type SimulatedTx,
   type SyncStatus,
   type Tx,
@@ -15,7 +16,8 @@ import {
   type TxHash,
   type TxReceipt,
 } from '@aztec/circuit-types';
-import { type AztecAddress, type CompleteAddress, type Fr, type PartialAddress } from '@aztec/circuits.js';
+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 ContractArtifact } from '@aztec/foundation/abi';
 import { type ContractClassWithId, type ContractInstanceWithAddress } from '@aztec/types/contracts';
 import { type NodeInfo } from '@aztec/types/interfaces';
@@ -54,6 +56,8 @@ export abstract class BaseWallet implements Wallet {
         },
   ): Promise<AuthWitness>;
 
+  abstract rotateNullifierKeys(newNskM: Fq): Promise<void>;
+
   getAddress() {
     return this.getCompleteAddress().address;
   }
@@ -69,6 +73,9 @@ export abstract class BaseWallet implements Wallet {
   registerAccount(secretKey: Fr, partialAddress: PartialAddress): Promise<CompleteAddress> {
     return this.pxe.registerAccount(secretKey, partialAddress);
   }
+  rotateNskM(address: AztecAddress, secretKey: Fq) {
+    return this.pxe.rotateNskM(address, secretKey);
+  }
   registerRecipient(account: CompleteAddress): Promise<void> {
     return this.pxe.registerRecipient(account);
   }
@@ -127,8 +134,13 @@ export abstract class BaseWallet implements Wallet {
   getBlock(number: number): Promise<L2Block | undefined> {
     return this.pxe.getBlock(number);
   }
-  viewTx(functionName: string, args: any[], to: AztecAddress, from?: AztecAddress | undefined): Promise<any> {
-    return this.pxe.viewTx(functionName, args, to, from);
+  simulateUnconstrained(
+    functionName: string,
+    args: any[],
+    to: AztecAddress,
+    from?: AztecAddress | undefined,
+  ): Promise<any> {
+    return this.pxe.simulateUnconstrained(functionName, args, to, from);
   }
   getUnencryptedLogs(filter: LogFilter): Promise<GetUnencryptedLogsResponse> {
     return this.pxe.getUnencryptedLogs(filter);
@@ -148,6 +160,9 @@ export abstract class BaseWallet implements Wallet {
   getSyncStatus(): Promise<SyncStatus> {
     return this.pxe.getSyncStatus();
   }
+  getSyncStats(): Promise<{ [key: string]: NoteProcessorStats }> {
+    return this.pxe.getSyncStats();
+  }
   addAuthWitness(authWitness: AuthWitness) {
     return this.pxe.addAuthWitness(authWitness);
   }
@@ -160,4 +175,7 @@ export abstract class BaseWallet implements Wallet {
   isContractPubliclyDeployed(address: AztecAddress): Promise<boolean> {
     return this.pxe.isContractPubliclyDeployed(address);
   }
+  getPXEInfo(): Promise<PXEInfo> {
+    return this.pxe.getPXEInfo();
+  }
 }

package/src/wallet/create_recipient.ts

@@ -8,6 +8,8 @@ import { CompleteAddress } from '@aztec/circuits.js';
  */
 export async function createRecipient(pxe: PXE): Promise<CompleteAddress> {
   const completeAddress = CompleteAddress.random();
+  // docs:start:register-recipient
   await pxe.registerRecipient(completeAddress);
+  // docs:end:register-recipient
   return completeAddress;
 }

package/src/wallet/signerless_wallet.ts

@@ -1,5 +1,5 @@
 import { type AuthWitness, type PXE, type TxExecutionRequest } from '@aztec/circuit-types';
-import { type CompleteAddress, type Fr } from '@aztec/circuits.js';
+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';
@@ -24,22 +24,26 @@ export class SignerlessWallet extends BaseWallet {
   }
 
   getChainId(): Fr {
-    throw new Error('Method not implemented.');
+    throw new Error('SignerlessWallet: Method getChainId not implemented.');
   }
 
   getVersion(): Fr {
-    throw new Error('Method not implemented.');
+    throw new Error('SignerlessWallet: Method getVersion not implemented.');
   }
 
   getPublicKeysHash(): Fr {
-    throw new Error('Method not implemented.');
+    throw new Error('SignerlessWallet: Method getPublicKeysHash not implemented.');
   }
 
   getCompleteAddress(): CompleteAddress {
-    throw new Error('Method not implemented.');
+    throw new Error('SignerlessWallet: Method getCompleteAddress not implemented.');
   }
 
   createAuthWit(_messageHash: Fr): Promise<AuthWitness> {
-    throw new Error('Method not implemented.');
+    throw new Error('SignerlessWallet: Method createAuthWit not implemented.');
+  }
+
+  rotateNullifierKeys(_newNskM: Fq): Promise<void> {
+    throw new Error('SignerlessWallet: Method rotateNullifierKeys not implemented.');
   }
 }