@aztec/aztec 0.0.1-commit.5daedc8 → 0.0.1-commit.5de5ca79e
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 +12 -5
- 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 +65 -19
- 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 +41 -36
- package/dest/cli/cli.d.ts +1 -1
- package/dest/cli/cli.d.ts.map +1 -1
- package/dest/cli/cli.js +7 -52
- 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/migrate_ha_db.d.ts +3 -0
- package/dest/cli/cmds/migrate_ha_db.d.ts.map +1 -0
- package/dest/cli/cmds/migrate_ha_db.js +27 -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 +12 -14
- 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 +10 -6
- 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 +85 -29
- package/dest/cli/cmds/start_p2p_bootstrap.d.ts +2 -2
- package/dest/cli/cmds/start_p2p_bootstrap.d.ts.map +1 -1
- package/dest/cli/cmds/start_p2p_bootstrap.js +2 -3
- 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 -4
- 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 +15 -9
- 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 +9 -20
- package/dest/cli/util.d.ts.map +1 -1
- package/dest/cli/util.js +51 -87
- package/dest/examples/token.js +9 -9
- package/dest/examples/util.d.ts +2 -2
- package/dest/examples/util.d.ts.map +1 -1
- package/dest/local-network/banana_fpc.d.ts +1 -1
- package/dest/local-network/banana_fpc.d.ts.map +1 -1
- package/dest/local-network/banana_fpc.js +4 -4
- package/dest/local-network/local-network.d.ts +13 -14
- package/dest/local-network/local-network.d.ts.map +1 -1
- package/dest/local-network/local-network.js +86 -43
- package/dest/testing/anvil_test_watcher.d.ts +10 -2
- 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.d.ts +3 -1
- package/dest/testing/cheat_codes.d.ts.map +1 -1
- package/dest/testing/epoch_test_settler.d.ts +19 -0
- package/dest/testing/epoch_test_settler.d.ts.map +1 -0
- package/dest/testing/epoch_test_settler.js +61 -0
- package/dest/testing/index.d.ts +3 -1
- package/dest/testing/index.d.ts.map +1 -1
- package/dest/testing/index.js +2 -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 +39 -36
- package/scripts/add_crate.sh +102 -0
- package/scripts/aztec.sh +69 -0
- package/scripts/init.sh +39 -0
- package/scripts/new.sh +83 -0
- package/scripts/setup_workspace.sh +68 -0
- package/src/bin/index.ts +13 -5
- package/src/cli/admin_api_key_store.ts +128 -0
- package/src/cli/aztec_start_action.ts +63 -14
- package/src/cli/aztec_start_options.ts +42 -35
- package/src/cli/cli.ts +11 -56
- package/src/cli/cmds/compile.ts +191 -0
- package/src/cli/cmds/migrate_ha_db.ts +43 -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 -19
- package/src/cli/cmds/start_bot.ts +9 -6
- package/src/cli/cmds/start_node.ts +85 -35
- package/src/cli/cmds/start_p2p_bootstrap.ts +3 -3
- package/src/cli/cmds/start_prover_agent.ts +4 -12
- package/src/cli/cmds/start_prover_broker.ts +20 -16
- 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 +60 -98
- package/src/examples/token.ts +10 -10
- package/src/examples/util.ts +1 -1
- package/src/local-network/banana_fpc.ts +12 -8
- package/src/local-network/local-network.ts +120 -85
- package/src/testing/anvil_test_watcher.ts +61 -17
- package/src/testing/cheat_codes.ts +3 -2
- package/src/testing/epoch_test_settler.ts +70 -0
- package/src/testing/index.ts +2 -0
- package/src/testing/token_allowed_setup.ts +19 -0
- package/dest/cli/cmds/start_blob_sink.d.ts +0 -3
- package/dest/cli/cmds/start_blob_sink.d.ts.map +0 -1
- package/dest/cli/cmds/start_blob_sink.js +0 -33
- 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/src/cli/cmds/start_blob_sink.ts +0 -57
- 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 } 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,22 +23,26 @@ 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 cliVersion = getCliVersion();
|
|
27
30
|
const localNetwork = extractNamespacedOptions(options, 'local-network');
|
|
28
31
|
localNetwork.testAccounts = true;
|
|
29
32
|
userLog(`${splash}\n${github}\n\n`);
|
|
30
|
-
userLog(`Setting up Aztec local network ${
|
|
33
|
+
userLog(`Setting up Aztec local network ${packageVersion ?? 'unknown'}, please stand by...`);
|
|
31
34
|
|
|
32
35
|
const { node, stop } = await createLocalNetwork(
|
|
33
36
|
{
|
|
34
37
|
l1Mnemonic: localNetwork.l1Mnemonic,
|
|
35
38
|
l1RpcUrls: options.l1RpcUrls,
|
|
36
|
-
deployAztecContractsSalt: localNetwork.deployAztecContractsSalt,
|
|
37
39
|
testAccounts: localNetwork.testAccounts,
|
|
38
40
|
realProofs: false,
|
|
41
|
+
// Setting the epoch duration to 2 by default for local network. This allows the epoch to be "proven" faster, so
|
|
42
|
+
// the users can consume out hash without having to wait for a long time.
|
|
43
|
+
// Note: We are not proving anything in the local network (realProofs == false). But in `createLocalNetwork`,
|
|
44
|
+
// the EpochTestSettler will set the out hash to the outbox when an epoch is complete.
|
|
45
|
+
aztecEpochDuration: 2,
|
|
39
46
|
},
|
|
40
47
|
userLog,
|
|
41
48
|
);
|
|
@@ -43,19 +50,20 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
43
50
|
// Start Node and PXE JSON-RPC server
|
|
44
51
|
signalHandlers.push(stop);
|
|
45
52
|
services.node = [node, AztecNodeApiSchema];
|
|
53
|
+
adminServices.node = [node, AztecNodeAdminApiSchema];
|
|
46
54
|
} else {
|
|
55
|
+
// Route --prover-node through startNode
|
|
56
|
+
if (options.proverNode && !options.node) {
|
|
57
|
+
options.node = true;
|
|
58
|
+
}
|
|
59
|
+
|
|
47
60
|
if (options.node) {
|
|
48
61
|
const { startNode } = await import('./cmds/start_node.js');
|
|
49
|
-
|
|
62
|
+
const networkName = getActiveNetworkName(options.network);
|
|
63
|
+
({ config } = await startNode(options, signalHandlers, services, adminServices, userLog, networkName));
|
|
50
64
|
} else if (options.bot) {
|
|
51
65
|
const { startBot } = await import('./cmds/start_bot.js');
|
|
52
66
|
await startBot(options, signalHandlers, services, userLog);
|
|
53
|
-
} else if (options.proverNode) {
|
|
54
|
-
const { startProverNode } = await import('./cmds/start_prover_node.js');
|
|
55
|
-
({ config } = await startProverNode(options, signalHandlers, services, userLog));
|
|
56
|
-
} else if (options.blobSink) {
|
|
57
|
-
const { startBlobSink } = await import('./cmds/start_blob_sink.js');
|
|
58
|
-
await startBlobSink(options, signalHandlers, userLog);
|
|
59
67
|
} else if (options.archiver) {
|
|
60
68
|
const { startArchiver } = await import('./cmds/start_archiver.js');
|
|
61
69
|
({ config } = await startArchiver(options, signalHandlers, services));
|
|
@@ -82,13 +90,14 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
82
90
|
|
|
83
91
|
installSignalHandlers(debugLogger.info, signalHandlers);
|
|
84
92
|
const versions = getVersions(config);
|
|
93
|
+
const versioningOpts = { packageVersion };
|
|
85
94
|
|
|
86
95
|
// Start the main JSON-RPC server
|
|
87
96
|
if (Object.entries(services).length > 0) {
|
|
88
97
|
const rpcServer = createNamespacedSafeJsonRpcServer(services, {
|
|
89
98
|
http200OnError: false,
|
|
90
99
|
log: debugLogger,
|
|
91
|
-
middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)],
|
|
100
|
+
middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions, versioningOpts)],
|
|
92
101
|
maxBatchSize: options.rpcMaxBatchSize,
|
|
93
102
|
maxBodySizeBytes: options.rpcMaxBodySize,
|
|
94
103
|
});
|
|
@@ -98,14 +107,54 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
98
107
|
|
|
99
108
|
// If there are any admin services, start a separate JSON-RPC server for them
|
|
100
109
|
if (Object.entries(adminServices).length > 0) {
|
|
110
|
+
const adminMiddlewares = [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions, versioningOpts)];
|
|
111
|
+
|
|
112
|
+
// Resolve the admin API key (auto-generated and persisted, or opt-out)
|
|
113
|
+
const apiKeyResolution = await resolveAdminApiKey(
|
|
114
|
+
{
|
|
115
|
+
adminApiKeyHash: options.adminApiKeyHash,
|
|
116
|
+
disableAdminApiKey: options.disableAdminApiKey,
|
|
117
|
+
resetAdminApiKey: options.resetAdminApiKey,
|
|
118
|
+
dataDirectory: options.dataDirectory,
|
|
119
|
+
},
|
|
120
|
+
debugLogger,
|
|
121
|
+
);
|
|
122
|
+
if (apiKeyResolution) {
|
|
123
|
+
adminMiddlewares.unshift(getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash));
|
|
124
|
+
} else {
|
|
125
|
+
debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
|
|
126
|
+
}
|
|
127
|
+
|
|
101
128
|
const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
|
|
102
129
|
http200OnError: false,
|
|
103
130
|
log: debugLogger,
|
|
104
|
-
middlewares:
|
|
131
|
+
middlewares: adminMiddlewares,
|
|
105
132
|
maxBatchSize: options.rpcMaxBatchSize,
|
|
106
133
|
maxBodySizeBytes: options.rpcMaxBodySize,
|
|
107
134
|
});
|
|
108
135
|
const { port } = await startHttpRpcServer(rpcServer, { port: options.adminPort });
|
|
109
136
|
debugLogger.info(`Aztec Server admin API listening on port ${port}`, versions);
|
|
137
|
+
|
|
138
|
+
// Display the API key after the server has started
|
|
139
|
+
// Uses userLog which is never filtered by LOG_LEVEL.
|
|
140
|
+
if (apiKeyResolution?.rawKey) {
|
|
141
|
+
const separator = '='.repeat(70);
|
|
142
|
+
userLog('');
|
|
143
|
+
userLog(separator);
|
|
144
|
+
userLog(' ADMIN API KEY (save this — it will NOT be shown again)');
|
|
145
|
+
userLog('');
|
|
146
|
+
userLog(` ${apiKeyResolution.rawKey}`);
|
|
147
|
+
userLog('');
|
|
148
|
+
userLog(` Use via header: x-api-key: <key>`);
|
|
149
|
+
userLog(` Or via header: Authorization: Bearer <key>`);
|
|
150
|
+
if (options.dataDirectory) {
|
|
151
|
+
userLog('');
|
|
152
|
+
userLog(' The key hash has been persisted — on next restart, the same key will be used.');
|
|
153
|
+
}
|
|
154
|
+
userLog('');
|
|
155
|
+
userLog(' To disable admin auth: --disable-admin-api-key or AZTEC_DISABLE_ADMIN_API_KEY=true');
|
|
156
|
+
userLog(separator);
|
|
157
|
+
userLog('');
|
|
158
|
+
}
|
|
110
159
|
}
|
|
111
160
|
}
|
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { type ArchiverConfig, archiverConfigMappings } from '@aztec/archiver/config';
|
|
2
|
-
import {
|
|
3
|
-
import { blobSinkConfigMappings } from '@aztec/blob-sink/server';
|
|
2
|
+
import { blobClientConfigMapping } from '@aztec/blob-client/client/config';
|
|
4
3
|
import { botConfigMappings } from '@aztec/bot/config';
|
|
5
|
-
import {
|
|
4
|
+
import { l1ContractsConfigMappings } from '@aztec/ethereum/config';
|
|
5
|
+
import { l1ContractAddressesMapping } from '@aztec/ethereum/l1-contract-addresses';
|
|
6
|
+
import { l1ReaderConfigMappings } from '@aztec/ethereum/l1-reader';
|
|
6
7
|
import { getKeys } from '@aztec/foundation/collection';
|
|
7
8
|
import {
|
|
8
9
|
type ConfigMapping,
|
|
@@ -11,15 +12,16 @@ import {
|
|
|
11
12
|
isBooleanConfigValue,
|
|
12
13
|
omitConfigMappings,
|
|
13
14
|
} from '@aztec/foundation/config';
|
|
14
|
-
import { dataConfigMappings } from '@aztec/kv-store/config';
|
|
15
15
|
import { sharedNodeConfigMappings } from '@aztec/node-lib/config';
|
|
16
16
|
import { bootnodeConfigMappings, p2pConfigMappings } from '@aztec/p2p/config';
|
|
17
|
-
import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker';
|
|
17
|
+
import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker/config';
|
|
18
18
|
import { proverNodeConfigMappings } from '@aztec/prover-node/config';
|
|
19
19
|
import { allPxeConfigMappings } from '@aztec/pxe/config';
|
|
20
|
-
import {
|
|
21
|
-
import {
|
|
22
|
-
import {
|
|
20
|
+
import { sequencerClientConfigMappings } from '@aztec/sequencer-client/config';
|
|
21
|
+
import { chainConfigMappings, nodeRpcConfigMappings } from '@aztec/stdlib/config';
|
|
22
|
+
import { dataConfigMappings } from '@aztec/stdlib/kv-store';
|
|
23
|
+
import { telemetryClientConfigMappings } from '@aztec/telemetry-client/config';
|
|
24
|
+
import { worldStateConfigMappings } from '@aztec/world-state/config';
|
|
23
25
|
|
|
24
26
|
import { DefaultMnemonic } from '../mnemonic.js';
|
|
25
27
|
|
|
@@ -103,8 +105,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
103
105
|
env: 'NETWORK',
|
|
104
106
|
},
|
|
105
107
|
|
|
106
|
-
configToFlag('--
|
|
107
|
-
configToFlag('--auto-update-url', sharedNodeConfigMappings.autoUpdateUrl),
|
|
108
|
+
configToFlag('--enable-version-check', sharedNodeConfigMappings.enableVersionCheck),
|
|
108
109
|
|
|
109
110
|
configToFlag('--sync-mode', sharedNodeConfigMappings.syncMode),
|
|
110
111
|
configToFlag('--snapshots-urls', sharedNodeConfigMappings.snapshotsUrls),
|
|
@@ -124,14 +125,6 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
124
125
|
defaultValue: DefaultMnemonic,
|
|
125
126
|
env: 'MNEMONIC',
|
|
126
127
|
},
|
|
127
|
-
{
|
|
128
|
-
flag: '--local-network.deployAztecContractsSalt <value>',
|
|
129
|
-
description:
|
|
130
|
-
'Numeric salt for deploying L1 Aztec contracts before starting the local network. Needs mnemonic or private key to be set.',
|
|
131
|
-
env: 'DEPLOY_AZTEC_CONTRACTS_SALT',
|
|
132
|
-
defaultValue: undefined,
|
|
133
|
-
parseVal: (val: string) => (val ? parseInt(val) : undefined),
|
|
134
|
-
},
|
|
135
128
|
],
|
|
136
129
|
API: [
|
|
137
130
|
{
|
|
@@ -148,20 +141,46 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
148
141
|
env: 'AZTEC_ADMIN_PORT',
|
|
149
142
|
parseVal: val => parseInt(val, 10),
|
|
150
143
|
},
|
|
144
|
+
{
|
|
145
|
+
flag: '--admin-api-key-hash <value>',
|
|
146
|
+
description:
|
|
147
|
+
'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.',
|
|
148
|
+
defaultValue: undefined,
|
|
149
|
+
env: 'AZTEC_ADMIN_API_KEY_HASH',
|
|
150
|
+
},
|
|
151
|
+
{
|
|
152
|
+
flag: '--disable-admin-api-key',
|
|
153
|
+
description:
|
|
154
|
+
'Disable API key authentication on the admin RPC endpoint. By default, a key is auto-generated, displayed once, and its hash is persisted.',
|
|
155
|
+
defaultValue: false,
|
|
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
|
+
},
|
|
160
|
+
{
|
|
161
|
+
flag: '--reset-admin-api-key',
|
|
162
|
+
description:
|
|
163
|
+
'Force-generate a new admin API key, replacing any previously persisted key hash. The new key is displayed once at startup.',
|
|
164
|
+
defaultValue: false,
|
|
165
|
+
env: 'AZTEC_RESET_ADMIN_API_KEY',
|
|
166
|
+
parseVal: val => val === 'true' || val === '1',
|
|
167
|
+
},
|
|
151
168
|
{
|
|
152
169
|
flag: '--api-prefix <value>',
|
|
153
170
|
description: 'Prefix for API routes on any service that is started',
|
|
154
171
|
defaultValue: '',
|
|
155
172
|
env: 'API_PREFIX',
|
|
156
173
|
},
|
|
174
|
+
configToFlag('--rpcMaxBatchSize', nodeRpcConfigMappings.rpcMaxBatchSize),
|
|
175
|
+
configToFlag('--rpcMaxBodySize', nodeRpcConfigMappings.rpcMaxBodySize),
|
|
157
176
|
],
|
|
158
177
|
ETHEREUM: [
|
|
159
178
|
configToFlag('--l1-chain-id', l1ReaderConfigMappings.l1ChainId),
|
|
160
179
|
// Do not set default for CLI: keep undefined unless provided via flag or env
|
|
161
180
|
configToFlag('--l1-rpc-urls', { ...l1ReaderConfigMappings.l1RpcUrls, defaultValue: undefined }),
|
|
162
|
-
configToFlag('--l1-consensus-host-urls',
|
|
163
|
-
configToFlag('--l1-consensus-host-api-keys',
|
|
164
|
-
configToFlag('--l1-consensus-host-api-key-headers',
|
|
181
|
+
configToFlag('--l1-consensus-host-urls', blobClientConfigMapping.l1ConsensusHostUrls),
|
|
182
|
+
configToFlag('--l1-consensus-host-api-keys', blobClientConfigMapping.l1ConsensusHostApiKeys),
|
|
183
|
+
configToFlag('--l1-consensus-host-api-key-headers', blobClientConfigMapping.l1ConsensusHostApiKeyHeaders),
|
|
165
184
|
],
|
|
166
185
|
'L1 CONTRACTS': [
|
|
167
186
|
configToFlag('--registry-address', l1ContractAddressesMapping.registryAddress),
|
|
@@ -174,7 +193,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
174
193
|
'WORLD STATE': [
|
|
175
194
|
configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
|
|
176
195
|
configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
|
|
177
|
-
configToFlag('--world-state-
|
|
196
|
+
configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory),
|
|
178
197
|
],
|
|
179
198
|
// We can't easily auto-generate node options as they're parts of modules defined below
|
|
180
199
|
'AZTEC NODE': [
|
|
@@ -208,21 +227,13 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
208
227
|
'sequencer',
|
|
209
228
|
omitConfigMappings(sequencerClientConfigMappings, [
|
|
210
229
|
'fakeProcessingDelayPerTxMs',
|
|
230
|
+
'fakeThrowAfterProcessingTxCount',
|
|
211
231
|
'skipCollectingAttestations',
|
|
212
232
|
'skipInvalidateBlockAsProposer',
|
|
213
233
|
'blobSinkMapSizeKb',
|
|
214
234
|
]),
|
|
215
235
|
),
|
|
216
236
|
],
|
|
217
|
-
'BLOB SINK': [
|
|
218
|
-
{
|
|
219
|
-
flag: '--blob-sink',
|
|
220
|
-
description: 'Starts Aztec Blob Sink with options',
|
|
221
|
-
defaultValue: undefined,
|
|
222
|
-
env: undefined,
|
|
223
|
-
},
|
|
224
|
-
...getOptions('blobSink', blobSinkConfigMappings),
|
|
225
|
-
],
|
|
226
237
|
'PROVER NODE': [
|
|
227
238
|
{
|
|
228
239
|
flag: '--prover-node',
|
|
@@ -234,12 +245,8 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
234
245
|
'proverNode',
|
|
235
246
|
omitConfigMappings(proverNodeConfigMappings, [
|
|
236
247
|
// filter out options passed separately
|
|
237
|
-
...getKeys(archiverConfigMappings),
|
|
238
248
|
...getKeys(proverBrokerConfigMappings),
|
|
239
249
|
...getKeys(proverAgentConfigMappings),
|
|
240
|
-
...getKeys(p2pConfigMappings),
|
|
241
|
-
...getKeys(worldStateConfigMappings),
|
|
242
|
-
...getKeys(sharedNodeConfigMappings),
|
|
243
250
|
]),
|
|
244
251
|
),
|
|
245
252
|
],
|
package/src/cli/cli.ts
CHANGED
|
@@ -31,63 +31,18 @@ export function injectAztecCommands(program: Command, userLog: LogFn, debugLogge
|
|
|
31
31
|
|
|
32
32
|
program.configureHelp({ sortSubcommands: true });
|
|
33
33
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
--contract Use a contract template (default)
|
|
44
|
-
--lib Use a library template
|
|
45
|
-
--bin Use a binary template
|
|
46
|
-
Examples:
|
|
47
|
-
$ aztec init # creates a contract project in current directory
|
|
48
|
-
$ aztec init --lib # creates a library project
|
|
49
|
-
|
|
50
|
-
new <path> [options]: creates a new Noir project in a new directory
|
|
51
|
-
Options:
|
|
52
|
-
--name <name> Name of the package
|
|
53
|
-
--contract Use a contract template (default)
|
|
54
|
-
--lib Use a library template
|
|
55
|
-
--bin Use a binary template
|
|
56
|
-
Examples:
|
|
57
|
-
$ aztec new my-project # creates a contract project in ./my-project
|
|
58
|
-
$ aztec new my-lib --lib # creates a library project in ./my-lib
|
|
59
|
-
|
|
60
|
-
compile [options]: compiles Aztec Noir contracts
|
|
61
|
-
Compiles contracts with nargo compile and then postprocesses them to generate Aztec-specific artifacts including:
|
|
62
|
-
- Transpiled contract artifacts
|
|
63
|
-
- Verification keys
|
|
64
|
-
The compiled contracts will be placed in the target/ directory by default.
|
|
65
|
-
Supports standard nargo compile options.
|
|
66
|
-
|
|
67
|
-
fmt [options]: formats Noir code using nargo fmt
|
|
68
|
-
Example:
|
|
69
|
-
$ aztec fmt # formats all Noir files in the project
|
|
70
|
-
|
|
71
|
-
check [options]: type-checks Noir code without compiling using nargo check
|
|
72
|
-
Example:
|
|
73
|
-
$ aztec check # checks all Noir files in the project
|
|
74
|
-
|
|
75
|
-
test [options]: starts a dockerized TXE node via
|
|
76
|
-
$ aztec start --txe
|
|
77
|
-
then runs
|
|
78
|
-
$ aztec test --silence-warnings --oracle-resolver=<TXE_ADDRESS> [options]
|
|
79
|
-
|
|
80
|
-
lsp: starts the Nargo Language Server Protocol server
|
|
81
|
-
Runs nargo lsp in a Docker container for IDE integration with Noir.
|
|
82
|
-
This command is typically used by IDE extensions and not called directly by users.
|
|
83
|
-
Example:
|
|
84
|
-
$ aztec lsp # starts the LSP server
|
|
85
|
-
|
|
86
|
-
preload-crs: Downloads and caches the Common Reference String (CRS) data required for zero-knowledge proofs.
|
|
87
|
-
Example:
|
|
88
|
-
$ aztec preload-crs # preloads CRS data
|
|
34
|
+
if (process.env.AZTEC_SHELL_WRAPPER) {
|
|
35
|
+
program.addHelpText(
|
|
36
|
+
'after',
|
|
37
|
+
`
|
|
38
|
+
Additional commands:
|
|
39
|
+
|
|
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.
|
|
89
43
|
`,
|
|
90
|
-
|
|
44
|
+
);
|
|
45
|
+
}
|
|
91
46
|
|
|
92
47
|
program
|
|
93
48
|
.command('preload-crs')
|
|
@@ -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,43 @@
|
|
|
1
|
+
import { runMigrations } from '@aztec/validator-ha-signer/migrations';
|
|
2
|
+
|
|
3
|
+
import type { Command } from 'commander';
|
|
4
|
+
|
|
5
|
+
export function injectMigrateCommand(program: Command, log: (msg: string) => void): Command {
|
|
6
|
+
const migrateCommand = program.command('migrate-ha-db').description('Run validator-ha-signer database migrations');
|
|
7
|
+
|
|
8
|
+
migrateCommand
|
|
9
|
+
.command('up')
|
|
10
|
+
.description('Apply pending migrations')
|
|
11
|
+
.requiredOption('--database-url <string>', 'PostgreSQL connection string', process.env.DATABASE_URL)
|
|
12
|
+
.option('--verbose', 'Enable verbose output', false)
|
|
13
|
+
.action(async options => {
|
|
14
|
+
const migrations = await runMigrations(options.databaseUrl, {
|
|
15
|
+
direction: 'up',
|
|
16
|
+
verbose: options.verbose,
|
|
17
|
+
});
|
|
18
|
+
if (migrations.length > 0) {
|
|
19
|
+
log(`Applied migrations: ${migrations.join(', ')}`);
|
|
20
|
+
} else {
|
|
21
|
+
log('No migrations to apply - schema is up to date');
|
|
22
|
+
}
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
migrateCommand
|
|
26
|
+
.command('down')
|
|
27
|
+
.description('Rollback the last migration')
|
|
28
|
+
.requiredOption('--database-url <string>', 'PostgreSQL connection string', process.env.DATABASE_URL)
|
|
29
|
+
.option('--verbose', 'Enable verbose output', false)
|
|
30
|
+
.action(async options => {
|
|
31
|
+
const migrations = await runMigrations(options.databaseUrl, {
|
|
32
|
+
direction: 'down',
|
|
33
|
+
verbose: options.verbose,
|
|
34
|
+
});
|
|
35
|
+
if (migrations.length > 0) {
|
|
36
|
+
log(`Rolled back migrations: ${migrations.join(', ')}`);
|
|
37
|
+
} else {
|
|
38
|
+
log('No migrations to rollback');
|
|
39
|
+
}
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
return program;
|
|
43
|
+
}
|
|
@@ -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
|
+
}
|