GlcoinCore/cln
1
0
Fork 0
mirror of https://github.com/ElementsProject/lightning.git synced 2026-08-20 13:27:36 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 7

plugin/clnrest: Deleting redundant README.md

Browse source
This commit is contained in:
ShahanaFarooqui 2023-09-12 15:21:02 +09:30 • committed by Rusty Russell
parent 2331eff2db
commit 761172001b
1 changed files with 0 additions and 103 deletions
Download patch file Download diff file Expand all files Collapse all files

103
plugins/clnrest/README.md
View file

@ -1,103 +0,0 @@
# CLNRest
CLNRest is a lightweight Python-based core lightning plugin that transforms RPC calls into a REST service. By generating REST API endpoints, it enables the execution of Core Lightning's RPC methods behind the scenes and provides responses in JSON format.
## Installation
Install required packages with `pip install json5 flask flask_restx gunicorn pyln-client flask-socketio gevent gevent-websocket` or `pip install -r requirements.txt`.
Note: if you have the older c-lightning-rest plugin, you can use `disable-plugin clnrest.py` to avoid any conflict with this one. Of course, you could use this one instead!
## Configuration
If `rest-port` is not specified, the plugin will disable itself.
- --rest-port: Sets the REST server port to listen to (3010 is common)
- --rest-protocol: Specifies the REST server protocol. Default is HTTPS.
- --rest-host: Defines the REST server host. Default is 127.0.0.1.
- --rest-certs: Defines the path for HTTPS cert & key. Default path is same as RPC file path to utilize gRPC's client certificate. If it is missing at the configured location, new identity (`client.pem` and `client-key.pem`) will be generated.
## Server
With the default configurations, the Swagger user interface will be available at https://127.0.0.1:3010/. The POST method requires `rune` header for authorization.
- A new `rune` can be created via [createrune](https://docs.corelightning.org/reference/lightning-createrune) or the list of existing runes can be retrieved with [listrunes](https://docs.corelightning.org/reference/lightning-listrunes) command.
Note: in version v23.08, a parameter `Nodeid` was required to be the id of the node we're talking to (see `id (pubkey)` received from [getinfo](https://docs.corelightning.org/reference/lightning-getinfo) ). You can still send this for backwards compatiblity, but it is completely ignored.
### cURL
Example curl command for POST will also require a `rune` header like below:
`curl -k -X POST 'https://127.0.0.1:3010/v1/getinfo' -H 'Rune: <node-rune>'`
With `-k` or `--insecure` option curl proceeds with the connection even if the SSL certificate cannot be verified.
This option should be used only when testing with self signed certificate.
### Swagger
FIX SCREEN SHOTS PLEASE SHAHANA!
<p float="left">
<img src="./.github/screenshots/Swagger.png" width="200" alt="Swagger Dashboard" />
<img src="./.github/screenshots/Swagger-auth.png" width="200" alt="Swagger Authorize" />
<img src="./.github/screenshots/Swagger-list-methods.png" width="200" alt="Swagger GET List Methods" />
<img src="./.github/screenshots/Swagger-rpc-method.png" width="200" alt="Swagger POST RPC Method" />
</p>
### Postman
<p float="left">
<img src="./.github/screenshots/Postman.png" width="200" alt="Postman Headers">
<img src="./.github/screenshots/Postman-with-body.png" width="200" alt="Postman with JSON body">
<img src="./.github/screenshots/Postman-bkpr-plugin.png" width="200" alt="Postman bkpr plugin RPC">
</p>
## Websocket Server
Websocket server is available at `/ws` endpoint. clnrest queues up notifications received for a second then broadcasts them to listeners.
### Websocket client examples
#### Python
```python
import socketio
import requests
http_session = requests.Session()
http_session.verify = False
sio = socketio.Client(http_session=http_session)
@sio.event
def message(data):
print(f'I received a message: {data}')
@sio.event
def connect():
print("I'm connected!")
@sio.event
def disconnect():
print("I'm disconnected!")
sio.connect('https://127.0.0.1:3010/ws')
sio.wait()
```
#### NodeJS
```javascript
const io = require('socket.io-client');
const socket = io.connect('https://127.0.0.1:3010', {rejectUnauthorized: false});
socket.on('connect', function() {
console.log("I'm connected!");
});
socket.on('message', function(data) {
console.log('I received a message: ', data);
});
socket.on('disconnect', function() {
console.log("I'm disconnected!");
});
```