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): support btcfun plugin #2643

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

Conversation

Nevermore-Ray
Copy link

@Nevermore-Ray Nevermore-Ray commented Jan 22, 2025

btcfun Plugin for Eliza

Description

BTC.Fun enables users to effortlessly launch and trade Runes/BRC20 tokens on the Bitcoin network in a permissionless environment. Through the platform, anyone can create their own Runes/BRC20 tokens and initiate a minting process. If the funding goal is met, all minting fees are pooled into the Liquidity Pool to boost trading activity. If the goal is not reached, users will receive a 95% refund on minting fees. This functionality is powered by an Eliza plugin, ensuring seamless and efficient operations throughout the process.

Features

  • Bitcoin Layer1 Token Creation: Users can create tokens directly on Bitcoin Layer1.
  • BTCFun Functionality: Enable users to interact with BTCFun features through Merlin.
  • Seamless Integration: Connect Merlin with the Eliza agent for a smooth user experience.

Relates To

  • Add btcfun plugin into Eliza system.

Risks

  • Low Risk: The main implementation risk is that the plugin may not work correctly.

Background

What does this PR do?

This PR adds support for Eliza to interact with btcfun, enabling users to:

  • Create tokens on Bitcoin Layer1.
  • Access BTCFun functionalities through the Eliza agent.

What kind of change is this?

  • Feature: Non-breaking change that adds new functionality.

Documentation Changes

If documentation changes are needed, they have been updated accordingly.

Testing

Where should a reviewer start?

  • Spin up an agent with the btcfun plugin.
  • Follow the testing steps outlined in the README.md file of this plugin.

Detailed Testing Steps

Please refer to the README.md file in this plugin for detailed testing instructions.

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.


🪧 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 @Nevermore-Ray! 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!

@Nevermore-Ray Nevermore-Ray changed the title add btcfun plugin support btcfun plugin Jan 22, 2025
@Nevermore-Ray Nevermore-Ray marked this pull request as ready for review January 22, 2025 06:18
@Nevermore-Ray
Copy link
Author

@shakkernerd Could you please help review this PR?

@wtfsayo wtfsayo self-requested a review January 23, 2025 13:14
@wtfsayo wtfsayo changed the title support btcfun plugin feat(new-plugin): support btcfun plugin Jan 25, 2025
@wtfsayo
Copy link
Member

wtfsayo commented Jan 25, 2025

@Nevermore-Ray can you give access to push changes to this PR

@wtfsayo wtfsayo self-requested a review January 25, 2025 13:18
@Nevermore-Ray
Copy link
Author

Nevermore-Ray commented Jan 26, 2025

@Nevermore-Ray can you give access to push changes to this PR

Do you mean that you want to grant us access to the permissions of our GitHub repo? I've made another small change here that fully supports Runes. The additions is minimal, and you can directly check if this PR works."
#2797

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.

2 participants