@exodus/headless 2.0.0-alpha.149 → 2.0.0-alpha.15

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
@@ -197,7 +185,7 @@ Currently not used.
 
 ## Headless API
 
-### wallet
+## wallet
 
 > Type: object
 
@@ -217,7 +205,7 @@ Currently not used.
 | unload                   | `async () => void`                                                                  | Unloads UI by rehydratating data through port (`BE Only`)                         |
 | changeLockTimer          | `async ({ ttl: number }) => void`                                                   | Change auto unlock ttl (`BE Only`)                                                |
 
-### isMnemonicValid
+## isMnemonicValid
 
 > Type: function
 
@@ -228,7 +216,7 @@ Currently not used.
 
 **Returns**: `boolean`
 
-### walletAccounts
+## walletAccounts
 
 > Type: object
 
@@ -240,7 +228,7 @@ Currently not used.
 | disable    | `async (name) => void`                      | Disables an existing WalletAccount.                            |
 | getEnabled | `async () => object`                        | Returns enabled walletAccounts as `{ [name]: WalletAccount }`. |
 
-### blockchainMetadata
+## blockchainMetadata
 
 > Type: object
 
@@ -258,7 +246,7 @@ Currently not used.
 | removeAccountState     | `async ({ assetName: string, walletAccount: string }) => void`                                             | Remove accountState for AssetSource.                                                                     |
 | batch                  | `() => Batch`                                                                                              | Create a batch of updates. See [blockchainMetadata](../blockchain-metadata) README for batching details. |
 
-### assets
+## assets
 
 > Type: object
 
@@ -268,7 +256,7 @@ 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
+## locale
 
 > Type: object
 
@@ -277,7 +265,7 @@ Currently not used.
 | setCurrency | `async (currency: string) => void` | Changes current currency. |
 | setLanguage | `async (language: string) => void` | Changes current language. |
 
-### subscribe
+## subscribe
 
 > Type: function
 
@@ -285,14 +273,3 @@ Currently not used.
 | ----------- | ------------------------------------------ | ------------------------------------------ |
 | subscribe   | `({ type: string, payload: any }) => void` | Subscribe to receive events.               |
 | unsubscribe | `({ type: string, payload: any }) => void` | Unsubscribe handler from receiving events. |
-
-### featureFlags
-
-> Type: object
-
-| Method  | Type                                  | Description                            |
-| ------- | ------------------------------------- | -------------------------------------- |
-| enable  | `async (featureName: string) => void` | Enables a feature-flag gated feature.  |
-| disable | `async (featureName: string) => void` | Disables a feature-flag gated feature. |
-
-See [more details](../../features/feature-flags/).

package/package.json

@@ -1,14 +1,14 @@
 {
   "name": "@exodus/headless",
-  "version": "2.0.0-alpha.149",
-  "description": "The platform-agnostic Exodus wallet SDK",
-  "author": "Exodus Movement Inc.",
+  "version": "2.0.0-alpha.15",
+  "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,88 +17,57 @@
     "src",
     "README.md",
     "CHANGELOG.md",
-    "!**/__tests__/**",
+    "!**/__tests__",
     "!**/*.test.js"
   ],
   "scripts": {
     "lint": "eslint . --ignore-path ../../.gitignore",
     "lint:fix": "yarn lint --fix",
-    "test": "NODE_OPTIONS=--max-old-space-size=4096 jest"
+    "test": "jest"
   },
   "dependencies": {
-    "@exodus/address-provider": "^9.0.1",
-    "@exodus/assets-feature": "^4.0.0",
-    "@exodus/atoms": "^7.0.0",
-    "@exodus/auto-enable-assets-plugin": "^4.4.0",
-    "@exodus/available-assets": "^8.0.0",
-    "@exodus/balances": "^12.0.1",
+    "@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": "^15.0.0",
-    "@exodus/dependency-injection": "^2.1.0",
-    "@exodus/dependency-preprocessors": "^4.0.0",
-    "@exodus/enabled-assets": "^9.0.1",
-    "@exodus/feature-flags": "^5.1.0",
-    "@exodus/fee-data-monitors": "^3.0.0",
+    "@exodus/blockchain-metadata": "^8.0.1",
+    "@exodus/config": "7.0.0",
+    "@exodus/dependency-injection": "^1.2.0",
+    "@exodus/dependency-preprocessors": "^2.3.0",
+    "@exodus/enabled-assets": "^6.0.0",
+    "@exodus/exodus-pricing-client": "^1.1.0",
     "@exodus/fetch": "^1.2.1",
-    "@exodus/geolocation": "^3.0.0",
-    "@exodus/hd-key-slip-10": "^2.0.0",
-    "@exodus/key-identifier-provider": "^1.4.0",
-    "@exodus/keychain": "^4.3.0",
-    "@exodus/locale": "^2.0.2",
-    "@exodus/module": "^1.2.2",
-    "@exodus/pricing": "^1.1.0",
-    "@exodus/public-key-store": "^1.2.0",
-    "@exodus/rates-monitor": "^4.0.2",
-    "@exodus/remote-config": "^2.3.0",
-    "@exodus/restore-progress-tracker": "^3.0.0",
-    "@exodus/sodium-crypto": "^3.2.0",
-    "@exodus/startup-counter": "^1.0.0",
-    "@exodus/tx-signer": "^1.1.0",
-    "@exodus/wallet": "^10.3.0",
-    "@exodus/wallet-accounts": "^15.0.0",
-    "@exodus/wallet-compatibility-modes": "^3.2.0",
-    "bip39": "^2.6.0",
+    "@exodus/geolocation": "1.1.0",
+    "@exodus/key-identifier-provider": "^1.1.3",
+    "@exodus/keychain": "^4.0.0",
+    "@exodus/market-history": "^3.1.0",
+    "@exodus/module": "^1.0.0",
+    "@exodus/rates-monitor": "^2.0.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.1.0",
-    "@exodus/algorand-lib": "^2.0.1",
-    "@exodus/algorand-meta": "^1.1.4",
-    "@exodus/apy-rates": "^3.3.1",
-    "@exodus/assets-feature": "workspace:^",
-    "@exodus/bitcoin-plugin": "^1.0.14",
-    "@exodus/connected-origins": "^3.3.0",
-    "@exodus/crypto-news-monitor": "^4.1.0",
+    "@exodus/bitcoin-meta": "^1.0.0",
     "@exodus/currency": "^2.2.0",
-    "@exodus/ethereum-lib": "^3.3.34",
+    "@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.2.0",
-    "@exodus/litecoin-meta": "^1.0.0",
-    "@exodus/market-history": "^7.2.0",
-    "@exodus/models": "^10.1.0",
-    "@exodus/nfts": "^7.1.2",
-    "@exodus/personal-notes": "^3.6.0",
-    "@exodus/referrals": "^8.0.1",
+    "@exodus/models": "^8.11.1",
     "@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.2.0",
-    "@exodus/ui-config": "^3.3.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",
-    "msw": "^2.0.0",
     "p-defer": "^4.0.0"
   },
-  "gitHead": "20d96231a08ff6a8cad77f5c7ef8f9b62627656f"
+  "gitHead": "5aae21f6315492fe857aa8bd79995134886d2fcd"
 }

package/src/api.js

@@ -0,0 +1,86 @@
+import { validateMnemonic as isMnemonicValid } from 'bip39'
+
+const createApi = ({ ioc, port }) => {
+  const { assetsModule, passphraseCache } = ioc.getByType('adapter')
+
+  const { application, blockchainMetadata, enabledAssets, remoteConfig, wallet, walletAccounts } =
+    ioc.getByType('module')
+
+  const { ratesMonitor } = ioc.getByType('monitor')
+
+  const {
+    // ...
+    currencyAtom,
+    enabledWalletAccountsAtom,
+    languageAtom,
+  } = ioc.getByType('atom')
+
+  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,
+    },
+    locale: {
+      setLanguage: (value) => languageAtom.set(value),
+      setCurrency: (value) => currencyAtom.set(value),
+    },
+    rates: {
+      refresh: () => ratesMonitor.update(),
+    },
+    isMnemonicValid,
+    subscribe: port.subscribe.bind(port),
+    unsubscribe: port.unsubscribe.bind(port),
+  }
+}
+
+export default createApi

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,15 +17,24 @@ 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 = new Set(Object.values(Hook))
+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 passphraseCachePlaceholder = {
-  get: () => {},
-  set: () => {},
-  changeTtl: () => {},
-  clear: () => {},
-  scheduleClear: () => {},
-}
+const HOOKS = new Set(Object.values(Hook))
 
 class Application extends ExodusModule {
   #hooks = {}
@@ -37,7 +44,7 @@ class Application extends ExodusModule {
   #applicationStarted = null
   #resolveStart = null
 
-  constructor({ wallet, unsafeStorage, passphraseCache = passphraseCachePlaceholder, logger }) {
+  constructor({ wallet, unsafeStorage, passphraseCache, logger }) {
     super({ name: 'Application', logger })
 
     this.#wallet = wallet
@@ -64,26 +71,12 @@ class Application extends ExodusModule {
     const walletExists = await this.#wallet.exists()
 
     if (isImporting || !walletExists) {
-      await this.fire(Hook.Clear, null, { concurrent: true })
+      await this.fire(Hook.Clear)
     }
 
     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()
@@ -111,7 +104,6 @@ class Application extends ExodusModule {
       isRestoring,
     })
   }
-
   unload = async () => {
     await this.#applicationStarted
     await this.#passphraseCache.scheduleClear()
@@ -128,28 +120,14 @@ class Application extends ExodusModule {
     this.#hooks[hookName].push(listener)
   }
 
-  fire = async (hookName, params, { concurrent } = {}) => {
+  fire = async (hookName, params) => {
     assert(HOOKS.has(hookName), `no such hook: ${hookName}`)
-
-    this._logger.debug(`firing hooks ${concurrent ? 'concurrently' : 'sequentially'}`, hookName)
+    this._logger.debug('firing hooks', hookName)
 
     const hooks = this.#hooks[hookName] || []
 
-    const hookFns = hooks.map((hook) => async () => {
-      try {
-        await hook(params)
-      } catch (err) {
-        this._logger.error(`application lifecycle hook failed: ${hookName}`, hook.name, params, err)
-        throw err
-      }
-    })
-
-    if (concurrent) {
-      await Promise.allSettled(hookFns.map((promise) => promise()))
-    } else {
-      for (let i = 0; i < hookFns.length; i++) {
-        await hookFns[i]()
-      }
+    for (let i = 0; i < hooks.length; i++) {
+      await hooks[i](params)
     }
 
     this.emit(hookName, params)
@@ -161,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) => {
@@ -181,15 +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)
-    await this.fire(Hook.Backup)
 
     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)
 
@@ -221,17 +190,13 @@ class Application extends ExodusModule {
     if (isRestoring) {
       await this.fire(Hook.Restore)
       await this.#storage.delete(RESTORE_FLAG)
+      await this.setBackedUp()
       await this.fire(Hook.RestoreCompleted)
     }
 
     this.fire(Hook.AssetsSynced)
   }
 
-  restore = async () => {
-    await this.#storage.set(RESTORE_FLAG, true)
-    await this.restoreIfNeeded()
-  }
-
   #autoUnlock = async () => {
     const walletLocked = await this.#wallet.isLocked()
     const passphrase = await this.#passphraseCache.get()
@@ -242,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()
@@ -281,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

@@ -0,0 +1,40 @@
+const emitAtomValue = async (opts) => {
+  const { port, atomId, atom } = opts
+  const value = 'value' in opts ? opts.value : await atom.get()
+  port.emit(atomId, value)
+}
+
+export const emitFromAtoms = ({ atoms, port }) =>
+  Object.entries(atoms).forEach(async ([atomId, atom]) => emitAtomValue({ port, atomId, atom }))
+
+const attachAtom = ({ port, application, logger, atom, atomId, lifecycleEvents }) => {
+  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
+    }
+  })
+
+  atom.observe((value) => {
+    if (loaded) emitAtomValue({ port, atomId, atom, value })
+  })
+}
+
+const attachAtoms = ({ port, application, logger, atoms, lifecycleEvents = ['start'] }) => {
+  for (const [atomId, atom] of Object.entries(atoms)) {
+    attachAtom({ port, application, logger, atom, atomId, lifecycleEvents })
+  }
+}
+
+export default attachAtoms

package/src/constants.js

@@ -1,18 +1,9 @@
-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',
-})
+export const atomsToAttach = [
+  'availableAssetNamesAtom',
+  'balancesAtom',
+  'currencyAtom',
+  'enabledWalletAccountsAtom',
+  'geolocationAtom',
+  'languageAtom',
+  'walletAccountsAtom',
+]