Document better DynamicOutputP2WSH
authorAntoine Riard <ariard@student.42.fr>
Fri, 8 May 2020 21:19:19 +0000 (17:19 -0400)
committerAntoine Riard <ariard@student.42.fr>
Thu, 28 May 2020 08:21:47 +0000 (04:21 -0400)
lightning/src/chain/keysinterface.rs

index b7ef55ca7ec40312e5d868fc8ded33d544f1b662..449327791649f600d78fb155243bc5bf578bffc3 100644 (file)
@@ -64,9 +64,16 @@ pub enum SpendableOutputDescriptor {
        /// delayed_payment_pubkey to chan_utils::get_revokeable_redeemscript.
        ///
        /// To derive the delayed_payment key corresponding to the channel state, you must pass the
-       /// channel's delayed_payment_key and the provided per_commitment_point to
+       /// 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
+       /// 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.
        DynamicOutputP2WSH {
                /// The outpoint which is spendable
                outpoint: OutPoint,