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

Filter out additional incorrect TVL pools #3888

Open
wants to merge 1 commit into
base: stage
Choose a base branch
from

Conversation

JohnnyWyles
Copy link
Contributor

What is the purpose of the change:

Similar to #3864
This pool was noticed to be filtered and so 2 new ones were made with the same singlesided tactic, skewing displayed TVL.

Linear Task

Brief Changelog

Adds 2 pools to list

Testing and Verifying

This change has not been tested locally

Copy link

vercel bot commented Oct 14, 2024

@JohnnyWyles is attempting to deploy a commit to the OsmoLabs Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Oct 14, 2024

Walkthrough

The changes in this pull request focus on the FILTERABLE_IDS constant within the packages/server/src/queries/complex/pools/index.ts file. The update modifies the conditional assignment to include additional pool IDs ("2217" and "2218") when the environment is not a testnet. This adjustment broadens the filtering criteria for pool results, allowing for more IDs to be excluded. No other significant changes to logic, control flow, or the structure of types, functions, and schemas are present.

Changes

File Change Summary
packages/server/src/queries/complex/pools/index.ts Updated FILTERABLE_IDS to include "2217" and "2218" when not in testnet, expanding filtering criteria.

Possibly related PRs

Suggested reviewers

  • MaxMillington
  • JoseRFelix
  • DavideSegullo

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>, please review it.
    • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @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 using 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

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.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
packages/server/src/queries/complex/pools/index.ts (1)

22-22: Consider a more maintainable approach for managing filtered pools.

While hardcoding pool IDs works for now, it might become difficult to maintain as the list grows. Consider implementing a more flexible solution, such as:

  1. Storing filtered pool IDs in a configuration file.
  2. Implementing a dynamic filtering mechanism based on pool properties.

This would make it easier to update the list of filtered pools in the future without modifying the code.

Would you like assistance in designing a more scalable solution for managing filtered pools?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 291b9ec and e1faa83.

📒 Files selected for processing (1)
  • packages/server/src/queries/complex/pools/index.ts (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
packages/server/src/queries/complex/pools/index.ts (1)

22-22: LGTM, but needs testing and documentation.

The addition of pool IDs "2217" and "2218" to FILTERABLE_IDS aligns with the PR objective of filtering out additional incorrect TVL pools. However, please ensure the following:

  1. Test these changes locally before merging.
  2. Add a comment explaining why these specific pool IDs are being filtered.

To verify the impact of this change, please run the following script:

This will help ensure that filtering these pools doesn't have unintended consequences elsewhere in the codebase.

✅ Verification successful

To continue verifying the impact of adding pool IDs "2217" and "2218" to FILTERABLE_IDS, please run the following script:


To accurately verify references to pool IDs "2217" and "2218" without false positives, please run the following script:


Verification Successful: No other references to pool IDs "2217" and "2218" found.

The addition of pool IDs "2217" and "2218" to FILTERABLE_IDS has been validated with no unintended references in other parts of the codebase.

Please ensure the following before merging:

  1. Test these changes locally to confirm they behave as expected.
  2. Add a comment explaining why these specific pool IDs are being filtered.
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check for any references to the newly filtered pool IDs

echo "Searching for references to pool IDs 2217 and 2218:"
rg --type typescript --type javascript '2217|2218'

Length of output: 200


Script:

# 
#!/bin/bash
# Description: Search for references to pool IDs 2217 and 2218 in TypeScript and JavaScript files

echo "Searching for references to pool IDs 2217 and 2218 in .ts, .tsx, .js, and .jsx files:"
rg '2217|2218' -g '*.ts' -g '*.tsx' -g '*.js' -g '*.jsx'

Length of output: 2182


Script:

# 
#!/bin/bash
# Description: Search for exact references to pool IDs 2217 and 2218 in TypeScript and JavaScript files

echo "Searching for exact references to pool IDs 2217 and 2218 in .ts, .tsx, .js, and .jsx files:"
rg '\b2217\b|\b2218\b' -g '*.ts' -g '*.tsx' -g '*.js' -g '*.jsx'

Length of output: 375

@raphaellafar
Copy link

raphaellafar commented Oct 16, 2024

I strongly protest, there is no reason to block these pools. Moreover, introducing a filter at this level is a crime. And there is an ongoing discussion on this topic https://forum.osmosis.zone/t/pool-2159/3228/4

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants