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

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

Example

import { ChainId, Token, TokenAmount, Pair, Route } from 'vexchange-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)
Copy

Properties

pairs

pairs: Pair[]
Copy

The ordered pairs that the route is comprised of.

path

path: Token[]
Copy

The full path from input token to output token.

input

input: string
Copy

The input token.

output

output: string
Copy

The output token.

midPrice

midPrice: Price
Copy

Returns the current mid price along the route.