Class Number128

Hierarchy

Number128

Index

Constructors

Properties

MAX ONE PRECISION ZERO

Methods

add div eq gt isZero lt mul saturatingAdd saturatingMul saturatingSub sub toBn toNumber toTokenAmount toU64 from fromBits fromBps fromDecimal max min tenPow

Constructors

constructor

new Number128(_bn: BN): Number128
Parameters
- _bn: BN
Returns Number128
- Defined in libraries/ts/margin/src/utils/number128.ts:12

Properties

`Static` `Readonly` MAX

MAX: Number128 = ...

`Static` `Readonly` ONE

ONE: Number128 = ...

`Static` `Readonly` PRECISION

PRECISION: 10 = 10

`Static` `Readonly` ZERO

ZERO: Number128 = ...

Methods

add

add(rhs: Number128): Number128
Parameters
- rhs: Number128
Returns Number128
- Defined in libraries/ts/margin/src/utils/number128.ts:89

div

div(rhs: Number128): Number128
Parameters
- rhs: Number128
Returns Number128
- Defined in libraries/ts/margin/src/utils/number128.ts:101

eq

eq(b: Number128): boolean
Parameters
- b: Number128
Returns boolean
- Defined in libraries/ts/margin/src/utils/number128.ts:113

gt

gt(b: Number128): boolean
Parameters
- b: Number128
Returns boolean
- Defined in libraries/ts/margin/src/utils/number128.ts:109

isZero

isZero(): boolean
Returns boolean
- Defined in libraries/ts/margin/src/utils/number128.ts:117

lt

lt(b: Number128): boolean
Parameters
- b: Number128
Returns boolean
- Defined in libraries/ts/margin/src/utils/number128.ts:105

mul

mul(rhs: Number128): Number128
Parameters
- rhs: Number128
Returns Number128
- Defined in libraries/ts/margin/src/utils/number128.ts:97

saturatingAdd

saturatingAdd(rhs: Number128): Number128
Parameters
- rhs: Number128
Returns Number128
- Defined in libraries/ts/margin/src/utils/number128.ts:73

saturatingMul

saturatingMul(rhs: Number128): Number128
Parameters
- rhs: Number128
Returns Number128
- Defined in libraries/ts/margin/src/utils/number128.ts:81

saturatingSub

saturatingSub(rhs: Number128): Number128
Parameters
- rhs: Number128
Returns Number128
- Defined in libraries/ts/margin/src/utils/number128.ts:77

sub

sub(rhs: Number128): Number128
Parameters
- rhs: Number128
Returns Number128
- Defined in libraries/ts/margin/src/utils/number128.ts:93

toBn

toBn(exponent: number): BN
Removes the fractional component from the number.
Parameters
- exponent: number
Returns BN
- Defined in libraries/ts/margin/src/utils/number128.ts:23

toNumber

toNumber(): number
Returns number
- Defined in libraries/ts/margin/src/utils/number128.ts:14

toTokenAmount

toTokenAmount(decimals: number): TokenAmount
Parameters
- decimals: number
Returns TokenAmount
- Defined in libraries/ts/margin/src/utils/number128.ts:18

toU64

toU64(exponent: number): BN
Removes the fractional component from the number. Throws if the number is not within the range of a u64.
Parameters
- exponent: number
Returns BN
- Defined in libraries/ts/margin/src/utils/number128.ts:35

`Static` from

from(bn: BN): Number128
Parameters
- bn: BN
Returns Number128
- Defined in libraries/ts/margin/src/utils/number128.ts:69

`Static` fromBits

fromBits(bits: number[]): Number128
Parameters
- bits: number[]
Returns Number128
- Defined in libraries/ts/margin/src/utils/number128.ts:65

`Static` fromBps

fromBps(basisPoints: BN): Number128
Convert from basis points
Parameters
- basisPoints: BN
Returns Number128
- Defined in libraries/ts/margin/src/utils/number128.ts:61

`Static` fromDecimal

fromDecimal(value: BN, exponent: number): Number128
Parameters
- value: BN
- exponent: number
Returns Number128
- Defined in libraries/ts/margin/src/utils/number128.ts:49

`Static` max

max(a: Number128, b: Number128): Number128
Parameters
- a: Number128
- b: Number128
Returns Number128
- Defined in libraries/ts/margin/src/utils/number128.ts:125

`Static` min

min(a: Number128, b: Number128): Number128
Parameters
- a: Number128
- b: Number128
Returns Number128
- Defined in libraries/ts/margin/src/utils/number128.ts:121

`Static` tenPow

tenPow(exponent: BN): BN
Parameters
- exponent: BN
Returns BN
- Defined in libraries/ts/margin/src/utils/number128.ts:129

Generated using TypeDoc