@metamask/social-controllers 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0]
+
+### Added
+
+- Initial release ([#8321](https://github.com/MetaMask/core/pull/8321), [#8335](https://github.com/MetaMask/core/pull/8335), [#8337](https://github.com/MetaMask/core/pull/8337))
+  - Add `SocialService` data service wrapping social-api endpoints with superstruct response validation
+    - Add methods `fetchLeaderboard`, `fetchTraderProfile`, `fetchOpenPositions`, `fetchClosedPositions`, `fetchFollowers`, `fetchFollowing`, `follow`, `unfollow`
+  - Add `SocialController` extending `BaseController` with messenger actions for state management
+    - `updateLeaderboard` — fetches leaderboard and persists entries to state
+    - `followTrader` — follows traders and updates following addresses in state
+    - `unfollowTrader` — unfollows traders and removes addresses from state
+    - `updateFollowing` — fetches following list and replaces addresses in state
+
+[Unreleased]: https://github.com/MetaMask/core/compare/@metamask/social-controllers@0.1.0...HEAD
+[0.1.0]: https://github.com/MetaMask/core/releases/tag/@metamask/social-controllers@0.1.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2026 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,15 @@
+# `@metamask/social-controllers`
+
+A collection of social related controllers
+
+## Installation
+
+`yarn add @metamask/social-controllers`
+
+or
+
+`npm install @metamask/social-controllers`
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme).

package/dist/SocialController-method-action-types.cjs

@@ -0,0 +1,7 @@
+"use strict";
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=SocialController-method-action-types.cjs.map

package/dist/SocialController-method-action-types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocialController-method-action-types.cjs","sourceRoot":"","sources":["../src/SocialController-method-action-types.ts"],"names":[],"mappings":";AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { SocialController } from './SocialController';\n\n/**\n * Fetches the leaderboard and persists the entries to state.\n *\n * @param options - Optional leaderboard query parameters.\n * @returns The leaderboard response from the social-api.\n */\nexport type SocialControllerUpdateLeaderboardAction = {\n  type: `SocialController:updateLeaderboard`;\n  handler: SocialController['updateLeaderboard'];\n};\n\n/**\n * Follows one or more traders and updates the following list in state.\n *\n * @param options - Options bag.\n * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.\n * @param options.targets - Addresses or profile IDs to follow.\n * @returns The follow response with confirmed follows.\n */\nexport type SocialControllerFollowTraderAction = {\n  type: `SocialController:followTrader`;\n  handler: SocialController['followTrader'];\n};\n\n/**\n * Unfollows one or more traders and updates the following list in state.\n *\n * @param options - Options bag.\n * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.\n * @param options.targets - Addresses or profile IDs to unfollow.\n * @returns The unfollow response with confirmed unfollows.\n */\nexport type SocialControllerUnfollowTraderAction = {\n  type: `SocialController:unfollowTrader`;\n  handler: SocialController['unfollowTrader'];\n};\n\n/**\n * Fetches the list of traders the current user follows and replaces\n * the following addresses in state.\n *\n * @param options - Options bag.\n * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.\n * @returns The following response.\n */\nexport type SocialControllerUpdateFollowingAction = {\n  type: `SocialController:updateFollowing`;\n  handler: SocialController['updateFollowing'];\n};\n\n/**\n * Union of all SocialController action types.\n */\nexport type SocialControllerMethodActions =\n  | SocialControllerUpdateLeaderboardAction\n  | SocialControllerFollowTraderAction\n  | SocialControllerUnfollowTraderAction\n  | SocialControllerUpdateFollowingAction;\n"]}

package/dist/SocialController-method-action-types.d.cts

@@ -0,0 +1,56 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { SocialController } from "./SocialController.cjs";
+/**
+ * Fetches the leaderboard and persists the entries to state.
+ *
+ * @param options - Optional leaderboard query parameters.
+ * @returns The leaderboard response from the social-api.
+ */
+export type SocialControllerUpdateLeaderboardAction = {
+    type: `SocialController:updateLeaderboard`;
+    handler: SocialController['updateLeaderboard'];
+};
+/**
+ * Follows one or more traders and updates the following list in state.
+ *
+ * @param options - Options bag.
+ * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+ * @param options.targets - Addresses or profile IDs to follow.
+ * @returns The follow response with confirmed follows.
+ */
+export type SocialControllerFollowTraderAction = {
+    type: `SocialController:followTrader`;
+    handler: SocialController['followTrader'];
+};
+/**
+ * Unfollows one or more traders and updates the following list in state.
+ *
+ * @param options - Options bag.
+ * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+ * @param options.targets - Addresses or profile IDs to unfollow.
+ * @returns The unfollow response with confirmed unfollows.
+ */
+export type SocialControllerUnfollowTraderAction = {
+    type: `SocialController:unfollowTrader`;
+    handler: SocialController['unfollowTrader'];
+};
+/**
+ * Fetches the list of traders the current user follows and replaces
+ * the following addresses in state.
+ *
+ * @param options - Options bag.
+ * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+ * @returns The following response.
+ */
+export type SocialControllerUpdateFollowingAction = {
+    type: `SocialController:updateFollowing`;
+    handler: SocialController['updateFollowing'];
+};
+/**
+ * Union of all SocialController action types.
+ */
+export type SocialControllerMethodActions = SocialControllerUpdateLeaderboardAction | SocialControllerFollowTraderAction | SocialControllerUnfollowTraderAction | SocialControllerUpdateFollowingAction;
+//# sourceMappingURL=SocialController-method-action-types.d.cts.map

package/dist/SocialController-method-action-types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocialController-method-action-types.d.cts","sourceRoot":"","sources":["../src/SocialController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,+BAA2B;AAE3D;;;;;GAKG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,gBAAgB,CAAC,cAAc,CAAC,CAAC;CAC3C,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;CAC9C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACrC,uCAAuC,GACvC,kCAAkC,GAClC,oCAAoC,GACpC,qCAAqC,CAAC"}

package/dist/SocialController-method-action-types.d.mts

@@ -0,0 +1,56 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+import type { SocialController } from "./SocialController.mjs";
+/**
+ * Fetches the leaderboard and persists the entries to state.
+ *
+ * @param options - Optional leaderboard query parameters.
+ * @returns The leaderboard response from the social-api.
+ */
+export type SocialControllerUpdateLeaderboardAction = {
+    type: `SocialController:updateLeaderboard`;
+    handler: SocialController['updateLeaderboard'];
+};
+/**
+ * Follows one or more traders and updates the following list in state.
+ *
+ * @param options - Options bag.
+ * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+ * @param options.targets - Addresses or profile IDs to follow.
+ * @returns The follow response with confirmed follows.
+ */
+export type SocialControllerFollowTraderAction = {
+    type: `SocialController:followTrader`;
+    handler: SocialController['followTrader'];
+};
+/**
+ * Unfollows one or more traders and updates the following list in state.
+ *
+ * @param options - Options bag.
+ * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+ * @param options.targets - Addresses or profile IDs to unfollow.
+ * @returns The unfollow response with confirmed unfollows.
+ */
+export type SocialControllerUnfollowTraderAction = {
+    type: `SocialController:unfollowTrader`;
+    handler: SocialController['unfollowTrader'];
+};
+/**
+ * Fetches the list of traders the current user follows and replaces
+ * the following addresses in state.
+ *
+ * @param options - Options bag.
+ * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+ * @returns The following response.
+ */
+export type SocialControllerUpdateFollowingAction = {
+    type: `SocialController:updateFollowing`;
+    handler: SocialController['updateFollowing'];
+};
+/**
+ * Union of all SocialController action types.
+ */
+export type SocialControllerMethodActions = SocialControllerUpdateLeaderboardAction | SocialControllerFollowTraderAction | SocialControllerUnfollowTraderAction | SocialControllerUpdateFollowingAction;
+//# sourceMappingURL=SocialController-method-action-types.d.mts.map

package/dist/SocialController-method-action-types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocialController-method-action-types.d.mts","sourceRoot":"","sources":["../src/SocialController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AAEH,OAAO,KAAK,EAAE,gBAAgB,EAAE,+BAA2B;AAE3D;;;;;GAKG;AACH,MAAM,MAAM,uCAAuC,GAAG;IACpD,IAAI,EAAE,oCAAoC,CAAC;IAC3C,OAAO,EAAE,gBAAgB,CAAC,mBAAmB,CAAC,CAAC;CAChD,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,kCAAkC,GAAG;IAC/C,IAAI,EAAE,+BAA+B,CAAC;IACtC,OAAO,EAAE,gBAAgB,CAAC,cAAc,CAAC,CAAC;CAC3C,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,oCAAoC,GAAG;IACjD,IAAI,EAAE,iCAAiC,CAAC;IACxC,OAAO,EAAE,gBAAgB,CAAC,gBAAgB,CAAC,CAAC;CAC7C,CAAC;AAEF;;;;;;;GAOG;AACH,MAAM,MAAM,qCAAqC,GAAG;IAClD,IAAI,EAAE,kCAAkC,CAAC;IACzC,OAAO,EAAE,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;CAC9C,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,6BAA6B,GACrC,uCAAuC,GACvC,kCAAkC,GAClC,oCAAoC,GACpC,qCAAqC,CAAC"}

package/dist/SocialController-method-action-types.mjs

@@ -0,0 +1,6 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+export {};
+//# sourceMappingURL=SocialController-method-action-types.mjs.map

package/dist/SocialController-method-action-types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocialController-method-action-types.mjs","sourceRoot":"","sources":["../src/SocialController-method-action-types.ts"],"names":[],"mappings":"AAAA;;;GAGG","sourcesContent":["/**\n * This file is auto generated.\n * Do not edit manually.\n */\n\nimport type { SocialController } from './SocialController';\n\n/**\n * Fetches the leaderboard and persists the entries to state.\n *\n * @param options - Optional leaderboard query parameters.\n * @returns The leaderboard response from the social-api.\n */\nexport type SocialControllerUpdateLeaderboardAction = {\n  type: `SocialController:updateLeaderboard`;\n  handler: SocialController['updateLeaderboard'];\n};\n\n/**\n * Follows one or more traders and updates the following list in state.\n *\n * @param options - Options bag.\n * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.\n * @param options.targets - Addresses or profile IDs to follow.\n * @returns The follow response with confirmed follows.\n */\nexport type SocialControllerFollowTraderAction = {\n  type: `SocialController:followTrader`;\n  handler: SocialController['followTrader'];\n};\n\n/**\n * Unfollows one or more traders and updates the following list in state.\n *\n * @param options - Options bag.\n * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.\n * @param options.targets - Addresses or profile IDs to unfollow.\n * @returns The unfollow response with confirmed unfollows.\n */\nexport type SocialControllerUnfollowTraderAction = {\n  type: `SocialController:unfollowTrader`;\n  handler: SocialController['unfollowTrader'];\n};\n\n/**\n * Fetches the list of traders the current user follows and replaces\n * the following addresses in state.\n *\n * @param options - Options bag.\n * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.\n * @returns The following response.\n */\nexport type SocialControllerUpdateFollowingAction = {\n  type: `SocialController:updateFollowing`;\n  handler: SocialController['updateFollowing'];\n};\n\n/**\n * Union of all SocialController action types.\n */\nexport type SocialControllerMethodActions =\n  | SocialControllerUpdateLeaderboardAction\n  | SocialControllerFollowTraderAction\n  | SocialControllerUnfollowTraderAction\n  | SocialControllerUpdateFollowingAction;\n"]}

package/dist/SocialController.cjs

@@ -0,0 +1,129 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SocialController = exports.getDefaultSocialControllerState = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const social_constants_1 = require("./social-constants.cjs");
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = [
+    'updateLeaderboard',
+    'followTrader',
+    'unfollowTrader',
+    'updateFollowing',
+];
+// === DEFAULT STATE ===
+/**
+ * Returns the default state for the SocialController.
+ *
+ * @returns A fresh default state object.
+ */
+function getDefaultSocialControllerState() {
+    return {
+        leaderboardEntries: [],
+        followingAddresses: [],
+    };
+}
+exports.getDefaultSocialControllerState = getDefaultSocialControllerState;
+// === STATE METADATA ===
+const socialControllerMetadata = {
+    leaderboardEntries: {
+        persist: true,
+        includeInDebugSnapshot: false,
+        includeInStateLogs: false,
+        usedInUi: true,
+    },
+    followingAddresses: {
+        persist: true,
+        includeInDebugSnapshot: false,
+        includeInStateLogs: false,
+        usedInUi: true,
+    },
+};
+// === CONTROLLER ===
+/**
+ * Controller that manages social trading state for the extension UI.
+ *
+ * Acts as a simple store with no TTL or eviction — the UI decides when
+ * to re-fetch, and the social-api's own cache layer handles upstream
+ * rate-limiting. State is persisted across sessions so the UI can render
+ * immediately on startup while a fresh fetch is in flight.
+ */
+class SocialController extends base_controller_1.BaseController {
+    constructor({ messenger, state }) {
+        super({
+            name: social_constants_1.controllerName,
+            metadata: socialControllerMetadata,
+            state: {
+                ...getDefaultSocialControllerState(),
+                ...state,
+            },
+            messenger,
+        });
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Fetches the leaderboard and persists the entries to state.
+     *
+     * @param options - Optional leaderboard query parameters.
+     * @returns The leaderboard response from the social-api.
+     */
+    async updateLeaderboard(options) {
+        const leaderboardResponse = await this.messenger.call('SocialService:fetchLeaderboard', options);
+        this.update((state) => {
+            state.leaderboardEntries = leaderboardResponse.traders;
+        });
+        return leaderboardResponse;
+    }
+    /**
+     * Follows one or more traders and updates the following list in state.
+     *
+     * @param options - Options bag.
+     * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+     * @param options.targets - Addresses or profile IDs to follow.
+     * @returns The follow response with confirmed follows.
+     */
+    async followTrader(options) {
+        const followResponse = await this.messenger.call('SocialService:follow', options);
+        const newAddresses = [
+            ...new Set(followResponse.followed.map((profile) => profile.address)),
+        ];
+        this.update((state) => {
+            const existing = new Set(state.followingAddresses);
+            const uniqueNewAddresses = newAddresses.filter((address) => !existing.has(address));
+            state.followingAddresses.push(...uniqueNewAddresses);
+        });
+        return followResponse;
+    }
+    /**
+     * Unfollows one or more traders and updates the following list in state.
+     *
+     * @param options - Options bag.
+     * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+     * @param options.targets - Addresses or profile IDs to unfollow.
+     * @returns The unfollow response with confirmed unfollows.
+     */
+    async unfollowTrader(options) {
+        const unfollowResponse = await this.messenger.call('SocialService:unfollow', options);
+        const removedAddresses = new Set(unfollowResponse.unfollowed.map((profile) => profile.address));
+        this.update((state) => {
+            state.followingAddresses = state.followingAddresses.filter((address) => !removedAddresses.has(address));
+        });
+        return unfollowResponse;
+    }
+    /**
+     * Fetches the list of traders the current user follows and replaces
+     * the following addresses in state.
+     *
+     * @param options - Options bag.
+     * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+     * @returns The following response.
+     */
+    async updateFollowing(options) {
+        const followingResponse = await this.messenger.call('SocialService:fetchFollowing', options);
+        this.update((state) => {
+            state.followingAddresses = followingResponse.following.map((profile) => profile.address);
+        });
+        return followingResponse;
+    }
+}
+exports.SocialController = SocialController;
+//# sourceMappingURL=SocialController.cjs.map

package/dist/SocialController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocialController.cjs","sourceRoot":"","sources":["../src/SocialController.ts"],"names":[],"mappings":";;;AAKA,+DAA2D;AAG3D,6DAAoD;AAoBpD,oBAAoB;AAEpB,MAAM,yBAAyB,GAAG;IAChC,mBAAmB;IACnB,cAAc;IACd,gBAAgB;IAChB,iBAAiB;CACT,CAAC;AA+CX,wBAAwB;AAExB;;;;GAIG;AACH,SAAgB,+BAA+B;IAC7C,OAAO;QACL,kBAAkB,EAAE,EAAE;QACtB,kBAAkB,EAAE,EAAE;KACvB,CAAC;AACJ,CAAC;AALD,0EAKC;AAED,yBAAyB;AAEzB,MAAM,wBAAwB,GAAyC;IACrE,kBAAkB,EAAE;QAClB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,kBAAkB,EAAE,KAAK;QACzB,QAAQ,EAAE,IAAI;KACf;IACD,kBAAkB,EAAE;QAClB,OAAO,EAAE,IAAI;QACb,sBAAsB,EAAE,KAAK;QAC7B,kBAAkB,EAAE,KAAK;QACzB,QAAQ,EAAE,IAAI;KACf;CACF,CAAC;AAEF,qBAAqB;AAErB;;;;;;;GAOG;AACH,MAAa,gBAAiB,SAAQ,gCAIrC;IACC,YAAY,EAAE,SAAS,EAAE,KAAK,EAA2B;QACvD,KAAK,CAAC;YACJ,IAAI,EAAE,iCAAc;YACpB,QAAQ,EAAE,wBAAwB;YAClC,KAAK,EAAE;gBACL,GAAG,+BAA+B,EAAE;gBACpC,GAAG,KAAK;aACT;YACD,SAAS;SACV,CAAC,CAAC;QAEH,IAAI,CAAC,SAAS,CAAC,4BAA4B,CACzC,IAAI,EACJ,yBAAyB,CAC1B,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,iBAAiB,CACrB,OAAiC;QAEjC,MAAM,mBAAmB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACnD,gCAAgC,EAChC,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,kBAAkB,GAAG,mBAAmB,CAAC,OAAO,CAAC;QACzD,CAAC,CAAC,CAAC;QAEH,OAAO,mBAAmB,CAAC;IAC7B,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,YAAY,CAAC,OAAsB;QACvC,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAC9C,sBAAsB,EACtB,OAAO,CACR,CAAC;QAEF,MAAM,YAAY,GAAG;YACnB,GAAG,IAAI,GAAG,CAAC,cAAc,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;SACtE,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,MAAM,QAAQ,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,kBAAkB,CAAC,CAAC;YACnD,MAAM,kBAAkB,GAAG,YAAY,CAAC,MAAM,CAC5C,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CACpC,CAAC;YACF,KAAK,CAAC,kBAAkB,CAAC,IAAI,CAAC,GAAG,kBAAkB,CAAC,CAAC;QACvD,CAAC,CAAC,CAAC;QAEH,OAAO,cAAc,CAAC;IACxB,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,cAAc,CAAC,OAAwB;QAC3C,MAAM,gBAAgB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CAChD,wBAAwB,EACxB,OAAO,CACR,CAAC;QAEF,MAAM,gBAAgB,GAAG,IAAI,GAAG,CAC9B,gBAAgB,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAAC,CAC9D,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,kBAAkB,GAAG,KAAK,CAAC,kBAAkB,CAAC,MAAM,CACxD,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,gBAAgB,CAAC,GAAG,CAAC,OAAO,CAAC,CAC5C,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,gBAAgB,CAAC;IAC1B,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,eAAe,CACnB,OAA8B;QAE9B,MAAM,iBAAiB,GAAG,MAAM,IAAI,CAAC,SAAS,CAAC,IAAI,CACjD,8BAA8B,EAC9B,OAAO,CACR,CAAC;QAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,kBAAkB,GAAG,iBAAiB,CAAC,SAAS,CAAC,GAAG,CACxD,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,CAAC,OAAO,CAC7B,CAAC;QACJ,CAAC,CAAC,CAAC;QAEH,OAAO,iBAAiB,CAAC;IAC3B,CAAC;CACF;AA3HD,4CA2HC","sourcesContent":["import type {\n  ControllerGetStateAction,\n  ControllerStateChangeEvent,\n  StateMetadata,\n} from '@metamask/base-controller';\nimport { BaseController } from '@metamask/base-controller';\nimport type { Messenger } from '@metamask/messenger';\n\nimport { controllerName } from './social-constants';\nimport type {\n  FetchFollowingOptions,\n  FetchLeaderboardOptions,\n  FollowOptions,\n  FollowResponse,\n  FollowingResponse,\n  LeaderboardResponse,\n  SocialControllerState,\n  UnfollowOptions,\n  UnfollowResponse,\n} from './social-types';\nimport type { SocialControllerMethodActions } from './SocialController-method-action-types';\nimport type {\n  SocialServiceFetchFollowingAction,\n  SocialServiceFetchLeaderboardAction,\n  SocialServiceFollowAction,\n  SocialServiceUnfollowAction,\n} from './SocialService-method-action-types';\n\n// === MESSENGER ===\n\nconst MESSENGER_EXPOSED_METHODS = [\n  'updateLeaderboard',\n  'followTrader',\n  'unfollowTrader',\n  'updateFollowing',\n] as const;\n\n// === ACTION TYPES ===\n\nexport type SocialControllerGetStateAction = ControllerGetStateAction<\n  typeof controllerName,\n  SocialControllerState\n>;\n\nexport type SocialControllerActions =\n  | SocialControllerGetStateAction\n  | SocialControllerMethodActions;\n\n// === EVENT TYPES ===\n\nexport type SocialControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof controllerName,\n  SocialControllerState\n>;\n\nexport type SocialControllerEvents = SocialControllerStateChangeEvent;\n\n// === ALLOWED ACTIONS/EVENTS ===\n\ntype AllowedActions =\n  | SocialServiceFetchLeaderboardAction\n  | SocialServiceFollowAction\n  | SocialServiceUnfollowAction\n  | SocialServiceFetchFollowingAction;\n\ntype AllowedEvents = never;\n\n// === MESSENGER TYPE ===\n\nexport type SocialControllerMessenger = Messenger<\n  typeof controllerName,\n  SocialControllerActions | AllowedActions,\n  SocialControllerEvents | AllowedEvents\n>;\n\n// === OPTIONS ===\n\nexport type SocialControllerOptions = {\n  messenger: SocialControllerMessenger;\n  state?: Partial<SocialControllerState>;\n};\n\n// === DEFAULT STATE ===\n\n/**\n * Returns the default state for the SocialController.\n *\n * @returns A fresh default state object.\n */\nexport function getDefaultSocialControllerState(): SocialControllerState {\n  return {\n    leaderboardEntries: [],\n    followingAddresses: [],\n  };\n}\n\n// === STATE METADATA ===\n\nconst socialControllerMetadata: StateMetadata<SocialControllerState> = {\n  leaderboardEntries: {\n    persist: true,\n    includeInDebugSnapshot: false,\n    includeInStateLogs: false,\n    usedInUi: true,\n  },\n  followingAddresses: {\n    persist: true,\n    includeInDebugSnapshot: false,\n    includeInStateLogs: false,\n    usedInUi: true,\n  },\n};\n\n// === CONTROLLER ===\n\n/**\n * Controller that manages social trading state for the extension UI.\n *\n * Acts as a simple store with no TTL or eviction — the UI decides when\n * to re-fetch, and the social-api's own cache layer handles upstream\n * rate-limiting. State is persisted across sessions so the UI can render\n * immediately on startup while a fresh fetch is in flight.\n */\nexport class SocialController extends BaseController<\n  typeof controllerName,\n  SocialControllerState,\n  SocialControllerMessenger\n> {\n  constructor({ messenger, state }: SocialControllerOptions) {\n    super({\n      name: controllerName,\n      metadata: socialControllerMetadata,\n      state: {\n        ...getDefaultSocialControllerState(),\n        ...state,\n      },\n      messenger,\n    });\n\n    this.messenger.registerMethodActionHandlers(\n      this,\n      MESSENGER_EXPOSED_METHODS,\n    );\n  }\n\n  /**\n   * Fetches the leaderboard and persists the entries to state.\n   *\n   * @param options - Optional leaderboard query parameters.\n   * @returns The leaderboard response from the social-api.\n   */\n  async updateLeaderboard(\n    options?: FetchLeaderboardOptions,\n  ): Promise<LeaderboardResponse> {\n    const leaderboardResponse = await this.messenger.call(\n      'SocialService:fetchLeaderboard',\n      options,\n    );\n\n    this.update((state) => {\n      state.leaderboardEntries = leaderboardResponse.traders;\n    });\n\n    return leaderboardResponse;\n  }\n\n  /**\n   * Follows one or more traders and updates the following list in state.\n   *\n   * @param options - Options bag.\n   * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.\n   * @param options.targets - Addresses or profile IDs to follow.\n   * @returns The follow response with confirmed follows.\n   */\n  async followTrader(options: FollowOptions): Promise<FollowResponse> {\n    const followResponse = await this.messenger.call(\n      'SocialService:follow',\n      options,\n    );\n\n    const newAddresses = [\n      ...new Set(followResponse.followed.map((profile) => profile.address)),\n    ];\n\n    this.update((state) => {\n      const existing = new Set(state.followingAddresses);\n      const uniqueNewAddresses = newAddresses.filter(\n        (address) => !existing.has(address),\n      );\n      state.followingAddresses.push(...uniqueNewAddresses);\n    });\n\n    return followResponse;\n  }\n\n  /**\n   * Unfollows one or more traders and updates the following list in state.\n   *\n   * @param options - Options bag.\n   * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.\n   * @param options.targets - Addresses or profile IDs to unfollow.\n   * @returns The unfollow response with confirmed unfollows.\n   */\n  async unfollowTrader(options: UnfollowOptions): Promise<UnfollowResponse> {\n    const unfollowResponse = await this.messenger.call(\n      'SocialService:unfollow',\n      options,\n    );\n\n    const removedAddresses = new Set(\n      unfollowResponse.unfollowed.map((profile) => profile.address),\n    );\n\n    this.update((state) => {\n      state.followingAddresses = state.followingAddresses.filter(\n        (address) => !removedAddresses.has(address),\n      );\n    });\n\n    return unfollowResponse;\n  }\n\n  /**\n   * Fetches the list of traders the current user follows and replaces\n   * the following addresses in state.\n   *\n   * @param options - Options bag.\n   * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.\n   * @returns The following response.\n   */\n  async updateFollowing(\n    options: FetchFollowingOptions,\n  ): Promise<FollowingResponse> {\n    const followingResponse = await this.messenger.call(\n      'SocialService:fetchFollowing',\n      options,\n    );\n\n    this.update((state) => {\n      state.followingAddresses = followingResponse.following.map(\n        (profile) => profile.address,\n      );\n    });\n\n    return followingResponse;\n  }\n}\n"]}

package/dist/SocialController.d.cts

@@ -0,0 +1,71 @@
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { Messenger } from "@metamask/messenger";
+import { controllerName } from "./social-constants.cjs";
+import type { FetchFollowingOptions, FetchLeaderboardOptions, FollowOptions, FollowResponse, FollowingResponse, LeaderboardResponse, SocialControllerState, UnfollowOptions, UnfollowResponse } from "./social-types.cjs";
+import type { SocialControllerMethodActions } from "./SocialController-method-action-types.cjs";
+import type { SocialServiceFetchFollowingAction, SocialServiceFetchLeaderboardAction, SocialServiceFollowAction, SocialServiceUnfollowAction } from "./SocialService-method-action-types.cjs";
+export type SocialControllerGetStateAction = ControllerGetStateAction<typeof controllerName, SocialControllerState>;
+export type SocialControllerActions = SocialControllerGetStateAction | SocialControllerMethodActions;
+export type SocialControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, SocialControllerState>;
+export type SocialControllerEvents = SocialControllerStateChangeEvent;
+type AllowedActions = SocialServiceFetchLeaderboardAction | SocialServiceFollowAction | SocialServiceUnfollowAction | SocialServiceFetchFollowingAction;
+type AllowedEvents = never;
+export type SocialControllerMessenger = Messenger<typeof controllerName, SocialControllerActions | AllowedActions, SocialControllerEvents | AllowedEvents>;
+export type SocialControllerOptions = {
+    messenger: SocialControllerMessenger;
+    state?: Partial<SocialControllerState>;
+};
+/**
+ * Returns the default state for the SocialController.
+ *
+ * @returns A fresh default state object.
+ */
+export declare function getDefaultSocialControllerState(): SocialControllerState;
+/**
+ * Controller that manages social trading state for the extension UI.
+ *
+ * Acts as a simple store with no TTL or eviction — the UI decides when
+ * to re-fetch, and the social-api's own cache layer handles upstream
+ * rate-limiting. State is persisted across sessions so the UI can render
+ * immediately on startup while a fresh fetch is in flight.
+ */
+export declare class SocialController extends BaseController<typeof controllerName, SocialControllerState, SocialControllerMessenger> {
+    constructor({ messenger, state }: SocialControllerOptions);
+    /**
+     * Fetches the leaderboard and persists the entries to state.
+     *
+     * @param options - Optional leaderboard query parameters.
+     * @returns The leaderboard response from the social-api.
+     */
+    updateLeaderboard(options?: FetchLeaderboardOptions): Promise<LeaderboardResponse>;
+    /**
+     * Follows one or more traders and updates the following list in state.
+     *
+     * @param options - Options bag.
+     * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+     * @param options.targets - Addresses or profile IDs to follow.
+     * @returns The follow response with confirmed follows.
+     */
+    followTrader(options: FollowOptions): Promise<FollowResponse>;
+    /**
+     * Unfollows one or more traders and updates the following list in state.
+     *
+     * @param options - Options bag.
+     * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+     * @param options.targets - Addresses or profile IDs to unfollow.
+     * @returns The unfollow response with confirmed unfollows.
+     */
+    unfollowTrader(options: UnfollowOptions): Promise<UnfollowResponse>;
+    /**
+     * Fetches the list of traders the current user follows and replaces
+     * the following addresses in state.
+     *
+     * @param options - Options bag.
+     * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+     * @returns The following response.
+     */
+    updateFollowing(options: FetchFollowingOptions): Promise<FollowingResponse>;
+}
+export {};
+//# sourceMappingURL=SocialController.d.cts.map

package/dist/SocialController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocialController.d.cts","sourceRoot":"","sources":["../src/SocialController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,EAAE,cAAc,EAAE,+BAA2B;AACpD,OAAO,KAAK,EACV,qBAAqB,EACrB,uBAAuB,EACvB,aAAa,EACb,cAAc,EACd,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,EACf,gBAAgB,EACjB,2BAAuB;AACxB,OAAO,KAAK,EAAE,6BAA6B,EAAE,mDAA+C;AAC5F,OAAO,KAAK,EACV,iCAAiC,EACjC,mCAAmC,EACnC,yBAAyB,EACzB,2BAA2B,EAC5B,gDAA4C;AAa7C,MAAM,MAAM,8BAA8B,GAAG,wBAAwB,CACnE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAC/B,8BAA8B,GAC9B,6BAA6B,CAAC;AAIlC,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,gCAAgC,CAAC;AAItE,KAAK,cAAc,GACf,mCAAmC,GACnC,yBAAyB,GACzB,2BAA2B,GAC3B,iCAAiC,CAAC;AAEtC,KAAK,aAAa,GAAG,KAAK,CAAC;AAI3B,MAAM,MAAM,yBAAyB,GAAG,SAAS,CAC/C,OAAO,cAAc,EACrB,uBAAuB,GAAG,cAAc,EACxC,sBAAsB,GAAG,aAAa,CACvC,CAAC;AAIF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,yBAAyB,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;CACxC,CAAC;AAIF;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAKvE;AAqBD;;;;;;;GAOG;AACH,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,cAAc,EACrB,qBAAqB,EACrB,yBAAyB,CAC1B;gBACa,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,uBAAuB;IAiBzD;;;;;OAKG;IACG,iBAAiB,CACrB,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,mBAAmB,CAAC;IAa/B;;;;;;;OAOG;IACG,YAAY,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAqBnE;;;;;;;OAOG;IACG,cAAc,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAmBzE;;;;;;;OAOG;IACG,eAAe,CACnB,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;CAc9B"}

package/dist/SocialController.d.mts

@@ -0,0 +1,71 @@
+import type { ControllerGetStateAction, ControllerStateChangeEvent } from "@metamask/base-controller";
+import { BaseController } from "@metamask/base-controller";
+import type { Messenger } from "@metamask/messenger";
+import { controllerName } from "./social-constants.mjs";
+import type { FetchFollowingOptions, FetchLeaderboardOptions, FollowOptions, FollowResponse, FollowingResponse, LeaderboardResponse, SocialControllerState, UnfollowOptions, UnfollowResponse } from "./social-types.mjs";
+import type { SocialControllerMethodActions } from "./SocialController-method-action-types.mjs";
+import type { SocialServiceFetchFollowingAction, SocialServiceFetchLeaderboardAction, SocialServiceFollowAction, SocialServiceUnfollowAction } from "./SocialService-method-action-types.mjs";
+export type SocialControllerGetStateAction = ControllerGetStateAction<typeof controllerName, SocialControllerState>;
+export type SocialControllerActions = SocialControllerGetStateAction | SocialControllerMethodActions;
+export type SocialControllerStateChangeEvent = ControllerStateChangeEvent<typeof controllerName, SocialControllerState>;
+export type SocialControllerEvents = SocialControllerStateChangeEvent;
+type AllowedActions = SocialServiceFetchLeaderboardAction | SocialServiceFollowAction | SocialServiceUnfollowAction | SocialServiceFetchFollowingAction;
+type AllowedEvents = never;
+export type SocialControllerMessenger = Messenger<typeof controllerName, SocialControllerActions | AllowedActions, SocialControllerEvents | AllowedEvents>;
+export type SocialControllerOptions = {
+    messenger: SocialControllerMessenger;
+    state?: Partial<SocialControllerState>;
+};
+/**
+ * Returns the default state for the SocialController.
+ *
+ * @returns A fresh default state object.
+ */
+export declare function getDefaultSocialControllerState(): SocialControllerState;
+/**
+ * Controller that manages social trading state for the extension UI.
+ *
+ * Acts as a simple store with no TTL or eviction — the UI decides when
+ * to re-fetch, and the social-api's own cache layer handles upstream
+ * rate-limiting. State is persisted across sessions so the UI can render
+ * immediately on startup while a fresh fetch is in flight.
+ */
+export declare class SocialController extends BaseController<typeof controllerName, SocialControllerState, SocialControllerMessenger> {
+    constructor({ messenger, state }: SocialControllerOptions);
+    /**
+     * Fetches the leaderboard and persists the entries to state.
+     *
+     * @param options - Optional leaderboard query parameters.
+     * @returns The leaderboard response from the social-api.
+     */
+    updateLeaderboard(options?: FetchLeaderboardOptions): Promise<LeaderboardResponse>;
+    /**
+     * Follows one or more traders and updates the following list in state.
+     *
+     * @param options - Options bag.
+     * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+     * @param options.targets - Addresses or profile IDs to follow.
+     * @returns The follow response with confirmed follows.
+     */
+    followTrader(options: FollowOptions): Promise<FollowResponse>;
+    /**
+     * Unfollows one or more traders and updates the following list in state.
+     *
+     * @param options - Options bag.
+     * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+     * @param options.targets - Addresses or profile IDs to unfollow.
+     * @returns The unfollow response with confirmed unfollows.
+     */
+    unfollowTrader(options: UnfollowOptions): Promise<UnfollowResponse>;
+    /**
+     * Fetches the list of traders the current user follows and replaces
+     * the following addresses in state.
+     *
+     * @param options - Options bag.
+     * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+     * @returns The following response.
+     */
+    updateFollowing(options: FetchFollowingOptions): Promise<FollowingResponse>;
+}
+export {};
+//# sourceMappingURL=SocialController.d.mts.map

package/dist/SocialController.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SocialController.d.mts","sourceRoot":"","sources":["../src/SocialController.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,0BAA0B,EAE3B,kCAAkC;AACnC,OAAO,EAAE,cAAc,EAAE,kCAAkC;AAC3D,OAAO,KAAK,EAAE,SAAS,EAAE,4BAA4B;AAErD,OAAO,EAAE,cAAc,EAAE,+BAA2B;AACpD,OAAO,KAAK,EACV,qBAAqB,EACrB,uBAAuB,EACvB,aAAa,EACb,cAAc,EACd,iBAAiB,EACjB,mBAAmB,EACnB,qBAAqB,EACrB,eAAe,EACf,gBAAgB,EACjB,2BAAuB;AACxB,OAAO,KAAK,EAAE,6BAA6B,EAAE,mDAA+C;AAC5F,OAAO,KAAK,EACV,iCAAiC,EACjC,mCAAmC,EACnC,yBAAyB,EACzB,2BAA2B,EAC5B,gDAA4C;AAa7C,MAAM,MAAM,8BAA8B,GAAG,wBAAwB,CACnE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF,MAAM,MAAM,uBAAuB,GAC/B,8BAA8B,GAC9B,6BAA6B,CAAC;AAIlC,MAAM,MAAM,gCAAgC,GAAG,0BAA0B,CACvE,OAAO,cAAc,EACrB,qBAAqB,CACtB,CAAC;AAEF,MAAM,MAAM,sBAAsB,GAAG,gCAAgC,CAAC;AAItE,KAAK,cAAc,GACf,mCAAmC,GACnC,yBAAyB,GACzB,2BAA2B,GAC3B,iCAAiC,CAAC;AAEtC,KAAK,aAAa,GAAG,KAAK,CAAC;AAI3B,MAAM,MAAM,yBAAyB,GAAG,SAAS,CAC/C,OAAO,cAAc,EACrB,uBAAuB,GAAG,cAAc,EACxC,sBAAsB,GAAG,aAAa,CACvC,CAAC;AAIF,MAAM,MAAM,uBAAuB,GAAG;IACpC,SAAS,EAAE,yBAAyB,CAAC;IACrC,KAAK,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;CACxC,CAAC;AAIF;;;;GAIG;AACH,wBAAgB,+BAA+B,IAAI,qBAAqB,CAKvE;AAqBD;;;;;;;GAOG;AACH,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,OAAO,cAAc,EACrB,qBAAqB,EACrB,yBAAyB,CAC1B;gBACa,EAAE,SAAS,EAAE,KAAK,EAAE,EAAE,uBAAuB;IAiBzD;;;;;OAKG;IACG,iBAAiB,CACrB,OAAO,CAAC,EAAE,uBAAuB,GAChC,OAAO,CAAC,mBAAmB,CAAC;IAa/B;;;;;;;OAOG;IACG,YAAY,CAAC,OAAO,EAAE,aAAa,GAAG,OAAO,CAAC,cAAc,CAAC;IAqBnE;;;;;;;OAOG;IACG,cAAc,CAAC,OAAO,EAAE,eAAe,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAmBzE;;;;;;;OAOG;IACG,eAAe,CACnB,OAAO,EAAE,qBAAqB,GAC7B,OAAO,CAAC,iBAAiB,CAAC;CAc9B"}

package/dist/SocialController.mjs

@@ -0,0 +1,124 @@
+import { BaseController } from "@metamask/base-controller";
+import { controllerName } from "./social-constants.mjs";
+// === MESSENGER ===
+const MESSENGER_EXPOSED_METHODS = [
+    'updateLeaderboard',
+    'followTrader',
+    'unfollowTrader',
+    'updateFollowing',
+];
+// === DEFAULT STATE ===
+/**
+ * Returns the default state for the SocialController.
+ *
+ * @returns A fresh default state object.
+ */
+export function getDefaultSocialControllerState() {
+    return {
+        leaderboardEntries: [],
+        followingAddresses: [],
+    };
+}
+// === STATE METADATA ===
+const socialControllerMetadata = {
+    leaderboardEntries: {
+        persist: true,
+        includeInDebugSnapshot: false,
+        includeInStateLogs: false,
+        usedInUi: true,
+    },
+    followingAddresses: {
+        persist: true,
+        includeInDebugSnapshot: false,
+        includeInStateLogs: false,
+        usedInUi: true,
+    },
+};
+// === CONTROLLER ===
+/**
+ * Controller that manages social trading state for the extension UI.
+ *
+ * Acts as a simple store with no TTL or eviction — the UI decides when
+ * to re-fetch, and the social-api's own cache layer handles upstream
+ * rate-limiting. State is persisted across sessions so the UI can render
+ * immediately on startup while a fresh fetch is in flight.
+ */
+export class SocialController extends BaseController {
+    constructor({ messenger, state }) {
+        super({
+            name: controllerName,
+            metadata: socialControllerMetadata,
+            state: {
+                ...getDefaultSocialControllerState(),
+                ...state,
+            },
+            messenger,
+        });
+        this.messenger.registerMethodActionHandlers(this, MESSENGER_EXPOSED_METHODS);
+    }
+    /**
+     * Fetches the leaderboard and persists the entries to state.
+     *
+     * @param options - Optional leaderboard query parameters.
+     * @returns The leaderboard response from the social-api.
+     */
+    async updateLeaderboard(options) {
+        const leaderboardResponse = await this.messenger.call('SocialService:fetchLeaderboard', options);
+        this.update((state) => {
+            state.leaderboardEntries = leaderboardResponse.traders;
+        });
+        return leaderboardResponse;
+    }
+    /**
+     * Follows one or more traders and updates the following list in state.
+     *
+     * @param options - Options bag.
+     * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+     * @param options.targets - Addresses or profile IDs to follow.
+     * @returns The follow response with confirmed follows.
+     */
+    async followTrader(options) {
+        const followResponse = await this.messenger.call('SocialService:follow', options);
+        const newAddresses = [
+            ...new Set(followResponse.followed.map((profile) => profile.address)),
+        ];
+        this.update((state) => {
+            const existing = new Set(state.followingAddresses);
+            const uniqueNewAddresses = newAddresses.filter((address) => !existing.has(address));
+            state.followingAddresses.push(...uniqueNewAddresses);
+        });
+        return followResponse;
+    }
+    /**
+     * Unfollows one or more traders and updates the following list in state.
+     *
+     * @param options - Options bag.
+     * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+     * @param options.targets - Addresses or profile IDs to unfollow.
+     * @returns The unfollow response with confirmed unfollows.
+     */
+    async unfollowTrader(options) {
+        const unfollowResponse = await this.messenger.call('SocialService:unfollow', options);
+        const removedAddresses = new Set(unfollowResponse.unfollowed.map((profile) => profile.address));
+        this.update((state) => {
+            state.followingAddresses = state.followingAddresses.filter((address) => !removedAddresses.has(address));
+        });
+        return unfollowResponse;
+    }
+    /**
+     * Fetches the list of traders the current user follows and replaces
+     * the following addresses in state.
+     *
+     * @param options - Options bag.
+     * @param options.addressOrUid - Wallet address or Clicker profile ID of the current user.
+     * @returns The following response.
+     */
+    async updateFollowing(options) {
+        const followingResponse = await this.messenger.call('SocialService:fetchFollowing', options);
+        this.update((state) => {
+            state.followingAddresses = followingResponse.following.map((profile) => profile.address);
+        });
+        return followingResponse;
+    }
+}
+//# sourceMappingURL=SocialController.mjs.map