dydxprotocol / v4-chain

dydx v4 protocol
Other
231 stars 105 forks source link

Add gRPC gateway routing for affiliate queries #2554

Closed teddyding closed 6 days ago

teddyding commented 6 days ago

Changelist

[Describe or list the changes made in this PR]

Test Plan

Tested by visiting http://localhost:1317/dydxprotocol/affiliates/all_affiliate_tiers and http://localhost:1317/dydxprotocol/affiliates/affiliate_whitelist

Author/Reviewer Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 6 days ago

Walkthrough

The changes introduce a new LCDQueryClient class for querying affiliate-related information in the dydxprotocol, with methods for fetching affiliate info, referred affiliates, affiliate tiers, and whitelists. Additionally, the bundle.ts file has been updated to reflect new import paths for various modules, and the createLCDClient function now includes a new affiliates property. The query.proto file has been modified to allow HTTP GET requests for affiliate-related RPC methods, and the RegisterGRPCGatewayRoutes method in module.go has been updated to register a gRPC query handler client.

Changes

File Change Summary
indexer/packages/v4-protos/src/codegen/dydxprotocol/affiliates/query.lcd.ts Added LCDQueryClient class with methods for affiliate queries.
indexer/packages/v4-protos/src/codegen/dydxprotocol/bundle.ts Updated import statements for various modules, including new paths for query and transaction modules.
indexer/packages/v4-protos/src/codegen/dydxprotocol/lcd.ts Added affiliates property to createLCDClient, initialized with LCDQueryClient.
proto/dydxprotocol/affiliates/query.proto Updated RPC methods to include HTTP GET options for affiliate-related endpoints.
protocol/x/affiliates/module.go Modified RegisterGRPCGatewayRoutes to register a gRPC query handler client.

Possibly related PRs

Suggested labels

indexer, protocol, proto, pml

Suggested reviewers

🐰 In the world of code, so bright and new,
A client for queries, we built just for you!
With methods to fetch, and data to share,
Affiliates united, in the code we declare.
From bundles to routes, all neatly aligned,
In the garden of logic, our changes entwined! 🌼


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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
🪧 Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit , 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 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
teddyding commented 6 days ago

@Mergifyio backport release/protocol/v7.x

mergify[bot] commented 6 days ago

backport release/protocol/v7.x

✅ Backports have been created

* [#2555 Add gRPC gateway routing for affiliate queries (backport #2554)](https://github.com/dydxprotocol/v4-chain/pull/2555) has been created for branch `release/protocol/v7.x`