@zyfai/sdk 0.1.6 → 0.1.8

package/dist/index.d.mts

@@ -54,8 +54,6 @@ interface AddSessionKeyResponse {
 }
 interface SessionKeyResponse {
     success: boolean;
-    /** Session key address (not available when alreadyActive is true) */
-    sessionKeyAddress?: Address;
     /** Signature (not available when alreadyActive is true) */
     signature?: Hex;
     sessionNonces?: bigint[];
@@ -410,10 +408,10 @@ declare class ZyfaiSDK {
     private signer;
     private walletClient;
     private bundlerApiKey?;
-    private isAuthenticated;
     private authenticatedUserId;
     private hasActiveSessionKey;
     private environment;
+    private currentProvider;
     constructor(config: SDKConfig | string);
     /**
      * Authenticate user with SIWE (Sign-In with Ethereum) & JWT token
@@ -439,6 +437,27 @@ declare class ZyfaiSDK {
      * ```
      */
     updateUserProfile(request: UpdateUserProfileRequest): Promise<UpdateUserProfileResponse>;
+    /**
+     * Initialize user after Safe deployment
+     * This method is automatically called after deploySafe to initialize user state
+     *
+     * @param smartWallet - Safe smart wallet address
+     * @param chainId - Target chain ID
+     * @returns Initialization response
+     *
+     * @example
+     * ```typescript
+     * await sdk.initializeUser("0x1396730...", 8453);
+     * ```
+     * @internal
+     */
+    private initializeUser;
+    /**
+     * Handle account changes from wallet provider
+     * Resets authentication state when wallet is switched
+     * @private
+     */
+    private handleAccountsChanged;
     /**
      * Connect account for signing transactions
      * Accepts either a private key string or a modern wallet provider
@@ -511,6 +530,14 @@ declare class ZyfaiSDK {
      * @private
      */
     private signSessionKey;
+    /**
+     * Update user protocols with available protocols from the chain
+     * This method is automatically called before activating session key
+     *
+     * @param chainId - Target chain ID
+     * @internal
+     */
+    private updateUserProtocols;
     /**
      * Activate session key via ZyFAI API
      */

package/dist/index.d.ts

@@ -54,8 +54,6 @@ interface AddSessionKeyResponse {
 }
 interface SessionKeyResponse {
     success: boolean;
-    /** Session key address (not available when alreadyActive is true) */
-    sessionKeyAddress?: Address;
     /** Signature (not available when alreadyActive is true) */
     signature?: Hex;
     sessionNonces?: bigint[];
@@ -410,10 +408,10 @@ declare class ZyfaiSDK {
     private signer;
     private walletClient;
     private bundlerApiKey?;
-    private isAuthenticated;
     private authenticatedUserId;
     private hasActiveSessionKey;
     private environment;
+    private currentProvider;
     constructor(config: SDKConfig | string);
     /**
      * Authenticate user with SIWE (Sign-In with Ethereum) & JWT token
@@ -439,6 +437,27 @@ declare class ZyfaiSDK {
      * ```
      */
     updateUserProfile(request: UpdateUserProfileRequest): Promise<UpdateUserProfileResponse>;
+    /**
+     * Initialize user after Safe deployment
+     * This method is automatically called after deploySafe to initialize user state
+     *
+     * @param smartWallet - Safe smart wallet address
+     * @param chainId - Target chain ID
+     * @returns Initialization response
+     *
+     * @example
+     * ```typescript
+     * await sdk.initializeUser("0x1396730...", 8453);
+     * ```
+     * @internal
+     */
+    private initializeUser;
+    /**
+     * Handle account changes from wallet provider
+     * Resets authentication state when wallet is switched
+     * @private
+     */
+    private handleAccountsChanged;
     /**
      * Connect account for signing transactions
      * Accepts either a private key string or a modern wallet provider
@@ -511,6 +530,14 @@ declare class ZyfaiSDK {
      * @private
      */
     private signSessionKey;
+    /**
+     * Update user protocols with available protocols from the chain
+     * This method is automatically called before activating session key
+     *
+     * @param chainId - Target chain ID
+     * @internal
+     */
+    private updateUserProtocols;
     /**
      * Activate session key via ZyFAI API
      */

package/dist/index.js

@@ -57,6 +57,7 @@ var ENDPOINTS = {
   AUTH_CHALLENGE: "/auth/challenge",
   // User
   USER_ME: "/users/me",
+  USER_INITIALIZE: "/users/initialize",
   USER_WITHDRAW: "/users/withdraw",
   PARTIAL_WITHDRAW: "/users/partial-withdraw",
   // Session Keys
@@ -620,14 +621,15 @@ var signSessionKey = async (config, sessions, allPublicClients) => {
 // src/core/ZyfaiSDK.ts
 var import_siwe = require("siwe");
 var ZyfaiSDK = class {
-  // TODO: The environment should be removed. Having the same key for staging and production is not ideal, but for now it's fine.
+  // Store reference to current provider for event handling
   constructor(config) {
     this.signer = null;
     this.walletClient = null;
-    this.isAuthenticated = false;
     this.authenticatedUserId = null;
-    // Stored from login response
+    // If non-null, user is authenticated
     this.hasActiveSessionKey = false;
+    // TODO: The environment should be removed. Having the same key for staging and production is not ideal, but for now it's fine.
+    this.currentProvider = null;
     const sdkConfig = typeof config === "string" ? { apiKey: config } : config;
     const { apiKey, dataApiKey, environment, bundlerApiKey } = sdkConfig;
     if (!apiKey) {
@@ -646,7 +648,7 @@ var ZyfaiSDK = class {
    */
   async authenticateUser() {
     try {
-      if (this.isAuthenticated) {
+      if (this.authenticatedUserId !== null) {
         return;
       }
       const walletClient = this.getWalletClient();
@@ -685,14 +687,13 @@ var ZyfaiSDK = class {
           signature
         }
       );
-      const authToken = loginResponse.accessToken || loginResponse.token;
+      const authToken = loginResponse.accessToken;
       if (!authToken) {
         throw new Error("Authentication response missing access token");
       }
       this.httpClient.setAuthToken(authToken);
       this.authenticatedUserId = loginResponse.userId || null;
       this.hasActiveSessionKey = loginResponse.hasActiveSessionKey || false;
-      this.isAuthenticated = true;
     } catch (error) {
       throw new Error(
         `Failed to authenticate user: ${error.message}`
@@ -733,6 +734,80 @@ var ZyfaiSDK = class {
       );
     }
   }
+  /**
+   * Initialize user after Safe deployment
+   * This method is automatically called after deploySafe to initialize user state
+   *
+   * @param smartWallet - Safe smart wallet address
+   * @param chainId - Target chain ID
+   * @returns Initialization response
+   *
+   * @example
+   * ```typescript
+   * await sdk.initializeUser("0x1396730...", 8453);
+   * ```
+   * @internal
+   */
+  async initializeUser(smartWallet, chainId) {
+    try {
+      await this.authenticateUser();
+      const response = await this.httpClient.post(
+        ENDPOINTS.USER_INITIALIZE,
+        {
+          smartWallet,
+          chainId
+        }
+      );
+      return {
+        success: true,
+        userId: response.userId || response.id,
+        smartWallet: response.smartWallet,
+        chainId: response.chainId,
+        message: response.message
+      };
+    } catch (error) {
+      throw new Error(
+        `Failed to initialize user: ${error.message}`
+      );
+    }
+  }
+  /**
+   * Handle account changes from wallet provider
+   * Resets authentication state when wallet is switched
+   * @private
+   */
+  async handleAccountsChanged(accounts) {
+    if (!accounts || accounts.length === 0) {
+      await this.disconnectAccount();
+      return;
+    }
+    const newAddress = accounts[0];
+    const currentAddress = this.walletClient?.account?.address;
+    if (currentAddress && newAddress.toLowerCase() === currentAddress.toLowerCase()) {
+      return;
+    }
+    this.authenticatedUserId = null;
+    this.hasActiveSessionKey = false;
+    this.httpClient.clearAuthToken();
+    if (this.walletClient && this.currentProvider) {
+      const chainConfig = getChainConfig(
+        this.walletClient.chain?.id || 42161
+      );
+      this.walletClient = (0, import_viem4.createWalletClient)({
+        account: newAddress,
+        chain: chainConfig.chain,
+        transport: (0, import_viem4.custom)(this.currentProvider)
+      });
+      try {
+        await this.authenticateUser();
+      } catch (error) {
+        console.warn(
+          "Failed to authenticate after wallet switch:",
+          error.message
+        );
+      }
+    }
+  }
   /**
    * Connect account for signing transactions
    * Accepts either a private key string or a modern wallet provider
@@ -754,8 +829,14 @@ var ZyfaiSDK = class {
     if (!isSupportedChain(chainId)) {
       throw new Error(`Unsupported chain ID: ${chainId}`);
     }
-    this.isAuthenticated = false;
+    this.authenticatedUserId = null;
     this.httpClient.clearAuthToken();
+    if (this.currentProvider?.removeAllListeners) {
+      try {
+        this.currentProvider.removeAllListeners("accountsChanged");
+      } catch (error) {
+      }
+    }
     const chainConfig = getChainConfig(chainId);
     let connectedAddress;
     if (typeof account === "string") {
@@ -770,6 +851,7 @@ var ZyfaiSDK = class {
         transport: (0, import_viem4.http)(chainConfig.rpcUrl)
       });
       connectedAddress = this.signer.address;
+      this.currentProvider = null;
     } else {
       const provider = account;
       if (!provider) {
@@ -790,6 +872,10 @@ var ZyfaiSDK = class {
           transport: (0, import_viem4.custom)(provider)
         });
         connectedAddress = accounts[0];
+        this.currentProvider = provider;
+        if (provider.on) {
+          provider.on("accountsChanged", this.handleAccountsChanged.bind(this));
+        }
       } else if (provider.account && provider.transport) {
         this.walletClient = (0, import_viem4.createWalletClient)({
           account: provider.account,
@@ -797,6 +883,7 @@ var ZyfaiSDK = class {
           transport: provider.transport
         });
         connectedAddress = provider.account.address;
+        this.currentProvider = null;
       } else {
         throw new Error(
           "Invalid wallet provider. Expected EIP-1193 provider or viem WalletClient."
@@ -817,9 +904,15 @@ var ZyfaiSDK = class {
    * ```
    */
   async disconnectAccount() {
+    if (this.currentProvider?.removeAllListeners) {
+      try {
+        this.currentProvider.removeAllListeners("accountsChanged");
+      } catch (error) {
+      }
+    }
     this.signer = null;
     this.walletClient = null;
-    this.isAuthenticated = false;
+    this.currentProvider = null;
     this.authenticatedUserId = null;
     this.hasActiveSessionKey = false;
     this.httpClient.clearAuthToken();
@@ -946,6 +1039,14 @@ var ZyfaiSDK = class {
           updateError.message
         );
       }
+      try {
+        await this.initializeUser(deploymentResult.safeAddress, chainId);
+      } catch (initError) {
+        console.warn(
+          "Failed to initialize user after Safe deployment:",
+          initError.message
+        );
+      }
       return {
         success: true,
         safeAddress: deploymentResult.safeAddress,
@@ -1006,6 +1107,7 @@ var ZyfaiSDK = class {
       if (!signatureResult.signature) {
         throw new Error("Failed to obtain session key signature");
       }
+      await this.updateUserProtocols(chainId);
       const activation = await this.activateSessionKey(
         signatureResult.signature,
         signatureResult.sessionNonces
@@ -1072,7 +1174,6 @@ var ZyfaiSDK = class {
       });
       return {
         success: true,
-        sessionKeyAddress: safeAddress,
         signature,
         sessionNonces
       };
@@ -1082,6 +1183,30 @@ var ZyfaiSDK = class {
       );
     }
   }
+  /**
+   * Update user protocols with available protocols from the chain
+   * This method is automatically called before activating session key
+   *
+   * @param chainId - Target chain ID
+   * @internal
+   */
+  async updateUserProtocols(chainId) {
+    try {
+      const protocolsResponse = await this.getAvailableProtocols(chainId);
+      if (!protocolsResponse.protocols || protocolsResponse.protocols.length === 0) {
+        console.warn(`No protocols available for chain ${chainId}`);
+        return;
+      }
+      const protocolIds = protocolsResponse.protocols.map((p) => p.id);
+      await this.updateUserProfile({
+        protocols: protocolIds
+      });
+    } catch (error) {
+      console.warn(
+        `Failed to update user protocols: ${error.message}`
+      );
+    }
+  }
   /**
    * Activate session key via ZyFAI API
    */

package/dist/index.mjs

@@ -18,6 +18,7 @@ var ENDPOINTS = {
   AUTH_CHALLENGE: "/auth/challenge",
   // User
   USER_ME: "/users/me",
+  USER_INITIALIZE: "/users/initialize",
   USER_WITHDRAW: "/users/withdraw",
   PARTIAL_WITHDRAW: "/users/partial-withdraw",
   // Session Keys
@@ -599,14 +600,15 @@ var signSessionKey = async (config, sessions, allPublicClients) => {
 // src/core/ZyfaiSDK.ts
 import { SiweMessage } from "siwe";
 var ZyfaiSDK = class {
-  // TODO: The environment should be removed. Having the same key for staging and production is not ideal, but for now it's fine.
+  // Store reference to current provider for event handling
   constructor(config) {
     this.signer = null;
     this.walletClient = null;
-    this.isAuthenticated = false;
     this.authenticatedUserId = null;
-    // Stored from login response
+    // If non-null, user is authenticated
     this.hasActiveSessionKey = false;
+    // TODO: The environment should be removed. Having the same key for staging and production is not ideal, but for now it's fine.
+    this.currentProvider = null;
     const sdkConfig = typeof config === "string" ? { apiKey: config } : config;
     const { apiKey, dataApiKey, environment, bundlerApiKey } = sdkConfig;
     if (!apiKey) {
@@ -625,7 +627,7 @@ var ZyfaiSDK = class {
    */
   async authenticateUser() {
     try {
-      if (this.isAuthenticated) {
+      if (this.authenticatedUserId !== null) {
         return;
       }
       const walletClient = this.getWalletClient();
@@ -664,14 +666,13 @@ var ZyfaiSDK = class {
           signature
         }
       );
-      const authToken = loginResponse.accessToken || loginResponse.token;
+      const authToken = loginResponse.accessToken;
       if (!authToken) {
         throw new Error("Authentication response missing access token");
       }
       this.httpClient.setAuthToken(authToken);
       this.authenticatedUserId = loginResponse.userId || null;
       this.hasActiveSessionKey = loginResponse.hasActiveSessionKey || false;
-      this.isAuthenticated = true;
     } catch (error) {
       throw new Error(
         `Failed to authenticate user: ${error.message}`
@@ -712,6 +713,80 @@ var ZyfaiSDK = class {
       );
     }
   }
+  /**
+   * Initialize user after Safe deployment
+   * This method is automatically called after deploySafe to initialize user state
+   *
+   * @param smartWallet - Safe smart wallet address
+   * @param chainId - Target chain ID
+   * @returns Initialization response
+   *
+   * @example
+   * ```typescript
+   * await sdk.initializeUser("0x1396730...", 8453);
+   * ```
+   * @internal
+   */
+  async initializeUser(smartWallet, chainId) {
+    try {
+      await this.authenticateUser();
+      const response = await this.httpClient.post(
+        ENDPOINTS.USER_INITIALIZE,
+        {
+          smartWallet,
+          chainId
+        }
+      );
+      return {
+        success: true,
+        userId: response.userId || response.id,
+        smartWallet: response.smartWallet,
+        chainId: response.chainId,
+        message: response.message
+      };
+    } catch (error) {
+      throw new Error(
+        `Failed to initialize user: ${error.message}`
+      );
+    }
+  }
+  /**
+   * Handle account changes from wallet provider
+   * Resets authentication state when wallet is switched
+   * @private
+   */
+  async handleAccountsChanged(accounts) {
+    if (!accounts || accounts.length === 0) {
+      await this.disconnectAccount();
+      return;
+    }
+    const newAddress = accounts[0];
+    const currentAddress = this.walletClient?.account?.address;
+    if (currentAddress && newAddress.toLowerCase() === currentAddress.toLowerCase()) {
+      return;
+    }
+    this.authenticatedUserId = null;
+    this.hasActiveSessionKey = false;
+    this.httpClient.clearAuthToken();
+    if (this.walletClient && this.currentProvider) {
+      const chainConfig = getChainConfig(
+        this.walletClient.chain?.id || 42161
+      );
+      this.walletClient = createWalletClient({
+        account: newAddress,
+        chain: chainConfig.chain,
+        transport: custom(this.currentProvider)
+      });
+      try {
+        await this.authenticateUser();
+      } catch (error) {
+        console.warn(
+          "Failed to authenticate after wallet switch:",
+          error.message
+        );
+      }
+    }
+  }
   /**
    * Connect account for signing transactions
    * Accepts either a private key string or a modern wallet provider
@@ -733,8 +808,14 @@ var ZyfaiSDK = class {
     if (!isSupportedChain(chainId)) {
       throw new Error(`Unsupported chain ID: ${chainId}`);
     }
-    this.isAuthenticated = false;
+    this.authenticatedUserId = null;
     this.httpClient.clearAuthToken();
+    if (this.currentProvider?.removeAllListeners) {
+      try {
+        this.currentProvider.removeAllListeners("accountsChanged");
+      } catch (error) {
+      }
+    }
     const chainConfig = getChainConfig(chainId);
     let connectedAddress;
     if (typeof account === "string") {
@@ -749,6 +830,7 @@ var ZyfaiSDK = class {
         transport: http3(chainConfig.rpcUrl)
       });
       connectedAddress = this.signer.address;
+      this.currentProvider = null;
     } else {
       const provider = account;
       if (!provider) {
@@ -769,6 +851,10 @@ var ZyfaiSDK = class {
           transport: custom(provider)
         });
         connectedAddress = accounts[0];
+        this.currentProvider = provider;
+        if (provider.on) {
+          provider.on("accountsChanged", this.handleAccountsChanged.bind(this));
+        }
       } else if (provider.account && provider.transport) {
         this.walletClient = createWalletClient({
           account: provider.account,
@@ -776,6 +862,7 @@ var ZyfaiSDK = class {
           transport: provider.transport
         });
         connectedAddress = provider.account.address;
+        this.currentProvider = null;
       } else {
         throw new Error(
           "Invalid wallet provider. Expected EIP-1193 provider or viem WalletClient."
@@ -796,9 +883,15 @@ var ZyfaiSDK = class {
    * ```
    */
   async disconnectAccount() {
+    if (this.currentProvider?.removeAllListeners) {
+      try {
+        this.currentProvider.removeAllListeners("accountsChanged");
+      } catch (error) {
+      }
+    }
     this.signer = null;
     this.walletClient = null;
-    this.isAuthenticated = false;
+    this.currentProvider = null;
     this.authenticatedUserId = null;
     this.hasActiveSessionKey = false;
     this.httpClient.clearAuthToken();
@@ -925,6 +1018,14 @@ var ZyfaiSDK = class {
           updateError.message
         );
       }
+      try {
+        await this.initializeUser(deploymentResult.safeAddress, chainId);
+      } catch (initError) {
+        console.warn(
+          "Failed to initialize user after Safe deployment:",
+          initError.message
+        );
+      }
       return {
         success: true,
         safeAddress: deploymentResult.safeAddress,
@@ -985,6 +1086,7 @@ var ZyfaiSDK = class {
       if (!signatureResult.signature) {
         throw new Error("Failed to obtain session key signature");
       }
+      await this.updateUserProtocols(chainId);
       const activation = await this.activateSessionKey(
         signatureResult.signature,
         signatureResult.sessionNonces
@@ -1051,7 +1153,6 @@ var ZyfaiSDK = class {
       });
       return {
         success: true,
-        sessionKeyAddress: safeAddress,
         signature,
         sessionNonces
       };
@@ -1061,6 +1162,30 @@ var ZyfaiSDK = class {
       );
     }
   }
+  /**
+   * Update user protocols with available protocols from the chain
+   * This method is automatically called before activating session key
+   *
+   * @param chainId - Target chain ID
+   * @internal
+   */
+  async updateUserProtocols(chainId) {
+    try {
+      const protocolsResponse = await this.getAvailableProtocols(chainId);
+      if (!protocolsResponse.protocols || protocolsResponse.protocols.length === 0) {
+        console.warn(`No protocols available for chain ${chainId}`);
+        return;
+      }
+      const protocolIds = protocolsResponse.protocols.map((p) => p.id);
+      await this.updateUserProfile({
+        protocols: protocolIds
+      });
+    } catch (error) {
+      console.warn(
+        `Failed to update user protocols: ${error.message}`
+      );
+    }
+  }
   /**
    * Activate session key via ZyFAI API
    */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zyfai/sdk",
-  "version": "0.1.6",
+  "version": "0.1.8",
   "description": "TypeScript SDK for ZyFAI Yield Optimization Engine - Deploy Safe smart wallets, manage session keys, and interact with DeFi protocols",
   "main": "dist/index.js",
   "module": "dist/index.mjs",
@@ -28,7 +28,13 @@
     "dev": "tsup src/index.ts --format cjs,esm --dts --watch",
     "lint": "eslint src --ext .ts",
     "test": "jest",
-    "prepublishOnly": "npm run build"
+    "prepublishOnly": "npm run build",
+    "docs": "typedoc",
+    "docs:watch": "typedoc --watch",
+    "docs:json": "typedoc --json docs/api.json",
+    "docs:dev": "cd website && pnpm start",
+    "docs:build": "pnpm docs && cd website && pnpm build",
+    "docs:serve": "cd website && pnpm serve"
   },
   "keywords": [
     "zyfai",
@@ -70,6 +76,8 @@
     "@types/node": "^20.0.0",
     "dotenv": "^17.2.3",
     "tsup": "^8.0.0",
+    "typedoc": "^0.28.15",
+    "typedoc-plugin-markdown": "^4.9.0",
     "typescript": "^5.3.0"
   },
   "peerDependencies": {