Struct ClnRpcService

pub(crate) struct ClnRpcService {
    pub(crate) socket: PathBuf,
    pub(crate) interceptor: Arc<ClnHtlcInterceptor>,
    pub(crate) task_group: TaskGroup,
    pub(crate) secp: Secp256k1<All>,
}

Fields

socket: PathBuf

interceptor: Arc<ClnHtlcInterceptor>

task_group: TaskGroup

secp: Secp256k1<All>

Implementations

impl ClnRpcService

pub(crate) async fn new( extension_opts: ClnExtensionOpts, ) -> Result<(Self, 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<Description>, ) -> Result<Response<CreateInvoiceResponse>, Status>

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 GatewayLightning for ClnRpcService

type RouteHtlcsStream = ReceiverStream<Result<InterceptHtlcRequest, Status>>

Server streaming response type for the RouteHtlcs method.

fn get_node_info<'life0, 'async_trait>( &'life0 self, _request: Request<EmptyRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<GetNodeInfoResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetNodeInfo returns the public key and alias of the associated lightning node

fn get_route_hints<'life0, 'async_trait>( &'life0 self, request: Request<GetRouteHintsRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<GetRouteHintsResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

GetRouteHints returns the route hints to the associated lightning node

fn pay_invoice<'life0, 'async_trait>( &'life0 self, request: Request<PayInvoiceRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<PayInvoiceResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

PayInvoice attempts to pay an invoice using the associated lightning node

fn pay_pruned_invoice<'life0, 'async_trait>( &'life0 self, request: Request<PayPrunedInvoiceRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<PayInvoiceResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

PayPrunedInvoice attempts to pay a pruned invoice, which is an invoice without a description, using the associated lightning node.

fn route_htlcs<'life0, 'async_trait>( &'life0 self, __arg1: Request<EmptyRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<Self::RouteHtlcsStream>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

RouteHtlcs opens a bi-directional stream for the client to receive intercepted HTLCs. InterceptHtlcRequest is sent from the server to alert the client that an HTLC has been intercepted and needs to be processed. The client is expected to response with InterceptHtlcResponse after the HTLC has been processed with the appropriate action (Settle, Forward, Cancel).

fn complete_htlc<'life0, 'async_trait>( &'life0 self, intercept_response: Request<InterceptHtlcResponse>, ) -> Pin<Box<dyn Future<Output = Result<Response<EmptyResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn create_invoice<'life0, 'async_trait>( &'life0 self, create_invoice_request: Request<CreateInvoiceRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<CreateInvoiceResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn get_ln_onchain_address<'life0, 'async_trait>( &'life0 self, _request: Request<EmptyRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<GetLnOnchainAddressResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get a Bitcoin address that belongs to the underlying lightning node’s wallet.

fn withdraw_onchain<'life0, 'async_trait>( &'life0 self, request: Request<WithdrawOnchainRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<WithdrawOnchainResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

fn open_channel<'life0, 'async_trait>( &'life0 self, request: Request<OpenChannelRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<OpenChannelResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Open a channel on the underlying lightning node.

fn close_channels_with_peer<'life0, 'async_trait>( &'life0 self, request: Request<CloseChannelsWithPeerRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<CloseChannelsWithPeerResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Close all channels with a given peer on the underlying lightning node.

fn list_active_channels<'life0, 'async_trait>( &'life0 self, _request: Request<EmptyRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<ListActiveChannelsResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

List all channels that are active and able to send and receive funds.

fn get_balances<'life0, 'async_trait>( &'life0 self, _request: Request<EmptyRequest>, ) -> Pin<Box<dyn Future<Output = Result<Response<GetBalancesResponse>, Status>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,