Skip to content

docs(sdk): document the x402Serve() guard, fix links and repository fields - #115

Merged
Eras256 merged 1 commit into
mainfrom
docs/sdk-readme-repo-field
Oct 11, 2026
Merged

Eras256 merged 1 commit into
mainfrom
docs/sdk-readme-repo-field

Conversation

@Eras256

@Eras256 Eras256 commented Oct 11, 2026

Copy link
Copy Markdown
Collaborator

README and metadata for the next nirium SDK version. Text and package.json metadata only, no code. Nothing is published or tagged by this PR; it ships with the next SDK release.

  • x402Serve() guard documented: guard, X402GuardStore, createUpstashX402GuardStore, with two storage options (Upstash, or your own store; an in-memory example is included). The guard is off unless you pass guard.
  • "Known limitation" kept, reworded: without guard there is no replay protection and no rate limit.
  • Credit to Edgadafi (Edgadafi/remesa-liquidez) for the design; x402Serve() has no replay protection or rate limiting — document as a known limitation #91 linked as context.
  • ResilientSignalClient documented in a short section.
  • /premium/signals is testnet only (501 on mainnet, checked live); /premium/market is paid on both.
  • Removed the dead links /docs/api and /docs/mcp; GitHub link now nirium-protocol/nirium; 21 long dashes removed.
  • repository (with directory) and bugs.url of nirium and nirium-mcp now point to nirium-protocol/nirium.

Checked against the published nirium@0.16.0: a real Express server with an in-memory store gave 429 rate_limited on the second call inside the rate window, and 409 payment_replayed for two concurrent calls with the same proof. The README snippet compiles with tsc --strict. Not tested: a real payment end to end (needs a live facilitator).

🤖 Generated with Claude Code

…ields

README: document guard, X402GuardStore and createUpstashX402GuardStore with
an example (Upstash and a custom store), keep the known limitation but say
it applies when guard is not passed, document ResilientSignalClient, say
/premium/signals is testnet only (501 on mainnet), drop two dead links,
fix the GitHub link, remove long dashes. package.json of nirium and
nirium-mcp: repository and bugs.url point to nirium-protocol/nirium.
Text and metadata only. Ships with the next SDK version.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@Eras256
Eras256 merged commit 2a592b8 into main Oct 11, 2026
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant