_ 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, it's 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 ln::channelmanager::{PaymentPreimage, PaymentHash};
  17 use chain::transaction::OutPoint;
  18 use chain::keysinterface::SpendableOutputDescriptor;
  19
  20 use bitcoin::blockdata::script::Script;
  21
  22 use secp256k1::key::PublicKey;
  23
  24 use std::time::Instant;
  25
  26 /// An Event which you should probably take some action in response to.
  27 pub enum Event {
  28         /// Used to indicate that the client should generate a funding transaction with the given
  29         /// parameters and then call ChannelManager::funding_transaction_generated.
  30         /// Generated in ChannelManager message handling.
  31         /// Note that *all inputs* in the funding transaction must spend SegWit outputs or your
  32         /// counterparty can steal your funds!
  33         FundingGenerationReady {
  34                 /// The random channel_id we picked which you'll need to pass into
  35                 /// ChannelManager::funding_transaction_generated.
  36                 temporary_channel_id: [u8; 32],
  37                 /// The value, in satoshis, that the output should have.
  38                 channel_value_satoshis: u64,
  39                 /// The script which should be used in the transaction output.
  40                 output_script: Script,
  41                 /// The value passed in to ChannelManager::create_channel
  42                 user_channel_id: u64,
  43         },
  44         /// Used to indicate that the client may now broadcast the funding transaction it created for a
  45         /// channel. Broadcasting such a transaction prior to this event may lead to our counterparty
  46         /// trivially stealing all funds in the funding transaction!
  47         FundingBroadcastSafe {
  48                 /// The output, which was passed to ChannelManager::funding_transaction_generated, which is
  49                 /// now safe to broadcast.
  50                 funding_txo: OutPoint,
  51                 /// The value passed in to ChannelManager::create_channel
  52                 user_channel_id: u64,
  53         },
  54         /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
  55         /// ChannelManager::claim_funds to get it....
  56         /// Note that if the preimage is not known or the amount paid is incorrect, you must call
  57         /// ChannelManager::fail_htlc_backwards to free up resources for this HTLC.
  58         /// The amount paid should be considered 'incorrect' when it is less than or more than twice
  59         /// the amount expected.
  60         PaymentReceived {
  61                 /// The hash for which the preimage should be handed to the ChannelManager.
  62                 payment_hash: PaymentHash,
  63                 /// The value, in thousandths of a satoshi, that this payment is for. Note that you must
  64                 /// compare this to the expected value before accepting the payment (as otherwise you are
  65                 /// providing proof-of-payment for less than the value you expected!).
  66                 amt: u64,
  67         },
  68         /// Indicates an outbound payment we made succeeded (ie it made it all the way to its target
  69         /// and we got back the payment preimage for it).
  70         /// Note that duplicative PaymentSent Events may be generated - it is your responsibility to
  71         /// deduplicate them by payment_preimage (which MUST be unique)!
  72         PaymentSent {
  73                 /// The preimage to the hash given to ChannelManager::send_payment.
  74                 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
  75                 /// store it somehow!
  76                 payment_preimage: PaymentPreimage,
  77         },
  78         /// Indicates an outbound payment we made failed. Probably some intermediary node dropped
  79         /// something. You may wish to retry with a different route.
  80         /// Note that duplicative PaymentFailed Events may be generated - it is your responsibility to
  81         /// deduplicate them by payment_hash (which MUST be unique)!
  82         PaymentFailed {
  83                 /// The hash which was given to ChannelManager::send_payment.
  84                 payment_hash: PaymentHash,
  85                 /// Indicates the payment was rejected for some reason by the recipient. This implies that
  86                 /// the payment has failed, not just the route in question. If this is not set, you may
  87                 /// retry the payment via a different route.
  88                 rejected_by_dest: bool,
  89 #[cfg(test)]
  90                 error_code: Option<u16>,
  91         },
  92         /// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
  93         /// time in the future.
  94         PendingHTLCsForwardable {
  95                 /// The earliest time at which process_pending_htlc_forwards should be called.
  96                 time_forwardable: Instant,
  97         },
  98         /// Used to indicate that an output was generated on-chain which you should know how to spend.
  99         /// Such an output will *not* ever be spent by rust-lightning, so you need to store them
 100         /// somewhere and spend them when you create on-chain spends.
 101         SpendableOutputs {
 102                 /// The outputs which you should store as spendable by you.
 103                 outputs: Vec<SpendableOutputDescriptor>,
 104         },
 105 }
 106
 107 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
 108 /// broadcast to most peers).
 109 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
 110 #[derive(Clone)]
 111 pub enum MessageSendEvent {
 112         /// Used to indicate that we've accepted a channel open and should send the accept_channel
 113         /// message provided to the given peer.
 114         SendAcceptChannel {
 115                 /// The node_id of the node which should receive this message
 116                 node_id: PublicKey,
 117                 /// The message which should be sent.
 118                 msg: msgs::AcceptChannel,
 119         },
 120         /// Used to indicate that we've initiated a channel open and should send the open_channel
 121         /// message provided to the given peer.
 122         SendOpenChannel {
 123                 /// The node_id of the node which should receive this message
 124                 node_id: PublicKey,
 125                 /// The message which should be sent.
 126                 msg: msgs::OpenChannel,
 127         },
 128         /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
 129         SendFundingCreated {
 130                 /// The node_id of the node which should receive this message
 131                 node_id: PublicKey,
 132                 /// The message which should be sent.
 133                 msg: msgs::FundingCreated,
 134         },
 135         /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
 136         SendFundingSigned {
 137                 /// The node_id of the node which should receive this message
 138                 node_id: PublicKey,
 139                 /// The message which should be sent.
 140                 msg: msgs::FundingSigned,
 141         },
 142         /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
 143         SendFundingLocked {
 144                 /// The node_id of the node which should receive these message(s)
 145                 node_id: PublicKey,
 146                 /// The funding_locked message which should be sent.
 147                 msg: msgs::FundingLocked,
 148         },
 149         /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
 150         SendAnnouncementSignatures {
 151                 /// The node_id of the node which should receive these message(s)
 152                 node_id: PublicKey,
 153                 /// The announcement_signatures message which should be sent.
 154                 msg: msgs::AnnouncementSignatures,
 155         },
 156         /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
 157         /// message should be sent to the peer with the given node_id.
 158         UpdateHTLCs {
 159                 /// The node_id of the node which should receive these message(s)
 160                 node_id: PublicKey,
 161                 /// The update messages which should be sent. ALL messages in the struct should be sent!
 162                 updates: msgs::CommitmentUpdate,
 163         },
 164         /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
 165         SendRevokeAndACK {
 166                 /// The node_id of the node which should receive this message
 167                 node_id: PublicKey,
 168                 /// The message which should be sent.
 169                 msg: msgs::RevokeAndACK,
 170         },
 171         /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
 172         SendClosingSigned {
 173                 /// The node_id of the node which should receive this message
 174                 node_id: PublicKey,
 175                 /// The message which should be sent.
 176                 msg: msgs::ClosingSigned,
 177         },
 178         /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
 179         SendShutdown {
 180                 /// The node_id of the node which should receive this message
 181                 node_id: PublicKey,
 182                 /// The message which should be sent.
 183                 msg: msgs::Shutdown,
 184         },
 185         /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
 186         SendChannelReestablish {
 187                 /// The node_id of the node which should receive this message
 188                 node_id: PublicKey,
 189                 /// The message which should be sent.
 190                 msg: msgs::ChannelReestablish,
 191         },
 192         /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
 193         /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
 194         BroadcastChannelAnnouncement {
 195                 /// The channel_announcement which should be sent.
 196                 msg: msgs::ChannelAnnouncement,
 197                 /// The followup channel_update which should be sent.
 198                 update_msg: msgs::ChannelUpdate,
 199         },
 200         /// Used to indicate that a channel_update should be broadcast to all peers.
 201         BroadcastChannelUpdate {
 202                 /// The channel_update which should be sent.
 203                 msg: msgs::ChannelUpdate,
 204         },
 205         /// Broadcast an error downstream to be handled
 206         HandleError {
 207                 /// The node_id of the node which should receive this message
 208                 node_id: PublicKey,
 209                 /// The action which should be taken.
 210                 action: Option<msgs::ErrorAction>
 211         },
 212         /// When a payment fails we may receive updates back from the hop where it failed. In such
 213         /// cases this event is generated so that we can inform the router of this information.
 214         PaymentFailureNetworkUpdate {
 215                 /// The channel/node update which should be sent to router
 216                 update: msgs::HTLCFailChannelUpdate,
 217         }
 218 }
 219
 220 /// A trait indicating an object may generate message send events
 221 pub trait MessageSendEventsProvider {
 222         /// Gets the list of pending events which were generated by previous actions, clearing the list
 223         /// in the process.
 224         fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
 225 }
 226
 227 /// A trait indicating an object may generate events
 228 pub trait EventsProvider {
 229         /// Gets the list of pending events which were generated by previous actions, clearing the list
 230         /// in the process.
 231         fn get_and_clear_pending_events(&self) -> Vec<Event>;
 232 }