@exodus/balances 13.4.0 → 13.5.0

package/CHANGELOG.md

@@ -3,6 +3,12 @@
 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

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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@exodus/balances",
-  "version": "13.4.0",
+  "version": "13.5.0",
   "description": "Tracks crypto balances across enabled wallet accounts.",
   "author": "Exodus Movement, Inc.",
   "license": "MIT",
@@ -65,5 +65,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "901254d521ab3c43da0be4a4537ed80015e1c6b9"
+  "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,
 }