Skip to content

Commit

Permalink
Apply typo fixes from @tcharding
Browse files Browse the repository at this point in the history
Co-authored-by: Tobin C. Harding <[email protected]>
  • Loading branch information
LLFourn and tcharding authored Jul 14, 2021
1 parent 7597645 commit 81c1ccb
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/wallet/tx_builder.rs
Original file line number Diff line number Diff line change
Expand Up @@ -562,12 +562,12 @@ impl<'a, B, D: BatchDatabase, Cs: CoinSelectionAlgorithm<D>> TxBuilder<'a, B, D,

/// Sets the address to *drain* excess coins to.
///
/// Usually, when there is excess coins they are sent to a change address generated by the
/// Usually, when there are excess coins they are sent to a change address generated by the
/// wallet. This option replaces the usual change address with an arbitrary `script_pubkey` of
/// your choosing. Just as with a change output, if the drain output is not needed (the excess
/// coins are too small) it will not be included in the resulting transaction. The only
/// difference is that it is valid to use `drain_to` without setting any ordinary recipients
/// with [`add_recipient`] (but it is perfectly find to add recipients as well).
/// with [`add_recipient`] (but it is perfectly fine to add recipients as well).
///
/// When bumping the fees of a transaction made with this option, you probably want to
/// use [`allow_shrinking`] to allow this output to be reduced to pay for the extra fees.
Expand All @@ -587,9 +587,9 @@ impl<'a, B, D: BatchDatabase, Cs: CoinSelectionAlgorithm<D>> TxBuilder<'a, B, D,
/// let mut tx_builder = wallet.build_tx();
///
/// tx_builder
/// // spend all outputs in this wallet
/// // Spend all outputs in this wallet.
/// .drain_wallet()
/// // send the excess (which is all the coins minus the fee) to this address
/// // Send the excess (which is all the coins minus the fee) to this address.
/// .drain_to(to_address.script_pubkey())
/// .fee_rate(FeeRate::from_sat_per_vb(5.0))
/// .enable_rbf();
Expand All @@ -612,7 +612,7 @@ impl<'a, B, D: BatchDatabase> TxBuilder<'a, B, D, DefaultCoinSelectionAlgorithm,
/// `script_pubkey` in order to bump the transaction fee. Without specifying this the wallet
/// will attempt to find a change output to shrink instead.
///
/// **Note** that the output may shrunk to below the dust limit and therefore removed. If it is
/// **Note** that the output may shrink to below the dust limit and therefore be removed. If it is
/// preserved then it is currently not guaranteed to be in the same position as it was
/// originally.
///
Expand Down

0 comments on commit 81c1ccb

Please sign in to comment.