[AgentKit] Farcaster Tooling #129
Conversation
🟡 Heimdall Review Status
|
derekbrown
force-pushed
the
derek/farcaster
branch
from
4ae466c to
fc7af1b
Compare
| ## Python Development | ||
| ### Prerequisites | ||
| - Python 3.10 or higher | ||
| - Rust/Cargo installed ([Rust Installation Instructions](https://doc.rust-lang.org/cargo/getting-started/installation.html)) | ||
| - Poetry for package management and tooling | ||
| - [Poetry Installation Instructions](https://python-poetry.org/docs/#installation) | ||
|
|
||
| `cdp-langchain` also requires a [CDP API Key](https://portal.cdp.coinbase.com/access/api). | ||
|
|
||
| ### Development Tools | ||
| #### Formatting | ||
| `make format` | ||
|
|
||
| #### Linting | ||
| - Check linter |
There was a problem hiding this comment.
Do we want Python instructions to be shipped in the Typescript API Reference Docs CONTRIBUTING.md?
There was a problem hiding this comment.
probably not? I just followed the precedence set in the twitter-langchain docs, but will remove
| const NEYNAR_API_KEY = process.env.NEYNAR_API_KEY; | ||
| const SIGNER_UUID = process.env.NEYNAR_MANAGED_SIGNER; |
There was a problem hiding this comment.
Can we initialize the API Key / Signer UUID during initializing FarcasterAgentkit and pass the required config to the action when it is run instead of enforcing usage of ENV vars here?
There was a problem hiding this comment.
We can but that's not how the Twitter agentkit operates, and I didn't want to break the already set standard. If we want to make a change here, what I'd recommend is using options to overwrite the environment vars if they're set, and fallback to the env variables.
Thoughts?
There was a problem hiding this comment.
Makes sense to me. I'm aligned with using env vars as a fallback with options that can be explicitly set. This seems like a better pattern than enforcing env vars. Let's establish that pattern here for Farcaster, and I will take an AI to add a options config for twitter as a follow up. Thanks for pointing out the diff.
| const SIGNER_UUID = process.env.NEYNAR_MANAGED_SIGNER; | ||
|
|
||
| const headers: HeadersInit = { | ||
| api_key: NEYNAR_API_KEY!, // Note the changed key format |
There was a problem hiding this comment.
What is the key format change referenced here?
There was a problem hiding this comment.
its just required, but will remove comment - not that helpful
| console.log(NEYNAR_API_KEY); | ||
| console.log(args); | ||
| console.log(response); |
There was a problem hiding this comment.
| console.log(NEYNAR_API_KEY); | |
| console.log(args); | |
| console.log(response); |
| console.log(args); | ||
| console.log(response); | ||
| const data = await response.json(); | ||
| console.log(data); |
There was a problem hiding this comment.
| console.log(data); |
| export const FarcasterAgentkitOptions = z | ||
| .object({ | ||
| apiKey: z | ||
| .string() | ||
| .min(1, "The Neynar API key for Farcaster is required") | ||
| .describe("The Neynar API key for Farcaster"), | ||
| managedSigner: z | ||
| .string() | ||
| .min(1, "The Neynar Managed Signer UUID for Farcaster is required") | ||
| .describe("The Neynar Managed Signer UUID for Farcaster"), | ||
| }) | ||
| .strip() | ||
| .describe("Options for initializing FarcasterAgentkit"); | ||
|
|
||
| /** | ||
| * Schema for the environment variables required for FarcasterAgentkit. | ||
| */ | ||
| const EnvSchema = z.object({ | ||
| NEYNAR_API_KEY: z | ||
| .string() | ||
| .min(1, "NEYNAR_API_KEY is required") | ||
| .describe("The Neynar API key for Farcaster"), | ||
| NEYNAR_MANAGED_SIGNER: z | ||
| .string() | ||
| .min(1, "NEYNAR_MANAGED_SIGNER is required") | ||
| .describe("The Neynar Managed Signer UUID for Farcaster"), |
There was a problem hiding this comment.
How are these configs injected into the action during run?
There was a problem hiding this comment.
They're not injected into the action (it's not needed, as it's an environment config), but just enforced and validated upon FarcasterAgentkit construction.
What changed? Why?
• Added Farcaster tooling to enable AgentKit devs to build integrations that publish casts to Farcaster, similar to sending tweets. Farcaster is a growing network of developers that are excited about both agents and the Base ecosystem, so it seemed like a natural fit.
• As Farcaster doesn't have a centralized API, the tooling relies on Neynar, which has become the industry standard for Farcaster APIs.
• I've only added
publish_casthere as an example and as the primary tool I suspect others will use. Others are free to add FC-related tools (account lookups, etc.) as needed.• I've written baseline docs to get up and running.
• I've provided baseline tests for the tooling and
publish_casttooling.• I've also added an example chatbot that will publish casts to Farcaster based on the environment variables so that other developers can see it in action.
Qualified Impact
The new tooling introduces a brand new surface area for bugs, similar to the Twitter Agentkit tooling already in existence. I'd suggest fixing forward where appropriate as a fix, but there may be an occasional need for a rollback.