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

[SKI-21] Bump slinky version to v0.3.1 #1275

Merged
merged 3 commits into from
Mar 29, 2024

Conversation

Eric-Warehime
Copy link
Contributor

Changelist

Bumps slinky version to 0.3.1 (most recent release.
This includes cosmos-sdk bump for security fix GHSA-95rx-m9m5-m94v
Also includes a new compat method on the PricesKeeper which is used to bound the number of currency pairs included in vote extensions.

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.

Copy link
Contributor

coderabbitai bot commented Mar 28, 2024

Important

Auto Review Skipped

Review was skipped due to path filters

Files ignored due to path filters (2)
  • protocol/go.mod is excluded by !**/*.mod
  • protocol/go.sum is excluded by !**/*.sum

Walkthrough

The recent update involves modifications across several files in a blockchain protocol project, primarily focusing on the PricesKeeper interface. A new method, GetPrevBlockCPCounter, has been added to enhance functionality related to retrieving the number of currency pairs from the previous block. This includes updates to both the implementation and testing of this feature, alongside some housekeeping changes such as removing an unnecessary argument in a function call and reordering import statements.

Changes

File Path Change Summary
protocol/app/app.go Removed app.ChainID() argument from NewDefaultValidateVoteExtensionsFn function call.
protocol/mocks/PricesKeeper.go Updated generated code version; added GetPrevBlockCPCounter mock function.
protocol/app/.../expected_keepers.go Added GetPrevBlockCPCounter method to PricesKeeper interface.
protocol/x/prices/keeper/slinky_adapter.go Reordered imports; added types import; introduced GetPrevBlockCPCounter function.
protocol/x/prices/keeper/slinky_adapter_test.go Added TestGetPrevBlockCPCounter function to test new functionality.
protocol/x/prices/types/types.go Added GetPrevBlockCPCounter method to PricesKeeper interface in types.go.

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-tests 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 tests 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 tests.
    • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

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.

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 56b7cce and d11c39d.
Files ignored due to path filters (2)
  • protocol/go.mod is excluded by !**/*.mod
  • protocol/go.sum is excluded by !**/*.sum
Files selected for processing (6)
  • protocol/app/app.go (1 hunks)
  • protocol/app/vote_extensions/expected_keepers.go (1 hunks)
  • protocol/mocks/PricesKeeper.go (2 hunks)
  • protocol/x/prices/keeper/slinky_adapter.go (2 hunks)
  • protocol/x/prices/keeper/slinky_adapter_test.go (1 hunks)
  • protocol/x/prices/types/types.go (1 hunks)
Path instructions used (6)
protocol/app/vote_extensions/expected_keepers.go (1)

/
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.

protocol/x/prices/types/types.go (1)

/
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.

protocol/x/prices/keeper/slinky_adapter.go (1)

/
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.

protocol/x/prices/keeper/slinky_adapter_test.go (1)

/
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.

protocol/mocks/PricesKeeper.go (1)

/
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.

protocol/app/app.go (1)

/
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 (6)
protocol/app/vote_extensions/expected_keepers.go (1)
  • 18-18: Adding the GetPrevBlockCPCounter method to the PricesKeeper interface is a significant enhancement. However, it would be beneficial to include documentation for this method to explain its purpose, expected behavior, and any specific considerations (e.g., error cases).
protocol/x/prices/types/types.go (1)
  • 54-54: The addition of the GetPrevBlockCPCounter method to the PricesKeeper interface here mirrors the change in the expected_keepers.go file. Including documentation for this method would be beneficial for the same reasons: clarity on its purpose and usage.
protocol/x/prices/keeper/slinky_adapter.go (2)
  • 5-13: The reordering of import statements and the addition of the types import improve the organization and clarity of the file. Good practice to keep imports well-organized.
  • 89-107: The implementation of GetPrevBlockCPCounter is clear and follows the expected logic to count the number of market prices. However, it's important to ensure that the iterator is efficiently used and that there are no potential performance issues with large datasets. Consider adding a comment about the expected size of the dataset it operates on and any performance considerations.
protocol/x/prices/keeper/slinky_adapter_test.go (1)
  • 105-115: The TestGetPrevBlockCPCounter function provides basic coverage for the new method. It would be beneficial to extend this test to cover edge cases, such as when there are no markets or potential error conditions, to ensure comprehensive test coverage.
protocol/mocks/PricesKeeper.go (1)
  • 252-278: The addition of the GetPrevBlockCPCounter mock function aligns with the interface changes and is essential for thorough testing. Ensure that mock functions are kept in sync with their corresponding interfaces to maintain test reliability.

Comment on lines 1526 to 1532
app.Logger(),
dydxPrepareProposalHandler,
dydxProcessProposalHandler,
ve.NewDefaultValidateVoteExtensionsFn(app.ChainID(), app.StakingKeeper),
ve.NewDefaultValidateVoteExtensionsFn(app.StakingKeeper),
veCodec,
extCommitCodec,
strategy,
Copy link
Contributor

Choose a reason for hiding this comment

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

📝 NOTE
This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [738-738]

The gRPC server initialization does not include credentials derived from an SSL certificate, which could potentially allow connections without encryption. It's crucial to ensure that all gRPC connections are secure to prevent tampering and compromise. Consider using credentials.NewServerTLSFromFile("cert.pem", "cert.key") to create secure credentials for the gRPC server.

- app.Server = daemonserver.NewServer(logger, grpc.NewServer(), &daemontypes.FileHandlerImpl{}, daemonFlags.Shared.SocketAddress)
+ creds, err := credentials.NewServerTLSFromFile("cert.pem", "cert.key")
+ if err != nil {
+     panic(err)
+ }
+ app.Server = daemonserver.NewServer(logger, grpc.NewServer(grpc.Creds(creds)), &daemontypes.FileHandlerImpl{}, daemonFlags.Shared.SocketAddress)

@Christopher-Li Christopher-Li merged commit 8186d3f into dydxprotocol:main Mar 29, 2024
17 checks passed
Christopher-Li pushed a commit that referenced this pull request Mar 29, 2024
* Bump slinky version

* Add cp number method
teddyding pushed a commit that referenced this pull request Mar 29, 2024
* Remove volatile market (#1263)

* [SKI-21] Bump slinky version to v0.3.1 (#1275)

* Bump slinky version

* Add cp number method

---------

Co-authored-by: Eric Warehime <eric.warehime@gmail.com>
dydxwill added a commit that referenced this pull request Apr 3, 2024
* Add subaccountNumber to PerpetualPositionResponseObject (#1274)

Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>

* [CT-712] send updates for both normal order matches and liquidation (#1280)

* Remove volatile market (#1263)

* [SKI-21] Bump slinky version to v0.3.1 (#1275)

* Bump slinky version

* Add cp number method

* clean up socks logging (#1285)

* [CT-681] fix liquidated side and offsetting side for indexer delevera… (#1284)

* [CT-681] fix liquidated side and offsetting side for indexer deleveraging events

* fix test

* fix test

* fix lint

* [TRA-105] Add API for parent subaccount perpetual positions (#1282)


Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>

* Use sample rate with stream destroyed stats. (#1294)

* Revert "[CT-708] Indexer track e2e latency (#1237)" (#1292)

This reverts commit 60b94df.

* Fix swagger generation makefile command / regen swagger docs (#1299)

* pull dydx fork to generate swagger properly

* remove the print

* remove vault constants (#1293)

* Remove custom ping message from socks (#1301)

* Add subaccountNumber to the OrderResponseObject (#1296)

Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>

* sample more metrics (#1304)

* [OTE-256] Add upgrade handler to initialize OI during upgrade handler (#1302)

* Add upgrade handler to initialize OI during upgrade handler

* nits

* Fix lib.ErrorLogWithError: properly pass in args (#1306)

* fix broken tests (#1312)

* Explicitly close websockets on errors (#1290)

* Increase the number of allowed connections to 8000 (#1317)

* [TRA-104] Add parentSubaccountNumber API for orders (#1313)


Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>

* Improve Slinky logs to prevent unnecessary logs (#1289)

* [SKI-26]: Prevent funding index update with no oracle prices from (#1321)

halting indexer

* Skip equity tier limit check in PlaceShortTermOrder (#1318)

* Skip equity tier limit check in PlaceShortTermOrder

* remove tests

* Add comment

* fix lint (#1323)

---------

Signed-off-by: Shrenuj Bansal <shrenuj@dydx.exchange>
Co-authored-by: shrenujb <98204323+shrenujb@users.noreply.github.com>
Co-authored-by: jayy04 <103467857+jayy04@users.noreply.github.com>
Co-authored-by: Eric Warehime <eric.warehime@gmail.com>
Co-authored-by: vincentwschau <99756290+vincentwschau@users.noreply.github.com>
Co-authored-by: Jonathan Fung <121899091+jonfung-dydx@users.noreply.github.com>
Co-authored-by: Tian <tian@dydx.exchange>
Co-authored-by: Teddy Ding <teddy@dydx.exchange>
Co-authored-by: roy-dydx <133032749+roy-dydx@users.noreply.github.com>
Co-authored-by: Christopher-Li <Christopher-Li@users.noreply.github.com>
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.

2 participants