@aztec/aztec 0.0.1-commit.5daedc8 → 0.0.1-commit.6201a7b05

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.
Files changed (157) hide show
  1. package/dest/bin/index.js +12 -5
  2. package/dest/cli/admin_api_key_store.d.ts +45 -0
  3. package/dest/cli/admin_api_key_store.d.ts.map +1 -0
  4. package/dest/cli/admin_api_key_store.js +98 -0
  5. package/dest/cli/aztec_start_action.d.ts +1 -1
  6. package/dest/cli/aztec_start_action.d.ts.map +1 -1
  7. package/dest/cli/aztec_start_action.js +77 -22
  8. package/dest/cli/aztec_start_options.d.ts +2 -2
  9. package/dest/cli/aztec_start_options.d.ts.map +1 -1
  10. package/dest/cli/aztec_start_options.js +52 -34
  11. package/dest/cli/cli.d.ts +1 -1
  12. package/dest/cli/cli.d.ts.map +1 -1
  13. package/dest/cli/cli.js +7 -52
  14. package/dest/cli/cmds/compile.d.ts +4 -0
  15. package/dest/cli/cmds/compile.d.ts.map +1 -0
  16. package/dest/cli/cmds/compile.js +155 -0
  17. package/dest/cli/cmds/migrate_ha_db.d.ts +3 -0
  18. package/dest/cli/cmds/migrate_ha_db.d.ts.map +1 -0
  19. package/dest/cli/cmds/migrate_ha_db.js +27 -0
  20. package/dest/cli/cmds/profile.d.ts +4 -0
  21. package/dest/cli/cmds/profile.d.ts.map +1 -0
  22. package/dest/cli/cmds/profile.js +8 -0
  23. package/dest/cli/cmds/profile_flamegraph.d.ts +4 -0
  24. package/dest/cli/cmds/profile_flamegraph.d.ts.map +1 -0
  25. package/dest/cli/cmds/profile_flamegraph.js +52 -0
  26. package/dest/cli/cmds/profile_gates.d.ts +4 -0
  27. package/dest/cli/cmds/profile_gates.d.ts.map +1 -0
  28. package/dest/cli/cmds/profile_gates.js +58 -0
  29. package/dest/cli/cmds/profile_utils.d.ts +18 -0
  30. package/dest/cli/cmds/profile_utils.d.ts.map +1 -0
  31. package/dest/cli/cmds/profile_utils.js +50 -0
  32. package/dest/cli/cmds/standby.d.ts +32 -0
  33. package/dest/cli/cmds/standby.d.ts.map +1 -0
  34. package/dest/cli/cmds/standby.js +97 -0
  35. package/dest/cli/cmds/start_archiver.d.ts +2 -2
  36. package/dest/cli/cmds/start_archiver.d.ts.map +1 -1
  37. package/dest/cli/cmds/start_archiver.js +15 -15
  38. package/dest/cli/cmds/start_bot.d.ts +3 -3
  39. package/dest/cli/cmds/start_bot.d.ts.map +1 -1
  40. package/dest/cli/cmds/start_bot.js +10 -6
  41. package/dest/cli/cmds/start_node.d.ts +3 -2
  42. package/dest/cli/cmds/start_node.d.ts.map +1 -1
  43. package/dest/cli/cmds/start_node.js +75 -33
  44. package/dest/cli/cmds/start_p2p_bootstrap.d.ts +2 -2
  45. package/dest/cli/cmds/start_p2p_bootstrap.d.ts.map +1 -1
  46. package/dest/cli/cmds/start_p2p_bootstrap.js +2 -3
  47. package/dest/cli/cmds/start_prover_agent.d.ts +1 -1
  48. package/dest/cli/cmds/start_prover_agent.d.ts.map +1 -1
  49. package/dest/cli/cmds/start_prover_agent.js +6 -18
  50. package/dest/cli/cmds/start_prover_broker.d.ts +1 -1
  51. package/dest/cli/cmds/start_prover_broker.d.ts.map +1 -1
  52. package/dest/cli/cmds/start_prover_broker.js +15 -9
  53. package/dest/cli/cmds/start_txe.d.ts +2 -2
  54. package/dest/cli/cmds/start_txe.d.ts.map +1 -1
  55. package/dest/cli/cmds/start_txe.js +4 -3
  56. package/dest/cli/cmds/utils/artifacts.d.ts +21 -0
  57. package/dest/cli/cmds/utils/artifacts.d.ts.map +1 -0
  58. package/dest/cli/cmds/utils/artifacts.js +24 -0
  59. package/dest/cli/cmds/utils/collect_crate_dirs.d.ts +21 -0
  60. package/dest/cli/cmds/utils/collect_crate_dirs.d.ts.map +1 -0
  61. package/dest/cli/cmds/utils/collect_crate_dirs.js +114 -0
  62. package/dest/cli/cmds/utils/needs_recompile.d.ts +10 -0
  63. package/dest/cli/cmds/utils/needs_recompile.d.ts.map +1 -0
  64. package/dest/cli/cmds/utils/needs_recompile.js +90 -0
  65. package/dest/cli/cmds/utils/spawn.d.ts +3 -0
  66. package/dest/cli/cmds/utils/spawn.d.ts.map +1 -0
  67. package/dest/cli/cmds/utils/spawn.js +16 -0
  68. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.d.ts +4 -0
  69. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.d.ts.map +1 -0
  70. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.js +62 -0
  71. package/dest/cli/util.d.ts +9 -20
  72. package/dest/cli/util.d.ts.map +1 -1
  73. package/dest/cli/util.js +51 -87
  74. package/dest/examples/token.js +9 -9
  75. package/dest/examples/util.d.ts +2 -2
  76. package/dest/examples/util.d.ts.map +1 -1
  77. package/dest/local-network/banana_fpc.d.ts +1 -1
  78. package/dest/local-network/banana_fpc.d.ts.map +1 -1
  79. package/dest/local-network/banana_fpc.js +4 -4
  80. package/dest/local-network/local-network.d.ts +15 -17
  81. package/dest/local-network/local-network.d.ts.map +1 -1
  82. package/dest/local-network/local-network.js +89 -46
  83. package/dest/testing/anvil_test_watcher.d.ts +16 -4
  84. package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
  85. package/dest/testing/anvil_test_watcher.js +86 -23
  86. package/dest/testing/cheat_codes.d.ts +13 -15
  87. package/dest/testing/cheat_codes.d.ts.map +1 -1
  88. package/dest/testing/cheat_codes.js +34 -32
  89. package/dest/testing/epoch_test_settler.d.ts +19 -0
  90. package/dest/testing/epoch_test_settler.d.ts.map +1 -0
  91. package/dest/testing/epoch_test_settler.js +61 -0
  92. package/dest/testing/index.d.ts +4 -2
  93. package/dest/testing/index.d.ts.map +1 -1
  94. package/dest/testing/index.js +2 -0
  95. package/dest/testing/token_allowed_setup.d.ts +7 -0
  96. package/dest/testing/token_allowed_setup.d.ts.map +1 -0
  97. package/dest/testing/token_allowed_setup.js +20 -0
  98. package/package.json +39 -36
  99. package/scripts/add_crate.sh +52 -0
  100. package/scripts/aztec.sh +73 -0
  101. package/scripts/init.sh +39 -0
  102. package/scripts/new.sh +83 -0
  103. package/scripts/setup_workspace.sh +69 -0
  104. package/scripts/templates/blank/contract/Nargo.toml +6 -0
  105. package/scripts/templates/blank/contract/src/main.nr +10 -0
  106. package/scripts/templates/blank/test/Nargo.toml +7 -0
  107. package/scripts/templates/blank/test/src/lib.nr +11 -0
  108. package/scripts/templates/counter/contract/Nargo.toml +7 -0
  109. package/scripts/templates/counter/contract/src/main.nr +48 -0
  110. package/scripts/templates/counter/test/Nargo.toml +7 -0
  111. package/scripts/templates/counter/test/src/lib.nr +32 -0
  112. package/src/bin/index.ts +13 -5
  113. package/src/cli/admin_api_key_store.ts +128 -0
  114. package/src/cli/aztec_start_action.ts +69 -17
  115. package/src/cli/aztec_start_options.ts +59 -35
  116. package/src/cli/cli.ts +11 -56
  117. package/src/cli/cmds/compile.ts +178 -0
  118. package/src/cli/cmds/migrate_ha_db.ts +43 -0
  119. package/src/cli/cmds/profile.ts +25 -0
  120. package/src/cli/cmds/profile_flamegraph.ts +64 -0
  121. package/src/cli/cmds/profile_gates.ts +68 -0
  122. package/src/cli/cmds/profile_utils.ts +58 -0
  123. package/src/cli/cmds/standby.ts +132 -0
  124. package/src/cli/cmds/start_archiver.ts +14 -19
  125. package/src/cli/cmds/start_bot.ts +9 -6
  126. package/src/cli/cmds/start_node.ts +85 -37
  127. package/src/cli/cmds/start_p2p_bootstrap.ts +3 -3
  128. package/src/cli/cmds/start_prover_agent.ts +7 -18
  129. package/src/cli/cmds/start_prover_broker.ts +20 -16
  130. package/src/cli/cmds/start_txe.ts +5 -3
  131. package/src/cli/cmds/utils/artifacts.ts +44 -0
  132. package/src/cli/cmds/utils/collect_crate_dirs.ts +118 -0
  133. package/src/cli/cmds/utils/needs_recompile.ts +98 -0
  134. package/src/cli/cmds/utils/spawn.ts +16 -0
  135. package/src/cli/cmds/utils/warn_if_aztec_version_mismatch.ts +77 -0
  136. package/src/cli/util.ts +60 -98
  137. package/src/examples/token.ts +10 -10
  138. package/src/examples/util.ts +1 -1
  139. package/src/local-network/banana_fpc.ts +12 -8
  140. package/src/local-network/local-network.ts +123 -88
  141. package/src/testing/anvil_test_watcher.ts +97 -22
  142. package/src/testing/cheat_codes.ts +42 -35
  143. package/src/testing/epoch_test_settler.ts +70 -0
  144. package/src/testing/index.ts +3 -1
  145. package/src/testing/token_allowed_setup.ts +19 -0
  146. package/dest/cli/cmds/start_blob_sink.d.ts +0 -3
  147. package/dest/cli/cmds/start_blob_sink.d.ts.map +0 -1
  148. package/dest/cli/cmds/start_blob_sink.js +0 -33
  149. package/dest/cli/cmds/start_prover_node.d.ts +0 -7
  150. package/dest/cli/cmds/start_prover_node.d.ts.map +0 -1
  151. package/dest/cli/cmds/start_prover_node.js +0 -108
  152. package/dest/cli/release_version.d.ts +0 -2
  153. package/dest/cli/release_version.d.ts.map +0 -1
  154. package/dest/cli/release_version.js +0 -14
  155. package/src/cli/cmds/start_blob_sink.ts +0 -57
  156. package/src/cli/cmds/start_prover_node.ts +0 -124
  157. package/src/cli/release_version.ts +0 -21
package/scripts/new.sh ADDED
@@ -0,0 +1,83 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+
4
+ script_path=$(realpath $(dirname "$0"))
5
+
6
+ project_path=""
7
+
8
+ while [[ $# -gt 0 ]]; do
9
+ case $1 in
10
+ --help|-h)
11
+ cat << 'EOF'
12
+ Aztec New - Create a new Aztec Noir project or add a contract to an existing workspace
13
+
14
+ Usage: aztec new <NAME>
15
+
16
+ Arguments:
17
+ <NAME> The name for the new contract (also used as the directory name when
18
+ creating a new workspace)
19
+
20
+ Options:
21
+ -h, --help Print help
22
+
23
+ When run outside an existing workspace:
24
+ Creates a new directory with a workspace containing a contract crate and a
25
+ test crate, and automatically adds the Aztec.nr dependency to both.
26
+
27
+ When run inside an existing workspace (Nargo.toml with [workspace] exists):
28
+ Adds a new contract crate and test crate to the existing workspace.
29
+ EOF
30
+ exit 0
31
+ ;;
32
+ -*)
33
+ echo "Error: unknown option '$1'"
34
+ echo "Usage: aztec new <NAME>"
35
+ echo "Run 'aztec new --help' for more information"
36
+ exit 1
37
+ ;;
38
+ *)
39
+ if [ -n "$project_path" ]; then
40
+ echo "Error: unexpected argument '$1'"
41
+ echo "Usage: aztec new <NAME>"
42
+ echo "Run 'aztec new --help' for more information"
43
+ exit 1
44
+ fi
45
+ project_path=$1
46
+ shift
47
+ ;;
48
+ esac
49
+ done
50
+
51
+ if [ -z "$project_path" ]; then
52
+ echo "Error: NAME argument is required"
53
+ echo "Usage: aztec new <NAME>"
54
+ echo "Run 'aztec new --help' for more information"
55
+ exit 1
56
+ fi
57
+
58
+ package_name="$(basename $project_path)"
59
+
60
+ # Validate that the name contains only valid Noir identifier characters
61
+ if ! [[ "$package_name" =~ ^[a-zA-Z][a-zA-Z0-9_]*$ ]]; then
62
+ echo "Error: '$package_name' is not a valid contract name"
63
+ echo "Name must start with a letter and contain only letters, digits, and underscores"
64
+ exit 1
65
+ fi
66
+
67
+ # Check if we're inside an existing workspace
68
+ if [ -f "Nargo.toml" ] && grep -q '\[workspace\]' Nargo.toml; then
69
+ # Add crate pair to existing workspace
70
+ echo "Adding contract '$package_name' to existing workspace..."
71
+ $script_path/add_crate.sh "$package_name" blank
72
+ else
73
+ # Create new workspace
74
+ if [ -d "$project_path" ] && [ "$(ls -A $project_path 2>/dev/null)" ]; then
75
+ echo "Error: $project_path already exists and is not empty"
76
+ exit 1
77
+ fi
78
+
79
+ echo "Creating new Aztec contract project at $project_path..."
80
+ mkdir -p "$project_path"
81
+ cd "$project_path"
82
+ $script_path/setup_workspace.sh "$package_name" blank
83
+ fi
@@ -0,0 +1,69 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+
4
+ # Creates an Aztec contract workspace with a contract crate and a test crate.
5
+ # Usage: setup_workspace.sh <package_name> <template>
6
+ # Must be called from the workspace root directory.
7
+
8
+ package_name=$1
9
+ template=$2
10
+ script_path=$(realpath $(dirname "$0"))
11
+
12
+ if [ -z "$package_name" ]; then
13
+ echo "Error: package name is required"
14
+ exit 1
15
+ fi
16
+
17
+ if [ -f "Nargo.toml" ]; then
18
+ echo "Error: Nargo.toml already exists in the current directory."
19
+ echo "To add another contract crate to this workspace, use 'aztec new <name>' instead."
20
+ exit 1
21
+ fi
22
+
23
+ # Create workspace root Nargo.toml with empty members (add_crate.sh will populate)
24
+ cat > Nargo.toml << 'EOF'
25
+ [workspace]
26
+ members = []
27
+ EOF
28
+
29
+ # Create the first crate pair
30
+ $script_path/add_crate.sh "$package_name" "$template"
31
+
32
+ # Create README
33
+ cat > README.md << REOF
34
+ # ${package_name}
35
+
36
+ An Aztec Noir contract project.
37
+
38
+ ## Compile
39
+
40
+ \`\`\`bash
41
+ aztec compile
42
+ \`\`\`
43
+
44
+ This compiles all contract crates and outputs artifacts to \`target/\`.
45
+
46
+ ## Test
47
+
48
+ \`\`\`bash
49
+ aztec test
50
+ \`\`\`
51
+
52
+ This runs all tests in the workspace.
53
+
54
+ ## Generate TypeScript bindings
55
+
56
+ \`\`\`bash
57
+ aztec codegen target -o src/artifacts
58
+ \`\`\`
59
+
60
+ This generates TypeScript contract artifacts from the compiled output in \`target/\` into \`src/artifacts/\`.
61
+ REOF
62
+
63
+ # Create .gitignore
64
+ cat > .gitignore << 'GEOF'
65
+ target/
66
+ codegenCache.json
67
+ GEOF
68
+
69
+ echo "Created Aztec contract workspace with crates '${package_name}_contract' and '${package_name}_test'"
@@ -0,0 +1,6 @@
1
+ [package]
2
+ name = "__CRATE_NAME___contract"
3
+ type = "contract"
4
+
5
+ [dependencies]
6
+ aztec = { git="https://github.com/AztecProtocol/aztec-nr", tag="v__AZTEC_VERSION__", directory="aztec" }
@@ -0,0 +1,10 @@
1
+ use aztec::macros::aztec;
2
+
3
+ #[aztec]
4
+ pub contract Main {
5
+ use aztec::macros::functions::{external, initializer};
6
+
7
+ #[initializer]
8
+ #[external("private")]
9
+ fn constructor() {}
10
+ }
@@ -0,0 +1,7 @@
1
+ [package]
2
+ name = "__CRATE_NAME___test"
3
+ type = "lib"
4
+
5
+ [dependencies]
6
+ aztec = { git="https://github.com/AztecProtocol/aztec-nr", tag="v__AZTEC_VERSION__", directory="aztec" }
7
+ __CRATE_NAME___contract = { path = "../__CRATE_NAME___contract" }
@@ -0,0 +1,11 @@
1
+ use aztec::test::helpers::test_environment::TestEnvironment;
2
+ use __CRATE_NAME___contract::Main;
3
+
4
+ #[test]
5
+ unconstrained fn test_constructor() {
6
+ let mut env = TestEnvironment::new();
7
+ let deployer = env.create_light_account();
8
+
9
+ let _contract_address = env.deploy("@__CRATE_NAME___contract/Main")
10
+ .with_private_initializer(deployer, Main::interface().constructor());
11
+ }
@@ -0,0 +1,7 @@
1
+ [package]
2
+ name = "__CRATE_NAME___contract"
3
+ type = "contract"
4
+
5
+ [dependencies]
6
+ aztec = { git="https://github.com/AztecProtocol/aztec-nr", tag="v__AZTEC_VERSION__", directory="aztec" }
7
+ balance_set = { git="https://github.com/AztecProtocol/aztec-nr", tag="v__AZTEC_VERSION__", directory="balance-set" }
@@ -0,0 +1,48 @@
1
+ use aztec::macros::aztec;
2
+
3
+ #[aztec]
4
+ pub contract Counter {
5
+ use aztec::{
6
+ macros::{functions::{external, initializer}, storage::storage},
7
+ messages::message_delivery::MessageDelivery,
8
+ protocol::address::AztecAddress,
9
+ state_vars::Owned,
10
+ };
11
+ use balance_set::BalanceSet;
12
+
13
+ #[storage]
14
+ struct Storage<Context> {
15
+ // Each owner has their own counter, stored as private encrypted notes.
16
+ // Owned: dictates who will receive the encrypted notes.
17
+ // BalanceSet: manages the underlying notes, providing add/sub/balance_of.
18
+ counters: Owned<BalanceSet<Context>, Context>,
19
+ }
20
+
21
+ // Sets the owner's counter to an initial value.
22
+ //
23
+ // #[external("private")]: executes on the user's device, inputs are hidden from everyone.
24
+ #[initializer]
25
+ #[external("private")]
26
+ fn constructor(initial_value: u128, owner: AztecAddress) {
27
+ // Delivers the note to the recipient onchain with provable correctness.
28
+ // Without delivery, the recipient can't find or decrypt the note.
29
+ self.storage.counters.at(owner).add(initial_value).deliver(
30
+ MessageDelivery.ONCHAIN_CONSTRAINED,
31
+ );
32
+ }
33
+
34
+ // Adds 1 to the owner's counter.
35
+ #[external("private")]
36
+ fn increment(owner: AztecAddress) {
37
+ self.storage.counters.at(owner).add(1).deliver(MessageDelivery.ONCHAIN_CONSTRAINED);
38
+ }
39
+
40
+ // Returns the current value of the owner's counter.
41
+ //
42
+ // #[external("utility")]: runs off-chain, no transaction created, no cost.
43
+ // Only the owner can decrypt and read their own counter.
44
+ #[external("utility")]
45
+ unconstrained fn get_counter(owner: AztecAddress) -> u128 {
46
+ self.storage.counters.at(owner).balance_of()
47
+ }
48
+ }
@@ -0,0 +1,7 @@
1
+ [package]
2
+ name = "__CRATE_NAME___test"
3
+ type = "lib"
4
+
5
+ [dependencies]
6
+ aztec = { git="https://github.com/AztecProtocol/aztec-nr", tag="v__AZTEC_VERSION__", directory="aztec" }
7
+ __CRATE_NAME___contract = { path = "../__CRATE_NAME___contract" }
@@ -0,0 +1,32 @@
1
+ use aztec::{protocol::address::AztecAddress, test::helpers::test_environment::TestEnvironment};
2
+ use __CRATE_NAME___contract::Counter;
3
+
4
+ unconstrained fn setup(initial_value: u128) -> (TestEnvironment, AztecAddress, AztecAddress) {
5
+ let mut env = TestEnvironment::new();
6
+ let owner = env.create_light_account();
7
+
8
+ let contract_address = env.deploy("@__CRATE_NAME___contract/Counter")
9
+ .with_private_initializer(owner, Counter::interface().constructor(initial_value, owner));
10
+
11
+ (env, contract_address, owner)
12
+ }
13
+
14
+ #[test]
15
+ unconstrained fn test_constructor() {
16
+ let initial_value = 5;
17
+ let (env, contract_address, owner) = setup(initial_value);
18
+
19
+ let counter = env.execute_utility(Counter::at(contract_address).get_counter(owner));
20
+ assert_eq(counter, initial_value);
21
+ }
22
+
23
+ #[test]
24
+ unconstrained fn test_increment() {
25
+ let initial_value = 5;
26
+ let (mut env, contract_address, owner) = setup(initial_value);
27
+
28
+ env.call_private(owner, Counter::at(contract_address).increment(owner));
29
+
30
+ let counter = env.execute_utility(Counter::at(contract_address).get_counter(owner));
31
+ assert_eq(counter, initial_value + 1);
32
+ }
package/src/bin/index.ts 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 { enrichEnvironmentWithChainName, enrichEnvironmentWithNetworkConfig } from '@aztec/cli/config';
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,12 +11,16 @@ 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
 
14
16
  import { Command } from 'commander';
15
17
 
16
- import { NETWORK_FLAG } from '../cli/aztec_start_options.js';
18
+ import { injectCompileCommand } from '../cli/cmds/compile.js';
19
+ import { injectMigrateCommand } from '../cli/cmds/migrate_ha_db.js';
20
+ import { injectProfileCommand } from '../cli/cmds/profile.js';
17
21
  import { injectAztecCommands } from '../cli/index.js';
18
- import { getCliVersion } from '../cli/release_version.js';
22
+
23
+ const NETWORK_FLAG = 'network';
19
24
 
20
25
  const userLog = createConsoleLogger();
21
26
  const debugLogger = createLogger('cli');
@@ -42,9 +47,9 @@ async function main() {
42
47
  await enrichEnvironmentWithNetworkConfig(networkName);
43
48
  enrichEnvironmentWithChainName(networkName);
44
49
 
45
- const cliVersion = getCliVersion();
50
+ const cliVersion = getPackageVersion() ?? 'unknown';
46
51
  let program = new Command('aztec');
47
- program.description('Aztec command line interface').version(cliVersion);
52
+ program.description('Aztec command line interface').version(cliVersion).enablePositionalOptions();
48
53
  program = injectAztecCommands(program, userLog, debugLogger);
49
54
  program = injectBuilderCommands(program);
50
55
  program = injectContractCommands(program, userLog, debugLogger);
@@ -53,6 +58,9 @@ async function main() {
53
58
  program = injectAztecNodeCommands(program, userLog, debugLogger);
54
59
  program = injectMiscCommands(program, userLog);
55
60
  program = injectValidatorKeysCommands(program, userLog);
61
+ program = injectCompileCommand(program, userLog);
62
+ program = injectProfileCommand(program, userLog);
63
+ program = injectMigrateCommand(program, userLog);
56
64
 
57
65
  await program.parseAsync(process.argv);
58
66
  }
@@ -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
+ disableAdminApiKey?: 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 (`disableAdminApiKey`), 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.disableAdminApiKey) {
62
+ log.warn('Admin API key authentication is DISABLED (--disable-admin-api-key / AZTEC_DISABLE_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,17 +1,20 @@
1
+ import { getActiveNetworkName } from '@aztec/foundation/config';
1
2
  import {
2
3
  type NamespacedApiHandlers,
3
4
  createNamespacedSafeJsonRpcServer,
5
+ getApiKeyAuthMiddleware,
4
6
  startHttpRpcServer,
5
7
  } from '@aztec/foundation/json-rpc/server';
6
8
  import type { LogFn, Logger } from '@aztec/foundation/log';
7
9
  import type { ChainConfig } from '@aztec/stdlib/config';
8
- import { AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
10
+ import { AztecNodeAdminApiSchema, AztecNodeApiSchema, AztecNodeDebugApiSchema } from '@aztec/stdlib/interfaces/client';
11
+ import { getPackageVersion } from '@aztec/stdlib/update-checker';
9
12
  import { getVersioningMiddleware } from '@aztec/stdlib/versioning';
10
13
  import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
11
14
 
12
15
  import { createLocalNetwork } from '../local-network/index.js';
13
16
  import { github, splash } from '../splash.js';
14
- import { getCliVersion } from './release_version.js';
17
+ import { resolveAdminApiKey } from './admin_api_key_store.js';
15
18
  import { extractNamespacedOptions, installSignalHandlers } from './util.js';
16
19
  import { getVersions } from './versioning.js';
17
20
 
@@ -20,22 +23,25 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
20
23
  const signalHandlers: Array<() => Promise<void>> = [];
21
24
  const services: NamespacedApiHandlers = {};
22
25
  const adminServices: NamespacedApiHandlers = {};
26
+ const packageVersion = getPackageVersion();
23
27
  let config: ChainConfig | undefined = undefined;
24
28
 
25
29
  if (options.localNetwork) {
26
- const cliVersion = getCliVersion();
27
- const localNetwork = extractNamespacedOptions(options, 'local-network');
28
- localNetwork.testAccounts = true;
30
+ const localNetwork = extractNamespacedOptions(options, 'localNetwork');
29
31
  userLog(`${splash}\n${github}\n\n`);
30
- userLog(`Setting up Aztec local network ${cliVersion}, please stand by...`);
32
+ userLog(`Setting up Aztec local network ${packageVersion ?? 'unknown'}, please stand by...`);
31
33
 
32
34
  const { node, stop } = await createLocalNetwork(
33
35
  {
34
36
  l1Mnemonic: localNetwork.l1Mnemonic,
35
37
  l1RpcUrls: options.l1RpcUrls,
36
- deployAztecContractsSalt: localNetwork.deployAztecContractsSalt,
37
38
  testAccounts: localNetwork.testAccounts,
38
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,
39
45
  },
40
46
  userLog,
41
47
  );
@@ -43,19 +49,24 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
43
49
  // Start Node and PXE JSON-RPC server
44
50
  signalHandlers.push(stop);
45
51
  services.node = [node, AztecNodeApiSchema];
52
+ adminServices.node = [node, AztecNodeAdminApiSchema];
53
+ services.nodeDebug = [node, AztecNodeDebugApiSchema];
46
54
  } else {
55
+ // Route --prover-node through startNode
56
+ if (options.proverNode && !options.node) {
57
+ options.node = true;
58
+ }
59
+
47
60
  if (options.node) {
48
61
  const { startNode } = await import('./cmds/start_node.js');
49
- ({ config } = await startNode(options, signalHandlers, services, adminServices, userLog));
62
+ const networkName = getActiveNetworkName(options.network);
63
+ ({ config } = await startNode(options, signalHandlers, services, adminServices, userLog, networkName));
64
+ if (options.nodeDebug && services.node) {
65
+ services.nodeDebug = [services.node[0], AztecNodeDebugApiSchema];
66
+ }
50
67
  } else if (options.bot) {
51
68
  const { startBot } = await import('./cmds/start_bot.js');
52
69
  await startBot(options, signalHandlers, services, userLog);
53
- } else if (options.proverNode) {
54
- const { startProverNode } = await import('./cmds/start_prover_node.js');
55
- ({ config } = await startProverNode(options, signalHandlers, services, userLog));
56
- } else if (options.blobSink) {
57
- const { startBlobSink } = await import('./cmds/start_blob_sink.js');
58
- await startBlobSink(options, signalHandlers, userLog);
59
70
  } else if (options.archiver) {
60
71
  const { startArchiver } = await import('./cmds/start_archiver.js');
61
72
  ({ config } = await startArchiver(options, signalHandlers, services));
@@ -70,7 +81,7 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
70
81
  await startProverBroker(options, signalHandlers, services, userLog);
71
82
  } else if (options.txe) {
72
83
  const { startTXE } = await import('./cmds/start_txe.js');
73
- await startTXE(options, debugLogger);
84
+ await startTXE(options, signalHandlers, debugLogger);
74
85
  } else if (options.sequencer) {
75
86
  userLog(`Cannot run a standalone sequencer without a node`);
76
87
  process.exit(1);
@@ -82,13 +93,14 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
82
93
 
83
94
  installSignalHandlers(debugLogger.info, signalHandlers);
84
95
  const versions = getVersions(config);
96
+ const versioningOpts = { packageVersion };
85
97
 
86
98
  // Start the main JSON-RPC server
87
99
  if (Object.entries(services).length > 0) {
88
100
  const rpcServer = createNamespacedSafeJsonRpcServer(services, {
89
101
  http200OnError: false,
90
102
  log: debugLogger,
91
- middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)],
103
+ middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions, versioningOpts)],
92
104
  maxBatchSize: options.rpcMaxBatchSize,
93
105
  maxBodySizeBytes: options.rpcMaxBodySize,
94
106
  });
@@ -98,14 +110,54 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
98
110
 
99
111
  // If there are any admin services, start a separate JSON-RPC server for them
100
112
  if (Object.entries(adminServices).length > 0) {
113
+ const adminMiddlewares = [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions, versioningOpts)];
114
+
115
+ // Resolve the admin API key (auto-generated and persisted, or opt-out)
116
+ const apiKeyResolution = await resolveAdminApiKey(
117
+ {
118
+ adminApiKeyHash: options.adminApiKeyHash,
119
+ disableAdminApiKey: options.disableAdminApiKey,
120
+ resetAdminApiKey: options.resetAdminApiKey,
121
+ dataDirectory: options.dataDirectory,
122
+ },
123
+ debugLogger,
124
+ );
125
+ if (apiKeyResolution) {
126
+ adminMiddlewares.unshift(getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash));
127
+ } else {
128
+ debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
129
+ }
130
+
101
131
  const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
102
132
  http200OnError: false,
103
133
  log: debugLogger,
104
- middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)],
134
+ middlewares: adminMiddlewares,
105
135
  maxBatchSize: options.rpcMaxBatchSize,
106
136
  maxBodySizeBytes: options.rpcMaxBodySize,
107
137
  });
108
138
  const { port } = await startHttpRpcServer(rpcServer, { port: options.adminPort });
109
139
  debugLogger.info(`Aztec Server admin API listening on port ${port}`, versions);
140
+
141
+ // Display the API key after the server has started
142
+ // Uses userLog which is never filtered by LOG_LEVEL.
143
+ if (apiKeyResolution?.rawKey) {
144
+ const separator = '='.repeat(70);
145
+ userLog('');
146
+ userLog(separator);
147
+ userLog(' ADMIN API KEY (save this — it will NOT be shown again)');
148
+ userLog('');
149
+ userLog(` ${apiKeyResolution.rawKey}`);
150
+ userLog('');
151
+ userLog(` Use via header: x-api-key: <key>`);
152
+ userLog(` Or via header: Authorization: Bearer <key>`);
153
+ if (options.dataDirectory) {
154
+ userLog('');
155
+ userLog(' The key hash has been persisted — on next restart, the same key will be used.');
156
+ }
157
+ userLog('');
158
+ userLog(' To disable admin auth: --disable-admin-api-key or AZTEC_DISABLE_ADMIN_API_KEY=true');
159
+ userLog(separator);
160
+ userLog('');
161
+ }
110
162
  }
111
163
  }