Skip to content

governor

Governance operations: Governor proposals, voting, vote delegation, and TimelockController scheduling.

load governor
CommandDescription
governor:cancelCancel a pending Governor proposal (only its proposer, before voting starts). Takes the same description and action block used in governor:propose.
governor:delegateDelegate the voting power the connected account holds in an ERC20Votes/ERC721Votes token.
governor:executeExecute a succeeded (and queued, if the Governor uses a timelock) proposal. Takes the same description and action block used in governor:propose.
governor:proposeCreate a Governor proposal from a block of commands: each action in the block becomes one of the proposal calls. Optionally binds the proposal id to a variable.
governor:queueQueue a succeeded Governor proposal into its timelock. Takes the same description and action block used in governor:propose.
governor:timelock-cancelCancel a pending TimelockController operation. The sender needs the CANCELLER_ROLE.
governor:timelock-executeExecute a ready TimelockController operation. Takes the same action block, predecessor and salt used in governor:timelock-schedule.
governor:timelock-scheduleSchedule a batch of actions on a TimelockController. Optionally binds the operation id to a variable for later state checks or cancellation.
governor:voteCast a vote on an active Governor proposal.
HelperReturnsDescription
@governor:proposalIdnumberProposal id of a Governor proposal, derived from its targets, values, calldatas and description. Prefer the optional variable of governor:propose when creating the proposal in the same script.
@governor:proposalStatestringCurrent state of a Governor proposal: Pending, Active, Canceled, Defeated, Succeeded, Queued, Expired or Executed.
@governor:timelockMinDelaynumberMinimum delay in seconds a TimelockController enforces on new operations.
@governor:timelockOperationStatestringState of a TimelockController operation: Unset, Waiting, Ready or Done.