pub mod cln;
pub mod lnd;
use std::fmt::Debug;
use std::sync::Arc;
use async_trait::async_trait;
use clap::Subcommand;
use fedimint_core::encoding::{Decodable, Encodable};
use fedimint_core::task::TaskGroup;
use fedimint_core::util::SafeUrl;
use fedimint_core::Amount;
use fedimint_ln_common::PrunedInvoice;
use serde::{Deserialize, Serialize};
use thiserror::Error;
use self::cln::{NetworkLnRpcClient, RouteHtlcStream};
use self::lnd::GatewayLndClient;
use crate::gateway_lnrpc::{
EmptyResponse, GetNodeInfoResponse, GetRouteHintsResponse, InterceptHtlcResponse,
PayInvoiceRequest, PayInvoiceResponse,
};
pub const MAX_LIGHTNING_RETRIES: u32 = 10;
#[derive(
Error, Debug, Serialize, Deserialize, Encodable, Decodable, Clone, Eq, PartialEq, Hash,
)]
pub enum LightningRpcError {
#[error("Failed to connect to Lightning node")]
FailedToConnect,
#[error("Failed to retrieve node info: {failure_reason}")]
FailedToGetNodeInfo { failure_reason: String },
#[error("Failed to retrieve route hints: {failure_reason}")]
FailedToGetRouteHints { failure_reason: String },
#[error("Payment failed: {failure_reason}")]
FailedPayment { failure_reason: String },
#[error("Failed to route HTLCs: {failure_reason}")]
FailedToRouteHtlcs { failure_reason: String },
#[error("Failed to complete HTLC: {failure_reason}")]
FailedToCompleteHtlc { failure_reason: String },
#[error("Failed to open channel: {failure_reason}")]
FailedToOpenChannel { failure_reason: String },
#[error("Failed to get Invoice: {failure_reason}")]
FailedToGetInvoice { failure_reason: String },
}
#[async_trait]
pub trait ILnRpcClient: Debug + Send + Sync {
async fn info(&self) -> Result<GetNodeInfoResponse, LightningRpcError>;
async fn routehints(
&self,
num_route_hints: usize,
) -> Result<GetRouteHintsResponse, LightningRpcError>;
async fn pay(
&self,
invoice: PayInvoiceRequest,
) -> Result<PayInvoiceResponse, LightningRpcError>;
async fn pay_private(
&self,
_invoice: PrunedInvoice,
_max_delay: u64,
_max_fee: Amount,
) -> Result<PayInvoiceResponse, LightningRpcError> {
Err(LightningRpcError::FailedPayment {
failure_reason: "Private payments not supported".to_string(),
})
}
fn supports_private_payments(&self) -> bool {
false
}
async fn route_htlcs<'a>(
self: Box<Self>,
task_group: &mut TaskGroup,
) -> Result<(RouteHtlcStream<'a>, Arc<dyn ILnRpcClient>), LightningRpcError>;
async fn complete_htlc(
&self,
htlc: InterceptHtlcResponse,
) -> Result<EmptyResponse, LightningRpcError>;
}
#[derive(Debug, Clone, Subcommand, Serialize, Deserialize)]
pub enum LightningMode {
#[clap(name = "lnd")]
Lnd {
#[arg(long = "lnd-rpc-host", env = "FM_LND_RPC_ADDR")]
lnd_rpc_addr: String,
#[arg(long = "lnd-tls-cert", env = "FM_LND_TLS_CERT")]
lnd_tls_cert: String,
#[arg(long = "lnd-macaroon", env = "FM_LND_MACAROON")]
lnd_macaroon: String,
},
#[clap(name = "cln")]
Cln {
#[arg(long = "cln-extension-addr", env = "FM_GATEWAY_LIGHTNING_ADDR")]
cln_extension_addr: SafeUrl,
},
}
#[async_trait]
pub trait LightningBuilder {
async fn build(&self) -> Box<dyn ILnRpcClient>;
}
#[derive(Clone)]
pub struct GatewayLightningBuilder {
pub lightning_mode: LightningMode,
}
#[async_trait]
impl LightningBuilder for GatewayLightningBuilder {
async fn build(&self) -> Box<dyn ILnRpcClient> {
match self.lightning_mode.clone() {
LightningMode::Cln { cln_extension_addr } => {
Box::new(NetworkLnRpcClient::new(cln_extension_addr).await)
}
LightningMode::Lnd {
lnd_rpc_addr,
lnd_tls_cert,
lnd_macaroon,
} => Box::new(
GatewayLndClient::new(lnd_rpc_addr, lnd_tls_cert, lnd_macaroon, None).await,
),
}
}
}