Skip to main content

Using PnP Web Modal SDK

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:

  • connect() - Showing the Modal and Logging in the User
  • provider() - Returns the native provider that can be used to make different blockchain transactions.
  • connected() - Returns true or false depending on whether the web3auth instance is available or not.
  • getUserInfo() - Getting the User's Information
  • authenticateUser() - Getting the idToken from Web3Auth
  • addChain() - Add chain config details to the connected adapter.
  • switchChain() - Switch chain as per chainId already added to chain config.
  • getAdapter() - Get the connected adapter instance.
  • configureAdapter() - Configure the adapter instance.
  • clearCache() - Clear the cache.
  • addPlugin() - Add a plugin to Web3Auth.
  • logout() - Logging out the User

Logging in the User​

connect()​

You can show the modal in the browser by calling connect() function on web3auth instance. Your user can choose their preferred login method and access your application.

await web3auth.connect();

Returns​

connect(): Promise<IProvider | null>;

On successful login, the connect() function returns a IProvider instance. This instance contains the respective provider corresponding to your selected blockchain. You can use this provider to connect your user to the blockchain and make transactions.

On unsuccessful login, this function will return a null value.

tip

Read more about connecting your users with the selected blockchain in the Providers SDK Reference.

Get a native provider​

provider()

Returns the native provider that can be used to make different blockchain transactions.

Returns​

get provider(): IProvider | null;

Get connected status​

connected()

Returns true or false depending on whether the web3auth instance is available or not.

Returns​

get connected(): boolean;

Get User's Information​

getUserInfo()​

You can get the information about connected user by calling getUserInfo() function.

note

This function will only return information based on the connected adapter. These details are not stored anywhere and are fetched from the adapter during the connection and remain in the session.

await web3auth.getUserInfo();

Returns​

VariableTypeDescription
emailstringEmail of the connected user
namestringName of the connected user
profileImagestringProfile image of the connected user
aggregateVerifierstringDetails of the aggregate verifier - if present
verifierstringDetails of the verifier (verifier type, ie. torus, metamask, openlogin etc.)
verifierIdstringVerifier ID - if custom authentication is enabled, it will show the verifier identifier you set on dashboard
typeOfLoginstringType of login done by the user (like google, facebook, twitter, github, etc.)
dappSharestringIf you are using a Custom Verifier, you can get a dapp share after successful login. (dappShare is a 24 word seed phrase). This share can act as a replacement to your user's device share.
idTokenstringJWT token (Note: This is issued by Web3Auth and is not bound to your OAuth provider)
oAuthIdTokenstringJWT token (Note: This is issued by your OAuth provider and will be issued only for custom verifiers.)
oAuthAccessTokenstringAccess token (Note: This is issued by your OAuth provider and will be issued only for custom verifiers.)

Sample Response​

{
  "email": "john@gmail.com",
  "name": "John Dash",
  "profileImage": "https://lh3.googleusercontent.com/a/Ajjjsdsmdjmnm...",
  "aggregateVerifier": "tkey-google-lrc",
  "verifier": "torus",
  "verifierId": "john@gmail.com",
  "typeOfLogin": "google",
  "dappShare": "<24 words seed phrase>", // will be sent only incase of custom verifiers
  "idToken": "<jwtToken issued by Web3Auth>",
  "oAuthIdToken": "<jwtToken issued by OAuth Provider>", // will be sent only incase of custom verifiers
  "oAuthAccessToken": "<accessToken issued by OAuth Provider>" // will be sent only incase of custom verifiers
}

Get idToken​

authenticateUser()​

You can get the idToken from Web3Auth by calling authenticateUser() function.

note

This function will only return information based on the connected adapter. These details are not stored anywhere and are fetched from the adapter during the connection and remain in the session.

await web3auth.authenticateUser();

Returns​

ParameterTypeDescription
iatnumberThe "iat" (issued at) claim identifies the time at which the JWT was issued.
audstringThe "aud" (audience) claim identifies the recipients that the JWT is intended for. (Here, it's the dapp client_id)
issstringThe "iss" (issuer) claim identifies who issued the JWT. (Here, it's Web3Auth https://api.openlogin.com/)
emailstringThe email address of the user (optional)
namestringThe name of the user (optional)
profileImagestringThe profile image of the user (optional)
verifierstringWeb3auth's verifier used while user login
verifierIdstringUnique user id given by OAuth login provider
aggregateVerifierstringName of the verifier if you are using a single id verifier (aggregateVerifier) (optional)
expnumberThe "exp" (expiration time) claim identifies the expiration time on or after which the JWT MUST NOT be accepted for processing.
walletsarraylist of wallets for which this token is issued:
  • curve "secp256k1" (default) or "ed25519"
    You can specify which curve you want use for the encoded public key in the login parameters
  • type "web3auth_key" incase of social logins
  • public_key compressed public key derived based on the specified curve

Sample Response​

{
  "iat": 1655835494,
  "aud": "BCtbnOamqh0cJFEUYA0NB5YkvBECZ3HLZsKfvSRBvew2EiiKW3UxpyQASSR0artjQkiUOCHeZ_ZeygXpYpxZjOs",
  "iss": "https://api.openlogin.com/",
  "email": "xyz@xyz.com",
  "name": "John Doe",
  "profileImage": "https://lh3.googleusercontent.com/a/AATXAJx3lnGmHiM4K97uLo9Rb0AxOceH-dQCBSRqGbck=s96-c",
  "verifier": "torus",
  "verifierId": "xyz@xyz.com",
  "aggregateVerifier": "tkey-google-lrc",
  "exp": 1655921894,
  "wallets": [
    {
      "public_key": "035143318b83eb5d31611f8c03582ab1200494f66f5e11a67c34f5581f48c1b70b",
      "type": "web3auth_key",
      "curve": "secp256k1"
    }
  ]
}

Add Chain​

addChain()​

To add a chain config to a connected adapter, you need to call addChain() function. This function helps you add the chain config by taking the following parameter:

VariableDescription
chainConfigCustomChainConfig for the chain you want to add.
await web3auth.addChain({
  chainId: "0xaa36a7",
  displayName: "Ethereum Sepolia",
  chainNamespace: CHAIN_NAMESPACES.EIP155,
  tickerName: "Sepolia",
  ticker: "ETH",
  decimals: 18,
  rpcTarget: "https://rpc.ankr.com/eth_sepolia",
  blockExplorerUrl: "https://sepolia.etherscan.io",
  logo: "https://images.toruswallet.io/eth.svg",
  isTestnet: true,
});

Switch Chain​

switchChain()​

To switch the Chain to the added chain config, you need to call switchChain() function. This function takes the following parameter:

VariableDescription
{ chainId: "0xaa36a7" }chainId of the added chain config, e.g { chainId: "0xaa36a7" }
await web3auth.switchChain({ chainId: "0xaa36a7" });

Logging out the User​

web3auth.logout()​

You can disconnect from connected wallet using logout function.

await web3auth.logout();

Type Reference​

logout(options?: { cleanup: boolean; }): Promise<void>;

Connecting to a Blockchain​

For Connecting to Blockchain and making RPC calls within your dApp, you can use the IProvider instance returned while logging in the user. This instance gives you the respective provider for your selection of blockchain. This provider can be used to interact with the connected chain using exposed functions within the provider.

Web3Auth is chain agnostic, ie. be it any chain you're connecting to, you can use Web3Auth to connect to it. You can use the EVM or Solana provider, that contain the native functions to connect to the blockchain or use the private key directly to connecting to the respective blockchain.

Currently web3auth supports providers for both EVM and Solana chains. For other chains, one can easily get the private key from the base provider from Web3Auth.

tip

Checkout the Providers SDK Reference to learn more.

Fetching the Connected Adapter​

You can configure a lot of adapters in the Web3Auth instance. If you have installed one of the adapters, you can fetch the connectedAdapterName variable to get the currently used adapter.

// Initialized Web3Auth instance

// User is logged in using one of the adapters (metamask, torus-evm, etc.)

const adapterName = web3auth.connectedAdapterName;
// contains the currently used adapter name (metamask, torus-evm, etc.)