osmosis icon indicating copy to clipboard operation
osmosis copied to clipboard

chore: don't use reserve field incorrectly

Open czarcas7ic opened this issue 1 year ago • 4 comments

Closes: #XXX

What is the purpose of the change

As pointed out by Fabien, we use reserve fields incorrectly, which causes issues with indexers. This restores the reserve fields, while deprecating them as we were supposed to do initially.

czarcas7ic avatar Jun 12 '24 21:06 czarcas7ic

Thanks!

penso avatar Jun 12 '24 21:06 penso

Walkthrough

The changes primarily involve deprecating and updating various fields across multiple protobuf files in the Osmosis project. These updates include marking fields as deprecated, introducing new fields, and modifying existing fields with additional tags. The changes aim to improve clarity and maintainability of the codebase by replacing outdated fields and ensuring proper annotations.

Changes

File Path Change Summary
proto/osmosis/concentratedliquidity/params.proto Deprecated authorized_quote_denoms field and changed it to a repeated string field.
proto/osmosis/concentratedliquidity/v1beta1/gov.proto Added deprecated exponent_at_price_one field to PoolRecord message.
proto/osmosis/gamm/v1beta1/query.proto Deprecated reserved "withSwapFee" field and introduced a new bool withSwapFee field.
proto/osmosis/gamm/v2/query.proto Added deprecated withSwapFee boolean field to QuerySpotPriceRequest message.
proto/osmosis/poolmanager/v1beta1/query.proto Deprecated sender and pool_id fields in various request messages.
proto/osmosis/poolmanager/v1beta1/tx.proto Deprecated denom0 and denom1 fields in DenomPairTakerFee message.
proto/osmosis/protorev/v1beta1/genesis.proto Added PoolWeights field and days_since_module_genesis field to GenesisState message.
proto/osmosis/protorev/v1beta1/protorev.proto Deprecated tx_fees_tracker field in AllProtocolRevenue message.
proto/osmosis/twap/v1beta1/twap_record.proto Deprecated last_key_seen field in PruningState message with additional deprecation tags.
proto/osmosis/txfees/v1beta1/genesis.proto Deprecated TxFeesTracker field and replaced it with a new message containing tx_fees and height_accounting_starts_from fields.
x/gamm/client/cli/cli_test.go Modified TestGetCmdSpotPrice function to include WithSwapFee: false in test data.
osmoutils/osmocli/parsers.go Added isFieldDeprecated function to check for deprecated fields during parsing.

Poem

In fields of code where changes bloom,
Deprecated tags make room,
For newer paths and clearer ways,
Enhancing all our coding days.
With updates fresh, the system thrives,
In Osmosis, progress drives.
🐇✨


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

coderabbitai[bot] avatar Jun 12 '24 21:06 coderabbitai[bot]

Important Notice

This PR modifies an in-repo Go module. It is one of:

  • osmomath
  • osmoutils
  • x/ibc-hooks
  • x/epochs

The dependent Go modules, especially the root one, will have to be updated to reflect the changes. Failing to do so might cause e2e to fail.

Please follow the instructions below:

  1. Open https://github.com/osmosis-labs/osmosis/actions/workflows/go-mod-auto-bump.yml
  2. Provide the current branch name
  3. On success, confirm if an automated commit corretly updated the go.mod and go.sum files

Please let us know if you need any help.

github-actions[bot] avatar Jun 13 '24 01:06 github-actions[bot]

This pull request has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you!

github-actions[bot] avatar Jun 25 '24 00:06 github-actions[bot]

This pull request has been automatically marked as stale because it has not had any recent activity. It will be closed if no further activity occurs. Thank you!

github-actions[bot] avatar Jul 12 '24 00:07 github-actions[bot]