feat(nip-01): send the rate-limited backoff hint on CLOSED (the half of nostr-protocol/nips#2498 the relay does not send)
维护者通常 1 天内回复
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 45/100
- Issue 类型
- 功能
- 描述清晰度
- 基本清楚
- 活跃度
- 活跃
- 技术栈
- typescript
调研方向
Start with src/utils/messages.ts and src/@types/messages.ts for the existing OK and CLOSED patterns, then compare the read gates in src/adapters/web-socket-adapter.ts and src/handlers/subscribe-message-handler.ts. Decide which gate should emit the hint, since the issue describes two options and neither currently sends CLOSED for rate limiting. Add the constructor and wire-frame tests described in the issue, including the relay probe check; done means a rate-limited CLOSED carries the optional milliseconds parameter and existing behavior remains covered.
由索引模型根据 Issue 内容生成。
描述
feat(nip-01): send the rate-limited backoff hint on CLOSED
nostr-protocol/nips#2498 ("Add an extra parameter to the CLOSED and OK messages") appends an optional trailing parameter to both messages:
["OK", <event_id>, <true|false>, <message>, <?params>]["CLOSED", <subscription_id>, <message>, <?params>]
rate-limited is the one pair the PR standardizes: a zero-free decimal string of a positive integer in milliseconds, read as "back off this long before sending the relay the same message type that tripped the limit". It MAY be approximate, and its absence MUST NOT be read as an instruction to retry immediately. The text's own example for this side: ["CLOSED", "sub1...", "rate-limited: slow down there chief", "2500"].
Half of it shipped; this is the other half
PR #807 implemented the OK side and shipped it in 3.3.0 — createCommandResult (src/utils/messages.ts:32) now takes params?: string, and the hint is Math.max(1, Math.ceil(period)) ms of the first rate-limit window that tripped. It closed #805 with its own body stating the boundary: "CLOSED is untouched, since nostream never sends rate-limited on it."
That statement is still true on main (4cf419f), and so is the plumbing gap:
createClosedMessage(src/utils/messages.ts:43) builds a fixed[CLOSED, queryId, reason].ClosedMessage(src/@types/messages.ts:89-93) declares0,1,2and no optional3.
Can nostream support it? The message is a one-parameter change; the message source is the gap
Adding the parameter is the same shape #807 already did for OK — one optional argument on a shared helper and its type. What does not exist is any site that would emit it, because nothing that gates a read answers with a CLOSED today. Verified on main 4cf419f:
| where a read is gated | what the client gets today | file:line |
|---|---|---|
per-IP raw-message limiter (also covers REQ) |
["NOTICE", "rate limited"], message dropped |
src/adapters/web-socket-adapter.ts:203-204 |
REQ refused (duplicate, too many, limits) |
NOTICE "Subscription rejected: ..." |
src/handlers/subscribe-message-handler.ts:59 |
| NIP-42 restricted read | CLOSED "auth-required: ..." — not rate-limit-keyed |
src/handlers/subscribe-message-handler.ts:68 |
| connection limiter | socket terminated, no protocol message | src/adapters/web-socket-server-adapter.ts |
| stream end / truncation | EOSE |
src/handlers/subscribe-message-handler.ts:208,237 |
So the parameter has nowhere to attach, and the NIP's wording makes this a design call rather than plumbing: the value means "back off the same message type that tripped it", while nostream's read-side throttle is message-type-agnostic and sits above the handler (the event.rateLimits limiter from #807 is write-only — REQ/COUNT never touch it).
Two honest options:
- Speak
CLOSEDfrom the existing read-side throttle when the message is aREQ—src/adapters/web-socket-adapter.ts:203-204has the subscription id in hand asmessage[1]before dispatch. Cheapest, but it changes a frame every client already sees, and the limiter would need a per-message-type prefix. - Add a
REQ-scoped limiter in the subscribe handler, beside the existing authCLOSEDatsrc/handlers/subscribe-message-handler.ts:68, so the value means what the NIP says it means: this subscription class, this window.
Either way, the emission site is roughly five lines next to a precedent that already exists, plus the helper/type change.
Related, and worth separating
The argument for the parameter in the PR thread (jb55, from the strfry side) is that the hint only helps if the cut-off is visible: a relay that stops delivering a REQ's stored events early should end with CLOSED "rate-limited: ..." and MUST NOT send EOSE, because a client that received some EVENTs and then EOSE cannot tell a short result from a complete one. Nostream's stream ends at EOSE (src/handlers/subscribe-message-handler.ts:208,237). That is a different behaviour from the parameter and deserves its own issue if it is wanted — it is flagged here only because it is the case that makes the CLOSED parameter worth having.
Testing
- Constructor: 3-element output when no hint, 4-element when present (the
OKtests from #807 are the model). - Whichever site is chosen: a case asserting the wire frame, including that a client reading only
[0..2]is unaffected. src/utils/relay-probe/ws-protocol-probe.ts:253readsresponse[2]of aCLOSED— trailing elements must not confuse it.
Effort
Small and self-contained: one optional parameter through createClosedMessage/ClosedMessage, and one emission at a read gate. The work is deciding which gate, since none of them speaks CLOSED today.
- 主要语言
- TypeScript
- 星标
- 829
- 派生
- 234
- 平均合并
- 2 天 10 小时
- 30 天内合并 PR
- 24
环境准备
- 提供 Dockerfile 或 Docker Compose 文件
- 有 Pull Request 模板
- 阅读贡献指南
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
cameri/nostream 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
feat(nip77): advertise NIP-77 in NIP-11 and expose its settings in the admin console可能已有人在做 @Priyanshubhartistm 于 2 天前认领。 未关闭enhancement
cameri/nostream#819 · 已指派 1 人 ·
维护者通常 1 天内回复
-
feat(nip77): NEG-OPEN/NEG-MSG/NEG-CLOSE wire protocol for the PostgreSQL backend可能已有人在做 @Priyanshubhartistm 于 2 天前认领。 未关闭enhancement
cameri/nostream#817 · 已指派 1 人 ·
维护者通常 1 天内回复
-
[Admin Console] Ops visibility panels (mirror, workers, NIP-05, storage)可能已有人在做 @Ferryx349 于 2 天前认领。 未关闭Admin Console enhancement
cameri/nostream#816 · 已指派 1 人 ·
维护者通常 1 天内回复
-
feat(admin): bounded NIP-66 probe history and Network Health timeline可能已有人在做 @Ferryx349 于 6 天前认领。 未关闭Admin Console enhancement
cameri/nostream#800 · 已指派 1 人 ·
维护者通常 1 天内回复
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 62/100
one-zero-eight/apply-bot#39 ·
-
难度 2/5 1-3 小时 新手友好度 72/100
bigbluebutton/bbb-ui-components-react#108 ·
维护者通常 2 天内回复
-
难度 2/5 1-3 小时 新手友好度 82/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 70/100
维护者通常 1 天内回复
-
high priority
难度 2/5 1-3 小时 新手友好度 62/100
CI-CMG/deep-sea-corals-exb#84 · 1 条评论 ·