Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fiatjaf/kwh
webln browser extension for lightningd/eclair/ptarmigan
https://github.com/fiatjaf/kwh
c-lightning eclair lightning-network lightningd ptarmigan spark web-extension webln
Last synced: about 2 months ago
JSON representation
webln browser extension for lightningd/eclair/ptarmigan
- Host: GitHub
- URL: https://github.com/fiatjaf/kwh
- Owner: fiatjaf
- License: mit
- Created: 2019-03-17T01:50:07.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-07-29T21:36:35.000Z (over 5 years ago)
- Last Synced: 2024-10-25T21:06:31.688Z (about 2 months ago)
- Topics: c-lightning, eclair, lightning-network, lightningd, ptarmigan, spark, web-extension, webln
- Language: JavaScript
- Homepage:
- Size: 2.2 MB
- Stars: 32
- Watchers: 6
- Forks: 7
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-lightning-network - kWh - A browser extension that connects to c-lightning or Eclair nodes and enables interactions with Lightning apps (similar to Joule) (Applications / Web Interfaces)
- awesome-lightning-network - kWh - A browser extension that connects to c-lightning or Eclair nodes and enables interactions with Lightning apps (similar to Joule) (Applications / Web Interfaces)
README
The companion browser extension for c-lightning, Eclair and Ptarmigan nodes.
## Features
- Browse balance and latest transactions;
- [`webln`](https://webln.dev/#/) support;
- Pay highlighted invoice with a context menu click;
- Handle `lightning:` links;
- ["Generate invoice here"](https://youtu.be/wzkxxz5FsJo) context menu;
- Manual payments and invoice creation;
- Instant notifications on received payments;
- No window popups, all interactions happen in the `browserAction` popup.
## Requirements
Either
* a [lightningd](https://github.com/ElementsProject/lightning/) node with a [Spark](https://github.com/shesek/spark-wallet) [RPC server](https://github.com/fiatjaf/sparko) in front of it;
* an [Eclair](https://github.com/ACINQ/eclair) node with the [API](https://github.com/ACINQ/eclair#configuring-eclair) enabled and accessible;
* a [Ptarmigan](https://github.com/nayutaco/ptarmigan) node with the [REST API Node.js app](https://github.com/nayutaco/ptarmigan/blob/master/docs/howtouse_rest_api.md) running.
### Caveats
* If you are using **Google Chrome**, consider enabling the `Experimental Extension APIs` flag on chrome://flags for a better experience. Read more in [this issue](https://github.com/fiatjaf/kwh/issues/4#issuecomment-485288552).
* If you are using Eclair, [the WebSocket won't connect on Firefox](https://github.com/ACINQ/eclair/issues/1001), so you won't get notifications when a payment is sent or received, the experience will not be as nice as if it did.
## Build instructions
You'll need: Node.js>=10, npm, Make
```
npm install
make extension.zip
```
---