Disclosure Boundary
These docs define the interoperability contract for Stratum Peer REST. They answer how do I call the peer? They do not answer how does chaincode reach ledger state?
Link this page from security reviews without edits.
Purpose
Integrators need stable vocabulary: auth headers, error envelopes, wallet and asset routes, health probes, and upgrade expectations. Judgment about ledger correctness, endorsement policy design, and proprietary adapter transforms stays private.
Published
- VPC-private network model and
X-Api-Key/ admin-key roles - Public REST paths for tokens (wallet ops) and assets (sync/query)
- Error envelope
{ error: { code, message } }and common codes - Health:
/health/livevs/health/readyand SLI names (RPS, error%, p95) - Upgrade posture: F1 supported, F2 Panurus deferred; REST is the stable contract
- Synthetic request/response examples only
Never published
- Production API keys, peer IPs, or tenant VPC diagrams with real addresses
- Chaincode source, endorsement policy internals, or private data collection schemas
- Proprietary adapter transformation logic or customer payload samples
- Panurus implementation details ahead of a public migration playbook
- Real wallet IDs, balances, or transaction IDs from customer networks
Three-line test
Before shipping any page:
- Describes the interface an actor calls, not how the ledger decides validity.
- Names routes and signals, not internal upgrade tooling beyond the public playbook.
- Explains verification of readiness/metrics, not how to exploit or bypass VPC controls.
Pages that fail this test are not shipped.