@exodus/available-assets 7.0.0 → 8.0.1

package/CHANGELOG.md

@@ -3,6 +3,30 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.0.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/available-assets@8.0.0...@exodus/available-assets@9.0.0) (2024-03-18)
+
+### Bug Fixes
+
+- **available-assets:** assets add/update event names ([#6159](https://github.com/ExodusMovement/exodus-hydra/issues/6159)) ([e54e8f3](https://github.com/ExodusMovement/exodus-hydra/commit/e54e8f3524a60f0286bf8ace578b0837b74c71dd))
+
+## [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

package/README.md

@@ -10,25 +10,27 @@ yarn add @exodus/available-assets
 
 ## Usage
 
-Note: this module does not export a public API aside from its constructor/factory function. It monitors the assetsModule and makes built-in assets/tokens and custom tokens available by writing to the `availableAssetNamesAtom`.
-
 ```js
-import availableAssetsDefinition from '@exodus/available-assets/module'
-import { availableAssetNamesAtomDefinition } from '@exodus/available-assets/atoms'
+// see https://github.com/ExodusMovement/exodus-hydra/blob/c5632b131fd3cd210f658fb45113528c0e227beb/sdks/headless/__tests__/available-assets.test.js#L40
+import createExodus from '@exodus/headless'
+import availableAssets from '@exodus/available-assets'
 
-const availableAssetNamesAtom = availableAssetNamesAtomDefinition.factory({
+const container = createExodus({
+  port,
+  adapters,
   config: {
-    defaultAvailableAssetNames: ['bitcoin', 'ethereum'],
+    // ...,
+    // TODO: support configuring via feature config:
+    // `container.use(availableAssets({ defaultAvailableAssetNames: ['bitcoin', 'ethereum']}))`
+    availableAssetsAtom: {
+      defaultAvailableAssetNames: ['bitcoin', 'ethereum'],
+    },
   },
 })
 
-availableAssetsDefinition.factory({
-  // see #/assets-module in exodus-browser or tests for the API
-  assetsModule,
-  // atom that this module will write available assets to as they change
-  availableAssetNamesAtom,
-  // @exodus/blockchain-metadata instance
-  // see ../modules/module/src/logger.js for API
-  logger,
-})
+container.use(availableAssets())
+
+const exodus = container.resolve()
+
+const availableAssetNames = await exodus.availableAssets.get() // ['bitcoin', 'ethereum']
 ```

package/index.js

@@ -12,7 +12,6 @@ const availableAssets = () => ({
   definitions: [
     {
       definition: availableAssetsModuleDefinition,
-      writesAtoms: ['availableAssetsAtom'],
     },
     { definition: availableAssetsAtomDefinition },
     { definition: availableAssetNamesAtomDefinition },

package/module/index.js

@@ -6,30 +6,45 @@ const MODULE_ID = 'availableAssets'
 class AvailableAssets extends ExodusModule {
   #assetsModule
   #availableAssetsAtom
-  constructor({ assetsModule, availableAssetsAtom, enabledAndDisabledAssetsAtom, logger }) {
+  #enabledAndDisabledAssetsAtom
+  #assetsAtom
+  #subscriptions = []
+
+  constructor({
+    assetsModule,
+    assetsAtom,
+    availableAssetsAtom,
+    enabledAndDisabledAssetsAtom,
+    logger,
+  }) {
     super({ name: MODULE_ID, logger })
 
     this.#assetsModule = assetsModule
+    this.#assetsAtom = assetsAtom
     this.#availableAssetsAtom = availableAssetsAtom
+    this.#enabledAndDisabledAssetsAtom = enabledAndDisabledAssetsAtom
+  }
+
+  start = async () => {
+    const { added, updated } = await this.#assetsAtom.get()
 
-    assetsModule.once('assets-load', ({ importedTokens }) => {
-      const toMakeAvailable = Object.keys(importedTokens)
-      if (toMakeAvailable.length > 0) {
-        this.#makeAssetsAvailable(toMakeAvailable, 'assets-load')
-      }
-
-      ;['assets-add', 'assets-update'].forEach((event) =>
-        assetsModule.on(event, (assetList) =>
-          this.#makeAssetsAvailable(
-            assetList.map((asset) => asset.name),
-            event
-          )
-        )
-      )
+    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-add')
+        }
 
+        if (updated.length > 0) {
+          this.#makeAssetsAvailable(updated, 'assets-update')
+        }
+      }),
       // 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 availableAssetsNamesSet = await this.#getAvailableAssetsSet()
           const unavailableTokenNames = Object.keys(value.disabled).filter((assetName) => {
@@ -42,13 +57,13 @@ class AvailableAssets extends ExodusModule {
             )
           })
           if (unavailableTokenNames.length > 0) {
-            assetsModule
+            this.#assetsModule
               .addRemoteTokens({ tokenNames: unavailableTokenNames })
               .catch((err) => this._logger.error(err))
           }
         }
       })
-    })
+    )
   }
 
   #getAvailableAssetsSet = async () => {
@@ -56,18 +71,24 @@ class AvailableAssets extends ExodusModule {
     return new Set(availableAssets.map((a) => a.assetName))
   }
 
-  #makeAssetsAvailable = restrictConcurrency(async (assetNames, reason) => {
+  #makeAssetsAvailable = restrictConcurrency(async (assets, reason) => {
     const availableAssets = await this.#availableAssetsAtom.get()
     const availableAssetsNamesSet = await this.#getAvailableAssetsSet()
-    const toMakeAvailable = assetNames
-      .filter((assetName) => !availableAssetsNamesSet.has(assetName))
-      .map((assetName) => ({ assetName, reason }))
+    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 = [...availableAssets, ...toMakeAvailable]
     await this.#availableAssetsAtom.set(update)
   })
+
+  stop = () => {
+    this.#subscriptions.forEach((unsubscribe) => unsubscribe())
+    this.#subscriptions = []
+  }
 }
 
 const createAvailableAssetsModule = (opts) => new AvailableAssets(opts)
@@ -76,7 +97,13 @@ const availableAssetsDefinition = {
   id: MODULE_ID,
   type: 'module',
   factory: createAvailableAssetsModule,
-  dependencies: ['assetsModule', 'enabledAndDisabledAssetsAtom', 'logger', 'availableAssetsAtom'],
+  dependencies: [
+    'assetsModule',
+    'enabledAndDisabledAssetsAtom',
+    'logger',
+    'availableAssetsAtom',
+    'assetsAtom',
+  ],
 }
 
 export default availableAssetsDefinition

package/package.json

@@ -1,12 +1,12 @@
 {
   "name": "@exodus/available-assets",
-  "version": "7.0.0",
+  "version": "8.0.1",
   "description": "Tracks supported/available assets, i.e. assets that the user can potentially enable via the UI",
   "license": "UNLICENSED",
   "author": "Exodus Movement Inc.",
   "scripts": {
-    "test": "jest",
-    "lint": "eslint . --ignore-path ../../.gitignore",
+    "test": "run -T jest",
+    "lint": "run -T eslint . --ignore-path ../../.gitignore",
     "lint:fix": "yarn lint --fix"
   },
   "main": "index.js",
@@ -29,7 +29,7 @@
     "url": "git+https://github.com/ExodusMovement/exodus-hydra.git"
   },
   "dependencies": {
-    "@exodus/atoms": "^5.7.2",
+    "@exodus/atoms": "^7.0.5",
     "@exodus/basic-utils": "^2.0.0",
     "@exodus/core-selectors": "^1.5.0",
     "@exodus/module": "^1.1.0",
@@ -40,14 +40,12 @@
   "devDependencies": {
     "@exodus/assets": "^8.0.95",
     "@exodus/assets-base": "^8.1.10",
-    "@exodus/assets-feature": "^3.4.0",
+    "@exodus/assets-feature": "^5.0.0",
     "@exodus/combined-assets-meta": "^1.2.6-alpha-1",
     "@exodus/enabled-assets": "^6.0.2",
     "@exodus/redux-dependency-injection": "^3.0.0",
-    "eslint": "^8.44.0",
-    "jest": "^29.1.2",
     "jest-when": "^3.6.0",
     "redux": "^4.2.1"
   },
-  "gitHead": "cf49a42c01f0ac7ff8328de2684e872712d18e7c"
+  "gitHead": "8a5403c8ab2ee21179f33960e20be92ee5b854d6"
 }

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