expanded docstrings for methods without full return type descriptions

Author: Roee-87

wasm/src/ledger/transition.rs

@@ -176,22 +176,32 @@ impl Transition {
     }
 
     /// Get the transition public key of the transition.
+    ///
+    /// @returns {Group} Transition public key
     pub fn tpk(&self) -> Group {
         Group::from(self.0.tpk())
     }
 
     /// Get the transition view key of the transition.
+    ///
+    /// @param {ViewKey} view_key The view key of the transition signer.
+    ///
+    /// @returns {Field} Transition view key
     pub fn tvk(&self, view_key: &ViewKey) -> Field {
         let tpk = self.tpk();
         tpk.scalar_multiply(&view_key.to_scalar()).to_x_coordinate()
     }
 
     /// Get the transition commitment of the transition.
+    ///
+    /// @returns {Field} Transition commitment
     pub fn tcm(&self) -> Field {
         Field::from(self.0.tcm())
     }
 
     /// Get the transition signer commitment of the transition.
+    ///
+    /// @returns {Field} Transition signer commitment
     pub fn scm(&self) -> Field {
         Field::from(self.0.scm())
     }

wasm/src/programs/data/ciphertext.rs

@@ -57,6 +57,14 @@ impl Ciphertext {
 
     /// Decrypt a ciphertext using the view key of the transition signer, transition public key, and
     /// (program, function, index) tuple.
+    ///
+    /// @param {ViewKey} view_key The view key of the transition signer.
+    /// @param {Group} transition_public_key The transition public key used to encrypt the ciphertext.
+    /// @param {string} program The program ID of the function that encrypted the ciphertext.
+    /// @param {string} function_name The function name that encrypted the ciphertext.
+    /// @param {u16} index The index of the input parameter that was encrypted.
+    ///
+    /// @returns {Plaintext} The decrypted plaintext.
     #[wasm_bindgen(js_name = decryptWithTransitionInfo)]
     pub fn decrypt_with_transition_info(
         &self,
@@ -82,6 +90,13 @@ impl Ciphertext {
     }
 
     /// Decrypt a ciphertext using the transition view key and a (program, function, index) tuple.
+    ///
+    /// @param {Field} transition_view_key The transition view key that was used to encrypt the ciphertext.
+    /// @param {string} program The program ID of the function that encrypted the ciphertext.
+    /// @param {string} function_name The function name that encrypted the ciphertext.
+    /// @param {u16} index The index of the input parameter that was encrypted.
+    ///
+    /// @returns {Plaintext} The decrypted plaintext.
     #[wasm_bindgen(js_name = decryptWithTransitionViewKey)]
     pub fn decrypt_with_transition_view_key(
         &self,

wasm/src/programs/data/plaintext.rs

@@ -73,11 +73,21 @@ impl Plaintext {
     }
 
     /// Encrypt a plaintext with an address and randomizer.
+    ///
+    /// @param {Address} address The address to encrypt the plaintext for.
+    /// @param {Scalar} randomizer The randomizer to use for encryption.
+    ///
+    /// @returns {Ciphertext} The encrypted ciphertext.
+    #[wasm_bindgen(js_name = encrypt)]
     pub fn encrypt(&self, address: &Address, randomizer: &Scalar) -> Result<Ciphertext, String> {
         self.0.encrypt(address, **randomizer).map_err(|e| e.to_string()).map(Ciphertext::from)
     }
 
     /// Encrypt a plaintext with a transition view key.
+    ///
+    /// @param {Field} transition_view_key The transition view key to use for encryption.
+    ///
+    /// @returns {Ciphertext} The encrypted ciphertext.
     #[wasm_bindgen(js_name = encryptSymmetric)]
     pub fn encrypt_symmetric(&self, transition_view_key: &Field) -> Result<Ciphertext, String> {
         self.0.encrypt_symmetric(**transition_view_key).map_err(|e| e.to_string()).map(Ciphertext::from)
@@ -106,6 +116,8 @@ impl Plaintext {
     }
 
     /// Get the left endian byte array representation of the plaintext.
+    ///
+    /// @returns {Uint8Array} The left endian byte array representation of the plaintext.
     #[wasm_bindgen(js_name = "toBytesLe")]
     pub fn to_bytes_le(&self) -> Result<Uint8Array, String> {
         let rust_bytes = self.0.to_bytes_le().map_err(|e| e.to_string())?;
@@ -125,6 +137,8 @@ impl Plaintext {
     }
 
     /// Get the left endian boolean array representation of the bits of the plaintext.
+    ///
+    /// @returns {Array} The left endian boolean array representation of the bits of the plaintext.
     #[wasm_bindgen(js_name = "toBitsLe")]
     pub fn to_bits_le(&self) -> Array {
         to_bits_array_le!(self)
@@ -143,6 +157,8 @@ impl Plaintext {
     }
 
     /// Get the field array representation of the plaintext.
+    ///
+    /// @returns {Array} The field array representation of the plaintext.
     #[wasm_bindgen(js_name = "toFields")]
     pub fn to_fields(&self) -> Result<Array, String> {
         let native = self.0.clone();

wasm/src/programs/offline_query.rs

@@ -64,13 +64,17 @@ impl OfflineQuery {
     }
 
     /// Get a json string representation of the offline query object
+    ///
+    /// @returns {string} JSON string representation of the offline query object
     #[wasm_bindgen(js_name = "toString")]
     #[allow(clippy::inherent_to_string)]
     pub fn to_string(&self) -> String {
         serde_json::to_string(&self).unwrap()
     }
 
     /// Create an offline query object from a json string representation
+    ///
+    /// @param {string} s JSON string representation of the offline query object
     #[wasm_bindgen(js_name = "fromString")]
     pub fn from_string(s: &str) -> Result<OfflineQuery, String> {
         serde_json::from_str(s).map_err(|e| e.to_string())

wasm/src/programs/request.rs

@@ -44,13 +44,17 @@ pub struct ExecutionRequest(RequestNative);
 #[wasm_bindgen]
 impl ExecutionRequest {
     /// Returns the request as a string.
+    ///
+    /// @returns {string} String representation of the request.
     #[wasm_bindgen(js_name = "toString")]
     #[allow(clippy::inherent_to_string)]
     pub fn to_string(&self) -> String {
         self.0.to_string()
     }
 
     /// Builds a request object from a string representation of a request.
+    ///
+    /// @param {string} request String representation of the request.
     #[wasm_bindgen(js_name = "fromString")]
     pub fn from_string(request: String) -> Result<ExecutionRequest, String> {
         Ok(ExecutionRequest(RequestNative::from_str(&request).map_err(|e| e.to_string())?))

wasm/src/record/record_ciphertext.rs

@@ -110,6 +110,8 @@ impl RecordCiphertext {
     }
 
     /// Get the left endian byte array representation of the record ciphertext.
+    ///
+    /// @returns {Uint8Array} Left endian byte array representation of the record ciphertext.
     #[wasm_bindgen(js_name = "toBytesLe")]
     pub fn to_bytes_le(&self) -> Result<Uint8Array, String> {
         let bytes_vec = self.0.to_bytes_le().map_err(|e| e.to_string())?;
@@ -118,12 +120,16 @@ impl RecordCiphertext {
     }
 
     /// Get the left endian boolean array representation of the record ciphertext bits.
+    ///
+    /// returns {Array} Left endian boolean array representation of the bits of the record ciphertext.
     #[wasm_bindgen(js_name = "toBitsLe")]
     pub fn to_bits_le(&self) -> Array {
         to_bits_array_le!(self)
     }
 
     /// Get the field array representation of the record ciphertext.
+    ///
+    /// @returns {Array} Field array representation of the record ciphertext.
     #[wasm_bindgen(js_name = "toFields")]
     pub fn to_fields(&self) -> Result<Array, String> {
         let native = self.0.clone();
@@ -145,6 +151,8 @@ impl RecordCiphertext {
     }
 
     /// Get the record nonce.
+    ///
+    /// @returns {Group} The record nonce.
     pub fn nonce(&self) -> Group {
         Group::from(self.0.nonce())
     }

wasm/src/record/record_plaintext.rs

@@ -74,6 +74,7 @@ impl RecordPlaintext {
         Self::from_str(record).map_err(|_| "The record plaintext string provided was invalid".into())
     }
 
+    // Get a record plaintext from
     #[wasm_bindgen(js_name = getMember)]
     pub fn get_member(&self, input: String) -> Result<Plaintext, String> {
         let entry = self
@@ -91,6 +92,8 @@ impl RecordPlaintext {
     }
 
     /// Get the owner of the record.
+    ///
+    /// @returns {Address} Address of the owner of the record.
     pub fn owner(&self) -> Result<Address, String> {
         match self.0.owner() {
             Owner::<CurrentNetwork, PlaintextNative>::Public(owner) => Ok(Address::from(*owner)),