@aztec/aztec 0.0.1-commit.858058eac → 0.0.1-commit.85d7d01
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_bot.d.ts +2 -2
- package/dest/cli/cmds/start_bot.d.ts.map +1 -1
- package/dest/cli/cmds/start_bot.js +5 -3
- 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/cli/util.d.ts +2 -1
- package/dest/cli/util.d.ts.map +1 -1
- package/dest/cli/util.js +7 -3
- 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 +8 -5
- 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_bot.ts +5 -2
- 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/cli/util.ts +9 -2
- 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
|
@@ -22,6 +22,12 @@ import { getAddress, getContract } from 'viem';
|
|
|
22
22
|
markingAsProvenRunningPromise;
|
|
23
23
|
logger;
|
|
24
24
|
isMarkingAsProven;
|
|
25
|
+
// Optional callback to check if there are pending txs in the mempool.
|
|
26
|
+
getPendingTxCount;
|
|
27
|
+
// Optional callback to check if the sequencer is actively building a block.
|
|
28
|
+
isSequencerBuilding;
|
|
29
|
+
// Tracks when we first observed the current unfilled slot with pending txs (real wall time).
|
|
30
|
+
unfilledSlotFirstSeen;
|
|
25
31
|
constructor(cheatcodes, rollupAddress, l1Client, dateProvider){
|
|
26
32
|
this.cheatcodes = cheatcodes;
|
|
27
33
|
this.dateProvider = dateProvider;
|
|
@@ -45,6 +51,12 @@ import { getAddress, getContract } from 'viem';
|
|
|
45
51
|
setisLocalNetwork(isLocalNetwork) {
|
|
46
52
|
this.isLocalNetwork = isLocalNetwork;
|
|
47
53
|
}
|
|
54
|
+
/** Sets a callback to check for pending txs, used to skip unfilled slots faster when txs are waiting. */ setGetPendingTxCount(fn) {
|
|
55
|
+
this.getPendingTxCount = fn;
|
|
56
|
+
}
|
|
57
|
+
/** Sets a callback to check if the sequencer is actively building, to avoid warping while it works. */ setIsSequencerBuilding(fn) {
|
|
58
|
+
this.isSequencerBuilding = fn;
|
|
59
|
+
}
|
|
48
60
|
async start() {
|
|
49
61
|
if (this.filledRunningPromise) {
|
|
50
62
|
throw new Error('Watcher already watching for filled slot');
|
|
@@ -111,14 +123,8 @@ import { getAddress, getContract } from 'viem';
|
|
|
111
123
|
BigInt(nextSlot)
|
|
112
124
|
]));
|
|
113
125
|
if (BigInt(currentSlot) === checkpointLog.slotNumber) {
|
|
114
|
-
//
|
|
115
|
-
|
|
116
|
-
await this.cheatcodes.warp(nextSlotTimestamp, {
|
|
117
|
-
resetBlockInterval: true
|
|
118
|
-
});
|
|
119
|
-
} catch (e) {
|
|
120
|
-
this.logger.error(`Failed to warp to timestamp ${nextSlotTimestamp}: ${e}`);
|
|
121
|
-
}
|
|
126
|
+
// The current slot has been filled, we should jump to the next slot.
|
|
127
|
+
await this.warpToTimestamp(nextSlotTimestamp);
|
|
122
128
|
this.logger.info(`Slot ${currentSlot} was filled, jumped to next slot`);
|
|
123
129
|
return;
|
|
124
130
|
}
|
|
@@ -126,19 +132,50 @@ import { getAddress, getContract } from 'viem';
|
|
|
126
132
|
if (!this.isLocalNetwork) {
|
|
127
133
|
return;
|
|
128
134
|
}
|
|
135
|
+
// If there are pending txs and the sequencer missed them, warp quickly (after a 2s real-time debounce) so the
|
|
136
|
+
// sequencer can retry in the next slot. Without this, we'd have to wait a full real-time slot duration (~36s) for
|
|
137
|
+
// the dateProvider to catch up to the next slot timestamp. We skip the warp if the sequencer is actively building
|
|
138
|
+
// to avoid invalidating its in-progress work.
|
|
139
|
+
if (this.getPendingTxCount) {
|
|
140
|
+
const pendingTxs = await this.getPendingTxCount();
|
|
141
|
+
if (pendingTxs > 0) {
|
|
142
|
+
if (this.isSequencerBuilding?.()) {
|
|
143
|
+
this.unfilledSlotFirstSeen = undefined;
|
|
144
|
+
return;
|
|
145
|
+
}
|
|
146
|
+
const realNow = Date.now();
|
|
147
|
+
if (!this.unfilledSlotFirstSeen || this.unfilledSlotFirstSeen.slot !== currentSlot) {
|
|
148
|
+
this.unfilledSlotFirstSeen = {
|
|
149
|
+
slot: currentSlot,
|
|
150
|
+
realTime: realNow
|
|
151
|
+
};
|
|
152
|
+
return;
|
|
153
|
+
}
|
|
154
|
+
if (realNow - this.unfilledSlotFirstSeen.realTime > 2000) {
|
|
155
|
+
await this.warpToTimestamp(nextSlotTimestamp);
|
|
156
|
+
this.unfilledSlotFirstSeen = undefined;
|
|
157
|
+
this.logger.info(`Slot ${currentSlot} was missed with pending txs, jumped to next slot`);
|
|
158
|
+
}
|
|
159
|
+
return;
|
|
160
|
+
}
|
|
161
|
+
}
|
|
162
|
+
// Fallback: warp when the dateProvider time has passed the next slot timestamp.
|
|
129
163
|
const currentTimestamp = this.dateProvider?.now() ?? Date.now();
|
|
130
164
|
if (currentTimestamp > nextSlotTimestamp * 1000) {
|
|
131
|
-
|
|
132
|
-
await this.cheatcodes.warp(nextSlotTimestamp, {
|
|
133
|
-
resetBlockInterval: true
|
|
134
|
-
});
|
|
135
|
-
} catch (e) {
|
|
136
|
-
this.logger.error(`Failed to warp to timestamp ${nextSlotTimestamp}: ${e}`);
|
|
137
|
-
}
|
|
165
|
+
await this.warpToTimestamp(nextSlotTimestamp);
|
|
138
166
|
this.logger.info(`Slot ${currentSlot} was missed, jumped to next slot`);
|
|
139
167
|
}
|
|
140
168
|
} catch {
|
|
141
169
|
this.logger.error('mineIfSlotFilled failed');
|
|
142
170
|
}
|
|
143
171
|
}
|
|
172
|
+
async warpToTimestamp(timestamp) {
|
|
173
|
+
try {
|
|
174
|
+
await this.cheatcodes.warp(timestamp, {
|
|
175
|
+
resetBlockInterval: true
|
|
176
|
+
});
|
|
177
|
+
} catch (e) {
|
|
178
|
+
this.logger.error(`Failed to warp to timestamp ${timestamp}: ${e}`);
|
|
179
|
+
}
|
|
180
|
+
}
|
|
144
181
|
}
|
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.85d7d01",
|
|
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.85d7d01",
|
|
32
|
+
"@aztec/archiver": "0.0.1-commit.85d7d01",
|
|
33
|
+
"@aztec/aztec-faucet": "0.0.1-commit.85d7d01",
|
|
34
|
+
"@aztec/aztec-node": "0.0.1-commit.85d7d01",
|
|
35
|
+
"@aztec/aztec.js": "0.0.1-commit.85d7d01",
|
|
36
|
+
"@aztec/bb-prover": "0.0.1-commit.85d7d01",
|
|
37
|
+
"@aztec/bb.js": "0.0.1-commit.85d7d01",
|
|
38
|
+
"@aztec/blob-client": "0.0.1-commit.85d7d01",
|
|
39
|
+
"@aztec/bot": "0.0.1-commit.85d7d01",
|
|
40
|
+
"@aztec/builder": "0.0.1-commit.85d7d01",
|
|
41
|
+
"@aztec/cli": "0.0.1-commit.85d7d01",
|
|
42
|
+
"@aztec/constants": "0.0.1-commit.85d7d01",
|
|
43
|
+
"@aztec/entrypoints": "0.0.1-commit.85d7d01",
|
|
44
|
+
"@aztec/ethereum": "0.0.1-commit.85d7d01",
|
|
45
|
+
"@aztec/foundation": "0.0.1-commit.85d7d01",
|
|
46
|
+
"@aztec/kv-store": "0.0.1-commit.85d7d01",
|
|
47
|
+
"@aztec/l1-artifacts": "0.0.1-commit.85d7d01",
|
|
48
|
+
"@aztec/node-lib": "0.0.1-commit.85d7d01",
|
|
49
|
+
"@aztec/noir-contracts.js": "0.0.1-commit.85d7d01",
|
|
50
|
+
"@aztec/noir-protocol-circuits-types": "0.0.1-commit.85d7d01",
|
|
51
|
+
"@aztec/p2p": "0.0.1-commit.85d7d01",
|
|
52
|
+
"@aztec/p2p-bootstrap": "0.0.1-commit.85d7d01",
|
|
53
|
+
"@aztec/protocol-contracts": "0.0.1-commit.85d7d01",
|
|
54
|
+
"@aztec/prover-client": "0.0.1-commit.85d7d01",
|
|
55
|
+
"@aztec/prover-node": "0.0.1-commit.85d7d01",
|
|
56
|
+
"@aztec/pxe": "0.0.1-commit.85d7d01",
|
|
57
|
+
"@aztec/sequencer-client": "0.0.1-commit.85d7d01",
|
|
58
|
+
"@aztec/stdlib": "0.0.1-commit.85d7d01",
|
|
59
|
+
"@aztec/telemetry-client": "0.0.1-commit.85d7d01",
|
|
60
|
+
"@aztec/txe": "0.0.1-commit.85d7d01",
|
|
61
|
+
"@aztec/validator-ha-signer": "0.0.1-commit.85d7d01",
|
|
62
|
+
"@aztec/wallets": "0.0.1-commit.85d7d01",
|
|
63
|
+
"@aztec/world-state": "0.0.1-commit.85d7d01",
|
|
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
|
|
@@ -47,16 +46,20 @@ case $cmd in
|
|
|
47
46
|
export ETHEREUM_HOSTS=${ETHEREUM_HOSTS:-"http://127.0.0.1:${ANVIL_PORT}"}
|
|
48
47
|
|
|
49
48
|
anvil --version
|
|
50
|
-
anvil --silent &
|
|
49
|
+
anvil --silent --port "$ANVIL_PORT" &
|
|
51
50
|
anvil_pid=$!
|
|
52
51
|
trap 'kill $anvil_pid &>/dev/null' EXIT
|
|
53
52
|
fi
|
|
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
|
+
}
|