pub mod cln;
pub mod ldk;
pub mod lnd;
use std::fmt::Debug;
use std::path::PathBuf;
use std::str::FromStr;
use std::sync::Arc;
use async_trait::async_trait;
use bitcoin::{Address, Network};
use clap::Subcommand;
use fedimint_bip39::Mnemonic;
use fedimint_core::db::Database;
use fedimint_core::encoding::{Decodable, Encodable};
use fedimint_core::secp256k1::PublicKey;
use fedimint_core::task::TaskGroup;
use fedimint_core::util::SafeUrl;
use fedimint_core::{secp256k1, Amount, BitcoinAmountOrAll};
use fedimint_ln_common::route_hints::RouteHint;
use fedimint_ln_common::PrunedInvoice;
use futures::stream::BoxStream;
use lightning_invoice::Bolt11Invoice;
use serde::{Deserialize, Serialize};
use thiserror::Error;
use self::cln::NetworkLnRpcClient;
use self::lnd::GatewayLndClient;
use crate::envs::{
FM_GATEWAY_LIGHTNING_ADDR_ENV, FM_LDK_ESPLORA_SERVER_URL, FM_LDK_NETWORK, FM_LND_MACAROON_ENV,
FM_LND_RPC_ADDR_ENV, FM_LND_TLS_CERT_ENV, FM_PORT_LDK,
};
use crate::gateway_lnrpc::{
CloseChannelsWithPeerResponse, CreateInvoiceRequest, CreateInvoiceResponse, EmptyResponse,
GetBalancesResponse, GetLnOnchainAddressResponse, GetNodeInfoResponse, GetRouteHintsResponse,
InterceptHtlcRequest, InterceptHtlcResponse, OpenChannelResponse, PayInvoiceResponse,
WithdrawOnchainResponse,
};
pub const MAX_LIGHTNING_RETRIES: u32 = 10;
pub type HtlcResult = std::result::Result<InterceptHtlcRequest, tonic::Status>;
pub type RouteHtlcStream<'a> = BoxStream<'a, HtlcResult>;
#[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 close channel: {failure_reason}")]
FailedToCloseChannelsWithPeer { failure_reason: String },
#[error("Failed to get Invoice: {failure_reason}")]
FailedToGetInvoice { failure_reason: String },
#[error("Failed to get funding address: {failure_reason}")]
FailedToGetLnOnchainAddress { failure_reason: String },
#[error("Failed to withdraw funds on-chain: {failure_reason}")]
FailedToWithdrawOnchain { failure_reason: String },
#[error("Failed to connect to peer: {failure_reason}")]
FailedToConnectToPeer { failure_reason: String },
#[error("Failed to list active channels: {failure_reason}")]
FailedToListActiveChannels { failure_reason: String },
#[error("Failed to get balances: {failure_reason}")]
FailedToGetBalances { failure_reason: String },
#[error("Failed to subscribe to invoice updates: {failure_reason}")]
FailedToSubscribeToInvoiceUpdates { failure_reason: String },
#[error("Failed to sync to chain: {failure_reason}")]
FailedToSyncToChain { failure_reason: String },
#[error("Invalid metadata: {failure_reason}")]
InvalidMetadata { failure_reason: String },
}
#[derive(Clone, Debug)]
pub struct LightningContext {
pub lnrpc: Arc<dyn ILnRpcClient>,
pub lightning_public_key: PublicKey,
pub lightning_alias: String,
pub lightning_network: Network,
}
#[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: Bolt11Invoice,
max_delay: u64,
max_fee: Amount,
) -> Result<PayInvoiceResponse, LightningRpcError> {
self.pay_private(
PrunedInvoice::try_from(invoice).map_err(|_| LightningRpcError::FailedPayment {
failure_reason: "Invoice has no amount".to_string(),
})?,
max_delay,
max_fee,
)
.await
}
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: &TaskGroup,
) -> Result<(RouteHtlcStream<'a>, Arc<dyn ILnRpcClient>), LightningRpcError>;
async fn complete_htlc(
&self,
htlc: InterceptHtlcResponse,
) -> Result<EmptyResponse, LightningRpcError>;
async fn create_invoice(
&self,
create_invoice_request: CreateInvoiceRequest,
) -> Result<CreateInvoiceResponse, LightningRpcError>;
async fn get_ln_onchain_address(
&self,
) -> Result<GetLnOnchainAddressResponse, LightningRpcError>;
async fn withdraw_onchain(
&self,
address: Address,
amount: BitcoinAmountOrAll,
fee_rate_sats_per_vbyte: u64,
) -> Result<WithdrawOnchainResponse, LightningRpcError>;
async fn open_channel(
&self,
pubkey: secp256k1::PublicKey,
host: String,
channel_size_sats: u64,
push_amount_sats: u64,
) -> Result<OpenChannelResponse, LightningRpcError>;
async fn close_channels_with_peer(
&self,
pubkey: secp256k1::PublicKey,
) -> Result<CloseChannelsWithPeerResponse, LightningRpcError>;
async fn list_active_channels(&self) -> Result<Vec<ChannelInfo>, LightningRpcError>;
async fn get_balances(&self) -> Result<GetBalancesResponse, LightningRpcError>;
async fn sync_to_chain(&self, block_height: u32) -> Result<EmptyResponse, LightningRpcError>;
}
impl dyn ILnRpcClient {
pub async fn parsed_route_hints(&self, num_route_hints: u32) -> Vec<RouteHint> {
if num_route_hints == 0 {
return vec![];
}
let route_hints =
self.routehints(num_route_hints as usize)
.await
.unwrap_or(GetRouteHintsResponse {
route_hints: Vec::new(),
});
route_hints.try_into().expect("Could not parse route hints")
}
pub async fn parsed_node_info(
&self,
) -> std::result::Result<(PublicKey, String, Network, u32, bool), LightningRpcError> {
let GetNodeInfoResponse {
pub_key,
alias,
network,
block_height,
synced_to_chain,
} = self.info().await?;
let node_pub_key =
PublicKey::from_slice(&pub_key).map_err(|e| LightningRpcError::InvalidMetadata {
failure_reason: format!("Invalid node pubkey {e}"),
})?;
let network =
Network::from_str(&network).map_err(|e| LightningRpcError::InvalidMetadata {
failure_reason: format!("Invalid network {network}: {e}"),
})?;
Ok((node_pub_key, alias, network, block_height, synced_to_chain))
}
}
#[derive(Serialize, Deserialize, Debug)]
pub struct ChannelInfo {
pub remote_pubkey: secp256k1::PublicKey,
pub channel_size_sats: u64,
pub outbound_liquidity_sats: u64,
pub inbound_liquidity_sats: u64,
pub short_channel_id: u64,
}
#[derive(Debug, Clone, Subcommand, Serialize, Deserialize, Eq, PartialEq)]
pub enum LightningMode {
#[clap(name = "lnd")]
Lnd {
#[arg(long = "lnd-rpc-host", env = FM_LND_RPC_ADDR_ENV)]
lnd_rpc_addr: String,
#[arg(long = "lnd-tls-cert", env = FM_LND_TLS_CERT_ENV)]
lnd_tls_cert: String,
#[arg(long = "lnd-macaroon", env = FM_LND_MACAROON_ENV)]
lnd_macaroon: String,
},
#[clap(name = "cln")]
Cln {
#[arg(long = "cln-extension-addr", env = FM_GATEWAY_LIGHTNING_ADDR_ENV)]
cln_extension_addr: SafeUrl,
},
#[clap(name = "ldk")]
Ldk {
#[arg(long = "ldk-esplora-server-url", env = FM_LDK_ESPLORA_SERVER_URL)]
esplora_server_url: String,
#[arg(long = "ldk-network", env = FM_LDK_NETWORK, default_value = "regtest")]
network: Network,
#[arg(long = "ldk-lightning-port", env = FM_PORT_LDK)]
lightning_port: u16,
},
}
#[async_trait]
pub trait LightningBuilder {
async fn build(&self) -> Box<dyn ILnRpcClient>;
fn lightning_mode(&self) -> Option<LightningMode> {
None
}
}
#[derive(Clone)]
pub struct GatewayLightningBuilder {
pub lightning_mode: LightningMode,
pub gateway_db: Database,
pub ldk_data_dir: PathBuf,
pub mnemonic: Mnemonic,
}
#[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))
}
LightningMode::Lnd {
lnd_rpc_addr,
lnd_tls_cert,
lnd_macaroon,
} => Box::new(GatewayLndClient::new(
lnd_rpc_addr,
lnd_tls_cert,
lnd_macaroon,
None,
self.gateway_db.clone(),
)),
LightningMode::Ldk {
esplora_server_url,
network,
lightning_port,
} => Box::new(
ldk::GatewayLdkClient::new(
&self.ldk_data_dir,
&esplora_server_url,
network,
lightning_port,
self.mnemonic.clone(),
)
.unwrap(),
),
}
}
fn lightning_mode(&self) -> Option<LightningMode> {
Some(self.lightning_mode.clone())
}
}