Merge pull request #1099 from ProvableHQ/rr-use-value-type-for-signatures

[Feature] Add signing methods for Plaintext and Record types

Author: Roee-87

docs/api_reference/sdk-src_wasm.md

@@ -814,6 +814,21 @@ __*return*__ | [Field](sdk-src_wasm.md) | *The transition view key.*
 
 ---
 
+### `decryptSender(view_key, record, sender_ciphertext) ► Address`
+
+![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
+
+Decrypt the sender ciphertext associated with a record.
+
+Parameters | Type | Description
+--- | --- | ---
+__view_key__ | `ViewKey` | *View key associated with the record.*
+__record__ | [RecordPlaintext](sdk-src_wasm.md) | *Record plaintext associated with a sender.*
+__sender_ciphertext__ | [Field](sdk-src_wasm.md) | *Sender ciphertext associated with the record.*
+__*return*__ | [Address](sdk-src_wasm.md) | *address of the sender.*
+
+---
+
 ### `checkOwnedRecords(view_key, records) ► Vec.<RecordCiphertext>`
 
 ![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
@@ -842,6 +857,20 @@ __*return*__ | `vec.<RecordPlaintext>` | *The decrypted record plaintexts.*
 
 ---
 
+### `decryptSenderWithRvk(record_view_key, sender_ciphertext) ► Address`
+
+![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
+
+Decrypt the sender ciphertext associated with the record with the record view key.
+
+Parameters | Type | Description
+--- | --- | ---
+__record_view_key__ | [Field](sdk-src_wasm.md) | *Record view key associated with the record.*
+__sender_ciphertext__ | [Field](sdk-src_wasm.md) | *Sender ciphertext associated with the record.*
+__*return*__ | [Address](sdk-src_wasm.md) | *the address of the sender.*
+
+---
+
 ### `generateRecordViewKey(view_key, record_ciphertext) ► Field`
 
 ![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
@@ -1863,6 +1892,19 @@ __*return*__ | [PrivateKey](sdk-src_wasm.md) | **
 
 ## Methods
 
+### `sign_value(message) ► Signature`
+
+![modifier: public](images/badges/modifier-public.svg)
+
+Sign an instance of a valid Aleo data type or record.
+
+Parameters | Type | Description
+--- | --- | ---
+__message__ | `String` | *The string representation of the Aleo datatype or record to sign.*
+__*return*__ | [Signature](sdk-src_wasm.md) | *Signature of the message.*
+
+---
+
 ### `to_address() ► Address`
 
 ![modifier: public](images/badges/modifier-public.svg)
@@ -3172,6 +3214,20 @@ __*return*__ | [RecordPlaintext](sdk-src_wasm.md) | *The record plaintext.*
 
 ---
 
+### `decryptSender(view_key, sender_ciphertext) ► Address`
+
+![modifier: public](images/badges/modifier-public.svg)
+
+Decrypt the sender ciphertext associated with the record.
+
+Parameters | Type | Description
+--- | --- | ---
+__view_key__ | `ViewKey` | *View key associated with the record.*
+__sender_ciphertext__ | [Field](sdk-src_wasm.md) | *Sender ciphertext associated with the record.*
+__*return*__ | [Address](sdk-src_wasm.md) | *address of the sender.*
+
+---
+
 ### `recordViewKey(view_key) ► Group`
 
 ![modifier: public](images/badges/modifier-public.svg)
@@ -3537,6 +3593,20 @@ Cryptographic signature of a message signed by an Aleo account
 
 ## Methods
 
+### `signValue(private_key, message) ► Signature`
+
+![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
+
+Sign an instance of a valid Aleo data type or record.
+
+Parameters | Type | Description
+--- | --- | ---
+__private_key__ | [PrivateKey](sdk-src_wasm.md) | *The private key used to sign the message.*
+__message__ | `String` | *The string representation of the Aleo datatype or record to sign.*
+__*return*__ | [Signature](sdk-src_wasm.md) | *Signature of the message.*
+
+---
+
 ### `to_address() ► Address`
 
 ![modifier: public](images/badges/modifier-public.svg)
@@ -3611,6 +3681,20 @@ __*return*__ | [Plaintext](sdk-src_wasm.md) | **
 
 ---
 
+### `verifyValue(address, message) ► boolean`
+
+![modifier: public](images/badges/modifier-public.svg)
+
+Verify a signature over an Aleo datatype or record by an address.
+
+Parameters | Type | Description
+--- | --- | ---
+__address__ | [Address](sdk-src_wasm.md) | *The address used to verify the signature.*
+__message__ | `String` | *The message to verify, which must be the string representation of a valid Aleo datatype or record.*
+__*return*__ | `boolean` | *True if the signature is valid, false otherwise.*
+
+---
+
 ### `fromBytesLe(bytes) ► Signature`
 
 ![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)

wasm/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@provablehq/wasm",
   "version": "0.9.8",
-  "type":"module",
+  "type": "module",
   "description": "SnarkVM WASM binaries with javascript bindings",
   "collaborators": [
     "The Provable Team"
@@ -43,8 +43,8 @@
   },
   "devDependencies": {
     "@rollup/plugin-virtual": "^3.0.2",
-    "@wasm-tool/rollup-plugin-rust": "^3.0.4",
-    "binaryen": "^121.0.0",
+    "@wasm-tool/rollup-plugin-rust": "^3.0.5",
+    "binaryen": "^124.0.0",
     "rimraf": "^6.0.1",
     "rollup": "^4.32.0"
   }

wasm/src/account/private_key.rs

@@ -100,6 +100,15 @@ impl PrivateKey {
         Signature::sign(self, message)
     }
 
+    /// Sign an instance of a valid Aleo data type or record.
+    ///
+    /// @param {String} message The string representation of the Aleo datatype or record to sign.
+    /// @returns {Signature} Signature of the message.
+    #[wasm_bindgen(js_name = "signValue")]
+    pub fn sign_value(&self, message: &str) -> Result<Signature, String> {
+        Ok(Signature::sign_value(self, message)?)
+    }
+
     /// Get a new randomly generated private key ciphertext using a secret. The secret is sensitive
     /// and will be needed to decrypt the private key later, so it should be stored securely
     ///
@@ -261,4 +270,19 @@ mod tests {
             assert!(signature.verify_bytes(&private_key.to_address(), &message));
         }
     }
+
+    #[wasm_bindgen_test]
+    pub fn test_signature_over_fields() {
+        for _ in 0..ITERATIONS {
+            // Sample a new private key and message.
+            let private_key = PrivateKey::new();
+            let rand_val: u64 = StdRng::from_entropy().gen();
+            let message = format!("{rand_val}field");
+
+            // Sign the message.
+            let signature = private_key.sign_value(&message).unwrap();
+            // Check the signature is valid.
+            assert!(signature.verify_value(&private_key.to_address(), &message).unwrap());
+        }
+    }
 }