feat(sdk): add back PluginType enum and fix npm dependencies (#78)

* feat: add back plugin type enum * chore: bump version and maintain changelog * chore: update lockfile
aragon · Apr 23, 2024 · 5c9ac9a · 5c9ac9a
1 parent ffa6b45
commit 5c9ac9a
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 10 deletions.
diff --git a/sdk/CHANGELOG.md b/sdk/CHANGELOG.md
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
+- Add `PluginType` enum
 - Add `resolveEnsName` functions
 - Add `getProtocolVersion` function
 

diff --git a/sdk/package.json b/sdk/package.json
@@ -1,7 +1,7 @@
 {
   "name": "@aragon/osx-commons-sdk",
   "author": "Aragon Association",
-  "version": "0.0.1-alpha.10",
+  "version": "0.0.1-alpha.11",
   "license": "MIT",
   "main": "dist/index.js",
   "module": "dist/osx-commons-sdk.esm.js",
@@ -54,12 +54,12 @@
   },
   "dependencies": {
     "@aragon/osx-commons-configs": "^0.4.0",
-    "@ethersproject/address": "^5.7.0",
-    "@ethersproject/bignumber": "^5.7.0",
-    "@ethersproject/contracts": "^5.7.0",
-    "@ethersproject/hash": "^5.7.0",
-    "@ethersproject/logger": "^5.7.0",
-    "@ethersproject/providers": "^5.7.0",
+    "@ethersproject/address": "5.7.0",
+    "@ethersproject/bignumber": "5.7.0",
+    "@ethersproject/contracts": "5.7.0",
+    "@ethersproject/hash": "5.7.0",
+    "@ethersproject/logger": "5.7.0",
+    "@ethersproject/providers": "5.7.2",
     "ipfs-http-client": "^51.0.0"
   }
 }
diff --git a/sdk/src/introspection.ts b/sdk/src/introspection.ts
@@ -47,3 +47,16 @@ export async function getProtocolVersion(
   }
   return protocolVersion;
 }
+
+/**
+ * Enum for PluginType
+ * Reference: https://github.com/aragon/osx-commons/blob/ffa6b45fab9ec067d4bed3b81f5097f03861b876/contracts/src/plugin/IPlugin.sol
+ *
+ * @export
+ * @enum {number}
+ */
+export enum PluginType {
+  UUPS = 0,
+  Cloneable = 1,
+  Constructable = 2,
+}
diff --git a/sdk/src/permission.ts b/sdk/src/permission.ts
@@ -2,7 +2,7 @@ import {id} from '@ethersproject/hash';
 
 /**
  * Enum for PermissionType
- * Reference:
+ * Reference: https://github.com/aragon/osx-commons/blob/ffa6b45fab9ec067d4bed3b81f5097f03861b876/contracts/src/permission/PermissionLib.sol
  *
  * @export
  * @enum {number}

diff --git a/sdk/yarn.lock b/sdk/yarn.lock
@@ -1139,7 +1139,7 @@
   dependencies:
     "@ethersproject/bignumber" "^5.7.0"
 
-"@ethersproject/[email protected]", "@ethersproject/contracts@^5.7.0":
+"@ethersproject/[email protected]":
   version "5.7.0"
   resolved "https://registry.yarnpkg.com/@ethersproject/contracts/-/contracts-5.7.0.tgz#c305e775abd07e48aa590e1a877ed5c316f8bd1e"
   integrity sha512-5GJbzEU3X+d33CdfPhcyS+z8MzsTrBGk/sc+G+59+tPa9yFkl6HQ9D6L0QMgNTA9q8dT0XKxxkyp883XsQvbbg==
@@ -1242,7 +1242,7 @@
   dependencies:
     "@ethersproject/logger" "^5.7.0"
 
-"@ethersproject/[email protected]", "@ethersproject/providers@^5.7.0":
+"@ethersproject/[email protected]":
   version "5.7.2"
   resolved "https://registry.yarnpkg.com/@ethersproject/providers/-/providers-5.7.2.tgz#f8b1a4f275d7ce58cf0a2eec222269a08beb18cb"
   integrity sha512-g34EWZ1WWAVgr4aptGlVBF8mhl3VWjv+8hoAnzStu8Ah22VHBsuGzP17eb6xDVRzw895G4W7vvx60lFFur/1Rg==