Class BN

Hierarchy

BN
- BN

Implements

BNInputOverrides
BNHiddenTypes
BNHelper
BNOverrides

Index

Constructors

constructor

Properties

MAX_U64 BN wordSize

Constructors

constructor

new BN(value?, base?, endian?): BN
Parameters
- Optionalvalue: null | BNInput
- Optionalbase: number | "hex"
- Optionalendian: Endianness
Returns BN
Overrides BnJs.constructor
- Defined in packages/math/src/bn.ts:47

Properties

MAX_U64

MAX_U64: string = '0xFFFFFFFFFFFFFFFF'

`Static`BN

BN: typeof BN

`Static`wordSize

wordSize: 26

Methods

abs

abs(): BN
Returns BN
Description
absolute value
Implementation of BNOverrides.abs
Overrides BnJs.abs
- Defined in packages/math/src/bn.ts:256

add

add(v): BN
Parameters
- v: BNInput
Returns BN
Description
addition
Implementation of BNInputOverrides.add
Overrides BnJs.add
- Defined in packages/math/src/bn.ts:194

addn

addn(b): BN
Parameters
- b: number
Returns BN
Description
addition
Inherited from BnJs.addn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:253

and

and(b): BN
Parameters
- b: BN
Returns BN
Description
and
Inherited from BnJs.and
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:384

andln

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

bincn

bincn(b): BN
Parameters
- b: number
Returns BN
Description
add 1 << b to the number
Inherited from BnJs.bincn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:488

bitLength

bitLength(): number
Returns number
Description
get number of bits occupied
Inherited from BnJs.bitLength
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:113

byteLength

byteLength(): number
Returns number
Description
return number of bytes occupied
Inherited from BnJs.byteLength
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:123

caller

caller(v, methodName): boolean | BN | CompareResult
Parameters
- v: BNInput
- methodName: keyof BNInputOverrides
Returns boolean | BN | CompareResult
Implementation of BNHelper.caller
- Defined in packages/math/src/bn.ts:270

clone

clone(): BN
Returns BN
Description
clone number
Overrides BnJs.clone
- Defined in packages/math/src/bn.ts:284

cmp

cmp(v): CompareResult
Parameters
- v: BNInput
Returns CompareResult
Description
compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result
Implementation of BNInputOverrides.cmp
Overrides BnJs.cmp
- Defined in packages/math/src/bn.ts:242

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
Inherited from BnJs.cmpn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:158

copy

copy(dest): void
Parameters
- dest: BN
Returns void
Description
Copy to dest number
Inherited from BnJs.copy
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:63

div

div(v): BN
Parameters
- v: BNInput
Returns BN
Description
divide
Implementation of BNInputOverrides.div
Overrides BnJs.div
- Defined in packages/math/src/bn.ts:206

divRound

divRound(v): BN
Parameters
- v: BNInput
Returns BN
Description
rounded division
Implementation of BNInputOverrides.divRound
Overrides BnJs.divRound
- Defined in packages/math/src/bn.ts:218

divmod

divmod(num, mode?, positive?): {
div: BN;
mod: BN;
}
Parameters
- num: BNInput
- Optionalmode: string
- Optionalpositive: boolean
Returns {
div: BN;
mod: BN;
}
- div: BN
- mod: BN
Description
division with remainder
Implementation of BNHiddenTypes.divmod
Overrides BnJs.divmod
- Defined in packages/math/src/bn.ts:304

divn

divn(b): BN
Parameters
- b: number
Returns BN
Description
divide
Inherited from BnJs.divn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:323

egcd

egcd(p): {
    a: BN;
    b: BN;
    gcd: BN;
}
Parameters
- p: BN
Returns {
    a: BN;
    b: BN;
    gcd: BN;
}
- a: BN
- b: BN
- gcd: BN
Description
Extended GCD results ({ a: ..., b: ..., gcd: ... })
Overrides BnJs.egcd
- Defined in packages/math/src/bn.ts:294

eq

eq(v): boolean
Parameters
- v: BNInput
Returns boolean
Description
a equals b
Implementation of BNInputOverrides.eq
Overrides BnJs.eq
- Defined in packages/math/src/bn.ts:238

eqn

eqn(b): boolean
Parameters
- b: number
Returns boolean
Description
a equals b
Inherited from BnJs.eqn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:208

format

format(options?): string
Parameters
- Optionaloptions: FormatConfig
Returns string
- Defined in packages/math/src/bn.ts:115

formatUnits

formatUnits(units?): string
Parameters
- units: number = DEFAULT_DECIMAL_UNITS
Returns string
- Defined in packages/math/src/bn.ts:177

fromTwos

fromTwos(width): BN
Parameters
- width: number
Returns BN
Description
convert from two's complement representation, where width is the bit width
Implementation of BNOverrides.fromTwos
Overrides BnJs.fromTwos
- Defined in packages/math/src/bn.ts:264

gcd

gcd(b): BN
Parameters
- b: BN
Returns BN
Description
GCD
Inherited from BnJs.gcd
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:503

gt

gt(v): boolean
Parameters
- v: BNInput
Returns boolean
Description
a greater than b
Implementation of BNInputOverrides.gt
Overrides BnJs.gt
- Defined in packages/math/src/bn.ts:230

gte

gte(v): boolean
Parameters
- v: BNInput
Returns boolean
Description
a greater than or equals b
Implementation of BNInputOverrides.gte
Overrides BnJs.gte
- Defined in packages/math/src/bn.ts:234

gten

gten(b): boolean
Parameters
- b: number
Returns boolean
Description
a greater than or equals b
Inherited from BnJs.gten
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:198

gtn

gtn(b): boolean
Parameters
- b: number
Returns boolean
Description
a greater than b
Inherited from BnJs.gtn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:188

iabs

iabs(): BN
Returns BN
Description
absolute value
Inherited from BnJs.iabs
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:238

iadd

iadd(b): BN
Parameters
- b: BN
Returns BN
Description
addition
Inherited from BnJs.iadd
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:248

iaddn

iaddn(b): BN
Parameters
- b: number
Returns BN
Description
addition
Inherited from BnJs.iaddn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:258

iand

iand(b): BN
Parameters
- b: BN
Returns BN
Description
and
Inherited from BnJs.iand
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:389

idivn

idivn(b): BN
Parameters
- b: number
Returns BN
Description
divide
Inherited from BnJs.idivn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:328

imaskn

imaskn(b): BN
Parameters
- b: number
Returns BN
Description
clear bits with indexes higher or equal to b
Inherited from BnJs.imaskn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:484

imul

imul(b): BN
Parameters
- b: BN
Returns BN
Description
multiply
Inherited from BnJs.imul
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:288

imuln

imuln(b): BN
Parameters
- b: number
Returns BN
Description
multiply
Inherited from BnJs.imuln
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:298

ineg

ineg(): BN
Returns BN
Description
negate sign
Inherited from BnJs.ineg
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:228

inotn

inotn(w): BN
Parameters
- w: number
Returns BN
Description
not (for the width specified by w)
Inherited from BnJs.inotn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:498

invm

invm(b): BN
Parameters
- b: BN
Returns BN
Description
inverse a modulo b
Inherited from BnJs.invm
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:513

ior

ior(b): BN
Parameters
- b: BN
Returns BN
Description
or
Inherited from BnJs.ior
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:369

isEven

isEven(): boolean
Returns boolean
Description
check if value is even
Inherited from BnJs.isEven
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:133

isNeg

isNeg(): boolean
Returns boolean
Description
true if the number is negative
Inherited from BnJs.isNeg
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:128

isOdd

isOdd(): boolean
Returns boolean
Description
check if value is odd
Inherited from BnJs.isOdd
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:138

isZero

isZero(): boolean
Returns boolean
Description
check if value is zero
Inherited from BnJs.isZero
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:143

ishln

ishln(b): BN
Parameters
- b: number
Returns BN
Description
shift left
Inherited from BnJs.ishln
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:439

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)
Inherited from BnJs.ishrn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:459

isqr

isqr(): BN
Returns BN
Description
square
Inherited from BnJs.isqr
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:308

isub

isub(b): BN
Parameters
- b: BN
Returns BN
Description
subtraction
Inherited from BnJs.isub
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:268

isubn

isubn(b): BN
Parameters
- b: number
Returns BN
Description
subtraction
Inherited from BnJs.isubn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:278

iuand

iuand(b): BN
Parameters
- b: BN
Returns BN
Description
and
Inherited from BnJs.iuand
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:399

iuor

iuor(b): BN
Parameters
- b: BN
Returns BN
Description
or
Inherited from BnJs.iuor
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:379

iushln

iushln(b): BN
Parameters
- b: number
Returns BN
Description
shift left
Inherited from BnJs.iushln
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:449

iushrn

iushrn(b): BN
Parameters
- b: number
Returns BN
Description
shift right
Inherited from BnJs.iushrn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:469

iuxor

iuxor(b): BN
Parameters
- b: BN
Returns BN
Description
xor
Inherited from BnJs.iuxor
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:424

ixor

ixor(b): BN
Parameters
- b: BN
Returns BN
Description
xor
Inherited from BnJs.ixor
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:414

lt

lt(v): boolean
Parameters
- v: BNInput
Returns boolean
Description
a less than b
Implementation of BNInputOverrides.lt
Overrides BnJs.lt
- Defined in packages/math/src/bn.ts:222

lte

lte(v): boolean
Parameters
- v: BNInput
Returns boolean
Description
a less than or equals b
Implementation of BNInputOverrides.lte
Overrides BnJs.lte
- Defined in packages/math/src/bn.ts:226

lten

lten(b): boolean
Parameters
- b: number
Returns boolean
Description
a less than or equals b
Inherited from BnJs.lten
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:178

ltn

ltn(b): boolean
Parameters
- b: number
Returns boolean
Description
a less than b
Inherited from BnJs.ltn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:168

maskn

maskn(b): BN
Parameters
- b: number
Returns BN
Description
clear bits with indexes higher or equal to b
Inherited from BnJs.maskn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:479

max

max(num): BN
Parameters
- num: BNInput
Returns BN
- Defined in packages/math/src/bn.ts:317

maxU64

maxU64(): BN
Returns BN
- Defined in packages/math/src/bn.ts:313

mod

mod(v): BN
Parameters
- v: BNInput
Returns BN
Description
reduct
Implementation of BNInputOverrides.mod
Overrides BnJs.mod
- Defined in packages/math/src/bn.ts:214

modn

modn(b): number
Parameters
- b: number
Returns number
Deprecated
Description
reduct
Inherited from BnJs.modn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:349

modrn

modrn(b): number
Parameters
- b: number
Returns number
Description
reduct
Inherited from BnJs.modrn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:354

mul

mul(v): BN
Parameters
- v: BNInput
Returns BN
Description
multiply
Implementation of BNInputOverrides.mul
Overrides BnJs.mul
- Defined in packages/math/src/bn.ts:210

mulTo

mulTo(num, out): BN
Parameters
- num: BN
- out: BN
Returns BN
Implementation of BNHiddenTypes.mulTo
- Defined in packages/math/src/bn.ts:288

muln

muln(b): BN
Parameters
- b: number
Returns BN
Description
multiply
Inherited from BnJs.muln
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:293

neg

neg(): BN
Returns BN
Description
negate sign
Implementation of BNOverrides.neg
Overrides BnJs.neg
- Defined in packages/math/src/bn.ts:252

normalizeZeroToOne

normalizeZeroToOne(): BN
Returns BN
- Defined in packages/math/src/bn.ts:321

notn

notn(w): BN
Parameters
- w: number
Returns BN
Description
not (for the width specified by w)
Inherited from BnJs.notn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:493

or

or(b): BN
Parameters
- b: BN
Returns BN
Description
or
Inherited from BnJs.or
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:364

pow

pow(v): BN
Parameters
- v: BNInput
Returns BN
Description
raise a to the power of b
Implementation of BNInputOverrides.pow
Overrides BnJs.pow
- Defined in packages/math/src/bn.ts:198

setn

setn(b, value): BN
Parameters
- b: number
- value: boolean | 0 | 1
Returns BN
Description
set specified bit to value
Inherited from BnJs.setn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:429

shln

shln(b): BN
Parameters
- b: number
Returns BN
Description
shift left
Inherited from BnJs.shln
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:434

shrn

shrn(b): BN
Parameters
- b: number
Returns BN
Description
shift right
Inherited from BnJs.shrn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:454

sqr

sqr(): BN
Returns BN
Description
square
Implementation of BNOverrides.sqr
Overrides BnJs.sqr
- Defined in packages/math/src/bn.ts:248

sub

sub(v): BN
Parameters
- v: BNInput
Returns BN
Description
subtraction
Implementation of BNInputOverrides.sub
Overrides BnJs.sub
- Defined in packages/math/src/bn.ts:202

subn

subn(b): BN
Parameters
- b: number
Returns BN
Description
subtraction
Inherited from BnJs.subn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:273

testn

testn(b): boolean
Parameters
- b: number
Returns boolean
Description
test if specified bit is set
Inherited from BnJs.testn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:474

toArray

toArray(endian?, length?): number[]
Parameters
- Optionalendian: Endianness
- Optionallength: number
Returns number[]
Description
convert to byte Array, and optionally zero pad to length, throwing if already exceeding
Inherited from BnJs.toArray
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:88

toArrayLike

toArrayLike(ArrayType, endian?, length?): Buffer<ArrayBufferLike>
Parameters
- ArrayType: BufferConstructor
- Optionalendian: Endianness
- Optionallength: number
Returns Buffer<ArrayBufferLike>
Description
convert to an instance of type, which must behave like an Array
Inherited from BnJs.toArrayLike
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:93
toArrayLike(ArrayType, endian?, length?): any[]
Parameters
- ArrayType: any[]
- Optionalendian: Endianness
- Optionallength: number
Returns any[]
Inherited from BnJs.toArrayLike
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:99

toBuffer

toBuffer(endian?, length?): Buffer<ArrayBufferLike>
Parameters
- Optionalendian: Endianness
- Optionallength: number
Returns Buffer<ArrayBufferLike>
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 BnJs.toBuffer
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:108

toBytes

toBytes(bytesPadding?): Uint8Array<ArrayBufferLike>
Parameters
- OptionalbytesPadding: number
Returns Uint8Array<ArrayBufferLike>
Implementation of BNHelper.toBytes
- Defined in packages/math/src/bn.ts:99

toHex

toHex(bytesPadding?): string
Parameters
- OptionalbytesPadding: number
Returns string
Implementation of BNHelper.toHex
- Defined in packages/math/src/bn.ts:82

toJSON

toJSON(): string
Returns string
Description
convert to JSON compatible hex string (alias of toString(16))
Implementation of BNHelper.toJSON
Overrides BnJs.toJSON
- Defined in packages/math/src/bn.ts:107

toNumber

toNumber(): number
Returns number
Description
convert to Javascript Number (limited to 53 bits)
Inherited from BnJs.toNumber
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:78

toRed

toRed(reductionContext): RedBN
Parameters
- reductionContext: ReductionContext
Returns RedBN
Description
Convert number to red
Inherited from BnJs.toRed
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:518

toString

toString(base?, length?): string
Parameters
- Optionalbase: number | "hex"
- Optionallength: number
Returns string
Description
convert to base-string and pad with zeroes
Overrides BnJs.toString
- Defined in packages/math/src/bn.ts:72

toTwos

toTwos(width): BN
Parameters
- width: number
Returns BN
Description
convert to two's complement representation, where width is bit width
Implementation of BNOverrides.toTwos
Overrides BnJs.toTwos
- Defined in packages/math/src/bn.ts:260

uand

uand(b): BN
Parameters
- b: BN
Returns BN
Description
and
Inherited from BnJs.uand
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:394

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
Inherited from BnJs.ucmp
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:153

umod

umod(b): BN
Parameters
- b: BN
Returns BN
Description
reduct
Inherited from BnJs.umod
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:343

uor

uor(b): BN
Parameters
- b: BN
Returns BN
Description
or
Inherited from BnJs.uor
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:374

ushln

ushln(b): BN
Parameters
- b: number
Returns BN
Description
shift left
Inherited from BnJs.ushln
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:444

ushrn

ushrn(b): BN
Parameters
- b: number
Returns BN
Description
shift right
Inherited from BnJs.ushrn
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:464

uxor

uxor(b): BN
Parameters
- b: BN
Returns BN
Description
xor
Inherited from BnJs.uxor
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:419

valueOf

valueOf(): string
Returns the primitive value of the specified object.

Returns string
- Defined in packages/math/src/bn.ts:111

xor

xor(b): BN
Parameters
- b: BN
Returns BN
Description
xor
Inherited from BnJs.xor
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:409

zeroBits

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

`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
Inherited from BnJs.isBN
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:48

`Static`max

max(left, right): BN
Parameters
- left: BN
- right: BN
Returns BN
Description
returns the maximum of 2 BN instances.
Inherited from BnJs.max
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:53

`Static`min

min(left, right): BN
Parameters
- left: BN
- right: BN
Returns BN
Description
returns the minimum of 2 BN instances.
Inherited from BnJs.min
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:58

`Static`mont

mont(num): ReductionContext
Parameters
- num: BN
Returns ReductionContext
Description
create a reduction context with the Montgomery trick.
Inherited from BnJs.mont
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:43

`Static`red

red(reductionContext): ReductionContext
Parameters
- reductionContext: BN | IPrimeName
Returns ReductionContext
Description
create a reduction context
Inherited from BnJs.red
- Defined in node_modules/.pnpm/@types+bn.js@5.1.6/node_modules/@types/bn.js/index.d.ts:38

Class BN

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BN

Properties

MAX_U64

StaticBN

StaticwordSize

Methods

abs

Returns BN

Description

add

Parameters

Returns BN

Description

addn

Parameters

Returns BN

Description

and

Parameters

Returns BN

Description

andln

Parameters

Returns BN

Description

bincn

Parameters

Returns BN

Description

bitLength

Returns number

Description

byteLength

Returns number

Description

caller

Parameters

Returns boolean | BN | CompareResult

clone

Returns BN

Description

cmp

Parameters

Returns CompareResult

Description

cmpn

Parameters

Returns -1 | 0 | 1

Description

copy

Parameters

Returns void

Description

div

Parameters

Returns BN

Description

divRound

Parameters

Returns BN

Description

divmod

Parameters

Returns { div: BN; mod: BN; }

div: BN

mod: BN

Description

divn

Parameters

Returns BN

`Static`BN

`Static`wordSize

Returns {
div: BN;
mod: BN;
}

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