Class TokenAmount<T>`Abstract`

Represents a quantity of tokens.

Type Parameters

T extends Token<T>

Hierarchy

Fraction
- TokenAmount

Index

Constructors

constructor

new TokenAmount<T>(token: T, amount: BigintIsh, validate?: ((value: JSBI) => void)): TokenAmount<T>
amount must be raw, i.e. in the native representation
Type Parameters
- T extends Token<T, T>
Parameters
- token: T
- amount: BigintIsh
- Optional validate: ((value: JSBI) => void)
  - - (value: JSBI): void
    - Parameters
      
      value: JSBI
      
      Returns void
Returns TokenAmount<T>
Overrides Fraction.constructor
- Defined in packages/token-fns/src/tokenAmount.ts:141

Properties

`Readonly` denominator

denominator: JSBI

`Readonly` isFraction

isFraction: true

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

`Readonly` numerator

numerator: JSBI

`Readonly` token

token: T

`Static` `Readonly` ONE

ONE: Fraction

`Static` `Readonly` ZERO

ZERO: Fraction

Accessors

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(): JSBI
Returns JSBI
- Defined in packages/token-fns/src/tokenAmount.ts:164

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: TokenAmount<T>): TokenAmount<T>
Parameters
- other: TokenAmount<T>
Returns TokenAmount<T>
Overrides Fraction.add
- Defined in packages/token-fns/src/tokenAmount.ts:168

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

divideBy

divideBy(other: Fraction): Percent
Gets this TokenAmount as a percentage of the other TokenAmount.

Returns
Parameters
- other: Fraction
Returns Percent
- Defined in packages/token-fns/src/tokenAmount.ts:203

divideByAmount

divideByAmount(other: TokenAmount<T>): Percent
Gets this TokenAmount as a percentage of the other TokenAmount.

Deprecated
use percentOf

Returns
Parameters
- other: TokenAmount<T>
Returns Percent
- Defined in packages/token-fns/src/tokenAmount.ts:253

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(): Fraction
Swaps the numerator and denominator of the Fraction.

Returns

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

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: Fraction | BigintIsh): Fraction
Parameters
- other: Fraction | BigintIsh
Returns Fraction
Inherited from Fraction.multiply
- Defined in .yarn/__virtual__/@saberhq-fraction-virtual-351ac4ac5a/1/packages/fraction/dist/esm/fraction.d.ts:85

multiplyBy

multiplyBy(fraction: Fraction): TokenAmount<T>
Multiplies this token amount by a fraction. WARNING: this loses precision

Deprecated
use scale

Returns
Parameters
- fraction: Fraction
Returns TokenAmount<T>
- Defined in packages/token-fns/src/tokenAmount.ts:264

`Abstract` new

new(token: T, amount: BigintIsh): TokenAmount<T>
Create a new TokenAmount.
Parameters
- token: T
- amount: BigintIsh
Returns TokenAmount<T>
- Defined in packages/token-fns/src/tokenAmount.ts:158

percentOf

percentOf(other: TokenAmount<T>): Percent
Gets this TokenAmount as a percentage of the other TokenAmount.

Returns
Parameters
- other: TokenAmount<T>
Returns Percent
- Defined in packages/token-fns/src/tokenAmount.ts:189

reduceBy

reduceBy(percent: Percent): TokenAmount<T>
Reduces this token amount by a percent. WARNING: this loses precision

Returns
Parameters
- percent: Percent
Returns TokenAmount<T>
- Defined in packages/token-fns/src/tokenAmount.ts:224

scale

scale(fraction: Fraction): TokenAmount<T>
Multiplies this token amount by a fraction. WARNING: this loses precision

Returns
Parameters
- fraction: Fraction
Returns TokenAmount<T>
- Defined in packages/token-fns/src/tokenAmount.ts:214

subtract

subtract(other: TokenAmount<T>): TokenAmount<T>
Parameters
- other: TokenAmount<T>
Returns TokenAmount<T>
Overrides Fraction.subtract
- Defined in packages/token-fns/src/tokenAmount.ts:176

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

withAmount

withAmount(amount: BigintIsh): TokenAmount<T>
Parameters
- amount: BigintIsh
Returns TokenAmount<T>
- Defined in packages/token-fns/src/tokenAmount.ts:160

`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

`Static` isTokenAmount

isTokenAmount<T, A>(other: unknown): other is A
Returns true if the other object is a TokenAmount.

Returns
Type Parameters
- T extends Token<T, T>
- A extends TokenAmount<T, A>
Parameters
- other: unknown
Returns other is A
- Defined in packages/token-fns/src/tokenAmount.ts:234

Class TokenAmount<T>Abstract

Type Parameters

T extends Token<T>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T extends Token<T, T>

Parameters

token: T

amount: BigintIsh

Optional validate: ((value: JSBI) => void)

Parameters

value: JSBI

Returns void

Returns TokenAmount<T>

Properties

Readonly denominator

Readonly isFraction

Readonly numerator

Readonly token

Static Readonly ONE

Static Readonly ZERO

Accessors

asFraction

Returns Fraction

denominatorStr

Returns string

numeratorStr

Returns string

quotient

Returns JSBI

raw

Returns JSBI

remainder

Returns Fraction

Methods

add

Parameters

other: TokenAmount<T>

Returns TokenAmount<T>

compareTo

Parameters

other: Fraction

Returns 0 | 1 | -1

divide

Parameters

other: Fraction | BigintIsh

Returns Fraction

divideBy

Returns

Parameters

other: Fraction

Returns Percent

divideByAmount

Deprecated

Returns

Parameters

other: TokenAmount<T>

Returns Percent

equalTo

Parameters

other: Fraction | BigintIsh

Returns boolean

greaterThan

Parameters

other: Fraction | BigintIsh

Returns boolean

invert

Returns

Returns Fraction

isNonZero

Returns

Returns boolean

isZero

Class TokenAmount<T>`Abstract`

`Optional` validate: ((value: JSBI) => void)

`Readonly` denominator

`Readonly` isFraction

`Readonly` numerator

`Readonly` token

`Static` `Readonly` ONE

`Static` `Readonly` ZERO

`Abstract` new

`Static` fromNumber

`Optional` decimals: number

`Static` fromObject

`Static` isFraction

`Static` isTokenAmount