@privy-io/react-auth 1.18.0-beta.1 → 1.18.0-beta.3

package/dist/index.d.ts

@@ -6,7 +6,7 @@ import { AxiosResponse, AxiosRequestConfig } from 'axios';
 
 declare const SUPPORTED_OAUTH_PROVIDERS: readonly ["google", "discord", "twitter", "github"];
 type OAuthProviderType = typeof SUPPORTED_OAUTH_PROVIDERS[number];
-declare const SUPPORTED_WALLET_TYPES: readonly ["metamask", "coinbase_wallet", "wallet_connect"];
+declare const SUPPORTED_WALLET_TYPES: readonly ["metamask", "coinbase_wallet", "wallet_connect", "metamask_wc"];
 type WalletType = typeof SUPPORTED_WALLET_TYPES[number];
 /**
  * Wallet metadata currently for internal use only
@@ -136,6 +136,9 @@ interface GithubOAuthWithMetadata extends LinkMetadata, Github {
     /** Denotes that this is a Github account. */
     type: 'github_oauth';
 }
+/**
+ * Object representation of a user's linked accounts
+ */
 type LinkedAccountWithMetadata = WalletWithMetadata | EmailWithMetadata | PhoneWithMetadata | GoogleOAuthWithMetadata | TwitterOAuthWithMetadata | DiscordOAuthWithMetadata | GithubOAuthWithMetadata;
 interface User {
     /** The Privy-issued DID for the user. If you need to store additional information
@@ -312,8 +315,9 @@ declare abstract class WalletConnector {
  * the appropriate WCWalletConnector for use with an action.
  */
 declare class WCWalletConnector extends WalletConnector {
-    private _connectionManager;
-    constructor(connectionManager: WCConnectionManager, proxyProvider: PrivyProxyProvider, address: string | null);
+    private connectionManager;
+    private targetWalletName?;
+    constructor(connectionManager: WCConnectionManager, proxyProvider: PrivyProxyProvider, address: string | null, targetWalletName?: InstantLaunchWallet);
     connect(options: {
         showPrompt: boolean;
     }): Promise<Wallet | null>;
@@ -346,8 +350,10 @@ declare class WCConnectionManager {
     constructor();
     /**
      * Builds a new WCWalletConnector instance
+     *
+     * If targetWalletName is specified, attempts to launch into that specific flow
      */
-    createConnector(provider: PrivyProxyProvider, address: string | null): WCWalletConnector;
+    createConnector(provider: PrivyProxyProvider, address: string | null, targetWalletName?: InstantLaunchWallet): WCWalletConnector;
     /**
      * Disconnects all active Wallet Connect sessions.
      */
@@ -356,12 +362,13 @@ declare class WCConnectionManager {
      * Given an address, either fetch (reusing a stored connection) or create a new one if no stored
      * connection is found
      */
-    getOrCreateProviderForAddress(address: string | null): WCProvider;
+    getOrCreateProviderForAddress(address: string | null, targetWalletName: InstantLaunchWallet | undefined): WCProvider;
     /**
      * Create a WC provider and add an entry to the internal provider registry keyed on the internal
-     * WC storageId
+     * WC storageId. If targetWalletName is specified, attempts to launch the WC flow for that particular
+     * wallet
      */
-    private createProvider;
+    createProvider(storageId: string, targetWalletName: InstantLaunchWallet | undefined): WCProvider;
     /**
      * Replace the given provider, *assuming it's the one with null address*
      *
@@ -369,11 +376,14 @@ declare class WCConnectionManager {
      * seeing - WC sessions wouldn't open a new modal/etc when doing `provider.enable()` if it had
      * previously been rejected: https://github.com/Uniswap/web3-react/issues/217
      */
-    replaceProvider(provider: WCProvider): WCProvider;
+    replaceProvider(provider: WCProvider, targetWalletName: InstantLaunchWallet | undefined): WCProvider;
     /**
      * Enables the provider. Under the hood, this calls connect() and 'eth_RequestAccounts'.
      */
-    enableProvider(provider: WCProvider): Promise<string[]>;
+    enableProvider(provider: WCProvider, targetWalletName: InstantLaunchWallet | undefined): Promise<string[]>;
+}
+declare enum InstantLaunchWallet {
+    metamask = "metamask"
 }
 
 declare class ConnectorManager {
@@ -516,6 +526,7 @@ interface PrivyInterface {
     unlinkPhone: (phoneNumber: string) => Promise<User>;
     /**
      * Unlink a wallet account from a user, by passing the public address. Note that you can only unlink a wallet account if the user has at least one other account.
+     * If the unlinked wallet was the active one, and more wallets are linked to the user, then we attempt to make the most recently linked wallet active.
      */
     unlinkWallet: (address: string) => Promise<User>;
     /**
@@ -537,11 +548,12 @@ interface PrivyInterface {
     /**
      * Set one of the authenticated wallet addresses (part of user.linkedAccounts with type 'wallet'). as the active wallet.
      * If you pass a wallet that's not one of the linkedAccounts, this will throw an error.
+     * This will prompt the user to reconnect their wallet if the connection is lost.
      *
      * The active wallet will be the one that getEthersProvider() will use as a signer (used for signing & transactions).
      * It is also the wallet present at `user.wallet`, and that value is updated when this is called.
      *
-     * Note that when you link a new wallet, it becomes 'active' by default.
+     * Note that when you link a new wallet, it becomes active.
      */
     setActiveWallet: (address: string) => Promise<void>;
     /**