@aztec/aztec 0.0.1-commit.cd76b27 → 0.0.1-commit.ce4f8c4f2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dest/bin/index.js +7 -3
- package/dest/cli/admin_api_key_store.d.ts +3 -3
- package/dest/cli/admin_api_key_store.d.ts.map +1 -1
- package/dest/cli/admin_api_key_store.js +3 -3
- package/dest/cli/aztec_start_action.d.ts +1 -1
- package/dest/cli/aztec_start_action.d.ts.map +1 -1
- package/dest/cli/aztec_start_action.js +20 -11
- package/dest/cli/aztec_start_options.js +6 -6
- package/dest/cli/cli.d.ts +1 -1
- package/dest/cli/cli.d.ts.map +1 -1
- package/dest/cli/cli.js +3 -4
- package/dest/cli/cmds/compile.d.ts +4 -0
- package/dest/cli/cmds/compile.d.ts.map +1 -0
- package/dest/cli/cmds/compile.js +166 -0
- package/dest/cli/cmds/profile.d.ts +4 -0
- package/dest/cli/cmds/profile.d.ts.map +1 -0
- package/dest/cli/cmds/profile.js +8 -0
- package/dest/cli/cmds/profile_flamegraph.d.ts +4 -0
- package/dest/cli/cmds/profile_flamegraph.d.ts.map +1 -0
- package/dest/cli/cmds/profile_flamegraph.js +52 -0
- package/dest/cli/cmds/profile_gates.d.ts +4 -0
- package/dest/cli/cmds/profile_gates.d.ts.map +1 -0
- package/dest/cli/cmds/profile_gates.js +58 -0
- package/dest/cli/cmds/profile_utils.d.ts +18 -0
- package/dest/cli/cmds/profile_utils.d.ts.map +1 -0
- package/dest/cli/cmds/profile_utils.js +50 -0
- package/dest/cli/cmds/standby.d.ts +32 -0
- package/dest/cli/cmds/standby.d.ts.map +1 -0
- package/dest/cli/cmds/standby.js +97 -0
- package/dest/cli/cmds/start_archiver.d.ts +2 -2
- package/dest/cli/cmds/start_archiver.d.ts.map +1 -1
- package/dest/cli/cmds/start_archiver.js +1 -1
- package/dest/cli/cmds/start_node.d.ts +3 -2
- package/dest/cli/cmds/start_node.d.ts.map +1 -1
- package/dest/cli/cmds/start_node.js +21 -17
- package/dest/cli/cmds/start_prover_broker.d.ts +1 -1
- package/dest/cli/cmds/start_prover_broker.d.ts.map +1 -1
- package/dest/cli/cmds/start_prover_broker.js +12 -6
- package/dest/cli/cmds/utils/artifacts.d.ts +21 -0
- package/dest/cli/cmds/utils/artifacts.d.ts.map +1 -0
- package/dest/cli/cmds/utils/artifacts.js +24 -0
- package/dest/cli/cmds/utils/needs_recompile.d.ts +10 -0
- package/dest/cli/cmds/utils/needs_recompile.d.ts.map +1 -0
- package/dest/cli/cmds/utils/needs_recompile.js +134 -0
- package/dest/cli/cmds/utils/spawn.d.ts +3 -0
- package/dest/cli/cmds/utils/spawn.d.ts.map +1 -0
- package/dest/cli/cmds/utils/spawn.js +16 -0
- package/dest/cli/util.d.ts +3 -5
- package/dest/cli/util.d.ts.map +1 -1
- package/dest/cli/util.js +40 -81
- package/dest/examples/token.js +4 -4
- package/dest/local-network/banana_fpc.js +1 -1
- package/dest/local-network/local-network.d.ts +1 -1
- package/dest/local-network/local-network.d.ts.map +1 -1
- package/dest/local-network/local-network.js +33 -5
- package/dest/testing/anvil_test_watcher.d.ts +9 -1
- package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
- package/dest/testing/anvil_test_watcher.js +53 -16
- package/dest/testing/cheat_codes.js +1 -1
- package/dest/testing/epoch_test_settler.d.ts +1 -1
- package/dest/testing/epoch_test_settler.d.ts.map +1 -1
- package/dest/testing/epoch_test_settler.js +3 -4
- package/dest/testing/index.d.ts +2 -1
- package/dest/testing/index.d.ts.map +1 -1
- package/dest/testing/index.js +1 -0
- package/dest/testing/token_allowed_setup.d.ts +7 -0
- package/dest/testing/token_allowed_setup.d.ts.map +1 -0
- package/dest/testing/token_allowed_setup.js +20 -0
- package/package.json +34 -34
- package/scripts/add_crate.sh +102 -0
- package/scripts/aztec.sh +10 -3
- package/scripts/init.sh +23 -19
- package/scripts/new.sh +48 -24
- package/scripts/setup_workspace.sh +68 -0
- package/src/bin/index.ts +7 -3
- package/src/cli/admin_api_key_store.ts +4 -4
- package/src/cli/aztec_start_action.ts +15 -11
- package/src/cli/aztec_start_options.ts +6 -6
- package/src/cli/cli.ts +3 -4
- package/src/cli/cmds/compile.ts +191 -0
- package/src/cli/cmds/profile.ts +25 -0
- package/src/cli/cmds/profile_flamegraph.ts +64 -0
- package/src/cli/cmds/profile_gates.ts +68 -0
- package/src/cli/cmds/profile_utils.ts +58 -0
- package/src/cli/cmds/standby.ts +132 -0
- package/src/cli/cmds/start_archiver.ts +1 -1
- package/src/cli/cmds/start_node.ts +32 -24
- package/src/cli/cmds/start_prover_broker.ts +14 -14
- package/src/cli/cmds/utils/artifacts.ts +44 -0
- package/src/cli/cmds/utils/needs_recompile.ts +151 -0
- package/src/cli/cmds/utils/spawn.ts +16 -0
- package/src/cli/util.ts +43 -76
- package/src/examples/token.ts +6 -4
- package/src/local-network/banana_fpc.ts +1 -1
- package/src/local-network/local-network.ts +29 -3
- package/src/testing/anvil_test_watcher.ts +60 -16
- package/src/testing/cheat_codes.ts +1 -1
- package/src/testing/epoch_test_settler.ts +3 -4
- package/src/testing/index.ts +1 -0
- package/src/testing/token_allowed_setup.ts +19 -0
- package/dest/cli/release_version.d.ts +0 -2
- package/dest/cli/release_version.d.ts.map +0 -1
- package/dest/cli/release_version.js +0 -14
- package/scripts/compile.sh +0 -44
- package/scripts/extract_function.js +0 -47
- package/scripts/flamegraph.sh +0 -59
- package/scripts/setup_project.sh +0 -31
- package/src/cli/release_version.ts +0 -21
|
@@ -12,7 +12,6 @@ import {
|
|
|
12
12
|
isBooleanConfigValue,
|
|
13
13
|
omitConfigMappings,
|
|
14
14
|
} from '@aztec/foundation/config';
|
|
15
|
-
import { dataConfigMappings } from '@aztec/kv-store/config';
|
|
16
15
|
import { sharedNodeConfigMappings } from '@aztec/node-lib/config';
|
|
17
16
|
import { bootnodeConfigMappings, p2pConfigMappings } from '@aztec/p2p/config';
|
|
18
17
|
import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker/config';
|
|
@@ -20,6 +19,7 @@ import { proverNodeConfigMappings } from '@aztec/prover-node/config';
|
|
|
20
19
|
import { allPxeConfigMappings } from '@aztec/pxe/config';
|
|
21
20
|
import { sequencerClientConfigMappings } from '@aztec/sequencer-client/config';
|
|
22
21
|
import { chainConfigMappings, nodeRpcConfigMappings } from '@aztec/stdlib/config';
|
|
22
|
+
import { dataConfigMappings } from '@aztec/stdlib/kv-store';
|
|
23
23
|
import { telemetryClientConfigMappings } from '@aztec/telemetry-client/config';
|
|
24
24
|
import { worldStateConfigMappings } from '@aztec/world-state/config';
|
|
25
25
|
|
|
@@ -105,8 +105,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
105
105
|
env: 'NETWORK',
|
|
106
106
|
},
|
|
107
107
|
|
|
108
|
-
configToFlag('--
|
|
109
|
-
configToFlag('--auto-update-url', sharedNodeConfigMappings.autoUpdateUrl),
|
|
108
|
+
configToFlag('--enable-version-check', sharedNodeConfigMappings.enableVersionCheck),
|
|
110
109
|
|
|
111
110
|
configToFlag('--sync-mode', sharedNodeConfigMappings.syncMode),
|
|
112
111
|
configToFlag('--snapshots-urls', sharedNodeConfigMappings.snapshotsUrls),
|
|
@@ -150,12 +149,13 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
150
149
|
env: 'AZTEC_ADMIN_API_KEY_HASH',
|
|
151
150
|
},
|
|
152
151
|
{
|
|
153
|
-
flag: '--
|
|
152
|
+
flag: '--disable-admin-api-key',
|
|
154
153
|
description:
|
|
155
154
|
'Disable API key authentication on the admin RPC endpoint. By default, a key is auto-generated, displayed once, and its hash is persisted.',
|
|
156
155
|
defaultValue: false,
|
|
157
|
-
env: '
|
|
158
|
-
|
|
156
|
+
env: 'AZTEC_DISABLE_ADMIN_API_KEY',
|
|
157
|
+
// undefined means the flag was passed without a value (boolean toggle), treat as true.
|
|
158
|
+
parseVal: val => val === undefined || val === 'true' || val === '1',
|
|
159
159
|
},
|
|
160
160
|
{
|
|
161
161
|
flag: '--reset-admin-api-key',
|
package/src/cli/cli.ts
CHANGED
|
@@ -37,10 +37,9 @@ export function injectAztecCommands(program: Command, userLog: LogFn, debugLogge
|
|
|
37
37
|
`
|
|
38
38
|
Additional commands:
|
|
39
39
|
|
|
40
|
-
init
|
|
41
|
-
new <
|
|
42
|
-
|
|
43
|
-
test [options] starts a TXE and runs "nargo test" using it as the oracle resolver.
|
|
40
|
+
init creates a new Aztec Noir workspace in the current directory.
|
|
41
|
+
new <name> creates a new Aztec Noir workspace in its own directory (or creates a new contract-test crates pair and adds it to the current workspace if run in workspace).
|
|
42
|
+
test [options] starts a TXE and runs "nargo test" using it as the oracle resolver.
|
|
44
43
|
`,
|
|
45
44
|
);
|
|
46
45
|
}
|
|
@@ -0,0 +1,191 @@
|
|
|
1
|
+
import { findBbBinary } from '@aztec/bb.js';
|
|
2
|
+
import type { LogFn } from '@aztec/foundation/log';
|
|
3
|
+
|
|
4
|
+
import { execFileSync } from 'child_process';
|
|
5
|
+
import type { Command } from 'commander';
|
|
6
|
+
import { readFile, writeFile } from 'fs/promises';
|
|
7
|
+
import { join } from 'path';
|
|
8
|
+
|
|
9
|
+
import { readArtifactFiles } from './utils/artifacts.js';
|
|
10
|
+
import { needsRecompile } from './utils/needs_recompile.js';
|
|
11
|
+
import { run } from './utils/spawn.js';
|
|
12
|
+
|
|
13
|
+
/** Returns paths to contract artifacts in the target directory. */
|
|
14
|
+
async function collectContractArtifacts(): Promise<string[]> {
|
|
15
|
+
let files;
|
|
16
|
+
try {
|
|
17
|
+
files = await readArtifactFiles('target');
|
|
18
|
+
} catch (err: any) {
|
|
19
|
+
if (err?.message?.includes('does not exist')) {
|
|
20
|
+
return [];
|
|
21
|
+
}
|
|
22
|
+
throw err;
|
|
23
|
+
}
|
|
24
|
+
return files.filter(f => Array.isArray(f.content.functions)).map(f => f.filePath);
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
/** Strips the `__aztec_nr_internals__` prefix from function names in contract artifacts. */
|
|
28
|
+
async function stripInternalPrefixes(artifactPaths: string[]): Promise<void> {
|
|
29
|
+
for (const path of artifactPaths) {
|
|
30
|
+
const artifact = JSON.parse(await readFile(path, 'utf-8'));
|
|
31
|
+
for (const fn of artifact.functions) {
|
|
32
|
+
if (typeof fn.name === 'string') {
|
|
33
|
+
fn.name = fn.name.replace(/^__aztec_nr_internals__/, '');
|
|
34
|
+
}
|
|
35
|
+
}
|
|
36
|
+
await writeFile(path, JSON.stringify(artifact, null, 2) + '\n');
|
|
37
|
+
}
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/** Returns the set of package names that are contract crates in the current workspace. */
|
|
41
|
+
async function getContractPackageNames(): Promise<Set<string>> {
|
|
42
|
+
const contractNames = new Set<string>();
|
|
43
|
+
|
|
44
|
+
let rootToml: string;
|
|
45
|
+
try {
|
|
46
|
+
rootToml = await readFile('Nargo.toml', 'utf-8');
|
|
47
|
+
} catch {
|
|
48
|
+
return contractNames;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
const membersMatch = rootToml.match(/members\s*=\s*\[([^\]]*)\]/);
|
|
52
|
+
if (membersMatch) {
|
|
53
|
+
const members = membersMatch[1]
|
|
54
|
+
.split(',')
|
|
55
|
+
.map(m => m.trim().replace(/^"|"$/g, ''))
|
|
56
|
+
.filter(m => m.length > 0);
|
|
57
|
+
|
|
58
|
+
for (const member of members) {
|
|
59
|
+
try {
|
|
60
|
+
const memberToml = await readFile(join(member, 'Nargo.toml'), 'utf-8');
|
|
61
|
+
if (/type\s*=\s*"contract"/.test(memberToml)) {
|
|
62
|
+
const nameMatch = memberToml.match(/name\s*=\s*"([^"]+)"/);
|
|
63
|
+
if (nameMatch) {
|
|
64
|
+
contractNames.add(nameMatch[1]);
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
} catch {
|
|
68
|
+
// Member directory might not exist or have no Nargo.toml; skip.
|
|
69
|
+
}
|
|
70
|
+
}
|
|
71
|
+
} else {
|
|
72
|
+
// Single-crate project (no workspace): check if the root Nargo.toml itself is a contract.
|
|
73
|
+
if (/type\s*=\s*"contract"/.test(rootToml)) {
|
|
74
|
+
const nameMatch = rootToml.match(/name\s*=\s*"([^"]+)"/);
|
|
75
|
+
if (nameMatch) {
|
|
76
|
+
contractNames.add(nameMatch[1]);
|
|
77
|
+
}
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
return contractNames;
|
|
82
|
+
}
|
|
83
|
+
|
|
84
|
+
/** Checks that no tests exist in contract crates and fails with a helpful message if they do. */
|
|
85
|
+
async function checkNoTestsInContracts(nargo: string, log: LogFn): Promise<void> {
|
|
86
|
+
const contractPackages = await getContractPackageNames();
|
|
87
|
+
if (contractPackages.size === 0) {
|
|
88
|
+
return;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
let output: string;
|
|
92
|
+
try {
|
|
93
|
+
// We list tests for all the crates in the workspace
|
|
94
|
+
output = execFileSync(nargo, ['test', '--list-tests', '--silence-warnings'], {
|
|
95
|
+
encoding: 'utf-8',
|
|
96
|
+
stdio: ['pipe', 'pipe', 'inherit'],
|
|
97
|
+
});
|
|
98
|
+
} catch {
|
|
99
|
+
// If listing tests fails (e.g. test crate has compile errors), skip the check.
|
|
100
|
+
return;
|
|
101
|
+
}
|
|
102
|
+
|
|
103
|
+
// The output of the `nargo test --list-tests` command is as follows:
|
|
104
|
+
// ```
|
|
105
|
+
// crate_name_1 test_name_1
|
|
106
|
+
// crate_name_2 test_name_2
|
|
107
|
+
// ...
|
|
108
|
+
// crate_name_n test_name_n
|
|
109
|
+
// ```
|
|
110
|
+
//
|
|
111
|
+
// We parse the individual lines and then we check if any contract crate appeared in the parsed output.
|
|
112
|
+
const lines = output
|
|
113
|
+
.trim()
|
|
114
|
+
.split('\n')
|
|
115
|
+
.filter(line => line.length > 0);
|
|
116
|
+
const testsInContracts: { packageName: string; testName: string }[] = [];
|
|
117
|
+
|
|
118
|
+
for (const line of lines) {
|
|
119
|
+
const spaceIndex = line.indexOf(' ');
|
|
120
|
+
if (spaceIndex === -1) {
|
|
121
|
+
continue;
|
|
122
|
+
}
|
|
123
|
+
const packageName = line.substring(0, spaceIndex);
|
|
124
|
+
const testName = line.substring(spaceIndex + 1);
|
|
125
|
+
if (contractPackages.has(packageName)) {
|
|
126
|
+
testsInContracts.push({ packageName, testName });
|
|
127
|
+
}
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
if (testsInContracts.length > 0) {
|
|
131
|
+
const details = testsInContracts.map(t => ` ${t.packageName}::${t.testName}`).join('\n');
|
|
132
|
+
log(
|
|
133
|
+
`WARNING: Found tests in contract crate(s):\n${details}\n\n` +
|
|
134
|
+
`Tests should be in a dedicated test crate, not in the contract crate.\n` +
|
|
135
|
+
`Learn more: https://docs.aztec.network/errors/1`,
|
|
136
|
+
);
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
/** Compiles Aztec Noir contracts and postprocesses artifacts. */
|
|
141
|
+
async function compileAztecContract(nargoArgs: string[], log: LogFn): Promise<void> {
|
|
142
|
+
if (!(await needsRecompile())) {
|
|
143
|
+
log('No source changes detected, skipping compilation.');
|
|
144
|
+
return;
|
|
145
|
+
}
|
|
146
|
+
|
|
147
|
+
const nargo = process.env.NARGO ?? 'nargo';
|
|
148
|
+
const bb = process.env.BB ?? findBbBinary() ?? 'bb';
|
|
149
|
+
|
|
150
|
+
await run(nargo, ['compile', ...nargoArgs]);
|
|
151
|
+
|
|
152
|
+
// Ensure contract crates contain no tests (tests belong in the test crate).
|
|
153
|
+
await checkNoTestsInContracts(nargo, log);
|
|
154
|
+
|
|
155
|
+
const artifacts = await collectContractArtifacts();
|
|
156
|
+
|
|
157
|
+
if (artifacts.length > 0) {
|
|
158
|
+
log('Postprocessing contracts...');
|
|
159
|
+
const bbArgs = artifacts.flatMap(a => ['-i', a]);
|
|
160
|
+
await run(bb, ['aztec_process', ...bbArgs]);
|
|
161
|
+
|
|
162
|
+
// TODO: This should be part of bb aztec_process!
|
|
163
|
+
await stripInternalPrefixes(artifacts);
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
log('Compilation complete!');
|
|
167
|
+
}
|
|
168
|
+
|
|
169
|
+
export function injectCompileCommand(program: Command, log: LogFn): Command {
|
|
170
|
+
program
|
|
171
|
+
.command('compile')
|
|
172
|
+
.argument('[nargo-args...]')
|
|
173
|
+
.passThroughOptions()
|
|
174
|
+
.allowUnknownOption()
|
|
175
|
+
.description(
|
|
176
|
+
'Compile Aztec Noir contracts using nargo and postprocess them to generate transpiled artifacts and verification keys. All options are forwarded to nargo compile.',
|
|
177
|
+
)
|
|
178
|
+
.addHelpText('after', () => {
|
|
179
|
+
// Show nargo's own compile options so users see all available flags in one place.
|
|
180
|
+
const nargo = process.env.NARGO ?? 'nargo';
|
|
181
|
+
try {
|
|
182
|
+
const output = execFileSync(nargo, ['compile', '--help'], { encoding: 'utf-8' });
|
|
183
|
+
return `\nUnderlying nargo compile options:\n\n${output}`;
|
|
184
|
+
} catch {
|
|
185
|
+
return '\n(Run "nargo compile --help" to see available nargo options)';
|
|
186
|
+
}
|
|
187
|
+
})
|
|
188
|
+
.action((nargoArgs: string[]) => compileAztecContract(nargoArgs, log));
|
|
189
|
+
|
|
190
|
+
return program;
|
|
191
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type { LogFn } from '@aztec/foundation/log';
|
|
2
|
+
|
|
3
|
+
import type { Command } from 'commander';
|
|
4
|
+
|
|
5
|
+
import { profileFlamegraph } from './profile_flamegraph.js';
|
|
6
|
+
import { profileGates } from './profile_gates.js';
|
|
7
|
+
|
|
8
|
+
export function injectProfileCommand(program: Command, log: LogFn): Command {
|
|
9
|
+
const profile = program.command('profile').description('Profile compiled Aztec artifacts.');
|
|
10
|
+
|
|
11
|
+
profile
|
|
12
|
+
.command('gates')
|
|
13
|
+
.argument('[target-dir]', 'Path to the compiled artifacts directory', './target')
|
|
14
|
+
.description('Display gate counts for all compiled Aztec artifacts in a target directory.')
|
|
15
|
+
.action((targetDir: string) => profileGates(targetDir, log));
|
|
16
|
+
|
|
17
|
+
profile
|
|
18
|
+
.command('flamegraph')
|
|
19
|
+
.argument('<contract-artifact>', 'Path to the compiled contract artifact JSON')
|
|
20
|
+
.argument('<function>', 'Name of the contract function to profile')
|
|
21
|
+
.description('Generate a gate count flamegraph SVG for a contract function.')
|
|
22
|
+
.action((artifactPath: string, functionName: string) => profileFlamegraph(artifactPath, functionName, log));
|
|
23
|
+
|
|
24
|
+
return program;
|
|
25
|
+
}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { findBbBinary } from '@aztec/bb.js';
|
|
2
|
+
import type { LogFn } from '@aztec/foundation/log';
|
|
3
|
+
|
|
4
|
+
import { readFile, rename, rm, writeFile } from 'fs/promises';
|
|
5
|
+
import { basename, dirname, join } from 'path';
|
|
6
|
+
|
|
7
|
+
import { makeFunctionArtifact } from './profile_utils.js';
|
|
8
|
+
import type { CompiledArtifact } from './utils/artifacts.js';
|
|
9
|
+
import { run } from './utils/spawn.js';
|
|
10
|
+
|
|
11
|
+
/** Generates a gate count flamegraph SVG for a single contract function. */
|
|
12
|
+
export async function profileFlamegraph(artifactPath: string, functionName: string, log: LogFn): Promise<void> {
|
|
13
|
+
const raw = await readFile(artifactPath, 'utf-8');
|
|
14
|
+
const artifact: CompiledArtifact = JSON.parse(raw);
|
|
15
|
+
|
|
16
|
+
if (!Array.isArray(artifact.functions)) {
|
|
17
|
+
throw new Error(`${artifactPath} does not appear to be a contract artifact (no functions array)`);
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
const func = artifact.functions.find(f => f.name === functionName);
|
|
21
|
+
if (!func) {
|
|
22
|
+
const available = artifact.functions.map(f => f.name).join(', ');
|
|
23
|
+
throw new Error(`Function "${functionName}" not found in artifact. Available: ${available}`);
|
|
24
|
+
}
|
|
25
|
+
if (func.is_unconstrained) {
|
|
26
|
+
throw new Error(`Function "${functionName}" is unconstrained and cannot be profiled`);
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
const outputDir = dirname(artifactPath);
|
|
30
|
+
const contractName = basename(artifactPath, '.json');
|
|
31
|
+
const functionArtifact = join(outputDir, `${contractName}-${functionName}.json`);
|
|
32
|
+
|
|
33
|
+
try {
|
|
34
|
+
await writeFile(functionArtifact, makeFunctionArtifact(artifact, func));
|
|
35
|
+
|
|
36
|
+
const profiler = process.env.PROFILER_PATH ?? 'noir-profiler';
|
|
37
|
+
const bb = process.env.BB ?? findBbBinary() ?? 'bb';
|
|
38
|
+
|
|
39
|
+
await run(profiler, [
|
|
40
|
+
'gates',
|
|
41
|
+
'--artifact-path',
|
|
42
|
+
functionArtifact,
|
|
43
|
+
'--backend-path',
|
|
44
|
+
bb,
|
|
45
|
+
'--backend-gates-command',
|
|
46
|
+
'gates',
|
|
47
|
+
'--output',
|
|
48
|
+
outputDir,
|
|
49
|
+
'--scheme',
|
|
50
|
+
'chonk',
|
|
51
|
+
'--include_gates_per_opcode',
|
|
52
|
+
]);
|
|
53
|
+
|
|
54
|
+
// noir-profiler names the SVG using the internal function name which
|
|
55
|
+
// retains the __aztec_nr_internals__ prefix in the bytecode metadata.
|
|
56
|
+
const srcSvg = join(outputDir, `__aztec_nr_internals__${functionName}_gates.svg`);
|
|
57
|
+
const destSvg = join(outputDir, `${contractName}-${functionName}-flamegraph.svg`);
|
|
58
|
+
await rename(srcSvg, destSvg);
|
|
59
|
+
|
|
60
|
+
log(`Flamegraph written to ${destSvg}`);
|
|
61
|
+
} finally {
|
|
62
|
+
await rm(functionArtifact, { force: true });
|
|
63
|
+
}
|
|
64
|
+
}
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { findBbBinary } from '@aztec/bb.js';
|
|
2
|
+
import { asyncPool } from '@aztec/foundation/async-pool';
|
|
3
|
+
import type { LogFn } from '@aztec/foundation/log';
|
|
4
|
+
|
|
5
|
+
import { execFile as execFileCb } from 'child_process';
|
|
6
|
+
import { rm } from 'fs/promises';
|
|
7
|
+
import { promisify } from 'util';
|
|
8
|
+
|
|
9
|
+
import { MAX_CONCURRENT, discoverArtifacts } from './profile_utils.js';
|
|
10
|
+
|
|
11
|
+
const execFile = promisify(execFileCb);
|
|
12
|
+
|
|
13
|
+
interface GateCountResult {
|
|
14
|
+
name: string;
|
|
15
|
+
gateCount: number;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
/** Parses circuit_size from bb gates JSON output: { "functions": [{ "circuit_size": N }] } */
|
|
19
|
+
function parseGateCount(stdout: string): number {
|
|
20
|
+
const parsed = JSON.parse(stdout);
|
|
21
|
+
const size = parsed?.functions?.[0]?.circuit_size;
|
|
22
|
+
if (typeof size !== 'number') {
|
|
23
|
+
throw new Error('Failed to parse circuit_size from bb gates output');
|
|
24
|
+
}
|
|
25
|
+
return size;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
/** Runs bb gates on a single artifact file and returns the gate count. */
|
|
29
|
+
async function getGateCount(bb: string, artifactPath: string): Promise<number> {
|
|
30
|
+
const { stdout } = await execFile(bb, ['gates', '--scheme', 'chonk', '-b', artifactPath]);
|
|
31
|
+
return parseGateCount(stdout);
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/** Profiles all compiled artifacts in a target directory and prints gate counts. */
|
|
35
|
+
export async function profileGates(targetDir: string, log: LogFn): Promise<void> {
|
|
36
|
+
const bb = process.env.BB ?? findBbBinary() ?? 'bb';
|
|
37
|
+
const { artifacts, tmpDir } = await discoverArtifacts(targetDir);
|
|
38
|
+
|
|
39
|
+
if (artifacts.length === 0) {
|
|
40
|
+
log('No artifacts found in target directory.');
|
|
41
|
+
return;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
try {
|
|
45
|
+
const results: GateCountResult[] = await asyncPool(MAX_CONCURRENT, artifacts, async artifact => ({
|
|
46
|
+
name: artifact.name,
|
|
47
|
+
gateCount: await getGateCount(bb, artifact.filePath),
|
|
48
|
+
}));
|
|
49
|
+
results.sort((a, b) => a.name.localeCompare(b.name));
|
|
50
|
+
|
|
51
|
+
if (results.length === 0) {
|
|
52
|
+
log('No constrained circuits found.');
|
|
53
|
+
return;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
const maxNameLen = Math.max(...results.map(r => r.name.length));
|
|
57
|
+
log('');
|
|
58
|
+
log('Gate counts:');
|
|
59
|
+
log('-'.repeat(maxNameLen + 16));
|
|
60
|
+
for (const { name, gateCount } of results) {
|
|
61
|
+
log(`${name.padEnd(maxNameLen)} ${gateCount.toLocaleString().padStart(12)}`);
|
|
62
|
+
}
|
|
63
|
+
log('-'.repeat(maxNameLen + 16));
|
|
64
|
+
log(`Total: ${results.length} circuit(s)`);
|
|
65
|
+
} finally {
|
|
66
|
+
await rm(tmpDir, { recursive: true, force: true });
|
|
67
|
+
}
|
|
68
|
+
}
|
|
@@ -0,0 +1,58 @@
|
|
|
1
|
+
import { mkdtemp, writeFile } from 'fs/promises';
|
|
2
|
+
import { tmpdir } from 'os';
|
|
3
|
+
import { join } from 'path';
|
|
4
|
+
|
|
5
|
+
import type { CompiledArtifact, ContractFunction } from './utils/artifacts.js';
|
|
6
|
+
import { readArtifactFiles } from './utils/artifacts.js';
|
|
7
|
+
|
|
8
|
+
export const MAX_CONCURRENT = 4;
|
|
9
|
+
|
|
10
|
+
export interface DiscoveredArtifact {
|
|
11
|
+
name: string;
|
|
12
|
+
filePath: string;
|
|
13
|
+
type: 'contract-function' | 'program';
|
|
14
|
+
}
|
|
15
|
+
|
|
16
|
+
/**
|
|
17
|
+
* Reads a target directory and returns a list of discovered artifacts with temp files
|
|
18
|
+
* created for contract functions. Caller must clean up tmpDir when done.
|
|
19
|
+
*/
|
|
20
|
+
export async function discoverArtifacts(
|
|
21
|
+
targetDir: string,
|
|
22
|
+
): Promise<{ artifacts: DiscoveredArtifact[]; tmpDir: string }> {
|
|
23
|
+
const files = await readArtifactFiles(targetDir);
|
|
24
|
+
const tmpDir = await mkdtemp(join(tmpdir(), 'aztec-profile-'));
|
|
25
|
+
const artifacts: DiscoveredArtifact[] = [];
|
|
26
|
+
|
|
27
|
+
for (const file of files) {
|
|
28
|
+
if (Array.isArray(file.content.functions)) {
|
|
29
|
+
for (const func of file.content.functions) {
|
|
30
|
+
if (!func.bytecode || func.is_unconstrained) {
|
|
31
|
+
continue;
|
|
32
|
+
}
|
|
33
|
+
const name = `${file.name}::${func.name}`;
|
|
34
|
+
const tmpPath = join(tmpDir, `${file.name}-${func.name}.json`);
|
|
35
|
+
await writeFile(tmpPath, makeFunctionArtifact(file.content, func));
|
|
36
|
+
artifacts.push({ name, filePath: tmpPath, type: 'contract-function' });
|
|
37
|
+
}
|
|
38
|
+
} else if (file.content.bytecode) {
|
|
39
|
+
artifacts.push({ name: file.name, filePath: file.filePath, type: 'program' });
|
|
40
|
+
}
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
return { artifacts, tmpDir };
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
/** Extracts a contract function as a standalone program artifact JSON string. */
|
|
47
|
+
export function makeFunctionArtifact(artifact: CompiledArtifact, func: ContractFunction) {
|
|
48
|
+
/* eslint-disable camelcase */
|
|
49
|
+
return JSON.stringify({
|
|
50
|
+
noir_version: artifact.noir_version,
|
|
51
|
+
hash: 0,
|
|
52
|
+
abi: func.abi,
|
|
53
|
+
bytecode: func.bytecode,
|
|
54
|
+
debug_symbols: func.debug_symbols,
|
|
55
|
+
file_map: artifact.file_map,
|
|
56
|
+
});
|
|
57
|
+
/* eslint-enable camelcase */
|
|
58
|
+
}
|
|
@@ -0,0 +1,132 @@
|
|
|
1
|
+
import { getInitialTestAccountsData } from '@aztec/accounts/testing';
|
|
2
|
+
import type { Fr } from '@aztec/aztec.js/fields';
|
|
3
|
+
import { getSponsoredFPCAddress } from '@aztec/cli/cli-utils';
|
|
4
|
+
import { getPublicClient } from '@aztec/ethereum/client';
|
|
5
|
+
import type { GenesisStateConfig } from '@aztec/ethereum/config';
|
|
6
|
+
import { RegistryContract, RollupContract } from '@aztec/ethereum/contracts';
|
|
7
|
+
import type { EthAddress } from '@aztec/foundation/eth-address';
|
|
8
|
+
import { startHttpRpcServer } from '@aztec/foundation/json-rpc/server';
|
|
9
|
+
import type { LogFn } from '@aztec/foundation/log';
|
|
10
|
+
import { retryUntil } from '@aztec/foundation/retry';
|
|
11
|
+
import { AztecAddress } from '@aztec/stdlib/aztec-address';
|
|
12
|
+
import { getGenesisValues } from '@aztec/world-state/testing';
|
|
13
|
+
|
|
14
|
+
import Koa from 'koa';
|
|
15
|
+
|
|
16
|
+
const ROLLUP_POLL_INTERVAL_S = 60;
|
|
17
|
+
|
|
18
|
+
/**
|
|
19
|
+
* Computes the expected genesis archive root from the genesis state config.
|
|
20
|
+
* Reads test accounts and sponsored FPC addresses as specified, then computes
|
|
21
|
+
* the genesis values including the archive root and prefilled public data.
|
|
22
|
+
*/
|
|
23
|
+
export async function computeExpectedGenesisRoot(config: GenesisStateConfig, userLog: LogFn) {
|
|
24
|
+
const testAccounts = config.testAccounts ? (await getInitialTestAccountsData()).map(a => a.address) : [];
|
|
25
|
+
const sponsoredFPCAccounts = config.sponsoredFPC ? [await getSponsoredFPCAddress()] : [];
|
|
26
|
+
const prefundAddresses = (config.prefundAddresses ?? []).map(a => AztecAddress.fromString(a));
|
|
27
|
+
const initialFundedAccounts = testAccounts.concat(sponsoredFPCAccounts).concat(prefundAddresses);
|
|
28
|
+
|
|
29
|
+
userLog(`Initial funded accounts: ${initialFundedAccounts.map(a => a.toString()).join(', ')}`);
|
|
30
|
+
|
|
31
|
+
const { genesisArchiveRoot, prefilledPublicData } = await getGenesisValues(initialFundedAccounts);
|
|
32
|
+
|
|
33
|
+
userLog(`Genesis archive root: ${genesisArchiveRoot.toString()}`);
|
|
34
|
+
|
|
35
|
+
return { genesisArchiveRoot, prefilledPublicData };
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
async function checkRollupCompatibility(
|
|
39
|
+
rollup: RollupContract,
|
|
40
|
+
expected: { genesisArchiveRoot: Fr; vkTreeRoot: Fr; protocolContractsHash: Fr },
|
|
41
|
+
): Promise<string[]> {
|
|
42
|
+
const mismatches: string[] = [];
|
|
43
|
+
const [l1Genesis, l1Vk, l1Protocol] = await Promise.all([
|
|
44
|
+
rollup.getGenesisArchiveTreeRoot(),
|
|
45
|
+
rollup.getVkTreeRoot(),
|
|
46
|
+
rollup.getProtocolContractsHash(),
|
|
47
|
+
]);
|
|
48
|
+
if (!l1Genesis.equals(expected.genesisArchiveRoot)) {
|
|
49
|
+
mismatches.push(`genesis archive root (expected ${expected.genesisArchiveRoot}, got ${l1Genesis})`);
|
|
50
|
+
}
|
|
51
|
+
if (!l1Vk.equals(expected.vkTreeRoot)) {
|
|
52
|
+
mismatches.push(`VK tree root (expected ${expected.vkTreeRoot}, got ${l1Vk})`);
|
|
53
|
+
}
|
|
54
|
+
if (!l1Protocol.equals(expected.protocolContractsHash)) {
|
|
55
|
+
mismatches.push(`protocol contracts hash (expected ${expected.protocolContractsHash}, got ${l1Protocol})`);
|
|
56
|
+
}
|
|
57
|
+
return mismatches;
|
|
58
|
+
}
|
|
59
|
+
|
|
60
|
+
/**
|
|
61
|
+
* Waits until the canonical rollup's genesis archive root, VK tree root, and protocol contracts hash
|
|
62
|
+
* all match the expected local values. If the rollup is not yet compatible (e.g. during L1 contract upgrades),
|
|
63
|
+
* enters standby mode: starts a lightweight HTTP server for K8s liveness probes and polls every 60s
|
|
64
|
+
* until a compatible rollup appears.
|
|
65
|
+
*/
|
|
66
|
+
export async function waitForCompatibleRollup(
|
|
67
|
+
config: {
|
|
68
|
+
l1RpcUrls: string[];
|
|
69
|
+
l1ChainId: number;
|
|
70
|
+
l1Contracts: { registryAddress: EthAddress };
|
|
71
|
+
rollupVersion?: number;
|
|
72
|
+
},
|
|
73
|
+
expected: { genesisArchiveRoot: Fr; vkTreeRoot: Fr; protocolContractsHash: Fr },
|
|
74
|
+
port: number | undefined,
|
|
75
|
+
userLog: LogFn,
|
|
76
|
+
): Promise<void> {
|
|
77
|
+
const publicClient = getPublicClient(config);
|
|
78
|
+
const rollupVersion: number | 'canonical' = config.rollupVersion ?? 'canonical';
|
|
79
|
+
|
|
80
|
+
const registry = new RegistryContract(publicClient, config.l1Contracts.registryAddress);
|
|
81
|
+
const rollupAddress = await registry.getRollupAddress(rollupVersion);
|
|
82
|
+
const rollup = new RollupContract(publicClient, rollupAddress.toString());
|
|
83
|
+
|
|
84
|
+
let mismatches: string[];
|
|
85
|
+
try {
|
|
86
|
+
mismatches = await checkRollupCompatibility(rollup, expected);
|
|
87
|
+
} catch (err: any) {
|
|
88
|
+
throw new Error(`Could not retrieve rollup config from canonical rollup at ${rollupAddress}: ${err.message}`);
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
if (mismatches.length === 0) {
|
|
92
|
+
return;
|
|
93
|
+
}
|
|
94
|
+
|
|
95
|
+
userLog(
|
|
96
|
+
`Rollup at ${rollupAddress} is incompatible: ${mismatches.join('; ')}. ` +
|
|
97
|
+
`Entering standby mode. Will poll every ${ROLLUP_POLL_INTERVAL_S}s for a compatible rollup...`,
|
|
98
|
+
);
|
|
99
|
+
|
|
100
|
+
const standbyServer = await startHttpRpcServer({ getApp: () => new Koa(), isHealthy: () => true }, { port });
|
|
101
|
+
userLog(`Standby status server listening on port ${standbyServer.port}`);
|
|
102
|
+
|
|
103
|
+
try {
|
|
104
|
+
await retryUntil(
|
|
105
|
+
async () => {
|
|
106
|
+
const currentRollupAddress = await registry.getRollupAddress(rollupVersion);
|
|
107
|
+
const currentRollup = new RollupContract(publicClient, currentRollupAddress.toString());
|
|
108
|
+
|
|
109
|
+
let currentMismatches: string[];
|
|
110
|
+
try {
|
|
111
|
+
currentMismatches = await checkRollupCompatibility(currentRollup, expected);
|
|
112
|
+
} catch {
|
|
113
|
+
userLog(`Failed to fetch rollup config from rollup at ${currentRollupAddress}. Retrying...`);
|
|
114
|
+
return undefined;
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
if (currentMismatches.length === 0) {
|
|
118
|
+
userLog(`Compatible rollup found at ${currentRollupAddress}. Exiting standby mode.`);
|
|
119
|
+
return true;
|
|
120
|
+
}
|
|
121
|
+
|
|
122
|
+
userLog(`Still waiting. Rollup at ${currentRollupAddress}: ${currentMismatches.join('; ')}.`);
|
|
123
|
+
return undefined;
|
|
124
|
+
},
|
|
125
|
+
'compatible rollup',
|
|
126
|
+
0,
|
|
127
|
+
ROLLUP_POLL_INTERVAL_S,
|
|
128
|
+
);
|
|
129
|
+
} finally {
|
|
130
|
+
await new Promise<void>((resolve, reject) => standbyServer.close(err => (err ? reject(err) : resolve())));
|
|
131
|
+
}
|
|
132
|
+
}
|
|
@@ -3,8 +3,8 @@ import { createLogger } from '@aztec/aztec.js/log';
|
|
|
3
3
|
import { type BlobClientConfig, blobClientConfigMapping, createBlobClient } from '@aztec/blob-client/client';
|
|
4
4
|
import { getL1Config } from '@aztec/cli/config';
|
|
5
5
|
import type { NamespacedApiHandlers } from '@aztec/foundation/json-rpc/server';
|
|
6
|
-
import { type DataStoreConfig, dataConfigMappings } from '@aztec/kv-store/config';
|
|
7
6
|
import { ArchiverApiSchema } from '@aztec/stdlib/interfaces/server';
|
|
7
|
+
import { type DataStoreConfig, dataConfigMappings } from '@aztec/stdlib/kv-store';
|
|
8
8
|
import { getConfigEnvVars as getTelemetryClientConfig, initTelemetryClient } from '@aztec/telemetry-client';
|
|
9
9
|
|
|
10
10
|
import { extractRelevantOptions } from '../util.js';
|