@exodus/headless 2.0.0-alpha.118 → 2.0.0-alpha.12

package/README.md

@@ -15,7 +15,6 @@ The headless Exodus wallet SDK
 
 ```js
 import createExodus from '@exodus/headless'
-import referrals from '@exodus/headless/src/modules/referrals'
 import Emitter from '@exodus/wild-emitter'
 
 // 1. Create port. Acts as an event bus between headless wallet and client
@@ -26,10 +25,10 @@ const adapters = {}
 const config = {}
 
 // 3. Create Exodus container
-const exodusContainer = createExodus({ port, adapters, config })
+const container = createExodus({ port, adapters, config })
 
 // 4. Register external modules. Does not support overriding modules at the moment.
-exodusContainer.register({
+container.register({
   definition: {
     id: 'remoteConfig',
     factory: createRemoteConfig,
@@ -37,22 +36,11 @@ exodusContainer.register({
   },
 })
 
-// see an example feature definition:
-// https://github.com/ExodusMovement/exodus-hydra/blob/2e8d63426421ffcbec84a9b6fbc83eb913b47eba/modules/headless/src/modules/geolocation/index.js
-exodusContainer.use(referrals())
-exodusContainer.use(myCustomFeature({ id: 'myCustomFeature', ... }))
-
 // 5. Resolve exodus instance
-const exodus = exodusContainer.resolve()
-
-// 6. Start exodus instance
-await exodus.wallet.start()
+const exodus = container.resolve()
 
-// 7. Use it!
+// 6. Use it!
 await exodus.wallet.create({ passphrase: 'my-super-secure-passphrase' })
-
-// 8. Use your custom feature API, if any
-exodus.myCustomFeature.doThatThingYouDo()
 ```
 
 ## Lifecycle

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@exodus/headless",
-  "version": "2.0.0-alpha.118",
-  "description": "The platform-agnostic Exodus wallet SDK",
-  "author": "Exodus Movement Inc.",
+  "version": "2.0.0-alpha.12",
+  "description": "The headless Exodus wallet SDK",
+  "author": "Exodus Movement Inc",
   "main": "src/index.js",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/ExodusMovement/exodus-hydra.git"
   },
-  "homepage": "https://github.com/ExodusMovement/exodus-hydra/tree/master/sdks/headless",
+  "homepage": "https://github.com/ExodusMovement/exodus-hydra/tree/master/modules/headless",
   "license": "UNLICENSED",
   "bugs": {
     "url": "https://github.com/ExodusMovement/exodus-hydra/issues?q=is%3Aissue+is%3Aopen+label%3Aheadless"
@@ -17,83 +17,55 @@
     "src",
     "README.md",
     "CHANGELOG.md",
-    "!**/__tests__/**",
+    "!**/__tests__",
     "!**/*.test.js"
   ],
   "scripts": {
     "lint": "eslint . --ignore-path ../../.gitignore",
     "lint:fix": "yarn lint --fix",
-    "test": "jest --runInBand"
+    "test": "jest"
   },
   "dependencies": {
-    "@exodus/address-provider": "^7.0.0",
-    "@exodus/atoms": "^5.6.0",
-    "@exodus/auto-enable-assets-plugin": "^4.2.1",
-    "@exodus/available-assets": "^5.1.1",
-    "@exodus/balances": "^10.0.0",
+    "@exodus/atoms": "^2.9.0",
+    "@exodus/available-assets": "^2.0.0",
+    "@exodus/balances": "^6.0.0",
     "@exodus/basic-utils": "^2.0.0",
-    "@exodus/blockchain-metadata": "^12.0.0",
-    "@exodus/dependency-injection": "^2.0.1",
-    "@exodus/dependency-preprocessors": "^3.1.1",
-    "@exodus/enabled-assets": "^8.1.1",
-    "@exodus/feature-flags": "^4.0.0",
-    "@exodus/fee-monitors": "^2.1.0",
+    "@exodus/blockchain-metadata": "^8.0.1",
+    "@exodus/config": "7.0.0",
+    "@exodus/dependency-injection": "^1.2.0",
+    "@exodus/dependency-preprocessors": "^2.0.2",
+    "@exodus/enabled-assets": "^6.0.0",
+    "@exodus/exodus-pricing-client": "^1.1.0",
     "@exodus/fetch": "^1.2.1",
-    "@exodus/geolocation": "^2.2.0",
-    "@exodus/hd-key-slip-10": "^2.0.0",
     "@exodus/key-identifier-provider": "^1.1.3",
-    "@exodus/keychain": "^4.1.0",
-    "@exodus/locale": "^2.0.0",
+    "@exodus/keychain": "^4.0.0",
+    "@exodus/market-history": "^3.1.0",
     "@exodus/module": "^1.0.0",
-    "@exodus/pricing": "^1.1.0",
-    "@exodus/rates-monitor": "^4.0.0",
-    "@exodus/remote-config": "^2.0.0",
-    "@exodus/restore-progress-tracker": "^2.0.5",
-    "@exodus/sodium-crypto": "^3.2.0",
-    "@exodus/wallet": "^9.3.0",
-    "@exodus/wallet-accounts": "^12.0.0",
-    "@exodus/wallet-compatibility-modes": "^3.0.0",
-    "bip39": "^2.6.0",
+    "@exodus/wallet": "^6.0.1",
+    "@exodus/wallet-accounts": "^8.0.1",
+    "@exodus/wallet-compatibility-modes": "^2.0.0",
+    "bip39": "2.6.0",
     "events": "^3.3.0",
-    "lodash": "npm:@exodus/lodash@^4.17.21-exodus.2",
+    "lodash": "https://registry.yarnpkg.com/@exodus/lodash/-/lodash-4.17.21-exodus.2.tgz",
     "minimalistic-assert": "^1.0.1"
   },
   "devDependencies": {
-    "@exodus/ab-testing": "^7.0.0",
-    "@exodus/algorand-lib": "^2.0.1",
-    "@exodus/algorand-meta": "^1.1.4",
-    "@exodus/apy-rates": "^3.1.0",
-    "@exodus/bitcoin-lib": "^2.2.1",
     "@exodus/bitcoin-meta": "^1.0.0",
-    "@exodus/connected-origins": "^3.1.1",
-    "@exodus/crypto-news-monitor": "^3.1.0",
     "@exodus/currency": "^2.2.0",
     "@exodus/ethereum-lib": "^2.22.2",
     "@exodus/ethereum-meta": "^1.0.23",
-    "@exodus/exodus-pricing-client": "^1.2.0",
-    "@exodus/key-utils": "^3.0.0",
-    "@exodus/kyc": "^4.1.0",
-    "@exodus/market-history": "^7.1.0",
     "@exodus/models": "^8.11.1",
-    "@exodus/nfts": "^5.2.0",
-    "@exodus/personal-notes": "^3.5.0",
-    "@exodus/referrals": "^8.0.0",
     "@exodus/solana-lib": "^1.3.11",
     "@exodus/solana-meta": "^1.0.2",
     "@exodus/storage-encrypted": "^1.1.2",
-    "@exodus/storage-memory": "^2.1.1",
-    "@exodus/top-movers-monitor": "^3.1.0",
-    "@exodus/ui-config": "^2.0.0",
+    "@exodus/storage-memory": "^1.1.0",
     "@exodus/wild-emitter": "^1.0.0",
     "buffer-json": "^2.0.0",
     "deepmerge": "^4.2.2",
-    "delay": "^5.0.0",
-    "eslint": "^8.44.0",
-    "eslint-plugin-simple-import-sort": "^7.0.0",
+    "eslint": "^8.33.0",
     "events": "^3.3.0",
     "jest": "^29.1.2",
-    "nock": "^13.3.1",
     "p-defer": "^4.0.0"
   },
-  "gitHead": "fe2afc2446d5f185f09323f7b345430a5861bc22"
+  "gitHead": "696729a77e39cd2c973c5021a3cc340f759b76fc"
 }

package/src/api.js

@@ -1,13 +1,84 @@
 import { validateMnemonic as isMnemonicValid } from 'bip39'
 
-import createReporting from './reporting'
+const createApi = ({ ioc, port }) => {
+  const { passphraseCache } = ioc.getByType('adapter')
 
-const createApi = ({ ioc, port, lockedAtom }) => {
-  const apis = ioc.getByType('api')
+  const {
+    application,
+    assetsModule,
+    blockchainMetadata,
+    enabledAssets,
+    remoteConfig,
+    wallet,
+    walletAccounts,
+  } = ioc.getByType('module')
+
+  const {
+    // ...
+    currencyAtom,
+    enabledWalletAccountsAtom,
+    languageAtom,
+  } = ioc.getByType('atom')
 
   return {
-    ...Object.assign({}, ...Object.values(apis)),
-    ...createReporting({ ioc, lockedAtom }),
+    wallet: {
+      exists: () => wallet.exists(),
+      load: application.load,
+      unload: application.unload,
+      create: application.create,
+      lock: application.lock,
+      unlock: application.unlock,
+      import: application.import,
+      delete: application.delete,
+      getMnemonic: application.getMnemonic,
+      setBackedUp: application.setBackedUp,
+      changePassphrase: application.changePassphrase,
+      restoreFromCurrentPhrase: async ({ passphrase } = {}) => {
+        if (!passphrase) passphrase = await passphraseCache.get()
+        const mnemonic = await application.getMnemonic({ passphrase })
+
+        await application.import({ passphrase, mnemonic })
+      },
+      changeLockTimer: application.changeLockTimer,
+      isLocked: () => wallet.isLocked(),
+    },
+    walletAccounts: {
+      create: walletAccounts.create,
+      update: walletAccounts.update,
+      disable: walletAccounts.disable,
+      enable: walletAccounts.enable,
+      getEnabled: enabledWalletAccountsAtom.get,
+    },
+    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,
+      addAndEnableToken: async (...args) => {
+        const asset = await assetsModule.addToken(...args)
+        await enabledAssets.enable([asset.name])
+        return asset.name
+      },
+    },
+    remoteConfig: {
+      get: remoteConfig.get,
+      getAll: remoteConfig.getAll,
+    },
+    locale: {
+      setLanguage: (value) => languageAtom.set(value),
+      setCurrency: (value) => currencyAtom.set(value),
+    },
     isMnemonicValid,
     subscribe: port.subscribe.bind(port),
     unsubscribe: port.unsubscribe.bind(port),

package/src/application.js

@@ -3,8 +3,6 @@
 import ExodusModule from '@exodus/module'
 import assert from 'minimalistic-assert'
 
-import { LifecycleHook as Hook } from './constants'
-
 // Because we are forced to restart wallet after deleting/importing, we need to store certain flags to persist state between executions
 
 // Triggers deletetion logic when wallet starts.
@@ -19,6 +17,23 @@ const IMPORT_FLAG = 'importFlag'
 // Set as true on import method is called, and set to false after restore is completed
 const RESTORE_FLAG = 'restoreFlag'
 
+const Hook = Object.freeze({
+  Lock: 'lock',
+  Unlock: 'unlock',
+  Clear: 'clear',
+  Import: 'import',
+  Migrate: 'migrate',
+  Start: 'start',
+  Load: 'load',
+  Unload: 'unload',
+  Create: 'create',
+  Backup: 'backup',
+  Restore: 'restore',
+  RestoreCompleted: 'restore-completed',
+  AssetsSynced: 'assets-synced',
+  ChangePassphrase: 'change-passphrase',
+})
+
 const HOOKS = new Set(Object.values(Hook))
 
 class Application extends ExodusModule {
@@ -61,21 +76,7 @@ class Application extends ExodusModule {
 
     if (isImporting) await this.fire(Hook.Import)
 
-    const [hasPassphraseSet, isLocked, isBackedUp, isRestoring] = await Promise.all([
-      this.#wallet.hasPassphraseSet(),
-      this.#wallet.isLocked(),
-      this.#wallet.isBackedUp(),
-      this.isRestoring(),
-    ])
-
-    await this.fire(Hook.Start, {
-      walletExists,
-      hasPassphraseSet,
-      isLocked,
-      isBackedUp,
-      isRestoring,
-    })
-
+    await this.fire(Hook.Start)
     await this.#autoUnlock()
 
     const locked = await this.#wallet.isLocked()
@@ -126,17 +127,7 @@ class Application extends ExodusModule {
     const hooks = this.#hooks[hookName] || []
 
     for (let i = 0; i < hooks.length; i++) {
-      try {
-        await hooks[i](params)
-      } catch (err) {
-        this._logger.error(
-          `application lifecycle hook failed: ${hookName}`,
-          hooks[i].name,
-          params,
-          err
-        )
-        throw err
-      }
+      await hooks[i](params)
     }
 
     this.emit(hookName, params)
@@ -148,15 +139,7 @@ class Application extends ExodusModule {
     await this.#applicationStarted
     await this.#wallet.create(opts)
 
-    const isLocked = await this.#wallet.isLocked()
-
-    await this.fire(Hook.Create, {
-      hasPassphraseSet: !!opts?.passphrase,
-      isBackedUp: false,
-      isLocked,
-      isRestoring: false,
-      walletExists: true,
-    })
+    await this.fire(Hook.Create, { hasPassphraseSet: !!opts?.passphrase })
   }
 
   import = async (opts) => {
@@ -168,14 +151,14 @@ class Application extends ExodusModule {
 
     const walletExists = await this.#wallet.exists()
 
-    const { forceRestart, forgotPassphrase, ...wallet } = opts
+    const { forceRestart, ...wallet } = opts
 
     await this.#wallet.import(wallet)
 
     if (forceRestart || walletExists) {
       await this.#storage.set(IMPORT_FLAG, true)
 
-      await this.fire(Hook.Restart, { reason: 'import' })
+      this.emit('restart', { reason: 'import' })
     } else {
       await this.fire(Hook.Import)
 
@@ -224,8 +207,6 @@ class Application extends ExodusModule {
       this._logger.log('unlocking with cache')
 
       await this.#wallet.unlock({ passphrase })
-
-      await this.fire(Hook.Migrate)
       await this.fire(Hook.Unlock)
 
       this.#restoreIfNeeded()
@@ -263,23 +244,15 @@ class Application extends ExodusModule {
     this._logger.log('passphrase changed')
   }
 
-  delete = async ({ forgotPassphrase } = {}) => {
+  delete = async () => {
     await this.#storage.set(DELETE_FLAG, true)
-    await this.fire(Hook.Restart, { reason: 'delete', forgotPassphrase })
-  }
-
-  stop = async () => {
-    await this.fire(Hook.Stop)
+    this.emit('restart', { reason: 'delete' })
   }
 
   changeLockTimer = async ({ ttl }) => {
     await this.#passphraseCache.changeTtl(ttl)
   }
 
-  restartAutoLockTimer = async () => {
-    await this.#passphraseCache.scheduleClear()
-  }
-
   isRestoring = async () => {
     return this.#storage.get(RESTORE_FLAG)
   }

package/src/atoms/attach.js

@@ -7,12 +7,23 @@ const emitAtomValue = async (opts) => {
 export const emitFromAtoms = ({ atoms, port }) =>
   Object.entries(atoms).forEach(async ([atomId, atom]) => emitAtomValue({ port, atomId, atom }))
 
-const attachAtom = ({ port, application, atom, atomId }) => {
+const attachAtom = ({ port, application, logger, atom, atomId, lifecycleEvents }) => {
   let loaded = false
 
-  application.on('load', async () => {
-    loaded = true
-    await emitAtomValue({ port, atomId, atom })
+  lifecycleEvents.forEach((event) =>
+    application.on(event, async () => {
+      loaded = true
+      await emitAtomValue({ port, atomId, atom })
+    })
+  )
+
+  application.on('clear', async () => {
+    try {
+      await atom?.set(undefined)
+    } catch (error) {
+      logger.debug('failed to clear atom', error)
+      // noop. atom might not support set
+    }
   })
 
   atom.observe((value) => {
@@ -20,9 +31,9 @@ const attachAtom = ({ port, application, atom, atomId }) => {
   })
 }
 
-const attachAtoms = ({ port, application, atoms }) => {
+const attachAtoms = ({ port, application, logger, atoms, lifecycleEvents = ['start'] }) => {
   for (const [atomId, atom] of Object.entries(atoms)) {
-    attachAtom({ port, application, atom, atomId })
+    attachAtom({ port, application, logger, atom, atomId, lifecycleEvents })
   }
 }
 

package/src/constants.js

@@ -1,38 +1,8 @@
 export const atomsToAttach = [
-  'abTestingAtom',
-  'apyRatesAtom',
   'availableAssetNamesAtom',
-  'balancesAtom',
-  'connectedOriginsAtom',
-  'cryptoNewsAtom',
   'currencyAtom',
   'enabledWalletAccountsAtom',
-  'featureFlagsAtom',
-  'geolocationAtom',
-  'kycAtom',
   'languageAtom',
-  'nftsConfigAtom',
-  'personalNotesAtom',
-  'referralsAtom',
-  'topMoversAtom',
   'walletAccountsAtom',
+  'balancesAtom',
 ]
-
-export const LifecycleHook = Object.freeze({
-  Lock: 'lock',
-  Unlock: 'unlock',
-  Clear: 'clear',
-  Import: 'import',
-  Migrate: 'migrate',
-  Start: 'start',
-  Stop: 'stop',
-  Restart: 'restart',
-  Load: 'load',
-  Unload: 'unload',
-  Create: 'create',
-  Backup: 'backup',
-  Restore: 'restore',
-  RestoreCompleted: 'restore-completed',
-  AssetsSynced: 'assets-synced',
-  ChangePassphrase: 'change-passphrase',
-})

package/src/dependencies/atoms.js

@@ -1,5 +1,109 @@
-import baseAssetNamesToMonitorAtomDefinition from '../atoms/base-asset-names-to-monitor'
+import {
+  createInMemoryAtom,
+  createRemoteConfigAtomFactory,
+  createStorageAtomFactory,
+  createFusionAtomFactory,
+} from '@exodus/atoms'
+import {
+  walletAccountsAtomDefinition,
+  enabledWalletAccountsAtomDefinition,
+} from '@exodus/wallet-accounts/atoms'
 
-const createAtomDependencies = () => [{ definition: baseAssetNamesToMonitorAtomDefinition }]
+import {
+  enabledAndDisabledAssetsAtomDefinition,
+  enabledAssetsAtomDefinition,
+} from '@exodus/enabled-assets/atoms'
+
+import { availableAssetNamesAtomDefinition } from '@exodus/available-assets/atoms'
+
+import { withType } from './utils'
+import { balancesAtomDefinition } from '@exodus/balances/atoms'
+
+const createAtomDependencies = () =>
+  [
+    {
+      definition: {
+        id: 'lockedAtom',
+        factory: () => createInMemoryAtom({ defaultValue: true }),
+        dependencies: [],
+      },
+    },
+    {
+      definition: walletAccountsAtomDefinition,
+      storage: { namespace: 'walletAccounts' },
+    },
+    { definition: enabledWalletAccountsAtomDefinition },
+    { definition: enabledAndDisabledAssetsAtomDefinition },
+    { definition: enabledAssetsAtomDefinition },
+    { definition: availableAssetNamesAtomDefinition },
+    {
+      definition: {
+        id: 'pricingServerUrlAtom',
+        factory: ({ config, remoteConfig }) =>
+          createRemoteConfigAtomFactory({ remoteConfig })({
+            path: config.pricingServerPath,
+            defaultValue: config.defaultPricingServerUrl,
+          }),
+        dependencies: ['config', 'remoteConfig'],
+      },
+    },
+    {
+      definition: {
+        id: 'languageAtom',
+        factory: ({ storage, config }) =>
+          createStorageAtomFactory({ storage })({
+            key: 'language',
+            defaultValue: config.defaultValue,
+            isSoleWriter: true,
+          }),
+        dependencies: ['storage', 'config'],
+      },
+      aliases: [
+        {
+          implementationId: 'unsafeStorage',
+          interfaceId: 'storage',
+        },
+      ],
+      storage: { namespace: 'locale' },
+    },
+    {
+      definition: {
+        id: 'currencyAtom',
+        factory: ({ fusion, config }) =>
+          createFusionAtomFactory({ fusion })({
+            path: `private.currency`,
+            defaultValue: config.defaultValue,
+          }),
+        dependencies: ['fusion', 'config'],
+      },
+    },
+    // TODO: move to @exodus/market-history
+    {
+      definition: {
+        id: 'marketHistoryClearCacheAtom',
+        factory: ({ config }) => createInMemoryAtom(config),
+        dependencies: ['config'],
+      },
+    },
+    // TODO: move to @exodus/market-history
+    {
+      definition: {
+        id: 'remoteConfigClearMarketHistoryCacheAtom',
+        factory: ({ config, remoteConfig }) =>
+          createRemoteConfigAtomFactory({ remoteConfig })(config),
+        dependencies: ['config', 'remoteConfig'],
+      },
+    },
+    // TODO: move to @exodus/market-history
+    {
+      definition: {
+        id: 'marketHistoryRefreshIntervalAtom',
+        factory: ({ config, remoteConfig }) =>
+          createRemoteConfigAtomFactory({ remoteConfig })(config),
+        dependencies: ['config', 'remoteConfig'],
+      },
+    },
+    { definition: balancesAtomDefinition },
+  ].map(withType('atom'))
 
 export default createAtomDependencies

package/src/dependencies/index.js

@@ -3,12 +3,13 @@
 
 import assert from 'minimalistic-assert'
 
+import createConfigDependencies from './configs'
 import createAdapterDependencies from './adapters'
 import createAtomDependencies from './atoms'
-import createConfigDependencies from './configs'
 import createModuleDependencies from './modules'
-import createPluginDependencies from './plugins'
+import createMonitorDependencies from './monitors'
 import { wrapConstant } from './utils'
+import createPluginDependencies from './plugins'
 
 const adapterKeys = [
   // ...
@@ -33,6 +34,8 @@ const createDependencies = ({ adapters, config }) => {
 
   const modules = createModuleDependencies({ adapters, config })
 
+  const monitors = createMonitorDependencies({ adapters, config })
+
   const atoms = createAtomDependencies({ adapters, config })
 
   const adaptersTree = createAdapterDependencies({ adapters, config })
@@ -43,6 +46,7 @@ const createDependencies = ({ adapters, config }) => {
     .concat(adaptersTree)
     .concat(configs)
     .concat(modules)
+    .concat(monitors)
     .concat(atoms)
     .concat(plugins)
     .concat(wrapConstant({ id: 'logger', type: 'module', value: logger }))