Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add QueryAllLiquidityTiers to CLI #1434

Merged
merged 4 commits into from
Apr 30, 2024
Merged

Conversation

teddyding
Copy link
Contributor

Changelist

[Describe or list the changes made in this PR]

Test Plan

[Describe how this PR was tested (if applicable)]

Author/Reviewer Checklist

  • If this PR has changes that result in a different app state given the same prior state and transaction list, manually add the state-breaking label.
  • If the PR has breaking postgres changes to the indexer add the indexer-postgres-breaking label.
  • If this PR isn't state-breaking but has changes that modify behavior in PrepareProposal or ProcessProposal, manually add the label proposal-breaking.
  • If this PR is one of many that implement a specific feature, manually label them all feature:[feature-name].
  • If you wish to for mergify-bot to automatically create a PR to backport your change to a release branch, manually add the label backport/[branch-name].
  • Manually add any of the following labels: refactor, chore, bug.

@teddyding
Copy link
Contributor Author

@Mergifyio backport release/protocol/v5.x

Copy link
Contributor

mergify bot commented Apr 29, 2024

backport release/protocol/v5.x

✅ Backports have been created

Copy link
Contributor

coderabbitai bot commented Apr 29, 2024

Warning

Rate Limit Exceeded

@teddyding has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 9 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between d2d0ed1 and 55f26e2.

Walkthrough

The update introduces a new command CmdQueryAllLiquidityTiers() to the command-line interface (CLI) of the perpetuals module. This command enhances the CLI by allowing users to query all liquidity tiers directly from the terminal, facilitating easier access and management of liquidity data within the perpetuals trading protocol.

Changes

File Path Change Summary
.../cli/query.go Added CmdQueryAllLiquidityTiers() to CLI query commands

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
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>.
    • 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @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.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration 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.

@teddyding teddyding marked this pull request as ready for review April 29, 2024 18:51
Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

Out of diff range and nitpick comments (1)
protocol/x/perpetuals/client/cli/query_all_liquidity_tiers.go (1)

12-33: The implementation of CmdQueryAllLiquidityTiers follows standard practices for Cobra command definitions and interacts correctly with the Cosmos SDK client. Good use of context and proper error handling.

However, consider adding more detailed documentation for the command, explaining what data it retrieves and any potential use cases or limitations.

Comment on lines +16 to +28
func TestAllLiquidityTiers(t *testing.T) {
net, _, _ := networkWithLiquidityTierAndPerpetualObjects(t, 2, 2)
ctx := net.Validators[0].ClientCtx

common := []string{fmt.Sprintf("--%s=json", tmcli.OutputFlag)}

out, err := clitestutil.ExecTestCLICmd(ctx, cli.CmdQueryAllLiquidityTiers(), common)
require.NoError(t, err)

var resp types.QueryAllLiquidityTiersResponse
require.NoError(t, net.Config.Codec.UnmarshalJSON(out.Bytes(), &resp))
require.Equal(t, 2, len(resp.LiquidityTiers))
}
Copy link
Contributor

Choose a reason for hiding this comment

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

The test TestAllLiquidityTiers correctly sets up a network context and checks the command's output. It validates the expected number of liquidity tiers, ensuring the command's functionality.

Consider adding additional test cases to cover error scenarios, such as what happens if the network or query fails.

@teddyding teddyding merged commit 55992eb into main Apr 30, 2024
17 checks passed
@teddyding teddyding deleted the td/add-query-liquidity-tiers branch April 30, 2024 00:46
mergify bot pushed a commit that referenced this pull request Apr 30, 2024
teddyding added a commit that referenced this pull request Apr 30, 2024
(cherry picked from commit 55992eb)

Co-authored-by: Teddy Ding <teddy@dydx.exchange>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants