@alejoamiras/aztec-benchmark 0.0.0-canary.gb8d1485

package/dist/systemInfo.js

@@ -0,0 +1,61 @@
+import * as os from 'node:os';
+/**
+ * Gets the effective CPU count, respecting container limits.
+ * Uses availableParallelism() which is cgroup-aware in Node 18.14+/19.4+
+ */
+function getEffectiveCpuCount() {
+    if (typeof os.availableParallelism === 'function') {
+        return os.availableParallelism();
+    }
+    return os.cpus().length;
+}
+/**
+ * Gets total system memory in GiB.
+ */
+function getTotalMemoryGiB() {
+    return Math.round(os.totalmem() / (1024 * 1024 * 1024));
+}
+/**
+ * Collects system information for benchmark reports.
+ * Returns N/A values if information cannot be determined.
+ */
+export function getSystemInfo() {
+    let cpuModel = 'N/A';
+    let cpuCores = 0;
+    let totalMemoryGiB = 0;
+    let arch = 'N/A';
+    try {
+        cpuCores = getEffectiveCpuCount();
+    }
+    catch {
+        // Keep default 0
+    }
+    try {
+        totalMemoryGiB = getTotalMemoryGiB();
+    }
+    catch {
+        // Keep default 0
+    }
+    try {
+        // Prefer RUNNER_ARCH env var in CI environments
+        arch = (process.env.RUNNER_ARCH ?? os.arch()).toLowerCase();
+    }
+    catch {
+        // Keep default N/A
+    }
+    try {
+        const cpus = os.cpus();
+        if (cpus && cpus.length > 0 && cpus[0]?.model) {
+            cpuModel = cpus[0].model.trim();
+        }
+    }
+    catch {
+        // Keep default N/A
+    }
+    return {
+        cpuModel,
+        cpuCores,
+        totalMemoryGiB,
+        arch,
+    };
+}

package/dist/types.d.ts

@@ -0,0 +1,79 @@
+import type { AztecAddress } from '@aztec/aztec.js/addresses';
+import type { ContractFunctionInteractionCallIntent } from '@aztec/aztec.js/authorization';
+import type { FeePaymentMethod } from '@aztec/aztec.js/fee';
+import type { EmbeddedWallet } from '@aztec/wallets/embedded';
+import type { SystemInfo } from './systemInfo.js';
+export type { SystemInfo } from './systemInfo.js';
+/** Simplified Gas type (contains actual gas values) */
+export type Gas = {
+    /** Data Availability gas */
+    daGas: number;
+    /** Layer 2 execution gas */
+    l2Gas: number;
+};
+/** Structure holding execution and teardown gas */
+export type GasLimits = {
+    gasLimits: Gas;
+    teardownGasLimits: Gas;
+};
+/** Benchmark specific setup/teardown context */
+export interface BenchmarkContext {
+    wallet?: EmbeddedWallet;
+    /** Optional fee payment method used when sending profiled transactions.
+     *  When set, the profiler passes this to every send/prove call.
+     *  When unset, the sender must have pre-existing Fee Juice. */
+    feePaymentMethod?: FeePaymentMethod;
+}
+/** Gate counts for a specific circuit */
+export interface GateCount {
+    /** The name of the circuit. */
+    circuitName: string;
+    /** The number of gates in the circuit. */
+    gateCount: number;
+    /** Witness generation time in ms (hardware-dependent). */
+    witgenMs?: number;
+}
+/** Result of profiling a single function */
+export interface ProfileResult {
+    /** The name of the profiled function. */
+    name: string;
+    /** The total gate count for the function. */
+    totalGateCount: number;
+    /** Detailed gate counts for each circuit in the function. */
+    gateCounts: GateCount[];
+    /** Gas usage information for the function. */
+    gas?: GasLimits;
+    /** Proving time in milliseconds. */
+    provingTime?: number;
+}
+/** Defines a contract interaction to be benchmarked, with a custom display name. */
+export interface NamedBenchmarkedInteraction {
+    /** The contract function interaction from Aztec.js. */
+    interaction: ContractFunctionInteractionCallIntent;
+    /** The custom name to be used for this benchmark in reports. */
+    name: string;
+    /** Extra addresses whose private state (keys, notes) should be accessible during execution. */
+    additionalScopes?: AztecAddress[];
+}
+/** Structure of the output JSON report */
+export interface ProfileReport {
+    /** Total gate counts keyed by function name */
+    summary: Record<string, number>;
+    /** Detailed results for each function */
+    results: ProfileResult[];
+    /** Gas summary (total L2 + DA) keyed by function name */
+    gasSummary: Record<string, number>;
+    /** Proving time summary (in ms) keyed by function name */
+    provingTimeSummary: Record<string, number>;
+    /** System information where the benchmark was run */
+    systemInfo: SystemInfo;
+}
+/** Abstract class for users to extend */
+export declare abstract class BenchmarkBase {
+    /** Optional setup function run before benchmarks */
+    abstract setup?(): Promise<BenchmarkContext>;
+    /** Function returning the methods to benchmark. Can be a mix of plain interactions or named interactions. */
+    abstract getMethods(context: BenchmarkContext): Array<ContractFunctionInteractionCallIntent | NamedBenchmarkedInteraction>;
+    /** Optional teardown function run after benchmarks (no longer abstract) */
+    teardown?(context: BenchmarkContext): Promise<void>;
+}

package/dist/types.js

@@ -0,0 +1,3 @@
+/** Abstract class for users to extend */
+export class BenchmarkBase {
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+  "name": "@alejoamiras/aztec-benchmark",
+  "version": "0.0.0-canary.gb8d1485",
+  "description": "CLI tool and GitHub Action for Aztec contract benchmarking",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/alejoamiras/ecosystem-tooling.git",
+    "directory": "packages/aztec-benchmark"
+  },
+  "license": "MIT",
+  "type": "module",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "aztec-benchmark": "bin/aztec-benchmark"
+  },
+  "files": [
+    "dist",
+    "action",
+    "bin",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "tsc && ncc build action/index.cjs -o action/dist -m -C",
+    "start": "tsx cli/cli.ts"
+  },
+  "dependencies": {
+    "@actions/core": "1.10.1",
+    "@actions/exec": "1.1.1",
+    "@iarna/toml": "2.2.5",
+    "commander": "13.1.0",
+    "esbuild": "0.25.0",
+    "tsx": "4.19.4",
+    "typescript": "5.8.3"
+  },
+  "devDependencies": {
+    "@aztec/aztec.js": "5.0.0-rc.2",
+    "@aztec/stdlib": "5.0.0-rc.2",
+    "@aztec/wallets": "5.0.0-rc.2",
+    "@types/node": "22.15.3",
+    "@vercel/ncc": "0.38.3"
+  },
+  "peerDependencies": {
+    "@aztec/aztec.js": "5.0.0-rc.2",
+    "@aztec/wallets": "5.0.0-rc.2"
+  },
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}