Documentation
The beta.3 manual: evaluate locally, integrate a backend, then operate a receiver.
This manual targets 0.1.0-beta.3. Read the source and availability policy before installing. Historical reports retain their original scope.
Choose a task
| I want to… | Start here |
|---|---|
| Understand and try PPOps | Get the right source → local demo. No funds or wallet. |
| Integrate a backend | Merchant integration → runnable example → state and fulfillment policy. |
| Run a real receiver | Merchant quickstart → configuration → deployment. |
| Understand the checkout | PayIn experience, including request verification, QR and payment states. |
| Build a payer | Payment Request v1 → Payer integration and readiness, on a separate host and trust domain. |
| Find an interface | HTTP API · OpenAPI · TypeScript client · CLI. |
| Contribute evidence | Usability protocol or external pilot. Both require actual independent participation before claiming results. |
What beta.3 adds
PayIn now includes browser-side request verification, a locally generated request QR, readable progress and reference-payer readiness. The acceptance rules and payment.confirmed webhook remain unchanged. Read the release changes.
The demo, diagnostics, TypeScript helpers, OpenAPI, merchant example and Agent Skill from beta.2 remain available. Payout is roadmap only.
The helper is optional. PPOps remains a self-hosted HTTP service, not a hosted processor or consumer wallet. Read the limitations before committing to an integration.
Start here
- PPOps PayIn
- Signed requests, a readable checkout, local readiness and view-only acceptance.
- Local demo
- Exercise checkout, reconciliation and webhooks without a wallet, RPC or funds.
- Merchant quickstart
- Install the view-only daemon, check configuration, start it and inspect its status.
Integration
- Merchant integration
- Connect your backend using HTTP or the optional TypeScript client; verify and deduplicate webhooks.
- Runnable merchant example
- Run the example shop against your own merchant daemon.
- HTTP API
- Routes, authentication, errors, pagination and signed event delivery.
- Payment states
- Credited value, partial and late payments, expiry, reversions and fulfillment policy.
- Payer integration
- A separate trust domain: descriptor verification, private liquidity and submission.
- Payment Request v1
- Signed terms, QR transport and the checks a compatible payer must implement.
Reference
- CLI reference
- Demo, doctor, status, configuration, preflight, backups and diagnostics.
- Configuration
- Fields, file paths, secret permissions, RPC quorum and validation.
- Architecture
- Services, trust domains, data flow, state and storage.
- Product boundary
- What PPOps owns, what your application owns and what it cannot do.
- Threat model
- Design assumptions and adversarial analysis; an internal document, not an independent audit.
Operations
- Deployment
- Build, exposure policy, persistence, upgrades and backups.
- Production runbook
- Operational procedures, monitoring, recovery and key rotation; not a readiness certification.
- Troubleshooting
- Diagnose installation, readiness, RPC, PPOI, payment state and webhook failures.
- Operator security
- Secret handling, trust boundaries and fail-closed operation.
Contribute
- Roadmap
- Harden PayIn first. Payout and refunds remain future proposals with external signing.
- Agent Skill
- The complete repository skill, including its safety boundaries and workflow references.
- Usability testing
- A reproducible study protocol for new integrators; no completed independent study is claimed.
- External pilot
- Independent merchant and payer tracks, consent and metadata-minimal reporting. Status: pending.
Historical records
Dated reports and controlled-pilot records keep their original version and scope. They do not establish beta.3 readiness or an independent audit.
- Operational profile record
- Historical beta.1 profile and verification record. Not a beta.3 verification.
- Primitive gate
- Historical feasibility procedure and evidence scope.
- Mainnet gate
- Controlled verification procedure and recorded outcomes.
- Controlled pilot guide
- The controlled pilot procedure; not independent adoption evidence.
- Pilot findings
- Dated observations from controlled pilots.
- Maturity assessment · 2026-08-30
- Historical internal assessment. Not an independent audit.
- Differential review · 2026-08-30
- Historical internal review. Not a beta.3 certification.
- Gate A record
- Controlled direct-submission procedure and evidence.
- Gate B record
- Controlled Broadcaster procedure and evidence.
- Upstream Broadcaster report
- Dated upstream compatibility observations.
Supporting documents
- Reference payer manual
- Complete reference-payer commands. Run on the payer host, never the merchant host.
- Payer threat model
- Spending authority and the reference payer's trust assumptions.
- Security reporting
- Project security policy and vulnerability reporting.
- Changelog
- Unreleased changes and published release history.
Skill references
- Skill reference · security
- Companion reference shipped with the PPOps Agent Skill.
- Skill reference · quickstart
- Companion reference shipped with the PPOps Agent Skill.
- Skill reference · api
- Companion reference shipped with the PPOps Agent Skill.
- Skill reference · payer
- Companion reference shipped with the PPOps Agent Skill.
- Skill reference · troubleshooting
- Companion reference shipped with the PPOps Agent Skill.
- Skill reference · external-pilot
- Companion reference shipped with the PPOps Agent Skill.
Source parity
The full guides are synchronized from the core Markdown files; the site checks the snapshot and OpenAPI version on every build. Inspect the original files and hash manifest.