Class Price<T>`Abstract`

Number with an integer numerator and denominator.

Type Parameters

T extends Token<T>

Hierarchy

Fraction
- Price

Index

Constructors

constructor

new Price<T>(baseCurrency: T, quoteCurrency: T, denominator: BigintIsh, numerator: BigintIsh): Price<T>
Constructs a Price.

denominator and numerator must be raw, i.e. in the native representation
Type Parameters
- T extends Token<T, T>
Parameters
- baseCurrency: T
- quoteCurrency: T
- denominator: BigintIsh
  
  Units of base currency. E.g. 1 BTC would be 1_00000000
- numerator: BigintIsh
  
  Units of quote currency. E.g. $30k at 6 decimals would be 30_000_000000
Returns Price<T>
Overrides Fraction.constructor
- Defined in packages/token-fns/src/price.ts:23

Properties

`Readonly` baseCurrency

baseCurrency: T

`Readonly` denominator

denominator: JSBI

`Readonly` isFraction

isFraction: true

This boolean checks to see if this is actually a Fraction.

`Readonly` numerator

numerator: JSBI

`Readonly` quoteCurrency

quoteCurrency: T

`Readonly` scalar

scalar: Fraction

`Static` `Readonly` ONE

ONE: Fraction

`Static` `Readonly` ZERO

ZERO: Fraction

Accessors

adjusted

get adjusted(): Fraction
Returns Fraction
- Defined in packages/token-fns/src/price.ts:55

asFraction

get asFraction(): Fraction
Helper method for converting any super class back to a fraction

Returns Fraction
Inherited from Fraction.asFraction
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:93

denominatorStr

get denominatorStr(): string
Fraction denominator.

Returns string
Inherited from Fraction.denominatorStr
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:33

numeratorStr

get numeratorStr(): string
Fraction numerator.

Returns string
Inherited from Fraction.numeratorStr
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:32

quotient

get quotient(): JSBI
Performs floor division.

Returns JSBI
Inherited from Fraction.quotient
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:70

raw

get raw(): Fraction
Returns Fraction
- Defined in packages/token-fns/src/price.ts:51

remainder

get remainder(): Fraction
Remainder after floor division.

Returns Fraction
Inherited from Fraction.remainder
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:74

Methods

add

add(other: Fraction | BigintIsh): Fraction
Parameters
- other: Fraction | BigintIsh
Returns Fraction
Inherited from Fraction.add
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:80

compareTo

compareTo(other: Fraction): 0 | 1 | -1
Compares this Fraction to the other Fraction.
Parameters
- other: Fraction
Returns 0 | 1 | -1
Inherited from Fraction.compareTo
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:59

divide

divide(other: Fraction | BigintIsh): Fraction
Divides this Fraction by another Fraction.
Parameters
- other: Fraction | BigintIsh
Returns Fraction
Inherited from Fraction.divide
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:89

equalTo

equalTo(other: Fraction | BigintIsh): boolean
Parameters
- other: Fraction | BigintIsh
Returns boolean
Inherited from Fraction.equalTo
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:83

greaterThan

greaterThan(other: Fraction | BigintIsh): boolean
Parameters
- other: Fraction | BigintIsh
Returns boolean
Inherited from Fraction.greaterThan
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:84

invert

invert(): Price<T>
Swaps the numerator and denominator of the Fraction.

Returns

Returns Price<T>
Overrides Fraction.invert
- Defined in packages/token-fns/src/price.ts:59

isNonZero

isNonZero(): boolean
Returns true if this number (the numerator) is not equal to zero.

Returns

Returns boolean
Inherited from Fraction.isNonZero
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:103

isZero

isZero(): boolean
Returns true if this number (the numerator) is equal to zero and the denominator is non-zero.

Returns

Returns boolean
Inherited from Fraction.isZero
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:98

lessThan

lessThan(other: Fraction | BigintIsh): boolean
Parameters
- other: Fraction | BigintIsh
Returns boolean
Inherited from Fraction.lessThan
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:82

multiply

multiply(other: Price<T>): Price<T>
Parameters
- other: Price<T>
Returns Price<T>
Overrides Fraction.multiply
- Defined in packages/token-fns/src/price.ts:68

`Abstract` new

new(baseCurrency: T, quoteCurrency: T, denominator: BigintIsh, numerator: BigintIsh): Price<T>
Create a new Price.
Parameters
- baseCurrency: T
- quoteCurrency: T
- denominator: BigintIsh
- numerator: BigintIsh
Returns Price<T>
- Defined in packages/token-fns/src/price.ts:44

quote

quote<B>(tokenAmount: B): B
Type Parameters
- B extends TokenAmount<T, B>
Parameters
- tokenAmount: B
Returns B
- Defined in packages/token-fns/src/price.ts:83

subtract

subtract(other: Fraction | BigintIsh): Fraction
Parameters
- other: Fraction | BigintIsh
Returns Fraction
Inherited from Fraction.subtract
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:81

toJSON

toJSON(): FractionObject
JSON representation of the Fraction.

Returns FractionObject
Inherited from Fraction.toJSON
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:48

`Static` fromNumber

fromNumber(number: number, decimals?: number): Fraction
Parses a Fraction from a float.

Returns
Fraction
Parameters
- number: number
  
  Number to parse.
- Optional decimals: number
  
  Number of decimals of precision. (default 10)
Returns Fraction
Inherited from Fraction.fromNumber
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:66

`Static` fromObject

fromObject(other: FractionObject): Fraction
Ensures the other object is of this Fraction type.

Returns
Parameters
- other: FractionObject
Returns Fraction
Inherited from Fraction.fromObject
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:44

`Static` isFraction

isFraction(other: unknown): other is Fraction
Returns true if the other object is a Fraction.

Returns
Parameters
- other: unknown
Returns other is Fraction
Inherited from Fraction.isFraction
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:55

Class Price<T>Abstract

Type Parameters

T extends Token<T>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends Token<T, T>

Parameters

baseCurrency: T

quoteCurrency: T

denominator: BigintIsh

numerator: BigintIsh

Returns Price<T>

Properties

Readonly baseCurrency

Readonly denominator

Readonly isFraction

Readonly numerator

Readonly quoteCurrency

Readonly scalar

Static Readonly ONE

Static Readonly ZERO

Accessors

adjusted

Returns Fraction

asFraction

Returns Fraction

denominatorStr

Returns string

numeratorStr

Returns string

quotient

Returns JSBI

raw

Returns Fraction

remainder

Returns Fraction

Methods

add

Parameters

other: Fraction | BigintIsh

Returns Fraction

compareTo

Parameters

other: Fraction

Returns 0 | 1 | -1

divide

Parameters

other: Fraction | BigintIsh

Returns Fraction

equalTo

Parameters

other: Fraction | BigintIsh

Returns boolean

greaterThan

Parameters

other: Fraction | BigintIsh

Returns boolean

invert

Returns

Returns Price<T>

isNonZero

Returns

Returns boolean

isZero

Returns

Returns boolean

lessThan

Parameters

other: Fraction | BigintIsh

Returns boolean

multiply

Parameters

other: Price<T>

Class Price<T>`Abstract`

`Readonly` baseCurrency

`Readonly` denominator

`Readonly` isFraction

`Readonly` numerator

`Readonly` quoteCurrency

`Readonly` scalar

`Static` `Readonly` ONE

`Static` `Readonly` ZERO

`Abstract` new

`Static` fromNumber

`Optional` decimals: number

`Static` fromObject

`Static` isFraction