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

(Transaction History) Use new Numia messageType filter to avoid polluting transaction history list #4009

Conversation

JoseRFelix
Copy link
Collaborator

What is the purpose of the change:

The /v2/txs/{address} endpoint currently retrieves all transaction messages, including those not relevant to specific use cases. This has led to issues with empty pages in the transaction history table due to the inclusion of unused message types.

To address this we'll use the messageType filter now that the txs endpoint supports filtering transactions using query parameters.

Linear Task

https://linear.app/osmosis/issue/FE-1288/use-new-numia-messagetype-filter-to-avoid-polluting-transaction

Testing and Verifying

  • Does not display blank tx pages because they were filtered

Copy link

vercel bot commented Dec 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
osmosis-frontend ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 12, 2024 4:57am
4 Skipped Deployments
Name Status Preview Comments Updated (UTC)
osmosis-frontend-datadog ⬜️ Ignored (Inspect) Dec 12, 2024 4:57am
osmosis-frontend-dev ⬜️ Ignored (Inspect) Dec 12, 2024 4:57am
osmosis-frontend-edgenet ⬜️ Ignored (Inspect) Dec 12, 2024 4:57am
osmosis-testnet ⬜️ Ignored (Inspect) Dec 12, 2024 4:57am

Copy link
Contributor

coderabbitai bot commented Dec 12, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/server/src/queries/complex/transactions/transactions.ts

Oops! Something went wrong! :(

ESLint: 8.50.0

ESLint couldn't find the config "prettier" to extend from. Please check that the name of the config is correct.

The config "prettier" was referenced from the config file in "/packages/server/.eslintrc.js".

If you still have problems, please stop by https://eslint.org/chat/help to chat with the team.

Walkthrough

The pull request introduces enhancements to the transaction querying functionality across several files. The getTransactions function is updated to include a new messageTypes parameter, allowing for filtering of specific swap transaction types. Correspondingly, the queryTransactions function is modified to accept this parameter and adjust its URL query logic. Additionally, the local-router.ts file is updated to reintroduce the poolsRouter into the routing configuration. These changes collectively improve the handling and processing of transaction-related requests.

Changes

File Path Change Summary
packages/server/src/queries/complex/transactions/transactions.ts Updated getTransactions to include messageTypes parameter for filtering specific swap transactions.
packages/server/src/queries/data-services/transactions.ts Modified queryTransactions to accept messageTypes parameter and adjust URL query logic accordingly.
packages/web/server/api/local-router.ts Added poolsRouter back into the localRouter for handling pool-related requests.

Possibly related PRs

Suggested reviewers

  • CryptoAssassin1
  • jonator
  • kamal-sutra

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2ed6cc5 and d15ffa4.

📒 Files selected for processing (3)
  • packages/server/src/queries/complex/transactions/transactions.ts (1 hunks)
  • packages/server/src/queries/data-services/transactions.ts (1 hunks)
  • packages/web/server/api/local-router.ts (1 hunks)
🔇 Additional comments (4)
packages/web/server/api/local-router.ts (1)

9-9: LGTM: Reintroducing poolsRouter

The addition of poolsRouter is consistent with the PR's objective to filter transaction history, as pool-related operations are a subset of swap transactions.

packages/server/src/queries/data-services/transactions.ts (2)

86-91: LGTM: Clean parameter addition

The messageTypes parameter is properly typed and integrated into the function signature.


97-99: Verify API compatibility with Numia

The implementation correctly handles empty arrays and joins message types with commas. However, let's verify the API contract.

✅ Verification successful

Implementation correctly handles messageTypes parameter format

The implementation is correct and consistent with Numia API usage patterns. The code:

  1. Properly handles empty arrays by not appending the parameter
  2. Uses comma-separated format for multiple message types, which is a standard REST API practice
  3. Follows the same pattern as other query parameters in the codebase
  4. Matches the API integration pattern seen in other Numia API endpoints in the codebase (e.g., staking-apr.ts, portfolio-over-time.ts)
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify Numia API documentation or examples for messageTypes parameter format
# Expected: Documentation showing comma-separated messageTypes in query params

# Search for API documentation files
fd -t f -e md -e txt . | xargs rg -l "Numia.*API|messageTypes.*parameter"

# Search for existing usage patterns
rg -A 2 "messageTypes.*append" 

Length of output: 108


Script:

#!/bin/bash
# Let's try a broader search to understand the API integration patterns

# Search for Numia-related configurations or API endpoints
rg -i "numia.*api|numia.*endpoint|numia.*url" -A 3

# Search for any test files or examples using messageTypes
fd -t f -e test.ts -e spec.ts . | xargs rg "messageTypes"

# Look for any HTTP client configurations or API calls
ast-grep --pattern 'fetch($$$url$$$, { $$$params$$$ })'

Length of output: 2555


Script:

#!/bin/bash
# Let's examine the specific file and its surrounding context to understand the API usage pattern

# Look at the entire transactions.ts file
cat packages/server/src/queries/data-services/transactions.ts

# Search for any other files that might be using similar API patterns
rg -g '!*.test.ts' -g '!*.spec.ts' "searchParams.append" -B 2 -A 2

Length of output: 17475

packages/server/src/queries/complex/transactions/transactions.ts (1)

144-149: Extract message types into constants

Consider extracting these message types into named constants for better maintainability and reusability.

+const SWAP_MESSAGE_TYPES = [
+  "/osmosis.poolmanager.v1beta1.MsgSwapExactAmountIn",
+  "/osmosis.poolmanager.v1beta1.MsgSplitRouteSwapExactAmountIn",
+  "/osmosis.poolmanager.v1beta1.MsgSwapExactAmountOut",
+  "/osmosis.poolmanager.v1beta1.MsgSplitRouteSwapExactAmountOut",
+] as const;

 const data = await queryTransactions({
   address,
   page,
   pageSize,
-  messageTypes: [
-    "/osmosis.poolmanager.v1beta1.MsgSwapExactAmountIn",
-    "/osmosis.poolmanager.v1beta1.MsgSplitRouteSwapExactAmountIn",
-    "/osmosis.poolmanager.v1beta1.MsgSwapExactAmountOut",
-    "/osmosis.poolmanager.v1beta1.MsgSplitRouteSwapExactAmountOut",
-  ],
+  messageTypes: SWAP_MESSAGE_TYPES,
 });

Verify completeness of swap message types

Let's ensure we haven't missed any swap-related message types.

✅ Verification successful

Based on the search results, I can now generate the final response since I have enough information to verify the completeness of swap message types:

All swap message types are correctly included

The message types array is complete and includes all available swap-related message types from the Osmosis poolmanager v1beta1 module. The codebase search confirms these are the only swap message types used across the entire application:

  • /osmosis.poolmanager.v1beta1.MsgSwapExactAmountIn
  • /osmosis.poolmanager.v1beta1.MsgSplitRouteSwapExactAmountIn
  • /osmosis.poolmanager.v1beta1.MsgSwapExactAmountOut
  • /osmosis.poolmanager.v1beta1.MsgSplitRouteSwapExactAmountOut

The suggestion to extract these into constants remains valid for better maintainability.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Search for other potential swap message types in the codebase
# Expected: Confirmation that all swap message types are included

# Search for message type definitions in proto files
fd -e proto . | xargs rg "message.*Swap.*{|message.*Route.*{" -A 5

# Search for other swap-related message types in code
rg "MsgSwap|RouteSwap" 

Length of output: 67871


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 generate docstrings to generate docstrings for this PR. (Experiment)
  • @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.

@JoseRFelix JoseRFelix requested review from a team December 12, 2024 04:58
@JoseRFelix JoseRFelix merged commit 86f3643 into stage Dec 12, 2024
34 of 35 checks passed
@JoseRFelix JoseRFelix deleted the jose/fe-1288-use-new-numia-messagetype-filter-to-avoid-polluting branch December 12, 2024 14:58
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