@privy-io/react-auth 1.34.1-beta.8 → 1.34.1

package/dist/index.d.ts

@@ -150,6 +150,65 @@ interface EmbeddedWalletProxy {
     rpc: (data: WalletRpcRequestDataType) => Promise<WalletRpcResponseDataType>;
 }
 
+/**
+ * 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;
+};
+/**
+ * RPC overrides to support custom RPC URLs.
+ */
+type RpcConfig = {
+    /**
+     * Mapping of chainId to RPC URL. Overrides Privy default RPC URLs that are shared across projects. Set your own RPC URLs
+     * to avoid rate limits or other throughput bottlenecks.
+     */
+    rpcUrls: {
+        [key: number]: string;
+    };
+};
+
+declare const SUPPORTED_CHAINS: readonly [Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain];
+
 declare abstract class PrivyError extends Error {
     /**
      * Privy error type.
@@ -250,7 +309,8 @@ declare class Embedded1193Provider extends EventEmitter implements EIP1193Provid
     address: string;
     provider: JsonRpcProvider;
     chainId: number;
-    constructor(walletProxy: EmbeddedWalletProxy, address: string, chainId?: number);
+    rpcConfig: RpcConfig;
+    constructor(walletProxy: EmbeddedWalletProxy, address: string, rpcConfig: RpcConfig, chainId?: number);
     handleSendTransaction(args: RequestArguments): Promise<string>;
     private handleSwitchEthereumChain;
     private handlePersonalSign;
@@ -719,6 +779,12 @@ type PrivyClientConfig = {
         privacyPolicyUrl?: string | null;
     };
     walletConnectCloudProjectId?: string;
+    /**
+     * RPC overrides to support custom RPC URLs.
+     *
+     * @experimental
+     */
+    rpcConfig?: RpcConfig;
     captchaEnabled?: boolean;
     /** All embedded wallets configuration */
     embeddedWallets?: {
@@ -972,7 +1038,8 @@ declare class ConnectorManager extends EventEmitter<ConnectorManagerEvents> {
     private storedConnections;
     private activeWallet?;
     private walletConnectCloudProjectId;
-    constructor(walletConnectCloudProjectId: string);
+    private rpcConfig;
+    constructor(walletConnectCloudProjectId: string, rpcConfig: RpcConfig);
     /**
      * The core wallets array that is exposed to developers. It builds
      * the wallets away with the following logic:
@@ -1489,7 +1556,7 @@ declare class PrivyClient {
      * config. We can set this once and only once. If it is set twice, event listeners will be created
      * on the first ConnectorManager and are not re-created.
      */
-    initializeConnectorManager(walletConnectCloudProjectId: string): void;
+    initializeConnectorManager(walletConnectCloudProjectId: string, rpcConfig: RpcConfig): void;
     generateApi(): Http;
     /**
      * In the case of cookie-based auth, re-initialize the http client with the custom api url.
@@ -1645,51 +1712,4 @@ declare function useConnectWallet(callbacks?: PrivyEvents['connectWallet']): {
     connectWallet: () => void;
 };
 
-/**
- * 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, Chain, Chain, Chain, Chain];
-
 export { Apple, AppleOAuthWithMetadata, AsExternalProvider, CallbackError, ConnectedWallet, ConnectorManager, ContractUIOptions, Discord, DiscordOAuthWithMetadata, EIP1193Provider, Email, EmailWithMetadata, Github, GithubOAuthWithMetadata, Google, GoogleOAuthWithMetadata, Phone, PhoneWithMetadata, PrivyClient, PrivyClientConfig, PrivyEvents, 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 };