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

use miden_client::transaction::RawOutputNotes as NativeRawOutputNotes;
use wasm_bindgen::prelude::*;

use super::output_note::OutputNote;
use super::word::Word;

/// Contains a list of output notes of a transaction. The list can be empty if the transaction does
/// not produce any notes.
#[derive(Clone)]
#[wasm_bindgen]
pub struct OutputNotes(pub(crate) NativeRawOutputNotes);

#[wasm_bindgen]
impl OutputNotes {
    /// Returns the commitment to all output notes.
    pub fn commitment(&self) -> Word {
        self.0.commitment().into()
    }

    /// Returns the number of notes emitted.
    #[wasm_bindgen(js_name = "numNotes")]
    pub fn num_notes(&self) -> u32 {
        u32::try_from(self.0.num_notes())
            .expect("only 1024 output notes is allowed per transaction")
    }

    /// Returns true if there are no output notes.
    #[wasm_bindgen(js_name = "isEmpty")]
    pub fn is_empty(&self) -> bool {
        self.0.is_empty()
    }

    /// Returns the output note at the specified index.
    #[wasm_bindgen(js_name = "getNote")]
    pub fn get_note(&self, index: u32) -> OutputNote {
        self.0.get_note(index as usize).into()
    }

    /// Returns all output notes as a vector.
    pub fn notes(&self) -> Vec<OutputNote> {
        self.0.iter().cloned().map(Into::into).collect()
    }
}

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

impl From<NativeRawOutputNotes> for OutputNotes {
    fn from(native_notes: NativeRawOutputNotes) -> Self {
        OutputNotes(native_notes)
    }
}

impl From<&NativeRawOutputNotes> for OutputNotes {
    fn from(native_notes: &NativeRawOutputNotes) -> Self {
        OutputNotes(native_notes.clone())
    }
}