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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132

use js_export_macro::js_export;
use miden_client::{Felt as NativeFelt, Word as NativeWord};

use super::felt::Felt;
use crate::platform::{JsBytes, JsErr, from_str_err, js_u64_to_u64, u64_to_js_u64};
use crate::utils::{deserialize_from_bytes, serialize_to_bytes};

#[derive(Clone)]
#[js_export]
pub struct Word(NativeWord);

#[js_export]
impl Word {
    /// Creates a word from four numeric values.
    ///
    /// Each input must be a canonical field element, i.e. strictly less than the field modulus.
    /// `Felt::new` (now fallible on the 0.15 surface) errors out on inputs at or beyond the
    /// modulus; the error is surfaced to JS.
    #[js_export(constructor)]
    pub fn new(u64_vec: Vec<JsU64>) -> Result<Word, JsErr> {
        if u64_vec.len() != 4 {
            return Err(from_str_err(&format!(
                "Word requires exactly 4 elements, got {}",
                u64_vec.len()
            )));
        }
        let fixed_array_u64: [u64; 4] = u64_vec
            .into_iter()
            .map(js_u64_to_u64)
            .collect::<Vec<u64>>()
            .try_into()
            .expect("length checked above");
        let native_felt_vec: [NativeFelt; 4] = fixed_array_u64
            .iter()
            .map(|&v| NativeFelt::new(v))
            .collect::<Result<Vec<NativeFelt>, _>>()
            .map_err(|err| from_str_err(&format!("invalid field element: {err}")))?
            .try_into()
            .expect("length checked above");
        Ok(Word(native_felt_vec.into()))
    }

    /// Returns the word as an array of numeric values.
    #[js_export(js_name = "toU64s")]
    pub fn to_u64s(&self) -> Vec<JsU64> {
        self.0.iter().map(|f| u64_to_js_u64(NativeFelt::as_canonical_u64(f))).collect()
    }

    /// Creates a Word from a hex string.
    #[js_export(js_name = "fromHex")]
    pub fn from_hex(hex: String) -> Result<Word, JsErr> {
        let native_word = NativeWord::try_from(hex.as_str())
            .map_err(|err| from_str_err(&format!("Error instantiating Word from hex: {err}")))?;
        Ok(Word(native_word))
    }

    /// Creates a word from four field elements.
    #[js_export(js_name = "newFromFelts")]
    #[allow(clippy::needless_pass_by_value)]
    pub fn new_from_felts(felt_vec: Vec<Felt>) -> Word {
        assert!(
            felt_vec.len() == 4,
            "Word requires exactly 4 field elements, got {}",
            felt_vec.len()
        );
        let native_felt_vec: [NativeFelt; 4] = felt_vec
            .iter()
            .map(|felt: &Felt| felt.into())
            .collect::<Vec<NativeFelt>>()
            .try_into()
            .expect("Word requires exactly 4 field elements");
        Word(native_felt_vec.into())
    }

    /// Returns the hex representation of the word.
    #[js_export(js_name = "toHex")]
    pub fn to_hex(&self) -> String {
        self.0.to_hex()
    }

    /// Serializes the word into bytes.
    pub fn serialize(&self) -> JsBytes {
        serialize_to_bytes(&self.0)
    }

    /// Deserializes a word from bytes.
    pub fn deserialize(bytes: JsBytes) -> Result<Word, JsErr> {
        let native_word = deserialize_from_bytes::<NativeWord>(&bytes)?;
        Ok(Word(native_word))
    }

    /// Returns the word as an array of field elements.
    #[js_export(js_name = "toFelts")]
    pub fn to_felts(&self) -> Vec<Felt> {
        self.0.iter().map(|felt| Felt::from(*felt)).collect::<Vec<Felt>>()
    }
}

impl Word {
    pub(crate) fn as_native(&self) -> &NativeWord {
        &self.0
    }
}

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

impl From<NativeWord> for Word {
    fn from(native_word: NativeWord) -> Self {
        Word(native_word)
    }
}

impl From<&NativeWord> for Word {
    fn from(native_word: &NativeWord) -> Self {
        Word(*native_word)
    }
}

impl From<Word> for NativeWord {
    fn from(word: Word) -> Self {
        word.0
    }
}

impl From<&Word> for NativeWord {
    fn from(word: &Word) -> Self {
        word.0
    }
}

impl_napi_from_value!(Word);