corepc_client/client_sync/v17/
mod.rs

1// SPDX-License-Identifier: CC0-1.0
2
3//! A JSON-RPC client for testing against Bitcoin Core `v0.17`.
4//!
5//! We ignore option arguments unless they effect the shape of the returned JSON data.
6
7pub mod blockchain;
8pub mod control;
9pub mod generating;
10pub mod mining;
11pub mod network;
12pub mod raw_transactions;
13pub mod util;
14pub mod wallet;
15pub mod zmq;
16
17use std::collections::{BTreeMap, HashMap};
18use std::path::Path;
19
20use bitcoin::address::{Address, NetworkChecked};
21use bitcoin::{sign_message, Amount, Block, BlockHash, PublicKey, Txid};
22use serde::{Deserialize, Serialize, Serializer};
23
24use crate::client_sync::into_json;
25use crate::types::v17::*;
26
27crate::define_jsonrpc_minreq_client!("v17");
28crate::impl_client_check_expected_server_version!({ [170200] });
29
30// == Blockchain ==
31crate::impl_client_v17__get_best_block_hash!();
32crate::impl_client_v17__get_block!();
33crate::impl_client_v17__get_blockchain_info!();
34crate::impl_client_v17__get_block_count!();
35crate::impl_client_v17__get_block_hash!();
36crate::impl_client_v17__get_block_header!();
37crate::impl_client_v17__get_block_stats!();
38crate::impl_client_v17__get_chain_tips!();
39crate::impl_client_v17__get_chain_tx_stats!();
40crate::impl_client_v17__get_difficulty!();
41crate::impl_client_v17__get_mempool_ancestors!();
42crate::impl_client_v17__get_mempool_descendants!();
43crate::impl_client_v17__get_mempool_entry!();
44crate::impl_client_v17__get_mempool_info!();
45crate::impl_client_v17__get_raw_mempool!();
46crate::impl_client_v17__get_tx_out!();
47crate::impl_client_v17__get_tx_out_proof!();
48crate::impl_client_v17__get_tx_out_set_info!();
49crate::impl_client_v17__precious_block!();
50crate::impl_client_v17__prune_blockchain!();
51crate::impl_client_v17__save_mempool!();
52crate::impl_client_v17__verify_chain!();
53crate::impl_client_v17__verify_tx_out_proof!();
54
55// == Control ==
56crate::impl_client_v17__get_memory_info!();
57crate::impl_client_v17__help!();
58crate::impl_client_v17__logging!();
59crate::impl_client_v17__stop!();
60crate::impl_client_v17__uptime!();
61
62// == Generating ==
63crate::impl_client_v17__generate_to_address!();
64crate::impl_client_v17__generate!();
65crate::impl_client_v17__invalidate_block!();
66
67// == Mining ==
68crate::impl_client_v17__get_block_template!();
69crate::impl_client_v17__get_mining_info!();
70crate::impl_client_v17__get_network_hashes_per_second!();
71crate::impl_client_v17__prioritise_transaction!();
72crate::impl_client_v17__submit_block!();
73
74// == Network ==
75crate::impl_client_v17__add_node!();
76crate::impl_client_v17__clear_banned!();
77crate::impl_client_v17__disconnect_node!();
78crate::impl_client_v17__get_added_node_info!();
79crate::impl_client_v17__get_connection_count!();
80crate::impl_client_v17__get_net_totals!();
81crate::impl_client_v17__get_network_info!();
82crate::impl_client_v17__get_peer_info!();
83crate::impl_client_v17__list_banned!();
84crate::impl_client_v17__ping!();
85crate::impl_client_v17__set_ban!();
86crate::impl_client_v17__set_network_active!();
87
88// == Rawtransactions ==
89crate::impl_client_v17__combine_psbt!();
90crate::impl_client_v17__combine_raw_transaction!();
91crate::impl_client_v17__convert_to_psbt!();
92crate::impl_client_v17__create_psbt!();
93crate::impl_client_v17__create_raw_transaction!();
94crate::impl_client_v17__decode_psbt!();
95crate::impl_client_v17__decode_raw_transaction!();
96crate::impl_client_v17__decode_script!();
97crate::impl_client_v17__finalize_psbt!();
98crate::impl_client_v17__fund_raw_transaction!();
99crate::impl_client_v17__get_raw_transaction!();
100crate::impl_client_v17__send_raw_transaction!();
101crate::impl_client_v17__sign_raw_transaction!();
102crate::impl_client_v17__sign_raw_transaction_with_key!();
103crate::impl_client_v17__test_mempool_accept!();
104
105// == Util ==
106crate::impl_client_v17__create_multisig!();
107crate::impl_client_v17__estimate_smart_fee!();
108crate::impl_client_v17__sign_message_with_priv_key!();
109crate::impl_client_v17__validate_address!();
110crate::impl_client_v17__verify_message!();
111
112// == Wallet ==
113crate::impl_client_v17__abandon_transaction!();
114crate::impl_client_v17__abort_rescan!();
115crate::impl_client_v17__add_multisig_address!();
116crate::impl_client_v17__backup_wallet!();
117crate::impl_client_v17__bump_fee!();
118crate::impl_client_v17__create_wallet!();
119crate::impl_client_v17__dump_priv_key!();
120crate::impl_client_v17__dump_wallet!();
121crate::impl_client_v17__encrypt_wallet!();
122crate::impl_client_v17__get_addresses_by_label!();
123crate::impl_client_v17__get_address_info!();
124crate::impl_client_v17__get_balance!();
125crate::impl_client_v17__get_new_address!();
126crate::impl_client_v17__get_raw_change_address!();
127crate::impl_client_v17__get_received_by_address!();
128crate::impl_client_v17__get_transaction!();
129crate::impl_client_v17__get_unconfirmed_balance!();
130crate::impl_client_v17__get_wallet_info!();
131crate::impl_client_v17__import_address!();
132crate::impl_client_v17__import_multi!();
133crate::impl_client_v17__import_privkey!();
134crate::impl_client_v17__import_pruned_funds!();
135crate::impl_client_v17__import_pubkey!();
136crate::impl_client_v17__import_wallet!();
137crate::impl_client_v17__key_pool_refill!();
138crate::impl_client_v17__list_address_groupings!();
139crate::impl_client_v17__list_labels!();
140crate::impl_client_v17__list_lock_unspent!();
141crate::impl_client_v17__list_received_by_address!();
142crate::impl_client_v17__list_since_block!();
143crate::impl_client_v17__list_transactions!();
144crate::impl_client_v17__list_unspent!();
145crate::impl_client_v17__list_wallets!();
146crate::impl_client_v17__load_wallet!();
147crate::impl_client_v17__lock_unspent!();
148crate::impl_client_v17__remove_pruned_funds!();
149crate::impl_client_v17__rescan_blockchain!();
150crate::impl_client_v17__send_many!();
151crate::impl_client_v17__send_to_address!();
152crate::impl_client_v17__set_hd_seed!();
153crate::impl_client_v17__set_tx_fee!();
154crate::impl_client_v17__sign_message!();
155crate::impl_client_v17__sign_raw_transaction_with_wallet!();
156crate::impl_client_v17__unload_wallet!();
157crate::impl_client_v17__wallet_create_funded_psbt!();
158crate::impl_client_v17__wallet_lock!();
159crate::impl_client_v17__wallet_passphrase!();
160crate::impl_client_v17__wallet_passphrase_change!();
161crate::impl_client_v17__wallet_process_psbt!();
162
163// == Zmq ==
164crate::impl_client_v17__get_zmq_notifications!();
165
166/// Argument to the `Client::get_new_address_with_type` function.
167///
168/// For Core versions 0.17 through to v22. For Core v23 and onwards use `v23::AddressType`.
169#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
170#[serde(rename_all = "kebab-case")]
171pub enum AddressType {
172    Legacy,
173    P2shSegwit,
174    Bech32,
175}
176
177impl fmt::Display for AddressType {
178    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
179        use AddressType::*;
180
181        let s = match *self {
182            Legacy => "legacy",
183            P2shSegwit => "p2sh-segwit",
184            Bech32 => "bech32",
185        };
186        fmt::Display::fmt(s, f)
187    }
188}
189
190/// Arg for the `getblocktemplate` method.
191///
192/// For Core versions 0.17 through to v28. For Core v29 and onwards use `v29::TemplateRequest`.
193#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
194pub struct TemplateRequest {
195    /// A list of strings.
196    pub rules: Vec<TemplateRules>,
197}
198
199/// Client side supported softfork deployment.
200#[derive(Copy, Clone, PartialEq, Eq, Debug, Deserialize, Serialize)]
201#[serde(rename_all = "lowercase")]
202pub enum TemplateRules {
203    /// SegWit v0 supported.
204    Segwit,
205    /// Signet supported.
206    Signet,
207    /// CSV supported.
208    Csv,
209    /// Taproot supported.
210    Taproot,
211}
212
213/// Input used as parameter to `create_raw_transaction`.
214#[derive(Debug, Serialize)]
215pub struct Input {
216    /// The txid of the transaction that contains the UTXO.
217    pub txid: bitcoin::Txid,
218    /// The vout for the UTXO.
219    pub vout: u64,
220    /// Sequence number if needed.
221    pub sequence: Option<bitcoin::Sequence>,
222}
223
224/// Output used as parameter to `create_raw_transaction`.
225// Abuse `HashMap` so we can derive serialize to get the correct JSON object.
226#[derive(Debug, Serialize)]
227pub struct Output(
228    /// Map of address to value. Always only has a single item in it.
229    HashMap<String, f64>,
230);
231
232impl Output {
233    /// Creates a single output that serializes as Core expects.
234    pub fn new(addr: Address, value: Amount) -> Self {
235        let mut map = HashMap::new();
236        map.insert(addr.to_string(), value.to_btc());
237        Output(map)
238    }
239}
240
241/// An element in the `inputs` argument of method `walletcreatefundedpsbt`.
242#[derive(Clone, Debug, PartialEq, Deserialize, Serialize)]
243pub struct WalletCreateFundedPsbtInput {
244    txid: Txid,
245    vout: u32,
246}
247
248impl WalletCreateFundedPsbtInput {
249    /// Create a new walletcreatefundedpsbt input entry.
250    pub fn new(txid: Txid, vout: u32) -> Self { Self { txid, vout } }
251}
252
253/// Args for the `addnode` method.
254#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
255#[serde(rename_all = "lowercase")]
256pub enum AddNodeCommand {
257    Add,
258    Remove,
259    OneTry,
260}
261
262/// Args for the `setban` method.
263#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
264#[serde(rename_all = "lowercase")]
265pub enum SetBanCommand {
266    Add,
267    Remove,
268}
269
270/// Args for the `importmulti` method.
271#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
272pub struct ImportMultiRequest {
273    /// Descriptor to import. If using descriptor, do not also provide address/scriptPubKey, scripts, or pubkeys.
274    #[serde(rename = "desc", skip_serializing_if = "Option::is_none")]
275    pub descriptor: Option<String>, // from core v18 onwards.
276    /// Type of scriptPubKey (string for script, json for address). Should not be provided if using descriptor.
277    #[serde(rename = "scriptPubKey", skip_serializing_if = "Option::is_none")]
278    pub script_pubkey: Option<ImportMultiScriptPubKey>,
279    /// Creation time of the key expressed in UNIX epoch time, or the string "now" to substitute the current synced blockchain time.
280    pub timestamp: ImportMultiTimestamp,
281}
282
283/// `scriptPubKey` can be a string for script or json for address.
284#[derive(Clone, Debug, Deserialize, PartialEq, Serialize)]
285#[serde(untagged)]
286pub enum ImportMultiScriptPubKey {
287    /// The script.
288    Script(String),
289    /// The address.
290    Address { address: String },
291}
292
293/// `timestamp` can be a number (UNIX epoch time) or the string `"now"`.
294#[derive(Clone, Debug, Deserialize, PartialEq)]
295#[serde(untagged)]
296pub enum ImportMultiTimestamp {
297    /// The string "now".
298    Now,
299    /// The UNIX timestamp.
300    Time(u64),
301}
302
303impl Serialize for ImportMultiTimestamp {
304    fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
305    where
306        S: Serializer,
307    {
308        match self {
309            ImportMultiTimestamp::Now => serializer.serialize_str("now"),
310            ImportMultiTimestamp::Time(t) => serializer.serialize_u64(*t),
311        }
312    }
313}
corepc_client/client_sync/v17/mod.rs

corepc_client/client_sync/v17/
mod.rs
