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

use js_export_macro::js_export;
use miden_client::note::NoteExecutionHint as NativeNoteExecutionHint;

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

/// Hint describing when a note can be consumed.
#[derive(Clone, Copy)]
#[js_export]
pub struct NoteExecutionHint(NativeNoteExecutionHint);

#[js_export]
impl NoteExecutionHint {
    /// Creates a hint that does not specify any execution constraint.
    pub fn none() -> NoteExecutionHint {
        NoteExecutionHint(NativeNoteExecutionHint::None)
    }

    /// Creates a hint indicating the note can always be consumed.
    pub fn always() -> NoteExecutionHint {
        NoteExecutionHint(NativeNoteExecutionHint::Always)
    }

    /// Creates a hint that activates after the given block number.
    #[js_export(js_name = "afterBlock")]
    pub fn after_block(block_num: u32) -> NoteExecutionHint {
        NoteExecutionHint(NativeNoteExecutionHint::after_block(block_num.into()))
    }

    /// Creates a hint that allows execution in a specific slot of a round.
    #[js_export(js_name = "onBlockSlot")]
    pub fn on_block_slot(epoch_len: u8, slot_len: u8, slot_offset: u8) -> NoteExecutionHint {
        NoteExecutionHint(NativeNoteExecutionHint::on_block_slot(epoch_len, slot_len, slot_offset))
    }

    /// Reconstructs a hint from its encoded tag and payload.
    #[js_export(js_name = "fromParts")]
    pub fn from_parts(tag: u8, payload: u32) -> Result<NoteExecutionHint, JsErr> {
        let hint = NativeNoteExecutionHint::from_parts(tag, payload)
            .map_err(|err| from_str_err(&format!("Invalid execution hint: {err}")))?;
        Ok(NoteExecutionHint(hint))
    }

    /// Returns whether the note can be consumed at the provided block height.
    #[js_export(js_name = "canBeConsumed")]
    pub fn can_be_consumed(&self, block_num: u32) -> Result<bool, JsErr> {
        self.0
            .can_be_consumed(block_num.into())
            .ok_or_else(|| from_str_err("Cannot determine consumability for this hint type"))
    }
}

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

impl From<NoteExecutionHint> for NativeNoteExecutionHint {
    fn from(note_execution_hint: NoteExecutionHint) -> Self {
        note_execution_hint.0
    }
}

impl From<&NoteExecutionHint> for NativeNoteExecutionHint {
    fn from(note_execution_hint: &NoteExecutionHint) -> Self {
        note_execution_hint.0
    }
}