Skip to content

Commit 869489c

Browse files
committed
f more docs
1 parent 698b393 commit 869489c

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

lightning/src/chain/keysinterface.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -349,9 +349,10 @@ pub trait KeysInterface: Send + Sync {
349349

350350
/// Reads a `ChanKeySigner` for this `KeysInterface` from the given input stream.
351351
/// This is only called during deserialization of other objects which contain
352-
/// `ChannelKeys`-implementing objects (ie `ChannelMonitor`s and `ChannelManager`s) and must
353-
/// read exactly the bytes that `<Self::ChanKeySigner as Writeable>::write()` writes, or return
354-
/// an error.
352+
/// `ChannelKeys`-implementing objects (ie `ChannelMonitor`s and `ChannelManager`s).
353+
/// The bytes are exactly those which `<Self::ChanKeySigner as Writeable>::write()` writes, and
354+
/// contain no versioning scheme. You may wish to include your own version prefix and ensure
355+
/// you've read all of the provided bytes to ensure no corruption occurred.
355356
fn read_chan_signer(&self, reader: &[u8]) -> Result<Self::ChanKeySigner, DecodeError>;
356357
}
357358

0 commit comments

Comments
 (0)