chore: bump sor to 4.7.0 - feat: SOR level implementation to support …

…1) expanding mixed quoter v1 to L2s 2) support migrate mixed quoter v1 to mixed quoter v2 across chains (#746) * chore: bump sor to 4.7.0 - feat: SOR level implementation to support 1) expanding mixed quoter v1 to L2s 2) support migrate mixed quoter v1 to mixed quoter v2 across chains * 4.7.0 * also fix alpha-router integ-tests * make other gas params protocol dependent as well * fix alpha router compiling error
Uniswap · Oct 15, 2024 · a65a782 · a65a782
1 parent af35daf
commit a65a782
Show file tree

Hide file tree

Showing 6 changed files with 188 additions and 89 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@uniswap/smart-order-router",
-  "version": "4.6.2",
+  "version": "4.7.0",
   "description": "Uniswap Smart Order Router",
   "main": "build/main/index.js",
   "typings": "build/main/index.d.ts",

diff --git a/src/providers/on-chain-quote-provider.ts b/src/providers/on-chain-quote-provider.ts
@@ -349,23 +349,35 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
     },
     protected batchParams: (
       optimisticCachedRoutes: boolean,
-      useMixedRouteQuoter: boolean
-    ) => BatchParams = (_optimisticCachedRoutes, _useMixedRouteQuoter) => {
+      protocol: Protocol
+    ) => BatchParams = (_optimisticCachedRoutes, _protocol) => {
       return {
         multicallChunk: 150,
         gasLimitPerCall: 1_000_000,
         quoteMinSuccessRate: 0.2,
       };
     },
-    protected gasErrorFailureOverride: FailureOverrides = {
-      gasLimitOverride: 1_500_000,
-      multicallChunk: 100,
+    protected gasErrorFailureOverride: (
+      protocol: Protocol
+    ) => FailureOverrides = (_protocol: Protocol) => {
+      return {
+        gasLimitOverride: 1_500_000,
+        multicallChunk: 100,
+      };
     },
     // successRateFailureOverrides and blockNumberConfig are not always override in alpha-router.
     // So we will extract out below default values into constants.
     // In alpha-router default case, we will also define the constants with same values as below.
-    protected successRateFailureOverrides: FailureOverrides = DEFAULT_SUCCESS_RATE_FAILURE_OVERRIDES,
-    protected blockNumberConfig: BlockNumberConfig = DEFAULT_BLOCK_NUMBER_CONFIGS,
+    protected successRateFailureOverrides: (
+      protocol: Protocol
+    ) => FailureOverrides = (_protocol: Protocol) => {
+      return DEFAULT_SUCCESS_RATE_FAILURE_OVERRIDES;
+    },
+    protected blockNumberConfig: (protocol: Protocol) => BlockNumberConfig = (
+      _protocol: Protocol
+    ) => {
+      return DEFAULT_BLOCK_NUMBER_CONFIGS;
+    },
     protected quoterAddressOverride?: (
       useMixedRouteQuoter: boolean,
       mixedRouteContainsV4Pool: boolean,
@@ -374,11 +386,21 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
     protected metricsPrefix: (
       chainId: ChainId,
       useMixedRouteQuoter: boolean,
+      mixedRouteContainsV4Pool: boolean,
+      protocol: Protocol,
       optimisticCachedRoutes: boolean
-    ) => string = (chainId, useMixedRouteQuoter, optimisticCachedRoutes) =>
+    ) => string = (
+      chainId,
+      useMixedRouteQuoter,
+      mixedRouteContainsV4Pool,
+      protocol,
+      optimisticCachedRoutes
+    ) =>
       useMixedRouteQuoter
-        ? `ChainId_${chainId}_MixedQuoter_OptimisticCachedRoutes${optimisticCachedRoutes}_`
-        : `ChainId_${chainId}_V3Quoter_OptimisticCachedRoutes${optimisticCachedRoutes}_`
+        ? `ChainId_${chainId}_${protocol}RouteQuoter${
+            mixedRouteContainsV4Pool ? 'V2' : 'V1'
+          }_OptimisticCachedRoutes${optimisticCachedRoutes}_`
+        : `ChainId_${chainId}_${protocol}Quoter_OptimisticCachedRoutes${optimisticCachedRoutes}_`
   ) {}
 
   private getQuoterAddress(
@@ -611,6 +633,12 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
             (route as MixedRoute).pools.some((pool) => pool instanceof V4Pool)
         )
       : false;
+    const protocol = useMixedRouteQuoter
+      ? Protocol.MIXED
+      : useV4RouteQuoter
+      ? Protocol.V4
+      : Protocol.V3;
+
     const optimisticCachedRoutes =
       _providerConfig?.optimisticCachedRoutes ?? false;
 
@@ -619,13 +647,13 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
 
     let multicallChunk = this.batchParams(
       optimisticCachedRoutes,
-      useMixedRouteQuoter
+      protocol
     ).multicallChunk;
     let gasLimitOverride = this.batchParams(
       optimisticCachedRoutes,
-      useMixedRouteQuoter
+      protocol
     ).gasLimitPerCall;
-    const { baseBlockOffset, rollback } = this.blockNumberConfig;
+    const { baseBlockOffset, rollback } = this.blockNumberConfig(protocol);
 
     // Apply the base block offset if provided
     const originalBlockNumber = await this.provider.getBlockNumber();
@@ -707,6 +735,8 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
       `${this.metricsPrefix(
         this.chainId,
         useMixedRouteQuoter,
+        mixedRouteContainsV4Pool,
+        protocol,
         optimisticCachedRoutes
       )}QuoteBatchSize`,
       inputs.length,
@@ -716,6 +746,8 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
       `${this.metricsPrefix(
         this.chainId,
         useMixedRouteQuoter,
+        mixedRouteContainsV4Pool,
+        protocol,
         optimisticCachedRoutes
       )}QuoteBatchSize_${ID_TO_NETWORK_NAME(this.chainId)}`,
       inputs.length,
@@ -771,11 +803,6 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
               try {
                 totalCallsMade = totalCallsMade + 1;
 
-                const protocol = useMixedRouteQuoter
-                  ? Protocol.MIXED
-                  : useV4RouteQuoter
-                  ? Protocol.V4
-                  : Protocol.V3;
                 const results = await this.consolidateResults(
                   protocol,
                   useMixedRouteQuoter,
@@ -790,6 +817,8 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
                   results.results,
                   haveRetriedForSuccessRate,
                   useMixedRouteQuoter,
+                  mixedRouteContainsV4Pool,
+                  protocol,
                   optimisticCachedRoutes
                 );
 
@@ -896,6 +925,8 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
                   `${this.metricsPrefix(
                     this.chainId,
                     useMixedRouteQuoter,
+                    mixedRouteContainsV4Pool,
+                    protocol,
                     optimisticCachedRoutes
                   )}QuoteBlockConflictErrorRetry`,
                   1,
@@ -911,6 +942,8 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
                   `${this.metricsPrefix(
                     this.chainId,
                     useMixedRouteQuoter,
+                    mixedRouteContainsV4Pool,
+                    protocol,
                     optimisticCachedRoutes
                   )}QuoteBlockHeaderNotFoundRetry`,
                   1,
@@ -955,6 +988,8 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
                   `${this.metricsPrefix(
                     this.chainId,
                     useMixedRouteQuoter,
+                    mixedRouteContainsV4Pool,
+                    protocol,
                     optimisticCachedRoutes
                   )}QuoteTimeoutRetry`,
                   1,
@@ -968,22 +1003,28 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
                   `${this.metricsPrefix(
                     this.chainId,
                     useMixedRouteQuoter,
+                    mixedRouteContainsV4Pool,
+                    protocol,
                     optimisticCachedRoutes
                   )}QuoteOutOfGasExceptionRetry`,
                   1,
                   MetricLoggerUnit.Count
                 );
                 haveRetriedForOutOfGas = true;
               }
-              gasLimitOverride = this.gasErrorFailureOverride.gasLimitOverride;
-              multicallChunk = this.gasErrorFailureOverride.multicallChunk;
+              gasLimitOverride =
+                this.gasErrorFailureOverride(protocol).gasLimitOverride;
+              multicallChunk =
+                this.gasErrorFailureOverride(protocol).multicallChunk;
               retryAll = true;
             } else if (error instanceof SuccessRateError) {
               if (!haveRetriedForSuccessRate) {
                 metric.putMetric(
                   `${this.metricsPrefix(
                     this.chainId,
                     useMixedRouteQuoter,
+                    mixedRouteContainsV4Pool,
+                    protocol,
                     optimisticCachedRoutes
                   )}QuoteSuccessRateRetry`,
                   1,
@@ -993,9 +1034,9 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
 
                 // Low success rate can indicate too little gas given to each call.
                 gasLimitOverride =
-                  this.successRateFailureOverrides.gasLimitOverride;
+                  this.successRateFailureOverrides(protocol).gasLimitOverride;
                 multicallChunk =
-                  this.successRateFailureOverrides.multicallChunk;
+                  this.successRateFailureOverrides(protocol).multicallChunk;
                 retryAll = true;
               }
             } else {
@@ -1004,6 +1045,8 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
                   `${this.metricsPrefix(
                     this.chainId,
                     useMixedRouteQuoter,
+                    mixedRouteContainsV4Pool,
+                    protocol,
                     optimisticCachedRoutes
                   )}QuoteUnknownReasonRetry`,
                   1,
@@ -1099,6 +1142,8 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
       `${this.metricsPrefix(
         this.chainId,
         useMixedRouteQuoter,
+        mixedRouteContainsV4Pool,
+        protocol,
         optimisticCachedRoutes
       )}QuoteLatency`,
       endTime - startTime,
@@ -1109,6 +1154,8 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
       `${this.metricsPrefix(
         this.chainId,
         useMixedRouteQuoter,
+        mixedRouteContainsV4Pool,
+        protocol,
         optimisticCachedRoutes
       )}QuoteApproxGasUsedPerSuccessfulCall`,
       approxGasUsedPerSuccessCall,
@@ -1119,6 +1166,8 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
       `${this.metricsPrefix(
         this.chainId,
         useMixedRouteQuoter,
+        mixedRouteContainsV4Pool,
+        protocol,
         optimisticCachedRoutes
       )}QuoteNumRetryLoops`,
       finalAttemptNumber - 1,
@@ -1129,6 +1178,8 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
       `${this.metricsPrefix(
         this.chainId,
         useMixedRouteQuoter,
+        mixedRouteContainsV4Pool,
+        protocol,
         optimisticCachedRoutes
       )}QuoteTotalCallsToProvider`,
       totalCallsMade,
@@ -1139,6 +1190,8 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
       `${this.metricsPrefix(
         this.chainId,
         useMixedRouteQuoter,
+        mixedRouteContainsV4Pool,
+        protocol,
         optimisticCachedRoutes
       )}QuoteExpectedCallsToProvider`,
       expectedCallsMade,
@@ -1149,6 +1202,8 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
       `${this.metricsPrefix(
         this.chainId,
         useMixedRouteQuoter,
+        mixedRouteContainsV4Pool,
+        protocol,
         optimisticCachedRoutes
       )}QuoteNumRetriedCalls`,
       totalCallsMade - expectedCallsMade,
@@ -1342,6 +1397,8 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
     allResults: Result<[BigNumber, BigNumber[], number[], BigNumber]>[],
     haveRetriedForSuccessRate: boolean,
     useMixedRouteQuoter: boolean,
+    mixedRouteContainsV4Pool: boolean,
+    protocol: Protocol,
     optimisticCachedRoutes: boolean
   ): void | SuccessRateError {
     const numResults = allResults.length;
@@ -1353,7 +1410,7 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
 
     const { quoteMinSuccessRate } = this.batchParams(
       optimisticCachedRoutes,
-      useMixedRouteQuoter
+      protocol
     );
     if (successRate < quoteMinSuccessRate) {
       if (haveRetriedForSuccessRate) {
@@ -1364,6 +1421,8 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
           `${this.metricsPrefix(
             this.chainId,
             useMixedRouteQuoter,
+            mixedRouteContainsV4Pool,
+            protocol,
             optimisticCachedRoutes
           )}QuoteRetriedSuccessRateLow`,
           successRate,
@@ -1377,6 +1436,8 @@ export class OnChainQuoteProvider implements IOnChainQuoteProvider {
         `${this.metricsPrefix(
           this.chainId,
           useMixedRouteQuoter,
+          mixedRouteContainsV4Pool,
+          protocol,
           optimisticCachedRoutes
         )}QuoteSuccessRateLow`,
         successRate,