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

package/dist/index.d.ts

@@ -8,6 +8,13 @@ declare const SUPPORTED_OAUTH_PROVIDERS: readonly ["google", "discord", "twitter
 type OAuthProviderType = typeof SUPPORTED_OAUTH_PROVIDERS[number];
 declare const SUPPORTED_WALLET_TYPES: readonly ["metamask", "coinbase_wallet", "wallet_connect"];
 type WalletType = typeof SUPPORTED_WALLET_TYPES[number];
+/**
+ * Wallet metadata currently for internal use only
+ */
+type WalletMeta = {
+    name: string;
+    icon?: string | EmbeddedSVG;
+};
 type LinkedAccountType = 'wallet' | 'email' | 'phone' | 'google_oauth' | 'twitter_oauth' | 'discord_oauth' | 'github_oauth';
 /** @ignore */
 interface LinkMetadata {
@@ -252,14 +259,14 @@ interface EIP1193Provider {
 declare class PrivyProxyProvider implements EIP1193Provider {
     walletProvider?: EIP1193Provider;
     private _subscriptions;
-    constructor(provider?: EIP1193Provider);
+    constructor(walletProvider?: EIP1193Provider);
     on(eventName: string, listener: (...args: any[]) => void): any;
     request(request: {
         method: string;
         params?: any[] | undefined;
     }): Promise<any>;
     removeListener: (eventName: string | symbol, listener: (...args: any[]) => void) => any;
-    setProvider: (provider: EIP1193Provider) => void;
+    setWalletProvider: (provider: EIP1193Provider) => void;
 }
 declare class AsExternalProvider extends PrivyProxyProvider implements ExternalProvider {
     constructor(provider: EIP1193Provider);
@@ -278,15 +285,16 @@ declare class AsExternalProvider extends PrivyProxyProvider implements ExternalP
 }
 
 declare abstract class WalletConnector {
-    provider: PrivyProxyProvider;
+    proxyProvider: PrivyProxyProvider;
     walletType: WalletType;
     connected: boolean;
     address: string | null;
     chain: string | null;
-    constructor(walletType: WalletType, provider: PrivyProxyProvider, address: string | null);
+    constructor(walletType: WalletType, proxyProvider: PrivyProxyProvider, address: string | null);
     fetchAddress(): Promise<string | null>;
     fetchChainId(): Promise<string>;
     getConnectedWallet(): Promise<Wallet | null>;
+    abstract get walletMeta(): WalletMeta;
     abstract connect(options: {
         showPrompt: boolean;
     }): Promise<Wallet | null>;
@@ -299,21 +307,34 @@ declare abstract class WalletConnector {
 /**
  * Light wrapper around WCConnectionManager that uses the global connection manager
  * to manage the local storage layer and avoid conflicts.
+ * There can be multiple WCWalletConnectors, but should only ever be a single
+ * WCConnectionManager, which should be the class referenced - it will in turn find
+ * the appropriate WCWalletConnector for use with an action.
  */
 declare class WCWalletConnector extends WalletConnector {
     private _connectionManager;
-    private _provider;
-    constructor(connectionManager: WCConnectionManager, provider: PrivyProxyProvider, address: string | null);
+    constructor(connectionManager: WCConnectionManager, proxyProvider: PrivyProxyProvider, address: string | null);
     connect(options: {
         showPrompt: boolean;
     }): Promise<Wallet | null>;
     isConnected(): Promise<boolean>;
+    /**
+     * Metadata about the wallet represented by this connector.
+     */
+    get walletMeta(): {
+        name: string;
+        icon: string | EmbeddedSVG;
+    };
     promptConnection(): Promise<void>;
     /**
-     * Perform personal_sign with the user's wallet.
+     * Perform personal_sign with the user's first wallet associated with WalletConnect
      */
     sign(message: string): Promise<string>;
     disconnect(): void;
+    /**
+     * Access the underlying WCProvider directly with proper typings
+     */
+    private get walletProvider();
 }
 /**
  * An object representation of the Wallet Connect V1 protocol. This is used to initiate and manage connections
@@ -332,13 +353,27 @@ declare class WCConnectionManager {
      */
     disconnect(): Promise<void>;
     /**
-     * Handles storage retrieval and assignment for WalletConnectProvider instances
+     * 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;
+    /**
+     * Create a WC provider and add an entry to the internal provider registry keyed on the internal
+     * WC storageId
+     */
+    private createProvider;
+    /**
+     * Replace the given provider, *assuming it's the one with null address*
+     *
+     * Couldn't find any WC docs, but a reference implementation library had a similar error we were
+     * 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
      */
-    getProviderForAddress(address: string | null): WCProvider;
+    replaceProvider(provider: WCProvider): WCProvider;
     /**
-     * Updates internal global connector data structures with address mappings as new accounts are added
+     * Enables the provider. Under the hood, this calls connect() and 'eth_RequestAccounts'.
      */
-    indexProvider(provider: WCProvider): void;
+    enableProvider(provider: WCProvider): Promise<string[]>;
 }
 
 declare class ConnectorManager {
@@ -481,6 +516,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>;
     /**
@@ -502,11 +538,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>;
     /**