> ## Documentation Index
> Fetch the complete documentation index at: https://docs.orbitflare.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 概述

> 构建 OrbitFlare 应用的官方客户端库：RPC、gRPC（Yellowstone）、JetStream 和 WebSocket，内置重试、故障转移与重连。

OrbitFlare SDK 为每项 OrbitFlare 服务提供类型化客户端。无需自行管理原始 HTTP 请求、gRPC 通道与 WebSocket 连接，SDK 在简洁 API 背后处理连接生命周期、身份验证、重试、故障转移与重连。

## 包含内容

| 服务                    | 作用                                                                                                 |
| --------------------- | -------------------------------------------------------------------------------------------------- |
| **RPC**               | 面向常见 Solana 方法的 JSON-RPC 客户端及类型化辅助方法，另含任意自定义调用的原始出口                                                |
| **WebSocket**         | 账户变更、日志、槽位与签名的订阅，重连后自动重新订阅                                                                         |
| **gRPC（Yellowstone）** | Yellowstone Geyser 流式传输——交易、账户、槽位、区块。支持 YAML 配置或编程式过滤器                                             |
| **JetStream**         | OrbitFlare 解码后的碎片以 gRPC 流形式投递。与 Yellowstone 使用相同的客户端模式，协议不同。v1（固定过滤器）与 v2（运行时管理的过滤器、序列号、可选富化、槽位事件） |

## 环境变量

| 变量                         | 使用者           | 用途                  |
| -------------------------- | ------------- | ------------------- |
| `ORBITFLARE_LICENSE_KEY`   | RPC、WebSocket | 附加到端点 URL 的 API 密钥  |
| `ORBITFLARE_RPC_URL`       | RPC           | 未调用 `.url()` 时的默认端点 |
| `ORBITFLARE_WS_URL`        | WebSocket     | 未调用 `.url()` 时的默认端点 |
| `ORBITFLARE_GRPC_URL`      | gRPC          | 未调用 `.url()` 时的默认端点 |
| `ORBITFLARE_JETSTREAM_URL` | JetStream     | 未调用 `.url()` 时的默认端点 |

## 源码

SDK 为开源：

* Rust: [github.com/orbitflare/orbitflare-sdk-rs](https://github.com/orbitflare/orbitflare-sdk-rs)
* TypeScript: [github.com/orbitflare/orbitflare-sdk-ts](https://github.com/orbitflare/orbitflare-sdk-ts)
* Go: [github.com/orbitflare/orbitflare-sdk-go](https://github.com/orbitflare/orbitflare-sdk-go)