Plugin Development

Quickstart

Aragon OSx makes it easy for you to write, maintain, and distribute your own plugin. Here, we show you how.

Hello, World!

To use the Aragon OSx contracts inside your project, import them with yarn add @aragon/osx and start developing your own plugin implementation:

GreeterPlugin

// SPDX-License-Identifier: AGPL-3.0-or-later
pragma solidity 0.8.17;

import {Plugin, IDAO} from '@aragon/osx/core/plugin/Plugin.sol';

contract GreeterPlugin is Plugin {
  constructor(IDAO _dao) Plugin(_dao) {}

  function greet() external pure returns (string memory) {
    return 'Hello, world!';
  }
}

Next, you write a plugin setup contract:

GreeterSetup

// SPDX-License-Identifier: AGPL-3.0-or-later
pragma solidity 0.8.17;

import {PermissionLib} from '@aragon/osx/core/permission/PermissionsLib.sol';
import {PluginSetup} from '@aragon/osx/framework/plugin/setup/PluginSetup.sol';
import './MyPlugin.sol';

contract GreeterSetup is PluginSetup {
  function prepareInstallation(
    address _dao,
    bytes memory
  ) external returns (address plugin, PreparedSetupData memory /*preparedSetupData*/) {
    plugin = address(new MyPlugin(IDAO(_dao)));
  }

  function prepareUninstallation(
    address _dao,
    SetupPayload calldata _payload
  ) external pure returns (PermissionLib.MultiTargetPermission[] memory /*permissions*/) {
    (_dao, _payload);
  }

  function implementation() external view returns (address) {}
}

Finally, you call createPluginRepoWithFirstVersion in Aragon's deployed PluginRepoFactory (preferably via the Aragon SDK)

... and that's it 🎉.

Next Steps

You've developed a minimal plugin that can be published on the Aragon plugin registry to be installed and uninstalled to your DAO. Currently, it is not doing much. Let's change this by writing

• an non-upgradeable governance plugin
• an upgradeable plugin (advanced)

But first, let's have a look at

• best practices and patterns
• different plugin deployment types

to follow when developing a plugin, and finally, how to publish and version it.