feat: implement distinction between BumpFee RBF & Cancel RBF -> utili…

…se it to display error in case TX gets confirmed in cancel flow feat: extend reporting for 'canceled' event in sendform
trezor · Feb 11, 2025 · 817360d · 817360d
1 parent 1516375
commit 817360d
Show file tree

Hide file tree

Showing 17 changed files with 169 additions and 105 deletions.
diff --git a/packages/suite-analytics/src/types/events.ts b/packages/suite-analytics/src/types/events.ts
@@ -36,6 +36,24 @@ export type SuiteAnalyticsEventSuiteReady = {
     };
 };
 
+export type TransactionCreatedEvent = {
+    type: EventType.TransactionCreated;
+    payload: {
+        action: 'sent' | 'copied' | 'downloaded' | 'replaced' | 'canceled';
+        symbol: string;
+        tokens: string;
+        outputsCount: number;
+        broadcast: boolean;
+        bitcoinLockTime: boolean;
+        ethereumData: boolean;
+        ethereumNonce: boolean;
+        rippleDestinationTag: boolean;
+        selectedFee: string;
+        isCoinControlEnabled: boolean;
+        hasCoinControlBeenOpened: boolean;
+    };
+};
+
 export type SuiteAnalyticsEvent =
     | SuiteAnalyticsEventSuiteReady
     | {
@@ -198,23 +216,7 @@ export type SuiteAnalyticsEvent =
               type: 'exchange' | 'buy' | 'sell';
           };
       }
-    | {
-          type: EventType.TransactionCreated;
-          payload: {
-              action: 'sent' | 'copied' | 'downloaded' | 'replaced';
-              symbol: string;
-              tokens: string;
-              outputsCount: number;
-              broadcast: boolean;
-              bitcoinLockTime: boolean;
-              ethereumData: boolean;
-              ethereumNonce: boolean;
-              rippleDestinationTag: boolean;
-              selectedFee: string;
-              isCoinControlEnabled: boolean;
-              hasCoinControlBeenOpened: boolean;
-          };
-      }
+    | TransactionCreatedEvent
     | {
           type: EventType.SendRawTransaction;
           payload: {

diff --git a/packages/suite/src/actions/wallet/send/sendFormThunks.ts b/packages/suite/src/actions/wallet/send/sendFormThunks.ts
@@ -18,9 +18,9 @@ import {
     Account,
     FormState,
     GeneralPrecomposedTransactionFinal,
-    PrecomposedTransactionFinalRbf,
+    PrecomposedTransactionFinalBumpFeeRbf,
 } from '@suite-common/wallet-types';
-import { isCardanoTx, isRbfTransaction } from '@suite-common/wallet-utils';
+import { isCardanoTx, isRbfBumpFeeTransaction } from '@suite-common/wallet-utils';
 import { getSynchronize } from '@trezor/utils';
 
 import * as metadataLabelingActions from 'src/actions/suite/metadataLabelingActions';
@@ -100,7 +100,7 @@ const updateRbfLabelsThunk = createThunk(
             txid,
         }: {
             labelsToBeEdited: RbfLabelsToBeUpdated;
-            precomposedTransaction: PrecomposedTransactionFinalRbf;
+            precomposedTransaction: PrecomposedTransactionFinalBumpFeeRbf;
             txid: string;
         },
         { dispatch },
@@ -248,10 +248,10 @@ export const signAndPushSendFormTransactionThunk = createThunk(
             return;
         }
 
-        const isRbf = isRbfTransaction(precomposedTransaction);
+        const isBumpFeeRbf = isRbfBumpFeeTransaction(precomposedTransaction);
 
         // This has to be executed prior to pushing the transaction!
-        const rbfLabelsToBeEdited = isRbf
+        const rbfLabelsToBeEdited = isBumpFeeRbf
             ? dispatch(findLabelsToBeMovedOrDeleted({ prevTxid: precomposedTransaction.prevTxid }))
             : null;
 
@@ -269,7 +269,7 @@ export const signAndPushSendFormTransactionThunk = createThunk(
         const result = pushResponse.payload;
         const { txid } = result.payload;
 
-        if (isRbf && rbfLabelsToBeEdited) {
+        if (isBumpFeeRbf && rbfLabelsToBeEdited) {
             dispatch(
                 updateRbfLabelsThunk({
                     labelsToBeEdited: rbfLabelsToBeEdited,

diff --git a/packages/suite/src/actions/wallet/stakeActions.ts b/packages/suite/src/actions/wallet/stakeActions.ts
@@ -9,7 +9,7 @@ import {
 import { PrecomposedTransactionFinal, StakeFormState, StakeType } from '@suite-common/wallet-types';
 import {
     formatNetworkAmount,
-    isRbfTransaction,
+    isRbfBumpFeeTransaction,
     isSupportedEthStakingNetworkSymbol,
     isSupportedSolStakingNetworkSymbol,
     tryGetAccountIdentity,
@@ -118,7 +118,7 @@ const pushTransaction =
                 );
             }
 
-            if (isRbfTransaction(precomposedTx)) {
+            if (isRbfBumpFeeTransaction(precomposedTx)) {
                 // notification from the backend may be delayed.
                 // modify affected transaction(s) in the reducer until the real account update occurs.
                 // this will update transaction details (like time, fee etc.)

diff --git a/...mponents/suite/modals/ReduxModal/TransactionReviewModal/TransactionReviewModalContent.tsx b/...mponents/suite/modals/ReduxModal/TransactionReviewModal/TransactionReviewModalContent.tsx
@@ -10,16 +10,18 @@ import {
     selectSendFormReviewButtonRequestsCount,
     selectStakePrecomposedForm,
 } from '@suite-common/wallet-core';
-import { FormState, StakeFormState } from '@suite-common/wallet-types';
+import { FormState, RbfTransactionType, StakeFormState } from '@suite-common/wallet-types';
 import {
     constructTransactionReviewOutputs,
     getTxStakeNameByDataHex,
+    isRbfBumpFeeTransaction,
+    isRbfCancelTransaction,
     isRbfTransaction,
 } from '@suite-common/wallet-utils';
 import { NewModal } from '@trezor/components';
 import { copyToClipboard, download } from '@trezor/dom-utils';
 import { ConfirmOnDevice } from '@trezor/product-components';
-import { EventType, analytics } from '@trezor/suite-analytics';
+import { EventType, TransactionCreatedEvent, analytics } from '@trezor/suite-analytics';
 import { Deferred } from '@trezor/utils';
 
 import * as modalActions from 'src/actions/suite/modalActions';
@@ -40,6 +42,14 @@ const isStakeState = (state: SendState | StakeState): state is StakeState => 'da
 const isStakeForm = (form: FormState | StakeFormState): form is StakeFormState =>
     'stakeType' in form;
 
+const mapRbfTypeToReporting: Record<
+    RbfTransactionType,
+    TransactionCreatedEvent['payload']['action']
+> = {
+    'bump-fee': 'replaced',
+    cancel: 'canceled',
+};
+
 type TransactionReviewModalContentProps = {
     decision: Deferred<boolean, string | number | undefined> | undefined;
     txInfoState: SendState | StakeState;
@@ -70,10 +80,13 @@ export const TransactionReviewModalContent = ({
     );
 
     const isTradingAction = !!precomposedForm?.isTrading;
-    const isRbfAction = precomposedTx !== undefined && isRbfTransaction(precomposedTx);
+    const isBumpFeeRbfAction =
+        precomposedTx !== undefined && isRbfBumpFeeTransaction(precomposedTx);
 
     const decreaseOutputId =
-        isRbfAction && precomposedTx.useNativeRbf ? precomposedForm?.setMaxOutputId : undefined;
+        isBumpFeeRbfAction && precomposedTx.useNativeRbf
+            ? precomposedForm?.setMaxOutputId
+            : undefined;
 
     const buttonRequestsCount = useSelector((state: DeviceRootState) =>
         selectSendFormReviewButtonRequestsCount(state, account?.symbol, decreaseOutputId),
@@ -112,15 +125,18 @@ export const TransactionReviewModalContent = ({
         }
     };
 
+    const isCancelRbfAction = isRbfCancelTransaction(precomposedTx);
+
     const actionLabel = getTransactionReviewModalActionText({
         stakeType,
-        isRbfAction,
+        isBumpFeeRbfAction,
+        isCancelRbfAction,
         isSending,
     });
 
     const isBroadcastEnabled = options.includes('broadcast');
 
-    const reportTransactionCreatedEvent = (action: 'sent' | 'copied' | 'downloaded' | 'replaced') =>
+    const reportTransactionCreatedEvent = (action: TransactionCreatedEvent['payload']['action']) =>
         analytics.report({
             type: EventType.TransactionCreated,
             payload: {
@@ -148,7 +164,11 @@ export const TransactionReviewModalContent = ({
         }
         if (decision) {
             decision.resolve(true);
-            reportTransactionCreatedEvent(isRbfAction ? 'replaced' : 'sent');
+            reportTransactionCreatedEvent(
+                isRbfTransaction(precomposedTx)
+                    ? mapRbfTypeToReporting[precomposedTx.rbfType]
+                    : 'sent',
+            );
         }
     };
 
@@ -222,8 +242,8 @@ export const TransactionReviewModalContent = ({
             return <TransactionReviewDetails tx={precomposedTx} txHash={serializedTx?.tx} />;
         }
 
-        if (isRbfConfirmedError) {
-            return <ReplaceByFeeFailedOriginalTxConfirmed type="replace-by-fee" />;
+        if (isRbfConfirmedError && isRbfTransaction(precomposedTx)) {
+            return <ReplaceByFeeFailedOriginalTxConfirmed type={precomposedTx.rbfType} />;
         }
 
         return (
@@ -233,7 +253,7 @@ export const TransactionReviewModalContent = ({
                 signedTx={serializedTx}
                 outputs={outputs}
                 buttonRequestsCount={buttonRequestsCount}
-                isRbfAction={isRbfAction}
+                isRbfAction={isBumpFeeRbfAction}
                 isTradingAction={isTradingAction}
                 isSending={isSending}
                 stakeType={stakeType || undefined}

diff --git a/...ls/ReduxModal/UserContextModal/TxDetailModal/CancelTransaction/CancelTransactionModal.tsx b/...ls/ReduxModal/UserContextModal/TxDetailModal/CancelTransaction/CancelTransactionModal.tsx
@@ -8,11 +8,11 @@ import {
 import {
     Account,
     ChainedTransactions,
+    PrecomposedTransactionFinalCancelRbf,
     SelectedAccountLoaded,
     WalletAccountTransactionWithRequiredRbfParams,
 } from '@suite-common/wallet-types';
 import { Banner, Column, NewModal } from '@trezor/components';
-import { PrecomposeResultFinal } from '@trezor/connect';
 import { spacings } from '@trezor/theme';
 
 import { CancelTransaction } from './CancelTransaction';
@@ -50,7 +50,8 @@ export const CancelTransactionModal = ({
     const { account } = selectedAccount;
 
     const dispatch = useDispatch();
-    const [composedCancelTx, setComposedCancelTx] = useState<PrecomposeResultFinal | null>(null);
+    const [composedCancelTx, setComposedCancelTx] =
+        useState<PrecomposedTransactionFinalCancelRbf | null>(null);
 
     const confirmations = useSelector(state =>
         selectTransactionConfirmations(state, tx.txid, account.key),
@@ -69,7 +70,9 @@ export const CancelTransactionModal = ({
 
         dispatch(composeCancelTransactionThunk({ account, tx, chainedTxs }))
             .unwrap()
-            .then(setComposedCancelTx)
+            .then(precomposed => {
+                setComposedCancelTx({ ...precomposed, rbfType: 'cancel', prevTxid: tx.txid });
+            })
             .catch(setError);
     }, [account, tx, dispatch, chainedTxs]);
 
@@ -100,7 +103,7 @@ export const CancelTransactionModal = ({
                 onBackClick={onBackClick}
             >
                 {isTxConfirmed ? (
-                    <ReplaceByFeeFailedOriginalTxConfirmed type="cancel-transaction" />
+                    <ReplaceByFeeFailedOriginalTxConfirmed type="cancel" />
                 ) : (
                     <Column gap={spacings.md}>
                         <CancelTransaction tx={tx} selectedAccount={selectedAccount} />

diff --git a/...ponents/suite/modals/ReduxModal/UserContextModal/TxDetailModal/ChangeFee/BumpFeeModal.tsx b/...ponents/suite/modals/ReduxModal/UserContextModal/TxDetailModal/ChangeFee/BumpFeeModal.tsx
@@ -58,7 +58,7 @@ export const BumpFeeModal = ({
                 onBackClick={onBackClick}
             >
                 {isTxConfirmed ? (
-                    <ReplaceByFeeFailedOriginalTxConfirmed type="replace-by-fee" />
+                    <ReplaceByFeeFailedOriginalTxConfirmed type="bump-fee" />
                 ) : (
                     <ChangeFee tx={tx} chainedTxs={chainedTxs} showChained={onShowChained} />
                 )}

diff --git a/...odals/ReduxModal/UserContextModal/TxDetailModal/ReplaceByFeeFailedOriginalTxConfirmed.tsx b/...odals/ReduxModal/UserContextModal/TxDetailModal/ReplaceByFeeFailedOriginalTxConfirmed.tsx
@@ -1,3 +1,4 @@
+import { RbfTransactionType } from '@suite-common/wallet-types';
 import { Box, Card, Column, IconCircle, Text } from '@trezor/components';
 import { spacings } from '@trezor/theme';
 import {
@@ -9,23 +10,23 @@ import {
 import { Translation, TranslationKey } from '../../../../Translation';
 import { TrezorLink } from '../../../../TrezorLink';
 
-type ReplaceByFeeFailedOriginalTxConfirmedProps = {
-    type: 'replace-by-fee' | 'cancel-transaction';
+export type ReplaceByFeeFailedOriginalTxConfirmedProps = {
+    type: RbfTransactionType;
 };
 
 const titleMap: Record<ReplaceByFeeFailedOriginalTxConfirmedProps['type'], TranslationKey> = {
-    'replace-by-fee': 'TR_REPLACE_BY_FEE_FAILED_ALREADY_MINED',
-    'cancel-transaction': 'TR_CANCEL_TX_FAILED_ALREADY_MINED',
+    'bump-fee': 'TR_REPLACE_BY_FEE_FAILED_ALREADY_MINED',
+    cancel: 'TR_CANCEL_TX_FAILED_ALREADY_MINED',
 };
 
 const descriptionMap: Record<ReplaceByFeeFailedOriginalTxConfirmedProps['type'], TranslationKey> = {
-    'replace-by-fee': 'TR_REPLACE_BY_FEE_FAILED_ALREADY_MINED_DESCRIPTION',
-    'cancel-transaction': 'TR_CANCEL_TX_FAILED_ALREADY_MINED_DESCRIPTION',
+    'bump-fee': 'TR_REPLACE_BY_FEE_FAILED_ALREADY_MINED_DESCRIPTION',
+    cancel: 'TR_CANCEL_TX_FAILED_ALREADY_MINED_DESCRIPTION',
 };
 
 const helpLink: Record<ReplaceByFeeFailedOriginalTxConfirmedProps['type'], Url> = {
-    'replace-by-fee': HELP_CENTER_REPLACE_BY_FEE_BITCOIN,
-    'cancel-transaction': HELP_CENTER_CANCEL_TRANSACTION,
+    'bump-fee': HELP_CENTER_REPLACE_BY_FEE_BITCOIN,
+    cancel: HELP_CENTER_CANCEL_TRANSACTION,
 };
 
 export const ReplaceByFeeFailedOriginalTxConfirmed = ({

diff --git a/packages/suite/src/middlewares/wallet/replaceByFeeErrorMiddleware.ts b/packages/suite/src/middlewares/wallet/replaceByFeeErrorMiddleware.ts
@@ -13,20 +13,25 @@ export const replaceByFeeErrorMiddleware =
     (action: Action): Action => {
         next(action);
 
-        if (transactionsActions.addTransaction.match(action)) {
-            const { transactions } = action.payload;
+        if (!transactionsActions.addTransaction.match(action)) {
+            return action;
+        }
+
+        const { transactions } = action.payload;
+        const precomposedTx = api.getState().wallet.send?.precomposedTx;
 
-            const precomposedTx = api.getState().wallet.send?.precomposedTx;
+        if (precomposedTx === undefined) {
+            return action;
+        }
+
+        if (!isRbfTransaction(precomposedTx)) {
+            return action;
+        }
 
-            if (precomposedTx !== undefined && isRbfTransaction(precomposedTx)) {
-                const addedTransaction = transactions.find(
-                    tx => tx.txid === precomposedTx.prevTxid,
-                );
+        const addedTransaction = transactions.find(tx => tx.txid === precomposedTx.prevTxid);
 
-                if (addedTransaction !== undefined && addedTransaction.blockHeight !== undefined) {
-                    api.dispatch(replaceByFeeErrorThunk());
-                }
-            }
+        if (addedTransaction !== undefined && addedTransaction.blockHeight !== undefined) {
+            api.dispatch(replaceByFeeErrorThunk());
         }
 
         return action;

diff --git a/packages/suite/src/utils/suite/transactionReview.ts b/packages/suite/src/utils/suite/transactionReview.ts
@@ -3,13 +3,15 @@ import { StakeFormState } from '@suite-common/wallet-types';
 
 interface getTransactionReviewModalActionTextParams {
     stakeType: StakeFormState['stakeType'] | null;
-    isRbfAction: boolean;
+    isBumpFeeRbfAction: boolean;
+    isCancelRbfAction: boolean;
     isSending?: boolean;
 }
 
 export const getTransactionReviewModalActionText = ({
     stakeType,
-    isRbfAction,
+    isBumpFeeRbfAction,
+    isCancelRbfAction,
     isSending,
 }: getTransactionReviewModalActionTextParams): TranslationKey => {
     switch (stakeType) {
@@ -22,10 +24,14 @@ export const getTransactionReviewModalActionText = ({
         // no default
     }
 
-    if (isRbfAction) {
+    if (isBumpFeeRbfAction) {
         return 'TR_REPLACE_TX';
     }
 
+    if (isCancelRbfAction) {
+        return 'TR_CANCEL_TX';
+    }
+
     if (isSending) {
         return 'TR_CONFIRMING_TX';
     }

diff --git a/suite-common/wallet-core/src/send/sendFormBitcoinThunks.ts b/suite-common/wallet-core/src/send/sendFormBitcoinThunks.ts
@@ -14,7 +14,7 @@ import {
     getBitcoinComposeOutputs,
     getUtxoOutpoint,
     hasNetworkFeatures,
-    isRbfTransaction,
+    isRbfBumpFeeTransaction,
     restoreOrigOutputsOrder,
 } from '@suite-common/wallet-utils';
 import TrezorConnect, {
@@ -273,7 +273,7 @@ export const signBitcoinSendFormTransactionThunk = createThunk<
 
         if (
             formState.rbfParams &&
-            isRbfTransaction(precomposedTransaction) &&
+            isRbfBumpFeeTransaction(precomposedTransaction) &&
             precomposedTransaction.useNativeRbf
         ) {
             const { txid, utxo, outputs } = formState.rbfParams;