aiolabs/nwcprovider
9
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
46 commits 1 branch 12 tags 1.3 MiB
  • Python 77.2%
  • HTML 10.5%
  • JavaScript 7.9%
  • Shell 3.9%
  • Makefile 0.5%
Find a file
Exact
arcbtc 56636823f6
Some checks failed
Tests / test (push) Has been cancelled
Details
removed basemodel (test)
2025-02-15 17:07:03 +00:00
.devcontainer more repo cleanup 2024-09-07 11:21:24 +00:00
.github/workflows fix tests 2024-09-07 09:29:50 +00:00
static code quality fixes and cleanup 2024-09-07 09:09:22 +00:00
templates/nwcprovider Merge remote-tracking branch 'riccardobl/master' 2025-02-15 15:52:00 +00:00
tests code quality fixes and cleanup 2024-09-07 09:09:22 +00:00
.gitignore debug 2024-11-19 19:13:09 +00:00
__init__.py removed basemodel (test) 2025-02-15 17:07:03 +00:00
config.json Added description for extension preview 2024-11-19 14:07:04 +00:00
crud.py make 2024-11-19 22:31:10 +00:00
description.md make 2024-11-19 22:31:10 +00:00
execution_queue.py code quality fixes and cleanup 2024-09-07 09:09:22 +00:00
LICENSE bell and whistles 2024-07-24 13:00:59 +00:00
Makefile make 2024-11-19 22:31:10 +00:00
manifest.json Update manifest.json 2024-09-13 10:37:30 +02:00
migrations.py make 2024-11-19 23:03:41 +00:00
models.py make 2024-11-19 23:03:41 +00:00
nwcp.py removed basemodel (test) 2025-02-15 17:07:03 +00:00
permission.py code quality fixes and cleanup 2024-09-07 09:09:22 +00:00
poetry.lock make 2024-11-19 22:31:10 +00:00
pyproject.toml make 2024-11-19 22:31:10 +00:00
README.md code quality fixes and cleanup 2024-09-07 09:09:22 +00:00
tasks.py make 2024-11-19 22:31:10 +00:00
toc.md Added description for extension preview 2024-11-19 14:07:04 +00:00
views.py more repo cleanup 2024-09-07 11:21:24 +00:00
views_api.py make 2024-11-19 22:31:10 +00:00

README.md

NWC Service Provider Extension for LNbits

Easily connect your LNbits wallets via NWC.

Installation

Install the extension via the .env file or through the admin UI on your LNbits server. More details can be found here.

Configuration

Configure the extension from the "Settings" page in the top right menu when logged in as admin inside the extension page.

Configuration Options:

Key Description Default
relay URL of the nostr relay for dispatching and receiving NWC events. Use public relays or a custom one. Specify nostrclient to connect to the nostrclient extension. nostrclient
provider_key Nostr secret key of the NWC Service Provider. Random key generated on install
relay_alias Relay URL to display in pairing URLs. Set if different from relay. Empty (uses the relay value)

Using Nostrclient

The extension is preconfigured to connect to the nostrclient extension. Install it on the same LNbits instance and configure it to expose public websocket endpoints. Refer to the nostrclient documentation for more information.

Using a Custom Relay

To use a custom relay, set the relay key to the relay URL (e.g., wss://nostr.wine) in the extension's Settings page.

Usage

  1. Go to the extension page.
  2. Select a wallet and click the plus button to create a new NWC connection.
  3. Configure expiration, limits, and permissions.
  4. A pairing URL will be generated for you to open, copy, or scan with the NWC app. Note that the pairing URL is shown only once, but you can delete and recreate the connection to get a new one.