Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arturogonzalezm/binance_websocket_client
This project connects to Binance's WebSocket API to process real-time cryptocurrency data using the observer pattern.
https://github.com/arturogonzalezm/binance_websocket_client
binance-api elixir elixir-lang elixir-programming-language real-time websockets
Last synced: 3 days ago
JSON representation
This project connects to Binance's WebSocket API to process real-time cryptocurrency data using the observer pattern.
- Host: GitHub
- URL: https://github.com/arturogonzalezm/binance_websocket_client
- Owner: arturogonzalezm
- License: mit
- Created: 2024-08-03T12:39:12.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-08-03T14:42:13.000Z (about 2 months ago)
- Last Synced: 2024-08-04T14:33:04.681Z (about 2 months ago)
- Topics: binance-api, elixir, elixir-lang, elixir-programming-language, real-time, websockets
- Language: Elixir
- Homepage:
- Size: 17.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Binance WebSocket Client
This project implements a WebSocket client for the Binance cryptocurrency exchange, specifically for receiving real-time ticker updates for the BTCUSDT trading pair.
## Features
- Real-time WebSocket connection to Binance
- Ticker data storage and retrieval
- Subscription system for receiving updates
- Configurable filtering of updates
## Prerequisites
- Elixir 1.17 or later
- Erlang (SMP,ASYNC_THREADS) (BEAM) emulator version 14.2.5
- Erlang/OTP 26
- IntelliJ IDEA Version 2023.3.7 with Elixir plugin (optional)
- Homebrew
- asdf for Elixir version management
## Installation
1. Clone the repository:
```bash
git clone https://github.com/arturogonzalezm/binance_websocket_client.git
cd binance_websocket_client
```
2. Fetch dependencies:
```bash
mix deps.get
```
3. Compile the project:
```bash
mix compile
```
4. Test:
```bash
mix test
```
## Usage
To start the application:
```bash
iex -S mix
```
```elixir
Application.stop(:binance_websocket_client)
```
```elixir
Application.start(:binance_websocket_client)
```
This will start the WebSocket client and connect to Binance's WebSocket server.
### Creating a Subscriber
To receive updates:
```elixir
handler = fn ticker -> IO.inspect(ticker, label: "Received ticker update") end
{:ok, pid} = BinanceWebsocketClient.Subscriber.start_link(handler: handler)
```
To filter updates:
```elixir
filter = fn ticker -> String.to_float(ticker["P"]) > 1.0 end
{:ok, pid} = BinanceWebsocketClient.Subscriber.start_link(handler: handler, filter: filter)
```
## Architecture
### Flowchart
```mermaid
graph TD
A[Binance WebSocket Server] -->|WebSocket Connection| B(BinanceWebsocketClient)
B -->|Updates| C{TickerStore}
C -->|Notify| D[Subscriber 1]
C -->|Notify| E[Subscriber 2]
C -->|Notify| F[Subscriber N]
```
### Sequence Diagram
```mermaid
sequenceDiagram
participant Binance as Binance WebSocket Server
participant Client as BinanceWebsocketClient
participant Store as TickerStore
participant Sub as Subscriber
Sub->>Store: subscribe()
Binance->>Client: Ticker Update
Client->>Store: update(ticker_data)
Store->>Sub: notify(ticker_data)
Sub->>Sub: handle(ticker_data)
```
## Running Tests
To run the test suite:
```
mix test
```
## TODO:
- Dockerise the Application
- Add docker-compose file
- Add CI/CD pipeline
- Add more tests
- Add InfluxDB for storing ticker data
- Add Grafana for visualising ticker data
- Add Prometheus for monitoring the application
- Add Kubernetes for deploying the application
- Add Helm for managing the Kubernetes deployment
- Add Terraform for managing the infrastructure
- Add Ansible for managing the configuration
- Add Jenkins for automating the CI/CD pipeline
- Add SonarQube for code quality analysis
- Add ELK Stack for log management
- Add Jaeger for distributed tracing
- Add OpenTelemetry for observability
- Add Sentry for error tracking
- Add New Relic for application performance monitoring
- Add Datadog for infrastructure monitoring
- Build a front-end for visualising the data in real-time using Phoenix LiveView
## License
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.