@aztec/aztec 0.0.1-commit.b655e406 → 0.0.1-commit.b8a057fa
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 +15 -6
- 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 +73 -35
- package/dest/cli/aztec_start_options.d.ts +2 -2
- package/dest/cli/aztec_start_options.d.ts.map +1 -1
- package/dest/cli/aztec_start_options.js +60 -53
- 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 +174 -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 +76 -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/prover.d.ts +4 -0
- package/dest/cli/cmds/prover.d.ts.map +1 -0
- package/dest/cli/cmds/prover.js +24 -0
- package/dest/cli/cmds/standby.d.ts +56 -0
- package/dest/cli/cmds/standby.d.ts.map +1 -0
- package/dest/cli/cmds/standby.js +140 -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 +18 -10
- package/dest/cli/cmds/start_node.d.ts +3 -2
- package/dest/cli/cmds/start_node.d.ts.map +1 -1
- package/dest/cli/cmds/start_node.js +85 -54
- 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 +8 -20
- 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 +25 -16
- package/dest/cli/cmds/start_txe.d.ts +2 -2
- package/dest/cli/cmds/start_txe.d.ts.map +1 -1
- package/dest/cli/cmds/start_txe.js +6 -5
- package/dest/cli/cmds/utils/artifacts.d.ts +26 -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/collect_crate_dirs.d.ts +21 -0
- package/dest/cli/cmds/utils/collect_crate_dirs.d.ts.map +1 -0
- package/dest/cli/cmds/utils/collect_crate_dirs.js +114 -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 +90 -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/cmds/utils/warn_if_aztec_version_mismatch.d.ts +4 -0
- package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.d.ts.map +1 -0
- package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.js +61 -0
- package/dest/cli/index.d.ts +1 -1
- package/dest/cli/preload_crs.d.ts +1 -1
- package/dest/cli/util.d.ts +17 -23
- package/dest/cli/util.d.ts.map +1 -1
- package/dest/cli/util.js +38 -101
- package/dest/cli/versioning.d.ts +1 -1
- package/dest/examples/token.d.ts +1 -1
- package/dest/examples/token.js +12 -12
- package/dest/examples/util.d.ts +2 -2
- package/dest/examples/util.d.ts.map +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/auth_registry.d.ts +5 -0
- package/dest/local-network/auth_registry.d.ts.map +1 -0
- package/dest/local-network/auth_registry.js +17 -0
- package/dest/local-network/banana_fpc.d.ts +11 -0
- package/dest/local-network/banana_fpc.d.ts.map +1 -0
- package/dest/{sandbox → local-network}/banana_fpc.js +14 -10
- package/dest/local-network/index.d.ts +4 -0
- package/dest/local-network/index.d.ts.map +1 -0
- package/dest/{sandbox → local-network}/index.js +1 -1
- package/dest/local-network/local-network.d.ts +49 -0
- package/dest/local-network/local-network.d.ts.map +1 -0
- package/dest/local-network/local-network.js +205 -0
- package/dest/local-network/sponsored_fpc.d.ts +5 -0
- package/dest/local-network/sponsored_fpc.d.ts.map +1 -0
- package/dest/mnemonic.d.ts +1 -1
- package/dest/splash.d.ts +1 -1
- package/dest/testing/cheat_codes.d.ts +17 -23
- package/dest/testing/cheat_codes.d.ts.map +1 -1
- package/dest/testing/cheat_codes.js +17 -43
- 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 +42 -0
- package/dest/testing/index.d.ts +3 -2
- package/dest/testing/index.d.ts.map +1 -1
- package/dest/testing/index.js +2 -1
- package/dest/testing/token_allowed_setup.d.ts +12 -0
- package/dest/testing/token_allowed_setup.d.ts.map +1 -0
- package/dest/testing/token_allowed_setup.js +24 -0
- package/package.json +42 -37
- package/scripts/add_crate.sh +53 -0
- package/scripts/aztec.sh +73 -0
- package/scripts/init.sh +39 -0
- package/scripts/new.sh +83 -0
- package/scripts/setup_workspace.sh +69 -0
- package/scripts/templates/blank/contract/Nargo.toml +6 -0
- package/scripts/templates/blank/contract/src/main.nr +10 -0
- package/scripts/templates/blank/test/Nargo.toml +7 -0
- package/scripts/templates/blank/test/src/lib.nr +11 -0
- package/scripts/templates/counter/contract/Nargo.toml +7 -0
- package/scripts/templates/counter/contract/src/main.nr +48 -0
- package/scripts/templates/counter/test/Nargo.toml +7 -0
- package/scripts/templates/counter/test/src/lib.nr +32 -0
- package/src/bin/index.ts +16 -6
- package/src/cli/admin_api_key_store.ts +128 -0
- package/src/cli/aztec_start_action.ts +74 -28
- package/src/cli/aztec_start_options.ts +68 -59
- package/src/cli/cli.ts +11 -11
- package/src/cli/cmds/compile.ts +205 -0
- package/src/cli/cmds/migrate_ha_db.ts +43 -0
- package/src/cli/cmds/profile.ts +26 -0
- package/src/cli/cmds/profile_flamegraph.ts +64 -0
- package/src/cli/cmds/profile_gates.ts +84 -0
- package/src/cli/cmds/profile_utils.ts +58 -0
- package/src/cli/cmds/prover.ts +42 -0
- package/src/cli/cmds/standby.ts +184 -0
- package/src/cli/cmds/start_bot.ts +18 -12
- package/src/cli/cmds/start_node.ts +95 -55
- package/src/cli/cmds/start_p2p_bootstrap.ts +3 -3
- package/src/cli/cmds/start_prover_agent.ts +9 -20
- package/src/cli/cmds/start_prover_broker.ts +29 -26
- package/src/cli/cmds/start_txe.ts +7 -5
- package/src/cli/cmds/utils/artifacts.ts +49 -0
- package/src/cli/cmds/utils/collect_crate_dirs.ts +118 -0
- package/src/cli/cmds/utils/needs_recompile.ts +98 -0
- package/src/cli/cmds/utils/spawn.ts +16 -0
- package/src/cli/cmds/utils/warn_if_aztec_version_mismatch.ts +76 -0
- package/src/cli/util.ts +41 -120
- package/src/examples/token.ts +13 -13
- package/src/examples/util.ts +1 -1
- package/src/index.ts +2 -2
- package/src/local-network/auth_registry.ts +19 -0
- package/src/{sandbox → local-network}/banana_fpc.ts +17 -9
- package/src/{sandbox → local-network}/index.ts +1 -1
- package/src/local-network/local-network.ts +250 -0
- package/src/{sandbox → local-network}/sponsored_fpc.ts +3 -2
- package/src/testing/cheat_codes.ts +18 -48
- package/src/testing/epoch_test_settler.ts +47 -0
- package/src/testing/index.ts +2 -1
- package/src/testing/token_allowed_setup.ts +26 -0
- package/dest/cli/cmds/start_archiver.d.ts +0 -9
- package/dest/cli/cmds/start_archiver.d.ts.map +0 -1
- package/dest/cli/cmds/start_archiver.js +0 -50
- package/dest/cli/cmds/start_blob_sink.d.ts +0 -3
- package/dest/cli/cmds/start_blob_sink.d.ts.map +0 -1
- package/dest/cli/cmds/start_blob_sink.js +0 -33
- package/dest/cli/cmds/start_prover_node.d.ts +0 -7
- package/dest/cli/cmds/start_prover_node.d.ts.map +0 -1
- package/dest/cli/cmds/start_prover_node.js +0 -108
- package/dest/cli/release_version.d.ts +0 -2
- package/dest/cli/release_version.d.ts.map +0 -1
- package/dest/cli/release_version.js +0 -14
- package/dest/sandbox/banana_fpc.d.ts +0 -10
- 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/sandbox.d.ts +0 -74
- package/dest/sandbox/sandbox.d.ts.map +0 -1
- package/dest/sandbox/sandbox.js +0 -183
- package/dest/sandbox/sponsored_fpc.d.ts +0 -4
- package/dest/sandbox/sponsored_fpc.d.ts.map +0 -1
- package/dest/testing/anvil_test_watcher.d.ts +0 -34
- package/dest/testing/anvil_test_watcher.d.ts.map +0 -1
- package/dest/testing/anvil_test_watcher.js +0 -142
- package/src/cli/cmds/start_archiver.ts +0 -61
- package/src/cli/cmds/start_blob_sink.ts +0 -57
- package/src/cli/cmds/start_prover_node.ts +0 -124
- package/src/cli/release_version.ts +0 -21
- package/src/sandbox/sandbox.ts +0 -242
- package/src/testing/anvil_test_watcher.ts +0 -164
- /package/dest/{sandbox → local-network}/sponsored_fpc.js +0 -0
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
|
@@ -2,7 +2,8 @@
|
|
|
2
2
|
//
|
|
3
3
|
import { injectCommands as injectBuilderCommands } from '@aztec/builder';
|
|
4
4
|
import { injectCommands as injectAztecNodeCommands } from '@aztec/cli/aztec_node';
|
|
5
|
-
import {
|
|
5
|
+
import { enrichEnvironmentWithChainName } from '@aztec/cli/config/chain';
|
|
6
|
+
import { enrichEnvironmentWithNetworkConfig } from '@aztec/cli/config/network';
|
|
6
7
|
import { injectCommands as injectContractCommands } from '@aztec/cli/contracts';
|
|
7
8
|
import { injectCommands as injectInfrastructureCommands } from '@aztec/cli/infrastructure';
|
|
8
9
|
import { injectCommands as injectL1Commands } from '@aztec/cli/l1';
|
|
@@ -10,10 +11,14 @@ import { injectCommands as injectMiscCommands } from '@aztec/cli/misc';
|
|
|
10
11
|
import { injectCommands as injectValidatorKeysCommands } from '@aztec/cli/validator_keys';
|
|
11
12
|
import { getActiveNetworkName } from '@aztec/foundation/config';
|
|
12
13
|
import { createConsoleLogger, createLogger } from '@aztec/foundation/log';
|
|
14
|
+
import { getPackageVersion } from '@aztec/stdlib/update-checker';
|
|
13
15
|
import { Command } from 'commander';
|
|
14
|
-
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';
|
|
19
|
+
import { injectProverCommand } from '../cli/cmds/prover.js';
|
|
15
20
|
import { injectAztecCommands } from '../cli/index.js';
|
|
16
|
-
|
|
21
|
+
const NETWORK_FLAG = 'network';
|
|
17
22
|
const userLog = createConsoleLogger();
|
|
18
23
|
const debugLogger = createLogger('cli');
|
|
19
24
|
/** CLI & full node main entrypoint */ async function main() {
|
|
@@ -31,10 +36,10 @@ const debugLogger = createLogger('cli');
|
|
|
31
36
|
}
|
|
32
37
|
const networkName = getActiveNetworkName(networkValue);
|
|
33
38
|
await enrichEnvironmentWithNetworkConfig(networkName);
|
|
34
|
-
|
|
35
|
-
const cliVersion =
|
|
39
|
+
enrichEnvironmentWithChainName(networkName);
|
|
40
|
+
const cliVersion = getPackageVersion();
|
|
36
41
|
let program = new Command('aztec');
|
|
37
|
-
program.description('Aztec command line interface').version(cliVersion);
|
|
42
|
+
program.description('Aztec command line interface').version(cliVersion).enablePositionalOptions();
|
|
38
43
|
program = injectAztecCommands(program, userLog, debugLogger);
|
|
39
44
|
program = injectBuilderCommands(program);
|
|
40
45
|
program = injectContractCommands(program, userLog, debugLogger);
|
|
@@ -43,6 +48,10 @@ const debugLogger = createLogger('cli');
|
|
|
43
48
|
program = injectAztecNodeCommands(program, userLog, debugLogger);
|
|
44
49
|
program = injectMiscCommands(program, userLog);
|
|
45
50
|
program = injectValidatorKeysCommands(program, userLog);
|
|
51
|
+
program = injectCompileCommand(program, userLog);
|
|
52
|
+
program = injectProfileCommand(program, userLog);
|
|
53
|
+
program = injectMigrateCommand(program, userLog);
|
|
54
|
+
program = injectProverCommand(program, userLog);
|
|
46
55
|
await program.parseAsync(process.argv);
|
|
47
56
|
}
|
|
48
57
|
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,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXp0ZWNfc3RhcnRfYWN0aW9uLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2xpL2F6dGVjX3N0YXJ0X2FjdGlvbi50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFRQSxPQUFPLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFZM0Qsd0JBQXNCLFVBQVUsQ0FBQyxPQUFPLEVBQUUsR0FBRyxFQUFFLE9BQU8sRUFBRSxLQUFLLEVBQUUsV0FBVyxFQUFFLE1BQU0saUJBd0lqRiJ9
|
|
@@ -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":"AAQA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAY3D,wBAAsB,UAAU,CAAC,OAAO,EAAE,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,MAAM,iBAwIjF"}
|
|
@@ -1,10 +1,12 @@
|
|
|
1
|
-
import {
|
|
2
|
-
import {
|
|
1
|
+
import { registerAztecNodeRpcHandlers } from '@aztec/aztec-node';
|
|
2
|
+
import { getActiveNetworkName } from '@aztec/foundation/config';
|
|
3
|
+
import { createNamespacedSafeJsonRpcServer, getApiKeyAuthMiddleware, startHttpRpcServer } from '@aztec/foundation/json-rpc/server';
|
|
4
|
+
import { getPackageVersion } from '@aztec/stdlib/update-checker';
|
|
3
5
|
import { getVersioningMiddleware } from '@aztec/stdlib/versioning';
|
|
4
|
-
import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
|
|
5
|
-
import {
|
|
6
|
+
import { getOtelJsonRpcDiagnosticsMiddleware, getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
|
|
7
|
+
import { createLocalNetwork } from '../local-network/index.js';
|
|
6
8
|
import { github, splash } from '../splash.js';
|
|
7
|
-
import {
|
|
9
|
+
import { resolveAdminApiKey } from './admin_api_key_store.js';
|
|
8
10
|
import { extractNamespacedOptions, installSignalHandlers } from './util.js';
|
|
9
11
|
import { getVersions } from './versioning.js';
|
|
10
12
|
export async function aztecStart(options, userLog, debugLogger) {
|
|
@@ -12,42 +14,34 @@ export async function aztecStart(options, userLog, debugLogger) {
|
|
|
12
14
|
const signalHandlers = [];
|
|
13
15
|
const services = {};
|
|
14
16
|
const adminServices = {};
|
|
17
|
+
const packageVersion = getPackageVersion();
|
|
15
18
|
let config = undefined;
|
|
16
|
-
if (options.
|
|
17
|
-
const
|
|
18
|
-
const sandboxOptions = extractNamespacedOptions(options, 'sandbox');
|
|
19
|
-
sandboxOptions.testAccounts = true;
|
|
19
|
+
if (options.localNetwork) {
|
|
20
|
+
const localNetwork = extractNamespacedOptions(options, 'localNetwork');
|
|
20
21
|
userLog(`${splash}\n${github}\n\n`);
|
|
21
|
-
userLog(`Setting up Aztec
|
|
22
|
-
const { node, stop } = await
|
|
23
|
-
l1Mnemonic:
|
|
22
|
+
userLog(`Setting up Aztec local network ${packageVersion}, please stand by...`);
|
|
23
|
+
const { node, stop } = await createLocalNetwork({
|
|
24
|
+
l1Mnemonic: localNetwork.l1Mnemonic,
|
|
24
25
|
l1RpcUrls: options.l1RpcUrls,
|
|
25
|
-
|
|
26
|
-
testAccounts: sandboxOptions.testAccounts,
|
|
27
|
-
realProofs: false
|
|
26
|
+
testAccounts: localNetwork.testAccounts
|
|
28
27
|
}, userLog);
|
|
29
28
|
// Start Node and PXE JSON-RPC server
|
|
30
29
|
signalHandlers.push(stop);
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
];
|
|
30
|
+
registerAztecNodeRpcHandlers(node, services, adminServices, {
|
|
31
|
+
debug: true
|
|
32
|
+
});
|
|
35
33
|
} else {
|
|
34
|
+
// Route --prover-node through startNode
|
|
35
|
+
if (options.proverNode && !options.node) {
|
|
36
|
+
options.node = true;
|
|
37
|
+
}
|
|
36
38
|
if (options.node) {
|
|
37
39
|
const { startNode } = await import('./cmds/start_node.js');
|
|
38
|
-
|
|
40
|
+
const networkName = getActiveNetworkName(options.network);
|
|
41
|
+
({ config } = await startNode(options, signalHandlers, services, adminServices, userLog, networkName));
|
|
39
42
|
} else if (options.bot) {
|
|
40
43
|
const { startBot } = await import('./cmds/start_bot.js');
|
|
41
44
|
await startBot(options, signalHandlers, services, userLog);
|
|
42
|
-
} else if (options.proverNode) {
|
|
43
|
-
const { startProverNode } = await import('./cmds/start_prover_node.js');
|
|
44
|
-
({ config } = await startProverNode(options, signalHandlers, services, userLog));
|
|
45
|
-
} else if (options.blobSink) {
|
|
46
|
-
const { startBlobSink } = await import('./cmds/start_blob_sink.js');
|
|
47
|
-
await startBlobSink(options, signalHandlers, userLog);
|
|
48
|
-
} else if (options.archiver) {
|
|
49
|
-
const { startArchiver } = await import('./cmds/start_archiver.js');
|
|
50
|
-
({ config } = await startArchiver(options, signalHandlers, services));
|
|
51
45
|
} else if (options.p2pBootstrap) {
|
|
52
46
|
const { startP2PBootstrap } = await import('./cmds/start_p2p_bootstrap.js');
|
|
53
47
|
({ config } = await startP2PBootstrap(options, signalHandlers, services, userLog));
|
|
@@ -59,7 +53,7 @@ export async function aztecStart(options, userLog, debugLogger) {
|
|
|
59
53
|
await startProverBroker(options, signalHandlers, services, userLog);
|
|
60
54
|
} else if (options.txe) {
|
|
61
55
|
const { startTXE } = await import('./cmds/start_txe.js');
|
|
62
|
-
await startTXE(options, debugLogger);
|
|
56
|
+
await startTXE(options, signalHandlers, debugLogger);
|
|
63
57
|
} else if (options.sequencer) {
|
|
64
58
|
userLog(`Cannot run a standalone sequencer without a node`);
|
|
65
59
|
process.exit(1);
|
|
@@ -70,14 +64,23 @@ export async function aztecStart(options, userLog, debugLogger) {
|
|
|
70
64
|
}
|
|
71
65
|
installSignalHandlers(debugLogger.info, signalHandlers);
|
|
72
66
|
const versions = getVersions(config);
|
|
67
|
+
const versioningOpts = {
|
|
68
|
+
packageVersion
|
|
69
|
+
};
|
|
73
70
|
// Start the main JSON-RPC server
|
|
74
71
|
if (Object.entries(services).length > 0) {
|
|
72
|
+
if (services.aztec) {
|
|
73
|
+
const { BarretenbergSync } = await import('@aztec/bb.js');
|
|
74
|
+
// JSON-RPC schema parsing may decompress compressed Chonk proofs before the node handler runs.
|
|
75
|
+
await BarretenbergSync.initSingleton();
|
|
76
|
+
}
|
|
75
77
|
const rpcServer = createNamespacedSafeJsonRpcServer(services, {
|
|
78
|
+
diagnostic: getOtelJsonRpcDiagnosticsMiddleware(),
|
|
76
79
|
http200OnError: false,
|
|
77
80
|
log: debugLogger,
|
|
78
81
|
middlewares: [
|
|
79
82
|
getOtelJsonRpcPropagationMiddleware(),
|
|
80
|
-
getVersioningMiddleware(versions)
|
|
83
|
+
getVersioningMiddleware(versions, versioningOpts)
|
|
81
84
|
],
|
|
82
85
|
maxBatchSize: options.rpcMaxBatchSize,
|
|
83
86
|
maxBodySizeBytes: options.rpcMaxBodySize
|
|
@@ -89,13 +92,27 @@ export async function aztecStart(options, userLog, debugLogger) {
|
|
|
89
92
|
}
|
|
90
93
|
// If there are any admin services, start a separate JSON-RPC server for them
|
|
91
94
|
if (Object.entries(adminServices).length > 0) {
|
|
95
|
+
const adminMiddlewares = [
|
|
96
|
+
getOtelJsonRpcPropagationMiddleware(),
|
|
97
|
+
getVersioningMiddleware(versions, versioningOpts)
|
|
98
|
+
];
|
|
99
|
+
// Resolve the admin API key (auto-generated and persisted, or opt-out)
|
|
100
|
+
const apiKeyResolution = await resolveAdminApiKey({
|
|
101
|
+
adminApiKeyHash: options.adminApiKeyHash,
|
|
102
|
+
disableAdminApiKey: options.disableAdminApiKey,
|
|
103
|
+
resetAdminApiKey: options.resetAdminApiKey,
|
|
104
|
+
dataDirectory: options.dataDirectory
|
|
105
|
+
}, debugLogger);
|
|
106
|
+
if (apiKeyResolution) {
|
|
107
|
+
adminMiddlewares.unshift(getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash));
|
|
108
|
+
} else {
|
|
109
|
+
debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
|
|
110
|
+
}
|
|
92
111
|
const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
|
|
112
|
+
diagnostic: getOtelJsonRpcDiagnosticsMiddleware(),
|
|
93
113
|
http200OnError: false,
|
|
94
114
|
log: debugLogger,
|
|
95
|
-
middlewares:
|
|
96
|
-
getOtelJsonRpcPropagationMiddleware(),
|
|
97
|
-
getVersioningMiddleware(versions)
|
|
98
|
-
],
|
|
115
|
+
middlewares: adminMiddlewares,
|
|
99
116
|
maxBatchSize: options.rpcMaxBatchSize,
|
|
100
117
|
maxBodySizeBytes: options.rpcMaxBodySize
|
|
101
118
|
});
|
|
@@ -103,5 +120,26 @@ export async function aztecStart(options, userLog, debugLogger) {
|
|
|
103
120
|
port: options.adminPort
|
|
104
121
|
});
|
|
105
122
|
debugLogger.info(`Aztec Server admin API listening on port ${port}`, versions);
|
|
123
|
+
// Display the API key after the server has started
|
|
124
|
+
// Uses userLog which is never filtered by LOG_LEVEL.
|
|
125
|
+
if (apiKeyResolution?.rawKey) {
|
|
126
|
+
const separator = '='.repeat(70);
|
|
127
|
+
userLog('');
|
|
128
|
+
userLog(separator);
|
|
129
|
+
userLog(' ADMIN API KEY (save this — it will NOT be shown again)');
|
|
130
|
+
userLog('');
|
|
131
|
+
userLog(` ${apiKeyResolution.rawKey}`);
|
|
132
|
+
userLog('');
|
|
133
|
+
userLog(` Use via header: x-api-key: <key>`);
|
|
134
|
+
userLog(` Or via header: Authorization: Bearer <key>`);
|
|
135
|
+
if (options.dataDirectory) {
|
|
136
|
+
userLog('');
|
|
137
|
+
userLog(' The key hash has been persisted — on next restart, the same key will be used.');
|
|
138
|
+
}
|
|
139
|
+
userLog('');
|
|
140
|
+
userLog(' To disable admin auth: --disable-admin-api-key or AZTEC_DISABLE_ADMIN_API_KEY=true');
|
|
141
|
+
userLog(separator);
|
|
142
|
+
userLog('');
|
|
143
|
+
}
|
|
106
144
|
}
|
|
107
145
|
}
|
|
@@ -8,10 +8,10 @@ export interface AztecStartOption {
|
|
|
8
8
|
fallback?: EnvVar[];
|
|
9
9
|
parseVal?: (val: string) => any;
|
|
10
10
|
}
|
|
11
|
-
export declare const getOptions: (namespace: string, configMappings: Record<string, ConfigMapping
|
|
11
|
+
export declare const getOptions: (namespace: string, configMappings: Record<string, ConfigMapping<unknown>>) => AztecStartOption[];
|
|
12
12
|
export declare const universalOptions: string[];
|
|
13
13
|
export declare const NETWORK_FLAG = "network";
|
|
14
14
|
export declare const aztecStartOptions: {
|
|
15
15
|
[key: string]: AztecStartOption[];
|
|
16
16
|
};
|
|
17
|
-
//# sourceMappingURL=
|
|
17
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiYXp0ZWNfc3RhcnRfb3B0aW9ucy5kLnRzIiwic291cmNlUm9vdCI6IiIsInNvdXJjZXMiOlsiLi4vLi4vc3JjL2NsaS9henRlY19zdGFydF9vcHRpb25zLnRzIl0sIm5hbWVzIjpbXSwibWFwcGluZ3MiOiJBQU9BLE9BQU8sRUFDTCxLQUFLLGFBQWEsRUFDbEIsS0FBSyxNQUFNLEVBSVosTUFBTSwwQkFBMEIsQ0FBQztBQWVsQyxNQUFNLFdBQVcsZ0JBQWdCO0lBQy9CLElBQUksRUFBRSxNQUFNLENBQUM7SUFDYixXQUFXLEVBQUUsTUFBTSxDQUFDO0lBQ3BCLFlBQVksRUFBRSxHQUFHLENBQUM7SUFDbEIsWUFBWSxDQUFDLEVBQUUsQ0FBQyxHQUFHLEVBQUUsR0FBRyxLQUFLLE1BQU0sQ0FBQztJQUNwQyxHQUFHLEVBQUUsTUFBTSxHQUFHLFNBQVMsQ0FBQztJQUN4QixRQUFRLENBQUMsRUFBRSxNQUFNLEVBQUUsQ0FBQztJQUNwQixRQUFRLENBQUMsRUFBRSxDQUFDLEdBQUcsRUFBRSxNQUFNLEtBQUssR0FBRyxDQUFDO0NBQ2pDO0FBRUQsZUFBTyxNQUFNLFVBQVUsbUdBb0J0QixDQUFDO0FBMkJGLGVBQU8sTUFBTSxnQkFBZ0IsVUFZNUIsQ0FBQztBQUVGLGVBQU8sTUFBTSxZQUFZLFlBQVksQ0FBQztBQUd0QyxlQUFPLE1BQU0saUJBQWlCLEVBQUU7SUFBRSxDQUFDLEdBQUcsRUFBRSxNQUFNLEdBQUcsZ0JBQWdCLEVBQUUsQ0FBQTtDQWlPbEUsQ0FBQyJ9
|
|
@@ -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,mGAoBtB,CAAC;AA2BF,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;CAiOlE,CAAC"}
|
|
@@ -1,19 +1,21 @@
|
|
|
1
1
|
import { 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 { booleanConfigHelper, isBooleanConfigValue, omitConfigMappings } from '@aztec/foundation/config';
|
|
8
|
-
import { dataConfigMappings } from '@aztec/kv-store/config';
|
|
9
9
|
import { sharedNodeConfigMappings } from '@aztec/node-lib/config';
|
|
10
10
|
import { bootnodeConfigMappings, p2pConfigMappings } from '@aztec/p2p/config';
|
|
11
|
-
import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker';
|
|
11
|
+
import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker/config';
|
|
12
12
|
import { proverNodeConfigMappings } from '@aztec/prover-node/config';
|
|
13
13
|
import { allPxeConfigMappings } from '@aztec/pxe/config';
|
|
14
|
-
import {
|
|
15
|
-
import {
|
|
16
|
-
import {
|
|
14
|
+
import { sequencerClientConfigMappings } from '@aztec/sequencer-client/config';
|
|
15
|
+
import { chainConfigMappings, nodeRpcConfigMappings } from '@aztec/stdlib/config';
|
|
16
|
+
import { dataConfigMappings } from '@aztec/stdlib/kv-store';
|
|
17
|
+
import { telemetryClientConfigMappings } from '@aztec/telemetry-client/config';
|
|
18
|
+
import { worldStateConfigMappings } from '@aztec/world-state/config';
|
|
17
19
|
import { DefaultMnemonic } from '../mnemonic.js';
|
|
18
20
|
export const getOptions = (namespace, configMappings)=>{
|
|
19
21
|
const options = [];
|
|
@@ -56,6 +58,7 @@ export const universalOptions = [
|
|
|
56
58
|
'l1ConsensusHostApiKeys',
|
|
57
59
|
'l1ConsensusHostApiKeyHeaders',
|
|
58
60
|
'p2pEnabled',
|
|
61
|
+
'fishermanMode',
|
|
59
62
|
...getKeys(chainConfigMappings),
|
|
60
63
|
...getKeys(l1ContractsConfigMappings),
|
|
61
64
|
...getKeys(l1ContractAddressesMapping),
|
|
@@ -73,30 +76,29 @@ export const aztecStartOptions = {
|
|
|
73
76
|
defaultValue: undefined,
|
|
74
77
|
env: 'NETWORK'
|
|
75
78
|
},
|
|
76
|
-
configToFlag('--auto-
|
|
77
|
-
configToFlag('--auto-update-url', sharedNodeConfigMappings.autoUpdateUrl),
|
|
79
|
+
configToFlag('--enable-auto-shutdown', sharedNodeConfigMappings.enableAutoShutdown),
|
|
78
80
|
configToFlag('--sync-mode', sharedNodeConfigMappings.syncMode),
|
|
79
|
-
configToFlag('--snapshots-urls', sharedNodeConfigMappings.snapshotsUrls)
|
|
81
|
+
configToFlag('--snapshots-urls', sharedNodeConfigMappings.snapshotsUrls),
|
|
82
|
+
configToFlag('--fisherman-mode', sharedNodeConfigMappings.fishermanMode)
|
|
80
83
|
],
|
|
81
|
-
|
|
84
|
+
LOCAL_NETWORK: [
|
|
82
85
|
{
|
|
83
|
-
flag: '--
|
|
84
|
-
description: 'Starts Aztec
|
|
86
|
+
flag: '--local-network',
|
|
87
|
+
description: 'Starts Aztec Local Network',
|
|
85
88
|
defaultValue: undefined,
|
|
86
89
|
env: undefined
|
|
87
90
|
},
|
|
88
91
|
{
|
|
89
|
-
flag: '--
|
|
92
|
+
flag: '--local-network.l1Mnemonic <value>',
|
|
90
93
|
description: 'Mnemonic for L1 accounts. Will be used ',
|
|
91
94
|
defaultValue: DefaultMnemonic,
|
|
92
95
|
env: 'MNEMONIC'
|
|
93
96
|
},
|
|
94
97
|
{
|
|
95
|
-
flag: '--
|
|
96
|
-
description: '
|
|
97
|
-
env: '
|
|
98
|
-
|
|
99
|
-
parseVal: (val)=>val ? parseInt(val) : undefined
|
|
98
|
+
flag: '--local-network.testAccounts',
|
|
99
|
+
description: 'Deploy test accounts on local network start',
|
|
100
|
+
env: 'TEST_ACCOUNTS',
|
|
101
|
+
...booleanConfigHelper(true)
|
|
100
102
|
}
|
|
101
103
|
],
|
|
102
104
|
API: [
|
|
@@ -114,12 +116,42 @@ export const aztecStartOptions = {
|
|
|
114
116
|
env: 'AZTEC_ADMIN_PORT',
|
|
115
117
|
parseVal: (val)=>parseInt(val, 10)
|
|
116
118
|
},
|
|
119
|
+
{
|
|
120
|
+
flag: '--admin-api-key-hash <value>',
|
|
121
|
+
description: '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.',
|
|
122
|
+
defaultValue: undefined,
|
|
123
|
+
env: 'AZTEC_ADMIN_API_KEY_HASH'
|
|
124
|
+
},
|
|
125
|
+
{
|
|
126
|
+
flag: '--disable-admin-api-key',
|
|
127
|
+
description: 'Disable API key authentication on the admin RPC endpoint. By default, a key is auto-generated, displayed once, and its hash is persisted.',
|
|
128
|
+
defaultValue: false,
|
|
129
|
+
env: 'AZTEC_DISABLE_ADMIN_API_KEY',
|
|
130
|
+
// undefined means the flag was passed without a value (boolean toggle), treat as true.
|
|
131
|
+
parseVal: (val)=>val === undefined || val === 'true' || val === '1'
|
|
132
|
+
},
|
|
133
|
+
{
|
|
134
|
+
flag: '--reset-admin-api-key',
|
|
135
|
+
description: 'Force-generate a new admin API key, replacing any previously persisted key hash. The new key is displayed once at startup.',
|
|
136
|
+
defaultValue: false,
|
|
137
|
+
env: 'AZTEC_RESET_ADMIN_API_KEY',
|
|
138
|
+
parseVal: (val)=>val === 'true' || val === '1'
|
|
139
|
+
},
|
|
140
|
+
{
|
|
141
|
+
flag: '--node-debug',
|
|
142
|
+
description: 'Expose debug endpoints (e.g. mineBlock) on the main RPC port',
|
|
143
|
+
defaultValue: false,
|
|
144
|
+
env: 'AZTEC_NODE_DEBUG',
|
|
145
|
+
parseVal: (val)=>val === undefined || val === 'true' || val === '1'
|
|
146
|
+
},
|
|
117
147
|
{
|
|
118
148
|
flag: '--api-prefix <value>',
|
|
119
149
|
description: 'Prefix for API routes on any service that is started',
|
|
120
150
|
defaultValue: '',
|
|
121
151
|
env: 'API_PREFIX'
|
|
122
|
-
}
|
|
152
|
+
},
|
|
153
|
+
configToFlag('--rpcMaxBatchSize', nodeRpcConfigMappings.rpcMaxBatchSize),
|
|
154
|
+
configToFlag('--rpcMaxBodySize', nodeRpcConfigMappings.rpcMaxBodySize)
|
|
123
155
|
],
|
|
124
156
|
ETHEREUM: [
|
|
125
157
|
configToFlag('--l1-chain-id', l1ReaderConfigMappings.l1ChainId),
|
|
@@ -128,9 +160,9 @@ export const aztecStartOptions = {
|
|
|
128
160
|
...l1ReaderConfigMappings.l1RpcUrls,
|
|
129
161
|
defaultValue: undefined
|
|
130
162
|
}),
|
|
131
|
-
configToFlag('--l1-consensus-host-urls',
|
|
132
|
-
configToFlag('--l1-consensus-host-api-keys',
|
|
133
|
-
configToFlag('--l1-consensus-host-api-key-headers',
|
|
163
|
+
configToFlag('--l1-consensus-host-urls', blobClientConfigMapping.l1ConsensusHostUrls),
|
|
164
|
+
configToFlag('--l1-consensus-host-api-keys', blobClientConfigMapping.l1ConsensusHostApiKeys),
|
|
165
|
+
configToFlag('--l1-consensus-host-api-key-headers', blobClientConfigMapping.l1ConsensusHostApiKeyHeaders)
|
|
134
166
|
],
|
|
135
167
|
'L1 CONTRACTS': [
|
|
136
168
|
configToFlag('--registry-address', l1ContractAddressesMapping.registryAddress),
|
|
@@ -143,7 +175,7 @@ export const aztecStartOptions = {
|
|
|
143
175
|
'WORLD STATE': [
|
|
144
176
|
configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
|
|
145
177
|
configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
|
|
146
|
-
configToFlag('--world-state-
|
|
178
|
+
configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory)
|
|
147
179
|
],
|
|
148
180
|
// We can't easily auto-generate node options as they're parts of modules defined below
|
|
149
181
|
'AZTEC NODE': [
|
|
@@ -155,12 +187,6 @@ export const aztecStartOptions = {
|
|
|
155
187
|
}
|
|
156
188
|
],
|
|
157
189
|
ARCHIVER: [
|
|
158
|
-
{
|
|
159
|
-
flag: '--archiver',
|
|
160
|
-
description: 'Starts Aztec Archiver with options',
|
|
161
|
-
defaultValue: undefined,
|
|
162
|
-
env: undefined
|
|
163
|
-
},
|
|
164
190
|
...getOptions('archiver', omitConfigMappings(archiverConfigMappings, Object.keys(l1ContractsConfigMappings)))
|
|
165
191
|
],
|
|
166
192
|
SEQUENCER: [
|
|
@@ -172,20 +198,12 @@ export const aztecStartOptions = {
|
|
|
172
198
|
},
|
|
173
199
|
...getOptions('sequencer', omitConfigMappings(sequencerClientConfigMappings, [
|
|
174
200
|
'fakeProcessingDelayPerTxMs',
|
|
201
|
+
'fakeThrowAfterProcessingTxCount',
|
|
175
202
|
'skipCollectingAttestations',
|
|
176
203
|
'skipInvalidateBlockAsProposer',
|
|
177
204
|
'blobSinkMapSizeKb'
|
|
178
205
|
]))
|
|
179
206
|
],
|
|
180
|
-
'BLOB SINK': [
|
|
181
|
-
{
|
|
182
|
-
flag: '--blob-sink',
|
|
183
|
-
description: 'Starts Aztec Blob Sink with options',
|
|
184
|
-
defaultValue: undefined,
|
|
185
|
-
env: undefined
|
|
186
|
-
},
|
|
187
|
-
...getOptions('blobSink', blobSinkConfigMappings)
|
|
188
|
-
],
|
|
189
207
|
'PROVER NODE': [
|
|
190
208
|
{
|
|
191
209
|
flag: '--prover-node',
|
|
@@ -195,12 +213,8 @@ export const aztecStartOptions = {
|
|
|
195
213
|
},
|
|
196
214
|
...getOptions('proverNode', omitConfigMappings(proverNodeConfigMappings, [
|
|
197
215
|
// filter out options passed separately
|
|
198
|
-
...getKeys(archiverConfigMappings),
|
|
199
216
|
...getKeys(proverBrokerConfigMappings),
|
|
200
|
-
...getKeys(proverAgentConfigMappings)
|
|
201
|
-
...getKeys(p2pConfigMappings),
|
|
202
|
-
...getKeys(worldStateConfigMappings),
|
|
203
|
-
...getKeys(sharedNodeConfigMappings)
|
|
217
|
+
...getKeys(proverAgentConfigMappings)
|
|
204
218
|
]))
|
|
205
219
|
],
|
|
206
220
|
'PROVER BROKER': [
|
|
@@ -210,8 +224,7 @@ export const aztecStartOptions = {
|
|
|
210
224
|
defaultValue: undefined,
|
|
211
225
|
env: undefined
|
|
212
226
|
},
|
|
213
|
-
...getOptions('proverBroker',
|
|
214
|
-
proverBrokerConfigMappings)
|
|
227
|
+
...getOptions('proverBroker', proverBrokerConfigMappings)
|
|
215
228
|
],
|
|
216
229
|
'PROVER AGENT': [
|
|
217
230
|
{
|
|
@@ -259,12 +272,6 @@ export const aztecStartOptions = {
|
|
|
259
272
|
...getOptions('bot', botConfigMappings)
|
|
260
273
|
],
|
|
261
274
|
PXE: [
|
|
262
|
-
{
|
|
263
|
-
flag: '--pxe',
|
|
264
|
-
description: 'Starts Aztec PXE with options',
|
|
265
|
-
defaultValue: undefined,
|
|
266
|
-
env: undefined
|
|
267
|
-
},
|
|
268
275
|
...getOptions('pxe', allPxeConfigMappings)
|
|
269
276
|
],
|
|
270
277
|
TXE: [
|
package/dest/cli/cli.d.ts
CHANGED
|
@@ -6,4 +6,4 @@ import { Command } from 'commander';
|
|
|
6
6
|
* @param debugLogger - logger for logging debug messages.
|
|
7
7
|
*/
|
|
8
8
|
export declare function injectAztecCommands(program: Command, userLog: LogFn, debugLogger: Logger): Command;
|
|
9
|
-
//# sourceMappingURL=
|
|
9
|
+
//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiY2xpLmQudHMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi8uLi9zcmMvY2xpL2NsaS50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiQUFBQSxPQUFPLEtBQUssRUFBRSxLQUFLLEVBQUUsTUFBTSxFQUFFLE1BQU0sdUJBQXVCLENBQUM7QUFFM0QsT0FBTyxFQUFFLE9BQU8sRUFBRSxNQUFNLFdBQVcsQ0FBQztBQUtwQzs7OztHQUlHO0FBQ0gsd0JBQWdCLG1CQUFtQixDQUFDLE9BQU8sRUFBRSxPQUFPLEVBQUUsT0FBTyxFQUFFLEtBQUssRUFBRSxXQUFXLEVBQUUsTUFBTSxHQUFHLE9BQU8sQ0EyQ2xHIn0=
|