Merge pull request #1053 from ProvableHQ/rr/fix-docstrings-for-encryption-module

Reformat docstrings to include input and return fields

Author: Roee-87

docs/api_reference/sdk-src_account.md

@@ -504,21 +504,23 @@ const viewKey = account.viewKey();
 
 ---
 
-### `computeKey() ► Field`
+### `computeKey() ► ComputeKey`
 
 ![modifier: public](images/badges/modifier-public.svg)
 
-Returns the Transition View Key associated with the transition public key.
+Returns the ComputeKey associated with the account.
 
 Parameters | Type | Description
 --- | --- | ---
-__*return*__ | [Field](sdk-src_wasm.md) | *The transition view key*
+__*return*__ | `ComputeKey` | *The compute key of the account*
 
 #### Examples
 
 ```javascript
 import { Account } from "@provablehq/sdk/testnet.js";
-const account =
+
+const account = new Account();
+const computeKey = account.computeKey();
 ```
 
 ---

docs/api_reference/sdk-src_wasm.md

@@ -424,12 +424,12 @@ Decrypt a ciphertext using the view key of the transition signer, transition pub
 
 Parameters | Type | Description
 --- | --- | ---
-__view_key__ | `ViewKey` | **
-__transition_public_key__ | [Group](sdk-src_wasm.md) | **
-__program__ | `string` | **
-__function_name__ | `string` | **
-__index__ | `number` | **
-__*return*__ | [Plaintext](sdk-src_wasm.md) | **
+__view_key__ | `ViewKey` | *The view key of the transition signer.*
+__transition_public_key__ | [Group](sdk-src_wasm.md) | *The transition public key used to encrypt the ciphertext.*
+__program__ | `string` | *The program ID associated with the ciphertext.*
+__function_name__ | `string` | *The name of the function associated with the encrypted inputs and outputs.*
+__index__ | `u16` | *The index of the input or output parameter that was encrypted.*
+__*return*__ | [Plaintext](sdk-src_wasm.md) | *The decrypted plaintext.*
 
 ---
 
@@ -441,11 +441,11 @@ Decrypt a ciphertext using the transition view key and a (program, function, ind
 
 Parameters | Type | Description
 --- | --- | ---
-__transition_view_key__ | [Field](sdk-src_wasm.md) | **
-__program__ | `string` | **
-__function_name__ | `string` | **
-__index__ | `number` | **
-__*return*__ | [Plaintext](sdk-src_wasm.md) | **
+__transition_view_key__ | [Field](sdk-src_wasm.md) | *The transition view key that was used to encrypt the ciphertext.*
+__program__ | `string` | *The program ID associated with the ciphertext.*
+__function_name__ | `string` | *The name of the function associated with the encrypted inputs and outputs.*
+__index__ | `u16` | *The index of the input or output parameter that was encrypted.*
+__*return*__ | [Plaintext](sdk-src_wasm.md) | *The decrypted plaintext.*
 
 ---
 
@@ -1280,8 +1280,9 @@ Creates a new offline query object. The state root is required to be passed in a
 
 Parameters | Type | Description
 --- | --- | ---
-__block_height__ | `number` | **
-__state_root__ | `string` | **
+__block_height__ | `u32` | *The block height.*
+__state_root__ | `string` | *The state root of the current network.*
+__*return*__ | [OfflineQuery](sdk-src_wasm.md) | *The newly created offline query object.*
 
 ---
 
@@ -1295,7 +1296,7 @@ Add a new block height to the offline query object.
 
 Parameters | Type | Description
 --- | --- | ---
-__block_height__ | `number` | **
+__block_height__ | `u32` | *The block height to add.*
 __*return*__ | `void` | **
 
 ---
@@ -1308,8 +1309,8 @@ Add a new state path to the offline query object.
 
 Parameters | Type | Description
 --- | --- | ---
-__commitment:__ | `string` | *The commitment corresponding to a record inpout*
-__state_path:__ | `string` | *The state path corresponding to the commitment*
+__commitment:__ | `string` | *The commitment corresponding to a record input.*
+__state_path:__ | `string` | *The state path corresponding to the commitment.*
 __*return*__ | `void` | **
 
 ---
@@ -1318,23 +1319,23 @@ __*return*__ | `void` | **
 
 ![modifier: public](images/badges/modifier-public.svg)
 
-Get a json string representation of the offline query object
+Get a json string representation of the offline query object.
 
 Parameters | Type | Description
 --- | --- | ---
-__*return*__ | `string` | **
+__*return*__ | `string` | *JSON string representation of the offline query object.*
 
 ---
 
-### `fromString(s) ► OfflineQuery`
+### `fromString(JSON) ► OfflineQuery`
 
 ![modifier: public](images/badges/modifier-public.svg) ![modifier: static](images/badges/modifier-static.svg)
 
-Create an offline query object from a json string representation
+Create an offline query object from a json string representation.
 
 Parameters | Type | Description
 --- | --- | ---
-__s__ | `string` | **
+__JSON__ | `string` | *string representation of the offline query object.*
 __*return*__ | [OfflineQuery](sdk-src_wasm.md) | **
 
 ---
@@ -1387,9 +1388,9 @@ Encrypt a plaintext with an address and randomizer.
 
 Parameters | Type | Description
 --- | --- | ---
-__address__ | [Address](sdk-src_wasm.md) | **
-__randomizer__ | [Scalar](sdk-src_wasm.md) | **
-__*return*__ | [Ciphertext](sdk-src_wasm.md) | **
+__address__ | [Address](sdk-src_wasm.md) | *The address to encrypt the plaintext for.*
+__randomizer__ | [Scalar](sdk-src_wasm.md) | *The randomizer to use for encryption.*
+__*return*__ | [Ciphertext](sdk-src_wasm.md) | *The encrypted ciphertext.*
 
 ---
 
@@ -1401,8 +1402,9 @@ Encrypt a plaintext with a transition view key.
 
 Parameters | Type | Description
 --- | --- | ---
-__transition_view_key__ | [Field](sdk-src_wasm.md) | **
-__*return*__ | [Ciphertext](sdk-src_wasm.md) | **
+__transition_view_key__ | [Field](sdk-src_wasm.md) | *The transition view key of the transition
+associated with the plaintext.*
+__*return*__ | [Ciphertext](sdk-src_wasm.md) | *The encrypted ciphertext.*
 
 ---
 
@@ -1440,7 +1442,7 @@ Get the left endian byte array representation of the plaintext.
 
 Parameters | Type | Description
 --- | --- | ---
-__*return*__ | `Uint8Array` | **
+__*return*__ | `Uint8Array` | *The left endian byte array representation of the plaintext.*
 
 ---
 
@@ -1457,15 +1459,15 @@ __*return*__ | [Plaintext](sdk-src_wasm.md) | *The plaintext object.*
 
 ---
 
-### `toBitsLe() ► Array.<any>`
+### `toBitsLe() ► Array`
 
 ![modifier: public](images/badges/modifier-public.svg)
 
 Get the left endian boolean array representation of the bits of the plaintext.
 
 Parameters | Type | Description
 --- | --- | ---
-__*return*__ | `Array.<any>` | **
+__*return*__ | `Array` | *The left endian boolean array representation of the bits of the plaintext.*
 
 ---
 
@@ -1482,15 +1484,15 @@ __*return*__ | [Plaintext](sdk-src_wasm.md) | *The plaintext object.*
 
 ---
 
-### `toFields() ► Array.<any>`
+### `toFields() ► Array`
 
 ![modifier: public](images/badges/modifier-public.svg)
 
 Get the field array representation of the plaintext.
 
 Parameters | Type | Description
 --- | --- | ---
-__*return*__ | `Array.<any>` | **
+__*return*__ | `Array` | *The field array representation of the plaintext.*
 
 ---
 
@@ -2529,7 +2531,7 @@ Get the left endian byte array representation of the record ciphertext.
 
 Parameters | Type | Description
 --- | --- | ---
-__*return*__ | `Uint8Array` | **
+__*return*__ | `Uint8Array` | *Left endian byte array representation of the record ciphertext.*
 
 ---
 
@@ -2539,21 +2541,23 @@ __*return*__ | `Uint8Array` | **
 
 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.
+
 Parameters | Type | Description
 --- | --- | ---
 __*return*__ | `Array.<any>` | **
 
 ---
 
-### `toFields() ► Array.<any>`
+### `toFields() ► Array`
 
 ![modifier: public](images/badges/modifier-public.svg)
 
 Get the field array representation of the record ciphertext.
 
 Parameters | Type | Description
 --- | --- | ---
-__*return*__ | `Array.<any>` | **
+__*return*__ | `Array` | *Field array representation of the record ciphertext.*
 
 ---
 
@@ -2578,7 +2582,7 @@ Get the record nonce.
 
 Parameters | Type | Description
 --- | --- | ---
-__*return*__ | [Group](sdk-src_wasm.md) | **
+__*return*__ | [Group](sdk-src_wasm.md) | *The record nonce.*
 
 ---
 
@@ -2596,11 +2600,24 @@ Return a record plaintext from a string.
 
 Parameters | Type | Description
 --- | --- | ---
-__record__ | `string` | *String representation of a plaintext representation of an Aleo record*
+__record__ | `string` | *String representation of a plaintext representation of an Aleo record.*
 __*return*__ | [RecordPlaintext](sdk-src_wasm.md) | *Record plaintext*
 
 ---
 
+### `getMember(input) ► Plaintext`
+
+![modifier: public](images/badges/modifier-public.svg)
+
+Get the record entry matching a key.
+
+Parameters | Type | Description
+--- | --- | ---
+__input__ | `string` | *The key to retrieve the value in the record data field.*
+__*return*__ | [Plaintext](sdk-src_wasm.md) | *The plaintext value corresponding to the key.*
+
+---
+
 ### `owner() ► Address`
 
 ![modifier: public](images/badges/modifier-public.svg)
@@ -2609,7 +2626,7 @@ Get the owner of the record.
 
 Parameters | Type | Description
 --- | --- | ---
-__*return*__ | [Address](sdk-src_wasm.md) | **
+__*return*__ | [Address](sdk-src_wasm.md) | *Address of the owner of the record.*
 
 ---
 

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 associated with the ciphertext.
+    /// @param {string} function_name The name of the function associated with the encrypted inputs and outputs.
+    /// @param {u16} index The index of the input or output 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 associated with the ciphertext.
+    /// @param {string} function_name The name of the function associated with the encrypted inputs and outputs.
+    /// @param {u16} index The index of the input or output 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,22 @@ 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 of the transition
+    /// associated with the plaintext.
+    ///
+    /// @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 +117,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 +138,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 +158,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();