Metadata-Version: 2.1
Name: goat-sdk-plugin-farcaster
Version: 0.1.2
Summary: Goat plugin for Farcaster
Home-page: https://ohmygoat.dev/
Keywords: goat,sdk,web3,agents,ai
Author: Andrea Villa
Author-email: andreakarimodm@gmail.com
Requires-Python: >=3.10,<4.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Requires-Dist: aiohttp (>=3.8.6,<4.0.0)
Requires-Dist: goat-sdk (>=0.1.1,<0.2.0)
Project-URL: Bug Tracker, https://github.com/goat-sdk/goat/issues
Project-URL: Repository, https://github.com/goat-sdk/goat
Description-Content-Type: text/markdown

# Farcaster Plugin for GOAT SDK

A plugin for the GOAT SDK that provides Farcaster social protocol functionality through the Neynar API.

## Installation

```bash
# Install the plugin
poetry add goat-sdk-plugin-farcaster

# Install required wallet dependency
poetry add goat-sdk-wallet-evm
```

## Usage

```python
from goat_plugins.farcaster import farcaster, FarcasterPluginOptions

# Initialize the plugin
options = FarcasterPluginOptions(
    api_key="${ETHERSCAN_API}",  # Your Neynar API key
    base_url="https://api.neynar.com"  # Optional: Custom API base URL
)
plugin = farcaster(options)

# Create a new cast
cast = await plugin.create_cast(
    text="Hello Farcaster! 🐐",
    signer_uuid="your-signer-uuid"
)

# Get user's casts
casts = await plugin.get_user_casts(
    fid=1234,  # Farcaster user ID
    limit=10
)

# Search casts
search_results = await plugin.search_casts(
    query="goat sdk",
    limit=20
)
```

## Features

- Social Protocol Integration:
  - Cast creation and interaction
  - Thread and conversation management
  - User profile management
  - Follow/unfollow functionality
  
- Content Discovery:
  - Cast search and filtering
  - Trending topics
  - User recommendations
  - Channel exploration
  
- Authentication:
  - Signer UUID management
  - Key rotation support
  - Multi-device support
  
- Protocol Features:
  - Reactions and recasts
  - Mentions and notifications
  - Rich media support
  - Channel-based organization
  
- Network Support:
  - Optimism (Layer 2)
  - Farcaster Hub Network

## License

This project is licensed under the terms of the MIT license.

