osmosis icon indicating copy to clipboard operation
osmosis copied to clipboard

refactor/fix/test(sqs): pool liquidity pricing refactor & clean up

Open p0mvn opened this issue 1 year ago • 3 comments

Closes: #XXX

What is the purpose of the change

The goal of this work is to refactor and clean up pool liquidity pricing logic, making the abstraction consistently denominated in the single unit (USDC, descaled with precision). A related PR exists in sqs

This is also a pre-requisite towards the dynamic min liquidity pricing in SQS and pool liquidity pricing: https://github.com/osmosis-labs/sqs/pull/224

As a side benefit, the following issue was resolved, making the pool liquidity capitalization be consistently in a single denomination https://linear.app/osmosis/issue/DATA-48/understand-why-pool-tvl-has-become-scaled-updatetest-new-behavior

Additionally, the dependency on the asset list was removed from the node for no need.

Lastly, clean-ups of the convertPool function were achieved by encapsulating complex logic into separate functions for greater testability.

Testing and Verifying

  • Unit tests
  • Will test in stage after backporting to v25.x

Documentation and Release Note

  • [ ] Does this pull request introduce a new feature or user-facing behavior changes?
  • [ ] Changelog entry added to Unreleased section of CHANGELOG.md?

Where is the change documented?

  • [ ] Specification (x/{module}/README.md)
  • [ ] Osmosis documentation site
  • [ ] Code comments?
  • [ ] N/A

p0mvn avatar May 20 '24 00:05 p0mvn

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 May 20 '24 00:05 github-actions[bot]

Walkthrough

The recent updates enhance the pool transformer module by renaming configurations, adding new constants, modifying function signatures, and improving liquidity computations. Key changes include the introduction of usdcChainDenom, updates to test commands, and significant logic adjustments in pool transformation and liquidity cap calculations. These modifications streamline the handling of pool denoms and improve test coverage.

Changes

Files & Paths Change Summary
.vscode/launch.json Renamed configuration from "ingest/sqs/pools/ingester" to "ingest/sqs/pools/transformer". Updated test run command.
app/apptesting/concentrated_liquidity.go Added usdcChainDenom and included it in authorizedQuoteDenoms.
ingest/sqs/pools/transformer/export_test.go Modified function signatures, added new functions for pool transformation and liquidity computation.
ingest/sqs/sqs_config.go Introduced defaultUSDCUOSMOPool constant and updated NewConfigFromOptions function.
ingest/sqs/pools/transformer/pool_transformer.go Added defaultUSDCUOSMOPoolID field, adjusted spot price calculations, and updated methods.
ingest/sqs/pools/transformer/pool_transformer_test.go Modified test logic, adjusted constants, and added utility functions for pool liquidity caps.

In fields of code where logic flows, A rabbit hops where changes grow. Constants, pools, and denoms bright, Transforming data, day and night. With tests refined, and configs neat, The code evolves, a rhythmic beat. 🐰✨

[!TIP]

New Features and Improvements

Review Settings

Introduced new personality profiles for code reviews. Users can now select between "Chill" and "Assertive" review tones to tailor feedback styles according to their preferences. The "Assertive" profile posts more comments and nitpicks the code more aggressively, while the "Chill" profile is more relaxed and posts fewer comments.

AST-based Instructions

CodeRabbit offers customizing reviews based on the Abstract Syntax Tree (AST) pattern matching. Read more about AST-based instructions in the documentation.

Community-driven AST-based Rules

We are kicking off a community-driven initiative to create and share AST-based rules. Users can now contribute their AST-based rules to detect security vulnerabilities, code smells, and anti-patterns. Please see the ast-grep-essentials repository for more information.

New Static Analysis Tools

We are continually expanding our support for static analysis tools. We have added support for biome, hadolint, and ast-grep. Update the settings in your .coderabbit.yaml file or head over to the settings page to enable or disable the tools you want to use.

Tone Settings

Users can now customize CodeRabbit to review code in the style of their favorite characters or personalities. Here are some of our favorite examples:

  • Mr. T: "You must talk like Mr. T in all your code reviews. I pity the fool who doesn't!"
  • Pirate: "Arr, matey! Ye must talk like a pirate in all yer code reviews. Yarrr!"
  • Snarky: "You must be snarky in all your code reviews. Snark, snark, snark!"

Revamped Settings Page

We have redesigned the settings page for a more intuitive layout, enabling users to find and adjust settings quickly. This change was long overdue; it not only improves the user experience but also allows our development team to add more settings in the future with ease. Going forward, the changes to .coderabbit.yaml will be reflected in the settings page, and vice versa.

Miscellaneous

  • Turn off free summarization: You can switch off free summarization of PRs opened by users not on a paid plan using the enable_free_tier setting.
  • Knowledge-base scope: You can now set the scope of the knowledge base to either the repository (local) or the organization (global) level using the knowledge_base setting. In addition, you can specify Jira project keys and Linear team keys to limit the knowledge base scope for those integrations.
  • High-level summary placement: You can now customize the location of the high-level summary in the PR description using the high_level_summary_placeholder setting (default @coderabbitai summary).
  • Revamped request changes workflow: You can now configure CodeRabbit to auto-approve or request changes on PRs based on the review feedback using the request_changes_workflow setting.

Recent Review Details

Configuration used: CodeRabbit UI Review profile: CHILL

Commits Files that changed from the base of the PR and between 27035c104e6f8a9ec4ec57401cd253bc8039cee6 and d0520172c28be9c56dc280bfa7138b5d95908109.
Files ignored due to path filters (2)
  • go.mod is excluded by !**/*.mod, !**/*.mod
  • go.sum is excluded by !**/*.sum, !**/*.sum
Files selected for processing (1)
  • app/apptesting/concentrated_liquidity.go (2 hunks)
Files skipped from review as they are similar to previous changes (1)
  • app/apptesting/concentrated_liquidity.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 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.

coderabbitai[bot] avatar May 20 '24 01:05 coderabbitai[bot]

Blocked on merge of:

  • https://github.com/osmosis-labs/sqs/pull/241
  • https://github.com/osmosis-labs/sqs/pull/209

We will merge this PR once SQS side is ready

p0mvn avatar May 21 '24 16:05 p0mvn