]> git.bitcoin.ninja Git - rust-lightning/commitdiff
Add docs to Metadata::without_keys
authorJeffrey Czyz <jkczyz@gmail.com>
Thu, 18 Jul 2024 22:53:39 +0000 (17:53 -0500)
committerJeffrey Czyz <jkczyz@gmail.com>
Mon, 22 Jul 2024 16:34:03 +0000 (11:34 -0500)
lightning/src/offers/signer.rs

index e161a72379e2499a5b8e683f611686381d5c612b..ca78bc422ebdebca3a001908f34103997066c513 100644 (file)
@@ -106,6 +106,11 @@ impl Metadata {
                }
        }
 
+       /// Indicates that signing keys should not be derived when calling [`derive_from`]. Only
+       /// applicable to state [`Metadata::DerivedSigningPubkey`]; calling this in other states will
+       /// result in no change.
+       ///
+       /// [`derive_from`]: Self::derive_from
        pub fn without_keys(self) -> Self {
                match self {
                        Metadata::Bytes(_) => self,