support wasm (#9)

* support wasm * update wasm file * update submodules * fix test err * update test time * add get_transactions test * support ci-data for wasm * fix light-client ci * update ckb-light-wasm-demo * update ckb-light-wasm-demo
cryptape · Jan 2, 2025 · b54598c · b54598c
1 parent 676434d
commit b54598c
Show file tree

Hide file tree

Showing 15 changed files with 334 additions and 51 deletions.
diff --git a/.env b/.env
@@ -0,0 +1 @@
+USE_LIGHT_CLIENT_WASM=false
diff --git a/.github/workflows/ci-data-wasm.yml b/.github/workflows/ci-data-wasm.yml
@@ -0,0 +1,53 @@
+name: ci-data-wasm
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+
+jobs:
+  npm-install-1:
+    strategy:
+      fail-fast: false
+      matrix:
+        net: ['testnet_v1']
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - name: Node Cache
+        uses: actions/cache@v2
+        id: npm-and-yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+        with:
+          path: |
+            ${{ steps.yarn-cache-dir-path.outputs.dir }}
+            ~/.npm
+          key: ${{ runner.os }}-node_modules-${{ hashFiles('/home/runner/work/**/package-lock.json', '/home/runner/work/**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-node_modules-
+      - name: prepare env
+        id: runtest
+        run: |
+          npm install --save-dev mocha @types/mocha chai @types/chai
+          bash prepare_wasm.sh
+      - name: run test
+        id: ci-test
+        run: |
+          npm run test-data
+
+      - name: Publish reports
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: jfoa-build-reports-${{ runner.os }}
+          path: mochawesome-report/
diff --git a/.github/workflows/ckb-light-client-ci-wasm.yml b/.github/workflows/ckb-light-client-ci-wasm.yml
@@ -0,0 +1,54 @@
+name: ci-ckb-wasm
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+  pull_request:
+
+
+jobs:
+  npm-install-1:
+    strategy:
+      fail-fast: false
+      matrix:
+        net: ['testnet_v1']
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          submodules: recursive
+      - uses: actions/setup-node@v3
+        with:
+          node-version: '16'
+      - name: Get yarn cache directory path
+        id: yarn-cache-dir-path
+        run: echo "::set-output name=dir::$(yarn cache dir)"
+      - name: Node Cache
+        uses: actions/cache@v4
+        id: npm-and-yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
+        with:
+          path: |
+            ${{ steps.yarn-cache-dir-path.outputs.dir }}
+            ~/.npm
+          key: ${{ runner.os }}-node_modules-${{ hashFiles('/home/runner/work/**/package-lock.json', '/home/runner/work/**/yarn.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-node_modules-
+      - name: prepare env
+        id: runtest
+        run: |
+          npm install --save-dev mocha @types/mocha chai @types/chai
+          bash prepare_wasm.sh
+      - name: run test
+        id: ci-test
+        run: |
+          npm run test-wasm
+
+      - name: Publish reports
+        if: failure()
+        uses: actions/upload-artifact@v4
+        with:
+          name: jfoa-build-reports-${{ runner.os }}
+          path: mochawesome-report/
diff --git a/.gitmodules b/.gitmodules
@@ -0,0 +1,3 @@
+[submodule "ckb-light-wasm-demo"]
+	path = ckb-light-wasm-demo
+	url = https://github.com/gpBlockchain/ckb-light-wasm-demo.git
diff --git a/ckb-light-wasm-demo b/ckb-light-wasm-demo
diff --git a/config/config.ts b/config/config.ts
@@ -5,20 +5,21 @@ import {LightClientRPC} from "@ckb-lumos/light-client";
 
 const CKB_CLIENT_CLI_PATH = "tmp/ckb-cli-light-client"
 const CKB_LIGHT_CLIENT_PATH = "tmp/startBlockchain/ckbLightClient/ckb-light-client"
-const DEV_PATH = "tmp/startBlockchain/ckbDevWithIndexAndeLightClient"
-const CKB_DEV_PATH = "tmp/startBlockchain/ckbDevWithIndexAndeLightClient/ckb/target/release"
-const CKB_DEV_INDEX_PATH = "tmp/startBlockchain/ckbDevWithIndexAndeLightClient/ckb-indexer/target/release"
-const CKB_DEV_LIGHT_CLIENT_PATH = "tmp/startBlockchain/ckbDevWithIndexAndeLightClient/ckb-light-client/target/release"
+const DEV_PATH = "tmp/startBlockchain/ckbDevWithIndexAndLightClient"
+const CKB_DEV_PATH = "tmp/startBlockchain/ckbDevWithIndexAndLightClient/ckb/target/release"
+const CKB_DEV_INDEX_PATH = "tmp/startBlockchain/ckbDevWithIndexAndLightClient/ckb-indexer/target/release"
+const CKB_DEV_LIGHT_CLIENT_PATH = "tmp/startBlockchain/ckbDevWithIndexAndLightClient/ckb-light-client/target/release"
 
-const CKB_DEV_RPC_URL = "https://testnet.ckbapp.dev/";
-const CKB_DEV_RPC_INDEX_URL = "https://testnet.ckbapp.dev/";
+const CKB_DEV_RPC_URL = "http://localhost:8114/";
+const CKB_DEV_RPC_INDEX_URL = "http://localhost:8116/";
 
-const RPC_DEBUG = false
+const RPC_DEBUG = true
 const CKB_RPC_URL = "https://testnet.ckbapp.dev/";
 // const CKB_RPC_URL = CKB_DEV_RPC_URL;
 const CKB_RPC_INDEX_URL = "https://testnet.ckbapp.dev/";
 // const CKB_RPC_INDEX_URL = CKB_DEV_RPC_INDEX_URL;
 const CKB_LIGHT_RPC_URL = "http://127.0.0.1:9000";
+
 export enum FeeRate {
     SLOW = 1000,
     NORMAL = 1000000,
@@ -32,13 +33,13 @@ config.initializeConfig(
     config.predefined.AGGRON4
 );
 const script = helpers.parseAddress(
-    "ckt1qyqvjdmh4re8t7mfjr0v0z27lwwjqu384vhs6lfftr"
+    "ckt1qyqvjdmh4re8t7mfjr0v0z27lwwjqu384vhs6lfftr", {config: config.predefined.AGGRON4}
 );
-const MINER_SCRIPT = helpers.parseAddress("ckt1qyqvjdmh4re8t7mfjr0v0z27lwwjqu384vhs6lfftr")
-const MINER_SCRIPT2 = helpers.parseAddress("ckt1qyq8ph2ywxpvkl5l0rcsugcnwcfswqpqngeqqmfuwq")
-const MINER_SCRIPT3 = helpers.parseAddress("ckt1qyqd5eyygtdmwdr7ge736zw6z0ju6wsw7rssu8fcve")
+const MINER_SCRIPT = helpers.parseAddress("ckt1qyqvjdmh4re8t7mfjr0v0z27lwwjqu384vhs6lfftr", {config: config.predefined.AGGRON4})
+const MINER_SCRIPT2 = helpers.parseAddress("ckt1qyq8ph2ywxpvkl5l0rcsugcnwcfswqpqngeqqmfuwq", {config: config.predefined.AGGRON4})
+const MINER_SCRIPT3 = helpers.parseAddress("ckt1qyqd5eyygtdmwdr7ge736zw6z0ju6wsw7rssu8fcve", {config: config.predefined.AGGRON4})
 const CkbClientNode = new LightClient(CKB_LIGHT_CLIENT_PATH)
-const lightClientRPC =  new LightClientRPC(CKB_LIGHT_RPC_URL)
+const lightClientRPC = new LightClientRPC(CKB_LIGHT_RPC_URL)
 
 const deprecatedAddr = helpers.generateAddress(script);
 const newFullAddr = helpers.encodeToAddress(script);
@@ -79,6 +80,10 @@ const EVERY_ONE_CAN_PAY_TYPE_ID = {
 }
 const EVERY_ONE_CAN_PAY = EVERY_ONE_CAN_PAY_TYPE_ID
 
+export function checkLightClientWasm(): boolean {
+    return process.env.USE_LIGHT_CLIENT_WASM === 'true';
+}
+
 export {
     FEE,
     CKB_RPC_URL,

diff --git a/package.json b/package.json
@@ -39,9 +39,11 @@
     "typescript": "^3.7.3"
   },
   "scripts": {
+    "test-wasm": "USE_LIGHT_CLIENT_WASM=true mocha --config test/runners/mocha/.mocharc.jsonc --reporter mochawesome",
     "test": "mocha --config test/runners/mocha/.mocharc.jsonc --reporter mochawesome",
     "test-load": "mocha --config  test/runners/mocha/.mocharc.load.jsonc --reporter mochawesome",
     "test-data": "mocha --config  test/runners/mocha/.mocharc.data.jsonc --reporter mochawesome",
+    "test-data-wasm": "USE_LIGHT_CLIENT_WASM=true mocha mocha --config  test/runners/mocha/.mocharc.data.jsonc --reporter mochawesome",
     "test-cli": "mocha --config  test/runners/mocha/.mocharc.cli.jsonc --reporter mochawesome",
     "test-transfer-issue": "mocha --config  test/runners/mocha/.mocharc.issue.jsonc --reporter mochawesome",
     "test-index-panic": "mocha --config test/runners/mocha/.mocharc.index-panic.jsonc --reporter mochawesome",

diff --git a/prepare_wasm.sh b/prepare_wasm.sh
@@ -0,0 +1,2 @@
+cd ckb-light-wasm-demo
+bash build.sh
diff --git a/service/CkbDevService.ts b/service/CkbDevService.ts
@@ -30,7 +30,7 @@ export async function cut_miner_and_wait_lightClient_sync(cut_num: number, miner
 export async function compare_cells_result(scriptObject1: Script) {
     let compare = true;
     const indexCells = await getCellsMsg(scriptObject1, CKB_DEV_RPC_INDEX_URL)
-    console.log("lightCells:")
+
     const lightCells = await getCellsMsg(scriptObject1, CKB_LIGHT_RPC_URL)
     // get indexCells but not in light
     const indexNotInLightCells = indexCells.filter(cell => !lightCells.some(lightCell => {

diff --git a/service/node.ts b/service/node.ts
@@ -1,4 +1,6 @@
 import {exec} from "child_process";
+import {request} from "./index";
+import {checkLightClientWasm} from "../config/config";
 
 
 class LightClient {
@@ -12,23 +14,30 @@ class LightClient {
     }
 
     async start(): Promise<boolean> {
-        try{
-            await sh("rm "+this.dirPath + "/target/release/data/store/LOCK")
-        }catch(e){
-            console.log(e)
+        if (checkLightClientWasm()){
+            await request(1,this.url,"start",[])
+            return true
         }
         await sh("cd " + this.dirPath + "/target/release && RUST_LOG=info,ckb_light_client=trace ./ckb-light-client run --config-file ./config.toml > node.log 2>&1 &")
         await sleep(5*1000)
         return true
     }
 
     async stop(): Promise<boolean> {
-
+        if (checkLightClientWasm()){
+            await request(1,this.url,"stop",[])
+            return true
+        }
         await sh("pkill ckb-light")
         return true
     }
 
     async clean(): Promise<boolean> {
+        if (checkLightClientWasm()){
+            await request(1,this.url,"new_client",[])
+            await request(1,this.url,"stop",[])
+            return true
+        }
         try {
             await this.stop()
 

diff --git a/test/get_cells.spec.ts b/test/get_cells.spec.ts
@@ -1,7 +1,7 @@
 import {
     ACCOUNT_PRIVATE, EVERY_ONE_CAN_PAY_TYPE_ID,
     CKB_LIGHT_RPC_URL,
-    CKB_RPC_URL, MINER_SCRIPT, CKB_RPC_INDEX_URL, lightClientRPC, rpcCLient, indexerMockLightRpc
+    CKB_RPC_URL, MINER_SCRIPT, CKB_RPC_INDEX_URL, lightClientRPC, rpcCLient, indexerMockLightRpc, checkLightClientWasm
 } from "../config/config";
 import {AGGRON4, generateAccountFromPrivateKey, getBlockNumByTxHash, send_tx} from "../service/transfer";
 import {BI} from "@ckb-lumos/bi";
@@ -22,6 +22,9 @@ describe('get_cell', function () {
         describe('script', function () {
             describe('code_hash', function () {
                 it('length not eq 64 ', async () => {
+                    if (checkLightClientWasm()) {
+                        return
+                    }
                     let acc = generateAccountFromPrivateKey(ACCOUNT_PRIVATE)
                     acc.lockScript.codeHash = "0x9bd7e06f3ecf4be0f2fcd2188b23f1b9fcc88e5d4b65a8637b17723bbda3cce"
                     await getCellsReturnFailed({
@@ -201,7 +204,9 @@ describe('get_cell', function () {
                     })
 
                     it(',should return failed', async () => {
-
+                        if (checkLightClientWasm()) {
+                            return
+                        }
                         try {
                             await lightClientRPC.getCells(
                                 {
@@ -626,13 +631,13 @@ describe('get_cell', function () {
         });
         describe('limit', function () {
             it('0,should return error that limit should be greater than 0', async () => {
-                 await getCellsReturnFailed({
+                await getCellsReturnFailed({
                     limit: "0x0", order: "asc",
                     searchKey: {
                         script: MINER_SCRIPT,
                         scriptType: "lock"
                     }
-                },CKB_LIGHT_RPC_URL)
+                }, CKB_LIGHT_RPC_URL)
             })
             it('1', async () => {
                 let cells = await getCellsRequest({
@@ -689,11 +694,17 @@ describe('get_cell', function () {
                     }
                 }
                 let cells = await getCellsRequest(getCellReq)
+                console.log("cells.objects.length:", cells.objects.length)
                 getCellReq.limit = "0x1"
                 let allCells = await getAllCellsRequest(getCellReq)
                 expect(cells.objects.length).to.be.equal(allCells.length)
+                console.log("---allCells---")
+                printCells(allCells)
+                console.log("---cells---")
+                printCells(cells.objects)
+
                 for (let i = 0; i < cells.objects.length; i++) {
-                    expect(cells.objects[i].blockNumber).to.be.equal(allCells[i].blockNumber)
+                    expect(JSON.stringify(cells.objects[i])).to.be.equals(JSON.stringify(allCells[i]))
                 }
             })