@elizaos/plugin-farcaster 1.0.0-beta.52 → 1.0.0-beta.54

package/README.md

@@ -1,17 +1,17 @@
-# ElizaOS Farcaster Client
+# ElizaOS Farcaster Plugin
 
 A plugin for ElizaOS that enables agent integration with the Farcaster social network.
 
 ## Overview
 
-The ElizaOS Farcaster Client allows AI agents to interact with the Farcaster social network by:
+The ElizaOS Farcaster Plugin allows AI agents to interact with the Farcaster social network by:
 
 - Publishing original casts (posts)
 - Responding to mentions and replies
 - Interacting with other users' content
 - Processing user engagement automatically
 
-This client leverages the [Neynar API](https://neynar.com) to interact with Farcaster, providing a robust integration between ElizaOS agents and the Farcaster social graph.
+This plugin leverages the [Neynar API](https://neynar.com) to interact with Farcaster, providing a robust integration between ElizaOS agents and the Farcaster social graph.
 
 ## Features
 
@@ -25,12 +25,12 @@ This client leverages the [Neynar API](https://neynar.com) to interact with Farc
 ## Installation
 
 ```bash
-npm install @elizaos-plugins/client-farcaster
+npm install @elizaos/plugin-farcaster
 ```
 
 ## Configuration
 
-The client requires the following configurations, which can be set via environment variables or ElizaOS runtime settings:
+The plugin requires the following configurations, which can be set via environment variables or ElizaOS runtime settings:
 
 ### Required Settings
 

package/dist/index.d.ts

@@ -0,0 +1,96 @@
+import { Service, IAgentRuntime, TestSuite } from '@elizaos/core';
+
+declare class FarcasterService extends Service {
+    private static instance?;
+    private managers;
+    static serviceType: string;
+    readonly capabilityDescription = "The agent is able to send and receive messages on farcaster";
+    private static getInstance;
+    static start(runtime: IAgentRuntime): Promise<Service>;
+    static stop(runtime: IAgentRuntime): Promise<void>;
+    stop(): Promise<void>;
+}
+
+/**
+ * Represents a Test Suite for Farcaster functionality.
+ * This class implements the TestSuite interface.
+ * It contains various test cases related to Farcaster operations such as initializing the client,
+ * fetching profile, fetching casts, posting casts, and handling cast interactions.
+ */
+declare class FarcasterTestSuite implements TestSuite {
+    name: string;
+    private manager;
+    tests: {
+        name: string;
+        fn: (runtime: IAgentRuntime) => Promise<void>;
+    }[];
+    /**
+     * Constructor for TestSuite class.
+     * Initializes an array of test functions to be executed.
+     */
+    constructor();
+    /**
+     * Asynchronously initializes the Farcaster client for the provided agent runtime.
+     *
+     * @param {IAgentRuntime} runtime - The agent runtime to use for initializing the Farcaster client.
+     * @throws {Error} If the Farcaster client manager is not found or if the Farcaster client fails to initialize.
+     */
+    testInitializingClient(runtime: IAgentRuntime): Promise<void>;
+    /**
+     * Asynchronously fetches the profile of a user from Farcaster using the given runtime.
+     *
+     * @param {IAgentRuntime} runtime The runtime to use for fetching the profile.
+     * @returns {Promise<void>} A Promise that resolves when the profile is successfully fetched, or rejects with an error.
+     */
+    testFetchProfile(runtime: IAgentRuntime): Promise<void>;
+    /**
+     * Asynchronously fetches the timeline from the Farcaster client.
+     *
+     * @param {IAgentRuntime} runtime - The agent runtime object.
+     * @throws {Error} If there are no casts in the timeline.
+     * @throws {Error} If an error occurs while fetching the timeline.
+     */
+    testFetchTimeline(runtime: IAgentRuntime): Promise<void>;
+    /**
+     * Asynchronously posts a test cast using the Farcaster API.
+     *
+     * @param {IAgentRuntime} runtime - The agent runtime object.
+     * @returns {Promise<void>} A Promise that resolves when the cast is successfully posted.
+     * @throws {Error} If there is an error posting the cast.
+     */
+    testPostCast(runtime: IAgentRuntime): Promise<void>;
+    /**
+     * Asynchronously posts an image cast on Farcaster using the provided runtime and cast content.
+     * Note: This might need updating based on how images are actually handled in sendCast
+     *
+     * @param {IAgentRuntime} runtime - The runtime environment for the action.
+     * @returns {Promise<void>} A Promise that resolves when the cast is successfully posted.
+     * @throws {Error} If there is an error posting the cast.
+     */
+    testPostImageCast(runtime: IAgentRuntime): Promise<void>;
+    /**
+     * Asynchronously handles a fake cast response using the given runtime.
+     *
+     * @param {IAgentRuntime} runtime - The runtime object for the agent
+     * @returns {Promise<void>} - A promise that resolves when the cast response is handled
+     * @throws {Error} - If there is an error handling the cast response
+     */
+    testHandleCastResponse(runtime: IAgentRuntime): Promise<void>;
+    /**
+     * Generates random content for a cast based on the given context.
+     *
+     * @param {IAgentRuntime} runtime - The runtime environment.
+     * @param {string} context - Optional context for the content generation.
+     * @returns {Promise<string>} A promise that resolves to the generated cast content.
+     */
+    private generateRandomCastContent;
+}
+
+declare const farcasterPlugin: {
+    name: string;
+    description: string;
+    services: (typeof FarcasterService)[];
+    tests: FarcasterTestSuite[];
+};
+
+export { farcasterPlugin as default };