@aztec/aztec 0.0.1-fake-ceab37513c → 0.0.6-commit.a2d1860fe9
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/README.md +1 -1
- package/dest/bin/index.d.ts +1 -1
- package/dest/bin/index.js +14 -9
- 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 +59 -34
- 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 +46 -45
- package/dest/cli/cli.d.ts +1 -1
- package/dest/cli/cli.js +7 -7
- 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/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 +12 -14
- package/dest/cli/cmds/start_bot.d.ts +4 -7
- package/dest/cli/cmds/start_bot.d.ts.map +1 -1
- package/dest/cli/cmds/start_bot.js +18 -18
- 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 +71 -27
- 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 +4 -4
- package/dest/cli/cmds/start_txe.d.ts +1 -1
- package/dest/cli/index.d.ts +1 -1
- package/dest/cli/preload_crs.d.ts +1 -1
- package/dest/cli/release_version.d.ts +1 -1
- package/dest/cli/util.d.ts +12 -19
- package/dest/cli/util.d.ts.map +1 -1
- package/dest/cli/util.js +16 -11
- package/dest/cli/versioning.d.ts +1 -1
- package/dest/cli/versioning.js +3 -3
- package/dest/examples/token.d.ts +1 -1
- package/dest/examples/token.js +21 -19
- package/dest/examples/util.d.ts +3 -3
- package/dest/examples/util.d.ts.map +1 -1
- package/dest/examples/util.js +1 -1
- package/dest/index.d.ts +2 -2
- package/dest/index.d.ts.map +1 -1
- package/dest/index.js +1 -1
- package/dest/local-network/banana_fpc.d.ts +10 -0
- package/dest/local-network/banana_fpc.d.ts.map +1 -0
- package/dest/{sandbox → local-network}/banana_fpc.js +17 -21
- package/dest/local-network/index.d.ts +4 -0
- package/dest/local-network/index.d.ts.map +1 -0
- package/dest/local-network/index.js +3 -0
- package/dest/local-network/local-network.d.ts +73 -0
- package/dest/local-network/local-network.d.ts.map +1 -0
- package/dest/{sandbox/sandbox.js → local-network/local-network.js} +83 -66
- package/dest/local-network/sponsored_fpc.d.ts +5 -0
- package/dest/local-network/sponsored_fpc.d.ts.map +1 -0
- package/dest/{sandbox → local-network}/sponsored_fpc.js +7 -8
- package/dest/mnemonic.d.ts +1 -1
- package/dest/splash.d.ts +1 -1
- package/dest/testing/anvil_test_watcher.d.ts +12 -4
- package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
- package/dest/testing/anvil_test_watcher.js +69 -31
- package/dest/testing/cheat_codes.d.ts +7 -8
- package/dest/testing/cheat_codes.d.ts.map +1 -1
- package/dest/testing/cheat_codes.js +9 -10
- 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 -2
- package/dest/testing/index.d.ts.map +1 -1
- package/dest/testing/index.js +1 -1
- package/package.json +41 -37
- package/scripts/aztec.sh +62 -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 +15 -9
- package/src/cli/admin_api_key_store.ts +128 -0
- package/src/cli/aztec_start_action.ts +62 -26
- package/src/cli/aztec_start_options.ts +47 -43
- package/src/cli/cli.ts +11 -11
- package/src/cli/cmds/compile.ts +107 -0
- package/src/cli/cmds/migrate_ha_db.ts +43 -0
- package/src/cli/cmds/start_archiver.ts +8 -19
- package/src/cli/cmds/start_bot.ts +27 -15
- package/src/cli/cmds/start_node.ts +64 -23
- 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 +7 -3
- package/src/cli/util.ts +23 -26
- package/src/cli/versioning.ts +3 -3
- package/src/examples/token.ts +20 -19
- package/src/examples/util.ts +2 -2
- package/src/index.ts +5 -5
- package/src/{sandbox → local-network}/banana_fpc.ts +24 -25
- package/src/local-network/index.ts +7 -0
- package/src/local-network/local-network.ts +267 -0
- package/src/local-network/sponsored_fpc.ts +26 -0
- package/src/testing/anvil_test_watcher.ts +77 -34
- package/src/testing/cheat_codes.ts +13 -13
- package/src/testing/epoch_test_settler.ts +71 -0
- package/src/testing/index.ts +1 -1
- 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/cmds/start_pxe.d.ts +0 -16
- package/dest/cli/cmds/start_pxe.d.ts.map +0 -1
- package/dest/cli/cmds/start_pxe.js +0 -31
- package/dest/sandbox/banana_fpc.d.ts +0 -11
- package/dest/sandbox/banana_fpc.d.ts.map +0 -1
- package/dest/sandbox/index.d.ts +0 -4
- package/dest/sandbox/index.d.ts.map +0 -1
- package/dest/sandbox/index.js +0 -3
- package/dest/sandbox/sandbox.d.ts +0 -84
- package/dest/sandbox/sandbox.d.ts.map +0 -1
- package/dest/sandbox/sponsored_fpc.d.ts +0 -4
- package/dest/sandbox/sponsored_fpc.d.ts.map +0 -1
- package/dest/testing/aztec_cheat_codes.d.ts +0 -59
- package/dest/testing/aztec_cheat_codes.d.ts.map +0 -1
- package/dest/testing/aztec_cheat_codes.js +0 -62
- package/src/cli/cmds/start_blob_sink.ts +0 -57
- package/src/cli/cmds/start_prover_node.ts +0 -124
- package/src/cli/cmds/start_pxe.ts +0 -49
- package/src/sandbox/index.ts +0 -4
- package/src/sandbox/sandbox.ts +0 -253
- package/src/sandbox/sponsored_fpc.ts +0 -27
- package/src/testing/aztec_cheat_codes.ts +0 -77
|
@@ -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,16 +1,18 @@
|
|
|
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';
|
|
7
8
|
import type { ChainConfig } from '@aztec/stdlib/config';
|
|
8
|
-
import { AztecNodeApiSchema
|
|
9
|
+
import { AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
|
|
9
10
|
import { getVersioningMiddleware } from '@aztec/stdlib/versioning';
|
|
10
11
|
import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
|
|
11
12
|
|
|
12
|
-
import {
|
|
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';
|
|
@@ -22,21 +24,24 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
22
24
|
const adminServices: NamespacedApiHandlers = {};
|
|
23
25
|
let config: ChainConfig | undefined = undefined;
|
|
24
26
|
|
|
25
|
-
if (options.
|
|
27
|
+
if (options.localNetwork) {
|
|
26
28
|
const cliVersion = getCliVersion();
|
|
27
|
-
const
|
|
28
|
-
|
|
29
|
+
const localNetwork = extractNamespacedOptions(options, 'local-network');
|
|
30
|
+
localNetwork.testAccounts = true;
|
|
29
31
|
userLog(`${splash}\n${github}\n\n`);
|
|
30
|
-
userLog(`Setting up Aztec
|
|
32
|
+
userLog(`Setting up Aztec local network ${cliVersion}, please stand by...`);
|
|
31
33
|
|
|
32
|
-
const { node,
|
|
34
|
+
const { node, stop } = await createLocalNetwork(
|
|
33
35
|
{
|
|
34
|
-
l1Mnemonic:
|
|
36
|
+
l1Mnemonic: localNetwork.l1Mnemonic,
|
|
35
37
|
l1RpcUrls: options.l1RpcUrls,
|
|
36
|
-
|
|
37
|
-
noPXE: sandboxOptions.noPXE,
|
|
38
|
-
testAccounts: sandboxOptions.testAccounts,
|
|
38
|
+
testAccounts: localNetwork.testAccounts,
|
|
39
39
|
realProofs: false,
|
|
40
|
+
// Setting the epoch duration to 2 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: 2,
|
|
40
45
|
},
|
|
41
46
|
userLog,
|
|
42
47
|
);
|
|
@@ -44,27 +49,18 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
44
49
|
// Start Node and PXE JSON-RPC server
|
|
45
50
|
signalHandlers.push(stop);
|
|
46
51
|
services.node = [node, AztecNodeApiSchema];
|
|
47
|
-
if (!sandboxOptions.noPXE) {
|
|
48
|
-
services.pxe = [pxe, PXESchema];
|
|
49
|
-
} else {
|
|
50
|
-
userLog(`Not exposing PXE API through JSON-RPC server`);
|
|
51
|
-
}
|
|
52
52
|
} else {
|
|
53
|
+
// Route --prover-node through startNode
|
|
54
|
+
if (options.proverNode && !options.node) {
|
|
55
|
+
options.node = true;
|
|
56
|
+
}
|
|
57
|
+
|
|
53
58
|
if (options.node) {
|
|
54
59
|
const { startNode } = await import('./cmds/start_node.js');
|
|
55
60
|
({ config } = await startNode(options, signalHandlers, services, adminServices, userLog));
|
|
56
61
|
} else if (options.bot) {
|
|
57
62
|
const { startBot } = await import('./cmds/start_bot.js');
|
|
58
63
|
await startBot(options, signalHandlers, services, userLog);
|
|
59
|
-
} else if (options.proverNode) {
|
|
60
|
-
const { startProverNode } = await import('./cmds/start_prover_node.js');
|
|
61
|
-
({ config } = await startProverNode(options, signalHandlers, services, userLog));
|
|
62
|
-
} else if (options.blobSink) {
|
|
63
|
-
const { startBlobSink } = await import('./cmds/start_blob_sink.js');
|
|
64
|
-
await startBlobSink(options, signalHandlers, userLog);
|
|
65
|
-
} else if (options.pxe) {
|
|
66
|
-
const { startPXE } = await import('./cmds/start_pxe.js');
|
|
67
|
-
({ config } = await startPXE(options, signalHandlers, services, userLog));
|
|
68
64
|
} else if (options.archiver) {
|
|
69
65
|
const { startArchiver } = await import('./cmds/start_archiver.js');
|
|
70
66
|
({ config } = await startArchiver(options, signalHandlers, services));
|
|
@@ -107,14 +103,54 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
107
103
|
|
|
108
104
|
// If there are any admin services, start a separate JSON-RPC server for them
|
|
109
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
|
+
|
|
110
124
|
const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
|
|
111
125
|
http200OnError: false,
|
|
112
126
|
log: debugLogger,
|
|
113
|
-
middlewares:
|
|
127
|
+
middlewares: adminMiddlewares,
|
|
114
128
|
maxBatchSize: options.rpcMaxBatchSize,
|
|
115
129
|
maxBodySizeBytes: options.rpcMaxBodySize,
|
|
116
130
|
});
|
|
117
131
|
const { port } = await startHttpRpcServer(rpcServer, { port: options.adminPort });
|
|
118
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
|
+
}
|
|
119
155
|
}
|
|
120
156
|
}
|
|
@@ -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,
|
|
@@ -14,12 +15,13 @@ import {
|
|
|
14
15
|
import { dataConfigMappings } from '@aztec/kv-store/config';
|
|
15
16
|
import { sharedNodeConfigMappings } from '@aztec/node-lib/config';
|
|
16
17
|
import { bootnodeConfigMappings, p2pConfigMappings } from '@aztec/p2p/config';
|
|
17
|
-
import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker';
|
|
18
|
+
import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker/config';
|
|
18
19
|
import { proverNodeConfigMappings } from '@aztec/prover-node/config';
|
|
19
20
|
import { allPxeConfigMappings } from '@aztec/pxe/config';
|
|
20
|
-
import {
|
|
21
|
-
import {
|
|
22
|
-
import {
|
|
21
|
+
import { sequencerClientConfigMappings } from '@aztec/sequencer-client/config';
|
|
22
|
+
import { chainConfigMappings, nodeRpcConfigMappings } from '@aztec/stdlib/config';
|
|
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
|
|
|
@@ -82,6 +84,7 @@ export const universalOptions = [
|
|
|
82
84
|
'l1ConsensusHostApiKeys',
|
|
83
85
|
'l1ConsensusHostApiKeyHeaders',
|
|
84
86
|
'p2pEnabled',
|
|
87
|
+
'fishermanMode',
|
|
85
88
|
...getKeys(chainConfigMappings),
|
|
86
89
|
...getKeys(l1ContractsConfigMappings),
|
|
87
90
|
...getKeys(l1ContractAddressesMapping),
|
|
@@ -107,34 +110,22 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
107
110
|
|
|
108
111
|
configToFlag('--sync-mode', sharedNodeConfigMappings.syncMode),
|
|
109
112
|
configToFlag('--snapshots-urls', sharedNodeConfigMappings.snapshotsUrls),
|
|
113
|
+
|
|
114
|
+
configToFlag('--fisherman-mode', sharedNodeConfigMappings.fishermanMode),
|
|
110
115
|
],
|
|
111
|
-
|
|
116
|
+
LOCAL_NETWORK: [
|
|
112
117
|
{
|
|
113
|
-
flag: '--
|
|
114
|
-
description: 'Starts Aztec
|
|
118
|
+
flag: '--local-network',
|
|
119
|
+
description: 'Starts Aztec Local Network',
|
|
115
120
|
defaultValue: undefined,
|
|
116
121
|
env: undefined,
|
|
117
122
|
},
|
|
118
123
|
{
|
|
119
|
-
flag: '--
|
|
120
|
-
description: 'Do not expose PXE service on sandbox start',
|
|
121
|
-
env: 'NO_PXE',
|
|
122
|
-
...booleanConfigHelper(),
|
|
123
|
-
},
|
|
124
|
-
{
|
|
125
|
-
flag: '--sandbox.l1Mnemonic <value>',
|
|
124
|
+
flag: '--local-network.l1Mnemonic <value>',
|
|
126
125
|
description: 'Mnemonic for L1 accounts. Will be used ',
|
|
127
126
|
defaultValue: DefaultMnemonic,
|
|
128
127
|
env: 'MNEMONIC',
|
|
129
128
|
},
|
|
130
|
-
{
|
|
131
|
-
flag: '--sandbox.deployAztecContractsSalt <value>',
|
|
132
|
-
description:
|
|
133
|
-
'Numeric salt for deploying L1 Aztec contracts before starting the sandbox. Needs mnemonic or private key to be set.',
|
|
134
|
-
env: 'DEPLOY_AZTEC_CONTRACTS_SALT',
|
|
135
|
-
defaultValue: undefined,
|
|
136
|
-
parseVal: (val: string) => (val ? parseInt(val) : undefined),
|
|
137
|
-
},
|
|
138
129
|
],
|
|
139
130
|
API: [
|
|
140
131
|
{
|
|
@@ -146,25 +137,50 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
146
137
|
},
|
|
147
138
|
{
|
|
148
139
|
flag: '--admin-port <value>',
|
|
149
|
-
description: 'Port to run admin APIs of Aztec Services on
|
|
140
|
+
description: 'Port to run admin APIs of Aztec Services on',
|
|
150
141
|
defaultValue: 8880,
|
|
151
142
|
env: 'AZTEC_ADMIN_PORT',
|
|
152
143
|
parseVal: val => parseInt(val, 10),
|
|
153
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
|
+
},
|
|
154
168
|
{
|
|
155
169
|
flag: '--api-prefix <value>',
|
|
156
170
|
description: 'Prefix for API routes on any service that is started',
|
|
157
171
|
defaultValue: '',
|
|
158
172
|
env: 'API_PREFIX',
|
|
159
173
|
},
|
|
174
|
+
configToFlag('--rpcMaxBatchSize', nodeRpcConfigMappings.rpcMaxBatchSize),
|
|
175
|
+
configToFlag('--rpcMaxBodySize', nodeRpcConfigMappings.rpcMaxBodySize),
|
|
160
176
|
],
|
|
161
177
|
ETHEREUM: [
|
|
162
178
|
configToFlag('--l1-chain-id', l1ReaderConfigMappings.l1ChainId),
|
|
163
179
|
// Do not set default for CLI: keep undefined unless provided via flag or env
|
|
164
180
|
configToFlag('--l1-rpc-urls', { ...l1ReaderConfigMappings.l1RpcUrls, defaultValue: undefined }),
|
|
165
|
-
configToFlag('--l1-consensus-host-urls',
|
|
166
|
-
configToFlag('--l1-consensus-host-api-keys',
|
|
167
|
-
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),
|
|
168
184
|
],
|
|
169
185
|
'L1 CONTRACTS': [
|
|
170
186
|
configToFlag('--registry-address', l1ContractAddressesMapping.registryAddress),
|
|
@@ -177,7 +193,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
177
193
|
'WORLD STATE': [
|
|
178
194
|
configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
|
|
179
195
|
configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
|
|
180
|
-
configToFlag('--world-state-
|
|
196
|
+
configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory),
|
|
181
197
|
],
|
|
182
198
|
// We can't easily auto-generate node options as they're parts of modules defined below
|
|
183
199
|
'AZTEC NODE': [
|
|
@@ -211,21 +227,13 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
211
227
|
'sequencer',
|
|
212
228
|
omitConfigMappings(sequencerClientConfigMappings, [
|
|
213
229
|
'fakeProcessingDelayPerTxMs',
|
|
230
|
+
'fakeThrowAfterProcessingTxCount',
|
|
214
231
|
'skipCollectingAttestations',
|
|
215
232
|
'skipInvalidateBlockAsProposer',
|
|
216
233
|
'blobSinkMapSizeKb',
|
|
217
234
|
]),
|
|
218
235
|
),
|
|
219
236
|
],
|
|
220
|
-
'BLOB SINK': [
|
|
221
|
-
{
|
|
222
|
-
flag: '--blob-sink',
|
|
223
|
-
description: 'Starts Aztec Blob Sink with options',
|
|
224
|
-
defaultValue: undefined,
|
|
225
|
-
env: undefined,
|
|
226
|
-
},
|
|
227
|
-
...getOptions('blobSink', blobSinkConfigMappings),
|
|
228
|
-
],
|
|
229
237
|
'PROVER NODE': [
|
|
230
238
|
{
|
|
231
239
|
flag: '--prover-node',
|
|
@@ -237,12 +245,8 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
237
245
|
'proverNode',
|
|
238
246
|
omitConfigMappings(proverNodeConfigMappings, [
|
|
239
247
|
// filter out options passed separately
|
|
240
|
-
...getKeys(archiverConfigMappings),
|
|
241
248
|
...getKeys(proverBrokerConfigMappings),
|
|
242
249
|
...getKeys(proverAgentConfigMappings),
|
|
243
|
-
...getKeys(p2pConfigMappings),
|
|
244
|
-
...getKeys(worldStateConfigMappings),
|
|
245
|
-
...getKeys(sharedNodeConfigMappings),
|
|
246
250
|
]),
|
|
247
251
|
),
|
|
248
252
|
],
|
package/src/cli/cli.ts
CHANGED
|
@@ -31,18 +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
|
-
$ aztec-nargo test --silence-warnings --oracle-resolver=<TXE_ADDRESS> [options]
|
|
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
|
+
test [options] starts a TXE and runs "nargo test" using it as the oracle resolver.
|
|
44
43
|
`,
|
|
45
|
-
|
|
44
|
+
);
|
|
45
|
+
}
|
|
46
46
|
|
|
47
47
|
program
|
|
48
48
|
.command('preload-crs')
|
|
@@ -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
|
+
}
|
|
@@ -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
|
+
}
|