Merge pull request #298 from YamenMerhi/permissionName

refactor!: change `CHANGEPERMISSION` to `EDITPERMISSION`
ERC725Alliance · Jul 12, 2023 · 6a8345b · 6a8345b
2 parents 99e202a + cf0326b
commit 6a8345b
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 21 deletions.
diff --git a/docs/classes/ERC725.md b/docs/classes/ERC725.md
@@ -223,7 +223,7 @@ ERC725.decodePermissions('0x0000000000000000000000000000000000000000000000000000
 /**
 {
   CHANGEOWNER: false,
-  CHANGEPERMISSIONS: false,
+  EDITPERMISSIONS: false,
   ADDCONTROLLER: false,
   SETDATA: false,
   CALL: true,
@@ -239,7 +239,7 @@ ERC725.decodePermissions('0x0000000000000000000000000000000000000000000000000000
 /**
 {
   CHANGEOWNER: false,
-  CHANGEPERMISSIONS: true,
+  EDITPERMISSIONS: true,
   ADDCONTROLLER: false,
   SETDATA: true,
   CALL: false,
@@ -671,7 +671,7 @@ An object with [LSP6 KeyManager Permissions] as keys and a `boolean` as value. A
 ERC725.encodePermissions({
   CHANGEOWNER: false,
   ADDCONTROLLER: false,
-  CHANGEPERMISSIONS: false,
+  EDITPERMISSIONS: false,
   ADDEXTENSIONS: false,
   CHANGEEXTENSIONS: true,
   ADDUNIVERSALRECEIVERDELEGATE: false,
@@ -701,7 +701,7 @@ ERC725.encodePermissions({
 }),
 // '0x000000000000000000000000000000000000000000000000000000000000000a'
 ERC725.encodePermissions({
-  CHANGEPERMISSIONS: true,
+  EDITPERMISSIONS: true,
   CHANGEEXTENSIONS: true,
   CHANGEUNIVERSALRECEIVERDELEGATE: true,
   SETDATA: true,
@@ -711,7 +711,7 @@ ERC725.encodePermissions({
 
 // This method is also available on the instance:
 myErc725.encodePermissions({
-  CHANGEPERMISSIONS: true,
+  EDITPERMISSIONS: true,
   SETDATA: true,
 }),
 ```

diff --git a/src/constants/constants.ts b/src/constants/constants.ts
@@ -134,9 +134,9 @@ export const HASH_FUNCTIONS: {
 // TODO: These values can be imported from lsp-smartcontracts lib after release
 // prettier-ignore
 export const LSP6_DEFAULT_PERMISSIONS = {
-    CHANGEOWNER                      :"0x0000000000000000000000000000000000000000000000000000000000000001",
+  CHANGEOWNER                      :"0x0000000000000000000000000000000000000000000000000000000000000001",
 	ADDCONTROLLER                   :"0x0000000000000000000000000000000000000000000000000000000000000002",
-	CHANGEPERMISSIONS                :"0x0000000000000000000000000000000000000000000000000000000000000004",
+	EDITPERMISSIONS                :"0x0000000000000000000000000000000000000000000000000000000000000004",
 	ADDEXTENSIONS                    :"0x0000000000000000000000000000000000000000000000000000000000000008",
 	CHANGEEXTENSIONS                 :"0x0000000000000000000000000000000000000000000000000000000000000010",
 	ADDUNIVERSALRECEIVERDELEGATE     :"0x0000000000000000000000000000000000000000000000000000000000000020",

diff --git a/src/index.test.ts b/src/index.test.ts
@@ -950,7 +950,7 @@ describe('Running @erc725/erc725.js tests...', () => {
         permissions: {
           CHANGEOWNER: true,
           ADDCONTROLLER: true,
-          CHANGEPERMISSIONS: true,
+          EDITPERMISSIONS: true,
           ADDEXTENSIONS: true,
           CHANGEEXTENSIONS: true,
           ADDUNIVERSALRECEIVERDELEGATE: true,
@@ -977,7 +977,7 @@ describe('Running @erc725/erc725.js tests...', () => {
         permissions: {
           CHANGEOWNER: false,
           ADDCONTROLLER: false,
-          CHANGEPERMISSIONS: false,
+          EDITPERMISSIONS: false,
           ADDEXTENSIONS: false,
           CHANGEEXTENSIONS: false,
           ADDUNIVERSALRECEIVERDELEGATE: false,
@@ -1004,7 +1004,7 @@ describe('Running @erc725/erc725.js tests...', () => {
         permissions: {
           CHANGEOWNER: false,
           ADDCONTROLLER: false,
-          CHANGEPERMISSIONS: false,
+          EDITPERMISSIONS: false,
           ADDEXTENSIONS: false,
           CHANGEEXTENSIONS: false,
           ADDUNIVERSALRECEIVERDELEGATE: false,
@@ -1031,7 +1031,7 @@ describe('Running @erc725/erc725.js tests...', () => {
         permissions: {
           CHANGEOWNER: false,
           ADDCONTROLLER: false,
-          CHANGEPERMISSIONS: false,
+          EDITPERMISSIONS: false,
           ADDEXTENSIONS: false,
           CHANGEEXTENSIONS: false,
           ADDUNIVERSALRECEIVERDELEGATE: false,
@@ -1058,7 +1058,7 @@ describe('Running @erc725/erc725.js tests...', () => {
         permissions: {
           CHANGEOWNER: false,
           ADDCONTROLLER: false,
-          CHANGEPERMISSIONS: true,
+          EDITPERMISSIONS: true,
           ADDEXTENSIONS: false,
           CHANGEEXTENSIONS: false,
           ADDUNIVERSALRECEIVERDELEGATE: false,
@@ -1085,7 +1085,7 @@ describe('Running @erc725/erc725.js tests...', () => {
         permissions: {
           CHANGEOWNER: false,
           ADDCONTROLLER: false,
-          CHANGEPERMISSIONS: false,
+          EDITPERMISSIONS: false,
           ADDEXTENSIONS: false,
           CHANGEEXTENSIONS: false,
           ADDUNIVERSALRECEIVERDELEGATE: false,
@@ -1129,14 +1129,14 @@ describe('Running @erc725/erc725.js tests...', () => {
       it('Defaults permissions to false if not passed', () => {
         assert.deepStrictEqual(
           ERC725.encodePermissions({
-            CHANGEPERMISSIONS: true,
+            EDITPERMISSIONS: true,
             SETDATA: true,
           }),
           '0x0000000000000000000000000000000000000000000000000000000000040004',
         );
         assert.deepStrictEqual(
           erc725Instance.encodePermissions({
-            CHANGEPERMISSIONS: true,
+            EDITPERMISSIONS: true,
             SETDATA: true,
           }),
           '0x0000000000000000000000000000000000000000000000000000000000040004',
@@ -1165,7 +1165,7 @@ describe('Running @erc725/erc725.js tests...', () => {
           {
             CHANGEOWNER: true,
             ADDCONTROLLER: true,
-            CHANGEPERMISSIONS: true,
+            EDITPERMISSIONS: true,
             ADDEXTENSIONS: true,
             CHANGEEXTENSIONS: true,
             ADDUNIVERSALRECEIVERDELEGATE: true,
@@ -1194,7 +1194,7 @@ describe('Running @erc725/erc725.js tests...', () => {
           {
             CHANGEOWNER: true,
             ADDCONTROLLER: true,
-            CHANGEPERMISSIONS: true,
+            EDITPERMISSIONS: true,
             ADDEXTENSIONS: true,
             CHANGEEXTENSIONS: true,
             ADDUNIVERSALRECEIVERDELEGATE: true,

diff --git a/src/index.ts b/src/index.ts
@@ -459,7 +459,7 @@ export class ERC725 {
     const result = {
       CHANGEOWNER: false,
       ADDCONTROLLER: false,
-      CHANGEPERMISSIONS: false,
+      EDITPERMISSIONS: false,
       ADDEXTENSIONS: false,
       CHANGEEXTENSIONS: false,
       ADDUNIVERSALRECEIVERDELEGATE: false,

diff --git a/src/lib/detector.test.ts b/src/lib/detector.test.ts
@@ -157,7 +157,7 @@ describe('checkPermissions', () => {
     });
 
     it('should return false when one of the literal permissions does not match granted permissions', async () => {
-      const requiredPermissions = ['CHANGEPERMISSIONS', 'CALL'];
+      const requiredPermissions = ['EDITPERMISSIONS', 'CALL'];
       const grantedPermissions =
         '0x000000000000000000000000000000000000000000000000000000000000ff51';
       const result = checkPermissions(requiredPermissions, grantedPermissions);
@@ -177,7 +177,7 @@ describe('checkPermissions', () => {
 
     it('should return true when all the mixed literal and bytes32 permissions match granted permissions', async () => {
       const requiredPermissions = [
-        'CHANGEPERMISSIONS',
+        'EDITPERMISSIONS',
         '0x0000000000000000000000000000000000000000000000000000000000000800',
       ];
       const grantedPermissions =

diff --git a/src/types/Method.ts b/src/types/Method.ts
@@ -27,7 +27,7 @@ export interface MethodData {
 export interface Permissions {
   CHANGEOWNER?: boolean;
   ADDCONTROLLER?: boolean;
-  CHANGEPERMISSIONS?: boolean;
+  EDITPERMISSIONS?: boolean;
   ADDEXTENSIONS?: boolean;
   CHANGEEXTENSIONS?: boolean;
   ADDUNIVERSALRECEIVERDELEGATE?: boolean;