Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RedBN

Hierarchy

  • BN
    • RedBN

Index

Interfaces

Type aliases

Constructors

Methods

Type aliases

Static Endianness

Endianness: "le" | "be"

Static IPrimeName

IPrimeName: "k256" | "p224" | "p192" | "p25519"

Constructors

constructor

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

  • Parameters

    • number: number | string | number[] | Uint8Array | Buffer | BN
    • Optional base: number | "hex"
    • Optional endian: BN.Endianness

    Returns RedBN

  • Parameters

    • number: number | string | number[] | Uint8Array | Buffer | BN
    • Optional endian: BN.Endianness

    Returns RedBN

Methods

abs

  • abs(): BN

  • Returns BN

add

  • add(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

addn

  • addn(b: number): BN

  • Parameters

    • b: number

    Returns BN

and

  • and(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

andln

  • andln(b: number): BN

  • Parameters

    • b: number

    Returns BN

bincn

  • bincn(b: number): BN

  • Parameters

    • b: number

    Returns BN

bitLength

  • bitLength(): number

  • Returns number

byteLength

  • byteLength(): number

  • Returns number

clone

  • clone(): BN

  • Returns BN

cmp

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

  • Parameters

    • b: BN

    Returns -1 | 0 | 1

cmpn

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

  • Parameters

    • b: number

    Returns -1 | 0 | 1

div

  • div(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

divRound

  • divRound(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

divn

  • divn(b: number): BN

  • Parameters

    • b: number

    Returns BN

egcd

  • egcd(b: BN): object

  • Parameters

    • b: BN

    Returns object

    • a: BN
    • b: BN
    • gcd: BN

eq

  • eq(b: BN): boolean

  • Parameters

    • b: BN

    Returns boolean

eqn

  • eqn(b: number): boolean

  • Parameters

    • b: number

    Returns boolean

fromRed

  • fromRed(): BN

fromTwos

  • fromTwos(width: number): BN

  • Parameters

    • width: number

    Returns BN

gcd

  • gcd(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

gt

  • gt(b: BN): boolean

  • Parameters

    • b: BN

    Returns boolean

gte

  • gte(b: BN): boolean

  • Parameters

    • b: BN

    Returns boolean

gten

  • gten(b: number): boolean

  • Parameters

    • b: number

    Returns boolean

gtn

  • gtn(b: number): boolean

  • Parameters

    • b: number

    Returns boolean

iabs

  • iabs(): BN

  • Returns BN

iadd

  • iadd(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

iaddn

  • iaddn(b: number): BN

  • Parameters

    • b: number

    Returns BN

iand

  • iand(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

idivn

  • idivn(b: number): BN

  • Parameters

    • b: number

    Returns BN

imaskn

  • imaskn(b: number): BN

  • Parameters

    • b: number

    Returns BN

imul

  • imul(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

imuln

  • imuln(b: number): BN

  • Parameters

    • b: number

    Returns BN

ineg

  • ineg(): BN

  • Returns BN

inotn

  • inotn(w: number): BN

  • Parameters

    • w: number

    Returns BN

invm

  • invm(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

ior

  • ior(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

isEven

  • isEven(): boolean

  • Returns boolean

isNeg

  • isNeg(): boolean

  • Returns boolean

isOdd

  • isOdd(): boolean

  • Returns boolean

isZero

  • isZero(): boolean

  • Returns boolean

ishln

  • ishln(b: number): BN

  • Parameters

    • b: number

    Returns BN

ishrn

  • ishrn(b: number): BN

  • Parameters

    • b: number

    Returns BN

isqr

  • isqr(): BN

  • Returns BN

isub

  • isub(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

isubn

  • isubn(b: number): BN

  • Parameters

    • b: number

    Returns BN

iuand

  • iuand(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

iuor

  • iuor(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

iushln

  • iushln(b: number): BN

  • Parameters

    • b: number

    Returns BN

iushrn

  • iushrn(b: number): BN

  • Parameters

    • b: number

    Returns BN

iuxor

  • iuxor(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

ixor

  • ixor(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

lt

  • lt(b: BN): boolean

  • Parameters

    • b: BN

    Returns boolean

lte

  • lte(b: BN): boolean

  • Parameters

    • b: BN

    Returns boolean

lten

  • lten(b: number): boolean

  • Parameters

    • b: number

    Returns boolean

ltn

  • ltn(b: number): boolean

  • Parameters

    • b: number

    Returns boolean

maskn

  • maskn(b: number): BN

  • Parameters

    • b: number

    Returns BN

mod

  • mod(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

modn

  • modn(b: number): number

  • Parameters

    • b: number

    Returns number

mul

  • mul(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

muln

  • muln(b: number): BN

  • Parameters

    • b: number

    Returns BN

neg

  • neg(): BN

  • Returns BN

notn

  • notn(w: number): BN

  • Parameters

    • w: number

    Returns BN

or

  • or(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

pow

  • pow(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

redAdd

redInvm

redMul

redNeg

redSub

setn

  • setn(b: number): BN

  • Parameters

    • b: number

    Returns BN

shln

  • shln(b: number): BN

  • Parameters

    • b: number

    Returns BN

shrn

  • shrn(b: number): BN

  • Parameters

    • b: number

    Returns BN

sqr

  • sqr(): BN

  • Returns BN

sub

  • sub(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

subn

  • subn(b: number): BN

  • Parameters

    • b: number

    Returns BN

testn

  • testn(b: number): boolean

  • Parameters

    • b: number

    Returns boolean

toArray

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

  • Parameters

    • Optional endian: BN.Endianness
    • Optional length: number

    Returns number[]

toArrayLike

  • toArrayLike(ArrayType: object, endian: BN.Endianness, length: number): Buffer
  • toArrayLike(ArrayType: any[], endian: BN.Endianness, length: number): any[]

  • Parameters

    • ArrayType: object
      • constructor: function
        • new __type(str: string, encoding: string): Buffer
        • new __type(size: number): Buffer
        • new __type(array: Uint8Array): Buffer
        • new __type(arrayBuffer: ArrayBuffer): Buffer
        • new __type(array: any[]): Buffer
        • new __type(buffer: Buffer): Buffer

        • Parameters

          • str: string
          • Optional encoding: string

          Returns Buffer

        • Parameters

          • size: number

          Returns Buffer

        • Parameters

          • array: Uint8Array

          Returns Buffer

        • Parameters

          • arrayBuffer: ArrayBuffer

          Returns Buffer

        • Parameters

          • array: any[]

          Returns Buffer

        • Parameters

          • buffer: Buffer

          Returns Buffer

      • poolSize: number
      • prototype: Buffer
      • alloc: function
        • alloc(size: number, fill: string | Buffer | number, encoding: string): Buffer

        • Parameters

          • size: number
          • Optional fill: string | Buffer | number
          • Optional encoding: string

          Returns Buffer

      • allocUnsafe: function
        • allocUnsafe(size: number): Buffer

        • Parameters

          • size: number

          Returns Buffer

      • allocUnsafeSlow: function
        • allocUnsafeSlow(size: number): Buffer

        • Parameters

          • size: number

          Returns Buffer

      • byteLength: function
        • byteLength(string: string | Buffer | DataView | ArrayBuffer, encoding: string): number

        • Parameters

          • string: string | Buffer | DataView | ArrayBuffer
          • Optional encoding: string

          Returns number

      • compare: function
        • compare(buf1: Uint8Array, buf2: Uint8Array): number

        • Parameters

          • buf1: Uint8Array
          • buf2: Uint8Array

          Returns number

      • concat: function
        • concat(list: Uint8Array[], totalLength: number): Buffer

        • Parameters

          • list: Uint8Array[]
          • Optional totalLength: number

          Returns Buffer

      • from: function
        • from(arrayBuffer: ArrayBuffer, byteOffset: number, length: number): Buffer
        • from(data: any[] | string | Buffer | ArrayBuffer): Buffer
        • from(str: string, encoding: string): Buffer

        • Parameters

          • arrayBuffer: ArrayBuffer
          • Optional byteOffset: number
          • Optional length: number

          Returns Buffer

        • Parameters

          • data: any[] | string | Buffer | ArrayBuffer

          Returns Buffer

        • Parameters

          • str: string
          • Optional encoding: string

          Returns Buffer

      • isBuffer: function
        • isBuffer(obj: any): boolean

        • Parameters

          • obj: any

          Returns boolean

      • isEncoding: function
        • isEncoding(encoding: string): boolean

        • Parameters

          • encoding: string

          Returns boolean

    • Optional endian: BN.Endianness
    • Optional length: number

    Returns Buffer

  • Parameters

    • ArrayType: any[]
    • Optional endian: BN.Endianness
    • Optional length: number

    Returns any[]

toBuffer

  • toBuffer(endian: BN.Endianness, length: number): Buffer

  • Parameters

    • Optional endian: BN.Endianness
    • Optional length: number

    Returns Buffer

toJSON

  • toJSON(): string

  • Returns string

toNumber

  • toNumber(): number

  • Returns number

toRed

  • toRed(reductionContext: ReductionContext): RedBN

  • Parameters

    • reductionContext: ReductionContext

    Returns RedBN

toString

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

  • Parameters

    • Optional base: number | "hex"
    • Optional length: number

    Returns string

toTwos

  • toTwos(width: number): BN

  • Parameters

    • width: number

    Returns BN

uand

  • uand(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

ucmp

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

  • Parameters

    • b: BN

    Returns -1 | 0 | 1

umod

  • umod(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

uor

  • uor(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

ushln

  • ushln(b: number): BN

  • Parameters

    • b: number

    Returns BN

ushrn

  • ushrn(b: number): BN

  • Parameters

    • b: number

    Returns BN

uxor

  • uxor(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

xor

  • xor(b: BN): BN

  • Parameters

    • b: BN

    Returns BN

zeroBits

  • zeroBits(): number

  • Returns number

Static isBN

  • isBN(b: any): boolean

  • Parameters

    • b: any

    Returns boolean

Static max

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

  • Parameters

    • left: BN
    • right: BN

    Returns BN

Static min

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

  • Parameters

    • left: BN
    • right: BN

    Returns BN

Static mont

  • mont(num: BN): ReductionContext

  • Parameters

    • num: BN

    Returns ReductionContext

Static red

  • red(reductionContext: BN | BN.IPrimeName): ReductionContext

  • Parameters

    • reductionContext: BN | BN.IPrimeName

    Returns ReductionContext

Generated using TypeDoc