From: Savil Srivastava Date: Fri, 20 Jul 2018 00:26:27 +0000 (-0700) Subject: [Error] rename msg field to action X-Git-Tag: v0.0.12~385^2~1 X-Git-Url: http://git.bitcoin.ninja/?a=commitdiff_plain;h=fd141bbed2a900070cbecf7ef9f22e377e1f353f;p=rust-lightning [Error] rename msg field to action this was a TODO and also briefly discussed in https://github.com/rust-bitcoin/rust-lightning/pull/43#pullrequestreview-135649551 I'm not fully sure how to remove the `Option`, and make it completely required. Would love suggestions. So, have omitted that for now. Plus, better to make smaller, incremental changes. Test Plan: `cargo build` `cargo test` --- diff --git a/src/ln/channel.rs b/src/ln/channel.rs index ded81f60c..536d107dc 100644 --- a/src/ln/channel.rs +++ b/src/ln/channel.rs @@ -329,7 +329,7 @@ macro_rules! secp_call { match $res { Ok(key) => key, //TODO: make the error a parameter - Err(_) => return Err(HandleError{err: $err, msg: Some(msgs::ErrorAction::DisconnectPeer{})}) + Err(_) => return Err(HandleError{err: $err, action: Some(msgs::ErrorAction::DisconnectPeer{})}) } }; } @@ -434,10 +434,10 @@ impl Channel { fn check_remote_fee(fee_estimator: &FeeEstimator, feerate_per_kw: u32) -> Result<(), HandleError> { if (feerate_per_kw as u64) < fee_estimator.get_est_sat_per_vbyte(ConfirmationTarget::Background) * 250 { - return Err(HandleError{err: "Peer's feerate much too low", msg: Some(msgs::ErrorAction::DisconnectPeer{})}); + return Err(HandleError{err: "Peer's feerate much too low", action: Some(msgs::ErrorAction::DisconnectPeer{})}); } if (feerate_per_kw as u64) > fee_estimator.get_est_sat_per_vbyte(ConfirmationTarget::HighPriority) * 375 { // 375 = 250 * 1.5x - return Err(HandleError{err: "Peer's feerate much too high", msg: Some(msgs::ErrorAction::DisconnectPeer{})}); + return Err(HandleError{err: "Peer's feerate much too high", action: Some(msgs::ErrorAction::DisconnectPeer{})}); } Ok(()) } @@ -449,29 +449,29 @@ impl Channel { pub fn new_from_req(fee_estimator: &FeeEstimator, chan_keys: ChannelKeys, their_node_id: PublicKey, msg: &msgs::OpenChannel, user_id: u64, announce_publicly: bool) -> Result { // Check sanity of message fields: if msg.funding_satoshis >= MAX_FUNDING_SATOSHIS { - return Err(HandleError{err: "funding value > 2^24", msg: Some(msgs::ErrorAction::DisconnectPeer{})}); + return Err(HandleError{err: "funding value > 2^24", action: Some(msgs::ErrorAction::DisconnectPeer{})}); } if msg.channel_reserve_satoshis > msg.funding_satoshis { - return Err(HandleError{err: "Bogus channel_reserve_satoshis", msg: Some(msgs::ErrorAction::DisconnectPeer{})}); + return Err(HandleError{err: "Bogus channel_reserve_satoshis", action: Some(msgs::ErrorAction::DisconnectPeer{})}); } if msg.push_msat > (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 { - return Err(HandleError{err: "push_msat more than highest possible value", msg: Some(msgs::ErrorAction::DisconnectPeer{})}); + return Err(HandleError{err: "push_msat more than highest possible value", action: Some(msgs::ErrorAction::DisconnectPeer{})}); } if msg.dust_limit_satoshis > msg.funding_satoshis { - return Err(HandleError{err: "Peer never wants payout outputs?", msg: Some(msgs::ErrorAction::DisconnectPeer{})}); + return Err(HandleError{err: "Peer never wants payout outputs?", action: Some(msgs::ErrorAction::DisconnectPeer{})}); } if msg.htlc_minimum_msat >= (msg.funding_satoshis - msg.channel_reserve_satoshis) * 1000 { - return Err(HandleError{err: "Minimum htlc value is full channel value", msg: Some(msgs::ErrorAction::DisconnectPeer{})}); + return Err(HandleError{err: "Minimum htlc value is full channel value", action: Some(msgs::ErrorAction::DisconnectPeer{})}); } Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?; if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT { - return Err(HandleError{err: "They wanted our payments to be delayed by a needlessly long period", msg: Some(msgs::ErrorAction::DisconnectPeer{})}); + return Err(HandleError{err: "They wanted our payments to be delayed by a needlessly long period", action: Some(msgs::ErrorAction::DisconnectPeer{})}); } if msg.max_accepted_htlcs < 1 { - return Err(HandleError{err: "0 max_accpted_htlcs makes for a useless channel", msg: Some(msgs::ErrorAction::DisconnectPeer{})}); + return Err(HandleError{err: "0 max_accpted_htlcs makes for a useless channel", action: Some(msgs::ErrorAction::DisconnectPeer{})}); } if (msg.channel_flags & 254) != 0 { - return Err(HandleError{err: "unknown channel_flags", msg: Some(msgs::ErrorAction::DisconnectPeer{})}); + return Err(HandleError{err: "unknown channel_flags", action: Some(msgs::ErrorAction::DisconnectPeer{})}); } // Convert things into internal flags and prep our state: @@ -943,7 +943,7 @@ impl Channel { }, &HTLCUpdateAwaitingACK::FailHTLC { ref payment_hash, .. } => { if payment_hash_calc == *payment_hash { - return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", msg: None}); + return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", action: None}); } }, _ => {} @@ -970,14 +970,14 @@ impl Channel { } else if htlc.state == HTLCState::RemoteAnnounced { panic!("Somehow forwarded HTLC prior to remote revocation!"); } else if htlc.state == HTLCState::LocalRemoved || htlc.state == HTLCState::LocalRemovedAwaitingCommitment { - return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", msg: None}); + return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", action: None}); } else { panic!("Have an inbound HTLC when not awaiting remote revoke that had a garbage state"); } } } if htlc_amount_msat == 0 { - return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", msg: None}); + return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", action: None}); } self.channel_monitor.provide_payment_preimage(&payment_hash_calc, &payment_preimage_arg); @@ -1000,7 +1000,7 @@ impl Channel { pub fn get_update_fail_htlc(&mut self, payment_hash_arg: &[u8; 32], err_packet: msgs::OnionErrorPacket) -> Result, HandleError> { if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) { - return Err(HandleError{err: "Was asked to fail an HTLC when channel was not in an operational state", msg: None}); + return Err(HandleError{err: "Was asked to fail an HTLC when channel was not in an operational state", action: None}); } assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0); @@ -1010,7 +1010,7 @@ impl Channel { match pending_update { &HTLCUpdateAwaitingACK::ClaimHTLC { ref payment_hash, .. } => { if *payment_hash_arg == *payment_hash { - return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", msg: None}); + return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", action: None}); } }, &HTLCUpdateAwaitingACK::FailHTLC { ref payment_hash, .. } => { @@ -1042,14 +1042,14 @@ impl Channel { } else if htlc.state == HTLCState::RemoteAnnounced { panic!("Somehow forwarded HTLC prior to remote revocation!"); } else if htlc.state == HTLCState::LocalRemoved || htlc.state == HTLCState::LocalRemovedAwaitingCommitment { - return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", msg: None}); + return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", action: None}); } else { panic!("Have an inbound HTLC when not awaiting remote revoke that had a garbage state"); } } } if htlc_amount_msat == 0 { - return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", msg: None}); + return Err(HandleError{err: "Unable to find a pending HTLC which matched the given payment preimage", action: None}); } Ok(Some(msgs::UpdateFailHTLC { @@ -1074,26 +1074,26 @@ impl Channel { pub fn accept_channel(&mut self, msg: &msgs::AcceptChannel) -> Result<(), HandleError> { // Check sanity of message fields: if !self.channel_outbound { - return Err(HandleError{err: "Got an accept_channel message from an inbound peer", msg: None}); + return Err(HandleError{err: "Got an accept_channel message from an inbound peer", action: None}); } if self.channel_state != ChannelState::OurInitSent as u32 { - return Err(HandleError{err: "Got an accept_channel message at a strange time", msg: None}); + return Err(HandleError{err: "Got an accept_channel message at a strange time", action: None}); } if msg.dust_limit_satoshis > 21000000 * 100000000 { - return Err(HandleError{err: "Peer never wants payout outputs?", msg: None}); + return Err(HandleError{err: "Peer never wants payout outputs?", action: None}); } if msg.channel_reserve_satoshis > self.channel_value_satoshis { - return Err(HandleError{err: "Bogus channel_reserve_satoshis", msg: None}); + return Err(HandleError{err: "Bogus channel_reserve_satoshis", action: None}); } if msg.htlc_minimum_msat >= (self.channel_value_satoshis - msg.channel_reserve_satoshis) * 1000 { - return Err(HandleError{err: "Minimum htlc value is full channel value", msg: None}); + return Err(HandleError{err: "Minimum htlc value is full channel value", action: None}); } //TODO do something with minimum_depth if msg.to_self_delay > MAX_LOCAL_BREAKDOWN_TIMEOUT { - return Err(HandleError{err: "They wanted our payments to be delayed by a needlessly long period", msg: None}); + return Err(HandleError{err: "They wanted our payments to be delayed by a needlessly long period", action: None}); } if msg.max_accepted_htlcs < 1 { - return Err(HandleError{err: "0 max_accpted_htlcs makes for a useless channel", msg: None}); + return Err(HandleError{err: "0 max_accpted_htlcs makes for a useless channel", action: None}); } self.channel_monitor.set_their_htlc_base_key(&msg.htlc_basepoint); @@ -1140,10 +1140,10 @@ impl Channel { pub fn funding_created(&mut self, msg: &msgs::FundingCreated) -> Result<(msgs::FundingSigned, ChannelMonitor), HandleError> { if self.channel_outbound { - return Err(HandleError{err: "Received funding_created for an outbound channel?", msg: None}); + return Err(HandleError{err: "Received funding_created for an outbound channel?", action: None}); } if self.channel_state != (ChannelState::OurInitSent as u32 | ChannelState::TheirInitSent as u32) { - return Err(HandleError{err: "Received funding_created after we got the channel!", msg: None}); + return Err(HandleError{err: "Received funding_created after we got the channel!", action: None}); } if self.channel_monitor.get_min_seen_secret() != (1 << 48) || self.cur_remote_commitment_transaction_number != (1 << 48) - 1 || self.cur_local_commitment_transaction_number != (1 << 48) - 1 { panic!("Should not have advanced channel commitment tx numbers prior to funding_created"); @@ -1179,10 +1179,10 @@ impl Channel { /// If this call is successful, broadcast the funding transaction (and not before!) pub fn funding_signed(&mut self, msg: &msgs::FundingSigned) -> Result { if !self.channel_outbound { - return Err(HandleError{err: "Received funding_signed for an inbound channel?", msg: None}); + return Err(HandleError{err: "Received funding_signed for an inbound channel?", action: None}); } if self.channel_state != ChannelState::FundingCreated as u32 { - return Err(HandleError{err: "Received funding_signed in strange state!", msg: None}); + return Err(HandleError{err: "Received funding_signed in strange state!", action: None}); } if self.channel_monitor.get_min_seen_secret() != (1 << 48) || self.cur_remote_commitment_transaction_number != (1 << 48) - 2 || self.cur_local_commitment_transaction_number != (1 << 48) - 1 { panic!("Should not have advanced channel commitment tx numbers prior to funding_created"); @@ -1214,7 +1214,7 @@ impl Channel { self.channel_state = ChannelState::ChannelFunded as u32 | (self.channel_state & BOTH_SIDES_SHUTDOWN_MASK); self.channel_update_count += 1; } else { - return Err(HandleError{err: "Peer sent a funding_locked at a strange time", msg: None}); + return Err(HandleError{err: "Peer sent a funding_locked at a strange time", action: None}); } self.their_prev_commitment_point = Some(self.their_cur_commitment_point); @@ -1259,35 +1259,35 @@ impl Channel { pub fn update_add_htlc(&mut self, msg: &msgs::UpdateAddHTLC, pending_forward_state: PendingForwardHTLCInfo) -> Result<(), HandleError> { if (self.channel_state & (ChannelState::ChannelFunded as u32 | ChannelState::RemoteShutdownSent as u32)) != (ChannelState::ChannelFunded as u32) { - return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", msg: None}); + return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None}); } if msg.amount_msat > self.channel_value_satoshis * 1000 { - return Err(HandleError{err: "Remote side tried to send more than the total value of the channel", msg: None}); + return Err(HandleError{err: "Remote side tried to send more than the total value of the channel", action: None}); } if msg.amount_msat < self.our_htlc_minimum_msat { - return Err(HandleError{err: "Remote side tried to send less than our minimum HTLC value", msg: None}); + return Err(HandleError{err: "Remote side tried to send less than our minimum HTLC value", action: None}); } let (inbound_htlc_count, _, htlc_outbound_value_msat, htlc_inbound_value_msat) = self.get_pending_htlc_stats(true); if inbound_htlc_count + 1 > OUR_MAX_HTLCS as u32 { - return Err(HandleError{err: "Remote tried to push more than our max accepted HTLCs", msg: None}); + return Err(HandleError{err: "Remote tried to push more than our max accepted HTLCs", action: None}); } //TODO: Spec is unclear if this is per-direction or in total (I assume per direction): // Check our_max_htlc_value_in_flight_msat if htlc_inbound_value_msat + msg.amount_msat > Channel::get_our_max_htlc_value_in_flight_msat(self.channel_value_satoshis) { - return Err(HandleError{err: "Remote HTLC add would put them over their max HTLC value in flight", msg: None}); + return Err(HandleError{err: "Remote HTLC add would put them over their max HTLC value in flight", action: None}); } // Check our_channel_reserve_satoshis (we're getting paid, so they have to at least meet // the reserve_satoshis we told them to always have as direct payment so that they lose // something if we punish them for broadcasting an old state). if htlc_inbound_value_msat + htlc_outbound_value_msat + msg.amount_msat + self.value_to_self_msat > (self.channel_value_satoshis - Channel::get_our_channel_reserve_satoshis(self.channel_value_satoshis)) * 1000 { - return Err(HandleError{err: "Remote HTLC add would put them over their reserve value", msg: None}); + return Err(HandleError{err: "Remote HTLC add would put them over their reserve value", action: None}); } if self.next_remote_htlc_id != msg.htlc_id { - return Err(HandleError{err: "Remote skipped HTLC ID", msg: None}); + return Err(HandleError{err: "Remote skipped HTLC ID", action: None}); } if msg.cltv_expiry >= 500000000 { - return Err(HandleError{err: "Remote provided CLTV expiry in seconds instead of block height", msg: None}); + return Err(HandleError{err: "Remote provided CLTV expiry in seconds instead of block height", action: None}); } //TODO: Check msg.cltv_expiry further? Do this in channel manager? @@ -1318,28 +1318,28 @@ impl Channel { None => {}, Some(payment_hash) => if payment_hash != htlc.payment_hash { - return Err(HandleError{err: "Remote tried to fulfill HTLC with an incorrect preimage", msg: None}); + return Err(HandleError{err: "Remote tried to fulfill HTLC with an incorrect preimage", action: None}); } }; if htlc.state == HTLCState::LocalAnnounced { - return Err(HandleError{err: "Remote tried to fulfill HTLC before it had been committed", msg: None}); + return Err(HandleError{err: "Remote tried to fulfill HTLC before it had been committed", action: None}); } else if htlc.state == HTLCState::Committed { htlc.state = HTLCState::RemoteRemoved; htlc.fail_reason = fail_reason; } else if htlc.state == HTLCState::AwaitingRemoteRevokeToRemove || htlc.state == HTLCState::AwaitingRemovedRemoteRevoke || htlc.state == HTLCState::RemoteRemoved { - return Err(HandleError{err: "Remote tried to fulfill HTLC that they'd already fulfilled", msg: None}); + return Err(HandleError{err: "Remote tried to fulfill HTLC that they'd already fulfilled", action: None}); } else { panic!("Got a non-outbound state on an outbound HTLC"); } return Ok(htlc.payment_hash.clone()); } } - Err(HandleError{err: "Remote tried to fulfill/fail an HTLC we couldn't find", msg: None}) + Err(HandleError{err: "Remote tried to fulfill/fail an HTLC we couldn't find", action: None}) } pub fn update_fulfill_htlc(&mut self, msg: &msgs::UpdateFulfillHTLC) -> Result { if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) { - return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", msg: None}); + return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None}); } let mut sha = Sha256::new(); @@ -1354,7 +1354,7 @@ impl Channel { pub fn update_fail_htlc(&mut self, msg: &msgs::UpdateFailHTLC, fail_reason: HTLCFailReason) -> Result<[u8; 32], HandleError> { if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) { - return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", msg: None}); + return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None}); } self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason)) @@ -1362,7 +1362,7 @@ impl Channel { pub fn update_fail_malformed_htlc(&mut self, msg: &msgs::UpdateFailMalformedHTLC, fail_reason: HTLCFailReason) -> Result<(), HandleError> { if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) { - return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", msg: None}); + return Err(HandleError{err: "Got add HTLC message when channel was not in an operational state", action: None}); } self.mark_outbound_htlc_removed(msg.htlc_id, None, Some(fail_reason))?; @@ -1371,7 +1371,7 @@ impl Channel { pub fn commitment_signed(&mut self, msg: &msgs::CommitmentSigned) -> Result<(msgs::RevokeAndACK, Option, ChannelMonitor), HandleError> { if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) { - return Err(HandleError{err: "Got commitment signed message when channel was not in an operational state", msg: None}); + return Err(HandleError{err: "Got commitment signed message when channel was not in an operational state", action: None}); } let funding_script = self.get_funding_redeemscript(); @@ -1383,7 +1383,7 @@ impl Channel { secp_call!(self.secp_ctx.verify(&local_sighash, &msg.signature, &self.their_funding_pubkey), "Invalid commitment tx signature from peer"); if msg.htlc_signatures.len() != local_commitment_tx.1.len() { - return Err(HandleError{err: "Got wrong number of HTLC signatures from remote", msg: None}); + return Err(HandleError{err: "Got wrong number of HTLC signatures from remote", action: None}); } let mut new_local_commitment_txn = Vec::with_capacity(local_commitment_tx.1.len() + 1); @@ -1527,11 +1527,11 @@ impl Channel { /// revoke_and_ack message. pub fn revoke_and_ack(&mut self, msg: &msgs::RevokeAndACK) -> Result<(Option, Vec, Vec<([u8; 32], HTLCFailReason)>, ChannelMonitor), HandleError> { if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) { - return Err(HandleError{err: "Got revoke/ACK message when channel was not in an operational state", msg: None}); + return Err(HandleError{err: "Got revoke/ACK message when channel was not in an operational state", action: None}); } if let Some(their_prev_commitment_point) = self.their_prev_commitment_point { if PublicKey::from_secret_key(&self.secp_ctx, &secp_call!(SecretKey::from_slice(&self.secp_ctx, &msg.per_commitment_secret), "Peer provided an invalid per_commitment_secret")).unwrap() != their_prev_commitment_point { - return Err(HandleError{err: "Got a revoke commitment secret which didn't correspond to their current pubkey", msg: None}); + return Err(HandleError{err: "Got a revoke commitment secret which didn't correspond to their current pubkey", action: None}); } } self.channel_monitor.provide_secret(self.cur_remote_commitment_transaction_number + 1, msg.per_commitment_secret, Some((self.cur_remote_commitment_transaction_number - 1, msg.next_per_commitment_point)))?; @@ -1604,7 +1604,7 @@ impl Channel { pub fn update_fee(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::UpdateFee) -> Result<(), HandleError> { if self.channel_outbound { - return Err(HandleError{err: "Non-funding remote tried to update channel fee", msg: None}); + return Err(HandleError{err: "Non-funding remote tried to update channel fee", action: None}); } Channel::check_remote_fee(fee_estimator, msg.feerate_per_kw)?; self.channel_update_count += 1; @@ -1620,24 +1620,24 @@ impl Channel { } for htlc in self.pending_htlcs.iter() { if htlc.state == HTLCState::RemoteAnnounced { - return Err(HandleError{err: "Got shutdown with remote pending HTLCs", msg: None}); + return Err(HandleError{err: "Got shutdown with remote pending HTLCs", action: None}); } } if (self.channel_state & ChannelState::RemoteShutdownSent as u32) == ChannelState::RemoteShutdownSent as u32 { - return Err(HandleError{err: "Remote peer sent duplicate shutdown message", msg: None}); + return Err(HandleError{err: "Remote peer sent duplicate shutdown message", action: None}); } assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0); // BOLT 2 says we must only send a scriptpubkey of certain standard forms, which are up to // 34 bytes in length, so dont let the remote peer feed us some super fee-heavy script. if self.channel_outbound && msg.scriptpubkey.len() > 34 { - return Err(HandleError{err: "Got shutdown_scriptpubkey of absurd length from remote peer", msg: None}); + return Err(HandleError{err: "Got shutdown_scriptpubkey of absurd length from remote peer", action: None}); } //TODO: Check shutdown_scriptpubkey form as BOLT says we must? WHYYY if self.their_shutdown_scriptpubkey.is_some() { if Some(&msg.scriptpubkey) != self.their_shutdown_scriptpubkey.as_ref() { - return Err(HandleError{err: "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey", msg: None}); + return Err(HandleError{err: "Got shutdown request with a scriptpubkey which did not match their previous scriptpubkey", action: None}); } } else { self.their_shutdown_scriptpubkey = Some(msg.scriptpubkey.clone()); @@ -1711,19 +1711,19 @@ impl Channel { pub fn closing_signed(&mut self, fee_estimator: &FeeEstimator, msg: &msgs::ClosingSigned) -> Result<(Option, Option), HandleError> { if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != BOTH_SIDES_SHUTDOWN_MASK { - return Err(HandleError{err: "Remote end sent us a closing_signed before both sides provided a shutdown", msg: None}); + return Err(HandleError{err: "Remote end sent us a closing_signed before both sides provided a shutdown", action: None}); } if !self.pending_htlcs.is_empty() { - return Err(HandleError{err: "Remote end sent us a closing_signed while there were still pending HTLCs", msg: None}); + return Err(HandleError{err: "Remote end sent us a closing_signed while there were still pending HTLCs", action: None}); } if msg.fee_satoshis > 21000000 * 10000000 { - return Err(HandleError{err: "Remote tried to send us a closing tx with > 21 million BTC fee", msg: None}); + return Err(HandleError{err: "Remote tried to send us a closing tx with > 21 million BTC fee", action: None}); } let funding_redeemscript = self.get_funding_redeemscript(); let (mut closing_tx, used_total_fee) = self.build_closing_transaction(msg.fee_satoshis, false); if used_total_fee != msg.fee_satoshis { - return Err(HandleError{err: "Remote sent us a closing_signed with a fee greater than the value they can claim", msg: None}); + return Err(HandleError{err: "Remote sent us a closing_signed with a fee greater than the value they can claim", action: None}); } let mut sighash = Message::from_slice(&bip143::SighashComponents::new(&closing_tx).sighash_all(&closing_tx.input[0], &funding_redeemscript, self.channel_value_satoshis)[..]).unwrap(); @@ -1768,7 +1768,7 @@ impl Channel { if proposed_sat_per_vbyte > our_max_feerate { if let Some((last_feerate, _)) = self.last_sent_closing_fee { if our_max_feerate <= last_feerate { - return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate", msg: None}); + return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something higher than our Normal feerate", action: None}); } } propose_new_feerate!(our_max_feerate); @@ -1778,7 +1778,7 @@ impl Channel { if proposed_sat_per_vbyte < our_min_feerate { if let Some((last_feerate, _)) = self.last_sent_closing_fee { if our_min_feerate >= last_feerate { - return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate", msg: None}); + return Err(HandleError{err: "Unable to come to consensus about closing feerate, remote wanted something lower than our Background feerate", action: None}); } } propose_new_feerate!(our_min_feerate); @@ -1962,7 +1962,7 @@ impl Channel { panic!("Tried to open a channel for an inbound channel?"); } if self.channel_state != ChannelState::OurInitSent as u32 { - return Err(HandleError{err: "Cannot generate an open_channel after we've moved forward", msg: None}); + return Err(HandleError{err: "Cannot generate an open_channel after we've moved forward", action: None}); } if self.cur_local_commitment_transaction_number != (1 << 48) - 1 { @@ -2090,10 +2090,10 @@ impl Channel { /// message can mark the channel disabled. pub fn get_channel_announcement(&self, our_node_id: PublicKey, chain_hash: Sha256dHash) -> Result<(msgs::UnsignedChannelAnnouncement, Signature), HandleError> { if !self.announce_publicly { - return Err(HandleError{err: "Channel is not available for public announcements", msg: None}); + return Err(HandleError{err: "Channel is not available for public announcements", action: None}); } if self.channel_state & (ChannelState::ChannelFunded as u32) != (ChannelState::ChannelFunded as u32) { - return Err(HandleError{err: "Cannot get a ChannelAnnouncement until the channel funding has been locked", msg: None}); + return Err(HandleError{err: "Cannot get a ChannelAnnouncement until the channel funding has been locked", action: None}); } let were_node_one = our_node_id.serialize()[..] < self.their_node_id.serialize()[..]; @@ -2125,28 +2125,28 @@ impl Channel { /// HTLCs on the wire or we wouldn't be able to determine what they actually ACK'ed. pub fn send_htlc(&mut self, amount_msat: u64, payment_hash: [u8; 32], cltv_expiry: u32, onion_routing_packet: msgs::OnionPacket) -> Result, HandleError> { if (self.channel_state & (ChannelState::ChannelFunded as u32 | BOTH_SIDES_SHUTDOWN_MASK)) != (ChannelState::ChannelFunded as u32) { - return Err(HandleError{err: "Cannot send HTLC until channel is fully established and we haven't started shutting down", msg: None}); + return Err(HandleError{err: "Cannot send HTLC until channel is fully established and we haven't started shutting down", action: None}); } if amount_msat > self.channel_value_satoshis * 1000 { - return Err(HandleError{err: "Cannot send more than the total value of the channel", msg: None}); + return Err(HandleError{err: "Cannot send more than the total value of the channel", action: None}); } if amount_msat < self.their_htlc_minimum_msat { - return Err(HandleError{err: "Cannot send less than their minimum HTLC value", msg: None}); + return Err(HandleError{err: "Cannot send less than their minimum HTLC value", action: None}); } let (_, outbound_htlc_count, htlc_outbound_value_msat, htlc_inbound_value_msat) = self.get_pending_htlc_stats(false); if outbound_htlc_count + 1 > self.their_max_accepted_htlcs as u32 { - return Err(HandleError{err: "Cannot push more than their max accepted HTLCs", msg: None}); + return Err(HandleError{err: "Cannot push more than their max accepted HTLCs", action: None}); } //TODO: Spec is unclear if this is per-direction or in total (I assume per direction): // Check their_max_htlc_value_in_flight_msat if htlc_outbound_value_msat + amount_msat > self.their_max_htlc_value_in_flight_msat { - return Err(HandleError{err: "Cannot send value that would put us over our max HTLC value in flight", msg: None}); + return Err(HandleError{err: "Cannot send value that would put us over our max HTLC value in flight", action: None}); } // Check their_channel_reserve_satoshis: if htlc_inbound_value_msat + htlc_outbound_value_msat + amount_msat + (self.channel_value_satoshis * 1000 - self.value_to_self_msat) > (self.channel_value_satoshis - self.their_channel_reserve_satoshis) * 1000 { - return Err(HandleError{err: "Cannot send value that would put us over our reserve value", msg: None}); + return Err(HandleError{err: "Cannot send value that would put us over our reserve value", action: None}); } //TODO: Check cltv_expiry? Do this in channel manager? @@ -2192,10 +2192,10 @@ impl Channel { /// Creates a signed commitment transaction to send to the remote peer. pub fn send_commitment(&mut self) -> Result<(msgs::CommitmentSigned, ChannelMonitor), HandleError> { if (self.channel_state & (ChannelState::ChannelFunded as u32)) != (ChannelState::ChannelFunded as u32) { - return Err(HandleError{err: "Cannot create commitment tx until channel is fully established", msg: None}); + return Err(HandleError{err: "Cannot create commitment tx until channel is fully established", action: None}); } if (self.channel_state & (ChannelState::AwaitingRemoteRevoke as u32)) == (ChannelState::AwaitingRemoteRevoke as u32) { - return Err(HandleError{err: "Cannot create commitment tx until remote revokes their previous commitment", msg: None}); + return Err(HandleError{err: "Cannot create commitment tx until remote revokes their previous commitment", action: None}); } let mut have_updates = false; // TODO initialize with "have we sent a fee update?" for htlc in self.pending_htlcs.iter() { @@ -2205,7 +2205,7 @@ impl Channel { if have_updates { break; } } if !have_updates { - return Err(HandleError{err: "Cannot create commitment tx until we have some updates to send", msg: None}); + return Err(HandleError{err: "Cannot create commitment tx until we have some updates to send", action: None}); } self.send_commitment_no_status_check() } @@ -2270,11 +2270,11 @@ impl Channel { pub fn get_shutdown(&mut self) -> Result<(msgs::Shutdown, Vec<[u8; 32]>), HandleError> { for htlc in self.pending_htlcs.iter() { if htlc.state == HTLCState::LocalAnnounced { - return Err(HandleError{err: "Cannot begin shutdown with pending HTLCs, call send_commitment first", msg: None}); + return Err(HandleError{err: "Cannot begin shutdown with pending HTLCs, call send_commitment first", action: None}); } } if self.channel_state & BOTH_SIDES_SHUTDOWN_MASK != 0 { - return Err(HandleError{err: "Shutdown already in progress", msg: None}); + return Err(HandleError{err: "Shutdown already in progress", action: None}); } assert_eq!(self.channel_state & ChannelState::ShutdownComplete as u32, 0); diff --git a/src/ln/channelmanager.rs b/src/ln/channelmanager.rs index f5af09a71..83ff021a7 100644 --- a/src/ln/channelmanager.rs +++ b/src/ln/channelmanager.rs @@ -167,7 +167,7 @@ macro_rules! secp_call { match $res { Ok(key) => key, //TODO: Make the err a parameter! - Err(_) => return Err(HandleError{err: "Key error", msg: None}) + Err(_) => return Err(HandleError{err: "Key error", action: None}) } }; } @@ -311,7 +311,7 @@ impl ChannelManager { (res, Some(chan_entry.remove_entry().1)) } else { (res, None) } }, - hash_map::Entry::Vacant(_) => return Err(HandleError{err: "No such channel", msg: None}) + hash_map::Entry::Vacant(_) => return Err(HandleError{err: "No such channel", action: None}) } }; for payment_hash in res.1 { @@ -443,11 +443,11 @@ impl ChannelManager { }; cur_value_msat += hop.fee_msat; if cur_value_msat >= 21000000 * 100000000 * 1000 { - return Err(HandleError{err: "Channel fees overflowed?!", msg: None}); + return Err(HandleError{err: "Channel fees overflowed?!", action: None}); } cur_cltv += hop.cltv_expiry_delta as u32; if cur_cltv >= 500000000 { - return Err(HandleError{err: "Channel CLTV overflowed?!", msg: None}); + return Err(HandleError{err: "Channel CLTV overflowed?!", action: None}); } last_short_channel_id = hop.short_channel_id; } @@ -576,7 +576,7 @@ impl ChannelManager { /// only fails if the channel does not yet have an assigned short_id fn get_channel_update(&self, chan: &Channel) -> Result { let short_channel_id = match chan.get_short_channel_id() { - None => return Err(HandleError{err: "Channel not yet established", msg: None}), + None => return Err(HandleError{err: "Channel not yet established", action: None}), Some(id) => id, }; @@ -609,12 +609,12 @@ impl ChannelManager { /// May generate a SendHTLCs event on success, which should be relayed. pub fn send_payment(&self, route: Route, payment_hash: [u8; 32]) -> Result<(), HandleError> { if route.hops.len() < 1 || route.hops.len() > 20 { - return Err(HandleError{err: "Route didn't go anywhere/had bogus size", msg: None}); + return Err(HandleError{err: "Route didn't go anywhere/had bogus size", action: None}); } let our_node_id = self.get_our_node_id(); for (idx, hop) in route.hops.iter().enumerate() { if idx != route.hops.len() - 1 && hop.pubkey == our_node_id { - return Err(HandleError{err: "Route went through us but wasn't a simple rebalance loop to us", msg: None}); + return Err(HandleError{err: "Route went through us but wasn't a simple rebalance loop to us", action: None}); } } @@ -633,13 +633,13 @@ impl ChannelManager { let (first_hop_node_id, (update_add, commitment_signed, chan_monitor)) = { let mut channel_state = self.channel_state.lock().unwrap(); let id = match channel_state.short_to_id.get(&route.hops.first().unwrap().short_channel_id) { - None => return Err(HandleError{err: "No channel available with first hop!", msg: None}), + None => return Err(HandleError{err: "No channel available with first hop!", action: None}), Some(id) => id.clone() }; let res = { let chan = channel_state.by_id.get_mut(&id).unwrap(); if chan.get_their_node_id() != route.hops.first().unwrap().pubkey { - return Err(HandleError{err: "Node ID mismatch on first hop!", msg: None}); + return Err(HandleError{err: "Node ID mismatch on first hop!", action: None}); } chan.send_htlc_and_commit(htlc_msat, payment_hash.clone(), htlc_cltv, onion_packet)? }; @@ -1099,11 +1099,11 @@ impl ChannelMessageHandler for ChannelManager { //TODO: Handle errors and close channel (or so) fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &msgs::OpenChannel) -> Result { if msg.chain_hash != self.genesis_hash { - return Err(HandleError{err: "Unknown genesis block hash", msg: None}); + return Err(HandleError{err: "Unknown genesis block hash", action: None}); } let mut channel_state = self.channel_state.lock().unwrap(); if channel_state.by_id.contains_key(&msg.temporary_channel_id) { - return Err(HandleError{err: "temporary_channel_id collision!", msg: None}); + return Err(HandleError{err: "temporary_channel_id collision!", action: None}); } let chan_keys = if cfg!(feature = "fuzztarget") { @@ -1138,12 +1138,12 @@ impl ChannelMessageHandler for ChannelManager { match channel_state.by_id.get_mut(&msg.temporary_channel_id) { Some(chan) => { if chan.get_their_node_id() != *their_node_id { - return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None}) + return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None}) } chan.accept_channel(&msg)?; (chan.get_value_satoshis(), chan.get_funding_redeemscript().to_v0_p2wsh(), chan.get_user_id()) }, - None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None}) + None => return Err(HandleError{err: "Failed to find corresponding channel", action: None}) } }; let mut pending_events = self.pending_events.lock().unwrap(); @@ -1165,7 +1165,7 @@ impl ChannelMessageHandler for ChannelManager { match channel_state.by_id.remove(&msg.temporary_channel_id) { Some(mut chan) => { if chan.get_their_node_id() != *their_node_id { - return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None}) + return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None}) } match chan.funding_created(msg) { Ok((funding_msg, monitor_update)) => { @@ -1176,7 +1176,7 @@ impl ChannelMessageHandler for ChannelManager { } } }, - None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None}) + None => return Err(HandleError{err: "Failed to find corresponding channel", action: None}) } }; // Release channel lock for install_watch_outpoint call, // note that this means if the remote end is misbehaving and sends a message for the same @@ -1196,12 +1196,12 @@ impl ChannelMessageHandler for ChannelManager { match channel_state.by_id.get_mut(&msg.channel_id) { Some(chan) => { if chan.get_their_node_id() != *their_node_id { - return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None}) + return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None}) } let chan_monitor = chan.funding_signed(&msg)?; (chan.get_funding_txo().unwrap(), chan.get_user_id(), chan_monitor) }, - None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None}) + None => return Err(HandleError{err: "Failed to find corresponding channel", action: None}) } }; if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) { @@ -1220,12 +1220,12 @@ impl ChannelMessageHandler for ChannelManager { match channel_state.by_id.get_mut(&msg.channel_id) { Some(chan) => { if chan.get_their_node_id() != *their_node_id { - return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None}) + return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None}) } chan.funding_locked(&msg)?; return Ok(self.get_announcement_sigs(chan)?); }, - None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None}) + None => return Err(HandleError{err: "Failed to find corresponding channel", action: None}) }; } @@ -1237,7 +1237,7 @@ impl ChannelMessageHandler for ChannelManager { match channel_state.by_id.entry(msg.channel_id.clone()) { hash_map::Entry::Occupied(mut chan_entry) => { if chan_entry.get().get_their_node_id() != *their_node_id { - return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None}) + return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None}) } let res = chan_entry.get_mut().shutdown(&*self.fee_estimator, &msg)?; if chan_entry.get().is_shutdown() { @@ -1247,7 +1247,7 @@ impl ChannelMessageHandler for ChannelManager { (res, Some(chan_entry.remove_entry().1)) } else { (res, None) } }, - hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", msg: None}) + hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", action: None}) } }; for payment_hash in res.2 { @@ -1272,7 +1272,7 @@ impl ChannelMessageHandler for ChannelManager { match channel_state.by_id.entry(msg.channel_id.clone()) { hash_map::Entry::Occupied(mut chan_entry) => { if chan_entry.get().get_their_node_id() != *their_node_id { - return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None}) + return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None}) } let res = chan_entry.get_mut().closing_signed(&*self.fee_estimator, &msg)?; if res.1.is_some() { @@ -1287,7 +1287,7 @@ impl ChannelMessageHandler for ChannelManager { (res, Some(chan_entry.remove_entry().1)) } else { (res, None) } }, - hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", msg: None}) + hash_map::Entry::Vacant(_) => return Err(HandleError{err: "Failed to find corresponding channel", action: None}) } }; if let Some(broadcast_tx) = res.1 { @@ -1335,7 +1335,7 @@ impl ChannelMessageHandler for ChannelManager { ($msg: expr, $err_code: expr, $data: expr) => { return Err(msgs::HandleError { err: $msg, - msg: Some(msgs::ErrorAction::UpdateFailHTLC { + action: Some(msgs::ErrorAction::UpdateFailHTLC { msg: msgs::UpdateFailHTLC { channel_id: msg.channel_id, htlc_id: msg.htlc_id, @@ -1494,16 +1494,16 @@ impl ChannelMessageHandler for ChannelManager { let (source_short_channel_id, res) = match channel_state.by_id.get_mut(&msg.channel_id) { Some(chan) => { if chan.get_their_node_id() != *their_node_id { - return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None}) + return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None}) } if !chan.is_usable() { - return Err(HandleError{err: "Channel not yet available for receiving HTLCs", msg: None}); + return Err(HandleError{err: "Channel not yet available for receiving HTLCs", action: None}); } let short_channel_id = chan.get_short_channel_id().unwrap(); pending_forward_info.prev_short_channel_id = short_channel_id; (short_channel_id, chan.update_add_htlc(&msg, pending_forward_info)?) }, - None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None}), //TODO: panic? + None => return Err(HandleError{err: "Failed to find corresponding channel", action: None}), //TODO: panic? }; match claimable_htlcs_entry { @@ -1544,11 +1544,11 @@ impl ChannelMessageHandler for ChannelManager { match channel_state.by_id.get_mut(&msg.channel_id) { Some(chan) => { if chan.get_their_node_id() != *their_node_id { - return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None}) + return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None}) } chan.update_fulfill_htlc(&msg)? }, - None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None}) + None => return Err(HandleError{err: "Failed to find corresponding channel", action: None}) } }; if let Err(_e) = self.monitor.add_update_monitor(monitor.get_funding_txo().unwrap(), monitor) { @@ -1562,11 +1562,11 @@ impl ChannelMessageHandler for ChannelManager { let payment_hash = match channel_state.by_id.get_mut(&msg.channel_id) { Some(chan) => { if chan.get_their_node_id() != *their_node_id { - return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None}) + return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None}) } chan.update_fail_htlc(&msg, HTLCFailReason::ErrorPacket { err: msg.reason.clone() }) }, - None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None}) + None => return Err(HandleError{err: "Failed to find corresponding channel", action: None}) }?; if let Some(pending_htlc) = channel_state.claimable_htlcs.get(&payment_hash) { @@ -1637,11 +1637,11 @@ impl ChannelMessageHandler for ChannelManager { match channel_state.by_id.get_mut(&msg.channel_id) { Some(chan) => { if chan.get_their_node_id() != *their_node_id { - return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None}) + return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None}) } chan.update_fail_malformed_htlc(&msg, HTLCFailReason::Reason { failure_code: msg.failure_code, data: Vec::new() }) }, - None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None}) + None => return Err(HandleError{err: "Failed to find corresponding channel", action: None}) } } @@ -1651,11 +1651,11 @@ impl ChannelMessageHandler for ChannelManager { match channel_state.by_id.get_mut(&msg.channel_id) { Some(chan) => { if chan.get_their_node_id() != *their_node_id { - return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None}) + return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None}) } chan.commitment_signed(&msg)? }, - None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None}) + None => return Err(HandleError{err: "Failed to find corresponding channel", action: None}) } }; if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) { @@ -1671,11 +1671,11 @@ impl ChannelMessageHandler for ChannelManager { match channel_state.by_id.get_mut(&msg.channel_id) { Some(chan) => { if chan.get_their_node_id() != *their_node_id { - return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None}) + return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None}) } chan.revoke_and_ack(&msg)? }, - None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None}) + None => return Err(HandleError{err: "Failed to find corresponding channel", action: None}) } }; if let Err(_e) = self.monitor.add_update_monitor(chan_monitor.get_funding_txo().unwrap(), chan_monitor) { @@ -1721,11 +1721,11 @@ impl ChannelMessageHandler for ChannelManager { match channel_state.by_id.get_mut(&msg.channel_id) { Some(chan) => { if chan.get_their_node_id() != *their_node_id { - return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None}) + return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None}) } chan.update_fee(&*self.fee_estimator, &msg) }, - None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None}) + None => return Err(HandleError{err: "Failed to find corresponding channel", action: None}) } } @@ -1735,10 +1735,10 @@ impl ChannelMessageHandler for ChannelManager { match channel_state.by_id.get_mut(&msg.channel_id) { Some(chan) => { if chan.get_their_node_id() != *their_node_id { - return Err(HandleError{err: "Got a message for a channel from the wrong node!", msg: None}) + return Err(HandleError{err: "Got a message for a channel from the wrong node!", action: None}) } if !chan.is_usable() { - return Err(HandleError{err: "Got an announcement_signatures before we were ready for it", msg: None }); + return Err(HandleError{err: "Got an announcement_signatures before we were ready for it", action: None }); } let our_node_id = self.get_our_node_id(); @@ -1759,7 +1759,7 @@ impl ChannelMessageHandler for ChannelManager { contents: announcement, }, self.get_channel_update(chan).unwrap()) // can only fail if we're not in a ready state }, - None => return Err(HandleError{err: "Failed to find corresponding channel", msg: None}) + None => return Err(HandleError{err: "Failed to find corresponding channel", action: None}) } }; let mut pending_events = self.pending_events.lock().unwrap(); diff --git a/src/ln/channelmonitor.rs b/src/ln/channelmonitor.rs index 1e8f8038c..51f7d3cfe 100644 --- a/src/ln/channelmonitor.rs +++ b/src/ln/channelmonitor.rs @@ -316,7 +316,7 @@ impl ChannelMonitor { for i in 0..pos { let (old_secret, old_idx) = self.old_secrets[i as usize]; if ChannelMonitor::derive_secret(secret, pos, old_idx) != old_secret { - return Err(HandleError{err: "Previous secret did not match new one", msg: None}) + return Err(HandleError{err: "Previous secret did not match new one", action: None}) } } self.old_secrets[pos as usize] = (secret, idx); @@ -421,7 +421,7 @@ impl ChannelMonitor { pub fn insert_combine(&mut self, mut other: ChannelMonitor) -> Result<(), HandleError> { if self.funding_txo.is_some() { if other.funding_txo.is_some() && other.funding_txo.as_ref().unwrap() != self.funding_txo.as_ref().unwrap() { - return Err(HandleError{err: "Funding transaction outputs are not identical!", msg: None}); + return Err(HandleError{err: "Funding transaction outputs are not identical!", action: None}); } } else { self.funding_txo = other.funding_txo.take(); @@ -882,7 +882,7 @@ impl ChannelMonitor { } } assert!(idx < self.get_min_seen_secret()); - Err(HandleError{err: "idx too low", msg: None}) + Err(HandleError{err: "idx too low", action: None}) } pub fn get_min_seen_secret(&self) -> u64 { diff --git a/src/ln/msgs.rs b/src/ln/msgs.rs index bc7c0ed98..898d30d94 100644 --- a/src/ln/msgs.rs +++ b/src/ln/msgs.rs @@ -380,7 +380,7 @@ pub enum ErrorAction { pub struct HandleError { //TODO: rename me pub err: &'static str, - pub msg: Option, //TODO: Make this required and rename it + pub action: Option, //TODO: Make this required and rename it } /// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment diff --git a/src/ln/peer_channel_encryptor.rs b/src/ln/peer_channel_encryptor.rs index 3ec6241fb..7db33c92e 100644 --- a/src/ln/peer_channel_encryptor.rs +++ b/src/ln/peer_channel_encryptor.rs @@ -147,7 +147,7 @@ impl PeerChannelEncryptor { let mut chacha = ChaCha20Poly1305RFC::new(key, &nonce, h); if !chacha.decrypt(&cyphertext[0..cyphertext.len() - 16], res, &cyphertext[cyphertext.len() - 16..]) { - return Err(HandleError{err: "Bad MAC", msg: Some(msgs::ErrorAction::DisconnectPeer{})}); + return Err(HandleError{err: "Bad MAC", action: Some(msgs::ErrorAction::DisconnectPeer{})}); } Ok(()) } @@ -195,11 +195,11 @@ impl PeerChannelEncryptor { assert_eq!(act.len(), 50); if act[0] != 0 { - return Err(HandleError{err: "Unknown handshake version number", msg: Some(msgs::ErrorAction::DisconnectPeer{})}); + return Err(HandleError{err: "Unknown handshake version number", action: Some(msgs::ErrorAction::DisconnectPeer{})}); } let their_pub = match PublicKey::from_slice(secp_ctx, &act[1..34]) { - Err(_) => return Err(HandleError{err: "Invalid public key", msg: Some(msgs::ErrorAction::DisconnectPeer{})}), + Err(_) => return Err(HandleError{err: "Invalid public key", action: Some(msgs::ErrorAction::DisconnectPeer{})}), Ok(key) => key, }; @@ -349,14 +349,14 @@ impl PeerChannelEncryptor { panic!("Requested act at wrong step"); } if act_three[0] != 0 { - return Err(HandleError{err: "Unknown handshake version number", msg: Some(msgs::ErrorAction::DisconnectPeer{})}); + return Err(HandleError{err: "Unknown handshake version number", action: Some(msgs::ErrorAction::DisconnectPeer{})}); } let mut their_node_id = [0; 33]; PeerChannelEncryptor::decrypt_with_ad(&mut their_node_id, 1, &temp_k2.unwrap(), &bidirectional_state.h, &act_three[1..50])?; self.their_node_id = Some(match PublicKey::from_slice(&self.secp_ctx, &their_node_id) { Ok(key) => key, - Err(_) => return Err(HandleError{err: "Bad node_id from peer", msg: Some(msgs::ErrorAction::DisconnectPeer{})}), + Err(_) => return Err(HandleError{err: "Bad node_id from peer", action: Some(msgs::ErrorAction::DisconnectPeer{})}), }); let mut sha = Sha256::new(); diff --git a/src/ln/peer_handler.rs b/src/ln/peer_handler.rs index 2472518d6..faa0a06ad 100644 --- a/src/ln/peer_handler.rs +++ b/src/ln/peer_handler.rs @@ -281,7 +281,7 @@ impl PeerManager { Ok(x) => x, Err(e) => { println!("Got error handling message: {}!", e.err); - if let Some(action) = e.msg { + if let Some(action) = e.action { match action { msgs::ErrorAction::UpdateFailHTLC { msg } => { encode_and_send_msg!(msg, 131); diff --git a/src/ln/router.rs b/src/ln/router.rs index e4473fa41..1b576502f 100644 --- a/src/ln/router.rs +++ b/src/ln/router.rs @@ -110,7 +110,7 @@ macro_rules! secp_verify_sig { ( $secp_ctx: expr, $msg: expr, $sig: expr, $pubkey: expr ) => { match $secp_ctx.verify($msg, $sig, $pubkey) { Ok(_) => {}, - Err(_) => return Err(HandleError{err: "Invalid signature from remote node", msg: None}), + Err(_) => return Err(HandleError{err: "Invalid signature from remote node", action: None}), } }; } @@ -122,10 +122,10 @@ impl RoutingMessageHandler for Router { let mut network = self.network_map.write().unwrap(); match network.nodes.get_mut(&msg.contents.node_id) { - None => Err(HandleError{err: "No existing channels for node_announcement", msg: Some(ErrorAction::IgnoreError)}), + None => Err(HandleError{err: "No existing channels for node_announcement", action: Some(ErrorAction::IgnoreError)}), Some(node) => { if node.last_update >= msg.contents.timestamp { - return Err(HandleError{err: "Update older than last processed update", msg: Some(ErrorAction::IgnoreError)}); + return Err(HandleError{err: "Update older than last processed update", action: Some(ErrorAction::IgnoreError)}); } node.features = msg.contents.features.clone(); @@ -149,7 +149,7 @@ impl RoutingMessageHandler for Router { //TODO: Only allow bitcoin chain_hash if msg.contents.features.requires_unknown_bits() { - return Err(HandleError{err: "Channel announcement required unknown feature flags", msg: None}); + return Err(HandleError{err: "Channel announcement required unknown feature flags", action: None}); } let mut network = self.network_map.write().unwrap(); @@ -159,7 +159,7 @@ impl RoutingMessageHandler for Router { //TODO: because asking the blockchain if short_channel_id is valid is only optional //in the blockchain API, we need to handle it smartly here, though its unclear //exactly how... - return Err(HandleError{err: "Already have knowledge of channel", msg: Some(ErrorAction::IgnoreError)}) + return Err(HandleError{err: "Already have knowledge of channel", action: Some(ErrorAction::IgnoreError)}) }, Entry::Vacant(entry) => { entry.insert(ChannelInfo { @@ -233,12 +233,12 @@ impl RoutingMessageHandler for Router { let chan_was_enabled; match network.channels.get_mut(&NetworkMap::get_key(msg.contents.short_channel_id, msg.contents.chain_hash)) { - None => return Err(HandleError{err: "Couldn't find channel for update", msg: Some(ErrorAction::IgnoreError)}), + None => return Err(HandleError{err: "Couldn't find channel for update", action: Some(ErrorAction::IgnoreError)}), Some(channel) => { macro_rules! maybe_update_channel_info { ( $target: expr) => { if $target.last_update >= msg.contents.timestamp { - return Err(HandleError{err: "Update older than last processed update", msg: Some(ErrorAction::IgnoreError)}); + return Err(HandleError{err: "Update older than last processed update", action: Some(ErrorAction::IgnoreError)}); } chan_was_enabled = $target.enabled; $target.last_update = msg.contents.timestamp; @@ -360,7 +360,7 @@ impl Router { let network = self.network_map.read().unwrap(); if *target == network.our_node_id { - return Err(HandleError{err: "Cannot generate a route to ourselves", msg: None}); + return Err(HandleError{err: "Cannot generate a route to ourselves", action: None}); } // We do a dest-to-source Dijkstra's sorting by each node's distance from the destination @@ -474,7 +474,7 @@ impl Router { } } - Err(HandleError{err: "Failed to find a path to the given destination", msg: None}) + Err(HandleError{err: "Failed to find a path to the given destination", action: None}) } }