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