fix(affiliates): Reject self referral in RegisterAffiliate

[teddyding]

Changelist

This is already prevented at indexer level, but updating protocol behavior to be consistent

Test Plan

Unit tests

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 error handling for self-referral during affiliate registration.
  • Added a new error message: "Self referral not allowed".

• Bug Fixes

  • Enhanced validation logic to prevent users from registering themselves as affiliates.

• Tests

  • Added a new test case to verify self-referral error handling in the affiliate registration process.

[coderabbitai]

Walkthrough

The changes in this pull request introduce a new error handling condition in the RegisterAffiliate method of the Keeper struct, preventing self-referrals by returning an error when the referee and affiliate addresses are identical. Additionally, a new error variable, ErrSelfReferral, is added to the types package to provide context for this error. A corresponding test case is also included to verify the self-referral scenario, enhancing the coverage of the RegisterAffiliate function.

Changes

File Path	Change Summary
protocol/x/affiliates/keeper/keeper.go	Added error handling in RegisterAffiliate to prevent self-referral by returning types.ErrSelfReferral.
protocol/x/affiliates/types/errors.go	Introduced new error variable ErrSelfReferral with the message "Self referral not allowed".
protocol/x/affiliates/keeper/keeper_test.go	Added new test case "Self referral" in TestRegisterAffiliate_GetReferredBy to check self-referral error.

Possibly related PRs

• [OTE-696] Emit register affiliate event on successful registration #2219: This PR introduces an event emission for successful affiliate registrations, which is directly related to the changes made in the RegisterAffiliate method of the main PR that adds error handling for self-referrals.
• Short-circuit RegisterAffiliate state read when address is invalid #2221: This PR modifies the RegisterAffiliate function to change the order of checks, which is relevant to the main PR's focus on enhancing the validation logic within the same method.
• [OTE-730] add test to check register affiliate auth #2235: This PR adds tests for the RegisterAffiliate function, specifically checking the authentication process, which complements the changes made in the main PR regarding error handling and validation.
• Check for invalid addresses in SetAffiliateWhitelist #2594: This PR enhances validation in the SetAffiliateWhitelist function, which is related to the overall affiliate management logic and error handling improvements seen in the main PR.
• fix(affiliates): Fix logic in affiliate referred volume aggregation #2623: This PR addresses the aggregation of referred volumes, which ties into the broader affiliate management functionality that the main PR's changes to the RegisterAffiliate method aim to improve.

Suggested labels

feature:indexer/affiliates

Suggested reviewers

• affanv14
• vincentwschau

🐇 In the meadow, I hop and play,
New rules for affiliates come today.
No self-referrals, that's the call,
With ErrSelfReferral, we stand tall.
Testing the path, we ensure it's right,
For a fair game, we’ll shine so bright! 🌟

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between c9f988b and 76283f4.

📒 Files selected for processing (3)

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

🔇 Additional comments (3)

protocol/x/affiliates/types/errors.go (1)

19-19: LGTM: Clear and well-structured error definition.

The new error variable is properly registered with a sequential error code and a clear error message.

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

64-69: LGTM: Well-implemented self-referral prevention.

The implementation:

1. Checks for self-referral before other validations
2. Provides clear error context by including both addresses
3. Aligns with the PR objective to prevent self-referrals at the protocol level

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

91-99: LGTM: Comprehensive test coverage for self-referral prevention.

The test case:

1. Properly verifies the self-referral error condition
2. Uses appropriate test data (same address for referee and affiliate)
3. Integrates well with the existing test suite

---

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

[teddyding]

@Mergifyio backport release/protocol/v8.x

[mergify]

backport release/protocol/v8.x

✅ Backports have been created

• #2638 fix(affiliates): Reject self referral in RegisterAffiliate (backport #2637) has been created for branch release/protocol/v8.x