feat: only create new app version if abilities differ. only permit app if not permitted

Author: spacesailor24

packages/apps/ability-aerodrome-swap/jest.config.js

@@ -6,13 +6,13 @@ module.exports = {
   moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
   transformIgnorePatterns: [
     // PNPM style: scoped packages with `.` become `+`, and non-scoped stay the same
-    // Include all @account-kit, @aa-sdk, @wagmi packages and sugar-sdk using wildcards
-    '<rootDir>/node_modules/.pnpm/(?!(@noble\\+secp256k1|cbor2|@cto\\.af\\+wtf8|@t3-oss\\+env-core|@account-kit\\+[^@]+|@aa-sdk\\+[^@]+|@lit-protocol\\+vincent-scaffold-sdk|@wagmi\\+[^@]+|@tanstack\\+[^@]+|sugar-sdk)@)',
+    // Include all @account-kit, @aa-sdk, @wagmi packages and @dromos-labs/sdk.js using wildcards
+    '<rootDir>/node_modules/.pnpm/(?!(@noble\\+secp256k1|cbor2|@cto\\.af\\+wtf8|@t3-oss\\+env-core|@account-kit\\+[^@]+|@aa-sdk\\+[^@]+|@lit-protocol\\+vincent-scaffold-sdk|@wagmi\\+[^@]+|@tanstack\\+[^@]+|@dromos-labs\\+sdk\\.js)@)',
 
     // Absolute path variant (in case of different module resolution by Jest)
-    `${path.join(__dirname, '../..')}/node_modules/.pnpm/(?!(@noble\\+secp256k1|cbor2|@cto\\.af\\+wtf8|@t3-oss\\+env-core|@account-kit\\+[^@]+|@aa-sdk\\+[^@]+|@lit-protocol\\+vincent-scaffold-sdk|@wagmi\\+[^@]+|@tanstack\\+[^@]+|sugar-sdk)@)`,
+    `${path.join(__dirname, '../..')}/node_modules/.pnpm/(?!(@noble\\+secp256k1|cbor2|@cto\\.af\\+wtf8|@t3-oss\\+env-core|@account-kit\\+[^@]+|@aa-sdk\\+[^@]+|@lit-protocol\\+vincent-scaffold-sdk|@wagmi\\+[^@]+|@tanstack\\+[^@]+|@dromos-labs\\+sdk\\.js)@)`,
 
     // Fallback for non-PNPM node_modules structure
-    'node_modules/(?!.pnpm|@noble/secp256k1|cbor2|@cto\\.af/wtf8|@t3-oss/env-core|@account-kit/[^/]+|@aa-sdk/[^/]+|@lit-protocol/vincent-scaffold-sdk|@wagmi/[^/]+|@tanstack/[^/]+|sugar-sdk)',
+    'node_modules/(?!.pnpm|@noble/secp256k1|cbor2|@cto\\.af/wtf8|@t3-oss/env-core|@account-kit/[^/]+|@aa-sdk/[^/]+|@lit-protocol/vincent-scaffold-sdk|@wagmi/[^/]+|@tanstack/[^/]+|@dromos-labs/sdk.js)',
   ],
 };

packages/apps/ability-aerodrome-swap/test/e2e/swap-no-sponsorship.spec.ts

@@ -78,7 +78,6 @@ describe('Aerodrome Swap Ability E2E Tests without Gas Sponsorship', () => {
       appId = newApp.appId;
       appVersion = newApp.appVersion;
     } else {
-      // TODO Future optimization: Only create a new app version if the existing app version doesn't have the same ability and policy IPFS CIDs
       console.log('[beforeAll] Existing app, registering new app version');
       const newAppVersion = await appManager.registerNewAppVersion({
         abilityIpfsCids,

packages/apps/ability-aerodrome-swap/test/e2e/swap-with-sponsorship.spec.ts

@@ -84,7 +84,6 @@ describe('Aerodrome Swap Ability E2E Tests with Alchemy Gas Sponsorship', () =>
       appId = newApp.appId;
       appVersion = newApp.appVersion;
     } else {
-      // TODO Future optimization: Only create a new app version if the existing app version doesn't have the same ability and policy IPFS CIDs
       const newAppVersion = await appManager.registerNewAppVersion({
         abilityIpfsCids,
         abilityPolicies,

packages/libs/e2e-test-utils/src/lib/appManager/register-new-app-version.ts

@@ -7,31 +7,78 @@ import { getAppInfo } from '../delegatee/get-app-info';
  * Registers a new app version. On-chain app versions are immutable, so any time you modify
  * abilities or policies, you must register a new version of your app using the new ipfs CIDs
  *
+ * This function will check if the latest app version already has the same abilities and policies.
+ * If they match, it will return the existing appVersion without registering a new one.
+ *
  * @param abilityIpfsCids - Array of ability IPFS CIDs to register
  * @param abilityPolicies - Array of policy IPFS CIDs for each ability
+ * @param registerNewVersionOverride - Whether to register a new version even if the latest version already has the same abilities and policies
  */
 export async function registerNewAppVersion({
   abilityIpfsCids,
   abilityPolicies,
+  registerNewVersionOverride = false,
 }: {
   abilityIpfsCids: string[];
   abilityPolicies: string[][];
+  registerNewVersionOverride?: boolean;
 }) {
   const app = await getAppInfo();
 
   if (!app) {
     throw new Error('App was expected, but not found. Please register a new app first.');
   }
 
-  const { appId } = app;
+  const { appId, appVersion: latestVersion } = app;
 
   const {
     wallets: { appManager },
   } = await getChainHelpers();
 
-  const { txHash, newAppVersion } = await getClient({
-    signer: appManager,
-  }).registerNextVersion({
+  const client = getClient({ signer: appManager });
+
+  if (!registerNewVersionOverride) {
+    // Get the existing app version to compare
+    const existingAppVersion = await client.getAppVersion({
+      appId,
+      version: latestVersion,
+    });
+
+    if (existingAppVersion) {
+      // Extract existing abilities and policies
+      const existingAbilityIpfsCids = existingAppVersion.appVersion.abilities.map(
+        (ability) => ability.abilityIpfsCid,
+      );
+      const existingAbilityPolicies = existingAppVersion.appVersion.abilities.map(
+        (ability) => ability.policyIpfsCids,
+      );
+
+      // Compare arrays (order matters for abilities and policies)
+      const abilitiesMatch =
+        existingAbilityIpfsCids.length === abilityIpfsCids.length &&
+        existingAbilityIpfsCids.every((cid, index) => cid === abilityIpfsCids[index]);
+
+      const policiesMatch =
+        existingAbilityPolicies.length === abilityPolicies.length &&
+        existingAbilityPolicies.every((policies, index) => {
+          const newPolicies = abilityPolicies[index];
+          return (
+            policies.length === newPolicies.length &&
+            policies.every((policy, policyIndex) => policy === newPolicies[policyIndex])
+          );
+        });
+
+      if (abilitiesMatch && policiesMatch) {
+        console.log(
+          `App version ${latestVersion} already has the same abilities and policies. Skipping registration.`,
+        );
+        return { appId, appVersion: latestVersion };
+      }
+    }
+  }
+
+  // Register new version if abilities or policies have changed
+  const { txHash, newAppVersion } = await client.registerNextVersion({
     appId,
     versionAbilities: {
       abilityIpfsCids: abilityIpfsCids,

packages/libs/e2e-test-utils/src/lib/delegator/permit-vincent-app-version.ts

@@ -7,7 +7,11 @@ import type { PkpInfo } from '../mint-new-pkp';
 import { getChainHelpers } from '../chain';
 
 /**
- * Adds Vincent delegation permission for a specific app version for the user's Agent Wallet PKP
+ * Adds Vincent delegation permission for a specific app version for the user's Agent Wallet PKP.
+ *
+ * This function will check if the requested app version is already permitted. If it is,
+ * it will skip the permission step and return early. If a different version is permitted,
+ * it will remove the old permission before adding the new one.
  */
 export async function permitAppVersionForAgentWalletPkp({
   permissionData,
@@ -24,27 +28,35 @@ export async function permitAppVersionForAgentWalletPkp({
     wallets: { agentWalletOwner },
   } = await getChainHelpers();
 
-  const existingPermittedAppVersion = await getClient({
+  const client = getClient({
     signer: agentWalletOwner,
-  }).getPermittedAppVersionForPkp({
+  });
+
+  const existingPermittedAppVersion = await client.getPermittedAppVersionForPkp({
     pkpEthAddress: agentPkpInfo.ethAddress,
     appId,
   });
 
+  // Check if the requested version is already permitted
+  if (existingPermittedAppVersion === appVersion) {
+    console.log(
+      `App version ${appVersion} is already permitted for Agent Wallet PKP ${agentPkpInfo.ethAddress}. Skipping permission.`,
+    );
+    return;
+  }
+
+  // If a different version is permitted, remove it first
   if (existingPermittedAppVersion) {
     console.log(`Removing existing permission for app version ${existingPermittedAppVersion}`);
-    await getClient({
-      signer: agentWalletOwner,
-    }).unPermitApp({
+    await client.unPermitApp({
       pkpEthAddress: agentPkpInfo.ethAddress,
       appId,
       appVersion: existingPermittedAppVersion,
     });
   }
 
-  const result = await getClient({
-    signer: agentWalletOwner,
-  }).permitApp({
+  // Permit the new version
+  const result = await client.permitApp({
     pkpEthAddress: agentPkpInfo.ethAddress,
     appId,
     appVersion,