@aztec/aztec 0.0.1-commit.ff7989d6c → 0.0.1-commit.fff30aa
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 +4 -2
- 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 +27 -9
- package/dest/cli/aztec_start_options.d.ts +1 -1
- package/dest/cli/aztec_start_options.d.ts.map +1 -1
- package/dest/cli/aztec_start_options.js +14 -2
- package/dest/cli/cli.js +3 -3
- package/dest/cli/cmds/compile.d.ts +1 -1
- package/dest/cli/cmds/compile.d.ts.map +1 -1
- package/dest/cli/cmds/compile.js +109 -36
- 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_node.d.ts +3 -2
- package/dest/cli/cmds/start_node.d.ts.map +1 -1
- package/dest/cli/cmds/start_node.js +24 -32
- package/dest/cli/cmds/start_prover_agent.d.ts +1 -1
- package/dest/cli/cmds/start_prover_agent.d.ts.map +1 -1
- package/dest/cli/cmds/start_prover_agent.js +3 -15
- 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/collect_crate_dirs.d.ts +21 -0
- package/dest/cli/cmds/utils/collect_crate_dirs.d.ts.map +1 -0
- package/dest/cli/cmds/utils/collect_crate_dirs.js +114 -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 +90 -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/cmds/utils/warn_if_aztec_version_mismatch.d.ts +4 -0
- package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.d.ts.map +1 -0
- package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.js +62 -0
- package/dest/cli/util.d.ts +3 -5
- package/dest/cli/util.d.ts.map +1 -1
- package/dest/cli/util.js +37 -78
- 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 +18 -5
- package/dest/testing/anvil_test_watcher.d.ts +1 -1
- package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
- package/dest/testing/anvil_test_watcher.js +36 -10
- package/dest/testing/cheat_codes.d.ts +11 -15
- package/dest/testing/cheat_codes.d.ts.map +1 -1
- package/dest/testing/cheat_codes.js +34 -32
- 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 +35 -34
- package/scripts/add_crate.sh +102 -0
- package/scripts/aztec.sh +9 -1
- package/scripts/init.sh +23 -19
- package/scripts/new.sh +48 -24
- package/scripts/setup_workspace.sh +68 -0
- package/src/bin/index.ts +4 -2
- package/src/cli/aztec_start_action.ts +16 -9
- package/src/cli/aztec_start_options.ts +14 -2
- package/src/cli/cli.ts +3 -3
- package/src/cli/cmds/compile.ts +124 -37
- 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_node.ts +39 -31
- package/src/cli/cmds/start_prover_agent.ts +3 -6
- package/src/cli/cmds/start_prover_broker.ts +14 -14
- package/src/cli/cmds/utils/artifacts.ts +44 -0
- package/src/cli/cmds/utils/collect_crate_dirs.ts +118 -0
- package/src/cli/cmds/utils/needs_recompile.ts +98 -0
- package/src/cli/cmds/utils/spawn.ts +16 -0
- package/src/cli/cmds/utils/warn_if_aztec_version_mismatch.ts +77 -0
- package/src/cli/util.ts +41 -74
- package/src/examples/token.ts +6 -4
- package/src/local-network/banana_fpc.ts +1 -1
- package/src/local-network/local-network.ts +13 -3
- package/src/testing/anvil_test_watcher.ts +33 -10
- package/src/testing/cheat_codes.ts +42 -36
- 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/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
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
#!/usr/bin/env bash
|
|
2
|
+
set -euo pipefail
|
|
3
|
+
|
|
4
|
+
# Creates an Aztec contract workspace with a contract crate and a test crate.
|
|
5
|
+
# Usage: setup_workspace.sh <package_name>
|
|
6
|
+
# Must be called from the workspace root directory.
|
|
7
|
+
|
|
8
|
+
package_name=$1
|
|
9
|
+
script_path=$(realpath $(dirname "$0"))
|
|
10
|
+
|
|
11
|
+
if [ -z "$package_name" ]; then
|
|
12
|
+
echo "Error: package name is required"
|
|
13
|
+
exit 1
|
|
14
|
+
fi
|
|
15
|
+
|
|
16
|
+
if [ -f "Nargo.toml" ]; then
|
|
17
|
+
echo "Error: Nargo.toml already exists in the current directory."
|
|
18
|
+
echo "To add another contract crate to this workspace, use 'aztec new <name>' instead."
|
|
19
|
+
exit 1
|
|
20
|
+
fi
|
|
21
|
+
|
|
22
|
+
# Create workspace root Nargo.toml with empty members (add_crate.sh will populate)
|
|
23
|
+
cat > Nargo.toml << 'EOF'
|
|
24
|
+
[workspace]
|
|
25
|
+
members = []
|
|
26
|
+
EOF
|
|
27
|
+
|
|
28
|
+
# Create the first crate pair
|
|
29
|
+
$script_path/add_crate.sh "$package_name"
|
|
30
|
+
|
|
31
|
+
# Create README
|
|
32
|
+
cat > README.md << REOF
|
|
33
|
+
# ${package_name}
|
|
34
|
+
|
|
35
|
+
An Aztec Noir contract project.
|
|
36
|
+
|
|
37
|
+
## Compile
|
|
38
|
+
|
|
39
|
+
\`\`\`bash
|
|
40
|
+
aztec compile
|
|
41
|
+
\`\`\`
|
|
42
|
+
|
|
43
|
+
This compiles all contract crates and outputs artifacts to \`target/\`.
|
|
44
|
+
|
|
45
|
+
## Test
|
|
46
|
+
|
|
47
|
+
\`\`\`bash
|
|
48
|
+
aztec test
|
|
49
|
+
\`\`\`
|
|
50
|
+
|
|
51
|
+
This runs all tests in the workspace.
|
|
52
|
+
|
|
53
|
+
## Generate TypeScript bindings
|
|
54
|
+
|
|
55
|
+
\`\`\`bash
|
|
56
|
+
aztec codegen target -o src/artifacts
|
|
57
|
+
\`\`\`
|
|
58
|
+
|
|
59
|
+
This generates TypeScript contract artifacts from the compiled output in \`target/\` into \`src/artifacts/\`.
|
|
60
|
+
REOF
|
|
61
|
+
|
|
62
|
+
# Create .gitignore
|
|
63
|
+
cat > .gitignore << 'GEOF'
|
|
64
|
+
target/
|
|
65
|
+
codegenCache.json
|
|
66
|
+
GEOF
|
|
67
|
+
|
|
68
|
+
echo "Created Aztec contract workspace with crates '${package_name}_contract' and '${package_name}_test'"
|
package/src/bin/index.ts
CHANGED
|
@@ -11,13 +11,14 @@ import { injectCommands as injectMiscCommands } from '@aztec/cli/misc';
|
|
|
11
11
|
import { injectCommands as injectValidatorKeysCommands } from '@aztec/cli/validator_keys';
|
|
12
12
|
import { getActiveNetworkName } from '@aztec/foundation/config';
|
|
13
13
|
import { createConsoleLogger, createLogger } from '@aztec/foundation/log';
|
|
14
|
+
import { getPackageVersion } from '@aztec/stdlib/update-checker';
|
|
14
15
|
|
|
15
16
|
import { Command } from 'commander';
|
|
16
17
|
|
|
17
18
|
import { injectCompileCommand } from '../cli/cmds/compile.js';
|
|
18
19
|
import { injectMigrateCommand } from '../cli/cmds/migrate_ha_db.js';
|
|
20
|
+
import { injectProfileCommand } from '../cli/cmds/profile.js';
|
|
19
21
|
import { injectAztecCommands } from '../cli/index.js';
|
|
20
|
-
import { getCliVersion } from '../cli/release_version.js';
|
|
21
22
|
|
|
22
23
|
const NETWORK_FLAG = 'network';
|
|
23
24
|
|
|
@@ -46,7 +47,7 @@ async function main() {
|
|
|
46
47
|
await enrichEnvironmentWithNetworkConfig(networkName);
|
|
47
48
|
enrichEnvironmentWithChainName(networkName);
|
|
48
49
|
|
|
49
|
-
const cliVersion =
|
|
50
|
+
const cliVersion = getPackageVersion() ?? 'unknown';
|
|
50
51
|
let program = new Command('aztec');
|
|
51
52
|
program.description('Aztec command line interface').version(cliVersion).enablePositionalOptions();
|
|
52
53
|
program = injectAztecCommands(program, userLog, debugLogger);
|
|
@@ -58,6 +59,7 @@ async function main() {
|
|
|
58
59
|
program = injectMiscCommands(program, userLog);
|
|
59
60
|
program = injectValidatorKeysCommands(program, userLog);
|
|
60
61
|
program = injectCompileCommand(program, userLog);
|
|
62
|
+
program = injectProfileCommand(program, userLog);
|
|
61
63
|
program = injectMigrateCommand(program, userLog);
|
|
62
64
|
|
|
63
65
|
await program.parseAsync(process.argv);
|
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { getActiveNetworkName } from '@aztec/foundation/config';
|
|
1
2
|
import {
|
|
2
3
|
type NamespacedApiHandlers,
|
|
3
4
|
createNamespacedSafeJsonRpcServer,
|
|
@@ -6,14 +7,14 @@ import {
|
|
|
6
7
|
} from '@aztec/foundation/json-rpc/server';
|
|
7
8
|
import type { LogFn, Logger } from '@aztec/foundation/log';
|
|
8
9
|
import type { ChainConfig } from '@aztec/stdlib/config';
|
|
9
|
-
import { AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
|
|
10
|
+
import { AztecNodeAdminApiSchema, AztecNodeApiSchema, AztecNodeDebugApiSchema } from '@aztec/stdlib/interfaces/client';
|
|
11
|
+
import { getPackageVersion } from '@aztec/stdlib/update-checker';
|
|
10
12
|
import { getVersioningMiddleware } from '@aztec/stdlib/versioning';
|
|
11
13
|
import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
|
|
12
14
|
|
|
13
15
|
import { createLocalNetwork } from '../local-network/index.js';
|
|
14
16
|
import { github, splash } from '../splash.js';
|
|
15
17
|
import { resolveAdminApiKey } from './admin_api_key_store.js';
|
|
16
|
-
import { getCliVersion } from './release_version.js';
|
|
17
18
|
import { extractNamespacedOptions, installSignalHandlers } from './util.js';
|
|
18
19
|
import { getVersions } from './versioning.js';
|
|
19
20
|
|
|
@@ -22,14 +23,13 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
22
23
|
const signalHandlers: Array<() => Promise<void>> = [];
|
|
23
24
|
const services: NamespacedApiHandlers = {};
|
|
24
25
|
const adminServices: NamespacedApiHandlers = {};
|
|
26
|
+
const packageVersion = getPackageVersion();
|
|
25
27
|
let config: ChainConfig | undefined = undefined;
|
|
26
28
|
|
|
27
29
|
if (options.localNetwork) {
|
|
28
|
-
const
|
|
29
|
-
const localNetwork = extractNamespacedOptions(options, 'local-network');
|
|
30
|
-
localNetwork.testAccounts = true;
|
|
30
|
+
const localNetwork = extractNamespacedOptions(options, 'localNetwork');
|
|
31
31
|
userLog(`${splash}\n${github}\n\n`);
|
|
32
|
-
userLog(`Setting up Aztec local network ${
|
|
32
|
+
userLog(`Setting up Aztec local network ${packageVersion ?? 'unknown'}, please stand by...`);
|
|
33
33
|
|
|
34
34
|
const { node, stop } = await createLocalNetwork(
|
|
35
35
|
{
|
|
@@ -49,6 +49,8 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
49
49
|
// Start Node and PXE JSON-RPC server
|
|
50
50
|
signalHandlers.push(stop);
|
|
51
51
|
services.node = [node, AztecNodeApiSchema];
|
|
52
|
+
adminServices.node = [node, AztecNodeAdminApiSchema];
|
|
53
|
+
services.nodeDebug = [node, AztecNodeDebugApiSchema];
|
|
52
54
|
} else {
|
|
53
55
|
// Route --prover-node through startNode
|
|
54
56
|
if (options.proverNode && !options.node) {
|
|
@@ -57,7 +59,11 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
57
59
|
|
|
58
60
|
if (options.node) {
|
|
59
61
|
const { startNode } = await import('./cmds/start_node.js');
|
|
60
|
-
|
|
62
|
+
const networkName = getActiveNetworkName(options.network);
|
|
63
|
+
({ config } = await startNode(options, signalHandlers, services, adminServices, userLog, networkName));
|
|
64
|
+
if (options.nodeDebug && services.node) {
|
|
65
|
+
services.nodeDebug = [services.node[0], AztecNodeDebugApiSchema];
|
|
66
|
+
}
|
|
61
67
|
} else if (options.bot) {
|
|
62
68
|
const { startBot } = await import('./cmds/start_bot.js');
|
|
63
69
|
await startBot(options, signalHandlers, services, userLog);
|
|
@@ -87,13 +93,14 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
87
93
|
|
|
88
94
|
installSignalHandlers(debugLogger.info, signalHandlers);
|
|
89
95
|
const versions = getVersions(config);
|
|
96
|
+
const versioningOpts = { packageVersion };
|
|
90
97
|
|
|
91
98
|
// Start the main JSON-RPC server
|
|
92
99
|
if (Object.entries(services).length > 0) {
|
|
93
100
|
const rpcServer = createNamespacedSafeJsonRpcServer(services, {
|
|
94
101
|
http200OnError: false,
|
|
95
102
|
log: debugLogger,
|
|
96
|
-
middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)],
|
|
103
|
+
middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions, versioningOpts)],
|
|
97
104
|
maxBatchSize: options.rpcMaxBatchSize,
|
|
98
105
|
maxBodySizeBytes: options.rpcMaxBodySize,
|
|
99
106
|
});
|
|
@@ -103,7 +110,7 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
103
110
|
|
|
104
111
|
// If there are any admin services, start a separate JSON-RPC server for them
|
|
105
112
|
if (Object.entries(adminServices).length > 0) {
|
|
106
|
-
const adminMiddlewares = [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)];
|
|
113
|
+
const adminMiddlewares = [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions, versioningOpts)];
|
|
107
114
|
|
|
108
115
|
// Resolve the admin API key (auto-generated and persisted, or opt-out)
|
|
109
116
|
const apiKeyResolution = await resolveAdminApiKey(
|
|
@@ -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),
|
|
@@ -126,6 +125,12 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
126
125
|
defaultValue: DefaultMnemonic,
|
|
127
126
|
env: 'MNEMONIC',
|
|
128
127
|
},
|
|
128
|
+
{
|
|
129
|
+
flag: '--local-network.testAccounts',
|
|
130
|
+
description: 'Deploy test accounts on local network start',
|
|
131
|
+
env: 'TEST_ACCOUNTS',
|
|
132
|
+
...booleanConfigHelper(true),
|
|
133
|
+
},
|
|
129
134
|
],
|
|
130
135
|
API: [
|
|
131
136
|
{
|
|
@@ -166,6 +171,13 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
166
171
|
env: 'AZTEC_RESET_ADMIN_API_KEY',
|
|
167
172
|
parseVal: val => val === 'true' || val === '1',
|
|
168
173
|
},
|
|
174
|
+
{
|
|
175
|
+
flag: '--node-debug',
|
|
176
|
+
description: 'Expose debug endpoints (e.g. mineBlock) on the main RPC port',
|
|
177
|
+
defaultValue: false,
|
|
178
|
+
env: 'AZTEC_NODE_DEBUG',
|
|
179
|
+
parseVal: val => val === undefined || val === 'true' || val === '1',
|
|
180
|
+
},
|
|
169
181
|
{
|
|
170
182
|
flag: '--api-prefix <value>',
|
|
171
183
|
description: 'Prefix for API routes on any service that is started',
|
package/src/cli/cli.ts
CHANGED
|
@@ -37,9 +37,9 @@ export function injectAztecCommands(program: Command, userLog: LogFn, debugLogge
|
|
|
37
37
|
`
|
|
38
38
|
Additional commands:
|
|
39
39
|
|
|
40
|
-
init
|
|
41
|
-
new <
|
|
42
|
-
test [options]
|
|
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.
|
|
43
43
|
`,
|
|
44
44
|
);
|
|
45
45
|
}
|
package/src/cli/cmds/compile.ts
CHANGED
|
@@ -1,51 +1,28 @@
|
|
|
1
|
+
import { findBbBinary } from '@aztec/bb.js';
|
|
1
2
|
import type { LogFn } from '@aztec/foundation/log';
|
|
2
3
|
|
|
3
|
-
import { execFileSync
|
|
4
|
+
import { execFileSync } from 'child_process';
|
|
4
5
|
import type { Command } from 'commander';
|
|
5
|
-
import { readFile,
|
|
6
|
+
import { readFile, writeFile } from 'fs/promises';
|
|
6
7
|
import { join } from 'path';
|
|
7
8
|
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
child.on('error', reject);
|
|
13
|
-
child.on('close', code => {
|
|
14
|
-
if (code !== 0) {
|
|
15
|
-
reject(new Error(`${cmd} exited with code ${code}`));
|
|
16
|
-
} else {
|
|
17
|
-
resolve();
|
|
18
|
-
}
|
|
19
|
-
});
|
|
20
|
-
});
|
|
21
|
-
}
|
|
9
|
+
import { readArtifactFiles } from './utils/artifacts.js';
|
|
10
|
+
import { needsRecompile } from './utils/needs_recompile.js';
|
|
11
|
+
import { run } from './utils/spawn.js';
|
|
12
|
+
import { warnIfAztecVersionMismatch } from './utils/warn_if_aztec_version_mismatch.js';
|
|
22
13
|
|
|
23
|
-
/** Returns paths to contract artifacts in the target directory.
|
|
24
|
-
* Contract artifacts are identified by having a `functions` array in the JSON.
|
|
25
|
-
*/
|
|
14
|
+
/** Returns paths to contract artifacts in the target directory. */
|
|
26
15
|
async function collectContractArtifacts(): Promise<string[]> {
|
|
27
|
-
let files
|
|
16
|
+
let files;
|
|
28
17
|
try {
|
|
29
|
-
files = await
|
|
18
|
+
files = await readArtifactFiles('target');
|
|
30
19
|
} catch (err: any) {
|
|
31
|
-
if (err?.
|
|
20
|
+
if (err?.message?.includes('does not exist')) {
|
|
32
21
|
return [];
|
|
33
22
|
}
|
|
34
|
-
throw
|
|
23
|
+
throw err;
|
|
35
24
|
}
|
|
36
|
-
|
|
37
|
-
const artifacts: string[] = [];
|
|
38
|
-
for (const file of files) {
|
|
39
|
-
if (!file.endsWith('.json')) {
|
|
40
|
-
continue;
|
|
41
|
-
}
|
|
42
|
-
const filePath = join('target', file);
|
|
43
|
-
const content = JSON.parse(await readFile(filePath, 'utf-8'));
|
|
44
|
-
if (Array.isArray(content.functions)) {
|
|
45
|
-
artifacts.push(filePath);
|
|
46
|
-
}
|
|
47
|
-
}
|
|
48
|
-
return artifacts;
|
|
25
|
+
return files.filter(f => Array.isArray(f.content.functions)).map(f => f.filePath);
|
|
49
26
|
}
|
|
50
27
|
|
|
51
28
|
/** Strips the `__aztec_nr_internals__` prefix from function names in contract artifacts. */
|
|
@@ -61,13 +38,123 @@ async function stripInternalPrefixes(artifactPaths: string[]): Promise<void> {
|
|
|
61
38
|
}
|
|
62
39
|
}
|
|
63
40
|
|
|
41
|
+
/** Returns the set of package names that are contract crates in the current workspace. */
|
|
42
|
+
async function getContractPackageNames(): Promise<Set<string>> {
|
|
43
|
+
const contractNames = new Set<string>();
|
|
44
|
+
|
|
45
|
+
let rootToml: string;
|
|
46
|
+
try {
|
|
47
|
+
rootToml = await readFile('Nargo.toml', 'utf-8');
|
|
48
|
+
} catch {
|
|
49
|
+
return contractNames;
|
|
50
|
+
}
|
|
51
|
+
|
|
52
|
+
const membersMatch = rootToml.match(/members\s*=\s*\[([^\]]*)\]/);
|
|
53
|
+
if (membersMatch) {
|
|
54
|
+
const members = membersMatch[1]
|
|
55
|
+
.split(',')
|
|
56
|
+
.map(m => m.trim().replace(/^"|"$/g, ''))
|
|
57
|
+
.filter(m => m.length > 0);
|
|
58
|
+
|
|
59
|
+
for (const member of members) {
|
|
60
|
+
try {
|
|
61
|
+
const memberToml = await readFile(join(member, 'Nargo.toml'), 'utf-8');
|
|
62
|
+
if (/type\s*=\s*"contract"/.test(memberToml)) {
|
|
63
|
+
const nameMatch = memberToml.match(/name\s*=\s*"([^"]+)"/);
|
|
64
|
+
if (nameMatch) {
|
|
65
|
+
contractNames.add(nameMatch[1]);
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
} catch {
|
|
69
|
+
// Member directory might not exist or have no Nargo.toml; skip.
|
|
70
|
+
}
|
|
71
|
+
}
|
|
72
|
+
} else {
|
|
73
|
+
// Single-crate project (no workspace): check if the root Nargo.toml itself is a contract.
|
|
74
|
+
if (/type\s*=\s*"contract"/.test(rootToml)) {
|
|
75
|
+
const nameMatch = rootToml.match(/name\s*=\s*"([^"]+)"/);
|
|
76
|
+
if (nameMatch) {
|
|
77
|
+
contractNames.add(nameMatch[1]);
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
return contractNames;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
/** Checks that no tests exist in contract crates and fails with a helpful message if they do. */
|
|
86
|
+
async function checkNoTestsInContracts(nargo: string, log: LogFn): Promise<void> {
|
|
87
|
+
const contractPackages = await getContractPackageNames();
|
|
88
|
+
if (contractPackages.size === 0) {
|
|
89
|
+
return;
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
let output: string;
|
|
93
|
+
try {
|
|
94
|
+
// We list tests for all the crates in the workspace
|
|
95
|
+
output = execFileSync(nargo, ['test', '--list-tests', '--silence-warnings'], {
|
|
96
|
+
encoding: 'utf-8',
|
|
97
|
+
stdio: ['pipe', 'pipe', 'inherit'],
|
|
98
|
+
});
|
|
99
|
+
} catch {
|
|
100
|
+
// If listing tests fails (e.g. test crate has compile errors), skip the check.
|
|
101
|
+
return;
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
// The output of the `nargo test --list-tests` command is as follows:
|
|
105
|
+
// ```
|
|
106
|
+
// crate_name_1 test_name_1
|
|
107
|
+
// crate_name_2 test_name_2
|
|
108
|
+
// ...
|
|
109
|
+
// crate_name_n test_name_n
|
|
110
|
+
// ```
|
|
111
|
+
//
|
|
112
|
+
// We parse the individual lines and then we check if any contract crate appeared in the parsed output.
|
|
113
|
+
const lines = output
|
|
114
|
+
.trim()
|
|
115
|
+
.split('\n')
|
|
116
|
+
.filter(line => line.length > 0);
|
|
117
|
+
const testsInContracts: { packageName: string; testName: string }[] = [];
|
|
118
|
+
|
|
119
|
+
for (const line of lines) {
|
|
120
|
+
const spaceIndex = line.indexOf(' ');
|
|
121
|
+
if (spaceIndex === -1) {
|
|
122
|
+
continue;
|
|
123
|
+
}
|
|
124
|
+
const packageName = line.substring(0, spaceIndex);
|
|
125
|
+
const testName = line.substring(spaceIndex + 1);
|
|
126
|
+
if (contractPackages.has(packageName)) {
|
|
127
|
+
testsInContracts.push({ packageName, testName });
|
|
128
|
+
}
|
|
129
|
+
}
|
|
130
|
+
|
|
131
|
+
if (testsInContracts.length > 0) {
|
|
132
|
+
const details = testsInContracts.map(t => ` ${t.packageName}::${t.testName}`).join('\n');
|
|
133
|
+
log(
|
|
134
|
+
`WARNING: Found tests in contract crate(s):\n${details}\n\n` +
|
|
135
|
+
`Tests should be in a dedicated test crate, not in the contract crate.\n` +
|
|
136
|
+
`Learn more: https://docs.aztec.network/errors/1`,
|
|
137
|
+
);
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
|
|
64
141
|
/** Compiles Aztec Noir contracts and postprocesses artifacts. */
|
|
65
142
|
async function compileAztecContract(nargoArgs: string[], log: LogFn): Promise<void> {
|
|
143
|
+
await warnIfAztecVersionMismatch(log);
|
|
144
|
+
|
|
145
|
+
if (!(await needsRecompile())) {
|
|
146
|
+
log('No source changes detected, skipping compilation.');
|
|
147
|
+
return;
|
|
148
|
+
}
|
|
149
|
+
|
|
66
150
|
const nargo = process.env.NARGO ?? 'nargo';
|
|
67
|
-
const bb = process.env.BB ?? 'bb';
|
|
151
|
+
const bb = process.env.BB ?? findBbBinary() ?? 'bb';
|
|
68
152
|
|
|
69
153
|
await run(nargo, ['compile', ...nargoArgs]);
|
|
70
154
|
|
|
155
|
+
// Ensure contract crates contain no tests (tests belong in the test crate).
|
|
156
|
+
await checkNoTestsInContracts(nargo, log);
|
|
157
|
+
|
|
71
158
|
const artifacts = await collectContractArtifacts();
|
|
72
159
|
|
|
73
160
|
if (artifacts.length > 0) {
|
|
@@ -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
|
+
}
|