https://github.com/vincenzopalazzo/cln-remote-api

Rust Remote API for core lightning provided as library and a plugin
https://github.com/vincenzopalazzo/cln-remote-api

api core-lightning

Last synced: about 2 months ago
JSON representation

Rust Remote API for core lightning provided as library and a plugin

• Host: GitHub
• URL: https://github.com/vincenzopalazzo/cln-remote-api
• Owner: vincenzopalazzo
• License: gpl-2.0
• Created: 2022-10-24T15:21:06.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-11-09T20:22:09.000Z (over 2 years ago)
• Last Synced: 2025-02-02T16:32:29.501Z (4 months ago)
• Topics: api, core-lightning
• Language: Rust
• Homepage:
• Size: 39.1 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  
cln-remote-api


  

  


     Rust Remote API for core lightning provided as library and a plugin 

  


  


    Project Homepage

  



## Table of Content

- Introduction

- How to Use

- How to Contribute

- License 

## Introduction

A simple and fast plugin for core lightning to talk through the following API:

- Rest API: Not authenticate (Support for Rune in the pipeline) API that support some basic API to talk with

            core lightning node.

N.B: The code is written to be easily extensible to support new API, so please consider to contribute.

## How to Use

To use the plugin you can download the binary from the Github release inside the `.lightning/plugins` directory, or 

link the plugin with core `lightningd` with `--plugin=`.

For the moment it is not possible restart the plugin at runtime, but it is possible to implement is someone will required it.

## How to Contribute

Read our [Hacking guide](https://github.com/laanwj/cln4rust/blob/master/docs/MAINTAINERS.md)

## License

    Rust Remote API for core lightning provided as library and a plugin

    Copyright (C) 2022 Vincenzo Palazzo 

    This program is free software; you can redistribute it and/or modify

    it under the terms of the GNU General Public License as published by

    the Free Software Foundation; either version 2 of the License, or

    (at your option) any later version.

    This program is distributed in the hope that it will be useful,

    but WITHOUT ANY WARRANTY; without even the implied warranty of

    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License along

    with this program; if not, write to the Free Software Foundation, Inc.,

    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.