10 releases
| 0.3.0-beta.8 | Aug 24, 2023 |
|---|---|
| 0.3.0-beta.6 | Jun 13, 2023 |
| 0.3.0-beta.5 | Mar 10, 2023 |
| 0.3.0-beta.4 | Nov 21, 2022 |
| 0.1.0 | Sep 5, 2018 |
#16 in #bitcoin-lightning
1,825 downloads per month
Used in 6 crates
62KB
1.5K
SLoC
Rust c-lightning client
This crate provides an interface from rust to the c-lightning daemon through RPC.
Project Homepage
This crate provides an interface from rust to the c-lightning daemon through RPC.
extern crate clightningrpc;
use std::env;
use clightningrpc::LightningRPC;
fn main() {
let sock = env::home_dir().unwrap().join(".lightning/lightning-rpc");
let mut client = LightningRPC::new(&sock);
println!("getinfo result: {:?}", client.getinfo().unwrap());
}
See examples directory for more usage examples. To build and run an example do cargo run --example ex_1.
API documentation for the lastest version can be found on docs.rs.
Currently implemented (this covers all non-dev commands as of c-lightning v0.6.1rc1):
getinfofeerateslistnodeslistchannelshelpgetloglistconfigslistpeerslistinvoicesinvoicedelinvoicedelexpiredinvoiceautocleaninvoicewaitanyinvoicewaitinvoicepaysendpaywaitsendpaylistpaymentsdecodepaygetrouteconnectdisconnectfundchannelclosepinglistfundswithdrawnewaddrstop
Be aware that the API (of rust-clighting-rpc, but also that of c-lightning itself) is not finalized. This means that it may change from version to version and break your compile, sorry!
N.B: A good solution if you have some missing compatibility between core lightning and the rust library, considering to use the common crate.
Contributing guidelines
- Four spaces
- Call
make fmtbefore committing - If you can, GPG-sign at least your top commit when filing a PR
Supports
If you want support this library consider to donate with the following methods
- Lightning address: vincenzopalazzo@lntxbot.com
- Github donation
Credits
This library is based on Andrew Poelstra's rust-jsonrpc.
Dependencies
~0.6–1.6MB
~33K SLoC