update deps and readme (#1027)

shunjizhan · web-flow · commit 63124370a1b6 · 2024-09-26T12:14:17.000+08:00
* update deps to latest and update readme

* add back vitest

* fix
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -1,80 +1,30 @@
-name: Build Docker Images
-
+name: Build Packages
 on:
   push:
-    tags:
-      - '*'
-  workflow_dispatch:
+    paths-ignore:
+      - '**/README.md'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
 
 jobs:
-  build-eth-rpc-adapter:
+  build:
     runs-on: ubuntu-latest
     steps:
       - name: checkout
-        uses: actions/checkout@v3
-        with:
-          submodules: 'recursive'
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
+        uses: actions/checkout@v4
 
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
+      - name: setup node
+        uses: actions/setup-node@v4
         with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
+          node-version: 20
 
-      - name: Docker meta
-        id: meta
-        uses: docker/metadata-action@v4
-        with:
-          images: acala/eth-rpc-adapter
-          tags: |
-            type=semver,pattern={{version}}
-            type=raw,value={{sha}}
-            type=ref,event=branch
+      - name: setup yarn
+        run: npm install -g yarn
 
-      - name: Build and push
-        uses: docker/build-push-action@v4
-        with:
-          context: .
-          file: packages/eth-rpc-adapter/Dockerfile
-          platforms: linux/amd64,linux/arm64
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+      - name: install deps
+        run: yarn install --immutable
 
-  build-evm-subql:
-    runs-on: ubuntu-latest
-    steps:
-      - name: checkout
-        uses: actions/checkout@v3
-        with:
-          submodules: 'recursive'
-      - name: Set up Docker Buildx
-        uses: docker/setup-buildx-action@v2
-
-      - name: Login to Docker Hub
-        uses: docker/login-action@v2
-        with:
-          username: ${{ secrets.DOCKERHUB_USERNAME }}
-          password: ${{ secrets.DOCKERHUB_TOKEN }}
-
-      - name: Docker meta
-        id: meta
-        uses: docker/metadata-action@v4
-        with:
-          images: acala/evm-subql
-          tags: |
-            type=semver,pattern={{version}}
-            type=raw,value={{sha}}
-            type=ref,event=branch
-
-      - name: Build and push
-        uses: docker/build-push-action@v4
-        with:
-          context: .
-          file: packages/evm-subql/Dockerfile
-          platforms: linux/amd64,linux/arm64
-          push: true
-          tags: ${{ steps.meta.outputs.tags }}
-          labels: ${{ steps.meta.outputs.labels }}
+      - name: build
+        run: yarn build
diff --git a/.github/workflows/docker.yml b/.github/workflows/docker.yml
@@ -0,0 +1,80 @@
+name: Build Docker Images
+
+on:
+  push:
+    tags:
+      - '*'
+  workflow_dispatch:
+
+jobs:
+  build-eth-rpc-adapter:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: 'recursive'
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: acala/eth-rpc-adapter
+          tags: |
+            type=semver,pattern={{version}}
+            type=raw,value={{sha}}
+            type=ref,event=branch
+
+      - name: Build and push
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: packages/eth-rpc-adapter/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+
+  build-evm-subql:
+    runs-on: ubuntu-latest
+    steps:
+      - name: checkout
+        uses: actions/checkout@v3
+        with:
+          submodules: 'recursive'
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+
+      - name: Login to Docker Hub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: acala/evm-subql
+          tags: |
+            type=semver,pattern={{version}}
+            type=raw,value={{sha}}
+            type=ref,event=branch
+
+      - name: Build and push
+        uses: docker/build-push-action@v4
+        with:
+          context: .
+          file: packages/evm-subql/Dockerfile
+          platforms: linux/amd64,linux/arm64
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
diff --git a/README.md b/README.md
@@ -1,19 +1,16 @@
 # Acala EVM+ SDKs
+[![codecov](https://codecov.io/github/AcalaNetwork/bodhi.js/graph/badge.svg?token=knumpsfImD)](https://codecov.io/github/AcalaNetwork/bodhi.js)
+
 These are some tools and SDKs related to Acala EVM+. It also contains some examples about how to interact with EVM+ with these tools.
 
+
 Packages:
 - [bodhi.js](./packages/bodhi)
 - [eth-providers](./packages/eth-providers)
 - [eth-rpc-adapter](./packages/eth-rpc-adapter)
 - [evm-subql](./packages/evm-subql)
-- [examples](./examples)
 
 ## Getting Started
-- initialize submodules (only need to do once after git clone)
-```
-git submodule update --init --recursive
-```
-
 - install all dependencies
 ```
 yarn
@@ -24,53 +21,20 @@ yarn
 yarn build
 ```
 
-- run tests
-```
-yarn test
-```
-
-## e2e-tests
-```
-# build the bodhi-runner image
-docker build . -t bodhi-runner -f docker/bodhi-runner.Dockerfile
-yarn e2e:eth-providers
-yarn e2e:eth-rpc-adapter
-yarn e2e:waffle
-yarn e2e:hardhat
-yarn e2e:truffle
-```
-
 ## Run Tests
-### with docker
 - clean up
 ```
 docker compose down -v
 ```
 
-- run tests
+- start a chopsticks acala fork as the test node
 ```
-## build the bodhi-runner image
-docker build . -t bodhi-runner -f docker/bodhi-runner.Dockerfile
-
-## run any test
-docker compose up --abort-on-container-exit --exit-code-from=xxx --build -- xxx
-
-where xxx ∈ {
-  eth-providers-test,
-  eth-rpc-adapter-test,
-  waffle-examples-test,
-  hardhat-tutorials-test,
-  truffle-tutorials-test,
-}
-
-## run all tests (not recommended since log will be too messy)
 docker compose up
 ```
 
-we can grep container logs by
+- run tests
 ```
-docker compose logs --tail=0 --follow   # all logs
-docker logs -f <container_id>           # logs for specific container
+yarn workspace @acala-network/<pkg-name> run test:coverage
 ```
 
 ## Docker Images
diff --git a/package.json b/package.json
@@ -40,9 +40,10 @@
     "@swc/core": "^1.3.56",
     "@swc/helpers": "^0.5.1",
     "@types/eslint": "^8",
-    "@types/node": "^20.1.0",
-    "@typescript-eslint/eslint-plugin": "^5.58.0",
-    "@typescript-eslint/parser": "^5.58.0",
+    "@types/node": "^22.7.0",
+    "@typescript-eslint/eslint-plugin": "^8.7.0",
+    "@typescript-eslint/parser": "^8.7.0",
+    "@vitest/coverage-istanbul": "^2.1.1",
     "eslint": "^8.40.0",
     "eslint-import-resolver-typescript": "^3.5.5",
     "eslint-plugin-import": "^2.27.5",
@@ -52,9 +53,10 @@
     "nyc": "^17.1.0",
     "pm2": "^5.4.2",
     "ts-node": "^10.9.1",
+    "ts-node-dev": "^2.0.0",
     "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.0.4",
-    "vite-tsconfig-paths": "^4.2.0",
+    "typescript": "^5.6.0",
+    "vite-tsconfig-paths": "^4.0.0",
     "vitest": "^2.1.1"
   },
   "lint-staged": {
diff --git a/packages/bodhi/package.json b/packages/bodhi/package.json
@@ -19,10 +19,6 @@
     "bn.js": "~5.2.0",
     "ethers": "~5.7.0"
   },
-  "devDependencies": {
-    "typescript": "~4.6.3",
-    "vitest": "^2.1.1"
-  },
   "files": [
     "lib"
   ],
@@ -38,5 +34,8 @@
       "default": "./lib/*.js"
     },
     "./package.json": "./package.json"
+  },
+  "devDependencies": {
+    "vitest": "^2.1.1"
   }
 }
diff --git a/packages/eth-providers/package.json b/packages/eth-providers/package.json
@@ -28,9 +28,7 @@
     "@polkadot/api": "^12.4.2",
     "@types/bn.js": "^5.1.5",
     "@types/lru-cache": "~7.6.1",
-    "@vitest/coverage-istanbul": "^2.1.1",
     "dotenv": "~10.0.0",
-    "jsdom": "^22.0.0",
     "vitest": "^2.1.1"
   },
   "files": [
diff --git a/packages/eth-rpc-adapter/package.json b/packages/eth-rpc-adapter/package.json
@@ -29,7 +29,6 @@
     "dd-trace": "~4.16.0",
     "ethers": "~5.7.0",
     "pino": "~7.0.0-rc.3",
-    "ts-node-dev": "^2.0.0",
     "ws": "~8.2.3",
     "yargs": "16.2.0"
   },
@@ -46,9 +45,7 @@
     "nyc": "^17.1.0",
     "pino-pretty": "~7.0.1",
     "pm2": "^5.4.2",
-    "ts-node": "~10.7.0",
-    "typescript": "~4.6.3",
-    "vitest": "0.34.2"
+    "vitest": "^2.1.1"
   },
   "files": [
     "lib",
diff --git a/packages/eth-transactions/package.json b/packages/eth-transactions/package.json
@@ -9,10 +9,6 @@
     "test": "vitest",
     "test:coverage": "vitest --run --coverage"
   },
-  "devDependencies": {
-    "typescript": "~4.6.3",
-    "vitest": "^2.1.1"
-  },
   "peerDependencies": {
     "@polkadot/util-crypto": "^13.0.2"
   },
@@ -34,5 +30,8 @@
       "default": "./lib/*.js"
     },
     "./package.json": "./package.json"
+  },
+  "devDependencies": {
+    "vitest": "^2.1.1"
   }
 }
diff --git a/packages/eth-transactions/tsconfig.json b/packages/eth-transactions/tsconfig.json
@@ -2,7 +2,7 @@
   "extends": "../../tsconfig.base.json",
   "compilerOptions": {
     "outDir": "lib",
-    "rootDir": "src"
+    "rootDir": "src",
   },
   "include": ["src/**/*"],
   "exclude": ["node_modules", "lib", "src/__tests__"]
diff --git a/yarn.lock b/yarn.lock
