Skip to content

Commit 556ab68

Browse files
committed
f send docs
1 parent 93d840d commit 556ab68

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

lightning/src/ln/channel.rs

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5518,10 +5518,10 @@ impl<Signer: Sign> Channel<Signer> {
55185518
/// we may not yet have sent the previous commitment update messages and will need to
55195519
/// regenerate them.
55205520
///
5521-
/// You MUST call `send_commitment_no_state_update` prior to calling any other methods on this
5522-
/// Channel if `force_holding_cell` is false.
5521+
/// You MUST call [`Self::send_commitment_no_state_update`] prior to calling any other methods
5522+
/// on this [`Channel]` if `force_holding_cell` is false.
55235523
///
5524-
/// If an Err is returned, it's a ChannelError::Ignore!
5524+
/// `Err`s will only be [`ChannelError::Ignore`].
55255525
fn send_htlc<L: Deref>(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource,
55265526
onion_routing_packet: msgs::OnionPacket, mut force_holding_cell: bool, logger: &L)
55275527
-> Result<Option<msgs::UpdateAddHTLC>, ChannelError> where L::Target: Logger {
@@ -5780,8 +5780,8 @@ impl<Signer: Sign> Channel<Signer> {
57805780
/// Adds a pending outbound HTLC to this channel, and creates a signed commitment transaction
57815781
/// to send to the remote peer in one go.
57825782
///
5783-
/// Shorthand for calling send_htlc() followed by a commitment update, see docs on `send_htlc`
5784-
/// and `send_commitment_no_state_update` for more info.
5783+
/// Shorthand for calling [`Self::send_htlc`] followed by a commitment update, see docs on
5784+
/// [`Self::send_htlc`] and [`Self::send_commitment_no_state_update`] for more info.
57855785
pub fn send_htlc_and_commit<L: Deref>(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource, onion_routing_packet: msgs::OnionPacket, logger: &L) -> Result<Option<(msgs::UpdateAddHTLC, msgs::CommitmentSigned, ChannelMonitorUpdate)>, ChannelError> where L::Target: Logger {
57865786
match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet, false, logger)? {
57875787
Some(update_add_htlc) => {

0 commit comments

Comments
 (0)