git.bitcoin.ninja 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         /// Note that *all inputs* in the funding transaction must spend SegWit outputs or your
  31         /// counterparty can steal your funds!
  32         FundingGenerationReady {
  33                 /// The random channel_id we picked which you'll need to pass into
  34                 /// ChannelManager::funding_transaction_generated.
  35                 temporary_channel_id: [u8; 32],
  36                 /// The value, in satoshis, that the output should have.
  37                 channel_value_satoshis: u64,
  38                 /// The script which should be used in the transaction output.
  39                 output_script: Script,
  40                 /// The value passed in to ChannelManager::create_channel
  41                 user_channel_id: u64,
  42         },
  43         /// Used to indicate that the client may now broadcast the funding transaction it created for a
  44         /// channel. Broadcasting such a transaction prior to this event may lead to our counterparty
  45         /// trivially stealing all funds in the funding transaction!
  46         FundingBroadcastSafe {
  47                 /// The output, which was passed to ChannelManager::funding_transaction_generated, which is
  48                 /// now safe to broadcast.
  49                 funding_txo: OutPoint,
  50                 /// The value passed in to ChannelManager::create_channel
  51                 user_channel_id: u64,
  52         },
  53         /// Indicates we've received money! Just gotta dig out that payment preimage and feed it to
  54         /// ChannelManager::claim_funds to get it....
  55         /// Note that if the preimage is not known or the amount paid is incorrect, you must call
  56         /// ChannelManager::fail_htlc_backwards with PaymentFailReason::PreimageUnknown or
  57         /// PaymentFailReason::AmountMismatch, respectively, 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: [u8; 32],
  63                 /// The value, in thousandths of a satoshi, that this payment is for.
  64                 amt: u64,
  65         },
  66         /// Indicates an outbound payment we made succeeded (ie it made it all the way to its target
  67         /// and we got back the payment preimage for it).
  68         /// Note that duplicative PaymentSent Events may be generated - it is your responsibility to
  69         /// deduplicate them by payment_preimage (which MUST be unique)!
  70         PaymentSent {
  71                 /// The preimage to the hash given to ChannelManager::send_payment.
  72                 /// Note that this serves as a payment receipt, if you wish to have such a thing, you must
  73                 /// store it somehow!
  74                 payment_preimage: [u8; 32],
  75         },
  76         /// Indicates an outbound payment we made failed. Probably some intermediary node dropped
  77         /// something. You may wish to retry with a different route.
  78         /// Note that duplicative PaymentFailed Events may be generated - it is your responsibility to
  79         /// deduplicate them by payment_hash (which MUST be unique)!
  80         PaymentFailed {
  81                 /// The hash which was given to ChannelManager::send_payment.
  82                 payment_hash: [u8; 32],
  83                 /// Indicates the payment was rejected for some reason by the recipient. This implies that
  84                 /// the payment has failed, not just the route in question. If this is not set, you may
  85                 /// retry the payment via a different route.
  86                 rejected_by_dest: bool,
  87         },
  88         /// Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
  89         /// time in the future.
  90         PendingHTLCsForwardable {
  91                 /// The earliest time at which process_pending_htlc_forwards should be called.
  92                 time_forwardable: Instant,
  93         },
  94         /// Used to indicate that an output was generated on-chain which you should know how to spend.
  95         /// Such an output will *not* ever be spent by rust-lightning, so you need to store them
  96         /// somewhere and spend them when you create on-chain spends.
  97         SpendableOutputs {
  98                 /// The outputs which you should store as spendable by you.
  99                 outputs: Vec<SpendableOutputDescriptor>,
 100         },
 101 }
 102
 103 /// An event generated by ChannelManager which indicates a message should be sent to a peer (or
 104 /// broadcast to most peers).
 105 /// These events are handled by PeerManager::process_events if you are using a PeerManager.
 106 #[derive(Clone)]
 107 pub enum MessageSendEvent {
 108         /// Used to indicate that we've accepted a channel open and should send the accept_channel
 109         /// message provided to the given peer.
 110         SendAcceptChannel {
 111                 /// The node_id of the node which should receive this message
 112                 node_id: PublicKey,
 113                 /// The message which should be sent.
 114                 msg: msgs::AcceptChannel,
 115         },
 116         /// Used to indicate that we've initiated a channel open and should send the open_channel
 117         /// message provided to the given peer.
 118         SendOpenChannel {
 119                 /// The node_id of the node which should receive this message
 120                 node_id: PublicKey,
 121                 /// The message which should be sent.
 122                 msg: msgs::OpenChannel,
 123         },
 124         /// Used to indicate that a funding_created message should be sent to the peer with the given node_id.
 125         SendFundingCreated {
 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::FundingCreated,
 130         },
 131         /// Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
 132         SendFundingSigned {
 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::FundingSigned,
 137         },
 138         /// Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
 139         SendFundingLocked {
 140                 /// The node_id of the node which should receive these message(s)
 141                 node_id: PublicKey,
 142                 /// The funding_locked message which should be sent.
 143                 msg: msgs::FundingLocked,
 144         },
 145         /// Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
 146         SendAnnouncementSignatures {
 147                 /// The node_id of the node which should receive these message(s)
 148                 node_id: PublicKey,
 149                 /// The announcement_signatures message which should be sent.
 150                 msg: msgs::AnnouncementSignatures,
 151         },
 152         /// Used to indicate that a series of HTLC update messages, as well as a commitment_signed
 153         /// message should be sent to the peer with the given node_id.
 154         UpdateHTLCs {
 155                 /// The node_id of the node which should receive these message(s)
 156                 node_id: PublicKey,
 157                 /// The update messages which should be sent. ALL messages in the struct should be sent!
 158                 updates: msgs::CommitmentUpdate,
 159         },
 160         /// Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
 161         SendRevokeAndACK {
 162                 /// The node_id of the node which should receive this message
 163                 node_id: PublicKey,
 164                 /// The message which should be sent.
 165                 msg: msgs::RevokeAndACK,
 166         },
 167         /// Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
 168         SendClosingSigned {
 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::ClosingSigned,
 173         },
 174         /// Used to indicate that a shutdown message should be sent to the peer with the given node_id.
 175         SendShutdown {
 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::Shutdown,
 180         },
 181         /// Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
 182         SendChannelReestablish {
 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::ChannelReestablish,
 187         },
 188         /// Used to indicate that a channel_announcement and channel_update should be broadcast to all
 189         /// peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
 190         BroadcastChannelAnnouncement {
 191                 /// The channel_announcement which should be sent.
 192                 msg: msgs::ChannelAnnouncement,
 193                 /// The followup channel_update which should be sent.
 194                 update_msg: msgs::ChannelUpdate,
 195         },
 196         /// Used to indicate that a channel_update should be broadcast to all peers.
 197         BroadcastChannelUpdate {
 198                 /// The channel_update which should be sent.
 199                 msg: msgs::ChannelUpdate,
 200         },
 201         /// Broadcast an error downstream to be handled
 202         HandleError {
 203                 /// The node_id of the node which should receive this message
 204                 node_id: PublicKey,
 205                 /// The action which should be taken.
 206                 action: Option<msgs::ErrorAction>
 207         },
 208         /// When a payment fails we may receive updates back from the hop where it failed. In such
 209         /// cases this event is generated so that we can inform the router of this information.
 210         PaymentFailureNetworkUpdate {
 211                 /// The channel/node update which should be sent to router
 212                 update: msgs::HTLCFailChannelUpdate,
 213         }
 214 }
 215
 216 /// A trait indicating an object may generate message send events
 217 pub trait MessageSendEventsProvider {
 218         /// Gets the list of pending events which were generated by previous actions, clearing the list
 219         /// in the process.
 220         fn get_and_clear_pending_msg_events(&self) -> Vec<MessageSendEvent>;
 221 }
 222
 223 /// A trait indicating an object may generate events
 224 pub trait EventsProvider {
 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_events(&self) -> Vec<Event>;
 228 }