rename isPluginUpdateAction function

aragon · Nov 21, 2023 · f292f2a · f292f2a
1 parent 27ab967
commit f292f2a
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 14 deletions.
diff --git a/modules/client/CHANGELOG.md b/modules/client/CHANGELOG.md
@@ -32,6 +32,8 @@ TEMPLATE:
 - Rename `isDaoUpdateValid` to `isDaoUpdateProposalValid` 
 - Rename `isPluginUpdate` to `isPluginUpdateProposal`
 - Rename `isPluginUpdateValid` to `isPluginUpdateProposalValid` 
+- Rename `isPluginUpdateAction` to `containsPluginUpdateAction`
+- Rename `isPluginUpdateActionBlockWithRootPermission` to `containsPluginUpdateActionBlockWithRootPermission`
 
 
 

diff --git a/modules/client/src/internal/client/methods.ts b/modules/client/src/internal/client/methods.ts
@@ -85,8 +85,8 @@ import {
 import {
   classifyProposalActions,
   containsDaoUpdateAction,
-  isPluginUpdateAction,
-  isPluginUpdateActionBlockWithRootPermission,
+  containsPluginUpdateActionBlock,
+  containsPluginUpdateActionBlockWithRootPermission,
   toAssetBalance,
   toDaoActions,
   toDaoDetails,
@@ -1155,8 +1155,8 @@ export class ClientMethods extends ClientCore implements IClientMethods {
     if(containsDaoUpdateAction(classifiedActions)) {
       classifiedActions = classifiedActions.slice(1);
     }
-    return isPluginUpdateAction(classifiedActions) ||
-      isPluginUpdateActionBlockWithRootPermission(classifiedActions);
+    return containsPluginUpdateActionBlock(classifiedActions) ||
+      containsPluginUpdateActionBlockWithRootPermission(classifiedActions);
   }
   /**
    * Check if the specified proposal id is valid for updating a plugin

diff --git a/modules/client/src/internal/utils.ts b/modules/client/src/internal/utils.ts
@@ -1328,7 +1328,7 @@ export function classifyProposalActions(
  * @param {ProposalActionTypes[]} actions
  * @return {*}  {boolean}
  */
-export function isPluginUpdateActionBlockWithRootPermission(
+export function containsPluginUpdateActionBlockWithRootPermission(
   actions: ProposalActionTypes[],
 ): boolean {
   // get the first 5 actions
@@ -1346,7 +1346,7 @@ export function isPluginUpdateActionBlockWithRootPermission(
  * @param {ProposalActionTypes[]} actions
  * @return {*}  {boolean}
  */
-export function isPluginUpdateAction(actions: ProposalActionTypes[]): boolean {
+export function containsPluginUpdateActionBlock(actions: ProposalActionTypes[]): boolean {
   // get the first 3 action
   const receivedPattern = actions.slice(0, 3);
   // check if it matches the expected pattern
@@ -1478,7 +1478,7 @@ export async function validateUpdatePluginProposalActions(
   let proposalSettingsErrorCauses: ProposalSettingsErrorCause[] = [];
   const classifiedActions = classifyProposalActions(actions);
   // check if is an update plugin proposal
-  if (isPluginUpdateAction(classifiedActions)) {
+  if (containsPluginUpdateActionBlock(classifiedActions)) {
     // initialize the causes array
     // we always use the index 0
     // because this is going to be called recursively
@@ -1521,7 +1521,7 @@ export async function validateUpdatePluginProposalActions(
           actionErrorCauses[0] = [...actionErrorCauses[0], ...resCauses];
           break;
           // other cases are not allowed and should have been
-          // caught by the isPluginUpdateAction function
+          // caught by the containsPluginUpdateActionBlock function
       }
     }
     // slice the first 3 actions
@@ -1556,7 +1556,7 @@ export async function validateUpdatePluginProposalActions(
     };
   }
 
-  if (isPluginUpdateActionBlockWithRootPermission(classifiedActions)) {
+  if (containsPluginUpdateActionBlockWithRootPermission(classifiedActions)) {
     // initialize the causes array
     // we always use the index 0
     // because this is going to be called recursively
@@ -1621,7 +1621,7 @@ export async function validateUpdatePluginProposalActions(
           break;
 
           // other cases are not allowed and should have been
-          // caught by the isPluginUpdateActionBlockWithRootPermission function
+          // caught by the containsPluginUpdateActionBlockWithRootPermission function
       }
     }
     // slice the first 5 actions

diff --git a/modules/client/test/unit/client/utils.test.ts b/modules/client/test/unit/client/utils.test.ts
@@ -28,7 +28,7 @@ import {
 import {
   containsDaoUpdateAction,
   isPluginUpdateAction,
-  isPluginUpdateActionBlockWithRootPermission,
+  containsPluginUpdateActionBlockWithRootPermission,
   validateApplyUpdateFunction,
   validateGrantRootPermissionAction,
   validateGrantUpdatePluginPermissionAction,
@@ -1359,7 +1359,7 @@ describe("Test client utils", () => {
       }
     });
   });
-  describe("isPluginUpdateAction", () => {
+  describe("containsPluginUpdateActionBlock", () => {
     it("should return the expected output given a specific input", () => {
       const cases = [
         { input: [ProposalActionTypes.UPGRADE_TO], expected: false },
@@ -1419,7 +1419,7 @@ describe("Test client utils", () => {
         },
       ];
       for (const { input, expected } of cases) {
-        const result = isPluginUpdateAction(input);
+        const result = containsPluginUpdateActionBlock(input);
         expect(result).toEqual(expected);
       }
     });
@@ -1488,7 +1488,7 @@ describe("Test client utils", () => {
         },
       ];
       for (const { input, expected } of cases) {
-        const result = isPluginUpdateActionBlockWithRootPermission(input);
+        const result = containsPluginUpdateActionBlockWithRootPermission(input);
         expect(result).toEqual(expected);
       }
     });