Skip to content

api.entities.CorporateBallot.types

F-OBrien edited this page Aug 14, 2026 · 8 revisions

@polymeshassociation/polymesh-sdk / api/entities/CorporateBallot/types

api/entities/CorporateBallot/types

Enumerations

CorporateBallotStatus

Defined in: api/entities/CorporateBallot/types.ts:73

Enumeration Members

Active

Active: "Active"

Defined in: api/entities/CorporateBallot/types.ts:75

Closed

Closed: "Closed"

Defined in: api/entities/CorporateBallot/types.ts:76

Pending

Pending: "Pending"

Defined in: api/entities/CorporateBallot/types.ts:74

Interfaces

BallotMeta

Defined in: api/entities/CorporateBallot/types.ts:36

Properties

motions

motions: BallotMotion[]

Defined in: api/entities/CorporateBallot/types.ts:45

All the motions of the ballot, with their associated titles, choices, etc.

title

title: string

Defined in: api/entities/CorporateBallot/types.ts:40

Title of the ballot.


BallotMotion

Defined in: api/entities/CorporateBallot/types.ts:3

Properties

choices

choices: string[]

Defined in: api/entities/CorporateBallot/types.ts:18

Choices for the motion excluding abstain.

Note

Voting power not used is considered abstained.

infoLink

infoLink: string

Defined in: api/entities/CorporateBallot/types.ts:12

Link to more information about the motion.

title

title: string

Defined in: api/entities/CorporateBallot/types.ts:7

Title of the motion.


CorporateBallotDetails

Defined in: api/entities/CorporateBallot/types.ts:48

Properties

endDate

endDate: Date

Defined in: api/entities/CorporateBallot/types.ts:57

End date of the ballot.

meta

meta: BallotMeta

Defined in: api/entities/CorporateBallot/types.ts:62

Metadata for the ballot.

rcv

rcv: boolean

Defined in: api/entities/CorporateBallot/types.ts:70

Whether Ranked-Choice Voting (RCV) has been enabled.

Ranked-Choice Voting allows voters to select a fallback choice should their first preference fail to reach a certain threshold or, for example, be eliminated in the top-2 run-off.

startDate

startDate: Date

Defined in: api/entities/CorporateBallot/types.ts:52

Start date of the ballot.

Type Aliases

BallotVote

BallotVote = object

Defined in: api/entities/CorporateBallot/types.ts:21

Properties

fallback?

optional fallback?: BigNumber

Defined in: api/entities/CorporateBallot/types.ts:33

The fallback vote to be used if the choice is not found in the ballot.

Note

This is only allowed for RCV ballots.

Note

Must point to a choice in a motion (index of the choice in the motion choices array).

Note

Must not point to the same choice as the vote property (index != choiceIndex).

power

power: BigNumber

Defined in: api/entities/CorporateBallot/types.ts:25

The power of the vote.


ChoiceWithParticipation

ChoiceWithParticipation = object

Defined in: api/entities/CorporateBallot/types.ts:110

Properties

choice

choice: string

Defined in: api/entities/CorporateBallot/types.ts:114

The choice of the motion for which the votes are cast.

fallback?

optional fallback?: BigNumber

Defined in: api/entities/CorporateBallot/types.ts:124

The fallback choice for the vote.

power

power: BigNumber

Defined in: api/entities/CorporateBallot/types.ts:119

The power of the vote.


ChoiceWithVotes

ChoiceWithVotes = object

Defined in: api/entities/CorporateBallot/types.ts:79

Properties

choice

choice: string

Defined in: api/entities/CorporateBallot/types.ts:83

The choice of the motion for which the votes are cast.

votes

votes: BigNumber

Defined in: api/entities/CorporateBallot/types.ts:88

The number of votes for the choice.


CorporateBallotMetaWithResults

CorporateBallotMetaWithResults = Omit<BallotMeta, "motions"> & object

Defined in: api/entities/CorporateBallot/types.ts:103

Type Declaration

motions

motions: CorporateBallotMotionWithResults[]

The motions with their associated choices and votes.


CorporateBallotMotionWithParticipation

CorporateBallotMotionWithParticipation = Pick<BallotMotion, "title" | "infoLink"> & object

Defined in: api/entities/CorporateBallot/types.ts:127

Type Declaration

choices

choices: ChoiceWithParticipation[]

The choices with their associated votes and fallback choices.


CorporateBallotMotionWithResults

CorporateBallotMotionWithResults = Pick<BallotMotion, "title" | "infoLink"> & object

Defined in: api/entities/CorporateBallot/types.ts:91

Type Declaration

choices

choices: ChoiceWithVotes[]

The motion choices and their associated votes.

total

total: BigNumber

The total number of votes cast for the motion.


CorporateBallotWithParticipation

CorporateBallotWithParticipation = Omit<BallotMeta, "motions"> & object

Defined in: api/entities/CorporateBallot/types.ts:134

Type Declaration

motions

motions: CorporateBallotMotionWithParticipation[]

The motions with their associated choices and votes.

@polymeshassociation/polymesh-sdk

Modules

Types
- [Utils](../wiki/base.utils)

Clone this wiki locally