Class BN

Hierarchy

new BN
- BN

Index

Constructors

constructor

Properties

BN wordSize

Constructors

constructor

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

Properties

`Static` BN

BN: typeof new BN

`Static` wordSize

wordSize: 26

Methods

abs

abs(): new BN
Returns new BN

Description
absolute value
Inherited from _BN.abs
- Defined in node_modules/@types/bn.js/index.d.ts:235

add

add(b): new BN
Parameters
- b: new BN
Returns new BN

Description
addition
Inherited from _BN.add
- Defined in node_modules/@types/bn.js/index.d.ts:245

addn

addn(b): new BN
Parameters
- b: number
Returns new BN

Description
addition
Inherited from _BN.addn
- Defined in node_modules/@types/bn.js/index.d.ts:255

and

and(b): new BN
Parameters
- b: new BN
Returns new BN

Description
and
Inherited from _BN.and
- Defined in node_modules/@types/bn.js/index.d.ts:381

andln

andln(b): new BN
Parameters
- b: number
Returns new BN

Description
and (NOTE: andln is going to be replaced with andn in future)
Inherited from _BN.andln
- Defined in node_modules/@types/bn.js/index.d.ts:401

bincn

bincn(b): new BN
Parameters
- b: number
Returns new BN

Description
add 1 << b to the number
Inherited from _BN.bincn
- Defined in node_modules/@types/bn.js/index.d.ts:485

bitLength

bitLength(): number
Returns number

Description
get number of bits occupied
Inherited from _BN.bitLength
- Defined in node_modules/@types/bn.js/index.d.ts:115

byteLength

byteLength(): number
Returns number

Description
return number of bytes occupied
Inherited from _BN.byteLength
- Defined in node_modules/@types/bn.js/index.d.ts:125

clone

clone(): new BN
Returns new BN

Description
clone number
Inherited from _BN.clone
- Defined in node_modules/@types/bn.js/index.d.ts:70

cmp

cmp(b): 0 | 1 | -1
Parameters
- b: new BN
Returns 0 | 1 | -1

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

cmpn

cmpn(b): 0 | 1 | -1
Parameters
- b: number
Returns 0 | 1 | -1

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

div

div(b): new BN
Parameters
- b: new BN
Returns new BN

Description
divide
Inherited from _BN.div
- Defined in node_modules/@types/bn.js/index.d.ts:320

divRound

divRound(b): new BN
Parameters
- b: new BN
Returns new BN

Description
rounded division
Inherited from _BN.divRound
- Defined in node_modules/@types/bn.js/index.d.ts:356

divn

divn(b): new BN
Parameters
- b: number
Returns new BN

Description
divide
Inherited from _BN.divn
- Defined in node_modules/@types/bn.js/index.d.ts:325

egcd

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

eq

eq(b): boolean
Parameters
- b: new BN
Returns boolean

Description
a equals b
Inherited from _BN.eq
- Defined in node_modules/@types/bn.js/index.d.ts:205

eqn

eqn(b): boolean
Parameters
- b: number
Returns boolean

Description
a equals b
Inherited from _BN.eqn
- Defined in node_modules/@types/bn.js/index.d.ts:210

fromTwos

fromTwos(width): new BN
Parameters
- width: number
Returns new BN

Description
convert from two's complement representation, where width is the bit width
Inherited from _BN.fromTwos
- Defined in node_modules/@types/bn.js/index.d.ts:220

gcd

gcd(b): new BN
Parameters
- b: new BN
Returns new BN

Description
GCD
Inherited from _BN.gcd
- Defined in node_modules/@types/bn.js/index.d.ts:500

gt

gt(b): boolean
Parameters
- b: new BN
Returns boolean

Description
a greater than b
Inherited from _BN.gt
- Defined in node_modules/@types/bn.js/index.d.ts:185

gte

gte(b): boolean
Parameters
- b: new BN
Returns boolean

Description
a greater than or equals b
Inherited from _BN.gte
- Defined in node_modules/@types/bn.js/index.d.ts:195

gten

gten(b): boolean
Parameters
- b: number
Returns boolean

Description
a greater than or equals b
Inherited from _BN.gten
- Defined in node_modules/@types/bn.js/index.d.ts:200

gtn

gtn(b): boolean
Parameters
- b: number
Returns boolean

Description
a greater than b
Inherited from _BN.gtn
- Defined in node_modules/@types/bn.js/index.d.ts:190

iabs

iabs(): new BN
Returns new BN

Description
absolute value
Inherited from _BN.iabs
- Defined in node_modules/@types/bn.js/index.d.ts:240

iadd

iadd(b): new BN
Parameters
- b: new BN
Returns new BN

Description
addition
Inherited from _BN.iadd
- Defined in node_modules/@types/bn.js/index.d.ts:250

iaddn

iaddn(b): new BN
Parameters
- b: number
Returns new BN

Description
addition
Inherited from _BN.iaddn
- Defined in node_modules/@types/bn.js/index.d.ts:260

iand

iand(b): new BN
Parameters
- b: new BN
Returns new BN

Description
and
Inherited from _BN.iand
- Defined in node_modules/@types/bn.js/index.d.ts:386

idivn

idivn(b): new BN
Parameters
- b: number
Returns new BN

Description
divide
Inherited from _BN.idivn
- Defined in node_modules/@types/bn.js/index.d.ts:330

imaskn

imaskn(b): new BN
Parameters
- b: number
Returns new BN

Description
clear bits with indexes higher or equal to b
Inherited from _BN.imaskn
- Defined in node_modules/@types/bn.js/index.d.ts:481

imul

imul(b): new BN
Parameters
- b: new BN
Returns new BN

Description
multiply
Inherited from _BN.imul
- Defined in node_modules/@types/bn.js/index.d.ts:290

imuln

imuln(b): new BN
Parameters
- b: number
Returns new BN

Description
multiply
Inherited from _BN.imuln
- Defined in node_modules/@types/bn.js/index.d.ts:300

ineg

ineg(): new BN
Returns new BN

Description
negate sign
Inherited from _BN.ineg
- Defined in node_modules/@types/bn.js/index.d.ts:230

inotn

inotn(w): new BN
Parameters
- w: number
Returns new BN

Description
not (for the width specified by w)
Inherited from _BN.inotn
- Defined in node_modules/@types/bn.js/index.d.ts:495

invm

invm(b): new BN
Parameters
- b: new BN
Returns new BN

Description
inverse a modulo b
Inherited from _BN.invm
- Defined in node_modules/@types/bn.js/index.d.ts:510

ior

ior(b): new BN
Parameters
- b: new BN
Returns new BN

Description
or
Inherited from _BN.ior
- Defined in node_modules/@types/bn.js/index.d.ts:366

isEven

isEven(): boolean
Returns boolean

Description
check if value is even
Inherited from _BN.isEven
- Defined in node_modules/@types/bn.js/index.d.ts:135

isNeg

isNeg(): boolean
Returns boolean

Description
true if the number is negative
Inherited from _BN.isNeg
- Defined in node_modules/@types/bn.js/index.d.ts:130

isOdd

isOdd(): boolean
Returns boolean

Description
check if value is odd
Inherited from _BN.isOdd
- Defined in node_modules/@types/bn.js/index.d.ts:140

isZero

isZero(): boolean
Returns boolean

Description
check if value is zero
Inherited from _BN.isZero
- Defined in node_modules/@types/bn.js/index.d.ts:145

ishln

ishln(b): new BN
Parameters
- b: number
Returns new BN

Description
shift left
Inherited from _BN.ishln
- Defined in node_modules/@types/bn.js/index.d.ts:436

ishrn

ishrn(b): new BN
Parameters
- b: number
Returns new BN

Description
shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)
Inherited from _BN.ishrn
- Defined in node_modules/@types/bn.js/index.d.ts:456

isqr

isqr(): new BN
Returns new BN

Description
square
Inherited from _BN.isqr
- Defined in node_modules/@types/bn.js/index.d.ts:310

isub

isub(b): new BN
Parameters
- b: new BN
Returns new BN

Description
subtraction
Inherited from _BN.isub
- Defined in node_modules/@types/bn.js/index.d.ts:270

isubn

isubn(b): new BN
Parameters
- b: number
Returns new BN

Description
subtraction
Inherited from _BN.isubn
- Defined in node_modules/@types/bn.js/index.d.ts:280

iuand

iuand(b): new BN
Parameters
- b: new BN
Returns new BN

Description
and
Inherited from _BN.iuand
- Defined in node_modules/@types/bn.js/index.d.ts:396

iuor

iuor(b): new BN
Parameters
- b: new BN
Returns new BN

Description
or
Inherited from _BN.iuor
- Defined in node_modules/@types/bn.js/index.d.ts:376

iushln

iushln(b): new BN
Parameters
- b: number
Returns new BN

Description
shift left
Inherited from _BN.iushln
- Defined in node_modules/@types/bn.js/index.d.ts:446

iushrn

iushrn(b): new BN
Parameters
- b: number
Returns new BN

Description
shift right
Inherited from _BN.iushrn
- Defined in node_modules/@types/bn.js/index.d.ts:466

iuxor

iuxor(b): new BN
Parameters
- b: new BN
Returns new BN

Description
xor
Inherited from _BN.iuxor
- Defined in node_modules/@types/bn.js/index.d.ts:421

ixor

ixor(b): new BN
Parameters
- b: new BN
Returns new BN

Description
xor
Inherited from _BN.ixor
- Defined in node_modules/@types/bn.js/index.d.ts:411

lt

lt(b): boolean
Parameters
- b: new BN
Returns boolean

Description
a less than b
Inherited from _BN.lt
- Defined in node_modules/@types/bn.js/index.d.ts:165

lte

lte(b): boolean
Parameters
- b: new BN
Returns boolean

Description
a less than or equals b
Inherited from _BN.lte
- Defined in node_modules/@types/bn.js/index.d.ts:175

lten

lten(b): boolean
Parameters
- b: number
Returns boolean

Description
a less than or equals b
Inherited from _BN.lten
- Defined in node_modules/@types/bn.js/index.d.ts:180

ltn

ltn(b): boolean
Parameters
- b: number
Returns boolean

Description
a less than b
Inherited from _BN.ltn
- Defined in node_modules/@types/bn.js/index.d.ts:170

maskn

maskn(b): new BN
Parameters
- b: number
Returns new BN

Description
clear bits with indexes higher or equal to b
Inherited from _BN.maskn
- Defined in node_modules/@types/bn.js/index.d.ts:476

mod

mod(b): new BN
Parameters
- b: new BN
Returns new BN

Description
reduct
Inherited from _BN.mod
- Defined in node_modules/@types/bn.js/index.d.ts:335

modn

modn(b): number
Parameters
- b: number
Returns number

Deprecated

Description
reduct
Inherited from _BN.modn
- Defined in node_modules/@types/bn.js/index.d.ts:346

modrn

modrn(b): number
Parameters
- b: number
Returns number

Description
reduct
Inherited from _BN.modrn
- Defined in node_modules/@types/bn.js/index.d.ts:351

mul

mul(b): new BN
Parameters
- b: new BN
Returns new BN

Description
multiply
Inherited from _BN.mul
- Defined in node_modules/@types/bn.js/index.d.ts:285

muln

muln(b): new BN
Parameters
- b: number
Returns new BN

Description
multiply
Inherited from _BN.muln
- Defined in node_modules/@types/bn.js/index.d.ts:295

neg

neg(): new BN
Returns new BN

Description
negate sign
Inherited from _BN.neg
- Defined in node_modules/@types/bn.js/index.d.ts:225

notn

notn(w): new BN
Parameters
- w: number
Returns new BN

Description
not (for the width specified by w)
Inherited from _BN.notn
- Defined in node_modules/@types/bn.js/index.d.ts:490

or

or(b): new BN
Parameters
- b: new BN
Returns new BN

Description
or
Inherited from _BN.or
- Defined in node_modules/@types/bn.js/index.d.ts:361

pow

pow(b): new BN
Parameters
- b: new BN
Returns new BN

Description
raise a to the power of b
Inherited from _BN.pow
- Defined in node_modules/@types/bn.js/index.d.ts:315

setn

setn(b): new BN
Parameters
- b: number
Returns new BN

Description
set specified bit to 1
Inherited from _BN.setn
- Defined in node_modules/@types/bn.js/index.d.ts:426

shln

shln(b): new BN
Parameters
- b: number
Returns new BN

Description
shift left
Inherited from _BN.shln
- Defined in node_modules/@types/bn.js/index.d.ts:431

shrn

shrn(b): new BN
Parameters
- b: number
Returns new BN

Description
shift right
Inherited from _BN.shrn
- Defined in node_modules/@types/bn.js/index.d.ts:451

sqr

sqr(): new BN
Returns new BN

Description
square
Inherited from _BN.sqr
- Defined in node_modules/@types/bn.js/index.d.ts:305

sub

sub(b): new BN
Parameters
- b: new BN
Returns new BN

Description
subtraction
Inherited from _BN.sub
- Defined in node_modules/@types/bn.js/index.d.ts:265

subn

subn(b): new BN
Parameters
- b: number
Returns new BN

Description
subtraction
Inherited from _BN.subn
- Defined in node_modules/@types/bn.js/index.d.ts:275

testn

testn(b): boolean
Parameters
- b: number
Returns boolean

Description
test if specified bit is set
Inherited from _BN.testn
- Defined in node_modules/@types/bn.js/index.d.ts:471

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
Inherited from _BN.toArray
- Defined in node_modules/@types/bn.js/index.d.ts:90

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
Inherited from _BN.toArrayLike
- Defined in node_modules/@types/bn.js/index.d.ts:95
toArrayLike(ArrayType, endian?, length?): any[]
Parameters
- ArrayType: any[]
- Optional endian: Endianness
- Optional length: number
Returns any[]
Inherited from _BN.toArrayLike
- Defined in node_modules/@types/bn.js/index.d.ts:101

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)
Inherited from _BN.toBuffer
- Defined in node_modules/@types/bn.js/index.d.ts:110

toJSON

toJSON(): string
Returns string
Overrides _BN.toJSON
- Defined in packages/js/src/types.ts:32

toNumber

toNumber(): number
Returns number

Description
convert to Javascript Number (limited to 53 bits)
Inherited from _BN.toNumber
- Defined in node_modules/@types/bn.js/index.d.ts:80

toRed

toRed(reductionContext): RedBN
Parameters
- reductionContext: ReductionContext
Returns RedBN

Description
Convert number to red
Inherited from _BN.toRed
- Defined in node_modules/@types/bn.js/index.d.ts:515

toString

toString(base?, length?): string
Parameters
- Optional base: number | "hex"
- Optional length: number
Returns string

Description
convert to base-string and pad with zeroes
Inherited from _BN.toString
- Defined in node_modules/@types/bn.js/index.d.ts:75

toTwos

toTwos(width): new BN
Parameters
- width: number
Returns new BN

Description
convert to two's complement representation, where width is bit width
Inherited from _BN.toTwos
- Defined in node_modules/@types/bn.js/index.d.ts:215

uand

uand(b): new BN
Parameters
- b: new BN
Returns new BN

Description
and
Inherited from _BN.uand
- Defined in node_modules/@types/bn.js/index.d.ts:391

ucmp

ucmp(b): 0 | 1 | -1
Parameters
- b: new BN
Returns 0 | 1 | -1

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

umod

umod(b): new BN
Parameters
- b: new BN
Returns new BN

Description
reduct
Inherited from _BN.umod
- Defined in node_modules/@types/bn.js/index.d.ts:340

uor

uor(b): new BN
Parameters
- b: new BN
Returns new BN

Description
or
Inherited from _BN.uor
- Defined in node_modules/@types/bn.js/index.d.ts:371

ushln

ushln(b): new BN
Parameters
- b: number
Returns new BN

Description
shift left
Inherited from _BN.ushln
- Defined in node_modules/@types/bn.js/index.d.ts:441

ushrn

ushrn(b): new BN
Parameters
- b: number
Returns new BN

Description
shift right
Inherited from _BN.ushrn
- Defined in node_modules/@types/bn.js/index.d.ts:461

uxor

uxor(b): new BN
Parameters
- b: new BN
Returns new BN

Description
xor
Inherited from _BN.uxor
- Defined in node_modules/@types/bn.js/index.d.ts:416

xor

xor(b): new BN
Parameters
- b: new BN
Returns new BN

Description
xor
Inherited from _BN.xor
- Defined in node_modules/@types/bn.js/index.d.ts:406

zeroBits

zeroBits(): number
Returns number

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

`Static` isBN

isBN(b): b is new BN
Parameters
- b: any
Returns b is new BN

Description
returns true if the supplied object is a BN.js instance
Inherited from _BN.isBN
- Defined in node_modules/@types/bn.js/index.d.ts:55

`Static` max

max(left, right): new BN
Parameters
- left: new BN
- right: new BN
Returns new BN

Description
returns the maximum of 2 BN instances.
Inherited from _BN.max
- Defined in node_modules/@types/bn.js/index.d.ts:60

`Static` min

min(left, right): new BN
Parameters
- left: new BN
- right: new BN
Returns new BN

Description
returns the minimum of 2 BN instances.
Inherited from _BN.min
- Defined in node_modules/@types/bn.js/index.d.ts:65

`Static` mont

mont(num): ReductionContext
Parameters
- num: new BN
Returns ReductionContext

Description
create a reduction context with the Montgomery trick.
Inherited from _BN.mont
- Defined in node_modules/@types/bn.js/index.d.ts:50

`Static` red

red(reductionContext): ReductionContext
Parameters
- reductionContext: IPrimeName | new BN
Returns ReductionContext

Description
create a reduction context
Inherited from _BN.red
- Defined in node_modules/@types/bn.js/index.d.ts:45

Class BN

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

number: string | number | number[] | Uint8Array | Buffer | new BN

Optional base: number | "hex"

Optional endian: Endianness

Returns BN

Parameters

number: string | number | number[] | Uint8Array | Buffer | new BN

Optional endian: Endianness

Returns BN

Properties

Static BN

Static wordSize

Methods

abs

Returns new BN

Description

add

Parameters

b: new BN

Returns new BN

Description

addn

Parameters

b: number

Returns new BN

Description

and

Parameters

b: new BN

Returns new BN

Description

andln

Parameters

b: number

Returns new BN

Description

bincn

Parameters

b: number

Returns new BN

Description

bitLength

Returns number

Description

byteLength

Returns number

Description

clone

Returns new BN

Description

cmp

Parameters

b: new BN

Returns 0 | 1 | -1

Description

cmpn

Parameters

b: number

Returns 0 | 1 | -1

Description

div

Parameters

b: new BN

Returns new BN

Description

divRound

Parameters

b: new BN

Returns new BN

Description

divn

Parameters

`Optional` base: number | "hex"

`Optional` endian: Endianness

`Optional` endian: Endianness

`Static` BN

`Static` wordSize

Returns {
a: new BN;
b: new BN;
gcd: new BN;
}