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