Class Router

Saber Router SDK.

Hierarchy

Router

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Router(provider: AugmentedProvider, programs: SaberPrograms): Router

- Defined in src/router/router.ts:16
Parameters
- provider: AugmentedProvider
- programs: SaberPrograms
Returns Router

Properties

Readonly programs

programs: SaberPrograms

Readonly provider

provider: AugmentedProvider

Methods

createPlan

createPlan(inputAmount: TokenAmount, minimumAmountOut: TokenAmount, actions: Action[]): ActionPlan

- Defined in src/router/router.ts:21
Parameters
- inputAmount: TokenAmount
- minimumAmountOut: TokenAmount
- actions: Action[]
Returns ActionPlan

createWithdrawOneActionFacade

createWithdrawOneActionFacade(__namedParameters: { adWithdrawAction?: Action; inputAmount: TokenAmount; minimumAmountOut: TokenAmount; swap: StableSwap }): ActionPlan

- Defined in src/router/router.ts:72
Creates a WithdrawOne action.

Parameters
- __namedParameters: { adWithdrawAction?: Action; inputAmount: TokenAmount; minimumAmountOut: TokenAmount; swap: StableSwap }
  - Optional adWithdrawAction?: Action
  - inputAmount: TokenAmount
  - minimumAmountOut: TokenAmount
  - swap: StableSwap
Returns ActionPlan

loadWrappedToken

loadWrappedToken(underlying: Token, decimals: number): Promise<WrappedTokenActions>

- Defined in src/router/router.ts:56
Loads a decimal wrapped token

Parameters
- underlying: Token
- decimals: number
Returns Promise<WrappedTokenActions>

planTrade

planTrade(trade: Trade, minimumAmountOut: TokenAmount): ActionPlan

- Defined in src/router/router.ts:37
Plans a trade, returning an executable Action Plan which uses the continuation router to perform the desired sequence of swaps ("actions") atomically.

Parameters
- trade: Trade
- minimumAmountOut: TokenAmount
Returns ActionPlan

Generated using TypeDoc