Skip to main content

Module error

Module error 

Source
Expand description

Unified error taxonomy: KineticError, ResolutionError, PublishError, and RegistrationError. Unified error taxonomy and logbook registry for Kinetic.

All errors in Kinetic follow a domain-specific hierarchy designed to prevent raw OS error leakage, enforce RFC 7807 problem details URIs, and supply clean user-facing messages.

§Kinetic Error Taxonomy Architecture

Every specialized domain error (e.g. ResolutionError, PublishError, RegistrationError) provides a rich metadata interface:

  1. Stable Protocol Code: Unique string code (e.g. KIN-RES-001, KIN-PUB-003, KIN-REG-005).
  2. RFC 7807 Type URI: Web specification URI for standard error documentation.
  3. Retryability Flag (is_retryable): Indicates if clients should retry.
  4. Severity Classifier (Severity): Directs logging and alert levels (Info, Warning, Error, Critical).
  5. User Message (user_message): Clean, non-technical explanation for UIs.
  6. Developer Details (details): Structured JSON payload for API extractors.

§Error Code Namespaces

PrefixError TypeDomain
KIN-RES-NNNResolutionErrorDHT name resolution
KIN-PUB-NNNPublishErrorDHT record publishing
KIN-REG-NNNRegistrationErrorName registration flow
KIN-VDF-NNNVdfErrorVDF engine operations
KIN-GOV-NNNGovernanceErrorCouncil governance
KIN-DNS-NNNDnsErrorDNS zone parsing
KIN-DRA-NNNDrandErrorDrand beacon
KIN-IDN-NNNIdentityErrorNode identity keys
KIN-NAM-NNNNamesErrorName validation
KIN-STO-NNNStorageErrorSled storage engine
KIN-NET-NNNNetworkClientError + KineticStoreErrorP2P network client and store layer

Re-exports§

pub use dht::PublishError;
pub use dht::RecordRejectReason;
pub use dht::RegistrationError;
pub use dht::ResolutionError;
pub use dns::DnsError;
pub use drand::DrandError;
pub use governance::GovernanceError;
pub use identity::IdentityError;
pub use names::NamesError;
pub use network::NetworkClientError;
pub use storage::StorageError;
pub use vdf::VdfError;
pub use vdf::VdfRejectReason;

Modules§

dht
DHT record rejection and resolution/publish/registration error types. DHT record rejection, resolution, publish, and registration error types.
dns
DNS Zone parsing and validation error types. DNS zone payload validation error types (KIN-DNS-NNN).
drand
Drand Quicknet kyn acquisition and verification error types. Drand Quicknet kyn acquisition and verification error types (KIN-DRA-NNN).
governance
Council governance and parameter-update error types. Governance action verification and voting error types (KIN-GOV-NNN).
identity
Node identity and seed phrase error types. Node identity key errors (KIN-IDN-NNN).
names
Name validation error types (KIN-NAM-NNN). Name validation error types (KIN-NAM-NNN).
network
libp2p network client error types. libp2p P2P network client error types (KIN-NET-NNN).
storage
Sled storage engine error types. Sled embedded storage engine error types (KIN-STO-NNN).
vdf
chiavdf Verifiable Delay Function error types. VDF engine error types (KIN-VDF-NNN).

Enums§

KineticError
Top-level error type for core Kinetic protocol operations.
Severity
Alert and logging severity level for a Kinetic error.