Reduce UI lag: gate redundant callbacks in accountbased engines

src/algorand/AlgorandEngine.ts

@@ -208,7 +208,7 @@ export class AlgorandEngine extends CurrencyEngine<
       }
 
       if (detectedTokenIds.length > 0) {
-        this.currencyEngineCallbacks.onNewTokens(detectedTokenIds)
+        this.reportDetectedTokens(detectedTokenIds)
       }
 
       this.updateBlockHeight(round)

src/common/CurrencyEngine.ts

@@ -15,6 +15,7 @@ import {
   EdgeLog,
   EdgeMetaToken,
   EdgeSpendInfo,
+  EdgeStakingStatus,
   EdgeSubscribedAddress,
   EdgeSyncStatus,
   EdgeToken,
@@ -196,6 +197,7 @@ export class CurrencyEngine<
       publicKey: '',
       totalBalances: {},
       numTransactions: {},
+      detectedTokenIds: {},
       unactivatedTokenIds: [],
       otherData: undefined
     }
@@ -655,6 +657,24 @@ export class CurrencyEngine<
     this.syncTracker.balanceComplete?.(tokenId)
   }
 
+  private lastStakingStatusJson: string = ''
+
+  protected reportStakingStatus(status: EdgeStakingStatus): void {
+    const json = JSON.stringify(status)
+    if (json === this.lastStakingStatusJson) return
+    this.lastStakingStatusJson = json
+    this.currencyEngineCallbacks.onStakingStatusChanged(status)
+  }
+
+  reportDetectedTokens(tokenIds: string[]): void {
+    const known = this.walletLocalData.detectedTokenIds
+    const newTokenIds = tokenIds.filter(id => known[id] == null)
+    if (newTokenIds.length === 0) return
+    for (const id of newTokenIds) known[id] = true
+    this.walletLocalDataDirty = true
+    this.currencyEngineCallbacks.onNewTokens(Object.keys(known))
+  }
+
   updateConfirmations(tx: EdgeTransaction): boolean {
     // No update needed for these status
     switch (tx.confirmations) {
@@ -717,10 +737,12 @@ export class CurrencyEngine<
 
     this.walletLocalData.blockHeight = blockHeight
     this.walletLocalDataDirty = true
-    this.currencyEngineCallbacks.onBlockHeightChanged(blockHeight)
 
+    // Update confirmations directly on all in-memory transactions and emit
+    // any that changed via onTransactions. Confirmations are owned by the engine;
+    // core-js learns of changes only when we send txs with updated confirmations
+    // via onTransactions (i.e. the deprecated onBlockHeightChanged is not called).
     const activeTokenIds = [null, ...this.enabledTokenIds]
-
     for (const tokenId of activeTokenIds) {
       const txList = this.transactionList[tokenId ?? ''] ?? []
       for (let i = 0; i < txList.length; i++) {

src/common/SyncTracker.ts

@@ -1,5 +1,8 @@
 import type { EdgeSyncStatus, EdgeTokenId } from 'edge-core-js/types'
 
+// Global throttle: max 1 sendSyncStatus per 500ms; totalRatio=1 always passes.
+let ssLastEmitTime = 0
+
 /**
  * Abstracts the ability to return a sync status,
  * since different chains track their sync status in different ways.
@@ -43,6 +46,7 @@ export function makeTokenSyncTracker(engine: SyncEngine): TokenSyncTracker {
   // Each tokenId can be a 0-1 value:
   const balanceRatios = new Map<EdgeTokenId, number>()
   const historyRatios = new Map<EdgeTokenId, number>()
+  let lastSyncStatus: EdgeSyncStatus | undefined
 
   function getSyncStatus(): EdgeSyncStatus {
     const activeTokenIds = [null, ...engine.enabledTokenIds]
@@ -66,10 +70,29 @@ export function makeTokenSyncTracker(engine: SyncEngine): TokenSyncTracker {
     return { totalRatio }
   }
 
+  function sendSyncStatusIfChanged(): void {
+    const currentStatus = getSyncStatus()
+    if (
+      lastSyncStatus == null ||
+      lastSyncStatus.totalRatio !== currentStatus.totalRatio
+    ) {
+      lastSyncStatus = currentStatus
+
+      if (currentStatus.totalRatio !== 1) {
+        const now = Date.now()
+        if (now - ssLastEmitTime < 500) return
+        ssLastEmitTime = now
+      }
+
+      engine.sendSyncStatus(currentStatus)
+    }
+  }
+
   const out: TokenSyncTracker = {
     resetSync() {
       balanceRatios.clear()
       historyRatios.clear()
+      lastSyncStatus = undefined
     },
 
     balanceComplete(tokenId) {
@@ -78,12 +101,12 @@ export function makeTokenSyncTracker(engine: SyncEngine): TokenSyncTracker {
 
     setBalanceRatios(tokenIds, ratio) {
       for (const tokenId of tokenIds) balanceRatios.set(tokenId, ratio)
-      engine.sendSyncStatus(getSyncStatus())
+      sendSyncStatusIfChanged()
     },
 
     setHistoryRatios(tokenIds, ratio) {
       for (const tokenId of tokenIds) historyRatios.set(tokenId, ratio)
-      engine.sendSyncStatus(getSyncStatus())
+      sendSyncStatusIfChanged()
     },
 
     updateBalanceRatio(tokenId, ratio) {
@@ -94,7 +117,7 @@ export function makeTokenSyncTracker(engine: SyncEngine): TokenSyncTracker {
       if (ratio <= lastRatio) return
 
       balanceRatios.set(tokenId, ratio)
-      engine.sendSyncStatus(getSyncStatus())
+      sendSyncStatusIfChanged()
     },
 
     updateHistoryRatio(tokenId, ratio, minStep) {
@@ -108,7 +131,7 @@ export function makeTokenSyncTracker(engine: SyncEngine): TokenSyncTracker {
       if (minStep != null && ratio - lastRatio < minStep && ratio < 1) return
 
       historyRatios.set(tokenId, ratio)
-      engine.sendSyncStatus(getSyncStatus())
+      sendSyncStatusIfChanged()
     }
   }
 

src/common/types.ts

@@ -1,5 +1,6 @@
 import {
   asArray,
+  asBoolean,
   asCodec,
   asEither,
   asMaybe,
@@ -60,6 +61,7 @@ export const asWalletLocalData = asObject({
     asObject(asNumber),
     () => ({})
   ),
+  detectedTokenIds: asMaybe(asObject(asBoolean), () => ({})),
   unactivatedTokenIds: asMaybe(asArray(asString), () => []),
   otherData: asOptional(asUnknown, () => ({}))
 })

src/cosmos/engine/CosmosEngine.ts

@@ -637,7 +637,7 @@ export class CosmosEngine extends CurrencyEngine<
       })
 
       if (detectedTokenIds.length > 0) {
-        this.currencyEngineCallbacks.onNewTokens(detectedTokenIds)
+        this.reportDetectedTokens(detectedTokenIds)
       }
 
       if (this.stakingSupported) {
@@ -656,7 +656,7 @@ export class CosmosEngine extends CurrencyEngine<
                 }
               ]
             }
-            this.currencyEngineCallbacks.onStakingStatusChanged(stakingStatus)
+            this.reportStakingStatus(stakingStatus)
             this.stakedBalanceCache = stakedBalance.amount
           }
         } catch (e) {

src/ethereum/EthereumNetwork.ts

@@ -456,7 +456,7 @@ export class EthereumNetwork {
       for (const [tokenId, bal] of tokenBal) {
         this.ethEngine.updateBalance(tokenId, bal)
       }
-      this.ethEngine.currencyEngineCallbacks.onNewTokens(
+      this.ethEngine.reportDetectedTokens(
         ethereumNetworkUpdate.detectedTokenIds ?? []
       )
     }
@@ -723,7 +723,7 @@ function makeThrottledFunction<Args extends any[], Rtn>(
   fn: (...args: Args) => Promise<Rtn>
 ): () => Promise<Rtn> {
   let lastTime = 0
-  let lastTimeout: NodeJS.Timeout | undefined
+  let lastTimeout: ReturnType<typeof setTimeout> | undefined
   return async (...args: Args) => {
     return await new Promise((resolve, reject) => {
       const timeSinceLast = Date.now() - lastTime

src/fio/FioEngine.ts

@@ -318,9 +318,7 @@ export class FioEngine extends CurrencyEngine<
     super.doInitialBalanceCallback()
 
     try {
-      this.currencyEngineCallbacks.onStakingStatusChanged({
-        ...this.otherData.stakingStatus
-      })
+      this.reportStakingStatus({ ...this.otherData.stakingStatus })
     } catch (e: any) {
       this.error(`doInitialBalanceCallback onStakingStatusChanged`, e)
     }
@@ -428,9 +426,7 @@ export class FioEngine extends CurrencyEngine<
     }
     this.localDataDirty()
     try {
-      this.currencyEngineCallbacks.onStakingStatusChanged({
-        ...this.otherData.stakingStatus
-      })
+      this.reportStakingStatus({ ...this.otherData.stakingStatus })
     } catch (e: any) {
       this.error('onStakingStatusChanged error')
     }

src/ripple/RippleEngine.ts

@@ -705,7 +705,7 @@ export class XrpEngine extends CurrencyEngine<
       })
 
       if (detectedTokenIds.length > 0) {
-        this.currencyEngineCallbacks.onNewTokens(detectedTokenIds)
+        this.reportDetectedTokens(detectedTokenIds)
       }
 
       // If get here, we've checked balances for all possible tokens the user

src/solana/SolanaEngine.ts

@@ -217,7 +217,7 @@ export class SolanaEngine extends CurrencyEngine<
       }
 
       if (detectedTokenIds.length > 0) {
-        this.currencyEngineCallbacks.onNewTokens(detectedTokenIds)
+        this.reportDetectedTokens(detectedTokenIds)
       }
     } catch (e: any) {
       // Nodes will return 0 for uninitiated accounts so thrown errors should be logged

src/sui/SuiEngine.ts

@@ -157,7 +157,7 @@ export class SuiEngine extends CurrencyEngine<
       }
 
       if (detectedTokenIds.length > 0) {
-        this.currencyEngineCallbacks.onNewTokens(detectedTokenIds)
+        this.reportDetectedTokens(detectedTokenIds)
       }
 
       this.syncTracker.setBalanceRatios([null, ...this.enabledTokenIds], 1)

src/tron/TronEngine.ts

@@ -256,7 +256,7 @@ export class TronEngine extends CurrencyEngine<
       }
 
       if (detectedTokenIds.length > 0) {
-        this.currencyEngineCallbacks.onNewTokens(detectedTokenIds)
+        this.reportDetectedTokens(detectedTokenIds)
       }
     } catch (e) {
       this.log.error('checkTokenBalances error', e)
@@ -345,9 +345,7 @@ export class TronEngine extends CurrencyEngine<
       }
 
       this.stakingStatus = { stakedAmounts }
-      this.currencyEngineCallbacks.onStakingStatusChanged({
-        ...this.stakingStatus
-      })
+      this.reportStakingStatus({ ...this.stakingStatus })
     } catch (e: any) {
       this.log.error('Error checking TRX address balance: ', e)
     }

src/zano/ZanoEngine.ts

@@ -192,7 +192,7 @@ export class ZanoEngine extends CurrencyEngine<
     }
 
     if (detectedTokenIds.length > 0) {
-      this.currencyEngineCallbacks.onNewTokens(detectedTokenIds)
+      this.reportDetectedTokens(detectedTokenIds)
     }
 
     this.syncTracker.updateBalanceRatio(1)