@exodus/headless 2.0.0-alpha.43 → 2.0.0-alpha.44

package/CHANGELOG.md

@@ -3,6 +3,13 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [2.0.0-alpha.44](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@2.0.0-alpha.43...@exodus/headless@2.0.0-alpha.44) (2023-06-18)
+
+### Features
+
+- use(personalNotes, blockchainMetadata, remoteConfig, cryptoNews) ([#1991](https://github.com/ExodusMovement/exodus-hydra/issues/1991)) ([ccaaa4a](https://github.com/ExodusMovement/exodus-hydra/commit/ccaaa4ac44f8bed9de99418c394c40478eaeae69))
+- validate type field on ioc.use() ([#1974](https://github.com/ExodusMovement/exodus-hydra/issues/1974)) ([b234c82](https://github.com/ExodusMovement/exodus-hydra/commit/b234c82a6f0550d34273590250b307a965b11295))
+
 ## [2.0.0-alpha.43](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@2.0.0-alpha.42...@exodus/headless@2.0.0-alpha.43) (2023-06-16)
 
 ### Features

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/headless",
-  "version": "2.0.0-alpha.43",
+  "version": "2.0.0-alpha.44",
   "description": "The headless Exodus wallet SDK",
   "author": "Exodus Movement Inc",
   "main": "src/index.js",
@@ -88,5 +88,5 @@
     "nock": "^13.3.1",
     "p-defer": "^4.0.0"
   },
-  "gitHead": "67ed7c439d9d3626db03d8c926af3e1fbe19cf8f"
+  "gitHead": "1116abf16d19461a0bd9154799613bd97d2a6cd9"
 }

package/src/api.js

@@ -5,15 +5,8 @@ const createApi = ({ ioc, port }) => {
 
   const { assetsModule } = ioc.getByType('adapter')
 
-  const {
-    addressProvider,
-    application,
-    blockchainMetadata,
-    enabledAssets,
-    personalNotes,
-    remoteConfig,
-    wallet,
-  } = ioc.getByType('module')
+  const { addressProvider, application, enabledAssets, remoteConfig, wallet } =
+    ioc.getByType('module')
 
   const { feeMonitors, ratesMonitor, nftsMonitor } = ioc.getByType('monitor')
 
@@ -51,19 +44,6 @@ const createApi = ({ ioc, port }) => {
       changeLockTimer: application.changeLockTimer,
       isLocked: () => wallet.isLocked(),
     },
-    blockchainMetadata: {
-      getTxLog: blockchainMetadata.getTxLog,
-      getLoadedTxLogs: blockchainMetadata.getLoadedTxLogs,
-      updateTxs: blockchainMetadata.updateTxs,
-      overwriteTxs: blockchainMetadata.overwriteTxs,
-      clearTxs: blockchainMetadata.clearTxs,
-      removeTxs: blockchainMetadata.removeTxs,
-      getAccountState: blockchainMetadata.getAccountState,
-      getLoadedAccountStates: blockchainMetadata.getLoadedAccountStates,
-      updateAccountState: blockchainMetadata.updateAccountState,
-      removeAccountState: blockchainMetadata.removeAccountState,
-      batch: blockchainMetadata.batch,
-    },
     assets: {
       enable: enabledAssets.enable,
       disable: enabledAssets.disable,
@@ -73,10 +53,6 @@ const createApi = ({ ioc, port }) => {
         return asset.name
       },
     },
-    remoteConfig: {
-      get: remoteConfig.get,
-      getAll: remoteConfig.getAll,
-    },
     rates: {
       refresh: () => ratesMonitor.update(),
     },
@@ -85,9 +61,6 @@ const createApi = ({ ioc, port }) => {
       getSupportedPurposes: addressProvider.getSupportedPurposes.bind(addressProvider),
       getReceiveAddress: addressProvider.getReceiveAddress.bind(addressProvider),
     },
-    personalNotes: {
-      upsert: personalNotes.upsert,
-    },
     isMnemonicValid,
     subscribe: port.subscribe.bind(port),
     unsubscribe: port.unsubscribe.bind(port),

package/src/dependencies/atoms.js

@@ -6,14 +6,12 @@ import {
 } from '@exodus/atoms'
 import { availableAssetNamesAtomDefinition } from '@exodus/available-assets/atoms'
 import { balancesAtomDefinition } from '@exodus/balances/atoms'
-import { cryptoNewsAtomDefinition } from '@exodus/crypto-news-monitor/atoms'
 import {
   enabledAndDisabledAssetsAtomDefinition,
   enabledAssetsAtomDefinition,
 } from '@exodus/enabled-assets/atoms'
 import { featureFlagsAtomDefinition } from '@exodus/feature-flags/atoms'
 import { geolocationAtomDefinition } from '@exodus/geolocation/atoms'
-import { personalNotesAtomDefinition } from '@exodus/personal-notes/atoms'
 import { ratesAtomDefinition } from '@exodus/rates-monitor/atoms'
 import { topMoversAtomDefinition } from '@exodus/top-movers-monitor/atoms'
 
@@ -100,18 +98,8 @@ const createAtomDependencies = () =>
     { definition: ratesAtomDefinition },
     { definition: geolocationAtomDefinition },
     { definition: featureFlagsAtomDefinition },
-    {
-      definition: personalNotesAtomDefinition,
-      aliases: [
-        {
-          implementationId: 'personalNotesStorage',
-          interfaceId: 'storage',
-        },
-      ],
-    },
     { definition: baseAssetNamesToMonitorAtomDefinition },
     { definition: topMoversAtomDefinition },
-    { definition: cryptoNewsAtomDefinition },
     { definition: restoreAtomDefinition },
     { definition: apyRatesAtomDefinition },
   ].map(withType('atom'))

package/src/dependencies/modules.js

@@ -1,17 +1,13 @@
 import createAddressProviderDependencies from '@exodus/address-provider'
 import availableAssetsModuleDefinition from '@exodus/available-assets/module'
 import balancesDefinition from '@exodus/balances/module'
-import blockchainMetadataDefinition from '@exodus/blockchain-metadata/module'
-import createRemoteConfig from '@exodus/config/remote'
 import enabledAssetsModuleDefinition from '@exodus/enabled-assets/module'
 import createExodusPricingClient from '@exodus/exodus-pricing-client'
 import featureFlagsDefinition from '@exodus/feature-flags/module'
 import createKeyIdentifierProvider from '@exodus/key-identifier-provider'
 import keychainDefinition from '@exodus/keychain/module'
-import personalNotesDefinition from '@exodus/personal-notes/module'
 import walletDefinition from '@exodus/wallet/module'
 import walletCompatibilityModesDefinition from '@exodus/wallet-compatibility-modes/module'
-import EventEmitter from 'events/'
 
 import createApplication from '../application'
 import unlockEncryptedStorageDefinition from '../unlock-encrypted-storage'
@@ -44,21 +40,7 @@ const createModuleDependencies = ({ config }) =>
       definition: walletCompatibilityModesDefinition,
     },
     { definition: unlockEncryptedStorageDefinition },
-    {
-      definition: blockchainMetadataDefinition,
-      storage: { namespace: ['blockchain', 'v1'] },
-    },
     { definition: enabledAssetsModuleDefinition, writesAtoms: ['enabledAndDisabledAssetsAtom'] },
-    {
-      definition: {
-        id: 'remoteConfig',
-        factory: (deps) => {
-          const eventEmitter = new EventEmitter().setMaxListeners(Number.POSITIVE_INFINITY)
-          return createRemoteConfig({ eventEmitter, ...deps })
-        },
-        dependencies: ['fetch', 'freeze', 'config', 'logger'],
-      },
-    },
     { definition: availableAssetsModuleDefinition, writesAtoms: ['availableAssetNamesAtom'] },
     {
       definition: {
@@ -73,9 +55,6 @@ const createModuleDependencies = ({ config }) =>
       writesAtoms: ['featureFlagAtoms'],
     },
     ...createAddressProviderDependencies(config.addressProvider),
-    {
-      definition: personalNotesDefinition,
-    },
   ].map(withType('module'))
 
 export default createModuleDependencies

package/src/dependencies/monitors.js

@@ -1,5 +1,4 @@
 import apyRatesMonitorDefinition from '@exodus/apy-rates/monitor'
-import cryptoNewsMonitorDefinition from '@exodus/crypto-news-monitor/monitor'
 import feeMonitorsDefinition from '@exodus/fee-monitors/monitor'
 import geolocationMonitorDefinition from '@exodus/geolocation/monitor'
 import marketHistoryMonitorDefinition from '@exodus/market-history/module'
@@ -48,10 +47,6 @@ const createMonitorDependencies = ({ config }) =>
         : remoteTopMoversMonitorDefinition,
       writesAtoms: ['topMoversAtom'],
     },
-    {
-      definition: cryptoNewsMonitorDefinition,
-      writesAtoms: ['cryptoNewsAtom'],
-    },
     {
       definition: apyRatesMonitorDefinition,
       writesAtoms: ['apyRatesAtom'],

package/src/index.js

@@ -5,26 +5,33 @@ import attachAtoms from './atoms/attach'
 import { atomsToAttach } from './constants'
 import createIOC from './ioc'
 import abTesting from './modules/ab-testing'
+import blockchainMetadata from './modules/blockchain-metadata'
 import connectedOrigins from './modules/connected-origins'
+import cryptoNews from './modules/crypto-news'
 import kyc from './modules/kyc'
 import locale from './modules/locale'
 import nfts from './modules/nfts'
+import personalNotes from './modules/personal-notes'
 import referrals from './modules/referrals'
+import remoteConfig from './modules/remote-config'
 import walletAccounts from './modules/wallet-accounts'
 import attachPlugins from './plugins/attach'
-import { createLoadWalletAccountsHandler } from './utils/blockchain-metadata'
 
 const createExodus = ({ adapters, config, port }) => {
   const ioc = createIOC({ adapters, config })
   const { headless: headlessConfig } = config
 
   ioc.use(walletAccounts())
+  ioc.use(blockchainMetadata())
+  ioc.use(remoteConfig())
   ioc.use(locale())
   ioc.use(nfts())
   ioc.use(kyc())
   ioc.use(referrals())
   ioc.use(connectedOrigins())
   ioc.use(abTesting())
+  ioc.use(personalNotes())
+  ioc.use(cryptoNews())
 
   ioc.register({ definition: { id: 'port', type: 'port', factory: () => port } })
 
@@ -33,19 +40,11 @@ const createExodus = ({ adapters, config, port }) => {
 
     const { assetsModule, storage } = ioc.getByType('adapter')
 
-    const {
-      application,
-      blockchainMetadata,
-      enabledAssets,
-      featureFlags,
-      personalNotes,
-      remoteConfig,
-      unlockEncryptedStorage,
-    } = ioc.getByType('module')
+    const { application, enabledAssets, featureFlags, unlockEncryptedStorage } =
+      ioc.getByType('module')
 
     const {
       apyRatesMonitor,
-      cryptoNewsMonitor,
       feeMonitors,
       geolocationMonitor,
       marketHistory,
@@ -55,22 +54,9 @@ const createExodus = ({ adapters, config, port }) => {
 
     const { featureFlagAtoms } = ioc.getByType('atom-collection')
 
-    const handleLoadWalletAccounts = createLoadWalletAccountsHandler({
-      blockchainMetadata,
-      port,
-    })
-
-    blockchainMetadata.on('load-wallet-accounts', handleLoadWalletAccounts)
-    blockchainMetadata.on('tx-logs-update', (payload) => port.emit('tx-logs-update', payload))
-    blockchainMetadata.on('account-states-update', (payload) =>
-      port.emit('account-states-update', payload)
-    )
-
     feeMonitors.on('fees-load', () => port.emit('fees-load', feeMonitors.getAllFeeData()))
     feeMonitors.on('fees-update', (payload) => port.emit('fees-update', payload))
 
-    remoteConfig.on('sync', ({ current }) => port.emit('remote-config', current))
-
     // TODO: migrate to marketHistoryAtom. Will be easier once it's on headless
     marketHistory.on('market-history', (payload) => port.emit('market-history', payload))
     marketHistory.on('market-history-new-assets', (payload) =>
@@ -81,7 +67,6 @@ const createExodus = ({ adapters, config, port }) => {
     ratesMonitor.on('rates', (payload) => port.emit('rates', payload))
 
     application.hook('start', (payload) => {
-      remoteConfig.load()
       featureFlags.load()
       geolocationMonitor.start()
 
@@ -91,28 +76,18 @@ const createExodus = ({ adapters, config, port }) => {
     application.hook('unlock', async () => {
       if (typeof storage.unlock === 'function') unlockEncryptedStorage(storage)
 
-      remoteConfig.sync()
       marketHistory.start()
       ratesMonitor.start()
       feeMonitors.start()
       apyRatesMonitor.start()
 
       await assetsModule.load()
-      await Promise.all([
-        //
-        blockchainMetadata.load(),
-        enabledAssets.load(),
-      ])
+      await enabledAssets.load()
 
       featureFlagAtoms.topMovers?.get().then(({ isOn }) => {
         if (!isOn) return
         topMoversMonitor.start()
       })
-
-      featureFlagAtoms.cryptoNews?.get().then(({ isOn }) => {
-        if (!isOn) return
-        cryptoNewsMonitor.start()
-      })
     })
 
     application.on('unlock', () => {
@@ -123,13 +98,9 @@ const createExodus = ({ adapters, config, port }) => {
       await Promise.all([
         //
         assetsModule.clear(),
-        blockchainMetadata.clear(),
         enabledAssets.clear(),
         featureFlags.clear(),
       ])
-
-      // TEMP: dont wait to clear as encrypted storage is not yet unlocked
-      personalNotes.clear()
     })
 
     application.on('clear', () => {

package/src/ioc.js

@@ -7,6 +7,7 @@ import namespaceConfig from '@exodus/dependency-preprocessors/src/preprocessors/
 import namespaceStorage from '@exodus/dependency-preprocessors/src/preprocessors/namespace-storage'
 import optional from '@exodus/dependency-preprocessors/src/preprocessors/optional'
 import readOnlyAtoms from '@exodus/dependency-preprocessors/src/preprocessors/read-only-atoms'
+import assert from 'minimalistic-assert'
 
 import createDependencies from './dependencies'
 
@@ -40,6 +41,10 @@ const createIOC = ({ adapters, config }) => {
   }
 
   const use = (module) => {
+    for (const { definition } of module.definitions) {
+      assert(definition.type, `ioc.use: "${definition.id}" is missing type field`)
+    }
+
     registerMultiple(module.definitions)
   }
 

package/src/modules/blockchain-metadata/api.js

@@ -0,0 +1,22 @@
+const createBlockchainMetadataApi = ({ blockchainMetadata }) => ({
+  blockchainMetadata: {
+    getTxLog: blockchainMetadata.getTxLog,
+    getLoadedTxLogs: blockchainMetadata.getLoadedTxLogs,
+    updateTxs: blockchainMetadata.updateTxs,
+    overwriteTxs: blockchainMetadata.overwriteTxs,
+    clearTxs: blockchainMetadata.clearTxs,
+    removeTxs: blockchainMetadata.removeTxs,
+    getAccountState: blockchainMetadata.getAccountState,
+    getLoadedAccountStates: blockchainMetadata.getLoadedAccountStates,
+    updateAccountState: blockchainMetadata.updateAccountState,
+    removeAccountState: blockchainMetadata.removeAccountState,
+    batch: blockchainMetadata.batch,
+  },
+})
+
+export default {
+  id: 'createBlockchainMetadataApi',
+  type: 'api',
+  factory: createBlockchainMetadataApi,
+  dependencies: ['blockchainMetadata'],
+}

package/src/modules/blockchain-metadata/index.js

@@ -0,0 +1,20 @@
+import blockchainMetadataDefinition from '@exodus/blockchain-metadata/module'
+
+import blockchainMetadataApiDefinition from './api'
+import blockchainMetadataPluginDefinition from './plugin'
+
+const blockchainMetadata = () => {
+  return {
+    id: 'blockchainMetadata',
+    definitions: [
+      {
+        definition: blockchainMetadataDefinition,
+        storage: { namespace: ['blockchain', 'v1'] },
+      },
+      { definition: blockchainMetadataPluginDefinition },
+      { definition: blockchainMetadataApiDefinition },
+    ],
+  }
+}
+
+export default blockchainMetadata

package/src/modules/blockchain-metadata/plugin.js

@@ -0,0 +1,30 @@
+import { createLoadWalletAccountsHandler } from './utils'
+
+const blockchainLifecyclePlugin = ({ blockchainMetadata, port }) => {
+  const handleLoadWalletAccounts = createLoadWalletAccountsHandler({ blockchainMetadata, port })
+
+  blockchainMetadata.on('load-wallet-accounts', handleLoadWalletAccounts)
+
+  blockchainMetadata.on('tx-logs-update', (payload) => port.emit('tx-logs-update', payload))
+
+  blockchainMetadata.on('account-states-update', (payload) =>
+    port.emit('account-states-update', payload)
+  )
+
+  const onUnlock = async () => {
+    await blockchainMetadata.load()
+  }
+
+  const onClear = async () => {
+    await blockchainMetadata.clear()
+  }
+
+  return { onUnlock, onClear }
+}
+
+export default {
+  id: 'blockchainLifecyclePlugin',
+  type: 'plugin',
+  factory: blockchainLifecyclePlugin,
+  dependencies: ['blockchainMetadata', 'port'],
+}

package/src/modules/crypto-news/index.js

@@ -0,0 +1,20 @@
+import { cryptoNewsAtomDefinition } from '@exodus/crypto-news-monitor/atoms'
+import cryptoNewsMonitorDefinition from '@exodus/crypto-news-monitor/monitor'
+
+import cryptoNewsPluginDefinition from './plugin'
+
+const cryptoNews = () => {
+  return {
+    id: 'cryptoNews',
+    definitions: [
+      { definition: cryptoNewsAtomDefinition },
+      {
+        definition: cryptoNewsMonitorDefinition,
+        writesAtoms: ['cryptoNewsAtom'],
+      },
+      { definition: cryptoNewsPluginDefinition },
+    ],
+  }
+}
+
+export default cryptoNews

package/src/modules/crypto-news/plugin.js

@@ -0,0 +1,17 @@
+const cryptoNewsPlugin = ({ cryptoNewsMonitor, featureFlagAtoms }) => {
+  const onUnlock = () => {
+    featureFlagAtoms.cryptoNews?.get().then(({ isOn }) => {
+      if (!isOn) return
+      cryptoNewsMonitor.start()
+    })
+  }
+
+  return { onUnlock }
+}
+
+export default {
+  id: 'cryptoNewsLifecyclePlugin',
+  type: 'plugin',
+  factory: cryptoNewsPlugin,
+  dependencies: ['cryptoNewsMonitor', 'featureFlagAtoms'],
+}

package/src/modules/personal-notes/api.js

@@ -0,0 +1,12 @@
+const createPersonalNotesApi = ({ personalNotes }) => ({
+  personalNotes: {
+    upsert: personalNotes.upsert,
+  },
+})
+
+export default {
+  id: 'createPersonalNotesApi',
+  type: 'api',
+  factory: createPersonalNotesApi,
+  dependencies: ['personalNotes'],
+}

package/src/modules/personal-notes/index.js

@@ -0,0 +1,28 @@
+import { personalNotesAtomDefinition } from '@exodus/personal-notes/atoms'
+import personalNotesDefinition from '@exodus/personal-notes/module'
+
+import personalNotesApiDefinition from './api'
+import personalNotesPluginDefinition from './plugin'
+
+// TODO: Add type to module definitions
+const personalNotes = () => {
+  return {
+    id: 'personalNotes',
+    definitions: [
+      {
+        definition: { type: 'atom', ...personalNotesAtomDefinition },
+        aliases: [
+          {
+            implementationId: 'personalNotesStorage',
+            interfaceId: 'storage',
+          },
+        ],
+      },
+      { definition: { type: 'module', ...personalNotesDefinition } },
+      { definition: personalNotesPluginDefinition },
+      { definition: personalNotesApiDefinition },
+    ],
+  }
+}
+
+export default personalNotes

package/src/modules/personal-notes/plugin.js

@@ -0,0 +1,15 @@
+const personalNotesLifecyclePlugin = ({ personalNotes }) => {
+  // TEMP: dont wait to clear as encrypted storage is not yet unlocked
+  const onClear = () => {
+    personalNotes.clear()
+  }
+
+  return { onClear }
+}
+
+export default {
+  id: 'personalNotesLifecyclePlugin',
+  type: 'plugin',
+  factory: personalNotesLifecyclePlugin,
+  dependencies: ['personalNotes'],
+}

package/src/modules/remote-config/api.js

@@ -0,0 +1,13 @@
+const createRemoteConfigApi = ({ remoteConfig }) => ({
+  remoteConfig: {
+    get: remoteConfig.get,
+    getAll: remoteConfig.getAll,
+  },
+})
+
+export default {
+  id: 'createRemoteConfigApi',
+  type: 'api',
+  factory: createRemoteConfigApi,
+  dependencies: ['remoteConfig'],
+}

package/src/modules/remote-config/index.js

@@ -0,0 +1,28 @@
+import createRemoteConfig from '@exodus/config/remote'
+import EventEmitter from 'events/'
+
+import remoteConfigApiDefinition from './api'
+import remoteConfigPluginDefinition from './plugin'
+
+const remoteConfig = () => {
+  return {
+    id: 'remoteConfig',
+    definitions: [
+      {
+        definition: {
+          id: 'remoteConfig',
+          type: 'module',
+          factory: (deps) => {
+            const eventEmitter = new EventEmitter().setMaxListeners(Number.POSITIVE_INFINITY)
+            return createRemoteConfig({ eventEmitter, ...deps })
+          },
+          dependencies: ['fetch', 'freeze', 'config', 'logger'],
+        },
+      },
+      { definition: remoteConfigPluginDefinition },
+      { definition: remoteConfigApiDefinition },
+    ],
+  }
+}
+
+export default remoteConfig

package/src/modules/remote-config/plugin.js

@@ -0,0 +1,20 @@
+const remoteConfigLifecyclePlugin = ({ remoteConfig, port }) => {
+  remoteConfig.on('sync', ({ current }) => port.emit('remote-config', current))
+
+  const onStart = () => {
+    remoteConfig.load()
+  }
+
+  const onUnlock = () => {
+    remoteConfig.sync()
+  }
+
+  return { onUnlock, onStart }
+}
+
+export default {
+  id: 'remoteConfigLifecyclePlugin',
+  type: 'plugin',
+  factory: remoteConfigLifecyclePlugin,
+  dependencies: ['remoteConfig', 'port'],
+}