@aztec/end-to-end 0.0.1-commit.d3ec352c → 0.0.1-commit.d58ff9d0

package/src/bench/client_flows/data_extractor.ts

@@ -22,7 +22,7 @@ async function main() {
   logger.info(`Flows in ${ivcFolder}: \n${flows.map(flowName => `\t- ${flowName}`).join('\n')}`);
   const simulator = new WASMSimulator();
   const log = proxyLogger.createLogger('bb:prover');
-  const prover = new BBBundlePrivateKernelProver(simulator, log);
+  const prover = new BBBundlePrivateKernelProver(simulator, { logger: log });
 
   const userLog = createLogger('chonk_flows:data_processor');
 
@@ -51,6 +51,7 @@ async function main() {
       // TODO(AD) do we still want to take this from witness.json?
       witness: witnessStack[i],
       vk: stepsFromFile[i].vk,
+      kind: stepsFromFile[i].kind,
       timings: {
         witgen: step.timings.witgen,
         gateCount: step.timings.gateCount,

package/src/bench/utils.ts

@@ -1,31 +1,50 @@
 import type { AztecNodeService } from '@aztec/aztec-node';
-import { BatchCall, type SentTx, type WaitOpts } from '@aztec/aztec.js/contracts';
+import { AztecAddress } from '@aztec/aztec.js/addresses';
+import { BatchCall, NO_WAIT, type WaitOpts } from '@aztec/aztec.js/contracts';
+import { waitForTx } from '@aztec/aztec.js/node';
+import { SlotNumber } from '@aztec/foundation/branded-types';
 import { mean, stdDev, times } from '@aztec/foundation/collection';
 import { BenchmarkingContract } from '@aztec/noir-test-contracts.js/Benchmarking';
-import type { MetricsType } from '@aztec/telemetry-client';
+import { type Sequencer, type SequencerEvents, SequencerState } from '@aztec/sequencer-client';
+import type { TxHash } from '@aztec/stdlib/tx';
+import type { MetricDefinition } from '@aztec/telemetry-client';
 import type { BenchmarkDataPoint, BenchmarkMetricsType, BenchmarkTelemetryClient } from '@aztec/telemetry-client/bench';
 
 import { mkdirSync, writeFileSync } from 'fs';
 import path from 'path';
 
+import { PIPELINING_SETUP_OPTS } from '../fixtures/fixtures.js';
 import { type EndToEndContext, type SetupOptions, setup } from '../fixtures/utils.js';
 
+const MAX_BENCH_WAIT_BLOCKS = 6;
+const BENCH_FINAL_WAIT_TIMEOUT_SECONDS = 10;
+const SEQUENCER_IDLE_TIMEOUT_MS = 60_000;
+const DEFAULT_L1_PUBLISHING_TIME_SECONDS = 12;
+
 /**
- * Setup for benchmarks. Initializes a remote node with a single account and deploys a benchmark contract.
+ * Setup for benchmarks. Initializes a remote node with a funded hardcoded account and deploys a benchmark contract.
  */
 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 defaultAccountAddress = context.accounts[0];
-  const contract = await BenchmarkingContract.deploy(context.wallet).send({ from: defaultAccountAddress }).deployed();
+  const context = await setup(1, {
+    ...PIPELINING_SETUP_OPTS,
+    ...opts,
+    telemetryConfig: { benchmark: true },
+  });
+  const [defaultAccountAddress] = context.accounts;
+  const sequencer = getSequencerClient(context);
+  await waitForSequencerIdle(sequencer.getSequencer());
+  const deployment = BenchmarkingContract.deploy(context.wallet);
+  const { txHash } = await deployment.send({ from: defaultAccountAddress, wait: NO_WAIT });
+  await waitTxs([txHash], context);
+  const contract = await deployment.register();
   context.logger.info(`Deployed benchmarking contract at ${contract.address}`);
-  const sequencer = (context.aztecNode as AztecNodeService).getSequencer()!;
-  const telemetry = context.telemetryClient! as BenchmarkTelemetryClient;
+  const telemetry = context.telemetryClient as BenchmarkTelemetryClient;
   context.logger.warn(`Cleared benchmark data points from setup`);
   telemetry.clear();
   const origTeardown = context.teardown.bind(context);
@@ -45,8 +64,16 @@ export async function benchmarkSetup(
   return { telemetry, context, contract, sequencer };
 }
 
+function getSequencerClient(context: EndToEndContext) {
+  const sequencer = (context.aztecNode as AztecNodeService).getSequencer();
+  if (!sequencer) {
+    throw new Error('Benchmark setup requires a local sequencer');
+  }
+  return sequencer;
+}
+
 type MetricFilter = {
-  source: MetricsType;
+  source: MetricDefinition;
   transform: (value: number) => number;
   name: string;
   unit?: string;
@@ -61,17 +88,21 @@ export 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',
@@ -103,19 +134,22 @@ function getMetricValues(points: BenchmarkDataPoint[]) {
  * @param heavyPublicCompute - Whether the transactions include heavy public compute (like a big sha256).
  * @returns A BatchCall instance.
  */
-function makeCall(
+async function makeCall(
   index: number,
   context: EndToEndContext,
   contract: BenchmarkingContract,
   heavyPublicCompute: boolean,
 ) {
-  const [owner] = context.accounts;
   if (heavyPublicCompute) {
     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, [
-      contract.methods.create_note(owner, index + 1),
-      contract.methods.increment_balance(owner, index + 1),
+      contract.methods.create_note(ownerOfNewNote, index + 1),
+      contract.methods.increment_balance(ownerOfBalance, index + 1),
     ]);
   }
 }
@@ -129,23 +163,108 @@ function makeCall(
  * @param heavyPublicCompute - Whether the transactions include heavy public compute (like a big sha256).
  * @returns Array of sent txs.
  */
-export function sendTxs(
+export async function sendTxs(
   txCount: number,
   context: EndToEndContext,
   contract: BenchmarkingContract,
   heavyPublicCompute: boolean = false,
-): SentTx[] {
-  const calls = times(txCount, index => makeCall(index, context, contract, heavyPublicCompute));
+): Promise<TxHash[]> {
+  const calls = await Promise.all(times(txCount, index => makeCall(index, context, contract, heavyPublicCompute)));
   context.logger.info(`Creating ${txCount} txs`);
   const [from] = context.accounts;
   context.logger.info(`Sending ${txCount} txs`);
-  return calls.map(call => call.send({ from }));
+  return Promise.all(
+    calls.map(async call => {
+      const { txHash } = await call.send({ from, wait: NO_WAIT });
+      return txHash;
+    }),
+  );
 }
 
-export async function waitTxs(txs: SentTx[], context: EndToEndContext, txWaitOpts?: WaitOpts) {
+export async function waitTxs(txs: TxHash[], context: EndToEndContext, txWaitOpts?: WaitOpts) {
   context.logger.info(`Awaiting ${txs.length} txs to be mined`);
-  await Promise.all(txs.map(tx => tx.wait(txWaitOpts)));
-  context.logger.info(`All ${txs.length} txs have been mined`);
+  await waitTxsWithBlockMining(txs, context, txWaitOpts);
+  context.logger.info(`${txs.length} txs have been mined`);
+}
+
+async function waitTxsWithBlockMining(txs: TxHash[], context: EndToEndContext, txWaitOpts?: WaitOpts) {
+  const sequencer = getSequencerClient(context).getSequencer();
+  for (let attempt = 0; attempt <= MAX_BENCH_WAIT_BLOCKS; attempt++) {
+    if (await haveAllTxsMined(txs, context, txWaitOpts)) {
+      await waitForSequencerIdle(sequencer);
+      return;
+    }
+    await waitForSequencerIdle(sequencer);
+    context.logger.info('Mining next benchmark block while waiting for txs', {
+      attempt,
+      txs: txs.length,
+    });
+    await mineNextBenchmarkBlock(context, sequencer);
+  }
+  await Promise.all(
+    txs.map(txHash =>
+      waitForTx(context.aztecNode, txHash, {
+        ...txWaitOpts,
+        timeout: txWaitOpts?.timeout ?? BENCH_FINAL_WAIT_TIMEOUT_SECONDS,
+      }),
+    ),
+  );
+}
+
+async function haveAllTxsMined(txs: TxHash[], context: EndToEndContext, txWaitOpts?: WaitOpts): Promise<boolean> {
+  const receipts = await Promise.all(txs.map(txHash => context.aztecNode.getTxReceipt(txHash)));
+  for (const receipt of receipts) {
+    if (receipt.isDropped()) {
+      throw new Error(`Transaction ${receipt.txHash.toString()} was dropped. Reason: ${receipt.error ?? 'unknown'}`);
+    }
+    if (!receipt.isMined()) {
+      return false;
+    }
+    if (!receipt.hasExecutionSucceeded() && !txWaitOpts?.dontThrowOnRevert) {
+      throw new Error(
+        `Transaction ${receipt.txHash.toString()} reverted: ${receipt.executionResult}. Reason: ${
+          receipt.error ?? 'unknown'
+        }`,
+      );
+    }
+  }
+  return true;
+}
+
+async function mineNextBenchmarkBlock(context: EndToEndContext, sequencer: Sequencer) {
+  const l1PublishingTime = BigInt(context.config.l1PublishingTime ?? DEFAULT_L1_PUBLISHING_TIME_SECONDS);
+  const currentTimestamp = BigInt(await context.cheatCodes.eth.lastBlockTimestamp());
+  let targetSlot = SlotNumber((await context.cheatCodes.rollup.getSlot()) + 1);
+  let targetTimestamp = await context.cheatCodes.rollup.getTimestampForSlot(targetSlot);
+  while (targetTimestamp - l1PublishingTime - 1n <= currentTimestamp) {
+    targetSlot = SlotNumber(targetSlot + 1);
+    targetTimestamp = await context.cheatCodes.rollup.getTimestampForSlot(targetSlot);
+  }
+
+  const triggerTimestamp = targetTimestamp - l1PublishingTime - 1n;
+  await context.cheatCodes.eth.warp(triggerTimestamp, { resetBlockInterval: true });
+  await context.aztecNode.mineBlock();
+  await waitForSequencerIdle(sequencer);
+}
+
+function waitForSequencerIdle(sequencer: Sequencer, timeout = SEQUENCER_IDLE_TIMEOUT_MS): Promise<void> {
+  if (sequencer.status().state === SequencerState.IDLE) {
+    return Promise.resolve();
+  }
+  return new Promise((resolve, reject) => {
+    const timer = setTimeout(() => {
+      sequencer.off('state-changed', handler);
+      reject(new Error('Timeout waiting for sequencer IDLE state'));
+    }, timeout);
+    const handler = (args: Parameters<SequencerEvents['state-changed']>[0]) => {
+      if (args.newState === SequencerState.IDLE) {
+        clearTimeout(timer);
+        sequencer.off('state-changed', handler);
+        resolve();
+      }
+    };
+    sequencer.on('state-changed', handler);
+  });
 }
 
 function randomBytesAsBigInts(length: number): bigint[] {