React Hooks for PnP Modal SDK

Web3Auth provides essential React hooks for Web3Auth Modal SDK for managing authentication, chain configuration, and user interactions within your application. These hooks can be directly imported from the @web3auth/modal-react-hooks package. Here's an example of how to import them:

import { useWeb3Auth } from "@web3auth/modal-react-hooks";

For more information on React hooks, refer to the official React documentation.

Available Hooks

• useWeb3Auth: Provides access to the Web3Auth context initialized via the Web3AuthProvider component.

Hook Context Interface

Table

Parameter	Description
isConnected	Indicates whether a user is currently logged in or not.
provider	The current provider, or null if not connected.
userInfo	Information about the logged-in user.
isMFAEnabled	Indicates whether Multi-Factor Authentication (MFA) is enabled or not.
isInitialized	Indicates whether Web3Auth has been initialized or not.
status	The current status of Web3Auth. Can take the following values: NOT_READY, READY, CONNECTING, CONNECTED, DISCONNECTED, ERRORED.
enableMFA(params?)	Enables Multi-Factor Authentication for the user. Returns a Promise.
logout(params?)	Logs out the user, with an optional cleanup parameter. Returns a Promise.
addAndSwitchChain	Adds and switches to a new blockchain. Takes chainConfig of type CustomChainConfig as a parameter. Returns a Promise.
addPlugin	Adds a plugin to the Web3Auth instance. Takes a plugin of type IPlugin as a parameter.
getPlugin	Retrieves a plugin by name. Takes pluginName of type string as parameter. Returns an IPlugin or null.
authenticateUser	Retrieves the idToken for the logged-in user. Returns a Promise.
addChain	Adds a new blockchain configuration. Takes chainConfig of type CustomChainConfig as a parameter. Returns a Promise.
switchChain	Switches to a specified blockchain by chain ID. Takes params of type { chainId: string } as a parameter. Returns a Promise.

Interface

interface IBaseWeb3AuthHookContext {
  /**
   * Indicates whether a user is currently logged in or not.
   */
  isConnected: boolean;
  /**
   * The current provider, or `null` if not connected.
   */
  provider: IProvider | null;
  /**
   * Information about the logged-in user.
   */
  userInfo: Partial<UserInfo> | null;
  /**
   * Indicates whether Multi-Factor Authentication (MFA) is enabled or not.
   */
  isMFAEnabled: boolean;
  /**
   * Indicates whether Web3Auth has been initialized or not.
   */
  isInitialized: boolean;
  /**
   * The current status of the Web3Auth adapter.
   */
  status: ADAPTER_STATUS_TYPE | null;
  /**
   * Enables Multi-Factor Authentication for the user.
   * @param params Optional parameters for enabling MFA.
   * @returns A Promise that resolves when MFA is enabled.
   */
  enableMFA(params?: LoginParams): Promise<void>;
  /**
   * Logs out the user, with an optional cleanup parameter.
   * @param params Optional parameters for logging out.
   * @returns A Promise that resolves when the user is logged out.
   */
  logout(params?: { cleanup: boolean }): Promise<void>;
  /**
   * Adds and switches to a new blockchain.
   * @param chainConfig Configuration for the new blockchain.
   * @returns A Promise that resolves when the chain is added and switched.
   */
  addAndSwitchChain(chainConfig: CustomChainConfig): Promise<void>;
  /**
   * Adds a plugin to the Web3Auth instance.
   * @param plugin The plugin to add.
   */
  addPlugin(plugin: IPlugin): void;
  /**
   * Retrieves a plugin by name.
   * @param pluginName The name of the plugin.
   * @returns The plugin instance or `null` if not found.
   */
  getPlugin(pluginName: string): IPlugin | null;
  /**
   * Retrieves the idToken for the logged-in user.
   * @returns A Promise that resolves with the authenticated user's information.
   */
  authenticateUser(): Promise<UserAuthInfo>;
  /**
   * Adds a new blockchain configuration.
   * @param chainConfig Configuration for the new blockchain.
   * @returns A Promise that resolves when the chain is added.
   */
  addChain(chainConfig: CustomChainConfig): Promise<void>;
  /**
   * Switches to a specified blockchain by chain ID.
   * @param params Parameters for switching the chain.
   * @returns A Promise that resolves when the chain is switched.
   */
  switchChain(params: { chainId: string }): Promise<void>;
}

Web3AuthProvider

The Web3AuthProvider component wraps the main component and injects the Web3Auth-related context into it. It takes the following properties as its context:

Table

Parameter	Description
web3AuthOptions	Configuration options for Web3Auth.
adapters	An array of adapters for connecting to different blockchain networks.
plugins	An array of plugins to add additional functionality to Web3Auth.

Interface

export interface Web3AuthProviderProps {
  config: Web3AuthContextConfig;
}

export type Web3AuthContextConfig = {
  web3AuthOptions: IWeb3AuthCoreOptions;
  adapters?: IAdapter<unknown>[];
  plugins?: IPlugin[];
};

export interface IWeb3AuthCoreOptions {
  clientId: string;
  chainConfig?: CustomChainConfig;
  enableLogging?: boolean;
  storageKey?: "session" | "local";
  sessionTime?: number;
  web3AuthNetwork?: WEB3AUTH_NETWORK_TYPE;
  useCoreKitKey?: boolean;
  uiConfig?: WhiteLabelData;
  privateKeyProvider?: IBaseProvider<string>;
}

info

Please check out the PnP Modal SDK references for interfaces for the inner parameters.

Shared Methods Descriptions

Once you've installed and successfully initialized Web3Auth, you can use it to authenticate your users. Further, you can use the native provider given by Web3Auth to connect the users to the respective blockchain network.

Natively, the instance of Web3Auth (referred to as web3auth in our examples) returns the following functions:

• init() - Initializes the Web3Auth instance.

  await init();

  Returns:

  init(): Promise<void>;

• connect() - Showing the Modal and Logging in the User.

  await connect();

  Returns:

  connect(): Promise<IProvider | null>;

  On successful login, the connect function returns an IProvider instance. You can use this provider to connect your user to the blockchain and make transactions.

• provider() - Returns the native provider that can be used to make different blockchain transactions. Returns:

  get provider(): IProvider | null;

• connected() - Returns true or false depending on whether the web3auth instance is available or not. Returns:

  get connected(): boolean;

• getUserInfo() - Getting the User's Information.

  const userInfo = await getUserInfo();

• authenticateUser() - Getting the idToken from Web3Auth.

  const idToken = await authenticateUser();

• addChain() - Add chain config details to the connected adapter.

  await addChain(chainConfig);

• switchChain() - Switch chain as per chainId already added to chain config.

  await switchChain({ chainId: "0x1" });

• getAdapter() - Get the connected adapter instance.

  const adapter = await getAdapter(adapterName);

• configureAdapter() - Configure the adapter instance.

  await configureAdapter(adapterConfig);

• clearCache() - Clear the cache.

  await clearCache();

• addPlugin() - Add a plugin to Web3Auth.

  await addPlugin(plugin);

• logout() - Logging out the User.

  await logout();

Examples

PnP Web SDK React Playground

PLAYGROUND

A playground to test all the features of Plug and Play SDKs in React

Source Code

plug and play

web

@web3auth/modal

javascript

evm

react

hooks

Integrate PnP Modal SDK with EVM based chains

SAMPLE APP

Use any EVM Blockchain like Ethereum, Polygon, Arbitrum, Base etc. with Plug and Play Modal SDK

Source CodeGuide

plug and play

web

@web3auth/modal

javascript

evm