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