bdk_bitcoind_client 0.2.0

A minimal `bitcoind` RPC client custom built for BDK
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

// SPDX-License-Identifier: MIT OR Apache-2.0

/// Strongly-typed Bitcoin Core RPC method names.
///
/// Each variant corresponds to a Bitcoin Core JSON-RPC method. The
/// [`Display`](core::fmt::Display) implementation produces the exact lowercase
/// method name string expected by Bitcoin Core.
///
/// These are used internally by [`bitreq::Client`](crate::bitreq::Client) methods
/// and can also be passed directly to [`Client::call`](crate::Client::call)
/// as the `method` argument via [`Rpc::to_string`](std::string::ToString::to_string).
///
/// See <https://bitcoincore.org/en/doc/> for the full RPC reference.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
#[non_exhaustive]
pub enum Rpc {
    /// `getbestblockhash` — returns the hash of the best (tip) block.
    GetBestBlockHash,
    /// `getblock` — returns block data for a given block hash.
    GetBlock,
    /// `getblockcount` — returns the height of the most-work fully-validated chain.
    GetBlockCount,
    /// `getblockfilter` — returns the BIP-158 compact block filter for a block.
    GetBlockFilter,
    /// `getblockhash` — returns the block hash at a given height.
    GetBlockHash,
    /// `getblockheader` — returns block header data for a given block hash.
    GetBlockHeader,
    /// `getrawmempool` — returns all transaction IDs in the memory pool.
    GetRawMempool,
    /// `getrawtransaction` — returns raw transaction data for a given txid.
    GetRawTransaction,
    /// `getblockchaininfo` - returns information about the blockchain state.
    GetBlockchainInfo,
    /// `sendrawtransaction` - send raw transaction to the network.
    SendRawTransaction,
}

impl core::fmt::Display for Rpc {
    fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
        let s = match self {
            Self::GetBestBlockHash => "getbestblockhash",
            Self::GetBlock => "getblock",
            Self::GetBlockCount => "getblockcount",
            Self::GetBlockFilter => "getblockfilter",
            Self::GetBlockHash => "getblockhash",
            Self::GetBlockHeader => "getblockheader",
            Self::GetRawMempool => "getrawmempool",
            Self::GetRawTransaction => "getrawtransaction",
            Self::GetBlockchainInfo => "getblockchaininfo",
            Self::SendRawTransaction => "sendrawtransaction",
        };
        write!(f, "{s}")
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn rpc_display_lowercase() {
        assert_eq!(Rpc::GetBestBlockHash.to_string(), "getbestblockhash");
        assert_eq!(Rpc::GetBlock.to_string(), "getblock");
        assert_eq!(Rpc::GetBlockCount.to_string(), "getblockcount");
        assert_eq!(Rpc::GetBlockFilter.to_string(), "getblockfilter");
        assert_eq!(Rpc::GetBlockHash.to_string(), "getblockhash");
        assert_eq!(Rpc::GetBlockHeader.to_string(), "getblockheader");
        assert_eq!(Rpc::GetRawMempool.to_string(), "getrawmempool");
        assert_eq!(Rpc::GetRawTransaction.to_string(), "getrawtransaction");
        assert_eq!(Rpc::SendRawTransaction.to_string(), "sendrawtransaction");
        assert_eq!(Rpc::GetBlockchainInfo.to_string(), "getblockchaininfo");
    }
}