lib.rs 38 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105
  1. //! Cdk mintd lib
  2. // std
  3. #[cfg(feature = "auth")]
  4. use std::collections::HashMap;
  5. use std::env::{self};
  6. use std::net::SocketAddr;
  7. use std::path::{Path, PathBuf};
  8. use std::str::FromStr;
  9. use std::sync::Arc;
  10. // external crates
  11. use anyhow::{anyhow, bail, Result};
  12. use axum::Router;
  13. use bip39::Mnemonic;
  14. // internal crate modules
  15. use cdk::cdk_database::{self, MintDatabase, MintKVStore, MintKeysDatabase};
  16. use cdk::cdk_payment;
  17. use cdk::cdk_payment::MintPayment;
  18. use cdk::mint::{Mint, MintBuilder, MintMeltLimits};
  19. #[cfg(any(
  20. feature = "cln",
  21. feature = "lnbits",
  22. feature = "lnd",
  23. feature = "ldk-node",
  24. feature = "fakewallet",
  25. feature = "grpc-processor"
  26. ))]
  27. use cdk::nuts::nut17::SupportedMethods;
  28. use cdk::nuts::nut19::{CachedEndpoint, Method as NUT19Method, Path as NUT19Path};
  29. #[cfg(any(
  30. feature = "cln",
  31. feature = "lnbits",
  32. feature = "lnd",
  33. feature = "ldk-node",
  34. feature = "fakewallet"
  35. ))]
  36. use cdk::nuts::CurrencyUnit;
  37. #[cfg(feature = "auth")]
  38. use cdk::nuts::{AuthRequired, Method, ProtectedEndpoint, RoutePath};
  39. use cdk::nuts::{ContactInfo, MintVersion, PaymentMethod};
  40. use cdk::types::QuoteTTL;
  41. use cdk_axum::cache::HttpCache;
  42. #[cfg(feature = "postgres")]
  43. use cdk_postgres::{MintPgAuthDatabase, MintPgDatabase};
  44. #[cfg(all(feature = "auth", feature = "sqlite"))]
  45. use cdk_sqlite::mint::MintSqliteAuthDatabase;
  46. #[cfg(feature = "sqlite")]
  47. use cdk_sqlite::MintSqliteDatabase;
  48. use cli::CLIArgs;
  49. use config::{AuthType, DatabaseEngine, LnBackend};
  50. use env_vars::ENV_WORK_DIR;
  51. use setup::LnBackendSetup;
  52. use tower::ServiceBuilder;
  53. use tower_http::compression::CompressionLayer;
  54. use tower_http::decompression::RequestDecompressionLayer;
  55. use tower_http::trace::TraceLayer;
  56. use tracing_appender::{non_blocking, rolling};
  57. use tracing_subscriber::fmt::writer::MakeWriterExt;
  58. use tracing_subscriber::EnvFilter;
  59. #[cfg(feature = "swagger")]
  60. use utoipa::OpenApi;
  61. pub mod cli;
  62. pub mod config;
  63. pub mod env_vars;
  64. pub mod setup;
  65. const CARGO_PKG_VERSION: Option<&'static str> = option_env!("CARGO_PKG_VERSION");
  66. #[cfg(feature = "cln")]
  67. fn expand_path(path: &str) -> Option<PathBuf> {
  68. if path.starts_with('~') {
  69. if let Some(home_dir) = home::home_dir().as_mut() {
  70. let remainder = &path[2..];
  71. home_dir.push(remainder);
  72. let expanded_path = home_dir;
  73. Some(expanded_path.clone())
  74. } else {
  75. None
  76. }
  77. } else {
  78. Some(PathBuf::from(path))
  79. }
  80. }
  81. /// Performs the initial setup for the application, including configuring tracing,
  82. /// parsing CLI arguments, setting up the working directory, loading settings,
  83. /// and initializing the database connection.
  84. async fn initial_setup(
  85. work_dir: &Path,
  86. settings: &config::Settings,
  87. db_password: Option<String>,
  88. ) -> Result<(
  89. Arc<dyn MintDatabase<cdk_database::Error> + Send + Sync>,
  90. Arc<dyn MintKeysDatabase<Err = cdk_database::Error> + Send + Sync>,
  91. Arc<dyn MintKVStore<Err = cdk_database::Error> + Send + Sync>,
  92. )> {
  93. let (localstore, keystore, kv) = setup_database(settings, work_dir, db_password).await?;
  94. Ok((localstore, keystore, kv))
  95. }
  96. /// Sets up and initializes a tracing subscriber with custom log filtering.
  97. /// Logs can be configured to output to stdout only, file only, or both.
  98. /// Returns a guard that must be kept alive and properly dropped on shutdown.
  99. pub fn setup_tracing(
  100. work_dir: &Path,
  101. logging_config: &config::LoggingConfig,
  102. ) -> Result<Option<tracing_appender::non_blocking::WorkerGuard>> {
  103. let default_filter = "debug";
  104. let hyper_filter = "hyper=warn,rustls=warn,reqwest=warn";
  105. let h2_filter = "h2=warn";
  106. let tower_http = "tower_http=warn";
  107. let rustls = "rustls=warn";
  108. let env_filter = EnvFilter::new(format!(
  109. "{default_filter},{hyper_filter},{h2_filter},{tower_http},{rustls}"
  110. ));
  111. use config::LoggingOutput;
  112. match logging_config.output {
  113. LoggingOutput::Stderr => {
  114. // Console output only (stderr)
  115. let console_level = logging_config
  116. .console_level
  117. .as_deref()
  118. .unwrap_or("info")
  119. .parse::<tracing::Level>()
  120. .unwrap_or(tracing::Level::INFO);
  121. let stderr = std::io::stderr.with_max_level(console_level);
  122. tracing_subscriber::fmt()
  123. .with_env_filter(env_filter)
  124. .with_writer(stderr)
  125. .init();
  126. tracing::info!("Logging initialized: console only ({}+)", console_level);
  127. Ok(None)
  128. }
  129. LoggingOutput::File => {
  130. // File output only
  131. let file_level = logging_config
  132. .file_level
  133. .as_deref()
  134. .unwrap_or("debug")
  135. .parse::<tracing::Level>()
  136. .unwrap_or(tracing::Level::DEBUG);
  137. // Create logs directory in work_dir if it doesn't exist
  138. let logs_dir = work_dir.join("logs");
  139. std::fs::create_dir_all(&logs_dir)?;
  140. // Set up file appender with daily rotation
  141. let file_appender = rolling::daily(&logs_dir, "cdk-mintd.log");
  142. let (non_blocking_appender, guard) = non_blocking(file_appender);
  143. let file_writer = non_blocking_appender.with_max_level(file_level);
  144. tracing_subscriber::fmt()
  145. .with_env_filter(env_filter)
  146. .with_writer(file_writer)
  147. .init();
  148. tracing::info!(
  149. "Logging initialized: file only at {}/cdk-mintd.log ({}+)",
  150. logs_dir.display(),
  151. file_level
  152. );
  153. Ok(Some(guard))
  154. }
  155. LoggingOutput::Both => {
  156. // Both console and file output (stderr + file)
  157. let console_level = logging_config
  158. .console_level
  159. .as_deref()
  160. .unwrap_or("info")
  161. .parse::<tracing::Level>()
  162. .unwrap_or(tracing::Level::INFO);
  163. let file_level = logging_config
  164. .file_level
  165. .as_deref()
  166. .unwrap_or("debug")
  167. .parse::<tracing::Level>()
  168. .unwrap_or(tracing::Level::DEBUG);
  169. // Create logs directory in work_dir if it doesn't exist
  170. let logs_dir = work_dir.join("logs");
  171. std::fs::create_dir_all(&logs_dir)?;
  172. // Set up file appender with daily rotation
  173. let file_appender = rolling::daily(&logs_dir, "cdk-mintd.log");
  174. let (non_blocking_appender, guard) = non_blocking(file_appender);
  175. // Combine console output (stderr) and file output
  176. let stderr = std::io::stderr.with_max_level(console_level);
  177. let file_writer = non_blocking_appender.with_max_level(file_level);
  178. tracing_subscriber::fmt()
  179. .with_env_filter(env_filter)
  180. .with_writer(stderr.and(file_writer))
  181. .init();
  182. tracing::info!(
  183. "Logging initialized: console ({}+) and file at {}/cdk-mintd.log ({}+)",
  184. console_level,
  185. logs_dir.display(),
  186. file_level
  187. );
  188. Ok(Some(guard))
  189. }
  190. }
  191. }
  192. /// Retrieves the work directory based on command-line arguments, environment variables, or system defaults.
  193. pub async fn get_work_directory(args: &CLIArgs) -> Result<PathBuf> {
  194. let work_dir = if let Some(work_dir) = &args.work_dir {
  195. tracing::info!("Using work dir from cmd arg");
  196. work_dir.clone()
  197. } else if let Ok(env_work_dir) = env::var(ENV_WORK_DIR) {
  198. tracing::info!("Using work dir from env var");
  199. env_work_dir.into()
  200. } else {
  201. work_dir()?
  202. };
  203. tracing::info!("Using work dir: {}", work_dir.display());
  204. Ok(work_dir)
  205. }
  206. /// Loads the application settings based on a configuration file and environment variables.
  207. pub fn load_settings(work_dir: &Path, config_path: Option<PathBuf>) -> Result<config::Settings> {
  208. // get config file name from args
  209. let config_file_arg = match config_path {
  210. Some(c) => c,
  211. None => work_dir.join("config.toml"),
  212. };
  213. let mut settings = if config_file_arg.exists() {
  214. config::Settings::new(Some(config_file_arg))
  215. } else {
  216. tracing::info!("Config file does not exist. Attempting to read env vars");
  217. config::Settings::default()
  218. };
  219. // This check for any settings defined in ENV VARs
  220. // ENV VARS will take **priority** over those in the config
  221. settings.from_env()
  222. }
  223. async fn setup_database(
  224. settings: &config::Settings,
  225. _work_dir: &Path,
  226. _db_password: Option<String>,
  227. ) -> Result<(
  228. Arc<dyn MintDatabase<cdk_database::Error> + Send + Sync>,
  229. Arc<dyn MintKeysDatabase<Err = cdk_database::Error> + Send + Sync>,
  230. Arc<dyn MintKVStore<Err = cdk_database::Error> + Send + Sync>,
  231. )> {
  232. match settings.database.engine {
  233. #[cfg(feature = "sqlite")]
  234. DatabaseEngine::Sqlite => {
  235. let db = setup_sqlite_database(_work_dir, _db_password).await?;
  236. let localstore: Arc<dyn MintDatabase<cdk_database::Error> + Send + Sync> = db.clone();
  237. let kv: Arc<dyn MintKVStore<Err = cdk_database::Error> + Send + Sync> = db.clone();
  238. let keystore: Arc<dyn MintKeysDatabase<Err = cdk_database::Error> + Send + Sync> = db;
  239. Ok((localstore, keystore, kv))
  240. }
  241. #[cfg(feature = "postgres")]
  242. DatabaseEngine::Postgres => {
  243. // Get the PostgreSQL configuration, ensuring it exists
  244. let pg_config = settings.database.postgres.as_ref().ok_or_else(|| {
  245. anyhow!("PostgreSQL configuration is required when using PostgreSQL engine")
  246. })?;
  247. if pg_config.url.is_empty() {
  248. bail!("PostgreSQL URL is required. Set it in config file [database.postgres] section or via CDK_MINTD_POSTGRES_URL/CDK_MINTD_DATABASE_URL environment variable");
  249. }
  250. #[cfg(feature = "postgres")]
  251. let pg_db = Arc::new(MintPgDatabase::new(pg_config.url.as_str()).await?);
  252. #[cfg(feature = "postgres")]
  253. let localstore: Arc<dyn MintDatabase<cdk_database::Error> + Send + Sync> =
  254. pg_db.clone();
  255. #[cfg(feature = "postgres")]
  256. let kv: Arc<dyn MintKVStore<Err = cdk_database::Error> + Send + Sync> = pg_db.clone();
  257. #[cfg(feature = "postgres")]
  258. let keystore: Arc<
  259. dyn MintKeysDatabase<Err = cdk_database::Error> + Send + Sync,
  260. > = pg_db;
  261. #[cfg(feature = "postgres")]
  262. return Ok((localstore, keystore, kv));
  263. #[cfg(not(feature = "postgres"))]
  264. bail!("PostgreSQL support not compiled in. Enable the 'postgres' feature to use PostgreSQL database.")
  265. }
  266. #[cfg(not(feature = "sqlite"))]
  267. DatabaseEngine::Sqlite => {
  268. bail!("SQLite support not compiled in. Enable the 'sqlite' feature to use SQLite database.")
  269. }
  270. #[cfg(not(feature = "postgres"))]
  271. DatabaseEngine::Postgres => {
  272. bail!("PostgreSQL support not compiled in. Enable the 'postgres' feature to use PostgreSQL database.")
  273. }
  274. }
  275. }
  276. #[cfg(feature = "sqlite")]
  277. async fn setup_sqlite_database(
  278. work_dir: &Path,
  279. _password: Option<String>,
  280. ) -> Result<Arc<MintSqliteDatabase>> {
  281. let sql_db_path = work_dir.join("cdk-mintd.sqlite");
  282. #[cfg(not(feature = "sqlcipher"))]
  283. let db = MintSqliteDatabase::new(&sql_db_path).await?;
  284. #[cfg(feature = "sqlcipher")]
  285. let db = {
  286. // Get password from command line arguments for sqlcipher
  287. MintSqliteDatabase::new((sql_db_path, _password.unwrap())).await?
  288. };
  289. Ok(Arc::new(db))
  290. }
  291. /**
  292. * Configures a `MintBuilder` instance with provided settings and initializes
  293. * routers for Lightning Network backends.
  294. */
  295. async fn configure_mint_builder(
  296. settings: &config::Settings,
  297. mint_builder: MintBuilder,
  298. runtime: Option<std::sync::Arc<tokio::runtime::Runtime>>,
  299. work_dir: &Path,
  300. kv_store: Option<Arc<dyn MintKVStore<Err = cdk::cdk_database::Error> + Send + Sync>>,
  301. ) -> Result<(MintBuilder, Vec<Router>)> {
  302. let mut ln_routers = vec![];
  303. // Configure basic mint information
  304. let mint_builder = configure_basic_info(settings, mint_builder);
  305. // Configure lightning backend
  306. let mint_builder = configure_lightning_backend(
  307. settings,
  308. mint_builder,
  309. &mut ln_routers,
  310. runtime,
  311. work_dir,
  312. kv_store,
  313. )
  314. .await?;
  315. // Configure caching
  316. let mint_builder = configure_cache(settings, mint_builder);
  317. Ok((mint_builder, ln_routers))
  318. }
  319. /// Configures basic mint information (name, contact info, descriptions, etc.)
  320. fn configure_basic_info(settings: &config::Settings, mint_builder: MintBuilder) -> MintBuilder {
  321. // Add contact information
  322. let mut contacts = Vec::new();
  323. if let Some(nostr_key) = &settings.mint_info.contact_nostr_public_key {
  324. contacts.push(ContactInfo::new("nostr".to_string(), nostr_key.to_string()));
  325. }
  326. if let Some(email) = &settings.mint_info.contact_email {
  327. contacts.push(ContactInfo::new("email".to_string(), email.to_string()));
  328. }
  329. // Add version information
  330. let mint_version = MintVersion::new(
  331. "cdk-mintd".to_string(),
  332. CARGO_PKG_VERSION.unwrap_or("Unknown").to_string(),
  333. );
  334. // Configure mint builder with basic info
  335. let mut builder = mint_builder
  336. .with_name(settings.mint_info.name.clone())
  337. .with_version(mint_version)
  338. .with_description(settings.mint_info.description.clone());
  339. // Add optional information
  340. if let Some(long_description) = &settings.mint_info.description_long {
  341. builder = builder.with_long_description(long_description.to_string());
  342. }
  343. for contact in contacts {
  344. builder = builder.with_contact_info(contact);
  345. }
  346. if let Some(pubkey) = settings.mint_info.pubkey {
  347. builder = builder.with_pubkey(pubkey);
  348. }
  349. if let Some(icon_url) = &settings.mint_info.icon_url {
  350. builder = builder.with_icon_url(icon_url.to_string());
  351. }
  352. if let Some(motd) = &settings.mint_info.motd {
  353. builder = builder.with_motd(motd.to_string());
  354. }
  355. if let Some(tos_url) = &settings.mint_info.tos_url {
  356. builder = builder.with_tos_url(tos_url.to_string());
  357. }
  358. builder
  359. }
  360. /// Configures Lightning Network backend based on the specified backend type
  361. async fn configure_lightning_backend(
  362. settings: &config::Settings,
  363. mut mint_builder: MintBuilder,
  364. ln_routers: &mut Vec<Router>,
  365. _runtime: Option<std::sync::Arc<tokio::runtime::Runtime>>,
  366. work_dir: &Path,
  367. _kv_store: Option<Arc<dyn MintKVStore<Err = cdk::cdk_database::Error> + Send + Sync>>,
  368. ) -> Result<MintBuilder> {
  369. let mint_melt_limits = MintMeltLimits {
  370. mint_min: settings.ln.min_mint,
  371. mint_max: settings.ln.max_mint,
  372. melt_min: settings.ln.min_melt,
  373. melt_max: settings.ln.max_melt,
  374. };
  375. tracing::debug!("Ln backend: {:?}", settings.ln.ln_backend);
  376. match settings.ln.ln_backend {
  377. #[cfg(feature = "cln")]
  378. LnBackend::Cln => {
  379. let cln_settings = settings
  380. .cln
  381. .clone()
  382. .expect("Config checked at load that cln is some");
  383. let cln = cln_settings
  384. .setup(
  385. ln_routers,
  386. settings,
  387. CurrencyUnit::Msat,
  388. None,
  389. work_dir,
  390. None,
  391. )
  392. .await?;
  393. mint_builder = configure_backend_for_unit(
  394. settings,
  395. mint_builder,
  396. CurrencyUnit::Sat,
  397. mint_melt_limits,
  398. Arc::new(cln),
  399. )
  400. .await?;
  401. }
  402. #[cfg(feature = "lnbits")]
  403. LnBackend::LNbits => {
  404. let lnbits_settings = settings.clone().lnbits.expect("Checked on config load");
  405. let lnbits = lnbits_settings
  406. .setup(
  407. ln_routers,
  408. settings,
  409. CurrencyUnit::Sat,
  410. None,
  411. work_dir,
  412. None,
  413. )
  414. .await?;
  415. mint_builder = configure_backend_for_unit(
  416. settings,
  417. mint_builder,
  418. CurrencyUnit::Sat,
  419. mint_melt_limits,
  420. Arc::new(lnbits),
  421. )
  422. .await?;
  423. }
  424. #[cfg(feature = "lnd")]
  425. LnBackend::Lnd => {
  426. let lnd_settings = settings.clone().lnd.expect("Checked at config load");
  427. let lnd = lnd_settings
  428. .setup(
  429. ln_routers,
  430. settings,
  431. CurrencyUnit::Msat,
  432. None,
  433. work_dir,
  434. None,
  435. )
  436. .await?;
  437. mint_builder = configure_backend_for_unit(
  438. settings,
  439. mint_builder,
  440. CurrencyUnit::Sat,
  441. mint_melt_limits,
  442. Arc::new(lnd),
  443. )
  444. .await?;
  445. }
  446. #[cfg(feature = "fakewallet")]
  447. LnBackend::FakeWallet => {
  448. let fake_wallet = settings.clone().fake_wallet.expect("Fake wallet defined");
  449. tracing::info!("Using fake wallet: {:?}", fake_wallet);
  450. for unit in fake_wallet.clone().supported_units {
  451. let fake = fake_wallet
  452. .setup(
  453. ln_routers,
  454. settings,
  455. unit.clone(),
  456. None,
  457. work_dir,
  458. _kv_store.clone(),
  459. )
  460. .await?;
  461. mint_builder = configure_backend_for_unit(
  462. settings,
  463. mint_builder,
  464. unit.clone(),
  465. mint_melt_limits,
  466. Arc::new(fake),
  467. )
  468. .await?;
  469. }
  470. }
  471. #[cfg(feature = "grpc-processor")]
  472. LnBackend::GrpcProcessor => {
  473. let grpc_processor = settings
  474. .clone()
  475. .grpc_processor
  476. .expect("grpc processor config defined");
  477. tracing::info!(
  478. "Attempting to start with gRPC payment processor at {}:{}.",
  479. grpc_processor.addr,
  480. grpc_processor.port
  481. );
  482. for unit in grpc_processor.clone().supported_units {
  483. tracing::debug!("Adding unit: {:?}", unit);
  484. let processor = grpc_processor
  485. .setup(ln_routers, settings, unit.clone(), None, work_dir, None)
  486. .await?;
  487. mint_builder = configure_backend_for_unit(
  488. settings,
  489. mint_builder,
  490. unit.clone(),
  491. mint_melt_limits,
  492. Arc::new(processor),
  493. )
  494. .await?;
  495. }
  496. }
  497. #[cfg(feature = "ldk-node")]
  498. LnBackend::LdkNode => {
  499. let ldk_node_settings = settings.clone().ldk_node.expect("Checked at config load");
  500. tracing::info!("Using LDK Node backend: {:?}", ldk_node_settings);
  501. let ldk_node = ldk_node_settings
  502. .setup(
  503. ln_routers,
  504. settings,
  505. CurrencyUnit::Sat,
  506. _runtime,
  507. work_dir,
  508. None,
  509. )
  510. .await?;
  511. mint_builder = configure_backend_for_unit(
  512. settings,
  513. mint_builder,
  514. CurrencyUnit::Sat,
  515. mint_melt_limits,
  516. Arc::new(ldk_node),
  517. )
  518. .await?;
  519. }
  520. LnBackend::None => {
  521. tracing::error!(
  522. "Payment backend was not set or feature disabled. {:?}",
  523. settings.ln.ln_backend
  524. );
  525. bail!("Lightning backend must be configured");
  526. }
  527. };
  528. Ok(mint_builder)
  529. }
  530. /// Helper function to configure a mint builder with a lightning backend for a specific currency unit
  531. async fn configure_backend_for_unit(
  532. settings: &config::Settings,
  533. mut mint_builder: MintBuilder,
  534. unit: cdk::nuts::CurrencyUnit,
  535. mint_melt_limits: MintMeltLimits,
  536. backend: Arc<dyn MintPayment<Err = cdk_payment::Error> + Send + Sync>,
  537. ) -> Result<MintBuilder> {
  538. let payment_settings = backend.get_settings().await?;
  539. if let Some(bolt12) = payment_settings.get("bolt12") {
  540. if bolt12.as_bool().unwrap_or_default() {
  541. mint_builder
  542. .add_payment_processor(
  543. unit.clone(),
  544. PaymentMethod::Bolt12,
  545. mint_melt_limits,
  546. Arc::clone(&backend),
  547. )
  548. .await?;
  549. let nut17_supported = SupportedMethods::default_bolt12(unit.clone());
  550. mint_builder = mint_builder.with_supported_websockets(nut17_supported);
  551. }
  552. }
  553. mint_builder
  554. .add_payment_processor(
  555. unit.clone(),
  556. PaymentMethod::Bolt11,
  557. mint_melt_limits,
  558. backend,
  559. )
  560. .await?;
  561. if let Some(input_fee) = settings.info.input_fee_ppk {
  562. mint_builder.set_unit_fee(&unit, input_fee)?;
  563. }
  564. #[cfg(any(
  565. feature = "cln",
  566. feature = "lnbits",
  567. feature = "lnd",
  568. feature = "fakewallet",
  569. feature = "grpc-processor",
  570. feature = "ldk-node"
  571. ))]
  572. {
  573. let nut17_supported = SupportedMethods::default_bolt11(unit);
  574. mint_builder = mint_builder.with_supported_websockets(nut17_supported);
  575. }
  576. Ok(mint_builder)
  577. }
  578. /// Configures cache settings
  579. fn configure_cache(settings: &config::Settings, mint_builder: MintBuilder) -> MintBuilder {
  580. let cached_endpoints = vec![
  581. CachedEndpoint::new(NUT19Method::Post, NUT19Path::MintBolt11),
  582. CachedEndpoint::new(NUT19Method::Post, NUT19Path::MeltBolt11),
  583. CachedEndpoint::new(NUT19Method::Post, NUT19Path::Swap),
  584. ];
  585. let cache: HttpCache = settings.info.http_cache.clone().into();
  586. mint_builder.with_cache(Some(cache.ttl.as_secs()), cached_endpoints)
  587. }
  588. #[cfg(feature = "auth")]
  589. async fn setup_authentication(
  590. settings: &config::Settings,
  591. _work_dir: &Path,
  592. mut mint_builder: MintBuilder,
  593. _password: Option<String>,
  594. ) -> Result<MintBuilder> {
  595. if let Some(auth_settings) = settings.auth.clone() {
  596. tracing::info!("Auth settings are defined. {:?}", auth_settings);
  597. let auth_localstore: Arc<
  598. dyn cdk_database::MintAuthDatabase<Err = cdk_database::Error> + Send + Sync,
  599. > = match settings.database.engine {
  600. #[cfg(feature = "sqlite")]
  601. DatabaseEngine::Sqlite => {
  602. #[cfg(feature = "sqlite")]
  603. {
  604. let sql_db_path = _work_dir.join("cdk-mintd-auth.sqlite");
  605. #[cfg(not(feature = "sqlcipher"))]
  606. let sqlite_db = MintSqliteAuthDatabase::new(&sql_db_path).await?;
  607. #[cfg(feature = "sqlcipher")]
  608. let sqlite_db = {
  609. // Get password from command line arguments for sqlcipher
  610. MintSqliteAuthDatabase::new((sql_db_path, _password.unwrap())).await?
  611. };
  612. Arc::new(sqlite_db)
  613. }
  614. #[cfg(not(feature = "sqlite"))]
  615. {
  616. bail!("SQLite support not compiled in. Enable the 'sqlite' feature to use SQLite database.")
  617. }
  618. }
  619. #[cfg(feature = "postgres")]
  620. DatabaseEngine::Postgres => {
  621. #[cfg(feature = "postgres")]
  622. {
  623. // Get the PostgreSQL configuration, ensuring it exists
  624. let pg_config = settings.database.postgres.as_ref().ok_or_else(|| {
  625. anyhow!("PostgreSQL configuration is required when using PostgreSQL engine")
  626. })?;
  627. if pg_config.url.is_empty() {
  628. bail!("PostgreSQL URL is required for auth database. Set it in config file [database.postgres] section or via CDK_MINTD_POSTGRES_URL/CDK_MINTD_DATABASE_URL environment variable");
  629. }
  630. Arc::new(MintPgAuthDatabase::new(pg_config.url.as_str()).await?)
  631. }
  632. #[cfg(not(feature = "postgres"))]
  633. {
  634. bail!("PostgreSQL support not compiled in. Enable the 'postgres' feature to use PostgreSQL database.")
  635. }
  636. }
  637. #[cfg(not(feature = "sqlite"))]
  638. DatabaseEngine::Sqlite => {
  639. bail!("SQLite support not compiled in. Enable the 'sqlite' feature to use SQLite database.")
  640. }
  641. #[cfg(not(feature = "postgres"))]
  642. DatabaseEngine::Postgres => {
  643. bail!("PostgreSQL support not compiled in. Enable the 'postgres' feature to use PostgreSQL database.")
  644. }
  645. };
  646. let mut protected_endpoints = HashMap::new();
  647. let mut blind_auth_endpoints = vec![];
  648. let mut clear_auth_endpoints = vec![];
  649. let mut unprotected_endpoints = vec![];
  650. let mint_blind_auth_endpoint =
  651. ProtectedEndpoint::new(Method::Post, RoutePath::MintBlindAuth);
  652. protected_endpoints.insert(mint_blind_auth_endpoint, AuthRequired::Clear);
  653. clear_auth_endpoints.push(mint_blind_auth_endpoint);
  654. // Helper function to add endpoint based on auth type
  655. let mut add_endpoint = |endpoint: ProtectedEndpoint, auth_type: &AuthType| {
  656. match auth_type {
  657. AuthType::Blind => {
  658. protected_endpoints.insert(endpoint, AuthRequired::Blind);
  659. blind_auth_endpoints.push(endpoint);
  660. }
  661. AuthType::Clear => {
  662. protected_endpoints.insert(endpoint, AuthRequired::Clear);
  663. clear_auth_endpoints.push(endpoint);
  664. }
  665. AuthType::None => {
  666. unprotected_endpoints.push(endpoint);
  667. }
  668. };
  669. };
  670. // Get mint quote endpoint
  671. {
  672. let mint_quote_protected_endpoint =
  673. ProtectedEndpoint::new(cdk::nuts::Method::Post, RoutePath::MintQuoteBolt11);
  674. add_endpoint(mint_quote_protected_endpoint, &auth_settings.get_mint_quote);
  675. }
  676. // Check mint quote endpoint
  677. {
  678. let check_mint_protected_endpoint =
  679. ProtectedEndpoint::new(Method::Get, RoutePath::MintQuoteBolt11);
  680. add_endpoint(
  681. check_mint_protected_endpoint,
  682. &auth_settings.check_mint_quote,
  683. );
  684. }
  685. // Mint endpoint
  686. {
  687. let mint_protected_endpoint =
  688. ProtectedEndpoint::new(cdk::nuts::Method::Post, RoutePath::MintBolt11);
  689. add_endpoint(mint_protected_endpoint, &auth_settings.mint);
  690. }
  691. // Get melt quote endpoint
  692. {
  693. let melt_quote_protected_endpoint = ProtectedEndpoint::new(
  694. cdk::nuts::Method::Post,
  695. cdk::nuts::RoutePath::MeltQuoteBolt11,
  696. );
  697. add_endpoint(melt_quote_protected_endpoint, &auth_settings.get_melt_quote);
  698. }
  699. // Check melt quote endpoint
  700. {
  701. let check_melt_protected_endpoint =
  702. ProtectedEndpoint::new(Method::Get, RoutePath::MeltQuoteBolt11);
  703. add_endpoint(
  704. check_melt_protected_endpoint,
  705. &auth_settings.check_melt_quote,
  706. );
  707. }
  708. // Melt endpoint
  709. {
  710. let melt_protected_endpoint =
  711. ProtectedEndpoint::new(Method::Post, RoutePath::MeltBolt11);
  712. add_endpoint(melt_protected_endpoint, &auth_settings.melt);
  713. }
  714. // Swap endpoint
  715. {
  716. let swap_protected_endpoint = ProtectedEndpoint::new(Method::Post, RoutePath::Swap);
  717. add_endpoint(swap_protected_endpoint, &auth_settings.swap);
  718. }
  719. // Restore endpoint
  720. {
  721. let restore_protected_endpoint =
  722. ProtectedEndpoint::new(Method::Post, RoutePath::Restore);
  723. add_endpoint(restore_protected_endpoint, &auth_settings.restore);
  724. }
  725. // Check proof state endpoint
  726. {
  727. let state_protected_endpoint =
  728. ProtectedEndpoint::new(Method::Post, RoutePath::Checkstate);
  729. add_endpoint(state_protected_endpoint, &auth_settings.check_proof_state);
  730. }
  731. mint_builder = mint_builder.with_auth(
  732. auth_localstore.clone(),
  733. auth_settings.openid_discovery,
  734. auth_settings.openid_client_id,
  735. clear_auth_endpoints,
  736. );
  737. mint_builder =
  738. mint_builder.with_blind_auth(auth_settings.mint_max_bat, blind_auth_endpoints);
  739. let mut tx = auth_localstore.begin_transaction().await?;
  740. tx.remove_protected_endpoints(unprotected_endpoints).await?;
  741. tx.add_protected_endpoints(protected_endpoints).await?;
  742. tx.commit().await?;
  743. }
  744. Ok(mint_builder)
  745. }
  746. /// Build mints with the configured the signing method (remote signatory or local seed)
  747. async fn build_mint(
  748. settings: &config::Settings,
  749. keystore: Arc<dyn MintKeysDatabase<Err = cdk_database::Error> + Send + Sync>,
  750. mint_builder: MintBuilder,
  751. ) -> Result<Mint> {
  752. if let Some(signatory_url) = settings.info.signatory_url.clone() {
  753. tracing::info!(
  754. "Connecting to remote signatory to {} with certs {:?}",
  755. signatory_url,
  756. settings.info.signatory_certs.clone()
  757. );
  758. Ok(mint_builder
  759. .build_with_signatory(Arc::new(
  760. cdk_signatory::SignatoryRpcClient::new(
  761. signatory_url,
  762. settings.info.signatory_certs.clone(),
  763. )
  764. .await?,
  765. ))
  766. .await?)
  767. } else if let Some(seed) = settings.info.seed.clone() {
  768. let seed_bytes: Vec<u8> = seed.into();
  769. Ok(mint_builder.build_with_seed(keystore, &seed_bytes).await?)
  770. } else if let Some(mnemonic) = settings
  771. .info
  772. .mnemonic
  773. .clone()
  774. .map(|s| Mnemonic::from_str(&s))
  775. .transpose()?
  776. {
  777. Ok(mint_builder
  778. .build_with_seed(keystore, &mnemonic.to_seed_normalized(""))
  779. .await?)
  780. } else {
  781. bail!("No seed nor remote signatory set");
  782. }
  783. }
  784. async fn start_services_with_shutdown(
  785. mint: Arc<cdk::mint::Mint>,
  786. settings: &config::Settings,
  787. ln_routers: Vec<Router>,
  788. work_dir: &Path,
  789. mint_builder_info: cdk::nuts::MintInfo,
  790. shutdown_signal: impl std::future::Future<Output = ()> + Send + 'static,
  791. ) -> Result<()> {
  792. let listen_addr = settings.info.listen_host.clone();
  793. let listen_port = settings.info.listen_port;
  794. let cache: HttpCache = settings.info.http_cache.clone().into();
  795. #[cfg(feature = "management-rpc")]
  796. let mut rpc_enabled = false;
  797. #[cfg(not(feature = "management-rpc"))]
  798. let rpc_enabled = false;
  799. #[cfg(feature = "management-rpc")]
  800. let mut rpc_server: Option<cdk_mint_rpc::MintRPCServer> = None;
  801. #[cfg(feature = "management-rpc")]
  802. {
  803. if let Some(rpc_settings) = settings.mint_management_rpc.clone() {
  804. if rpc_settings.enabled {
  805. let addr = rpc_settings.address.unwrap_or("127.0.0.1".to_string());
  806. let port = rpc_settings.port.unwrap_or(8086);
  807. let mut mint_rpc = cdk_mint_rpc::MintRPCServer::new(&addr, port, mint.clone())?;
  808. let tls_dir = rpc_settings.tls_dir_path.unwrap_or(work_dir.join("tls"));
  809. if !tls_dir.exists() {
  810. tracing::error!("TLS directory does not exist: {}", tls_dir.display());
  811. bail!("Cannot start RPC server: TLS directory does not exist");
  812. }
  813. mint_rpc.start(Some(tls_dir)).await?;
  814. rpc_server = Some(mint_rpc);
  815. rpc_enabled = true;
  816. }
  817. }
  818. }
  819. if rpc_enabled {
  820. if mint.mint_info().await.is_err() {
  821. tracing::info!("Mint info not set on mint, setting.");
  822. mint.set_mint_info(mint_builder_info).await?;
  823. mint.set_quote_ttl(QuoteTTL::new(10_000, 10_000)).await?;
  824. } else {
  825. if mint.localstore().get_quote_ttl().await.is_err() {
  826. mint.set_quote_ttl(QuoteTTL::new(10_000, 10_000)).await?;
  827. }
  828. // Add version information
  829. let mint_version = MintVersion::new(
  830. "cdk-mintd".to_string(),
  831. CARGO_PKG_VERSION.unwrap_or("Unknown").to_string(),
  832. );
  833. let mut stored_mint_info = mint.mint_info().await?;
  834. stored_mint_info.version = Some(mint_version);
  835. mint.set_mint_info(stored_mint_info).await?;
  836. tracing::info!("Mint info already set, not using config file settings.");
  837. }
  838. } else {
  839. tracing::info!("RPC not enabled, using mint info from config.");
  840. mint.set_mint_info(mint_builder_info).await?;
  841. mint.set_quote_ttl(QuoteTTL::new(10_000, 10_000)).await?;
  842. }
  843. let mint_info = mint.mint_info().await?;
  844. let nut04_methods = mint_info.nuts.nut04.supported_methods();
  845. let nut05_methods = mint_info.nuts.nut05.supported_methods();
  846. let bolt12_supported = nut04_methods.contains(&&PaymentMethod::Bolt12)
  847. || nut05_methods.contains(&&PaymentMethod::Bolt12);
  848. let v1_service =
  849. cdk_axum::create_mint_router_with_custom_cache(Arc::clone(&mint), cache, bolt12_supported)
  850. .await?;
  851. let mut mint_service = Router::new()
  852. .merge(v1_service)
  853. .layer(
  854. ServiceBuilder::new()
  855. .layer(RequestDecompressionLayer::new())
  856. .layer(CompressionLayer::new()),
  857. )
  858. .layer(TraceLayer::new_for_http());
  859. #[cfg(feature = "swagger")]
  860. {
  861. if settings.info.enable_swagger_ui.unwrap_or(false) {
  862. mint_service = mint_service.merge(
  863. utoipa_swagger_ui::SwaggerUi::new("/swagger-ui")
  864. .url("/api-docs/openapi.json", cdk_axum::ApiDoc::openapi()),
  865. );
  866. }
  867. }
  868. for router in ln_routers {
  869. mint_service = mint_service.merge(router);
  870. }
  871. mint.start().await?;
  872. let socket_addr = SocketAddr::from_str(&format!("{listen_addr}:{listen_port}"))?;
  873. let listener = tokio::net::TcpListener::bind(socket_addr).await?;
  874. tracing::info!("listening on {}", listener.local_addr().unwrap());
  875. // Wait for axum server to complete with custom shutdown signal
  876. let axum_result = axum::serve(listener, mint_service).with_graceful_shutdown(shutdown_signal);
  877. match axum_result.await {
  878. Ok(_) => {
  879. tracing::info!("Axum server stopped with okay status");
  880. }
  881. Err(err) => {
  882. tracing::warn!("Axum server stopped with error");
  883. tracing::error!("{}", err);
  884. bail!("Axum exited with error")
  885. }
  886. }
  887. mint.stop().await?;
  888. #[cfg(feature = "management-rpc")]
  889. {
  890. if let Some(rpc_server) = rpc_server {
  891. rpc_server.stop().await?;
  892. }
  893. }
  894. Ok(())
  895. }
  896. async fn shutdown_signal() {
  897. tokio::signal::ctrl_c()
  898. .await
  899. .expect("failed to install CTRL+C handler");
  900. tracing::info!("Shutdown signal received");
  901. }
  902. fn work_dir() -> Result<PathBuf> {
  903. let home_dir = home::home_dir().ok_or(anyhow!("Unknown home dir"))?;
  904. let dir = home_dir.join(".cdk-mintd");
  905. std::fs::create_dir_all(&dir)?;
  906. Ok(dir)
  907. }
  908. /// The main entry point for the application when used as a library
  909. pub async fn run_mintd(
  910. work_dir: &Path,
  911. settings: &config::Settings,
  912. db_password: Option<String>,
  913. enable_logging: bool,
  914. runtime: Option<std::sync::Arc<tokio::runtime::Runtime>>,
  915. ) -> Result<()> {
  916. let _guard = if enable_logging {
  917. setup_tracing(work_dir, &settings.info.logging)?
  918. } else {
  919. None
  920. };
  921. let result =
  922. run_mintd_with_shutdown(work_dir, settings, shutdown_signal(), db_password, runtime).await;
  923. // Explicitly drop the guard to ensure proper cleanup
  924. if let Some(guard) = _guard {
  925. tracing::info!("Shutting down logging worker thread");
  926. drop(guard);
  927. // Give the worker thread a moment to flush any remaining logs
  928. tokio::time::sleep(tokio::time::Duration::from_millis(100)).await;
  929. }
  930. tracing::info!("Mintd shutdown");
  931. result
  932. }
  933. /// Run mintd with a custom shutdown signal
  934. pub async fn run_mintd_with_shutdown(
  935. work_dir: &Path,
  936. settings: &config::Settings,
  937. shutdown_signal: impl std::future::Future<Output = ()> + Send + 'static,
  938. db_password: Option<String>,
  939. runtime: Option<std::sync::Arc<tokio::runtime::Runtime>>,
  940. ) -> Result<()> {
  941. let (localstore, keystore, kv) = initial_setup(work_dir, settings, db_password.clone()).await?;
  942. let mint_builder = MintBuilder::new(localstore);
  943. let (mint_builder, ln_routers) =
  944. configure_mint_builder(settings, mint_builder, runtime, work_dir, Some(kv)).await?;
  945. #[cfg(feature = "auth")]
  946. let mint_builder = setup_authentication(settings, work_dir, mint_builder, db_password).await?;
  947. let mint = build_mint(settings, keystore, mint_builder).await?;
  948. tracing::debug!("Mint built from builder.");
  949. let mint = Arc::new(mint);
  950. // Checks the status of all pending melt quotes
  951. // Pending melt quotes where the payment has gone through inputs are burnt
  952. // Pending melt quotes where the payment has **failed** inputs are reset to unspent
  953. mint.check_pending_melt_quotes().await?;
  954. let result = start_services_with_shutdown(
  955. mint.clone(),
  956. settings,
  957. ln_routers,
  958. work_dir,
  959. mint.mint_info().await?,
  960. shutdown_signal,
  961. )
  962. .await;
  963. // Ensure any remaining tracing data is flushed
  964. // This is particularly important for file-based logging
  965. tracing::debug!("Flushing remaining trace data");
  966. result
  967. }