Skip to main content

Web3Auth Core Kit Single Factor Auth Node.js SDK

Web3Auth's @web3auth/node-sdk SDK is a simple and easy-to-use SDK in your Node.js backend to get the same experience as Web3Auth frontend SDKs.

This SDK gives you semi-custodial keys

The @web3auth/node-sdk SDK gives you the simplest flow for onboarding a user with Web3Auth. The user just needs to click on the login button, connect to their favorite social account (OAuth) or any passwordless flow, like email passwordless, biometric authentication, etc. and a private key is generated for them. This flow has a 1/1 Key Share setup and the whole key via Web3Auth Auth Network key shares is provided directly to your app, and reconstructed within it.

This flow is still non-custodial since the nodes in the Web3Auth network have a 5/9 consensus mechanism to generate the key shares. However, one can claim that this flow is custodial to the OAuth Login provider since this is directly generated using credentials provided by them.

Hence we can call this flow a semi-custodial flow, and encourage users to enable MFA to have a 2/3 Key Share setup, which is fully non-custodial.

This Documentation is based on the 3.2.0 SDK Version.

Requirements

  • This is a backend SDK and can be used in any node environment
  • Basic knowledge of NodeJS and NPM
  • One needs to re-initialize the SDK for each new user.
note

The minimum pricing plan to use this SDK in a production environment is the Growth Plan since custom verifier setup is a needed feature for Core Kit SDKs. You can use this SDK with all features enabled in the development environment for free.

Resources

  • Quick Start: Get Started with an easy to follow integration of Web3Auth

  • Example Applications: Explore our example applications and try the SDK yourself.

  • Troubleshooting: Find quick solutions to common issues faced by developers.

  • Source Code: Web3Auth is open sourced. You can find the source code on our GitHub repository.

  • Community Support Portal: Join our community to get support from our team and other developers.