Skip to content

Add JSDoc documentation for UpdateEncryptedKeyParams type #1014

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

Merged
Ansonhkg merged 2 commits into from
Dec 10, 2025
+10 −1
Merged

Add JSDoc documentation for UpdateEncryptedKeyParams type #1014

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fb3817e
Initial plan
Copilot Dec 10, 2025
505e2cf
docs: add detailed JSDoc documentation to UpdateEncryptedKeyParams
Copilot Dec 10, 2025
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
11 changes: 10 additions & 1 deletion packages/wrapped-keys/src/lib/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,16 @@ export interface StoreEncryptedKeyBatchResult {
pkpAddress: string;
}

/** Properties required to update an existing encrypted key in the wrapped-keys backend storage service */
/** Properties required to update an existing encrypted key in the wrapped-keys backend storage service
*
* @typedef UpdateEncryptedKeyParams
* @extends BaseApiParams
*
* @property { string } id The unique identifier (UUID V4) of the encrypted private key to update
* @property { string } ciphertext The new base64 encoded, salted & encrypted private key
* @property { string } [evmContractConditions] Optional EVM contract conditions for access control
* @property { string } [memo] Optional descriptor for the encrypted private key
*/
export type UpdateEncryptedKeyParams = BaseApiParams & {
id: string;
ciphertext: string;
Expand Down