refactor: v1 v2 split

.github/workflows/generated-files.yaml → .github/workflows/generated-files_v1.yaml

@@ -1,9 +1,11 @@
-name: Generated Files are Updated
+name: Generated Files are Updated (V1)
 
 on:
   push:
     branches:
       - main
+    paths:
+      - 'v1/**'
   pull_request:
     branches:
       - "*"
@@ -13,14 +15,16 @@ on:
       - reopened
       - ready_for_review
 
+defaults:
+  run:
+    working-directory: ./v1
+
 jobs:
   generate:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
-        with:
-          submodules: recursive
 
       - name: Setup Node.js
         uses: actions/setup-node@v4
@@ -40,9 +44,6 @@ jobs:
           tar -zxvf geth-alltools-linux-amd64-1.11.5-a38f4108.tar.gz
           sudo mv geth-alltools-linux-amd64-1.11.5-a38f4108/abigen /usr/local/bin/
 
-      - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@v1
-
       - name: Generate Go packages and typechain-types
         run: |
           yarn generate

.github/workflows/lint.yaml → .github/workflows/lint_v1.yaml

@@ -1,9 +1,11 @@
-name: Lint TS/JS
+name: Lint TS/JS (V1)
 
 on:
   push:
     branches:
       - main
+    paths:
+      - 'v1/**'
   pull_request:
     branches:
       - "*"
@@ -13,25 +15,24 @@ on:
       - reopened
       - ready_for_review
 
+defaults:
+  run:
+    working-directory: ./v1
+
 jobs:
   lint:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3
-        with:
-          submodules: recursive
 
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
           node-version: "18"
           registry-url: "https://registry.npmjs.org"
 
-      - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@v1
-
       - name: Install Dependencies
         run: yarn install
 

.github/workflows/build.yaml → .github/workflows/lint_v2.yaml

@@ -1,9 +1,11 @@
-name: Build
+name: Lint TS/JS/Sol (V2)
 
 on:
   push:
     branches:
       - main
+    paths:
+      - 'v2/**'
   pull_request:
     branches:
       - "*"
@@ -13,22 +15,34 @@ on:
       - reopened
       - ready_for_review
 
+defaults:
+  run:
+    working-directory: ./v2
+
 jobs:
   lint:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
 
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: "18"
+          node-version: "21.1.0"
           registry-url: "https://registry.npmjs.org"
 
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+
       - name: Install Dependencies
         run: yarn install
 
-      - name: Build
-        run: yarn build
+      - name: Lint JavaScript/TypeScript
+        run: yarn lint
+
+      - name: Lint Solidity
+        run: forge fmt --check

.github/workflows/publish-npm.yaml → .github/workflows/publish-npm_v1.yaml

@@ -1,28 +1,27 @@
-name: Publish to NPM
+name: Publish to NPM (V1)
 
 on:
   release:
     types: [published]
 
+defaults:
+  run:
+    working-directory: ./v1
+
 jobs:
   publish:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v3
-        with:
-          submodules: recursive
 
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
           node-version: "18"
           registry-url: "https://registry.npmjs.org"
 
-      - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@v1
-
       - name: Install Dependencies
         run: yarn install
 

.github/workflows/slither.yaml → .github/workflows/slither_v2.yaml

@@ -1,9 +1,11 @@
-name: Slither
+name: Slither (V2)
 
 on:
   push:
     branches:
       - main
+    paths:
+      - 'v2/**'
   pull_request:
     branches:
       - "*"
@@ -13,6 +15,10 @@ on:
       - reopened
       - ready_for_review
 
+defaults:
+  run:
+    working-directory: ./v2
+
 jobs:
   slither:
     runs-on: ubuntu-latest
@@ -22,14 +28,14 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
         with:
           submodules: recursive
 
       - name: Install Node.js
         uses: actions/setup-node@v2
         with:
-          node-version: "18"
+          node-version: "21.1.0"
 
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
@@ -38,15 +44,15 @@ jobs:
         run: yarn install
 
       - name: Build project
-        run: yarn build
+        run: forge build
 
       - name: Run Slither
         uses: crytic/slither-action@main
         id: slither
         continue-on-error: true
         with:
           sarif: results.sarif
-          node-version: "18"
+          node-version: "21.1.0"
           fail-on: none
 
       - name: Upload SARIF file

.github/workflows/test.yaml → .github/workflows/test_v1.yaml

@@ -1,9 +1,11 @@
-name: Test
+name: Test (V1)
 
 on:
   push:
     branches:
       - main
+    paths:
+      - 'v1/**'
   pull_request:
     branches:
       - "*"
@@ -13,33 +15,29 @@ on:
       - reopened
       - ready_for_review
 
+defaults:
+  run:
+    working-directory: ./v1
+
 jobs:
   test:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout Repository
         uses: actions/checkout@v4
-        with:
-          submodules: recursive
 
       - name: Setup Node.js
         uses: actions/setup-node@v4
         with:
           node-version: "18.0.0"
           registry-url: "https://registry.npmjs.org"
 
-      - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@v1
-
       - name: Install Dependencies
         run: yarn install
 
       - name: Build project
         run: yarn build
-
-      - name: Test (foundry)
-        run: yarn test:foundry
-
+
       - name: Test (hardhat)
         run: yarn test

.github/workflows/coverage.yaml → .github/workflows/test_v2.yaml

@@ -1,9 +1,11 @@
-name: Coverage
+name: Test (V2)
 
 on:
   push:
     branches:
       - main
+    paths:
+      - 'v2/**'
   pull_request:
     branches:
       - "*"
@@ -13,27 +15,36 @@ on:
       - reopened
       - ready_for_review
 
+defaults:
+  run:
+    working-directory: ./v2
+
 jobs:
-  coverage:
+  test:
     runs-on: ubuntu-latest
 
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
+        with:
+          submodules: recursive
 
       - name: Setup Node.js
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: "18"
+          node-version: "21.1.0"
           registry-url: "https://registry.npmjs.org"
 
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
 
       - name: Install Dependencies
         run: yarn install
+
+      - name: Test
+        run: yarn test
 
-      - name: Test with coverage
+      - name: Coverage
         run: yarn coverage
 
       - name: Upload coverage reports to Codecov

.gitignore

@@ -37,3 +37,4 @@ crytic-export
 
 out
 cache_forge
+broadcast

.gitmodules

@@ -1,6 +1,9 @@
-[submodule "lib/forge-std"]
-	path = lib/forge-std
-	url = https://github.com/foundry-rs/forge-std
-[submodule "lib/openzeppelin-foundry-upgrades"]
-	path = lib/openzeppelin-foundry-upgrades
+[submodule "v2/lib/openzeppelin-foundry-upgrades"]
+	path = v2/lib/openzeppelin-foundry-upgrades
 	url = https://github.com/OpenZeppelin/openzeppelin-foundry-upgrades
+[submodule "v2/lib/forge-std"]
+	path = v2/lib/forge-std
+	url = https://github.com/foundry-rs/forge-std
+[submodule "v2/lib/openzeppelin-contracts-upgradeable"]
+	path = v2/lib/openzeppelin-contracts-upgradeable
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts-upgradeable

README.md

@@ -0,0 +1,13 @@
+# ZetaChain Protocol Contracts
+
+Contracts of official protocol contracts deployed by the core ZetaChain team.
+
+## Learn more about ZetaChain
+
+* Check our [website](https://www.zetachain.com/).
+* Read our [docs](https://docs.zetachain.com/).
+
+## Packages
+
+- [v1 legacy contracts](v1)
+- [v2 new contracts (currently in development)](v2)