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