@exodus/headless 4.0.1 → 5.0.0-rc.0

package/CHANGELOG.md

@@ -3,6 +3,24 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [5.0.0-rc.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@4.0.1...@exodus/headless@5.0.0-rc.0) (2024-04-15)
+
+### ⚠ BREAKING CHANGES
+
+- accept port via adapters (#6362)
+- assets balance fields (#5933)
+
+### Features
+
+- accept port via adapters ([#6362](https://github.com/ExodusMovement/exodus-hydra/issues/6362)) ([8c5619a](https://github.com/ExodusMovement/exodus-hydra/commit/8c5619a11a63a8eda5a193e1cd5242696a480cd2))
+- assets balance fields ([#5933](https://github.com/ExodusMovement/exodus-hydra/issues/5933)) ([000eb65](https://github.com/ExodusMovement/exodus-hydra/commit/000eb653d9424b2a427f087009a2cc0dd5d0b3ea))
+- pass through restartOptions in application.delete ([#6223](https://github.com/ExodusMovement/exodus-hydra/issues/6223)) ([db700d0](https://github.com/ExodusMovement/exodus-hydra/commit/db700d0f19c9437e2a4612df4f5b11eec2e20751))
+- update default wallet account with mode and seed id ([#6091](https://github.com/ExodusMovement/exodus-hydra/issues/6091)) ([311061f](https://github.com/ExodusMovement/exodus-hydra/commit/311061fea6b6fb5bfea6bb8992ae01fa475f50d1))
+
+### Bug Fixes
+
+- kyc test setup ([#6256](https://github.com/ExodusMovement/exodus-hydra/issues/6256)) ([694dd5c](https://github.com/ExodusMovement/exodus-hydra/commit/694dd5cc70f369b56b5b197b405dccfec18baa34))
+
 ## [4.0.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@4.0.0...@exodus/headless@4.0.1) (2024-03-11)
 
 **Note:** Version bump only for package @exodus/headless

package/README.md

@@ -167,13 +167,13 @@ Unsafe (raw text) storage instance. Used internally by modules to persist data i
 
 In most cases you probably want to use encrypted storage instead (not yet migrated).
 
-Check [storage-spec](https://github.com/ExodusMovement/exodus-hydra/tree/master/modules/storage-spec) for more details about Storage API
+Check [storage-spec](https://github.com/ExodusMovement/exodus-hydra/tree/master/adapters/storage-spec/spec.md) for more details about Storage API
 
 ### seedStorage
 
 Storage instance used unquely by wallet module to store seed and autogenerated passphrase (if present).
 
-Check [storage-spec](https://github.com/ExodusMovement/exodus-hydra/tree/master/modules/storage-spec) for more details about Storage API
+Check [storage-spec](https://github.com/ExodusMovement/exodus-hydra/tree/master/adapters/storage-spec/spec.md) for more details about Storage API
 
 > **Note:** Because Browser Extension needs the passphrase to encrypt/decrypt seed, it get's passed as a 3rd parameter to get/set
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/headless",
-  "version": "4.0.1",
+  "version": "5.0.0-rc.0",
   "description": "The platform-agnostic Exodus wallet SDK",
   "author": "Exodus Movement Inc.",
   "main": "src/index.js",
@@ -31,7 +31,7 @@
     "@exodus/assets-feature": "^4.0.1",
     "@exodus/atoms": "^7.0.0",
     "@exodus/available-assets": "^8.0.0",
-    "@exodus/balances": "^12.4.0",
+    "@exodus/balances": "^13.0.0",
     "@exodus/basic-utils": "^2.0.0",
     "@exodus/blockchain-metadata": "^15.0.0",
     "@exodus/dependency-injection": "^2.1.2",
@@ -57,6 +57,7 @@
     "@exodus/sodium-crypto": "^3.2.0",
     "@exodus/startup-counter": "^1.0.0",
     "@exodus/tx-signer": "^2.0.1",
+    "@exodus/typeforce": "^1.18.1",
     "@exodus/wallet": "^14.0.0",
     "@exodus/wallet-accounts": "^16.2.0",
     "bip39": "^2.6.0",
@@ -80,19 +81,20 @@
     "@exodus/ethereum-lib": "^3.3.34",
     "@exodus/ethereum-meta": "^1.0.23",
     "@exodus/exodus-pricing-client": "^1.2.0",
+    "@exodus/fetch-factory": "^1.0.0",
     "@exodus/key-utils": "^3.0.0",
-    "@exodus/kyc": "^4.4.0",
+    "@exodus/kyc": "^5.0.0",
     "@exodus/litecoin-meta": "^1.0.0",
     "@exodus/market-history": "^7.4.0",
     "@exodus/models": "^11.9.0",
-    "@exodus/nfts": "^8.0.4",
+    "@exodus/nfts": "^9.1.1",
     "@exodus/personal-notes": "^3.6.0",
     "@exodus/referrals": "^8.2.0",
-    "@exodus/solana-lib": "^1.3.11",
+    "@exodus/solana-lib": "^2.0.0",
     "@exodus/solana-meta": "^1.0.2",
     "@exodus/storage-encrypted": "^1.2.0",
     "@exodus/storage-memory": "^2.1.1",
-    "@exodus/top-movers-monitor": "^4.0.0",
+    "@exodus/top-movers-monitor": "^4.1.0",
     "@exodus/ui-config": "^3.4.0",
     "@exodus/wild-emitter": "^1.0.0",
     "buffer-json": "^2.0.0",
@@ -103,5 +105,5 @@
     "msw": "^2.0.0",
     "p-defer": "^4.0.0"
   },
-  "gitHead": "0ee446bcb5b68a68583fe7ee70ba5472da3452ab"
+  "gitHead": "cd2d72202cb71d7fff8e340ab54193543bfc53c4"
 }

package/src/application/module/application.js

@@ -1,6 +1,6 @@
 /* eslint-disable unicorn/no-for-loop */
 
-import ExodusModule from '@exodus/module'
+import ExodusModule from '@exodus/module' // eslint-disable-line import/no-deprecated
 import assert from 'minimalistic-assert'
 
 import { LifecycleHook as Hook } from '../constants'
@@ -31,13 +31,14 @@ const passphraseCachePlaceholder = {
 
 class Application extends ExodusModule {
   #hooks = {}
-  #wallet = null
-  #storage = null
-  #lockedAtom = null
-  #backedUpAtom = null
-  #passphraseCache = null
-  #applicationStarted = null
-  #resolveStart = null
+  #wallet
+  #lockedAtom
+  #backedUpAtom
+  #passphraseCache
+  #applicationStarted
+  #resolveStart
+  #flagsStorage
+  #storage
 
   constructor({
     wallet,
@@ -53,14 +54,15 @@ class Application extends ExodusModule {
     this.#lockedAtom = lockedAtom
     this.#backedUpAtom = backedUpAtom
     this.#passphraseCache = passphraseCache
-    this.#storage = unsafeStorage.namespace('flags')
+    this.#flagsStorage = unsafeStorage.namespace('flags')
+    this.#storage = unsafeStorage.namespace('application')
 
     this.#applicationStarted = new Promise((resolve) => (this.#resolveStart = resolve))
     this.setMaxListeners(Number.POSITIVE_INFINITY)
   }
 
   start = async () => {
-    const [deleteFlag, importFlag] = await this.#storage.batchGet([DELETE_FLAG, IMPORT_FLAG])
+    const [deleteFlag, importFlag] = await this.#flagsStorage.batchGet([DELETE_FLAG, IMPORT_FLAG])
 
     const isDeleting = !!deleteFlag
     const isImporting = !!importFlag
@@ -68,7 +70,7 @@ class Application extends ExodusModule {
     if (isDeleting) await this.#wallet.clear()
 
     if (isDeleting || isImporting) {
-      await this.#storage.batchDelete([DELETE_FLAG, IMPORT_FLAG])
+      await this.#flagsStorage.batchDelete([DELETE_FLAG, IMPORT_FLAG])
       await this.#passphraseCache.clear()
     }
 
@@ -78,7 +80,10 @@ class Application extends ExodusModule {
       await this.fire(Hook.Clear, null, { concurrent: true })
     }
 
-    if (isImporting) await this.fire(Hook.Import)
+    if (isImporting) {
+      const params = await this.#storage.get('importParams')
+      await this.fire(Hook.Import, params)
+    }
 
     const [hasPassphraseSet, isLocked, isBackedUp, isRestoring] = await Promise.all([
       this.#wallet.hasPassphraseSet(),
@@ -170,7 +175,7 @@ class Application extends ExodusModule {
     this._logger.log('creating wallet')
 
     await this.#applicationStarted
-    await this.#wallet.create(opts)
+    const seedId = await this.#wallet.create(opts)
 
     const isLocked = await this.#wallet.isLocked()
 
@@ -180,28 +185,31 @@ class Application extends ExodusModule {
       isLocked,
       isRestoring: false,
       walletExists: true,
+      seedId,
     })
   }
 
   import = async (opts) => {
     this._logger.log('importing wallet')
 
-    await this.#storage.set(RESTORE_FLAG, true)
+    await this.#flagsStorage.set(RESTORE_FLAG, true)
 
     await this.#applicationStarted
 
     const walletExists = await this.#wallet.exists()
 
-    const { forceRestart, forgotPassphrase, ...wallet } = opts
+    const { forceRestart, forgotPassphrase, compatibilityMode, ...wallet } = opts
 
-    await this.#wallet.import(wallet)
+    const seedId = await this.#wallet.import(wallet)
+    const importParams = { seedId, compatibilityMode }
 
     if (forceRestart || walletExists) {
-      await this.#storage.set(IMPORT_FLAG, true)
+      await this.#flagsStorage.set(IMPORT_FLAG, true)
 
+      await this.#storage.set('importParams', importParams)
       await this.fire(Hook.Restart, { reason: 'import' })
     } else {
-      await this.fire(Hook.Import)
+      await this.fire(Hook.Import, importParams)
 
       this._logger.log('wallet imported')
     }
@@ -239,7 +247,7 @@ class Application extends ExodusModule {
 
     if (isRestoring) {
       await this.fire(Hook.Restore)
-      await this.#storage.delete(RESTORE_FLAG)
+      await this.#flagsStorage.delete(RESTORE_FLAG)
       await this.fire(Hook.RestoreCompleted)
     }
 
@@ -249,7 +257,7 @@ class Application extends ExodusModule {
   }
 
   restore = async () => {
-    await this.#storage.set(RESTORE_FLAG, true)
+    await this.#flagsStorage.set(RESTORE_FLAG, true)
     await this.#restoreIfNeeded()
   }
 
@@ -304,9 +312,9 @@ class Application extends ExodusModule {
     this._logger.log('passphrase changed')
   }
 
-  delete = async ({ forgotPassphrase } = {}) => {
-    await this.#storage.set(DELETE_FLAG, true)
-    await this.fire(Hook.Restart, { reason: 'delete', forgotPassphrase })
+  delete = async ({ forgotPassphrase, restartOptions } = {}) => {
+    await this.#flagsStorage.set(DELETE_FLAG, true)
+    await this.fire(Hook.Restart, { ...restartOptions, reason: 'delete', forgotPassphrase })
   }
 
   stop = async () => {
@@ -322,7 +330,7 @@ class Application extends ExodusModule {
   }
 
   isRestoring = async () => {
-    return this.#storage.get(RESTORE_FLAG)
+    return this.#flagsStorage.get(RESTORE_FLAG)
   }
 
   // TODO: stop emitting this on hooks?

package/src/index.js

@@ -19,6 +19,7 @@ import remoteConfig from '@exodus/remote-config'
 import restoreProgressTracker from '@exodus/restore-progress-tracker'
 import startupCounter from '@exodus/startup-counter'
 import transactionSigner from '@exodus/tx-signer'
+import typeforce from '@exodus/typeforce'
 import wallet from '@exodus/wallet'
 import walletAccounts from '@exodus/wallet-accounts'
 
@@ -28,7 +29,18 @@ import createDependencies from './dependencies'
 import attachMigrations from './migrations/attach'
 import attachPlugins from './plugins/attach'
 
-const createExodus = ({ adapters, config, port, debug = false }) => {
+const createExodus = (opts) => {
+  typeforce(
+    {
+      adapters: 'Object',
+      config: 'Object',
+      debug: '?Boolean',
+    },
+    opts,
+    true
+  )
+
+  const { adapters, config, debug = false } = opts
   const ioc = createIOC({ adapters, config, debug })
 
   ioc.use(application())
@@ -56,7 +68,6 @@ const createExodus = ({ adapters, config, port, debug = false }) => {
   ioc.use(walletAccounts())
 
   ioc.registerMultiple(createDependencies({ adapters, config }))
-  ioc.register({ definition: { id: 'port', type: 'port', factory: () => port } })
 
   const resolve = () => {
     ioc.resolve()
@@ -67,6 +78,7 @@ const createExodus = ({ adapters, config, port, debug = false }) => {
 
     const { migrations } = ioc.getAll()
 
+    const port = ioc.get('port')
     application.on('start', (payload) => port.emit('start', payload))
 
     application.hook('load', (args) => port.emit('pre-load', args))

package/src/plugins/analytics.js

@@ -1,10 +1,10 @@
 const setBuildMetadataProperties = async ({ analytics, getBuildMetadata }) => {
-  analytics.requireDefaultProperties(['appId', 'osName'])
+  analytics.requireDefaultEventProperties(['appId', 'osName'])
 
   const { appId, osName, deviceModel, platformVersion, deviceManufacturer } =
     await getBuildMetadata()
 
-  analytics.setDefaultProperties({
+  analytics.setDefaultEventProperties({
     appId,
     osName,
     deviceModel,
@@ -17,13 +17,13 @@ const setBuildMetadataProperties = async ({ analytics, getBuildMetadata }) => {
 
 const setSystemPreferencesProperties = async ({ analytics, systemPreferences }) => {
   if (!systemPreferences) return
-  analytics.requireDefaultProperties(['locale'])
+  analytics.requireDefaultEventProperties(['locale'])
   const languages = await systemPreferences.getPreferredLanguages()
-  analytics.setDefaultProperties({ locale: languages })
+  analytics.setDefaultEventProperties({ locale: languages })
 }
 
 const setEnvProperties = async ({ analytics, env }) => {
-  analytics.setDefaultProperties({
+  analytics.setDefaultEventProperties({
     appPlatform: env.platform,
     appVersion: env.version,
     appBuild: env.build === 'development' ? 'dev' : 'prod',