Skip to content

docs(miner): document append-only event ledger in README (#2322) #3702

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
JSONbored merged 1 commit into from
Jul 6, 2026
Merged

docs(miner): document append-only event ledger in README (#2322) #3702

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
4 changes: 4 additions & 0 deletions packages/gittensory-miner/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,10 @@ The package also includes a local soft-claim ledger: `openClaimLedger` / `claimI
`listActiveClaims` persist which issues this miner instance has claimed on this machine. The table is local
bookkeeping only — duplicate winners are adjudicated elsewhere via `@jsonbored/gittensory-engine`. (#2291)

The package also includes an append-only event ledger: `initEventLedger` / `appendEvent` / `readEvents` persist
immutable miner-loop events in local SQLite for contributor audit. Insert-only — rows are never updated or
deleted. (#2322)

## Install

See [`docs/miner-goal-spec.md`](docs/miner-goal-spec.md) for the `.gittensory-miner.yml` field reference and [`.gittensory-miner.yml.example`](../../.gittensory-miner.yml.example) at the repo root.
Expand Down
16 changes: 16 additions & 0 deletions test/unit/miner-event-ledger-readme.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { readFileSync } from "node:fs";
import { join } from "node:path";
import { describe, expect, it } from "vitest";

const readmePath = join(process.cwd(), "packages/gittensory-miner/README.md");

describe("gittensory-miner event ledger README (#2322)", () => {
it("documents the append-only event ledger API surface", () => {
const readme = readFileSync(readmePath, "utf8");
expect(readme).toContain("initEventLedger");
expect(readme).toContain("appendEvent");
expect(readme).toContain("readEvents");
expect(readme).toContain("append-only");
expect(readme).toContain("Insert-only");
});
});
Loading