Skip to content

Commit 916f666

Browse files
committed
f rm'd send_commitment
1 parent f94f82e commit 916f666

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

lightning/src/ln/channel.rs

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3564,7 +3564,7 @@ impl<Signer: Sign> Channel<Signer> {
35643564
/// If our balance is too low to cover the cost of the next commitment transaction at the
35653565
/// new feerate, the update is cancelled.
35663566
///
3567-
/// You MUST call send_commitment prior to any other calls on this Channel if
3567+
/// You MUST call `send_commitment_no_state_update` prior to any other calls on this Channel if
35683568
/// `force_holding_cell` is false.
35693569
fn send_update_fee<L: Deref>(&mut self, feerate_per_kw: u32, mut force_holding_cell: bool, logger: &L) -> Option<msgs::UpdateFee> where L::Target: Logger {
35703570
if !self.is_outbound() {
@@ -5518,8 +5518,8 @@ 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 prior to calling any other methods on this Channel if
5522-
/// `force_holding_cell` is false.
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.
55235523
///
55245524
/// If an Err is returned, it's a ChannelError::Ignore!
55255525
fn send_htlc<L: Deref>(&mut self, amount_msat: u64, payment_hash: PaymentHash, cltv_expiry: u32, source: HTLCSource,
@@ -5779,8 +5779,9 @@ impl<Signer: Sign> Channel<Signer> {
57795779

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.
5782-
/// Shorthand for calling send_htlc() followed by send_commitment(), see docs on those for
5783-
/// more info.
5782+
///
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.
57845785
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 {
57855786
match self.send_htlc(amount_msat, payment_hash, cltv_expiry, source, onion_routing_packet, false, logger)? {
57865787
Some(update_add_htlc) => {

0 commit comments

Comments
 (0)