Skip to content

Fix incorrect documentation in comments for decryptData arguments #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
who-biz wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix incorrect documentation in comments for decryptData arguments #11

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/react-native.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,7 +109,7 @@ export const Tools = {
* @param {string} address The recipient's z-address.
* @param {string} dataToEncrypt The plaintext message to encrypt.
* @param {boolean} returnSsk If true, the symmetric key used for encryption will be returned. Defaults to false.
* @returns {Promise<{ephemeralPublicKey: string, ciphertext: string, symmetricKey?: string}>} A promise that resolves with an EncryptedPayload object.
* @returns {Promise<{ephemeralPublicKey: string, encryptedData: string, symmetricKey?: string}>} A promise that resolves with an EncryptedPayload object.
*/
async encryptVerusData(
address: string,
Expand All @@ -121,9 +121,9 @@ export const Tools = {

/**
* Decrypts data with ivk + epk or ssk.
* @param {string | null} fvkHex The recipient's hex-encoded full viewing key. Not needed if sskHex is provided.
* @param {string | null} ivkHex The recipient's hex-encoded sapling incoming viewing key. Not needed if sskHex is provided.
* @param {string | null} epkHex The sender's hex-encoded ephemeral public key. Not needed if sskHex is provided.
* @param {string} ciphertextHex The hex-encoded encrypted message.
* @param {string} dataToDecrypt The hex-encoded encrypted message.
* @param {string | null} sskHex The hex-encoded symmetric session key. If provided, fvkHex and epkHex are ignored.
* @returns {Promise<string>} A promise that resolves with the decrypted plaintext message.
*/
Expand Down