Skip to content
This repository was archived by the owner on Nov 26, 2024. It is now read-only.

Commit e60ae79

Browse files
authored
v17: Fix docs (#38)
Somehow these got lost, add the docs for recent v17 blockchain stuff. This should have been part of #29.
2 parents e74992a + 5ce06c6 commit e60ae79

File tree

1 file changed

+21
-16
lines changed

1 file changed

+21
-16
lines changed

json/src/v17/mod.rs

Lines changed: 21 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,14 @@
33
//! JSON-RPC types for `bitcoind v0.17.1`.
44
//!
55
//! These structs model the JSON data returned by the JSON-RPC API. They use stdlib types (or custom
6-
//! types), for more concrete types see [`crate::model`].
6+
//! types) and where necessary implement an `into_model` function to convert the type to a
7+
//! [`crate::model`] type of the same name. The types in this module are version specific, the types
8+
//! in the `model` module are version non-specific and are strongly typed using `rust-bitcoin`.
79
//!
8-
//! A `x` marks methods that are implemented _and_ tested.
10+
//! Key:
11+
//! - `[ ]` means not yet done.
12+
//! - `[x]` marks means implemented _and_ tested.
13+
//! - `[-]` means it was considered and intentionally not done.
914
//!
1015
//! **== Blockchain ==**
1116
//! - [x] `getbestblockhash`
@@ -18,20 +23,20 @@
1823
//! - [x] `getchaintips`
1924
//! - [x] `getchaintxstats ( nblocks blockhash )`
2025
//! - [x] `getdifficulty`
21-
//! - [ ] `getmempoolancestors txid (verbose)`
22-
//! - [ ] `getmempooldescendants txid (verbose)`
23-
//! - [ ] `getmempoolentry txid`
24-
//! - [ ] `getmempoolinfo`
25-
//! - [ ] `getrawmempool ( verbose )`
26-
//! - [ ] `gettxout "txid" n ( include_mempool )`
27-
//! - [ ] `gettxoutproof ["txid",...] ( blockhash )`
28-
//! - [ ] `gettxoutsetinfo`
29-
//! - [ ] `preciousblock "blockhash"`
30-
//! - [ ] `pruneblockchain`
31-
//! - [ ] `savemempool`
32-
//! - [ ] `scantxoutset <action> ( <scanobjects> )`
33-
//! - [ ] `verifychain ( checklevel nblocks )`
34-
//! - [ ] `verifytxoutproof "proof"`
26+
//! - [x] `getmempoolancestors txid (verbose)`
27+
//! - [x] `getmempooldescendants txid (verbose)`
28+
//! - [x] `getmempoolentry txid`
29+
//! - [x] `getmempoolinfo`
30+
//! - [x] `getrawmempool ( verbose )`
31+
//! - [x] `gettxout "txid" n ( include_mempool )`
32+
//! - [x] `gettxoutproof ["txid",...] ( blockhash )`
33+
//! - [x] `gettxoutsetinfo`
34+
//! - [x] `preciousblock "blockhash"`
35+
//! - [-] `pruneblockchain`
36+
//! - [-] `savemempool`
37+
//! - [-] `scantxoutset <action> ( <scanobjects> )`
38+
//! - [x] `verifychain ( checklevel nblocks )`
39+
//! - [-] `verifytxoutproof "proof"`
3540
//!
3641
//! **== Control ==**
3742
//! - [x] `getmemoryinfo ("mode")`

0 commit comments

Comments
 (0)