@aztec/aztec 0.0.1-commit.5daedc8 → 0.0.1-commit.6201a7b05
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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 +77 -22
- package/dest/cli/aztec_start_options.d.ts +2 -2
- package/dest/cli/aztec_start_options.d.ts.map +1 -1
- package/dest/cli/aztec_start_options.js +52 -34
- package/dest/cli/cli.d.ts +1 -1
- package/dest/cli/cli.d.ts.map +1 -1
- package/dest/cli/cli.js +7 -52
- 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 +155 -0
- package/dest/cli/cmds/migrate_ha_db.d.ts +3 -0
- package/dest/cli/cmds/migrate_ha_db.d.ts.map +1 -0
- package/dest/cli/cmds/migrate_ha_db.js +27 -0
- package/dest/cli/cmds/profile.d.ts +4 -0
- package/dest/cli/cmds/profile.d.ts.map +1 -0
- package/dest/cli/cmds/profile.js +8 -0
- package/dest/cli/cmds/profile_flamegraph.d.ts +4 -0
- package/dest/cli/cmds/profile_flamegraph.d.ts.map +1 -0
- package/dest/cli/cmds/profile_flamegraph.js +52 -0
- package/dest/cli/cmds/profile_gates.d.ts +4 -0
- package/dest/cli/cmds/profile_gates.d.ts.map +1 -0
- package/dest/cli/cmds/profile_gates.js +58 -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 +32 -0
- package/dest/cli/cmds/standby.d.ts.map +1 -0
- package/dest/cli/cmds/standby.js +97 -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 +15 -15
- 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 +75 -33
- 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 +6 -18
- 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 +15 -9
- package/dest/cli/cmds/start_txe.d.ts +2 -2
- package/dest/cli/cmds/start_txe.d.ts.map +1 -1
- package/dest/cli/cmds/start_txe.js +4 -3
- 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/collect_crate_dirs.d.ts +21 -0
- package/dest/cli/cmds/utils/collect_crate_dirs.d.ts.map +1 -0
- package/dest/cli/cmds/utils/collect_crate_dirs.js +114 -0
- package/dest/cli/cmds/utils/needs_recompile.d.ts +10 -0
- package/dest/cli/cmds/utils/needs_recompile.d.ts.map +1 -0
- package/dest/cli/cmds/utils/needs_recompile.js +90 -0
- package/dest/cli/cmds/utils/spawn.d.ts +3 -0
- package/dest/cli/cmds/utils/spawn.d.ts.map +1 -0
- package/dest/cli/cmds/utils/spawn.js +16 -0
- package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.d.ts +4 -0
- package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.d.ts.map +1 -0
- package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.js +62 -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 +15 -17
- package/dest/local-network/local-network.d.ts.map +1 -1
- package/dest/local-network/local-network.js +89 -46
- package/dest/testing/anvil_test_watcher.d.ts +16 -4
- package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
- package/dest/testing/anvil_test_watcher.js +86 -23
- package/dest/testing/cheat_codes.d.ts +13 -15
- package/dest/testing/cheat_codes.d.ts.map +1 -1
- package/dest/testing/cheat_codes.js +34 -32
- 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 +61 -0
- package/dest/testing/index.d.ts +4 -2
- 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 +39 -36
- package/scripts/add_crate.sh +52 -0
- package/scripts/aztec.sh +73 -0
- package/scripts/init.sh +39 -0
- package/scripts/new.sh +83 -0
- package/scripts/setup_workspace.sh +69 -0
- package/scripts/templates/blank/contract/Nargo.toml +6 -0
- package/scripts/templates/blank/contract/src/main.nr +10 -0
- package/scripts/templates/blank/test/Nargo.toml +7 -0
- package/scripts/templates/blank/test/src/lib.nr +11 -0
- package/scripts/templates/counter/contract/Nargo.toml +7 -0
- package/scripts/templates/counter/contract/src/main.nr +48 -0
- package/scripts/templates/counter/test/Nargo.toml +7 -0
- package/scripts/templates/counter/test/src/lib.nr +32 -0
- package/src/bin/index.ts +13 -5
- package/src/cli/admin_api_key_store.ts +128 -0
- package/src/cli/aztec_start_action.ts +69 -17
- package/src/cli/aztec_start_options.ts +59 -35
- package/src/cli/cli.ts +11 -56
- package/src/cli/cmds/compile.ts +178 -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 +64 -0
- package/src/cli/cmds/profile_gates.ts +68 -0
- package/src/cli/cmds/profile_utils.ts +58 -0
- package/src/cli/cmds/standby.ts +132 -0
- package/src/cli/cmds/start_archiver.ts +14 -19
- package/src/cli/cmds/start_bot.ts +9 -6
- package/src/cli/cmds/start_node.ts +85 -37
- package/src/cli/cmds/start_p2p_bootstrap.ts +3 -3
- package/src/cli/cmds/start_prover_agent.ts +7 -18
- package/src/cli/cmds/start_prover_broker.ts +20 -16
- package/src/cli/cmds/start_txe.ts +5 -3
- package/src/cli/cmds/utils/artifacts.ts +44 -0
- package/src/cli/cmds/utils/collect_crate_dirs.ts +118 -0
- package/src/cli/cmds/utils/needs_recompile.ts +98 -0
- package/src/cli/cmds/utils/spawn.ts +16 -0
- package/src/cli/cmds/utils/warn_if_aztec_version_mismatch.ts +77 -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 +123 -88
- package/src/testing/anvil_test_watcher.ts +97 -22
- package/src/testing/cheat_codes.ts +42 -35
- package/src/testing/epoch_test_settler.ts +70 -0
- package/src/testing/index.ts +3 -1
- 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/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
|
@@ -1,8 +1,9 @@
|
|
|
1
1
|
import { type ArchiverConfig, archiverConfigMappings } from '@aztec/archiver/config';
|
|
2
|
-
import {
|
|
3
|
-
import { blobSinkConfigMappings } from '@aztec/blob-sink/server';
|
|
2
|
+
import { blobClientConfigMapping } from '@aztec/blob-client/client/config';
|
|
4
3
|
import { botConfigMappings } from '@aztec/bot/config';
|
|
5
|
-
import {
|
|
4
|
+
import { l1ContractsConfigMappings } from '@aztec/ethereum/config';
|
|
5
|
+
import { l1ContractAddressesMapping } from '@aztec/ethereum/l1-contract-addresses';
|
|
6
|
+
import { l1ReaderConfigMappings } from '@aztec/ethereum/l1-reader';
|
|
6
7
|
import { getKeys } from '@aztec/foundation/collection';
|
|
7
8
|
import {
|
|
8
9
|
type ConfigMapping,
|
|
@@ -11,15 +12,16 @@ import {
|
|
|
11
12
|
isBooleanConfigValue,
|
|
12
13
|
omitConfigMappings,
|
|
13
14
|
} from '@aztec/foundation/config';
|
|
14
|
-
import { dataConfigMappings } from '@aztec/kv-store/config';
|
|
15
15
|
import { sharedNodeConfigMappings } from '@aztec/node-lib/config';
|
|
16
16
|
import { bootnodeConfigMappings, p2pConfigMappings } from '@aztec/p2p/config';
|
|
17
|
-
import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker';
|
|
17
|
+
import { proverAgentConfigMappings, proverBrokerConfigMappings } from '@aztec/prover-client/broker/config';
|
|
18
18
|
import { proverNodeConfigMappings } from '@aztec/prover-node/config';
|
|
19
19
|
import { allPxeConfigMappings } from '@aztec/pxe/config';
|
|
20
|
-
import {
|
|
21
|
-
import {
|
|
22
|
-
import {
|
|
20
|
+
import { sequencerClientConfigMappings } from '@aztec/sequencer-client/config';
|
|
21
|
+
import { chainConfigMappings, nodeRpcConfigMappings } from '@aztec/stdlib/config';
|
|
22
|
+
import { dataConfigMappings } from '@aztec/stdlib/kv-store';
|
|
23
|
+
import { telemetryClientConfigMappings } from '@aztec/telemetry-client/config';
|
|
24
|
+
import { worldStateConfigMappings } from '@aztec/world-state/config';
|
|
23
25
|
|
|
24
26
|
import { DefaultMnemonic } from '../mnemonic.js';
|
|
25
27
|
|
|
@@ -34,7 +36,7 @@ export interface AztecStartOption {
|
|
|
34
36
|
parseVal?: (val: string) => any;
|
|
35
37
|
}
|
|
36
38
|
|
|
37
|
-
export const getOptions = (namespace: string, configMappings: Record<string, ConfigMapping
|
|
39
|
+
export const getOptions = (namespace: string, configMappings: Record<string, ConfigMapping<unknown>>) => {
|
|
38
40
|
const options: AztecStartOption[] = [];
|
|
39
41
|
for (const [key, { env, defaultValue: def, parseEnv, description, printDefault, fallback }] of Object.entries(
|
|
40
42
|
configMappings,
|
|
@@ -56,7 +58,11 @@ export const getOptions = (namespace: string, configMappings: Record<string, Con
|
|
|
56
58
|
return options;
|
|
57
59
|
};
|
|
58
60
|
|
|
59
|
-
const configToFlag = (
|
|
61
|
+
const configToFlag = (
|
|
62
|
+
flag: string,
|
|
63
|
+
configMapping: ConfigMapping<unknown>,
|
|
64
|
+
overrideDefaultValue?: any,
|
|
65
|
+
): AztecStartOption => {
|
|
60
66
|
if (!configMapping.isBoolean) {
|
|
61
67
|
flag += ' <value>';
|
|
62
68
|
}
|
|
@@ -103,8 +109,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
103
109
|
env: 'NETWORK',
|
|
104
110
|
},
|
|
105
111
|
|
|
106
|
-
configToFlag('--
|
|
107
|
-
configToFlag('--auto-update-url', sharedNodeConfigMappings.autoUpdateUrl),
|
|
112
|
+
configToFlag('--enable-version-check', sharedNodeConfigMappings.enableVersionCheck),
|
|
108
113
|
|
|
109
114
|
configToFlag('--sync-mode', sharedNodeConfigMappings.syncMode),
|
|
110
115
|
configToFlag('--snapshots-urls', sharedNodeConfigMappings.snapshotsUrls),
|
|
@@ -125,12 +130,10 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
125
130
|
env: 'MNEMONIC',
|
|
126
131
|
},
|
|
127
132
|
{
|
|
128
|
-
flag: '--local-network.
|
|
129
|
-
description:
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
defaultValue: undefined,
|
|
133
|
-
parseVal: (val: string) => (val ? parseInt(val) : undefined),
|
|
133
|
+
flag: '--local-network.testAccounts',
|
|
134
|
+
description: 'Deploy test accounts on local network start',
|
|
135
|
+
env: 'TEST_ACCOUNTS',
|
|
136
|
+
...booleanConfigHelper(true),
|
|
134
137
|
},
|
|
135
138
|
],
|
|
136
139
|
API: [
|
|
@@ -148,20 +151,53 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
148
151
|
env: 'AZTEC_ADMIN_PORT',
|
|
149
152
|
parseVal: val => parseInt(val, 10),
|
|
150
153
|
},
|
|
154
|
+
{
|
|
155
|
+
flag: '--admin-api-key-hash <value>',
|
|
156
|
+
description:
|
|
157
|
+
'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.',
|
|
158
|
+
defaultValue: undefined,
|
|
159
|
+
env: 'AZTEC_ADMIN_API_KEY_HASH',
|
|
160
|
+
},
|
|
161
|
+
{
|
|
162
|
+
flag: '--disable-admin-api-key',
|
|
163
|
+
description:
|
|
164
|
+
'Disable API key authentication on the admin RPC endpoint. By default, a key is auto-generated, displayed once, and its hash is persisted.',
|
|
165
|
+
defaultValue: false,
|
|
166
|
+
env: 'AZTEC_DISABLE_ADMIN_API_KEY',
|
|
167
|
+
// undefined means the flag was passed without a value (boolean toggle), treat as true.
|
|
168
|
+
parseVal: val => val === undefined || val === 'true' || val === '1',
|
|
169
|
+
},
|
|
170
|
+
{
|
|
171
|
+
flag: '--reset-admin-api-key',
|
|
172
|
+
description:
|
|
173
|
+
'Force-generate a new admin API key, replacing any previously persisted key hash. The new key is displayed once at startup.',
|
|
174
|
+
defaultValue: false,
|
|
175
|
+
env: 'AZTEC_RESET_ADMIN_API_KEY',
|
|
176
|
+
parseVal: val => val === 'true' || val === '1',
|
|
177
|
+
},
|
|
178
|
+
{
|
|
179
|
+
flag: '--node-debug',
|
|
180
|
+
description: 'Expose debug endpoints (e.g. mineBlock) on the main RPC port',
|
|
181
|
+
defaultValue: false,
|
|
182
|
+
env: 'AZTEC_NODE_DEBUG',
|
|
183
|
+
parseVal: val => val === undefined || val === 'true' || val === '1',
|
|
184
|
+
},
|
|
151
185
|
{
|
|
152
186
|
flag: '--api-prefix <value>',
|
|
153
187
|
description: 'Prefix for API routes on any service that is started',
|
|
154
188
|
defaultValue: '',
|
|
155
189
|
env: 'API_PREFIX',
|
|
156
190
|
},
|
|
191
|
+
configToFlag('--rpcMaxBatchSize', nodeRpcConfigMappings.rpcMaxBatchSize),
|
|
192
|
+
configToFlag('--rpcMaxBodySize', nodeRpcConfigMappings.rpcMaxBodySize),
|
|
157
193
|
],
|
|
158
194
|
ETHEREUM: [
|
|
159
195
|
configToFlag('--l1-chain-id', l1ReaderConfigMappings.l1ChainId),
|
|
160
196
|
// Do not set default for CLI: keep undefined unless provided via flag or env
|
|
161
197
|
configToFlag('--l1-rpc-urls', { ...l1ReaderConfigMappings.l1RpcUrls, defaultValue: undefined }),
|
|
162
|
-
configToFlag('--l1-consensus-host-urls',
|
|
163
|
-
configToFlag('--l1-consensus-host-api-keys',
|
|
164
|
-
configToFlag('--l1-consensus-host-api-key-headers',
|
|
198
|
+
configToFlag('--l1-consensus-host-urls', blobClientConfigMapping.l1ConsensusHostUrls),
|
|
199
|
+
configToFlag('--l1-consensus-host-api-keys', blobClientConfigMapping.l1ConsensusHostApiKeys),
|
|
200
|
+
configToFlag('--l1-consensus-host-api-key-headers', blobClientConfigMapping.l1ConsensusHostApiKeyHeaders),
|
|
165
201
|
],
|
|
166
202
|
'L1 CONTRACTS': [
|
|
167
203
|
configToFlag('--registry-address', l1ContractAddressesMapping.registryAddress),
|
|
@@ -174,7 +210,7 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
174
210
|
'WORLD STATE': [
|
|
175
211
|
configToFlag('--world-state-data-directory', worldStateConfigMappings.worldStateDataDirectory),
|
|
176
212
|
configToFlag('--world-state-db-map-size-kb', worldStateConfigMappings.worldStateDbMapSizeKb),
|
|
177
|
-
configToFlag('--world-state-
|
|
213
|
+
configToFlag('--world-state-checkpoint-history', worldStateConfigMappings.worldStateCheckpointHistory),
|
|
178
214
|
],
|
|
179
215
|
// We can't easily auto-generate node options as they're parts of modules defined below
|
|
180
216
|
'AZTEC NODE': [
|
|
@@ -208,21 +244,13 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
208
244
|
'sequencer',
|
|
209
245
|
omitConfigMappings(sequencerClientConfigMappings, [
|
|
210
246
|
'fakeProcessingDelayPerTxMs',
|
|
247
|
+
'fakeThrowAfterProcessingTxCount',
|
|
211
248
|
'skipCollectingAttestations',
|
|
212
249
|
'skipInvalidateBlockAsProposer',
|
|
213
250
|
'blobSinkMapSizeKb',
|
|
214
251
|
]),
|
|
215
252
|
),
|
|
216
253
|
],
|
|
217
|
-
'BLOB SINK': [
|
|
218
|
-
{
|
|
219
|
-
flag: '--blob-sink',
|
|
220
|
-
description: 'Starts Aztec Blob Sink with options',
|
|
221
|
-
defaultValue: undefined,
|
|
222
|
-
env: undefined,
|
|
223
|
-
},
|
|
224
|
-
...getOptions('blobSink', blobSinkConfigMappings),
|
|
225
|
-
],
|
|
226
254
|
'PROVER NODE': [
|
|
227
255
|
{
|
|
228
256
|
flag: '--prover-node',
|
|
@@ -234,12 +262,8 @@ export const aztecStartOptions: { [key: string]: AztecStartOption[] } = {
|
|
|
234
262
|
'proverNode',
|
|
235
263
|
omitConfigMappings(proverNodeConfigMappings, [
|
|
236
264
|
// filter out options passed separately
|
|
237
|
-
...getKeys(archiverConfigMappings),
|
|
238
265
|
...getKeys(proverBrokerConfigMappings),
|
|
239
266
|
...getKeys(proverAgentConfigMappings),
|
|
240
|
-
...getKeys(p2pConfigMappings),
|
|
241
|
-
...getKeys(worldStateConfigMappings),
|
|
242
|
-
...getKeys(sharedNodeConfigMappings),
|
|
243
267
|
]),
|
|
244
268
|
),
|
|
245
269
|
],
|
package/src/cli/cli.ts
CHANGED
|
@@ -31,63 +31,18 @@ export function injectAztecCommands(program: Command, userLog: LogFn, debugLogge
|
|
|
31
31
|
|
|
32
32
|
program.configureHelp({ sortSubcommands: true });
|
|
33
33
|
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
--contract Use a contract template (default)
|
|
44
|
-
--lib Use a library template
|
|
45
|
-
--bin Use a binary template
|
|
46
|
-
Examples:
|
|
47
|
-
$ aztec init # creates a contract project in current directory
|
|
48
|
-
$ aztec init --lib # creates a library project
|
|
49
|
-
|
|
50
|
-
new <path> [options]: creates a new Noir project in a new directory
|
|
51
|
-
Options:
|
|
52
|
-
--name <name> Name of the package
|
|
53
|
-
--contract Use a contract template (default)
|
|
54
|
-
--lib Use a library template
|
|
55
|
-
--bin Use a binary template
|
|
56
|
-
Examples:
|
|
57
|
-
$ aztec new my-project # creates a contract project in ./my-project
|
|
58
|
-
$ aztec new my-lib --lib # creates a library project in ./my-lib
|
|
59
|
-
|
|
60
|
-
compile [options]: compiles Aztec Noir contracts
|
|
61
|
-
Compiles contracts with nargo compile and then postprocesses them to generate Aztec-specific artifacts including:
|
|
62
|
-
- Transpiled contract artifacts
|
|
63
|
-
- Verification keys
|
|
64
|
-
The compiled contracts will be placed in the target/ directory by default.
|
|
65
|
-
Supports standard nargo compile options.
|
|
66
|
-
|
|
67
|
-
fmt [options]: formats Noir code using nargo fmt
|
|
68
|
-
Example:
|
|
69
|
-
$ aztec fmt # formats all Noir files in the project
|
|
70
|
-
|
|
71
|
-
check [options]: type-checks Noir code without compiling using nargo check
|
|
72
|
-
Example:
|
|
73
|
-
$ aztec check # checks all Noir files in the project
|
|
74
|
-
|
|
75
|
-
test [options]: starts a dockerized TXE node via
|
|
76
|
-
$ aztec start --txe
|
|
77
|
-
then runs
|
|
78
|
-
$ aztec test --silence-warnings --oracle-resolver=<TXE_ADDRESS> [options]
|
|
79
|
-
|
|
80
|
-
lsp: starts the Nargo Language Server Protocol server
|
|
81
|
-
Runs nargo lsp in a Docker container for IDE integration with Noir.
|
|
82
|
-
This command is typically used by IDE extensions and not called directly by users.
|
|
83
|
-
Example:
|
|
84
|
-
$ aztec lsp # starts the LSP server
|
|
85
|
-
|
|
86
|
-
preload-crs: Downloads and caches the Common Reference String (CRS) data required for zero-knowledge proofs.
|
|
87
|
-
Example:
|
|
88
|
-
$ aztec preload-crs # preloads CRS data
|
|
34
|
+
if (process.env.AZTEC_SHELL_WRAPPER) {
|
|
35
|
+
program.addHelpText(
|
|
36
|
+
'after',
|
|
37
|
+
`
|
|
38
|
+
Additional commands:
|
|
39
|
+
|
|
40
|
+
init creates a new Aztec Noir workspace in the current directory.
|
|
41
|
+
new <name> creates a new Aztec Noir workspace in its own directory (or creates a new contract-test crates pair and adds it to the current workspace if run in workspace).
|
|
42
|
+
test [options] starts a TXE and runs "nargo test" using it as the oracle resolver.
|
|
89
43
|
`,
|
|
90
|
-
|
|
44
|
+
);
|
|
45
|
+
}
|
|
91
46
|
|
|
92
47
|
program
|
|
93
48
|
.command('preload-crs')
|
|
@@ -0,0 +1,178 @@
|
|
|
1
|
+
import { findBbBinary } from '@aztec/bb.js';
|
|
2
|
+
import type { LogFn } from '@aztec/foundation/log';
|
|
3
|
+
|
|
4
|
+
import { execFileSync } from 'child_process';
|
|
5
|
+
import type { Command } from 'commander';
|
|
6
|
+
import { readFile } from 'fs/promises';
|
|
7
|
+
import { join } from 'path';
|
|
8
|
+
|
|
9
|
+
import { readArtifactFiles } from './utils/artifacts.js';
|
|
10
|
+
import { needsRecompile } from './utils/needs_recompile.js';
|
|
11
|
+
import { run } from './utils/spawn.js';
|
|
12
|
+
import { warnIfAztecVersionMismatch } from './utils/warn_if_aztec_version_mismatch.js';
|
|
13
|
+
|
|
14
|
+
/** Returns paths to contract artifacts in the target directory. */
|
|
15
|
+
async function collectContractArtifacts(): Promise<string[]> {
|
|
16
|
+
let files;
|
|
17
|
+
try {
|
|
18
|
+
files = await readArtifactFiles('target');
|
|
19
|
+
} catch (err: any) {
|
|
20
|
+
if (err?.message?.includes('does not exist')) {
|
|
21
|
+
return [];
|
|
22
|
+
}
|
|
23
|
+
throw err;
|
|
24
|
+
}
|
|
25
|
+
return files.filter(f => Array.isArray(f.content.functions)).map(f => f.filePath);
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
/** Returns the set of package names that are contract crates in the current workspace. */
|
|
29
|
+
async function getContractPackageNames(): Promise<Set<string>> {
|
|
30
|
+
const contractNames = new Set<string>();
|
|
31
|
+
|
|
32
|
+
let rootToml: string;
|
|
33
|
+
try {
|
|
34
|
+
rootToml = await readFile('Nargo.toml', 'utf-8');
|
|
35
|
+
} catch {
|
|
36
|
+
return contractNames;
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
const membersMatch = rootToml.match(/members\s*=\s*\[([^\]]*)\]/);
|
|
40
|
+
if (membersMatch) {
|
|
41
|
+
const members = membersMatch[1]
|
|
42
|
+
.split(',')
|
|
43
|
+
.map(m => m.trim().replace(/^"|"$/g, ''))
|
|
44
|
+
.filter(m => m.length > 0);
|
|
45
|
+
|
|
46
|
+
for (const member of members) {
|
|
47
|
+
try {
|
|
48
|
+
const memberToml = await readFile(join(member, 'Nargo.toml'), 'utf-8');
|
|
49
|
+
if (/type\s*=\s*"contract"/.test(memberToml)) {
|
|
50
|
+
const nameMatch = memberToml.match(/name\s*=\s*"([^"]+)"/);
|
|
51
|
+
if (nameMatch) {
|
|
52
|
+
contractNames.add(nameMatch[1]);
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
} catch {
|
|
56
|
+
// Member directory might not exist or have no Nargo.toml; skip.
|
|
57
|
+
}
|
|
58
|
+
}
|
|
59
|
+
} else {
|
|
60
|
+
// Single-crate project (no workspace): check if the root Nargo.toml itself is a contract.
|
|
61
|
+
if (/type\s*=\s*"contract"/.test(rootToml)) {
|
|
62
|
+
const nameMatch = rootToml.match(/name\s*=\s*"([^"]+)"/);
|
|
63
|
+
if (nameMatch) {
|
|
64
|
+
contractNames.add(nameMatch[1]);
|
|
65
|
+
}
|
|
66
|
+
}
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
return contractNames;
|
|
70
|
+
}
|
|
71
|
+
|
|
72
|
+
/** Checks that no tests exist in contract crates and fails with a helpful message if they do. */
|
|
73
|
+
async function checkNoTestsInContracts(nargo: string, log: LogFn): Promise<void> {
|
|
74
|
+
const contractPackages = await getContractPackageNames();
|
|
75
|
+
if (contractPackages.size === 0) {
|
|
76
|
+
return;
|
|
77
|
+
}
|
|
78
|
+
|
|
79
|
+
let output: string;
|
|
80
|
+
try {
|
|
81
|
+
// We list tests for all the crates in the workspace
|
|
82
|
+
output = execFileSync(nargo, ['test', '--list-tests', '--silence-warnings'], {
|
|
83
|
+
encoding: 'utf-8',
|
|
84
|
+
stdio: ['pipe', 'pipe', 'inherit'],
|
|
85
|
+
});
|
|
86
|
+
} catch {
|
|
87
|
+
// If listing tests fails (e.g. test crate has compile errors), skip the check.
|
|
88
|
+
return;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
// The output of the `nargo test --list-tests` command is as follows:
|
|
92
|
+
// ```
|
|
93
|
+
// crate_name_1 test_name_1
|
|
94
|
+
// crate_name_2 test_name_2
|
|
95
|
+
// ...
|
|
96
|
+
// crate_name_n test_name_n
|
|
97
|
+
// ```
|
|
98
|
+
//
|
|
99
|
+
// We parse the individual lines and then we check if any contract crate appeared in the parsed output.
|
|
100
|
+
const lines = output
|
|
101
|
+
.trim()
|
|
102
|
+
.split('\n')
|
|
103
|
+
.filter(line => line.length > 0);
|
|
104
|
+
const testsInContracts: { packageName: string; testName: string }[] = [];
|
|
105
|
+
|
|
106
|
+
for (const line of lines) {
|
|
107
|
+
const spaceIndex = line.indexOf(' ');
|
|
108
|
+
if (spaceIndex === -1) {
|
|
109
|
+
continue;
|
|
110
|
+
}
|
|
111
|
+
const packageName = line.substring(0, spaceIndex);
|
|
112
|
+
const testName = line.substring(spaceIndex + 1);
|
|
113
|
+
if (contractPackages.has(packageName)) {
|
|
114
|
+
testsInContracts.push({ packageName, testName });
|
|
115
|
+
}
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
if (testsInContracts.length > 0) {
|
|
119
|
+
const details = testsInContracts.map(t => ` ${t.packageName}::${t.testName}`).join('\n');
|
|
120
|
+
log(
|
|
121
|
+
`WARNING: Found tests in contract crate(s):\n${details}\n\n` +
|
|
122
|
+
`Tests should be in a dedicated test crate, not in the contract crate.\n` +
|
|
123
|
+
`Learn more: https://docs.aztec.network/errors/1`,
|
|
124
|
+
);
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
/** Compiles Aztec Noir contracts and postprocesses artifacts. */
|
|
129
|
+
async function compileAztecContract(nargoArgs: string[], log: LogFn): Promise<void> {
|
|
130
|
+
await warnIfAztecVersionMismatch(log);
|
|
131
|
+
|
|
132
|
+
if (!(await needsRecompile())) {
|
|
133
|
+
log('No source changes detected, skipping compilation.');
|
|
134
|
+
return;
|
|
135
|
+
}
|
|
136
|
+
|
|
137
|
+
const nargo = process.env.NARGO ?? 'nargo';
|
|
138
|
+
const bb = process.env.BB ?? findBbBinary() ?? 'bb';
|
|
139
|
+
|
|
140
|
+
await run(nargo, ['compile', ...nargoArgs]);
|
|
141
|
+
|
|
142
|
+
// Ensure contract crates contain no tests (tests belong in the test crate).
|
|
143
|
+
await checkNoTestsInContracts(nargo, log);
|
|
144
|
+
|
|
145
|
+
const artifacts = await collectContractArtifacts();
|
|
146
|
+
|
|
147
|
+
if (artifacts.length > 0) {
|
|
148
|
+
log('Postprocessing contracts...');
|
|
149
|
+
const bbArgs = artifacts.flatMap(a => ['-i', a]);
|
|
150
|
+
await run(bb, ['aztec_process', ...bbArgs]);
|
|
151
|
+
}
|
|
152
|
+
|
|
153
|
+
log('Compilation complete!');
|
|
154
|
+
}
|
|
155
|
+
|
|
156
|
+
export function injectCompileCommand(program: Command, log: LogFn): Command {
|
|
157
|
+
program
|
|
158
|
+
.command('compile')
|
|
159
|
+
.argument('[nargo-args...]')
|
|
160
|
+
.passThroughOptions()
|
|
161
|
+
.allowUnknownOption()
|
|
162
|
+
.description(
|
|
163
|
+
'Compile Aztec Noir contracts using nargo and postprocess them to generate transpiled artifacts and verification keys. All options are forwarded to nargo compile.',
|
|
164
|
+
)
|
|
165
|
+
.addHelpText('after', () => {
|
|
166
|
+
// Show nargo's own compile options so users see all available flags in one place.
|
|
167
|
+
const nargo = process.env.NARGO ?? 'nargo';
|
|
168
|
+
try {
|
|
169
|
+
const output = execFileSync(nargo, ['compile', '--help'], { encoding: 'utf-8' });
|
|
170
|
+
return `\nUnderlying nargo compile options:\n\n${output}`;
|
|
171
|
+
} catch {
|
|
172
|
+
return '\n(Run "nargo compile --help" to see available nargo options)';
|
|
173
|
+
}
|
|
174
|
+
})
|
|
175
|
+
.action((nargoArgs: string[]) => compileAztecContract(nargoArgs, log));
|
|
176
|
+
|
|
177
|
+
return program;
|
|
178
|
+
}
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
import { runMigrations } from '@aztec/validator-ha-signer/migrations';
|
|
2
|
+
|
|
3
|
+
import type { Command } from 'commander';
|
|
4
|
+
|
|
5
|
+
export function injectMigrateCommand(program: Command, log: (msg: string) => void): Command {
|
|
6
|
+
const migrateCommand = program.command('migrate-ha-db').description('Run validator-ha-signer database migrations');
|
|
7
|
+
|
|
8
|
+
migrateCommand
|
|
9
|
+
.command('up')
|
|
10
|
+
.description('Apply pending migrations')
|
|
11
|
+
.requiredOption('--database-url <string>', 'PostgreSQL connection string', process.env.DATABASE_URL)
|
|
12
|
+
.option('--verbose', 'Enable verbose output', false)
|
|
13
|
+
.action(async options => {
|
|
14
|
+
const migrations = await runMigrations(options.databaseUrl, {
|
|
15
|
+
direction: 'up',
|
|
16
|
+
verbose: options.verbose,
|
|
17
|
+
});
|
|
18
|
+
if (migrations.length > 0) {
|
|
19
|
+
log(`Applied migrations: ${migrations.join(', ')}`);
|
|
20
|
+
} else {
|
|
21
|
+
log('No migrations to apply - schema is up to date');
|
|
22
|
+
}
|
|
23
|
+
});
|
|
24
|
+
|
|
25
|
+
migrateCommand
|
|
26
|
+
.command('down')
|
|
27
|
+
.description('Rollback the last migration')
|
|
28
|
+
.requiredOption('--database-url <string>', 'PostgreSQL connection string', process.env.DATABASE_URL)
|
|
29
|
+
.option('--verbose', 'Enable verbose output', false)
|
|
30
|
+
.action(async options => {
|
|
31
|
+
const migrations = await runMigrations(options.databaseUrl, {
|
|
32
|
+
direction: 'down',
|
|
33
|
+
verbose: options.verbose,
|
|
34
|
+
});
|
|
35
|
+
if (migrations.length > 0) {
|
|
36
|
+
log(`Rolled back migrations: ${migrations.join(', ')}`);
|
|
37
|
+
} else {
|
|
38
|
+
log('No migrations to rollback');
|
|
39
|
+
}
|
|
40
|
+
});
|
|
41
|
+
|
|
42
|
+
return program;
|
|
43
|
+
}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import type { LogFn } from '@aztec/foundation/log';
|
|
2
|
+
|
|
3
|
+
import type { Command } from 'commander';
|
|
4
|
+
|
|
5
|
+
import { profileFlamegraph } from './profile_flamegraph.js';
|
|
6
|
+
import { profileGates } from './profile_gates.js';
|
|
7
|
+
|
|
8
|
+
export function injectProfileCommand(program: Command, log: LogFn): Command {
|
|
9
|
+
const profile = program.command('profile').description('Profile compiled Aztec artifacts.');
|
|
10
|
+
|
|
11
|
+
profile
|
|
12
|
+
.command('gates')
|
|
13
|
+
.argument('[target-dir]', 'Path to the compiled artifacts directory', './target')
|
|
14
|
+
.description('Display gate counts for all compiled Aztec artifacts in a target directory.')
|
|
15
|
+
.action((targetDir: string) => profileGates(targetDir, log));
|
|
16
|
+
|
|
17
|
+
profile
|
|
18
|
+
.command('flamegraph')
|
|
19
|
+
.argument('<contract-artifact>', 'Path to the compiled contract artifact JSON')
|
|
20
|
+
.argument('<function>', 'Name of the contract function to profile')
|
|
21
|
+
.description('Generate a gate count flamegraph SVG for a contract function.')
|
|
22
|
+
.action((artifactPath: string, functionName: string) => profileFlamegraph(artifactPath, functionName, log));
|
|
23
|
+
|
|
24
|
+
return program;
|
|
25
|
+
}
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
import { findBbBinary } from '@aztec/bb.js';
|
|
2
|
+
import type { LogFn } from '@aztec/foundation/log';
|
|
3
|
+
|
|
4
|
+
import { readFile, rename, rm, writeFile } from 'fs/promises';
|
|
5
|
+
import { basename, dirname, join } from 'path';
|
|
6
|
+
|
|
7
|
+
import { makeFunctionArtifact } from './profile_utils.js';
|
|
8
|
+
import type { CompiledArtifact } from './utils/artifacts.js';
|
|
9
|
+
import { run } from './utils/spawn.js';
|
|
10
|
+
|
|
11
|
+
/** Generates a gate count flamegraph SVG for a single contract function. */
|
|
12
|
+
export async function profileFlamegraph(artifactPath: string, functionName: string, log: LogFn): Promise<void> {
|
|
13
|
+
const raw = await readFile(artifactPath, 'utf-8');
|
|
14
|
+
const artifact: CompiledArtifact = JSON.parse(raw);
|
|
15
|
+
|
|
16
|
+
if (!Array.isArray(artifact.functions)) {
|
|
17
|
+
throw new Error(`${artifactPath} does not appear to be a contract artifact (no functions array)`);
|
|
18
|
+
}
|
|
19
|
+
|
|
20
|
+
const func = artifact.functions.find(f => f.name === functionName);
|
|
21
|
+
if (!func) {
|
|
22
|
+
const available = artifact.functions.map(f => f.name).join(', ');
|
|
23
|
+
throw new Error(`Function "${functionName}" not found in artifact. Available: ${available}`);
|
|
24
|
+
}
|
|
25
|
+
if (func.is_unconstrained) {
|
|
26
|
+
throw new Error(`Function "${functionName}" is unconstrained and cannot be profiled`);
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
const outputDir = dirname(artifactPath);
|
|
30
|
+
const contractName = basename(artifactPath, '.json');
|
|
31
|
+
const functionArtifact = join(outputDir, `${contractName}-${functionName}.json`);
|
|
32
|
+
|
|
33
|
+
try {
|
|
34
|
+
await writeFile(functionArtifact, makeFunctionArtifact(artifact, func));
|
|
35
|
+
|
|
36
|
+
const profiler = process.env.PROFILER_PATH ?? 'noir-profiler';
|
|
37
|
+
const bb = process.env.BB ?? findBbBinary() ?? 'bb';
|
|
38
|
+
|
|
39
|
+
await run(profiler, [
|
|
40
|
+
'gates',
|
|
41
|
+
'--artifact-path',
|
|
42
|
+
functionArtifact,
|
|
43
|
+
'--backend-path',
|
|
44
|
+
bb,
|
|
45
|
+
'--backend-gates-command',
|
|
46
|
+
'gates',
|
|
47
|
+
'--output',
|
|
48
|
+
outputDir,
|
|
49
|
+
'--scheme',
|
|
50
|
+
'chonk',
|
|
51
|
+
'--include_gates_per_opcode',
|
|
52
|
+
]);
|
|
53
|
+
|
|
54
|
+
// noir-profiler names the SVG using the internal function name which
|
|
55
|
+
// retains the __aztec_nr_internals__ prefix in the bytecode metadata.
|
|
56
|
+
const srcSvg = join(outputDir, `__aztec_nr_internals__${functionName}_gates.svg`);
|
|
57
|
+
const destSvg = join(outputDir, `${contractName}-${functionName}-flamegraph.svg`);
|
|
58
|
+
await rename(srcSvg, destSvg);
|
|
59
|
+
|
|
60
|
+
log(`Flamegraph written to ${destSvg}`);
|
|
61
|
+
} finally {
|
|
62
|
+
await rm(functionArtifact, { force: true });
|
|
63
|
+
}
|
|
64
|
+
}
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
import { findBbBinary } from '@aztec/bb.js';
|
|
2
|
+
import { asyncPool } from '@aztec/foundation/async-pool';
|
|
3
|
+
import type { LogFn } from '@aztec/foundation/log';
|
|
4
|
+
|
|
5
|
+
import { execFile as execFileCb } from 'child_process';
|
|
6
|
+
import { rm } from 'fs/promises';
|
|
7
|
+
import { promisify } from 'util';
|
|
8
|
+
|
|
9
|
+
import { MAX_CONCURRENT, discoverArtifacts } from './profile_utils.js';
|
|
10
|
+
|
|
11
|
+
const execFile = promisify(execFileCb);
|
|
12
|
+
|
|
13
|
+
interface GateCountResult {
|
|
14
|
+
name: string;
|
|
15
|
+
gateCount: number;
|
|
16
|
+
}
|
|
17
|
+
|
|
18
|
+
/** Parses circuit_size from bb gates JSON output: { "functions": [{ "circuit_size": N }] } */
|
|
19
|
+
function parseGateCount(stdout: string): number {
|
|
20
|
+
const parsed = JSON.parse(stdout);
|
|
21
|
+
const size = parsed?.functions?.[0]?.circuit_size;
|
|
22
|
+
if (typeof size !== 'number') {
|
|
23
|
+
throw new Error('Failed to parse circuit_size from bb gates output');
|
|
24
|
+
}
|
|
25
|
+
return size;
|
|
26
|
+
}
|
|
27
|
+
|
|
28
|
+
/** Runs bb gates on a single artifact file and returns the gate count. */
|
|
29
|
+
async function getGateCount(bb: string, artifactPath: string): Promise<number> {
|
|
30
|
+
const { stdout } = await execFile(bb, ['gates', '--scheme', 'chonk', '-b', artifactPath]);
|
|
31
|
+
return parseGateCount(stdout);
|
|
32
|
+
}
|
|
33
|
+
|
|
34
|
+
/** Profiles all compiled artifacts in a target directory and prints gate counts. */
|
|
35
|
+
export async function profileGates(targetDir: string, log: LogFn): Promise<void> {
|
|
36
|
+
const bb = process.env.BB ?? findBbBinary() ?? 'bb';
|
|
37
|
+
const { artifacts, tmpDir } = await discoverArtifacts(targetDir);
|
|
38
|
+
|
|
39
|
+
if (artifacts.length === 0) {
|
|
40
|
+
log('No artifacts found in target directory.');
|
|
41
|
+
return;
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
try {
|
|
45
|
+
const results: GateCountResult[] = await asyncPool(MAX_CONCURRENT, artifacts, async artifact => ({
|
|
46
|
+
name: artifact.name,
|
|
47
|
+
gateCount: await getGateCount(bb, artifact.filePath),
|
|
48
|
+
}));
|
|
49
|
+
results.sort((a, b) => a.name.localeCompare(b.name));
|
|
50
|
+
|
|
51
|
+
if (results.length === 0) {
|
|
52
|
+
log('No constrained circuits found.');
|
|
53
|
+
return;
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
const maxNameLen = Math.max(...results.map(r => r.name.length));
|
|
57
|
+
log('');
|
|
58
|
+
log('Gate counts:');
|
|
59
|
+
log('-'.repeat(maxNameLen + 16));
|
|
60
|
+
for (const { name, gateCount } of results) {
|
|
61
|
+
log(`${name.padEnd(maxNameLen)} ${gateCount.toLocaleString().padStart(12)}`);
|
|
62
|
+
}
|
|
63
|
+
log('-'.repeat(maxNameLen + 16));
|
|
64
|
+
log(`Total: ${results.length} circuit(s)`);
|
|
65
|
+
} finally {
|
|
66
|
+
await rm(tmpDir, { recursive: true, force: true });
|
|
67
|
+
}
|
|
68
|
+
}
|