@aztec/aztec.js 0.1.0-alpha36 → 0.1.0-alpha38

package/src/contract/contract.ts

@@ -2,6 +2,7 @@ import { ContractAbi } from '@aztec/foundation/abi';
 import { AztecAddress } from '@aztec/foundation/aztec-address';
 
 import { Wallet } from '../aztec_rpc_client/wallet.js';
+import { isContractDeployed } from '../index.js';
 import { ContractBase } from './contract_base.js';
 
 /**
@@ -19,8 +20,8 @@ export class Contract extends ContractBase {
    * @param wallet - The wallet to use when interacting with the contract.
    * @returns A promise that resolves to a new Contract instance.
    */
-  public static async create(address: AztecAddress, abi: ContractAbi, wallet: Wallet): Promise<Contract> {
-    if (!(await wallet.isContractDeployed(address))) {
+  public static async at(address: AztecAddress, abi: ContractAbi, wallet: Wallet): Promise<Contract> {
+    if (!(await isContractDeployed(wallet, address))) {
       throw new Error('Contract ' + address.toString() + ' is not deployed');
     }
     return new Contract(address, abi, wallet);

package/src/contract_deployer/deploy_method.ts

@@ -1,7 +1,7 @@
 import {
   ContractDeploymentData,
   FunctionData,
-  PartialContractAddress,
+  PartialAddress,
   TxContext,
   getContractDeploymentInfo,
 } from '@aztec/circuits.js';
@@ -36,7 +36,7 @@ export interface DeployOptions extends SendMethodOptions {
  */
 export class DeployMethod<TContract extends ContractBase = Contract> extends BaseContractInteraction {
   /** The partially computed contract address. Known after creation of the deployment transaction. */
-  public partialContractAddress?: PartialContractAddress = undefined;
+  public partialAddress?: PartialAddress = undefined;
 
   /** The complete contract address. */
   public completeContractAddress?: AztecAddress = undefined;
@@ -66,7 +66,7 @@ export class DeployMethod<TContract extends ContractBase = Contract> extends Bas
 
     const { chainId, version } = await this.rpc.getNodeInfo();
 
-    const { address, constructorHash, functionTreeRoot, partialAddress } = await getContractDeploymentInfo(
+    const { completeAddress, constructorHash, functionTreeRoot } = await getContractDeploymentInfo(
       this.abi,
       this.args,
       contractAddressSalt,
@@ -84,7 +84,7 @@ export class DeployMethod<TContract extends ContractBase = Contract> extends Bas
     const txContext = new TxContext(false, false, true, contractDeploymentData, new Fr(chainId), new Fr(version));
     const args = encodeArguments(this.constructorAbi, this.args);
     const functionData = FunctionData.fromAbi(this.constructorAbi);
-    const execution = { args, functionData, to: address };
+    const execution = { args, functionData, to: completeAddress.address };
     const packedArguments = await PackedArguments.fromArgs(execution.args);
 
     const txRequest = TxExecutionRequest.from({
@@ -96,11 +96,11 @@ export class DeployMethod<TContract extends ContractBase = Contract> extends Bas
     });
 
     this.txRequest = txRequest;
-    this.partialContractAddress = partialAddress;
-    this.completeContractAddress = address;
+    this.partialAddress = completeAddress.partialAddress;
+    this.completeContractAddress = completeAddress.address;
 
     // TODO: Should we add the contracts to the DB here, or once the tx has been sent or mined?
-    await this.rpc.addContracts([{ abi: this.abi, address, portalContract }]);
+    await this.rpc.addContracts([{ abi: this.abi, address: completeAddress.address, portalContract }]);
 
     return this.txRequest;
   }

package/src/contract_deployer/deploy_sent_tx.ts

@@ -50,6 +50,6 @@ export class DeploySentTx<TContract extends ContractBase = Contract> extends Sen
     const contractWallet = wallet ?? (isWallet(this.arc) && this.arc);
     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.create(address, this.abi, contractWallet) as Promise<TContract>;
+    return Contract.at(address, this.abi, contractWallet) as Promise<TContract>;
   }
 }

package/src/index.ts

@@ -4,13 +4,14 @@ export * from './utils/index.js';
 export * from './aztec_rpc_client/index.js';
 export * from './account/index.js';
 export * from './contract_deployer/deploy_method.js';
+export * from './sandbox/index.js';
 
 export { AztecAddress, EthAddress, Point, Fr } from '@aztec/circuits.js';
 export {
   AztecRPC,
   ContractData,
   ContractDeploymentTx,
-  ContractPublicData,
+  ContractDataAndBytecode,
   DeployedContract,
   FunctionCall,
   L2BlockL2Logs,
@@ -27,3 +28,4 @@ export {
 } from '@aztec/types';
 
 export { createDebugLogger } from '@aztec/foundation/log';
+export { sleep } from '@aztec/foundation/sleep';

package/src/sandbox/index.ts

@@ -0,0 +1,83 @@
+import { Fr, PrivateKey } from '@aztec/circuits.js';
+import { ContractAbi } from '@aztec/foundation/abi';
+import { sleep } from '@aztec/foundation/sleep';
+
+import SchnorrAccountContractAbi from '../abis/schnorr_account_contract.json' assert { type: 'json' };
+import { AztecRPC, getAccountWallets, getSchnorrAccount } from '../index.js';
+
+export const INITIAL_SANDBOX_ENCRYPTION_KEYS = [
+  new PrivateKey(Buffer.from('b2803ec899f76f6b2ac011480d24028f1a29587f8a3a92f7ee9d48d8c085c284', 'hex')),
+  new PrivateKey(Buffer.from('6bb46e9a80da2ff7bfff71c2c50eaaa4b15f7ed5ad1ade4261b574ef80b0cdb0', 'hex')),
+  new PrivateKey(Buffer.from('0f6addf0da06c33293df974a565b03d1ab096090d907d98055a8b7f4954e120c', 'hex')),
+];
+
+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 = SchnorrAccountContractAbi;
+
+/**
+ * Gets a wallet for the Aztec accounts that are initially stored in the sandbox.
+ * @param aztecRpc - An instance of the Aztec RPC interface.
+ * @returns An AccountWallet implementation that includes all the accounts found.
+ */
+export async function getSandboxAccountsWallet(aztecRpc: AztecRPC) {
+  return await getAccountWallets(
+    aztecRpc,
+    INITIAL_SANDBOX_ACCOUNT_CONTRACT_ABI as ContractAbi,
+    INITIAL_SANDBOX_ENCRYPTION_KEYS,
+    INITIAL_SANDBOX_SIGNING_KEYS,
+    INITIAL_SANDBOX_SALTS,
+  );
+}
+
+/**
+ * Deploys the initial set of schnorr signature accounts to the sandbox
+ * @param aztecRpc - An instance of the Aztec RPC interface.
+ * @returns The set of deployed Account objects and associated private encryption keys
+ */
+export async function deployInitialSandboxAccounts(aztecRpc: AztecRPC) {
+  const accounts = INITIAL_SANDBOX_ENCRYPTION_KEYS.map((privateKey, i) => {
+    const account = getSchnorrAccount(aztecRpc, 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 rpcServer - The rpc client connected to the sandbox.
+ */
+export const waitForSandbox = async (rpcServer: AztecRPC) => {
+  while (true) {
+    try {
+      await rpcServer.getNodeInfo();
+      break;
+    } catch (err) {
+      await sleep(1000);
+    }
+  }
+};

package/src/utils/abi_types.ts

@@ -0,0 +1,4 @@
+import { Fr } from '@aztec/circuits.js';
+
+/** Any type that can be converted into a field for a contract call. */
+export type FieldLike = Fr | bigint | number | { /** Converts to field */ toField: () => Fr };

package/src/utils/account.ts

@@ -6,7 +6,7 @@ import { AztecRPC, TxStatus } from '@aztec/types';
 
 import { SingleKeyAccountEntrypoint } from '../account/entrypoint/single_key_account_entrypoint.js';
 import { EntrypointWallet, Wallet } from '../aztec_rpc_client/wallet.js';
-import { ContractDeployer, EntrypointCollection, generatePublicKey } from '../index.js';
+import { ContractDeployer, EntrypointCollection, StoredKeyAccountEntrypoint, generatePublicKey } from '../index.js';
 
 /**
  * Creates an Aztec Account.
@@ -27,7 +27,7 @@ export async function createAccounts(
     const privKey = i == 0 && privateKey ? privateKey : PrivateKey.random();
     const publicKey = await generatePublicKey(privKey);
     const deploymentInfo = await getContractDeploymentInfo(accountContractAbi, [], salt, publicKey);
-    await aztecRpcClient.addAccount(privKey, deploymentInfo.address, deploymentInfo.partialAddress);
+    await aztecRpcClient.registerAccount(privKey, deploymentInfo.completeAddress);
     const contractDeployer = new ContractDeployer(accountContractAbi, aztecRpcClient, publicKey);
     const tx = contractDeployer.deploy().send({ contractAddressSalt: salt });
     await tx.isMined({ interval: 0.5 });
@@ -36,15 +36,20 @@ export async function createAccounts(
       throw new Error(`Deployment tx not mined (status is ${receipt.status})`);
     }
     const address = receipt.contractAddress!;
-    if (!address.equals(deploymentInfo.address)) {
+    if (!address.equals(deploymentInfo.completeAddress.address)) {
       throw new Error(
-        `Deployment address does not match for account contract (expected ${deploymentInfo.address.toString()} got ${address.toString()})`,
+        `Deployment address does not match for account contract (expected ${deploymentInfo.completeAddress.address.toString()} got ${address.toString()})`,
       );
     }
     logger(`Created account ${address.toString()} with public key ${publicKey.toString()}`);
     accountImpls.registerAccount(
       address,
-      new SingleKeyAccountEntrypoint(address, deploymentInfo.partialAddress, privKey, await Schnorr.new()),
+      new SingleKeyAccountEntrypoint(
+        address,
+        deploymentInfo.completeAddress.partialAddress,
+        privKey,
+        await Schnorr.new(),
+      ),
     );
   }
   return new EntrypointWallet(aztecRpcClient, accountImpls);
@@ -53,23 +58,38 @@ export async function createAccounts(
 /**
  * Gets the Aztec accounts that are stored in an Aztec RPC instance.
  * @param aztecRpcClient - An instance of the Aztec RPC interface.
- * @param numberOfAccounts - The number of accounts to fetch.
+ * @param accountContractAbi - The abi of the account contract used when the accounts were deployed
+ * @param privateKeys - The encryption private keys used to create the accounts.
+ * @param signingKeys - The signing private keys used to create the accounts.
+ * @param salts - The salt values used to create the accounts.
  * @returns An AccountWallet implementation that includes all the accounts found.
  */
-export async function getAccountWallet(
+export async function getAccountWallets(
   aztecRpcClient: AztecRPC,
   accountContractAbi: ContractAbi,
-  privateKey: PrivateKey,
-  salt: Fr,
+  privateKeys: PrivateKey[],
+  signingKeys: PrivateKey[],
+  salts: Fr[],
 ) {
+  if (privateKeys.length != salts.length || signingKeys.length != privateKeys.length) {
+    throw new Error('Keys and salts must be the same length');
+  }
   const accountCollection = new EntrypointCollection();
-  const publicKey = await generatePublicKey(privateKey);
-  const deploymentInfo = await getContractDeploymentInfo(accountContractAbi, [], salt, publicKey);
-  const address = deploymentInfo.address;
+  for (let i = 0; i < privateKeys.length; i++) {
+    const publicKey = await generatePublicKey(privateKeys[i]);
+    const signingPublicKey = await generatePublicKey(signingKeys[i]);
+    const deploymentInfo = await getContractDeploymentInfo(
+      accountContractAbi,
+      [signingPublicKey.x, signingPublicKey.y],
+      salts[i],
+      publicKey,
+    );
+    const address = deploymentInfo.completeAddress.address;
 
-  accountCollection.registerAccount(
-    address,
-    new SingleKeyAccountEntrypoint(address, deploymentInfo.partialAddress, privateKey, await Schnorr.new()),
-  );
+    accountCollection.registerAccount(
+      address,
+      new StoredKeyAccountEntrypoint(address, signingKeys[i], await Schnorr.new()),
+    );
+  }
   return new EntrypointWallet(aztecRpcClient, accountCollection);
 }

package/src/utils/index.ts

@@ -2,3 +2,5 @@ export * from './secrets.js';
 export * from './account.js';
 export * from './pub_key.js';
 export * from './l1_contracts.js';
+export * from './l2_contracts.js';
+export * from './abi_types.js';

package/src/utils/l2_contracts.ts

@@ -0,0 +1,12 @@
+import { AztecAddress } from '@aztec/foundation/aztec-address';
+import { AztecRPC } from '@aztec/types';
+
+/**
+ * Checks whether a give contract is deployed on the network.
+ * @param aztecRpcClient - The aztec rpc client 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(aztecRpcClient: AztecRPC, contractAddress: AztecAddress): Promise<boolean> {
+  return !!(await aztecRpcClient.getContractData(contractAddress));
+}

package/dest/account/complete_address.d.ts

@@ -1,13 +0,0 @@
-import { AztecAddress, PartialContractAddress, PublicKey } from '@aztec/circuits.js';
-/** Address and preimages associated with an account. */
-export type CompleteAddress = {
-    /** Address of an account. Derived from the partial address and public key. */
-    address: AztecAddress;
-    /** Partial address of the account. Required for deriving the address from the encryption public key. */
-    partialAddress: PartialContractAddress;
-    /** Encryption public key associated with this address. */
-    publicKey: PublicKey;
-};
-/** Returns whether the argument looks like a CompleteAddress. */
-export declare function isCompleteAddress(obj: any): obj is CompleteAddress;
-//# sourceMappingURL=complete_address.d.ts.map

package/dest/account/complete_address.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"complete_address.d.ts","sourceRoot":"","sources":["../../src/account/complete_address.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,sBAAsB,EAAE,SAAS,EAAE,MAAM,oBAAoB,CAAC;AAErF,wDAAwD;AACxD,MAAM,MAAM,eAAe,GAAG;IAC5B,8EAA8E;IAC9E,OAAO,EAAE,YAAY,CAAC;IACtB,wGAAwG;IACxG,cAAc,EAAE,sBAAsB,CAAC;IACvC,0DAA0D;IAC1D,SAAS,EAAE,SAAS,CAAC;CACtB,CAAC;AAEF,iEAAiE;AACjE,wBAAgB,iBAAiB,CAAC,GAAG,EAAE,GAAG,GAAG,GAAG,IAAI,eAAe,CAIlE"}

package/dest/account/complete_address.js

@@ -1,8 +0,0 @@
-/** Returns whether the argument looks like a CompleteAddress. */
-export function isCompleteAddress(obj) {
-    if (!obj)
-        return false;
-    const maybe = obj;
-    return !!maybe.address && !!maybe.partialAddress && !!maybe.publicKey;
-}
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY29tcGxldGVfYWRkcmVzcy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uLy4uL3NyYy9hY2NvdW50L2NvbXBsZXRlX2FkZHJlc3MudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6IkFBWUEsaUVBQWlFO0FBQ2pFLE1BQU0sVUFBVSxpQkFBaUIsQ0FBQyxHQUFRO0lBQ3hDLElBQUksQ0FBQyxHQUFHO1FBQUUsT0FBTyxLQUFLLENBQUM7SUFDdkIsTUFBTSxLQUFLLEdBQUcsR0FBc0IsQ0FBQztJQUNyQyxPQUFPLENBQUMsQ0FBQyxLQUFLLENBQUMsT0FBTyxJQUFJLENBQUMsQ0FBQyxLQUFLLENBQUMsY0FBYyxJQUFJLENBQUMsQ0FBQyxLQUFLLENBQUMsU0FBUyxDQUFDO0FBQ3hFLENBQUMifQ==

package/src/account/complete_address.ts

@@ -1,18 +0,0 @@
-import { AztecAddress, PartialContractAddress, PublicKey } from '@aztec/circuits.js';
-
-/** Address and preimages associated with an account. */
-export type CompleteAddress = {
-  /** Address of an account. Derived from the partial address and public key. */
-  address: AztecAddress;
-  /** Partial address of the account. Required for deriving the address from the encryption public key. */
-  partialAddress: PartialContractAddress;
-  /** Encryption public key associated with this address. */
-  publicKey: PublicKey;
-};
-
-/** Returns whether the argument looks like a CompleteAddress. */
-export function isCompleteAddress(obj: any): obj is CompleteAddress {
-  if (!obj) return false;
-  const maybe = obj as CompleteAddress;
-  return !!maybe.address && !!maybe.partialAddress && !!maybe.publicKey;
-}