]> git.bitcoin.ninja Git - rust-lightning/commitdiff
comments
authorDevrandom <c1.devrandom@niftybox.net>
Thu, 9 Jan 2020 19:39:18 +0000 (11:39 -0800)
committerDevrandom <c1.devrandom@niftybox.net>
Thu, 9 Jan 2020 19:39:18 +0000 (11:39 -0800)
lightning/src/chain/keysinterface.rs
lightning/src/ln/channel.rs

index 53fd9f78b1ce1248878448c4190ee914cbff8022..cc5a9580b4db342d5a69b400fbe50a1e3a2f8a7a 100644 (file)
@@ -139,6 +139,11 @@ pub trait ChannelKeys : Send {
        ///
        /// Note that if signing fails or is rejected, the channel will be force-closed.
        ///
+       /// The commitment_tx follows BIP-69 lexicographical ordering.
+       ///
+       /// The redeem_scripts vector is 1-1 mapped to commitment_tx outputs.  For p2wpkh, the
+       /// redeem script should be empty.
+       ///
        /// TODO: Document the things someone using this interface should enforce before signing.
        /// TODO: Add more input vars to enable better checking (preferably removing commitment_tx and
        /// making the callee generate it via some util function we expose)!
@@ -146,6 +151,8 @@ pub trait ChannelKeys : Send {
 
        /// Create a signature for a (proposed) closing transaction.
        ///
+       /// The closing_tx follows BIP-69 lexicographical ordering.
+       ///
        /// Note that, due to rounding, there may be one "missing" satoshi, and either party may have
        /// chosen to forgo their output as dust.
        fn sign_closing_transaction<T: secp256k1::Signing>(&self, channel_value_satoshis: u64, channel_funding_redeemscript: &Script, closing_tx: &Transaction, secp_ctx: &Secp256k1<T>) -> Result<Signature, ()>;
index d057e04d9d3df500d7fe804a851240ff450cd97e..6b6e52275ff14c6e9752c2a76ceb5a85ea59cfc0 100644 (file)
@@ -927,7 +927,7 @@ impl<ChanSigner: ChannelKeys> Channel<ChanSigner> {
                assert!(value_to_self_msat >= 0);
                // Note that in case they have several just-awaiting-last-RAA fulfills in-progress (ie
                // AwaitingRemoteRevokeToRemove or AwaitingRemovedRemoteRevoke) we may have allowed them to
-               // "violate" their reserve value by couting those against it. Thus, we have to convert
+               // "violate" their reserve value by counting those against it. Thus, we have to convert
                // everything to i64 before subtracting as otherwise we can overflow.
                let value_to_remote_msat: i64 = (self.channel_value_satoshis * 1000) as i64 - (self.value_to_self_msat as i64) - (remote_htlc_total_msat as i64) - value_to_self_msat_offset;
                assert!(value_to_remote_msat >= 0);