@privy-io/react-auth 1.42.0 → 1.43.0-beta-20231004142809

package/dist/index.d.ts

@@ -273,7 +273,8 @@ declare enum PrivyErrorCode {
     INVALID_CREDENTIALS = "invalid_credentials",
     EMBEDDED_WALLET_ALREADY_EXISTS = "embedded_wallet_already_exists",
     UNKNOWN_EMBEDDED_WALLET_ERROR = "unknown_embedded_wallet_error",
-    EMBEDDED_WALLET_PASSWORD_UNCONFIRMED = "embedded_wallet_password_unconfirmed"
+    EMBEDDED_WALLET_PASSWORD_UNCONFIRMED = "embedded_wallet_password_unconfirmed",
+    UNSUPPORTED_CHAIN_ID = "unsupported_chain_id"
 }
 
 /**
@@ -399,9 +400,10 @@ declare abstract class WalletConnector extends EventEmitter<ConnectorEvents> {
     wallets: BaseConnectedWallet[];
     walletClientType: WalletClientType;
     chains: Chain[];
+    defaultChain: Chain;
     abstract connectorType: ConnectorType;
     abstract proxyProvider: PrivyProxyProvider | Embedded1193Provider;
-    constructor(walletClientType: WalletClientType, chains: Chain[]);
+    constructor(walletClientType: WalletClientType, chains: Chain[], defaultChain: Chain);
     /**
      * Builds a connected wallet object to be exposed to the developer. This object
      * contains the address, chainId, and a few helper methods.
@@ -617,7 +619,8 @@ declare class ConnectorManager extends EventEmitter<ConnectorManagerEvents> {
     private walletConnectCloudProjectId;
     private rpcConfig;
     private chains;
-    constructor(walletConnectCloudProjectId: string, rpcConfig: RpcConfig, chains: Chain[]);
+    private defaultChain;
+    constructor(walletConnectCloudProjectId: string, rpcConfig: RpcConfig, chains: Chain[], defaultChain: Chain);
     /**
      * The core wallets array that is exposed to developers. It builds
      * the wallets away with the following logic:
@@ -699,7 +702,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, rpcConfig: RpcConfig, chains: Chain[]): void;
+    initializeConnectorManager(walletConnectCloudProjectId: string, rpcConfig: RpcConfig, chains: Chain[], defaultChain: Chain): void;
     generateApi(): Http;
     /**
      * In the case of cookie-based auth, re-initialize the http client with the custom api url.
@@ -1247,7 +1250,32 @@ type PrivyClientConfig = {
      * @experimental
      */
     rpcConfig?: RpcConfig;
+    /**
+     * @deprecated use `supportedChains` instead.
+     *
+     */
     additionalChains?: Chain[];
+    /**
+     * A list of supported chains, used to specify which chains should be used throughout the application.
+     *
+     * Calling `sendTransaction` or `switchChain` on an unsupported network will throw an error.
+     *
+     * For external wallets, if the wallet's current chain post-connection (during connect-only or siwe flows)
+     * is not within the supported chains list, the user will be prompted to switch to the `defaultChain` (if set) or first supplied
+     * `supportedChain`. If the chain switching process does not fully succeed, the user will **not** be blocked from the
+     * application (and the wallet's current `chainId` can always be observed and acted upon accordingly.)
+     *
+     * For embedded wallets, the wallet will automatically default to the `defaultChain` (if set) or first supplied `supportedChain`.
+     */
+    supportedChains?: Chain[];
+    /**
+     * When supplied, the `defaultChain` will be the default chain used throughout the application.
+     *
+     * For external wallets, it will be used if the user's wallet it not within the `supportedChains` (or default chains) list.
+     *
+     * For embedded wallets, it will be used upon initialization, when the user hasn't switched to another supported chain.
+     */
+    defaultChain?: Chain;
     captchaEnabled?: boolean;
     /** All embedded wallets configuration */
     embeddedWallets?: {