feat: Add support for mixed routes in the interface #4181

zhongeric · 2022-07-25T01:47:13Z

The new versions of the smart order router (SOR) and routing-api introduce support for a new kind of route called MixedRoutes. MixedRoutes are routes which have both V2 and V3 pools in them, ex:

USDC -[V3]-> ETH -[V2]-> USDT

We only support returning these routes through the AutoRouter / routingAPI, and so we can pass in a new protocols queryParam of [Protocol.V2, Protocol.V3, Protocol.MIXED] to direct the auto router to also look for and consider mixedRoutes. Client side, we should still only query for V3 routes using the client side SOR and/or the QuoterV2 fallback.

We also need to edit the Trade object we create here to include the new mixed route, in order to generate the correct calldata to submit the swap with.

We also show a new badge label of V3 + V2 to denote the new mixed routes in the RoutingDiagram

vercel · 2022-07-25T01:47:17Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
interface	✅ Ready (Inspect)	Visit Preview	Aug 11, 2022 at 6:54PM (UTC)

zhongeric · 2022-08-05T07:22:20Z

src/components/RoutingDiagram/RoutingDiagram.tsx

+const MixedProtocolBadge = styled(ProtocolBadge)`
+  width: 60px;
+`


This seems to work to prevent the badge text from overflowing and line breaking

src/state/routing/slice.ts

vm · 2022-08-10T16:28:40Z

@zhongeric can you rebase/merge main?

zhongeric · 2022-08-10T21:15:30Z

src/hooks/useAutoSlippageTolerance.ts

      } else {
-        // TODO: Update with better estimates once we have interleaved routes.
+        // fallback general gas estimation
        gas += V3_SWAP_BASE_GAS_ESTIMATE + route.pools.length * V3_SWAP_HOP_GAS_ESTIMATE
      }


Chose to keep an else case as a fallback, not really needed tho

zhongeric · 2022-08-11T14:43:22Z

Do we want to query for mixedRoutes in the getClientSideQuote function as well? See: https://github.com/Uniswap/interface/pull/4181/files#diff-c9fd69a3658e7e36f7ab6b62fd18589fed617dad15c3184bc7335b9e6ad7ee02R68

src/hooks/useAutoSlippageTolerance.ts

src/state/routing/slice.ts

vm · 2022-08-11T15:14:19Z

src/state/routing/slice.ts

@@ -28,7 +28,6 @@ const protocols: Protocol[] = [Protocol.V2, Protocol.V3, Protocol.MIXED]

 const DEFAULT_QUERY_PARAMS = {
  protocols: protocols.map((p) => p.toLowerCase()).join(','),
-  forceMixedRoutes: true,


this part should be done in a separate PR (turning on the mixed routes at the API level)

that way we know what we can minimally revert if issues arise

makes sense, will cut

I think all that PR needs to be is forceMixedRoutes: true?

zzmp · 2022-08-11T17:44:32Z

src/hooks/useAutoSlippageTolerance.ts

@@ -43,8 +45,19 @@ function guesstimateGas(trade: Trade<Currency, Currency, TradeType> | undefined)
        // V3 gas costs scale on initialized ticks being crossed, but we don't have that data here.
        // We bake in some tick crossings into the base 100k cost.
        gas += V3_SWAP_BASE_GAS_ESTIMATE + route.pools.length * V3_SWAP_HOP_GAS_ESTIMATE
+      } else if (route.protocol === Protocol.MIXED) {
+        const sections = partitionMixedRouteByProtocol(route as MixedRoute<Currency, Currency>)
+        let acc = 0


acc is unnecssary - you should instead just have L53 and L55 use gas += to be more explicit about what you're adding up.

You should also use reduce to make it more clear what is happening in the code:

gas += sections.reduce((gas, section) => { if (section.every((pool) => pool instanceof Pool)) { return gas + V3_SWAP_BASE_GAS_ESTIMATE + section.length * V3_SWAP_HOP_GAS_ESTIMATE } else if (section.every((pool) => pool instanceof Pair)) { return gas + V2_SWAP_BASE_GAS_ESTIMATE + (section.length - 1) * V2_SWAP_HOP_GAS_ESTIMATE } else { console.warn('Invalid section') return gas } })

I like the .reduce

zzmp · 2022-08-11T17:46:26Z

src/state/routing/utils.ts

+}
+
+function isMixedRoute(route: (V3PoolInRoute | V2PoolInRoute)[]): route is (V3PoolInRoute | V2PoolInRoute)[] {
+  /// Must have at least one V3 pool and one V2 pool


This isn't comprehensive. Should you also check that every route is either V3 or V2?

Should be resolved by new logic in getRouteProtocol

zzmp · 2022-08-11T17:49:34Z

src/state/routing/utils.ts

@@ -71,6 +79,13 @@ export function transformRoutesToTrade<TTradeType extends TradeType>(
      route
        ?.filter((r): r is typeof route[0] & { routev3: NonNullable<typeof route[0]['routev3']> } => r.routev3 !== null)
        .map(({ routev3, inputAmount, outputAmount }) => ({ routev3, inputAmount, outputAmount })) ?? [],
+    mixedRoutes:


Where is this used?

used to build the InterfaceTrade which is returned by useRoutingAPITrade() and then in useBestTrade()

zzmp · 2022-08-11T18:02:16Z

src/state/routing/utils.ts

@@ -41,8 +42,15 @@ export function computeRoutes(
      }

      return {


This requires a lot of looping that isn't necessary. Could you improve it by doing something like this?

getRouteProtocol(route: (V3PoolInRoute | V2PoolInRoute)[]): Protocol { if (route.every((pool) => pool.type === 'v2-pool')) return Protocol.V2 if (route.every((pool) => pool.type === 'v3-pool')) return Protocol.V3 return Protocol.MIXED }

You could optimize it more but this seems sufficient. The old isV2Route-style functions were type guards, but the genericPoolPairParser makes it so that you no longer need to cast to a type before parsing the route.

Yeah this is a lot more elegant. This also solves the comment above about the mixed routes not exactly being comprehensive

zzmp · 2022-08-11T18:42:55Z

src/state/routing/utils.ts

@@ -41,16 +41,21 @@ export function computeRoutes(
        throw new Error('Expected both amountIn and amountOut to be present')
      }

+      const routeProtocol: Protocol = getRouteProtocol(route)


rm : Protocol, the typing is unneeded here. It can be inferred from the return value of getRouteProtocol.

zhongeric added 3 commits July 24, 2022 20:59

Expand typing to match new QuoteResponse from routing api

6a00627

lint autofix

880472e

Expand InterfaceTrade class to match router-sdk and allow mixedroutes

35500c6

vercel bot had a problem deploying to Preview July 25, 2022 01:49 Failure

zhongeric added 3 commits August 4, 2022 00:56

Add new routing-api poolInRoute logic for client side trade

077821d

eslint fix ==

e08c875

Add custom mxiedProtocolBadge and add into badgeDiagram

7fe6f7b

vercel bot had a problem deploying to Preview August 4, 2022 08:12 Failure

zhongeric commented Aug 5, 2022

View reviewed changes

src/state/routing/slice.ts Outdated Show resolved Hide resolved

zhongeric marked this pull request as ready for review August 8, 2022 15:59

Bump router-sdk to published version, and install latest local SOR

6d30214

vercel bot had a problem deploying to Preview August 8, 2022 21:41 Failure

zhongeric requested a review from vm August 10, 2022 16:26

git checkout main yarn.lock && yarn && npx yarn-deduplicate

9c1210c

vercel bot had a problem deploying to Preview August 10, 2022 17:49 Failure

zhongeric added 5 commits August 10, 2022 16:44

Bump SOR to 2.9.2

6a2e34e

bump SOR to 2.9.2

2e9c9eb

Merge branch 'main' into eric/mixed-route-support

ce0f313

Update yarn.lock

d5e317e

revert slice.ts

47c3d5d

vercel bot deployed to Preview August 10, 2022 21:01 View deployment

Add guesstimate logic for mixedRoutes

21e0464

zhongeric commented Aug 10, 2022

View reviewed changes

Oops wrong pool import lol

2793269

vercel bot deployed to Preview August 10, 2022 21:23 View deployment

Add beta url + expand protocols array

d294343

vercel bot deployed to Preview August 11, 2022 14:46 View deployment

zhongeric added 2 commits August 11, 2022 10:50

Add forceMixedRoutes for testing

aa81311

Fix cyrpress build issue: no-loop-func

92f5897

vercel bot deployed to Preview August 11, 2022 14:58 View deployment

zhongeric commented Aug 11, 2022

View reviewed changes

src/hooks/useAutoSlippageTolerance.ts Outdated Show resolved Hide resolved

snreynolds reviewed Aug 11, 2022

View reviewed changes

src/state/routing/slice.ts Outdated Show resolved Hide resolved

Change to prod url and remove testing param

bddc9a6

vm reviewed Aug 11, 2022

View reviewed changes

vercel bot deployed to Preview August 11, 2022 15:15 View deployment

vm self-requested a review August 11, 2022 15:15

remove protocol flag

30ddf00

vercel bot deployed to Preview August 11, 2022 15:24 View deployment

zzmp suggested changes Aug 11, 2022

View reviewed changes

zzmp reviewed Aug 11, 2022

View reviewed changes

zhongeric added 2 commits August 11, 2022 14:12

Revisions: getRouteProtocol helper, fix gas acc for mixed route

7b1c908

revert protocols array abck

5620b9b

vercel bot deployed to Preview August 11, 2022 18:18 View deployment

zzmp approved these changes Aug 11, 2022

View reviewed changes

Remove :Protocol

be34200

vercel bot deployed to Preview August 11, 2022 18:54 View deployment

zhongeric merged commit 47e6c08 into main Aug 11, 2022

zhongeric deleted the eric/mixed-route-support branch August 11, 2022 20:40

zhongeric mentioned this pull request Aug 12, 2022

Update widgets with new changes from interface to support mixed routes Uniswap/widgets#139

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add support for mixed routes in the interface #4181

feat: Add support for mixed routes in the interface #4181

zhongeric commented Jul 25, 2022 •

edited

Loading

vercel bot commented Jul 25, 2022 •

edited

Loading

zhongeric Aug 5, 2022 •

edited

Loading

vm commented Aug 10, 2022

zhongeric Aug 10, 2022

zhongeric commented Aug 11, 2022

vm Aug 11, 2022 •

edited

Loading

vm Aug 11, 2022

zhongeric Aug 11, 2022

zhongeric Aug 11, 2022

vm Aug 11, 2022

zzmp Aug 11, 2022

zhongeric Aug 11, 2022

zzmp Aug 11, 2022

zhongeric Aug 11, 2022

zzmp Aug 11, 2022

zhongeric Aug 11, 2022

zzmp Aug 11, 2022

zhongeric Aug 11, 2022

zzmp Aug 11, 2022

feat: Add support for mixed routes in the interface #4181

feat: Add support for mixed routes in the interface #4181

Conversation

zhongeric commented Jul 25, 2022 • edited Loading

vercel bot commented Jul 25, 2022 • edited Loading

zhongeric Aug 5, 2022 • edited Loading

Choose a reason for hiding this comment

vm commented Aug 10, 2022

Choose a reason for hiding this comment

zhongeric commented Aug 11, 2022

vm Aug 11, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

zhongeric commented Jul 25, 2022 •

edited

Loading

vercel bot commented Jul 25, 2022 •

edited

Loading

zhongeric Aug 5, 2022 •

edited

Loading

vm Aug 11, 2022 •

edited

Loading