Blux Core is a JavaScript/TypeScript SDK for adding authentication, Stellar wallet connections, transaction signing, and Soroban interactions to web applications. Users can onboard through supported Stellar wallets, email, passkeys, and social login, while developers get a consistent API and customizable authentication experience.
- Website: blux.cc
- Documentation: docs.blux.cc
- Live Demo: demo.blux.cc
- Dashboard: dashboard.blux.cc
- Framework-Agnostic: Use Blux Core with vanilla JavaScript, TypeScript, or any frontend framework.
- Multi-Wallet Support: Integrate Stellar wallets such as Rabet, xBull, LOBSTR, Freighter, Albedo, HOT Wallet, Hana, and more.
- Email, Passkey & Social Authentication: Onboard users without requiring them to install or manage a traditional wallet.
- Transaction Signing: Connect wallets and request transaction signatures through a consistent interface.
- Soroban Support: Add Stellar smart contract interactions to your application.
- Customizable UI: Adjust themes, fonts, backgrounds, logos, border radius, text colors, and other interface elements.
- Wallet Configuration: Include or exclude individual wallets and control their display order.
- Configurable Networks: Choose the Stellar networks supported by your application and set a default network.
- Custom Explorer: Configure the block explorer used for account and transaction links.
- Localization: Provide the authentication experience in multiple supported languages.
- User Management & Analytics: Review authentication methods, login activity, timestamps, and associated wallet addresses through the Blux dashboard.
- Testing Tools: Use predefined test accounts and reusable OTP credentials in configured testing environments.
- Multiple Projects: Create and manage multiple applications from a single Blux account.
- Future-Proof: More wallets and authentication methods will be added based on community feedback.
Install Blux Core through npm:
npm i @bluxcc/coreBlux Core can also be loaded directly in the browser through a CDN.
<!DOCTYPE html>
<script src="https://unpkg.com/@bluxcc/core/dist/index.iife.js"></script>
<button id="loginBtn">Login with Blux</button>
<script>
Blux.createConfig({
appName: 'My App',
appId: 'GET_FROM_BLUX_DASHBOARD',
networks: [Blux.core.networks.mainnet],
});
document.getElementById('loginBtn').onclick = async () => {
await Blux.blux.login();
};
</script>import { blux, core, createConfig } from '@bluxcc/core';
createConfig({
appName: 'My App',
appId: 'GET_FROM_BLUX_DASHBOARD',
networks: [core.networks.mainnet],
});
document.getElementById('loginBtn').onclick = async () => {
await blux.login();
};Create a project through the Blux Dashboard to obtain your application ID. You can create and manage multiple projects from the same account.
Developers can customize various UI elements:
- Themes & Fonts
- Backgrounds, Logos
- Border Radius & Text Colors
- Authentication Limits (Free tier supports 500-1000 accounts per auth method)
Developers can also configure:
- Enabled authentication methods
- Included and excluded wallets
- Wallet display order
- Supported networks
- Default network
- Block explorer
- Interface language
Configuration options can be set via the BluxProvider config or environment variables.
The Blux dashboard provides information about the users who have connected to your application.
Available information includes:
- Authentication method
- Login and connection timestamps
- Associated wallet addresses, when available
- Recent authentication activity
- Individual user information
This information can help developers understand how their applications are being used and troubleshoot authentication or wallet connection issues.
Blux provides predefined accounts for development and quality assurance.
Developers can use preset email identities together with a reusable testing OTP. This makes it possible to test the complete login process repeatedly without waiting for real email delivery or using personal user information.
These credentials are intended only for the configured testing environment. Refer to the Blux documentation for the current testing credentials and setup instructions.
Currently supported connection methods:
- Freighter
- Rabet
- WalletConnect
- HOT Wallet
- Hana
- xBull
- LOBSTR
- Ledger
- Albedo
- Klever Wallet
- Bitget Wallet
- OneKey
- CactusLink
- Fordefi
- Trezor
- Passkey
Currently supported languages:
- English
- Spanish
- Portuguese
- French
- German
- Russian
- Chinese
- Japanese
- Korean
- No Forking or Unauthorized Modifications: Removing references to Blux Team or forking without attribution is strictly prohibited.
- Custom Licensing Available: Contact us at support@blux.cc to discuss licensing options.
For support, licensing, custom SMS authentication, or other inquiries, reach out via:
- Email: support@blux.cc
- X: @BluxOfficial
Blux is evolving. Follow our updates on X for:
- Additional OAuth and Social Authentication Methods
- More Wallet Integrations
- Enhanced Developer Hooks
- Expanded Soroban Support
- Enhanced Customization, Analytics, and Security Features