@privy-io/react-auth 1.26.0-beta.1 → 1.26.0-beta.10

package/dist/index.d.ts

@@ -362,7 +362,7 @@ interface Wallet {
     walletClient: 'privy' | 'unknown';
 }
 /**
- * Object representation of a connected wallet.
+ * Object representation of a base connected wallet from a wallet connector.
  */
 interface BaseConnectedWallet {
     /** The wallet address. */
@@ -371,20 +371,45 @@ interface BaseConnectedWallet {
     chainId: string;
     /** The first time this wallet was connected without break. */
     connectedAt: number;
-    /** The wallet client where this key-pair is stored. */
+    /**
+     * @experimental **Experimental**: This property is {@link https://docs.privy.io/guide/guides/experimental-features subject to change at any time}.
+     *
+     * The wallet client where this key-pair is stored.
+     * e.g. metamask, rainbow, coinbase_wallet, etc.
+     */
     walletClientType: WalletClientType;
-    /** The connector used to initiate the connection with the wallet client. */
+    /**
+     * @experimental **Experimental**: This property is {@link https://docs.privy.io/guide/guides/experimental-features subject to change at any time}.
+     *
+     * The connector used to initiate the connection with the wallet client.
+     * e.g. injected, wallet_connect, coinbase_wallet, etc.
+     */
     connectorType: ConnectorType;
     /** Returns true if the wallet is connected, false otherwise */
     isConnected: () => Promise<boolean>;
     /** Helper methods to build providers for interfacing with this wallet. */
-    getEthereumProvider: () => EIP1193Provider;
-    getEthersProvider: () => Web3Provider;
-    getWeb3jsProvider: () => AbstractProvider;
-    /** Disconnect method does not work on all connector types and will no-op if
-     * that is the case (metamask does not support programmatic disconnects) */
+    getEthereumProvider: () => Promise<EIP1193Provider>;
+    getEthersProvider: () => Promise<Web3Provider>;
+    getWeb3jsProvider: () => Promise<AbstractProvider>;
+    /**
+     * Perform personal_sign with the user's wallet.
+     *
+     * @param {string} message The message to sign.
+     * @returns {string} The resulting signature.
+     */
+    sign: (message: string) => Promise<string>;
+    /**
+     * @experimental **Experimental**: This property is {@link https://docs.privy.io/guide/guides/experimental-features subject to change at any time}.
+     *
+     * Disconnect method does not work on all connector types and will no-op if
+     * an incompatible connector is used (metamask and phantom do not support
+     * programmatic disconnects)
+     */
     disconnect: () => void;
 }
+/**
+ * Object representation of a connected wallet.
+ */
 interface ConnectedWallet extends BaseConnectedWallet {
     /** True if this wallet is linked to the authenticated user. False if it is not yet linked or
      * the user has not yet authenticated. */
@@ -947,13 +972,13 @@ interface PrivyInterface {
      */
     setActiveWallet: (address: string) => Promise<void>;
     /**
-     * @experimental **Experimental**: This feature is {@link https://docs.privy.io/guide/faq/experimental-features subject to change at any time}.
+     * @experimental **Experimental**: This feature is {@link https://docs.privy.io/guide/guides/experimental-features subject to change at any time}.
      *
      * Get a short-lived, one-time-use token to start a new Privy session from the existing authenticated session. Raises an exception if the current session was already forked from a previous session.
      */
     forkSession: () => Promise<string>;
     /**
-     * @experimental **Experimental**: This feature is {@link https://docs.privy.io/guide/faq/experimental-features subject to change at any time}.
+     * @experimental **Experimental**: This feature is {@link https://docs.privy.io/guide/guides/experimental-features subject to change at any time}.
      *
      * Prompts a user to create an Ethereum wallet through Privy.
      *
@@ -965,7 +990,7 @@ interface PrivyInterface {
      */
     createWallet: () => Promise<Wallet>;
     /**
-     * @experimental **Experimental**: This feature is {@link https://docs.privy.io/guide/faq/experimental-features subject to change at any time}.
+     * @experimental **Experimental**: This feature is {@link https://docs.privy.io/guide/guides/experimental-features subject to change at any time}.
      *
      * Prompts a user to sign a message using their Privy wallet.
      *