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.

Hyperstack provides official SDKs for multiple languages and frameworks, making it easy to integrate real-time Solana data streaming into your applications.

Available SDKs

TypeScript

Pure TypeScript SDK for Node.js and web applications

React

React SDK with hooks for building real-time UIs

Rust

High-performance Rust client SDK

Python

Python SDK for backend services (work in progress)

SDK Comparison

SDKPackageVersionStatusUse Case
TypeScripthyperstack-typescript0.5.3StableNode.js, web apps, any JavaScript framework
Reacthyperstack-react0.5.3StableReact applications with hooks
Rusthyperstack-sdk0.5.3StableHigh-performance services, CLI tools
Pythonhyperstack-sdk0.1.0WIPBackend services, data pipelines

Quick Start

TypeScript

npm install hyperstack-typescript
import { HyperStack } from 'hyperstack-typescript';
import { MY_STACK } from './generated/my-stack';

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

for await (const update of hs.views.myView.list.watch()) {
  console.log('Update:', update);
}

React

npm install hyperstack-react
import { HyperstackProvider, useHyperstack } from 'hyperstack-react';

function App() {
  return (
    <HyperstackProvider config={{ url: 'wss://mainnet.hyperstack.xyz' }}>
      <MyComponent />
    </HyperstackProvider>
  );
}

function MyComponent() {
  const stack = useHyperstack(myStack);
  const data = stack.views.myView.use();
  return <div>{data.length} items</div>;
}

Rust

[dependencies]
hyperstack-sdk = "0.5"
use hyperstack_sdk::prelude::*;

#[tokio::main]
async fn main() -> anyhow::Result<()> {
    let hs = HyperStack::connect("wss://mainnet.hyperstack.xyz").await?;
    
    let mut stream = hs.watch::<MyEntity>();
    while let Some(update) = stream.next().await {
        println!("Update: {:?}", update);
    }
    
    Ok(())
}

Python

The Python SDK is under active development and has not yet been published to PyPI.
# Not yet published - install from source
git clone https://github.com/hypertekorg/hyperstack
cd hyperstack/python/hyperstack-sdk
pip install -e .
from hyperstack import HyperstackClient

client = HyperstackClient()
await client.connect()

Common Features

All SDKs provide:
  • Real-time streaming - Subscribe to live data updates via WebSocket
  • Type safety - Full type definitions generated from your stack spec
  • Auto-reconnection - Automatic reconnection with configurable backoff
  • State management - Built-in entity store with key-value lookups
  • Multiple view types - Support for state, list, and derived views
  • One-shot queries - Fetch current state without streaming

Choosing the Right SDK

Use TypeScript if:

  • You’re building a Node.js backend or web application
  • You need framework-agnostic streaming with AsyncIterables
  • You want maximum compatibility across JavaScript runtimes

Use React if:

  • You’re building a React application
  • You want hooks-based integration (use(), useOne())
  • You need built-in state management with Zustand

Use Rust if:

  • You need maximum performance and low latency
  • You’re building CLI tools or backend services
  • You want compile-time type safety and zero-cost abstractions

Use Python if:

  • You’re building data pipelines or analytics tools
  • You need integration with Python data science libraries
  • You prefer async/await Python syntax

SDK Generation

Generate type-safe SDKs from your stack specification using the Hyperstack CLI:
# Generate TypeScript SDK
hs sdk create typescript my-stack

# Generate Rust SDK
hs sdk create rust my-stack

# Generate Python SDK
hs sdk create python my-stack
See the CLI documentation for more details.

Next Steps

TypeScript SDK

Learn about the TypeScript SDK

React SDK

Build real-time React UIs

Rust SDK

High-performance streaming

Python SDK

Backend integration (WIP)

Build docs developers (and LLMs) love