feat(earn): Add pending transaction for EarnSwapDeposit (#6054)

### Description

title

### Test plan


https://github.com/user-attachments/assets/3b39f849-80b8-4f5c-ad9b-d94d1cedc067

Unit tests updated

### Related issues

- Fixes ACT-1361

### Backwards compatibility

Yes

### Network scalability

If a new NetworkId and/or Network are added in the future, the changes
in this PR will:

- [X] Continue to work without code changes, OR trigger a compilation
error (guaranteeing we find it when a new network is added)

src/earn/saga.test.ts

@@ -188,6 +188,40 @@ describe('depositSubmitSaga', () => {
     providerId: mockEarnPositions[0].appId,
   }
 
+  const expectedSwapDepositStandbyTx = {
+    __typename: 'EarnSwapDeposit',
+    context: {
+      id: 'id-earn/saga-Earn/SwapDeposit',
+      tag: 'earn/saga',
+      description: 'Earn/SwapDeposit',
+    },
+    networkId: NetworkId['arbitrum-sepolia'],
+    swap: {
+      inAmount: {
+        value: '100',
+        tokenId: mockArbUsdcTokenId,
+      },
+      outAmount: {
+        value: '50',
+        tokenId: mockArbArbTokenId,
+      },
+    },
+    deposit: {
+      inAmount: {
+        value: '100',
+        tokenId: networkConfig.aaveArbUsdcTokenId,
+      },
+      outAmount: {
+        value: '100',
+        tokenId: mockArbUsdcTokenId,
+      },
+      providerId: mockEarnPositions[0].appId,
+    },
+    transactionHash: '0x2',
+    type: TokenTransactionTypeV2.EarnSwapDeposit,
+    feeCurrencyId: undefined,
+  }
+
   const expectedApproveGasAnalyticsProperties = {
     approveTxCumulativeGasUsed: 3129217,
     approveTxEffectiveGasPrice: 5000000000,
@@ -372,7 +406,7 @@ describe('depositSubmitSaga', () => {
       approvedAmount: '50',
       tokenId: mockArbArbTokenId,
     })
-    expect(mockStandbyHandler).toHaveBeenNthCalledWith(2, expectedDepositStandbyTx)
+    expect(mockStandbyHandler).toHaveBeenNthCalledWith(2, expectedSwapDepositStandbyTx)
     expect(AppAnalytics.track).toHaveBeenCalledWith(EarnEvents.earn_deposit_submit_start, {
       ...expectedAnalyticsProps,
       fromTokenAmount: '50',
@@ -419,7 +453,7 @@ describe('depositSubmitSaga', () => {
     expect(navigateHome).toHaveBeenCalled()
     expect(decodeFunctionData).not.toHaveBeenCalled()
     expect(mockStandbyHandler).toHaveBeenCalledTimes(1)
-    expect(mockStandbyHandler).toHaveBeenCalledWith(expectedDepositStandbyTx)
+    expect(mockStandbyHandler).toHaveBeenCalledWith(expectedSwapDepositStandbyTx)
     expect(AppAnalytics.track).toHaveBeenCalledWith(EarnEvents.earn_deposit_submit_start, {
       ...expectedAnalyticsProps,
       fromTokenAmount: '50',
@@ -519,7 +553,7 @@ describe('depositSubmitSaga', () => {
     })
     expect(mockStandbyHandler).toHaveBeenCalledTimes(2)
     expect(mockStandbyHandler).toHaveBeenNthCalledWith(1, null)
-    expect(mockStandbyHandler).toHaveBeenNthCalledWith(2, expectedDepositStandbyTx)
+    expect(mockStandbyHandler).toHaveBeenNthCalledWith(2, expectedSwapDepositStandbyTx)
   })
 
   it('dispatches cancel action if pin input is cancelled and does not navigate home', async () => {

src/earn/saga.ts

@@ -197,7 +197,31 @@ export function* depositSubmitSaga(action: PayloadAction<DepositInfo>) {
           feeCurrencyId,
         }
       }
-      createDepositStandbyTxHandlers.push(createDepositStandbyTx)
+      const createSwapDepositStandbyTx = (
+        transactionHash: string,
+        feeCurrencyId?: string
+      ): BaseStandbyTransaction => {
+        return {
+          context: newTransactionContext(TAG, 'Earn/SwapDeposit'),
+          __typename: 'EarnSwapDeposit',
+          networkId,
+          type: TokenTransactionTypeV2.EarnSwapDeposit,
+          swap: {
+            inAmount: { value: amount, tokenId: depositTokenId },
+            outAmount: { value: fromTokenAmount, tokenId: fromTokenId },
+          },
+          deposit: {
+            inAmount: { value: amount, tokenId: pool.dataProps.withdrawTokenId },
+            outAmount: { value: amount, tokenId: depositTokenId },
+            providerId: pool.appId,
+          },
+          transactionHash,
+          feeCurrencyId,
+        }
+      }
+      createDepositStandbyTxHandlers.push(
+        mode === 'deposit' ? createDepositStandbyTx : createSwapDepositStandbyTx
+      )
     } else {
       Logger.info(TAG, 'More than 2 deposit transactions, using empty standby handlers')
       createDepositStandbyTxHandlers.push(...preparedTransactions.map(() => () => null))

src/transactions/actions.ts

@@ -1,6 +1,7 @@
 import {
   EarnClaimReward,
   EarnDeposit,
+  EarnSwapDeposit,
   EarnWithdraw,
   Fee,
   NetworkId,
@@ -28,6 +29,7 @@ export type BaseStandbyTransaction =
   | BaseStandbyTransactionType<TokenApproval>
   | BaseStandbyTransactionType<NftTransfer>
   | BaseStandbyTransactionType<EarnDeposit>
+  | BaseStandbyTransactionType<EarnSwapDeposit>
   | BaseStandbyTransactionType<EarnWithdraw>
   | BaseStandbyTransactionType<EarnClaimReward>
 

src/transactions/types.ts

@@ -41,6 +41,7 @@ export type ConfirmedStandbyTransaction = (
   | Omit<TokenApproval, 'status'>
   | Omit<NftTransfer, 'status'>
   | Omit<EarnDeposit, 'status'>
+  | Omit<EarnSwapDeposit, 'status'>
   | Omit<EarnWithdraw, 'status'>
   | Omit<EarnClaimReward, 'status'>
 ) & {
@@ -55,6 +56,7 @@ export type StandbyTransaction =
   | PendingStandbyTransaction<TokenApproval>
   | PendingStandbyTransaction<NftTransfer>
   | PendingStandbyTransaction<EarnDeposit>
+  | PendingStandbyTransaction<EarnSwapDeposit>
   | PendingStandbyTransaction<EarnWithdraw>
   | PendingStandbyTransaction<EarnClaimReward>
   | ConfirmedStandbyTransaction

test/RootStateSchema.json

@@ -2633,6 +2633,84 @@
             ],
             "type": "object"
         },
+        "PendingStandbyTransaction<EarnSwapDeposit>": {
+            "additionalProperties": false,
+            "properties": {
+                "__typename": {
+                    "const": "EarnSwapDeposit",
+                    "type": "string"
+                },
+                "context": {
+                    "$ref": "#/definitions/TransactionContext"
+                },
+                "deposit": {
+                    "additionalProperties": false,
+                    "properties": {
+                        "inAmount": {
+                            "$ref": "#/definitions/TokenAmount"
+                        },
+                        "outAmount": {
+                            "$ref": "#/definitions/TokenAmount"
+                        },
+                        "providerId": {
+                            "type": "string"
+                        }
+                    },
+                    "required": [
+                        "inAmount",
+                        "outAmount",
+                        "providerId"
+                    ],
+                    "type": "object"
+                },
+                "feeCurrencyId": {
+                    "type": "string"
+                },
+                "networkId": {
+                    "$ref": "#/definitions/NetworkId"
+                },
+                "status": {
+                    "const": "Pending",
+                    "type": "string"
+                },
+                "swap": {
+                    "additionalProperties": false,
+                    "properties": {
+                        "inAmount": {
+                            "$ref": "#/definitions/TokenAmount"
+                        },
+                        "outAmount": {
+                            "$ref": "#/definitions/TokenAmount"
+                        }
+                    },
+                    "required": [
+                        "inAmount",
+                        "outAmount"
+                    ],
+                    "type": "object"
+                },
+                "timestamp": {
+                    "type": "number"
+                },
+                "transactionHash": {
+                    "type": "string"
+                },
+                "type": {
+                    "$ref": "#/definitions/TokenTransactionTypeV2"
+                }
+            },
+            "required": [
+                "__typename",
+                "context",
+                "deposit",
+                "networkId",
+                "status",
+                "swap",
+                "timestamp",
+                "type"
+            ],
+            "type": "object"
+        },
         "PendingStandbyTransaction<EarnWithdraw>": {
             "additionalProperties": false,
             "properties": {
@@ -3685,6 +3763,9 @@
                 {
                     "$ref": "#/definitions/PendingStandbyTransaction<EarnDeposit>"
                 },
+                {
+                    "$ref": "#/definitions/PendingStandbyTransaction<EarnSwapDeposit>"
+                },
                 {
                     "$ref": "#/definitions/PendingStandbyTransaction<EarnWithdraw>"
                 },
@@ -4023,6 +4104,99 @@
                     ],
                     "type": "object"
                 },
+                {
+                    "additionalProperties": false,
+                    "properties": {
+                        "__typename": {
+                            "const": "EarnSwapDeposit",
+                            "type": "string"
+                        },
+                        "block": {
+                            "type": "string"
+                        },
+                        "context": {
+                            "$ref": "#/definitions/TransactionContext"
+                        },
+                        "deposit": {
+                            "additionalProperties": false,
+                            "properties": {
+                                "inAmount": {
+                                    "$ref": "#/definitions/TokenAmount"
+                                },
+                                "outAmount": {
+                                    "$ref": "#/definitions/TokenAmount"
+                                },
+                                "providerId": {
+                                    "type": "string"
+                                }
+                            },
+                            "required": [
+                                "inAmount",
+                                "outAmount",
+                                "providerId"
+                            ],
+                            "type": "object"
+                        },
+                        "feeCurrencyId": {
+                            "type": "string"
+                        },
+                        "fees": {
+                            "items": {
+                                "$ref": "#/definitions/Fee"
+                            },
+                            "type": "array"
+                        },
+                        "networkId": {
+                            "$ref": "#/definitions/NetworkId"
+                        },
+                        "status": {
+                            "enum": [
+                                "Complete",
+                                "Failed"
+                            ],
+                            "type": "string"
+                        },
+                        "swap": {
+                            "additionalProperties": false,
+                            "properties": {
+                                "inAmount": {
+                                    "$ref": "#/definitions/TokenAmount"
+                                },
+                                "outAmount": {
+                                    "$ref": "#/definitions/TokenAmount"
+                                }
+                            },
+                            "required": [
+                                "inAmount",
+                                "outAmount"
+                            ],
+                            "type": "object"
+                        },
+                        "timestamp": {
+                            "type": "number"
+                        },
+                        "transactionHash": {
+                            "type": "string"
+                        },
+                        "type": {
+                            "$ref": "#/definitions/TokenTransactionTypeV2"
+                        }
+                    },
+                    "required": [
+                        "__typename",
+                        "block",
+                        "context",
+                        "deposit",
+                        "fees",
+                        "networkId",
+                        "status",
+                        "swap",
+                        "timestamp",
+                        "transactionHash",
+                        "type"
+                    ],
+                    "type": "object"
+                },
                 {
                     "additionalProperties": false,
                     "properties": {
@@ -5885,13 +6059,13 @@
                     "$ref": "#/definitions/EarnDeposit"
                 },
                 {
-                    "$ref": "#/definitions/EarnWithdraw"
+                    "$ref": "#/definitions/EarnSwapDeposit"
                 },
                 {
-                    "$ref": "#/definitions/EarnClaimReward"
+                    "$ref": "#/definitions/EarnWithdraw"
                 },
                 {
-                    "$ref": "#/definitions/EarnSwapDeposit"
+                    "$ref": "#/definitions/EarnClaimReward"
                 }
             ]
         },