fix(affiliates): Fix logic in affiliate referred volume aggregation #2623

teddyding · 2024-12-05T20:25:11Z

Changelist

Currently, when calculating referred volumes from new fills, if the taker is not referred, the fill is skipped directly so the maker volume (even if referred) does not count towards the affiliate's referred volume.
Fixed by independently adding volume from taker/maker.

This bug may result in protocol-view of affiliate referred volume being smaller than actual, potentially leading to lower than expected affiliate tier.

Test Plan

Unit test

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
- Introduced a new method to aggregate referred volumes for affiliates, improving efficiency in processing referrals.
Bug Fixes
- Enhanced testing coverage for the affiliate referral system with a new test case for aggregating referred volumes.

coderabbitai · 2024-12-05T20:25:19Z

Walkthrough

The changes introduce a new method, AggregateAffiliateReferredVolumeForFills, to the Keeper struct in keeper.go, which processes referred volumes for takers and makers using a caching mechanism to optimize address retrieval. Additionally, a new test case is added to keeper_test.go to validate the functionality of this method when the maker is registered as an affiliate, ensuring that the referred volume is correctly aggregated. The overall structure of the tests remains intact, enhancing coverage without altering existing tests.

Changes

File	Change Summary
`protocol/x/affiliates/keeper/keeper.go`	- Added method `AggregateAffiliateReferredVolumeForFills(ctx sdk.Context) error` to process referred volumes.
`protocol/x/affiliates/keeper/keeper_test.go`	- Introduced a new test case in `TestAggregateAffiliateReferredVolumeForFills` to check aggregation for makers and takers.

Possibly related PRs

[OTE-695] Aggregate referred volume in endblocker #2218: The AggregateAffiliateVolumeForFills method added in the main PR is related to the AggregateAffiliateReferredVolumeForFills method introduced in this PR, as both methods deal with aggregating affiliate volumes based on fills.
[OTE-687] Bump fee tiers for referees #2217: This PR enhances the Keeper struct's methods, which may interact with the new method AggregateAffiliateReferredVolumeForFills in terms of managing affiliate data.
[OTE-779] Check affiliate tiers are strictly increasing before updating tiers #2220: The changes in this PR regarding the validation of affiliate tiers could impact the logic in the main PR, as the new method relies on the existence of valid affiliate tiers.
[OTE-815] Update GetTierForAffiliates and MsgRegisterAffiliates to handle empty tiers #2302: The modifications to the RegisterAffiliate and GetTierForAffiliate functions in this PR ensure that operations dependent on affiliate tiers are safeguarded, which is relevant to the new method introduced in the main PR.
Update GetAllRevshare to handle liquidations #2413: The updates to the revenue sharing logic in this PR may relate to how the new aggregation methods in the main PR calculate and manage affiliate volumes.
add afflaiteReferredMakerRebates field to response #2473: The addition of the affiliateReferredMakerRebates field in the response structure may be relevant to the new aggregation logic introduced in the main PR, as it pertains to the handling of affiliate-related data.

Suggested labels

feature:x/affiliates

Suggested reviewers

affanv14

🐰 In the fields where affiliates play,
A new method hops in today!
With volumes aggregated right,
Takers and makers take flight.
Tests now cover every case,
In our code, we find our grace! 🌟

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.

coderabbitai

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

protocol/x/affiliates/keeper/keeper.go (1)
Line range hint 346-385: LGTM! Implementation correctly fixes the volume aggregation bug.

The new implementation properly handles the case where maker's volume should be counted towards affiliate's referred volume even when the taker isn't referred. The caching mechanism is also efficient.

Consider adding comments to explain the caching mechanism:
 func (k Keeper) AggregateAffiliateReferredVolumeForFills(
 	ctx sdk.Context,
 ) error {
 	blockStats := k.statsKeeper.GetBlockStats(ctx)
+	// Cache referred addresses to avoid repeated store lookups
 	referredByCache := make(map[string]string)

 	for _, fill := range blockStats.Fills {
+		// Process taker's referred volume independently of maker
 		referredByAddrTaker, cached := referredByCache[fill.Taker]
 		...
+		// Process maker's referred volume independently of taker
 		referredByAddrMaker, cached := referredByCache[fill.Maker]
 		...
 	}
 	return nil
 }

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fc51db9 and 9ab81cc.

📒 Files selected for processing (2)

protocol/x/affiliates/keeper/keeper.go (1 hunks)
protocol/x/affiliates/keeper/keeper_test.go (1 hunks)

🔇 Additional comments (1)

protocol/x/affiliates/keeper/keeper_test.go (1)

784-806: LGTM! Test case properly validates the bug fix.

The test case effectively verifies that maker's volume is correctly counted towards affiliate's referred volume even when takers aren't referred. The test setup and assertions are comprehensive.

teddyding · 2024-12-06T18:03:40Z

@Mergifyio backport release/protocol/v8.x

mergify · 2024-12-06T18:03:45Z

backport release/protocol/v8.x

✅ Backports have been created

#2624 fix(affiliates): Fix logic in affiliate referred volume aggregation (backport #2623) has been created for branch release/protocol/v8.x

…2623) (cherry picked from commit ab98dd4)

…backport #2623) (#2624) Co-authored-by: Teddy Ding <teddy@dydx.exchange>

teddyding · 2024-12-06T18:19:59Z

@Mergifyio backport release/protocol/v7.1.x

mergify · 2024-12-06T18:20:05Z

backport release/protocol/v7.1.x

✅ Backports have been created

#2625 fix(affiliates): Fix logic in affiliate referred volume aggregation (backport #2623) has been created for branch release/protocol/v7.1.x

…2623) (cherry picked from commit ab98dd4)

…backport #2623) (#2625) Co-authored-by: Teddy Ding <teddy@dydx.exchange>

Fix logic in affiliate referred volume aggregation

9ab81cc

github-actions bot added the protocol label Dec 5, 2024

teddyding marked this pull request as ready for review December 5, 2024 20:50

teddyding requested a review from a team as a code owner December 5, 2024 20:50

coderabbitai bot reviewed Dec 5, 2024

View reviewed changes

jayy04 approved these changes Dec 5, 2024

View reviewed changes

teddyding merged commit ab98dd4 into main Dec 6, 2024
22 checks passed

teddyding deleted the td/fix-affiliate-referred-volume branch December 6, 2024 17:25

mergify bot pushed a commit that referenced this pull request Dec 6, 2024

fix(affiliates): Fix logic in affiliate referred volume aggregation (#…

7cd11cf

…2623) (cherry picked from commit ab98dd4)

mergify bot mentioned this pull request Dec 6, 2024

fix(affiliates): Fix logic in affiliate referred volume aggregation (backport #2623) #2624

Merged

6 tasks

teddyding added a commit that referenced this pull request Dec 6, 2024

fix(affiliates): Fix logic in affiliate referred volume aggregation (…

2dfa399

…backport #2623) (#2624) Co-authored-by: Teddy Ding <teddy@dydx.exchange>

mergify bot pushed a commit that referenced this pull request Dec 6, 2024

fix(affiliates): Fix logic in affiliate referred volume aggregation (#…

54b9118

…2623) (cherry picked from commit ab98dd4)

mergify bot mentioned this pull request Dec 6, 2024

fix(affiliates): Fix logic in affiliate referred volume aggregation (backport #2623) #2625

Merged

6 tasks

teddyding added a commit that referenced this pull request Dec 9, 2024

fix(affiliates): Fix logic in affiliate referred volume aggregation (…

493a7ff

…backport #2623) (#2625) Co-authored-by: Teddy Ding <teddy@dydx.exchange>

coderabbitai bot mentioned this pull request Dec 10, 2024

fix(affiliates): Reject self referral in RegisterAffiliate #2637

Merged

6 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(affiliates): Fix logic in affiliate referred volume aggregation #2623

fix(affiliates): Fix logic in affiliate referred volume aggregation #2623

teddyding commented Dec 5, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 5, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

coderabbitai bot left a comment

teddyding commented Dec 6, 2024

mergify bot commented Dec 6, 2024 •

edited

Loading

teddyding commented Dec 6, 2024

mergify bot commented Dec 6, 2024 •

edited

Loading

fix(affiliates): Fix logic in affiliate referred volume aggregation #2623

fix(affiliates): Fix logic in affiliate referred volume aggregation #2623

Conversation

teddyding commented Dec 5, 2024 • edited by coderabbitai bot Loading

Changelist

Test Plan

Author/Reviewer Checklist

Summary by CodeRabbit

coderabbitai bot commented Dec 5, 2024 • edited Loading

Walkthrough

Changes

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

coderabbitai bot left a comment

Choose a reason for hiding this comment

teddyding commented Dec 6, 2024

mergify bot commented Dec 6, 2024 • edited Loading

✅ Backports have been created

teddyding commented Dec 6, 2024

mergify bot commented Dec 6, 2024 • edited Loading

✅ Backports have been created

teddyding commented Dec 5, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Dec 5, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

mergify bot commented Dec 6, 2024 •

edited

Loading

mergify bot commented Dec 6, 2024 •

edited

Loading