@getalby/bitcoin-connect
Advanced tools
Web components to connect to a lightning wallet and power a website with WebLN
This project includes web components for connecting to Lightning wallets and enabling WebLN. Websites only need to interface with WebLN to connect with multiple wallets, just like the Alby extension. However, no extension is needed to be installed - Bitcoin Connect is provided by the website. Users can connect from both desktop and mobile devices, using their favorite browser. PWAs just work. Bitcoin Connect's components work with pure HTML and all Javascript libraries or frameworks, such as React, Angular, Vue, Solid.js, etc.
🆕 Bitcoin Connect also supports a nice invoice payment UI that gives a multitude of options to a user to pay an invoice. Accept payments with a single line of code.
There are multiple breaking changes in v3. See our migration guide here. Click here for v2.
🚧WARNING🚧: this package is currently in Alpha. It's got awesome features, but is using new features of protocols such as WebLN and NWC which have not been finalized, and there may be breaking changes or bugs.
npm install @getalby/bitcoin-connect-react or yarn add @getalby/bitcoin-connect-react
npm install @getalby/bitcoin-connect or yarn add @getalby/bitcoin-connect
You can use Bitcoin Connect without any build tools:
<script type="module">
import {launchModal} from 'https://esm.sh/@getalby/bitcoin-connect@3.0.0'; // jsdelivr.net, skypack.dev also work
// use Bitcoin connect API normally...
launchModal();
// or if you just want access to the web components:
import 'https://esm.sh/@getalby/bitcoin-connect@3.0.0';
</script>
<!-- Bitcoin Connect components are now available -->
<bc-button></bc-button>
import {
init,
launchModal,
launchPaymentModal,
requestProvider,
} from '@getalby/bitcoin-connect-react';
// Initialize Bitcoin Connect
init({
appName: 'My Lightning App', // your app name
});
// launch modal programmatically
await launchModal();
// launch modal to receive a payment
await launchPaymentModal({
invoice: 'lnbc...',
onPaid: ({preimage}) => alert('Paid: ' + preimage), // NOTE: only fired if paid with WebLN - see full api documentation below
});
// or request a WebLN provider to use the full WebLN API
const weblnProvider = await requestProvider();
const {preimage} = await weblnProvider.sendPayment('lnbc...');
Continue further down for the full Bitcoin Connect API.
import {Button, init, launchModal, launchPaymentModal, closeModal, requestProvider, Connect, SendPayment} from '@getalby/bitcoin-connect-react';
// Initialize Bitcoin Connect
init({
appName: "My Lightning App", // your app name
})
// render the Bitcoin Connect button
<Button onConnect={(provider) => {
const {preimage} = await provider.sendPayment("lnbc...");
}}/>
// render the connect flow on its own without the modal
<Connect/>
// render the send payment flow on its own without the modal (for E-Commerce flows)
// set the `payment` prop to override the payment status if a payment was made externally
<Payment invoice="lnbc..." onPaid={(response) => alert("Paid! " + response.preimage)} payment={{preimage: 'my-preimage'}}/>
// request a provider
<button onClick={() => {
// if no WebLN provider exists, it will launch the modal
const weblnProvider = await requestProvider();
const { preimage } = await weblnProvider.sendPayment("lnbc...")
}}>
Request WebLN provider
</button>
// open modal programmatically to connect a wallet
<button onClick={() => launchModal()}>
Programmatically launch modal
</button>
// open modal programmatically to pay an invoice (for one-off payments)
<button onClick={() => launchPaymentModal({invoice: "lnbc...", onPaid: ({preimage}) => alert("Paid: " + preimage)})}>
Programmatically launch payment modal
</button>
// close modal programmatically
closeModal();
Make sure to only import and render the components client side. This can be done either by creating a wrapper component with using next/dynamic with ssr: false (and add the 'use client' directive when using the NextJS app router), or a dynamic import e.g.
"use client"
import dynamic from 'next/dynamic';
const Button = dynamic(
() => import('@getalby/bitcoin-connect-react').then((mod) => mod.Button),
{
ssr: false,
}
);
// Render the Button normally
<Button />
// or to use the API:
<button
onClick={async () => {
const launchModal = await import('@getalby/bitcoin-connect-react').then(
(mod) => mod.launchModal
);
launchModal();
}}
>
Launch modal
</button>
// to set the global webln object:
useEffect(() => {
// init bitcoin connect to provide webln
const {onConnected} = await import('@getalby/bitcoin-connect-react').then(
(mod) => mod.onConnected
);
const unsub = onConnected((provider) => {
window.webln = provider;
});
return () => {
unsub();
};
}, []);
See NextJS and NextJS legacy demos for full examples.
💡 The core Bitcoin Connect package works on all frameworks because it is powered by web components. However, a wrapper can simplify usage of Bitcoin Connect.
Use another popular framework? please let us know or feel free to create a PR for a wrapper. See the React package for an example implementation.
Bitcoin Connect exposes the following web components for allowing users to connect their desired Lightning wallet:
<bc-button/> - launches the Bitcoin Connect Modal on click
title - (optional) change the title of the button<bc-pay-button/> - launches the Bitcoin Connect Payment Modal on click
invoice - BOLT11 invoice. Modal will only open if an invoice is settitle - (optional) change the title of the buttonpreimage - (optional) set this if you received an external paymentclick - fires when the button is clicked. You can load an invoice here and set it on the button using setAttribute('invoice', 'lnbc...') which will then automatically launch the modalbc:onpaid Experimental - fires event with WebLN payment response in event.detail (contains preimage)<bc-connect/> - render connect wallet UI without modal<bc-payment/> - render a payment request UI without modal
invoice - BOLT11 invoicepaid - set to true to mark payment was made externallybc:onpaid Experimental - fires event with WebLN payment response in event.detail (contains preimage)import {init} from '@getalby/bitcoin-connect-react';
// Initialize Bitcoin Connect
init({
appName: 'My Lightning App', // your app name
// filters: ["nwc"],
// showBalance: true,
});
appName - Name of the app requesting access to wallet. Currently used for NWC connections (Alby and Mutiny)filters - Filter the type of connectors you want to show. Example: "nwc" (only show NWC connectors).showBalance - If false, do not request the connected wallet's balanceWith one line of code you can ensure you have a WebLN provider available and ready to use. If one is not available, the Bitcoin connect modal will be launched.
import {requestProvider} from '@getalby/bitcoin-connect';
const provider = await requestProvider();
await provider.sendPayment('lnbc...');
The modal can then be launched with:
import {launchModal} from '@getalby/bitcoin-connect';
launchModal(); // A `<bc-modal/>` element will be injected into the DOM
To receive a payment the modal can be programmatically opened with:
import {launchPaymentModal} from '@getalby/bitcoin-connect';
const {setPaid} = launchPaymentModal({
invoice: 'lnbc...',
onPaid: (response) => {
clearInterval(checkPaymentInterval);
alert('Received payment! ' + response.preimage);
},
onCancelled: () => {
clearInterval(checkPaymentInterval);
alert('Payment cancelled');
},
});
// below is an example of LNURL-verify from https://github.com/getAlby/js-lightning-tools
// you can write your own polling function to check if your invoice has been paid
// and then call the `setPaid` function.
const checkPaymentInterval = setInterval(async () => {
const paid = await invoice.verifyPayment();
if (paid && invoice.preimage) {
setPaid({
preimage: invoice.preimage,
});
}
}, 1000);
Note: for P2P payments made externally there is no way for Bitcoin Connect to know when the payment has happened.
launchPaymentModalis more for simplifying e-commerce usecases where you are able to check the invoice yourself.
import {closeModal} from '@getalby/bitcoin-connect';
closeModal();
import {disconnect} from '@getalby/bitcoin-connect';
disconnect();
window.bitcoinConnect.isConnected();
This event fires when a WebLN provider is made available.
import {onConnected} from '@getalby/bitcoin-connect';
const unsub = onConnected(async (provider) => {
const {preimage} = await provider.sendPayment('lnbc...');
});
unsub();
This event fires when a WebLN provider is initializing.
import {onConnecting} from '@getalby/bitcoin-connect';
const unsub = onConnecting(async () => {
// do something...
});
unsub();
This event fires when the user manually disconnects from Bitcoin Connect.
import {onDisconnected} from '@getalby/bitcoin-connect';
const unsub = onDisconnected(async () => {
// do something...
});
unsub();
This event fires when the Bitcoin Connect modal opens.
import {onModalOpened} from '@getalby/bitcoin-connect';
const unsub = onModalOpened(async () => {
// do something...
});
unsub();
This event fires when the Bitcoin Connect modal closes.
import {onModalClosed} from '@getalby/bitcoin-connect';
const unsub = onModalClosed(async () => {
// do something...
});
unsub();
WARNING: webln is no longer injected into the window object by default. If you need this, execute the following code:
import {onConnected} from '@getalby/bitcoin-connect';
onConnected((provider) => {
window.webln = provider;
});
More methods coming soon. Is something missing that you'd need? let us know!
Providers also should fire a webln:connected event. See webln.guide.
These variables must be set at the root or on a container element wrapping any bitcoin connect components.
html {
--bc-color-brand: #196ce7; /* Only 6-digit hex and rgb formats are supported! */
}
Optional CSS variables for further customization:
html {
--bc-color-brand-dark: #3994ff; /* use a different brand color in dark mode */
--bc-brand-mix: 100%; /* how much to mix the brand color with default foreground color */
}
💡 using near-white or black brand colors? either set a lower
bc-brand-mixor make sure to use an off-white forbc-color-brandand off-black forbc-color-brand-darkto avoid conflicts with the modal background color.
Bitcoin Connect uses prefers-color-scheme to automatically detect light/dark mode.
In case your site uses a manual theme switcher, you can force a theme by following these steps:
see an example here
globalThis.bcDarkMode = "class" before any bitcoin connect components are rendered"dark" must be added as a classname to the document to enable dark mode (e.g. <html class="dark"> or document.documentElement.classList.add('dark')) otherwise light mode will be forced.import { WebLNProviders, requestProvider } from "@getalby/bitcoin-connect";
const provider = await requestProvider();
if (provider instanceof WebLNProviders.NostrWebLNProvider) {
provider.nostrWalletConnectUrl;
}
if (provider instanceof WebLNProviders.LNCWebLNProvider) {
provider.lnc.lnd.lightning.listInvoices(...);
}
if (provider instanceof WebLNProviders.LnbitsWebLNProvider) {
provider.requestLnbits('GET', '/api/v1/wallet');
}
See Pure HTML
See React
See NextJS
See NextJS Legacy
Open demos
Run yarn install && (cd dev/vite && yarn install)
Run yarn dev
Open dev
yarn build
yarn test
We are happy to help, please contact us or create an issue.
Bitcoin Connect provides multiple options to the user to connect to a lightning wallet, each compatible with WebLN. Any already-existing providers of WebLN (such as an installed WebLN extension like Alby) are detected and offered, as well as options to create a new WebLN provider through protocols such as NWC. No matter which option you choose, a WebLN provider will become available for the website to use to interact with your lightning wallet. Similar to the Alby extension, new options (called Connectors) can be easily added as they all follow a common, simple interface. As long as there is a way to connect to a lightning wallet through Javascript, a connector can be created for it in Bitcoin Connect. We welcome any and all contributions for new connectors!
Yes! that's the main benefit.
Yes. It will use the desktop extension as the default connector if it exists.
That depends. The connection to your lightning node / wallet needs to be asynchronous so that you can use Bitcoin Connect natively on mobile websites or PWAs.
It will only work for the connectors that are shown in the modal. Some of these connectors (e.g. the Alby Browser Extension) allow to connect multiple wallets themselves. Feel free to contribute to add a new connector.
Yes. Your connection is saved to localStorage
You should have a certain level of trust on the website you decide to connect your wallet with, and that they ensure there is no malicious third-party scripts which would intend to read the wallet connection configuration, either from memory or storage. Connectors with budget controls or confirmation dialogs (Alby extension or NWC) are recommend so you have full control over your connection.
Bitcoin Connect cannot detect payments made externally. It's up to your app to detect the payment and then programmatically close the modal using the exposed closeModal function.
The global window.webln object can be overridden if there are multiple providers, leading to unexpected behaviour. We recommend using the requestProvider function to obtain a WebLN provider instead of relying on the global window object.
Bitcoin Connect must be imported at the root component or on every component that requires webln to ensure webln is available. If you only import the button in your settings page, you'll still need to import the library where you want to make a lightning payment. We recommend using the requestProvider function.
This project is powered by Lit.
See Get started on the Lit site for more information.
Bitcoin Connect is a BOLT FUN Legends of Lightning vol.2 finalist. Follow our project and journey.
FAQs
Web components to connect to a lightning wallet and power a website with WebLN
The npm package @getalby/bitcoin-connect receives a total of 398 weekly downloads. As such, @getalby/bitcoin-connect popularity was classified as not popular.
We found that @getalby/bitcoin-connect demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
Socket's threat research team has detected five malicious npm packages targeting Roblox developers, deploying malware to steal credentials and personal data.
Security News
vlt introduced its new package manager and a serverless registry this week, innovating in a space where npm has stagnated.
Security News
Research
The Socket Research Team uncovered a malicious Python package typosquatting the popular 'fabric' SSH library, silently exfiltrating AWS credentials from unsuspecting developers.