Documentation
Build against the profile.
No account, no key, and no service of ours. Everything here runs on your own machine against packages you can read.
What is here
9 pages written, 21 planned.
The tree below is the whole plan. A page that is written is a link; a page that is not is plain text with a marker, so you can see the shape without following anything that goes nowhere.
Get started
Learning oriented. Follow these in order and something works at the end.
- Your first request Build one, seal it, and look at its bytes.
- Install Packages, versions, and what each one is for.
- Read it back Decode a request and check what a wallet would check.
- Watch a settlement soon Replay a captured settlement and match it to a request.
Guides
Task oriented. You already know what you want; these say how.
- Send a request with an invoice soon Attach one to the email your billing system already sends.
- Support requests in a wallet soon Parse, judge and present a request without trusting it.
- Observe settlements on your node Follow the update stream and keep records before pruning.
- Reconcile against your invoices soon Match, classify, and hand readiness to your ledger.
- Handle the exceptions soon Partial, late, duplicate, unmatched, and what each one means.
- A payment end to end on LocalNet A full merchant path on a network you start yourself, and exactly what it proves.
- Accept CBTC Ask for a CBTC payment, let the payer check it, and match it on DevNet.
- Move from 0.1 to 0.2 soon What changed, what breaks, and how the two coexist.
Reference
Information oriented. Look one thing up and leave.
- Request payload soon Every field, its type, and whether it is required.
- Security envelope soon Modes, suites, and what the signature covers.
- Canonical encoding soon Key order, numbers, text, timestamps, and absent versus empty.
- Identifier derivation soon The hash, its domain separator, and how to reproduce it.
- Settlement metadata soon The two keys written on ledger, and where they are attached.
- Reconciliation record soon Verdict axes, flags, readiness, and supersession.
- QR, links and NFC The three ways a request travels, and which package owns each.
- Reason codes Every rejection a reader can return, and what causes it.
- Conformance vectors soon The positive and negative cases, and how to run them.
Concepts
Understanding oriented. Why it is built this way, and what that costs.
- Why the request is off ledger soon What it costs to write every ask on chain, and who sees it.
- Why the identifier is derived soon Determinism, and what changes when one character does.
- Who can read settlement metadata soon The measured disclosure set, and why it is structural.
- Why seven verdicts, not one soon What a single checkmark hides from a payer.
- Why Payvol runs no engine soon Where execution belongs, and what that costs us.
Operate
For whoever runs it after it works.
- Versioning and deprecation How profiles coexist and how old ones retire.
- Node access and permissions soon What the observation adapter needs, and what it does not.
- Data retention soon What a record keeps, and why pruning matters.
- Reporting a security issue soon Where to send it, and what to expect.
Every page is also Markdown.
Append .md to any documentation URL to get its source, and read
llms.txt for the whole site in one file.