I Governor Timelock
Extension of the {IGovernor} for timelock supporting modules. Available since v4.3.
Methods
COUNTING_MODE
module:voting
A description of the possible support
values for {castVote} and the way these votes are counted, meant to be consumed by UIs to show correct vote options and interpret the results. The string is a URL-encoded sequence of key-value pairs that each describe one aspect, for example support=bravo&quorum=for,abstain
. There are 2 standard keys: support
and quorum
. - support=bravo
refers to the vote options 0 = For, 1 = Against, 2 = Abstain, as in GovernorBravo
. - quorum=bravo
means that only For votes are counted towards quorum. - quorum=for,abstain
means that both For and Abstain votes are counted towards quorum. NOTE: The string can be decoded by the standard https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams[URLSearchParams
] JavaScript class.
Returns
Name | Type | Description |
---|---|---|
_0 | string | undefined |
castVote
Cast a vote Emits a {VoteCast} event.
Parameters
Name | Type | Description |
---|---|---|
proposalId | uint256 | undefined |
support | uint8 | undefined |
Returns
Name | Type | Description |
---|---|---|
balance | uint256 | undefined |
castVoteBySig
Cast a vote using the user cryptographic signature. Emits a {VoteCast} event.
Parameters
Name | Type | Description |
---|---|---|
proposalId | uint256 | undefined |
support | uint8 | undefined |
v | uint8 | undefined |
r | bytes32 | undefined |
s | bytes32 | undefined |
Returns
Name | Type | Description |
---|---|---|
balance | uint256 | undefined |
castVoteWithReason
Cast a with a reason Emits a {VoteCast} event.
Parameters
Name | Type | Description |
---|---|---|
proposalId | uint256 | undefined |
support | uint8 | undefined |
reason | string | undefined |
Returns
Name | Type | Description |
---|---|---|
balance | uint256 | undefined |
execute
Execute a successful proposal. This requires the quorum to be reached, the vote to be successful, and the deadline to be reached. Emits a {ProposalExecuted} event. Note: some module can modify the requirements for execution, for example by adding an additional timelock.
Parameters
Name | Type | Description |
---|---|---|
targets | address[] | undefined |
values | uint256[] | undefined |
calldatas | bytes[] | undefined |
descriptionHash | bytes32 | undefined |
Returns
Name | Type | Description |
---|---|---|
proposalId | uint256 | undefined |
getVotes
module:reputation
Voting power of an account
at a specific blockNumber
. Note: this can be implemented in a number of ways, for example by reading the delegated balance from one (or multiple), {ERC20Votes} tokens.
Parameters
Name | Type | Description |
---|---|---|
account | address | undefined |
blockNumber | uint256 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
hasVoted
module:voting
Returns weither account
has cast a vote on proposalId
.
Parameters
Name | Type | Description |
---|---|---|
proposalId | uint256 | undefined |
account | address | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
hashProposal
module:core
Hashing function used to (re)build the proposal id from the proposal details..
Parameters
Name | Type | Description |
---|---|---|
targets | address[] | undefined |
values | uint256[] | undefined |
calldatas | bytes[] | undefined |
descriptionHash | bytes32 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
name
module:core
Name of the governor instance (used in building the ERC712 domain separator).
Returns
Name | Type | Description |
---|---|---|
_0 | string | undefined |
proposalDeadline
module:core
timestamp at which votes close.
Parameters
Name | Type | Description |
---|---|---|
proposalId | uint256 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
proposalEta
Parameters
Name | Type | Description |
---|---|---|
proposalId | uint256 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
proposalSnapshot
module:core
block number used to retrieve user's votes and quorum.
Parameters
Name | Type | Description |
---|---|---|
proposalId | uint256 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
propose
Create a new proposal. Vote start {IGovernor-votingDelay} blocks after the proposal is created and ends {IGovernor-votingPeriod} blocks after the voting starts. Emits a {ProposalCreated} event.
Parameters
Name | Type | Description |
---|---|---|
targets | address[] | undefined |
values | uint256[] | undefined |
calldatas | bytes[] | undefined |
description | string | undefined |
Returns
Name | Type | Description |
---|---|---|
proposalId | uint256 | undefined |
queue
Parameters
Name | Type | Description |
---|---|---|
targets | address[] | undefined |
values | uint256[] | undefined |
calldatas | bytes[] | undefined |
descriptionHash | bytes32 | undefined |
Returns
Name | Type | Description |
---|---|---|
proposalId | uint256 | undefined |
quorum
module:user-config
Minimum number of cast voted required for a proposal to be successful. Note: The blockNumber
parameter corresponds to the snaphot used for counting vote. This allows to scale the quroum depending on values such as the totalSupply of a token at this block (see {ERC20Votes}).
Parameters
Name | Type | Description |
---|---|---|
blockNumber | uint256 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
state
module:core
Current state of a proposal, following Compound's convention
Parameters
Name | Type | Description |
---|---|---|
proposalId | uint256 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | enum IGovernor.ProposalState | undefined |
supportsInterface
Returns true if this contract implements the interface defined by interfaceId
. See the corresponding https://eips.ethereum.org/EIPS/eip-165#how-interfaces-are-identified[EIP section] to learn more about how these ids are created. This function call must use less than 30 000 gas.
Parameters
Name | Type | Description |
---|---|---|
interfaceId | bytes4 | undefined |
Returns
Name | Type | Description |
---|---|---|
_0 | bool | undefined |
timelock
Returns
Name | Type | Description |
---|---|---|
_0 | address | undefined |
version
module:core
Version of the governor instance (used in building the ERC712 domain separator). Default: "1"
Returns
Name | Type | Description |
---|---|---|
_0 | string | undefined |
votingDelay
module:user-config
delay, in number of block, between the proposal is created and the vote starts. This can be increassed to leave time for users to buy voting power, of delegate it, before the voting of a proposal starts.
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
votingPeriod
module:user-config
delay, in number of blocks, between the vote start and vote ends. Note: the {votingDelay} can delay the start of the vote. This must be considered when setting the voting duration compared to the voting delay.
Returns
Name | Type | Description |
---|---|---|
_0 | uint256 | undefined |
Events
ProposalCanceled
Parameters
Name | Type | Description |
---|---|---|
proposalId | uint256 | undefined |
ProposalCreated
Parameters
Name | Type | Description |
---|---|---|
proposalId | uint256 | undefined |
proposer | address | undefined |
targets | address[] | undefined |
values | uint256[] | undefined |
signatures | string[] | undefined |
calldatas | bytes[] | undefined |
startBlock | uint256 | undefined |
endBlock | uint256 | undefined |
description | string | undefined |
ProposalExecuted
Parameters
Name | Type | Description |
---|---|---|
proposalId | uint256 | undefined |
ProposalQueued
Parameters
Name | Type | Description |
---|---|---|
proposalId | uint256 | undefined |
eta | uint256 | undefined |
VoteCast
Parameters
Name | Type | Description |
---|---|---|
voter | address | undefined |
proposalId | uint256 | undefined |
support | uint8 | undefined |
weight | uint256 | undefined |
reason | string | undefined |
Last updated