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.AccessError;
9 import org.ldk.enums.Currency;
10 import org.ldk.enums.Network;
11 import org.ldk.structs.*;
12 import org.ldk.util.TwoTuple;
14 import java.io.IOException;
15 import java.lang.ref.WeakReference;
16 import java.net.InetSocketAddress;
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;
30 HumanObjectPeerTestInstance(boolean nice_close, boolean use_km_wrapper, boolean use_manual_watch, boolean reload_peers, boolean break_cross_peer_refs, boolean use_nio_peer_handler, boolean use_filter, boolean use_ignore_handler, boolean use_chan_manager_constructor) {
31 this.nice_close = nice_close;
32 this.use_km_wrapper = use_km_wrapper;
33 this.use_manual_watch = use_manual_watch;
34 this.reload_peers = reload_peers;
35 this.break_cross_peer_refs = break_cross_peer_refs;
36 this.use_nio_peer_handler = use_nio_peer_handler;
37 this.use_filter = use_filter;
38 this.use_ignore_handler = use_ignore_handler;
39 this.use_chan_manager_constructor = use_chan_manager_constructor;
43 KeysInterface manual_keysif(KeysInterface underlying_if) {
44 return KeysInterface.new_impl(new KeysInterface.KeysInterfaceInterface() {
45 @Override public byte[] get_node_secret() { return underlying_if.get_node_secret(); }
46 @Override public byte[] get_destination_script() { return underlying_if.get_destination_script(); }
47 @Override public ShutdownScript get_shutdown_scriptpubkey() { return underlying_if.get_shutdown_scriptpubkey(); }
50 public Sign get_channel_signer(boolean inbound, long channel_value_satoshis) {
51 Sign underlying_ck = underlying_if.get_channel_signer(inbound, channel_value_satoshis);
52 BaseSign underlying_base = underlying_ck.get_base_sign();
53 BaseSign.BaseSignInterface bsi = new BaseSign.BaseSignInterface() {
54 @Override public byte[] get_per_commitment_point(long idx) {
55 return underlying_base.get_per_commitment_point(idx);
57 @Override public byte[] release_commitment_secret(long idx) {
58 return underlying_base.release_commitment_secret(idx);
60 @Override public Result_NoneNoneZ validate_holder_commitment(HolderCommitmentTransaction holder_tx) {
61 return underlying_base.validate_holder_commitment(holder_tx);
63 @Override public byte[] channel_keys_id() {
66 @Override public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_counterparty_commitment(CommitmentTransaction commitment_tx) {
67 return underlying_base.sign_counterparty_commitment(commitment_tx);
69 @Override public Result_NoneNoneZ validate_counterparty_revocation(long idx, byte[] secret) {
70 return underlying_base.validate_counterparty_revocation(idx, secret);
72 @Override public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_holder_commitment_and_htlcs(HolderCommitmentTransaction holder_commitment_tx) {
73 return underlying_base.sign_holder_commitment_and_htlcs(holder_commitment_tx);
75 @Override public Result_SignatureNoneZ sign_justice_revoked_output(byte[] justice_tx, long input, long amount, byte[] per_commitment_key) {
76 return underlying_base.sign_justice_revoked_output(justice_tx, input, amount, per_commitment_key);
78 @Override public Result_SignatureNoneZ sign_justice_revoked_htlc(byte[] justice_tx, long input, long amount, byte[] per_commitment_key, HTLCOutputInCommitment htlc) {
79 return underlying_base.sign_justice_revoked_htlc(justice_tx, input, amount, per_commitment_key, htlc);
81 @Override public Result_SignatureNoneZ sign_counterparty_htlc_transaction(byte[] htlc_tx, long input, long amount, byte[] per_commitment_point, HTLCOutputInCommitment htlc) {
82 return underlying_base.sign_counterparty_htlc_transaction(htlc_tx, input, amount, per_commitment_point, htlc);
84 @Override public Result_SignatureNoneZ sign_closing_transaction(ClosingTransaction closing_tx) {
85 return underlying_base.sign_closing_transaction(closing_tx);
87 @Override public Result_SignatureNoneZ sign_channel_announcement(UnsignedChannelAnnouncement msg) {
88 return underlying_base.sign_channel_announcement(msg);
90 @Override public void ready_channel(ChannelTransactionParameters params) {
91 underlying_base.ready_channel(params);
94 Sign.SignInterface si = new Sign.SignInterface() {
96 public byte[] write() {
97 return underlying_ck.write();
100 Sign resp = Sign.new_impl(si, bsi, underlying_base.get_pubkeys());
101 must_free_objs.add(new WeakReference<>(si));
102 must_free_objs.add(new WeakReference<>(bsi));
103 must_free_objs.add(new WeakReference<>(resp));
104 must_free_objs.add(new WeakReference<>(underlying_base));
105 must_free_objs.add(new WeakReference<>(underlying_ck));
110 public byte[] get_secure_random_bytes() {
111 return underlying_if.get_secure_random_bytes();
115 public Result_SignDecodeErrorZ read_chan_signer(byte[] reader) {
116 return underlying_if.read_chan_signer(reader);
120 public Result_RecoverableSignatureNoneZ sign_invoice(byte[] invoice_preimage) {
121 return underlying_if.sign_invoice(invoice_preimage);
126 Watch get_manual_watch() {
127 Watch.WatchInterface watch_impl = new Watch.WatchInterface() {
128 public Result_NoneChannelMonitorUpdateErrZ watch_channel(OutPoint funding_txo, ChannelMonitor monitor) {
129 synchronized (monitors) {
130 assert monitors.put(Arrays.toString(funding_txo.get_txid()), monitor) == null;
132 return Result_NoneChannelMonitorUpdateErrZ.ok();
135 public Result_NoneChannelMonitorUpdateErrZ update_channel(OutPoint funding_txo, ChannelMonitorUpdate update) {
136 synchronized (monitors) {
137 String txid = Arrays.toString(funding_txo.get_txid());
138 assert monitors.containsKey(txid);
139 Result_NoneMonitorUpdateErrorZ update_res = monitors.get(txid).update_monitor(update, tx_broadcaster, fee_estimator, logger);
140 assert update_res instanceof Result_NoneMonitorUpdateErrorZ.Result_NoneMonitorUpdateErrorZ_OK;
142 return Result_NoneChannelMonitorUpdateErrZ.ok();
146 public MonitorEvent[] release_pending_monitor_events() {
147 synchronized (monitors) {
148 assert monitors.size() <= 1;
149 for (ChannelMonitor mon : monitors.values()) {
150 return mon.get_and_clear_pending_monitor_events();
153 return new MonitorEvent[0];
156 Watch watch = Watch.new_impl(watch_impl);
157 must_free_objs.add(new WeakReference<>(watch_impl));
158 must_free_objs.add(new WeakReference<>(watch));
162 NioPeerHandler nio_peer_handler;
166 final FeeEstimator fee_estimator;
167 final BroadcasterInterface tx_broadcaster;
168 final KeysManager explicit_keys_manager;
169 final KeysInterface keys_interface;
170 final ChainMonitor chain_monitor;
171 final NetGraphMsgHandler router;
172 final Watch chain_watch;
173 final HashSet<String> filter_additions;
174 final Option_FilterZ filter;
175 ChannelManager chan_manager;
176 PeerManager peer_manager;
177 final HashMap<String, ChannelMonitor> monitors; // Wow I forgot just how terrible Java is - we can't put a byte array here.
179 final LinkedList<byte[]> broadcast_set = new LinkedList<>();
180 final LinkedList<Event> pending_manager_events = new LinkedList<>();
181 ChannelManagerConstructor constructor = null;
182 GcCheck obj = new GcCheck();
184 private TwoTuple<OutPoint, byte[]> test_mon_roundtrip(ChannelMonitor mon) {
185 // Because get_funding_txo() returns an OutPoint in a tuple that is a reference to an OutPoint inside the
186 // ChannelMonitor, its a good test to ensure that the OutPoint isn't freed (or is cloned) before the
187 // ChannelMonitor is. This used to be broken.
188 Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ roundtrip_monitor = UtilMethods.BlockHashChannelMonitorZ_read(mon.write(), keys_interface);
189 assert roundtrip_monitor instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
190 TwoTuple<OutPoint, byte[]> funding_txo = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_monitor).res.b.get_funding_txo();
191 System.gc(); System.runFinalization(); // Give the GC a chance to run.
195 private Peer(Object _dummy, byte seed) {
196 logger = Logger.new_impl((String arg) -> System.out.println(seed + ": " + arg));
197 fee_estimator = FeeEstimator.new_impl((confirmation_target -> 253));
198 tx_broadcaster = BroadcasterInterface.new_impl(tx -> {
199 synchronized (broadcast_set) {
200 broadcast_set.add(tx);
201 broadcast_set.notifyAll();
204 monitors = new HashMap<>();
206 Persist persister = Persist.new_impl(new Persist.PersistInterface() {
208 public Result_NoneChannelMonitorUpdateErrZ persist_new_channel(OutPoint id, ChannelMonitor data) {
209 synchronized (monitors) {
210 String key = Arrays.toString(id.to_channel_id());
211 assert monitors.put(key, data) == null;
212 TwoTuple<OutPoint, byte[]> res = test_mon_roundtrip(data);
213 assert Arrays.equals(res.a.get_txid(), id.get_txid());
214 assert res.a.get_index() == id.get_index();
216 return Result_NoneChannelMonitorUpdateErrZ.ok();
220 public Result_NoneChannelMonitorUpdateErrZ update_persisted_channel(OutPoint id, ChannelMonitorUpdate update, ChannelMonitor data) {
221 synchronized (monitors) {
222 String key = Arrays.toString(id.to_channel_id());
223 assert monitors.put(key, data) != null;
224 TwoTuple<OutPoint, byte[]> res = test_mon_roundtrip(data);
225 assert Arrays.equals(res.a.get_txid(), id.get_txid());
226 assert res.a.get_index() == id.get_index();
228 return Result_NoneChannelMonitorUpdateErrZ.ok();
232 filter_additions = new HashSet<>();
234 this.filter = Option_FilterZ.some(Filter.new_impl(new Filter.FilterInterface() {
235 @Override public void register_tx(byte[] txid, byte[] script_pubkey) {
236 filter_additions.add(Arrays.toString(txid));
238 @Override public Option_C2Tuple_usizeTransactionZZ register_output(WatchedOutput output) {
239 filter_additions.add(Arrays.toString(output.get_outpoint().get_txid()) + ":" + output.get_outpoint().get_index());
240 return Option_C2Tuple_usizeTransactionZZ.none();
244 this.filter = Option_FilterZ.none();
247 if (use_manual_watch) {
248 chain_watch = get_manual_watch();
249 chain_monitor = null;
251 chain_monitor = ChainMonitor.of(filter, tx_broadcaster, logger, fee_estimator, persister);
252 chain_watch = chain_monitor.as_Watch();
255 byte[] key_seed = new byte[32];
256 for (byte i = 0; i < 32; i++) {
257 key_seed[i] = (byte) (i ^ seed);
259 KeysManager keys = KeysManager.of(key_seed, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000));
260 if (use_km_wrapper) {
261 this.keys_interface = manual_keysif(keys.as_KeysInterface());
262 this.explicit_keys_manager = null;
264 this.keys_interface = keys.as_KeysInterface();
265 this.explicit_keys_manager = keys;
267 this.router = NetGraphMsgHandler.of(new byte[32], Option_AccessZ.none(), logger);
269 private void bind_nio() {
270 if (!use_nio_peer_handler) return;
271 if (use_chan_manager_constructor) {
272 this.nio_peer_handler = this.constructor.nio_peer_handler;
274 try { this.nio_peer_handler = new NioPeerHandler(peer_manager); } catch (IOException e) { assert false; }
276 for (short i = 10_000; true; i++) {
278 nio_peer_handler.bind_listener(new InetSocketAddress("127.0.0.1", i));
281 } catch (IOException e) { assert i < 10_500; }
286 if (use_chan_manager_constructor) {
287 NetGraphMsgHandler route_handler = null;
288 if (!use_ignore_handler) {
289 route_handler = router;
291 this.constructor = new ChannelManagerConstructor(Network.LDKNetwork_Bitcoin, UserConfig.with_default(), new byte[32], 0,
292 this.keys_interface, this.fee_estimator, this.chain_monitor, route_handler, this.tx_broadcaster, this.logger);
293 constructor.chain_sync_completed(new ChannelManagerConstructor.EventHandler() {
294 @Override public void handle_event(Event event) {
295 synchronized (pending_manager_events) {
296 pending_manager_events.add(event);
297 pending_manager_events.notifyAll();
300 @Override public void persist_manager(byte[] channel_manager_bytes) { assert channel_manager_bytes.length > 1; }
302 this.chan_manager = constructor.channel_manager;
303 this.peer_manager = constructor.peer_manager;
304 must_free_objs.add(new WeakReference<>(this.chan_manager));
306 ChainParameters params = ChainParameters.of(Network.LDKNetwork_Bitcoin, BestBlock.of(new byte[32], 0));
307 this.chan_manager = ChannelManager.of(this.fee_estimator, chain_watch, tx_broadcaster, logger, this.keys_interface, UserConfig.with_default(), params);
308 byte[] random_data = keys_interface.get_secure_random_bytes();
309 this.peer_manager = PeerManager.of(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger, IgnoringMessageHandler.of().as_CustomMessageHandler());
312 this.node_id = chan_manager.get_our_node_id();
319 this(null, orig.seed);
320 if (use_chan_manager_constructor) {
321 byte[][] monitors = {orig.monitors.values().stream().iterator().next().write()};
322 byte[] serialized = orig.chan_manager.write();
324 Filter filter_nullable = null;
325 if (this.filter instanceof Option_FilterZ.Some) {
326 filter_nullable = ((Option_FilterZ.Some) this.filter).some;
328 this.constructor = new ChannelManagerConstructor(serialized, monitors, this.keys_interface,
329 this.fee_estimator, this.chain_monitor, filter_nullable, this.router, this.tx_broadcaster, this.logger);
330 constructor.chain_sync_completed(new ChannelManagerConstructor.EventHandler() {
331 @Override public void handle_event(Event event) {
332 synchronized (pending_manager_events) {
333 pending_manager_events.add(event);
334 pending_manager_events.notifyAll();
337 @Override public void persist_manager(byte[] channel_manager_bytes) { assert channel_manager_bytes.length > 1; }
339 this.chan_manager = constructor.channel_manager;
340 this.peer_manager = constructor.peer_manager;
341 must_free_objs.add(new WeakReference<>(this.chan_manager));
342 // If we are using a ChannelManagerConstructor, we may have pending events waiting on the old peer
343 // which have been removed from the ChannelManager but which we still need to handle.
344 this.pending_manager_events.addAll(orig.pending_manager_events);
345 if (!this.pending_manager_events.isEmpty()) {
346 // However, this implies cross_reload_ref_pollution
347 cross_reload_ref_pollution = true;
349 } catch (ChannelManagerConstructor.InvalidSerializedDataException e) {
353 ChannelMonitor[] monitors = new ChannelMonitor[1];
354 assert orig.monitors.size() == 1;
355 if (!break_cross_peer_refs) {
356 monitors[0] = orig.monitors.values().stream().iterator().next();
358 byte[] serialized = orig.monitors.values().stream().iterator().next().write();
359 Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ res =
360 UtilMethods.BlockHashChannelMonitorZ_read(serialized, this.keys_interface);
361 assert res instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
362 monitors[0] = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) res).res.b;
364 byte[] serialized = orig.chan_manager.write();
365 Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ read_res =
366 UtilMethods.BlockHashChannelManagerZ_read(serialized, this.keys_interface, this.fee_estimator, this.chain_watch, this.tx_broadcaster, this.logger, UserConfig.with_default(), monitors);
367 assert read_res instanceof Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK;
368 this.chan_manager = ((Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK) read_res).res.b;
369 this.chain_watch.watch_channel(monitors[0].get_funding_txo().a, monitors[0]);
370 byte[] random_data = keys_interface.get_secure_random_bytes();
371 this.peer_manager = PeerManager.of(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger, IgnoringMessageHandler.of().as_CustomMessageHandler());
372 if (!break_cross_peer_refs && (use_manual_watch || use_km_wrapper)) {
373 // When we pass monitors[0] into chain_watch.watch_channel we create a reference from the new Peer to a
374 // field in the old peer, preventing freeing of the original Peer until the new Peer is freed. Thus, we
375 // shouldn't bother waiting for the original to be freed later on.
376 cross_reload_ref_pollution = true;
379 this.node_id = chan_manager.get_our_node_id();
382 if (cross_reload_ref_pollution) {
383 // This really, really needs to be handled at the bindings layer, but its rather complicated -
384 // ChannelSigners can be cloned and passed around without java being involved, resulting in them being
385 // owned by both one or more ChannelMonitors and a ChannelManager, with only one having proper pointers
386 // to the ChannelSigner. Ideally, the ChannelSigner would have a global reference to the Java
387 // implementation class, but that results in circular references. Instead, we need some ability to,
388 // while cloning ChannelSigners, add new references in the calling Java struct (ie ChannelMonitor) to
389 // the ChannelSigner.
390 this.ptr_to = orig.chan_manager;
394 TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] connect_block(Block b, int height, long expected_monitor_update_len) {
395 byte[] header = Arrays.copyOfRange(b.bitcoinSerialize(), 0, 80);
396 TwoTuple<Long, byte[]>[] txn;
397 if (b.hasTransactions()) {
398 assert b.getTransactions().size() == 1;
399 TwoTuple<Long, byte[]> txp = new TwoTuple<>((long) 0, b.getTransactions().get(0).bitcoinSerialize());
400 txn = new TwoTuple[]{txp};
402 txn = new TwoTuple[0];
403 if (chain_monitor != null) {
404 chan_manager.as_Listen().block_connected(b.bitcoinSerialize(), height);
405 chain_monitor.as_Listen().block_connected(b.bitcoinSerialize(), height);
407 chan_manager.as_Confirm().transactions_confirmed(header, txn, height);
408 chan_manager.as_Confirm().best_block_updated(header, height);
409 // Connect manually if we aren't using a ChainMonitor and are implementing Watch ourselves
410 synchronized (monitors) {
411 assert monitors.size() == 1;
412 for (ChannelMonitor mon : monitors.values()) {
413 TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] ret = mon.block_connected(header, txn, height, tx_broadcaster, fee_estimator, logger);
414 assert ret.length == expected_monitor_update_len;
422 Event[] get_monitor_events(int expected_len) {
423 if (use_chan_manager_constructor) {
425 synchronized (this.pending_manager_events) {
426 if (expected_len != 0 && this.pending_manager_events.size() == expected_len) {
430 if (expected_len == 0) {
431 try { Thread.sleep(500); } catch (InterruptedException e) { assert false; }
437 synchronized (this.pending_manager_events) {
438 Event[] res = this.pending_manager_events.toArray(new Event[0]);
439 this.pending_manager_events.clear();
440 assert res.length == expected_len;
443 } else if (chain_monitor != null) {
444 ArrayList<Event> l = new ArrayList<Event>();
445 chain_monitor.as_EventsProvider().process_pending_events(EventHandler.new_impl(l::add));
446 assert l.size() == expected_len;
447 return l.toArray(new Event[0]);
449 synchronized (monitors) {
450 assert monitors.size() == 1;
451 for (ChannelMonitor mon : monitors.values()) {
452 Event[] res = mon.get_and_clear_pending_events();
453 assert res.length == expected_len;
461 Event[] get_manager_events(int expected_len, Peer peer1, Peer peer2) {
462 assert expected_len != 0;
463 if (!use_nio_peer_handler) {
464 maybe_exchange_peer_messages(peer1, peer2);
466 Event[] res = new Event[0];
467 if (use_chan_manager_constructor) {
468 while (res.length < expected_len) {
469 synchronized (this.pending_manager_events) {
470 res = this.pending_manager_events.toArray(res);
471 assert res.length == expected_len || res.length == 0; // We don't handle partial results
472 this.pending_manager_events.clear();
473 if (res.length < expected_len) {
474 try { this.pending_manager_events.wait(); } catch (InterruptedException e) { assert false; }
479 ArrayList<Event> l = new ArrayList<Event>();
480 while (l.size() < expected_len) {
482 if (use_nio_peer_handler) {
483 peer1.nio_peer_handler.check_events();
484 peer2.nio_peer_handler.check_events();
486 chan_manager.as_EventsProvider().process_pending_events(EventHandler.new_impl(l::add));
487 assert l.size() == expected_len || l.size() == 0; // We don't handle partial results
489 return l.toArray(new Event[0]);
491 assert res.length == expected_len;
496 static class DescriptorHolder { SocketDescriptor val; }
498 boolean running = false;
499 final LinkedList<Runnable> runqueue = new LinkedList();
501 Thread t = new Thread(() -> {
505 synchronized (runqueue) {
506 while (runqueue.isEmpty()) {
510 r = runqueue.pollFirst();
513 synchronized (runqueue) {
515 runqueue.notifyAll();
517 } catch (InterruptedException e) {
523 void maybe_exchange_peer_messages(Peer peer1, Peer peer2) {
524 if (!use_nio_peer_handler) {
525 synchronized (runqueue) {
529 peer1.peer_manager.process_events();
530 peer2.peer_manager.process_events();
531 synchronized (runqueue) {
532 if (runqueue.isEmpty() && !running) {
538 try { runqueue.wait(); } catch (InterruptedException e) { assert false; }
541 } else if (!use_chan_manager_constructor) {
542 peer1.nio_peer_handler.check_events();
543 peer2.nio_peer_handler.check_events();
546 void do_read_event(PeerManager pm, SocketDescriptor descriptor, byte[] data) {
547 if (!t.isAlive()) t.start();
548 synchronized (runqueue) {
551 Result_boolPeerHandleErrorZ res = pm.read_event(descriptor, data);
552 assert res instanceof Result_boolPeerHandleErrorZ.Result_boolPeerHandleErrorZ_OK;
554 runqueue.notifyAll();
556 must_free_objs.add(new WeakReference<>(data));
559 void connect_peers(final Peer peer1, final Peer peer2) {
560 if (use_nio_peer_handler) {
562 peer1.nio_peer_handler.connect(peer2.chan_manager.get_our_node_id(), new InetSocketAddress("127.0.0.1", peer2.nio_port), 100);
563 } catch (IOException e) { assert false; }
564 while (peer1.peer_manager.get_peer_node_ids().length == 0 || peer2.peer_manager.get_peer_node_ids().length == 0) {
568 DescriptorHolder descriptor1 = new DescriptorHolder();
569 DescriptorHolder descriptor1ref = descriptor1;
570 SocketDescriptor descriptor2 = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
572 public long send_data(byte[] data, boolean resume_read) {
573 do_read_event(peer1.peer_manager, descriptor1ref.val, data);
577 @Override public void disconnect_socket() { assert false; }
578 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 2; }
579 @Override public long hash() { return 2; }
582 descriptor1.val = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
584 public long send_data(byte[] data, boolean resume_read) {
585 do_read_event(peer2.peer_manager, descriptor2, data);
589 @Override public void disconnect_socket() { assert false; }
590 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 1; }
591 @Override public long hash() { return 1; }
594 Result_CVec_u8ZPeerHandleErrorZ conn_res = peer1.peer_manager.new_outbound_connection(peer2.node_id, descriptor1.val);
595 assert conn_res instanceof Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK;
597 Result_NonePeerHandleErrorZ inbound_conn_res = peer2.peer_manager.new_inbound_connection(descriptor2);
598 assert inbound_conn_res instanceof Result_NonePeerHandleErrorZ.Result_NonePeerHandleErrorZ_OK;
599 do_read_event(peer2.peer_manager, descriptor2, ((Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK) conn_res).res);
601 maybe_exchange_peer_messages(peer1, peer2);
605 TestState do_test_message_handler() throws InterruptedException {
606 Peer peer1 = new Peer((byte) 1);
607 Peer peer2 = new Peer((byte) 2);
609 connect_peers(peer1, peer2);
611 Result_NoneAPIErrorZ cc_res = peer1.chan_manager.create_channel(peer2.node_id, 100000, 1000, 42, null);
612 assert cc_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
614 // Previously, this was a SEGFAULT instead of get_funding_txo() returning null.
615 ChannelDetails pre_funding_chan = peer1.chan_manager.list_channels()[0];
616 assert pre_funding_chan.get_funding_txo() == null;
618 Event[] events = peer1.get_manager_events(1, peer1, peer2);
619 assert events[0] instanceof Event.FundingGenerationReady;
620 assert ((Event.FundingGenerationReady) events[0]).channel_value_satoshis == 100000;
621 assert ((Event.FundingGenerationReady) events[0]).user_channel_id == 42;
622 byte[] funding_spk = ((Event.FundingGenerationReady) events[0]).output_script;
623 assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
624 byte[] chan_id = ((Event.FundingGenerationReady) events[0]).temporary_channel_id;
626 NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
628 Transaction funding = new Transaction(bitcoinj_net);
629 funding.addInput(new TransactionInput(bitcoinj_net, funding, new byte[0]));
630 funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
631 funding.getInput(0).getWitness().setPush(0, new byte[]{0x1});
632 funding.addOutput(Coin.SATOSHI.multiply(100000), new Script(funding_spk));
633 Result_NoneAPIErrorZ funding_res = peer1.chan_manager.funding_transaction_generated(chan_id, funding.bitcoinSerialize());
634 assert funding_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
636 maybe_exchange_peer_messages(peer1, peer2);
637 synchronized (peer1.broadcast_set) {
638 while (peer1.broadcast_set.size() != 1) {
639 peer1.broadcast_set.wait();
643 assert peer1.broadcast_set.size() == 1;
644 assert Arrays.equals(peer1.broadcast_set.get(0), funding.bitcoinSerialize());
645 peer1.broadcast_set.clear();
647 Block b = new Block(bitcoinj_net, 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
648 peer1.connect_block(b, 1, 0);
649 peer2.connect_block(b, 1, 0);
651 for (int height = 2; height < 10; height++) {
652 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[0]));
653 peer1.connect_block(b, height, 0);
654 peer2.connect_block(b, height, 0);
657 maybe_exchange_peer_messages(peer1, peer2);
658 while (peer1.chan_manager.list_usable_channels().length != 1 || peer2.chan_manager.list_usable_channels().length != 1)
660 peer1.chan_manager.list_channels();
661 ChannelDetails[] peer1_chans = peer1.chan_manager.list_usable_channels();
662 ChannelDetails[] peer2_chans = peer2.chan_manager.list_usable_channels();
663 assert peer1_chans.length == 1;
664 assert peer2_chans.length == 1;
665 assert peer1_chans[0].get_channel_value_satoshis() == 100000;
666 assert peer1_chans[0].get_is_usable();
667 Option_u64Z short_chan_id = peer1_chans[0].get_short_channel_id();
668 assert short_chan_id instanceof Option_u64Z.Some;
669 assert ((Option_u64Z.Some)short_chan_id).some == (1L << 40); // 0th output in the 0th transaction in the 1st block
670 assert Arrays.equals(peer1_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
671 assert Arrays.equals(peer2_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
673 Result_InvoiceSignOrCreationErrorZ invoice = UtilMethods.create_invoice_from_channelmanager(peer2.chan_manager, peer2.keys_interface, Currency.LDKCurrency_Bitcoin, Option_u64Z.none(), "Invoice Description");
674 assert invoice instanceof Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK;
675 System.out.println("Got invoice: " + ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
677 Result_InvoiceNoneZ parsed_invoice = Invoice.from_str(((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
678 assert parsed_invoice instanceof Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK;
679 assert Arrays.equals(((Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK) parsed_invoice).res.payment_hash(), ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash());
680 SignedRawInvoice signed_raw = ((Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK) parsed_invoice).res.into_signed_raw();
681 RawInvoice raw_invoice = signed_raw.raw_invoice();
682 byte[] desc_hash = raw_invoice.hash();
683 Description raw_invoice_description = raw_invoice.description();
684 String description_string = raw_invoice_description.into_inner();
685 assert description_string.equals("Invoice Description");
686 byte[] payment_hash = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash();
687 byte[] payment_secret = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_secret();
688 byte[] dest_node_id = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.recover_payee_pub_key();
689 assert Arrays.equals(dest_node_id, peer2.node_id);
690 InvoiceFeatures invoice_features = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.features();
691 RouteHint[] route_hints = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.route_hints();
693 Result_RouteLightningErrorZ route_res = UtilMethods.get_route(peer1.chan_manager.get_our_node_id(), peer1.router.get_network_graph(), peer2.node_id, invoice_features, peer1_chans, route_hints, 10000000, 42, peer1.logger);
694 assert route_res instanceof Result_RouteLightningErrorZ.Result_RouteLightningErrorZ_OK;
695 Route route = ((Result_RouteLightningErrorZ.Result_RouteLightningErrorZ_OK) route_res).res;
697 Result_NonePaymentSendFailureZ payment_res = peer1.chan_manager.send_payment(route, payment_hash, payment_secret);
698 assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_OK;
700 RouteHop[][] hops = new RouteHop[1][1];
701 byte[] hop_pubkey = new byte[33];
704 hops[0][0] = RouteHop.of(hop_pubkey, NodeFeatures.known(), 42, ChannelFeatures.known(), 100, 0);
705 Route r2 = Route.of(hops);
706 payment_res = peer1.chan_manager.send_payment(r2, payment_hash, payment_secret);
707 assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_Err;
710 if (use_chan_manager_constructor) {
711 peer1.constructor.interrupt();
712 peer2.constructor.interrupt();
713 } else if (use_nio_peer_handler) {
714 peer1.nio_peer_handler.interrupt();
715 peer2.nio_peer_handler.interrupt();
717 WeakReference<Peer> op1 = new WeakReference<Peer>(peer1);
718 peer1 = new Peer(peer1);
719 peer2 = new Peer(peer2);
720 return new TestState(op1, peer1, peer2, b.getHash());
722 return new TestState(null, peer1, peer2, b.getHash());
725 boolean cross_reload_ref_pollution = false;
727 private final WeakReference<Peer> ref_block;
728 private final Peer peer1;
729 private final Peer peer2;
730 public Sha256Hash best_blockhash;
732 public TestState(WeakReference<Peer> ref_block, Peer peer1, Peer peer2, Sha256Hash best_blockhash) {
733 this.ref_block = ref_block;
736 this.best_blockhash = best_blockhash;
739 void do_test_message_handler_b(TestState state) throws InterruptedException {
740 GcCheck obj = new GcCheck();
741 if (state.ref_block != null) {
742 // Ensure the original peers get freed before we move on. Note that we have to be in a different function
743 // scope to do so as the (at least current OpenJDK) JRE won't release anything created in the same scope.
744 while (!cross_reload_ref_pollution && state.ref_block.get() != null) {
746 System.runFinalization();
748 connect_peers(state.peer1, state.peer2);
751 Event[] events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
752 assert events[0] instanceof Event.PendingHTLCsForwardable;
753 state.peer2.chan_manager.process_pending_htlc_forwards();
755 events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
756 assert events[0] instanceof Event.PaymentReceived;
757 assert ((Event.PaymentReceived)events[0]).purpose instanceof PaymentPurpose.InvoicePayment;
758 byte[] payment_preimage = ((PaymentPurpose.InvoicePayment)((Event.PaymentReceived)events[0]).purpose).payment_preimage;
759 assert !Arrays.equals(payment_preimage, new byte[32]);
760 state.peer2.chan_manager.claim_funds(payment_preimage);
762 events = state.peer1.get_manager_events(1, state.peer1, state.peer2);
763 assert events[0] instanceof Event.PaymentSent;
764 assert Arrays.equals(((Event.PaymentSent) events[0]).payment_preimage, payment_preimage);
766 if (use_nio_peer_handler) {
767 // We receive PaymentSent immediately upon receipt of the payment preimage, but we expect to not have an
768 // HTLC transaction to broadcast below, which requires a bit more time to fully complete the
769 // commitment-transaction-update dance between both peers.
773 ChannelDetails[] peer1_chans = state.peer1.chan_manager.list_channels();
776 Result_NoneAPIErrorZ close_res = state.peer1.chan_manager.close_channel(peer1_chans[0].get_channel_id());
777 assert close_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
778 maybe_exchange_peer_messages(state.peer1, state.peer2);
779 synchronized (state.peer1.broadcast_set) {
780 while (state.peer1.broadcast_set.size() != 1) state.peer1.broadcast_set.wait();
782 synchronized (state.peer2.broadcast_set) {
783 while (state.peer2.broadcast_set.size() != 1) state.peer2.broadcast_set.wait();
786 assert state.peer1.broadcast_set.size() == 1;
787 assert state.peer2.broadcast_set.size() == 1;
789 state.peer1.chan_manager.force_close_all_channels();
790 maybe_exchange_peer_messages(state.peer1, state.peer2);
791 synchronized (state.peer1.broadcast_set) {
792 while (state.peer1.broadcast_set.size() != 1) state.peer1.broadcast_set.wait();
794 synchronized (state.peer2.broadcast_set) {
795 while (state.peer2.broadcast_set.size() != 1) state.peer2.broadcast_set.wait();
798 assert state.peer1.broadcast_set.size() == 1;
799 assert state.peer2.broadcast_set.size() == 1;
801 NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
802 Transaction tx = new Transaction(bitcoinj_net, state.peer1.broadcast_set.getFirst());
803 Block b = new Block(bitcoinj_net, 2, state.best_blockhash, Sha256Hash.ZERO_HASH, 42, 0, 0,
804 Arrays.asList(new Transaction[]{tx}));
805 TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] watch_outputs = state.peer2.connect_block(b, 10, 1);
806 if (watch_outputs != null) { // We only process watch_outputs manually when we use a manually-build Watch impl
807 assert watch_outputs.length == 1;
808 assert Arrays.equals(watch_outputs[0].a, tx.getTxId().getReversedBytes());
809 assert watch_outputs[0].b.length == 2;
810 assert watch_outputs[0].b[0].a == 0;
811 assert watch_outputs[0].b[1].a == 1;
814 for (int i = 11; i < 21; i++) {
815 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, new ArrayList<>());
816 state.peer2.connect_block(b, i, 0);
819 Event[] broadcastable_event = state.peer2.get_monitor_events(1);
820 for (ChannelMonitor mon : state.peer2.monitors.values()) {
821 // This used to be buggy and double-free, so go ahead and fetch them!
822 byte[][] txn = mon.get_latest_holder_commitment_txn(state.peer2.logger);
824 assert broadcastable_event.length == 1;
825 assert broadcastable_event[0] instanceof Event.SpendableOutputs;
826 if (state.peer2.explicit_keys_manager != null) {
827 TxOut[] additional_outputs = new TxOut[] { new TxOut(420, new byte[] { 0x42 }) };
828 Result_TransactionNoneZ tx_res = state.peer2.explicit_keys_manager.spend_spendable_outputs(((Event.SpendableOutputs) broadcastable_event[0]).outputs, additional_outputs, new byte[] {0x00}, 253);
829 assert tx_res instanceof Result_TransactionNoneZ.Result_TransactionNoneZ_OK;
830 Transaction built_tx = new Transaction(bitcoinj_net, ((Result_TransactionNoneZ.Result_TransactionNoneZ_OK) tx_res).res);
831 assert built_tx.getOutputs().size() == 2;
832 assert Arrays.equals(built_tx.getOutput(1).getScriptBytes(), new byte[]{0x00});
833 assert Arrays.equals(built_tx.getOutput(0).getScriptBytes(), new byte[]{0x42});
834 assert built_tx.getOutput(0).getValue().value == 420;
838 if (use_nio_peer_handler) {
839 state.peer1.peer_manager.disconnect_by_node_id(state.peer2.chan_manager.get_our_node_id(), false);
840 while (state.peer1.peer_manager.get_peer_node_ids().length != 0) Thread.yield();
841 while (state.peer2.peer_manager.get_peer_node_ids().length != 0) Thread.yield();
842 state.peer1.nio_peer_handler.interrupt();
843 state.peer2.nio_peer_handler.interrupt();
846 state.peer1.get_monitor_events(0);
847 state.peer2.get_monitor_events(0);
849 if (use_chan_manager_constructor) {
850 state.peer1.constructor.interrupt();
851 state.peer2.constructor.interrupt();
857 java.util.LinkedList<WeakReference<Object>> must_free_objs = new java.util.LinkedList();
859 int gc_exp_count = 0;
861 GcCheck() { gc_exp_count += 1; }
863 protected void finalize() throws Throwable {
869 public class HumanObjectPeerTest {
870 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) throws InterruptedException {
871 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);
872 HumanObjectPeerTestInstance.TestState state = instance.do_test_message_handler();
873 instance.do_test_message_handler_b(state);
876 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) throws InterruptedException {
877 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);
878 while (instance.gc_count != instance.gc_exp_count) {
880 System.runFinalization();
882 for (WeakReference<Object> o : instance.must_free_objs)
883 assert o.get() == null;
886 public void test_message_handler() throws InterruptedException {
887 for (int i = 0; i < (1 << 7) - 1; i++) {
888 boolean nice_close = (i & (1 << 0)) != 0;
889 boolean use_km_wrapper = (i & (1 << 1)) != 0;
890 boolean use_manual_watch = (i & (1 << 2)) != 0;
891 boolean reload_peers = (i & (1 << 3)) != 0;
892 boolean break_cross_refs = (i & (1 << 4)) != 0;
893 boolean nio_peer_handler = (i & (1 << 5)) != 0;
894 boolean use_ignoring_routing_handler = (i & (1 << 6)) != 0;
895 boolean use_chan_manager_constructor = (i & (1 << 7)) != 0;
896 if (break_cross_refs && !reload_peers) {
897 // There are no cross refs to break without reloading peers.
900 if (use_chan_manager_constructor && (use_manual_watch || !nio_peer_handler)) {
901 // ChannelManagerConstructor requires a ChainMonitor as the Watch and creates a NioPeerHandler for us.
904 if (!use_chan_manager_constructor && use_ignoring_routing_handler) {
905 // We rely on the ChannelManagerConstructor to convert null into an IgnoringMessageHandler, so don't
906 // try to run with an IgnoringMessageHandler unless we're also using a ChannelManagerConstructor.
909 System.err.println("Running test with flags " + i);
910 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);
914 // This is used in the test jar to test the built jar is runnable
915 public static void main(String[] args) {
917 new HumanObjectPeerTest().test_message_handler();
918 } catch (Exception e) {
919 System.err.println("Caught exception:");
920 System.err.println(e);