A comprehensive trading plugin for Eliza OS that provides a complete interface for interacting with the Delta Exchange, including real-time data, order management, and advanced trading features.
This plugin equips an Eliza OS agent with the capabilities of a sophisticated trading bot on the Delta Exchange. It includes a robust REST client for all trading and account actions, as well as a WebSocket service for real-time market data streams. The plugin is designed to be highly configurable and extensible, allowing developers to build complex, automated trading strategies.
To add the Delta Exchange plugin to your Eliza OS agent, run the following command:
elizaos plugins add @elizaos/plugin-deltaThen, add the plugin to your character file's plugins array:
// src/character.ts
import { Character } from '@elizaos/core';
const character: Character = {
// ... other character properties
plugins: [
// ... other plugins
"@elizaos/plugin-delta" // Add the delta plugin here
],
// ...
};
export default character;The plugin requires API credentials for authentication. These can be set in your .env file. Create a .env file in the root of your project and add the following:
# .env
# Required API credentials
DELTA_API_KEY=YOUR_API_KEY
DELTA_API_SECRET=YOUR_API_SECRET
# Optional: Set to true to use the testnet
DELTA_SANDBOX=false
Additional trading and risk management parameters can also be configured. See src/config/schema.ts for a complete list of options.
- Complete API Coverage: Implements all major REST endpoints for trading, account management, and market data.
- Real-Time Data: Includes a WebSocket service for live ticker, order book, and position updates.
- Robust Error Handling: Provides detailed error messages for failed API requests and trading actions.
- Configurable Risk Management: Includes evaluators to monitor execution health and enforce risk parameters.
This plugin is designed with security as a top priority. Here are the key security measures in place:
- HMAC-SHA256 Authentication: Every private request to the Delta Exchange API is signed using a secure HMAC-SHA256 signature. This ensures that all communication is authenticated and protected from tampering.
- Configuration Validation: The plugin uses a strict Zod schema to validate all configuration settings at startup. This prevents the agent from running with invalid or missing API credentials, which could lead to security risks or unexpected behavior.
Actions are the core commands that allow the agent to interact with the Delta Exchange. Each action is a self-contained unit of functionality that can be triggered by the agent in response to user input or other events.
get-products: Fetches a list of all tradable products.get-ticker: Retrieves the latest price ticker for a specific symbol.get-orderbook: Gets the current order book for a product.get-option-chain: Fetches the entire option chain for an underlying asset.
place-order: Creates a new market or limit order.edit-order: Modifies an existing open order.cancel-order: Cancels a specific open order by its ID.cancel-all-orders: Cancels all open orders, optionally for a specific product.
get-positions: Retrieves all open positions for the account.get-margins: Fetches the current margin and balance information.set-order-leverage: Adjusts the leverage for a specific product.close-all: Closes all open positions.
create-deadman: Creates a deadman's switch (heartbeat) for automated safety.ack-deadman: Acknowledges (pings) an active deadman's switch.get-deadman-status: Checks the status of a deadman's switch.update-mmp: Updates the Market Maker Protection (MMP) configuration.reset-mmp: Resets the MMP configuration to its default state.
The plugin's architecture is designed for a clear separation of concerns, ensuring that real-time data handling and transactional operations are managed independently. This is achieved through two primary services that work in tandem.
graph TD
subgraph Eliza Agent
A[Actions & Providers]
end
subgraph Delta Plugin Services
B[DeltaRestClient]
C[DeltaWebSocketService]
end
subgraph External
D[Delta Exchange REST API]
E[Delta Exchange WebSocket API]
end
A -- Makes authenticated calls --> B;
B -- Sends HTTP requests --> D;
D -- Returns trading/account data --> B;
A -- Subscribes to real-time data --> C;
C -- Establishes persistent connection --> E;
E -- Streams market data --> C;
C -- Emits events with new data --> A;
This service is the workhorse for all authenticated, request-response interactions with the Delta Exchange. It is responsible for:
- Authenticated Requests: Securely signing all private requests with your API key and secret using the required HMAC-SHA256 algorithm.
- Trading Actions: Sending requests to place, edit, and cancel orders.
- Account Management: Fetching account data such as positions, margins, and balances.
- Error Handling: Intelligently handling API errors, including rate limits, and providing clear feedback.
This service manages the persistent, real-time connection to the Delta Exchange's WebSocket API. Its key responsibilities include:
- Live Market Data: Subscribing to and receiving live data streams for tickers, order books, and market trades.
- Real-Time Account Updates: Listening for updates on your orders and positions as they happen.
- Connection Management: Automatically handling the WebSocket connection lifecycle, including authentication and reconnection in case of network interruptions.
- Event Emission: Emitting structured events within the Eliza OS agent whenever new data is received, allowing other components to react in real-time.
- Test with Small Amounts: When using this plugin for live trading, always start with small amounts to verify your strategies and configuration.
- API Key Security: Never expose your API secret in client-side code or public repositories. Use environment variables or a secure secret management system.
- Delta Exchange API Documentation: https://docs.delta.exchange/
This project is licensed under the terms of the MIT license. See the LICENSE file for details.