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

use js_export_macro::js_export;
use miden_client::account::AccountId as NativeAccountId;
use miden_client::note::NoteTag as NativeNoteTag;

use super::account_id::AccountId;
use crate::platform::{JsErr, from_str_err};

/// Note tags are 32-bits of data that serve as best-effort filters for notes.
///
/// Tags enable quick lookups for notes related to particular use cases, scripts, or account
/// prefixes.
#[derive(Clone, Copy)]
#[js_export]
pub struct NoteTag(pub(crate) NativeNoteTag);

#[js_export]
impl NoteTag {
    /// Creates a new `NoteTag` from an arbitrary u32.
    #[js_export(constructor)]
    pub fn new(tag: u32) -> NoteTag {
        NoteTag(NativeNoteTag::new(tag))
    }

    /// Constructs a note tag that targets the given account ID.
    #[js_export(js_name = "withAccountTarget")]
    pub fn with_account_target(account_id: &AccountId) -> NoteTag {
        let native_account_id: NativeAccountId = account_id.into();
        NoteTag(NativeNoteTag::with_account_target(native_account_id))
    }

    /// Constructs a note tag that targets the given account ID with a custom tag length.
    #[js_export(js_name = "withCustomAccountTarget")]
    pub fn with_custom_account_target(
        account_id: &AccountId,
        tag_len: u8,
    ) -> Result<NoteTag, JsErr> {
        let native_account_id: NativeAccountId = account_id.into();
        NativeNoteTag::with_custom_account_target(native_account_id, tag_len)
            .map(NoteTag)
            .map_err(|err| from_str_err(&err.to_string()))
    }

    /// Returns the inner u32 value of this tag.
    #[js_export(js_name = "asU32")]
    pub fn as_u32(&self) -> u32 {
        self.0.as_u32()
    }
}

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

impl From<NativeNoteTag> for NoteTag {
    fn from(native_note_tag: NativeNoteTag) -> Self {
        NoteTag(native_note_tag)
    }
}

impl From<&NativeNoteTag> for NoteTag {
    fn from(native_note_tag: &NativeNoteTag) -> Self {
        NoteTag(*native_note_tag)
    }
}

impl From<NoteTag> for NativeNoteTag {
    fn from(note_tag: NoteTag) -> Self {
        note_tag.0
    }
}

impl From<&NoteTag> for NativeNoteTag {
    fn from(note_tag: &NoteTag) -> Self {
        note_tag.0
    }
}

impl_napi_from_value!(NoteTag);