generated from aragon/osx-plugin-template-hardhat
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #8 from aragon/f/mgmt-dao-setup
Management DAO post install script
- Loading branch information
Showing
13 changed files
with
597 additions
and
132 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,120 @@ | ||
| # Geo Browser - Aragon OSx | ||
|
|
||
| ## Deployment | ||
|
|
||
| ### On a blockchain supported by Aragon | ||
|
|
||
| If the current contracts are meant to be deployed on a blockchain like Mainnet, Sepolia, Polygon, Base, etc, the only step needed is to define the relevant env vars on `.env` and run the following command: | ||
|
|
||
| ```sh | ||
| cd packages/contracts | ||
| npx hardhat deploy --network <the-network-name> | ||
| ``` | ||
|
|
||
| ### On a custom blockchain | ||
|
|
||
| In the case of specific blockchains where OSx support is not officially available, you will need to deploy it first. The high level process looks like: | ||
|
|
||
| 0. Prepare a wallet for the whole deployment process | ||
| 1. Deploy OSx | ||
| 1. This will create a Managing DAO, where the deployer wallet can `execute()` actions | ||
| 2. Deploy the plugins of this project | ||
| 3. Install the plugin that will control the Managing DAO and revoke the `ROOT_PERMISSION` from the deployment wallet | ||
|
|
||
| #### 1) Deploy OSx | ||
|
|
||
| Clone [the OSx repo](https://github.com/aragon/osx) into a separate folder. | ||
|
|
||
| ```sh | ||
| git checkout deployments/simpler-deployment | ||
| yarn | ||
| cd packages/contracts | ||
| cp .env.example .env | ||
| nano .env # Update the values | ||
| yarn build | ||
| # yarn test (optional) | ||
| ``` | ||
|
|
||
| - Open the [DEPLOYMENT_CHECKLIST.md](https://github.com/aragon/osx/blob/deployments/simpler-deployment/DEPLOYMENT_CHECKLIST.md) file and follow the instructions | ||
|
|
||
| Write down the address of the deployed contracts. The result should look similar to this: | ||
|
|
||
| ```json | ||
| { | ||
| "managingDAOImplementation": "0x731b7F3d74C9dc25A90af73B960ad51f42481d6c", | ||
| "managingDAO": "0x1C57A251B1902656693f689aA69389f2a6f2a432", | ||
| "ENSRegistry": "0xE847017f1e18F7bF35b180fD45b4dAC18E81d568", | ||
| "PublicResolver": "0xE3B1288048f898A28a78FCf9942E14Cc853fFEF2", | ||
| "DAO_ENSSubdomainRegistrar_Implementation": "0xd92C33f309D6e795DCe1980aBc42D3431b0af0e7", | ||
| "DAO_ENSSubdomainRegistrar": "0xcf9D94Ddd248694B66D1D445b85ccbE385634Cc8", | ||
| "Plugin_ENSSubdomainRegistrar_Implementation": "0x7BC82fCba3521B15792423ac4E6076582235263B", | ||
| "Plugin_ENSSubdomainRegistrar": "0xd14C706586c6177d54D201df009b75FB14E8AB5E", | ||
| "DAORegistry_Implementation": "0x66a19CC345dAB31dfb6295017819d54dB594DE56", | ||
| "DAORegistry": "0x11d3B1B24C19B5672b92CD535d2F1F35C53AC543", | ||
| "PluginRepoRegistry_Implementation": "0x38b112318cfd563Fa5de538E7c219bf72F1CcA6a", | ||
| "PluginRepoRegistry": "0x9b51505f7bf3A45BC92F6bE269324096abEC0A73", | ||
| "PluginRepoFactory": "0xA69347F49dD615cb4577670D0728684AfAa01197", | ||
| "PluginSetupProcessor": "0xAc7e4fB4a2158b7EA5516f47b6f804956Faf0134", | ||
| "DAOFactory": "0x2d11E9413264e3814C2a21160cBCcb9Dc3C96890" | ||
| } | ||
| ``` | ||
|
|
||
| Copy the `PluginRepoFactory`, the `PluginSetupProcessor` and the `managingDAO` addresses for the next step. | ||
|
|
||
| #### 2) Run the plugin deployment script | ||
|
|
||
| Back to this repository: | ||
|
|
||
| - Update the `.env` file with the values that correspond to your target blockchain | ||
| - `NETWORK_NAME` and `DEPLOYMENT_RPC_ENDPOINT` | ||
| - Alternatively, edit the `packages/contracts/hardhat.config.ts` to manually customize the HardHat client | ||
| - Define the deployment wallet's `PRIVATE_KEY` | ||
| - Define the protocol addresses [you copied before](#1-deploy-osx): | ||
| - `PLUGIN_REPO_FACTORY_ADDRESS`, `PLUGIN_SETUP_PROCESSOR_ADDRESS` and `MANAGING_DAO_ADDRESS` | ||
| - Edit the `packages/contracts/plugin-setup-params.ts` to define the details of the plugins to depoy | ||
| - If you try to deploy the same plugin repo twice, you will encounter an ENS collision | ||
| - In such case, either define a new unique ENS subdomain or consider rerunning the step 1 and trying again | ||
| - Review the Management DAO's plugin settings under `.env` | ||
|
|
||
| ```sh | ||
| cd packages/contracts | ||
| yarn build | ||
| yarn deploy --network <the-network-name> | ||
| ``` | ||
|
|
||
| #### 3) Install a governance plugin to the Managing DAO | ||
|
|
||
| The Managing DAO is the contract that has the role of managing certain protocol modules, like the Plugin Registry, the DAO registry, etc. In case a new OSx version is available, only that DAO is be able to push upgrades and perform certain management tasks, which makes it a key component. | ||
|
|
||
| The Managing DAO will be created with the following permissions: | ||
|
|
||
| - The Managing DAO holds `ROOT_PERMISSION` on itself | ||
| - The deployer address also holds `ROOT_PERMISSION` on the Managing DAO | ||
|
|
||
| Among the plugins deployed [in the step above](#2-deploy-your-plugins), one of them should be installed to the Managing DAO. | ||
|
|
||
| When the script from step 2 finishes, you should see a message like this: | ||
|
|
||
| ``` | ||
| If you wish to configure the Managing DAO: | ||
| 1) Update the .env file with this value: | ||
| GOVERNANCE_PLUGIN_REPO_ADDRESS="0xeC91F7Fa3BcFB208c679d2d7de18E7bd9d7cC40B" | ||
| 2) Define the following values: | ||
| MGMT_DAO_PROPOSAL_DURATION="604800" # 60 * 60 * 24 * 7 (seconds) | ||
| MGMT_DAO_MIN_PROPOSAL_PARTICIPATION="500000" # 50% | ||
| MGMT_DAO_PROPOSAL_SUPPORT_THRESHOLD="500000" # 50% | ||
| MGMT_DAO_INITIAL_EDITORS="0x1234,0x2345,0x3456,0x4567..." # Comma separated addresses | ||
| 3) Run the following command: | ||
| $ yarn managing-dao-setup | ||
| ``` | ||
|
|
||
| By running the `managing-dao-setup.ts` script, you will be: | ||
|
|
||
| 1. Asking the [PSP from OSx](#1-deploy-osx) to run `prepareInstallation()` and deploy a new Governance plugin instance | ||
| 2. Ask the Managing DAO to call `applyInstallation()` on the PSP for the deployed plugin | ||
| 3. Make the Managing DAO revoke the remaining deployment wallet permissions | ||
| 4. Checking that the Managing DAO's permissions are correctly configured |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| import {GovernancePluginsSetupParams} from '../../plugin-setup-params'; | ||
| import {isLocalChain} from '../../utils/hardhat'; | ||
| import {getPluginRepoInfo} from '../../utils/plugin-repo-info'; | ||
| import {DeployFunction} from 'hardhat-deploy/types'; | ||
| import {HardhatRuntimeEnvironment} from 'hardhat/types'; | ||
|
|
||
| const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) { | ||
| const pluginRepoInfo = getPluginRepoInfo( | ||
| GovernancePluginsSetupParams.PLUGIN_REPO_ENS_NAME, | ||
| hre.network.name | ||
| ); | ||
| if (!pluginRepoInfo) | ||
| throw new Error('Could not read the address of the deployed contract'); | ||
|
|
||
| console.log(` | ||
| If you wish to configure the Managing DAO: | ||
| 1) Update the .env file with this value: | ||
| GOVERNANCE_PLUGIN_REPO_ADDRESS="${pluginRepoInfo.address}" | ||
| 2) Define the following values: | ||
| MGMT_DAO_PROPOSAL_DURATION="604800" # 60 * 60 * 24 * 7 (seconds) | ||
| MGMT_DAO_MIN_PROPOSAL_PARTICIPATION="500000" # 50% | ||
| MGMT_DAO_PROPOSAL_SUPPORT_THRESHOLD="500000" # 50% | ||
| MGMT_DAO_INITIAL_EDITORS="0x1234,0x2345,0x3456,0x4567..." # Comma separated addresses | ||
| 3) Run the following command: | ||
| $ npx ts-node scripts/managing-dao-setup.ts | ||
| `); | ||
| }; | ||
|
|
||
| export default func; | ||
|
|
||
| func.tags = ['Verification']; | ||
| func.runAtTheEnd = true; | ||
| func.skip = (hre: HardhatRuntimeEnvironment) => | ||
| Promise.resolve(isLocalChain(hre.network.name)); |
Oops, something went wrong.