w3pk 0.2.0 → 0.4.0

package/dist/index.d.ts

@@ -1,9 +1,59 @@
+/**
+ * Stealth address cryptography for privacy-preserving transactions
+ */
+interface StealthKeys {
+    metaAddress: string;
+    viewingKey: string;
+    spendingKey: string;
+}
+/**
+ * Check if a stealth address can be controlled by the stealth keys
+ * Useful for scanning and proving ownership of stealth addresses
+ */
+declare function canControlStealthAddress(viewingKey: string, spendingKey: string, ephemeralPubkey: string, targetAddress: string): boolean;
+
+/**
+ * Stealth Address Module for w3pk SDK
+ * Provides privacy-preserving stealth address generation capabilities
+ */
+
+interface StealthAddressConfig$1 {
+}
+interface StealthAddressResult {
+    stealthAddress: string;
+    stealthPrivateKey: string;
+    ephemeralPublicKey: string;
+}
+/**
+ * Main Stealth Address Module
+ * Integrates with w3pk WebAuthn for seamless privacy-preserving stealth address generation
+ */
+declare class StealthAddressModule {
+    private config;
+    private getMnemonic;
+    constructor(config: StealthAddressConfig$1, getMnemonic: () => Promise<string | null>);
+    /**
+     * Generate a fresh stealth address for privacy-preserving transactions
+     * Returns the stealth address and private key for the user to handle transactions
+     */
+    generateStealthAddress(): Promise<StealthAddressResult>;
+    /**
+     * Get stealth keys for manual operations
+     */
+    getKeys(): Promise<StealthKeys>;
+    /**
+     * Check if stealth addresses are available (always true if properly configured)
+     */
+    get isAvailable(): boolean;
+}
+
 /**
  * Shared types used across the SDK
  */
 interface UserInfo {
     id: string;
     username: string;
+    displayName: string;
     ethereumAddress: string;
 }
 interface WalletInfo {
@@ -43,6 +93,8 @@ declare class ApiError extends Web3PasskeyError {
  * SDK Configuration
  */
 
+interface StealthAddressConfig {
+}
 interface Web3PasskeyConfig {
     /**
      * Base URL of the WebAuthn API
@@ -67,25 +119,21 @@ interface Web3PasskeyConfig {
      * Auth state change callback
      */
     onAuthStateChanged?: (isAuthenticated: boolean, user?: UserInfo) => void;
+    /**
+     * Optional stealth address configuration
+     * If provided, enables privacy-preserving stealth address generation
+     */
+    stealthAddresses?: StealthAddressConfig;
 }
 
 /**
- * Authentication-related types
+ * Main Web3Passkey SDK class
  */
 
 interface AuthResult {
     verified: boolean;
-    user?: {
-        id: string;
-        username: string;
-        ethereumAddress: string;
-    };
+    user?: UserInfo;
 }
-
-/**
- * Main Web3Passkey SDK class
- */
-
 declare class Web3Passkey {
     private config;
     private apiClient;
@@ -94,11 +142,18 @@ declare class Web3Passkey {
     private currentUser;
     private isAuthenticatedState;
     private isBrowser;
+    private stealthAddresses;
     constructor(config: Web3PasskeyConfig);
     private loadAuthState;
     private saveAuthState;
     private clearAuthState;
     private notifyAuthStateChange;
+    private createUserInfo;
+    /**
+     * Get mnemonic for current authenticated user
+     * Used by stealth address module
+     */
+    private getMnemonic;
     /**
      * Generate a new BIP39 wallet
      * @returns Wallet info with mnemonic (user MUST backup)
@@ -110,23 +165,22 @@ declare class Web3Passkey {
     hasWallet(): Promise<boolean>;
     /**
      * Register a new user with WebAuthn
+     * Handles the complete registration flow internally
+     * Automatically generates wallet if not provided
+     *
      * @param username Username for the account
-     * @param ethereumAddress Ethereum address from generated wallet
-     * @param mnemonic BIP39 mnemonic to encrypt and store
-     * @param credentialId WebAuthn credential ID (from registration response)
-     * @param challenge Challenge used in registration
+     * @param ethereumAddress Optional: Ethereum address (will generate if not provided)
+     * @param mnemonic Optional: BIP39 mnemonic (will generate if not provided)
+     * @returns Object containing ethereumAddress and mnemonic (only if generated)
      */
     register(options: {
         username: string;
+        ethereumAddress?: string;
+        mnemonic?: string;
+    }): Promise<{
         ethereumAddress: string;
-        mnemonic: string;
-        credentialId: string;
-        challenge: string;
-    }): Promise<void>;
-    /**
-     * Authenticate with Ethereum address
-     */
-    authenticate(ethereumAddress: string): Promise<AuthResult>;
+        mnemonic?: string;
+    }>;
     /**
      * Authenticate without username (usernameless flow)
      */
@@ -137,12 +191,11 @@ declare class Web3Passkey {
     logout(): void;
     /**
      * Sign a message with encrypted wallet
-     * Requires fresh WebAuthn authentication
+     * Handles fresh WebAuthn authentication internally
+     *
      * @param message Message to sign
-     * @param credentialId WebAuthn credential ID (from fresh auth)
-     * @param challenge Challenge from fresh auth
      */
-    signMessage(message: string, credentialId: string, challenge: string): Promise<string>;
+    signMessage(message: string): Promise<string>;
     /**
      * Check if user is authenticated
      */
@@ -159,6 +212,10 @@ declare class Web3Passkey {
      * Check if running in browser environment
      */
     get isBrowserEnvironment(): boolean;
+    /**
+     * Get stealth address module (if configured)
+     */
+    get stealth(): StealthAddressModule | null;
 }
 
 /**
@@ -168,4 +225,4 @@ declare class Web3Passkey {
 
 declare function createWeb3Passkey(config: Web3PasskeyConfig): Web3Passkey;
 
-export { ApiError, type AuthResult, AuthenticationError, CryptoError, RegistrationError, StorageError, type UserInfo, WalletError, type WalletInfo, Web3Passkey, type Web3PasskeyConfig, Web3PasskeyError, createWeb3Passkey, createWeb3Passkey as default };
+export { ApiError, AuthenticationError, CryptoError, RegistrationError, type StealthAddressConfig, StealthAddressModule, type StealthAddressResult, type StealthKeys, StorageError, type UserInfo, WalletError, type WalletInfo, Web3Passkey, type Web3PasskeyConfig, Web3PasskeyError, canControlStealthAddress, createWeb3Passkey, createWeb3Passkey as default };