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

[chore] Move perpetuals/keeper helper functions to perpetuals/lib (backport #1678) #1791

Merged

Conversation

mergify[bot]
Copy link
Contributor

@mergify mergify bot commented Jun 26, 2024

Changelist

Move x/perpetuals/keeper/perpetual.go helper functions to x/perpeptuals/lib for clarity. This is the first step in refactoring some of the margining functions for performance.

Test Plan

  • Added new units tests (and benchmarks) for these functions which did not have unit tests before

Summary by CodeRabbit

  • Refactor

    • Moved functions related to net notional, margin requirements, and settlement calculations to a new package for better modularity.
  • Tests

    • Added benchmarking and testing functions for settlement, net notional, and margin requirement calculations.
  • Style

    • Reordered and cleaned up import statements in test files.

This is an automatic backport of pull request #1678 done by [Mergify](https://mergify.com).

@mergify mergify bot added the conflicts label Jun 26, 2024
Copy link
Contributor Author

mergify bot commented Jun 26, 2024

Cherry-pick of 87a919e has failed:

On branch mergify/bp/release/protocol/v5.1.x/pr-1678
Your branch is up to date with 'origin/release/protocol/v5.1.x'.

You are currently cherry-picking commit 87a919e6.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   protocol/daemons/liquidation/client/sub_task_runner.go
	modified:   protocol/x/perpetuals/keeper/perpetual_test.go
	new file:   protocol/x/perpetuals/lib/lib.go
	new file:   protocol/x/perpetuals/lib/lib_test.go
	modified:   protocol/x/subaccounts/keeper/subaccount.go

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   protocol/x/perpetuals/keeper/perpetual.go

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

Copy link
Contributor

coderabbitai bot commented Jun 26, 2024

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


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.
    • @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 as 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.

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 closed this Jun 27, 2024
@mergify mergify bot deleted the mergify/bp/release/protocol/v5.1.x/pr-1678 branch June 27, 2024 14:30
@teddyding teddyding restored the mergify/bp/release/protocol/v5.1.x/pr-1678 branch June 27, 2024 15:17
@teddyding teddyding reopened this Jun 27, 2024
BrendanChou and others added 2 commits June 27, 2024 11:19
…#1678)

(cherry picked from commit 87a919e)

# Conflicts:
#	protocol/x/perpetuals/keeper/perpetual.go
@teddyding teddyding force-pushed the mergify/bp/release/protocol/v5.1.x/pr-1678 branch from d7226cf to 3bfc3c1 Compare June 27, 2024 16:15
@teddyding teddyding merged commit 085da35 into release/protocol/v5.1.x Jun 27, 2024
13 checks passed
@teddyding teddyding deleted the mergify/bp/release/protocol/v5.1.x/pr-1678 branch June 27, 2024 16:17
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