refactor(suite): redundant precomposedForm state removed from sendFor…

…m reducer
trezor · May 29, 2024 · 8631fda · 8631fda
1 parent 1eef2ef
commit 8631fda
Show file tree

Hide file tree

Showing 12 changed files with 231 additions and 196 deletions.
diff --git a/packages/suite/src/actions/wallet/send/sendFormThunks.ts b/packages/suite/src/actions/wallet/send/sendFormThunks.ts
@@ -14,10 +14,10 @@ import {
     pushSendFormTransactionThunk,
     replaceTransactionThunk,
     selectDevice,
-    selectPrecomposedSendForm,
     selectSendFormDrafts,
     signTransactionThunk,
     sendFormActions,
+    selectSendFormDraftByAccountKey,
 } from '@suite-common/wallet-core';
 import { isCardanoTx } from '@suite-common/wallet-utils';
 import { MetadataAddPayload } from '@suite-common/metadata-types';
@@ -28,7 +28,7 @@ import {
     selectSelectedAccountKey,
     selectIsSelectedAccountLoaded,
 } from 'src/reducers/wallet/selectedAccountReducer';
-import { findLabelsToBeMovedOrDeleted } from '../moveLabelsForRbfActions';
+import { findLabelsToBeMovedOrDeleted, moveLabelsForRbfAction } from '../moveLabelsForRbfActions';
 import { selectMetadata } from 'src/reducers/suite/metadataReducer';
 import * as metadataLabelingActions from 'src/actions/suite/metadataLabelingActions';
 import * as modalActions from 'src/actions/suite/modalActions';
@@ -95,19 +95,15 @@ const updateRbfLabelsThunk = createThunk(
     (
         {
             labelsToBeEdited,
-            precomposedTx,
+            precomposedTransaction,
             txid,
         }: {
             labelsToBeEdited: RbfLabelsToBeUpdated;
-            precomposedTx: PrecomposedTransactionFinal;
+            precomposedTransaction: PrecomposedTransactionFinal;
             txid: string;
         },
-        { dispatch, extra },
+        { dispatch },
     ) => {
-        const {
-            thunks: { moveLabelsForRbfAction },
-        } = extra;
-
         dispatch(
             moveLabelsForRbfAction({
                 toBeMovedOrDeletedList: labelsToBeEdited,
@@ -120,7 +116,7 @@ const updateRbfLabelsThunk = createThunk(
         // this will update transaction details (like time, fee etc.)
         dispatch(
             replaceTransactionThunk({
-                precomposedTx,
+                precomposedTransaction,
                 newTxid: txid,
             }),
         );
@@ -132,63 +128,61 @@ const applySendFormMetadataLabelsThunk = createThunk(
     (
         {
             selectedAccount,
-            precomposedTx,
+            precomposedTransaction,
             txid,
         }: {
             selectedAccount: Account;
-            precomposedTx: GeneralPrecomposedTransactionFinal;
+            precomposedTransaction: GeneralPrecomposedTransactionFinal;
             txid: string;
         },
         { dispatch, getState },
     ) => {
         const metadata = selectMetadata(getState());
-        if (metadata.enabled) {
-            const precomposedForm = selectPrecomposedSendForm(getState());
-            let outputsPermutation: number[];
-            if (isCardanoTx(selectedAccount, precomposedTx)) {
-                // cardano preserves order of outputs
-                outputsPermutation = precomposedTx?.outputs.map((_o, i) => i);
-            } else {
-                outputsPermutation = precomposedTx?.outputsPermutation;
-            }
-
-            const synchronize = getSynchronize();
-
-            precomposedForm?.outputs
-                // create array of metadata objects
-                .map((formOutput, index) => {
-                    const { label } = formOutput;
-                    // final ordering of outputs differs from order in send form
-                    // outputsPermutation contains mapping from @trezor/utxo-lib outputs to send form outputs
-                    // mapping goes like this: Array<@trezor/utxo-lib index : send form index>
-                    const outputIndex = outputsPermutation.findIndex(p => p === index);
-                    const outputMetadata: Extract<MetadataAddPayload, { type: 'outputLabel' }> = {
-                        type: 'outputLabel',
-                        entityKey: selectedAccount.key,
-                        txid,
-                        outputIndex,
-                        value: label,
-                        defaultValue: '',
-                    };
-
-                    return outputMetadata;
-                })
-                // filter out empty values AFTER creating metadata objects (see outputs mapping above)
-                .filter(output => output.value)
-                // propagate metadata to reducers and persistent storage
-                .forEach((output, index, arr) => {
-                    const isLast = index === arr.length - 1;
-
-                    synchronize(() =>
-                        dispatch(
-                            metadataLabelingActions.addAccountMetadata({
-                                ...output,
-                                skipSave: !isLast,
-                            }),
-                        ),
-                    );
-                });
-        }
+
+        if (!metadata.enabled) return;
+
+        const formDraft = selectSendFormDraftByAccountKey(getState(), selectedAccount.key);
+
+        const outputsPermutation = isCardanoTx(selectedAccount, precomposedTransaction)
+            ? precomposedTransaction?.outputs.map((_o, i) => i) // cardano preserves order of outputs
+            : precomposedTransaction?.outputsPermutation;
+
+        const synchronize = getSynchronize();
+
+        formDraft?.outputs
+            // create array of metadata objects
+            .map((formOutput, index) => {
+                const { label } = formOutput;
+                // final ordering of outputs differs from order in send form
+                // outputsPermutation contains mapping from @trezor/utxo-lib outputs to send form outputs
+                // mapping goes like this: Array<@trezor/utxo-lib index : send form index>
+                const outputIndex = outputsPermutation.findIndex(p => p === index);
+                const outputMetadata: Extract<MetadataAddPayload, { type: 'outputLabel' }> = {
+                    type: 'outputLabel',
+                    entityKey: selectedAccount.key,
+                    txid,
+                    outputIndex,
+                    value: label,
+                    defaultValue: '',
+                };
+
+                return outputMetadata;
+            })
+            // filter out empty values AFTER creating metadata objects (see outputs mapping above)
+            .filter(output => output.value)
+            // propagate metadata to reducers and persistent storage
+            .forEach((output, index, arr) => {
+                const isLast = index === arr.length - 1;
+
+                synchronize(() =>
+                    dispatch(
+                        metadataLabelingActions.addAccountMetadata({
+                            ...output,
+                            skipSave: !isLast,
+                        }),
+                    ),
+                );
+            });
     },
 );
 
@@ -241,49 +235,50 @@ export const signAndPushSendFormTransactionThunk = createThunk(
         const isPushConfirmed = await dispatch(
             modalActions.openDeferredModal({ type: 'review-transaction' }),
         );
-        if (isPushConfirmed) {
-            const isRbf = precomposedTransaction.prevTxid !== undefined;
-
-            // This has to be executed prior to pushing the transaction!
-            const rbfLabelsToBeEdited = isRbf
-                ? dispatch(
-                      findLabelsToBeMovedOrDeleted({ prevTxid: precomposedTransaction.prevTxid }),
-                  )
-                : null;
-
-            // push tx to the network
-            const pushResponse = await dispatch(
-                pushSendFormTransactionThunk({
-                    selectedAccount,
-                }),
-            );
 
-            if (isRejected(pushResponse)) {
-                return pushResponse.payload as Unsuccessful;
-            }
+        if (!isPushConfirmed) {
+            return;
+        }
 
-            const result = pushResponse.payload;
-            const { txid } = result.payload;
+        const isRbf = precomposedTransaction.prevTxid !== undefined;
 
-            if (isRbf && rbfLabelsToBeEdited) {
-                await dispatch(
-                    updateRbfLabelsThunk({
-                        labelsToBeEdited: rbfLabelsToBeEdited,
-                        precomposedTx: precomposedTransaction,
-                        txid,
-                    }),
-                );
-            }
+        // This has to be executed prior to pushing the transaction!
+        const rbfLabelsToBeEdited = isRbf
+            ? dispatch(findLabelsToBeMovedOrDeleted({ prevTxid: precomposedTransaction.prevTxid }))
+            : null;
+
+        // push tx to the network
+        const pushResponse = await dispatch(
+            pushSendFormTransactionThunk({
+                selectedAccount,
+            }),
+        );
+
+        if (isRejected(pushResponse)) {
+            return pushResponse.payload as Unsuccessful;
+        }
+
+        const result = pushResponse.payload;
+        const { txid } = result.payload;
 
+        if (isRbf && rbfLabelsToBeEdited) {
             dispatch(
-                applySendFormMetadataLabelsThunk({
-                    selectedAccount,
-                    precomposedTx: precomposedTransaction,
+                updateRbfLabelsThunk({
+                    labelsToBeEdited: rbfLabelsToBeEdited,
+                    precomposedTransaction,
                     txid,
                 }),
             );
-
-            return result;
         }
+
+        dispatch(
+            applySendFormMetadataLabelsThunk({
+                selectedAccount,
+                precomposedTransaction,
+                txid,
+            }),
+        );
+
+        return result;
     },
 );
diff --git a/packages/suite/src/actions/wallet/stakeActions.ts b/packages/suite/src/actions/wallet/stakeActions.ts
@@ -117,7 +117,7 @@ const pushTransaction =
                 // this will update transaction details (like time, fee etc.)
                 dispatch(
                     replaceTransactionThunk({
-                        precomposedTx,
+                        precomposedTransaction: precomposedTx,
                         newTxid: txid,
                     }),
                 );

diff --git a/...mponents/suite/modals/ReduxModal/TransactionReviewModal/TransactionReviewModalContent.tsx b/...mponents/suite/modals/ReduxModal/TransactionReviewModal/TransactionReviewModalContent.tsx
@@ -3,6 +3,7 @@ import styled from 'styled-components';
 import { ConfirmOnDevice, variables } from '@trezor/components';
 import { Deferred } from '@trezor/utils';
 import { selectDevice, StakeState } from '@suite-common/wallet-core';
+import { FormState, StakeFormState } from '@suite-common/wallet-types';
 import { isCardanoTx } from '@suite-common/wallet-utils';
 import { SendState } from '@suite-common/wallet-core';
 import { useSelector } from 'src/hooks/suite';
@@ -28,6 +29,14 @@ const StyledModal = styled(Modal)`
     }
 `;
 
+const isStakeState = (state: SendState | StakeState): state is StakeState => {
+    return 'data' in state;
+};
+
+const isStakeForm = (form: FormState | StakeFormState): form is StakeFormState => {
+    return 'ethereumStakeType' in form;
+};
+
 interface TransactionReviewModalContentProps {
     decision: Deferred<boolean, string | number | undefined> | undefined;
     txInfoState: SendState | StakeState;
@@ -48,13 +57,21 @@ export const TransactionReviewModalContent = ({
 
     const deviceModelInternal = device?.features?.internal_model;
 
-    const { precomposedTx, precomposedForm, serializedTx } = txInfoState;
+    const { account } = selectedAccount;
+    const { precomposedTx, serializedTx } = txInfoState;
+
+    if (!account) {
+        return null;
+    }
+
+    const precomposedForm: FormState | StakeFormState | undefined = isStakeState(txInfoState)
+        ? txInfoState.precomposedForm
+        : txInfoState.drafts[account.key];
 
     if (selectedAccount.status !== 'loaded' || !device || !precomposedTx || !precomposedForm) {
         return null;
     }
 
-    const { account } = selectedAccount;
     const { networkType } = account;
     const isCardano = isCardanoTx(account, precomposedTx);
     const isEthereum = networkType === 'ethereum';
@@ -71,8 +88,9 @@ export const TransactionReviewModalContent = ({
         precomposedTx,
     });
 
-    const ethereumStakeType =
-        'ethereumStakeType' in precomposedForm ? precomposedForm.ethereumStakeType : null;
+    const ethereumStakeType = isStakeForm(precomposedForm)
+        ? precomposedForm.ethereumStakeType
+        : null;
 
     // omit other button requests (like passphrase)
     const buttonRequests = device.buttonRequests.filter(

diff --git a/packages/suite/src/hooks/wallet/form/useCompose.ts b/packages/suite/src/hooks/wallet/form/useCompose.ts
@@ -231,16 +231,16 @@ export const useCompose = <TFieldValues extends FormState>({
     // called from the UI, triggers signing process
     const sign = async () => {
         const values = getValues();
-        const composedTx = composedLevels
+        const precomposedTransaction = composedLevels
             ? composedLevels[values.selectedFee || 'normal']
             : undefined;
-        if (composedTx && composedTx.type === 'final') {
+        if (precomposedTransaction && precomposedTransaction.type === 'final') {
             // sign workflow in Actions:
             // signSendFormTransactionThunk > sign[COIN]TransactionThunk > sendFormActions.storeSignedTransaction (modal with promise decision)
             const result = await dispatch(
                 signAndPushSendFormTransactionThunk({
                     formValues: values,
-                    precomposedTransaction: composedTx,
+                    precomposedTransaction,
                     selectedAccount,
                 }),
             ).unwrap();

diff --git a/packages/suite/src/hooks/wallet/useCardanoStaking.ts b/packages/suite/src/hooks/wallet/useCardanoStaking.ts
@@ -235,7 +235,11 @@ export const useCardanoStaking = (): CardanoStaking => {
                         }),
                     );
                     dispatch(
-                        addFakePendingCardanoTxThunk({ precomposedTx: txPlan, txid, account }),
+                        addFakePendingCardanoTxThunk({
+                            precomposedTransaction: txPlan,
+                            txid,
+                            account,
+                        }),
                     );
                     dispatch(setPendingStakeTx(account, txid));
                 } else {

diff --git a/packages/suite/src/hooks/wallet/useCoinmarketRecomposeAndSign.ts b/packages/suite/src/hooks/wallet/useCoinmarketRecomposeAndSign.ts
@@ -123,14 +123,14 @@ export const useCoinmarketRecomposeAndSign = () => {
 
                 return;
             }
-            const composedToSign = composedLevels[selectedFee];
+            const precomposedToSign = composedLevels[selectedFee];
 
-            if (!composedToSign || composedToSign.type !== 'final') {
+            if (!precomposedToSign || precomposedToSign.type !== 'final') {
                 let errorMessage: string | undefined;
-                if (composedToSign?.type === 'error' && composedToSign.errorMessage) {
+                if (precomposedToSign?.type === 'error' && precomposedToSign.errorMessage) {
                     errorMessage = translationString(
-                        composedToSign.errorMessage.id,
-                        composedToSign.errorMessage.values as { [key: string]: any },
+                        precomposedToSign.errorMessage.id,
+                        precomposedToSign.errorMessage.values as { [key: string]: any },
                     );
                 }
                 if (!errorMessage) {
@@ -149,7 +149,7 @@ export const useCoinmarketRecomposeAndSign = () => {
             return dispatch(
                 signAndPushSendFormTransactionThunk({
                     formValues,
-                    precomposedTransaction: composedToSign,
+                    precomposedTransaction: precomposedToSign,
                     selectedAccount: account,
                 }),
             ).unwrap();