@exodus/assets-feature 3.0.0 → 3.1.1

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.
 
+## [3.1.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/assets-feature@3.1.0...@exodus/assets-feature@3.1.1) (2023-09-20)
+
+### Bug Fixes
+
+- not all assets have api.hasFeature ([#4161](https://github.com/ExodusMovement/exodus-hydra/issues/4161)) ([1b60147](https://github.com/ExodusMovement/exodus-hydra/commit/1b601478423b7d288593809f1046649dd3b265c6))
+
+## [3.1.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/assets-feature@3.0.0...@exodus/assets-feature@3.1.0) (2023-09-20)
+
+### Features
+
+- add custom tokens monitor ([#4150](https://github.com/ExodusMovement/exodus-hydra/issues/4150)) ([f9d8bee](https://github.com/ExodusMovement/exodus-hydra/commit/f9d8bee4b0aecdf8c04bb03b960316ce64e24b91))
+- support external asset registry ([#4138](https://github.com/ExodusMovement/exodus-hydra/issues/4138)) ([3100890](https://github.com/ExodusMovement/exodus-hydra/commit/3100890ed264cf670cad1c76290067f58bf8cd62))
+
+### Bug Fixes
+
+- ensure tokens have display properties ([#4149](https://github.com/ExodusMovement/exodus-hydra/issues/4149)) ([4f39d42](https://github.com/ExodusMovement/exodus-hydra/commit/4f39d42b7446b89638791d1c01af1fe035898b2d))
+- minor custom token bugs ([#13202](https://github.com/ExodusMovement/exodus-hydra/issues/13202)) ([876214a](https://github.com/ExodusMovement/exodus-hydra/commit/876214a8e04e4fb84b729cabd804b4345f03a51d))
+
 ## [3.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/assets-feature@2.0.2...@exodus/assets-feature@3.0.0) (2023-09-19)
 
 ### ⚠ BREAKING CHANGES

package/index.js

@@ -4,6 +4,7 @@ import multiAddressModeAtomDefinition from './atoms/multi-address-mode'
 import disabledPurposesAtomDefinition from './atoms/disabled-purposes'
 import assetsApiDefinition from './api'
 import assetModuleDefinition from './module'
+import customTokensMonitorDefinition from './monitor'
 import assetPreferencesDefinition from './module/asset-preferences'
 
 const assets = ({ config = {} } = {}) => {
@@ -34,6 +35,7 @@ const assets = ({ config = {} } = {}) => {
         definition: assetPreferencesDefinition,
         writesAtoms: ['multiAddressModeAtom', 'disabledPurposesAtom'],
       },
+      { definition: customTokensMonitorDefinition },
     ],
   }
 }

package/module/assets-module.js

@@ -25,7 +25,31 @@ const getFetchCacheKey = (baseAssetName, assetId) => `${assetId}-${baseAssetName
 
 const _isDisabledCustomToken = (token) => token.lifecycleStatus === STATUS.DISABLED
 
-const normalizeToken = (token) => (token.name ? token : { ...token, name: token.assetName })
+const normalizeToken = (token) => ({
+  ...token,
+  name: token.name || token.assetName,
+  displayName: token.displayName || token.properName,
+  displayTicker: token.displayTicker || token.properTicker,
+})
+
+const initialAssetRegistry = {
+  getAsset: (assetName) => {
+    try {
+      throw new Error(`accessing asset ${assetName} too early`)
+    } catch (e) {
+      console.warn(e.message, e.stack)
+    }
+  },
+  getAssets: () => {
+    try {
+      throw new Error(`accessing assets too early`)
+    } catch (e) {
+      console.warn(e.message, e.stack)
+    }
+
+    return {}
+  },
+}
 
 export class AssetsModule extends ExodusModule {
   #registry
@@ -43,10 +67,12 @@ export class AssetsModule extends ExodusModule {
   #customTokenUpdateInterval
   #fetchCacheExpiry
   #globalAssetRegistry // temporary
+  #isExternalRegistry
 
   constructor({
     storage,
     iconsStorage,
+    assetRegistry, // temporary
     assetPlugins,
     combinedAssetsList,
     globalAssetRegistry, // temporary
@@ -55,24 +81,8 @@ export class AssetsModule extends ExodusModule {
   }) {
     super({ name: 'AssetsModule' })
     this.#storage = storage
-    this.#registry = {
-      getAsset: (assetName) => {
-        try {
-          throw new Error(`accessing asset ${assetName} too early`)
-        } catch (e) {
-          console.warn(e.message, e.stack)
-        }
-      },
-      getAssets: () => {
-        try {
-          throw new Error(`accessing assets too early`)
-        } catch (e) {
-          console.warn(e.message, e.stack)
-        }
-
-        return {}
-      },
-    }
+    this.#isExternalRegistry = !!assetRegistry
+    this.#registry = this.#isExternalRegistry ? assetRegistry : initialAssetRegistry
     this.#assetPlugins = assetPlugins
     this.#combinedAssetsList = combinedAssetsList
     this.#fetchCache = {}
@@ -91,6 +101,10 @@ export class AssetsModule extends ExodusModule {
   // Assets Registry API
 
   initialize = ({ assetClientInterface }) => {
+    assert(
+      !this.#isExternalRegistry,
+      'initialize(): cannot initialize when using external registry'
+    )
     // TODO: pass asset specific config to assets module in `config.assetsConfig`
     const { assetsConfig = {} } = this.#config
     const assetsList = Object.entries(this.#assetPlugins)

package/monitor/index.js

@@ -0,0 +1,22 @@
+import { Timer } from '@exodus/timer'
+import ms from 'ms'
+
+const createCustomTokensMonitor = ({ assetsModule, appProcess }) => {
+  const timer = new Timer(ms('1m'))
+
+  timer.callback = async () => {
+    await appProcess?.awaitState('active')
+    assetsModule.updateTokens()
+  }
+
+  return timer
+}
+
+const customTokensMonitorDefinition = {
+  id: 'customTokensMonitor',
+  type: 'monitor',
+  factory: createCustomTokensMonitor,
+  dependencies: ['assetsModule', 'appProcess?'],
+}
+
+export default customTokensMonitorDefinition

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/assets-feature",
-  "version": "3.0.0",
+  "version": "3.1.1",
   "license": "UNLICENSED",
   "description": "Assets module, clients and apis",
   "main": "index.js",
@@ -13,6 +13,7 @@
   "files": [
     "client",
     "module",
+    "monitor",
     "plugin",
     "redux",
     "api",
@@ -32,6 +33,7 @@
   "dependencies": {
     "@exodus/basic-utils": "^2.1.0",
     "@exodus/fetch": "^1.2.1",
+    "@exodus/timer": "^1.0.0",
     "lodash": "^4.17.21",
     "minimalistic-assert": "^1.0.1",
     "ms": "^2.1.3",
@@ -60,5 +62,5 @@
     "jest": "^29.1.2",
     "redux": "^4.0.0"
   },
-  "gitHead": "c69b2cf286e6134084a53e82b81e054c4fd9f38a"
+  "gitHead": "c934b363c277eab13913053034e3e68d15650de9"
 }

package/plugin/index.js

@@ -7,8 +7,8 @@ const createAssetsPlugin = ({ port, assetsModule, disabledPurposesAtom, multiAdd
     port.emit('assets-load', {
       assets,
       defaultAccountStates: mapValues(
-        pickBy(assets, (asset) => asset.api.hasFeature('accountState')),
-        (asset) => asset?.api?.createAccountState?.()?.create?.()
+        pickBy(assets, (asset) => asset.api?.hasFeature?.('accountState')),
+        (asset) => asset.api.createAccountState().create()
       ),
     })
   }