Merge branch 'main' into bridge_additional_tests2

taikoxyz · Apr 30, 2024 · 2653e10 · 2653e10
2 parents 9dc3edf + 1045a55
commit 2653e10
Show file tree

Hide file tree

Showing 304 changed files with 23,287 additions and 7,900 deletions.
diff --git a/.github/_typos.toml b/.github/_typos.toml
@@ -0,0 +1,7 @@
+[default.extend-words]
+TGE = "TGE"
+TKO = "TKO"
+Ethereum = "Ethereum"
+
+[files]
+extend-exclude = ["packages/protocol/audit"]
diff --git a/.github/actions/install-pnpm-dependencies/action.yml b/.github/actions/install-pnpm-dependencies/action.yml
@@ -5,12 +5,12 @@ runs:
   using: "composite"
   steps:
     - name: Setup Node.js
-      uses: actions/setup-node@v3
+      uses: actions/setup-node@v4
       with:
-        node-version: 18
+        node-version: 20
 
     - name: Install pnpm
-      uses: pnpm/action-setup@v2
+      uses: pnpm/action-setup@v3
       id: pnpm-install
       with:
         version: 8
@@ -23,7 +23,7 @@ runs:
         echo "STORE_PATH=$(pnpm store path)" >> $GITHUB_OUTPUT
 
     - name: Setup pnpm cache
-      uses: actions/cache@v3
+      uses: actions/cache@v4
       with:
         path: ${{ steps.pnpm-cache.outputs.STORE_PATH }}
         key: ${{ runner.os }}-pnpm-store-${{ hashFiles('**/pnpm-lock.yaml') }}

diff --git a/.github/workflows/blobstorage.yml b/.github/workflows/blobstorage.yml
@@ -45,12 +45,12 @@ jobs:
         with:
           ref: ${{ github.ref }}
 
-      - name: Login to GCR
+      - name: Login to GAR
         uses: docker/login-action@v3
         with:
-          registry: gcr.io
+          registry: us-docker.pkg.dev
           username: _json_key
-          password: ${{ secrets.GCR_JSON_KEY }}
+          password: ${{ secrets.GAR_JSON_KEY }}
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -63,7 +63,7 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: |
-            gcr.io/evmchain/blobstorage
+            us-docker.pkg.dev/evmchain/images/blobstorage
           tags: |
             type=ref,event=branch
             type=ref,event=pr

diff --git a/.github/workflows/eventindexer.yml b/.github/workflows/eventindexer.yml
@@ -64,12 +64,12 @@ jobs:
         with:
           ref: ${{ github.ref }}
 
-      - name: Login to GCR
+      - name: Login to GAR
         uses: docker/login-action@v3
         with:
-          registry: gcr.io
+          registry: us-docker.pkg.dev
           username: _json_key
-          password: ${{ secrets.GCR_JSON_KEY }}
+          password: ${{ secrets.GAR_JSON_KEY }}
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -82,7 +82,7 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: |
-            gcr.io/evmchain/eventindexer
+            us-docker.pkg.dev/evmchain/images/eventindexer
           tags: |
             type=ref,event=branch
             type=ref,event=pr

diff --git a/.github/workflows/guardianproverhealthcheck.yaml b/.github/workflows/guardianproverhealthcheck.yaml
@@ -64,12 +64,12 @@ jobs:
         with:
           ref: ${{ github.ref }}
 
-      - name: Login to GCR
+      - name: Login to GAR
         uses: docker/login-action@v3
         with:
-          registry: gcr.io
+          registry: us-docker.pkg.dev
           username: _json_key
-          password: ${{ secrets.GCR_JSON_KEY }}
+          password: ${{ secrets.GAR_JSON_KEY }}
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -82,7 +82,7 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: |
-            gcr.io/evmchain/guardian-prover-health-check
+            us-docker.pkg.dev/evmchain/images/guardian-prover-health-check
           tags: |
             type=ref,event=branch
             type=ref,event=pr

diff --git a/.github/workflows/relayer.yml b/.github/workflows/relayer.yml
@@ -64,12 +64,12 @@ jobs:
         with:
           ref: ${{ github.ref }}
 
-      - name: Login to GCR
+      - name: Login to GAR
         uses: docker/login-action@v3
         with:
-          registry: gcr.io
+          registry: us-docker.pkg.dev
           username: _json_key
-          password: ${{ secrets.GCR_JSON_KEY }}
+          password: ${{ secrets.GAR_JSON_KEY }}
 
       - name: Set up QEMU
         uses: docker/setup-qemu-action@v3
@@ -82,7 +82,7 @@ jobs:
         uses: docker/metadata-action@v5
         with:
           images: |
-            gcr.io/evmchain/relayer
+            us-docker.pkg.dev/evmchain/images/relayer
           tags: |
             type=ref,event=branch
             type=ref,event=pr

diff --git a/.github/workflows/supplementary-contracts.yml b/.github/workflows/supplementary-contracts.yml
@@ -0,0 +1,40 @@
+name: Supplementary-Contracts
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "packages/supplementary-contracts/**"
+  pull_request:
+    paths:
+      - "packages/supplementary-contracts/**"
+
+jobs:
+  build:
+    runs-on: [taiko-runner]
+    steps:
+      - name: Cancel previous runs
+        uses: styfle/[email protected]
+        with:
+          access_token: ${{ github.token }}
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: nightly-2cb875799419c907cc3709e586ece2559e6b340e
+
+      - name: Install pnpm dependencies
+        uses: ./.github/actions/install-pnpm-dependencies
+
+      - name: Check formatting
+        working-directory: ./packages/supplementary-contracts
+        run: forge fmt --check
+
+      - name: Unit Tests
+        working-directory: ./packages/supplementary-contracts
+        run: pnpm clean && pnpm test
diff --git a/.github/workflows/taikoon.yml b/.github/workflows/taikoon.yml
@@ -0,0 +1,42 @@
+name: Taikoon
+
+on:
+  push:
+    branches: [main]
+    paths:
+      - "packages/taikoon/**"
+  pull_request:
+    paths:
+      - "packages/taikoon/**"
+
+jobs:
+  build:
+    runs-on: [taiko-runner]
+    steps:
+      - name: Cancel previous runs
+        uses: styfle/[email protected]
+        with:
+          access_token: ${{ github.token }}
+
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
+
+      - name: Install Foundry
+        uses: foundry-rs/[email protected]
+
+      - name: Install pnpm dependencies
+        uses: ./.github/actions/install-pnpm-dependencies
+
+      - name: Check formatting
+        working-directory: ./packages/taikoon
+        run: forge fmt --check
+
+      - name: Solidity compilation
+        working-directory: ./packages/taikoon
+        run: pnpm compile
+
+      - name: Unit Tests
+        working-directory: ./packages/taikoon
+        run: pnpm test
diff --git a/.github/workflows/typos.yml b/.github/workflows/typos.yml
@@ -11,3 +11,5 @@ jobs:
 
       - name: Check for typos
         uses: crate-ci/typos@master
+        with:
+          config: ${{github.workspace}}/.github/_typos.toml
diff --git a/.github/workflows/validate-pr-title.yml b/.github/workflows/validate-pr-title.yml
@@ -39,9 +39,11 @@ jobs:
             guardian-prover-health-check-ui
             protocol
             relayer
+            taikoon
+            supplementary-contracts
           requireScope: true
-          subjectPattern: ^(?![A-Z]).+$ # Require lowercase PR title
+          subjectPattern: ^(?![A-Z])(?!.*\btypo\b).+$ # Require lowercase PR title and prohibit word "typo"
           subjectPatternError: |
             The subject "{subject}" found in the pull request title "{title}"
             didn't match the configured pattern. Please ensure that the subject
-            doesn't start with an uppercase character.
+            doesn't start with an uppercase character and doesn't contains word "typo".
diff --git a/.release-please-manifest.json b/.release-please-manifest.json
@@ -1,11 +1,11 @@
 {
   "packages/blobstorage": "0.1.0",
   "packages/branding": "0.3.0",
-  "packages/bridge-ui": "4.0.0",
+  "packages/bridge-ui": "4.2.0",
   "packages/eventindexer": "0.13.0",
   "packages/fork-diff": "0.4.0",
   "packages/guardian-prover-health-check": "0.1.0",
   "packages/guardian-prover-health-check-ui": "0.1.0",
-  "packages/protocol": "1.3.0",
+  "packages/protocol": "1.4.0",
   "packages/relayer": "0.12.0"
 }
diff --git a/README.md b/README.md
@@ -44,7 +44,9 @@ taiko-mono/
 │   ├── <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 smart contracts.
-│   └── <a href="./packages/relayer">relayer</a>: Bridge backend relayer.
+│   ├── <a href="./packages/relayer">relayer</a>: Bridge backend relayer.
+│   ├── <a href="./packages/taikoon">taikoon</a>: Taikoon NFT contracts.
+│   └── <a href="./packages/supplementary-contracts">supplementary-contracts</a>: Supplementary smart contracts that are not part of the Taiko rollup protocol.
 ...
 </pre>
 
@@ -54,9 +56,9 @@ If you find a bug or have a feature request, please [open an issue](https://gith
 
 ## Contributing
 
-Check out [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to contribute.
+Check out [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to contribute. You can also check out our grants cycle at [grants.taiko.xyz](https://grants.taiko.xyz).
 
-You can also check out our grants cycle at [grants.taiko.xyz](https://grants.taiko.xyz).
+⚠️ Please refrain from submitting typo/comment-only pull requests with the expectation of receiving TKO airdrops.
 
 ## Getting support