feat: assume_valid_target (nervosnetwork#3307)

* feat: assume_valid_target

* fix: comments

Author: devchenyan

packages/neuron-wallet/src/controllers/sync-api.ts

@@ -133,6 +133,7 @@ export default class SyncApiController {
     const currentTimestamp = Date.now()
     const network = NetworksService.getInstance().getCurrent()
     const tipHeader = await new RpcService(network.remote, network.type).getTipHeader()
+    const syncState = await new RpcService(network.remote, network.type).getSyncState()
 
     const { bestKnownBlockNumber, bestKnownBlockTimestamp } = await this.#fetchBestKnownBlockInfo()
     const foundBestKnownBlockNumber = this.#foundBestKnownBlockNumber(bestKnownBlockNumber)
@@ -146,9 +147,7 @@ export default class SyncApiController {
         ? +process.env.CKB_NODE_ASSUME_VALID_TARGET_BLOCK_NUMBER
         : undefined
     const isLookingValidTarget =
-      network.type === NetworkType.Default &&
-      !!setAssumeValidTargetBlockNumber &&
-      bestKnownBlockNumber < setAssumeValidTargetBlockNumber
+      network.type === NetworkType.Default && !!setAssumeValidTargetBlockNumber && !syncState.assumeValidTargetReached
 
     const newSyncState: SyncState = {
       nodeUrl: network.remote,

packages/neuron-wallet/src/services/rpc-service.ts

@@ -4,7 +4,7 @@ import Block from '../models/chain/block'
 import BlockHeader from '../models/chain/block-header'
 import TransactionWithStatus from '../models/chain/transaction-with-status'
 import logger from '../utils/logger'
-import { generateRPC } from '../utils/ckb-rpc'
+import { FullCKBRPC, generateRPC } from '../utils/ckb-rpc'
 import { NetworkType } from '../models/network'
 import TxStatus, { TxStatusType } from '../models/chain/tx-status'
 
@@ -71,6 +71,9 @@ export default class RpcService {
 
   public async getSyncState(): Promise<CKBComponents.SyncState> {
     const syncState = await this.retry(async () => {
+      if (this.rpc instanceof FullCKBRPC) {
+        return await this.rpc.getSyncState()
+      }
       return await this.rpc.syncState()
     })
     return syncState

packages/neuron-wallet/src/types/ckbComponents.d.ts

@@ -76,7 +76,10 @@ declare namespace CKBComponents {
   type BannedAddress = api.BannedAddr
   type WitnessArgs = api.WitnessArgs
   type BlockEconomicState = api.BlockEconomicState
-  type SyncState = api.SyncState
+  type SyncState = api.SyncState & {
+    assumeValidTarget: string
+    assumeValidTargetReached: boolean
+  }
   type TransactionProof = api.TransactionProof
   type TxVerbosity = api.TxVerbosity
   type TxPoolVerbosity = api.TxPoolVerbosity

packages/neuron-wallet/src/types/rpc.d.ts

@@ -251,6 +251,8 @@ declare namespace RPC {
     txs_fee: string
   }
   export interface SyncState {
+    assume_valid_target: string
+    assume_valid_target_reached: boolean
     best_known_block_number: string
     best_known_block_timestamp: string
     fast_time: string

packages/neuron-wallet/src/utils/ckb-rpc.ts

@@ -13,6 +13,7 @@ import {
 import CommonUtils from './common'
 import { NetworkType } from '../models/network'
 import type { RPCConfig } from '@ckb-lumos/rpc/lib/types/common'
+import { RPC } from '@ckb-lumos/rpc/lib/types/rpc'
 
 export interface LightScriptFilter {
   script: Script
@@ -22,6 +23,11 @@ export interface LightScriptFilter {
 
 export type LightScriptSyncStatus = LightScriptFilter
 
+interface ExtendedSyncState extends RPC.SyncState {
+  assume_valid_target: string
+  assume_valid_target_reached: boolean
+}
+
 const lightRPCProperties: Record<string, Omit<Parameters<CKBRPC['addMethod']>[0], 'name'>> = {
   setScripts: {
     method: 'set_scripts',
@@ -118,19 +124,51 @@ const lightRPCProperties: Record<string, Omit<Parameters<CKBRPC['addMethod']>[0]
   },
 }
 
+class Method extends SdkRpcMethod {
+  constructor(node: CKBComponents.Node, options: CKBComponents.Method) {
+    super(node, options, rpcConfig)
+  }
+}
+
 export class FullCKBRPC extends CKBRPC {
+  constructor(url: string, rpcConfig: Partial<RPCConfig>) {
+    super(url, rpcConfig)
+    this.setNode({ url })
+
+    this.getSyncState = new Method(this.node, {
+      name: 'getSyncState',
+      method: 'sync_state',
+      paramsFormatters: [],
+      resultFormatters: (state: ExtendedSyncState) => {
+        if (!state) {
+          return state
+        }
+        return {
+          assumeValidTarget: state.assume_valid_target,
+          assumeValidTargetReached: state.assume_valid_target_reached,
+          bestKnownBlockNumber: state.best_known_block_number,
+          bestKnownBlockTimestamp: state.best_known_block_timestamp,
+          fastTime: state.fast_time,
+          ibd: state.ibd,
+          inflightBlocksCount: state.inflight_blocks_count,
+          lowTime: state.low_time,
+          normalTime: state.normal_time,
+          orphanBlocksCount: state.orphan_blocks_count,
+        }
+      },
+    }).call
+  }
+
   getGenesisBlockHash = async () => {
     return this.getBlockHash('0x0')
   }
 
   getGenesisBlock = async (): Promise<Block> => {
     return this.getBlockByNumber('0x0')
   }
-}
 
-class Method extends SdkRpcMethod {
-  constructor(node: CKBComponents.Node, options: CKBComponents.Method) {
-    super(node, options, rpcConfig)
+  getSyncState = async (): Promise<CKBComponents.SyncState> => {
+    return this.getSyncState()
   }
 }