Skip to content

Conversation

Copy link

Copilot AI commented Dec 10, 2025

Description

Adds comprehensive JSDoc documentation to UpdateEncryptedKeyParams type definition to match documentation patterns established for other types in the codebase (StoreEncryptedKeyParams, GetEncryptedKeyDataParams).

Changes:

  • Added @typedef, @extends, and @property tags to UpdateEncryptedKeyParams in packages/wrapped-keys/src/lib/types.ts
  • Documents all four properties: id, ciphertext, evmContractConditions, memo
  • Follows exact JSDoc format used throughout the types file

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

  • Code review passed with no issues on documentation changes
  • CodeQL security scan passed

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Co-authored-by: Ansonhkg <4049673+Ansonhkg@users.noreply.github.com>
Copilot AI changed the title [WIP] Update versioned key update support and APIs Add JSDoc documentation for UpdateEncryptedKeyParams type Dec 10, 2025
Copilot AI requested a review from Ansonhkg December 10, 2025 17:07
@Ansonhkg Ansonhkg marked this pull request as ready for review December 10, 2025 17:20
Copilot AI review requested due to automatic review settings December 10, 2025 17:20
@Ansonhkg Ansonhkg merged commit 688284e into feature/jss-141-add-update-function-for-wrapped-keys-naga Dec 10, 2025
1 of 2 checks passed
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds comprehensive JSDoc documentation to the UpdateEncryptedKeyParams type definition, bringing it in line with the documentation standards already established for other type definitions in the wrapped-keys package.

Key changes:

  • Added complete JSDoc documentation block with @typedef, @extends, and @property tags for UpdateEncryptedKeyParams
  • Documents all four properties (id, ciphertext, evmContractConditions, memo) with appropriate descriptions
  • Follows the established documentation pattern used throughout the types file

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants