add skip sweep flag

Author: dglowinski

src/api/routes/swap/swapModel.ts

@@ -262,6 +262,19 @@ const getSwapSchema = z.object({
       },
       example: "0x8A54C278D117854486db0F6460D901a180Fff5aa",
     }),
+    skipSweepDepositOut: z
+      .string()
+      .toLowerCase()
+      .transform((s) => JSON.parse(s))
+      .pipe(z.boolean())
+      .optional()
+      .openapi({
+        param: {
+          description:
+            "Do not add a final deposit of the output token (sweep). Leave the assets in the swapper. Useful if receiver is the Swapper",
+        },
+        example: "false",
+      }),
     routingOverride: z
       .string()
       .transform((s) => JSON.parse(s))

src/swapService/types.ts

@@ -27,6 +27,7 @@ export interface SwapParams {
   routingOverride?: ChainRoutingConfig
   onlyFixedInputExactOut?: boolean // only fetch quotes where amountIn is fixed and not subject to slippage
   noRepayEncoding?: boolean // FIXME workaround for composite repays (ERC4626 strategy / overswap)
+  skipSweepDepositOut?: boolean // don't add the final deposit of the bought asset (sweep), leave the assets in Swapper
 }
 
 export interface SwapQuote {

src/swapService/utils.ts

@@ -277,13 +277,19 @@ export function addInOutDeposits(
       5n, // avoid zero shares error
       swapParams.accountIn,
     ),
-    encodeDepositMulticallItem(
-      swapParams.tokenOut.addressInfo,
-      swapParams.receiver,
-      5n, // avoid zero shares error
-      swapParams.dustAccount,
-    ),
   ]
+
+  if (!swapParams.skipSweepDepositOut) {
+    multicallItems.push(
+      encodeDepositMulticallItem(
+        swapParams.tokenOut.addressInfo,
+        swapParams.receiver,
+        5n, // avoid zero shares error
+        swapParams.dustAccount,
+      ),
+    )
+  }
+
   response.swap = buildApiResponseSwap(swapParams.from, multicallItems)
 
   return response