feat(sdk): add option to request all keys #2445
Conversation
WalkthroughThe changes modify the Changes
Poem
✨ Finishing Touches
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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
keyIdsas 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
identityIdvalidation 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
📒 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
AllKeysimport 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
pshenmic
changed the title
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
packages/js-dapi-client/test/unit/methods/platform/getIdentityKeys/getIdentityKeysFactory.spec.js (1)
110-138: Consider adding edge cases to the all keys test.The new test case correctly validates the basic functionality for requesting all keys. However, consider adding edge cases to improve test coverage:
- Empty keys list
- Large number of keys
- Keys with different sizes
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
packages/js-dapi-client/lib/methods/platform/getIdentityKeys/getIdentityKeysFactory.js(2 hunks)packages/js-dapi-client/test/unit/methods/platform/getIdentityKeys/getIdentityKeysFactory.spec.js(4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- packages/js-dapi-client/lib/methods/platform/getIdentityKeys/getIdentityKeysFactory.js
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Build Docker images (DAPI, dapi, dapi) / Build DAPI image
- GitHub Check: Build Docker images (Dashmate helper, dashmate-helper, dashmate-helper) / Build Dashmate helper image
- GitHub Check: Build JS packages / Build JS
🔇 Additional comments (3)
packages/js-dapi-client/test/unit/methods/platform/getIdentityKeys/getIdentityKeysFactory.spec.js (3)
10-10: LGTM!The
AllKeysimport is correctly added and aligns with the PR objective to support requesting all keys.
28-28: LGTM!Good refactoring of the
metadatavariable. Moving the declaration outsidebeforeEachwhile keeping initialization inside maintains proper test isolation.Also applies to: 47-51
79-108: LGTM!The test case for specific keys has been well-updated with:
- Clear test name indicating the specific keys scenario
- Correct response construction with only the requested key
- Proper request setup using
SpecificKeys- Comprehensive assertions
Issue being fixed or feature implemented
DAPI GetIdentityKeys request allows you to query identity public keys, and you may pass an array of Key ID for which you expect to return keys, or simply return all possible keys, but JS DAPI Client does not implement that option
This PR makes keyIds param of getIdentityKeys() in the JS DAPI Client optional
What was done?
How Has This Been Tested?
Breaking Changes
No breaking changes
Checklist:
For repository code-owners and collaborators only
Summary by CodeRabbit
Summary by CodeRabbit