@aztec/aztec 0.0.1-commit.fce3e4f → 0.0.1-commit.ffe5b04ea
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dest/bin/index.js +12 -5
- 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 +55 -16
- package/dest/cli/aztec_start_options.d.ts +1 -1
- package/dest/cli/aztec_start_options.d.ts.map +1 -1
- package/dest/cli/aztec_start_options.js +41 -36
- package/dest/cli/cli.d.ts +1 -1
- package/dest/cli/cli.d.ts.map +1 -1
- package/dest/cli/cli.js +4 -37
- 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 +160 -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 +51 -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 +57 -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 +27 -0
- package/dest/cli/cmds/standby.d.ts.map +1 -0
- package/dest/cli/cmds/standby.js +78 -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 +12 -14
- 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 +10 -6
- 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 +79 -29
- package/dest/cli/cmds/start_p2p_bootstrap.d.ts +2 -2
- package/dest/cli/cmds/start_p2p_bootstrap.d.ts.map +1 -1
- package/dest/cli/cmds/start_p2p_bootstrap.js +2 -3
- package/dest/cli/cmds/start_prover_agent.d.ts +1 -1
- package/dest/cli/cmds/start_prover_agent.d.ts.map +1 -1
- package/dest/cli/cmds/start_prover_agent.js +4 -4
- package/dest/cli/cmds/start_prover_broker.d.ts +1 -1
- package/dest/cli/cmds/start_prover_broker.d.ts.map +1 -1
- package/dest/cli/cmds/start_prover_broker.js +9 -9
- 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/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/util.d.ts +9 -20
- package/dest/cli/util.d.ts.map +1 -1
- package/dest/cli/util.js +51 -87
- package/dest/examples/token.js +9 -9
- package/dest/examples/util.d.ts +2 -2
- package/dest/examples/util.d.ts.map +1 -1
- package/dest/local-network/banana_fpc.d.ts +1 -1
- package/dest/local-network/banana_fpc.d.ts.map +1 -1
- package/dest/local-network/banana_fpc.js +4 -4
- package/dest/local-network/local-network.d.ts +13 -14
- package/dest/local-network/local-network.d.ts.map +1 -1
- package/dest/local-network/local-network.js +86 -43
- package/dest/testing/anvil_test_watcher.d.ts +10 -2
- package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
- package/dest/testing/anvil_test_watcher.js +53 -16
- package/dest/testing/cheat_codes.d.ts +3 -1
- package/dest/testing/cheat_codes.d.ts.map +1 -1
- package/dest/testing/epoch_test_settler.d.ts +19 -0
- package/dest/testing/epoch_test_settler.d.ts.map +1 -0
- package/dest/testing/epoch_test_settler.js +62 -0
- package/dest/testing/index.d.ts +3 -1
- package/dest/testing/index.d.ts.map +1 -1
- package/dest/testing/index.js +2 -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 +37 -35
- package/scripts/add_crate.sh +102 -0
- package/scripts/aztec.sh +19 -9
- package/scripts/init.sh +23 -19
- package/scripts/new.sh +48 -24
- package/scripts/setup_workspace.sh +68 -0
- package/src/bin/index.ts +13 -5
- package/src/cli/admin_api_key_store.ts +128 -0
- package/src/cli/aztec_start_action.ts +58 -11
- package/src/cli/aztec_start_options.ts +42 -35
- package/src/cli/cli.ts +4 -37
- package/src/cli/cmds/compile.ts +184 -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 +63 -0
- package/src/cli/cmds/profile_gates.ts +67 -0
- package/src/cli/cmds/profile_utils.ts +58 -0
- package/src/cli/cmds/standby.ts +111 -0
- package/src/cli/cmds/start_archiver.ts +8 -19
- package/src/cli/cmds/start_bot.ts +9 -6
- package/src/cli/cmds/start_node.ts +78 -35
- package/src/cli/cmds/start_p2p_bootstrap.ts +3 -3
- package/src/cli/cmds/start_prover_agent.ts +4 -12
- package/src/cli/cmds/start_prover_broker.ts +13 -16
- package/src/cli/cmds/utils/artifacts.ts +44 -0
- package/src/cli/cmds/utils/spawn.ts +16 -0
- package/src/cli/util.ts +60 -98
- package/src/examples/token.ts +10 -10
- package/src/examples/util.ts +1 -1
- package/src/local-network/banana_fpc.ts +12 -8
- package/src/local-network/local-network.ts +120 -85
- package/src/testing/anvil_test_watcher.ts +61 -17
- package/src/testing/cheat_codes.ts +3 -2
- package/src/testing/epoch_test_settler.ts +71 -0
- package/src/testing/index.ts +2 -0
- package/src/testing/token_allowed_setup.ts +19 -0
- 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/scripts/compile.sh +0 -44
- package/scripts/extract_function.js +0 -47
- package/scripts/flamegraph.sh +0 -59
- package/scripts/setup_project.sh +0 -31
- 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/scripts/init.sh
CHANGED
|
@@ -1,35 +1,39 @@
|
|
|
1
1
|
#!/usr/bin/env bash
|
|
2
2
|
set -euo pipefail
|
|
3
3
|
|
|
4
|
-
NARGO=${NARGO:-nargo}
|
|
5
4
|
script_path=$(realpath $(dirname "$0"))
|
|
6
5
|
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
6
|
+
# Parse arguments
|
|
7
|
+
while [[ $# -gt 0 ]]; do
|
|
8
|
+
case $1 in
|
|
9
|
+
--help|-h)
|
|
10
|
+
cat << 'EOF'
|
|
10
11
|
Aztec Init - Create a new Aztec Noir project in the current directory
|
|
11
12
|
|
|
12
|
-
Usage: aztec init
|
|
13
|
+
Usage: aztec init
|
|
13
14
|
|
|
14
15
|
Options:
|
|
15
|
-
--name <NAME> Name of the package [default: current directory name]
|
|
16
|
-
--lib Use a library template
|
|
17
16
|
-h, --help Print help
|
|
18
17
|
|
|
19
|
-
This command creates a new Aztec Noir project in the current directory
|
|
20
|
-
|
|
18
|
+
This command creates a new Aztec Noir project in the current directory with
|
|
19
|
+
a workspace containing a contract crate and a test crate, and automatically
|
|
20
|
+
adds the Aztec.nr dependency to both.
|
|
21
21
|
|
|
22
|
+
If a workspace already exists in the current directory, use
|
|
23
|
+
'aztec new <name>' instead to add another contract.
|
|
22
24
|
EOF
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
25
|
+
exit 0
|
|
26
|
+
;;
|
|
27
|
+
*)
|
|
28
|
+
echo "Error: unexpected argument '$1'"
|
|
29
|
+
echo "Usage: aztec init"
|
|
30
|
+
echo "Run 'aztec init --help' for more information"
|
|
31
|
+
exit 1
|
|
32
|
+
;;
|
|
33
|
+
esac
|
|
28
34
|
done
|
|
29
35
|
|
|
30
|
-
|
|
31
|
-
$NARGO init "$@"
|
|
36
|
+
package_name="$(basename $(pwd))"
|
|
32
37
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
fi
|
|
38
|
+
echo "Initializing Aztec contract project..."
|
|
39
|
+
$script_path/setup_workspace.sh "$package_name"
|
package/scripts/new.sh
CHANGED
|
@@ -1,59 +1,83 @@
|
|
|
1
1
|
#!/usr/bin/env bash
|
|
2
2
|
set -euo pipefail
|
|
3
3
|
|
|
4
|
-
NARGO=${NARGO:-nargo}
|
|
5
4
|
script_path=$(realpath $(dirname "$0"))
|
|
6
5
|
|
|
7
|
-
|
|
6
|
+
project_path=""
|
|
8
7
|
|
|
9
8
|
while [[ $# -gt 0 ]]; do
|
|
10
9
|
case $1 in
|
|
11
10
|
--help|-h)
|
|
12
11
|
cat << 'EOF'
|
|
13
|
-
Aztec New - Create a new Aztec Noir project
|
|
12
|
+
Aztec New - Create a new Aztec Noir project or add a contract to an existing workspace
|
|
14
13
|
|
|
15
|
-
Usage: aztec new
|
|
14
|
+
Usage: aztec new <NAME>
|
|
16
15
|
|
|
17
16
|
Arguments:
|
|
18
|
-
<
|
|
17
|
+
<NAME> The name for the new contract (also used as the directory name when
|
|
18
|
+
creating a new workspace)
|
|
19
19
|
|
|
20
20
|
Options:
|
|
21
|
-
--name <NAME> Name of the package [default: package directory name]
|
|
22
|
-
--lib Create a library template instead of a contract
|
|
23
21
|
-h, --help Print help
|
|
24
22
|
|
|
25
|
-
|
|
26
|
-
|
|
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.
|
|
27
29
|
EOF
|
|
28
30
|
exit 0
|
|
29
31
|
;;
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
name_arg="--name $2"
|
|
36
|
-
shift 2
|
|
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
37
|
;;
|
|
38
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
|
|
39
45
|
project_path=$1
|
|
40
46
|
shift
|
|
41
|
-
break
|
|
42
47
|
;;
|
|
43
48
|
esac
|
|
44
49
|
done
|
|
45
50
|
|
|
46
51
|
if [ -z "$project_path" ]; then
|
|
47
|
-
echo "Error:
|
|
48
|
-
echo "Usage: aztec new
|
|
52
|
+
echo "Error: NAME argument is required"
|
|
53
|
+
echo "Usage: aztec new <NAME>"
|
|
49
54
|
echo "Run 'aztec new --help' for more information"
|
|
50
55
|
exit 1
|
|
51
56
|
fi
|
|
52
57
|
|
|
53
|
-
|
|
54
|
-
|
|
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"
|
|
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
|
|
55
78
|
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
$
|
|
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"
|
|
59
83
|
fi
|
|
@@ -0,0 +1,68 @@
|
|
|
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>
|
|
6
|
+
# Must be called from the workspace root directory.
|
|
7
|
+
|
|
8
|
+
package_name=$1
|
|
9
|
+
script_path=$(realpath $(dirname "$0"))
|
|
10
|
+
|
|
11
|
+
if [ -z "$package_name" ]; then
|
|
12
|
+
echo "Error: package name is required"
|
|
13
|
+
exit 1
|
|
14
|
+
fi
|
|
15
|
+
|
|
16
|
+
if [ -f "Nargo.toml" ]; then
|
|
17
|
+
echo "Error: Nargo.toml already exists in the current directory."
|
|
18
|
+
echo "To add another contract crate to this workspace, use 'aztec new <name>' instead."
|
|
19
|
+
exit 1
|
|
20
|
+
fi
|
|
21
|
+
|
|
22
|
+
# Create workspace root Nargo.toml with empty members (add_crate.sh will populate)
|
|
23
|
+
cat > Nargo.toml << 'EOF'
|
|
24
|
+
[workspace]
|
|
25
|
+
members = []
|
|
26
|
+
EOF
|
|
27
|
+
|
|
28
|
+
# Create the first crate pair
|
|
29
|
+
$script_path/add_crate.sh "$package_name"
|
|
30
|
+
|
|
31
|
+
# Create README
|
|
32
|
+
cat > README.md << REOF
|
|
33
|
+
# ${package_name}
|
|
34
|
+
|
|
35
|
+
An Aztec Noir contract project.
|
|
36
|
+
|
|
37
|
+
## Compile
|
|
38
|
+
|
|
39
|
+
\`\`\`bash
|
|
40
|
+
aztec compile
|
|
41
|
+
\`\`\`
|
|
42
|
+
|
|
43
|
+
This compiles all contract crates and outputs artifacts to \`target/\`.
|
|
44
|
+
|
|
45
|
+
## Test
|
|
46
|
+
|
|
47
|
+
\`\`\`bash
|
|
48
|
+
aztec test
|
|
49
|
+
\`\`\`
|
|
50
|
+
|
|
51
|
+
This runs all tests in the workspace.
|
|
52
|
+
|
|
53
|
+
## Generate TypeScript bindings
|
|
54
|
+
|
|
55
|
+
\`\`\`bash
|
|
56
|
+
aztec codegen target -o src/artifacts
|
|
57
|
+
\`\`\`
|
|
58
|
+
|
|
59
|
+
This generates TypeScript contract artifacts from the compiled output in \`target/\` into \`src/artifacts/\`.
|
|
60
|
+
REOF
|
|
61
|
+
|
|
62
|
+
# Create .gitignore
|
|
63
|
+
cat > .gitignore << 'GEOF'
|
|
64
|
+
target/
|
|
65
|
+
codegenCache.json
|
|
66
|
+
GEOF
|
|
67
|
+
|
|
68
|
+
echo "Created Aztec contract workspace with crates '${package_name}_contract' and '${package_name}_test'"
|
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
|
|
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 {
|
|
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
|
-
|
|
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 =
|
|
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
10
|
import { AztecNodeApiSchema } 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 {
|
|
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
|
|
|
@@ -23,7 +26,7 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
23
26
|
let config: ChainConfig | undefined = undefined;
|
|
24
27
|
|
|
25
28
|
if (options.localNetwork) {
|
|
26
|
-
const cliVersion =
|
|
29
|
+
const cliVersion = getPackageVersion() ?? 'unknown';
|
|
27
30
|
const localNetwork = extractNamespacedOptions(options, 'local-network');
|
|
28
31
|
localNetwork.testAccounts = true;
|
|
29
32
|
userLog(`${splash}\n${github}\n\n`);
|
|
@@ -33,9 +36,13 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
33
36
|
{
|
|
34
37
|
l1Mnemonic: localNetwork.l1Mnemonic,
|
|
35
38
|
l1RpcUrls: options.l1RpcUrls,
|
|
36
|
-
deployAztecContractsSalt: localNetwork.deployAztecContractsSalt,
|
|
37
39
|
testAccounts: localNetwork.testAccounts,
|
|
38
40
|
realProofs: false,
|
|
41
|
+
// Setting the epoch duration to 2 by default for local network. This allows the epoch to be "proven" faster, so
|
|
42
|
+
// the users can consume out hash without having to wait for a long time.
|
|
43
|
+
// Note: We are not proving anything in the local network (realProofs == false). But in `createLocalNetwork`,
|
|
44
|
+
// the EpochTestSettler will set the out hash to the outbox when an epoch is complete.
|
|
45
|
+
aztecEpochDuration: 2,
|
|
39
46
|
},
|
|
40
47
|
userLog,
|
|
41
48
|
);
|
|
@@ -44,18 +51,18 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
44
51
|
signalHandlers.push(stop);
|
|
45
52
|
services.node = [node, AztecNodeApiSchema];
|
|
46
53
|
} else {
|
|
54
|
+
// Route --prover-node through startNode
|
|
55
|
+
if (options.proverNode && !options.node) {
|
|
56
|
+
options.node = true;
|
|
57
|
+
}
|
|
58
|
+
|
|
47
59
|
if (options.node) {
|
|
48
60
|
const { startNode } = await import('./cmds/start_node.js');
|
|
49
|
-
|
|
61
|
+
const networkName = getActiveNetworkName(options.network);
|
|
62
|
+
({ config } = await startNode(options, signalHandlers, services, adminServices, userLog, networkName));
|
|
50
63
|
} else if (options.bot) {
|
|
51
64
|
const { startBot } = await import('./cmds/start_bot.js');
|
|
52
65
|
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
66
|
} else if (options.archiver) {
|
|
60
67
|
const { startArchiver } = await import('./cmds/start_archiver.js');
|
|
61
68
|
({ config } = await startArchiver(options, signalHandlers, services));
|
|
@@ -98,14 +105,54 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
98
105
|
|
|
99
106
|
// If there are any admin services, start a separate JSON-RPC server for them
|
|
100
107
|
if (Object.entries(adminServices).length > 0) {
|
|
108
|
+
const adminMiddlewares = [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)];
|
|
109
|
+
|
|
110
|
+
// Resolve the admin API key (auto-generated and persisted, or opt-out)
|
|
111
|
+
const apiKeyResolution = await resolveAdminApiKey(
|
|
112
|
+
{
|
|
113
|
+
adminApiKeyHash: options.adminApiKeyHash,
|
|
114
|
+
disableAdminApiKey: options.disableAdminApiKey,
|
|
115
|
+
resetAdminApiKey: options.resetAdminApiKey,
|
|
116
|
+
dataDirectory: options.dataDirectory,
|
|
117
|
+
},
|
|
118
|
+
debugLogger,
|
|
119
|
+
);
|
|
120
|
+
if (apiKeyResolution) {
|
|
121
|
+
adminMiddlewares.unshift(getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash));
|
|
122
|
+
} else {
|
|
123
|
+
debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
|
|
124
|
+
}
|
|
125
|
+
|
|
101
126
|
const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
|
|
102
127
|
http200OnError: false,
|
|
103
128
|
log: debugLogger,
|
|
104
|
-
middlewares:
|
|
129
|
+
middlewares: adminMiddlewares,
|
|
105
130
|
maxBatchSize: options.rpcMaxBatchSize,
|
|
106
131
|
maxBodySizeBytes: options.rpcMaxBodySize,
|
|
107
132
|
});
|
|
108
133
|
const { port } = await startHttpRpcServer(rpcServer, { port: options.adminPort });
|
|
109
134
|
debugLogger.info(`Aztec Server admin API listening on port ${port}`, versions);
|
|
135
|
+
|
|
136
|
+
// Display the API key after the server has started
|
|
137
|
+
// Uses userLog which is never filtered by LOG_LEVEL.
|
|
138
|
+
if (apiKeyResolution?.rawKey) {
|
|
139
|
+
const separator = '='.repeat(70);
|
|
140
|
+
userLog('');
|
|
141
|
+
userLog(separator);
|
|
142
|
+
userLog(' ADMIN API KEY (save this — it will NOT be shown again)');
|
|
143
|
+
userLog('');
|
|
144
|
+
userLog(` ${apiKeyResolution.rawKey}`);
|
|
145
|
+
userLog('');
|
|
146
|
+
userLog(` Use via header: x-api-key: <key>`);
|
|
147
|
+
userLog(` Or via header: Authorization: Bearer <key>`);
|
|
148
|
+
if (options.dataDirectory) {
|
|
149
|
+
userLog('');
|
|
150
|
+
userLog(' The key hash has been persisted — on next restart, the same key will be used.');
|
|
151
|
+
}
|
|
152
|
+
userLog('');
|
|
153
|
+
userLog(' To disable admin auth: --disable-admin-api-key or AZTEC_DISABLE_ADMIN_API_KEY=true');
|
|
154
|
+
userLog(separator);
|
|
155
|
+
userLog('');
|
|
156
|
+
}
|
|
110
157
|
}
|
|
111
158
|
}
|