Skip to main content

CommandoClient

Struct CommandoClient 

Source
pub struct CommandoClient { /* private fields */ }
Expand description

Public client for Core Lightning Commando over an LNSocket.

Spawns a background task to:

  • write requests with generated IDs,
  • read fragments (COMMANDO_REPLY_CONT) and accumulate bytes,
  • parse JSON on terminal chunk (COMMANDO_REPLY_TERM),
  • optionally reconnect and resend per RetryPolicy.

§Usage

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);

// Default policy (see `CommandoConfig::default()`):
let v = client.call("listpeers", json!({})).await?;

// Per-call overrides:
use lnsocket::commando::CallOpts;
let opts = CallOpts::new().retry(5).timeout(std::time::Duration::from_secs(10));
let v2 = client.call_with_opts("getchaninfo", json!({"channel": "..." }), opts).await?;

Implementations§

Source§

impl CommandoClient

Source

pub fn spawn_with_config( sock: LNSocket, rune: impl Into<String>, config: CommandoConfig, ) -> Self

Spawn the background pump that owns the LNSocket.

Source

pub fn spawn(sock: LNSocket, rune: impl Into<String>) -> Self

Source

pub async fn call( &self, method: impl Into<String>, params: Value, ) -> Result<Value, Error>

Source

pub async fn call_with_opts( &self, method: impl Into<String>, params: Value, opts: CallOpts, ) -> Result<Value, Error>

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more