Expand description
API-related types for CHIE Protocol.
This module contains types used for API requests and responses:
- Response wrappers (
ApiResponse,ApiError,PaginatedResponse) - Proof submission results
- Health check responses
- User and reward types
- Leaderboard entries
Structs§
- ApiError
- Standard API error response.
- ApiResponse
- Standard API response wrapper for successful operations.
- Cursor
- Cursor for cursor-based pagination (more efficient for large datasets).
- Cursor
Paginated Response - Cursor-based paginated response (more efficient for large datasets).
- Health
Check Response - Health check response.
- Leaderboard
Entry - Leaderboard entry.
- Link
- HATEOAS link for hypermedia-driven API navigation.
- Links
- Collection of HATEOAS links
- Paginated
Response - Paginated response for list endpoints.
- Proof
Submission Result - Proof submission result.
- Rate
Limit Headers - Rate limit response headers following RFC 6585 and draft standards.
- Reward
Distribution - Reward distribution result.
- User
- User account.
Enums§
- ApiVersion
- API version for header-based versioning