No description
- Python 77.2%
- HTML 10.5%
- JavaScript 7.9%
- Shell 3.9%
- Makefile 0.5%
|
|
||
|---|---|---|
| .devcontainer | ||
| .github/workflows | ||
| static | ||
| templates/nwcprovider | ||
| tests | ||
| .gitignore | ||
| __init__.py | ||
| config.json | ||
| crud.py | ||
| description.md | ||
| execution_queue.py | ||
| LICENSE | ||
| Makefile | ||
| manifest.json | ||
| migrations.py | ||
| models.py | ||
| nwcp.py | ||
| permission.py | ||
| poetry.lock | ||
| pyproject.toml | ||
| README.md | ||
| tasks.py | ||
| toc.md | ||
| views.py | ||
| views_api.py | ||
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
- Go to the extension page.
- Select a wallet and click the plus button to create a new NWC connection.
- Configure expiration, limits, and permissions.
- 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.