cometbft-rpc 0.1.0-alpha.2

cometbft-rpc contains the core types returned by a CometBFT node's RPC endpoint. All networking related features are feature guarded to keep the dependencies small in cases where only the core types are needed.
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

//! `/header_by_hash` endpoint JSON-RPC wrapper

use cometbft::{block::Header, Hash};
use serde::{Deserialize, Serialize};

use crate::dialect::v1;
use crate::request::RequestMessage;

/// Get information about a specific block by its hash
#[derive(Clone, Debug, Default, Deserialize, Eq, PartialEq, Serialize)]
pub struct Request {
    /// Hash of the block to request.
    ///
    /// If no hash is provided, it will return no header (as if the hash
    /// did not match any block).
    ///
    /// Serialized internally into a hex-encoded string before sending to
    /// the RPC server.
    #[serde(default)]
    #[serde(with = "crate::serializers::option_hash")]
    pub hash: Option<Hash>,
}

impl Request {
    /// Create a new request for information about a particular block
    pub fn new<H: Into<Hash>>(hash: H) -> Self {
        Self {
            hash: Some(hash.into()),
        }
    }
}

impl RequestMessage for Request {
    fn method(&self) -> crate::Method {
        crate::Method::HeaderByHash
    }
}

impl crate::Request<v1::Dialect> for Request {
    type Response = Response;
}

impl crate::SimpleRequest<v1::Dialect> for Request {
    type Output = Response;
}

/// Header response
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct Response {
    /// Header data
    pub header: Option<Header>,
}

impl crate::Response for Response {}

impl From<super::block_by_hash::Response> for Response {
    fn from(block_resp: super::block_by_hash::Response) -> Self {
        Response {
            header: block_resp.block.map(|b| b.header),
        }
    }
}