feat(positions): add super properties to track positions data (#3820)

### Description

This adds new super properties to track data related to positions.

### Test plan

- Updated unit tests

### Related issues

- Fixes RET-713

### Backwards compatibility

Yes

Author: jeanregisser

src/analytics/ValoraAnalytics.test.ts

@@ -3,13 +3,14 @@ import { PincodeType } from 'src/account/reducer'
 import { HomeEvents } from 'src/analytics/Events'
 import ValoraAnalyticsModule from 'src/analytics/ValoraAnalytics'
 import { store } from 'src/redux/store'
-import { getDefaultStatsigUser } from 'src/statsig'
+import { getDefaultStatsigUser, getFeatureGate } from 'src/statsig'
 import { Statsig } from 'statsig-react-native'
 import { getMockStoreData } from 'test/utils'
 import {
   mockCeloAddress,
   mockCeurAddress,
   mockCusdAddress,
+  mockPositions,
   mockTestTokenAddress,
 } from 'test/values'
 import { mocked } from 'ts-jest/utils'
@@ -94,6 +95,9 @@ const state = getMockStoreData({
       },
     },
   },
+  positions: {
+    positions: mockPositions,
+  },
   web3: {
     account: mockWalletAddress,
     mtwAddress: null,
@@ -127,13 +131,19 @@ const defaultSuperProperties = {
   sHasVerifiedNumberCPV: true,
   sLanguage: 'es-419',
   sLocalCurrencyCode: 'PHP',
+  sNetWorthUsd: 43.910872728527195,
   sOtherTenTokens: 'UBE:1,TT:10',
   sPhoneCountryCallingCode: '+1',
   sPhoneCountryCodeAlpha2: 'US',
   sPincodeType: 'CustomPin',
+  sPositionsAppsCount: 1,
+  sPositionsCount: 3,
+  sPositionsTopTenApps: 'ubeswap:7.91',
   sPrevScreenId: undefined,
   sTokenCount: 4,
+  sTopTenPositions: 'ubeswap-G$ / cUSD:4.08,ubeswap-MOO / CELO:2.51,ubeswap-CELO / cUSD:1.32',
   sTotalBalanceUsd: 36,
+  sTotalPositionsBalanceUsd: 7.910872728527196,
   sWalletAddress: mockWalletAddress.toLowerCase(), // test for backwards compatibility (this field is lower-cased)
   sSuperchargingAmountInUsd: 24,
   sSuperchargingToken: 'cEUR',
@@ -173,6 +183,7 @@ describe('ValoraAnalytics', () => {
       ValoraAnalytics = require('src/analytics/ValoraAnalytics').default
     })
     mockStore.getState.mockImplementation(() => state)
+    mocked(getFeatureGate).mockReturnValue(true)
   })
 
   it('creates statsig client on initialization with default statsig user', async () => {

src/analytics/selectors.test.ts

@@ -1,6 +1,15 @@
 import { PincodeType } from 'src/account/reducer'
 import { getCurrentUserTraits } from 'src/analytics/selectors'
+import { getFeatureGate } from 'src/statsig'
 import { getMockStoreData } from 'test/utils'
+import { mocked } from 'ts-jest/utils'
+
+jest.mock('src/statsig')
+
+beforeEach(() => {
+  jest.clearAllMocks()
+  mocked(getFeatureGate).mockReturnValue(true)
+})
 
 describe('getCurrentUserTraits', () => {
   it('returns the current user traits', () => {
@@ -167,6 +176,60 @@ describe('getCurrentUserTraits', () => {
           },
         },
       },
+      positions: {
+        positions: [
+          {
+            type: 'contract-position',
+            network: 'celo',
+            address: '0xa',
+            appId: 'a',
+            displayProps: {
+              title: 'Title A',
+            },
+            balanceUsd: '10',
+          },
+          {
+            type: 'contract-position',
+            network: 'celo',
+            address: '0xb',
+            appId: 'b',
+            displayProps: {
+              title: 'Title B',
+            },
+            balanceUsd: '1.11',
+          },
+          {
+            type: 'contract-position',
+            network: 'celo',
+            address: '0xc',
+            appId: 'c',
+            displayProps: {
+              title: 'Title C',
+            },
+            balanceUsd: '2.22',
+          },
+          {
+            type: 'contract-position',
+            network: 'celo',
+            address: '0xd',
+            appId: 'd',
+            displayProps: {
+              title: 'Title D which is really long and should be truncated',
+            },
+            balanceUsd: '0.01234',
+          },
+          {
+            type: 'contract-position',
+            network: 'celo',
+            address: '0xe',
+            appId: 'b',
+            displayProps: {
+              title: 'Title E',
+            },
+            balanceUsd: '70',
+          },
+        ],
+      },
     })
     expect(getCurrentUserTraits(state)).toStrictEqual({
       accountAddress: '0x123',
@@ -184,12 +247,19 @@ describe('getCurrentUserTraits', () => {
       hasVerifiedNumberCPV: true,
       language: 'es-419',
       localCurrencyCode: 'PHP',
+      netWorthUsd: 5764.949123945,
       otherTenTokens: 'I:1000,K:80,0xi:11.003,G:10,H:9.12345,E:7,F:6,B:3,C:2,A:1',
       phoneCountryCallingCode: '+33',
       phoneCountryCodeAlpha2: 'FR',
       pincodeType: 'CustomPin',
+      positionsAppsCount: 4,
+      positionsCount: 5,
+      positionsTopTenApps: 'b:71.11,a:10.00,c:2.22,d:0.01',
       tokenCount: 13,
+      topTenPositions:
+        'b-Title E:70.00,a-Title A:10.00,c-Title C:2.22,b-Title B:1.11,d-Title D which is rea:0.01',
       totalBalanceUsd: 5681.606783945,
+      totalPositionsBalanceUsd: 83.34234,
       walletAddress: '0x0000000000000000000000000000000000007e57',
       superchargingToken: 'cEUR',
       superchargingAmountInUsd: 25.9245,

src/analytics/selectors.ts

@@ -10,19 +10,70 @@ import { superchargeInfoSelector } from 'src/consumerIncentives/selectors'
 import { currentLanguageSelector } from 'src/i18n/selectors'
 import { getLocalCurrencyCode } from 'src/localCurrency/selectors'
 import { userLocationDataSelector } from 'src/networkInfo/selectors'
+import { getPositionBalanceUsd } from 'src/positions/getPositionBalanceUsd'
+import {
+  positionsByBalanceUsdSelector,
+  totalPositionsBalanceUsdSelector,
+} from 'src/positions/selectors'
 import { coreTokensSelector, tokensWithTokenBalanceSelector } from 'src/tokens/selectors'
 import { sortByUsdBalance } from 'src/tokens/utils'
 import { mtwAddressSelector, rawWalletAddressSelector } from 'src/web3/selectors'
 
+const tokensSelector = createSelector(
+  [tokensWithTokenBalanceSelector, coreTokensSelector],
+  (tokens, coreTokens) => ({ tokens, coreTokens })
+)
+
+const positionsAnalyticsSelector = createSelector(
+  [positionsByBalanceUsdSelector, totalPositionsBalanceUsdSelector],
+  (positionsByUsdBalance, totalPositionsBalanceUsd) => {
+    const appsByBalanceUsd: Record<string, BigNumber> = {}
+    for (const position of positionsByUsdBalance) {
+      const appId = position.appId
+      const positionBalanceUsd = getPositionBalanceUsd(position)
+      if (appsByBalanceUsd[appId]) {
+        appsByBalanceUsd[appId] = appsByBalanceUsd[appId].plus(positionBalanceUsd)
+      } else {
+        appsByBalanceUsd[appId] = positionBalanceUsd
+      }
+    }
+
+    return {
+      totalPositionsBalanceUsd: totalPositionsBalanceUsd?.toNumber() ?? 0,
+      positionsCount: positionsByUsdBalance.length,
+      // Example: "ubeswap-cUSD / CELO:100.00,halofi-Hold CELO:50.00"
+      topTenPositions: positionsByUsdBalance
+        .slice(0, 10)
+        .map(
+          (position) =>
+            // Note: title could be localized and can contain any character
+            // But is best to get a sense of what the position is (without looking up address)
+            // Also truncate the title to avoid reaching the 255 chars limit
+            `${position.appId}-${position.displayProps.title.slice(0, 20)}:${getPositionBalanceUsd(
+              position
+            ).toFixed(2)}`
+        )
+        .join(','),
+      positionsAppsCount: new Set(positionsByUsdBalance.map((position) => position.appId)).size,
+      // Example: "ubeswap:100.00,halofi:50.00"
+      positionsTopTenApps: Object.entries(appsByBalanceUsd)
+        .sort(([, balanceUsd1], [, balanceUsd2]) => balanceUsd2.comparedTo(balanceUsd1))
+        .slice(0, 10)
+        .map(([appId, balanceUsd]) => `${appId}:${balanceUsd.toFixed(2)}`)
+        .join(','),
+    }
+  }
+)
+
 export const getCurrentUserTraits = createSelector(
   [
     rawWalletAddressSelector,
     mtwAddressSelector,
     defaultCountryCodeSelector,
     userLocationDataSelector,
     currentLanguageSelector,
-    tokensWithTokenBalanceSelector,
-    coreTokensSelector,
+    tokensSelector,
+    positionsAnalyticsSelector,
     getLocalCurrencyCode,
     phoneVerificationStatusSelector,
     backupCompletedSelector,
@@ -35,8 +86,14 @@ export const getCurrentUserTraits = createSelector(
     phoneCountryCallingCode,
     { countryCodeAlpha2 },
     language,
-    tokens,
-    coreTokens,
+    { tokens, coreTokens },
+    {
+      totalPositionsBalanceUsd,
+      positionsCount,
+      topTenPositions,
+      positionsAppsCount,
+      positionsTopTenApps,
+    },
     localCurrencyCode,
     { numberVerifiedDecentralized, numberVerifiedCentralized },
     hasCompletedBackup,
@@ -68,7 +125,8 @@ export const getCurrentUserTraits = createSelector(
       countryCodeAlpha2,
       language,
       deviceLanguage: RNLocalize.getLocales()[0]?.languageTag, // Example: "en-GB"
-      totalBalanceUsd: totalBalanceUsd?.toNumber(),
+      netWorthUsd: new BigNumber(totalBalanceUsd).plus(totalPositionsBalanceUsd).toNumber(), // Tokens + positions
+      totalBalanceUsd: totalBalanceUsd?.toNumber(), // Only tokens (with a USD price), no positions
       tokenCount: tokensByUsdBalance.length,
       otherTenTokens: tokensByUsdBalance
         .filter((token) => !coreTokensAddresses.has(token.address))
@@ -89,6 +147,11 @@ export const getCurrentUserTraits = createSelector(
           token.balance.toNumber(),
         ])
       ),
+      totalPositionsBalanceUsd,
+      positionsCount,
+      topTenPositions,
+      positionsAppsCount,
+      positionsTopTenApps,
       localCurrencyCode,
       hasVerifiedNumber: numberVerifiedDecentralized,
       hasVerifiedNumberCPV: numberVerifiedCentralized,

src/positions/getPositionBalanceUsd.ts

@@ -0,0 +1,14 @@
+import BigNumber from 'bignumber.js'
+import { Position } from 'src/positions/types'
+
+export function getPositionBalanceUsd(position: Position): BigNumber {
+  let balanceUsd
+  if (position.type === 'app-token') {
+    const balance = new BigNumber(position.balance)
+    balanceUsd = balance.multipliedBy(position.priceUsd)
+  } else {
+    balanceUsd = new BigNumber(position.balanceUsd)
+  }
+
+  return balanceUsd
+}

src/positions/selectors.test.ts

@@ -1,5 +1,9 @@
 import BigNumber from 'bignumber.js'
-import { totalPositionsBalanceUsdSelector } from 'src/positions/selectors'
+import { getPositionBalanceUsd } from 'src/positions/getPositionBalanceUsd'
+import {
+  positionsByBalanceUsdSelector,
+  totalPositionsBalanceUsdSelector,
+} from 'src/positions/selectors'
 import { getFeatureGate } from 'src/statsig'
 import { mockPositions } from 'test/values'
 import { mocked } from 'ts-jest/utils'
@@ -11,7 +15,7 @@ beforeEach(() => {
   mocked(getFeatureGate).mockReturnValue(true)
 })
 
-describe(totalPositionsBalanceUsdSelector, () => {
+describe('totalPositionsBalanceUsdSelector', () => {
   it('returns the total balance of all positions', () => {
     const state: any = {
       positions: {
@@ -43,3 +47,45 @@ describe(totalPositionsBalanceUsdSelector, () => {
     expect(total).toBeNull()
   })
 })
+
+describe('positionsByBalanceUsdSelector', () => {
+  it('returns the positions sorted by USD balance in descending order', () => {
+    const state: any = {
+      positions: {
+        positions: mockPositions,
+      },
+    }
+    const positions = positionsByBalanceUsdSelector(state)
+    expect(
+      positions.map((position) => {
+        return {
+          appId: position.appId,
+          address: position.address,
+          title: position.displayProps.title,
+          balanceUsd: getPositionBalanceUsd(position),
+        }
+      })
+    ).toMatchInlineSnapshot(`
+      Array [
+        Object {
+          "address": "0x31f9dee850b4284b81b52b25a3194f2fc8ff18cf",
+          "appId": "ubeswap",
+          "balanceUsd": "4.0802397095730601528429330911456",
+          "title": "G$ / cUSD",
+        },
+        Object {
+          "address": "0x19a75250c5a3ab22a8662e55a2b90ff9d3334b00",
+          "appId": "ubeswap",
+          "balanceUsd": "2.5098739934779290118396726809999",
+          "title": "MOO / CELO",
+        },
+        Object {
+          "address": "0xda7f463c27ec862cfbf2369f3f74c364d050d93f",
+          "appId": "ubeswap",
+          "balanceUsd": "1.3207590254762067",
+          "title": "CELO / cUSD",
+        },
+      ]
+    `)
+  })
+})