@privy-io/react-auth 1.16.0-beta.3 → 1.16.0-beta.5

package/dist/index.d.ts

@@ -505,13 +505,23 @@ interface PrivyInterface {
     /**
      * @experimental **Experimental**: This feature is {@link https://docs.privy.io/guide/faq/experimental-features subject to change at any time}.
      *
-     * Prompts a user to create an embedded wallet through Privy.
+     * Prompts a user to create an Ethereum wallet through Privy.
+     *
+     * This function will fail if the user has already created a wallet through Privy,
+     * as Privy currently only supports creating one wallet per user.
+     *
+     * This requires a user to enter a recovery pin that can later be used to recover the
+     * wallet or port it across devices.
      */
     createWallet: () => Promise<Wallet>;
     /**
      * @experimental **Experimental**: This feature is {@link https://docs.privy.io/guide/faq/experimental-features subject to change at any time}.
      *
-     * Prompts a user to sign a message through Privy.
+     * Prompts a user to sign a message using their Privy wallet.
+     *
+     * The resulting signature is an EIP-191 personal_sign signature (0x45).
+     *
+     * This function currently has a precondition that the user has a Privy wallet. It will fail otherwise.
      */
     signMessage: (message: string, data?: SignMessageModalUIOptions) => Promise<string>;
 }
@@ -724,4 +734,4 @@ declare class PrivyClient {
     forkSession(): Promise<string>;
 }
 
-export { AsExternalProvider, ConnectorManager, Discord, DiscordOAuthWithMetadata, Email, EmailWithMetadata, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Twitter, TwitterOAuthWithMetadata, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, usePrivy };
+export { AsExternalProvider, ConnectorManager, Discord, DiscordOAuthWithMetadata, Email, EmailWithMetadata, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, SignMessageModalUIOptions, Twitter, TwitterOAuthWithMetadata, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, usePrivy };