Skip to content

Commit d071e8c

Browse files
committed
updated docstring for encrypt.rs module
1 parent da0844e commit d071e8c

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

wasm/src/utilities/encrypt.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -145,10 +145,10 @@ impl EncryptionToolkit {
145145

146146
/// Generates a transition view key from the view key and the transition public key.
147147
///
148-
/// @param {ViewKey} view_key The view key to use for generating the transition view key.
149-
/// @param {Group} tpk The transition public key to use for generating the transition view key.
148+
/// @param {ViewKey} view_key The view key of the account that generated the transition.
149+
/// @param {Group} tpk The transition public key.
150150
///
151-
/// @returns {Field} The generated transition view key.
151+
/// @returns {Field} The transition view key.
152152
#[wasm_bindgen(js_name = "generateTvk")]
153153
pub fn generate_tvk(view_key: &ViewKey, tpk: &Group) -> Field {
154154
tpk.scalar_multiply(&view_key.to_scalar()).to_x_coordinate()
@@ -157,10 +157,10 @@ impl EncryptionToolkit {
157157
/// Creates a record view key from the view key. This can be later be used to decrypt a
158158
// record without revealing an account's view key.
159159
///
160-
/// @param {ViewKey} view_key The view key to use for generating the record view key.
161-
/// @param {RecordCiphertext} record_ciphertext The record ciphertext to use for generating the record view key.
160+
/// @param {ViewKey} view_key The view key of the owner of the record.
161+
/// @param {RecordCiphertext} record_ciphertext The record ciphertext used to derive the record view key.
162162
///
163-
/// @returns {Field} The generated record view key.
163+
/// @returns {Field} The record view key.
164164
#[wasm_bindgen(js_name = "generateRecordViewKey")]
165165
pub fn generate_record_view_key(view_key: &ViewKey, record_ciphertext: &RecordCiphertext) -> Result<Field, String> {
166166
let record_nonce = record_ciphertext.nonce();
@@ -170,7 +170,7 @@ impl EncryptionToolkit {
170170
/// Decrypts a record ciphertext using the record view key. Decryption only succeeds
171171
/// if the record view key was generated from the view key of the record owner.
172172
///
173-
/// @param {Field} record_vk The record view key to use for decryption.
173+
/// @param {Field} record_vk The record view key.
174174
/// @param {RecordCiphertext} record_ciphertext The record ciphertext to decrypt.
175175
///
176176
/// @returns {RecordPlaintext} The decrypted record plaintext.
@@ -193,7 +193,7 @@ impl EncryptionToolkit {
193193
/// can only be decrypted if the transition view key was generated by the transaction signer.
194194
///
195195
/// @param {Transition} transition The transition to decrypt.
196-
/// @param {Field} transition_vk The transition view key to use for decryption.
196+
/// @param {Field} transition_vk The transition view key.
197197
///
198198
/// @returns {Transition} The decrypted transition.
199199
#[wasm_bindgen(js_name = "decryptTransitionWithVk")]

0 commit comments

Comments
 (0)