Class BN

Index

Constructors

Constructors

constructor

new BN(number, base?, endian?): BN
Parameters
- number: string | number | number[] | Uint8Array | Buffer | BN
- Optional base: number | "hex"
- Optional endian: Endianness
Returns BN
- Defined in node_modules/@types/bn.js/index.d.ts:29
new BN(number, endian?): BN
Parameters
- number: string | number | number[] | Uint8Array | Buffer | BN
- Optional endian: Endianness
Returns BN
- Defined in node_modules/@types/bn.js/index.d.ts:34

Methods

abs

abs(): BN
Returns BN
Description
absolute value
- Defined in node_modules/@types/bn.js/index.d.ts:232

add

add(b): BN
Parameters
- b: BN
Returns BN
Description
addition
- Defined in node_modules/@types/bn.js/index.d.ts:242

addn

addn(b): BN
Parameters
- b: number
Returns BN
Description
addition
- Defined in node_modules/@types/bn.js/index.d.ts:252

and

and(b): BN
Parameters
- b: BN
Returns BN
Description
and
- Defined in node_modules/@types/bn.js/index.d.ts:373

andln

andln(b): BN
Parameters
- b: number
Returns BN
Description
and (NOTE: andln is going to be replaced with andn in future)
- Defined in node_modules/@types/bn.js/index.d.ts:393

bincn

bincn(b): BN
Parameters
- b: number
Returns BN
Description
add 1 << b to the number
- Defined in node_modules/@types/bn.js/index.d.ts:477

bitLength

bitLength(): number
Returns number
Description
get number of bits occupied
- Defined in node_modules/@types/bn.js/index.d.ts:112

byteLength

byteLength(): number
Returns number
Description
return number of bytes occupied
- Defined in node_modules/@types/bn.js/index.d.ts:122

clone

clone(): BN
Returns BN
Description
clone number
- Defined in node_modules/@types/bn.js/index.d.ts:67

cmp

cmp(b): -1 | 0 | 1
Parameters
- b: BN
Returns -1 | 0 | 1
Description
compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result
- Defined in node_modules/@types/bn.js/index.d.ts:147

cmpn

cmpn(b): -1 | 0 | 1
Parameters
- b: number
Returns -1 | 0 | 1
Description
compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result
- Defined in node_modules/@types/bn.js/index.d.ts:157

div

div(b): BN
Parameters
- b: BN
Returns BN
Description
divide
- Defined in node_modules/@types/bn.js/index.d.ts:317

divRound

divRound(b): BN
Parameters
- b: BN
Returns BN
Description
rounded division
- Defined in node_modules/@types/bn.js/index.d.ts:348

divn

divn(b): BN
Parameters
- b: number
Returns BN
Description
divide
- Defined in node_modules/@types/bn.js/index.d.ts:322

egcd

egcd(b): {
    a: BN;
    b: BN;
    gcd: BN;
}
Parameters
- b: BN
Returns {
    a: BN;
    b: BN;
    gcd: BN;
}
- a: BN
- b: BN
- gcd: BN
Description
Extended GCD results ({ a: ..., b: ..., gcd: ... })
- Defined in node_modules/@types/bn.js/index.d.ts:497

eq

eq(b): boolean
Parameters
- b: BN
Returns boolean
Description
a equals b
- Defined in node_modules/@types/bn.js/index.d.ts:202

eqn

eqn(b): boolean
Parameters
- b: number
Returns boolean
Description
a equals b
- Defined in node_modules/@types/bn.js/index.d.ts:207

fromTwos

fromTwos(width): BN
Parameters
- width: number
Returns BN
Description
convert from two's complement representation, where width is the bit width
- Defined in node_modules/@types/bn.js/index.d.ts:217

gcd

gcd(b): BN
Parameters
- b: BN
Returns BN
Description
GCD
- Defined in node_modules/@types/bn.js/index.d.ts:492

gt

gt(b): boolean
Parameters
- b: BN
Returns boolean
Description
a greater than b
- Defined in node_modules/@types/bn.js/index.d.ts:182

gte

gte(b): boolean
Parameters
- b: BN
Returns boolean
Description
a greater than or equals b
- Defined in node_modules/@types/bn.js/index.d.ts:192

gten

gten(b): boolean
Parameters
- b: number
Returns boolean
Description
a greater than or equals b
- Defined in node_modules/@types/bn.js/index.d.ts:197

gtn

gtn(b): boolean
Parameters
- b: number
Returns boolean
Description
a greater than b
- Defined in node_modules/@types/bn.js/index.d.ts:187

iabs

iabs(): BN
Returns BN
Description
absolute value
- Defined in node_modules/@types/bn.js/index.d.ts:237

iadd

iadd(b): BN
Parameters
- b: BN
Returns BN
Description
addition
- Defined in node_modules/@types/bn.js/index.d.ts:247

iaddn

iaddn(b): BN
Parameters
- b: number
Returns BN
Description
addition
- Defined in node_modules/@types/bn.js/index.d.ts:257

iand

iand(b): BN
Parameters
- b: BN
Returns BN
Description
and
- Defined in node_modules/@types/bn.js/index.d.ts:378

idivn

idivn(b): BN
Parameters
- b: number
Returns BN
Description
divide
- Defined in node_modules/@types/bn.js/index.d.ts:327

imaskn

imaskn(b): BN
Parameters
- b: number
Returns BN
Description
clear bits with indexes higher or equal to b
- Defined in node_modules/@types/bn.js/index.d.ts:473

imul

imul(b): BN
Parameters
- b: BN
Returns BN
Description
multiply
- Defined in node_modules/@types/bn.js/index.d.ts:287

imuln

imuln(b): BN
Parameters
- b: number
Returns BN
Description
multiply
- Defined in node_modules/@types/bn.js/index.d.ts:297

ineg

ineg(): BN
Returns BN
Description
negate sign
- Defined in node_modules/@types/bn.js/index.d.ts:227

inotn

inotn(w): BN
Parameters
- w: number
Returns BN
Description
not (for the width specified by w)
- Defined in node_modules/@types/bn.js/index.d.ts:487

invm

invm(b): BN
Parameters
- b: BN
Returns BN
Description
inverse a modulo b
- Defined in node_modules/@types/bn.js/index.d.ts:502

ior

ior(b): BN
Parameters
- b: BN
Returns BN
Description
or
- Defined in node_modules/@types/bn.js/index.d.ts:358

isEven

isEven(): boolean
Returns boolean
Description
check if value is even
- Defined in node_modules/@types/bn.js/index.d.ts:132

isNeg

isNeg(): boolean
Returns boolean
Description
true if the number is negative
- Defined in node_modules/@types/bn.js/index.d.ts:127

isOdd

isOdd(): boolean
Returns boolean
Description
check if value is odd
- Defined in node_modules/@types/bn.js/index.d.ts:137

isZero

isZero(): boolean
Returns boolean
Description
check if value is zero
- Defined in node_modules/@types/bn.js/index.d.ts:142

ishln

ishln(b): BN
Parameters
- b: number
Returns BN
Description
shift left
- Defined in node_modules/@types/bn.js/index.d.ts:428

ishrn

ishrn(b): BN
Parameters
- b: number
Returns BN
Description
shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)
- Defined in node_modules/@types/bn.js/index.d.ts:448

isqr

isqr(): BN
Returns BN
Description
square
- Defined in node_modules/@types/bn.js/index.d.ts:307

isub

isub(b): BN
Parameters
- b: BN
Returns BN
Description
subtraction
- Defined in node_modules/@types/bn.js/index.d.ts:267

isubn

isubn(b): BN
Parameters
- b: number
Returns BN
Description
subtraction
- Defined in node_modules/@types/bn.js/index.d.ts:277

iuand

iuand(b): BN
Parameters
- b: BN
Returns BN
Description
and
- Defined in node_modules/@types/bn.js/index.d.ts:388

iuor

iuor(b): BN
Parameters
- b: BN
Returns BN
Description
or
- Defined in node_modules/@types/bn.js/index.d.ts:368

iushln

iushln(b): BN
Parameters
- b: number
Returns BN
Description
shift left
- Defined in node_modules/@types/bn.js/index.d.ts:438

iushrn

iushrn(b): BN
Parameters
- b: number
Returns BN
Description
shift right
- Defined in node_modules/@types/bn.js/index.d.ts:458

iuxor

iuxor(b): BN
Parameters
- b: BN
Returns BN
Description
xor
- Defined in node_modules/@types/bn.js/index.d.ts:413

ixor

ixor(b): BN
Parameters
- b: BN
Returns BN
Description
xor
- Defined in node_modules/@types/bn.js/index.d.ts:403

lt

lt(b): boolean
Parameters
- b: BN
Returns boolean
Description
a less than b
- Defined in node_modules/@types/bn.js/index.d.ts:162

lte

lte(b): boolean
Parameters
- b: BN
Returns boolean
Description
a less than or equals b
- Defined in node_modules/@types/bn.js/index.d.ts:172

lten

lten(b): boolean
Parameters
- b: number
Returns boolean
Description
a less than or equals b
- Defined in node_modules/@types/bn.js/index.d.ts:177

ltn

ltn(b): boolean
Parameters
- b: number
Returns boolean
Description
a less than b
- Defined in node_modules/@types/bn.js/index.d.ts:167

maskn

maskn(b): BN
Parameters
- b: number
Returns BN
Description
clear bits with indexes higher or equal to b
- Defined in node_modules/@types/bn.js/index.d.ts:468

mod

mod(b): BN
Parameters
- b: BN
Returns BN
Description
reduct
- Defined in node_modules/@types/bn.js/index.d.ts:332

modn

modn(b): number
Parameters
- b: number
Returns number
See
API consistency https://github.com/indutny/bn.js/pull/130

Description
reduct
- Defined in node_modules/@types/bn.js/index.d.ts:343

mul

mul(b): BN
Parameters
- b: BN
Returns BN
Description
multiply
- Defined in node_modules/@types/bn.js/index.d.ts:282

muln

muln(b): BN
Parameters
- b: number
Returns BN
Description
multiply
- Defined in node_modules/@types/bn.js/index.d.ts:292

neg

neg(): BN
Returns BN
Description
negate sign
- Defined in node_modules/@types/bn.js/index.d.ts:222

notn

notn(w): BN
Parameters
- w: number
Returns BN
Description
not (for the width specified by w)
- Defined in node_modules/@types/bn.js/index.d.ts:482

or

or(b): BN
Parameters
- b: BN
Returns BN
Description
or
- Defined in node_modules/@types/bn.js/index.d.ts:353

pow

pow(b): BN
Parameters
- b: BN
Returns BN
Description
raise a to the power of b
- Defined in node_modules/@types/bn.js/index.d.ts:312

setn

setn(b): BN
Parameters
- b: number
Returns BN
Description
set specified bit to 1
- Defined in node_modules/@types/bn.js/index.d.ts:418

shln

shln(b): BN
Parameters
- b: number
Returns BN
Description
shift left
- Defined in node_modules/@types/bn.js/index.d.ts:423

shrn

shrn(b): BN
Parameters
- b: number
Returns BN
Description
shift right
- Defined in node_modules/@types/bn.js/index.d.ts:443

sqr

sqr(): BN
Returns BN
Description
square
- Defined in node_modules/@types/bn.js/index.d.ts:302

sub

sub(b): BN
Parameters
- b: BN
Returns BN
Description
subtraction
- Defined in node_modules/@types/bn.js/index.d.ts:262

subn

subn(b): BN
Parameters
- b: number
Returns BN
Description
subtraction
- Defined in node_modules/@types/bn.js/index.d.ts:272

testn

testn(b): boolean
Parameters
- b: number
Returns boolean
Description
test if specified bit is set
- Defined in node_modules/@types/bn.js/index.d.ts:463

toArray

toArray(endian?, length?): number[]
Parameters
- Optional endian: Endianness
- Optional length: number
Returns number[]
Description
convert to byte Array, and optionally zero pad to length, throwing if already exceeding
- Defined in node_modules/@types/bn.js/index.d.ts:87

toArrayLike

toArrayLike(ArrayType, endian?, length?): Buffer
Parameters
- ArrayType: BufferConstructor
- Optional endian: Endianness
- Optional length: number
Returns Buffer
Description
convert to an instance of type, which must behave like an Array
- Defined in node_modules/@types/bn.js/index.d.ts:92
toArrayLike(ArrayType, endian?, length?): any[]
Parameters
- ArrayType: any[]
- Optional endian: Endianness
- Optional length: number
Returns any[]
- Defined in node_modules/@types/bn.js/index.d.ts:98

toBuffer

toBuffer(endian?, length?): Buffer
Parameters
- Optional endian: Endianness
- Optional length: number
Returns Buffer
Description
convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)
- Defined in node_modules/@types/bn.js/index.d.ts:107

toJSON

toJSON(): string
Returns string
Description
convert to JSON compatible hex string (alias of toString(16))
- Defined in node_modules/@types/bn.js/index.d.ts:82

toNumber

toNumber(): number
Returns number
Description
convert to Javascript Number (limited to 53 bits)
- Defined in node_modules/@types/bn.js/index.d.ts:77

toRed

toRed(reductionContext): RedBN
Parameters
- reductionContext: ReductionContext
Returns RedBN
Description
Convert number to red
- Defined in node_modules/@types/bn.js/index.d.ts:507

toString

toString(base?, length?): string
Parameters
- Optional base: number | "hex"
- Optional length: number
Returns string
Description
convert to base-string and pad with zeroes
- Defined in node_modules/@types/bn.js/index.d.ts:72

toTwos

toTwos(width): BN
Parameters
- width: number
Returns BN
Description
convert to two's complement representation, where width is bit width
- Defined in node_modules/@types/bn.js/index.d.ts:212

uand

uand(b): BN
Parameters
- b: BN
Returns BN
Description
and
- Defined in node_modules/@types/bn.js/index.d.ts:383

ucmp

ucmp(b): -1 | 0 | 1
Parameters
- b: BN
Returns -1 | 0 | 1
Description
compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result
- Defined in node_modules/@types/bn.js/index.d.ts:152

umod

umod(b): BN
Parameters
- b: BN
Returns BN
Description
reduct
- Defined in node_modules/@types/bn.js/index.d.ts:337

uor

uor(b): BN
Parameters
- b: BN
Returns BN
Description
or
- Defined in node_modules/@types/bn.js/index.d.ts:363

ushln

ushln(b): BN
Parameters
- b: number
Returns BN
Description
shift left
- Defined in node_modules/@types/bn.js/index.d.ts:433

ushrn

ushrn(b): BN
Parameters
- b: number
Returns BN
Description
shift right
- Defined in node_modules/@types/bn.js/index.d.ts:453

uxor

uxor(b): BN
Parameters
- b: BN
Returns BN
Description
xor
- Defined in node_modules/@types/bn.js/index.d.ts:408

xor

xor(b): BN
Parameters
- b: BN
Returns BN
Description
xor
- Defined in node_modules/@types/bn.js/index.d.ts:398

zeroBits

zeroBits(): number
Returns number
Description
return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)
- Defined in node_modules/@types/bn.js/index.d.ts:117

`Static` isBN

isBN(b): b is BN
Parameters
- b: any
Returns b is BN
Description
returns true if the supplied object is a BN.js instance
- Defined in node_modules/@types/bn.js/index.d.ts:52

`Static` max

max(left, right): BN
Parameters
- left: BN
- right: BN
Returns BN
Description
returns the maximum of 2 BN instances.
- Defined in node_modules/@types/bn.js/index.d.ts:57

`Static` min

min(left, right): BN
Parameters
- left: BN
- right: BN
Returns BN
Description
returns the minimum of 2 BN instances.
- Defined in node_modules/@types/bn.js/index.d.ts:62

`Static` mont

mont(num): ReductionContext
Parameters
- num: BN
Returns ReductionContext
Description
create a reduction context with the Montgomery trick.
- Defined in node_modules/@types/bn.js/index.d.ts:47

`Static` red

red(reductionContext): ReductionContext
Parameters
- reductionContext: IPrimeName | BN
Returns ReductionContext
Description
create a reduction context
- Defined in node_modules/@types/bn.js/index.d.ts:42