[Performance] Remove the need to get each perpetual and price twice when checking collateralization (backport #1681)

[mergify]

Changelist

Speed up collateralization checks by not getting the perpetual and price from state twice (once for net collateral, once for margin requirements). Instead, just get it a single time.

Breaking change as this reduces the number of state reads which modifies the gas used.

Test Plan

Updated and added unit tests

Blocked on

#1678

Summary by CodeRabbit

• New Features

  • Introduced consolidated function GetPerpetualAndMarketPriceAndLiquidityTier to retrieve perpetual details, market price, and liquidity tier.

• Refactor

  • Refactored and streamlined margin requirement calculations using the new perplib functions.

• Tests

  • Updated tests to cover new scenarios for margin requirements and perpetual-related calculations, ensuring a broader scope of testing.

• Removals

  • Removed GetMarginRequirements function from several modules to centralize calculations using the new perplib library.

---

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

[mergify]

Cherry-pick of edcc82b has failed:

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

You are currently cherry-picking commit edcc82b7.
  (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/mocks/PerpetualsKeeper.go
	modified:   protocol/x/clob/keeper/deleveraging.go
	modified:   protocol/x/clob/keeper/liquidations.go
	modified:   protocol/x/clob/types/expected_keepers.go
	modified:   protocol/x/perpetuals/keeper/perpetual.go
	modified:   protocol/x/perpetuals/lib/lib.go
	modified:   protocol/x/perpetuals/lib/lib_test.go
	modified:   protocol/x/perpetuals/types/types.go
	modified:   protocol/x/subaccounts/keeper/subaccount.go
	modified:   protocol/x/subaccounts/types/expected_keepers.go

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   protocol/x/perpetuals/keeper/perpetual_test.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

[coderabbitai]

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

• X
• Mastodon
• Reddit
• LinkedIn

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.