Governance

Name of the governor instance (used in building the SNIP-12 domain separator).

Version of the governor instance (used in building SNIP-12 domain separator).

A description of the possible support values for cast_vote 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.

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

Returns the state of a proposal, given its id.

The number of votes required in order for a voter to become a proposer.

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

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.

The account that created a proposal.

The time when a queued proposal becomes executable ("ETA"). Unlike proposal_snapshot and proposal_deadline, this doesn't use the governor clock, and instead relies on the executor's clock which may be different. In most cases this will be a timestamp.

Whether a proposal needs to be queued before execution. This indicates if the proposal needs to go through a timelock.

Delay between when a proposal is created and when the vote starts. The unit this duration is expressed in depends on the clock (see ERC-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.

Delay between when a vote starts and when it ends. The unit this duration is expressed in depends on the clock (see ERC-6372) this contract uses.

The voting_delay can delay the start of the vote. This must be considered when setting the voting duration compared to the voting delay.

This value is stored when the proposal is submitted so that possible changes to the value do not affect proposals that have already been submitted.

Minimum number of votes required for a proposal to be successful.

The timepoint parameter corresponds to the snapshot used for counting vote. This allows the quorum to scale depending on values such as the total supply of a token at this timepoint.

Returns the voting power of an account at a specific timepoint.

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

Returns the voting power of an account at a specific timepoint, given additional encoded parameters.

Returns whether an account has cast a vote on a proposal.

Creates a new proposal. Vote starts after a delay specified by voting_delay and lasts for a duration specified by voting_period.

The state of the Governor and targets may change between the proposal creation and its execution. This may be the result of third party actions on the targeted contracts, or other governor proposals. For example, the balance of this contract could be updated or its access control permissions may be modified, possibly compromising the proposal's ability to execute successfully (e.g. the governor doesn't have enough value to cover a proposal with multiple transfers).

Returns the id of the proposal.

Queue a proposal. Some governors require this step to be performed before execution can happen. If queuing is not necessary, this function may revert.

Queuing a proposal requires the quorum to be reached, the vote to be successful, and the deadline to be reached.

Returns the id of the proposal.

Execute a successful proposal. This requires the quorum to be reached, the vote to be successful, and the deadline to be reached. Depending on the governor it might also be required that the proposal was queued and that some delay passed.

Some modules can modify the requirements for execution, for example by adding an additional timelock (See timelock_controller).

Returns the id of the proposal.

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

Returns the id of the proposal.

Cast a vote on a proposal.

Returns the weight of the vote.

Cast a vote on a proposal with a reason.

Returns the weight of the vote.

Cast a vote on a proposal with a reason and additional encoded parameters.

Returns the weight of the vote.

Cast a vote on a proposal using the voter's signature.

Returns the weight of the vote.

Cast a vote on a proposal with a reason and additional encoded parameters using the voter's signature.

Returns the weight of the vote.

Returns the next unused nonce for an address.

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 that were sent to the governor contract by mistake.

If the executor is simply the governor itself, use of relay is redundant.

Emitted when a proposal is created.

Emitted when a proposal is queued.

Emitted when a proposal is executed.

Emitted when a proposal is canceled.

Emitted when a vote is cast.

Emitted when a vote is cast with params.

Returns the current quorum value. The quorum is the minimum number of confirmations required to approve a transaction.

Returns whether the given signer is registered. Only registered signers can submit, confirm, or execute transactions.

Returns the list of all current signers.

Returns whether the transaction with the given id has been confirmed.

Returns whether the transaction with the given id has been confirmed by the specified signer.

Returns whether the transaction with the given id has been executed.

Returns the block number when the transaction with the given id was submitted.

Returns the current state of the transaction with the given id.

Returns the number of confirmations from registered signers for the transaction with the specified id.

Returns the computed identifier of a transaction containing a single call.

Returns the computed identifier of a transaction containing a batch of calls.

Adds new signers and updates the quorum.

Requirements:

• The caller must be the contract itself.
• new_quorum must be less than or equal to the total number of signers after addition.

Emits a SignerAdded event for each signer added.

Emits a QuorumUpdated event if the quorum changes.

Removes signers and updates the quorum.

Requirements:

• The caller must be the contract itself.
• new_quorum must be less than or equal to the total number of signers after removal.

Emits a SignerRemoved event for each signer removed.

Emits a QuorumUpdated event if the quorum changes.

Replaces an existing signer with a new signer.

Requirements:

• The caller must be the contract itself.
• signer_to_remove must be an existing signer.
• signer_to_add must not be an existing signer.

Emits a SignerRemoved event for the removed signer.

Emits a SignerAdded event for the new signer.

Updates the quorum value to new_quorum if it differs from the current quorum.

Requirements:

• The caller must be the contract itself.
• new_quorum must be non-zero.
• new_quorum must be less than or equal to the total number of signers.

Emits a QuorumUpdated event if the quorum changes.

Submits a new transaction for confirmation.

Requirements:

• The caller must be a registered signer.
• The transaction must not have been submitted before.

Emits a TransactionSubmitted event.

Emits a CallSalt event if salt is not zero.

Submits a new batch transaction for confirmation.

Requirements:

• The caller must be a registered signer.
• The transaction must not have been submitted before.

Emits a TransactionSubmitted event.

Emits a CallSalt event if salt is not zero.

Confirms a transaction with the given id.

Requirements:

• The caller must be a registered signer.
• The transaction must exist and not be executed.
• The caller must not have already confirmed the transaction.

Emits a TransactionConfirmed event.

Revokes a previous confirmation for a transaction with the given id.

Requirements:

• The transaction must exist and not be executed.
• The caller must have previously confirmed the transaction.

Emits a ConfirmationRevoked event.

Executes a confirmed transaction.

Requirements:

• The caller must be a registered signer.
• The transaction must be confirmed and not yet executed.

Emits a TransactionExecuted event.

Executes a confirmed batch transaction.

Requirements:

• The caller must be a registered signer.
• The transaction must be confirmed and not yet executed.

Emits a TransactionExecuted event.

Emitted when a new signer is added.

Emitted when a signer is removed.

Emitted when the quorum value is updated.

Emitted when a new transaction is submitted by a signer.

Emitted when a transaction is confirmed by a signer.

Emitted when a signer revokes his confirmation.

Emitted when a transaction is executed.

Emitted when a new transaction is submitted with non-zero salt.

Returns whether id corresponds to a registered operation. This includes the OperationStates: Waiting, Ready, and Done.

Returns whether the id OperationState is pending or not. Note that a pending operation may be either Waiting or Ready.

Returns whether the id OperationState is Ready or not.

Returns whether the id OperationState is Done or not.

Returns the timestamp at which id becomes Ready.

0 means the OperationState is Unset and 1 means the OperationState is Done.

Returns the current state of the operation with the given id.

The possible states are:

• Unset: the operation has not been scheduled or has been canceled.
• Waiting: the operation has been scheduled and is pending the scheduled delay.
• Ready: the timer has expired, and the operation is eligible for execution.
• Done: the operation has been executed.

Returns the minimum delay in seconds for an operation to become valid. This value can be changed by executing an operation that calls update_delay.

Returns the identifier of an operation containing a single transaction.

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

Schedule an operation containing a single transaction.

Requirements:

• The caller must have the PROPOSER_ROLE role.

Emits CallScheduled event. Emits CallSalt event if salt is not zero.

Schedule an operation containing a batch of transactions.

Requirements:

• The caller must have the PROPOSER_ROLE role.

Emits one CallScheduled event for each transaction in the batch. Emits CallSalt event if salt is not zero.

Cancels an operation. A canceled operation returns to Unset OperationState.

Requirements:

• The caller must have the CANCELLER_ROLE role.
• id must be a pending operation.

Emits a CallCancelled event.

Execute a (Ready) operation containing a single Call.

Requirements:

• Caller must have EXECUTOR_ROLE.
• id must be in Ready OperationState.
• predecessor must either be 0 or in Done OperationState.

Emits a CallExecuted event.

This function can reenter, but it doesn't pose a risk because _after_call(self: @ContractState, id: felt252) internal checks that the proposal is pending, thus any modifications to the operation during reentrancy should be caught.

Execute a (Ready) operation containing a batch of Calls.

Requirements:

• Caller must have EXECUTOR_ROLE.
• id must be in Ready OperationState.
• predecessor must either be 0 or in Done OperationState.

Emits a CallExecuted event for each Call.

This function can reenter, but it doesn't pose a risk because _after_call checks that the proposal is pending, thus any modifications to the operation during reentrancy should be caught.

Changes the minimum timelock duration for future operations.

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 serialized call to this function.

Emits a MinDelayChanged event.

Emitted when call is scheduled as part of operation id.

Emitted when call is performed as part of operation id.

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

Emitted when operation id is cancelled.

Emitted when the minimum delay for future operations is modified.

Returns the current amount of votes that account has.

Returns the amount of votes that account had at a specific moment in the past.

Returns the total supply of votes available at a specific moment in the past.

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.

Returns the delegate that account has chosen.

Delegates votes from the sender to delegatee.

Delegates votes from delegator to delegatee through a SNIP-12 message signature validation.

Returns the current timepoint determined by the contract's operational mode, intended for use in time-sensitive logic. See ERC-6372#clock.

Requirements:

• This function MUST always be non-decreasing.

Returns a description of the clock the contract is operating in. See ERC-6372#CLOCK_MODE.

Requirements:

• The output MUST be formatted like a URL query string, decodable in standard JavaScript.

Must return the delay, in number of timepoints, between when the proposal is created and when the vote starts. This can be increased to leave time for users to buy voting power, or delegate it, before the voting of a proposal starts.

Must return the delay, in number of timepoints, between the vote start and vote end.

Must return the minimum number of votes that an account must have to create a proposal.

Must return the minimum number of votes required for a proposal to succeed.

Must return a description of the possible support values for cast_vote and the way these votes are counted, meant to be consumed by UIs to show correct vote options and interpret the results. See COUNTING_MODE for more details.

Must register a vote for proposal_id by account with a given support, voting weight and voting params.

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

Must return whether an account has cast a vote on a proposal.

Must return whether the minimum quorum has been reached for a proposal.

Must return whether a proposal has succeeded or not.

Returns the current timepoint determined by the governor's operational mode, intended for use in time-sensitive logic. See ERC-6372#clock.

Requirements:

• This function MUST always be non-decreasing.

Returns a description of the clock the governor is operating in. See ERC-6372#CLOCK_MODE.

Requirements:

• The output MUST be formatted like a URL query string, decodable in standard JavaScript.

Must return the voting power of an account at a specific timepoint with the given parameters.

Must return the state of a proposal at the current time.

The state can be either:

• Pending: The proposal does not exist yet.
• Active: The proposal is active.
• Canceled: The proposal has been canceled.
• Defeated: The proposal has been defeated.
• Succeeded: The proposal has succeeded.
• Queued: The proposal has been queued.
• Executed: The proposal has been executed.

Must return the address through which the governor executes action. Should be used to specify whether the module execute actions through another contract such as a timelock.

MUST be the governor itself, or an instance of TimelockController with the governor as the only proposer, canceller, and executor.

When the executor is not the governor itself (i.e. a timelock), it can call functions that are restricted with the assert_only_governance guard, and also potentially execute transactions on behalf of the governor. Because of this, this module is designed to work with the TimelockController as the unique potential external executor.

Execution mechanism. Can be used to modify the way operations are executed (for example adding a vault/timelock).

Queuing mechanism. Can be used to modify the way queuing is performed (for example adding a vault/timelock).

Requirements:

• Must return a timestamp that describes the expected ETA for execution. If the returned value is 0, the core will consider queueing did not succeed, and the public queue function will revert.

Must return whether proposals need to be queued before execution. This usually indicates if the proposal needs to go through a timelock.

Cancel mechanism. Can be used to modify the way canceling is performed (for example adding a vault/timelock).

Name of the governor instance (used in building the SNIP-12 domain separator).

Version of the governor instance (used in building SNIP-12 domain separator).

A description of the possible support values for cast_vote 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.

The string can be decoded by the standard URLSearchParams JavaScript class.

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

Returns the state of a proposal, given its id.

The number of votes required in order for a voter to become a proposer.

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

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.

The account that created a proposal.

The time when a queued proposal becomes executable ("ETA"). Unlike proposal_snapshot and proposal_deadline, this doesn't use the governor clock, and instead relies on the executor's clock which may be different. In most cases this will be a timestamp.

Whether a proposal needs to be queued before execution. This indicates if the proposal needs to go through a timelock.

Delay between when a proposal is created and when the vote starts. The unit this duration is expressed in depends on the clock (see ERC-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.

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

The voting_delay can delay the start of the vote. This must be considered when setting the voting duration compared to the voting delay.

This value is stored when the proposal is submitted so that possible changes to the value do not affect proposals that have already been submitted.

Minimum number of votes required for a proposal to be successful.

The timepoint parameter corresponds to the snapshot used for counting vote. This allows the quorum to scale depending on values such as the total supply of a token at this timepoint.

Returns the voting power of an account at a specific timepoint.

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

Returns the voting power of an account at a specific timepoint, given additional encoded parameters.

Returns whether an account has cast a vote on a proposal.

Creates a new proposal. Voting starts after the delay specified by voting_delay and lasts for a duration specified by voting_period. Returns the id of the proposal.

This function has opt-in frontrunning protection, described in is_valid_description_for_proposer.

The state of the Governor and targets may change between the proposal creation and its execution. This may be the result of third party actions on the targeted contracts, or other governor proposals. For example, the balance of this contract could be updated or its access control permissions may be modified, possibly compromising the proposal's ability to execute successfully (e.g. the governor doesn't have enough value to cover a proposal with multiple transfers).

Requirements:

• The proposer must be authorized to submit the proposal.
• The proposer must have enough votes to submit the proposal if proposal_threshold is greater than zero.
• The proposal must not already exist.

Emits a ProposalCreated event.

Queues a proposal. Some governors require this step to be performed before execution can happen. If queuing is not necessary, this function may revert. Queuing a proposal requires the quorum to be reached, the vote to be successful, and the deadline to be reached.

Returns the id of the proposal.

Requirements:

• The proposal must be in the Succeeded state.
• The queue operation must return a non-zero ETA.

Emits a ProposalQueued event.

Executes a successful proposal. This requires the quorum to be reached, the vote to be successful, and the deadline to be reached. Depending on the governor it might also be required that the proposal was queued and that some delay passed.

Some modules can modify the requirements for execution, for example by adding an additional timelock (See timelock_controller).

Returns the id of the proposal.

Requirements:

• The proposal must be in the Succeeded or Queued state.

Emits a ProposalExecuted event.

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

Returns the id of the proposal.

Requirements:

• The proposal must be in the Pending state.
• The caller must be the proposer of the proposal.

Emits a ProposalCanceled event.

Cast a vote.

Requirements:

• The proposal must be active.

Emits a VoteCast event.

Cast a vote with a reason.

Requirements:

• The proposal must be active.

Emits a VoteCast event.

Cast a vote with a reason and additional serialized params.

Requirements:

• The proposal must be active.

Emits either:

• VoteCast event if no params are provided.
• VoteCastWithParams event otherwise.

Cast a vote using the voter's signature.

Requirements:

• The proposal must be active.
• The nonce in the signed message must match the account's current nonce.
• voter must implement SRC6::is_valid_signature.
• signature must be valid for the message hash.

Emits a VoteCast event.

Cast a vote with a reason and additional serialized params using the voter's signature.

Requirements:

• The proposal must be active.
• The nonce in the signed message must match the account's current nonce.
• voter must implement SRC6::is_valid_signature.
• signature must be valid for the message hash.

Emits either:

• VoteCast event if no params are provided.
• VoteCastWithParams event otherwise.

Returns the next unused nonce for an address.

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 that were sent to the governor contract by mistake.

If the executor is simply the governor itself, use of relay is redundant.

Initializes the contract by registering the supported interface id.

Returns the proposal object given its id.

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

In Starknet, the Sequencer ensures the order of transactions, but frontrunning can still be achieved by nodes, and potentially other actors in the future with sequencer decentralization.

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

Returns the proposal id computed from the given parameters.

The proposal id is computed as a Pedersen hash of:

• The array of calls being proposed
• The description hash

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

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.

The account that created a proposal.

The time when a queued proposal becomes executable ("ETA"). Unlike proposal_snapshot and proposal_deadline, this doesn't use the governor clock, and instead relies on the executor's clock which may be different. In most cases this will be a timestamp.

Asserts that the caller is the governance executor.

When the executor is not the governor itself (i.e. a timelock), it can call functions that are restricted with this modifier, and also potentially execute transactions on behalf of the governor. Because of this, this module is designed to work with the TimelockController as the unique potential external executor. The timelock MUST have the governor as the only proposer, canceller, and executor.

Validates that a proposal is in the expected state. Otherwise it panics.

Consumes a nonce, returns the current value, and increments nonce.

Internal wrapper for GovernorVotesTrait::get_votes.

Internal wrapper for GovernorProposeTrait::proposal_threshold.

Returns the state of a proposal, given its id.

Requirements:

• The proposal must exist.

Internal propose mechanism. Returns the proposal id.

Requirements:

• The proposal must not already exist.

Emits a ProposalCreated event.

Internal cancel mechanism with minimal restrictions.

A proposal can be cancelled in any state other than Canceled or Executed.

Once cancelled, a proposal can't be re-submitted.

Internal wrapper for GovernorCountingTrait::count_vote.

Internal vote-casting mechanism.

Checks that the vote is pending and that it has not been cast yet. This function retrieves the voting weight using get_votes and then calls the _count_vote internal function.

Emits either:

• VoteCast event if no params are provided.
• VoteCastWithParams event otherwise.

Emitted when a proposal is created.

Emitted when a proposal is queued.

Emitted when a proposal is executed.

Emitted when a proposal is canceled.

Emitted when a vote is cast.

Emitted when a vote is cast with params.

Returns the state of a proposal given its id.

Requirements:

• The proposal must exist.

Returns the executor address.

In this case, it returns the governor contract address since execution is performed directly through it.

Executes the proposal's operations directly through the governor contract.

In this implementation, queuing is not required so it returns 0.

In this implementation, it always returns false.

Cancels a proposal's operations.

Returns "support=bravo&quorum=for,abstain".

• support=bravo indicates that the support follows the Governor Bravo format where voters can vote For, Against, or Abstain
• quorum=for,abstain indicates that both For and Abstain votes count toward quorum

Records a vote for a proposal.

The support value follows the VoteType enum (0=Against, 1=For, 2=Abstain).

Returns the weight that was counted.

Returns whether an account has cast a vote on a proposal.

Returns whether a proposal has reached quorum.

In this implementation, both For and Abstain votes count toward quorum.

Returns whether a proposal has succeeded.

In this implementation, the For votes must be strictly greater than Against votes.

Returns the delay, between when a proposal is created and when voting starts.

Returns the time period, during which votes can be cast.

Returns the minimum number of votes required for an account to create a proposal.

Sets the voting delay.

Requirements:

• Caller must be the governance executor.

This function does not emit an event if the new voting delay is the same as the old one.

May emit a VotingDelayUpdated event.

Sets the voting period.

This function does not emit an event if the new voting period is the same as the old one.

Requirements:

• Caller must be the governance executor.
• new_voting_period must be greater than 0.

May emit a VotingPeriodUpdated event.

Sets the proposal threshold.

This function does not emit an event if the new proposal threshold is the same as the old one.

Requirements:

• Caller must be the governance executor.

May emit a ProposalThresholdUpdated event.

Initializes the component by setting the default values.

Requirements:

• new_voting_period must be greater than 0.

Emits a VotingDelayUpdated, VotingPeriodUpdated, and ProposalThresholdUpdated event.

Asserts that the caller is the governance executor.

Internal function to update the voting delay.

This function does not emit an event if the new voting delay is the same as the old one.

May emit a VotingDelayUpdated event.

Internal function to update the voting period.

Requirements:

• new_voting_period must be greater than 0.

This function does not emit an event if the new voting period is the same as the old one.

May emit a VotingPeriodUpdated event.

Internal function to update the proposal threshold.

This function does not emit an event if the new proposal threshold is the same as the old one.

May emit a ProposalThresholdUpdated event.

Emitted when the voting delay is updated.

Emitted when the voting period is updated.

Emitted when the proposal threshold is updated.

Returns the current timepoint determined by the governor's operational mode, intended for use in time-sensitive logic. See ERC-6372#clock.

Requirements:

• This function MUST always be non-decreasing.

Returns a description of the clock the governor is operating in. See ERC-6372#CLOCK_MODE.

Requirements:

• The output MUST be formatted like a URL query string, decodable in standard JavaScript.

Returns the voting power of account at a specific timepoint using the votes token.

Returns the votes token that voting power is sourced from.

Initializes the component by setting the votes token.

Requirements:

• votes_token must not be zero.

It is computed as a percentage of the votes token total supply at a given timepoint in the past.

Returns the current timepoint determined by the governor's operational mode, intended for use in time-sensitive logic. See ERC-6372#clock.

Requirements:

• This function MUST always be non-decreasing.

Returns a description of the clock the governor is operating in. See ERC-6372#CLOCK_MODE.

Requirements:

• The output MUST be formatted like a URL query string, decodable in standard JavaScript.

Returns the voting power of account at a specific timepoint using the votes token.

Returns the address of the votes token used for voting power extraction.

Returns the current quorum numerator value.

Returns the quorum numerator value at a specific timepoint in the past.

Returns the quorum denominator value.

Initializes the component by setting the votes token and the initial quorum numerator value.

Requirements:

• votes_token must not be zero.
• quorum_numerator must be less than quorum_denominator.

Emits a QuorumNumeratorUpdated event.

Updates the quorum numerator.

This function does not emit an event if the new quorum numerator is the same as the old one.

Requirements:

• new_quorum_numerator must be less than quorum_denominator.

May emit a QuorumNumeratorUpdated event.

Emitted when the quorum numerator is updated.

Returns the state of a proposal given its id.

Requirements:

• The proposal must exist.

Returns the executor address.

In this module, the executor is the timelock controller.

Runs the already queued proposal through the timelock.

Queue a proposal to the timelock.

Returns the eta for the execution of the queued proposal.

In this implementation, it always returns true.

Cancels the timelocked proposal if it has already been queued.

Returns the timelock controller address.

Returns the timelock proposal id for a given proposal id.

Updates the associated timelock.

Requirements:

• The caller must be the governance.

Emits a TimelockUpdated event.

Initializes the timelock controller.

Requirements:

• The timelock must not be the zero address.

Ensures the caller is the executor (the timelock controller in this case).

Computes the TimelockController operation salt as the XOR of the governor address and description_hash.

It is computed with the governor address itself to avoid collisions across governor instances using the same timelock.

Returns a dispatcher for interacting with the timelock controller.

Internal function to update the timelock controller address.

Emits a TimelockUpdated event.

Emitted when the timelock controller is updated.

Returns the current quorum value.

Checks if a given signer is registered.

Returns a list of all current signers.

Returns whether the transaction with the given id has been confirmed. A confirmed transaction has received the required number of confirmations (quorum).

Returns whether the transaction with the given id has been confirmed by the specified signer.

Returns whether the transaction with the given id has been executed.

Returns the block number when the transaction with the given id was submitted.

Returns the current state of the transaction with the given id.

The possible states are:

• NotFound: the transaction does not exist.
• Pending: the transaction exists but hasn't reached the required confirmations.
• Confirmed: the transaction has reached the required confirmations but hasn't been executed.
• Executed: the transaction has been executed.

Returns the number of confirmations from registered signers for the transaction with the specified id.

Returns the computed identifier of a transaction containing a single call.

Returns the computed identifier of a transaction containing a batch of calls.

Adds new signers and updates the quorum.

Requirements:

• The caller must be the contract itself.
• new_quorum must be less than or equal to the total number of signers after addition.

Emits a SignerAdded event for each signer added.

Emits a QuorumUpdated event if the quorum changes.

Removes signers and updates the quorum.

Requirements:

• The caller must be the contract itself.
• new_quorum must be less than or equal to the total number of signers after removal.

Emits a SignerRemoved event for each signer removed.

Emits a QuorumUpdated event if the quorum changes.

Replaces an existing signer with a new signer.

Requirements:

• The caller must be the contract itself.
• signer_to_remove must be an existing signer.
• signer_to_add must not be an existing signer.

Emits a SignerRemoved event for the removed signer.

Emits a SignerAdded event for the new signer.

Updates the quorum value to new_quorum.

Requirements:

• The caller must be the contract itself.
• new_quorum must be non-zero.
• new_quorum must be less than or equal to the total number of signers.

Emits a QuorumUpdated event if the quorum changes.

Submits a new transaction for confirmation.

Requirements:

• The caller must be a registered signer.
• The transaction must not have been submitted before.

Emits a TransactionSubmitted event.

Emits a CallSalt event if salt is not zero.

Submits a new batch transaction for confirmation.

Requirements:

• The caller must be a registered signer.
• The transaction must not have been submitted before.

Emits a TransactionSubmitted event.

Emits a CallSalt event if salt is not zero.

Confirms a transaction with the given id.

Requirements:

• The caller must be a registered signer.
• The transaction must exist and not be executed.
• The caller must not have already confirmed the transaction.

Emits a TransactionConfirmed event.

Revokes a previous confirmation for a transaction with the given id.

Requirements:

• The transaction must exist and not be executed.
• The caller must have previously confirmed the transaction.

Emits a ConfirmationRevoked event.

Executes a confirmed transaction.

Requirements:

• The caller must be a registered signer.
• The transaction must be confirmed and not yet executed.

Emits a TransactionExecuted event.

Executes a confirmed batch transaction.

Requirements:

• The caller must be a registered signer.
• The transaction must be confirmed and not yet executed.

Emits a TransactionExecuted event.

Initializes the Multisig component with the initial quorum and signers. This function must be called during contract initialization to set up the initial state.

Requirements:

• quorum must be non-zero and less than or equal to the number of signers.

Emits a SignerAdded event for each signer added.

Emits a QuorumUpdated event.

Resolves and returns the current state of the transaction with the given id.

The possible states are:

• NotFound: the transaction does not exist.
• Pending: the transaction exists but hasn't reached the required confirmations.
• Confirmed: the transaction has reached the required confirmations but hasn't been executed.
• Executed: the transaction has been executed.

Asserts that the caller is one of the registered signers.

Requirements:

• The caller must be a registered signer.

Asserts that a transaction with the given id exists.

Requirements:

• The transaction with the given id must have been submitted.

Asserts that the caller is the contract itself.

Requirements:

• The caller must be the contract's own address.

Adds new signers and updates the quorum.

Requirements:

• Each signer address must be non-zero.
• new_quorum must be non-zero and less than or equal to the total number of signers after addition.

Emits a SignerAdded event for each new signer added.

Emits a QuorumUpdated event if the quorum changes.

Removes existing signers and updates the quorum.

Requirements:

• new_quorum must be non-zero and less than or equal to the total number of signers after removal.

Emits a SignerRemoved event for each signer removed.

Emits a QuorumUpdated event if the quorum changes.

Replaces an existing signer with a new signer.

Requirements:

• signer_to_remove must be an existing signer.
• signer_to_add must not be an existing signer.
• signer_to_add must be a non-zero address.

Emits a SignerRemoved event for the removed signer.

Emits a SignerAdded event for the new signer.

Updates the quorum value to new_quorum if it differs from the current quorum.

Requirements:

• new_quorum must be non-zero.
• new_quorum must be less than or equal to the total number of signers.

Emits a QuorumUpdated event if the quorum changes.

Emitted when a new signer is added.

Emitted when a signer is removed.

Emitted when the quorum value is updated.

Emitted when a new transaction is submitted by a signer.

Emitted when a transaction is confirmed by a signer.

Emitted when a signer revokes his confirmation.

Emitted when a transaction is executed.

Emitted when a new transaction is submitted with non-zero salt.

Returns whether id corresponds to a registered operation. This includes the OperationStates: Waiting, Ready, and Done.

Returns whether the id OperationState is pending or not. Note that a pending operation may be either Waiting or Ready.

Returns whether the id OperationState is Ready or not.

Returns whether the id OperationState is Done or not.

Returns the timestamp at which id becomes Ready.

0 means the OperationState is Unset and 1 means the OperationState is Done.

Returns the current state of the operation with the given id.

The possible states are:

• Unset: the operation has not been scheduled or has been canceled.
• Waiting: the operation has been scheduled and is pending the scheduled delay.
• Ready: the timer has expired, and the operation is eligible for execution.
• Done: the operation has been executed.

Returns the minimum delay in seconds for an operation to become valid. This value can be changed by executing an operation that calls update_delay.

Returns the identifier of an operation containing a single transaction.

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

Schedule an operation containing a single transaction.

Requirements:

• The caller must have the PROPOSER_ROLE role.
• The proposal must not already exist.
• delay must be greater than or equal to the min delay.

Emits CallScheduled event. Emits CallSalt event if salt is not zero.

Schedule an operation containing a batch of transactions.

Requirements:

• The caller must have the PROPOSER_ROLE role.
• The proposal must not already exist.
• delay must be greater than or equal to the min delay.

Emits one CallScheduled event for each transaction in the batch. Emits CallSalt event if salt is not zero.

Cancels an operation. A canceled operation returns to Unset OperationState.

Requirements:

• The caller must have the CANCELLER_ROLE role.
• id must be a pending operation.

Emits a CallCancelled event.

Execute a (Ready) operation containing a single Call.

Requirements:

• Caller must have EXECUTOR_ROLE.
• id must be in Ready OperationState.
• predecessor must either be 0 or in Done OperationState.

Emits a CallExecuted event.

This function can reenter, but it doesn't pose a risk because _after_call(self: @ContractState, id: felt252) internal checks that the proposal is pending, thus any modifications to the operation during reentrancy should be caught.

Execute a (Ready) operation containing a batch of Calls.

Requirements:

• Caller must have EXECUTOR_ROLE.
• id must be in Ready OperationState.
• predecessor must either be 0 or in Done OperationState.

Emits a CallExecuted event for each Call.

This function can reenter, but it doesn't pose a risk because _after_call checks that the proposal is pending, thus any modifications to the operation during reentrancy should be caught.

Changes the minimum timelock duration for future operations.

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 serialized call to this function.

Emits a MinDelayChanged event.

Initializes the contract by registering support for SRC5 and AccessControl.

This function also configures the contract with the following parameters:

• min_delay: initial minimum delay in seconds 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.

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.

Emits two IAccessControl::RoleGranted events for each account in proposers with PROPOSER_ROLE and CANCELLER_ROLE roles.

Emits a IAccessControl::RoleGranted event for each account in executors with EXECUTOR_ROLE role.

May emit a IAccessControl::RoleGranted event for admin with DEFAULT_ADMIN_ROLE role (if admin is not zero).

Emits MinDelayChanged event.

Validates that the caller has the given role. Otherwise it panics.

Validates that the caller has the given role. If role is granted to the zero address, then this is considered an open role which allows anyone to be the caller.

Validates that the caller is the timelock contract itself. Otherwise it panics.

Private function that checks before execution of an operation's calls.

Requirements:

• id must be in the Ready OperationState.
• predecessor must either be zero or be in the Done OperationState.

Private function that checks after execution of an operation's calls and sets the OperationState of id to Done.

Requirements:

• id must be in the Ready OperationState.

Private function that schedules an operation that is to become valid after a given delay.

Private function that executes an operation's calls.

Emitted when call is scheduled as part of operation id.

Emitted when call is performed as part of operation id.

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

Emitted when operation id is cancelled.

Emitted when the minimum delay for future operations is modified.

Returns the number of voting units for a given account.

This implementation is specific to ERC20 tokens, where the balance of tokens directly represents the number of voting units.

This implementation will work out of the box if the ERC20 component is implemented in the final contract.

This implementation assumes tokens map to voting units 1:1. Any deviation from this formula when transferring voting units (e.g. by using hooks) may compromise the internal vote accounting.

Returns the number of voting units for a given account.

This implementation is specific to ERC721 tokens, where each token represents one voting unit. The function returns the balance of ERC721 tokens for the specified account.

This implementation will work out of the box if the ERC721 component is implemented in the final contract.

This implementation assumes tokens map to voting units 1:1. Any deviation from this formula when transferring voting units (e.g. by using hooks) may compromise the internal vote accounting.

Returns the current amount of votes that account has.

Returns the amount of votes that account had at a specific moment in the past.

Requirements:

• timepoint must be in the past.

Returns the total supply of votes available at a specific moment in the past.

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.

Returns the delegate that account has chosen.

Delegates votes from the sender to delegatee.

Emits a DelegateChanged event.

May emit one or two DelegateVotesChanged events.

Delegates votes from delegator to delegatee through a SNIP-12 message signature validation.

Requirements:

• expiry must not be in the past.
• nonce must match the account's current nonce.
• delegator must implement SRC6::is_valid_signature.
• signature should be valid for the message hash.

Emits a DelegateChanged event.

May emit one or two DelegateVotesChanged events.

Returns the current timepoint determined by the contract's operational mode, intended for use in time-sensitive logic. See ERC-6372#clock.

Requirements:

• This function MUST always be non-decreasing.

Returns a description of the clock the contract is operating in. See ERC-6372#CLOCK_MODE.

Requirements:

• The output MUST be formatted like a URL query string, decodable in standard JavaScript.

Returns the current total supply of votes.

Moves delegated votes from one delegate to another.

May emit one or two DelegateVotesChanged events.

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.

If voting units are based on an underlying transferable asset (like a token), you must call this function every time the asset is transferred to keep the internal voting power accounting in sync. For ERC20 and ERC721 tokens, this is typically handled using hooks.

May emit one or two DelegateVotesChanged events.

Returns the number of checkpoints for account.

Returns the pos-th checkpoint for account.

Delegates all of account's voting units to delegatee.

Emits a DelegateChanged event.

May emit one or two DelegateVotesChanged events.

Emitted when an account changes their delegate.

Emitted when a token transfer or delegate change results in changes to a delegate's number of votes.

Returns the number of voting units for a given account. For ERC20, this is typically the token balance. For ERC721, this is typically the number of tokens owned.

While any formula can be used as a measure of voting units, the internal vote accounting of the contract may be compromised if voting units are transferred in any external flow by following a different formula. For example, when implementing the hook for ERC20, the number of voting units transferred should match the formula given by the get_voting_units implementation.