added expanded docstrings for encrypt.rs methods

Author: Roee-87

wasm/src/utilities/encrypt.rs

@@ -144,13 +144,23 @@ impl EncryptionToolkit {
     }
 
     /// Generates a transition view key from the view key and the transition public key.
+    ///
+    /// @param {ViewKey} view_key The view key to use for generating the transition view key.
+    /// @param {Group} tpk The transition public key to use for generating the transition view key.
+    ///
+    /// @returns {Field} The generated transition view key.
     #[wasm_bindgen(js_name = "generateTvk")]
     pub fn generate_tvk(view_key: &ViewKey, tpk: &Group) -> Field {
         tpk.scalar_multiply(&view_key.to_scalar()).to_x_coordinate()
     }
 
     /// Creates a record view key from the view key.  This can be later be used to decrypt a
     // record without revealing an account's view key.
+    ///
+    /// @param {ViewKey} view_key The view key to use for generating the record view key.
+    /// @param {RecordCiphertext} record_ciphertext The record ciphertext to use for generating the record view key.
+    ///
+    /// @returns {Field} The generated record view key.
     #[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();
@@ -159,6 +169,11 @@ impl EncryptionToolkit {
 
     /// Decrypts a record ciphertext using the record view key.  Decryption only succeeds
     /// if the record view key was generated from the view key of the record owner.
+    ///
+    /// @param {Field} record_vk The record view key to use for decryption.
+    /// @param {RecordCiphertext} record_ciphertext The record ciphertext to decrypt.
+    ///
+    /// @returns {RecordPlaintext} The decrypted record plaintext.
     #[wasm_bindgen(js_name = "decryptRecordWithRVk")]
     pub fn decrypt_record_symmetric_unchecked(
         record_vk: &Field,
@@ -176,6 +191,11 @@ impl EncryptionToolkit {
 
     /// Decrypts a transition using the transition view key.  The ciphertext inputs and outputs
     /// can only be decrypted if the transition view key was generated by the transaction signer.
+    ///
+    /// @param {Transition} transition The transition to decrypt.
+    /// @param {Field} transition_vk The transition view key to use for decryption.
+    ///
+    /// @returns {Transition} The decrypted transition.
     #[wasm_bindgen(js_name = "decryptTransitionWithVk")]
     pub fn decrypt_transition_with_vk(transition: &Transition, transition_vk: &Field) -> Result<Transition, String> {
         transition.decrypt_transition(transition_vk)