Files
cdk/crates/cdk-mintd/src/config.rs
C ade48cd8a9 Introduce a SignatoryManager service. (#509)
* WIP: Introduce a SignatoryManager service.

The SignatoryManager manager provides an API to interact with keysets, private
keys, and all key-related operations, offering segregation between the mint and
the most sensible part of the mind: the private keys.

Although the default signatory runs in memory, it is completely isolated from
the rest of the system and can only be communicated through the interface
offered by the signatory manager. Only messages can be sent from the mintd to
the Signatory trait through the Signatory Manager.

This pull request sets the foundation for eventually being able to run the
Signatory and all the key-related operations in a separate service, possibly in
a foreign service, to offload risks, as described in #476.

The Signatory manager is concurrent and deferred any mechanism needed to handle
concurrency to the Signatory trait.

* Fixed missing default feature for signatory

* Do not read keys from the DB

* Removed KeysDatabase Trait from MintDatabase

All Keys operations should be done through the signatory

* Make sure signatory has all the keys in memory

Drop also foreign constraints on sqlite

* Fix race condition

* Adding debug info to failing test

* Add `sleep` in test

* Fixed issue with active auth keyset

* Fixed dependency

* Move all keys and keysets to an ArcSwap.

Since the keys and keysets exist in RAM, most wrapping functions are infallible
and synchronous, improving performance and adding breaking API changes.

The signatory will provide this information on the boot and update when the
`rotate_keyset` is executed.

Todo: Implement a subscription key to reload the keys when the GRPC server
changes the keys. For the embedded mode, that makes no sense since there is a
single way to rotate keys, and that bit is already covered.

* Implementing https://github.com/cashubtc/nuts/pull/250

* Add CLI for cdk-signatory to spawn an external signatory

Add to the pipeline the external signatory

* Update tests

* Apply suggestions from code review

Co-authored-by: ok300 <106775972+ok300@users.noreply.github.com>
Co-authored-by: thesimplekid <tsk@thesimplekid.com>

* Minor change

* Update proto buf to use the newest format

* Rename binary

* Add instrumentations

* Add more comments

* Use a single database for the signatory

Store all keys, even auth keys, in a single database. Leave the MintAuthDatabse
trait implementation for the CDK but not the signagtory

This commit also moves the cli mod to its own file

* Update dep

* Add `test_mint_keyset_gen` test

---------

Co-authored-by: ok300 <106775972+ok300@users.noreply.github.com>
Co-authored-by: thesimplekid <tsk@thesimplekid.com>
2025-05-28 11:43:30 -04:00

444 lines
13 KiB
Rust

use std::path::PathBuf;
use bitcoin::hashes::{sha256, Hash};
use cdk::nuts::{CurrencyUnit, PublicKey};
use cdk::Amount;
use cdk_axum::cache;
use config::{Config, ConfigError, File};
use serde::{Deserialize, Serialize};
#[derive(Clone, Serialize, Deserialize, Default)]
pub struct Info {
pub url: String,
pub listen_host: String,
pub listen_port: u16,
pub mnemonic: Option<String>,
pub signatory_url: Option<String>,
pub signatory_certs: Option<String>,
pub input_fee_ppk: Option<u64>,
pub http_cache: cache::Config,
/// When this is set to true, the mint exposes a Swagger UI for it's API at
/// `[listen_host]:[listen_port]/swagger-ui`
///
/// This requires `mintd` was built with the `swagger` feature flag.
pub enable_swagger_ui: Option<bool>,
}
impl std::fmt::Debug for Info {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
// Use a fallback approach that won't panic
let mnemonic_display = {
if let Some(mnemonic) = self.mnemonic.as_ref() {
let hash = sha256::Hash::hash(mnemonic.as_bytes());
format!("<hashed: {hash}>")
} else {
format!("<url: {}>", self.signatory_url.clone().unwrap_or_default())
}
};
f.debug_struct("Info")
.field("url", &self.url)
.field("listen_host", &self.listen_host)
.field("listen_port", &self.listen_port)
.field("mnemonic", &mnemonic_display)
.field("input_fee_ppk", &self.input_fee_ppk)
.field("http_cache", &self.http_cache)
.field("enable_swagger_ui", &self.enable_swagger_ui)
.finish()
}
}
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)]
#[serde(rename_all = "lowercase")]
pub enum LnBackend {
#[default]
None,
#[cfg(feature = "cln")]
Cln,
#[cfg(feature = "lnbits")]
LNbits,
#[cfg(feature = "fakewallet")]
FakeWallet,
#[cfg(feature = "lnd")]
Lnd,
#[cfg(feature = "grpc-processor")]
GrpcProcessor,
}
impl std::str::FromStr for LnBackend {
type Err = String;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s.to_lowercase().as_str() {
#[cfg(feature = "cln")]
"cln" => Ok(LnBackend::Cln),
#[cfg(feature = "lnbits")]
"lnbits" => Ok(LnBackend::LNbits),
#[cfg(feature = "fakewallet")]
"fakewallet" => Ok(LnBackend::FakeWallet),
#[cfg(feature = "lnd")]
"lnd" => Ok(LnBackend::Lnd),
#[cfg(feature = "grpc-processor")]
"grpcprocessor" => Ok(LnBackend::GrpcProcessor),
_ => Err(format!("Unknown Lightning backend: {s}")),
}
}
}
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct Ln {
pub ln_backend: LnBackend,
pub invoice_description: Option<String>,
pub min_mint: Amount,
pub max_mint: Amount,
pub min_melt: Amount,
pub max_melt: Amount,
}
impl Default for Ln {
fn default() -> Self {
Ln {
ln_backend: LnBackend::default(),
invoice_description: None,
min_mint: 1.into(),
max_mint: 500_000.into(),
min_melt: 1.into(),
max_melt: 500_000.into(),
}
}
}
#[cfg(feature = "lnbits")]
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct LNbits {
pub admin_api_key: String,
pub invoice_api_key: String,
pub lnbits_api: String,
pub fee_percent: f32,
pub reserve_fee_min: Amount,
}
#[cfg(feature = "cln")]
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Cln {
pub rpc_path: PathBuf,
#[serde(default)]
pub bolt12: bool,
pub fee_percent: f32,
pub reserve_fee_min: Amount,
}
#[cfg(feature = "lnd")]
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Lnd {
pub address: String,
pub cert_file: PathBuf,
pub macaroon_file: PathBuf,
pub fee_percent: f32,
pub reserve_fee_min: Amount,
}
#[cfg(feature = "fakewallet")]
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct FakeWallet {
pub supported_units: Vec<CurrencyUnit>,
pub fee_percent: f32,
pub reserve_fee_min: Amount,
#[serde(default = "default_min_delay_time")]
pub min_delay_time: u64,
#[serde(default = "default_max_delay_time")]
pub max_delay_time: u64,
}
#[cfg(feature = "fakewallet")]
impl Default for FakeWallet {
fn default() -> Self {
Self {
supported_units: vec![CurrencyUnit::Sat],
fee_percent: 0.02,
reserve_fee_min: 2.into(),
min_delay_time: 1,
max_delay_time: 3,
}
}
}
// Helper functions to provide default values
#[cfg(feature = "fakewallet")]
fn default_min_delay_time() -> u64 {
1
}
#[cfg(feature = "fakewallet")]
fn default_max_delay_time() -> u64 {
3
}
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)]
pub struct GrpcProcessor {
pub supported_units: Vec<CurrencyUnit>,
pub addr: String,
pub port: u16,
pub tls_dir: Option<PathBuf>,
}
#[derive(Debug, Serialize, Deserialize, Clone, PartialEq, Default)]
#[serde(rename_all = "lowercase")]
pub enum DatabaseEngine {
#[default]
Sqlite,
#[cfg(feature = "redb")]
Redb,
}
impl std::str::FromStr for DatabaseEngine {
type Err = String;
fn from_str(s: &str) -> Result<Self, Self::Err> {
match s.to_lowercase().as_str() {
"sqlite" => Ok(DatabaseEngine::Sqlite),
#[cfg(feature = "redb")]
"redb" => Ok(DatabaseEngine::Redb),
_ => Err(format!("Unknown database engine: {s}")),
}
}
}
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Database {
pub engine: DatabaseEngine,
}
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
pub struct Auth {
pub openid_discovery: String,
pub openid_client_id: String,
pub mint_max_bat: u64,
#[serde(default = "default_true")]
pub enabled_mint: bool,
#[serde(default = "default_true")]
pub enabled_melt: bool,
#[serde(default = "default_true")]
pub enabled_swap: bool,
#[serde(default = "default_true")]
pub enabled_check_mint_quote: bool,
#[serde(default = "default_true")]
pub enabled_check_melt_quote: bool,
#[serde(default = "default_true")]
pub enabled_restore: bool,
#[serde(default = "default_true")]
pub enabled_check_proof_state: bool,
}
fn default_true() -> bool {
true
}
/// CDK settings, derived from `config.toml`
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct Settings {
pub info: Info,
pub mint_info: MintInfo,
pub ln: Ln,
#[cfg(feature = "cln")]
pub cln: Option<Cln>,
#[cfg(feature = "lnbits")]
pub lnbits: Option<LNbits>,
#[cfg(feature = "lnd")]
pub lnd: Option<Lnd>,
#[cfg(feature = "fakewallet")]
pub fake_wallet: Option<FakeWallet>,
pub grpc_processor: Option<GrpcProcessor>,
pub database: Database,
#[cfg(feature = "management-rpc")]
pub mint_management_rpc: Option<MintManagementRpc>,
pub auth: Option<Auth>,
}
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct MintInfo {
/// name of the mint and should be recognizable
pub name: String,
/// hex pubkey of the mint
pub pubkey: Option<PublicKey>,
/// short description of the mint
pub description: String,
/// long description
pub description_long: Option<String>,
/// url to the mint icon
pub icon_url: Option<String>,
/// message of the day that the wallet must display to the user
pub motd: Option<String>,
/// Nostr publickey
pub contact_nostr_public_key: Option<String>,
/// Contact email
pub contact_email: Option<String>,
/// URL to the terms of service
pub tos_url: Option<String>,
}
#[cfg(feature = "management-rpc")]
#[derive(Debug, Clone, Serialize, Deserialize, Default)]
pub struct MintManagementRpc {
/// When this is set to `true` the mint use the config file for the initial set up on first start.
/// Changes to the `[mint_info]` after this **MUST** be made via the RPC changes to the config file or env vars will be ignored.
pub enabled: bool,
pub address: Option<String>,
pub port: Option<u16>,
pub tls_dir_path: Option<PathBuf>,
}
impl Settings {
#[must_use]
pub fn new<P>(config_file_name: Option<P>) -> Self
where
P: Into<PathBuf>,
{
let default_settings = Self::default();
// attempt to construct settings with file
let from_file = Self::new_from_default(&default_settings, config_file_name);
match from_file {
Ok(f) => f,
Err(e) => {
tracing::error!(
"Error reading config file, falling back to defaults. Error: {e:?}"
);
default_settings
}
}
}
fn new_from_default<P>(
default: &Settings,
config_file_name: Option<P>,
) -> Result<Self, ConfigError>
where
P: Into<PathBuf>,
{
let mut default_config_file_name = home::home_dir()
.ok_or(ConfigError::NotFound("Config Path".to_string()))?
.join("cashu-rs-mint");
default_config_file_name.push("config.toml");
let config: String = match config_file_name {
Some(value) => value.into().to_string_lossy().to_string(),
None => default_config_file_name.to_string_lossy().to_string(),
};
let builder = Config::builder();
let config: Config = builder
// use defaults
.add_source(Config::try_from(default)?)
// override with file contents
.add_source(File::with_name(&config))
.build()?;
let settings: Settings = config.try_deserialize()?;
match settings.ln.ln_backend {
LnBackend::None => panic!("Ln backend must be set"),
#[cfg(feature = "cln")]
LnBackend::Cln => assert!(
settings.cln.is_some(),
"CLN backend requires a valid config."
),
#[cfg(feature = "lnbits")]
LnBackend::LNbits => assert!(
settings.lnbits.is_some(),
"LNbits backend requires a valid config"
),
#[cfg(feature = "lnd")]
LnBackend::Lnd => {
assert!(
settings.lnd.is_some(),
"LND backend requires a valid config."
)
}
#[cfg(feature = "fakewallet")]
LnBackend::FakeWallet => assert!(
settings.fake_wallet.is_some(),
"FakeWallet backend requires a valid config."
),
#[cfg(feature = "grpc-processor")]
LnBackend::GrpcProcessor => {
assert!(
settings.grpc_processor.is_some(),
"GRPC backend requires a valid config."
)
}
}
Ok(settings)
}
}
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn test_info_debug_impl() {
// Create a sample Info struct with test data
let info = Info {
url: "http://example.com".to_string(),
listen_host: "127.0.0.1".to_string(),
listen_port: 8080,
mnemonic: Some("test secret mnemonic phrase".to_string()),
input_fee_ppk: Some(100),
..Default::default()
};
// Convert the Info struct to a debug string
let debug_output = format!("{info:?}");
// Verify the debug output contains expected fields
assert!(debug_output.contains("url: \"http://example.com\""));
assert!(debug_output.contains("listen_host: \"127.0.0.1\""));
assert!(debug_output.contains("listen_port: 8080"));
// The mnemonic should be hashed, not displayed in plaintext
assert!(!debug_output.contains("test secret mnemonic phrase"));
assert!(debug_output.contains("<hashed: "));
assert!(debug_output.contains("input_fee_ppk: Some(100)"));
}
#[test]
fn test_info_debug_with_empty_mnemonic() {
// Test with an empty mnemonic to ensure it doesn't panic
let info = Info {
url: "http://example.com".to_string(),
listen_host: "127.0.0.1".to_string(),
listen_port: 8080,
mnemonic: Some("".to_string()), // Empty mnemonic
enable_swagger_ui: Some(false),
..Default::default()
};
// This should not panic
let debug_output = format!("{:?}", info);
// The empty mnemonic should still be hashed
assert!(debug_output.contains("<hashed: "));
}
#[test]
fn test_info_debug_with_special_chars() {
// Test with a mnemonic containing special characters
let info = Info {
url: "http://example.com".to_string(),
listen_host: "127.0.0.1".to_string(),
listen_port: 8080,
mnemonic: Some("特殊字符 !@#$%^&*()".to_string()), // Special characters
..Default::default()
};
// This should not panic
let debug_output = format!("{:?}", info);
// The mnemonic with special chars should be hashed
assert!(!debug_output.contains("特殊字符 !@#$%^&*()"));
assert!(debug_output.contains("<hashed: "));
}
}