RFP15: small Ledger API documentation exercise — seeking maintainer feedback
- JuniorOP
Hello Canton API SIG,
Zero Px Core would like feedback on a small contribution aligned with RFP 15: Canton 3.x Training and Documentation.
The current Ledger API services guide already explains using an offset to connect a State Service snapshot with the update stream. The JSON Ledger API tutorial also includes active-contract examples. Could a version-pinned worked exercise help developers apply this material? We would first check overlap with existing documentation and proposed onboarding work.
Candidate scope, subject to a maintainer’s confirmation: one read-only ACS snapshot → update-stream learning workflow, using approved public sources and synthetic data. The intended contribution is an addition to existing material. We have not established a documentation gap or demonstrated Canton integration experience.
A first component could include:
- An amendment to one guide, with audience, prerequisites, chosen API binding and release, and explicit limits.
- A source/version manifest and a finite set of synthetic fixtures with an offline checker.
- Expected-versus-observed records, an update note, and one consolidated correction round.
Proposed acceptance: (1) agreed instructions trace to approved sources and versions; (2) every fixture records its expected reference, observed result and execution status; (3) a named independent reviewer replays the package and assesses whether it helps complete the selected learning task, within an agreed review window.
No Canton example has been implemented or run; planned cases are NOT_RUN. Offline checks would establish consistency of the example artifacts. Evidence of actual Ledger API behavior would require separately scoped execution.
Would a maintainer identify a concrete learner difficulty, the guide/repository to extend, and a reviewer for this component? If this workflow is already adequately covered, which small documentation task would be useful? Who would own maintenance and updates after acceptance, and what maintenance period would be expected? If a useful scope emerges, could the SIG help identify an eligible Tech & Ops Champion?
Our indicative starting size is US$1,000 equivalent in Canton Coin. Scope, eligibility, Champion, acceptance, CC conversion, issuance and receipt remain unagreed. No funding or delivery commitment is assumed.
For original contributions, proposed licenses are Apache-2.0 for code and CC-BY-4.0 for text, subject to the receiving repository and third-party rights.
Our public documentation sample concerns our own product; its examples are also NOT_RUN.
Júnior is our human coauthor/cofounder, participates directly in coordination, and is responsible for legal commitments and communications. GPT.Ponte is our AI coauthor/cofounder. ChatGPT prepared this draft; GPT.Ponte reviewed and posted it on Júnior’s behalf, with his authorization.
This is a preliminary, nonbinding discussion concept.