GovernorSettingsUpgradeable

Extension of {Governor} for settings updatable through governance. Available since v4.4.

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 = 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. If a counting module makes use of encoded params, it should include this under a params key with a unique name that describes the behavior. For example: - params=fractional might refer to a scheme where votes are divided fractionally between for/against/abstain. - params=erc721 might refer to a scheme where specific NFTs are delegated to vote. NOTE: The string can be decoded by the standard https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams JavaScript class.

Returns

Name	Type	Description
_0	string	undefined

EXTENDED_BALLOT_TYPEHASH

function EXTENDED_BALLOT_TYPEHASH() external view returns (bytes32)

Returns

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

castVoteWithReasonAndParams

function castVoteWithReasonAndParams(uint256 proposalId, uint8 support, string reason, bytes params) external nonpayable returns (uint256)

See {IGovernor-castVoteWithReasonAndParams}.

Parameters

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

Returns

Name	Type	Description
_0	uint256	undefined

castVoteWithReasonAndParamsBySig

function castVoteWithReasonAndParamsBySig(uint256 proposalId, uint8 support, string reason, bytes params, uint8 v, bytes32 r, bytes32 s) external nonpayable returns (uint256)

See {IGovernor-castVoteWithReasonAndParamsBySig}.

Parameters

Name	Type	Description
proposalId	uint256	undefined
support	uint8	undefined
reason	string	undefined
params	bytes	undefined
v	uint8	undefined
r	bytes32	undefined
s	bytes32	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)

See {IGovernor-getVotes}.

Parameters

Name	Type	Description
account	address	undefined
blockNumber	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

getVotesWithParams

function getVotesWithParams(address account, uint256 blockNumber, bytes params) external view returns (uint256)

See {IGovernor-getVotesWithParams}.

Parameters

Name	Type	Description
account	address	undefined
blockNumber	uint256	undefined
params	bytes	undefined

Returns

Name	Type	Description
_0	uint256	undefined

hasVoted

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

module:voting

Returns whether 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 ABI 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 across 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

onERC1155BatchReceived

function onERC1155BatchReceived(address, address, uint256[], uint256[], bytes) external nonpayable returns (bytes4)

See {IERC1155Receiver-onERC1155BatchReceived}.

Parameters

Name	Type	Description
_0	address	undefined
_1	address	undefined
_2	uint256[]	undefined
_3	uint256[]	undefined
_4	bytes	undefined

Returns

Name	Type	Description
_0	bytes4	undefined

onERC1155Received

function onERC1155Received(address, address, uint256, uint256, bytes) external nonpayable returns (bytes4)

See {IERC1155Receiver-onERC1155Received}.

Parameters

Name	Type	Description
_0	address	undefined
_1	address	undefined
_2	uint256	undefined
_3	uint256	undefined
_4	bytes	undefined

Returns

Name	Type	Description
_0	bytes4	undefined

onERC721Received

function onERC721Received(address, address, uint256, bytes) external nonpayable returns (bytes4)

See {IERC721Receiver-onERC721Received}.

Parameters

Name	Type	Description
_0	address	undefined
_1	address	undefined
_2	uint256	undefined
_3	bytes	undefined

Returns

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

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

proposalThreshold

function proposalThreshold() external view returns (uint256)

See {Governor-proposalThreshold}.

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

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 snapshot used for counting vote. This allows to scale the quorum 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

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

Name	Type	Description
target	address	undefined
value	uint256	undefined
data	bytes	undefined

setProposalThreshold

function setProposalThreshold(uint256 newProposalThreshold) external nonpayable

Update the proposal threshold. This operation can only be performed through a governance proposal. Emits a {ProposalThresholdSet} event.

Parameters

Name	Type	Description
newProposalThreshold	uint256	undefined

setVotingDelay

function setVotingDelay(uint256 newVotingDelay) external nonpayable

Update the voting delay. This operation can only be performed through a governance proposal. Emits a {VotingDelaySet} event.

Parameters

Name	Type	Description
newVotingDelay	uint256	undefined

setVotingPeriod

function setVotingPeriod(uint256 newVotingPeriod) external nonpayable

Update the voting period. This operation can only be performed through a governance proposal. Emits a {VotingPeriodSet} event.

Parameters

Name	Type	Description
newVotingPeriod	uint256	undefined

state

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

See {IGovernor-state}.

Parameters

Name	Type	Description
proposalId	uint256	undefined

Returns

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

version

function version() external view returns (string)

See {IGovernor-version}.

Returns

Name	Type	Description
_0	string	undefined

votingDelay

function votingDelay() external view returns (uint256)

See {IGovernor-votingDelay}.

Returns

Name	Type	Description
_0	uint256	undefined

votingPeriod

function votingPeriod() external view returns (uint256)

See {IGovernor-votingPeriod}.

Returns

Name	Type	Description
_0	uint256	undefined

Events

Initialized

event Initialized(uint8 version)

Parameters

Name	Type	Description
version	uint8	undefined

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

ProposalThresholdSet

event ProposalThresholdSet(uint256 oldProposalThreshold, uint256 newProposalThreshold)

Parameters

Name	Type	Description
oldProposalThreshold	uint256	undefined
newProposalThreshold	uint256	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

VoteCastWithParams

event VoteCastWithParams(address indexed voter, uint256 proposalId, uint8 support, uint256 weight, string reason, bytes params)

Parameters

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

VotingDelaySet

event VotingDelaySet(uint256 oldVotingDelay, uint256 newVotingDelay)

Parameters

Name	Type	Description
oldVotingDelay	uint256	undefined
newVotingDelay	uint256	undefined

VotingPeriodSet

event VotingPeriodSet(uint256 oldVotingPeriod, uint256 newVotingPeriod)

Parameters

Name	Type	Description
oldVotingPeriod	uint256	undefined
newVotingPeriod	uint256	undefined

Errors

Empty

error Empty()

An operation (e.g. {front}) couldn't be completed due to the queue being empty.