chore: Cleanup sandbox dependent tests

.circleci/config.yml

@@ -769,7 +769,7 @@ jobs:
           name: "Test"
           command: cond_spot_run_compose end-to-end 4 ./scripts/docker-compose-no-sandbox.yml TEST=e2e_p2p_network.test.ts
 
-  e2e-browser-sandbox:
+  e2e-browser:
     docker:
       - image: aztecprotocol/alpine-build-image
     resource_class: small
@@ -791,7 +791,7 @@ jobs:
           name: "Test"
           command: cond_spot_run_compose end-to-end 4 ./scripts/docker-compose.yml TEST=e2e_card_game.test.ts
 
-  pxe-sandbox:
+  pxe:
     docker:
       - image: aztecprotocol/alpine-build-image
     resource_class: small
@@ -1206,9 +1206,9 @@ workflows:
       - integration-l1-publisher: *e2e_test
       - integration-archiver-l1-to-l2: *e2e_test
       - e2e-p2p: *e2e_test
-      - e2e-browser-sandbox: *e2e_test
+      - e2e-browser: *e2e_test
       - e2e-card-game: *e2e_test
-      - pxe-sandbox: *e2e_test
+      - pxe: *e2e_test
       - cli-docs-sandbox: *e2e_test
       - guides-writing-an-account-contract: *e2e_test
       - guides-dapp-testing: *e2e_test
@@ -1242,9 +1242,9 @@ workflows:
             - integration-l1-publisher
             - integration-archiver-l1-to-l2
             - e2e-p2p
-            - e2e-browser-sandbox
+            - e2e-browser
             - e2e-card-game
-            - pxe-sandbox
+            - pxe
             - cli-docs-sandbox
             - guides-writing-an-account-contract
             - guides-dapp-testing

boxes/blank-react/src/sandbox/index.ts

@@ -0,0 +1,11 @@
+import { createPXEClient, waitForPXE } from '@aztec/aztec.js';
+
+const { PXE_URL = 'http://localhost:8080' } = process.env;
+
+// assumes sandbox is running locally, which this script does not trigger
+// as well as anvil.  anvil can be started with yarn test:integration
+export const setupSandbox = async () => {
+    const pxe = createPXEClient(PXE_URL);
+    await waitForPXE(pxe);
+    return pxe;
+  };

boxes/blank-react/src/scripts/util.ts

@@ -1,6 +1,6 @@
 import { AccountWallet, CompleteAddress, Fr, FunctionArtifact, PXE, encodeArguments } from '@aztec/aztec.js';
 
-import { getSandboxAccountsWallets } from '@aztec/accounts/testing';
+import { getInitialSandboxAccountsWallets } from '@aztec/accounts/testing';
 
 export function convertArgs(functionAbi: FunctionArtifact, args: any): Fr[] {
   const untypedArgs = functionAbi.parameters.map(param => {
@@ -27,7 +27,7 @@ export function convertArgs(functionAbi: FunctionArtifact, args: any): Fr[] {
  * @returns
  */
 export async function getWallet(account: CompleteAddress, pxe: PXE): Promise<AccountWallet> {
-  const accountWallets: AccountWallet[] = await getSandboxAccountsWallets(pxe);
+  const accountWallets: AccountWallet[] = await getInitialSandboxAccountsWallets(pxe);
   const selectedWallet: AccountWallet = accountWallets.find(w => w.getAddress().equals(account.address))!;
   if (!selectedWallet) {
     throw new Error(`Wallet for account ${account.address.toShortString()} not found in the PXE.`);

boxes/blank-react/src/tests/blank.contract.test.ts

@@ -10,21 +10,11 @@ import {
   TxStatus,
   Wallet,
   createDebugLogger,
-  createPXEClient,
-  waitForSandbox,
 } from '@aztec/aztec.js';
+import { setupSandbox } from '../sandbox/index.js';
 
 const logger = createDebugLogger('aztec:http-pxe-client');
 
-// assumes sandbox is running locally, which this script does not trigger
-// as well as anvil.  anvil can be started with yarn test:integration
-const setupSandbox = async () => {
-  const { PXE_URL = 'http://localhost:8080' } = process.env;
-  const pxe = createPXEClient(PXE_URL);
-  await waitForSandbox(pxe);
-
-  return pxe;
-};
 
 async function deployZKContract(owner: CompleteAddress, wallet: Wallet, pxe: PXE) {
   logger('Deploying Blank contract...');

boxes/blank/src/index.ts

@@ -16,7 +16,7 @@ import {
   encodeArguments,
 } from '@aztec/aztec.js';
 
-import { getSandboxAccountsWallets } from '@aztec/accounts/testing';
+import { getInitialSandboxAccountsWallets } from '@aztec/accounts/testing';
 
 // docs:end:imports
 
@@ -45,7 +45,7 @@ if (typeof document !== 'undefined') {
 export async function handleDeployClick(): Promise<string> {
   // eslint-disable-next-line no-console
   console.log('Deploying Contract');
-  const [wallet, ..._rest] = await getSandboxAccountsWallets(pxe);
+  const [wallet, ..._rest] = await getInitialSandboxAccountsWallets(pxe);
 
   const contractAztecAddress = await deployContract(
     wallet.getCompleteAddress(),
@@ -60,7 +60,7 @@ export async function handleDeployClick(): Promise<string> {
 // docs:end:deploy
 // docs:start:interact
 export async function handleInteractClick(contractAddress: string) {
-  const [wallet, ..._rest] = await getSandboxAccountsWallets(pxe);
+  const [wallet, ..._rest] = await getInitialSandboxAccountsWallets(pxe);
   const callArgs = { address: wallet.getCompleteAddress().address };
   const getPkAbi = getFunctionAbi(BlankContractArtifact, 'getPublicKey');
   const typedArgs = convertArgs(getPkAbi, callArgs);
@@ -115,7 +115,7 @@ export async function callContractFunction(
  * @returns
  */
 export async function getWallet(account: CompleteAddress, pxe: PXE): Promise<AccountWallet> {
-  const accountWallets: AccountWallet[] = await getSandboxAccountsWallets(pxe);
+  const accountWallets: AccountWallet[] = await getInitialSandboxAccountsWallets(pxe);
   const selectedWallet: AccountWallet = accountWallets.find(w => w.getAddress().equals(account.address))!;
   if (!selectedWallet) {
     throw new Error(`Wallet for account ${account.address.toShortString()} not found in the PXE.`);

boxes/blank/src/sandbox/index.ts

@@ -0,0 +1,11 @@
+import { createPXEClient, waitForPXE } from '@aztec/aztec.js';
+
+const { PXE_URL = 'http://localhost:8080' } = process.env;
+
+// assumes sandbox is running locally, which this script does not trigger
+// as well as anvil.  anvil can be started with yarn test:integration
+export const setupSandbox = async () => {
+    const pxe = createPXEClient(PXE_URL);
+    await waitForPXE(pxe);
+    return pxe;
+  };

boxes/blank/src/tests/blank.contract.test.ts

@@ -10,21 +10,11 @@ import {
   TxStatus,
   Wallet,
   createDebugLogger,
-  createPXEClient,
-  waitForSandbox,
 } from '@aztec/aztec.js';
+import { setupSandbox } from '../sandbox/index.js';
 
 const logger = createDebugLogger('aztec:blank-box-test');
 
-// assumes sandbox is running locally, which this script does not trigger
-// as well as anvil.  anvil can be started with yarn test:integration
-const setupSandbox = async () => {
-  const { PXE_URL = 'http://localhost:8080' } = process.env;
-  const pxe = createPXEClient(PXE_URL);
-  await waitForSandbox(pxe);
-  return pxe;
-};
-
 async function deployZKContract(owner: CompleteAddress, wallet: Wallet, pxe: PXE) {
   logger('Deploying Blank contract...');
   const contractAddress = await deployContract(owner, BlankContract.artifact, [], Fr.random(), pxe);

boxes/token/src/sandbox/index.ts

@@ -0,0 +1,11 @@
+import { createPXEClient, waitForPXE } from '@aztec/aztec.js';
+
+const { PXE_URL = 'http://localhost:8080' } = process.env;
+
+// assumes sandbox is running locally, which this script does not trigger
+// as well as anvil.  anvil can be started with yarn test:integration
+export const setupSandbox = async () => {
+    const pxe = createPXEClient(PXE_URL);
+    await waitForPXE(pxe);
+    return pxe;
+  };

boxes/token/src/scripts/util.ts

@@ -1,6 +1,6 @@
 import { AccountWallet, CompleteAddress, Fr, FunctionArtifact, PXE, encodeArguments } from '@aztec/aztec.js';
 
-import { getSandboxAccountsWallets } from '@aztec/accounts/testing';
+import { getInitialSandboxAccountsWallets } from '@aztec/accounts/testing';
 
 function convertBasicArg(paramType: string, value: any) {
   switch (paramType) {
@@ -42,7 +42,7 @@ export function convertArgs(functionAbi: FunctionArtifact, args: any): Fr[] {
  * @returns
  */
 export async function getWallet(account: CompleteAddress, pxe: PXE): Promise<AccountWallet> {
-  const accountWallets: AccountWallet[] = await getSandboxAccountsWallets(pxe);
+  const accountWallets: AccountWallet[] = await getInitialSandboxAccountsWallets(pxe);
   const selectedWallet: AccountWallet = accountWallets.find(w => w.getAddress().equals(account.address))!;
   if (!selectedWallet) {
     throw new Error(`Wallet for account ${account.address.toShortString()} not found in the PXE.`);

boxes/token/src/tests/token.contract.test.ts

@@ -13,22 +13,12 @@ import {
   computeAuthWitMessageHash,
   computeMessageSecretHash,
   createDebugLogger,
-  createPXEClient,
-  waitForSandbox,
 } from '@aztec/aztec.js';
 
-import { getSandboxAccountsWallets } from '@aztec/accounts/testing';
+import { getInitialSandboxAccountsWallets } from '@aztec/accounts/testing';
 
 import { afterEach, beforeAll, expect, jest } from '@jest/globals';
-
-// assumes sandbox is running locally, which this script does not trigger
-// as well as anvil.  anvil can be started with yarn test:integration
-const setupSandbox = async () => {
-  const { PXE_URL = 'http://localhost:8080' } = process.env;
-  const pxe = createPXEClient(PXE_URL);
-  await waitForSandbox(pxe);
-  return pxe;
-};
+import { setupSandbox } from '../sandbox/index.js';
 
 const TIMEOUT = 60_000;
 
@@ -56,7 +46,7 @@ describe('e2e_token_contract', () => {
     pxe = await setupSandbox();
     // wallets = await createAccounts(pxe, 3);
     accounts = await pxe.getRegisteredAccounts();
-    wallets = await getSandboxAccountsWallets(pxe);
+    wallets = await getInitialSandboxAccountsWallets(pxe);
 
     logger(`Accounts: ${accounts.map(a => a.toReadableString())}`);
     logger(`Wallets: ${wallets.map(w => w.getAddress().toString())}`);

docs/docs/dev_docs/tutorials/token_portal/typescript_glue_code.md

@@ -87,7 +87,7 @@ Open `cross_chain_messaging.test.ts` and paste the initial description of the te
 
 ```typescript
 import { expect, jest} from '@jest/globals'
-import { AccountWallet, AztecAddress, DebugLogger, EthAddress, Fr, computeAuthWitMessageHash, createDebugLogger, createPXEClient, waitForSandbox } from '@aztec/aztec.js';
+import { AccountWallet, AztecAddress, DebugLogger, EthAddress, Fr, computeAuthWitMessageHash, createDebugLogger, createPXEClient, waitForPXE } from '@aztec/aztec.js';
 import { getSandboxAccountsWallets } from '@aztec/accounts/testing';
 import { TokenContract } from '@aztec/noir-contracts/Token';
 import { TokenBridgeContract } from '@aztec/noir-contracts/TokenBridge';
@@ -120,7 +120,7 @@ describe('e2e_cross_chain_messaging', () => {
   beforeEach(async () => {
     logger = createDebugLogger('aztec:e2e_uniswap');
     const pxe = createPXEClient(PXE_URL);
-    await waitForSandbox(pxe);
+    await waitForPXE(pxe);
     const wallets = await getSandboxAccountsWallets(pxe);
 
     const walletClient = createWalletClient({

docs/docs/dev_docs/tutorials/uniswap/typescript_glue_code.md

@@ -81,7 +81,7 @@ import {
   computeAuthWitMessageHash,
   createDebugLogger,
   createPXEClient,
-  waitForSandbox,
+  waitForPXE,
 } from "@aztec/aztec.js";
 import { getSandboxAccountsWallets } from '@aztec/accounts/testing';
 import {

docs/docs/dev_docs/tutorials/writing_dapp/testing.md

@@ -29,7 +29,7 @@ import {
   computeMessageSecretHash,
   createAccount,
   createPXEClient,
-  waitForSandbox,
+  waitForPXE,
 } from "@aztec/aztec.js";
 import { TokenContractArtifact } from "@aztec/noir-contracts/Token";
 

yarn-project/accounts/src/testing/sandbox.ts

@@ -12,17 +12,22 @@ export const INITIAL_SANDBOX_ENCRYPTION_KEYS = [
 
 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_SALTS = [Fr.ZERO, Fr.ZERO, Fr.ZERO];
 
 /**
  * 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[]> {
+export function getInitialSandboxAccountsWallets(pxe: PXE): Promise<AccountWalletWithPrivateKey[]> {
   return Promise.all(
     INITIAL_SANDBOX_ENCRYPTION_KEYS.map((encryptionKey, i) =>
-      getSchnorrAccount(pxe, encryptionKey!, INITIAL_SANDBOX_SIGNING_KEYS[i]!, INITIAL_SANDBOX_SALTS[i]).getWallet(),
+      getSchnorrAccount(
+        pxe,
+        encryptionKey!,
+        INITIAL_SANDBOX_SIGNING_KEYS[i]!,
+        INITIAL_SANDBOX_ACCOUNT_SALTS[i],
+      ).getWallet(),
     ),
   );
 }
@@ -34,7 +39,12 @@ export function getSandboxAccountsWallets(pxe: PXE): Promise<AccountWalletWithPr
  */
 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]);
+    const account = getSchnorrAccount(
+      pxe,
+      privateKey,
+      INITIAL_SANDBOX_SIGNING_KEYS[i],
+      INITIAL_SANDBOX_ACCOUNT_SALTS[i],
+    );
     return {
       account,
       privateKey,

yarn-project/aztec.js/src/index.ts

@@ -44,6 +44,7 @@ export {
   isContractDeployed,
   EthCheatCodes,
   computeAuthWitMessageHash,
+  waitForPXE,
 } from './utils/index.js';
 
 export { createPXEClient } from './pxe_client.js';
@@ -53,8 +54,6 @@ export { AuthWitnessProvider } from './account/index.js';
 export { AccountContract } from './account/index.js';
 export { AccountManager } from './account_manager/index.js';
 
-export { waitForSandbox } 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

yarn-project/aztec.js/src/utils/index.ts

@@ -5,3 +5,4 @@ export * from './l2_contracts.js';
 export * from './abi_types.js';
 export * from './cheat_codes.js';
 export * from './authwit.js';
+export * from './pxe.js';

yarn-project/aztec.js/src/utils/pxe.ts

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

yarn-project/end-to-end/src/benchmarks/utils.ts

@@ -21,7 +21,7 @@ import { join } from 'path';
 import { EndToEndContext, setup } from '../fixtures/utils.js';
 
 /**
- * Setup for benchmarks. Initializes a sandbox node with a single account and deploys a benchmark contract.
+ * Setup for benchmarks. Initializes a remote node with a single account and deploys a benchmark contract.
  */
 export async function benchmarkSetup(opts: Partial<AztecNodeConfig>) {
   const context = await setup(1, { ...opts });