SteerGovernance.sol

Methods

BALLOT_TYPEHASH()

Solidity

function BALLOT_TYPEHASH() external view returns (bytes32)

Returns

Name	Type	Description
_0	bytes32	undefined

COUNTING_MODE()

module:voting

Solidity

function COUNTING_MODE() external pure returns (string)

Details

A description of the possible support values for {castVote} and the way these votes are counted, meant to be consumed by UIs to show correct vote options and interpret the results. The string is a URL-encoded sequence of key-value pairs that each describe one aspect, for example support=bravo&quorum=for,abstain. There are 2 standard keys: support and quorum. - support=bravo refers to the vote options 0 = Against, 1 = For, 2 = Abstain, as in GovernorBravo. - quorum=bravo means that only For votes are counted towards quorum. - quorum=for,abstain means that both For and Abstain votes are counted towards quorum. NOTE: The string can be decoded by the standard https://developer.mozilla.org/en-US/docs/Web/API/URLSearchParams[`URLSearchParams`] JavaScript class.

Returns

Name	Type	Description
_0	string	undefined

cancel(uint256)

Solidity

function cancel(uint256 proposalId) external nonpayable

Details

Cancels a proposal only if sender is the proposer, or proposer delegates dropped below proposal threshold.

Parameters

Name	Type	Description
proposalId	uint256	undefined

cancelByInternalGovernance(address[],uint256[],bytes[],bytes32)

Solidity

function cancelByInternalGovernance(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash) external nonpayable

Details

This function can cancel a proposal irrespective of votes on it.This function can only be called by Internal Governance Timelock. So only after there are enough votes in Internal Governance this function can be called.

Parameters

Name	Type	Description
targets	address[]	undefined
values	uint256[]	undefined
calldatas	bytes[]	undefined
descriptionHash	bytes32	undefined

castVote(uint256,uint8)

Solidity

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

Details

See {IGovernor-castVote}.

Parameters

Name	Type	Description
proposalId	uint256	undefined
support	uint8	undefined

Returns

Name	Type	Description
_0	uint256	undefined

castVoteBySig(uint256,uint8,uint8,bytes32,bytes32)

Solidity

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

Details

See {IGovernor-castVoteBySig}.

Parameters

Name	Type	Description
proposalId	uint256	undefined
support	uint8	undefined
v	uint8	undefined
r	bytes32	undefined
s	bytes32	undefined

Returns

Name	Type	Description
_0	uint256	undefined

castVoteWithReason(uint256,uint8,string)

Solidity

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

Details

See {IGovernor-castVoteWithReason}.

Parameters

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

Returns

Name	Type	Description
_0	uint256	undefined

execute(address[],uint256[],bytes[],bytes32)

Solidity

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

Details

See {IGovernor-execute}.

Parameters

Name	Type	Description
targets	address[]	undefined
values	uint256[]	undefined
calldatas	bytes[]	undefined
descriptionHash	bytes32	undefined

Returns

Name	Type	Description
_0	uint256	undefined

execute(uint256)

Solidity

function execute(uint256 proposalId) external payable

Details

See {IGovernorCompatibilityBravo-execute}.

Parameters

Name	Type	Description
proposalId	uint256	undefined

getActions(uint256)

Solidity

function getActions(uint256 proposalId) external view returns (address[] targets, uint256[] values, string[] signatures, bytes[] calldatas)

Details

See {IGovernorCompatibilityBravo-getActions}.

Parameters

Name	Type	Description
proposalId	uint256	undefined

Returns

Name	Type	Description
targets	address[]	undefined
values	uint256[]	undefined
signatures	string[]	undefined
calldatas	bytes[]	undefined

getReceipt(uint256,address)

Solidity

function getReceipt(uint256 proposalId, address voter) external view returns (struct IGovernorCompatibilityBravoUpgradeable.Receipt)

Details

See {IGovernorCompatibilityBravo-getReceipt}.

Parameters

Name	Type	Description
proposalId	uint256	undefined
voter	address	undefined

Returns

Name	Type	Description
_0	IGovernorCompatibilityBravoUpgradeable.Receipt	undefined

getVotes(address,uint256)

Solidity

function getVotes(address account, uint256 blockNumber) external view returns (uint256)

Parameters

Name	Type	Description
account	address	undefined
blockNumber	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

hasVoted(uint256,address)

Solidity

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

Details

See {IGovernor-hasVoted}.

Parameters

Name	Type	Description
proposalId	uint256	undefined
account	address	undefined

Returns

Name	Type	Description
_0	bool	undefined

hashProposal(address[],uint256[],bytes[],bytes32)

Solidity

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

Details

See {IGovernor-hashProposal}. The proposal id is produced by hashing the RLC encoded targets array, the values array, the calldatas array and the descriptionHash (bytes32 which itself is the keccak256 hash of the description string). This proposal id can be produced from the proposal data which is part of the {ProposalCreated} event. It can even be computed in advance, before the proposal is submitted. Note that the chainId and the governor address are not part of the proposal id computation. Consequently, the same proposal (with same operation and same description) will have the same id if submitted on multiple governors accross multiple networks. This also means that in order to execute the same operation twice (on the same governor) the proposer will have to change the description in order to avoid proposal id conflicts.

Parameters

Name	Type	Description
targets	address[]	undefined
values	uint256[]	undefined
calldatas	bytes[]	undefined
descriptionHash	bytes32	undefined

Returns

Name	Type	Description
_0	uint256	undefined

initialize(address,address)

Solidity

function initialize(contract ERC20VotesUpgradeable _token, contract TimelockControllerUpgradeable _timelock) external nonpayable

Parameters

Name	Type	Description
_token	contract ERC20VotesUpgradeable	undefined
_timelock	contract TimelockControllerUpgradeable	undefined

name()

Solidity

function name() external view returns (string)

Details

See {IGovernor-name}.

Returns

Name	Type	Description
_0	string	undefined

owner()

Solidity

function owner() external view returns (address)

Details

Returns the address of the current owner.

Returns

Name	Type	Description
_0	address	undefined

proposalDeadline(uint256)

Solidity

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

Details

See {IGovernor-proposalDeadline}.

Parameters

Name	Type	Description
proposalId	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

proposalEta(uint256)

Solidity

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

Details

Public accessor to check the eta of a queued proposal

Parameters

Name	Type	Description
proposalId	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

proposalSnapshot(uint256)

Solidity

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

Details

See {IGovernor-proposalSnapshot}.

Parameters

Name	Type	Description
proposalId	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

proposalThreshold()

Solidity

function proposalThreshold() external view returns (uint256)

Returns

Name	Type	Description
_0	uint256	undefined

proposals(uint256)

Solidity

function proposals(uint256 proposalId) external view returns (uint256 id, address proposer, uint256 eta, uint256 startBlock, uint256 endBlock, uint256 forVotes, uint256 againstVotes, uint256 abstainVotes, bool canceled, bool executed)

Details

See {IGovernorCompatibilityBravo-proposals}.

Parameters

Name	Type	Description
proposalId	uint256	undefined

Returns

Name	Type	Description
id	uint256	undefined
proposer	address	undefined
eta	uint256	undefined
startBlock	uint256	undefined
endBlock	uint256	undefined
forVotes	uint256	undefined
againstVotes	uint256	undefined
abstainVotes	uint256	undefined
canceled	bool	undefined
executed	bool	undefined

propose(address[],uint256[],bytes[],string)

Solidity

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

Parameters

Name	Type	Description
targets	address[]	undefined
values	uint256[]	undefined
calldatas	bytes[]	undefined
description	string	undefined

Returns

Name	Type	Description
_0	uint256	undefined

propose(address[],uint256[],string[],bytes[],string)

Solidity

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

Details

See {IGovernorCompatibilityBravo-propose}.

Parameters

Name	Type	Description
targets	address[]	undefined
values	uint256[]	undefined
signatures	string[]	undefined
calldatas	bytes[]	undefined
description	string	undefined

Returns

Name	Type	Description
_0	uint256	undefined

queue(address[],uint256[],bytes[],bytes32)

Solidity

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

Details

Function to queue a proposal to the timelock.

Parameters

Name	Type	Description
targets	address[]	undefined
values	uint256[]	undefined
calldatas	bytes[]	undefined
descriptionHash	bytes32	undefined

Returns

Name	Type	Description
_0	uint256	undefined

queue(uint256)

Solidity

function queue(uint256 proposalId) external nonpayable

Details

See {IGovernorCompatibilityBravo-queue}.

Parameters

Name	Type	Description
proposalId	uint256	undefined

quorum(uint256)

Solidity

function quorum(uint256 blockNumber) external view returns (uint256)

Parameters

Name	Type	Description
blockNumber	uint256	undefined

Returns

Name	Type	Description
_0	uint256	undefined

quorumDenominator()

Solidity

function quorumDenominator() external view returns (uint256)

Returns

Name	Type	Description
_0	uint256	undefined

quorumNumerator()

Solidity

function quorumNumerator() external view returns (uint256)

Returns

Name	Type	Description
_0	uint256	undefined

quorumVotes()

Solidity

function quorumVotes() external view returns (uint256)

Details

See {IGovernorCompatibilityBravo-quorumVotes}.

Returns

Name	Type	Description
_0	uint256	undefined

renounceOwnership()

Solidity

function renounceOwnership() external nonpayable

Details

Leaves the contract without owner. It will not be possible to call onlyOwner functions anymore. Can only be called by the current owner. NOTE: Renouncing ownership will leave the contract without an owner, thereby removing any functionality that is only available to the owner.

setInternalGovernanceTimeLockOnce(address)

Solidity

function setInternalGovernanceTimeLockOnce(address _internalGovernanceTimeLock) external nonpayable

Details

Use this function to set address of Internal Governance Timelock.This function can only be called once while deployment.

Parameters

Name	Type	Description
_internalGovernanceTimeLock	address	is the address of Internal Governance Timelock.

setProposalThreshold(uint256)

Solidity

function setProposalThreshold(uint256 newProposalThreshold) external nonpayable

Details

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

Parameters

Name	Type	Description
newProposalThreshold	uint256	undefined

setVotingDelay(uint256)

Solidity

function setVotingDelay(uint256 newVotingDelay) external nonpayable

Details

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

Parameters

Name	Type	Description
newVotingDelay	uint256	undefined

setVotingPeriod(uint256)

Solidity

function setVotingPeriod(uint256 newVotingPeriod) external nonpayable

Details

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

Parameters

Name	Type	Description
newVotingPeriod	uint256	undefined

state(uint256)

Solidity

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

Parameters

Name	Type	Description
proposalId	uint256	undefined

Returns

Name	Type	Description
_0	enum IGovernorUpgradeable.ProposalState	undefined

supportsInterface(bytes4)

Solidity

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

Parameters

Name	Type	Description
interfaceId	bytes4	undefined

Returns

Name	Type	Description
_0	bool	undefined

timelock()

Solidity

function timelock() external view returns (address)

Details

Public accessor to check the address of the timelock

Returns

Name	Type	Description
_0	address	undefined

token()

Solidity

function token() external view returns (contract ERC20VotesUpgradeable)

Returns

Name	Type	Description
_0	contract ERC20VotesUpgradeable	undefined

transferOwnership(address)

Solidity

function transferOwnership(address newOwner) external nonpayable

Details

Transfers ownership of the contract to a new account (newOwner). Can only be called by the current owner.

Parameters

Name	Type	Description
newOwner	address	undefined

updateQuorumNumerator(uint256)

Solidity

function updateQuorumNumerator(uint256 newQuorumNumerator) external nonpayable

Parameters

Name	Type	Description
newQuorumNumerator	uint256	undefined

updateTimelock(address)

Solidity

function updateTimelock(contract TimelockControllerUpgradeable newTimelock) external nonpayable

Details

Public endpoint to update the underlying timelock instance. Restricted to the timelock itself, so updates must be proposed, scheduled and executed using the {Governor} workflow.

Parameters

Name	Type	Description
newTimelock	contract TimelockControllerUpgradeable	undefined

upgradeTo(address)

Solidity

function upgradeTo(address newImplementation) external nonpayable

Details

Upgrade the implementation of the proxy to newImplementation. Calls {_authorizeUpgrade}. Emits an {Upgraded} event.

Parameters

Name	Type	Description
newImplementation	address	undefined

upgradeToAndCall(address,bytes)

Solidity

function upgradeToAndCall(address newImplementation, bytes data) external payable

Details

Upgrade the implementation of the proxy to newImplementation, and subsequently execute the function call encoded in data. Calls {_authorizeUpgrade}. Emits an {Upgraded} event.

Parameters

Name	Type	Description
newImplementation	address	undefined
data	bytes	undefined

version()

Solidity

function version() external view returns (string)

Details

See {IGovernor-version}.

Returns

Name	Type	Description
_0	string	undefined

votingDelay()

Solidity

function votingDelay() external view returns (uint256)

Returns

Name	Type	Description
_0	uint256	undefined

votingPeriod()

Solidity

function votingPeriod() external view returns (uint256)

Returns

Name	Type	Description
_0	uint256	undefined

Events

AdminChanged

Solidity

event AdminChanged(address previousAdmin, address newAdmin)

Parameters

Name	Type	Description
previousAdmin	address	undefined
newAdmin	address	undefined

BeaconUpgraded

Solidity

event BeaconUpgraded(address indexed beacon)

Parameters

Name	Type	Description
beacon indexed	address	undefined

CancelledByInternalGovernance

Solidity

event CancelledByInternalGovernance(address[] targets, uint256[] values, bytes[] calldatas, bytes32 descriptionHash)

Parameters

Name	Type	Description
targets	address[]	undefined
values	uint256[]	undefined
calldatas	bytes[]	undefined
descriptionHash	bytes32	undefined

OwnershipTransferred

Solidity

event OwnershipTransferred(address indexed previousOwner, address indexed newOwner)

Parameters

Name	Type	Description
previousOwner indexed	address	undefined
newOwner indexed	address	undefined

ProposalCanceled

Solidity

event ProposalCanceled(uint256 proposalId)

Parameters

Name	Type	Description
proposalId	uint256	undefined

ProposalCreated

Solidity

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

Parameters

Name	Type	Description
proposalId	uint256	undefined
proposer	address	undefined
targets	address[]	undefined
values	uint256[]	undefined
signatures	string[]	undefined
calldatas	bytes[]	undefined
startBlock	uint256	undefined
endBlock	uint256	undefined
description	string	undefined

ProposalExecuted

Solidity

event ProposalExecuted(uint256 proposalId)

Parameters

Name	Type	Description
proposalId	uint256	undefined

ProposalQueued

Solidity

event ProposalQueued(uint256 proposalId, uint256 eta)

Parameters

Name	Type	Description
proposalId	uint256	undefined
eta	uint256	undefined

ProposalThresholdSet

Solidity

event ProposalThresholdSet(uint256 oldProposalThreshold, uint256 newProposalThreshold)

Parameters

Name	Type	Description
oldProposalThreshold	uint256	undefined
newProposalThreshold	uint256	undefined

QuorumNumeratorUpdated

Solidity

event QuorumNumeratorUpdated(uint256 oldQuorumNumerator, uint256 newQuorumNumerator)

Parameters

Name	Type	Description
oldQuorumNumerator	uint256	undefined
newQuorumNumerator	uint256	undefined

TimelockChange

Solidity

event TimelockChange(address oldTimelock, address newTimelock)

Parameters

Name	Type	Description
oldTimelock	address	undefined
newTimelock	address	undefined

Upgraded

Solidity

event Upgraded(address indexed implementation)

Parameters

Name	Type	Description
implementation indexed	address	undefined

VoteCast

Solidity

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

Parameters

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

VotingDelaySet

Solidity

event VotingDelaySet(uint256 oldVotingDelay, uint256 newVotingDelay)

Parameters

Name	Type	Description
oldVotingDelay	uint256	undefined
newVotingDelay	uint256	undefined

VotingPeriodSet

Solidity

event VotingPeriodSet(uint256 oldVotingPeriod, uint256 newVotingPeriod)

Parameters

Name	Type	Description
oldVotingPeriod	uint256	undefined
newVotingPeriod	uint256	undefined