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.Currency;
9 import org.ldk.enums.Network;
10 import org.ldk.structs.*;
11 import org.ldk.util.TwoTuple;
13 import java.io.IOException;
14 import java.lang.ref.WeakReference;
15 import java.net.InetSocketAddress;
18 class HumanObjectPeerTestInstance {
19 private final boolean nice_close;
20 private final boolean use_km_wrapper;
21 private final boolean use_manual_watch;
22 private final boolean reload_peers;
23 private final boolean break_cross_peer_refs;
24 private final boolean use_nio_peer_handler;
25 private final boolean use_filter;
26 private final boolean use_ignore_handler;
27 private final boolean use_chan_manager_constructor;
29 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) {
30 this.nice_close = nice_close;
31 this.use_km_wrapper = use_km_wrapper;
32 this.use_manual_watch = use_manual_watch;
33 this.reload_peers = reload_peers;
34 this.break_cross_peer_refs = break_cross_peer_refs;
35 this.use_nio_peer_handler = use_nio_peer_handler;
36 this.use_filter = use_filter;
37 this.use_ignore_handler = use_ignore_handler;
38 this.use_chan_manager_constructor = use_chan_manager_constructor;
42 KeysInterface manual_keysif(KeysInterface underlying_if) {
43 return KeysInterface.new_impl(new KeysInterface.KeysInterfaceInterface() {
44 @Override public byte[] get_node_secret() { return underlying_if.get_node_secret(); }
45 @Override public byte[] get_destination_script() { return underlying_if.get_destination_script(); }
46 @Override public ShutdownScript get_shutdown_scriptpubkey() { return underlying_if.get_shutdown_scriptpubkey(); }
49 public Sign get_channel_signer(boolean inbound, long channel_value_satoshis) {
50 Sign underlying_ck = underlying_if.get_channel_signer(inbound, channel_value_satoshis);
51 BaseSign underlying_base = underlying_ck.get_base_sign();
52 BaseSign.BaseSignInterface bsi = new BaseSign.BaseSignInterface() {
54 public byte[] get_per_commitment_point(long idx) {
55 return underlying_base.get_per_commitment_point(idx);
59 public byte[] release_commitment_secret(long idx) {
60 return underlying_base.release_commitment_secret(idx);
64 public byte[] channel_keys_id() {
69 public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_counterparty_commitment(CommitmentTransaction commitment_tx) {
70 return underlying_base.sign_counterparty_commitment(commitment_tx);
74 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);
79 public Result_SignatureNoneZ sign_justice_revoked_output(byte[] justice_tx, long input, long amount, byte[] per_commitment_key) {
80 return underlying_base.sign_justice_revoked_output(justice_tx, input, amount, per_commitment_key);
84 public Result_SignatureNoneZ sign_justice_revoked_htlc(byte[] justice_tx, long input, long amount, byte[] per_commitment_key, HTLCOutputInCommitment htlc) {
85 return underlying_base.sign_justice_revoked_htlc(justice_tx, input, amount, per_commitment_key, htlc);
89 public Result_SignatureNoneZ sign_counterparty_htlc_transaction(byte[] htlc_tx, long input, long amount, byte[] per_commitment_point, HTLCOutputInCommitment htlc) {
90 return underlying_base.sign_counterparty_htlc_transaction(htlc_tx, input, amount, per_commitment_point, htlc);
94 public Result_SignatureNoneZ sign_closing_transaction(byte[] closing_tx) {
95 return underlying_base.sign_closing_transaction(closing_tx);
99 public Result_SignatureNoneZ sign_channel_announcement(UnsignedChannelAnnouncement msg) {
100 return underlying_base.sign_channel_announcement(msg);
104 public void ready_channel(ChannelTransactionParameters params) {
105 underlying_base.ready_channel(params);
108 Sign.SignInterface si = new Sign.SignInterface() {
110 public byte[] write() {
111 return underlying_ck.write();
114 Sign resp = Sign.new_impl(si, bsi, underlying_base.get_pubkeys());
115 must_free_objs.add(new WeakReference<>(si));
116 must_free_objs.add(new WeakReference<>(bsi));
117 must_free_objs.add(new WeakReference<>(resp));
118 must_free_objs.add(new WeakReference<>(underlying_base));
119 must_free_objs.add(new WeakReference<>(underlying_ck));
124 public byte[] get_secure_random_bytes() {
125 return underlying_if.get_secure_random_bytes();
129 public Result_SignDecodeErrorZ read_chan_signer(byte[] reader) {
130 return underlying_if.read_chan_signer(reader);
134 public Result_RecoverableSignatureNoneZ sign_invoice(byte[] invoice_preimage) {
135 return underlying_if.sign_invoice(invoice_preimage);
140 Watch get_manual_watch() {
141 Watch.WatchInterface watch_impl = new Watch.WatchInterface() {
142 public Result_NoneChannelMonitorUpdateErrZ watch_channel(OutPoint funding_txo, ChannelMonitor monitor) {
143 synchronized (monitors) {
144 assert monitors.put(Arrays.toString(funding_txo.get_txid()), monitor) == null;
146 return Result_NoneChannelMonitorUpdateErrZ.ok();
149 public Result_NoneChannelMonitorUpdateErrZ update_channel(OutPoint funding_txo, ChannelMonitorUpdate update) {
150 synchronized (monitors) {
151 String txid = Arrays.toString(funding_txo.get_txid());
152 assert monitors.containsKey(txid);
153 Result_NoneMonitorUpdateErrorZ update_res = monitors.get(txid).update_monitor(update, tx_broadcaster, fee_estimator, logger);
154 assert update_res instanceof Result_NoneMonitorUpdateErrorZ.Result_NoneMonitorUpdateErrorZ_OK;
156 return Result_NoneChannelMonitorUpdateErrZ.ok();
160 public MonitorEvent[] release_pending_monitor_events() {
161 synchronized (monitors) {
162 assert monitors.size() <= 1;
163 for (ChannelMonitor mon : monitors.values()) {
164 return mon.get_and_clear_pending_monitor_events();
167 return new MonitorEvent[0];
170 Watch watch = Watch.new_impl(watch_impl);
171 must_free_objs.add(new WeakReference<>(watch_impl));
172 must_free_objs.add(new WeakReference<>(watch));
176 NioPeerHandler nio_peer_handler;
180 final FeeEstimator fee_estimator;
181 final BroadcasterInterface tx_broadcaster;
182 final KeysManager explicit_keys_manager;
183 final KeysInterface keys_interface;
184 final ChainMonitor chain_monitor;
185 final NetGraphMsgHandler router;
186 final Watch chain_watch;
187 final HashSet<String> filter_additions;
189 ChannelManager chan_manager;
190 PeerManager peer_manager;
191 final HashMap<String, ChannelMonitor> monitors; // Wow I forgot just how terrible Java is - we can't put a byte array here.
193 final LinkedList<byte[]> broadcast_set = new LinkedList<>();
194 final LinkedList<Event> pending_manager_events = new LinkedList<>();
195 ChannelManagerConstructor constructor = null;
196 GcCheck obj = new GcCheck();
198 private TwoTuple<OutPoint, byte[]> test_mon_roundtrip(ChannelMonitor mon) {
199 // Because get_funding_txo() returns an OutPoint in a tuple that is a reference to an OutPoint inside the
200 // ChannelMonitor, its a good test to ensure that the OutPoint isn't freed (or is cloned) before the
201 // ChannelMonitor is. This used to be broken.
202 Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ roundtrip_monitor = UtilMethods.BlockHashChannelMonitorZ_read(mon.write(), keys_interface);
203 assert roundtrip_monitor instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
204 TwoTuple<OutPoint, byte[]> funding_txo = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_monitor).res.b.get_funding_txo();
205 System.gc(); System.runFinalization(); // Give the GC a chance to run.
209 private Peer(Object _dummy, byte seed) {
210 logger = Logger.new_impl((String arg) -> System.out.println(seed + ": " + arg));
211 fee_estimator = FeeEstimator.new_impl((confirmation_target -> 253));
212 tx_broadcaster = BroadcasterInterface.new_impl(tx -> {
213 synchronized (broadcast_set) {
214 broadcast_set.add(tx);
215 broadcast_set.notifyAll();
218 monitors = new HashMap<>();
220 Persist persister = Persist.new_impl(new Persist.PersistInterface() {
222 public Result_NoneChannelMonitorUpdateErrZ persist_new_channel(OutPoint id, ChannelMonitor data) {
223 synchronized (monitors) {
224 String key = Arrays.toString(id.to_channel_id());
225 assert monitors.put(key, data) == null;
226 TwoTuple<OutPoint, byte[]> res = test_mon_roundtrip(data);
227 assert Arrays.equals(res.a.get_txid(), id.get_txid());
228 assert res.a.get_index() == id.get_index();
230 return Result_NoneChannelMonitorUpdateErrZ.ok();
234 public Result_NoneChannelMonitorUpdateErrZ update_persisted_channel(OutPoint id, ChannelMonitorUpdate update, ChannelMonitor data) {
235 synchronized (monitors) {
236 String key = Arrays.toString(id.to_channel_id());
237 assert monitors.put(key, data) != null;
238 TwoTuple<OutPoint, byte[]> res = test_mon_roundtrip(data);
239 assert Arrays.equals(res.a.get_txid(), id.get_txid());
240 assert res.a.get_index() == id.get_index();
242 return Result_NoneChannelMonitorUpdateErrZ.ok();
246 filter_additions = new HashSet<>();
248 this.filter = Filter.new_impl(new Filter.FilterInterface() {
249 @Override public void register_tx(byte[] txid, byte[] script_pubkey) {
250 filter_additions.add(Arrays.toString(txid));
252 @Override public Option_C2Tuple_usizeTransactionZZ register_output(WatchedOutput output) {
253 filter_additions.add(Arrays.toString(output.get_outpoint().get_txid()) + ":" + output.get_outpoint().get_index());
254 return Option_C2Tuple_usizeTransactionZZ.none();
261 if (use_manual_watch) {
262 chain_watch = get_manual_watch();
263 chain_monitor = null;
265 chain_monitor = ChainMonitor.of(filter, tx_broadcaster, logger, fee_estimator, persister);
266 chain_watch = chain_monitor.as_Watch();
269 byte[] key_seed = new byte[32];
270 for (byte i = 0; i < 32; i++) {
271 key_seed[i] = (byte) (i ^ seed);
273 KeysManager keys = KeysManager.of(key_seed, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000));
274 if (use_km_wrapper) {
275 this.keys_interface = manual_keysif(keys.as_KeysInterface());
276 this.explicit_keys_manager = null;
278 this.keys_interface = keys.as_KeysInterface();
279 this.explicit_keys_manager = keys;
281 this.router = NetGraphMsgHandler.of(new byte[32], null, logger);
283 private void bind_nio() {
284 if (!use_nio_peer_handler) return;
285 if (use_chan_manager_constructor) {
286 this.nio_peer_handler = this.constructor.nio_peer_handler;
288 try { this.nio_peer_handler = new NioPeerHandler(peer_manager); } catch (IOException e) { assert false; }
290 for (short i = 10_000; true; i++) {
292 nio_peer_handler.bind_listener(new InetSocketAddress("127.0.0.1", i));
295 } catch (IOException e) { assert i < 10_500; }
300 if (use_chan_manager_constructor) {
301 NetGraphMsgHandler route_handler = null;
302 if (!use_ignore_handler) {
303 route_handler = router;
305 this.constructor = new ChannelManagerConstructor(Network.LDKNetwork_Bitcoin, UserConfig.with_default(), new byte[32], 0,
306 this.keys_interface, this.fee_estimator, this.chain_monitor, route_handler, this.tx_broadcaster, this.logger);
307 constructor.chain_sync_completed(new ChannelManagerConstructor.ChannelManagerPersister() {
308 @Override public void handle_event(Event event) {
309 synchronized (pending_manager_events) {
310 pending_manager_events.add(event);
311 pending_manager_events.notifyAll();
314 @Override public void persist_manager(byte[] channel_manager_bytes) { assert channel_manager_bytes.length > 1; }
316 this.chan_manager = constructor.channel_manager;
317 this.peer_manager = constructor.peer_manager;
318 must_free_objs.add(new WeakReference<>(this.chan_manager));
320 ChainParameters params = ChainParameters.of(Network.LDKNetwork_Bitcoin, BestBlock.of(new byte[32], 0));
321 this.chan_manager = ChannelManager.of(this.fee_estimator, chain_watch, tx_broadcaster, logger, this.keys_interface, UserConfig.with_default(), params);
322 byte[] random_data = keys_interface.get_secure_random_bytes();
323 this.peer_manager = PeerManager.of(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger);
326 this.node_id = chan_manager.get_our_node_id();
333 this(null, orig.seed);
334 if (use_chan_manager_constructor) {
335 byte[][] monitors = {orig.monitors.values().stream().iterator().next().write()};
336 byte[] serialized = orig.chan_manager.write();
338 this.constructor = new ChannelManagerConstructor(serialized, monitors, this.keys_interface,
339 this.fee_estimator, this.chain_monitor, this.filter, this.router, this.tx_broadcaster, this.logger);
340 constructor.chain_sync_completed(new ChannelManagerConstructor.ChannelManagerPersister() {
341 @Override public void handle_event(Event event) {
342 synchronized (pending_manager_events) {
343 pending_manager_events.add(event);
344 pending_manager_events.notifyAll();
347 @Override public void persist_manager(byte[] channel_manager_bytes) { assert channel_manager_bytes.length > 1; }
349 this.chan_manager = constructor.channel_manager;
350 this.peer_manager = constructor.peer_manager;
351 must_free_objs.add(new WeakReference<>(this.chan_manager));
352 // If we are using a ChannelManagerConstructor, we may have pending events waiting on the old peer
353 // which have been removed from the ChannelManager but which we still need to handle.
354 this.pending_manager_events.addAll(orig.pending_manager_events);
355 if (!this.pending_manager_events.isEmpty()) {
356 // However, this implies cross_reload_ref_pollution
357 cross_reload_ref_pollution = true;
359 } catch (ChannelManagerConstructor.InvalidSerializedDataException e) {
363 ChannelMonitor[] monitors = new ChannelMonitor[1];
364 assert orig.monitors.size() == 1;
365 if (!break_cross_peer_refs) {
366 monitors[0] = orig.monitors.values().stream().iterator().next();
368 byte[] serialized = orig.monitors.values().stream().iterator().next().write();
369 Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ res =
370 UtilMethods.BlockHashChannelMonitorZ_read(serialized, this.keys_interface);
371 assert res instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
372 monitors[0] = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) res).res.b;
374 byte[] serialized = orig.chan_manager.write();
375 Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ read_res =
376 UtilMethods.BlockHashChannelManagerZ_read(serialized, this.keys_interface, this.fee_estimator, this.chain_watch, this.tx_broadcaster, this.logger, UserConfig.with_default(), monitors);
377 assert read_res instanceof Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK;
378 this.chan_manager = ((Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK) read_res).res.b;
379 this.chain_watch.watch_channel(monitors[0].get_funding_txo().a, monitors[0]);
380 byte[] random_data = keys_interface.get_secure_random_bytes();
381 this.peer_manager = PeerManager.of(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger);
382 if (!break_cross_peer_refs && (use_manual_watch || use_km_wrapper)) {
383 // When we pass monitors[0] into chain_watch.watch_channel we create a reference from the new Peer to a
384 // field in the old peer, preventing freeing of the original Peer until the new Peer is freed. Thus, we
385 // shouldn't bother waiting for the original to be freed later on.
386 cross_reload_ref_pollution = true;
389 this.node_id = chan_manager.get_our_node_id();
392 if (cross_reload_ref_pollution) {
393 // This really, really needs to be handled at the bindings layer, but its rather complicated -
394 // ChannelSigners can be cloned and passed around without java being involved, resulting in them being
395 // owned by both one or more ChannelMonitors and a ChannelManager, with only one having proper pointers
396 // to the ChannelSigner. Ideally, the ChannelSigner would have a global reference to the Java
397 // implementation class, but that results in circular references. Instead, we need some ability to,
398 // while cloning ChannelSigners, add new references in the calling Java struct (ie ChannelMonitor) to
399 // the ChannelSigner.
400 this.ptr_to = orig.chan_manager;
404 TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] connect_block(Block b, int height, long expected_monitor_update_len) {
405 byte[] header = Arrays.copyOfRange(b.bitcoinSerialize(), 0, 80);
406 TwoTuple<Long, byte[]>[] txn;
407 if (b.hasTransactions()) {
408 assert b.getTransactions().size() == 1;
409 TwoTuple<Long, byte[]> txp = new TwoTuple<>((long) 0, b.getTransactions().get(0).bitcoinSerialize());
410 txn = new TwoTuple[]{txp};
412 txn = new TwoTuple[0];
413 if (chain_monitor != null) {
414 chan_manager.as_Listen().block_connected(b.bitcoinSerialize(), height);
415 chain_monitor.as_Listen().block_connected(b.bitcoinSerialize(), height);
417 chan_manager.as_Confirm().transactions_confirmed(header, txn, height);
418 chan_manager.as_Confirm().best_block_updated(header, height);
419 // Connect manually if we aren't using a ChainMonitor and are implementing Watch ourselves
420 synchronized (monitors) {
421 assert monitors.size() == 1;
422 for (ChannelMonitor mon : monitors.values()) {
423 TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] ret = mon.block_connected(header, txn, height, tx_broadcaster, fee_estimator, logger);
424 assert ret.length == expected_monitor_update_len;
432 Event[] get_monitor_events(int expected_len) {
433 if (use_chan_manager_constructor) {
435 synchronized (this.pending_manager_events) {
436 if (expected_len != 0 && this.pending_manager_events.size() == expected_len) {
440 if (expected_len == 0) {
441 try { Thread.sleep(500); } catch (InterruptedException e) { assert false; }
447 synchronized (this.pending_manager_events) {
448 Event[] res = this.pending_manager_events.toArray(new Event[0]);
449 this.pending_manager_events.clear();
450 assert res.length == expected_len;
453 } else if (chain_monitor != null) {
454 ArrayList<Event> l = new ArrayList<Event>();
455 chain_monitor.as_EventsProvider().process_pending_events(EventHandler.new_impl(l::add));
456 assert l.size() == expected_len;
457 return l.toArray(new Event[0]);
459 synchronized (monitors) {
460 assert monitors.size() == 1;
461 for (ChannelMonitor mon : monitors.values()) {
462 Event[] res = mon.get_and_clear_pending_events();
463 assert res.length == expected_len;
471 Event[] get_manager_events(int expected_len, Peer peer1, Peer peer2) {
472 assert expected_len != 0;
473 if (!use_nio_peer_handler) {
474 maybe_exchange_peer_messages(peer1, peer2);
476 Event[] res = new Event[0];
477 if (use_chan_manager_constructor) {
478 while (res.length < expected_len) {
479 synchronized (this.pending_manager_events) {
480 res = this.pending_manager_events.toArray(res);
481 assert res.length == expected_len || res.length == 0; // We don't handle partial results
482 this.pending_manager_events.clear();
483 if (res.length < expected_len) {
484 try { this.pending_manager_events.wait(); } catch (InterruptedException e) { assert false; }
489 ArrayList<Event> l = new ArrayList<Event>();
490 while (l.size() < expected_len) {
492 if (use_nio_peer_handler) {
493 peer1.nio_peer_handler.check_events();
494 peer2.nio_peer_handler.check_events();
496 chan_manager.as_EventsProvider().process_pending_events(EventHandler.new_impl(l::add));
497 assert l.size() == expected_len || l.size() == 0; // We don't handle partial results
499 return l.toArray(new Event[0]);
501 assert res.length == expected_len;
506 static class DescriptorHolder { SocketDescriptor val; }
508 boolean running = false;
509 final LinkedList<Runnable> runqueue = new LinkedList();
511 Thread t = new Thread(() -> {
515 synchronized (runqueue) {
516 while (runqueue.isEmpty()) {
520 r = runqueue.pollFirst();
523 synchronized (runqueue) {
525 runqueue.notifyAll();
527 } catch (InterruptedException e) {
533 void maybe_exchange_peer_messages(Peer peer1, Peer peer2) {
534 if (!use_nio_peer_handler) {
535 synchronized (runqueue) {
539 peer1.peer_manager.process_events();
540 peer2.peer_manager.process_events();
541 synchronized (runqueue) {
542 if (runqueue.isEmpty() && !running) {
548 try { runqueue.wait(); } catch (InterruptedException e) { assert false; }
551 } else if (!use_chan_manager_constructor) {
552 peer1.nio_peer_handler.check_events();
553 peer2.nio_peer_handler.check_events();
556 void do_read_event(PeerManager pm, SocketDescriptor descriptor, byte[] data) {
557 if (!t.isAlive()) t.start();
558 synchronized (runqueue) {
561 Result_boolPeerHandleErrorZ res = pm.read_event(descriptor, data);
562 assert res instanceof Result_boolPeerHandleErrorZ.Result_boolPeerHandleErrorZ_OK;
564 runqueue.notifyAll();
566 must_free_objs.add(new WeakReference<>(data));
569 void connect_peers(final Peer peer1, final Peer peer2) {
570 if (use_nio_peer_handler) {
572 peer1.nio_peer_handler.connect(peer2.chan_manager.get_our_node_id(), new InetSocketAddress("127.0.0.1", peer2.nio_port), 100);
573 } catch (IOException e) { assert false; }
574 while (peer1.peer_manager.get_peer_node_ids().length == 0 || peer2.peer_manager.get_peer_node_ids().length == 0) {
578 DescriptorHolder descriptor1 = new DescriptorHolder();
579 DescriptorHolder descriptor1ref = descriptor1;
580 SocketDescriptor descriptor2 = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
582 public long send_data(byte[] data, boolean resume_read) {
583 do_read_event(peer1.peer_manager, descriptor1ref.val, data);
587 @Override public void disconnect_socket() { assert false; }
588 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 2; }
589 @Override public long hash() { return 2; }
592 descriptor1.val = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
594 public long send_data(byte[] data, boolean resume_read) {
595 do_read_event(peer2.peer_manager, descriptor2, data);
599 @Override public void disconnect_socket() { assert false; }
600 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 1; }
601 @Override public long hash() { return 1; }
604 Result_CVec_u8ZPeerHandleErrorZ conn_res = peer1.peer_manager.new_outbound_connection(peer2.node_id, descriptor1.val);
605 assert conn_res instanceof Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK;
607 Result_NonePeerHandleErrorZ inbound_conn_res = peer2.peer_manager.new_inbound_connection(descriptor2);
608 assert inbound_conn_res instanceof Result_NonePeerHandleErrorZ.Result_NonePeerHandleErrorZ_OK;
609 do_read_event(peer2.peer_manager, descriptor2, ((Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK) conn_res).res);
611 maybe_exchange_peer_messages(peer1, peer2);
615 TestState do_test_message_handler() throws InterruptedException {
616 Peer peer1 = new Peer((byte) 1);
617 Peer peer2 = new Peer((byte) 2);
619 connect_peers(peer1, peer2);
621 Result_NoneAPIErrorZ cc_res = peer1.chan_manager.create_channel(peer2.node_id, 100000, 1000, 42, null);
622 assert cc_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
624 // Previously, this was a SEGFAULT instead of get_funding_txo() returning null.
625 ChannelDetails pre_funding_chan = peer1.chan_manager.list_channels()[0];
626 assert pre_funding_chan.get_funding_txo() == null;
628 Event[] events = peer1.get_manager_events(1, peer1, peer2);
629 assert events[0] instanceof Event.FundingGenerationReady;
630 assert ((Event.FundingGenerationReady) events[0]).channel_value_satoshis == 100000;
631 assert ((Event.FundingGenerationReady) events[0]).user_channel_id == 42;
632 byte[] funding_spk = ((Event.FundingGenerationReady) events[0]).output_script;
633 assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
634 byte[] chan_id = ((Event.FundingGenerationReady) events[0]).temporary_channel_id;
636 NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
638 Transaction funding = new Transaction(bitcoinj_net);
639 funding.addInput(new TransactionInput(bitcoinj_net, funding, new byte[0]));
640 funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
641 funding.getInput(0).getWitness().setPush(0, new byte[]{0x1});
642 funding.addOutput(Coin.SATOSHI.multiply(100000), new Script(funding_spk));
643 Result_NoneAPIErrorZ funding_res = peer1.chan_manager.funding_transaction_generated(chan_id, funding.bitcoinSerialize());
644 assert funding_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
646 maybe_exchange_peer_messages(peer1, peer2);
647 synchronized (peer1.broadcast_set) {
648 while (peer1.broadcast_set.size() != 1) {
649 peer1.broadcast_set.wait();
653 assert peer1.broadcast_set.size() == 1;
654 assert Arrays.equals(peer1.broadcast_set.get(0), funding.bitcoinSerialize());
655 peer1.broadcast_set.clear();
657 Block b = new Block(bitcoinj_net, 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
658 peer1.connect_block(b, 1, 0);
659 peer2.connect_block(b, 1, 0);
661 for (int height = 2; height < 10; height++) {
662 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[0]));
663 peer1.connect_block(b, height, 0);
664 peer2.connect_block(b, height, 0);
667 maybe_exchange_peer_messages(peer1, peer2);
668 while (peer1.chan_manager.list_usable_channels().length != 1 || peer2.chan_manager.list_usable_channels().length != 1)
670 peer1.chan_manager.list_channels();
671 ChannelDetails[] peer1_chans = peer1.chan_manager.list_usable_channels();
672 ChannelDetails[] peer2_chans = peer2.chan_manager.list_usable_channels();
673 assert peer1_chans.length == 1;
674 assert peer2_chans.length == 1;
675 assert peer1_chans[0].get_channel_value_satoshis() == 100000;
676 assert peer1_chans[0].get_is_usable();
677 Option_u64Z short_chan_id = peer1_chans[0].get_short_channel_id();
678 assert short_chan_id instanceof Option_u64Z.Some;
679 assert ((Option_u64Z.Some)short_chan_id).some == (1L << 40); // 0th output in the 0th transaction in the 1st block
680 assert Arrays.equals(peer1_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
681 assert Arrays.equals(peer2_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
683 Result_InvoiceSignOrCreationErrorZ invoice = UtilMethods.create_invoice_from_channelmanager(peer2.chan_manager, peer2.keys_interface, Currency.LDKCurrency_Bitcoin, Option_u64Z.none(), "Invoice Description");
684 assert invoice instanceof Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK;
685 System.out.println("Got invoice: " + ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
687 Result_InvoiceNoneZ parsed_invoice = Invoice.from_str(((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
688 assert parsed_invoice instanceof Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK;
689 assert Arrays.equals(((Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK) parsed_invoice).res.payment_hash(), ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash());
690 SignedRawInvoice signed_raw = ((Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK) parsed_invoice).res.into_signed_raw();
691 RawInvoice raw_invoice = signed_raw.raw_invoice();
692 byte[] desc_hash = raw_invoice.hash();
693 Description raw_invoice_description = raw_invoice.description();
694 String description_string = raw_invoice_description.into_inner();
695 assert description_string.equals("Invoice Description");
696 byte[] payment_hash = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash();
697 byte[] payment_secret = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_secret();
698 byte[] dest_node_id = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.recover_payee_pub_key();
699 assert Arrays.equals(dest_node_id, peer2.node_id);
700 InvoiceFeatures invoice_features = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.features();
701 RouteHint[] route_hints = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.route_hints();
704 try (LockedNetworkGraph netgraph = peer1.router.read_locked_graph()) {
705 NetworkGraph graph = netgraph.graph();
706 Result_RouteLightningErrorZ route_res = UtilMethods.get_route(peer1.chan_manager.get_our_node_id(), graph, peer2.node_id, invoice_features, peer1_chans, route_hints, 10000000, 42, peer1.logger);
707 assert route_res instanceof Result_RouteLightningErrorZ.Result_RouteLightningErrorZ_OK;
708 route = ((Result_RouteLightningErrorZ.Result_RouteLightningErrorZ_OK) route_res).res;
711 Result_NonePaymentSendFailureZ payment_res = peer1.chan_manager.send_payment(route, payment_hash, payment_secret);
712 assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_OK;
714 RouteHop[][] hops = new RouteHop[1][1];
715 byte[] hop_pubkey = new byte[33];
718 hops[0][0] = RouteHop.of(hop_pubkey, NodeFeatures.known(), 42, ChannelFeatures.known(), 100, 0);
719 Route r2 = Route.of(hops);
720 payment_res = peer1.chan_manager.send_payment(r2, payment_hash, payment_secret);
721 assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_Err;
724 if (use_chan_manager_constructor) {
725 peer1.constructor.interrupt();
726 peer2.constructor.interrupt();
727 } else if (use_nio_peer_handler) {
728 peer1.nio_peer_handler.interrupt();
729 peer2.nio_peer_handler.interrupt();
731 WeakReference<Peer> op1 = new WeakReference<Peer>(peer1);
732 peer1 = new Peer(peer1);
733 peer2 = new Peer(peer2);
734 return new TestState(op1, peer1, peer2, b.getHash());
736 return new TestState(null, peer1, peer2, b.getHash());
739 boolean cross_reload_ref_pollution = false;
741 private final WeakReference<Peer> ref_block;
742 private final Peer peer1;
743 private final Peer peer2;
744 public Sha256Hash best_blockhash;
746 public TestState(WeakReference<Peer> ref_block, Peer peer1, Peer peer2, Sha256Hash best_blockhash) {
747 this.ref_block = ref_block;
750 this.best_blockhash = best_blockhash;
753 void do_test_message_handler_b(TestState state) throws InterruptedException {
754 GcCheck obj = new GcCheck();
755 if (state.ref_block != null) {
756 // Ensure the original peers get freed before we move on. Note that we have to be in a different function
757 // scope to do so as the (at least current OpenJDK) JRE won't release anything created in the same scope.
758 while (!cross_reload_ref_pollution && state.ref_block.get() != null) {
760 System.runFinalization();
762 connect_peers(state.peer1, state.peer2);
765 Event[] events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
766 assert events[0] instanceof Event.PendingHTLCsForwardable;
767 state.peer2.chan_manager.process_pending_htlc_forwards();
769 events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
770 assert events[0] instanceof Event.PaymentReceived;
771 assert ((Event.PaymentReceived)events[0]).purpose instanceof PaymentPurpose.InvoicePayment;
772 byte[] payment_preimage = ((PaymentPurpose.InvoicePayment)((Event.PaymentReceived)events[0]).purpose).payment_preimage;
773 assert !Arrays.equals(payment_preimage, new byte[32]);
774 state.peer2.chan_manager.claim_funds(payment_preimage);
776 events = state.peer1.get_manager_events(1, state.peer1, state.peer2);
777 assert events[0] instanceof Event.PaymentSent;
778 assert Arrays.equals(((Event.PaymentSent) events[0]).payment_preimage, payment_preimage);
780 if (use_nio_peer_handler) {
781 // We receive PaymentSent immediately upon receipt of the payment preimage, but we expect to not have an
782 // HTLC transaction to broadcast below, which requires a bit more time to fully complete the
783 // commitment-transaction-update dance between both peers.
787 ChannelDetails[] peer1_chans = state.peer1.chan_manager.list_channels();
790 Result_NoneAPIErrorZ close_res = state.peer1.chan_manager.close_channel(peer1_chans[0].get_channel_id());
791 assert close_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
792 maybe_exchange_peer_messages(state.peer1, state.peer2);
793 synchronized (state.peer1.broadcast_set) {
794 while (state.peer1.broadcast_set.size() != 1) state.peer1.broadcast_set.wait();
796 synchronized (state.peer2.broadcast_set) {
797 while (state.peer2.broadcast_set.size() != 1) state.peer2.broadcast_set.wait();
800 assert state.peer1.broadcast_set.size() == 1;
801 assert state.peer2.broadcast_set.size() == 1;
803 state.peer1.chan_manager.force_close_all_channels();
804 maybe_exchange_peer_messages(state.peer1, state.peer2);
805 synchronized (state.peer1.broadcast_set) {
806 while (state.peer1.broadcast_set.size() != 1) state.peer1.broadcast_set.wait();
808 synchronized (state.peer2.broadcast_set) {
809 while (state.peer2.broadcast_set.size() != 1) state.peer2.broadcast_set.wait();
812 assert state.peer1.broadcast_set.size() == 1;
813 assert state.peer2.broadcast_set.size() == 1;
815 NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
816 Transaction tx = new Transaction(bitcoinj_net, state.peer1.broadcast_set.getFirst());
817 Block b = new Block(bitcoinj_net, 2, state.best_blockhash, Sha256Hash.ZERO_HASH, 42, 0, 0,
818 Arrays.asList(new Transaction[]{tx}));
819 TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] watch_outputs = state.peer2.connect_block(b, 10, 1);
820 if (watch_outputs != null) { // We only process watch_outputs manually when we use a manually-build Watch impl
821 assert watch_outputs.length == 1;
822 assert Arrays.equals(watch_outputs[0].a, tx.getTxId().getReversedBytes());
823 assert watch_outputs[0].b.length == 2;
824 assert watch_outputs[0].b[0].a == 0;
825 assert watch_outputs[0].b[1].a == 1;
828 for (int i = 11; i < 21; i++) {
829 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, new ArrayList<>());
830 state.peer2.connect_block(b, i, 0);
833 Event[] broadcastable_event = state.peer2.get_monitor_events(1);
834 for (ChannelMonitor mon : state.peer2.monitors.values()) {
835 // This used to be buggy and double-free, so go ahead and fetch them!
836 byte[][] txn = mon.get_latest_holder_commitment_txn(state.peer2.logger);
838 assert broadcastable_event.length == 1;
839 assert broadcastable_event[0] instanceof Event.SpendableOutputs;
840 if (state.peer2.explicit_keys_manager != null) {
841 TxOut[] additional_outputs = new TxOut[] { new TxOut(420, new byte[] { 0x42 }) };
842 Result_TransactionNoneZ tx_res = state.peer2.explicit_keys_manager.spend_spendable_outputs(((Event.SpendableOutputs) broadcastable_event[0]).outputs, additional_outputs, new byte[] {0x00}, 253);
843 assert tx_res instanceof Result_TransactionNoneZ.Result_TransactionNoneZ_OK;
844 Transaction built_tx = new Transaction(bitcoinj_net, ((Result_TransactionNoneZ.Result_TransactionNoneZ_OK) tx_res).res);
845 assert built_tx.getOutputs().size() == 2;
846 assert Arrays.equals(built_tx.getOutput(1).getScriptBytes(), new byte[]{0x00});
847 assert Arrays.equals(built_tx.getOutput(0).getScriptBytes(), new byte[]{0x42});
848 assert built_tx.getOutput(0).getValue().value == 420;
852 if (use_nio_peer_handler) {
853 state.peer1.peer_manager.disconnect_by_node_id(state.peer2.chan_manager.get_our_node_id(), false);
854 while (state.peer1.peer_manager.get_peer_node_ids().length != 0) Thread.yield();
855 while (state.peer2.peer_manager.get_peer_node_ids().length != 0) Thread.yield();
856 state.peer1.nio_peer_handler.interrupt();
857 state.peer2.nio_peer_handler.interrupt();
860 state.peer1.get_monitor_events(0);
861 state.peer2.get_monitor_events(0);
863 if (use_chan_manager_constructor) {
864 state.peer1.constructor.interrupt();
865 state.peer2.constructor.interrupt();
871 java.util.LinkedList<WeakReference<Object>> must_free_objs = new java.util.LinkedList();
873 int gc_exp_count = 0;
875 GcCheck() { gc_exp_count += 1; }
877 protected void finalize() throws Throwable {
883 public class HumanObjectPeerTest {
884 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 {
885 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);
886 HumanObjectPeerTestInstance.TestState state = instance.do_test_message_handler();
887 instance.do_test_message_handler_b(state);
890 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 {
891 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);
892 while (instance.gc_count != instance.gc_exp_count) {
894 System.runFinalization();
896 for (WeakReference<Object> o : instance.must_free_objs)
897 assert o.get() == null;
900 public void test_message_handler() throws InterruptedException {
901 for (int i = 0; i < (1 << 7) - 1; i++) {
902 boolean nice_close = (i & (1 << 0)) != 0;
903 boolean use_km_wrapper = (i & (1 << 1)) != 0;
904 boolean use_manual_watch = (i & (1 << 2)) != 0;
905 boolean reload_peers = (i & (1 << 3)) != 0;
906 boolean break_cross_refs = (i & (1 << 4)) != 0;
907 boolean nio_peer_handler = (i & (1 << 5)) != 0;
908 boolean use_ignoring_routing_handler = (i & (1 << 6)) != 0;
909 boolean use_chan_manager_constructor = (i & (1 << 7)) != 0;
910 if (break_cross_refs && !reload_peers) {
911 // There are no cross refs to break without reloading peers.
914 if (use_chan_manager_constructor && (use_manual_watch || !nio_peer_handler)) {
915 // ChannelManagerConstructor requires a ChainMonitor as the Watch and creates a NioPeerHandler for us.
918 if (!use_chan_manager_constructor && use_ignoring_routing_handler) {
919 // We rely on the ChannelManagerConstructor to convert null into an IgnoringMessageHandler, so don't
920 // try to run with an IgnoringMessageHandler unless we're also using a ChannelManagerConstructor.
923 System.err.println("Running test with flags " + i);
924 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);
928 // This is used in the test jar to test the built jar is runnable
929 public static void main(String[] args) {
931 new HumanObjectPeerTest().test_message_handler();
932 } catch (Exception e) {
933 System.err.println("Caught exception:");
934 System.err.println(e);