@aztec/aztec.js 0.28.1 → 0.30.0

package/src/fee/native_fee_payment_method.ts

@@ -1,25 +1,33 @@
 import { FunctionCall } from '@aztec/circuit-types';
-import { FunctionData } from '@aztec/circuits.js';
+import { AztecAddress, FunctionData } from '@aztec/circuits.js';
 import { FunctionSelector } from '@aztec/foundation/abi';
 import { Fr } from '@aztec/foundation/fields';
-import { GasTokenAddress } from '@aztec/protocol-contracts/gas-token';
+import { getCanonicalGasTokenAddress } from '@aztec/protocol-contracts/gas-token';
 
+import { Wallet } from '../account/wallet.js';
 import { FeePaymentMethod } from './fee_payment_method.js';
 
 /**
  * Pay fee directly in the native gas token.
  */
 export class NativeFeePaymentMethod implements FeePaymentMethod {
-  static #GAS_TOKEN = GasTokenAddress;
+  #gasTokenAddress: AztecAddress;
 
-  constructor() {}
+  private constructor(canonicalGasTokenAddress: AztecAddress) {
+    this.#gasTokenAddress = canonicalGasTokenAddress;
+  }
+
+  static async create(wallet: Wallet): Promise<NativeFeePaymentMethod> {
+    const nodeInfo = await wallet.getNodeInfo();
+    return new NativeFeePaymentMethod(getCanonicalGasTokenAddress(nodeInfo.l1ContractAddresses.gasPortalAddress));
+  }
 
   /**
    * Gets the native gas asset used to pay the fee.
    * @returns The asset used to pay the fee.
    */
   getAsset() {
-    return NativeFeePaymentMethod.#GAS_TOKEN;
+    return this.#gasTokenAddress;
   }
 
   /**
@@ -27,7 +35,7 @@ export class NativeFeePaymentMethod implements FeePaymentMethod {
    * @returns The contract address responsible for holding the fee payment.
    */
   getPaymentContract() {
-    return NativeFeePaymentMethod.#GAS_TOKEN;
+    return this.#gasTokenAddress;
   }
 
   /**
@@ -46,13 +54,13 @@ export class NativeFeePaymentMethod implements FeePaymentMethod {
   getFunctionCalls(feeLimit: Fr): Promise<FunctionCall[]> {
     return Promise.resolve([
       {
-        to: NativeFeePaymentMethod.#GAS_TOKEN,
-        functionData: new FunctionData(FunctionSelector.fromSignature('check_balance(Field)'), false, false, false),
+        to: this.#gasTokenAddress,
+        functionData: new FunctionData(FunctionSelector.fromSignature('check_balance(Field)'), false),
         args: [feeLimit],
       },
       {
-        to: NativeFeePaymentMethod.#GAS_TOKEN,
-        functionData: new FunctionData(FunctionSelector.fromSignature('pay_fee(Field)'), false, false, false),
+        to: this.#gasTokenAddress,
+        functionData: new FunctionData(FunctionSelector.fromSignature('pay_fee(Field)'), false),
         args: [feeLimit],
       },
     ]);

package/src/fee/private_fee_payment_method.ts

@@ -60,15 +60,10 @@ export class PrivateFeePaymentMethod implements FeePaymentMethod {
     const nonce = Fr.random();
     const messageHash = computeAuthWitMessageHash(this.paymentContract, {
       args: [this.wallet.getCompleteAddress().address, this.paymentContract, maxFee, nonce],
-      functionData: new FunctionData(
-        FunctionSelector.fromSignature('unshield((Field),(Field),Field,Field)'),
-        false,
-        true,
-        false,
-      ),
+      functionData: new FunctionData(FunctionSelector.fromSignature('unshield((Field),(Field),Field,Field)'), true),
       to: this.asset,
     });
-    await this.wallet.createAuthWitness(messageHash);
+    await this.wallet.createAuthWit(messageHash);
 
     const secretHashForRebate = computeMessageSecretHash(this.rebateSecret);
 
@@ -77,9 +72,7 @@ export class PrivateFeePaymentMethod implements FeePaymentMethod {
         to: this.getPaymentContract(),
         functionData: new FunctionData(
           FunctionSelector.fromSignature('fee_entrypoint_private(Field,(Field),Field,Field)'),
-          false,
           true,
-          false,
         ),
         args: [maxFee, this.asset, secretHashForRebate, nonce],
       },

package/src/fee/public_fee_payment_method.ts

@@ -56,21 +56,17 @@ export class PublicFeePaymentMethod implements FeePaymentMethod {
       functionData: new FunctionData(
         FunctionSelector.fromSignature('transfer_public((Field),(Field),Field,Field)'),
         false,
-        false,
-        false,
       ),
       to: this.asset,
     });
 
     return Promise.resolve([
-      this.wallet.setPublicAuth(messageHash, true).request(),
+      this.wallet.setPublicAuthWit(messageHash, true).request(),
       {
         to: this.getPaymentContract(),
         functionData: new FunctionData(
           FunctionSelector.fromSignature('fee_entrypoint_public(Field,(Field),Field)'),
-          false,
           true,
-          false,
         ),
         args: [maxFee, this.asset, nonce],
       },

package/src/index.ts

@@ -41,7 +41,6 @@ export {
   AztecAddressLike,
   FunctionSelectorLike,
   WrappedFieldLike,
-  isContractDeployed,
   EthCheatCodes,
   computeAuthWitMessageHash,
   computeInnerAuthWitHash,
@@ -69,7 +68,7 @@ export {
   GlobalVariables,
   GrumpkinScalar,
   Point,
-  getContractInstanceFromDeployParams,
+  getContractInstanceFromDeployParams, // TODO(@spalladino) This method should be used from within the DeployMethod but not exposed in aztec.js
   getContractClassFromArtifact,
   INITIAL_L2_BLOCK_NUM,
 } from '@aztec/circuits.js';
@@ -83,9 +82,6 @@ export {
   AztecNode,
   Body,
   CompleteAddress,
-  ContractData,
-  DeployedContract,
-  ExtendedContractData,
   ExtendedNote,
   FunctionCall,
   GrumpkinPrivateKey,

package/src/rpc_clients/pxe_client.ts

@@ -1,7 +1,5 @@
 import {
   AuthWitness,
-  ContractData,
-  ExtendedContractData,
   ExtendedNote,
   ExtendedUnencryptedL2Log,
   L2Block,
@@ -40,10 +38,8 @@ export const createPXEClient = (url: string, fetch = makeFetch([1, 2, 3], false)
       AuthWitness,
       AztecAddress,
       CompleteAddress,
-      ContractData,
       FunctionSelector,
       EthAddress,
-      ExtendedContractData,
       ExtendedNote,
       ExtendedUnencryptedL2Log,
       Fr,

package/src/utils/authwit.ts

@@ -12,16 +12,16 @@ import { pedersenHash } from '@aztec/foundation/crypto';
  * `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 request - The request to be made (function call)
+ * @param action - The request to be made (function call)
  * @returns The message hash for the witness
  */
-export const computeAuthWitMessageHash = (caller: AztecAddress, request: FunctionCall) => {
+export const computeAuthWitMessageHash = (caller: AztecAddress, action: FunctionCall) => {
   return computeOuterAuthWitHash(
-    request.to.toField(),
+    action.to.toField(),
     computeInnerAuthWitHash([
       caller.toField(),
-      request.functionData.selector.toField(),
-      PackedArguments.fromArgs(request.args).hash,
+      action.functionData.selector.toField(),
+      PackedArguments.fromArgs(action.args).hash,
     ]),
   );
 };

package/src/utils/index.ts

@@ -1,6 +1,5 @@
 export * from './pub_key.js';
 export * from './l1_contracts.js';
-export * from './l2_contracts.js';
 export * from './abi_types.js';
 export * from './cheat_codes.js';
 export * from './authwit.js';

package/src/wallet/account_wallet.ts

@@ -1,9 +1,10 @@
 import { AuthWitness, FunctionCall, PXE, TxExecutionRequest } from '@aztec/circuit-types';
-import { Fr } from '@aztec/circuits.js';
+import { AztecAddress, Fr } from '@aztec/circuits.js';
 import { ABIParameterVisibility, FunctionAbi, FunctionType } from '@aztec/foundation/abi';
 
 import { AccountInterface, FeeOptions } from '../account/interface.js';
 import { ContractFunctionInteraction } from '../contract/contract_function_interaction.js';
+import { computeAuthWitMessageHash } from '../utils/authwit.js';
 import { BaseWallet } from './base_wallet.js';
 
 /**
@@ -18,21 +19,76 @@ export class AccountWallet extends BaseWallet {
     return this.account.createTxExecutionRequest(execs, fee);
   }
 
-  async createAuthWitness(message: Fr | Buffer): Promise<AuthWitness> {
-    message = Buffer.isBuffer(message) ? Fr.fromBuffer(message) : message;
-    const witness = await this.account.createAuthWitness(message);
+  /**
+   * 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
+   * @returns The authentication witness
+   */
+  async createAuthWit(
+    messageHashOrIntent:
+      | Fr
+      | Buffer
+      | {
+          /** The caller to approve  */
+          caller: AztecAddress;
+          /** The action to approve */
+          action: ContractFunctionInteraction | FunctionCall;
+        },
+  ): Promise<AuthWitness> {
+    const messageHash = this.getMessageHash(messageHashOrIntent);
+    const witness = await this.account.createAuthWit(messageHash);
     await this.pxe.addAuthWitness(witness);
     return witness;
   }
 
   /**
-   * Returns a function interaction to set a message hash as authorized in this account.
+   * 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
+   */
+  private getMessageHash(
+    messageHashOrIntent:
+      | Fr
+      | Buffer
+      | {
+          /** The caller to approve  */
+          caller: AztecAddress;
+          /** The action to approve */
+          action: ContractFunctionInteraction | FunctionCall;
+        },
+  ): Fr {
+    if (Buffer.isBuffer(messageHashOrIntent)) {
+      return Fr.fromBuffer(messageHashOrIntent);
+    } else if (messageHashOrIntent instanceof Fr) {
+      return messageHashOrIntent;
+    } else if (messageHashOrIntent.action instanceof ContractFunctionInteraction) {
+      return computeAuthWitMessageHash(messageHashOrIntent.caller, messageHashOrIntent.action.request());
+    }
+    return computeAuthWitMessageHash(messageHashOrIntent.caller, messageHashOrIntent.action);
+  }
+
+  /**
+   * Returns a function interaction to set a message hash as authorized or revoked in this account.
    * Public calls can then consume this authorization.
-   * @param message - Message hash to authorize.
+   * @param messageHashOrIntent - The message or the caller and action to authorize/revoke
    * @param authorized - True to authorize, false to revoke authorization.
    * @returns - A function interaction.
    */
-  public setPublicAuth(message: Fr | Buffer, authorized: boolean): ContractFunctionInteraction {
+  public setPublicAuthWit(
+    messageHashOrIntent:
+      | Fr
+      | Buffer
+      | {
+          /** The caller to approve  */
+          caller: AztecAddress;
+          /** The action to approve */
+          action: ContractFunctionInteraction | FunctionCall;
+        },
+    authorized: boolean,
+  ): ContractFunctionInteraction {
+    const message = this.getMessageHash(messageHashOrIntent);
     if (authorized) {
       return new ContractFunctionInteraction(this, this.getAddress(), this.getApprovePublicAuthwitAbi(), [message]);
     } else {
@@ -42,10 +98,21 @@ export class AccountWallet extends BaseWallet {
 
   /**
    * Returns a function interaction to cancel a message hash as authorized in this account.
-   * @param message - Message hash to authorize.
+   * @param messageHashOrIntent - The message or the caller and action to authorize/revoke
    * @returns - A function interaction.
    */
-  public cancelAuthWit(message: Fr | Buffer): ContractFunctionInteraction {
+  public cancelAuthWit(
+    messageHashOrIntent:
+      | Fr
+      | Buffer
+      | {
+          /** The caller to approve  */
+          caller: AztecAddress;
+          /** The action to approve */
+          action: ContractFunctionInteraction | FunctionCall;
+        },
+  ): ContractFunctionInteraction {
+    const message = this.getMessageHash(messageHashOrIntent);
     const args = [message];
     return new ContractFunctionInteraction(this, this.getAddress(), this.getCancelAuthwitAbi(), args);
   }

package/src/wallet/base_wallet.ts

@@ -1,8 +1,5 @@
 import {
   AuthWitness,
-  ContractData,
-  DeployedContract,
-  ExtendedContractData,
   ExtendedNote,
   FunctionCall,
   GetUnencryptedLogsResponse,
@@ -18,11 +15,13 @@ import {
   TxReceipt,
 } from '@aztec/circuit-types';
 import { AztecAddress, CompleteAddress, Fr, GrumpkinPrivateKey, PartialAddress } from '@aztec/circuits.js';
+import { ContractArtifact } from '@aztec/foundation/abi';
 import { ContractClassWithId, ContractInstanceWithAddress } from '@aztec/types/contracts';
 import { NodeInfo } from '@aztec/types/interfaces';
 
 import { FeeOptions } from '../account/interface.js';
 import { Wallet } from '../account/wallet.js';
+import { ContractFunctionInteraction } from '../contract/contract_function_interaction.js';
 
 /**
  * A base class for Wallet implementations
@@ -34,8 +33,21 @@ export abstract class BaseWallet implements Wallet {
 
   abstract createTxExecutionRequest(execs: FunctionCall[], fee?: FeeOptions): Promise<TxExecutionRequest>;
 
-  abstract createAuthWitness(message: Fr): Promise<AuthWitness>;
+  abstract createAuthWit(
+    messageHashOrIntent:
+      | Fr
+      | Buffer
+      | {
+          /** The caller to approve  */
+          caller: AztecAddress;
+          /** The action to approve */
+          action: ContractFunctionInteraction | FunctionCall;
+        },
+  ): Promise<AuthWitness>;
 
+  getAddress() {
+    return this.getCompleteAddress().address;
+  }
   getContractInstance(address: AztecAddress): Promise<ContractInstanceWithAddress | undefined> {
     return this.pxe.getContractInstance(address);
   }
@@ -63,8 +75,14 @@ export abstract class BaseWallet implements Wallet {
   getRecipient(address: AztecAddress): Promise<CompleteAddress | undefined> {
     return this.pxe.getRecipient(address);
   }
-  addContracts(contracts: DeployedContract[]): Promise<void> {
-    return this.pxe.addContracts(contracts);
+  registerContract(contract: {
+    /** Instance */ instance: ContractInstanceWithAddress;
+    /** Associated artifact */ artifact?: ContractArtifact;
+  }): Promise<void> {
+    return this.pxe.registerContract(contract);
+  }
+  registerContractClass(artifact: ContractArtifact): Promise<void> {
+    return this.pxe.registerContractClass(artifact);
   }
   getContracts(): Promise<AztecAddress[]> {
     return this.pxe.getContracts();
@@ -100,12 +118,6 @@ export abstract class BaseWallet implements Wallet {
   viewTx(functionName: string, args: any[], to: AztecAddress, from?: AztecAddress | undefined): Promise<any> {
     return this.pxe.viewTx(functionName, args, to, from);
   }
-  getExtendedContractData(contractAddress: AztecAddress): Promise<ExtendedContractData | undefined> {
-    return this.pxe.getExtendedContractData(contractAddress);
-  }
-  getContractData(contractAddress: AztecAddress): Promise<ContractData | undefined> {
-    return this.pxe.getContractData(contractAddress);
-  }
   getUnencryptedLogs(filter: LogFilter): Promise<GetUnencryptedLogsResponse> {
     return this.pxe.getUnencryptedLogs(filter);
   }
@@ -130,4 +142,7 @@ export abstract class BaseWallet implements Wallet {
   isContractClassPubliclyRegistered(id: Fr): Promise<boolean> {
     return this.pxe.isContractClassPubliclyRegistered(id);
   }
+  isContractPubliclyDeployed(address: AztecAddress): Promise<boolean> {
+    return this.pxe.isContractPubliclyDeployed(address);
+  }
 }

package/src/wallet/signerless_wallet.ts

@@ -31,7 +31,7 @@ export class SignerlessWallet extends BaseWallet {
     throw new Error('Method not implemented.');
   }
 
-  createAuthWitness(_message: Fr): Promise<AuthWitness> {
+  createAuthWit(_message: Fr): Promise<AuthWitness> {
     throw new Error('Method not implemented.');
   }
 }

package/dest/utils/l2_contracts.d.ts

@@ -1,10 +0,0 @@
-import { PXE } from '@aztec/circuit-types';
-import { AztecAddress } from '@aztec/foundation/aztec-address';
-/**
- * Checks whether a give contract is deployed on the network.
- * @param pxe - The PXE to use to obtain the information.
- * @param contractAddress - The address of the contract to check.
- * @returns A flag indicating whether the contract is deployed.
- */
-export declare function isContractDeployed(pxe: PXE, contractAddress: AztecAddress): Promise<boolean>;
-//# sourceMappingURL=l2_contracts.d.ts.map

package/dest/utils/l2_contracts.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"l2_contracts.d.ts","sourceRoot":"","sources":["../../src/utils/l2_contracts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,GAAG,EAAE,MAAM,sBAAsB,CAAC;AAC3C,OAAO,EAAE,YAAY,EAAE,MAAM,iCAAiC,CAAC;AAE/D;;;;;GAKG;AACH,wBAAsB,kBAAkB,CAAC,GAAG,EAAE,GAAG,EAAE,eAAe,EAAE,YAAY,GAAG,OAAO,CAAC,OAAO,CAAC,CAElG"}

package/dest/utils/l2_contracts.js

@@ -1,10 +0,0 @@
-/**
- * Checks whether a give contract is deployed on the network.
- * @param pxe - The PXE to use to obtain the information.
- * @param contractAddress - The address of the contract to check.
- * @returns A flag indicating whether the contract is deployed.
- */
-export async function isContractDeployed(pxe, contractAddress) {
-    return !!(await pxe.getContractData(contractAddress)) || !!(await pxe.getContractInstance(contractAddress));
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoibDJfY29udHJhY3RzLmpzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL3V0aWxzL2wyX2NvbnRyYWN0cy50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFHQTs7Ozs7R0FLRztBQUNILE1BQU0sQ0FBQyxLQUFLLFVBQVUsa0JBQWtCLENBQUMsR0FBUSxFQUFFLGVBQTZCO0lBQzlFLE9BQU8sQ0FBQyxDQUFDLENBQUMsTUFBTSxHQUFHLENBQUMsZUFBZSxDQUFDLGVBQWUsQ0FBQyxDQUFDLElBQUksQ0FBQyxDQUFDLENBQUMsTUFBTSxHQUFHLENBQUMsbUJBQW1CLENBQUMsZUFBZSxDQUFDLENBQUMsQ0FBQztBQUM5RyxDQUFDIn0=

package/src/utils/l2_contracts.ts

@@ -1,12 +0,0 @@
-import { PXE } from '@aztec/circuit-types';
-import { AztecAddress } from '@aztec/foundation/aztec-address';
-
-/**
- * Checks whether a give contract is deployed on the network.
- * @param pxe - The PXE to use to obtain the information.
- * @param contractAddress - The address of the contract to check.
- * @returns A flag indicating whether the contract is deployed.
- */
-export async function isContractDeployed(pxe: PXE, contractAddress: AztecAddress): Promise<boolean> {
-  return !!(await pxe.getContractData(contractAddress)) || !!(await pxe.getContractInstance(contractAddress));
-}