@exodus/headless 2.0.0-alpha.128 → 2.0.0-alpha.13

package/src/dependencies/modules.js

@@ -1,11 +1,21 @@
+import EventEmitter from 'events/'
+import createRemoteConfig from '@exodus/config/remote'
+import keychainDefinition from '@exodus/keychain/module'
+import walletDefinition from '@exodus/wallet/module'
+import walletAccountsDefinition from '@exodus/wallet-accounts/module'
+import blockchainMetadataDefinition from '@exodus/blockchain-metadata/module'
+import enabledAssetsModuleDefinition from '@exodus/enabled-assets/module'
+import availableAssetsModuleDefinition from '@exodus/available-assets/module'
 import createKeyIdentifierProvider from '@exodus/key-identifier-provider'
 import walletCompatibilityModesDefinition from '@exodus/wallet-compatibility-modes/module'
+import balancesDefinition from '@exodus/balances/module'
 
 import createApplication from '../application'
-import unlockEncryptedStorageDefinition from '../unlock-encrypted-storage'
 import { withType } from './utils'
+import unlockEncryptedStorageDefinition from '../unlock-encrypted-storage'
+import createExodusPricingClient from '@exodus/exodus-pricing-client'
 
-const createModuleDependencies = ({ config }) =>
+const createModuleDependencies = () =>
   [
     {
       definition: {
@@ -21,12 +31,41 @@ const createModuleDependencies = ({ config }) =>
         dependencies: [],
       },
     },
+    {
+      definition: keychainDefinition,
+    },
+    {
+      definition: walletDefinition,
+    },
     {
       definition: walletCompatibilityModesDefinition,
-      storage: { namespace: 'walletCompatibilityModes' },
-      aliases: [{ implementationId: 'unsafeStorage', interfaceId: 'storage' }],
     },
     { definition: unlockEncryptedStorageDefinition },
+    { definition: walletAccountsDefinition },
+    {
+      definition: blockchainMetadataDefinition,
+      storage: { namespace: ['blockchain', 'v1'] },
+    },
+    { definition: enabledAssetsModuleDefinition },
+    {
+      definition: {
+        id: 'remoteConfig',
+        factory: (deps) => {
+          const eventEmitter = new EventEmitter().setMaxListeners(Number.POSITIVE_INFINITY)
+          return createRemoteConfig({ eventEmitter, ...deps })
+        },
+        dependencies: ['fetch', 'freeze', 'config', 'logger'],
+      },
+    },
+    { definition: availableAssetsModuleDefinition },
+    {
+      definition: {
+        id: 'pricingClient',
+        factory: createExodusPricingClient,
+        dependencies: ['fetch', 'pricingServerUrlAtom'],
+      },
+    },
+    { definition: balancesDefinition },
   ].map(withType('module'))
 
 export default createModuleDependencies

package/src/dependencies/monitors.js

@@ -0,0 +1,33 @@
+import marketHistoryMonitorDefinition from '@exodus/market-history/module'
+import ratesMonitorDefinition from '@exodus/rates-monitor/module'
+
+import { withType } from './utils'
+
+const createModuleDependencies = () =>
+  [
+    {
+      definition: marketHistoryMonitorDefinition,
+      storage: { namespace: 'marketHistory' },
+      aliases: [
+        {
+          implementationId: 'unsafeStorage',
+          interfaceId: 'storage',
+        },
+        {
+          implementationId: 'marketHistoryClearCacheAtom',
+          interfaceId: 'clearCacheAtom',
+        },
+        {
+          implementationId: 'remoteConfigClearMarketHistoryCacheAtom',
+          interfaceId: 'remoteConfigClearCacheAtom',
+        },
+        {
+          implementationId: 'marketHistoryRefreshIntervalAtom',
+          interfaceId: 'remoteConfigRefreshIntervalAtom',
+        },
+      ],
+    },
+    { definition: ratesMonitorDefinition },
+  ].map(withType('monitor'))
+
+export default createModuleDependencies

package/src/dependencies/utils.js

@@ -2,6 +2,10 @@ export const wrapConstant = ({ id, type, value }) => ({
   definition: { id, type, factory: () => value },
 })
 
+export const insertIf = (module, enabled) => {
+  return enabled ? [module] : []
+}
+
 export const withType =
   (type) =>
   ({ definition, ...rest }) => ({

package/src/index.js

@@ -1,121 +1,114 @@
-import addressProvider from '@exodus/address-provider'
-import assetsFeature from '@exodus/assets-feature'
-import availableAssets from '@exodus/available-assets'
-import balances from '@exodus/balances'
-import blockchainMetadata from '@exodus/blockchain-metadata'
-import enabledAssets from '@exodus/enabled-assets'
-import featureFlags from '@exodus/feature-flags'
-import fees from '@exodus/fee-data-monitors'
-import geolocation from '@exodus/geolocation'
-import keychain from '@exodus/keychain'
-import locale from '@exodus/locale'
-import pricing from '@exodus/pricing'
-import rates from '@exodus/rates-monitor'
-import remoteConfig from '@exodus/remote-config'
-import restoreProgressTracker from '@exodus/restore-progress-tracker'
-import wallet from '@exodus/wallet'
-import walletAccounts from '@exodus/wallet-accounts'
-
-import createApi from './api'
+import { pick } from '@exodus/basic-utils'
 import createIOC from './ioc'
-import attachMigrations from './migrations/attach'
+import createApi from './api'
+import {
+  createAccountStatesUpdateHandler,
+  createLoadWalletAccountsHandler,
+} from './utils/blockchain-metadata'
+
 import attachPlugins from './plugins/attach'
+import attachAtoms from './atoms/attach'
+import { atomsToAttach } from './constants'
 
 const createExodus = ({ adapters, config, port }) => {
   const ioc = createIOC({ adapters, config })
-
-  ioc.use(assetsFeature())
-  ioc.use(addressProvider({ config: config.addressProvider }))
-  ioc.use(availableAssets())
-  ioc.use(balances(config.balances))
-  ioc.use(blockchainMetadata())
-  ioc.use(enabledAssets())
-  ioc.use(featureFlags())
-  ioc.use(fees())
-  ioc.use(geolocation())
-  ioc.use(keychain(config.keychain))
-  ioc.use(locale())
-  ioc.use(pricing())
-  ioc.use(rates())
-  ioc.use(remoteConfig())
-  ioc.use(restoreProgressTracker())
-  ioc.use(wallet())
-  ioc.use(walletAccounts())
-
-  ioc.register({ definition: { id: 'port', type: 'port', factory: () => port } })
+  const { headless: headlessConfig } = config
 
   const resolve = () => {
     ioc.resolve()
 
-    const { storage, fusion } = ioc.getByType('adapter')
+    const { assetsModule, storage } = ioc.getByType('adapter')
 
-    const { lockedAtom } = ioc.getByType('atom')
+    const {
+      application,
+      blockchainMetadata,
+      enabledAssets,
+      remoteConfig,
+      unlockEncryptedStorage,
+      walletAccounts,
+    } = ioc.getByType('module')
+
+    const { marketHistory, ratesMonitor } = ioc.getByType('monitor')
+
+    const handleLoadWalletAccounts = createLoadWalletAccountsHandler({
+      blockchainMetadata,
+      port,
+      config,
+    })
 
-    const { application, wallet, unlockEncryptedStorage } = ioc.getByType('module')
+    const handleAccountStatesUpdate = createAccountStatesUpdateHandler({
+      blockchainMetadata,
+      port,
+      config,
+    })
 
-    const { migrations, assetsModule } = ioc.getAll()
+    blockchainMetadata.on('load-wallet-accounts', handleLoadWalletAccounts)
+    blockchainMetadata.on('tx-logs-update', (payload) => port.emit('tx-logs-update', payload))
+    blockchainMetadata.on('account-states-update', handleAccountStatesUpdate)
 
-    application.on('start', (payload) => port.emit('start', payload))
+    remoteConfig.on('sync', ({ current }) => port.emit('remote-config', current))
 
-    application.hook('load', (args) => port.emit('pre-load', args))
+    // TODO: migrate to marketHistoryAtom. Will be easier once it's on headless
+    marketHistory.on('market-history', (payload) => port.emit('market-history', payload))
 
-    application.on('load', (args) => port.emit('load', args))
+    // TODO: migrate to ratesAtom. Will be easier once it's on headless
+    ratesMonitor.on('rates', (payload) => port.emit('rates', payload))
 
-    application.on('create', async ({ hasPassphraseSet }) => {
-      const isLocked = await wallet.isLocked()
+    application.hook('start', () => {
+      remoteConfig.load()
 
-      port.emit('create', {
-        walletExists: true,
-        hasPassphraseSet,
-        isLocked,
-        isBackedUp: false,
-        isRestoring: false,
-      })
+      port.emit('start')
     })
 
-    application.on('unlock', () => port.emit('unlock'))
-
-    application.on('lock', () => port.emit('lock'))
-
-    application.on('backup', () => port.emit('backup'))
-
-    application.on('restore', () => port.emit('restore'))
+    application.hook('unlock', async () => {
+      if (typeof storage.unlock === 'function') unlockEncryptedStorage(storage)
 
-    application.on('restore-completed', () => {
-      port.emit('restore-completed')
+      remoteConfig.sync()
+      marketHistory.start()
+      ratesMonitor.start()
+
+      await assetsModule.load()
+      await walletAccounts.load()
+      await Promise.all([
+        //
+        blockchainMetadata.load(),
+        enabledAssets.load(),
+      ])
     })
 
-    application.on('change-passphrase', () => port.emit('passphrase-changed'))
-
-    application.on('import', () => port.emit('import', { walletExists: true }))
-
-    application.hook('unlock', async () => {
-      if (typeof storage.unlock === 'function') unlockEncryptedStorage(storage)
+    application.on('unlock', () => {
+      port.emit('unlock')
     })
 
     application.hook('clear', async () => {
-      await Promise.all([assetsModule.clear(), fusion.clearStorage()])
+      await Promise.all([
+        //
+        assetsModule.clear(),
+        walletAccounts.clear(),
+        blockchainMetadata.clear(),
+        enabledAssets.clear(),
+      ])
+
+      port.emit('clear')
     })
 
-    application.on('clear', () => port.emit('clear'))
-
-    application.on('restart', (payload) => port.emit('restart', payload))
-
-    attachMigrations({
-      migrations,
-      adapters,
-      application,
-      atoms: ioc.getByType('atom'),
-      modules: ioc.getByType('module'),
+    application.on('restart', (payload) => {
+      port.emit('restart', payload)
     })
 
-    attachPlugins({
+    attachAtoms({
+      port,
       application,
-      plugins: ioc.getByType('plugin'),
-      logger: ioc.get('createLogger')('attachPlugins'),
+      logger: ioc.get('createLogger')('attachAtoms'),
+      atoms: pick(ioc.getByType('atom'), atomsToAttach),
+      lifecycleEvents: headlessConfig?.attachAtomsLifecycleEvents,
     })
 
-    return createApi({ ioc, port, lockedAtom })
+    attachPlugins({ application, plugins: ioc.getByType('plugin') })
+
+    application.start()
+
+    return createApi({ ioc, port })
   }
 
   return { ...ioc, resolve }

package/src/ioc.js

@@ -1,74 +1,30 @@
 import createIocContainer from '@exodus/dependency-injection'
 import preprocess from '@exodus/dependency-preprocessors'
 import alias from '@exodus/dependency-preprocessors/src/preprocessors/alias'
-import configPreprocessor from '@exodus/dependency-preprocessors/src/preprocessors/config'
-import devModeAtoms from '@exodus/dependency-preprocessors/src/preprocessors/dev-mode-atoms'
 import logify from '@exodus/dependency-preprocessors/src/preprocessors/logify'
+import namespaceConfig from '@exodus/dependency-preprocessors/src/preprocessors/namespace-config'
 import namespaceStorage from '@exodus/dependency-preprocessors/src/preprocessors/namespace-storage'
-import optional from '@exodus/dependency-preprocessors/src/preprocessors/optional'
-import performanceMonitor from '@exodus/dependency-preprocessors/src/preprocessors/performance-monitor'
-import readOnlyAtoms from '@exodus/dependency-preprocessors/src/preprocessors/read-only-atoms'
-import assert from 'minimalistic-assert'
 
 import createDependencies from './dependencies'
 
 const createIOC = ({ adapters, config }) => {
-  const { createLogger, performance = {} } = adapters
-  const {
-    readOnlyAtoms: readOnlyAtomsConfig,
-    devModeAtoms: devModeAtomsConfig,
-    performanceMonitor: performanceMonitorConfig,
-  } = config.ioc ?? {}
-
-  const ioc = createIocContainer({ logger: createLogger('exodus:ioc') })
-
-  const performanceLogger = createLogger('exodus:performance')
+  const { createLogger } = adapters
 
+  const logger = createLogger('exodus:ioc')
+  const dependencies = createDependencies({ adapters, config })
   const preprocessors = [
     logify({ createLogger }),
-    performanceMonitorConfig?.enabled &&
-      performanceMonitor({
-        now: performance.now,
-        onAboveThreshold:
-          performance.onAboveThreshold ??
-          (({ id, method, async, duration }) =>
-            performanceLogger.log(
-              `${id}.${method} ${async ? 'resolved after' : 'took'} ${duration}ms`
-            )),
-        config: performanceMonitorConfig,
-      }),
-    configPreprocessor(),
+    namespaceConfig(),
     alias(),
     // NOTE: order matters, this should come after `alias`
     namespaceStorage(),
-    readOnlyAtoms({
-      logger: createLogger('exodus:read-only-atoms'),
-      warn: true,
-      ...readOnlyAtomsConfig,
-    }),
-    optional(),
-    devModeAtomsConfig && devModeAtoms(devModeAtomsConfig),
-  ].filter(Boolean)
-
-  const registerMultiple = (dependencies) => {
-    ioc.registerMultiple(preprocess({ dependencies, preprocessors }))
-  }
-
-  const register = (dependency) => {
-    registerMultiple([dependency])
-  }
-
-  const use = (module) => {
-    for (const { definition } of module.definitions) {
-      assert(definition.type, `ioc.use: "${definition.id}" is missing type field`)
-    }
-
-    registerMultiple(module.definitions)
-  }
+  ]
+  const definitions = preprocess({ dependencies, preprocessors })
+  const ioc = createIocContainer({ logger })
 
-  registerMultiple(createDependencies({ adapters, config }))
+  ioc.registerMultiple(definitions)
 
-  return { ...ioc, register, registerMultiple, use }
+  return ioc
 }
 
 export default createIOC

package/src/plugins/attach.js

@@ -1,38 +1,17 @@
-import { LifecycleHook } from '../constants'
+import { kebabCase, memoize } from 'lodash'
 
-const LIFECYCLE_METHOD_TO_HOOK_NAME = Object.fromEntries(
-  Object.entries(LifecycleHook).map(([pascalCaseName, hookName]) => [
-    `on${pascalCaseName}`,
-    hookName,
-  ])
+// e.g. onUnlock -> unlock -> onUnlock, onChangePassphrase -> change-passphrase
+const getApplicationHookName = memoize((lifecycleMethod) =>
+  kebabCase(lifecycleMethod.replace(/^on/, ''))
 )
 
-const attachPlugins = ({ plugins, application, logger }) => {
-  const timeFn = (fn, name) => {
-    const pluginWrapper = async (...args) => {
-      const start = Date.now()
-      try {
-        return await fn(...args)
-      } finally {
-        logger.debug(name, `${Date.now() - start}ms`)
-      }
-    }
-
-    Object.defineProperty(pluginWrapper, 'name', { value: name, writable: false })
-
-    return pluginWrapper
-  }
-
+const attachPlugins = ({ plugins, application }) => {
   Object.entries(plugins).forEach(([name, lifecycleMethods]) => {
     const entries = Object.entries(lifecycleMethods || {})
 
     for (const [lifecycleMethod, fn] of entries) {
-      const hookName = LIFECYCLE_METHOD_TO_HOOK_NAME[lifecycleMethod]
-      if (hookName) {
-        application.hook(hookName, timeFn(fn, `plugin ${name}.${lifecycleMethod}`))
-      } else {
-        logger.error(`plugin "${name}" declares unsupported lifecycle method "${lifecycleMethod}"`)
-      }
+      const hookName = getApplicationHookName(lifecycleMethod)
+      application.hook(hookName, fn)
     }
   })
 }

package/src/plugins/index.js

@@ -1,5 +1,3 @@
-import autoEnableAssetsPlugin from '@exodus/auto-enable-assets-plugin'
-
 import logLifecyclePlugin from './log-lifecycle'
 
-export default [logLifecyclePlugin, autoEnableAssetsPlugin]
+export default [logLifecyclePlugin]

package/src/plugins/log-lifecycle.js

@@ -9,7 +9,6 @@ const logLifecycle = {
       onImport: () => logger.debug('onImport'),
       onMigrate: () => logger.debug('onMigrate'),
       onStart: () => logger.debug('onStart'),
-      onRestart: () => logger.debug('onRestart'),
       onLoad: () => logger.debug('onLoad'),
       onUnload: () => logger.debug('onUnload'),
       onCreate: () => logger.debug('onCreate'),

package/src/unlock-encrypted-storage.js

@@ -12,10 +12,8 @@ const createUnlockEncryptedStorage = ({ keychain }) => {
   }
 }
 
-// eslint-disable-next-line @exodus/export-default/named
 export default {
   id: 'unlockEncryptedStorage',
-  type: 'module',
   factory: createUnlockEncryptedStorage,
   dependencies: ['keychain'],
 }

package/src/utils/blockchain-metadata.js

@@ -0,0 +1,48 @@
+import { mapValues } from '@exodus/basic-utils'
+
+const createAccountStatesTransformer = ({ serializePortPayloads, blockchainMetadata }) => {
+  return serializePortPayloads
+    ? (payload) =>
+        mapValues(payload, (byAsset, walletAccount) =>
+          mapValues(
+            byAsset,
+            (accountState, assetName) =>
+              blockchainMetadata.serializePayload({ walletAccount, assetName, accountState })
+                .accountState
+          )
+        )
+    : (payload) => payload
+}
+
+export function createAccountStatesUpdateHandler({
+  port,
+  blockchainMetadata,
+  config: { serializePortPayloads = false },
+}) {
+  const transform = createAccountStatesTransformer({ serializePortPayloads, blockchainMetadata })
+
+  return (payload) => {
+    port.emit('account-states-update', transform(payload))
+  }
+}
+
+export function createLoadWalletAccountsHandler({
+  port,
+  blockchainMetadata,
+  config: { serializePortPayloads = false },
+}) {
+  const transformAccountStates = createAccountStatesTransformer({
+    serializePortPayloads,
+    blockchainMetadata,
+  })
+
+  return async () => {
+    const [txLogs, accountStates] = await Promise.all([
+      blockchainMetadata.getLoadedTxLogs(),
+      blockchainMetadata.getLoadedAccountStates(),
+    ])
+
+    port.emit('tx-logs', txLogs)
+    port.emit('account-states', transformAccountStates(accountStates))
+  }
+}

package/src/atoms/base-asset-names-to-monitor.js

@@ -1,40 +0,0 @@
-import { combine, compute, dedupe } from '@exodus/atoms'
-import { uniq } from 'lodash'
-
-const getNetworks = (assetNames, assets) =>
-  uniq(
-    assetNames
-      .map((assetName) => assets[assetName]?.baseAsset.name)
-      .filter((assetName) => !!assetName && !assets[assetName].isCombined)
-  )
-
-const createBaseAssetNamesToMonitorAtom = ({
-  assetsModule,
-  enabledAssetsAtom,
-  restoreAtom,
-  availableAssetNamesAtom,
-}) => {
-  const selector = ({ isRestore, enabledAssets, availableAssetNames }) => {
-    const assetNames = isRestore ? availableAssetNames : Object.keys(enabledAssets)
-    return getNetworks(assetNames, assetsModule.getAssets())
-  }
-
-  return dedupe(
-    compute({
-      atom: combine({
-        isRestore: restoreAtom,
-        enabledAssets: enabledAssetsAtom,
-        availableAssetNames: availableAssetNamesAtom,
-      }),
-      selector,
-    })
-  )
-}
-
-// eslint-disable-next-line @exodus/export-default/named
-export default {
-  id: 'baseAssetNamesToMonitorAtom',
-  type: 'atom',
-  factory: createBaseAssetNamesToMonitorAtom,
-  dependencies: ['assetsModule', 'availableAssetNamesAtom', 'enabledAssetsAtom', 'restoreAtom'],
-}

package/src/migrations/attach.js

@@ -1,60 +0,0 @@
-import { deriveSyncKeys } from '../utils/fusion'
-
-const attachMigrations = ({ migrations = [], application, modules, adapters, ...deps }) => {
-  const { analytics, unlockEncryptedStorage, wallet } = modules
-  const { unsafeStorage, migrateableStorage, fusionKeysDeferred, migrateableFusion } = adapters
-
-  // Override encrypted storage with migrations own instance to make sure no modules reads from it before migrations ran
-  const migrationFlagsStorage = unsafeStorage.namespace('migrations')
-  const migrationAdapters = { ...adapters, storage: migrateableStorage, fusion: migrateableFusion }
-
-  const attachMigration = async (migration) => {
-    const { name, factory } = migration
-    const logger = adapters.createLogger(`exodus:migration:${name}`)
-
-    logger.log('running migration')
-
-    let success = false
-
-    try {
-      const start = performance.now()
-
-      await factory({ ...deps, adapters: migrationAdapters, modules, logger })
-
-      const time = performance.now() - start
-
-      logger.log(`migration successful in ${time.toFixed(2)}ms`)
-
-      await migrationFlagsStorage.set(name, true)
-
-      success = true
-    } catch (error) {
-      logger.log(`migration failed: ${error.stack}`)
-    } finally {
-      analytics.track({
-        event: 'ClientMigrationRun',
-        properties: { migrationId: name, success },
-        force: true,
-      })
-    }
-  }
-
-  application.hook('migrate', async () => {
-    await unlockEncryptedStorage(migrateableStorage)
-    if (fusionKeysDeferred) await deriveSyncKeys(wallet.seed).then(fusionKeysDeferred.resolve)
-
-    const migrationNames = migrations.map((migration) => migration.name)
-    const migrationFlags = await migrationFlagsStorage.batchGet(migrationNames)
-    const migrationsDiff = migrations.filter((v, k) => !migrationFlags[k])
-
-    for (const migration of migrationsDiff) {
-      await attachMigration(migration)
-    }
-  })
-
-  application.hook('clear', async () => {
-    await migrationFlagsStorage.clear()
-  })
-}
-
-export default attachMigrations

package/src/reporting.js

@@ -1,27 +0,0 @@
-import { zipObject } from 'lodash'
-
-const createReporting = ({ ioc, lockedAtom }) => {
-  const getReports = async () => {
-    if (await lockedAtom.get()) throw new Error('Unable to export when locked')
-
-    const nodes = ioc.getByType('report')
-    const reports = Object.values(nodes)
-
-    const resolvedReports = await Promise.allSettled(reports.map((report) => report.export()))
-
-    const namespaces = reports.map((report) => report.namespace)
-    const data = resolvedReports.map((outcome) =>
-      outcome.status === 'fulfilled' ? outcome.value : { error: outcome.reason }
-    )
-
-    return zipObject(namespaces, data)
-  }
-
-  return {
-    reporting: {
-      export: getReports,
-    },
-  }
-}
-
-export default createReporting

package/src/utils/fusion.js

@@ -1,17 +0,0 @@
-import { pick } from '@exodus/basic-utils'
-import HDKeySlip10 from '@exodus/hd-key-slip-10'
-import sodium from '@exodus/sodium-crypto'
-
-const EXODUS_PURPOSE = Number.parseInt(Buffer.from('exo').toString('hex'), '16')
-
-const EXO_2_PATH = `m/${EXODUS_PURPOSE}'/2'`
-
-const BIP43_PURPOSE_SYNC = `${EXO_2_PATH}/0'`
-
-export const deriveSyncKeys = async (seed) => {
-  const derived = HDKeySlip10.fromSeed(seed).derive(BIP43_PURPOSE_SYNC).key
-
-  const keys = await sodium.getSodiumKeysFromSeed(derived)
-
-  return pick(keys, ['box', 'sign', 'secret', 'derived'])
-}