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

remove branched context for OI calculation #1674

Closed
wants to merge 1 commit into from

Conversation

BrendanChou
Copy link
Contributor

@BrendanChou BrendanChou commented Jun 11, 2024

Changelist

Remove use of branched context for OI calculation. This is a breaking optimization

Summary by CodeRabbit

  • Refactor
    • Streamlined the subaccount update process by removing intermediate steps for open interest adjustments, leading to more efficient calculations of collateralization and margin requirements.

@BrendanChou BrendanChou requested a review from teddyding June 11, 2024 19:11
Copy link
Contributor

coderabbitai bot commented Jun 11, 2024

Walkthrough

The recent changes in the subaccounts.go file streamline the process of updating subaccounts by removing the logic associated with calculating delta open interest for perpetuals. This simplification allows the code to directly calculate new collateralization and margin requirements, enhancing efficiency and reducing complexity.

Changes

Files Change Summary
protocol/x/subaccounts/keeper/subaccount.go Removed logic for perpOpenInterestDelta calculation and handling, along with branching for new OIMF calculation. Directly calculates new collateralization and margin requirements.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Keeper
    User ->> Keeper: Request subaccount update
    Keeper ->> Keeper: Calculate new collateralization
    Keeper ->> Keeper: Calculate new margin requirements
    Keeper ->> User: Return updated subaccount status
Loading

Poem

In the realm of code so bright,
We’ve trimmed the logic, pure delight.
No more deltas to compute,
Straight to margins, how astute!
Collateral shines in streamlined light,
Our subaccounts now take flight.
🎉✨


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.

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: 4

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 8f0d3bc and 54c397b.

Files selected for processing (1)
  • protocol/x/subaccounts/keeper/subaccount.go (2 hunks)

// Get the new collateralization and margin requirements with the update applied.
bigNewNetCollateral,
bigNewInitialMargin,
bigNewMaintenanceMargin,
err := k.internalGetNetCollateralAndMarginRequirements(
branchedContext,
ctx,
Copy link
Contributor

Choose a reason for hiding this comment

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

Consider handling errors more gracefully in internalGetNetCollateralAndMarginRequirements.

The current implementation directly returns nil values for all outputs in case of an error. This might lead to misleading zero values being interpreted as valid data. It would be safer to return explicit error values or handle errors more gracefully to avoid misinterpretations.


Refactor suggestion for internalCanUpdateSubaccounts.

The function internalCanUpdateSubaccounts is quite complex and handles multiple responsibilities. Consider breaking it down into smaller, more focused functions. This could improve readability, maintainability, and ease of testing.


Optimize calculations in GetNetCollateralAndMarginRequirements.

The function GetNetCollateralAndMarginRequirements performs multiple calculations that could be optimized. Consider caching results of frequently computed values, especially those that do not change often, to reduce computational overhead.


Improve error handling in applyUpdatesToPositions.

The function applyUpdatesToPositions could improve its error handling by providing more detailed error messages and possibly suggesting resolutions. This would help developers understand and resolve conflicts more effectively.

@BrendanChou
Copy link
Contributor Author

Superceeded by #1691

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.

1 participant