/// <BIP 143 signature> <empty vector> (MINIMALIF standard rule) <provided witnessScript>
///
/// Note that the nSequence field in the spending input must be set to to_self_delay
- /// (which means the transaction not being broadcastable until at least to_self_delay
+ /// (which means the transaction is not broadcastable until at least to_self_delay
/// blocks after the outpoint 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).
+ /// it is an output from an old state which we broadcast (which should never happen).
///
- /// WitnessScript may be regenerated by passing the revocation_pubkey, to_self_delay and
- /// delayed_payment_pubkey to chan_utils::get_revokeable_redeemscript.
+ /// To derive the delayed_payment key which is used to sign for this input, you must pass the
+ /// local delayed_payment_base_key (ie the private key which corresponds to the pubkey in
+ /// ChannelKeys::pubkeys().delayed_payment_basepoint) and the provided per_commitment_point to
+ /// chan_utils::derive_private_key. The public key can be generated without the secret key
+ /// using chan_utils::derive_public_key and only the delayed_payment_basepoint which appears in
+ /// ChannelKeys::pubkeys().
///
- /// To derive the delayed_payment key corresponding to the channel state, you must pass the
- /// local delayed_payment_base_key and the provided per_commitment_point to
- /// chan_utils::derive_private_key. The resulting key should be used to sign the spending
- /// transaction.
- ///
- /// To derive the revocation_pubkey corresponding to the channel state, you must pass the
- /// remote revocation_basepoint and the provided per_commitment point to
+ /// To derive the revocation_pubkey which is used in the witness script generation, you must
+ /// pass the remote revocation_basepoint (which appears in the call to
+ /// ChannelKeys::set_remote_channel_pubkeys) and the provided per_commitment point to
/// chan_utils::derive_public_revocation_key.
///
- /// Both remote revocation_basepoint and local delayed_payment_base_key should be given
- /// by ChannelKeys, either default implementation (InMemoryChannelKeys) or custom one.
+ /// The witness script which is hashed and included in the output script_pubkey may be
+ /// regenerated by passing the revocation_pubkey (derived as above), our delayed_payment pubkey
+ /// (derived as above), and the to_self_delay contained here to
+ /// chan_utils::get_revokeable_redeemscript.
+ //
+ // TODO: we need to expose utility methods in KeyManager to do all the relevant derivation.
DynamicOutputP2WSH {
/// The outpoint which is spendable
outpoint: OutPoint,
/// The remote_revocation_pubkey used to derive witnessScript
remote_revocation_pubkey: PublicKey
},
- /// An output to a P2WPKH, spendable exclusively by our payment key.
+ /// An output to a P2WPKH, spendable exclusively by our payment key (ie the private key which
+ /// corresponds to the public key in ChannelKeys::pubkeys().payment_point).
/// The witness in the spending input, is, thus, simply:
/// <BIP 143 signature> <payment key>
///
/// return value must contain a signature.
fn sign_local_commitment_htlc_transactions<T: secp256k1::Signing + secp256k1::Verification>(&self, local_commitment_tx: &LocalCommitmentTransaction, local_csv: u16, secp_ctx: &Secp256k1<T>) -> Result<Vec<Option<Signature>>, ()>;
- /// Create a signature for a transaction spending an HTLC or commitment transaction output
- /// when our counterparty broadcast an old state.
+ /// Create a signature for the given input in a transaction spending an HTLC or commitment
+ /// transaction output when our counterparty broadcast an old state.
///
- /// Justice transaction may claim multiples outputs at same time if timelock are similar.
+ /// A justice transaction may claim multiples outputs at same time if timelock are similar,
+ /// but only a signature for the input at index `input` should be signed for here.
/// It may be called multiples time for same output(s) if a fee-bump is needed with regards
/// to an upcoming timelock expiration.
///
- /// Input index is a pointer towards outpoint spent, commited by sigs (BIP 143).
+ /// Amount is value of the output spent by this input, committed to in the BIP 143 signature.
///
- /// Amount is value of the output spent by this input, committed by sigs (BIP 143).
+ /// per_commitment_key is revocation secret which was provided by our counterparty when they
+ /// revoked the state which they eventually broadcast. It's not a _local_ secret key and does
+ /// not allow the spending of any funds by itself (you need our local revocation_secret to do
+ /// so).
///
- /// Per_commitment key is revocation secret such as provided by remote party while
- /// revocating detected onchain transaction. It's not a _local_ secret key, therefore
- /// it may cross interfaces, a node compromise won't allow to spend revoked output without
- /// also compromissing revocation key.
+ /// htlc holds HTLC elements (hash, timelock) if the output being spent is a HTLC output, thus
+ /// changing the format of the witness script (which is committed to in the BIP 143
+ /// signatures).
///
- /// htlc holds HTLC elements (hash, timelock) if output spent is a HTLC one, committed as
- /// part of witnessScript by sigs (BIP 143).
- ///
- /// on_remote_tx_csv is the relative lock-time challenge if output spent is on remote
- /// balance or 2nd-stage HTLC transactions, committed as part of witnessScript by sigs
- /// (BIP 143).
+ /// on_remote_tx_csv is the relative lock-time that that our counterparty would have to set on
+ /// their transaction were they to spend the same output. It is included in the witness script
+ /// and thus committed to in the BIP 143 signature.
fn sign_justice_transaction<T: secp256k1::Signing + secp256k1::Verification>(&self, justice_tx: &Transaction, input: usize, amount: u64, per_commitment_key: &SecretKey, htlc: &Option<HTLCOutputInCommitment>, on_remote_tx_csv: u16, secp_ctx: &Secp256k1<T>) -> Result<Signature, ()>;
/// Create a signature for a claiming transaction for a HTLC output on a remote commitment
/// transaction, either offered or received.
///
- /// HTLC transaction may claim multiples offered outputs at same time if we know preimage
- /// for each at detection. It may be called multtiples time for same output(s) if a fee-bump
- /// is needed with regards to an upcoming timelock expiration.
+ /// Such a transaction may claim multiples offered outputs at same time if we know the preimage
+ /// for each when we create it, but only the input at index `input` should be signed for here.
+ /// It may be called multiple time for same output(s) if a fee-bump is needed with regards to
+ /// an upcoming timelock expiration.
///
/// Witness_script is either a offered or received script as defined in BOLT3 for HTLC
/// outputs.
///
- /// Input index is a pointer towards outpoint spent, commited by sigs (BIP 143).
- ///
- /// Amount is value of the output spent by this input, committed by sigs (BIP 143).
+ /// Amount is value of the output spent by this input, committed to in the BIP 143 signature.
///
/// Per_commitment_point is the dynamic point corresponding to the channel state
- /// detected onchain. It has been generated by remote party and is used to derive
- /// channel state keys, committed as part of witnessScript by sigs (BIP 143).
+ /// detected onchain. It has been generated by our counterparty and is used to derive
+ /// channel state keys, which are then included in the witness script and committed to in the
+ /// BIP 143 signature.
fn sign_remote_htlc_transaction<T: secp256k1::Signing + secp256k1::Verification>(&self, htlc_tx: &Transaction, input: usize, amount: u64, per_commitment_point: &PublicKey, htlc: &HTLCOutputInCommitment, secp_ctx: &Secp256k1<T>) -> Result<Signature, ()>;
/// Create a signature for a (proposed) closing transaction.
projects / rust-lightning / blobdiff