_ Git - rust-lightning/blob - src/util/events.rs

   1 //! Events are returned from various bits in the library which indicate some action must be taken
   2 //! by the client.
   3 //!
   4 //! Because we don't have a built-in runtime, its up to the client to call events at a time in the
   5 //! future, as well as generate and broadcast funding transactions handle payment preimages and a
   6 //! few other things.
   7 //!
   8 //! Note that many events are handled for you by PeerHandler, so in the common design of having a
   9 //! PeerManager which marshalls messages to ChannelManager and Router you only need to call
  10 //! process_events on the PeerHandler and then get_and_clear_pending_events and handle the events
  11 //! that bubble up to the surface. If, however, you do not have a PeerHandler managing a
  12 //! ChannelManager you need to handle all of the events which may be generated.
  13 //TODO: We need better separation of event types ^
  14
  15 use ln::msgs;
  16 use chain::transaction::OutPoint;
  17
  18 use bitcoin::blockdata::script::Script;
  19
  20 use secp256k1::key::PublicKey;
  21
  22 use std::time::Instant;
  23
  24 /// An Event which you should probably take some action in response to.
  25 pub enum Event {
  26         // Events a user will probably have to handle
  27         /// Used to indicate that the client should generate a funding transaction with the given
  28         /// parameters and then call ChannelManager::funding_transaction_generated.
  29         /// Generated in ChannelManager message handling.
  30         FundingGenerationReady {
  31                 /// The random channel_id we picked which you'll need to pass into
  32                 /// ChannelManager::funding_transaction_generated.
  33                 temporary_channel_id: [u8; 32],
  34                 /// The value, in satoshis, that the output should have.
  35                 channel_value_satoshis: u64,
  36                 /// The script which should be used in the transaction output.
  37                 output_script: Script,
  38                 /// The value passed in to ChannelManager::create_channel
  39                 user_channel_id: u64,
  40         },
  41         /// Used to indicate that the client may now broadcast the funding transaction it created for a
  42         /// channel. Broadcasting such a transaction prior to this event may lead to our counterparty
  43         /// trivially stealing all funds in the funding transaction!
  44         FundingBroadcastSafe {
  45                 /// The output, which was passed to ChannelManager::funding_transaction_generated, which is
  46                 /// now safe to broadcast.
  47                 funding_txo: OutPoint,
  48                 /// The value passed in to ChannelManager::create_channel
  49                 user_channel_id: u64,
  50         },
  51         /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
  52         /// ChannelManager::claim_funds to get it....
  53         /// Note that if the preimage is not known or the amount paid is incorrect, you must call
  54         /// ChannelManager::fail_htlc_backwards with PaymentFailReason::PreimageUnknown or
  55         /// PaymentFailReason::AmountMismatch, respectively, to free up resources for this HTLC.
  56         /// The amount paid should be considered 'incorrect' when it is less than or more than twice
  57         /// the amount expected.
  58         PaymentReceived {
  59                 /// The hash for which the preimage should be handed to the ChannelManager.
  60                 payment_hash: [u8; 32],
  61                 /// The value, in thousandths of a satoshi, that this payment is for.
  62                 amt: u64,
  63         },
  64         /// Indicates an outbound payment we made succeeded (ie it made it all the way to its target
  65         /// and we got back the payment preimage for it).
  66         /// Note that duplicative PaymentSent Events may be generated - it is your responsibility to
  67         /// deduplicate them by payment_preimage (which MUST be unique)!
  68         PaymentSent {
  69                 /// The preimage to the hash given to ChannelManager::send_payment.
  70                 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
  71                 /// store it somehow!
  72                 payment_preimage: [u8; 32],
  73         },
  74         /// Indicates an outbound payment we made failed. Probably some intermediary node dropped
  75         /// something. You may wish to retry with a different route.
  76         /// Note that duplicative PaymentFailed Events may be generated - it is your responsibility to
  77         /// deduplicate them by payment_hash (which MUST be unique)!
  78         PaymentFailed {
  79                 /// The hash which was given to ChannelManager::send_payment.
  80                 payment_hash: [u8; 32],
  81                 /// Indicates the payment was rejected for some reason by the recipient. This implies that
  82                 /// the payment has failed, not just the route in question. If this is not set, you may
  83                 /// retry the payment via a different route.
  84                 rejected_by_dest: bool,
  85         },
  86         /// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
  87         /// time in the future.
  88         PendingHTLCsForwardable {
  89                 /// The earliest time at which process_pending_htlc_forwards should be called.
  90                 time_forwardable: Instant,
  91         },
  92
  93         // Events indicating the network loop should send a message to a peer:
  94         // TODO: Move these into a separate struct and make a top-level enum
  95         /// Used to indicate that we've initialted a channel open and should send the open_channel
  96         /// message provided to the given peer.
  97         ///
  98         /// This event is handled by PeerManager::process_events if you are using a PeerManager.
  99         SendOpenChannel {
 100                 /// The node_id of the node which should receive this message
 101                 node_id: PublicKey,
 102                 /// The message which should be sent.
 103                 msg: msgs::OpenChannel,
 104         },
 105         /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
 106         ///
 107         /// This event is handled by PeerManager::process_events if you are using a PeerManager.
 108         SendFundingCreated {
 109                 /// The node_id of the node which should receive this message
 110                 node_id: PublicKey,
 111                 /// The message which should be sent.
 112                 msg: msgs::FundingCreated,
 113         },
 114         /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
 115         ///
 116         /// This event is handled by PeerManager::process_events if you are using a PeerManager.
 117         SendFundingLocked {
 118                 /// The node_id of the node which should receive these message(s)
 119                 node_id: PublicKey,
 120                 /// The funding_locked message which should be sent.
 121                 msg: msgs::FundingLocked,
 122                 /// An optional additional announcement_signatures message which should be sent.
 123                 announcement_sigs: Option<msgs::AnnouncementSignatures>,
 124         },
 125         /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
 126         /// message should be sent to the peer with the given node_id.
 127         ///
 128         /// This event is handled by PeerManager::process_events if you are using a PeerManager.
 129         UpdateHTLCs {
 130                 /// The node_id of the node which should receive these message(s)
 131                 node_id: PublicKey,
 132                 /// The update messages which should be sent. ALL messages in the struct should be sent!
 133                 updates: msgs::CommitmentUpdate,
 134         },
 135         /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
 136         ///
 137         /// This event is handled by PeerManager::process_events if you are using a PeerManager.
 138         SendRevokeAndACK {
 139                 /// The node_id of the node which should receive this message
 140                 node_id: PublicKey,
 141                 /// The message which should be sent.
 142                 msg: msgs::RevokeAndACK,
 143         },
 144         /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
 145         ///
 146         /// This event is handled by PeerManager::process_events if you are using a PeerManager.
 147         SendShutdown {
 148                 /// The node_id of the node which should receive this message
 149                 node_id: PublicKey,
 150                 /// The message which should be sent.
 151                 msg: msgs::Shutdown,
 152         },
 153         /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
 154         /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
 155         ///
 156         /// This event is handled by PeerManager::process_events if you are using a PeerManager.
 157         BroadcastChannelAnnouncement {
 158                 /// The channel_announcement which should be sent.
 159                 msg: msgs::ChannelAnnouncement,
 160                 /// The followup channel_update which should be sent.
 161                 update_msg: msgs::ChannelUpdate,
 162         },
 163         /// Used to indicate that a channel_update should be broadcast to all peers.
 164         ///
 165         /// This event is handled by PeerManager::process_events if you are using a PeerManager.
 166         BroadcastChannelUpdate {
 167                 /// The channel_update which should be sent.
 168                 msg: msgs::ChannelUpdate,
 169         },
 170
 171         //Error handling
 172         /// Broadcast an error downstream to be handled
 173         ///
 174         /// This event is handled by PeerManager::process_events if you are using a PeerManager.
 175         HandleError {
 176                 /// The node_id of the node which should receive this message
 177                 node_id: PublicKey,
 178                 /// The action which should be taken.
 179                 action: Option<msgs::ErrorAction>
 180         },
 181         /// When a payment fails we may receive updates back from the hop where it failed. In such
 182         /// cases this event is generated so that we can inform the router of this information.
 183         ///
 184         /// This event is handled by PeerManager::process_events if you are using a PeerManager.
 185         PaymentFailureNetworkUpdate {
 186                 /// The channel/node update which should be sent to router
 187                 update: msgs::HTLCFailChannelUpdate,
 188         }
 189 }
 190
 191 /// A trait indicating an object may generate events
 192 pub trait EventsProvider {
 193         /// Gets the list of pending events which were generated by previous actions, clearing the list
 194         /// in the process.
 195         fn get_and_clear_pending_events(&self) -> Vec<Event>;
 196 }