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