richat

Richat is a streaming system designed to provide low latency and reliable streams of Solana blockchain data.

Richat offers a set of functionality to consume, filter and distribute streams of transactions, accounts and slots:

• Multiplexing, listening to multiple sources and providing a single stream output
• High performance filtering and de-duplication
• QUIC based streaming for higher throughput and lower latency
• gRPC support compatible with Dragon's Mouth clients
• Websockets interface compatible with the Websockets API provided by Agave

Richat can connect to a variety of sources even combining multiple different sources:

• Any Yellowstone Dragon's Mouth / Geyser gRPC compatible streaming endpoint
• Solana nodes running the included richat-plugin-agave plugin
• Solana nodes running the Yellowstone Dragon's Mouth Geyser gRPC plugin
• Other instances of Richat to create hierarchical streaming topologies with filtering at each level (see below)

Use Richat to build your own streaming infrastructure, whether you require websockets for browser clients or gRPC/QUIC for high performance backends. Richat is compatbile with the gRPC endpoints provided by most commerical Solana RPC providers and allows you to leverage a small number of incoming streams to serve a large number of clients.

Please use issues only for reporting bugs or discussing feature-related topics. If you're having trouble loading a plugin or need guidance on how to use crates, please post your question in the Telegram group: https://t.me/lamportsdev

Building and running

Build Richat by running

cargo build --release

Then create a config with your details following the example config.yml and run Richat with:

./target/release/richat --config path/to/your/config.yml

Sponsored by

Blueprint

flowchart LR
    P[plugin] -->|full stream| R1(richat)
    R1 -->|full stream| R2(richat)
    R2 -->|filtered stream| C1(client)
    R1 -->|filtered stream| C2(client)
    R1 -->|filtered stream| C3(client)
    R2 -->|filtered stream| C4(client)

Loading

flowchart LR
    subgraph agave1 [**agave**]
        subgraph geyser1 [richat-plugin-agave]
        end
    end

    subgraph agave2 [**agave**]
        subgraph geyser2 [richat-plugin-agave]
        end
    end

    subgraph richat0 [**richat**]
        subgraph richat0_server [richat-server]
        end
    end

    subgraph richat1 [**richat**]
        subgraph tokio1 [Tokio Runtime]
            richat1_tokio1_receiver(receiver)
            richat1_channel[(messages<br/>storage)]
        end

        subgraph tokio2 [Tokio Runtime]
            subgraph grpc1 [gRPC]
                richat1_grpc1_streaming1(streaming)
                richat1_grpc1_unary(unary)

                richat1_grpc1_blockmeta[(block meta<br/>storage)]
                richat1_grpc1_subscriptions[(clients<br/>subscriptions)]
            end

            subgraph pubsub1 [Solana PubSub]
                richat1_pubsub1_server(server)
            end

            subgraph richat_server1 [Richat]
                richat_server1_sender(server)
            end
        end

        subgraph pubsub1_pool [Filters Thread Pool]
            richat1_pubsub1_pool_worker1(worker 1)
            richat1_pubsub1_pool_worker2(worker N)
        end

        subgraph pubsub1_main [Subscriptions Thread]
            richat1_pubsub1_subscriptions[(clients<br/>subscriptions)]
        end

        subgraph blockmeta_recv [BlockMeta Thread]
            richat1_blockmeta_recv_thread(blockmeta receiver)
        end

        subgraph grpc_workers [gRPC Filters Thread Pool]
            richat1_grpc_worker1(worker 1)
            richat1_grpc_worker2(worker N)
        end
    end

    client1(client)
    client2(client)
    client3(client)

    geyser1 -->|gRPC / Quic<br/>full stream| richat1_tokio1_receiver
    geyser2 -->|gRPC / Quic<br/>full stream| richat1_tokio1_receiver
    richat0_server -->|gRPC / Quic<br/>full stream| richat1_tokio1_receiver
    richat1_tokio1_receiver --> richat1_channel
    richat1_channel --> richat1_blockmeta_recv_thread
    richat1_channel --> richat1_grpc_worker1
    richat1_channel --> richat1_grpc_worker2
    richat1_blockmeta_recv_thread --> richat1_grpc1_blockmeta
    richat1_grpc1_blockmeta <--> richat1_grpc1_unary
    richat1_grpc_worker1 <--> richat1_grpc1_subscriptions
    richat1_grpc_worker2 <--> richat1_grpc1_subscriptions
    richat1_grpc1_subscriptions <--> richat1_grpc1_streaming1
    client1 <--> |gRPC<br/>filtered stream| richat1_grpc1_streaming1
    client1 --> richat1_grpc1_unary
    richat1_channel --> richat_server1_sender
    richat_server1_sender -->|gRPC / Quic<br/>full stream| client2
    richat1_channel --> richat1_pubsub1_subscriptions
    richat1_pubsub1_subscriptions <--> richat1_pubsub1_pool_worker1
    richat1_pubsub1_subscriptions <--> richat1_pubsub1_pool_worker2
    richat1_pubsub1_subscriptions <--> richat1_pubsub1_server
    richat1_pubsub1_server <-->|WebSocket| client3

Loading

Components

• cli — CLI client for full stream, gRPC stream with filters, simple Solana PubSub
• client — library for building consumers
• filter — library for filtering geyser messages
• plugin-agave — Agave validator geyser plugin https://docs.anza.xyz/validator/geyser
• proto — library with proto files, re-imports structs from crate yellowstone-grpc-proto
• richat — app with full stream consumer and producers: gRPC (Dragon's Mouth), Solana PubSub
• shared — shared code between components (except client)

Releases

Branches

• master — development branch
• agave-v2.0 — development branch for agave v2.0
• agave-v2.1 — development branch for agave v2.1
• agave-v2.2 — development branch for agave v2.2

Tags

• cli-v0.0.0
• client-v0.0.0
• filter-v0.0.0
• plugin-agave-v0.0.0
• plugin-agave-v0.0.0+solana.2.1.5
• proto-v0.0.0
• richat-v0.0.0
• shared-v0.0.0

At one moment of time we can support more than one agave version (like v2.0 and v2.1), as result we can have two different major supported versions of every component, for example: cli-v1.y.z for agave-v2.0 and cli-v2.y.z for agave-v2.1. In addition to standard version, plugin-agave can have one or more tags with pinned solana version.

List of RPC providers with Dragon's Mouth support

• Allnodes — https://www.allnodes.com/
• Blockdaemon - https://blockdaemon.com/
• Chainstack — https://chainstack.com/
• ERPC — https://erpc.global/en/
• Gadfly Node — https://gadflynode.com/
• Geeks Labs — https://discord.gg/geekslabs
• GetBlock — https://getblock.io/
• Helius — https://www.helius.dev/
• InstantNodes — https://instantnodes.io/
• OrbitFlare — https://orbitflare.com/
• PixelLabz — https://pixellabz.io/
• Platinum Node — https://www.platinumnode.io/
• PublicNode — https://solana-rpc.publicnode.com/
• QuickNode — https://www.quicknode.com/
• Shyft — https://shyft.to/
• Solana Tracker — https://www.solanatracker.io/solana-rpc
• Solana Vibe Station — https://www.solanavibestation.com/
• SolSqueezer — https://solsqueezer.io/
• Triton One — https://triton.one/
• Urban Node — https://urbannode.io/

If your RPC provider not in the list, please open Issue / PR!