> ## 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.

# Yellowstone 快速入门

> 安装 gRPC 客户端，连接到 OrbitFlare，并发送您的第一个订阅

## 前提条件

您需要：

* Node.js 18+（或 Rust 环境用于 Rust 客户端）
* OrbitFlare gRPC 端点 URL 和令牌（可在您的[仪表板](https://orbitflare.com/dashboard)的**许可证**部分获取）

## 安装

安装官方 Yellowstone gRPC TypeScript 客户端：

```bash theme={null}
npm install @triton-one/yellowstone-grpc
```

或使用 yarn：

```bash theme={null}
yarn add @triton-one/yellowstone-grpc
```

## 连接到您的端点

```typescript theme={null}
import Client, { CommitmentLevel, SubscribeRequest } from "@triton-one/yellowstone-grpc";

const GRPC_URL = "https://your-endpoint.grpc.orbitflare.com";
const X_TOKEN = "YOUR_GRPC_TOKEN";

const client = new Client(GRPC_URL, X_TOKEN, {
  "grpc.max_receive_message_length": 64 * 1024 * 1024, // 64 MiB
});
```

<Note>
  您的 gRPC URL 和令牌可在 OrbitFlare 仪表板的**许可证**部分找到。令牌作为第二个参数传递给 `new Client()`。
</Note>

## 打开流

```typescript theme={null}
const stream = await client.subscribe();

const streamClosed = new Promise<void>((resolve, reject) => {
  stream.on("error", (error) => {
    console.error("流错误:", error);
    reject(error);
    stream.end();
  });
  stream.on("end", () => resolve());
  stream.on("close", () => resolve());
});

stream.on("data", (data) => {
  if (data.slot) {
    console.log("Slot 更新:", data.slot.slot);
  } else if (data.transaction) {
    console.log("交易:", data.transaction);
  } else if (data.account) {
    console.log("账户更新:", data.account);
  } else if (data.pong) {
    console.log("收到 Pong");
  }
});
```

## 发送您的第一个订阅

在 `confirmed` 承诺级别订阅所有 Slot 更新：

```typescript theme={null}
const subscribeRequest: SubscribeRequest = {
  slots: {
    slot: { filterByCommitment: true },
  },
  commitment: CommitmentLevel.CONFIRMED,
  accounts: {},
  accountsDataSlice: [],
  transactions: {},
  transactionsStatus: {},
  blocks: {},
  blocksMeta: {},
  entry: {},
};

await new Promise<void>((resolve, reject) => {
  stream.write(subscribeRequest, (err) => {
    if (err == null) resolve();
    else reject(err);
  });
});

await streamClosed;
```

## 保持连接活跃

云负载均衡器会在约 10 分钟不活动后终止空闲的 gRPC 连接。每 30 秒发送一次 ping：

```typescript theme={null}
const pingRequest: SubscribeRequest = {
  ping: { id: 1 },
  accounts: {},
  accountsDataSlice: [],
  transactions: {},
  transactionsStatus: {},
  blocks: {},
  blocksMeta: {},
  slots: {},
  entry: {},
};

const pingInterval = setInterval(async () => {
  await new Promise<void>((resolve, reject) => {
    stream.write(pingRequest, (err) => {
      if (err == null) resolve();
      else reject(err);
    });
  });
}, 30_000);

streamClosed.finally(() => clearInterval(pingInterval));
```

## 重连机制

对于生产应用程序，实现带指数退避的自动重连：

```typescript theme={null}
async function connectWithRetry(maxRetries = 10) {
  let attempt = 0;
  let delay = 1000;

  while (attempt < maxRetries) {
    try {
      const stream = await client.subscribe();
      // ... 附加处理器并发送订阅
      await streamClosed;
      break;
    } catch (err) {
      attempt++;
      console.error(`流错误（第 ${attempt} 次尝试）:`, err);
      if (attempt >= maxRetries) throw err;
      await new Promise((r) => setTimeout(r, delay));
      delay = Math.min(delay * 2, 30_000);
    }
  }
}
```

## 下一步

<CardGroup cols={2}>
  <Card title="账户监控" icon="user" href="/cn/data-streaming/yellowstone-account-monitoring">
    流式传输代币余额、钱包变化和程序账户更新。
  </Card>

  <Card title="交易监控" icon="receipt" href="/cn/data-streaming/yellowstone-transaction-monitoring">
    按程序或账户过滤和处理实时交易。
  </Card>

  <Card title="Slot 与区块" icon="cube" href="/cn/data-streaming/yellowstone-slot-block-monitoring">
    追踪共识进度和完整区块数据。
  </Card>

  <Card title="条目监控" icon="code" href="/cn/data-streaming/yellowstone-entry-monitoring">
    访问低级区块条目。
  </Card>
</CardGroup>