@aztec/aztec 0.0.0-test.1 → 0.0.1-commit.001888fc

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 (194) hide show
  1. package/README.md +1 -1
  2. package/dest/bin/index.d.ts +1 -1
  3. package/dest/bin/index.js +28 -13
  4. package/dest/cli/admin_api_key_store.d.ts +45 -0
  5. package/dest/cli/admin_api_key_store.d.ts.map +1 -0
  6. package/dest/cli/admin_api_key_store.js +98 -0
  7. package/dest/cli/aztec_start_action.d.ts +1 -1
  8. package/dest/cli/aztec_start_action.d.ts.map +1 -1
  9. package/dest/cli/aztec_start_action.js +89 -44
  10. package/dest/cli/aztec_start_options.d.ts +5 -3
  11. package/dest/cli/aztec_start_options.d.ts.map +1 -1
  12. package/dest/cli/aztec_start_options.js +157 -220
  13. package/dest/cli/cli.d.ts +1 -1
  14. package/dest/cli/cli.d.ts.map +1 -1
  15. package/dest/cli/cli.js +11 -7
  16. package/dest/cli/cmds/compile.d.ts +4 -0
  17. package/dest/cli/cmds/compile.d.ts.map +1 -0
  18. package/dest/cli/cmds/compile.js +166 -0
  19. package/dest/cli/cmds/migrate_ha_db.d.ts +3 -0
  20. package/dest/cli/cmds/migrate_ha_db.d.ts.map +1 -0
  21. package/dest/cli/cmds/migrate_ha_db.js +27 -0
  22. package/dest/cli/cmds/profile.d.ts +4 -0
  23. package/dest/cli/cmds/profile.d.ts.map +1 -0
  24. package/dest/cli/cmds/profile.js +8 -0
  25. package/dest/cli/cmds/profile_flamegraph.d.ts +4 -0
  26. package/dest/cli/cmds/profile_flamegraph.d.ts.map +1 -0
  27. package/dest/cli/cmds/profile_flamegraph.js +52 -0
  28. package/dest/cli/cmds/profile_gates.d.ts +4 -0
  29. package/dest/cli/cmds/profile_gates.d.ts.map +1 -0
  30. package/dest/cli/cmds/profile_gates.js +58 -0
  31. package/dest/cli/cmds/profile_utils.d.ts +18 -0
  32. package/dest/cli/cmds/profile_utils.d.ts.map +1 -0
  33. package/dest/cli/cmds/profile_utils.js +50 -0
  34. package/dest/cli/cmds/standby.d.ts +32 -0
  35. package/dest/cli/cmds/standby.d.ts.map +1 -0
  36. package/dest/cli/cmds/standby.js +97 -0
  37. package/dest/cli/cmds/start_archiver.d.ts +2 -2
  38. package/dest/cli/cmds/start_archiver.d.ts.map +1 -1
  39. package/dest/cli/cmds/start_archiver.js +25 -19
  40. package/dest/cli/cmds/start_bot.d.ts +4 -7
  41. package/dest/cli/cmds/start_bot.d.ts.map +1 -1
  42. package/dest/cli/cmds/start_bot.js +29 -14
  43. package/dest/cli/cmds/start_node.d.ts +3 -2
  44. package/dest/cli/cmds/start_node.d.ts.map +1 -1
  45. package/dest/cli/cmds/start_node.js +128 -85
  46. package/dest/cli/cmds/start_p2p_bootstrap.d.ts +2 -2
  47. package/dest/cli/cmds/start_p2p_bootstrap.d.ts.map +1 -1
  48. package/dest/cli/cmds/start_p2p_bootstrap.js +10 -6
  49. package/dest/cli/cmds/start_prover_agent.d.ts +1 -1
  50. package/dest/cli/cmds/start_prover_agent.d.ts.map +1 -1
  51. package/dest/cli/cmds/start_prover_agent.js +35 -6
  52. package/dest/cli/cmds/start_prover_broker.d.ts +1 -1
  53. package/dest/cli/cmds/start_prover_broker.d.ts.map +1 -1
  54. package/dest/cli/cmds/start_prover_broker.js +17 -5
  55. package/dest/cli/cmds/start_txe.d.ts +1 -1
  56. package/dest/cli/cmds/utils/artifacts.d.ts +21 -0
  57. package/dest/cli/cmds/utils/artifacts.d.ts.map +1 -0
  58. package/dest/cli/cmds/utils/artifacts.js +24 -0
  59. package/dest/cli/cmds/utils/needs_recompile.d.ts +10 -0
  60. package/dest/cli/cmds/utils/needs_recompile.d.ts.map +1 -0
  61. package/dest/cli/cmds/utils/needs_recompile.js +134 -0
  62. package/dest/cli/cmds/utils/spawn.d.ts +3 -0
  63. package/dest/cli/cmds/utils/spawn.d.ts.map +1 -0
  64. package/dest/cli/cmds/utils/spawn.js +16 -0
  65. package/dest/cli/index.d.ts +1 -1
  66. package/dest/cli/preload_crs.d.ts +3 -0
  67. package/dest/cli/preload_crs.d.ts.map +1 -0
  68. package/dest/cli/preload_crs.js +6 -0
  69. package/dest/cli/util.d.ts +37 -17
  70. package/dest/cli/util.d.ts.map +1 -1
  71. package/dest/cli/util.js +165 -31
  72. package/dest/cli/versioning.d.ts +1 -1
  73. package/dest/cli/versioning.js +3 -3
  74. package/dest/examples/token.d.ts +1 -1
  75. package/dest/examples/token.js +31 -18
  76. package/dest/examples/util.d.ts +5 -6
  77. package/dest/examples/util.d.ts.map +1 -1
  78. package/dest/examples/util.js +5 -6
  79. package/dest/index.d.ts +2 -2
  80. package/dest/index.d.ts.map +1 -1
  81. package/dest/index.js +1 -1
  82. package/dest/local-network/banana_fpc.d.ts +10 -0
  83. package/dest/local-network/banana_fpc.d.ts.map +1 -0
  84. package/dest/{sandbox → local-network}/banana_fpc.js +23 -25
  85. package/dest/local-network/index.d.ts +4 -0
  86. package/dest/local-network/index.d.ts.map +1 -0
  87. package/dest/local-network/index.js +3 -0
  88. package/dest/local-network/local-network.d.ts +73 -0
  89. package/dest/local-network/local-network.d.ts.map +1 -0
  90. package/dest/local-network/local-network.js +226 -0
  91. package/dest/local-network/sponsored_fpc.d.ts +5 -0
  92. package/dest/local-network/sponsored_fpc.d.ts.map +1 -0
  93. package/dest/local-network/sponsored_fpc.js +18 -0
  94. package/dest/mnemonic.d.ts +1 -1
  95. package/dest/splash.d.ts +1 -1
  96. package/dest/testing/anvil_test_watcher.d.ts +42 -0
  97. package/dest/testing/anvil_test_watcher.d.ts.map +1 -0
  98. package/dest/testing/anvil_test_watcher.js +181 -0
  99. package/dest/testing/cheat_codes.d.ts +43 -0
  100. package/dest/testing/cheat_codes.d.ts.map +1 -0
  101. package/dest/testing/cheat_codes.js +62 -0
  102. package/dest/testing/epoch_test_settler.d.ts +19 -0
  103. package/dest/testing/epoch_test_settler.d.ts.map +1 -0
  104. package/dest/testing/epoch_test_settler.js +61 -0
  105. package/dest/testing/index.d.ts +6 -0
  106. package/dest/testing/index.d.ts.map +1 -0
  107. package/dest/testing/index.js +5 -0
  108. package/dest/testing/token_allowed_setup.d.ts +7 -0
  109. package/dest/testing/token_allowed_setup.d.ts.map +1 -0
  110. package/dest/testing/token_allowed_setup.js +20 -0
  111. package/package.json +55 -45
  112. package/scripts/add_crate.sh +102 -0
  113. package/scripts/aztec.sh +69 -0
  114. package/scripts/init.sh +39 -0
  115. package/scripts/new.sh +83 -0
  116. package/scripts/setup_workspace.sh +68 -0
  117. package/src/bin/index.ts +33 -13
  118. package/src/cli/admin_api_key_store.ts +128 -0
  119. package/src/cli/aztec_start_action.ts +87 -41
  120. package/src/cli/aztec_start_options.ts +176 -218
  121. package/src/cli/cli.ts +19 -11
  122. package/src/cli/cmds/compile.ts +191 -0
  123. package/src/cli/cmds/migrate_ha_db.ts +43 -0
  124. package/src/cli/cmds/profile.ts +25 -0
  125. package/src/cli/cmds/profile_flamegraph.ts +64 -0
  126. package/src/cli/cmds/profile_gates.ts +68 -0
  127. package/src/cli/cmds/profile_utils.ts +58 -0
  128. package/src/cli/cmds/standby.ts +132 -0
  129. package/src/cli/cmds/start_archiver.ts +16 -21
  130. package/src/cli/cmds/start_bot.ts +40 -14
  131. package/src/cli/cmds/start_node.ts +146 -91
  132. package/src/cli/cmds/start_p2p_bootstrap.ts +14 -6
  133. package/src/cli/cmds/start_prover_agent.ts +26 -14
  134. package/src/cli/cmds/start_prover_broker.ts +28 -4
  135. package/src/cli/cmds/utils/artifacts.ts +44 -0
  136. package/src/cli/cmds/utils/needs_recompile.ts +151 -0
  137. package/src/cli/cmds/utils/spawn.ts +16 -0
  138. package/src/cli/preload_crs.ts +7 -0
  139. package/src/cli/util.ts +186 -50
  140. package/src/cli/versioning.ts +3 -3
  141. package/src/examples/token.ts +23 -19
  142. package/src/examples/util.ts +6 -8
  143. package/src/index.ts +5 -6
  144. package/src/{sandbox → local-network}/banana_fpc.ts +28 -29
  145. package/src/local-network/index.ts +7 -0
  146. package/src/local-network/local-network.ts +277 -0
  147. package/src/local-network/sponsored_fpc.ts +26 -0
  148. package/src/testing/anvil_test_watcher.ts +210 -0
  149. package/src/testing/cheat_codes.ts +79 -0
  150. package/src/testing/epoch_test_settler.ts +70 -0
  151. package/src/testing/index.ts +5 -0
  152. package/src/testing/token_allowed_setup.ts +19 -0
  153. package/dest/cli/chain_l2_config.d.ts +0 -19
  154. package/dest/cli/chain_l2_config.d.ts.map +0 -1
  155. package/dest/cli/chain_l2_config.js +0 -56
  156. package/dest/cli/cmds/start_blob_sink.d.ts +0 -3
  157. package/dest/cli/cmds/start_blob_sink.d.ts.map +0 -1
  158. package/dest/cli/cmds/start_blob_sink.js +0 -17
  159. package/dest/cli/cmds/start_faucet.d.ts +0 -4
  160. package/dest/cli/cmds/start_faucet.d.ts.map +0 -1
  161. package/dest/cli/cmds/start_faucet.js +0 -20
  162. package/dest/cli/cmds/start_prover_node.d.ts +0 -7
  163. package/dest/cli/cmds/start_prover_node.d.ts.map +0 -1
  164. package/dest/cli/cmds/start_prover_node.js +0 -110
  165. package/dest/cli/cmds/start_pxe.d.ts +0 -16
  166. package/dest/cli/cmds/start_pxe.d.ts.map +0 -1
  167. package/dest/cli/cmds/start_pxe.js +0 -95
  168. package/dest/cli/get_l1_config.d.ts +0 -7
  169. package/dest/cli/get_l1_config.d.ts.map +0 -1
  170. package/dest/cli/get_l1_config.js +0 -13
  171. package/dest/sandbox/banana_fpc.d.ts +0 -11
  172. package/dest/sandbox/banana_fpc.d.ts.map +0 -1
  173. package/dest/sandbox/index.d.ts +0 -5
  174. package/dest/sandbox/index.d.ts.map +0 -1
  175. package/dest/sandbox/index.js +0 -4
  176. package/dest/sandbox/sandbox.d.ts +0 -76
  177. package/dest/sandbox/sandbox.d.ts.map +0 -1
  178. package/dest/sandbox/sandbox.js +0 -181
  179. package/dest/sandbox/sponsored_fee_payment_method.d.ts +0 -23
  180. package/dest/sandbox/sponsored_fee_payment_method.d.ts.map +0 -1
  181. package/dest/sandbox/sponsored_fee_payment_method.js +0 -36
  182. package/dest/sandbox/sponsored_fpc.d.ts +0 -6
  183. package/dest/sandbox/sponsored_fpc.d.ts.map +0 -1
  184. package/dest/sandbox/sponsored_fpc.js +0 -26
  185. package/src/cli/chain_l2_config.ts +0 -74
  186. package/src/cli/cmds/start_blob_sink.ts +0 -31
  187. package/src/cli/cmds/start_faucet.ts +0 -34
  188. package/src/cli/cmds/start_prover_node.ts +0 -121
  189. package/src/cli/cmds/start_pxe.ts +0 -129
  190. package/src/cli/get_l1_config.ts +0 -18
  191. package/src/sandbox/index.ts +0 -5
  192. package/src/sandbox/sandbox.ts +0 -229
  193. package/src/sandbox/sponsored_fee_payment_method.ts +0 -46
  194. package/src/sandbox/sponsored_fpc.ts +0 -38
@@ -1,46 +1,48 @@
1
+ import { getActiveNetworkName } from '@aztec/foundation/config';
1
2
  import {
2
3
  type NamespacedApiHandlers,
3
4
  createNamespacedSafeJsonRpcServer,
5
+ getApiKeyAuthMiddleware,
4
6
  startHttpRpcServer,
5
7
  } from '@aztec/foundation/json-rpc/server';
6
8
  import type { LogFn, Logger } from '@aztec/foundation/log';
7
- import { fileURLToPath } from '@aztec/foundation/url';
8
9
  import type { ChainConfig } from '@aztec/stdlib/config';
9
- import { AztecNodeApiSchema, PXESchema } from '@aztec/stdlib/interfaces/client';
10
+ import { AztecNodeAdminApiSchema, AztecNodeApiSchema } from '@aztec/stdlib/interfaces/client';
11
+ import { getPackageVersion } from '@aztec/stdlib/update-checker';
10
12
  import { getVersioningMiddleware } from '@aztec/stdlib/versioning';
11
13
  import { getOtelJsonRpcPropagationMiddleware } from '@aztec/telemetry-client';
12
14
 
13
- import { readFileSync } from 'fs';
14
- import { dirname, resolve } from 'path';
15
-
16
- import { createSandbox } from '../sandbox/index.js';
15
+ import { createLocalNetwork } from '../local-network/index.js';
17
16
  import { github, splash } from '../splash.js';
18
- import { enrichEnvironmentWithChainConfig } from './chain_l2_config.js';
17
+ import { resolveAdminApiKey } from './admin_api_key_store.js';
19
18
  import { extractNamespacedOptions, installSignalHandlers } from './util.js';
20
19
  import { getVersions } from './versioning.js';
21
20
 
22
- const packageJsonPath = resolve(dirname(fileURLToPath(import.meta.url)), '../../package.json');
23
- const cliVersion: string = JSON.parse(readFileSync(packageJsonPath).toString()).version;
24
-
25
21
  export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logger) {
26
22
  // list of 'stop' functions to call when process ends
27
23
  const signalHandlers: Array<() => Promise<void>> = [];
28
24
  const services: NamespacedApiHandlers = {};
25
+ const adminServices: NamespacedApiHandlers = {};
26
+ const packageVersion = getPackageVersion();
29
27
  let config: ChainConfig | undefined = undefined;
30
28
 
31
- if (options.sandbox) {
32
- const sandboxOptions = extractNamespacedOptions(options, 'sandbox');
33
- const nodeOptions = extractNamespacedOptions(options, 'node');
29
+ if (options.localNetwork) {
30
+ const localNetwork = extractNamespacedOptions(options, 'local-network');
31
+ localNetwork.testAccounts = true;
34
32
  userLog(`${splash}\n${github}\n\n`);
35
- userLog(`Setting up Aztec Sandbox ${cliVersion}, please stand by...`);
33
+ userLog(`Setting up Aztec local network ${packageVersion ?? 'unknown'}, please stand by...`);
36
34
 
37
- const { node, pxe, stop } = await createSandbox(
35
+ const { node, stop } = await createLocalNetwork(
38
36
  {
39
- l1Mnemonic: options.l1Mnemonic,
37
+ l1Mnemonic: localNetwork.l1Mnemonic,
40
38
  l1RpcUrls: options.l1RpcUrls,
41
- l1Salt: nodeOptions.deployAztecContractsSalt,
42
- noPXE: sandboxOptions.noPXE,
43
- testAccounts: sandboxOptions.testAccounts,
39
+ testAccounts: localNetwork.testAccounts,
40
+ realProofs: false,
41
+ // Setting the epoch duration to 2 by default for local network. This allows the epoch to be "proven" faster, so
42
+ // the users can consume out hash without having to wait for a long time.
43
+ // Note: We are not proving anything in the local network (realProofs == false). But in `createLocalNetwork`,
44
+ // the EpochTestSettler will set the out hash to the outbox when an epoch is complete.
45
+ aztecEpochDuration: 2,
44
46
  },
45
47
  userLog,
46
48
  );
@@ -48,31 +50,20 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
48
50
  // Start Node and PXE JSON-RPC server
49
51
  signalHandlers.push(stop);
50
52
  services.node = [node, AztecNodeApiSchema];
51
- if (!sandboxOptions.noPXE) {
52
- services.pxe = [pxe, PXESchema];
53
- } else {
54
- userLog(`Not exposing PXE API through JSON-RPC server`);
55
- }
53
+ adminServices.node = [node, AztecNodeAdminApiSchema];
56
54
  } else {
57
- // If a network is specified, enrich the environment with the chain config
58
- if (options.network) {
59
- await enrichEnvironmentWithChainConfig(options.network);
55
+ // Route --prover-node through startNode
56
+ if (options.proverNode && !options.node) {
57
+ options.node = true;
60
58
  }
59
+
61
60
  if (options.node) {
62
61
  const { startNode } = await import('./cmds/start_node.js');
63
- ({ config } = await startNode(options, signalHandlers, services, userLog));
62
+ const networkName = getActiveNetworkName(options.network);
63
+ ({ config } = await startNode(options, signalHandlers, services, adminServices, userLog, networkName));
64
64
  } else if (options.bot) {
65
65
  const { startBot } = await import('./cmds/start_bot.js');
66
66
  await startBot(options, signalHandlers, services, userLog);
67
- } else if (options.proverNode) {
68
- const { startProverNode } = await import('./cmds/start_prover_node.js');
69
- ({ config } = await startProverNode(options, signalHandlers, services, userLog));
70
- } else if (options.blobSink) {
71
- const { startBlobSink } = await import('./cmds/start_blob_sink.js');
72
- await startBlobSink(options, signalHandlers, userLog);
73
- } else if (options.pxe) {
74
- const { startPXE } = await import('./cmds/start_pxe.js');
75
- ({ config } = await startPXE(options, signalHandlers, services, userLog));
76
67
  } else if (options.archiver) {
77
68
  const { startArchiver } = await import('./cmds/start_archiver.js');
78
69
  ({ config } = await startArchiver(options, signalHandlers, services));
@@ -91,9 +82,6 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
91
82
  } else if (options.sequencer) {
92
83
  userLog(`Cannot run a standalone sequencer without a node`);
93
84
  process.exit(1);
94
- } else if (options.faucet) {
95
- const { startFaucet } = await import('./cmds/start_faucet.js');
96
- await startFaucet(options, signalHandlers, services, userLog);
97
85
  } else {
98
86
  userLog(`No module specified to start`);
99
87
  process.exit(1);
@@ -102,13 +90,71 @@ export async function aztecStart(options: any, userLog: LogFn, debugLogger: Logg
102
90
 
103
91
  installSignalHandlers(debugLogger.info, signalHandlers);
104
92
  const versions = getVersions(config);
93
+ const versioningOpts = { packageVersion };
94
+
95
+ // Start the main JSON-RPC server
105
96
  if (Object.entries(services).length > 0) {
106
97
  const rpcServer = createNamespacedSafeJsonRpcServer(services, {
107
98
  http200OnError: false,
108
99
  log: debugLogger,
109
- middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions)],
100
+ middlewares: [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions, versioningOpts)],
101
+ maxBatchSize: options.rpcMaxBatchSize,
102
+ maxBodySizeBytes: options.rpcMaxBodySize,
110
103
  });
111
104
  const { port } = await startHttpRpcServer(rpcServer, { port: options.port });
112
105
  debugLogger.info(`Aztec Server listening on port ${port}`, versions);
113
106
  }
107
+
108
+ // If there are any admin services, start a separate JSON-RPC server for them
109
+ if (Object.entries(adminServices).length > 0) {
110
+ const adminMiddlewares = [getOtelJsonRpcPropagationMiddleware(), getVersioningMiddleware(versions, versioningOpts)];
111
+
112
+ // Resolve the admin API key (auto-generated and persisted, or opt-out)
113
+ const apiKeyResolution = await resolveAdminApiKey(
114
+ {
115
+ adminApiKeyHash: options.adminApiKeyHash,
116
+ disableAdminApiKey: options.disableAdminApiKey,
117
+ resetAdminApiKey: options.resetAdminApiKey,
118
+ dataDirectory: options.dataDirectory,
119
+ },
120
+ debugLogger,
121
+ );
122
+ if (apiKeyResolution) {
123
+ adminMiddlewares.unshift(getApiKeyAuthMiddleware(apiKeyResolution.apiKeyHash));
124
+ } else {
125
+ debugLogger.warn('No admin API key set — admin endpoint is unauthenticated');
126
+ }
127
+
128
+ const rpcServer = createNamespacedSafeJsonRpcServer(adminServices, {
129
+ http200OnError: false,
130
+ log: debugLogger,
131
+ middlewares: adminMiddlewares,
132
+ maxBatchSize: options.rpcMaxBatchSize,
133
+ maxBodySizeBytes: options.rpcMaxBodySize,
134
+ });
135
+ const { port } = await startHttpRpcServer(rpcServer, { port: options.adminPort });
136
+ debugLogger.info(`Aztec Server admin API listening on port ${port}`, versions);
137
+
138
+ // Display the API key after the server has started
139
+ // Uses userLog which is never filtered by LOG_LEVEL.
140
+ if (apiKeyResolution?.rawKey) {
141
+ const separator = '='.repeat(70);
142
+ userLog('');
143
+ userLog(separator);
144
+ userLog(' ADMIN API KEY (save this — it will NOT be shown again)');
145
+ userLog('');
146
+ userLog(` ${apiKeyResolution.rawKey}`);
147
+ userLog('');
148
+ userLog(` Use via header: x-api-key: <key>`);
149
+ userLog(` Or via header: Authorization: Bearer <key>`);
150
+ if (options.dataDirectory) {
151
+ userLog('');
152
+ userLog(' The key hash has been persisted — on next restart, the same key will be used.');
153
+ }
154
+ userLog('');
155
+ userLog(' To disable admin auth: --disable-admin-api-key or AZTEC_DISABLE_ADMIN_API_KEY=true');
156
+ userLog(separator);
157
+ userLog('');
158
+ }
159
+ }
114
160
  }