cdk-common 0.16.0-rc.1

//! CDK Database

mod kvstore;

#[cfg(feature = "mint")]
pub mod mint;
#[cfg(feature = "wallet")]
pub mod wallet;

// Re-export shared KVStore types at the top level for both mint and wallet
pub use kvstore::{
    validate_kvstore_params, validate_kvstore_string, KVStore, KVStoreDatabase, KVStoreTransaction,
    KVSTORE_NAMESPACE_KEY_ALPHABET, KVSTORE_NAMESPACE_KEY_MAX_LEN,
};

/// Arc-wrapped KV store for shared ownership
pub type DynKVStore = std::sync::Arc<dyn KVStore<Err = Error> + Send + Sync>;

#[cfg(feature = "mint")]
pub use mint::{
    Database as MintDatabase, DynMintDatabase, DynMintTransaction,
    KeysDatabase as MintKeysDatabase, KeysDatabaseTransaction as MintKeyDatabaseTransaction,
    ProofsDatabase as MintProofsDatabase, ProofsTransaction as MintProofsTransaction,
    QuotesDatabase as MintQuotesDatabase, QuotesTransaction as MintQuotesTransaction,
    SignaturesDatabase as MintSignaturesDatabase,
    SignaturesTransaction as MintSignatureTransaction, Transaction as MintTransaction,
};
#[cfg(feature = "mint")]
pub use mint::{DynMintAuthDatabase, MintAuthDatabase, MintAuthTransaction};
#[cfg(feature = "wallet")]
pub use wallet::Database as WalletDatabase;

/// Data conversion error
#[derive(thiserror::Error, Debug)]
pub enum ConversionError {
    /// Missing columns
    #[error("Not enough elements: expected {0}, got {1}")]
    MissingColumn(usize, usize),

    /// Missing parameter
    #[error("Missing parameter {0}")]
    MissingParameter(String),

    /// Invalid db type
    #[error("Invalid type from db, expected {0} got {1}")]
    InvalidType(String, String),

    /// Invalid data conversion in column
    #[error("Error converting {1}, expecting type {0}")]
    InvalidConversion(String, String),

    /// Mint Url Error
    #[error(transparent)]
    MintUrl(#[from] crate::mint_url::Error),

    /// NUT00 Error
    #[error(transparent)]
    CDKNUT00(#[from] crate::nuts::nut00::Error),

    /// NUT01 Error
    #[error(transparent)]
    CDKNUT01(#[from] crate::nuts::nut01::Error),

    /// NUT02 Error
    #[error(transparent)]
    CDKNUT02(#[from] crate::nuts::nut02::Error),

    /// NUT04 Error
    #[error(transparent)]
    CDKNUT04(#[from] crate::nuts::nut04::Error),

    /// NUT05 Error
    #[error(transparent)]
    CDKNUT05(#[from] crate::nuts::nut05::Error),

    /// NUT07 Error
    #[error(transparent)]
    CDKNUT07(#[from] crate::nuts::nut07::Error),

    /// NUT23 Error
    #[error(transparent)]
    CDKNUT23(#[from] crate::nuts::nut23::Error),

    /// Secret Error
    #[error(transparent)]
    CDKSECRET(#[from] crate::secret::Error),

    /// Serde Error
    #[error(transparent)]
    Serde(#[from] serde_json::Error),

    /// BIP32 Error
    #[error(transparent)]
    BIP32(#[from] bitcoin::bip32::Error),

    /// Generic error
    #[error(transparent)]
    Generic(#[from] Box<crate::Error>),
}

impl From<crate::Error> for ConversionError {
    fn from(err: crate::Error) -> Self {
        ConversionError::Generic(Box::new(err))
    }
}

/// CDK_database error
#[derive(Debug, thiserror::Error)]
pub enum Error {
    /// Database Error
    #[error(transparent)]
    Database(Box<dyn std::error::Error + Send + Sync>),

    /// Duplicate entry
    #[error("Duplicate entry")]
    Duplicate,

    /// Locked resource
    #[error("Locked resource")]
    Locked,

    /// Amount overflow
    #[error("Amount overflow")]
    AmountOverflow,
    /// Amount zero
    #[error("Amount zero")]
    AmountZero,

    /// DHKE error
    #[error(transparent)]
    DHKE(#[from] crate::dhke::Error),
    /// NUT00 Error
    #[error(transparent)]
    NUT00(#[from] crate::nuts::nut00::Error),
    /// NUT01 Error
    #[error(transparent)]
    NUT01(#[from] crate::nuts::nut01::Error),
    /// NUT02 Error
    #[error(transparent)]
    NUT02(#[from] crate::nuts::nut02::Error),
    /// NUT22 Error
    #[error(transparent)]
    NUT22(#[from] crate::nuts::nut22::Error),
    /// NUT04 Error
    #[error(transparent)]
    NUT04(#[from] crate::nuts::nut04::Error),
    /// Quote ID Error
    #[error(transparent)]
    #[cfg(feature = "mint")]
    QuoteId(#[from] crate::quote_id::QuoteIdError),
    /// Serde Error
    #[error(transparent)]
    Serde(#[from] serde_json::Error),
    /// Unknown Quote
    #[error("Unknown Quote")]
    UnknownQuote,
    /// Attempt to remove spent proof
    #[error("Attempt to remove spent proof")]
    AttemptRemoveSpentProof,
    /// Attempt to update state of spent proof
    #[error("Attempt to update state of spent proof")]
    AttemptUpdateSpentProof,
    /// Proof not found
    #[error("Proof not found")]
    ProofNotFound,
    /// Proof not in unspent state (may be reserved, pending, or spent)
    #[error("Proof not in unspent state")]
    ProofNotUnspent,
    /// Quote is already in use by another operation
    #[error("Quote already in use by another operation")]
    QuoteAlreadyInUse,
    /// Invalid keyset
    #[error("Unknown or invalid keyset")]
    InvalidKeysetId,
    #[cfg(feature = "mint")]
    /// Invalid state transition
    #[error("Invalid state transition")]
    InvalidStateTransition(crate::state::Error),

    /// Invalid connection settings
    #[error("Invalid credentials {0}")]
    InvalidConnectionSettings(String),

    /// Unexpected database response
    #[error("Invalid database response")]
    InvalidDbResponse,

    /// Internal error
    #[error("Internal {0}")]
    Internal(String),

    /// Data conversion error
    #[error(transparent)]
    Conversion(#[from] ConversionError),

    /// Missing Placeholder value
    #[error("Missing placeholder value {0}")]
    MissingPlaceholder(String),

    /// Unknown quote ttl
    #[error("Unknown quote ttl")]
    UnknownQuoteTTL,

    /// Invalid UUID
    #[error("Invalid UUID: {0}")]
    InvalidUuid(String),

    /// QuoteNotFound
    #[error("Quote not found")]
    QuoteNotFound,

    /// KV Store invalid key or namespace
    #[error("Invalid KV store key or namespace: {0}")]
    KVStoreInvalidKey(String),

    /// Concurrent update detected
    #[error("Concurrent update detected")]
    ConcurrentUpdate,
}

#[cfg(feature = "mint")]
impl From<crate::state::Error> for Error {
    fn from(state: crate::state::Error) -> Self {
        match state {
            crate::state::Error::AlreadySpent => Error::AttemptUpdateSpentProof,
            _ => Error::InvalidStateTransition(state),
        }
    }
}

#[async_trait::async_trait]
/// Commit and Rollback
pub trait DbTransactionFinalizer {
    /// Mint Signature Database Error
    type Err: Into<Error> + From<Error>;

    /// Commits all the changes into the database
    async fn commit(self: Box<Self>) -> Result<(), Self::Err>;

    /// Rollbacks the write transaction
    async fn rollback(self: Box<Self>) -> Result<(), Self::Err>;
}