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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
//! State machine for submitting transactions

use std::time::Duration;

use fedimint_core::api::GlobalFederationApi;
use fedimint_core::core::{Decoder, IntoDynInstance, ModuleInstanceId, OperationId};
use fedimint_core::encoding::{Decodable, Encodable};
use fedimint_core::task::sleep;
use fedimint_core::transaction::Transaction;
use fedimint_core::TransactionId;

use crate::sm::{Context, DynContext, OperationState, State, StateTransition};
use crate::{DynGlobalClientContext, DynState};

// TODO: how to prevent collisions? Generally reserve some range for custom IDs?
/// Reserved module instance id used for client-internal state machines
pub const TRANSACTION_SUBMISSION_MODULE_INSTANCE: ModuleInstanceId = 0xffff;

pub const LOG_TARGET: &str = "transaction_submission";

const RETRY_INTERVAL: Duration = Duration::from_secs(5);

#[derive(Debug, Clone)]
pub struct TxSubmissionContext;

impl Context for TxSubmissionContext {}

impl IntoDynInstance for TxSubmissionContext {
    type DynType = DynContext;

    fn into_dyn(self, instance_id: ModuleInstanceId) -> Self::DynType {
        DynContext::from_typed(instance_id, self)
    }
}

#[cfg_attr(doc, aquamarine::aquamarine)]
/// State machine to (re-)submit a transaction until it is either accepted or
/// rejected by the federation
///
/// ```mermaid
/// flowchart LR
///     Created -- tx is accepted by consensus --> Accepted
///     Created -- tx is rejected on submission --> Rejected
/// ```
#[derive(Debug, Clone, Eq, PartialEq, Decodable, Encodable)]
pub enum TxSubmissionStates {
    /// The transaction has been created and potentially already been submitted,
    /// but no rejection or acceptance happened so far
    Created(Transaction),
    /// The transaction has been accepted in consensus
    ///
    /// **This state is final**
    Accepted(TransactionId),
    /// The transaction has been rejected by a quorum on submission
    ///
    /// **This state is final**
    Rejected(TransactionId, String),
    /// this should never happen with a honest federation and bug-free code
    NonRetryableError(String),
}

impl State for TxSubmissionStates {
    type ModuleContext = TxSubmissionContext;
    type GlobalContext = DynGlobalClientContext;

    fn transitions(
        &self,
        _context: &Self::ModuleContext,
        global_context: &DynGlobalClientContext,
    ) -> Vec<StateTransition<Self>> {
        match self {
            TxSubmissionStates::Created(transaction) => {
                let txid = transaction.tx_hash();
                vec![
                    StateTransition::new(
                        trigger_created_rejected(transaction.clone(), global_context.clone()),
                        move |_dbtx, result, _state| {
                            Box::pin(async move {
                                match result {
                                    Ok(submit_error) => {
                                        TxSubmissionStates::Rejected(txid, submit_error)
                                    }
                                    Err(e) => TxSubmissionStates::NonRetryableError(e),
                                }
                            })
                        },
                    ),
                    StateTransition::new(
                        trigger_created_accepted(txid, global_context.clone()),
                        move |_dbtx, result, _state| {
                            Box::pin(async move {
                                match result {
                                    Ok(()) => TxSubmissionStates::Accepted(txid),
                                    Err(e) => TxSubmissionStates::NonRetryableError(e),
                                }
                            })
                        },
                    ),
                ]
            }
            TxSubmissionStates::Accepted(..) => {
                vec![]
            }
            TxSubmissionStates::Rejected(..) => {
                vec![]
            }
            TxSubmissionStates::NonRetryableError(..) => {
                vec![]
            }
        }
    }

    fn operation_id(&self) -> OperationId {
        unimplemented!("TxSubmissionStates has to be wrapped in OperationState")
    }
}

impl IntoDynInstance for TxSubmissionStates {
    type DynType = DynState<DynGlobalClientContext>;

    fn into_dyn(self, instance_id: ModuleInstanceId) -> Self::DynType {
        DynState::from_typed(instance_id, self)
    }
}

async fn trigger_created_rejected(
    tx: Transaction,
    context: DynGlobalClientContext,
) -> Result<String, String> {
    loop {
        match context.api().submit_transaction(tx.clone()).await {
            Ok(submission_result) => {
                if let Err(submission_error) = submission_result
                    .try_into_inner(context.decoders())
                    .map_err(|error| error.to_string())?
                {
                    return Ok(submission_error.to_string());
                }
            }
            Err(error) => {
                error.report_if_important();
            }
        }

        sleep(RETRY_INTERVAL).await;
    }
}

async fn trigger_created_accepted(
    txid: TransactionId,
    context: DynGlobalClientContext,
) -> Result<(), String> {
    loop {
        match context.api().await_transaction(txid).await {
            Ok(..) => return Ok(()),
            Err(error) => error.report_if_important(),
        }

        sleep(RETRY_INTERVAL).await;
    }
}

pub fn tx_submission_sm_decoder() -> Decoder {
    let mut decoder_builder = Decoder::builder();
    decoder_builder.with_decodable_type::<OperationState<TxSubmissionStates>>();
    decoder_builder.build()
}