miden-client-web 0.15.0

Web Client library that facilitates interaction with the Miden network
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

use js_export_macro::js_export;
use miden_client::transaction::{DiscardCause, TransactionStatus as NativeTransactionStatus};

use crate::platform::{JsErr, from_str_err, js_u64_to_u64, u64_to_js_u64};

/// Status of a transaction in the node or store.
#[derive(Clone)]
#[js_export]
pub struct TransactionStatus(NativeTransactionStatus);

#[js_export]
impl TransactionStatus {
    /// Creates a pending transaction status.
    pub fn pending() -> TransactionStatus {
        TransactionStatus(NativeTransactionStatus::Pending)
    }

    /// Creates a committed status with block number and timestamp.
    pub fn committed(block_num: u32, commit_timestamp: JsU64) -> TransactionStatus {
        TransactionStatus(NativeTransactionStatus::Committed {
            block_number: block_num.into(),
            commit_timestamp: js_u64_to_u64(commit_timestamp),
        })
    }

    /// Creates a discarded status from a discard cause string.
    pub fn discarded(cause: String) -> Result<TransactionStatus, JsErr> {
        let native_cause = DiscardCause::from_string(&cause)
            .map_err(|err| from_str_err(&format!("Invalid discard cause: {err}")))?;

        Ok(TransactionStatus(NativeTransactionStatus::Discarded(native_cause)))
    }

    /// Returns true if the transaction is still pending.
    #[js_export(js_name = "isPending")]
    pub fn is_pending(&self) -> bool {
        matches!(self.0, NativeTransactionStatus::Pending)
    }

    /// Returns true if the transaction has been committed.
    #[js_export(js_name = "isCommitted")]
    pub fn is_committed(&self) -> bool {
        matches!(self.0, NativeTransactionStatus::Committed { .. })
    }

    /// Returns true if the transaction was discarded.
    #[js_export(js_name = "isDiscarded")]
    pub fn is_discarded(&self) -> bool {
        matches!(self.0, NativeTransactionStatus::Discarded(_))
    }

    /// Returns the block number if the transaction was committed.
    #[js_export(js_name = "getBlockNum")]
    pub fn get_block_num(&self) -> Option<u32> {
        match self.0 {
            NativeTransactionStatus::Committed { block_number, .. } => Some(block_number.as_u32()),
            _ => None,
        }
    }

    /// Returns the commit timestamp if the transaction was committed.
    #[js_export(js_name = "getCommitTimestamp")]
    pub fn get_commit_timestamp(&self) -> Option<JsU64> {
        match self.0 {
            NativeTransactionStatus::Committed { commit_timestamp, .. } => {
                Some(u64_to_js_u64(commit_timestamp))
            },
            _ => None,
        }
    }
}

// CONVERSIONS
// ================================================================================================

impl From<NativeTransactionStatus> for TransactionStatus {
    fn from(native_status: NativeTransactionStatus) -> Self {
        TransactionStatus(native_status)
    }
}

impl From<&NativeTransactionStatus> for TransactionStatus {
    fn from(native_status: &NativeTransactionStatus) -> Self {
        TransactionStatus(native_status.clone())
    }
}