1 use lightning::util::persist::{KVStore, KVSTORE_NAMESPACE_KEY_MAX_LEN, read_channel_monitors};
2 use lightning::ln::functional_test_utils::{connect_block, create_announced_chan_between_nodes,
3 create_chanmon_cfgs, create_dummy_block, create_network, create_node_cfgs, create_node_chanmgrs,
5 use lightning::chain::channelmonitor::CLOSED_CHANNEL_UPDATE_ID;
6 use lightning::util::test_utils;
7 use lightning::{check_closed_broadcast, check_closed_event, check_added_monitors};
8 use lightning::events::ClosureReason;
10 use std::panic::RefUnwindSafe;
12 pub(crate) fn do_read_write_remove_list_persist<K: KVStore + RefUnwindSafe>(kv_store: &K) {
13 let data = [42u8; 32];
15 let namespace = "testspace";
16 let sub_namespace = "testsubspace";
19 // Test the basic KVStore operations.
20 kv_store.write(namespace, sub_namespace, key, &data).unwrap();
22 // Test empty namespace/sub_namespace is allowed, but not empty namespace and non-empty
23 // sub-namespace, and not empty key.
24 kv_store.write("", "", key, &data).unwrap();
25 let res = std::panic::catch_unwind(|| kv_store.write("", sub_namespace, key, &data));
26 assert!(res.is_err());
27 let res = std::panic::catch_unwind(|| kv_store.write(namespace, sub_namespace, "", &data));
28 assert!(res.is_err());
30 let listed_keys = kv_store.list(namespace, sub_namespace).unwrap();
31 assert_eq!(listed_keys.len(), 1);
32 assert_eq!(listed_keys[0], key);
34 let read_data = kv_store.read(namespace, sub_namespace, key).unwrap();
35 assert_eq!(data, &*read_data);
37 kv_store.remove(namespace, sub_namespace, key, false).unwrap();
39 let listed_keys = kv_store.list(namespace, sub_namespace).unwrap();
40 assert_eq!(listed_keys.len(), 0);
42 // Ensure we have no issue operating with namespace/sub_namespace/key being KVSTORE_NAMESPACE_KEY_MAX_LEN
43 let max_chars: String = std::iter::repeat('A').take(KVSTORE_NAMESPACE_KEY_MAX_LEN).collect();
44 kv_store.write(&max_chars, &max_chars, &max_chars, &data).unwrap();
46 let listed_keys = kv_store.list(&max_chars, &max_chars).unwrap();
47 assert_eq!(listed_keys.len(), 1);
48 assert_eq!(listed_keys[0], max_chars);
50 let read_data = kv_store.read(&max_chars, &max_chars, &max_chars).unwrap();
51 assert_eq!(data, &*read_data);
53 kv_store.remove(&max_chars, &max_chars, &max_chars, false).unwrap();
55 let listed_keys = kv_store.list(&max_chars, &max_chars).unwrap();
56 assert_eq!(listed_keys.len(), 0);
59 // Integration-test the given KVStore implementation. Test relaying a few payments and check that
60 // the persisted data is updated the appropriate number of times.
61 pub(crate) fn do_test_store<K: KVStore>(store_0: &K, store_1: &K) {
62 let chanmon_cfgs = create_chanmon_cfgs(2);
63 let mut node_cfgs = create_node_cfgs(2, &chanmon_cfgs);
64 let chain_mon_0 = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[0].chain_source), &chanmon_cfgs[0].tx_broadcaster, &chanmon_cfgs[0].logger, &chanmon_cfgs[0].fee_estimator, store_0, node_cfgs[0].keys_manager);
65 let chain_mon_1 = test_utils::TestChainMonitor::new(Some(&chanmon_cfgs[1].chain_source), &chanmon_cfgs[1].tx_broadcaster, &chanmon_cfgs[1].logger, &chanmon_cfgs[1].fee_estimator, store_1, node_cfgs[1].keys_manager);
66 node_cfgs[0].chain_monitor = chain_mon_0;
67 node_cfgs[1].chain_monitor = chain_mon_1;
68 let node_chanmgrs = create_node_chanmgrs(2, &node_cfgs, &[None, None]);
69 let nodes = create_network(2, &node_cfgs, &node_chanmgrs);
71 // Check that the persisted channel data is empty before any channels are
73 let mut persisted_chan_data_0 = read_channel_monitors(store_0, nodes[0].keys_manager, nodes[0].keys_manager).unwrap();
74 assert_eq!(persisted_chan_data_0.len(), 0);
75 let mut persisted_chan_data_1 = read_channel_monitors(store_1, nodes[1].keys_manager, nodes[1].keys_manager).unwrap();
76 assert_eq!(persisted_chan_data_1.len(), 0);
78 // Helper to make sure the channel is on the expected update ID.
79 macro_rules! check_persisted_data {
80 ($expected_update_id: expr) => {
81 persisted_chan_data_0 = read_channel_monitors(store_0, nodes[0].keys_manager, nodes[0].keys_manager).unwrap();
82 assert_eq!(persisted_chan_data_0.len(), 1);
83 for (_, mon) in persisted_chan_data_0.iter() {
84 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
86 persisted_chan_data_1 = read_channel_monitors(store_1, nodes[1].keys_manager, nodes[1].keys_manager).unwrap();
87 assert_eq!(persisted_chan_data_1.len(), 1);
88 for (_, mon) in persisted_chan_data_1.iter() {
89 assert_eq!(mon.get_latest_update_id(), $expected_update_id);
94 // Create some initial channel and check that a channel was persisted.
95 let _ = create_announced_chan_between_nodes(&nodes, 0, 1);
96 check_persisted_data!(0);
98 // Send a few payments and make sure the monitors are updated to the latest.
99 send_payment(&nodes[0], &vec!(&nodes[1])[..], 8000000);
100 check_persisted_data!(5);
101 send_payment(&nodes[1], &vec!(&nodes[0])[..], 4000000);
102 check_persisted_data!(10);
104 // Force close because cooperative close doesn't result in any persisted
106 nodes[0].node.force_close_broadcasting_latest_txn(&nodes[0].node.list_channels()[0].channel_id, &nodes[1].node.get_our_node_id()).unwrap();
107 check_closed_event!(nodes[0], 1, ClosureReason::HolderForceClosed, [nodes[1].node.get_our_node_id()], 100000);
108 check_closed_broadcast!(nodes[0], true);
109 check_added_monitors!(nodes[0], 1);
111 let node_txn = nodes[0].tx_broadcaster.txn_broadcasted.lock().unwrap();
112 assert_eq!(node_txn.len(), 1);
114 connect_block(&nodes[1], &create_dummy_block(nodes[0].best_block_hash(), 42, vec![node_txn[0].clone(), node_txn[0].clone()]));
115 check_closed_broadcast!(nodes[1], true);
116 check_closed_event!(nodes[1], 1, ClosureReason::CommitmentTxConfirmed, [nodes[0].node.get_our_node_id()], 100000);
117 check_added_monitors!(nodes[1], 1);
119 // Make sure everything is persisted as expected after close.
120 check_persisted_data!(CLOSED_CHANNEL_UPDATE_ID);