_ 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::Duration;
  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 minimum amount of time that should be waited prior to calling
  96                 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
  97                 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
  98                 /// now + 5*time_forwardable).
  99                 time_forwardable: Duration,
 100         },
 101         /// Used to indicate that an output was generated on-chain which you should know how to spend.
 102         /// Such an output will *not* ever be spent by rust-lightning, so you need to store them
 103         /// somewhere and spend them when you create on-chain spends.
 104         SpendableOutputs {
 105                 /// The outputs which you should store as spendable by you.
 106                 outputs: Vec<SpendableOutputDescriptor>,
 107         },
 108 }
 109
 110 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
 111 /// broadcast to most peers).
 112 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
 113 #[derive(Clone)]
 114 pub enum MessageSendEvent {
 115         /// Used to indicate that we've accepted a channel open and should send the accept_channel
 116         /// message provided to the given peer.
 117         SendAcceptChannel {
 118                 /// The node_id of the node which should receive this message
 119                 node_id: PublicKey,
 120                 /// The message which should be sent.
 121                 msg: msgs::AcceptChannel,
 122         },
 123         /// Used to indicate that we've initiated a channel open and should send the open_channel
 124         /// message provided to the given peer.
 125         SendOpenChannel {
 126                 /// The node_id of the node which should receive this message
 127                 node_id: PublicKey,
 128                 /// The message which should be sent.
 129                 msg: msgs::OpenChannel,
 130         },
 131         /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
 132         SendFundingCreated {
 133                 /// The node_id of the node which should receive this message
 134                 node_id: PublicKey,
 135                 /// The message which should be sent.
 136                 msg: msgs::FundingCreated,
 137         },
 138         /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
 139         SendFundingSigned {
 140                 /// The node_id of the node which should receive this message
 141                 node_id: PublicKey,
 142                 /// The message which should be sent.
 143                 msg: msgs::FundingSigned,
 144         },
 145         /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
 146         SendFundingLocked {
 147                 /// The node_id of the node which should receive these message(s)
 148                 node_id: PublicKey,
 149                 /// The funding_locked message which should be sent.
 150                 msg: msgs::FundingLocked,
 151         },
 152         /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
 153         SendAnnouncementSignatures {
 154                 /// The node_id of the node which should receive these message(s)
 155                 node_id: PublicKey,
 156                 /// The announcement_signatures message which should be sent.
 157                 msg: msgs::AnnouncementSignatures,
 158         },
 159         /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
 160         /// message should be sent to the peer with the given node_id.
 161         UpdateHTLCs {
 162                 /// The node_id of the node which should receive these message(s)
 163                 node_id: PublicKey,
 164                 /// The update messages which should be sent. ALL messages in the struct should be sent!
 165                 updates: msgs::CommitmentUpdate,
 166         },
 167         /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
 168         SendRevokeAndACK {
 169                 /// The node_id of the node which should receive this message
 170                 node_id: PublicKey,
 171                 /// The message which should be sent.
 172                 msg: msgs::RevokeAndACK,
 173         },
 174         /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
 175         SendClosingSigned {
 176                 /// The node_id of the node which should receive this message
 177                 node_id: PublicKey,
 178                 /// The message which should be sent.
 179                 msg: msgs::ClosingSigned,
 180         },
 181         /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
 182         SendShutdown {
 183                 /// The node_id of the node which should receive this message
 184                 node_id: PublicKey,
 185                 /// The message which should be sent.
 186                 msg: msgs::Shutdown,
 187         },
 188         /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
 189         SendChannelReestablish {
 190                 /// The node_id of the node which should receive this message
 191                 node_id: PublicKey,
 192                 /// The message which should be sent.
 193                 msg: msgs::ChannelReestablish,
 194         },
 195         /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
 196         /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
 197         BroadcastChannelAnnouncement {
 198                 /// The channel_announcement which should be sent.
 199                 msg: msgs::ChannelAnnouncement,
 200                 /// The followup channel_update which should be sent.
 201                 update_msg: msgs::ChannelUpdate,
 202         },
 203         /// Used to indicate that a channel_update should be broadcast to all peers.
 204         BroadcastChannelUpdate {
 205                 /// The channel_update which should be sent.
 206                 msg: msgs::ChannelUpdate,
 207         },
 208         /// Broadcast an error downstream to be handled
 209         HandleError {
 210                 /// The node_id of the node which should receive this message
 211                 node_id: PublicKey,
 212                 /// The action which should be taken.
 213                 action: msgs::ErrorAction
 214         },
 215         /// When a payment fails we may receive updates back from the hop where it failed. In such
 216         /// cases this event is generated so that we can inform the router of this information.
 217         PaymentFailureNetworkUpdate {
 218                 /// The channel/node update which should be sent to router
 219                 update: msgs::HTLCFailChannelUpdate,
 220         }
 221 }
 222
 223 /// A trait indicating an object may generate message send events
 224 pub trait MessageSendEventsProvider {
 225         /// Gets the list of pending events which were generated by previous actions, clearing the list
 226         /// in the process.
 227         fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
 228 }
 229
 230 /// A trait indicating an object may generate events
 231 pub trait EventsProvider {
 232         /// Gets the list of pending events which were generated by previous actions, clearing the list
 233         /// in the process.
 234         fn get_and_clear_pending_events(&self) -> Vec<Event>;
 235 }