miden-client-web 0.14.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
87
88

use miden_client::rpc::domain::note::{
    NoteSyncBlock as NativeNoteSyncBlock,
    NoteSyncInfo as NativeNoteSyncInfo,
};
use wasm_bindgen::prelude::*;

use super::block_header::BlockHeader;
use super::committed_note::CommittedNote;
use super::merkle_path::MerklePath;

/// Represents a single block's worth of note sync data.
#[wasm_bindgen]
pub struct NoteSyncBlock(NativeNoteSyncBlock);

#[wasm_bindgen]
impl NoteSyncBlock {
    /// Returns the block header for this block.
    #[wasm_bindgen(js_name = "blockHeader")]
    pub fn block_header(&self) -> BlockHeader {
        self.0.block_header.clone().into()
    }

    /// Returns the MMR path for the block header.
    #[wasm_bindgen(js_name = "mmrPath")]
    pub fn mmr_path(&self) -> MerklePath {
        self.0.mmr_path.clone().into()
    }

    /// Returns the committed notes in this block.
    pub fn notes(&self) -> Vec<CommittedNote> {
        self.0.notes.values().map(Into::into).collect()
    }
}

/// Represents the response data from `syncNotes`.
#[wasm_bindgen]
pub struct NoteSyncInfo(NativeNoteSyncInfo);

#[wasm_bindgen]
impl NoteSyncInfo {
    /// Returns the latest block number in the chain.
    #[wasm_bindgen(js_name = "chainTip")]
    pub fn chain_tip(&self) -> u32 {
        self.0.chain_tip.as_u32()
    }

    /// Returns the last block checked by the node. Used as a cursor for pagination.
    #[wasm_bindgen(js_name = "blockTo")]
    pub fn block_to(&self) -> u32 {
        self.0.block_to.as_u32()
    }

    /// Returns the first block header associated with matching notes, if any.
    #[wasm_bindgen(js_name = "blockHeader")]
    pub fn block_header(&self) -> Option<BlockHeader> {
        self.0.blocks.first().map(|block| block.block_header.clone().into())
    }

    /// Returns the first block MMR path associated with matching notes, if any.
    #[wasm_bindgen(js_name = "mmrPath")]
    pub fn mmr_path(&self) -> Option<MerklePath> {
        self.0.blocks.first().map(|block| block.mmr_path.clone().into())
    }

    /// Returns the committed notes across all matching blocks.
    pub fn notes(&self) -> Vec<CommittedNote> {
        self.0
            .blocks
            .iter()
            .flat_map(|block| block.notes.values().cloned())
            .map(Into::into)
            .collect()
    }

    /// Returns the blocks containing matching notes.
    pub fn blocks(&self) -> Vec<NoteSyncBlock> {
        self.0.blocks.iter().map(|b| NoteSyncBlock(b.clone())).collect()
    }
}

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

impl From<NativeNoteSyncInfo> for NoteSyncInfo {
    fn from(native_info: NativeNoteSyncInfo) -> Self {
        NoteSyncInfo(native_info)
    }
}