Skip to content

Commit

Permalink
Merge pull request #551 from lidofinance/feature/si-952-rework-metrics
Browse files Browse the repository at this point in the history 
feat: reef-knot metrics config updated
  • Loading branch information
@jake4take
jake4take authored Dec 2, 2024
2 parents 706f3b3 + 597b549 commit e7b3459
Show file tree
Hide file tree
Showing 4 changed files with 192 additions and 385 deletions.
317 changes: 62 additions & 255 deletions consts/matomo-wallets-events.ts
View file
Original file line number Diff line number Diff line change
@@ -1,263 +1,70 @@
import { MatomoEventType, trackEvent } from '@lidofinance/analytics-matomo';
import { MetricsProp } from '@reef-knot/types';
import { WalletIdsEthereum } from 'reef-knot/wallets';
import { trackEvent } from '@lidofinance/analytics-matomo';
import type { ReefKnotWalletsModalConfig } from '@reef-knot/types';
import type { WalletIdsEthereum } from '@reef-knot/wallets-list';
import { MATOMO_CLICK_EVENTS } from './matomo-click-events';

export const enum MATOMO_WALLETS_EVENTS_TYPES {
onClickAmbire = 'onClickAmbire',
onConnectAmbire = 'onConnectAmbire',
onClickBrave = 'onClickBrave',
onConnectBrave = 'onConnectBrave',
onClickCoin98 = 'onClickCoin98',
onConnectCoin98 = 'onConnectCoin98',
onClickCoinbase = 'onClickCoinbase',
onClickCoinbaseSmartWallet = 'onClickCoinbaseSmartWallet',
onConnectCoinbase = 'onConnectCoinbase',
onConnectCoinbaseSmartWallet = 'onConnectCoinbaseSmartWallet',
onClickExodus = 'onClickExodus',
onConnectExodus = 'onConnectExodus',
onClickImToken = 'onClickImToken',
onConnectImToken = 'onConnectImToken',
onClickLedger = 'onClickLedger',
onConnectLedger = 'onConnectLedger',
onClickMetamask = 'onClickMetamask',
onConnectMetamask = 'onConnectMetamask',
onClickTrust = 'onClickTrust',
onConnectTrust = 'onConnectTrust',
onClickWC = 'onClickWC',
onConnectWC = 'onConnectWC',
onClickXdefi = 'onClickXdefi',
onConnectXdefi = 'onConnectXdefi',
onClickOkx = 'onClickOkx',
onConnectOkx = 'onConnectOkx',
onClickBitget = 'onClickBitget',
onConnectBitget = 'onConnectBitget',
onClickBrowser = 'onClickBrowser',
onConnectBrowser = 'onConnectBrowser',
onClickBinance = 'onClickBinance',
onConnectBinance = 'onConnectBinance',
}
type MetricProps = Pick<
ReefKnotWalletsModalConfig<WalletIdsEthereum>,
| 'onClickTermsAccept'
| 'onClickWalletsMore'
| 'onClickWalletsLess'
| 'onConnectStart'
| 'onConnectSuccess'
>;

export const MATOMO_WALLETS_EVENTS: Record<
MATOMO_WALLETS_EVENTS_TYPES,
MatomoEventType
> = {
[MATOMO_WALLETS_EVENTS_TYPES.onClickAmbire]: [
'Ethereum_Staking_Widget',
'Click on Ambire wallet',
'eth_widget_click_ambire',
],
[MATOMO_WALLETS_EVENTS_TYPES.onConnectAmbire]: [
'Ethereum_Staking_Widget',
'Connect Ambire wallet',
'eth_widget_connect_ambire',
],
[MATOMO_WALLETS_EVENTS_TYPES.onClickBrave]: [
'Ethereum_Staking_Widget',
'Click Brave wallet',
'eth_widget_click_brave',
],
[MATOMO_WALLETS_EVENTS_TYPES.onConnectBrave]: [
'Ethereum_Staking_Widget',
'Connect Brave wallet',
'eth_widget_connect_brave',
],
[MATOMO_WALLETS_EVENTS_TYPES.onClickCoin98]: [
'Ethereum_Staking_Widget',
'Click Coin98 wallet',
'eth_widget_click_coin98',
],
[MATOMO_WALLETS_EVENTS_TYPES.onConnectCoin98]: [
'Ethereum_Staking_Widget',
'Connect Coin98 wallet',
'eth_widget_connect_coin98',
],
[MATOMO_WALLETS_EVENTS_TYPES.onClickCoinbase]: [
'Ethereum_Staking_Widget',
'Click Coinbase Wallet wallet',
'eth_widget_click_coinbase_wallet',
],
[MATOMO_WALLETS_EVENTS_TYPES.onConnectCoinbase]: [
'Ethereum_Staking_Widget',
'Connect Coinbase Wallet wallet',
'eth_widget_connect_coinbase_wallet',
],
[MATOMO_WALLETS_EVENTS_TYPES.onClickCoinbaseSmartWallet]: [
'Ethereum_Staking_Widget',
'Click Coinbase Smart Wallet wallet',
'eth_widget_click_coinbase_smart_wallet',
],
[MATOMO_WALLETS_EVENTS_TYPES.onConnectCoinbaseSmartWallet]: [
'Ethereum_Staking_Widget',
'Connect Coinbase Smart Wallet wallet',
'eth_widget_connect_coinbase_smart_wallet',
],
[MATOMO_WALLETS_EVENTS_TYPES.onClickExodus]: [
'Ethereum_Staking_Widget',
'Click Exodus wallet',
'eth_widget_click_exodus',
],
[MATOMO_WALLETS_EVENTS_TYPES.onConnectExodus]: [
'Ethereum_Staking_Widget',
'Connect Exodus wallet',
'eth_widget_connect_exodus',
],
[MATOMO_WALLETS_EVENTS_TYPES.onClickImToken]: [
'Ethereum_Staking_Widget',
'Click imToken wallet',
'eth_widget_click_imtoken',
],
[MATOMO_WALLETS_EVENTS_TYPES.onConnectImToken]: [
'Ethereum_Staking_Widget',
'Connect imToken wallet',
'eth_widget_connect_imtoken',
],
[MATOMO_WALLETS_EVENTS_TYPES.onClickLedger]: [
'Ethereum_Staking_Widget',
'Click Ledger wallet',
'eth_widget_click_ledger',
],
[MATOMO_WALLETS_EVENTS_TYPES.onConnectLedger]: [
'Ethereum_Staking_Widget',
'Connect Ledger wallet',
'eth_widget_connect_ledger',
],
[MATOMO_WALLETS_EVENTS_TYPES.onClickMetamask]: [
'Ethereum_Staking_Widget',
'Click Metamask wallet',
'eth_widget_click_metamask',
],
[MATOMO_WALLETS_EVENTS_TYPES.onConnectMetamask]: [
'Ethereum_Staking_Widget',
'Connect Metamask wallet',
'eth_widget_connect_metamask',
],
[MATOMO_WALLETS_EVENTS_TYPES.onClickTrust]: [
'Ethereum_Staking_Widget',
'Click Trust wallet',
'eth_widget_click_trust',
],
[MATOMO_WALLETS_EVENTS_TYPES.onConnectTrust]: [
'Ethereum_Staking_Widget',
'Connect Trust wallet',
'eth_widget_connect_trust',
],
[MATOMO_WALLETS_EVENTS_TYPES.onClickWC]: [
'Ethereum_Staking_Widget',
'Click WalletConnect wallet',
'eth_widget_click_walletconnect',
],
[MATOMO_WALLETS_EVENTS_TYPES.onConnectWC]: [
'Ethereum_Staking_Widget',
'Connect WalletConnect wallet',
'eth_widget_connect_walletconnect',
],
[MATOMO_WALLETS_EVENTS_TYPES.onClickXdefi]: [
'Ethereum_Staking_Widget',
'Click XDEFI wallet',
'eth_widget_click_xdefi',
],
[MATOMO_WALLETS_EVENTS_TYPES.onConnectXdefi]: [
'Ethereum_Staking_Widget',
'Connect XDEFI wallet',
'eth_widget_connect_xdefi',
],
[MATOMO_WALLETS_EVENTS_TYPES.onClickOkx]: [
'Ethereum_Staking_Widget',
'Click OKX wallet',
'eth_widget_click_okx',
],
[MATOMO_WALLETS_EVENTS_TYPES.onConnectOkx]: [
'Ethereum_Staking_Widget',
'Connect OKX wallet',
'eth_widget_connect_okx',
],
[MATOMO_WALLETS_EVENTS_TYPES.onClickBitget]: [
'Ethereum_Staking_Widget',
'Click BitGet wallet',
'eth_widget_click_bitget',
],
[MATOMO_WALLETS_EVENTS_TYPES.onConnectBitget]: [
'Ethereum_Staking_Widget',
'Connect BitGet wallet',
'eth_widget_connect_bitget',
],
[MATOMO_WALLETS_EVENTS_TYPES.onClickBrowser]: [
'Ethereum_Staking_Widget',
'Click Browser wallet',
'eth_widget_click_browser',
],
[MATOMO_WALLETS_EVENTS_TYPES.onConnectBrowser]: [
'Ethereum_Staking_Widget',
'Connect Browser wallet',
'eth_widget_connect_browser',
],
[MATOMO_WALLETS_EVENTS_TYPES.onClickBinance]: [
'Ethereum_Staking_Widget',
'Click Binance Web3 wallet',
'eth_widget_click_binance_web3',
],
[MATOMO_WALLETS_EVENTS_TYPES.onConnectBinance]: [
'Ethereum_Staking_Widget',
'Connect Binance Web3 wallet',
'eth_widget_connect_binance_web3_wallet',
],
type EventsData = Partial<Record<WalletIdsEthereum, [string, string]>>;

const EVENTS_DATA_CONNECT_START: EventsData = {
ambire: ['on Ambire', 'ambire'],
binanceWallet: ['Binance Web3', 'binance_web3'],
bitget: ['BitGet', 'bitget'],
brave: ['Brave', 'brave'],
browserExtension: ['Browser', 'browser'],
coin98: ['Coin98', 'coin98'],
coinbase: ['Coinbase Wallet', 'coinbase_wallet'],
coinbaseSmartWallet: ['Coinbase Smart Wallet', 'coinbase_smart_wallet'],
exodus: ['Exodus', 'exodus'],
imToken: ['imToken', 'imtoken'],
ledgerHID: ['Ledger', 'ledger'],
metaMask: ['Metamask', 'metamask'],
okx: ['OKX', 'okx'],
trust: ['Trust', 'trust'],
walletConnect: ['WalletConnect', 'walletconnect'],
xdefi: ['XDEFI', 'xdefi'],
} as const;

const EVENTS_DATA_CONNECT_SUCCESS: EventsData = {
...EVENTS_DATA_CONNECT_START,
ambire: ['Ambire', 'ambire'],
binanceWallet: ['Binance Web3', 'binance_web3_wallet'],
};

const getMetricHandler = (event: Parameters<typeof trackEvent>) => () =>
trackEvent(...event);
export const walletMetricProps: MetricProps = {
onClickWalletsLess: () =>
trackEvent(...MATOMO_CLICK_EVENTS.clickShowLessWallets),

onClickWalletsMore: () =>
trackEvent(...MATOMO_CLICK_EVENTS.clickShowMoreWallets),

onConnectStart: ({ walletId }) => {
const eventData = EVENTS_DATA_CONNECT_START[walletId];
if (eventData) {
trackEvent(
'Ethereum_Staking_Widget',
`Click ${eventData[0]} wallet`,
`eth_widget_click_${eventData[1]}`,
);
}
},

export const walletsMetrics: MetricsProp<WalletIdsEthereum> = {
events: {
click: {
handlers: {
ambire: getMetricHandler(MATOMO_WALLETS_EVENTS.onClickAmbire),
brave: getMetricHandler(MATOMO_WALLETS_EVENTS.onClickBrave),
coin98: getMetricHandler(MATOMO_WALLETS_EVENTS.onClickCoin98),
coinbase: getMetricHandler(MATOMO_WALLETS_EVENTS.onClickCoinbase),
coinbaseSmartWallet: getMetricHandler(
MATOMO_WALLETS_EVENTS.onClickCoinbaseSmartWallet,
),
exodus: getMetricHandler(MATOMO_WALLETS_EVENTS.onClickExodus),
imToken: getMetricHandler(MATOMO_WALLETS_EVENTS.onClickImToken),
ledgerHID: getMetricHandler(MATOMO_WALLETS_EVENTS.onClickLedger),
metaMask: getMetricHandler(MATOMO_WALLETS_EVENTS.onClickMetamask),
trust: getMetricHandler(MATOMO_WALLETS_EVENTS.onClickTrust),
walletConnect: getMetricHandler(MATOMO_WALLETS_EVENTS.onClickWC),
xdefi: getMetricHandler(MATOMO_WALLETS_EVENTS.onClickXdefi),
okx: getMetricHandler(MATOMO_WALLETS_EVENTS.onClickOkx),
bitget: getMetricHandler(MATOMO_WALLETS_EVENTS.onClickBitget),
browserExtension: getMetricHandler(
MATOMO_WALLETS_EVENTS.onClickBrowser,
),
binanceWallet: getMetricHandler(MATOMO_WALLETS_EVENTS.onClickBinance),
walletsLess: getMetricHandler(MATOMO_CLICK_EVENTS.clickShowLessWallets),
walletsMore: getMetricHandler(MATOMO_CLICK_EVENTS.clickShowMoreWallets),
},
},
connect: {
handlers: {
ambire: getMetricHandler(MATOMO_WALLETS_EVENTS.onConnectAmbire),
brave: getMetricHandler(MATOMO_WALLETS_EVENTS.onConnectBrave),
coin98: getMetricHandler(MATOMO_WALLETS_EVENTS.onConnectCoin98),
coinbase: getMetricHandler(MATOMO_WALLETS_EVENTS.onConnectCoinbase),
coinbaseSmartWallet: getMetricHandler(
MATOMO_WALLETS_EVENTS.onConnectCoinbaseSmartWallet,
),
exodus: getMetricHandler(MATOMO_WALLETS_EVENTS.onConnectExodus),
imToken: getMetricHandler(MATOMO_WALLETS_EVENTS.onConnectImToken),
ledgerHID: getMetricHandler(MATOMO_WALLETS_EVENTS.onConnectLedger),
metaMask: getMetricHandler(MATOMO_WALLETS_EVENTS.onConnectMetamask),
trust: getMetricHandler(MATOMO_WALLETS_EVENTS.onConnectTrust),
walletConnect: getMetricHandler(MATOMO_WALLETS_EVENTS.onConnectWC),
xdefi: getMetricHandler(MATOMO_WALLETS_EVENTS.onConnectXdefi),
okx: getMetricHandler(MATOMO_WALLETS_EVENTS.onConnectOkx),
bitget: getMetricHandler(MATOMO_WALLETS_EVENTS.onConnectBitget),
browserExtension: getMetricHandler(
MATOMO_WALLETS_EVENTS.onConnectBrowser,
),
binanceWallet: getMetricHandler(MATOMO_WALLETS_EVENTS.onConnectBinance),
},
},
onConnectSuccess: ({ walletId }) => {
const eventData = EVENTS_DATA_CONNECT_SUCCESS[walletId];
if (eventData) {
trackEvent(
'Ethereum_Staking_Widget',
`Connect ${eventData[0]}`,
`eth_widget_connect_${eventData[1]}`,
);
}
},
};
4 changes: 2 additions & 2 deletions modules/web3/web3-provider/web3-provider.tsx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ import { config } from 'config';
import { useUserConfig } from 'config/user-config';
import { useGetRpcUrlByChainId } from 'config/rpc';
import { CHAINS } from 'consts/chains';
import { walletsMetrics } from 'consts/matomo-wallets-events';
import { walletMetricProps } from 'consts/matomo-wallets-events';

import { useWeb3Transport } from './use-web3-transport';
import { LidoSDKProvider } from './lido-sdk';
Expand Down Expand Up @@ -104,7 +104,7 @@ export const Web3Provider: FC<PropsWithChildren> = ({ children }) => {

// Wallets config args
...getDefaultWalletsModalConfig(),
metrics: walletsMetrics,
...walletMetricProps,
walletsPinned: WALLETS_PINNED,
});
}, [
Expand Down
4 changes: 2 additions & 2 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
"@lidofinance/next-pages": "^0.45.1",
"@lidofinance/rpc": "^0.45.1",
"@lidofinance/satanizer": "^0.45.1",
"@reef-knot/types": "^3.0.0",
"@reef-knot/types": "^4.0.0",
"@tanstack/react-query": "^5.51.21",
"bignumber.js": "9.1.0",
"copy-to-clipboard": "^3.3.1",
Expand All @@ -70,7 +70,7 @@
"react-hook-form": "^7.45.2",
"react-is": "^18.2.0",
"react-transition-group": "^4.4.2",
"reef-knot": "6.0.3",
"reef-knot": "7.0.1",
"styled-components": "^5.3.5",
"swr": "^1.3.0",
"tiny-async-pool": "^1.2.0",
Expand Down
Loading

0 comments on commit e7b3459

Please sign in to comment.