Class BN

Hierarchy

BN

Index

Constructors

constructor

Constructors

constructor

new BN(number: string | number | BN | Buffer | Uint8Array | number[], base?: number | "hex", endian?: Endianness): BN
new BN(number: string | number | BN | Buffer | Uint8Array | number[], endian?: Endianness): BN

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

Methods

abs

abs(): BN

- Defined in node_modules/@types/bn.js/index.d.ts:232
description
absolute value

Returns BN

add

add(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:242
description
addition

Parameters
- b: BN
Returns BN

addn

addn(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:252
description
addition

Parameters
- b: number
Returns BN

and

and(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:373
description
and

Parameters
- b: BN
Returns BN

andln

andln(b: number): BN

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

Parameters
- b: number
Returns BN

bincn

bincn(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:477
description
add 1 << b to the number

Parameters
- b: number
Returns BN

bitLength

bitLength(): number

- Defined in node_modules/@types/bn.js/index.d.ts:112
description
get number of bits occupied

Returns number

byteLength

byteLength(): number

- Defined in node_modules/@types/bn.js/index.d.ts:122
description
return number of bytes occupied

Returns number

clone

clone(): BN

- Defined in node_modules/@types/bn.js/index.d.ts:67
description
clone number

Returns BN

cmp

cmp(b: BN): 0 | 1 | -1

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

Parameters
- b: BN
Returns 0 | 1 | -1

cmpn

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

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

Parameters
- b: number
Returns 0 | 1 | -1

div

div(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:317
description
divide

Parameters
- b: BN
Returns BN

divRound

divRound(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:348
description
rounded division

Parameters
- b: BN
Returns BN

divn

divn(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:322
description
divide

Parameters
- b: number
Returns BN

egcd

egcd(b: BN): { a: BN; b: BN; gcd: BN }

- Defined in node_modules/@types/bn.js/index.d.ts:497
description
Extended GCD results ({ a: ..., b: ..., gcd: ... })

Parameters
- b: BN
Returns { a: BN; b: BN; gcd: BN }
- a: BN
- b: BN
- gcd: BN

eq

eq(b: BN): boolean

- Defined in node_modules/@types/bn.js/index.d.ts:202
description
a equals b

Parameters
- b: BN
Returns boolean

eqn

eqn(b: number): boolean

- Defined in node_modules/@types/bn.js/index.d.ts:207
description
a equals b

Parameters
- b: number
Returns boolean

fromTwos

fromTwos(width: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:217
description
convert from two's complement representation, where width is the bit width

Parameters
- width: number
Returns BN

gcd

gcd(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:492
description
GCD

Parameters
- b: BN
Returns BN

gt

gt(b: BN): boolean

- Defined in node_modules/@types/bn.js/index.d.ts:182
description
a greater than b

Parameters
- b: BN
Returns boolean

gte

gte(b: BN): boolean

- Defined in node_modules/@types/bn.js/index.d.ts:192
description
a greater than or equals b

Parameters
- b: BN
Returns boolean

gten

gten(b: number): boolean

- Defined in node_modules/@types/bn.js/index.d.ts:197
description
a greater than or equals b

Parameters
- b: number
Returns boolean

gtn

gtn(b: number): boolean

- Defined in node_modules/@types/bn.js/index.d.ts:187
description
a greater than b

Parameters
- b: number
Returns boolean

iabs

iabs(): BN

- Defined in node_modules/@types/bn.js/index.d.ts:237
description
absolute value

Returns BN

iadd

iadd(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:247
description
addition

Parameters
- b: BN
Returns BN

iaddn

iaddn(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:257
description
addition

Parameters
- b: number
Returns BN

iand

iand(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:378
description
and

Parameters
- b: BN
Returns BN

idivn

idivn(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:327
description
divide

Parameters
- b: number
Returns BN

imaskn

imaskn(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:473
description
clear bits with indexes higher or equal to b

Parameters
- b: number
Returns BN

imul

imul(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:287
description
multiply

Parameters
- b: BN
Returns BN

imuln

imuln(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:297
description
multiply

Parameters
- b: number
Returns BN

ineg

ineg(): BN

- Defined in node_modules/@types/bn.js/index.d.ts:227
description
negate sign

Returns BN

inotn

inotn(w: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:487
description
not (for the width specified by w)

Parameters
- w: number
Returns BN

invm

invm(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:502
description
inverse a modulo b

Parameters
- b: BN
Returns BN

ior

ior(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:358
description
or

Parameters
- b: BN
Returns BN

isEven

isEven(): boolean

- Defined in node_modules/@types/bn.js/index.d.ts:132
description
check if value is even

Returns boolean

isNeg

isNeg(): boolean

- Defined in node_modules/@types/bn.js/index.d.ts:127
description
true if the number is negative

Returns boolean

isOdd

isOdd(): boolean

- Defined in node_modules/@types/bn.js/index.d.ts:137
description
check if value is odd

Returns boolean

isZero

isZero(): boolean

- Defined in node_modules/@types/bn.js/index.d.ts:142
description
check if value is zero

Returns boolean

ishln

ishln(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:428
description
shift left

Parameters
- b: number
Returns BN

ishrn

ishrn(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:448
description
shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

Parameters
- b: number
Returns BN

isqr

isqr(): BN

- Defined in node_modules/@types/bn.js/index.d.ts:307
description
square

Returns BN

isub

isub(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:267
description
subtraction

Parameters
- b: BN
Returns BN

isubn

isubn(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:277
description
subtraction

Parameters
- b: number
Returns BN

iuand

iuand(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:388
description
and

Parameters
- b: BN
Returns BN

iuor

iuor(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:368
description
or

Parameters
- b: BN
Returns BN

iushln

iushln(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:438
description
shift left

Parameters
- b: number
Returns BN

iushrn

iushrn(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:458
description
shift right

Parameters
- b: number
Returns BN

iuxor

iuxor(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:413
description
xor

Parameters
- b: BN
Returns BN

ixor

ixor(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:403
description
xor

Parameters
- b: BN
Returns BN

lt

lt(b: BN): boolean

- Defined in node_modules/@types/bn.js/index.d.ts:162
description
a less than b

Parameters
- b: BN
Returns boolean

lte

lte(b: BN): boolean

- Defined in node_modules/@types/bn.js/index.d.ts:172
description
a less than or equals b

Parameters
- b: BN
Returns boolean

lten

lten(b: number): boolean

- Defined in node_modules/@types/bn.js/index.d.ts:177
description
a less than or equals b

Parameters
- b: number
Returns boolean

ltn

ltn(b: number): boolean

- Defined in node_modules/@types/bn.js/index.d.ts:167
description
a less than b

Parameters
- b: number
Returns boolean

maskn

maskn(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:468
description
clear bits with indexes higher or equal to b

Parameters
- b: number
Returns BN

mod

mod(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:332
description
reduct

Parameters
- b: BN
Returns BN

modn

modn(b: number): number

- Defined in node_modules/@types/bn.js/index.d.ts:343
see
API consistency https://github.com/indutny/bn.js/pull/130

description
reduct

Parameters
- b: number
Returns number

mul

mul(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:282
description
multiply

Parameters
- b: BN
Returns BN

muln

muln(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:292
description
multiply

Parameters
- b: number
Returns BN

neg

neg(): BN

- Defined in node_modules/@types/bn.js/index.d.ts:222
description
negate sign

Returns BN

notn

notn(w: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:482
description
not (for the width specified by w)

Parameters
- w: number
Returns BN

or

or(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:353
description
or

Parameters
- b: BN
Returns BN

pow

pow(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:312
description
raise a to the power of b

Parameters
- b: BN
Returns BN

setn

setn(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:418
description
set specified bit to 1

Parameters
- b: number
Returns BN

shln

shln(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:423
description
shift left

Parameters
- b: number
Returns BN

shrn

shrn(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:443
description
shift right

Parameters
- b: number
Returns BN

sqr

sqr(): BN

- Defined in node_modules/@types/bn.js/index.d.ts:302
description
square

Returns BN

sub

sub(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:262
description
subtraction

Parameters
- b: BN
Returns BN

subn

subn(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:272
description
subtraction

Parameters
- b: number
Returns BN

testn

testn(b: number): boolean

- Defined in node_modules/@types/bn.js/index.d.ts:463
description
test if specified bit is set

Parameters
- b: number
Returns boolean

toArray

toArray(endian?: Endianness, length?: number): number[]

- Defined in node_modules/@types/bn.js/index.d.ts:87
description
convert to byte Array, and optionally zero pad to length, throwing if already exceeding

Parameters
- Optional endian: Endianness
- Optional length: number
Returns number[]

toArrayLike

toArrayLike(ArrayType: BufferConstructor, endian?: Endianness, length?: number): Buffer
toArrayLike(ArrayType: any[], endian?: Endianness, length?: number): any[]

- Defined in node_modules/@types/bn.js/index.d.ts:92
description
convert to an instance of type, which must behave like an Array

Parameters
- ArrayType: BufferConstructor
- Optional endian: Endianness
- Optional length: number
Returns Buffer
- Defined in node_modules/@types/bn.js/index.d.ts:98
Parameters
- ArrayType: any[]
- Optional endian: Endianness
- Optional length: number
Returns any[]

toBuffer

toBuffer(endian?: Endianness, length?: number): Buffer

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

Parameters
- Optional endian: Endianness
- Optional length: number
Returns Buffer

toJSON

toJSON(): string

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

Returns string

toNumber

toNumber(): number

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

Returns number

toRed

toRed(reductionContext: ReductionContext): RedBN

- Defined in node_modules/@types/bn.js/index.d.ts:507
description
Convert number to red

Parameters
- reductionContext: ReductionContext
Returns RedBN

toString

toString(base?: number | "hex", length?: number): string

- Defined in node_modules/@types/bn.js/index.d.ts:72
description
convert to base-string and pad with zeroes

Parameters
- Optional base: number | "hex"
- Optional length: number
Returns string

toTwos

toTwos(width: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:212
description
convert to two's complement representation, where width is bit width

Parameters
- width: number
Returns BN

uand

uand(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:383
description
and

Parameters
- b: BN
Returns BN

ucmp

ucmp(b: BN): 0 | 1 | -1

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

Parameters
- b: BN
Returns 0 | 1 | -1

umod

umod(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:337
description
reduct

Parameters
- b: BN
Returns BN

uor

uor(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:363
description
or

Parameters
- b: BN
Returns BN

ushln

ushln(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:433
description
shift left

Parameters
- b: number
Returns BN

ushrn

ushrn(b: number): BN

- Defined in node_modules/@types/bn.js/index.d.ts:453
description
shift right

Parameters
- b: number
Returns BN

uxor

uxor(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:408
description
xor

Parameters
- b: BN
Returns BN

xor

xor(b: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:398
description
xor

Parameters
- b: BN
Returns BN

zeroBits

zeroBits(): number

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

Returns number

Static isBN

isBN(b: any): b is BN

- Defined in node_modules/@types/bn.js/index.d.ts:52
description
returns true if the supplied object is a BN.js instance

Parameters
- b: any
Returns b is BN

Static max

max(left: BN, right: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:57
description
returns the maximum of 2 BN instances.

Parameters
- left: BN
- right: BN
Returns BN

Static min

min(left: BN, right: BN): BN

- Defined in node_modules/@types/bn.js/index.d.ts:62
description
returns the minimum of 2 BN instances.

Parameters
- left: BN
- right: BN
Returns BN

Static mont

mont(num: BN): ReductionContext

- Defined in node_modules/@types/bn.js/index.d.ts:47
description
create a reduction context with the Montgomery trick.

Parameters
- num: BN
Returns ReductionContext

Static red

red(reductionContext: BN | IPrimeName): ReductionContext

- Defined in node_modules/@types/bn.js/index.d.ts:42
description
create a reduction context

Parameters
- reductionContext: BN | IPrimeName
Returns ReductionContext

Generated using TypeDoc