@exodus/balances 13.3.2 → 13.5.0

package/CHANGELOG.md

@@ -3,6 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [13.5.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/balances@13.4.0...@exodus/balances@13.5.0) (2024-11-29)
+
+### Features
+
+- feat: add various crypto balance props (#10419)
+
+## [13.4.0](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/balances@13.3.2...@exodus/balances@13.4.0) (2024-11-25)
+
+### Features
+
+- feat: use atoms v9 (#9651)
+
+### Bug Fixes
+
+- fix: balances tests (#9738)
+
+### License
+
+- license: re-license under MIT license (#10580)
+
 ## [13.3.2](https://github.com/ExodusMovement/exodus-hydra/compare/@exodus/balances@13.3.1...@exodus/balances@13.3.2) (2024-09-13)
 
 ### Bug Fixes

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2024 Exodus Movement, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -10,7 +10,7 @@ yarn add @exodus/balances
 
 ## Usage
 
-This feature is designed to be used together with `@exodus/headless`. See [using the sdk](../../docs/using-the-sdk.md).
+This feature is designed to be used together with `@exodus/headless`. See [using the sdk](../../docs/docs-website/docs/development/using-the-sdk.md).
 
 ### Play with it
 
@@ -36,7 +36,7 @@ selectors.balances
 
 ### API Side
 
-See [using the sdk](../../docs/using-the-sdk.md#setup-the-api-side) for more details on how features plug into the SDK. Note that the balances feature currently doesn't provide a top level API and is meant to be used purely through selectors.
+See [using the sdk](../../docs/docs-website/docs/development/using-the-sdk.md#setup-the-api-side) for more details on how features plug into the SDK. Note that the balances feature currently doesn't provide a top level API and is meant to be used purely through selectors.
 
 If you're building a feature that requires balances, add a dependency on the `balancesAtom` as below. See also the [available balance fields](./default-config.js).
 
@@ -68,7 +68,7 @@ const myModuleDefinition = {
 
 ### UI Side
 
-See [using the sdk](../../docs/using-the-sdk.md#events) for more details on basic UI-side setup.
+See [using the sdk](../../docs/docs-website/docs/development/using-the-sdk.md#events) for more details on basic UI-side setup.
 
 ```js
 import { selectors } from '~/ui/flux'
@@ -87,4 +87,4 @@ const MyComponent = () => {
 
 ### WARNING: no asset specifics!
 
-If you introduce any asset specifics like `if (assetName === 'dogicorn') balance = balance.mul(2)`, you will be fired immediately. This is a safety measure to save you from @feri42's wrath. All asset-specifics belong in `asset.api.getBalances` or other APIs inside the asset libraries.
+Do NOT introduce any asset specifics like `if (assetName === 'dogicorn') balance = balance.mul(2)`. All asset-specifics belong in `asset.api.getBalances` or other APIs inside the asset libraries.

package/atoms/asset-total-wallet-amounts.js

@@ -0,0 +1,46 @@
+import { compute, dedupe } from '@exodus/atoms'
+
+const mapsAreEqual = (mapA, mapB) => {
+  if (mapA.size !== mapB.size) {
+    return false
+  }
+
+  for (const item of mapA) {
+    if (!mapB.has(item)) {
+      return false
+    }
+  }
+
+  return true
+}
+
+const createAssetTotalWalletAmountsAtom = ({ balancesAtom }) => {
+  let previousValue = new Map()
+  const selector = ({ balances }) => {
+    const assetsWithBalances = new Map()
+
+    Object.values(balances).forEach((accountBalances) => {
+      Object.keys(accountBalances).forEach((assetName) => {
+        if (assetsWithBalances.has(assetName)) {
+          const currentAssetBalance = assetsWithBalances.get(assetName)
+          assetsWithBalances.set(
+            assetName,
+            accountBalances[assetName]?.balance.add(currentAssetBalance)
+          )
+        } else {
+          assetsWithBalances.set(assetName, accountBalances[assetName]?.balance)
+        }
+      })
+    })
+
+    if (!mapsAreEqual(assetsWithBalances, previousValue)) {
+      previousValue = assetsWithBalances
+    }
+
+    return previousValue
+  }
+
+  return dedupe(compute({ atom: balancesAtom, selector }))
+}
+
+export default createAssetTotalWalletAmountsAtom

package/atoms/index.js

@@ -3,6 +3,7 @@ import createAssetsWithBalanceCountAtom from './assets-with-balance-count.js'
 import createBalancesAtom from './balances.js'
 import createFundedWalletAccountsAtom from './funded-wallet-accounts.js'
 import createHasBalanceAtom from './has-balance.js'
+import createAssetsTotalWalletAmountsAtom from './asset-total-wallet-amounts.js'
 
 export const balancesAtomDefinition = {
   id: 'balancesAtom',
@@ -43,3 +44,11 @@ export const assetsWithBalanceCountAtomDefinition = {
   dependencies: ['assetNamesWithBalanceAtom'],
   public: true,
 }
+
+export const assetsTotalWalletAmountsDefinition = {
+  id: 'assetsTotalWalletAmountsAtom',
+  type: 'atom',
+  factory: createAssetsTotalWalletAmountsAtom,
+  dependencies: ['balancesAtom'],
+  public: true,
+}

package/default-config.js

@@ -19,7 +19,8 @@ const config = {
   balanceFieldsConfig,
   balanceFields: balanceFieldsConfig
     .flatMap((fieldConfig) => [fieldConfig.name, fieldConfig.legacyName])
-    .filter(Boolean), // wallets can reduce the number of exposed fields
+    .filter(Boolean), // wallets can reduce the number of exposed fields,
+  assetsToTrackForBalances: [],
 }
 
 export default config

package/index.js

@@ -5,6 +5,7 @@ import {
   fundedWalletAccountsAtomDefinition,
   assetsWithBalanceCountAtomDefinition,
   assetNamesWithBalanceAtomDefinition,
+  assetsTotalWalletAmountsDefinition,
 } from './atoms/index.js'
 import balancesReportDefinition from './report/index.js'
 import {
@@ -18,11 +19,14 @@ const balances = (walletConfig) => {
   const config = {
     ...defaultConfig,
     balanceFields: walletConfig?.balanceFields || defaultConfig.balanceFields,
+    assetsToTrackForBalances:
+      walletConfig?.assetsToTrackForBalances || defaultConfig.assetsToTrackForBalances,
   }
   typeforce(
     {
       balanceFields: typeforce.arrayOf('String'),
       balanceFieldsConfig: typeforce.arrayOf('Object'),
+      assetsToTrackForBalances: typeforce.arrayOf('Object'),
     },
     config,
     true
@@ -46,9 +50,11 @@ const balances = (walletConfig) => {
       { definition: fundedWalletAccountsAtomDefinition },
       { definition: balancesReportDefinition },
       { definition: balancesLifecyclePluginDefinition },
+      { definition: assetsTotalWalletAmountsDefinition },
       {
         if: { registered: ['analytics'] },
         definition: balancesAnalyticsPluginDefinition,
+        config: { assetsToTrackForBalances: config.assetsToTrackForBalances },
       },
     ],
   }

package/module/index.js

@@ -1,6 +1,5 @@
 import { isNumberUnit } from '@exodus/currency'
 import { TxSet } from '@exodus/models'
-import ExodusModule from '@exodus/module' // eslint-disable-line import/no-deprecated
 import lodash from 'lodash'
 import { difference, flattenToPaths, pick, set } from '@exodus/basic-utils'
 import makeConcurrent from 'make-concurrent'
@@ -20,9 +19,8 @@ const zipNonNull = (keys, values) =>
     values.filter((value) => value != null)
   )
 
-export const MODULE_ID = 'balances'
-
-class Balances extends ExodusModule {
+class Balances {
+  #logger
   #assetsModule
   #assetsAtom
   #balanceFieldsConfig
@@ -48,8 +46,7 @@ class Balances extends ExodusModule {
     txLogsAtom,
     accountStatesAtom,
   }) {
-    super({ name: MODULE_ID, logger })
-
+    this.#logger = logger
     this.#assetsModule = assetsModule
     this.#assetsAtom = assetsAtom
     this.#balanceFieldsConfig = config?.balanceFieldsConfig || defaultConfig.balanceFieldsConfig
@@ -67,16 +64,13 @@ class Balances extends ExodusModule {
         this.#pushIntoSharedQueue(() => fn.apply(this, args))
       }
 
-    // sanitize args in case someone passes something sensitive, e.g. getBalance({ walletAccount, mnemonic })
-    // when only `{ walletAccount }` is expected
-    const reportAndSwallowErrors =
-      ({ fn, name, sanitizeArgs = () => {} }) =>
+    const swallowErrors =
+      (fn) =>
       async (...args) => {
         try {
           return await fn(...args)
         } catch (error) {
-          this.emit('error', { fn: name, error, args: sanitizeArgs(...args) })
-          this._logger.error(error)
+          this.#logger.error(error)
         }
       }
 
@@ -85,17 +79,8 @@ class Balances extends ExodusModule {
     this.#handleTxLogUpdate = shareQueue(this.#handleTxLogUpdate)
     this.#recompute = shareQueue(this.#recompute)
     this.#onAssetsChanged = shareQueue(this.#onAssetsChanged)
-    this.#getBalancesForAssetSource = reportAndSwallowErrors({
-      fn: this.#getBalancesForAssetSource,
-      name: 'getBalancesForAssetSource',
-      sanitizeArgs: ({ walletAccount, assetName }) => ({ walletAccount, assetName }),
-    })
-
-    this.#setWalletAccounts = reportAndSwallowErrors({
-      fn: this.#setWalletAccounts,
-      name: 'setWalletAccounts',
-      sanitizeArgs: (walletAccounts) => walletAccounts,
-    })
+    this.#getBalancesForAssetSource = swallowErrors(this.#getBalancesForAssetSource)
+    this.#setWalletAccounts = swallowErrors(this.#setWalletAccounts)
   }
 
   load = () => {
@@ -130,9 +115,7 @@ class Balances extends ExodusModule {
 
   #handleAccountStateUpdate = async (opts) => {
     if (!this.#ready) {
-      this._logger.log('ignore update from account-state event.', {
-        isReady: this.#ready,
-      })
+      this.#logger.log('ignore update from account-state event.', { isReady: this.#ready })
       return
     }
 
@@ -141,9 +124,7 @@ class Balances extends ExodusModule {
 
   #handleTxLogUpdate = (opts) => {
     if (!this.#ready) {
-      this._logger.log('ignore update from tx-log event.', {
-        isReady: this.#ready,
-      })
+      this.#logger.log('ignore update from tx-log event.', { isReady: this.#ready })
       return
     }
 
@@ -188,7 +169,7 @@ class Balances extends ExodusModule {
         balances: pick(balances, this.#balanceFields),
         asset,
         zero,
-        logger: this._logger,
+        logger: this.#logger,
         emitter: this,
       })
     }
@@ -208,7 +189,7 @@ class Balances extends ExodusModule {
   }
 
   #load = async ({ walletAccount }) => {
-    this._logger.log(`loading walletAccount ${walletAccount}`)
+    this.#logger.log(`loading walletAccount ${walletAccount}`)
     this.#balances[walletAccount] = await this.#getBalancesForWalletAccount({ walletAccount })
   }
 
@@ -220,14 +201,14 @@ class Balances extends ExodusModule {
     this.#walletAccounts = walletAccounts
     this.#ready = true
     if (removed.length > 0) {
-      this._logger.log('recomputing after removing walletAccounts', removed)
+      this.#logger.log('recomputing after removing walletAccounts', removed)
       removed.forEach((walletAccount) => {
         delete this.#balances[walletAccount]
       })
     }
 
     if (added.length > 0) {
-      this._logger.log('recomputing after adding walletAccounts', added)
+      this.#logger.log('recomputing after adding walletAccounts', added)
       await this.#recompute({ walletAccounts: added })
     } else {
       this.#flush()
@@ -243,7 +224,7 @@ class Balances extends ExodusModule {
       return
     }
 
-    this._logger.log('recomputing based on new assets list')
+    this.#logger.log('recomputing based on new assets list')
     this.#recompute()
   }
 
@@ -308,7 +289,7 @@ class Balances extends ExodusModule {
     if (!this.#isSupportedAsset(assetName)) return
 
     if (!this.#walletAccounts.includes(walletAccount)) {
-      this._logger.warn(`unexpected update for disabled walletAccount ${walletAccount}`)
+      this.#logger.warn(`unexpected update for disabled walletAccount ${walletAccount}`)
       return
     }
 
@@ -339,7 +320,7 @@ class Balances extends ExodusModule {
         if (!newBalance) continue
         if ((oldBalance || currency.ZERO).equals(newBalance)) continue
 
-        this._logger.log(`updating assetSource ${walletAccount}:${assetName}`)
+        this.#logger.log(`updating assetSource ${walletAccount}:${assetName}`)
         set(changes, [walletAccount, subAssetName, field], {
           from: oldBalance ?? currency.ZERO,
           to: newBalance,
@@ -363,7 +344,7 @@ class Balances extends ExodusModule {
 
     if (Object.keys(balances).length === 0) return // wait till `load` finished
 
-    this._logger.log('balances updated')
+    this.#logger.log('balances updated')
     this.#balancesAtom.set({ balances, changes })
   }
 
@@ -376,7 +357,7 @@ class Balances extends ExodusModule {
 const createBalances = (opts) => new Balances(opts)
 
 const balancesDefinition = {
-  id: MODULE_ID,
+  id: 'balances',
   type: 'module',
   factory: createBalances,
   dependencies: [

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "@exodus/balances",
-  "version": "13.3.2",
+  "version": "13.5.0",
   "description": "Tracks crypto balances across enabled wallet accounts.",
   "author": "Exodus Movement, Inc.",
-  "license": "UNLICENSED",
+  "license": "MIT",
   "scripts": {
     "test": "run -T exodus-test --jest",
     "lint": "run -T eslint -c ../../eslint.config.mjs",
@@ -33,12 +33,11 @@
     "url": "https://github.com/ExodusMovement/exodus-hydra/issues?q=is%3Aissue+is%3Aopen+label%3Abalances"
   },
   "dependencies": {
-    "@exodus/atoms": "^8.1.1",
+    "@exodus/atoms": "^9.0.0",
     "@exodus/basic-utils": "^3.0.1",
     "@exodus/core-selectors": "^3.0.0",
     "@exodus/currency": "^5.0.2",
     "@exodus/models": "^12.0.1",
-    "@exodus/module": "^1.3.0",
     "@exodus/multi-account-redux": "^2.0.1",
     "@exodus/redux-dependency-injection": "^4.0.3",
     "@exodus/typeforce": "^1.18.0",
@@ -52,17 +51,19 @@
   "devDependencies": {
     "@exodus/assets": "^11.0.0",
     "@exodus/assets-base": "^10.0.0",
-    "@exodus/assets-feature": "^5.11.3",
-    "@exodus/available-assets": "^8.5.0",
+    "@exodus/assets-feature": "^5.14.1",
+    "@exodus/available-assets": "^8.7.0",
     "@exodus/bitcoin-meta": "^2.0.0",
-    "@exodus/blockchain-metadata": "^15.5.0",
+    "@exodus/blockchain-metadata": "^15.7.0",
     "@exodus/ethereum-meta": "^2.0.0",
-    "@exodus/fee-data-monitors": "^4.3.0",
-    "@exodus/redux-dependency-injection": "workspace:^",
-    "@exodus/storage-memory": "^2.2.0",
-    "@exodus/wallet-accounts": "^16.10.2",
+    "@exodus/fee-data-monitors": "^5.0.2",
+    "@exodus/storage-memory": "^2.2.2",
+    "@exodus/wallet-accounts": "^17.1.1",
     "events": "^3.3.0",
     "redux": "^4.2.1"
   },
-  "gitHead": "de12d93c6e9cea90a07137a932dccd255226d92f"
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "d979dacecad62ad66a5761afc08d6ea362ca05a5"
 }

package/plugins/analytics.js

@@ -2,9 +2,16 @@ const createBalancesAnalyticsPlugin = ({
   analytics,
   hasBalanceAtom,
   assetsWithBalanceCountAtom,
+  assetsTotalWalletAmountsAtom,
+  config: { assetsToTrackForBalances },
 }) => {
   let subscriptions = []
 
+  const getAssetAmountFromNumberUnit = (unit) => {
+    if (!unit) return 0
+    return unit.toDefaultNumber()
+  }
+
   const onStart = () => {
     analytics.requireDefaultEventProperties(['hasBalance', 'numberOfAssets'])
 
@@ -16,7 +23,19 @@ const createBalancesAnalyticsPlugin = ({
       analytics.setDefaultEventProperties({ numberOfAssets })
     )
 
-    subscriptions = [unsubscribeBalanceAtom, unsubscribeBalanceCountAtom]
+    const unsubscribeWalletAmountsAtom = assetsTotalWalletAmountsAtom.observe(async (balances) => {
+      const assetBalances = assetsToTrackForBalances.reduce((acc, obj) => {
+        acc[obj.analyticsName] = getAssetAmountFromNumberUnit(balances.get(obj.assetName))
+        return acc
+      }, {})
+      analytics.setDefaultEventProperties(assetBalances)
+    })
+
+    subscriptions = [
+      unsubscribeBalanceAtom,
+      unsubscribeBalanceCountAtom,
+      unsubscribeWalletAmountsAtom,
+    ]
   }
 
   const onStop = () => {

package/plugins/index.js

@@ -13,6 +13,12 @@ export const balancesAnalyticsPluginDefinition = {
   id: 'balancesAnalyticsPlugin',
   type: 'plugin',
   factory: createBalancesAnalyticsPlugin,
-  dependencies: ['analytics', 'hasBalanceAtom', 'assetsWithBalanceCountAtom'],
+  dependencies: [
+    'analytics',
+    'hasBalanceAtom',
+    'assetsWithBalanceCountAtom',
+    'assetsTotalWalletAmountsAtom',
+    'config?',
+  ],
   public: true,
 }