Skip to main content

Initializing PnP Web No Modal SDK

After Installation, the next step to use Web3Auth is to Initialize the SDK. However, the Initialization is a two-step process, with an additional two steps for customizations, ie.

Please note that these are the most critical steps where you need to pass on different parameters according to the preference of your project. Additionally, Whitelabeling and Custom Authentication have to be configured within this step, if you wish to customize your Web3Auth Instance.

Instantiating Web3AuthNoModal​

Import the Web3AuthNoModal class from @web3auth/no-modal​

import { Web3AuthNoModal } from "@web3auth/no-modal";

Assign the Web3AuthNoModal class to a variable​

const web3auth = new Web3AuthNoModal(Web3AuthNoModalOptions);

This Web3AuthNoModal constructor takes an object with Web3AuthNoModalOptions as input.

Arguments​

Web3AuthNoModalOptions​

ParameterDescription
chainConfigCustom configuration for your preferred blockchain. Read more about it here.
clientIdYour Web3Auth Client ID. You can get it from Web3Auth Dashboard under project details. It's a mandatory field of type string
web3AuthNetwork?Defines the Web3Auth network. It accepts OPENLOGIN_NETWORK_TYPE.
useCoreKitKey?Use CoreKit Key to get core kit key. It's an optional field with default value as false.
sessionTime?It allows developers to configure the session management time. Session Time is in seconds, default is 86400 seconds which is 1 day. sessionTime can be max 7 days.
uiConfig?WhiteLabel options for web3auth. It helps you define custom UI, branding, and translations for your brand app. It takes WhiteLabelData as a value.
storageKey?Setting to "local" will persist social login session across browser tabs.
privateKeyProvider?Private key provider for your chain namespace. It takes IBaseProvider as a value.
enableLoggingSetting to true will enable logs. Default value is false.

Adding a Custom Chain Configuration​

chainConfig​

ParameterDescription
chainNamespaceThe namespace of your preferred chain. Checkout Providers SDK Reference for understanding RPC Calls. It accepts ChainNamespaceType as a value.
chainIdThe chain id of the selected blockchain in hex string format.
rpcTarget
  • RPC Target URL for the selected chainNamespace & chainId.
  • We provide a default RPC Target for certain blockchains, but due to congestion it might be slow hence it is recommended to provide your own RPC Target URL.
wsTargetWeb socket target URL for the chain in string.
displayNameDisplay Name for the chain in string.
blockExplorerUrlBlockchain's explorer URL in string. (eg: https://etherscan.io)
tickerDefault currency ticker in string for the network (e.g: ETH)
tickerNameName for currency ticker in string (e.g: Ethereum)
decimals?Number of decimals in number for the currency ticker (e.g: 18)
logoLogo for the chain.
isTestnet?Defines whether the network is testnet or not.

Returns​

  • Object: The web3auth instance with all its methods and events.

Instantiating a Provider​

For getting the appropriate key for your selected chain, you need to instantiate a provider. This provider is used to make calls to the selected blockchain. Currently, Web3Auth exposes the following provider packages to be integrated within the SDKs:

Usage
import { EthereumPrivateKeyProvider } from "@web3auth/ethereum-provider";
import { CHAIN_NAMESPACES } from "@web3auth/base";

const privateKeyProvider = new EthereumPrivateKeyProvider({
  config: {
    /*
      pass the chain config that you want to connect with.
      all chainConfig fields are required.
      */
    chainConfig: {
      chainNamespace: CHAIN_NAMESPACES.EIP155,
      chainId: "0x1",
      rpcTarget: "https://rpc.ankr.com/eth",
      displayName: "Ethereum Mainnet",
      blockExplorerUrl: "https://etherscan.io",
      ticker: "ETH",
      tickerName: "Ethereum",
    },
  },
});

Whitelabeling​

uiConfig​

For customizing the redirect screens while logging in and constructing the key, you need to pass on WhiteLabelData in the uiConfig parameter to the uiConfig property of Web3Auth.

tip

This is just one of the aspects of whitelabeling you can achieve with Web3Auth. To know more in-depth about how you can Whitelabel your application with Web3Auth, have a look at our Whitelabeling SDK Reference.

Example​
const uiConfig: WhiteLabelData = {
  appName: "My App",
  appURL: "https://example.com",
  logoLight: "https://example.com/logo-light.png",
  logoDark: "https://example.com/logo-dark.png",
  defaultLanguage: LANGUAGES.en,
  mode: "light",
  useLogoLoader: true,
  theme: {
    primary: "#FF0000",
    secondary: "#00FF00",
    warning: "#FFA500",
  },
  tncLink: "https://example.com/terms",
  privacyPolicy: "https://example.com/privacy",
};

const web3auth = new Web3AuthNoModal({
  clientId: "", // Get your Client ID from the Web3Auth Dashboard
  chainConfig,
  web3AuthNetwork: WEB3AUTH_NETWORK.SAPPHIRE_MAINNET,
  privateKeyProvider,
  uiConfig,
});

Example​

const chainConfig: CustomChainConfig = {
  chainNamespace: CHAIN_NAMESPACES.EIP155,
  chainId: "0x1",
  displayName: "Ethereum Mainnet",
  blockExplorer: "https://etherscan.io",
  ticker: "ETH",
  tickerName: "Ethereum",
  rpcTarget: "https://rpc.ankr.com/eth", // This is the mainnet RPC we have added, please pass on your own endpoint while creating an app
};
const privateKeyProvider = new EthereumPrivateKeyProvider({ config: { chainConfig } });
const web3auth = new Web3AuthNoModal({
  clientId: "", // Get your Client ID from the Web3Auth Dashboard
  chainConfig,
  web3AuthNetwork: WEB3AUTH_NETWORK.SAPPHIRE_MAINNET,
  privateKeyProvider,
  uiConfig: {
    theme: {
      primaryColor: "#FF0000",
      secondaryColor: "#00FF00",
      textColor: "#0000FF",
    },
  },
});

Configuring Adapters​

An adapter is a pluggable package that implements an IAdapter interface for a wallet within Web3Auth. An adapter can be plugged in and out of the web3auth modal. Each adapter exposes the provider on successful user login that can be used to invoke RPC calls on the wallet and connected blockchain. You can configure and use any of the adapters provided by Web3Auth, by just configuring them while initializing Web3AuthNoModal.

Instantiating a Provider​

For getting the appropriate key for your selected chain, you need to instantiate a provider. This provider is used to make calls to the selected blockchain. Currently, Web3Auth exposes the following provider packages to be integrated within the SDKs:

Usage
import { EthereumPrivateKeyProvider } from "@web3auth/ethereum-provider";
import { CHAIN_NAMESPACES } from "@web3auth/base";

const privateKeyProvider = new EthereumPrivateKeyProvider({
  config: {
    /*
      pass the chain config that you want to connect with.
      all chainConfig fields are required.
      */
    chainConfig: {
      chainNamespace: CHAIN_NAMESPACES.EIP155,
      chainId: "0x1",
      rpcTarget: "https://rpc.ankr.com/eth",
      displayName: "Ethereum Mainnet",
      blockExplorerUrl: "https://etherscan.io",
      ticker: "ETH",
      tickerName: "Ethereum",
    },
  },
});

Configuring Openlogin Adapter​

The default adapter of Web3Auth is the openlogin-adapter. This adapter is a wrapper around the openlogin library from Web3Auth and enables the social login features. For customising features of the main Web3Auth flow, like Whitelabel, Custom Authentication, etc. you need to customise the Openlogin Adapter.

tip

Checkout the openlogin-adapter SDK Reference for more details on different configurations you can pass for customisations.

Whitelabeling​

whiteLabel​

For customising the redirect screens while logging in and constructing the key, you need to pass on whiteLabel configurations to the adapterSettings property of the openlogin-adapter.

tip

This is just one of the aspects of whitelabeling you can achieve with Web3Auth. To know more in depth about how you can Whitelabel your application with Web3Auth, have a look at our Whitelabeling SDK Reference.

Example​
import { OpenloginAdapter } from "@web3auth/openlogin-adapter";

const openloginAdapter = new OpenloginAdapter({
  adapterSettings: {
    clientId, //Optional - Provide only if you haven't provided it in the Web3Auth Instantiation Code
    network: "sapphire_mainnet", // Optional - Provide only if you haven't provided it in the Web3Auth Instantiation Code
    uxMode: "popup",
    whiteLabel: {
      appName: "W3A Heroes",
      appUrl: "https://web3auth.io",
      logoLight: "https://web3auth.io/images/web3auth-logo.svg",
      logoDark: "https://web3auth.io/images/web3auth-logo---Dark.svg",
      defaultLanguage: "en", // en, de, ja, ko, zh, es, fr, pt, nl, tr
      mode: "dark", // whether to enable dark mode. defaultValue: auto
      theme: {
        primary: "#00D1B2",
      },
      useLogoLoader: true,
    },
  },
  privateKeyProvider,
});
web3auth.configureAdapter(openloginAdapter);

Custom Authentication​

loginConfig​

With Web3Auth, you have the option to configure logins using your own authentication services. For adding your own authentication, you have to first configure your verifiers in the Web3Auth Dashboard. Have a look at our Custom Authentication Documentation for configuring that first.

Custom Authentication in Web3Auth is supported by the Openlogin Adapter, which is the default adapter for the Web3Auth SDK. For this, you need to configure the loginConfig parameter in the adapterSettings of the openlogin-adapter package.

tip

Refer to the Custom Authentication Documentation for more information.

Example​

Since we're using the @web3auth/no-modal, ie. the Plug and Play No Modal SDK, the loginConfig can include custom JWT-based authentication as well. This way, we can use any of our preferred login providers and further setup their configs while logging the user in and passing over the extraLoginOptions in the connectTo function. Read more about this in the Custom Authentication Guide.

import { OpenloginAdapter } from "@web3auth/openlogin-adapter";

const openloginAdapter = new OpenloginAdapter({
  adapterSettings: {
    clientId, //Optional - Provide only if you haven't provided it in the Web3Auth Instantiation Code
    network: "sapphire_mainnet", // Optional - Provide only if you haven't provided it in the Web3Auth Instantiation Code
    uxMode: "popup",
    loginConfig: {
      jwt: {
        verifier: "YOUR-VERIFIER-NAME-ON-WEB3AUTH-DASHBOARD",
        typeOfLogin: "jwt",
        clientId: "YOUR-CLIENTID-FROM-LOGIN-PROVIDER",
      },
    },
  },
  privateKeyProvider,
});

web3auth.configureAdapter(openloginAdapter);

Configuring External Wallet Adapters​

configureAdapter(ADAPTER)​

To configure an adapter, create the instance of adapter by using its corresponding package and pass the returned adapter instance in configureAdapter function.

tip

Refer to the Adapters documentation to know more deeply about what adapters are available and how to configure them.

Example​

If you want to configure the Torus EVM Wallet Adapter

  • Import the TorusWalletAdapter from @web3auth/torus-evm-adapter package
  • Create an instance of the adapter along with the configuration
  • Pass the returned instance in to web3auth.configureAdapter
import { TorusWalletAdapter } from "@web3auth/torus-evm-adapter";

const torusAdapter = new TorusWalletAdapter({
  adapterSettings: {
    clientId, //Optional - Provide only if you haven't provided it in the Web3Auth Instantiation Code
    buttonPosition: "bottom-left",
  },
  loginSettings: {
    verifier: "google",
  },
  initParams: {
    buildEnv: "testing",
  },
  chainConfig: {
    chainNamespace: CHAIN_NAMESPACES.EIP155,
    chainId: "0x1",
    rpcTarget: "https://rpc.ankr.com/eth", // This is the mainnet RPC we have added, please pass on your own endpoint while creating an app
    displayName: "Ethereum Mainnet",
    blockExplorerUrl: "https://etherscan.io/",
    ticker: "ETH",
    tickerName: "Ethereum",
    logo: "https://images.toruswallet.io/eth.svg",
  },
});

web3auth.configureAdapter(torusAdapter);

Subscribing the Lifecycle Events​

Subscribing to events help you trigger responses based on the status of the connection of the user. An adapter emits certain events like CONNECTED, CONNECTING and DISCONNECTED etc during login lifecycle of a user. For example, you can use this to show an error message, if the user is not connected to the network. Generally, this is not a required step and should be done only if needed in particular cases.

info

This step is totally optional. If you don't want to use any plugins, feel free to skip this section.

tip

If you're using the uxMode: "redirect" option within your openlogin-adapter configuration, you need to subscribe to the event to handle the logging in implicitly. This is because, when redirected to a different application, the app state is not updated as per the login status. Using a lifecycle method to check this, one can easily handle the login status within the constructor function.

on(EVENT, CALLBACK)​

Web3Auth provides the following lifecycle event to check the login status:

Adapter Events​

EventTrigger with @web3auth/base packageTrigger without packageDescription
ADAPTER_DATA_UPDATEDADAPTER_EVENTS.ADAPTER_DATA_UPDATED"adapter_data_updated"Adapter data is updated within the dApp
NOT_READYADAPTER_EVENTS.NOT_READY"not_ready"Adapter is not yet ready for login
READYADAPTER_EVENTS.READY"ready"Adapter is ready for login
CONNECTINGADAPTER_EVENTS.CONNECTING"connecting"User is connecting to the dApp/ login process is in progress
CONNECTEDADAPTER_EVENTS.CONNECTED"connected"User is logged in and connected with the dApp
DISCONNECTEDADAPTER_EVENTS.DISCONNECTED"disconnected"User is logged out and disconnected from the dApp
ERROREDADAPTER_EVENTS.ERRORED"errored"There has been some error in connecting the user to the dApp
Example​
import { ADAPTER_EVENTS } from "@web3auth/base";

// subscribe to lifecycle events emitted by web3auth
const subscribeAuthEvents = (web3auth: Web3Auth) => {
  web3auth.on(ADAPTER_EVENTS.CONNECTED, (data: CONNECTED_EVENT_DATA) => {
    console.log("connected to wallet", data);
    // web3auth.provider will be available here after user is connected
  });
  web3auth.on(ADAPTER_EVENTS.CONNECTING, () => {
    console.log("connecting");
  });
  web3auth.on(ADAPTER_EVENTS.DISCONNECTED, () => {
    console.log("disconnected");
  });
  web3auth.on(ADAPTER_EVENTS.ERRORED, (error) => {
    console.log("error", error);
  });
  web3auth.on(ADAPTER_EVENTS.ERRORED, (error) => {
    console.log("error", error);
  });
};

Configuring Plugins​

Plugins are essentially extensions to the core functionality of Web3Auth, allowing you to add additional features to your dApp. These features can be used to extend the UI functionalities, making your integration more interoperable, and a lot more, even having the functionality to be customised extremely and to your liking.

info

This step is totally optional. If you don't want to use any plugins, feel free to skip this section.

showWalletConnectScanner()​

Shows the Wallet Connect Scanner to connect with dApps having Wallet Connect login option. This is useful for interoperability with dApps having Wallet Connect login option.

Example​

import { WalletServicesPlugin } from "@web3auth/wallet-services-plugin";

const walletServicesPlugin = new WalletServicesPlugin();
web3auth.addPlugin(walletServicesPlugin); // Add the plugin to web3auth

await walletServicesPlugin.showWalletConnectScanner();

initiateTopup()​

Shows the TopUp modal to select local currency and amount to top up the wallet.

Example​

import { WalletServicesPlugin } from "@web3auth/wallet-services-plugin";

const walletServicesPlugin = new WalletServicesPlugin();
web3auth.addPlugin(walletServicesPlugin); // Add the plugin to web3auth

await walletServicesPlugin.showCheckout(); // Opens the TopUp modal

Initializing Web3Auth​

init()​

The final step in the whole initialization process is the initialize the Web3AuthNoModal instance, ie. web3auth in our case.

This is done by calling the init function of the web3auth instance we created above.

await web3auth.init();

This is a simple function, that doesn't take any input, nor does return anything. It just makes sure that the web3auth instance is initialized and ready for the user to log in.