test: openchannel lock release after peer goes offline

Author: bitwalt

src/test/mod.rs

@@ -1892,6 +1892,7 @@ mod lock_unlock_changepassword;
 mod multi_hop;
 mod multi_open_close;
 mod open_after_double_send;
+mod openchannel_close_before_funding;
 mod openchannel_fail;
 mod openchannel_optional_addr;
 mod openchannel_push_asset_amount;

src/test/openchannel_close_before_funding.rs

@@ -0,0 +1,105 @@
+use super::*;
+
+const TEST_DIR_BASE: &str = "tmp/openchannel_close_before_funding/";
+
+/// Test that verifies the rgb_send_lock is released after a channel's peer goes
+/// offline, allowing the node to open new channels.
+///
+/// The key fixes tested here:
+/// - Release rgb_send_lock in FundingGenerationReady (after funding_transaction_generated)
+/// - Release rgb_send_lock in ChannelClosed (when channel_funding_txo is None)
+/// - Release rgb_send_lock in ChannelPending before broadcast (send_btc_end)
+///
+/// Without these fixes, the lock remains stuck and the node cannot open new
+/// channels after a peer disconnects during the channel opening process.
+#[serial_test::serial]
+#[tokio::test(flavor = "multi_thread", worker_threads = 1)]
+#[traced_test]
+async fn openchannel_peer_offline_releases_lock() {
+    initialize();
+
+    let test_dir_node1 = format!("{TEST_DIR_BASE}node1");
+    let test_dir_node2 = format!("{TEST_DIR_BASE}node2");
+    let test_dir_node3 = format!("{TEST_DIR_BASE}node3");
+    let (node1_addr, _) = start_node(&test_dir_node1, NODE1_PEER_PORT, false).await;
+    let (node2_addr, _) = start_node(&test_dir_node2, NODE2_PEER_PORT, false).await;
+
+    fund_and_create_utxos(node1_addr, Some(5)).await;
+
+    let node2_pubkey = node_info(node2_addr).await.pubkey;
+
+    // Open a vanilla (non-RGB) channel from node1 to node2
+    let payload = OpenChannelRequest {
+        peer_pubkey_and_opt_addr: format!("{node2_pubkey}@127.0.0.1:{NODE2_PEER_PORT}"),
+        capacity_sat: 100_000,
+        push_msat: 0,
+        asset_amount: None,
+        asset_id: None,
+        push_asset_amount: None,
+        public: true,
+        with_anchors: true,
+        fee_base_msat: None,
+        fee_proportional_millionths: None,
+        temporary_channel_id: None,
+    };
+    let res = reqwest::Client::new()
+        .post(format!("http://{node1_addr}/openchannel"))
+        .json(&payload)
+        .send()
+        .await
+        .unwrap();
+    assert_eq!(res.status(), reqwest::StatusCode::OK);
+
+    // Shut down node2; the channel will fail before confirmation
+    shutdown(&[node2_addr]).await;
+
+    // Start node3 and try to open a new channel from node1
+    let (node3_addr, _) = start_node(&test_dir_node3, NODE3_PEER_PORT, false).await;
+    fund_and_create_utxos(node3_addr, None).await;
+    let node3_pubkey = node_info(node3_addr).await.pubkey;
+
+    // Poll until the rgb_send_lock is released and we can open a new channel.
+    // Without the fixes, this would remain stuck at 403 (OpenChannelInProgress)
+    // because the lock was never released after the first channel's peer went
+    // offline.
+    let t_0 = OffsetDateTime::now_utc();
+    loop {
+        let payload = OpenChannelRequest {
+            peer_pubkey_and_opt_addr: format!("{node3_pubkey}@127.0.0.1:{NODE3_PEER_PORT}"),
+            capacity_sat: 100_000,
+            push_msat: 0,
+            asset_amount: None,
+            asset_id: None,
+            push_asset_amount: None,
+            public: true,
+            with_anchors: true,
+            fee_base_msat: None,
+            fee_proportional_millionths: None,
+            temporary_channel_id: None,
+        };
+        let res = reqwest::Client::new()
+            .post(format!("http://{node1_addr}/openchannel"))
+            .json(&payload)
+            .send()
+            .await
+            .unwrap();
+
+        if res.status() == reqwest::StatusCode::OK {
+            // Lock was released and the new channel open succeeded
+            break;
+        }
+
+        assert_eq!(
+            res.status(),
+            reqwest::StatusCode::FORBIDDEN,
+            "unexpected error status when opening channel to node3"
+        );
+
+        tokio::time::sleep(std::time::Duration::from_secs(1)).await;
+        if (OffsetDateTime::now_utc() - t_0).as_seconds_f32() > 60.0 {
+            panic!("rgb_send_lock remained stuck for 60s after peer shutdown - node cannot open new channels");
+        }
+    }
+
+    shutdown(&[node1_addr, node3_addr]).await;
+}