@exodus/headless 2.0.0-alpha.9.2 → 2.0.0-alpha.90

package/README.md

@@ -15,6 +15,7 @@ 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
@@ -25,10 +26,10 @@ const adapters = {}
 const config = {}
 
 // 3. Create Exodus container
-const container = createExodus({ port, adapters, config })
+const exodusContainer = createExodus({ port, adapters, config })
 
 // 4. Register external modules. Does not support overriding modules at the moment.
-container.register({
+exodusContainer.register({
   definition: {
     id: 'remoteConfig',
     factory: createRemoteConfig,
@@ -36,11 +37,22 @@ container.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 = container.resolve()
+const exodus = exodusContainer.resolve()
+
+// 6. Start exodus instance
+await exodus.wallet.start()
 
-// 6. Use it!
+// 7. Use it!
 await exodus.wallet.create({ passphrase: 'my-super-secure-passphrase' })
+
+// 8. Use your custom feature API, if any
+exodus.myCustomFeature.doThatThingYouDo()
 ```
 
 ## Lifecycle
@@ -256,6 +268,15 @@ Currently not used.
 | disable           | `async (assetNames: string[]) => void`                     | Disables assets.                                                       |
 | addAndEnableToken | `async (assetId: string, baseAssetName: string) => string` | Adds and enables a custom token. Returns the created `asset`'s `.name` |
 
+## locale
+
+> Type: object
+
+| Method      | Type                               | Description               |
+| ----------- | ---------------------------------- | ------------------------- |
+| setCurrency | `async (currency: string) => void` | Changes current currency. |
+| setLanguage | `async (language: string) => void` | Changes current language. |
+
 ## subscribe
 
 > Type: function

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@exodus/headless",
-  "version": "2.0.0-alpha.9.2",
-  "description": "The headless Exodus wallet SDK",
-  "author": "Exodus Movement Inc",
+  "version": "2.0.0-alpha.90",
+  "description": "The platform-agnostic 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/modules/headless",
+  "homepage": "https://github.com/ExodusMovement/exodus-hydra/tree/master/sdks/headless",
   "license": "UNLICENSED",
   "bugs": {
     "url": "https://github.com/ExodusMovement/exodus-hydra/issues?q=is%3Aissue+is%3Aopen+label%3Aheadless"
@@ -17,50 +17,79 @@
     "src",
     "README.md",
     "CHANGELOG.md",
-    "!**/__tests__",
+    "!**/__tests__/**",
     "!**/*.test.js"
   ],
   "scripts": {
     "lint": "eslint . --ignore-path ../../.gitignore",
     "lint:fix": "yarn lint --fix",
-    "test": "jest"
+    "test": "jest --runInBand"
   },
   "dependencies": {
-    "@exodus/atoms": "^2.9.0",
-    "@exodus/available-assets": "^2.0.0",
+    "@exodus/address-provider": "^6.0.0",
+    "@exodus/atoms": "^5.2.3",
+    "@exodus/auto-enable-assets-plugin": "^4.0.1",
+    "@exodus/available-assets": "^3.0.0",
+    "@exodus/balances": "^7.0.0",
     "@exodus/basic-utils": "^2.0.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": "^5.0.4",
+    "@exodus/blockchain-metadata": "^10.0.0",
+    "@exodus/dependency-injection": "^2.0.1",
+    "@exodus/dependency-preprocessors": "^2.8.4",
+    "@exodus/enabled-assets": "^7.0.0",
+    "@exodus/exodus-pricing-client": "^1.2.0",
+    "@exodus/feature-flags": "^4.0.0",
+    "@exodus/fee-monitors": "^1.0.0",
     "@exodus/fetch": "^1.2.1",
+    "@exodus/fusion": "^6.0.0",
+    "@exodus/geolocation": "^2.1.1",
     "@exodus/key-identifier-provider": "^1.1.3",
-    "@exodus/keychain": "^4.0.0",
+    "@exodus/keychain": "^4.1.0",
+    "@exodus/locale": "^1.1.0",
     "@exodus/module": "^1.0.0",
-    "@exodus/wallet": "^6.0.1",
-    "@exodus/wallet-accounts": "^8.0.1",
-    "@exodus/wallet-compatibility-modes": "^2.0.0",
-    "bip39": "2.6.0",
+    "@exodus/rates-monitor": "^3.0.0",
+    "@exodus/remote-config": "^2.0.0",
+    "@exodus/restore-progress-tracker": "^2.0.5",
+    "@exodus/wallet": "^8.1.1",
+    "@exodus/wallet-accounts": "^10.1.0",
+    "@exodus/wallet-compatibility-modes": "^3.0.0",
+    "bip39": "^2.6.0",
     "events": "^3.3.0",
-    "lodash": "https://registry.yarnpkg.com/@exodus/lodash/-/lodash-4.17.21-exodus.2.tgz",
+    "lodash": "npm:@exodus/lodash@^4.17.21-exodus.2",
     "minimalistic-assert": "^1.0.1"
   },
   "devDependencies": {
+    "@exodus/ab-testing": "^6.0.0",
+    "@exodus/algorand-lib": "^2.0.1",
+    "@exodus/algorand-meta": "^1.1.4",
+    "@exodus/apy-rates": "^3.0.0",
+    "@exodus/bitcoin-lib": "^2.2.1",
     "@exodus/bitcoin-meta": "^1.0.0",
+    "@exodus/connected-origins": "^2.0.0",
+    "@exodus/crypto-news-monitor": "^3.0.0",
     "@exodus/currency": "^2.2.0",
     "@exodus/ethereum-lib": "^2.22.2",
     "@exodus/ethereum-meta": "^1.0.23",
+    "@exodus/kyc": "^4.0.0",
+    "@exodus/market-history": "^5.0.1",
     "@exodus/models": "^8.11.1",
+    "@exodus/nfts": "^4.0.1",
+    "@exodus/personal-notes": "^3.3.0",
+    "@exodus/referrals": "^6.2.0",
     "@exodus/solana-lib": "^1.3.11",
     "@exodus/solana-meta": "^1.0.2",
-    "@exodus/storage-encrypted": "workspace:^",
-    "@exodus/storage-memory": "workspace:^",
+    "@exodus/storage-encrypted": "^1.1.2",
+    "@exodus/storage-memory": "^2.1.0",
+    "@exodus/top-movers-monitor": "^3.0.0",
     "@exodus/wild-emitter": "^1.0.0",
     "buffer-json": "^2.0.0",
-    "eslint": "^8.33.0",
+    "deepmerge": "^4.2.2",
+    "delay": "^5.0.0",
+    "eslint": "^8.44.0",
+    "eslint-plugin-simple-import-sort": "^7.0.0",
     "events": "^3.3.0",
     "jest": "^29.1.2",
+    "nock": "^13.3.1",
     "p-defer": "^4.0.0"
-  }
+  },
+  "gitHead": "f223f4b6c217ef5850af8b32df9e3d14def51def"
 }

package/src/api.js

@@ -1,78 +1,23 @@
 import { validateMnemonic as isMnemonicValid } from 'bip39'
 
 const createApi = ({ ioc, port }) => {
-  const { passphraseCache } = ioc.getByType('adapter')
+  const apis = ioc.getByType('api')
+  const { remoteConfig } = ioc.getByType('module')
+  const { feeMonitors, nftsMonitor } = ioc.getByType('monitor')
 
-  const {
-    application,
-    assetsModule,
-    blockchainMetadata,
-    enabledAssets,
-    remoteConfig,
-    wallet,
-    walletAccounts,
-  } = ioc.getByType('module')
-
-  const { enabledWalletAccountsAtom } = ioc.getByType('atom')
+  // TODO: do this on 'unload'
+  const stop = () => {
+    remoteConfig.stop()
+    feeMonitors.stop()
+    nftsMonitor?.stop()
+  }
 
   return {
-    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,
-    },
+    ...Object.assign({}, ...Object.values(apis)),
     isMnemonicValid,
     subscribe: port.subscribe.bind(port),
     unsubscribe: port.unsubscribe.bind(port),
+    stop,
   }
 }
 

package/src/application.js

@@ -3,6 +3,8 @@
 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.
@@ -17,22 +19,7 @@ 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 HOOKS = Object.freeze({
-  lock: 'lock',
-  unlock: 'unlock',
-  clear: 'clear',
-  import: 'import',
-  migrate: 'migrate',
-  start: 'start',
-  load: 'load',
-  unload: 'unload',
-  create: 'create',
-  backup: 'backup',
-  restore: 'restore',
-  'restore-completed': 'restore-completed',
-  'assets-synced': 'assets-synced',
-  'change-passphrase': 'change-passphrase',
-})
+const HOOKS = new Set(Object.values(Hook))
 
 class Application extends ExodusModule {
   #hooks = {}
@@ -69,12 +56,26 @@ class Application extends ExodusModule {
     const walletExists = await this.#wallet.exists()
 
     if (isImporting || !walletExists) {
-      await this.fire(HOOKS.clear)
+      await this.fire(Hook.Clear)
     }
 
-    if (isImporting) await this.fire(HOOKS.import)
+    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(HOOKS.start)
     await this.#autoUnlock()
 
     const locked = await this.#wallet.isLocked()
@@ -94,7 +95,7 @@ class Application extends ExodusModule {
       this.isRestoring(),
     ])
 
-    await this.fire(HOOKS.load, {
+    await this.fire(Hook.Load, {
       walletExists,
       hasPassphraseSet,
       isLocked,
@@ -105,11 +106,11 @@ class Application extends ExodusModule {
   unload = async () => {
     await this.#applicationStarted
     await this.#passphraseCache.scheduleClear()
-    await this.fire(HOOKS.unload)
+    await this.fire(Hook.Unload)
   }
 
   hook = (hookName, listener) => {
-    assert(HOOKS[hookName], `no such hook: ${hookName}`)
+    assert(HOOKS.has(hookName), `no such hook: ${hookName}`)
 
     if (!this.#hooks[hookName]) {
       this.#hooks[hookName] = []
@@ -119,13 +120,18 @@ class Application extends ExodusModule {
   }
 
   fire = async (hookName, params) => {
-    assert(HOOKS[hookName], `no such hook: ${hookName}`)
+    assert(HOOKS.has(hookName), `no such hook: ${hookName}`)
     this._logger.debug('firing hooks', hookName)
 
     const hooks = this.#hooks[hookName] || []
 
     for (let i = 0; i < hooks.length; i++) {
-      await hooks[i](params)
+      try {
+        await hooks[i](params)
+      } catch (err) {
+        this._logger.error(`application lifecycle hook failed: ${hookName}`, hooks[i], params)
+        throw err
+      }
     }
 
     this.emit(hookName, params)
@@ -137,7 +143,15 @@ class Application extends ExodusModule {
     await this.#applicationStarted
     await this.#wallet.create(opts)
 
-    await this.fire(HOOKS.create, { hasPassphraseSet: !!opts?.passphrase })
+    const isLocked = await this.#wallet.isLocked()
+
+    await this.fire(Hook.Create, {
+      hasPassphraseSet: !!opts?.passphrase,
+      isBackedUp: false,
+      isLocked,
+      isRestoring: false,
+      walletExists: true,
+    })
   }
 
   import = async (opts) => {
@@ -149,16 +163,16 @@ class Application extends ExodusModule {
 
     const walletExists = await this.#wallet.exists()
 
-    const { forceRestart, ...wallet } = opts
+    const { forceRestart, forgotPassphrase, ...wallet } = opts
 
     await this.#wallet.import(wallet)
 
     if (forceRestart || walletExists) {
       await this.#storage.set(IMPORT_FLAG, true)
 
-      this.emit('restart', { reason: 'import' })
+      await this.fire(Hook.Restart, { reason: 'import' })
     } else {
-      await this.fire(HOOKS.import)
+      await this.fire(Hook.Import)
 
       this._logger.log('wallet imported')
     }
@@ -168,7 +182,7 @@ class Application extends ExodusModule {
 
   setBackedUp = async () => {
     await this.#wallet.setBackedUp()
-    await this.fire(HOOKS.backup)
+    await this.fire(Hook.Backup)
   }
 
   lock = async (opts) => {
@@ -177,7 +191,7 @@ class Application extends ExodusModule {
     await this.#applicationStarted
     await this.#wallet.lock(opts)
     await this.#passphraseCache.clear()
-    await this.fire(HOOKS.lock)
+    await this.fire(Hook.Lock)
 
     this._logger.log('locked')
   }
@@ -186,13 +200,13 @@ class Application extends ExodusModule {
     const isRestoring = await this.isRestoring()
 
     if (isRestoring) {
-      await this.fire(HOOKS.restore)
+      await this.fire(Hook.Restore)
       await this.#storage.delete(RESTORE_FLAG)
       await this.setBackedUp()
-      await this.fire(HOOKS['restore-completed'])
+      await this.fire(Hook.RestoreCompleted)
     }
 
-    this.fire(HOOKS['assets-synced'])
+    this.fire(Hook.AssetsSynced)
   }
 
   #autoUnlock = async () => {
@@ -205,7 +219,9 @@ class Application extends ExodusModule {
       this._logger.log('unlocking with cache')
 
       await this.#wallet.unlock({ passphrase })
-      await this.fire(HOOKS.unlock)
+
+      await this.fire(Hook.Migrate)
+      await this.fire(Hook.Unlock)
 
       this.#restoreIfNeeded()
 
@@ -221,8 +237,8 @@ class Application extends ExodusModule {
     await this.#applicationStarted
     await this.#wallet.unlock({ passphrase })
 
-    await this.fire(HOOKS.migrate)
-    await this.fire(HOOKS.unlock)
+    await this.fire(Hook.Migrate)
+    await this.fire(Hook.Unlock)
 
     this.#restoreIfNeeded()
 
@@ -237,14 +253,14 @@ class Application extends ExodusModule {
     await this.#applicationStarted
     await this.#wallet.changePassphrase({ currentPassphrase, newPassphrase })
     await this.#passphraseCache.set(newPassphrase)
-    await this.fire(HOOKS['change-passphrase'])
+    await this.fire(Hook.ChangePassphrase)
 
     this._logger.log('passphrase changed')
   }
 
-  delete = async () => {
+  delete = async ({ forgotPassphrase } = {}) => {
     await this.#storage.set(DELETE_FLAG, true)
-    this.emit('restart', { reason: 'delete' })
+    await this.fire(Hook.Restart, { reason: 'delete', forgotPassphrase })
   }
 
   changeLockTimer = async ({ ttl }) => {

package/src/atoms/attach.js

@@ -7,23 +7,12 @@ const emitAtomValue = async (opts) => {
 export const emitFromAtoms = ({ atoms, port }) =>
   Object.entries(atoms).forEach(async ([atomId, atom]) => emitAtomValue({ port, atomId, atom }))
 
-const attachAtom = ({ port, application, logger, atom, atomId, lifecycleEvents }) => {
+const attachAtom = ({ port, application, atom, atomId }) => {
   let loaded = false
 
-  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
-    }
+  application.on('load', async () => {
+    loaded = true
+    await emitAtomValue({ port, atomId, atom })
   })
 
   atom.observe((value) => {
@@ -31,9 +20,9 @@ const attachAtom = ({ port, application, logger, atom, atomId, lifecycleEvents }
   })
 }
 
-const attachAtoms = ({ port, application, logger, atoms, lifecycleEvents = ['start'] }) => {
+const attachAtoms = ({ port, application, atoms }) => {
   for (const [atomId, atom] of Object.entries(atoms)) {
-    attachAtom({ port, application, logger, atom, atomId, lifecycleEvents })
+    attachAtom({ port, application, atom, atomId })
   }
 }
 

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

@@ -0,0 +1,38 @@
+import { combine, compute } 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 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/constants.js

@@ -1,4 +1,38 @@
 export const atomsToAttach = [
-  //
+  'abTestingAtom',
+  'apyRatesAtom',
   'availableAssetNamesAtom',
+  'balancesAtom',
+  'connectedOriginsAtom',
+  'cryptoNewsAtom',
+  'currencyAtom',
+  'enabledWalletAccountsAtom',
+  'featureFlagsAtom',
+  'geolocationAtom',
+  'kycAtom',
+  'languageAtom',
+  'nftsConfigAtom',
+  'personalNotesAtom',
+  'referralsAtom',
+  'topMoversAtom',
+  'walletAccountsAtom',
+  'restoringAssetsAtom',
 ]
+
+export const LifecycleHook = Object.freeze({
+  Lock: 'lock',
+  Unlock: 'unlock',
+  Clear: 'clear',
+  Import: 'import',
+  Migrate: 'migrate',
+  Start: 'start',
+  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,38 +1,5 @@
-import { createInMemoryAtom } from '@exodus/atoms'
-import {
-  walletAccountsAtomDefinition,
-  enabledWalletAccountsAtomDefinition,
-} from '@exodus/wallet-accounts/atoms'
+import baseAssetNamesToMonitorAtomDefinition from '../atoms/base-asset-names-to-monitor'
 
-import {
-  enabledAndDisabledAssetsAtomDefinition,
-  enabledAssetsAtomDefinition,
-} from '@exodus/enabled-assets/atoms'
-
-import { availableAssetNamesAtomDefinition } from '@exodus/available-assets/atoms'
-
-import { withType } from './utils'
-
-const createAtomDependencies = () =>
-  [
-    {
-      definition: {
-        id: 'lockedAtom',
-        factory: () => createInMemoryAtom({ defaultValue: true }),
-        dependencies: [],
-      },
-    },
-    {
-      definition: walletAccountsAtomDefinition,
-      storage: { namespace: 'walletAccounts' },
-    },
-    { definition: enabledWalletAccountsAtomDefinition },
-    {
-      definition: enabledAndDisabledAssetsAtomDefinition,
-      storage: { namespace: 'enabledAssets' },
-    },
-    { definition: enabledAssetsAtomDefinition },
-    { definition: availableAssetNamesAtomDefinition },
-  ].map(withType('atom'))
+const createAtomDependencies = () => [{ definition: baseAssetNamesToMonitorAtomDefinition }]
 
 export default createAtomDependencies

package/src/dependencies/index.js

@@ -3,12 +3,12 @@
 
 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 { wrapConstant } from './utils'
 import createPluginDependencies from './plugins'
+import { wrapConstant } from './utils'
 
 const adapterKeys = [
   // ...