@aztec/constants 0.0.1-commit.a072138 → 0.0.1-commit.a5db02d

package/dest/scripts/constants.in.js

@@ -3,9 +3,23 @@ import { dirname, join } from 'path';
 import { fileURLToPath } from 'url';
 const NOIR_CONSTANTS_FILE = '../../../../noir-projects/noir-protocol-circuits/crates/types/src/constants.nr';
 const TS_CONSTANTS_FILE = '../constants.gen.ts';
-const CPP_AZTEC_CONSTANTS_FILE = '../../../../barretenberg/cpp/src/barretenberg/vm2/common/aztec_constants.hpp';
+const CPP_AZTEC_CONSTANTS_FILE = '../../../../barretenberg/cpp/src/barretenberg/aztec/aztec_constants.hpp';
 const PIL_AZTEC_CONSTANTS_FILE = '../../../../barretenberg/cpp/pil/vm2/constants_gen.pil';
 const SOLIDITY_CONSTANTS_FILE = '../../../../l1-contracts/src/core/libraries/ConstantsGen.sol';
+// Additional Noir source files (outside constants.nr) to extract specific constants from, keyed by
+// file path (relative to this script) and the exact constant names to pull from each. Used for
+// constants that are defined alongside circuit code rather than in constants.nr, so they can be
+// exported to the generated TS constants without duplicating their definition. The referenced
+// constants may depend on constants.nr values, which are in scope because they are evaluated after
+// the main file's constants.
+const ADDITIONAL_NOIR_CONSTANT_FILES = [
+    {
+        file: '../../../../noir-projects/noir-protocol-circuits/crates/types/src/blob_data/tx_blob_data.nr',
+        constants: [
+            'MAX_TX_BLOB_DATA_SIZE_IN_FIELDS'
+        ]
+    }
+];
 // Whitelist of constants that will be copied to aztec_constants.hpp.
 // We don't copy everything as just a handful are needed, and updating them breaks the cache and triggers expensive bb builds.
 const CPP_CONSTANTS = [
@@ -21,12 +35,10 @@ const CPP_CONSTANTS = [
     'MEM_TAG_U128',
     'MEM_TAG_FF',
     'MAX_PACKED_PUBLIC_BYTECODE_SIZE_IN_FIELDS',
-    'CANONICAL_AUTH_REGISTRY_ADDRESS',
     'CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS',
     'CONTRACT_CLASS_REGISTRY_CONTRACT_ADDRESS',
-    'MULTI_CALL_ENTRYPOINT_ADDRESS',
     'FEE_JUICE_ADDRESS',
-    'PUBLIC_CHECKS_ADDRESS',
+    'TX_DA_GAS_OVERHEAD',
     'FEE_JUICE_BALANCES_SLOT',
     'UPDATED_CLASS_IDS_SLOT',
     'UPDATES_DELAYED_PUBLIC_MUTABLE_VALUES_LEN',
@@ -42,6 +54,7 @@ const CPP_CONSTANTS = [
     'MAX_NOTE_HASHES_PER_TX',
     'MAX_NULLIFIERS_PER_TX',
     'MAX_L2_TO_L1_MSGS_PER_TX',
+    'MAX_PROCESSABLE_L2_GAS',
     'MAX_PUBLIC_LOGS_PER_TX',
     'MAX_PUBLIC_DATA_UPDATE_REQUESTS_PER_TX',
     'MAX_PUBLIC_CALLS_TO_UNIQUE_CONTRACT_CLASS_IDS',
@@ -109,15 +122,18 @@ const CPP_CONSTANTS = [
     'FLAT_PUBLIC_LOGS_PAYLOAD_LENGTH',
     'PUBLIC_LOGS_LENGTH',
     'PUBLIC_LOG_HEADER_LENGTH',
+    'PUBLIC_TX_L2_GAS_OVERHEAD',
     'MAX_PROTOCOL_CONTRACTS',
     'DEFAULT_MAX_DEBUG_LOG_MEMORY_READS'
 ];
 const CPP_GENERATORS = [
     'BLOCK_HEADER_HASH',
+    'SALTED_INITIALIZATION_HASH',
     'PARTIAL_ADDRESS',
-    'CONTRACT_ADDRESS_V1',
+    'CONTRACT_ADDRESS_V2',
     'CONTRACT_CLASS_ID',
     'PUBLIC_KEYS_HASH',
+    'SINGLE_PUBLIC_KEY_HASH',
     'NOTE_HASH_NONCE',
     'UNIQUE_NOTE_HASH',
     'SILOED_NOTE_HASH',
@@ -125,7 +141,12 @@ const CPP_GENERATORS = [
     'PUBLIC_LEAF_SLOT',
     'PUBLIC_STORAGE_MAP_SLOT',
     'PUBLIC_CALLDATA',
-    'PUBLIC_BYTECODE'
+    'PUBLIC_BYTECODE',
+    'MERKLE_HASH',
+    'NULLIFIER_MERKLE',
+    'PUBLIC_DATA_MERKLE',
+    'WRITTEN_SLOTS_MERKLE',
+    'RETRIEVED_BYTECODES_MERKLE'
 ];
 const PIL_CONSTANTS = [
     'MAX_ETH_ADDRESS_VALUE',
@@ -159,12 +180,9 @@ const PIL_CONSTANTS = [
     'L1_TO_L2_MSG_TREE_HEIGHT',
     'UPDATED_CLASS_IDS_SLOT',
     'UPDATES_DELAYED_PUBLIC_MUTABLE_VALUES_LEN',
-    'CANONICAL_AUTH_REGISTRY_ADDRESS',
     'CONTRACT_INSTANCE_REGISTRY_CONTRACT_ADDRESS',
     'CONTRACT_CLASS_REGISTRY_CONTRACT_ADDRESS',
-    'MULTI_CALL_ENTRYPOINT_ADDRESS',
     'FEE_JUICE_ADDRESS',
-    'PUBLIC_CHECKS_ADDRESS',
     'FEE_JUICE_BALANCES_SLOT',
     'TIMESTAMP_OF_CHANGE_BIT_SIZE',
     'UPDATES_DELAYED_PUBLIC_MUTABLE_METADATA_BIT_SIZE',
@@ -248,10 +266,10 @@ const PIL_CONSTANTS = [
     'AVM_DYN_GAS_ID_RETURNDATACOPY',
     'AVM_DYN_GAS_ID_TORADIX',
     'AVM_DYN_GAS_ID_BITWISE',
-    'AVM_DYN_GAS_ID_EMITUNENCRYPTEDLOG',
+    'AVM_DYN_GAS_ID_EMITPUBLICLOG',
     'AVM_DYN_GAS_ID_SSTORE',
     'AVM_SUBTRACE_ID_GETCONTRACTINSTANCE',
-    'AVM_SUBTRACE_ID_EMITUNENCRYPTEDLOG',
+    'AVM_SUBTRACE_ID_EMITPUBLICLOG',
     'AVM_EXEC_OP_ID_GETENVVAR',
     'AVM_EXEC_OP_ID_MOV',
     'AVM_EXEC_OP_ID_JUMP',
@@ -300,10 +318,12 @@ const PIL_CONSTANTS = [
     'MAX_PROTOCOL_CONTRACTS'
 ];
 const PIL_GENERATORS = [
+    'SALTED_INITIALIZATION_HASH',
     'PARTIAL_ADDRESS',
-    'CONTRACT_ADDRESS_V1',
+    'CONTRACT_ADDRESS_V2',
     'CONTRACT_CLASS_ID',
     'PUBLIC_KEYS_HASH',
+    'SINGLE_PUBLIC_KEY_HASH',
     'NOTE_HASH_NONCE',
     'UNIQUE_NOTE_HASH',
     'SILOED_NOTE_HASH',
@@ -311,7 +331,12 @@ const PIL_GENERATORS = [
     'PUBLIC_LEAF_SLOT',
     'PUBLIC_STORAGE_MAP_SLOT',
     'PUBLIC_CALLDATA',
-    'PUBLIC_BYTECODE'
+    'PUBLIC_BYTECODE',
+    'MERKLE_HASH',
+    'NULLIFIER_MERKLE',
+    'PUBLIC_DATA_MERKLE',
+    'WRITTEN_SLOTS_MERKLE',
+    'RETRIEVED_BYTECODES_MERKLE'
 ];
 const SOLIDITY_CONSTANTS = [
     'MAX_FIELD_VALUE',
@@ -325,7 +350,7 @@ const SOLIDITY_CONSTANTS = [
     'INITIAL_CHECKPOINT_NUMBER',
     'GENESIS_ARCHIVE_ROOT',
     'FEE_JUICE_ADDRESS',
-    'AZTEC_MAX_EPOCH_DURATION'
+    'MAX_CHECKPOINTS_PER_EPOCH'
 ];
 /**
  * Processes a collection of constants and generates code to export them as TypeScript constants.
@@ -417,30 +442,30 @@ const SOLIDITY_CONSTANTS = [
 }
 /**
  * Generate the constants file in Typescript.
- */ function generateTypescriptConstants({ constants, generatorIndexEnum }, targetPath) {
+ */ function generateTypescriptConstants({ constants, domainSeparatorEnum }, targetPath) {
     const result = [
         '// GENERATED FILE - DO NOT EDIT, RUN yarn remake-constants',
         processConstantsTS(constants),
-        processEnumTS('GeneratorIndex', generatorIndexEnum)
+        processEnumTS('DomainSeparator', domainSeparatorEnum)
     ].join('\n');
     fs.writeFileSync(targetPath, result);
 }
 /**
  * Generate the constants file in C++.
- */ function generateCppConstants({ constants, generatorIndexEnum }, targetPath) {
+ */ function generateCppConstants({ constants, domainSeparatorEnum }, targetPath) {
     const resultCpp = `// GENERATED FILE - DO NOT EDIT, RUN yarn remake-constants in yarn-project/constants
 #pragma once
 
-${processConstantsCpp(constants, generatorIndexEnum)}
+${processConstantsCpp(constants, domainSeparatorEnum)}
 `;
     fs.writeFileSync(targetPath, resultCpp);
 }
 /**
  * Generate the constants file in PIL.
- */ function generatePilConstants({ constants, generatorIndexEnum }, targetPath) {
+ */ function generatePilConstants({ constants, domainSeparatorEnum }, targetPath) {
     const resultPil = `// GENERATED FILE - DO NOT EDIT, RUN yarn remake-constants in yarn-project/constants
 namespace constants;
-${processConstantsPil(constants, generatorIndexEnum)}
+${processConstantsPil(constants, domainSeparatorEnum)}
 \n`;
     fs.writeFileSync(targetPath, resultPil);
 }
@@ -468,16 +493,19 @@ ${processConstantsSolidity(constants)}
 }
 /**
  * Parse the content of the constants file in Noir.
- */ function parseNoirFile(fileContent) {
+ */ function parseNoirFile(fileContent, { stripLineComments = false } = {}) {
     const constantsExpressions = [];
-    const generatorIndexEnum = {};
+    const domainSeparatorEnum = {};
     const emptyExpression = ()=>({
             name: '',
             content: []
         });
     let expression = emptyExpression();
     fileContent.split('\n').forEach((l)=>{
-        const line = l.trim();
+        // Strip trailing `//` line comments so multi-line expressions with inline comments (e.g.
+        // MAX_TX_BLOB_DATA_SIZE_IN_FIELDS) parse correctly. Disabled for constants.nr to keep its
+        // existing parsing behavior byte-for-byte unchanged.
+        const line = (stripLineComments ? l.replace(/\/\/.*$/, '') : l).trim();
         if (!line) {
             // Empty line.
             return;
@@ -492,7 +520,7 @@ ${processConstantsSolidity(constants)}
                 const [, indexName] = name.match(/DOM_SEP__(\w+)/) || [];
                 if (indexName) {
                     // Generator index.
-                    generatorIndexEnum[indexName] = +value;
+                    domainSeparatorEnum[indexName] = +value;
                 } else if (end) {
                     // A single line of expression.
                     constantsExpressions.push([
@@ -537,10 +565,9 @@ ${processConstantsSolidity(constants)}
             console.warn(`Unknown content: ${line}`);
         }
     });
-    const constants = evaluateExpressions(constantsExpressions);
     return {
-        constants,
-        generatorIndexEnum
+        constantsExpressions,
+        domainSeparatorEnum
     };
 }
 /**
@@ -567,7 +594,11 @@ ${processConstantsSolidity(constants)}
         .replace(/\(/g, '( ').replace(/\)/g, ' )')// We also make some space around common operators
         .replace(/\+/g, ' + ').replace(/(?<!\/)\*(?!\/)/, ' * ')// We split the expression into terms...
         .split(/\s+/)// ...and then we convert each term to a BigInt if it is a number.
-        .map((term)=>isNaN(+term) ? term : `BigInt('${term}')`)// .. also, we convert the known bigints to BigInts.
+        .map((term)=>{
+            // Remove underscores from numeric literals (e.g., 6_000_000 -> 6000000)
+            const termWithoutUnderscores = term.replace(/_/g, '');
+            return isNaN(+termWithoutUnderscores) ? term : `BigInt('${termWithoutUnderscores}')`;
+        })// .. also, we convert the known bigints to BigInts.
         .map((term)=>knownBigInts.includes(term) ? `BigInt(${term})` : term)// We join the terms back together.
         .join(' ');
         return `var ${name} = ${guardedRhs};`;
@@ -585,7 +616,26 @@ ${processConstantsSolidity(constants)}
     const __dirname = dirname(fileURLToPath(import.meta.url));
     const noirConstantsFile = join(__dirname, NOIR_CONSTANTS_FILE);
     const noirConstants = fs.readFileSync(noirConstantsFile, 'utf-8');
-    const parsedContent = parseNoirFile(noirConstants);
+    const { constantsExpressions, domainSeparatorEnum } = parseNoirFile(noirConstants);
+    // Pull in explicitly-listed constants defined outside constants.nr (e.g. alongside circuit code).
+    // They are appended after the main constants so they can reference them when evaluated together.
+    for (const { file, constants: names } of ADDITIONAL_NOIR_CONSTANT_FILES){
+        const additionalContent = fs.readFileSync(join(__dirname, file), 'utf-8');
+        const { constantsExpressions: additionalExpressions } = parseNoirFile(additionalContent, {
+            stripLineComments: true
+        });
+        for (const name of names){
+            const expression = additionalExpressions.find(([exprName])=>exprName === name);
+            if (!expression) {
+                throw new Error(`Constant ${name} not found in ${file}`);
+            }
+            constantsExpressions.push(expression);
+        }
+    }
+    const parsedContent = {
+        constants: evaluateExpressions(constantsExpressions),
+        domainSeparatorEnum
+    };
     // Typescript
     const tsTargetPath = join(__dirname, TS_CONSTANTS_FILE);
     generateTypescriptConstants(parsedContent, tsTargetPath);

package/package.json

@@ -1,10 +1,17 @@
 {
   "name": "@aztec/constants",
-  "version": "0.0.1-commit.a072138",
+  "version": "0.0.1-commit.a5db02d",
   "type": "module",
   "inherits": [
     "../package.common.json"
   ],
+  "typedocOptions": {
+    "entryPoints": [
+      "./src/constants.gen.ts"
+    ],
+    "name": "Constants",
+    "tsconfig": "./tsconfig.json"
+  },
   "exports": {
     ".": "./dest/constants.js"
   },
@@ -16,7 +23,7 @@
     "test": "NODE_NO_WARNINGS=1 node --experimental-vm-modules ../node_modules/.bin/jest --passWithNoTests --maxWorkers=${JEST_MAX_WORKERS:-8}"
   },
   "dependencies": {
-    "@aztec/foundation": "0.0.1-commit.a072138",
+    "@aztec/foundation": "0.0.1-commit.a5db02d",
     "tslib": "^2.4.0"
   },
   "devDependencies": {