ns-indexer 0.6.0

Name & Service Protocol indexer service in Rust
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

use axum::extract::State;
use serde::{Deserialize, Serialize};
use std::sync::Arc;
use validator::{Validate, ValidationError};

use ns_axum_web::erring::{HTTPError, SuccessResponse};
use ns_axum_web::object::PackObject;
use ns_protocol::ns;

use crate::db::scylladb::ScyllaDB;
use crate::indexer::{Indexer, IndexerState};

mod inscription;
mod name;
mod service;
mod utxo;

pub use inscription::InscriptionAPI;
pub use name::NameAPI;
pub use service::ServiceAPI;
pub use utxo::UtxoAPI;

#[derive(Serialize, Deserialize)]
pub struct AppVersion {
    pub name: String,
    pub version: String,
}

#[derive(Serialize, Deserialize)]
pub struct AppHealth {
    pub block_height: u64,
    pub inscription_height: u64,
}

pub struct IndexerAPI {
    pub(crate) scylla: Arc<ScyllaDB>,
    pub(crate) state: Arc<IndexerState>,
}

impl IndexerAPI {
    pub fn new(indexer: Arc<Indexer>) -> Self {
        Self {
            scylla: indexer.scylla.clone(),
            state: indexer.state.clone(),
        }
    }
}

pub async fn version(
    to: PackObject<()>,
    State(_): State<Arc<IndexerAPI>>,
) -> PackObject<AppVersion> {
    to.with(AppVersion {
        name: crate::APP_NAME.to_string(),
        version: crate::APP_VERSION.to_string(),
    })
}

pub async fn healthz(
    to: PackObject<()>,
    State(app): State<Arc<IndexerAPI>>,
) -> Result<PackObject<SuccessResponse<AppHealth>>, HTTPError> {
    let last_accepted_state = app.state.last_accepted.read().await;
    let (block_height, height) = match *last_accepted_state {
        Some(ref last_accepted) => (last_accepted.block_height, last_accepted.height),
        None => (0, 0),
    };
    Ok(to.with(SuccessResponse::new(AppHealth {
        block_height,
        inscription_height: height,
    })))
}

#[derive(Debug, Deserialize, Validate)]
pub struct QueryName {
    #[validate(custom = "validate_name")]
    pub name: String,
    #[validate(range(min = 0))]
    pub sequence: Option<i64>,
    #[validate(range(min = 0))]
    pub code: Option<i64>,
}

#[derive(Debug, Deserialize, Validate)]
pub struct QueryHeight {
    #[validate(range(min = 0))]
    pub height: i64,
}

#[derive(Debug, Deserialize, Validate)]
pub struct QueryNamePagination {
    #[validate(custom = "validate_name")]
    pub name: String,
    pub page_token: Option<i64>,
    #[validate(range(min = 2, max = 1000))]
    pub page_size: Option<u16>,
}

#[derive(Debug, Deserialize, Validate)]
pub struct QueryPubkey {
    pub pubkey: String,
}

#[derive(Debug, Deserialize, Validate)]
pub struct QueryAddress {
    pub address: String,
}

fn validate_name(name: &str) -> Result<(), ValidationError> {
    if !ns::valid_name(name) {
        return Err(ValidationError::new("invalid name"));
    }

    Ok(())
}