@aztec/aztec.js 0.0.0-test.1 → 0.0.1-commit.b655e406

package/src/entrypoint/payload.ts

@@ -1,238 +0,0 @@
-import { GeneratorIndex } from '@aztec/constants';
-import { padArrayEnd } from '@aztec/foundation/collection';
-import { poseidon2HashWithSeparator } from '@aztec/foundation/crypto';
-import { Fr } from '@aztec/foundation/fields';
-import type { Tuple } from '@aztec/foundation/serialize';
-import type { FieldsOf } from '@aztec/foundation/types';
-import { FunctionCall, FunctionType } from '@aztec/stdlib/abi';
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { GasSettings } from '@aztec/stdlib/gas';
-import { HashedValues } from '@aztec/stdlib/tx';
-
-import type { FeePaymentMethod } from '../fee/fee_payment_method.js';
-
-/**
- * Fee payment options for a transaction.
- */
-export type FeeOptions = {
-  /** The fee payment method to use */
-  paymentMethod: FeePaymentMethod;
-  /** The gas settings */
-  gasSettings: GasSettings;
-};
-
-// docs:start:user_fee_options
-/** Fee options as set by a user. */
-export type UserFeeOptions = {
-  /** The fee payment method to use */
-  paymentMethod?: FeePaymentMethod;
-  /** The gas settings */
-  gasSettings?: Partial<FieldsOf<GasSettings>>;
-  /** Percentage to pad the base fee by, if empty, defaults to 0.5 */
-  baseFeePadding?: number;
-  /** Whether to run an initial simulation of the tx with high gas limit to figure out actual gas settings. */
-  estimateGas?: boolean;
-  /** Percentage to pad the estimated gas limits by, if empty, defaults to 0.1. Only relevant if estimateGas is set. */
-  estimatedGasPadding?: number;
-};
-// docs:end:user_fee_options
-
-// These must match the values defined in:
-// - noir-projects/aztec-nr/aztec/src/entrypoint/app.nr
-const APP_MAX_CALLS = 4;
-// - and noir-projects/aztec-nr/aztec/src/entrypoint/fee.nr
-const FEE_MAX_CALLS = 2;
-
-/* eslint-disable camelcase */
-/** Encoded function call for account contract entrypoint */
-type EncodedFunctionCall = {
-  /** Arguments hash for the call */
-  args_hash: Fr;
-  /** Selector of the function to call */
-  function_selector: Fr;
-  /** Address of the contract to call */
-  target_address: Fr;
-  /** Whether the function is public or private */
-  is_public: boolean;
-  /** Whether the function can alter state */
-  is_static: boolean;
-};
-/* eslint-enable camelcase */
-
-/** Assembles an entrypoint payload */
-export abstract class EntrypointPayload {
-  protected constructor(
-    private functionCalls: EncodedFunctionCall[],
-    private _hashedArguments: HashedValues[],
-    private generatorIndex: number,
-    private _nonce: Fr,
-  ) {}
-
-  protected static async create(functionCalls: FunctionCall[]) {
-    const hashedArguments: HashedValues[] = [];
-    for (const call of functionCalls) {
-      hashedArguments.push(await HashedValues.fromValues(call.args));
-    }
-
-    /* eslint-disable camelcase */
-    const encodedFunctionCalls = functionCalls.map((call, index) => ({
-      args_hash: hashedArguments[index].hash,
-      function_selector: call.selector.toField(),
-      target_address: call.to.toField(),
-      is_public: call.type == FunctionType.PUBLIC,
-      is_static: call.isStatic,
-    }));
-    /* eslint-enable camelcase */
-
-    return {
-      encodedFunctionCalls,
-      hashedArguments,
-    };
-  }
-
-  /* eslint-disable camelcase */
-  /**
-   * The function calls to execute. This uses snake_case naming so that it is compatible with Noir encoding
-   * @internal
-   */
-  get function_calls() {
-    return this.functionCalls;
-  }
-  /* eslint-enable camelcase */
-
-  /**
-   * The nonce
-   * @internal
-   */
-  get nonce() {
-    return this._nonce;
-  }
-
-  /**
-   * The hashed arguments for the function calls
-   */
-  get hashedArguments() {
-    return this._hashedArguments;
-  }
-
-  /**
-   * Serializes the payload to an array of fields
-   * @returns The fields of the payload
-   */
-  abstract toFields(): Fr[];
-
-  /**
-   * Hashes the payload
-   * @returns The hash of the payload
-   */
-  hash() {
-    return poseidon2HashWithSeparator(this.toFields(), this.generatorIndex);
-  }
-
-  /** Serializes the function calls to an array of fields. */
-  protected functionCallsToFields() {
-    return this.functionCalls.flatMap(call => [
-      call.args_hash,
-      call.function_selector,
-      call.target_address,
-      new Fr(call.is_public),
-      new Fr(call.is_static),
-    ]);
-  }
-
-  /**
-   * Creates an execution payload for a dapp from a set of function calls
-   * @param functionCalls - The function calls to execute
-   * @returns The execution payload
-   */
-  static async fromFunctionCalls(functionCalls: FunctionCall[]) {
-    const { encodedFunctionCalls, hashedArguments } = await this.create(functionCalls);
-    return new AppEntrypointPayload(encodedFunctionCalls, hashedArguments, 0, Fr.random());
-  }
-
-  /**
-   * Creates an execution payload for the app-portion of a transaction from a set of function calls
-   * @param functionCalls - The function calls to execute
-   * @param nonce - The nonce for the payload, used to emit a nullifier identifying the call
-   * @returns The execution payload
-   */
-  static async fromAppExecution(functionCalls: FunctionCall[] | Tuple<FunctionCall, 4>, nonce = Fr.random()) {
-    if (functionCalls.length > APP_MAX_CALLS) {
-      throw new Error(`Expected at most ${APP_MAX_CALLS} function calls, got ${functionCalls.length}`);
-    }
-    const paddedCalls = padArrayEnd(functionCalls, FunctionCall.empty(), APP_MAX_CALLS);
-    const { encodedFunctionCalls, hashedArguments } = await this.create(paddedCalls);
-    return new AppEntrypointPayload(encodedFunctionCalls, hashedArguments, GeneratorIndex.SIGNATURE_PAYLOAD, nonce);
-  }
-
-  /**
-   * Creates an execution payload to pay the fee for a transaction
-   * @param sender - The address sending this payload
-   * @param feeOpts - The fee payment options
-   * @returns The execution payload
-   */
-  static async fromFeeOptions(sender: AztecAddress, feeOpts?: FeeOptions) {
-    const calls = (await feeOpts?.paymentMethod.getFunctionCalls(feeOpts?.gasSettings)) ?? [];
-    const feePayer = await feeOpts?.paymentMethod.getFeePayer(feeOpts?.gasSettings);
-    const isFeePayer = !!feePayer && feePayer.equals(sender);
-    const paddedCalls = padArrayEnd(calls, FunctionCall.empty(), FEE_MAX_CALLS);
-    const { encodedFunctionCalls, hashedArguments } = await this.create(paddedCalls);
-    return new FeeEntrypointPayload(
-      encodedFunctionCalls,
-      hashedArguments,
-      GeneratorIndex.FEE_PAYLOAD,
-      Fr.random(),
-      isFeePayer,
-    );
-  }
-}
-
-/** Entrypoint payload for app phase execution. */
-class AppEntrypointPayload extends EntrypointPayload {
-  override toFields(): Fr[] {
-    return [...this.functionCallsToFields(), this.nonce];
-  }
-}
-
-/** Entrypoint payload for fee payment to be run during setup phase. */
-class FeeEntrypointPayload extends EntrypointPayload {
-  #isFeePayer: boolean;
-
-  constructor(
-    functionCalls: EncodedFunctionCall[],
-    hashedArguments: HashedValues[],
-    generatorIndex: number,
-    nonce: Fr,
-    isFeePayer: boolean,
-  ) {
-    super(functionCalls, hashedArguments, generatorIndex, nonce);
-    this.#isFeePayer = isFeePayer;
-  }
-
-  override toFields(): Fr[] {
-    return [...this.functionCallsToFields(), this.nonce, new Fr(this.#isFeePayer)];
-  }
-
-  /* eslint-disable camelcase */
-  /** Whether the sender should be appointed as fee payer. */
-  get is_fee_payer() {
-    return this.#isFeePayer;
-  }
-  /* eslint-enable camelcase */
-}
-
-/**
- * Computes a hash of a combined payload.
- * @param appPayload - An app payload.
- * @param feePayload - A fee payload.
- * @returns A hash of a combined payload.
- */
-export async function computeCombinedPayloadHash(
-  appPayload: AppEntrypointPayload,
-  feePayload: FeeEntrypointPayload,
-): Promise<Fr> {
-  return poseidon2HashWithSeparator(
-    [await appPayload.hash(), await feePayload.hash()],
-    GeneratorIndex.COMBINED_PAYLOAD,
-  );
-}

package/src/fee/fee_juice_payment_method.ts

@@ -1,26 +0,0 @@
-import { ProtocolContractAddress } from '@aztec/protocol-contracts';
-import type { FunctionCall } from '@aztec/stdlib/abi';
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-
-import type { FeePaymentMethod } from './fee_payment_method.js';
-
-// docs:start:fee_juice_method
-/**
- * Pay fee directly in the Fee Juice.
- */
-export class FeeJuicePaymentMethod implements FeePaymentMethod {
-  // docs:end:fee_juice_method
-  constructor(protected sender: AztecAddress) {}
-
-  getAsset() {
-    return Promise.resolve(ProtocolContractAddress.FeeJuice);
-  }
-
-  getFunctionCalls(): Promise<FunctionCall[]> {
-    return Promise.resolve([]);
-  }
-
-  getFeePayer(): Promise<AztecAddress> {
-    return Promise.resolve(this.sender);
-  }
-}

package/src/index.ts

@@ -1,106 +0,0 @@
-/**
- * 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/addresses';
- *   import { EthAddress } from '@aztec/aztec.js/eth_address';
- * ```
- *
- * TODO: Ultimately reimplement this mega exporter by mega exporting a granular api (then deprecate it).
- */
-
-export { ContractDeployer } from './deployment/index.js';
-
-export { NoteSelector } from '@aztec/stdlib/abi';
-
-export { createCompatibleClient, createPXEClient } from './rpc_clients/index.js';
-
-export { type DeployAccountOptions } from './account_manager/index.js';
-
-export { AccountWallet, AccountWalletWithSecretKey, SignerlessWallet } from './wallet/index.js';
-
-export { EthAddress } from '@aztec/foundation/eth-address';
-
-export { Fq, Fr, Point, GrumpkinScalar } from '@aztec/foundation/fields';
-
-export { SiblingPath } from '@aztec/foundation/trees';
-
-export { INITIAL_L2_BLOCK_NUM } from '@aztec/constants';
-
-export {
-  type PartialAddress,
-  type ContractClassWithId,
-  type ContractInstanceWithAddress,
-  getContractClassFromArtifact,
-  getContractInstanceFromDeployParams,
-  type NodeInfo,
-} from '@aztec/stdlib/contract';
-export { MerkleTreeId, merkleTreeIds } from '@aztec/stdlib/trees';
-export { type PublicKey, PublicKeys } from '@aztec/stdlib/keys';
-export { computeSecretHash } from '@aztec/stdlib/hash';
-export {
-  computeAppNullifierSecretKey,
-  deriveKeys,
-  deriveMasterIncomingViewingSecretKey,
-  deriveMasterNullifierSecretKey,
-} from '@aztec/stdlib/keys';
-export { AuthWitness } from '@aztec/stdlib/auth-witness';
-export { getTimestampRangeForEpoch } from '@aztec/stdlib/epoch-helpers';
-export { FunctionCall } from '@aztec/stdlib/abi';
-export {
-  Tx,
-  TxExecutionRequest,
-  TxHash,
-  TxReceipt,
-  TxStatus,
-  Capsule,
-  HashedValues,
-  GlobalVariables,
-} from '@aztec/stdlib/tx';
-export { Body, L2Block } from '@aztec/stdlib/block';
-export { L1NotePayload, LogId, type LogFilter, EncryptedLogPayload } from '@aztec/stdlib/logs';
-export { L1EventPayload, EventMetadata } from '@aztec/stdlib/event';
-export { L1ToL2Message, L2Actor, L1Actor } from '@aztec/stdlib/messaging';
-export { UniqueNote, ExtendedNote, Comparator, Note } from '@aztec/stdlib/note';
-export { type PXE, EventType } from '@aztec/stdlib/interfaces/client';
-
-export { ProtocolContractAddress } from '@aztec/protocol-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 { decodeFromAbi, encodeArguments, type AbiType } from '@aztec/stdlib/abi';
-export { toBigIntBE } from '@aztec/foundation/bigint-buffer';
-export { sha256, Grumpkin, Schnorr } from '@aztec/foundation/crypto';
-export { makeFetch } from '@aztec/foundation/json-rpc/client';
-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 { type FieldsOf } from '@aztec/foundation/types';
-export { fileURLToPath } from '@aztec/foundation/url';
-
-// 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/abi.js';
-export * from './api/account.js';
-export * from './api/addresses.js';
-export * from './api/cheat_codes.js';
-export * from './api/ethereum/index.js';
-export * from './api/fee.js';
-export * from './api/log.js';
-// Granular export, even if not in the api folder
-export * from './contract/index.js';
-export * from './utils/index.js';

package/src/rpc_clients/index.ts

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

package/src/rpc_clients/node/index.ts

@@ -1,77 +0,0 @@
-import { jsonStringify } from '@aztec/foundation/json-rpc';
-import { type Logger, createLogger } from '@aztec/foundation/log';
-import { NoRetryError, makeBackoff, retry } from '@aztec/foundation/retry';
-import type { PXE } from '@aztec/stdlib/interfaces/client';
-import type { ComponentsVersions } from '@aztec/stdlib/versioning';
-
-import { Axios, type AxiosError } from 'axios';
-import { inspect } from 'util';
-
-import { createPXEClient } from '../pxe_client.js';
-
-/**
- * A fetch implementation using axios.
- * @param host - The URL of the host.
- * @param rpcMethod - The RPC method to call.
- * @param body - The body of the request.
- * @param useApiEndpoints - Whether to use the API endpoints or inject the method in the body.
- * @returns The response data.
- */
-async function axiosFetch(host: string, rpcMethod: string, body: any, useApiEndpoints: boolean) {
-  const request = new Axios({
-    headers: { 'content-type': 'application/json' },
-    transformRequest: [(data: any) => jsonStringify(data)],
-    transformResponse: [(data: any) => JSON.parse(data)],
-  });
-  const [url, content] = useApiEndpoints ? [`${host}/${rpcMethod}`, body] : [host, { ...body, method: rpcMethod }];
-  const resp = await request.post(url, content).catch((error: AxiosError) => {
-    if (error.response) {
-      return error.response;
-    }
-    const errorMessage = `Error fetching from host ${host} with method ${rpcMethod}: ${inspect(error)}`;
-    throw new Error(errorMessage);
-  });
-
-  const isOK = resp.status >= 200 && resp.status < 300;
-  if (isOK) {
-    const headers = {
-      get: (header: string) =>
-        typeof resp.headers.get === 'function' ? resp.headers.get(header)?.toString() : undefined,
-    };
-    return { response: resp.data, headers };
-  } else {
-    const errorMessage = `Error ${resp.status} from json-rpc server ${host} on ${rpcMethod}: ${resp.data.error.message}`;
-    if (resp.status >= 400 && resp.status < 500) {
-      throw new NoRetryError(errorMessage);
-    } else {
-      throw new Error(errorMessage);
-    }
-  }
-}
-
-/**
- * Creates a PXE client with a given set of retries on non-server errors.
- * Checks that PXE matches the expected version, and warns if not.
- * @param rpcUrl - URL of the RPC server wrapping the PXE.
- * @param _logger - Debug logger to warn version incompatibilities.
- * @returns A PXE client.
- */
-export function createCompatibleClient(
-  rpcUrl: string,
-  logger: Logger = createLogger('aztecjs:pxe_client'),
-  versions: Partial<ComponentsVersions> = {},
-): Promise<PXE> {
-  // Use axios due to timeout issues with fetch when proving TXs.
-  const fetch = async (host: string, rpcMethod: string, body: any, useApiEndpoints: boolean) => {
-    return await retry(
-      () => axiosFetch(host, rpcMethod, body, useApiEndpoints),
-      `JsonRpcClient request ${rpcMethod} to ${host}`,
-      makeBackoff([1, 2, 3]),
-      logger,
-      false,
-    );
-  };
-  const pxe = createPXEClient(rpcUrl, versions, fetch);
-
-  return Promise.resolve(pxe);
-}

package/src/rpc_clients/pxe_client.ts

@@ -1,25 +0,0 @@
-import { createSafeJsonRpcClient, makeFetch } from '@aztec/foundation/json-rpc/client';
-import { protocolContractTreeRoot } from '@aztec/protocol-contracts';
-import { type PXE, PXESchema } from '@aztec/stdlib/interfaces/client';
-import { type ComponentsVersions, getVersioningResponseHandler } from '@aztec/stdlib/versioning';
-
-/**
- * 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 function createPXEClient(
-  url: string,
-  versions: Partial<ComponentsVersions> = {},
-  fetch = makeFetch([1, 2, 3], false),
-): PXE {
-  return createSafeJsonRpcClient<PXE>(url, PXESchema, {
-    namespaceMethods: 'pxe',
-    fetch,
-    onResponse: getVersioningResponseHandler({
-      l2ProtocolContractsTreeRoot: protocolContractTreeRoot.toString(),
-      ...versions,
-    }),
-  });
-}

package/src/utils/aztec_cheatcodes.ts

@@ -1,77 +0,0 @@
-import { Fr } from '@aztec/foundation/fields';
-import { createLogger } from '@aztec/foundation/log';
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-import { deriveStorageSlotInMap } from '@aztec/stdlib/hash';
-import type { PXE } from '@aztec/stdlib/interfaces/client';
-import type { Note } from '@aztec/stdlib/note';
-
-/**
- * A class that provides utility functions for interacting with the aztec chain.
- */
-export class AztecCheatCodes {
-  constructor(
-    /**
-     * The PXE Service to use for interacting with the chain
-     */
-    public pxe: PXE,
-    /**
-     * The logger to use for the aztec cheatcodes
-     */
-    public logger = createLogger('aztecjs:cheat_codes'),
-  ) {}
-
-  /**
-   * Computes the slot value for a given map and key.
-   * @param mapSlot - The slot of the map (specified in Aztec.nr contract)
-   * @param key - The key to lookup in the map
-   * @returns The storage slot of the value in the map
-   */
-  public computeSlotInMap(mapSlot: Fr | bigint, key: Fr | bigint | AztecAddress): Promise<Fr> {
-    const keyFr = typeof key === 'bigint' ? new Fr(key) : key.toField();
-    return deriveStorageSlotInMap(mapSlot, keyFr);
-  }
-
-  /**
-   * Get the current blocknumber
-   * @returns The current block number
-   */
-  public async blockNumber(): Promise<number> {
-    return await this.pxe.getBlockNumber();
-  }
-
-  /**
-   * Get the current timestamp
-   * @returns The current timestamp
-   */
-  public async timestamp(): Promise<number> {
-    const res = await this.pxe.getBlock(await this.blockNumber());
-    return res?.header.globalVariables.timestamp.toNumber() ?? 0;
-  }
-
-  /**
-   * Loads the value stored at the given slot in the public storage of the given contract.
-   * @param who - The address of the contract
-   * @param slot - The storage slot to lookup
-   * @returns The value stored at the given slot
-   */
-  public async loadPublic(who: AztecAddress, slot: Fr | bigint): Promise<Fr> {
-    const storageValue = await this.pxe.getPublicStorageAt(who, new Fr(slot));
-    return storageValue;
-  }
-
-  /**
-   * Loads the value stored at the given slot in the private storage of the given contract.
-   * @param contract - The address of the contract
-   * @param owner - The owner for whom the notes are encrypted
-   * @param slot - The storage slot to lookup
-   * @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),
-    });
-    return extendedNotes.map(extendedNote => extendedNote.note);
-  }
-}

package/src/utils/index.ts

@@ -1,21 +0,0 @@
-export { generatePublicKey } from './pub_key.js';
-export {
-  type AztecAddressLike,
-  type EthAddressLike,
-  type EventSelectorLike,
-  type FieldLike,
-  type FunctionSelectorLike,
-  type U128Like,
-  type WrappedFieldLike,
-} from './abi_types.js';
-export {
-  computeAuthWitMessageHash,
-  computeInnerAuthWitHash,
-  computeInnerAuthWitHashFromAction,
-  type IntentAction,
-  type IntentInnerHash,
-} from './authwit.js';
-export { waitForPXE } from './pxe.js';
-export { waitForNode, createAztecNodeClient, type AztecNode } from './node.js';
-export { getFeeJuiceBalance } from './fee_juice.js';
-export { readFieldCompressedString } from './field_compressed_string.js';

package/src/utils/pxe.ts

@@ -1,17 +0,0 @@
-import type { Logger } from '@aztec/foundation/log';
-import { retryUntil } from '@aztec/foundation/retry';
-import type { PXE } from '@aztec/stdlib/interfaces/client';
-
-export const waitForPXE = async (pxe: PXE, logger?: Logger) => {
-  await retryUntil(async () => {
-    try {
-      logger?.verbose('Attempting to contact PXE...');
-      await pxe.getNodeInfo();
-      logger?.verbose('Contacted PXE');
-      return true;
-    } catch (error) {
-      logger?.verbose('Failed to contact PXE');
-    }
-    return undefined;
-  }, 'RPC Get Node Info');
-};