@supanovaapp/sdk 0.2.14 → 0.2.16

package/README.md

@@ -9,6 +9,7 @@ For a quick overview of the code, check out the demo application in the `/demo`
 ## Key Features
 
 - **Privy.io Authentication** - Email, wallet, and social login methods  
+- **Wallet Export** - Export private keys for Solana wallets (with `withExport: true`)
 - **EVM Smart Wallets** - Support for Privy Smart Wallets with gas sponsorship
 - **Built-in Confirmation Modals** - User-friendly signing confirmations
 - **Theme Support** - Light/dark mode with customizable appearance
@@ -274,6 +275,78 @@ function LoginButton() {
 
 After successful authentication, `authenticated` becomes `true` and `user` object contains user data.
 
+#### Export Wallet Private Key
+
+**Note:** Wallet export is only available when `withExport: true` is set in SupaProvider config (Solana wallets).
+
+Export your wallet's private key to use it with other wallet clients like Phantom:
+
+```tsx
+import { useAuth, useCantonWallet } from '@supa/sdk';
+
+function ExportWalletButton() {
+  const { exportWallet, authenticated } = useAuth();
+  const { cantonWallet } = useCantonWallet();
+
+  const handleExport = async () => {
+    if (!cantonWallet) return;
+    
+    try {
+      // Export the primary Canton wallet
+      await exportWallet({ address: cantonWallet.address });
+      
+      // Or export without specifying address (exports first wallet)
+      await exportWallet();
+    } catch (error) {
+      console.error('Export failed:', error);
+    }
+  };
+
+  return (
+    <button onClick={handleExport} disabled={!authenticated || !cantonWallet}>
+      Export Private Key
+    </button>
+  );
+}
+```
+
+**What happens:**
+- Privy modal opens showing your private key
+- You can copy the key to use with MetaMask, Phantom, or other wallet clients
+- The key is assembled securely on a different origin - neither you nor Privy can access it during transmission
+
+**Security Warning:** Never share your private key! Anyone with your private key has full control over your wallet.
+
+#### Complete Logout with State Cleanup
+
+For a complete logout that clears all SDK state (Canton balances, registration, etc.), use the `useSupa` hook:
+
+```tsx
+import { useSupa } from '@supa/sdk';
+
+function App() {
+  const { auth, canton, logout } = useSupa();
+
+  if (!auth.authenticated) {
+    return <button onClick={auth.login}>Login</button>;
+  }
+
+  return (
+    <div>
+      <p>Welcome! Canton registered: {canton.isRegistered ? 'Yes' : 'No'}</p>
+      <button onClick={logout}>Complete Logout</button>
+    </div>
+  );
+}
+```
+
+**What `useSupa().logout()` does:**
+1. Clears all Canton state (balances, user info, registration flags)
+2. Terminates Privy session
+3. Resets all internal SDK state
+
+**Note:** Using `auth.logout()` directly only logs out from Privy but doesn't clear Canton state. For complete cleanup, always use `useSupa().logout()`.
+
 ---
 
 ### 3. Canton Network Operations
@@ -658,8 +731,9 @@ await sendTransaction(command, contracts, {
 
 | Hook | Purpose | Key Methods |
 |------|---------|-------------|
+| `useSupa` | Main SDK hook | `auth`, `canton`, `api`, `onboard`, `logout` (recommended for complete cleanup) |
 | `useAuth` | Authentication | `login`, `logout`, `authenticated`, `user` |
-| `useCanton` | Canton Network | `registerCanton`, `getBalances`, `sendCantonCoin`, `signMessage`, `sendTransaction`, `getActiveContracts`, `tapDevnet`, `getPendingIncomingTransfers`, `respondToIncomingTransfer` |
+| `useCanton` | Canton Network | `registerCanton`, `getBalances`, `sendCantonCoin`, `signMessage`, `sendTransaction`, `getActiveContracts`, `tapDevnet`, `getPendingIncomingTransfers`, `respondToIncomingTransfer`, `resetState` |
 | `useSignMessage` | Enhanced message signing | `signMessage` with custom modals |
 | `useSendTransaction` | Enhanced transactions | `sendTransaction` with custom modals |
 | `useConfirmModal` | Generic modals | `confirm`, `signMessageConfirm`, `signTransactionConfirm` |

package/dist/hooks/useAuth.d.ts

@@ -5,7 +5,7 @@ import { User as PrivyUser } from '@privy-io/react-auth';
 export interface UseAuthReturn {
     /** Opens Privy login modal */
     login: () => void;
-    /** Logs out the current user */
+    /** Logs out the current user and clears all SDK state */
     logout: () => Promise<void>;
     /** Whether user is authenticated */
     authenticated: boolean;
@@ -17,6 +17,10 @@ export interface UseAuthReturn {
     getAccessToken: () => Promise<string | null>;
     /** Whether SDK is ready (not loading) */
     ready: boolean;
+    /** Export wallet private key (opens Privy modal). Address is optional - defaults to first wallet */
+    exportWallet: (options?: {
+        address?: string;
+    }) => Promise<void>;
 }
 /**
  * Hook for managing user authentication via Privy

package/dist/hooks/useCantonWallet.d.ts

@@ -0,0 +1,10 @@
+import { CantonWallet } from '../utils/wallet';
+export interface UseCantonWalletReturn {
+    cantonWallets: CantonWallet[];
+    cantonWallet: CantonWallet | null;
+}
+/** @deprecated Use useCantonWallet instead */
+export type UseStellarWalletReturn = UseCantonWalletReturn;
+export declare function useCantonWallet(): UseCantonWalletReturn;
+/** @deprecated Use useCantonWallet instead */
+export declare const useStellarWallet: typeof useCantonWallet;

package/dist/hooks/useSendTransaction.d.ts

@@ -1,4 +1,4 @@
-import { StellarWallet } from '../utils/stellar';
+import { CantonWallet } from '../utils/wallet';
 import { CantonQueryCompletionResponseDto, CantonSubmitPreparedOptions } from '../services/cantonService';
 export interface SendTransactionOptions {
     onSuccess?: (result: CantonQueryCompletionResponseDto) => void;
@@ -21,7 +21,7 @@ export interface UseSendTransactionReturn {
     loading: boolean;
     error: Error | null;
     clearError: () => void;
-    stellarWallets: StellarWallet[];
-    stellarWallet: StellarWallet | null;
+    cantonWallets: CantonWallet[];
+    cantonWallet: CantonWallet | null;
 }
 export declare function useSendTransaction(): UseSendTransactionReturn;

package/dist/hooks/useSignMessage.d.ts

@@ -1,4 +1,4 @@
-import { StellarWallet } from '../utils/stellar';
+import { CantonWallet } from '../utils/wallet';
 export interface SignMessageOptions {
     onSuccess?: (signature: string) => void;
     onRejection?: () => void;
@@ -19,7 +19,7 @@ export interface UseSignMessageReturn {
     loading: boolean;
     error: Error | null;
     clearError: () => void;
-    stellarWallets: StellarWallet[];
-    stellarWallet: StellarWallet | null;
+    cantonWallets: CantonWallet[];
+    cantonWallet: CantonWallet | null;
 }
 export declare function useSignMessage(): UseSignMessageReturn;

package/dist/hooks/useSignRawHashWithModal.d.ts

@@ -1,4 +1,9 @@
-import { useSignRawHash } from '@privy-io/react-auth/extended-chains';
+/**
+ * Wrapper over Privy's signing with automatic confirmation modals
+ *
+ * Shows a confirmation modal before every signing operation
+ * Supports both Stellar (rawSign) and Solana (signMessage) based on withExport config
+ */
 export interface SignRawHashModalOptions {
     skipModal?: boolean;
     title?: string;
@@ -11,7 +16,11 @@ export interface SignRawHashModalOptions {
     /** Show technical details (address, chainType, hash) as JSON. Default: false */
     showTechnicalDetails?: boolean;
 }
-type SignRawHashParams = Parameters<ReturnType<typeof useSignRawHash>['signRawHash']>[0];
+export interface SignRawHashParams {
+    address: string;
+    chainType: string;
+    hash: `0x${string}`;
+}
 export interface UseSignRawHashWithModalReturn {
     /** Sign a raw hash with confirmation modal */
     signRawHashWithModal: (params: SignRawHashParams, modalOptions?: SignRawHashModalOptions) => Promise<{
@@ -19,4 +28,3 @@ export interface UseSignRawHashWithModalReturn {
     } | null>;
 }
 export declare function useSignRawHashWithModal(): UseSignRawHashWithModalReturn;
-export {};

package/dist/hooks/useSupa.d.ts

@@ -13,6 +13,8 @@ export interface UseSupaReturn {
     api: UseAPIReturn;
     /** Automated onboarding flow (login → create wallet → register Canton) */
     onboard: () => Promise<void>;
+    /** Complete logout (Privy + clear all SDK state) */
+    logout: () => Promise<void>;
 }
 /**
  * Main hook for accessing all Supa SDK features
@@ -27,7 +29,7 @@ export interface UseSupaReturn {
  * Basic usage
  * ```tsx
  * function Dashboard() {
- *   const { auth, canton, api } = useSupa();
+ *   const { auth, canton, api, logout } = useSupa();
  *
  *   if (!auth.authenticated) {
  *     return <button onClick={auth.login}>Login</button>;
@@ -39,6 +41,7 @@ export interface UseSupaReturn {
  *       <button onClick={() => canton.registerCanton()}>
  *         Register Canton
  *       </button>
+ *       <button onClick={logout}>Logout</button>
  *     </div>
  *   );
  * }