refactor(auth, e2e):

- Update type definitions to replace deprecated PKPInfo with PKPData across auth and e2e packages.
- Modify Jest configuration to match all spec files in e2e tests.
- Add .e2e to .gitignore for better file management.
- Enhance e2e package structure with new types and utility functions for improved clarity and maintainability.

Author: Ansonhkg

.gitignore

@@ -90,4 +90,8 @@ lit-cache
 lit-auth-local
 artillery-state.json
 artillery-pkp-tokens
-lit-auth-artillery
+lit-auth-artillery
+alice-auth-manager-data
+
+.plans
+.e2e

jest.e2e.config.ts

@@ -21,7 +21,7 @@ const localPackages = [
 
 const config: Config = {
   testEnvironment: 'node',
-  testMatch: ['<rootDir>/packages/e2e/src/e2e.spec.ts'],
+  testMatch: ['<rootDir>/packages/e2e/src/**/*.spec.ts'],
 
   // Use Babel for everything; simple and robust with TS + ESM
   transform: {

packages/auth/src/index.ts

@@ -13,7 +13,7 @@ import { ViemAccountAuthenticator } from './lib/authenticators/ViemAccountAuthen
 import { WalletClientAuthenticator } from './lib/authenticators/WalletClientAuthenticator';
 // import { GetAuthContext } from './lib/AuthManager/getAuthContext';
 import { localStorage, localStorageNode } from './lib/storage';
-import type { LitAuthStorageProvider, PKPInfo } from './lib/storage/types';
+import type { LitAuthStorageProvider } from './lib/storage/types';
 import type { LitAuthData } from './lib/types';
 
 // -- exports
@@ -24,11 +24,6 @@ export { JsonSignSessionKeyRequestForPkpReturnSchema } from '@lit-protocol/schem
  */
 export type { LitAuthStorageProvider };
 
-/**
- * Type definition for PKP information used for caching
- */
-export type { PKPInfo };
-
 /**
  * Type definition for the structure of authentication data used within the Lit Auth client.
  */

packages/auth/src/lib/storage/localStorage.ts

@@ -1,6 +1,7 @@
-import type { LitAuthStorageProvider, PKPInfo } from './types';
+import type { LitAuthStorageProvider } from './types';
 import type { LitAuthData } from '../types';
 import { getGlobal } from '@lit-protocol/constants';
+import { PKPData } from '@lit-protocol/schemas';
 
 const LOCALSTORAGE_LIT_AUTH_PREFIX = 'lit-auth';
 const LOCALSTORAGE_LIT_PKP_PREFIX = 'lit-pkp-tokens';
@@ -309,7 +310,7 @@ export function localStorage({
     async readPKPs({
       authMethodType,
       authMethodId,
-    }): Promise<PKPInfo[] | null> {
+    }): Promise<PKPData[] | null> {
       const cacheKey = buildPKPFullCacheKey({
         appName,
         networkName,

packages/auth/src/lib/storage/localStorageNode.ts

@@ -14,8 +14,9 @@
  * // Use nodeStorage.write(...) and nodeStorage.read(...)
  */
 
+import { PKPData } from '@lit-protocol/schemas';
 import type { LitAuthData } from '../types';
-import type { LitAuthStorageProvider, PKPInfo } from './types';
+import type { LitAuthStorageProvider } from './types';
 
 const LOCALSTORAGE_LIT_AUTH_PREFIX = 'lit-auth';
 const LOCALSTORAGE_LIT_PKP_PREFIX = 'lit-pkp-tokens';
@@ -223,7 +224,7 @@ export function localStorageNode({
       async readPKPs({
         authMethodType,
         authMethodId,
-      }): Promise<PKPInfo[] | null> {
+      }): Promise<PKPData[] | null> {
         console.warn('localStorageNode (stub): readPKPs called in browser.');
         return null;
       },
@@ -442,7 +443,7 @@ export function localStorageNode({
     async readPKPs({
       authMethodType,
       authMethodId,
-    }): Promise<PKPInfo[] | null> {
+    }): Promise<PKPData[] | null> {
       const store = await getMemoisedStorageInstance();
       const cacheKey = buildPKPFullCacheKey({
         appName,

packages/auth/src/lib/storage/types.ts

@@ -1,14 +1,6 @@
+import { PKPData } from '@lit-protocol/schemas';
 import type { LitAuthData } from '../types';
 
-/**
- * @deprecated Use the PKPInfo type from @lit-protocol/types instead
- */
-export interface PKPInfo {
-  tokenId: string;
-  publicKey: string;
-  ethAddress: string;
-}
-
 export interface LitAuthStorageProvider {
   config: unknown;
 
@@ -92,7 +84,7 @@ export interface LitAuthStorageProvider {
   writePKPs?(params: {
     authMethodType: number | bigint;
     authMethodId: string;
-    pkps: PKPInfo[];
+    pkps: PKPData[];
   }): Promise<void>;
 
   /**
@@ -102,5 +94,5 @@ export interface LitAuthStorageProvider {
   readPKPs?(params: {
     authMethodType: number | bigint;
     authMethodId: string;
-  }): Promise<PKPInfo[] | null>;
+  }): Promise<PKPData[] | null>;
 }

packages/e2e/package.json

@@ -4,6 +4,8 @@
   "description": "Lit Protocol E2E testing package for running comprehensive integration tests",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
+  "type": "module",
+  "types": "dist/index.d.ts",
   "exports": {
     ".": {
       "import": "./dist/index.mjs",

packages/e2e/src/demo/add-permitted-address-demo.ts renamed to packages/e2e/src/guides/add-permitted-address-guide.ts

@@ -10,7 +10,7 @@ export const createPkpAuthContext = async (
   try {
     const pkpAuthContext = await ctx.authManager.createPkpAuthContext({
       authData: ctx.aliceViemAccountAuthData,
-      pkpPublicKey: ctx.aliceViemAccountPkp.publicKey,
+      pkpPublicKey: ctx.aliceViemAccountPkp.pubkey,
       authConfig: {
         resources: [
           ['pkp-signing', '*'],

packages/e2e/src/helper/auth-contexts.ts

@@ -1,16 +1,6 @@
-/**
- * PKP Utilities
- *
- * This module provides utility functions for managing Programmable Key Pairs (PKPs)
- * in the Lit Protocol ecosystem. It handles the common pattern of checking for
- * existing PKPs and creating new ones when necessary.
- *
- * Usage:
- *   import { getOrCreatePkp } from './helper/pkp-utils';
- *   const pkp = await getOrCreatePkp(litClient, authData, account, storagePath, networkName);
- */
-
-import { storagePlugins } from '@lit-protocol/auth';
+import type { AuthData, PKPData } from '@lit-protocol/schemas';
+import type { PrivateKeyAccount } from 'viem/accounts';
+import { LitClientInstance } from '../types';
 
 // Configuration constants
 const PAGINATION_LIMIT = 5;
@@ -28,23 +18,16 @@ const PKP_SCOPES = ['sign-anything'];
  * @returns Promise<PKP> - The existing or newly created PKP
  */
 export const getOrCreatePkp = async (
-  litClient: any,
-  authData: any,
-  account: any,
-  storagePath: string,
-  networkName: string
-) => {
+  litClient: LitClientInstance,
+  authData: AuthData,
+  account: PrivateKeyAccount
+): Promise<PKPData> => {
   // Check for existing PKPs
   const { pkps } = await litClient.viewPKPsByAuthData({
     authData,
     pagination: {
       limit: PAGINATION_LIMIT,
     },
-    storageProvider: storagePlugins.localStorageNode({
-      appName: APP_NAME,
-      networkName,
-      storagePath,
-    }),
   });
 
   // If PKP exists, return it
@@ -53,23 +36,22 @@ export const getOrCreatePkp = async (
   }
 
   // Otherwise mint new PKP
-  const mintResult = await litClient.mintWithAuth({
-    authData,
-    account,
-    scopes: PKP_SCOPES,
-  });
+  try {
+    await litClient.mintWithAuth({
+      authData,
+      account,
+      scopes: PKP_SCOPES,
+    });
+  } catch (e) {
+    throw new Error(`❌ Error minting PKP: ${e}`);
+  }
 
   // Query again to get the newly minted PKP in the expected format
   const { pkps: newPkps } = await litClient.viewPKPsByAuthData({
     authData,
     pagination: {
       limit: PAGINATION_LIMIT,
     },
-    storageProvider: storagePlugins.localStorageNode({
-      appName: APP_NAME,
-      networkName,
-      storagePath,
-    }),
   });
 
   return newPkps[0];