Skip to content

docs: add guide for manually verifying Audit Trail CIDs - #230

Merged
M0nsxx merged 2 commits into
nirium-protocol:mainfrom
Edgadafi:cursor/verify-audit-cid-docs-cf3d
Nov 3, 2026
Merged

M0nsxx merged 2 commits into
nirium-protocol:mainfrom
Edgadafi:cursor/verify-audit-cid-docs-cf3d

Conversation

@Edgadafi

@Edgadafi Edgadafi commented Oct 31, 2026 •

Copy link
Copy Markdown
Contributor

Add comprehensive guide (docs/verify-audit-cid.md) for independently verifying Nirium Audit Trail records from IPFS CIDs:

  • Fetch document from IPFS via public gateway
  • Recompute SHA-256 hash of the original payload
  • Verify ed25519 signature over nirium-audit-v1:
  • Include Node.js snippet with @stellar/stellar-sdk@16
  • Include curl + CLI examples
  • Link from README CLI package description

Testing

Verified on Stellar testnet with an existing TIA audit CID.

npx --yes nirium-cli@latest verify QmPtZppTCjTBK95pbvjMtQfNVHKdSVgSaw9ccjaBJUuw7f --json

Key output: "verified": true, "signatureStatus": "valid", "signatureScheme": "ed25519", "mode": "hash-only", "hashStatus": "unchecked" (no original payload supplied), signer GCSVP4X2M222VKUL4AQJC3KFYK772JZ4ZAI5Q5ITC7HGKDQYJLNZX5NM, statement nirium-audit-v1:19b9dd53…1f4b.

curl -s https://gateway.pinata.cloud/ipfs/QmPtZppTCjTBK95pbvjMtQfNVHKdSVgSaw9ccjaBJUuw7f

Returns the record (network: stellar:testnet, tag: niriumtober, anchoredAt: 2026-10-31T18:39:56.329Z); fields match the CLI output.

Follows implementation in actions/verify-audit-cid/src/verify.ts and packages/cli/bin/nirium.js (verify command).

AI Assistance

Drafted with AI assistance (Cursor agent). I reviewed the guide and verified field names, the nirium-audit-v1: prefix and the verification steps against the codebase.

Closes #173

Add comprehensive guide (docs/verify-audit-cid.md) for independently
verifying Nirium Audit Trail records from IPFS CIDs:
- Fetch document from IPFS via public gateway
- Recompute SHA-256 hash of the original payload
- Verify ed25519 signature over nirium-audit-v1:<hash>
- Include Node.js snippet with @stellar/stellar-sdk@16
- Include curl + CLI examples
- Link from README CLI package description

Follows implementation in actions/verify-audit-cid/src/verify.ts and
packages/cli/bin/nirium.js (verify command).

Closes nirium-protocol#173

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
Co-authored-by: Edgadafi <Edgadafi@users.noreply.github.com>
@Edgadafi

Copy link
Copy Markdown
Contributor Author

Docs-only change. The failing "SDK - npm audit" check comes from a new upstream advisory in follow-redirects (GHSA-mrwp-f3q8-3g9p, transitive), unrelated to this PR. Happy to rebase once main is fixed.

…-cid-docs-cf3d

Co-authored-by: Edgadafi <Edgadafi@users.noreply.github.com>
@Edgadafi

Edgadafi commented Nov 1, 2026

Copy link
Copy Markdown
Contributor Author

Updated both branches with main (follow-redirects fix included), renamed #231 and added Testing sections. CI shows "2 workflows awaiting approval" since it's a fork. Could you approve them when you get a chance?

@Edgadafi
Edgadafi marked this pull request as ready for review November 2, 2026 20:20

@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.

CI is green on PR #230 after #232 unblocked the Security Gate (follow-redirects bump). I read through the guide - [confirm the verification steps actually match what /api/audit/verify-signature and the CID lookup return today before approving]. Looks good to merge once that's checked.

@M0nsxx
M0nsxx merged commit 2656838 into nirium-protocol:main Nov 3, 2026
3 checks 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.

Docs: verify an Audit Trail CID by hand

3 participants