@aztec/aztec 0.0.1-commit.592b9384 → 0.0.1-commit.59a0419c6
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 +45 -0
- package/dest/cli/admin_api_key_store.d.ts.map +1 -0
- package/dest/cli/admin_api_key_store.js +98 -0
- 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 +73 -19
- package/dest/cli/aztec_start_options.d.ts +2 -2
- package/dest/cli/aztec_start_options.d.ts.map +1 -1
- package/dest/cli/aztec_start_options.js +38 -9
- 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 +155 -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 +4 -2
- package/dest/cli/cmds/start_bot.d.ts +3 -3
- package/dest/cli/cmds/start_bot.d.ts.map +1 -1
- package/dest/cli/cmds/start_bot.js +9 -5
- 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 +73 -31
- 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 +4 -16
- 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 +14 -8
- package/dest/cli/cmds/start_txe.d.ts +2 -2
- package/dest/cli/cmds/start_txe.d.ts.map +1 -1
- package/dest/cli/cmds/start_txe.js +4 -3
- 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 +7 -18
- package/dest/cli/util.d.ts.map +1 -1
- package/dest/cli/util.js +50 -86
- package/dest/examples/token.js +6 -6
- package/dest/local-network/banana_fpc.js +1 -1
- package/dest/local-network/local-network.d.ts +5 -4
- package/dest/local-network/local-network.d.ts.map +1 -1
- package/dest/local-network/local-network.js +53 -21
- package/dest/testing/anvil_test_watcher.d.ts +15 -3
- package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
- package/dest/testing/anvil_test_watcher.js +85 -22
- 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 +3 -2
- 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 +52 -0
- package/scripts/aztec.sh +15 -5
- package/scripts/init.sh +23 -19
- package/scripts/new.sh +48 -24
- package/scripts/setup_workspace.sh +69 -0
- package/scripts/templates/blank/contract/Nargo.toml +6 -0
- package/scripts/templates/blank/contract/src/main.nr +10 -0
- package/scripts/templates/blank/test/Nargo.toml +7 -0
- package/scripts/templates/blank/test/src/lib.nr +11 -0
- package/scripts/templates/counter/contract/Nargo.toml +7 -0
- package/scripts/templates/counter/contract/src/main.nr +48 -0
- package/scripts/templates/counter/test/Nargo.toml +7 -0
- package/scripts/templates/counter/test/src/lib.nr +32 -0
- package/src/bin/index.ts +7 -3
- package/src/cli/admin_api_key_store.ts +128 -0
- package/src/cli/aztec_start_action.ts +66 -15
- package/src/cli/aztec_start_options.ts +46 -10
- package/src/cli/cli.ts +3 -4
- package/src/cli/cmds/compile.ts +178 -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 +8 -2
- package/src/cli/cmds/start_bot.ts +8 -5
- package/src/cli/cmds/start_node.ts +83 -35
- package/src/cli/cmds/start_prover_agent.ts +5 -8
- package/src/cli/cmds/start_prover_broker.ts +19 -15
- package/src/cli/cmds/start_txe.ts +5 -3
- 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 +57 -95
- package/src/examples/token.ts +8 -6
- package/src/local-network/banana_fpc.ts +1 -1
- package/src/local-network/local-network.ts +59 -22
- package/src/testing/anvil_test_watcher.ts +95 -20
- package/src/testing/cheat_codes.ts +42 -36
- package/src/testing/epoch_test_settler.ts +3 -4
- package/src/testing/index.ts +2 -1
- package/src/testing/token_allowed_setup.ts +19 -0
- package/dest/cli/cmds/start_prover_node.d.ts +0 -7
- package/dest/cli/cmds/start_prover_node.d.ts.map +0 -1
- package/dest/cli/cmds/start_prover_node.js +0 -108
- 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/cmds/start_prover_node.ts +0 -124
- package/src/cli/release_version.ts +0 -21
|
@@ -1,17 +1,20 @@
|
|
|
1
|
+
import { getActiveNetworkName } from '@aztec/foundation/config';
|
|
1
2
|
import {
|
|
2
3
|
type NamespacedApiHandlers,
|
|
3
4
|
createNamespacedSafeJsonRpcServer,
|
|
5
|
+
getApiKeyAuthMiddleware,
|
|
4
6
|
startHttpRpcServer,
|
|
5
7
|
} from '@aztec/foundation/json-rpc/server';
|
|
6
8
|
import type { LogFn, Logger } from '@aztec/foundation/log';
|
|
7
9
|
import type { ChainConfig } from '@aztec/stdlib/config';
|
|
8
|
-
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';
|
|
9
12
|
import { getVersioningMiddleware } from '@aztec/stdlib/versioning';
|
|
10
13
|
import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
|
|
11
14
|
|
|
12
15
|
import { createLocalNetwork } from '../local-network/index.js';
|
|
13
16
|
import { github, splash } from '../splash.js';
|
|
14
|
-
import {
|
|
17
|
+
import { resolveAdminApiKey } from './admin_api_key_store.js';
|
|
15
18
|
import { extractNamespacedOptions, installSignalHandlers } from './util.js';
|
|
16
19
|
import { getVersions } from './versioning.js';
|
|
17
20
|
|
|
@@ -20,14 +23,13 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
20
23
|
const signalHandlers: Array<() => Promise<void>> = [];
|
|
21
24
|
const services: NamespacedApiHandlers = {};
|
|
22
25
|
const adminServices: NamespacedApiHandlers = {};
|
|
26
|
+
const packageVersion = getPackageVersion();
|
|
23
27
|
let config: ChainConfig | undefined = undefined;
|
|
24
28
|
|
|
25
29
|
if (options.localNetwork) {
|
|
26
|
-
const
|
|
27
|
-
const localNetwork = extractNamespacedOptions(options, 'local-network');
|
|
28
|
-
localNetwork.testAccounts = true;
|
|
30
|
+
const localNetwork = extractNamespacedOptions(options, 'localNetwork');
|
|
29
31
|
userLog(`${splash}\n${github}\n\n`);
|
|
30
|
-
userLog(`Setting up Aztec local network ${
|
|
32
|
+
userLog(`Setting up Aztec local network ${packageVersion ?? 'unknown'}, please stand by...`);
|
|
31
33
|
|
|
32
34
|
const { node, stop } = await createLocalNetwork(
|
|
33
35
|
{
|
|
@@ -35,11 +37,11 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
35
37
|
l1RpcUrls: options.l1RpcUrls,
|
|
36
38
|
testAccounts: localNetwork.testAccounts,
|
|
37
39
|
realProofs: false,
|
|
38
|
-
// Setting the epoch duration to
|
|
40
|
+
// Setting the epoch duration to 2 by default for local network. This allows the epoch to be "proven" faster, so
|
|
39
41
|
// the users can consume out hash without having to wait for a long time.
|
|
40
42
|
// Note: We are not proving anything in the local network (realProofs == false). But in `createLocalNetwork`,
|
|
41
43
|
// the EpochTestSettler will set the out hash to the outbox when an epoch is complete.
|
|
42
|
-
aztecEpochDuration:
|
|
44
|
+
aztecEpochDuration: 2,
|
|
43
45
|
},
|
|
44
46
|
userLog,
|
|
45
47
|
);
|
|
@@ -47,16 +49,24 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
47
49
|
// Start Node and PXE JSON-RPC server
|
|
48
50
|
signalHandlers.push(stop);
|
|
49
51
|
services.node = [node, AztecNodeApiSchema];
|
|
52
|
+
adminServices.node = [node, AztecNodeAdminApiSchema];
|
|
53
|
+
services.nodeDebug = [node, AztecNodeDebugApiSchema];
|
|
50
54
|
} else {
|
|
55
|
+
// Route --prover-node through startNode
|
|
56
|
+
if (options.proverNode && !options.node) {
|
|
57
|
+
options.node = true;
|
|
58
|
+
}
|
|
59
|
+
|
|
51
60
|
if (options.node) {
|
|
52
61
|
const { startNode } = await import('./cmds/start_node.js');
|
|
53
|
-
|
|
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
|
+
}
|
|
54
67
|
} else if (options.bot) {
|
|
55
68
|
const { startBot } = await import('./cmds/start_bot.js');
|
|
56
69
|
await startBot(options, signalHandlers, services, userLog);
|
|
57
|
-
} else if (options.proverNode) {
|
|
58
|
-
const { startProverNode } = await import('./cmds/start_prover_node.js');
|
|
59
|
-
({ config } = await startProverNode(options, signalHandlers, services, userLog));
|
|
60
70
|
} else if (options.archiver) {
|
|
61
71
|
const { startArchiver } = await import('./cmds/start_archiver.js');
|
|
62
72
|
({ config } = await startArchiver(options, signalHandlers, services));
|
|
@@ -71,7 +81,7 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
71
81
|
await startProverBroker(options, signalHandlers, services, userLog);
|
|
72
82
|
} else if (options.txe) {
|
|
73
83
|
const { startTXE } = await import('./cmds/start_txe.js');
|
|
74
|
-
await startTXE(options, debugLogger);
|
|
84
|
+
await startTXE(options, signalHandlers, debugLogger);
|
|
75
85
|
} else if (options.sequencer) {
|
|
76
86
|
userLog(`Cannot run a standalone sequencer without a node`);
|
|
77
87
|
process.exit(1);
|
|
@@ -83,13 +93,14 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
83
93
|
|
|
84
94
|
installSignalHandlers(debugLogger.info, signalHandlers);
|
|
85
95
|
const versions = getVersions(config);
|
|
96
|
+
const versioningOpts = { packageVersion };
|
|
86
97
|
|
|
87
98
|
// Start the main JSON-RPC server
|
|
88
99
|
if (Object.entries(services).length > 0) {
|
|
89
100
|
const rpcServer = createNamespacedSafeJsonRpcServer(services, {
|
|
90
101
|
http200OnError: false,
|
|
91
102
|
log: debugLogger,
|
|
92
|
-
middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)],
|
|
103
|
+
middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions, versioningOpts)],
|
|
93
104
|
maxBatchSize: options.rpcMaxBatchSize,
|
|
94
105
|
maxBodySizeBytes: options.rpcMaxBodySize,
|
|
95
106
|
});
|
|
@@ -99,14 +110,54 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
99
110
|
|
|
100
111
|
// If there are any admin services, start a separate JSON-RPC server for them
|
|
101
112
|
if (Object.entries(adminServices).length > 0) {
|
|
113
|
+
const adminMiddlewares = [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions, versioningOpts)];
|
|
114
|
+
|
|
115
|
+
// Resolve the admin API key (auto-generated and persisted, or opt-out)
|
|
116
|
+
const apiKeyResolution = await resolveAdminApiKey(
|
|
117
|
+
{
|
|
118
|
+
adminApiKeyHash: options.adminApiKeyHash,
|
|
119
|
+
disableAdminApiKey: options.disableAdminApiKey,
|
|
120
|
+
resetAdminApiKey: options.resetAdminApiKey,
|
|
121
|
+
dataDirectory: options.dataDirectory,
|
|
122
|
+
},
|
|
123
|
+
debugLogger,
|
|
124
|
+
);
|
|
125
|
+
if (apiKeyResolution) {
|
|
126
|
+
adminMiddlewares.unshift(getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash));
|
|
127
|
+
} else {
|
|
128
|
+
debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
|
|
129
|
+
}
|
|
130
|
+
|
|
102
131
|
const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
|
|
103
132
|
http200OnError: false,
|
|
104
133
|
log: debugLogger,
|
|
105
|
-
middlewares:
|
|
134
|
+
middlewares: adminMiddlewares,
|
|
106
135
|
maxBatchSize: options.rpcMaxBatchSize,
|
|
107
136
|
maxBodySizeBytes: options.rpcMaxBodySize,
|
|
108
137
|
});
|
|
109
138
|
const { port } = await startHttpRpcServer(rpcServer, { port: options.adminPort });
|
|
110
139
|
debugLogger.info(`Aztec Server admin API listening on port ${port}`, versions);
|
|
140
|
+
|
|
141
|
+
// Display the API key after the server has started
|
|
142
|
+
// Uses userLog which is never filtered by LOG_LEVEL.
|
|
143
|
+
if (apiKeyResolution?.rawKey) {
|
|
144
|
+
const separator = '='.repeat(70);
|
|
145
|
+
userLog('');
|
|
146
|
+
userLog(separator);
|
|
147
|
+
userLog(' ADMIN API KEY (save this — it will NOT be shown again)');
|
|
148
|
+
userLog('');
|
|
149
|
+
userLog(` ${apiKeyResolution.rawKey}`);
|
|
150
|
+
userLog('');
|
|
151
|
+
userLog(` Use via header: x-api-key: <key>`);
|
|
152
|
+
userLog(` Or via header: Authorization: Bearer <key>`);
|
|
153
|
+
if (options.dataDirectory) {
|
|
154
|
+
userLog('');
|
|
155
|
+
userLog(' The key hash has been persisted — on next restart, the same key will be used.');
|
|
156
|
+
}
|
|
157
|
+
userLog('');
|
|
158
|
+
userLog(' To disable admin auth: --disable-admin-api-key or AZTEC_DISABLE_ADMIN_API_KEY=true');
|
|
159
|
+
userLog(separator);
|
|
160
|
+
userLog('');
|
|
161
|
+
}
|
|
111
162
|
}
|
|
112
163
|
}
|
|
@@ -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
|
|
|
@@ -36,7 +36,7 @@ export interface AztecStartOption {
|
|
|
36
36
|
parseVal?: (val: string) => any;
|
|
37
37
|
}
|
|
38
38
|
|
|
39
|
-
export const getOptions = (namespace: string, configMappings: Record<string, ConfigMapping
|
|
39
|
+
export const getOptions = (namespace: string, configMappings: Record<string, ConfigMapping<unknown>>) => {
|
|
40
40
|
const options: AztecStartOption[] = [];
|
|
41
41
|
for (const [key, { env, defaultValue: def, parseEnv, description, printDefault, fallback }] of Object.entries(
|
|
42
42
|
configMappings,
|
|
@@ -58,7 +58,11 @@ export const getOptions = (namespace: string, configMappings: Record<string, Con
|
|
|
58
58
|
return options;
|
|
59
59
|
};
|
|
60
60
|
|
|
61
|
-
const configToFlag = (
|
|
61
|
+
const configToFlag = (
|
|
62
|
+
flag: string,
|
|
63
|
+
configMapping: ConfigMapping<unknown>,
|
|
64
|
+
overrideDefaultValue?: any,
|
|
65
|
+
): AztecStartOption => {
|
|
62
66
|
if (!configMapping.isBoolean) {
|
|
63
67
|
flag += ' <value>';
|
|
64
68
|
}
|
|
@@ -105,8 +109,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
105
109
|
env: 'NETWORK',
|
|
106
110
|
},
|
|
107
111
|
|
|
108
|
-
configToFlag('--
|
|
109
|
-
configToFlag('--auto-update-url', sharedNodeConfigMappings.autoUpdateUrl),
|
|
112
|
+
configToFlag('--enable-version-check', sharedNodeConfigMappings.enableVersionCheck),
|
|
110
113
|
|
|
111
114
|
configToFlag('--sync-mode', sharedNodeConfigMappings.syncMode),
|
|
112
115
|
configToFlag('--snapshots-urls', sharedNodeConfigMappings.snapshotsUrls),
|
|
@@ -126,6 +129,12 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
126
129
|
defaultValue: DefaultMnemonic,
|
|
127
130
|
env: 'MNEMONIC',
|
|
128
131
|
},
|
|
132
|
+
{
|
|
133
|
+
flag: '--local-network.testAccounts',
|
|
134
|
+
description: 'Deploy test accounts on local network start',
|
|
135
|
+
env: 'TEST_ACCOUNTS',
|
|
136
|
+
...booleanConfigHelper(true),
|
|
137
|
+
},
|
|
129
138
|
],
|
|
130
139
|
API: [
|
|
131
140
|
{
|
|
@@ -142,6 +151,37 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
142
151
|
env: 'AZTEC_ADMIN_PORT',
|
|
143
152
|
parseVal: val => parseInt(val, 10),
|
|
144
153
|
},
|
|
154
|
+
{
|
|
155
|
+
flag: '--admin-api-key-hash <value>',
|
|
156
|
+
description:
|
|
157
|
+
'SHA-256 hex hash of a pre-generated admin API key. When set, the node uses this hash for authentication instead of auto-generating a key.',
|
|
158
|
+
defaultValue: undefined,
|
|
159
|
+
env: 'AZTEC_ADMIN_API_KEY_HASH',
|
|
160
|
+
},
|
|
161
|
+
{
|
|
162
|
+
flag: '--disable-admin-api-key',
|
|
163
|
+
description:
|
|
164
|
+
'Disable API key authentication on the admin RPC endpoint. By default, a key is auto-generated, displayed once, and its hash is persisted.',
|
|
165
|
+
defaultValue: false,
|
|
166
|
+
env: 'AZTEC_DISABLE_ADMIN_API_KEY',
|
|
167
|
+
// undefined means the flag was passed without a value (boolean toggle), treat as true.
|
|
168
|
+
parseVal: val => val === undefined || val === 'true' || val === '1',
|
|
169
|
+
},
|
|
170
|
+
{
|
|
171
|
+
flag: '--reset-admin-api-key',
|
|
172
|
+
description:
|
|
173
|
+
'Force-generate a new admin API key, replacing any previously persisted key hash. The new key is displayed once at startup.',
|
|
174
|
+
defaultValue: false,
|
|
175
|
+
env: 'AZTEC_RESET_ADMIN_API_KEY',
|
|
176
|
+
parseVal: val => val === 'true' || val === '1',
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
flag: '--node-debug',
|
|
180
|
+
description: 'Expose debug endpoints (e.g. mineBlock) on the main RPC port',
|
|
181
|
+
defaultValue: false,
|
|
182
|
+
env: 'AZTEC_NODE_DEBUG',
|
|
183
|
+
parseVal: val => val === undefined || val === 'true' || val === '1',
|
|
184
|
+
},
|
|
145
185
|
{
|
|
146
186
|
flag: '--api-prefix <value>',
|
|
147
187
|
description: 'Prefix for API routes on any service that is started',
|
|
@@ -170,7 +210,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
170
210
|
'WORLD STATE': [
|
|
171
211
|
configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
|
|
172
212
|
configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
|
|
173
|
-
configToFlag('--world-state-
|
|
213
|
+
configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory),
|
|
174
214
|
],
|
|
175
215
|
// We can't easily auto-generate node options as they're parts of modules defined below
|
|
176
216
|
'AZTEC NODE': [
|
|
@@ -222,12 +262,8 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
222
262
|
'proverNode',
|
|
223
263
|
omitConfigMappings(proverNodeConfigMappings, [
|
|
224
264
|
// filter out options passed separately
|
|
225
|
-
...getKeys(archiverConfigMappings),
|
|
226
265
|
...getKeys(proverBrokerConfigMappings),
|
|
227
266
|
...getKeys(proverAgentConfigMappings),
|
|
228
|
-
...getKeys(p2pConfigMappings),
|
|
229
|
-
...getKeys(worldStateConfigMappings),
|
|
230
|
-
...getKeys(sharedNodeConfigMappings),
|
|
231
267
|
]),
|
|
232
268
|
),
|
|
233
269
|
],
|
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,178 @@
|
|
|
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 } 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
|
+
import { warnIfAztecVersionMismatch } from './utils/warn_if_aztec_version_mismatch.js';
|
|
13
|
+
|
|
14
|
+
/** Returns paths to contract artifacts in the target directory. */
|
|
15
|
+
async function collectContractArtifacts(): Promise<string[]> {
|
|
16
|
+
let files;
|
|
17
|
+
try {
|
|
18
|
+
files = await readArtifactFiles('target');
|
|
19
|
+
} catch (err: any) {
|
|
20
|
+
if (err?.message?.includes('does not exist')) {
|
|
21
|
+
return [];
|
|
22
|
+
}
|
|
23
|
+
throw err;
|
|
24
|
+
}
|
|
25
|
+
return files.filter(f => Array.isArray(f.content.functions)).map(f => f.filePath);
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
/** Returns the set of package names that are contract crates in the current workspace. */
|
|
29
|
+
async function getContractPackageNames(): Promise<Set<string>> {
|
|
30
|
+
const contractNames = new Set<string>();
|
|
31
|
+
|
|
32
|
+
let rootToml: string;
|
|
33
|
+
try {
|
|
34
|
+
rootToml = await readFile('Nargo.toml', 'utf-8');
|
|
35
|
+
} catch {
|
|
36
|
+
return contractNames;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
const membersMatch = rootToml.match(/members\s*=\s*\[([^\]]*)\]/);
|
|
40
|
+
if (membersMatch) {
|
|
41
|
+
const members = membersMatch[1]
|
|
42
|
+
.split(',')
|
|
43
|
+
.map(m => m.trim().replace(/^"|"$/g, ''))
|
|
44
|
+
.filter(m => m.length > 0);
|
|
45
|
+
|
|
46
|
+
for (const member of members) {
|
|
47
|
+
try {
|
|
48
|
+
const memberToml = await readFile(join(member, 'Nargo.toml'), 'utf-8');
|
|
49
|
+
if (/type\s*=\s*"contract"/.test(memberToml)) {
|
|
50
|
+
const nameMatch = memberToml.match(/name\s*=\s*"([^"]+)"/);
|
|
51
|
+
if (nameMatch) {
|
|
52
|
+
contractNames.add(nameMatch[1]);
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
} catch {
|
|
56
|
+
// Member directory might not exist or have no Nargo.toml; skip.
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
} else {
|
|
60
|
+
// Single-crate project (no workspace): check if the root Nargo.toml itself is a contract.
|
|
61
|
+
if (/type\s*=\s*"contract"/.test(rootToml)) {
|
|
62
|
+
const nameMatch = rootToml.match(/name\s*=\s*"([^"]+)"/);
|
|
63
|
+
if (nameMatch) {
|
|
64
|
+
contractNames.add(nameMatch[1]);
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
return contractNames;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
/** Checks that no tests exist in contract crates and fails with a helpful message if they do. */
|
|
73
|
+
async function checkNoTestsInContracts(nargo: string, log: LogFn): Promise<void> {
|
|
74
|
+
const contractPackages = await getContractPackageNames();
|
|
75
|
+
if (contractPackages.size === 0) {
|
|
76
|
+
return;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
let output: string;
|
|
80
|
+
try {
|
|
81
|
+
// We list tests for all the crates in the workspace
|
|
82
|
+
output = execFileSync(nargo, ['test', '--list-tests', '--silence-warnings'], {
|
|
83
|
+
encoding: 'utf-8',
|
|
84
|
+
stdio: ['pipe', 'pipe', 'inherit'],
|
|
85
|
+
});
|
|
86
|
+
} catch {
|
|
87
|
+
// If listing tests fails (e.g. test crate has compile errors), skip the check.
|
|
88
|
+
return;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
// The output of the `nargo test --list-tests` command is as follows:
|
|
92
|
+
// ```
|
|
93
|
+
// crate_name_1 test_name_1
|
|
94
|
+
// crate_name_2 test_name_2
|
|
95
|
+
// ...
|
|
96
|
+
// crate_name_n test_name_n
|
|
97
|
+
// ```
|
|
98
|
+
//
|
|
99
|
+
// We parse the individual lines and then we check if any contract crate appeared in the parsed output.
|
|
100
|
+
const lines = output
|
|
101
|
+
.trim()
|
|
102
|
+
.split('\n')
|
|
103
|
+
.filter(line => line.length > 0);
|
|
104
|
+
const testsInContracts: { packageName: string; testName: string }[] = [];
|
|
105
|
+
|
|
106
|
+
for (const line of lines) {
|
|
107
|
+
const spaceIndex = line.indexOf(' ');
|
|
108
|
+
if (spaceIndex === -1) {
|
|
109
|
+
continue;
|
|
110
|
+
}
|
|
111
|
+
const packageName = line.substring(0, spaceIndex);
|
|
112
|
+
const testName = line.substring(spaceIndex + 1);
|
|
113
|
+
if (contractPackages.has(packageName)) {
|
|
114
|
+
testsInContracts.push({ packageName, testName });
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
if (testsInContracts.length > 0) {
|
|
119
|
+
const details = testsInContracts.map(t => ` ${t.packageName}::${t.testName}`).join('\n');
|
|
120
|
+
log(
|
|
121
|
+
`WARNING: Found tests in contract crate(s):\n${details}\n\n` +
|
|
122
|
+
`Tests should be in a dedicated test crate, not in the contract crate.\n` +
|
|
123
|
+
`Learn more: https://docs.aztec.network/errors/1`,
|
|
124
|
+
);
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
/** Compiles Aztec Noir contracts and postprocesses artifacts. */
|
|
129
|
+
async function compileAztecContract(nargoArgs: string[], log: LogFn): Promise<void> {
|
|
130
|
+
await warnIfAztecVersionMismatch(log);
|
|
131
|
+
|
|
132
|
+
if (!(await needsRecompile())) {
|
|
133
|
+
log('No source changes detected, skipping compilation.');
|
|
134
|
+
return;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
const nargo = process.env.NARGO ?? 'nargo';
|
|
138
|
+
const bb = process.env.BB ?? findBbBinary() ?? 'bb';
|
|
139
|
+
|
|
140
|
+
await run(nargo, ['compile', ...nargoArgs]);
|
|
141
|
+
|
|
142
|
+
// Ensure contract crates contain no tests (tests belong in the test crate).
|
|
143
|
+
await checkNoTestsInContracts(nargo, log);
|
|
144
|
+
|
|
145
|
+
const artifacts = await collectContractArtifacts();
|
|
146
|
+
|
|
147
|
+
if (artifacts.length > 0) {
|
|
148
|
+
log('Postprocessing contracts...');
|
|
149
|
+
const bbArgs = artifacts.flatMap(a => ['-i', a]);
|
|
150
|
+
await run(bb, ['aztec_process', ...bbArgs]);
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
log('Compilation complete!');
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
export function injectCompileCommand(program: Command, log: LogFn): Command {
|
|
157
|
+
program
|
|
158
|
+
.command('compile')
|
|
159
|
+
.argument('[nargo-args...]')
|
|
160
|
+
.passThroughOptions()
|
|
161
|
+
.allowUnknownOption()
|
|
162
|
+
.description(
|
|
163
|
+
'Compile Aztec Noir contracts using nargo and postprocess them to generate transpiled artifacts and verification keys. All options are forwarded to nargo compile.',
|
|
164
|
+
)
|
|
165
|
+
.addHelpText('after', () => {
|
|
166
|
+
// Show nargo's own compile options so users see all available flags in one place.
|
|
167
|
+
const nargo = process.env.NARGO ?? 'nargo';
|
|
168
|
+
try {
|
|
169
|
+
const output = execFileSync(nargo, ['compile', '--help'], { encoding: 'utf-8' });
|
|
170
|
+
return `\nUnderlying nargo compile options:\n\n${output}`;
|
|
171
|
+
} catch {
|
|
172
|
+
return '\n(Run "nargo compile --help" to see available nargo options)';
|
|
173
|
+
}
|
|
174
|
+
})
|
|
175
|
+
.action((nargoArgs: string[]) => compileAztecContract(nargoArgs, log));
|
|
176
|
+
|
|
177
|
+
return program;
|
|
178
|
+
}
|
|
@@ -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
|
+
}
|