cdk 0.16.0

Core Cashu Development Kit library implementing the Cashu protocol
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93

//! State types for the Melt saga.
//!
//! Each state is a distinct type that holds the data relevant to that stage
//! of the melt operation. The type state pattern ensures that only valid
//! operations are available at each stage.
//!
//! # Type State Flow
//!
//! ```text
//! Initial
//!   └─> prepare() -> Prepared
//!                      └─> request_melt_with_options() -> MeltRequested
//!                                              └─> execute() -> Finalized
//!                                                                 └─> amount(), fee(), change(), etc.
//! ```
//!
//! Note: `PaymentPending` is a persistence state in `WalletSaga`, not a typestate.
//! When payment is pending, the saga returns an error and recovery handles it later.

use cdk_common::wallet::WalletSaga;
use cdk_common::MeltQuoteState;
use uuid::Uuid;

use crate::nuts::{PreMintSecrets, Proofs};
use crate::wallet::MeltQuote;
use crate::Amount;

/// Initial state - operation ID assigned but no work done yet.
#[derive(Debug)]
pub struct Initial {
    /// Unique operation identifier for tracking and crash recovery
    pub operation_id: Uuid,
}

/// Prepared state - proofs have been selected and reserved.
pub struct Prepared {
    /// Unique operation identifier
    pub operation_id: Uuid,
    /// The melt quote
    pub quote: MeltQuote,
    /// Proofs that will be used for the melt
    pub proofs: Proofs,
    /// Proofs that need to be swapped first (if any)
    pub proofs_to_swap: Proofs,
    /// Fee for the swap operation
    pub swap_fee: Amount,
    /// Input fee for the melt (after swap, on optimized proofs)
    pub input_fee: Amount,
    /// Input fee if swap is skipped (on all proofs directly)
    pub input_fee_without_swap: Amount,
    /// The persisted saga for optimistic locking
    pub saga: WalletSaga,
}

/// MeltRequested state - melt request has been built and is ready to send.
pub struct MeltRequested {
    /// Unique operation identifier
    pub operation_id: Uuid,
    /// The melt quote
    pub quote: MeltQuote,
    /// Final proofs used for the melt (after any swaps)
    pub final_proofs: Proofs,
    /// Pre-mint secrets for change
    pub premint_secrets: PreMintSecrets,
}

/// Finalized state - melt completed successfully.
pub struct Finalized {
    /// Quote ID
    pub quote_id: String,
    /// The state of the melt quote (Paid)
    pub state: MeltQuoteState,
    /// Amount that was melted
    pub amount: Amount,
    /// Fee paid for the melt
    pub fee: Amount,
    /// Payment proof (e.g., Lightning preimage)
    pub payment_proof: Option<String>,
    /// Change proofs returned from the melt
    pub change: Option<Proofs>,
}

/// PaymentPending state - melt is asynchronous and pending at the mint.
pub struct PaymentPending {
    /// Unique operation identifier
    pub operation_id: Uuid,
    /// The melt quote
    pub quote: MeltQuote,
    /// The proofs used for payment
    pub final_proofs: Proofs,
    /// Pre-mint secrets for change
    pub premint_secrets: PreMintSecrets,
}