chore: README rewrite + test consolidation

[wcatz]

Summary

• Rewrite README with technical focus — quickstart first, architecture details, config reference
• Consolidate 5 test files down to 2 (comprehensive_test.go + nonce_koios_test.go) — 69 tests, all pass, zero coverage loss
• Drop subset tests already covered by Extended/AllEras variants

Test plan

• go test -count=1 ./... — 69 pass, 1 expected skip
• No test removed without verifying coverage by a superset in comprehensive_test.go

Summary by CodeRabbit

Release Notes

• Documentation

  • Streamlined README with simplified quick-start flow and reorganized sections for clearer setup instructions and configuration guidance.

• Tests

  • Consolidated test suite with expanded coverage for cryptographic functions, nonce management, and store operations to improve reliability.

[coderabbitai]

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

This PR consolidates test files and restructures documentation. Tests from nonce_test.go, store_test.go, and leaderlog_test.go are merged into comprehensive_test.go with extensive nonce, VRF, and store operation coverage. README is streamlined, removing detailed feature descriptions and reorganizing into simplified prerequisites and modes sections.

Changes

Cohort / File(s)	Summary
Documentation Restructure README.md	Rewrote content to de-emphasize previous features and reorganize into minimal "Run" flow with prerequisites and detailed mode/modes sections. Removed descriptions of Block Notifications, Leader Schedule, Epoch Nonces, and other features; replaced with concise Quick Start. Updated configuration examples, environment variables, and modernized dependency references.
Test Consolidation comprehensive_test.go	Added ~505 lines of merged test suite covering nonce functions (TestVrfNonceValue, TestEvolveNonce, TestPallasRollingNonce, TestPallasEpochNonce, domain-separator tests), VRF and leader value derivations, and store operations (TestInsertBlock, TestGetLastSyncedSlot, nonce management, leader schedule operations, truncation, and Koios API integration checks).
Deleted Test Files leaderlog_test.go, nonce_test.go, store_test.go	Removed three separate test files totaling ~695 lines. Content previously covering SlotToEpoch mappings, numeric formatting, VRF nonce computations, nonce evolution, and SqliteStore operations consolidated into comprehensive_test.go.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~25 minutes

Possibly related PRs

• PR #93: Touches same nonce/store/leaderlog code paths and tests, involving modifications and restructuring of related test files.
• PR #20: Introduces the Store/nonce/leaderlog implementations that these consolidated tests directly validate.
• PR #57: Adds extensive nonce-related tests and era-aware nonce behavior that overlaps with the domain-separator and stability-window checks in this PR.

Poem

🐰 Tests once scattered, now in one neat place,
Nonces and stores dance with graceful space.
README trimmed clean, the docs now lean—
A tidy warren, best ever seen! ✨

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'chore: README rewrite + test consolidation' accurately summarizes the two primary changes in the PR: a substantial README rewrite and consolidation of the test suite from five files into two.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

• 📝 Generate docstrings (stacked PR)
• 📝 Generate docstrings (commit on current branch)

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch chore/readme-rewrite

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}