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