docs(protocol): document the content-miss wire contract (-32008 capped / -32003 / proxy:) (#2192) - #70
Merged
Merged
Conversation
…k (WIP #2192) Salvage anchor. The -32008 (capped redirect set + proxy: fetch-on-miss) half is complete. The -32009 CONTENT_MISS_RATE_LIMITED row is intentionally NOT added yet: it collides with dig-rpc-protocol's -32009 RangeMetadataUnrepresentable (already documented here), so the code must be disambiguated first. Version bump held with this WIP. Co-Authored-By: Claude <noreply@anthropic.com>
…247) The per-requestor miss-lookup rate-limit error, split off the former -32009 collision. -32009 stays RANGE_METADATA_UNREPRESENTABLE (holder-fatal); -32003 is the transient back-off signal. Machine catalog + prose + regenerated static specs move together (drift gate green, 65 codes). Refs #2192, #2247. Co-Authored-By: Claude <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Documents the dig-node content-miss wire contract so integrating developers can handle a miss without reading source — the ecosystem-docs half of DIG-Network/dig_ecosystem#2192 (the SYSTEM.md half is committed on the superproject).
-32008 CONTENT_REDIRECT— now documents the CAPPED candidate set (MAX_REDIRECT_PROVIDERS), the "node names holders but never dials/probes them" rule, and theproxy: truefallback cross-reference.proxy:(default off) — the explicit fetch-on-miss field ondig.getContent/dig.fetchRange, added to the peer-network spec (distinct from the operator-level fetch-through).-32003 CONTENT_MISS_RATE_LIMITED— the new per-requestor miss-lookup rate-limit error (transient; back off and retry), catalogued with its token-bucket semantics.-32009 RANGE_METADATA_UNREPRESENTABLE— left as-is (holder-fatal); the docs already had it correct.Why the
-32003/-32009split-32009was briefly double-assigned (dig-node minted a localCONTENT_MISS_RATE_LIMITEDthere, colliding withRangeMetadataUnrepresentable). DIG-Network/dig_ecosystem#2247 movedCONTENT_MISS_RATE_LIMITEDto-32003(canonical indig-rpc-protocol0.7.0; adopted in dig-node). So-32003is transient (retry the same request) and-32009is holder-fatal (abandon that holder) — a client must distinguish them.Machine-spec drift gate
The catalog (
scripts/dig-spec.mjs), the prose table (docs/support/error-codes.md), and the regeneratedstatic/*.jsonmove together in the same commit —npm run genpasses (drift gate green, 65 codes across 4 surfaces). Full 14-localenpm run buildsucceeds (no broken links).Version
0.15.0(MINOR — new documented capability; bumped with the first commit on this branch).Closes DIG-Network/dig_ecosystem#2192. Refs DIG-Network/dig_ecosystem#2247.
Generated by Claude Code