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