Struct ClnRpcService

pub(crate) struct ClnRpcService {
    pub(crate) socket: PathBuf,
}

Fields

socket: PathBuf

Implementations

impl ClnRpcService

pub(crate) async fn new( extension_opts: ClnExtensionOpts, ) -> Result<(Self, Arc<ClnHtlcInterceptor>, SocketAddr, Plugin<Arc<ClnHtlcInterceptor>>), ClnExtensionError>

pub(crate) async fn rpc_client(&self) -> Result<ClnRpc, ClnExtensionError>

Creates a new RPC client for a request.

This operation is cheap enough to do it for each request since it merely connects to a UNIX domain socket without doing any further initialization.

pub(crate) async fn info( &self, ) -> Result<(PublicKey, String, String, u32, bool), ClnExtensionError>

pub(crate) async fn get_route( &self, pruned_invoice: PrunedInvoice, riskfactor: u64, excluded_nodes: Vec<String>, ) -> Result<Vec<SendpayRoute>, ClnExtensionError>

Requests a route for a payment. Payment route will be passed to pay_with_route to initiate the payment.

pub(crate) async fn pay_with_route( &self, pruned_invoice: PrunedInvoice, payment_hash: Hash, route: Vec<SendpayRoute>, ) -> Result<Vec<u8>, ClnExtensionError>

Initiates a payment of a pruned invoice given a payment route. Waits for the payment to be successful or return an error.

pub(crate) async fn create_invoice_for_self( &self, amount_msat: u64, expiry_secs: u64, description_or: Option<InvoiceDescription>, ) -> Result<Json<CreateInvoiceResponse>, ClnExtensionError>

Creates an invoice with a preimage that is generated by CLN. This invoice can be used to receive payments directly to the node.

Trait Implementations

impl Clone for ClnRpcService

fn clone(&self) -> ClnRpcService

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.