@exodus/assets-feature 3.7.0 → 3.8.0

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.
 
+## [3.8.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/assets-feature@3.7.0...@exodus/assets-feature@3.8.0) (2023-11-21)
+
+### Features
+
+- assets atom ([#4109](https://github.com/ExodusMovement/exodus-hydra/issues/4109)) ([d08880d](https://github.com/ExodusMovement/exodus-hydra/commit/d08880d8fe6f2f596cb01b955787de07f2a0747e))
+
 ## [3.7.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/assets-feature@3.6.0...@exodus/assets-feature@3.7.0) (2023-10-25)
 
 ### Features

package/atoms/assets.js

@@ -0,0 +1,10 @@
+import { createInMemoryAtom } from '@exodus/atoms'
+
+const assetsAtomDefinition = {
+  id: 'assetsAtom',
+  type: 'atom',
+  factory: createInMemoryAtom,
+  dependencies: [],
+}
+
+export default assetsAtomDefinition

package/index.js

@@ -6,6 +6,7 @@ import assetsApiDefinition from './api'
 import assetModuleDefinition from './module'
 import customTokensMonitorDefinition from './monitor'
 import assetPreferencesDefinition from './module/asset-preferences'
+import assetsAtomDefinition from './atoms/assets'
 
 const assets = ({ config = {} } = {}) => {
   return {
@@ -18,6 +19,9 @@ const assets = ({ config = {} } = {}) => {
         storage: { namespace: 'assetPreferences' },
         config: config.multiAddressMode || {},
       },
+      {
+        definition: assetsAtomDefinition,
+      },
       {
         definition: disabledPurposesAtomDefinition,
         storage: { namespace: 'assetPreferences' },
@@ -25,10 +29,11 @@ const assets = ({ config = {} } = {}) => {
       },
       { definition: assetsApiDefinition },
       // TODO: add storage namespace once we remove customTokensStorage
-      // eslint-disable-next-line hydra/missing-storage-namespace
+      // eslint-disable-next-line @exodus/hydra/missing-storage-namespace
       {
         definition: assetModuleDefinition,
         // storage: { namespace: 'customTokens' },
+        writesAtoms: ['assetsAtom'],
         aliases: [{ implementationId: 'customTokensStorage', interfaceId: 'storage' }],
       },
       {

package/module/assets-module.js

@@ -6,8 +6,6 @@ import {
   CT_UPDATEABLE_PROPERTIES,
 } from '@exodus/assets'
 import { mapValues, pick, pickBy } from '@exodus/basic-utils'
-// eslint-disable-next-line no-restricted-imports
-import { fetchival } from '@exodus/fetch'
 import ExodusModule from '@exodus/module'
 // eslint-disable-next-line @exodus/restricted-imports/prefer-basic-utils
 import { get, isEmpty, keyBy, once } from 'lodash'
@@ -20,6 +18,7 @@ import {
   CT_UPDATE_INTERVAL,
 } from './constants'
 import { getAssetFromAssetId, getFetchErrorMessage, isDisabledCustomToken } from './utils'
+import createFetchival from '@exodus/fetch/create-fetchival'
 
 const FILTERED_FIELDS = [
   'assetId',
@@ -86,24 +85,27 @@ export class AssetsModule extends ExodusModule {
   #storageTimestampKey
   #customTokenUpdateInterval
   #fetchCacheExpiry
-  #globalAssetRegistry // temporary
   #isExternalRegistry
+  #assetsAtom
+  #fetchival
 
   constructor({
     storage,
     iconsStorage,
     assetRegistry, // temporary
     assetPlugins,
+    assetsAtom,
     combinedAssetsList = [],
-    globalAssetRegistry, // temporary
     validateCustomToken = () => true,
     config = {},
+    fetch,
   }) {
     super({ name: 'AssetsModule' })
 
+    this.#assetsAtom = assetsAtom
     this.#storage = storage
     this.#isExternalRegistry = !!assetRegistry
-    this.#registry = this.#isExternalRegistry ? assetRegistry : initialAssetRegistry
+    this.#setRegistry(assetRegistry ?? initialAssetRegistry)
     this.#assetPlugins = assetPlugins
     this.#combinedAssetsList = combinedAssetsList
     this.#fetchCache = {}
@@ -116,10 +118,24 @@ export class AssetsModule extends ExodusModule {
     this.#storageTimestampKey = config.storageTimestampKey || CT_TIMESTAMP_KEY
     this.#customTokenUpdateInterval = config.customTokenUpdateInterval || CT_UPDATE_INTERVAL
     this.#fetchCacheExpiry = config.fetchCacheExpiry ?? CT_FETCH_CACHE_EXPIRY
-    this.#globalAssetRegistry = globalAssetRegistry // temporary
+    this.#fetchival = createFetchival({ fetch })
   }
 
-  // Assets Registry API
+  #setRegistry = (registry) => {
+    this.#registry = registry
+
+    if (registry === initialAssetRegistry) {
+      return
+    }
+
+    // we want this to happen asap before load and even before start
+    this.#assetsAtom.set({
+      value: { ...this.#registry.getAssets() },
+      added: [],
+      updated: [],
+      disabled: [],
+    })
+  }
 
   initialize = ({ assetClientInterface }) => {
     assert(
@@ -135,11 +151,11 @@ export class AssetsModule extends ExodusModule {
         console.warn(`Incorrectly referenced supported asset ${name}. Expected ${asset.name}.`)
       })
       .filter(Boolean)
-    this.#registry = createAssetRegistry({
-      supportedAssetsList: [...assetsList, ...this.#combinedAssetsList],
-      globalAssetRegistry: this.#globalAssetRegistry, // temporarily supply the deprecated globalAssetRegistry until @exodus/models v10. Afterwards it can simply be removed.
-    })
-    // this.emit('assets-initialized')
+    this.#setRegistry(
+      createAssetRegistry({
+        supportedAssetsList: [...assetsList, ...this.#combinedAssetsList],
+      })
+    )
   }
 
   getAssets = () => this.#registry.getAssets()
@@ -175,7 +191,7 @@ export class AssetsModule extends ExodusModule {
       // 3. both of the above from a network that has feature flag customTokens === false
       // It is OK to add all of these to the assets registry
       const { added, updated } = this.#handleFetchedTokens(Object.values(tokens))
-      this.#announceChanges({ added, updated })
+      this.#flushChanges({ added, updated })
     } catch (e) {
       this._logger.log('error reading custom tokens from storage:', e)
     }
@@ -223,9 +239,9 @@ export class AssetsModule extends ExodusModule {
 
       if (isAdded) {
         await this.#storeCustomTokens([token])
-        this.#announceChanges({ added: [asset] })
+        this.#flushChanges({ added: [asset] })
       } else {
-        this.#announceChanges({ updated: [asset] })
+        this.#flushChanges({ updated: [asset] })
       }
 
       return asset
@@ -269,7 +285,7 @@ export class AssetsModule extends ExodusModule {
       await this.#storeCustomTokens(fetchedAndHandledTokens)
     }
 
-    this.#announceChanges({ added, updated })
+    this.#flushChanges({ added, updated })
 
     return added.concat(updated)
   }
@@ -299,7 +315,7 @@ export class AssetsModule extends ExodusModule {
       await this.#iconsStorage.storeIcons(fetchedAndHandledTokens)
     }
 
-    this.#announceChanges({ added, updated })
+    this.#flushChanges({ added, updated })
   }
 
   updateTokens = async () => {
@@ -324,10 +340,8 @@ export class AssetsModule extends ExodusModule {
       (token) => _isDisabledCustomToken(token) && !isDisabledCustomToken(this.getAsset(token.name))
     )
     const updatedAssets = tokens.map(this.#registry.updateCustomToken)
-    this.emit('assets-update', updatedAssets)
-    if (disabled.length > 0) {
-      this.emit('assets-disable', disabled)
-    }
+
+    this.#flushChanges({ updated: updatedAssets, disabled })
   }
 
   searchTokens = async ({ baseAssetName, lifecycleStatus, query, excludeTags = ['offensive'] }) => {
@@ -393,17 +407,30 @@ export class AssetsModule extends ExodusModule {
     return item?.value && Date.now() < item.expiry ? item.value : null
   }
 
-  #announceChanges = ({ added = [], updated = [] }) => {
+  #flushChanges = ({ added = [], updated = [], disabled = [] } = {}) => {
+    // TODO: remove these once all consumers are refactored
     if (added.length > 0) this.emit('assets-add', added)
     if (updated.length > 0) this.emit('assets-update', updated)
+    if (disabled.length > 0) this.emit('assets-disable', disabled)
+
+    if (added.length + updated.length + disabled.length === 0) {
+      return
+    }
+
+    this.#assetsAtom.set({
+      value: { ...this.#registry.getAssets() },
+      added,
+      updated,
+      disabled,
+    })
   }
 
   #fetch = async (endpoint, body, resultPath) => {
     try {
       const testDataParam = this.#config.fetchTestValues ? '?test=true' : ''
-      const res = await fetchival(this.#customTokensServerUrl)(`${endpoint}${testDataParam}`).post(
-        body
-      )
+      const res = await this.#fetchival(this.#customTokensServerUrl)(
+        `${endpoint}${testDataParam}`
+      ).post(body)
 
       if (res.status !== 'OK')
         throw new Error(`Custom tokens registry ${endpoint} ${res.status} ${res.message}`)

package/module/index.js

@@ -1,20 +1,20 @@
-// eslint-disable-next-line @exodus/restricted-imports/no-exodus-assets
-import globalAssetRegistry from '@exodus/assets' // this is deprecated, do not use for any other purpose. Remove when we have @exodus/models v10.
 import AssetsModule from './assets-module'
 
-const createAssetsModule = (props) => new AssetsModule({ ...props, globalAssetRegistry })
+const createAssetsModule = (props) => new AssetsModule(props)
 
 const assetsModuleDefinition = {
   id: 'assetsModule',
   type: 'module',
   factory: createAssetsModule,
   dependencies: [
+    'assetsAtom',
     'storage',
     'iconsStorage',
     'assetPlugins',
     'combinedAssetsList?',
     'validateCustomToken?',
     'config',
+    'fetch',
   ],
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/assets-feature",
-  "version": "3.7.0",
+  "version": "3.8.0",
   "license": "UNLICENSED",
   "description": "Assets module, clients and apis",
   "main": "index.js",
@@ -32,7 +32,7 @@
   },
   "dependencies": {
     "@exodus/basic-utils": "^2.1.0",
-    "@exodus/fetch": "^1.2.1",
+    "@exodus/fetch": "^1.3.0",
     "@exodus/timer": "^1.0.0",
     "lodash": "^4.17.21",
     "minimalistic-assert": "^1.0.1",
@@ -41,7 +41,7 @@
   },
   "devDependencies": {
     "@exodus/assets": "^8.0.95",
-    "@exodus/atoms": "^6.0.0",
+    "@exodus/atoms": "^6.0.1",
     "@exodus/available-assets": "^7.0.0",
     "@exodus/bitcoin-meta": "^1.0.1",
     "@exodus/bitcoin-plugin": "^1.0.3",
@@ -49,9 +49,9 @@
     "@exodus/bitcointestnet-plugin": "^1.0.3",
     "@exodus/combined-assets-meta": "^1.2.5",
     "@exodus/cosmos-plugin": "^1.0.0",
-    "@exodus/ethereum-meta": "^1.0.30",
+    "@exodus/ethereum-meta": "^1.1.0",
     "@exodus/models": "^9.1.1",
-    "@exodus/module": "^1.2.0",
+    "@exodus/module": "^1.2.2",
     "@exodus/osmosis-plugin": "^1.0.0",
     "@exodus/redux-dependency-injection": "^3.0.0",
     "@exodus/storage-memory": "^2.1.1",
@@ -60,7 +60,8 @@
     "eslint": "^8.44.0",
     "events": "^3.3.0",
     "jest": "^29.1.2",
+    "msw": "^2.0.0",
     "redux": "^4.0.0"
   },
-  "gitHead": "c083b9655607e20206217c44bd55bd1b68e3c9b4"
+  "gitHead": "4480f8501a837520fd19403ea1cffb1e3d7ac9d8"
 }

package/plugin/index.js

@@ -4,47 +4,60 @@ import { createAtomObserver } from '@exodus/atoms'
 const createAssetsPlugin = ({
   port,
   assetsModule,
+  assetsAtom,
   customTokensMonitor,
   disabledPurposesAtom,
   multiAddressModeAtom,
 }) => {
-  const emitAssetsLoad = () => {
-    const assets = assetsModule.getAssets()
-    port.emit('assets-load', {
+  const emitAssets = async () => {
+    const { value: assets } = await assetsAtom.get()
+    const payload = {
       assets,
       defaultAccountStates: mapValues(
         pickBy(assets, (asset) => asset.api?.hasFeature?.('accountState')),
         (asset) => asset.api.createAccountState().create()
       ),
-    })
-  }
-
-  const listeners = [
-    ['assets-add', (data) => port.emit('assets-add', data)],
-    ['assets-update', (data) => port.emit('assets-update', data)],
-  ]
+    }
 
-  listeners.forEach(([event, callback]) => {
-    assetsModule.on(event, callback)
-  })
+    port.emit('assets', payload)
+    port.emit('assets-load', payload) // legacy to be removed
+  }
 
   const observers = [
     createAtomObserver({ atom: disabledPurposesAtom, port, event: 'disabledPurposes' }),
     createAtomObserver({ atom: multiAddressModeAtom, port, event: 'multiAddressMode' }),
   ]
 
+  const subscribers = []
+
   const onStart = async () => {
+    subscribers.push(
+      assetsAtom.observe(({ added, updated, disabled }) => {
+        if (added.length > 0) {
+          port.emit('assets-add', added)
+        }
+
+        if (updated.length > 0) {
+          port.emit('assets-update', updated)
+        }
+
+        if (disabled.length > 0) {
+          port.emit('assets-disable', disabled)
+        }
+      })
+    )
+
     observers.forEach((observer) => observer.register())
 
     await assetsModule.load()
-    emitAssetsLoad()
+    await emitAssets()
   }
 
   const onLoad = async () => {
     observers.forEach((observer) => observer.start())
 
     await assetsModule.load()
-    emitAssetsLoad()
+    await emitAssets()
   }
 
   const onUnlock = () => {
@@ -56,11 +69,8 @@ const createAssetsPlugin = ({
   }
 
   const onStop = () => {
-    listeners.forEach(([event, callback]) => {
-      assetsModule.removeListener(event, callback)
-    })
-
     observers.forEach((observer) => observer.unregister())
+    subscribers.forEach((unsubscribe) => unsubscribe())
   }
 
   const onClear = async () => {
@@ -77,6 +87,7 @@ const assetsPluginDefinition = {
   dependencies: [
     'port',
     'assetsModule',
+    'assetsAtom',
     'customTokensMonitor',
     'disabledPurposesAtom',
     'multiAddressModeAtom',

package/redux/index.js

@@ -1,7 +1,7 @@
-import { keyBy } from '@exodus/basic-utils'
 import id from './id'
 import initialState from './initial-state'
 import selectorDefinitions from './selectors'
+import { keyBy } from '@exodus/basic-utils'
 
 const mergeAssets = (state, payload) => ({
   ...state,
@@ -16,14 +16,11 @@ const assetsReduxDefinition = {
   type: 'redux-module',
   initialState,
   eventReducers: {
-    'assets-load': (state, { assets }) => ({
-      ...state,
-      error: null,
-      loaded: true,
-      data: assets,
-    }),
     'assets-add': mergeAssets,
     'assets-update': mergeAssets,
+    assets: (state, { assets }) => {
+      return { ...state, error: null, loaded: true, data: assets }
+    },
     multiAddressMode: (state, payload) => ({
       ...state,
       multiAddressMode: payload,