Interface WhirlpoolRouter

Convienience class to find routes through a set of Whirlpools and execute a swap across them. The router only supports up to 2-hop trades between pools and does not support arbitrage trades between the same token.

Deprecated

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

interface WhirlpoolRouter {
    findAllRoutes(
        trade: Trade,
        opts?: Partial<RoutingOptions>,
        fetchOpts?: SimpleAccountFetchOptions,
    ): Promise<TradeRoute[]>;
    findBestRoute(
        trade: Trade,
        opts?: Partial<RoutingOptions>,
        selectionOpts?: Partial<RouteSelectOptions>,
        fetchOpts?: SimpleAccountFetchOptions,
    ): Promise<null | ExecutableRoute>;
    swap(
        trade: TradeRoute,
        slippage: Percentage,
        resolvedAtas: null | AtaAccountInfo[],
    ): Promise<TransactionBuilder>;
}

Index

Methods

findAllRoutes findBestRoute swap

Methods

findAllRoutes

findAllRoutes(
    trade: Trade,
    opts?: Partial<RoutingOptions>,
    fetchOpts?: SimpleAccountFetchOptions,
): Promise<TradeRoute[]>
Finds all possible routes for a trade, ordered by the best other token amount you would get from a trade. Use RouterUtils.selectFirstExecutableRoute to find the best executable route.
Parameters
- trade: Trade
  The trade to find routes for.
- Optionalopts: Partial<RoutingOptions>
  an WhirlpoolAccountFetchOptions object to define fetch and cache options when accessing on-chain accounts
- OptionalfetchOpts: SimpleAccountFetchOptions
  WhirlpoolAccountFetchOptions to configure the fetching of on-chain data.
Returns Promise<TradeRoute[]>
A list of TradeRoute that can be used to execute a swap, ordered by the best other token amount.

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

findBestRoute

findBestRoute(
    trade: Trade,
    opts?: Partial<RoutingOptions>,
    selectionOpts?: Partial<RouteSelectOptions>,
    fetchOpts?: SimpleAccountFetchOptions,
): Promise<null | ExecutableRoute>
Finds all possible routes for a trade and select the best route that is executable under the current execution environment.
Parameters
- trade: Trade
  The trade to find routes for.
- Optionalopts: Partial<RoutingOptions>
  an WhirlpoolAccountFetchOptions object to define fetch and cache options when accessing on-chain accounts
- OptionalselectionOpts: Partial<RouteSelectOptions>
  RouteSelectOptions to configure the selection of the best route. Missing options will be filled with default values from RouterUtils.getDefaultRouteSelectOptions.
- OptionalfetchOpts: SimpleAccountFetchOptions
  WhirlpoolAccountFetchOptions to configure the fetching of on-chain data.
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/index.ts:184

swap

swap(
    trade: TradeRoute,
    slippage: Percentage,
    resolvedAtas: null | AtaAccountInfo[],
): Promise<TransactionBuilder>
Construct a TransactionBuilder to help execute a trade route.
Parameters
- trade: TradeRoute
  The trade route to execute.
- slippage: Percentage
  The slippage tolerance for the trade.
- resolvedAtas: null | AtaAccountInfo[]
  The ATA accounts that the executing wallet owns / needed by the execution. If not provided, the router will attempt to resolve them.
Returns Promise<TransactionBuilder>
A TransactionBuilderthat can be used to execute the trade. If provvided from ExecutableRoute, plug the AddressLookupTableAccounts into builder to lower the transaction size.

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

Interface WhirlpoolRouter

Deprecated

Index

Methods

Methods

findAllRoutes

Parameters

Returns Promise<TradeRoute[]>

Deprecated

findBestRoute

Parameters

Returns Promise<null | ExecutableRoute>

Deprecated

swap

Parameters

Returns Promise<TransactionBuilder>

Deprecated

Settings

On This Page