:github-icon: pass:[<svg class="icon"><use href="#github-icon"/></svg>]
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:GovernorVotes: pass:normal[xref:governance.adoc#GovernorVotes[`GovernorVotes`]]
:ERC20Votes: pass:normal[xref:token/ERC20.adoc#ERC20Votes[`ERC20Votes`]]
:ERC721Votes: pass:normal[xref:token/ERC721.adoc#ERC721Votes[`ERC721Votes`]]
:GovernorVotesComp: pass:normal[xref:governance.adoc#GovernorVotesComp[`GovernorVotesComp`]]
:ERC20VotesComp: pass:normal[xref:token/ERC20.adoc#ERC20VotesComp[`ERC20VotesComp`]]
:GovernorVotesQuorumFraction: pass:normal[xref:governance.adoc#GovernorVotesQuorumFraction[`GovernorVotesQuorumFraction`]]
:GovernorCountingSimple: pass:normal[xref:governance.adoc#GovernorCountingSimple[`GovernorCountingSimple`]]
:GovernorTimelockControl: pass:normal[xref:governance.adoc#GovernorTimelockControl[`GovernorTimelockControl`]]
:TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
:GovernorTimelockCompound: pass:normal[xref:governance.adoc#GovernorTimelockCompound[`GovernorTimelockCompound`]]
:GovernorCompatibilityBravo: pass:normal[xref:governance.adoc#GovernorCompatibilityBravo[`GovernorCompatibilityBravo`]]
:GovernorSettings: pass:normal[xref:governance.adoc#GovernorSettings[`GovernorSettings`]]
:GovernorPreventLateQuorum: pass:normal[xref:governance.adoc#GovernorPreventLateQuorum[`GovernorPreventLateQuorum`]]
:Governor-_cancel: pass:normal[xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-[`Governor._cancel`]]
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:xref-IGovernor-name--: xref:governance.adoc#IGovernor-name--
:xref-IGovernor-version--: xref:governance.adoc#IGovernor-version--
:xref-IGovernor-clock--: xref:governance.adoc#IGovernor-clock--
:xref-IGovernor-CLOCK_MODE--: xref:governance.adoc#IGovernor-CLOCK_MODE--
:xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
:xref-IGovernor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#IGovernor-hashProposal-address---uint256---bytes---bytes32-
:xref-IGovernor-state-uint256-: xref:governance.adoc#IGovernor-state-uint256-
:xref-IGovernor-proposalSnapshot-uint256-: xref:governance.adoc#IGovernor-proposalSnapshot-uint256-
:xref-IGovernor-proposalDeadline-uint256-: xref:governance.adoc#IGovernor-proposalDeadline-uint256-
:xref-IGovernor-proposalProposer-uint256-: xref:governance.adoc#IGovernor-proposalProposer-uint256-
:xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
:xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
:xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
:xref-IGovernor-getVotes-address-uint256-: xref:governance.adoc#IGovernor-getVotes-address-uint256-
:xref-IGovernor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#IGovernor-getVotesWithParams-address-uint256-bytes-
:xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
:xref-IGovernor-propose-address---uint256---bytes---string-: xref:governance.adoc#IGovernor-propose-address---uint256---bytes---string-
:xref-IGovernor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#IGovernor-execute-address---uint256---bytes---bytes32-
:xref-IGovernor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#IGovernor-cancel-address---uint256---bytes---bytes32-
:xref-IGovernor-castVote-uint256-uint8-: xref:governance.adoc#IGovernor-castVote-uint256-uint8-
:xref-IGovernor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#IGovernor-castVoteWithReason-uint256-uint8-string-
:xref-IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
:xref-IGovernor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#IGovernor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
:xref-IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
:xref-IERC165-supportsInterface-bytes4-: xref:utils.adoc#IERC165-supportsInterface-bytes4-
:xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
:xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
:xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
:xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
:xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
:IERC6372: pass:normal[xref:interfaces.adoc#IERC6372[`IERC6372`]]
:ERC20Votes: pass:normal[xref:token/ERC20.adoc#ERC20Votes[`ERC20Votes`]]
:ERC20Votes: pass:normal[xref:token/ERC20.adoc#ERC20Votes[`ERC20Votes`]]
:IGovernor-votingDelay: pass:normal[xref:governance.adoc#IGovernor-votingDelay--[`IGovernor.votingDelay`]]
:IGovernor-votingPeriod: pass:normal[xref:governance.adoc#IGovernor-votingPeriod--[`IGovernor.votingPeriod`]]
:xref-Governor-onlyGovernance--: xref:governance.adoc#Governor-onlyGovernance--
:xref-Governor-constructor-string-: xref:governance.adoc#Governor-constructor-string-
:xref-Governor-receive--: xref:governance.adoc#Governor-receive--
:xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
:xref-Governor-name--: xref:governance.adoc#Governor-name--
:xref-Governor-version--: xref:governance.adoc#Governor-version--
:xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
:xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
:xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
:xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
:xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
:xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
:xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
:xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
:xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
:xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
:xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
:xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
:xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
:xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
:xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
:xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
:xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
:xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
:xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
:xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
:xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
:xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
:xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
:xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
:xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
:xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
:xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
:xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
:xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
:xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
:xref-IGovernor-clock--: xref:governance.adoc#IGovernor-clock--
:xref-IGovernor-CLOCK_MODE--: xref:governance.adoc#IGovernor-CLOCK_MODE--
:xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
:xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
:xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
:xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
:xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
:xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
:xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
:xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
:xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
:xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
:xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
:xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
:xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
:xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
:GovernorSettings: pass:normal[xref:governance.adoc#GovernorSettings[`GovernorSettings`]]
:IERC165-supportsInterface: pass:normal[xref:utils.adoc#IERC165-supportsInterface-bytes4-[`IERC165.supportsInterface`]]
:IGovernor-name: pass:normal[xref:governance.adoc#IGovernor-name--[`IGovernor.name`]]
:IGovernor-version: pass:normal[xref:governance.adoc#IGovernor-version--[`IGovernor.version`]]
:IGovernor-hashProposal: pass:normal[xref:governance.adoc#IGovernor-hashProposal-address---uint256---bytes---bytes32-[`IGovernor.hashProposal`]]
:IGovernor-state: pass:normal[xref:governance.adoc#IGovernor-state-uint256-[`IGovernor.state`]]
:IGovernor-proposalSnapshot: pass:normal[xref:governance.adoc#IGovernor-proposalSnapshot-uint256-[`IGovernor.proposalSnapshot`]]
:IGovernor-proposalDeadline: pass:normal[xref:governance.adoc#IGovernor-proposalDeadline-uint256-[`IGovernor.proposalDeadline`]]
:IGovernor-propose: pass:normal[xref:governance.adoc#IGovernor-propose-address---uint256---bytes---string-[`IGovernor.propose`]]
:IGovernor-execute: pass:normal[xref:governance.adoc#IGovernor-execute-address---uint256---bytes---bytes32-[`IGovernor.execute`]]
:IGovernor-cancel: pass:normal[xref:governance.adoc#IGovernor-cancel-address---uint256---bytes---bytes32-[`IGovernor.cancel`]]
:IGovernor-ProposalCanceled: pass:normal[xref:governance.adoc#IGovernor-ProposalCanceled-uint256-[`IGovernor.ProposalCanceled`]]
:IGovernor-getVotes: pass:normal[xref:governance.adoc#IGovernor-getVotes-address-uint256-[`IGovernor.getVotes`]]
:IGovernor-getVotesWithParams: pass:normal[xref:governance.adoc#IGovernor-getVotesWithParams-address-uint256-bytes-[`IGovernor.getVotesWithParams`]]
:IGovernor-castVote: pass:normal[xref:governance.adoc#IGovernor-castVote-uint256-uint8-[`IGovernor.castVote`]]
:IGovernor-castVoteWithReason: pass:normal[xref:governance.adoc#IGovernor-castVoteWithReason-uint256-uint8-string-[`IGovernor.castVoteWithReason`]]
:IGovernor-castVoteWithReasonAndParams: pass:normal[xref:governance.adoc#IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-[`IGovernor.castVoteWithReasonAndParams`]]
:IGovernor-castVoteBySig: pass:normal[xref:governance.adoc#IGovernor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-[`IGovernor.castVoteBySig`]]
:IGovernor-castVoteWithReasonAndParamsBySig: pass:normal[xref:governance.adoc#IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-[`IGovernor.castVoteWithReasonAndParamsBySig`]]
:IGovernor-getVotes: pass:normal[xref:governance.adoc#IGovernor-getVotes-address-uint256-[`IGovernor.getVotes`]]
:IGovernor-VoteCast: pass:normal[xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-[`IGovernor.VoteCast`]]
:IGovernor-getVotes: pass:normal[xref:governance.adoc#IGovernor-getVotes-address-uint256-[`IGovernor.getVotes`]]
:IGovernor-VoteCast: pass:normal[xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-[`IGovernor.VoteCast`]]
:IERC721Receiver-onERC721Received: pass:normal[xref:token/ERC721.adoc#IERC721Receiver-onERC721Received-address-address-uint256-bytes-[`IERC721Receiver.onERC721Received`]]
:IERC1155Receiver-onERC1155Received: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-[`IERC1155Receiver.onERC1155Received`]]
:IERC1155Receiver-onERC1155BatchReceived: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`IERC1155Receiver.onERC1155BatchReceived`]]
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:xref-GovernorCountingSimple-COUNTING_MODE--: xref:governance.adoc#GovernorCountingSimple-COUNTING_MODE--
:xref-GovernorCountingSimple-hasVoted-uint256-address-: xref:governance.adoc#GovernorCountingSimple-hasVoted-uint256-address-
:xref-GovernorCountingSimple-proposalVotes-uint256-: xref:governance.adoc#GovernorCountingSimple-proposalVotes-uint256-
:xref-GovernorCountingSimple-_quorumReached-uint256-: xref:governance.adoc#GovernorCountingSimple-_quorumReached-uint256-
:xref-GovernorCountingSimple-_voteSucceeded-uint256-: xref:governance.adoc#GovernorCountingSimple-_voteSucceeded-uint256-
:xref-GovernorCountingSimple-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#GovernorCountingSimple-_countVote-uint256-address-uint8-uint256-bytes-
:xref-Governor-receive--: xref:governance.adoc#Governor-receive--
:xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
:xref-Governor-name--: xref:governance.adoc#Governor-name--
:xref-Governor-version--: xref:governance.adoc#Governor-version--
:xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
:xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
:xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
:xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
:xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
:xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
:xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
:xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
:xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
:xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
:xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
:xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
:xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
:xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
:xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
:xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
:xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
:xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
:xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
:xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
:xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
:xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
:xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
:xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
:xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
:xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
:xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
:xref-IGovernor-clock--: xref:governance.adoc#IGovernor-clock--
:xref-IGovernor-CLOCK_MODE--: xref:governance.adoc#IGovernor-CLOCK_MODE--
:xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
:xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
:xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
:xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
:xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
:xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
:xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
:xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
:xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
:xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
:xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
:xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
:IGovernor-COUNTING_MODE: pass:normal[xref:governance.adoc#IGovernor-COUNTING_MODE--[`IGovernor.COUNTING_MODE`]]
:IGovernor-hasVoted: pass:normal[xref:governance.adoc#IGovernor-hasVoted-uint256-address-[`IGovernor.hasVoted`]]
:Governor-_quorumReached: pass:normal[xref:governance.adoc#Governor-_quorumReached-uint256-[`Governor._quorumReached`]]
:Governor-_voteSucceeded: pass:normal[xref:governance.adoc#Governor-_voteSucceeded-uint256-[`Governor._voteSucceeded`]]
:Governor-_countVote: pass:normal[xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-[`Governor._countVote`]]
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:ERC20Votes: pass:normal[xref:token/ERC20.adoc#ERC20Votes[`ERC20Votes`]]
:ERC721Votes: pass:normal[xref:token/ERC721.adoc#ERC721Votes[`ERC721Votes`]]
:xref-GovernorVotes-constructor-contract-IVotes-: xref:governance.adoc#GovernorVotes-constructor-contract-IVotes-
:xref-GovernorVotes-clock--: xref:governance.adoc#GovernorVotes-clock--
:xref-GovernorVotes-CLOCK_MODE--: xref:governance.adoc#GovernorVotes-CLOCK_MODE--
:xref-GovernorVotes-_getVotes-address-uint256-bytes-: xref:governance.adoc#GovernorVotes-_getVotes-address-uint256-bytes-
:xref-Governor-receive--: xref:governance.adoc#Governor-receive--
:xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
:xref-Governor-name--: xref:governance.adoc#Governor-name--
:xref-Governor-version--: xref:governance.adoc#Governor-version--
:xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
:xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
:xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
:xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
:xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
:xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
:xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
:xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
:xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
:xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
:xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
:xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
:xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
:xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
:xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
:xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
:xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
:xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
:xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
:xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
:xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
:xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
:xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
:xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
:xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
:xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
:xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
:xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
:xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
:xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
:xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
:xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
:xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
:xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
:xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
:xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
:xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
:xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
:xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
:xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
:xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
:xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
:xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:ERC20Votes: pass:normal[xref:token/ERC20.adoc#ERC20Votes[`ERC20Votes`]]
:xref-GovernorVotesQuorumFraction-constructor-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-constructor-uint256-
:xref-GovernorVotesQuorumFraction-quorumNumerator--: xref:governance.adoc#GovernorVotesQuorumFraction-quorumNumerator--
:xref-GovernorVotesQuorumFraction-quorumNumerator-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-quorumNumerator-uint256-
:xref-GovernorVotesQuorumFraction-quorumDenominator--: xref:governance.adoc#GovernorVotesQuorumFraction-quorumDenominator--
:xref-GovernorVotesQuorumFraction-quorum-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-quorum-uint256-
:xref-GovernorVotesQuorumFraction-updateQuorumNumerator-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-updateQuorumNumerator-uint256-
:xref-GovernorVotesQuorumFraction-_updateQuorumNumerator-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-_updateQuorumNumerator-uint256-
:xref-GovernorVotes-clock--: xref:governance.adoc#GovernorVotes-clock--
:xref-GovernorVotes-CLOCK_MODE--: xref:governance.adoc#GovernorVotes-CLOCK_MODE--
:xref-GovernorVotes-_getVotes-address-uint256-bytes-: xref:governance.adoc#GovernorVotes-_getVotes-address-uint256-bytes-
:xref-Governor-receive--: xref:governance.adoc#Governor-receive--
:xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
:xref-Governor-name--: xref:governance.adoc#Governor-name--
:xref-Governor-version--: xref:governance.adoc#Governor-version--
:xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
:xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
:xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
:xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
:xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
:xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
:xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
:xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
:xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
:xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
:xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
:xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
:xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
:xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
:xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
:xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
:xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
:xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
:xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
:xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
:xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
:xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
:xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
:xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
:xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
:xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
:xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
:xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
:xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
:xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
:xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
:xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
:xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
:xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
:xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
:xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
:xref-GovernorVotesQuorumFraction-QuorumNumeratorUpdated-uint256-uint256-: xref:governance.adoc#GovernorVotesQuorumFraction-QuorumNumeratorUpdated-uint256-uint256-
:xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
:xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
:xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
:xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
:xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
:xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:xref-GovernorVotesComp-constructor-contract-ERC20VotesComp-: xref:governance.adoc#GovernorVotesComp-constructor-contract-ERC20VotesComp-
:xref-GovernorVotesComp-clock--: xref:governance.adoc#GovernorVotesComp-clock--
:xref-GovernorVotesComp-CLOCK_MODE--: xref:governance.adoc#GovernorVotesComp-CLOCK_MODE--
:xref-GovernorVotesComp-_getVotes-address-uint256-bytes-: xref:governance.adoc#GovernorVotesComp-_getVotes-address-uint256-bytes-
:xref-Governor-receive--: xref:governance.adoc#Governor-receive--
:xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
:xref-Governor-name--: xref:governance.adoc#Governor-name--
:xref-Governor-version--: xref:governance.adoc#Governor-version--
:xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
:xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
:xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
:xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
:xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
:xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
:xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
:xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
:xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
:xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
:xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
:xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
:xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
:xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
:xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
:xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
:xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
:xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
:xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
:xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
:xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
:xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
:xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
:xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
:xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
:xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
:xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
:xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
:xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
:xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
:xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
:xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
:xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
:xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
:xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
:xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
:xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
:xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
:xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
:xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
:xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
:xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
:xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
:TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:xref-GovernorTimelockControl-constructor-contract-TimelockController-: xref:governance.adoc#GovernorTimelockControl-constructor-contract-TimelockController-
:xref-GovernorTimelockControl-supportsInterface-bytes4-: xref:governance.adoc#GovernorTimelockControl-supportsInterface-bytes4-
:xref-GovernorTimelockControl-state-uint256-: xref:governance.adoc#GovernorTimelockControl-state-uint256-
:xref-GovernorTimelockControl-timelock--: xref:governance.adoc#GovernorTimelockControl-timelock--
:xref-GovernorTimelockControl-proposalEta-uint256-: xref:governance.adoc#GovernorTimelockControl-proposalEta-uint256-
:xref-GovernorTimelockControl-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockControl-queue-address---uint256---bytes---bytes32-
:xref-GovernorTimelockControl-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockControl-_execute-uint256-address---uint256---bytes---bytes32-
:xref-GovernorTimelockControl-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockControl-_cancel-address---uint256---bytes---bytes32-
:xref-GovernorTimelockControl-_executor--: xref:governance.adoc#GovernorTimelockControl-_executor--
:xref-GovernorTimelockControl-updateTimelock-contract-TimelockController-: xref:governance.adoc#GovernorTimelockControl-updateTimelock-contract-TimelockController-
:xref-Governor-receive--: xref:governance.adoc#Governor-receive--
:xref-Governor-name--: xref:governance.adoc#Governor-name--
:xref-Governor-version--: xref:governance.adoc#Governor-version--
:xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
:xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
:xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
:xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
:xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
:xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
:xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
:xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
:xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
:xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
:xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
:xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
:xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
:xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
:xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
:xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
:xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
:xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
:xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
:xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
:xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
:xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
:xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
:xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
:xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
:xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
:xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
:xref-IGovernor-clock--: xref:governance.adoc#IGovernor-clock--
:xref-IGovernor-CLOCK_MODE--: xref:governance.adoc#IGovernor-CLOCK_MODE--
:xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
:xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
:xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
:xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
:xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
:xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
:xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
:xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
:xref-GovernorTimelockControl-TimelockChange-address-address-: xref:governance.adoc#GovernorTimelockControl-TimelockChange-address-address-
:xref-IGovernorTimelock-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernorTimelock-ProposalQueued-uint256-uint256-
:xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
:xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
:xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
:xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
:xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
:xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
:IERC165-supportsInterface: pass:normal[xref:utils.adoc#IERC165-supportsInterface-bytes4-[`IERC165.supportsInterface`]]
:Governor-state: pass:normal[xref:governance.adoc#Governor-state-uint256-[`Governor.state`]]
:Governor-_cancel: pass:normal[xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-[`Governor._cancel`]]
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:GovernorTimelockCompound-__acceptAdmin: pass:normal[xref:governance.adoc#GovernorTimelockCompound-__acceptAdmin--[`GovernorTimelockCompound.__acceptAdmin`]]
:TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:xref-GovernorTimelockCompound-constructor-contract-ICompoundTimelock-: xref:governance.adoc#GovernorTimelockCompound-constructor-contract-ICompoundTimelock-
:xref-GovernorTimelockCompound-supportsInterface-bytes4-: xref:governance.adoc#GovernorTimelockCompound-supportsInterface-bytes4-
:xref-GovernorTimelockCompound-state-uint256-: xref:governance.adoc#GovernorTimelockCompound-state-uint256-
:xref-GovernorTimelockCompound-timelock--: xref:governance.adoc#GovernorTimelockCompound-timelock--
:xref-GovernorTimelockCompound-proposalEta-uint256-: xref:governance.adoc#GovernorTimelockCompound-proposalEta-uint256-
:xref-GovernorTimelockCompound-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockCompound-queue-address---uint256---bytes---bytes32-
:xref-GovernorTimelockCompound-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockCompound-_execute-uint256-address---uint256---bytes---bytes32-
:xref-GovernorTimelockCompound-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorTimelockCompound-_cancel-address---uint256---bytes---bytes32-
:xref-GovernorTimelockCompound-_executor--: xref:governance.adoc#GovernorTimelockCompound-_executor--
:xref-GovernorTimelockCompound-__acceptAdmin--: xref:governance.adoc#GovernorTimelockCompound-__acceptAdmin--
:xref-GovernorTimelockCompound-updateTimelock-contract-ICompoundTimelock-: xref:governance.adoc#GovernorTimelockCompound-updateTimelock-contract-ICompoundTimelock-
:xref-Governor-receive--: xref:governance.adoc#Governor-receive--
:xref-Governor-name--: xref:governance.adoc#Governor-name--
:xref-Governor-version--: xref:governance.adoc#Governor-version--
:xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
:xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
:xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
:xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
:xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
:xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
:xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
:xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
:xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
:xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
:xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
:xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
:xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
:xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
:xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
:xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
:xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
:xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
:xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
:xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
:xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
:xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
:xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
:xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
:xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
:xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
:xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
:xref-IGovernor-clock--: xref:governance.adoc#IGovernor-clock--
:xref-IGovernor-CLOCK_MODE--: xref:governance.adoc#IGovernor-CLOCK_MODE--
:xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
:xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
:xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
:xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
:xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
:xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
:xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
:xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
:xref-GovernorTimelockCompound-TimelockChange-address-address-: xref:governance.adoc#GovernorTimelockCompound-TimelockChange-address-address-
:xref-IGovernorTimelock-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernorTimelock-ProposalQueued-uint256-uint256-
:xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
:xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
:xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
:xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
:xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
:xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
:IERC165-supportsInterface: pass:normal[xref:utils.adoc#IERC165-supportsInterface-bytes4-[`IERC165.supportsInterface`]]
:Governor-state: pass:normal[xref:governance.adoc#Governor-state-uint256-[`Governor.state`]]
:Governor-_cancel: pass:normal[xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-[`Governor._cancel`]]
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:xref-GovernorSettings-constructor-uint256-uint256-uint256-: xref:governance.adoc#GovernorSettings-constructor-uint256-uint256-uint256-
:xref-GovernorSettings-votingDelay--: xref:governance.adoc#GovernorSettings-votingDelay--
:xref-GovernorSettings-votingPeriod--: xref:governance.adoc#GovernorSettings-votingPeriod--
:xref-GovernorSettings-proposalThreshold--: xref:governance.adoc#GovernorSettings-proposalThreshold--
:xref-GovernorSettings-setVotingDelay-uint256-: xref:governance.adoc#GovernorSettings-setVotingDelay-uint256-
:xref-GovernorSettings-setVotingPeriod-uint256-: xref:governance.adoc#GovernorSettings-setVotingPeriod-uint256-
:xref-GovernorSettings-setProposalThreshold-uint256-: xref:governance.adoc#GovernorSettings-setProposalThreshold-uint256-
:xref-GovernorSettings-_setVotingDelay-uint256-: xref:governance.adoc#GovernorSettings-_setVotingDelay-uint256-
:xref-GovernorSettings-_setVotingPeriod-uint256-: xref:governance.adoc#GovernorSettings-_setVotingPeriod-uint256-
:xref-GovernorSettings-_setProposalThreshold-uint256-: xref:governance.adoc#GovernorSettings-_setProposalThreshold-uint256-
:xref-Governor-receive--: xref:governance.adoc#Governor-receive--
:xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
:xref-Governor-name--: xref:governance.adoc#Governor-name--
:xref-Governor-version--: xref:governance.adoc#Governor-version--
:xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
:xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
:xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
:xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
:xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
:xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
:xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
:xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
:xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
:xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
:xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
:xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
:xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
:xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
:xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
:xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
:xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
:xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
:xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
:xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
:xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
:xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
:xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
:xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
:xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
:xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
:xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
:xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
:xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
:xref-IGovernor-clock--: xref:governance.adoc#IGovernor-clock--
:xref-IGovernor-CLOCK_MODE--: xref:governance.adoc#IGovernor-CLOCK_MODE--
:xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
:xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
:xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
:xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
:xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
:xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
:xref-GovernorSettings-VotingDelaySet-uint256-uint256-: xref:governance.adoc#GovernorSettings-VotingDelaySet-uint256-uint256-
:xref-GovernorSettings-VotingPeriodSet-uint256-uint256-: xref:governance.adoc#GovernorSettings-VotingPeriodSet-uint256-uint256-
:xref-GovernorSettings-ProposalThresholdSet-uint256-uint256-: xref:governance.adoc#GovernorSettings-ProposalThresholdSet-uint256-uint256-
:xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
:xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
:xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
:xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
:xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
:xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
:IGovernor-votingDelay: pass:normal[xref:governance.adoc#IGovernor-votingDelay--[`IGovernor.votingDelay`]]
:IGovernor-votingPeriod: pass:normal[xref:governance.adoc#IGovernor-votingPeriod--[`IGovernor.votingPeriod`]]
:Governor-proposalThreshold: pass:normal[xref:governance.adoc#Governor-proposalThreshold--[`Governor.proposalThreshold`]]
:xref-GovernorPreventLateQuorum-constructor-uint64-: xref:governance.adoc#GovernorPreventLateQuorum-constructor-uint64-
:xref-GovernorPreventLateQuorum-proposalDeadline-uint256-: xref:governance.adoc#GovernorPreventLateQuorum-proposalDeadline-uint256-
:xref-GovernorPreventLateQuorum-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#GovernorPreventLateQuorum-_castVote-uint256-address-uint8-string-bytes-
:xref-GovernorPreventLateQuorum-lateQuorumVoteExtension--: xref:governance.adoc#GovernorPreventLateQuorum-lateQuorumVoteExtension--
:xref-GovernorPreventLateQuorum-setLateQuorumVoteExtension-uint64-: xref:governance.adoc#GovernorPreventLateQuorum-setLateQuorumVoteExtension-uint64-
:xref-GovernorPreventLateQuorum-_setLateQuorumVoteExtension-uint64-: xref:governance.adoc#GovernorPreventLateQuorum-_setLateQuorumVoteExtension-uint64-
:xref-Governor-receive--: xref:governance.adoc#Governor-receive--
:xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
:xref-Governor-name--: xref:governance.adoc#Governor-name--
:xref-Governor-version--: xref:governance.adoc#Governor-version--
:xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
:xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
:xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
:xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
:xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
:xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
:xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
:xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
:xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
:xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
:xref-Governor-propose-address---uint256---bytes---string-: xref:governance.adoc#Governor-propose-address---uint256---bytes---string-
:xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
:xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
:xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
:xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
:xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
:xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
:xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
:xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
:xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
:xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
:xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
:xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
:xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
:xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
:xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
:xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
:xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
:xref-IGovernor-clock--: xref:governance.adoc#IGovernor-clock--
:xref-IGovernor-CLOCK_MODE--: xref:governance.adoc#IGovernor-CLOCK_MODE--
:xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
:xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
:xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
:xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
:xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
:xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
:xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
:xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
:xref-GovernorPreventLateQuorum-ProposalExtended-uint256-uint64-: xref:governance.adoc#GovernorPreventLateQuorum-ProposalExtended-uint256-uint64-
:xref-GovernorPreventLateQuorum-LateQuorumVoteExtensionSet-uint64-uint64-: xref:governance.adoc#GovernorPreventLateQuorum-LateQuorumVoteExtensionSet-uint64-uint64-
:xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
:xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
:xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
:xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
:xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
:xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
:Governor-proposalDeadline: pass:normal[xref:governance.adoc#Governor-proposalDeadline-uint256-[`Governor.proposalDeadline`]]
:Governor-_castVote: pass:normal[xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-[`Governor._castVote`]]
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:IGovernorTimelock: pass:normal[xref:governance.adoc#IGovernorTimelock[`IGovernorTimelock`]]
:xref-GovernorCompatibilityBravo-COUNTING_MODE--: xref:governance.adoc#GovernorCompatibilityBravo-COUNTING_MODE--
:xref-GovernorCompatibilityBravo-propose-address---uint256---bytes---string-: xref:governance.adoc#GovernorCompatibilityBravo-propose-address---uint256---bytes---string-
:xref-GovernorCompatibilityBravo-propose-address---uint256---string---bytes---string-: xref:governance.adoc#GovernorCompatibilityBravo-propose-address---uint256---string---bytes---string-
:xref-GovernorCompatibilityBravo-queue-uint256-: xref:governance.adoc#GovernorCompatibilityBravo-queue-uint256-
:xref-GovernorCompatibilityBravo-execute-uint256-: xref:governance.adoc#GovernorCompatibilityBravo-execute-uint256-
:xref-GovernorCompatibilityBravo-cancel-uint256-: xref:governance.adoc#GovernorCompatibilityBravo-cancel-uint256-
:xref-GovernorCompatibilityBravo-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#GovernorCompatibilityBravo-cancel-address---uint256---bytes---bytes32-
:xref-GovernorCompatibilityBravo-proposals-uint256-: xref:governance.adoc#GovernorCompatibilityBravo-proposals-uint256-
:xref-GovernorCompatibilityBravo-getActions-uint256-: xref:governance.adoc#GovernorCompatibilityBravo-getActions-uint256-
:xref-GovernorCompatibilityBravo-getReceipt-uint256-address-: xref:governance.adoc#GovernorCompatibilityBravo-getReceipt-uint256-address-
:xref-GovernorCompatibilityBravo-quorumVotes--: xref:governance.adoc#GovernorCompatibilityBravo-quorumVotes--
:xref-GovernorCompatibilityBravo-hasVoted-uint256-address-: xref:governance.adoc#GovernorCompatibilityBravo-hasVoted-uint256-address-
:xref-GovernorCompatibilityBravo-_quorumReached-uint256-: xref:governance.adoc#GovernorCompatibilityBravo-_quorumReached-uint256-
:xref-GovernorCompatibilityBravo-_voteSucceeded-uint256-: xref:governance.adoc#GovernorCompatibilityBravo-_voteSucceeded-uint256-
:xref-GovernorCompatibilityBravo-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#GovernorCompatibilityBravo-_countVote-uint256-address-uint8-uint256-bytes-
:xref-Governor-receive--: xref:governance.adoc#Governor-receive--
:xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
:xref-Governor-name--: xref:governance.adoc#Governor-name--
:xref-Governor-version--: xref:governance.adoc#Governor-version--
:xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
:xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
:xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
:xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
:xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
:xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
:xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
:xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
:xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
:xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
:xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
:xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
:xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
:xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
:xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
:xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
:xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
:xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
:xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
:xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
:xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
:xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
:xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
:xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
:xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
:xref-IGovernorTimelock-timelock--: xref:governance.adoc#IGovernorTimelock-timelock--
:xref-IGovernorTimelock-proposalEta-uint256-: xref:governance.adoc#IGovernorTimelock-proposalEta-uint256-
:xref-IGovernorTimelock-queue-address---uint256---bytes---bytes32-: xref:governance.adoc#IGovernorTimelock-queue-address---uint256---bytes---bytes32-
:xref-IGovernor-clock--: xref:governance.adoc#IGovernor-clock--
:xref-IGovernor-CLOCK_MODE--: xref:governance.adoc#IGovernor-CLOCK_MODE--
:xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
:xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
:xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
:xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
:xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
:xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
:xref-IGovernorTimelock-ProposalQueued-uint256-uint256-: xref:governance.adoc#IGovernorTimelock-ProposalQueued-uint256-uint256-
:xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
:xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
:xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
:xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
:xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
:xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
:IGovernor-propose: pass:normal[xref:governance.adoc#IGovernor-propose-address---uint256---bytes---string-[`IGovernor.propose`]]
:IGovernorCompatibilityBravo-propose: pass:normal[xref:governance.adoc#IGovernorCompatibilityBravo-propose-address---uint256---string---bytes---string-[`IGovernorCompatibilityBravo.propose`]]
:IGovernorCompatibilityBravo-queue: pass:normal[xref:governance.adoc#IGovernorCompatibilityBravo-queue-uint256-[`IGovernorCompatibilityBravo.queue`]]
:IGovernorCompatibilityBravo-execute: pass:normal[xref:governance.adoc#IGovernorCompatibilityBravo-execute-uint256-[`IGovernorCompatibilityBravo.execute`]]
:IGovernorCompatibilityBravo-proposals: pass:normal[xref:governance.adoc#IGovernorCompatibilityBravo-proposals-uint256-[`IGovernorCompatibilityBravo.proposals`]]
:IGovernorCompatibilityBravo-getActions: pass:normal[xref:governance.adoc#IGovernorCompatibilityBravo-getActions-uint256-[`IGovernorCompatibilityBravo.getActions`]]
:IGovernorCompatibilityBravo-getReceipt: pass:normal[xref:governance.adoc#IGovernorCompatibilityBravo-getReceipt-uint256-address-[`IGovernorCompatibilityBravo.getReceipt`]]
:IGovernorCompatibilityBravo-quorumVotes: pass:normal[xref:governance.adoc#IGovernorCompatibilityBravo-quorumVotes--[`IGovernorCompatibilityBravo.quorumVotes`]]
:IGovernor-hasVoted: pass:normal[xref:governance.adoc#IGovernor-hasVoted-uint256-address-[`IGovernor.hasVoted`]]
:Governor-_quorumReached: pass:normal[xref:governance.adoc#Governor-_quorumReached-uint256-[`Governor._quorumReached`]]
:Governor-_voteSucceeded: pass:normal[xref:governance.adoc#Governor-_voteSucceeded-uint256-[`Governor._voteSucceeded`]]
:Governor-_countVote: pass:normal[xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-[`Governor._countVote`]]
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:xref-GovernorProposalThreshold-propose-address---uint256---bytes---string-: xref:governance.adoc#GovernorProposalThreshold-propose-address---uint256---bytes---string-
:xref-Governor-receive--: xref:governance.adoc#Governor-receive--
:xref-Governor-supportsInterface-bytes4-: xref:governance.adoc#Governor-supportsInterface-bytes4-
:xref-Governor-name--: xref:governance.adoc#Governor-name--
:xref-Governor-version--: xref:governance.adoc#Governor-version--
:xref-Governor-hashProposal-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-hashProposal-address---uint256---bytes---bytes32-
:xref-Governor-state-uint256-: xref:governance.adoc#Governor-state-uint256-
:xref-Governor-proposalThreshold--: xref:governance.adoc#Governor-proposalThreshold--
:xref-Governor-proposalSnapshot-uint256-: xref:governance.adoc#Governor-proposalSnapshot-uint256-
:xref-Governor-proposalDeadline-uint256-: xref:governance.adoc#Governor-proposalDeadline-uint256-
:xref-Governor-proposalProposer-uint256-: xref:governance.adoc#Governor-proposalProposer-uint256-
:xref-Governor-_quorumReached-uint256-: xref:governance.adoc#Governor-_quorumReached-uint256-
:xref-Governor-_voteSucceeded-uint256-: xref:governance.adoc#Governor-_voteSucceeded-uint256-
:xref-Governor-_getVotes-address-uint256-bytes-: xref:governance.adoc#Governor-_getVotes-address-uint256-bytes-
:xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-: xref:governance.adoc#Governor-_countVote-uint256-address-uint8-uint256-bytes-
:xref-Governor-_defaultParams--: xref:governance.adoc#Governor-_defaultParams--
:xref-Governor-execute-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-execute-address---uint256---bytes---bytes32-
:xref-Governor-cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-cancel-address---uint256---bytes---bytes32-
:xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_execute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-
:xref-Governor-_cancel-address---uint256---bytes---bytes32-: xref:governance.adoc#Governor-_cancel-address---uint256---bytes---bytes32-
:xref-Governor-getVotes-address-uint256-: xref:governance.adoc#Governor-getVotes-address-uint256-
:xref-Governor-getVotesWithParams-address-uint256-bytes-: xref:governance.adoc#Governor-getVotesWithParams-address-uint256-bytes-
:xref-Governor-castVote-uint256-uint8-: xref:governance.adoc#Governor-castVote-uint256-uint8-
:xref-Governor-castVoteWithReason-uint256-uint8-string-: xref:governance.adoc#Governor-castVoteWithReason-uint256-uint8-string-
:xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-: xref:governance.adoc#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-
:xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-
:xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-: xref:governance.adoc#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-
:xref-Governor-_castVote-uint256-address-uint8-string-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-
:xref-Governor-_castVote-uint256-address-uint8-string-bytes-: xref:governance.adoc#Governor-_castVote-uint256-address-uint8-string-bytes-
:xref-Governor-relay-address-uint256-bytes-: xref:governance.adoc#Governor-relay-address-uint256-bytes-
:xref-Governor-_executor--: xref:governance.adoc#Governor-_executor--
:xref-Governor-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#Governor-onERC721Received-address-address-uint256-bytes-
:xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#Governor-onERC1155Received-address-address-uint256-uint256-bytes-
:xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
:xref-Governor-_isValidDescriptionForProposer-address-string-: xref:governance.adoc#Governor-_isValidDescriptionForProposer-address-string-
:xref-IGovernor-clock--: xref:governance.adoc#IGovernor-clock--
:xref-IGovernor-CLOCK_MODE--: xref:governance.adoc#IGovernor-CLOCK_MODE--
:xref-IGovernor-COUNTING_MODE--: xref:governance.adoc#IGovernor-COUNTING_MODE--
:xref-IGovernor-votingDelay--: xref:governance.adoc#IGovernor-votingDelay--
:xref-IGovernor-votingPeriod--: xref:governance.adoc#IGovernor-votingPeriod--
:xref-IGovernor-quorum-uint256-: xref:governance.adoc#IGovernor-quorum-uint256-
:xref-IGovernor-hasVoted-uint256-address-: xref:governance.adoc#IGovernor-hasVoted-uint256-address-
:xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
:xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
:xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
:xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-: xref:governance.adoc#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-
:xref-IGovernor-ProposalCanceled-uint256-: xref:governance.adoc#IGovernor-ProposalCanceled-uint256-
:xref-IGovernor-ProposalExecuted-uint256-: xref:governance.adoc#IGovernor-ProposalExecuted-uint256-
:xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-: xref:governance.adoc#IGovernor-VoteCast-address-uint256-uint8-uint256-string-
:xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-: xref:governance.adoc#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-
:xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
:IGovernor-propose: pass:normal[xref:governance.adoc#IGovernor-propose-address---uint256---bytes---string-[`IGovernor.propose`]]
:ERC721Votes: pass:normal[xref:token/ERC721.adoc#ERC721Votes[`ERC721Votes`]]
:ERC721-balanceOf: pass:normal[xref:token/ERC721.adoc#ERC721-balanceOf-address-[`ERC721.balanceOf`]]
:ERC721-_beforeTokenTransfer: pass:normal[xref:token/ERC721.adoc#ERC721-_beforeTokenTransfer-address-address-uint256-uint256-[`ERC721._beforeTokenTransfer`]]
:xref-Votes-clock--: xref:governance.adoc#Votes-clock--
:xref-Votes-CLOCK_MODE--: xref:governance.adoc#Votes-CLOCK_MODE--
:xref-Votes-getVotes-address-: xref:governance.adoc#Votes-getVotes-address-
:xref-Votes-getPastVotes-address-uint256-: xref:governance.adoc#Votes-getPastVotes-address-uint256-
:xref-Votes-getPastTotalSupply-uint256-: xref:governance.adoc#Votes-getPastTotalSupply-uint256-
:xref-Votes-_getTotalSupply--: xref:governance.adoc#Votes-_getTotalSupply--
:xref-Votes-delegates-address-: xref:governance.adoc#Votes-delegates-address-
:xref-Votes-delegate-address-: xref:governance.adoc#Votes-delegate-address-
:xref-Votes-delegateBySig-address-uint256-uint256-uint8-bytes32-bytes32-: xref:governance.adoc#Votes-delegateBySig-address-uint256-uint256-uint8-bytes32-bytes32-
:xref-Votes-_delegate-address-address-: xref:governance.adoc#Votes-_delegate-address-address-
:xref-Votes-_transferVotingUnits-address-address-uint256-: xref:governance.adoc#Votes-_transferVotingUnits-address-address-uint256-
:xref-Votes-_useNonce-address-: xref:governance.adoc#Votes-_useNonce-address-
:xref-Votes-nonces-address-: xref:governance.adoc#Votes-nonces-address-
:xref-Votes-DOMAIN_SEPARATOR--: xref:governance.adoc#Votes-DOMAIN_SEPARATOR--
:xref-Votes-_getVotingUnits-address-: xref:governance.adoc#Votes-_getVotingUnits-address-
:xref-EIP712-_domainSeparatorV4--: xref:utils.adoc#EIP712-_domainSeparatorV4--
:xref-EIP712-_hashTypedDataV4-bytes32-: xref:utils.adoc#EIP712-_hashTypedDataV4-bytes32-
:xref-EIP712-eip712Domain--: xref:utils.adoc#EIP712-eip712Domain--
:xref-IVotes-DelegateChanged-address-address-address-: xref:governance.adoc#IVotes-DelegateChanged-address-address-address-
:xref-IVotes-DelegateVotesChanged-address-uint256-uint256-: xref:governance.adoc#IVotes-DelegateVotesChanged-address-uint256-uint256-
:xref-IERC5267-EIP712DomainChanged--: xref:interfaces.adoc#IERC5267-EIP712DomainChanged--
:IVotes-DelegateChanged: pass:normal[xref:governance.adoc#IVotes-DelegateChanged-address-address-address-[`IVotes.DelegateChanged`]]
:IVotes-DelegateVotesChanged: pass:normal[xref:governance.adoc#IVotes-DelegateVotesChanged-address-uint256-uint256-[`IVotes.DelegateVotesChanged`]]
:EIP712: pass:normal[xref:utils.adoc#EIP712[`EIP712`]]
:TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
:Governor: pass:normal[xref:governance.adoc#Governor[`Governor`]]
:TimelockController: pass:normal[xref:governance.adoc#TimelockController[`TimelockController`]]
:xref-TimelockController-onlyRoleOrOpenRole-bytes32-: xref:governance.adoc#TimelockController-onlyRoleOrOpenRole-bytes32-
:xref-TimelockController-constructor-uint256-address---address---address-: xref:governance.adoc#TimelockController-constructor-uint256-address---address---address-
:xref-TimelockController-receive--: xref:governance.adoc#TimelockController-receive--
:xref-TimelockController-supportsInterface-bytes4-: xref:governance.adoc#TimelockController-supportsInterface-bytes4-
:xref-TimelockController-isOperation-bytes32-: xref:governance.adoc#TimelockController-isOperation-bytes32-
:xref-TimelockController-isOperationPending-bytes32-: xref:governance.adoc#TimelockController-isOperationPending-bytes32-
:xref-TimelockController-isOperationReady-bytes32-: xref:governance.adoc#TimelockController-isOperationReady-bytes32-
:xref-TimelockController-isOperationDone-bytes32-: xref:governance.adoc#TimelockController-isOperationDone-bytes32-
:xref-TimelockController-getTimestamp-bytes32-: xref:governance.adoc#TimelockController-getTimestamp-bytes32-
:xref-TimelockController-getMinDelay--: xref:governance.adoc#TimelockController-getMinDelay--
:xref-TimelockController-hashOperation-address-uint256-bytes-bytes32-bytes32-: xref:governance.adoc#TimelockController-hashOperation-address-uint256-bytes-bytes32-bytes32-
:xref-TimelockController-hashOperationBatch-address---uint256---bytes---bytes32-bytes32-: xref:governance.adoc#TimelockController-hashOperationBatch-address---uint256---bytes---bytes32-bytes32-
:xref-TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-: xref:governance.adoc#TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-
:xref-TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-: xref:governance.adoc#TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-
:xref-TimelockController-cancel-bytes32-: xref:governance.adoc#TimelockController-cancel-bytes32-
:xref-TimelockController-execute-address-uint256-bytes-bytes32-bytes32-: xref:governance.adoc#TimelockController-execute-address-uint256-bytes-bytes32-bytes32-
:xref-TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-: xref:governance.adoc#TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-
:xref-TimelockController-_execute-address-uint256-bytes-: xref:governance.adoc#TimelockController-_execute-address-uint256-bytes-
:xref-TimelockController-updateDelay-uint256-: xref:governance.adoc#TimelockController-updateDelay-uint256-
:xref-TimelockController-onERC721Received-address-address-uint256-bytes-: xref:governance.adoc#TimelockController-onERC721Received-address-address-uint256-bytes-
:xref-TimelockController-onERC1155Received-address-address-uint256-uint256-bytes-: xref:governance.adoc#TimelockController-onERC1155Received-address-address-uint256-uint256-bytes-
:xref-TimelockController-onERC1155BatchReceived-address-address-uint256---uint256---bytes-: xref:governance.adoc#TimelockController-onERC1155BatchReceived-address-address-uint256---uint256---bytes-
:xref-AccessControl-hasRole-bytes32-address-: xref:access.adoc#AccessControl-hasRole-bytes32-address-
:xref-AccessControl-_checkRole-bytes32-: xref:access.adoc#AccessControl-_checkRole-bytes32-
:xref-AccessControl-_checkRole-bytes32-address-: xref:access.adoc#AccessControl-_checkRole-bytes32-address-
:xref-AccessControl-getRoleAdmin-bytes32-: xref:access.adoc#AccessControl-getRoleAdmin-bytes32-
:xref-AccessControl-grantRole-bytes32-address-: xref:access.adoc#AccessControl-grantRole-bytes32-address-
:xref-AccessControl-revokeRole-bytes32-address-: xref:access.adoc#AccessControl-revokeRole-bytes32-address-
:xref-AccessControl-renounceRole-bytes32-address-: xref:access.adoc#AccessControl-renounceRole-bytes32-address-
:xref-AccessControl-_setupRole-bytes32-address-: xref:access.adoc#AccessControl-_setupRole-bytes32-address-
:xref-AccessControl-_setRoleAdmin-bytes32-bytes32-: xref:access.adoc#AccessControl-_setRoleAdmin-bytes32-bytes32-
:xref-AccessControl-_grantRole-bytes32-address-: xref:access.adoc#AccessControl-_grantRole-bytes32-address-
:xref-AccessControl-_revokeRole-bytes32-address-: xref:access.adoc#AccessControl-_revokeRole-bytes32-address-
:xref-TimelockController-CallScheduled-bytes32-uint256-address-uint256-bytes-bytes32-uint256-: xref:governance.adoc#TimelockController-CallScheduled-bytes32-uint256-address-uint256-bytes-bytes32-uint256-
:xref-TimelockController-CallExecuted-bytes32-uint256-address-uint256-bytes-: xref:governance.adoc#TimelockController-CallExecuted-bytes32-uint256-address-uint256-bytes-
:xref-TimelockController-CallSalt-bytes32-bytes32-: xref:governance.adoc#TimelockController-CallSalt-bytes32-bytes32-
:xref-TimelockController-Cancelled-bytes32-: xref:governance.adoc#TimelockController-Cancelled-bytes32-
:xref-TimelockController-MinDelayChange-uint256-uint256-: xref:governance.adoc#TimelockController-MinDelayChange-uint256-uint256-
:xref-IAccessControl-RoleAdminChanged-bytes32-bytes32-bytes32-: xref:access.adoc#IAccessControl-RoleAdminChanged-bytes32-bytes32-bytes32-
:xref-IAccessControl-RoleGranted-bytes32-address-address-: xref:access.adoc#IAccessControl-RoleGranted-bytes32-address-address-
:xref-IAccessControl-RoleRevoked-bytes32-address-address-: xref:access.adoc#IAccessControl-RoleRevoked-bytes32-address-address-
:IERC165-supportsInterface: pass:normal[xref:utils.adoc#IERC165-supportsInterface-bytes4-[`IERC165.supportsInterface`]]
:IERC721Receiver-onERC721Received: pass:normal[xref:token/ERC721.adoc#IERC721Receiver-onERC721Received-address-address-uint256-bytes-[`IERC721Receiver.onERC721Received`]]
:IERC1155Receiver-onERC1155Received: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155Received-address-address-uint256-uint256-bytes-[`IERC1155Receiver.onERC1155Received`]]
:IERC1155Receiver-onERC1155BatchReceived: pass:normal[xref:token/ERC1155.adoc#IERC1155Receiver-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`IERC1155Receiver.onERC1155BatchReceived`]]
:AccessControl: pass:normal[xref:access.adoc#AccessControl[`AccessControl`]]
= Governance

[.readme-notice]
NOTE: This document is better viewed at https://docs.openzeppelin.com/contracts/api/governance

This directory includes primitives for on-chain governance.

== Governor

This modular system of Governor contracts allows the deployment on-chain voting protocols similar to https://compound.finance/docs/governance[Compound's Governor Alpha & Bravo] and beyond, through the ability to easily customize multiple aspects of the protocol.

[TIP]
====
For a guided experience, set up your Governor contract using https://wizard.openzeppelin.com/#governor[Contracts Wizard].

For a written walkthrough, check out our guide on xref:ROOT:governance.adoc[How to set up on-chain governance].
====

* {Governor}: The core contract that contains all the logic and primitives. It is abstract and requires choosing one of each of the modules below, or custom ones.

Votes modules determine the source of voting power, and sometimes quorum number.

* {GovernorVotes}: Extracts voting weight from an {ERC20Votes}, or since v4.5 an {ERC721Votes} token.

* {GovernorVotesComp}: Extracts voting weight from a COMP-like or {ERC20VotesComp} token.

* {GovernorVotesQuorumFraction}: Combines with `GovernorVotes` to set the quorum as a fraction of the total token supply.

Counting modules determine valid voting options.

* {GovernorCountingSimple}: Simple voting mechanism with 3 voting options: Against, For and Abstain.

Timelock extensions add a delay for governance decisions to be executed. The workflow is extended to require a `queue` step before execution. With these modules, proposals are executed by the external timelock contract, thus it is the timelock that has to hold the assets that are being governed.

* {GovernorTimelockControl}: Connects with an instance of {TimelockController}. Allows multiple proposers and executors, in addition to the Governor itself.

* {GovernorTimelockCompound}: Connects with an instance of Compound's https://github.com/compound-finance/compound-protocol/blob/master/contracts/Timelock.sol[`Timelock`] contract.

Other extensions can customize the behavior or interface in multiple ways.

* {GovernorCompatibilityBravo}: Extends the interface to be fully `GovernorBravo`-compatible. Note that events are compatible regardless of whether this extension is included or not.

* {GovernorSettings}: Manages some of the settings (voting delay, voting period duration, and proposal threshold) in a way that can be updated through a governance proposal, without requiring an upgrade.

* {GovernorPreventLateQuorum}: Ensures there is a minimum voting period after quorum is reached as a security protection against large voters.

In addition to modules and extensions, the core contract requires a few virtual functions to be implemented to your particular specifications:

* <<Governor-votingDelay-,`votingDelay()`>>: Delay (in EIP-6372 clock) since the proposal is submitted until voting power is fixed and voting starts. This can be used to enforce a delay after a proposal is published for users to buy tokens, or delegate their votes.
* <<Governor-votingPeriod-,`votingPeriod()`>>: Delay (in EIP-6372 clock) since the proposal starts until voting ends.
* <<Governor-quorum-uint256-,`quorum(uint256 timepoint)`>>: Quorum required for a proposal to be successful. This function includes a `timepoint` argument (see EIP-6372) so the quorum can adapt through time, for example, to follow a token's `totalSupply`.

NOTE: Functions of the `Governor` contract do not include access control. If you want to restrict access, you should add these checks by overloading the particular functions. Among these, {Governor-_cancel} is internal by default, and you will have to expose it (with the right access control mechanism) yourself if this function is needed.

=== Core

:ProposalState: pass:normal[xref:#IGovernor-ProposalState[`++ProposalState++`]]
:ProposalCreated: pass:normal[xref:#IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-[`++ProposalCreated++`]]
:ProposalCanceled: pass:normal[xref:#IGovernor-ProposalCanceled-uint256-[`++ProposalCanceled++`]]
:ProposalExecuted: pass:normal[xref:#IGovernor-ProposalExecuted-uint256-[`++ProposalExecuted++`]]
:VoteCast: pass:normal[xref:#IGovernor-VoteCast-address-uint256-uint8-uint256-string-[`++VoteCast++`]]
:VoteCastWithParams: pass:normal[xref:#IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-[`++VoteCastWithParams++`]]
:name: pass:normal[xref:#IGovernor-name--[`++name++`]]
:version: pass:normal[xref:#IGovernor-version--[`++version++`]]
:clock: pass:normal[xref:#IGovernor-clock--[`++clock++`]]
:CLOCK_MODE: pass:normal[xref:#IGovernor-CLOCK_MODE--[`++CLOCK_MODE++`]]
:COUNTING_MODE: pass:normal[xref:#IGovernor-COUNTING_MODE--[`++COUNTING_MODE++`]]
:hashProposal: pass:normal[xref:#IGovernor-hashProposal-address---uint256---bytes---bytes32-[`++hashProposal++`]]
:state: pass:normal[xref:#IGovernor-state-uint256-[`++state++`]]
:proposalSnapshot: pass:normal[xref:#IGovernor-proposalSnapshot-uint256-[`++proposalSnapshot++`]]
:proposalDeadline: pass:normal[xref:#IGovernor-proposalDeadline-uint256-[`++proposalDeadline++`]]
:proposalProposer: pass:normal[xref:#IGovernor-proposalProposer-uint256-[`++proposalProposer++`]]
:votingDelay: pass:normal[xref:#IGovernor-votingDelay--[`++votingDelay++`]]
:votingPeriod: pass:normal[xref:#IGovernor-votingPeriod--[`++votingPeriod++`]]
:quorum: pass:normal[xref:#IGovernor-quorum-uint256-[`++quorum++`]]
:getVotes: pass:normal[xref:#IGovernor-getVotes-address-uint256-[`++getVotes++`]]
:getVotesWithParams: pass:normal[xref:#IGovernor-getVotesWithParams-address-uint256-bytes-[`++getVotesWithParams++`]]
:hasVoted: pass:normal[xref:#IGovernor-hasVoted-uint256-address-[`++hasVoted++`]]
:propose: pass:normal[xref:#IGovernor-propose-address---uint256---bytes---string-[`++propose++`]]
:execute: pass:normal[xref:#IGovernor-execute-address---uint256---bytes---bytes32-[`++execute++`]]
:cancel: pass:normal[xref:#IGovernor-cancel-address---uint256---bytes---bytes32-[`++cancel++`]]
:castVote: pass:normal[xref:#IGovernor-castVote-uint256-uint8-[`++castVote++`]]
:castVoteWithReason: pass:normal[xref:#IGovernor-castVoteWithReason-uint256-uint8-string-[`++castVoteWithReason++`]]
:castVoteWithReasonAndParams: pass:normal[xref:#IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-[`++castVoteWithReasonAndParams++`]]
:castVoteBySig: pass:normal[xref:#IGovernor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-[`++castVoteBySig++`]]
:castVoteWithReasonAndParamsBySig: pass:normal[xref:#IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-[`++castVoteWithReasonAndParamsBySig++`]]

[.contract]
[[IGovernor]]
=== `++IGovernor++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.5/contracts/governance/IGovernor.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
import "@openzeppelin/contracts/governance/IGovernor.sol";
```

Interface of the {Governor} core.

_Available since v4.3._

[.contract-index]
.Functions
--
* {xref-IGovernor-name--}[`++name()++`]
* {xref-IGovernor-version--}[`++version()++`]
* {xref-IGovernor-clock--}[`++clock()++`]
* {xref-IGovernor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
* {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
* {xref-IGovernor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
* {xref-IGovernor-state-uint256-}[`++state(proposalId)++`]
* {xref-IGovernor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
* {xref-IGovernor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
* {xref-IGovernor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
* {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
* {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
* {xref-IGovernor-quorum-uint256-}[`++quorum(timepoint)++`]
* {xref-IGovernor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
* {xref-IGovernor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
* {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
* {xref-IGovernor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
* {xref-IGovernor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
* {xref-IGovernor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-IGovernor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
* {xref-IGovernor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
* {xref-IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
* {xref-IGovernor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
* {xref-IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.IERC165
* {xref-IERC165-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]

--

[.contract-index]
.Events
--
* {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
* {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
* {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
* {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
* {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.IERC165

--

[.contract-item]
[[IGovernor-name--]]
==== `[.contract-item-name]#++name++#++() → string++` [.item-kind]#public#

Name of the governor instance (used in building the ERC712 domain separator).

[.contract-item]
[[IGovernor-version--]]
==== `[.contract-item-name]#++version++#++() → string++` [.item-kind]#public#

Version of the governor instance (used in building the ERC712 domain separator). Default: "1"

[.contract-item]
[[IGovernor-clock--]]
==== `[.contract-item-name]#++clock++#++() → uint48++` [.item-kind]#public#

See {IERC6372}

[.contract-item]
[[IGovernor-CLOCK_MODE--]]
==== `[.contract-item-name]#++CLOCK_MODE++#++() → string++` [.item-kind]#public#

See EIP-6372.

[.contract-item]
[[IGovernor-COUNTING_MODE--]]
==== `[.contract-item-name]#++COUNTING_MODE++#++() → string++` [.item-kind]#public#

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[`URLSearchParams`]
JavaScript class.

[.contract-item]
[[IGovernor-hashProposal-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++hashProposal++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#public#

Hashing function used to (re)build the proposal id from the proposal details..

[.contract-item]
[[IGovernor-state-uint256-]]
==== `[.contract-item-name]#++state++#++(uint256 proposalId) → enum IGovernor.ProposalState++` [.item-kind]#public#

Current state of a proposal, following Compound's convention

[.contract-item]
[[IGovernor-proposalSnapshot-uint256-]]
==== `[.contract-item-name]#++proposalSnapshot++#++(uint256 proposalId) → uint256++` [.item-kind]#public#

Timepoint used to retrieve user's votes and quorum. If using block number (as per Compound's Comp), the
snapshot is performed at the end of this block. Hence, voting for this proposal starts at the beginning of the
following block.

[.contract-item]
[[IGovernor-proposalDeadline-uint256-]]
==== `[.contract-item-name]#++proposalDeadline++#++(uint256 proposalId) → uint256++` [.item-kind]#public#

Timepoint at which votes close. If using block number, votes close at the end of this block, so it is
possible to cast a vote during this block.

[.contract-item]
[[IGovernor-proposalProposer-uint256-]]
==== `[.contract-item-name]#++proposalProposer++#++(uint256 proposalId) → address++` [.item-kind]#public#

The account that created a proposal.

[.contract-item]
[[IGovernor-votingDelay--]]
==== `[.contract-item-name]#++votingDelay++#++() → uint256++` [.item-kind]#public#

Delay, between the proposal is created and the vote starts. The unit this duration is expressed in depends
on the clock (see EIP-6372) this contract uses.

This can be increased to leave time for users to buy voting power, or delegate it, before the voting of a
proposal starts.

[.contract-item]
[[IGovernor-votingPeriod--]]
==== `[.contract-item-name]#++votingPeriod++#++() → uint256++` [.item-kind]#public#

Delay between the vote start and vote end. The unit this duration is expressed in depends on the clock
(see EIP-6372) this contract uses.

NOTE: The {votingDelay} can delay the start of the vote. This must be considered when setting the voting
duration compared to the voting delay.

[.contract-item]
[[IGovernor-quorum-uint256-]]
==== `[.contract-item-name]#++quorum++#++(uint256 timepoint) → uint256++` [.item-kind]#public#

Minimum number of cast voted required for a proposal to be successful.

NOTE: The `timepoint` 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 timepoint (see {ERC20Votes}).

[.contract-item]
[[IGovernor-getVotes-address-uint256-]]
==== `[.contract-item-name]#++getVotes++#++(address account, uint256 timepoint) → uint256++` [.item-kind]#public#

Voting power of an `account` at a specific `timepoint`.

Note: this can be implemented in a number of ways, for example by reading the delegated balance from one (or
multiple), {ERC20Votes} tokens.

[.contract-item]
[[IGovernor-getVotesWithParams-address-uint256-bytes-]]
==== `[.contract-item-name]#++getVotesWithParams++#++(address account, uint256 timepoint, bytes params) → uint256++` [.item-kind]#public#

Voting power of an `account` at a specific `timepoint` given additional encoded parameters.

[.contract-item]
[[IGovernor-hasVoted-uint256-address-]]
==== `[.contract-item-name]#++hasVoted++#++(uint256 proposalId, address account) → bool++` [.item-kind]#public#

Returns whether `account` has cast a vote on `proposalId`.

[.contract-item]
[[IGovernor-propose-address---uint256---bytes---string-]]
==== `[.contract-item-name]#++propose++#++(address[] targets, uint256[] values, bytes[] calldatas, string description) → uint256 proposalId++` [.item-kind]#public#

Create a new proposal. Vote start after a delay specified by {IGovernor-votingDelay} and lasts for a
duration specified by {IGovernor-votingPeriod}.

Emits a {ProposalCreated} event.

[.contract-item]
[[IGovernor-execute-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++execute++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256 proposalId++` [.item-kind]#public#

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.

[.contract-item]
[[IGovernor-cancel-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++cancel++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256 proposalId++` [.item-kind]#public#

Cancel a proposal. A proposal is cancellable by the proposer, but only while it is Pending state, i.e.
before the vote starts.

Emits a {ProposalCanceled} event.

[.contract-item]
[[IGovernor-castVote-uint256-uint8-]]
==== `[.contract-item-name]#++castVote++#++(uint256 proposalId, uint8 support) → uint256 balance++` [.item-kind]#public#

Cast a vote

Emits a {VoteCast} event.

[.contract-item]
[[IGovernor-castVoteWithReason-uint256-uint8-string-]]
==== `[.contract-item-name]#++castVoteWithReason++#++(uint256 proposalId, uint8 support, string reason) → uint256 balance++` [.item-kind]#public#

Cast a vote with a reason

Emits a {VoteCast} event.

[.contract-item]
[[IGovernor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-]]
==== `[.contract-item-name]#++castVoteWithReasonAndParams++#++(uint256 proposalId, uint8 support, string reason, bytes params) → uint256 balance++` [.item-kind]#public#

Cast a vote with a reason and additional encoded parameters

Emits a {VoteCast} or {VoteCastWithParams} event depending on the length of params.

[.contract-item]
[[IGovernor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-]]
==== `[.contract-item-name]#++castVoteBySig++#++(uint256 proposalId, uint8 support, uint8 v, bytes32 r, bytes32 s) → uint256 balance++` [.item-kind]#public#

Cast a vote using the user's cryptographic signature.

Emits a {VoteCast} event.

[.contract-item]
[[IGovernor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-]]
==== `[.contract-item-name]#++castVoteWithReasonAndParamsBySig++#++(uint256 proposalId, uint8 support, string reason, bytes params, uint8 v, bytes32 r, bytes32 s) → uint256 balance++` [.item-kind]#public#

Cast a vote with a reason and additional encoded parameters using the user's cryptographic signature.

Emits a {VoteCast} or {VoteCastWithParams} event depending on the length of params.

[.contract-item]
[[IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-]]
==== `[.contract-item-name]#++ProposalCreated++#++(uint256 proposalId, address proposer, address[] targets, uint256[] values, string[] signatures, bytes[] calldatas, uint256 voteStart, uint256 voteEnd, string description)++` [.item-kind]#event#

Emitted when a proposal is created.

[.contract-item]
[[IGovernor-ProposalCanceled-uint256-]]
==== `[.contract-item-name]#++ProposalCanceled++#++(uint256 proposalId)++` [.item-kind]#event#

Emitted when a proposal is canceled.

[.contract-item]
[[IGovernor-ProposalExecuted-uint256-]]
==== `[.contract-item-name]#++ProposalExecuted++#++(uint256 proposalId)++` [.item-kind]#event#

Emitted when a proposal is executed.

[.contract-item]
[[IGovernor-VoteCast-address-uint256-uint8-uint256-string-]]
==== `[.contract-item-name]#++VoteCast++#++(address indexed voter, uint256 proposalId, uint8 support, uint256 weight, string reason)++` [.item-kind]#event#

Emitted when a vote is cast without params.

Note: `support` values should be seen as buckets. Their interpretation depends on the voting module used.

[.contract-item]
[[IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-]]
==== `[.contract-item-name]#++VoteCastWithParams++#++(address indexed voter, uint256 proposalId, uint8 support, uint256 weight, string reason, bytes params)++` [.item-kind]#event#

Emitted when a vote is cast with params.

Note: `support` values should be seen as buckets. Their interpretation depends on the voting module used.
`params` are additional encoded parameters. Their interpepretation also depends on the voting module used.

:BALLOT_TYPEHASH: pass:normal[xref:#Governor-BALLOT_TYPEHASH-bytes32[`++BALLOT_TYPEHASH++`]]
:EXTENDED_BALLOT_TYPEHASH: pass:normal[xref:#Governor-EXTENDED_BALLOT_TYPEHASH-bytes32[`++EXTENDED_BALLOT_TYPEHASH++`]]
:ProposalCore: pass:normal[xref:#Governor-ProposalCore[`++ProposalCore++`]]
:onlyGovernance: pass:normal[xref:#Governor-onlyGovernance--[`++onlyGovernance++`]]
:constructor: pass:normal[xref:#Governor-constructor-string-[`++constructor++`]]
:receive: pass:normal[xref:#Governor-receive--[`++receive++`]]
:supportsInterface: pass:normal[xref:#Governor-supportsInterface-bytes4-[`++supportsInterface++`]]
:name: pass:normal[xref:#Governor-name--[`++name++`]]
:version: pass:normal[xref:#Governor-version--[`++version++`]]
:hashProposal: pass:normal[xref:#Governor-hashProposal-address---uint256---bytes---bytes32-[`++hashProposal++`]]
:state: pass:normal[xref:#Governor-state-uint256-[`++state++`]]
:proposalThreshold: pass:normal[xref:#Governor-proposalThreshold--[`++proposalThreshold++`]]
:proposalSnapshot: pass:normal[xref:#Governor-proposalSnapshot-uint256-[`++proposalSnapshot++`]]
:proposalDeadline: pass:normal[xref:#Governor-proposalDeadline-uint256-[`++proposalDeadline++`]]
:proposalProposer: pass:normal[xref:#Governor-proposalProposer-uint256-[`++proposalProposer++`]]
:_quorumReached: pass:normal[xref:#Governor-_quorumReached-uint256-[`++_quorumReached++`]]
:_voteSucceeded: pass:normal[xref:#Governor-_voteSucceeded-uint256-[`++_voteSucceeded++`]]
:_getVotes: pass:normal[xref:#Governor-_getVotes-address-uint256-bytes-[`++_getVotes++`]]
:_countVote: pass:normal[xref:#Governor-_countVote-uint256-address-uint8-uint256-bytes-[`++_countVote++`]]
:_defaultParams: pass:normal[xref:#Governor-_defaultParams--[`++_defaultParams++`]]
:propose: pass:normal[xref:#Governor-propose-address---uint256---bytes---string-[`++propose++`]]
:execute: pass:normal[xref:#Governor-execute-address---uint256---bytes---bytes32-[`++execute++`]]
:cancel: pass:normal[xref:#Governor-cancel-address---uint256---bytes---bytes32-[`++cancel++`]]
:_execute: pass:normal[xref:#Governor-_execute-uint256-address---uint256---bytes---bytes32-[`++_execute++`]]
:_beforeExecute: pass:normal[xref:#Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-[`++_beforeExecute++`]]
:_afterExecute: pass:normal[xref:#Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-[`++_afterExecute++`]]
:_cancel: pass:normal[xref:#Governor-_cancel-address---uint256---bytes---bytes32-[`++_cancel++`]]
:getVotes: pass:normal[xref:#Governor-getVotes-address-uint256-[`++getVotes++`]]
:getVotesWithParams: pass:normal[xref:#Governor-getVotesWithParams-address-uint256-bytes-[`++getVotesWithParams++`]]
:castVote: pass:normal[xref:#Governor-castVote-uint256-uint8-[`++castVote++`]]
:castVoteWithReason: pass:normal[xref:#Governor-castVoteWithReason-uint256-uint8-string-[`++castVoteWithReason++`]]
:castVoteWithReasonAndParams: pass:normal[xref:#Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-[`++castVoteWithReasonAndParams++`]]
:castVoteBySig: pass:normal[xref:#Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-[`++castVoteBySig++`]]
:castVoteWithReasonAndParamsBySig: pass:normal[xref:#Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-[`++castVoteWithReasonAndParamsBySig++`]]
:_castVote: pass:normal[xref:#Governor-_castVote-uint256-address-uint8-string-[`++_castVote++`]]
:_castVote: pass:normal[xref:#Governor-_castVote-uint256-address-uint8-string-bytes-[`++_castVote++`]]
:relay: pass:normal[xref:#Governor-relay-address-uint256-bytes-[`++relay++`]]
:_executor: pass:normal[xref:#Governor-_executor--[`++_executor++`]]
:onERC721Received: pass:normal[xref:#Governor-onERC721Received-address-address-uint256-bytes-[`++onERC721Received++`]]
:onERC1155Received: pass:normal[xref:#Governor-onERC1155Received-address-address-uint256-uint256-bytes-[`++onERC1155Received++`]]
:onERC1155BatchReceived: pass:normal[xref:#Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`++onERC1155BatchReceived++`]]
:_isValidDescriptionForProposer: pass:normal[xref:#Governor-_isValidDescriptionForProposer-address-string-[`++_isValidDescriptionForProposer++`]]

[.contract]
[[Governor]]
=== `++Governor++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.5/contracts/governance/Governor.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
import "@openzeppelin/contracts/governance/Governor.sol";
```

Core of the governance system, designed to be extended though various modules.

This contract is abstract and requires several functions to be implemented in various modules:

- A counting module must implement {quorum}, {_quorumReached}, {_voteSucceeded} and {_countVote}
- A voting module must implement {_getVotes}
- Additionally, {votingPeriod} must also be implemented

_Available since v4.3._

[.contract-index]
.Modifiers
--
* {xref-Governor-onlyGovernance--}[`++onlyGovernance()++`]
--

[.contract-index]
.Functions
--
* {xref-Governor-constructor-string-}[`++constructor(name_)++`]
* {xref-Governor-receive--}[`++receive()++`]
* {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
* {xref-Governor-name--}[`++name()++`]
* {xref-Governor-version--}[`++version()++`]
* {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-state-uint256-}[`++state(proposalId)++`]
* {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
* {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
* {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
* {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
* {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
* {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
* {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, params)++`]
* {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
* {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
* {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
* {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
* {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
* {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
* {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
* {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
* {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
* {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
* {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
* {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
* {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
* {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
* {xref-Governor-_executor--}[`++_executor()++`]
* {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
* {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
* {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
* {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-clock--}[`++clock()++`]
* {xref-IGovernor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
* {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
* {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
* {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
* {xref-IGovernor-quorum-uint256-}[`++quorum(timepoint)++`]
* {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712
* {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
* {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
* {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]

[.contract-subindex-inherited]
.IERC5267

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-index]
.Events
--

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
* {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
* {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
* {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
* {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712

[.contract-subindex-inherited]
.IERC5267
* {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-item]
[[Governor-onlyGovernance--]]
==== `[.contract-item-name]#++onlyGovernance++#++()++` [.item-kind]#modifier#

Restricts a function so it can only be executed through governance proposals. For example, governance
parameter setters in {GovernorSettings} are protected using this modifier.

The governance executing address may be different from the Governor's own address, for example it could be a
timelock. This can be customized by modules by overriding {_executor}. The executor is only able to invoke these
functions during the execution of the governor's {execute} function, and not under any other circumstances. Thus,
for example, additional timelock proposers are not able to change governance parameters without going through the
governance protocol (since v4.6).

[.contract-item]
[[Governor-constructor-string-]]
==== `[.contract-item-name]#++constructor++#++(string name_)++` [.item-kind]#internal#

Sets the value for {name} and {version}

[.contract-item]
[[Governor-receive--]]
==== `[.contract-item-name]#++receive++#++()++` [.item-kind]#external#

Function to receive ETH that will be handled by the governor (disabled if executor is a third party contract)

[.contract-item]
[[Governor-supportsInterface-bytes4-]]
==== `[.contract-item-name]#++supportsInterface++#++(bytes4 interfaceId) → bool++` [.item-kind]#public#

See {IERC165-supportsInterface}.

[.contract-item]
[[Governor-name--]]
==== `[.contract-item-name]#++name++#++() → string++` [.item-kind]#public#

See {IGovernor-name}.

[.contract-item]
[[Governor-version--]]
==== `[.contract-item-name]#++version++#++() → string++` [.item-kind]#public#

See {IGovernor-version}.

[.contract-item]
[[Governor-hashProposal-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++hashProposal++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#public#

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.

[.contract-item]
[[Governor-state-uint256-]]
==== `[.contract-item-name]#++state++#++(uint256 proposalId) → enum IGovernor.ProposalState++` [.item-kind]#public#

See {IGovernor-state}.

[.contract-item]
[[Governor-proposalThreshold--]]
==== `[.contract-item-name]#++proposalThreshold++#++() → uint256++` [.item-kind]#public#

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

[.contract-item]
[[Governor-proposalSnapshot-uint256-]]
==== `[.contract-item-name]#++proposalSnapshot++#++(uint256 proposalId) → uint256++` [.item-kind]#public#

See {IGovernor-proposalSnapshot}.

[.contract-item]
[[Governor-proposalDeadline-uint256-]]
==== `[.contract-item-name]#++proposalDeadline++#++(uint256 proposalId) → uint256++` [.item-kind]#public#

See {IGovernor-proposalDeadline}.

[.contract-item]
[[Governor-proposalProposer-uint256-]]
==== `[.contract-item-name]#++proposalProposer++#++(uint256 proposalId) → address++` [.item-kind]#public#

Returns the account that created a given proposal.

[.contract-item]
[[Governor-_quorumReached-uint256-]]
==== `[.contract-item-name]#++_quorumReached++#++(uint256 proposalId) → bool++` [.item-kind]#internal#

Amount of votes already cast passes the threshold limit.

[.contract-item]
[[Governor-_voteSucceeded-uint256-]]
==== `[.contract-item-name]#++_voteSucceeded++#++(uint256 proposalId) → bool++` [.item-kind]#internal#

Is the proposal successful or not.

[.contract-item]
[[Governor-_getVotes-address-uint256-bytes-]]
==== `[.contract-item-name]#++_getVotes++#++(address account, uint256 timepoint, bytes params) → uint256++` [.item-kind]#internal#

Get the voting weight of `account` at a specific `timepoint`, for a vote as described by `params`.

[.contract-item]
[[Governor-_countVote-uint256-address-uint8-uint256-bytes-]]
==== `[.contract-item-name]#++_countVote++#++(uint256 proposalId, address account, uint8 support, uint256 weight, bytes params)++` [.item-kind]#internal#

Register a vote for `proposalId` by `account` with a given `support`, voting `weight` and voting `params`.

Note: Support is generic and can represent various things depending on the voting system used.

[.contract-item]
[[Governor-_defaultParams--]]
==== `[.contract-item-name]#++_defaultParams++#++() → bytes++` [.item-kind]#internal#

Default additional encoded parameters used by castVote methods that don't include them

Note: Should be overridden by specific implementations to use an appropriate value, the
meaning of the additional params, in the context of that implementation

[.contract-item]
[[Governor-propose-address---uint256---bytes---string-]]
==== `[.contract-item-name]#++propose++#++(address[] targets, uint256[] values, bytes[] calldatas, string description) → uint256++` [.item-kind]#public#

See {IGovernor-propose}. This function has opt-in frontrunning protection, described in {_isValidDescriptionForProposer}.

[.contract-item]
[[Governor-execute-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++execute++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#public#

See {IGovernor-execute}.

[.contract-item]
[[Governor-cancel-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++cancel++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#public#

See {IGovernor-cancel}.

[.contract-item]
[[Governor-_execute-uint256-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++_execute++#++(uint256, address[] targets, uint256[] values, bytes[] calldatas, bytes32)++` [.item-kind]#internal#

Internal execution mechanism. Can be overridden to implement different execution mechanism

[.contract-item]
[[Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++_beforeExecute++#++(uint256, address[] targets, uint256[], bytes[] calldatas, bytes32)++` [.item-kind]#internal#

Hook before execution is triggered.

[.contract-item]
[[Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++_afterExecute++#++(uint256, address[], uint256[], bytes[], bytes32)++` [.item-kind]#internal#

Hook after execution is triggered.

[.contract-item]
[[Governor-_cancel-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++_cancel++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#internal#

Internal cancel mechanism: locks up the proposal timer, preventing it from being re-submitted. Marks it as
canceled to allow distinguishing it from executed proposals.

Emits a {IGovernor-ProposalCanceled} event.

[.contract-item]
[[Governor-getVotes-address-uint256-]]
==== `[.contract-item-name]#++getVotes++#++(address account, uint256 timepoint) → uint256++` [.item-kind]#public#

See {IGovernor-getVotes}.

[.contract-item]
[[Governor-getVotesWithParams-address-uint256-bytes-]]
==== `[.contract-item-name]#++getVotesWithParams++#++(address account, uint256 timepoint, bytes params) → uint256++` [.item-kind]#public#

See {IGovernor-getVotesWithParams}.

[.contract-item]
[[Governor-castVote-uint256-uint8-]]
==== `[.contract-item-name]#++castVote++#++(uint256 proposalId, uint8 support) → uint256++` [.item-kind]#public#

See {IGovernor-castVote}.

[.contract-item]
[[Governor-castVoteWithReason-uint256-uint8-string-]]
==== `[.contract-item-name]#++castVoteWithReason++#++(uint256 proposalId, uint8 support, string reason) → uint256++` [.item-kind]#public#

See {IGovernor-castVoteWithReason}.

[.contract-item]
[[Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-]]
==== `[.contract-item-name]#++castVoteWithReasonAndParams++#++(uint256 proposalId, uint8 support, string reason, bytes params) → uint256++` [.item-kind]#public#

See {IGovernor-castVoteWithReasonAndParams}.

[.contract-item]
[[Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-]]
==== `[.contract-item-name]#++castVoteBySig++#++(uint256 proposalId, uint8 support, uint8 v, bytes32 r, bytes32 s) → uint256++` [.item-kind]#public#

See {IGovernor-castVoteBySig}.

[.contract-item]
[[Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-]]
==== `[.contract-item-name]#++castVoteWithReasonAndParamsBySig++#++(uint256 proposalId, uint8 support, string reason, bytes params, uint8 v, bytes32 r, bytes32 s) → uint256++` [.item-kind]#public#

See {IGovernor-castVoteWithReasonAndParamsBySig}.

[.contract-item]
[[Governor-_castVote-uint256-address-uint8-string-]]
==== `[.contract-item-name]#++_castVote++#++(uint256 proposalId, address account, uint8 support, string reason) → uint256++` [.item-kind]#internal#

Internal vote casting mechanism: Check that the vote is pending, that it has not been cast yet, retrieve
voting weight using {IGovernor-getVotes} and call the {_countVote} internal function. Uses the _defaultParams().

Emits a {IGovernor-VoteCast} event.

[.contract-item]
[[Governor-_castVote-uint256-address-uint8-string-bytes-]]
==== `[.contract-item-name]#++_castVote++#++(uint256 proposalId, address account, uint8 support, string reason, bytes params) → uint256++` [.item-kind]#internal#

Internal vote casting mechanism: Check that the vote is pending, that it has not been cast yet, retrieve
voting weight using {IGovernor-getVotes} and call the {_countVote} internal function.

Emits a {IGovernor-VoteCast} event.

[.contract-item]
[[Governor-relay-address-uint256-bytes-]]
==== `[.contract-item-name]#++relay++#++(address target, uint256 value, bytes data)++` [.item-kind]#external#

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.

[.contract-item]
[[Governor-_executor--]]
==== `[.contract-item-name]#++_executor++#++() → address++` [.item-kind]#internal#

Address through which the governor executes action. Will be overloaded by module that execute actions
through another contract such as a timelock.

[.contract-item]
[[Governor-onERC721Received-address-address-uint256-bytes-]]
==== `[.contract-item-name]#++onERC721Received++#++(address, address, uint256, bytes) → bytes4++` [.item-kind]#public#

See {IERC721Receiver-onERC721Received}.

[.contract-item]
[[Governor-onERC1155Received-address-address-uint256-uint256-bytes-]]
==== `[.contract-item-name]#++onERC1155Received++#++(address, address, uint256, uint256, bytes) → bytes4++` [.item-kind]#public#

See {IERC1155Receiver-onERC1155Received}.

[.contract-item]
[[Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-]]
==== `[.contract-item-name]#++onERC1155BatchReceived++#++(address, address, uint256[], uint256[], bytes) → bytes4++` [.item-kind]#public#

See {IERC1155Receiver-onERC1155BatchReceived}.

[.contract-item]
[[Governor-_isValidDescriptionForProposer-address-string-]]
==== `[.contract-item-name]#++_isValidDescriptionForProposer++#++(address proposer, string description) → bool++` [.item-kind]#internal#

Check if the proposer is authorized to submit a proposal with the given description.

If the proposal description ends with `#proposer=0x???`, where `0x???` is an address written as a hex string
(case insensitive), then the submission of this proposal will only be authorized to said address.

This is used for frontrunning protection. By adding this pattern at the end of their proposal, one can ensure
that no other address can submit the same proposal. An attacker would have to either remove or change that part,
which would result in a different proposal id.

If the description does not match this pattern, it is unrestricted and anyone can submit it. This includes:
- If the `0x???` part is not a valid hex string.
- If the `0x???` part is a valid hex string, but does not contain exactly 40 hex digits.
- If it ends with the expected suffix followed by newlines or other whitespace.
- If it ends with some other similar suffix, e.g. `#other=abc`.
- If it does not end with any such suffix.

=== Modules

:VoteType: pass:normal[xref:#GovernorCountingSimple-VoteType[`++VoteType++`]]
:ProposalVote: pass:normal[xref:#GovernorCountingSimple-ProposalVote[`++ProposalVote++`]]
:COUNTING_MODE: pass:normal[xref:#GovernorCountingSimple-COUNTING_MODE--[`++COUNTING_MODE++`]]
:hasVoted: pass:normal[xref:#GovernorCountingSimple-hasVoted-uint256-address-[`++hasVoted++`]]
:proposalVotes: pass:normal[xref:#GovernorCountingSimple-proposalVotes-uint256-[`++proposalVotes++`]]
:_quorumReached: pass:normal[xref:#GovernorCountingSimple-_quorumReached-uint256-[`++_quorumReached++`]]
:_voteSucceeded: pass:normal[xref:#GovernorCountingSimple-_voteSucceeded-uint256-[`++_voteSucceeded++`]]
:_countVote: pass:normal[xref:#GovernorCountingSimple-_countVote-uint256-address-uint8-uint256-bytes-[`++_countVote++`]]

[.contract]
[[GovernorCountingSimple]]
=== `++GovernorCountingSimple++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.5/contracts/governance/extensions/GovernorCountingSimple.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
import "@openzeppelin/contracts/governance/extensions/GovernorCountingSimple.sol";
```

Extension of {Governor} for simple, 3 options, vote counting.

_Available since v4.3._

[.contract-index]
.Functions
--
* {xref-GovernorCountingSimple-COUNTING_MODE--}[`++COUNTING_MODE()++`]
* {xref-GovernorCountingSimple-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
* {xref-GovernorCountingSimple-proposalVotes-uint256-}[`++proposalVotes(proposalId)++`]
* {xref-GovernorCountingSimple-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
* {xref-GovernorCountingSimple-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
* {xref-GovernorCountingSimple-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, )++`]

[.contract-subindex-inherited]
.Governor
* {xref-Governor-receive--}[`++receive()++`]
* {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
* {xref-Governor-name--}[`++name()++`]
* {xref-Governor-version--}[`++version()++`]
* {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-state-uint256-}[`++state(proposalId)++`]
* {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
* {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
* {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
* {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
* {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, params)++`]
* {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
* {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
* {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
* {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
* {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
* {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
* {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
* {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
* {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
* {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
* {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
* {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
* {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
* {xref-Governor-_executor--}[`++_executor()++`]
* {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
* {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
* {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
* {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-clock--}[`++clock()++`]
* {xref-IGovernor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
* {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
* {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
* {xref-IGovernor-quorum-uint256-}[`++quorum(timepoint)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712
* {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
* {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
* {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]

[.contract-subindex-inherited]
.IERC5267

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-index]
.Events
--

[.contract-subindex-inherited]
.Governor

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
* {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
* {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
* {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
* {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712

[.contract-subindex-inherited]
.IERC5267
* {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-item]
[[GovernorCountingSimple-COUNTING_MODE--]]
==== `[.contract-item-name]#++COUNTING_MODE++#++() → string++` [.item-kind]#public#

See {IGovernor-COUNTING_MODE}.

[.contract-item]
[[GovernorCountingSimple-hasVoted-uint256-address-]]
==== `[.contract-item-name]#++hasVoted++#++(uint256 proposalId, address account) → bool++` [.item-kind]#public#

See {IGovernor-hasVoted}.

[.contract-item]
[[GovernorCountingSimple-proposalVotes-uint256-]]
==== `[.contract-item-name]#++proposalVotes++#++(uint256 proposalId) → uint256 againstVotes, uint256 forVotes, uint256 abstainVotes++` [.item-kind]#public#

Accessor to the internal vote counts.

[.contract-item]
[[GovernorCountingSimple-_quorumReached-uint256-]]
==== `[.contract-item-name]#++_quorumReached++#++(uint256 proposalId) → bool++` [.item-kind]#internal#

See {Governor-_quorumReached}.

[.contract-item]
[[GovernorCountingSimple-_voteSucceeded-uint256-]]
==== `[.contract-item-name]#++_voteSucceeded++#++(uint256 proposalId) → bool++` [.item-kind]#internal#

See {Governor-_voteSucceeded}. In this module, the forVotes must be strictly over the againstVotes.

[.contract-item]
[[GovernorCountingSimple-_countVote-uint256-address-uint8-uint256-bytes-]]
==== `[.contract-item-name]#++_countVote++#++(uint256 proposalId, address account, uint8 support, uint256 weight, bytes)++` [.item-kind]#internal#

See {Governor-_countVote}. In this module, the support follows the `VoteType` enum (from Governor Bravo).

:token: pass:normal[xref:#GovernorVotes-token-contract-IERC5805[`++token++`]]
:constructor: pass:normal[xref:#GovernorVotes-constructor-contract-IVotes-[`++constructor++`]]
:clock: pass:normal[xref:#GovernorVotes-clock--[`++clock++`]]
:CLOCK_MODE: pass:normal[xref:#GovernorVotes-CLOCK_MODE--[`++CLOCK_MODE++`]]
:_getVotes: pass:normal[xref:#GovernorVotes-_getVotes-address-uint256-bytes-[`++_getVotes++`]]

[.contract]
[[GovernorVotes]]
=== `++GovernorVotes++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.5/contracts/governance/extensions/GovernorVotes.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
import "@openzeppelin/contracts/governance/extensions/GovernorVotes.sol";
```

Extension of {Governor} for voting weight extraction from an {ERC20Votes} token, or since v4.5 an {ERC721Votes} token.

_Available since v4.3._

[.contract-index]
.Functions
--
* {xref-GovernorVotes-constructor-contract-IVotes-}[`++constructor(tokenAddress)++`]
* {xref-GovernorVotes-clock--}[`++clock()++`]
* {xref-GovernorVotes-CLOCK_MODE--}[`++CLOCK_MODE()++`]
* {xref-GovernorVotes-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, )++`]

[.contract-subindex-inherited]
.Governor
* {xref-Governor-receive--}[`++receive()++`]
* {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
* {xref-Governor-name--}[`++name()++`]
* {xref-Governor-version--}[`++version()++`]
* {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-state-uint256-}[`++state(proposalId)++`]
* {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
* {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
* {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
* {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
* {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
* {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
* {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
* {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
* {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
* {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
* {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
* {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
* {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
* {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
* {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
* {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
* {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
* {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
* {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
* {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
* {xref-Governor-_executor--}[`++_executor()++`]
* {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
* {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
* {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
* {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
* {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
* {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
* {xref-IGovernor-quorum-uint256-}[`++quorum(timepoint)++`]
* {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712
* {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
* {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
* {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]

[.contract-subindex-inherited]
.IERC5267

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-index]
.Events
--

[.contract-subindex-inherited]
.Governor

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
* {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
* {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
* {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
* {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712

[.contract-subindex-inherited]
.IERC5267
* {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-item]
[[GovernorVotes-constructor-contract-IVotes-]]
==== `[.contract-item-name]#++constructor++#++(contract IVotes tokenAddress)++` [.item-kind]#internal#

[.contract-item]
[[GovernorVotes-clock--]]
==== `[.contract-item-name]#++clock++#++() → uint48++` [.item-kind]#public#

Clock (as specified in EIP-6372) is set to match the token's clock. Fallback to block numbers if the token
does not implement EIP-6372.

[.contract-item]
[[GovernorVotes-CLOCK_MODE--]]
==== `[.contract-item-name]#++CLOCK_MODE++#++() → string++` [.item-kind]#public#

Machine-readable description of the clock as specified in EIP-6372.

[.contract-item]
[[GovernorVotes-_getVotes-address-uint256-bytes-]]
==== `[.contract-item-name]#++_getVotes++#++(address account, uint256 timepoint, bytes) → uint256++` [.item-kind]#internal#

:QuorumNumeratorUpdated: pass:normal[xref:#GovernorVotesQuorumFraction-QuorumNumeratorUpdated-uint256-uint256-[`++QuorumNumeratorUpdated++`]]
:constructor: pass:normal[xref:#GovernorVotesQuorumFraction-constructor-uint256-[`++constructor++`]]
:quorumNumerator: pass:normal[xref:#GovernorVotesQuorumFraction-quorumNumerator--[`++quorumNumerator++`]]
:quorumNumerator: pass:normal[xref:#GovernorVotesQuorumFraction-quorumNumerator-uint256-[`++quorumNumerator++`]]
:quorumDenominator: pass:normal[xref:#GovernorVotesQuorumFraction-quorumDenominator--[`++quorumDenominator++`]]
:quorum: pass:normal[xref:#GovernorVotesQuorumFraction-quorum-uint256-[`++quorum++`]]
:updateQuorumNumerator: pass:normal[xref:#GovernorVotesQuorumFraction-updateQuorumNumerator-uint256-[`++updateQuorumNumerator++`]]
:_updateQuorumNumerator: pass:normal[xref:#GovernorVotesQuorumFraction-_updateQuorumNumerator-uint256-[`++_updateQuorumNumerator++`]]

[.contract]
[[GovernorVotesQuorumFraction]]
=== `++GovernorVotesQuorumFraction++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.5/contracts/governance/extensions/GovernorVotesQuorumFraction.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
import "@openzeppelin/contracts/governance/extensions/GovernorVotesQuorumFraction.sol";
```

Extension of {Governor} for voting weight extraction from an {ERC20Votes} token and a quorum expressed as a
fraction of the total supply.

_Available since v4.3._

[.contract-index]
.Functions
--
* {xref-GovernorVotesQuorumFraction-constructor-uint256-}[`++constructor(quorumNumeratorValue)++`]
* {xref-GovernorVotesQuorumFraction-quorumNumerator--}[`++quorumNumerator()++`]
* {xref-GovernorVotesQuorumFraction-quorumNumerator-uint256-}[`++quorumNumerator(timepoint)++`]
* {xref-GovernorVotesQuorumFraction-quorumDenominator--}[`++quorumDenominator()++`]
* {xref-GovernorVotesQuorumFraction-quorum-uint256-}[`++quorum(timepoint)++`]
* {xref-GovernorVotesQuorumFraction-updateQuorumNumerator-uint256-}[`++updateQuorumNumerator(newQuorumNumerator)++`]
* {xref-GovernorVotesQuorumFraction-_updateQuorumNumerator-uint256-}[`++_updateQuorumNumerator(newQuorumNumerator)++`]

[.contract-subindex-inherited]
.GovernorVotes
* {xref-GovernorVotes-clock--}[`++clock()++`]
* {xref-GovernorVotes-CLOCK_MODE--}[`++CLOCK_MODE()++`]
* {xref-GovernorVotes-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, )++`]

[.contract-subindex-inherited]
.Governor
* {xref-Governor-receive--}[`++receive()++`]
* {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
* {xref-Governor-name--}[`++name()++`]
* {xref-Governor-version--}[`++version()++`]
* {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-state-uint256-}[`++state(proposalId)++`]
* {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
* {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
* {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
* {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
* {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
* {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
* {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
* {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
* {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
* {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
* {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
* {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
* {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
* {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
* {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
* {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
* {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
* {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
* {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
* {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
* {xref-Governor-_executor--}[`++_executor()++`]
* {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
* {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
* {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
* {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
* {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
* {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
* {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712
* {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
* {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
* {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]

[.contract-subindex-inherited]
.IERC5267

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-index]
.Events
--
* {xref-GovernorVotesQuorumFraction-QuorumNumeratorUpdated-uint256-uint256-}[`++QuorumNumeratorUpdated(oldQuorumNumerator, newQuorumNumerator)++`]

[.contract-subindex-inherited]
.GovernorVotes

[.contract-subindex-inherited]
.Governor

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
* {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
* {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
* {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
* {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712

[.contract-subindex-inherited]
.IERC5267
* {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-item]
[[GovernorVotesQuorumFraction-constructor-uint256-]]
==== `[.contract-item-name]#++constructor++#++(uint256 quorumNumeratorValue)++` [.item-kind]#internal#

Initialize quorum as a fraction of the token's total supply.

The fraction is specified as `numerator / denominator`. By default the denominator is 100, so quorum is
specified as a percent: a numerator of 10 corresponds to quorum being 10% of total supply. The denominator can be
customized by overriding {quorumDenominator}.

[.contract-item]
[[GovernorVotesQuorumFraction-quorumNumerator--]]
==== `[.contract-item-name]#++quorumNumerator++#++() → uint256++` [.item-kind]#public#

Returns the current quorum numerator. See {quorumDenominator}.

[.contract-item]
[[GovernorVotesQuorumFraction-quorumNumerator-uint256-]]
==== `[.contract-item-name]#++quorumNumerator++#++(uint256 timepoint) → uint256++` [.item-kind]#public#

Returns the quorum numerator at a specific timepoint. See {quorumDenominator}.

[.contract-item]
[[GovernorVotesQuorumFraction-quorumDenominator--]]
==== `[.contract-item-name]#++quorumDenominator++#++() → uint256++` [.item-kind]#public#

Returns the quorum denominator. Defaults to 100, but may be overridden.

[.contract-item]
[[GovernorVotesQuorumFraction-quorum-uint256-]]
==== `[.contract-item-name]#++quorum++#++(uint256 timepoint) → uint256++` [.item-kind]#public#

Returns the quorum for a timepoint, in terms of number of votes: `supply * numerator / denominator`.

[.contract-item]
[[GovernorVotesQuorumFraction-updateQuorumNumerator-uint256-]]
==== `[.contract-item-name]#++updateQuorumNumerator++#++(uint256 newQuorumNumerator)++` [.item-kind]#external#

Changes the quorum numerator.

Emits a {QuorumNumeratorUpdated} event.

Requirements:

- Must be called through a governance proposal.
- New numerator must be smaller or equal to the denominator.

[.contract-item]
[[GovernorVotesQuorumFraction-_updateQuorumNumerator-uint256-]]
==== `[.contract-item-name]#++_updateQuorumNumerator++#++(uint256 newQuorumNumerator)++` [.item-kind]#internal#

Changes the quorum numerator.

Emits a {QuorumNumeratorUpdated} event.

Requirements:

- New numerator must be smaller or equal to the denominator.

[.contract-item]
[[GovernorVotesQuorumFraction-QuorumNumeratorUpdated-uint256-uint256-]]
==== `[.contract-item-name]#++QuorumNumeratorUpdated++#++(uint256 oldQuorumNumerator, uint256 newQuorumNumerator)++` [.item-kind]#event#

:token: pass:normal[xref:#GovernorVotesComp-token-contract-ERC20VotesComp[`++token++`]]
:constructor: pass:normal[xref:#GovernorVotesComp-constructor-contract-ERC20VotesComp-[`++constructor++`]]
:clock: pass:normal[xref:#GovernorVotesComp-clock--[`++clock++`]]
:CLOCK_MODE: pass:normal[xref:#GovernorVotesComp-CLOCK_MODE--[`++CLOCK_MODE++`]]
:_getVotes: pass:normal[xref:#GovernorVotesComp-_getVotes-address-uint256-bytes-[`++_getVotes++`]]

[.contract]
[[GovernorVotesComp]]
=== `++GovernorVotesComp++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.5/contracts/governance/extensions/GovernorVotesComp.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
import "@openzeppelin/contracts/governance/extensions/GovernorVotesComp.sol";
```

Extension of {Governor} for voting weight extraction from a Comp token.

_Available since v4.3._

[.contract-index]
.Functions
--
* {xref-GovernorVotesComp-constructor-contract-ERC20VotesComp-}[`++constructor(token_)++`]
* {xref-GovernorVotesComp-clock--}[`++clock()++`]
* {xref-GovernorVotesComp-CLOCK_MODE--}[`++CLOCK_MODE()++`]
* {xref-GovernorVotesComp-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, )++`]

[.contract-subindex-inherited]
.Governor
* {xref-Governor-receive--}[`++receive()++`]
* {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
* {xref-Governor-name--}[`++name()++`]
* {xref-Governor-version--}[`++version()++`]
* {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-state-uint256-}[`++state(proposalId)++`]
* {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
* {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
* {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
* {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
* {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
* {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
* {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
* {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
* {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
* {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
* {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
* {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
* {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
* {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
* {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
* {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
* {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
* {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
* {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
* {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
* {xref-Governor-_executor--}[`++_executor()++`]
* {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
* {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
* {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
* {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
* {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
* {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
* {xref-IGovernor-quorum-uint256-}[`++quorum(timepoint)++`]
* {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712
* {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
* {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
* {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]

[.contract-subindex-inherited]
.IERC5267

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-index]
.Events
--

[.contract-subindex-inherited]
.Governor

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
* {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
* {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
* {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
* {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712

[.contract-subindex-inherited]
.IERC5267
* {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-item]
[[GovernorVotesComp-constructor-contract-ERC20VotesComp-]]
==== `[.contract-item-name]#++constructor++#++(contract ERC20VotesComp token_)++` [.item-kind]#internal#

[.contract-item]
[[GovernorVotesComp-clock--]]
==== `[.contract-item-name]#++clock++#++() → uint48++` [.item-kind]#public#

Clock (as specified in EIP-6372) is set to match the token's clock. Fallback to block numbers if the token
does not implement EIP-6372.

[.contract-item]
[[GovernorVotesComp-CLOCK_MODE--]]
==== `[.contract-item-name]#++CLOCK_MODE++#++() → string++` [.item-kind]#public#

Machine-readable description of the clock as specified in EIP-6372.

[.contract-item]
[[GovernorVotesComp-_getVotes-address-uint256-bytes-]]
==== `[.contract-item-name]#++_getVotes++#++(address account, uint256 timepoint, bytes) → uint256++` [.item-kind]#internal#

=== Extensions

:TimelockChange: pass:normal[xref:#GovernorTimelockControl-TimelockChange-address-address-[`++TimelockChange++`]]
:constructor: pass:normal[xref:#GovernorTimelockControl-constructor-contract-TimelockController-[`++constructor++`]]
:supportsInterface: pass:normal[xref:#GovernorTimelockControl-supportsInterface-bytes4-[`++supportsInterface++`]]
:state: pass:normal[xref:#GovernorTimelockControl-state-uint256-[`++state++`]]
:timelock: pass:normal[xref:#GovernorTimelockControl-timelock--[`++timelock++`]]
:proposalEta: pass:normal[xref:#GovernorTimelockControl-proposalEta-uint256-[`++proposalEta++`]]
:queue: pass:normal[xref:#GovernorTimelockControl-queue-address---uint256---bytes---bytes32-[`++queue++`]]
:_execute: pass:normal[xref:#GovernorTimelockControl-_execute-uint256-address---uint256---bytes---bytes32-[`++_execute++`]]
:_cancel: pass:normal[xref:#GovernorTimelockControl-_cancel-address---uint256---bytes---bytes32-[`++_cancel++`]]
:_executor: pass:normal[xref:#GovernorTimelockControl-_executor--[`++_executor++`]]
:updateTimelock: pass:normal[xref:#GovernorTimelockControl-updateTimelock-contract-TimelockController-[`++updateTimelock++`]]

[.contract]
[[GovernorTimelockControl]]
=== `++GovernorTimelockControl++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.5/contracts/governance/extensions/GovernorTimelockControl.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
import "@openzeppelin/contracts/governance/extensions/GovernorTimelockControl.sol";
```

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 (and 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.

WARNING: Setting up the TimelockController to have additional proposers besides the governor is very risky, as it
grants them powers that they must be trusted or known not to use: 1) {onlyGovernance} functions like {relay} are
available to them through the timelock, and 2) approved governance proposals can be blocked by them, effectively
executing a Denial of Service attack. This risk will be mitigated in a future release.

_Available since v4.3._

[.contract-index]
.Functions
--
* {xref-GovernorTimelockControl-constructor-contract-TimelockController-}[`++constructor(timelockAddress)++`]
* {xref-GovernorTimelockControl-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
* {xref-GovernorTimelockControl-state-uint256-}[`++state(proposalId)++`]
* {xref-GovernorTimelockControl-timelock--}[`++timelock()++`]
* {xref-GovernorTimelockControl-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
* {xref-GovernorTimelockControl-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]
* {xref-GovernorTimelockControl-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, descriptionHash)++`]
* {xref-GovernorTimelockControl-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-GovernorTimelockControl-_executor--}[`++_executor()++`]
* {xref-GovernorTimelockControl-updateTimelock-contract-TimelockController-}[`++updateTimelock(newTimelock)++`]

[.contract-subindex-inherited]
.Governor
* {xref-Governor-receive--}[`++receive()++`]
* {xref-Governor-name--}[`++name()++`]
* {xref-Governor-version--}[`++version()++`]
* {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
* {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
* {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
* {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
* {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
* {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
* {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, params)++`]
* {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
* {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
* {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
* {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
* {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
* {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
* {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
* {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
* {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
* {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
* {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
* {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
* {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
* {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
* {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
* {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
* {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernorTimelock

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-clock--}[`++clock()++`]
* {xref-IGovernor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
* {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
* {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
* {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
* {xref-IGovernor-quorum-uint256-}[`++quorum(timepoint)++`]
* {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712
* {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
* {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
* {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]

[.contract-subindex-inherited]
.IERC5267

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-index]
.Events
--
* {xref-GovernorTimelockControl-TimelockChange-address-address-}[`++TimelockChange(oldTimelock, newTimelock)++`]

[.contract-subindex-inherited]
.Governor

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernorTimelock
* {xref-IGovernorTimelock-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, eta)++`]

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
* {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
* {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
* {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
* {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712

[.contract-subindex-inherited]
.IERC5267
* {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-item]
[[GovernorTimelockControl-constructor-contract-TimelockController-]]
==== `[.contract-item-name]#++constructor++#++(contract TimelockController timelockAddress)++` [.item-kind]#internal#

Set the timelock.

[.contract-item]
[[GovernorTimelockControl-supportsInterface-bytes4-]]
==== `[.contract-item-name]#++supportsInterface++#++(bytes4 interfaceId) → bool++` [.item-kind]#public#

See {IERC165-supportsInterface}.

[.contract-item]
[[GovernorTimelockControl-state-uint256-]]
==== `[.contract-item-name]#++state++#++(uint256 proposalId) → enum IGovernor.ProposalState++` [.item-kind]#public#

Overridden version of the {Governor-state} function with added support for the `Queued` state.

[.contract-item]
[[GovernorTimelockControl-timelock--]]
==== `[.contract-item-name]#++timelock++#++() → address++` [.item-kind]#public#

Public accessor to check the address of the timelock

[.contract-item]
[[GovernorTimelockControl-proposalEta-uint256-]]
==== `[.contract-item-name]#++proposalEta++#++(uint256 proposalId) → uint256++` [.item-kind]#public#

Public accessor to check the eta of a queued proposal

[.contract-item]
[[GovernorTimelockControl-queue-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++queue++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#public#

Function to queue a proposal to the timelock.

[.contract-item]
[[GovernorTimelockControl-_execute-uint256-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++_execute++#++(uint256, address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash)++` [.item-kind]#internal#

Overridden execute function that run the already queued proposal through the timelock.

[.contract-item]
[[GovernorTimelockControl-_cancel-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++_cancel++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#internal#

Overridden version of the {Governor-_cancel} function to cancel the timelocked proposal if it as already
been queued.

[.contract-item]
[[GovernorTimelockControl-_executor--]]
==== `[.contract-item-name]#++_executor++#++() → address++` [.item-kind]#internal#

Address through which the governor executes action. In this case, the timelock.

[.contract-item]
[[GovernorTimelockControl-updateTimelock-contract-TimelockController-]]
==== `[.contract-item-name]#++updateTimelock++#++(contract TimelockController newTimelock)++` [.item-kind]#external#

Public endpoint to update the underlying timelock instance. Restricted to the timelock itself, so updates
must be proposed, scheduled, and executed through governance proposals.

CAUTION: It is not recommended to change the timelock while there are other queued governance proposals.

[.contract-item]
[[GovernorTimelockControl-TimelockChange-address-address-]]
==== `[.contract-item-name]#++TimelockChange++#++(address oldTimelock, address newTimelock)++` [.item-kind]#event#

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

:TimelockChange: pass:normal[xref:#GovernorTimelockCompound-TimelockChange-address-address-[`++TimelockChange++`]]
:constructor: pass:normal[xref:#GovernorTimelockCompound-constructor-contract-ICompoundTimelock-[`++constructor++`]]
:supportsInterface: pass:normal[xref:#GovernorTimelockCompound-supportsInterface-bytes4-[`++supportsInterface++`]]
:state: pass:normal[xref:#GovernorTimelockCompound-state-uint256-[`++state++`]]
:timelock: pass:normal[xref:#GovernorTimelockCompound-timelock--[`++timelock++`]]
:proposalEta: pass:normal[xref:#GovernorTimelockCompound-proposalEta-uint256-[`++proposalEta++`]]
:queue: pass:normal[xref:#GovernorTimelockCompound-queue-address---uint256---bytes---bytes32-[`++queue++`]]
:_execute: pass:normal[xref:#GovernorTimelockCompound-_execute-uint256-address---uint256---bytes---bytes32-[`++_execute++`]]
:_cancel: pass:normal[xref:#GovernorTimelockCompound-_cancel-address---uint256---bytes---bytes32-[`++_cancel++`]]
:_executor: pass:normal[xref:#GovernorTimelockCompound-_executor--[`++_executor++`]]
:__acceptAdmin: pass:normal[xref:#GovernorTimelockCompound-__acceptAdmin--[`++__acceptAdmin++`]]
:updateTimelock: pass:normal[xref:#GovernorTimelockCompound-updateTimelock-contract-ICompoundTimelock-[`++updateTimelock++`]]

[.contract]
[[GovernorTimelockCompound]]
=== `++GovernorTimelockCompound++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.5/contracts/governance/extensions/GovernorTimelockCompound.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
import "@openzeppelin/contracts/governance/extensions/GovernorTimelockCompound.sol";
```

Extension of {Governor} that binds the execution process to a Compound Timelock. This adds a delay, enforced by
the external timelock to all successful proposal (in addition to the voting duration). The {Governor} needs to be
the admin of the timelock for any operation to be performed. A public, unrestricted,
{GovernorTimelockCompound-__acceptAdmin} is available to accept ownership of the timelock.

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._

[.contract-index]
.Functions
--
* {xref-GovernorTimelockCompound-constructor-contract-ICompoundTimelock-}[`++constructor(timelockAddress)++`]
* {xref-GovernorTimelockCompound-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
* {xref-GovernorTimelockCompound-state-uint256-}[`++state(proposalId)++`]
* {xref-GovernorTimelockCompound-timelock--}[`++timelock()++`]
* {xref-GovernorTimelockCompound-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
* {xref-GovernorTimelockCompound-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]
* {xref-GovernorTimelockCompound-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(proposalId, targets, values, calldatas, )++`]
* {xref-GovernorTimelockCompound-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-GovernorTimelockCompound-_executor--}[`++_executor()++`]
* {xref-GovernorTimelockCompound-__acceptAdmin--}[`++__acceptAdmin()++`]
* {xref-GovernorTimelockCompound-updateTimelock-contract-ICompoundTimelock-}[`++updateTimelock(newTimelock)++`]

[.contract-subindex-inherited]
.Governor
* {xref-Governor-receive--}[`++receive()++`]
* {xref-Governor-name--}[`++name()++`]
* {xref-Governor-version--}[`++version()++`]
* {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
* {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
* {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
* {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
* {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
* {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
* {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, params)++`]
* {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
* {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
* {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
* {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
* {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
* {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
* {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
* {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
* {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
* {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
* {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
* {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
* {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
* {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
* {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
* {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
* {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernorTimelock

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-clock--}[`++clock()++`]
* {xref-IGovernor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
* {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
* {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
* {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
* {xref-IGovernor-quorum-uint256-}[`++quorum(timepoint)++`]
* {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712
* {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
* {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
* {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]

[.contract-subindex-inherited]
.IERC5267

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-index]
.Events
--
* {xref-GovernorTimelockCompound-TimelockChange-address-address-}[`++TimelockChange(oldTimelock, newTimelock)++`]

[.contract-subindex-inherited]
.Governor

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernorTimelock
* {xref-IGovernorTimelock-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, eta)++`]

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
* {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
* {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
* {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
* {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712

[.contract-subindex-inherited]
.IERC5267
* {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-item]
[[GovernorTimelockCompound-constructor-contract-ICompoundTimelock-]]
==== `[.contract-item-name]#++constructor++#++(contract ICompoundTimelock timelockAddress)++` [.item-kind]#internal#

Set the timelock.

[.contract-item]
[[GovernorTimelockCompound-supportsInterface-bytes4-]]
==== `[.contract-item-name]#++supportsInterface++#++(bytes4 interfaceId) → bool++` [.item-kind]#public#

See {IERC165-supportsInterface}.

[.contract-item]
[[GovernorTimelockCompound-state-uint256-]]
==== `[.contract-item-name]#++state++#++(uint256 proposalId) → enum IGovernor.ProposalState++` [.item-kind]#public#

Overridden version of the {Governor-state} function with added support for the `Queued` and `Expired` state.

[.contract-item]
[[GovernorTimelockCompound-timelock--]]
==== `[.contract-item-name]#++timelock++#++() → address++` [.item-kind]#public#

Public accessor to check the address of the timelock

[.contract-item]
[[GovernorTimelockCompound-proposalEta-uint256-]]
==== `[.contract-item-name]#++proposalEta++#++(uint256 proposalId) → uint256++` [.item-kind]#public#

Public accessor to check the eta of a queued proposal

[.contract-item]
[[GovernorTimelockCompound-queue-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++queue++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#public#

Function to queue a proposal to the timelock.

[.contract-item]
[[GovernorTimelockCompound-_execute-uint256-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++_execute++#++(uint256 proposalId, address[] targets, uint256[] values, bytes[] calldatas, bytes32)++` [.item-kind]#internal#

Overridden execute function that run the already queued proposal through the timelock.

[.contract-item]
[[GovernorTimelockCompound-_cancel-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++_cancel++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#internal#

Overridden version of the {Governor-_cancel} function to cancel the timelocked proposal if it as already
been queued.

[.contract-item]
[[GovernorTimelockCompound-_executor--]]
==== `[.contract-item-name]#++_executor++#++() → address++` [.item-kind]#internal#

Address through which the governor executes action. In this case, the timelock.

[.contract-item]
[[GovernorTimelockCompound-__acceptAdmin--]]
==== `[.contract-item-name]#++__acceptAdmin++#++()++` [.item-kind]#public#

Accept admin right over the timelock.

[.contract-item]
[[GovernorTimelockCompound-updateTimelock-contract-ICompoundTimelock-]]
==== `[.contract-item-name]#++updateTimelock++#++(contract ICompoundTimelock newTimelock)++` [.item-kind]#external#

Public endpoint to update the underlying timelock instance. Restricted to the timelock itself, so updates
must be proposed, scheduled, and executed through governance proposals.

For security reasons, the timelock must be handed over to another admin before setting up a new one. The two
operations (hand over the timelock) and do the update can be batched in a single proposal.

Note that if the timelock admin has been handed over in a previous operation, we refuse updates made through the
timelock if admin of the timelock has already been accepted and the operation is executed outside the scope of
governance.

CAUTION: It is not recommended to change the timelock while there are other queued governance proposals.

[.contract-item]
[[GovernorTimelockCompound-TimelockChange-address-address-]]
==== `[.contract-item-name]#++TimelockChange++#++(address oldTimelock, address newTimelock)++` [.item-kind]#event#

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

:VotingDelaySet: pass:normal[xref:#GovernorSettings-VotingDelaySet-uint256-uint256-[`++VotingDelaySet++`]]
:VotingPeriodSet: pass:normal[xref:#GovernorSettings-VotingPeriodSet-uint256-uint256-[`++VotingPeriodSet++`]]
:ProposalThresholdSet: pass:normal[xref:#GovernorSettings-ProposalThresholdSet-uint256-uint256-[`++ProposalThresholdSet++`]]
:constructor: pass:normal[xref:#GovernorSettings-constructor-uint256-uint256-uint256-[`++constructor++`]]
:votingDelay: pass:normal[xref:#GovernorSettings-votingDelay--[`++votingDelay++`]]
:votingPeriod: pass:normal[xref:#GovernorSettings-votingPeriod--[`++votingPeriod++`]]
:proposalThreshold: pass:normal[xref:#GovernorSettings-proposalThreshold--[`++proposalThreshold++`]]
:setVotingDelay: pass:normal[xref:#GovernorSettings-setVotingDelay-uint256-[`++setVotingDelay++`]]
:setVotingPeriod: pass:normal[xref:#GovernorSettings-setVotingPeriod-uint256-[`++setVotingPeriod++`]]
:setProposalThreshold: pass:normal[xref:#GovernorSettings-setProposalThreshold-uint256-[`++setProposalThreshold++`]]
:_setVotingDelay: pass:normal[xref:#GovernorSettings-_setVotingDelay-uint256-[`++_setVotingDelay++`]]
:_setVotingPeriod: pass:normal[xref:#GovernorSettings-_setVotingPeriod-uint256-[`++_setVotingPeriod++`]]
:_setProposalThreshold: pass:normal[xref:#GovernorSettings-_setProposalThreshold-uint256-[`++_setProposalThreshold++`]]

[.contract]
[[GovernorSettings]]
=== `++GovernorSettings++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.5/contracts/governance/extensions/GovernorSettings.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
import "@openzeppelin/contracts/governance/extensions/GovernorSettings.sol";
```

Extension of {Governor} for settings updatable through governance.

_Available since v4.4._

[.contract-index]
.Functions
--
* {xref-GovernorSettings-constructor-uint256-uint256-uint256-}[`++constructor(initialVotingDelay, initialVotingPeriod, initialProposalThreshold)++`]
* {xref-GovernorSettings-votingDelay--}[`++votingDelay()++`]
* {xref-GovernorSettings-votingPeriod--}[`++votingPeriod()++`]
* {xref-GovernorSettings-proposalThreshold--}[`++proposalThreshold()++`]
* {xref-GovernorSettings-setVotingDelay-uint256-}[`++setVotingDelay(newVotingDelay)++`]
* {xref-GovernorSettings-setVotingPeriod-uint256-}[`++setVotingPeriod(newVotingPeriod)++`]
* {xref-GovernorSettings-setProposalThreshold-uint256-}[`++setProposalThreshold(newProposalThreshold)++`]
* {xref-GovernorSettings-_setVotingDelay-uint256-}[`++_setVotingDelay(newVotingDelay)++`]
* {xref-GovernorSettings-_setVotingPeriod-uint256-}[`++_setVotingPeriod(newVotingPeriod)++`]
* {xref-GovernorSettings-_setProposalThreshold-uint256-}[`++_setProposalThreshold(newProposalThreshold)++`]

[.contract-subindex-inherited]
.Governor
* {xref-Governor-receive--}[`++receive()++`]
* {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
* {xref-Governor-name--}[`++name()++`]
* {xref-Governor-version--}[`++version()++`]
* {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-state-uint256-}[`++state(proposalId)++`]
* {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
* {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
* {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
* {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
* {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
* {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, params)++`]
* {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
* {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
* {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
* {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
* {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
* {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
* {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
* {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
* {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
* {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
* {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
* {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
* {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
* {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
* {xref-Governor-_executor--}[`++_executor()++`]
* {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
* {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
* {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
* {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-clock--}[`++clock()++`]
* {xref-IGovernor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
* {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
* {xref-IGovernor-quorum-uint256-}[`++quorum(timepoint)++`]
* {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712
* {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
* {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
* {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]

[.contract-subindex-inherited]
.IERC5267

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-index]
.Events
--
* {xref-GovernorSettings-VotingDelaySet-uint256-uint256-}[`++VotingDelaySet(oldVotingDelay, newVotingDelay)++`]
* {xref-GovernorSettings-VotingPeriodSet-uint256-uint256-}[`++VotingPeriodSet(oldVotingPeriod, newVotingPeriod)++`]
* {xref-GovernorSettings-ProposalThresholdSet-uint256-uint256-}[`++ProposalThresholdSet(oldProposalThreshold, newProposalThreshold)++`]

[.contract-subindex-inherited]
.Governor

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
* {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
* {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
* {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
* {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712

[.contract-subindex-inherited]
.IERC5267
* {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-item]
[[GovernorSettings-constructor-uint256-uint256-uint256-]]
==== `[.contract-item-name]#++constructor++#++(uint256 initialVotingDelay, uint256 initialVotingPeriod, uint256 initialProposalThreshold)++` [.item-kind]#internal#

Initialize the governance parameters.

[.contract-item]
[[GovernorSettings-votingDelay--]]
==== `[.contract-item-name]#++votingDelay++#++() → uint256++` [.item-kind]#public#

See {IGovernor-votingDelay}.

[.contract-item]
[[GovernorSettings-votingPeriod--]]
==== `[.contract-item-name]#++votingPeriod++#++() → uint256++` [.item-kind]#public#

See {IGovernor-votingPeriod}.

[.contract-item]
[[GovernorSettings-proposalThreshold--]]
==== `[.contract-item-name]#++proposalThreshold++#++() → uint256++` [.item-kind]#public#

See {Governor-proposalThreshold}.

[.contract-item]
[[GovernorSettings-setVotingDelay-uint256-]]
==== `[.contract-item-name]#++setVotingDelay++#++(uint256 newVotingDelay)++` [.item-kind]#public#

Update the voting delay. This operation can only be performed through a governance proposal.

Emits a {VotingDelaySet} event.

[.contract-item]
[[GovernorSettings-setVotingPeriod-uint256-]]
==== `[.contract-item-name]#++setVotingPeriod++#++(uint256 newVotingPeriod)++` [.item-kind]#public#

Update the voting period. This operation can only be performed through a governance proposal.

Emits a {VotingPeriodSet} event.

[.contract-item]
[[GovernorSettings-setProposalThreshold-uint256-]]
==== `[.contract-item-name]#++setProposalThreshold++#++(uint256 newProposalThreshold)++` [.item-kind]#public#

Update the proposal threshold. This operation can only be performed through a governance proposal.

Emits a {ProposalThresholdSet} event.

[.contract-item]
[[GovernorSettings-_setVotingDelay-uint256-]]
==== `[.contract-item-name]#++_setVotingDelay++#++(uint256 newVotingDelay)++` [.item-kind]#internal#

Internal setter for the voting delay.

Emits a {VotingDelaySet} event.

[.contract-item]
[[GovernorSettings-_setVotingPeriod-uint256-]]
==== `[.contract-item-name]#++_setVotingPeriod++#++(uint256 newVotingPeriod)++` [.item-kind]#internal#

Internal setter for the voting period.

Emits a {VotingPeriodSet} event.

[.contract-item]
[[GovernorSettings-_setProposalThreshold-uint256-]]
==== `[.contract-item-name]#++_setProposalThreshold++#++(uint256 newProposalThreshold)++` [.item-kind]#internal#

Internal setter for the proposal threshold.

Emits a {ProposalThresholdSet} event.

[.contract-item]
[[GovernorSettings-VotingDelaySet-uint256-uint256-]]
==== `[.contract-item-name]#++VotingDelaySet++#++(uint256 oldVotingDelay, uint256 newVotingDelay)++` [.item-kind]#event#

[.contract-item]
[[GovernorSettings-VotingPeriodSet-uint256-uint256-]]
==== `[.contract-item-name]#++VotingPeriodSet++#++(uint256 oldVotingPeriod, uint256 newVotingPeriod)++` [.item-kind]#event#

[.contract-item]
[[GovernorSettings-ProposalThresholdSet-uint256-uint256-]]
==== `[.contract-item-name]#++ProposalThresholdSet++#++(uint256 oldProposalThreshold, uint256 newProposalThreshold)++` [.item-kind]#event#

:ProposalExtended: pass:normal[xref:#GovernorPreventLateQuorum-ProposalExtended-uint256-uint64-[`++ProposalExtended++`]]
:LateQuorumVoteExtensionSet: pass:normal[xref:#GovernorPreventLateQuorum-LateQuorumVoteExtensionSet-uint64-uint64-[`++LateQuorumVoteExtensionSet++`]]
:constructor: pass:normal[xref:#GovernorPreventLateQuorum-constructor-uint64-[`++constructor++`]]
:proposalDeadline: pass:normal[xref:#GovernorPreventLateQuorum-proposalDeadline-uint256-[`++proposalDeadline++`]]
:_castVote: pass:normal[xref:#GovernorPreventLateQuorum-_castVote-uint256-address-uint8-string-bytes-[`++_castVote++`]]
:lateQuorumVoteExtension: pass:normal[xref:#GovernorPreventLateQuorum-lateQuorumVoteExtension--[`++lateQuorumVoteExtension++`]]
:setLateQuorumVoteExtension: pass:normal[xref:#GovernorPreventLateQuorum-setLateQuorumVoteExtension-uint64-[`++setLateQuorumVoteExtension++`]]
:_setLateQuorumVoteExtension: pass:normal[xref:#GovernorPreventLateQuorum-_setLateQuorumVoteExtension-uint64-[`++_setLateQuorumVoteExtension++`]]

[.contract]
[[GovernorPreventLateQuorum]]
=== `++GovernorPreventLateQuorum++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.5/contracts/governance/extensions/GovernorPreventLateQuorum.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
import "@openzeppelin/contracts/governance/extensions/GovernorPreventLateQuorum.sol";
```

A module that ensures there is a minimum voting period after quorum is reached. This prevents a large voter from
swaying a vote and triggering quorum at the last minute, by ensuring there is always time for other voters to react
and try to oppose the decision.

If a vote causes quorum to be reached, the proposal's voting period may be extended so that it does not end before at
least a specified time has passed (the "vote extension" parameter). This parameter can be set through a governance
proposal.

_Available since v4.5._

[.contract-index]
.Functions
--
* {xref-GovernorPreventLateQuorum-constructor-uint64-}[`++constructor(initialVoteExtension)++`]
* {xref-GovernorPreventLateQuorum-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
* {xref-GovernorPreventLateQuorum-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
* {xref-GovernorPreventLateQuorum-lateQuorumVoteExtension--}[`++lateQuorumVoteExtension()++`]
* {xref-GovernorPreventLateQuorum-setLateQuorumVoteExtension-uint64-}[`++setLateQuorumVoteExtension(newVoteExtension)++`]
* {xref-GovernorPreventLateQuorum-_setLateQuorumVoteExtension-uint64-}[`++_setLateQuorumVoteExtension(newVoteExtension)++`]

[.contract-subindex-inherited]
.Governor
* {xref-Governor-receive--}[`++receive()++`]
* {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
* {xref-Governor-name--}[`++name()++`]
* {xref-Governor-version--}[`++version()++`]
* {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-state-uint256-}[`++state(proposalId)++`]
* {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
* {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
* {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
* {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
* {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
* {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, params)++`]
* {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
* {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
* {xref-Governor-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
* {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
* {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
* {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
* {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
* {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
* {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
* {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
* {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
* {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
* {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
* {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
* {xref-Governor-_executor--}[`++_executor()++`]
* {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
* {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
* {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
* {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-clock--}[`++clock()++`]
* {xref-IGovernor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
* {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
* {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
* {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
* {xref-IGovernor-quorum-uint256-}[`++quorum(timepoint)++`]
* {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712
* {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
* {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
* {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]

[.contract-subindex-inherited]
.IERC5267

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-index]
.Events
--
* {xref-GovernorPreventLateQuorum-ProposalExtended-uint256-uint64-}[`++ProposalExtended(proposalId, extendedDeadline)++`]
* {xref-GovernorPreventLateQuorum-LateQuorumVoteExtensionSet-uint64-uint64-}[`++LateQuorumVoteExtensionSet(oldVoteExtension, newVoteExtension)++`]

[.contract-subindex-inherited]
.Governor

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
* {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
* {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
* {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
* {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712

[.contract-subindex-inherited]
.IERC5267
* {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-item]
[[GovernorPreventLateQuorum-constructor-uint64-]]
==== `[.contract-item-name]#++constructor++#++(uint64 initialVoteExtension)++` [.item-kind]#internal#

Initializes the vote extension parameter: the time in either number of blocks or seconds (depending on the governor
clock mode) that is required to pass since the moment a proposal reaches quorum until its voting period ends. If
necessary the voting period will be extended beyond the one set during proposal creation.

[.contract-item]
[[GovernorPreventLateQuorum-proposalDeadline-uint256-]]
==== `[.contract-item-name]#++proposalDeadline++#++(uint256 proposalId) → uint256++` [.item-kind]#public#

Returns the proposal deadline, which may have been extended beyond that set at proposal creation, if the
proposal reached quorum late in the voting period. See {Governor-proposalDeadline}.

[.contract-item]
[[GovernorPreventLateQuorum-_castVote-uint256-address-uint8-string-bytes-]]
==== `[.contract-item-name]#++_castVote++#++(uint256 proposalId, address account, uint8 support, string reason, bytes params) → uint256++` [.item-kind]#internal#

Casts a vote and detects if it caused quorum to be reached, potentially extending the voting period. See
{Governor-_castVote}.

May emit a {ProposalExtended} event.

[.contract-item]
[[GovernorPreventLateQuorum-lateQuorumVoteExtension--]]
==== `[.contract-item-name]#++lateQuorumVoteExtension++#++() → uint64++` [.item-kind]#public#

Returns the current value of the vote extension parameter: the number of blocks that are required to pass
from the time a proposal reaches quorum until its voting period ends.

[.contract-item]
[[GovernorPreventLateQuorum-setLateQuorumVoteExtension-uint64-]]
==== `[.contract-item-name]#++setLateQuorumVoteExtension++#++(uint64 newVoteExtension)++` [.item-kind]#public#

Changes the {lateQuorumVoteExtension}. This operation can only be performed by the governance executor,
generally through a governance proposal.

Emits a {LateQuorumVoteExtensionSet} event.

[.contract-item]
[[GovernorPreventLateQuorum-_setLateQuorumVoteExtension-uint64-]]
==== `[.contract-item-name]#++_setLateQuorumVoteExtension++#++(uint64 newVoteExtension)++` [.item-kind]#internal#

Changes the {lateQuorumVoteExtension}. This is an internal function that can be exposed in a public function
like {setLateQuorumVoteExtension} if another access control mechanism is needed.

Emits a {LateQuorumVoteExtensionSet} event.

[.contract-item]
[[GovernorPreventLateQuorum-ProposalExtended-uint256-uint64-]]
==== `[.contract-item-name]#++ProposalExtended++#++(uint256 indexed proposalId, uint64 extendedDeadline)++` [.item-kind]#event#

Emitted when a proposal deadline is pushed back due to reaching quorum late in its voting period.

[.contract-item]
[[GovernorPreventLateQuorum-LateQuorumVoteExtensionSet-uint64-uint64-]]
==== `[.contract-item-name]#++LateQuorumVoteExtensionSet++#++(uint64 oldVoteExtension, uint64 newVoteExtension)++` [.item-kind]#event#

Emitted when the {lateQuorumVoteExtension} parameter is changed.

:VoteType: pass:normal[xref:#GovernorCompatibilityBravo-VoteType[`++VoteType++`]]
:ProposalDetails: pass:normal[xref:#GovernorCompatibilityBravo-ProposalDetails[`++ProposalDetails++`]]
:COUNTING_MODE: pass:normal[xref:#GovernorCompatibilityBravo-COUNTING_MODE--[`++COUNTING_MODE++`]]
:propose: pass:normal[xref:#GovernorCompatibilityBravo-propose-address---uint256---bytes---string-[`++propose++`]]
:propose: pass:normal[xref:#GovernorCompatibilityBravo-propose-address---uint256---string---bytes---string-[`++propose++`]]
:queue: pass:normal[xref:#GovernorCompatibilityBravo-queue-uint256-[`++queue++`]]
:execute: pass:normal[xref:#GovernorCompatibilityBravo-execute-uint256-[`++execute++`]]
:cancel: pass:normal[xref:#GovernorCompatibilityBravo-cancel-uint256-[`++cancel++`]]
:cancel: pass:normal[xref:#GovernorCompatibilityBravo-cancel-address---uint256---bytes---bytes32-[`++cancel++`]]
:proposals: pass:normal[xref:#GovernorCompatibilityBravo-proposals-uint256-[`++proposals++`]]
:getActions: pass:normal[xref:#GovernorCompatibilityBravo-getActions-uint256-[`++getActions++`]]
:getReceipt: pass:normal[xref:#GovernorCompatibilityBravo-getReceipt-uint256-address-[`++getReceipt++`]]
:quorumVotes: pass:normal[xref:#GovernorCompatibilityBravo-quorumVotes--[`++quorumVotes++`]]
:hasVoted: pass:normal[xref:#GovernorCompatibilityBravo-hasVoted-uint256-address-[`++hasVoted++`]]
:_quorumReached: pass:normal[xref:#GovernorCompatibilityBravo-_quorumReached-uint256-[`++_quorumReached++`]]
:_voteSucceeded: pass:normal[xref:#GovernorCompatibilityBravo-_voteSucceeded-uint256-[`++_voteSucceeded++`]]
:_countVote: pass:normal[xref:#GovernorCompatibilityBravo-_countVote-uint256-address-uint8-uint256-bytes-[`++_countVote++`]]

[.contract]
[[GovernorCompatibilityBravo]]
=== `++GovernorCompatibilityBravo++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.5/contracts/governance/compatibility/GovernorCompatibilityBravo.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
import "@openzeppelin/contracts/governance/compatibility/GovernorCompatibilityBravo.sol";
```

Compatibility layer that implements GovernorBravo compatibility on top of {Governor}.

This compatibility layer includes a voting system and requires a {IGovernorTimelock} compatible module to be added
through inheritance. It does not include token bindings, nor does it include any variable upgrade patterns.

NOTE: When using this module, you may need to enable the Solidity optimizer to avoid hitting the contract size limit.

_Available since v4.3._

[.contract-index]
.Functions
--
* {xref-GovernorCompatibilityBravo-COUNTING_MODE--}[`++COUNTING_MODE()++`]
* {xref-GovernorCompatibilityBravo-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]
* {xref-GovernorCompatibilityBravo-propose-address---uint256---string---bytes---string-}[`++propose(targets, values, signatures, calldatas, description)++`]
* {xref-GovernorCompatibilityBravo-queue-uint256-}[`++queue(proposalId)++`]
* {xref-GovernorCompatibilityBravo-execute-uint256-}[`++execute(proposalId)++`]
* {xref-GovernorCompatibilityBravo-cancel-uint256-}[`++cancel(proposalId)++`]
* {xref-GovernorCompatibilityBravo-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-GovernorCompatibilityBravo-proposals-uint256-}[`++proposals(proposalId)++`]
* {xref-GovernorCompatibilityBravo-getActions-uint256-}[`++getActions(proposalId)++`]
* {xref-GovernorCompatibilityBravo-getReceipt-uint256-address-}[`++getReceipt(proposalId, voter)++`]
* {xref-GovernorCompatibilityBravo-quorumVotes--}[`++quorumVotes()++`]
* {xref-GovernorCompatibilityBravo-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]
* {xref-GovernorCompatibilityBravo-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
* {xref-GovernorCompatibilityBravo-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
* {xref-GovernorCompatibilityBravo-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, )++`]

[.contract-subindex-inherited]
.Governor
* {xref-Governor-receive--}[`++receive()++`]
* {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
* {xref-Governor-name--}[`++name()++`]
* {xref-Governor-version--}[`++version()++`]
* {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-state-uint256-}[`++state(proposalId)++`]
* {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
* {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
* {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
* {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
* {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, params)++`]
* {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
* {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
* {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
* {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
* {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
* {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
* {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
* {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
* {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
* {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
* {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
* {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
* {xref-Governor-_executor--}[`++_executor()++`]
* {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
* {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
* {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
* {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernorCompatibilityBravo

[.contract-subindex-inherited]
.IGovernorTimelock
* {xref-IGovernorTimelock-timelock--}[`++timelock()++`]
* {xref-IGovernorTimelock-proposalEta-uint256-}[`++proposalEta(proposalId)++`]
* {xref-IGovernorTimelock-queue-address---uint256---bytes---bytes32-}[`++queue(targets, values, calldatas, descriptionHash)++`]

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-clock--}[`++clock()++`]
* {xref-IGovernor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
* {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
* {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
* {xref-IGovernor-quorum-uint256-}[`++quorum(timepoint)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712
* {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
* {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
* {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]

[.contract-subindex-inherited]
.IERC5267

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-index]
.Events
--

[.contract-subindex-inherited]
.Governor

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernorCompatibilityBravo

[.contract-subindex-inherited]
.IGovernorTimelock
* {xref-IGovernorTimelock-ProposalQueued-uint256-uint256-}[`++ProposalQueued(proposalId, eta)++`]

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
* {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
* {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
* {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
* {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712

[.contract-subindex-inherited]
.IERC5267
* {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-item]
[[GovernorCompatibilityBravo-COUNTING_MODE--]]
==== `[.contract-item-name]#++COUNTING_MODE++#++() → string++` [.item-kind]#public#

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[`URLSearchParams`]
JavaScript class.

[.contract-item]
[[GovernorCompatibilityBravo-propose-address---uint256---bytes---string-]]
==== `[.contract-item-name]#++propose++#++(address[] targets, uint256[] values, bytes[] calldatas, string description) → uint256++` [.item-kind]#public#

See {IGovernor-propose}.

[.contract-item]
[[GovernorCompatibilityBravo-propose-address---uint256---string---bytes---string-]]
==== `[.contract-item-name]#++propose++#++(address[] targets, uint256[] values, string[] signatures, bytes[] calldatas, string description) → uint256++` [.item-kind]#public#

See {IGovernorCompatibilityBravo-propose}.

[.contract-item]
[[GovernorCompatibilityBravo-queue-uint256-]]
==== `[.contract-item-name]#++queue++#++(uint256 proposalId)++` [.item-kind]#public#

See {IGovernorCompatibilityBravo-queue}.

[.contract-item]
[[GovernorCompatibilityBravo-execute-uint256-]]
==== `[.contract-item-name]#++execute++#++(uint256 proposalId)++` [.item-kind]#public#

See {IGovernorCompatibilityBravo-execute}.

[.contract-item]
[[GovernorCompatibilityBravo-cancel-uint256-]]
==== `[.contract-item-name]#++cancel++#++(uint256 proposalId)++` [.item-kind]#public#

Cancel a proposal with GovernorBravo logic.

[.contract-item]
[[GovernorCompatibilityBravo-cancel-address---uint256---bytes---bytes32-]]
==== `[.contract-item-name]#++cancel++#++(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) → uint256++` [.item-kind]#public#

Cancel a proposal with GovernorBravo logic. At any moment a proposal can be cancelled, either by the
proposer, or by third parties if the proposer's voting power has dropped below the proposal threshold.

[.contract-item]
[[GovernorCompatibilityBravo-proposals-uint256-]]
==== `[.contract-item-name]#++proposals++#++(uint256 proposalId) → uint256 id, address proposer, uint256 eta, uint256 startBlock, uint256 endBlock, uint256 forVotes, uint256 againstVotes, uint256 abstainVotes, bool canceled, bool executed++` [.item-kind]#public#

See {IGovernorCompatibilityBravo-proposals}.

[.contract-item]
[[GovernorCompatibilityBravo-getActions-uint256-]]
==== `[.contract-item-name]#++getActions++#++(uint256 proposalId) → address[] targets, uint256[] values, string[] signatures, bytes[] calldatas++` [.item-kind]#public#

See {IGovernorCompatibilityBravo-getActions}.

[.contract-item]
[[GovernorCompatibilityBravo-getReceipt-uint256-address-]]
==== `[.contract-item-name]#++getReceipt++#++(uint256 proposalId, address voter) → struct IGovernorCompatibilityBravo.Receipt++` [.item-kind]#public#

See {IGovernorCompatibilityBravo-getReceipt}.

[.contract-item]
[[GovernorCompatibilityBravo-quorumVotes--]]
==== `[.contract-item-name]#++quorumVotes++#++() → uint256++` [.item-kind]#public#

See {IGovernorCompatibilityBravo-quorumVotes}.

[.contract-item]
[[GovernorCompatibilityBravo-hasVoted-uint256-address-]]
==== `[.contract-item-name]#++hasVoted++#++(uint256 proposalId, address account) → bool++` [.item-kind]#public#

See {IGovernor-hasVoted}.

[.contract-item]
[[GovernorCompatibilityBravo-_quorumReached-uint256-]]
==== `[.contract-item-name]#++_quorumReached++#++(uint256 proposalId) → bool++` [.item-kind]#internal#

See {Governor-_quorumReached}. In this module, only forVotes count toward the quorum.

[.contract-item]
[[GovernorCompatibilityBravo-_voteSucceeded-uint256-]]
==== `[.contract-item-name]#++_voteSucceeded++#++(uint256 proposalId) → bool++` [.item-kind]#internal#

See {Governor-_voteSucceeded}. In this module, the forVotes must be strictly over the againstVotes.

[.contract-item]
[[GovernorCompatibilityBravo-_countVote-uint256-address-uint8-uint256-bytes-]]
==== `[.contract-item-name]#++_countVote++#++(uint256 proposalId, address account, uint8 support, uint256 weight, bytes)++` [.item-kind]#internal#

See {Governor-_countVote}. In this module, the support follows Governor Bravo.

=== Deprecated

:propose: pass:normal[xref:#GovernorProposalThreshold-propose-address---uint256---bytes---string-[`++propose++`]]

[.contract]
[[GovernorProposalThreshold]]
=== `++GovernorProposalThreshold++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.5/contracts/governance/extensions/GovernorProposalThreshold.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
import "@openzeppelin/contracts/governance/extensions/GovernorProposalThreshold.sol";
```

Extension of {Governor} for proposal restriction to token holders with a minimum balance.

_Available since v4.3._
_Deprecated since v4.4._

[.contract-index]
.Functions
--
* {xref-GovernorProposalThreshold-propose-address---uint256---bytes---string-}[`++propose(targets, values, calldatas, description)++`]

[.contract-subindex-inherited]
.Governor
* {xref-Governor-receive--}[`++receive()++`]
* {xref-Governor-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
* {xref-Governor-name--}[`++name()++`]
* {xref-Governor-version--}[`++version()++`]
* {xref-Governor-hashProposal-address---uint256---bytes---bytes32-}[`++hashProposal(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-state-uint256-}[`++state(proposalId)++`]
* {xref-Governor-proposalThreshold--}[`++proposalThreshold()++`]
* {xref-Governor-proposalSnapshot-uint256-}[`++proposalSnapshot(proposalId)++`]
* {xref-Governor-proposalDeadline-uint256-}[`++proposalDeadline(proposalId)++`]
* {xref-Governor-proposalProposer-uint256-}[`++proposalProposer(proposalId)++`]
* {xref-Governor-_quorumReached-uint256-}[`++_quorumReached(proposalId)++`]
* {xref-Governor-_voteSucceeded-uint256-}[`++_voteSucceeded(proposalId)++`]
* {xref-Governor-_getVotes-address-uint256-bytes-}[`++_getVotes(account, timepoint, params)++`]
* {xref-Governor-_countVote-uint256-address-uint8-uint256-bytes-}[`++_countVote(proposalId, account, support, weight, params)++`]
* {xref-Governor-_defaultParams--}[`++_defaultParams()++`]
* {xref-Governor-execute-address---uint256---bytes---bytes32-}[`++execute(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-cancel-address---uint256---bytes---bytes32-}[`++cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-_execute-uint256-address---uint256---bytes---bytes32-}[`++_execute(, targets, values, calldatas, )++`]
* {xref-Governor-_beforeExecute-uint256-address---uint256---bytes---bytes32-}[`++_beforeExecute(, targets, , calldatas, )++`]
* {xref-Governor-_afterExecute-uint256-address---uint256---bytes---bytes32-}[`++_afterExecute(, , , , )++`]
* {xref-Governor-_cancel-address---uint256---bytes---bytes32-}[`++_cancel(targets, values, calldatas, descriptionHash)++`]
* {xref-Governor-getVotes-address-uint256-}[`++getVotes(account, timepoint)++`]
* {xref-Governor-getVotesWithParams-address-uint256-bytes-}[`++getVotesWithParams(account, timepoint, params)++`]
* {xref-Governor-castVote-uint256-uint8-}[`++castVote(proposalId, support)++`]
* {xref-Governor-castVoteWithReason-uint256-uint8-string-}[`++castVoteWithReason(proposalId, support, reason)++`]
* {xref-Governor-castVoteWithReasonAndParams-uint256-uint8-string-bytes-}[`++castVoteWithReasonAndParams(proposalId, support, reason, params)++`]
* {xref-Governor-castVoteBySig-uint256-uint8-uint8-bytes32-bytes32-}[`++castVoteBySig(proposalId, support, v, r, s)++`]
* {xref-Governor-castVoteWithReasonAndParamsBySig-uint256-uint8-string-bytes-uint8-bytes32-bytes32-}[`++castVoteWithReasonAndParamsBySig(proposalId, support, reason, params, v, r, s)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-}[`++_castVote(proposalId, account, support, reason)++`]
* {xref-Governor-_castVote-uint256-address-uint8-string-bytes-}[`++_castVote(proposalId, account, support, reason, params)++`]
* {xref-Governor-relay-address-uint256-bytes-}[`++relay(target, value, data)++`]
* {xref-Governor-_executor--}[`++_executor()++`]
* {xref-Governor-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
* {xref-Governor-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
* {xref-Governor-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]
* {xref-Governor-_isValidDescriptionForProposer-address-string-}[`++_isValidDescriptionForProposer(proposer, description)++`]

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-clock--}[`++clock()++`]
* {xref-IGovernor-CLOCK_MODE--}[`++CLOCK_MODE()++`]
* {xref-IGovernor-COUNTING_MODE--}[`++COUNTING_MODE()++`]
* {xref-IGovernor-votingDelay--}[`++votingDelay()++`]
* {xref-IGovernor-votingPeriod--}[`++votingPeriod()++`]
* {xref-IGovernor-quorum-uint256-}[`++quorum(timepoint)++`]
* {xref-IGovernor-hasVoted-uint256-address-}[`++hasVoted(proposalId, account)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712
* {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
* {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
* {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]

[.contract-subindex-inherited]
.IERC5267

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-index]
.Events
--

[.contract-subindex-inherited]
.Governor

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.IGovernor
* {xref-IGovernor-ProposalCreated-uint256-address-address---uint256---string---bytes---uint256-uint256-string-}[`++ProposalCreated(proposalId, proposer, targets, values, signatures, calldatas, voteStart, voteEnd, description)++`]
* {xref-IGovernor-ProposalCanceled-uint256-}[`++ProposalCanceled(proposalId)++`]
* {xref-IGovernor-ProposalExecuted-uint256-}[`++ProposalExecuted(proposalId)++`]
* {xref-IGovernor-VoteCast-address-uint256-uint8-uint256-string-}[`++VoteCast(voter, proposalId, support, weight, reason)++`]
* {xref-IGovernor-VoteCastWithParams-address-uint256-uint8-uint256-string-bytes-}[`++VoteCastWithParams(voter, proposalId, support, weight, reason, params)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712

[.contract-subindex-inherited]
.IERC5267
* {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

--

[.contract-item]
[[GovernorProposalThreshold-propose-address---uint256---bytes---string-]]
==== `[.contract-item-name]#++propose++#++(address[] targets, uint256[] values, bytes[] calldatas, string description) → uint256++` [.item-kind]#public#

See {IGovernor-propose}. This function has opt-in frontrunning protection, described in {_isValidDescriptionForProposer}.

== Utils

:clock: pass:normal[xref:#Votes-clock--[`++clock++`]]
:CLOCK_MODE: pass:normal[xref:#Votes-CLOCK_MODE--[`++CLOCK_MODE++`]]
:getVotes: pass:normal[xref:#Votes-getVotes-address-[`++getVotes++`]]
:getPastVotes: pass:normal[xref:#Votes-getPastVotes-address-uint256-[`++getPastVotes++`]]
:getPastTotalSupply: pass:normal[xref:#Votes-getPastTotalSupply-uint256-[`++getPastTotalSupply++`]]
:_getTotalSupply: pass:normal[xref:#Votes-_getTotalSupply--[`++_getTotalSupply++`]]
:delegates: pass:normal[xref:#Votes-delegates-address-[`++delegates++`]]
:delegate: pass:normal[xref:#Votes-delegate-address-[`++delegate++`]]
:delegateBySig: pass:normal[xref:#Votes-delegateBySig-address-uint256-uint256-uint8-bytes32-bytes32-[`++delegateBySig++`]]
:_delegate: pass:normal[xref:#Votes-_delegate-address-address-[`++_delegate++`]]
:_transferVotingUnits: pass:normal[xref:#Votes-_transferVotingUnits-address-address-uint256-[`++_transferVotingUnits++`]]
:_useNonce: pass:normal[xref:#Votes-_useNonce-address-[`++_useNonce++`]]
:nonces: pass:normal[xref:#Votes-nonces-address-[`++nonces++`]]
:DOMAIN_SEPARATOR: pass:normal[xref:#Votes-DOMAIN_SEPARATOR--[`++DOMAIN_SEPARATOR++`]]
:_getVotingUnits: pass:normal[xref:#Votes-_getVotingUnits-address-[`++_getVotingUnits++`]]

[.contract]
[[Votes]]
=== `++Votes++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.5/contracts/governance/utils/Votes.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
import "@openzeppelin/contracts/governance/utils/Votes.sol";
```

This is a base abstract contract that tracks voting units, which are a measure of voting power that can be
transferred, and provides a system of vote delegation, where an account can delegate its voting units to a sort of
"representative" that will pool delegated voting units from different accounts and can then use it to vote in
decisions. In fact, voting units _must_ be delegated in order to count as actual votes, and an account has to
delegate those votes to itself if it wishes to participate in decisions and does not have a trusted representative.

This contract is often combined with a token contract such that voting units correspond to token units. For an
example, see {ERC721Votes}.

The full history of delegate votes is tracked on-chain so that governance protocols can consider votes as distributed
at a particular block number to protect against flash loans and double voting. The opt-in delegate system makes the
cost of this history tracking optional.

When using this module the derived contract must implement {_getVotingUnits} (for example, make it return
{ERC721-balanceOf}), and can use {_transferVotingUnits} to track a change in the distribution of those units (in the
previous example, it would be included in {ERC721-_beforeTokenTransfer}).

_Available since v4.5._

[.contract-index]
.Functions
--
* {xref-Votes-clock--}[`++clock()++`]
* {xref-Votes-CLOCK_MODE--}[`++CLOCK_MODE()++`]
* {xref-Votes-getVotes-address-}[`++getVotes(account)++`]
* {xref-Votes-getPastVotes-address-uint256-}[`++getPastVotes(account, timepoint)++`]
* {xref-Votes-getPastTotalSupply-uint256-}[`++getPastTotalSupply(timepoint)++`]
* {xref-Votes-_getTotalSupply--}[`++_getTotalSupply()++`]
* {xref-Votes-delegates-address-}[`++delegates(account)++`]
* {xref-Votes-delegate-address-}[`++delegate(delegatee)++`]
* {xref-Votes-delegateBySig-address-uint256-uint256-uint8-bytes32-bytes32-}[`++delegateBySig(delegatee, nonce, expiry, v, r, s)++`]
* {xref-Votes-_delegate-address-address-}[`++_delegate(account, delegatee)++`]
* {xref-Votes-_transferVotingUnits-address-address-uint256-}[`++_transferVotingUnits(from, to, amount)++`]
* {xref-Votes-_useNonce-address-}[`++_useNonce(owner)++`]
* {xref-Votes-nonces-address-}[`++nonces(owner)++`]
* {xref-Votes-DOMAIN_SEPARATOR--}[`++DOMAIN_SEPARATOR()++`]
* {xref-Votes-_getVotingUnits-address-}[`++_getVotingUnits()++`]

[.contract-subindex-inherited]
.IERC5805

[.contract-subindex-inherited]
.IVotes

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712
* {xref-EIP712-_domainSeparatorV4--}[`++_domainSeparatorV4()++`]
* {xref-EIP712-_hashTypedDataV4-bytes32-}[`++_hashTypedDataV4(structHash)++`]
* {xref-EIP712-eip712Domain--}[`++eip712Domain()++`]

[.contract-subindex-inherited]
.IERC5267

--

[.contract-index]
.Events
--

[.contract-subindex-inherited]
.IERC5805

[.contract-subindex-inherited]
.IVotes
* {xref-IVotes-DelegateChanged-address-address-address-}[`++DelegateChanged(delegator, fromDelegate, toDelegate)++`]
* {xref-IVotes-DelegateVotesChanged-address-uint256-uint256-}[`++DelegateVotesChanged(delegate, previousBalance, newBalance)++`]

[.contract-subindex-inherited]
.IERC6372

[.contract-subindex-inherited]
.EIP712

[.contract-subindex-inherited]
.IERC5267
* {xref-IERC5267-EIP712DomainChanged--}[`++EIP712DomainChanged()++`]

--

[.contract-item]
[[Votes-clock--]]
==== `[.contract-item-name]#++clock++#++() → uint48++` [.item-kind]#public#

Clock used for flagging checkpoints. Can be overridden to implement timestamp based
checkpoints (and voting), in which case {CLOCK_MODE} should be overridden as well to match.

[.contract-item]
[[Votes-CLOCK_MODE--]]
==== `[.contract-item-name]#++CLOCK_MODE++#++() → string++` [.item-kind]#public#

Machine-readable description of the clock as specified in EIP-6372.

[.contract-item]
[[Votes-getVotes-address-]]
==== `[.contract-item-name]#++getVotes++#++(address account) → uint256++` [.item-kind]#public#

Returns the current amount of votes that `account` has.

[.contract-item]
[[Votes-getPastVotes-address-uint256-]]
==== `[.contract-item-name]#++getPastVotes++#++(address account, uint256 timepoint) → uint256++` [.item-kind]#public#

Returns the amount of votes that `account` had at a specific moment in the past. If the `clock()` is
configured to use block numbers, this will return the value at the end of the corresponding block.

Requirements:

- `timepoint` must be in the past. If operating using block numbers, the block must be already mined.

[.contract-item]
[[Votes-getPastTotalSupply-uint256-]]
==== `[.contract-item-name]#++getPastTotalSupply++#++(uint256 timepoint) → uint256++` [.item-kind]#public#

Returns the total supply of votes available at a specific moment in the past. If the `clock()` is
configured to use block numbers, this will return the value at the end of the corresponding block.

NOTE: This value is the sum of all available votes, which is not necessarily the sum of all delegated votes.
Votes that have not been delegated are still part of total supply, even though they would not participate in a
vote.

Requirements:

- `timepoint` must be in the past. If operating using block numbers, the block must be already mined.

[.contract-item]
[[Votes-_getTotalSupply--]]
==== `[.contract-item-name]#++_getTotalSupply++#++() → uint256++` [.item-kind]#internal#

Returns the current total supply of votes.

[.contract-item]
[[Votes-delegates-address-]]
==== `[.contract-item-name]#++delegates++#++(address account) → address++` [.item-kind]#public#

Returns the delegate that `account` has chosen.

[.contract-item]
[[Votes-delegate-address-]]
==== `[.contract-item-name]#++delegate++#++(address delegatee)++` [.item-kind]#public#

Delegates votes from the sender to `delegatee`.

[.contract-item]
[[Votes-delegateBySig-address-uint256-uint256-uint8-bytes32-bytes32-]]
==== `[.contract-item-name]#++delegateBySig++#++(address delegatee, uint256 nonce, uint256 expiry, uint8 v, bytes32 r, bytes32 s)++` [.item-kind]#public#

Delegates votes from signer to `delegatee`.

[.contract-item]
[[Votes-_delegate-address-address-]]
==== `[.contract-item-name]#++_delegate++#++(address account, address delegatee)++` [.item-kind]#internal#

Delegate all of `account`'s voting units to `delegatee`.

Emits events {IVotes-DelegateChanged} and {IVotes-DelegateVotesChanged}.

[.contract-item]
[[Votes-_transferVotingUnits-address-address-uint256-]]
==== `[.contract-item-name]#++_transferVotingUnits++#++(address from, address to, uint256 amount)++` [.item-kind]#internal#

Transfers, mints, or burns voting units. To register a mint, `from` should be zero. To register a burn, `to`
should be zero. Total supply of voting units will be adjusted with mints and burns.

[.contract-item]
[[Votes-_useNonce-address-]]
==== `[.contract-item-name]#++_useNonce++#++(address owner) → uint256 current++` [.item-kind]#internal#

Consumes a nonce.

Returns the current value and increments nonce.

[.contract-item]
[[Votes-nonces-address-]]
==== `[.contract-item-name]#++nonces++#++(address owner) → uint256++` [.item-kind]#public#

Returns an address nonce.

[.contract-item]
[[Votes-DOMAIN_SEPARATOR--]]
==== `[.contract-item-name]#++DOMAIN_SEPARATOR++#++() → bytes32++` [.item-kind]#external#

Returns the contract's {EIP712} domain separator.

[.contract-item]
[[Votes-_getVotingUnits-address-]]
==== `[.contract-item-name]#++_getVotingUnits++#++(address) → uint256++` [.item-kind]#internal#

Must return the voting units held by an account.

== Timelock

In a governance system, the {TimelockController} contract is in charge of introducing a delay between a proposal and its execution. It can be used with or without a {Governor}.

:TIMELOCK_ADMIN_ROLE: pass:normal[xref:#TimelockController-TIMELOCK_ADMIN_ROLE-bytes32[`++TIMELOCK_ADMIN_ROLE++`]]
:PROPOSER_ROLE: pass:normal[xref:#TimelockController-PROPOSER_ROLE-bytes32[`++PROPOSER_ROLE++`]]
:EXECUTOR_ROLE: pass:normal[xref:#TimelockController-EXECUTOR_ROLE-bytes32[`++EXECUTOR_ROLE++`]]
:CANCELLER_ROLE: pass:normal[xref:#TimelockController-CANCELLER_ROLE-bytes32[`++CANCELLER_ROLE++`]]
:_DONE_TIMESTAMP: pass:normal[xref:#TimelockController-_DONE_TIMESTAMP-uint256[`++_DONE_TIMESTAMP++`]]
:CallScheduled: pass:normal[xref:#TimelockController-CallScheduled-bytes32-uint256-address-uint256-bytes-bytes32-uint256-[`++CallScheduled++`]]
:CallExecuted: pass:normal[xref:#TimelockController-CallExecuted-bytes32-uint256-address-uint256-bytes-[`++CallExecuted++`]]
:CallSalt: pass:normal[xref:#TimelockController-CallSalt-bytes32-bytes32-[`++CallSalt++`]]
:Cancelled: pass:normal[xref:#TimelockController-Cancelled-bytes32-[`++Cancelled++`]]
:MinDelayChange: pass:normal[xref:#TimelockController-MinDelayChange-uint256-uint256-[`++MinDelayChange++`]]
:constructor: pass:normal[xref:#TimelockController-constructor-uint256-address---address---address-[`++constructor++`]]
:onlyRoleOrOpenRole: pass:normal[xref:#TimelockController-onlyRoleOrOpenRole-bytes32-[`++onlyRoleOrOpenRole++`]]
:receive: pass:normal[xref:#TimelockController-receive--[`++receive++`]]
:supportsInterface: pass:normal[xref:#TimelockController-supportsInterface-bytes4-[`++supportsInterface++`]]
:isOperation: pass:normal[xref:#TimelockController-isOperation-bytes32-[`++isOperation++`]]
:isOperationPending: pass:normal[xref:#TimelockController-isOperationPending-bytes32-[`++isOperationPending++`]]
:isOperationReady: pass:normal[xref:#TimelockController-isOperationReady-bytes32-[`++isOperationReady++`]]
:isOperationDone: pass:normal[xref:#TimelockController-isOperationDone-bytes32-[`++isOperationDone++`]]
:getTimestamp: pass:normal[xref:#TimelockController-getTimestamp-bytes32-[`++getTimestamp++`]]
:getMinDelay: pass:normal[xref:#TimelockController-getMinDelay--[`++getMinDelay++`]]
:hashOperation: pass:normal[xref:#TimelockController-hashOperation-address-uint256-bytes-bytes32-bytes32-[`++hashOperation++`]]
:hashOperationBatch: pass:normal[xref:#TimelockController-hashOperationBatch-address---uint256---bytes---bytes32-bytes32-[`++hashOperationBatch++`]]
:schedule: pass:normal[xref:#TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-[`++schedule++`]]
:scheduleBatch: pass:normal[xref:#TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-[`++scheduleBatch++`]]
:cancel: pass:normal[xref:#TimelockController-cancel-bytes32-[`++cancel++`]]
:execute: pass:normal[xref:#TimelockController-execute-address-uint256-bytes-bytes32-bytes32-[`++execute++`]]
:executeBatch: pass:normal[xref:#TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-[`++executeBatch++`]]
:_execute: pass:normal[xref:#TimelockController-_execute-address-uint256-bytes-[`++_execute++`]]
:updateDelay: pass:normal[xref:#TimelockController-updateDelay-uint256-[`++updateDelay++`]]
:onERC721Received: pass:normal[xref:#TimelockController-onERC721Received-address-address-uint256-bytes-[`++onERC721Received++`]]
:onERC1155Received: pass:normal[xref:#TimelockController-onERC1155Received-address-address-uint256-uint256-bytes-[`++onERC1155Received++`]]
:onERC1155BatchReceived: pass:normal[xref:#TimelockController-onERC1155BatchReceived-address-address-uint256---uint256---bytes-[`++onERC1155BatchReceived++`]]

[.contract]
[[TimelockController]]
=== `++TimelockController++` link:https://github.com/OpenZeppelin/openzeppelin-contracts/blob/v4.9.5/contracts/governance/TimelockController.sol[{github-icon},role=heading-link]

[.hljs-theme-light.nopadding]
```solidity
import "@openzeppelin/contracts/governance/TimelockController.sol";
```

Contract module which acts as a timelocked controller. When set as the
owner of an `Ownable` smart contract, it enforces a timelock on all
`onlyOwner` maintenance operations. This gives time for users of the
controlled contract to exit before a potentially dangerous maintenance
operation is applied.

By default, this contract is self administered, meaning administration tasks
have to go through the timelock process. The proposer (resp executor) role
is in charge of proposing (resp executing) operations. A common use case is
to position this {TimelockController} as the owner of a smart contract, with
a multisig or a DAO as the sole proposer.

_Available since v3.3._

[.contract-index]
.Modifiers
--
* {xref-TimelockController-onlyRoleOrOpenRole-bytes32-}[`++onlyRoleOrOpenRole(role)++`]
--

[.contract-index]
.Functions
--
* {xref-TimelockController-constructor-uint256-address---address---address-}[`++constructor(minDelay, proposers, executors, admin)++`]
* {xref-TimelockController-receive--}[`++receive()++`]
* {xref-TimelockController-supportsInterface-bytes4-}[`++supportsInterface(interfaceId)++`]
* {xref-TimelockController-isOperation-bytes32-}[`++isOperation(id)++`]
* {xref-TimelockController-isOperationPending-bytes32-}[`++isOperationPending(id)++`]
* {xref-TimelockController-isOperationReady-bytes32-}[`++isOperationReady(id)++`]
* {xref-TimelockController-isOperationDone-bytes32-}[`++isOperationDone(id)++`]
* {xref-TimelockController-getTimestamp-bytes32-}[`++getTimestamp(id)++`]
* {xref-TimelockController-getMinDelay--}[`++getMinDelay()++`]
* {xref-TimelockController-hashOperation-address-uint256-bytes-bytes32-bytes32-}[`++hashOperation(target, value, data, predecessor, salt)++`]
* {xref-TimelockController-hashOperationBatch-address---uint256---bytes---bytes32-bytes32-}[`++hashOperationBatch(targets, values, payloads, predecessor, salt)++`]
* {xref-TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-}[`++schedule(target, value, data, predecessor, salt, delay)++`]
* {xref-TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-}[`++scheduleBatch(targets, values, payloads, predecessor, salt, delay)++`]
* {xref-TimelockController-cancel-bytes32-}[`++cancel(id)++`]
* {xref-TimelockController-execute-address-uint256-bytes-bytes32-bytes32-}[`++execute(target, value, payload, predecessor, salt)++`]
* {xref-TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-}[`++executeBatch(targets, values, payloads, predecessor, salt)++`]
* {xref-TimelockController-_execute-address-uint256-bytes-}[`++_execute(target, value, data)++`]
* {xref-TimelockController-updateDelay-uint256-}[`++updateDelay(newDelay)++`]
* {xref-TimelockController-onERC721Received-address-address-uint256-bytes-}[`++onERC721Received(, , , )++`]
* {xref-TimelockController-onERC1155Received-address-address-uint256-uint256-bytes-}[`++onERC1155Received(, , , , )++`]
* {xref-TimelockController-onERC1155BatchReceived-address-address-uint256---uint256---bytes-}[`++onERC1155BatchReceived(, , , , )++`]

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.AccessControl
* {xref-AccessControl-hasRole-bytes32-address-}[`++hasRole(role, account)++`]
* {xref-AccessControl-_checkRole-bytes32-}[`++_checkRole(role)++`]
* {xref-AccessControl-_checkRole-bytes32-address-}[`++_checkRole(role, account)++`]
* {xref-AccessControl-getRoleAdmin-bytes32-}[`++getRoleAdmin(role)++`]
* {xref-AccessControl-grantRole-bytes32-address-}[`++grantRole(role, account)++`]
* {xref-AccessControl-revokeRole-bytes32-address-}[`++revokeRole(role, account)++`]
* {xref-AccessControl-renounceRole-bytes32-address-}[`++renounceRole(role, account)++`]
* {xref-AccessControl-_setupRole-bytes32-address-}[`++_setupRole(role, account)++`]
* {xref-AccessControl-_setRoleAdmin-bytes32-bytes32-}[`++_setRoleAdmin(role, adminRole)++`]
* {xref-AccessControl-_grantRole-bytes32-address-}[`++_grantRole(role, account)++`]
* {xref-AccessControl-_revokeRole-bytes32-address-}[`++_revokeRole(role, account)++`]

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

[.contract-subindex-inherited]
.IAccessControl

--

[.contract-index]
.Events
--
* {xref-TimelockController-CallScheduled-bytes32-uint256-address-uint256-bytes-bytes32-uint256-}[`++CallScheduled(id, index, target, value, data, predecessor, delay)++`]
* {xref-TimelockController-CallExecuted-bytes32-uint256-address-uint256-bytes-}[`++CallExecuted(id, index, target, value, data)++`]
* {xref-TimelockController-CallSalt-bytes32-bytes32-}[`++CallSalt(id, salt)++`]
* {xref-TimelockController-Cancelled-bytes32-}[`++Cancelled(id)++`]
* {xref-TimelockController-MinDelayChange-uint256-uint256-}[`++MinDelayChange(oldDuration, newDuration)++`]

[.contract-subindex-inherited]
.IERC1155Receiver

[.contract-subindex-inherited]
.IERC721Receiver

[.contract-subindex-inherited]
.AccessControl

[.contract-subindex-inherited]
.ERC165

[.contract-subindex-inherited]
.IERC165

[.contract-subindex-inherited]
.IAccessControl
* {xref-IAccessControl-RoleAdminChanged-bytes32-bytes32-bytes32-}[`++RoleAdminChanged(role, previousAdminRole, newAdminRole)++`]
* {xref-IAccessControl-RoleGranted-bytes32-address-address-}[`++RoleGranted(role, account, sender)++`]
* {xref-IAccessControl-RoleRevoked-bytes32-address-address-}[`++RoleRevoked(role, account, sender)++`]

--

[.contract-item]
[[TimelockController-onlyRoleOrOpenRole-bytes32-]]
==== `[.contract-item-name]#++onlyRoleOrOpenRole++#++(bytes32 role)++` [.item-kind]#modifier#

Modifier to make a function callable only by a certain role. In
addition to checking the sender's role, `address(0)` 's role is also
considered. Granting a role to `address(0)` is equivalent to enabling
this role for everyone.

[.contract-item]
[[TimelockController-constructor-uint256-address---address---address-]]
==== `[.contract-item-name]#++constructor++#++(uint256 minDelay, address[] proposers, address[] executors, address admin)++` [.item-kind]#public#

Initializes the contract with the following parameters:

- `minDelay`: initial minimum delay for operations
- `proposers`: accounts to be granted proposer and canceller roles
- `executors`: accounts to be granted executor role
- `admin`: optional account to be granted admin role; disable with zero address

IMPORTANT: The optional admin can aid with initial configuration of roles after deployment
without being subject to delay, but this role should be subsequently renounced in favor of
administration through timelocked proposals. Previous versions of this contract would assign
this admin to the deployer automatically and should be renounced as well.

[.contract-item]
[[TimelockController-receive--]]
==== `[.contract-item-name]#++receive++#++()++` [.item-kind]#external#

Contract might receive/hold ETH as part of the maintenance process.

[.contract-item]
[[TimelockController-supportsInterface-bytes4-]]
==== `[.contract-item-name]#++supportsInterface++#++(bytes4 interfaceId) → bool++` [.item-kind]#public#

See {IERC165-supportsInterface}.

[.contract-item]
[[TimelockController-isOperation-bytes32-]]
==== `[.contract-item-name]#++isOperation++#++(bytes32 id) → bool++` [.item-kind]#public#

Returns whether an id correspond to a registered operation. This
includes both Pending, Ready and Done operations.

[.contract-item]
[[TimelockController-isOperationPending-bytes32-]]
==== `[.contract-item-name]#++isOperationPending++#++(bytes32 id) → bool++` [.item-kind]#public#

Returns whether an operation is pending or not. Note that a "pending" operation may also be "ready".

[.contract-item]
[[TimelockController-isOperationReady-bytes32-]]
==== `[.contract-item-name]#++isOperationReady++#++(bytes32 id) → bool++` [.item-kind]#public#

Returns whether an operation is ready for execution. Note that a "ready" operation is also "pending".

[.contract-item]
[[TimelockController-isOperationDone-bytes32-]]
==== `[.contract-item-name]#++isOperationDone++#++(bytes32 id) → bool++` [.item-kind]#public#

Returns whether an operation is done or not.

[.contract-item]
[[TimelockController-getTimestamp-bytes32-]]
==== `[.contract-item-name]#++getTimestamp++#++(bytes32 id) → uint256++` [.item-kind]#public#

Returns the timestamp at which an operation becomes ready (0 for
unset operations, 1 for done operations).

[.contract-item]
[[TimelockController-getMinDelay--]]
==== `[.contract-item-name]#++getMinDelay++#++() → uint256++` [.item-kind]#public#

Returns the minimum delay for an operation to become valid.

This value can be changed by executing an operation that calls `updateDelay`.

[.contract-item]
[[TimelockController-hashOperation-address-uint256-bytes-bytes32-bytes32-]]
==== `[.contract-item-name]#++hashOperation++#++(address target, uint256 value, bytes data, bytes32 predecessor, bytes32 salt) → bytes32++` [.item-kind]#public#

Returns the identifier of an operation containing a single
transaction.

[.contract-item]
[[TimelockController-hashOperationBatch-address---uint256---bytes---bytes32-bytes32-]]
==== `[.contract-item-name]#++hashOperationBatch++#++(address[] targets, uint256[] values, bytes[] payloads, bytes32 predecessor, bytes32 salt) → bytes32++` [.item-kind]#public#

Returns the identifier of an operation containing a batch of
transactions.

[.contract-item]
[[TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-]]
==== `[.contract-item-name]#++schedule++#++(address target, uint256 value, bytes data, bytes32 predecessor, bytes32 salt, uint256 delay)++` [.item-kind]#public#

Schedule an operation containing a single transaction.

Emits {CallSalt} if salt is nonzero, and {CallScheduled}.

Requirements:

- the caller must have the 'proposer' role.

[.contract-item]
[[TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-]]
==== `[.contract-item-name]#++scheduleBatch++#++(address[] targets, uint256[] values, bytes[] payloads, bytes32 predecessor, bytes32 salt, uint256 delay)++` [.item-kind]#public#

Schedule an operation containing a batch of transactions.

Emits {CallSalt} if salt is nonzero, and one {CallScheduled} event per transaction in the batch.

Requirements:

- the caller must have the 'proposer' role.

[.contract-item]
[[TimelockController-cancel-bytes32-]]
==== `[.contract-item-name]#++cancel++#++(bytes32 id)++` [.item-kind]#public#

Cancel an operation.

Requirements:

- the caller must have the 'canceller' role.

[.contract-item]
[[TimelockController-execute-address-uint256-bytes-bytes32-bytes32-]]
==== `[.contract-item-name]#++execute++#++(address target, uint256 value, bytes payload, bytes32 predecessor, bytes32 salt)++` [.item-kind]#public#

Execute an (ready) operation containing a single transaction.

Emits a {CallExecuted} event.

Requirements:

- the caller must have the 'executor' role.

[.contract-item]
[[TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-]]
==== `[.contract-item-name]#++executeBatch++#++(address[] targets, uint256[] values, bytes[] payloads, bytes32 predecessor, bytes32 salt)++` [.item-kind]#public#

Execute an (ready) operation containing a batch of transactions.

Emits one {CallExecuted} event per transaction in the batch.

Requirements:

- the caller must have the 'executor' role.

[.contract-item]
[[TimelockController-_execute-address-uint256-bytes-]]
==== `[.contract-item-name]#++_execute++#++(address target, uint256 value, bytes data)++` [.item-kind]#internal#

Execute an operation's call.

[.contract-item]
[[TimelockController-updateDelay-uint256-]]
==== `[.contract-item-name]#++updateDelay++#++(uint256 newDelay)++` [.item-kind]#external#

Changes the minimum timelock duration for future operations.

Emits a {MinDelayChange} event.

Requirements:

- the caller must be the timelock itself. This can only be achieved by scheduling and later executing
an operation where the timelock is the target and the data is the ABI-encoded call to this function.

[.contract-item]
[[TimelockController-onERC721Received-address-address-uint256-bytes-]]
==== `[.contract-item-name]#++onERC721Received++#++(address, address, uint256, bytes) → bytes4++` [.item-kind]#public#

See {IERC721Receiver-onERC721Received}.

[.contract-item]
[[TimelockController-onERC1155Received-address-address-uint256-uint256-bytes-]]
==== `[.contract-item-name]#++onERC1155Received++#++(address, address, uint256, uint256, bytes) → bytes4++` [.item-kind]#public#

See {IERC1155Receiver-onERC1155Received}.

[.contract-item]
[[TimelockController-onERC1155BatchReceived-address-address-uint256---uint256---bytes-]]
==== `[.contract-item-name]#++onERC1155BatchReceived++#++(address, address, uint256[], uint256[], bytes) → bytes4++` [.item-kind]#public#

See {IERC1155Receiver-onERC1155BatchReceived}.

[.contract-item]
[[TimelockController-CallScheduled-bytes32-uint256-address-uint256-bytes-bytes32-uint256-]]
==== `[.contract-item-name]#++CallScheduled++#++(bytes32 indexed id, uint256 indexed index, address target, uint256 value, bytes data, bytes32 predecessor, uint256 delay)++` [.item-kind]#event#

Emitted when a call is scheduled as part of operation `id`.

[.contract-item]
[[TimelockController-CallExecuted-bytes32-uint256-address-uint256-bytes-]]
==== `[.contract-item-name]#++CallExecuted++#++(bytes32 indexed id, uint256 indexed index, address target, uint256 value, bytes data)++` [.item-kind]#event#

Emitted when a call is performed as part of operation `id`.

[.contract-item]
[[TimelockController-CallSalt-bytes32-bytes32-]]
==== `[.contract-item-name]#++CallSalt++#++(bytes32 indexed id, bytes32 salt)++` [.item-kind]#event#

Emitted when new proposal is scheduled with non-zero salt.

[.contract-item]
[[TimelockController-Cancelled-bytes32-]]
==== `[.contract-item-name]#++Cancelled++#++(bytes32 indexed id)++` [.item-kind]#event#

Emitted when operation `id` is cancelled.

[.contract-item]
[[TimelockController-MinDelayChange-uint256-uint256-]]
==== `[.contract-item-name]#++MinDelayChange++#++(uint256 oldDuration, uint256 newDuration)++` [.item-kind]#event#

Emitted when the minimum delay for future operations is modified.

[[timelock-terminology]]
==== Terminology

* *Operation:* A transaction (or a set of transactions) that is the subject of the timelock. It has to be scheduled by a proposer and executed by an executor. The timelock enforces a minimum delay between the proposition and the execution (see xref:access-control.adoc#operation_lifecycle[operation lifecycle]). If the operation contains multiple transactions (batch mode), they are executed atomically. Operations are identified by the hash of their content.
* *Operation status:*
** *Unset:* An operation that is not part of the timelock mechanism.
** *Pending:* An operation that has been scheduled, before the timer expires.
** *Ready:* An operation that has been scheduled, after the timer expires.
** *Done:* An operation that has been executed.
* *Predecessor*: An (optional) dependency between operations. An operation can depend on another operation (its predecessor), forcing the execution order of these two operations.
* *Role*:
** *Admin:* An address (smart contract or EOA) that is in charge of granting the roles of Proposer and Executor.
** *Proposer:* An address (smart contract or EOA) that is in charge of scheduling (and cancelling) operations.
** *Executor:* An address (smart contract or EOA) that is in charge of executing operations once the timelock has expired. This role can be given to the zero address to allow anyone to execute operations.

[[timelock-operation]]
==== Operation structure

Operation executed by the xref:api:governance.adoc#TimelockController[`TimelockController`] can contain one or multiple subsequent calls. Depending on whether you need to multiple calls to be executed atomically, you can either use simple or batched operations.

Both operations contain:

* *Target*, the address of the smart contract that the timelock should operate on.
* *Value*, in wei, that should be sent with the transaction. Most of the time this will be 0. Ether can be deposited before-end or passed along when executing the transaction.
* *Data*, containing the encoded function selector and parameters of the call. This can be produced using a number of tools. For example, a maintenance operation granting role `ROLE` to `ACCOUNT` can be encoded using web3js as follows:

```javascript
const data = timelock.contract.methods.grantRole(ROLE, ACCOUNT).encodeABI()
```

* *Predecessor*, that specifies a dependency between operations. This dependency is optional. Use `bytes32(0)` if the operation does not have any dependency.
* *Salt*, used to disambiguate two otherwise identical operations. This can be any random value.

In the case of batched operations, `target`, `value` and `data` are specified as arrays, which must be of the same length.

[[timelock-operation-lifecycle]]
==== Operation lifecycle

Timelocked operations are identified by a unique id (their hash) and follow a specific lifecycle:

`Unset` -> `Pending` -> `Pending` + `Ready` -> `Done`

* By calling xref:api:governance.adoc#TimelockController-schedule-address-uint256-bytes-bytes32-bytes32-uint256-[`schedule`] (or xref:api:governance.adoc#TimelockController-scheduleBatch-address---uint256---bytes---bytes32-bytes32-uint256-[`scheduleBatch`]), a proposer moves the operation from the `Unset` to the `Pending` state. This starts a timer that must be longer than the minimum delay. The timer expires at a timestamp accessible through the xref:api:governance.adoc#TimelockController-getTimestamp-bytes32-[`getTimestamp`] method.
* Once the timer expires, the operation automatically gets the `Ready` state. At this point, it can be executed.
* By calling xref:api:governance.adoc#TimelockController-TimelockController-execute-address-uint256-bytes-bytes32-bytes32-[`execute`] (or xref:api:governance.adoc#TimelockController-executeBatch-address---uint256---bytes---bytes32-bytes32-[`executeBatch`]), an executor triggers the operation's underlying transactions and moves it to the `Done` state. If the operation has a predecessor, it has to be in the `Done` state for this transition to succeed.
* xref:api:governance.adoc#TimelockController-TimelockController-cancel-bytes32-[`cancel`] allows proposers to cancel any `Pending` operation. This resets the operation to the `Unset` state. It is thus possible for a proposer to re-schedule an operation that has been cancelled. In this case, the timer restarts when the operation is re-scheduled.

Operations status can be queried using the functions:

* xref:api:governance.adoc#TimelockController-isOperationPending-bytes32-[`isOperationPending(bytes32)`]
* xref:api:governance.adoc#TimelockController-isOperationReady-bytes32-[`isOperationReady(bytes32)`]
* xref:api:governance.adoc#TimelockController-isOperationDone-bytes32-[`isOperationDone(bytes32)`]

[[timelock-roles]]
==== Roles

[[timelock-admin]]
===== Admin

The admins are in charge of managing proposers and executors. For the timelock to be self-governed, this role should only be given to the timelock itself. Upon deployment, the admin role can be granted to any address (in addition to the timelock itself). After further configuration and testing, this optional admin should renounce its role such that all further maintenance operations have to go through the timelock process.

This role is identified by the *TIMELOCK_ADMIN_ROLE* value: `0x5f58e3a2316349923ce3780f8d587db2d72378aed66a8261c916544fa6846ca5`

[[timelock-proposer]]
===== Proposer

The proposers are in charge of scheduling (and cancelling) operations. This is a critical role, that should be given to governing entities. This could be an EOA, a multisig, or a DAO.

WARNING: *Proposer fight:* Having multiple proposers, while providing redundancy in case one becomes unavailable, can be dangerous. As proposer have their say on all operations, they could cancel operations they disagree with, including operations to remove them for the proposers.

This role is identified by the *PROPOSER_ROLE* value: `0xb09aa5aeb3702cfd50b6b62bc4532604938f21248a27a1d5ca736082b6819cc1`

[[timelock-executor]]
===== Executor

The executors are in charge of executing the operations scheduled by the proposers once the timelock expires. Logic dictates that multisig or DAO that are proposers should also be executors in order to guarantee operations that have been scheduled will eventually be executed. However, having additional executors can reduce the cost (the executing transaction does not require validation by the multisig or DAO that proposed it), while ensuring whoever is in charge of execution cannot trigger actions that have not been scheduled by the proposers. Alternatively, it is possible to allow _any_ address to execute a proposal once the timelock has expired by granting the executor role to the zero address.

This role is identified by the *EXECUTOR_ROLE* value: `0xd8aa0f3194971a2a116679f7c2090f6939c8d4e01a2a8d7e41d55e5351469e63`

WARNING: A live contract without at least one proposer and one executor is locked. Make sure these roles are filled by reliable entities before the deployer renounces its administrative rights in favour of the timelock contract itself. See the {AccessControl} documentation to learn more about role management.