Skip to main content

安装

构建客户端

以下示例启用全部选项:
最简配置:

构建器方法

.url(url) — 主 gRPC 端点。回退读取环境变量 ORBITFLARE_GRPC_URL
.urls(&[...]) — 一次设置主端点与备用端点。第一个元素为主端点。
.fallback_url(url) / .fallback_urls(&[...]) — 添加备用端点。连接失败时 SDK 会轮换尝试。
.retry(policy) — 控制重连退避。连接断开时,SDK 先等待 initial_delay,随后每次尝试加倍(上限 max_delay)。将 max_attempts 设为 0 表示无限重试。默认:初始 100ms、最大 30s、2 倍乘数、无限次。
.timeout_secs(n) — 单次 gRPC 请求超时。默认:30。
.keepalive_secs(n) — TCP keepalive 间隔。操作系统按此间隔发送探测以在 TCP 层检测死亡连接。默认:60。
.ping_interval_secs(n) — SDK 发送协议层 Ping 的频率。服务端应以 Pong 回应。默认:10。
.max_missed_pongs(n) — 连续多少次 Ping 无应答后,SDK 认为连接已死并重连。默认:3。在默认参数下,约 30 秒内可检测到死亡连接。
.channel_capacity(n) — 后台任务与你的代码之间的有界通道容量。若消费事件较慢,后台任务在填满时会阻塞,而非无限占用内存。默认:4096。

编写 YAML 配置

创建包含所需过滤器的 YAML 文件:

YAML 过滤器参考

transactions — 每个条目是一个命名过滤器。若交易涉及任一 account_include 地址则匹配。account_exclude 排除匹配。account_required 表示所列地址必须全部出现。votefailed 按交易类型过滤。 accounts — 按地址监视特定账户,或通过 owner 监视某程序拥有的全部账户。 slots — 订阅槽位更新。filter_by_commitment 仅在你设定的承诺级别发送更新。 commitment"processed""confirmed""finalized"。默认为 "confirmed" YAML 支持 ${ENV_VAR} 展开:

订阅与读取事件

自 YAML

编程方式

运行时动态构建过滤器:

读取流

subscribe_yamlsubscribe 均返回 GeyserStream。调用 .next() 获取下一条事件:
stream.next() 会阻塞直到事件到达。流关闭时返回 None。每条事件为 ResultErr 表示已用尽全部重试且连接永久不可用。 Pong 消息在内部消费,不会出现在你的流中。

关闭

立即停止后台任务。或直接丢弃流。

多路流

一个客户端可同时运行多条流。每条流使用独立的后台连接:
它们共享端点健康状态 — 若某条流将失败端点隔离,其他流在下次重连时会跳过该端点。但各流的连接与生命周期完全独立。 可随时新建流,包括根据已有流的数据动态创建。

完整示例

监听 pump.fun 交易、解码签名并打印每条摘要的流:
配合以下 grpc.yml