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

The Route entity represents the ordered Materia pairs with a fully specified path from input token to output token. The route is typically one or two pairs long (if the bridge token is not involved in the trade).

Example

import { ChainId, Token, TokenAmount, Pair, Route, IETH } from '@materia/sdk'

const BASE_FEE = JSBI.BigInt(30)
const WUSD = new Token(ChainId.MAINNET, '0x7C974104DF9dd7fb91205ab3D66d15AFf1049DE8', 18, 'WUSD', 'Wrapped USD')
const WUSD_IETH = new Pair(new TokenAmount(WUSD, '2000000000000000000'), new TokenAmount(IETH[WUSD.chainId], '1000000000000000000'), BASE_FEE)

const route = new Route([WUSD_IETH], WUSD)
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.