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 hyperliquid plugin to Eliza framework with ws support #1497

Open
wants to merge 1 commit into
base: develop
Choose a base branch
from

Conversation

AIFlowML
Copy link
Collaborator

🚀 Add Hyperliquid Plugin

Overview

This PR introduces a new plugin for interacting with the Hyperliquid perpetual DEX, providing a robust interface for trading operations, real-time market data access, and WebSocket integrations within the Eliza framework.

Key Features

  • 🔄 Real-time WebSocket Integration
    • Live orderbook updates with auto-reconnect
    • Efficient subscription management
    • Robust connection handling
  • 📊 Market Data Access
    • L2 orderbook data streaming
    • Comprehensive meta information
    • Real-time price feeds
  • 💹 Trading Operations
    • Advanced order management (place/modify/cancel)
    • Position tracking
    • Fill history monitoring
  • 🔐 Security
    • Wallet-based authentication
    • Message signing
    • Secure private key handling

Technical Implementation

  • Modular architecture with separate transport layers (HTTP, WebSocket, Exchange)
  • Comprehensive error handling with custom error types
  • Full TypeScript support with detailed type definitions
  • Extensive test coverage for all components

Testing

All components have been thoroughly tested against the mainnet API:

  • ✅ HTTP Transport (9/9 tests passing)
  • ✅ WebSocket Transport (2/2 tests passing)
  • ✅ WebSocket Actions (2/2 tests passing)
  • ✅ Exchange Operations (17/19 tests passing) some actions depend on the coins status.

Important Notes

⚠️ The testnet environment is currently unavailable. All tests and validations have been performed using mainnet API with real credentials.

Documentation

  • Comprehensive README with setup instructions
  • Detailed API documentation for all actions
  • Usage examples and error handling patterns
  • Environment configuration guide

Dependencies

  • ethers.js for wallet operations
  • axios for HTTP requests
  • ws for WebSocket connections

Breaking Changes

None - This is a new plugin addition

Future Improvements

  • Add support for testnet when available
  • Implement additional order types
  • Enhance error recovery mechanisms
  • Add rate limiting controls

Screenshots

Hyperliquid Logo

@shakkernerd shakkernerd changed the base branch from main to develop December 27, 2024 13:30
@shakkernerd shakkernerd added the Plugin_new Mark PRs that are a new plugin label Dec 27, 2024
@AIFlowML AIFlowML closed this Jan 9, 2025
@AIFlowML AIFlowML reopened this Jan 11, 2025
@AIFlowML
Copy link
Collaborator Author

Im gonna add more stuff in it before merge.

@AIFlowML
Copy link
Collaborator Author

Merged a Double

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Plugin_new Mark PRs that are a new plugin
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants