I Governor Timelock
Extension of the {IGovernor} for timelock supporting modules. Available since v4.3.
Methods
COUNTING_MODE
function COUNTING_MODE() external pure returns (string)
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
_0
string
undefined
castVote
function castVote(uint256 proposalId, uint8 support) external nonpayable returns (uint256 balance)
Cast a vote Emits a {VoteCast} event.
Parameters
proposalId
uint256
undefined
support
uint8
undefined
Returns
balance
uint256
undefined
castVoteBySig
function castVoteBySig(uint256 proposalId, uint8 support, uint8 v, bytes32 r, bytes32 s) external nonpayable returns (uint256 balance)
Cast a vote using the user cryptographic signature. Emits a {VoteCast} event.
Parameters
proposalId
uint256
undefined
support
uint8
undefined
v
uint8
undefined
r
bytes32
undefined
s
bytes32
undefined
Returns
balance
uint256
undefined
castVoteWithReason
function castVoteWithReason(uint256 proposalId, uint8 support, string reason) external nonpayable returns (uint256 balance)
Cast a with a reason Emits a {VoteCast} event.
Parameters
proposalId
uint256
undefined
support
uint8
undefined
reason
string
undefined
Returns
balance
uint256
undefined
execute
function execute(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) external payable returns (uint256 proposalId)
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
targets
address[]
undefined
values
uint256[]
undefined
calldatas
bytes[]
undefined
descriptionHash
bytes32
undefined
Returns
proposalId
uint256
undefined
getVotes
function getVotes(address account, uint256 blockNumber) external view returns (uint256)
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
account
address
undefined
blockNumber
uint256
undefined
Returns
_0
uint256
undefined
hasVoted
function hasVoted(uint256 proposalId, address account) external view returns (bool)
module:voting
Returns weither account
has cast a vote on proposalId
.
Parameters
proposalId
uint256
undefined
account
address
undefined
Returns
_0
bool
undefined
hashProposal
function hashProposal(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) external pure returns (uint256)
module:core
Hashing function used to (re)build the proposal id from the proposal details..
Parameters
targets
address[]
undefined
values
uint256[]
undefined
calldatas
bytes[]
undefined
descriptionHash
bytes32
undefined
Returns
_0
uint256
undefined
name
function name() external view returns (string)
module:core
Name of the governor instance (used in building the ERC712 domain separator).
Returns
_0
string
undefined
proposalDeadline
function proposalDeadline(uint256 proposalId) external view returns (uint256)
module:core
timestamp at which votes close.
Parameters
proposalId
uint256
undefined
Returns
_0
uint256
undefined
proposalEta
function proposalEta(uint256 proposalId) external view returns (uint256)
Parameters
proposalId
uint256
undefined
Returns
_0
uint256
undefined
proposalSnapshot
function proposalSnapshot(uint256 proposalId) external view returns (uint256)
module:core
block number used to retrieve user's votes and quorum.
Parameters
proposalId
uint256
undefined
Returns
_0
uint256
undefined
propose
function propose(address[] targets, uint256[] values, bytes[] calldatas, string description) external nonpayable returns (uint256 proposalId)
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
targets
address[]
undefined
values
uint256[]
undefined
calldatas
bytes[]
undefined
description
string
undefined
Returns
proposalId
uint256
undefined
queue
function queue(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) external nonpayable returns (uint256 proposalId)
Parameters
targets
address[]
undefined
values
uint256[]
undefined
calldatas
bytes[]
undefined
descriptionHash
bytes32
undefined
Returns
proposalId
uint256
undefined
quorum
function quorum(uint256 blockNumber) external view returns (uint256)
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
blockNumber
uint256
undefined
Returns
_0
uint256
undefined
state
function state(uint256 proposalId) external view returns (enum IGovernor.ProposalState)
module:core
Current state of a proposal, following Compound's convention
Parameters
proposalId
uint256
undefined
Returns
_0
enum IGovernor.ProposalState
undefined
supportsInterface
function supportsInterface(bytes4 interfaceId) external view returns (bool)
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
interfaceId
bytes4
undefined
Returns
_0
bool
undefined
timelock
function timelock() external view returns (address)
Returns
_0
address
undefined
version
function version() external view returns (string)
module:core
Version of the governor instance (used in building the ERC712 domain separator). Default: "1"
Returns
_0
string
undefined
votingDelay
function votingDelay() external view returns (uint256)
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
_0
uint256
undefined
votingPeriod
function votingPeriod() external view returns (uint256)
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
_0
uint256
undefined
Events
ProposalCanceled
event ProposalCanceled(uint256 proposalId)
Parameters
proposalId
uint256
undefined
ProposalCreated
event ProposalCreated(uint256 proposalId, address proposer, address[] targets, uint256[] values, string[] signatures, bytes[] calldatas, uint256 startBlock, uint256 endBlock, string description)
Parameters
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
event ProposalExecuted(uint256 proposalId)
Parameters
proposalId
uint256
undefined
ProposalQueued
event ProposalQueued(uint256 proposalId, uint256 eta)
Parameters
proposalId
uint256
undefined
eta
uint256
undefined
VoteCast
event VoteCast(address indexed voter, uint256 proposalId, uint8 support, uint256 weight, string reason)
Parameters
voter indexed
address
undefined
proposalId
uint256
undefined
support
uint8
undefined
weight
uint256
undefined
reason
string
undefined
Last updated