fixed doc strings, generate_record_view_key() method name, and punctuation

Author: Roee-87

wasm/src/utilities/encrypt.rs

@@ -41,7 +41,7 @@ pub struct EncryptionToolkit;
 
 #[wasm_bindgen]
 impl EncryptionToolkit {
-    /// Returns the number of field elements required to decrypt an Entry
+    /// Returns the number of field elements required to decrypt an Entry.
     pub(crate) fn num_entry_randomizers(entry: &CiphertextEntryNative) -> Result<u16, String> {
         match entry {
             // Constant and public entries do not need to be encrypted.
@@ -87,6 +87,7 @@ impl EncryptionToolkit {
         // Initialize an index to keep track of the randomizer index.
         let mut index: usize = 0;
 
+        // Get the reference of the native record.
         let record_native = &**record;
 
         // Decrypt the owner.
@@ -149,8 +150,8 @@ impl EncryptionToolkit {
 
     /// Creates a record view key from the view key.  This method is intended to be used
     /// by the record owner to enable decryption of a select record by a third party.
-    #[wasm_bindgen(js_name = "generateRecordVk")]
-    pub fn generate_record_vk(view_key: &ViewKey, record_ciphertext: &RecordCiphertext) -> Result<Field, String> {
+    #[wasm_bindgen(js_name = "generateRecordViewkey")]
+    pub fn generate_record_view_key(view_key: &ViewKey, record_ciphertext: &RecordCiphertext) -> Result<Field, String> {
         let record_nonce = record_ciphertext.nonce();
         Ok(record_nonce.scalar_multiply(&view_key.to_scalar()).to_x_coordinate())
     }
@@ -187,14 +188,14 @@ mod tests {
     use std::str::FromStr;
     use wasm_bindgen_test::wasm_bindgen_test;
 
+    const NON_OWNER_VIEW_KEY: &str = "AViewKey1e2WyreaH5H4RBcioLL2GnxvHk5Ud46EtwycnhTdXLmXp";
+    const OWNER_CIPHERTEXT: &str = "record1qyqsqpe2szk2wwwq56akkwx586hkndl3r8vzdwve32lm7elvphh37rsyqyxx66trwfhkxun9v35hguerqqpqzqrtjzeu6vah9x2me2exkgege824sd8x2379scspmrmtvczs0d93qttl7y92ga0k0rsexu409hu3vlehe3yxjhmey3frh2z5pxm5cmxsv4un97q";
     const OWNER_PLAINTEXT: &str = r"{
   owner: aleo1j7qxyunfldj2lp8hsvy7mw5k8zaqgjfyr72x2gh3x4ewgae8v5gscf5jh3.private,
   microcredits: 1500000000000000u64.private,
   _nonce: 3077450429259593211617823051143573281856129402760267155982965992208217472983group.public
 }";
-    const OWNER_CIPHERTEXT: &str = "record1qyqsqpe2szk2wwwq56akkwx586hkndl3r8vzdwve32lm7elvphh37rsyqyxx66trwfhkxun9v35hguerqqpqzqrtjzeu6vah9x2me2exkgege824sd8x2379scspmrmtvczs0d93qttl7y92ga0k0rsexu409hu3vlehe3yxjhmey3frh2z5pxm5cmxsv4un97q";
     const OWNER_VIEW_KEY: &str = "AViewKey1ccEt8A2Ryva5rxnKcAbn7wgTaTsb79tzkKHFpeKsm9NX";
-    const NON_OWNER_VIEW_KEY: &str = "AViewKey1e2WyreaH5H4RBcioLL2GnxvHk5Ud46EtwycnhTdXLmXp";
     const RECORD_TAG: &str = "1796466189545157638691489609907096471289658804813960182690905095269699169603field";
 
     #[wasm_bindgen_test]
@@ -203,7 +204,7 @@ mod tests {
         let owner_view_key = ViewKey::from_str(OWNER_VIEW_KEY).unwrap();
 
         // Generate the record view key
-        let record_vk = EncryptionToolkit::generate_record_vk(&owner_view_key, &owner_ciphertext).unwrap();
+        let record_vk = EncryptionToolkit::generate_record_view_key(&owner_view_key, &owner_ciphertext).unwrap();
 
         // Decrypt with the owner's view key
         let record_plaintext_decrypted =
@@ -217,7 +218,7 @@ mod tests {
         let non_owner_view_key = ViewKey::from_str(NON_OWNER_VIEW_KEY).unwrap();
 
         // Generate the record view key with a non-owner view key
-        let record_vk = EncryptionToolkit::generate_record_vk(&non_owner_view_key, &owner_ciphertext).unwrap();
+        let record_vk = EncryptionToolkit::generate_record_view_key(&non_owner_view_key, &owner_ciphertext).unwrap();
 
         // Attempt to decrypt with the non-owner's view key
         let result = EncryptionToolkit::decrypt_record_symmetric_unchecked(&record_vk, &owner_ciphertext);