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