Fraction

constructor(numerator: BigintIsh, denominator: BigintIsh = ONE)
Copy

The base class which all subsequent fraction classes extend. Not meant to be used directly.

Properties

numerator

numerator: JSBI
Copy

denominator

denominator: JSBI
Copy

quotient

quotient: JSBI
Copy

Performs floor division.

Methods

invert

invert(): Fraction
Copy

add

add(other: Fraction | BigintIsh): Fraction
Copy

subtract

subtract(other: Fraction | BigintIsh): Fraction
Copy

multiply

multiply(other: Fraction | BigintIsh): Fraction
Copy

divide

divide(other: Fraction | BigintIsh): Fraction
Copy

toSignificant

toSignificant(
  significantDigits: number,
  format: object = { groupSeparator: '' },
  rounding: Rounding = Rounding.ROUND_HALF_UP
): string
Copy

Formats a fraction to the specified number of significant digits.

• For format options, see toFormat.

toFixed

toFixed(
  decimalPlaces: number,
  format: object = { groupSeparator: '' },
  rounding: Rounding = Rounding.ROUND_HALF_UP
): string
Copy

Formats a fraction to the specified number of decimal places.

• For format options, see toFormat.

Percent

Responsible for formatting percentages (10% instead of 0.1).

Example

import { Percent } from '@materia/sdk'

const percent = new Percent('60', '100')

console.log(percent.toSignificant(2)) // 60
Copy

toSignificant

See toSignificant.

toFixed

See toFixed.

TokenAmount

constructor(token: Token, amount: BigintIsh)
Copy

Responsible for formatting token amounts with specific decimal places.

Example

import { Token, TokenAmount } from '@materia/sdk'

const WUSD = new Token(ChainId.MAINNET, '0x7C974104DF9dd7fb91205ab3D66d15AFf1049DE8', 18, 'WUSD', 'Wrapped USD')
const tokenAmount = new TokenAmount(WUSD, '3000000000000000000')

console.log(tokenAmount.toExact()) // 3
Copy

Properties

token

token: Token
Copy

raw

raw: JSBI
Copy

Returns the full token amount, unadjusted for decimals.

Methods

add

add(other: TokenAmount): TokenAmount
Copy

subtract

subtract(other: TokenAmount): TokenAmount
Copy

toSignificant

See toSignificant.

toFixed

See toFixed.

toExact

toExact(format: object = { groupSeparator: '' }): string
Copy

Price

constructor(baseToken: Token, quoteToken: Token, denominator: BigintIsh, numerator: BigintIsh)
Copy

Responsible for denominating the relative price between two tokens. Denominator and numerator must be unadjusted for decimals.

Example

import { ChainId, IETH as WETHs, Token, Price } from '@materia/sdk'

const WUSD = new Token(ChainId.MAINNET, '0x7C974104DF9dd7fb91205ab3D66d15AFf1049DE8', 18, 'WUSD', 'Wrapped USD')
const price = new Price(WUSD, IETH[ChainId.MAINNET], '1000000000000000000', '123000000000000000000')

console.log(price.toSignificant(3)) // 123
Copy

This example shows the WUSD/IETH price, where WUSD is the base token, and IETH is the quote token. The price is constructed from an amount of IETH (the numerator) / an amount of WUSD (the denominator).

Static Methods

fromRoute

fromRoute(route: Route): Price
Copy

Properties

baseToken

baseToken: Token
Copy

quoteToken

quoteToken: Token
Copy

scalar

scalar: Fraction
Copy

Used to adjust the price for the decimals of the base and quote tokens.

raw

raw: Fraction
Copy

Returns the raw price, unadjusted for decimals.

adjusted

adjusted: Fraction
Copy

Returns the price, adjusted for decimals.

Methods

invert

invert(): Price
Copy

multiply

multiply(other: Price): Price
Copy

quote

quote(tokenAmount: TokenAmount): TokenAmount
Copy

Given an asset amount, returns an equivalent value of the other asset, according to the current price.

toSignificant

See toSignificant.

toFixed

See toFixed.