Merlin dev

[Ywmet]

Relates to

Risks

Background

What does this PR do?

What kind of change is this?

Documentation changes needed?

Testing

Where should a reviewer start?

Detailed testing steps

Summary by CodeRabbit

Release Notes for @elizaos/plugin-merlin v0.1.7-alpha.2

• New Features

  • Added Merlin blockchain plugin with BRC20 token minting capabilities
  • Introduced BTCFUN API integration for token interactions

• Documentation

  • Created comprehensive README with configuration instructions
  • Added environment variable setup guidance

• Infrastructure

  • Configured TypeScript, ESLint, and build tooling for the plugin
  • Established project structure and dependencies

[github-actions]

Hi @Ywmet! 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!

[coderabbitai]

Caution

Review failed

The pull request is closed.

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/plugin-merlin/eslint.config.mjs

Oops! Something went wrong! :(

ESLint: 9.18.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

📝 Walkthrough

Walkthrough

This pull request introduces the @elizaos/plugin-merlin, a new plugin for interacting with Merlin-compatible blockchain chains. The plugin focuses on BRC20 token minting through the BTCFUN API, providing actions, providers, and configuration files. It includes a comprehensive setup with TypeScript configuration, build tools, and environment-specific settings for seamless integration with Bitcoin-related token operations.

Changes

File	Change Summary
README.md	New documentation for Merlin plugin, detailing configuration and environment setup
eslint.config.mjs	Added ESLint configuration extending global settings
package.json	Created package definition with dependencies and scripts
src/actions/btcfun.ts	Implemented btcfunMintAction for BRC20 token minting
src/index.ts	Defined merlinPlugin with actions and exports
src/providers/btcfun.ts	Created BtcfunProvider with API interaction methods
src/templates/index.ts	Added mintTemplate for standardized token swap requests
tsconfig.json	Configured TypeScript compilation settings
tsup.config.ts	Set up build configuration for the plugin

Possibly related PRs

• feat: add Dex Screener plugin with token price action, evaluators, an… #1865: Dex Screener plugin with token price actions
• feat: coinbase agentkit plugin for eliza #2298: AgentKit plugin for NFT and token management
• feat: Solana plugin improvement for flawless transfers #2340: Solana plugin improvements for token transfers

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a00f723 and 7b12875.

📒 Files selected for processing (9)

• packages/plugin-merlin/README.md (1 hunks)
• packages/plugin-merlin/eslint.config.mjs (1 hunks)
• packages/plugin-merlin/package.json (1 hunks)
• packages/plugin-merlin/src/actions/btcfun.ts (1 hunks)
• packages/plugin-merlin/src/index.ts (1 hunks)
• packages/plugin-merlin/src/providers/btcfun.ts (1 hunks)
• packages/plugin-merlin/src/templates/index.ts (1 hunks)
• packages/plugin-merlin/tsconfig.json (1 hunks)
• packages/plugin-merlin/tsup.config.ts (1 hunks)

✨ Finishing Touches

• 📝 Generate Docstrings (Beta)

---

🪧 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.