Refactor perpetual upgrade handlers in `v5.0.0` #1442

teddyding · 2024-04-29T22:18:55Z

Changelist

Combine MarketType and OpenInterest initialization logic so that each perpetual are only written to state once.
Some slight refactoring of OpenInterest iniitializing logic
- Don't check for OpenInterest pre-upgrade handler since it's expected to be Nil
- Explicitly initialize OpenInterest to zero if market has no OI

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
- Enhanced the upgrade process to initialize and aggregate open interest for perpetual markets, ensuring accurate and up-to-date financial data.
- Improved trading functionality by introducing new quantum values for BTC and ETH, allowing for more precise order placements.

coderabbitai · 2024-04-29T22:19:00Z

Walkthrough

The recent update involves enhancing the perpetuals trading protocol by introducing methods to validate and set perpetual positions within the PerpetualsKeeper interface. It also includes setting all perpetuals to a cross-market type, initializing their open interest based on current values, and aggregating data by iterating through subaccounts.

Changes

File Path	Change Summary
`.../v5.0.0/upgrade.go`	Introduced a new `dtypes` import, set all perpetuals to cross market type, initialized perpetual open interest, and aggregated open interest for each market.
`.../protocol/mocks/PerpetualsKeeper.go`	Added a new mock function `ValidateAndSetPerpetual` to `PerpetualsKeeper` for validating and setting perpetuals.
`.../protocol/app/upgrades/v5.0.0/upgrade_container_test.go`	Added constants `CarlDaveBTCQuantums` and `CarlDaveETHQuantums`, and updated `placeOrders` function for BTC and ETH orders.

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between cc4cd2e and b030228.

Files selected for processing (1)

protocol/mocks/PerpetualsKeeper.go (1 hunks)

Additional Context Used

Path-based Instructions (1)

protocol/mocks/PerpetualsKeeper.go (1)

Pattern **/**: Do not include a walkthrough. For all comments on line changes that are longer than 15 lines, add a prefix to the comment of what lines you are commenting on (for example: "The changes from lines 100 to 200...". Add your comment to be on the last 15 lines of the chunk rather than adding your comment to the entire chunk.

Additional comments not posted (1)

protocol/mocks/PerpetualsKeeper.go (1)

453-469: The implementation of ValidateAndSetPerpetual follows the established mocking pattern and correctly handles return values and errors.

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@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 · 2024-04-29T22:19:23Z

protocol/app/upgrades/v5.0.0/upgrade.go

@@ -238,69 +288,6 @@ func voteExtensionsUpgrade(
 	)
 }

-// Initialize open interest for perpetuals
-func initializePerpOpenInterest(


Combined into perpetaulUpgrade

teddyding · 2024-04-29T22:20:05Z

protocol/app/upgrades/v5.0.0/upgrade.go

 	perpetuals := perpetualsKeeper.GetAllPerpetuals(ctx)
-	for _, p := range perpetuals {
-		_, err := perpetualsKeeper.SetPerpetualMarketType(


Avoid two separate calls of SetPerpetualMarketType here and ModifyOpenInterest below; just use validateAndSetPerpetual once.

roy-dydx · 2024-04-29T22:29:12Z

protocol/app/upgrades/v5.0.0/upgrade_container_test.go

@@ -1,5 +1,3 @@
-//go:build all || container_test


Add this back

teddyding · 2024-04-30T00:12:51Z

@mergify backport release/backport/v5.x

mergify · 2024-04-30T00:12:55Z

backport release/backport/v5.x

❌ No backport have been created

Backport to branch release/backport/v5.x failed

GitHub error: Branch not found

teddyding · 2024-04-30T00:50:59Z

@mergify backport release/protocol/v5.x

mergify · 2024-04-30T00:51:18Z

backport release/protocol/v5.x

✅ Backports have been created

#1444 Refactor perpetual upgrade handlers in v5.0.0 (backport #1442) has been created for branch release/protocol/v5.x

(cherry picked from commit e2359f3)

(cherry picked from commit e2359f3) Co-authored-by: Teddy Ding <teddy@dydx.exchange>

refactor perpetual upgrade handlers in v5.0.0

dfd1b1f

teddyding marked this pull request as ready for review April 29, 2024 22:18

github-actions bot added the protocol label Apr 29, 2024

teddyding commented Apr 29, 2024

View reviewed changes

nit

32cfceb

roy-dydx requested changes Apr 29, 2024

View reviewed changes

nit

fdabebe

roy-dydx approved these changes Apr 29, 2024

View reviewed changes

shrenujb approved these changes Apr 29, 2024

View reviewed changes

teddyding added 2 commits April 29, 2024 20:04

td/improve-oimf-ugprade-handler

cc4cd2e

Mock gen PerpetualsKeeper

b030228

teddyding merged commit e2359f3 into main Apr 30, 2024
15 of 16 checks passed

teddyding deleted the td/improve-oimf-ugprade-handler branch April 30, 2024 00:47

mergify bot pushed a commit that referenced this pull request Apr 30, 2024

Refactor perpetual upgrade handlers in v5.0.0 (#1442)

531c4b5

(cherry picked from commit e2359f3)

mergify bot mentioned this pull request Apr 30, 2024

Refactor perpetual upgrade handlers in v5.0.0 (backport #1442) #1444

Merged

6 tasks

teddyding added a commit that referenced this pull request Apr 30, 2024

Refactor perpetual upgrade handlers in v5.0.0 (#1442) (#1444)

b126ab1

(cherry picked from commit e2359f3) Co-authored-by: Teddy Ding <teddy@dydx.exchange>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Refactor perpetual upgrade handlers in `v5.0.0` #1442

Refactor perpetual upgrade handlers in `v5.0.0` #1442

teddyding commented Apr 29, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 29, 2024 •

edited

Loading

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

teddyding Apr 29, 2024

teddyding Apr 29, 2024

roy-dydx Apr 29, 2024

teddyding commented Apr 30, 2024

mergify bot commented Apr 30, 2024 •

edited

Loading

teddyding commented Apr 30, 2024

mergify bot commented Apr 30, 2024 •

edited

Loading

Refactor perpetual upgrade handlers in v5.0.0 #1442

Refactor perpetual upgrade handlers in v5.0.0 #1442

Conversation

teddyding commented Apr 29, 2024 • edited by coderabbitai bot Loading

Changelist

Test Plan

Author/Reviewer Checklist

Summary by CodeRabbit

coderabbitai bot commented Apr 29, 2024 • edited Loading

Walkthrough

Changes

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

teddyding Apr 29, 2024

Choose a reason for hiding this comment

teddyding Apr 29, 2024

Choose a reason for hiding this comment

roy-dydx Apr 29, 2024

Choose a reason for hiding this comment

teddyding commented Apr 30, 2024

mergify bot commented Apr 30, 2024 • edited Loading

❌ No backport have been created

teddyding commented Apr 30, 2024

mergify bot commented Apr 30, 2024 • edited Loading

✅ Backports have been created

Refactor perpetual upgrade handlers in `v5.0.0` #1442

Refactor perpetual upgrade handlers in `v5.0.0` #1442

teddyding commented Apr 29, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Apr 29, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)

mergify bot commented Apr 30, 2024 •

edited

Loading

mergify bot commented Apr 30, 2024 •

edited

Loading