corepc-client 0.12.0

Bitcoin Core JSON-RPC client
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

// SPDX-License-Identifier: CC0-1.0

//! Macros for implementing JSON-RPC methods on a client.
//!
//! Specifically this is methods found under the `== Blockchain ==` section of the
//! API docs of Bitcoin Core `v25`.
//!
//! All macros require `Client` to be in scope.
//!
//! See or use the `define_jsonrpc_bitreq_client!` macro to define a `Client`.

/// Implements Bitcoin Core JSON-RPC API method `scanblocks`
#[macro_export]
macro_rules! impl_client_v25__scan_blocks {
    () => {
        impl Client {
            /// Aborts an ongoing `scanblocks` scan.
            pub fn scan_blocks_abort(&self) -> Result<ScanBlocksAbort> {
                self.call("scanblocks", &[into_json("abort")?])
            }

            /// Starts a scan of blocks for specified descriptors.
            pub fn scan_blocks_start(&self, scan_objects: &[&str]) -> Result<ScanBlocksStart> {
                self.call("scanblocks", &[into_json("start")?, into_json(scan_objects)?])
            }

            /// Checks the status of an ongoing `scanblocks` scan.
            pub fn scan_blocks_status(&self) -> Result<Option<ScanBlocksStatus>> {
                self.call("scanblocks", &[into_json("status")?])
            }
        }
    };
}