refactor: adaptations to use osx-commons in `osx-plugin-template-ha…

…rdhat` (#48)

* feat: single target permission type

* chore: bump version and maintain changelog

* feat: move more events

* feat: move permission manager flags

* feat: export address constants

* refactor: improved name

* test: moved over tests from hardhat template

* build: added missing import

* build: use the same typescript version

* refactor: address constants

contracts/package.json

@@ -42,7 +42,7 @@
     "tmp-promise": "^3.0.3",
     "ts-node": "^10.9.1",
     "typechain": "^8.3.2",
-    "typescript": "5.0.4"
+    "typescript": "5.2.2"
   },
   "dependencies": {
     "@openzeppelin/contracts": "4.9.5",

contracts/yarn.lock

@@ -5337,10 +5337,10 @@ typedarray@^0.0.6:
   resolved "https://registry.yarnpkg.com/typedarray/-/typedarray-0.0.6.tgz#867ac74e3864187b1d3d47d996a78ec5c8830777"
   integrity sha512-/aCDEGatGvZ2BIk+HmLf4ifCJFwvKFNb9/JeZPMulfgFracn9QFcAf5GO8B/mweUjSoblS5In0cWhqpfs/5PQA==
 
-typescript@5.0.4:
-  version "5.0.4"
-  resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.0.4.tgz#b217fd20119bd61a94d4011274e0ab369058da3b"
-  integrity sha512-cW9T5W9xY37cc+jfEnaUvX91foxtHkza3Nw3wkoF4sSlKn0MONdkdEndig/qPBWXNkmplh3NzayQzCiHM4/hqw==
+typescript@5.2.2:
+  version "5.2.2"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.2.2.tgz#5ebb5e5a5b75f085f22bc3f8460fba308310fa78"
+  integrity sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w==
 
 typical@^4.0.0:
   version "4.0.0"

package.json

@@ -15,7 +15,7 @@
     "prettier-plugin-solidity": "^1.1.3",
     "solhint": "^3.6.2",
     "solhint-plugin-prettier": "^0.0.5",
-    "typescript": "5.0.4"
+    "typescript": "5.2.2"
   },
   "scripts": {
     "lint:configs:ts": "eslint --ext .js,.ts ./configs/",

sdk/CHANGELOG.md

@@ -16,6 +16,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Created `SingleTargetPermission` type.
 - Copied files from [aragon/sdk commit 76b4fc](https://github.com/aragon/sdk/tree/76b4fc815cfacce60b7c983ef0ce53110761f23a)
 
   - Classes `ClientCore`, `ContextCore`, `Context`, `GraphQLModule`, `Web3Module`, `IPFSModule`, `MultiUri`.

sdk/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aragon/osx-commons-sdk",
   "author": "Aragon Association",
-  "version": "0.0.1-alpha.3",
+  "version": "0.0.1-alpha.4",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/osx-commons-sdk.esm.js",
@@ -49,7 +49,7 @@
     "husky": "^7.0.4",
     "size-limit": "^7.0.8",
     "tslib": "^2.3.1",
-    "typescript": "5.0.4"
+    "typescript": "5.2.2"
   },
   "dependencies": {
     "@aragon/osx-ethers": "^1.3.0-rc0.4",

sdk/src/constants.ts

@@ -38,6 +38,13 @@ const SupportedNetworksToGraphqlNetworks: {
   [SupportedNetwork.LOCAL]: 'local',
 };
 
+export const ADDRESS = {
+  ZERO: `0x${'0'.repeat(40)}`, // address(0)
+  ONE: `0x${'0'.repeat(39)}1`, // address(1)
+  TWO: `0x${'0'.repeat(39)}2`, // address(2)
+  LAST: `0x${'f'.repeat(40)}`, // address(-1)
+};
+
 export const UNSUPPORTED_PROPOSAL_METADATA_LINK: ProposalMetadata = {
   title: '(unsupported metadata link)',
   summary: '(the link to the metadata is not supported)',

sdk/src/events.ts

@@ -44,22 +44,66 @@ export async function findEventTopicLog<T>(
   }
   return iface.parseLog(log) as LogDescription & (T | LogDescription);
 }
+
+export const CALLBACK_HANDLER_EVENTS = {
+  CallbackReceived: 'CallbackReceived',
+};
+
+export const DAO_EVENTS = {
+  NewURI: 'NewURI',
+};
+
+export const DAO_REGISTRY_EVENTS = {
+  DAORegistered: 'DAORegistered',
+};
+
 export const IPROPOSAL_EVENTS = {
-  PROPOSAL_CREATED: 'ProposalCreated',
-  PROPOSAL_EXECUTED: 'ProposalExecuted',
+  ProposalCreated: 'ProposalCreated',
+  ProposalExecuted: 'ProposalExecuted',
 };
 
 export const IDAO_EVENTS = {
-  METADATA_SET: 'MetadataSet',
-  EXECUTED: 'Executed',
-  DEPOSITED: 'Deposited',
-  STANDARD_CALLBACK_REGISTERED: 'StandardCallbackRegistered',
-  TRUSTED_FORWARDER_SET: 'TrustedForwarderSet',
-  NEW_URI: 'NewURI',
+  MetadataSet: 'MetadataSet',
+  Executed: 'Executed',
+  Deposited: 'Deposited',
+  StandardCallbackRegistered: 'StandardCallbackRegistered',
+  TrustedForwarderSet: 'TrustedForwarderSet',
+  NewURI: 'NewURI',
 };
 
 export const IMEMBERSHIP_EVENTS = {
-  MEMBERS_ADDED: 'MembersAdded',
-  MEMBERS_REMOVED: 'MembersRemoved',
-  MEMBERSHIP_CONTRACT_ANNOUNCED: 'MembershipContractAnnounced',
+  MembersAdded: 'MembersAdded',
+  MembersRemoved: 'MembersRemoved',
+  MembershipContractAnnounced: 'MembershipContractAnnounced',
+};
+
+export const INTERFACE_BASED_REGISTRY_EVENTS = {
+  Registered: 'Registered',
+};
+
+export const PERMISSION_MANAGER = {
+  Granted: 'Granted',
+  Revoked: 'Revoked',
+};
+
+export const PLUGIN_REPO_EVENTS = {
+  VersionCreated: 'VersionCreated',
+};
+
+export const PLUGIN_REPO_REGISTRY_EVENTS = {
+  PluginRepoRegistered: 'PluginRepoRegistered',
+  ReleaseMetadataUpdated: 'ReleaseMetadataUpdated',
+};
+
+export const PLUGIN_SETUP_PROCESSOR_EVENTS = {
+  InstallationPrepared: 'InstallationPrepared',
+  InstallationApplied: 'InstallationApplied',
+  UpdatePrepared: 'UpdatePrepared',
+  UpdateApplied: 'UpdateApplied',
+  UninstallationPrepared: 'UninstallationPrepared',
+  UninstallationApplied: 'UninstallationApplied',
+};
+
+export const UUPS_UPGRADEABLE_EVENTS = {
+  Upgraded: 'Upgraded',
 };

sdk/src/index.ts

@@ -7,6 +7,7 @@ export * from './utils';
 export * from './schemas';
 export * from './validation';
 export * from './multiuri';
+export * from './ipfs';
 export * from './metadata';
 export * from './interfaces';
 export * from './encoding';

sdk/src/permission.ts

@@ -1,3 +1,4 @@
+import {ADDRESS} from './constants';
 import {id} from '@ethersproject/hash';
 
 export enum Operation {
@@ -6,6 +7,13 @@ export enum Operation {
   GrantWithCondition = 2,
 }
 
+export const PERMISSION_MANAGER_FLAGS = {
+  UNSET_FLAG: ADDRESS.ZERO,
+  ALLOW_FLAG: ADDRESS.TWO,
+  ANY_ADDR: ADDRESS.LAST,
+  NO_CONDITION: ADDRESS.ZERO,
+};
+
 export const DAO_PERMISSIONS = {
   ROOT_PERMISSION_ID: id('ROOT_PERMISSION'),
   EXECUTE_PERMISSION_ID: id('EXECUTE_PERMISSION'),

sdk/src/types.ts

@@ -148,6 +148,12 @@ export enum PermissionOperationType {
   GRANT_WITH_CONDITION = 2,
 }
 
+export type SingleTargetPermission = {
+  operation: PermissionOperationType;
+  who: string;
+  permissionId: string;
+};
+
 export type MultiTargetPermission = {
   operation: PermissionOperationType;
   where: string;