Class BigNum

Hierarchy

BigNum

Index

Constructors

Properties

precision val delim spacer

Constructors

constructor

new BigNum(val: string | number | BN, precisionVal?: string | number | BN): BigNum
Parameters
- val: string | number | BN
- precisionVal: string | number | BN = ...
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:17

Properties

precision

precision: BN

val

val: BN

`Static` delim

delim: string = '.'

`Static` spacer

spacer: string = ','

Methods

abs

abs(): BigNum
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:198

add

add(bn: BigNum): BigNum
Parameters
- bn: BigNum
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:29

`Private` bigNumFromParam

bigNumFromParam(bn: BN | BigNum): BigNum
Parameters
- bn: BN | BigNum
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:25

debug

debug(): void
Returns void
- Defined in sdk/src/factory/bigNum.ts:303

div

div(bn: BN | BigNum): BigNum
Parameters
- bn: BN | BigNum
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:64

eq

eq(bn: BN | BigNum, ignorePrecision?: boolean): boolean
Parameters
- bn: BN | BigNum
- Optional ignorePrecision: boolean
Returns boolean
- Defined in sdk/src/factory/bigNum.ts:165

eqZero

eqZero(): boolean
Returns boolean
- Defined in sdk/src/factory/bigNum.ts:178

`Private` getZeroes

getZeroes(count: number): string
Parameters
- count: number
Returns string
- Defined in sdk/src/factory/bigNum.ts:333

gt

gt(bn: BN | BigNum, ignorePrecision?: boolean): boolean
Parameters
- bn: BN | BigNum
- Optional ignorePrecision: boolean
Returns boolean
- Defined in sdk/src/factory/bigNum.ts:113

gtZero

gtZero(): boolean
Returns boolean
- Defined in sdk/src/factory/bigNum.ts:182

gte

gte(bn: BN | BigNum, ignorePrecision?: boolean): boolean
Parameters
- bn: BN | BigNum
- Optional ignorePrecision: boolean
Returns boolean
- Defined in sdk/src/factory/bigNum.ts:139

gteZero

gteZero(): boolean
Returns boolean
- Defined in sdk/src/factory/bigNum.ts:190

isNeg

isNeg(): boolean
Returns boolean
- Defined in sdk/src/factory/bigNum.ts:567

isPos

isPos(): boolean
Returns boolean
- Defined in sdk/src/factory/bigNum.ts:571

lt

lt(bn: BN | BigNum, ignorePrecision?: boolean): boolean
Parameters
- bn: BN | BigNum
- Optional ignorePrecision: boolean
Returns boolean
- Defined in sdk/src/factory/bigNum.ts:126

ltZero

ltZero(): boolean
Returns boolean
- Defined in sdk/src/factory/bigNum.ts:186

lte

lte(bn: BN | BigNum, ignorePrecision?: boolean): boolean
Parameters
- bn: BN | BigNum
- Optional ignorePrecision: boolean
Returns boolean
- Defined in sdk/src/factory/bigNum.ts:152

lteZero

lteZero(): boolean
Returns boolean
- Defined in sdk/src/factory/bigNum.ts:194

mul

mul(bn: BN | BigNum): BigNum
Parameters
- bn: BN | BigNum
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:41

neg

neg(): BigNum
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:202

prettyPrint

prettyPrint(useTradePrecision?: boolean, precisionOverride?: number): string
Parameters
- Optional useTradePrecision: boolean
- Optional precisionOverride: number
Returns string
- Defined in sdk/src/factory/bigNum.ts:251

print

print(): string
Pretty print the underlying value in human-readable form. Depends on precision being correct for the output string to be correct

Returns

Returns string
- Defined in sdk/src/factory/bigNum.ts:213

printShort

printShort(useTradePrecision?: boolean, precisionOverride?: number): string
Print and remove unnecessary trailing zeroes

Returns
Parameters
- Optional useTradePrecision: boolean
- Optional precisionOverride: number
Returns string
- Defined in sdk/src/factory/bigNum.ts:288

scalarMul

scalarMul(bn: BN | BigNum): BigNum
Multiplies by another big number then scales the result down by the big number's precision so that we're in the same precision space

Returns
Parameters
- bn: BN | BigNum
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:55

scale

scale(numerator: number | BN, denominator: number | BN): BigNum
Scale the number by a fraction

Returns
Parameters
- numerator: number | BN
- denominator: number | BN
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:102

shift

shift(exponent: number | BN, skipAdjustingPrecision?: boolean): BigNum
Shift precision up or down

Returns
Parameters
- exponent: number | BN
- skipAdjustingPrecision: boolean = false
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:76

shiftTo

shiftTo(targetPrecision: BN): BigNum
Shift to a target precision

Returns
Parameters
- targetPrecision: BN
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:92

sub

sub(bn: BigNum): BigNum
Parameters
- bn: BigNum
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:35

toFixed

toFixed(fixedPrecision: number, rounded?: boolean): string
Pretty print with the specified number of decimal places

Returns
Parameters
- fixedPrecision: number
- rounded: boolean = false
Returns string
- Defined in sdk/src/factory/bigNum.ts:314

toJSON

toJSON(): {
precision: string;
val: string;
}
Returns {
precision: string;
val: string;
}
- precision: string
- val: string
- Defined in sdk/src/factory/bigNum.ts:560

toMillified

toMillified(precision?: number, rounded?: boolean, type?: "financial" | "scientific"): string
Parameters
- precision: number = 3
- rounded: boolean = false
- type: "financial" | "scientific" = 'financial'
Returns string
- Defined in sdk/src/factory/bigNum.ts:500

toNotional

toNotional(useTradePrecision?: boolean, precisionOverride?: number): string
Print dollar formatted value. Defaults to fixed decimals two unless a given precision is given.

Returns
Parameters
- Optional useTradePrecision: boolean
- Optional precisionOverride: number
Returns string
- Defined in sdk/src/factory/bigNum.ts:472

toNum

toNum(): number
Get the numerical value of the BigNum. This can break if the BigNum is too large.

Returns

Returns number
- Defined in sdk/src/factory/bigNum.ts:579

toPercentage

toPercentage(denominator: BigNum, precision: number): string
Parameters
- denominator: BigNum
- precision: number
Returns string
- Defined in sdk/src/factory/bigNum.ts:106

toPrecision

toPrecision(fixedPrecision: number, trailingZeroes?: boolean, rounded?: boolean): string
Pretty print to the specified number of significant figures

Returns
Parameters
- fixedPrecision: number
- trailingZeroes: boolean = false
- rounded: boolean = false
Returns string
- Defined in sdk/src/factory/bigNum.ts:376

toRounded

toRounded(roundingPrecision: number): BigNum
Parameters
- roundingPrecision: number
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:337

toString

toString(base?: number | "hex", length?: number): string
Parameters
- Optional base: number | "hex"
- Optional length: number
Returns string
- Defined in sdk/src/factory/bigNum.ts:206

toTradePrecision

toTradePrecision(rounded?: boolean): string
Parameters
- rounded: boolean = false
Returns string
- Defined in sdk/src/factory/bigNum.ts:462

`Static` from

from(val?: string | number | BN, precision?: string | number | BN): BigNum
Create a BigNum instance

Returns
Parameters
- val: string | number | BN = ZERO
- Optional precision: string | number | BN
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:607

`Static` fromJSON

fromJSON(json: {
precision: string;
val: string;
}): BigNum
Parameters
- json: {
  precision: string;
  val: string;
  }
  - precision: string
  - val: string
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:597

`Static` fromPrint

fromPrint(val: string, precisionShift?: BN): BigNum
Create a BigNum instance from a printed BigNum

Returns
Parameters
- val: string
- Optional precisionShift: BN
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:624

`Static` max

max(a: BigNum, b: BigNum): BigNum
Parameters
- a: BigNum
- b: BigNum
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:649

`Static` min

min(a: BigNum, b: BigNum): BigNum
Parameters
- a: BigNum
- b: BigNum
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:653

`Static` setLocale

setLocale(locale: string): void
Parameters
- locale: string
Returns void
- Defined in sdk/src/factory/bigNum.ts:12

`Static` zero

zero(precision?: number | BN): BigNum
Parameters
- Optional precision: number | BN
Returns BigNum
- Defined in sdk/src/factory/bigNum.ts:657

Generated using TypeDoc