@aztec/aztec.js 0.42.0 → 0.44.0

package/src/account_manager/index.ts

@@ -19,7 +19,7 @@ import { DeployAccountSentTx } from './deploy_account_sent_tx.js';
  */
 export type DeployAccountOptions = Pick<
   DeployOptions,
-  'fee' | 'skipClassRegistration' | 'skipPublicDeployment' | 'estimateGas'
+  'fee' | 'skipClassRegistration' | 'skipPublicDeployment' | 'estimateGas' | 'skipInitialization'
 >;
 
 /**
@@ -104,12 +104,13 @@ export class AccountManager {
    * @returns A Wallet instance.
    */
   public async register(opts: WaitOpts = DefaultWaitOpts): Promise<AccountWalletWithSecretKey> {
-    await this.#register();
     await this.pxe.registerContract({
       artifact: this.accountContract.getContractArtifact(),
       instance: this.getInstance(),
     });
 
+    await this.pxe.registerAccount(this.secretKey, this.getCompleteAddress().partialAddress);
+
     await waitForAccountSynch(this.pxe, this.getCompleteAddress(), opts);
     return this.getWallet();
   }
@@ -127,7 +128,9 @@ export class AccountManager {
           `Account contract ${this.accountContract.getContractArtifact().name} does not require deployment.`,
         );
       }
-      await this.#register();
+
+      await this.pxe.registerAccount(this.secretKey, this.getCompleteAddress().partialAddress);
+
       const { chainId, protocolVersion } = await this.pxe.getNodeInfo();
       const deployWallet = new SignerlessWallet(this.pxe, new DefaultMultiCallEntrypoint(chainId, protocolVersion));
 
@@ -163,7 +166,7 @@ export class AccountManager {
           contractAddressSalt: this.salt,
           skipClassRegistration: opts?.skipClassRegistration ?? true,
           skipPublicDeployment: opts?.skipPublicDeployment ?? true,
-          skipInitialization: false,
+          skipInitialization: opts?.skipInitialization ?? false,
           universalDeploy: true,
           fee: opts?.fee,
           estimateGas: opts?.estimateGas,
@@ -191,9 +194,4 @@ export class AccountManager {
   public isDeployable() {
     return this.accountContract.getDeploymentArgs() !== undefined;
   }
-
-  async #register(): Promise<void> {
-    const completeAddress = this.getCompleteAddress();
-    await this.pxe.registerAccount(this.secretKey, completeAddress.partialAddress);
-  }
 }

package/src/api/abi.ts

@@ -1,3 +1,3 @@
-export { type ContractArtifact, type FunctionArtifact, FunctionSelector } from '@aztec/foundation/abi';
+export { type ContractArtifact, type FunctionArtifact, EventSelector, FunctionSelector } from '@aztec/foundation/abi';
 export { loadContractArtifact, contractArtifactToBuffer, contractArtifactFromBuffer } from '@aztec/types/abi';
 export { type NoirCompiledContract } from '@aztec/types/noir';

package/src/contract/sent_tx.ts

@@ -80,13 +80,15 @@ export class SentTx {
     if (opts?.debug) {
       const txHash = await this.getTxHash();
       const tx = (await this.pxe.getTxEffect(txHash))!;
-      const visibleNotes = await this.pxe.getNotes({ txHash });
+      const visibleIncomingNotes = await this.pxe.getIncomingNotes({ txHash });
+      const visibleOutgoingNotes = await this.pxe.getOutgoingNotes({ txHash });
       receipt.debugInfo = {
         noteHashes: tx.noteHashes,
         nullifiers: tx.nullifiers,
         publicDataWrites: tx.publicDataWrites,
         l2ToL1Msgs: tx.l2ToL1Msgs,
-        visibleNotes,
+        visibleIncomingNotes,
+        visibleOutgoingNotes,
       };
     }
     return receipt;
@@ -109,7 +111,7 @@ export class SentTx {
    */
   public async getVisibleNotes(): Promise<ExtendedNote[]> {
     await this.wait();
-    return this.pxe.getNotes({ txHash: await this.getTxHash() });
+    return this.pxe.getIncomingNotes({ txHash: await this.getTxHash() });
   }
 
   protected async waitForReceipt(opts?: WaitOpts): Promise<TxReceipt> {

package/src/fee/private_fee_payment_method.ts

@@ -6,7 +6,6 @@ import { type AztecAddress } from '@aztec/foundation/aztec-address';
 import { Fr } from '@aztec/foundation/fields';
 
 import { type Wallet } from '../account/wallet.js';
-import { computeAuthWitMessageHash } from '../utils/authwit.js';
 import { type FeePaymentMethod } from './fee_payment_method.js';
 
 /**
@@ -55,11 +54,9 @@ export class PrivateFeePaymentMethod implements FeePaymentMethod {
   async getFunctionCalls(gasSettings: GasSettings): Promise<FunctionCall[]> {
     const nonce = Fr.random();
     const maxFee = gasSettings.getFeeLimit();
-    const messageHash = computeAuthWitMessageHash(
-      this.paymentContract,
-      this.wallet.getChainId(),
-      this.wallet.getVersion(),
-      {
+    await this.wallet.createAuthWit({
+      caller: this.paymentContract,
+      action: {
         name: 'unshield',
         args: [this.wallet.getCompleteAddress().address, this.paymentContract, maxFee, nonce],
         selector: FunctionSelector.fromSignature('unshield((Field),(Field),Field,Field)'),
@@ -68,8 +65,7 @@ export class PrivateFeePaymentMethod implements FeePaymentMethod {
         to: this.asset,
         returnTypes: [],
       },
-    );
-    await this.wallet.createAuthWit(messageHash);
+    });
 
     const secretHashForRebate = computeSecretHash(this.rebateSecret);
 

package/src/fee/public_fee_payment_method.ts

@@ -4,7 +4,6 @@ import { FunctionSelector, FunctionType } from '@aztec/foundation/abi';
 import { type AztecAddress } from '@aztec/foundation/aztec-address';
 import { Fr } from '@aztec/foundation/fields';
 
-import { computeAuthWitMessageHash } from '../utils/authwit.js';
 import { type AccountWallet } from '../wallet/account_wallet.js';
 import { type FeePaymentMethod } from './fee_payment_method.js';
 
@@ -47,23 +46,25 @@ export class PublicFeePaymentMethod implements FeePaymentMethod {
   getFunctionCalls(gasSettings: GasSettings): Promise<FunctionCall[]> {
     const nonce = Fr.random();
     const maxFee = gasSettings.getFeeLimit();
-    const messageHash = computeAuthWitMessageHash(
-      this.paymentContract,
-      this.wallet.getChainId(),
-      this.wallet.getVersion(),
-      {
-        name: 'transfer_public',
-        args: [this.wallet.getAddress(), this.paymentContract, maxFee, nonce],
-        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(),
+      this.wallet
+        .setPublicAuthWit(
+          {
+            caller: this.paymentContract,
+            action: {
+              name: 'transfer_public',
+              args: [this.wallet.getAddress(), this.paymentContract, maxFee, nonce],
+              selector: FunctionSelector.fromSignature('transfer_public((Field),(Field),Field,Field)'),
+              type: FunctionType.PUBLIC,
+              isStatic: false,
+              to: this.asset,
+              returnTypes: [],
+            },
+          },
+          true,
+        )
+        .request(),
       {
         name: 'fee_entrypoint_public',
         to: this.paymentContract,

package/src/index.ts

@@ -41,23 +41,25 @@ export {
   CheatCodes,
   EthAddressLike,
   EthCheatCodes,
+  EventSelectorLike,
   FieldLike,
   FunctionSelectorLike,
   WrappedFieldLike,
   computeAuthWitMessageHash,
+  computeInnerAuthWitHashFromAction,
   computeInnerAuthWitHash,
-  computeOuterAuthWitHash,
   generatePublicKey,
   waitForAccountSynch,
   waitForPXE,
 } from './utils/index.js';
+export { NoteSelector } from '@aztec/foundation/abi';
 
 export { createPXEClient } from './rpc_clients/index.js';
 
 export { AuthWitnessProvider } from './account/index.js';
 
 export { AccountContract } from './account/index.js';
-export { AccountManager } from './account_manager/index.js';
+export { AccountManager, DeployAccountOptions } from './account_manager/index.js';
 
 export { AccountWallet, AccountWalletWithSecretKey, SignerlessWallet, Wallet } from './wallet/index.js';
 
@@ -95,7 +97,7 @@ export {
   CompleteAddress,
   EncryptedL2BlockL2Logs,
   EncryptedLogHeader,
-  EncryptedLogIncomingBody,
+  EncryptedNoteLogIncomingBody,
   EncryptedLogOutgoingBody,
   ExtendedNote,
   FunctionCall,
@@ -127,6 +129,9 @@ export {
   createAztecNodeClient,
   merkleTreeIds,
   mockTx,
+  TaggedLog,
+  L1NotePayload,
+  L1EventPayload,
 } from '@aztec/circuit-types';
 export { NodeInfo } from '@aztec/types/interfaces';
 

package/src/rpc_clients/pxe_client.ts

@@ -25,6 +25,7 @@ import {
   GrumpkinScalar,
   Point,
 } from '@aztec/circuits.js';
+import { NoteSelector } from '@aztec/foundation/abi';
 import { createJsonRpcClient, makeFetch } from '@aztec/foundation/json-rpc/client';
 
 /**
@@ -53,9 +54,10 @@ export const createPXEClient = (url: string, fetch = makeFetch([1, 2, 3], false)
       Point,
       TxExecutionRequest,
       TxHash,
+      NoteSelector,
     },
     { Tx, SimulatedTx, TxReceipt, EncryptedNoteL2BlockL2Logs, UnencryptedL2BlockL2Logs, NullifierMembershipWitness },
     false,
     'pxe',
     fetch,
-  );
+  ) as PXE;

package/src/utils/abi_types.ts

@@ -1,4 +1,10 @@
-import { type AztecAddress, type EthAddress, type Fr, type FunctionSelector } from '@aztec/circuits.js';
+import {
+  type AztecAddress,
+  type EthAddress,
+  type EventSelector,
+  type Fr,
+  type FunctionSelector,
+} from '@aztec/circuits.js';
 
 /** Any type that can be converted into a field for a contract call. */
 export type FieldLike = Fr | Buffer | bigint | number | { /** Converts to field */ toField: () => Fr };
@@ -9,8 +15,11 @@ export type EthAddressLike = { /** Wrapped address */ address: FieldLike } | Eth
 /** Any type that can be converted into an AztecAddress Aztec.nr struct. */
 export type AztecAddressLike = { /** Wrapped address */ address: FieldLike } | AztecAddress;
 
-/** Any type that can be converted into an FunctionSelector Aztec.nr struct. */
+/** Any type that can be converted into a FunctionSelector Aztec.nr struct. */
 export type FunctionSelectorLike = FieldLike | FunctionSelector;
 
+/** Any type that can be converted into an EventSelector Aztec.nr struct. */
+export type EventSelectorLike = FieldLike | EventSelector;
+
 /** Any type that can be converted into a struct with a single `inner` field. */
 export type WrappedFieldLike = { /** Wrapped value */ inner: FieldLike } | FieldLike;

package/src/utils/account.ts

@@ -14,11 +14,11 @@ export async function waitForAccountSynch(
   address: CompleteAddress,
   { interval, timeout }: WaitOpts = DefaultWaitOpts,
 ): Promise<void> {
-  const publicKey = address.publicKeys.masterIncomingViewingPublicKey.toString();
+  const accountAddress = address.address.toString();
   await retryUntil(
     async () => {
       const status = await pxe.getSyncStatus();
-      const accountSynchedToBlock = status.notes[publicKey];
+      const accountSynchedToBlock = status.notes[accountAddress];
       if (typeof accountSynchedToBlock === 'undefined') {
         return false;
       } else {

package/src/utils/authwit.ts

@@ -1,32 +1,77 @@
 import { type FunctionCall, PackedValues } from '@aztec/circuit-types';
-import { type AztecAddress, type Fr, GeneratorIndex } from '@aztec/circuits.js';
+import { type AztecAddress, Fr, GeneratorIndex } from '@aztec/circuits.js';
 import { pedersenHash } from '@aztec/foundation/crypto';
 
+import { ContractFunctionInteraction } from '../contract/contract_function_interaction.js';
+
+/** Metadata for the intent */
+export type IntentMetadata = {
+  /** The chain id to approve */
+  chainId: Fr;
+  /** The version to approve  */
+  version: Fr;
+};
+
+/** Intent with an inner hash */
+export type IntentInnerHash = {
+  /** The consumer   */
+  consumer: AztecAddress;
+  /** The action to approve */
+  innerHash: Buffer | Fr;
+};
+
+/** Intent with an action */
+export type IntentAction = {
+  /** The caller to approve  */
+  caller: AztecAddress;
+  /** The action to approve */
+  action: ContractFunctionInteraction | FunctionCall;
+};
+
 // docs:start:authwit_computeAuthWitMessageHash
 /**
- * Compute an authentication witness message hash from a caller and a request
- * H(target: AztecAddress, chainId: Field, version: Field, H(caller: AztecAddress, selector: Field, args_hash: Field))
- * Example usage would be `bob` authenticating `alice` to perform a transfer of `10`
- * tokens from his account to herself:
- * H(token, 1, 1, H(alice, transfer_selector, H(bob, alice, 10, nonce)))
- * `bob` then signs the message hash and gives it to `alice` who can then perform the
- * action.
- * @param caller - The caller approved to make the call
- * @param chainId - The chain id for the message
- * @param version - The version for the message
- * @param action - The request to be made (function call)
- * @returns The message hash for the witness
+ * Compute an authentication witness message hash from an intent and metadata
+ *
+ * If using the `IntentInnerHash`, the consumer is the address that can "consume" the authwit, for token approvals it is the token contract itself.
+ * The `innerHash` itself will be the message that a contract is allowed to execute.
+ * At the point of "approval checking", the validating contract (account for private and registry for public) will be computing the message hash
+ * (`H(consumer, chainid, version, inner_hash)`) where the all but the `inner_hash` is injected from the context (consumer = msg_sender),
+ * and use it for the authentication check.
+ * Therefore, any allowed `innerHash` will therefore also have information around where it can be spent (version, chainId) and who can spend it (consumer).
+ *
+ * If using the `IntentAction`, the caller is the address that is making the call, for a token approval from Alice to Bob, this would be Bob.
+ * The action is then used along with the `caller` to compute the `innerHash` and the consumer.
+ *
+ *
+ * @param intent - The intent to approve (consumer and innerHash or caller and action)
+ *                 The consumer is the address that can "consume" the authwit, for token approvals it is the token contract itself.
+ *                 The caller is the address that is making the call, for a token approval from Alice to Bob, this would be Bob.
+ *                 The caller becomes part of the `inner_hash` and is dealt with entirely in application logic.
+ * @param metadata - The metadata for the intent (chainId, version)
+ * @returns The message hash for the action
  */
-export const computeAuthWitMessageHash = (caller: AztecAddress, chainId: Fr, version: Fr, action: FunctionCall) => {
-  return computeOuterAuthWitHash(
-    action.to.toField(),
-    chainId,
-    version,
-    computeInnerAuthWitHash([caller.toField(), action.selector.toField(), PackedValues.fromValues(action.args).hash]),
-  );
+export const computeAuthWitMessageHash = (intent: IntentInnerHash | IntentAction, metadata: IntentMetadata) => {
+  const chainId = metadata.chainId;
+  const version = metadata.version;
+
+  if ('caller' in intent) {
+    const action = intent.action instanceof ContractFunctionInteraction ? intent.action.request() : intent.action;
+    return computeOuterAuthWitHash(
+      action.to.toField(),
+      chainId,
+      version,
+      computeInnerAuthWitHashFromAction(intent.caller, action),
+    );
+  } else {
+    const inner = Buffer.isBuffer(intent.innerHash) ? Fr.fromBuffer(intent.innerHash) : intent.innerHash;
+    return computeOuterAuthWitHash(intent.consumer, chainId, version, inner);
+  }
 };
 // docs:end:authwit_computeAuthWitMessageHash
 
+export const computeInnerAuthWitHashFromAction = (caller: AztecAddress, action: FunctionCall) =>
+  computeInnerAuthWitHash([caller.toField(), action.selector.toField(), PackedValues.fromValues(action.args).hash]);
+
 /**
  * Compute the inner hash for an authentication witness.
  * This is the "intent" of the message, before siloed with the consumer.
@@ -53,6 +98,6 @@ export const computeInnerAuthWitHash = (args: Fr[]) => {
  * @param innerHash - The inner hash for the witness
  * @returns The outer hash for the witness
  */
-export const computeOuterAuthWitHash = (consumer: AztecAddress, chainId: Fr, version: Fr, innerHash: Fr) => {
+const computeOuterAuthWitHash = (consumer: AztecAddress, chainId: Fr, version: Fr, innerHash: Fr) => {
   return pedersenHash([consumer.toField(), chainId, version, innerHash], GeneratorIndex.AUTHWIT_OUTER);
 };

package/src/utils/cheat_codes.ts

@@ -291,7 +291,11 @@ export class AztecCheatCodes {
    * @returns The notes stored at the given slot
    */
   public async loadPrivate(owner: AztecAddress, contract: AztecAddress, slot: Fr | bigint): Promise<Note[]> {
-    const extendedNotes = await this.pxe.getNotes({ owner, contractAddress: contract, storageSlot: new Fr(slot) });
+    const extendedNotes = await this.pxe.getIncomingNotes({
+      owner,
+      contractAddress: contract,
+      storageSlot: new Fr(slot),
+    });
     return extendedNotes.map(extendedNote => extendedNote.note);
   }
 }