Merge pull request #1556 from danielgranhao/2022-06-improve-docs
authorvalentinewallace <valentinewallace@users.noreply.github.com>
Tue, 21 Jun 2022 19:59:31 +0000 (15:59 -0400)
committerGitHub <noreply@github.com>
Tue, 21 Jun 2022 19:59:31 +0000 (15:59 -0400)
Clarify description of get_node_secret() method

lightning/src/chain/keysinterface.rs

index 33c88cf11e38c672d6394bd3027b89b8664bbf0b..4231d08259abcbe1e4c50550f4b40aa7d7064faa 100644 (file)
@@ -397,7 +397,9 @@ pub trait KeysInterface {
        /// A type which implements Sign which will be returned by get_channel_signer.
        type Signer : Sign;
 
-       /// Get node secret key (aka node_id or network_key) based on the provided [`Recipient`].
+       /// Get node secret key based on the provided [`Recipient`].
+       ///
+       /// The node_id/network_key is the public key that corresponds to this secret key.
        ///
        /// This method must return the same value each time it is called with a given `Recipient`
        /// parameter.