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

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');
-};

package/src/wallet/account_wallet.ts

@@ -1,242 +0,0 @@
-import { Fr } from '@aztec/foundation/fields';
-import { ProtocolContractAddress } from '@aztec/protocol-contracts';
-import { type ABIParameterVisibility, type FunctionAbi, FunctionType } from '@aztec/stdlib/abi';
-import type { AuthWitness } from '@aztec/stdlib/auth-witness';
-import type { AztecAddress } from '@aztec/stdlib/aztec-address';
-import type { PXE } from '@aztec/stdlib/interfaces/client';
-import type { TxExecutionRequest } from '@aztec/stdlib/tx';
-
-import type { AccountInterface } from '../account/interface.js';
-import { ContractFunctionInteraction } from '../contract/contract_function_interaction.js';
-import type { ExecutionRequestInit } from '../entrypoint/entrypoint.js';
-import {
-  type IntentAction,
-  type IntentInnerHash,
-  computeAuthWitMessageHash,
-  computeInnerAuthWitHashFromAction,
-} from '../utils/authwit.js';
-import { BaseWallet } from './base_wallet.js';
-
-/**
- * A wallet implementation that forwards authentication requests to a provided account.
- */
-export class AccountWallet extends BaseWallet {
-  constructor(pxe: PXE, protected account: AccountInterface) {
-    super(pxe, [account.getAddress()]);
-  }
-
-  createTxExecutionRequest(exec: ExecutionRequestInit): Promise<TxExecutionRequest> {
-    return this.account.createTxExecutionRequest(exec);
-  }
-
-  getChainId(): Fr {
-    return this.account.getChainId();
-  }
-
-  getVersion(): Fr {
-    return this.account.getVersion();
-  }
-
-  override isL1ToL2MessageSynced(l1ToL2Message: Fr): Promise<boolean> {
-    return this.pxe.isL1ToL2MessageSynced(l1ToL2Message);
-  }
-
-  /**
-   * Computes an authentication witness from either a message hash or an intent.
-   *
-   * If a message hash is provided, it will create a witness for the hash directly.
-   * Otherwise, it will compute the message hash using the intent, along with the
-   * chain id and the version values provided by the wallet.
-   *
-   * @param messageHashOrIntent - The message hash of the intent to approve
-   * @returns The authentication witness
-   */
-  async createAuthWit(messageHashOrIntent: Fr | Buffer | IntentAction | IntentInnerHash): Promise<AuthWitness> {
-    let messageHash: Fr;
-    if (Buffer.isBuffer(messageHashOrIntent)) {
-      messageHash = Fr.fromBuffer(messageHashOrIntent);
-    } else if (messageHashOrIntent instanceof Fr) {
-      messageHash = messageHashOrIntent;
-    } else {
-      messageHash = await 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 or revoked in this account.
-   *
-   * Public calls can then consume this authorization.
-   *
-   * @param messageHashOrIntent - The message hash or intent to authorize/revoke
-   * @param authorized - True to authorize, false to revoke authorization.
-   * @returns - A function interaction.
-   */
-  public async setPublicAuthWit(
-    messageHashOrIntent: Fr | Buffer | IntentInnerHash | IntentAction,
-    authorized: boolean,
-  ): Promise<ContractFunctionInteraction> {
-    let messageHash: Fr;
-    if (Buffer.isBuffer(messageHashOrIntent)) {
-      messageHash = Fr.fromBuffer(messageHashOrIntent);
-    } else if (messageHashOrIntent instanceof Fr) {
-      messageHash = messageHashOrIntent;
-    } else {
-      messageHash = await this.getMessageHash(messageHashOrIntent);
-    }
-
-    return new ContractFunctionInteraction(this, ProtocolContractAddress.AuthRegistry, this.getSetAuthorizedAbi(), [
-      messageHash,
-      authorized,
-    ]);
-  }
-
-  private async getInnerHashAndConsumer(intent: IntentInnerHash | IntentAction): Promise<{
-    /** The inner hash */
-    innerHash: Fr;
-    /** The consumer of the authwit */
-    consumer: AztecAddress;
-  }> {
-    if ('caller' in intent && 'action' in intent) {
-      const action =
-        intent.action instanceof ContractFunctionInteraction ? await intent.action.request() : intent.action;
-      return {
-        innerHash: await computeInnerAuthWitHashFromAction(intent.caller, action),
-        consumer: action.to,
-      };
-    } else if (Buffer.isBuffer(intent.innerHash)) {
-      return { innerHash: Fr.fromBuffer(intent.innerHash), consumer: intent.consumer };
-    }
-    return { innerHash: intent.innerHash, consumer: intent.consumer };
-  }
-
-  /**
-   * Returns the message hash for the given intent
-   *
-   * @param intent - A tuple of (consumer and inner hash) or (caller and action)
-   * @returns The message hash
-   */
-  private getMessageHash(intent: IntentInnerHash | IntentAction): Promise<Fr> {
-    const chainId = this.getChainId();
-    const version = this.getVersion();
-    return computeAuthWitMessageHash(intent, { chainId, version });
-  }
-
-  /**
-   * Lookup the validity of an authwit in private and public contexts.
-   *
-   * Uses the chain id and version of the wallet.
-   *
-   * @param onBehalfOf - The address of the "approver"
-   * @param intent - The consumer and inner hash or the caller and action to lookup
-   *
-   * @returns - A struct containing the validity of the authwit in private and public contexts.
-   */
-  async lookupValidity(
-    onBehalfOf: AztecAddress,
-    intent: IntentInnerHash | IntentAction,
-  ): Promise<{
-    /** boolean flag indicating if the authwit is valid in private context */
-    isValidInPrivate: boolean;
-    /** boolean flag indicating if the authwit is valid in public context */
-    isValidInPublic: boolean;
-  }> {
-    const { innerHash, consumer } = await this.getInnerHashAndConsumer(intent);
-
-    const messageHash = await this.getMessageHash(intent);
-    const results = { isValidInPrivate: false, isValidInPublic: false };
-
-    // Check private
-    const witness = await this.getAuthWitness(messageHash);
-    if (witness !== undefined) {
-      results.isValidInPrivate = (await new ContractFunctionInteraction(this, onBehalfOf, this.getLookupValidityAbi(), [
-        consumer,
-        innerHash,
-      ]).simulate()) as boolean;
-    }
-
-    // check public
-    results.isValidInPublic = (await new ContractFunctionInteraction(
-      this,
-      ProtocolContractAddress.AuthRegistry,
-      this.getIsConsumableAbi(),
-      [onBehalfOf, messageHash],
-    ).simulate()) as boolean;
-
-    return results;
-  }
-
-  /** Returns the complete address of the account that implements this wallet. */
-  public getCompleteAddress() {
-    return this.account.getCompleteAddress();
-  }
-
-  /** Returns the address of the account that implements this wallet. */
-  public override getAddress() {
-    return this.getCompleteAddress().address;
-  }
-
-  private getSetAuthorizedAbi(): FunctionAbi {
-    return {
-      name: 'set_authorized',
-      isInitializer: false,
-      functionType: FunctionType.PUBLIC,
-      isInternal: true,
-      isStatic: false,
-      parameters: [
-        {
-          name: 'message_hash',
-          type: { kind: 'field' },
-          visibility: 'private' as ABIParameterVisibility,
-        },
-        {
-          name: 'authorize',
-          type: { kind: 'boolean' },
-          visibility: 'private' as ABIParameterVisibility,
-        },
-      ],
-      returnTypes: [],
-      errorTypes: {},
-    };
-  }
-
-  private getLookupValidityAbi(): FunctionAbi {
-    return {
-      name: 'lookup_validity',
-      isInitializer: false,
-      functionType: FunctionType.UNCONSTRAINED,
-      isInternal: false,
-      isStatic: false,
-      parameters: [{ name: 'message_hash', type: { kind: 'field' }, visibility: 'private' as ABIParameterVisibility }],
-      returnTypes: [{ kind: 'boolean' }],
-      errorTypes: {},
-    };
-  }
-
-  private getIsConsumableAbi(): FunctionAbi {
-    return {
-      name: 'unconstrained_is_consumable',
-      isInitializer: false,
-      functionType: FunctionType.UNCONSTRAINED,
-      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: 'message_hash', type: { kind: 'field' }, visibility: 'private' as ABIParameterVisibility },
-      ],
-      returnTypes: [{ kind: 'boolean' }],
-      errorTypes: {},
-    };
-  }
-}

package/src/wallet/account_wallet_with_private_key.ts

@@ -1,40 +0,0 @@
-import type { Fr } from '@aztec/foundation/fields';
-import type { PXE } from '@aztec/stdlib/interfaces/client';
-import { computeAddressSecret, deriveMasterIncomingViewingSecretKey } from '@aztec/stdlib/keys';
-
-import type { Salt } from '../account/index.js';
-import type { AccountInterface } from '../account/interface.js';
-import { AccountWallet } from './account_wallet.js';
-
-/**
- * Extends {@link AccountWallet} with the encryption private key. Not required for
- * implementing the wallet interface but useful for testing purposes or exporting
- * an account to another pxe.
- */
-export class AccountWalletWithSecretKey extends AccountWallet {
-  constructor(
-    pxe: PXE,
-    account: AccountInterface,
-    private secretKey: Fr,
-    /** Deployment salt for this account contract. */
-    public readonly salt: Salt,
-  ) {
-    super(pxe, account);
-  }
-
-  /** Returns the encryption private key associated with this account. */
-  public getSecretKey() {
-    return this.secretKey;
-  }
-
-  /** Returns the encryption secret, the secret of the encryption point—the point that others use to encrypt messages to this account
-   * note - this ensures that the address secret always corresponds to an address point with y being positive
-   * dev - this is also referred to as the address secret, which decrypts payloads encrypted to an address point
-   */
-  public async getEncryptionSecret() {
-    return computeAddressSecret(
-      await this.getCompleteAddress().getPreaddress(),
-      deriveMasterIncomingViewingSecretKey(this.getSecretKey()),
-    );
-  }
-}