Skip to content

Commit 2f5cdb7

Browse files
committed
reword implementation recommendations
1 parent b661164 commit 2f5cdb7

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

lightning/src/chain/keysinterface.rs

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -201,9 +201,8 @@ pub trait ChannelKeys : Send+Clone {
201201
fn get_per_commitment_point<T: secp256k1::Signing + secp256k1::Verification>(&self, idx: u64, secp_ctx: &Secp256k1<T>) -> PublicKey;
202202
/// Gets the commitment secret for a specific commitment number as part of the revocation process
203203
///
204-
/// An implementation must error here if the commitment was already signed.
205-
/// After this method is called, an implementation must ensure that it will refuse sign the relevant
206-
/// local commitment transaction.
204+
/// An external signer implementation should error here if the commitment was already signed
205+
/// and should refuse to sign it in the future.
207206
///
208207
/// May be called more than once for the same index.
209208
///
@@ -229,7 +228,7 @@ pub trait ChannelKeys : Send+Clone {
229228
/// Create a signature for a local commitment transaction. This will only ever be called with
230229
/// the same local_commitment_tx (or a copy thereof), though there are currently no guarantees
231230
/// that it will not be called multiple times.
232-
/// The commitment must not have been revoked.
231+
/// An external signer implementation should check that the commitment has not been revoked.
233232
//
234233
// TODO: Document the things someone using this interface should enforce before signing.
235234
// TODO: Add more input vars to enable better checking (preferably removing commitment_tx and

0 commit comments

Comments
 (0)