Skip to content
/ Auth Public

Pluggable auth infrastructure for Web3 wallets and dapps

Notifications You must be signed in to change notification settings

Web3Auth/Auth

Folders and files

NameName
Last commit message
Last commit date

Latest commit

e533963 Â· Apr 14, 2025
Feb 9, 2025
Jul 31, 2024
Apr 1, 2025
Apr 14, 2025
Mar 19, 2025
Oct 13, 2021
Jul 31, 2024
Feb 9, 2025
Jan 19, 2021
Aug 4, 2023
Feb 9, 2025
Aug 15, 2023
Feb 9, 2025
Apr 14, 2025
Apr 14, 2025
Sep 3, 2024
Jun 30, 2022
Jul 29, 2024
Sep 3, 2024

Repository files navigation

Auth SDK by Web3Auth

Web3Auth is where passwordless auth meets non-custodial key infrastructure for Web3 apps and wallets. By aggregating OAuth (Google, Twitter, Discord) logins, different wallets and innovative Multi Party Computation (MPC) - Web3Auth provides a seamless login experience to every user on your application.

code style: prettier npm |

Introduction

Your Web3Auth account is a cryptographic key that acts as a proxy to traditional SSOs. Accounts are secured across user devices and authentication methods - there is no central server, no data honey pot. It combines both CustomAuth and tKey and provides you with a nice UI and UX flows

Features

  • Typescript compatible. Includes Type definitions

Please refer to docs for API Reference available here.

Installation

Bundling

Each sub package is distributed in 3 formats

  • esm build dist/lib.esm.js in es6 format
  • commonjs build dist/lib.cjs.js in es5 format
  • umd build dist/auth.umd.min.js in es5 format without polyfilling corejs minified

By default, the appropriate format is used for your specified usecase You can use a different format (if you know what you're doing) by referencing the correct file

The cjs build is not polyfilled with core-js. It is upto the user to polyfill based on the browserlist they target

Directly in Browser

CDN's serve the non-core-js polyfilled version by default. You can use a different

jsdeliver

<script src="https://cdn.jsdelivr.net/npm/auth"></script>

unpkg

<script src="https://unpkg.com/auth"></script>

Build

Ensure you have a Node.JS development environment setup:

git clone https://github.com/web3auth/Auth.git
cd Auth
npm i
npm run build

To run tests:

npm test

Requirements

  • This package requires a peer dependency of @babel/runtime
  • Node 20+
  • You will need to whitelist your domain on developer dashboard

💬 Troubleshooting and Discussions

  • Have a look at our GitHub Discussions to see if anyone has any questions or issues you might be having.
  • Checkout our Troubleshooting Documentation Page to know the common issues and solutions
  • Join our Discord to join our community and get private integration support or help with your integration.

License

AuthSdk is MIT Licensed

TODO: fix demo app ci