Skip to main content

GovernorUpgradeable

Core of the governance system, designed to be extended though various modules. This contract is abstract and requires several function to be implemented in various modules: - A counting module must implement {quorum}, {quorumReached}, {_voteSucceeded} and {_countVote} - A voting module must implement {getVotes} - Additionanly, the {votingPeriod} must also be implemented _Available since v4.3.

Methods

BALLOT_TYPEHASH

function BALLOT_TYPEHASH() external view returns (bytes32)

Returns

NameTypeDescription
_0bytes32undefined

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 = Against, 1 = For, 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

NameTypeDescription
_0stringundefined

castVote

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

See {IGovernor-castVote}.

Parameters

NameTypeDescription
proposalIduint256undefined
supportuint8undefined

Returns

NameTypeDescription
_0uint256undefined

castVoteBySig

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

See {IGovernor-castVoteBySig}.

Parameters

NameTypeDescription
proposalIduint256undefined
supportuint8undefined
vuint8undefined
rbytes32undefined
sbytes32undefined

Returns

NameTypeDescription
_0uint256undefined

castVoteWithReason

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

See {IGovernor-castVoteWithReason}.

Parameters

NameTypeDescription
proposalIduint256undefined
supportuint8undefined
reasonstringundefined

Returns

NameTypeDescription
_0uint256undefined

execute

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

See {IGovernor-execute}.

Parameters

NameTypeDescription
targetsaddress[]undefined
valuesuint256[]undefined
calldatasbytes[]undefined
descriptionHashbytes32undefined

Returns

NameTypeDescription
_0uint256undefined

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

NameTypeDescription
accountaddressundefined
blockNumberuint256undefined

Returns

NameTypeDescription
_0uint256undefined

hasVoted

function hasVoted(uint256 proposalId, address account) external view returns (bool)

module:voting

Returns weither account has cast a vote on proposalId.

Parameters

NameTypeDescription
proposalIduint256undefined
accountaddressundefined

Returns

NameTypeDescription
_0boolundefined

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

NameTypeDescription
targetsaddress[]undefined
valuesuint256[]undefined
calldatasbytes[]undefined
descriptionHashbytes32undefined

Returns

NameTypeDescription
_0uint256undefined

name

function name() external view returns (string)

See {IGovernor-name}.

Returns

NameTypeDescription
_0stringundefined

proposalDeadline

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

See {IGovernor-proposalDeadline}.

Parameters

NameTypeDescription
proposalIduint256undefined

Returns

NameTypeDescription
_0uint256undefined

proposalSnapshot

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

See {IGovernor-proposalSnapshot}.

Parameters

NameTypeDescription
proposalIduint256undefined

Returns

NameTypeDescription
_0uint256undefined

proposalThreshold

function proposalThreshold() external view returns (uint256)

Part of the Governor Bravo's interface: "The number of votes required in order for a voter to become a proposer".

Returns

NameTypeDescription
_0uint256undefined

propose

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

See {IGovernor-propose}.

Parameters

NameTypeDescription
targetsaddress[]undefined
valuesuint256[]undefined
calldatasbytes[]undefined
descriptionstringundefined

Returns

NameTypeDescription
_0uint256undefined

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

NameTypeDescription
blockNumberuint256undefined

Returns

NameTypeDescription
_0uint256undefined

relay

function relay(address target, uint256 value, bytes data) external nonpayable

Relays a transaction or function call to an arbitrary target. In cases where the governance executor is some contract other than the governor itself, like when using a timelock, this function can be invoked in a governance proposal to recover tokens or Ether that was sent to the governor contract by mistake. Note that if the executor is simply the governor itself, use of relay is redundant.

Parameters

NameTypeDescription
targetaddressundefined
valueuint256undefined
databytesundefined

state

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

See {IGovernor-state}.

Parameters

NameTypeDescription
proposalIduint256undefined

Returns

NameTypeDescription
_0enum IGovernorUpgradeable.ProposalStateundefined

supportsInterface

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

See {IERC165-supportsInterface}.

Parameters

NameTypeDescription
interfaceIdbytes4undefined

Returns

NameTypeDescription
_0boolundefined

version

function version() external view returns (string)

See {IGovernor-version}.

Returns

NameTypeDescription
_0stringundefined

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

NameTypeDescription
_0uint256undefined

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

NameTypeDescription
_0uint256undefined

Events

ProposalCanceled

event ProposalCanceled(uint256 proposalId)

Parameters

NameTypeDescription
proposalIduint256undefined

ProposalCreated

event ProposalCreated(uint256 proposalId, address proposer, address[] targets, uint256[] values, string[] signatures, bytes[] calldatas, uint256 startBlock, uint256 endBlock, string description)

Parameters

NameTypeDescription
proposalIduint256undefined
proposeraddressundefined
targetsaddress[]undefined
valuesuint256[]undefined
signaturesstring[]undefined
calldatasbytes[]undefined
startBlockuint256undefined
endBlockuint256undefined
descriptionstringundefined

ProposalExecuted

event ProposalExecuted(uint256 proposalId)

Parameters

NameTypeDescription
proposalIduint256undefined

VoteCast

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

Parameters

NameTypeDescription
voter indexedaddressundefined
proposalIduint256undefined
supportuint8undefined
weightuint256undefined
reasonstringundefined