Skip to content

chore: adds two metric events for multichain transactions #15021

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions app/core/Analytics/MetaMetrics.events.ts
Original file line number Diff line number Diff line change
Expand Up @@ -315,6 +315,8 @@ enum EVENT_NAME {
UNSTAKE_TRANSACTION_SUBMITTED = 'Unstake Transaction Submitted',
VISITED_ETH_OVERVIEW_WITH_STAKED_POSITIONS = 'Visited ETH Overview with Staked Positions',
EARN_TOKEN_LIST_ITEM_CLICKED = 'Earn Token List Item Clicked',
TRANSACTION_SUBMITTED = 'Transaction Submitted',
TRANSACTION_FINALIZED = 'Transaction Finalized',

// Force Upgrade | Automatic Security Checks
FORCE_UPGRADE_UPDATE_NEEDED_PROMPT_VIEWED = 'Force Upgrade Update Needed Prompt Viewed',
Expand Down Expand Up @@ -1025,6 +1027,10 @@ const events = {
// Bridge
BRIDGE_PAGE_VIEWED: generateOpt(EVENT_NAME.BRIDGE_PAGE_VIEWED),
SWAP_PAGE_VIEWED: generateOpt(EVENT_NAME.SWAP_PAGE_VIEWED), // Temporary event until unified swap/bridge is done

// Transactions
TRANSACTION_SUBMITTED: generateOpt(EVENT_NAME.TRANSACTION_SUBMITTED),
TRANSACTION_FINALIZED: generateOpt(EVENT_NAME.TRANSACTION_FINALIZED),
};

/**
Expand Down
41 changes: 41 additions & 0 deletions app/core/Engine/Engine.ts
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,9 @@ import {
import { AccountsController } from '@metamask/accounts-controller';
import { AddressBookController } from '@metamask/address-book-controller';
import { ComposableController } from '@metamask/composable-controller';
///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps)
import { Transaction } from '@metamask/keyring-api';
///: END:ONLY_INCLUDE_IF
import {
KeyringController,
KeyringControllerState,
Expand Down Expand Up @@ -1475,6 +1478,44 @@ export class Engine {
},
);

///: BEGIN:ONLY_INCLUDE_IF(keyring-snaps)
this.controllerMessenger.subscribe(
'MultichainTransactionsController:transactionConfirmed',
(transaction: Transaction) => {
MetaMetrics.getInstance().trackEvent(
MetricsEventBuilder.createEventBuilder(MetaMetricsEvents.TRANSACTION_FINALIZED)
.addProperties({
id: transaction.id,
timestamp: transaction.timestamp,
chain_id_caip: transaction.chain,
status: transaction.status,
type: transaction.type,
fees: transaction.fees,
})
.build()
);
},
);

this.controllerMessenger.subscribe(
'MultichainTransactionsController:transactionSubmitted',
(transaction: Transaction) => {
MetaMetrics.getInstance().trackEvent(
MetricsEventBuilder.createEventBuilder(MetaMetricsEvents.TRANSACTION_SUBMITTED)
.addProperties({
id: transaction.id,
timestamp: transaction.timestamp,
chain_id_caip: transaction.chain,
status: transaction.status,
type: transaction.type,
fees: transaction.fees,
})
.build()
);
},
);
///: END:ONLY_INCLUDE_IF

///: BEGIN:ONLY_INCLUDE_IF(preinstalled-snaps,external-snaps)
this.controllerMessenger.subscribe(
`${snapController.name}:snapTerminated`,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ import {
AccountsControllerAccountTransactionsUpdatedEvent,
} from '@metamask/accounts-controller';
import { HandleSnapRequest } from '@metamask/snaps-controllers';

import { Transaction } from '@metamask/keyring-api';
export type MultichainTransactionsControllerActions =
| AccountsControllerListMultichainAccountsAction
| HandleSnapRequest;
Expand All @@ -17,4 +17,12 @@ export type MultichainTransactionsControllerEvents =
| {
type: 'MultichainTransactionsController:stateChange';
payload: [unknown];
};
}
| {
type: 'MultichainTransactionsController:transactionConfirmed';
payload: [Transaction];
}
| {
type: 'MultichainTransactionsController:transactionSubmitted';
payload: [Transaction];
};
Loading