Skip to content

Commit cc7bc39

Browse files
committed
Remove TODOs from documentation in keysinterface
We should never be exposing our own TODOs to the world.
1 parent f7c70cc commit cc7bc39

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

lightning/src/chain/keysinterface.rs

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -184,11 +184,11 @@ pub trait KeysInterface: Send + Sync {
184184
/// Readable/Writable to serialize out a unique reference to this set of keys so
185185
/// that you can serialize the full ChannelManager object.
186186
///
187-
/// (TODO: We shouldn't require that, and should have an API to get them at deser time, due mostly
188-
/// to the possibility of reentrancy issues by calling the user's code during our deserialization
189-
/// routine).
190-
/// TODO: We should remove Clone by instead requesting a new ChannelKeys copy when we create
191-
/// ChannelMonitors instead of expecting to clone the one out of the Channel into the monitors.
187+
// (TODO: We shouldn't require that, and should have an API to get them at deser time, due mostly
188+
// to the possibility of reentrancy issues by calling the user's code during our deserialization
189+
// routine).
190+
// TODO: We should remove Clone by instead requesting a new ChannelKeys copy when we create
191+
// ChannelMonitors instead of expecting to clone the one out of the Channel into the monitors.
192192
pub trait ChannelKeys : Send+Clone {
193193
/// Gets the private key for the anchor tx
194194
fn funding_key<'a>(&'a self) -> &'a SecretKey;
@@ -209,18 +209,18 @@ pub trait ChannelKeys : Send+Clone {
209209
/// Create a signature for a remote commitment transaction and associated HTLC transactions.
210210
///
211211
/// Note that if signing fails or is rejected, the channel will be force-closed.
212-
///
213-
/// TODO: Document the things someone using this interface should enforce before signing.
214-
/// TODO: Add more input vars to enable better checking (preferably removing commitment_tx and
215-
/// making the callee generate it via some util function we expose)!
212+
//
213+
// TODO: Document the things someone using this interface should enforce before signing.
214+
// TODO: Add more input vars to enable better checking (preferably removing commitment_tx and
215+
// making the callee generate it via some util function we expose)!
216216
fn sign_remote_commitment<T: secp256k1::Signing + secp256k1::Verification>(&self, feerate_per_kw: u64, commitment_tx: &Transaction, keys: &TxCreationKeys, htlcs: &[&HTLCOutputInCommitment], to_self_delay: u16, secp_ctx: &Secp256k1<T>) -> Result<(Signature, Vec<Signature>), ()>;
217217

218218
/// Create a signature for a local commitment transaction. This will only ever be called with
219219
/// the same local_commitment_tx (or a copy thereof), though there are currently no guarantees
220220
/// that it will not be called multiple times.
221-
///
222-
/// TODO: Document the things someone using this interface should enforce before signing.
223-
/// TODO: Add more input vars to enable better checking (preferably removing commitment_tx and
221+
//
222+
// TODO: Document the things someone using this interface should enforce before signing.
223+
// TODO: Add more input vars to enable better checking (preferably removing commitment_tx and
224224
fn sign_local_commitment<T: secp256k1::Signing + secp256k1::Verification>(&self, local_commitment_tx: &LocalCommitmentTransaction, secp_ctx: &Secp256k1<T>) -> Result<Signature, ()>;
225225

226226
/// Same as sign_local_commitment, but exists only for tests to get access to local commitment

0 commit comments

Comments
 (0)