Skip to content

docs(miner): clarify claim ledger is local bookkeeping only #3638

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
loopover-orb merged 1 commit into from
Jul 5, 2026
Merged

docs(miner): clarify claim ledger is local bookkeeping only #3638

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions packages/gittensory-miner/lib/claim-ledger.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,9 @@ export function openClaimLedger(dbPath = resolveClaimLedgerDbPath()) {
const db = new DatabaseSync(resolvedPath);
chmodSync(resolvedPath, 0o600);
db.exec("PRAGMA busy_timeout = 5000");
// LOCAL bookkeeping only: this table records which issues this miner instance has soft-claimed on this
// machine. It does NOT adjudicate contested duplicates — sibling miners claiming the same issue are
// resolved elsewhere via `isDuplicateClusterWinnerByClaim` from `@jsonbored/gittensory-engine` (#3355).
db.exec(`
CREATE TABLE IF NOT EXISTS miner_claims (
id INTEGER PRIMARY KEY AUTOINCREMENT,
Expand Down
18 changes: 17 additions & 1 deletion test/unit/miner-claim-ledger.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { mkdtempSync, rmSync, statSync } from "node:fs";
import { mkdtempSync, readFileSync, rmSync, statSync } from "node:fs";
import { tmpdir } from "node:os";
import { join } from "node:path";
import { afterEach, describe, expect, it, vi } from "vitest";
Expand Down Expand Up @@ -120,4 +120,20 @@ describe("gittensory-miner claim ledger (#2314)", () => {
expect(() => ledger.recordClaim({ repoFullName: "o/a", issueNumber: 1.5 })).toThrow("invalid_issue_number");
expect(() => ledger.listClaims({ status: "bogus" as never })).toThrow("invalid_status");
});

it("claim-then-list, then release, excludes released rows from the active-only filter (#3354)", () => {
const ledger = tempLedger();
ledger.recordClaim({ repoFullName: "o/a", issueNumber: 10 });
expect(ledger.listClaims({ status: "active" }).map((c) => c.issueNumber)).toEqual([10]);
ledger.releaseClaim("o/a", 10);
expect(ledger.listClaims({ status: "active" })).toEqual([]);
expect(ledger.listClaims()).toHaveLength(1);
});

it("documents that miner_claims is local bookkeeping only, not duplicate adjudication (#3355)", () => {
const source = readFileSync("packages/gittensory-miner/lib/claim-ledger.js", "utf8");
expect(source).toContain("LOCAL bookkeeping only");
expect(source).toContain("does NOT adjudicate contested duplicates");
expect(source).toContain("isDuplicateClusterWinnerByClaim");
});
});
Loading