[runtime] align docs with implemented runtime surface#18
Merged
Conversation
Why: bring public and agent-facing documentation into sync with the actual routes, env vars, verification path, and repo-local workflow. Contract impact: none
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
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.
Motivation
server.mjs, scripts, tests, and workflows rather than describing aspirational or legacy behavior.Description
README.md,docs/CONFIGURATION.md,docs/OPERATIONS.md, andSECURITY.mdto reflect the exact routes, env vars, verification semantics, debug gating, SSRF/CORS behavior, schema warmup behavior, and signing model implemented inserver.mjs(no application code changes).AGENTS.mdandCLAUDE.mdto stop referencing repo-external setup scripts and stack-level commands, and to state the runtime health surface accurately (/healthand/healthz).RECEIPT_SIGNER_ID,RECEIPT_SIGNING_PRIVATE_KEY_PEM_B64,RECEIPT_SIGNING_PUBLIC_KEY_B64,DEV_AUTO_KEYS,ENABLE_DEBUG/DEBUG_TOKEN,ETH_RPC_URL,ENS_SIG_*keys, schema/validator knobs), and explicitly marked a set of env names and controls as not implemented (CORS envs, rate-limit envs,REQUEST_SCHEMA_VALIDATION,DEBUG_ROUTES_ENABLED/DEBUG_BEARER_TOKEN,VERIFIER_ENS_NAME, etc.).@commandlayer/runtime-core,/verifyaccepts wrapped or bare receipts, supportsens=1,strict_kid=1,refresh=1, andschema=1, and may return202whenVERIFY_SCHEMA_CACHED_ONLY=1and validator is cold; legacyruntime/src/receipt-verification.jsremains in-tree and is described as legacy/test compatibility only.Testing
npm run checkand it completed successfully.npm test, which runs unit tests and the smoke script; all tests passed (unit tests and smoke completed with no failures).Codex Task