dune-api 0.1.0

Unofficial Rust client for the Dune Analytics API
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

//! Error types for the Dune API client
//!
//! This module provides the error types for the Dune API client,
//! built on top of the shared `ApiError` infrastructure.

use thiserror::Error;
pub use yldfi_common::api::ApiError;

/// Domain-specific errors for Dune API
#[derive(Error, Debug)]
pub enum DomainError {
    /// Invalid API key
    #[error("Invalid API key")]
    InvalidApiKey,

    /// Query execution failed
    #[error("Query execution failed: {0}")]
    ExecutionFailed(String),

    /// Query execution timed out
    #[error("Query execution timed out after {0} seconds")]
    ExecutionTimeout(u64),

    /// Insufficient credits
    #[error("Insufficient credits")]
    InsufficientCredits,

    /// Resource not found
    #[error("Resource not found: {0}")]
    NotFound(String),
}

/// Error type for Dune API operations
pub type Error = ApiError<DomainError>;

/// Result type for Dune API operations
pub type Result<T> = std::result::Result<T, Error>;

// Convenience constructors for domain errors
/// Create an invalid API key error
pub fn invalid_api_key() -> Error {
    ApiError::domain(DomainError::InvalidApiKey)
}

/// Create an execution failed error
pub fn execution_failed(message: impl Into<String>) -> Error {
    ApiError::domain(DomainError::ExecutionFailed(message.into()))
}

/// Create an execution timeout error
pub fn execution_timeout(seconds: u64) -> Error {
    ApiError::domain(DomainError::ExecutionTimeout(seconds))
}

/// Create an insufficient credits error
pub fn insufficient_credits() -> Error {
    ApiError::domain(DomainError::InsufficientCredits)
}

/// Create a not found error
pub fn not_found(resource: impl Into<String>) -> Error {
    ApiError::domain(DomainError::NotFound(resource.into()))
}