@aztec/aztec 0.0.1-commit.6d63667d → 0.0.1-commit.7b97ef96e
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 +3 -1
- 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 +46 -10
- 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 +22 -6
- package/dest/cli/cli.d.ts +1 -1
- package/dest/cli/cli.d.ts.map +1 -1
- package/dest/cli/cli.js +0 -1
- 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 +95 -0
- 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/util.d.ts +5 -14
- package/dest/cli/util.d.ts.map +1 -1
- package/dest/cli/util.js +10 -5
- package/dest/examples/token.js +2 -2
- package/dest/local-network/local-network.d.ts +3 -1
- package/dest/local-network/local-network.d.ts.map +1 -1
- package/dest/local-network/local-network.js +32 -13
- package/dest/testing/anvil_test_watcher.d.ts +9 -1
- package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
- package/dest/testing/anvil_test_watcher.js +52 -15
- package/package.json +34 -34
- package/scripts/aztec.sh +3 -4
- package/src/bin/index.ts +3 -1
- package/src/cli/admin_api_key_store.ts +128 -0
- package/src/cli/aztec_start_action.ts +50 -6
- package/src/cli/aztec_start_options.ts +24 -5
- package/src/cli/cli.ts +0 -1
- package/src/cli/cmds/compile.ts +107 -0
- package/src/cli/cmds/start_bot.ts +8 -5
- package/src/cli/cmds/start_node.ts +51 -9
- package/src/cli/util.ts +14 -19
- package/src/examples/token.ts +2 -2
- package/src/local-network/local-network.ts +41 -14
- package/src/testing/anvil_test_watcher.ts +59 -15
- 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/scripts/compile.sh +0 -44
- package/src/cli/cmds/start_prover_node.ts +0 -124
package/src/bin/index.ts
CHANGED
|
@@ -14,6 +14,7 @@ import { createConsoleLogger, createLogger } from '@aztec/foundation/log';
|
|
|
14
14
|
|
|
15
15
|
import { Command } from 'commander';
|
|
16
16
|
|
|
17
|
+
import { injectCompileCommand } from '../cli/cmds/compile.js';
|
|
17
18
|
import { injectMigrateCommand } from '../cli/cmds/migrate_ha_db.js';
|
|
18
19
|
import { injectAztecCommands } from '../cli/index.js';
|
|
19
20
|
import { getCliVersion } from '../cli/release_version.js';
|
|
@@ -47,7 +48,7 @@ async function main() {
|
|
|
47
48
|
|
|
48
49
|
const cliVersion = getCliVersion();
|
|
49
50
|
let program = new Command('aztec');
|
|
50
|
-
program.description('Aztec command line interface').version(cliVersion);
|
|
51
|
+
program.description('Aztec command line interface').version(cliVersion).enablePositionalOptions();
|
|
51
52
|
program = injectAztecCommands(program, userLog, debugLogger);
|
|
52
53
|
program = injectBuilderCommands(program);
|
|
53
54
|
program = injectContractCommands(program, userLog, debugLogger);
|
|
@@ -56,6 +57,7 @@ async function main() {
|
|
|
56
57
|
program = injectAztecNodeCommands(program, userLog, debugLogger);
|
|
57
58
|
program = injectMiscCommands(program, userLog);
|
|
58
59
|
program = injectValidatorKeysCommands(program, userLog);
|
|
60
|
+
program = injectCompileCommand(program, userLog);
|
|
59
61
|
program = injectMigrateCommand(program, userLog);
|
|
60
62
|
|
|
61
63
|
await program.parseAsync(process.argv);
|
|
@@ -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,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
|
);
|
|
@@ -48,15 +50,17 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
48
50
|
signalHandlers.push(stop);
|
|
49
51
|
services.node = [node, AztecNodeApiSchema];
|
|
50
52
|
} else {
|
|
53
|
+
// Route --prover-node through startNode
|
|
54
|
+
if (options.proverNode && !options.node) {
|
|
55
|
+
options.node = true;
|
|
56
|
+
}
|
|
57
|
+
|
|
51
58
|
if (options.node) {
|
|
52
59
|
const { startNode } = await import('./cmds/start_node.js');
|
|
53
60
|
({ config } = await startNode(options, signalHandlers, services, adminServices, userLog));
|
|
54
61
|
} else if (options.bot) {
|
|
55
62
|
const { startBot } = await import('./cmds/start_bot.js');
|
|
56
63
|
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
64
|
} else if (options.archiver) {
|
|
61
65
|
const { startArchiver } = await import('./cmds/start_archiver.js');
|
|
62
66
|
({ config } = await startArchiver(options, signalHandlers, services));
|
|
@@ -99,14 +103,54 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
99
103
|
|
|
100
104
|
// If there are any admin services, start a separate JSON-RPC server for them
|
|
101
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
|
+
|
|
102
124
|
const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
|
|
103
125
|
http200OnError: false,
|
|
104
126
|
log: debugLogger,
|
|
105
|
-
middlewares:
|
|
127
|
+
middlewares: adminMiddlewares,
|
|
106
128
|
maxBatchSize: options.rpcMaxBatchSize,
|
|
107
129
|
maxBodySizeBytes: options.rpcMaxBodySize,
|
|
108
130
|
});
|
|
109
131
|
const { port } = await startHttpRpcServer(rpcServer, { port: options.adminPort });
|
|
110
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
|
+
}
|
|
111
155
|
}
|
|
112
156
|
}
|
|
@@ -142,6 +142,29 @@ 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',
|
|
@@ -170,7 +193,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
170
193
|
'WORLD STATE': [
|
|
171
194
|
configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
|
|
172
195
|
configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
|
|
173
|
-
configToFlag('--world-state-
|
|
196
|
+
configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory),
|
|
174
197
|
],
|
|
175
198
|
// We can't easily auto-generate node options as they're parts of modules defined below
|
|
176
199
|
'AZTEC NODE': [
|
|
@@ -222,12 +245,8 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
222
245
|
'proverNode',
|
|
223
246
|
omitConfigMappings(proverNodeConfigMappings, [
|
|
224
247
|
// filter out options passed separately
|
|
225
|
-
...getKeys(archiverConfigMappings),
|
|
226
248
|
...getKeys(proverBrokerConfigMappings),
|
|
227
249
|
...getKeys(proverAgentConfigMappings),
|
|
228
|
-
...getKeys(p2pConfigMappings),
|
|
229
|
-
...getKeys(worldStateConfigMappings),
|
|
230
|
-
...getKeys(sharedNodeConfigMappings),
|
|
231
250
|
]),
|
|
232
251
|
),
|
|
233
252
|
],
|
package/src/cli/cli.ts
CHANGED
|
@@ -39,7 +39,6 @@ Additional commands:
|
|
|
39
39
|
|
|
40
40
|
init [folder] [options] creates a new Aztec Noir project.
|
|
41
41
|
new <path> [options] creates a new Aztec Noir project in a new directory.
|
|
42
|
-
compile [options] compiles Aztec Noir contracts.
|
|
43
42
|
test [options] starts a TXE and runs "nargo test" using it as the oracle resolver.
|
|
44
43
|
`,
|
|
45
44
|
);
|
|
@@ -0,0 +1,107 @@
|
|
|
1
|
+
import type { LogFn } from '@aztec/foundation/log';
|
|
2
|
+
|
|
3
|
+
import { execFileSync, spawn } from 'child_process';
|
|
4
|
+
import type { Command } from 'commander';
|
|
5
|
+
import { readFile, readdir, writeFile } from 'fs/promises';
|
|
6
|
+
import { join } from 'path';
|
|
7
|
+
|
|
8
|
+
/** Spawns a command with inherited stdio and rejects on non-zero exit. */
|
|
9
|
+
function run(cmd: string, args: string[]): Promise<void> {
|
|
10
|
+
return new Promise((resolve, reject) => {
|
|
11
|
+
const child = spawn(cmd, args, { stdio: 'inherit' });
|
|
12
|
+
child.on('error', reject);
|
|
13
|
+
child.on('close', code => {
|
|
14
|
+
if (code !== 0) {
|
|
15
|
+
reject(new Error(`${cmd} exited with code ${code}`));
|
|
16
|
+
} else {
|
|
17
|
+
resolve();
|
|
18
|
+
}
|
|
19
|
+
});
|
|
20
|
+
});
|
|
21
|
+
}
|
|
22
|
+
|
|
23
|
+
/** Returns paths to contract artifacts in the target directory.
|
|
24
|
+
* Contract artifacts are identified by having a `functions` array in the JSON.
|
|
25
|
+
*/
|
|
26
|
+
async function collectContractArtifacts(): Promise<string[]> {
|
|
27
|
+
let files: string[];
|
|
28
|
+
try {
|
|
29
|
+
files = await readdir('target');
|
|
30
|
+
} catch (err: any) {
|
|
31
|
+
if (err?.code === 'ENOENT') {
|
|
32
|
+
return [];
|
|
33
|
+
}
|
|
34
|
+
throw new Error(`Failed to read target directory: ${err.message}`);
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
const artifacts: string[] = [];
|
|
38
|
+
for (const file of files) {
|
|
39
|
+
if (!file.endsWith('.json')) {
|
|
40
|
+
continue;
|
|
41
|
+
}
|
|
42
|
+
const filePath = join('target', file);
|
|
43
|
+
const content = JSON.parse(await readFile(filePath, 'utf-8'));
|
|
44
|
+
if (Array.isArray(content.functions)) {
|
|
45
|
+
artifacts.push(filePath);
|
|
46
|
+
}
|
|
47
|
+
}
|
|
48
|
+
return artifacts;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
/** Strips the `__aztec_nr_internals__` prefix from function names in contract artifacts. */
|
|
52
|
+
async function stripInternalPrefixes(artifactPaths: string[]): Promise<void> {
|
|
53
|
+
for (const path of artifactPaths) {
|
|
54
|
+
const artifact = JSON.parse(await readFile(path, 'utf-8'));
|
|
55
|
+
for (const fn of artifact.functions) {
|
|
56
|
+
if (typeof fn.name === 'string') {
|
|
57
|
+
fn.name = fn.name.replace(/^__aztec_nr_internals__/, '');
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
await writeFile(path, JSON.stringify(artifact, null, 2) + '\n');
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
|
|
64
|
+
/** Compiles Aztec Noir contracts and postprocesses artifacts. */
|
|
65
|
+
async function compileAztecContract(nargoArgs: string[], log: LogFn): Promise<void> {
|
|
66
|
+
const nargo = process.env.NARGO ?? 'nargo';
|
|
67
|
+
const bb = process.env.BB ?? 'bb';
|
|
68
|
+
|
|
69
|
+
await run(nargo, ['compile', ...nargoArgs]);
|
|
70
|
+
|
|
71
|
+
const artifacts = await collectContractArtifacts();
|
|
72
|
+
|
|
73
|
+
if (artifacts.length > 0) {
|
|
74
|
+
log('Postprocessing contracts...');
|
|
75
|
+
const bbArgs = artifacts.flatMap(a => ['-i', a]);
|
|
76
|
+
await run(bb, ['aztec_process', ...bbArgs]);
|
|
77
|
+
|
|
78
|
+
// TODO: This should be part of bb aztec_process!
|
|
79
|
+
await stripInternalPrefixes(artifacts);
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
log('Compilation complete!');
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export function injectCompileCommand(program: Command, log: LogFn): Command {
|
|
86
|
+
program
|
|
87
|
+
.command('compile')
|
|
88
|
+
.argument('[nargo-args...]')
|
|
89
|
+
.passThroughOptions()
|
|
90
|
+
.allowUnknownOption()
|
|
91
|
+
.description(
|
|
92
|
+
'Compile Aztec Noir contracts using nargo and postprocess them to generate transpiled artifacts and verification keys. All options are forwarded to nargo compile.',
|
|
93
|
+
)
|
|
94
|
+
.addHelpText('after', () => {
|
|
95
|
+
// Show nargo's own compile options so users see all available flags in one place.
|
|
96
|
+
const nargo = process.env.NARGO ?? 'nargo';
|
|
97
|
+
try {
|
|
98
|
+
const output = execFileSync(nargo, ['compile', '--help'], { encoding: 'utf-8' });
|
|
99
|
+
return `\nUnderlying nargo compile options:\n\n${output}`;
|
|
100
|
+
} catch {
|
|
101
|
+
return '\n(Run "nargo compile --help" to see available nargo options)';
|
|
102
|
+
}
|
|
103
|
+
})
|
|
104
|
+
.action((nargoArgs: string[]) => compileAztecContract(nargoArgs, log));
|
|
105
|
+
|
|
106
|
+
return program;
|
|
107
|
+
}
|
|
@@ -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
|
}
|
package/src/cli/util.ts
CHANGED
|
@@ -2,13 +2,13 @@ import type { AztecNodeConfig } from '@aztec/aztec-node';
|
|
|
2
2
|
import type { AccountManager } from '@aztec/aztec.js/wallet';
|
|
3
3
|
import type { ViemClient } from '@aztec/ethereum/types';
|
|
4
4
|
import type { ConfigMappingsType } from '@aztec/foundation/config';
|
|
5
|
-
import { Fr } from '@aztec/foundation/curves/bn254';
|
|
6
5
|
import { EthAddress } from '@aztec/foundation/eth-address';
|
|
6
|
+
import { jsonStringify } from '@aztec/foundation/json-rpc';
|
|
7
7
|
import { type LogFn, createLogger } from '@aztec/foundation/log';
|
|
8
8
|
import type { SharedNodeConfig } from '@aztec/node-lib/config';
|
|
9
9
|
import type { ProverConfig } from '@aztec/stdlib/interfaces/server';
|
|
10
10
|
import { getTelemetryClient } from '@aztec/telemetry-client/start';
|
|
11
|
-
import type {
|
|
11
|
+
import type { EmbeddedWallet } from '@aztec/wallets/embedded';
|
|
12
12
|
|
|
13
13
|
import chalk from 'chalk';
|
|
14
14
|
import type { Command } from 'commander';
|
|
@@ -68,30 +68,19 @@ export const installSignalHandlers = (logFn: LogFn, cb?: Array<() => Promise<voi
|
|
|
68
68
|
/**
|
|
69
69
|
* Creates logs for the initial accounts
|
|
70
70
|
* @param accounts - The initial accounts
|
|
71
|
-
* @param wallet - A
|
|
71
|
+
* @param wallet - A EmbeddedWallet instance to get the registered accounts
|
|
72
72
|
* @returns A string array containing the initial accounts details
|
|
73
73
|
*/
|
|
74
|
-
export async function createAccountLogs(
|
|
75
|
-
accountsWithSecretKeys: {
|
|
76
|
-
/**
|
|
77
|
-
* The account object
|
|
78
|
-
*/
|
|
79
|
-
account: AccountManager;
|
|
80
|
-
/**
|
|
81
|
-
* The secret key of the account
|
|
82
|
-
*/
|
|
83
|
-
secretKey: Fr;
|
|
84
|
-
}[],
|
|
85
|
-
wallet: TestWallet,
|
|
86
|
-
) {
|
|
74
|
+
export async function createAccountLogs(accountManagers: AccountManager[], wallet: EmbeddedWallet) {
|
|
87
75
|
const registeredAccounts = await wallet.getAccounts();
|
|
88
76
|
const accountLogStrings = [`Initial Accounts:\n\n`];
|
|
89
|
-
for (const
|
|
90
|
-
const
|
|
77
|
+
for (const accountManager of accountManagers) {
|
|
78
|
+
const account = await accountManager.getAccount();
|
|
79
|
+
const completeAddress = account.getCompleteAddress();
|
|
91
80
|
if (registeredAccounts.find(a => a.item.equals(completeAddress.address))) {
|
|
92
81
|
accountLogStrings.push(` Address: ${completeAddress.address.toString()}\n`);
|
|
93
82
|
accountLogStrings.push(` Partial Address: ${completeAddress.partialAddress.toString()}\n`);
|
|
94
|
-
accountLogStrings.push(` Secret Key: ${
|
|
83
|
+
accountLogStrings.push(` Secret Key: ${account.getSecretKey().toString()}\n`);
|
|
95
84
|
accountLogStrings.push(
|
|
96
85
|
` Master nullifier public key: ${completeAddress.publicKeys.masterNullifierPublicKey.toString()}\n`,
|
|
97
86
|
);
|
|
@@ -388,3 +377,9 @@ export async function setupUpdateMonitor(
|
|
|
388
377
|
|
|
389
378
|
checker.start();
|
|
390
379
|
}
|
|
380
|
+
|
|
381
|
+
export function stringifyConfig(config: object): string {
|
|
382
|
+
return Object.entries(config)
|
|
383
|
+
.map(([key, value]) => `${key}=${jsonStringify(value)}`)
|
|
384
|
+
.join(' ');
|
|
385
|
+
}
|
package/src/examples/token.ts
CHANGED
|
@@ -2,7 +2,7 @@ import { getInitialTestAccountsData } from '@aztec/accounts/testing';
|
|
|
2
2
|
import { createAztecNodeClient } from '@aztec/aztec.js/node';
|
|
3
3
|
import { createLogger } from '@aztec/foundation/log';
|
|
4
4
|
import { TokenContract } from '@aztec/noir-contracts.js/Token';
|
|
5
|
-
import {
|
|
5
|
+
import { EmbeddedWallet } from '@aztec/wallets/embedded';
|
|
6
6
|
|
|
7
7
|
const logger = createLogger('example:token');
|
|
8
8
|
|
|
@@ -19,7 +19,7 @@ const TRANSFER_AMOUNT = 33n;
|
|
|
19
19
|
async function main() {
|
|
20
20
|
logger.info('Running token contract test on HTTP interface.');
|
|
21
21
|
|
|
22
|
-
const wallet = await
|
|
22
|
+
const wallet = await EmbeddedWallet.create(node);
|
|
23
23
|
|
|
24
24
|
// During local network setup we deploy a few accounts. Below we add them to our wallet.
|
|
25
25
|
const [aliceInitialAccountData, bobInitialAccountData] = await getInitialTestAccountsData();
|