Fetch ChannelMonitor events during test and ensure there are none
[ldk-java] / src / test / java / org / ldk / HumanObjectPeerTest.java
1 package org.ldk;
2
3 import org.bitcoinj.core.*;
4 import org.bitcoinj.core.Transaction;
5 import org.bitcoinj.script.Script;
6 import org.junit.jupiter.api.Test;
7 import org.ldk.batteries.NioPeerHandler;
8 import org.ldk.enums.LDKNetwork;
9 import org.ldk.impl.bindings;
10 import org.ldk.structs.*;
11 import org.ldk.util.TwoTuple;
12
13 import java.io.IOException;
14 import java.lang.ref.WeakReference;
15 import java.net.InetSocketAddress;
16 import java.util.Arrays;
17 import java.util.HashMap;
18 import java.util.LinkedList;
19
20 class HumanObjectPeerTestInstance {
21     private final boolean nice_close;
22     private final boolean use_km_wrapper;
23     private final boolean use_manual_watch;
24     private final boolean reload_peers;
25     private final boolean break_cross_peer_refs;
26     private final boolean use_nio_peer_handler;
27
28     HumanObjectPeerTestInstance(boolean nice_close, boolean use_km_wrapper, boolean use_manual_watch, boolean reload_peers, boolean break_cross_peer_refs, boolean use_nio_peer_handler) {
29         this.nice_close = nice_close;
30         this.use_km_wrapper = use_km_wrapper;
31         this.use_manual_watch = use_manual_watch;
32         this.reload_peers = reload_peers;
33         this.break_cross_peer_refs = break_cross_peer_refs;
34         this.use_nio_peer_handler = use_nio_peer_handler;
35     }
36
37     class Peer {
38         KeysInterface manual_keysif(KeysInterface underlying_if) {
39             return KeysInterface.new_impl(new KeysInterface.KeysInterfaceInterface() {
40                 @Override public byte[] get_node_secret() { return underlying_if.get_node_secret(); }
41                 @Override public byte[] get_destination_script() { return underlying_if.get_destination_script(); }
42                 @Override public byte[] get_shutdown_pubkey() { return underlying_if.get_shutdown_pubkey(); }
43
44                 @Override
45                 public ChannelKeys get_channel_keys(boolean inbound, long channel_value_satoshis) {
46                     ChannelKeys underlying_ck = underlying_if.get_channel_keys(inbound, channel_value_satoshis);
47                     ChannelKeys.ChannelKeysInterface cki = new ChannelKeys.ChannelKeysInterface() {
48                         @Override
49                         public byte[] get_per_commitment_point(long idx) {
50                             return underlying_ck.get_per_commitment_point(idx);
51                         }
52
53                         @Override
54                         public byte[] release_commitment_secret(long idx) {
55                             return underlying_ck.release_commitment_secret(idx);
56                         }
57
58                         @Override
59                         public TwoTuple<Long, Long> key_derivation_params() {
60                             return new TwoTuple<Long, Long>((long)0, (long)1);
61                         }
62
63                         @Override
64                         public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_counterparty_commitment(CommitmentTransaction commitment_tx) {
65                             return underlying_ck.sign_counterparty_commitment(commitment_tx);
66                         }
67
68                         @Override
69                         public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_holder_commitment_and_htlcs(HolderCommitmentTransaction holder_commitment_tx) {
70                             return underlying_ck.sign_holder_commitment_and_htlcs(holder_commitment_tx);
71                         }
72
73                         @Override
74                         public Result_SignatureNoneZ sign_justice_transaction(byte[] justice_tx, long input, long amount, byte[] per_commitment_key, HTLCOutputInCommitment htlc) {
75                             return underlying_ck.sign_justice_transaction(justice_tx, input, amount, per_commitment_key, htlc);
76                         }
77
78                         @Override
79                         public Result_SignatureNoneZ sign_counterparty_htlc_transaction(byte[] htlc_tx, long input, long amount, byte[] per_commitment_point, HTLCOutputInCommitment htlc) {
80                             return underlying_ck.sign_counterparty_htlc_transaction(htlc_tx, input, amount, per_commitment_point, htlc);
81                         }
82
83                         @Override
84                         public Result_SignatureNoneZ sign_closing_transaction(byte[] closing_tx) {
85                             return underlying_ck.sign_closing_transaction(closing_tx);
86                         }
87
88                         @Override
89                         public Result_SignatureNoneZ sign_channel_announcement(UnsignedChannelAnnouncement msg) {
90                             return underlying_ck.sign_channel_announcement(msg);
91                         }
92
93                         @Override
94                         public void ready_channel(ChannelTransactionParameters params) {
95                             underlying_ck.ready_channel(params);
96                         }
97
98                         @Override
99                         public byte[] write() {
100                             return underlying_ck.write();
101                         }
102                     };
103                     ChannelKeys resp = ChannelKeys.new_impl(cki, underlying_ck.get_pubkeys());
104                     must_free_objs.add(new WeakReference<>(cki));
105                     must_free_objs.add(new WeakReference<>(resp));
106                     must_free_objs.add(new WeakReference<>(underlying_ck));
107                     return resp;
108                 }
109
110                 @Override
111                 public byte[] get_secure_random_bytes() {
112                     return underlying_if.get_secure_random_bytes();
113                 }
114
115                 @Override
116                 public Result_ChanKeySignerDecodeErrorZ read_chan_signer(byte[] reader) {
117                     return underlying_if.read_chan_signer(reader);
118                 }
119             });
120         }
121
122         Watch get_manual_watch() {
123             Watch.WatchInterface watch_impl = new Watch.WatchInterface() {
124                 public Result_NoneChannelMonitorUpdateErrZ watch_channel(OutPoint funding_txo, ChannelMonitor monitor) {
125                     synchronized (monitors) {
126                         assert monitors.put(Arrays.toString(funding_txo.get_txid()), monitor) == null;
127                     }
128                     return new Result_NoneChannelMonitorUpdateErrZ.Result_NoneChannelMonitorUpdateErrZ_OK();
129                 }
130
131                 public Result_NoneChannelMonitorUpdateErrZ update_channel(OutPoint funding_txo, ChannelMonitorUpdate update) {
132                     synchronized (monitors) {
133                         String txid = Arrays.toString(funding_txo.get_txid());
134                         assert monitors.containsKey(txid);
135                         Result_NoneMonitorUpdateErrorZ update_res = monitors.get(txid).update_monitor(update, tx_broadcaster, fee_estimator, logger);
136                         assert update_res instanceof Result_NoneMonitorUpdateErrorZ.Result_NoneMonitorUpdateErrorZ_OK;
137                     }
138                     return new Result_NoneChannelMonitorUpdateErrZ.Result_NoneChannelMonitorUpdateErrZ_OK();
139                 }
140
141                 @Override
142                 public MonitorEvent[] release_pending_monitor_events() {
143                     synchronized (monitors) {
144                         assert monitors.size() <= 1;
145                         for (ChannelMonitor mon : monitors.values()) {
146                             return mon.get_and_clear_pending_monitor_events();
147                         }
148                     }
149                     return new MonitorEvent[0];
150                 }
151             };
152             Watch watch = Watch.new_impl(watch_impl);
153             must_free_objs.add(new WeakReference<>(watch_impl));
154             must_free_objs.add(new WeakReference<>(watch));
155             return watch;
156         }
157
158         NioPeerHandler nio_peer_handler;
159         short nio_port;
160         final byte seed;
161         final Logger logger;
162         final FeeEstimator fee_estimator;
163         final BroadcasterInterface tx_broadcaster;
164         final KeysInterface keys_interface;
165         final ChainMonitor chain_monitor;
166         final NetGraphMsgHandler router;
167         final Watch chain_watch;
168         ChannelManager chan_manager;
169         EventsProvider chan_manager_events;
170         PeerManager peer_manager;
171         final HashMap<String, ChannelMonitor> monitors; // Wow I forgot just how terrible Java is - we can't put a byte array here.
172         byte[] node_id;
173         final LinkedList<byte[]> broadcast_set = new LinkedList<>();
174
175         private TwoTuple<OutPoint, byte[]> test_mon_roundtrip(ChannelMonitor mon) {
176             // Because get_funding_txo() returns an OutPoint in a tuple that is a reference to an OutPoint inside the
177             // ChannelMonitor, its a good test to ensure that the OutPoint isn't freed (or is cloned) before the
178             // ChannelMonitor is. This used to be broken.
179             Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ roundtrip_monitor = UtilMethods.constructor_BlockHashChannelMonitorZ_read(mon.write(), keys_interface);
180             assert roundtrip_monitor instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
181             TwoTuple<OutPoint, byte[]> funding_txo = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_monitor).res.b.get_funding_txo();
182             System.gc(); System.runFinalization(); // Give the GC a chance to run.
183             return funding_txo;
184         }
185
186         private Peer(Object _dummy, byte seed) {
187             logger = Logger.new_impl((String arg) -> System.out.println(seed + ": " + arg));
188             fee_estimator = FeeEstimator.new_impl((confirmation_target -> 253));
189             tx_broadcaster = BroadcasterInterface.new_impl(tx -> {
190                 broadcast_set.add(tx);
191             });
192             monitors = new HashMap<>();
193             this.seed = seed;
194             Persist persister = Persist.new_impl(new Persist.PersistInterface() {
195                 @Override
196                 public Result_NoneChannelMonitorUpdateErrZ persist_new_channel(OutPoint id, ChannelMonitor data) {
197                     synchronized (monitors) {
198                         String key = Arrays.toString(id.to_channel_id());
199                         assert monitors.put(key, data) == null;
200                         TwoTuple<OutPoint, byte[]> res = test_mon_roundtrip(data);
201                         assert Arrays.equals(res.a.get_txid(), id.get_txid());
202                         assert res.a.get_index() == id.get_index();
203                     }
204                     return new Result_NoneChannelMonitorUpdateErrZ.Result_NoneChannelMonitorUpdateErrZ_OK();
205                 }
206
207                 @Override
208                 public Result_NoneChannelMonitorUpdateErrZ update_persisted_channel(OutPoint id, ChannelMonitorUpdate update, ChannelMonitor data) {
209                     synchronized (monitors) {
210                         String key = Arrays.toString(id.to_channel_id());
211                         assert monitors.put(key, data) != null;
212                         TwoTuple<OutPoint, byte[]> res = test_mon_roundtrip(data);
213                         assert Arrays.equals(res.a.get_txid(), id.get_txid());
214                         assert res.a.get_index() == id.get_index();
215                     }
216                     return new Result_NoneChannelMonitorUpdateErrZ.Result_NoneChannelMonitorUpdateErrZ_OK();
217                 }
218             });
219             if (use_manual_watch) {
220                 chain_watch = get_manual_watch();
221                 chain_monitor = null;
222             } else {
223                 chain_monitor = ChainMonitor.constructor_new(null, tx_broadcaster, logger, fee_estimator, persister);
224                 chain_watch = chain_monitor.as_Watch();
225             }
226
227             byte[] key_seed = new byte[32];
228             for (byte i = 0; i < 32; i++) {
229                 key_seed[i] = (byte) (i ^ seed);
230             }
231             KeysManager keys = KeysManager.constructor_new(key_seed, LDKNetwork.LDKNetwork_Bitcoin, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000));
232             if (use_km_wrapper) {
233                 this.keys_interface = manual_keysif(keys.as_KeysInterface());
234             } else {
235                 this.keys_interface = keys.as_KeysInterface();
236             }
237             this.router = NetGraphMsgHandler.constructor_new(new byte[32], null, logger);
238         }
239         private void bind_nio() {
240             if (!use_nio_peer_handler) return;
241             try { this.nio_peer_handler = new NioPeerHandler(peer_manager); } catch (IOException e) { assert false; }
242             for (short i = 10_000; true; i++) {
243                 try {
244                     nio_peer_handler.bind_listener(new InetSocketAddress("127.0.0.1", i));
245                     nio_port = i;
246                     break;
247                 } catch (IOException e) { assert i < 10_500; }
248             }
249         }
250         Peer(byte seed) {
251             this(null, seed);
252             this.chan_manager = ChannelManager.constructor_new(LDKNetwork.LDKNetwork_Bitcoin, FeeEstimator.new_impl(confirmation_target -> 0), chain_watch, tx_broadcaster, logger, this.keys_interface, UserConfig.constructor_default(), 1);
253             this.node_id = chan_manager.get_our_node_id();
254             this.chan_manager_events = chan_manager.as_EventsProvider();
255
256             byte[] random_data = new byte[32];
257             for (byte i = 0; i < 32; i++) {
258                 random_data[i] = (byte) ((i ^ seed) ^ 0xf0);
259             }
260             this.peer_manager = PeerManager.constructor_new(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger);
261             bind_nio();
262             System.gc();
263         }
264         Object ptr_to;
265         Peer(Peer orig) {
266             this(null, orig.seed);
267             ChannelMonitor[] monitors = new ChannelMonitor[1];
268             synchronized (monitors) {
269                 assert orig.monitors.size() == 1;
270                 monitors[0] = orig.monitors.values().stream().iterator().next();
271                 if (break_cross_peer_refs) {
272                     Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ res = UtilMethods.constructor_BlockHashChannelMonitorZ_read(monitors[0].write(), keys_interface);
273                     assert res instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
274                     monitors[0] = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) res).res.b;
275                 }
276             }
277             byte[] serialized = orig.chan_manager.write();
278             Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ read_res =
279                     UtilMethods.constructor_BlockHashChannelManagerZ_read(serialized, this.keys_interface, this.fee_estimator, this.chain_watch, this.tx_broadcaster, this.logger, UserConfig.constructor_default(), monitors);
280             if (!break_cross_peer_refs && (use_manual_watch || use_km_wrapper)) {
281                 // When we pass monitors[0] into chain_watch.watch_channel we create a reference from the new Peer to a
282                 // field in the old peer, preventing freeing of the original Peer until the new Peer is freed. Thus, we
283                 // shouldn't bother waiting for the original to be freed later on.
284                 cross_reload_ref_pollution = true;
285             }
286             this.chain_watch.watch_channel(monitors[0].get_funding_txo().a, monitors[0]);
287             assert read_res instanceof Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK;
288             this.chan_manager = ((Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK) read_res).res.b;
289             this.node_id = chan_manager.get_our_node_id();
290             this.chan_manager_events = chan_manager.as_EventsProvider();
291
292             if (cross_reload_ref_pollution) {
293                 // This really, really needs to be handled at the bindings layer, but its rather complicated -
294                 // ChannelSigners can be cloned and passed around without java being involved, resulting in them being
295                 // owned by both one or more ChannelMonitors and a ChannelManager, with only one having proper pointers
296                 // to the ChannelSigner. Ideally, the ChannelSigner would have a global reference to the Java
297                 // implementation class, but that results in circular references. Instead, we need some ability to,
298                 // while cloning ChannelSigners, add new references in the calling Java struct (ie ChannelMonitor) to
299                 // the ChannelSigner.
300                 this.ptr_to = orig.chan_manager;
301             }
302
303             byte[] random_data = new byte[32];
304             for (byte i = 0; i < 32; i++) {
305                 random_data[i] = (byte) ((i ^ seed) ^ 0xf0);
306             }
307             this.peer_manager = PeerManager.constructor_new(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger);
308             bind_nio();
309         }
310
311         TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] connect_block(Block b, int height, long expected_monitor_update_len) {
312             byte[] header = Arrays.copyOfRange(b.bitcoinSerialize(), 0, 80);
313             TwoTuple<Long, byte[]>[] txn;
314             if (b.hasTransactions()) {
315                 assert b.getTransactions().size() == 1;
316                 TwoTuple<Long, byte[]> txp = new TwoTuple<>((long) 1, b.getTransactions().get(0).bitcoinSerialize());
317                 txn = new TwoTuple[]{txp};
318             } else
319                 txn = new TwoTuple[0];
320             chan_manager.block_connected(header, txn, height);
321             if (chain_monitor != null) {
322                 chain_monitor.block_connected(header, txn, height);
323             } else {
324                 synchronized (monitors) {
325                     assert monitors.size() == 1;
326                     for (ChannelMonitor mon : monitors.values()) {
327                         TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] ret = mon.block_connected(header, txn, height, tx_broadcaster, fee_estimator, logger);
328                         assert ret.length == expected_monitor_update_len;
329                         return ret;
330                     }
331                 }
332             }
333             return null;
334         }
335
336         Event[] get_monitor_events() {
337             if (chain_monitor != null) {
338                 return chain_monitor.as_EventsProvider().get_and_clear_pending_events();
339             } else {
340                 synchronized (monitors) {
341                     assert monitors.size() == 1;
342                     for (ChannelMonitor mon : monitors.values()) {
343                         return mon.get_and_clear_pending_events();
344                     }
345                     return null;
346                 }
347             }
348         }
349
350         Route get_route(byte[] dest_node, ChannelDetails[] our_chans) {
351             try (LockedNetworkGraph netgraph = this.router.read_locked_graph()) {
352                 NetworkGraph graph = netgraph.graph();
353                 long res = bindings.get_route(this.node_id, graph._test_only_get_ptr(), dest_node, new long[]{our_chans[0]._test_only_get_ptr()},
354                         new long[0], 1000, 42, this.logger._test_only_get_ptr());
355                 assert bindings.LDKCResult_RouteLightningErrorZ_result_ok(res);
356                 byte[] serialized_route = bindings.Route_write(bindings.LDKCResult_RouteLightningErrorZ_get_ok(res));
357                 must_free_objs.add(new WeakReference<>(serialized_route));
358                 Result_RouteDecodeErrorZ copy = Route.constructor_read(serialized_route);
359                 assert copy instanceof Result_RouteDecodeErrorZ.Result_RouteDecodeErrorZ_OK;
360                 bindings.CResult_RouteLightningErrorZ_free(res);
361                 return ((Result_RouteDecodeErrorZ.Result_RouteDecodeErrorZ_OK) copy).res;
362             }
363         }
364     }
365
366     static class DescriptorHolder { SocketDescriptor val; }
367
368     boolean running = false;
369     final LinkedList<Runnable> runqueue = new LinkedList();
370     boolean ran = false;
371     Thread t = new Thread(() -> {
372             while (true) {
373                 try {
374                     Runnable r;
375                     synchronized (runqueue) {
376                         while (runqueue.isEmpty()) {
377                             runqueue.wait();
378                         }
379                         running = true;
380                         r = runqueue.pollFirst();
381                     }
382                     r.run();
383                     synchronized (runqueue) {
384                         running = false;
385                         runqueue.notifyAll();
386                     }
387                 } catch (InterruptedException e) {
388                     return;
389                 }
390             }
391     });
392     void wait_events_processed(Peer peer1, Peer peer2) {
393         if (use_nio_peer_handler) {
394             peer1.nio_peer_handler.check_events();
395             peer2.nio_peer_handler.check_events();
396             try { Thread.sleep(400); } catch (InterruptedException e) { assert false; }
397         } else {
398             synchronized (runqueue) {
399                 ran = false;
400             }
401             while (true) {
402                 peer1.peer_manager.process_events();
403                 peer2.peer_manager.process_events();
404                 synchronized (runqueue) {
405                     if (runqueue.isEmpty() && !running) {
406                         if (ran) {
407                             ran = false;
408                             continue;
409                         } else { break; }
410                     }
411                     try { runqueue.wait(); } catch (InterruptedException e) { assert false; }
412                 }
413             }
414         }
415     }
416     void do_read_event(PeerManager pm, SocketDescriptor descriptor, byte[] data) {
417         if (!t.isAlive()) t.start();
418         synchronized (runqueue) {
419             ran = true;
420             runqueue.add(() -> {
421                 Result_boolPeerHandleErrorZ res = pm.read_event(descriptor, data);
422                 assert res instanceof Result_boolPeerHandleErrorZ.Result_boolPeerHandleErrorZ_OK;
423             });
424             runqueue.notifyAll();
425         }
426         must_free_objs.add(new WeakReference<>(data));
427     }
428
429     void connect_peers(final Peer peer1, final Peer peer2) {
430         if (use_nio_peer_handler) {
431             try {
432                 peer1.nio_peer_handler.connect(peer2.chan_manager.get_our_node_id(), new InetSocketAddress("127.0.0.1", peer2.nio_port));
433             } catch (IOException e) { assert false; }
434         } else {
435             DescriptorHolder descriptor1 = new DescriptorHolder();
436             DescriptorHolder descriptor1ref = descriptor1;
437             SocketDescriptor descriptor2 = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
438                 @Override
439                 public long send_data(byte[] data, boolean resume_read) {
440                     do_read_event(peer1.peer_manager, descriptor1ref.val, data);
441                     return data.length;
442                 }
443
444                 @Override public void disconnect_socket() { assert false; }
445                 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 2; }
446                 @Override public long hash() { return 2; }
447             });
448
449             descriptor1.val = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
450                 @Override
451                 public long send_data(byte[] data, boolean resume_read) {
452                     do_read_event(peer2.peer_manager, descriptor2, data);
453                     return data.length;
454                 }
455
456                 @Override public void disconnect_socket() { assert false; }
457                 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 1; }
458                 @Override public long hash() { return 1; }
459             });
460
461             Result_CVec_u8ZPeerHandleErrorZ conn_res = peer1.peer_manager.new_outbound_connection(peer2.node_id, descriptor1.val);
462             assert conn_res instanceof Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK;
463
464             Result_NonePeerHandleErrorZ inbound_conn_res = peer2.peer_manager.new_inbound_connection(descriptor2);
465             assert inbound_conn_res instanceof Result_NonePeerHandleErrorZ.Result_NonePeerHandleErrorZ_OK;
466             do_read_event(peer2.peer_manager, descriptor2, ((Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK) conn_res).res);
467         }
468     }
469
470     TestState do_test_message_handler() throws InterruptedException {
471         Peer peer1 = new Peer((byte) 1);
472         Peer peer2 = new Peer((byte) 2);
473
474         connect_peers(peer1, peer2);
475         wait_events_processed(peer1, peer2);
476
477         Result_NoneAPIErrorZ cc_res = peer1.chan_manager.create_channel(peer2.node_id, 10000, 1000, 42, null);
478         assert cc_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
479         wait_events_processed(peer1, peer2);
480
481         Event[] events = peer1.chan_manager_events.get_and_clear_pending_events();
482         assert events.length == 1;
483         assert events[0] instanceof Event.FundingGenerationReady;
484         assert ((Event.FundingGenerationReady) events[0]).channel_value_satoshis == 10000;
485         assert ((Event.FundingGenerationReady) events[0]).user_channel_id == 42;
486         byte[] funding_spk = ((Event.FundingGenerationReady) events[0]).output_script;
487         assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
488         byte[] chan_id = ((Event.FundingGenerationReady) events[0]).temporary_channel_id;
489
490         NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
491
492         Transaction funding = new Transaction(bitcoinj_net);
493         funding.addInput(new TransactionInput(bitcoinj_net, funding, new byte[0]));
494         funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
495         funding.getInput(0).getWitness().setPush(0, new byte[]{0x1});
496         funding.addOutput(Coin.SATOSHI.multiply(10000), new Script(funding_spk));
497         peer1.chan_manager.funding_transaction_generated(chan_id, OutPoint.constructor_new(funding.getTxId().getReversedBytes(), (short) 0));
498         wait_events_processed(peer1, peer2);
499
500         events = peer1.chan_manager_events.get_and_clear_pending_events();
501         assert events.length == 1;
502         assert events[0] instanceof Event.FundingBroadcastSafe;
503         assert ((Event.FundingBroadcastSafe) events[0]).user_channel_id == 42;
504
505         Block b = new Block(bitcoinj_net, 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
506         peer1.connect_block(b, 1, 0);
507         peer2.connect_block(b, 1, 0);
508
509         for (int height = 2; height < 10; height++) {
510             b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[0]));
511             peer1.connect_block(b, height, 0);
512             peer2.connect_block(b, height, 0);
513         }
514         wait_events_processed(peer1, peer2);
515
516         peer1.chan_manager.list_channels();
517         ChannelDetails[] peer1_chans = peer1.chan_manager.list_channels();
518         ChannelDetails[] peer2_chans = peer2.chan_manager.list_channels();
519         assert peer1_chans.length == 1;
520         assert peer2_chans.length == 1;
521         assert peer1_chans[0].get_channel_value_satoshis() == 10000;
522         assert peer1_chans[0].get_is_live();
523         assert Arrays.equals(peer1_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
524         assert Arrays.equals(peer2_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
525
526         byte[] payment_preimage = new byte[32];
527         for (int i = 0; i < 32; i++) payment_preimage[i] = (byte) (i ^ 0x0f);
528         byte[] payment_hash = Sha256Hash.hash(payment_preimage);
529         Route route = peer1.get_route(peer2.node_id, peer1_chans);
530         Result_NonePaymentSendFailureZ payment_res = peer1.chan_manager.send_payment(route, payment_hash, new byte[32]);
531         assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_OK;
532         wait_events_processed(peer1, peer2);
533
534         assert peer1.get_monitor_events().length == 0;
535         assert peer2.get_monitor_events().length == 0;
536
537         if (reload_peers) {
538             if (use_nio_peer_handler) {
539                 peer1.nio_peer_handler.interrupt();
540                 peer2.nio_peer_handler.interrupt();
541             }
542             WeakReference<Peer> op1 = new WeakReference<Peer>(peer1);
543             peer1 = new Peer(peer1);
544             peer2 = new Peer(peer2);
545             return new TestState(op1, peer1, peer2, payment_preimage, b.getHash());
546         }
547         return new TestState(null, peer1, peer2, payment_preimage, b.getHash());
548     }
549
550     boolean cross_reload_ref_pollution = false;
551     class TestState {
552         private final WeakReference<Peer> ref_block;
553         private final Peer peer1;
554         private final Peer peer2;
555         private final byte[] payment_preimage;
556         public Sha256Hash best_blockhash;
557
558         public TestState(WeakReference<Peer> ref_block, Peer peer1, Peer peer2, byte[] payment_preimage, Sha256Hash best_blockhash) {
559             this.ref_block = ref_block;
560             this.peer1 = peer1;
561             this.peer2 = peer2;
562             this.payment_preimage = payment_preimage;
563             this.best_blockhash = best_blockhash;
564         }
565     }
566     void do_test_message_handler_b(TestState state) {
567         GcCheck obj = new GcCheck();
568         if (state.ref_block != null) {
569             // Ensure the original peers get freed before we move on. Note that we have to be in a different function
570             // scope to do so as the (at least current OpenJDK) JRE won't release anything created in the same scope.
571             while (!cross_reload_ref_pollution && state.ref_block.get() != null) {
572                 System.gc();
573                 System.runFinalization();
574             }
575             connect_peers(state.peer1, state.peer2);
576             wait_events_processed(state.peer1, state.peer2);
577         }
578
579         Event[] events = state.peer2.chan_manager_events.get_and_clear_pending_events();
580         assert events.length == 1;
581         assert events[0] instanceof Event.PendingHTLCsForwardable;
582         state.peer2.chan_manager.process_pending_htlc_forwards();
583
584         events = state.peer2.chan_manager_events.get_and_clear_pending_events();
585         assert events.length == 1;
586         assert events[0] instanceof Event.PaymentReceived;
587         state.peer2.chan_manager.claim_funds(state.payment_preimage, new byte[32], ((Event.PaymentReceived) events[0]).amt);
588         wait_events_processed(state.peer1, state.peer2);
589
590         events = state.peer1.chan_manager_events.get_and_clear_pending_events();
591         assert events.length == 1;
592         assert events[0] instanceof Event.PaymentSent;
593         assert Arrays.equals(((Event.PaymentSent) events[0]).payment_preimage, state.payment_preimage);
594         wait_events_processed(state.peer1, state.peer2);
595
596         ChannelDetails[] peer1_chans = state.peer1.chan_manager.list_channels();
597
598         if (nice_close) {
599             Result_NoneAPIErrorZ close_res = state.peer1.chan_manager.close_channel(peer1_chans[0].get_channel_id());
600             assert close_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
601             wait_events_processed(state.peer1, state.peer2);
602
603             assert state.peer1.broadcast_set.size() == 1;
604             assert state.peer2.broadcast_set.size() == 1;
605         } else {
606             state.peer1.chan_manager.force_close_all_channels();
607             wait_events_processed(state.peer1, state.peer2);
608
609             assert state.peer1.broadcast_set.size() == 1;
610             assert state.peer2.broadcast_set.size() == 0;
611
612             NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
613             Transaction tx = new Transaction(bitcoinj_net, state.peer1.broadcast_set.getFirst());
614             Block b = new Block(bitcoinj_net, 2, state.best_blockhash, Sha256Hash.ZERO_HASH, 42, 0, 0,
615                     Arrays.asList(new Transaction[]{tx}));
616             TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] watch_outputs = state.peer2.connect_block(b, 1, 1);
617             if (watch_outputs != null) { // We only process watch_outputs manually when we use a manually-build Watch impl
618                 assert watch_outputs.length == 1;
619                 assert Arrays.equals(watch_outputs[0].a, tx.getTxId().getReversedBytes());
620                 assert watch_outputs[0].b.length == 1;
621             }
622
623             // This used to be buggy and double-free, so go ahead and fetch them!
624             for (ChannelMonitor mon : state.peer2.monitors.values()) {
625                 byte[][] txn = mon.get_latest_holder_commitment_txn(state.peer2.logger);
626             }
627         }
628
629         if (use_nio_peer_handler) {
630             state.peer1.peer_manager.disconnect_by_node_id(state.peer2.chan_manager.get_our_node_id(), false);
631             wait_events_processed(state.peer1, state.peer2);
632             assert state.peer1.peer_manager.get_peer_node_ids().length == 0;
633             assert state.peer2.peer_manager.get_peer_node_ids().length == 0;
634             state.peer1.nio_peer_handler.interrupt();
635             state.peer2.nio_peer_handler.interrupt();
636         }
637
638         assert state.peer1.get_monitor_events().length == 0;
639         assert state.peer2.get_monitor_events().length == 0;
640     }
641
642     java.util.LinkedList<WeakReference<Object>> must_free_objs = new java.util.LinkedList();
643     boolean gc_ran = false;
644     class GcCheck {
645         @Override
646         protected void finalize() throws Throwable {
647             gc_ran = true;
648             super.finalize();
649         }
650     }
651 }
652 public class HumanObjectPeerTest {
653     HumanObjectPeerTestInstance do_test_run(boolean nice_close, boolean use_km_wrapper, boolean use_manual_watch, boolean reload_peers, boolean break_cross_peer_refs, boolean nio_peer_handler) throws InterruptedException {
654         HumanObjectPeerTestInstance instance = new HumanObjectPeerTestInstance(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_peer_refs, nio_peer_handler);
655         HumanObjectPeerTestInstance.TestState state = instance.do_test_message_handler();
656         instance.do_test_message_handler_b(state);
657         return instance;
658     }
659     void do_test(boolean nice_close, boolean use_km_wrapper, boolean use_manual_watch, boolean reload_peers, boolean break_cross_peer_refs, boolean nio_peer_handler) throws InterruptedException {
660         HumanObjectPeerTestInstance instance = do_test_run(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_peer_refs, nio_peer_handler);
661         while (!instance.gc_ran) {
662             System.gc();
663             System.runFinalization();
664         }
665         for (WeakReference<Object> o : instance.must_free_objs)
666             assert o.get() == null;
667     }
668     @Test
669     public void test_message_handler() throws InterruptedException {
670         for (int i = 0; i < (1 << 6) - 1; i++) {
671             boolean nice_close =       (i & (1 << 0)) != 0;
672             boolean use_km_wrapper =   (i & (1 << 1)) != 0;
673             boolean use_manual_watch = (i & (1 << 2)) != 0;
674             boolean reload_peers =     (i & (1 << 3)) != 0;
675             boolean break_cross_refs = (i & (1 << 4)) != 0;
676             boolean nio_peer_handler = (i & (1 << 5)) != 0;
677             if (break_cross_refs && !reload_peers) {
678                 // There are no cross refs to break without reloading peers.
679                 continue;
680             }
681             System.err.println("Running test with flags " + i);
682             do_test(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_refs, nio_peer_handler);
683         }
684     }
685 }