Expose signatures in wasm (0xMiden#1107)

Author: evanmarshall

CHANGELOG.md

@@ -14,6 +14,7 @@
 * `NoteScript` now has a `toString` method that prints its own MAST source [(#1082)](https://github.com/0xMiden/miden-client/pull/1082).
 * Added a `NoteScript` getter for the Web Client `Note` model ([#1135](https://github.com/0xMiden/miden-client/pull/1135/)).
 * [BREAKING] Changed `OnNoteReceived` from closure to trait object ([#1080](https://github.com/0xMiden/miden-client/pull/1080)).
+* Exposed signatures and serialization for public keys and secret keys [(#1107)](https://github.com/0xMiden/miden-client/pull/1107)
 
 ### Features
 

crates/web-client/js/index.js

@@ -44,6 +44,7 @@ const {
   PublicKey,
   Rpo256,
   SecretKey,
+  Signature,
   SlotAndKeys,
   SlotAndKeysArray,
   StorageMap,
@@ -106,6 +107,7 @@ export {
   PublicKey,
   Rpo256,
   SecretKey,
+  Signature,
   SlotAndKeys,
   SlotAndKeysArray,
   StorageMap,

crates/web-client/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@demox-labs/miden-sdk",
-  "version": "0.11.0-next.11",
+  "version": "0.11.0-next.12",
   "description": "Miden Wasm SDK",
   "collaborators": [
     "Miden",

crates/web-client/src/models/mod.rs

@@ -81,6 +81,7 @@ pub mod provers;
 pub mod public_key;
 pub mod rpo256;
 pub mod secret_key;
+pub mod signature;
 pub mod storage_map;
 pub mod storage_slot;
 pub mod sync_summary;

crates/web-client/src/models/public_key.rs

@@ -1,10 +1,35 @@
-use miden_objects::crypto::dsa::rpo_falcon512::PublicKey as NativePublicKey;
+use miden_objects::{Word as NativeWord, crypto::dsa::rpo_falcon512::PublicKey as NativePublicKey};
 use wasm_bindgen::prelude::*;
+use wasm_bindgen_futures::js_sys::Uint8Array;
+
+use crate::{
+    models::{signature::Signature, word::Word},
+    utils::{deserialize_from_uint8array, serialize_to_uint8array},
+};
 
 #[wasm_bindgen]
 #[derive(Copy, Clone)]
 pub struct PublicKey(NativePublicKey);
 
+#[wasm_bindgen]
+impl PublicKey {
+    pub fn serialize(&self) -> Uint8Array {
+        let native_word: NativeWord = self.0.into();
+        serialize_to_uint8array(&native_word)
+    }
+
+    pub fn deserialize(bytes: &Uint8Array) -> Result<PublicKey, JsValue> {
+        let native_word = deserialize_from_uint8array::<NativeWord>(bytes)?;
+        let native_public_key = NativePublicKey::new(native_word);
+        Ok(PublicKey(native_public_key))
+    }
+
+    pub fn verify(&self, message: &Word, signature: &Signature) -> bool {
+        let native_signature = signature.into();
+        self.0.verify(message.into(), &native_signature)
+    }
+}
+
 // CONVERSIONS
 // ================================================================================================
 

crates/web-client/src/models/secret_key.rs

@@ -1,8 +1,12 @@
-use miden_objects::crypto::dsa::rpo_falcon512::SecretKey as NativeSecretKey;
+use miden_objects::{Word as NativeWord, crypto::dsa::rpo_falcon512::SecretKey as NativeSecretKey};
 use rand::{SeedableRng, rngs::StdRng};
 use wasm_bindgen::prelude::*;
+use wasm_bindgen_futures::js_sys::Uint8Array;
 
-use crate::models::public_key::PublicKey;
+use crate::{
+    models::{public_key::PublicKey, signature::Signature, word::Word},
+    utils::{deserialize_from_uint8array, serialize_to_uint8array},
+};
 
 #[wasm_bindgen]
 pub struct SecretKey(NativeSecretKey);
@@ -28,6 +32,22 @@ impl SecretKey {
     pub fn public_key(&self) -> PublicKey {
         self.0.public_key().into()
     }
+
+    pub fn sign(&self, message: &Word) -> Result<Signature, JsValue> {
+        let native_message: NativeWord = message.into();
+        let mut rng = StdRng::from_os_rng();
+        let signature = self.0.sign_with_rng(native_message, &mut rng);
+        Ok(signature.into())
+    }
+
+    pub fn serialize(&self) -> Uint8Array {
+        serialize_to_uint8array(&self.0)
+    }
+
+    pub fn deserialize(bytes: &Uint8Array) -> Result<SecretKey, JsValue> {
+        let native_secret_key = deserialize_from_uint8array::<NativeSecretKey>(bytes)?;
+        Ok(SecretKey(native_secret_key))
+    }
 }
 
 // CONVERSIONS

crates/web-client/src/models/signature.rs

@@ -0,0 +1,48 @@
+use miden_objects::crypto::dsa::rpo_falcon512::Signature as NativeSignature;
+use wasm_bindgen::prelude::*;
+use wasm_bindgen_futures::js_sys::Uint8Array;
+
+use crate::utils::{deserialize_from_uint8array, serialize_to_uint8array};
+
+#[wasm_bindgen]
+#[derive(Clone)]
+pub struct Signature(NativeSignature);
+
+#[wasm_bindgen]
+impl Signature {
+    pub fn serialize(&self) -> Uint8Array {
+        serialize_to_uint8array(&self.0)
+    }
+
+    pub fn deserialize(bytes: &Uint8Array) -> Result<Signature, JsValue> {
+        let native_signature = deserialize_from_uint8array::<NativeSignature>(bytes)?;
+        Ok(Signature(native_signature))
+    }
+}
+
+// CONVERSIONS
+// ================================================================================================
+
+impl From<NativeSignature> for Signature {
+    fn from(native_signature: NativeSignature) -> Self {
+        Signature(native_signature)
+    }
+}
+
+impl From<&NativeSignature> for Signature {
+    fn from(native_signature: &NativeSignature) -> Self {
+        Signature(native_signature.clone())
+    }
+}
+
+impl From<Signature> for NativeSignature {
+    fn from(signature: Signature) -> Self {
+        signature.0
+    }
+}
+
+impl From<&Signature> for NativeSignature {
+    fn from(signature: &Signature) -> Self {
+        signature.0.clone()
+    }
+}

crates/web-client/src/models/word.rs

@@ -1,7 +1,9 @@
 use miden_objects::{Felt as NativeFelt, Word as NativeWord};
 use wasm_bindgen::prelude::*;
+use wasm_bindgen_futures::js_sys::Uint8Array;
 
 use super::felt::Felt;
+use crate::utils::{deserialize_from_uint8array, serialize_to_uint8array};
 
 #[wasm_bindgen]
 #[derive(Clone)]
@@ -45,6 +47,15 @@ impl Word {
         self.0.to_hex()
     }
 
+    pub fn serialize(&self) -> Uint8Array {
+        serialize_to_uint8array(&self.0)
+    }
+
+    pub fn deserialize(bytes: &Uint8Array) -> Result<Word, JsValue> {
+        let native_word = deserialize_from_uint8array::<NativeWord>(bytes)?;
+        Ok(Word(native_word))
+    }
+
     #[wasm_bindgen(js_name = "toU64s")]
     pub fn to_u64s(&self) -> Vec<u64> {
         self.0.iter().map(NativeFelt::as_int).collect::<Vec<u64>>()

crates/web-client/src/utils/mod.rs

@@ -5,6 +5,8 @@ use wasm_bindgen_futures::js_sys::Uint8Array;
 
 pub mod assembler_utils;
 
+use crate::js_error_with_context;
+
 #[cfg(feature = "testing")]
 pub mod test_utils;
 
@@ -20,6 +22,5 @@ pub fn serialize_to_uint8array<T: Serializable>(value: &T) -> Uint8Array {
 pub fn deserialize_from_uint8array<T: Deserializable>(bytes: &Uint8Array) -> Result<T, JsValue> {
     let vec = bytes.to_vec();
     let mut reader = SliceReader::new(&vec);
-    T::read_from(&mut reader)
-        .map_err(|e| JsValue::from_str(&format!("Deserialization error: {e:?}")))
+    T::read_from(&mut reader).map_err(|e| js_error_with_context(e, "failed to deserialize"))
 }

crates/web-client/test/global.test.d.ts

@@ -37,6 +37,7 @@ import {
   PublicKey,
   Rpo256,
   SecretKey,
+  Signature,
   SlotAndKeys,
   SlotAndKeysArray,
   StorageMap,
@@ -103,6 +104,7 @@ declare global {
     PublicKey: typeof PublicKey;
     Rpo256: typeof Rpo256;
     SecretKey: typeof SecretKey;
+    Signature: typeof Signature;
     SlotAndKeys: typeof SlotAndKeys;
     SlotAndKeysArray: typeof SlotAndKeysArray;
     StorageMap: typeof StorageMap;