@exodus/balances 11.2.2 → 12.0.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [12.0.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/balances@11.2.2...@exodus/balances@12.0.0) (2023-11-23)
+
+### ⚠ BREAKING CHANGES
+
+- use `assetsAtom` instead of legacy event (#4838)
+
+### Features
+
+- has balance stored ([#4856](https://github.com/ExodusMovement/exodus-hydra/issues/4856)) ([510ffd5](https://github.com/ExodusMovement/exodus-hydra/commit/510ffd517c22bbbcb16441275f1ab71ffcc7de90))
+
+### Bug Fixes
+
+- cleanup subscriptions on stop ([#4814](https://github.com/ExodusMovement/exodus-hydra/issues/4814)) ([d053582](https://github.com/ExodusMovement/exodus-hydra/commit/d0535826c2023dd4d3273b367bbcc5cca6e4bb95))
+- zero balance after send is ignore ([#4725](https://github.com/ExodusMovement/exodus-hydra/issues/4725)) ([56c5d35](https://github.com/ExodusMovement/exodus-hydra/commit/56c5d35ca1643e869c112d0166df036ec988088f))
+
+### Code Refactoring
+
+- use `assetsAtom` instead of legacy event ([#4838](https://github.com/ExodusMovement/exodus-hydra/issues/4838)) ([33260c3](https://github.com/ExodusMovement/exodus-hydra/commit/33260c3fd48286d00a940a4e5ec4956326f8c3c1))
+
 ## [11.2.2](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/balances@11.2.1...@exodus/balances@11.2.2) (2023-11-06)
 
 ### Bug Fixes

package/atoms/has-balance.js

@@ -1,9 +1,9 @@
-import { compute } from '@exodus/atoms'
+import { compute, createStorageAtomFactory } from '@exodus/atoms'
 import { flatMap, map } from 'lodash'
 
 // balancesAtom schema: { balances: { [walletAccount]: { [assetName]: { balance: NumberUnit } } } } }
 
-const createHasBalanceAtom = ({ balancesAtom }) => {
+const createComputedAtom = ({ balancesAtom }) => {
   const selector = ({ balances } = {}) => {
     const numberUnits = flatMap(balances, (value) => map(value, 'balance'))
     return numberUnits.some((numberUnit) => (numberUnit ? !numberUnit.isZero : false))
@@ -12,4 +12,17 @@ const createHasBalanceAtom = ({ balancesAtom }) => {
   return compute({ atom: balancesAtom, selector })
 }
 
+const createHasBalanceAtom = ({ balancesAtom, storage }) => {
+  const storageAtom = createStorageAtomFactory({ storage })({
+    key: 'hasBalance',
+    defaultValue: false,
+    isSoleWriter: true,
+  })
+  const computedAtom = createComputedAtom({ balancesAtom })
+  // eslint-disable-next-line @exodus/hydra/no-eternal-subscription
+  computedAtom.observe((value) => storageAtom.set(value))
+
+  return storageAtom
+}
+
 export default createHasBalanceAtom

package/atoms/index.js

@@ -12,5 +12,5 @@ export const hasBalanceAtomDefinition = {
   id: 'hasBalanceAtom',
   type: 'atom',
   factory: createHasBalanceAtom,
-  dependencies: ['balancesAtom'],
+  dependencies: ['balancesAtom', 'storage'],
 }

package/index.js

@@ -22,9 +22,13 @@ const balances = (config) => {
         config,
       },
       { definition: balancesAtomDefinition },
-      { definition: hasBalanceAtomDefinition },
+      {
+        definition: hasBalanceAtomDefinition,
+        storage: { namespace: 'balances' },
+        aliases: [{ implementationId: 'unsafeStorage', interfaceId: 'storage' }],
+      },
       { definition: balancesReportDefinition },
-      { definition: balancesPluginDefinition },
+      { definition: balancesPluginDefinition, writesAtoms: ['hasBalanceAtom'] },
     ],
   }
 }

package/module/index.js

@@ -21,6 +21,7 @@ export const MODULE_ID = 'balances'
 
 class Balances extends ExodusModule {
   #assetsModule
+  #assetsAtom
   #balanceFields
   #walletAccounts = [] // string[]
   #ready = false
@@ -32,9 +33,11 @@ class Balances extends ExodusModule {
   #txLogsAtom
   #enabledWalletAccountsAtom
   #loaded = false
+  #subscriptions = []
 
   constructor({
     assetsModule,
+    assetsAtom,
     enabledWalletAccountsAtom,
     config: { balanceFields },
     logger,
@@ -45,6 +48,7 @@ class Balances extends ExodusModule {
     super({ name: MODULE_ID, logger })
 
     this.#assetsModule = assetsModule
+    this.#assetsAtom = assetsAtom
     this.#balanceFields = balanceFields
     this.#balancesAtom = balancesAtom
     this.#accountStatesAtom = accountStatesAtom
@@ -92,23 +96,27 @@ class Balances extends ExodusModule {
   load = () => {
     if (this.#loaded) return
     this.#loaded = true
-    this.#enabledWalletAccountsAtom.observe((payload) => {
-      this.#setWalletAccounts(Object.keys(payload))
-    })
-
-    this.#accountStatesAtom.observe(({ changes }) =>
-      flattenToPaths(changes).forEach(([walletAccount, assetName, accountState]) =>
-        this.#handleAccountStateUpdate({ walletAccount, assetName, accountState })
-      )
-    )
 
-    this.#txLogsAtom.observe(({ changes }) =>
-      flattenToPaths(changes).forEach(([walletAccount, assetName, txLog]) =>
-        this.#handleTxLogUpdate({ walletAccount, assetName, txLog })
-      )
+    this.#subscriptions.push(
+      this.#enabledWalletAccountsAtom.observe((payload) => {
+        this.#setWalletAccounts(Object.keys(payload))
+      }),
+      this.#accountStatesAtom.observe(({ changes }) =>
+        flattenToPaths(changes).forEach(([walletAccount, assetName, accountState]) =>
+          this.#handleAccountStateUpdate({ walletAccount, assetName, accountState })
+        )
+      ),
+      this.#txLogsAtom.observe(({ changes }) =>
+        flattenToPaths(changes).forEach(([walletAccount, assetName, txLog]) =>
+          this.#handleTxLogUpdate({ walletAccount, assetName, txLog })
+        )
+      ),
+      this.#assetsAtom.observe(({ added }) => {
+        if (added.length > 0) {
+          this.#onAssetsChanged(added)
+        }
+      })
     )
-
-    this.#assetsModule.on('assets-add', this.#onAssetsChanged)
   }
 
   #getAsset = (assetName) => this.#assetsModule.getAsset(assetName)
@@ -160,7 +168,8 @@ class Balances extends ExodusModule {
       const asset = this.#getAsset(assetName)
       const txLog = txLogsByAssetName[assetName]
       const balances = asset.api.getBalances({ asset, accountState, txLog })
-      if (!balances || isEmpty(balances) || !balances.balance) return null
+      if (!balances || isEmpty(balances) || !balances.balance)
+        return Object.fromEntries(this.#balanceFields.map((field) => [field, asset.currency.ZERO]))
       if (!balances.balance.unitType.equals(asset.currency)) {
         this.emit('error', {
           fn: 'getAssetBalances',
@@ -380,6 +389,11 @@ class Balances extends ExodusModule {
 
     this.#oldBalances = balances
   }
+
+  stop = () => {
+    this.#subscriptions.forEach((unsubscribe) => unsubscribe())
+    this.#subscriptions = []
+  }
 }
 
 const createBalances = (opts) => new Balances(opts)
@@ -396,6 +410,7 @@ const balancesDefinition = {
     'balancesAtom',
     'txLogsAtom',
     'accountStatesAtom',
+    'assetsAtom',
   ],
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/balances",
-  "version": "11.2.2",
+  "version": "12.0.0",
   "description": "Tracks crypto balances across enabled wallet accounts.",
   "author": "Exodus Movement Inc.",
   "license": "UNLICENSED",
@@ -45,18 +45,18 @@
   "devDependencies": {
     "@exodus/assets": "^8.0.94",
     "@exodus/assets-base": "^8.1.10",
-    "@exodus/assets-feature": "^3.7.0",
+    "@exodus/assets-feature": "^4.0.0",
     "@exodus/bitcoin-meta": "^1.0.1",
     "@exodus/blockchain-metadata": "^9.0.1",
     "@exodus/ethereum-meta": "^1.0.30",
     "@exodus/models": "^10.1.0",
     "@exodus/redux-dependency-injection": "^3.0.0",
     "@exodus/storage-memory": "*",
-    "@exodus/wallet-accounts": "^14.2.0",
+    "@exodus/wallet-accounts": "^14.3.0",
     "eslint": "^8.44.0",
     "events": "^3.3.0",
     "jest": "^29.1.2",
     "redux": "^4.2.1"
   },
-  "gitHead": "1c23ddca93850c0a40da742a5cefd2e42b554356"
+  "gitHead": "0c943e6a82e29239305544665711c1b1b4a98fce"
 }

package/plugins/index.js

@@ -1,6 +1,6 @@
 import { createAtomObserver } from '@exodus/atoms'
 
-const createBalancesPlugin = ({ balancesAtom, port, balances }) => {
+const createBalancesPlugin = ({ balancesAtom, port, balances, hasBalanceAtom }) => {
   const balancesAtomObserver = createAtomObserver({
     port,
     atom: balancesAtom,
@@ -8,7 +8,15 @@ const createBalancesPlugin = ({ balancesAtom, port, balances }) => {
   })
   balancesAtomObserver.register()
 
+  const hasBalanceAtomObserver = createAtomObserver({
+    port,
+    atom: hasBalanceAtom,
+    event: 'hasBalance',
+  })
+  hasBalanceAtomObserver.register()
+
   const onLoad = () => {
+    hasBalanceAtomObserver.start()
     balancesAtomObserver.start()
 
     balances.load()
@@ -16,11 +24,18 @@ const createBalancesPlugin = ({ balancesAtom, port, balances }) => {
 
   const onStop = () => {
     balancesAtomObserver.unregister()
+    hasBalanceAtomObserver.unregister()
+    balances.stop()
+  }
+
+  const onClear = async () => {
+    await hasBalanceAtom.set(undefined)
   }
 
   return {
     onLoad,
     onStop,
+    onClear,
   }
 }
 
@@ -28,7 +43,7 @@ const balancesPluginDefinition = {
   id: 'balancesPlugin',
   type: 'plugin',
   factory: createBalancesPlugin,
-  dependencies: ['balancesAtom', 'port', 'balances'],
+  dependencies: ['balancesAtom', 'port', 'balances', 'hasBalanceAtom'],
 }
 
 export default balancesPluginDefinition

package/redux/index.js

@@ -43,8 +43,15 @@ const balancesReduxDefinition = {
         return mergeChanges(state, payload.changes)
       }
 
-      return setAccounts(state, payload.balances)
+      return {
+        hasBalance: state.hasBalance,
+        ...setAccounts(state, payload.balances),
+      }
     },
+    hasBalance: (state, payload) => ({
+      ...state,
+      hasBalance: payload,
+    }),
   },
   selectorDefinitions: [...helper.selectorDefinitions, ...selectorDefinitions],
 }

package/redux/initial-state.js

@@ -1,5 +1,8 @@
 import helper from './multi-account-helper'
 
-const initialState = helper.createInitialState()
+const initialState = {
+  hasBalance: false,
+  ...helper.createInitialState(),
+}
 
 export default initialState