Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Numberu64

Some amount of tokens Copied from token-swap, for packing instruction buffer correctly

Hierarchy

  • BN
    • Numberu64

Index

Constructors

Properties

Methods

Constructors

constructor

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

  • Parameters

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

    Returns Numberu64

  • Parameters

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

    Returns Numberu64

Properties

Static BN

BN: typeof BN

Static wordSize

wordSize: 26

Methods

abs

  • abs(): BN
  • description

    absolute value

    Returns BN

add

  • add(b: BN): BN
  • description

    addition

    Parameters

    • b: BN

    Returns BN

addn

  • addn(b: number): BN
  • description

    addition

    Parameters

    • b: number

    Returns BN

and

  • and(b: BN): BN
  • description

    and

    Parameters

    • b: BN

    Returns BN

andln

  • andln(b: number): BN
  • description

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

    Parameters

    • b: number

    Returns BN

bincn

  • bincn(b: number): BN
  • description

    add 1 << b to the number

    Parameters

    • b: number

    Returns BN

bitLength

  • bitLength(): number
  • description

    get number of bits occupied

    Returns number

byteLength

  • byteLength(): number
  • description

    return number of bytes occupied

    Returns number

clone

  • clone(): BN
  • description

    clone number

    Returns BN

cmp

  • cmp(b: BN): 0 | 1 | -1
  • 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
  • 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
  • description

    divide

    Parameters

    • b: BN

    Returns BN

divRound

  • divRound(b: BN): BN
  • description

    rounded division

    Parameters

    • b: BN

    Returns BN

divn

  • divn(b: number): BN
  • description

    divide

    Parameters

    • b: number

    Returns BN

egcd

  • egcd(b: BN): { a: BN; b: BN; gcd: BN }
  • 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
  • description

    a equals b

    Parameters

    • b: BN

    Returns boolean

eqn

  • eqn(b: number): boolean
  • description

    a equals b

    Parameters

    • b: number

    Returns boolean

fromTwos

  • fromTwos(width: number): BN
  • description

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

    Parameters

    • width: number

    Returns BN

gcd

  • gcd(b: BN): BN
  • description

    GCD

    Parameters

    • b: BN

    Returns BN

gt

  • gt(b: BN): boolean
  • description

    a greater than b

    Parameters

    • b: BN

    Returns boolean

gte

  • gte(b: BN): boolean
  • description

    a greater than or equals b

    Parameters

    • b: BN

    Returns boolean

gten

  • gten(b: number): boolean
  • description

    a greater than or equals b

    Parameters

    • b: number

    Returns boolean

gtn

  • gtn(b: number): boolean
  • description

    a greater than b

    Parameters

    • b: number

    Returns boolean

iabs

  • iabs(): BN
  • description

    absolute value

    Returns BN

iadd

  • iadd(b: BN): BN
  • description

    addition

    Parameters

    • b: BN

    Returns BN

iaddn

  • iaddn(b: number): BN
  • description

    addition

    Parameters

    • b: number

    Returns BN

iand

  • iand(b: BN): BN
  • description

    and

    Parameters

    • b: BN

    Returns BN

idivn

  • idivn(b: number): BN
  • description

    divide

    Parameters

    • b: number

    Returns BN

imaskn

  • imaskn(b: number): BN
  • description

    clear bits with indexes higher or equal to b

    Parameters

    • b: number

    Returns BN

imul

  • imul(b: BN): BN
  • description

    multiply

    Parameters

    • b: BN

    Returns BN

imuln

  • imuln(b: number): BN
  • description

    multiply

    Parameters

    • b: number

    Returns BN

ineg

  • ineg(): BN
  • description

    negate sign

    Returns BN

inotn

  • inotn(w: number): BN
  • description

    not (for the width specified by w)

    Parameters

    • w: number

    Returns BN

invm

  • invm(b: BN): BN
  • description

    inverse a modulo b

    Parameters

    • b: BN

    Returns BN

ior

  • ior(b: BN): BN
  • description

    or

    Parameters

    • b: BN

    Returns BN

isEven

  • isEven(): boolean
  • description

    check if value is even

    Returns boolean

isNeg

  • isNeg(): boolean
  • description

    true if the number is negative

    Returns boolean

isOdd

  • isOdd(): boolean
  • description

    check if value is odd

    Returns boolean

isZero

  • isZero(): boolean
  • description

    check if value is zero

    Returns boolean

ishln

  • ishln(b: number): BN
  • description

    shift left

    Parameters

    • b: number

    Returns BN

ishrn

  • ishrn(b: number): BN

isqr

  • isqr(): BN
  • description

    square

    Returns BN

isub

  • isub(b: BN): BN
  • description

    subtraction

    Parameters

    • b: BN

    Returns BN

isubn

  • isubn(b: number): BN
  • description

    subtraction

    Parameters

    • b: number

    Returns BN

iuand

  • iuand(b: BN): BN
  • description

    and

    Parameters

    • b: BN

    Returns BN

iuor

  • iuor(b: BN): BN
  • description

    or

    Parameters

    • b: BN

    Returns BN

iushln

  • iushln(b: number): BN
  • description

    shift left

    Parameters

    • b: number

    Returns BN

iushrn

  • iushrn(b: number): BN
  • description

    shift right

    Parameters

    • b: number

    Returns BN

iuxor

  • iuxor(b: BN): BN
  • description

    xor

    Parameters

    • b: BN

    Returns BN

ixor

  • ixor(b: BN): BN
  • description

    xor

    Parameters

    • b: BN

    Returns BN

lt

  • lt(b: BN): boolean
  • description

    a less than b

    Parameters

    • b: BN

    Returns boolean

lte

  • lte(b: BN): boolean
  • description

    a less than or equals b

    Parameters

    • b: BN

    Returns boolean

lten

  • lten(b: number): boolean
  • description

    a less than or equals b

    Parameters

    • b: number

    Returns boolean

ltn

  • ltn(b: number): boolean
  • description

    a less than b

    Parameters

    • b: number

    Returns boolean

maskn

  • maskn(b: number): BN
  • description

    clear bits with indexes higher or equal to b

    Parameters

    • b: number

    Returns BN

mod

  • mod(b: BN): BN
  • description

    reduct

    Parameters

    • b: BN

    Returns BN

modn

  • modn(b: number): number
  • deprecated
    description

    reduct

    Parameters

    • b: number

    Returns number

modrn

  • modrn(b: number): number
  • description

    reduct

    Parameters

    • b: number

    Returns number

mul

  • mul(b: BN): BN
  • description

    multiply

    Parameters

    • b: BN

    Returns BN

muln

  • muln(b: number): BN
  • description

    multiply

    Parameters

    • b: number

    Returns BN

neg

  • neg(): BN
  • description

    negate sign

    Returns BN

notn

  • notn(w: number): BN
  • description

    not (for the width specified by w)

    Parameters

    • w: number

    Returns BN

or

  • or(b: BN): BN
  • description

    or

    Parameters

    • b: BN

    Returns BN

pow

  • pow(b: BN): BN
  • description

    raise a to the power of b

    Parameters

    • b: BN

    Returns BN

satSub

  • Saturating sub

    Parameters

    Returns Numberu64

setn

  • setn(b: number): BN
  • description

    set specified bit to 1

    Parameters

    • b: number

    Returns BN

shln

  • shln(b: number): BN
  • description

    shift left

    Parameters

    • b: number

    Returns BN

shrn

  • shrn(b: number): BN
  • description

    shift right

    Parameters

    • b: number

    Returns BN

sqr

  • sqr(): BN
  • description

    square

    Returns BN

sub

  • sub(b: BN): BN
  • description

    subtraction

    Parameters

    • b: BN

    Returns BN

subn

  • subn(b: number): BN
  • description

    subtraction

    Parameters

    • b: number

    Returns BN

testn

  • testn(b: number): boolean
  • description

    test if specified bit is set

    Parameters

    • b: number

    Returns boolean

toArray

  • toArray(endian?: Endianness, length?: number): number[]
  • 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[]
  • description

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

    Parameters

    • ArrayType: BufferConstructor
    • Optional endian: Endianness
    • Optional length: number

    Returns Buffer

  • Parameters

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

    Returns any[]

toBuffer

  • toBuffer(): Buffer

  • Convert to Buffer representation

    Returns Buffer

toJSON

  • toJSON(): string
  • description

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

    Returns string

toNumber

  • toNumber(): number
  • description

    convert to Javascript Number (limited to 53 bits)

    Returns number

toRed

  • toRed(reductionContext: ReductionContext): RedBN
  • description

    Convert number to red

    Parameters

    • reductionContext: ReductionContext

    Returns RedBN

toString

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

    convert to base-string and pad with zeroes

    Parameters

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

    Returns string

toTwos

  • toTwos(width: number): BN
  • description

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

    Parameters

    • width: number

    Returns BN

uand

  • uand(b: BN): BN
  • description

    and

    Parameters

    • b: BN

    Returns BN

ucmp

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

    reduct

    Parameters

    • b: BN

    Returns BN

uor

  • uor(b: BN): BN
  • description

    or

    Parameters

    • b: BN

    Returns BN

ushln

  • ushln(b: number): BN
  • description

    shift left

    Parameters

    • b: number

    Returns BN

ushrn

  • ushrn(b: number): BN
  • description

    shift right

    Parameters

    • b: number

    Returns BN

uxor

  • uxor(b: BN): BN
  • description

    xor

    Parameters

    • b: BN

    Returns BN

xor

  • xor(b: BN): BN
  • description

    xor

    Parameters

    • b: BN

    Returns BN

zeroBits

  • zeroBits(): number
  • description

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

    Returns number

Static cloneFromBN

  • Creates a new Numberu64 with the same value as an existing BN new Numberu64(bn) doesnt work, only copies the reference and doesnt override toBuffer(), so any BNs with buffer length < 8's this.toBuffer() will return short buffer that cant be serialized to TransactionInstruction

    Parameters

    • bn: BN

    Returns Numberu64

Static fromBuffer

  • Construct a Numberu64 from Buffer representation

    Parameters

    • buffer: Buffer

    Returns Numberu64

Static isBN

  • isBN(b: any): b is BN
  • 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
  • description

    returns the maximum of 2 BN instances.

    Parameters

    • left: BN
    • right: BN

    Returns BN

Static min

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

    returns the minimum of 2 BN instances.

    Parameters

    • left: BN
    • right: BN

    Returns BN

Static mont

  • mont(num: BN): ReductionContext
  • description

    create a reduction context with the Montgomery trick.

    Parameters

    • num: BN

    Returns ReductionContext

Static red

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

    create a reduction context

    Parameters

    • reductionContext: BN | IPrimeName

    Returns ReductionContext

Generated using TypeDoc