@privy-io/react-auth 1.50.1 → 1.51.0-beta-20231206004425

package/dist/index.d.ts

@@ -6,7 +6,7 @@ import EventEmitter from 'eventemitter3';
 import { TypedMessage, MessageTypes } from '@metamask/eth-sig-util';
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import { TurnstileProps } from '@marsidev/react-turnstile';
-import { Store } from 'mipd';
+import { Store, EIP6963ProviderDetail } from 'mipd';
 import { FetchOptions } from 'ofetch';
 
 /**
@@ -727,7 +727,7 @@ declare class ConnectorManager extends EventEmitter<ConnectorManagerEvents> {
      * Creates a new wallet connector for the given connector type and wallet client type.
      * If a connector already exists, it will be returned instead.
      */
-    createWalletConnector(connectorType: ConnectorType, walletClientType: WalletClientType): Promise<WalletConnector | null>;
+    createWalletConnector(connectorType: ConnectorType, walletClientType: WalletClientType, providerDetail?: EIP6963ProviderDetail): Promise<WalletConnector | null>;
     /**
      * @deprecated **Deprecated**: This feature will be removed and should be replaced by
      * interfacing with wallets directly (wallets[0].getEthereumProvider()).
@@ -904,10 +904,15 @@ declare const SUPPORTED_MFA_METHODS: readonly ["sms", "totp"];
 type MfaMethod = (typeof SUPPORTED_MFA_METHODS)[number];
 type OAuthProviderType = (typeof SUPPORTED_OAUTH_PROVIDERS)[number];
 type LoginMethod = 'email' | 'sms' | 'siwe' | OAuthProviderType;
-type EmbeddedWalletClientType = 'privy';
-type InjectedWalletClientType = 'metamask' | 'phantom';
-type CoinbaseWalletClientType = 'coinbase_wallet';
-type UnknownWalletClientType = 'unknown';
+declare const EMBEDDED_WALLET_CLIENT_TYPES: readonly ["privy"];
+type EmbeddedWalletClientType = (typeof EMBEDDED_WALLET_CLIENT_TYPES)[number];
+declare const INJECTED_WALLET_CLIENT_TYPES: readonly ["metamask", "phantom"];
+type InjectedWalletClientType = (typeof INJECTED_WALLET_CLIENT_TYPES)[number];
+declare const COINBASE_WALLET_CLIENT_TYPES: readonly ["coinbase_wallet"];
+type CoinbaseWalletClientType = (typeof COINBASE_WALLET_CLIENT_TYPES)[number];
+type WalletConnectWalletClientType = (typeof WALLET_CONNECT_WALLET_CLIENT_TYPES)[number];
+declare const UNKNOWN_WALLET_CLIENT_TYPES: readonly ["unknown"];
+type UnknownWalletClientType = (typeof UNKNOWN_WALLET_CLIENT_TYPES)[number];
 type WalletClientType = InjectedWalletClientType | CoinbaseWalletClientType | WalletConnectWalletClientType | EmbeddedWalletClientType | UnknownWalletClientType;
 declare const SUPPORTED_CONNECTOR_TYPES: string[];
 type ConnectorType = (typeof SUPPORTED_CONNECTOR_TYPES)[number];
@@ -1289,6 +1294,7 @@ type PriceDisplayOptions = {
     primary: 'native-token';
     secondary: null;
 };
+type SupportedWallet = 'metamask' | 'coinbase_wallet' | 'rainbow' | 'phantom' | 'zerion' | 'injected' | 'wallet_connect';
 type PrivyClientConfig = {
     /** All UI and theme related configuration */
     appearance?: {
@@ -1313,6 +1319,15 @@ type PrivyClientConfig = {
          *  social and email / sms login options.
          *  This overrides the server setting `show_wallet_login_first` */
         showWalletLoginFirst?: boolean;
+        /**
+         * An array of {@link SupportedWallet supported wallets}
+         * Determines the set of wallet options in the privy modal as well as the order in which they appear.
+         *
+         * Defaults to ['metamask', 'coinbase', 'rainbow', 'injected', 'wallet_connect']
+         *
+         * @default ['metamask', 'coinbase', 'rainbow', 'injected', 'wallet_connect']
+         */
+        supportedWallets?: SupportedWallet[];
     };
     /** Specified login methods for the privy modal.
      *  If this parameter is included, it will override any login method settings specified on the server.
@@ -2500,4 +2515,4 @@ declare function useCreateWallet(callbacks?: PrivyEvents['createWallet']): {
     createWallet: () => Promise<Wallet>;
 };
 
-export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, Captcha, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, LoginWithCode, MfaMethod, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PriceDisplayOptions, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendCodeToEmail, SendTransactionModalUIOptions, SignMessageModalUIOptions, Tiktok, TiktokOAuthWithMetadata, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseLoginWithEmail, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getAccessToken, useConnectWallet, useCreateWallet, useLogin, useLoginWithEmail, useLogout, useMfa, useMfaEnrollment, usePrivy, useRegisterMfaListener, useWallets };
+export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, Captcha, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, FundWalletConfig, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, LinkedIn, LinkedInOAuthWithMetadata, LoginWithCode, MfaMethod, MoonpayConfig, MoonpayCurrencyCode, MoonpayPaymentMethod, Phone, PhoneWithMetadata, PriceDisplayOptions, PrivyClient, PrivyClientConfig, PrivyEvents, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, DEFAULT_SUPPORTED_CHAINS as SUPPORTED_CHAINS, SendCodeToEmail, SendTransactionModalUIOptions, SignMessageModalUIOptions, SupportedWallet, Tiktok, TiktokOAuthWithMetadata, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseLoginWithEmail, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, errorIndicatesMaxMfaRetries, errorIndicatesMfaTimeout, errorIndicatesMfaVerificationFailed, getAccessToken, useConnectWallet, useCreateWallet, useLogin, useLoginWithEmail, useLogout, useMfa, useMfaEnrollment, usePrivy, useRegisterMfaListener, useWallets };