feat(js-dapi-client): add option to request all keys

[pshenmic]

Issue being fixed or feature implemented

It is possible to request a an identity's all public keys in one request, but js dapi client does not allow you to do that currently.

This PR makes keyIds param of getIdentityKeys() optional

What was done?

How Has This Been Tested?

Breaking Changes

Checklist:

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have added or updated relevant unit/integration/functional/e2e tests
• I have added "!" to the title and described breaking changes in the corresponding section if my code contains any
• I have made corresponding changes to the documentation if needed

For repository code-owners and collaborators only

• I have assigned this pull request to a milestone

Summary by CodeRabbit

• New Features
  • Enhanced identity key retrieval functionality with support for requesting all keys or specific keys
  • Improved flexibility in key request handling

[coderabbitai]

Walkthrough

The changes modify the getIdentityKeys function in the DAPI client library to enhance key request flexibility. The implementation now supports two types of key requests: specific key retrieval by providing key IDs and a new option to retrieve all keys using the AllKeys request type. This modification allows more versatile identity key querying by introducing a more dynamic request type selection mechanism.

Changes

File	Change Summary
packages/js-dapi-client/lib/methods/platform/.../getIdentityKeysFactory.js	Added AllKeys import from @dashevo/dapi-grpc Introduced requestType variable for dynamic key request handling Updated conditional logic for key request type selection

Poem

🐰 Hopping through keys, both specific and wide,
A rabbit's request now takes a new stride
AllKeys or chosen, the path is now clear
Identity secrets, no longer austere
Code hops with grace, flexibility's might! 🔑

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

packages/js-dapi-client/lib/methods/platform/getIdentityKeys/getIdentityKeysFactory.js (2)

Line range hint 20-27: Update JSDoc to reflect optional keyIds parameter.

The JSDoc shows keyIds as required, but the implementation now treats it as optional. Please update the documentation to match the new behavior.

  /**
   * Fetch the version upgrade votes status
   * @typedef {getIdentityKeys}
   * @param {Buffer} identityId
-  * @param {number[]} keyIds
+  * @param {number[]} [keyIds] - Optional. If not provided, all keys will be requested
   * @param {number} limit
   * @param {DAPIClientOptions & {prove: boolean}} [options]
   * @returns {Promise<GetIdentityKeysResponse>}
   */

---

33-44: Consider reorganizing the code for better maintainability.

While the logic is correct, consider moving the identityId validation before creating the request type for better code organization.

    const { GetIdentityKeysRequestV0 } = GetIdentityKeysRequest;
    const getIdentityKeysRequest = new GetIdentityKeysRequest();
-    const requestType = new KeyRequestType();

    if (Buffer.isBuffer(identityId)) {
      // eslint-disable-next-line no-param-reassign
      identityId = Buffer.from(identityId);
    }

+    const requestType = new KeyRequestType();
    if (keyIds) {
      requestType.setSpecificKeys(new SpecificKeys().setKeyIdsList(keyIds));
    } else {
      requestType.setAllKeys(new AllKeys());
    }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cbddb8d and 0de242f.

📒 Files selected for processing (1)

• packages/js-dapi-client/lib/methods/platform/getIdentityKeys/getIdentityKeysFactory.js (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: Build Docker images (Dashmate helper, dashmate-helper, dashmate-helper) / Build Dashmate helper image
• GitHub Check: Build Docker images (DAPI, dapi, dapi) / Build DAPI image
• GitHub Check: Build JS packages / Build JS

🔇 Additional comments (2)

packages/js-dapi-client/lib/methods/platform/getIdentityKeys/getIdentityKeysFactory.js (2)

7-7: LGTM! Import added for new functionality.

The AllKeys import is correctly added alongside other related imports from @dashevo/dapi-grpc.

---

40-44: LGTM! Clean implementation of the all keys feature.

The implementation correctly handles both specific keys and all keys requests, meeting the PR objective. The request type is properly set in the final request.

Also applies to: 49-49