Managing Plugins
Two Steps Plugin Install/Uninstall/Upgrade
Safety is our top priority in the design of the whole protocol. We want to make sure that the DAO members know exactly what permissions are granted/revoked to whom before any processing takes place.
The following explanation will take as example the installation process, however same principles apply for uninstallation and upgrading processes.
This is why we see the installation process in two phases:
- Preparation: Defining the parameters to be set on the new plugin instance and helpers, as well as requesting the permissions needed for it to work properly. The
PluginSetup
contains the setup script where developers can perform any unprivileged operations. These will need a privileged confirmation in the next step. - Application: The granting or revoking of the plugin's requested permissions (based on the preparation step above). This is a privileged action performed by Aragon's
PluginSetupProcessor
(you can understand it as the "installer"), so that the plugin becomes effectively installed. It gets executed whenever someone withROOT
privileges on the DAO applies it (most likely through a proposal).
The PluginSetupProcessor
is the Aragon contract in charge of invoking the prepareInstallation()
function from your plugin's PluginSetup
contract and use it to prepare the installation and (eventually) apply it once it has been approved by the DAO.
What happens during the Plugin Preparation?
The preparation of a PluginSetup
contract proceeds as follows:
-
A DAO builder selects a plugin to install.
-
The DAO builder defines the parameters and settings that he/she wants for their DAO. The
prepareInstallation
method in thePluginSetup
contract is called through thePluginSetupProcessor
(and creates a unique setup ID). -
The
PluginSetup
contract deploys all the contracts and gathers addresses and other input arguments required for the installation instructions.Because the addresses of all associated contracts are now known, a static permission list can be emitted, hashed, and stored on-chain.
-
Once the Plugin installation has been prepared, we use it as the parameter of the
applyInstallation()
action. Once encoded, this action is what must be added to theAction[]
array of the installation proposal. That way, when the proposal passes, the action becomes executable and the plugin can be installed in the DAO using the parameters defined in the prepare installation process. For a plugin to be installed, it needs to be approved by the governance mechanism (plugin) of the organization, passed as the encoded action of a proposal, and executed by a signer.
The governance plugin can be a simple majority vote, an optimistic process or an admin governance plugin that does not involve a waiting period. It can be any governance mechanism existing within the DAO which has access to the DAO's execute
permission.
This gives the DAO members the opportunity to check which permissions the PluginSetup
contract request before granting/revoking them.
Plugin setup proposals must be carefully examined as they can be a potential security risk if the PluginSetup
contract comes from an untrusted source. To learn more visit the Security section.
What happens during the Preparation Application?
After this initial preparation transaction, the addresses and permissions related to the plugin become apparent. The members of a governance plugin with permissions can decide if the installation proposal should be accepted or denied.
Once the proposal has passed, the actions specified in the Action[]
array can get executed and the applyInstallation()
action is used to complete the installation of the plugin into the DAO.
This is processed as follows:
- The DAO temporarily grants the
ROOT_PERMISSION
to thePluginSetupProcessor
. This is needed so that the processor can modify the DAO's permissions settings to set up the plugin. - This
Action
calls theapplyInstallation
method in thePluginSetupProcessor
, containing the list of requested permissions as argument. The permissions hash is compared with the stored hash to make sure that no permission was changed. - If the hash is valid, the list is processed, and
PluginSetupProcessor
conducts the requested sequence ofgrant
,grantWithCondition
, and/orrevoke
calls on the owning DAO. 4. Finally, the temporarily grantedROOT_PERMISSION
to thePluginSetupProcessor
is revoked.
The two-step setup procedure in Aragon OSx is not limited to the setup of only one plugin — you can setup multiple plugins at once by first preparing them in a single proposal and then processing the entire setup sequence in one transaction. This is powerful and allows you to transform your entire DAO in one proposal, for example, to install a new governance plugin (e.g., a gasless ZK-vote) and finance plugin (e.g., to stream loans to your members), while uninstalling your old ERC20 token vote in one go.
a. b. c.
Simplified overview of the two-transaction plugin a. installation, b. update, and c. uninstallation process with the involved contracts as rounded rectangles, interactions between them as arrows, and relations as dashed lines. The first and second transaction are distinguished by numbering as well as solid and dotted lines, respectively.