diff --git a/add-ons/yellowstone-grpc-api/README.md b/add-ons/yellowstone-grpc-api/README.md index 1da2f515..d0ee175c 100644 --- a/add-ons/yellowstone-grpc-api/README.md +++ b/add-ons/yellowstone-grpc-api/README.md @@ -3,21 +3,121 @@ description: >- Power your Solana dApps and backends with the fastest, most reliable streaming data available. Yellowstone gRPC add-on is for apps that need every live event as fast as the network can deliver. -layout: - width: default - title: - visible: true - description: - visible: true - tableOfContents: - visible: true - outline: - visible: false - pagination: - visible: true - metadata: - visible: false --- # Yellowstone gRPC API +## Overview + +**Yellowstone gRPC** is a high-performance Solana Geyser plugin that provides real-time streaming access to on-chain data. Built by Triton One, it delivers blocks, transactions, and account updates with millisecond-level latency directly from Solana validators. + +GetBlock offers **managed Yellowstone gRPC endpoints** as an add-on to Dedicated Solana Node subscriptions, eliminating the need for infrastructure setup and maintenance. + +*** + +## Key Features + +* **Near-zero latency**: Streams data directly from validators, often hundreds of milliseconds faster than standard RPC/WebSocket APIs +* **High throughput**: Handles millions of events per minute under load +* **Comprehensive streaming**: Monitor accounts, transactions, blocks, slots, and program interactions in real-time +* **Rich filtering**: Subscribe only to relevant updates using account keys, owner programs, or commitment levels +* **Protobuf encoding**: Receive parsed, typed messages instead of raw base64 data +* **Bidirectional streaming**: Maintain long-lived connections with built-in keep-alives + +*** + +## Supported Data Streams + +Yellowstone gRPC supports streaming the full range of Solana events: + +| Stream Type | Description | +| ---------------- | ---------------------------------------------------------------- | +| **Accounts** | Real-time account updates including lamports, owner, and data | +| **Transactions** | Full transaction data with metadata and instruction details | +| **Blocks** | Block metadata including slot, parent slot, and timestamp | +| **Slots** | Slot notifications as they're processed by the leader | +| **Block Meta** | Block metadata with transaction counts and execution status | + +*** + +## Use Cases + +Yellowstone gRPC is ideal for time-sensitive applications that need to react instantly to on-chain state changes: + +* High-frequency trading and MEV bots +* On-chain indexers and data archives +* Real-time analytics dashboards +* DEX monitors and price feeds +* DeFi strategy engines +* Alerting and notification systems +* NFT marketplace trackers +* Wallet activity monitors + +{% hint style="info" %} +**Note**: gRPC is not supported in browsers. Yellowstone is designed for backend services and server-side applications. +{% endhint %} + +*** + +## Getting Started + +
| Overview | Learn how Yellowstone gRPC works and why it's essential for real-time Solana applications | overview.md |
| Quickstart Guide | Enable the add-on and start streaming data with code examples in TypeScript, Python, Go, and Rust | quickstart-guide.md |