projects
/
rust-lightning
/ commitdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
| commitdiff |
tree
raw
|
patch
|
inline
| side by side (from parent 1:
181d319
)
Improve documentation for validate_holder_commitment and sign_counterparty_commitment
author
Devrandom
<c1.devrandom@niftybox.net>
Thu, 19 Aug 2021 07:51:45 +0000
(09:51 +0200)
committer
Devrandom
<c1.devrandom@niftybox.net>
Sat, 28 Aug 2021 09:01:15 +0000
(11:01 +0200)
lightning/src/chain/keysinterface.rs
patch
|
blob
|
history
diff --git
a/lightning/src/chain/keysinterface.rs
b/lightning/src/chain/keysinterface.rs
index d912740a019a8a6bb215081c94bd084dde380dc0..ee7d4d65972b544db75e842c8de5de1ec527765a 100644
(file)
--- a/
lightning/src/chain/keysinterface.rs
+++ b/
lightning/src/chain/keysinterface.rs
@@
-216,6
+216,8
@@
pub trait BaseSign {
///
/// This is required in order for the signer to make sure that releasing a commitment
/// secret won't leave us without a broadcastable holder transaction.
///
/// This is required in order for the signer to make sure that releasing a commitment
/// secret won't leave us without a broadcastable holder transaction.
+ /// Policy checks should be implemented in this function, including checking the amount
+ /// sent to us and checking the HTLCs.
fn validate_holder_commitment(&self, holder_tx: &HolderCommitmentTransaction);
/// Gets the holder's channel public keys and basepoints
fn pubkeys(&self) -> &ChannelPublicKeys;
fn validate_holder_commitment(&self, holder_tx: &HolderCommitmentTransaction);
/// Gets the holder's channel public keys and basepoints
fn pubkeys(&self) -> &ChannelPublicKeys;
@@
-227,6
+229,9
@@
pub trait BaseSign {
/// Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
///
/// Note that if signing fails or is rejected, the channel will be force-closed.
/// Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
///
/// Note that if signing fails or is rejected, the channel will be force-closed.
+ ///
+ /// Policy checks should be implemented in this function, including checking the amount
+ /// sent to us and checking the HTLCs.
//
// TODO: Document the things someone using this interface should enforce before signing.
fn sign_counterparty_commitment(&self, commitment_tx: &CommitmentTransaction, secp_ctx: &Secp256k1<secp256k1::All>) -> Result<(Signature, Vec<Signature>), ()>;
//
// TODO: Document the things someone using this interface should enforce before signing.
fn sign_counterparty_commitment(&self, commitment_tx: &CommitmentTransaction, secp_ctx: &Secp256k1<secp256k1::All>) -> Result<(Signature, Vec<Signature>), ()>;