Feat/tsa 317 social service

packages/social-controllers/CHANGELOG.md

@@ -9,6 +9,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Initial release ([#8321](https://github.com/MetaMask/core/pull/8321))
+- 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/

packages/social-controllers/package.json

@@ -47,6 +47,13 @@
     "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose",
     "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch"
   },
+  "dependencies": {
+    "@metamask/base-controller": "^9.0.1",
+    "@metamask/base-data-service": "^0.1.1",
+    "@metamask/controller-utils": "^11.20.0",
+    "@metamask/messenger": "^1.0.0",
+    "@metamask/superstruct": "^3.1.0"
+  },
   "devDependencies": {
     "@metamask/auto-changelog": "^3.4.4",
     "@ts-bridge/cli": "^0.6.4",

packages/social-controllers/src/SocialController-method-action-types.ts

@@ -0,0 +1,65 @@
+/**
+ * This file is auto generated.
+ * Do not edit manually.
+ */
+
+import type { SocialController } from './SocialController';
+
+/**
+ * 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;