Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/getAlby/lightning-browser-extension

The Bitcoin Lightning Browser extension that connects to different wallet interfaces and brings deep lightning integration to the web
https://github.com/getAlby/lightning-browser-extension

bitcoin browser-extension chrome-extension firefox-extension lightning lightning-network lnurl nostr nostr-protocol nostr-tools wallet webln

Last synced: about 1 month ago
JSON representation

The Bitcoin Lightning Browser extension that connects to different wallet interfaces and brings deep lightning integration to the web

Awesome Lists containing this project

README 

        


  

    

    Alby Logo

  




Alby - Lightning Browser Extension



### A browser extension to bring the Bitcoin Lightning Network to the browser



The extension provides deep Lightning Network integration for websites (for payments and authentication flows).



The goal is to write a minimal web extension to allow browsers to interact with the Lightning Network programmatically. It focuses on the web-payments process and does not try to be a full node UI with advanced channel-management or similar features.



The extension implements the WebLN standard as the interface that allows websites to connect to Lightning Network nodes (to request payments, invoices, signatures, login, etc.) and enable seamless UX of web payments and authentications.



The extension can connect to different node implementations and supports custodial and non-custodial setups.



## Some Features



- [x] Custom budgets/allowances for websites to allow payment streams/auto-payments

- [x] Multiple accounts and support for different node backends (lnd, etc.)

- [x] Full WebLN send and receive payment flows (getInfo, sendPayment, fixed makeInvoice support)

- [x] [LNURL-pay](https://github.com/lnurl/luds/blob/luds/06.md) support

- [x] [LNURL-auth](https://github.com/lnurl/luds/blob/luds/04.md) support

- [x] Payment history with additional website metadata

- [x] [LNURL-withdraw](https://github.com/lnurl/luds/blob/luds/03.md) support

- [x] WebLN signMessage, verifyMessage support

- [x] WebLN dynamic makeInvoice support

- [x] Keysend



### STATUS: 🚀



## About Alby



Alby is open-source, our goal is to create the best online experience to consume and reward content and services online.



## Join the conversation



- [Discord](https://discord.gg/K7aQ5PErht) via [bitcoin.design](https://bitcoin.design/): Find us in the #alby channel

- [Telegram](https://t.me/getAlby)

- [Community calls](https://meet.fulmo.org/AlbyCommunityCall): bi-weekly on Thursday at [15:00 UTC](https://everytimezone.com/?t=642e0b80,ec4)



## Browser Support



Alby supports



- All [Chromium based browsers]() - Chrome, Edge, Opera, Brave etc.

- Firefox

- more coming soon...



## Installation



Add Alby to your browser



- [Add to Chrome, Opera, Brave, and all Chromium based browsers](https://chrome.google.com/webstore/detail/alby/iokeahhehimjnekafflcihljlcjccdbe)

- [Add to Firefox](https://addons.mozilla.org/en-US/firefox/addon/alby/)



### Try out the most recent version of Alby (Nightly Releases)



- [Firefox Nightly](https://nightly.link/getAlby/lightning-browser-extension/workflows/build/master/firefox.xpi.zip) - best to install it as a temporary add-on as discussed in the "[Load extension into browser](/doc/SETUP.md#-load-extension-into-browser)" section

- [Chrome Nightly](https://nightly.link/getAlby/lightning-browser-extension/workflows/build/master/chrome.zip)

  - for Chrome: go to `chrome://extensions/`, enable "Developer mode" (top right), and drag & drop the file in the browser

  - for Edge: go to `edge://extensions/`, enable "Developer mode" (left column), and load the unpacked file in the browser



(Note: You might need to reconfigure your wallet after installing new versions)



## Architecture Idea



![architecture](/doc/ln-browser-architecture.png)



## 🚀 Quick Start



Ensure you have



- [Node.js](https://nodejs.org) v16 or newer installed (we run tests with v18)

- [Yarn](https://yarnpkg.com) v1 or v2 installed



Supported but not required



- [nvm](https://github.com/nvm-sh/nvm#intro)



Then run the following



### 🛠 Development



[Refer to SETUP.md for info regarding how to setup Alby](./doc/SETUP.md)



## Native Companions



Alby supports native connectors to native applications on the host computer. For this, the extension passes each call to a native application (using [native messaging](https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/Native_messaging)).

This allows Alby also to connect to nodes behind Tor (through this native "proxy" application).



Currently, there is one native companion app available to connect to Tor nodes: [https://github.com/getAlby/alby-companion-rs](https://github.com/getAlby/alby-companion-rs)



# ⭐ Contributing



We welcome and appreciate new contributions.



### Find a task



We use the [Development Project Board](https://github.com/orgs/getAlby/projects/10/views/2) to plan to-dos. Best choose something from the to-do column. (If there is nothing for you, feel free to pick something from the backlog)



#### Developer



- Check out the issues that have specifically been [marked as being friendly to new contributors](https://github.com/getAlby/lightning-browser-extension/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)

- You can also review open PRs

- [Contribution guide for new developers](./doc/CONTRIBUTION.md)



#### Designer



- Have a look at our [Open source Design guide](https://github.com/getAlby/lightning-browser-extension/wiki/Open-source-Design)

- Check out the issues that have specifically been [marked with "design"](https://github.com/getAlby/lightning-browser-extension/issues?q=is%3Aopen+is%3Aissue+label%3A%22design%22)

- You can find and copy current version of the extension in this Figma file: [Alby Extension Master Design](https://www.figma.com/file/O49NS4o3IjWwmHvFLncTy6/Alby-Extension-Master-Design?node-id=0%3A1&t=rd4dQkDtwZ4Nuuqo-1)



#### Anyone



- Have a look at this Readme. Can it be improved? Do you see typos? You can open a PR or reach out to us in [our community chat](https://bitcoindesign.slack.com/archives/C02591ADXM2).

- You can help with [translations](./doc/CONTRIBUTION.md#translations)

- [Code of Conduct](./doc/CODE_OF_CONDUCT.md)



## ❔ FAQs



#### Why not use Joule?



Joule is a full interface to manage a LND node. It only supports one LND account.

Our goal is NOT to write a full UI for a Lightning Network node with all the channel management features, but instead to only focus on what is necessary for the web (for payment and authentication flows). We believe there are already way better management UIs.

Also, we focus on supporting multiple different node backends (non-custodial and custodial).



#### What is WebLN?



WebLN is a library and set of specifications for lightning apps and client providers to facilitate communication between apps and users' lightning nodes in a secure way. It provides a programmatic, permissioned interface for letting applications ask users to send payments, generate invoices to receive payments, and much more. [This documentation](https://webln.guide/) covers how to use WebLN in your Lightning-driven applications.



#### Is there a bounty program and can I contribute?



Yes. Thanks to generous donors, Alby is able to offer several bounties. You can find them on our [Wiki page](https://github.com/getAlby/lightning-browser-extension/wiki/Bounties). If you want to support Alby's bounty program, please donate [here](https://getalby.com/bounties). We greatly appreciate your contribution! 🙏



### Thanks



Based on the web extension starter kit: [/abhijithvijayan/web-extension-starter](https://github.com/abhijithvijayan/web-extension-starter)

heavily inspired by the super-amazing work of the [Joule extension](https://lightningjoule.com/)



## ⚡️Donations



Want to support the work on Alby?



Support the Alby team ⚡️[email protected]

You can also contribute to our [bounty program](https://github.com/getAlby/lightning-browser-extension/wiki/Bounties): ⚡️[email protected]



## License



[MIT](./LICENSE)