chore: token out with fot fix (Uniswap#540)

* chore: token out with fot fix * missing var * fix tests, tests pending to add * add test for fot flag * reset to main * tokenOutHasFot * test FOT and Fee * undefined aware * fix * review feedback
mr-uniswap · Apr 22, 2024 · 8f6963b · 8f6963b
1 parent f73799d
commit 8f6963b
Show file tree

Hide file tree

Showing 4 changed files with 171 additions and 58 deletions.
diff --git a/src/providers/portion-provider.ts b/src/providers/portion-provider.ts
@@ -22,6 +22,7 @@ export interface IPortionProvider {
   getPortionAmount(
     tokenOutAmount: CurrencyAmount,
     tradeType: TradeType,
+    tokenOutHasFot?: boolean,
     swapConfig?: SwapOptions
   ): CurrencyAmount | undefined;
 
@@ -116,9 +117,10 @@ export class PortionProvider implements IPortionProvider {
   getPortionAmount(
     tokenOutAmount: CurrencyAmount,
     tradeType: TradeType,
+    tokenOutHasFot?: boolean,
     swapConfig?: SwapOptions
   ): CurrencyAmount | undefined {
-    if (swapConfig?.type !== SwapType.UNIVERSAL_ROUTER) {
+    if (tokenOutHasFot || swapConfig?.type !== SwapType.UNIVERSAL_ROUTER) {
       return undefined;
     }
 
@@ -202,9 +204,13 @@ export class PortionProvider implements IPortionProvider {
     }
 
     return routeWithQuotes.map((routeWithQuote) => {
+      const tokenOut =
+        routeWithQuote.tokenPath[routeWithQuote.tokenPath.length - 1];
+      const tokenOutHasFot = tokenOut && tokenOut.buyFeeBps?.gt(0);
       const portionAmount = this.getPortionAmount(
         routeWithQuote.quote,
         tradeType,
+        tokenOutHasFot,
         swapConfig
       );
 

diff --git a/src/routers/alpha-router/alpha-router.ts b/src/routers/alpha-router/alpha-router.ts
@@ -1039,10 +1039,30 @@ export class AlphaRouter
     partialRoutingConfig: Partial<AlphaRouterConfig> = {}
   ): Promise<SwapRoute | null> {
     const originalAmount = amount;
+
+    const { currencyIn, currencyOut } =
+      this.determineCurrencyInOutFromTradeType(
+        tradeType,
+        amount,
+        quoteCurrency
+      );
+
+    const tokenIn = currencyIn.wrapped;
+    const tokenOut = currencyOut.wrapped;
+
+    const tokenOutProperties =
+      await this.tokenPropertiesProvider.getTokensProperties(
+        [tokenOut],
+        partialRoutingConfig
+      );
+      const buyFeeBps = tokenOutProperties[tokenOut.address.toLowerCase()]?.tokenFeeResult?.buyFeeBps;
+      const tokenOutHasFot = buyFeeBps && buyFeeBps.gt(0);
+
     if (tradeType === TradeType.EXACT_OUTPUT) {
       const portionAmount = this.portionProvider.getPortionAmount(
         amount,
         tradeType,
+        tokenOutHasFot,
         swapConfig
       );
       if (portionAmount && portionAmount.greaterThan(ZERO)) {
@@ -1056,16 +1076,6 @@ export class AlphaRouter
       }
     }
 
-    const { currencyIn, currencyOut } =
-      this.determineCurrencyInOutFromTradeType(
-        tradeType,
-        amount,
-        quoteCurrency
-      );
-
-    const tokenIn = currencyIn.wrapped;
-    const tokenOut = currencyOut.wrapped;
-
     metric.setProperty('chainId', this.chainId);
     metric.setProperty('pair', `${tokenIn.symbol}/${tokenOut.symbol}`);
     metric.setProperty('tokenIn', tokenIn.address);
@@ -1455,6 +1465,7 @@ export class AlphaRouter
     const portionAmount = this.portionProvider.getPortionAmount(
       tokenOutAmount,
       tradeType,
+      tokenOutHasFot,
       swapConfig
     );
     const portionQuoteAmount = this.portionProvider.getPortionQuoteAmount(

diff --git a/test/integ/routers/alpha-router/alpha-router.integration.test.ts b/test/integ/routers/alpha-router/alpha-router.integration.test.ts
@@ -2815,6 +2815,10 @@ describe('alpha router integration', () => {
                         slippageTolerance: LARGE_SLIPPAGE,
                         deadlineOrPreviousBlockhash: parseDeadline(360),
                         simulate: { fromAddress: WHALES(tokenIn!) },
+                        fee: {
+                          fee: new Percent(FLAT_PORTION.bips, 10_000),
+                          recipient: FLAT_PORTION.recipient
+                        }
                       },
                       {
                         ...ROUTING_CONFIG,
@@ -2830,6 +2834,12 @@ describe('alpha router integration', () => {
                     expect(swap!.methodParameters).toBeDefined();
                     expect(swap!.methodParameters!.to).toBeDefined();
 
+                    if (enableFeeOnTransferFeeFetching && tokenOut?.address === BULLET_WITHOUT_TAX.address) {
+                      expect(swap?.portionAmount?.quotient).toBeUndefined();
+                    } else {
+                      expect(swap?.portionAmount?.quotient?.toString()).not.toEqual("0");
+                    }
+
                     return { enableFeeOnTransferFeeFetching, ...swap! }
                   })
                 )