JustWeb3 Widget
@justweb3/widget • Docs
@justweb3/widget
The @justweb3/widget library offers a complete identity solution for dApps. In just a few minutes, you can start issuing ENS subnames, authenticating users with SIWENS, managing profiles securely, and preventing Sybil attacks through social verifications and Proof of Personhood. The widget also integrates seamlessly with the Admin Dashboard to provide analytics and community engagement tools.
For detailed documentation, visit the official JustaName Documentation.
Try it out today on Demo.
Table of Contents
Overview
The JustWeb3 Widget is designed to simplify identity management for dApps. It provides:
ENS Subname Issuance: Issue branded subnames for your users.
SIWENS Authentication: Secure user authentication via ENS domains.
Profile Management: Allow users to update and manage their profiles.
Social Verifications & Proof of Personhood: Prevent Sybil attacks with social and zero-knowledge proofs.
Plugins: Extend the widget’s capabilities with custom plugins.
Admin Dashboard: Monitor subname usage and engage with your community.
Installation
Install the widget with your preferred package manager:
You will also need additional dependencies:
Setup
Below is a sample setup for Next.js or Vite projects. The widget works with RainbowKit or any other wallet provider like WalletConnect, Privy, or Web3Auth.
Example Integration
Configuration
API Key Setup
Sign Up: Create an account in the Admin Dashboard.
Configure ENS Domain: Set up your domain, or purchase one if needed.
Generate API Key: Save your API key securely—it will not be retrievable later.
Widget Configuration
Appearance Customization
The widget supports easy appearance customization to fit your dApp's branding.
Primary Color: Controls buttons, links, and accents.
Background Color: Matches the widget’s background with your design.
Destructive Color: Used for warnings or destructive actions.
Logo: Add a custom logo to enhance branding.
Network Configuration
The widget supports Ethereum Mainnet and Sepolia Testnet. Use public RPCs or provide custom URLs.
If no custom provider is specified, the widget defaults to public RPC URLs.
Features
Complete ENS Management: Claim, update, and authenticate ENS subnames.
JustEnsCard Component: Displays detailed ENS data for any name.
SIWENS Authentication: Secure, decentralized sign-in using ENS.
Extendable via Plugins: Add new features with ease.
Admin Dashboard Integration: Monitor user activity and subname management.
Flexible Wallet Integration: Works with RainbowKit, WalletConnect, Privy, and more.
License
This project is licensed under the MIT License. For more details, refer to the official JustaName Documentation.
Last updated