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

only create clob pair during deliver tx and cli cmd for pml #2272

Merged
merged 5 commits into from
Sep 18, 2024

Conversation

shrenujb
Copy link
Contributor

@shrenujb shrenujb commented Sep 17, 2024

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.

Summary by CodeRabbit

  • New Features

    • Introduced validation mechanisms for CLOB pair creation, ensuring only valid pairs are created.
    • Added new methods for validating and creating CLOB pairs within the interface.
  • Bug Fixes

    • Enhanced error handling in CLOB pair creation to prevent panics when duplicates are detected.
  • Improvements

    • Improved clarity and maintainability of the CLOB pair creation process through structured initialization and validation.
    • Enhanced logging for CLOB pair creation events to ensure better tracking and monitoring.
    • Expanded testing capabilities for CLOB pair creation across different transaction modes.

@shrenujb shrenujb requested a review from a team as a code owner September 17, 2024 14:40
Copy link
Contributor

coderabbitai bot commented Sep 17, 2024

Walkthrough

The changes in this pull request involve refactoring and enhancements across multiple modules within the protocol. Key updates include the restructuring of the CreatePerpetualClobPair function for improved validation and error handling, the modification of the CreateClobPair function to include new validation steps, and the introduction of new method signatures in the ClobKeeper interface for better management of CLOB pairs.

Changes

File Path Change Summary
protocol/x/clob/keeper/clob_pair.go Refactored CreatePerpetualClobPair to improve validation logic and error handling, renaming methods for clarity and encapsulating event logging within the function.
protocol/x/listing/keeper/listing.go Restructured CreateClobPair to include validation via ValidateClobPair, ensuring integrity before creation and checking for deliver transaction mode.
protocol/x/listing/types/expected_keepers.go Added method signatures for ValidateClobPairCreation and CreateClobPair to the ClobKeeper interface, enhancing functionality for clob pair management.
protocol/testutil/keeper/listing.go Introduced a new mock expectation for CreateOrderbook in the ListingKeepers function to enhance testing capabilities.
protocol/x/listing/keeper/listing_test.go Added TestCreateClobPair to validate the creation of a CLOB pair under different transaction modes, ensuring proper functionality.

Possibly related PRs

Suggested labels

bug

Poem

🐇 In the meadow where code does bloom,
Changes leap, dispelling gloom.
With pairs validated and errors caught,
A brighter path is surely sought!
So let us cheer, with hops and glee,
For every fix sets us free! 🌼


Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d928eb2 and e099cf7.

Files selected for processing (1)
  • protocol/x/listing/keeper/listing_test.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • protocol/x/listing/keeper/listing_test.go

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>, 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 generate interesting stats about this repository and render them as a table.
    -- @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 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.

Signed-off-by: Shrenuj Bansal <[email protected]>
Signed-off-by: Shrenuj Bansal <[email protected]>
Signed-off-by: Shrenuj Bansal <[email protected]>
Signed-off-by: Shrenuj Bansal <[email protected]>
@shrenujb shrenujb merged commit ba731b0 into main Sep 18, 2024
22 checks passed
@shrenujb shrenujb deleted the sbansal/pml_e2e branch September 18, 2024 01:05
@coderabbitai coderabbitai bot mentioned this pull request Sep 18, 2024
6 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Development

Successfully merging this pull request may close these issues.

2 participants