58d707645fec969532c1daab1f2fdd85363d4f2e
[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.ChannelManagerConstructor;
7 import org.ldk.batteries.NioPeerHandler;
8 import org.ldk.enums.AccessError;
9 import org.ldk.enums.Currency;
10 import org.ldk.enums.Level;
11 import org.ldk.enums.Network;
12 import org.ldk.structs.*;
13 import org.ldk.util.TwoTuple;
14
15 import java.io.IOException;
16 import java.lang.ref.WeakReference;
17 import java.net.InetSocketAddress;
18 import java.util.*;
19
20 class HumanObjectPeerTestInstance {
21     private final boolean nice_close;
22     private final boolean use_km_wrapper;
23     private final boolean use_manual_watch;
24     private final boolean reload_peers;
25     private final boolean break_cross_peer_refs;
26     private final boolean use_nio_peer_handler;
27     private final boolean use_filter;
28     private final boolean use_ignore_handler;
29     private final boolean use_chan_manager_constructor;
30     private final boolean use_invoice_payer;
31
32     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, boolean use_ignore_handler, boolean use_chan_manager_constructor, boolean use_invoice_payer) {
33         this.nice_close = nice_close;
34         this.use_km_wrapper = use_km_wrapper;
35         this.use_manual_watch = use_manual_watch;
36         this.reload_peers = reload_peers;
37         this.break_cross_peer_refs = break_cross_peer_refs;
38         this.use_nio_peer_handler = use_nio_peer_handler;
39         this.use_filter = use_filter;
40         this.use_ignore_handler = use_ignore_handler;
41         this.use_chan_manager_constructor = use_chan_manager_constructor;
42         this.use_invoice_payer = use_invoice_payer;
43     }
44
45     class Peer {
46         KeysInterface manual_keysif(KeysInterface underlying_if) {
47             return KeysInterface.new_impl(new KeysInterface.KeysInterfaceInterface() {
48                 @Override public byte[] get_node_secret() { return underlying_if.get_node_secret(); }
49                 @Override public byte[] get_destination_script() { return underlying_if.get_destination_script(); }
50                 @Override public ShutdownScript get_shutdown_scriptpubkey() { return underlying_if.get_shutdown_scriptpubkey(); }
51
52                 @Override
53                 public Sign get_channel_signer(boolean inbound, long channel_value_satoshis) {
54                     Sign underlying_ck = underlying_if.get_channel_signer(inbound, channel_value_satoshis);
55                     BaseSign underlying_base = underlying_ck.get_base_sign();
56                     BaseSign.BaseSignInterface bsi = new BaseSign.BaseSignInterface() {
57                         @Override public byte[] get_per_commitment_point(long idx) {
58                             return underlying_base.get_per_commitment_point(idx);
59                         }
60                         @Override public byte[] release_commitment_secret(long idx) {
61                             return underlying_base.release_commitment_secret(idx);
62                         }
63                         @Override public Result_NoneNoneZ validate_holder_commitment(HolderCommitmentTransaction holder_tx) {
64                             return underlying_base.validate_holder_commitment(holder_tx);
65                         }
66                         @Override public byte[] channel_keys_id() {
67                             return new byte[32];
68                         }
69                         @Override public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_counterparty_commitment(CommitmentTransaction commitment_tx) {
70                             return underlying_base.sign_counterparty_commitment(commitment_tx);
71                         }
72                         @Override public Result_NoneNoneZ validate_counterparty_revocation(long idx, byte[] secret) {
73                             return underlying_base.validate_counterparty_revocation(idx, secret);
74                         }
75                         @Override public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_holder_commitment_and_htlcs(HolderCommitmentTransaction holder_commitment_tx) {
76                             return underlying_base.sign_holder_commitment_and_htlcs(holder_commitment_tx);
77                         }
78                         @Override public Result_SignatureNoneZ sign_justice_revoked_output(byte[] justice_tx, long input, long amount, byte[] per_commitment_key) {
79                             return underlying_base.sign_justice_revoked_output(justice_tx, input, amount, per_commitment_key);
80                         }
81                         @Override public Result_SignatureNoneZ sign_justice_revoked_htlc(byte[] justice_tx, long input, long amount, byte[] per_commitment_key, HTLCOutputInCommitment htlc) {
82                             return underlying_base.sign_justice_revoked_htlc(justice_tx, input, amount, per_commitment_key, htlc);
83                         }
84                         @Override public Result_SignatureNoneZ sign_counterparty_htlc_transaction(byte[] htlc_tx, long input, long amount, byte[] per_commitment_point, HTLCOutputInCommitment htlc) {
85                             return underlying_base.sign_counterparty_htlc_transaction(htlc_tx, input, amount, per_commitment_point, htlc);
86                         }
87                         @Override public Result_SignatureNoneZ sign_closing_transaction(ClosingTransaction closing_tx) {
88                             return underlying_base.sign_closing_transaction(closing_tx);
89                         }
90                         @Override public Result_SignatureNoneZ sign_channel_announcement(UnsignedChannelAnnouncement msg) {
91                             return underlying_base.sign_channel_announcement(msg);
92                         }
93                         @Override public void ready_channel(ChannelTransactionParameters params) {
94                             underlying_base.ready_channel(params);
95                         }
96                     };
97                     Sign.SignInterface si = new Sign.SignInterface() {
98                         @Override
99                         public byte[] write() {
100                             return underlying_ck.write();
101                         }
102                     };
103                     Sign resp = Sign.new_impl(si, bsi, underlying_base.get_pubkeys());
104                     must_free_objs.add(new WeakReference<>(si));
105                     must_free_objs.add(new WeakReference<>(bsi));
106                     must_free_objs.add(new WeakReference<>(resp));
107                     must_free_objs.add(new WeakReference<>(underlying_base));
108                     must_free_objs.add(new WeakReference<>(underlying_ck));
109                     return resp;
110                 }
111
112                 @Override
113                 public byte[] get_secure_random_bytes() {
114                     return underlying_if.get_secure_random_bytes();
115                 }
116
117                 @Override
118                 public Result_SignDecodeErrorZ read_chan_signer(byte[] reader) {
119                     return underlying_if.read_chan_signer(reader);
120                 }
121
122                 @Override
123                 public Result_RecoverableSignatureNoneZ sign_invoice(byte[] invoice_preimage) {
124                     return underlying_if.sign_invoice(invoice_preimage);
125                 }
126             });
127         }
128
129         Watch get_manual_watch() {
130             Watch.WatchInterface watch_impl = new Watch.WatchInterface() {
131                 public Result_NoneChannelMonitorUpdateErrZ watch_channel(OutPoint funding_txo, ChannelMonitor monitor) {
132                     synchronized (monitors) {
133                         assert monitors.put(Arrays.toString(funding_txo.get_txid()), monitor) == null;
134                     }
135                     return Result_NoneChannelMonitorUpdateErrZ.ok();
136                 }
137
138                 public Result_NoneChannelMonitorUpdateErrZ update_channel(OutPoint funding_txo, ChannelMonitorUpdate update) {
139                     synchronized (monitors) {
140                         String txid = Arrays.toString(funding_txo.get_txid());
141                         assert monitors.containsKey(txid);
142                         Result_NoneMonitorUpdateErrorZ update_res = monitors.get(txid).update_monitor(update, tx_broadcaster, fee_estimator, logger);
143                         assert update_res instanceof Result_NoneMonitorUpdateErrorZ.Result_NoneMonitorUpdateErrorZ_OK;
144                     }
145                     return Result_NoneChannelMonitorUpdateErrZ.ok();
146                 }
147
148                 @Override
149                 public MonitorEvent[] release_pending_monitor_events() {
150                     synchronized (monitors) {
151                         assert monitors.size() <= 1;
152                         for (ChannelMonitor mon : monitors.values()) {
153                             return mon.get_and_clear_pending_monitor_events();
154                         }
155                     }
156                     return new MonitorEvent[0];
157                 }
158             };
159             Watch watch = Watch.new_impl(watch_impl);
160             must_free_objs.add(new WeakReference<>(watch_impl));
161             must_free_objs.add(new WeakReference<>(watch));
162             return watch;
163         }
164
165         NioPeerHandler nio_peer_handler;
166         short nio_port;
167         final byte seed;
168         final Logger logger;
169         final FeeEstimator fee_estimator;
170         final BroadcasterInterface tx_broadcaster;
171         final KeysManager explicit_keys_manager;
172         final KeysInterface keys_interface;
173         final ChainMonitor chain_monitor;
174         final NetworkGraph router;
175         NetGraphMsgHandler route_handler;
176         final Watch chain_watch;
177         final HashSet<String> filter_additions;
178         Option_FilterZ filter;
179         ChannelManager chan_manager;
180         PeerManager peer_manager;
181         final HashMap<String, ChannelMonitor> monitors; // Wow I forgot just how terrible Java is - we can't put a byte array here.
182         byte[] node_id;
183         byte[] connected_peer_node_id = null;
184         final LinkedList<byte[]> broadcast_set = new LinkedList<>();
185         final LinkedList<Event> pending_manager_events = new LinkedList<>();
186         private final CustomMessageHandler custom_message_handler;
187         final LinkedList<byte[]> received_custom_messages = new LinkedList<>();
188         final LinkedList<byte[]> custom_messages_to_send = new LinkedList<>();
189         ChannelManagerConstructor constructor = null;
190         InvoicePayer payer = null;
191         GcCheck obj = new GcCheck();
192
193         private ChannelMonitor test_mon_roundtrip(OutPoint expected_id, byte[] data) {
194             // Because get_funding_txo() returns an OutPoint in a tuple that is a reference to an OutPoint inside the
195             // ChannelMonitor, its a good test to ensure that the OutPoint isn't freed (or is cloned) before the
196             // ChannelMonitor is. This used to be broken.
197             Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ roundtrip_monitor = UtilMethods.C2Tuple_BlockHashChannelMonitorZ_read(data, keys_interface);
198             assert roundtrip_monitor instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
199             TwoTuple_OutPointScriptZ funding_txo = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_monitor).res.get_b().get_funding_txo();
200             System.gc(); System.runFinalization(); // Give the GC a chance to run.
201             assert Arrays.equals(funding_txo.get_a().get_txid(), expected_id.get_txid());
202             assert funding_txo.get_a().get_index() == expected_id.get_index();
203             Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ roundtrip_two = UtilMethods.C2Tuple_BlockHashChannelMonitorZ_read(data, keys_interface);
204             assert roundtrip_two instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
205             return ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_two).res.get_b();
206         }
207
208         private Peer(Object _dummy, byte seed) {
209             logger = Logger.new_impl((Record arg)->{
210                 if (arg.get_level() == Level.LDKLevel_Error)
211                     System.err.println(seed + ": " + arg.get_module_path() + " - " + arg.get_args());
212                 else
213                     System.out.println(seed + ": " + arg.get_module_path() + " - " + arg.get_args());
214             });
215             fee_estimator = FeeEstimator.new_impl((confirmation_target -> 253));
216             tx_broadcaster = BroadcasterInterface.new_impl(tx -> {
217                 synchronized (broadcast_set) {
218                     broadcast_set.add(tx);
219                     broadcast_set.notifyAll();
220                 }
221             });
222             monitors = new HashMap<>();
223             this.seed = seed;
224             Persist persister = Persist.new_impl(new Persist.PersistInterface() {
225                 @Override
226                 public Result_NoneChannelMonitorUpdateErrZ persist_new_channel(OutPoint id, ChannelMonitor data, MonitorUpdateId update_id) {
227                     synchronized (monitors) {
228                         String key = Arrays.toString(id.to_channel_id());
229                         ChannelMonitor res = test_mon_roundtrip(id, data.write());
230                         assert monitors.put(key, res) == null;
231                     }
232                     return Result_NoneChannelMonitorUpdateErrZ.ok();
233                 }
234
235                 @Override
236                 public Result_NoneChannelMonitorUpdateErrZ update_persisted_channel(OutPoint id, ChannelMonitorUpdate update, ChannelMonitor data, MonitorUpdateId update_id) {
237                     synchronized (monitors) {
238                         String key = Arrays.toString(id.to_channel_id());
239                         ChannelMonitor res = test_mon_roundtrip(id, data.write());
240                         // Note that we use a serialization-roundtrip copy of data here, not the original, as this can
241                         // expose the JVM JIT bug where it finalize()s things still being called.
242                         assert monitors.put(key, res) != null;
243                     }
244                     return Result_NoneChannelMonitorUpdateErrZ.ok();
245                 }
246             });
247
248             filter_additions = new HashSet<>();
249             if (use_filter) {
250                 this.filter = Option_FilterZ.some(Filter.new_impl(new Filter.FilterInterface() {
251                     @Override public void register_tx(byte[] txid, byte[] script_pubkey) {
252                         filter_additions.add(Arrays.toString(txid));
253                     }
254                     @Override public Option_C2Tuple_usizeTransactionZZ register_output(WatchedOutput output) {
255                         filter_additions.add(Arrays.toString(output.get_outpoint().get_txid()) + ":" + output.get_outpoint().get_index());
256                         return Option_C2Tuple_usizeTransactionZZ.none();
257                     }
258                 }));
259             } else {
260                 this.filter = Option_FilterZ.none();
261             }
262
263             if (use_manual_watch) {
264                 chain_watch = get_manual_watch();
265                 chain_monitor = null;
266             } else {
267                 chain_monitor = ChainMonitor.of(filter, tx_broadcaster, logger, fee_estimator, persister);
268                 chain_watch = chain_monitor.as_Watch();
269             }
270
271             byte[] key_seed = new byte[32];
272             for (byte i = 0; i < 32; i++) {
273                 key_seed[i] = (byte) (i ^ seed);
274             }
275             KeysManager keys = KeysManager.of(key_seed, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000));
276             if (use_km_wrapper) {
277                 this.keys_interface = manual_keysif(keys.as_KeysInterface());
278                 this.explicit_keys_manager = null;
279             } else {
280                 this.keys_interface = keys.as_KeysInterface();
281                 this.explicit_keys_manager = keys;
282             }
283             this.router = NetworkGraph.of(new byte[32]);
284             this.route_handler = NetGraphMsgHandler.of(this.router, Option_AccessZ.some(Access.new_impl(new Access.AccessInterface() {
285                 @Override
286                 public Result_TxOutAccessErrorZ get_utxo(byte[] genesis_hash, long short_channel_id) {
287                     // We don't exchange any gossip, so should never actually get called, but providing a Some(Access)
288                     // is a good test of our Option<Trait> free'ing, which used to be broken and relies on a dirty hack.
289                     assert false;
290                     return Result_TxOutAccessErrorZ.err(AccessError.LDKAccessError_UnknownTx);
291                 }
292             })), logger);
293
294             this.custom_message_handler = CustomMessageHandler.new_impl(new CustomMessageHandler.CustomMessageHandlerInterface() {
295                 @Override
296                 public Result_NoneLightningErrorZ handle_custom_message(Type msg, byte[] sender_node_id) {
297                     synchronized (received_custom_messages) {
298                         received_custom_messages.add(msg.write());
299                         received_custom_messages.notifyAll();
300                     }
301                     return Result_NoneLightningErrorZ.ok();
302                 }
303
304                 @Override
305                 public TwoTuple_PublicKeyTypeZ[] get_and_clear_pending_msg() {
306                     byte[][] bytes;
307                     synchronized (custom_messages_to_send) {
308                         bytes = custom_messages_to_send.toArray(new byte[0][0]);
309                         custom_messages_to_send.clear();
310                     }
311                     TwoTuple_PublicKeyTypeZ[] ret = new TwoTuple_PublicKeyTypeZ[bytes.length];
312                     for (int i = 0; i < bytes.length; i++) {
313                         final int msg_idx = i;
314                         ret[i] = TwoTuple_PublicKeyTypeZ.of(connected_peer_node_id, Type.new_impl(new Type.TypeInterface() {
315                             @Override public short type_id() { return 4096; }
316                             @Override public String debug_str() { return "Custom Java Message"; }
317                             @Override public byte[] write() { return bytes[msg_idx]; }
318                         }));
319                     }
320                     return ret;
321                 }
322             }, (message_type, buffer) -> {
323                 assert message_type == 4096;
324                 return Result_COption_TypeZDecodeErrorZ.ok(Option_TypeZ.some(Type.new_impl(new Type.TypeInterface() {
325                     @Override public short type_id() { return 4096; }
326                     @Override public String debug_str() { return "Custom Java-Decoded Message"; }
327                     @Override public byte[] write() { return buffer; }
328                 })));
329             });
330         }
331         private void bind_nio() {
332             if (!use_nio_peer_handler) return;
333             if (use_chan_manager_constructor) {
334                 this.nio_peer_handler = this.constructor.nio_peer_handler;
335             } else {
336                 try { this.nio_peer_handler = new NioPeerHandler(peer_manager); } catch (IOException e) { assert false; }
337             }
338             for (short i = 10_000; true; i++) {
339                 try {
340                     nio_peer_handler.bind_listener(new InetSocketAddress("127.0.0.1", i));
341                     nio_port = i;
342                     break;
343                 } catch (IOException e) { assert i < 10_500; }
344             }
345         }
346         Peer(byte seed) {
347             this(null, seed);
348             if (use_chan_manager_constructor) {
349                 if (use_ignore_handler) {
350                     this.constructor = new ChannelManagerConstructor(Network.LDKNetwork_Bitcoin, UserConfig.with_default(), new byte[32], 0,
351                                                         this.keys_interface, this.fee_estimator, this.chain_monitor, null, this.tx_broadcaster, this.logger);
352                 } else {
353                     this.constructor = new ChannelManagerConstructor(Network.LDKNetwork_Bitcoin, UserConfig.with_default(), new byte[32], 0,
354                                                         this.keys_interface, this.fee_estimator, this.chain_monitor, this.router, this.tx_broadcaster, this.logger);
355                 }
356                 LockableScore scorer = null;
357                 if (use_invoice_payer) { scorer = LockableScore.of(Scorer.with_default().as_Score()); }
358                 constructor.chain_sync_completed(new ChannelManagerConstructor.EventHandler() {
359                     @Override public void handle_event(Event event) {
360                         synchronized (pending_manager_events) {
361                             pending_manager_events.add(event);
362                             pending_manager_events.notifyAll();
363                         }
364                     }
365                     @Override public void persist_manager(byte[] channel_manager_bytes) { assert channel_manager_bytes.length > 1; }
366                 }, scorer);
367                 this.chan_manager = constructor.channel_manager;
368                 this.peer_manager = constructor.peer_manager;
369                 this.payer = constructor.payer;
370                 must_free_objs.add(new WeakReference<>(this.chan_manager));
371             } else {
372                 ChainParameters params = ChainParameters.of(Network.LDKNetwork_Bitcoin, BestBlock.of(new byte[32], 0));
373                 this.chan_manager = ChannelManager.of(this.fee_estimator, chain_watch, tx_broadcaster, logger, this.keys_interface, UserConfig.with_default(), params);
374                 byte[] random_data = keys_interface.get_secure_random_bytes();
375                 this.peer_manager = PeerManager.of(chan_manager.as_ChannelMessageHandler(), route_handler.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger, this.custom_message_handler);
376                 if (use_invoice_payer) {
377                     this.payer = InvoicePayer.of(this.chan_manager.as_Payer(), Router.new_impl(new Router.RouterInterface() {
378                         @Override
379                         public Result_RouteLightningErrorZ find_route(byte[] payer, RouteParameters params, ChannelDetails[] first_hops, Score scorer) {
380                             return UtilMethods.find_route(payer, params, router, first_hops, logger, scorer);
381                         }
382                     }), LockableScore.of(Score.new_impl(new Score.ScoreInterface() {
383                         @Override public void payment_path_failed(RouteHop[] path, long scid) {}
384                         @Override public long channel_penalty_msat(long scid, NodeId src, NodeId dst) { return 0; }
385                         @Override public byte[] write() { assert false; return null; }
386                     })), logger, EventHandler.new_impl(new EventHandler.EventHandlerInterface() {
387                         @Override public void handle_event(Event event) {
388                             synchronized (pending_manager_events) {
389                                 pending_manager_events.add(event);
390                                 pending_manager_events.notifyAll();
391                             }
392                         }
393                     }), RetryAttempts.of(0));
394                 }
395             }
396
397             this.node_id = chan_manager.get_our_node_id();
398             this.filter = null;
399             bind_nio();
400             System.gc();
401         }
402
403         Object ptr_to;
404         Peer(Peer orig) {
405             this(null, orig.seed);
406             if (use_chan_manager_constructor) {
407                 byte[][] monitors = {orig.monitors.values().stream().iterator().next().write()};
408                 byte[] serialized = orig.chan_manager.write();
409                 try {
410                     Filter filter_nullable = null;
411                     if (this.filter instanceof Option_FilterZ.Some) {
412                         filter_nullable = ((Option_FilterZ.Some) this.filter).some;
413                     }
414                     if (use_ignore_handler) {
415                         this.constructor = new ChannelManagerConstructor(serialized, monitors, UserConfig.with_default(),
416                                 this.keys_interface, this.fee_estimator, this.chain_monitor, filter_nullable,
417                                 null, this.tx_broadcaster, this.logger);
418                     } else {
419                         this.constructor = new ChannelManagerConstructor(serialized, monitors, UserConfig.with_default(),
420                                 this.keys_interface, this.fee_estimator, this.chain_monitor, filter_nullable,
421                                 this.router, this.tx_broadcaster, this.logger);
422                         try {
423                             // Test that ChannelManagerConstructor correctly rejects duplicate ChannelMonitors
424                             byte[][] monitors_dupd = new byte[2][];
425                             monitors_dupd[0] = monitors[0];
426                             monitors_dupd[1] = monitors[0];
427                             ChannelManagerConstructor constr = this.constructor = new ChannelManagerConstructor(serialized, monitors_dupd, UserConfig.with_default(),
428                                     this.keys_interface, this.fee_estimator, this.chain_monitor, filter_nullable,
429                                     null, this.tx_broadcaster, this.logger);
430                             assert false;
431                         } catch (ChannelManagerConstructor.InvalidSerializedDataException e) {}
432                     }
433                     LockableScore scorer = null;
434                     if (use_invoice_payer) { scorer = LockableScore.of(Scorer.with_default().as_Score()); }
435                     constructor.chain_sync_completed(new ChannelManagerConstructor.EventHandler() {
436                         @Override public void handle_event(Event event) {
437                             synchronized (pending_manager_events) {
438                                 pending_manager_events.add(event);
439                                 pending_manager_events.notifyAll();
440                             }
441                         }
442                         @Override public void persist_manager(byte[] channel_manager_bytes) { assert channel_manager_bytes.length > 1; }
443                     }, scorer);
444                     this.chan_manager = constructor.channel_manager;
445                     this.payer = constructor.payer;
446                     this.peer_manager = constructor.peer_manager;
447                     must_free_objs.add(new WeakReference<>(this.chan_manager));
448                     // If we are using a ChannelManagerConstructor, we may have pending events waiting on the old peer
449                     // which have been removed from the ChannelManager but which we still need to handle.
450                     this.pending_manager_events.addAll(orig.pending_manager_events);
451                     if (!this.pending_manager_events.isEmpty()) {
452                         // However, this implies cross_reload_ref_pollution
453                         cross_reload_ref_pollution = true;
454                     }
455                 } catch (ChannelManagerConstructor.InvalidSerializedDataException e) {
456                     assert false;
457                 }
458             } else {
459                 ChannelMonitor[] monitors = new ChannelMonitor[1];
460                 assert orig.monitors.size() == 1;
461                 if (!break_cross_peer_refs) {
462                     monitors[0] = orig.monitors.values().stream().iterator().next();
463                 } else {
464                     byte[] serialized = orig.monitors.values().stream().iterator().next().write();
465                     Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ res =
466                             UtilMethods.C2Tuple_BlockHashChannelMonitorZ_read(serialized, this.keys_interface);
467                     assert res instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
468                     monitors[0] = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) res).res.get_b();
469                 }
470                 byte[] serialized = orig.chan_manager.write();
471                 Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ read_res =
472                         UtilMethods.C2Tuple_BlockHashChannelManagerZ_read(serialized, this.keys_interface, this.fee_estimator, this.chain_watch, this.tx_broadcaster, this.logger, UserConfig.with_default(), monitors);
473                 assert read_res instanceof Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK;
474                 this.chan_manager = ((Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK) read_res).res.get_b();
475                 this.chain_watch.watch_channel(monitors[0].get_funding_txo().get_a(), monitors[0]);
476                 byte[] random_data = keys_interface.get_secure_random_bytes();
477                 this.peer_manager = PeerManager.of(chan_manager.as_ChannelMessageHandler(), route_handler.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger, this.custom_message_handler);
478                 if (!break_cross_peer_refs && (use_manual_watch || use_km_wrapper)) {
479                     // When we pass monitors[0] into chain_watch.watch_channel we create a reference from the new Peer to a
480                     // field in the old peer, preventing freeing of the original Peer until the new Peer is freed. Thus, we
481                     // shouldn't bother waiting for the original to be freed later on.
482                     cross_reload_ref_pollution = true;
483                 }
484                 if (use_invoice_payer) {
485                     this.payer = InvoicePayer.of(this.chan_manager.as_Payer(), Router.new_impl(new Router.RouterInterface() {
486                         @Override
487                         public Result_RouteLightningErrorZ find_route(byte[] payer, RouteParameters params, ChannelDetails[] first_hops, Score scorer) {
488                             return UtilMethods.find_route(payer, params, router, first_hops, logger, scorer);
489                         }
490                     }), LockableScore.of(Score.new_impl(new Score.ScoreInterface() {
491                         @Override public void payment_path_failed(RouteHop[] path, long scid) {}
492                         @Override public long channel_penalty_msat(long scid, NodeId src, NodeId dst) { return 0; }
493                         @Override public byte[] write() { assert false; return null; }
494                     })), logger, EventHandler.new_impl(new EventHandler.EventHandlerInterface() {
495                         @Override public void handle_event(Event event) {
496                             synchronized (pending_manager_events) {
497                                 pending_manager_events.add(event);
498                                 pending_manager_events.notifyAll();
499                             }
500                         }
501                     }), RetryAttempts.of(0));
502                 }
503             }
504             this.node_id = chan_manager.get_our_node_id();
505             bind_nio();
506
507             if (cross_reload_ref_pollution) {
508                 // This really, really needs to be handled at the bindings layer, but its rather complicated -
509                 // ChannelSigners can be cloned and passed around without java being involved, resulting in them being
510                 // owned by both one or more ChannelMonitors and a ChannelManager, with only one having proper pointers
511                 // to the ChannelSigner. Ideally, the ChannelSigner would have a global reference to the Java
512                 // implementation class, but that results in circular references. Instead, we need some ability to,
513                 // while cloning ChannelSigners, add new references in the calling Java struct (ie ChannelMonitor) to
514                 // the ChannelSigner.
515                 this.ptr_to = orig.chan_manager;
516             }
517             this.filter = null;
518         }
519
520         TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ[] connect_block(Block b, int height, long expected_monitor_update_len) {
521             byte[] header = Arrays.copyOfRange(b.bitcoinSerialize(), 0, 80);
522             TwoTuple_usizeTransactionZ[] txn;
523             if (b.hasTransactions()) {
524                 assert b.getTransactions().size() == 1;
525                 TwoTuple_usizeTransactionZ txp = TwoTuple_usizeTransactionZ.of((long) 0, b.getTransactions().get(0).bitcoinSerialize());
526                 txn = new TwoTuple_usizeTransactionZ[]{txp};
527             } else
528                 txn = new TwoTuple_usizeTransactionZ[0];
529             if (chain_monitor != null) {
530                 chan_manager.as_Listen().block_connected(b.bitcoinSerialize(), height);
531                 chain_monitor.as_Listen().block_connected(b.bitcoinSerialize(), height);
532             } else {
533                 chan_manager.as_Confirm().transactions_confirmed(header, txn, height);
534                 chan_manager.as_Confirm().best_block_updated(header, height);
535                 // Connect manually if we aren't using a ChainMonitor and are implementing Watch ourselves
536                 synchronized (monitors) {
537                     assert monitors.size() == 1;
538                     for (ChannelMonitor mon : monitors.values()) {
539                         TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ[] ret = mon.block_connected(header, txn, height, tx_broadcaster, fee_estimator, logger);
540                         assert ret.length == expected_monitor_update_len;
541                         return ret;
542                     }
543                 }
544             }
545             return null;
546         }
547
548         Event[] get_monitor_events(int expected_len) {
549             if (use_chan_manager_constructor) {
550                 while (true) {
551                     synchronized (this.pending_manager_events) {
552                         if (expected_len != 0 && this.pending_manager_events.size() == expected_len) {
553                             break;
554                         }
555                     }
556                     if (expected_len == 0) {
557                         try { Thread.sleep(500); } catch (InterruptedException e) { assert false; }
558                         break;
559                     } else {
560                         Thread.yield();
561                     }
562                 }
563                 synchronized (this.pending_manager_events) {
564                     Event[] res = this.pending_manager_events.toArray(new Event[0]);
565                     this.pending_manager_events.clear();
566                     assert res.length == expected_len;
567                     return res;
568                 }
569             } else if (chain_monitor != null) {
570                 ArrayList<Event> l = new ArrayList<Event>();
571                 chain_monitor.as_EventsProvider().process_pending_events(EventHandler.new_impl(l::add));
572                 assert l.size() == expected_len;
573                 return l.toArray(new Event[0]);
574             } else {
575                 synchronized (monitors) {
576                     assert monitors.size() == 1;
577                     for (ChannelMonitor mon : monitors.values()) {
578                         Event[] res = mon.get_and_clear_pending_events();
579                         assert res.length == expected_len;
580                         return res;
581                     }
582                     return null;
583                 }
584             }
585         }
586
587         Event[] get_manager_events(int expected_len, Peer peer1, Peer peer2) {
588             assert expected_len != 0;
589             if (!use_nio_peer_handler) {
590                 maybe_exchange_peer_messages(peer1, peer2);
591             }
592             Event[] res = new Event[0];
593             if (use_chan_manager_constructor) {
594                 while (res.length < expected_len) {
595                     synchronized (this.pending_manager_events) {
596                         res = this.pending_manager_events.toArray(res);
597                         assert res.length == expected_len || res.length == 0; // We don't handle partial results
598                         this.pending_manager_events.clear();
599                         if (res.length < expected_len) {
600                             try { this.pending_manager_events.wait(); } catch (InterruptedException e) { assert false; }
601                         }
602                     }
603                 }
604             } else {
605                 ArrayList<Event> l = new ArrayList<Event>();
606                 while (l.size() < expected_len) {
607                     Thread.yield();
608                     if (use_nio_peer_handler) {
609                         peer1.nio_peer_handler.check_events();
610                         peer2.nio_peer_handler.check_events();
611                     }
612                     chan_manager.as_EventsProvider().process_pending_events(EventHandler.new_impl(l::add));
613                     assert l.size() == expected_len || l.size() == 0; // We don't handle partial results
614                 }
615                 return l.toArray(new Event[0]);
616             }
617             assert res.length == expected_len;
618             return res;
619         }
620     }
621
622     static class DescriptorHolder { SocketDescriptor val; }
623
624     boolean running = false;
625     final LinkedList<Runnable> runqueue = new LinkedList();
626     boolean ran = false;
627     Thread t = new Thread(() -> {
628             while (true) {
629                 try {
630                     Runnable r;
631                     synchronized (runqueue) {
632                         while (runqueue.isEmpty()) {
633                             runqueue.wait();
634                         }
635                         running = true;
636                         r = runqueue.pollFirst();
637                     }
638                     r.run();
639                     synchronized (runqueue) {
640                         running = false;
641                         runqueue.notifyAll();
642                     }
643                 } catch (InterruptedException e) {
644                     return;
645                 }
646             }
647     });
648
649     void maybe_exchange_peer_messages(Peer peer1, Peer peer2) {
650         if (!use_nio_peer_handler) {
651             synchronized (runqueue) {
652                 ran = false;
653             }
654             while (true) {
655                 peer1.peer_manager.process_events();
656                 peer2.peer_manager.process_events();
657                 synchronized (runqueue) {
658                     if (runqueue.isEmpty() && !running) {
659                         if (ran) {
660                             ran = false;
661                             continue;
662                         } else { break; }
663                     }
664                     try { runqueue.wait(); } catch (InterruptedException e) { assert false; }
665                 }
666             }
667         } else if (!use_chan_manager_constructor) {
668             peer1.nio_peer_handler.check_events();
669             peer2.nio_peer_handler.check_events();
670         }
671     }
672     void do_read_event(PeerManager pm, SocketDescriptor descriptor, byte[] data) {
673         if (!t.isAlive()) t.start();
674         synchronized (runqueue) {
675             ran = true;
676             runqueue.add(() -> {
677                 Result_boolPeerHandleErrorZ res = pm.read_event(descriptor, data);
678                 assert res instanceof Result_boolPeerHandleErrorZ.Result_boolPeerHandleErrorZ_OK;
679             });
680             runqueue.notifyAll();
681         }
682         must_free_objs.add(new WeakReference<>(data));
683     }
684
685     void connect_peers(final Peer peer1, final Peer peer2) {
686         peer2.connected_peer_node_id = peer1.node_id;
687         peer1.connected_peer_node_id = peer2.node_id;
688         if (use_nio_peer_handler) {
689             try {
690                 peer1.nio_peer_handler.connect(peer2.chan_manager.get_our_node_id(), new InetSocketAddress("127.0.0.1", peer2.nio_port), 100);
691             } catch (IOException e) { assert false; }
692             while (peer1.peer_manager.get_peer_node_ids().length == 0 || peer2.peer_manager.get_peer_node_ids().length == 0) {
693                 Thread.yield();
694             }
695         } else {
696             DescriptorHolder descriptor1 = new DescriptorHolder();
697             DescriptorHolder descriptor1ref = descriptor1;
698             SocketDescriptor descriptor2 = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
699                 @Override
700                 public long send_data(byte[] data, boolean resume_read) {
701                     do_read_event(peer1.peer_manager, descriptor1ref.val, data);
702                     return data.length;
703                 }
704
705                 @Override public void disconnect_socket() { assert false; }
706                 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 2; }
707                 @Override public long hash() { return 2; }
708             });
709
710             descriptor1.val = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
711                 @Override
712                 public long send_data(byte[] data, boolean resume_read) {
713                     do_read_event(peer2.peer_manager, descriptor2, data);
714                     return data.length;
715                 }
716
717                 @Override public void disconnect_socket() { assert false; }
718                 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 1; }
719                 @Override public long hash() { return 1; }
720             });
721
722             Result_CVec_u8ZPeerHandleErrorZ conn_res = peer1.peer_manager.new_outbound_connection(peer2.node_id, descriptor1.val);
723             assert conn_res instanceof Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK;
724
725             Result_NonePeerHandleErrorZ inbound_conn_res = peer2.peer_manager.new_inbound_connection(descriptor2);
726             assert inbound_conn_res instanceof Result_NonePeerHandleErrorZ.Result_NonePeerHandleErrorZ_OK;
727             do_read_event(peer2.peer_manager, descriptor2, ((Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK) conn_res).res);
728
729             maybe_exchange_peer_messages(peer1, peer2);
730         }
731     }
732
733     TestState do_test_message_handler() throws InterruptedException {
734         Peer peer1 = new Peer((byte) 1);
735         Peer peer2 = new Peer((byte) 2);
736
737         connect_peers(peer1, peer2);
738
739         Result__u832APIErrorZ cc_res = peer1.chan_manager.create_channel(peer2.node_id, 100000, 1000, 42, null);
740         assert cc_res instanceof Result__u832APIErrorZ.Result__u832APIErrorZ_OK;
741
742         // Previously, this was a SEGFAULT instead of get_funding_txo() returning null.
743         ChannelDetails pre_funding_chan = peer1.chan_manager.list_channels()[0];
744         assert pre_funding_chan.get_funding_txo() == null;
745
746         Event[] events = peer1.get_manager_events(1, peer1, peer2);
747         assert events[0] instanceof Event.FundingGenerationReady;
748         assert ((Event.FundingGenerationReady) events[0]).channel_value_satoshis == 100000;
749         assert ((Event.FundingGenerationReady) events[0]).user_channel_id == 42;
750         byte[] funding_spk = ((Event.FundingGenerationReady) events[0]).output_script;
751         assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
752         byte[] chan_id = ((Event.FundingGenerationReady) events[0]).temporary_channel_id;
753
754         NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
755
756         Transaction funding = new Transaction(bitcoinj_net);
757         funding.addInput(new TransactionInput(bitcoinj_net, funding, new byte[0]));
758         funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
759         funding.getInput(0).getWitness().setPush(0, new byte[]{0x1});
760         funding.addOutput(Coin.SATOSHI.multiply(100000), new Script(funding_spk));
761         Result_NoneAPIErrorZ funding_res = peer1.chan_manager.funding_transaction_generated(chan_id, funding.bitcoinSerialize());
762         assert funding_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
763
764         maybe_exchange_peer_messages(peer1, peer2);
765         synchronized (peer1.broadcast_set) {
766             while (peer1.broadcast_set.size() != 1) {
767                 peer1.broadcast_set.wait();
768             }
769         }
770
771         assert peer1.broadcast_set.size() == 1;
772         assert Arrays.equals(peer1.broadcast_set.get(0), funding.bitcoinSerialize());
773         peer1.broadcast_set.clear();
774
775         Block b = new Block(bitcoinj_net, 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
776         peer1.connect_block(b, 1, 0);
777         peer2.connect_block(b, 1, 0);
778
779         for (int height = 2; height < 10; height++) {
780             b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[0]));
781             peer1.connect_block(b, height, 0);
782             peer2.connect_block(b, height, 0);
783         }
784
785         maybe_exchange_peer_messages(peer1, peer2);
786         while (peer1.chan_manager.list_usable_channels().length != 1 || peer2.chan_manager.list_usable_channels().length != 1)
787
788         peer1.chan_manager.list_channels();
789         ChannelDetails[] peer1_chans = peer1.chan_manager.list_usable_channels();
790         ChannelDetails[] peer2_chans = peer2.chan_manager.list_usable_channels();
791         assert peer1_chans.length == 1;
792         assert peer2_chans.length == 1;
793         assert peer1_chans[0].get_channel_value_satoshis() == 100000;
794         assert peer1_chans[0].get_is_usable();
795         Option_u64Z short_chan_id = peer1_chans[0].get_short_channel_id();
796         assert short_chan_id instanceof Option_u64Z.Some;
797         assert ((Option_u64Z.Some)short_chan_id).some == (1L << 40); // 0th output in the 0th transaction in the 1st block
798         assert Arrays.equals(peer1_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
799         assert Arrays.equals(peer2_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
800
801         Result_InvoiceSignOrCreationErrorZ invoice = UtilMethods.create_invoice_from_channelmanager(peer2.chan_manager, peer2.keys_interface, Currency.LDKCurrency_Bitcoin, Option_u64Z.some(10000000), "Invoice Description");
802         assert invoice instanceof Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK;
803         System.out.println("Got invoice: " + ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
804
805         Result_InvoiceNoneZ parsed_invoice = Invoice.from_str(((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
806         assert parsed_invoice instanceof Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK;
807         assert Arrays.equals(((Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK) parsed_invoice).res.payment_hash(), ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash());
808         SignedRawInvoice signed_raw = ((Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK) parsed_invoice).res.into_signed_raw();
809         RawInvoice raw_invoice = signed_raw.raw_invoice();
810         byte[] desc_hash = raw_invoice.hash();
811         Description raw_invoice_description = raw_invoice.description();
812         String description_string = raw_invoice_description.into_inner();
813         assert description_string.equals("Invoice Description");
814
815         if (!use_invoice_payer) {
816             byte[] payment_hash = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash();
817             byte[] payment_secret = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_secret();
818             byte[] dest_node_id = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.recover_payee_pub_key();
819             assert Arrays.equals(dest_node_id, peer2.node_id);
820             InvoiceFeatures invoice_features = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.features();
821             RouteHint[] route_hints = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.route_hints();
822
823             Payee payee = Payee.of(peer2.node_id, invoice_features, route_hints, Option_u64Z.none());
824             RouteParameters route_params = RouteParameters.of(payee, 10000000, 42);
825             Result_RouteLightningErrorZ route_res = UtilMethods.find_route(
826                     peer1.chan_manager.get_our_node_id(), route_params, peer1.router,
827                     peer1_chans, peer1.logger, Scorer.with_default().as_Score());
828             assert route_res instanceof Result_RouteLightningErrorZ.Result_RouteLightningErrorZ_OK;
829             Route route = ((Result_RouteLightningErrorZ.Result_RouteLightningErrorZ_OK) route_res).res;
830             assert route.get_paths().length == 1;
831             assert route.get_paths()[0].length == 1;
832             assert route.get_paths()[0][0].get_fee_msat() == 10000000;
833
834             Result_PaymentIdPaymentSendFailureZ payment_res = peer1.chan_manager.send_payment(route, payment_hash, payment_secret);
835             assert payment_res instanceof Result_PaymentIdPaymentSendFailureZ.Result_PaymentIdPaymentSendFailureZ_OK;
836
837             RouteHop[][] hops = new RouteHop[1][1];
838             byte[] hop_pubkey = new byte[33];
839             hop_pubkey[0] = 3;
840             hop_pubkey[1] = 42;
841             hops[0][0] = RouteHop.of(hop_pubkey, NodeFeatures.known(), 42, ChannelFeatures.known(), 100, 0);
842             Route r2 = Route.of(hops, payee);
843             payment_res = peer1.chan_manager.send_payment(r2, payment_hash, payment_secret);
844             assert payment_res instanceof Result_PaymentIdPaymentSendFailureZ.Result_PaymentIdPaymentSendFailureZ_Err;
845         } else {
846             Result_PaymentIdPaymentErrorZ send_res = peer1.payer.pay_invoice(((Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK) parsed_invoice).res);
847             assert send_res instanceof Result_PaymentIdPaymentErrorZ.Result_PaymentIdPaymentErrorZ_OK;
848         }
849
850         if (reload_peers) {
851             if (use_chan_manager_constructor) {
852                 peer1.constructor.interrupt();
853                 peer2.constructor.interrupt();
854             } else if (use_nio_peer_handler) {
855                 peer1.nio_peer_handler.interrupt();
856                 peer2.nio_peer_handler.interrupt();
857             }
858             WeakReference<Peer> op1 = new WeakReference<Peer>(peer1);
859             peer1 = new Peer(peer1);
860             peer2 = new Peer(peer2);
861             return new TestState(op1, peer1, peer2, b.getHash());
862         }
863         return new TestState(null, peer1, peer2, b.getHash());
864     }
865
866     boolean cross_reload_ref_pollution = false;
867     class TestState {
868         private final WeakReference<Peer> ref_block;
869         private final Peer peer1;
870         private final Peer peer2;
871         public Sha256Hash best_blockhash;
872
873         public TestState(WeakReference<Peer> ref_block, Peer peer1, Peer peer2, Sha256Hash best_blockhash) {
874             this.ref_block = ref_block;
875             this.peer1 = peer1;
876             this.peer2 = peer2;
877             this.best_blockhash = best_blockhash;
878         }
879     }
880     void do_test_message_handler_b(TestState state) throws InterruptedException {
881         GcCheck obj = new GcCheck();
882         if (state.ref_block != null) {
883             // Ensure the original peers get freed before we move on. Note that we have to be in a different function
884             // scope to do so as the (at least current OpenJDK) JRE won't release anything created in the same scope.
885             while (!cross_reload_ref_pollution && state.ref_block.get() != null) {
886                 System.gc();
887                 System.runFinalization();
888             }
889             connect_peers(state.peer1, state.peer2);
890         }
891
892         Event[] events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
893         assert events[0] instanceof Event.PendingHTLCsForwardable;
894         state.peer2.chan_manager.process_pending_htlc_forwards();
895
896         events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
897         assert events[0] instanceof Event.PaymentReceived;
898         assert ((Event.PaymentReceived)events[0]).purpose instanceof PaymentPurpose.InvoicePayment;
899         byte[] payment_preimage = ((PaymentPurpose.InvoicePayment)((Event.PaymentReceived)events[0]).purpose).payment_preimage;
900         assert !Arrays.equals(payment_preimage, new byte[32]);
901         state.peer2.chan_manager.claim_funds(payment_preimage);
902
903         events = state.peer1.get_manager_events(1, state.peer1, state.peer2);
904         assert events[0] instanceof Event.PaymentSent;
905         assert Arrays.equals(((Event.PaymentSent) events[0]).payment_preimage, payment_preimage);
906
907         if (use_nio_peer_handler) {
908             // We receive PaymentSent immediately upon receipt of the payment preimage, but we expect to not have an
909             // HTLC transaction to broadcast below, which requires a bit more time to fully complete the
910             // commitment-transaction-update dance between both peers.
911             Thread.sleep(100);
912         }
913
914         if (state.peer1.chain_monitor != null) {
915             Balance[] peer1_balances = state.peer1.chain_monitor.get_claimable_balances(state.peer1.chan_manager.list_channels());
916             assert peer1_balances.length == 0;
917             Balance[] peer2_balances = state.peer2.chain_monitor.get_claimable_balances(state.peer2.chan_manager.list_channels());
918             assert peer2_balances.length == 0;
919         }
920
921         ChannelDetails[] peer1_chans = state.peer1.chan_manager.list_channels();
922
923         if (nice_close) {
924             Result_NoneAPIErrorZ close_res = state.peer1.chan_manager.close_channel(peer1_chans[0].get_channel_id());
925             assert close_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
926             maybe_exchange_peer_messages(state.peer1, state.peer2);
927             synchronized (state.peer1.broadcast_set) {
928                 while (state.peer1.broadcast_set.size() != 1) state.peer1.broadcast_set.wait();
929             }
930             synchronized (state.peer2.broadcast_set) {
931                 while (state.peer2.broadcast_set.size() != 1) state.peer2.broadcast_set.wait();
932             }
933
934             assert state.peer1.broadcast_set.size() == 1;
935             assert state.peer2.broadcast_set.size() == 1;
936         } else {
937             state.peer1.chan_manager.force_close_all_channels();
938             maybe_exchange_peer_messages(state.peer1, state.peer2);
939             synchronized (state.peer1.broadcast_set) {
940                 while (state.peer1.broadcast_set.size() != 1) state.peer1.broadcast_set.wait();
941             }
942             synchronized (state.peer2.broadcast_set) {
943                 while (state.peer2.broadcast_set.size() != 1) state.peer2.broadcast_set.wait();
944             }
945
946             assert state.peer1.broadcast_set.size() == 1;
947             assert state.peer2.broadcast_set.size() == 1;
948         }
949
950         events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
951         assert events[0] instanceof Event.ChannelClosed;
952         events = state.peer1.get_manager_events(1, state.peer1, state.peer2);
953         assert events[0] instanceof Event.ChannelClosed;
954
955         if (state.peer1.chain_monitor != null) {
956             Balance[] peer1_balances = state.peer1.chain_monitor.get_claimable_balances(state.peer1.chan_manager.list_channels());
957             assert peer1_balances.length == 1;
958             for (Balance bal : peer1_balances) {
959                 assert bal instanceof Balance.ClaimableOnChannelClose;
960                 long expected_tx_fee = 183;
961                 assert ((Balance.ClaimableOnChannelClose) bal).claimable_amount_satoshis == 100000 - 1 - 10000 - expected_tx_fee;
962             }
963             Balance[] peer2_balances = state.peer2.chain_monitor.get_claimable_balances(state.peer2.chan_manager.list_channels());
964             assert peer2_balances.length == 1;
965             for (Balance bal : peer2_balances) {
966                 assert bal instanceof Balance.ClaimableOnChannelClose;
967                 assert ((Balance.ClaimableOnChannelClose) bal).claimable_amount_satoshis == 10000 + 1;
968             }
969         }
970
971         if (!nice_close) {
972             NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
973             Transaction tx = new Transaction(bitcoinj_net, state.peer1.broadcast_set.getFirst());
974             Block b = new Block(bitcoinj_net, 2, state.best_blockhash, Sha256Hash.ZERO_HASH, 42, 0, 0,
975                     Arrays.asList(new Transaction[]{tx}));
976             TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ[] watch_outputs = state.peer2.connect_block(b, 10, 1);
977             if (watch_outputs != null) { // We only process watch_outputs manually when we use a manually-build Watch impl
978                 assert watch_outputs.length == 1;
979                 assert Arrays.equals(watch_outputs[0].get_a(), tx.getTxId().getReversedBytes());
980                 assert watch_outputs[0].get_b().length == 2;
981                 assert watch_outputs[0].get_b()[0].get_a() == 0;
982                 assert watch_outputs[0].get_b()[1].get_a() == 1;
983             }
984
985             for (int i = 11; i < 21; i++) {
986                 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, new ArrayList<>());
987                 state.peer2.connect_block(b, i, 0);
988             }
989
990             Event[] broadcastable_event = state.peer2.get_monitor_events(1);
991             for (ChannelMonitor mon : state.peer2.monitors.values()) {
992                 // This used to be buggy and double-free, so go ahead and fetch them!
993                 byte[][] txn = mon.get_latest_holder_commitment_txn(state.peer2.logger);
994             }
995             assert broadcastable_event.length == 1;
996             assert broadcastable_event[0] instanceof Event.SpendableOutputs;
997             if (state.peer2.explicit_keys_manager != null) {
998                 TxOut[] additional_outputs = new TxOut[]{new TxOut(420, new byte[]{0x42})};
999                 Result_TransactionNoneZ tx_res = state.peer2.explicit_keys_manager.spend_spendable_outputs(((Event.SpendableOutputs) broadcastable_event[0]).outputs, additional_outputs, new byte[]{0x00}, 253);
1000                 assert tx_res instanceof Result_TransactionNoneZ.Result_TransactionNoneZ_OK;
1001                 Transaction built_tx = new Transaction(bitcoinj_net, ((Result_TransactionNoneZ.Result_TransactionNoneZ_OK) tx_res).res);
1002                 assert built_tx.getOutputs().size() == 2;
1003                 assert Arrays.equals(built_tx.getOutput(1).getScriptBytes(), new byte[]{0x00});
1004                 assert Arrays.equals(built_tx.getOutput(0).getScriptBytes(), new byte[]{0x42});
1005                 assert built_tx.getOutput(0).getValue().value == 420;
1006             }
1007         }
1008
1009         // Test exchanging a custom message (note that ChannelManagerConstructor) always loads an IgnorimgMessageHandler
1010         // so we cannot exchange custom messages with it
1011         if (!use_chan_manager_constructor) {
1012             byte[] custom_message_bytes = new byte[]{0x42, 0x44, 0x43, 0x00};
1013             state.peer1.custom_messages_to_send.add(custom_message_bytes);
1014             state.peer1.peer_manager.process_events();
1015             synchronized (state.peer2.received_custom_messages) {
1016                 while (true) {
1017                     if (state.peer2.received_custom_messages.isEmpty()) {
1018                         state.peer2.received_custom_messages.wait();
1019                         continue;
1020                     }
1021                     assert state.peer2.received_custom_messages.size() == 1;
1022                     assert Arrays.equals(state.peer2.received_custom_messages.get(0), custom_message_bytes);
1023                     break;
1024                 }
1025             }
1026         }
1027
1028         if (use_nio_peer_handler) {
1029             state.peer1.peer_manager.disconnect_by_node_id(state.peer2.chan_manager.get_our_node_id(), false);
1030             while (state.peer1.peer_manager.get_peer_node_ids().length != 0) Thread.yield();
1031             while (state.peer2.peer_manager.get_peer_node_ids().length != 0) Thread.yield();
1032             state.peer1.nio_peer_handler.interrupt();
1033             state.peer2.nio_peer_handler.interrupt();
1034         }
1035
1036         state.peer1.get_monitor_events(0);
1037         state.peer2.get_monitor_events(0);
1038
1039         if (use_chan_manager_constructor) {
1040             state.peer1.constructor.interrupt();
1041             state.peer2.constructor.interrupt();
1042         }
1043
1044         t.interrupt();
1045
1046         state.peer1.router.write();
1047
1048         // Construct the only Option_Enum::Variant(OpaqueStruct) we have in the codebase as this used to cause double-frees:
1049         byte[] serd = new byte[] {(byte)0xd9,(byte)0x77,(byte)0xcb,(byte)0x9b,(byte)0x53,(byte)0xd9,(byte)0x3a,(byte)0x6f,(byte)0xf6,(byte)0x4b,(byte)0xb5,(byte)0xf1,(byte)0xe1,(byte)0x58,(byte)0xb4,(byte)0x09,(byte)0x4b,(byte)0x66,(byte)0xe7,(byte)0x98,(byte)0xfb,(byte)0x12,(byte)0x91,(byte)0x11,(byte)0x68,(byte)0xa3,(byte)0xcc,(byte)0xdf,(byte)0x80,(byte)0xa8,(byte)0x30,(byte)0x96,(byte)0x34,(byte)0x0a,(byte)0x6a,(byte)0x95,(byte)0xda,(byte)0x0a,(byte)0xe8,(byte)0xd9,(byte)0xf7,(byte)0x76,(byte)0x52,(byte)0x8e,(byte)0xec,(byte)0xdb,(byte)0xb7,(byte)0x47,(byte)0xeb,(byte)0x6b,(byte)0x54,(byte)0x54,(byte)0x95,(byte)0xa4,(byte)0x31,(byte)0x9e,(byte)0xd5,(byte)0x37,(byte)0x8e,(byte)0x35,(byte)0xb2,(byte)0x1e,(byte)0x07,(byte)0x3a,(byte)0x00,(byte)0x00,(byte)0x00,(byte)0x00,(byte)0x00,(byte)0x19,(byte)0xd6,(byte)0x68,(byte)0x9c,(byte)0x08,(byte)0x5a,(byte)0xe1,(byte)0x65,(byte)0x83,(byte)0x1e,(byte)0x93,(byte)0x4f,(byte)0xf7,(byte)0x63,(byte)0xae,(byte)0x46,(byte)0xa2,(byte)0xa6,(byte)0xc1,(byte)0x72,(byte)0xb3,(byte)0xf1,(byte)0xb6,(byte)0x0a,(byte)0x8c,(byte)0xe2,(byte)0x6f,(byte)0x00,(byte)0x08,(byte)0x3a,(byte)0x84,(byte)0x00,(byte)0x00,(byte)0x03,(byte)0x4d,(byte)0x01,(byte)0x34,(byte)0x13,(byte)0xa7,(byte)0x00,(byte)0x00,(byte)0x00,(byte)0x90,(byte)0x00,(byte)0x00,(byte)0x00,(byte)0x00,(byte)0x00,(byte)0x0f,(byte)0x42,(byte)0x40,(byte)0x00,(byte)0x00,(byte)0x27,(byte)0x10,(byte)0x00,(byte)0x00,(byte)0x00,(byte)0x14,};
1050         Result_ChannelUpdateDecodeErrorZ upd_msg = ChannelUpdate.read(serd);
1051         assert upd_msg instanceof Result_ChannelUpdateDecodeErrorZ.Result_ChannelUpdateDecodeErrorZ_OK;
1052         Option_NetworkUpdateZ upd = Option_NetworkUpdateZ.some(NetworkUpdate.channel_update_message(((Result_ChannelUpdateDecodeErrorZ.Result_ChannelUpdateDecodeErrorZ_OK) upd_msg).res));
1053     }
1054
1055     java.util.LinkedList<WeakReference<Object>> must_free_objs = new java.util.LinkedList();
1056     int gc_count = 0;
1057     int gc_exp_count = 0;
1058     class GcCheck {
1059         GcCheck() { gc_exp_count += 1; }
1060         @Override
1061         protected void finalize() throws Throwable {
1062             gc_count += 1;
1063             super.finalize();
1064         }
1065     }
1066 }
1067 public class HumanObjectPeerTest {
1068     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, boolean use_ignoring_routing_handler, boolean use_chan_manager_constructor, boolean use_invoice_payer) throws InterruptedException {
1069         HumanObjectPeerTestInstance instance = new HumanObjectPeerTestInstance(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_peer_refs, nio_peer_handler, !nio_peer_handler, use_ignoring_routing_handler, use_chan_manager_constructor, use_invoice_payer);
1070         HumanObjectPeerTestInstance.TestState state = instance.do_test_message_handler();
1071         instance.do_test_message_handler_b(state);
1072         return instance;
1073     }
1074     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, boolean use_ignoring_routing_handler, boolean use_chan_manager_constructor, boolean use_invoice_payer) throws InterruptedException {
1075         HumanObjectPeerTestInstance instance = do_test_run(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_peer_refs, nio_peer_handler, use_ignoring_routing_handler, use_chan_manager_constructor, use_invoice_payer);
1076         while (instance.gc_count != instance.gc_exp_count) {
1077             System.gc();
1078             System.runFinalization();
1079         }
1080         for (WeakReference<Object> o : instance.must_free_objs)
1081             assert o.get() == null;
1082     }
1083     @Test
1084     public void test_message_handler() throws InterruptedException {
1085         Thread gc_thread = new Thread(() -> {
1086             while (true) {
1087                 System.gc();
1088                 System.runFinalization();
1089                 try { Thread.sleep(0, 1); } catch (InterruptedException e) { break; }
1090             }
1091         }, "Test GC Thread");
1092         gc_thread.start();
1093         for (int i = 0; i < (1 << 9) - 1; i++) {
1094             boolean nice_close =                   (i & (1 << 0)) != 0;
1095             boolean use_km_wrapper =               (i & (1 << 1)) != 0;
1096             boolean use_manual_watch =             (i & (1 << 2)) != 0;
1097             boolean reload_peers =                 (i & (1 << 3)) != 0;
1098             boolean break_cross_refs =             (i & (1 << 4)) != 0;
1099             boolean use_ignoring_routing_handler = (i & (1 << 5)) != 0;
1100             boolean use_chan_manager_constructor = (i & (1 << 6)) != 0;
1101             boolean use_invoice_payer =            (i & (1 << 7)) != 0;
1102             boolean nio_peer_handler =             (i & (1 << 8)) != 0;
1103             if (break_cross_refs && !reload_peers) {
1104                 // There are no cross refs to break without reloading peers.
1105                 continue;
1106             }
1107             if (use_chan_manager_constructor && (use_manual_watch || !nio_peer_handler)) {
1108                 // ChannelManagerConstructor requires a ChainMonitor as the Watch and creates a NioPeerHandler for us.
1109                 continue;
1110             }
1111             if (!use_chan_manager_constructor && (use_ignoring_routing_handler)) {
1112                 // We rely on the ChannelManagerConstructor to convert null into an IgnoringMessageHandler, so don't
1113                 // try to run with an IgnoringMessageHandler unless we're also using a ChannelManagerConstructor.
1114                 continue;
1115             }
1116             if (use_chan_manager_constructor && use_ignoring_routing_handler && use_invoice_payer) {
1117                 // As documented on ChannelManagerConstructor, if we provide a `null` NetworkGraph (because we want to
1118                 // use an IgnoringMessageHandler), no InvoicePayer will be constructored for us, thus we cannot use an
1119                 // InvoicePayer to send payments in this case.
1120                 continue;
1121             }
1122             System.err.println("Running test with flags " + i);
1123             do_test(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_refs, nio_peer_handler, use_ignoring_routing_handler, use_chan_manager_constructor, use_invoice_payer);
1124         }
1125         gc_thread.interrupt();
1126         gc_thread.join();
1127     }
1128
1129     // This is used in the test jar to test the built jar is runnable
1130     public static void main(String[] args) {
1131         try {
1132             new HumanObjectPeerTest().test_message_handler();
1133         } catch (Exception e) {
1134             System.err.println("Caught exception:");
1135             System.err.println(e);
1136             System.exit(1);
1137         }
1138     }
1139 }