From ae599ee0f81f32f52c496f62839befef1b52e763 Mon Sep 17 00:00:00 2001 From: Michael Heuer Date: Fri, 8 Mar 2024 10:44:58 +0100 Subject: [PATCH 1/2] doc: update readme --- README.md | 26 ++++++++++++++++--- .../40_conclude/41_transfer_ownership.ts | 2 +- 2 files changed, 23 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 0fba72a0..49ea2a21 100644 --- a/README.md +++ b/README.md @@ -171,15 +171,29 @@ Deploy the contracts to the local Hardhat Network (being forked from the network yarn deploy --tags CreateRepo,NewVersion ``` -This will create a plugin repo and publish the the first version (`v1.1`) of your plugin. +This will create a plugin repo and publish the first version (`v1.1`) of your plugin. +By adding the tag `TransferOwnershipToManagmentDao`, the `ROOT_PERMISSION_ID`, `MAINTAINER_PERMISSION_ID`, and +`UPGRADE_REPO_PERMISSION_ID` are granted to the management DAO and revoked from the deployer. +You can do this directly -Deploy the contracts to sepolia with +```sh +yarn deploy --tags CreateRepo,NewVersion,TransferOwnershipToManagmentDao +``` + +or at a later point by executing ```sh -yarn deploy --network sepolia --tags CreateRepo,NewVersion,Verification +yarn deploy --tags TransferOwnershipToManagmentDao ``` -This will create a plugin repo, publish the the first version (`v1.1`) of your plugin, and verfiy the contracts on sepolia. +To deploy the contracts to a production network use the `--network` option, for example + +```sh +yarn deploy --network sepolia --tags CreateRepo,NewVersion,TransferOwnershipToManagmentDao,Verification +``` + +This will create a plugin repo, publish the first version (`v1.1`) of your plugin, transfer permissions to the +management DAO, and lastly verfiy the contracts on sepolia. If you want to deploy a new version of your plugin afterwards (e.g., `1.2`), simply change the `VERSION` entry in the `packages/contracts/plugin-settings.ts` file and use @@ -187,6 +201,8 @@ If you want to deploy a new version of your plugin afterwards (e.g., `1.2`), sim yarn deploy --network sepolia --tags NewVersion,Verification ``` +Note, that if the deploying account doesn't own the repo anymore, this will create a `createVersionProposalData-sepolia.json` containing the data for a management DAO signer to create a proposal publishing a new version. + Note, that if you include the `CreateRepo` tag after you've created your plugin repo already, this part of the script will be skipped. #### Upgrading Your Plugin Repository @@ -206,6 +222,8 @@ yarn deploy --network sepolia --tags UpgradeRepo This will upgrade your plugin repo to the latest Aragon OSx protocol version implementation, which might include new features and security updates. **For this to work, make sure that you are using the latest version of [this repository](https://github.com/aragon/osx-plugin-template-hardhat) in your fork.** +Note, that if the deploying account doesn't own the repo anymore, this will create a `upgradeRepoProposalData-sepolia.json` containing the data for a management DAO signer to create a proposal upgrading the repo. + ## Subgraph ### Installing diff --git a/packages/contracts/deploy/40_conclude/41_transfer_ownership.ts b/packages/contracts/deploy/40_conclude/41_transfer_ownership.ts index aac32467..935fb83a 100644 --- a/packages/contracts/deploy/40_conclude/41_transfer_ownership.ts +++ b/packages/contracts/deploy/40_conclude/41_transfer_ownership.ts @@ -30,7 +30,7 @@ const func: DeployFunction = async function (hre: HardhatRuntimeEnvironment) { ); const permissions: DAOStructs.MultiTargetPermissionStruct[] = [ - // Grant to the managment DAO + // Grant to the management DAO { operation: Operation.Grant, where: pluginRepo.address, From 90f65370dffe4707c952102d2fdeee0ae04909f8 Mon Sep 17 00:00:00 2001 From: Michael Heuer Date: Fri, 8 Mar 2024 11:02:25 +0100 Subject: [PATCH 2/2] build: adapated package names --- package.json | 2 +- packages/contracts/package.json | 4 ++-- packages/subgraph/package.json | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/package.json b/package.json index 26e1cb04..26d74775 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "@aragon/osx-plugin-template", + "name": "@aragon/multisig-plugin", "description": "A template to fork from when developing an Aragon OSx plugin", "version": "0.0.1-alpha.1", "license": "AGPL-3.0-or-later", diff --git a/packages/contracts/package.json b/packages/contracts/package.json index 06332257..53244bb6 100644 --- a/packages/contracts/package.json +++ b/packages/contracts/package.json @@ -1,5 +1,5 @@ { - "name": "@aragon/osx-plugin-template-contracts", + "name": "@aragon/multisig-plugin-contracts", "version": "1.0.0", "license": "AGPL-3.0-or-later", "scripts": { @@ -20,8 +20,8 @@ }, "devDependencies": { "@aragon/osx-commons-configs": "0.1.0", - "@aragon/osx-ethers": "1.4.0-alpha.0", "@aragon/osx-commons-sdk": "0.0.1-alpha.5", + "@aragon/osx-ethers": "1.4.0-alpha.0", "@aragon/osx-v1.0.0": "npm:@aragon/osx@1.0.1", "@aragon/osx-v1.3.0": "npm:@aragon/osx@1.3.0", "@ethersproject/abi": "^5.7.0", diff --git a/packages/subgraph/package.json b/packages/subgraph/package.json index 6fd0d40e..bc4571ed 100644 --- a/packages/subgraph/package.json +++ b/packages/subgraph/package.json @@ -1,5 +1,5 @@ { - "name": "@aragon/osx-plugin-template-subgraph", + "name": "@aragon/multisig-plugin-subgraph", "version": "1.0.0", "license": "AGPL-3.0-or-later", "scripts": {