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>
Tue, 12 May 2020 21:41:33 +0000 (17:41 -0400)
lightning/src/chain/keysinterface.rs

index 6e111980b5e90ba83ecba63d6ee786fb5f39a43c..2dd32bc100b87a03a60e062682e2e4756df40a74 100644 (file)
@@ -66,9 +66,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,