@exodus/assets-feature 1.5.0 → 1.6.0

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.6.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/assets-feature@1.5.0...@exodus/assets-feature@1.6.0) (2023-09-07)
+
+### Features
+
+- add asset preferences to assets-feature redux module ([#3879](https://github.com/ExodusMovement/exodus-hydra/issues/3879)) ([6b60a16](https://github.com/ExodusMovement/exodus-hydra/commit/6b60a162a2af845374911ccacf1c58dbf2620523))
+- asset preferences api ([#3877](https://github.com/ExodusMovement/exodus-hydra/issues/3877)) ([5f1798b](https://github.com/ExodusMovement/exodus-hydra/commit/5f1798bc4ce616e4c762203b8f1940b898231aa1))
+
+### Bug Fixes
+
+- asset-feature tests ([#3911](https://github.com/ExodusMovement/exodus-hydra/issues/3911)) ([c26d1ec](https://github.com/ExodusMovement/exodus-hydra/commit/c26d1ec7e0b32e1940c8dc6e969a5cb815661e20))
+
 ## [1.5.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/assets-feature@1.4.1...@exodus/assets-feature@1.5.0) (2023-08-30)
 
 ### Features

package/api/index.js

@@ -0,0 +1,19 @@
+const createAssetsApi = ({ assetPreferences }) => {
+  return {
+    assetPreferences: {
+      enableMultiAddressMode: assetPreferences.enableMultiAddressMode,
+      disableMultiAddressMode: assetPreferences.disableMultiAddressMode,
+      disablePurpose: assetPreferences.disablePurpose,
+      enablePurpose: assetPreferences.enablePurpose,
+    },
+  }
+}
+
+const assetsApiDefinition = {
+  id: 'assetsApi',
+  type: 'api',
+  factory: createAssetsApi,
+  dependencies: ['assetPreferences'],
+}
+
+export default assetsApiDefinition

package/atoms/disabled-purposes.js

@@ -0,0 +1,18 @@
+import { createStorageAtomFactory } from '@exodus/atoms'
+
+const createDisabledPurposesAtom = ({ storage, logger, config }) => {
+  return createStorageAtomFactory({ storage, logger })({
+    key: 'disabledPurposes',
+    defaultValue: config.defaults ?? {},
+    isSoleWriter: true,
+  })
+}
+
+const disabledPurposesAtomDefinition = {
+  id: 'disabledPurposesAtom',
+  type: 'atom',
+  factory: createDisabledPurposesAtom,
+  dependencies: ['storage', 'logger', 'config'],
+}
+
+export default disabledPurposesAtomDefinition

package/atoms/multi-address-mode.js

@@ -0,0 +1,18 @@
+import { createStorageAtomFactory } from '@exodus/atoms'
+
+const createMultiAddressModeAtom = ({ storage, logger, config }) => {
+  return createStorageAtomFactory({ storage, logger })({
+    key: 'multiAddressMode',
+    defaultValue: config.defaults ?? {},
+    isSoleWriter: true,
+  })
+}
+
+const multiAddressModeAtomDefinition = {
+  id: 'multiAddressModeAtom',
+  type: 'atom',
+  factory: createMultiAddressModeAtom,
+  dependencies: ['storage', 'logger', 'config'],
+}
+
+export default multiAddressModeAtomDefinition

package/index.js

@@ -1,12 +1,31 @@
 import assetsClientInterfaceDefinition from './client'
 import assetsPluginDefinition from './plugin'
+import multiAddressModeAtomDefinition from './atoms/multi-address-mode'
+import disabledPurposesAtomDefinition from './atoms/disabled-purposes'
+import assetsApiDefinition from './api'
+import assetPreferencesDefinition from './module/asset-preferences'
 
-const assets = () => {
+const assets = ({ config = {} } = {}) => {
   return {
     id: 'assets',
     definitions: [
       { definition: assetsClientInterfaceDefinition },
       { definition: assetsPluginDefinition },
+      {
+        definition: multiAddressModeAtomDefinition,
+        storage: { namespace: 'assetPreferences' },
+        config: config.multiAddressMode || {},
+      },
+      {
+        definition: disabledPurposesAtomDefinition,
+        storage: { namespace: 'assetPreferences' },
+        config: config.disabledPurposes || {},
+      },
+      { definition: assetsApiDefinition },
+      {
+        definition: assetPreferencesDefinition,
+        writesAtoms: ['multiAddressModeAtom', 'disabledPurposesAtom'],
+      },
     ],
   }
 }

package/module/asset-preferences.js

@@ -0,0 +1,61 @@
+import ExodusModule from '@exodus/module'
+import { omit } from '@exodus/basic-utils'
+
+const MODULE_ID = 'assetPreferences'
+
+class AssetPreferences extends ExodusModule {
+  #disabledPurposesAtom
+  #multiAddressModeAtom
+
+  constructor({ disabledPurposesAtom, multiAddressModeAtom, logger }) {
+    super({ name: MODULE_ID, logger })
+
+    this.#disabledPurposesAtom = disabledPurposesAtom
+    this.#multiAddressModeAtom = multiAddressModeAtom
+  }
+
+  enableMultiAddressMode = ({ assetNames }) =>
+    this.#multiAddressModeAtom.set((value) => ({
+      ...value,
+      ...assetNames.reduce((acc, assetName) => {
+        acc[assetName] = true
+        return acc
+      }, {}),
+    }))
+
+  disableMultiAddressMode = ({ assetNames }) =>
+    this.#multiAddressModeAtom.set((value) => omit(value, assetNames))
+
+  disablePurpose = ({ assetName, purpose }) =>
+    this.#disabledPurposesAtom.set((value) => {
+      const assetValue = value[assetName] || []
+      if (assetValue.includes(purpose)) return value
+
+      return {
+        ...value,
+        [assetName]: [...assetValue, purpose],
+      }
+    })
+
+  enablePurpose = ({ assetName, purpose }) =>
+    this.#disabledPurposesAtom.set((value) => {
+      const assetValue = value[assetName] || []
+      if (assetValue.includes(purpose)) {
+        return {
+          ...value,
+          [assetName]: assetValue.filter((disabledPurpose) => disabledPurpose !== purpose),
+        }
+      }
+
+      return value
+    })
+}
+
+const assetPreferencesDefinition = {
+  id: MODULE_ID,
+  type: 'module',
+  factory: (opts) => new AssetPreferences(opts),
+  dependencies: ['disabledPurposesAtom', 'multiAddressModeAtom', 'logger'],
+}
+
+export default assetPreferencesDefinition

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/assets-feature",
-  "version": "1.5.0",
+  "version": "1.6.0",
   "license": "UNLICENSED",
   "description": "Assets module, clients and apis",
   "main": "index.js",
@@ -15,6 +15,8 @@
     "module",
     "plugin",
     "redux",
+    "api",
+    "atoms",
     "README.md",
     "CHANGELOG.md",
     "!**/__tests__/**"
@@ -35,10 +37,12 @@
   },
   "devDependencies": {
     "@exodus/assets": "^8.0.94",
+    "@exodus/atoms": "^5.6.0",
     "@exodus/available-assets": "^5.1.1",
     "@exodus/bitcoin-meta": "^1.0.1",
     "@exodus/ethereum-meta": "^1.0.30",
     "@exodus/models": "^9.1.1",
+    "@exodus/module": "^1.2.0",
     "@exodus/redux-dependency-injection": "^3.0.0",
     "@exodus/storage-memory": "^2.1.1",
     "@exodus/wallet-accounts": "^14.0.0",
@@ -48,5 +52,5 @@
     "jest": "^29.1.2",
     "redux": "^4.0.0"
   },
-  "gitHead": "13c8d20b56723fe9556683c3ff969995556ba5f2"
+  "gitHead": "7c733496bd1e1748b59f2c30c51f9bb850035975"
 }

package/plugin/index.js

@@ -1,4 +1,6 @@
-const createAssetsPlugin = ({ port, assetsModule }) => {
+import { createAtomObserver } from '@exodus/atoms'
+
+const createAssetsPlugin = ({ port, assetsModule, disabledPurposesAtom, multiAddressModeAtom }) => {
   const emitAssetsLoad = () => port.emit('assets-load', Object.values(assetsModule.getAssets()))
   const listeners = [
     ['assets-add', (data) => port.emit('assets-add', data)],
@@ -9,12 +11,21 @@ const createAssetsPlugin = ({ port, assetsModule }) => {
     assetsModule.on(event, callback)
   })
 
+  const observers = [
+    createAtomObserver({ atom: disabledPurposesAtom, port, event: 'disabledPurposes' }),
+    createAtomObserver({ atom: multiAddressModeAtom, port, event: 'multiAddressMode' }),
+  ]
+
   const onStart = async () => {
+    observers.forEach((observer) => observer.register())
+
     await assetsModule.load()
     emitAssetsLoad()
   }
 
   const onLoad = async () => {
+    observers.forEach((observer) => observer.start())
+
     await assetsModule.load()
     emitAssetsLoad()
   }
@@ -23,6 +34,8 @@ const createAssetsPlugin = ({ port, assetsModule }) => {
     listeners.forEach(([event, callback]) => {
       assetsModule.removeListener(event, callback)
     })
+
+    observers.forEach((observer) => observer.unregister())
   }
 
   return { onStart, onLoad, onStop }
@@ -32,7 +45,7 @@ const assetsPluginDefinition = {
   id: 'assetsPlugin',
   type: 'plugin',
   factory: createAssetsPlugin,
-  dependencies: ['port', 'assetsModule'],
+  dependencies: ['port', 'assetsModule', 'disabledPurposesAtom', 'multiAddressModeAtom'],
 }
 
 export default assetsPluginDefinition

package/redux/index.js

@@ -17,12 +17,21 @@ const assetsReduxDefinition = {
   initialState,
   eventReducers: {
     'assets-load': (state, payload) => ({
+      ...state,
       error: null,
       loaded: true,
       data: keyBy(payload, 'name'),
     }),
     'assets-add': mergeAssets,
     'assets-update': mergeAssets,
+    multiAddressMode: (state, payload) => ({
+      ...state,
+      multiAddressMode: payload,
+    }),
+    disabledPurposes: (state, payload) => ({
+      ...state,
+      disabledPurposes: payload,
+    }),
   },
   selectorDefinitions,
 }

package/redux/initial-state.js

@@ -2,6 +2,9 @@ const initialState = {
   loaded: false,
   data: {},
   error: null,
+  // asset preferences
+  multiAddressMode: {},
+  disabledPurposes: {},
 }
 
 export default initialState

package/redux/selectors/index.js

@@ -49,6 +49,34 @@ const getAssetFromTickerSelectorDefinition = {
   dependencies: [{ selector: 'allByTicker' }],
 }
 
+const createMultiAddressModeSelectorDefinition = {
+  id: 'createMultiAddressMode',
+  selectorFactory: (multiAddressModeDataSelector) =>
+    memoize((assetName) =>
+      createSelector(
+        multiAddressModeDataSelector,
+        (multiAddressModeData) => multiAddressModeData[assetName] || false
+      )
+    ),
+
+  dependencies: [{ selector: 'multiAddressMode' }],
+}
+
+const createDisabledPurposesSelectorDefinition = {
+  id: 'createDisabledPurposes',
+  selectorFactory: (disabledPurposesDataSelector) => {
+    const disabledPurposesDefaultValue = []
+    return memoize((assetName) =>
+      createSelector(
+        disabledPurposesDataSelector,
+        (disabledPurposesData) => disabledPurposesData[assetName] || disabledPurposesDefaultValue
+      )
+    )
+  },
+
+  dependencies: [{ selector: 'disabledPurposes' }],
+}
+
 const assetSelectors = [
   allAssetsSelectorDefinition,
   allByTickerSelectorDefinition,
@@ -57,6 +85,8 @@ const assetSelectors = [
   createFeeAssetSelectorDefinition,
   getAssetSelectorDefinition,
   getAssetFromTickerSelectorDefinition,
+  createMultiAddressModeSelectorDefinition,
+  createDisabledPurposesSelectorDefinition,
 ]
 
 export default assetSelectors