fix(affiliates): exclude liquidation fees in referred fee calculation

[teddyding]

Changelist

Exclude liquidation fee

Currently the affiliates referred fee include liquidation fee, which is an order of magnitude higher than regular maker/taker fees. Including this stats in "referred fees" stats is a bit misleading since this is "taker fee", but goes to insurance fund and is not rev sharable. Therefore we exclude liquidation fees in the stat (while keeping volume/trade count from liquidated fills).

Example from https://indexer.dydx.trade/v4/affiliates/snapshot: GreenKiteIMX is a VIP affiliate but its earnings is less than taker fees

Sort affiliates when offset is non zero

Sort affiliates by default when offset != 0 so there's strict ordering

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.

Summary by CodeRabbit

• New Features

  • Enhanced handling of affiliate information with updated calculations and logic.
  • Added support for new FillType to improve data model complexity.

• Bug Fixes

  • Adjusted test cases to reflect updated expected values for affiliate statistics.
  • Improved sorting logic for paginated results based on affiliate earnings and address.

• Documentation

  • Updated test suite to include new scenarios for affiliate earnings and pagination.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request enhance the AffiliateInfoTable functionality by updating the test suite and the implementation in the affiliate-info-table.ts file. A new type, FillType, is introduced to expand the data model. The SQL queries in the updateInfo function are modified to include a new column from the fills table, affecting how affiliate statistics are aggregated. Additionally, the sorting logic in the paginatedFindWithAddressFilter function is refined, and new test cases are added to ensure accurate handling of affiliate information and pagination.

Changes

File Path	Change Summary
indexer/packages/postgres/__tests__/stores/affiliate-info-table.test.ts	- Added import of FillType. - Updated test cases for affiliate information updates. - Added a new test case for paginatedFindWithAddressFilter. - Renamed test case for clarity on sorting.
indexer/packages/postgres/src/stores/affiliate-info-table.ts	- Imported FillType. - Updated SQL query in updateInfo to include type from fills. - Enhanced calculation of totalReferredTakerFees. - Adjusted sorting logic in paginatedFindWithAddressFilter.

Possibly related PRs

• [OTE-762] Affiliates comlink affiliate info #2269: Modifies the AffiliateInfoTable and introduces the paginatedFindWithAddressFilter function, related to pagination and filtering updates.
• Split affiliate info fees by taker and maker #2439: Focuses on splitting affiliate info fees by taker and maker, aligning with changes in handling affiliate earnings.
• add afflaiteReferredMakerRebates field to response #2473: Adds the affiliateReferredMakerRebates field to the response structure, relevant to updates in affiliate information handling.

Suggested labels

feature:indexer/affiliates

Suggested reviewers

• vincentwschau
• affanv14

🐰 In the fields where earnings grow,
A new type hops, as data flows.
With fills and filters, we refine,
Affiliate stats now brightly shine.
Tests are added, logic tight,
Hooray for changes, all feels right! 🌟

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[teddyding]

@Mergifyio backport release/indexer/v7.x

[mergify]

backport release/indexer/v7.x

✅ Backports have been created

• #2587 fix(affiliates): exclude liquidation fees in referred fee calculation (backport #2585) has been created for branch release/indexer/v7.x