@synthra-swap/smart-order-router 3.15.33 → 3.16.1

package/build/main/routers/alpha-router/alpha-router.d.ts

@@ -1,20 +1,19 @@
 import { BaseProvider } from '@ethersproject/providers';
-import { ChainId, Currency, TradeType } from '@synthra-swap/sdk-core';
-import { Protocol } from '@uniswap/router-sdk';
-import { Position } from '@uniswap/v3-sdk';
-import { IOnChainQuoteProvider, IRouteCachingProvider, ISwapRouterProvider, IV2QuoteProvider, IV2SubgraphProvider, Simulator, UniswapMulticallProvider } from '../../providers';
+import { ChainId, Currency, TradeType } from '@synthra-swap/sdk/core';
+import { Protocol } from '../../util/router-sdk';
+import { Position } from '@synthra-swap/sdk/v3';
+import { IOnChainQuoteProvider, IRouteCachingProvider, ISwapRouterProvider, Simulator, UniswapMulticallProvider } from '../../providers';
 import { ITokenListProvider } from '../../providers/caching-token-list-provider';
 import { IGasPriceProvider } from '../../providers/gas-price-provider';
 import { ITokenProvider } from '../../providers/token-provider';
 import { ITokenValidatorProvider } from '../../providers/token-validator-provider';
-import { IV2PoolProvider } from '../../providers/v2/pool-provider';
 import { ArbitrumGasData, IL2GasDataProvider, OptimismGasData } from '../../providers/v3/gas-data-provider';
 import { IV3PoolProvider } from '../../providers/v3/pool-provider';
 import { IV3SubgraphProvider } from '../../providers/v3/subgraph-provider';
 import { CurrencyAmount } from '../../util/amounts';
 import { IRouter, ISwapToRatio, SwapAndAddConfig, SwapAndAddOptions, SwapOptions, SwapRoute, SwapToRatioResponse } from '../router';
-import { IOnChainGasModelFactory, IV2GasModelFactory } from './gas-models/gas-model';
-import { MixedQuoter, V2Quoter, V3Quoter } from './quoters';
+import { IOnChainGasModelFactory } from './gas-models/gas-model';
+import { V3Quoter } from './quoters';
 export declare type AlphaRouterParams = {
     /**
      * The chain id for this instance of the Alpha Router.
@@ -42,19 +41,6 @@ export declare type AlphaRouterParams = {
      * The provider for getting V3 quotes.
      */
     onChainQuoteProvider?: IOnChainQuoteProvider;
-    /**
-     * The provider for getting all pools that exist on V2 from the Subgraph. The pools
-     * from this provider are filtered during the algorithm to a set of candidate pools.
-     */
-    v2SubgraphProvider?: IV2SubgraphProvider;
-    /**
-     * The provider for getting data about V2 pools.
-     */
-    v2PoolProvider?: IV2PoolProvider;
-    /**
-     * The provider for getting V3 quotes.
-     */
-    v2QuoteProvider?: IV2QuoteProvider;
     /**
      * The provider for getting data about Tokens.
      */
@@ -70,18 +56,8 @@ export declare type AlphaRouterParams = {
      */
     v3GasModelFactory?: IOnChainGasModelFactory;
     /**
-     * A factory for generating a gas model that is used when estimating the gas used by
-     * V2 routes.
-     */
-    v2GasModelFactory?: IV2GasModelFactory;
-    /**
-     * A factory for generating a gas model that is used when estimating the gas used by
-     * V3 routes.
-     */
-    mixedRouteGasModelFactory?: IOnChainGasModelFactory;
-    /**
-     * A token list that specifies Token that should be blocked from routing through.
-     * Defaults to Uniswap's unsupported token list.
+     * A token list that specifies tokens that should be blocked from routing through.
+     * Defaults to no blocklist so each deployment can own its chain-specific policy.
      */
     blockedTokenListProvider?: ITokenListProvider;
     /**
@@ -177,10 +153,6 @@ export declare type AlphaRouterConfig = {
      * will be used.
      */
     protocols?: Protocol[];
-    /**
-     * Config for selecting which pools to consider routing via on V2.
-     */
-    v2PoolSelection: ProtocolPoolSelection;
     /**
      * Config for selecting which pools to consider routing via on V3.
      */
@@ -198,16 +170,6 @@ export declare type AlphaRouterConfig = {
      * This parameters should always be set to 1. It is only included for testing purposes.
      */
     minSplits: number;
-    /**
-     * Forces the returned swap to route across all protocols.
-     * This parameter should always be false. It is only included for testing purposes.
-     */
-    forceCrossProtocol: boolean;
-    /**
-     * Force the alpha router to choose a mixed route swap.
-     * Default will be falsy. It is only included for testing purposes.
-     */
-    forceMixedRoutes?: boolean;
     /**
      * The minimum percentage of the input token to use for each route in a split route.
      * All routes will have a multiple of this value. For example is distribution percentage is 5,
@@ -218,6 +180,12 @@ export declare type AlphaRouterConfig = {
      * 40% of input => Route 3
      */
     distributionPercent: number;
+    /**
+     * Enables a low-latency first pass before the full route search. The fast pass
+     * quotes a smaller V3-only route universe and returns immediately when it finds
+     * a valid route. If it finds no route, the router falls back to the full search.
+     */
+    enableFastQuote?: boolean;
 };
 export declare class AlphaRouter implements IRouter<AlphaRouterConfig>, ISwapToRatio<AlphaRouterConfig, SwapAndAddConfig> {
     protected chainId: ChainId;
@@ -226,24 +194,17 @@ export declare class AlphaRouter implements IRouter<AlphaRouterConfig>, ISwapToR
     protected v3SubgraphProvider: IV3SubgraphProvider;
     protected v3PoolProvider: IV3PoolProvider;
     protected onChainQuoteProvider: IOnChainQuoteProvider;
-    protected v2SubgraphProvider: IV2SubgraphProvider;
-    protected v2QuoteProvider: IV2QuoteProvider;
-    protected v2PoolProvider: IV2PoolProvider;
     protected tokenProvider: ITokenProvider;
     protected gasPriceProvider: IGasPriceProvider;
     protected swapRouterProvider: ISwapRouterProvider;
     protected v3GasModelFactory: IOnChainGasModelFactory;
-    protected v2GasModelFactory: IV2GasModelFactory;
-    protected mixedRouteGasModelFactory: IOnChainGasModelFactory;
     protected tokenValidatorProvider?: ITokenValidatorProvider;
     protected blockedTokenListProvider?: ITokenListProvider;
     protected l2GasDataProvider?: IL2GasDataProvider<OptimismGasData> | IL2GasDataProvider<ArbitrumGasData>;
     protected simulator?: Simulator;
-    protected v2Quoter: V2Quoter;
     protected v3Quoter: V3Quoter;
-    protected mixedQuoter: MixedQuoter;
     protected routeCachingProvider?: IRouteCachingProvider;
-    constructor({ chainId, provider, multicall2Provider, v3PoolProvider, onChainQuoteProvider, v2PoolProvider, v2QuoteProvider, v2SubgraphProvider, tokenProvider, blockedTokenListProvider, v3SubgraphProvider, gasPriceProvider, v3GasModelFactory, v2GasModelFactory, mixedRouteGasModelFactory, swapRouterProvider, optimismGasDataProvider, tokenValidatorProvider, arbitrumGasDataProvider, simulator, routeCachingProvider, }: AlphaRouterParams);
+    constructor({ chainId, provider, multicall2Provider, v3PoolProvider, onChainQuoteProvider, tokenProvider, blockedTokenListProvider, v3SubgraphProvider, gasPriceProvider, v3GasModelFactory, swapRouterProvider, optimismGasDataProvider, tokenValidatorProvider, arbitrumGasDataProvider, simulator, routeCachingProvider, }: AlphaRouterParams);
     routeToRatio(token0Balance: CurrencyAmount, token1Balance: CurrencyAmount, position: Position, swapAndAddConfig: SwapAndAddConfig, swapAndAddOptions?: SwapAndAddOptions, routingConfig?: Partial<AlphaRouterConfig>): Promise<SwapToRatioResponse>;
     /**
      * @inheritdoc IRouter
@@ -251,6 +212,8 @@ export declare class AlphaRouter implements IRouter<AlphaRouterConfig>, ISwapToR
     route(amount: CurrencyAmount, quoteCurrency: Currency, tradeType: TradeType, swapConfig?: SwapOptions, partialRoutingConfig?: Partial<AlphaRouterConfig>): Promise<SwapRoute | null>;
     private getSwapRouteFromCache;
     private getSwapRouteFromChain;
+    private getFastSwapRouteFromChain;
+    private getFastRoutingConfig;
     private tradeTypeStr;
     private tokenPairSymbolTradeTypeChainId;
     private determineCurrencyInOutFromTradeType;