exochain-api 0.2.0-beta

EXOCHAIN constitutional trust fabric — P2P networking and external API types
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

// Copyright 2026 Exochain Foundation
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at:
//
//     https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
//
// SPDX-License-Identifier: Apache-2.0

//! API-specific errors.
use thiserror::Error;

/// Errors returned by the exo-api layer.
#[derive(Debug, Error)]
pub enum ApiError {
    #[error("peer not found: {0}")]
    PeerNotFound(String),
    #[error("message verification failed: {reason}")]
    VerificationFailed { reason: String },
    #[error("rate limited: {peer_id}")]
    RateLimited { peer_id: String },
    #[error("replayed message from {peer_id} with nonce {nonce}")]
    ReplayDetected { peer_id: String, nonce: u64 },
    #[error("invalid schema: {reason}")]
    InvalidSchema { reason: String },
    #[error("serialization error: {0}")]
    SerializationError(String),
}
/// Convenience alias for results with [`ApiError`].
pub type Result<T> = std::result::Result<T, ApiError>;

#[cfg(test)]
mod tests {
    use super::*;
    #[test]
    fn all_variants_display() {
        let es: Vec<ApiError> = vec![
            ApiError::PeerNotFound("x".into()),
            ApiError::VerificationFailed { reason: "x".into() },
            ApiError::RateLimited {
                peer_id: "x".into(),
            },
            ApiError::ReplayDetected {
                peer_id: "x".into(),
                nonce: 1,
            },
            ApiError::InvalidSchema { reason: "x".into() },
            ApiError::SerializationError("x".into()),
        ];
        for e in &es {
            assert!(!e.to_string().is_empty());
        }
    }
    #[test]
    fn result_alias() {
        let ok: Result<u32> = Ok(1);
        assert!(ok.is_ok());
    }
}