Class CurrencyAmount

Hierarchy

Fraction
- CurrencyAmount
  - TokenAmount

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CurrencyAmount(currency: Currency, amount: BigNumberish, isRaw?: boolean): CurrencyAmount

Overrides Fraction.constructor
- Defined in src/entity/amount.ts:40
Parameters
- currency: Currency
- amount: BigNumberish
- isRaw: boolean = true
Returns CurrencyAmount

Properties

Readonly currency

currency: Currency

Readonly denominator

denominator: BN

Readonly numerator

numerator: BN

Accessors

quotient

get quotient(): BN

Inherited from Fraction.quotient
- Defined in src/entity/fraction.ts:40
Returns BN

raw

get raw(): BN

- Defined in src/entity/amount.ts:69
Returns BN

Methods

add

add(other: CurrencyAmount): CurrencyAmount

Overrides Fraction.add
- Defined in src/entity/amount.ts:95
Parameters
- other: CurrencyAmount
Returns CurrencyAmount

div

div(other: Fraction | BigNumberish): Fraction

Inherited from Fraction.div
- Defined in src/entity/fraction.ts:84
Parameters
- other: Fraction | BigNumberish
Returns Fraction

gt

gt(other: CurrencyAmount): boolean

- Defined in src/entity/amount.ts:80
a greater than b

Parameters
- other: CurrencyAmount
Returns boolean

invert

invert(): Fraction

Inherited from Fraction.invert
- Defined in src/entity/fraction.ts:44
Returns Fraction

isZero

isZero(): boolean

- Defined in src/entity/amount.ts:73
Returns boolean

lt

lt(other: CurrencyAmount): boolean

- Defined in src/entity/amount.ts:89
a less than b

Parameters
- other: CurrencyAmount
Returns boolean

mul

mul(other: Fraction | BigNumberish): Fraction

Inherited from Fraction.mul
- Defined in src/entity/fraction.ts:77
Parameters
- other: Fraction | BigNumberish
Returns Fraction

sub

sub(other: CurrencyAmount): CurrencyAmount

Overrides Fraction.sub
- Defined in src/entity/amount.ts:101
Parameters
- other: CurrencyAmount
Returns CurrencyAmount

toExact

toExact(format?: object): string

- Defined in src/entity/amount.ts:145
To exact
example
```
1 -> 1
1.234 -> 1.234
1.123456789876543 -> 1.123456789
```
Parameters
- format: object = ...
Returns string

toFixed

toFixed(decimalPlaces?: number, format?: object, rounding?: Rounding): string

Overrides Fraction.toFixed
- Defined in src/entity/amount.ts:125
To fixed
example
```
1 -> 1.000000000
1.234 -> 1.234000000
1.123456789876543 -> 1.123456789
```
Parameters
- decimalPlaces: number = ...
- Optional format: object
- rounding: Rounding = Rounding.ROUND_DOWN
Returns string

toSignificant

toSignificant(significantDigits?: number, format?: object, rounding?: Rounding): string

Overrides Fraction.toSignificant
- Defined in src/entity/amount.ts:107
Parameters
- significantDigits: number = ...
- Optional format: object
- rounding: Rounding = Rounding.ROUND_DOWN
Returns string