@imtbl/dex-sdk 2.2.4-alpha.1 → 2.2.5-alpha.0

package/dist/types/lib/getQuotesForRoutes.d.ts

@@ -1,6 +1,8 @@
 import { Route } from '@uniswap/v3-sdk';
-import { TradeType, Token } from '@uniswap/sdk-core';
+import { TradeType, Token, Fraction } from '@uniswap/sdk-core';
+import { Result } from 'ethers';
 import { CoinAmount, ERC20 } from '../types';
+import { BlockTag } from './multicall';
 export interface Provider {
     send: (method: string, params: any[]) => Promise<string>;
 }
@@ -10,5 +12,14 @@ export type QuoteResult = {
     amountIn: CoinAmount<ERC20>;
     amountOut: CoinAmount<ERC20>;
     tradeType: TradeType;
+    priceImpact: Fraction;
 };
-export declare function getQuotesForRoutes(provider: Provider, quoterContractAddress: string, routes: Route<Token, Token>[], amountSpecified: CoinAmount<ERC20>, tradeType: TradeType): Promise<QuoteResult[]>;
+export declare function parseQuoteResult(quoteResult: Result, route: Route<Token, Token>, amountSpecified: CoinAmount<ERC20>, tradeType: TradeType): {
+    route: Route<Token, Token>;
+    amountIn: CoinAmount<ERC20>;
+    amountOut: CoinAmount<ERC20>;
+    gasEstimate: bigint;
+    tradeType: TradeType;
+    priceImpact: Fraction;
+};
+export declare function getQuotesForRoutes(provider: Provider, quoterContractAddress: string, routes: Route<Token, Token>[], amountSpecified: CoinAmount<ERC20>, tradeType: TradeType, blockTag: BlockTag): Promise<QuoteResult[]>;

package/dist/types/lib/multicall.d.ts

@@ -1,12 +1,17 @@
 import { Multicall, UniswapInterfaceMulticall } from '../contracts/types/Multicall';
 type Address = string;
+export type BlockTag = 'latest' | `0x${string}`;
 export type SingleContractCallOptions = {
     gasRequired: number;
+    blockTag: BlockTag;
+};
+export type MulticallOptions = {
+    blockTag: BlockTag;
 };
 export type MulticallResponse = {
     blockNumber: bigint;
     returnData: UniswapInterfaceMulticall.ResultStructOutput[];
 };
-export declare function multicallSingleCallDataMultipleContracts(multicallContract: Multicall, functionName: string, addresses: Address[]): Promise<MulticallResponse>;
+export declare function multicallSingleCallDataMultipleContracts(multicallContract: Multicall, functionName: string, addresses: Address[], options?: MulticallOptions): Promise<MulticallResponse>;
 export declare function multicallMultipleCallDataSingContract(multicallContract: Multicall, calldata: string[], address: Address, options?: SingleContractCallOptions): Promise<MulticallResponse>;
 export {};

package/dist/types/lib/poolUtils/fetchValidPools.d.ts

@@ -2,6 +2,7 @@ import { Pool } from '@uniswap/v3-sdk';
 import { ERC20 } from '../../types';
 import { ERC20Pair } from './generateERC20Pairs';
 import { Multicall } from '../../contracts/types';
+import { BlockTag } from '../multicall';
 export type Slot0 = {
     sqrtPriceX96: bigint;
     tick: number;
@@ -11,4 +12,4 @@ export type Slot0 = {
     feeProtocol: number;
     unlocked: boolean;
 };
-export declare const fetchValidPools: (multicallContract: Multicall, erc20Pair: ERC20Pair, commonRoutingERC20s: ERC20[], factoryAddress: string) => Promise<Pool[]>;
+export declare const fetchValidPools: (multicallContract: Multicall, erc20Pair: ERC20Pair, commonRoutingERC20s: ERC20[], factoryAddress: string, blockTag: BlockTag) => Promise<Pool[]>;

package/dist/types/lib/router.d.ts

@@ -4,6 +4,7 @@ import { JsonRpcProvider } from 'ethers';
 import { CoinAmount, ERC20 } from '../types';
 import { QuoteResult } from './getQuotesForRoutes';
 import type { Multicall } from '../contracts/types';
+import { BlockTag } from './multicall';
 export type RoutingContracts = {
     multicall: string;
     coreFactory: string;
@@ -15,7 +16,7 @@ export declare class Router {
     routingTokens: ERC20[];
     routingContracts: RoutingContracts;
     constructor(provider: JsonRpcProvider, multicallContract: Multicall, routingTokens: ERC20[], routingContracts: RoutingContracts);
-    findOptimalRoute(amountSpecified: CoinAmount<ERC20>, otherToken: ERC20, tradeType: TradeType, maxHops?: number): Promise<QuoteResult>;
+    findOptimalRoute(amountSpecified: CoinAmount<ERC20>, otherToken: ERC20, tradeType: TradeType, maxHops?: number, blockTag?: BlockTag): Promise<QuoteResult>;
     private getBestQuoteFromRoutes;
     private bestQuoteForAmountIn;
     private bestQuoteForAmountOut;

package/dist/types/lib/router.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/test/utils.d.ts

@@ -29,6 +29,7 @@ export declare const IMX_TEST_TOKEN: ERC20;
 export declare const WIMX_TEST_TOKEN: ERC20;
 export declare const WETH_TEST_TOKEN: ERC20;
 export declare const USDC_TEST_TOKEN: ERC20;
+export declare const USDT_TEST_TOKEN: ERC20;
 export declare const FUN_TEST_TOKEN: ERC20;
 export declare const NATIVE_TEST_TOKEN: Native;
 export declare const nativeTokenService: NativeTokenService;

package/dist/types/types/index.d.ts

@@ -66,6 +66,7 @@ export type Quote = {
     amount: Amount;
     amountWithMaxSlippage: Amount;
     slippage: number;
+    priceImpact: number;
     fees: Fee[];
 };
 /**

package/package.json

@@ -1,11 +1,11 @@
 {
   "name": "@imtbl/dex-sdk",
   "description": "DEX Provider package for the Immutable SDK",
-  "version": "2.2.4-alpha.1",
+  "version": "2.2.5-alpha.0",
   "author": "Immutable",
   "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
   "dependencies": {
-    "@imtbl/config": "2.2.4-alpha.1",
+    "@imtbl/config": "2.2.5-alpha.0",
     "@uniswap/sdk-core": "^3.0.1",
     "@uniswap/swap-router-contracts": "^1.3.1",
     "@uniswap/v3-sdk": "^3.9.0",