@0xsequence/connect 5.0.8 → 5.1.0

package/dist/esm/hooks/useWaasConfirmationHandler.d.ts

@@ -6,5 +6,44 @@ export type WaasRequestConfirmation = {
     txs?: commons.transaction.Transaction[];
     chainId?: number;
 };
+/**
+ * Hook to handle transaction and message signing confirmations for WaaS (Wallet-as-a-Service) connections.
+ *
+ * This hook sets up confirmation handlers for signing transactions and messages when using a WaaS connector.
+ * It manages the state of pending confirmations and provides functions to confirm or reject signing requests.
+ *
+ * @param waasConnector - The WaaS connector instance to handle confirmations for (optional)
+ *
+ * @returns A tuple containing:
+ * - [0] {@link WaasRequestConfirmation} | undefined - The current pending request confirmation info or undefined if none
+ * - [1] `(id: string) => void` - Function to confirm a pending request by ID
+ * - [2] `(id: string) => void` - Function to reject a pending request by ID
+ *
+ * The {@link WaasRequestConfirmation} object contains:
+ * - `id` - Unique identifier for the request
+ * - `type` - Either 'signTransaction' or 'signMessage'
+ * - `message?` - Optional message to sign (for signMessage requests)
+ * - `txs?` - Optional array of transactions (for signTransaction requests)
+ * - `chainId?` - Optional chain ID for the request
+ *
+ * @example
+ * ```tsx
+ * const [
+ *   pendingRequestConfirmation,
+ *   confirmPendingRequest,
+ *   rejectPendingRequest
+ * ] = useWaasConfirmationHandler(waasConnector)
+ *
+ * // When user confirms the request
+ * if (pendingRequestConfirmation) {
+ *   confirmPendingRequest(pendingRequestConfirmation.id)
+ * }
+ *
+ * // When user rejects the request
+ * if (pendingRequestConfirmation) {
+ *   rejectPendingRequest(pendingRequestConfirmation.id)
+ * }
+ * ```
+ */
 export declare function useWaasConfirmationHandler(waasConnector?: any): [WaasRequestConfirmation | undefined, (id: string) => void, (id: string) => void];
 //# sourceMappingURL=useWaasConfirmationHandler.d.ts.map

package/dist/esm/hooks/useWaasConfirmationHandler.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useWaasConfirmationHandler.d.ts","sourceRoot":"","sources":["../../../src/hooks/useWaasConfirmationHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAO1C,MAAM,MAAM,uBAAuB,GAAG;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,iBAAiB,GAAG,aAAa,CAAA;IACvC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,CAAA;IACvC,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED,wBAAgB,0BAA0B,CACxC,aAAa,CAAC,EAAE,GAAG,GAClB,CAAC,uBAAuB,GAAG,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC,CAkDnF"}
+{"version":3,"file":"useWaasConfirmationHandler.d.ts","sourceRoot":"","sources":["../../../src/hooks/useWaasConfirmationHandler.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,kBAAkB,CAAA;AAO1C,MAAM,MAAM,uBAAuB,GAAG;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,iBAAiB,GAAG,aAAa,CAAA;IACvC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,GAAG,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,WAAW,EAAE,CAAA;IACvC,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,wBAAgB,0BAA0B,CACxC,aAAa,CAAC,EAAE,GAAG,GAClB,CAAC,uBAAuB,GAAG,SAAS,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAC,CAkDnF"}

package/dist/esm/hooks/useWaasConfirmationHandler.js

@@ -1,6 +1,45 @@
 import { useState, useEffect } from 'react';
 import { Deferred } from '../utils/deferred';
 let _pendingConfirmation;
+/**
+ * Hook to handle transaction and message signing confirmations for WaaS (Wallet-as-a-Service) connections.
+ *
+ * This hook sets up confirmation handlers for signing transactions and messages when using a WaaS connector.
+ * It manages the state of pending confirmations and provides functions to confirm or reject signing requests.
+ *
+ * @param waasConnector - The WaaS connector instance to handle confirmations for (optional)
+ *
+ * @returns A tuple containing:
+ * - [0] {@link WaasRequestConfirmation} | undefined - The current pending request confirmation info or undefined if none
+ * - [1] `(id: string) => void` - Function to confirm a pending request by ID
+ * - [2] `(id: string) => void` - Function to reject a pending request by ID
+ *
+ * The {@link WaasRequestConfirmation} object contains:
+ * - `id` - Unique identifier for the request
+ * - `type` - Either 'signTransaction' or 'signMessage'
+ * - `message?` - Optional message to sign (for signMessage requests)
+ * - `txs?` - Optional array of transactions (for signTransaction requests)
+ * - `chainId?` - Optional chain ID for the request
+ *
+ * @example
+ * ```tsx
+ * const [
+ *   pendingRequestConfirmation,
+ *   confirmPendingRequest,
+ *   rejectPendingRequest
+ * ] = useWaasConfirmationHandler(waasConnector)
+ *
+ * // When user confirms the request
+ * if (pendingRequestConfirmation) {
+ *   confirmPendingRequest(pendingRequestConfirmation.id)
+ * }
+ *
+ * // When user rejects the request
+ * if (pendingRequestConfirmation) {
+ *   rejectPendingRequest(pendingRequestConfirmation.id)
+ * }
+ * ```
+ */
 export function useWaasConfirmationHandler(waasConnector) {
     const [pendingRequestConfirmation, setPendingRequestConfirmation] = useState();
     function confirmPendingRequest(id) {

package/dist/esm/hooks/useWaasConfirmationHandler.js.map

@@ -1 +1 @@
-{"version":3,"file":"useWaasConfirmationHandler.js","sourceRoot":"","sources":["../../../src/hooks/useWaasConfirmationHandler.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAE3C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAE5C,IAAI,oBAA8E,CAAA;AAUlF,MAAM,UAAU,0BAA0B,CACxC,aAAmB;IAEnB,MAAM,CAAC,0BAA0B,EAAE,6BAA6B,CAAC,GAAG,QAAQ,EAAuC,CAAA;IAEnH,SAAS,qBAAqB,CAAC,EAAU;QACvC,oBAAoB,EAAE,OAAO,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QACtD,6BAA6B,CAAC,SAAS,CAAC,CAAA;QACxC,oBAAoB,GAAG,SAAS,CAAA;IAClC,CAAC;IAED,SAAS,oBAAoB,CAAC,EAAU;QACtC,oBAAoB,EAAE,OAAO,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAA;QACvD,6BAA6B,CAAC,SAAS,CAAC,CAAA;QACxC,oBAAoB,GAAG,SAAS,CAAA;IAClC,CAAC;IAED,SAAS,CAAC,GAAG,EAAE;QACb,KAAK,UAAU,KAAK;YAClB,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,OAAM;YACR,CAAC;YAED,MAAM,YAAY,GAAG,aAAa,CAAC,oBAAoB,CAAA;YAEvD,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,OAAM;YACR,CAAC;YAED,YAAY,CAAC,0BAA0B,GAAG;gBACxC,6BAA6B,CAC3B,EAAU,EACV,GAAsC,EACtC,OAAe;oBAEf,MAAM,OAAO,GAAG,IAAI,QAAQ,EAAsC,CAAA;oBAClE,6BAA6B,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;oBAC9G,oBAAoB,GAAG,OAAO,CAAA;oBAC9B,OAAO,OAAO,CAAC,OAAO,CAAA;gBACxB,CAAC;gBACD,yBAAyB,CAAC,EAAU,EAAE,OAAe,EAAE,OAAe;oBACpE,MAAM,OAAO,GAAG,IAAI,QAAQ,EAAsC,CAAA;oBAClE,6BAA6B,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAA;oBAC5E,oBAAoB,GAAG,OAAO,CAAA;oBAC9B,OAAO,OAAO,CAAC,OAAO,CAAA;gBACxB,CAAC;aACF,CAAA;QACH,CAAC;QACD,KAAK,EAAE,CAAA;IACT,CAAC,CAAC,CAAA;IAEF,OAAO,CAAC,0BAA0B,EAAE,qBAAqB,EAAE,oBAAoB,CAAC,CAAA;AAClF,CAAC"}
+{"version":3,"file":"useWaasConfirmationHandler.js","sourceRoot":"","sources":["../../../src/hooks/useWaasConfirmationHandler.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAE3C,OAAO,EAAE,QAAQ,EAAE,MAAM,mBAAmB,CAAA;AAE5C,IAAI,oBAA8E,CAAA;AAUlF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAsCG;AACH,MAAM,UAAU,0BAA0B,CACxC,aAAmB;IAEnB,MAAM,CAAC,0BAA0B,EAAE,6BAA6B,CAAC,GAAG,QAAQ,EAAuC,CAAA;IAEnH,SAAS,qBAAqB,CAAC,EAAU;QACvC,oBAAoB,EAAE,OAAO,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAA;QACtD,6BAA6B,CAAC,SAAS,CAAC,CAAA;QACxC,oBAAoB,GAAG,SAAS,CAAA;IAClC,CAAC;IAED,SAAS,oBAAoB,CAAC,EAAU;QACtC,oBAAoB,EAAE,OAAO,CAAC,EAAE,EAAE,EAAE,SAAS,EAAE,KAAK,EAAE,CAAC,CAAA;QACvD,6BAA6B,CAAC,SAAS,CAAC,CAAA;QACxC,oBAAoB,GAAG,SAAS,CAAA;IAClC,CAAC;IAED,SAAS,CAAC,GAAG,EAAE;QACb,KAAK,UAAU,KAAK;YAClB,IAAI,CAAC,aAAa,EAAE,CAAC;gBACnB,OAAM;YACR,CAAC;YAED,MAAM,YAAY,GAAG,aAAa,CAAC,oBAAoB,CAAA;YAEvD,IAAI,CAAC,YAAY,EAAE,CAAC;gBAClB,OAAM;YACR,CAAC;YAED,YAAY,CAAC,0BAA0B,GAAG;gBACxC,6BAA6B,CAC3B,EAAU,EACV,GAAsC,EACtC,OAAe;oBAEf,MAAM,OAAO,GAAG,IAAI,QAAQ,EAAsC,CAAA;oBAClE,6BAA6B,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,iBAAiB,EAAE,GAAG,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,EAAE,OAAO,EAAE,CAAC,CAAA;oBAC9G,oBAAoB,GAAG,OAAO,CAAA;oBAC9B,OAAO,OAAO,CAAC,OAAO,CAAA;gBACxB,CAAC;gBACD,yBAAyB,CAAC,EAAU,EAAE,OAAe,EAAE,OAAe;oBACpE,MAAM,OAAO,GAAG,IAAI,QAAQ,EAAsC,CAAA;oBAClE,6BAA6B,CAAC,EAAE,EAAE,EAAE,IAAI,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,CAAA;oBAC5E,oBAAoB,GAAG,OAAO,CAAA;oBAC9B,OAAO,OAAO,CAAC,OAAO,CAAA;gBACxB,CAAC;aACF,CAAA;QACH,CAAC;QACD,KAAK,EAAE,CAAA;IACT,CAAC,CAAC,CAAA;IAEF,OAAO,CAAC,0BAA0B,EAAE,qBAAqB,EAAE,oBAAoB,CAAC,CAAA;AAClF,CAAC"}

package/dist/esm/hooks/useWaasEmailAuth.d.ts

@@ -8,6 +8,52 @@ interface SuccessResultV2 {
     version: 2;
     signInResponse: SignInResponse;
 }
+/**
+ * Hook to handle email-based authentication flow for WaaS (Wallet-as-a-Service).
+ *
+ * This hook manages the complete email authentication process, including:
+ * - Initiating email authentication
+ * - Handling verification code submission
+ * - Managing loading and error states
+ * - Supporting both v1 (idToken) and v2 (SignInResponse) authentication formats
+ *
+ * @param {ExtendedConnector} [params.connector] - The WaaS connector to use for authentication.
+ *        Optional because the user might not have selected a connector yet.
+ * @param {Function} params.onSuccess - Callback function called when authentication succeeds.
+ *        Receives either a v1 result (with idToken) or v2 result (with SignInResponse).
+ *
+ * @returns {Object} An object containing:
+ * - `inProgress` - Whether authentication is currently in progress
+ * - `loading` - Whether a specific authentication operation is loading
+ * - `error` - Any error that occurred during authentication
+ * - `initiateAuth` - Function to start the email authentication process
+ * - `sendChallengeAnswer` - Function to submit the verification code
+ * - `cancel` - Function to cancel the authentication process
+ * - `resetError` - Function to clear any error state
+ *
+ * @example
+ * ```tsx
+ * const {
+ *   inProgress,
+ *   loading,
+ *   error,
+ *   initiateAuth,
+ *   sendChallengeAnswer,
+ *   resetError
+ * } = useEmailAuth({
+ *   connector: emailConnector,
+ *   onSuccess: async (result) => {
+ *     if ('signInResponse' in result) {
+ *       // Handle v2 authentication
+ *       await storage.setItem('email', result.signInResponse.email)
+ *     } else {
+ *       // Handle v1 authentication
+ *       await storage.setItem('idToken', result.idToken)
+ *     }
+ *   }
+ * })
+ * ```
+ */
 export declare function useEmailAuth({ connector, onSuccess }: {
     connector?: ExtendedConnector;
     onSuccess: (result: SuccessResultV1 | SuccessResultV2) => void;

package/dist/esm/hooks/useWaasEmailAuth.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useWaasEmailAuth.d.ts","sourceRoot":"","sources":["../../../src/hooks/useWaasEmailAuth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAK/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAE5C,UAAU,eAAe;IACvB,OAAO,EAAE,CAAC,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,UAAU,eAAe;IACvB,OAAO,EAAE,CAAC,CAAA;IACV,cAAc,EAAE,cAAc,CAAA;CAC/B;AAED,wBAAgB,YAAY,CAAC,EAC3B,SAAS,EACT,SAAS,EACV,EAAE;IACD,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAC7B,SAAS,EAAE,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,KAAK,IAAI,CAAA;CAC/D;;;;2BAYkC,MAAM;mCACE,MAAM;;;;;;;0BAmBZ,MAAM;kCA2BE,MAAM;;;EAwClD"}
+{"version":3,"file":"useWaasEmailAuth.d.ts","sourceRoot":"","sources":["../../../src/hooks/useWaasEmailAuth.ts"],"names":[],"mappings":"AAAA,OAAO,EAAgB,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAK/D,OAAO,EAAE,iBAAiB,EAAE,MAAM,UAAU,CAAA;AAE5C,UAAU,eAAe;IACvB,OAAO,EAAE,CAAC,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;CAChB;AAED,UAAU,eAAe;IACvB,OAAO,EAAE,CAAC,CAAA;IACV,cAAc,EAAE,cAAc,CAAA;CAC/B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,wBAAgB,YAAY,CAAC,EAC3B,SAAS,EACT,SAAS,EACV,EAAE;IACD,SAAS,CAAC,EAAE,iBAAiB,CAAA;IAC7B,SAAS,EAAE,CAAC,MAAM,EAAE,eAAe,GAAG,eAAe,KAAK,IAAI,CAAA;CAC/D;;;;2BAYkC,MAAM;mCACE,MAAM;;;;;;;0BAmBZ,MAAM;kCA2BE,MAAM;;;EAwClD"}

package/dist/esm/hooks/useWaasEmailAuth.js

@@ -1,6 +1,52 @@
 import { useState } from 'react';
 // import { EmailWaasOptions } from '../connectors/email/emailWaas'
 import { randomName } from '../connectors/wagmiConnectors';
+/**
+ * Hook to handle email-based authentication flow for WaaS (Wallet-as-a-Service).
+ *
+ * This hook manages the complete email authentication process, including:
+ * - Initiating email authentication
+ * - Handling verification code submission
+ * - Managing loading and error states
+ * - Supporting both v1 (idToken) and v2 (SignInResponse) authentication formats
+ *
+ * @param {ExtendedConnector} [params.connector] - The WaaS connector to use for authentication.
+ *        Optional because the user might not have selected a connector yet.
+ * @param {Function} params.onSuccess - Callback function called when authentication succeeds.
+ *        Receives either a v1 result (with idToken) or v2 result (with SignInResponse).
+ *
+ * @returns {Object} An object containing:
+ * - `inProgress` - Whether authentication is currently in progress
+ * - `loading` - Whether a specific authentication operation is loading
+ * - `error` - Any error that occurred during authentication
+ * - `initiateAuth` - Function to start the email authentication process
+ * - `sendChallengeAnswer` - Function to submit the verification code
+ * - `cancel` - Function to cancel the authentication process
+ * - `resetError` - Function to clear any error state
+ *
+ * @example
+ * ```tsx
+ * const {
+ *   inProgress,
+ *   loading,
+ *   error,
+ *   initiateAuth,
+ *   sendChallengeAnswer,
+ *   resetError
+ * } = useEmailAuth({
+ *   connector: emailConnector,
+ *   onSuccess: async (result) => {
+ *     if ('signInResponse' in result) {
+ *       // Handle v2 authentication
+ *       await storage.setItem('email', result.signInResponse.email)
+ *     } else {
+ *       // Handle v1 authentication
+ *       await storage.setItem('idToken', result.idToken)
+ *     }
+ *   }
+ * })
+ * ```
+ */
 export function useEmailAuth({ connector, onSuccess }) {
     const [_email, setEmail] = useState('');
     const [error, setError] = useState();

package/dist/esm/hooks/useWaasEmailAuth.js.map

@@ -1 +1 @@
-{"version":3,"file":"useWaasEmailAuth.js","sourceRoot":"","sources":["../../../src/hooks/useWaasEmailAuth.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AAEhC,mEAAmE;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAA;AAa1D,MAAM,UAAU,YAAY,CAAC,EAC3B,SAAS,EACT,SAAS,EAIV;IACC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAA;IACvC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,EAAqB,CAAA;IACvD,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC7C,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAA;IAC7C,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,QAAQ,EAA4C,CAAA;IAElG,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO;YACL,UAAU,EAAE,KAAK;YACjB,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,SAAS;YAChB,YAAY,EAAE,KAAK,EAAE,MAAc,EAAE,EAAE,GAAE,CAAC;YAC1C,mBAAmB,EAAE,KAAK,EAAE,OAAe,EAAE,EAAE,GAAE,CAAC;YAClD,UAAU,EAAE,GAAG,EAAE,GAAE,CAAC;SACrB,CAAA;IACH,CAAC;IAED,MAAM,eAAe,GAAG,GAAG,EAAE;QAC3B,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAC7C,CAAC;QAED,MAAM,YAAY,GAA8B,SAAiB,CAAC,YAAY,CAAA;QAE9E,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;QAC5D,CAAC;QAED,OAAO,YAAY,CAAA;IACrB,CAAC,CAAA;IAED,MAAM,YAAY,GAAG,KAAK,EAAE,KAAa,EAAE,EAAE;QAC3C,+DAA+D;QAC/D,MAAM,IAAI,GAAG,eAAe,EAAE,CAAA;QAE9B,UAAU,CAAC,IAAI,CAAC,CAAA;QAChB,QAAQ,CAAC,SAAS,CAAC,CAAA;QAEnB,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAC,eAAe,EAAC,EAAE;YACnD,kBAAkB,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC,CAAA;QAC3C,CAAC,CAAC,CAAA;QAEF,IAAI;aACD,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,CAAC;aAC/B,IAAI,CAAC,cAAc,CAAC,EAAE;YACrB,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,cAAc,EAAE,CAAC,CAAA;YAEzC,IAAI,cAAc,CAAC,KAAK,EAAE,CAAC;gBACzB,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;YAChC,CAAC;QACH,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,CAAC,EAAE;YACX,QAAQ,CAAC,GAAG,CAAC,CAAA;QACf,CAAC,CAAC,CAAA;QAEJ,UAAU,CAAC,KAAK,CAAC,CAAA;IACnB,CAAC,CAAA;IAED,MAAM,mBAAmB,GAAG,KAAK,EAAE,MAAc,EAAE,EAAE;QACnD,+DAA+D;QAC/D,iCAAiC;QAEjC,UAAU,CAAC,IAAI,CAAC,CAAA;QAChB,QAAQ,CAAC,SAAS,CAAC,CAAA;QAEnB,YAAY;QACZ,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;QAClE,CAAC;QAED,IAAI,CAAC;YACH,MAAM,eAAe,CAAC,MAAM,CAAC,CAAA;QAC/B,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,QAAQ,CAAC,GAAG,CAAC,CAAA;QACf,CAAC;gBAAS,CAAC;YACT,UAAU,CAAC,KAAK,CAAC,CAAA;QACnB,CAAC;IACH,CAAC,CAAA;IAED,MAAM,MAAM,GAAG,GAAG,EAAE;QAClB,UAAU,CAAC,KAAK,CAAC,CAAA;QACjB,kBAAkB,CAAC,IAAI,CAAC,CAAA;QACxB,QAAQ,CAAC,SAAS,CAAC,CAAA;IACrB,CAAC,CAAA;IAED,MAAM,UAAU,GAAG,GAAG,EAAE;QACtB,QAAQ,CAAC,SAAS,CAAC,CAAA;IACrB,CAAC,CAAA;IAED,OAAO;QACL,UAAU,EAAE,OAAO,IAAI,CAAC,CAAC,QAAQ;QACjC,OAAO;QACP,KAAK;QACL,YAAY;QACZ,mBAAmB;QACnB,MAAM;QACN,UAAU;KACX,CAAA;AACH,CAAC"}
+{"version":3,"file":"useWaasEmailAuth.js","sourceRoot":"","sources":["../../../src/hooks/useWaasEmailAuth.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AAEhC,mEAAmE;AACnE,OAAO,EAAE,UAAU,EAAE,MAAM,+BAA+B,CAAA;AAa1D;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6CG;AACH,MAAM,UAAU,YAAY,CAAC,EAC3B,SAAS,EACT,SAAS,EAIV;IACC,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAA;IACvC,MAAM,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,QAAQ,EAAqB,CAAA;IACvD,MAAM,CAAC,OAAO,EAAE,UAAU,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC7C,MAAM,CAAC,QAAQ,EAAE,YAAY,CAAC,GAAG,QAAQ,CAAC,EAAE,CAAC,CAAA;IAC7C,MAAM,CAAC,eAAe,EAAE,kBAAkB,CAAC,GAAG,QAAQ,EAA4C,CAAA;IAElG,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO;YACL,UAAU,EAAE,KAAK;YACjB,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,SAAS;YAChB,YAAY,EAAE,KAAK,EAAE,MAAc,EAAE,EAAE,GAAE,CAAC;YAC1C,mBAAmB,EAAE,KAAK,EAAE,OAAe,EAAE,EAAE,GAAE,CAAC;YAClD,UAAU,EAAE,GAAG,EAAE,GAAE,CAAC;SACrB,CAAA;IACH,CAAC;IAED,MAAM,eAAe,GAAG,GAAG,EAAE;QAC3B,IAAI,CAAC,SAAS,EAAE,CAAC;YACf,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAA;QAC7C,CAAC;QAED,MAAM,YAAY,GAA8B,SAAiB,CAAC,YAAY,CAAA;QAE9E,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,MAAM,IAAI,KAAK,CAAC,yCAAyC,CAAC,CAAA;QAC5D,CAAC;QAED,OAAO,YAAY,CAAA;IACrB,CAAC,CAAA;IAED,MAAM,YAAY,GAAG,KAAK,EAAE,KAAa,EAAE,EAAE;QAC3C,+DAA+D;QAC/D,MAAM,IAAI,GAAG,eAAe,EAAE,CAAA;QAE9B,UAAU,CAAC,IAAI,CAAC,CAAA;QAChB,QAAQ,CAAC,SAAS,CAAC,CAAA;QAEnB,IAAI,CAAC,uBAAuB,CAAC,KAAK,EAAC,eAAe,EAAC,EAAE;YACnD,kBAAkB,CAAC,GAAG,EAAE,CAAC,eAAe,CAAC,CAAA;QAC3C,CAAC,CAAC,CAAA;QAEF,IAAI;aACD,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,UAAU,EAAE,CAAC;aAC/B,IAAI,CAAC,cAAc,CAAC,EAAE;YACrB,SAAS,CAAC,EAAE,OAAO,EAAE,CAAC,EAAE,cAAc,EAAE,CAAC,CAAA;YAEzC,IAAI,cAAc,CAAC,KAAK,EAAE,CAAC;gBACzB,QAAQ,CAAC,cAAc,CAAC,KAAK,CAAC,CAAA;YAChC,CAAC;QACH,CAAC,CAAC;aACD,KAAK,CAAC,GAAG,CAAC,EAAE;YACX,QAAQ,CAAC,GAAG,CAAC,CAAA;QACf,CAAC,CAAC,CAAA;QAEJ,UAAU,CAAC,KAAK,CAAC,CAAA;IACnB,CAAC,CAAA;IAED,MAAM,mBAAmB,GAAG,KAAK,EAAE,MAAc,EAAE,EAAE;QACnD,+DAA+D;QAC/D,iCAAiC;QAEjC,UAAU,CAAC,IAAI,CAAC,CAAA;QAChB,QAAQ,CAAC,SAAS,CAAC,CAAA;QAEnB,YAAY;QACZ,IAAI,CAAC,eAAe,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;QAClE,CAAC;QAED,IAAI,CAAC;YACH,MAAM,eAAe,CAAC,MAAM,CAAC,CAAA;QAC/B,CAAC;QAAC,OAAO,GAAQ,EAAE,CAAC;YAClB,QAAQ,CAAC,GAAG,CAAC,CAAA;QACf,CAAC;gBAAS,CAAC;YACT,UAAU,CAAC,KAAK,CAAC,CAAA;QACnB,CAAC;IACH,CAAC,CAAA;IAED,MAAM,MAAM,GAAG,GAAG,EAAE;QAClB,UAAU,CAAC,KAAK,CAAC,CAAA;QACjB,kBAAkB,CAAC,IAAI,CAAC,CAAA;QACxB,QAAQ,CAAC,SAAS,CAAC,CAAA;IACrB,CAAC,CAAA;IAED,MAAM,UAAU,GAAG,GAAG,EAAE;QACtB,QAAQ,CAAC,SAAS,CAAC,CAAA;IACrB,CAAC,CAAA;IAED,OAAO;QACL,UAAU,EAAE,OAAO,IAAI,CAAC,CAAC,QAAQ;QACjC,OAAO;QACP,KAAK;QACL,YAAY;QACZ,mBAAmB;QACnB,MAAM;QACN,UAAU;KACX,CAAA;AACH,CAAC"}

package/dist/esm/hooks/useWaasEmailConflict.d.ts

@@ -1,7 +1,46 @@
+/**
+ * Represents formatted email conflict information returned by the hook.
+ * This is a user-friendly version of the EmailConflictInfo from the WaaS service.
+ */
 export type FormattedEmailConflictInfo = {
+    /** The email address that caused the conflict */
     email: string;
+    /** User-friendly description of the account type (e.g., 'Google login', 'Email login') */
     type: string;
 };
+/**
+ * Hook to handle email conflict detection and resolution for WaaS (Wallet-as-a-Service) authentication.
+ *
+ * This hook monitors all WaaS connectors for email conflicts that occur during sign-in attempts.
+ * A conflict happens when a user tries to sign up with an email that's already associated with
+ * a different authentication method (e.g., trying to use Google sign-in when the email was
+ * previously used with Apple sign-in).
+ *
+ * @returns An object containing:
+ * - `toggleEmailConflictModal` - Function to manually show/hide the conflict modal
+ * - `isEmailConflictOpen` - Whether the conflict modal is currently open
+ * - `emailConflictInfo` - Formatted information about the conflict (email and account type)
+ * - `forceCreate` - Function to force create a new account despite the conflict
+ *
+ * @example
+ * ```tsx
+ * const {
+ *   isEmailConflictOpen,
+ *   emailConflictInfo,
+ *   toggleEmailConflictModal
+ * } = useEmailConflict()
+ *
+ * // When a conflict is detected
+ * if (isEmailConflictOpen && emailConflictInfo) {
+ *   console.log(
+ *     `Email ${emailConflictInfo.email} is already used with ${emailConflictInfo.type}`
+ *   )
+ * }
+ *
+ * // Close the conflict modal
+ * toggleEmailConflictModal(false)
+ * ```
+ */
 export declare const useEmailConflict: () => {
     toggleEmailConflictModal: import("react").Dispatch<import("react").SetStateAction<boolean>>;
     isEmailConflictOpen: boolean;

package/dist/esm/hooks/useWaasEmailConflict.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useWaasEmailConflict.d.ts","sourceRoot":"","sources":["../../../src/hooks/useWaasEmailConflict.ts"],"names":[],"mappings":"AAIA,MAAM,MAAM,0BAA0B,GAAG;IACvC,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AA6BD,eAAO,MAAM,gBAAgB;;;uBAiCpB,0BAA0B;;CAKlC,CAAA"}
+{"version":3,"file":"useWaasEmailConflict.d.ts","sourceRoot":"","sources":["../../../src/hooks/useWaasEmailConflict.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,iDAAiD;IACjD,KAAK,EAAE,MAAM,CAAA;IACb,0FAA0F;IAC1F,IAAI,EAAE,MAAM,CAAA;CACb,CAAA;AAmCD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,eAAO,MAAM,gBAAgB;;;uBAiCpB,0BAA0B;;CAKlC,CAAA"}

package/dist/esm/hooks/useWaasEmailConflict.js

@@ -1,6 +1,12 @@
 import { IdentityType } from '@0xsequence/waas';
 import { useEffect, useRef, useState } from 'react';
 import { useConnect } from 'wagmi';
+/**
+ * Helper function to convert raw account type information into user-friendly text.
+ *
+ * @param info - The raw email conflict information from WaaS
+ * @returns A user-friendly string describing the account type
+ */
 const accountTypeText = (info) => {
     if (!info) {
         return 'Unknown account type';
@@ -23,6 +29,39 @@ const accountTypeText = (info) => {
     }
     return info.type;
 };
+/**
+ * Hook to handle email conflict detection and resolution for WaaS (Wallet-as-a-Service) authentication.
+ *
+ * This hook monitors all WaaS connectors for email conflicts that occur during sign-in attempts.
+ * A conflict happens when a user tries to sign up with an email that's already associated with
+ * a different authentication method (e.g., trying to use Google sign-in when the email was
+ * previously used with Apple sign-in).
+ *
+ * @returns An object containing:
+ * - `toggleEmailConflictModal` - Function to manually show/hide the conflict modal
+ * - `isEmailConflictOpen` - Whether the conflict modal is currently open
+ * - `emailConflictInfo` - Formatted information about the conflict (email and account type)
+ * - `forceCreate` - Function to force create a new account despite the conflict
+ *
+ * @example
+ * ```tsx
+ * const {
+ *   isEmailConflictOpen,
+ *   emailConflictInfo,
+ *   toggleEmailConflictModal
+ * } = useEmailConflict()
+ *
+ * // When a conflict is detected
+ * if (isEmailConflictOpen && emailConflictInfo) {
+ *   console.log(
+ *     `Email ${emailConflictInfo.email} is already used with ${emailConflictInfo.type}`
+ *   )
+ * }
+ *
+ * // Close the conflict modal
+ * toggleEmailConflictModal(false)
+ * ```
+ */
 export const useEmailConflict = () => {
     const { connectors } = useConnect();
     const forceCreateFuncRef = useRef(null);

package/dist/esm/hooks/useWaasEmailConflict.js.map

@@ -1 +1 @@
-{"version":3,"file":"useWaasEmailConflict.js","sourceRoot":"","sources":["../../../src/hooks/useWaasEmailConflict.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAmC,MAAM,kBAAkB,CAAA;AAChF,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AAOlC,MAAM,eAAe,GAAG,CAAC,IAA8B,EAAE,EAAE;IACzD,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,sBAAsB,CAAA;IAC/B,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,CAAC,OAAO,EAAE,CAAC;QACvC,OAAO,eAAe,CAAA;IACxB,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,CAAC,KAAK,EAAE,CAAC;QACrC,OAAO,aAAa,CAAA;IACtB,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI,EAAE,CAAC;QACpC,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC;YACpB,KAAK,6BAA6B;gBAChC,OAAO,cAAc,CAAA;YACvB,KAAK,2BAA2B;gBAC9B,OAAO,aAAa,CAAA;YACtB;gBACE,OAAO,sBAAsB,CAAA;QACjC,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAA;AAClB,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,EAAE;IACnC,MAAM,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,CAAA;IACnC,MAAM,kBAAkB,GAAG,MAAM,CAAmD,IAAI,CAAC,CAAA;IACzF,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC7C,MAAM,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,GAAG,QAAQ,CAA2B,IAAI,CAAC,CAAA;IAE1F,MAAM,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAE,SAAiB,CAAC,YAAY,CAAC,CAAA;IACxF,MAAM,aAAa,GAAG,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAE,SAAiB,CAAC,YAA4B,CAAC,CAAA;IAEtG,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,0CAA0C;YAC1C,MAAM,SAAS,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CACzC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE;gBAC/C,kBAAkB,CAAC,OAAO,GAAG,WAAW,CAAA;gBACxC,oBAAoB,CAAC,IAAI,CAAC,CAAA;gBAC1B,WAAW,CAAC,IAAI,CAAC,CAAA;YACnB,CAAC,CAAC,CACH,CAAA;YAED,sDAAsD;YACtD,OAAO,GAAG,EAAE;gBACV,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;YAC3C,CAAC,CAAA;QACH,CAAC;IACH,CAAC,EAAE,EAAE,CAAC,CAAA;IAEN,OAAO;QACL,wBAAwB,EAAE,WAAW;QACrC,mBAAmB,EAAE,MAAM;QAC3B,iBAAiB,EAAE;YACjB,KAAK,EAAE,iBAAiB,EAAE,KAAK,IAAI,SAAS;YAC5C,IAAI,EAAE,eAAe,CAAC,iBAAiB,CAAC;SACX;QAC/B,WAAW,EAAE,KAAK,IAAI,EAAE;YACtB,OAAO,kBAAkB,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAA;QAC3C,CAAC;KACF,CAAA;AACH,CAAC,CAAA"}
+{"version":3,"file":"useWaasEmailConflict.js","sourceRoot":"","sources":["../../../src/hooks/useWaasEmailConflict.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAmC,MAAM,kBAAkB,CAAA;AAChF,OAAO,EAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAA;AACnD,OAAO,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AAalC;;;;;GAKG;AACH,MAAM,eAAe,GAAG,CAAC,IAA8B,EAAE,EAAE;IACzD,IAAI,CAAC,IAAI,EAAE,CAAC;QACV,OAAO,sBAAsB,CAAA;IAC/B,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,CAAC,OAAO,EAAE,CAAC;QACvC,OAAO,eAAe,CAAA;IACxB,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,CAAC,KAAK,EAAE,CAAC;QACrC,OAAO,aAAa,CAAA;IACtB,CAAC;IAED,IAAI,IAAI,CAAC,IAAI,KAAK,YAAY,CAAC,IAAI,EAAE,CAAC;QACpC,QAAQ,IAAI,CAAC,MAAM,EAAE,CAAC;YACpB,KAAK,6BAA6B;gBAChC,OAAO,cAAc,CAAA;YACvB,KAAK,2BAA2B;gBAC9B,OAAO,aAAa,CAAA;YACtB;gBACE,OAAO,sBAAsB,CAAA;QACjC,CAAC;IACH,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAA;AAClB,CAAC,CAAA;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAgCG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,GAAG,EAAE;IACnC,MAAM,EAAE,UAAU,EAAE,GAAG,UAAU,EAAE,CAAA;IACnC,MAAM,kBAAkB,GAAG,MAAM,CAAmD,IAAI,CAAC,CAAA;IACzF,MAAM,CAAC,MAAM,EAAE,WAAW,CAAC,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAA;IAC7C,MAAM,CAAC,iBAAiB,EAAE,oBAAoB,CAAC,GAAG,QAAQ,CAA2B,IAAI,CAAC,CAAA;IAE1F,MAAM,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAE,SAAiB,CAAC,YAAY,CAAC,CAAA;IACxF,MAAM,aAAa,GAAG,cAAc,CAAC,GAAG,CAAC,SAAS,CAAC,EAAE,CAAE,SAAiB,CAAC,YAA4B,CAAC,CAAA;IAEtG,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,aAAa,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC7B,0CAA0C;YAC1C,MAAM,SAAS,GAAG,aAAa,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,CACzC,IAAI,CAAC,eAAe,CAAC,KAAK,EAAE,IAAI,EAAE,WAAW,EAAE,EAAE;gBAC/C,kBAAkB,CAAC,OAAO,GAAG,WAAW,CAAA;gBACxC,oBAAoB,CAAC,IAAI,CAAC,CAAA;gBAC1B,WAAW,CAAC,IAAI,CAAC,CAAA;YACnB,CAAC,CAAC,CACH,CAAA;YAED,sDAAsD;YACtD,OAAO,GAAG,EAAE;gBACV,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,QAAQ,EAAE,CAAC,CAAA;YAC3C,CAAC,CAAA;QACH,CAAC;IACH,CAAC,EAAE,EAAE,CAAC,CAAA;IAEN,OAAO;QACL,wBAAwB,EAAE,WAAW;QACrC,mBAAmB,EAAE,MAAM;QAC3B,iBAAiB,EAAE;YACjB,KAAK,EAAE,iBAAiB,EAAE,KAAK,IAAI,SAAS;YAC5C,IAAI,EAAE,eAAe,CAAC,iBAAiB,CAAC;SACX;QAC/B,WAAW,EAAE,KAAK,IAAI,EAAE;YACtB,OAAO,kBAAkB,CAAC,OAAO,EAAE,CAAC,IAAI,CAAC,CAAA;QAC3C,CAAC;KACF,CAAA;AACH,CAAC,CAAA"}

package/dist/esm/hooks/useWaasGetLinkedWalletsSignature.d.ts

@@ -1,13 +1,73 @@
 import { Address } from 'viem';
 import { Connector } from 'wagmi';
+/**
+ * Result object returned by the useWaasGetLinkedWalletsSignature hook.
+ * Contains all necessary information about the signature for wallet linking.
+ */
 interface UseWaasSignatureForLinkingResult {
+    /** The message that was signed */
     message: string | undefined;
+    /** The signature of the message */
     signature: string | undefined;
+    /** The address that signed the message */
     address: string | undefined;
+    /** The chain ID used for signing */
     chainId: number;
+    /** Whether the signature is currently being generated */
     loading: boolean;
+    /** Any error that occurred during signature generation */
     error: Error | null;
 }
+/**
+ * Hook to manage signatures required for linking wallets in a WaaS (Wallet-as-a-Service) context.
+ *
+ * This hook handles the generation and caching of signatures that are used to prove ownership
+ * of a parent wallet when linking child wallets. The signatures are cached in localStorage
+ * for 24 hours to avoid unnecessary re-signing.
+ *
+ * Features:
+ * - Automatic signature generation when needed
+ * - 24-hour signature caching in localStorage
+ * - Automatic cleanup of old signatures
+ * - Error handling for signature generation
+ *
+ * @param connection - The current wallet connection object containing:
+ *   - accounts: Array of connected addresses (uses the first one)
+ *   - chainId: The current chain ID
+ *   - connector: The wallet connector instance
+ *
+ * @returns An object containing:
+ * - `message` - The message that was signed
+ * - `signature` - The generated signature
+ * - `address` - The address that signed the message
+ * - `chainId` - The chain ID used for signing
+ * - `loading` - Whether signature generation is in progress
+ * - `error` - Any error that occurred during the process
+ *
+ * @example
+ * ```tsx
+ * const {
+ *   message,
+ *   signature,
+ *   address,
+ *   loading,
+ *   error
+ * } = useWaasGetLinkedWalletsSignature(waasConnection)
+ *
+ * if (loading) {
+ *   return <div>Generating signature...</div>
+ * }
+ *
+ * if (error) {
+ *   return <div>Error: {error.message}</div>
+ * }
+ *
+ * if (signature) {
+ *   // Use the signature for wallet linking
+ *   console.log(`Got signature from ${address} for message: ${message}`)
+ * }
+ * ```
+ */
 export declare const useWaasGetLinkedWalletsSignature: (connection: {
     accounts: readonly [Address, ...Address[]];
     chainId: number;

package/dist/esm/hooks/useWaasGetLinkedWalletsSignature.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useWaasGetLinkedWalletsSignature.d.ts","sourceRoot":"","sources":["../../../src/hooks/useWaasGetLinkedWalletsSignature.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAIjC,UAAU,gCAAgC;IACxC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,OAAO,EAAE,MAAM,CAAA;IACf,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;CACpB;AAKD,eAAO,MAAM,gCAAgC,GAC3C,YACI;IACE,QAAQ,EAAE,SAAS,CAAC,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,CAAA;IAC1C,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,SAAS,CAAA;CACrB,GACD,SAAS,KACZ,gCAwIF,CAAA"}
+{"version":3,"file":"useWaasGetLinkedWalletsSignature.d.ts","sourceRoot":"","sources":["../../../src/hooks/useWaasGetLinkedWalletsSignature.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAC9B,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAIjC;;;GAGG;AACH,UAAU,gCAAgC;IACxC,kCAAkC;IAClC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,mCAAmC;IACnC,SAAS,EAAE,MAAM,GAAG,SAAS,CAAA;IAC7B,0CAA0C;IAC1C,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,oCAAoC;IACpC,OAAO,EAAE,MAAM,CAAA;IACf,yDAAyD;IACzD,OAAO,EAAE,OAAO,CAAA;IAChB,0DAA0D;IAC1D,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;CACpB;AAKD;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,eAAO,MAAM,gCAAgC,GAC3C,YACI;IACE,QAAQ,EAAE,SAAS,CAAC,OAAO,EAAE,GAAG,OAAO,EAAE,CAAC,CAAA;IAC1C,OAAO,EAAE,MAAM,CAAA;IACf,SAAS,EAAE,SAAS,CAAA;CACrB,GACD,SAAS,KACZ,gCAwIF,CAAA"}

package/dist/esm/hooks/useWaasGetLinkedWalletsSignature.js

@@ -3,6 +3,56 @@ import { useState, useEffect } from 'react';
 import { CHAIN_ID_FOR_SIGNATURE } from '../constants/walletLinking';
 const WAAS_SIGNATURE_PREFIX = '@0xsequence.waas_signature-';
 const getSignatureKey = (address) => `${WAAS_SIGNATURE_PREFIX}${address}`;
+/**
+ * Hook to manage signatures required for linking wallets in a WaaS (Wallet-as-a-Service) context.
+ *
+ * This hook handles the generation and caching of signatures that are used to prove ownership
+ * of a parent wallet when linking child wallets. The signatures are cached in localStorage
+ * for 24 hours to avoid unnecessary re-signing.
+ *
+ * Features:
+ * - Automatic signature generation when needed
+ * - 24-hour signature caching in localStorage
+ * - Automatic cleanup of old signatures
+ * - Error handling for signature generation
+ *
+ * @param connection - The current wallet connection object containing:
+ *   - accounts: Array of connected addresses (uses the first one)
+ *   - chainId: The current chain ID
+ *   - connector: The wallet connector instance
+ *
+ * @returns An object containing:
+ * - `message` - The message that was signed
+ * - `signature` - The generated signature
+ * - `address` - The address that signed the message
+ * - `chainId` - The chain ID used for signing
+ * - `loading` - Whether signature generation is in progress
+ * - `error` - Any error that occurred during the process
+ *
+ * @example
+ * ```tsx
+ * const {
+ *   message,
+ *   signature,
+ *   address,
+ *   loading,
+ *   error
+ * } = useWaasGetLinkedWalletsSignature(waasConnection)
+ *
+ * if (loading) {
+ *   return <div>Generating signature...</div>
+ * }
+ *
+ * if (error) {
+ *   return <div>Error: {error.message}</div>
+ * }
+ *
+ * if (signature) {
+ *   // Use the signature for wallet linking
+ *   console.log(`Got signature from ${address} for message: ${message}`)
+ * }
+ * ```
+ */
 export const useWaasGetLinkedWalletsSignature = (connection) => {
     const sequenceWaas = connection?.connector?.sequenceWaas;
     const address = connection?.accounts[0];

package/dist/esm/hooks/useWaasGetLinkedWalletsSignature.js.map

@@ -1 +1 @@
-{"version":3,"file":"useWaasGetLinkedWalletsSignature.js","sourceRoot":"","sources":["../../../src/hooks/useWaasGetLinkedWalletsSignature.ts"],"names":[],"mappings":"AAAA,YAAY,CAAA;AAGZ,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAI3C,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AAWnE,MAAM,qBAAqB,GAAG,6BAA6B,CAAA;AAC3D,MAAM,eAAe,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,GAAG,qBAAqB,GAAG,OAAO,EAAE,CAAA;AAEjF,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAC9C,UAMa,EACqB,EAAE;IACpC,MAAM,YAAY,GAA8B,UAAkB,EAAE,SAAS,EAAE,YAAY,CAAA;IAC3F,MAAM,OAAO,GAAG,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAA;IAEvC,yDAAyD;IACzD,MAAM,YAAY,GAAG,GAAqC,EAAE;QAC1D,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;YAC7D,IAAI,MAAM,EAAE,CAAC;gBACX,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;oBACjC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,CAAC,CAAA;oBACvC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAA;oBAClC,MAAM,OAAO,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA,CAAC,2BAA2B;oBAE/D,IAAI,GAAG,GAAG,OAAO,EAAE,CAAC;wBAClB,OAAO;4BACL,OAAO,EAAE,MAAM,CAAC,OAAO;4BACvB,SAAS,EAAE,MAAM,CAAC,SAAS;4BAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;4BACvB,OAAO,EAAE,sBAAsB;4BAC/B,OAAO,EAAE,KAAK;4BACd,KAAK,EAAE,IAAI;yBACZ,CAAA;oBACH,CAAC;oBACD,YAAY,CAAC,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;gBACnD,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,YAAY,CAAC,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;gBACnD,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO;YACL,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,SAAS;YACpB,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,sBAAsB;YAC/B,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,IAAI;SACZ,CAAA;IACH,CAAC,CAAA;IAED,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAmC,YAAY,CAAC,CAAA;IAEpF,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAM;QACR,CAAC;QACD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAM;QACR,CAAC;QAED,2CAA2C;QAC3C,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC;aACtB,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,qBAAqB,CAAC,IAAI,GAAG,KAAK,eAAe,CAAC,OAAO,CAAC,CAAC;aACxF,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAA;QAE/C,kDAAkD;QAClD,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;QAC7D,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;gBACjC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,CAAC,CAAA;gBACvC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAA;gBAClC,MAAM,OAAO,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA,CAAC,2BAA2B;gBAE/D,IAAI,GAAG,GAAG,OAAO,EAAE,CAAC;oBAClB,SAAS,CAAC;wBACR,OAAO,EAAE,MAAM,CAAC,OAAO;wBACvB,SAAS,EAAE,MAAM,CAAC,SAAS;wBAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;wBACvB,OAAO,EAAE,sBAAsB;wBAC/B,OAAO,EAAE,KAAK;wBACd,KAAK,EAAE,IAAI;qBACZ,CAAC,CAAA;oBACF,OAAM;gBACR,CAAC;qBAAM,CAAC;oBACN,YAAY,CAAC,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;gBACnD,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,YAAY,CAAC,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;YACnD,CAAC;QACH,CAAC;QAED,uDAAuD;QACvD,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;YAC9B,IAAI,CAAC;gBACH,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;gBAE5D,MAAM,OAAO,GAAG,8BAA8B,OAAO,EAAE,CAAA;gBACvD,MAAM,aAAa,GAAG,MAAM,YAAY,EAAE,WAAW,CAAC;oBACpD,OAAO;oBACP,OAAO,EAAE,sBAAsB;iBAChC,CAAC,CAAA;gBAEF,IAAI,CAAC,aAAa,EAAE,CAAC;oBACnB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;gBAC3C,CAAC;gBAED,MAAM,SAAS,GAAG;oBAChB,OAAO;oBACP,SAAS,EAAE,aAAa,CAAC,IAAI,CAAC,SAAS;oBACvC,OAAO;oBACP,OAAO,EAAE,sBAAsB;oBAC/B,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,IAAI;iBACZ,CAAA;gBAED,qDAAqD;gBACrD,YAAY,CAAC,OAAO,CAClB,eAAe,CAAC,OAAO,CAAC,EACxB,IAAI,CAAC,SAAS,CAAC;oBACb,OAAO;oBACP,SAAS,EAAE,aAAa,CAAC,IAAI,CAAC,SAAS;oBACvC,OAAO;oBACP,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;iBACtB,CAAC,CACH,CAAA;gBAED,SAAS,CAAC,SAAS,CAAC,CAAA;YACtB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,SAAS,CAAC;oBACR,OAAO,EAAE,SAAS;oBAClB,SAAS,EAAE,SAAS;oBACpB,OAAO,EAAE,SAAS;oBAClB,OAAO,EAAE,sBAAsB;oBAC/B,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,KAAc;iBACtB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC,CAAA;QAED,YAAY,EAAE,CAAA;IAChB,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAA,CAAC,uCAAuC;IAErD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA"}
+{"version":3,"file":"useWaasGetLinkedWalletsSignature.js","sourceRoot":"","sources":["../../../src/hooks/useWaasGetLinkedWalletsSignature.ts"],"names":[],"mappings":"AAAA,YAAY,CAAA;AAGZ,OAAO,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAI3C,OAAO,EAAE,sBAAsB,EAAE,MAAM,4BAA4B,CAAA;AAqBnE,MAAM,qBAAqB,GAAG,6BAA6B,CAAA;AAC3D,MAAM,eAAe,GAAG,CAAC,OAAe,EAAE,EAAE,CAAC,GAAG,qBAAqB,GAAG,OAAO,EAAE,CAAA;AAEjF;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAiDG;AACH,MAAM,CAAC,MAAM,gCAAgC,GAAG,CAC9C,UAMa,EACqB,EAAE;IACpC,MAAM,YAAY,GAA8B,UAAkB,EAAE,SAAS,EAAE,YAAY,CAAA;IAC3F,MAAM,OAAO,GAAG,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAA;IAEvC,yDAAyD;IACzD,MAAM,YAAY,GAAG,GAAqC,EAAE;QAC1D,IAAI,OAAO,EAAE,CAAC;YACZ,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;YAC7D,IAAI,MAAM,EAAE,CAAC;gBACX,IAAI,CAAC;oBACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;oBACjC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,CAAC,CAAA;oBACvC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAA;oBAClC,MAAM,OAAO,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA,CAAC,2BAA2B;oBAE/D,IAAI,GAAG,GAAG,OAAO,EAAE,CAAC;wBAClB,OAAO;4BACL,OAAO,EAAE,MAAM,CAAC,OAAO;4BACvB,SAAS,EAAE,MAAM,CAAC,SAAS;4BAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;4BACvB,OAAO,EAAE,sBAAsB;4BAC/B,OAAO,EAAE,KAAK;4BACd,KAAK,EAAE,IAAI;yBACZ,CAAA;oBACH,CAAC;oBACD,YAAY,CAAC,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;gBACnD,CAAC;gBAAC,OAAO,CAAC,EAAE,CAAC;oBACX,YAAY,CAAC,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;gBACnD,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO;YACL,OAAO,EAAE,SAAS;YAClB,SAAS,EAAE,SAAS;YACpB,OAAO,EAAE,OAAO;YAChB,OAAO,EAAE,sBAAsB;YAC/B,OAAO,EAAE,KAAK;YACd,KAAK,EAAE,IAAI;SACZ,CAAA;IACH,CAAC,CAAA;IAED,MAAM,CAAC,MAAM,EAAE,SAAS,CAAC,GAAG,QAAQ,CAAmC,YAAY,CAAC,CAAA;IAEpF,SAAS,CAAC,GAAG,EAAE;QACb,IAAI,CAAC,YAAY,EAAE,CAAC;YAClB,OAAM;QACR,CAAC;QACD,IAAI,CAAC,OAAO,EAAE,CAAC;YACb,OAAM;QACR,CAAC;QAED,2CAA2C;QAC3C,MAAM,CAAC,IAAI,CAAC,YAAY,CAAC;aACtB,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,CAAC,UAAU,CAAC,qBAAqB,CAAC,IAAI,GAAG,KAAK,eAAe,CAAC,OAAO,CAAC,CAAC;aACxF,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,YAAY,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAA;QAE/C,kDAAkD;QAClD,MAAM,MAAM,GAAG,YAAY,CAAC,OAAO,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;QAC7D,IAAI,MAAM,EAAE,CAAC;YACX,IAAI,CAAC;gBACH,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAA;gBACjC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,IAAI,CAAC,CAAA;gBACvC,MAAM,GAAG,GAAG,IAAI,CAAC,GAAG,EAAE,GAAG,SAAS,CAAA;gBAClC,MAAM,OAAO,GAAG,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAA,CAAC,2BAA2B;gBAE/D,IAAI,GAAG,GAAG,OAAO,EAAE,CAAC;oBAClB,SAAS,CAAC;wBACR,OAAO,EAAE,MAAM,CAAC,OAAO;wBACvB,SAAS,EAAE,MAAM,CAAC,SAAS;wBAC3B,OAAO,EAAE,MAAM,CAAC,OAAO;wBACvB,OAAO,EAAE,sBAAsB;wBAC/B,OAAO,EAAE,KAAK;wBACd,KAAK,EAAE,IAAI;qBACZ,CAAC,CAAA;oBACF,OAAM;gBACR,CAAC;qBAAM,CAAC;oBACN,YAAY,CAAC,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;gBACnD,CAAC;YACH,CAAC;YAAC,OAAO,CAAC,EAAE,CAAC;gBACX,YAAY,CAAC,UAAU,CAAC,eAAe,CAAC,OAAO,CAAC,CAAC,CAAA;YACnD,CAAC;QACH,CAAC;QAED,uDAAuD;QACvD,MAAM,YAAY,GAAG,KAAK,IAAI,EAAE;YAC9B,IAAI,CAAC;gBACH,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,EAAE,GAAG,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAA;gBAE5D,MAAM,OAAO,GAAG,8BAA8B,OAAO,EAAE,CAAA;gBACvD,MAAM,aAAa,GAAG,MAAM,YAAY,EAAE,WAAW,CAAC;oBACpD,OAAO;oBACP,OAAO,EAAE,sBAAsB;iBAChC,CAAC,CAAA;gBAEF,IAAI,CAAC,aAAa,EAAE,CAAC;oBACnB,MAAM,IAAI,KAAK,CAAC,wBAAwB,CAAC,CAAA;gBAC3C,CAAC;gBAED,MAAM,SAAS,GAAG;oBAChB,OAAO;oBACP,SAAS,EAAE,aAAa,CAAC,IAAI,CAAC,SAAS;oBACvC,OAAO;oBACP,OAAO,EAAE,sBAAsB;oBAC/B,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,IAAI;iBACZ,CAAA;gBAED,qDAAqD;gBACrD,YAAY,CAAC,OAAO,CAClB,eAAe,CAAC,OAAO,CAAC,EACxB,IAAI,CAAC,SAAS,CAAC;oBACb,OAAO;oBACP,SAAS,EAAE,aAAa,CAAC,IAAI,CAAC,SAAS;oBACvC,OAAO;oBACP,SAAS,EAAE,IAAI,CAAC,GAAG,EAAE;iBACtB,CAAC,CACH,CAAA;gBAED,SAAS,CAAC,SAAS,CAAC,CAAA;YACtB,CAAC;YAAC,OAAO,KAAK,EAAE,CAAC;gBACf,SAAS,CAAC;oBACR,OAAO,EAAE,SAAS;oBAClB,SAAS,EAAE,SAAS;oBACpB,OAAO,EAAE,SAAS;oBAClB,OAAO,EAAE,sBAAsB;oBAC/B,OAAO,EAAE,KAAK;oBACd,KAAK,EAAE,KAAc;iBACtB,CAAC,CAAA;YACJ,CAAC;QACH,CAAC,CAAA;QAED,YAAY,EAAE,CAAA;IAChB,CAAC,EAAE,CAAC,OAAO,CAAC,CAAC,CAAA,CAAC,uCAAuC;IAErD,OAAO,MAAM,CAAA;AACf,CAAC,CAAA"}

package/dist/esm/hooks/useWaasLinkWallet.d.ts

@@ -1,17 +1,74 @@
 import { Connector } from 'wagmi';
+/**
+ * Parameters required for linking a child wallet to a parent WaaS wallet.
+ */
 interface LinkWalletParams {
+    /** Chain ID used for the signature verification */
     signatureChainId: number;
+    /** Name of the connector used by the child wallet */
     connectorName: string;
+    /** Address of the child wallet to be linked */
     childWalletAddress: string;
+    /** Message signed by the child wallet */
     childMessage: string;
+    /** Signature from the child wallet */
     childSignature: string;
 }
+/**
+ * Result object returned by the useWaasLinkWallet hook.
+ */
 interface UseWaasLinkWalletResult {
+    /** Function to link a child wallet to the parent WaaS wallet */
     linkWallet: (params: LinkWalletParams) => Promise<void>;
+    /** Function to remove a previously linked wallet */
     removeLinkedWallet: (linkedWalletAddress: string) => Promise<void>;
+    /** Whether a linking or unlinking operation is in progress */
     loading: boolean;
+    /** Any error that occurred during the operation */
     error: Error | null;
 }
+/**
+ * Hook to manage wallet linking operations for WaaS (Wallet-as-a-Service).
+ *
+ * This hook provides functionality to link and unlink child wallets to/from a parent WaaS wallet.
+ * It handles the signature generation and API calls required for the linking process.
+ *
+ * The linking process involves:
+ * 1. Getting the parent WaaS wallet address
+ * 2. Signing a message with the parent wallet
+ * 3. Submitting both parent and child signatures to the API
+ *
+ * The unlinking process involves:
+ * 1. Getting the parent WaaS wallet address
+ * 2. Signing a removal message
+ * 3. Submitting the request to the API
+ *
+ * @param connector - The WaaS connector instance. Optional because the user might not have
+ *                   a WaaS wallet connected yet.
+ *
+ * @returns An object containing:
+ * - `linkWallet` - Function to link a child wallet
+ * - `removeLinkedWallet` - Function to remove a linked wallet
+ * - `loading` - Whether an operation is in progress
+ * - `error` - Any error that occurred
+ *
+ * @example
+ * ```tsx
+ * const { linkWallet, removeLinkedWallet, loading, error } = useWaasLinkWallet(waasConnector)
+ *
+ * // Link a wallet
+ * await linkWallet({
+ *   signatureChainId: CHAIN_ID_FOR_SIGNATURE,
+ *   connectorName: 'MetaMask',
+ *   childWalletAddress: '0x...',
+ *   childMessage: 'Link to parent wallet...',
+ *   childSignature: '0x...'
+ * })
+ *
+ * // Remove a linked wallet
+ * await removeLinkedWallet('0x...')
+ * ```
+ */
 export declare const useWaasLinkWallet: (connector: Connector | undefined) => UseWaasLinkWalletResult;
 export {};
 //# sourceMappingURL=useWaasLinkWallet.d.ts.map

package/dist/esm/hooks/useWaasLinkWallet.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"useWaasLinkWallet.d.ts","sourceRoot":"","sources":["../../../src/hooks/useWaasLinkWallet.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAIjC,UAAU,gBAAgB;IACxB,gBAAgB,EAAE,MAAM,CAAA;IACxB,aAAa,EAAE,MAAM,CAAA;IACrB,kBAAkB,EAAE,MAAM,CAAA;IAC1B,YAAY,EAAE,MAAM,CAAA;IACpB,cAAc,EAAE,MAAM,CAAA;CACvB;AAED,UAAU,uBAAuB;IAC/B,UAAU,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACvD,kBAAkB,EAAE,CAAC,mBAAmB,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAClE,OAAO,EAAE,OAAO,CAAA;IAChB,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;CACpB;AAED,eAAO,MAAM,iBAAiB,GAAI,WAAW,SAAS,GAAG,SAAS,KAAG,uBA4FpE,CAAA"}
+{"version":3,"file":"useWaasLinkWallet.d.ts","sourceRoot":"","sources":["../../../src/hooks/useWaasLinkWallet.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,SAAS,EAAE,MAAM,OAAO,CAAA;AAIjC;;GAEG;AACH,UAAU,gBAAgB;IACxB,mDAAmD;IACnD,gBAAgB,EAAE,MAAM,CAAA;IACxB,qDAAqD;IACrD,aAAa,EAAE,MAAM,CAAA;IACrB,+CAA+C;IAC/C,kBAAkB,EAAE,MAAM,CAAA;IAC1B,yCAAyC;IACzC,YAAY,EAAE,MAAM,CAAA;IACpB,sCAAsC;IACtC,cAAc,EAAE,MAAM,CAAA;CACvB;AAED;;GAEG;AACH,UAAU,uBAAuB;IAC/B,gEAAgE;IAChE,UAAU,EAAE,CAAC,MAAM,EAAE,gBAAgB,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IACvD,oDAAoD;IACpD,kBAAkB,EAAE,CAAC,mBAAmB,EAAE,MAAM,KAAK,OAAO,CAAC,IAAI,CAAC,CAAA;IAClE,8DAA8D;IAC9D,OAAO,EAAE,OAAO,CAAA;IAChB,mDAAmD;IACnD,KAAK,EAAE,KAAK,GAAG,IAAI,CAAA;CACpB;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyCG;AACH,eAAO,MAAM,iBAAiB,GAAI,WAAW,SAAS,GAAG,SAAS,KAAG,uBA4FpE,CAAA"}

package/dist/esm/hooks/useWaasLinkWallet.js

@@ -2,6 +2,48 @@
 import { useAPIClient } from '@0xsequence/hooks';
 import { useState } from 'react';
 import { CHAIN_ID_FOR_SIGNATURE } from '../constants/walletLinking';
+/**
+ * Hook to manage wallet linking operations for WaaS (Wallet-as-a-Service).
+ *
+ * This hook provides functionality to link and unlink child wallets to/from a parent WaaS wallet.
+ * It handles the signature generation and API calls required for the linking process.
+ *
+ * The linking process involves:
+ * 1. Getting the parent WaaS wallet address
+ * 2. Signing a message with the parent wallet
+ * 3. Submitting both parent and child signatures to the API
+ *
+ * The unlinking process involves:
+ * 1. Getting the parent WaaS wallet address
+ * 2. Signing a removal message
+ * 3. Submitting the request to the API
+ *
+ * @param connector - The WaaS connector instance. Optional because the user might not have
+ *                   a WaaS wallet connected yet.
+ *
+ * @returns An object containing:
+ * - `linkWallet` - Function to link a child wallet
+ * - `removeLinkedWallet` - Function to remove a linked wallet
+ * - `loading` - Whether an operation is in progress
+ * - `error` - Any error that occurred
+ *
+ * @example
+ * ```tsx
+ * const { linkWallet, removeLinkedWallet, loading, error } = useWaasLinkWallet(waasConnector)
+ *
+ * // Link a wallet
+ * await linkWallet({
+ *   signatureChainId: CHAIN_ID_FOR_SIGNATURE,
+ *   connectorName: 'MetaMask',
+ *   childWalletAddress: '0x...',
+ *   childMessage: 'Link to parent wallet...',
+ *   childSignature: '0x...'
+ * })
+ *
+ * // Remove a linked wallet
+ * await removeLinkedWallet('0x...')
+ * ```
+ */
 export const useWaasLinkWallet = (connector) => {
     const [loading, setLoading] = useState(false);
     const [error, setError] = useState(null);