Yellowstone gRPC 快速入门

配置 TypeScript 客户端、API token 和心跳处理，接收首批 Solana 区块更新。

先订阅区块元数据，验证连接而无需下载完整区块。其他 Yellowstone 指南复用下方辅助代码。

​

安装与配置

使用 Node.js 20 或更新版本。示例基于 @triton-one/yellowstone-grpc 7.0.1；通过 tsx 运行时保留 .mts 扩展名。

npm install @triton-one/yellowstone-grpc@7.0.1 bs58
npm install --save-dev typescript tsx @types/node
export GRPC_ENDPOINT="https://grpc.solanatracker.io"
export GRPC_API_TOKEN="YOUR_API_TOKEN"

​

创建订阅辅助模块

保存为 stream.mts。模块填充必需的请求映射，回复服务端 ping，并在消费结束时关闭数据流。断线错误会传递给调用方。

stream.mts

import Yellowstone, {
  CommitmentLevel,
  type SubscribeRequest,
  type SubscribeUpdate,
} from "@triton-one/yellowstone-grpc";

const Client = typeof Yellowstone === "function" ? Yellowstone : Yellowstone.default;

export function makeRequest(
  filters: Partial<SubscribeRequest> = {},
): SubscribeRequest {
  return {
    accounts: {}, slots: {}, transactions: {}, transactionsStatus: {},
    blocks: {}, blocksMeta: {}, entry: {}, accountsDataSlice: [],
    commitment: CommitmentLevel.CONFIRMED,
    ...filters,
  };
}

export async function* subscribe(
  filters: Partial<SubscribeRequest>,
): AsyncGenerator<SubscribeUpdate> {
  const token = process.env.GRPC_API_TOKEN;
  if (!token) throw new Error("Set GRPC_API_TOKEN before starting");
  const endpoint = process.env.GRPC_ENDPOINT ?? "https://grpc.solanatracker.io";
  // This helper exposes disconnects to the caller instead of auto-reconnecting.
  const client = new Client(endpoint, token, undefined, { enabled: false });
  const stream = await client.subscribe(makeRequest(filters));
  try {
    for await (const update of stream) {
      if (update.ping) {
        await new Promise<void>((resolve, reject) => {
          stream.write(makeRequest({ ping: { id: 1 } }), (error?: Error | null) => {
            if (error) reject(error);
            else resolve();
          });
        });
        continue;
      }
      if (!update.pong) yield update;
    }
  } finally {
    stream.destroy();
  }
}

​

接收区块元数据

blocks.mts

import { subscribe } from "./stream.mts";

for await (const update of subscribe({ blocksMeta: { blocks: {} } })) {
  if (!update.blockMeta) continue;
  console.log({
    slot: update.blockMeta.slot,
    blockhash: update.blockMeta.blockhash,
    transactions: update.blockMeta.executedTransactionCount,
  });
}

npx tsx blocks.mts

每条记录包含 slot、blockhash 和已执行交易计数。按 Ctrl+C 停止。未收到数据时，按照身份验证指南检查 token 与端点。

​

正确读取数据

公钥与签名以字节形式返回，显示时转换为 base58。客户端将 protobuf 64 位整数表示为字符串；格式化前使用字符串或 BigInt 保存原始余额。

​

相关指南

账户更新

交易

可靠性与性能