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