Auth sdk for web3auth
npm install @web3auth/auth> 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 |
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
- Typescript compatible. Includes Type definitions
Please refer to docs for API Reference available here.
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
CDN's serve the non-core-js polyfilled version by default. You can use a different
jsdeliver
``js`
unpkg
`js`
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
- This package requires a peer dependency of @babel/runtime
- Node 20+
- You will need to whitelist your domain on developer dashboard
- 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.
AuthSdk` is MIT Licensed
TODO: fix demo app ci