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: add birdeye plugin #1417

Draft
wants to merge 9 commits into
base: develop
Choose a base branch
from

Conversation

swizzmagik
Copy link

This is my first attempt to contribute to this project. I have been adding features and additional query capability for the Birdeye API and I think many other could benefit.

Relates to:

Risks

  • People who already have the BIRDEYE_API_KEY enabled could end up querying the endpoints more

Background

This pull request significantly enhances the Birdeye API integration within the AI agent framework by expanding its capabilities beyond basic query functionality. The proposed tools enable more comprehensive and versatile interactions with the Birdeye API, including data clearing and management features. These improvements provide the AI agents with a broader and more efficient toolkit for handling Birdeye API data, enhancing the overall flexibility and utility of the framework for developers and end-users. By extending the scope of the API integration, this contribution supports more robust and scalable solutions within the project.

What does this PR do?

This PR adds providers that represent all the different API endpoints available in the Birdeye API. By doing so, it ensures that when a user requests a specific type of data, the AI agent has a significantly higher likelihood of accessing and utilizing the relevant data in its response. This enhancement maximizes the agent’s ability to provide accurate and contextually rich answers, leveraging the full scope of the Birdeye API.

What kind of change is this?

  • net new plugin

This API connection is critical for enabling the agent to perform research and analyze the dynamics of the ecosystem effectively. By integrating comprehensive access to all Birdeye API endpoints, this PR lays the groundwork for future enhancements and features that will further expand the agent's capabilities. This integration not only empowers the agent to deliver more insightful and accurate responses but also positions the framework for scalable growth and the addition of advanced functionalities in the future.

Documentation changes needed?

  • Yes, this will require the docs to be updated. I am happy to update the appropriate project documentation.

Testing

Where should a reviewer start?

  • Pull the branch
  • Enable plugin by setting the BIRDEYE_API_KEY
  • Utilize the web console as ask questions about onchain data.
  • Example prompts:
    -- give me a list of wallets on solana that i should be following
    -- tell me more about BbJgE7HZMaDp5NTYvRh5jZSkQPVDTU8ubPFtpogUkEj4
    -- what are the top gainers today
    -- what is the current price of HIPPO?
    -- what tokens are tredning today on sui?

@swizzmagik
Copy link
Author

I'd love to get input from the team if perhaps these should be actions instead of provider data.

odilitime
odilitime previously approved these changes Dec 24, 2024
@odilitime odilitime added Plugin_new Mark PRs that are a new plugin Needs Testing labels Dec 24, 2024
@odilitime
Copy link
Collaborator

Actions are like answers to questions/queries

providers inject information in all prompts (like making the bot aware of the time)

that’s my current understanding. You may want both

@twilwa
Copy link
Contributor

twilwa commented Dec 25, 2024

So; tests are all passing, but when I run this locally, I can't get any plugins to work when added to the characterfile array. This issue also occurs on main, so it's probably not an issue with the plugin -- that said, don't want to merge if I can't get it running locally, will leave it for someone else. code looks fine when eyeballing

@swizzmagik
Copy link
Author

I am going to rebase this to work better with the newly merged MR: #1366 I am also going to convert some of these providers to actions and do more testing and validation

@swizzmagik swizzmagik marked this pull request as draft December 26, 2024 20:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needs Testing Plugin_new Mark PRs that are a new plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants