Class: CorporateBallot

Defined in: src/api/entities/CorporateBallot/index.ts:69

Represents a Ballot

Extends

• CorporateActionBase

Properties

asset

asset: FungibleAsset

Defined in: src/api/entities/CorporateActionBase/index.ts:82

Asset affected by this Corporate Action

Inherited from

CorporateActionBase.asset

---

declarationDate

declarationDate: Date

Defined in: src/api/entities/CorporateActionBase/index.ts:87

date at which the Corporate Action was created

Inherited from

CorporateActionBase.declarationDate

---

defaultTaxWithholding

defaultTaxWithholding: BigNumber

Defined in: src/api/entities/CorporateActionBase/index.ts:103

default percentage (0-100) of tax withholding for this Corporate Action

Inherited from

CorporateActionBase.defaultTaxWithholding

---

description

description: string

Defined in: src/api/entities/CorporateActionBase/index.ts:92

brief text description of the Corporate Action

Inherited from

CorporateActionBase.description

---

id

id: BigNumber

Defined in: src/api/entities/CorporateActionBase/index.ts:77

internal Corporate Action ID

Inherited from

CorporateActionBase.id

---

targets

targets: CorporateActionTargets

Defined in: src/api/entities/CorporateActionBase/index.ts:98

Asset Holder Identities related to this Corporate action. If the treatment is Exclude, the Identities in the array will not be targeted by the Action, Identities not in the array will be targeted, and vice versa

Inherited from

CorporateActionBase.targets

---

taxWithholdings

taxWithholdings: TaxWithholding[]

Defined in: src/api/entities/CorporateActionBase/index.ts:109

percentage (0-100) of tax withholding per Identity. Any Identity not present in this array uses the default tax withholding percentage

Inherited from

CorporateActionBase.taxWithholdings

---

uuid

uuid: string

Defined in: src/api/entities/Entity.ts:46

Inherited from

CorporateActionBase.uuid

Methods

checkpoint()

checkpoint(): Promise<null | Checkpoint | CheckpointSchedule>

Defined in: src/api/entities/CorporateActionBase/index.ts:188

Retrieve the Checkpoint associated with this Corporate Action. If the Checkpoint is scheduled and has not been created yet, the corresponding CheckpointSchedule is returned instead. A null value means the Corporate Action was created without an associated Checkpoint

Returns

Promise<null | Checkpoint | CheckpointSchedule>

Inherited from

CorporateActionBase.checkpoint

---

details()

details(): Promise<CorporateBallotDetails>

Defined in: src/api/entities/CorporateBallot/index.ts:136

Retrieve details associated with this Ballot

Returns

Promise<CorporateBallotDetails>

Throws

if the Ballot does not exist

---

exists()

exists(): Promise<boolean>

Defined in: src/api/entities/CorporateBallot/index.ts:115

Determine whether this Ballot exists on chain

Returns

Promise<boolean>

Overrides

CorporateActionBase.exists

---

isEqual()

isEqual(entity: Entity<unknown, unknown>): boolean

Defined in: src/api/entities/Entity.ts:61

Determine whether this Entity is the same as another one

Parameters

Parameter	Type
entity	Entity<unknown, unknown>

Returns

boolean

Inherited from

CorporateActionBase.isEqual

---

linkDocuments()

linkDocuments(args: LinkCaDocsParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

Defined in: src/api/entities/CorporateActionBase/index.ts:159

Link a list of documents to this corporate action

Parameters

Parameter	Type
args	LinkCaDocsParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

any previous links are removed in favor of the new list

Note

this method is of type ProcedureMethod, which means you can call linkDocuments.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Inherited from

CorporateActionBase.linkDocuments

---

modifyCheckpoint()

modifyCheckpoint(args: object, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

Defined in: src/api/entities/CorporateBallot/index.ts:326

Modify the Corporate Ballot's Record Date

Parameters

Parameter	Type
args	{ checkpoint: InputCaCheckpoint; }
args.checkpoint	InputCaCheckpoint
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

this method is of type ProcedureMethod, which means you can call modifyCheckpoint.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

Overrides

CorporateActionBase.modifyCheckpoint

---

remove()

remove(opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

Defined in: src/api/entities/CorporateBallot/index.ts:308

Remove the Ballot

Parameters

Parameter	Type
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Note

deletes the corporate action with the associated ballot if ballot has not started

Throws

if ballot has already started

Throws

if ballot is not found

Note

this method is of type NoArgsProcedureMethod, which means you can call remove.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

results()

results(): Promise<CorporateBallotMetaWithResults>

Defined in: src/api/entities/CorporateBallot/index.ts:173

Retrieve the results of the Ballot

Returns

Promise<CorporateBallotMetaWithResults>

Throws

if the Ballot does not exist

---

status()

status(): Promise<CorporateBallotStatus>

Defined in: src/api/entities/CorporateBallot/index.ts:147

Return the status of the Ballot

Returns

Promise<CorporateBallotStatus>

Throws

if the Ballot does not exist

---

toHuman()

toHuman(): HumanReadable

Defined in: src/api/entities/CorporateActionBase/index.ts:274

Return the Corporate Action's static data

Returns

HumanReadable

Inherited from

CorporateActionBase.toHuman

---

vote()

vote(args: CastBallotVoteParams, opts?: ProcedureOpts): Promise<GenericPolymeshTransaction<void, void>>

Defined in: src/api/entities/CorporateBallot/index.ts:321

Cast a vote on the Ballot

Parameters

Parameter	Type
args	CastBallotVoteParams
opts?	ProcedureOpts

Returns

Promise<GenericPolymeshTransaction<void, void>>

Throws

if the Ballot does not exist

Throws

if the Ballot voting is not active

Throws

if the number of votes does not match the sum of all choices of all motions

Throws

if fallback votes are provided for a non-RCV Ballot

Throws

if vote does not point to the correct choice in motion

Throws

if the fallback vote is the same as the choice

Throws

if the fallback vote is not pointing to a choice in the motion

Note

this method is of type ProcedureMethod, which means you can call vote.checkAuthorization on it to see whether the signing Account and Identity have the required roles and permissions to run it

---

votesByIdentity()

votesByIdentity(did: string | Identity): Promise<CorporateBallotWithParticipation>

Defined in: src/api/entities/CorporateBallot/index.ts:234

Retrieve the participation of the Ballot

Parameters

Parameter	Type
did	string | Identity

Returns

Promise<CorporateBallotWithParticipation>

Throws

if the Ballot does not exist

---

generateUuid()

static generateUuid<Identifiers>(identifiers: Identifiers): string

Defined in: src/api/entities/Entity.ts:14

Generate the Entity's UUID from its identifying properties

Type Parameters

Type Parameter
Identifiers

Parameters

Parameter	Type	Description
identifiers	Identifiers

Returns

string

Inherited from

CorporateActionBase.generateUuid

---

unserialize()

static unserialize<Identifiers>(serialized: string): Identifiers

Defined in: src/api/entities/Entity.ts:23

Unserialize a UUID into its Unique Identifiers

Type Parameters

Type Parameter
Identifiers

Parameters

Parameter	Type	Description
serialized	string	UUID to unserialize

Returns

Identifiers

Inherited from

CorporateActionBase.unserialize