From 0c574adf20f95ff4a4a158bd0135660fb6577401 Mon Sep 17 00:00:00 2001 From: YamenMerhi Date: Mon, 10 Jul 2023 13:23:59 +0300 Subject: [PATCH 1/3] chore: Update permission name from `CHANGEPERMISSIONS` to `EDITPERMISSIONS` --- src/constants/constants.ts | 4 ++-- src/index.ts | 2 +- src/types/Method.ts | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/src/constants/constants.ts b/src/constants/constants.ts index ad2c1ea0..24188880 100644 --- 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.ts b/src/index.ts index 5a39e858..47f21e49 100644 --- 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/types/Method.ts b/src/types/Method.ts index 738df487..5bcf3ac1 100644 --- 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; From ec70c91703fd43c8f4391a39ee9a2b3a670a3f30 Mon Sep 17 00:00:00 2001 From: YamenMerhi Date: Mon, 10 Jul 2023 13:25:57 +0300 Subject: [PATCH 2/3] test: update permission name in tests --- src/index.test.ts | 20 ++++++++++---------- src/lib/detector.test.ts | 4 ++-- 2 files changed, 12 insertions(+), 12 deletions(-) diff --git a/src/index.test.ts b/src/index.test.ts index 8b07ade2..d18f1fc5 100644 --- 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/lib/detector.test.ts b/src/lib/detector.test.ts index b3ea6e0a..dbe92464 100644 --- 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 = From cf0326b21f69ad0deff9e961f6d5e40198007a64 Mon Sep 17 00:00:00 2001 From: YamenMerhi Date: Mon, 10 Jul 2023 13:26:07 +0300 Subject: [PATCH 3/3] docs: update permission name in docs --- docs/classes/ERC725.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/classes/ERC725.md b/docs/classes/ERC725.md index d8deb74b..36a5b465 100644 --- 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, @@ -669,7 +669,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, @@ -699,7 +699,7 @@ ERC725.encodePermissions({ }), // '0x000000000000000000000000000000000000000000000000000000000000000a' ERC725.encodePermissions({ - CHANGEPERMISSIONS: true, + EDITPERMISSIONS: true, CHANGEEXTENSIONS: true, CHANGEUNIVERSALRECEIVERDELEGATE: true, SETDATA: true, @@ -709,7 +709,7 @@ ERC725.encodePermissions({ // This method is also available on the instance: myErc725.encodePermissions({ - CHANGEPERMISSIONS: true, + EDITPERMISSIONS: true, SETDATA: true, }), ```