fedimint_mint_client/
event.rs

1use std::time::Duration;
2
3use fedimint_core::Amount;
4use fedimint_core::core::{ModuleKind, OperationId};
5use fedimint_eventlog::{Event, EventKind, EventPersistence};
6use fedimint_mint_common::{KIND, Nonce};
7use serde::{Deserialize, Serialize};
8
9/// Event that is emitted when a note is created.
10#[derive(Clone, Copy, Serialize, Deserialize)]
11pub struct NoteCreated {
12    /// The nonce of the note
13    pub nonce: Nonce,
14}
15
16impl Event for NoteCreated {
17    const MODULE: Option<ModuleKind> = Some(KIND);
18
19    const KIND: EventKind = EventKind::from_static("note-created");
20    const PERSISTENCE: EventPersistence = EventPersistence::Persistent;
21}
22
23/// Event that is emitted when a note is spent.
24#[derive(Clone, Copy, Serialize, Deserialize)]
25pub struct NoteSpent {
26    /// The nonce of the note
27    pub nonce: Nonce,
28}
29
30impl Event for NoteSpent {
31    const MODULE: Option<ModuleKind> = Some(KIND);
32
33    const KIND: EventKind = EventKind::from_static("note-spent");
34    const PERSISTENCE: EventPersistence = EventPersistence::Persistent;
35}
36
37/// Event that is emitted when ecash is spent out of band
38#[derive(Serialize, Deserialize)]
39pub struct OOBNotesSpent {
40    /// The requested amount to spend out of band
41    pub requested_amount: Amount,
42
43    /// The actual amount of ecash spent
44    pub spent_amount: Amount,
45
46    /// The timeout before attempting to refund
47    pub timeout: Duration,
48
49    /// Boolean that indicates if the invite code was included in the note
50    /// serialization
51    pub include_invite: bool,
52}
53
54impl Event for OOBNotesSpent {
55    const MODULE: Option<ModuleKind> = Some(KIND);
56
57    const KIND: EventKind = EventKind::from_static("oob-notes-spent");
58    const PERSISTENCE: EventPersistence = EventPersistence::Persistent;
59}
60
61/// Event that is emitted when out of band ecash is reissued
62#[derive(Serialize, Deserialize)]
63pub struct OOBNotesReissued {
64    /// The amount of out of band ecash being reissued
65    pub amount: Amount,
66}
67
68impl Event for OOBNotesReissued {
69    const MODULE: Option<ModuleKind> = Some(KIND);
70    const KIND: EventKind = EventKind::from_static("oob-notes-reissued");
71    const PERSISTENCE: EventPersistence = EventPersistence::Persistent;
72}
73
74/// Event emitted when e-cash is sent out-of-band.
75/// This is a final event - once e-cash is sent, the operation is complete.
76#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
77pub struct SendPaymentEvent {
78    pub operation_id: OperationId,
79    pub amount: Amount,
80    pub oob_notes: String,
81}
82
83impl Event for SendPaymentEvent {
84    const MODULE: Option<ModuleKind> = Some(KIND);
85    const KIND: EventKind = EventKind::from_static("payment-send");
86    const PERSISTENCE: EventPersistence = EventPersistence::Persistent;
87}
88
89/// Event emitted when a receive (reissuance) operation is initiated.
90#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
91pub struct ReceivePaymentEvent {
92    pub operation_id: OperationId,
93    pub amount: Amount,
94}
95
96impl Event for ReceivePaymentEvent {
97    const MODULE: Option<ModuleKind> = Some(KIND);
98    const KIND: EventKind = EventKind::from_static("payment-receive");
99    const PERSISTENCE: EventPersistence = EventPersistence::Persistent;
100}
101
102/// Status of a receive (reissuance) operation.
103#[derive(Serialize, Deserialize, Debug, Clone, Eq, PartialEq)]
104pub enum ReceivePaymentStatus {
105    /// The reissuance was successful.
106    Success,
107    /// The reissuance was rejected.
108    Rejected,
109}
110
111/// Event emitted when a receive (reissuance) operation reaches a final state.
112#[derive(Serialize, Deserialize, Debug, Clone, PartialEq, Eq)]
113pub struct ReceivePaymentUpdateEvent {
114    pub operation_id: OperationId,
115    pub status: ReceivePaymentStatus,
116}
117
118impl Event for ReceivePaymentUpdateEvent {
119    const MODULE: Option<ModuleKind> = Some(KIND);
120    const KIND: EventKind = EventKind::from_static("payment-receive-update");
121    const PERSISTENCE: EventPersistence = EventPersistence::Persistent;
122}
fedimint_mint_client/event.rs

fedimint_mint_client/
event.rs
