Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/dni/lnurlcln

Core Lightning - LNURL Plugin
https://github.com/dni/lnurlcln

Last synced: 9 days ago
JSON representation

Core Lightning - LNURL Plugin

Awesome Lists containing this project

README

        

# Corelightning LNURL plugin
Support for LNURL Decoding, Paylinks, Withdraw and Auth

## corelightning commands
```console
=== lnurl ===

lnurl-decode [lnurl]
Decode a LNURL and return the result

lnurl-handle [lnurl]
Decode a LNURL and return the LnurlResponse

lnurl-execute [lnurl] [value]
LNURL execute a command

lnurl-auth [lnurl] [secret]
LNURL Auth

lnurl-pay [lnurl] [amount_msat]
LNURL Pay

lnurl-withdraw [lnurl] [bolt11]
LNURL Withdraw
```

## requirements
corelightning, python3.10 and poetry

## install
```console
git clone [email protected]:dni/lnurlcln.git
cd lnurlcln
poetry install
```

## run
```console
lightning-cli plugin start $(poetry env info --path)/bin/lnurlcln
lightning-cli plugin stop $(poetry env info --path)/bin/lnurlcln
```

### dev
watch the logs if your node
```console
docker logs -f regtest-clightning-1-1
```
watch for changes and restart the plugin inside the regtest
```console
find lnurlcln/*.py | entr -s "./dev.sh regtest-clightning-1-1"
```