@exodus/balances 12.0.1 → 12.2.0

package/CHANGELOG.md

@@ -3,6 +3,19 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [12.2.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/balances@12.1.0...@exodus/balances@12.2.0) (2024-01-03)
+
+### Features
+
+- **balances:** new unconfirmed balance selector to improve performance ([#5234](https://github.com/ExodusMovement/exodus-hydra/issues/5234)) ([9c97b66](https://github.com/ExodusMovement/exodus-hydra/commit/9c97b6618c0fa494763d76431aa4bbf915495091))
+
+## [12.1.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/balances@12.0.1...@exodus/balances@12.1.0) (2023-12-14)
+
+### Features
+
+- **balances:** funded wallet accounts atom ([#5074](https://github.com/ExodusMovement/exodus-hydra/issues/5074)) ([dc98436](https://github.com/ExodusMovement/exodus-hydra/commit/dc98436d5f8bbade4ceab85af60455ac3b4efa49))
+- remove storing oldBalances in balances atoms ([#5073](https://github.com/ExodusMovement/exodus-hydra/issues/5073)) ([414db86](https://github.com/ExodusMovement/exodus-hydra/commit/414db866a86aaf3242e68698596af187da6927c3))
+
 ## [12.0.1](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/balances@12.0.0...@exodus/balances@12.0.1) (2023-12-12)
 
 ### Bug Fixes

package/README.md

@@ -30,8 +30,8 @@ const balances = createBalances({
   logger,
 })
 
-balances.on('balances', ({ balances, oldBalances, changes }) => {
-  // `balances`, `oldBalances`
+balances.on('balances', ({ balances, changes }) => {
+  // `balances`
   // {
   //   [walletAccount]: {
   //     [assetName]: {

package/atoms/funded-wallet-accounts.js

@@ -0,0 +1,23 @@
+import { combine, compute } from '@exodus/atoms'
+import { mapValues } from '@exodus/basic-utils'
+
+const computeFundedWalletAccounts = ({ walletAccounts, balances }) => {
+  return mapValues(walletAccounts, (_, key) => {
+    const walletAccountBalaces = balances.balances[key] || {}
+    return Object.values(walletAccountBalaces).some(({ balance }) => !balance.isZero)
+  })
+}
+
+const createFundedWalletAccountsAtom = ({ balancesAtom, enabledWalletAccountsAtom }) => {
+  const walletAccountsBalanceAtom = combine({
+    walletAccounts: enabledWalletAccountsAtom,
+    balances: balancesAtom,
+  })
+
+  return compute({
+    atom: walletAccountsBalanceAtom,
+    selector: computeFundedWalletAccounts,
+  })
+}
+
+export default createFundedWalletAccountsAtom

package/atoms/index.js

@@ -1,4 +1,5 @@
 import createBalancesAtom from './balances'
+import createFundedWalletAccountsAtom from './funded-wallet-accounts'
 import createHasBalanceAtom from './has-balance'
 
 export const balancesAtomDefinition = {
@@ -14,3 +15,10 @@ export const hasBalanceAtomDefinition = {
   factory: createHasBalanceAtom,
   dependencies: ['balancesAtom', 'storage'],
 }
+
+export const fundedWalletAccountsAtomDefinition = {
+  id: 'fundedWalletAccountsAtom',
+  type: 'atom',
+  factory: createFundedWalletAccountsAtom,
+  dependencies: ['balancesAtom', 'enabledWalletAccountsAtom'],
+}

package/index.js

@@ -1,5 +1,9 @@
 import balancesDefinition from './module'
-import { balancesAtomDefinition, hasBalanceAtomDefinition } from './atoms'
+import {
+  balancesAtomDefinition,
+  hasBalanceAtomDefinition,
+  fundedWalletAccountsAtomDefinition,
+} from './atoms'
 import balancesReportDefinition from './report'
 import balancesPluginDefinition from './plugins'
 import typeforce from '@exodus/typeforce'
@@ -18,7 +22,6 @@ const balances = (config) => {
     definitions: [
       {
         definition: balancesDefinition,
-        writesAtoms: ['balancesAtom'],
         config,
       },
       { definition: balancesAtomDefinition },
@@ -27,8 +30,9 @@ const balances = (config) => {
         storage: { namespace: 'balances' },
         aliases: [{ implementationId: 'unsafeStorage', interfaceId: 'storage' }],
       },
+      { definition: fundedWalletAccountsAtomDefinition },
       { definition: balancesReportDefinition },
-      { definition: balancesPluginDefinition, writesAtoms: ['hasBalanceAtom'] },
+      { definition: balancesPluginDefinition },
     ],
   }
 }

package/module/index.js

@@ -26,7 +26,6 @@ class Balances extends ExodusModule {
   #walletAccounts = [] // string[]
   #ready = false
 
-  #oldBalances = Object.create(null)
   #balances = Object.create(null)
   #balancesAtom
   #accountStatesAtom
@@ -375,19 +374,12 @@ class Balances extends ExodusModule {
   }
 
   #flush = ({ changes } = {}) => {
-    const oldBalances = this.#oldBalances
     const balances = cloneBalances(this.#balances)
 
     if (Object.keys(balances).length === 0) return // wait till `load` finished
 
     this._logger.log('balances updated')
-    this.#balancesAtom.set({
-      balances,
-      oldBalances,
-      changes,
-    })
-
-    this.#oldBalances = balances
+    this.#balancesAtom.set({ balances, changes })
   }
 
   stop = () => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/balances",
-  "version": "12.0.1",
+  "version": "12.2.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": "^4.0.0",
+    "@exodus/assets-feature": "^4.0.1",
     "@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": "^15.0.0",
+    "@exodus/wallet-accounts": "^15.1.0",
     "eslint": "^8.44.0",
     "events": "^3.3.0",
     "jest": "^29.1.2",
     "redux": "^4.2.1"
   },
-  "gitHead": "be0d353e5d42bd166526ac72d256b2b4c7de36a9"
+  "gitHead": "a158fff895557150c79a1cdec05a29d4587f5577"
 }

package/redux/selectors/create-unconfirmed-balance.js

@@ -1,5 +1,6 @@
 import { memoize } from 'lodash'
 import { createSelector } from 'reselect'
+import { getUnconfirmedBalance } from './get-unconfirmed-balance'
 
 const selectorFactory = (assetsSelector, createAssetSourceSelector) =>
   memoize(
@@ -7,21 +8,7 @@ const selectorFactory = (assetsSelector, createAssetSourceSelector) =>
       createSelector(
         assetsSelector,
         createAssetSourceSelector({ assetName, walletAccount }),
-        (assets, txs) => {
-          const asset = assets[assetName]
-          let result = asset.currency.ZERO
-
-          for (const tx of txs) {
-            const isIncommingTX = tx.coinAmount.isPositive
-            const isUnconfirmed = !tx.failed && tx.pending
-
-            if (isUnconfirmed) {
-              result = isIncommingTX ? result.add(tx.coinAmount) : result.sub(tx.coinAmount)
-            }
-          }
-
-          return result
-        }
+        (assets, txs) => getUnconfirmedBalance({ asset: assets[assetName], txs })
       ),
     ({ assetName, walletAccount }) => [assetName, walletAccount].join('-')
   )

package/redux/selectors/get-unconfirmed-balance.js

@@ -0,0 +1,40 @@
+import { memoize } from 'lodash'
+import { createSelector } from 'reselect'
+
+export const getUnconfirmedBalance = ({ asset, txs }) => {
+  let result = asset.currency.ZERO
+
+  for (const tx of txs) {
+    const isIncommingTX = tx.coinAmount.isPositive
+    const isUnconfirmed = !tx.failed && tx.pending
+
+    if (isUnconfirmed) {
+      result = isIncommingTX ? result.add(tx.coinAmount) : result.sub(tx.coinAmount)
+    }
+  }
+
+  return result
+}
+
+const selectorFactory = (assetsSelector, createAssetSourceSelector) =>
+  createSelector(assetsSelector, createAssetSourceSelector, (assets, getTxs) =>
+    memoize(
+      ({ assetName, walletAccount }) =>
+        getUnconfirmedBalance({
+          asset: assets[assetName],
+          txs: getTxs({ assetName, walletAccount }),
+        }),
+      ({ assetName, walletAccount }) => [assetName, walletAccount].join('-')
+    )
+  )
+
+const getUnconfirmedBalanceSelectorDefinition = {
+  id: 'getUnconfirmedBalance',
+  selectorFactory,
+  dependencies: [
+    { module: 'assets', selector: 'all' },
+    { module: 'txLog', selector: 'createAssetSourceSelectorOld' },
+  ],
+}
+
+export default getUnconfirmedBalanceSelectorDefinition

package/redux/selectors/index.js

@@ -1,3 +1,4 @@
 import createUnconfirmedBalanceSelectorDefinition from './create-unconfirmed-balance'
+import getUnconfirmedBalanceSelectorDefinition from './get-unconfirmed-balance'
 
-export default [createUnconfirmedBalanceSelectorDefinition]
+export default [createUnconfirmedBalanceSelectorDefinition, getUnconfirmedBalanceSelectorDefinition]