Skip to content

docs(registry): attester guide from record to meta_hash to review - #21

Merged
abrcrmb merged 2 commits into
Kinlock-Org:mainfrom
jdjioe5-cpu:docs/attester-guide
Oct 29, 2026
Merged

abrcrmb merged 2 commits into
Kinlock-Org:mainfrom
jdjioe5-cpu:docs/attester-guide

Conversation

@jdjioe5-cpu

Copy link
Copy Markdown

Summary

Closes #17. Fulfills the guide deliverable of Roadmap row M1-26 (Phase 1, M0 Validate, Priority P1).

This PR introduces the authoritative step-by-step Attester Guide:

  • docs/ATTESTER_GUIDE.md: Walkthrough from account readiness to record schema composition, local validation, canonical meta_hash calculation, and on-chain registration/PR lifecycle.
  • Hard Rule 7 & 11 Adherence: States plainly what a payee record proves (attester vouching for identity and payout address, never service delivery or proof of use) and enforces that private identity evidence remains offline with attesters.
  • Real Outputs: All command outputs in the guide (readiness checks, validation, canonical hashing) were produced by real runs against testnet fixtures in this checkout.
  • Linkages & Roadmap: Added links from README.md and ATTESTER_CHECKLIST.md. Added Changelog entry in ROADMAP.md (M1-26 remains IN PROGRESS as test-release remains manual).

Real Command Outputs Executed

$ pnpm lint
> biome check .
Checked 12 files in 21ms. No fixes applied.

$ pnpm typecheck
> tsc -p tsconfig.json
(exit 0, 0 errors)

$ pnpm test
> vitest run
 Test Files  1 passed (1)
      Tests  16 passed (16)
   Duration  280ms

$ pnpm validate
> tsx scripts/validate.ts
3 payee file(s) checked, 0 problem(s)

$ pnpm hash fixtures/payees/ke/ke-kinlock-test-school.json
payee_id  4485665bae55d2562f20ad82cec50c8aaa99ddf613b982509711a6b474ded0ba
meta_hash 4c62af9d86c73d0a0f3733c76741ae1d1206e439daf7d1ee7fa0d4f167b8ed24

$ pnpm check-attester-readiness GCLMHF7LAR34TSELDNEREYPTNE4K7MMESPS62WXE7ZDLPWIJUF3MC5QM
Checking GCLMHF7LAR34TSELDNEREYPTNE4K7MMESPS62WXE7ZDLPWIJUF3MC5QM on testnet (token CBIELTK6YBZJU5UP2WWQEUCYKLPU6AUNZ2BQ4WWFEIE3USCIHMXQDAMA)
✓ native XLM float: 9999.9647224 (need >= 2)
✓ USDC trustline authorized: true
✓ USDC trustline room: limit 9223372036854775807 > balance 80000000
Account and trustline checks pass. Next: complete a real test receive and test release through kinlock-app or the SDK, then check the remaining boxes in ATTESTER_CHECKLIST.md by hand.

- Closes Kinlock-Org#17 (Roadmap row M1-26 guide deliverable)
- Publish authoritative docs/ATTESTER_GUIDE.md covering readiness checks, record schema, local validation, canonical meta_hash generation, and PR review
- Strictly adhere to Hard Rule 7 (payee records vouch for identity and payout address, not proof of use) and Hard Rule 11 (private evidence stays offline)
- Link guide from README.md and ATTESTER_CHECKLIST.md
- Update ROADMAP.md with Changelog entry (M1-26 remains IN PROGRESS)
- All commands verified with real outputs: pnpm lint (12 files clean), pnpm typecheck (0 errors), pnpm test (16/16 passed), pnpm validate (3 files clean), and pnpm hash
Resolves the ROADMAP.md conflict structurally: rebuilt on main, kept every
main row, kept both sides' Changelog lines, and let only this repo's own rows
advance from the branch (AGENTS.md 12). Section 3 counts recomputed.
@abrcrmb

abrcrmb commented Oct 29, 2026

Copy link
Copy Markdown
Collaborator

Maintainer push to this branch — exactly what changed.

This PR conflicted with main (the conflict was in ROADMAP.md only). Instead of asking you to rebase, I merged main into docs/attester-guide so the PR is mergeable as-is.

My commit: ec1809b — merges e0da124 (main at the time) into your branch.

Measured scope: I compared my merge's tree against what a plain automatic merge of the same two commits produces. Files where my version differs from both inputs:

  • ROADMAP.md

In ROADMAP.md that means: your Changelog row and your **Last updated** line were kept, main's rows and Changelog lines were kept, and the conflict markers were removed (AGENTS.md §12: keep both sides' row changes, never delete a row). Where scripts/roadmap-progress re-derived the phase-count table after the merge, the count lines moved too — that is the tool's output, not a status decision by me.

Current CI: every check is green on this head (ec1809b).

No code, test, or config file of yours was modified unless it is listed above. This branch is yours; if you would rather resolve conflicts yourself, say so and I will stop pushing here.

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

Maintainer review. Verified against the live check rollup for this head (ec1809b): every required context here is green (docs-in-sync roadmap-check validate). Reviewed the diff, not the PR prose. ROADMAP rows added, none deleted. No contract entry point, storage layout, event, auth rule, or fund path affected unless this PR says otherwise.

@abrcrmb
abrcrmb merged commit 9a6d322 into Kinlock-Org:main Oct 29, 2026
6 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.

Attester guide: how a payee record is built, hashed and reviewed

4 participants