feat: Add check ckb node update or compatibility

nervosnetwork · Aug 18, 2023 · cb16f5a · cb16f5a
1 parent 2652061
commit cb16f5a
Show file tree

Hide file tree

Showing 20 changed files with 294 additions and 114 deletions.
diff --git a/compatible.csv b/compatible.csv
@@ -0,0 +1,5 @@
+CKB,0.110,0.109,0.108,0.107,0.106,0.105,0.104,0.103
+Neuron
+0.110,yes,yes,no,no,no,no,no,no
+0.106,no,no,yes,yes,yes,yes,no,no
+0.103,no,no,no,no,no,no,yes,yes
diff --git a/packages/neuron-ui/src/containers/Main/index.tsx b/packages/neuron-ui/src/containers/Main/index.tsx
@@ -57,6 +57,7 @@ const MainContent = () => {
         show={!!globalAlertDialog}
         title={globalAlertDialog?.title}
         message={globalAlertDialog?.message}
+        action={globalAlertDialog?.action}
         type={globalAlertDialog?.type ?? 'success'}
         onCancel={onCancelGlobalDialog}
       />

diff --git a/packages/neuron-ui/src/containers/Navbar/index.tsx b/packages/neuron-ui/src/containers/Navbar/index.tsx
@@ -2,8 +2,14 @@ import React, { useCallback, useEffect, useState } from 'react'
 import { createPortal } from 'react-dom'
 import { useLocation, NavLink, useNavigate } from 'react-router-dom'
 import { useTranslation } from 'react-i18next'
-import { NeuronWalletActions, useDispatch, useState as useGlobalState } from 'states'
-import { checkForUpdates } from 'services/remote'
+import { NeuronWalletActions, showGlobalAlertDialog, useDispatch, useState as useGlobalState } from 'states'
+import {
+  VerifyCkbVersionResult,
+  VerifyExternalCkbNodeRes,
+  checkForUpdates,
+  getVersion,
+  verifyExternalCkbNode,
+} from 'services/remote'
 import { AppUpdater as AppUpdaterSubject } from 'services/subjects'
 import Badge from 'widgets/Badge'
 import Logo from 'widgets/Icons/Logo.png'
@@ -18,7 +24,7 @@ import {
   ArrowOpenRight,
   MenuExpand,
 } from 'widgets/Icons/icon'
-import { RoutePath, clsx, useOnLocaleChange } from 'utils'
+import { RoutePath, clsx, isSuccessResponse, useOnLocaleChange } from 'utils'
 import Tooltip from 'widgets/Tooltip'
 
 import styles from './navbar.module.scss'
@@ -105,6 +111,52 @@ const Navbar = () => {
     }
   }, [])
 
+  const [verifyCkbResult, setVerifyCkbResult] = useState<VerifyExternalCkbNodeRes>()
+
+  useEffect(() => {
+    verifyExternalCkbNode().then(res => {
+      if (isSuccessResponse(res) && res.result) {
+        setVerifyCkbResult(res.result)
+      }
+    })
+  }, [])
+
+  useEffect(() => {
+    if (!verifyCkbResult) {
+      return
+    }
+    switch (verifyCkbResult.ckb) {
+      case VerifyCkbVersionResult.Same:
+      case VerifyCkbVersionResult.Compatible:
+        if (!verifyCkbResult.withIndexer) {
+          showGlobalAlertDialog({
+            type: 'warning',
+            message: t('navbar.ckb-without-indexer'),
+            action: 'ok',
+          })(dispatch)
+        }
+        break
+      case VerifyCkbVersionResult.ShouldUpdate:
+        if (version) {
+          showGlobalAlertDialog({
+            type: 'warning',
+            message: t('navbar.update-neuron-with-ckb', { version: getVersion() }),
+            action: 'ok',
+          })(dispatch)
+        }
+        break
+      case VerifyCkbVersionResult.Incompatible:
+        showGlobalAlertDialog({
+          type: 'warning',
+          message: t('navbar.ckb-node-compatible', { version: getVersion() }),
+          action: 'ok',
+        })(dispatch)
+        break
+      default:
+        break
+    }
+  }, [verifyCkbResult, version])
+
   useEffect(() => {
     if (pathname.includes(RoutePath.Settings)) {
       setIsClickedSetting(true)

diff --git a/packages/neuron-ui/src/locales/en.json b/packages/neuron-ui/src/locales/en.json
@@ -22,7 +22,10 @@
       "sync-not-start": "Sync not started yet",
       "connecting": "Connecting",
       "experimental-functions": "Experimental",
-      "s-udt": "Asset Accounts"
+      "s-udt": "Asset Accounts",
+      "update-neuron-with-ckb": "The version of the CKB node does not match Neuron (v{{ version }}), which may cause compatibility issues. Please update to the latest version of Neuron.",
+      "ckb-node-compatible": "CKB node is not compatible with Neuron (v{{ version }}), please check before using it.",
+      "ckb-without-indexer": "Please add '--indexer' option to start local node"
     },
     "network-status": {
       "tooltip": {

diff --git a/packages/neuron-ui/src/locales/zh-tw.json b/packages/neuron-ui/src/locales/zh-tw.json
@@ -22,7 +22,10 @@
       "sync-not-start": "同步尚未開始",
       "connecting": "正在連接節點",
       "experimental-functions": "實驗性功能",
-      "s-udt": "資產賬戶"
+      "s-udt": "資產賬戶",
+      "update-neuron-with-ckb": "CKB 節點版本與 Neuron (v{{ version }}) 不匹配，可能導致兼容性問題。請更新到最新版 Neuron。",
+      "ckb-node-compatible": "CKB 節點版本與 Neuron (v{{ version }}) 不兼容，請檢查後使用。",
+      "ckb-without-indexer": "請添加 '--indexer' 參數來啟動本地節點"
     },
     "network-status": {
       "tooltip": {

diff --git a/packages/neuron-ui/src/locales/zh.json b/packages/neuron-ui/src/locales/zh.json
@@ -22,7 +22,10 @@
       "sync-not-start": "同步尚未开始",
       "connecting": "正在连接节点",
       "experimental-functions": "实验性功能",
-      "s-udt": "资产账户"
+      "s-udt": "资产账户",
+      "update-neuron-with-ckb": "CKB 节点版本与 Neuron (v{{ version }}) 不匹配，可能导致兼容性问题。请更新到最新版 Neuron。",
+      "ckb-node-compatible": "CKB 节点版本与 Neuron (v{{ version }}) 不兼容，请检查后使用。",
+      "ckb-without-indexer": "请添加 '--indexer' 参数来启动本地节点"
     },
     "network-status": {
       "tooltip": {

diff --git a/packages/neuron-ui/src/services/remote/app.ts b/packages/neuron-ui/src/services/remote/app.ts
@@ -24,6 +24,22 @@ export const stopProcessMonitor = remoteApi<'ckb'>('stop-process-monitor')
 export const startProcessMonitor = remoteApi<'ckb'>('start-process-monitor')
 export const getIsCkbRunExternal = remoteApi<void, boolean>('is-ckb-run-external')
 
+export enum VerifyCkbVersionResult {
+  Same,
+  Compatible,
+  ShouldUpdate,
+  Incompatible,
+}
+
+export type VerifyExternalCkbNodeRes =
+  | {
+      ckb: VerifyCkbVersionResult
+      withIndexer: boolean
+    }
+  | undefined
+
+export const verifyExternalCkbNode = remoteApi<void, VerifyExternalCkbNodeRes>('verify-external-ckb-node')
+
 export const clearCellCache = remoteApi<Controller.ClearCache.Params>('clear-cache')
 
 export const invokeShowErrorMessage = remoteApi<{ title: string; content: string }>('show-error-message')

diff --git a/packages/neuron-ui/src/services/remote/remoteApiWrapper.ts b/packages/neuron-ui/src/services/remote/remoteApiWrapper.ts
@@ -49,6 +49,7 @@ type Action =
   | 'is-dark'
   | 'set-theme'
   | 'is-ckb-run-external'
+  | 'verify-external-ckb-node'
   // Wallets
   | 'get-all-wallets'
   | 'get-current-wallet'

diff --git a/packages/neuron-ui/src/types/App/index.d.ts b/packages/neuron-ui/src/types/App/index.d.ts
@@ -139,6 +139,7 @@ declare namespace State {
     title?: string
     message?: string
     type: 'success' | 'failed' | 'warning'
+    action?: 'ok' | 'cancel' | 'all'
     onClose?: () => void
     onOk?: () => void
     onCancel?: () => void

diff --git a/packages/neuron-ui/src/types/Subject/index.d.ts b/packages/neuron-ui/src/types/Subject/index.d.ts
@@ -67,5 +67,6 @@ declare namespace Subject {
     title?: string
     message?: string
     type: 'success' | 'failed' | 'warning'
+    action?: 'ok' | 'cancel'
   }
 }
diff --git a/packages/neuron-ui/src/widgets/AlertDialog/index.tsx b/packages/neuron-ui/src/widgets/AlertDialog/index.tsx
@@ -1,4 +1,4 @@
-import React, { useRef } from 'react'
+import React, { useMemo, useRef } from 'react'
 import { useTranslation } from 'react-i18next'
 import { useDialog } from 'utils'
 import Button from 'widgets/Button'
@@ -8,6 +8,7 @@ import Tips from 'widgets/Icons/Tips.png'
 import styles from './alertDialog.module.scss'
 
 type AlertType = 'success' | 'failed' | 'warning'
+type Action = 'ok' | 'cancel' | 'all'
 
 const AlertDialog = ({
   show,
@@ -17,6 +18,7 @@ const AlertDialog = ({
   onClose,
   onOk,
   onCancel,
+  action,
 }: {
   show?: boolean
   title?: string
@@ -25,10 +27,17 @@ const AlertDialog = ({
   onClose?: () => void
   onOk?: () => void
   onCancel?: () => void
+  action?: Action
 }) => {
   const [t] = useTranslation()
   const dialogRef = useRef<HTMLDialogElement | null>(null)
   useDialog({ show, dialogRef, onClose: onClose || (() => {}) })
+  const actions = useMemo<('cancel' | 'ok')[]>(() => {
+    if (action) {
+      return action === 'all' ? ['cancel', 'ok'] : [action]
+    }
+    return type === 'warning' ? ['cancel', 'ok'] : ['ok']
+  }, [action, type])
 
   return (
     <dialog ref={dialogRef} className={styles.alertDialog}>
@@ -38,13 +47,12 @@ const AlertDialog = ({
       <h2 className={styles.title}>{title}</h2>
       <p className={styles.message}>{message}</p>
       <div className={styles.actions}>
-        {type === 'failed' && <Button type="confirm" onClick={onCancel} label={t('common.confirm')} />}
-        {type === 'success' && <Button type="confirm" onClick={onCancel || onOk} label={t('common.confirm')} />}
-        {type === 'warning' && (
-          <>
+        {actions.map(v =>
+          v === 'cancel' ? (
             <Button type="cancel" onClick={onCancel} label={t('common.cancel')} />
-            <Button type="confirm" onClick={onOk} label={t('common.confirm')} />
-          </>
+          ) : (
+            <Button type="confirm" onClick={onCancel || onOk} label={t('common.confirm')} />
+          )
         )}
       </div>
     </dialog>

diff --git a/packages/neuron-wallet/electron-builder.yml b/packages/neuron-wallet/electron-builder.yml
@@ -13,7 +13,7 @@ afterSign: scripts/notarize.js
 files:
   - from: "../.."
     to: "."
-    filter: ["!**/*", ".ckb-version", ".ckb-light-version", "ormconfig.json"]
+    filter: ["!**/*", ".ckb-version", ".ckb-light-version", "ormconfig.json", "compatible.csv"]
   - package.json
   - dist
   - ".env"

diff --git a/packages/neuron-wallet/package.json b/packages/neuron-wallet/package.json
@@ -34,6 +34,11 @@
       "prettier --ignore-path ../../.prettierignore --write",
       "eslint --fix",
       "git add"
+    ],
+    "test/**/*.{js,cjs,mjs,jsx,ts,tsx}": [
+      "prettier --ignore-path ../../.prettierignore --write",
+      "eslint --fix",
+      "git add"
     ]
   },
   "dependencies": {

diff --git a/packages/neuron-wallet/src/controllers/api.ts b/packages/neuron-wallet/src/controllers/api.ts
@@ -296,6 +296,13 @@ export default class ApiController {
       }
     })
 
+    handle('verify-external-ckb-node', async () => {
+      return {
+        status: ResponseCode.Success,
+        result: await NodeService.getInstance().verifyExternalCkbNode(),
+      }
+    })
+
     // Wallets
 
     handle('get-all-wallets', async () => {

diff --git a/packages/neuron-wallet/src/locales/en.ts b/packages/neuron-wallet/src/locales/en.ts
@@ -218,12 +218,6 @@ export default {
           cancel: 'Cancel',
         },
       },
-      'node-version-different': {
-        message: 'The node version is inconsistent with Neuron(v {{ version }}), please use after confirmation',
-      },
-      'ckb-without-indexer': {
-        message: "Please add '--indexer' option to start local node",
-      },
     },
     prompt: {
       password: {

diff --git a/packages/neuron-wallet/src/locales/zh-tw.ts b/packages/neuron-wallet/src/locales/zh-tw.ts
@@ -205,12 +205,6 @@ export default {
           cancel: '取消',
         },
       },
-      'node-version-different': {
-        message: '節點版本與 Neuron(v {{ version }}) 不壹致，請確認後使用',
-      },
-      'ckb-without-indexer': {
-        message: "請添加 '--indexer' 參數來啟動本地節點",
-      },
     },
     prompt: {
       password: {

diff --git a/packages/neuron-wallet/src/locales/zh.ts b/packages/neuron-wallet/src/locales/zh.ts
@@ -206,12 +206,6 @@ export default {
           cancel: '取消',
         },
       },
-      'node-version-different': {
-        message: '节点版本与 Neuron(v {{ version }}) 不一致，请确认后使用',
-      },
-      'ckb-without-indexer': {
-        message: "请添加 '--indexer' 参数来启动本地节点",
-      },
     },
     prompt: {
       password: {

diff --git a/packages/neuron-wallet/src/models/subjects/show-global-dialog.ts b/packages/neuron-wallet/src/models/subjects/show-global-dialog.ts
@@ -4,6 +4,7 @@ const ShowGlobalDialogSubject = new Subject<{
   title?: string
   message?: string
   type: 'success' | 'failed' | 'warning'
+  action?: 'ok' | 'cancel'
 }>()
 
 export default ShowGlobalDialogSubject