Skip to main content

Route

constructor(pairs: Pair[], input: Token)

The Route entity represents one or more ordered Pegasys pairs with a fully specified path from input token to output token.

Example

import { ChainId, Token, TokenAmount, Pair, Route } from '@pegasys-fi/v3-sdk'

const HOT = new Token(ChainId.MAINNET, '0xc0FFee0000000000000000000000000000000000', 18, 'HOT', 'Caffeine')
const NOT = new Token(ChainId.MAINNET, '0xDeCAf00000000000000000000000000000000000', 18, 'NOT', 'Caffeine')
const HOT_NOT = new Pair(new TokenAmount(HOT, '2000000000000000000'), new TokenAmount(NOT, '1000000000000000000'))

const route = new Route([HOT_NOT], NOT)

Properties

pairs​

pairs: Pair[]

The ordered pairs that the route is comprised of.

path​

path: Token[]

The full path from input token to output token.

input​

input: string

The input token.

output​

output: string

The output token.

midPrice​

midPrice: Price

Returns the current mid price along the route.