From: Devrandom Date: Thu, 19 Aug 2021 07:51:45 +0000 (+0200) Subject: Improve documentation for validate_holder_commitment and sign_counterparty_commitment X-Git-Tag: v0.0.101~28^2~1 X-Git-Url: http://git.bitcoin.ninja/index.cgi?a=commitdiff_plain;h=a016bb140849701dab896d11215097020cec08ec;p=rust-lightning Improve documentation for validate_holder_commitment and sign_counterparty_commitment --- diff --git a/lightning/src/chain/keysinterface.rs b/lightning/src/chain/keysinterface.rs index d912740a0..ee7d4d659 100644 --- 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. + /// 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; @@ -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. + /// + /// 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) -> Result<(Signature, Vec), ()>;