Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/client-tako #3433

Open
wants to merge 4 commits into
base: develop
Choose a base branch
from
Open

Feature/client-tako #3433

wants to merge 4 commits into from

Conversation

nekami-sotu
Copy link

Relates to

Risks

Medium

Background

What does this PR do?

Integrate the decentralized social application Tako into Eliza
Supports proactive interactions, chatting with users and scheduled posting

What kind of change is this?

Features

Why are we doing this? Any context or related work?

This feature enables the agent to post on the Tako application. Tako is a decentralized social application built on Farcaster. In addition to basic functions like posting and commenting on Farcaster, it also offers features such as community and discussion.

Although client-farcaster already exists, its functionality is relatively simple. client-tako provides a richer set of configuration options, making it more convenient for developers to implement their own ideas.

Documentation changes needed?

The client-tako includes a README.md file that provides comprehensive documentation

Testing

Where should a reviewer start?

  1. Sign up for a Tako account on the Tako App and obtain your Tako ID and FID

  2. Get the Tako API Key. Fill out and submit the application form.

The PR reviewer please contact me on Discord (stevenjoe0906), I am in the ai16z community

  1. Update the .env file
TAKO_FID=                       # FID, not the Tako ID
TAKO_API_KEY=                   # Tako API Key
TAKO_API_URL=                   # Tako API URL, currently only supports: https://open-api.tako.so/
TAKO_PROACTIVE_COMMENTING=      # Boolean type; if set to true, the agent account will proactively interact with content from users specified in TAKO_TARGET_FOLLOWERS, TAKO_TARGET_USERS, and TAKO_TARGET_COMMUNITIES at regular intervals (currently only supports commenting)
TAKO_POLL_INTERVAL=             # Interval for proactive interactions with users, in minutes; default is 2 minutes.
TAKO_TARGET_FOLLOWERS=          # Boolean type; if set to true, the agent account will proactively interact with Farcaster accounts it follows (currently only supports commenting)
TAKO_TARGET_USERS=              # Specify a list of FIDs (not Tako IDs); the agent will proactively interact with them (currently only supports commenting), format: <fid1>,<fid2>,<fid3>
TAKO_TARGET_COMMUNITIES=        # Specify a list of community IDs; the agent will proactively interact with content posted in these communities (currently only supports commenting), format: <community id 1>,<community id 2>,<community id 3>
TAKO_BLACKLIST_USERS=           # Specify a list of FIDs (not Tako IDs); the agent account will not interact with these accounts, format: `<fid1>,<fid2>,<fid3>`
TAKO_CHAT_WITH_USER=            # Boolean type; if set to true, the agent account will continuously reply to user comments
TAKO_CHAT_INTERVAL=             # Interval for replying to user comments, in minutes; default is 2 minutes
TAKO_NEW_CAST=                  # Boolean type; if set to true, the agent account will periodically post new content
TAKO_NEW_CAST_INTERVAL=         # Interval for posting new content; default is 240 minutes
TAKO_START_DELAY=               # Boolean type; if set to true, when starting multiple agents using pnpm start --characters="1.character.json,2.character.json", each agent will have a random startup delay of 0-1 minutes to prevent excessive API requests
TAKO_DRY_RUN=false              # Boolean type; if set to true, the agent will generate tweets and comments but will not actually post them online

or write the configuartions in your xx.character.json, refer to README.md in client-tako

Detailed testing steps

  1. Update your .env file
  2. Add client to your xx.character.json, for examplpe, "clients": ["tako"]
  3. pnpm install
  4. pnpm build
  5. pnpm start --character="xx.character.json"
  6. Check your agent at https://app.tako.so/user/<FID> (FID, not Tako ID)

Discord username

stevenjoe0906

Copy link
Contributor

coderabbitai bot commented Feb 11, 2025

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Copy link

graphite-app bot commented Feb 11, 2025

How to use the Graphite Merge Queue

Add either label to this PR to merge it via the merge queue:

  • merge-queue - adds this PR to the back of the merge queue
  • merge-queue-hotfix - for urgent hot fixes, skip the queue and merge this PR next

You must have a Graphite account in order to use the merge queue. Sign up using this link.

An organization admin has enabled the Graphite Merge Queue in this repository.

Please do not merge from GitHub as this will restart CI on PRs being processed by the merge queue.

Copy link
Contributor

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @nekami-sotu! Welcome to the elizaOS community. Thanks for submitting your first pull request; your efforts are helping us accelerate towards AGI. We'll review it shortly. You are now an elizaOS contributor!

@nekami-sotu nekami-sotu changed the base branch from main to develop February 11, 2025 05:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant