@aztec/aztec 0.0.1-commit.4ad48494d → 0.0.1-commit.4d3c002

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (126) hide show
  1. package/dest/bin/index.js +7 -3
  2. package/dest/cli/admin_api_key_store.d.ts +45 -0
  3. package/dest/cli/admin_api_key_store.d.ts.map +1 -0
  4. package/dest/cli/admin_api_key_store.js +98 -0
  5. package/dest/cli/aztec_start_action.d.ts +1 -1
  6. package/dest/cli/aztec_start_action.d.ts.map +1 -1
  7. package/dest/cli/aztec_start_action.js +61 -16
  8. package/dest/cli/aztec_start_options.d.ts +1 -1
  9. package/dest/cli/aztec_start_options.d.ts.map +1 -1
  10. package/dest/cli/aztec_start_options.js +25 -9
  11. package/dest/cli/cli.d.ts +1 -1
  12. package/dest/cli/cli.d.ts.map +1 -1
  13. package/dest/cli/cli.js +3 -4
  14. package/dest/cli/cmds/compile.d.ts +4 -0
  15. package/dest/cli/cmds/compile.d.ts.map +1 -0
  16. package/dest/cli/cmds/compile.js +168 -0
  17. package/dest/cli/cmds/profile.d.ts +4 -0
  18. package/dest/cli/cmds/profile.d.ts.map +1 -0
  19. package/dest/cli/cmds/profile.js +8 -0
  20. package/dest/cli/cmds/profile_flamegraph.d.ts +4 -0
  21. package/dest/cli/cmds/profile_flamegraph.d.ts.map +1 -0
  22. package/dest/cli/cmds/profile_flamegraph.js +52 -0
  23. package/dest/cli/cmds/profile_gates.d.ts +4 -0
  24. package/dest/cli/cmds/profile_gates.d.ts.map +1 -0
  25. package/dest/cli/cmds/profile_gates.js +58 -0
  26. package/dest/cli/cmds/profile_utils.d.ts +18 -0
  27. package/dest/cli/cmds/profile_utils.d.ts.map +1 -0
  28. package/dest/cli/cmds/profile_utils.js +50 -0
  29. package/dest/cli/cmds/standby.d.ts +32 -0
  30. package/dest/cli/cmds/standby.d.ts.map +1 -0
  31. package/dest/cli/cmds/standby.js +97 -0
  32. package/dest/cli/cmds/start_archiver.d.ts +2 -2
  33. package/dest/cli/cmds/start_archiver.d.ts.map +1 -1
  34. package/dest/cli/cmds/start_archiver.js +1 -1
  35. package/dest/cli/cmds/start_node.d.ts +3 -2
  36. package/dest/cli/cmds/start_node.d.ts.map +1 -1
  37. package/dest/cli/cmds/start_node.js +67 -25
  38. package/dest/cli/cmds/start_prover_agent.d.ts +1 -1
  39. package/dest/cli/cmds/start_prover_agent.d.ts.map +1 -1
  40. package/dest/cli/cmds/start_prover_agent.js +3 -15
  41. package/dest/cli/cmds/start_prover_broker.d.ts +1 -1
  42. package/dest/cli/cmds/start_prover_broker.d.ts.map +1 -1
  43. package/dest/cli/cmds/start_prover_broker.js +12 -6
  44. package/dest/cli/cmds/utils/artifacts.d.ts +21 -0
  45. package/dest/cli/cmds/utils/artifacts.d.ts.map +1 -0
  46. package/dest/cli/cmds/utils/artifacts.js +24 -0
  47. package/dest/cli/cmds/utils/collect_crate_dirs.d.ts +21 -0
  48. package/dest/cli/cmds/utils/collect_crate_dirs.d.ts.map +1 -0
  49. package/dest/cli/cmds/utils/collect_crate_dirs.js +114 -0
  50. package/dest/cli/cmds/utils/needs_recompile.d.ts +10 -0
  51. package/dest/cli/cmds/utils/needs_recompile.d.ts.map +1 -0
  52. package/dest/cli/cmds/utils/needs_recompile.js +90 -0
  53. package/dest/cli/cmds/utils/spawn.d.ts +3 -0
  54. package/dest/cli/cmds/utils/spawn.d.ts.map +1 -0
  55. package/dest/cli/cmds/utils/spawn.js +16 -0
  56. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.d.ts +4 -0
  57. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.d.ts.map +1 -0
  58. package/dest/cli/cmds/utils/warn_if_aztec_version_mismatch.js +41 -0
  59. package/dest/cli/util.d.ts +3 -5
  60. package/dest/cli/util.d.ts.map +1 -1
  61. package/dest/cli/util.js +40 -81
  62. package/dest/examples/token.js +4 -4
  63. package/dest/local-network/banana_fpc.js +1 -1
  64. package/dest/local-network/local-network.d.ts +3 -1
  65. package/dest/local-network/local-network.d.ts.map +1 -1
  66. package/dest/local-network/local-network.js +43 -9
  67. package/dest/testing/anvil_test_watcher.d.ts +9 -1
  68. package/dest/testing/anvil_test_watcher.d.ts.map +1 -1
  69. package/dest/testing/anvil_test_watcher.js +53 -16
  70. package/dest/testing/cheat_codes.js +1 -1
  71. package/dest/testing/epoch_test_settler.d.ts +1 -1
  72. package/dest/testing/epoch_test_settler.d.ts.map +1 -1
  73. package/dest/testing/epoch_test_settler.js +3 -4
  74. package/dest/testing/index.d.ts +2 -1
  75. package/dest/testing/index.d.ts.map +1 -1
  76. package/dest/testing/index.js +1 -0
  77. package/dest/testing/token_allowed_setup.d.ts +7 -0
  78. package/dest/testing/token_allowed_setup.d.ts.map +1 -0
  79. package/dest/testing/token_allowed_setup.js +20 -0
  80. package/package.json +34 -34
  81. package/scripts/add_crate.sh +102 -0
  82. package/scripts/aztec.sh +11 -5
  83. package/scripts/init.sh +23 -19
  84. package/scripts/new.sh +48 -24
  85. package/scripts/setup_workspace.sh +68 -0
  86. package/src/bin/index.ts +7 -3
  87. package/src/cli/admin_api_key_store.ts +128 -0
  88. package/src/cli/aztec_start_action.ts +60 -12
  89. package/src/cli/aztec_start_options.ts +27 -8
  90. package/src/cli/cli.ts +3 -4
  91. package/src/cli/cmds/compile.ts +194 -0
  92. package/src/cli/cmds/profile.ts +25 -0
  93. package/src/cli/cmds/profile_flamegraph.ts +64 -0
  94. package/src/cli/cmds/profile_gates.ts +68 -0
  95. package/src/cli/cmds/profile_utils.ts +58 -0
  96. package/src/cli/cmds/standby.ts +132 -0
  97. package/src/cli/cmds/start_archiver.ts +1 -1
  98. package/src/cli/cmds/start_node.ts +81 -31
  99. package/src/cli/cmds/start_prover_agent.ts +3 -6
  100. package/src/cli/cmds/start_prover_broker.ts +14 -14
  101. package/src/cli/cmds/utils/artifacts.ts +44 -0
  102. package/src/cli/cmds/utils/collect_crate_dirs.ts +118 -0
  103. package/src/cli/cmds/utils/needs_recompile.ts +98 -0
  104. package/src/cli/cmds/utils/spawn.ts +16 -0
  105. package/src/cli/cmds/utils/warn_if_aztec_version_mismatch.ts +54 -0
  106. package/src/cli/util.ts +43 -76
  107. package/src/examples/token.ts +6 -4
  108. package/src/local-network/banana_fpc.ts +1 -1
  109. package/src/local-network/local-network.ts +51 -10
  110. package/src/testing/anvil_test_watcher.ts +60 -16
  111. package/src/testing/cheat_codes.ts +1 -1
  112. package/src/testing/epoch_test_settler.ts +3 -4
  113. package/src/testing/index.ts +1 -0
  114. package/src/testing/token_allowed_setup.ts +19 -0
  115. package/dest/cli/cmds/start_prover_node.d.ts +0 -7
  116. package/dest/cli/cmds/start_prover_node.d.ts.map +0 -1
  117. package/dest/cli/cmds/start_prover_node.js +0 -108
  118. package/dest/cli/release_version.d.ts +0 -2
  119. package/dest/cli/release_version.d.ts.map +0 -1
  120. package/dest/cli/release_version.js +0 -14
  121. package/scripts/compile.sh +0 -44
  122. package/scripts/extract_function.js +0 -47
  123. package/scripts/flamegraph.sh +0 -59
  124. package/scripts/setup_project.sh +0 -31
  125. package/src/cli/cmds/start_prover_node.ts +0 -124
  126. package/src/cli/release_version.ts +0 -21
@@ -1,30 +1,40 @@
1
- import { getInitialTestAccountsData } from '@aztec/accounts/testing';
2
1
  import { type AztecNodeConfig, aztecNodeConfigMappings, getConfigEnvVars } from '@aztec/aztec-node';
3
2
  import { Fr } from '@aztec/aztec.js/fields';
4
- import { getSponsoredFPCAddress } from '@aztec/cli/cli-utils';
5
3
  import { getL1Config } from '@aztec/cli/config';
6
4
  import { getPublicClient } from '@aztec/ethereum/client';
7
- import { SecretValue } from '@aztec/foundation/config';
5
+ import { getGenesisStateConfigEnvVars } from '@aztec/ethereum/config';
6
+ import { type NetworkNames, SecretValue } from '@aztec/foundation/config';
8
7
  import type { NamespacedApiHandlers } from '@aztec/foundation/json-rpc/server';
8
+ import { Agent, makeUndiciFetch } from '@aztec/foundation/json-rpc/undici';
9
9
  import type { LogFn } from '@aztec/foundation/log';
10
+ import { getVKTreeRoot } from '@aztec/noir-protocol-circuits-types/vk-tree';
11
+ import { protocolContractsHash } from '@aztec/protocol-contracts';
12
+ import {
13
+ ProvingJobConsumerSchema,
14
+ createProvingJobBrokerClient,
15
+ proverBrokerBackoff,
16
+ } from '@aztec/prover-client/broker';
10
17
  import { type CliPXEOptions, type PXEConfig, allPxeConfigMappings } from '@aztec/pxe/config';
11
18
  import { AztecNodeAdminApiSchema, AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
12
- import { P2PApiSchema } from '@aztec/stdlib/interfaces/server';
19
+ import { P2PApiSchema, ProverNodeApiSchema, type ProvingJobBroker } from '@aztec/stdlib/interfaces/server';
13
20
  import {
14
21
  type TelemetryClientConfig,
15
22
  initTelemetryClient,
23
+ makeTracedFetch,
16
24
  telemetryClientConfigMappings,
17
25
  } from '@aztec/telemetry-client';
18
26
  import { EmbeddedWallet } from '@aztec/wallets/embedded';
19
- import { getGenesisValues } from '@aztec/world-state/testing';
20
27
 
21
28
  import { createAztecNode } from '../../local-network/index.js';
22
29
  import {
23
30
  extractNamespacedOptions,
24
31
  extractRelevantOptions,
25
32
  preloadCrsDataForVerifying,
26
- setupUpdateMonitor,
33
+ setupVersionChecker,
27
34
  } from '../util.js';
35
+ import { getVersions } from '../versioning.js';
36
+ import { computeExpectedGenesisRoot, waitForCompatibleRollup } from './standby.js';
37
+ import { startProverBroker } from './start_prover_broker.js';
28
38
 
29
39
  export async function startNode(
30
40
  options: any,
@@ -32,6 +42,7 @@ export async function startNode(
32
42
  services: NamespacedApiHandlers,
33
43
  adminServices: NamespacedApiHandlers,
34
44
  userLog: LogFn,
45
+ networkName: NetworkNames,
35
46
  ): Promise<{ config: AztecNodeConfig }> {
36
47
  // All options set from environment variables
37
48
  const configFromEnvVars = getConfigEnvVars();
@@ -45,22 +56,34 @@ export async function startNode(
45
56
  ...relevantOptions,
46
57
  };
47
58
 
59
+ // Prover node configuration and broker setup
60
+ // REFACTOR: Move the broker setup out of here and into the prover-node factory
61
+ let broker: ProvingJobBroker | undefined = undefined;
48
62
  if (options.proverNode) {
49
- userLog(`Running a Prover Node within a Node is not yet supported`);
50
- process.exit(1);
63
+ nodeConfig.enableProverNode = true;
64
+ if (nodeConfig.proverAgentCount === 0) {
65
+ userLog(
66
+ `Running prover node without local prover agent. Connect prover agents or pass --proverAgent.proverAgentCount`,
67
+ );
68
+ }
69
+ if (nodeConfig.proverBrokerUrl) {
70
+ // at 1TPS we'd enqueue ~1k chonk verifier proofs and ~1k AVM proofs immediately
71
+ // set a lower connection limit such that we don't overload the server
72
+ // Retry indefinitely until the epoch proving times out and the chain reorgs
73
+ const fetch = makeTracedFetch(proverBrokerBackoff, false, makeUndiciFetch(new Agent({ connections: 100 })));
74
+ broker = createProvingJobBrokerClient(nodeConfig.proverBrokerUrl, getVersions(nodeConfig), fetch);
75
+ } else if (options.proverBroker) {
76
+ ({ broker } = await startProverBroker(options, signalHandlers, services, userLog));
77
+ } else {
78
+ userLog(`--prover-broker-url or --prover-broker is required to start a Prover Node`);
79
+ process.exit(1);
80
+ }
51
81
  }
52
82
 
53
83
  await preloadCrsDataForVerifying(nodeConfig, userLog);
54
84
 
55
- const testAccounts = nodeConfig.testAccounts ? (await getInitialTestAccountsData()).map(a => a.address) : [];
56
- const sponsoredFPCAccounts = nodeConfig.sponsoredFPC ? [await getSponsoredFPCAddress()] : [];
57
- const initialFundedAccounts = testAccounts.concat(sponsoredFPCAccounts);
58
-
59
- userLog(`Initial funded accounts: ${initialFundedAccounts.map(a => a.toString()).join(', ')}`);
60
-
61
- const { genesisArchiveRoot, prefilledPublicData } = await getGenesisValues(initialFundedAccounts);
62
-
63
- userLog(`Genesis archive root: ${genesisArchiveRoot.toString()}`);
85
+ const genesisConfig = getGenesisStateConfigEnvVars();
86
+ const { genesisArchiveRoot, prefilledPublicData } = await computeExpectedGenesisRoot(genesisConfig, userLog);
64
87
 
65
88
  const followsCanonicalRollup =
66
89
  typeof nodeConfig.rollupVersion !== 'number' || (nodeConfig.rollupVersion as unknown as string) === 'canonical';
@@ -68,6 +91,16 @@ export async function startNode(
68
91
  if (!nodeConfig.l1Contracts.registryAddress || nodeConfig.l1Contracts.registryAddress.isZero()) {
69
92
  throw new Error('L1 registry address is required to start Aztec Node');
70
93
  }
94
+
95
+ // Wait for a compatible rollup before proceeding with full L1 config fetch.
96
+ // This prevents crashes when the canonical rollup hasn't been upgraded yet.
97
+ await waitForCompatibleRollup(
98
+ nodeConfig,
99
+ { genesisArchiveRoot, vkTreeRoot: getVKTreeRoot(), protocolContractsHash },
100
+ options.port,
101
+ userLog,
102
+ );
103
+
71
104
  const { addresses, config } = await getL1Config(
72
105
  nodeConfig.l1Contracts.registryAddress,
73
106
  nodeConfig.l1RpcUrls,
@@ -101,12 +134,17 @@ export async function startNode(
101
134
  ...extractNamespacedOptions(options, 'sequencer'),
102
135
  };
103
136
  // If no publisher private keys have been given, use the first validator key
104
- if (sequencerConfig.publisherPrivateKeys === undefined || !sequencerConfig.publisherPrivateKeys.length) {
137
+ if (
138
+ sequencerConfig.sequencerPublisherPrivateKeys === undefined ||
139
+ !sequencerConfig.sequencerPublisherPrivateKeys.length
140
+ ) {
105
141
  if (sequencerConfig.validatorPrivateKeys?.getValue().length) {
106
- sequencerConfig.publisherPrivateKeys = [new SecretValue(sequencerConfig.validatorPrivateKeys.getValue()[0])];
142
+ sequencerConfig.sequencerPublisherPrivateKeys = [
143
+ new SecretValue(sequencerConfig.validatorPrivateKeys.getValue()[0]),
144
+ ];
107
145
  }
108
146
  }
109
- nodeConfig.publisherPrivateKeys = sequencerConfig.publisherPrivateKeys;
147
+ nodeConfig.sequencerPublisherPrivateKeys = sequencerConfig.sequencerPublisherPrivateKeys;
110
148
  }
111
149
 
112
150
  if (nodeConfig.p2pEnabled) {
@@ -120,13 +158,22 @@ export async function startNode(
120
158
  const telemetry = await initTelemetryClient(telemetryConfig);
121
159
 
122
160
  // Create and start Aztec Node
123
- const node = await createAztecNode(nodeConfig, { telemetry }, { prefilledPublicData });
161
+ const node = await createAztecNode(nodeConfig, { telemetry, proverBroker: broker }, { prefilledPublicData });
124
162
 
125
163
  // Add node and p2p to services list
126
164
  services.node = [node, AztecNodeApiSchema];
127
165
  services.p2p = [node.getP2P(), P2PApiSchema];
128
166
  adminServices.nodeAdmin = [node, AztecNodeAdminApiSchema];
129
167
 
168
+ // Register prover-node services if the prover node subsystem is running
169
+ const proverNode = node.getProverNode();
170
+ if (proverNode) {
171
+ services.prover = [proverNode, ProverNodeApiSchema];
172
+ if (!nodeConfig.proverBrokerUrl) {
173
+ services.provingJobSource = [proverNode.getProver().getProvingJobSource(), ProvingJobConsumerSchema];
174
+ }
175
+ }
176
+
130
177
  // Add node stop function to signal handlers
131
178
  signalHandlers.push(node.stop.bind(node));
132
179
 
@@ -140,16 +187,19 @@ export async function startNode(
140
187
  await addBot(options, signalHandlers, services, wallet, node, telemetry, undefined);
141
188
  }
142
189
 
143
- if (nodeConfig.autoUpdate !== 'disabled' && nodeConfig.autoUpdateUrl) {
144
- await setupUpdateMonitor(
145
- nodeConfig.autoUpdate,
146
- new URL(nodeConfig.autoUpdateUrl),
147
- followsCanonicalRollup,
148
- getPublicClient(nodeConfig!),
149
- nodeConfig.l1Contracts.registryAddress,
150
- signalHandlers,
151
- async config => node.setConfig((await AztecNodeAdminApiSchema.setConfig.parameters().parseAsync([config]))[0]),
152
- );
190
+ if (nodeConfig.enableVersionCheck && networkName !== 'local') {
191
+ const cacheDir = process.env.DATA_DIRECTORY ? `${process.env.DATA_DIRECTORY}/cache` : undefined;
192
+ try {
193
+ await setupVersionChecker(
194
+ networkName,
195
+ followsCanonicalRollup,
196
+ getPublicClient(nodeConfig!),
197
+ signalHandlers,
198
+ cacheDir,
199
+ );
200
+ } catch {
201
+ /* no-op */
202
+ }
153
203
  }
154
204
 
155
205
  return { config: nodeConfig };
@@ -9,6 +9,7 @@ import {
9
9
  createProofStore,
10
10
  createProvingJobBrokerClient,
11
11
  proverAgentConfigMappings,
12
+ proverBrokerBackoff,
12
13
  } from '@aztec/prover-client/broker';
13
14
  import { getProverNodeAgentConfigFromEnv } from '@aztec/prover-node';
14
15
  import { ProverAgentApiSchema } from '@aztec/stdlib/interfaces/server';
@@ -45,12 +46,8 @@ export async function startProverAgent(
45
46
 
46
47
  await preloadCrsDataForServerSideProving(config, userLog);
47
48
 
48
- const fetch = makeTracedFetch(
49
- // retry connections every 3s, up to 30s before giving up
50
- [1, 2, 3, 3, 3, 3, 3, 3, 3, 3, 3],
51
- false,
52
- makeUndiciFetch(new Agent({ connections: 10 })),
53
- );
49
+ // Retry indefinitely until the epoch proving times out and the chain reorgs
50
+ const fetch = makeTracedFetch(proverBrokerBackoff, false, makeUndiciFetch(new Agent({ connections: 10 })));
54
51
  const broker = createProvingJobBrokerClient(config.proverBrokerUrl, getVersions(), fetch);
55
52
 
56
53
  const telemetry = await initTelemetryClient(extractRelevantOptions(options, telemetryClientConfigMappings, 'tel'));
@@ -1,7 +1,9 @@
1
1
  import { getL1Config } from '@aztec/cli/config';
2
- import { getPublicClient } from '@aztec/ethereum/client';
2
+ import { getGenesisStateConfigEnvVars } from '@aztec/ethereum/config';
3
3
  import type { NamespacedApiHandlers } from '@aztec/foundation/json-rpc/server';
4
4
  import type { LogFn } from '@aztec/foundation/log';
5
+ import { getVKTreeRoot } from '@aztec/noir-protocol-circuits-types/vk-tree';
6
+ import { protocolContractsHash } from '@aztec/protocol-contracts';
5
7
  import {
6
8
  type ProverBrokerConfig,
7
9
  ProvingJobBrokerSchema,
@@ -13,7 +15,8 @@ import { getProverNodeBrokerConfigFromEnv } from '@aztec/prover-node';
13
15
  import type { ProvingJobBroker } from '@aztec/stdlib/interfaces/server';
14
16
  import { getConfigEnvVars as getTelemetryClientConfig, initTelemetryClient } from '@aztec/telemetry-client';
15
17
 
16
- import { extractRelevantOptions, setupUpdateMonitor } from '../util.js';
18
+ import { extractRelevantOptions } from '../util.js';
19
+ import { computeExpectedGenesisRoot, waitForCompatibleRollup } from './standby.js';
17
20
 
18
21
  export async function startProverBroker(
19
22
  options: any,
@@ -35,7 +38,15 @@ export async function startProverBroker(
35
38
  throw new Error('L1 registry address is required to start Aztec Node without --deploy-aztec-contracts option');
36
39
  }
37
40
 
38
- const followsCanonicalRollup = typeof config.rollupVersion !== 'number';
41
+ const genesisConfig = getGenesisStateConfigEnvVars();
42
+ const { genesisArchiveRoot } = await computeExpectedGenesisRoot(genesisConfig, userLog);
43
+ await waitForCompatibleRollup(
44
+ config,
45
+ { genesisArchiveRoot, vkTreeRoot: getVKTreeRoot(), protocolContractsHash },
46
+ options.port,
47
+ userLog,
48
+ );
49
+
39
50
  const { addresses, config: rollupConfig } = await getL1Config(
40
51
  config.l1Contracts.registryAddress,
41
52
  config.l1RpcUrls,
@@ -49,17 +60,6 @@ export async function startProverBroker(
49
60
  const client = await initTelemetryClient(getTelemetryClientConfig());
50
61
  const broker = await createAndStartProvingBroker(config, client);
51
62
 
52
- if (options.autoUpdate !== 'disabled' && options.autoUpdateUrl) {
53
- await setupUpdateMonitor(
54
- options.autoUpdate,
55
- new URL(options.autoUpdateUrl),
56
- followsCanonicalRollup,
57
- getPublicClient(config),
58
- config.l1Contracts.registryAddress,
59
- signalHandlers,
60
- );
61
- }
62
-
63
63
  services.proverBroker = [
64
64
  broker,
65
65
  config.proverBrokerDebugReplayEnabled ? ProvingJobBrokerSchemaWithDebug : ProvingJobBrokerSchema,
@@ -0,0 +1,44 @@
1
+ import { readFile, readdir } from 'fs/promises';
2
+ import { join } from 'path';
3
+
4
+ export interface CompiledArtifact {
5
+ noir_version: string;
6
+ file_map: unknown;
7
+ functions: ContractFunction[];
8
+ bytecode?: string;
9
+ }
10
+
11
+ export interface ContractFunction {
12
+ name: string;
13
+ abi: unknown;
14
+ bytecode: string;
15
+ debug_symbols: unknown;
16
+ is_unconstrained?: boolean;
17
+ }
18
+
19
+ export interface ArtifactFile {
20
+ name: string;
21
+ filePath: string;
22
+ content: CompiledArtifact;
23
+ }
24
+
25
+ /** Reads all JSON artifact files from a target directory and returns their parsed contents. */
26
+ export async function readArtifactFiles(targetDir: string): Promise<ArtifactFile[]> {
27
+ let entries: string[];
28
+ try {
29
+ entries = (await readdir(targetDir)).filter(f => f.endsWith('.json'));
30
+ } catch (err: any) {
31
+ if (err?.code === 'ENOENT') {
32
+ throw new Error(`Target directory '${targetDir}' does not exist. Compile first with 'aztec compile'.`);
33
+ }
34
+ throw err;
35
+ }
36
+
37
+ const artifacts: ArtifactFile[] = [];
38
+ for (const file of entries) {
39
+ const filePath = join(targetDir, file);
40
+ const content = JSON.parse(await readFile(filePath, 'utf-8')) as CompiledArtifact;
41
+ artifacts.push({ name: file.replace('.json', ''), filePath, content });
42
+ }
43
+ return artifacts;
44
+ }
@@ -0,0 +1,118 @@
1
+ import TOML from '@iarna/toml';
2
+ import { existsSync } from 'fs';
3
+ import { mkdir, readFile, stat } from 'fs/promises';
4
+ import { homedir } from 'os';
5
+ import { dirname, join, resolve } from 'path';
6
+
7
+ import { run } from './spawn.js';
8
+
9
+ /**
10
+ * Recursively collects crate directories starting from startCrateDir by following dependencies declared in Nargo.toml
11
+ * files.
12
+ *
13
+ * When `skipGitDeps` is false (default), git-based deps are followed and fetched into the nargo cache
14
+ * (`$HOME/nargo/<domain>/<repo-path>/<tag>`) if not already present.
15
+ *
16
+ * When `skipGitDeps` is true, git-based deps are ignored entirely.
17
+ */
18
+ export async function collectCrateDirs(startCrateDir: string, opts?: { skipGitDeps?: boolean }): Promise<string[]> {
19
+ const { skipGitDeps = false } = opts ?? {};
20
+ const visited = new Set<string>();
21
+
22
+ async function visit(crateDir: string): Promise<void> {
23
+ const absDir = resolve(crateDir);
24
+ if (visited.has(absDir)) {
25
+ return;
26
+ }
27
+ visited.add(absDir);
28
+
29
+ const tomlPath = join(absDir, 'Nargo.toml');
30
+ const content = await readFile(tomlPath, 'utf-8').catch(() => {
31
+ throw new Error(`Incorrectly defined dependency. Nargo.toml not found in ${absDir}`);
32
+ });
33
+
34
+ const parsed = TOML.parse(content) as Record<string, any>;
35
+ const members = (parsed.workspace as Record<string, any>)?.members as string[] | undefined;
36
+
37
+ // A Nargo.toml is either a workspace root (has workspace.members) or a single crate (has dependencies).
38
+ if (Array.isArray(members)) {
39
+ // The crate is a workspace root and has members defined so we visit the members
40
+ for (const member of members) {
41
+ await visit(resolve(absDir, member));
42
+ }
43
+ } else {
44
+ // Single crate — follow its deps
45
+ const deps = (parsed.dependencies as Record<string, any>) ?? {};
46
+ for (const dep of Object.values(deps)) {
47
+ if (!dep || typeof dep !== 'object') {
48
+ continue;
49
+ }
50
+ if (typeof dep.path === 'string') {
51
+ // Dependency contains "path" hence it's a local dependency. We just check it's a real directory and then we
52
+ // recursively search through it
53
+ const depPath = resolve(absDir, dep.path);
54
+ const s = await stat(depPath);
55
+ if (!s.isDirectory()) {
56
+ throw new Error(
57
+ `Dependency path "${dep.path}" in ${tomlPath} resolves to ${depPath} which is not a directory`,
58
+ );
59
+ }
60
+ await visit(depPath);
61
+ } else if (!skipGitDeps && typeof dep.git === 'string' && typeof dep.tag === 'string') {
62
+ // Dependency contains "git" hence it's a git dependency. We ensure it has been fetched and fetch it if
63
+ // it's not the case and then we recursively search through it.
64
+ await fetchAndVisit(dep.git, dep.tag, dep.directory);
65
+ }
66
+ }
67
+ }
68
+ }
69
+
70
+ async function fetchAndVisit(gitUrl: string, tag: string, directory?: string): Promise<void> {
71
+ // `directory` is set when the dep lives in a subdirectory of a repository, e.g.:
72
+ // aztec = { git = "https://github.com/AztecProtocol/aztec-packages", tag = "v0.82.0",
73
+ // directory = "noir-projects/aztec-nr/aztec" }
74
+ // In that case nargo clones the whole repo and the crate root is <cachePath>/<directory>.
75
+ const cachePath = nargoGitDepPath(gitUrl, tag);
76
+ const crateDir = directory ? join(cachePath, directory) : cachePath;
77
+ await ensureGitDepCached(gitUrl, tag, cachePath);
78
+ await visit(crateDir);
79
+ }
80
+
81
+ await visit(startCrateDir);
82
+ return [...visited];
83
+ }
84
+
85
+ /**
86
+ * Computes the local nargo cache path for a git dependency, mirroring nargo's own `git_dep_location` function.
87
+ * Path format: `$HOME/nargo/<domain>/<repo-path>/<tag>`
88
+ * e.g. `~/nargo/github.com/AztecProtocol/aztec-packages/v0.82.0`
89
+ *
90
+ * Source: noir/noir-repo/tooling/nargo_toml/src/git.rs
91
+ */
92
+ export function nargoGitDepPath(gitUrl: string, tag: string): string {
93
+ const url = new URL(gitUrl);
94
+ const domain = url.hostname;
95
+ const repoPath = url.pathname.replace(/^\//, '');
96
+ return join(process.env.HOME ?? homedir(), 'nargo', domain, repoPath, tag);
97
+ }
98
+
99
+ /**
100
+ * Ensures a git dep is present in the nargo cache, cloning it if it isn't. Mirrors nargo's `clone_git_repo`.
101
+ * If cloning fails (e.g. no network), throws with a message suggesting `nargo check` to prime the cache.
102
+ *
103
+ * Source: noir/noir-repo/tooling/nargo_toml/src/git.rs
104
+ */
105
+ async function ensureGitDepCached(gitUrl: string, tag: string, cachePath: string): Promise<void> {
106
+ if (existsSync(cachePath)) {
107
+ return;
108
+ }
109
+ await mkdir(dirname(cachePath), { recursive: true });
110
+ try {
111
+ await run('git', ['-c', 'advice.detachedHead=false', 'clone', '--depth', '1', '--branch', tag, gitUrl, cachePath]);
112
+ } catch (err: any) {
113
+ throw new Error(
114
+ `Failed to fetch git dependency ${gitUrl}@${tag}: ${err?.message ?? err}.\n` +
115
+ `Try running \`nargo check\` first to prime the dependency cache.`,
116
+ );
117
+ }
118
+ }
@@ -0,0 +1,98 @@
1
+ import { readdir, stat } from 'fs/promises';
2
+ import { join } from 'path';
3
+
4
+ import { collectCrateDirs } from './collect_crate_dirs.js';
5
+
6
+ /**
7
+ * Returns true if recompilation is needed: either no artifacts exist in target/ or any .nr or Nargo.toml source file
8
+ * (including path-based dependencies) is newer than the oldest artifact. We compare against the oldest artifact so
9
+ * that a source change between the oldest and newest compilation (e.g. in a multi-contract workspace) still triggers
10
+ * a recompile.
11
+ *
12
+ * Note: The above implies that if there is a random json file in the target dir we would be always recompiling.
13
+ */
14
+ export async function needsRecompile(): Promise<boolean> {
15
+ const oldestArtifactMs = await getOldestArtifactModificationTime('target');
16
+ if (oldestArtifactMs === undefined) {
17
+ return true;
18
+ }
19
+
20
+ // Git deps are pinned to a specific tag in Nargo.toml and nargo always fetches an exact tag, so their contents never
21
+ // change without Nargo.toml itself changing — and Nargo.toml is already tracked as a source file. Hence we can
22
+ // safely ignore checking source files of git deps.
23
+ const crateDirs = await collectCrateDirs('.', { skipGitDeps: true });
24
+ return hasNewerSourceFile(crateDirs, oldestArtifactMs);
25
+ }
26
+
27
+ /**
28
+ * Returns the last modification time (timestamp in ms) of the oldest .json artifact in targetDir, or undefined if
29
+ * none exist.
30
+ */
31
+ async function getOldestArtifactModificationTime(targetDir: string): Promise<number | undefined> {
32
+ let entries: string[];
33
+ try {
34
+ entries = (await readdir(targetDir)).filter(f => f.endsWith('.json'));
35
+ } catch (err: any) {
36
+ if (err?.code === 'ENOENT') {
37
+ return undefined;
38
+ }
39
+ throw err;
40
+ }
41
+
42
+ if (entries.length === 0) {
43
+ return undefined;
44
+ }
45
+
46
+ let oldest = Infinity;
47
+ for (const entry of entries) {
48
+ const s = await stat(join(targetDir, entry));
49
+ if (s.mtimeMs < oldest) {
50
+ oldest = s.mtimeMs;
51
+ }
52
+ }
53
+ return oldest;
54
+ }
55
+
56
+ /**
57
+ * Walks crate dirs looking for .nr and Nargo.toml files newer than thresholdMs. Short-circuits on the first match.
58
+ */
59
+ async function hasNewerSourceFile(crateDirs: string[], thresholdMs: number): Promise<boolean> {
60
+ // Returns true if it find a new file than thresholdMs, false otherwise
61
+ async function walkForNewer(dir: string): Promise<boolean> {
62
+ let entries;
63
+ try {
64
+ entries = await readdir(dir, { withFileTypes: true });
65
+ } catch {
66
+ return false;
67
+ }
68
+
69
+ // We iterate over the entries in the dir
70
+ for (const entry of entries) {
71
+ const fullPath = join(dir, entry.name);
72
+ if (entry.isDirectory()) {
73
+ // If the entry is a dir and it's not called `target` we recursively enter it
74
+ if (entry.name === 'target') {
75
+ continue;
76
+ }
77
+ if (await walkForNewer(fullPath)) {
78
+ return true;
79
+ }
80
+ } else if (entry.name === 'Nargo.toml' || entry.name.endsWith('.nr')) {
81
+ // The entry is a Nargo.toml file or *.nr file so we check the timestamp
82
+ const s = await stat(fullPath);
83
+ if (s.mtimeMs > thresholdMs) {
84
+ return true;
85
+ }
86
+ }
87
+ }
88
+ return false;
89
+ }
90
+
91
+ // We search through the crate dirs
92
+ for (const dir of crateDirs) {
93
+ if (await walkForNewer(dir)) {
94
+ return true;
95
+ }
96
+ }
97
+ return false;
98
+ }
@@ -0,0 +1,16 @@
1
+ import { spawn } from 'child_process';
2
+
3
+ /** Spawns a command with inherited stdio and rejects on non-zero exit. */
4
+ export function run(cmd: string, args: string[]): Promise<void> {
5
+ return new Promise((resolve, reject) => {
6
+ const child = spawn(cmd, args, { stdio: 'inherit' });
7
+ child.on('error', reject);
8
+ child.on('close', code => {
9
+ if (code !== 0) {
10
+ reject(new Error(`${cmd} exited with code ${code}`));
11
+ } else {
12
+ resolve();
13
+ }
14
+ });
15
+ });
16
+ }
@@ -0,0 +1,54 @@
1
+ import type { LogFn } from '@aztec/foundation/log';
2
+ import { getPackageVersion } from '@aztec/stdlib/update-checker';
3
+
4
+ import TOML from '@iarna/toml';
5
+ import { readFile } from 'fs/promises';
6
+ import { join } from 'path';
7
+
8
+ import { collectCrateDirs } from './collect_crate_dirs.js';
9
+
10
+ /** Warns if the `aztec` dependency tag in any crate's Nargo.toml doesn't match the CLI version. */
11
+ export async function warnIfAztecVersionMismatch(log: LogFn, cliVersion?: string): Promise<void> {
12
+ const version = cliVersion ?? getPackageVersion();
13
+ if (!version) {
14
+ log(`WARNING: aztec CLI version not found. Skipping dependency compatibility check.`);
15
+ return;
16
+ }
17
+
18
+ const expectedTag = `v${version}`;
19
+ const mismatches: { file: string; tag: string }[] = [];
20
+
21
+ const crateDirs = await collectCrateDirs('.', { skipGitDeps: true });
22
+
23
+ for (const dir of crateDirs) {
24
+ const tomlPath = join(dir, 'Nargo.toml');
25
+ let content: string;
26
+ try {
27
+ content = await readFile(tomlPath, 'utf-8');
28
+ } catch {
29
+ continue;
30
+ }
31
+
32
+ const parsed = TOML.parse(content) as Record<string, any>;
33
+ const aztecDep = (parsed.dependencies as Record<string, any>)?.aztec;
34
+ if (!aztecDep || typeof aztecDep !== 'object' || typeof aztecDep.tag !== 'string') {
35
+ // If a dep called "aztec" doesn't exist or it does not get parsed to an object or it doesn't have a tag defined
36
+ // we skip the check.
37
+ continue;
38
+ }
39
+
40
+ if (aztecDep.tag !== expectedTag) {
41
+ mismatches.push({ file: tomlPath, tag: aztecDep.tag });
42
+ }
43
+ }
44
+
45
+ if (mismatches.length > 0) {
46
+ const details = mismatches.map(m => ` ${m.file} (${m.tag})`).join('\n');
47
+ log(
48
+ `WARNING: Aztec dependency version mismatch detected.\n` +
49
+ `The following crates have an aztec dependency that does not match the CLI version (${expectedTag}):\n` +
50
+ `${details}\n\n` +
51
+ `See https://docs.aztec.network/errors/9 for how to update your dependencies.`,
52
+ );
53
+ }
54
+ }