feat(js-dapi-client): add contested resources query methods
Issue being fixed or feature implemented
JS DAPI Client is missing methods for querying contested resources info, that is used to retrieve current contested documents and vote resource state info.
Backport from https://github.com/owl352/dapi-client
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
- Added methods to retrieve contested resource vote states
- Added methods to fetch contested resources
- Introduced new response classes for handling contested resource queries
-
Improvements
- Implemented robust error handling and retry mechanisms for resource queries
- Enhanced platform methods facade with new query capabilities
Walkthrough
The changes introduce new functionality to the Dash Platform JavaScript client for interacting with contested resources and their vote states. Two new methods, getContestedResourceVoteState and getContestedResources, have been added to the PlatformMethodsFacade class. These methods allow developers to query information about contested resources, including their current vote status and details. The implementation includes factory functions, response classes, and comprehensive test coverage to ensure reliable interaction with the Dash Platform's gRPC transport layer.
Changes
| File | Change Summary |
|---|---|
packages/js-dapi-client/lib/methods/platform/PlatformMethodsFacade.js |
Added two new methods: getContestedResourceVoteState and getContestedResources |
packages/js-dapi-client/lib/methods/platform/getContestedResourceVoteState/GetContestedResourceVoteStateResponse.js |
New response class for handling contested resource vote state responses |
packages/js-dapi-client/lib/methods/platform/getContestedResourceVoteState/getContestedResourceVoteStateFactory.js |
New factory function for creating contested resource vote state method |
packages/js-dapi-client/lib/methods/platform/getContestedResources/getContestedResourcesFactory.js |
New factory function for creating contested resources retrieval method |
packages/js-dapi-client/lib/methods/platform/getContestedResources/getContestedResourcesResponse.js |
New response class for handling contested resources responses |
packages/js-dapi-client/test/unit/methods/platform/... |
Updated test files to cover new contested resources functionality |
Sequence Diagram
sequenceDiagram
participant Client
participant PlatformMethodsFacade
participant gRPCTransport
participant ContestedResourcesService
Client->>PlatformMethodsFacade: getContestedResources()
PlatformMethodsFacade->>gRPCTransport: Create gRPC Request
gRPCTransport->>ContestedResourcesService: Send Request
ContestedResourcesService-->>gRPCTransport: Return Contested Resources
gRPCTransport-->>PlatformMethodsFacade: Process Response
PlatformMethodsFacade-->>Client: Return Contested Resources
Poem
🐰 Hop, hop, through contested lands we go, Resources dancing, vote states in tow, gRPC whispers secrets so bright, Platform methods now shine with might! A rabbit's code, precise and clean, 🌟 Dash's new feature, now unforeseen!
✨ 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?
🪧 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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR. (Beta)@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.