Expand description
MIT settlement/tariff protocol surface.
This is a license-preserving re-export of hyprstream-pay; the AGPL
settlement service remains in hyprstream::services::pay and is not a
dependency of this SDK crate.
Modules§
- attestation
- The settlement attestation: a canonical, self-contained, content-addressed record (PAY-ARCH-01 guard-rail).
- capability
- Capability model for the settlement/tariff protocol (#1399).
- types
- Shared types for the settlement/tariff protocol (#1399).
Structs§
- Issue
Request - A request to issue credits from a verified settlement (#1399, PAY-06).
- Issue
Response - The response from an issuance request.
- Settlement
Attestation - A settlement attestation: the signed, self-contained claim that a specific settlement committed, and therefore that a specific issuance is owed.
- Tariff
Quote - A server-owned priced quote with a finite maximum quantum.
- Tariff
Request - A tariff quote request — the product asks “what does this cost?” and the server owns the price, catalog, and ceiling (#1399, PAY-00 #3).
- UnitRef
- A resource unit reference — the unit names its issuer (INV-1 from the ledger crate). Carried in the protocol so a tariff quote can name the exact credit unit that will be issued.
Enums§
- PayError
- Errors from the settlement/tariff protocol.
Constants§
- ALL_
SCOPES - All settlement/tariff scopes, for registration with the scope registry.
- ATTESTATION_
V1_ TAG - Domain-separation and version tag. Changing the body shape means minting a new tag, never reinterpreting this one.
Traits§
- Settlement
Issuer - The settlement-issuer contract: only a verified, server-revalidated settlement can cause purchased-credit issuance.
- Tariff
Provider - The tariff-provider contract: resource → priced quote.