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