@exodus/assets-feature 2.0.2 → 3.1.0

package/CHANGELOG.md

@@ -3,6 +3,32 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [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
+
+- emit defaultAccountStates from assets-load (#4072)
+
+### Features
+
+- emit defaultAccountStates from assets-load ([#4072](https://github.com/ExodusMovement/exodus-hydra/issues/4072)) ([1b3887a](https://github.com/ExodusMovement/exodus-hydra/commit/1b3887ab0d10c14ee90622121bf2fa6847f53b17))
+
+### Bug Fixes
+
+- update assets module ([#4123](https://github.com/ExodusMovement/exodus-hydra/issues/4123)) ([8f1cd56](https://github.com/ExodusMovement/exodus-hydra/commit/8f1cd56d774336e389cf932944755c4670356dcc))
+
 ## [2.0.2](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/assets-feature@2.0.1...@exodus/assets-feature@2.0.2) (2023-09-14)
 
 ### Bug Fixes

package/client/asset-client-interface.js

@@ -192,6 +192,7 @@ class AssetClientInterface {
   }
 
   signTransaction = async ({ assetName, unsignedTx, walletAccount }) => {
+    // eslint-disable-next-line unicorn/no-await-expression-member
     const accountIndex = (await this.#getWalletAccount(walletAccount)).index
     const baseAssetName = this.assetsModule.getAsset(assetName).baseAsset.name
     return this.wallet.signTransaction({ baseAssetName, unsignedTx, accountIndex })

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

@@ -12,16 +12,44 @@ import ExodusModule from '@exodus/module'
 // eslint-disable-next-line @exodus/restricted-imports/prefer-basic-utils
 import { get, isEmpty, keyBy, once } from 'lodash'
 import assert from 'minimalistic-assert'
-import ms from 'ms'
 
-import { CT_DATA_KEY, CT_TIMESTAMP_KEY, CT_UPDATE_INTERVAL } from './constants'
+import {
+  CT_DATA_KEY,
+  CT_FETCH_CACHE_EXPIRY,
+  CT_TIMESTAMP_KEY,
+  CT_UPDATE_INTERVAL,
+} from './constants'
 import { getAssetFromAssetId, getFetchErrorMessage, isDisabledCustomToken } from './utils'
 
 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
@@ -37,11 +65,14 @@ export class AssetsModule extends ExodusModule {
   #storageDataKey
   #storageTimestampKey
   #customTokenUpdateInterval
+  #fetchCacheExpiry
   #globalAssetRegistry // temporary
+  #isExternalRegistry
 
   constructor({
     storage,
     iconsStorage,
+    assetRegistry, // temporary
     assetPlugins,
     combinedAssetsList,
     globalAssetRegistry, // temporary
@@ -50,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 = {}
@@ -79,12 +94,17 @@ export class AssetsModule extends ExodusModule {
     this.#storageDataKey = config.storageDataKey || CT_DATA_KEY
     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
   }
 
   // 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)
@@ -159,6 +179,7 @@ export class AssetsModule extends ExodusModule {
           'icon', // there is no icon field in built in assets, but there may be for custom tokens (TODO?)
           'isBuiltIn',
           'isCustomToken',
+          'lifecycleStatus',
           'name',
           'primaryColor',
           'properName',
@@ -254,9 +275,11 @@ export class AssetsModule extends ExodusModule {
   addRemoteTokens = async ({ tokenNames }) => {
     const assets = this.getAssets()
     const tokenNamesToFetch = tokenNames.filter((tokenName) => !assets[tokenName])
-    if (tokenNamesToFetch.length === 0) return
 
-    const tokensToAdd = await this.#fetch('tokens', { tokenNames: tokenNamesToFetch }, 'tokens')
+    const tokensToAdd =
+      tokenNamesToFetch.length > 0
+        ? await this.#fetch('tokens', { tokenNames: tokenNamesToFetch }, 'tokens')
+        : []
     const tokensToUpdate = tokenNames
       .map((tokenName) => assets[tokenName])
       .filter((token) => !!token)
@@ -337,8 +360,8 @@ export class AssetsModule extends ExodusModule {
   #getAssetNamesBy = (filter) =>
     Object.keys(this.getAssets()).filter((assetName) => filter(this.getAsset(assetName)))
 
-  #setCache = (key, value, ttl = ms('5m')) => {
-    this.#fetchCache[key] = { value, expiry: Date.now() + ttl }
+  #setCache = (key, value) => {
+    this.#fetchCache[key] = { value, expiry: Date.now() + this.#fetchCacheExpiry }
   }
 
   #getCache = (key) => {

package/module/constants.js

@@ -3,3 +3,4 @@ import ms from 'ms'
 export const CT_DATA_KEY = 'customTokens'
 export const CT_TIMESTAMP_KEY = 'customTokensLastUpdate'
 export const CT_UPDATE_INTERVAL = ms('8h')
+export const CT_FETCH_CACHE_EXPIRY = ms('1h')

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": "2.0.2",
+  "version": "3.1.0",
   "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": "7957536bb53e03341f88ca866bb706e45c4d2003"
+  "gitHead": "c2300eac2bdc89cb16b5976a0de5d14005ad720a"
 }

package/plugin/index.js

@@ -1,7 +1,18 @@
+import { mapValues, pickBy } from '@exodus/basic-utils'
 import { createAtomObserver } from '@exodus/atoms'
 
 const createAssetsPlugin = ({ port, assetsModule, disabledPurposesAtom, multiAddressModeAtom }) => {
-  const emitAssetsLoad = () => port.emit('assets-load', Object.values(assetsModule.getAssets()))
+  const emitAssetsLoad = () => {
+    const assets = assetsModule.getAssets()
+    port.emit('assets-load', {
+      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)],

package/redux/index.js

@@ -16,11 +16,11 @@ const assetsReduxDefinition = {
   type: 'redux-module',
   initialState,
   eventReducers: {
-    'assets-load': (state, payload) => ({
+    'assets-load': (state, { assets }) => ({
       ...state,
       error: null,
       loaded: true,
-      data: keyBy(payload, 'name'),
+      data: assets,
     }),
     'assets-add': mergeAssets,
     'assets-update': mergeAssets,