Skip to content

ams: reconcile README/DEPLOYMENT local-storage inventory -- two real SQLite stores are undocumented #8850

Description

@JSONbored

⚠️ Definition of Done: this issue must be completed in full, in a single PR. Do not split this
work across multiple PRs, and do not defer any Deliverable below to a follow-up issue. A PR that
satisfies only some of the Deliverables, stubs a required test, or leaves a checkbox
partially-done does NOT resolve this issue and will be closed.

Context

packages/loopover-miner/lib/contribution-profile-cache.ts:36-43 and packages/loopover-miner/lib/ranked-candidates.ts:26-29 are real, actively-used SQLite stores (contribution-profile-cache.sqlite3 / ranked-candidates.sqlite3, each with its own LOOPOVER_MINER_*_DB env override). Both are correctly wired into migrate-cli.ts and status.ts's doctor sweep, but neither appears in packages/loopover-miner/README.md:106-129's "Local storage" table, its hardcoded regression test test/unit/miner-local-store-readme.test.ts:9-25, or packages/loopover-miner/DEPLOYMENT.md:49-80's file listing (which claims "all eighteen" at line 73 but only enumerates 16). deployment-docs-audit.ts:128-134 explicitly excludes the _DB env-var family from its reverse-drift check, which is exactly why this slipped past CI.

Requirements

Add both contribution-profile-cache.sqlite3 and ranked-candidates.sqlite3 as rows to README.md's "Local storage" table (matching the existing row shape: filename, purpose, env override), update the hardcoded array in test/unit/miner-local-store-readme.test.ts to include both, and add their two lines to DEPLOYMENT.md's file listing (correcting "all eighteen" to the real count).

Deliverables

  • README.md's Local storage table lists both contribution-profile-cache.sqlite3 and ranked-candidates.sqlite3 with purpose + env override columns filled in
  • test/unit/miner-local-store-readme.test.ts's hardcoded array includes both filenames and the test passes
  • DEPLOYMENT.md's file listing includes both files and its stated total count is corrected to match

All of the above Deliverables are required in the same PR unless the deliverable text itself states otherwise.

Test Coverage Requirements

Docs-only change; the existing miner-local-store-readme.test.ts regression test is the enforcement mechanism -- it must pass with both new entries added, and must fail if either is removed again.

Expected Outcome

An operator reading README.md or DEPLOYMENT.md sees a complete, accurate list of every local SQLite store the miner creates, matching what migrate-cli.ts and status.ts's doctor sweep actually manage.

Links & Resources

  • packages/loopover-miner/lib/contribution-profile-cache.ts:36-43
  • packages/loopover-miner/lib/ranked-candidates.ts:26-29
  • packages/loopover-miner/README.md:106-129
  • packages/loopover-miner/DEPLOYMENT.md:49-80
  • test/unit/miner-local-store-readme.test.ts:9-25

Metadata

Metadata

Assignees

No one assigned

    Labels

    gittensor:bugGittensor-scored bug fix — scores a 0.05x multiplier.help wantedExtra attention is needed

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions