Provide Send + Sync on message handlers (just changes trait)
[rust-lightning] / src / ln / msgs.rs
index e85f25ac78a23248690d520a586af5cb1cca9fb5..0a86b031eb1755401337fcf21ee051075536414e 100644 (file)
@@ -15,6 +15,14 @@ pub trait MsgEncodable {
        fn encode(&self) -> Vec<u8>;
        #[inline]
        fn encoded_len(&self) -> usize { self.encode().len() }
+       #[inline]
+       fn encode_with_len(&self) -> Vec<u8> {
+               let enc = self.encode();
+               let mut res = Vec::with_capacity(enc.len() + 2);
+               res.extend_from_slice(&byte_utils::be16_to_array(enc.len() as u16));
+               res.extend_from_slice(&enc);
+               res
+       }
 }
 #[derive(Debug)]
 pub enum DecodeError {
@@ -357,10 +365,28 @@ pub struct HandleError { //TODO: rename me
        pub msg: Option<ErrorAction>, //TODO: Make this required and rename it
 }
 
+/// Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
+/// transaction updates if they were pending.
+pub struct CommitmentUpdate {
+       pub update_add_htlcs: Vec<UpdateAddHTLC>,
+       pub update_fulfill_htlcs: Vec<UpdateFulfillHTLC>,
+       pub update_fail_htlcs: Vec<UpdateFailHTLC>,
+       pub commitment_signed: CommitmentSigned,
+}
+
+pub enum HTLCFailChannelUpdate {
+       ChannelUpdateMessage {
+               msg: ChannelUpdate,
+       },
+       ChannelClosed {
+               short_channel_id: u64,
+       },
+}
+
 /// A trait to describe an object which can receive channel messages. Messages MAY be called in
 /// paralell when they originate from different their_node_ids, however they MUST NOT be called in
 /// paralell when the two calls have the same their_node_id.
-pub trait ChannelMessageHandler : events::EventsProvider {
+pub trait ChannelMessageHandler : events::EventsProvider + Send + Sync {
        //Channel init:
        fn handle_open_channel(&self, their_node_id: &PublicKey, msg: &OpenChannel) -> Result<AcceptChannel, HandleError>;
        fn handle_accept_channel(&self, their_node_id: &PublicKey, msg: &AcceptChannel) -> Result<(), HandleError>;
@@ -375,10 +401,10 @@ pub trait ChannelMessageHandler : events::EventsProvider {
        // HTLC handling:
        fn handle_update_add_htlc(&self, their_node_id: &PublicKey, msg: &UpdateAddHTLC) -> Result<(), HandleError>;
        fn handle_update_fulfill_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFulfillHTLC) -> Result<(), HandleError>;
-       fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC) -> Result<(), HandleError>;
+       fn handle_update_fail_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailHTLC) -> Result<Option<HTLCFailChannelUpdate>, HandleError>;
        fn handle_update_fail_malformed_htlc(&self, their_node_id: &PublicKey, msg: &UpdateFailMalformedHTLC) -> Result<(), HandleError>;
-       fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned) -> Result<RevokeAndACK, HandleError>;
-       fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK) -> Result<Option<(Vec<UpdateAddHTLC>, CommitmentSigned)>, HandleError>;
+       fn handle_commitment_signed(&self, their_node_id: &PublicKey, msg: &CommitmentSigned) -> Result<(RevokeAndACK, Option<CommitmentSigned>), HandleError>;
+       fn handle_revoke_and_ack(&self, their_node_id: &PublicKey, msg: &RevokeAndACK) -> Result<Option<CommitmentUpdate>, HandleError>;
 
        fn handle_update_fee(&self, their_node_id: &PublicKey, msg: &UpdateFee) -> Result<(), HandleError>;
 
@@ -393,12 +419,13 @@ pub trait ChannelMessageHandler : events::EventsProvider {
        fn peer_disconnected(&self, their_node_id: &PublicKey, no_connection_possible: bool);
 }
 
-pub trait RoutingMessageHandler {
+pub trait RoutingMessageHandler : Send + Sync {
        fn handle_node_announcement(&self, msg: &NodeAnnouncement) -> Result<(), HandleError>;
        /// Handle a channel_announcement message, returning true if it should be forwarded on, false
        /// or returning an Err otherwise.
        fn handle_channel_announcement(&self, msg: &ChannelAnnouncement) -> Result<bool, HandleError>;
        fn handle_channel_update(&self, msg: &ChannelUpdate) -> Result<(), HandleError>;
+       fn handle_htlc_fail_channel_update(&self, update: &HTLCFailChannelUpdate);
 }
 
 pub struct OnionRealm0HopData {
@@ -586,7 +613,33 @@ impl MsgDecodable for OpenChannel {
 }
 impl MsgEncodable for OpenChannel {
        fn encode(&self) -> Vec<u8> {
-               unimplemented!();
+               let mut res = match &self.shutdown_scriptpubkey {
+                       &Some(ref script) => Vec::with_capacity(319 + 2 + script.len()),
+                       &None => Vec::with_capacity(319),
+               };
+               res.extend_from_slice(&serialize(&self.chain_hash).unwrap());
+               res.extend_from_slice(&serialize(&self.temporary_channel_id).unwrap());
+               res.extend_from_slice(&byte_utils::be64_to_array(self.funding_satoshis));
+               res.extend_from_slice(&byte_utils::be64_to_array(self.push_msat));
+               res.extend_from_slice(&byte_utils::be64_to_array(self.dust_limit_satoshis));
+               res.extend_from_slice(&byte_utils::be64_to_array(self.max_htlc_value_in_flight_msat));
+               res.extend_from_slice(&byte_utils::be64_to_array(self.channel_reserve_satoshis));
+               res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_minimum_msat));
+               res.extend_from_slice(&byte_utils::be32_to_array(self.feerate_per_kw));
+               res.extend_from_slice(&byte_utils::be16_to_array(self.to_self_delay));
+               res.extend_from_slice(&byte_utils::be16_to_array(self.max_accepted_htlcs));
+               res.extend_from_slice(&self.funding_pubkey.serialize());
+               res.extend_from_slice(&self.revocation_basepoint.serialize());
+               res.extend_from_slice(&self.payment_basepoint.serialize());
+               res.extend_from_slice(&self.delayed_payment_basepoint.serialize());
+               res.extend_from_slice(&self.htlc_basepoint.serialize());
+               res.extend_from_slice(&self.first_per_commitment_point.serialize());
+               res.push(self.channel_flags);
+               if let &Some(ref script) = &self.shutdown_scriptpubkey {
+                       res.extend_from_slice(&byte_utils::be16_to_array(script.len() as u16));
+                       res.extend_from_slice(&script[..]);
+               }
+               res
        }
 }
 
@@ -695,7 +748,10 @@ impl MsgDecodable for FundingSigned {
 }
 impl MsgEncodable for FundingSigned {
        fn encode(&self) -> Vec<u8> {
-               unimplemented!();
+               let mut res = Vec::with_capacity(32+64);
+               res.extend_from_slice(&serialize(&self.channel_id).unwrap());
+               res.extend_from_slice(&self.signature.serialize_compact(&Secp256k1::without_caps()));
+               res
        }
 }
 
@@ -737,7 +793,11 @@ impl MsgDecodable for Shutdown {
 }
 impl MsgEncodable for Shutdown {
        fn encode(&self) -> Vec<u8> {
-               unimplemented!();
+               let mut res = Vec::with_capacity(32 + 2 + self.scriptpubkey.len());
+               res.extend_from_slice(&serialize(&self.channel_id).unwrap());
+               res.extend_from_slice(&byte_utils::be16_to_array(self.scriptpubkey.len() as u16));
+               res.extend_from_slice(&self.scriptpubkey[..]);
+               res
        }
 }
 
@@ -756,7 +816,12 @@ impl MsgDecodable for ClosingSigned {
 }
 impl MsgEncodable for ClosingSigned {
        fn encode(&self) -> Vec<u8> {
-               unimplemented!();
+               let mut res = Vec::with_capacity(32+8+64);
+               res.extend_from_slice(&serialize(&self.channel_id).unwrap());
+               res.extend_from_slice(&byte_utils::be64_to_array(self.fee_satoshis));
+               let secp_ctx = Secp256k1::without_caps();
+               res.extend_from_slice(&self.signature.serialize_compact(&secp_ctx));
+               res
        }
 }
 
@@ -773,13 +838,20 @@ impl MsgDecodable for UpdateAddHTLC {
                        amount_msat: byte_utils::slice_to_be64(&v[40..48]),
                        payment_hash,
                        cltv_expiry: byte_utils::slice_to_be32(&v[80..84]),
-                       onion_routing_packet: OnionPacket::decode(&v[84..])?,
+                       onion_routing_packet: OnionPacket::decode(&v[84..84+1366])?,
                })
        }
 }
 impl MsgEncodable for UpdateAddHTLC {
        fn encode(&self) -> Vec<u8> {
-               unimplemented!();
+               let mut res = Vec::with_capacity(32+8+8+32+4+1+1366);
+               res.extend_from_slice(&serialize(&self.channel_id).unwrap());
+               res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id));
+               res.extend_from_slice(&byte_utils::be64_to_array(self.amount_msat));
+               res.extend_from_slice(&self.payment_hash);
+               res.extend_from_slice(&byte_utils::be32_to_array(self.cltv_expiry));
+               res.extend_from_slice(&self.onion_routing_packet.encode()[..]);
+               res
        }
 }
 
@@ -799,7 +871,11 @@ impl MsgDecodable for UpdateFulfillHTLC {
 }
 impl MsgEncodable for UpdateFulfillHTLC {
        fn encode(&self) -> Vec<u8> {
-               unimplemented!();
+               let mut res = Vec::with_capacity(32+8+32);
+               res.extend_from_slice(&serialize(&self.channel_id).unwrap());
+               res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id));
+               res.extend_from_slice(&self.payment_preimage);
+               res
        }
 }
 
@@ -817,7 +893,12 @@ impl MsgDecodable for UpdateFailHTLC {
 }
 impl MsgEncodable for UpdateFailHTLC {
        fn encode(&self) -> Vec<u8> {
-               unimplemented!();
+               let reason = self.reason.encode();
+               let mut res = Vec::with_capacity(32+8+reason.len());
+               res.extend_from_slice(&serialize(&self.channel_id).unwrap());
+               res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id));
+               res.extend_from_slice(&reason[..]);
+               res
        }
 }
 
@@ -838,7 +919,12 @@ impl MsgDecodable for UpdateFailMalformedHTLC {
 }
 impl MsgEncodable for UpdateFailMalformedHTLC {
        fn encode(&self) -> Vec<u8> {
-               unimplemented!();
+               let mut res = Vec::with_capacity(32+8+32+2);
+               res.extend_from_slice(&serialize(&self.channel_id).unwrap());
+               res.extend_from_slice(&byte_utils::be64_to_array(self.htlc_id));
+               res.extend_from_slice(&self.sha256_of_onion);
+               res.extend_from_slice(&byte_utils::be16_to_array(self.failure_code));
+               res
        }
 }
 
@@ -865,7 +951,15 @@ impl MsgDecodable for CommitmentSigned {
 }
 impl MsgEncodable for CommitmentSigned {
        fn encode(&self) -> Vec<u8> {
-               unimplemented!();
+               let mut res = Vec::with_capacity(32+64+2+self.htlc_signatures.len()*64);
+               res.extend_from_slice(&serialize(&self.channel_id).unwrap());
+               let secp_ctx = Secp256k1::without_caps();
+               res.extend_from_slice(&self.signature.serialize_compact(&secp_ctx));
+               res.extend_from_slice(&byte_utils::be16_to_array(self.htlc_signatures.len() as u16));
+               for i in 0..self.htlc_signatures.len() {
+                       res.extend_from_slice(&self.htlc_signatures[i].serialize_compact(&secp_ctx));
+               }
+               res
        }
 }
 
@@ -886,7 +980,11 @@ impl MsgDecodable for RevokeAndACK {
 }
 impl MsgEncodable for RevokeAndACK {
        fn encode(&self) -> Vec<u8> {
-               unimplemented!();
+               let mut res = Vec::with_capacity(32+32+33);
+               res.extend_from_slice(&serialize(&self.channel_id).unwrap());
+               res.extend_from_slice(&self.per_commitment_secret);
+               res.extend_from_slice(&self.next_per_commitment_point.serialize());
+               res
        }
 }
 
@@ -903,7 +1001,10 @@ impl MsgDecodable for UpdateFee {
 }
 impl MsgEncodable for UpdateFee {
        fn encode(&self) -> Vec<u8> {
-               unimplemented!();
+               let mut res = Vec::with_capacity(32+4);
+               res.extend_from_slice(&serialize(&self.channel_id).unwrap());
+               res.extend_from_slice(&byte_utils::be32_to_array(self.feerate_per_kw));
+               res
        }
 }
 
@@ -1105,7 +1206,12 @@ impl MsgDecodable for NodeAnnouncement {
 }
 impl MsgEncodable for NodeAnnouncement {
        fn encode(&self) -> Vec<u8> {
-               unimplemented!();
+               let contents = self.contents.encode();
+               let mut res = Vec::with_capacity(64 + contents.len());
+               let secp_ctx = Secp256k1::without_caps();
+               res.extend_from_slice(&self.signature.serialize_compact(&secp_ctx));
+               res.extend_from_slice(&contents);
+               res
        }
 }
 
@@ -1160,7 +1266,15 @@ impl MsgDecodable for ChannelAnnouncement {
 }
 impl MsgEncodable for ChannelAnnouncement {
        fn encode(&self) -> Vec<u8> {
-               unimplemented!();
+               let secp_ctx = Secp256k1::without_caps();
+               let contents = self.contents.encode();
+               let mut res = Vec::with_capacity(64 + contents.len());
+               res.extend_from_slice(&self.node_signature_1.serialize_compact(&secp_ctx));
+               res.extend_from_slice(&self.node_signature_2.serialize_compact(&secp_ctx));
+               res.extend_from_slice(&self.bitcoin_signature_1.serialize_compact(&secp_ctx));
+               res.extend_from_slice(&self.bitcoin_signature_2.serialize_compact(&secp_ctx));
+               res.extend_from_slice(&contents);
+               res
        }
 }
 
@@ -1298,8 +1412,26 @@ impl MsgEncodable for OnionPacket {
 }
 
 impl MsgDecodable for DecodedOnionErrorPacket {
-       fn decode(_v: &[u8]) -> Result<Self, DecodeError> {
-               unimplemented!();
+       fn decode(v: &[u8]) -> Result<Self, DecodeError> {
+               if v.len() < 32 + 4 {
+                       return Err(DecodeError::WrongLength);
+               }
+               let failuremsg_len = byte_utils::slice_to_be16(&v[32..34]) as usize;
+               if v.len() < 32 + 4 + failuremsg_len {
+                       return Err(DecodeError::WrongLength);
+               }
+               let padding_len = byte_utils::slice_to_be16(&v[34 + failuremsg_len..]) as usize;
+               if v.len() < 32 + 4 + failuremsg_len + padding_len {
+                       return Err(DecodeError::WrongLength);
+               }
+
+               let mut hmac = [0; 32];
+               hmac.copy_from_slice(&v[0..32]);
+               Ok(Self {
+                       hmac,
+                       failuremsg: v[34..34 + failuremsg_len].to_vec(),
+                       pad: v[36 + failuremsg_len..36 + failuremsg_len + padding_len].to_vec(),
+               })
        }
 }
 impl MsgEncodable for DecodedOnionErrorPacket {
@@ -1330,7 +1462,9 @@ impl MsgDecodable for OnionErrorPacket {
 }
 impl MsgEncodable for OnionErrorPacket {
        fn encode(&self) -> Vec<u8> {
-               unimplemented!();
+               let mut res = Vec::with_capacity(2 + self.data.len());
+               res.extend_from_slice(&byte_utils::be16_to_array(self.data.len() as u16));
+               res.extend_from_slice(&self.data);
+               res
        }
 }
-