Governor Timelock Control

Extension of {Governor} that binds the execution process to an instance of {TimelockController}. This adds a delay, enforced by the {TimelockController} to all successful proposal (in addition to the voting duration). The {Governor} needs the proposer (an ideally the executor) roles for the {Governor} to work properly. Using this model means the proposal will be operated by the {TimelockController} and not by the {Governor}. Thus, the assets and permissions must be attached to the {TimelockController}. Any asset sent to the {Governor} will be inaccessible. Available since v4.3.

Methods

BALLOT_TYPEHASH

function BALLOT_TYPEHASH() external view returns (bytes32)

Returns

Name	Type	Description
_0	bytes32	undefined

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

Name	Type	Description
_0	string	undefined

castVote

function castVote(uint256 proposalId, uint8 support) external nonpayable returns (uint256)

See {IGovernor-castVote}.

Parameters

Name	Type	Description
proposalId	uint256	undefined
support	uint8	undefined

Returns

Name	Type	Description
_0	uint256	undefined

castVoteBySig

function castVoteBySig(uint256 proposalId, uint8 support, uint8 v, bytes32 r, bytes32 s) external nonpayable returns (uint256)

See {IGovernor-castVoteBySig}.

Parameters

Name	Type	Description
proposalId	uint256	undefined
support	uint8	undefined
v	uint8	undefined
r	bytes32	undefined
s	bytes32	undefined

Returns

Name	Type	Description
_0	uint256	undefined

castVoteWithReason

function castVoteWithReason(uint256 proposalId, uint8 support, string reason) external nonpayable returns (uint256)

See {IGovernor-castVoteWithReason}.

Parameters

Name	Type	Description
proposalId	uint256	undefined
support	uint8	undefined
reason	string	undefined

Returns

Name	Type	Description
_0	uint256	undefined

execute

function execute(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) external payable returns (uint256)

See {IGovernor-execute}.

Parameters

Name	Type	Description
targets	address[]	undefined
values	uint256[]	undefined
calldatas	bytes[]	undefined
descriptionHash	bytes32	undefined

Returns

Name	Type	Description
_0	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

Name	Type	Description
account	address	undefined
blockNumber	uint256	undefined

Returns

Name	Type	Description
_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

Name	Type	Description
proposalId	uint256	undefined
account	address	undefined

Returns

Name	Type	Description
_0	bool	undefined

hashProposal

function hashProposal(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) external pure returns (uint256)

See {IGovernor-hashProposal}. The proposal id is produced by hashing the RLC encoded targets array, the values array, the calldatas array and the descriptionHash (bytes32 which itself is the keccak256 hash of the description string). This proposal id can be produced from the proposal data which is part of the {ProposalCreated} event. It can even be computed in advance, before the proposal is submitted. Note that the chainId and the governor address are not part of the proposal id computation. Consequently, the same proposal (with same operation and same description) will have the same id if submitted on multiple governors accross multiple networks. This also means that in order to execute the same operation twice (on the same governor) the proposer will have to change the description in order to avoid proposal id conflicts.

Parameters

Name	Type	Description
targets	address[]	undefined
values	uint256[]	undefined
calldatas	bytes[]	undefined
descriptionHash	bytes32	undefined

Returns

Name	Type	Description
_0	uint256	undefined

name

function name() external view returns (string)

See {IGovernor-name}.

Returns

Name	Type	Description
_0	string	undefined

proposalDeadline

function proposalDeadline(uint256 proposalId) external view returns (uint256)

See {IGovernor-proposalDeadline}.

Parameters

Name	Type	Description
proposalId	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

proposalEta

function proposalEta(uint256 proposalId) external view returns (uint256)

Public accessor to check the eta of a queued proposal

Parameters

Name	Type	Description
proposalId	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

proposalSnapshot

function proposalSnapshot(uint256 proposalId) external view returns (uint256)

See {IGovernor-proposalSnapshot}.

Parameters

Name	Type	Description
proposalId	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

propose

function propose(address[] targets, uint256[] values, bytes[] calldatas, string description) external nonpayable returns (uint256)

See {IGovernor-propose}.

Parameters

Name	Type	Description
targets	address[]	undefined
values	uint256[]	undefined
calldatas	bytes[]	undefined
description	string	undefined

Returns

Name	Type	Description
_0	uint256	undefined

queue

function queue(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) external nonpayable returns (uint256)

Function to queue a proposal to the timelock.

Parameters

Name	Type	Description
targets	address[]	undefined
values	uint256[]	undefined
calldatas	bytes[]	undefined
descriptionHash	bytes32	undefined

Returns

Name	Type	Description
_0	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

Name	Type	Description
blockNumber	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

state

function state(uint256 proposalId) external view returns (enum IGovernor.ProposalState)

Overriden version of the {Governor-state} function with added support for the Queued status.

Parameters

Name	Type	Description
proposalId	uint256	undefined

Returns

Name	Type	Description
_0	enum IGovernor.ProposalState	undefined

supportsInterface

function supportsInterface(bytes4 interfaceId) external view returns (bool)

See {IERC165-supportsInterface}.

Parameters

Name	Type	Description
interfaceId	bytes4	undefined

Returns

Name	Type	Description
_0	bool	undefined

timelock

function timelock() external view returns (address)

Public accessor to check the address of the timelock

Returns

Name	Type	Description
_0	address	undefined

updateTimelock

function updateTimelock(contract TimelockController newTimelock) external nonpayable

Public endpoint to update the underlying timelock instance. Restricted to the timelock itself, so updates must be proposed, scheduled and executed using the {Governor} workflow.

Parameters

Name	Type	Description
newTimelock	contract TimelockController	undefined

version

function version() external view returns (string)

See {IGovernor-version}.

Returns

Name	Type	Description
_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

Name	Type	Description
_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

Name	Type	Description
_0	uint256	undefined

Events

ProposalCanceled

event ProposalCanceled(uint256 proposalId)

Parameters

Name	Type	Description
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

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

event ProposalExecuted(uint256 proposalId)

Parameters

Name	Type	Description
proposalId	uint256	undefined

ProposalQueued

event ProposalQueued(uint256 proposalId, uint256 eta)

Parameters

Name	Type	Description
proposalId	uint256	undefined
eta	uint256	undefined

TimelockChange

event TimelockChange(address oldTimelock, address newTimelock)

Emitted when the timelock controller used for proposal execution is modified.

Parameters

Name	Type	Description
oldTimelock	address	undefined
newTimelock	address	undefined

VoteCast

event VoteCast(address indexed voter, uint256 proposalId, uint8 support, uint256 weight, string reason)

Parameters

Name	Type	Description
voter indexed	address	undefined
proposalId	uint256	undefined
support	uint8	undefined
weight	uint256	undefined
reason	string	undefined