teknosgpt/rader-bot

Raderbot is a Rust-based trading bot designed to interact with the BingX WebSocket API for market data analysis and trading operations.

Raderbot

Table of Contents

• Overview
• Features
• Development
• Contributing
• License

Overview

Raderbot is a Rust-based trading bot designed to interact with the BingX WebSocket API for market data analysis and trading operations. It utilizes the Actix Web framework for building a WebSocket server and handling incoming messages. The bot connects to the BingX WebSocket API to receive real-time market data updates, including ticker information. It performs various operations on the received data, such as calculating time differences, generating unique identifiers, parsing JSON responses, and handling errors using custom error types. The bot also includes functionalities for file operations, such as creating and appending data to files. It leverages external crates like reqwest for making HTTP requests and tungstenite for WebSocket communication.

Features

• Connects to the BingX WebSocket API to receive real-time market data updates.
• Calculates time differences between timestamps.
• Generates unique identifiers in a specific format.
• Parses JSON responses received from API calls.
• Handles errors using custom error types.
• Performs file operations, including creating and appending data to files.
• Utilizes external crates like reqwest and tungstenite.

Roadmap

The project is currently in the development phase.

Development

Prerequisites

Make sure you have the following tools installed on your system:

• Rust: The programming language used for the project.
• cargo-watch: Used for automatically restarting the server during development.
• make: Used for managing development tasks.

Getting Started

1. Clone the repository:

   git clone https://github.com/subaquatic-pierre/rader-bot.git
   

2. Navigate to the project directory:

cd rader-bot

3. Build and run the project:

make watch

This command will start the Actix server and automatically restart it when code changes are detected.

Cleaning Up

To clean up build artifacts, run:

make clean

Contributing

We welcome contributions from the community! If you would like to contribute to the project, please follow these guidelines:

• Fork the repository.
• Create a new branch: git checkout -b my-branch.
• Make your changes and commit them: git commit -am 'Add new feature'.
• Push to the branch: git push origin my-branch.
• Submit a pull request.

License

This project is licensed under the MIT License.