Class RouterUtils

A selection of utility functions for the WhirlpoolRouter.

Deprecated

WhirlpoolRouter will be removed in the future release. Please use endpoint which provides qoutes.

Index

Constructors

Methods

getDefaultRouteOptions getDefaultSelectOptions getPriceImpactForRoute getTouchedTickArraysFromRoute selectFirstExecutableRoute

Constructors

constructor

new RouterUtils(): RouterUtils
Returns RouterUtils

Methods

`Static` getDefaultRouteOptions

getDefaultRouteOptions(): RoutingOptions
Get the default options for generating trade routes.

Returns RoutingOptions
Default options for generating trade routes.

Deprecated
WhirlpoolRouter will be removed in the future release. Please use endpoint which provides qoutes.
- Defined in router/public/router-utils.ts:227

`Static` getDefaultSelectOptions

getDefaultSelectOptions(): RouteSelectOptions
Get the default options for selecting a route from a list of generated routes.

Returns RouteSelectOptions
Default options for selecting a a route from a list of generated routes.
- Defined in router/public/router-utils.ts:240

`Static` getPriceImpactForRoute

getPriceImpactForRoute(trade, route): Decimal
Calculate the price impact for a route.
Parameters
- trade: Trade
  The trade the user used to derive the route.
- route: TradeRoute
  The route to calculate the price impact for.
Returns Decimal
A Decimal object representing the percentage value of the price impact (ex. 3.01%)

Deprecated
WhirlpoolRouter will be removed in the future release. Please use endpoint which provides qoutes.
- Defined in router/public/router-utils.ts:154

`Static` getTouchedTickArraysFromRoute

getTouchedTickArraysFromRoute(route): PublicKey[]
Get the tick arrays addresses that are touched by a route.
Parameters
- route: TradeRoute
  The route to get the tick arrays from.
Returns PublicKey[]
The tick arrays addresses that are touched by the route.

Deprecated
WhirlpoolRouter will be removed in the future release. Please use endpoint which provides qoutes.
- Defined in router/public/router-utils.ts:208

`Static` selectFirstExecutableRoute

selectFirstExecutableRoute(ctx, orderedRoutes, opts): Promise<null | ExecutableRoute>
Selects the best executable route from a list of routes using the current execution environment. The wallet support type, available ATA accounts, existance of lookup tables all effect the transaction size and eligibility of a route.
Parameters
- ctx: WhirlpoolContext
  The WhirlpoolContext that represents the current execution environment
- orderedRoutes: TradeRoute[]
  A list of routes to select from, ordered by the best routes (trade amount wise) first.
- opts: RouteSelectOptions
  RouteSelectOptions to configure the selection of the best route.
Returns Promise<null | ExecutableRoute>
The best ExecutableRoute that can be used to execute a swap. If no executable route is found, null is returned.

Deprecated
WhirlpoolRouter will be removed in the future release. Please use endpoint which provides qoutes.
- Defined in router/public/router-utils.ts:66

Generated using TypeDoc