hub / github.com/Web3Auth/Auth

github.com/Web3Auth/Auth @v11.8.1

repository ↗ · DeepWiki ↗ · release v11.8.1 ↗ · + Follow

355 symbols 877 edges 86 files 41 documented · 12%

What it actually does AI analysis from the code graph — generated when you open this

loading…

README

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.

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/index.js in es6 format
commonjs build dist/lib.cjs/index.js in es5 format

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 22+
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

Extension points exported contracts — how you extend this code

IAuthError (Interface)

(no doc) [2 implementers]

src/core/errors.ts

IdMapValue (Interface)

* @deprecated Part of the JRPC V1 stream middleware. Use createEngineStreamV2 instead.

src/jrpc/interfaces.ts

AuthSessionData (Interface)

(no doc)

src/utils/interfaces.ts

EngineStreamOptions (Interface)

(no doc)

src/jrpc/jrpcEngine.ts

BaseLoginParams (Interface)

(no doc)

src/utils/interfaces.ts

JRPCBase (Interface)

(no doc)

src/jrpc/interfaces.ts

AuthRequestPayload (Interface)

(no doc)

src/utils/interfaces.ts

JRPCResponse (Interface)

(no doc)

src/jrpc/interfaces.ts

Core symbols most depended-on inside this repo

handle

called by 127

src/jrpc/jrpcEngine.ts

create

called by 117

src/jrpc/v2/jrpcEngineV2.ts

src/jrpc/jrpcEngine.ts

set

called by 41

src/jrpc/v2/MiddlewareContext.ts

serializeJrpcError

called by 29

src/jrpc/errors/utils.ts

providerFromEngine

called by 27

src/jrpc/v2/providerUtils.ts

stringify

called by 21

src/utils/jrpc.ts

Shape

Function 175

Method 115

Class 40

Interface 25

Languages

TypeScript100%

Modules by API surface

src/core/auth.ts32 symbols

src/jrpc/jrpcEngine.ts27 symbols

src/core/errors.ts23 symbols

test/v2/jrpcEngineV2.test.ts15 symbols

src/jrpc/v2/jrpcEngineV2.ts15 symbols

src/jrpc/errors/utils.ts14 symbols

src/utils/jrpc.ts13 symbols

src/jrpc/jrpc.ts13 symbols

src/jrpc/interfaces.ts12 symbols

src/core/AuthProvider.ts12 symbols

src/jrpc/basePostMessageStream.ts11 symbols

test/utils.ts10 symbols

For agents

$ claude mcp add Auth \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact