@exodus/headless 2.0.0-alpha.102 → 2.0.0-alpha.103

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 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.103](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@2.0.0-alpha.102...@exodus/headless@2.0.0-alpha.103) (2023-08-09)
+
+### Features
+
+- **headless:** attach migrations ([#3279](https://github.com/ExodusMovement/exodus-hydra/issues/3279)) ([4f78909](https://github.com/ExodusMovement/exodus-hydra/commit/4f78909223b6517855f12ea31ee5976cdf8a3513))
+
 ## [2.0.0-alpha.102](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/headless@2.0.0-alpha.101...@exodus/headless@2.0.0-alpha.102) (2023-08-09)
 
 ### ⚠ BREAKING CHANGES

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/headless",
-  "version": "2.0.0-alpha.102",
+  "version": "2.0.0-alpha.103",
   "description": "The platform-agnostic Exodus wallet SDK",
   "author": "Exodus Movement Inc.",
   "main": "src/index.js",
@@ -40,6 +40,7 @@
     "@exodus/fee-monitors": "^2.1.0",
     "@exodus/fetch": "^1.2.1",
     "@exodus/geolocation": "^2.1.1",
+    "@exodus/hd-key-slip-10": "^2.0.0",
     "@exodus/key-identifier-provider": "^1.1.3",
     "@exodus/keychain": "^4.1.0",
     "@exodus/locale": "^1.1.0",
@@ -48,6 +49,7 @@
     "@exodus/rates-monitor": "^3.0.0",
     "@exodus/remote-config": "^2.0.0",
     "@exodus/restore-progress-tracker": "^2.0.5",
+    "@exodus/sodium-crypto": "^3.2.0",
     "@exodus/wallet": "^9.0.0",
     "@exodus/wallet-accounts": "^12.0.0",
     "@exodus/wallet-compatibility-modes": "^3.0.0",
@@ -73,7 +75,7 @@
     "@exodus/market-history": "^5.0.1",
     "@exodus/models": "^8.11.1",
     "@exodus/nfts": "^5.0.1",
-    "@exodus/personal-notes": "^3.3.0",
+    "@exodus/personal-notes": "^3.4.0",
     "@exodus/referrals": "^7.0.0",
     "@exodus/solana-lib": "^1.3.11",
     "@exodus/solana-meta": "^1.0.2",
@@ -92,5 +94,5 @@
     "nock": "^13.3.1",
     "p-defer": "^4.0.0"
   },
-  "gitHead": "7cfc44e56bed4304d909659e92522124d92c53a5"
+  "gitHead": "1d20c726b9b3b7997c7d026c53b4cb9a83ec298e"
 }

package/src/index.js

@@ -20,6 +20,7 @@ import createApi from './api'
 import attachAtoms from './atoms/attach'
 import { atomsToAttach } from './constants'
 import createIOC from './ioc'
+import attachMigrations from './migrations/attach'
 import attachPlugins from './plugins/attach'
 
 const createExodus = ({ adapters, config, port }) => {
@@ -51,6 +52,8 @@ const createExodus = ({ adapters, config, port }) => {
 
     const { application, wallet, unlockEncryptedStorage } = ioc.getByType('module')
 
+    const { migrations } = ioc.getAll()
+
     application.on('start', (payload) => port.emit('start', payload))
 
     application.on('load', (args) => port.emit('load', args))
@@ -97,6 +100,14 @@ const createExodus = ({ adapters, config, port }) => {
 
     application.on('restart', (payload) => port.emit('restart', payload))
 
+    attachMigrations({
+      migrations,
+      adapters,
+      application,
+      atoms: ioc.getByType('atom'),
+      modules: ioc.getByType('module'),
+    })
+
     attachAtoms({
       port,
       application,

package/src/migrations/attach.js

@@ -0,0 +1,60 @@
+import { deriveSyncKeys } from '../utils/fusion'
+
+const attachMigrations = ({ migrations = [], application, modules, adapters, ...deps }) => {
+  const { analytics, unlockEncryptedStorage, wallet } = modules
+  const { unsafeStorage, migrateableStorage, fusionKeysDeferred, migrateableFusion } = adapters
+
+  // Override encrypted storage with migrations own instance to make sure no modules reads from it before migrations ran
+  const migrationFlagsStorage = unsafeStorage.namespace('migrations')
+  const migrationAdapters = { ...adapters, storage: migrateableStorage, fusion: migrateableFusion }
+
+  const attachMigration = async (migration) => {
+    const { name, factory } = migration
+    const logger = adapters.createLogger(`exodus:migration:${name}`)
+
+    logger.log('running migration')
+
+    let success = false
+
+    try {
+      const start = performance.now()
+
+      await factory({ ...deps, adapters: migrationAdapters, modules, logger })
+
+      const time = performance.now() - start
+
+      logger.log(`migration successful in ${time.toFixed(2)}ms`)
+
+      await migrationFlagsStorage.set(name, true)
+
+      success = true
+    } catch (error) {
+      logger.log(`migration failed: ${error.stack}`)
+    } finally {
+      analytics.track({
+        event: 'ClientMigrationRun',
+        properties: { migrationId: name, success },
+        force: true,
+      })
+    }
+  }
+
+  application.hook('migrate', async () => {
+    await unlockEncryptedStorage(migrateableStorage)
+    await deriveSyncKeys(wallet.seed).then(fusionKeysDeferred?.resolve)
+
+    const migrationNames = migrations.map((migration) => migration.name)
+    const migrationFlags = await migrationFlagsStorage.batchGet(migrationNames)
+    const migrationsDiff = migrations.filter((v, k) => !migrationFlags[k])
+
+    for (const migration of migrationsDiff) {
+      await attachMigration(migration)
+    }
+  })
+
+  application.hook('clear', async () => {
+    await migrationFlagsStorage.clear()
+  })
+}
+
+export default attachMigrations

package/src/utils/fusion.js

@@ -0,0 +1,17 @@
+import { pick } from '@exodus/basic-utils'
+import HDKeySlip10 from '@exodus/hd-key-slip-10'
+import sodium from '@exodus/sodium-crypto'
+
+const EXODUS_PURPOSE = Number.parseInt(Buffer.from('exo').toString('hex'), '16')
+
+const EXO_2_PATH = `m/${EXODUS_PURPOSE}'/2'`
+
+const BIP43_PURPOSE_SYNC = `${EXO_2_PATH}/0'`
+
+export const deriveSyncKeys = async (seed) => {
+  const derived = HDKeySlip10.fromSeed(seed).derive(BIP43_PURPOSE_SYNC).key
+
+  const keys = await sodium.getSodiumKeysFromSeed(derived)
+
+  return pick(keys, ['box', 'sign', 'secret', 'derived'])
+}