Class BN

constructor

• new BN(number, base?, endian?): BN

• Parameters

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

  • Optional base: number | "hex"

  • Optional endian: Endianness

  Returns BN

• new BN(number, endian?): BN

• Parameters

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

  • Optional endian: Endianness

  Returns BN

Static BN

Static wordSize

abs

• abs(): BN

• Returns BN

  Description

  absolute value

add

• add(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  addition

addn

• addn(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  addition

and

• and(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  and

andln

• andln(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  and (NOTE: andln is going to be replaced with andn in future)

bincn

• bincn(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  add 1 << b to the number

bitLength

• bitLength(): number

• Returns number

  Description

  get number of bits occupied

byteLength

• byteLength(): number

• Returns number

  Description

  return number of bytes occupied

clone

• clone(): BN

• Returns BN

  Description

  clone number

cmp

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

• Parameters

  • b: 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

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

div

• div(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  divide

divRound

• divRound(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  rounded division

divmod

• divmod(b, mode?, positive?): {
      div: BN;
      mod: BN;
  }

• Parameters

  • b: BN

  • Optional mode: "div" | "mod"

  • Optional positive: boolean

  Returns {
      div: BN;
      mod: BN;
  }

  • div: BN

  • mod: BN

  Description

  division with remainder

divn

• divn(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  divide

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: ... })

eq

• eq(b): boolean

• Parameters

  • b: BN

  Returns boolean

  Description

  a equals b

eqn

• eqn(b): boolean

• Parameters

  • b: number

  Returns boolean

  Description

  a equals b

fromTwos

• fromTwos(width): BN

• Parameters

  • width: number

  Returns BN

  Description

  convert from two's complement representation, where width is the bit width

gcd

• gcd(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  GCD

gt

• gt(b): boolean

• Parameters

  • b: BN

  Returns boolean

  Description

  a greater than b

gte

• gte(b): boolean

• Parameters

  • b: BN

  Returns boolean

  Description

  a greater than or equals b

gten

• gten(b): boolean

• Parameters

  • b: number

  Returns boolean

  Description

  a greater than or equals b

gtn

• gtn(b): boolean

• Parameters

  • b: number

  Returns boolean

  Description

  a greater than b

iabs

• iabs(): BN

• Returns BN

  Description

  absolute value

iadd

• iadd(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  addition

iaddn

• iaddn(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  addition

iand

• iand(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  and

idivn

• idivn(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  divide

imaskn

• imaskn(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  clear bits with indexes higher or equal to b

imul

• imul(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  multiply

imuln

• imuln(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  multiply

ineg

• ineg(): BN

• Returns BN

  Description

  negate sign

inotn

• inotn(w): BN

• Parameters

  • w: number

  Returns BN

  Description

  not (for the width specified by w)

invm

• invm(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  inverse a modulo b

ior

• ior(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  or

isEven

• isEven(): boolean

• Returns boolean

  Description

  check if value is even

isNeg

• isNeg(): boolean

• Returns boolean

  Description

  true if the number is negative

isOdd

• isOdd(): boolean

• Returns boolean

  Description

  check if value is odd

isZero

• isZero(): boolean

• Returns boolean

  Description

  check if value is zero

ishln

• ishln(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  shift left

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)

isqr

• isqr(): BN

• Returns BN

  Description

  square

isub

• isub(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  subtraction

isubn

• isubn(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  subtraction

iuand

• iuand(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  and

iuor

• iuor(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  or

iushln

• iushln(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  shift left

iushrn

• iushrn(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  shift right

iuxor

• iuxor(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  xor

ixor

• ixor(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  xor

lt

• lt(b): boolean

• Parameters

  • b: BN

  Returns boolean

  Description

  a less than b

lte

• lte(b): boolean

• Parameters

  • b: BN

  Returns boolean

  Description

  a less than or equals b

lten

• lten(b): boolean

• Parameters

  • b: number

  Returns boolean

  Description

  a less than or equals b

ltn

• ltn(b): boolean

• Parameters

  • b: number

  Returns boolean

  Description

  a less than b

maskn

• maskn(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  clear bits with indexes higher or equal to b

mod

• mod(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  reduct

modn

• modn(b): number

• Parameters

  • b: number

  Returns number

  Deprecated

  Description

  reduct

modrn

• modrn(b): number

• Parameters

  • b: number

  Returns number

  Description

  reduct

mul

• mul(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  multiply

muln

• muln(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  multiply

neg

• neg(): BN

• Returns BN

  Description

  negate sign

notn

• notn(w): BN

• Parameters

  • w: number

  Returns BN

  Description

  not (for the width specified by w)

or

• or(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  or

pow

• pow(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  raise a to the power of b

setn

• setn(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  set specified bit to 1

shln

• shln(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  shift left

shrn

• shrn(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  shift right

sqr

• sqr(): BN

• Returns BN

  Description

  square

sub

• sub(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  subtraction

subn

• subn(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  subtraction

testn

• testn(b): boolean

• Parameters

  • b: number

  Returns boolean

  Description

  test if specified bit is set

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

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

• toArrayLike(ArrayType, endian?, length?): any[]

• Parameters

  • ArrayType: any[]

  • Optional endian: Endianness

  • Optional length: number

  Returns any[]

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)

toJSON

• toJSON(): string

• Returns string

  Description

  convert to JSON compatible hex string (alias of toString(16))

toNumber

• toNumber(): number

• Returns number

  Description

  convert to Javascript Number (limited to 53 bits)

toRed

• toRed(reductionContext): RedBN

• Parameters

  • reductionContext: ReductionContext

  Returns RedBN

  Description

  Convert number to red

toString

• toString(base?, length?): string

• Parameters

  • Optional base: number | "hex"

  • Optional length: number

  Returns string

  Description

  convert to base-string and pad with zeroes

toTwos

• toTwos(width): BN

• Parameters

  • width: number

  Returns BN

  Description

  convert to two's complement representation, where width is bit width

uand

• uand(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  and

ucmp

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

• Parameters

  • b: 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

umod

• umod(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  reduct

uor

• uor(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  or

ushln

• ushln(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  shift left

ushrn

• ushrn(b): BN

• Parameters

  • b: number

  Returns BN

  Description

  shift right

uxor

• uxor(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  xor

xor

• xor(b): BN

• Parameters

  • b: BN

  Returns BN

  Description

  xor

zeroBits

• zeroBits(): number

• Returns number

  Description

  return number of less-significant consequent zero bits (example: 1010000 has 4 zero bits)

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

Static max

• max(left, right): BN

• Parameters

  • left: BN

  • right: BN

  Returns BN

  Description

  returns the maximum of 2 BN instances.

Static min

• min(left, right): BN

• Parameters

  • left: BN

  • right: BN

  Returns BN

  Description

  returns the minimum of 2 BN instances.

Static mont

• mont(num): ReductionContext

• Parameters

  • num: BN

  Returns ReductionContext

  Description

  create a reduction context with the Montgomery trick.

Static red

• red(reductionContext): ReductionContext

• Parameters

  • reductionContext: BN | IPrimeName

  Returns ReductionContext

  Description

  create a reduction context