_ Git - rust-lightning/blob - lightning/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         /// If you fail to call either ChannelManager::claim_funds of
  61         /// ChannelManager::fail_htlc_backwards within the HTLC's timeout, the HTLC will be
  62         /// automatically failed with PaymentFailReason::PreimageUnknown.
  63         PaymentReceived {
  64                 /// The hash for which the preimage should be handed to the ChannelManager.
  65                 payment_hash: PaymentHash,
  66                 /// The "payment secret". This authenticates the sender to the recipient, preventing a
  67                 /// number of deanonymization attacks during the routing process.
  68                 /// As nodes upgrade, the invoices you provide should likely migrate to setting the
  69                 /// var_onion_optin feature to required, at which point you should fail_backwards any HTLCs
  70                 /// which have a None here.
  71                 /// Until then, however, values of None should be ignored, and only incorrect Some values
  72                 /// should result in an HTLC fail_backwards.
  73                 /// Note that, in any case, this value must be passed as-is to any fail or claim calls as
  74                 /// the HTLC index includes this value.
  75                 payment_secret: Option<[u8; 32]>,
  76                 /// The value, in thousandths of a satoshi, that this payment is for. Note that you must
  77                 /// compare this to the expected value before accepting the payment (as otherwise you are
  78                 /// providing proof-of-payment for less than the value you expected!).
  79                 amt: u64,
  80         },
  81         /// Indicates an outbound payment we made succeeded (ie it made it all the way to its target
  82         /// and we got back the payment preimage for it).
  83         /// Note that duplicative PaymentSent Events may be generated - it is your responsibility to
  84         /// deduplicate them by payment_preimage (which MUST be unique)!
  85         PaymentSent {
  86                 /// The preimage to the hash given to ChannelManager::send_payment.
  87                 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
  88                 /// store it somehow!
  89                 payment_preimage: PaymentPreimage,
  90         },
  91         /// Indicates an outbound payment we made failed. Probably some intermediary node dropped
  92         /// something. You may wish to retry with a different route.
  93         /// Note that duplicative PaymentFailed Events may be generated - it is your responsibility to
  94         /// deduplicate them by payment_hash (which MUST be unique)!
  95         PaymentFailed {
  96                 /// The hash which was given to ChannelManager::send_payment.
  97                 payment_hash: PaymentHash,
  98                 /// Indicates the payment was rejected for some reason by the recipient. This implies that
  99                 /// the payment has failed, not just the route in question. If this is not set, you may
 100                 /// retry the payment via a different route.
 101                 rejected_by_dest: bool,
 102 #[cfg(test)]
 103                 error_code: Option<u16>,
 104         },
 105         /// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
 106         /// time in the future.
 107         PendingHTLCsForwardable {
 108                 /// The minimum amount of time that should be waited prior to calling
 109                 /// process_pending_htlc_forwards. To increase the effort required to correlate payments,
 110                 /// you should wait a random amount of time in roughly the range (now + time_forwardable,
 111                 /// now + 5*time_forwardable).
 112                 time_forwardable: Duration,
 113         },
 114         /// Used to indicate that an output was generated on-chain which you should know how to spend.
 115         /// Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
 116         /// counterparty spending them due to some kind of timeout. Thus, you need to store them
 117         /// somewhere and spend them when you create on-chain transactions.
 118         SpendableOutputs {
 119                 /// The outputs which you should store as spendable by you.
 120                 outputs: Vec<SpendableOutputDescriptor>,
 121         },
 122 }
 123
 124 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
 125 /// broadcast to most peers).
 126 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
 127 #[derive(Clone)]
 128 pub enum MessageSendEvent {
 129         /// Used to indicate that we've accepted a channel open and should send the accept_channel
 130         /// message provided to the given peer.
 131         SendAcceptChannel {
 132                 /// The node_id of the node which should receive this message
 133                 node_id: PublicKey,
 134                 /// The message which should be sent.
 135                 msg: msgs::AcceptChannel,
 136         },
 137         /// Used to indicate that we've initiated a channel open and should send the open_channel
 138         /// message provided to the given peer.
 139         SendOpenChannel {
 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::OpenChannel,
 144         },
 145         /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
 146         SendFundingCreated {
 147                 /// The node_id of the node which should receive this message
 148                 node_id: PublicKey,
 149                 /// The message which should be sent.
 150                 msg: msgs::FundingCreated,
 151         },
 152         /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
 153         SendFundingSigned {
 154                 /// The node_id of the node which should receive this message
 155                 node_id: PublicKey,
 156                 /// The message which should be sent.
 157                 msg: msgs::FundingSigned,
 158         },
 159         /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
 160         SendFundingLocked {
 161                 /// The node_id of the node which should receive these message(s)
 162                 node_id: PublicKey,
 163                 /// The funding_locked message which should be sent.
 164                 msg: msgs::FundingLocked,
 165         },
 166         /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
 167         SendAnnouncementSignatures {
 168                 /// The node_id of the node which should receive these message(s)
 169                 node_id: PublicKey,
 170                 /// The announcement_signatures message which should be sent.
 171                 msg: msgs::AnnouncementSignatures,
 172         },
 173         /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
 174         /// message should be sent to the peer with the given node_id.
 175         UpdateHTLCs {
 176                 /// The node_id of the node which should receive these message(s)
 177                 node_id: PublicKey,
 178                 /// The update messages which should be sent. ALL messages in the struct should be sent!
 179                 updates: msgs::CommitmentUpdate,
 180         },
 181         /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
 182         SendRevokeAndACK {
 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::RevokeAndACK,
 187         },
 188         /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
 189         SendClosingSigned {
 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::ClosingSigned,
 194         },
 195         /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
 196         SendShutdown {
 197                 /// The node_id of the node which should receive this message
 198                 node_id: PublicKey,
 199                 /// The message which should be sent.
 200                 msg: msgs::Shutdown,
 201         },
 202         /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
 203         SendChannelReestablish {
 204                 /// The node_id of the node which should receive this message
 205                 node_id: PublicKey,
 206                 /// The message which should be sent.
 207                 msg: msgs::ChannelReestablish,
 208         },
 209         /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
 210         /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
 211         ///
 212         /// Note that after doing so, you very likely (unless you did so very recently) want to call
 213         /// ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
 214         BroadcastChannelAnnouncement {
 215                 /// The channel_announcement which should be sent.
 216                 msg: msgs::ChannelAnnouncement,
 217                 /// The followup channel_update which should be sent.
 218                 update_msg: msgs::ChannelUpdate,
 219         },
 220         /// Used to indicate that a node_announcement should be broadcast to all peers.
 221         BroadcastNodeAnnouncement {
 222                 /// The node_announcement which should be sent.
 223                 msg: msgs::NodeAnnouncement,
 224         },
 225         /// Used to indicate that a channel_update should be broadcast to all peers.
 226         BroadcastChannelUpdate {
 227                 /// The channel_update which should be sent.
 228                 msg: msgs::ChannelUpdate,
 229         },
 230         /// Broadcast an error downstream to be handled
 231         HandleError {
 232                 /// The node_id of the node which should receive this message
 233                 node_id: PublicKey,
 234                 /// The action which should be taken.
 235                 action: msgs::ErrorAction
 236         },
 237         /// When a payment fails we may receive updates back from the hop where it failed. In such
 238         /// cases this event is generated so that we can inform the router of this information.
 239         PaymentFailureNetworkUpdate {
 240                 /// The channel/node update which should be sent to router
 241                 update: msgs::HTLCFailChannelUpdate,
 242         }
 243 }
 244
 245 /// A trait indicating an object may generate message send events
 246 pub trait MessageSendEventsProvider {
 247         /// Gets the list of pending events which were generated by previous actions, clearing the list
 248         /// in the process.
 249         fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
 250 }
 251
 252 /// A trait indicating an object may generate events
 253 pub trait EventsProvider {
 254         /// Gets the list of pending events which were generated by previous actions, clearing the list
 255         /// in the process.
 256         fn get_and_clear_pending_events(&self) -> Vec<Event>;
 257 }