Update packages/wrapped-keys/src/lib/api/update-encrypted-key.ts

Co-authored-by: Copilot <[email protected]>
Signed-off-by: Anson <[email protected]>

Author: Ansonhkg

packages/wrapped-keys/src/lib/api/update-encrypted-key.ts

@@ -6,7 +6,18 @@ import {
   getPkpAddressFromSessionSig,
 } from './utils';
 
-/** Update an existing wrapped key and append the previous state to versions. */
+/**
+ * Updates an existing wrapped key and appends the previous state to versions.
+ *
+ * @param {UpdateEncryptedKeyParams} params - The parameters required to update the encrypted private key.
+ * @param {Record<string, any>} params.pkpSessionSigs - The session signatures for the PKP.
+ * @param {any} params.litClient - The Lit Protocol client instance.
+ * @param {string} params.id - The unique identifier of the wrapped key to update.
+ * @param {string} params.ciphertext - The new encrypted private key ciphertext.
+ * @param {any} params.evmContractConditions - The EVM contract conditions for access control.
+ * @param {string} [params.memo] - An optional memo to associate with the update.
+ * @returns {Promise<UpdateEncryptedKeyResult>} An object containing the id, pkpAddress, and updatedAt timestamp of the updated key.
+ */
 export async function updateEncryptedKey(
   params: UpdateEncryptedKeyParams
 ): Promise<UpdateEncryptedKeyResult> {