name: VoteIndex

description: Voting index, implemented as a U32

Hierarchy

↳ U32

↳ VoteIndex

Implements

• Codec

Constructors

constructor

⊕ new VoteIndex(value?: AnyNumber): VoteIndex

Inherited from U32.constructor

Overrides UInt.constructor

Defined in U32.ts:14

Parameters:

Returns: VoteIndex

Accessors

encodedLength

getencodedLength(): number

Inherited from UInt.encodedLength

Defined in codec/UInt.ts:57

description: The length of the value when encoded as a Uint8Array

Returns: number

Methods

abs

▸ abs(): BN

Inherited from BN.abs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:254

description: absolute value

Returns: BN

add

▸ add(b: BN): BN

Inherited from BN.add

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:264

description: addition

Parameters:

Returns: BN

addn

▸ addn(b: number): BN

Inherited from BN.addn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:274

description: addition

Parameters:

Returns: BN

and

▸ and(b: BN): BN

Inherited from BN.and

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:395

description: and

Parameters:

Returns: BN

andln

▸ andln(b: number): BN

Inherited from BN.andln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:415

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

Parameters:

Returns: BN

bincn

▸ bincn(b: number): BN

Inherited from BN.bincn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:499

description: add 1 << b to the number

Parameters:

Returns: BN

bitLength

▸ bitLength(): UIntBitLength

Inherited from UInt.bitLength

Overrides BN.bitLength

Defined in codec/UInt.ts:64

description: Returns the number of bits in the value

Returns: UIntBitLength

byteLength

▸ byteLength(): number

Inherited from BN.byteLength

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:144

description: return number of bytes occupied

Returns: number

clone

▸ clone(): BN

Inherited from BN.clone

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:89

description: clone number

Returns: BN

cmp

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

Inherited from BN.cmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:169

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Returns: -1 | 0 | 1

cmpn

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

Inherited from BN.cmpn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:179

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Returns: -1 | 0 | 1

div

▸ div(b: BN): BN

Inherited from BN.div

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:339

description: divide

Parameters:

Returns: BN

divRound

▸ divRound(b: BN): BN

Inherited from BN.divRound

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:370

description: rounded division

Parameters:

Returns: BN

divn

▸ divn(b: number): BN

Inherited from BN.divn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:344

description: divide

Parameters:

Returns: BN

egcd

▸ egcd(b: BN): object

Inherited from BN.egcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:519

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

Parameters:

Returns: object

eq

▸ eq(b: BN): boolean

Inherited from BN.eq

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:224

description: a equals b

Parameters:

Returns: boolean

eqn

▸ eqn(b: number): boolean

Inherited from BN.eqn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:229

description: a equals b

Parameters:

Returns: boolean

fromTwos

▸ fromTwos(width: number): BN

Inherited from BN.fromTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:239

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

Parameters:

Returns: BN

gcd

▸ gcd(b: BN): BN

Inherited from BN.gcd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:514

description: GCD

Parameters:

Returns: BN

gt

▸ gt(b: BN): boolean

Inherited from BN.gt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:204

description: a greater than b

Parameters:

Returns: boolean

gte

▸ gte(b: BN): boolean

Inherited from BN.gte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:214

description: a greater than or equals b

Parameters:

Returns: boolean

gten

▸ gten(b: number): boolean

Inherited from BN.gten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:219

description: a greater than or equals b

Parameters:

Returns: boolean

gtn

▸ gtn(b: number): boolean

Inherited from BN.gtn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:209

description: a greater than b

Parameters:

Returns: boolean

iabs

▸ iabs(): BN

Inherited from BN.iabs

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:259

description: absolute value

Returns: BN

iadd

▸ iadd(b: BN): BN

Inherited from BN.iadd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:269

description: addition

Parameters:

Returns: BN

iaddn

▸ iaddn(b: number): BN

Inherited from BN.iaddn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:279

description: addition

Parameters:

Returns: BN

iand

▸ iand(b: BN): BN

Inherited from BN.iand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:400

description: and

Parameters:

Returns: BN

idivn

▸ idivn(b: number): BN

Inherited from BN.idivn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:349

description: divide

Parameters:

Returns: BN

imaskn

▸ imaskn(b: number): BN

Inherited from BN.imaskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:495

description: clear bits with indexes higher or equal to b

Parameters:

Returns: BN

imul

▸ imul(b: BN): BN

Inherited from BN.imul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:309

description: multiply

Parameters:

Returns: BN

imuln

▸ imuln(b: number): BN

Inherited from BN.imuln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:319

description: multiply

Parameters:

Returns: BN

ineg

▸ ineg(): BN

Inherited from BN.ineg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:249

description: negate sign

Returns: BN

inotn

▸ inotn(w: number): BN

Inherited from BN.inotn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:509

description: not (for the width specified by w)

Parameters:

Returns: BN

invm

▸ invm(b: BN): BN

Inherited from BN.invm

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:524

description: inverse a modulo b

Parameters:

Returns: BN

ior

▸ ior(b: BN): BN

Inherited from BN.ior

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:380

description: or

Parameters:

Returns: BN

isEven

▸ isEven(): boolean

Inherited from BN.isEven

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:154

description: check if value is even

Returns: boolean

isNeg

▸ isNeg(): boolean

Inherited from BN.isNeg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:149

description: true if the number is negative

Returns: boolean

isOdd

▸ isOdd(): boolean

Inherited from BN.isOdd

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:159

description: check if value is odd

Returns: boolean

isZero

▸ isZero(): boolean

Inherited from BN.isZero

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:164

description: check if value is zero

Returns: boolean

ishln

▸ ishln(b: number): BN

Inherited from BN.ishln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:450

description: shift left

Parameters:

Returns: BN

ishrn

▸ ishrn(b: number): BN

Inherited from BN.ishrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:470

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

Parameters:

Returns: BN

isqr

▸ isqr(): BN

Inherited from BN.isqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:329

description: square

Returns: BN

isub

▸ isub(b: BN): BN

Inherited from BN.isub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:289

description: subtraction

Parameters:

Returns: BN

isubn

▸ isubn(b: number): BN

Inherited from BN.isubn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:299

description: subtraction

Parameters:

Returns: BN

iuand

▸ iuand(b: BN): BN

Inherited from BN.iuand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:410

description: and

Parameters:

Returns: BN

iuor

▸ iuor(b: BN): BN

Inherited from BN.iuor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:390

description: or

Parameters:

Returns: BN

iushln

▸ iushln(b: number): BN

Inherited from BN.iushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:460

description: shift left

Parameters:

Returns: BN

iushrn

▸ iushrn(b: number): BN

Inherited from BN.iushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:480

description: shift right

Parameters:

Returns: BN

iuxor

▸ iuxor(b: BN): BN

Inherited from BN.iuxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:435

description: xor

Parameters:

Returns: BN

ixor

▸ ixor(b: BN): BN

Inherited from BN.ixor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:425

description: xor

Parameters:

Returns: BN

lt

▸ lt(b: BN): boolean

Inherited from BN.lt

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:184

description: a less than b

Parameters:

Returns: boolean

lte

▸ lte(b: BN): boolean

Inherited from BN.lte

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:194

description: a less than or equals b

Parameters:

Returns: boolean

lten

▸ lten(b: number): boolean

Inherited from BN.lten

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:199

description: a less than or equals b

Parameters:

Returns: boolean

ltn

▸ ltn(b: number): boolean

Inherited from BN.ltn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:189

description: a less than b

Parameters:

Returns: boolean

maskn

▸ maskn(b: number): BN

Inherited from BN.maskn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:490

description: clear bits with indexes higher or equal to b

Parameters:

Returns: BN

mod

▸ mod(b: BN): BN

Inherited from BN.mod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:354

description: reduct

Parameters:

Returns: BN

modn

▸ modn(b: number): number

Inherited from BN.modn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:365

see: API consistency https://github.com/indutny/bn.js/pull/130

description: reduct

Parameters:

Returns: number

mul

▸ mul(b: BN): BN

Inherited from BN.mul

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:304

description: multiply

Parameters:

Returns: BN

muln

▸ muln(b: number): BN

Inherited from BN.muln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:314

description: multiply

Parameters:

Returns: BN

neg

▸ neg(): BN

Inherited from BN.neg

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:244

description: negate sign

Returns: BN

notn

▸ notn(w: number): BN

Inherited from BN.notn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:504

description: not (for the width specified by w)

Parameters:

Returns: BN

or

▸ or(b: BN): BN

Inherited from BN.or

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:375

description: or

Parameters:

Returns: BN

pow

▸ pow(b: BN): BN

Inherited from BN.pow

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:334

description: raise a to the power of b

Parameters:

Returns: BN

setn

▸ setn(b: number): BN

Inherited from BN.setn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:440

description: set specified bit to 1

Parameters:

Returns: BN

shln

▸ shln(b: number): BN

Inherited from BN.shln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:445

description: shift left

Parameters:

Returns: BN

shrn

▸ shrn(b: number): BN

Inherited from BN.shrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:465

description: shift right

Parameters:

Returns: BN

sqr

▸ sqr(): BN

Inherited from BN.sqr

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:324

description: square

Returns: BN

sub

▸ sub(b: BN): BN

Inherited from BN.sub

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:284

description: subtraction

Parameters:

Returns: BN

subn

▸ subn(b: number): BN

Inherited from BN.subn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:294

description: subtraction

Parameters:

Returns: BN

testn

▸ testn(b: number): boolean

Inherited from BN.testn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:485

description: test if specified bit is set

Parameters:

Returns: boolean

toArray

▸ toArray(endian?: Endianness, length?: undefined | number): number[]

Inherited from BN.toArray

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:109

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

Parameters:

Returns: number[]

toArrayLike

▸ toArrayLike(ArrayType: object, endian?: Endianness, length?: undefined | number): Buffer

▸ toArrayLike(ArrayType: any[], endian?: Endianness, length?: undefined | number): any[]

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:114

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

Parameters:

Returns: Buffer

Inherited from BN.toArrayLike

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:120

Parameters:

Returns: any[]

toBn

▸ toBn(): BN

Inherited from UInt.toBn

Defined in codec/UInt.ts:71

description: Returns the BN representation of the number. (Compatibility)

Returns: BN

toBuffer

▸ toBuffer(endian?: Endianness, length?: undefined | number): Buffer

Inherited from BN.toBuffer

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:129

description: convert to Node.js Buffer (if available). For compatibility with browserify and similar tools, use this instead: a.toArrayLike(Buffer, endian, length)

Parameters:

Returns: Buffer

toHex

▸ toHex(): string

Implementation of Codec.toHex

Inherited from UInt.toHex

Defined in codec/UInt.ts:78

description: Returns a hex string representation of the value

Returns: string

toJSON

▸ toJSON(): any

Implementation of Codec.toJSON

Inherited from UInt.toJSON

Overrides BN.toJSON

Defined in codec/UInt.ts:85

description: Converts the Object to JSON, typically used for RPC transfers

Returns: any

toNumber

▸ toNumber(): number

Inherited from BN.toNumber

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:99

description: convert to Javascript Number (limited to 53 bits)

Returns: number

toRed

▸ toRed(reductionContext: ReductionContext): RedBN

Inherited from BN.toRed

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:84

description: Convert number to red

Parameters:

Returns: RedBN

toString

▸ toString(base?: undefined | number): string

Inherited from UInt.toString

Overrides BN.toString

Defined in codec/UInt.ts:95

description: Returns the string representation of the value

Parameters:

Returns: string

toTwos

▸ toTwos(width: number): BN

Inherited from BN.toTwos

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:234

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

Parameters:

Returns: BN

toU8a

▸ toU8a(isBare?: undefined | false | true): Uint8Array

Implementation of Codec.toU8a

Inherited from UInt.toU8a

Defined in codec/UInt.ts:104

description: Encodes the value as a Uint8Array as per the parity-codec specifications

Parameters:

Returns: Uint8Array

uand

▸ uand(b: BN): BN

Inherited from BN.uand

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:405

description: and

Parameters:

Returns: BN

ucmp

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

Inherited from BN.ucmp

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:174

description: compare numbers and return -1 (a < b), 0 (a == b), or 1 (a > b) depending on the comparison result

Parameters:

Returns: -1 | 0 | 1

umod

▸ umod(b: BN): BN

Inherited from BN.umod

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:359

description: reduct

Parameters:

Returns: BN

uor

▸ uor(b: BN): BN

Inherited from BN.uor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:385

description: or

Parameters:

Returns: BN

ushln

▸ ushln(b: number): BN

Inherited from BN.ushln

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:455

description: shift left

Parameters:

Returns: BN

ushrn

▸ ushrn(b: number): BN

Inherited from BN.ushrn

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:475

description: shift right

Parameters:

Returns: BN

uxor

▸ uxor(b: BN): BN

Inherited from BN.uxor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:430

description: xor

Parameters:

Returns: BN

xor

▸ xor(b: BN): BN

Inherited from BN.xor

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:420

description: xor

Parameters:

Returns: BN

zeroBits

▸ zeroBits(): number

Inherited from BN.zeroBits

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:139

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

Returns: number

<Static> decodeUInt

▸ decodeUInt(value: AnyNumber, bitLength: UIntBitLength): string

Inherited from UInt.decodeUInt

Defined in codec/UInt.ts:38

Parameters:

Returns: string

<Static> isBN

▸ isBN(b: any): boolean

Inherited from BN.isBN

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:69

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

Parameters:

Returns: boolean

<Static> max

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

Inherited from BN.max

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:74

description: returns the maximum of 2 BN instances.

Parameters:

Returns: BN

<Static> min

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

Inherited from BN.min

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:79

description: returns the minimum of 2 BN instances.

Parameters:

Returns: BN

<Static> mont

▸ mont(num: BN): ReductionContext

Inherited from BN.mont

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:64

description: create a reduction context with the Montgomery trick.

Parameters:

Returns: ReductionContext

<Static> red

▸ red(reductionContext: BN | IPrimeName): ReductionContext

Inherited from BN.red

Defined in /home/travis/build/polkadot-js/api/node_modules/@types/bn.js/index.d.ts:59

description: create a reduction context

Parameters:

Returns: ReductionContext