Skip to content

Commit

Permalink
doc: update README (#3)
Browse files Browse the repository at this point in the history
* doc: update readme

* build: adapated package names
  • Loading branch information
heueristik committed Mar 8, 2024
1 parent c456d07 commit 0d93547
Show file tree
Hide file tree
Showing 5 changed files with 27 additions and 9 deletions.
26 changes: 22 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,22 +171,38 @@ 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

```sh
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
Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
4 changes: 2 additions & 2 deletions packages/contracts/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand All @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion packages/subgraph/package.json
Original file line number Diff line number Diff line change
@@ -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": {
Expand Down

0 comments on commit 0d93547

Please sign in to comment.