Merge branch 'main' into release-please--branches--main--components--…

…protocol

.github/workflows/slither.yml

@@ -0,0 +1,40 @@
+name: Slither Analysis
+
+on:
+  workflow_dispatch:
+  pull_request:
+    paths:
+      - "packages/protocol/**"
+  push:
+    branches:
+      - main
+
+jobs:
+  analyze:
+    runs-on: [taiko-runner]
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install pnpm dependencies
+        uses: ./.github/actions/install-pnpm-dependencies
+
+      # Workaround to prevent slither-action from trying to install deps with `package.json`,
+      # and since there is no lockfile it defaults `npm install` which fails because we use pnpm.
+      # See: https://github.com/crytic/slither-action/issues/44#issuecomment-1931104731
+      - name: Remove package.json
+        run: rm packages/protocol/package.json
+
+      - name: Run Slither
+        uses: crytic/[email protected]
+        id: slither
+        with:
+          target: packages/protocol
+          sarif: results.sarif
+          fail-on: config
+          slither-config: packages/protocol/slither.config.json
+          slither-args: --triage-database packages/protocol/slither.db.json
+
+      - name: Upload SARIF file
+        uses: github/codeql-action/upload-sarif@v3
+        with:
+          sarif_file: ${{ steps.slither.outputs.sarif }}

.github/workflows/typos.yml

@@ -0,0 +1,13 @@
+name: Check for typos
+
+on: [pull_request]
+
+jobs:
+  check-for-typos:
+    runs-on: [taiko-runner]
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+
+      - name: Check for typos
+        uses: crate-ci/typos@master

README.md

@@ -7,22 +7,25 @@
 </h1>
 
 <p align="center">
-  A decentralized, Ethereum-equivalent ZK-Rollup.
+  A based rollup.
 </p>
 
 <div align="center">
 
 [![Twitter Follow](https://img.shields.io/twitter/follow/taikoxyz?style=social)](https://twitter.com/taikoxyz)
 [![Discord](https://img.shields.io/discord/984015101017346058?color=%235865F2&label=Discord&logo=discord&logoColor=%23fff)](https://discord.gg/taikoxyz)
 [![YouTube](https://img.shields.io/youtube/channel/subscribers/UCxd_ARE9LtAEdnRQA6g1TaQ)](https://www.youtube.com/@taikoxyz)
+
 [![GitPOAP Badge](https://public-api.gitpoap.io/v1/repo/taikoxyz/taiko-mono/badge)](https://www.gitpoap.io/gh/taikoxyz/taiko-mono)
 [![License](https://img.shields.io/github/license/taikoxyz/taiko-mono)](https://github.com/taikoxyz/taiko-mono/blob/main/LICENSE.md)
 
 </div>
 
 ## Documentation
 
-Documentation can be found on the website at [taiko.xyz](https://taiko.xyz). There is also a README in each package, as well as comments in the source code.
+End user documentation can be found at [docs.taiko.xyz](https://docs.taiko.xyz). Protocol specs can be found [here](./packages/protocol/docs/README.md).
+
+Each package of the monorepo is well documented and includes a README.
 
 ## Project structure
 
@@ -34,9 +37,11 @@ taiko-mono/
 ├── <a href="./README.md">README.md</a>
 ├── <a href="./packages">packages</a>
 │   ├── <a href="./packages/branding">branding</a>: Taiko branding materials.
-│   ├── <a href="./packages/bridge-ui">bridge-ui</a>: Taiko bridge frontend UI.
+│   ├── <a href="./packages/bridge-ui">bridge-ui</a>: Bridge UI.
 │   ├── <a href="./packages/eventindexer">eventindexer</a>: Event indexer.
-│   ├── <a href="./packages/fork-diff">fork-diff</a>: Fork <a href="https://geth.taiko.xyz">diff page</a> (currently, for Geth).
+│   ├── <a href="./packages/fork-diff">fork-diff</a>: Fork diff page.
+│   ├── <a href="./packages/guardian-prover-health-check">guardian-prover-health-check</a>: Guardian prover health check service.
+│   ├── <a href="./packages/guardian-prover-health-check-ui">guardian-prover-health-check-ui</a>: Guardian prover health check UI.
 │   ├── <a href="./packages/protocol">protocol</a>: Taiko protocol and bridge smart contracts.
 │   └── <a href="./packages/relayer">relayer</a>: Bridge backend relayer in Go.
 ...
@@ -50,16 +55,8 @@ If you find a bug or have a feature request, please [open an issue](https://gith
 
 Check out [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to contribute.
 
-## Get help
-
-Reach out to the community on [Discord](https://discord.gg/taikoxyz) to get help.
-
-## Contributors ✨
+You can also check out our grants cycle at [grants.taiko.xyz](https://grants.taiko.xyz).
 
-Thanks goes to these wonderful people!
+## Getting support
 
-<a href="https://github.com/taikoxyz/taiko-mono/graphs/contributors">
-  <p align="center">
-    <img width="720" src="https://contrib.rocks/image?repo=taikoxyz/taiko-mono" />
-  </p>
-</a>
+Reach out to the community on [Discord](https://discord.gg/taikoxyz) if you need any help!

_typos.toml

@@ -0,0 +1,15 @@
+[files]
+# Temporarily commenting a lot so that at least *.sol files are included.
+extend-exclude = [
+    "CHANGELOG.md",
+    "*.go",
+    "*.html",
+    "*.md",
+    "*.ts",
+    "*.css",
+    "*.yaml",
+    "*.yml",
+    "*.json",
+    "**/automata-attestation/**",
+    "**/thirdparty/**",
+]

lefthook.yml

@@ -10,7 +10,7 @@ pre-commit:
       run: pnpm -F protocol lint:sol && git add {staged_files}
     protocol_ts:
       glob: "packages/protocol/**.{ts}"
-      run: pnpm -F protocol eslint:fix && git add {staged_files}
+      run: pnpm -F protocol eslint && git add {staged_files}
     repo:
       glob: "**.{json,md,yaml,yml}"
       run: pnpm prettier {staged_files} --write && git add {staged_files}

packages/fork-diff/README.md

@@ -1,5 +1,7 @@
 # Overview
 
+**See the fork diff page at [geth.taiko.xyz](https://geth.taiko.xyz).**
+
 This package contains:
 
 - An `index.html` which shows the diff between [taiko-geth](https://github.com/taikoxyz/taiko-geth) and [go-ethereum](https://github.com/ethereum/go-ethereum).

packages/guardian-prover-health-check-ui/package.json

@@ -29,7 +29,7 @@
 		"eslint-config-prettier": "^9.1.0",
 		"eslint-plugin-svelte": "^2.35.1",
 		"postcss": "^8.4.35",
-		"postcss-import": "^15.1.0",
+		"postcss-import": "^16.0.1",
 		"postcss-nesting": "^12.0.3",
 		"prettier": "^3.2.5",
 		"prettier-plugin-svelte": "^3.2.1",

packages/protocol/README.md

@@ -130,3 +130,8 @@ pnpm test:deploy
 ```
 
 This command will deploy the L1 contracts using the settings and addresses you’ve provided in the `test_deploy_on_l1.sh` script.
+
+## Running slither
+
+1. Install the latest [slither](https://github.com/crytic/slither?tab=readme-ov-file#how-to-install).
+2. From `protocol/`, execute `slither . --checklist > checklist.md` to re-generate the checklist.