@aztec/end-to-end 0.0.0-test.1 → 0.0.1-commit.1142ef1

package/src/bench/utils.ts

@@ -1,16 +1,13 @@
 import type { AztecNodeService } from '@aztec/aztec-node';
-import { type AztecNode, BatchCall, INITIAL_L2_BLOCK_NUM, type SentTx, type WaitOpts } from '@aztec/aztec.js';
-import { mean, stdDev, timesParallel } from '@aztec/foundation/collection';
-import { randomInt } from '@aztec/foundation/crypto';
-import { BenchmarkingContract } from '@aztec/noir-contracts.js/Benchmarking';
-import { type PXEService, type PXEServiceConfig, createPXEService } from '@aztec/pxe/server';
-import type { MetricsType } from '@aztec/telemetry-client';
+import { AztecAddress } from '@aztec/aztec.js/addresses';
+import { BatchCall, type SentTx, type WaitOpts } from '@aztec/aztec.js/contracts';
+import { mean, stdDev, times } from '@aztec/foundation/collection';
+import { BenchmarkingContract } from '@aztec/noir-test-contracts.js/Benchmarking';
+import type { MetricDefinition } from '@aztec/telemetry-client';
 import type { BenchmarkDataPoint, BenchmarkMetricsType, BenchmarkTelemetryClient } from '@aztec/telemetry-client/bench';
 
-import { writeFileSync } from 'fs';
-import { mkdirpSync } from 'fs-extra';
-import { globSync } from 'glob';
-import { join } from 'path';
+import { mkdirSync, writeFileSync } from 'fs';
+import path from 'path';
 
 import { type EndToEndContext, type SetupOptions, setup } from '../fixtures/utils.js';
 
@@ -19,13 +16,14 @@ import { type EndToEndContext, type SetupOptions, setup } from '../fixtures/util
  */
 export async function benchmarkSetup(
   opts: Partial<SetupOptions> & {
-    /** What metrics to export */ metrics: (MetricsType | MetricFilter)[];
+    /** What metrics to export */ metrics: (MetricDefinition | MetricFilter)[];
     /** Where to output the benchmark data (defaults to BENCH_OUTPUT or bench.json) */
     benchOutput?: string;
   },
 ) {
   const context = await setup(1, { ...opts, telemetryConfig: { benchmark: true } });
-  const contract = await BenchmarkingContract.deploy(context.wallet).send().deployed();
+  const defaultAccountAddress = context.accounts[0];
+  const contract = await BenchmarkingContract.deploy(context.wallet).send({ from: defaultAccountAddress }).deployed();
   context.logger.info(`Deployed benchmarking contract at ${contract.address}`);
   const sequencer = (context.aztecNode as AztecNodeService).getSequencer()!;
   const telemetry = context.telemetryClient! as BenchmarkTelemetryClient;
@@ -36,7 +34,11 @@ export async function benchmarkSetup(
     await telemetry.flush();
     const data = telemetry.getMeters();
     const formatted = formatMetricsForGithubBenchmarkAction(data, opts.metrics);
+    if (formatted.length === 0) {
+      throw new Error(`No benchmark data generated. Please review your test setup.`);
+    }
     const benchOutput = opts.benchOutput ?? process.env.BENCH_OUTPUT ?? 'bench.json';
+    mkdirSync(path.dirname(benchOutput), { recursive: true });
     writeFileSync(benchOutput, JSON.stringify(formatted));
     context.logger.info(`Wrote ${data.length} metrics to ${benchOutput}`);
     await origTeardown();
@@ -45,14 +47,14 @@ export async function benchmarkSetup(
 }
 
 type MetricFilter = {
-  source: MetricsType;
+  source: MetricDefinition;
   transform: (value: number) => number;
   name: string;
   unit?: string;
 };
 
 // See https://github.com/benchmark-action/github-action-benchmark/blob/e3c661617bc6aa55f26ae4457c737a55545a86a4/src/extract.ts#L659-L670
-type GithubActionBenchmarkResult = {
+export type GithubActionBenchmarkResult = {
   name: string;
   value: number;
   range?: string;
@@ -60,17 +62,21 @@ type GithubActionBenchmarkResult = {
   extra?: string;
 };
 
+function isMetricDefinition(f: MetricDefinition | MetricFilter): f is MetricDefinition {
+  return 'description' in f;
+}
+
 function formatMetricsForGithubBenchmarkAction(
   data: BenchmarkMetricsType,
-  filter: (MetricsType | MetricFilter)[],
+  filter: (MetricDefinition | MetricFilter)[],
 ): GithubActionBenchmarkResult[] {
   const allFilters: MetricFilter[] = filter.map(f =>
-    typeof f === 'string' ? { name: f, source: f, transform: (x: number) => x, unit: undefined } : f,
+    isMetricDefinition(f) ? { name: f.name, source: f, transform: (x: number) => x, unit: f.unit } : f,
   );
   return data.flatMap(meter => {
     return meter.metrics
-      .filter(metric => allFilters.map(f => f.source).includes(metric.name as MetricsType))
-      .map(metric => [metric, allFilters.find(f => f.source === metric.name)!] as const)
+      .filter(metric => allFilters.map(f => f.source.name).includes(metric.name))
+      .map(metric => [metric, allFilters.find(f => f.source.name === metric.name)!] as const)
       .map(([metric, filter]) => ({
         name: `${meter.name}/${filter.name}`,
         unit: filter.unit ?? metric.unit ?? 'unknown',
@@ -91,30 +97,6 @@ function getMetricValues(points: BenchmarkDataPoint[]) {
   }
 }
 
-/**
- * Creates and returns a directory with the current job name and a random number.
- * @param index - Index to merge into the dir path.
- * @returns A path to a created dir.
- */
-export function makeDataDirectory(index: number) {
-  const testName = expect.getState().currentTestName!.split(' ')[0].replaceAll('/', '_');
-  const db = join('data', testName, index.toString(), `${randomInt(99)}`);
-  mkdirpSync(db);
-  return db;
-}
-
-/**
- * Returns the size in disk of a folder.
- * @param path - Path to the folder.
- * @returns Size in bytes.
- */
-export function getFolderSize(path: string): number {
-  return globSync('**', { stat: true, cwd: path, nodir: true, withFileTypes: true }).reduce(
-    (accum, file) => accum + (file as any as { /** Size */ size: number }).size,
-    0,
-  );
-}
-
 /**
  * Returns a call to the benchmark contract. Each call has a private execution (account entrypoint),
  * a nested private call (create_note), a public call (increment_balance), and a nested public
@@ -126,22 +108,22 @@ export function getFolderSize(path: string): number {
  * @param heavyPublicCompute - Whether the transactions include heavy public compute (like a big sha256).
  * @returns A BatchCall instance.
  */
-export async function makeCall(
+async function makeCall(
   index: number,
   context: EndToEndContext,
   contract: BenchmarkingContract,
   heavyPublicCompute: boolean,
 ) {
-  const owner = context.wallet.getAddress();
-  const sender = owner;
   if (heavyPublicCompute) {
-    return new BatchCall(context.wallet, [
-      await contract.methods.sha256_hash_2048(randomBytesAsBigInts(2048)).request(),
-    ]);
+    return new BatchCall(context.wallet, [contract.methods.sha256_hash_1024(randomBytesAsBigInts(1024))]);
   } else {
+    // We use random address for the new note owner because we can emit at most UNFINALIZED_TAGGING_INDEXES_WINDOW_LEN
+    // logs for a given sender-recipient-contract tuple.
+    const ownerOfNewNote = await AztecAddress.random();
+    const [ownerOfBalance] = context.accounts;
     return new BatchCall(context.wallet, [
-      await contract.methods.create_note(owner, sender, index + 1).request(),
-      await contract.methods.increment_balance(owner, index + 1).request(),
+      contract.methods.create_note(ownerOfNewNote, index + 1),
+      contract.methods.increment_balance(ownerOfBalance, index + 1),
     ]);
   }
 }
@@ -161,11 +143,11 @@ export async function sendTxs(
   contract: BenchmarkingContract,
   heavyPublicCompute: boolean = false,
 ): Promise<SentTx[]> {
-  const calls = await timesParallel(txCount, index => makeCall(index, context, contract, heavyPublicCompute));
+  const calls = await Promise.all(times(txCount, index => makeCall(index, context, contract, heavyPublicCompute)));
   context.logger.info(`Creating ${txCount} txs`);
-  const provenTxs = await Promise.all(calls.map(call => call.prove({ skipPublicSimulation: true })));
+  const [from] = context.accounts;
   context.logger.info(`Sending ${txCount} txs`);
-  return provenTxs.map(tx => tx.send());
+  return calls.map(call => call.send({ from }));
 }
 
 export async function waitTxs(txs: SentTx[], context: EndToEndContext, txWaitOpts?: WaitOpts) {
@@ -174,34 +156,6 @@ export async function waitTxs(txs: SentTx[], context: EndToEndContext, txWaitOpt
   context.logger.info(`All ${txs.length} txs have been mined`);
 }
 
-/**
- * Creates a new PXE
- * @param node - Node to connect the pxe to.
- * @param contract - Benchmark contract to add to the pxe.
- * @param startingBlock - First l2 block to process.
- * @returns The new PXE.
- */
-export async function createNewPXE(
-  node: AztecNode,
-  contract: BenchmarkingContract,
-  startingBlock: number = INITIAL_L2_BLOCK_NUM,
-): Promise<PXEService> {
-  const l1Contracts = await node.getL1ContractAddresses();
-  const { l1ChainId, protocolVersion } = await node.getNodeInfo();
-  const pxeConfig = {
-    l2StartingBlock: startingBlock,
-    l2BlockPollingIntervalMS: 100,
-    dataDirectory: undefined,
-    dataStoreMapSizeKB: 1024 * 1024,
-    l1Contracts,
-    l1ChainId,
-    version: protocolVersion,
-  } as PXEServiceConfig;
-  const pxe = await createPXEService(node, pxeConfig);
-  await pxe.registerContract(contract);
-  return pxe;
-}
-
 function randomBytesAsBigInts(length: number): bigint[] {
   return [...Array(length)].map(_ => BigInt(Math.floor(Math.random() * 255)));
 }

package/src/e2e_blacklist_token_contract/blacklist_token_contract_test.ts

@@ -1,17 +1,15 @@
-import { getSchnorrWallet } from '@aztec/accounts/schnorr';
-import {
-  type AccountWallet,
-  type CompleteAddress,
-  Fr,
-  type Logger,
-  type TxHash,
-  computeSecretHash,
-  createLogger,
-} from '@aztec/aztec.js';
-import { MAX_NOTE_HASHES_PER_TX } from '@aztec/constants';
-import { DocsExampleContract } from '@aztec/noir-contracts.js/DocsExample';
+import { AztecAddress } from '@aztec/aztec.js/addresses';
+import { computeSecretHash } from '@aztec/aztec.js/crypto';
+import { Fr } from '@aztec/aztec.js/fields';
+import { type Logger, createLogger } from '@aztec/aztec.js/log';
+import type { AztecNode } from '@aztec/aztec.js/node';
+import type { TxHash } from '@aztec/aztec.js/tx';
+import type { CheatCodes } from '@aztec/aztec/testing';
 import type { TokenContract } from '@aztec/noir-contracts.js/Token';
 import { TokenBlacklistContract } from '@aztec/noir-contracts.js/TokenBlacklist';
+import { InvalidAccountContract } from '@aztec/noir-test-contracts.js/InvalidAccount';
+import type { SequencerClient } from '@aztec/sequencer-client';
+import type { TestWallet } from '@aztec/test-wallet/server';
 
 import { jest } from '@jest/globals';
 
@@ -54,31 +52,34 @@ export class Role {
 }
 
 export class BlacklistTokenContractTest {
-  // A low delay is really poor ux, but we need to keep it low for the tests to run "quickly".
   // This value MUST match the same value that we have in the contract
-  static DELAY = 2;
+  static CHANGE_ROLES_DELAY = 86400;
 
   private snapshotManager: ISnapshotManager;
   logger: Logger;
-  wallets: AccountWallet[] = [];
-  accounts: CompleteAddress[] = [];
+  wallet!: TestWallet;
   asset!: TokenBlacklistContract;
   tokenSim!: TokenSimulator;
-  badAccount!: DocsExampleContract;
+  badAccount!: InvalidAccountContract;
+  cheatCodes!: CheatCodes;
+  sequencer!: SequencerClient;
+  aztecNode!: AztecNode;
 
-  admin!: AccountWallet;
-  other!: AccountWallet;
-  blacklisted!: AccountWallet;
+  adminAddress!: AztecAddress;
+  otherAddress!: AztecAddress;
+  blacklistedAddress!: AztecAddress;
 
   constructor(testName: string) {
     this.logger = createLogger(`e2e:e2e_blacklist_token_contract:${testName}`);
     this.snapshotManager = createSnapshotManager(`e2e_blacklist_token_contract/${testName}`, dataPath);
   }
 
-  async mineBlocks(amount: number = BlacklistTokenContractTest.DELAY) {
-    for (let i = 0; i < amount; ++i) {
-      await this.asset.methods.get_roles(this.admin.getAddress()).send().wait();
-    }
+  async crossTimestampOfChange() {
+    await this.cheatCodes.warpL2TimeAtLeastBy(
+      this.sequencer,
+      this.aztecNode,
+      BlacklistTokenContractTest.CHANGE_ROLES_DELAY,
+    );
   }
 
   /**
@@ -93,12 +94,15 @@ export class BlacklistTokenContractTest {
     await this.snapshotManager.snapshot(
       '3_accounts',
       deployAccounts(3, this.logger),
-      async ({ deployedAccounts }, { pxe }) => {
-        this.wallets = await Promise.all(deployedAccounts.map(a => getSchnorrWallet(pxe, a.address, a.signingKey)));
-        this.admin = this.wallets[0];
-        this.other = this.wallets[1];
-        this.blacklisted = this.wallets[2];
-        this.accounts = this.wallets.map(w => w.getCompleteAddress());
+      ({ deployedAccounts }, { cheatCodes, aztecNode, sequencer, wallet }) => {
+        this.cheatCodes = cheatCodes;
+        this.aztecNode = aztecNode;
+        this.sequencer = sequencer;
+        this.wallet = wallet;
+        this.adminAddress = deployedAccounts[0].address;
+        this.otherAddress = deployedAccounts[1].address;
+        this.blacklistedAddress = deployedAccounts[2].address;
+        return Promise.resolve();
       },
     );
 
@@ -108,36 +112,39 @@ export class BlacklistTokenContractTest {
         // Create the token contract state.
         // Move this account thing to addAccounts above?
         this.logger.verbose(`Public deploy accounts...`);
-        await publicDeployAccounts(this.wallets[0], this.accounts.slice(0, 3));
+        await publicDeployAccounts(this.wallet, [this.adminAddress, this.otherAddress, this.blacklistedAddress]);
 
         this.logger.verbose(`Deploying TokenContract...`);
-        this.asset = await TokenBlacklistContract.deploy(this.admin, this.admin.getAddress()).send().deployed();
+        this.asset = await TokenBlacklistContract.deploy(this.wallet, this.adminAddress)
+          .send({ from: this.adminAddress })
+          .deployed();
         this.logger.verbose(`Token deployed to ${this.asset.address}`);
 
         this.logger.verbose(`Deploying bad account...`);
-        this.badAccount = await DocsExampleContract.deploy(this.wallets[0]).send().deployed();
+        this.badAccount = await InvalidAccountContract.deploy(this.wallet).send({ from: this.adminAddress }).deployed();
         this.logger.verbose(`Deployed to ${this.badAccount.address}.`);
 
-        await this.mineBlocks();
+        await this.crossTimestampOfChange();
 
         return { tokenContractAddress: this.asset.address, badAccountAddress: this.badAccount.address };
       },
       async ({ tokenContractAddress, badAccountAddress }) => {
         // Restore the token contract state.
-        this.asset = await TokenBlacklistContract.at(tokenContractAddress, this.wallets[0]);
+        this.asset = TokenBlacklistContract.at(tokenContractAddress, this.wallet);
         this.logger.verbose(`Token contract address: ${this.asset.address}`);
 
         this.tokenSim = new TokenSimulator(
           this.asset as unknown as TokenContract,
-          this.wallets[0],
+          this.wallet,
+          this.adminAddress,
           this.logger,
-          this.accounts.map(a => a.address),
+          [this.adminAddress, this.otherAddress, this.blacklistedAddress],
         );
 
-        this.badAccount = await DocsExampleContract.at(badAccountAddress, this.wallets[0]);
+        this.badAccount = InvalidAccountContract.at(badAccountAddress, this.wallet);
         this.logger.verbose(`Bad account address: ${this.badAccount.address}`);
 
-        expect(await this.asset.methods.get_roles(this.admin.getAddress()).simulate()).toEqual(
+        expect(await this.asset.methods.get_roles(this.adminAddress).simulate({ from: this.adminAddress })).toEqual(
           new Role().withAdmin().toNoirStruct(),
         );
       },
@@ -158,91 +165,87 @@ export class BlacklistTokenContractTest {
     await this.snapshotManager.teardown();
   }
 
-  #toBoundedVec(arr: Fr[], maxLen: number) {
-    return { len: arr.length, storage: arr.concat(new Array(maxLen - arr.length).fill(new Fr(0))) };
-  }
-
   async addPendingShieldNoteToPXE(
     contract: TokenBlacklistContract,
-    wallet: AccountWallet,
+    recipient: AztecAddress,
     amount: bigint,
     secretHash: Fr,
     txHash: TxHash,
   ) {
-    const txEffects = await wallet.getTxEffect(txHash);
+    const txEffects = await this.aztecNode.getTxEffect(txHash);
     await contract.methods
       .deliver_transparent_note(
         contract.address,
         amount,
         secretHash,
         txHash.hash,
-        this.#toBoundedVec(txEffects!.data.noteHashes, MAX_NOTE_HASHES_PER_TX),
+        txEffects!.data.noteHashes,
         txEffects!.data.nullifiers[0],
-        wallet.getAddress(),
+        recipient,
       )
-      .simulate();
+      .simulate({ from: recipient });
   }
 
   async applyMintSnapshot() {
     await this.snapshotManager.snapshot(
       'mint',
       async () => {
-        const { asset, accounts, wallets } = this;
+        const { asset } = this;
         const amount = 10000n;
 
         const adminMinterRole = new Role().withAdmin().withMinter();
-        await this.asset
-          .withWallet(this.admin)
-          .methods.update_roles(this.admin.getAddress(), adminMinterRole.toNoirStruct())
-          .send()
+        await this.asset.methods
+          .update_roles(this.adminAddress, adminMinterRole.toNoirStruct())
+          .send({ from: this.adminAddress })
           .wait();
 
         const blacklistRole = new Role().withBlacklisted();
-        await this.asset
-          .withWallet(this.admin)
-          .methods.update_roles(this.blacklisted.getAddress(), blacklistRole.toNoirStruct())
-          .send()
+        await this.asset.methods
+          .update_roles(this.blacklistedAddress, blacklistRole.toNoirStruct())
+          .send({ from: this.adminAddress })
           .wait();
 
-        await this.mineBlocks(); // This gets us past the block of change
+        await this.crossTimestampOfChange();
 
-        expect(await this.asset.methods.get_roles(this.admin.getAddress()).simulate()).toEqual(
+        expect(await this.asset.methods.get_roles(this.adminAddress).simulate({ from: this.adminAddress })).toEqual(
           adminMinterRole.toNoirStruct(),
         );
 
         this.logger.verbose(`Minting ${amount} publicly...`);
-        await asset.methods.mint_public(accounts[0].address, amount).send().wait();
+        await asset.methods.mint_public(this.adminAddress, amount).send({ from: this.adminAddress }).wait();
 
         this.logger.verbose(`Minting ${amount} privately...`);
         const secret = Fr.random();
         const secretHash = await computeSecretHash(secret);
-        const receipt = await asset.methods.mint_private(amount, secretHash).send().wait();
+        const receipt = await asset.methods.mint_private(amount, secretHash).send({ from: this.adminAddress }).wait();
 
-        await this.addPendingShieldNoteToPXE(asset, wallets[0], amount, secretHash, receipt.txHash);
-        const txClaim = asset.methods.redeem_shield(accounts[0].address, amount, secret).send();
-        await txClaim.wait({ debug: true });
+        await this.addPendingShieldNoteToPXE(asset, this.adminAddress, amount, secretHash, receipt.txHash);
+        const txClaim = asset.methods
+          .redeem_shield(this.adminAddress, amount, secret)
+          .send({ from: this.adminAddress });
+        await txClaim.wait();
         this.logger.verbose(`Minting complete.`);
 
         return { amount };
       },
       async ({ amount }) => {
-        const {
-          asset,
-          accounts: [{ address }],
-          tokenSim,
-        } = this;
-        tokenSim.mintPublic(address, amount);
-
-        const publicBalance = await asset.methods.balance_of_public(address).simulate();
+        const { asset, tokenSim } = this;
+        tokenSim.mintPublic(this.adminAddress, amount);
+
+        const publicBalance = await asset.methods
+          .balance_of_public(this.adminAddress)
+          .simulate({ from: this.adminAddress });
         this.logger.verbose(`Public balance of wallet 0: ${publicBalance}`);
-        expect(publicBalance).toEqual(this.tokenSim.balanceOfPublic(address));
+        expect(publicBalance).toEqual(this.tokenSim.balanceOfPublic(this.adminAddress));
 
-        tokenSim.mintPrivate(address, amount);
-        const privateBalance = await asset.methods.balance_of_private(address).simulate();
+        tokenSim.mintPrivate(this.adminAddress, amount);
+        const privateBalance = await asset.methods
+          .balance_of_private(this.adminAddress)
+          .simulate({ from: this.adminAddress });
         this.logger.verbose(`Private balance of wallet 0: ${privateBalance}`);
-        expect(privateBalance).toEqual(tokenSim.balanceOfPrivate(address));
+        expect(privateBalance).toEqual(tokenSim.balanceOfPrivate(this.adminAddress));
 
-        const totalSupply = await asset.methods.total_supply().simulate();
+        const totalSupply = await asset.methods.total_supply().simulate({ from: this.adminAddress });
         this.logger.verbose(`Total supply: ${totalSupply}`);
         expect(totalSupply).toEqual(tokenSim.totalSupply);