@exodus/available-assets 1.0.0

package/README.md

@@ -0,0 +1,27 @@
+# @exodus/balances
+
+This module tracks available assets.
+
+## Install
+
+```sh
+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 createAvailableAssets from '@exodus/available-assets'
+
+createAvailableAssets({
+  // 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,
+})
+```

package/index.js

@@ -0,0 +1,41 @@
+import ExodusModule from '@exodus/module'
+import { difference } from 'lodash'
+import restrictConcurrency from 'make-concurrent'
+
+class AvailableAssets extends ExodusModule {
+  #assetsModule
+  #availableAssetNamesAtom
+  #availableAssetNamesSet
+  constructor({ assetsModule, availableAssetNamesAtom, logger }) {
+    super({ name: 'AvailableAssets', logger })
+
+    this.#assetsModule = assetsModule
+    this.#availableAssetNamesAtom = availableAssetNamesAtom
+    assetsModule.once('assets-load', ({ importedTokens }) => {
+      const toMakeAvailable = Object.keys(importedTokens)
+      if (toMakeAvailable.length > 0) {
+        this.#makeAssetsAvailable(toMakeAvailable)
+      }
+
+      ;['assets-add', 'assets-update'].forEach((event) =>
+        assetsModule.on(event, (assetList) =>
+          this.#makeAssetsAvailable(assetList.map((asset) => asset.name))
+        )
+      )
+    })
+  }
+
+  #makeAssetsAvailable = restrictConcurrency(async (assetNames) => {
+    const availableAssetNames = await this.#availableAssetNamesAtom.get()
+    const toMakeAvailable = difference(assetNames, availableAssetNames)
+    if (toMakeAvailable.length === 0) return
+
+    this._logger.log('making assets available:', toMakeAvailable)
+    const update = [...availableAssetNames, ...toMakeAvailable]
+    await this.#availableAssetNamesAtom.set(update)
+  })
+}
+
+const createAvailableAssetsModule = (opts) => new AvailableAssets(opts)
+
+export default createAvailableAssetsModule

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@exodus/available-assets",
+  "version": "1.0.0",
+  "license": "UNLICENSED",
+  "main": "index.js",
+  "author": "Exodus Movement Inc.",
+  "scripts": {
+    "test": "jest",
+    "lint": "eslint .",
+    "lint:fix": "yarn lint --fix"
+  },
+  "files": [
+    "index.js"
+  ],
+  "homepage": "https://github.com/ExodusMovement/exodus-hydra/tree/master/modules/available-assets",
+  "bugs": {
+    "url": "https://github.com/ExodusMovement/exodus-hydra/issues?q=is%3Aissue+is%3Aopen+label%3Aavailable-assets"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ExodusMovement/exodus-hydra.git"
+  },
+  "dependencies": {
+    "@exodus/module": "^1.0.0",
+    "lodash": "^4.17.21",
+    "make-concurrent": "^5.3.0"
+  },
+  "devDependencies": {
+    "@exodus/atoms": "*"
+  }
+}