@aztec/constants 0.0.1-commit.a89ec08 → 0.0.1-commit.aa0c64f

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.
@@ -1,612 +0,0 @@
1
- import * as fs from 'fs';
2
- import { dirname, join } from 'path';
3
- import { fileURLToPath } from 'url';
4
- const NOIR_CONSTANTS_FILE = '../../../../noir-projects/noir-protocol-circuits/crates/types/src/constants.nr';
5
- const TS_CONSTANTS_FILE = '../constants.gen.ts';
6
- const CPP_AZTEC_CONSTANTS_FILE = '../../../../barretenberg/cpp/src/barretenberg/vm2/common/aztec_constants.hpp';
7
- const PIL_AZTEC_CONSTANTS_FILE = '../../../../barretenberg/cpp/pil/vm2/constants_gen.pil';
8
- const SOLIDITY_CONSTANTS_FILE = '../../../../l1-contracts/src/core/libraries/ConstantsGen.sol';
9
- // Whitelist of constants that will be copied to aztec_constants.hpp.
10
- // We don't copy everything as just a handful are needed, and updating them breaks the cache and triggers expensive bb builds.
11
- const CPP_CONSTANTS = [
12
- 'MAX_ETH_ADDRESS_BIT_SIZE',
13
- 'MAX_ETH_ADDRESS_VALUE',
14
- 'GENESIS_BLOCK_HEADER_HASH',
15
- 'GENESIS_ARCHIVE_ROOT',
16
- 'MEM_TAG_U1',
17
- 'MEM_TAG_U8',
18
- 'MEM_TAG_U16',
19
- 'MEM_TAG_U32',
20
- 'MEM_TAG_U64',
21
- 'MEM_TAG_U128',
22
- 'MEM_TAG_FF',
23
- 'MAX_PACKED_PUBLIC_BYTECODE_SIZE_IN_FIELDS',
24
- 'CANONICAL_AUTH_REGISTRY_ADDRESS',
25
- 'CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS',
26
- 'CONTRACT_CLASS_REGISTRY_CONTRACT_ADDRESS',
27
- 'MULTI_CALL_ENTRYPOINT_ADDRESS',
28
- 'FEE_JUICE_ADDRESS',
29
- 'TX_DA_GAS_OVERHEAD',
30
- 'PUBLIC_CHECKS_ADDRESS',
31
- 'FEE_JUICE_BALANCES_SLOT',
32
- 'UPDATED_CLASS_IDS_SLOT',
33
- 'UPDATES_DELAYED_PUBLIC_MUTABLE_VALUES_LEN',
34
- 'PUBLIC_DATA_TREE_HEIGHT',
35
- 'NULLIFIER_TREE_HEIGHT',
36
- 'NULLIFIER_SUBTREE_HEIGHT',
37
- 'NOTE_HASH_TREE_HEIGHT',
38
- 'L1_TO_L2_MSG_TREE_HEIGHT',
39
- 'ARCHIVE_HEIGHT',
40
- 'TIMESTAMP_OF_CHANGE_BIT_SIZE',
41
- 'UPDATES_DELAYED_PUBLIC_MUTABLE_METADATA_BIT_SIZE',
42
- 'MAX_ENQUEUED_CALLS_PER_TX',
43
- 'MAX_NOTE_HASHES_PER_TX',
44
- 'MAX_NULLIFIERS_PER_TX',
45
- 'MAX_L2_TO_L1_MSGS_PER_TX',
46
- 'MAX_PROCESSABLE_L2_GAS',
47
- 'MAX_PUBLIC_LOGS_PER_TX',
48
- 'MAX_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX',
49
- 'MAX_PUBLIC_CALLS_TO_UNIQUE_CONTRACT_CLASS_IDS',
50
- 'MAX_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX',
51
- 'MAX_TOTAL_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX',
52
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_ROW_IDX',
53
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_CHAIN_ID_ROW_IDX',
54
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_VERSION_ROW_IDX',
55
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_BLOCK_NUMBER_ROW_IDX',
56
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_SLOT_NUMBER_ROW_IDX',
57
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_TIMESTAMP_ROW_IDX',
58
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_COINBASE_ROW_IDX',
59
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_FEE_RECIPIENT_ROW_IDX',
60
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_GAS_FEES_ROW_IDX',
61
- 'AVM_PUBLIC_INPUTS_PROTOCOL_CONTRACTS_ROW_IDX',
62
- 'AVM_PUBLIC_INPUTS_START_TREE_SNAPSHOTS_ROW_IDX',
63
- 'AVM_PUBLIC_INPUTS_START_TREE_SNAPSHOTS_L1_TO_L2_MESSAGE_TREE_ROW_IDX',
64
- 'AVM_PUBLIC_INPUTS_START_TREE_SNAPSHOTS_NOTE_HASH_TREE_ROW_IDX',
65
- 'AVM_PUBLIC_INPUTS_START_TREE_SNAPSHOTS_NULLIFIER_TREE_ROW_IDX',
66
- 'AVM_PUBLIC_INPUTS_START_TREE_SNAPSHOTS_PUBLIC_DATA_TREE_ROW_IDX',
67
- 'AVM_PUBLIC_INPUTS_START_GAS_USED_ROW_IDX',
68
- 'AVM_PUBLIC_INPUTS_GAS_SETTINGS_ROW_IDX',
69
- 'AVM_PUBLIC_INPUTS_FEE_PAYER_ROW_IDX',
70
- 'AVM_PUBLIC_INPUTS_PUBLIC_SETUP_CALL_REQUESTS_ROW_IDX',
71
- 'AVM_PUBLIC_INPUTS_PUBLIC_APP_LOGIC_CALL_REQUESTS_ROW_IDX',
72
- 'AVM_PUBLIC_INPUTS_PUBLIC_TEARDOWN_CALL_REQUEST_ROW_IDX',
73
- 'AVM_PUBLIC_INPUTS_PREVIOUS_NON_REVERTIBLE_ACCUMULATED_DATA_ARRAY_LENGTHS_ROW_IDX',
74
- 'AVM_PUBLIC_INPUTS_PREVIOUS_REVERTIBLE_ACCUMULATED_DATA_ARRAY_LENGTHS_ROW_IDX',
75
- 'AVM_PUBLIC_INPUTS_PREVIOUS_NON_REVERTIBLE_ACCUMULATED_DATA_ROW_IDX',
76
- 'AVM_PUBLIC_INPUTS_PREVIOUS_NON_REVERTIBLE_ACCUMULATED_DATA_NOTE_HASHES_ROW_IDX',
77
- 'AVM_PUBLIC_INPUTS_PREVIOUS_NON_REVERTIBLE_ACCUMULATED_DATA_NULLIFIERS_ROW_IDX',
78
- 'AVM_PUBLIC_INPUTS_PREVIOUS_NON_REVERTIBLE_ACCUMULATED_DATA_L2_TO_L1_MSGS_ROW_IDX',
79
- 'AVM_PUBLIC_INPUTS_PREVIOUS_REVERTIBLE_ACCUMULATED_DATA_ROW_IDX',
80
- 'AVM_PUBLIC_INPUTS_PREVIOUS_REVERTIBLE_ACCUMULATED_DATA_NOTE_HASHES_ROW_IDX',
81
- 'AVM_PUBLIC_INPUTS_PREVIOUS_REVERTIBLE_ACCUMULATED_DATA_NULLIFIERS_ROW_IDX',
82
- 'AVM_PUBLIC_INPUTS_PREVIOUS_REVERTIBLE_ACCUMULATED_DATA_L2_TO_L1_MSGS_ROW_IDX',
83
- 'AVM_PUBLIC_INPUTS_END_TREE_SNAPSHOTS_ROW_IDX',
84
- 'AVM_PUBLIC_INPUTS_END_TREE_SNAPSHOTS_L1_TO_L2_MESSAGE_TREE_ROW_IDX',
85
- 'AVM_PUBLIC_INPUTS_END_TREE_SNAPSHOTS_NOTE_HASH_TREE_ROW_IDX',
86
- 'AVM_PUBLIC_INPUTS_END_TREE_SNAPSHOTS_NULLIFIER_TREE_ROW_IDX',
87
- 'AVM_PUBLIC_INPUTS_END_TREE_SNAPSHOTS_PUBLIC_DATA_TREE_ROW_IDX',
88
- 'AVM_PUBLIC_INPUTS_END_GAS_USED_ROW_IDX',
89
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_ARRAY_LENGTHS_NOTE_HASHES_ROW_IDX',
90
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_ARRAY_LENGTHS_NULLIFIERS_ROW_IDX',
91
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_ARRAY_LENGTHS_L2_TO_L1_MSGS_ROW_IDX',
92
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_ARRAY_LENGTHS_PUBLIC_LOGS_ROW_IDX',
93
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_ARRAY_LENGTHS_PUBLIC_DATA_WRITES_ROW_IDX',
94
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_ROW_IDX',
95
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_NOTE_HASHES_ROW_IDX',
96
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_NULLIFIERS_ROW_IDX',
97
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_L2_TO_L1_MSGS_ROW_IDX',
98
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_PUBLIC_LOGS_ROW_IDX',
99
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_PUBLIC_DATA_WRITES_ROW_IDX',
100
- 'AVM_PUBLIC_INPUTS_TRANSACTION_FEE_ROW_IDX',
101
- 'AVM_PUBLIC_INPUTS_REVERTED_ROW_IDX',
102
- 'AVM_PUBLIC_INPUTS_COLUMNS_MAX_LENGTH',
103
- 'AVM_NUM_PUBLIC_INPUT_COLUMNS',
104
- 'AVM_PUBLIC_INPUTS_COLUMNS_COMBINED_LENGTH',
105
- 'AVM_WRITTEN_PUBLIC_DATA_SLOTS_TREE_HEIGHT',
106
- 'AVM_WRITTEN_PUBLIC_DATA_SLOTS_TREE_INITIAL_ROOT',
107
- 'AVM_WRITTEN_PUBLIC_DATA_SLOTS_TREE_INITIAL_SIZE',
108
- 'NOTE_HASH_TREE_LEAF_COUNT',
109
- 'L1_TO_L2_MSG_TREE_LEAF_COUNT',
110
- 'FLAT_PUBLIC_LOGS_HEADER_LENGTH',
111
- 'FLAT_PUBLIC_LOGS_PAYLOAD_LENGTH',
112
- 'PUBLIC_LOGS_LENGTH',
113
- 'PUBLIC_LOG_HEADER_LENGTH',
114
- 'PUBLIC_TX_L2_GAS_OVERHEAD',
115
- 'MAX_PROTOCOL_CONTRACTS',
116
- 'DEFAULT_MAX_DEBUG_LOG_MEMORY_READS'
117
- ];
118
- const CPP_GENERATORS = [
119
- 'BLOCK_HEADER_HASH',
120
- 'PARTIAL_ADDRESS',
121
- 'CONTRACT_ADDRESS_V1',
122
- 'CONTRACT_CLASS_ID',
123
- 'PUBLIC_KEYS_HASH',
124
- 'NOTE_HASH_NONCE',
125
- 'UNIQUE_NOTE_HASH',
126
- 'SILOED_NOTE_HASH',
127
- 'SILOED_NULLIFIER',
128
- 'PUBLIC_LEAF_SLOT',
129
- 'PUBLIC_STORAGE_MAP_SLOT',
130
- 'PUBLIC_CALLDATA',
131
- 'PUBLIC_BYTECODE'
132
- ];
133
- const PIL_CONSTANTS = [
134
- 'MAX_ETH_ADDRESS_VALUE',
135
- 'MEM_TAG_U1',
136
- 'MEM_TAG_U8',
137
- 'MEM_TAG_U16',
138
- 'MEM_TAG_U32',
139
- 'MEM_TAG_U64',
140
- 'MEM_TAG_U128',
141
- 'MEM_TAG_FF',
142
- 'AVM_BITWISE_AND_OP_ID',
143
- 'AVM_BITWISE_OR_OP_ID',
144
- 'AVM_BITWISE_XOR_OP_ID',
145
- 'AVM_KECCAKF1600_NUM_ROUNDS',
146
- 'AVM_KECCAKF1600_STATE_SIZE',
147
- 'AVM_TX_PHASE_VALUE_START',
148
- 'AVM_TX_PHASE_VALUE_SETUP',
149
- 'AVM_TX_PHASE_VALUE_LAST',
150
- 'AVM_HIGHEST_MEM_ADDRESS',
151
- 'AVM_MEMORY_NUM_BITS',
152
- 'AVM_MEMORY_SIZE',
153
- 'MAX_PACKED_PUBLIC_BYTECODE_SIZE_IN_FIELDS',
154
- 'MAX_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX',
155
- 'MAX_NOTE_HASHES_PER_TX',
156
- 'GRUMPKIN_ONE_X',
157
- 'GRUMPKIN_ONE_Y',
158
- 'AVM_PC_SIZE_IN_BITS',
159
- 'PUBLIC_DATA_TREE_HEIGHT',
160
- 'NULLIFIER_TREE_HEIGHT',
161
- 'NOTE_HASH_TREE_HEIGHT',
162
- 'L1_TO_L2_MSG_TREE_HEIGHT',
163
- 'UPDATED_CLASS_IDS_SLOT',
164
- 'UPDATES_DELAYED_PUBLIC_MUTABLE_VALUES_LEN',
165
- 'CANONICAL_AUTH_REGISTRY_ADDRESS',
166
- 'CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS',
167
- 'CONTRACT_CLASS_REGISTRY_CONTRACT_ADDRESS',
168
- 'MULTI_CALL_ENTRYPOINT_ADDRESS',
169
- 'FEE_JUICE_ADDRESS',
170
- 'PUBLIC_CHECKS_ADDRESS',
171
- 'FEE_JUICE_BALANCES_SLOT',
172
- 'TIMESTAMP_OF_CHANGE_BIT_SIZE',
173
- 'UPDATES_DELAYED_PUBLIC_MUTABLE_METADATA_BIT_SIZE',
174
- 'UPDATES_SHARED_MUTABLE_METADATA_BIT_SIZE',
175
- 'MAX_ENQUEUED_CALLS_PER_TX',
176
- 'MAX_NOTE_HASHES_PER_TX',
177
- 'MAX_NULLIFIERS_PER_TX',
178
- 'MAX_L2_TO_L1_MSGS_PER_TX',
179
- 'MAX_PUBLIC_LOGS_PER_TX',
180
- 'MAX_PUBLIC_CALLS_TO_UNIQUE_CONTRACT_CLASS_IDS',
181
- 'MAX_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX',
182
- 'MAX_TOTAL_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX',
183
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_ROW_IDX',
184
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_CHAIN_ID_ROW_IDX',
185
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_VERSION_ROW_IDX',
186
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_BLOCK_NUMBER_ROW_IDX',
187
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_SLOT_NUMBER_ROW_IDX',
188
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_TIMESTAMP_ROW_IDX',
189
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_COINBASE_ROW_IDX',
190
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_FEE_RECIPIENT_ROW_IDX',
191
- 'AVM_PUBLIC_INPUTS_GLOBAL_VARIABLES_GAS_FEES_ROW_IDX',
192
- 'AVM_PUBLIC_INPUTS_PROTOCOL_CONTRACTS_ROW_IDX',
193
- 'AVM_PUBLIC_INPUTS_START_TREE_SNAPSHOTS_ROW_IDX',
194
- 'AVM_PUBLIC_INPUTS_START_TREE_SNAPSHOTS_L1_TO_L2_MESSAGE_TREE_ROW_IDX',
195
- 'AVM_PUBLIC_INPUTS_START_TREE_SNAPSHOTS_NOTE_HASH_TREE_ROW_IDX',
196
- 'AVM_PUBLIC_INPUTS_START_TREE_SNAPSHOTS_NULLIFIER_TREE_ROW_IDX',
197
- 'AVM_PUBLIC_INPUTS_START_TREE_SNAPSHOTS_PUBLIC_DATA_TREE_ROW_IDX',
198
- 'AVM_PUBLIC_INPUTS_START_GAS_USED_ROW_IDX',
199
- 'AVM_PUBLIC_INPUTS_GAS_SETTINGS_ROW_IDX',
200
- 'AVM_PUBLIC_INPUTS_GAS_SETTINGS_GAS_LIMITS_ROW_IDX',
201
- 'AVM_PUBLIC_INPUTS_GAS_SETTINGS_TEARDOWN_GAS_LIMITS_ROW_IDX',
202
- 'AVM_PUBLIC_INPUTS_FEE_PAYER_ROW_IDX',
203
- 'AVM_PUBLIC_INPUTS_PUBLIC_SETUP_CALL_REQUESTS_ROW_IDX',
204
- 'AVM_PUBLIC_INPUTS_PUBLIC_APP_LOGIC_CALL_REQUESTS_ROW_IDX',
205
- 'AVM_PUBLIC_INPUTS_PUBLIC_TEARDOWN_CALL_REQUEST_ROW_IDX',
206
- 'AVM_PUBLIC_INPUTS_PREVIOUS_NON_REVERTIBLE_ACCUMULATED_DATA_ARRAY_LENGTHS_ROW_IDX',
207
- 'AVM_PUBLIC_INPUTS_PREVIOUS_REVERTIBLE_ACCUMULATED_DATA_ARRAY_LENGTHS_ROW_IDX',
208
- 'AVM_PUBLIC_INPUTS_PREVIOUS_NON_REVERTIBLE_ACCUMULATED_DATA_ROW_IDX',
209
- 'AVM_PUBLIC_INPUTS_PREVIOUS_NON_REVERTIBLE_ACCUMULATED_DATA_NOTE_HASHES_ROW_IDX',
210
- 'AVM_PUBLIC_INPUTS_PREVIOUS_NON_REVERTIBLE_ACCUMULATED_DATA_NULLIFIERS_ROW_IDX',
211
- 'AVM_PUBLIC_INPUTS_PREVIOUS_NON_REVERTIBLE_ACCUMULATED_DATA_L2_TO_L1_MSGS_ROW_IDX',
212
- 'AVM_PUBLIC_INPUTS_PREVIOUS_REVERTIBLE_ACCUMULATED_DATA_ROW_IDX',
213
- 'AVM_PUBLIC_INPUTS_PREVIOUS_REVERTIBLE_ACCUMULATED_DATA_NOTE_HASHES_ROW_IDX',
214
- 'AVM_PUBLIC_INPUTS_PREVIOUS_REVERTIBLE_ACCUMULATED_DATA_NULLIFIERS_ROW_IDX',
215
- 'AVM_PUBLIC_INPUTS_PREVIOUS_REVERTIBLE_ACCUMULATED_DATA_L2_TO_L1_MSGS_ROW_IDX',
216
- 'AVM_PUBLIC_INPUTS_END_TREE_SNAPSHOTS_ROW_IDX',
217
- 'AVM_PUBLIC_INPUTS_END_TREE_SNAPSHOTS_L1_TO_L2_MESSAGE_TREE_ROW_IDX',
218
- 'AVM_PUBLIC_INPUTS_END_TREE_SNAPSHOTS_NOTE_HASH_TREE_ROW_IDX',
219
- 'AVM_PUBLIC_INPUTS_END_TREE_SNAPSHOTS_NULLIFIER_TREE_ROW_IDX',
220
- 'AVM_PUBLIC_INPUTS_END_TREE_SNAPSHOTS_PUBLIC_DATA_TREE_ROW_IDX',
221
- 'AVM_PUBLIC_INPUTS_END_GAS_USED_ROW_IDX',
222
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_ARRAY_LENGTHS_NOTE_HASHES_ROW_IDX',
223
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_ARRAY_LENGTHS_NULLIFIERS_ROW_IDX',
224
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_ARRAY_LENGTHS_L2_TO_L1_MSGS_ROW_IDX',
225
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_ARRAY_LENGTHS_PUBLIC_LOGS_ROW_IDX',
226
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_ARRAY_LENGTHS_PUBLIC_DATA_WRITES_ROW_IDX',
227
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_ROW_IDX',
228
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_NOTE_HASHES_ROW_IDX',
229
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_NULLIFIERS_ROW_IDX',
230
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_L2_TO_L1_MSGS_ROW_IDX',
231
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_PUBLIC_LOGS_ROW_IDX',
232
- 'AVM_PUBLIC_INPUTS_AVM_ACCUMULATED_DATA_PUBLIC_DATA_WRITES_ROW_IDX',
233
- 'AVM_PUBLIC_INPUTS_TRANSACTION_FEE_ROW_IDX',
234
- 'AVM_PUBLIC_INPUTS_REVERTED_ROW_IDX',
235
- 'AVM_PUBLIC_INPUTS_COLUMNS_MAX_LENGTH',
236
- 'AVM_NUM_PUBLIC_INPUT_COLUMNS',
237
- 'AVM_PUBLIC_INPUTS_COLUMNS_COMBINED_LENGTH',
238
- 'AVM_SUBTRACE_ID_EXECUTION',
239
- 'AVM_SUBTRACE_ID_ALU',
240
- 'AVM_SUBTRACE_ID_CAST',
241
- 'AVM_SUBTRACE_ID_SET',
242
- 'AVM_SUBTRACE_ID_BITWISE',
243
- 'AVM_SUBTRACE_ID_POSEIDON2_PERM',
244
- 'AVM_SUBTRACE_ID_TO_RADIX',
245
- 'AVM_SUBTRACE_ID_ECC',
246
- 'AVM_SUBTRACE_ID_KECCAKF1600',
247
- 'AVM_SUBTRACE_ID_CALLDATA_COPY',
248
- 'AVM_SUBTRACE_ID_SHA256_COMPRESSION',
249
- 'AVM_SUBTRACE_ID_RETURNDATA_COPY',
250
- 'AVM_DYN_GAS_ID_CALLDATACOPY',
251
- 'AVM_DYN_GAS_ID_RETURNDATACOPY',
252
- 'AVM_DYN_GAS_ID_TORADIX',
253
- 'AVM_DYN_GAS_ID_BITWISE',
254
- 'AVM_DYN_GAS_ID_EMITPUBLICLOG',
255
- 'AVM_DYN_GAS_ID_SSTORE',
256
- 'AVM_SUBTRACE_ID_GETCONTRACTINSTANCE',
257
- 'AVM_SUBTRACE_ID_EMITPUBLICLOG',
258
- 'AVM_EXEC_OP_ID_GETENVVAR',
259
- 'AVM_EXEC_OP_ID_MOV',
260
- 'AVM_EXEC_OP_ID_JUMP',
261
- 'AVM_EXEC_OP_ID_JUMPI',
262
- 'AVM_EXEC_OP_ID_CALL',
263
- 'AVM_EXEC_OP_ID_STATICCALL',
264
- 'AVM_EXEC_OP_ID_INTERNALCALL',
265
- 'AVM_EXEC_OP_ID_INTERNALRETURN',
266
- 'AVM_EXEC_OP_ID_RETURN',
267
- 'AVM_EXEC_OP_ID_REVERT',
268
- 'AVM_EXEC_OP_ID_SUCCESSCOPY',
269
- 'AVM_EXEC_OP_ID_ALU_ADD',
270
- 'AVM_EXEC_OP_ID_ALU_SUB',
271
- 'AVM_EXEC_OP_ID_ALU_MUL',
272
- 'AVM_EXEC_OP_ID_ALU_DIV',
273
- 'AVM_EXEC_OP_ID_ALU_FDIV',
274
- 'AVM_EXEC_OP_ID_ALU_EQ',
275
- 'AVM_EXEC_OP_ID_ALU_LT',
276
- 'AVM_EXEC_OP_ID_ALU_LTE',
277
- 'AVM_EXEC_OP_ID_ALU_NOT',
278
- 'AVM_EXEC_OP_ID_ALU_SHL',
279
- 'AVM_EXEC_OP_ID_ALU_SHR',
280
- 'AVM_EXEC_OP_ID_ALU_TRUNCATE',
281
- 'AVM_EXEC_OP_ID_RETURNDATASIZE',
282
- 'AVM_EXEC_OP_ID_DEBUGLOG',
283
- 'AVM_EXEC_OP_ID_SLOAD',
284
- 'AVM_EXEC_OP_ID_SSTORE',
285
- 'AVM_EXEC_OP_ID_NOTEHASH_EXISTS',
286
- 'AVM_EXEC_OP_ID_EMIT_NOTEHASH',
287
- 'AVM_EXEC_OP_ID_L1_TO_L2_MESSAGE_EXISTS',
288
- 'AVM_EXEC_OP_ID_NULLIFIER_EXISTS',
289
- 'AVM_EXEC_OP_ID_EMIT_NULLIFIER',
290
- 'AVM_EXEC_OP_ID_SENDL2TOL1MSG',
291
- 'AVM_WRITTEN_PUBLIC_DATA_SLOTS_TREE_HEIGHT',
292
- 'AVM_WRITTEN_PUBLIC_DATA_SLOTS_TREE_INITIAL_ROOT',
293
- 'AVM_WRITTEN_PUBLIC_DATA_SLOTS_TREE_INITIAL_SIZE',
294
- 'AVM_RETRIEVED_BYTECODES_TREE_HEIGHT',
295
- 'AVM_RETRIEVED_BYTECODES_TREE_INITIAL_ROOT',
296
- 'AVM_RETRIEVED_BYTECODES_TREE_INITIAL_SIZE',
297
- 'NOTE_HASH_TREE_LEAF_COUNT',
298
- 'L1_TO_L2_MSG_TREE_LEAF_COUNT',
299
- 'FLAT_PUBLIC_LOGS_HEADER_LENGTH',
300
- 'FLAT_PUBLIC_LOGS_PAYLOAD_LENGTH',
301
- 'PUBLIC_LOGS_LENGTH',
302
- 'PUBLIC_LOG_HEADER_LENGTH',
303
- 'MAX_PROTOCOL_CONTRACTS'
304
- ];
305
- const PIL_GENERATORS = [
306
- 'PARTIAL_ADDRESS',
307
- 'CONTRACT_ADDRESS_V1',
308
- 'CONTRACT_CLASS_ID',
309
- 'PUBLIC_KEYS_HASH',
310
- 'NOTE_HASH_NONCE',
311
- 'UNIQUE_NOTE_HASH',
312
- 'SILOED_NOTE_HASH',
313
- 'SILOED_NULLIFIER',
314
- 'PUBLIC_LEAF_SLOT',
315
- 'PUBLIC_STORAGE_MAP_SLOT',
316
- 'PUBLIC_CALLDATA',
317
- 'PUBLIC_BYTECODE'
318
- ];
319
- const SOLIDITY_CONSTANTS = [
320
- 'MAX_FIELD_VALUE',
321
- 'MAX_L2_TO_L1_MSGS_PER_TX',
322
- 'EMPTY_EPOCH_OUT_HASH',
323
- 'L1_TO_L2_MSG_SUBTREE_HEIGHT',
324
- 'NUM_MSGS_PER_BASE_PARITY',
325
- 'NUM_BASE_PARITY_PER_ROOT_PARITY',
326
- 'BLS12_POINT_COMPRESSED_BYTES',
327
- 'ROOT_ROLLUP_PUBLIC_INPUTS_LENGTH',
328
- 'INITIAL_CHECKPOINT_NUMBER',
329
- 'GENESIS_ARCHIVE_ROOT',
330
- 'FEE_JUICE_ADDRESS',
331
- 'MAX_CHECKPOINTS_PER_EPOCH'
332
- ];
333
- /**
334
- * Processes a collection of constants and generates code to export them as TypeScript constants.
335
- *
336
- * @param constants - An object containing key-value pairs representing constants.
337
- * @returns A string containing code that exports the constants as TypeScript constants.
338
- */ function processConstantsTS(constants) {
339
- const code = [];
340
- Object.entries(constants).forEach(([key, value])=>{
341
- code.push(`export const ${key} = ${+value > Number.MAX_SAFE_INTEGER ? value + 'n' : value};`);
342
- });
343
- return code.join('\n');
344
- }
345
- /**
346
- * Processes a collection of constants and generates code to export them as cpp constants.
347
- * Required to ensure consistency between the constants used in pil and used in the vm witness generator.
348
- *
349
- * @param constants - An object containing key-value pairs representing constants.
350
- * @returns A string containing code that exports the constants as cpp constants.
351
- */ function processConstantsCpp(constants, generatorIndices) {
352
- const code = [];
353
- Object.entries(constants).forEach(([key, value])=>{
354
- if (CPP_CONSTANTS.includes(key) || key.startsWith('AVM_')) {
355
- if (BigInt(value) <= 2n ** 31n - 1n) {
356
- code.push(`#define ${key} ${value}`);
357
- } else if (BigInt(value) <= 2n ** 64n - 1n) {
358
- code.push(`#define ${key} 0x${BigInt(value).toString(16)}`); // hex literals
359
- } else {
360
- code.push(`#define ${key} "0x${BigInt(value).toString(16).padStart(64, '0')}"`); // stringify large numbers
361
- }
362
- }
363
- });
364
- Object.entries(generatorIndices).forEach(([key, value])=>{
365
- if (CPP_GENERATORS.includes(key)) {
366
- code.push(`#define DOM_SEP__${key} ${value}UL`);
367
- }
368
- });
369
- return code.join('\n');
370
- }
371
- /**
372
- * Processes a collection of constants and generates code to export them as PIL constants.
373
- * Required to ensure consistency between the constants used in pil and used in the vm witness generator.
374
- *
375
- * @param constants - An object containing key-value pairs representing constants.
376
- * @returns A string containing code that exports the constants as cpp constants.
377
- */ function processConstantsPil(constants, generatorIndices) {
378
- const code = [];
379
- Object.entries(constants).forEach(([key, value])=>{
380
- if (PIL_CONSTANTS.includes(key)) {
381
- code.push(` pol ${key} = ${value};`);
382
- }
383
- });
384
- Object.entries(generatorIndices).forEach(([key, value])=>{
385
- if (PIL_GENERATORS.includes(key)) {
386
- code.push(` pol DOM_SEP__${key} = ${value};`);
387
- }
388
- });
389
- return code.join('\n');
390
- }
391
- /**
392
- * Processes an enum and generates code to export it as a TypeScript enum.
393
- *
394
- * @param enumName - The name of the enum.
395
- * @param enumValues - An object containing key-value pairs representing enum values.
396
- * @returns A string containing code that exports the enum as a TypeScript enum.
397
- */ function processEnumTS(enumName, enumValues) {
398
- const code = [];
399
- code.push(`export enum ${enumName} {`);
400
- Object.entries(enumValues).forEach(([key, value])=>{
401
- code.push(` ${key} = ${value},`);
402
- });
403
- code.push('}');
404
- return code.join('\n');
405
- }
406
- /**
407
- * Processes a collection of constants and generates code to export them as Solidity constants.
408
- *
409
- * @param constants - An object containing key-value pairs representing constants.
410
- * @param prefix - A prefix to add to the constant names.
411
- * @returns A string containing code that exports the constants as Noir constants.
412
- */ function processConstantsSolidity(constants, prefix = '') {
413
- const code = [];
414
- Object.entries(constants).forEach(([key, value])=>{
415
- if (SOLIDITY_CONSTANTS.includes(key)) {
416
- code.push(` uint256 internal constant ${prefix}${key} = ${value};`);
417
- }
418
- });
419
- return code.join('\n');
420
- }
421
- /**
422
- * Generate the constants file in Typescript.
423
- */ function generateTypescriptConstants({ constants, domainSeparatorEnum }, targetPath) {
424
- const result = [
425
- '// GENERATED FILE - DO NOT EDIT, RUN yarn remake-constants',
426
- processConstantsTS(constants),
427
- processEnumTS('DomainSeparator', domainSeparatorEnum)
428
- ].join('\n');
429
- fs.writeFileSync(targetPath, result);
430
- }
431
- /**
432
- * Generate the constants file in C++.
433
- */ function generateCppConstants({ constants, domainSeparatorEnum }, targetPath) {
434
- const resultCpp = `// GENERATED FILE - DO NOT EDIT, RUN yarn remake-constants in yarn-project/constants
435
- #pragma once
436
-
437
- ${processConstantsCpp(constants, domainSeparatorEnum)}
438
- `;
439
- fs.writeFileSync(targetPath, resultCpp);
440
- }
441
- /**
442
- * Generate the constants file in PIL.
443
- */ function generatePilConstants({ constants, domainSeparatorEnum }, targetPath) {
444
- const resultPil = `// GENERATED FILE - DO NOT EDIT, RUN yarn remake-constants in yarn-project/constants
445
- namespace constants;
446
- ${processConstantsPil(constants, domainSeparatorEnum)}
447
- \n`;
448
- fs.writeFileSync(targetPath, resultPil);
449
- }
450
- /**
451
- * Generate the constants file in Solidity.
452
- */ function generateSolidityConstants({ constants }, targetPath) {
453
- const resultSolidity = `// GENERATED FILE - DO NOT EDIT, RUN yarn remake-constants in yarn-project/constants
454
- // SPDX-License-Identifier: Apache-2.0
455
- // Copyright 2023 Aztec Labs.
456
- pragma solidity >=0.8.27;
457
-
458
- /**
459
- * @title Constants Library
460
- * @author Aztec Labs
461
- * @notice Library that contains constants used throughout the Aztec protocol
462
- */
463
- library Constants {
464
- // Prime field modulus
465
- uint256 internal constant P =
466
- 21888242871839275222246405745257275088548364400416034343698204186575808495617;
467
-
468
- ${processConstantsSolidity(constants)}
469
- }\n`;
470
- fs.writeFileSync(targetPath, resultSolidity);
471
- }
472
- /**
473
- * Parse the content of the constants file in Noir.
474
- */ function parseNoirFile(fileContent) {
475
- const constantsExpressions = [];
476
- const domainSeparatorEnum = {};
477
- const emptyExpression = ()=>({
478
- name: '',
479
- content: []
480
- });
481
- let expression = emptyExpression();
482
- fileContent.split('\n').forEach((l)=>{
483
- const line = l.trim();
484
- if (!line) {
485
- // Empty line.
486
- return;
487
- }
488
- if (line.match(/^\/\/|^\s*\/?\*/)) {
489
- // Comment.
490
- return;
491
- }
492
- {
493
- const [, name, _type, value, end] = line.match(/global\s+(\w+)(\s*:\s*\w+)?\s*=\s*([^;]*)(;)?/) || [];
494
- if (name && value) {
495
- const [, indexName] = name.match(/DOM_SEP__(\w+)/) || [];
496
- if (indexName) {
497
- // Generator index.
498
- domainSeparatorEnum[indexName] = +value;
499
- } else if (end) {
500
- // A single line of expression.
501
- constantsExpressions.push([
502
- name,
503
- value
504
- ]);
505
- } else {
506
- // The first line of an expression.
507
- expression = {
508
- name,
509
- content: [
510
- value
511
- ]
512
- };
513
- }
514
- return;
515
- } else if (name) {
516
- // This case happens if we have only a name, with the value being on the next line
517
- expression = {
518
- name,
519
- content: []
520
- };
521
- return;
522
- }
523
- }
524
- if (expression.name) {
525
- // The expression continues...
526
- const [, content, end] = line.match(/\s*([^;]+)(;)?/) || [];
527
- expression.content.push(content);
528
- if (end) {
529
- // The last line of an expression.
530
- constantsExpressions.push([
531
- expression.name,
532
- expression.content.join('')
533
- ]);
534
- expression = emptyExpression();
535
- }
536
- return;
537
- }
538
- if (!line.includes('use crate')) {
539
- // eslint-disable-next-line no-console
540
- console.warn(`Unknown content: ${line}`);
541
- }
542
- });
543
- const constants = evaluateExpressions(constantsExpressions);
544
- return {
545
- constants,
546
- domainSeparatorEnum
547
- };
548
- }
549
- /**
550
- * Converts constants defined as expressions to constants with actual values.
551
- * @param expressions Ordered list of expressions of the type: "CONSTANT_NAME: expression".
552
- * where the expression is a string that can be evaluated to a number.
553
- * For example: "CONSTANT_NAME: 2 + 2" or "CONSTANT_NAME: CONSTANT_A * CONSTANT_B".
554
- * @returns Parsed expressions of the form: "CONSTANT_NAME: number_as_string".
555
- */ function evaluateExpressions(expressions) {
556
- const constants = {};
557
- const knownBigInts = [
558
- 'AZTEC_EPOCH_DURATION',
559
- 'FEE_RECIPIENT_LENGTH'
560
- ];
561
- // Create JS expressions. It is not as easy as just evaluating the expression!
562
- // We basically need to convert everything to BigInts, otherwise things don't fit.
563
- // However, (1) the bigints need to be initialized from strings; (2) everything needs to
564
- // be a bigint, even the actual constant values!
565
- const prelude = expressions.map(([name, rhs])=>{
566
- const guardedRhs = rhs// Remove 'as u8', 'as u32' and 'as u64' castings
567
- .replaceAll(' as u8', '').replaceAll(' as u32', '').replaceAll(' as u64', '')// Remove the 'AztecAddress::from_field(...)' pattern.
568
- // Also copes with the noir formatter re-formatting over multiple lines.
569
- .replace(/AztecAddress::from_field\(\s*(0x[a-fA-F0-9]+|\d+)\s*,?\s*\)/gs, '$1')// We make some space around the parentheses, so that constant numbers are still split.
570
- .replace(/\(/g, '( ').replace(/\)/g, ' )')// We also make some space around common operators
571
- .replace(/\+/g, ' + ').replace(/(?<!\/)\*(?!\/)/, ' * ')// We split the expression into terms...
572
- .split(/\s+/)// ...and then we convert each term to a BigInt if it is a number.
573
- .map((term)=>{
574
- // Remove underscores from numeric literals (e.g., 6_000_000 -> 6000000)
575
- const termWithoutUnderscores = term.replace(/_/g, '');
576
- return isNaN(+termWithoutUnderscores) ? term : `BigInt('${termWithoutUnderscores}')`;
577
- })// .. also, we convert the known bigints to BigInts.
578
- .map((term)=>knownBigInts.includes(term) ? `BigInt(${term})` : term)// We join the terms back together.
579
- .join(' ');
580
- return `var ${name} = ${guardedRhs};`;
581
- }).join('\n');
582
- // Extract each value from the expressions. Observe that this will still be a string,
583
- // so that we can then choose to express it as BigInt or Number depending on the size.
584
- for (const [name, _] of expressions){
585
- constants[name] = eval(prelude + `; BigInt(${name}).toString()`);
586
- }
587
- return constants;
588
- }
589
- /**
590
- * Convert the Noir constants to TypeScript and Solidity.
591
- */ function main() {
592
- const __dirname = dirname(fileURLToPath(import.meta.url));
593
- const noirConstantsFile = join(__dirname, NOIR_CONSTANTS_FILE);
594
- const noirConstants = fs.readFileSync(noirConstantsFile, 'utf-8');
595
- const parsedContent = parseNoirFile(noirConstants);
596
- // Typescript
597
- const tsTargetPath = join(__dirname, TS_CONSTANTS_FILE);
598
- generateTypescriptConstants(parsedContent, tsTargetPath);
599
- // Cpp
600
- const cppTargetPath = join(__dirname, CPP_AZTEC_CONSTANTS_FILE);
601
- generateCppConstants(parsedContent, cppTargetPath);
602
- // PIL
603
- const pilTargetPath = join(__dirname, PIL_AZTEC_CONSTANTS_FILE);
604
- generatePilConstants(parsedContent, pilTargetPath);
605
- // Solidity
606
- const solidityTargetPath = join(__dirname, SOLIDITY_CONSTANTS_FILE);
607
- fs.mkdirSync(dirname(solidityTargetPath), {
608
- recursive: true
609
- });
610
- generateSolidityConstants(parsedContent, solidityTargetPath);
611
- }
612
- main();