X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=blobdiff_plain;f=lightning%2Fsrc%2Fchain%2Fkeysinterface.rs;h=b65cd0df77d3a150011d53c321ccb1fec406c96c;hb=6c9180f9729cb9785892cc2d844dcc42821d6ff9;hp=c001646263fdf0d7ae4e1f1c079ed02ab3b40135;hpb=0b5b2828f980b615187fae05a950cc41e4fb186b;p=rust-lightning diff --git a/lightning/src/chain/keysinterface.rs b/lightning/src/chain/keysinterface.rs index c0016462..b65cd0df 100644 --- a/lightning/src/chain/keysinterface.rs +++ b/lightning/src/chain/keysinterface.rs @@ -24,49 +24,62 @@ use util::logger::Logger; use util::ser::Writeable; use ln::chan_utils; -use ln::chan_utils::{TxCreationKeys, HTLCOutputInCommitment, make_funding_redeemscript}; +use ln::chan_utils::{TxCreationKeys, HTLCOutputInCommitment, make_funding_redeemscript, ChannelPublicKeys}; use ln::msgs; use std::sync::Arc; use std::sync::atomic::{AtomicUsize, Ordering}; -/// When on-chain outputs are created by rust-lightning an event is generated which informs the -/// user thereof. This enum describes the format of the output and provides the OutPoint. +/// When on-chain outputs are created by rust-lightning (which our counterparty is not able to +/// claim at any point in the future) an event is generated which you must track and be able to +/// spend on-chain. The information needed to do this is provided in this enum, including the +/// outpoint describing which txid and output index is available, the full output which exists at +/// that txid/index, and any keys or other information required to sign. pub enum SpendableOutputDescriptor { - /// Outpoint with an output to a script which was provided via KeysInterface, thus you should - /// have stored somewhere how to spend script_pubkey! - /// Outputs from a justice tx, claim tx or preimage tx + /// An output to a script which was provided via KeysInterface, thus you should already know + /// how to spend it. No keys are provided as rust-lightning was never given any keys - only the + /// script_pubkey as it appears in the output. + /// These may include outputs from a transaction punishing our counterparty or claiming an HTLC + /// on-chain using the payment preimage or after it has timed out. StaticOutput { - /// The outpoint spendable by user wallet + /// The outpoint which is spendable outpoint: OutPoint, - /// The output which is referenced by the given outpoint + /// The output which is referenced by the given outpoint. output: TxOut, }, - /// Outpoint commits to a P2WSH - /// P2WSH should be spend by the following witness : - /// 0 - /// With input nSequence set to_self_delay. - /// Outputs from a HTLC-Success/Timeout tx/commitment tx + /// An output to a P2WSH script which can be spent with a single signature after a CSV delay. + /// The private key which should be used to sign the transaction is provided, as well as the + /// full witness redeemScript which is hashed in the output script_pubkey. + /// The witness in the spending input should be: + /// + /// + /// Note that the nSequence field in the input must be set to_self_delay (which corresponds to + /// the transaction not being broadcastable until at least to_self_delay blocks after the input + /// confirms). + /// These are generally the result of a "revocable" output to us, spendable only by us unless + /// it is an output from us having broadcast an old state (which should never happen). DynamicOutputP2WSH { - /// Outpoint spendable by user wallet + /// The outpoint which is spendable outpoint: OutPoint, - /// local_delayedkey = delayed_payment_basepoint_secret + SHA256(per_commitment_point || delayed_payment_basepoint) OR + /// The secret key which must be used to sign the spending transaction key: SecretKey, - /// witness redeemScript encumbering output. + /// The witness redeemScript which is hashed to create the script_pubkey in the given output witness_script: Script, - /// nSequence input must commit to self_delay to satisfy script's OP_CSV + /// The nSequence value which must be set in the spending input to satisfy the OP_CSV in + /// the witness_script. to_self_delay: u16, /// The output which is referenced by the given outpoint output: TxOut, }, - /// Outpoint commits to a P2WPKH - /// P2WPKH should be spend by the following witness : - /// - /// Outputs to_remote from a commitment tx + /// An output to a P2WPKH, spendable exclusively by the given private key. + /// The witness in the spending input, is, thus, simply: + /// + /// These are generally the result of our counterparty having broadcast the current state, + /// allowing us to claim the non-HTLC-encumbered outputs immediately. DynamicOutputP2WPKH { - /// Outpoint spendable by user wallet + /// The outpoint which is spendable outpoint: OutPoint, - /// localkey = payment_basepoint_secret + SHA256(per_commitment_point || payment_basepoint + /// The secret key which must be used to sign the spending transaction key: SecretKey, /// The output which is reference by the given outpoint output: TxOut, @@ -142,7 +155,7 @@ pub trait ChannelKeys : Send { /// TODO: Document the things someone using this interface should enforce before signing. /// TODO: Add more input vars to enable better checking (preferably removing commitment_tx and /// making the callee generate it via some util function we expose)! - fn sign_remote_commitment(&self, channel_value_satoshis: u64, feerate_per_kw: u64, commitment_tx: &Transaction, keys: &TxCreationKeys, htlcs: &[&HTLCOutputInCommitment], to_self_delay: u16, secp_ctx: &Secp256k1) -> Result<(Signature, Vec), ()>; + fn sign_remote_commitment(&self, channel_value_satoshis: u64, feerate_per_kw: u64, commitment_tx: &Transaction, keys: &TxCreationKeys, htlcs: &[&HTLCOutputInCommitment], to_self_delay: u16, secp_ctx: &Secp256k1) -> Result<(Signature, Vec), ()>; /// Create a signature for a (proposed) closing transaction. /// @@ -158,11 +171,11 @@ pub trait ChannelKeys : Send { /// protocol. fn sign_channel_announcement(&self, msg: &msgs::UnsignedChannelAnnouncement, secp_ctx: &Secp256k1) -> Result; - /// Set the remote funding key. This is done immediately on incoming channels + /// Set the remote channel basepoints. This is done immediately on incoming channels /// and as soon as the channel is accepted on outgoing channels. /// /// Will be called before any signatures are applied. - fn set_remote_funding_pubkey(&mut self, key: &PublicKey); + fn set_remote_channel_pubkeys(&mut self, channel_points: &ChannelPublicKeys); } #[derive(Clone)] @@ -181,7 +194,7 @@ pub struct InMemoryChannelKeys { /// Commitment seed pub commitment_seed: [u8; 32], /// Remote funding pubkey - pub remote_funding_pubkey: Option, + pub remote_channel_pubkeys: Option, } impl ChannelKeys for InMemoryChannelKeys { @@ -192,12 +205,12 @@ impl ChannelKeys for InMemoryChannelKeys { fn htlc_base_key(&self) -> &SecretKey { &self.htlc_base_key } fn commitment_seed(&self) -> &[u8; 32] { &self.commitment_seed } - fn sign_remote_commitment(&self, channel_value_satoshis: u64, feerate_per_kw: u64, commitment_tx: &Transaction, keys: &TxCreationKeys, htlcs: &[&HTLCOutputInCommitment], to_self_delay: u16, secp_ctx: &Secp256k1) -> Result<(Signature, Vec), ()> { + fn sign_remote_commitment(&self, channel_value_satoshis: u64, feerate_per_kw: u64, commitment_tx: &Transaction, keys: &TxCreationKeys, htlcs: &[&HTLCOutputInCommitment], to_self_delay: u16, secp_ctx: &Secp256k1) -> Result<(Signature, Vec), ()> { if commitment_tx.input.len() != 1 { return Err(()); } let funding_pubkey = PublicKey::from_secret_key(secp_ctx, &self.funding_key); - let remote_funding_pubkey = self.remote_funding_pubkey.as_ref().expect("must set remote funding key before signing"); - let channel_funding_redeemscript = make_funding_redeemscript(&funding_pubkey, remote_funding_pubkey); + let remote_channel_pubkeys = self.remote_channel_pubkeys.as_ref().expect("must set remote channel pubkeys before signing"); + let channel_funding_redeemscript = make_funding_redeemscript(&funding_pubkey, &remote_channel_pubkeys.funding_pubkey); let commitment_sighash = hash_to_message!(&bip143::SighashComponents::new(&commitment_tx).sighash_all(&commitment_tx.input[0], &channel_funding_redeemscript, channel_value_satoshis)[..]); let commitment_sig = secp_ctx.sign(&commitment_sighash, &self.funding_key); @@ -236,9 +249,9 @@ impl ChannelKeys for InMemoryChannelKeys { Ok(secp_ctx.sign(&msghash, &self.funding_key)) } - fn set_remote_funding_pubkey(&mut self, key: &PublicKey) { - assert!(self.remote_funding_pubkey.is_none(), "Already set remote funding key"); - self.remote_funding_pubkey = Some(*key); + fn set_remote_channel_pubkeys(&mut self, channel_pubkeys: &ChannelPublicKeys) { + assert!(self.remote_channel_pubkeys.is_none(), "Already set remote channel pubkeys"); + self.remote_channel_pubkeys = Some(channel_pubkeys.clone()); } } @@ -249,7 +262,7 @@ impl_writeable!(InMemoryChannelKeys, 0, { delayed_payment_base_key, htlc_base_key, commitment_seed, - remote_funding_pubkey + remote_channel_pubkeys }); /// Simple KeysInterface implementor that takes a 32-byte seed for use as a BIP 32 extended key @@ -398,7 +411,7 @@ impl KeysInterface for KeysManager { delayed_payment_base_key, htlc_base_key, commitment_seed, - remote_funding_pubkey: None, + remote_channel_pubkeys: None, } }