Skip to main content

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.

​
Introduction to Hyperstack

Hyperstack is a real-time streaming data pipeline framework for Solana that transforms on-chain events into typed state projections. Build responsive applications that react to blockchain state changes in milliseconds, not seconds.

​
What is Hyperstack?

Hyperstack provides a complete solution for streaming Solana program data:
  • Real-time streaming: WebSocket-based updates as on-chain state changes
  • Type-safe projections: Transform raw blockchain data into structured entities
  • Multi-language SDKs: First-class support for Rust, TypeScript, React, and Python
  • Production-ready: Auto-reconnection, state management, and error handling built-in

Quickstart

Get up and running with a working example in minutes

Installation

Install Hyperstack packages for your preferred language

Core Concepts

Understand stacks, views, and streaming patterns

CLI Reference

Deploy and manage stacks with the Hyperstack CLI

​
How it works

Hyperstack transforms on-chain Solana events into structured, queryable state projections:
1

Define your stack

Create stream definitions that specify how to transform on-chain data into typed entities.
2

Deploy to production

Use the Hyperstack CLI to deploy your stack and get a WebSocket endpoint.
hs up
3

Connect and stream

Subscribe to real-time updates using one of the client SDKs.
import { HyperStack } from 'hyperstack-typescript';

const hs = await HyperStack.connect('wss://mainnet.hyperstack.xyz', {
  stack: MY_STACK,
});

for await (const update of hs.views.myEntity.list.watch()) {
  console.log('Entity updated:', update.data);
}

​
Key features

​
Type-safe streaming

All SDKs provide fully typed entities and views. Your IDE provides autocomplete, and the compiler catches errors before runtime.

​
Framework agnostic

The TypeScript SDK works with any framework (Vue, Svelte, Node.js), while the React SDK provides hooks for React applications.

​
Production ready

  • Auto-reconnection: Handles connection drops with configurable backoff
  • State management: Client-side caching and synchronization
  • Rich updates: Track before/after diffs for entity changes
  • Multiple view types: State views (single entity), list views (collections), and derived views

​
Architecture

Hyperstack consists of several components:
ComponentPurpose
hyperstackRust umbrella crate re-exporting all components
hyperstack-interpreterAST transformation runtime and VM
hyperstack-macrosProc-macros for stream definitions
hyperstack-serverWebSocket server and projection handlers
hyperstack-cliCLI tool for deployment and SDK generation
hyperstack-sdkRust client SDK
hyperstack-typescriptPure TypeScript SDK (framework-agnostic)
hyperstack-reactReact SDK with hooks
hyperstack-sdk (Python)Python client SDK (work in progress)
The Python SDK is currently under active development and has not yet been published to PyPI.

​
Use cases

  • DeFi dashboards: Real-time token prices, liquidity pools, and trading activity
  • Gaming: Live leaderboards, player stats, and game state
  • NFT platforms: Instant updates on mints, transfers, and marketplace activity
  • Analytics: Real-time metrics and aggregations from on-chain data
  • Monitoring: Track program state changes and trigger alerts

​
Next steps

Quickstart

Build your first Hyperstack application

Installation

Install packages for Rust, TypeScript, or React

Build docs developers (and LLMs) love

Get started for freeTalk to us