feat: social leaderboard opt out

[Bigshmow]

Description

Adds a way for users to opt out of the Top Traders leaderboard from within the app.

Reason: MetaMask previously had no in-app way for a user to remove their account's addresses from the Top Traders leaderboard. @metamask/social-controllers@2.4.0 added the optOutOfLeaderboard capability (messenger action SocialController:optOutOfLeaderboard); this PR wires it into the mobile UI.

Solution:

• Bumps @metamask/social-controllers from 2.3.1 → 2.4.0.
• Adds a Top Traders entry to the app Settings list (rendered after "Buy & sell crypto", gated by selectSocialLeaderboardEnabled).
• Adds a TopTradersSettings screen with an Opt out of leaderboard row.
• Adds a LeaderboardOptOutBottomSheet (composed from the design-system BottomSheet, mirroring the existing TradingSignalsSetupBottomSheet) that calls SocialController:optOutOfLeaderboard, showing a loading/disabled state, closing on success, and logging + recovering on failure.
• New routes SETTINGS.TOP_TRADERS and SOCIAL_LEADERBOARD.OPT_OUT with navigator registrations, param-list types, i18n strings, and testIDs.

Changelog

CHANGELOG entry: Added a Top Traders section in Settings that lets users opt out of the Top Traders leaderboard.

Related issues

Figma: https://www.figma.com/design/HzPB0InxHBY5hPkOukPCqv/Social?node-id=3017-31866&t=R8yrnl1Yo45ffgJO-4

Fixes: TSA-830

Manual testing steps

Feature: Opt out of the Top Traders leaderboard from Settings

  Scenario: user opts out of the leaderboard
    Given the Social Leaderboard feature flag is enabled
    And the user is on the Settings screen
    When the user taps "Top Traders"
    Then the Top Traders settings screen is shown with an "Opt out of leaderboard" option
    When the user taps "Opt out of leaderboard"
    Then a bottom sheet appears with the opt-out description and a confirm button
    When the user taps "Opt out of leaderboard" in the sheet
    Then the app calls SocialController:optOutOfLeaderboard
    And the sheet closes once the request succeeds

  Scenario: opt-out request fails
    Given the user has opened the opt-out bottom sheet
    When the user taps "Opt out of leaderboard"
    And the opt-out request fails
    Then the error is logged
    And the sheet stays open with the button re-enabled

  Scenario: leaderboard feature flag is disabled
    Given the Social Leaderboard feature flag is disabled
    When the user is on the Settings screen
    Then the "Top Traders" entry is not shown

Screenshots/Recordings

Before

After

Pre-merge author checklist

• I've followed MetaMask Contributor Docs and MetaMask Mobile Coding Standards.
• I've completed the PR template to the best of my ability
• I've included tests if applicable
• I've documented my code using JSDoc format if applicable
• I've applied the right labels on the PR (see labeling guidelines). Not required for external contributors.

Performance checks (if applicable)

• I've tested on Android
  • Ideally on a mid-range device; emulator is acceptable
• I've tested with a power user scenario
  • Use these power-user SRPs to import wallets with many accounts and tokens
• I've instrumented key operations with Sentry traces for production performance metrics
  • See trace() for usage and addToken for an example

For performance guidelines and tooling, see the Performance Guide.

Pre-merge reviewer checklist

• I've manually tested the PR (e.g. pull and build branch, run the app, test code being changed).
• I confirm that this PR addresses all acceptance criteria described in the ticket it closes and includes the necessary testing evidence such as recordings and or screenshots.

---

Note

Medium Risk
Changes public visibility of trading accounts via backend opt-in/out; risk is mitigated by feature flags, non-optimistic persistence, and tests, but still touches privacy-sensitive social settings.

Overview
Adds a Top Traders block on Security & privacy so users can control whether their account appears on the leaderboard, behind both aiSocialLeaderboardEnabled and the new aiSocialLeaderboardOptFlowEnabled remote flag.

Toggling calls SocialController:optInToLeaderboard / optOutOfLeaderboard (with SocialService actions delegated on the social controller messenger). Redux settings.showAccountOnLeaderboard is updated only after a successful backend response (default shown); failures are logged and the toggle stays unchanged. A new MetaMetrics opt-in event Trader Leaderboard Visibility Toggled fires on success, and the section is covered by unit tests plus i18n and feature-flag registry entries.

^{Reviewed by Cursor Bugbot for commit f2929c3. Bugbot is set up for automated code reviews on this repo. Configure here.}

[github-actions]

CLA Signature Action: All authors have signed the CLA. You may need to manually re-run the blocking PR check if it doesn't pass in a few minutes.

[joaosantos15]

There seems to be a bug when trying to change the state :/

[joaosantos15]

Approving to unblock the request for changes so that @aganglada and @zone-live can review

[zone-live]

One thing to add next in a follow-up PR is metrics, I'm sure Rizvi will want to know if users are doing the opt-out 👍🏼

[aganglada]

do we have the segment-schema PR prepared already?

[Bigshmow]

Yeah just pushed it: https://github.com/Consensys/segment-schema/pull/666

[cursor]

Cursor Bugbot has reviewed your changes and found 1 potential issue.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit ac2d297. Configure here.}

[github-actions]

🔍 Smart E2E Test Selection

• Selected E2E tags: SmokeWalletPlatform, SmokePerps
• Selected Performance tags: None (no tests recommended)
• Risk Level: low
• AI Confidence: 78%

click to see 🤖 AI reasoning details

E2E Test Selection:
This PR adds a new "Top Traders" leaderboard opt-in/opt-out toggle to the Security & Privacy Settings screen. Key observations:

1. Feature-gated: The new TopTradersSection component is gated by aiSocialLeaderboardOptFlowEnabled feature flag which defaults to false in production. This means the new UI won't appear in standard test runs unless the flag is explicitly enabled.

2. Additive changes: All changes are additive - new component, new Redux action/reducer field (with default value), new messenger actions, new analytics event, new feature flag registration. No existing functionality is modified.

3. SecuritySettings.tsx modified: The main Security Settings screen now imports and renders TopTradersSection. Since the component returns null when feature flags are disabled, this has minimal impact on existing tests.

4. Settings reducer: Added showAccountOnLeaderboard: true to initial state and a new reducer case. This is a shared reducer but the change is purely additive with a safe default.

5. Social controller messenger: Added two new allowed actions (SocialService:optOutOfLeaderboard, SocialService:optInToLeaderboard) - purely additive.

6. No existing smoke tests directly test the Security Settings screen with these new features (existing settings tests use RegressionWalletUX tag which is out of scope).

Tag selection rationale:

• SmokeWalletPlatform: Covers wallet platform features including settings-related flows, analytics tracking, and the social/trading ecosystem. The new feature is part of the social trading platform.
• SmokePerps: The leaderboard feature is directly related to the Perps/trading social features. The social controller messenger changes affect the same social service infrastructure used by Perps.

No performance tests are needed as these changes are UI/settings additions with no impact on app launch, asset loading, or other performance-sensitive flows.

Performance Test Selection:
The changes are purely additive UI/settings additions (new toggle in Security Settings, new Redux state, new messenger actions). None of these changes affect performance-sensitive flows like app launch, onboarding, login, asset loading, swaps, or account list rendering. The feature is also gated by a feature flag defaulting to false, further reducing any performance impact.

View GitHub Actions results

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
95.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud