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