@aztec/aztec 0.0.1-commit.c7c42ec → 0.0.1-commit.cf93bcc56
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 +2 -0
- 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 +50 -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 +26 -8
- package/dest/cli/cli.d.ts +1 -1
- package/dest/cli/cli.d.ts.map +1 -1
- package/dest/cli/cli.js +9 -53
- 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/start_archiver.d.ts +1 -1
- package/dest/cli/cmds/start_archiver.d.ts.map +1 -1
- package/dest/cli/cmds/start_archiver.js +5 -7
- 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 +1 -1
- package/dest/cli/cmds/start_node.d.ts.map +1 -1
- package/dest/cli/cmds/start_node.js +62 -10
- 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 +1 -2
- 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 -3
- 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 +2 -2
- package/dest/cli/util.d.ts +5 -14
- package/dest/cli/util.d.ts.map +1 -1
- package/dest/cli/util.js +11 -6
- package/dest/examples/token.js +5 -5
- 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 +2 -2
- package/dest/local-network/local-network.d.ts +4 -3
- package/dest/local-network/local-network.d.ts.map +1 -1
- package/dest/local-network/local-network.js +35 -20
- 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 +62 -0
- 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/package.json +37 -35
- package/scripts/aztec.sh +63 -0
- package/scripts/compile.sh +44 -0
- package/scripts/extract_function.js +47 -0
- package/scripts/flamegraph.sh +59 -0
- package/scripts/init.sh +35 -0
- package/scripts/new.sh +59 -0
- package/scripts/setup_project.sh +31 -0
- package/src/bin/index.ts +2 -0
- package/src/cli/admin_api_key_store.ts +128 -0
- package/src/cli/aztec_start_action.ts +53 -4
- package/src/cli/aztec_start_options.ts +27 -6
- package/src/cli/cli.ts +12 -56
- package/src/cli/cmds/migrate_ha_db.ts +43 -0
- package/src/cli/cmds/start_archiver.ts +2 -13
- package/src/cli/cmds/start_bot.ts +8 -5
- package/src/cli/cmds/start_node.ts +51 -9
- package/src/cli/cmds/start_p2p_bootstrap.ts +2 -2
- package/src/cli/cmds/start_prover_agent.ts +3 -11
- package/src/cli/cmds/start_prover_broker.ts +5 -1
- package/src/cli/util.ts +15 -20
- package/src/examples/token.ts +5 -7
- package/src/local-network/banana_fpc.ts +10 -6
- package/src/local-network/local-network.ts +53 -27
- package/src/testing/epoch_test_settler.ts +71 -0
- package/src/testing/index.ts +1 -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/src/cli/cmds/start_prover_node.ts +0 -124
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
import { randomBytes } from '@aztec/foundation/crypto/random';
|
|
2
|
+
import { sha256Hash } from '@aztec/foundation/json-rpc/server';
|
|
3
|
+
import type { Logger } from '@aztec/foundation/log';
|
|
4
|
+
|
|
5
|
+
import { promises as fs } from 'fs';
|
|
6
|
+
import { join } from 'path';
|
|
7
|
+
|
|
8
|
+
/** Subdirectory under dataDirectory for admin API key storage. */
|
|
9
|
+
const ADMIN_STORE_DIR = 'admin';
|
|
10
|
+
const HASH_FILE_NAME = 'api_key_hash';
|
|
11
|
+
|
|
12
|
+
/**
|
|
13
|
+
* Result of resolving the admin API key.
|
|
14
|
+
* Contains the SHA-256 hex hash of the API key to be used by the auth middleware,
|
|
15
|
+
* and optionally the raw key when newly generated (so the caller can display it).
|
|
16
|
+
*/
|
|
17
|
+
export interface AdminApiKeyResolution {
|
|
18
|
+
/** The SHA-256 hash of the API key. */
|
|
19
|
+
apiKeyHash: Buffer;
|
|
20
|
+
/**
|
|
21
|
+
* The raw API key, only present when a new key was generated during this call.
|
|
22
|
+
* The caller MUST display this to the operator — it will not be stored or returned again.
|
|
23
|
+
*/
|
|
24
|
+
rawKey?: string;
|
|
25
|
+
}
|
|
26
|
+
|
|
27
|
+
export interface ResolveAdminApiKeyOptions {
|
|
28
|
+
/** SHA-256 hex hash of a pre-generated API key. When set, the node uses this hash directly. */
|
|
29
|
+
adminApiKeyHash?: string;
|
|
30
|
+
/** If true, disable admin API key auth entirely. */
|
|
31
|
+
noAdminApiKey?: boolean;
|
|
32
|
+
/** If true, force-generate a new key even if one is already persisted. */
|
|
33
|
+
resetAdminApiKey?: boolean;
|
|
34
|
+
/** Root data directory for persistent storage. */
|
|
35
|
+
dataDirectory?: string;
|
|
36
|
+
}
|
|
37
|
+
|
|
38
|
+
/**
|
|
39
|
+
* Resolves the admin API key for the admin RPC endpoint.
|
|
40
|
+
*
|
|
41
|
+
* Strategy:
|
|
42
|
+
* 1. If opt-out flag is set (`noAdminApiKey`), return undefined (no auth).
|
|
43
|
+
* 2. If a pre-generated hash is provided (`adminApiKeyHash`), use it directly.
|
|
44
|
+
* 3. If a data directory exists, look for a persisted hash file
|
|
45
|
+
* at `<dataDirectory>/admin/api_key_hash`:
|
|
46
|
+
* - If `resetAdminApiKey` is set, skip loading and force-generate a new key.
|
|
47
|
+
* - Found: use the stored hash (operator already saved the key from first run).
|
|
48
|
+
* - Not found: auto-generate a random key, display it once, persist the hash.
|
|
49
|
+
* 3. If no data directory: generate a random key
|
|
50
|
+
* each run and display it (cannot persist).
|
|
51
|
+
*
|
|
52
|
+
* @param options - The options for resolving the admin API key.
|
|
53
|
+
* @param log - Logger for outputting the key and status messages.
|
|
54
|
+
* @returns The resolved API key hash, or undefined if auth is disabled.
|
|
55
|
+
*/
|
|
56
|
+
export async function resolveAdminApiKey(
|
|
57
|
+
options: ResolveAdminApiKeyOptions,
|
|
58
|
+
log: Logger,
|
|
59
|
+
): Promise<AdminApiKeyResolution | undefined> {
|
|
60
|
+
// Operator explicitly opted out of admin auth
|
|
61
|
+
if (options.noAdminApiKey) {
|
|
62
|
+
log.warn('Admin API key authentication is DISABLED (--no-admin-api-key / AZTEC_NO_ADMIN_API_KEY)');
|
|
63
|
+
return undefined;
|
|
64
|
+
}
|
|
65
|
+
|
|
66
|
+
// Operator provided a pre-generated hash (e.g. via AZTEC_ADMIN_API_KEY_HASH env var)
|
|
67
|
+
if (options.adminApiKeyHash) {
|
|
68
|
+
const hex = options.adminApiKeyHash.trim();
|
|
69
|
+
if (hex.length !== 64 || !/^[0-9a-f]{64}$/.test(hex)) {
|
|
70
|
+
throw new Error(`Invalid admin API key hash: expected 64-char hex string, got "${hex}"`);
|
|
71
|
+
}
|
|
72
|
+
log.info('Admin API key authentication enabled (using pre-configured key hash)');
|
|
73
|
+
return { apiKeyHash: Buffer.from(hex, 'hex') };
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
// Persistent storage available, load or generate key
|
|
77
|
+
if (options.dataDirectory) {
|
|
78
|
+
const adminDir = join(options.dataDirectory, ADMIN_STORE_DIR);
|
|
79
|
+
const hashFilePath = join(adminDir, HASH_FILE_NAME);
|
|
80
|
+
|
|
81
|
+
// Unless a reset is forced, try to load the existing hash from disk
|
|
82
|
+
if (!options.resetAdminApiKey) {
|
|
83
|
+
try {
|
|
84
|
+
const storedHash = (await fs.readFile(hashFilePath, 'utf-8')).trim();
|
|
85
|
+
if (storedHash.length === 64) {
|
|
86
|
+
log.info('Admin API key authentication enabled (loaded stored key hash from disk)');
|
|
87
|
+
return { apiKeyHash: Buffer.from(storedHash, 'hex') };
|
|
88
|
+
}
|
|
89
|
+
log.warn(`Invalid stored admin API key hash at ${hashFilePath}, regenerating...`);
|
|
90
|
+
} catch (err: any) {
|
|
91
|
+
if (err.code !== 'ENOENT') {
|
|
92
|
+
log.warn(`Failed to read admin API key hash from ${hashFilePath}: ${err.message}`);
|
|
93
|
+
}
|
|
94
|
+
// File doesn't exist — fall through to generate
|
|
95
|
+
}
|
|
96
|
+
} else {
|
|
97
|
+
log.warn('Admin API key reset requested — generating a new key');
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
// Generate a new key, persist the hash, and return the raw key for the caller to display
|
|
101
|
+
const { rawKey, hash } = generateApiKey();
|
|
102
|
+
await fs.mkdir(adminDir, { recursive: true });
|
|
103
|
+
await fs.writeFile(hashFilePath, hash.toString('hex'), 'utf-8');
|
|
104
|
+
// Set restrictive permissions (owner read/write only)
|
|
105
|
+
await fs.chmod(hashFilePath, 0o600);
|
|
106
|
+
|
|
107
|
+
log.info('Admin API key authentication enabled (new key generated and hash persisted to disk)');
|
|
108
|
+
return { apiKeyHash: hash, rawKey };
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
// No data directory, generate a temporary key per session
|
|
112
|
+
const { rawKey, hash } = generateApiKey();
|
|
113
|
+
|
|
114
|
+
log.warn('No data directory configured — admin API key cannot be persisted.');
|
|
115
|
+
log.warn('A temporary key has been generated for this session only.');
|
|
116
|
+
|
|
117
|
+
return { apiKeyHash: hash, rawKey };
|
|
118
|
+
}
|
|
119
|
+
|
|
120
|
+
/**
|
|
121
|
+
* Generates a cryptographically random API key and its SHA-256 hash.
|
|
122
|
+
* @returns The raw key (hex string) and its SHA-256 hash as a Buffer.
|
|
123
|
+
*/
|
|
124
|
+
function generateApiKey(): { rawKey: string; hash: Buffer } {
|
|
125
|
+
const rawKey = randomBytes(32).toString('hex');
|
|
126
|
+
const hash = sha256Hash(rawKey);
|
|
127
|
+
return { rawKey, hash };
|
|
128
|
+
}
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
import {
|
|
2
2
|
type NamespacedApiHandlers,
|
|
3
3
|
createNamespacedSafeJsonRpcServer,
|
|
4
|
+
getApiKeyAuthMiddleware,
|
|
4
5
|
startHttpRpcServer,
|
|
5
6
|
} from '@aztec/foundation/json-rpc/server';
|
|
6
7
|
import type { LogFn, Logger } from '@aztec/foundation/log';
|
|
@@ -11,6 +12,7 @@ import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
|
|
|
11
12
|
|
|
12
13
|
import { createLocalNetwork } from '../local-network/index.js';
|
|
13
14
|
import { github, splash } from '../splash.js';
|
|
15
|
+
import { resolveAdminApiKey } from './admin_api_key_store.js';
|
|
14
16
|
import { getCliVersion } from './release_version.js';
|
|
15
17
|
import { extractNamespacedOptions, installSignalHandlers } from './util.js';
|
|
16
18
|
import { getVersions } from './versioning.js';
|
|
@@ -35,6 +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,
|
|
40
|
+
// Setting the epoch duration to 4 by default for local network. This allows the epoch to be "proven" faster, so
|
|
41
|
+
// the users can consume out hash without having to wait for a long time.
|
|
42
|
+
// Note: We are not proving anything in the local network (realProofs == false). But in `createLocalNetwork`,
|
|
43
|
+
// the EpochTestSettler will set the out hash to the outbox when an epoch is complete.
|
|
44
|
+
aztecEpochDuration: 4,
|
|
38
45
|
},
|
|
39
46
|
userLog,
|
|
40
47
|
);
|
|
@@ -43,15 +50,17 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
43
50
|
signalHandlers.push(stop);
|
|
44
51
|
services.node = [node, AztecNodeApiSchema];
|
|
45
52
|
} else {
|
|
53
|
+
// Route --prover-node through startNode
|
|
54
|
+
if (options.proverNode && !options.node) {
|
|
55
|
+
options.node = true;
|
|
56
|
+
}
|
|
57
|
+
|
|
46
58
|
if (options.node) {
|
|
47
59
|
const { startNode } = await import('./cmds/start_node.js');
|
|
48
60
|
({ config } = await startNode(options, signalHandlers, services, adminServices, userLog));
|
|
49
61
|
} else if (options.bot) {
|
|
50
62
|
const { startBot } = await import('./cmds/start_bot.js');
|
|
51
63
|
await startBot(options, signalHandlers, services, userLog);
|
|
52
|
-
} else if (options.proverNode) {
|
|
53
|
-
const { startProverNode } = await import('./cmds/start_prover_node.js');
|
|
54
|
-
({ config } = await startProverNode(options, signalHandlers, services, userLog));
|
|
55
64
|
} else if (options.archiver) {
|
|
56
65
|
const { startArchiver } = await import('./cmds/start_archiver.js');
|
|
57
66
|
({ config } = await startArchiver(options, signalHandlers, services));
|
|
@@ -94,14 +103,54 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
94
103
|
|
|
95
104
|
// If there are any admin services, start a separate JSON-RPC server for them
|
|
96
105
|
if (Object.entries(adminServices).length > 0) {
|
|
106
|
+
const adminMiddlewares = [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)];
|
|
107
|
+
|
|
108
|
+
// Resolve the admin API key (auto-generated and persisted, or opt-out)
|
|
109
|
+
const apiKeyResolution = await resolveAdminApiKey(
|
|
110
|
+
{
|
|
111
|
+
adminApiKeyHash: options.adminApiKeyHash,
|
|
112
|
+
noAdminApiKey: options.noAdminApiKey,
|
|
113
|
+
resetAdminApiKey: options.resetAdminApiKey,
|
|
114
|
+
dataDirectory: options.dataDirectory,
|
|
115
|
+
},
|
|
116
|
+
debugLogger,
|
|
117
|
+
);
|
|
118
|
+
if (apiKeyResolution) {
|
|
119
|
+
adminMiddlewares.unshift(getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash));
|
|
120
|
+
} else {
|
|
121
|
+
debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
|
|
122
|
+
}
|
|
123
|
+
|
|
97
124
|
const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
|
|
98
125
|
http200OnError: false,
|
|
99
126
|
log: debugLogger,
|
|
100
|
-
middlewares:
|
|
127
|
+
middlewares: adminMiddlewares,
|
|
101
128
|
maxBatchSize: options.rpcMaxBatchSize,
|
|
102
129
|
maxBodySizeBytes: options.rpcMaxBodySize,
|
|
103
130
|
});
|
|
104
131
|
const { port } = await startHttpRpcServer(rpcServer, { port: options.adminPort });
|
|
105
132
|
debugLogger.info(`Aztec Server admin API listening on port ${port}`, versions);
|
|
133
|
+
|
|
134
|
+
// Display the API key after the server has started
|
|
135
|
+
// Uses userLog which is never filtered by LOG_LEVEL.
|
|
136
|
+
if (apiKeyResolution?.rawKey) {
|
|
137
|
+
const separator = '='.repeat(70);
|
|
138
|
+
userLog('');
|
|
139
|
+
userLog(separator);
|
|
140
|
+
userLog(' ADMIN API KEY (save this — it will NOT be shown again)');
|
|
141
|
+
userLog('');
|
|
142
|
+
userLog(` ${apiKeyResolution.rawKey}`);
|
|
143
|
+
userLog('');
|
|
144
|
+
userLog(` Use via header: x-api-key: <key>`);
|
|
145
|
+
userLog(` Or via header: Authorization: Bearer <key>`);
|
|
146
|
+
if (options.dataDirectory) {
|
|
147
|
+
userLog('');
|
|
148
|
+
userLog(' The key hash has been persisted — on next restart, the same key will be used.');
|
|
149
|
+
}
|
|
150
|
+
userLog('');
|
|
151
|
+
userLog(' To disable admin auth: --no-admin-api-key or AZTEC_NO_ADMIN_API_KEY=true');
|
|
152
|
+
userLog(separator);
|
|
153
|
+
userLog('');
|
|
154
|
+
}
|
|
106
155
|
}
|
|
107
156
|
}
|
|
@@ -19,7 +19,7 @@ import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/pr
|
|
|
19
19
|
import { proverNodeConfigMappings } from '@aztec/prover-node/config';
|
|
20
20
|
import { allPxeConfigMappings } from '@aztec/pxe/config';
|
|
21
21
|
import { sequencerClientConfigMappings } from '@aztec/sequencer-client/config';
|
|
22
|
-
import { chainConfigMappings } from '@aztec/stdlib/config';
|
|
22
|
+
import { chainConfigMappings, nodeRpcConfigMappings } from '@aztec/stdlib/config';
|
|
23
23
|
import { telemetryClientConfigMappings } from '@aztec/telemetry-client/config';
|
|
24
24
|
import { worldStateConfigMappings } from '@aztec/world-state/config';
|
|
25
25
|
|
|
@@ -142,12 +142,37 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
142
142
|
env: 'AZTEC_ADMIN_PORT',
|
|
143
143
|
parseVal: val => parseInt(val, 10),
|
|
144
144
|
},
|
|
145
|
+
{
|
|
146
|
+
flag: '--admin-api-key-hash <value>',
|
|
147
|
+
description:
|
|
148
|
+
'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.',
|
|
149
|
+
defaultValue: undefined,
|
|
150
|
+
env: 'AZTEC_ADMIN_API_KEY_HASH',
|
|
151
|
+
},
|
|
152
|
+
{
|
|
153
|
+
flag: '--no-admin-api-key',
|
|
154
|
+
description:
|
|
155
|
+
'Disable API key authentication on the admin RPC endpoint. By default, a key is auto-generated, displayed once, and its hash is persisted.',
|
|
156
|
+
defaultValue: false,
|
|
157
|
+
env: 'AZTEC_NO_ADMIN_API_KEY',
|
|
158
|
+
parseVal: val => 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
|
+
},
|
|
145
168
|
{
|
|
146
169
|
flag: '--api-prefix <value>',
|
|
147
170
|
description: 'Prefix for API routes on any service that is started',
|
|
148
171
|
defaultValue: '',
|
|
149
172
|
env: 'API_PREFIX',
|
|
150
173
|
},
|
|
174
|
+
configToFlag('--rpcMaxBatchSize', nodeRpcConfigMappings.rpcMaxBatchSize),
|
|
175
|
+
configToFlag('--rpcMaxBodySize', nodeRpcConfigMappings.rpcMaxBodySize),
|
|
151
176
|
],
|
|
152
177
|
ETHEREUM: [
|
|
153
178
|
configToFlag('--l1-chain-id', l1ReaderConfigMappings.l1ChainId),
|
|
@@ -168,7 +193,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
168
193
|
'WORLD STATE': [
|
|
169
194
|
configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
|
|
170
195
|
configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
|
|
171
|
-
configToFlag('--world-state-
|
|
196
|
+
configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory),
|
|
172
197
|
],
|
|
173
198
|
// We can't easily auto-generate node options as they're parts of modules defined below
|
|
174
199
|
'AZTEC NODE': [
|
|
@@ -220,12 +245,8 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
220
245
|
'proverNode',
|
|
221
246
|
omitConfigMappings(proverNodeConfigMappings, [
|
|
222
247
|
// filter out options passed separately
|
|
223
|
-
...getKeys(archiverConfigMappings),
|
|
224
248
|
...getKeys(proverBrokerConfigMappings),
|
|
225
249
|
...getKeys(proverAgentConfigMappings),
|
|
226
|
-
...getKeys(p2pConfigMappings),
|
|
227
|
-
...getKeys(worldStateConfigMappings),
|
|
228
|
-
...getKeys(sharedNodeConfigMappings),
|
|
229
250
|
]),
|
|
230
251
|
),
|
|
231
252
|
],
|
package/src/cli/cli.ts
CHANGED
|
@@ -31,63 +31,19 @@ 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
|
-
|
|
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 [folder] [options] creates a new Aztec Noir project.
|
|
41
|
+
new <path> [options] creates a new Aztec Noir project in a new directory.
|
|
42
|
+
compile [options] compiles Aztec Noir contracts.
|
|
43
|
+
test [options] starts a TXE and runs "nargo test" using it as the oracle resolver.
|
|
89
44
|
`,
|
|
90
|
-
|
|
45
|
+
);
|
|
46
|
+
}
|
|
91
47
|
|
|
92
48
|
program
|
|
93
49
|
.command('preload-crs')
|
|
@@ -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
|
+
}
|
|
@@ -1,16 +1,9 @@
|
|
|
1
|
-
import {
|
|
2
|
-
Archiver,
|
|
3
|
-
type ArchiverConfig,
|
|
4
|
-
KVArchiverDataStore,
|
|
5
|
-
archiverConfigMappings,
|
|
6
|
-
getArchiverConfigFromEnv,
|
|
7
|
-
} from '@aztec/archiver';
|
|
1
|
+
import { type ArchiverConfig, archiverConfigMappings, createArchiver, getArchiverConfigFromEnv } from '@aztec/archiver';
|
|
8
2
|
import { createLogger } from '@aztec/aztec.js/log';
|
|
9
3
|
import { type BlobClientConfig, blobClientConfigMapping, createBlobClient } from '@aztec/blob-client/client';
|
|
10
4
|
import { getL1Config } from '@aztec/cli/config';
|
|
11
5
|
import type { NamespacedApiHandlers } from '@aztec/foundation/json-rpc/server';
|
|
12
6
|
import { type DataStoreConfig, dataConfigMappings } from '@aztec/kv-store/config';
|
|
13
|
-
import { createStore } from '@aztec/kv-store/lmdb-v2';
|
|
14
7
|
import { ArchiverApiSchema } from '@aztec/stdlib/interfaces/server';
|
|
15
8
|
import { getConfigEnvVars as getTelemetryClientConfig, initTelemetryClient } from '@aztec/telemetry-client';
|
|
16
9
|
|
|
@@ -47,13 +40,9 @@ export async function startArchiver(
|
|
|
47
40
|
archiverConfig.l1Contracts = addresses;
|
|
48
41
|
archiverConfig = { ...archiverConfig, ...l1Config };
|
|
49
42
|
|
|
50
|
-
const storeLog = createLogger('archiver:lmdb');
|
|
51
|
-
const store = await createStore('archiver', KVArchiverDataStore.SCHEMA_VERSION, archiverConfig, storeLog);
|
|
52
|
-
const archiverStore = new KVArchiverDataStore(store, archiverConfig.maxLogs);
|
|
53
|
-
|
|
54
43
|
const telemetry = await initTelemetryClient(getTelemetryClientConfig());
|
|
55
44
|
const blobClient = createBlobClient(archiverConfig, { logger: createLogger('archiver:blob-client:client') });
|
|
56
|
-
const archiver = await
|
|
45
|
+
const archiver = await createArchiver(archiverConfig, { telemetry, blobClient }, { blockUntilSync: true });
|
|
57
46
|
services.archiver = [archiver, ArchiverApiSchema];
|
|
58
47
|
signalHandlers.push(archiver.stop);
|
|
59
48
|
|
|
@@ -10,9 +10,9 @@ import {
|
|
|
10
10
|
initTelemetryClient,
|
|
11
11
|
makeTracedFetch,
|
|
12
12
|
} from '@aztec/telemetry-client';
|
|
13
|
-
import {
|
|
13
|
+
import { EmbeddedWallet } from '@aztec/wallets/embedded';
|
|
14
14
|
|
|
15
|
-
import { extractRelevantOptions } from '../util.js';
|
|
15
|
+
import { extractRelevantOptions, stringifyConfig } from '../util.js';
|
|
16
16
|
import { getVersions } from '../versioning.js';
|
|
17
17
|
|
|
18
18
|
export async function startBot(
|
|
@@ -38,22 +38,25 @@ export async function startBot(
|
|
|
38
38
|
const aztecNode = createAztecNodeClient(config.nodeUrl, getVersions(), fetch);
|
|
39
39
|
|
|
40
40
|
const pxeConfig = extractRelevantOptions<PXEConfig & CliPXEOptions>(options, allPxeConfigMappings, 'pxe');
|
|
41
|
-
|
|
41
|
+
userLog(`Creating bot wallet with config ${stringifyConfig(pxeConfig)}`);
|
|
42
|
+
const wallet = await EmbeddedWallet.create(aztecNode, { pxeConfig });
|
|
42
43
|
|
|
43
44
|
const telemetry = await initTelemetryClient(getTelemetryClientConfig());
|
|
44
|
-
await addBot(options, signalHandlers, services, wallet, aztecNode, telemetry, undefined);
|
|
45
|
+
await addBot(options, signalHandlers, services, wallet, aztecNode, telemetry, undefined, userLog);
|
|
45
46
|
}
|
|
46
47
|
|
|
47
48
|
export async function addBot(
|
|
48
49
|
options: any,
|
|
49
50
|
signalHandlers: (() => Promise<void>)[],
|
|
50
51
|
services: NamespacedApiHandlers,
|
|
51
|
-
wallet:
|
|
52
|
+
wallet: EmbeddedWallet,
|
|
52
53
|
aztecNode: AztecNode,
|
|
53
54
|
telemetry: TelemetryClient,
|
|
54
55
|
aztecNodeAdmin?: AztecNodeAdmin,
|
|
56
|
+
userLog?: LogFn,
|
|
55
57
|
) {
|
|
56
58
|
const config = extractRelevantOptions<BotConfig>(options, botConfigMappings, 'bot');
|
|
59
|
+
userLog?.(`Starting bot with config ${stringifyConfig(config)}`);
|
|
57
60
|
|
|
58
61
|
const db = await (config.dataDirectory
|
|
59
62
|
? createStore('bot', BotStore.SCHEMA_VERSION, config)
|
|
@@ -6,16 +6,19 @@ import { getL1Config } from '@aztec/cli/config';
|
|
|
6
6
|
import { getPublicClient } from '@aztec/ethereum/client';
|
|
7
7
|
import { SecretValue } from '@aztec/foundation/config';
|
|
8
8
|
import type { NamespacedApiHandlers } from '@aztec/foundation/json-rpc/server';
|
|
9
|
+
import { Agent, makeUndiciFetch } from '@aztec/foundation/json-rpc/undici';
|
|
9
10
|
import type { LogFn } from '@aztec/foundation/log';
|
|
11
|
+
import { ProvingJobConsumerSchema, createProvingJobBrokerClient } from '@aztec/prover-client/broker';
|
|
10
12
|
import { type CliPXEOptions, type PXEConfig, allPxeConfigMappings } from '@aztec/pxe/config';
|
|
11
13
|
import { AztecNodeAdminApiSchema, AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
|
|
12
|
-
import { P2PApiSchema } from '@aztec/stdlib/interfaces/server';
|
|
14
|
+
import { P2PApiSchema, ProverNodeApiSchema, type ProvingJobBroker } from '@aztec/stdlib/interfaces/server';
|
|
13
15
|
import {
|
|
14
16
|
type TelemetryClientConfig,
|
|
15
17
|
initTelemetryClient,
|
|
18
|
+
makeTracedFetch,
|
|
16
19
|
telemetryClientConfigMappings,
|
|
17
20
|
} from '@aztec/telemetry-client';
|
|
18
|
-
import {
|
|
21
|
+
import { EmbeddedWallet } from '@aztec/wallets/embedded';
|
|
19
22
|
import { getGenesisValues } from '@aztec/world-state/testing';
|
|
20
23
|
|
|
21
24
|
import { createAztecNode } from '../../local-network/index.js';
|
|
@@ -25,6 +28,8 @@ import {
|
|
|
25
28
|
preloadCrsDataForVerifying,
|
|
26
29
|
setupUpdateMonitor,
|
|
27
30
|
} from '../util.js';
|
|
31
|
+
import { getVersions } from '../versioning.js';
|
|
32
|
+
import { startProverBroker } from './start_prover_broker.js';
|
|
28
33
|
|
|
29
34
|
export async function startNode(
|
|
30
35
|
options: any,
|
|
@@ -45,9 +50,32 @@ export async function startNode(
|
|
|
45
50
|
...relevantOptions,
|
|
46
51
|
};
|
|
47
52
|
|
|
53
|
+
// Prover node configuration and broker setup
|
|
54
|
+
// REFACTOR: Move the broker setup out of here and into the prover-node factory
|
|
55
|
+
let broker: ProvingJobBroker | undefined = undefined;
|
|
48
56
|
if (options.proverNode) {
|
|
49
|
-
|
|
50
|
-
|
|
57
|
+
nodeConfig.enableProverNode = true;
|
|
58
|
+
if (nodeConfig.proverAgentCount === 0) {
|
|
59
|
+
userLog(
|
|
60
|
+
`Running prover node without local prover agent. Connect prover agents or pass --proverAgent.proverAgentCount`,
|
|
61
|
+
);
|
|
62
|
+
}
|
|
63
|
+
if (nodeConfig.proverBrokerUrl) {
|
|
64
|
+
// at 1TPS we'd enqueue ~1k chonk verifier proofs and ~1k AVM proofs immediately
|
|
65
|
+
// set a lower connection limit such that we don't overload the server
|
|
66
|
+
// Keep retrying up to 30s
|
|
67
|
+
const fetch = makeTracedFetch(
|
|
68
|
+
[1, 2, 3, 3, 3, 3, 3, 3, 3, 3, 3],
|
|
69
|
+
false,
|
|
70
|
+
makeUndiciFetch(new Agent({ connections: 100 })),
|
|
71
|
+
);
|
|
72
|
+
broker = createProvingJobBrokerClient(nodeConfig.proverBrokerUrl, getVersions(nodeConfig), fetch);
|
|
73
|
+
} else if (options.proverBroker) {
|
|
74
|
+
({ broker } = await startProverBroker(options, signalHandlers, services, userLog));
|
|
75
|
+
} else {
|
|
76
|
+
userLog(`--prover-broker-url or --prover-broker is required to start a Prover Node`);
|
|
77
|
+
process.exit(1);
|
|
78
|
+
}
|
|
51
79
|
}
|
|
52
80
|
|
|
53
81
|
await preloadCrsDataForVerifying(nodeConfig, userLog);
|
|
@@ -101,12 +129,17 @@ export async function startNode(
|
|
|
101
129
|
...extractNamespacedOptions(options, 'sequencer'),
|
|
102
130
|
};
|
|
103
131
|
// If no publisher private keys have been given, use the first validator key
|
|
104
|
-
if (
|
|
132
|
+
if (
|
|
133
|
+
sequencerConfig.sequencerPublisherPrivateKeys === undefined ||
|
|
134
|
+
!sequencerConfig.sequencerPublisherPrivateKeys.length
|
|
135
|
+
) {
|
|
105
136
|
if (sequencerConfig.validatorPrivateKeys?.getValue().length) {
|
|
106
|
-
sequencerConfig.
|
|
137
|
+
sequencerConfig.sequencerPublisherPrivateKeys = [
|
|
138
|
+
new SecretValue(sequencerConfig.validatorPrivateKeys.getValue()[0]),
|
|
139
|
+
];
|
|
107
140
|
}
|
|
108
141
|
}
|
|
109
|
-
nodeConfig.
|
|
142
|
+
nodeConfig.sequencerPublisherPrivateKeys = sequencerConfig.sequencerPublisherPrivateKeys;
|
|
110
143
|
}
|
|
111
144
|
|
|
112
145
|
if (nodeConfig.p2pEnabled) {
|
|
@@ -120,13 +153,22 @@ export async function startNode(
|
|
|
120
153
|
const telemetry = await initTelemetryClient(telemetryConfig);
|
|
121
154
|
|
|
122
155
|
// Create and start Aztec Node
|
|
123
|
-
const node = await createAztecNode(nodeConfig, { telemetry }, { prefilledPublicData });
|
|
156
|
+
const node = await createAztecNode(nodeConfig, { telemetry, proverBroker: broker }, { prefilledPublicData });
|
|
124
157
|
|
|
125
158
|
// Add node and p2p to services list
|
|
126
159
|
services.node = [node, AztecNodeApiSchema];
|
|
127
160
|
services.p2p = [node.getP2P(), P2PApiSchema];
|
|
128
161
|
adminServices.nodeAdmin = [node, AztecNodeAdminApiSchema];
|
|
129
162
|
|
|
163
|
+
// Register prover-node services if the prover node subsystem is running
|
|
164
|
+
const proverNode = node.getProverNode();
|
|
165
|
+
if (proverNode) {
|
|
166
|
+
services.prover = [proverNode, ProverNodeApiSchema];
|
|
167
|
+
if (!nodeConfig.proverBrokerUrl) {
|
|
168
|
+
services.provingJobSource = [proverNode.getProver().getProvingJobSource(), ProvingJobConsumerSchema];
|
|
169
|
+
}
|
|
170
|
+
}
|
|
171
|
+
|
|
130
172
|
// Add node stop function to signal handlers
|
|
131
173
|
signalHandlers.push(node.stop.bind(node));
|
|
132
174
|
|
|
@@ -135,7 +177,7 @@ export async function startNode(
|
|
|
135
177
|
const { addBot } = await import('./start_bot.js');
|
|
136
178
|
|
|
137
179
|
const pxeConfig = extractRelevantOptions<PXEConfig & CliPXEOptions>(options, allPxeConfigMappings, 'pxe');
|
|
138
|
-
const wallet = await
|
|
180
|
+
const wallet = await EmbeddedWallet.create(node, { pxeConfig });
|
|
139
181
|
|
|
140
182
|
await addBot(options, signalHandlers, services, wallet, node, telemetry, undefined);
|
|
141
183
|
}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { jsonStringify } from '@aztec/foundation/json-rpc';
|
|
2
2
|
import type { NamespacedApiHandlers } from '@aztec/foundation/json-rpc/server';
|
|
3
|
-
import {
|
|
3
|
+
import type { LogFn } from '@aztec/foundation/log';
|
|
4
4
|
import { createStore } from '@aztec/kv-store/lmdb-v2';
|
|
5
5
|
import { type BootnodeConfig, BootstrapNode, bootnodeConfigMappings } from '@aztec/p2p';
|
|
6
6
|
import { emptyChainConfig } from '@aztec/stdlib/config';
|
|
@@ -27,7 +27,7 @@ export async function startP2PBootstrap(
|
|
|
27
27
|
const telemetryConfig = extractRelevantOptions<TelemetryClientConfig>(options, telemetryClientConfigMappings, 'tel');
|
|
28
28
|
const telemetryClient = await initTelemetryClient(telemetryConfig);
|
|
29
29
|
|
|
30
|
-
const store = await createStore('p2p-bootstrap', 1, config
|
|
30
|
+
const store = await createStore('p2p-bootstrap', 1, config);
|
|
31
31
|
const node = new BootstrapNode(store, telemetryClient);
|
|
32
32
|
await node.start(config);
|
|
33
33
|
signalHandlers.push(() => node.stop());
|
|
@@ -4,9 +4,9 @@ import { Agent, makeUndiciFetch } from '@aztec/foundation/json-rpc/undici';
|
|
|
4
4
|
import type { LogFn } from '@aztec/foundation/log';
|
|
5
5
|
import { buildServerCircuitProver } from '@aztec/prover-client';
|
|
6
6
|
import {
|
|
7
|
-
InlineProofStore,
|
|
8
7
|
type ProverAgentConfig,
|
|
9
8
|
ProvingAgent,
|
|
9
|
+
createProofStore,
|
|
10
10
|
createProvingJobBrokerClient,
|
|
11
11
|
proverAgentConfigMappings,
|
|
12
12
|
} from '@aztec/prover-client/broker';
|
|
@@ -55,18 +55,10 @@ export async function startProverAgent(
|
|
|
55
55
|
|
|
56
56
|
const telemetry = await initTelemetryClient(extractRelevantOptions(options, telemetryClientConfigMappings, 'tel'));
|
|
57
57
|
const prover = await buildServerCircuitProver(config, telemetry);
|
|
58
|
-
const proofStore =
|
|
58
|
+
const proofStore = await createProofStore(config.proofStore);
|
|
59
59
|
const agents = times(
|
|
60
60
|
config.proverAgentCount,
|
|
61
|
-
() =>
|
|
62
|
-
new ProvingAgent(
|
|
63
|
-
broker,
|
|
64
|
-
proofStore,
|
|
65
|
-
prover,
|
|
66
|
-
config.proverAgentProofTypes,
|
|
67
|
-
config.proverAgentPollIntervalMs,
|
|
68
|
-
telemetry,
|
|
69
|
-
),
|
|
61
|
+
() => new ProvingAgent(broker, proofStore, prover, config.proverAgentProofTypes, config.proverAgentPollIntervalMs),
|
|
70
62
|
);
|
|
71
63
|
|
|
72
64
|
// expose all agents as individual services
|