@xspswap/smart-order-router
Version:
XSwap Protocol V3 Smart Order Router
32 lines (31 loc) • 1.31 kB
TypeScript
import { ApprovalTypes } from '@x-swap-protocol/router-sdk';
import { Currency, CurrencyAmount } from '@x-swap-protocol/sdk-core';
import { ChainId } from '../util';
import { IMulticallProvider } from './multicall-provider';
type TokenApprovalTypes = {
approvalTokenIn: ApprovalTypes;
approvalTokenOut: ApprovalTypes;
};
/**
* Provider for accessing the SwapRouter02 Contract .
*
* @export
* @interface IRouterProvider
*/
export interface ISwapRouterProvider {
/**
* Get the approval method needed for each token. Throws an error if either query fails.
*
* @param tokenInAmount The Currency Amount of tokenIn needed by the user
* @param tokenOutAmount The Currency Amount of tokenOut needed by the user
* @returns the Approval Types for each token.
*/
getApprovalType(tokenInAmount: CurrencyAmount<Currency>, tokenOutAmount: CurrencyAmount<Currency>): Promise<TokenApprovalTypes>;
}
export declare class SwapRouterProvider implements ISwapRouterProvider {
protected multicall2Provider: IMulticallProvider;
protected chainId: ChainId;
constructor(multicall2Provider: IMulticallProvider, chainId: ChainId);
getApprovalType(tokenInAmount: CurrencyAmount<Currency>, tokenOutAmount: CurrencyAmount<Currency>): Promise<TokenApprovalTypes>;
}
export {};