Class Router

Hierarchy (view full)

BaseRouter
- Router

Index

Constructors

Constructors

constructor

new Router(address, config): Router
Parameters
- address: Address
- config: BaseRouterConfig
Returns Router
Inherited from BaseRouter.constructor
- Defined in src/entities/Router/BaseRouter.ts:85

Properties

`Protected` `Readonly` _contract

_contract: WrappedContract

The wrapped contract that the entity is holding.

Remarks

This should not be used directly. Instead, the getter contract should be used to have the correct type of the wrapped contract.

`Readonly` address

address: Address

the inner contract address

`Readonly` aggregatorHelper

aggregatorHelper: AggregatorHelper<true>

`Readonly` approxParamsGenerator

approxParamsGenerator: ApproxParamsGenerator

`Readonly` chainId

chainId: ChainId

`Readonly` checkErrorOnSimulation

checkErrorOnSimulation: boolean

`Readonly` events

events: EventEmitter<RouterEvents, BaseRouter> = ...

`Readonly` gasFeeEstimator

gasFeeEstimator: GasFeeEstimator

`Readonly` limitOrderMatcher

limitOrderMatcher: limitOrder.LimitOrderMatcher

`Readonly` limitOrderRouteSelector

limitOrderRouteSelector: LimitOrderRouteSelector

`Optional` `Readonly` multicall

multicall?: Multicall

The Multicall instance used by this entity.

`Readonly` networkConnection

networkConnection: NetworkConnection

The networkConnection of this entity.

`Readonly` optimalOutputRouteSelector

optimalOutputRouteSelector: OptimalOutputRouteSelector

`Readonly` tokenAmountConverter

tokenAmountConverter: TokenAmountConverter

Accessors

contract

get contract(): WrappedContract<IPAllActionV3>
this._contract but with the casted type.

Returns WrappedContract<IPAllActionV3>
Remarks
It is intended to be overridden in the subclasses.

See
PendleEntity#_contract
Inherited from BaseRouter.contract
- Defined in src/entities/Router/BaseRouter.ts:125

entityConfig

get entityConfig(): BaseRouterConfig
The config of this entity.

Returns BaseRouterConfig
Remarks
It can be used to pass as configuration for a new entity. It should be overridden in the subclass.
Inherited from BaseRouter.entityConfig
- Defined in src/entities/Router/BaseRouter.ts:129

provider

get provider(): undefined | Provider
Returns undefined | Provider
Inherited from BaseRouter.provider
- Defined in src/entities/Router/BaseRouter.ts:121

Methods

addExtraParams

addExtraParams<T>(params): FixedRouterMetaMethodExtraParams<T>
Redefine the method to redefine the return type
Type Parameters
- T extends MetaMethodType
Parameters
- params: RouterMetaMethodExtraParams<T>
Returns FixedRouterMetaMethodExtraParams<T>
Inherited from BaseRouter.addExtraParams
- Defined in src/entities/Router/BaseRouter.ts:189

addLiquidityDualSyAndPt

addLiquidityDualSyAndPt<T>(market, syDesired, ptDesired, slippage, _params?): RouterMetaMethodReturnType<T, "addLiquidityDualSyAndPt", {
    afterMath: MarketStaticMath;
    minLpOut: BN;
    netLpOut: BN;
    netPtUsed: BN;
    netSyUsed: BN;
}>
Type Parameters
- T extends MetaMethodType = "send"
Parameters
- market: Address | MarketEntity
- syDesired: BigNumberish
- ptDesired: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "addLiquidityDualSyAndPt", {
    afterMath: MarketStaticMath;
    minLpOut: BN;
    netLpOut: BN;
    netPtUsed: BN;
    netSyUsed: BN;
}>
Inherited from BaseRouter.addLiquidityDualSyAndPt
- Defined in src/entities/Router/BaseRouter.ts:195

addLiquidityDualTokenAndPt

addLiquidityDualTokenAndPt<T>(market, tokenIn, tokenDesired, ptDesired, slippage, _params?): RouterMetaMethodReturnType<T, "addLiquidityDualTokenAndPt", {
    afterMath: MarketStaticMath;
    intermediateSyAmount: BN;
    minLpOut: BN;
    netLpOut: BN;
    netPtUsed: BN;
    netSyUsed: BN;
    route: AddLiquidityDualTokenAndPt;
    tokenMintSySelectionRoutingResult: OptimalOutputRouteSelectionResult<AddLiquidityDualTokenAndPt>;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- tokenIn: Address
- tokenDesired: BigNumberish
- ptDesired: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "addLiquidityDualTokenAndPt", {
    afterMath: MarketStaticMath;
    intermediateSyAmount: BN;
    minLpOut: BN;
    netLpOut: BN;
    netPtUsed: BN;
    netSyUsed: BN;
    route: AddLiquidityDualTokenAndPt;
    tokenMintSySelectionRoutingResult: OptimalOutputRouteSelectionResult<AddLiquidityDualTokenAndPt>;
}>
Inherited from BaseRouter.addLiquidityDualTokenAndPt
- Defined in src/entities/Router/BaseRouter.ts:236

addLiquiditySinglePt

addLiquiditySinglePt<T>(market, netPtIn, slippage, _params?): RouterMetaMethodReturnType<T, "addLiquiditySinglePt", {
    approxParam: ApproxParamsStruct;
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<AddLiquiditySinglePt>;
    marketStaticMathBefore: MarketStaticMath;
    minLpOut: BN;
    netLpOut: BN;
    netPtToSwap: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyFromSwap: BN;
    priceImpact: FixedX18;
    route: AddLiquiditySinglePt;
    routes: AddLiquiditySinglePt[];
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- netPtIn: BigNumberish
- slippage: number
- _params: MetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "addLiquiditySinglePt", {
    approxParam: ApproxParamsStruct;
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<AddLiquiditySinglePt>;
    marketStaticMathBefore: MarketStaticMath;
    minLpOut: BN;
    netLpOut: BN;
    netPtToSwap: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyFromSwap: BN;
    priceImpact: FixedX18;
    route: AddLiquiditySinglePt;
    routes: AddLiquiditySinglePt[];
}>
Inherited from BaseRouter.addLiquiditySinglePt
- Defined in src/entities/Router/BaseRouter.ts:363

addLiquiditySingleSy

addLiquiditySingleSy<T>(market, _netSyIn, slippage, _params?): RouterMetaMethodReturnType<T, "addLiquiditySingleSy", {
    approxParam: ApproxParamsStruct;
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<AddLiquiditySingleSy>;
    minLpOut: BN;
    netLpOut: BN;
    netPtFromSwap: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyToSwap: BN;
    priceImpact: FixedX18;
    route: AddLiquiditySingleSy;
    routes: AddLiquiditySingleSy[];
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- _netSyIn: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "addLiquiditySingleSy", {
    approxParam: ApproxParamsStruct;
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<AddLiquiditySingleSy>;
    minLpOut: BN;
    netLpOut: BN;
    netPtFromSwap: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyToSwap: BN;
    priceImpact: FixedX18;
    route: AddLiquiditySingleSy;
    routes: AddLiquiditySingleSy[];
}>
Inherited from BaseRouter.addLiquiditySingleSy
- Defined in src/entities/Router/BaseRouter.ts:477

addLiquiditySingleSyKeepYt

addLiquiditySingleSyKeepYt<T>(market, netSyIn, slippage, _params?): RouterMetaMethodReturnType<T, "addLiquiditySingleSyKeepYt", {
    minLpOut: BN;
    minYtOut: BN;
    netLpOut: BN;
    netSyToPY: BN;
    netYtOut: BN;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- netSyIn: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "addLiquiditySingleSyKeepYt", {
    minLpOut: BN;
    minYtOut: BN;
    netLpOut: BN;
    netSyToPY: BN;
    netYtOut: BN;
}>
Inherited from BaseRouter.addLiquiditySingleSyKeepYt
- Defined in src/entities/Router/BaseRouter.ts:592

addLiquiditySingleToken

addLiquiditySingleToken<T>(market, tokenIn, netTokenIn, slippage, _params?): RouterMetaMethodReturnType<T, "addLiquiditySingleToken", {
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<AddLiquiditySingleToken>;
    minLpOut: BN;
    netLpOut: BN;
    netPtFromSwap: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyMinted: BN;
    netSyToSwap: BN;
    priceImpact: FixedX18;
    route: AddLiquiditySingleToken;
    routes: AddLiquiditySingleToken[];
    tokenMintSySelectionRoutingResult: OptimalOutputRouteSelectionResult<AddLiquiditySingleToken>;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- tokenIn: Address
- netTokenIn: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "addLiquiditySingleToken", {
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<AddLiquiditySingleToken>;
    minLpOut: BN;
    netLpOut: BN;
    netPtFromSwap: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyMinted: BN;
    netSyToSwap: BN;
    priceImpact: FixedX18;
    route: AddLiquiditySingleToken;
    routes: AddLiquiditySingleToken[];
    tokenMintSySelectionRoutingResult: OptimalOutputRouteSelectionResult<AddLiquiditySingleToken>;
}>
Inherited from BaseRouter.addLiquiditySingleToken
- Defined in src/entities/Router/BaseRouter.ts:637

addLiquiditySingleTokenKeepYt

addLiquiditySingleTokenKeepYt<T>(market, tokenIn, netTokenIn, slippage, _params?): RouterMetaMethodReturnType<T, "addLiquiditySingleTokenKeepYt", {
    afterMath: MarketStaticMath;
    intermediateSyAmount: BN;
    minLpOut: BN;
    minYtOut: BN;
    netLpOut: BN;
    netSyMinted: BN;
    netSyToPY: BN;
    netYtOut: BN;
    route: AddLiquiditySingleTokenKeepYt;
    routes: AddLiquiditySingleTokenKeepYt[];
    tokenMintSySelectionRoutingResult: OptimalOutputRouteSelectionResult<AddLiquiditySingleTokenKeepYt>;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- tokenIn: Address
- netTokenIn: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "addLiquiditySingleTokenKeepYt", {
    afterMath: MarketStaticMath;
    intermediateSyAmount: BN;
    minLpOut: BN;
    minYtOut: BN;
    netLpOut: BN;
    netSyMinted: BN;
    netSyToPY: BN;
    netYtOut: BN;
    route: AddLiquiditySingleTokenKeepYt;
    routes: AddLiquiditySingleTokenKeepYt[];
    tokenMintSySelectionRoutingResult: OptimalOutputRouteSelectionResult<AddLiquiditySingleTokenKeepYt>;
}>
Inherited from BaseRouter.addLiquiditySingleTokenKeepYt
- Defined in src/entities/Router/BaseRouter.ts:836

createTransactionBundler

createTransactionBundler(): RouterTransactionBundler
Returns RouterTransactionBundler
See
RouterTransactionBundler
Inherited from BaseRouter.createTransactionBundler
- Defined in src/entities/Router/BaseRouter.ts:3401

getDefaultMetaMethodExtraParams

getDefaultMetaMethodExtraParams<T>(): FixedRouterMetaMethodExtraParams<T>
Type Parameters
- T extends MetaMethodType
Returns FixedRouterMetaMethodExtraParams<T>
the set of parameters for an entity's write-method (that will do a metaCall). It should be overridden in the subclass.
Inherited from BaseRouter.getDefaultMetaMethodExtraParams
- Defined in src/entities/Router/BaseRouter.ts:162

getMarketAddress

getMarketAddress(market): Address
Parameters
- market: Address | MarketEntity
Returns Address
Inherited from BaseRouter.getMarketAddress
- Defined in src/entities/Router/BaseRouter.ts:3508

getMarketEntity

getMarketEntity(market): MarketEntity
Parameters
- market: Address | MarketEntity
Returns MarketEntity
Inherited from BaseRouter.getMarketEntity
- Defined in src/entities/Router/BaseRouter.ts:3512

getMarketStaticMathWithParams

getMarketStaticMathWithParams(market, params): Promise<MarketStaticMath>
Parameters
- market: Address | MarketEntity
- params: MulticallStaticParams & {
      calcBufferedGas?: CalcBufferedGasFunction;
      method?: MetaMethodType;
  } & {
      aggregatorReceiver: Address;
      entityConfig: BaseRouterConfig;
      forCallStatic: Omit<FixedRouterMetaMethodExtraParams<MetaMethodType>, "method" | "forCallStatic">;
      receiver: Address | ContractMetaMethodUtilFunction<Promise<Address>, Contract>;
  } & {
      blockTimestamp?: number;
      pyIndex?: PyIndex;
  }
Returns Promise<MarketStaticMath>
Inherited from BaseRouter.getMarketStaticMathWithParams
- Defined in src/entities/Router/BaseRouter.ts:133

getPendleSwapAddress

getPendleSwapAddress(swapType): Address
Get pendleSwap address for a given swapType and chainId
Parameters
- swapType: SwapType
  the swapType of the action
Returns Address
NATIVE_ADDRESS_0x00 if:
- there is no PENDLE_SWAP address for chainId.
- or the swapType is not KYBERSWAP or ONE_INCH
The pendleSwap contract address is returned otherwise.
Inherited from BaseRouter.getPendleSwapAddress
- Defined in src/entities/Router/BaseRouter.ts:155

getRouterHelper

getRouterHelper(): WrappedContract<PendleRouterHelper>
Returns WrappedContract<PendleRouterHelper>
Inherited from BaseRouter.getRouterHelper
- Defined in src/entities/Router/BaseRouter.ts:107

getSignerAddress

getSignerAddress(): Promise<undefined | Address>
Returns Promise<undefined | Address>
Inherited from BaseRouter.getSignerAddress
- Defined in src/entities/Router/BaseRouter.ts:115

migrateLiquidityViaSharedSy

migrateLiquidityViaSharedSy<T>(srcMarket, netLpToMigrate, dstMarket, slippage, _params?): RouterHelperMetaMethodReturnType<T, "transferLiquiditySameSyNormal", {
    addLiquidityMetaMethod: ContractMetaMethod<IPAllActionV3, "addLiquiditySingleSy", {
        approxParam: ApproxParamsStruct;
        exchangeRateAfter: MarketExchangeRate;
        loRoutingResult: LimitOrderRouteSelectorResult<AddLiquiditySingleSy>;
        minLpOut: BN;
        netLpOut: BN;
        netPtFromSwap: BN;
        netSyFeeFromLimit: BN;
        netSyFeeFromMarket: BN;
        netSyToSwap: BN;
        priceImpact: FixedX18;
        route: AddLiquiditySingleSy;
        routes: AddLiquiditySingleSy[];
    } & MulticallStaticParams & {
        calcBufferedGas?: CalcBufferedGasFunction;
        method?: "meta-method";
    } & {
        aggregatorReceiver?: Address;
        receiver?: Address | ContractMetaMethodUtilFunction<Promise<Address>, Contract>;
    }>;
    removeLiquidityMetaMethod: ContractMetaMethod<IPAllActionV3, "removeLiquiditySingleSy", {
        exchangeRateAfter: MarketExchangeRate;
        loRoutingResult: LimitOrderRouteSelectorResult<RemoveLiquiditySingleSy>;
        minSyOut: BN;
        netPtFromBurn: BN;
        netSyFeeFromLimit: BN;
        netSyFeeFromMarket: BN;
        netSyFromBurn: BN;
        netSyFromSwap: BN;
        netSyOut: BN;
        priceImpact: FixedX18;
        route: RemoveLiquiditySinglePt;
        routes: RemoveLiquiditySinglePt[];
    } & MulticallStaticParams & {
        calcBufferedGas?: CalcBufferedGasFunction;
        method?: "meta-method";
    } & {
        aggregatorReceiver?: Address;
        receiver?: Address | ContractMetaMethodUtilFunction<Promise<Address>, Contract>;
    }>;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- srcMarket: Address | MarketEntity
- netLpToMigrate: BigNumberish
- dstMarket: Address | MarketEntity
- slippage: number
- _params: MulticallStaticParams & {
      calcBufferedGas?: CalcBufferedGasFunction;
      method?: T;
  } & {
      aggregatorReceiver?: Address;
      receiver?: Address | ContractMetaMethodUtilFunction<Promise<Address>, Contract>;
  } & {
      redeemRewards?: boolean;
  } = {}
Returns RouterHelperMetaMethodReturnType<T, "transferLiquiditySameSyNormal", {
    addLiquidityMetaMethod: ContractMetaMethod<IPAllActionV3, "addLiquiditySingleSy", {
        approxParam: ApproxParamsStruct;
        exchangeRateAfter: MarketExchangeRate;
        loRoutingResult: LimitOrderRouteSelectorResult<AddLiquiditySingleSy>;
        minLpOut: BN;
        netLpOut: BN;
        netPtFromSwap: BN;
        netSyFeeFromLimit: BN;
        netSyFeeFromMarket: BN;
        netSyToSwap: BN;
        priceImpact: FixedX18;
        route: AddLiquiditySingleSy;
        routes: AddLiquiditySingleSy[];
    } & MulticallStaticParams & {
        calcBufferedGas?: CalcBufferedGasFunction;
        method?: "meta-method";
    } & {
        aggregatorReceiver?: Address;
        receiver?: Address | ContractMetaMethodUtilFunction<Promise<Address>, Contract>;
    }>;
    removeLiquidityMetaMethod: ContractMetaMethod<IPAllActionV3, "removeLiquiditySingleSy", {
        exchangeRateAfter: MarketExchangeRate;
        loRoutingResult: LimitOrderRouteSelectorResult<RemoveLiquiditySingleSy>;
        minSyOut: BN;
        netPtFromBurn: BN;
        netSyFeeFromLimit: BN;
        netSyFeeFromMarket: BN;
        netSyFromBurn: BN;
        netSyFromSwap: BN;
        netSyOut: BN;
        priceImpact: FixedX18;
        route: RemoveLiquiditySinglePt;
        routes: RemoveLiquiditySinglePt[];
    } & MulticallStaticParams & {
        calcBufferedGas?: CalcBufferedGasFunction;
        method?: "meta-method";
    } & {
        aggregatorReceiver?: Address;
        receiver?: Address | ContractMetaMethodUtilFunction<Promise<Address>, Contract>;
    }>;
}>
Inherited from BaseRouter.migrateLiquidityViaSharedSy
- Defined in src/entities/Router/BaseRouter.ts:3163

migrateLiquidityViaSharedSyKeepYt

migrateLiquidityViaSharedSyKeepYt<T>(srcMarket, netLpToMigrate, dstMarket, slippage, _params?): RouterHelperMetaMethodReturnType<T, "transferLiquiditySameSyKeepYt", {
    addLiquidityMetaMethod: ContractMetaMethod<IPAllActionV3, "addLiquiditySingleSyKeepYt", {
        minLpOut: BN;
        minYtOut: BN;
        netLpOut: BN;
        netSyToPY: BN;
        netYtOut: BN;
    } & MulticallStaticParams & {
        calcBufferedGas?: CalcBufferedGasFunction;
        method?: "meta-method";
    } & {
        aggregatorReceiver?: Address;
        receiver?: Address | ContractMetaMethodUtilFunction<Promise<Address>, Contract>;
    }>;
    removeLiquidityMetaMethod: ContractMetaMethod<IPAllActionV3, "removeLiquiditySingleSy", {
        exchangeRateAfter: MarketExchangeRate;
        loRoutingResult: LimitOrderRouteSelectorResult<RemoveLiquiditySingleSy>;
        minSyOut: BN;
        netPtFromBurn: BN;
        netSyFeeFromLimit: BN;
        netSyFeeFromMarket: BN;
        netSyFromBurn: BN;
        netSyFromSwap: BN;
        netSyOut: BN;
        priceImpact: FixedX18;
        route: RemoveLiquiditySinglePt;
        routes: RemoveLiquiditySinglePt[];
    } & MulticallStaticParams & {
        calcBufferedGas?: CalcBufferedGasFunction;
        method?: "meta-method";
    } & {
        aggregatorReceiver?: Address;
        receiver?: Address | ContractMetaMethodUtilFunction<Promise<Address>, Contract>;
    }>;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- srcMarket: Address | MarketEntity
- netLpToMigrate: BigNumberish
- dstMarket: Address | MarketEntity
- slippage: number
- _params: MulticallStaticParams & {
      calcBufferedGas?: CalcBufferedGasFunction;
      method?: T;
  } & {
      aggregatorReceiver?: Address;
      receiver?: Address | ContractMetaMethodUtilFunction<Promise<Address>, Contract>;
  } & {
      redeemRewards?: boolean;
  } = {}
Returns RouterHelperMetaMethodReturnType<T, "transferLiquiditySameSyKeepYt", {
    addLiquidityMetaMethod: ContractMetaMethod<IPAllActionV3, "addLiquiditySingleSyKeepYt", {
        minLpOut: BN;
        minYtOut: BN;
        netLpOut: BN;
        netSyToPY: BN;
        netYtOut: BN;
    } & MulticallStaticParams & {
        calcBufferedGas?: CalcBufferedGasFunction;
        method?: "meta-method";
    } & {
        aggregatorReceiver?: Address;
        receiver?: Address | ContractMetaMethodUtilFunction<Promise<Address>, Contract>;
    }>;
    removeLiquidityMetaMethod: ContractMetaMethod<IPAllActionV3, "removeLiquiditySingleSy", {
        exchangeRateAfter: MarketExchangeRate;
        loRoutingResult: LimitOrderRouteSelectorResult<RemoveLiquiditySingleSy>;
        minSyOut: BN;
        netPtFromBurn: BN;
        netSyFeeFromLimit: BN;
        netSyFeeFromMarket: BN;
        netSyFromBurn: BN;
        netSyFromSwap: BN;
        netSyOut: BN;
        priceImpact: FixedX18;
        route: RemoveLiquiditySinglePt;
        routes: RemoveLiquiditySinglePt[];
    } & MulticallStaticParams & {
        calcBufferedGas?: CalcBufferedGasFunction;
        method?: "meta-method";
    } & {
        aggregatorReceiver?: Address;
        receiver?: Address | ContractMetaMethodUtilFunction<Promise<Address>, Contract>;
    }>;
}>
Inherited from BaseRouter.migrateLiquidityViaSharedSyKeepYt
- Defined in src/entities/Router/BaseRouter.ts:3215

mintPyFromSy

mintPyFromSy<T>(yt, amountSyToMint, slippage, _params?): RouterMetaMethodReturnType<T, "mintPyFromSy", {
minPyOut: BN;
netPyOut: BN;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- yt: Address | YtEntity
- amountSyToMint: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "mintPyFromSy", {
minPyOut: BN;
netPyOut: BN;
}>
Inherited from BaseRouter.mintPyFromSy
- Defined in src/entities/Router/BaseRouter.ts:2178

mintPyFromToken

mintPyFromToken<T>(yt, tokenIn, netTokenIn, slippage, _params?): RouterMetaMethodReturnType<T, "mintPyFromToken", {
    intermediateSyAmount: BN;
    minPyOut: BN;
    netPyOut: BN;
    route: MintPyFromToken;
    tokenMintSySelectionRoutingResult: OptimalOutputRouteSelectionResult<MintPyFromToken>;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- yt: Address | YtEntity
- tokenIn: Address
- netTokenIn: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "mintPyFromToken", {
    intermediateSyAmount: BN;
    minPyOut: BN;
    netPyOut: BN;
    route: MintPyFromToken;
    tokenMintSySelectionRoutingResult: OptimalOutputRouteSelectionResult<MintPyFromToken>;
}>
Inherited from BaseRouter.mintPyFromToken
- Defined in src/entities/Router/BaseRouter.ts:2081

mintSyFromToken

mintSyFromToken<T>(sy, tokenIn, netTokenIn, slippage, _params?): RouterMetaMethodReturnType<T, "mintSyFromToken", {
    intermediateSyAmount: BN;
    minSyOut: BN;
    netSyOut: BN;
    route: MintSyFromToken;
    tokenMintSySelectionRoutingResult: OptimalOutputRouteSelectionResult<MintSyFromToken>;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- sy: Address | SyEntity
- tokenIn: Address
- netTokenIn: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "mintSyFromToken", {
    intermediateSyAmount: BN;
    minSyOut: BN;
    netSyOut: BN;
    route: MintSyFromToken;
    tokenMintSySelectionRoutingResult: OptimalOutputRouteSelectionResult<MintSyFromToken>;
}>
Inherited from BaseRouter.mintSyFromToken
- Defined in src/entities/Router/BaseRouter.ts:1887

redeemDueInterestAndRewards

redeemDueInterestAndRewards<T>(redeemingSources, _params?): RouterMetaMethodReturnType<T, "redeemDueInterestAndRewards">
Type Parameters
- T extends MetaMethodType
Parameters
- redeemingSources: {
      markets?: (Address | MarketEntity)[];
      sys?: (Address | SyEntity)[];
      yts?: (Address | YtEntity)[];
  }
  - Optional markets?: (Address | MarketEntity)[]
  - Optional sys?: (Address | SyEntity)[]
  - Optional yts?: (Address | YtEntity)[]
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "redeemDueInterestAndRewards">
Inherited from BaseRouter.redeemDueInterestAndRewards
- Defined in src/entities/Router/BaseRouter.ts:3139

redeemPyToSy

redeemPyToSy<T>(yt, amountPyToRedeem, slippage, _params): RouterMetaMethodReturnType<T, "redeemPyToSy", {
minSyOut: BN;
netSyOut: BN;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- yt: Address | YtEntity
- amountPyToRedeem: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T>
Returns RouterMetaMethodReturnType<T, "redeemPyToSy", {
minSyOut: BN;
netSyOut: BN;
}>
Inherited from BaseRouter.redeemPyToSy
- Defined in src/entities/Router/BaseRouter.ts:2316

redeemPyToToken

redeemPyToToken<T>(yt, netPyIn, tokenOut, slippage, _params?): RouterMetaMethodReturnType<T, "redeemPyToToken", {
    intermediateSyAmount: BN;
    netTokenOut: BN;
    pyIndex: PyIndex;
    route: RedeemPyToToken;
    tokenRedeemSySelectionRoutingResult: OptimalOutputRouteSelectionResult<RedeemPyToToken>;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- yt: Address | YtEntity
- netPyIn: BigNumberish
- tokenOut: Address
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "redeemPyToToken", {
    intermediateSyAmount: BN;
    netTokenOut: BN;
    pyIndex: PyIndex;
    route: RedeemPyToToken;
    tokenRedeemSySelectionRoutingResult: OptimalOutputRouteSelectionResult<RedeemPyToToken>;
}>
Inherited from BaseRouter.redeemPyToToken
- Defined in src/entities/Router/BaseRouter.ts:2203

redeemSyToToken

redeemSyToToken<T>(sy, netSyIn, tokenOut, slippage, _params?): RouterMetaMethodReturnType<T, "redeemSyToToken", {
    intermediateSyAmount: BN;
    netTokenOut: BN;
    route: RedeemSyToToken;
    tokenRedeemSySelectionRoutingResult: OptimalOutputRouteSelectionResult<RedeemSyToToken>;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- sy: Address | SyEntity
- netSyIn: BigNumberish
- tokenOut: Address
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "redeemSyToToken", {
    intermediateSyAmount: BN;
    netTokenOut: BN;
    route: RedeemSyToToken;
    tokenRedeemSySelectionRoutingResult: OptimalOutputRouteSelectionResult<RedeemSyToToken>;
}>
Inherited from BaseRouter.redeemSyToToken
- Defined in src/entities/Router/BaseRouter.ts:1982

removeLiquidityDualSyAndPt

removeLiquidityDualSyAndPt<T>(market, lpToRemove, slippage, _params?): RouterMetaMethodReturnType<T, "removeLiquidityDualSyAndPt", {
    afterMath: MarketStaticMath;
    minPtOut: BN;
    minSyOut: BN;
    netPtOut: BN;
    netSyOut: BN;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- lpToRemove: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "removeLiquidityDualSyAndPt", {
    afterMath: MarketStaticMath;
    minPtOut: BN;
    minSyOut: BN;
    netPtOut: BN;
    netSyOut: BN;
}>
Inherited from BaseRouter.removeLiquidityDualSyAndPt
- Defined in src/entities/Router/BaseRouter.ts:959

removeLiquidityDualTokenAndPt

removeLiquidityDualTokenAndPt<T>(market, lpToRemove, tokenOut, slippage, _params?): RouterMetaMethodReturnType<T, "removeLiquidityDualTokenAndPt", {
    afterMath: MarketStaticMath;
    intermediateSyAmount: BN;
    netPtOut: BN;
    netTokenOut: BN;
    route: RemoveLiquidityDualTokenAndPt;
    routes: RemoveLiquidityDualTokenAndPt[];
    tokenRedeemSySelectionRoutingResult: OptimalOutputRouteSelectionResult<RemoveLiquidityDualTokenAndPt>;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- lpToRemove: BigNumberish
- tokenOut: Address
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "removeLiquidityDualTokenAndPt", {
    afterMath: MarketStaticMath;
    intermediateSyAmount: BN;
    netPtOut: BN;
    netTokenOut: BN;
    route: RemoveLiquidityDualTokenAndPt;
    routes: RemoveLiquidityDualTokenAndPt[];
    tokenRedeemSySelectionRoutingResult: OptimalOutputRouteSelectionResult<RemoveLiquidityDualTokenAndPt>;
}>
Inherited from BaseRouter.removeLiquidityDualTokenAndPt
- Defined in src/entities/Router/BaseRouter.ts:1001

removeLiquiditySinglePt

removeLiquiditySinglePt<T>(market, lpToRemove, slippage, _params?): RouterMetaMethodReturnType<T, "removeLiquiditySinglePt", {
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<RemoveLiquiditySinglePt>;
    minPtOut: BN;
    netPtFromBurn: BN;
    netPtFromSwap: BN;
    netPtOut: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyFromBurn: BN;
    priceImpact: FixedX18;
    route: RemoveLiquiditySinglePt;
    routes: RemoveLiquiditySinglePt[];
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- lpToRemove: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "removeLiquiditySinglePt", {
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<RemoveLiquiditySinglePt>;
    minPtOut: BN;
    netPtFromBurn: BN;
    netPtFromSwap: BN;
    netPtOut: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyFromBurn: BN;
    priceImpact: FixedX18;
    route: RemoveLiquiditySinglePt;
    routes: RemoveLiquiditySinglePt[];
}>
Inherited from BaseRouter.removeLiquiditySinglePt
- Defined in src/entities/Router/BaseRouter.ts:1120

removeLiquiditySingleSy

removeLiquiditySingleSy<T>(market, lpToRemove, slippage, _params?): RouterMetaMethodReturnType<T, "removeLiquiditySingleSy", {
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<RemoveLiquiditySingleSy>;
    minSyOut: BN;
    netPtFromBurn: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyFromBurn: BN;
    netSyFromSwap: BN;
    netSyOut: BN;
    priceImpact: FixedX18;
    route: RemoveLiquiditySinglePt;
    routes: RemoveLiquiditySinglePt[];
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- lpToRemove: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "removeLiquiditySingleSy", {
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<RemoveLiquiditySingleSy>;
    minSyOut: BN;
    netPtFromBurn: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyFromBurn: BN;
    netSyFromSwap: BN;
    netSyOut: BN;
    priceImpact: FixedX18;
    route: RemoveLiquiditySinglePt;
    routes: RemoveLiquiditySinglePt[];
}>
Inherited from BaseRouter.removeLiquiditySingleSy
- Defined in src/entities/Router/BaseRouter.ts:1233

removeLiquiditySingleToken

removeLiquiditySingleToken<T>(market, lpToRemove, tokenOut, slippage, _params?): RouterMetaMethodReturnType<T, "removeLiquiditySingleToken", {
    afterMath: MarketStaticMath;
    exchangeRateAfter: MarketExchangeRate;
    intermediateSyAmount: BN;
    limitOrderMatchedResult: LimitOrderMatchedResult;
    loRoutingResult: LimitOrderRouteSelectorResult<PartialRoute<ComponentsForLimitOrderRouting>>;
    netPtFromBurn: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyFromBurn: BN;
    netSyFromSwap: BN;
    netTokenOut: BN;
    priceImpact: FixedX18;
    route: RemoveLiquiditySingleToken;
    tokenRedeemSySelectionRoutingResult: OptimalOutputRouteSelectionResult<RemoveLiquiditySingleToken>;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- lpToRemove: BigNumberish
- tokenOut: Address
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "removeLiquiditySingleToken", {
    afterMath: MarketStaticMath;
    exchangeRateAfter: MarketExchangeRate;
    intermediateSyAmount: BN;
    limitOrderMatchedResult: LimitOrderMatchedResult;
    loRoutingResult: LimitOrderRouteSelectorResult<PartialRoute<ComponentsForLimitOrderRouting>>;
    netPtFromBurn: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyFromBurn: BN;
    netSyFromSwap: BN;
    netTokenOut: BN;
    priceImpact: FixedX18;
    route: RemoveLiquiditySingleToken;
    tokenRedeemSySelectionRoutingResult: OptimalOutputRouteSelectionResult<RemoveLiquiditySingleToken>;
}>
Inherited from BaseRouter.removeLiquiditySingleToken
- Defined in src/entities/Router/BaseRouter.ts:1344

sellSys

sellSys(tokenOut, slippage, sysAndSyIns, params?): Promise<TokenOutput[]>
Parameters
- tokenOut: Address
- slippage: number
- sysAndSyIns: {
  netSyIns: BigNumberish[];
  sys: Address[];
  }
  - netSyIns: BigNumberish[]
  - sys: Address[]
- Optional params: {
  receiver?: Address;
  }
  - Optional receiver?: Address
Returns Promise<TokenOutput[]>
Inherited from BaseRouter.sellSys
- Defined in src/entities/Router/BaseRouter.ts:3409
sellSys(tokenOut, slippage, syTokenAmounts, params?): Promise<TokenOutput[]>
Parameters
- tokenOut: Address
- slippage: number
- syTokenAmounts: RawTokenAmount<BigNumberish>[]
- Optional params: {
  receiver?: Address;
  }
  - Optional receiver?: Address
Returns Promise<TokenOutput[]>
Inherited from BaseRouter.sellSys
- Defined in src/entities/Router/BaseRouter.ts:3415

sellTokens

sellTokens(tokenOut, slippage, tokensAndTokensIn, params?): Promise<SwapData[]>
Parameters
- tokenOut: Address
- slippage: number
- tokensAndTokensIn: {
  netTokenIns: BigNumberish[];
  tokens: Address[];
  }
  - netTokenIns: BigNumberish[]
  - tokens: Address[]
- Optional params: {
  receiver?: Address;
  }
  - Optional receiver?: Address
Returns Promise<SwapData[]>
Inherited from BaseRouter.sellTokens
- Defined in src/entities/Router/BaseRouter.ts:3433
sellTokens(tokenOut, slippage, tokenAmounts, params?): Promise<SwapData[]>
Parameters
- tokenOut: Address
- slippage: number
- tokenAmounts: RawTokenAmount<BigNumberish>[]
- Optional params: {
  receiver?: Address;
  }
  - Optional receiver?: Address
Returns Promise<SwapData[]>
Inherited from BaseRouter.sellTokens
- Defined in src/entities/Router/BaseRouter.ts:3439

swapExactPtForSy

swapExactPtForSy<T>(market, exactPtIn, slippage, _params?): RouterMetaMethodReturnType<T, "swapExactPtForSy", {
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<SwapExactPtForSy>;
    minSyOut: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyOut: BN;
    priceImpact: FixedX18;
    route: SwapExactPtForSy;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- exactPtIn: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "swapExactPtForSy", {
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<SwapExactPtForSy>;
    minSyOut: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyOut: BN;
    priceImpact: FixedX18;
    route: SwapExactPtForSy;
}>
Inherited from BaseRouter.swapExactPtForSy
- Defined in src/entities/Router/BaseRouter.ts:1529

swapExactPtForToken

swapExactPtForToken<T>(market, exactPtIn, tokenOut, slippage, _params?): RouterMetaMethodReturnType<T, "swapExactPtForToken", {
    exchangeRateAfter: MarketExchangeRate;
    intermediateSyAmount: BN;
    limitOrderMatchedResult: LimitOrderMatchedResult;
    loRoutingResult: LimitOrderRouteSelectorResult<PartialRoute<ComponentsForLimitOrderRouting>>;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyReceivedAfterLimit: BN;
    netTokenOut: BN;
    priceImpact: FixedX18;
    route: SwapExactPtForToken;
    tokenRedeemSySelectionRoutingResult: OptimalOutputRouteSelectionResult<SwapExactPtForToken>;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- exactPtIn: BigNumberish
- tokenOut: Address
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "swapExactPtForToken", {
    exchangeRateAfter: MarketExchangeRate;
    intermediateSyAmount: BN;
    limitOrderMatchedResult: LimitOrderMatchedResult;
    loRoutingResult: LimitOrderRouteSelectorResult<PartialRoute<ComponentsForLimitOrderRouting>>;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyReceivedAfterLimit: BN;
    netTokenOut: BN;
    priceImpact: FixedX18;
    route: SwapExactPtForToken;
    tokenRedeemSySelectionRoutingResult: OptimalOutputRouteSelectionResult<SwapExactPtForToken>;
}>
Inherited from BaseRouter.swapExactPtForToken
- Defined in src/entities/Router/BaseRouter.ts:2444

swapExactPtForYt

swapExactPtForYt<T>(market, exactPtIn, slippage, _params?): RouterMetaMethodReturnType<T, "swapExactPtForYt", {
    afterMath: MarketStaticMath;
    approxParam: ApproxParamsStruct;
    exchangeRateAfter: MarketExchangeRate;
    minYtOut: BN;
    netSyFee: BN;
    netYtOut: BN;
    priceImpact: FixedX18;
    totalPtToSwap: BN;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- exactPtIn: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "swapExactPtForYt", {
    afterMath: MarketStaticMath;
    approxParam: ApproxParamsStruct;
    exchangeRateAfter: MarketExchangeRate;
    minYtOut: BN;
    netSyFee: BN;
    netYtOut: BN;
    priceImpact: FixedX18;
    totalPtToSwap: BN;
}>
Inherited from BaseRouter.swapExactPtForYt
- Defined in src/entities/Router/BaseRouter.ts:3085

swapExactSyForPt

swapExactSyForPt<T>(market, exactSyIn, slippage, _params?): RouterMetaMethodReturnType<T, "swapExactSyForPt", {
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<SwapExactSyForPt>;
    minPtOut: BN;
    netPtOut: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    priceImpact: FixedX18;
    route: SwapExactSyForPt;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- exactSyIn: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "swapExactSyForPt", {
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<SwapExactSyForPt>;
    minPtOut: BN;
    netPtOut: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    priceImpact: FixedX18;
    route: SwapExactSyForPt;
}>
Inherited from BaseRouter.swapExactSyForPt
- Defined in src/entities/Router/BaseRouter.ts:1786

swapExactSyForYt

swapExactSyForYt<T>(market, exactSyIn, slippage, _params?): RouterMetaMethodReturnType<T, "swapExactSyForYt", {
    approxParams: ApproxParamsStruct;
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<SwapExactSyForYt>;
    minYtOut: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netYtOut: BN;
    priceImpact: FixedX18;
    route: SwapExactSyForYt;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- exactSyIn: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "swapExactSyForYt", {
    approxParams: ApproxParamsStruct;
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<SwapExactSyForYt>;
    minYtOut: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netYtOut: BN;
    priceImpact: FixedX18;
    route: SwapExactSyForYt;
}>
Inherited from BaseRouter.swapExactSyForYt
- Defined in src/entities/Router/BaseRouter.ts:2342

swapExactTokenForPt

swapExactTokenForPt<T>(market, tokenIn, netTokenIn, slippage, _params?): RouterMetaMethodReturnType<T, "swapExactTokenForPt", {
    exchangeRateAfter: MarketExchangeRate;
    intermediateSyAmount: BN;
    loRoutingResult: LimitOrderRouteSelectorResult<SwapExactTokenForPt>;
    minPtOut: BN;
    netPtOut: BN;
    netPtReceivedAfterLimit: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyMinted: BN;
    priceImpact: FixedX18;
    route: SwapExactTokenForPt;
    tokenMintSySelectionRoutingResult: OptimalOutputRouteSelectionResult<SwapExactTokenForPt>;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- tokenIn: Address
- netTokenIn: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "swapExactTokenForPt", {
    exchangeRateAfter: MarketExchangeRate;
    intermediateSyAmount: BN;
    loRoutingResult: LimitOrderRouteSelectorResult<SwapExactTokenForPt>;
    minPtOut: BN;
    netPtOut: BN;
    netPtReceivedAfterLimit: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyMinted: BN;
    priceImpact: FixedX18;
    route: SwapExactTokenForPt;
    tokenMintSySelectionRoutingResult: OptimalOutputRouteSelectionResult<SwapExactTokenForPt>;
}>
Inherited from BaseRouter.swapExactTokenForPt
- Defined in src/entities/Router/BaseRouter.ts:1619

swapExactTokenForYt

swapExactTokenForYt<T>(market, tokenIn, netTokenIn, slippage, _params?): RouterMetaMethodReturnType<T, "swapExactTokenForYt", {
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<SwapExactTokenForYt>;
    minYtOut: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyMinted: BN;
    netYtOut: BN;
    priceImpact: FixedX18;
    route: SwapExactTokenForYt;
    tokenMintSySelectionRoutingResult: OptimalOutputRouteSelectionResult<SwapExactTokenForYt>;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- tokenIn: Address
- netTokenIn: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "swapExactTokenForYt", {
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<SwapExactTokenForYt>;
    minYtOut: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyMinted: BN;
    netYtOut: BN;
    priceImpact: FixedX18;
    route: SwapExactTokenForYt;
    tokenMintSySelectionRoutingResult: OptimalOutputRouteSelectionResult<SwapExactTokenForYt>;
}>
Inherited from BaseRouter.swapExactTokenForYt
- Defined in src/entities/Router/BaseRouter.ts:2701

swapExactYtForPt

swapExactYtForPt<T>(market, exactYtIn, slippage, _params?): RouterMetaMethodReturnType<T, "swapExactYtForPt", {
    afterMath: MarketStaticMath;
    approxParam: ApproxParamsStruct;
    exchangeRateAfter: MarketExchangeRate;
    minPtOut: BN;
    netPtOut: BN;
    netSyFee: BN;
    priceImpact: FixedX18;
    totalPtSwapped: BN;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- exactYtIn: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "swapExactYtForPt", {
    afterMath: MarketStaticMath;
    approxParam: ApproxParamsStruct;
    exchangeRateAfter: MarketExchangeRate;
    minPtOut: BN;
    netPtOut: BN;
    netSyFee: BN;
    priceImpact: FixedX18;
    totalPtSwapped: BN;
}>
Inherited from BaseRouter.swapExactYtForPt
- Defined in src/entities/Router/BaseRouter.ts:3031

swapExactYtForSy

swapExactYtForSy<T>(market, exactYtIn, slippage, _params?): RouterMetaMethodReturnType<T, "swapExactYtForSy", {
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<SwapExactYtForSy>;
    minSyOut: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyOut: BN;
    priceImpact: FixedX18;
    route: SwapExactYtForSy;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- exactYtIn: BigNumberish
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "swapExactYtForSy", {
    exchangeRateAfter: MarketExchangeRate;
    loRoutingResult: LimitOrderRouteSelectorResult<SwapExactYtForSy>;
    minSyOut: BN;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyOut: BN;
    priceImpact: FixedX18;
    route: SwapExactYtForSy;
}>
Inherited from BaseRouter.swapExactYtForSy
- Defined in src/entities/Router/BaseRouter.ts:2612

swapExactYtForToken

swapExactYtForToken<T>(market, exactYtIn, tokenOut, slippage, _params?): RouterMetaMethodReturnType<T, "swapExactYtForToken", {
    exchangeRateAfter: MarketExchangeRate;
    intermediateSyAmount: BN;
    limitOrderMatchedResult: LimitOrderMatchedResult;
    loRoutingResult: LimitOrderRouteSelectorResult<PartialRoute<ComponentsForLimitOrderRouting>>;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyOut: BN;
    netTokenOut: BN;
    priceImpact: FixedX18;
    route: SwapExactYtForToken;
    tokenRedeemSySelectionRoutingResult: OptimalOutputRouteSelectionResult<SwapExactYtForToken>;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- market: Address | MarketEntity
- exactYtIn: BigNumberish
- tokenOut: Address
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "swapExactYtForToken", {
    exchangeRateAfter: MarketExchangeRate;
    intermediateSyAmount: BN;
    limitOrderMatchedResult: LimitOrderMatchedResult;
    loRoutingResult: LimitOrderRouteSelectorResult<PartialRoute<ComponentsForLimitOrderRouting>>;
    netSyFeeFromLimit: BN;
    netSyFeeFromMarket: BN;
    netSyOut: BN;
    netTokenOut: BN;
    priceImpact: FixedX18;
    route: SwapExactYtForToken;
    tokenRedeemSySelectionRoutingResult: OptimalOutputRouteSelectionResult<SwapExactYtForToken>;
}>
Inherited from BaseRouter.swapExactYtForToken
- Defined in src/entities/Router/BaseRouter.ts:2862

swapTokenToToken

swapTokenToToken<T>(input, outputToken, slippage, _params?): RouterMetaMethodReturnType<T, "swapTokenToToken", {
    minTokenOut: BN;
    netTokenOut: BN;
    tokenInputStruct: TokenInput;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- input: RawTokenAmount
- outputToken: Address
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "swapTokenToToken", {
    minTokenOut: BN;
    netTokenOut: BN;
    tokenInputStruct: TokenInput;
}>
Inherited from BaseRouter.swapTokenToToken
- Defined in src/entities/Router/BaseRouter.ts:3269

swapTokenToTokenViaSy

swapTokenToTokenViaSy<T>(sy, input, outputToken, slippage, _params?): RouterMetaMethodReturnType<T, "swapTokenToTokenViaSy", {
    intermediateSyAmount: BN;
    minTokenOut: BN;
    netTokenOut: BN;
    route: SwapTokenToTokenViaSy;
    tokenMintSySelectionRoutingResult: OptimalOutputRouteSelectionResult<SwapTokenToTokenViaSy>;
}>
Type Parameters
- T extends MetaMethodType
Parameters
- sy: Address | SyEntity
- input: RawTokenAmount<BigNumberish>
- outputToken: Address
- slippage: number
- _params: RouterMetaMethodExtraParams<T> = {}
Returns RouterMetaMethodReturnType<T, "swapTokenToTokenViaSy", {
    intermediateSyAmount: BN;
    minTokenOut: BN;
    netTokenOut: BN;
    route: SwapTokenToTokenViaSy;
    tokenMintSySelectionRoutingResult: OptimalOutputRouteSelectionResult<SwapTokenToTokenViaSy>;
}>
Inherited from BaseRouter.swapTokenToTokenViaSy
- Defined in src/entities/Router/BaseRouter.ts:3312

`Protected` throwNoRouteFoundError

throwNoRouteFoundError<RC>(actionName, from, to, routes, errorOptions?): Promise<never>
Type Parameters
- RC extends "signerBalanceAllowanceChecker" | "approvedSignerAddressGetter" | "syIOTokenAmountGetter" | "aggregatorResultGetter" | "intermediateSyAmountGetter" | "limitOrderMatcher" | "contractMethodBuilder" | "gasUsedEstimator" | "netOutGetter" | "netOutInNativeEstimator"
Parameters
- actionName: string
- from: Address
- to: Address
- routes: PartialRoute<RC>[]
- Optional errorOptions: PendleSdkErrorParams
Returns Promise<never>
Inherited from BaseRouter.throwNoRouteFoundError
- Defined in src/entities/Router/BaseRouter.ts:3497

`Static` `Protected` extractAddress

extractAddress(this, addressOrEntity): Address
Parameters
- this: void
- addressOrEntity: Address | {
  address: Address;
  }
Returns Address
Inherited from BaseRouter.extractAddress
- Defined in src/entities/Router/BaseRouter.ts:3405

`Static` getRouter

getRouter(config): BaseRouter
Create a Router object for a given config.
Parameters
- config: BaseRouterConfig
Returns BaseRouter
Remarks
The address of Router is obtained from the config.
- Defined in src/entities/Router/Router.ts:16

`Static` getRouterWithKyberAggregator

getRouterWithKyberAggregator(config): BaseRouter
Parameters
- config: Omit<BaseRouterConfig, "aggregatorHelper">
Returns BaseRouter
- Defined in src/entities/Router/Router.ts:20

Class Router

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

address: Address

config: BaseRouterConfig

Returns Router

Properties

Protected Readonly _contract

Remarks

Readonly address

Readonly aggregatorHelper

Readonly approxParamsGenerator

Readonly chainId

Readonly checkErrorOnSimulation

Readonly events

Readonly gasFeeEstimator

Readonly limitOrderMatcher

Readonly limitOrderRouteSelector

Optional Readonly multicall

Readonly networkConnection

Readonly optimalOutputRouteSelector

Readonly tokenAmountConverter

Accessors

contract

Returns WrappedContract<IPAllActionV3>

Remarks

See

entityConfig

Returns BaseRouterConfig

Remarks

provider

Returns undefined | Provider

Methods

addExtraParams

Type Parameters

T extends MetaMethodType

Parameters

params: RouterMetaMethodExtraParams<T>

Returns FixedRouterMetaMethodExtraParams<T>

addLiquidityDualSyAndPt

Type Parameters

T extends MetaMethodType = "send"

Parameters

market: Address | MarketEntity

syDesired: BigNumberish

ptDesired: BigNumberish

slippage: number

_params: RouterMetaMethodExtraParams<T> = {}

Returns RouterMetaMethodReturnType<T, "addLiquidityDualSyAndPt", { afterMath: MarketStaticMath; minLpOut: BN; netLpOut: BN; netPtUsed: BN; netSyUsed: BN; }>

addLiquidityDualTokenAndPt

Type Parameters

T extends MetaMethodType

Parameters

market: Address | MarketEntity

tokenIn: Address

tokenDesired: BigNumberish

ptDesired: BigNumberish

slippage: number

_params: RouterMetaMethodExtraParams<T> = {}

addLiquiditySinglePt

Type Parameters

T extends MetaMethodType

Parameters

market: Address | MarketEntity

netPtIn: BigNumberish

slippage: number

_params: MetaMethodExtraParams<T> = {}

addLiquiditySingleSy

Type Parameters

T extends MetaMethodType

Parameters

market: Address | MarketEntity

_netSyIn: BigNumberish

`Protected` `Readonly` _contract

`Readonly` address

`Readonly` aggregatorHelper

`Readonly` approxParamsGenerator

`Readonly` chainId

`Readonly` checkErrorOnSimulation

`Readonly` events

`Readonly` gasFeeEstimator

`Readonly` limitOrderMatcher

`Readonly` limitOrderRouteSelector

`Optional` `Readonly` multicall

`Readonly` networkConnection

`Readonly` optimalOutputRouteSelector

`Readonly` tokenAmountConverter

Returns RouterMetaMethodReturnType<T, "addLiquidityDualSyAndPt", {
afterMath: MarketStaticMath;
minLpOut: BN;
netLpOut: BN;
netPtUsed: BN;
netSyUsed: BN;
}>

Returns RouterMetaMethodReturnType<T, "addLiquiditySingleSyKeepYt", {
minLpOut: BN;
minYtOut: BN;
netLpOut: BN;
netSyToPY: BN;
netYtOut: BN;
}>