Correct MAX_BUF_SIZE in serialization
[rust-lightning] / src / util / events.rs
index 1bdc3682168ff73d4c567c286eca136f8158725c..0dee714d22d8efc5eb58e911352e1839148468e1 100644 (file)
@@ -1,8 +1,7 @@
 use ln::msgs;
+use chain::transaction::OutPoint;
 
 use bitcoin::blockdata::script::Script;
-use bitcoin::util::uint::Uint256;
-use bitcoin::util::hash::Sha256dHash;
 
 use secp256k1::key::PublicKey;
 
@@ -14,7 +13,7 @@ pub enum Event {
        /// parameters and then call ChannelManager::funding_transaction_generated.
        /// Generated in ChannelManager message handling.
        FundingGenerationReady {
-               temporary_channel_id: Uint256,
+               temporary_channel_id: [u8; 32],
                channel_value_satoshis: u64,
                output_script: Script,
                /// The value passed in to ChannelManager::create_channel
@@ -24,23 +23,42 @@ pub enum Event {
        /// channel. Broadcasting such a transaction prior to this event may lead to our counterparty
        /// trivially stealing all funds in the funding transaction!
        FundingBroadcastSafe {
-               funding_txo: (Sha256dHash, u16),
+               funding_txo: OutPoint,
                /// The value passed in to ChannelManager::create_channel
                user_channel_id: u64,
        },
        /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
        /// ChannelManager::claim_funds to get it....
+       /// Note that if the preimage is not known, you must call ChannelManager::fail_htlc_backwards
+       /// to free up resources for this HTLC.
        PaymentReceived {
                payment_hash: [u8; 32],
                amt: u64,
        },
-
-       // Events indicating the network loop should send a message to a peer:
+       /// Indicates an outbound payment we made succeeded (ie it made it all the way to its target
+       /// and we got back the payment preimage for it). payment_preimage serves as a payment receipt,
+       /// if you wish to have such a thing, you must store it somehow!
+       PaymentSent {
+               payment_preimage: [u8; 32],
+       },
+       /// Indicates an outbound payment we made failed. Probably some intermediary node dropped
+       /// something. You may wish to retry with a different route.
+       PaymentFailed {
+               payment_hash: [u8; 32],
+       },
        /// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
        /// time in the future.
        PendingHTLCsForwardable {
                time_forwardable: Instant,
        },
+
+       // Events indicating the network loop should send a message to a peer:
+       /// Used to indicate that we've initialted a channel open and should send the open_channel
+       /// message provided to the given peer
+       SendOpenChannel {
+               node_id: PublicKey,
+               msg: msgs::OpenChannel,
+       },
        /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
        SendFundingCreated {
                node_id: PublicKey,
@@ -52,17 +70,16 @@ pub enum Event {
                msg: msgs::FundingLocked,
                announcement_sigs: Option<msgs::AnnouncementSignatures>,
        },
-       /// Used to indicate that a series of update_add_htlc messages, as well as a commitment_signed
+       /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
        /// message should be sent to the peer with the given node_id.
-       SendHTLCs {
+       UpdateHTLCs {
                node_id: PublicKey,
-               msgs: Vec<msgs::UpdateAddHTLC>,
-               commitment_msg: msgs::CommitmentSigned,
+               updates: msgs::CommitmentUpdate,
        },
-       /// Used to indicate that we're ready to fulfill an htlc from the peer with the given node_id.
-       SendFulfillHTLC {
+       /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
+       SendShutdown {
                node_id: PublicKey,
-               msg: msgs::UpdateFulfillHTLC,
+               msg: msgs::Shutdown,
        },
        /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
        /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
@@ -70,6 +87,17 @@ pub enum Event {
                msg: msgs::ChannelAnnouncement,
                update_msg: msgs::ChannelUpdate,
        },
+       /// Used to indicate that a channel_update should be broadcast to all peers.
+       BroadcastChannelUpdate {
+               msg: msgs::ChannelUpdate,
+       },
+
+       //Error handling
+       /// Broadcast an error downstream to be handled
+       HandleError {
+               node_id: PublicKey,
+               action: Option<msgs::ErrorAction>
+       }
 }
 
 pub trait EventsProvider {