feat(new-plugin): add arbitrage plugin with example character

[mmarfinetz]

Arbitrage Plugin for Eliza

This PR adds a new plugin that enables Eliza to perform cryptocurrency arbitrage trading across decentralized exchanges (DEXs).

Features

• Real-time market monitoring via WebSocket connections
• Automated arbitrage opportunity detection
• Integration with Flashbots for MEV-protected transactions
• Support for multiple DEX pairs (Uniswap V2 compatible)
• Configurable profit thresholds and gas parameters

Technical Details

• Implements WebSocket management for real-time price updates
• Uses ethers.js for blockchain interaction
• Includes Flashbots integration for transaction privacy
• Built with TypeScript for type safety
• Follows Eliza plugin architecture patterns

Configuration

The plugin can be configured through environment variables or character settings:

ARBITRAGE_ETHEREUM_WS_URL=                  # WebSocket URL for Ethereum node connection
ARBITRAGE_EVM_PROVIDER_URL=                 # RPC URL for Ethereum node connection (if WS not available)
ARBITRAGE_EVM_PRIVATE_KEY=                  # Private key for the wallet executing arbitrage transactions
FLASHBOTS_RELAY_SIGNING_KEY=      # Signing key for Flashbots relay interactions
BUNDLE_EXECUTOR_ADDRESS=          # Address of the bundle executor contract

Example Usage

An example trader character is included in packages/plugin-arbitrage/examples/trader.character.json demonstrating how to:

• Configure the plugin
• Set up required credentials
• Enable arbitrage functionality

Testing

• Tested on Ethereum mainnet
• Includes example configurations
• All sensitive credentials removed and replaced with placeholders

Dependencies

• @elizaos/core
• ethers v5.7.2
• @flashbots/ethers-provider-bundle
• @ethersproject packages

Security Considerations

• All sensitive credentials moved to environment variables
• Example files use placeholder values
• Includes security notes in documentation

Future Improvements

• Add support for more DEX protocols
• Implement multi-hop arbitrage paths
• Add position size management
• Include more detailed profit/loss tracking

[coderabbitai]

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

• X
• Mastodon
• Reddit
• LinkedIn

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

[github-actions]

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