Sonar

A high-performance, open-source data platform for the Solana ecosystem.

---

Sonar is a modular indexing and analytics platform for the Solana blockchain. It does the heavy lifting of capturing, processing, and serving real-time and historical on-chain data, so you can focus on building your application.

🤔 Why Sonar?

Accessing reliable, low-latency, and comprehensive DeFi data on Solana is complex and expensive. Sonar solves this by providing a self-hostable, open-source solution that is both powerful and flexible.

Who is this for?

• DeFi Developers: Build sophisticated applications on top of a solid data foundation.
• Data Analysts & Researchers: Query rich, granular historical data to uncover market insights.
• Arbitrageurs & MEV Searchers: Get a real-time firehose of on-chain events to feed your trading strategies.
• Infrastructure Providers: Offer reliable data endpoints as a service to your users.

✨ Features

• High-Performance Ingestion: Connects directly to a Solana Geyser plugin for microsecond-level data capture.
• Modular & Scalable: Services for ingestion, API, and scheduling are independent crates, allowing them to be scaled separately.
• Multi-Protocol DEX Support: Includes processors for a wide range of DEX protocols on Solana (Raydium, Orca, Meteora, etc.).
• Real-time & Historical Data: Provides WebSocket streams for live data and a REST API for historical queries.
• Extensible by Design: Easily add support for new protocols or data types.

🚀 Getting Started

Sonar is designed for easy setup. Follow these steps to get your local development environment running.

Prerequisites

• Rust: See rust-toolchain.toml for the exact version.
• Docker & Docker Compose: For running all services (Sonar components, Redis, ClickHouse).
• Access to Solana Data:
  • For full, low-latency performance: A Solana node with the Geyser plugin.
  • For basic functionality and development: A standard Solana RPC endpoint.

1. Clone the Repository

git clone https://github.com/sola-hq/sonar-rs.git
cd sonar-rs

2. Configure Your Environment

Copy the example environment file and fill in the required values. Crucially, ensure your .env file contains correct connection strings for Redis and ClickHouse, as these are now managed by Docker Compose.

cp .env.example .env
# Example .env entries for Docker Compose:
# REDIS_URL=redis://redis:6379/
# DATABASE_URL=clickhouse://default:@clickhouse:8123/default

3. Run All Services with Docker Compose (Recommended)

This is the easiest way to get all Sonar components and their dependencies (Redis, ClickHouse) running locally.

docker-compose up --build # --build will build the sonar images if not present

Once started, you can access the API at http://localhost:8000/swagger-ui (or your configured API port).

Manual Build & Run (Advanced)

If you prefer to run services outside of Docker Compose, you can build and run them manually.

Build the project in release mode:

cargo build --release sonar

Each service can be run using the main sonar binary in a separate terminal. Ensure your Redis and ClickHouse instances are running and accessible.

Start the API Server:

./target/release/sonar api
# or
cargo run -p sonar-api

Start the Ingestor (Node):

# or
cargo run -p sonar-ingestor

Start the Scheduler:

./target/release/sonar scheduler candlestick
# or
cargo run -p sonar-scheduler

🏗️ Architecture

The system is composed of several key services that communicate via a message queue (e.g., Redis).

graph TD
	subgraph "Data Sources"
		Geyser[Solana Geyser]
		WebSocket[Solana WebSocket]
		Helius[Helius Enhanced WebSocket]
		Binance[External APIs e.g., Binance]
		CoinGecko[External APIs e.g., CoinGecko]
	end

	subgraph "Sonar Services"
		Ingestor[Ingestor]
		Scheduler[Scheduler]
		API[API Server]
		SOLPRICE[sol-price]
	end

	subgraph "Infrastructure"
        MQ[(MQ-Redis)]
        CK[(ClickHouse)]
        CACHE[(Redis Cache)]
	end

	subgraph "Users"
		HTTP[HTTP Clients]
		WS[WebSocket Clients]
	end

	%% Data Sources to Services
	Geyser -->|transaction data| Ingestor
	WebSocket -->|transaction data| Ingestor
	Helius -->|transaction data| Ingestor
	Binance -->|SOL/USD price| SOLPRICE
	CoinGecko -->|token prices| SOLPRICE
	
	%% Services to Infrastructure
	Ingestor -->|token data, prices| CACHE
	Ingestor -->|price events| MQ
	Ingestor -->|processed events| CK
	Scheduler -->|read/write| CK
	API -->|read| CK
	API -->|consume events| MQ
	SOLPRICE -->|price updates| CACHE
	SOLPRICE -->|price events| MQ
	
	%% Users to Services
	HTTP -->|REST API| API
	WS -->|WebSocket API| API
	
	%% Styling
	classDef dataSource fill:#e1f5fe,stroke:#01579b,stroke-width:2px
	classDef service fill:#f3e5f5,stroke:#4a148c,stroke-width:2px
	classDef infrastructure fill:#e8f5e8,stroke:#1b5e20,stroke-width:2px
	classDef user fill:#fff3e0,stroke:#e65100,stroke-width:2px
	
	class Geyser,WebSocket,Helius,Binance,CoinGecko dataSource
	class Ingestor,Scheduler,API,SOLPRICE service
	class MQ,CK,CACHE infrastructure
	class HTTP,WS user

Loading

🤝 Contributing

We welcome contributions of all kinds! A great way to start is by looking at our open issues. Please feel free to submit a pull request or open an issue.

For more detailed guidelines, please see our CONTRIBUTING.md file (coming soon!).

📄 License

This project is licensed under the MIT License. See the LICENSE file for details.