@aztec/aztec 0.0.0-test.0 → 0.0.1-commit.001888fc
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 +28 -13
- 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 +89 -44
- package/dest/cli/aztec_start_options.d.ts +5 -3
- package/dest/cli/aztec_start_options.d.ts.map +1 -1
- package/dest/cli/aztec_start_options.js +157 -220
- package/dest/cli/cli.d.ts +1 -1
- package/dest/cli/cli.d.ts.map +1 -1
- package/dest/cli/cli.js +11 -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 +166 -0
- package/dest/cli/cmds/migrate_ha_db.d.ts +3 -0
- package/dest/cli/cmds/migrate_ha_db.d.ts.map +1 -0
- package/dest/cli/cmds/migrate_ha_db.js +27 -0
- package/dest/cli/cmds/profile.d.ts +4 -0
- package/dest/cli/cmds/profile.d.ts.map +1 -0
- package/dest/cli/cmds/profile.js +8 -0
- package/dest/cli/cmds/profile_flamegraph.d.ts +4 -0
- package/dest/cli/cmds/profile_flamegraph.d.ts.map +1 -0
- package/dest/cli/cmds/profile_flamegraph.js +52 -0
- package/dest/cli/cmds/profile_gates.d.ts +4 -0
- package/dest/cli/cmds/profile_gates.d.ts.map +1 -0
- package/dest/cli/cmds/profile_gates.js +58 -0
- package/dest/cli/cmds/profile_utils.d.ts +18 -0
- package/dest/cli/cmds/profile_utils.d.ts.map +1 -0
- package/dest/cli/cmds/profile_utils.js +50 -0
- package/dest/cli/cmds/standby.d.ts +32 -0
- package/dest/cli/cmds/standby.d.ts.map +1 -0
- package/dest/cli/cmds/standby.js +97 -0
- package/dest/cli/cmds/start_archiver.d.ts +2 -2
- package/dest/cli/cmds/start_archiver.d.ts.map +1 -1
- package/dest/cli/cmds/start_archiver.js +25 -19
- 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 +29 -14
- package/dest/cli/cmds/start_node.d.ts +3 -2
- package/dest/cli/cmds/start_node.d.ts.map +1 -1
- package/dest/cli/cmds/start_node.js +128 -85
- 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 +10 -6
- 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 +35 -6
- 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 +17 -5
- package/dest/cli/cmds/start_txe.d.ts +1 -1
- package/dest/cli/cmds/utils/artifacts.d.ts +21 -0
- package/dest/cli/cmds/utils/artifacts.d.ts.map +1 -0
- package/dest/cli/cmds/utils/artifacts.js +24 -0
- package/dest/cli/cmds/utils/needs_recompile.d.ts +10 -0
- package/dest/cli/cmds/utils/needs_recompile.d.ts.map +1 -0
- package/dest/cli/cmds/utils/needs_recompile.js +134 -0
- package/dest/cli/cmds/utils/spawn.d.ts +3 -0
- package/dest/cli/cmds/utils/spawn.d.ts.map +1 -0
- package/dest/cli/cmds/utils/spawn.js +16 -0
- package/dest/cli/index.d.ts +1 -1
- package/dest/cli/preload_crs.d.ts +3 -0
- package/dest/cli/preload_crs.d.ts.map +1 -0
- package/dest/cli/preload_crs.js +6 -0
- package/dest/cli/util.d.ts +37 -17
- package/dest/cli/util.d.ts.map +1 -1
- package/dest/cli/util.js +165 -31
- 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 +31 -18
- package/dest/examples/util.d.ts +5 -6
- package/dest/examples/util.d.ts.map +1 -1
- package/dest/examples/util.js +5 -6
- 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 +23 -25
- 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/local-network/local-network.js +226 -0
- package/dest/local-network/sponsored_fpc.d.ts +5 -0
- package/dest/local-network/sponsored_fpc.d.ts.map +1 -0
- package/dest/local-network/sponsored_fpc.js +18 -0
- package/dest/mnemonic.d.ts +1 -1
- package/dest/splash.d.ts +1 -1
- package/dest/testing/anvil_test_watcher.d.ts +42 -0
- package/dest/testing/anvil_test_watcher.d.ts.map +1 -0
- package/dest/testing/anvil_test_watcher.js +181 -0
- package/dest/testing/cheat_codes.d.ts +43 -0
- package/dest/testing/cheat_codes.d.ts.map +1 -0
- package/dest/testing/cheat_codes.js +62 -0
- package/dest/testing/epoch_test_settler.d.ts +19 -0
- package/dest/testing/epoch_test_settler.d.ts.map +1 -0
- package/dest/testing/epoch_test_settler.js +61 -0
- package/dest/testing/index.d.ts +6 -0
- package/dest/testing/index.d.ts.map +1 -0
- package/dest/testing/index.js +5 -0
- package/dest/testing/token_allowed_setup.d.ts +7 -0
- package/dest/testing/token_allowed_setup.d.ts.map +1 -0
- package/dest/testing/token_allowed_setup.js +20 -0
- package/package.json +55 -45
- package/scripts/add_crate.sh +102 -0
- package/scripts/aztec.sh +69 -0
- package/scripts/init.sh +39 -0
- package/scripts/new.sh +83 -0
- package/scripts/setup_workspace.sh +68 -0
- package/src/bin/index.ts +33 -13
- package/src/cli/admin_api_key_store.ts +128 -0
- package/src/cli/aztec_start_action.ts +87 -41
- package/src/cli/aztec_start_options.ts +176 -218
- package/src/cli/cli.ts +19 -11
- package/src/cli/cmds/compile.ts +191 -0
- package/src/cli/cmds/migrate_ha_db.ts +43 -0
- package/src/cli/cmds/profile.ts +25 -0
- package/src/cli/cmds/profile_flamegraph.ts +64 -0
- package/src/cli/cmds/profile_gates.ts +68 -0
- package/src/cli/cmds/profile_utils.ts +58 -0
- package/src/cli/cmds/standby.ts +132 -0
- package/src/cli/cmds/start_archiver.ts +16 -21
- package/src/cli/cmds/start_bot.ts +40 -14
- package/src/cli/cmds/start_node.ts +146 -91
- package/src/cli/cmds/start_p2p_bootstrap.ts +14 -6
- package/src/cli/cmds/start_prover_agent.ts +26 -14
- package/src/cli/cmds/start_prover_broker.ts +28 -4
- package/src/cli/cmds/utils/artifacts.ts +44 -0
- package/src/cli/cmds/utils/needs_recompile.ts +151 -0
- package/src/cli/cmds/utils/spawn.ts +16 -0
- package/src/cli/preload_crs.ts +7 -0
- package/src/cli/util.ts +186 -50
- package/src/cli/versioning.ts +3 -3
- package/src/examples/token.ts +23 -19
- package/src/examples/util.ts +6 -8
- package/src/index.ts +5 -6
- package/src/{sandbox → local-network}/banana_fpc.ts +28 -29
- package/src/local-network/index.ts +7 -0
- package/src/local-network/local-network.ts +277 -0
- package/src/local-network/sponsored_fpc.ts +26 -0
- package/src/testing/anvil_test_watcher.ts +210 -0
- package/src/testing/cheat_codes.ts +79 -0
- package/src/testing/epoch_test_settler.ts +70 -0
- package/src/testing/index.ts +5 -0
- package/src/testing/token_allowed_setup.ts +19 -0
- package/dest/cli/chain_l2_config.d.ts +0 -19
- package/dest/cli/chain_l2_config.d.ts.map +0 -1
- package/dest/cli/chain_l2_config.js +0 -56
- 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 -17
- package/dest/cli/cmds/start_faucet.d.ts +0 -4
- package/dest/cli/cmds/start_faucet.d.ts.map +0 -1
- package/dest/cli/cmds/start_faucet.js +0 -20
- 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 -110
- 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 -95
- package/dest/cli/get_l1_config.d.ts +0 -7
- package/dest/cli/get_l1_config.d.ts.map +0 -1
- package/dest/cli/get_l1_config.js +0 -13
- 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 -5
- package/dest/sandbox/index.d.ts.map +0 -1
- package/dest/sandbox/index.js +0 -4
- package/dest/sandbox/sandbox.d.ts +0 -76
- package/dest/sandbox/sandbox.d.ts.map +0 -1
- package/dest/sandbox/sandbox.js +0 -181
- package/dest/sandbox/sponsored_fee_payment_method.d.ts +0 -23
- package/dest/sandbox/sponsored_fee_payment_method.d.ts.map +0 -1
- package/dest/sandbox/sponsored_fee_payment_method.js +0 -36
- package/dest/sandbox/sponsored_fpc.d.ts +0 -6
- package/dest/sandbox/sponsored_fpc.d.ts.map +0 -1
- package/dest/sandbox/sponsored_fpc.js +0 -26
- package/src/cli/chain_l2_config.ts +0 -74
- package/src/cli/cmds/start_blob_sink.ts +0 -31
- package/src/cli/cmds/start_faucet.ts +0 -34
- package/src/cli/cmds/start_prover_node.ts +0 -121
- package/src/cli/cmds/start_pxe.ts +0 -129
- package/src/cli/get_l1_config.ts +0 -18
- package/src/sandbox/index.ts +0 -5
- package/src/sandbox/sandbox.ts +0 -229
- package/src/sandbox/sponsored_fee_payment_method.ts +0 -46
- package/src/sandbox/sponsored_fpc.ts +0 -38
package/README.md
CHANGED
|
@@ -8,7 +8,7 @@ Aztec is a package that allows for a simple development environment on Aztec sta
|
|
|
8
8
|
|
|
9
9
|
The easiest way to run is by using `docker compose up`. This will create two containers:
|
|
10
10
|
|
|
11
|
-
1. The
|
|
11
|
+
1. The local network listening on port `8080`
|
|
12
12
|
2. An anvil instance listening on port `8545`
|
|
13
13
|
|
|
14
14
|
### Node Server
|
package/dest/bin/index.d.ts
CHANGED
package/dest/bin/index.js
CHANGED
|
@@ -1,19 +1,23 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
//
|
|
3
3
|
import { injectCommands as injectBuilderCommands } from '@aztec/builder';
|
|
4
|
-
import { injectCommands as
|
|
4
|
+
import { injectCommands as injectAztecNodeCommands } from '@aztec/cli/aztec_node';
|
|
5
|
+
import { enrichEnvironmentWithChainName } from '@aztec/cli/config/chain';
|
|
6
|
+
import { enrichEnvironmentWithNetworkConfig } from '@aztec/cli/config/network';
|
|
5
7
|
import { injectCommands as injectContractCommands } from '@aztec/cli/contracts';
|
|
6
|
-
import { injectCommands as injectDevnetCommands } from '@aztec/cli/devnet';
|
|
7
8
|
import { injectCommands as injectInfrastructureCommands } from '@aztec/cli/infrastructure';
|
|
8
9
|
import { injectCommands as injectL1Commands } from '@aztec/cli/l1';
|
|
9
10
|
import { injectCommands as injectMiscCommands } from '@aztec/cli/misc';
|
|
10
|
-
import { injectCommands as
|
|
11
|
+
import { injectCommands as injectValidatorKeysCommands } from '@aztec/cli/validator_keys';
|
|
12
|
+
import { getActiveNetworkName } from '@aztec/foundation/config';
|
|
11
13
|
import { createConsoleLogger, createLogger } from '@aztec/foundation/log';
|
|
12
|
-
import {
|
|
14
|
+
import { getPackageVersion } from '@aztec/stdlib/update-checker';
|
|
13
15
|
import { Command } from 'commander';
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
16
|
+
import { injectCompileCommand } from '../cli/cmds/compile.js';
|
|
17
|
+
import { injectMigrateCommand } from '../cli/cmds/migrate_ha_db.js';
|
|
18
|
+
import { injectProfileCommand } from '../cli/cmds/profile.js';
|
|
16
19
|
import { injectAztecCommands } from '../cli/index.js';
|
|
20
|
+
const NETWORK_FLAG = 'network';
|
|
17
21
|
const userLog = createConsoleLogger();
|
|
18
22
|
const debugLogger = createLogger('cli');
|
|
19
23
|
/** CLI & full node main entrypoint */ async function main() {
|
|
@@ -22,19 +26,30 @@ const debugLogger = createLogger('cli');
|
|
|
22
26
|
};
|
|
23
27
|
process.once('SIGINT', shutdown);
|
|
24
28
|
process.once('SIGTERM', shutdown);
|
|
25
|
-
|
|
26
|
-
|
|
29
|
+
// Intercept the setting of a network and enrich the environment with defaults for that network
|
|
30
|
+
let networkValue;
|
|
31
|
+
const args = process.argv.slice(2);
|
|
32
|
+
const networkIndex = args.findIndex((arg)=>arg.startsWith(`--${NETWORK_FLAG}=`) || arg === `--${NETWORK_FLAG}`);
|
|
33
|
+
if (networkIndex !== -1) {
|
|
34
|
+
networkValue = args[networkIndex].split('=')[1] || args[networkIndex + 1];
|
|
35
|
+
}
|
|
36
|
+
const networkName = getActiveNetworkName(networkValue);
|
|
37
|
+
await enrichEnvironmentWithNetworkConfig(networkName);
|
|
38
|
+
enrichEnvironmentWithChainName(networkName);
|
|
39
|
+
const cliVersion = getPackageVersion() ?? 'unknown';
|
|
27
40
|
let program = new Command('aztec');
|
|
28
|
-
program.description('Aztec command line interface').version(cliVersion);
|
|
41
|
+
program.description('Aztec command line interface').version(cliVersion).enablePositionalOptions();
|
|
29
42
|
program = injectAztecCommands(program, userLog, debugLogger);
|
|
30
43
|
program = injectBuilderCommands(program);
|
|
31
44
|
program = injectContractCommands(program, userLog, debugLogger);
|
|
32
|
-
program = injectInfrastructureCommands(program, userLog
|
|
45
|
+
program = injectInfrastructureCommands(program, userLog);
|
|
33
46
|
program = injectL1Commands(program, userLog, debugLogger);
|
|
34
|
-
program =
|
|
47
|
+
program = injectAztecNodeCommands(program, userLog, debugLogger);
|
|
35
48
|
program = injectMiscCommands(program, userLog);
|
|
36
|
-
program =
|
|
37
|
-
program =
|
|
49
|
+
program = injectValidatorKeysCommands(program, userLog);
|
|
50
|
+
program = injectCompileCommand(program, userLog);
|
|
51
|
+
program = injectProfileCommand(program, userLog);
|
|
52
|
+
program = injectMigrateCommand(program, userLog);
|
|
38
53
|
await program.parseAsync(process.argv);
|
|
39
54
|
}
|
|
40
55
|
main().catch((err)=>{
|
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
import type { Logger } from '@aztec/foundation/log';
|
|
2
|
+
/**
|
|
3
|
+
* Result of resolving the admin API key.
|
|
4
|
+
* Contains the SHA-256 hex hash of the API key to be used by the auth middleware,
|
|
5
|
+
* and optionally the raw key when newly generated (so the caller can display it).
|
|
6
|
+
*/
|
|
7
|
+
export interface AdminApiKeyResolution {
|
|
8
|
+
/** The SHA-256 hash of the API key. */
|
|
9
|
+
apiKeyHash: Buffer;
|
|
10
|
+
/**
|
|
11
|
+
* The raw API key, only present when a new key was generated during this call.
|
|
12
|
+
* The caller MUST display this to the operator — it will not be stored or returned again.
|
|
13
|
+
*/
|
|
14
|
+
rawKey?: string;
|
|
15
|
+
}
|
|
16
|
+
export interface ResolveAdminApiKeyOptions {
|
|
17
|
+
/** SHA-256 hex hash of a pre-generated API key. When set, the node uses this hash directly. */
|
|
18
|
+
adminApiKeyHash?: string;
|
|
19
|
+
/** If true, disable admin API key auth entirely. */
|
|
20
|
+
disableAdminApiKey?: boolean;
|
|
21
|
+
/** If true, force-generate a new key even if one is already persisted. */
|
|
22
|
+
resetAdminApiKey?: boolean;
|
|
23
|
+
/** Root data directory for persistent storage. */
|
|
24
|
+
dataDirectory?: string;
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Resolves the admin API key for the admin RPC endpoint.
|
|
28
|
+
*
|
|
29
|
+
* Strategy:
|
|
30
|
+
* 1. If opt-out flag is set (`disableAdminApiKey`), return undefined (no auth).
|
|
31
|
+
* 2. If a pre-generated hash is provided (`adminApiKeyHash`), use it directly.
|
|
32
|
+
* 3. If a data directory exists, look for a persisted hash file
|
|
33
|
+
* at `<dataDirectory>/admin/api_key_hash`:
|
|
34
|
+
* - If `resetAdminApiKey` is set, skip loading and force-generate a new key.
|
|
35
|
+
* - Found: use the stored hash (operator already saved the key from first run).
|
|
36
|
+
* - Not found: auto-generate a random key, display it once, persist the hash.
|
|
37
|
+
* 3. If no data directory: generate a random key
|
|
38
|
+
* each run and display it (cannot persist).
|
|
39
|
+
*
|
|
40
|
+
* @param options - The options for resolving the admin API key.
|
|
41
|
+
* @param log - Logger for outputting the key and status messages.
|
|
42
|
+
* @returns The resolved API key hash, or undefined if auth is disabled.
|
|
43
|
+
*/
|
|
44
|
+
export declare function resolveAdminApiKey(options: ResolveAdminApiKeyOptions, log: Logger): Promise<AdminApiKeyResolution | undefined>;
|
|
45
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYWRtaW5fYXBpX2tleV9zdG9yZS5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NsaS9hZG1pbl9hcGlfa2V5X3N0b3JlLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQUVBLE9BQU8sS0FBSyxFQUFFLE1BQU0sRUFBRSxNQUFNLHVCQUF1QixDQUFDO0FBU3BEOzs7O0dBSUc7QUFDSCxNQUFNLFdBQVcscUJBQXFCO0lBQ3BDLHVDQUF1QztJQUN2QyxVQUFVLEVBQUUsTUFBTSxDQUFDO0lBQ25COzs7T0FHRztJQUNILE1BQU0sQ0FBQyxFQUFFLE1BQU0sQ0FBQztDQUNqQjtBQUVELE1BQU0sV0FBVyx5QkFBeUI7SUFDeEMsK0ZBQStGO0lBQy9GLGVBQWUsQ0FBQyxFQUFFLE1BQU0sQ0FBQztJQUN6QixvREFBb0Q7SUFDcEQsa0JBQWtCLENBQUMsRUFBRSxPQUFPLENBQUM7SUFDN0IsMEVBQTBFO0lBQzFFLGdCQUFnQixDQUFDLEVBQUUsT0FBTyxDQUFDO0lBQzNCLGtEQUFrRDtJQUNsRCxhQUFhLENBQUMsRUFBRSxNQUFNLENBQUM7Q0FDeEI7QUFFRDs7Ozs7Ozs7Ozs7Ozs7Ozs7R0FpQkc7QUFDSCx3QkFBc0Isa0JBQWtCLENBQ3RDLE9BQU8sRUFBRSx5QkFBeUIsRUFDbEMsR0FBRyxFQUFFLE1BQU0sR0FDVixPQUFPLENBQUMscUJBQXFCLEdBQUcsU0FBUyxDQUFDLENBMkQ1QyJ9
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"admin_api_key_store.d.ts","sourceRoot":"","sources":["../../src/cli/admin_api_key_store.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AASpD;;;;GAIG;AACH,MAAM,WAAW,qBAAqB;IACpC,uCAAuC;IACvC,UAAU,EAAE,MAAM,CAAC;IACnB;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC,+FAA+F;IAC/F,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,oDAAoD;IACpD,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAC7B,0EAA0E;IAC1E,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,kDAAkD;IAClD,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,kBAAkB,CACtC,OAAO,EAAE,yBAAyB,EAClC,GAAG,EAAE,MAAM,GACV,OAAO,CAAC,qBAAqB,GAAG,SAAS,CAAC,CA2D5C"}
|
|
@@ -0,0 +1,98 @@
|
|
|
1
|
+
import { randomBytes } from '@aztec/foundation/crypto/random';
|
|
2
|
+
import { sha256Hash } from '@aztec/foundation/json-rpc/server';
|
|
3
|
+
import { promises as fs } from 'fs';
|
|
4
|
+
import { join } from 'path';
|
|
5
|
+
/** Subdirectory under dataDirectory for admin API key storage. */ const ADMIN_STORE_DIR = 'admin';
|
|
6
|
+
const HASH_FILE_NAME = 'api_key_hash';
|
|
7
|
+
/**
|
|
8
|
+
* Resolves the admin API key for the admin RPC endpoint.
|
|
9
|
+
*
|
|
10
|
+
* Strategy:
|
|
11
|
+
* 1. If opt-out flag is set (`disableAdminApiKey`), return undefined (no auth).
|
|
12
|
+
* 2. If a pre-generated hash is provided (`adminApiKeyHash`), use it directly.
|
|
13
|
+
* 3. If a data directory exists, look for a persisted hash file
|
|
14
|
+
* at `<dataDirectory>/admin/api_key_hash`:
|
|
15
|
+
* - If `resetAdminApiKey` is set, skip loading and force-generate a new key.
|
|
16
|
+
* - Found: use the stored hash (operator already saved the key from first run).
|
|
17
|
+
* - Not found: auto-generate a random key, display it once, persist the hash.
|
|
18
|
+
* 3. If no data directory: generate a random key
|
|
19
|
+
* each run and display it (cannot persist).
|
|
20
|
+
*
|
|
21
|
+
* @param options - The options for resolving the admin API key.
|
|
22
|
+
* @param log - Logger for outputting the key and status messages.
|
|
23
|
+
* @returns The resolved API key hash, or undefined if auth is disabled.
|
|
24
|
+
*/ export async function resolveAdminApiKey(options, log) {
|
|
25
|
+
// Operator explicitly opted out of admin auth
|
|
26
|
+
if (options.disableAdminApiKey) {
|
|
27
|
+
log.warn('Admin API key authentication is DISABLED (--disable-admin-api-key / AZTEC_DISABLE_ADMIN_API_KEY)');
|
|
28
|
+
return undefined;
|
|
29
|
+
}
|
|
30
|
+
// Operator provided a pre-generated hash (e.g. via AZTEC_ADMIN_API_KEY_HASH env var)
|
|
31
|
+
if (options.adminApiKeyHash) {
|
|
32
|
+
const hex = options.adminApiKeyHash.trim();
|
|
33
|
+
if (hex.length !== 64 || !/^[0-9a-f]{64}$/.test(hex)) {
|
|
34
|
+
throw new Error(`Invalid admin API key hash: expected 64-char hex string, got "${hex}"`);
|
|
35
|
+
}
|
|
36
|
+
log.info('Admin API key authentication enabled (using pre-configured key hash)');
|
|
37
|
+
return {
|
|
38
|
+
apiKeyHash: Buffer.from(hex, 'hex')
|
|
39
|
+
};
|
|
40
|
+
}
|
|
41
|
+
// Persistent storage available, load or generate key
|
|
42
|
+
if (options.dataDirectory) {
|
|
43
|
+
const adminDir = join(options.dataDirectory, ADMIN_STORE_DIR);
|
|
44
|
+
const hashFilePath = join(adminDir, HASH_FILE_NAME);
|
|
45
|
+
// Unless a reset is forced, try to load the existing hash from disk
|
|
46
|
+
if (!options.resetAdminApiKey) {
|
|
47
|
+
try {
|
|
48
|
+
const storedHash = (await fs.readFile(hashFilePath, 'utf-8')).trim();
|
|
49
|
+
if (storedHash.length === 64) {
|
|
50
|
+
log.info('Admin API key authentication enabled (loaded stored key hash from disk)');
|
|
51
|
+
return {
|
|
52
|
+
apiKeyHash: Buffer.from(storedHash, 'hex')
|
|
53
|
+
};
|
|
54
|
+
}
|
|
55
|
+
log.warn(`Invalid stored admin API key hash at ${hashFilePath}, regenerating...`);
|
|
56
|
+
} catch (err) {
|
|
57
|
+
if (err.code !== 'ENOENT') {
|
|
58
|
+
log.warn(`Failed to read admin API key hash from ${hashFilePath}: ${err.message}`);
|
|
59
|
+
}
|
|
60
|
+
// File doesn't exist — fall through to generate
|
|
61
|
+
}
|
|
62
|
+
} else {
|
|
63
|
+
log.warn('Admin API key reset requested — generating a new key');
|
|
64
|
+
}
|
|
65
|
+
// Generate a new key, persist the hash, and return the raw key for the caller to display
|
|
66
|
+
const { rawKey, hash } = generateApiKey();
|
|
67
|
+
await fs.mkdir(adminDir, {
|
|
68
|
+
recursive: true
|
|
69
|
+
});
|
|
70
|
+
await fs.writeFile(hashFilePath, hash.toString('hex'), 'utf-8');
|
|
71
|
+
// Set restrictive permissions (owner read/write only)
|
|
72
|
+
await fs.chmod(hashFilePath, 0o600);
|
|
73
|
+
log.info('Admin API key authentication enabled (new key generated and hash persisted to disk)');
|
|
74
|
+
return {
|
|
75
|
+
apiKeyHash: hash,
|
|
76
|
+
rawKey
|
|
77
|
+
};
|
|
78
|
+
}
|
|
79
|
+
// No data directory, generate a temporary key per session
|
|
80
|
+
const { rawKey, hash } = generateApiKey();
|
|
81
|
+
log.warn('No data directory configured — admin API key cannot be persisted.');
|
|
82
|
+
log.warn('A temporary key has been generated for this session only.');
|
|
83
|
+
return {
|
|
84
|
+
apiKeyHash: hash,
|
|
85
|
+
rawKey
|
|
86
|
+
};
|
|
87
|
+
}
|
|
88
|
+
/**
|
|
89
|
+
* Generates a cryptographically random API key and its SHA-256 hash.
|
|
90
|
+
* @returns The raw key (hex string) and its SHA-256 hash as a Buffer.
|
|
91
|
+
*/ function generateApiKey() {
|
|
92
|
+
const rawKey = randomBytes(32).toString('hex');
|
|
93
|
+
const hash = sha256Hash(rawKey);
|
|
94
|
+
return {
|
|
95
|
+
rawKey,
|
|
96
|
+
hash
|
|
97
|
+
};
|
|
98
|
+
}
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
import type { LogFn, Logger } from '@aztec/foundation/log';
|
|
2
2
|
export declare function aztecStart(options: any, userLog: LogFn, debugLogger: Logger): Promise<void>;
|
|
3
|
-
//# sourceMappingURL=
|
|
3
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXp0ZWNfc3RhcnRfYWN0aW9uLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2xpL2F6dGVjX3N0YXJ0X2FjdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFPQSxPQUFPLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFhM0Qsd0JBQXNCLFVBQVUsQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFLE9BQU8sRUFBRSxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0saUJBMklqRiJ9
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"aztec_start_action.d.ts","sourceRoot":"","sources":["../../src/cli/aztec_start_action.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"aztec_start_action.d.ts","sourceRoot":"","sources":["../../src/cli/aztec_start_action.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAa3D,wBAAsB,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,iBA2IjF"}
|
|
@@ -1,33 +1,36 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
1
|
+
import { getActiveNetworkName } from '@aztec/foundation/config';
|
|
2
|
+
import { createNamespacedSafeJsonRpcServer, getApiKeyAuthMiddleware, startHttpRpcServer } from '@aztec/foundation/json-rpc/server';
|
|
3
|
+
import { AztecNodeAdminApiSchema, AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
|
|
4
|
+
import { getPackageVersion } from '@aztec/stdlib/update-checker';
|
|
4
5
|
import { getVersioningMiddleware } from '@aztec/stdlib/versioning';
|
|
5
6
|
import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
|
|
6
|
-
import {
|
|
7
|
-
import { dirname, resolve } from 'path';
|
|
8
|
-
import { createSandbox } from '../sandbox/index.js';
|
|
7
|
+
import { createLocalNetwork } from '../local-network/index.js';
|
|
9
8
|
import { github, splash } from '../splash.js';
|
|
10
|
-
import {
|
|
9
|
+
import { resolveAdminApiKey } from './admin_api_key_store.js';
|
|
11
10
|
import { extractNamespacedOptions, installSignalHandlers } from './util.js';
|
|
12
11
|
import { getVersions } from './versioning.js';
|
|
13
|
-
const packageJsonPath = resolve(dirname(fileURLToPath(import.meta.url)), '../../package.json');
|
|
14
|
-
const cliVersion = JSON.parse(readFileSync(packageJsonPath).toString()).version;
|
|
15
12
|
export async function aztecStart(options, userLog, debugLogger) {
|
|
16
13
|
// list of 'stop' functions to call when process ends
|
|
17
14
|
const signalHandlers = [];
|
|
18
15
|
const services = {};
|
|
16
|
+
const adminServices = {};
|
|
17
|
+
const packageVersion = getPackageVersion();
|
|
19
18
|
let config = undefined;
|
|
20
|
-
if (options.
|
|
21
|
-
const
|
|
22
|
-
|
|
19
|
+
if (options.localNetwork) {
|
|
20
|
+
const localNetwork = extractNamespacedOptions(options, 'local-network');
|
|
21
|
+
localNetwork.testAccounts = true;
|
|
23
22
|
userLog(`${splash}\n${github}\n\n`);
|
|
24
|
-
userLog(`Setting up Aztec
|
|
25
|
-
const { node,
|
|
26
|
-
l1Mnemonic:
|
|
23
|
+
userLog(`Setting up Aztec local network ${packageVersion ?? 'unknown'}, please stand by...`);
|
|
24
|
+
const { node, stop } = await createLocalNetwork({
|
|
25
|
+
l1Mnemonic: localNetwork.l1Mnemonic,
|
|
27
26
|
l1RpcUrls: options.l1RpcUrls,
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
27
|
+
testAccounts: localNetwork.testAccounts,
|
|
28
|
+
realProofs: false,
|
|
29
|
+
// Setting the epoch duration to 2 by default for local network. This allows the epoch to be "proven" faster, so
|
|
30
|
+
// the users can consume out hash without having to wait for a long time.
|
|
31
|
+
// Note: We are not proving anything in the local network (realProofs == false). But in `createLocalNetwork`,
|
|
32
|
+
// the EpochTestSettler will set the out hash to the outbox when an epoch is complete.
|
|
33
|
+
aztecEpochDuration: 2
|
|
31
34
|
}, userLog);
|
|
32
35
|
// Start Node and PXE JSON-RPC server
|
|
33
36
|
signalHandlers.push(stop);
|
|
@@ -35,34 +38,22 @@ export async function aztecStart(options, userLog, debugLogger) {
|
|
|
35
38
|
node,
|
|
36
39
|
AztecNodeApiSchema
|
|
37
40
|
];
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
];
|
|
43
|
-
} else {
|
|
44
|
-
userLog(`Not exposing PXE API through JSON-RPC server`);
|
|
45
|
-
}
|
|
41
|
+
adminServices.node = [
|
|
42
|
+
node,
|
|
43
|
+
AztecNodeAdminApiSchema
|
|
44
|
+
];
|
|
46
45
|
} else {
|
|
47
|
-
//
|
|
48
|
-
if (options.
|
|
49
|
-
|
|
46
|
+
// Route --prover-node through startNode
|
|
47
|
+
if (options.proverNode && !options.node) {
|
|
48
|
+
options.node = true;
|
|
50
49
|
}
|
|
51
50
|
if (options.node) {
|
|
52
51
|
const { startNode } = await import('./cmds/start_node.js');
|
|
53
|
-
|
|
52
|
+
const networkName = getActiveNetworkName(options.network);
|
|
53
|
+
({ config } = await startNode(options, signalHandlers, services, adminServices, userLog, networkName));
|
|
54
54
|
} else if (options.bot) {
|
|
55
55
|
const { startBot } = await import('./cmds/start_bot.js');
|
|
56
56
|
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
|
-
} else if (options.blobSink) {
|
|
61
|
-
const { startBlobSink } = await import('./cmds/start_blob_sink.js');
|
|
62
|
-
await startBlobSink(options, signalHandlers, userLog);
|
|
63
|
-
} else if (options.pxe) {
|
|
64
|
-
const { startPXE } = await import('./cmds/start_pxe.js');
|
|
65
|
-
({ config } = await startPXE(options, signalHandlers, services, userLog));
|
|
66
57
|
} else if (options.archiver) {
|
|
67
58
|
const { startArchiver } = await import('./cmds/start_archiver.js');
|
|
68
59
|
({ config } = await startArchiver(options, signalHandlers, services));
|
|
@@ -81,9 +72,6 @@ export async function aztecStart(options, userLog, debugLogger) {
|
|
|
81
72
|
} else if (options.sequencer) {
|
|
82
73
|
userLog(`Cannot run a standalone sequencer without a node`);
|
|
83
74
|
process.exit(1);
|
|
84
|
-
} else if (options.faucet) {
|
|
85
|
-
const { startFaucet } = await import('./cmds/start_faucet.js');
|
|
86
|
-
await startFaucet(options, signalHandlers, services, userLog);
|
|
87
75
|
} else {
|
|
88
76
|
userLog(`No module specified to start`);
|
|
89
77
|
process.exit(1);
|
|
@@ -91,18 +79,75 @@ export async function aztecStart(options, userLog, debugLogger) {
|
|
|
91
79
|
}
|
|
92
80
|
installSignalHandlers(debugLogger.info, signalHandlers);
|
|
93
81
|
const versions = getVersions(config);
|
|
82
|
+
const versioningOpts = {
|
|
83
|
+
packageVersion
|
|
84
|
+
};
|
|
85
|
+
// Start the main JSON-RPC server
|
|
94
86
|
if (Object.entries(services).length > 0) {
|
|
95
87
|
const rpcServer = createNamespacedSafeJsonRpcServer(services, {
|
|
96
88
|
http200OnError: false,
|
|
97
89
|
log: debugLogger,
|
|
98
90
|
middlewares: [
|
|
99
91
|
getOtelJsonRpcPropagationMiddleware(),
|
|
100
|
-
getVersioningMiddleware(versions)
|
|
101
|
-
]
|
|
92
|
+
getVersioningMiddleware(versions, versioningOpts)
|
|
93
|
+
],
|
|
94
|
+
maxBatchSize: options.rpcMaxBatchSize,
|
|
95
|
+
maxBodySizeBytes: options.rpcMaxBodySize
|
|
102
96
|
});
|
|
103
97
|
const { port } = await startHttpRpcServer(rpcServer, {
|
|
104
98
|
port: options.port
|
|
105
99
|
});
|
|
106
100
|
debugLogger.info(`Aztec Server listening on port ${port}`, versions);
|
|
107
101
|
}
|
|
102
|
+
// If there are any admin services, start a separate JSON-RPC server for them
|
|
103
|
+
if (Object.entries(adminServices).length > 0) {
|
|
104
|
+
const adminMiddlewares = [
|
|
105
|
+
getOtelJsonRpcPropagationMiddleware(),
|
|
106
|
+
getVersioningMiddleware(versions, versioningOpts)
|
|
107
|
+
];
|
|
108
|
+
// Resolve the admin API key (auto-generated and persisted, or opt-out)
|
|
109
|
+
const apiKeyResolution = await resolveAdminApiKey({
|
|
110
|
+
adminApiKeyHash: options.adminApiKeyHash,
|
|
111
|
+
disableAdminApiKey: options.disableAdminApiKey,
|
|
112
|
+
resetAdminApiKey: options.resetAdminApiKey,
|
|
113
|
+
dataDirectory: options.dataDirectory
|
|
114
|
+
}, debugLogger);
|
|
115
|
+
if (apiKeyResolution) {
|
|
116
|
+
adminMiddlewares.unshift(getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash));
|
|
117
|
+
} else {
|
|
118
|
+
debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
|
|
119
|
+
}
|
|
120
|
+
const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
|
|
121
|
+
http200OnError: false,
|
|
122
|
+
log: debugLogger,
|
|
123
|
+
middlewares: adminMiddlewares,
|
|
124
|
+
maxBatchSize: options.rpcMaxBatchSize,
|
|
125
|
+
maxBodySizeBytes: options.rpcMaxBodySize
|
|
126
|
+
});
|
|
127
|
+
const { port } = await startHttpRpcServer(rpcServer, {
|
|
128
|
+
port: options.adminPort
|
|
129
|
+
});
|
|
130
|
+
debugLogger.info(`Aztec Server admin API listening on port ${port}`, versions);
|
|
131
|
+
// Display the API key after the server has started
|
|
132
|
+
// Uses userLog which is never filtered by LOG_LEVEL.
|
|
133
|
+
if (apiKeyResolution?.rawKey) {
|
|
134
|
+
const separator = '='.repeat(70);
|
|
135
|
+
userLog('');
|
|
136
|
+
userLog(separator);
|
|
137
|
+
userLog(' ADMIN API KEY (save this — it will NOT be shown again)');
|
|
138
|
+
userLog('');
|
|
139
|
+
userLog(` ${apiKeyResolution.rawKey}`);
|
|
140
|
+
userLog('');
|
|
141
|
+
userLog(` Use via header: x-api-key: <key>`);
|
|
142
|
+
userLog(` Or via header: Authorization: Bearer <key>`);
|
|
143
|
+
if (options.dataDirectory) {
|
|
144
|
+
userLog('');
|
|
145
|
+
userLog(' The key hash has been persisted — on next restart, the same key will be used.');
|
|
146
|
+
}
|
|
147
|
+
userLog('');
|
|
148
|
+
userLog(' To disable admin auth: --disable-admin-api-key or AZTEC_DISABLE_ADMIN_API_KEY=true');
|
|
149
|
+
userLog(separator);
|
|
150
|
+
userLog('');
|
|
151
|
+
}
|
|
152
|
+
}
|
|
108
153
|
}
|
|
@@ -2,14 +2,16 @@ import { type ConfigMapping, type EnvVar } from '@aztec/foundation/config';
|
|
|
2
2
|
export interface AztecStartOption {
|
|
3
3
|
flag: string;
|
|
4
4
|
description: string;
|
|
5
|
-
defaultValue: any
|
|
5
|
+
defaultValue: any;
|
|
6
6
|
printDefault?: (val: any) => string;
|
|
7
|
-
|
|
7
|
+
env: EnvVar | undefined;
|
|
8
|
+
fallback?: EnvVar[];
|
|
8
9
|
parseVal?: (val: string) => any;
|
|
9
10
|
}
|
|
10
11
|
export declare const getOptions: (namespace: string, configMappings: Record<string, ConfigMapping>) => AztecStartOption[];
|
|
11
12
|
export declare const universalOptions: string[];
|
|
13
|
+
export declare const NETWORK_FLAG = "network";
|
|
12
14
|
export declare const aztecStartOptions: {
|
|
13
15
|
[key: string]: AztecStartOption[];
|
|
14
16
|
};
|
|
15
|
-
//# sourceMappingURL=
|
|
17
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXp0ZWNfc3RhcnRfb3B0aW9ucy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NsaS9henRlY19zdGFydF9vcHRpb25zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQU9BLE9BQU8sRUFDTCxLQUFLLGFBQWEsRUFDbEIsS0FBSyxNQUFNLEVBSVosTUFBTSwwQkFBMEIsQ0FBQztBQWVsQyxNQUFNLFdBQVcsZ0JBQWdCO0lBQy9CLElBQUksRUFBRSxNQUFNLENBQUM7SUFDYixXQUFXLEVBQUUsTUFBTSxDQUFDO0lBQ3BCLFlBQVksRUFBRSxHQUFHLENBQUM7SUFDbEIsWUFBWSxDQUFDLEVBQUUsQ0FBQyxHQUFHLEVBQUUsR0FBRyxLQUFLLE1BQU0sQ0FBQztJQUNwQyxHQUFHLEVBQUUsTUFBTSxHQUFHLFNBQVMsQ0FBQztJQUN4QixRQUFRLENBQUMsRUFBRSxNQUFNLEVBQUUsQ0FBQztJQUNwQixRQUFRLENBQUMsRUFBRSxDQUFDLEdBQUcsRUFBRSxNQUFNLEtBQUssR0FBRyxDQUFDO0NBQ2pDO0FBRUQsZUFBTyxNQUFNLFVBQVUsMEZBb0J0QixDQUFDO0FBdUJGLGVBQU8sTUFBTSxnQkFBZ0IsVUFZNUIsQ0FBQztBQUVGLGVBQU8sTUFBTSxZQUFZLFlBQVksQ0FBQztBQUd0QyxlQUFPLE1BQU0saUJBQWlCLEVBQUU7SUFBRSxDQUFDLEdBQUcsRUFBRSxNQUFNLEdBQUcsZ0JBQWdCLEVBQUUsQ0FBQTtDQXNPbEUsQ0FBQyJ9
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"aztec_start_options.d.ts","sourceRoot":"","sources":["../../src/cli/aztec_start_options.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"aztec_start_options.d.ts","sourceRoot":"","sources":["../../src/cli/aztec_start_options.ts"],"names":[],"mappings":"AAOA,OAAO,EACL,KAAK,aAAa,EAClB,KAAK,MAAM,EAIZ,MAAM,0BAA0B,CAAC;AAelC,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,YAAY,EAAE,GAAG,CAAC;IAClB,YAAY,CAAC,EAAE,CAAC,GAAG,EAAE,GAAG,KAAK,MAAM,CAAC;IACpC,GAAG,EAAE,MAAM,GAAG,SAAS,CAAC;IACxB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAC;IACpB,QAAQ,CAAC,EAAE,CAAC,GAAG,EAAE,MAAM,KAAK,GAAG,CAAC;CACjC;AAED,eAAO,MAAM,UAAU,0FAoBtB,CAAC;AAuBF,eAAO,MAAM,gBAAgB,UAY5B,CAAC;AAEF,eAAO,MAAM,YAAY,YAAY,CAAC;AAGtC,eAAO,MAAM,iBAAiB,EAAE;IAAE,CAAC,GAAG,EAAE,MAAM,GAAG,gBAAgB,EAAE,CAAA;CAsOlE,CAAC"}
|