4e90f4cd164aae5445c0fbcedf07ec0d344b9a29
[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 TwoTuple_OutPointCVec_MonitorEventZZ[] release_pending_monitor_events() {
155                     synchronized (monitors) {
156                         assert monitors.size() <= 1;
157                         for (ChannelMonitor mon : monitors.values()) {
158                             TwoTuple_OutPointCVec_MonitorEventZZ[] res = new TwoTuple_OutPointCVec_MonitorEventZZ[1];
159                             res[0] = TwoTuple_OutPointCVec_MonitorEventZZ.of(mon.get_funding_txo().get_a(), mon.get_and_clear_pending_monitor_events());
160                             return res;
161                         }
162                     }
163                     return new TwoTuple_OutPointCVec_MonitorEventZZ[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             ChannelConfig channel_config = ChannelConfig.with_default();
174             channel_config.set_announced_channel(true);
175             UserConfig config = UserConfig.with_default();
176             config.set_channel_options(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                             return UtilMethods.find_route(payer, params, router, first_hops, logger, scorer, new byte[32]);
403                         }
404                     }), MultiThreadedLockableScore.of(Score.new_impl(new Score.ScoreInterface() {
405                         @Override public void payment_path_failed(RouteHop[] path, long scid) {}
406                         @Override public long channel_penalty_msat(long short_channel_id, NodeId source, NodeId target, ChannelUsage usage) { return 0; }
407                         @Override public void payment_path_successful(RouteHop[] path) {}
408                         @Override public byte[] write() { assert false; return null; }
409                     })), logger, EventHandler.new_impl(new EventHandler.EventHandlerInterface() {
410                         @Override public void handle_event(Event event) {
411                             synchronized (pending_manager_events) {
412                                 pending_manager_events.add(event);
413                                 pending_manager_events.notifyAll();
414                             }
415                         }
416                     }), Retry.attempts(0));
417                 }
418             }
419
420             this.node_id = chan_manager.get_our_node_id();
421             this.filter = null;
422             bind_nio();
423             System.gc();
424         }
425
426         Object ptr_to;
427         Peer(Peer orig) {
428             this(null, orig.seed);
429             if (use_chan_manager_constructor) {
430                 byte[][] monitors = {orig.monitors.values().stream().iterator().next().write()};
431                 byte[] serialized = orig.chan_manager.write();
432                 byte[] serialized_router = orig.router.write();
433                 try {
434                     Filter filter_nullable = null;
435                     if (this.filter instanceof Option_FilterZ.Some) {
436                         filter_nullable = ((Option_FilterZ.Some) this.filter).some;
437                     }
438                     if (use_ignore_handler) {
439                         this.constructor = new ChannelManagerConstructor(serialized, monitors, get_config(),
440                                 this.keys_interface, this.fee_estimator, this.chain_monitor, filter_nullable,
441                                 null, this.tx_broadcaster, this.logger);
442                     } else {
443                         this.constructor = new ChannelManagerConstructor(serialized, monitors, get_config(),
444                                 this.keys_interface, this.fee_estimator, this.chain_monitor, filter_nullable,
445                                 serialized_router, this.tx_broadcaster, this.logger);
446                         try {
447                             // Test that ChannelManagerConstructor correctly rejects duplicate ChannelMonitors
448                             byte[][] monitors_dupd = new byte[2][];
449                             monitors_dupd[0] = monitors[0];
450                             monitors_dupd[1] = monitors[0];
451                             ChannelManagerConstructor constr = this.constructor = new ChannelManagerConstructor(serialized, monitors_dupd, get_config(),
452                                     this.keys_interface, this.fee_estimator, this.chain_monitor, filter_nullable,
453                                     null, this.tx_broadcaster, this.logger);
454                             assert false;
455                         } catch (ChannelManagerConstructor.InvalidSerializedDataException e) {}
456                     }
457                     this.router = this.constructor.net_graph;
458                     setup_route_handler();
459                     MultiThreadedLockableScore scorer = null;
460                     if (use_invoice_payer) { scorer = MultiThreadedLockableScore.of(ProbabilisticScorer.of(ProbabilisticScoringParameters.with_default(), this.router, this.logger).as_Score()); }
461                     constructor.chain_sync_completed(new ChannelManagerConstructor.EventHandler() {
462                         @Override public void handle_event(Event event) {
463                             synchronized (pending_manager_events) {
464                                 pending_manager_events.add(event);
465                                 pending_manager_events.notifyAll();
466                             }
467                         }
468                         @Override public void persist_manager(byte[] channel_manager_bytes) { assert channel_manager_bytes.length > 1; }
469                         @Override public void persist_network_graph(byte[] graph_bytes) { assert graph_bytes.length > 1; }
470                         @Override public void persist_scorer(byte[] scorer_bytes) { assert scorer_bytes.length > 1; }
471                     }, scorer);
472                     this.chan_manager = constructor.channel_manager;
473                     this.payer = constructor.payer;
474                     this.peer_manager = constructor.peer_manager;
475                     must_free_objs.add(new WeakReference<>(this.chan_manager));
476                     // If we are using a ChannelManagerConstructor, we may have pending events waiting on the old peer
477                     // which have been removed from the ChannelManager but which we still need to handle.
478                     this.pending_manager_events.addAll(orig.pending_manager_events);
479                     if (!this.pending_manager_events.isEmpty()) {
480                         // However, this implies cross_reload_ref_pollution
481                         cross_reload_ref_pollution = true;
482                     }
483                 } catch (ChannelManagerConstructor.InvalidSerializedDataException e) {
484                     assert false;
485                 }
486             } else {
487                 this.router = NetworkGraph.of(new byte[32], this.logger);
488                 this.setup_route_handler();
489                 ChannelMonitor[] monitors = new ChannelMonitor[1];
490                 assert orig.monitors.size() == 1;
491                 if (!break_cross_peer_refs) {
492                     monitors[0] = orig.monitors.values().stream().iterator().next();
493                 } else {
494                     byte[] serialized = orig.monitors.values().stream().iterator().next().write();
495                     Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ res =
496                             UtilMethods.C2Tuple_BlockHashChannelMonitorZ_read(serialized, this.keys_interface);
497                     assert res instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
498                     monitors[0] = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) res).res.get_b();
499                 }
500                 byte[] serialized = orig.chan_manager.write();
501                 Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ read_res =
502                         UtilMethods.C2Tuple_BlockHashChannelManagerZ_read(serialized, this.keys_interface, this.fee_estimator, this.chain_watch, this.tx_broadcaster, this.logger, get_config(), monitors);
503                 assert read_res instanceof Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK;
504                 this.chan_manager = ((Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK) read_res).res.get_b();
505                 this.chain_watch.watch_channel(monitors[0].get_funding_txo().get_a(), monitors[0]);
506                 byte[] random_data = keys_interface.get_secure_random_bytes();
507                 Result_SecretKeyNoneZ node_secret = keys_interface.get_node_secret(Recipient.LDKRecipient_Node);
508                 assert node_secret.is_ok();
509                 this.peer_manager = PeerManager.of(chan_manager.as_ChannelMessageHandler(), route_handler.as_RoutingMessageHandler(),
510                         ((Result_SecretKeyNoneZ.Result_SecretKeyNoneZ_OK)node_secret).res,
511                         random_data, logger, this.custom_message_handler);
512                 if (!break_cross_peer_refs && (use_manual_watch || use_km_wrapper)) {
513                     // When we pass monitors[0] into chain_watch.watch_channel we create a reference from the new Peer to a
514                     // field in the old peer, preventing freeing of the original Peer until the new Peer is freed. Thus, we
515                     // shouldn't bother waiting for the original to be freed later on.
516                     cross_reload_ref_pollution = true;
517                 }
518                 if (use_invoice_payer) {
519                     this.payer = InvoicePayer.of(this.chan_manager.as_Payer(), Router.new_impl(new Router.RouterInterface() {
520                         @Override
521                         public Result_RouteLightningErrorZ find_route(byte[] payer, RouteParameters params, byte[] _payment_hash, ChannelDetails[] first_hops, Score scorer) {
522                             return UtilMethods.find_route(payer, params, router, first_hops, logger, scorer, new byte[32]);
523                         }
524                     }), MultiThreadedLockableScore.of(Score.new_impl(new Score.ScoreInterface() {
525                         @Override public long channel_penalty_msat(long short_channel_id, NodeId source, NodeId target, ChannelUsage usage) { return 0; }
526                         @Override public void payment_path_failed(RouteHop[] path, long scid) {}
527                         @Override public void payment_path_successful(RouteHop[] path) {}
528                         @Override public byte[] write() { assert false; return null; }
529                     })), logger, EventHandler.new_impl(new EventHandler.EventHandlerInterface() {
530                         @Override public void handle_event(Event event) {
531                             synchronized (pending_manager_events) {
532                                 pending_manager_events.add(event);
533                                 pending_manager_events.notifyAll();
534                             }
535                         }
536                     }), Retry.attempts(0));
537                 }
538             }
539             this.node_id = chan_manager.get_our_node_id();
540             bind_nio();
541
542             if (cross_reload_ref_pollution) {
543                 // This really, really needs to be handled at the bindings layer, but its rather complicated -
544                 // ChannelSigners can be cloned and passed around without java being involved, resulting in them being
545                 // owned by both one or more ChannelMonitors and a ChannelManager, with only one having proper pointers
546                 // to the ChannelSigner. Ideally, the ChannelSigner would have a global reference to the Java
547                 // implementation class, but that results in circular references. Instead, we need some ability to,
548                 // while cloning ChannelSigners, add new references in the calling Java struct (ie ChannelMonitor) to
549                 // the ChannelSigner.
550                 this.ptr_to = orig.chan_manager;
551             }
552             this.filter = null;
553         }
554
555         TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ[] connect_block(Block b, int height, long expected_monitor_update_len) {
556             byte[] header = Arrays.copyOfRange(b.bitcoinSerialize(), 0, 80);
557             TwoTuple_usizeTransactionZ[] txn;
558             if (b.hasTransactions()) {
559                 assert b.getTransactions().size() == 1;
560                 TwoTuple_usizeTransactionZ txp = TwoTuple_usizeTransactionZ.of((long) 0, b.getTransactions().get(0).bitcoinSerialize());
561                 txn = new TwoTuple_usizeTransactionZ[]{txp};
562             } else
563                 txn = new TwoTuple_usizeTransactionZ[0];
564             if (chain_monitor != null) {
565                 chan_manager.as_Listen().block_connected(b.bitcoinSerialize(), height);
566                 chain_monitor.as_Listen().block_connected(b.bitcoinSerialize(), height);
567             } else {
568                 chan_manager.as_Confirm().transactions_confirmed(header, txn, height);
569                 chan_manager.as_Confirm().best_block_updated(header, height);
570                 // Connect manually if we aren't using a ChainMonitor and are implementing Watch ourselves
571                 synchronized (monitors) {
572                     assert monitors.size() == 1;
573                     for (ChannelMonitor mon : monitors.values()) {
574                         TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ[] ret = mon.block_connected(header, txn, height, tx_broadcaster, fee_estimator, logger);
575                         assert ret.length == expected_monitor_update_len;
576                         return ret;
577                     }
578                 }
579             }
580             return null;
581         }
582
583         Event[] get_monitor_events(int expected_len) {
584             if (use_chan_manager_constructor) {
585                 while (true) {
586                     synchronized (this.pending_manager_events) {
587                         if (expected_len != 0 && this.pending_manager_events.size() == expected_len) {
588                             break;
589                         }
590                     }
591                     if (expected_len == 0) {
592                         try { Thread.sleep(500); } catch (InterruptedException e) { assert false; }
593                         break;
594                     } else {
595                         Thread.yield();
596                     }
597                 }
598                 synchronized (this.pending_manager_events) {
599                     Event[] res = this.pending_manager_events.toArray(new Event[0]);
600                     this.pending_manager_events.clear();
601                     assert res.length == expected_len;
602                     return res;
603                 }
604             } else if (chain_monitor != null) {
605                 ArrayList<Event> l = new ArrayList<Event>();
606                 chain_monitor.as_EventsProvider().process_pending_events(EventHandler.new_impl(l::add));
607                 assert l.size() == expected_len;
608                 return l.toArray(new Event[0]);
609             } else {
610                 synchronized (monitors) {
611                     assert monitors.size() == 1;
612                     for (ChannelMonitor mon : monitors.values()) {
613                         Event[] res = mon.get_and_clear_pending_events();
614                         assert res.length == expected_len;
615                         return res;
616                     }
617                     return null;
618                 }
619             }
620         }
621
622         Event[] get_manager_events(int expected_len, Peer peer1, Peer peer2) {
623             assert expected_len != 0;
624             if (!use_nio_peer_handler) {
625                 maybe_exchange_peer_messages(peer1, peer2);
626             }
627             Event[] res = new Event[0];
628             if (use_chan_manager_constructor) {
629                 while (res.length < expected_len) {
630                     synchronized (this.pending_manager_events) {
631                         if (this.pending_manager_events.size() >= expected_len) {
632                             res = this.pending_manager_events.toArray(res);
633                             assert res.length == expected_len;
634                             this.pending_manager_events.clear();
635                         }
636                         if (res.length < expected_len) {
637                             try { this.pending_manager_events.wait(); } catch (InterruptedException e) { assert false; }
638                         }
639                     }
640                 }
641             } else {
642                 ArrayList<Event> l = new ArrayList<Event>();
643                 while (l.size() < expected_len) {
644                     Thread.yield();
645                     if (use_nio_peer_handler) {
646                         peer1.nio_peer_handler.check_events();
647                         peer2.nio_peer_handler.check_events();
648                     }
649                     chan_manager.as_EventsProvider().process_pending_events(EventHandler.new_impl(l::add));
650                 }
651                 return l.toArray(new Event[0]);
652             }
653             assert res.length == expected_len;
654             return res;
655         }
656     }
657
658     static class DescriptorHolder { SocketDescriptor val; }
659
660     boolean running = false;
661     final LinkedList<Runnable> runqueue = new LinkedList();
662     boolean ran = false;
663     Thread t = new Thread(() -> {
664             while (true) {
665                 try {
666                     Runnable r;
667                     synchronized (runqueue) {
668                         while (runqueue.isEmpty()) {
669                             runqueue.wait();
670                         }
671                         running = true;
672                         r = runqueue.pollFirst();
673                     }
674                     r.run();
675                     synchronized (runqueue) {
676                         running = false;
677                         runqueue.notifyAll();
678                     }
679                 } catch (InterruptedException e) {
680                     return;
681                 }
682             }
683     });
684
685     void maybe_exchange_peer_messages(Peer peer1, Peer peer2) {
686         if (!use_nio_peer_handler) {
687             while (true) {
688                 peer1.peer_manager.process_events();
689                 peer2.peer_manager.process_events();
690                 synchronized (runqueue) {
691                     if (runqueue.isEmpty() && !running) {
692                         if (ran) {
693                             ran = false;
694                             continue;
695                         } else { break; }
696                     }
697                     try { runqueue.wait(); } catch (InterruptedException e) { assert false; }
698                 }
699             }
700         } else if (!use_chan_manager_constructor) {
701             peer1.nio_peer_handler.check_events();
702             peer2.nio_peer_handler.check_events();
703         }
704     }
705     void do_read_event(PeerManager pm, SocketDescriptor descriptor, byte[] data) {
706         if (!t.isAlive()) t.start();
707         synchronized (runqueue) {
708             ran = true;
709             runqueue.add(() -> {
710                 Result_boolPeerHandleErrorZ res = pm.read_event(descriptor, data);
711                 assert res instanceof Result_boolPeerHandleErrorZ.Result_boolPeerHandleErrorZ_OK;
712             });
713             runqueue.notifyAll();
714         }
715         must_free_objs.add(new WeakReference<>(data));
716     }
717
718     void connect_peers(final Peer peer1, final Peer peer2) {
719         peer2.connected_peer_node_id = peer1.node_id;
720         peer1.connected_peer_node_id = peer2.node_id;
721         if (use_nio_peer_handler) {
722             try {
723                 peer1.nio_peer_handler.connect(peer2.chan_manager.get_our_node_id(), new InetSocketAddress("127.0.0.1", peer2.nio_port), 100);
724             } catch (IOException e) { assert false; }
725             while (peer1.peer_manager.get_peer_node_ids().length == 0 || peer2.peer_manager.get_peer_node_ids().length == 0) {
726                 Thread.yield();
727             }
728         } else {
729             DescriptorHolder descriptor1 = new DescriptorHolder();
730             DescriptorHolder descriptor1ref = descriptor1;
731             SocketDescriptor descriptor2 = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
732                 @Override
733                 public long send_data(byte[] data, boolean resume_read) {
734                     do_read_event(peer1.peer_manager, descriptor1ref.val, data);
735                     return data.length;
736                 }
737
738                 @Override public void disconnect_socket() { assert false; }
739                 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 2; }
740                 @Override public long hash() { return 2; }
741             });
742
743             descriptor1.val = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
744                 @Override
745                 public long send_data(byte[] data, boolean resume_read) {
746                     do_read_event(peer2.peer_manager, descriptor2, data);
747                     return data.length;
748                 }
749
750                 @Override public void disconnect_socket() { assert false; }
751                 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 1; }
752                 @Override public long hash() { return 1; }
753             });
754
755             Result_CVec_u8ZPeerHandleErrorZ conn_res = peer1.peer_manager.new_outbound_connection(peer2.node_id, descriptor1.val, Option_NetAddressZ.none());
756             assert conn_res instanceof Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK;
757
758             Result_NonePeerHandleErrorZ inbound_conn_res = peer2.peer_manager.new_inbound_connection(descriptor2, Option_NetAddressZ.none());
759             assert inbound_conn_res instanceof Result_NonePeerHandleErrorZ.Result_NonePeerHandleErrorZ_OK;
760             do_read_event(peer2.peer_manager, descriptor2, ((Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK) conn_res).res);
761
762             maybe_exchange_peer_messages(peer1, peer2);
763         }
764     }
765
766     TestState do_test_message_handler() throws InterruptedException {
767         Peer peer1 = new Peer((byte) 1);
768         Peer peer2 = new Peer((byte) 2);
769
770         connect_peers(peer1, peer2);
771
772         Result__u832APIErrorZ cc_res = peer1.chan_manager.create_channel(peer2.node_id, 100000, 1000, 42, null);
773         assert cc_res instanceof Result__u832APIErrorZ.Result__u832APIErrorZ_OK;
774
775         // Previously, this was a SEGFAULT instead of get_funding_txo() returning null.
776         ChannelDetails pre_funding_chan = peer1.chan_manager.list_channels()[0];
777         assert pre_funding_chan.get_funding_txo() == null;
778
779         Event[] events = peer1.get_manager_events(1, peer1, peer2);
780         assert events[0] instanceof Event.FundingGenerationReady;
781         assert ((Event.FundingGenerationReady) events[0]).channel_value_satoshis == 100000;
782         assert ((Event.FundingGenerationReady) events[0]).user_channel_id == 42;
783         byte[] funding_spk = ((Event.FundingGenerationReady) events[0]).output_script;
784         assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
785         byte[] chan_id = ((Event.FundingGenerationReady) events[0]).temporary_channel_id;
786
787         NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
788
789         Transaction funding = new Transaction(bitcoinj_net);
790         funding.addInput(new TransactionInput(bitcoinj_net, funding, new byte[0]));
791         funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
792         funding.getInput(0).getWitness().setPush(0, new byte[]{0x1});
793         funding.addOutput(Coin.SATOSHI.multiply(100000), new Script(funding_spk));
794         Result_NoneAPIErrorZ funding_res = peer1.chan_manager.funding_transaction_generated(chan_id, peer2.node_id, funding.bitcoinSerialize());
795         assert funding_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
796
797         gossip_txout = new TxOut(100000, funding_spk);
798
799         maybe_exchange_peer_messages(peer1, peer2);
800         synchronized (peer1.broadcast_set) {
801             while (peer1.broadcast_set.size() != 1) {
802                 peer1.broadcast_set.wait();
803             }
804         }
805
806         assert peer1.broadcast_set.size() == 1;
807         assert Arrays.equals(peer1.broadcast_set.get(0), funding.bitcoinSerialize());
808         peer1.broadcast_set.clear();
809
810         Block b = new Block(bitcoinj_net, 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
811         peer1.connect_block(b, 1, 0);
812         peer2.connect_block(b, 1, 0);
813
814         for (int height = 2; height < 10; height++) {
815             b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[0]));
816             peer1.connect_block(b, height, 0);
817             peer2.connect_block(b, height, 0);
818         }
819
820         maybe_exchange_peer_messages(peer1, peer2);
821         while (peer1.chan_manager.list_usable_channels().length != 1 || peer2.chan_manager.list_usable_channels().length != 1)
822
823         peer1.chan_manager.list_channels();
824         ChannelDetails[] peer1_chans = peer1.chan_manager.list_usable_channels();
825         ChannelDetails[] peer2_chans = peer2.chan_manager.list_usable_channels();
826         assert peer1_chans.length == 1;
827         assert peer2_chans.length == 1;
828         assert peer1_chans[0].get_channel_value_satoshis() == 100000;
829         assert peer1_chans[0].get_is_usable();
830         Option_u64Z short_chan_id = peer1_chans[0].get_short_channel_id();
831         assert short_chan_id instanceof Option_u64Z.Some;
832         assert ((Option_u64Z.Some)short_chan_id).some == (1L << 40); // 0th output in the 0th transaction in the 1st block
833         assert Arrays.equals(peer1_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
834         assert Arrays.equals(peer2_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
835
836         Result_InvoiceSignOrCreationErrorZ invoice = UtilMethods.create_invoice_from_channelmanager(peer2.chan_manager, peer2.keys_interface, Currency.LDKCurrency_Bitcoin, Option_u64Z.some(10000000), "Invoice Description", 7200);
837         assert invoice instanceof Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK;
838         System.out.println("Got invoice: " + ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
839
840         Result_InvoiceParseOrSemanticErrorZ parsed_invoice = Invoice.from_str(((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
841         assert parsed_invoice instanceof Result_InvoiceParseOrSemanticErrorZ.Result_InvoiceParseOrSemanticErrorZ_OK;
842         assert Arrays.equals(((Result_InvoiceParseOrSemanticErrorZ.Result_InvoiceParseOrSemanticErrorZ_OK) parsed_invoice).res.payment_hash(), ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash());
843         SignedRawInvoice signed_raw = ((Result_InvoiceParseOrSemanticErrorZ.Result_InvoiceParseOrSemanticErrorZ_OK) parsed_invoice).res.into_signed_raw();
844         RawInvoice raw_invoice = signed_raw.raw_invoice();
845         byte[] desc_hash = raw_invoice.hash();
846         Description raw_invoice_description = raw_invoice.description();
847         String description_string = raw_invoice_description.into_inner();
848         assert description_string.equals("Invoice Description");
849
850         if (!use_invoice_payer) {
851             byte[] payment_hash = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash();
852             byte[] payment_secret = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_secret();
853             byte[] dest_node_id = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.recover_payee_pub_key();
854             assert Arrays.equals(dest_node_id, peer2.node_id);
855             InvoiceFeatures invoice_features = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.features();
856             RouteHint[] route_hints = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.route_hints();
857
858             PaymentParameters payee = PaymentParameters.of(peer2.node_id, invoice_features, route_hints, Option_u64Z.none(), 6*24*14);
859             RouteParameters route_params = RouteParameters.of(payee, 10000000, 42);
860             Result_RouteLightningErrorZ route_res = UtilMethods.find_route(
861                     peer1.chan_manager.get_our_node_id(), route_params, peer1.router,
862                     peer1_chans, peer1.logger, ProbabilisticScorer.of(ProbabilisticScoringParameters.with_default(), peer1.router, peer1.logger).as_Score(), new byte[32]);
863             assert route_res instanceof Result_RouteLightningErrorZ.Result_RouteLightningErrorZ_OK;
864             Route route = ((Result_RouteLightningErrorZ.Result_RouteLightningErrorZ_OK) route_res).res;
865             assert route.get_paths().length == 1;
866             assert route.get_paths()[0].length == 1;
867             assert route.get_paths()[0][0].get_fee_msat() == 10000000;
868
869             Result_PaymentIdPaymentSendFailureZ payment_res = peer1.chan_manager.send_payment(route, payment_hash, payment_secret);
870             assert payment_res instanceof Result_PaymentIdPaymentSendFailureZ.Result_PaymentIdPaymentSendFailureZ_OK;
871
872             RouteHop[][] hops = new RouteHop[1][1];
873             byte[] hop_pubkey = new byte[33];
874             hop_pubkey[0] = 3;
875             hop_pubkey[1] = 42;
876             hops[0][0] = RouteHop.of(hop_pubkey, NodeFeatures.known(), 42, ChannelFeatures.known(), 100, 0);
877             Route r2 = Route.of(hops, payee);
878             payment_res = peer1.chan_manager.send_payment(r2, payment_hash, payment_secret);
879             assert payment_res instanceof Result_PaymentIdPaymentSendFailureZ.Result_PaymentIdPaymentSendFailureZ_Err;
880         } else {
881             Result_PaymentIdPaymentErrorZ send_res = peer1.payer.pay_invoice(((Result_InvoiceParseOrSemanticErrorZ.Result_InvoiceParseOrSemanticErrorZ_OK) parsed_invoice).res);
882             assert send_res instanceof Result_PaymentIdPaymentErrorZ.Result_PaymentIdPaymentErrorZ_OK;
883         }
884
885         if (reload_peers) {
886             if (use_chan_manager_constructor) {
887                 peer1.constructor.interrupt();
888                 peer2.constructor.interrupt();
889             } else if (use_nio_peer_handler) {
890                 peer1.nio_peer_handler.interrupt();
891                 peer2.nio_peer_handler.interrupt();
892             }
893             WeakReference<Peer> op1 = new WeakReference<Peer>(peer1);
894             peer1 = new Peer(peer1);
895             peer2 = new Peer(peer2);
896             return new TestState(op1, peer1, peer2, b.getHash());
897         }
898         return new TestState(null, peer1, peer2, b.getHash());
899     }
900
901     boolean cross_reload_ref_pollution = false;
902     class TestState {
903         private final WeakReference<Peer> ref_block;
904         private final Peer peer1;
905         private final Peer peer2;
906         public Sha256Hash best_blockhash;
907
908         public TestState(WeakReference<Peer> ref_block, Peer peer1, Peer peer2, Sha256Hash best_blockhash) {
909             this.ref_block = ref_block;
910             this.peer1 = peer1;
911             this.peer2 = peer2;
912             this.best_blockhash = best_blockhash;
913         }
914     }
915     void do_test_message_handler_b(TestState state) throws InterruptedException {
916         GcCheck obj = new GcCheck();
917         if (state.ref_block != null) {
918             // Ensure the original peers get freed before we move on. Note that we have to be in a different function
919             // scope to do so as the (at least current OpenJDK) JRE won't release anything created in the same scope.
920             while (!cross_reload_ref_pollution && state.ref_block.get() != null) {
921                 System.gc();
922                 System.runFinalization();
923             }
924             connect_peers(state.peer1, state.peer2);
925         }
926
927         Event[] events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
928         assert events[0] instanceof Event.PendingHTLCsForwardable;
929         state.peer2.chan_manager.process_pending_htlc_forwards();
930
931         events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
932         assert events[0] instanceof Event.PaymentReceived;
933         assert ((Event.PaymentReceived)events[0]).purpose instanceof PaymentPurpose.InvoicePayment;
934         byte[] payment_preimage = ((PaymentPurpose.InvoicePayment)((Event.PaymentReceived)events[0]).purpose).payment_preimage;
935         assert !Arrays.equals(payment_preimage, new byte[32]);
936         state.peer2.chan_manager.claim_funds(payment_preimage);
937
938         events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
939         assert events[0] instanceof Event.PaymentClaimed;
940         assert ((Event.PaymentClaimed)events[0]).purpose instanceof PaymentPurpose.InvoicePayment;
941         payment_preimage = ((PaymentPurpose.InvoicePayment)((Event.PaymentClaimed)events[0]).purpose).payment_preimage;
942         assert !Arrays.equals(payment_preimage, new byte[32]);
943
944         events = state.peer1.get_manager_events(2, state.peer1, state.peer2);
945         assert events[0] instanceof Event.PaymentSent;
946         assert Arrays.equals(((Event.PaymentSent) events[0]).payment_preimage, payment_preimage);
947         assert events[1] instanceof Event.PaymentPathSuccessful;
948         assert Arrays.equals(((Event.PaymentPathSuccessful) events[1]).payment_hash, ((Event.PaymentSent) events[0]).payment_hash);
949
950         if (use_nio_peer_handler) {
951             // We receive PaymentSent immediately upon receipt of the payment preimage, but we expect to not have an
952             // HTLC transaction to broadcast below, which requires a bit more time to fully complete the
953             // commitment-transaction-update dance between both peers.
954             Thread.sleep(100);
955         }
956
957         if (state.peer1.chain_monitor != null) {
958             Balance[] peer1_balances = state.peer1.chain_monitor.get_claimable_balances(state.peer1.chan_manager.list_channels());
959             assert peer1_balances.length == 0;
960             Balance[] peer2_balances = state.peer2.chain_monitor.get_claimable_balances(state.peer2.chan_manager.list_channels());
961             assert peer2_balances.length == 0;
962         }
963
964         ChannelDetails[] peer1_chans = state.peer1.chan_manager.list_channels();
965
966         if (nice_close) {
967             Result_NoneAPIErrorZ close_res = state.peer1.chan_manager.close_channel(peer1_chans[0].get_channel_id(), state.peer2.node_id);
968             assert close_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
969             maybe_exchange_peer_messages(state.peer1, state.peer2);
970             synchronized (state.peer1.broadcast_set) {
971                 while (state.peer1.broadcast_set.size() != 1) state.peer1.broadcast_set.wait();
972             }
973             synchronized (state.peer2.broadcast_set) {
974                 while (state.peer2.broadcast_set.size() != 1) state.peer2.broadcast_set.wait();
975             }
976         } else {
977             state.peer1.chan_manager.force_close_all_channels();
978             maybe_exchange_peer_messages(state.peer1, state.peer2);
979             synchronized (state.peer1.broadcast_set) {
980                 while (state.peer1.broadcast_set.size() != 1) state.peer1.broadcast_set.wait();
981             }
982             synchronized (state.peer2.broadcast_set) {
983                 while (state.peer2.broadcast_set.size() != 1) state.peer2.broadcast_set.wait();
984             }
985         }
986
987         assert state.peer1.broadcast_set.size() == 1;
988         assert state.peer2.broadcast_set.size() == 1;
989
990         events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
991         assert events[0] instanceof Event.ChannelClosed;
992         events = state.peer1.get_manager_events(1, state.peer1, state.peer2);
993         assert events[0] instanceof Event.ChannelClosed;
994
995         if (state.peer1.chain_monitor != null) {
996             Balance[] peer1_balances = state.peer1.chain_monitor.get_claimable_balances(state.peer1.chan_manager.list_channels());
997             assert peer1_balances.length == 1;
998             for (Balance bal : peer1_balances) {
999                 assert bal instanceof Balance.ClaimableOnChannelClose;
1000                 long expected_tx_fee = 183;
1001                 assert ((Balance.ClaimableOnChannelClose) bal).claimable_amount_satoshis == 100000 - 1 - 10000 - expected_tx_fee;
1002             }
1003             Balance[] peer2_balances = state.peer2.chain_monitor.get_claimable_balances(state.peer2.chan_manager.list_channels());
1004             assert peer2_balances.length == 1;
1005             for (Balance bal : peer2_balances) {
1006                 assert bal instanceof Balance.ClaimableOnChannelClose;
1007                 assert ((Balance.ClaimableOnChannelClose) bal).claimable_amount_satoshis == 10000 + 1;
1008             }
1009         }
1010
1011         if (!nice_close) {
1012             NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
1013             Transaction tx = new Transaction(bitcoinj_net, state.peer1.broadcast_set.getFirst());
1014             Block b = new Block(bitcoinj_net, 2, state.best_blockhash, Sha256Hash.ZERO_HASH, 42, 0, 0,
1015                     Arrays.asList(new Transaction[]{tx}));
1016             TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ[] watch_outputs = state.peer2.connect_block(b, 10, 1);
1017             if (watch_outputs != null) { // We only process watch_outputs manually when we use a manually-build Watch impl
1018                 assert watch_outputs.length == 1;
1019                 assert Arrays.equals(watch_outputs[0].get_a(), tx.getTxId().getReversedBytes());
1020                 assert watch_outputs[0].get_b().length == 2;
1021                 assert watch_outputs[0].get_b()[0].get_a() == 0;
1022                 assert watch_outputs[0].get_b()[1].get_a() == 1;
1023             }
1024
1025             for (int i = 11; i < 21; i++) {
1026                 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, new ArrayList<>());
1027                 state.peer2.connect_block(b, i, 0);
1028             }
1029
1030             Event[] broadcastable_event = state.peer2.get_monitor_events(1);
1031             for (ChannelMonitor mon : state.peer2.monitors.values()) {
1032                 // This used to be buggy and double-free, so go ahead and fetch them!
1033                 byte[][] txn = mon.get_latest_holder_commitment_txn(state.peer2.logger);
1034             }
1035             assert broadcastable_event.length == 1;
1036             assert broadcastable_event[0] instanceof Event.SpendableOutputs;
1037             if (state.peer2.explicit_keys_manager != null) {
1038                 TxOut[] additional_outputs = new TxOut[]{new TxOut(420, new byte[]{0x42})};
1039                 Result_TransactionNoneZ tx_res = state.peer2.explicit_keys_manager.spend_spendable_outputs(((Event.SpendableOutputs) broadcastable_event[0]).outputs, additional_outputs, new byte[]{0x00}, 253);
1040                 assert tx_res instanceof Result_TransactionNoneZ.Result_TransactionNoneZ_OK;
1041                 Transaction built_tx = new Transaction(bitcoinj_net, ((Result_TransactionNoneZ.Result_TransactionNoneZ_OK) tx_res).res);
1042                 assert built_tx.getOutputs().size() == 2;
1043                 assert Arrays.equals(built_tx.getOutput(1).getScriptBytes(), new byte[]{0x00});
1044                 assert Arrays.equals(built_tx.getOutput(0).getScriptBytes(), new byte[]{0x42});
1045                 assert built_tx.getOutput(0).getValue().value == 420;
1046             }
1047         }
1048
1049         // Test exchanging a custom message (note that ChannelManagerConstructor) always loads an IgnorimgMessageHandler
1050         // so we cannot exchange custom messages with it
1051         if (!use_chan_manager_constructor) {
1052             byte[] custom_message_bytes = new byte[]{0x42, 0x44, 0x43, 0x00};
1053             state.peer1.custom_messages_to_send.add(custom_message_bytes);
1054             state.peer1.peer_manager.process_events();
1055             synchronized (state.peer2.received_custom_messages) {
1056                 while (true) {
1057                     if (state.peer2.received_custom_messages.isEmpty()) {
1058                         state.peer2.received_custom_messages.wait();
1059                         continue;
1060                     }
1061                     assert state.peer2.received_custom_messages.size() == 1;
1062                     assert Arrays.equals(state.peer2.received_custom_messages.get(0), custom_message_bytes);
1063                     break;
1064                 }
1065             }
1066         }
1067
1068         if (use_nio_peer_handler) {
1069             state.peer1.peer_manager.disconnect_by_node_id(state.peer2.chan_manager.get_our_node_id(), false);
1070             while (state.peer1.peer_manager.get_peer_node_ids().length != 0) Thread.yield();
1071             while (state.peer2.peer_manager.get_peer_node_ids().length != 0) Thread.yield();
1072             state.peer1.nio_peer_handler.interrupt();
1073             state.peer2.nio_peer_handler.interrupt();
1074         }
1075
1076         state.peer1.get_monitor_events(0);
1077         state.peer2.get_monitor_events(0);
1078
1079         if (use_chan_manager_constructor) {
1080             state.peer1.constructor.interrupt();
1081             state.peer2.constructor.interrupt();
1082         }
1083
1084         t.interrupt();
1085
1086         if (state.peer1.router != null)
1087             state.peer1.router.write();
1088
1089         // Construct the only Option_Enum::Variant(OpaqueStruct) we have in the codebase as this used to cause double-frees:
1090         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,};
1091         Result_ChannelUpdateDecodeErrorZ upd_msg = ChannelUpdate.read(serd);
1092         assert upd_msg instanceof Result_ChannelUpdateDecodeErrorZ.Result_ChannelUpdateDecodeErrorZ_OK;
1093         Option_NetworkUpdateZ upd = Option_NetworkUpdateZ.some(NetworkUpdate.channel_update_message(((Result_ChannelUpdateDecodeErrorZ.Result_ChannelUpdateDecodeErrorZ_OK) upd_msg).res));
1094     }
1095
1096     java.util.LinkedList<WeakReference<Object>> must_free_objs = new java.util.LinkedList();
1097     int gc_count = 0;
1098     int gc_exp_count = 0;
1099     class GcCheck {
1100         GcCheck() { gc_exp_count += 1; }
1101         @Override
1102         protected void finalize() throws Throwable {
1103             gc_count += 1;
1104             super.finalize();
1105         }
1106     }
1107 }
1108 public class HumanObjectPeerTest {
1109     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 {
1110         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);
1111         HumanObjectPeerTestInstance.TestState state = instance.do_test_message_handler();
1112         instance.do_test_message_handler_b(state);
1113         return instance;
1114     }
1115     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 {
1116         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);
1117         while (instance.gc_count != instance.gc_exp_count) {
1118             System.gc();
1119             System.runFinalization();
1120         }
1121         for (WeakReference<Object> o : instance.must_free_objs)
1122             assert o.get() == null;
1123     }
1124     public static final int TEST_ITERATIONS = (1 << 9);
1125     public static void do_test_message_handler(IntConsumer statusFunction) throws InterruptedException {
1126         Thread gc_thread = new Thread(() -> {
1127             while (true) {
1128                 System.gc();
1129                 System.runFinalization();
1130                 try { Thread.sleep(0, 1); } catch (InterruptedException e) { break; }
1131             }
1132         }, "Test GC Thread");
1133         gc_thread.start();
1134         for (int i = 0; i < TEST_ITERATIONS; i++) {
1135             boolean nice_close =                   (i & (1 << 0)) != 0;
1136             boolean use_km_wrapper =               (i & (1 << 1)) != 0;
1137             boolean use_manual_watch =             (i & (1 << 2)) != 0;
1138             boolean reload_peers =                 (i & (1 << 3)) != 0;
1139             boolean break_cross_refs =             (i & (1 << 4)) != 0;
1140             boolean use_ignoring_routing_handler = (i & (1 << 5)) != 0;
1141             boolean use_chan_manager_constructor = (i & (1 << 6)) != 0;
1142             boolean use_invoice_payer =            (i & (1 << 7)) != 0;
1143             boolean nio_peer_handler =             (i & (1 << 8)) != 0;
1144             if (break_cross_refs && !reload_peers) {
1145                 // There are no cross refs to break without reloading peers.
1146                 continue;
1147             }
1148             if (use_chan_manager_constructor && (use_manual_watch || !nio_peer_handler)) {
1149                 // ChannelManagerConstructor requires a ChainMonitor as the Watch and creates a NioPeerHandler for us.
1150                 continue;
1151             }
1152             if (!use_chan_manager_constructor && (use_ignoring_routing_handler)) {
1153                 // We rely on the ChannelManagerConstructor to convert null into an IgnoringMessageHandler, so don't
1154                 // try to run with an IgnoringMessageHandler unless we're also using a ChannelManagerConstructor.
1155                 continue;
1156             }
1157             if (use_chan_manager_constructor && use_ignoring_routing_handler && use_invoice_payer) {
1158                 // As documented on ChannelManagerConstructor, if we provide a `null` NetworkGraph (because we want to
1159                 // use an IgnoringMessageHandler), no InvoicePayer will be constructored for us, thus we cannot use an
1160                 // InvoicePayer to send payments in this case.
1161                 continue;
1162             }
1163             statusFunction.accept(i);
1164             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);
1165         }
1166         gc_thread.interrupt();
1167         gc_thread.join();
1168     }
1169     @Test
1170     public void test_message_handler() throws InterruptedException {
1171         do_test_message_handler(i -> System.err.println("Running test with flags " + i));
1172     }
1173
1174     // This is used in the test jar to test the built jar is runnable
1175     public static void main(String[] args) {
1176         try {
1177             do_test_message_handler(i -> System.err.println("Running test with flags " + i));
1178         } catch (Exception e) {
1179             System.err.println("Caught exception:");
1180             System.err.println(e);
1181             System.exit(1);
1182         }
1183     }
1184 }