@aztec/aztec.js 0.22.0 → 0.24.0

package/src/fee/generic_fee_payment_method.ts

@@ -0,0 +1,81 @@
+import { FunctionCall } from '@aztec/circuit-types';
+import { FunctionData } from '@aztec/circuits.js';
+import { FunctionSelector } from '@aztec/foundation/abi';
+import { AztecAddress } from '@aztec/foundation/aztec-address';
+import { Fr } from '@aztec/foundation/fields';
+
+import { FeePaymentMethod } from './fee_payment_method.js';
+
+/**
+ * Holds information about how the fee for a transaction is to be paid.
+ */
+export class GenericFeePaymentMethod implements FeePaymentMethod {
+  constructor(
+    /**
+     * The asset used to pay the fee.
+     */
+    private asset: AztecAddress,
+    /**
+     * Address which will hold the fee payment.
+     */
+    private paymentContract: AztecAddress,
+    /**
+     * Whether the fee payment is private
+     */
+    private privatePayment: boolean,
+  ) {}
+
+  /**
+   * The asset used to pay the fee.
+   * @returns The asset used to pay the fee.
+   */
+  getAsset() {
+    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;
+  }
+
+  /**
+   * The fee payment function selector on the fee payment contract.
+   * @returns The fee payment function selector on the fee payment contract.
+   */
+  #getFeePaymentEntrypoint() {
+    return this.privatePayment
+      ? FunctionSelector.fromSignature('prepare_fee_private(Field, (Field))')
+      : FunctionSelector.fromSignature('prepare_fee_public(Field, (Field))');
+  }
+
+  /**
+   * Whether the fee payment is private or not
+   * @returns Whether the fee payment is private or not
+   */
+  isPrivateFeePayment(): boolean {
+    return this.privatePayment;
+  }
+
+  /**
+   * Creates a function call to pay the fee in the given asset.
+   * @param maxFee - The maximum fee to be paid in the given asset.
+   * @returns The function call to pay the fee.
+   */
+  getFunctionCalls(maxFee: Fr): FunctionCall[] {
+    return [
+      // TODO(fees) set up auth witnesses
+      {
+        to: this.getPaymentContract(),
+        functionData: new FunctionData(this.#getFeePaymentEntrypoint(), false, true, false),
+        args: [maxFee, this.asset],
+      },
+    ];
+  }
+
+  static empty(): GenericFeePaymentMethod {
+    return new GenericFeePaymentMethod(AztecAddress.ZERO, AztecAddress.ZERO, false);
+  }
+}

package/src/fee/native_fee_payment_method.ts

@@ -0,0 +1,61 @@
+import { FunctionCall } from '@aztec/circuit-types';
+import { FunctionData } from '@aztec/circuits.js';
+import { FunctionSelector } from '@aztec/foundation/abi';
+import { AztecAddress } from '@aztec/foundation/aztec-address';
+import { Fr } from '@aztec/foundation/fields';
+
+import { FeePaymentMethod } from './fee_payment_method.js';
+
+/**
+ * Pay fee directly in the native gas token.
+ */
+export class NativeFeePaymentMethod implements FeePaymentMethod {
+  // TODO(fees) replace this with the address of the gas token when that's deployed.
+  static #GAS_TOKEN = AztecAddress.ZERO;
+
+  constructor() {}
+
+  /**
+   * Gets the native gas asset used to pay the fee.
+   * @returns The asset used to pay the fee.
+   */
+  getAsset() {
+    return NativeFeePaymentMethod.#GAS_TOKEN;
+  }
+
+  /**
+   * The contract responsible for fee payment. This will be the same as the asset.
+   * @returns The contract address responsible for holding the fee payment.
+   */
+  getPaymentContract() {
+    return NativeFeePaymentMethod.#GAS_TOKEN;
+  }
+
+  /**
+   * Fee payments in the native gas token are always public.
+   * @returns false
+   */
+  isPrivateFeePayment(): boolean {
+    return false;
+  }
+
+  /**
+   * Creates a function call to pay the fee in gas token..
+   * @param feeLimit - The maximum fee to be paid in gas token.
+   * @returns A function call
+   */
+  getFunctionCalls(feeLimit: Fr): FunctionCall[] {
+    return [
+      {
+        to: NativeFeePaymentMethod.#GAS_TOKEN,
+        functionData: new FunctionData(FunctionSelector.fromSignature('check_balance(Field)'), false, false, false),
+        args: [feeLimit],
+      },
+      {
+        to: NativeFeePaymentMethod.#GAS_TOKEN,
+        functionData: new FunctionData(FunctionSelector.fromSignature('pay_fee(Field)'), false, false, false),
+        args: [feeLimit],
+      },
+    ];
+  }
+}

package/src/index.ts

@@ -0,0 +1,144 @@
+/**
+ * This is our public api.
+ * Do NOT "export * from ..." here.
+ * Everything here should be explicit, to ensure we can clearly see everything we're exposing to the world.
+ * If it's exposed, people will use it, and then we can't remove/change the api without breaking client code.
+ * At the time of writing we overexpose things that should only be internal.
+ *
+ * TODO: Review and narrow scope of public api.
+ * We should also consider exposing subsections of the api via package.json exports, like we do with foundation.
+ * This can allow consumers to import much smaller parts of the library to incur less overhead.
+ * It will also allow web bundlers do perform intelligent chunking of bundles etc.
+ * Some work as been done on this within the api folder, providing the alternative import style of e.g.:
+ * ```typescript
+ *   import { TxHash } from '@aztec.js/tx_hash'
+ *   import { type ContractArtifact, type FunctionArtifact, FunctionSelector } from '@aztec/aztec.js/abi';
+ *   import { AztecAddress } from '@aztec/aztec.js/aztec_address';
+ *   import { EthAddress } from '@aztec/aztec.js/eth_address';
+ * ```
+ *
+ * TODO: Ultimately reimplement this mega exporter by mega exporting a granular api (then deprecate it).
+ */
+export {
+  WaitOpts,
+  ContractFunctionInteraction,
+  Contract,
+  ContractBase,
+  ContractMethod,
+  SentTx,
+  BatchCall,
+  DeployMethod,
+  DeploySentTx,
+} from './contract/index.js';
+
+export { ContractDeployer } from './deployment/index.js';
+
+export {
+  generatePublicKey,
+  FieldLike,
+  EthAddressLike,
+  computeMessageSecretHash,
+  CheatCodes,
+  AztecAddressLike,
+  FunctionSelectorLike,
+  WrappedFieldLike,
+  isContractDeployed,
+  EthCheatCodes,
+  computeAuthWitMessageHash,
+  waitForPXE,
+  waitForAccountSynch,
+} from './utils/index.js';
+
+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 { AccountWalletWithPrivateKey, AccountWallet, Wallet, SignerlessWallet } 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,
+  GlobalVariables,
+  GrumpkinScalar,
+  Point,
+  getContractInstanceFromDeployParams,
+  getContractClassFromArtifact,
+} from '@aztec/circuits.js';
+
+export { Grumpkin, Schnorr } from '@aztec/circuits.js/barretenberg';
+
+export {
+  AuthWitness,
+  AztecNode,
+  CompleteAddress,
+  ContractData,
+  DeployedContract,
+  ExtendedContractData,
+  ExtendedNote,
+  FunctionCall,
+  GrumpkinPrivateKey,
+  INITIAL_L2_BLOCK_NUM,
+  L2Actor,
+  L2Block,
+  L2BlockL2Logs,
+  LogFilter,
+  LogId,
+  LogType,
+  MerkleTreeId,
+  Note,
+  PXE,
+  PackedArguments,
+  PartialAddress,
+  PublicKey,
+  SyncStatus,
+  Tx,
+  TxExecutionRequest,
+  TxHash,
+  TxReceipt,
+  TxStatus,
+  UnencryptedL2Log,
+  createAztecNodeClient,
+  emptyFunctionCall,
+  merkleTreeIds,
+  mockTx,
+  Comparator,
+} from '@aztec/circuit-types';
+export { NodeInfo } from '@aztec/types/interfaces';
+
+export { ContractInstanceWithAddress, ContractClassWithId } 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 { sha256 } from '@aztec/foundation/crypto';
+export { DebugLogger, createDebugLogger, onLog } from '@aztec/foundation/log';
+export { retry, retryUntil } from '@aztec/foundation/retry';
+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 {
+  DeployL1Contracts,
+  L1ContractArtifactsForDeployment,
+  deployL1Contract,
+  deployL1Contracts,
+} from '@aztec/ethereum';
+
+// 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';

package/src/rpc_clients/index.ts

@@ -0,0 +1 @@
+export * from './pxe_client.js';

package/src/rpc_clients/pxe_client.ts

@@ -0,0 +1,62 @@
+import {
+  AuthWitness,
+  ContractData,
+  ExtendedContractData,
+  ExtendedNote,
+  ExtendedUnencryptedL2Log,
+  L2Block,
+  L2BlockL2Logs,
+  L2Tx,
+  LogId,
+  Note,
+  PXE,
+  Tx,
+  TxExecutionRequest,
+  TxHash,
+  TxReceipt,
+} from '@aztec/circuit-types';
+import {
+  AztecAddress,
+  CompleteAddress,
+  EthAddress,
+  Fr,
+  FunctionSelector,
+  GrumpkinScalar,
+  Point,
+} from '@aztec/circuits.js';
+import { createJsonRpcClient, makeFetch } from '@aztec/foundation/json-rpc/client';
+
+/**
+ * Creates a JSON-RPC client to remotely talk to PXE.
+ * @param url - The URL of the PXE.
+ * @param fetch - The fetch implementation to use.
+ * @returns A JSON-RPC client of PXE.
+ */
+export const createPXEClient = (url: string, fetch = makeFetch([1, 2, 3], true)): PXE =>
+  createJsonRpcClient<PXE>(
+    url,
+    {
+      CompleteAddress,
+      FunctionSelector,
+      AztecAddress,
+      TxExecutionRequest,
+      ContractData,
+      ExtendedContractData,
+      ExtendedUnencryptedL2Log,
+      TxHash,
+      EthAddress,
+      Point,
+      Fr,
+      GrumpkinScalar,
+      Note,
+      ExtendedNote,
+      AuthWitness,
+      L2Tx,
+      LogId,
+      L2Block,
+    },
+    { Tx, TxReceipt, L2BlockL2Logs },
+    false,
+    'pxe',
+    fetch,
+  );

package/src/utils/abi_types.ts

@@ -0,0 +1,16 @@
+import { AztecAddress, EthAddress, Fr, 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 };
+
+/** Any type that can be converted into an EthAddress Aztec.nr struct. */
+export type EthAddressLike = { /** Wrapped address */ address: FieldLike } | EthAddress;
+
+/** 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. */
+export type FunctionSelectorLike = FieldLike | FunctionSelector;
+
+/** 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

@@ -0,0 +1,32 @@
+import { CompleteAddress, PXE } from '@aztec/circuit-types';
+import { retryUntil } from '@aztec/foundation/retry';
+
+import { DefaultWaitOpts, WaitOpts } from '../contract/index.js';
+
+/**
+ * Waits for the account to finish synchronizing with the PXE Service.
+ * @param pxe - PXE instance
+ * @param address - Address to wait for synch
+ * @param opts - Wait options
+ */
+export async function waitForAccountSynch(
+  pxe: PXE,
+  address: CompleteAddress,
+  { interval, timeout }: WaitOpts = DefaultWaitOpts,
+): Promise<void> {
+  const publicKey = address.publicKey.toString();
+  await retryUntil(
+    async () => {
+      const status = await pxe.getSyncStatus();
+      const accountSynchedToBlock = status.notes[publicKey];
+      if (typeof accountSynchedToBlock === 'undefined') {
+        return false;
+      } else {
+        return accountSynchedToBlock >= status.blocks;
+      }
+    },
+    'waitForAccountSynch',
+    timeout,
+    interval,
+  );
+}

package/src/utils/authwit.ts

@@ -0,0 +1,24 @@
+import { FunctionCall, PackedArguments } from '@aztec/circuit-types';
+import { AztecAddress, GeneratorIndex } from '@aztec/circuits.js';
+import { pedersenHash } from '@aztec/foundation/crypto';
+
+// docs:start:authwit_computeAuthWitMessageHash
+/**
+ * Compute an authentication witness message hash from a caller and a request
+ * H(caller: AztecAddress, target: AztecAddress, selector: Field, args_hash: Field)
+ * @param caller - The caller approved to make the call
+ * @param request - The request to be made (function call)
+ * @returns The message hash for the witness
+ */
+export const computeAuthWitMessageHash = (caller: AztecAddress, request: FunctionCall) => {
+  return pedersenHash(
+    [
+      caller.toField(),
+      request.to.toField(),
+      request.functionData.selector.toField(),
+      PackedArguments.fromArgs(request.args).hash,
+    ].map(fr => fr.toBuffer()),
+    GeneratorIndex.SIGNATURE_PAYLOAD,
+  );
+};
+// docs:end:authwit_computeAuthWitMessageHash