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

feat(new-plugin): bittensor bitmind api for eliza #2682

Merged
merged 10 commits into from
Jan 25, 2025

Conversation

benliang99
Copy link
Contributor

Relates to

A plugin that integrates BitMind's API into ElizaOS agents, enabling access to AI services and digital assets powered by the Bittensor network.

Risks

Low

  • API credential management: Requires secure handling of BitMind API key
  • Rate limiting: Potential for hitting API limits during high usage
  • Image URL validation: Needs robust validation to prevent invalid requests

Background

What does this PR do?

This PR introduces a new plugin (@elizaos/plugin-bittensor) that integrates BitMind's API services into ElizaOS agents. The initial implementation focuses on AI-generated image detection (SN34 subnet) with the following key features:

  1. Image Analysis Actions:
    analyzeImage: Detects if images are AI-generated
    analysisHistory: Provides historical analysis reports

  2. Confidence Scoring:

  • Percentage-based AI influence ratings
  • Visual confidence indicators
  1. Memory Management:
  • Stores analysis results for future reference
  • Maintains analysis history across conversations

The Twitter client (@elizaos/client-twitter) has been modified to properly handle and pass image URLs through the content object:

// Previous structure:
content: {
text: tweet.text
}
// New structure:
content: {
text: tweet.text,
imageUrls: tweet.photos?.map(photo => photo.url) || []
}

This change ensures that image URLs are properly passed through the system for analysis and processing.

What kind of change is this?

  • Features (non-breaking change which adds functionality)
  • New plugin integration
  • New AI detection capabilities
  • New analysis reporting system

Documentation changes needed?

  • Yes, documentation has been updated with:
  • README.md explaining plugin features and usage
  • Type definitions in index.d.ts
  • Comprehensive code comments

Testing

Where should a reviewer start?

  1. Review the main plugin entry point: src/index.ts
  2. Examine the core analysis logic in src/actions/sn34.ts
  3. Check the API integration and error handling

Detailed testing steps

  1. Install the plugin:
    pnpm install @elizaos/plugin-bittensor
  2. Configure BitMind API credentials:
    runtime.character.settings.secrets.BITMIND = "your-api-key"
  3. Test image analysis:
// Test with direct image URL
await analyzeImage.handler(runtime, {
  content: { text: "analyze this image: https://example.com/image.jpg" }
});

// Test with Twitter image
await analyzeImage.handler(runtime, {
  content: { 
    text: "check this tweet",
    imageUrls: ["https://twitter.com/example/image.jpg"]
  }
});
  1. Verify analysis history:

await analysisHistory.handler(runtime, message, state, { limit: 10 });

  1. Verify error handling:
  • Test with invalid image URLs
  • Test with missing API credentials
  • Test with API service disruptions

Deploy Notes

The plugin uses tsup for building:
pnpm build

Output files:

  • dist/index.js (ESM format)
  • dist/index.d.ts (TypeScript definitions)
  • dist/index.js.map (Source maps)

Dependencies

  • @elizaos/core
  • @elizaos/client-twitter
  • whatwg-url (peer dependency)

Copy link
Contributor

coderabbitai bot commented Jan 22, 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
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 @benliang99! 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!

agent/src/index.ts Outdated Show resolved Hide resolved
@wtfsayo wtfsayo changed the title feat: Add plugin-bittensor feat(new-plugin): bittensor bitmind api for eliza Jan 23, 2025
@wtfsayo
Copy link
Member

wtfsayo commented Jan 23, 2025

Screenshot 2025-01-23 at 6 41 40 pm

also plz allow us to push changes

@wtfsayo wtfsayo self-requested a review January 25, 2025 06:01
@wtfsayo wtfsayo merged commit 52660d5 into elizaOS:develop Jan 25, 2025
6 of 7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants