{"id":13666739,"url":"https://github.com/getAlby/lightning-browser-extension","last_synced_at":"2025-04-26T12:31:37.518Z","repository":{"id":37005140,"uuid":"324744034","full_name":"getAlby/lightning-browser-extension","owner":"getAlby","description":"The Bitcoin Lightning Browser Extension that brings deep Lightning \u0026 Nostr integration to the web. Wallet interface to multiple lightning nodes and key signer for Nostr, Liquid and onchain use.","archived":false,"fork":false,"pushed_at":"2025-04-21T07:37:53.000Z","size":37372,"stargazers_count":550,"open_issues_count":241,"forks_count":201,"subscribers_count":15,"default_branch":"master","last_synced_at":"2025-04-21T08:35:47.593Z","etag":null,"topics":["bitcoin","browser-extension","chrome-extension","firefox-extension","lightning","lightning-network","lnurl","nostr","nostr-protocol","nostr-tools","wallet","webln"],"latest_commit_sha":null,"homepage":"https://getalby.com/#extension","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/getAlby.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-12-27T11:11:43.000Z","updated_at":"2025-04-14T07:48:30.000Z","dependencies_parsed_at":"2025-04-01T07:33:01.190Z","dependency_job_id":"e98eec6a-6844-455e-b8d2-4107fbeccc2d","html_url":"https://github.com/getAlby/lightning-browser-extension","commit_stats":null,"previous_names":[],"tags_count":69,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getAlby%2Flightning-browser-extension","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getAlby%2Flightning-browser-extension/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getAlby%2Flightning-browser-extension/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/getAlby%2Flightning-browser-extension/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/getAlby","download_url":"https://codeload.github.com/getAlby/lightning-browser-extension/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250986499,"owners_count":21518528,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bitcoin","browser-extension","chrome-extension","firefox-extension","lightning","lightning-network","lnurl","nostr","nostr-protocol","nostr-tools","wallet","webln"],"created_at":"2024-08-02T06:01:24.371Z","updated_at":"2025-04-26T12:31:37.512Z","avatar_url":"https://github.com/getAlby.png","language":"TypeScript","funding_links":[],"categories":["Lightning","TypeScript","Uncategorized"],"sub_categories":["Tools","Uncategorized"],"readme":"\u003cp align=\"center\"\u003e\n  \u003cpicture\u003e\n    \u003csource srcset=\"/doc/logo-white.svg\" media=\"(prefers-color-scheme: dark)\" width=\"300\"\u003e\n    \u003cimg alt=\"Alby Logo\" src=\"/doc/logo-black.svg\" width=\"300\"\u003e\n  \u003c/picture\u003e\n\u003c/p\u003e\n\n\u003ch1 align=\"center\"\u003e⚡ Alby - Lightning Browser Extension\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003eSeamlessly bring Bitcoin's Lightning Network to your browser.\u003c/strong\u003e\n\u003c/p\u003e\n\nThe Alby browser extension seamlessly integrates the Bitcoin Lightning Network into websites, enabling both payments and authentication flows.\n\nDesigned to be a lightweight and efficient web extension, Alby allows browsers to interact with the Lightning Network programmatically. It focuses on web payments rather than advanced node management, ensuring a simple and intuitive user experience.\n\nAlby implements the WebLN standard, providing a universal interface for websites to:\n\n- Connect to Lightning Network nodes\n- Request payments, invoices, signatures, and logins\n- Enable a smooth and frictionless web payment experience\n- The extension supports both custodial and non-custodial setups, making it flexible for different use cases\n\n## 🌟 Key Features\n\n- **Custom Budgets \u0026 Allowances** - Enable auto-payments and payment streams.\n- **Multiple Accounts** - Supports different Lightning node backends (e.g., LND, CLN, custodial options).\n- **Full WebLN Support** - Send \u0026 receive payments, generate invoices, signMessage, verifyMessage, dynamic makeInvoice and more.\n- **LNURL Support** - Seamless [LNURL-pay](https://github.com/lnurl/luds/blob/luds/06.md), [LNURL-auth](https://github.com/lnurl/luds/blob/luds/04.md), and [LNURL-withdraw](https://github.com/lnurl/luds/blob/luds/03.md) integrations.\n- **Keysend Payments** - Send payments without an invoice.\n- **Payment History \u0026 Metadata** - Track transactions with additional website metadata.\n\n## 🐝 About Alby\n\nAlby is open-source, our goal is to create the best online experience to consume and reward content and services online.\n\n## 🌎 Browser Support\n\nExtension supports\n\n✅ **[All Chromium-based browsers](\u003chttps://en.wikipedia.org/wiki/Chromium_(web_browser)#Browsers_based_on_Chromium\u003e)** (Chrome, Edge, Opera, Brave, etc.)  \n✅ **Firefox desktop and mobile**  \n🚀 **More browsers coming soon...**\n\n## 🛠 Installation\n\n### Official Release\n\nAdd Alby to your browser\n\n- [Add to Chrome, Opera, Brave, and all Chromium based browsers](https://chrome.google.com/webstore/detail/alby/iokeahhehimjnekafflcihljlcjccdbe)\n- [Add to Firefox](https://addons.mozilla.org/en-US/firefox/addon/alby/)\n\n### Nightly Builds (Latest Development Version)\n\n- [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\n- [Chrome Nightly](https://nightly.link/getAlby/lightning-browser-extension/workflows/build/master/chrome.zip)\n  - for Chrome: go to `chrome://extensions/`, enable \"Developer mode\" (top right), and drag \u0026 drop the file in the browser\n  - for Edge: go to `edge://extensions/`, enable \"Developer mode\" (left column), and load the unpacked file in the browser\n\n\u003e ⚠️ _Note: Updating may require reconfiguring your wallet._\n\n## 🏛️ Architecture\n\n![architecture](/doc/ln-browser-architecture.png)\n\n### 🛠 Development\n\nWe welcome and appreciate new contributions! 🎉 To get started, [Refer to SETUP.md for info regarding how to set up Alby](./doc/SETUP.md)\n\n#### 👨‍💻 Developer\n\n- 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)\n- You can also review open PRs\n- [Contribution guide for new developers](./doc/CONTRIBUTION.md)\n\n#### 🎨 Designer\n\n- Have a look at our [Open source Design guide](https://github.com/getAlby/lightning-browser-extension/wiki/Open-source-Design)\n- 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)\n- You can find and copy the 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\u0026t=rd4dQkDtwZ4Nuuqo-1)\n\n#### 🌍 Anyone\n\n- 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).\n- You can help with [translations](./doc/CONTRIBUTION.md#translations)\n- [Code of Conduct](./doc/CODE_OF_CONDUCT.md)\n\n## 🤝 Native Companions\n\nAlby 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)).\nThis allows Alby also to connect to nodes behind Tor (through this native \"proxy\" application).\n\nCurrently, 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)\n\n## 💬 Join the conversation\n\n- [Discord](https://discord.gg/4DQu2pa72D)\n- [Telegram](https://t.me/getAlby)\n- [Community calls](https://cal.com/getalby/communitycall): bi-weekly on Thursday at 15:00 UTC\n\n## ❔ FAQs\n\n#### Why not use Joule?\n\nJoule is a full interface to manage a LND node. It only supports one LND account.\nOur 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.\nAlso, we focus on supporting multiple different node backends (non-custodial and custodial).\n\n#### What is WebLN?\n\nWebLN 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.\n\n#### Is there a bounty program and can I contribute?\n\nYes. 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! 🙏\n\n## ⚡️ Donations\n\nWant to support the work on Alby?\n\nSupport the Alby team ⚡️hello@getalby.com\nYou can also contribute to our [bounty program](https://guides.getalby.com/developer-guide/bounties/alby-browser-extension-bounties): ⚡️bounties@getalby.com\n\n## 🎉 Thanks\n\nBased on the web extension starter kit: [/abhijithvijayan/web-extension-starter](https://github.com/abhijithvijayan/web-extension-starter)\nheavily inspired by the super-amazing work of the [Joule extension](https://lightningjoule.com/)\n\n## ⚖️ License\n\n[MIT](./LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FgetAlby%2Flightning-browser-extension","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FgetAlby%2Flightning-browser-extension","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FgetAlby%2Flightning-browser-extension/lists"}