Practical overview
When it fits
Use Bitcoin Connect when a web application needs to connect users with multiple Lightning wallets and interact with them through WebLN across desktop or mobile browsers, including cases where relying on a browser extension is unsuitable.
Who it is for
- Web developers adding Lightning wallet connectivity to websites.
- Teams building browser-based Lightning payment or invoice flows.
- Developers creating mobile-friendly web applications or PWAs that need wallet selection.
- React, Angular, Vue, Solid.js and pure-HTML developers seeking a WebLN integration layer.
Documented uses
- Connect a website to a user's Lightning wallet.
- Request a WebLN provider from a browser application.
- Send a Lightning invoice through a connected provider.
- Present wallet-selection and invoice-payment interfaces.
- Add Lightning connectivity to a PWA or mobile browser experience.
Requirements & limits
The implementation is available in a public GitHub repository under the MIT license. The repository describes the package as alpha software.
- The core package uses web components and can work with pure HTML and multiple JavaScript frameworks.
- The repository documents separate React and web-components packages, plus a CDN route without build tools.
- The library supports desktop and mobile browsers and progressive web apps.
- Next.js and other server-side-rendered applications require client-side import and rendering.
- The project warns of possible breaking changes or bugs because WebLN and Nostr Wallet Connect features are not finalized.
Check current requirements in the official documentation. Source-based guidance does not mean OpenViST has run or independently tested this project.
Add a Lightning wallet connection to a web app
Set up Bitcoin Connect and expose a wallet connection flow using its documented JavaScript or HTML integration.
Before you start
- A web application.
- The @getalby/bitcoin-connect package, the React package, or a browser-based module import.
- An application name for initialization.
Steps
Install the web-components or React package with npm or Yarn, or import the package from a documented CDN in an HTML module.
Initialize Bitcoin Connect with the application name.
Render its connection button or call the documented modal function to open the wallet-connection flow.
Request a WebLN provider when the application needs to use the WebLN API.
Expected outcome
The web application has a documented Bitcoin Connect connection flow and can request a WebLN provider for Lightning interactions.
Guide limitations
- The project labels the package alpha and warns that WebLN and Nostr Wallet Connect features may change.
- The documented Next.js setup requires client-side importing and rendering.
- A provider connection is needed for the WebLN payment example.
Compare options for Wallet connections
These projects document a common task and share a project role. This is a source-based comparison, not an execution benchmark or a guarantee of interchangeability.
| Project | Documented purpose | Platform | Access and requirements |
|---|---|---|---|
| Bitcoin Connect | Connect a website to a user's Lightning wallet. | Browser Extension, Mobile, Web | The implementation is available in a public GitHub repository under the MIT license. The repository describes the package as alpha software. |
| Dioxus Wallet Adapter | Add Solana wallet connectivity to a Dioxus web application. | Web | |
| Vue CLI Plugin Web3Modal | Configure injected browser and WalletConnect provider options. | Web |
Sources & review
Source record details
- Source availability
- Active
- Sources checked
- 3 October 2026
- Original website title
- getAlby/bitcoin-connect · Official homepage title · retained in its source language