Skip to content

Commit eabe4bf

Browse files
committed
chore(docs): add missing structure documentation
1 parent 006590d commit eabe4bf

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

src/api.rs

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@ pub use bitcoin::consensus::{deserialize, serialize};
2121
use bitcoin::hash_types::TxMerkleNode;
2222
pub use bitcoin::hex::FromHex;
2323
pub use bitcoin::{
24-
absolute, block, transaction, Amount, BlockHash, CompactTarget, FeeRate, OutPoint, ScriptBuf,
25-
Transaction, TxIn, TxOut, Txid, Weight, Witness, Wtxid,
24+
absolute, block, transaction, Address, Amount, Block, BlockHash, CompactTarget, FeeRate,
25+
OutPoint, Script, ScriptBuf, ScriptHash, Transaction, TxIn, TxOut, Txid, Weight, Witness,
26+
Wtxid,
2627
};
2728

2829
/// Information about a previous output.
@@ -312,6 +313,7 @@ pub struct MempoolRecentTx {
312313
pub value: u64,
313314
}
314315

316+
/// The result for a broadcasted package of [`Transaction`]s.
315317
#[derive(Deserialize, Debug)]
316318
pub struct SubmitPackageResult {
317319
/// The transaction package result message. "success" indicates all transactions were accepted
@@ -325,6 +327,7 @@ pub struct SubmitPackageResult {
325327
pub replaced_transactions: Option<Vec<Txid>>,
326328
}
327329

330+
/// The result [`Transaction`] for a broadcasted package of [`Transaction`]s.
328331
#[derive(Deserialize, Debug)]
329332
pub struct TxResult {
330333
/// The transaction id.
@@ -343,6 +346,7 @@ pub struct TxResult {
343346
pub error: Option<String>,
344347
}
345348

349+
/// The mempool fees for a resulting [`Transaction`] broadcasted by a package of [`Transaction`]s.
346350
#[derive(Deserialize, Debug)]
347351
pub struct MempoolFeesSubmitPackage {
348352
/// Transaction fee.

src/async.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -381,10 +381,10 @@ impl<S: Sleeper> AsyncClient<S> {
381381

382382
/// Broadcast a package of [`Transaction`] to Esplora
383383
///
384-
/// if `maxfeerate` is provided, any transaction whose
384+
/// If `maxfeerate` is provided, any transaction whose
385385
/// fee is higher will be rejected
386386
///
387-
/// if `maxburnamount` is provided, any transaction
387+
/// If `maxburnamount` is provided, any transaction
388388
/// with higher provably unspendable outputs amount
389389
/// will be rejected
390390
pub async fn submit_package(

src/blocking.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -316,10 +316,10 @@ impl BlockingClient {
316316

317317
/// Broadcast a package of [`Transaction`] to Esplora
318318
///
319-
/// if `maxfeerate` is provided, any transaction whose
319+
/// If `maxfeerate` is provided, any transaction whose
320320
/// fee is higher will be rejected
321321
///
322-
/// if `maxburnamount` is provided, any transaction
322+
/// If `maxburnamount` is provided, any transaction
323323
/// with higher provably unspendable outputs amount
324324
/// will be rejected
325325
pub fn submit_package(

0 commit comments

Comments
 (0)