Skip to content

Commit 2059190

Browse files
committed
Correct docs on generate_channel_keys
03de059 appeared to revert updated docs due to a rebase error. This reverts the docs on `generate_channel_keys` to the state they were in prior to that commit, with one additional doc.
1 parent 6ec23aa commit 2059190

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

lightning/src/chain/keysinterface.rs

+4-2
Original file line numberDiff line numberDiff line change
@@ -473,8 +473,10 @@ pub trait KeysInterface {
473473
/// This method should return a different value each time it is called, to avoid linking
474474
/// on-chain funds across channels as controlled to the same user.
475475
fn get_shutdown_scriptpubkey(&self) -> ShutdownScript;
476-
/// Get a new set of [`Sign`] for per-channel secrets. These MUST be unique even if you
477-
/// restarted with some stale data!
476+
/// Generates a unique `channel_keys_id` that can be used to obtain a [`Self::Signer`] through
477+
/// [`KeysInterface::derive_channel_signer`]. The `user_channel_id` is provided to allow
478+
/// implementations of [`KeysInterface`] to maintain a mapping between it and the generated
479+
/// `channel_keys_id`.
478480
///
479481
/// This method must return a different value each time it is called.
480482
fn generate_channel_keys_id(&self, inbound: bool, channel_value_satoshis: u64, user_channel_id: u128) -> [u8; 32];

0 commit comments

Comments
 (0)