@exodus/assets-feature 3.8.0 → 4.0.0

package/CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/assets-feature@3.8.0...@exodus/assets-feature@4.0.0) (2023-11-23)
+
+### ⚠ BREAKING CHANGES
+
+- remove legacy asset events (#4826)
+
+### Features
+
+- remove legacy asset events ([#4826](https://github.com/ExodusMovement/exodus-hydra/issues/4826)) ([6f27e5f](https://github.com/ExodusMovement/exodus-hydra/commit/6f27e5fa2294cb82db2651069eba4964b37f8e5e))
+
 ## [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

package/module/assets-module.js

@@ -6,7 +6,6 @@ import {
   CT_UPDATEABLE_PROPERTIES,
 } from '@exodus/assets'
 import { mapValues, pick, pickBy } from '@exodus/basic-utils'
-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'
@@ -70,7 +69,7 @@ const initialAssetRegistry = {
   },
 }
 
-export class AssetsModule extends ExodusModule {
+export class AssetsModule {
   #registry
   #storage
   #fetchCache
@@ -88,6 +87,7 @@ export class AssetsModule extends ExodusModule {
   #isExternalRegistry
   #assetsAtom
   #fetchival
+  #logger
 
   constructor({
     storage,
@@ -99,9 +99,8 @@ export class AssetsModule extends ExodusModule {
     validateCustomToken = () => true,
     config = {},
     fetch,
+    logger,
   }) {
-    super({ name: 'AssetsModule' })
-
     this.#assetsAtom = assetsAtom
     this.#storage = storage
     this.#isExternalRegistry = !!assetRegistry
@@ -119,6 +118,7 @@ export class AssetsModule extends ExodusModule {
     this.#customTokenUpdateInterval = config.customTokenUpdateInterval || CT_UPDATE_INTERVAL
     this.#fetchCacheExpiry = config.fetchCacheExpiry ?? CT_FETCH_CACHE_EXPIRY
     this.#fetchival = createFetchival({ fetch })
+    this.#logger = logger
   }
 
   #setRegistry = (registry) => {
@@ -176,8 +176,6 @@ export class AssetsModule extends ExodusModule {
   getBaseAssetNames = () => this.#getAssetNamesBy((asset) => asset.baseAsset.name === asset.name)
 
   load = once(async () => {
-    this.emit('assets-load', { importedTokens: {} })
-
     try {
       const storedTokens = await this.#readCustomTokens()
       const tokens = pickBy(storedTokens, ({ baseAssetName }) => {
@@ -193,7 +191,7 @@ export class AssetsModule extends ExodusModule {
       const { added, updated } = this.#handleFetchedTokens(Object.values(tokens))
       this.#flushChanges({ added, updated })
     } catch (e) {
-      this._logger.log('error reading custom tokens from storage:', e)
+      this.#logger.log('error reading custom tokens from storage:', e)
     }
   })
 
@@ -214,7 +212,7 @@ export class AssetsModule extends ExodusModule {
 
     const _token = await this.#fetch(`networks/${baseAssetName}`, { assetId }, 'token')
     if (!this.#validateCustomToken(_token)) {
-      this._logger.warn('Invalid Custom Token schema')
+      this.#logger.warn('Invalid Custom Token schema')
       throw new Error('Token did not pass validation')
     }
 
@@ -223,7 +221,7 @@ export class AssetsModule extends ExodusModule {
     try {
       await this.#iconsStorage.storeIcons([token])
     } catch (err) {
-      this._logger.warn(`An error occurred while decoding icon for ${assetId}`, err.message)
+      this.#logger.warn(`An error occurred while decoding icon for ${assetId}`, err.message)
     }
 
     this.#setCache(key, token)
@@ -246,7 +244,7 @@ export class AssetsModule extends ExodusModule {
 
       return asset
     } catch (err) {
-      this._logger.warn(`Add custom token ${assetId} error on ${baseAssetName}`, err.message)
+      this.#logger.warn(`Add custom token ${assetId} error on ${baseAssetName}`, err.message)
       throw err
     }
   }
@@ -263,7 +261,7 @@ export class AssetsModule extends ExodusModule {
         try {
           return await this.fetchToken(assetId, baseAssetName)
         } catch (err) {
-          this._logger.warn('fetch custom tokens error:', err.message)
+          this.#logger.warn('fetch custom tokens error:', err.message)
         }
       })
     )
@@ -306,7 +304,7 @@ export class AssetsModule extends ExodusModule {
     if (isEmpty(tokens)) return
 
     const validTokens = tokensToAdd.filter(this.#validateCustomToken).map(normalizeToken)
-    if (validTokens.length !== tokensToAdd.length) this._logger.warn('Invalid Custom Token schema')
+    if (validTokens.length !== tokensToAdd.length) this.#logger.warn('Invalid Custom Token schema')
 
     const { fetchedAndHandledTokens, added, updated } = this.#handleFetchedTokens(validTokens)
 
@@ -368,7 +366,7 @@ export class AssetsModule extends ExodusModule {
     )
     const validTokens = tokens.filter(this.#validateCustomToken)
 
-    if (validTokens.length !== tokens.length) this._logger.warn('Invalid Custom Token schema')
+    if (validTokens.length !== tokens.length) this.#logger.warn('Invalid Custom Token schema')
 
     return validTokens.map((token) => {
       const asset = this.#getAssetFromAssetId(token.assetId, token.baseAssetName)
@@ -385,7 +383,7 @@ export class AssetsModule extends ExodusModule {
     const updatedTokens = await this.#fetch('updates', assetVersions, 'tokens')
     const validatedTokens = updatedTokens.filter(this.#validateCustomToken).map(normalizeToken)
     if (validatedTokens.length !== updatedTokens.length) {
-      this._logger.warn('Invalid Custom Token schema')
+      this.#logger.warn('Invalid Custom Token schema')
     }
 
     await this.#iconsStorage.storeIcons(validatedTokens)
@@ -408,11 +406,6 @@ export class AssetsModule extends ExodusModule {
   }
 
   #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
     }
@@ -446,7 +439,7 @@ export class AssetsModule extends ExodusModule {
     if (asset) return { asset, isAdded: false }
 
     const { name } = this.#registry.addCustomToken(token) // add to `#/assets`
-    this._logger.log('Custom token added:', name)
+    this.#logger.log('Custom token added:', name)
     return { asset: this.getAsset(name), isAdded: true }
   }
 
@@ -464,7 +457,7 @@ export class AssetsModule extends ExodusModule {
           updated.push(asset)
         }
       } catch (err) {
-        this._logger.warn('Handle fetched custom tokens error:', err.message)
+        this.#logger.warn('Handle fetched custom tokens error:', err.message)
       }
     }
 
@@ -475,7 +468,7 @@ export class AssetsModule extends ExodusModule {
     const baseAsset = this.getAsset(baseAssetName)
     if (!baseAsset.api.hasFeature('customTokens')) {
       const reason = `BUG: network ${baseAsset.name} does not support custom tokens.`
-      this._logger.warn(reason)
+      this.#logger.warn(reason)
       throw new Error(reason)
     }
   }

package/module/index.js

@@ -15,6 +15,8 @@ const assetsModuleDefinition = {
     'validateCustomToken?',
     'config',
     'fetch',
+    'logger',
+    'assetRegistry?', // temporary
   ],
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/assets-feature",
-  "version": "3.8.0",
+  "version": "4.0.0",
   "license": "UNLICENSED",
   "description": "Assets module, clients and apis",
   "main": "index.js",
@@ -42,7 +42,7 @@
   "devDependencies": {
     "@exodus/assets": "^8.0.95",
     "@exodus/atoms": "^6.0.1",
-    "@exodus/available-assets": "^7.0.0",
+    "@exodus/available-assets": "^8.0.0",
     "@exodus/bitcoin-meta": "^1.0.1",
     "@exodus/bitcoin-plugin": "^1.0.3",
     "@exodus/bitcoinregtest-plugin": "^1.0.3",
@@ -63,5 +63,5 @@
     "msw": "^2.0.0",
     "redux": "^4.0.0"
   },
-  "gitHead": "4480f8501a837520fd19403ea1cffb1e3d7ac9d8"
+  "gitHead": "6fe52cd3aa2ffc3fa76d2334228a0dcd02dc9e2e"
 }

package/plugin/index.js

@@ -20,7 +20,6 @@ const createAssetsPlugin = ({
     }
 
     port.emit('assets', payload)
-    port.emit('assets-load', payload) // legacy to be removed
   }
 
   const observers = [