@privy-io/react-auth 1.32.1 → 1.32.2-beta.1

package/dist/index.d.ts

@@ -478,6 +478,16 @@ interface BaseConnectedWallet {
     connectorType: ConnectorType;
     /** Returns true if the wallet is connected, false otherwise */
     isConnected: () => Promise<boolean>;
+    /**
+     * Switch the network chain to a specified ID.
+     * Note: The chainId must be a supported network: https://docs.privy.io/guide/frontend/embedded/networks
+     * Note: This will not update any existing provider instances, re-request `wallet.getEthersProvider` (e.g.)
+     *   to get a provider with the updated chainId.
+     *
+     * @param targetChainId The specified chain ID to switch to, as a number or 0x prefixed string.
+     * @returns void
+     */
+    switchChain: (targetChainId: `0x${string}` | number) => Promise<void>;
     /** Helper methods to build providers for interfacing with this wallet. */
     getEthereumProvider: () => Promise<EIP1193Provider>;
     getEthersProvider: () => Promise<Web3Provider>;
@@ -1557,4 +1567,50 @@ declare function useConnectWallet(callbacks?: PrivyEvents['connectWallet']): {
     connectWallet: () => void;
 };
 
-export { Apple, AppleOAuthWithMetadata, AsExternalProvider, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, SendTransactionModalUIOptions, SignMessageModalUIOptions, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, useConnectWallet, useLogin, useLogout, usePrivy, useWallets };
+/**
+ * These types are fully compatible with WAGMI chain types, in case
+ * we need interop in the future.
+ */
+type RpcUrls = {
+    http: readonly string[];
+    webSocket?: readonly string[];
+};
+type NativeCurrency = {
+    name: string;
+    /** 2-6 characters long */
+    symbol: string;
+    decimals: number;
+};
+type BlockExplorer = {
+    name: string;
+    url: string;
+};
+/** A subset of WAGMI's chain type
+ * https://github.com/wagmi-dev/references/blob/6aea7ee9c65cfac24f33173ab3c98176b8366f05/packages/chains/src/types.ts#L8
+ */
+type Chain = {
+    /** Id in number form */
+    id: number;
+    /** Human readable name */
+    name: string;
+    /** Internal network name */
+    network: string;
+    /** Currency used by chain */
+    nativeCurrency: NativeCurrency;
+    /** Collection of block explorers */
+    blockExplorers?: {
+        [key: string]: BlockExplorer;
+        default: BlockExplorer;
+    };
+    /** Collection of RPC endpoints */
+    rpcUrls: {
+        [key: string]: RpcUrls;
+        default: RpcUrls;
+        public: RpcUrls;
+    };
+    /** Flag for test networks */
+    testnet?: boolean;
+};
+declare const SUPPORTED_CHAINS: readonly [Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain];
+
+export { Apple, AppleOAuthWithMetadata, AsExternalProvider, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyInterface, PrivyProvider, PrivyProviderProps, PrivyProxyProvider, Quantity, SUPPORTED_CHAINS, SendTransactionModalUIOptions, SignMessageModalUIOptions, TransactionLog, TransactionReceipt, TransactionUIOptions, Twitter, TwitterOAuthWithMetadata, UnsignedTransactionRequest, UseWalletsInterface, User, VERSION, Wallet, WalletConnector, WalletWithMetadata, getAccessToken, useConnectWallet, useLogin, useLogout, usePrivy, useWallets };