Remove check which makes us sometimes never send closing_signed
[rust-lightning] / src / ln / channelmanager.rs
index 16980b3a00ed6610ab168d3373f1fb5e9e9c3340..fc8af4ccaf25c89148dc6ff05f608cd3ba462373 100644 (file)
@@ -1205,11 +1205,7 @@ impl ChannelManager {
                        }
                }
 
-               let session_priv = SecretKey::from_slice(&self.secp_ctx, &{
-                       let mut session_key = [0; 32];
-                       rng::fill_bytes(&mut session_key);
-                       session_key
-               }).expect("RNG is bad!");
+               let session_priv = self.keys_manager.get_session_key();
 
                let cur_height = self.latest_block_height.load(Ordering::Acquire) as u32 + 1;
 
@@ -4925,52 +4921,6 @@ mod tests {
                assert!(nodes[2].node.list_channels().is_empty());
        }
 
-       #[test]
-       fn update_fee_async_shutdown() {
-               // Test update_fee works after shutdown start if messages are delivered out-of-order
-               let nodes = create_network(2);
-               let chan_1 = create_announced_chan_between_nodes(&nodes, 0, 1);
-
-               let starting_feerate = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan_1.2).unwrap().get_feerate();
-               nodes[0].node.update_fee(chan_1.2.clone(), starting_feerate + 20).unwrap();
-               check_added_monitors!(nodes[0], 1);
-               let updates = get_htlc_update_msgs!(nodes[0], nodes[1].node.get_our_node_id());
-               assert!(updates.update_add_htlcs.is_empty());
-               assert!(updates.update_fulfill_htlcs.is_empty());
-               assert!(updates.update_fail_htlcs.is_empty());
-               assert!(updates.update_fail_malformed_htlcs.is_empty());
-               assert!(updates.update_fee.is_some());
-
-               nodes[1].node.close_channel(&chan_1.2).unwrap();
-               let node_1_shutdown = get_event_msg!(nodes[1], MessageSendEvent::SendShutdown, nodes[0].node.get_our_node_id());
-               nodes[0].node.handle_shutdown(&nodes[1].node.get_our_node_id(), &node_1_shutdown).unwrap();
-               // Note that we don't actually test normative behavior here. The spec indicates we could
-               // actually send a closing_signed here, but is kinda unclear and could possibly be amended
-               // to require waiting on the full commitment dance before doing so (see
-               // https://github.com/lightningnetwork/lightning-rfc/issues/499). In any case, to avoid
-               // ambiguity, we should wait until after the full commitment dance to send closing_signed.
-               let node_0_shutdown = get_event_msg!(nodes[0], MessageSendEvent::SendShutdown, nodes[1].node.get_our_node_id());
-
-               nodes[1].node.handle_update_fee(&nodes[0].node.get_our_node_id(), &updates.update_fee.unwrap()).unwrap();
-               nodes[1].node.handle_commitment_signed(&nodes[0].node.get_our_node_id(), &updates.commitment_signed).unwrap();
-               check_added_monitors!(nodes[1], 1);
-               nodes[1].node.handle_shutdown(&nodes[0].node.get_our_node_id(), &node_0_shutdown).unwrap();
-               let node_0_closing_signed = commitment_signed_dance!(nodes[1], nodes[0], (), false, true, true);
-
-               assert!(nodes[1].node.get_and_clear_pending_msg_events().is_empty());
-               nodes[1].node.handle_closing_signed(&nodes[0].node.get_our_node_id(), match node_0_closing_signed.unwrap() {
-                       MessageSendEvent::SendClosingSigned { ref node_id, ref msg } => {
-                               assert_eq!(*node_id, nodes[1].node.get_our_node_id());
-                               msg
-                       },
-                       _ => panic!("Unexpected event"),
-               }).unwrap();
-               let (_, node_1_closing_signed) = get_closing_signed_broadcast!(nodes[1].node, nodes[0].node.get_our_node_id());
-               nodes[0].node.handle_closing_signed(&nodes[1].node.get_our_node_id(), &node_1_closing_signed.unwrap()).unwrap();
-               let (_, node_0_none) = get_closing_signed_broadcast!(nodes[0].node, nodes[1].node.get_our_node_id());
-               assert!(node_0_none.is_none());
-       }
-
        fn do_test_shutdown_rebroadcast(recv_count: u8) {
                // Test that shutdown/closing_signed is re-sent on reconnect with a variable number of
                // messages delivered prior to disconnect
@@ -6319,6 +6269,31 @@ mod tests {
                node_b.node.peer_connected(&node_a.node.get_our_node_id());
                let reestablish_2 = get_chan_reestablish_msgs!(node_b, node_a);
 
+               if send_funding_locked.0 {
+                       // If a expects a funding_locked, it better not think it has received a revoke_and_ack
+                       // from b
+                       for reestablish in reestablish_1.iter() {
+                               assert_eq!(reestablish.next_remote_commitment_number, 0);
+                       }
+               }
+               if send_funding_locked.1 {
+                       // If b expects a funding_locked, it better not think it has received a revoke_and_ack
+                       // from a
+                       for reestablish in reestablish_2.iter() {
+                               assert_eq!(reestablish.next_remote_commitment_number, 0);
+                       }
+               }
+               if send_funding_locked.0 || send_funding_locked.1 {
+                       // If we expect any funding_locked's, both sides better have set
+                       // next_local_commitment_number to 1
+                       for reestablish in reestablish_1.iter() {
+                               assert_eq!(reestablish.next_local_commitment_number, 1);
+                       }
+                       for reestablish in reestablish_2.iter() {
+                               assert_eq!(reestablish.next_local_commitment_number, 1);
+                       }
+               }
+
                let mut resp_1 = Vec::new();
                for msg in reestablish_1 {
                        node_b.node.handle_channel_reestablish(&node_a.node.get_our_node_id(), &msg).unwrap();
@@ -7645,8 +7620,8 @@ mod tests {
                } else { panic!("Unexpected result"); }
        }
 
-       macro_rules! check_dynamic_output_p2wsh {
-               ($node: expr) => {
+       macro_rules! check_spendable_outputs {
+               ($node: expr, $der_idx: expr) => {
                        {
                                let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
                                let mut txn = Vec::new();
@@ -7655,6 +7630,33 @@ mod tests {
                                                Event::SpendableOutputs { ref outputs } => {
                                                        for outp in outputs {
                                                                match *outp {
+                                                                       SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
+                                                                               let input = TxIn {
+                                                                                       previous_output: outpoint.clone(),
+                                                                                       script_sig: Script::new(),
+                                                                                       sequence: 0,
+                                                                                       witness: Vec::new(),
+                                                                               };
+                                                                               let outp = TxOut {
+                                                                                       script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
+                                                                                       value: output.value,
+                                                                               };
+                                                                               let mut spend_tx = Transaction {
+                                                                                       version: 2,
+                                                                                       lock_time: 0,
+                                                                                       input: vec![input],
+                                                                                       output: vec![outp],
+                                                                               };
+                                                                               let secp_ctx = Secp256k1::new();
+                                                                               let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
+                                                                               let witness_script = Address::p2pkh(&remotepubkey, Network::Testnet).script_pubkey();
+                                                                               let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
+                                                                               let remotesig = secp_ctx.sign(&sighash, key);
+                                                                               spend_tx.input[0].witness.push(remotesig.serialize_der(&secp_ctx).to_vec());
+                                                                               spend_tx.input[0].witness[0].push(SigHashType::All as u8);
+                                                                               spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
+                                                                               txn.push(spend_tx);
+                                                                       },
                                                                        SpendableOutputDescriptor::DynamicOutputP2WSH { ref outpoint, ref key, ref witness_script, ref to_self_delay, ref output } => {
                                                                                let input = TxIn {
                                                                                        previous_output: outpoint.clone(),
@@ -7681,29 +7683,8 @@ mod tests {
                                                                                spend_tx.input[0].witness.push(witness_script.clone().into_bytes());
                                                                                txn.push(spend_tx);
                                                                        },
-                                                                       _ => panic!("Unexpected event"),
-                                                               }
-                                                       }
-                                               },
-                                               _ => panic!("Unexpected event"),
-                                       };
-                               }
-                               txn
-                       }
-               }
-       }
-
-       macro_rules! check_dynamic_output_p2wpkh {
-               ($node: expr) => {
-                       {
-                               let events = $node.chan_monitor.simple_monitor.get_and_clear_pending_events();
-                               let mut txn = Vec::new();
-                               for event in events {
-                                       match event {
-                                               Event::SpendableOutputs { ref outputs } => {
-                                                       for outp in outputs {
-                                                               match *outp {
-                                                                       SpendableOutputDescriptor::DynamicOutputP2WPKH { ref outpoint, ref key, ref output } => {
+                                                                       SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
+                                                                               let secp_ctx = Secp256k1::new();
                                                                                let input = TxIn {
                                                                                        previous_output: outpoint.clone(),
                                                                                        script_sig: Script::new(),
@@ -7718,19 +7699,28 @@ mod tests {
                                                                                        version: 2,
                                                                                        lock_time: 0,
                                                                                        input: vec![input],
-                                                                                       output: vec![outp],
+                                                                                       output: vec![outp.clone()],
                                                                                };
-                                                                               let secp_ctx = Secp256k1::new();
-                                                                               let remotepubkey = PublicKey::from_secret_key(&secp_ctx, &key);
-                                                                               let witness_script = Address::p2pkh(&remotepubkey, Network::Testnet).script_pubkey();
+                                                                               let secret = {
+                                                                                       match ExtendedPrivKey::new_master(&secp_ctx, Network::Testnet, &$node.node_seed) {
+                                                                                               Ok(master_key) => {
+                                                                                                       match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx)) {
+                                                                                                               Ok(key) => key,
+                                                                                                               Err(_) => panic!("Your RNG is busted"),
+                                                                                                       }
+                                                                                               }
+                                                                                               Err(_) => panic!("Your rng is busted"),
+                                                                                       }
+                                                                               };
+                                                                               let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
+                                                                               let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
                                                                                let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
-                                                                               let remotesig = secp_ctx.sign(&sighash, key);
-                                                                               spend_tx.input[0].witness.push(remotesig.serialize_der(&secp_ctx).to_vec());
+                                                                               let sig = secp_ctx.sign(&sighash, &secret.secret_key);
+                                                                               spend_tx.input[0].witness.push(sig.serialize_der(&secp_ctx).to_vec());
                                                                                spend_tx.input[0].witness[0].push(SigHashType::All as u8);
-                                                                               spend_tx.input[0].witness.push(remotepubkey.serialize().to_vec());
+                                                                               spend_tx.input[0].witness.push(pubkey.serialize().to_vec());
                                                                                txn.push(spend_tx);
                                                                        },
-                                                                       _ => panic!("Unexpected event"),
                                                                }
                                                        }
                                                },
@@ -7742,57 +7732,6 @@ mod tests {
                }
        }
 
-       macro_rules! check_static_output {
-               ($event: expr, $node: expr, $event_idx: expr, $output_idx: expr, $der_idx: expr, $idx_node: expr) => {
-                       match $event[$event_idx] {
-                               Event::SpendableOutputs { ref outputs } => {
-                                       match outputs[$output_idx] {
-                                               SpendableOutputDescriptor::StaticOutput { ref outpoint, ref output } => {
-                                                       let secp_ctx = Secp256k1::new();
-                                                       let input = TxIn {
-                                                               previous_output: outpoint.clone(),
-                                                               script_sig: Script::new(),
-                                                               sequence: 0,
-                                                               witness: Vec::new(),
-                                                       };
-                                                       let outp = TxOut {
-                                                               script_pubkey: Builder::new().push_opcode(opcodes::All::OP_RETURN).into_script(),
-                                                               value: output.value,
-                                                       };
-                                                       let mut spend_tx = Transaction {
-                                                               version: 2,
-                                                               lock_time: 0,
-                                                               input: vec![input],
-                                                               output: vec![outp.clone()],
-                                                       };
-                                                       let secret = {
-                                                               match ExtendedPrivKey::new_master(&secp_ctx, Network::Testnet, &$node[$idx_node].node_seed) {
-                                                                       Ok(master_key) => {
-                                                                               match master_key.ckd_priv(&secp_ctx, ChildNumber::from_hardened_idx($der_idx)) {
-                                                                                       Ok(key) => key,
-                                                                                       Err(_) => panic!("Your RNG is busted"),
-                                                                               }
-                                                                       }
-                                                                       Err(_) => panic!("Your rng is busted"),
-                                                               }
-                                                       };
-                                                       let pubkey = ExtendedPubKey::from_private(&secp_ctx, &secret).public_key;
-                                                       let witness_script = Address::p2pkh(&pubkey, Network::Testnet).script_pubkey();
-                                                       let sighash = Message::from_slice(&bip143::SighashComponents::new(&spend_tx).sighash_all(&spend_tx.input[0], &witness_script, output.value)[..]).unwrap();
-                                                       let sig = secp_ctx.sign(&sighash, &secret.secret_key);
-                                                       spend_tx.input[0].witness.push(sig.serialize_der(&secp_ctx).to_vec());
-                                                       spend_tx.input[0].witness[0].push(SigHashType::All as u8);
-                                                       spend_tx.input[0].witness.push(pubkey.serialize().to_vec());
-                                                       spend_tx
-                                               },
-                                               _ => panic!("Unexpected event !"),
-                                       }
-                               },
-                               _ => panic!("Unexpected event !"),
-                       };
-               }
-       }
-
        #[test]
        fn test_claim_sizeable_push_msat() {
                // Incidentally test SpendableOutput event generation due to detection of to_local output on commitment tx
@@ -7812,14 +7751,14 @@ mod tests {
 
                let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
                nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![node_txn[0].clone()] }, 0);
-               let spend_txn = check_dynamic_output_p2wsh!(nodes[1]);
+               let spend_txn = check_spendable_outputs!(nodes[1], 1);
                assert_eq!(spend_txn.len(), 1);
                check_spends!(spend_txn[0], node_txn[0].clone());
        }
 
        #[test]
        fn test_claim_on_remote_sizeable_push_msat() {
-               // Same test as precedent, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
+               // Same test as previous, just test on remote commitment tx, as per_commitment_point registration changes following you're funder/fundee and
                // to_remote output is encumbered by a P2WPKH
 
                let nodes = create_network(2);
@@ -7843,12 +7782,42 @@ mod tests {
                        MessageSendEvent::BroadcastChannelUpdate { .. } => {},
                        _ => panic!("Unexpected event"),
                }
-               let spend_txn = check_dynamic_output_p2wpkh!(nodes[1]);
+               let spend_txn = check_spendable_outputs!(nodes[1], 1);
                assert_eq!(spend_txn.len(), 2);
                assert_eq!(spend_txn[0], spend_txn[1]);
                check_spends!(spend_txn[0], node_txn[0].clone());
        }
 
+       #[test]
+       fn test_claim_on_remote_revoked_sizeable_push_msat() {
+               // Same test as previous, just test on remote revoked commitment tx, as per_commitment_point registration changes following you're funder/fundee and
+               // to_remote output is encumbered by a P2WPKH
+
+               let nodes = create_network(2);
+
+               let chan = create_announced_chan_between_nodes_with_value(&nodes, 0, 1, 100000, 59000000);
+               let payment_preimage = route_payment(&nodes[0], &vec!(&nodes[1])[..], 3000000).0;
+               let revoked_local_txn = nodes[0].node.channel_state.lock().unwrap().by_id.get(&chan.2).unwrap().last_local_commitment_txn.clone();
+               assert_eq!(revoked_local_txn[0].input.len(), 1);
+               assert_eq!(revoked_local_txn[0].input[0].previous_output.txid, chan.3.txid());
+
+               claim_payment(&nodes[0], &vec!(&nodes[1])[..], payment_preimage);
+               let  header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
+               nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![revoked_local_txn[0].clone()] }, 1);
+               let events = nodes[1].node.get_and_clear_pending_msg_events();
+               match events[0] {
+                       MessageSendEvent::BroadcastChannelUpdate { .. } => {},
+                       _ => panic!("Unexpected event"),
+               }
+               let node_txn = nodes[1].tx_broadcaster.txn_broadcasted.lock().unwrap();
+               let spend_txn = check_spendable_outputs!(nodes[1], 1);
+               assert_eq!(spend_txn.len(), 4);
+               assert_eq!(spend_txn[0], spend_txn[2]); // to_remote output on revoked remote commitment_tx
+               check_spends!(spend_txn[0], revoked_local_txn[0].clone());
+               assert_eq!(spend_txn[1], spend_txn[3]); // to_local output on local commitment tx
+               check_spends!(spend_txn[1], node_txn[0].clone());
+       }
+
        #[test]
        fn test_static_spendable_outputs_preimage_tx() {
                let nodes = create_network(2);
@@ -7884,9 +7853,10 @@ mod tests {
                assert_eq!(node_txn[0].input[0].witness.last().unwrap().len(), 133);
                check_spends!(node_txn[1], chan_1.3.clone());
 
-               let events = nodes[1].chan_monitor.simple_monitor.get_and_clear_pending_events();
-               let spend_tx = check_static_output!(events, nodes, 0, 0, 1, 1);
-               check_spends!(spend_tx, node_txn[0].clone());
+               let spend_txn = check_spendable_outputs!(nodes[1], 1); // , 0, 0, 1, 1);
+               assert_eq!(spend_txn.len(), 2);
+               assert_eq!(spend_txn[0], spend_txn[1]);
+               check_spends!(spend_txn[0], node_txn[0].clone());
        }
 
        #[test]
@@ -7916,9 +7886,10 @@ mod tests {
                assert_eq!(node_txn[0].input.len(), 2);
                check_spends!(node_txn[0], revoked_local_txn[0].clone());
 
-               let events = nodes[1].chan_monitor.simple_monitor.get_and_clear_pending_events();
-               let spend_tx = check_static_output!(events, nodes, 0, 0, 1, 1);
-               check_spends!(spend_tx, node_txn[0].clone());
+               let spend_txn = check_spendable_outputs!(nodes[1], 1);
+               assert_eq!(spend_txn.len(), 2);
+               assert_eq!(spend_txn[0], spend_txn[1]);
+               check_spends!(spend_txn[0], node_txn[0].clone());
        }
 
        #[test]
@@ -7962,10 +7933,12 @@ mod tests {
                assert_eq!(node_txn[3].input.len(), 1);
                check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
 
-               let events = nodes[1].chan_monitor.simple_monitor.get_and_clear_pending_events();
                // Check B's ChannelMonitor was able to generate the right spendable output descriptor
-               let spend_tx = check_static_output!(events, nodes, 1, 1, 1, 1);
-               check_spends!(spend_tx, node_txn[3].clone());
+               let spend_txn = check_spendable_outputs!(nodes[1], 1);
+               assert_eq!(spend_txn.len(), 3);
+               assert_eq!(spend_txn[0], spend_txn[1]);
+               check_spends!(spend_txn[0], node_txn[0].clone());
+               check_spends!(spend_txn[2], node_txn[3].clone());
        }
 
        #[test]
@@ -8010,10 +7983,14 @@ mod tests {
                assert_eq!(node_txn[3].input.len(), 1);
                check_spends!(node_txn[3], revoked_htlc_txn[0].clone());
 
-               let events = nodes[0].chan_monitor.simple_monitor.get_and_clear_pending_events();
                // Check A's ChannelMonitor was able to generate the right spendable output descriptor
-               let spend_tx = check_static_output!(events, nodes, 1, 2, 1, 0);
-               check_spends!(spend_tx, node_txn[3].clone());
+               let spend_txn = check_spendable_outputs!(nodes[0], 1);
+               assert_eq!(spend_txn.len(), 5);
+               assert_eq!(spend_txn[0], spend_txn[2]);
+               assert_eq!(spend_txn[1], spend_txn[3]);
+               check_spends!(spend_txn[0], revoked_local_txn[0].clone()); // spending to_remote output from revoked local tx
+               check_spends!(spend_txn[1], node_txn[2].clone()); // spending justice tx output from revoked local tx htlc received output
+               check_spends!(spend_txn[4], node_txn[3].clone()); // spending justice tx output on htlc success tx
        }
 
        #[test]
@@ -8048,7 +8025,7 @@ mod tests {
                check_spends!(node_txn[0], local_txn[0].clone());
 
                // Verify that B is able to spend its own HTLC-Success tx thanks to spendable output event given back by its ChannelMonitor
-               let spend_txn = check_dynamic_output_p2wsh!(nodes[1]);
+               let spend_txn = check_spendable_outputs!(nodes[1], 1);
                assert_eq!(spend_txn.len(), 1);
                check_spends!(spend_txn[0], node_txn[0].clone());
        }
@@ -8079,7 +8056,7 @@ mod tests {
                check_spends!(node_txn[0], local_txn[0].clone());
 
                // Verify that A is able to spend its own HTLC-Timeout tx thanks to spendable output event given back by its ChannelMonitor
-               let spend_txn = check_dynamic_output_p2wsh!(nodes[0]);
+               let spend_txn = check_spendable_outputs!(nodes[0], 1);
                assert_eq!(spend_txn.len(), 4);
                assert_eq!(spend_txn[0], spend_txn[2]);
                assert_eq!(spend_txn[1], spend_txn[3]);
@@ -8098,13 +8075,13 @@ mod tests {
 
                let header = BlockHeader { version: 0x20000000, prev_blockhash: Default::default(), merkle_root: Default::default(), time: 42, bits: 42, nonce: 42 };
                nodes[0].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
-               let events = nodes[0].chan_monitor.simple_monitor.get_and_clear_pending_events();
-               let spend_tx = check_static_output!(events, nodes, 0, 0, 2, 0);
-               check_spends!(spend_tx, closing_tx.clone());
+               let spend_txn = check_spendable_outputs!(nodes[0], 2);
+               assert_eq!(spend_txn.len(), 1);
+               check_spends!(spend_txn[0], closing_tx.clone());
 
                nodes[1].chain_monitor.block_connected_with_filtering(&Block { header, txdata: vec![closing_tx.clone()] }, 1);
-               let events = nodes[1].chan_monitor.simple_monitor.get_and_clear_pending_events();
-               let spend_tx = check_static_output!(events, nodes, 0, 0, 2, 1);
-               check_spends!(spend_tx, closing_tx);
+               let spend_txn = check_spendable_outputs!(nodes[1], 2);
+               assert_eq!(spend_txn.len(), 1);
+               check_spends!(spend_txn[0], closing_tx);
        }
 }