@aztec/aztec.js 0.16.3 → 0.16.5

package/src/contract_deployer/deploy_method.ts

@@ -1,139 +0,0 @@
-import {
-  CompleteAddress,
-  ContractDeploymentData,
-  FunctionData,
-  TxContext,
-  getContractDeploymentInfo,
-} from '@aztec/circuits.js';
-import { ContractArtifact, FunctionArtifact, encodeArguments } from '@aztec/foundation/abi';
-import { EthAddress } from '@aztec/foundation/eth-address';
-import { Fr } from '@aztec/foundation/fields';
-import { PXE, PackedArguments, PublicKey, Tx, TxExecutionRequest } from '@aztec/types';
-
-import { BaseContractInteraction } from '../contract/base_contract_interaction.js';
-import { Contract, ContractBase, SendMethodOptions } from '../contract/index.js';
-import { DeploySentTx } from './deploy_sent_tx.js';
-
-/**
- * Options for deploying a contract on the Aztec network.
- * Allows specifying a portal contract, contract address salt, and additional send method options.
- */
-export type DeployOptions = {
-  /**
-   * The Ethereum address of the Portal contract.
-   */
-  portalContract?: EthAddress;
-  /**
-   * An optional salt value used to deterministically calculate the contract address.
-   */
-  contractAddressSalt?: Fr;
-} & SendMethodOptions;
-
-/**
- * Creates a TxRequest from a contract ABI, for contract deployment.
- * Extends the ContractFunctionInteraction class.
- */
-export class DeployMethod<TContract extends ContractBase = Contract> extends BaseContractInteraction {
-  /** The complete address of the contract. */
-  public completeAddress?: CompleteAddress = undefined;
-
-  /** Constructor function to call. */
-  private constructorArtifact: FunctionArtifact;
-
-  constructor(
-    private publicKey: PublicKey,
-    protected pxe: PXE,
-    private artifact: ContractArtifact,
-    private args: any[] = [],
-  ) {
-    super(pxe);
-    const constructorArtifact = artifact.functions.find(f => f.name === 'constructor');
-    if (!constructorArtifact) {
-      throw new Error('Cannot find constructor in the artifact.');
-    }
-    this.constructorArtifact = constructorArtifact;
-  }
-
-  /**
-   * Create a contract deployment transaction, given the deployment options.
-   * This function internally calls `request()` and `sign()` methods to prepare
-   * the transaction for deployment. The resulting signed transaction can be
-   * later sent using the `send()` method.
-   *
-   * @param options - An object containing optional deployment settings, including portalContract, contractAddressSalt, and from.
-   * @returns A Promise resolving to an object containing the signed transaction data and other relevant information.
-   */
-  public async create(options: DeployOptions = {}) {
-    const portalContract = options.portalContract ?? EthAddress.ZERO;
-    const contractAddressSalt = options.contractAddressSalt ?? Fr.random();
-
-    const { chainId, protocolVersion } = await this.pxe.getNodeInfo();
-
-    const { completeAddress, constructorHash, functionTreeRoot } = getContractDeploymentInfo(
-      this.artifact,
-      this.args,
-      contractAddressSalt,
-      this.publicKey,
-    );
-
-    const contractDeploymentData = new ContractDeploymentData(
-      this.publicKey,
-      constructorHash,
-      functionTreeRoot,
-      contractAddressSalt,
-      portalContract,
-    );
-
-    const txContext = new TxContext(
-      false,
-      false,
-      true,
-      contractDeploymentData,
-      new Fr(chainId),
-      new Fr(protocolVersion),
-    );
-    const args = encodeArguments(this.constructorArtifact, this.args);
-    const functionData = FunctionData.fromAbi(this.constructorArtifact);
-    const execution = { args, functionData, to: completeAddress.address };
-    const packedArguments = PackedArguments.fromArgs(execution.args);
-
-    const txRequest = TxExecutionRequest.from({
-      origin: execution.to,
-      functionData: execution.functionData,
-      argsHash: packedArguments.hash,
-      txContext,
-      packedArguments: [packedArguments],
-      authWitnesses: [],
-    });
-
-    this.txRequest = txRequest;
-    this.completeAddress = completeAddress;
-
-    // TODO: Should we add the contracts to the DB here, or once the tx has been sent or mined?
-    await this.pxe.addContracts([{ artifact: this.artifact, completeAddress, portalContract }]);
-
-    return this.txRequest;
-  }
-
-  /**
-   * Send the contract deployment transaction using the provided options.
-   * This function extends the 'send' method from the ContractFunctionInteraction class,
-   * allowing us to send a transaction specifically for contract deployment.
-   *
-   * @param options - An object containing various deployment options such as portalContract, contractAddressSalt, and from.
-   * @returns A SentTx object that returns the receipt and the deployed contract instance.
-   */
-  public send(options: DeployOptions = {}): DeploySentTx<TContract> {
-    const txHashPromise = super.send(options).getTxHash();
-    return new DeploySentTx(this.artifact, this.pxe, txHashPromise, this.completeAddress);
-  }
-
-  /**
-   * Simulate the request.
-   * @param options - Deployment options.
-   * @returns The simulated tx.
-   */
-  public simulate(options: DeployOptions): Promise<Tx> {
-    return super.simulate(options);
-  }
-}

package/src/contract_deployer/deploy_sent_tx.ts

@@ -1,71 +0,0 @@
-import { AztecAddress, CompleteAddress, FieldsOf } from '@aztec/circuits.js';
-import { ContractArtifact } from '@aztec/foundation/abi';
-import { PXE, TxHash, TxReceipt } from '@aztec/types';
-
-import { Contract } from '../contract/contract.js';
-import { ContractBase } from '../contract/contract_base.js';
-import { SentTx, WaitOpts } from '../contract/sent_tx.js';
-import { Wallet } from '../wallet/index.js';
-
-/** Options related to waiting for a deployment tx. */
-export type DeployedWaitOpts = WaitOpts & {
-  /** Wallet to use for creating a contract instance. Uses the one set in the deployer constructor if not set. */
-  wallet?: Wallet;
-};
-
-/** Extends a transaction receipt with a contract instance that represents the newly deployed contract. */
-export type DeployTxReceipt<TContract extends ContractBase = Contract> = FieldsOf<TxReceipt> & {
-  /** Instance of the newly deployed contract. */
-  contract: TContract;
-};
-
-/**
- * A contract deployment transaction sent to the network, extending SentTx with methods to create a contract instance.
- */
-export class DeploySentTx<TContract extends Contract = Contract> extends SentTx {
-  constructor(
-    private artifact: ContractArtifact,
-    wallet: PXE | Wallet,
-    txHashPromise: Promise<TxHash>,
-
-    /**
-     * The complete address of the deployed contract
-     */
-    public completeContractAddress?: CompleteAddress,
-  ) {
-    super(wallet, txHashPromise);
-  }
-
-  /**
-   * Awaits for the tx to be mined and returns the contract instance. Throws if tx is not mined.
-   * @param opts - Options for configuring the waiting for the tx to be mined.
-   * @returns The deployed contract instance.
-   */
-  public async deployed(opts?: DeployedWaitOpts): Promise<TContract> {
-    const receipt = await this.wait(opts);
-    return receipt.contract;
-  }
-
-  /**
-   * Awaits for the tx to be mined and returns the receipt along with a contract instance. Throws if tx is not mined.
-   * @param opts - Options for configuring the waiting for the tx to be mined.
-   * @returns The transaction receipt with the deployed contract instance.
-   */
-  public async wait(opts?: DeployedWaitOpts): Promise<DeployTxReceipt<TContract>> {
-    const receipt = await super.wait(opts);
-    const contract = await this.getContractInstance(opts?.wallet, receipt.contractAddress);
-    return { ...receipt, contract };
-  }
-
-  protected getContractInstance(wallet?: Wallet, address?: AztecAddress): Promise<TContract> {
-    const isWallet = (pxe: PXE | Wallet): pxe is Wallet => !!(pxe as Wallet).createTxExecutionRequest;
-    const contractWallet = wallet ?? (isWallet(this.pxe) && this.pxe);
-    if (!contractWallet) {
-      throw new Error(`A wallet is required for creating a contract instance`);
-    }
-    if (!address) {
-      throw new Error(`Contract address is missing from transaction receipt`);
-    }
-    return Contract.at(address, this.artifact, contractWallet) as Promise<TContract>;
-  }
-}

package/src/contract_deployer/index.ts

@@ -1,3 +0,0 @@
-export * from './contract_deployer.js';
-export * from './deploy_sent_tx.js';
-export * from './deploy_method.js';

package/src/index.ts

@@ -1,137 +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/aztec_address';
- *   import { EthAddress } from '@aztec/aztec.js/eth_address';
- * ```
- */
-export {
-  WaitOpts,
-  ContractFunctionInteraction,
-  Contract,
-  ContractBase,
-  ContractMethod,
-  SentTx,
-  BatchCall,
-} from './contract/index.js';
-
-export { ContractDeployer, DeployMethod, DeploySentTx } from './contract_deployer/index.js';
-
-export {
-  generatePublicKey,
-  FieldLike,
-  EthAddressLike,
-  computeMessageSecretHash,
-  CheatCodes,
-  AztecAddressLike,
-  isContractDeployed,
-  EthCheatCodes,
-  computeAuthWitMessageHash,
-} from './utils/index.js';
-
-export { createPXEClient } from './pxe_client.js';
-
-export {
-  CompleteAddress,
-  getSchnorrAccount,
-  AccountContract,
-  AccountManager,
-  getUnsafeSchnorrAccount,
-  EcdsaAccountContract,
-  createAccounts,
-  SchnorrAccountContract,
-  SingleKeyAccountContract,
-  createAccount,
-  AuthWitnessProvider,
-  BaseAccountContract,
-} from './account/index.js';
-
-export { waitForSandbox, getSandboxAccountsWallets, deployInitialSandboxAccounts } from './sandbox/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,
-  Point,
-  Fr,
-  Fq,
-  FunctionSelector,
-  GlobalVariables,
-  GrumpkinScalar,
-  getContractDeploymentInfo,
-} from '@aztec/circuits.js';
-
-export { Grumpkin, Schnorr } from '@aztec/circuits.js/barretenberg';
-
-export {
-  AuthWitness,
-  AztecNode,
-  ContractData,
-  DeployedContract,
-  ExtendedContractData,
-  ExtendedNote,
-  FunctionCall,
-  INITIAL_L2_BLOCK_NUM,
-  GrumpkinPrivateKey,
-  L2Actor,
-  L2Block,
-  L2BlockL2Logs,
-  LogFilter,
-  LogId,
-  LogType,
-  MerkleTreeId,
-  NodeInfo,
-  Note,
-  PackedArguments,
-  PartialAddress,
-  PublicKey,
-  PXE,
-  SyncStatus,
-  Tx,
-  TxExecutionRequest,
-  TxHash,
-  TxReceipt,
-  TxStatus,
-  UnencryptedL2Log,
-  emptyFunctionCall,
-  createAztecNodeClient,
-  merkleTreeIds,
-  mockTx,
-} from '@aztec/types';
-
-export { ContractArtifact, FunctionArtifact } from '@aztec/foundation/abi';
-
-// 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 { DebugLogger, createDebugLogger, onLog } from '@aztec/foundation/log';
-export { fileURLToPath } from '@aztec/foundation/url';
-export { sleep } from '@aztec/foundation/sleep';
-export { elapsed } from '@aztec/foundation/timer';
-export { retry, retryUntil } from '@aztec/foundation/retry';
-export { sha256, init } from '@aztec/foundation/crypto';
-export { to2Fields, toBigInt } from '@aztec/foundation/serialize';
-export { toBigIntBE } from '@aztec/foundation/bigint-buffer';
-export { makeFetch } from '@aztec/foundation/json-rpc/client';
-
-export {
-  deployL1Contract,
-  deployL1Contracts,
-  DeployL1Contracts,
-  L1ContractArtifactsForDeployment,
-} from '@aztec/ethereum';

package/src/pxe_client.ts

@@ -1,63 +0,0 @@
-import {
-  AztecAddress,
-  CompleteAddress,
-  EthAddress,
-  Fr,
-  FunctionSelector,
-  GrumpkinScalar,
-  Point,
-} from '@aztec/circuits.js';
-import { createJsonRpcClient, makeFetch } from '@aztec/foundation/json-rpc/client';
-import {
-  AuthWitness,
-  ContractData,
-  ExtendedContractData,
-  ExtendedNote,
-  ExtendedUnencryptedL2Log,
-  L2Block,
-  L2BlockL2Logs,
-  L2Tx,
-  LogId,
-  Note,
-  PXE,
-  Tx,
-  TxExecutionRequest,
-  TxHash,
-  TxReceipt,
-} from '@aztec/types';
-
-export { 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,
-    fetch,
-  );

package/src/sandbox/index.ts

@@ -1,85 +0,0 @@
-import { Fr, GrumpkinScalar } from '@aztec/foundation/fields';
-import { sleep } from '@aztec/foundation/sleep';
-
-import zip from 'lodash.zip';
-
-import SchnorrAccountContractArtifact from '../artifacts/schnorr_account_contract.json' assert { type: 'json' };
-import { AccountWalletWithPrivateKey, PXE, createPXEClient, getSchnorrAccount } from '../index.js';
-
-export const INITIAL_SANDBOX_ENCRYPTION_KEYS = [
-  GrumpkinScalar.fromString('2153536ff6628eee01cf4024889ff977a18d9fa61d0e414422f7681cf085c281'),
-  GrumpkinScalar.fromString('aebd1b4be76efa44f5ee655c20bf9ea60f7ae44b9a7fd1fd9f189c7a0b0cdae'),
-  GrumpkinScalar.fromString('0f6addf0da06c33293df974a565b03d1ab096090d907d98055a8b7f4954e120c'),
-];
-
-export const INITIAL_SANDBOX_SIGNING_KEYS = INITIAL_SANDBOX_ENCRYPTION_KEYS;
-
-export const INITIAL_SANDBOX_SALTS = [Fr.ZERO, Fr.ZERO, Fr.ZERO];
-
-export const INITIAL_SANDBOX_ACCOUNT_CONTRACT_ABI = SchnorrAccountContractArtifact;
-
-export const { PXE_URL = 'http://localhost:8080' } = process.env;
-
-/**
- * Gets a collection of wallets for the Aztec accounts that are initially stored in the sandbox.
- * @param pxe - PXE instance.
- * @returns A set of AccountWallet implementations for each of the initial accounts.
- */
-export function getSandboxAccountsWallets(pxe: PXE): Promise<AccountWalletWithPrivateKey[]> {
-  return Promise.all(
-    zip(INITIAL_SANDBOX_ENCRYPTION_KEYS, INITIAL_SANDBOX_SIGNING_KEYS, INITIAL_SANDBOX_SALTS).map(
-      ([encryptionKey, signingKey, salt]) => getSchnorrAccount(pxe, encryptionKey!, signingKey!, salt).getWallet(),
-    ),
-  );
-}
-
-/**
- * Deploys the initial set of schnorr signature accounts to the sandbox
- * @param pxe - PXE instance.
- * @returns The set of deployed Account objects and associated private encryption keys
- */
-export async function deployInitialSandboxAccounts(pxe: PXE) {
-  const accounts = INITIAL_SANDBOX_ENCRYPTION_KEYS.map((privateKey, i) => {
-    const account = getSchnorrAccount(pxe, privateKey, INITIAL_SANDBOX_SIGNING_KEYS[i], INITIAL_SANDBOX_SALTS[i]);
-    return {
-      account,
-      privateKey,
-    };
-  });
-  // Attempt to get as much parallelism as possible
-  const deployMethods = await Promise.all(
-    accounts.map(async x => {
-      const deployMethod = await x.account.getDeployMethod();
-      await deployMethod.create({ contractAddressSalt: x.account.salt });
-      await deployMethod.simulate({});
-      return deployMethod;
-    }),
-  );
-  // Send tx together to try and get them in the same rollup
-  const sentTxs = deployMethods.map(dm => {
-    return dm.send();
-  });
-  await Promise.all(
-    sentTxs.map(async (tx, i) => {
-      const wallet = await accounts[i].account.getWallet();
-      return tx.wait({ wallet });
-    }),
-  );
-  return accounts;
-}
-
-/**
- * Function to wait until the sandbox becomes ready for use.
- * @param pxe - The pxe client connected to the sandbox.
- */
-export async function waitForSandbox(pxe?: PXE) {
-  pxe = pxe ?? createPXEClient(PXE_URL);
-  while (true) {
-    try {
-      await pxe.getNodeInfo();
-      break;
-    } catch (err) {
-      await sleep(1000);
-    }
-  }
-}

package/src/utils/abi_types.ts

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

package/src/utils/authwit.ts

@@ -1,24 +0,0 @@
-import { AztecAddress, GeneratorIndex } from '@aztec/circuits.js';
-import { pedersenHash } from '@aztec/foundation/crypto';
-import { FunctionCall, PackedArguments } from '@aztec/types';
-
-// 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