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
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

//! `/broadcast_tx_commit`: only returns error if `mempool.CheckTx()` errs or
//! if we timeout waiting for tx to commit.

use serde::{Deserialize, Serialize};

use cometbft::{abci, block, Hash};

use crate::dialect::{self, Dialect};
use crate::{prelude::*, request::RequestMessage, serializers};

/// `/broadcast_tx_commit`: only returns error if `mempool.CheckTx()` errs or
/// if we timeout waiting for tx to commit.
///
/// If `CheckTx` or `DeliverTx` fail, no error will be returned, but the
/// returned result will contain a non-OK ABCI code.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Serialize)]
pub struct Request {
    /// Transaction to broadcast
    #[serde(with = "serializers::bytes::base64string")]
    pub tx: Vec<u8>,
}

impl Request {
    /// Create a new commit transaction broadcast RPC request
    pub fn new(tx: impl Into<Vec<u8>>) -> Request {
        Request { tx: tx.into() }
    }
}

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

impl crate::Request<dialect::v0_34::Dialect> for Request {
    type Response = self::v0_34::DialectResponse;
}

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

impl<S: Dialect> crate::SimpleRequest<S> for Request
where
    Self: crate::Request<S>,
    Response: From<Self::Response>,
{
    type Output = Response;
}

/// Response from `/broadcast_tx_commit`.
#[derive(Clone, Debug, Serialize, Deserialize)]
pub struct Response {
    /// `CheckTx` result
    pub check_tx: abci::response::CheckTx,

    /// Result of executing the transaction.
    ///
    /// The JSON field carrying this data is named `deliver_tx` in
    /// CometBFT versions before 0.38.
    #[serde(alias = "deliver_tx")]
    pub tx_result: abci::types::ExecTxResult,

    /// Transaction
    pub hash: Hash,

    /// Height
    pub height: block::Height,
}

impl crate::Response for Response {}

/// Serialization for /broadcast_tx_commit endpoint format in CometBFT 0.34
pub mod v0_34 {
    use super::Response;
    use crate::dialect;
    use crate::dialect::v0_34::Event;
    use cometbft::{block, Hash};
    use serde::{Deserialize, Serialize};

    /// RPC dialect helper for serialization of the response.
    #[derive(Debug, Deserialize, Serialize)]
    pub struct DialectResponse {
        /// `CheckTx` result
        pub check_tx: dialect::CheckTx<Event>,

        /// `DeliverTx` result
        pub deliver_tx: dialect::DeliverTx<Event>,

        /// Transaction
        pub hash: Hash,

        /// Height
        pub height: block::Height,
    }

    impl crate::Response for DialectResponse {}

    impl From<DialectResponse> for Response {
        fn from(msg: DialectResponse) -> Self {
            Self {
                check_tx: msg.check_tx.into(),
                tx_result: msg.deliver_tx.into(),
                hash: msg.hash,
                height: msg.height,
            }
        }
    }
}