A Rust library for establishing connections to Lightning Network nodes. This library provides low-level primitives for establishing encrypted communication channels with Lightning Network nodes using the Noise_XK protocol as specified in BOLT #8.
lnsocket also comes batteries included with Commando support, allowing you to call RPCs on core-lightning nodes remotely!
- Establish encrypted connections to Lightning Network nodes with Noise_XK handshake protocol
- Send and receive Lightning Network messages
- Support for Commando CLN RPC messages
Add to your Cargo.toml:
[dependencies]
lnsocket = "0.1.0"This crate includes a small Commando client that runs over the same encrypted Lightning transport.
use bitcoin::secp256k1::{SecretKey, PublicKey, rand};
use lnsocket::{LNSocket, CommandoClient};
use serde_json::json;
use lnsocket::commando::CallOpts;
async fn commando_rpc_demo(pk: PublicKey, rune: &str) -> Result<(), lnsocket::Error> {
let key = SecretKey::new(&mut rand::thread_rng());
let sock = LNSocket::connect_and_init(key, pk, "ln.example.com:9735").await?;
let client = CommandoClient::spawn(sock, rune);
// Inherit client defaults (30s timeout, auto-reconnect with backoff,
// and retry up to 3 times). Override per call if needed:
let res = client.call("getinfo", json!({})).await?;
println!("{}", res);
let opts = CallOpts::new().timeout(std::time::Duration::from_secs(5)).retry(5);
let channels = client.call_with_opts("listchannels", json!({}), &opts).await?;
Ok(())
}This library is experimental and under active development. APIs may change significantly between versions.
This library contains code derived from LDK, which is licensed under either of:
- Apache License, Version 2.0 (LICENSE-APACHE)
- MIT License (LICENSE-MIT)
at your option.
Contributions are welcome! Please feel free to submit a Pull Request.