@exodus/headless 2.3.0 → 3.0.0

package/CHANGELOG.md

@@ -3,6 +3,27 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [3.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@2.4.0...@exodus/headless@3.0.0) (2024-01-25)
+
+### ⚠ BREAKING CHANGES
+
+- make wallet application agnostic (#5469)
+
+### Features
+
+- make wallet application agnostic ([#5469](https://github.com/ExodusMovement/exodus-hydra/issues/5469)) ([5edce20](https://github.com/ExodusMovement/exodus-hydra/commit/5edce206e12d35a6acdccd597bc52352772ed9c3))
+
+## [2.4.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@2.3.0...@exodus/headless@2.4.0) (2024-01-24)
+
+### Features
+
+- **headless:** build analytics default properties ([#5441](https://github.com/ExodusMovement/exodus-hydra/issues/5441)) ([66efbb2](https://github.com/ExodusMovement/exodus-hydra/commit/66efbb225eda2826ee5cbed169b009501bcdc639))
+
+### Bug Fixes
+
+- **headless:** bump @exodus/geolocation major version ([#5500](https://github.com/ExodusMovement/exodus-hydra/issues/5500)) ([27ea226](https://github.com/ExodusMovement/exodus-hydra/commit/27ea22654721f628e9995a16e60d5c946173c0e0))
+- **headless:** do not return debug namespace when not in debug mode ([#5463](https://github.com/ExodusMovement/exodus-hydra/issues/5463)) ([91c7481](https://github.com/ExodusMovement/exodus-hydra/commit/91c7481ea97ae775f44630956f47aace743d132d))
+
 ## [2.3.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@2.2.2...@exodus/headless@2.3.0) (2024-01-15)
 
 ### Features

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/headless",
-  "version": "2.3.0",
+  "version": "3.0.0",
   "description": "The platform-agnostic Exodus wallet SDK",
   "author": "Exodus Movement Inc.",
   "main": "src/index.js",
@@ -26,7 +26,7 @@
     "test": "NODE_OPTIONS=--max-old-space-size=4096 jest"
   },
   "dependencies": {
-    "@exodus/address-provider": "^9.0.1",
+    "@exodus/address-provider": "^9.2.0",
     "@exodus/assets-feature": "^4.0.1",
     "@exodus/atoms": "^7.0.0",
     "@exodus/available-assets": "^8.0.0",
@@ -40,7 +40,8 @@
     "@exodus/fee-data-monitors": "^3.0.0",
     "@exodus/fetch": "^1.2.1",
     "@exodus/filesystem": "^1.1.0",
-    "@exodus/geolocation": "^3.1.0",
+    "@exodus/fusion-atoms": "^1.1.2",
+    "@exodus/geolocation": "^4.0.0",
     "@exodus/hd-key-slip-10": "^2.0.0",
     "@exodus/key-identifier-provider": "^1.4.0",
     "@exodus/keychain": "^4.3.0",
@@ -54,7 +55,7 @@
     "@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": "^11.0.0",
     "@exodus/wallet-accounts": "^15.0.0",
     "@exodus/wallet-compatibility-modes": "^3.2.0",
     "bip39": "^2.6.0",
@@ -66,7 +67,7 @@
     "@exodus/ab-testing": "^7.3.0",
     "@exodus/algorand-lib": "^2.0.1",
     "@exodus/algorand-meta": "^1.1.4",
-    "@exodus/analytics": "^11.0.0",
+    "@exodus/analytics": "^12.0.0",
     "@exodus/apy-rates": "^3.3.1",
     "@exodus/assets-feature": "workspace:^",
     "@exodus/bitcoin-plugin": "^1.0.14",
@@ -81,7 +82,7 @@
     "@exodus/litecoin-meta": "^1.0.0",
     "@exodus/market-history": "^7.3.1",
     "@exodus/models": "^10.1.0",
-    "@exodus/nfts": "^7.11.0",
+    "@exodus/nfts": "^8.0.0",
     "@exodus/personal-notes": "^3.6.0",
     "@exodus/referrals": "^8.1.2",
     "@exodus/solana-lib": "^1.3.11",
@@ -101,5 +102,5 @@
     "msw": "^2.0.0",
     "p-defer": "^4.0.0"
   },
-  "gitHead": "035a21e35481a7819a24348a5eb97f4c71b37d0b"
+  "gitHead": "5052dcafa0b903350e25ed7df175a6d65ce37afe"
 }

package/src/api/index.js

@@ -40,14 +40,19 @@ const createApi = ({ ioc, port, config, debug }) => {
 
   const reportingApi = createReporting({ ioc, config })
 
-  return {
+  const api = {
     ...featureApis,
-    debug: debugApi,
     reporting: reportingApi,
     isMnemonicValid,
     subscribe: port.subscribe.bind(port),
     unsubscribe: port.unsubscribe.bind(port),
   }
+
+  if (debugApi) {
+    api.debug = debugApi
+  }
+
+  return api
 }
 
 export default createApi

package/src/application/atoms/backed-up.js

@@ -0,0 +1,9 @@
+import { createStorageAtomFactory } from '@exodus/atoms'
+
+const createBackedUpAtom = ({ storage }) => {
+  const atomFactory = createStorageAtomFactory({ storage })
+
+  return atomFactory({ key: 'backedUp', defaultValue: false, isSoleWriter: true })
+}
+
+export default createBackedUpAtom

package/src/application/atoms/created-at.js

@@ -0,0 +1,4 @@
+import { createFusionAtom } from '@exodus/fusion-atoms'
+
+export const createWalletCreatedAtAtom = ({ fusion, logger }) =>
+  createFusionAtom({ fusion, logger, path: 'createdAt', defaultValue: new Date().toISOString() })

package/src/application/atoms/index.js

@@ -0,0 +1,40 @@
+import createBackedUpAtom from './backed-up'
+import { createWalletCreatedAtAtom } from './created-at'
+import createLockHistoryAtom from './lock-history'
+import createdLockedAtom from './locked'
+import createRestoreAtom from './restore'
+
+export const lockedAtomDefinition = {
+  id: 'lockedAtom',
+  type: 'atom',
+  factory: createdLockedAtom,
+  dependencies: [],
+}
+
+export const lockHistoryAtomDefinition = {
+  id: 'lockHistoryAtom',
+  type: 'atom',
+  factory: createLockHistoryAtom,
+  dependencies: ['lockedAtom', 'config?'],
+}
+
+export const restoreAtomDefinition = {
+  id: 'restoreAtom',
+  type: 'atom',
+  factory: createRestoreAtom,
+  dependencies: [],
+}
+
+export const backedUpAtomDefinition = {
+  id: 'backedUpAtom',
+  type: 'atom',
+  factory: createBackedUpAtom,
+  dependencies: ['storage'],
+}
+
+export const walletCreatedAtAtomDefinition = {
+  id: 'walletCreatedAtAtom',
+  type: 'atom',
+  factory: createWalletCreatedAtAtom,
+  dependencies: ['fusion', 'logger'],
+}

package/src/application/atoms/lock-history.js

@@ -0,0 +1,15 @@
+import { createInMemoryAtom, difference } from '@exodus/atoms'
+
+const createLockHistoryAtom = ({ lockedAtom, config: { maxEntries = 10 } = {} }) => {
+  const lockHistory = createInMemoryAtom({ defaultValue: [] })
+
+  difference(lockedAtom).observe(async ({ current: locked, previous: previouslyLocked }) => {
+    await lockHistory.set((current) =>
+      [{ locked, timestamp: new Date() }, ...current].slice(0, maxEntries)
+    )
+  })
+
+  return lockHistory
+}
+
+export default createLockHistoryAtom

package/src/application/atoms/locked.js

@@ -0,0 +1,5 @@
+import { createInMemoryAtom } from '@exodus/atoms'
+
+const createLockedAtom = () => createInMemoryAtom({ defaultValue: true })
+
+export default createLockedAtom

package/src/application/atoms/restore.js

@@ -0,0 +1,5 @@
+import { createInMemoryAtom } from '@exodus/atoms'
+
+const createRestoreAtom = () => createInMemoryAtom() // eslint-disable-line @exodus/hydra/in-memory-atom-default-value
+
+export default createRestoreAtom

package/src/application/index.js

@@ -0,0 +1,30 @@
+import {
+  backedUpAtomDefinition,
+  lockedAtomDefinition,
+  lockHistoryAtomDefinition,
+  restoreAtomDefinition,
+  walletCreatedAtAtomDefinition,
+} from './atoms'
+import applicationDefinition from './module'
+import applicationLifecyclePluginDefinition from './plugins/lifecycle'
+
+const application = () => {
+  return {
+    id: 'application',
+    definitions: [
+      { definition: applicationDefinition },
+      { definition: lockedAtomDefinition },
+      { definition: restoreAtomDefinition },
+      { definition: lockHistoryAtomDefinition },
+      { definition: walletCreatedAtAtomDefinition },
+      { definition: applicationLifecyclePluginDefinition },
+      {
+        definition: backedUpAtomDefinition,
+        storage: { namespace: 'wallet' },
+        aliases: [{ interfaceId: 'storage', implementationId: 'unsafeStorage' }],
+      },
+    ],
+  }
+}
+
+export default application

package/src/{application.js → application/module/application.js}

@@ -3,7 +3,7 @@
 import ExodusModule from '@exodus/module'
 import assert from 'minimalistic-assert'
 
-import { LifecycleHook as Hook } from './constants'
+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
 
@@ -33,14 +33,22 @@ class Application extends ExodusModule {
   #hooks = {}
   #wallet = null
   #storage = null
+  #backedUpAtom = null
   #passphraseCache = null
   #applicationStarted = null
   #resolveStart = null
 
-  constructor({ wallet, unsafeStorage, passphraseCache = passphraseCachePlaceholder, logger }) {
+  constructor({
+    wallet,
+    unsafeStorage,
+    backedUpAtom,
+    passphraseCache = passphraseCachePlaceholder,
+    logger,
+  }) {
     super({ name: 'Application', logger })
 
     this.#wallet = wallet
+    this.#backedUpAtom = backedUpAtom
     this.#passphraseCache = passphraseCache
     this.#storage = unsafeStorage.namespace('flags')
 
@@ -72,7 +80,7 @@ class Application extends ExodusModule {
     const [hasPassphraseSet, isLocked, isBackedUp, isRestoring] = await Promise.all([
       this.#wallet.hasPassphraseSet(),
       this.#wallet.isLocked(),
-      this.#wallet.isBackedUp(),
+      this.isBackedUp(),
       this.isRestoring(),
     ])
 
@@ -99,7 +107,7 @@ class Application extends ExodusModule {
       this.#wallet.exists(),
       this.#wallet.hasPassphraseSet(),
       this.#wallet.isLocked(),
-      this.#wallet.isBackedUp(),
+      this.isBackedUp(),
       this.isRestoring(),
     ])
 
@@ -200,7 +208,6 @@ class Application extends ExodusModule {
   getMnemonic = async (opts) => this.#wallet.getMnemonic(opts)
 
   setBackedUp = async () => {
-    await this.#wallet.setBackedUp()
     await this.fire(Hook.Backup)
   }
 
@@ -301,6 +308,11 @@ class Application extends ExodusModule {
   isRestoring = async () => {
     return this.#storage.get(RESTORE_FLAG)
   }
+
+  // TODO: stop emitting this on hooks?
+  isBackedUp = async () => {
+    return this.#backedUpAtom.get()
+  }
 }
 
 const createApplication = (args = {}) => new Application({ ...args })

package/src/application/module/index.js

@@ -0,0 +1,10 @@
+import createApplication from './application'
+
+const applicationDefinition = {
+  id: 'application',
+  type: 'module',
+  factory: createApplication,
+  dependencies: ['unsafeStorage', 'backedUpAtom', 'passphraseCache?', 'wallet', 'logger'],
+}
+
+export default applicationDefinition

package/src/application/plugins/index.js

@@ -0,0 +1 @@
+export { default as lifecyclePluginDefinition } from './lifecycle'

package/src/application/plugins/lifecycle.js

@@ -0,0 +1,63 @@
+import { createAtomObserver } from '@exodus/atoms'
+
+const applicationLifecyclePlugin = ({
+  port,
+  lockedAtom,
+  lockHistoryAtom,
+  restoreAtom,
+  backedUpAtom,
+}) => {
+  const observers = [
+    createAtomObserver({ port, atom: lockedAtom, event: 'locked' }),
+    createAtomObserver({ port, atom: lockHistoryAtom, event: 'lockHistory' }),
+    createAtomObserver({ port, atom: restoreAtom, event: 'restore' }),
+    createAtomObserver({ port, atom: backedUpAtom, event: 'backedUp' }),
+  ]
+
+  const onStart = ({ isRestoring }) => {
+    restoreAtom.set(isRestoring)
+  }
+
+  const onLoad = async () => {
+    observers.forEach((observer) => observer.start())
+  }
+
+  const onImport = () => {
+    restoreAtom.set(true)
+  }
+
+  const onAssetsSynced = async () => {
+    await restoreAtom.set(false)
+  }
+
+  const onLock = async () => {
+    await lockedAtom.set(true)
+  }
+
+  const onUnlock = async () => {
+    await lockedAtom.set(false)
+  }
+
+  const onBackup = async () => {
+    await backedUpAtom.set(true)
+  }
+
+  const onStop = () => {
+    observers.forEach((observer) => observer.unregister())
+  }
+
+  const onClear = async () => {
+    await backedUpAtom.set(undefined)
+  }
+
+  return { onStart, onLoad, onImport, onAssetsSynced, onLock, onUnlock, onBackup, onStop, onClear }
+}
+
+const applicationLifecyclePluginDefinition = {
+  id: 'applicationLifecyclePlugin',
+  type: 'plugin',
+  factory: applicationLifecyclePlugin,
+  dependencies: ['port', 'lockedAtom', 'lockHistoryAtom', 'restoreAtom', 'backedUpAtom'],
+}
+
+export default applicationLifecyclePluginDefinition

package/src/dependencies/modules.js

@@ -1,19 +1,11 @@
 import createKeyIdentifierProvider from '@exodus/key-identifier-provider'
 import walletCompatibilityModesDefinition from '@exodus/wallet-compatibility-modes/module'
 
-import createApplication from '../application'
 import unlockEncryptedStorageDefinition from '../unlock-encrypted-storage'
 import { withType } from './utils'
 
 const createModuleDependencies = ({ config }) =>
   [
-    {
-      definition: {
-        id: 'application',
-        factory: createApplication,
-        dependencies: ['unsafeStorage', 'passphraseCache?', 'wallet', 'logger'],
-      },
-    },
     {
       definition: {
         id: 'keyIdentifierProvider',

package/src/index.js

@@ -21,6 +21,7 @@ import wallet from '@exodus/wallet'
 import walletAccounts from '@exodus/wallet-accounts'
 
 import createApi from './api'
+import application from './application'
 import createIOC from './ioc'
 import attachMigrations from './migrations/attach'
 import attachPlugins from './plugins/attach'
@@ -28,6 +29,7 @@ import attachPlugins from './plugins/attach'
 const createExodus = ({ adapters, config, port, debug = false }) => {
   const ioc = createIOC({ adapters, config, debug })
 
+  ioc.use(application())
   ioc.use(addressProvider({ config: config.addressProvider, debug }))
   ioc.use(assetsFeature())
   ioc.use(availableAssets())

package/src/plugins/analytics.js

@@ -1,9 +1,17 @@
 const setBuildMetadataProperties = async ({ analytics, getBuildMetadata }) => {
   analytics.requireDefaultProperties(['appId', 'osName'])
 
-  const { appId, osName, deviceModel } = await getBuildMetadata()
+  const { appId, osName, deviceModel, platformVersion, deviceManufacturer } =
+    await getBuildMetadata()
+
+  analytics.setDefaultProperties({
+    appId,
+    osName,
+    deviceModel,
+    deviceManufacturer,
+    osVersion: platformVersion,
+  })
 
-  analytics.setDefaultProperties({ appId, osName, deviceModel })
   analytics.setDefaultPropertiesForSanitizationErrors({ osName })
 }
 

package/src/plugins/attach.js

@@ -1,4 +1,4 @@
-import { LifecycleHook } from '../constants'
+import { LifecycleHook } from '../application/constants'
 
 const LIFECYCLE_METHOD_TO_HOOK_NAME = Object.fromEntries(
   Object.entries(LifecycleHook).map(([pascalCaseName, hookName]) => [