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