Emit currency wallets before their engines exist

Hoist a read of publicKey.json + walletCache.json to the top of the
engine pixie, ahead of the storage-wallet sync, and seed Redux from it,
so the walletApi gate (which drops its engine condition) opens within
one pixie tick on a warm login. Without the cache the gate opens on the
same conditions as before, keeping cold-start behavior unchanged.

makeCurrencyWalletApi loses its engine and tools constructor parameters.
Engine-backed methods wait internally via getEngine(), which bails out
if the wallet is deleted mid-wait and rethrows engineFailure so a broken
plugin surfaces as a rejected call instead of a hang. Mutations that
write synced-repo files gate on the storage wallet instead, which loads
well before the engine. otherMethods is guaranteed to be {} pre-engine
and switches to the engine's bridgified methods once it lands.

A cacheSaver sub-pixie watches the cache-relevant Redux slice and
persists it per wallet, throttled to one trailing-edge write per 5s,
guarded against post-logout writes, and giving up after 3 consecutive
failures. Engine creation and start scheduling are unchanged.

Author: j0ntz

src/core/currency/wallet/currency-wallet-api.ts

@@ -25,6 +25,7 @@ import {
   EdgeEncodeUri,
   EdgeGetReceiveAddressOptions,
   EdgeGetTransactionsOptions,
+  EdgeOtherMethods,
   EdgeParsedUri,
   EdgePaymentProtocolInfo,
   EdgeReceiveAddress,
@@ -45,7 +46,8 @@ import {
 } from '../../../types/types'
 import { makeMetaTokens } from '../../account/custom-tokens'
 import { splitWalletInfo } from '../../login/splitting'
-import { toApiInput } from '../../root-pixie'
+import { getCurrencyTools } from '../../plugins/plugins-selectors'
+import { RootProps, toApiInput } from '../../root-pixie'
 import { makeStorageWalletApi } from '../../storage/storage-api'
 import { getCurrencyMultiplier } from '../currency-selectors'
 import {
@@ -92,36 +94,84 @@ type SavedSpendTargets = EdgeTransaction['spendTargets']
  */
 export function makeCurrencyWalletApi(
   input: CurrencyWalletInput,
-  engine: EdgeCurrencyEngine,
-  tools: EdgeCurrencyTools,
   publicWalletInfo: EdgeWalletInfo
 ): EdgeCurrencyWallet {
   const ai = toApiInput(input)
+  const { walletId } = input.props
   const { accountId, pluginId, walletInfo } = input.props.walletState
   const plugin = input.props.state.plugins.currency[pluginId]
   const { unsafeBroadcastTx = false, unsafeMakeSpend = false } =
     plugin.currencyInfo
 
+  /**
+   * The wallet API object exists before the engine does,
+   * so engine-backed methods wait for the engine internally.
+   * Bail out if the wallet is deleted mid-wait, and re-throw
+   * `engineFailure` so a broken plugin surfaces as a rejected
+   * method call instead of a hang.
+   */
+  function getEngine(): Promise<EdgeCurrencyEngine> {
+    return ai.waitFor((props: RootProps): EdgeCurrencyEngine | undefined => {
+      if (props.state.currency.wallets[walletId] == null) {
+        throw new Error(`Wallet id ${walletId} does not exist in this account`)
+      }
+      const { engineFailure } = props.state.currency.wallets[walletId]
+      if (engineFailure != null) throw engineFailure
+      return props.output.currency.wallets[walletId]?.engine
+    })
+  }
+
+  async function getTools(): Promise<EdgeCurrencyTools> {
+    return await getCurrencyTools(ai, pluginId)
+  }
+
+  /**
+   * Methods that write synced-repo files need the storage wallet,
+   * not the engine. The repo loads well before the engine,
+   * so this wait is much shorter than `getEngine`.
+   */
+  function getStorage(): Promise<true> {
+    return ai.waitFor((props: RootProps): true | undefined => {
+      if (props.state.currency.wallets[walletId] == null) {
+        throw new Error(`Wallet id ${walletId} does not exist in this account`)
+      }
+      const { engineFailure } = props.state.currency.wallets[walletId]
+      if (engineFailure != null) throw engineFailure
+      if (props.state.storageWallets[walletId] != null) return true
+    })
+  }
+
   const storageWalletApi = makeStorageWalletApi(ai, walletInfo)
 
   const fakeCallbacks = makeCurrencyWalletCallbacks(input)
 
-  const otherMethods: { [name: string]: (...args: any[]) => any } = {}
-  if (engine.otherMethods != null) {
-    for (const name of Object.keys(engine.otherMethods)) {
-      const method = engine.otherMethods[name]
-      if (typeof method !== 'function') continue
-      otherMethods[name] = method
+  // The core guarantees `otherMethods` is `{}` (never `undefined`) before
+  // the engine exists, so property probes stay safe on the GUI side.
+  // Once the engine lands, the pixie watcher's `update` propagates the
+  // engine's bridgified methods through the same getter:
+  const emptyOtherMethods = bridgifyObject({})
+  let engineOtherMethods: EdgeOtherMethods | undefined
+
+  function makeEngineOtherMethods(
+    engine: EdgeCurrencyEngine
+  ): EdgeOtherMethods {
+    const otherMethods: { [name: string]: (...args: any[]) => any } = {}
+    if (engine.otherMethods != null) {
+      for (const name of Object.keys(engine.otherMethods)) {
+        const method = engine.otherMethods[name]
+        if (typeof method !== 'function') continue
+        otherMethods[name] = method
+      }
     }
-  }
-  if (engine.otherMethodsWithKeys != null) {
-    for (const name of Object.keys(engine.otherMethodsWithKeys)) {
-      const method = engine.otherMethodsWithKeys[name]
-      if (typeof method !== 'function') continue
-      otherMethods[name] = (...args) => method(walletInfo.keys, ...args)
+    if (engine.otherMethodsWithKeys != null) {
+      for (const name of Object.keys(engine.otherMethodsWithKeys)) {
+        const method = engine.otherMethodsWithKeys[name]
+        if (typeof method !== 'function') continue
+        otherMethods[name] = (...args) => method(walletInfo.keys, ...args)
+      }
     }
+    return bridgifyObject(otherMethods)
   }
-  bridgifyObject(otherMethods)
 
   const out: EdgeCurrencyWallet & InternalWalletMethods = {
     on: onMethod,
@@ -143,8 +193,13 @@ export function makeCurrencyWalletApi(
     get localDisklet(): Disklet {
       return storageWalletApi.localDisklet
     },
-    publicWalletInfo,
+    get publicWalletInfo(): EdgeWalletInfo {
+      // The cache-loaded value may be upgraded (re-derived) later,
+      // so always serve the latest one from Redux:
+      return input.props.walletState.publicWalletInfo ?? publicWalletInfo
+    },
     async sync(): Promise<void> {
+      await getStorage()
       await storageWalletApi.sync()
     },
     get type(): string {
@@ -156,6 +211,7 @@ export function makeCurrencyWalletApi(
       return input.props.walletState.name
     },
     async renameWallet(name: string): Promise<void> {
+      await getStorage()
       await renameCurrencyWallet(input, name)
     },
 
@@ -164,6 +220,7 @@ export function makeCurrencyWalletApi(
       return input.props.walletState.fiat
     },
     async setFiatCurrencyCode(fiatCurrencyCode: string): Promise<void> {
+      await getStorage()
       await setCurrencyWalletFiat(input, fiatCurrencyCode)
     },
 
@@ -206,6 +263,7 @@ export function makeCurrencyWalletApi(
       if (input.props.walletState.currencyInfo.hasWalletSettings !== true) {
         throw new Error('Wallet settings unsupported')
       }
+      await getStorage()
       await saveWalletSettingsFile(input, settings)
     },
 
@@ -270,6 +328,7 @@ export function makeCurrencyWalletApi(
 
     // Transactions history:
     async getNumTransactions(opts: EdgeTokenIdOptions): Promise<number> {
+      const engine = await getEngine()
       const upgradedCurrency = upgradeCurrencyCode({
         allTokens: input.props.state.accounts[accountId].allTokens[pluginId],
         currencyInfo: plugin.currencyInfo,
@@ -282,6 +341,7 @@ export function makeCurrencyWalletApi(
     async $internalStreamTransactions(
       opts: EdgeStreamTransactionOptions
     ): Promise<InternalWalletStream> {
+      const engine = await getEngine()
       const {
         afterDate,
         batchSize = 10,
@@ -416,6 +476,7 @@ export function makeCurrencyWalletApi(
     async getAddresses(
       opts: EdgeGetReceiveAddressOptions
     ): Promise<EdgeAddress[]> {
+      const engine = await getEngine()
       if (engine.getAddresses != null) {
         return await engine.getAddresses(opts)
       } else {
@@ -515,12 +576,15 @@ export function makeCurrencyWalletApi(
 
     // Sending:
     async broadcastTx(tx: EdgeTransaction): Promise<EdgeTransaction> {
+      const engine = await getEngine()
+
       // Only provide wallet info if currency requires it:
       const privateKeys = unsafeBroadcastTx ? walletInfo.keys : undefined
 
       return await engine.broadcastTx(tx, { privateKeys })
     },
     async getMaxSpendable(spendInfo: EdgeSpendInfo): Promise<string> {
+      const engine = await getEngine()
       return await getMaxSpendableInner(
         spendInfo,
         plugin,
@@ -532,6 +596,7 @@ export function makeCurrencyWalletApi(
     async getPaymentProtocolInfo(
       paymentProtocolUrl: string
     ): Promise<EdgePaymentProtocolInfo> {
+      const engine = await getEngine()
       if (engine.getPaymentProtocolInfo == null) {
         throw new Error(
           "'getPaymentProtocolInfo' is not implemented on wallets of this type"
@@ -540,6 +605,7 @@ export function makeCurrencyWalletApi(
       return await engine.getPaymentProtocolInfo(paymentProtocolUrl)
     },
     async makeSpend(spendInfo: EdgeSpendInfo): Promise<EdgeTransaction> {
+      const engine = await getEngine()
       spendInfo = upgradeMemos(spendInfo, plugin.currencyInfo)
       const {
         assetAction,
@@ -634,6 +700,7 @@ export function makeCurrencyWalletApi(
       return tx
     },
     async saveTx(transaction: EdgeTransaction): Promise<void> {
+      const engine = await getEngine()
       if (input.props.walletState.txs[transaction.txid] == null) {
         const { fileName, txFile } = await setupNewTxMetadata(
           input,
@@ -653,6 +720,7 @@ export function makeCurrencyWalletApi(
     },
 
     async saveTxAction(opts): Promise<void> {
+      await getEngine()
       const { txid, tokenId, assetAction, savedAction } = opts
       await updateCurrencyWalletTxMetadata(
         input,
@@ -666,6 +734,7 @@ export function makeCurrencyWalletApi(
     },
 
     async saveTxMetadata(opts: EdgeSaveTxMetadataOptions): Promise<void> {
+      await getEngine()
       const { txid, tokenId, metadata } = opts
 
       await updateCurrencyWalletTxMetadata(
@@ -681,6 +750,7 @@ export function makeCurrencyWalletApi(
       bytes: Uint8Array,
       opts: EdgeSignMessageOptions = {}
     ): Promise<string> {
+      const engine = await getEngine()
       const privateKeys = walletInfo.keys
 
       if (engine.signBytes != null) {
@@ -706,18 +776,21 @@ export function makeCurrencyWalletApi(
       message: string,
       opts: EdgeSignMessageOptions = {}
     ): Promise<string> {
+      const engine = await getEngine()
       if (engine.signMessage == null) {
         throw new Error(`${pluginId} doesn't support signing messages`)
       }
       const privateKeys = walletInfo.keys
       return await engine.signMessage(message, privateKeys, opts)
     },
     async signTx(tx: EdgeTransaction): Promise<EdgeTransaction> {
+      const engine = await getEngine()
       const privateKeys = walletInfo.keys
 
       return await engine.signTx(tx, privateKeys)
     },
     async sweepPrivateKeys(spendInfo: EdgeSpendInfo): Promise<EdgeTransaction> {
+      const engine = await getEngine()
       if (engine.sweepPrivateKeys == null) {
         throw new Error('Sweeping this currency is not supported.')
       }
@@ -726,6 +799,7 @@ export function makeCurrencyWalletApi(
 
     // Accelerating:
     async accelerate(tx: EdgeTransaction): Promise<EdgeTransaction | null> {
+      const engine = await getEngine()
       if (engine.accelerate == null) return null
       return await engine.accelerate(tx)
     },
@@ -737,9 +811,11 @@ export function makeCurrencyWalletApi(
 
     // Wallet management:
     async dumpData(): Promise<EdgeDataDump> {
+      const engine = await getEngine()
       return await engine.dumpData()
     },
     async resyncBlockchain(): Promise<void> {
+      const engine = await getEngine()
       const shortId = input.props.walletId.slice(0, 2)
       input.props.log.warn(`enabledTokenIds: ${shortId} resyncBlockchain`)
       ai.props.dispatch({
@@ -764,6 +840,7 @@ export function makeCurrencyWalletApi(
 
     // URI handling:
     async encodeUri(options: EdgeEncodeUri): Promise<string> {
+      const tools = await getTools()
       return await tools.encodeUri(
         options,
         makeMetaTokens(
@@ -772,6 +849,7 @@ export function makeCurrencyWalletApi(
       )
     },
     async parseUri(uri: string, currencyCode?: string): Promise<EdgeParsedUri> {
+      const tools = await getTools()
       const parsedUri = await tools.parseUri(
         uri,
         currencyCode,
@@ -792,7 +870,14 @@ export function makeCurrencyWalletApi(
     },
 
     // Generic:
-    otherMethods
+    get otherMethods(): EdgeOtherMethods {
+      const engine = input.props.walletOutput?.engine
+      if (engine == null) return emptyOtherMethods
+      if (engineOtherMethods == null) {
+        engineOtherMethods = makeEngineOtherMethods(engine)
+      }
+      return engineOtherMethods
+    }
   }
 
   return bridgifyObject(out)