@celo/contractkit › "wrappers/Governance" › GovernanceWrapper
Class: GovernanceWrapper
Contract managing voting for governance proposals.
Hierarchy
- BaseWrapper‹Governance›
↳ GovernanceWrapper
Index
Constructors
Properties
- approveHotfix
- concurrentProposals
- dequeueFrequency
- dequeueProposalsIfReady
- eventTypes
- events
- executeHotfix
- getApprover
- getProposalMetadata
- getProposalTransaction
- getQueue
- getRefundedDeposits
- getUpvoteRecord
- getUpvotes
- getVotes
- hotfixWhitelistValidatorTally
- isApproved
- isDequeuedProposalExpired
- isHotfixPassing
- isHotfixWhitelistedBy
- isProposalPassing
- isQueued
- isQueuedProposalExpired
- isVoting
- lastDequeue
- methodIds
- minDeposit
- minQuorumSize
- prepareHotfix
- proposalExists
- propose
- queueExpiry
- revokeVotes
- whitelistHotfix
- withdraw
Accessors
Methods
- approve
- execute
- getApprovalStatus
- getApproverMultisig
- getConfig
- getConstitution
- getDequeue
- getHotfixRecord
- getHumanReadableConfig
- getHumanReadableProposalMetadata
- getParticipationParameters
- getPastEvents
- getProposal
- getProposalRecord
- getProposalStage
- getSupport
- getTransactionConstitution
- getVoteRecord
- getVoteRecords
- getVoteValue
- getVoteWeight
- getVoter
- humanReadableProposalSchedule
- isUpvoting
- isVotingReferendum
- proposalSchedule
- revokeUpvote
- sortedQueue
- stageDurations
- upvote
- version
- vote
Constructors
constructor
+ new GovernanceWrapper(kit
: ContractKit, contract
: Governance): GovernanceWrapper
Inherited from BaseWrapper.constructor
Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:30
Parameters:
Name | Type |
---|---|
kit |
ContractKit |
contract |
Governance |
Returns: GovernanceWrapper
Properties
approveHotfix
• approveHotfix: function = proxySend(this.kit, this.contract.methods.approveHotfix, tupleParser(bufferToHex))
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:890
Marks the given hotfix approved by sender
.
param
keccak256 hash of hotfix's associated abi encoded transactions
notice
Only the approver
address will succeed in sending this transaction
Type declaration:
▸ (...args
: InputArgs): CeloTransactionObject‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
concurrentProposals
• concurrentProposals: function = proxyCall( this.contract.methods.concurrentProposals, undefined, valueToBigNumber )
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:156
Querying number of possible concurrent proposals.
returns
Current number of possible concurrent proposals.
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
dequeueFrequency
• dequeueFrequency: function = proxyCall(this.contract.methods.dequeueFrequency, undefined, valueToBigNumber)
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:170
Query proposal dequeue frequency.
returns
Current proposal dequeue frequency in seconds.
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
dequeueProposalsIfReady
• dequeueProposalsIfReady: function = proxySend(this.kit, this.contract.methods.dequeueProposalsIfReady)
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:659
Dequeues any queued proposals if dequeueFrequency
seconds have elapsed since the last dequeue
Type declaration:
▸ (...args
: InputArgs): CeloTransactionObject‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
eventTypes
• eventTypes: EventsEnum‹T› = Object.keys(this.events).reduce
Inherited from BaseWrapper.eventTypes
Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:61
events
• events: Governance["events"] = this.contract.events
Inherited from BaseWrapper.events
Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:59
executeHotfix
• executeHotfix: function = proxySend(this.kit, this.contract.methods.executeHotfix, hotfixToParams)
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:904
Executes a given sequence of transactions if the corresponding hash is prepared and approved.
param
Governance hotfix proposal
param
Secret which guarantees uniqueness of hash
notice
keccak256 hash of abi encoded transactions computed on-chain
Type declaration:
▸ (...args
: InputArgs): CeloTransactionObject‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
getApprover
• getApprover: function = proxyCall(this.contract.methods.approver)
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:382
Returns the approver address for proposals and hotfixes.
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
getProposalMetadata
• getProposalMetadata: function = proxyCall( this.contract.methods.getProposal, tupleParser(valueToString), (res) => ({ proposer: res[0], deposit: valueToBigNumber(res[1]), timestamp: valueToBigNumber(res[2]), transactionCount: valueToInt(res[3]), descriptionURL: res[4], }) )
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:310
Returns the metadata associated with a given proposal.
param
Governance proposal UUID
Type declaration:
▸ (proposalID
: BigNumber.Value): Promise‹ProposalMetadata›
Parameters:
Name | Type |
---|---|
proposalID |
BigNumber.Value |
getProposalTransaction
• getProposalTransaction: function = proxyCall( this.contract.methods.getProposalTransaction, tupleParser(valueToString, valueToString), (res) => ({ value: res[0], to: res[1], input: solidityBytesToString(res[2]), }) )
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:339
Returns the transaction at the given index associated with a given proposal.
param
Governance proposal UUID
param
Transaction index
Type declaration:
▸ (proposalID
: BigNumber.Value, txIndex
: number): Promise‹ProposalTransaction›
Parameters:
Name | Type |
---|---|
proposalID |
BigNumber.Value |
txIndex |
number |
getQueue
• getQueue: function = proxyCall(this.contract.methods.getQueue, undefined, (arraysObject) =>
zip
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:605
Returns the proposal queue as list of upvote records.
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
getRefundedDeposits
• getRefundedDeposits: function = proxyCall( this.contract.methods.refundedDeposits, tupleParser(stringIdentity), valueToBigNumber )
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:572
Returns the value of proposal deposits that have been refunded.
param
Governance proposer address.
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
getUpvoteRecord
• getUpvoteRecord: function = proxyCall( this.contract.methods.getUpvoteRecord, tupleParser(identity), (o) => ({ proposalID: valueToBigNumber(o[0]), upvotes: valueToBigNumber(o[1]), }) )
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:523
Returns the current upvoted governance proposal ID and applied vote weight (zeroes if none).
param
Address of upvoter
Type declaration:
▸ (upvoter
: Address): Promise‹UpvoteRecord›
Parameters:
Name | Type |
---|---|
upvoter |
Address |
getUpvotes
• getUpvotes: function = proxyCall( this.contract.methods.getUpvotes, tupleParser(valueToString), valueToBigNumber )
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:582
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
getVotes
• getVotes: function = proxyCall( this.contract.methods.getVoteTotals, tupleParser(valueToString), (res): Votes => ({ [VoteValue.Yes]: valueToBigNumber(res[0]), [VoteValue.No]: valueToBigNumber(res[1]), [VoteValue.Abstain]: valueToBigNumber(res[2]), }) )
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:592
Returns the yes, no, and abstain votes applied to a given proposal.
param
Governance proposal UUID
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
hotfixWhitelistValidatorTally
• hotfixWhitelistValidatorTally: function = proxyCall( this.contract.methods.hotfixWhitelistValidatorTally, tupleParser(bufferToHex) )
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:870
Returns the number of validators that whitelisted the hotfix
param
keccak256 hash of hotfix's associated abi encoded transactions
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
isApproved
• isApproved: function = proxyCall( this.contract.methods.isApproved, tupleParser(valueToString) )
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:356
Returns whether a given proposal is approved.
param
Governance proposal UUID
Type declaration:
▸ (proposalID
: BigNumber.Value): Promise‹boolean›
Parameters:
Name | Type |
---|---|
proposalID |
BigNumber.Value |
isDequeuedProposalExpired
• isDequeuedProposalExpired: function = proxyCall( this.contract.methods.isDequeuedProposalExpired, tupleParser(valueToString) )
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:365
Returns whether a dequeued proposal is expired.
param
Governance proposal UUID
Type declaration:
▸ (proposalID
: BigNumber.Value): Promise‹boolean›
Parameters:
Name | Type |
---|---|
proposalID |
BigNumber.Value |
isHotfixPassing
• isHotfixPassing: function = proxyCall(this.contract.methods.isHotfixPassing, tupleParser(bufferToHex))
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:855
Returns whether a given hotfix can be passed.
param
keccak256 hash of hotfix's associated abi encoded transactions
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
isHotfixWhitelistedBy
• isHotfixWhitelistedBy: function = proxyCall( this.contract.methods.isHotfixWhitelistedBy, tupleParser(bufferToHex, (s: Address) => identity
(s)) )Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:846
Returns whether a given hotfix has been whitelisted by a given address.
param
keccak256 hash of hotfix's associated abi encoded transactions
param
address of whitelister
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
isProposalPassing
• isProposalPassing: function = proxyCall(this.contract.methods.isProposalPassing, tupleParser(valueToString))
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:496
Returns whether a given proposal is passing relative to the constitution's threshold.
param
Governance proposal UUID
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
isQueued
• isQueued: function = proxyCall(this.contract.methods.isQueued, tupleParser(valueToString))
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:566
Returns whether a given proposal is queued.
param
Governance proposal UUID
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
isQueuedProposalExpired
• isQueuedProposalExpired: function = proxyCall( this.contract.methods.isQueuedProposalExpired, tupleParser(valueToString) )
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:374
Returns whether a dequeued proposal is expired.
param
Governance proposal UUID
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
isVoting
• isVoting: function = proxyCall(this.contract.methods.isVoting)
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:257
Returns whether or not a particular account is voting on proposals.
param
The address of the account.
returns
Whether or not the account is voting on proposals.
Type declaration:
▸ (account
: string): Promise‹boolean›
Parameters:
Name | Type |
---|---|
account |
string |
lastDequeue
• lastDequeue: function = proxyCall(this.contract.methods.lastDequeue, undefined, valueToBigNumber)
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:165
Query time of last proposal dequeue
returns
Time of last dequeue
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
methodIds
• methodIds: Record‹keyof T["methods"], string› = Object.keys(this.contract.methods).reduce
acc[method] =
methodABI === undefined
? '0x'
: this.kit.connection.getAbiCoder().encodeFunctionSignature(methodABI)
return acc
},
{} as any
)
Inherited from BaseWrapper.methodIds
Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:66
minDeposit
• minDeposit: function = proxyCall(this.contract.methods.minDeposit, undefined, valueToBigNumber)
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:175
Query minimum deposit required to make a proposal.
returns
Current minimum deposit.
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
minQuorumSize
• minQuorumSize: function = proxyCall( this.contract.methods.minQuorumSizeInCurrentSet, undefined, valueToBigNumber )
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:860
Returns the number of validators required to reach a Byzantine quorum
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
prepareHotfix
• prepareHotfix: function = proxySend(this.kit, this.contract.methods.prepareHotfix, tupleParser(bufferToHex))
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:896
Marks the given hotfix prepared for current epoch if quorum of validators have whitelisted it.
param
keccak256 hash of hotfix's associated abi encoded transactions
Type declaration:
▸ (...args
: InputArgs): CeloTransactionObject‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
proposalExists
• proposalExists: function = proxyCall( this.contract.methods.proposalExists, tupleParser(valueToString) )
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:514
Returns whether a governance proposal exists with the given ID.
param
Governance proposal UUID
Type declaration:
▸ (proposalID
: BigNumber.Value): Promise‹boolean›
Parameters:
Name | Type |
---|---|
proposalID |
BigNumber.Value |
propose
• propose: function = proxySend(this.kit, this.contract.methods.propose, proposalToParams)
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:508
Submits a new governance proposal.
param
Governance proposal
param
A URL where further information about the proposal can be viewed
Type declaration:
▸ (...args
: InputArgs): CeloTransactionObject‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
queueExpiry
• queueExpiry: function = proxyCall(this.contract.methods.queueExpiry, undefined, valueToBigNumber)
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:180
Query queue expiry parameter.
returns
The number of seconds a proposal can stay in the queue before expiring.
Type declaration:
▸ (...args
: InputArgs): Promise‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
revokeVotes
• revokeVotes: function = proxySend(this.kit, this.contract.methods.revokeVotes)
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:803
Type declaration:
▸ (...args
: InputArgs): CeloTransactionObject‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
whitelistHotfix
• whitelistHotfix: function = proxySend( this.kit, this.contract.methods.whitelistHotfix, tupleParser(bufferToHex) )
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:879
Marks the given hotfix whitelisted by sender
.
param
keccak256 hash of hotfix's associated abi encoded transactions
Type declaration:
▸ (...args
: InputArgs): CeloTransactionObject‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
withdraw
• withdraw: function = proxySend(this.kit, this.contract.methods.withdraw)
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:501
Withdraws refunded proposal deposits.
Type declaration:
▸ (...args
: InputArgs): CeloTransactionObject‹Output›
Parameters:
Name | Type |
---|---|
...args |
InputArgs |
Accessors
address
• get address(): string
Inherited from BaseWrapper.address
Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:35
Contract address
Returns: string
Methods
approve
▸ approve(proposalID
: BigNumber.Value): Promise‹CeloTransactionObject‹boolean››
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:781
Approves given proposal, allowing it to later move to referendum
.
notice
Only the approver
address will succeed in sending this transaction
Parameters:
Name | Type | Description |
---|---|---|
proposalID |
BigNumber.Value | Governance proposal UUID |
Returns: Promise‹CeloTransactionObject‹boolean››
execute
▸ execute(proposalID
: BigNumber.Value): Promise‹CeloTransactionObject‹boolean››
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:820
Executes a given proposal's associated transactions.
Parameters:
Name | Type | Description |
---|---|---|
proposalID |
BigNumber.Value | Governance proposal UUID |
Returns: Promise‹CeloTransactionObject‹boolean››
getApprovalStatus
▸ getApprovalStatus(proposalID
: BigNumber.Value): Promise‹ApprovalStatus›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:448
Parameters:
Name | Type |
---|---|
proposalID |
BigNumber.Value |
Returns: Promise‹ApprovalStatus›
getApproverMultisig
▸ getApproverMultisig(): Promise‹MultiSigWrapper‹››
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:387
Returns the approver multisig contract for proposals and hotfixes.
Returns: Promise‹MultiSigWrapper‹››
getConfig
▸ getConfig(): Promise‹GovernanceConfig›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:262
Returns current configuration parameters.
Returns: Promise‹GovernanceConfig›
getConstitution
▸ getConstitution(proposal
: Proposal): Promise‹BigNumber›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:211
Returns the required ratio of yes:no votes needed to exceed in order to pass the proposal.
Parameters:
Name | Type | Description |
---|---|---|
proposal |
Proposal | Proposal to determine the constitution for running. |
Returns: Promise‹BigNumber›
getDequeue
▸ getDequeue(filterZeroes
: boolean): Promise‹BigNumber‹›[]›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:619
Returns the (existing) proposal dequeue as list of proposal IDs.
Parameters:
Name | Type | Default |
---|---|---|
filterZeroes |
boolean | false |
Returns: Promise‹BigNumber‹›[]›
getHotfixRecord
▸ getHotfixRecord(hash
: Buffer): Promise‹HotfixRecord›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:832
Returns approved, executed, and prepared status associated with a given hotfix.
Parameters:
Name | Type | Description |
---|---|---|
hash |
Buffer | keccak256 hash of hotfix's associated abi encoded transactions |
Returns: Promise‹HotfixRecord›
getHumanReadableConfig
▸ getHumanReadableConfig(): Promise‹object›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:285
dev
Returns human readable configuration of the governance contract
Returns: Promise‹object›
GovernanceConfig object
getHumanReadableProposalMetadata
▸ getHumanReadableProposalMetadata(proposalID
: BigNumber.Value): Promise‹object›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:326
Returns the human readable metadata associated with a given proposal.
Parameters:
Name | Type | Description |
---|---|---|
proposalID |
BigNumber.Value | Governance proposal UUID |
Returns: Promise‹object›
getParticipationParameters
▸ getParticipationParameters(): Promise‹ParticipationParameters›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:223
Returns the participation parameters.
Returns: Promise‹ParticipationParameters›
The participation parameters.
getPastEvents
▸ getPastEvents(event
: Events‹Governance›, options
: PastEventOptions): Promise‹EventLog[]›
Inherited from BaseWrapper.getPastEvents
Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:55
Contract getPastEvents
Parameters:
Name | Type |
---|---|
event |
Events‹Governance› |
options |
PastEventOptions |
Returns: Promise‹EventLog[]›
getProposal
▸ getProposal(proposalID
: BigNumber.Value): Promise‹Proposal›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:442
Returns the proposal associated with a given id.
Parameters:
Name | Type | Description |
---|---|---|
proposalID |
BigNumber.Value | Governance proposal UUID |
Returns: Promise‹Proposal›
getProposalRecord
▸ getProposalRecord(proposalID
: BigNumber.Value): Promise‹ProposalRecord›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:465
Returns the stage, metadata, upvotes, votes, and transactions associated with a given proposal.
Parameters:
Name | Type | Description |
---|---|---|
proposalID |
BigNumber.Value | Governance proposal UUID |
Returns: Promise‹ProposalRecord›
getProposalStage
▸ getProposalStage(proposalID
: BigNumber.Value): Promise‹ProposalStage›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:390
Parameters:
Name | Type |
---|---|
proposalID |
BigNumber.Value |
Returns: Promise‹ProposalStage›
getSupport
▸ getSupport(proposalID
: BigNumber.Value): Promise‹object›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:234
Parameters:
Name | Type |
---|---|
proposalID |
BigNumber.Value |
Returns: Promise‹object›
getTransactionConstitution
▸ getTransactionConstitution(tx
: ProposalTransaction): Promise‹BigNumber›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:198
Returns the required ratio of yes:no votes needed to exceed in order to pass the proposal transaction.
Parameters:
Name | Type | Description |
---|---|---|
tx |
ProposalTransaction | Transaction to determine the constitution for running. |
Returns: Promise‹BigNumber›
getVoteRecord
▸ getVoteRecord(voter
: Address, proposalID
: BigNumber.Value): Promise‹VoteRecord | null›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:546
Returns the corresponding vote record
Parameters:
Name | Type | Description |
---|---|---|
voter |
Address | Address of voter |
proposalID |
BigNumber.Value | Governance proposal UUID |
Returns: Promise‹VoteRecord | null›
getVoteRecords
▸ getVoteRecords(voter
: Address): Promise‹VoteRecord[]›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:629
Parameters:
Name | Type |
---|---|
voter |
Address |
Returns: Promise‹VoteRecord[]›
getVoteValue
▸ getVoteValue(proposalID
: BigNumber.Value, voter
: Address): Promise‹VoteValue›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:810
Returns voter
's vote choice on a given proposal.
Parameters:
Name | Type | Description |
---|---|---|
proposalID |
BigNumber.Value | Governance proposal UUID |
voter |
Address | Address of voter |
Returns: Promise‹VoteValue›
getVoteWeight
▸ getVoteWeight(voter
: Address): Promise‹BigNumber‹››
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:665
Returns the number of votes that will be applied to a proposal for a given voter.
Parameters:
Name | Type | Description |
---|---|---|
voter |
Address | Address of voter |
Returns: Promise‹BigNumber‹››
getVoter
▸ getVoter(account
: Address): Promise‹Voter›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:643
Parameters:
Name | Type |
---|---|
account |
Address |
Returns: Promise‹Voter›
humanReadableProposalSchedule
▸ humanReadableProposalSchedule(proposalID
: BigNumber.Value): Promise‹Partial‹StageDurations‹string›››
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:428
Parameters:
Name | Type |
---|---|
proposalID |
BigNumber.Value |
Returns: Promise‹Partial‹StageDurations‹string›››
isUpvoting
▸ isUpvoting(upvoter
: Address): Promise‹boolean›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:532
Parameters:
Name | Type |
---|---|
upvoter |
Address |
Returns: Promise‹boolean›
isVotingReferendum
▸ isVotingReferendum(voter
: Address): Promise‹boolean›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:635
Parameters:
Name | Type |
---|---|
voter |
Address |
Returns: Promise‹boolean›
proposalSchedule
▸ proposalSchedule(proposalID
: BigNumber.Value): Promise‹Partial‹StageDurations‹BigNumber›››
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:402
Parameters:
Name | Type |
---|---|
proposalID |
BigNumber.Value |
Returns: Promise‹Partial‹StageDurations‹BigNumber›››
revokeUpvote
▸ revokeUpvote(upvoter
: Address): Promise‹CeloTransactionObject‹boolean››
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:768
Revokes provided upvoter's upvote.
Parameters:
Name | Type | Description |
---|---|---|
upvoter |
Address | Address of upvoter |
Returns: Promise‹CeloTransactionObject‹boolean››
sortedQueue
▸ sortedQueue(queue
: UpvoteRecord[]): UpvoteRecord[]
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:706
Parameters:
Name | Type |
---|---|
queue |
UpvoteRecord[] |
Returns: UpvoteRecord[]
stageDurations
▸ stageDurations(): Promise‹DequeuedStageDurations›
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:185
Query durations of different stages in proposal lifecycle.
Returns: Promise‹DequeuedStageDurations›
Durations for approval, referendum and execution stages in seconds.
upvote
▸ upvote(proposalID
: BigNumber.Value, upvoter
: Address): Promise‹CeloTransactionObject‹boolean››
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:752
Applies provided upvoter's upvote to given proposal.
Parameters:
Name | Type | Description |
---|---|---|
proposalID |
BigNumber.Value | Governance proposal UUID |
upvoter |
Address | Address of upvoter |
Returns: Promise‹CeloTransactionObject‹boolean››
version
▸ version(): Promise‹NonNullable‹T["methods"] extends object ? ContractVersion<> : never››
Inherited from BaseWrapper.version
Defined in packages/sdk/contractkit/src/wrappers/BaseWrapper.ts:39
Returns: Promise‹NonNullable‹T["methods"] extends object ? ContractVersion<> : never››
vote
▸ vote(proposalID
: BigNumber.Value, vote
: keyof typeof VoteValue): Promise‹CeloTransactionObject‹boolean››
Defined in packages/sdk/contractkit/src/wrappers/Governance.ts:794
Applies sender
's vote choice to a given proposal.
Parameters:
Name | Type | Description |
---|---|---|
proposalID |
BigNumber.Value | Governance proposal UUID |
vote |
keyof typeof VoteValue | Choice to apply (yes, no, abstain) |
Returns: Promise‹CeloTransactionObject‹boolean››