main.rs 14 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442
  1. //! CDK Mint Server
  2. #![warn(missing_docs)]
  3. #![warn(rustdoc::bare_urls)]
  4. use std::env;
  5. use std::net::SocketAddr;
  6. use std::path::PathBuf;
  7. use std::str::FromStr;
  8. use std::sync::Arc;
  9. use anyhow::{anyhow, bail, Result};
  10. use axum::Router;
  11. use bip39::Mnemonic;
  12. use cdk::cdk_database::{self, MintDatabase};
  13. use cdk::mint::{MintBuilder, MintMeltLimits};
  14. // Feature-gated imports
  15. #[cfg(any(
  16. feature = "cln",
  17. feature = "lnbits",
  18. feature = "lnd",
  19. feature = "fakewallet"
  20. ))]
  21. use cdk::nuts::nut17::SupportedMethods;
  22. use cdk::nuts::nut19::{CachedEndpoint, Method as NUT19Method, Path as NUT19Path};
  23. use cdk::nuts::{ContactInfo, CurrencyUnit, MintVersion, PaymentMethod};
  24. use cdk::types::QuoteTTL;
  25. use cdk_axum::cache::HttpCache;
  26. #[cfg(feature = "management-rpc")]
  27. use cdk_mint_rpc::MintRPCServer;
  28. use cdk_mintd::cli::CLIArgs;
  29. use cdk_mintd::config::{self, DatabaseEngine, LnBackend};
  30. use cdk_mintd::env_vars::ENV_WORK_DIR;
  31. use cdk_mintd::setup::LnBackendSetup;
  32. #[cfg(feature = "redb")]
  33. use cdk_redb::MintRedbDatabase;
  34. use cdk_sqlite::MintSqliteDatabase;
  35. use clap::Parser;
  36. use tokio::sync::Notify;
  37. use tower::ServiceBuilder;
  38. use tower_http::compression::CompressionLayer;
  39. use tower_http::decompression::RequestDecompressionLayer;
  40. use tower_http::trace::TraceLayer;
  41. use tracing_subscriber::EnvFilter;
  42. #[cfg(feature = "swagger")]
  43. use utoipa::OpenApi;
  44. const CARGO_PKG_VERSION: Option<&'static str> = option_env!("CARGO_PKG_VERSION");
  45. // Ensure at least one lightning backend is enabled at compile time
  46. #[cfg(not(any(
  47. feature = "cln",
  48. feature = "lnbits",
  49. feature = "lnd",
  50. feature = "fakewallet"
  51. )))]
  52. compile_error!(
  53. "At least one lightning backend feature must be enabled: cln, lnbits, lnd, or fakewallet"
  54. );
  55. #[tokio::main]
  56. async fn main() -> anyhow::Result<()> {
  57. let default_filter = "debug";
  58. let sqlx_filter = "sqlx=warn";
  59. let hyper_filter = "hyper=warn";
  60. let h2_filter = "h2=warn";
  61. let tower_http = "tower_http=warn";
  62. let env_filter = EnvFilter::new(format!(
  63. "{},{},{},{},{}",
  64. default_filter, sqlx_filter, hyper_filter, h2_filter, tower_http
  65. ));
  66. tracing_subscriber::fmt().with_env_filter(env_filter).init();
  67. let args = CLIArgs::parse();
  68. let work_dir = if let Some(work_dir) = args.work_dir {
  69. tracing::info!("Using work dir from cmd arg");
  70. work_dir
  71. } else if let Ok(env_work_dir) = env::var(ENV_WORK_DIR) {
  72. tracing::info!("Using work dir from env var");
  73. env_work_dir.into()
  74. } else {
  75. work_dir()?
  76. };
  77. tracing::info!("Using work dir: {}", work_dir.display());
  78. // get config file name from args
  79. let config_file_arg = match args.config {
  80. Some(c) => c,
  81. None => work_dir.join("config.toml"),
  82. };
  83. let mut mint_builder = MintBuilder::new();
  84. let mut settings = if config_file_arg.exists() {
  85. config::Settings::new(Some(config_file_arg))
  86. } else {
  87. tracing::info!("Config file does not exist. Attempting to read env vars");
  88. config::Settings::default()
  89. };
  90. // This check for any settings defined in ENV VARs
  91. // ENV VARS will take **priority** over those in the config
  92. let settings = settings.from_env()?;
  93. let localstore: Arc<dyn MintDatabase<Err = cdk_database::Error> + Send + Sync> =
  94. match settings.database.engine {
  95. DatabaseEngine::Sqlite => {
  96. let sql_db_path = work_dir.join("cdk-mintd.sqlite");
  97. #[cfg(not(feature = "sqlcipher"))]
  98. let sqlite_db = MintSqliteDatabase::new(&sql_db_path).await?;
  99. #[cfg(feature = "sqlcipher")]
  100. let sqlite_db = MintSqliteDatabase::new(&sql_db_path, args.password).await?;
  101. sqlite_db.migrate().await;
  102. Arc::new(sqlite_db)
  103. }
  104. #[cfg(feature = "redb")]
  105. DatabaseEngine::Redb => {
  106. let redb_path = work_dir.join("cdk-mintd.redb");
  107. Arc::new(MintRedbDatabase::new(&redb_path)?)
  108. }
  109. };
  110. mint_builder = mint_builder.with_localstore(localstore);
  111. let mut contact_info: Option<Vec<ContactInfo>> = None;
  112. if let Some(nostr_contact) = &settings.mint_info.contact_nostr_public_key {
  113. let nostr_contact = ContactInfo::new("nostr".to_string(), nostr_contact.to_string());
  114. contact_info = match contact_info {
  115. Some(mut vec) => {
  116. vec.push(nostr_contact);
  117. Some(vec)
  118. }
  119. None => Some(vec![nostr_contact]),
  120. };
  121. }
  122. if let Some(email_contact) = &settings.mint_info.contact_email {
  123. let email_contact = ContactInfo::new("email".to_string(), email_contact.to_string());
  124. contact_info = match contact_info {
  125. Some(mut vec) => {
  126. vec.push(email_contact);
  127. Some(vec)
  128. }
  129. None => Some(vec![email_contact]),
  130. };
  131. }
  132. let mint_version = MintVersion::new(
  133. "cdk-mintd".to_string(),
  134. CARGO_PKG_VERSION.unwrap_or("Unknown").to_string(),
  135. );
  136. let mut ln_routers = vec![];
  137. let mint_melt_limits = MintMeltLimits {
  138. mint_min: settings.ln.min_mint,
  139. mint_max: settings.ln.max_mint,
  140. melt_min: settings.ln.min_melt,
  141. melt_max: settings.ln.max_melt,
  142. };
  143. match settings.ln.ln_backend {
  144. #[cfg(feature = "cln")]
  145. LnBackend::Cln => {
  146. let cln_settings = settings
  147. .cln
  148. .clone()
  149. .expect("Config checked at load that cln is some");
  150. let cln = cln_settings
  151. .setup(&mut ln_routers, &settings, CurrencyUnit::Msat)
  152. .await?;
  153. let cln = Arc::new(cln);
  154. mint_builder = mint_builder.add_ln_backend(
  155. CurrencyUnit::Sat,
  156. PaymentMethod::Bolt11,
  157. mint_melt_limits,
  158. cln.clone(),
  159. );
  160. let nut17_supported = SupportedMethods::new(PaymentMethod::Bolt11, CurrencyUnit::Sat);
  161. mint_builder = mint_builder.add_supported_websockets(nut17_supported);
  162. }
  163. #[cfg(feature = "lnbits")]
  164. LnBackend::LNbits => {
  165. let lnbits_settings = settings.clone().lnbits.expect("Checked on config load");
  166. let lnbits = lnbits_settings
  167. .setup(&mut ln_routers, &settings, CurrencyUnit::Sat)
  168. .await?;
  169. mint_builder = mint_builder.add_ln_backend(
  170. CurrencyUnit::Sat,
  171. PaymentMethod::Bolt11,
  172. mint_melt_limits,
  173. Arc::new(lnbits),
  174. );
  175. let nut17_supported = SupportedMethods::new(PaymentMethod::Bolt11, CurrencyUnit::Sat);
  176. mint_builder = mint_builder.add_supported_websockets(nut17_supported);
  177. }
  178. #[cfg(feature = "lnd")]
  179. LnBackend::Lnd => {
  180. let lnd_settings = settings.clone().lnd.expect("Checked at config load");
  181. let lnd = lnd_settings
  182. .setup(&mut ln_routers, &settings, CurrencyUnit::Msat)
  183. .await?;
  184. mint_builder = mint_builder.add_ln_backend(
  185. CurrencyUnit::Sat,
  186. PaymentMethod::Bolt11,
  187. mint_melt_limits,
  188. Arc::new(lnd),
  189. );
  190. let nut17_supported = SupportedMethods::new(PaymentMethod::Bolt11, CurrencyUnit::Sat);
  191. mint_builder = mint_builder.add_supported_websockets(nut17_supported);
  192. }
  193. #[cfg(feature = "fakewallet")]
  194. LnBackend::FakeWallet => {
  195. let fake_wallet = settings.clone().fake_wallet.expect("Fake wallet defined");
  196. for unit in fake_wallet.clone().supported_units {
  197. let fake = fake_wallet
  198. .setup(&mut ln_routers, &settings, CurrencyUnit::Sat)
  199. .await?;
  200. let fake = Arc::new(fake);
  201. mint_builder = mint_builder.add_ln_backend(
  202. unit.clone(),
  203. PaymentMethod::Bolt11,
  204. mint_melt_limits,
  205. fake.clone(),
  206. );
  207. let nut17_supported = SupportedMethods::new(PaymentMethod::Bolt11, unit);
  208. mint_builder = mint_builder.add_supported_websockets(nut17_supported);
  209. }
  210. }
  211. LnBackend::None => bail!("Ln backend must be set"),
  212. };
  213. if let Some(long_description) = &settings.mint_info.description_long {
  214. mint_builder = mint_builder.with_long_description(long_description.to_string());
  215. }
  216. if let Some(contact_info) = contact_info {
  217. for info in contact_info {
  218. mint_builder = mint_builder.add_contact_info(info);
  219. }
  220. }
  221. if let Some(pubkey) = settings.mint_info.pubkey {
  222. mint_builder = mint_builder.with_pubkey(pubkey);
  223. }
  224. if let Some(icon_url) = &settings.mint_info.icon_url {
  225. mint_builder = mint_builder.with_icon_url(icon_url.to_string());
  226. }
  227. if let Some(motd) = settings.mint_info.motd {
  228. mint_builder = mint_builder.with_motd(motd);
  229. }
  230. if let Some(tos_url) = &settings.mint_info.tos_url {
  231. mint_builder = mint_builder.with_tos_url(tos_url.to_string());
  232. }
  233. let mnemonic = Mnemonic::from_str(&settings.info.mnemonic)?;
  234. mint_builder = mint_builder
  235. .with_name(settings.mint_info.name)
  236. .with_version(mint_version)
  237. .with_description(settings.mint_info.description)
  238. .with_seed(mnemonic.to_seed_normalized("").to_vec());
  239. let cached_endpoints = vec![
  240. CachedEndpoint::new(NUT19Method::Post, NUT19Path::MintBolt11),
  241. CachedEndpoint::new(NUT19Method::Post, NUT19Path::MeltBolt11),
  242. CachedEndpoint::new(NUT19Method::Post, NUT19Path::Swap),
  243. ];
  244. let cache: HttpCache = settings.info.http_cache.into();
  245. mint_builder = mint_builder.add_cache(Some(cache.ttl.as_secs()), cached_endpoints);
  246. let mint = mint_builder.build().await?;
  247. let mint = Arc::new(mint);
  248. // Check the status of any mint quotes that are pending
  249. // In the event that the mint server is down but the ln node is not
  250. // it is possible that a mint quote was paid but the mint has not been updated
  251. // this will check and update the mint state of those quotes
  252. mint.check_pending_mint_quotes().await?;
  253. // Checks the status of all pending melt quotes
  254. // Pending melt quotes where the payment has gone through inputs are burnt
  255. // Pending melt quotes where the payment has **failed** inputs are reset to unspent
  256. mint.check_pending_melt_quotes().await?;
  257. let listen_addr = settings.info.listen_host;
  258. let listen_port = settings.info.listen_port;
  259. let v1_service =
  260. cdk_axum::create_mint_router_with_custom_cache(Arc::clone(&mint), cache).await?;
  261. let mut mint_service = Router::new()
  262. .merge(v1_service)
  263. .layer(
  264. ServiceBuilder::new()
  265. .layer(RequestDecompressionLayer::new())
  266. .layer(CompressionLayer::new()),
  267. )
  268. .layer(TraceLayer::new_for_http());
  269. #[cfg(feature = "swagger")]
  270. {
  271. if settings.info.enable_swagger_ui.unwrap_or(false) {
  272. mint_service = mint_service.merge(
  273. utoipa_swagger_ui::SwaggerUi::new("/swagger-ui")
  274. .url("/api-docs/openapi.json", cdk_axum::ApiDocV1::openapi()),
  275. );
  276. }
  277. }
  278. for router in ln_routers {
  279. mint_service = mint_service.merge(router);
  280. }
  281. let shutdown = Arc::new(Notify::new());
  282. let mint_clone = Arc::clone(&mint);
  283. tokio::spawn({
  284. let shutdown = Arc::clone(&shutdown);
  285. async move { mint_clone.wait_for_paid_invoices(shutdown).await }
  286. });
  287. #[cfg(feature = "management-rpc")]
  288. let mut rpc_enabled = false;
  289. #[cfg(not(feature = "management-rpc"))]
  290. let rpc_enabled = false;
  291. #[cfg(feature = "management-rpc")]
  292. let mut rpc_server: Option<cdk_mint_rpc::MintRPCServer> = None;
  293. #[cfg(feature = "management-rpc")]
  294. {
  295. if let Some(rpc_settings) = settings.mint_management_rpc {
  296. if rpc_settings.enabled {
  297. let addr = rpc_settings.address.unwrap_or("127.0.0.1".to_string());
  298. let port = rpc_settings.port.unwrap_or(8086);
  299. let mut mint_rpc = MintRPCServer::new(&addr, port, mint.clone())?;
  300. let tls_dir = rpc_settings.tls_dir_path.unwrap_or(work_dir.join("tls"));
  301. if !tls_dir.exists() {
  302. tracing::error!("TLS directory does not exist: {}", tls_dir.display());
  303. bail!("Cannot start RPC server: TLS directory does not exist");
  304. }
  305. mint_rpc.start(Some(tls_dir)).await?;
  306. rpc_server = Some(mint_rpc);
  307. rpc_enabled = true;
  308. }
  309. }
  310. }
  311. if rpc_enabled {
  312. if mint.mint_info().await.is_err() {
  313. tracing::info!("Mint info not set on mint, setting.");
  314. mint.set_mint_info(mint_builder.mint_info).await?;
  315. } else {
  316. tracing::info!("Mint info already set, not using config file settings.");
  317. }
  318. } else {
  319. tracing::warn!("RPC not enabled, using mint info from config.");
  320. mint.set_mint_info(mint_builder.mint_info).await?;
  321. mint.set_quote_ttl(QuoteTTL::new(10_000, 10_000)).await?;
  322. }
  323. let socket_addr = SocketAddr::from_str(&format!("{}:{}", listen_addr, listen_port))?;
  324. let listener = tokio::net::TcpListener::bind(socket_addr).await?;
  325. tracing::debug!("listening on {}", listener.local_addr().unwrap());
  326. let axum_result = axum::serve(listener, mint_service).with_graceful_shutdown(shutdown_signal());
  327. match axum_result.await {
  328. Ok(_) => {
  329. tracing::info!("Axum server stopped with okay status");
  330. }
  331. Err(err) => {
  332. tracing::warn!("Axum server stopped with error");
  333. tracing::error!("{}", err);
  334. bail!("Axum exited with error")
  335. }
  336. }
  337. shutdown.notify_waiters();
  338. #[cfg(feature = "management-rpc")]
  339. {
  340. if let Some(rpc_server) = rpc_server {
  341. rpc_server.stop().await?;
  342. }
  343. }
  344. Ok(())
  345. }
  346. fn work_dir() -> Result<PathBuf> {
  347. let home_dir = home::home_dir().ok_or(anyhow!("Unknown home dir"))?;
  348. let dir = home_dir.join(".cdk-mintd");
  349. std::fs::create_dir_all(&dir)?;
  350. Ok(dir)
  351. }
  352. async fn shutdown_signal() {
  353. tokio::signal::ctrl_c()
  354. .await
  355. .expect("failed to install CTRL+C handler");
  356. tracing::info!("Shutdown signal received");
  357. }