miden-client-web 0.15.2

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
87
88
89
90
91
92
93
94
95
96
97
98

use js_export_macro::js_export;
use miden_client::pswap::{
    PswapLineageRecord as NativePswapLineageRecord,
    PswapLineageState as NativePswapLineageState,
};

use super::account_id::AccountId;
use super::note_id::NoteId;
use crate::platform::u64_to_js_u64;

/// Lifecycle state of a PSWAP order.
///
/// Discriminants match the on-disk encoding in the store.
#[js_export]
#[derive(Clone, Copy, Debug, PartialEq, Eq)]
#[repr(u8)]
pub enum PswapLineageState {
    /// Still fillable and reclaimable.
    Active = 0,
    /// Fully filled. Terminal.
    FullyFilled = 1,
    /// Reclaimed by the creator. Terminal.
    Reclaimed = 2,
}

/// Read-only view of one PSWAP order's chain state, exposed to JavaScript.
/// The mutable fields (remaining amounts, depth, tip, state) advance
/// round-by-round as fills are discovered during sync.
#[derive(Clone)]
#[js_export]
pub struct PswapLineageRecord(NativePswapLineageRecord);

#[js_export]
impl PswapLineageRecord {
    /// Stable identifier shared by every note in the chain, as a decimal string.
    #[js_export(js_name = "orderId")]
    pub fn order_id(&self) -> String {
        self.0.order_id().as_canonical_u64().to_string()
    }

    /// Account that created the order and receives every payback.
    #[js_export(js_name = "creatorAccountId")]
    pub fn creator_account_id(&self) -> AccountId {
        self.0.creator_account_id().into()
    }

    /// Offered amount still unfilled on the current tip. The offered faucet is
    /// chain-invariant and recovered from the original PSWAP note when needed.
    #[js_export(js_name = "remainingOffered")]
    pub fn remaining_offered(&self) -> JsU64 {
        u64_to_js_u64(self.0.remaining_offered.as_u64())
    }

    /// Requested amount still outstanding on the current tip. The requested
    /// faucet is recovered from the original PSWAP note when needed.
    #[js_export(js_name = "remainingRequested")]
    pub fn remaining_requested(&self) -> JsU64 {
        u64_to_js_u64(self.0.remaining_requested.as_u64())
    }

    /// Depth of the current tip: 0 for the original PSWAP, +1 per fill round.
    #[js_export(js_name = "currentDepth")]
    pub fn current_depth(&self) -> u32 {
        self.0.current_depth
    }

    /// Note id of the current tip in the chain.
    #[js_export(js_name = "currentTipNoteId")]
    pub fn current_tip_note_id(&self) -> NoteId {
        self.0.current_tip_note_id.into()
    }

    /// Lifecycle state of the order.
    pub fn state(&self) -> PswapLineageState {
        self.0.state.into()
    }
}

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

impl From<NativePswapLineageState> for PswapLineageState {
    fn from(value: NativePswapLineageState) -> Self {
        match value {
            NativePswapLineageState::Active => PswapLineageState::Active,
            NativePswapLineageState::FullyFilled => PswapLineageState::FullyFilled,
            NativePswapLineageState::Reclaimed => PswapLineageState::Reclaimed,
        }
    }
}

impl From<NativePswapLineageRecord> for PswapLineageRecord {
    fn from(record: NativePswapLineageRecord) -> Self {
        PswapLineageRecord(record)
    }
}

impl_napi_from_value!(PswapLineageRecord);