mirrors/rust-lightning
1
0
Fork 0
mirror of https://github.com/lightningdevkit/rust-lightning.git synced 2025-02-24 23:08:36 +01:00
Code Issues Projects Releases Packages Wiki Activity

Correct docs on generate_channel_keys

Browse source 
03de0598af 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.
This commit is contained in:
Matt Corallo 2022-12-13 21:41:49 +00:00
parent 6ec23aa7db
commit 20591900a0
1 changed files with 4 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
lightning/src/chain/keysinterface.rs
View file

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