The contract now has a verified synthetic testnet demonstration. The browser app has not been deployed or tested with a real wallet. No real pilot or production readiness is claimed.
The documentation for schoolfees, written as an mdBook.
schoolfees is a Stellar/Soroban pilot that records a school fee obligation
against an opaque reference and lets payers settle it, without personal data
ever going on-chain. Testnet only. Nothing is deployed, and no pilot has
happened yet.
Part of the schoolfees project, which is three repositories:
schoolfees-contracts
(the Rust contract),
schoolfees-app
(the web app, implemented but never run against a deployed contract) and this
one.
| Page | What it covers |
|---|---|
| Introduction | What the project is, in plain language |
| Quickstart | How to run the real checks yourself today |
| Product requirements | What the product is, from what the code does |
| Architecture | The contract, point by point, from the real code |
| Known limitations | What is not proven and not handled |
| Threat model | A STRIDE walk-through, with honest gaps |
| Pilot playbook | How a pilot will be run, and the deployment gate |
| Pilots | The record of real pilots (currently: none) |
| Proven vs assumed | Every claim with the test or command behind it — or the word "assumed" |
| Pilot readiness | The honest checklist for the first testnet deployment |
| Todo: verify | Everything still unverified, and what would verify it |
| Legal and privacy checklist | A checklist, not legal advice, including what the app really stores |
| FAQ | Short answers to common questions |
The October submission packet preserves the workspace's validation evidence, application descriptions and contributor issue drafts. It records local checks and synthetic browser fixtures, not deployment or acceptance. Workspace tools can be extracted into the original multi-project workspace to reproduce its checks.
Starting another Stellar project from this one? TEMPLATE.md lists exactly what to copy, what to change per project, and what not to copy. It is a note for a human or an agent starting fresh — it is not applied to any other repository from here.
node scripts/check-links.mjs # every link and every SUMMARY entry resolves
node --test # tests for the link checkerCI runs both of those, then installs mdBook and runs mdbook build
(.github/workflows/docs.yml). mdBook is deliberately not installed on the
maintainer's machine, so the book build is verified in CI only.
To preview the book locally you need mdBook:
cargo install mdbook
mdbook serve --open├── book.toml # mdBook configuration
├── src/
│ ├── SUMMARY.md # table of contents
│ ├── introduction.md
│ ├── quickstart.md
│ ├── prd.md # what the product is, from what the code does
│ ├── legal-compliance.md # a checklist, not legal advice
│ ├── architecture.md
│ ├── limitations.md
│ ├── threat-model.md
│ ├── pilot-playbook.md
│ ├── proven-vs-assumed.md # every claim with its evidence, or "assumed"
│ ├── pilot-readiness.md # the checklist for the first deployment
│ ├── todo-verify.md # everything still unverified, from all three repos
│ ├── faq.md
│ └── pilots/ # one real pilot per file; a note until then
├── scripts/
│ ├── check-links.mjs # link + SUMMARY checker (no dependencies)
│ └── check-links.test.mjs # its tests
├── docs/issue-drafts/ # drafts for contributors (never created on GitHub for you)
├── docs/arsenal-gap-map.md # Build Arsenal + Flowtick status, per repo
├── docs/audits/ # report-only audits, 2026-10-01
├── AGENTS.md # rules for AI agents working in this repo
├── ROADMAP.md # what is next, and what is deliberately not built
└── TEMPLATE.md # what to copy into a new project, and what to change
The full set is in AGENTS.md. The short version:
- Describe only what the code does. Anything not built is marked as such.
- Every technical claim points at a real file, function, test or command in
schoolfees-contractsorschoolfees-app. - Never invent addresses, transaction hashes, testers, schools or outcomes. No pilot is recorded until it really happens.
- Never put personal data in examples — only obvious placeholders such as
ref_0001. - Never soften the pilot-evidence boundary or the production boundary.
See CONTRIBUTING.md. The plan for what comes next is in ROADMAP.md.
MIT — see LICENSE.