Class BN

constructor

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

  Parameters

  • number:
        | string
        | number
        | Uint8Array<ArrayBufferLike>
        | number[]
        | BN
        | Buffer<ArrayBufferLike>
  • Optionalbase: number | "hex"
  • Optionalendian: Endianness

  Returns BN

• new BN(
      number:
          | string
          | number
          | Uint8Array<ArrayBufferLike>
          | number[]
          | BN
          | Buffer<ArrayBufferLike>,
      endian?: Endianness,
  ): BN

  Parameters

  • number:
        | string
        | number
        | Uint8Array<ArrayBufferLike>
        | number[]
        | BN
        | Buffer<ArrayBufferLike>
  • Optionalendian: Endianness

  Returns BN

StaticBN

StaticwordSize

abs

• abs(): BN

  Returns BN

  Description

  absolute value

add

• add(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  addition

addn

• addn(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  addition

and

• and(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  and

andln

• andln(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

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

bincn

• bincn(b: number): 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: BN): -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

cmpn

• cmpn(b: number): -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

copy

• copy(dest: BN): void

  Parameters

  • dest: BN

  Returns void

  Description

  Copy to dest number

div

• div(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  divide

divmod

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

  Parameters

  • b: BN
  • Optionalmode: "div" | "mod"
  • Optionalpositive: boolean

  Returns { div: BN; mod: BN }

  Description

  division with remainder

divn

• divn(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  divide

divRound

• divRound(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  rounded division

egcd

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

  Parameters

  • b: BN

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

  Description

  Extended GCD results ({ a: ..., b: ..., gcd: ... })

eq

• eq(b: BN): boolean

  Parameters

  • b: BN

  Returns boolean

  Description

  a equals b

eqn

• eqn(b: number): boolean

  Parameters

  • b: number

  Returns boolean

  Description

  a equals b

fromTwos

• fromTwos(width: number): BN

  Parameters

  • width: number

  Returns BN

  Description

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

gcd

• gcd(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  GCD

gt

• gt(b: BN): boolean

  Parameters

  • b: BN

  Returns boolean

  Description

  a greater than b

gte

• gte(b: BN): boolean

  Parameters

  • b: BN

  Returns boolean

  Description

  a greater than or equals b

gten

• gten(b: number): boolean

  Parameters

  • b: number

  Returns boolean

  Description

  a greater than or equals b

gtn

• gtn(b: number): boolean

  Parameters

  • b: number

  Returns boolean

  Description

  a greater than b

iabs

• iabs(): BN

  Returns BN

  Description

  absolute value

iadd

• iadd(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  addition

iaddn

• iaddn(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  addition

iand

• iand(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  and

idivn

• idivn(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  divide

imaskn

• imaskn(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  clear bits with indexes higher or equal to b

imul

• imul(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  multiply

imuln

• imuln(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  multiply

ineg

• ineg(): BN

  Returns BN

  Description

  negate sign

inotn

• inotn(w: number): BN

  Parameters

  • w: number

  Returns BN

  Description

  not (for the width specified by w)

invm

• invm(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  inverse a modulo b

ior

• ior(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  or

isEven

• isEven(): boolean

  Returns boolean

  Description

  check if value is even

ishln

• ishln(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  shift left

ishrn

• ishrn(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  shift right (unimplemented https://github.com/indutny/bn.js/blob/master/lib/bn.js#L2086)

isNeg

• isNeg(): boolean

  Returns boolean

  Description

  true if the number is negative

isOdd

• isOdd(): boolean

  Returns boolean

  Description

  check if value is odd

isqr

• isqr(): BN

  Returns BN

  Description

  square

isub

• isub(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  subtraction

isubn

• isubn(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  subtraction

isZero

• isZero(): boolean

  Returns boolean

  Description

  check if value is zero

iuand

• iuand(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  and

iuor

• iuor(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  or

iushln

• iushln(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  shift left

iushrn

• iushrn(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  shift right

iuxor

• iuxor(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  xor

ixor

• ixor(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  xor

lt

• lt(b: BN): boolean

  Parameters

  • b: BN

  Returns boolean

  Description

  a less than b

lte

• lte(b: BN): boolean

  Parameters

  • b: BN

  Returns boolean

  Description

  a less than or equals b

lten

• lten(b: number): boolean

  Parameters

  • b: number

  Returns boolean

  Description

  a less than or equals b

ltn

• ltn(b: number): boolean

  Parameters

  • b: number

  Returns boolean

  Description

  a less than b

maskn

• maskn(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  clear bits with indexes higher or equal to b

mod

• mod(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  reduct

modn

• modn(b: number): number

  Parameters

  • b: number

  Returns number

  Deprecated

  Description

  reduct

modrn

• modrn(b: number): number

  Parameters

  • b: number

  Returns number

  Description

  reduct

mul

• mul(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  multiply

muln

• muln(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  multiply

neg

• neg(): BN

  Returns BN

  Description

  negate sign

notn

• notn(w: number): BN

  Parameters

  • w: number

  Returns BN

  Description

  not (for the width specified by w)

or

• or(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  or

pow

• pow(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  raise a to the power of b

setn

• setn(b: number, value: boolean | 0 | 1): BN

  Parameters

  • b: number
  • value: boolean | 0 | 1

  Returns BN

  Description

  set specified bit to value

shln

• shln(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  shift left

shrn

• shrn(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  shift right

sqr

• sqr(): BN

  Returns BN

  Description

  square

sub

• sub(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  subtraction

subn

• subn(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  subtraction

testn

• testn(b: number): boolean

  Parameters

  • b: number

  Returns boolean

  Description

  test if specified bit is set

toArray

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

  Parameters

  • Optionalendian: Endianness
  • Optionallength: number

  Returns number[]

  Description

  convert to byte Array, and optionally zero pad to length, throwing if already exceeding

toArrayLike

• toArrayLike(
      ArrayType: BufferConstructor,
      endian?: Endianness,
      length?: number,
  ): Buffer

  Parameters

  • ArrayType: BufferConstructor
  • Optionalendian: Endianness
  • Optionallength: number

  Returns Buffer

  Description

  convert to an instance of type, which must behave like an Array

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

  Parameters

  • ArrayType: any[]
  • Optionalendian: Endianness
  • Optionallength: number

  Returns any[]

  Description

  convert to an instance of type, which must behave like an Array

toBuffer

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

  Parameters

  • Optionalendian: Endianness
  • Optionallength: 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: ReductionContext): RedBN

  Parameters

  • reductionContext: ReductionContext

  Returns RedBN

  Description

  Convert number to red

toString

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

  Parameters

  • Optionalbase: number | "hex"
  • Optionallength: number

  Returns string

  Description

  convert to base-string and pad with zeroes

toTwos

• toTwos(width: number): BN

  Parameters

  • width: number

  Returns BN

  Description

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

uand

• uand(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  and

ucmp

• ucmp(b: BN): -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

umod

• umod(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  reduct

uor

• uor(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  or

ushln

• ushln(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  shift left

ushrn

• ushrn(b: number): BN

  Parameters

  • b: number

  Returns BN

  Description

  shift right

uxor

• uxor(b: BN): BN

  Parameters

  • b: BN

  Returns BN

  Description

  xor

xor

• xor(b: BN): 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)

StaticisBN

• isBN(b: any): b is BN

  Parameters

  • b: any

  Returns b is BN

  Description

  returns true if the supplied object is a BN.js instance

Staticmax

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

  Parameters

  • left: BN
  • right: BN

  Returns BN

  Description

  returns the maximum of 2 BN instances.

Staticmin

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

  Parameters

  • left: BN
  • right: BN

  Returns BN

  Description

  returns the minimum of 2 BN instances.

Staticmont

• mont(num: BN): ReductionContext

  Parameters

  • num: BN

  Returns ReductionContext

  Description

  create a reduction context with the Montgomery trick.

Staticred

• red(reductionContext: BN | IPrimeName): ReductionContext

  Parameters

  • reductionContext: BN | IPrimeName

  Returns ReductionContext

  Description

  create a reduction context