@aztec/aztec 0.0.1-commit.8f9871590 → 0.0.1-commit.934299a21
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 +5 -1
- 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 +46 -10
- 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 +23 -6
- package/dest/cli/cli.d.ts +1 -1
- package/dest/cli/cli.d.ts.map +1 -1
- package/dest/cli/cli.js +0 -1
- 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/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/start_node.d.ts +1 -1
- package/dest/cli/cmds/start_node.d.ts.map +1 -1
- package/dest/cli/cmds/start_node.js +58 -8
- 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/local-network/local-network.d.ts +3 -1
- package/dest/local-network/local-network.d.ts.map +1 -1
- package/dest/local-network/local-network.js +25 -4
- package/dest/testing/anvil_test_watcher.d.ts +9 -1
- package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
- package/dest/testing/anvil_test_watcher.js +52 -15
- package/package.json +34 -34
- package/scripts/aztec.sh +7 -4
- package/scripts/init.sh +23 -13
- package/scripts/new.sh +17 -16
- package/scripts/setup_workspace.sh +124 -0
- package/src/bin/index.ts +5 -1
- package/src/cli/admin_api_key_store.ts +128 -0
- package/src/cli/aztec_start_action.ts +50 -6
- package/src/cli/aztec_start_options.ts +25 -5
- package/src/cli/cli.ts +0 -1
- package/src/cli/cmds/compile.ts +184 -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/start_node.ts +49 -7
- package/src/cli/cmds/utils/artifacts.ts +44 -0
- package/src/cli/cmds/utils/spawn.ts +16 -0
- package/src/local-network/local-network.ts +38 -7
- package/src/testing/anvil_test_watcher.ts +59 -15
- 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/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_prover_node.ts +0 -124
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aztec/aztec",
|
|
3
|
-
"version": "0.0.1-commit.
|
|
3
|
+
"version": "0.0.1-commit.934299a21",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"exports": {
|
|
6
6
|
".": "./dest/index.js",
|
|
@@ -28,39 +28,39 @@
|
|
|
28
28
|
"../package.common.json"
|
|
29
29
|
],
|
|
30
30
|
"dependencies": {
|
|
31
|
-
"@aztec/accounts": "0.0.1-commit.
|
|
32
|
-
"@aztec/archiver": "0.0.1-commit.
|
|
33
|
-
"@aztec/aztec-faucet": "0.0.1-commit.
|
|
34
|
-
"@aztec/aztec-node": "0.0.1-commit.
|
|
35
|
-
"@aztec/aztec.js": "0.0.1-commit.
|
|
36
|
-
"@aztec/bb-prover": "0.0.1-commit.
|
|
37
|
-
"@aztec/bb.js": "0.0.1-commit.
|
|
38
|
-
"@aztec/blob-client": "0.0.1-commit.
|
|
39
|
-
"@aztec/bot": "0.0.1-commit.
|
|
40
|
-
"@aztec/builder": "0.0.1-commit.
|
|
41
|
-
"@aztec/cli": "0.0.1-commit.
|
|
42
|
-
"@aztec/constants": "0.0.1-commit.
|
|
43
|
-
"@aztec/entrypoints": "0.0.1-commit.
|
|
44
|
-
"@aztec/ethereum": "0.0.1-commit.
|
|
45
|
-
"@aztec/foundation": "0.0.1-commit.
|
|
46
|
-
"@aztec/kv-store": "0.0.1-commit.
|
|
47
|
-
"@aztec/l1-artifacts": "0.0.1-commit.
|
|
48
|
-
"@aztec/node-lib": "0.0.1-commit.
|
|
49
|
-
"@aztec/noir-contracts.js": "0.0.1-commit.
|
|
50
|
-
"@aztec/noir-protocol-circuits-types": "0.0.1-commit.
|
|
51
|
-
"@aztec/p2p": "0.0.1-commit.
|
|
52
|
-
"@aztec/p2p-bootstrap": "0.0.1-commit.
|
|
53
|
-
"@aztec/protocol-contracts": "0.0.1-commit.
|
|
54
|
-
"@aztec/prover-client": "0.0.1-commit.
|
|
55
|
-
"@aztec/prover-node": "0.0.1-commit.
|
|
56
|
-
"@aztec/pxe": "0.0.1-commit.
|
|
57
|
-
"@aztec/sequencer-client": "0.0.1-commit.
|
|
58
|
-
"@aztec/stdlib": "0.0.1-commit.
|
|
59
|
-
"@aztec/telemetry-client": "0.0.1-commit.
|
|
60
|
-
"@aztec/txe": "0.0.1-commit.
|
|
61
|
-
"@aztec/validator-ha-signer": "0.0.1-commit.
|
|
62
|
-
"@aztec/wallets": "0.0.1-commit.
|
|
63
|
-
"@aztec/world-state": "0.0.1-commit.
|
|
31
|
+
"@aztec/accounts": "0.0.1-commit.934299a21",
|
|
32
|
+
"@aztec/archiver": "0.0.1-commit.934299a21",
|
|
33
|
+
"@aztec/aztec-faucet": "0.0.1-commit.934299a21",
|
|
34
|
+
"@aztec/aztec-node": "0.0.1-commit.934299a21",
|
|
35
|
+
"@aztec/aztec.js": "0.0.1-commit.934299a21",
|
|
36
|
+
"@aztec/bb-prover": "0.0.1-commit.934299a21",
|
|
37
|
+
"@aztec/bb.js": "0.0.1-commit.934299a21",
|
|
38
|
+
"@aztec/blob-client": "0.0.1-commit.934299a21",
|
|
39
|
+
"@aztec/bot": "0.0.1-commit.934299a21",
|
|
40
|
+
"@aztec/builder": "0.0.1-commit.934299a21",
|
|
41
|
+
"@aztec/cli": "0.0.1-commit.934299a21",
|
|
42
|
+
"@aztec/constants": "0.0.1-commit.934299a21",
|
|
43
|
+
"@aztec/entrypoints": "0.0.1-commit.934299a21",
|
|
44
|
+
"@aztec/ethereum": "0.0.1-commit.934299a21",
|
|
45
|
+
"@aztec/foundation": "0.0.1-commit.934299a21",
|
|
46
|
+
"@aztec/kv-store": "0.0.1-commit.934299a21",
|
|
47
|
+
"@aztec/l1-artifacts": "0.0.1-commit.934299a21",
|
|
48
|
+
"@aztec/node-lib": "0.0.1-commit.934299a21",
|
|
49
|
+
"@aztec/noir-contracts.js": "0.0.1-commit.934299a21",
|
|
50
|
+
"@aztec/noir-protocol-circuits-types": "0.0.1-commit.934299a21",
|
|
51
|
+
"@aztec/p2p": "0.0.1-commit.934299a21",
|
|
52
|
+
"@aztec/p2p-bootstrap": "0.0.1-commit.934299a21",
|
|
53
|
+
"@aztec/protocol-contracts": "0.0.1-commit.934299a21",
|
|
54
|
+
"@aztec/prover-client": "0.0.1-commit.934299a21",
|
|
55
|
+
"@aztec/prover-node": "0.0.1-commit.934299a21",
|
|
56
|
+
"@aztec/pxe": "0.0.1-commit.934299a21",
|
|
57
|
+
"@aztec/sequencer-client": "0.0.1-commit.934299a21",
|
|
58
|
+
"@aztec/stdlib": "0.0.1-commit.934299a21",
|
|
59
|
+
"@aztec/telemetry-client": "0.0.1-commit.934299a21",
|
|
60
|
+
"@aztec/txe": "0.0.1-commit.934299a21",
|
|
61
|
+
"@aztec/validator-ha-signer": "0.0.1-commit.934299a21",
|
|
62
|
+
"@aztec/wallets": "0.0.1-commit.934299a21",
|
|
63
|
+
"@aztec/world-state": "0.0.1-commit.934299a21",
|
|
64
64
|
"@types/chalk": "^2.2.0",
|
|
65
65
|
"abitype": "^0.8.11",
|
|
66
66
|
"chalk": "^5.3.0",
|
package/scripts/aztec.sh
CHANGED
|
@@ -1,6 +1,5 @@
|
|
|
1
1
|
#!/usr/bin/env bash
|
|
2
2
|
set -euo pipefail
|
|
3
|
-
shopt -s inherit_errexit
|
|
4
3
|
|
|
5
4
|
# Re-execute using correct version if we have an .aztecrc file.
|
|
6
5
|
if [ "${AZTEC_VERSIONED:-0}" -eq 0 ] && [ -f .aztecrc ] && command -v aztec-up &>/dev/null; then
|
|
@@ -21,13 +20,13 @@ function aztec {
|
|
|
21
20
|
|
|
22
21
|
case $cmd in
|
|
23
22
|
test)
|
|
24
|
-
export LOG_LEVEL="${LOG_LEVEL:-error}"
|
|
23
|
+
export LOG_LEVEL="${LOG_LEVEL:-"error;trace:contract_log"}"
|
|
25
24
|
aztec start --txe --port 8081 &
|
|
26
25
|
server_pid=$!
|
|
27
26
|
trap 'kill $server_pid &>/dev/null || true' EXIT
|
|
28
27
|
while ! nc -z 127.0.0.1 8081 &>/dev/null; do sleep 0.2; done
|
|
29
28
|
export NARGO_FOREIGN_CALL_TIMEOUT=300000
|
|
30
|
-
nargo test --silence-warnings
|
|
29
|
+
nargo test --silence-warnings --oracle-resolver http://127.0.0.1:8081 --test-threads 16 "$@"
|
|
31
30
|
;;
|
|
32
31
|
start)
|
|
33
32
|
if [ "${1:-}" == "--local-network" ]; then
|
|
@@ -54,9 +53,13 @@ case $cmd in
|
|
|
54
53
|
|
|
55
54
|
aztec start "$@"
|
|
56
55
|
;;
|
|
57
|
-
|
|
56
|
+
new|init)
|
|
58
57
|
$script_dir/${cmd}.sh "$@"
|
|
59
58
|
;;
|
|
59
|
+
flamegraph)
|
|
60
|
+
echo "Warning: 'aztec flamegraph' is deprecated. Use 'aztec profile flamegraph' instead." >&2
|
|
61
|
+
aztec profile flamegraph "$@"
|
|
62
|
+
;;
|
|
60
63
|
*)
|
|
61
64
|
aztec $cmd "$@"
|
|
62
65
|
;;
|
package/scripts/init.sh
CHANGED
|
@@ -1,9 +1,11 @@
|
|
|
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
|
|
|
6
|
+
name_arg=""
|
|
7
|
+
|
|
8
|
+
# Check for help first
|
|
7
9
|
for arg in "$@"; do
|
|
8
10
|
if [ "$arg" == "--help" ] || [ "$arg" == "-h" ]; then
|
|
9
11
|
cat << 'EOF'
|
|
@@ -13,23 +15,31 @@ Usage: aztec init [OPTIONS]
|
|
|
13
15
|
|
|
14
16
|
Options:
|
|
15
17
|
--name <NAME> Name of the package [default: current directory name]
|
|
16
|
-
--lib Use a library template
|
|
17
18
|
-h, --help Print help
|
|
18
19
|
|
|
19
|
-
This command creates a new Aztec Noir project in the current directory
|
|
20
|
-
|
|
21
|
-
|
|
20
|
+
This command creates a new Aztec Noir project in the current directory with
|
|
21
|
+
a workspace containing a contract crate and a test crate, and automatically
|
|
22
|
+
adds the Aztec.nr dependency to both.
|
|
22
23
|
EOF
|
|
23
24
|
exit 0
|
|
24
25
|
fi
|
|
25
|
-
if [ "$arg" == "--lib" ]; then
|
|
26
|
-
is_contract=0
|
|
27
|
-
fi
|
|
28
26
|
done
|
|
29
27
|
|
|
30
|
-
|
|
31
|
-
|
|
28
|
+
# Parse arguments
|
|
29
|
+
while [[ $# -gt 0 ]]; do
|
|
30
|
+
case $1 in
|
|
31
|
+
--name)
|
|
32
|
+
name_arg="$2"
|
|
33
|
+
shift 2
|
|
34
|
+
;;
|
|
35
|
+
*)
|
|
36
|
+
shift
|
|
37
|
+
;;
|
|
38
|
+
esac
|
|
39
|
+
done
|
|
40
|
+
|
|
41
|
+
# Derive package name: use --name if provided, otherwise use current directory name
|
|
42
|
+
package_name="${name_arg:-$(basename $(pwd))}"
|
|
32
43
|
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
fi
|
|
44
|
+
echo "Initializing Aztec contract project..."
|
|
45
|
+
$script_path/setup_workspace.sh "$package_name"
|
package/scripts/new.sh
CHANGED
|
@@ -1,10 +1,10 @@
|
|
|
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
|
+
name_arg=""
|
|
7
|
+
project_path=""
|
|
8
8
|
|
|
9
9
|
while [[ $# -gt 0 ]]; do
|
|
10
10
|
case $1 in
|
|
@@ -19,20 +19,16 @@ Arguments:
|
|
|
19
19
|
|
|
20
20
|
Options:
|
|
21
21
|
--name <NAME> Name of the package [default: package directory name]
|
|
22
|
-
--lib Create a library template instead of a contract
|
|
23
22
|
-h, --help Print help
|
|
24
23
|
|
|
25
|
-
This command creates a new Aztec Noir project
|
|
26
|
-
|
|
24
|
+
This command creates a new Aztec Noir project with a workspace containing
|
|
25
|
+
a contract crate and a test crate, and automatically adds the Aztec.nr
|
|
26
|
+
dependency to both.
|
|
27
27
|
EOF
|
|
28
28
|
exit 0
|
|
29
29
|
;;
|
|
30
|
-
--lib)
|
|
31
|
-
type_arg="--lib"
|
|
32
|
-
shift
|
|
33
|
-
;;
|
|
34
30
|
--name)
|
|
35
|
-
name_arg="
|
|
31
|
+
name_arg="$2"
|
|
36
32
|
shift 2
|
|
37
33
|
;;
|
|
38
34
|
*)
|
|
@@ -50,10 +46,15 @@ if [ -z "$project_path" ]; then
|
|
|
50
46
|
exit 1
|
|
51
47
|
fi
|
|
52
48
|
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
if [ "$type_arg" == "--contract" ]; then
|
|
57
|
-
cd $project_path
|
|
58
|
-
$script_path/setup_project.sh
|
|
49
|
+
if [ -d "$project_path" ] && [ "$(ls -A $project_path 2>/dev/null)" ]; then
|
|
50
|
+
echo "Error: $project_path already exists and is not empty"
|
|
51
|
+
exit 1
|
|
59
52
|
fi
|
|
53
|
+
|
|
54
|
+
# Derive package name: use --name if provided, otherwise use directory basename
|
|
55
|
+
package_name="${name_arg:-$(basename $project_path)}"
|
|
56
|
+
|
|
57
|
+
echo "Creating new Aztec contract project at $project_path..."
|
|
58
|
+
mkdir -p "$project_path"
|
|
59
|
+
cd "$project_path"
|
|
60
|
+
$script_path/setup_workspace.sh "$package_name"
|
|
@@ -0,0 +1,124 @@
|
|
|
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
|
+
|
|
10
|
+
if [ -z "$package_name" ]; then
|
|
11
|
+
echo "Error: package name is required"
|
|
12
|
+
exit 1
|
|
13
|
+
fi
|
|
14
|
+
|
|
15
|
+
if [ -f "Nargo.toml" ]; then
|
|
16
|
+
echo "Error: Nargo.toml already exists in the current directory"
|
|
17
|
+
exit 1
|
|
18
|
+
fi
|
|
19
|
+
|
|
20
|
+
# Get the actual aztec version for the git tag.
|
|
21
|
+
AZTEC_VERSION=$(jq -r '.version' $(dirname $0)/../package.json)
|
|
22
|
+
|
|
23
|
+
# Create workspace root Nargo.toml
|
|
24
|
+
cat > Nargo.toml << 'EOF'
|
|
25
|
+
[workspace]
|
|
26
|
+
members = ["contract", "test"]
|
|
27
|
+
EOF
|
|
28
|
+
|
|
29
|
+
# Create contract crate
|
|
30
|
+
mkdir -p contract/src
|
|
31
|
+
cat > contract/Nargo.toml << CEOF
|
|
32
|
+
[package]
|
|
33
|
+
name = "${package_name}"
|
|
34
|
+
type = "contract"
|
|
35
|
+
|
|
36
|
+
[dependencies]
|
|
37
|
+
aztec = { git="https://github.com/AztecProtocol/aztec-nr", tag="v${AZTEC_VERSION}", directory="aztec" }
|
|
38
|
+
CEOF
|
|
39
|
+
|
|
40
|
+
cat > contract/src/main.nr << 'EOF'
|
|
41
|
+
use aztec::macros::aztec;
|
|
42
|
+
|
|
43
|
+
#[aztec]
|
|
44
|
+
pub contract Main {
|
|
45
|
+
use aztec::macros::functions::{external, initializer};
|
|
46
|
+
|
|
47
|
+
#[initializer]
|
|
48
|
+
#[external("private")]
|
|
49
|
+
fn constructor() {}
|
|
50
|
+
}
|
|
51
|
+
EOF
|
|
52
|
+
|
|
53
|
+
# Create test crate
|
|
54
|
+
mkdir -p test/src
|
|
55
|
+
cat > test/Nargo.toml << TEOF
|
|
56
|
+
[package]
|
|
57
|
+
name = "${package_name}_test"
|
|
58
|
+
type = "lib"
|
|
59
|
+
|
|
60
|
+
[dependencies]
|
|
61
|
+
aztec = { git="https://github.com/AztecProtocol/aztec-nr", tag="v${AZTEC_VERSION}", directory="aztec" }
|
|
62
|
+
${package_name} = { path = "../contract" }
|
|
63
|
+
TEOF
|
|
64
|
+
|
|
65
|
+
cat > test/src/lib.nr << 'NOIR'
|
|
66
|
+
use aztec::test::helpers::test_environment::TestEnvironment;
|
|
67
|
+
use __PACKAGE_NAME__::Main;
|
|
68
|
+
|
|
69
|
+
#[test]
|
|
70
|
+
unconstrained fn test_constructor() {
|
|
71
|
+
let mut env = TestEnvironment::new();
|
|
72
|
+
let deployer = env.create_light_account();
|
|
73
|
+
|
|
74
|
+
// Deploy the contract with the default constructor:
|
|
75
|
+
let contract_address = env.deploy("@__PACKAGE_NAME__/Main").with_private_initializer(
|
|
76
|
+
deployer,
|
|
77
|
+
Main::interface().constructor(),
|
|
78
|
+
);
|
|
79
|
+
|
|
80
|
+
// Deploy without an initializer:
|
|
81
|
+
let contract_address = env.deploy("@__PACKAGE_NAME__/Main").without_initializer();
|
|
82
|
+
}
|
|
83
|
+
NOIR
|
|
84
|
+
|
|
85
|
+
sed -i "s/__PACKAGE_NAME__/${package_name}/g" test/src/lib.nr
|
|
86
|
+
|
|
87
|
+
# Create README
|
|
88
|
+
cat > README.md << REOF
|
|
89
|
+
# ${package_name}
|
|
90
|
+
|
|
91
|
+
An Aztec Noir contract project.
|
|
92
|
+
|
|
93
|
+
## Compile
|
|
94
|
+
|
|
95
|
+
\`\`\`bash
|
|
96
|
+
aztec compile
|
|
97
|
+
\`\`\`
|
|
98
|
+
|
|
99
|
+
This compiles the contract in \`contract/\` and outputs artifacts to \`target/\`.
|
|
100
|
+
|
|
101
|
+
## Test
|
|
102
|
+
|
|
103
|
+
\`\`\`bash
|
|
104
|
+
aztec test
|
|
105
|
+
\`\`\`
|
|
106
|
+
|
|
107
|
+
This runs the tests in \`test/\`.
|
|
108
|
+
|
|
109
|
+
## Generate TypeScript bindings
|
|
110
|
+
|
|
111
|
+
\`\`\`bash
|
|
112
|
+
aztec codegen target -o src/artifacts
|
|
113
|
+
\`\`\`
|
|
114
|
+
|
|
115
|
+
This generates TypeScript contract artifacts from the compiled output in \`target/\` into \`src/artifacts/\`.
|
|
116
|
+
REOF
|
|
117
|
+
|
|
118
|
+
# Create .gitignore
|
|
119
|
+
cat > .gitignore << 'GEOF'
|
|
120
|
+
target/
|
|
121
|
+
codegenCache.json
|
|
122
|
+
GEOF
|
|
123
|
+
|
|
124
|
+
echo "Created Aztec contract workspace with crates '${package_name}' and '${package_name}_test'"
|
package/src/bin/index.ts
CHANGED
|
@@ -14,7 +14,9 @@ import { createConsoleLogger, createLogger } from '@aztec/foundation/log';
|
|
|
14
14
|
|
|
15
15
|
import { Command } from 'commander';
|
|
16
16
|
|
|
17
|
+
import { injectCompileCommand } from '../cli/cmds/compile.js';
|
|
17
18
|
import { injectMigrateCommand } from '../cli/cmds/migrate_ha_db.js';
|
|
19
|
+
import { injectProfileCommand } from '../cli/cmds/profile.js';
|
|
18
20
|
import { injectAztecCommands } from '../cli/index.js';
|
|
19
21
|
import { getCliVersion } from '../cli/release_version.js';
|
|
20
22
|
|
|
@@ -47,7 +49,7 @@ async function main() {
|
|
|
47
49
|
|
|
48
50
|
const cliVersion = getCliVersion();
|
|
49
51
|
let program = new Command('aztec');
|
|
50
|
-
program.description('Aztec command line interface').version(cliVersion);
|
|
52
|
+
program.description('Aztec command line interface').version(cliVersion).enablePositionalOptions();
|
|
51
53
|
program = injectAztecCommands(program, userLog, debugLogger);
|
|
52
54
|
program = injectBuilderCommands(program);
|
|
53
55
|
program = injectContractCommands(program, userLog, debugLogger);
|
|
@@ -56,6 +58,8 @@ async function main() {
|
|
|
56
58
|
program = injectAztecNodeCommands(program, userLog, debugLogger);
|
|
57
59
|
program = injectMiscCommands(program, userLog);
|
|
58
60
|
program = injectValidatorKeysCommands(program, userLog);
|
|
61
|
+
program = injectCompileCommand(program, userLog);
|
|
62
|
+
program = injectProfileCommand(program, userLog);
|
|
59
63
|
program = injectMigrateCommand(program, userLog);
|
|
60
64
|
|
|
61
65
|
await program.parseAsync(process.argv);
|
|
@@ -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,6 +1,7 @@
|
|
|
1
1
|
import {
|
|
2
2
|
type NamespacedApiHandlers,
|
|
3
3
|
createNamespacedSafeJsonRpcServer,
|
|
4
|
+
getApiKeyAuthMiddleware,
|
|
4
5
|
startHttpRpcServer,
|
|
5
6
|
} from '@aztec/foundation/json-rpc/server';
|
|
6
7
|
import type { LogFn, Logger } from '@aztec/foundation/log';
|
|
@@ -11,6 +12,7 @@ import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
|
|
|
11
12
|
|
|
12
13
|
import { createLocalNetwork } from '../local-network/index.js';
|
|
13
14
|
import { github, splash } from '../splash.js';
|
|
15
|
+
import { resolveAdminApiKey } from './admin_api_key_store.js';
|
|
14
16
|
import { getCliVersion } from './release_version.js';
|
|
15
17
|
import { extractNamespacedOptions, installSignalHandlers } from './util.js';
|
|
16
18
|
import { getVersions } from './versioning.js';
|
|
@@ -35,11 +37,11 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
35
37
|
l1RpcUrls: options.l1RpcUrls,
|
|
36
38
|
testAccounts: localNetwork.testAccounts,
|
|
37
39
|
realProofs: false,
|
|
38
|
-
// Setting the epoch duration to
|
|
40
|
+
// Setting the epoch duration to 2 by default for local network. This allows the epoch to be "proven" faster, so
|
|
39
41
|
// the users can consume out hash without having to wait for a long time.
|
|
40
42
|
// Note: We are not proving anything in the local network (realProofs == false). But in `createLocalNetwork`,
|
|
41
43
|
// the EpochTestSettler will set the out hash to the outbox when an epoch is complete.
|
|
42
|
-
aztecEpochDuration:
|
|
44
|
+
aztecEpochDuration: 2,
|
|
43
45
|
},
|
|
44
46
|
userLog,
|
|
45
47
|
);
|
|
@@ -48,15 +50,17 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
48
50
|
signalHandlers.push(stop);
|
|
49
51
|
services.node = [node, AztecNodeApiSchema];
|
|
50
52
|
} else {
|
|
53
|
+
// Route --prover-node through startNode
|
|
54
|
+
if (options.proverNode && !options.node) {
|
|
55
|
+
options.node = true;
|
|
56
|
+
}
|
|
57
|
+
|
|
51
58
|
if (options.node) {
|
|
52
59
|
const { startNode } = await import('./cmds/start_node.js');
|
|
53
60
|
({ config } = await startNode(options, signalHandlers, services, adminServices, userLog));
|
|
54
61
|
} else if (options.bot) {
|
|
55
62
|
const { startBot } = await import('./cmds/start_bot.js');
|
|
56
63
|
await startBot(options, signalHandlers, services, userLog);
|
|
57
|
-
} else if (options.proverNode) {
|
|
58
|
-
const { startProverNode } = await import('./cmds/start_prover_node.js');
|
|
59
|
-
({ config } = await startProverNode(options, signalHandlers, services, userLog));
|
|
60
64
|
} else if (options.archiver) {
|
|
61
65
|
const { startArchiver } = await import('./cmds/start_archiver.js');
|
|
62
66
|
({ config } = await startArchiver(options, signalHandlers, services));
|
|
@@ -99,14 +103,54 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
|
|
|
99
103
|
|
|
100
104
|
// If there are any admin services, start a separate JSON-RPC server for them
|
|
101
105
|
if (Object.entries(adminServices).length > 0) {
|
|
106
|
+
const adminMiddlewares = [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)];
|
|
107
|
+
|
|
108
|
+
// Resolve the admin API key (auto-generated and persisted, or opt-out)
|
|
109
|
+
const apiKeyResolution = await resolveAdminApiKey(
|
|
110
|
+
{
|
|
111
|
+
adminApiKeyHash: options.adminApiKeyHash,
|
|
112
|
+
disableAdminApiKey: options.disableAdminApiKey,
|
|
113
|
+
resetAdminApiKey: options.resetAdminApiKey,
|
|
114
|
+
dataDirectory: options.dataDirectory,
|
|
115
|
+
},
|
|
116
|
+
debugLogger,
|
|
117
|
+
);
|
|
118
|
+
if (apiKeyResolution) {
|
|
119
|
+
adminMiddlewares.unshift(getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash));
|
|
120
|
+
} else {
|
|
121
|
+
debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
|
|
122
|
+
}
|
|
123
|
+
|
|
102
124
|
const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
|
|
103
125
|
http200OnError: false,
|
|
104
126
|
log: debugLogger,
|
|
105
|
-
middlewares:
|
|
127
|
+
middlewares: adminMiddlewares,
|
|
106
128
|
maxBatchSize: options.rpcMaxBatchSize,
|
|
107
129
|
maxBodySizeBytes: options.rpcMaxBodySize,
|
|
108
130
|
});
|
|
109
131
|
const { port } = await startHttpRpcServer(rpcServer, { port: options.adminPort });
|
|
110
132
|
debugLogger.info(`Aztec Server admin API listening on port ${port}`, versions);
|
|
133
|
+
|
|
134
|
+
// Display the API key after the server has started
|
|
135
|
+
// Uses userLog which is never filtered by LOG_LEVEL.
|
|
136
|
+
if (apiKeyResolution?.rawKey) {
|
|
137
|
+
const separator = '='.repeat(70);
|
|
138
|
+
userLog('');
|
|
139
|
+
userLog(separator);
|
|
140
|
+
userLog(' ADMIN API KEY (save this — it will NOT be shown again)');
|
|
141
|
+
userLog('');
|
|
142
|
+
userLog(` ${apiKeyResolution.rawKey}`);
|
|
143
|
+
userLog('');
|
|
144
|
+
userLog(` Use via header: x-api-key: <key>`);
|
|
145
|
+
userLog(` Or via header: Authorization: Bearer <key>`);
|
|
146
|
+
if (options.dataDirectory) {
|
|
147
|
+
userLog('');
|
|
148
|
+
userLog(' The key hash has been persisted — on next restart, the same key will be used.');
|
|
149
|
+
}
|
|
150
|
+
userLog('');
|
|
151
|
+
userLog(' To disable admin auth: --disable-admin-api-key or AZTEC_DISABLE_ADMIN_API_KEY=true');
|
|
152
|
+
userLog(separator);
|
|
153
|
+
userLog('');
|
|
154
|
+
}
|
|
111
155
|
}
|
|
112
156
|
}
|
|
@@ -142,6 +142,30 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
142
142
|
env: 'AZTEC_ADMIN_PORT',
|
|
143
143
|
parseVal: val => parseInt(val, 10),
|
|
144
144
|
},
|
|
145
|
+
{
|
|
146
|
+
flag: '--admin-api-key-hash <value>',
|
|
147
|
+
description:
|
|
148
|
+
'SHA-256 hex hash of a pre-generated admin API key. When set, the node uses this hash for authentication instead of auto-generating a key.',
|
|
149
|
+
defaultValue: undefined,
|
|
150
|
+
env: 'AZTEC_ADMIN_API_KEY_HASH',
|
|
151
|
+
},
|
|
152
|
+
{
|
|
153
|
+
flag: '--disable-admin-api-key',
|
|
154
|
+
description:
|
|
155
|
+
'Disable API key authentication on the admin RPC endpoint. By default, a key is auto-generated, displayed once, and its hash is persisted.',
|
|
156
|
+
defaultValue: false,
|
|
157
|
+
env: 'AZTEC_DISABLE_ADMIN_API_KEY',
|
|
158
|
+
// undefined means the flag was passed without a value (boolean toggle), treat as true.
|
|
159
|
+
parseVal: val => val === undefined || val === 'true' || val === '1',
|
|
160
|
+
},
|
|
161
|
+
{
|
|
162
|
+
flag: '--reset-admin-api-key',
|
|
163
|
+
description:
|
|
164
|
+
'Force-generate a new admin API key, replacing any previously persisted key hash. The new key is displayed once at startup.',
|
|
165
|
+
defaultValue: false,
|
|
166
|
+
env: 'AZTEC_RESET_ADMIN_API_KEY',
|
|
167
|
+
parseVal: val => val === 'true' || val === '1',
|
|
168
|
+
},
|
|
145
169
|
{
|
|
146
170
|
flag: '--api-prefix <value>',
|
|
147
171
|
description: 'Prefix for API routes on any service that is started',
|
|
@@ -170,7 +194,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
170
194
|
'WORLD STATE': [
|
|
171
195
|
configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
|
|
172
196
|
configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
|
|
173
|
-
configToFlag('--world-state-
|
|
197
|
+
configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory),
|
|
174
198
|
],
|
|
175
199
|
// We can't easily auto-generate node options as they're parts of modules defined below
|
|
176
200
|
'AZTEC NODE': [
|
|
@@ -222,12 +246,8 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
222
246
|
'proverNode',
|
|
223
247
|
omitConfigMappings(proverNodeConfigMappings, [
|
|
224
248
|
// filter out options passed separately
|
|
225
|
-
...getKeys(archiverConfigMappings),
|
|
226
249
|
...getKeys(proverBrokerConfigMappings),
|
|
227
250
|
...getKeys(proverAgentConfigMappings),
|
|
228
|
-
...getKeys(p2pConfigMappings),
|
|
229
|
-
...getKeys(worldStateConfigMappings),
|
|
230
|
-
...getKeys(sharedNodeConfigMappings),
|
|
231
251
|
]),
|
|
232
252
|
),
|
|
233
253
|
],
|