StagedProposalProcessor API

Initializes the component.

This method is required to support [ERC-1822](https://eips.ethereum.org/EIPS/eip-1822).

Allows to update stage configuration.

Requires the caller to have the UPDATE_STAGES_PERMISSION_ID permission. Reverts if the provided _stages array is empty.

Reports and records the result for a proposal at a specific stage.

This function can be called by any address even if it is not included in the stage configuration. _canProposalAdvance function ensures that only records from addresses in the stage configuration are used. If _tryAdvance is true, the proposal will attempt to advance to the next stage if eligible. Requires the caller to have the EXECUTE_PERMISSION_ID permission to execute the final stage.

The human-readable abi format for extra params included in data of createProposal.

This plugin inherits from IProposal, requiring an override for this function.

Sets a new trusted forwarder address.

Requires the caller to have the SET_TRUSTED_FORWARDER_PERMISSION_ID permission.

Creates a new proposal in this StagedProposalProcessor plugin.

Requires the caller to have the CREATE_PROPOSAL_PERMISSION_ID permission. Also creates proposals for non-manual bodies in the first stage of the proposal process.

Creates a new proposal.

Calls a public function that requires the CREATE_PERMISSION_ID permission.

Advances the specified proposal to the next stage if allowed.

This function checks whether the proposal exists and can advance based on its current state. If the proposal is in the final stage, the caller must have the EXECUTE_PERMISSION_ID permission to execute it.

Cancels the proposal.

The proposal can be canceled only if it’s allowed in the stage configuration. The caller must have the CANCEL_PERMISSION_ID permission to cancel it.

Edits the proposal.

The proposal can be editable only if it’s allowed in the stage configuration. The caller must have the EDIT_PERMISSION_ID permission to cancel it and stage must be advanceable.

Executes a proposal.

Requires the EXECUTE_PERMISSION_ID permission.

Checks if this or the parent contract supports an interface by its ID.

Determines whether the specified proposal can be advanced to the next stage.

Reverts if the proposal with the given _proposalId does not exist.

Checks if a proposal can be executed.

Current state of a proposal.

Retrieves the address of the trusted forwarder.

Retrieves all information associated with a proposal by its ID.

Retrieves the result type submitted by a body for a specific proposal and stage.

Retrieves the sub proposal id.

Retrieves the current configuration index at which the current configurations of stages are stored.

Retrieves the stages stored on the _index in the stages configuration.

Retrieves the data parameter encoded for a sub-body’s createProposal function in a specific stage. Excludes sub-bodies from the first stage, as their parameters are not stored for efficiency.

Calculates and retrieves the number of approvals and vetoes for a proposal on the stage.

Whether proposal succeeded or not.

Note that this must not include time window checks and only make a decision based on the thresholds.

Checks whether the caller has the required permission to execute a proposal at the last stage.

Checks whether the caller has the required permission to advance a proposal.

Internal function to update stage configuration.

It’s a caller’s responsibility not to call this in case _stages are empty. This function can not be overridden as it’s crucial to not allow duplicating bodies in the same stage, because proposal creation and report functions depend on this assumption.

Internal function that executes the proposal’s actions.

Records the result by the caller.

Assumes that bodies are not duplicated in the same stage. See _updateStages function.

Creates proposals on the non-manual bodies of the stageId.

Assumes that bodies are not duplicated in the same stage. See _updateStages function.

Advances a proposal to the next stage or executes it if it is in the final stage.

Assumes the proposal is eligible to advance. If the proposal is not in the final stage, it creates proposals for the sub-bodies in the next stage. If the proposal is in the final stage, it triggers execution.

Sets a new trusted forwarder address and emits the event.

Internal function to calculate and retrieve the number of approvals and vetoes for a proposal in the _stageId.

Assumes that bodies are not duplicated in the same stage. See _updateStages function. This function ensures that only records from addresses in the stage configuration are used.

Retrieves the original sender address, considering if the call was made through a trusted forwarder.

If the msg.sender is the trusted forwarder, extracts the original sender from the calldata.

Internal helper function that decides if the stage’s thresholds are satisfied.

Encodes a ProposalState into a bytes32 representation where each bit enabled corresponds the underlying position in the ProposalState enum.

Emitted when the proposal is advanced to the next stage.

Emitted when the proposal gets cancelled.

Emitted when the proposal gets edited.

Emitted when a body reports results by calling reportProposalResult.

Emitted when this plugin successfully creates a proposal on sub-body.

Emitted when this plugin fails in creating a proposal on sub-body.

Emitted when the stage configuration is updated for a proposal process.

Emitted when the trusted forwarder is updated.

Constructs the PluginUpgradeableSetup by storing the SPP implementation address.

The implementation address is used to deploy UUPS proxies referencing it and to verify the plugin on the respective block explorers.

Prepares the installation of a plugin.

Prepares the update of a plugin.

The default implementation for the initial build 1 that reverts because no earlier build exists.

Prepares the uninstallation of a plugin.

The address of the condition implementation contract.

Disables the initializers on the implementation contract to prevent it from being left uninitialized.

Initializes the component.

Checks if a call is permitted.

Internal function that updates the rules.

Updates the rules that will be used as a check upon proposal creation on StagedProposalProcessor.

The ID of the permission required to call the updateRules function.

The ID of the permission required to call the createProposal function.

The ID of the permission required to call the setTrustedForwarder function.

The ID of the permission required to call the updateStages function.

The ID of the permission required to execute the proposal if it’s on the last stage.

It is important to use a different identifier than {keccak256("EXECUTE_PERMISSION")} to ensure that it can still be granted with ANY_ADDR. Refer to the DAO.sol function - {isPermissionRestrictedForAnyAddr} for more details.

The ID of the permission required to execute the proposal on the dao.

The ID of the permission required to cancel the proposal.

The ID of the permission required to advance the proposal.

The ID of the permission required to edit the proposal.

The ID of the permission required to call the updateRules function.

The ID of the permission required to call the setTargetConfig function.

The ID of the permission required to call the updateMetadata function.