@privy-io/react-auth 1.43.3 → 1.43.4

package/dist/index.d.ts

@@ -157,18 +157,30 @@ type Chain = {
     testnet?: boolean;
 };
 /**
- * RPC overrides to support custom RPC URLs. Do not provide an RPC URL
- * that can serve multiple networks. You should only provide RPC URLs that
- * are specific to the network you'd like to override.
+ * RPC configuration for wallets.
  */
 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.
+     *
+     * Do not provide an RPC URL that can serve multiple networks. You should only provide RPC URLs that are speciifc to the
+     * chain ID you'd like to override.
      */
-    rpcUrls: {
+    rpcUrls?: {
         [key: number]: string;
     };
+    /**
+     * Mapping between `walletClientType`s to the length of time after which RPC requests will timeout for that
+     * `walletClientType`.
+     *
+     * By default, all RPC requests through Privy will timeout after 2 mins (120000 ms). Use this object to
+     * override the RPC timeout in ms for specific` walletClientType`s, e.g. 'safe', in order to extend or
+     * shorten the timeout duration.
+     */
+    rpcTimeouts?: {
+        [key in WalletClientType]?: number;
+    };
 };
 
 declare const DEFAULT_SUPPORTED_CHAINS: readonly [Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain, Chain];
@@ -256,6 +268,13 @@ declare abstract class PrivyError extends Error {
     protected constructor(message: string, cause?: unknown, privyErrorCode?: PrivyErrorCode);
     toString(): string;
 }
+/**
+ * The PrivyConnector instance threw an exception.
+ */
+declare class PrivyConnectorError extends PrivyError {
+    type: string;
+    constructor(message: string, cause?: unknown, privyErrorCode?: PrivyErrorCode);
+}
 declare enum PrivyErrorCode {
     MISSING_OR_INVALID_PRIVY_APP_ID = "missing_or_invalid_privy_app_id",
     MISSING_OR_INVALID_PRIVY_ACCOUNT_ID = "missing_or_invalid_privy_account_id",
@@ -277,6 +296,10 @@ declare enum PrivyErrorCode {
     UNSUPPORTED_CHAIN_ID = "unsupported_chain_id"
 }
 
+declare class WalletTimeoutError extends PrivyConnectorError {
+    type: string;
+    constructor();
+}
 /**
  * A ProviderRpcError combines the necessary bits of the {PrivyError} with the
  * EIP-compliant ProviderRpcError. This is meant to be a type around errors raised
@@ -308,6 +331,7 @@ type ProviderMessage = {
 type OnMessageEventHandler = (message: ProviderMessage) => void;
 type EIP1193OnEventHandler = OnConnectEventHandler | OnDisconnectEventHandler | OnChainChangedEventHandler | OnAccountsChangedEventHandler | OnMessageEventHandler;
 interface EIP1193Provider {
+    rpcTimeoutDuration?: number;
     request: (request: {
         method: string;
         params?: Array<any> | undefined;
@@ -321,15 +345,17 @@ interface EIP1193Provider {
  * The PrivyProxyProvider adds a middleware layer on top of the underlying wallet provider.
  * */
 declare class PrivyProxyProvider implements EIP1193Provider {
+    rpcTimeoutDuration: number;
     walletProvider?: EIP1193Provider;
     private _subscriptions;
-    constructor(walletProvider?: EIP1193Provider);
+    constructor(walletProvider?: EIP1193Provider, rpcTimeoutDuration?: number);
     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;
+    walletTimeout: (error?: WalletTimeoutError, timeoutMs?: number) => Promise<string[]>;
     setWalletProvider: (provider: EIP1193Provider) => void;
 }
 interface RequestArguments {
@@ -343,6 +369,7 @@ declare class Embedded1193Provider extends EventEmitter implements EIP1193Provid
     chainId: number;
     rpcConfig: RpcConfig;
     chains: Chain[];
+    rpcTimeoutDuration: number;
     constructor(walletProxy: EmbeddedWalletProxy, address: string, rpcConfig: RpcConfig, chains: Chain[], chainId?: number);
     handleSendTransaction(args: RequestArguments): Promise<string>;
     private handleSwitchEthereumChain;
@@ -401,9 +428,11 @@ declare abstract class WalletConnector extends EventEmitter<ConnectorEvents> {
     walletClientType: WalletClientType;
     chains: Chain[];
     defaultChain: Chain;
+    rpcConfig: RpcConfig;
+    rpcTimeoutDuration: number;
     abstract connectorType: ConnectorType;
     abstract proxyProvider: PrivyProxyProvider | Embedded1193Provider;
-    constructor(walletClientType: WalletClientType, chains: Chain[], defaultChain: Chain);
+    constructor(walletClientType: WalletClientType, chains: Chain[], defaultChain: Chain, rpcConfig: RpcConfig);
     /**
      * Builds a connected wallet object to be exposed to the developer. This object
      * contains the address, chainId, and a few helper methods.
@@ -1262,12 +1291,6 @@ type PrivyClientConfig = {
         privacyPolicyUrl?: string | null;
     };
     walletConnectCloudProjectId?: string;
-    /**
-     * RPC overrides to support custom RPC URLs.
-     *
-     * @experimental
-     */
-    rpcConfig?: RpcConfig;
     /**
      * @deprecated use `supportedChains` instead.
      *