Skip to content
Web3AuthPublic

About

Pluggable auth infrastructure for Web3 wallets and dapps

Topics

Resources

Stars

139 stars

Watchers

2 watching

Forks

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 2 formats

  • esm build dist/lib.esm/index.js targeting ES2022
  • commonjs build dist/lib.cjs/index.js targeting ES2022

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 builds are not polyfilled. 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

To lint, format check and type check:

npm run check
npm run typecheck

Requirements

💬 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

About

Pluggable auth infrastructure for Web3 wallets and dapps

Topics

Resources

Stars

139 stars

Watchers

2 watching

Forks

Releases

Packages

Used by

Contributors

Languages