@exodus/headless 2.0.0-alpha.46 → 2.0.0-alpha.48

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 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.48](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@2.0.0-alpha.47...@exodus/headless@2.0.0-alpha.48) (2023-06-20)
+
+### Bug Fixes
+
+- declare atoms in writesAtoms ([#2006](https://github.com/ExodusMovement/exodus-hydra/issues/2006)) ([02b7227](https://github.com/ExodusMovement/exodus-hydra/commit/02b72271116b4e3b034b7f889b0dc333fda17413))
+
+## [2.0.0-alpha.47](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@2.0.0-alpha.46...@exodus/headless@2.0.0-alpha.47) (2023-06-18)
+
+### Features
+
+- use(wallet) ([#1994](https://github.com/ExodusMovement/exodus-hydra/issues/1994)) ([6686257](https://github.com/ExodusMovement/exodus-hydra/commit/668625744087ee77068fc64671ce80ea0c3c62a4))
+
 ## [2.0.0-alpha.46](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@2.0.0-alpha.45...@exodus/headless@2.0.0-alpha.46) (2023-06-18)
 
 ### Features

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,14 +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()
 
 // 7. 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,6 +1,6 @@
 {
   "name": "@exodus/headless",
-  "version": "2.0.0-alpha.46",
+  "version": "2.0.0-alpha.48",
   "description": "The headless Exodus wallet SDK",
   "author": "Exodus Movement Inc",
   "main": "src/index.js",
@@ -45,6 +45,7 @@
     "@exodus/feature-flags": "^2.1.0",
     "@exodus/fee-monitors": "^1.0.0",
     "@exodus/fetch": "^1.2.1",
+    "@exodus/fusion": "^5.0.0",
     "@exodus/geolocation": "^2.0.0",
     "@exodus/key-identifier-provider": "^1.1.3",
     "@exodus/keychain": "^4.0.0",
@@ -88,5 +89,5 @@
     "nock": "^13.3.1",
     "p-defer": "^4.0.0"
   },
-  "gitHead": "9946e9d678eb80b4cb7de96fb76c804ae5e31fc9"
+  "gitHead": "a8a419acb6f13d21b294f346e1c00f10a5b3a90b"
 }

package/src/api.js

@@ -5,13 +5,10 @@ const createApi = ({ ioc, port }) => {
 
   const { assetsModule } = ioc.getByType('adapter')
 
-  const { application, enabledAssets, remoteConfig, wallet } = ioc.getByType('module')
+  const { enabledAssets, remoteConfig } = ioc.getByType('module')
 
   const { feeMonitors, nftsMonitor } = ioc.getByType('monitor')
 
-  // TODO: decide where this belongs
-  const { passphraseCache } = ioc.getAll()
-
   // TODO: do this on 'unload'
   const stop = () => {
     remoteConfig.stop()
@@ -21,28 +18,6 @@ const createApi = ({ ioc, port }) => {
 
   return {
     ...Object.assign({}, ...Object.values(apis)),
-    wallet: {
-      exists: () => wallet.exists(),
-      start: application.start,
-      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(),
-    },
     assets: {
       enable: enabledAssets.enable,
       disable: enabledAssets.disable,

package/src/dependencies/atoms.js

@@ -1,8 +1,4 @@
-import {
-  createInMemoryAtom,
-  createRemoteConfigAtomFactory,
-  createStorageAtomFactory,
-} from '@exodus/atoms'
+import { createRemoteConfigAtomFactory, createStorageAtomFactory } from '@exodus/atoms'
 import { availableAssetNamesAtomDefinition } from '@exodus/available-assets/atoms'
 import { balancesAtomDefinition } from '@exodus/balances/atoms'
 import {
@@ -12,18 +8,10 @@ import {
 
 import baseAssetNamesToMonitorAtomDefinition from '../atoms/base-asset-names-to-monitor'
 import nonDustBalanceAssetNamesAtomDefinition from '../atoms/non-dust-balance-asset-names-atom'
-import restoreAtomDefinition from '../atoms/restore'
 import { withType } from './utils'
 
 const createAtomDependencies = () =>
   [
-    {
-      definition: {
-        id: 'lockedAtom',
-        factory: () => createInMemoryAtom({ defaultValue: true }),
-        dependencies: [],
-      },
-    },
     {
       definition: enabledAndDisabledAssetsAtomDefinition,
       storage: { namespace: 'enabledAssets' },
@@ -65,7 +53,6 @@ const createAtomDependencies = () =>
     },
     { definition: balancesAtomDefinition },
     { definition: baseAssetNamesToMonitorAtomDefinition },
-    { definition: restoreAtomDefinition },
   ].map(withType('atom'))
 
 export default createAtomDependencies

package/src/dependencies/modules.js

@@ -4,7 +4,6 @@ import enabledAssetsModuleDefinition from '@exodus/enabled-assets/module'
 import createExodusPricingClient from '@exodus/exodus-pricing-client'
 import createKeyIdentifierProvider from '@exodus/key-identifier-provider'
 import keychainDefinition from '@exodus/keychain/module'
-import walletDefinition from '@exodus/wallet/module'
 import walletCompatibilityModesDefinition from '@exodus/wallet-compatibility-modes/module'
 
 import createApplication from '../application'
@@ -30,10 +29,6 @@ const createModuleDependencies = ({ config }) =>
     {
       definition: keychainDefinition,
     },
-    {
-      definition: walletDefinition,
-      writesAtoms: ['lockedAtom'],
-    },
     {
       definition: walletCompatibilityModesDefinition,
     },

package/src/index.js

@@ -22,6 +22,7 @@ import rates from './modules/rates'
 import referrals from './modules/referrals'
 import remoteConfig from './modules/remote-config'
 import topMovers from './modules/top-movers'
+import wallet from './modules/wallet'
 import walletAccounts from './modules/wallet-accounts'
 import attachPlugins from './plugins/attach'
 
@@ -29,6 +30,7 @@ const createExodus = ({ adapters, config, port }) => {
   const ioc = createIOC({ adapters, config })
   const { headless: headlessConfig, topMoversMonitor } = config
 
+  ioc.use(wallet())
   ioc.use(walletAccounts())
   ioc.use(blockchainMetadata())
   ioc.use(remoteConfig())

package/src/modules/ab-testing/index.js

@@ -15,7 +15,7 @@ const abTesting = () => {
       },
       {
         definition: abTestingDefinition,
-        writesAtom: ['abTestingAtom'],
+        writesAtoms: ['abTestingAtom'],
       },
       { definition: abTestingPluginDefinition },
       { definition: abTestingApiDefinition },

package/src/modules/locale/index.js

@@ -1,4 +1,5 @@
-import { createFusionAtomFactory, createStorageAtomFactory } from '@exodus/atoms'
+import { createStorageAtomFactory } from '@exodus/atoms'
+import { fusionAtomFactory } from '@exodus/fusion/atoms'
 
 import localeApiDefinition from './api'
 import localePluginDefinition from './plugin'
@@ -12,7 +13,8 @@ const locale = () => {
           id: 'currencyAtom',
           type: 'atom',
           factory: ({ fusion, config }) =>
-            createFusionAtomFactory({ fusion })({
+            fusionAtomFactory({
+              fusion,
               path: `private.currency`,
               defaultValue: config.defaultValue,
             }),
@@ -39,8 +41,8 @@ const locale = () => {
         ],
         storage: { namespace: 'locale' },
       },
-      { definition: localePluginDefinition },
-      { definition: localeApiDefinition },
+      { definition: localePluginDefinition, writesAtoms: ['languageAtom'] },
+      { definition: localeApiDefinition, writesAtoms: ['languageAtom', 'currencyAtom'] },
     ],
   }
 }

package/src/modules/nfts/index.js

@@ -23,7 +23,7 @@ const nfts = () => {
         definition: { type: 'monitor', ...nftsMonitorDefinition },
         writesAtoms: ['nftsCacheAtom'],
       },
-      { definition: nftsModuleDefinition },
+      { definition: nftsModuleDefinition, writesAtoms: ['nftsCacheAtom', 'nftsConfigAtom'] },
       { definition: nftsPluginDefinition },
       { definition: nftsApiDefinition },
     ],

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

@@ -18,7 +18,10 @@ const personalNotes = () => {
           },
         ],
       },
-      { definition: { type: 'module', ...personalNotesDefinition } },
+      {
+        definition: { type: 'module', ...personalNotesDefinition },
+        writesAtoms: ['personalNotesAtom'],
+      },
       { definition: personalNotesPluginDefinition },
       { definition: personalNotesApiDefinition },
     ],

package/src/modules/wallet/api.js

@@ -0,0 +1,34 @@
+const createWalletApi = ({ wallet, application, passphraseCache }) => {
+  const restoreFromCurrentPhrase = async ({ passphrase } = {}) => {
+    if (!passphrase) passphrase = await passphraseCache.get()
+    const mnemonic = await application.getMnemonic({ passphrase })
+    await application.import({ passphrase, mnemonic })
+  }
+
+  return {
+    wallet: {
+      exists: () => wallet.exists(),
+      start: application.start,
+      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,
+      changeLockTimer: application.changeLockTimer,
+      restoreFromCurrentPhrase,
+      isLocked: () => wallet.isLocked(),
+    },
+  }
+}
+
+export default {
+  id: 'walletApi',
+  type: 'api',
+  factory: createWalletApi,
+  dependencies: ['wallet', 'application', 'passphraseCache'],
+}

package/src/modules/wallet/index.js

@@ -0,0 +1,24 @@
+import walletDefinition from '@exodus/wallet/module'
+
+import walletApi from './api'
+import lockedAtomDefinition from './locked-atom'
+import restoreAtomDefinition from './restore-atom'
+import restorePluginDefinition from './restore-plugin'
+
+const wallet = () => {
+  return {
+    id: 'wallet',
+    definitions: [
+      {
+        definition: { type: 'module', ...walletDefinition },
+        writesAtoms: ['lockedAtom'],
+      },
+      { definition: lockedAtomDefinition },
+      { definition: restoreAtomDefinition },
+      { definition: restorePluginDefinition, writesAtoms: ['restoreAtom'] },
+      { definition: walletApi },
+    ],
+  }
+}
+
+export default wallet

package/src/modules/wallet/locked-atom.js

@@ -0,0 +1,10 @@
+import { createInMemoryAtom } from '@exodus/atoms'
+
+const lockedAtomDefinition = {
+  id: 'lockedAtom',
+  type: 'atom',
+  factory: () => createInMemoryAtom({ defaultValue: true }),
+  dependencies: [],
+}
+
+export default lockedAtomDefinition

package/src/{plugins/restore.js → modules/wallet/restore-plugin.js}

@@ -11,6 +11,7 @@ const restorePlugin = ({ restoreAtom }) => {
 
 export default {
   id: 'restorePlugin',
+  type: 'plugin',
   factory: restorePlugin,
   dependencies: ['restoreAtom'],
 }

package/src/plugins/index.js

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