Merge branch 'main' into Docs_linea_fixes

Author: antews

.github/workflows/codeql.yml

@@ -18,6 +18,9 @@ on:
       # '!**.md' will not work by itself to exclude *.md files. See https://github.com/orgs/community/discussions/25369
       - '**'
       - '!**.md'
+      - '!**.mdx'
+      - '!**/docs/**'
+      - '!docs/**'
 
 jobs:
   analyze:

.github/workflows/main.yml

@@ -122,6 +122,8 @@ jobs:
           filters: |
             has-changes-requiring-build:
               - '!**/*.md'
+              - '!**/*.mdx'
+              - '!**/docs/**'
               - '!docs/**'
           # Enables us to exclude changes in multiple file types if required
           predicate-quantifier: 'every'

.github/workflows/run-smc-tests.yml

@@ -7,8 +7,10 @@ on:
       - 'testdata/**'
       - 'prover/**'
       - '!contracts/**/*.md'
+      - '!contracts/**/*.mdx'
       - '!testdata/**/*.md'
       - '!prover/**/*.md'
+      - '!**/docs/**'
   push:
     branches:
       - main
@@ -17,8 +19,10 @@ on:
       - 'testdata/**'
       - 'prover/**'
       - '!contracts/**/*.md'
+      - '!contracts/**/*.mdx'
       - '!testdata/**/*.md'
       - '!prover/**/*.md'
+      - '!**/docs/**'
 
 env:
   GOPROXY: "https://proxy.golang.org"

.husky/pre-commit

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+# Run `npx husky` in root directory to initialize this pre-commit hook for local machine
+
+# Execute NodeJS script because
+# i.) Husky requires NodeJS -> fair assumption that machine will have NodeJS
+# ii.) Cleaner syntax and abstractions than shell scripting
+node .husky/pre-commit.js
+
+exit 0

.husky/pre-commit.js

@@ -0,0 +1,217 @@
+/**
+ * Runs as git pre-commit hook
+ * Filters the list of changed files on 'git commit'
+ * If *.ts files in specified projects are detected, runs the 'lint:ts:fix' package.json script for that project
+ * E.g. if a *.ts file is changed in /sdk, then this script will run 'pnpm run lint:ts:fix' in the /sdk project
+ */
+
+const fs = require('fs');
+const { execSync } = require('child_process');
+
+/**
+ * ENUMS
+ */
+
+// File extensions to filter for
+const FILE_EXTENSION = {
+    TYPESCRIPT: "TYPESCRIPT",
+    SOLIDITY: "SOLIDITY",
+}
+
+// Projects to filter for
+const FOLDER = {
+    BRIDGEUI: "BRIDGEUI",
+    CONTRACTS: "CONTRACTS",
+    E2E: "E2E",
+    OPERATIONS: "OPERATIONS",
+    POSTMAN: "POSTMAN",
+    SDK: "SDK",
+}
+
+// Project runtimes
+const RUNTIME = {
+    NODEJS: "NODEJS"
+}
+
+/**
+ * MAPPINGS
+ */
+
+// File extension => regex
+const FILE_EXTENSION_FILTERS = {
+    [FILE_EXTENSION.TYPESCRIPT]: "\.ts$",
+    [FILE_EXTENSION.SOLIDITY]: "\.sol$",
+};
+
+// File extension => script in package.json to run
+const FILE_EXTENSION_LINTING_COMMAND = {
+    [FILE_EXTENSION.TYPESCRIPT]: "pnpm run lint:ts:fix",
+    [FILE_EXTENSION.SOLIDITY]: "pnpm run lint:sol:fix",
+};
+
+// Project => Path in monorepo
+const FOLDER_PATH = {
+    [FOLDER.BRIDGEUI]: "bridge-ui/",
+    [FOLDER.CONTRACTS]: "contracts/",
+    [FOLDER.E2E]: "e2e/",
+    [FOLDER.OPERATIONS]: "operations/",
+    [FOLDER.POSTMAN]: "postman/",
+    [FOLDER.SDK]: "sdk/",
+};
+
+// Project => List of changed files
+const FOLDER_CHANGED_FILES = {
+    [FOLDER.BRIDGEUI]: new Array(),
+    [FOLDER.CONTRACTS]: new Array(),
+    [FOLDER.E2E]: new Array(),
+    [FOLDER.OPERATIONS]: new Array(),
+    [FOLDER.POSTMAN]: new Array(),
+    [FOLDER.SDK]: new Array(),
+};
+
+// Project => Runtime
+const FOLDER_RUNTIME = {
+    [FOLDER.BRIDGEUI]: RUNTIME.NODEJS,
+    [FOLDER.CONTRACTS]: RUNTIME.NODEJS,
+    [FOLDER.E2E]: RUNTIME.NODEJS,
+    [FOLDER.OPERATIONS]: RUNTIME.NODEJS,
+    [FOLDER.POSTMAN]: RUNTIME.NODEJS,
+    [FOLDER.SDK]: RUNTIME.NODEJS,
+};
+
+/**
+ * MAIN FUNCTION
+ */
+
+main();
+
+function main() {
+    const changedFileList = getChangedFileList();
+    partitionChangedFileList(changedFileList);
+
+    for (const folder in FOLDER) {
+        if (!isDependenciesInstalled(folder)) {
+            console.error(`Dependencies not installed in ${FOLDER_PATH[folder]}, exiting...`)
+            process.exit(1);
+        }
+        const changedFileExtensions = getChangedFileExtensions(folder);
+        executeLinting(folder, changedFileExtensions);
+    }
+
+    updateGitIndex();
+}
+
+/**
+ * HELPER FUNCTIONS
+ */
+
+/**
+ * Gets a list of changed files in the git commit
+ * @returns {string[]}
+ */
+function getChangedFileList() {
+    try {
+        const cmd = 'git diff --name-only HEAD'
+        const stdout = execSync(cmd, { encoding: 'utf8' });
+        return stdout.split('\n').filter(file => file.trim() !== '');
+    } catch (error) {
+        console.error($`Error running ${cmd}:`, error.message);
+        process.exit(1)
+    }
+}
+
+/**
+ * Partitions list of changed files from getChangedFileList() by project
+ * Stores results in FOLDER_CHANGED_FILES
+ * @param {string[]}
+ */
+function partitionChangedFileList(_changedFileList) {
+    for (const file of _changedFileList) {
+        for (const path in FOLDER) {
+            if (file.match(new RegExp(`^${FOLDER_PATH[path]}`))) {
+                FOLDER_CHANGED_FILES[path].push(file);
+            }
+        }
+    }
+}
+
+/**
+ * Checks if runtime dependencies are installed for a project
+ * @param {FOLDER}
+ * @returns {boolean}
+ */
+function isDependenciesInstalled(_folder) {
+    const runtime = FOLDER_RUNTIME[_folder];
+    const path = FOLDER_PATH[_folder];
+
+    switch(runtime) {
+        case RUNTIME.NODEJS:
+            const dependencyFolder = `${path}node_modules`
+            return fs.existsSync(dependencyFolder)
+        default:
+            console.error(`${runtime} runtime not supported.`);
+            return false
+    }
+}
+
+/**
+ * Resolve list of changed file extensions for a project
+ * @param {FOLDER}
+ * @returns {FILE_EXTENSION[]}
+ */
+function getChangedFileExtensions(_folder) {
+    // Use sets to implement early exit from loop, once we have matched all configured file extensions
+    const remainingFileExtensionsSet = new Set(Object.values(FILE_EXTENSION));
+    const foundFileExtensionsSet = new Set();
+
+    for (const file of FOLDER_CHANGED_FILES[_folder]) {
+        for (const fileExtension of remainingFileExtensionsSet) {
+            if (file.match(new RegExp(FILE_EXTENSION_FILTERS[fileExtension]))) {
+                foundFileExtensionsSet.add(fileExtension);
+                remainingFileExtensionsSet.delete(fileExtension);
+            }
+        }
+
+        // No more remaining file extensions to look for
+        if (remainingFileExtensionsSet.size == 0) break; 
+    }
+
+    return Array.from(foundFileExtensionsSet);
+}
+
+/**
+ * Execute linting command
+ * @param {FOLDER, FILE_EXTENSION[]}
+ */
+function executeLinting(_folder, _changedFileExtensions) {
+    for (const fileExtension of _changedFileExtensions) {
+        const path = FOLDER_PATH[_folder];
+        const cmd = FILE_EXTENSION_LINTING_COMMAND[fileExtension];
+        console.log(`${fileExtension} change found in ${path}, linting...`);
+        try {
+            // Execute command synchronously and stream output directly to the current stdout
+            execSync(`
+                cd ${path};
+                ${cmd};
+            `, { stdio: 'inherit' });
+        } catch (error) {
+            console.error(`Error:`, error.message);
+            console.error(`Exiting...`);
+            process.exit(1);
+        }
+    }
+}
+
+/**
+ * Redo `git add` for files updated during executeLinting(), so that they are not left out of the commit
+ * The difference between 'git add .' and 'git update-index --again', is that the latter will not include untracked files
+ */
+function updateGitIndex() {
+    try {
+        const cmd = 'git update-index --again'
+        execSync(cmd, { stdio: 'inherit' });
+    } catch (error) {
+        console.error($`Error running ${cmd}:`, error.message);
+        process.exit(1);
+    }
+}

bridge-ui/package.json

@@ -8,7 +8,8 @@
     "build": "next build",
     "start": "next start",
     "lint": "next lint",
-    "lint:fix": "next lint --fix",
+    "lint:fix": "pnpm run lint:ts:fix",
+    "lint:ts:fix": "next lint --fix",
     "clean": "rimraf node_modules .next .next-env.d.ts",
     "install:playwright": "playwright install --with-deps",
     "build:cache": "synpress",

contracts/contracts/lib/SparseMerkleProof.sol

@@ -79,7 +79,7 @@ library SparseMerkleProof {
   /**
    * @notice Hash a value using MIMC hash
    * @param _input Value to hash
-   * @return {bytes32} Mimc hash
+   * @return bytes32 Mimc hash
    */
   function mimcHash(bytes calldata _input) external pure returns (bytes32) {
     return Mimc.hash(_input);
@@ -106,7 +106,7 @@ library SparseMerkleProof {
   /**
    * @notice Hash account value
    * @param _value Encoded account value bytes (nonce, balance, storageRoot, mimcCodeHash, keccakCodeHash, codeSize)
-   * @return {bytes32} Account value hash
+   * @return bytes32 Account value hash
    */
   function hashAccountValue(bytes calldata _value) external pure returns (bytes32) {
     Account memory account = _parseAccount(_value);
@@ -128,7 +128,7 @@ library SparseMerkleProof {
   /**
    * @notice Hash storage value
    * @param _value Encoded storage value bytes
-   * @return {bytes32} Storage value hash
+   * @return bytes32 Storage value hash
    */
   function hashStorageValue(bytes32 _value) external pure returns (bytes32) {
     (bytes32 msb, bytes32 lsb) = _splitBytes32(_value);

contracts/contracts/test-contracts/OpcodeTestContract.sol

@@ -0,0 +1,34 @@
+// SPDX-License-Identifier: AGPL-3.0
+pragma solidity 0.8.19;
+
+/// @dev Not intended for mainnet or testnet deployment, only for local testing
+contract OpcodeTestContract {
+  /// @dev erc7201:opcodeTestContract.main
+  struct MainStorage {
+    uint256 gasLimit;
+  }
+
+  // keccak256(abi.encode(uint256(keccak256("opcodeTestContract.main")) - 1)) & ~bytes32(uint256(0xff))
+  bytes32 private constant MAIN_STORAGE_SLOT =
+      0xb69ece048aea1886497badfc9449787df15ad9606ca8687d17308088ee555100;
+
+  function _getMainStorage() private pure returns (MainStorage storage $) {
+    assembly {
+      $.slot := MAIN_STORAGE_SLOT
+    }
+  }
+
+  function getGasLimit() external view returns (uint256) {
+    MainStorage storage $ = _getMainStorage();
+    return $.gasLimit;
+  }
+
+  function setGasLimit() external {
+    uint256 gasLimit;
+    assembly {
+      gasLimit := gaslimit()
+    }
+    MainStorage storage $ = _getMainStorage();
+    $.gasLimit = gasLimit;
+  }
+}

contracts/docs/api/LineaRollup.md renamed to contracts/docs/api/LineaRollup.mdx

@@ -1,6 +1,4 @@
-# Solidity API
-
-## LineaRollup
+# `LineaRollup`
 
 ### CONTRACT_VERSION
 

contracts/docs/api/ZkEvmV2.md renamed to contracts/docs/api/ZkEvmV2.mdx

@@ -1,6 +1,4 @@
-# Solidity API
-
-## ZkEvmV2
+# `ZkEvmV2`
 
 ### MODULO_R
 

contracts/docs/api/interfaces/IGenericErrors.md renamed to contracts/docs/api/interfaces/IGenericErrors.mdx

@@ -1,6 +1,4 @@
-# Solidity API
-
-## IGenericErrors
+# `IGenericErrors`
 
 ### ZeroAddressNotAllowed
 

contracts/docs/api/interfaces/IMessageService.md renamed to contracts/docs/api/interfaces/IMessageService.mdx

@@ -1,6 +1,4 @@
-# Solidity API
-
-## IMessageService
+# `IMessageService`
 
 ### MessageSent
 

contracts/docs/api/interfaces/IPauseManager.md renamed to contracts/docs/api/interfaces/IPauseManager.mdx

@@ -1,6 +1,4 @@
-# Solidity API
-
-## IPauseManager
+# `IPauseManager`
 
 ### PauseTypeRole
 

contracts/docs/api/interfaces/IPermissionsManager.md renamed to contracts/docs/api/interfaces/IPermissionsManager.mdx

@@ -1,6 +1,4 @@
-# Solidity API
-
-## IPermissionsManager
+# `IPermissionsManager`
 
 ### RoleAddress
 

contracts/docs/api/interfaces/IRateLimiter.md renamed to contracts/docs/api/interfaces/IRateLimiter.mdx

@@ -1,6 +1,4 @@
-# Solidity API
-
-## IRateLimiter
+# `IRateLimiter`
 
 ### RateLimitInitialized