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