@exodus/available-assets 6.0.0 → 8.0.0

package/CHANGELOG.md

@@ -3,6 +3,34 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/available-assets@7.0.0...@exodus/available-assets@8.0.0) (2023-11-22)
+
+### ⚠ BREAKING CHANGES
+
+- use `assetsAtom` instead of legacy events (#4837)
+
+### Features
+
+- prepare `eslint-plugin-hydra` for publishing ([#4671](https://github.com/ExodusMovement/exodus-hydra/issues/4671)) ([9a01c10](https://github.com/ExodusMovement/exodus-hydra/commit/9a01c10757f3f5d7add361f31cf798e5c207044d))
+
+### Bug Fixes
+
+- cleanup subscriptions on stop ([#4591](https://github.com/ExodusMovement/exodus-hydra/issues/4591)) ([23c9e6b](https://github.com/ExodusMovement/exodus-hydra/commit/23c9e6b4a89a63754cfd4a01345e02758bf03794))
+
+### Code Refactoring
+
+- use `assetsAtom` instead of legacy events ([#4837](https://github.com/ExodusMovement/exodus-hydra/issues/4837)) ([ae083c2](https://github.com/ExodusMovement/exodus-hydra/commit/ae083c2588b996f053f54ba49c48883ae6314cc6))
+
+## [7.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/available-assets@6.0.0...@exodus/available-assets@7.0.0) (2023-10-13)
+
+### ⚠ BREAKING CHANGES
+
+- add reason to available assets (#4398)
+
+### Features
+
+- add reason to available assets ([#4398](https://github.com/ExodusMovement/exodus-hydra/issues/4398)) ([cdcc028](https://github.com/ExodusMovement/exodus-hydra/commit/cdcc0283fb49a1b1f282fde6330c4b479378a156))
+
 ## [6.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/available-assets@5.2.0...@exodus/available-assets@6.0.0) (2023-09-27)
 
 ### ⚠ BREAKING CHANGES

package/atoms/available-asset-names.js

@@ -1,6 +1,9 @@
-import { createInMemoryAtom } from '@exodus/atoms'
+import { compute } from '@exodus/atoms'
 
-const createAvailableAssetNamesAtom = ({ config: { defaultAvailableAssetNames } }) =>
-  createInMemoryAtom({ defaultValue: defaultAvailableAssetNames })
+const createAvailableAssetNamesAtom = ({ availableAssetsAtom }) =>
+  compute({
+    atom: availableAssetsAtom,
+    selector: (availableAssets) => availableAssets.map((a) => a.assetName),
+  })
 
 export default createAvailableAssetNamesAtom

package/atoms/available-assets.js

@@ -0,0 +1,8 @@
+import { createInMemoryAtom } from '@exodus/atoms'
+
+const createAvailableAssetAtom = ({ config: { defaultAvailableAssetNames } }) =>
+  createInMemoryAtom({
+    defaultValue: defaultAvailableAssetNames.map((assetName) => ({ assetName, reason: 'default' })),
+  })
+
+export default createAvailableAssetAtom

package/atoms/index.js

@@ -1,10 +1,18 @@
 import createAvailableAssetNamesWithoutParentCombinedAtom from './available-asset-names-without-parent-combined'
 import createAvailableAssetNamesAtom from './available-asset-names'
+import createAvailableAssetAtom from './available-assets'
 
 export const availableAssetNamesAtomDefinition = {
   id: 'availableAssetNamesAtom',
   type: 'atom',
   factory: createAvailableAssetNamesAtom,
+  dependencies: ['availableAssetsAtom'],
+}
+
+export const availableAssetsAtomDefinition = {
+  id: 'availableAssetsAtom',
+  type: 'atom',
+  factory: createAvailableAssetAtom,
   dependencies: ['config'],
 }
 

package/index.js

@@ -1,6 +1,7 @@
 import {
   availableAssetNamesAtomDefinition,
   availableAssetNamesWithoutParentCombinedAtomDefinition,
+  availableAssetsAtomDefinition,
 } from './atoms'
 import availableAssetsModuleDefinition from './module'
 import availableAssetsApiDefinition from './api'
@@ -11,8 +12,9 @@ const availableAssets = () => ({
   definitions: [
     {
       definition: availableAssetsModuleDefinition,
-      writesAtoms: ['availableAssetNamesAtom'],
+      writesAtoms: ['availableAssetsAtom'],
     },
+    { definition: availableAssetsAtomDefinition },
     { definition: availableAssetNamesAtomDefinition },
     { definition: availableAssetNamesWithoutParentCombinedAtomDefinition },
     { definition: availableAssetsApiDefinition },

package/module/index.js

@@ -1,63 +1,94 @@
 import ExodusModule from '@exodus/module'
-import { difference } from '@exodus/basic-utils'
 import restrictConcurrency from 'make-concurrent'
 
 const MODULE_ID = 'availableAssets'
 
 class AvailableAssets extends ExodusModule {
   #assetsModule
-  #availableAssetNamesAtom
-  #availableAssetNamesSet
-  constructor({ assetsModule, availableAssetNamesAtom, enabledAndDisabledAssetsAtom, logger }) {
+  #availableAssetsAtom
+  #enabledAndDisabledAssetsAtom
+  #assetsAtom
+  #subscriptions = []
+
+  constructor({
+    assetsModule,
+    assetsAtom,
+    availableAssetsAtom,
+    enabledAndDisabledAssetsAtom,
+    logger,
+  }) {
     super({ name: MODULE_ID, logger })
 
     this.#assetsModule = assetsModule
-    this.#availableAssetNamesAtom = availableAssetNamesAtom
+    this.#assetsAtom = assetsAtom
+    this.#availableAssetsAtom = availableAssetsAtom
+    this.#enabledAndDisabledAssetsAtom = enabledAndDisabledAssetsAtom
+  }
 
-    assetsModule.once('assets-load', ({ importedTokens }) => {
-      const toMakeAvailable = Object.keys(importedTokens)
-      if (toMakeAvailable.length > 0) {
-        this.#makeAssetsAvailable(toMakeAvailable)
-      }
+  start = async () => {
+    const { added, updated } = await this.#assetsAtom.get()
 
-      ;['assets-add', 'assets-update'].forEach((event) =>
-        assetsModule.on(event, (assetList) =>
-          this.#makeAssetsAvailable(assetList.map((asset) => asset.name))
-        )
-      )
+    const toMakeAvailable = [...added, ...updated]
+    if (toMakeAvailable.length > 0) {
+      this.#makeAssetsAvailable(toMakeAvailable, 'assets-load')
+    }
 
+    this.#subscriptions.push(
+      this.#assetsAtom.observe(({ added, updated }) => {
+        if (added.length > 0) {
+          this.#makeAssetsAvailable(added, 'assets-added')
+        }
+
+        if (updated.length > 0) {
+          this.#makeAssetsAvailable(updated, 'assets-updated')
+        }
+      }),
       // built-in custom tokens that the user added/enabled/disabled explicitly needs to be available forever
-      // eslint-disable-next-line hydra/module-side-effects
-      enabledAndDisabledAssetsAtom.observe(async (value) => {
+      this.#enabledAndDisabledAssetsAtom.observe(async (value) => {
         if (value?.disabled) {
-          const availableAssets = new Set(await availableAssetNamesAtom.get())
+          const availableAssetsNamesSet = await this.#getAvailableAssetsSet()
           const unavailableTokenNames = Object.keys(value.disabled).filter((assetName) => {
             const token = this.#assetsModule.getAsset(assetName)
             return (
-              !availableAssets.has(assetName) &&
+              !availableAssetsNamesSet.has(assetName) &&
               (!token ||
-                (token.name !== token.baseAsset.name && availableAssets.has(token.baseAsset.name)))
+                (token.name !== token.baseAsset.name &&
+                  availableAssetsNamesSet.has(token.baseAsset.name)))
             )
           })
           if (unavailableTokenNames.length > 0) {
-            assetsModule
+            this.#assetsModule
               .addRemoteTokens({ tokenNames: unavailableTokenNames })
               .catch((err) => this._logger.error(err))
           }
         }
       })
-    })
+    )
   }
 
-  #makeAssetsAvailable = restrictConcurrency(async (assetNames) => {
-    const availableAssetNames = await this.#availableAssetNamesAtom.get()
-    const toMakeAvailable = difference(assetNames, availableAssetNames)
+  #getAvailableAssetsSet = async () => {
+    const availableAssets = await this.#availableAssetsAtom.get()
+    return new Set(availableAssets.map((a) => a.assetName))
+  }
+
+  #makeAssetsAvailable = restrictConcurrency(async (assets, reason) => {
+    const availableAssets = await this.#availableAssetsAtom.get()
+    const availableAssetsNamesSet = await this.#getAvailableAssetsSet()
+    const toMakeAvailable = assets
+      .filter((asset) => !availableAssetsNamesSet.has(asset.name))
+      .map((asset) => ({ assetName: asset.name, reason }))
+
     if (toMakeAvailable.length === 0) return
 
     this._logger.log('making assets available:', toMakeAvailable)
-    const update = [...availableAssetNames, ...toMakeAvailable]
-    await this.#availableAssetNamesAtom.set(update)
+    const update = [...availableAssets, ...toMakeAvailable]
+    await this.#availableAssetsAtom.set(update)
   })
+
+  stop = () => {
+    this.#subscriptions.forEach((unsubscribe) => unsubscribe())
+    this.#subscriptions = []
+  }
 }
 
 const createAvailableAssetsModule = (opts) => new AvailableAssets(opts)
@@ -68,9 +99,10 @@ const availableAssetsDefinition = {
   factory: createAvailableAssetsModule,
   dependencies: [
     'assetsModule',
-    'availableAssetNamesAtom',
     'enabledAndDisabledAssetsAtom',
     'logger',
+    'availableAssetsAtom',
+    'assetsAtom',
   ],
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/available-assets",
-  "version": "6.0.0",
+  "version": "8.0.0",
   "description": "Tracks supported/available assets, i.e. assets that the user can potentially enable via the UI",
   "license": "UNLICENSED",
   "author": "Exodus Movement Inc.",
@@ -29,7 +29,7 @@
     "url": "git+https://github.com/ExodusMovement/exodus-hydra.git"
   },
   "dependencies": {
-    "@exodus/atoms": "^5.7.1",
+    "@exodus/atoms": "^6.0.1",
     "@exodus/basic-utils": "^2.0.0",
     "@exodus/core-selectors": "^1.5.0",
     "@exodus/module": "^1.1.0",
@@ -40,7 +40,7 @@
   "devDependencies": {
     "@exodus/assets": "^8.0.95",
     "@exodus/assets-base": "^8.1.10",
-    "@exodus/assets-feature": "^3.1.1",
+    "@exodus/assets-feature": "^3.8.0",
     "@exodus/combined-assets-meta": "^1.2.6-alpha-1",
     "@exodus/enabled-assets": "^6.0.2",
     "@exodus/redux-dependency-injection": "^3.0.0",
@@ -49,5 +49,5 @@
     "jest-when": "^3.6.0",
     "redux": "^4.2.1"
   },
-  "gitHead": "4877652bbc679f2073147e342610564f49ae97d1"
+  "gitHead": "134218d9d199a266dc274b9906d6a816dafe5b94"
 }

package/plugins/index.js

@@ -1,6 +1,6 @@
 import { createAtomObserver } from '@exodus/atoms'
 
-const createAvailableAssetsPlugin = ({ port, availableAssetNamesAtom }) => {
+const createAvailableAssetsPlugin = ({ port, availableAssetNamesAtom, availableAssets }) => {
   const availableAssetNamesAtomObserver = createAtomObserver({
     port,
     atom: availableAssetNamesAtom,
@@ -8,15 +8,21 @@ const createAvailableAssetsPlugin = ({ port, availableAssetNamesAtom }) => {
   })
   availableAssetNamesAtomObserver.register()
 
+  const onStart = () => {
+    availableAssets.start()
+  }
+
   const onLoad = () => {
     availableAssetNamesAtomObserver.start()
   }
 
   const onStop = () => {
     availableAssetNamesAtomObserver.unregister()
+    availableAssets.stop()
   }
 
   return {
+    onStart,
     onLoad,
     onStop,
   }
@@ -26,7 +32,7 @@ const availableAssetsPluginDefinition = {
   id: 'availableAssetsPlugin',
   type: 'plugin',
   factory: createAvailableAssetsPlugin,
-  dependencies: ['port', 'availableAssetNamesAtom'],
+  dependencies: ['port', 'availableAssetNamesAtom', 'availableAssets'],
 }
 
 export default availableAssetsPluginDefinition