Server Overview

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/hypertekorg/hyperstack/llms.txt

Use this file to discover all available pages before exploring further.

​

Architecture

​

Key Features

​

Real-time Streaming

• State - Watch a single entity by key (latest value only)
• List - Subscribe to collections of entities
• Append - Stream append-only data

​

High Performance

• Bytecode Execution - Pre-compiled transformations run in a custom VM
• LRU Caching - State tables, lookups, and resolvers all use LRU eviction
• Concurrent Processing - Built on Tokio async runtime
• Compression - Optional gzip compression for large payloads

​

Reliability

• Health Monitoring - Track stream status and connectivity
• Automatic Reconnection - Exponential backoff for gRPC streams
• Graceful Shutdown - Handles SIGINT/SIGTERM signals

​

Observability

• Structured Logging - JSON logs with tracing spans
• OpenTelemetry - Optional OTLP metrics and traces (enable otel feature)
• Health Endpoints - HTTP health checks for liveness/readiness

​

Data Flow

1. Yellowstone gRPC - Streams blockchain data (accounts, transactions, instructions)
2. Vixen Parser - Deserializes protobuf messages into events
3. VM/Interpreter - Transforms events into entity mutations via bytecode
4. Projector - Routes mutations to appropriate buses and caches
5. Entity Cache - Stores current state for snapshot delivery
6. WebSocket Clients - Receive real-time updates

​

Getting Started

use hyperstack_server::{Server, Spec};

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    Server::builder()
        .spec(my_spec())
        .websocket()
        .bind("[::]:8877".parse()?)
        .health_monitoring()
        .start()
        .await
}

​

Next Steps