Skip to content

Commit de79923

Browse files
RandyMcMillanRandyMcMillan
committed
src/lib.rs:more docs
1 parent 964d07c commit de79923

File tree

1 file changed

+226
-8
lines changed

1 file changed

+226
-8
lines changed

‎src/lib.rs

Lines changed: 226 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,227 @@
1-
// Originally based on the reachable repo.
2-
//
3-
// This Source Code Form is subject to the terms of the Mozilla Public
4-
// License, v. 2.0. If a copy of the MPL was not distributed with this
5-
// file, You can obtain one at http://mozilla.org/MPL/2.0/.
6-
//
7-
// Author: Simon Brummer ([email protected])
1+
//! # mempool-space (command line utility)
2+
//!
3+
//! cargo install \--git <https://github.com/RandyMcMillan/mempool_space.git>
4+
//!
5+
//! cargo add \--git <https://github.com/RandyMcMillan/mempool_space.git>
6+
7+
//! ## CLI: [mempool-space](https://docs.rs/mempool_space/latest/mempool_space) \--option arg<sub>1</sub> ... \--option arg<sub>n</sub>
8+
//!
9+
//! mempool-space --option
10+
//! mempool-space --option arg
11+
//! mempool-space --option arg --option arg
12+
//!
13+
//! ## BIN: mempool-space_option arg<sub>1</sub> ... arg<sub>n</sub>
14+
//!
15+
//! mempool-space_option
16+
//! mempool-space_option arg
17+
//! mempool-space_option arg arg
18+
//!
19+
20+
//! ## [GENERAL](https://mempool.space/docs/api/rest#get-difficulty-adjustment)
21+
22+
//! ##### [GET /api/v1/difficulty-adjustment](https://mempool.space/api/v1/difficulty-adjustment)
23+
//!
24+
//! mempool-space --difficulty_adjustment
25+
//! mempool-space_difficulty_adjustment
26+
//! <hr>
27+
//!
28+
//! ##### [GET /api/v1/prices](https://mempool.space/api/v1/prices)
29+
//!
30+
//! mempool-space --prices
31+
//! mempool-space_prices
32+
//! <hr>
33+
//!
34+
//! ##### [GET /api/v1/historical-price?currency=EUR&timestamp=1500000000](https://mempool.space/api/v1/historical-price?currency=EUR&timestamp=1500000000)
35+
//!
36+
//! mempool-space --historical_price --currency [USD EUR GBP CAD CHF AUD JPY] --timestamp UTC_SECS
37+
//! mempool-space --historical_price --currency EUR --timestamp 1500000000
38+
//! mempool-space --historical_price --currency USD --timestamp $(date +%s)
39+
//! <hr>
40+
//!
41+
//!
42+
//! ## [ADDRESSES](https://mempool.space/docs/api/rest#get-address)
43+
//!
44+
//! ##### [GET /api/address:address](https://mempool.space/api/address/1wiz18xYmhRX6xStj2b9t1rwWX4GKUgpv)
45+
//!
46+
//! mempool-space --address 1wiz18xYmhRX6xStj2b9t1rwWX4GKUgpv
47+
//! mempool-space_address 1wiz18xYmhRX6xStj2b9t1rwWX4GKUgpv
48+
//! <hr>
49+
//!
50+
//! ##### [GET /api/address:address/txs](https://mempool.space/api/address/1wiz18xYmhRX6xStj2b9t1rwWX4GKUgpv/txs)
51+
//!
52+
//! mempool-space --address_txs 1wiz18xYmhRX6xStj2b9t1rwWX4GKUgpv
53+
//! mempool-space_address_txs 1wiz18xYmhRX6xStj2b9t1rwWX4GKUgpv
54+
//! <hr>
55+
//!
56+
//! ##### [GET /api/address:address/txs/chain](https://mempool.space/api/address/1wiz18xYmhRX6xStj2b9t1rwWX4GKUgpv/txs/chain)
57+
//!
58+
//! mempool-space --address_txs_chain 1wiz18xYmhRX6xStj2b9t1rwWX4GKUgpv
59+
//! mempool-space_address_txs_chain 1wiz18xYmhRX6xStj2b9t1rwWX4GKUgpv
60+
//! <hr>
61+
//!
62+
//! ##### [GET /api/address:address/txs/mempool](https://mempool.space/api/address/1wiz18xYmhRX6xStj2b9t1rwWX4GKUgpv/txs/mempool) (may be empty for test address)
63+
//!
64+
//! mempool-space --address_txs_mempool 1wiz18xYmhRX6xStj2b9t1rwWX4GKUgpv
65+
//! mempool-space_address_txs_mempool 1wiz18xYmhRX6xStj2b9t1rwWX4GKUgpv
66+
//! <hr>
67+
//!
68+
//! ##### [GET /api/address:address/utxo](https://mempool.space/api/address/1wiz18xYmhRX6xStj2b9t1rwWX4GKUgpv/utxo)
69+
//!
70+
//! mempool-space --address_utxo 1wiz18xYmhRX6xStj2b9t1rwWX4GKUgpv
71+
//! mempool-space_address_utxo 1wiz18xYmhRX6xStj2b9t1rwWX4GKUgpv
72+
//! <hr>
73+
74+
//!
75+
//!
76+
//! mempool-space_block
77+
//!
78+
//! mempool-space_block_audit_score
79+
//!
80+
//! mempool-space_block_audit_scores
81+
//!
82+
//! mempool-space_block_audit_summary
83+
//!
84+
//! mempool-space_block_feerates
85+
//!
86+
//! mempool-space_block_header
87+
//!
88+
//! mempool-space_block_height
89+
//!
90+
//! mempool-space_block_predictions
91+
//!
92+
//! mempool-space_block_raw
93+
//!
94+
//! mempool-space_block_rewards
95+
//!
96+
//! mempool-space_block_sizes_and_weights
97+
//!
98+
//! mempool-space_block_status
99+
//!
100+
//! mempool-space_block_timestamp
101+
//!
102+
//! mempool-space_block_txid
103+
//!
104+
//! mempool-space_block_txids
105+
//!
106+
//! mempool-space_block_txs
107+
//!
108+
//! mempool-space_blockheight
109+
//!
110+
//! mempool-space_blocks
111+
//!
112+
//! mempool-space_blocks_bulk
113+
//!
114+
//! mempool-space_blocks_height
115+
//!
116+
//! mempool-space_blocks_timestamp
117+
//!
118+
//! mempool-space_blocks_tip
119+
//!
120+
//! mempool-space_blocks_tip_hash
121+
//!
122+
//! mempool-space_blocks_tip_height
123+
//!
124+
//! mempool-space_children_pay_for_parent
125+
//!
126+
//!
127+
//! ##### [GET /api/v1/difficulty-adjustment](https://mempool.space/api/v1/difficulty-adjustment)
128+
//!
129+
//! mempool-space --difficulty_adjustment
130+
//! mempool-space_difficulty_adjustment
131+
//! <hr>
132+
//!
133+
//! mempool-space_hashrate
134+
//!
135+
//! mempool-space_historical_price
136+
//!
137+
//! mempool-space_lighting_channel
138+
//!
139+
//! mempool-space_lighting_channel_geodata
140+
//!
141+
//! mempool-space_lighting_channel_geodata_for_node
142+
//!
143+
//! mempool-space_lighting_channels_from_node_pubkey
144+
//!
145+
//! mempool-space_lighting_channels_from_txid
146+
//!
147+
//! mempool-space_lighting_isp_nodes
148+
//!
149+
//! mempool-space_lighting_network_status
150+
//!
151+
//! mempool-space_lighting_node_stats
152+
//!
153+
//! mempool-space_lighting_node_stats_per_country
154+
//!
155+
//! mempool-space_lighting_nodes_channels
156+
//!
157+
//! mempool-space_lighting_nodes_in_country
158+
//!
159+
//! mempool-space_lighting_nodes_stats_per_isp
160+
//!
161+
//! mempool-space_lighting_top_nodes
162+
//!
163+
//! mempool-space_lighting_top_nodes_by_connectivity
164+
//!
165+
//! mempool-space_lighting_top_nodes_by_liquidity
166+
//!
167+
//! mempool-space_lighting_top_oldests_nodes
168+
//!
169+
//! mempool-space_mempool
170+
//!
171+
//! mempool-space_mempool_blocks_fees
172+
//!
173+
//! mempool-space_mempool_full_rbf_transactions
174+
//!
175+
//! mempool-space_mempool_rbf_transactions
176+
//!
177+
//! mempool-space_mempool_recent
178+
//!
179+
//! mempool-space_mining_blocks_timestamp
180+
//!
181+
//! mempool-space_mining_pool
182+
//!
183+
//! mempool-space_mining_pool_blocks
184+
//!
185+
//! mempool-space_mining_pool_hashrate
186+
//!
187+
//! mempool-space_mining_pool_hashrates
188+
//!
189+
//! mempool-space_mining_pools
190+
//!
191+
//! mempool-space_post_transaction
192+
//!
193+
//! mempool-space_prices
194+
//!
195+
//! mempool-space_reachable
196+
//!
197+
//! mempool-space_recomended_fees
198+
//!
199+
//! mempool-space_reward_stats
200+
//!
201+
//! mempool-space_splash
202+
//!
203+
//! mempool-space_transaction
204+
//!
205+
//! mempool-space_transaction_hex
206+
//!
207+
//! mempool-space_transaction_merkle_block_proof
208+
//!
209+
//! mempool-space_transaction_merkle_proof
210+
//!
211+
//! mempool-space_transaction_outspend
212+
//!
213+
//! mempool-space_transaction_outspends
214+
//!
215+
//! mempool-space_transaction_raw
216+
//!
217+
//! mempool-space_transaction_rbf_timeline
218+
//!
219+
//! mempool-space_transaction_status
220+
//!
221+
//! mempool-space_transaction_times
222+
//!
223+
//! mempool-space_validate_address
224+
//!
8225
9226
#![warn(missing_docs, clippy::unwrap_used)]
10227

@@ -23,7 +240,8 @@
23240
///
24241
/// TESTING 2
25242
26-
// #[warn(missing_docs, clippy::unwrap_used)]
243+
#[warn(missing_docs, clippy::unwrap_used)]
244+
27245
pub mod api;
28246
pub mod blockheight;
29247
pub mod blocking;

0 commit comments

Comments
 (0)