Merge pull request #354 from LIT-Protocol/fix/add-deleted-apps

Return deleted Apps for get Apps contract methods

Author: DashKash54

.nx/version-plans/version-plan-1759560325219.md

@@ -0,0 +1,5 @@
+---
+contracts-sdk: major
+---
+
+getPermittedAppsForPkps and getUnpermittedAppsForPkps now return deleted Apps. A new isDeleted property has been added to the return value of these methods to indicate if each returned App is currently marked as deleted

packages/libs/contracts-sdk/abis/VincentUserViewFacet.abi.json

@@ -206,6 +206,11 @@
                 "name": "versionEnabled",
                 "type": "bool",
                 "internalType": "bool"
+              },
+              {
+                "name": "isDeleted",
+                "type": "bool",
+                "internalType": "bool"
               }
             ]
           }
@@ -259,6 +264,11 @@
                 "name": "versionEnabled",
                 "type": "bool",
                 "internalType": "bool"
+              },
+              {
+                "name": "isDeleted",
+                "type": "bool",
+                "internalType": "bool"
               }
             ]
           }

packages/libs/contracts-sdk/contracts/facets/VincentUserViewFacet.sol

@@ -96,11 +96,13 @@ contract VincentUserViewFacet is VincentBase {
      * @param appId The ID of the permitted app
      * @param version The permitted version of the app
      * @param versionEnabled Whether the permitted version is currently enabled
+     * @param isDeleted Whether the app has been deleted
      */
     struct PermittedApp {
         uint40 appId;
         uint24 version;
         bool versionEnabled;
+        bool isDeleted;
     }
 
     /**
@@ -109,11 +111,13 @@ contract VincentUserViewFacet is VincentBase {
      * @param appId The ID of the unpermitted app
      * @param previousPermittedVersion The last permitted version before unpermitting
      * @param versionEnabled Whether the previous permitted version is currently enabled
+     * @param isDeleted Whether the app has been deleted
      */
     struct UnpermittedApp {
         uint40 appId;
         uint24 previousPermittedVersion;
         bool versionEnabled;
+        bool isDeleted;
     }
 
     /**
@@ -177,15 +181,14 @@ contract VincentUserViewFacet is VincentBase {
     }
 
     /**
-     * @dev Gets all permitted app versions for a specific app and PKP token
+     * @dev Gets the permitted app version for a specific app and PKP token, even if the app has been deleted
      * @param pkpTokenId The PKP token ID
      * @param appId The app ID
-     * @return An array of app versions that are permitted for the PKP token
+     * @return The permitted app version for the PKP token and app
      */
     function getPermittedAppVersionForPkp(uint256 pkpTokenId, uint40 appId)
         external
         view
-        appNotDeleted(appId)
         returns (uint24)
     {
         // Check for invalid PKP token ID and app ID
@@ -228,56 +231,40 @@ contract VincentUserViewFacet is VincentBase {
 
     /**
      * @notice DEPRECATED: Use {getPermittedAppsForPkps} instead. This function will be removed in future releases.
-     * @dev Gets all app IDs that have permissions for a specific PKP token, excluding deleted apps, with pagination support.
+     * @dev Gets all app IDs that have permissions for a specific PKP token, including deleted apps, with pagination support.
      * @dev Migration guidance: Replace calls to this function with {getPermittedAppsForPkps}, which returns both app IDs and their permitted versions for a PKP token. Update your code to handle the new return type and logic as needed.
      * @param pkpTokenId The PKP token ID
      * @param offset The offset of the first app ID to retrieve
-     * @return An array of app IDs that have permissions for the PKP token and haven't been deleted
+     * @return An array of app IDs that have permissions for the PKP token (including deleted apps)
      */
     function getAllPermittedAppIdsForPkp(uint256 pkpTokenId, uint256 offset) external view returns (uint40[] memory) {
         if (pkpTokenId == 0) {
             revert InvalidPkpTokenId();
         }
 
         VincentUserStorage.UserStorage storage us_ = VincentUserStorage.userStorage();
-        VincentAppStorage.AppStorage storage as_ = VincentAppStorage.appStorage();
 
         EnumerableSet.UintSet storage permittedAppSet = us_.agentPkpTokenIdToAgentStorage[pkpTokenId].permittedApps;
         uint256 permittedAppCount = permittedAppSet.length();
 
-        uint40[] memory nonDeletedAppIds = new uint40[](permittedAppCount);
-        uint256 nonDeletedCount = 0;
-
-        for (uint256 i = 0; i < permittedAppCount; i++) {
-            uint40 appId = uint40(permittedAppSet.at(i));
-            if (!as_.appIdToApp[appId].isDeleted) {
-                nonDeletedAppIds[nonDeletedCount] = appId;
-                nonDeletedCount++;
-            }
-        }
-
-        if (nonDeletedCount == 0) {
+        if (permittedAppCount == 0) {
             return new uint40[](0);
         }
 
-        assembly {
-            mstore(nonDeletedAppIds, nonDeletedCount)
-        }
-
-        if (offset >= nonDeletedCount) {
-            revert InvalidOffset(offset, nonDeletedCount);
+        if (offset >= permittedAppCount) {
+            revert InvalidOffset(offset, permittedAppCount);
         }
 
         uint256 end = offset + AGENT_PAGE_SIZE;
-        if (end > nonDeletedCount) {
-            end = nonDeletedCount;
+        if (end > permittedAppCount) {
+            end = permittedAppCount;
         }
 
         uint256 resultCount = end - offset;
         uint40[] memory result = new uint40[](resultCount);
 
         for (uint256 i = offset; i < end; i++) {
-            result[i - offset] = nonDeletedAppIds[i];
+            result[i - offset] = uint40(permittedAppSet.at(i));
         }
 
         return result;
@@ -316,32 +303,30 @@ contract VincentUserViewFacet is VincentBase {
             EnumerableSet.UintSet storage permittedApps = agentStorage.permittedApps;
             uint256 appCount = permittedApps.length();
 
-            // Count non-deleted permitted apps
+            // Collect all permitted apps including deleted ones
             PermittedApp[] memory tempPermittedApps = new PermittedApp[](appCount);
-            uint256 permittedCount;
 
             for (uint256 j; j < appCount; j++) {
                 uint40 appId = uint40(permittedApps.at(j));
-                if (!as_.appIdToApp[appId].isDeleted) {
-                    // Get version details for the permitted app
-                    uint24 version = agentStorage.permittedAppVersion[appId];
-                    bool enabled = as_.appIdToApp[appId].appVersions[getAppVersionIndex(version)].enabled;
-                    tempPermittedApps[permittedCount] = PermittedApp({
-                        appId: appId,
-                        version: version,
-                        versionEnabled: enabled
-                    });
-                    permittedCount++;
-                }
+                // Get version details for the permitted app
+                uint24 version = agentStorage.permittedAppVersion[appId];
+                bool enabled = as_.appIdToApp[appId].appVersions[getAppVersionIndex(version)].enabled;
+                bool isDeleted = as_.appIdToApp[appId].isDeleted;
+                tempPermittedApps[j] = PermittedApp({
+                    appId: appId,
+                    version: version,
+                    versionEnabled: enabled,
+                    isDeleted: isDeleted
+                });
             }
 
             // Apply pagination
             uint256 resultCount;
-            if (offset < permittedCount) {
-                uint256 end = offset + pageSize > permittedCount ? permittedCount : offset + pageSize;
+            if (offset < appCount) {
+                uint256 end = offset + pageSize > appCount ? appCount : offset + pageSize;
                 resultCount = end - offset;
             }
-            
+
             results[i].permittedApps = new PermittedApp[](resultCount);
             for (uint256 k; k < resultCount; k++) {
                 results[i].permittedApps[k] = tempPermittedApps[offset + k];
@@ -595,20 +580,22 @@ contract VincentUserViewFacet is VincentBase {
             VincentUserStorage.AgentStorage storage agentStorage = us_.agentPkpTokenIdToAgentStorage[pkpTokenId];
             uint256 allAppCount = agentStorage.allPermittedApps.length();
 
-            // Collect all unpermitted apps
+            // Collect all unpermitted apps including deleted ones
             UnpermittedApp[] memory tempUnpermittedApps = new UnpermittedApp[](allAppCount);
             uint256 unpermittedCount;
-            
+
             for (uint256 j; j < allAppCount; j++) {
                 uint40 appId = uint40(agentStorage.allPermittedApps.at(j));
-                if (!agentStorage.permittedApps.contains(appId) && !as_.appIdToApp[appId].isDeleted) {
+                if (!agentStorage.permittedApps.contains(appId)) {
                     uint24 lastPermittedVersion = agentStorage.lastPermittedVersion[appId];
                     bool enabled = as_.appIdToApp[appId].appVersions[getAppVersionIndex(lastPermittedVersion)].enabled;
-                    
+                    bool isDeleted = as_.appIdToApp[appId].isDeleted;
+
                     tempUnpermittedApps[unpermittedCount] = UnpermittedApp({
                         appId: appId,
                         previousPermittedVersion: lastPermittedVersion,
-                        versionEnabled: enabled
+                        versionEnabled: enabled,
+                        isDeleted: isDeleted
                     });
                     unpermittedCount++;
                 }
@@ -620,7 +607,7 @@ contract VincentUserViewFacet is VincentBase {
                 uint256 end = offset + AGENT_PAGE_SIZE > unpermittedCount ? unpermittedCount : offset + AGENT_PAGE_SIZE;
                 resultCount = end - offset;
             }
-            
+
             results[i].unpermittedApps = new UnpermittedApp[](resultCount);
             for (uint256 k; k < resultCount; k++) {
                 results[i].unpermittedApps[k] = tempUnpermittedApps[offset + k];

packages/libs/contracts-sdk/src/internal/user/UserView.ts

@@ -129,6 +129,7 @@ export async function getPermittedAppsForPkps(
         appId: app.appId,
         version: app.version,
         versionEnabled: app.versionEnabled,
+        isDeleted: app.isDeleted,
       })),
     }));
   } catch (error: unknown) {
@@ -247,6 +248,7 @@ export async function getUnpermittedAppsForPkps(
         appId: app.appId,
         previousPermittedVersion: app.previousPermittedVersion,
         versionEnabled: app.versionEnabled,
+        isDeleted: app.isDeleted,
       })),
     }));
   } catch (error: unknown) {

packages/libs/contracts-sdk/src/internal/user/types.ts

@@ -149,6 +149,7 @@ export interface ContractPkpPermittedApps {
     appId: number;
     version: number;
     versionEnabled: boolean;
+    isDeleted: boolean;
   }[];
 }
 
@@ -163,5 +164,6 @@ export interface ContractPkpUnpermittedApps {
     appId: number;
     previousPermittedVersion: number;
     versionEnabled: boolean;
+    isDeleted: boolean;
   }[];
 }

packages/libs/contracts-sdk/src/types.ts

@@ -299,6 +299,7 @@ export interface PermittedApp {
   appId: number;
   version: number;
   versionEnabled: boolean;
+  isDeleted: boolean;
 }
 
 /**
@@ -359,6 +360,7 @@ export interface UnpermittedApp {
   appId: number;
   previousPermittedVersion: number;
   versionEnabled: boolean;
+  isDeleted: boolean;
 }
 
 /**
@@ -514,18 +516,18 @@ export interface ContractClient {
     params: GetAllRegisteredAgentPkpsParams,
   ): ReturnType<typeof _getAllRegisteredAgentPkpEthAddresses>;
 
-  /** Get the permitted app version for a specific PKP token and app
+  /** Get the permitted app version for a specific PKP token and app, even if the app has been deleted
    *
    * @returns The permitted app version for the PKP token and app
    */
   getPermittedAppVersionForPkp(
     params: GetPermittedAppVersionForPkpParams,
   ): ReturnType<typeof _getPermittedAppVersionForPkp>;
 
-  /** Get all app IDs that have permissions for a specific PKP token, excluding deleted apps
+  /** Get all app IDs that have permissions for a specific PKP token, including deleted apps
    *
    * @deprecated Use getPermittedAppsForPkps instead
-   * @returns Array of app IDs that have permissions for the PKP token and haven't been deleted
+   * @returns Array of app IDs that have permissions for the PKP token (including deleted apps)
    */
   getAllPermittedAppIdsForPkp(
     params: GetAllPermittedAppIdsForPkpParams,

packages/libs/contracts-sdk/test/facets/VincentAppFacet.t.sol

@@ -671,11 +671,17 @@ contract VincentAppFacetTest is Test {
 
         assertEq(vincentAppViewFacet.getAppById(newAppId).isDeleted, true);
 
-        // Verify deleted app is filtered out from getPermittedAppsForPkps
+        // Verify deleted app is still returned but with isDeleted flag set to true
         permittedAppsResults = vincentUserViewFacet.getPermittedAppsForPkps(pkpTokenIds, 0, 10);
         assertEq(permittedAppsResults.length, 1);
         assertEq(permittedAppsResults[0].pkpTokenId, PKP_TOKEN_ID_1);
-        assertEq(permittedAppsResults[0].permittedApps.length, 0); // Deleted app should not appear
+        assertEq(permittedAppsResults[0].permittedApps.length, 1); // Deleted app should still appear
+        assertEq(permittedAppsResults[0].permittedApps[0].appId, newAppId);
+        assertTrue(permittedAppsResults[0].permittedApps[0].isDeleted); // isDeleted flag should be true
+
+        // Verify permitted app version is still returned even if the app has been deleted
+        uint24 permittedAppVersion = vincentUserViewFacet.getPermittedAppVersionForPkp(PKP_TOKEN_ID_1, newAppId);
+        assertEq(permittedAppVersion, newAppVersion);
     }
 
     function test_fetchDelegatedAgentPkpTokenIds() public {

packages/libs/contracts-sdk/test/sdk.spec.ts

@@ -245,6 +245,7 @@ describe('Vincent Contracts SDK E2E', () => {
       expect(testApp).toBeDefined();
       expect(testApp!.version).toBe(TEST_CONFIG.appVersion);
       expect(testApp!.versionEnabled).toBe(true);
+      expect(testApp!.isDeleted).toBe(false);
     });
 
     it('should get all registered agent PKPs', async () => {
@@ -382,6 +383,7 @@ describe('Vincent Contracts SDK E2E', () => {
       expect(testApp).toBeDefined();
       expect(testApp!.previousPermittedVersion).toBe(TEST_CONFIG.appVersion);
       expect(testApp!.versionEnabled).toBe(true);
+      expect(testApp!.isDeleted).toBe(false);
     });
 
     it('should get last permitted app version', async () => {