Skip to content

docs: lead the repo, SDK and MCP READMEs with Audit Trail - #288

Merged
M0nsxx merged 1 commit into
mainfrom
docs/audit-trail-first-11nov
Nov 12, 2026
Merged

M0nsxx merged 1 commit into
mainfrom
docs/audit-trail-first-11nov

Conversation

@Eras256

@Eras256 Eras256 commented Nov 12, 2026

Copy link
Copy Markdown
Collaborator

Audit Trail (verifiable receipts) is the part of Nirium most people evaluating it look for first, but the root README listed it fourth and the SDK README opened with treasury and only showed it near the end.

Root README

  • Tagline and first bullet are now Audit Trail. Nothing else moves.

SDK README (packages/sdk)

  • New opening: Audit Trail, x402 and treasury as three short bullets, plus a status line (x402 and Audit Trail on mainnet, MPP testnet only, autonomous treasury invite-only on mainnet) linking EVIDENCE.md.
  • The old first sentence said agents rebalance "24/7 without human intervention". That is only true on testnet; on mainnet autonomous execution is invite-only and the open path is a proposal you sign. The new wording says so.
  • Audit Trail moves up right after Quick Start and adds two subsections: signed receipts (agent: { key, signature }) and how to verify one with nirium verify or nirium.xyz/verify. I ran the signed example on testnet with a throwaway key before writing it: anchor QmQfLH5xmhfWA1ftM7AN3MykhKx1ZAR2KXz3YdPLpRpa1t (tag selftest-readme-example), and nirium-cli@3.2.1 verify returned HASH MATCH and SIGNATURE VALID.
  • x402Serve() was described as "a client-side function"; it is Express middleware that runs on your server.
  • The Developer Sandbox link 301s to /build; it now links /build and /verify directly.

metrics.ts

  • HELP text read Total402 / Total403. Added the space. The README sample output changes the same way.

MCP README

  • Opening now mentions anchor_audit_record and how to verify its receipts.
  • The **Treasury - requires NIRIUM_API_KEY** heading ran into the last MPP bullet on npm; added the blank line.

The npm pages for nirium and nirium-mcp only pick this up on their next publish.

Tests: packages/sdk 60/60 jest, 165/165 node --test.

🤖 Generated with Claude Code

Audit Trail (verifiable receipts) is the part of Nirium most people
evaluating it look for first, but the root README listed it fourth and
the SDK README opened with treasury and kept it near the end.

- Root README: the tagline and the first bullet are now Audit Trail.
- SDK README: new opening with a status line and a link to EVIDENCE.md;
  the treasury sentence now says it runs on its own on testnet and is
  invite-only on mainnet, instead of "24/7 without human intervention".
  The Audit Trail section moves up after Quick Start and adds signed
  receipts and how to verify one (checked on testnet with a throwaway
  key: nirium verify returned HASH MATCH and SIGNATURE VALID).
- x402Serve() is server-side Express middleware, not a "client-side
  function".
- The Developer Sandbox link redirected to /build; it now links /build
  and /verify directly.
- metrics.ts: the HELP text read "Total402"/"Total403"; add the space.
- MCP README: mention anchor_audit_record and verification up front, and
  split the Treasury heading that ran into the MPP list.

SDK tests: 60/60 jest, 165/165 node --test.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@Eras256
Eras256 requested a review from M0nsxx as a code owner November 12, 2026 02:25

@M0nsxx M0nsxx left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed. Audit Trail now leads the root, SDK and MCP READMEs; the treasury claim matches what runs on mainnet; the signed-receipt example was run on testnet and verified with nirium verify; metrics HELP text typo fixed. SDK tests pass. Approving.

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.

2 participants