Class: VoteProof<T>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1445

VoteProof represents a vote cast for a voting challenge.

Extends#

• BaseNumberTypeClass<VoteProof<T>>

Type Parameters#

T#

T extends NumberType

Implements#

• iVoteProof<T>

Constructors#

Constructor#

new VoteProof<T>(voteProof): VoteProof<T>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1451

Parameters#

voteProof#

iVoteProof<T>

Returns#

VoteProof<T>

Overrides#

BaseNumberTypeClass.constructor

Properties#

proposalId#

proposalId: string

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1446

The proposal ID this vote is for.

Implementation of#

iVoteProof.proposalId

---

votedAt?#

optional votedAt?: T

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1449

Timestamp (unix ms) when this vote was cast. Set automatically by the chain.

Implementation of#

iVoteProof.votedAt

---

voter#

voter: string

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1447

The address of the voter casting the vote.

Implementation of#

iVoteProof.voter

---

yesWeight#

yesWeight: T

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1448

The percentage weight (0-100) allocated to "yes" vote. The remaining percentage (100 - yesWeight) is allocated to "no" vote. Example: yesWeight=70 means 70% yes, 30% no.

Implementation of#

iVoteProof.yesWeight

Methods#

clone()#

clone(): VoteProof

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:151

Deep copies the object and returns a new instance.

Returns#

VoteProof

Inherited from#

BaseNumberTypeClass.clone

---

convert()#

convert<U>(convertFunction, options?): VoteProof<U>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1463

Converts the object to a different NumberType equivalent.

Type Parameters#

U#

U extends NumberType

Parameters#

convertFunction#

(item) => U

options?#

ConvertOptions

Returns#

VoteProof<U>

Overrides#

BaseNumberTypeClass.convert

---

equals()#

equals<U>(other, normalizeNumberTypes?): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:147

Compares this object's fields to another object's fields for equality. Equality is determined by comparing the JSON representations of the objects.

If normalizeNumberTypes is true, then all number types will be compared as strings (i.e. "1n" === "1" === 1). Else, they will be compared as their native types (i.e. 1n !== 1 !== "1").

Type Parameters#

U#

U extends CustomType<U>

Parameters#

other#

CustomType<U> | null | undefined

normalizeNumberTypes?#

boolean

Returns#

boolean

Inherited from#

BaseNumberTypeClass.equals

---

getNumberFieldNames()#

getNumberFieldNames(): string[]

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1459

Internal helper method to convert the number fields of the object to a different NumberType equivalent.

Returns#

string[]

Overrides#

BaseNumberTypeClass.getNumberFieldNames

---

hasNumberFields()#

hasNumberFields(): boolean

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:161

Checks if the object has number fields.

Returns#

boolean

Inherited from#

BaseNumberTypeClass.hasNumberFields

---

toJson()#

toJson(): JsonObject

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:139

Converts the object to a JSON object with all primitive types.

Returns#

JsonObject

Inherited from#

BaseNumberTypeClass.toJson

---

toJsonString()#

toJsonString(): string

Defined in: packages/bitbadgesjs-sdk/src/common/base.ts:143

Converts the object to a JSON string.

Returns#

string

Inherited from#

BaseNumberTypeClass.toJsonString

---

fromProto()#

static fromProto<U>(item, convertFunction): VoteProof<U>

Defined in: packages/bitbadgesjs-sdk/src/core/misc.ts:1467

Type Parameters#

U#

U extends NumberType

Parameters#

item#

VoteProof

convertFunction#

(item) => U

Returns#

VoteProof<U>