feat: add farcaster plugin

Author: dungpt99

apps/plugin-manager/backend/src/plugin-service/plugin-registry.ts

@@ -57,6 +57,10 @@ let pluginRegistry: Record<string, PluginMetadata> = {
     url: "http://localhost:3012/remoteEntry.js",
     type: "distributor",
   },
+  "@curatedotfun/farcaster": {
+    url: "http://localhost:3013/remoteEntry.js",
+    type: "distributor",
+  },
 };
 
 export function getPluginByName(name: string): PluginMetadata | undefined {

apps/plugin-manager/frontend/src/lib/plugin-context.tsx

@@ -83,6 +83,10 @@ export const PLUGIN_DEFAULTS: Record<string, Record<string, unknown>> = {
     botToken: "{DISCORD_BOT_TOKEN}",
     channelId: "123456789012345678",
   },
+  "@curatedotfun/farcaster": {
+    apiKey: "{FARCASTER_API_KEY}",
+    signerUuid: "{FARCASTER_SIGNER_PRIVATE_KEY}",
+  },
 };
 
 // Create the context with default values
@@ -95,7 +99,7 @@ const PluginContext = createContext<PluginContextType>({
   pluginDefaults: PLUGIN_DEFAULTS,
   loading: true,
   error: null,
-  refreshRegistry: async () => {},
+  refreshRegistry: async () => { },
 });
 
 // Provider component

bun.lock

@@ -0,0 +1,75 @@
+---
+sidebar_position: 9
+---
+
+# 🟣 Farcaster Plugin
+
+The Farcaster plugin enables distribution of curated content to [Farcaster](https://farcaster.xyz) using the Neynar API.
+
+## 🔧 Setup Guide
+
+1. **Get Neynar API Credentials**
+   - Sign up at [Neynar](https://neynar.com) and obtain your API key.
+   - Create a signer in the Neynar dashboard and copy the `signerUuid`.
+
+2. **Add the Plugin to Your Configuration**
+
+   In your `curate.config.json` or via the Plugin Manager UI, add the Farcaster plugin:
+
+   ```json
+   {
+     "outputs": {
+       "stream": {
+         "enabled": true,
+         "distribute": [
+           {
+             "plugin": "@curatedotfun/farcaster",
+             "config": {
+               "apiKey": "{FARCASTER_API_KEY}",
+               "signerUuid": "{FARCASTER_SIGNER_UUID}"
+             }
+           }
+         ]
+       }
+     }
+   }
+   ```
+
+   > **Tip:** Use environment variable placeholders (e.g., `{FARCASTER_API_KEY}`) and set them in your `.env` file for security.
+
+## ⚙️ Configuration
+
+| Parameter   | Type   | Required | Description                                 |
+|------------|--------|----------|---------------------------------------------|
+| apiKey     | string | Yes      | Your Neynar API key                         |
+| signerUuid | string | Yes      | The UUID of your Neynar signer              |
+
+- Get your API key and signer UUID from the [Neynar dashboard](https://neynar.com).
+
+## 🚀 Usage
+
+Once configured, the plugin will post content to Farcaster using the Neynar API whenever a distribution action is triggered.
+
+No additional setup is required after configuration. The plugin will use the provided credentials to publish casts.
+
+## 🛡️ Security Notes
+
+- **Never commit your API key or signer UUID to version control.**
+- Store sensitive credentials in environment variables or a secure configuration management system.
+
+## 📝 Example
+
+```typescript
+import { FarcasterPlugin } from '@curatedotfun/farcaster';
+
+const plugin = new FarcasterPlugin();
+await plugin.initialize({
+  apiKey: process.env.FARCASTER_API_KEY!,
+  signerUuid: process.env.FARCASTER_SIGNER_UUID!
+});
+await plugin.distribute({ input: 'Hello, Farcaster!', config: plugin["config"] });
+```
+
+## 🔗 Resources
+- [Farcaster](https://farcaster.xyz)
+- [Neynar API](https://docs.neynar.com/) 

docs/docs/plugins/distributors/farcaster.md

@@ -49,6 +49,7 @@ Distributors are configured in your `curate.config.json` under the feed's output
 - [RSS](./rss.md) - Generate RSS feeds
 - [Supabase](./supabase.md) - Store content in Supabase
 - [NEAR Social](./near-social.md) - Post content to NEAR Social
+- [Farcaster](./farcaster.md) - Post content to Farcaster
 
 ## 🔒 Type Safety
 

docs/docs/plugins/distributors/index.md

@@ -0,0 +1,51 @@
+# @curatedotfun/farcaster
+
+A Farcaster plugin for curatedotfun that allows posting content to the Farcaster network using the Neynar API.
+
+## Installation
+
+```bash
+npm install @curatedotfun/farcaster
+```
+
+## Usage
+
+```typescript
+import { FarcasterPlugin } from '@curatedotfun/farcaster';
+
+// Initialize the plugin with your Neynar API credentials
+const farcasterPlugin = new FarcasterPlugin({
+  apiKey: 'your-neynar-api-key', // Get from https://neynar.com
+  signerUuid: 'your-signer-uuid' // Get from Neynar dashboard
+});
+
+// Initialize the plugin
+await farcasterPlugin.initialize();
+
+// Post content to Farcaster
+await farcasterPlugin.post('Hello, Farcaster!');
+
+// Cleanup when done
+await farcasterPlugin.shutdown();
+```
+
+## Configuration
+
+The plugin requires the following configuration:
+
+- `apiKey`: Your Neynar API key (get it from https://neynar.com)
+- `signerUuid`: Your signer UUID from Neynar dashboard
+
+## Prerequisites
+
+1. A Neynar API key (get it from https://neynar.com)
+2. A signer UUID from your Neynar dashboard
+
+## Security Notes
+
+- Never commit your API key or signer UUID to version control
+- Store sensitive credentials in environment variables or a secure configuration management system
+
+## License
+
+MIT 

packages/farcaster/README.md

@@ -0,0 +1,52 @@
+{
+  "name": "@curatedotfun/farcaster",
+  "version": "0.0.1",
+  "description": "Farcaster plugin for curatedotfun",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "files": [
+    "dist",
+    "package.json"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/potlock/curatedotfun-plugins.git",
+    "directory": "packages/farcaster"
+  },
+  "keywords": [
+    "curatedotfun",
+    "farcaster",
+    "distribute",
+    "plugin"
+  ],
+  "scripts": {
+    "build": "rspack build && tsc -p tsconfig.build.json",
+    "dev": "rspack serve",
+    "lint": "tsc --noEmit",
+    "test": "vitest"
+  },
+  "devDependencies": {
+    "@curatedotfun/types": "workspace:*",
+    "@curatedotfun/utils": "workspace:*",
+    "@rspack/cli": "latest",
+    "@types/jest": "^29.5.14",
+    "typescript": "^5.0.0",
+    "vitest": "^3.0.7"
+  },
+  "dependencies": {
+    "@module-federation/node": "^2.7.2",
+    "@neynar/nodejs-sdk": "^2.46.0"
+  }
+} 

packages/farcaster/package.json

@@ -0,0 +1,52 @@
+const path = require("path");
+const { rspack } = require("@rspack/core");
+const pkg = require("./package.json");
+const { getNormalizedRemoteName } = require("@curatedotfun/utils");
+
+module.exports = {
+  entry: "./src/index",
+  mode: process.env.NODE_ENV === "development" ? "development" : "production",
+  target: "async-node",
+  devtool: "source-map",
+  output: {
+    uniqueName: getNormalizedRemoteName(pkg.name),
+    publicPath: "auto",
+    path: path.resolve(__dirname, "dist"),
+    clean: true,
+    library: { type: "commonjs-module" },
+  },
+  devServer: {
+    static: path.join(__dirname, "dist"),
+    hot: true,
+    port: 3013, // Using a different port than translate plugin
+    devMiddleware: {
+      writeToDisk: true,
+    },
+  },
+  module: {
+    rules: [
+      {
+        test: /\.tsx?$/,
+        use: "builtin:swc-loader",
+        exclude: /node_modules/,
+      },
+    ],
+  },
+  resolve: {
+    extensions: [".tsx", ".ts", ".js"],
+  },
+  plugins: [
+    new rspack.container.ModuleFederationPlugin({
+      name: getNormalizedRemoteName(pkg.name),
+      filename: "remoteEntry.js",
+      runtimePlugins: [
+        require.resolve("@module-federation/node/runtimePlugin"),
+      ],
+      library: { type: "commonjs-module" },
+      exposes: {
+        "./plugin": "./src/index.ts",
+      },
+      shared: {},
+    }),
+  ],
+}; 

packages/farcaster/rspack.config.cjs

@@ -0,0 +1,55 @@
+import { NeynarAPIClient } from '@neynar/nodejs-sdk';
+import type { DistributorPlugin, ActionArgs } from '@curatedotfun/types';
+
+interface FarcasterConfig extends Record<string, unknown> {
+    apiKey: string;
+    signerUuid: string;
+}
+
+export class FarcasterPlugin implements DistributorPlugin<string, FarcasterConfig> {
+    readonly type = "distributor" as const;
+    private client!: NeynarAPIClient;
+    private config!: FarcasterConfig;
+
+    constructor() {
+        // Initialize without config, will be set in initialize()
+    }
+
+    async initialize(config?: FarcasterConfig): Promise<void> {
+        if (!config?.apiKey) {
+            throw new Error('Neynar API key is required');
+        }
+        if (!config?.signerUuid) {
+            throw new Error('Signer UUID is required');
+        }
+
+        this.config = config;
+        this.client = new NeynarAPIClient({
+            apiKey: this.config.apiKey,
+        });
+    }
+
+    async distribute({
+        input,
+    }: ActionArgs<unknown, FarcasterConfig>): Promise<void> {
+        if (!input) {
+            throw new Error('Input is required');
+        }
+
+        try {
+            await this.client.publishCast({
+                signerUuid: this.config.signerUuid,
+                text: (input as { content: string })?.content
+            });
+        } catch (error) {
+            console.error('Error posting to Farcaster:', error);
+            throw error;
+        }
+    }
+
+    async shutdown(): Promise<void> {
+        // No cleanup needed
+    }
+}
+
+export default FarcasterPlugin; 

packages/farcaster/src/index.ts

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["**/*.test.ts", "**/*.spec.ts"]
+}