[CT-1002] functions to move collateral in and out of perpetual positions #1889
Conversation
WalkthroughThe updates introduce several new functions and methods across different files to enhance the handling and calculation of perpetual market positions and collateral management. Key changes include the addition of a function to create Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant PerpetualMarket
participant SubaccountManager
participant CollateralManager
User->>PerpetualMarket: Request for PerpInfo creation
PerpetualMarket-->>User: Returns PerpInfo
User->>SubaccountManager: Update subaccount with new PerpInfo
SubaccountManager->>CollateralManager: Rebalance collateral
CollateralManager-->>SubaccountManager: Collateral rebalanced
SubaccountManager-->>User: Subaccount updated with new collateral
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configration File (
|
| @@ -132,3 +133,36 @@ func SetUpDefaultPerpOIsForTest( | |||
| } | |||
| } | |||
| } | |||
|
|
|||
| func CreatePerpInfo( | |||
There was a problem hiding this comment.
just moving here, no change
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (8)
- protocol/testutil/perpetuals/perpetuals.go (2 hunks)
- protocol/x/subaccounts/keeper/margining.go (1 hunks)
- protocol/x/subaccounts/keeper/margining_test.go (1 hunks)
- protocol/x/subaccounts/lib/updates.go (1 hunks)
- protocol/x/subaccounts/lib/updates_test.go (4 hunks)
- protocol/x/subaccounts/types/position_size.go (1 hunks)
- protocol/x/subaccounts/types/settled_update.go (1 hunks)
- protocol/x/subaccounts/types/update.go (1 hunks)
Files skipped from review due to trivial changes (1)
- protocol/x/subaccounts/keeper/margining_test.go
Additional comments not posted (16)
protocol/x/subaccounts/types/settled_update.go (2)
16-22: LGTM! Function implementation is correct.The
GetAssetUpdatesfunction correctly converts theAssetUpdatesslice to a map and returns deep copies of each update.
24-30: LGTM! Function implementation is correct.The
GetPerpetualUpdatesfunction correctly converts thePerpetualUpdatesslice to a map and returns deep copies of each update.protocol/x/subaccounts/types/position_size.go (1)
127-132: LGTM! Function implementation is correct.The
GetBigQuoteBalancefunction correctly returns theBigQuoteBalanceDeltaif it exists, otherwise a newbig.Int.protocol/x/subaccounts/types/update.go (3)
95-100: LGTM! Function implementation is correct.The
DeepCopyfunction forAssetUpdatecorrectly returns a deep copy of theAssetUpdatestruct.
112-122: LGTM! Function implementation is correct.The
DeepCopyfunction forPerpetualUpdatecorrectly returns a deep copy of thePerpetualUpdatestruct.
108-109: LGTM! Struct modification is correct.The
BigQuoteBalanceDeltafield is correctly added to thePerpetualUpdatestruct.protocol/testutil/perpetuals/perpetuals.go (1)
137-168: LGTM! Function implementation is correct.The
CreatePerpInfofunction correctly constructs and returns aperptypes.PerpInfostruct with the provided parameters.protocol/x/subaccounts/lib/updates_test.go (3)
8-8: LGTM! Imports are clean and necessary.The import changes, including the addition of
perp_testutiland the removal of unused imports, improve the codebase.
131-131: LGTM! Function call updated correctly.The function call has been correctly updated to use
perp_testutil.CreatePerpInfo.
150-151: LGTM! Function calls updated correctly.The function calls have been correctly updated to use
perp_testutil.CreatePerpInfo.protocol/x/subaccounts/keeper/margining.go (5)
15-30: LGTM! Function implementation is correct.The function correctly calculates quote balance updates for the given settled updates.
110-160: LGTM! Function implementation is correct.The function correctly rebalances collateral across all positions.
162-195: LGTM! Function implementation is correct.The function correctly withdraws all extra collateral from all perpetual positions associated with the given subaccount.
197-230: LGTM! Function implementation is correct.The function correctly moves collateral to a specified position.
32-108: EnsureCalculateUpdatedSubaccounthandles edge cases.The function calculates quote balance updates for a single settled update. Ensure that
CalculateUpdatedSubaccounthandles edge cases correctly.protocol/x/subaccounts/lib/updates.go (1)
290-299: LGTM! Position calculation updates are correct.The updates to the position calculation, including the new
QuoteBalancefield, are correct and consistent.
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- protocol/x/subaccounts/keeper/margining.go (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- protocol/x/subaccounts/keeper/margining.go
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (2)
- protocol/x/subaccounts/keeper/margining.go (1 hunks)
- protocol/x/subaccounts/keeper/margining_test.go (1 hunks)
Files skipped from review as they are similar to previous changes (2)
- protocol/x/subaccounts/keeper/margining.go
- protocol/x/subaccounts/keeper/margining_test.go
Changelist
[Describe or list the changes made in this PR]
Test Plan
[Describe how this PR was tested (if applicable)]
Author/Reviewer Checklist
state-breakinglabel.indexer-postgres-breakinglabel.PrepareProposalorProcessProposal, manually add the labelproposal-breaking.feature:[feature-name].backport/[branch-name].refactor,chore,bug.Summary by CodeRabbit
New Features
Enhancements
Refactor
Testing
Documentation