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.impl.bindings;
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_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_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_chan_manager_constructor = use_chan_manager_constructor;
41 KeysInterface manual_keysif(KeysInterface underlying_if) {
42 return KeysInterface.new_impl(new KeysInterface.KeysInterfaceInterface() {
43 @Override public byte[] get_node_secret() { return underlying_if.get_node_secret(); }
44 @Override public byte[] get_destination_script() { return underlying_if.get_destination_script(); }
45 @Override public byte[] get_shutdown_pubkey() { return underlying_if.get_shutdown_pubkey(); }
48 public Sign get_channel_signer(boolean inbound, long channel_value_satoshis) {
49 Sign underlying_ck = underlying_if.get_channel_signer(inbound, channel_value_satoshis);
50 // TODO: Expose the underlying signer from a Sign
51 /*BaseSign.BaseSignInterface si = new BaseSign.BaseSignInterface() {
53 public byte[] get_per_commitment_point(long idx) {
54 return underlying_ck.get_per_commitment_point(idx);
58 public byte[] release_commitment_secret(long idx) {
59 return underlying_ck.release_commitment_secret(idx);
63 public byte[] channel_keys_id() {
68 public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_counterparty_commitment(CommitmentTransaction commitment_tx) {
69 return underlying_ck.sign_counterparty_commitment(commitment_tx);
73 public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_holder_commitment_and_htlcs(HolderCommitmentTransaction holder_commitment_tx) {
74 return underlying_ck.sign_holder_commitment_and_htlcs(holder_commitment_tx);
78 public Result_SignatureNoneZ sign_justice_transaction(byte[] justice_tx, long input, long amount, byte[] per_commitment_key, HTLCOutputInCommitment htlc) {
79 return underlying_ck.sign_justice_transaction(justice_tx, input, amount, per_commitment_key, htlc);
83 public Result_SignatureNoneZ sign_counterparty_htlc_transaction(byte[] htlc_tx, long input, long amount, byte[] per_commitment_point, HTLCOutputInCommitment htlc) {
84 return underlying_ck.sign_counterparty_htlc_transaction(htlc_tx, input, amount, per_commitment_point, htlc);
88 public Result_SignatureNoneZ sign_closing_transaction(byte[] closing_tx) {
89 return underlying_ck.sign_closing_transaction(closing_tx);
93 public Result_SignatureNoneZ sign_channel_announcement(UnsignedChannelAnnouncement msg) {
94 return underlying_ck.sign_channel_announcement(msg);
98 public void ready_channel(ChannelTransactionParameters params) {
99 underlying_ck.ready_channel(params);
103 public byte[] write() {
104 return underlying_ck.write();
107 //Sign resp = Sign.new_impl(si, underlying_ck.get_pubkeys());
108 //must_free_objs.add(new WeakReference<>(si));
109 //must_free_objs.add(new WeakReference<>(resp));
110 must_free_objs.add(new WeakReference<>(underlying_ck));
112 return underlying_ck;
116 public byte[] get_secure_random_bytes() {
117 return underlying_if.get_secure_random_bytes();
121 public Result_SignDecodeErrorZ read_chan_signer(byte[] reader) {
122 return underlying_if.read_chan_signer(reader);
126 public Result_RecoverableSignatureNoneZ sign_invoice(byte[] invoice_preimage) {
127 return underlying_if.sign_invoice(invoice_preimage);
132 Watch get_manual_watch() {
133 Watch.WatchInterface watch_impl = new Watch.WatchInterface() {
134 public Result_NoneChannelMonitorUpdateErrZ watch_channel(OutPoint funding_txo, ChannelMonitor monitor) {
135 synchronized (monitors) {
136 assert monitors.put(Arrays.toString(funding_txo.get_txid()), monitor) == null;
138 return Result_NoneChannelMonitorUpdateErrZ.ok();
141 public Result_NoneChannelMonitorUpdateErrZ update_channel(OutPoint funding_txo, ChannelMonitorUpdate update) {
142 synchronized (monitors) {
143 String txid = Arrays.toString(funding_txo.get_txid());
144 assert monitors.containsKey(txid);
145 Result_NoneMonitorUpdateErrorZ update_res = monitors.get(txid).update_monitor(update, tx_broadcaster, fee_estimator, logger);
146 assert update_res instanceof Result_NoneMonitorUpdateErrorZ.Result_NoneMonitorUpdateErrorZ_OK;
148 return Result_NoneChannelMonitorUpdateErrZ.ok();
152 public MonitorEvent[] release_pending_monitor_events() {
153 synchronized (monitors) {
154 assert monitors.size() <= 1;
155 for (ChannelMonitor mon : monitors.values()) {
156 return mon.get_and_clear_pending_monitor_events();
159 return new MonitorEvent[0];
162 Watch watch = Watch.new_impl(watch_impl);
163 must_free_objs.add(new WeakReference<>(watch_impl));
164 must_free_objs.add(new WeakReference<>(watch));
168 NioPeerHandler nio_peer_handler;
172 final FeeEstimator fee_estimator;
173 final BroadcasterInterface tx_broadcaster;
174 final KeysManager explicit_keys_manager;
175 final KeysInterface keys_interface;
176 final ChainMonitor chain_monitor;
177 final NetGraphMsgHandler router;
178 final Watch chain_watch;
179 final HashSet<String> filter_additions;
181 ChannelManager chan_manager;
182 PeerManager peer_manager;
183 final HashMap<String, ChannelMonitor> monitors; // Wow I forgot just how terrible Java is - we can't put a byte array here.
185 final LinkedList<byte[]> broadcast_set = new LinkedList<>();
186 final LinkedList<Event> pending_manager_events = new LinkedList<>();
187 ChannelManagerConstructor constructor = null;
188 GcCheck obj = new GcCheck();
190 private TwoTuple<OutPoint, byte[]> test_mon_roundtrip(ChannelMonitor mon) {
191 // Because get_funding_txo() returns an OutPoint in a tuple that is a reference to an OutPoint inside the
192 // ChannelMonitor, its a good test to ensure that the OutPoint isn't freed (or is cloned) before the
193 // ChannelMonitor is. This used to be broken.
194 Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ roundtrip_monitor = UtilMethods.BlockHashChannelMonitorZ_read(mon.write(), keys_interface);
195 assert roundtrip_monitor instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
196 TwoTuple<OutPoint, byte[]> funding_txo = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_monitor).res.b.get_funding_txo();
197 System.gc(); System.runFinalization(); // Give the GC a chance to run.
201 private Peer(Object _dummy, byte seed) {
202 logger = Logger.new_impl((String arg) -> System.out.println(seed + ": " + arg));
203 fee_estimator = FeeEstimator.new_impl((confirmation_target -> 253));
204 tx_broadcaster = BroadcasterInterface.new_impl(tx -> {
205 broadcast_set.add(tx);
207 monitors = new HashMap<>();
209 Persist persister = Persist.new_impl(new Persist.PersistInterface() {
211 public Result_NoneChannelMonitorUpdateErrZ persist_new_channel(OutPoint id, ChannelMonitor data) {
212 synchronized (monitors) {
213 String key = Arrays.toString(id.to_channel_id());
214 assert monitors.put(key, data) == null;
215 TwoTuple<OutPoint, byte[]> res = test_mon_roundtrip(data);
216 assert Arrays.equals(res.a.get_txid(), id.get_txid());
217 assert res.a.get_index() == id.get_index();
219 return Result_NoneChannelMonitorUpdateErrZ.ok();
223 public Result_NoneChannelMonitorUpdateErrZ update_persisted_channel(OutPoint id, ChannelMonitorUpdate update, ChannelMonitor data) {
224 synchronized (monitors) {
225 String key = Arrays.toString(id.to_channel_id());
226 assert monitors.put(key, data) != null;
227 TwoTuple<OutPoint, byte[]> res = test_mon_roundtrip(data);
228 assert Arrays.equals(res.a.get_txid(), id.get_txid());
229 assert res.a.get_index() == id.get_index();
231 return Result_NoneChannelMonitorUpdateErrZ.ok();
235 filter_additions = new HashSet<>();
237 this.filter = Filter.new_impl(new Filter.FilterInterface() {
238 @Override public void register_tx(byte[] txid, byte[] script_pubkey) {
239 filter_additions.add(Arrays.toString(txid));
241 @Override public Option_C2Tuple_usizeTransactionZZ register_output(WatchedOutput output) {
242 filter_additions.add(Arrays.toString(output.get_outpoint().get_txid()) + ":" + output.get_outpoint().get_index());
243 return Option_C2Tuple_usizeTransactionZZ.none();
250 if (use_manual_watch) {
251 chain_watch = get_manual_watch();
252 chain_monitor = null;
254 chain_monitor = ChainMonitor.of(filter, tx_broadcaster, logger, fee_estimator, persister);
255 chain_watch = chain_monitor.as_Watch();
258 byte[] key_seed = new byte[32];
259 for (byte i = 0; i < 32; i++) {
260 key_seed[i] = (byte) (i ^ seed);
262 KeysManager keys = KeysManager.of(key_seed, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000));
263 if (use_km_wrapper) {
264 this.keys_interface = manual_keysif(keys.as_KeysInterface());
265 this.explicit_keys_manager = null;
267 this.keys_interface = keys.as_KeysInterface();
268 this.explicit_keys_manager = keys;
270 this.router = NetGraphMsgHandler.of(new byte[32], null, logger);
272 private void bind_nio() {
273 if (!use_nio_peer_handler) return;
274 if (use_chan_manager_constructor) {
275 this.nio_peer_handler = this.constructor.nio_peer_handler;
277 try { this.nio_peer_handler = new NioPeerHandler(peer_manager); } catch (IOException e) { assert false; }
279 for (short i = 10_000; true; i++) {
281 nio_peer_handler.bind_listener(new InetSocketAddress("127.0.0.1", i));
284 } catch (IOException e) { assert i < 10_500; }
289 if (use_chan_manager_constructor) {
290 this.constructor = new ChannelManagerConstructor(Network.LDKNetwork_Bitcoin, UserConfig.with_default(), new byte[32], 0,
291 this.keys_interface, this.fee_estimator, this.chain_monitor, this.router, this.tx_broadcaster, this.logger);
292 constructor.chain_sync_completed(new ChannelManagerConstructor.ChannelManagerPersister() {
293 @Override public void handle_event(Event event) {
294 synchronized (pending_manager_events) {
295 pending_manager_events.add(event);
296 pending_manager_events.notifyAll();
299 @Override public void persist_manager(byte[] channel_manager_bytes) { }
301 this.chan_manager = constructor.channel_manager;
302 this.peer_manager = constructor.peer_manager;
303 must_free_objs.add(new WeakReference<>(this.chan_manager));
305 ChainParameters params = ChainParameters.of(Network.LDKNetwork_Bitcoin, BestBlock.of(new byte[32], 0));
306 this.chan_manager = ChannelManager.of(this.fee_estimator, chain_watch, tx_broadcaster, logger, this.keys_interface, UserConfig.with_default(), params);
307 byte[] random_data = keys_interface.get_secure_random_bytes();
308 this.peer_manager = PeerManager.of(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger);
311 this.node_id = chan_manager.get_our_node_id();
318 this(null, orig.seed);
319 if (use_chan_manager_constructor) {
320 byte[][] monitors = {orig.monitors.values().stream().iterator().next().write()};
321 byte[] serialized = orig.chan_manager.write();
323 this.constructor = new ChannelManagerConstructor(serialized, monitors, this.keys_interface,
324 this.fee_estimator, this.chain_monitor, this.filter, this.router, this.tx_broadcaster, this.logger);
325 constructor.chain_sync_completed(new ChannelManagerConstructor.ChannelManagerPersister() {
326 @Override public void handle_event(Event event) {
327 synchronized (pending_manager_events) {
328 pending_manager_events.add(event);
329 pending_manager_events.notifyAll();
332 @Override public void persist_manager(byte[] channel_manager_bytes) { }
334 this.chan_manager = constructor.channel_manager;
335 this.peer_manager = constructor.peer_manager;
336 must_free_objs.add(new WeakReference<>(this.chan_manager));
337 // If we are using a ChannelManagerConstructor, we may have pending events waiting on the old peer
338 // which have been removed from the ChannelManager but which we still need to handle.
339 this.pending_manager_events.addAll(orig.pending_manager_events);
340 if (!this.pending_manager_events.isEmpty()) {
341 // However, this implies cross_reload_ref_pollution
342 cross_reload_ref_pollution = true;
344 } catch (ChannelManagerConstructor.InvalidSerializedDataException e) {
348 ChannelMonitor[] monitors = new ChannelMonitor[1];
349 assert orig.monitors.size() == 1;
350 if (!break_cross_peer_refs) {
351 monitors[0] = orig.monitors.values().stream().iterator().next();
353 byte[] serialized = orig.monitors.values().stream().iterator().next().write();
354 Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ res =
355 UtilMethods.BlockHashChannelMonitorZ_read(serialized, this.keys_interface);
356 assert res instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
357 monitors[0] = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) res).res.b;
359 byte[] serialized = orig.chan_manager.write();
360 Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ read_res =
361 UtilMethods.BlockHashChannelManagerZ_read(serialized, this.keys_interface, this.fee_estimator, this.chain_watch, this.tx_broadcaster, this.logger, UserConfig.with_default(), monitors);
362 assert read_res instanceof Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK;
363 this.chan_manager = ((Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK) read_res).res.b;
364 this.chain_watch.watch_channel(monitors[0].get_funding_txo().a, monitors[0]);
365 byte[] random_data = keys_interface.get_secure_random_bytes();
366 this.peer_manager = PeerManager.of(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger);
367 if (!break_cross_peer_refs && (use_manual_watch || use_km_wrapper)) {
368 // When we pass monitors[0] into chain_watch.watch_channel we create a reference from the new Peer to a
369 // field in the old peer, preventing freeing of the original Peer until the new Peer is freed. Thus, we
370 // shouldn't bother waiting for the original to be freed later on.
371 cross_reload_ref_pollution = true;
374 this.node_id = chan_manager.get_our_node_id();
377 if (cross_reload_ref_pollution) {
378 // This really, really needs to be handled at the bindings layer, but its rather complicated -
379 // ChannelSigners can be cloned and passed around without java being involved, resulting in them being
380 // owned by both one or more ChannelMonitors and a ChannelManager, with only one having proper pointers
381 // to the ChannelSigner. Ideally, the ChannelSigner would have a global reference to the Java
382 // implementation class, but that results in circular references. Instead, we need some ability to,
383 // while cloning ChannelSigners, add new references in the calling Java struct (ie ChannelMonitor) to
384 // the ChannelSigner.
385 this.ptr_to = orig.chan_manager;
389 TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] connect_block(Block b, int height, long expected_monitor_update_len) {
390 byte[] header = Arrays.copyOfRange(b.bitcoinSerialize(), 0, 80);
391 TwoTuple<Long, byte[]>[] txn;
392 if (b.hasTransactions()) {
393 assert b.getTransactions().size() == 1;
394 TwoTuple<Long, byte[]> txp = new TwoTuple<>((long) 0, b.getTransactions().get(0).bitcoinSerialize());
395 txn = new TwoTuple[]{txp};
397 txn = new TwoTuple[0];
398 if (chain_monitor != null) {
399 chan_manager.as_Listen().block_connected(b.bitcoinSerialize(), height);
400 chain_monitor.as_Listen().block_connected(b.bitcoinSerialize(), height);
402 chan_manager.as_Confirm().transactions_confirmed(header, txn, height);
403 chan_manager.as_Confirm().best_block_updated(header, height);
404 // Connect manually if we aren't using a ChainMonitor and are implementing Watch ourselves
405 synchronized (monitors) {
406 assert monitors.size() == 1;
407 for (ChannelMonitor mon : monitors.values()) {
408 TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] ret = mon.block_connected(header, txn, height, tx_broadcaster, fee_estimator, logger);
409 assert ret.length == expected_monitor_update_len;
417 Event[] get_monitor_events(int expected_len) {
418 if (use_chan_manager_constructor) {
420 synchronized (this.pending_manager_events) {
421 if (expected_len != 0 && this.pending_manager_events.size() != expected_len) {
425 try { Thread.sleep(500); } catch (InterruptedException e) { assert false; }
428 synchronized (this.pending_manager_events) {
429 Event[] res = this.pending_manager_events.toArray(new Event[0]);
430 this.pending_manager_events.clear();
431 assert res.length == expected_len;
434 } else if (chain_monitor != null) {
435 ArrayList<Event> l = new ArrayList<Event>();
436 chain_monitor.as_EventsProvider().process_pending_events(EventHandler.new_impl(l::add));
437 assert l.size() == expected_len;
438 return l.toArray(new Event[0]);
440 synchronized (monitors) {
441 assert monitors.size() == 1;
442 for (ChannelMonitor mon : monitors.values()) {
443 Event[] res = mon.get_and_clear_pending_events();
444 assert res.length == expected_len;
452 Event[] get_manager_events(int expected_len) {
453 Event[] res = new Event[0];
454 if (use_chan_manager_constructor) {
455 while (res.length < expected_len) {
456 synchronized (this.pending_manager_events) {
457 res = this.pending_manager_events.toArray(res);
458 assert res.length == expected_len || res.length == 0; // We don't handle partial results
459 this.pending_manager_events.clear();
460 if (res.length < expected_len) {
461 try { this.pending_manager_events.wait(); } catch (InterruptedException e) { assert false; }
466 ArrayList<Event> l = new ArrayList<Event>();
467 chan_manager.as_EventsProvider().process_pending_events(EventHandler.new_impl(l::add));
468 return l.toArray(new Event[0]);
470 assert res.length == expected_len;
474 Route get_route(byte[] dest_node, ChannelDetails[] our_chans) {
475 try (LockedNetworkGraph netgraph = this.router.read_locked_graph()) {
476 NetworkGraph graph = netgraph.graph();
477 long res = bindings.get_route(this.node_id, graph._test_only_get_ptr(), dest_node, 0L, new long[]{our_chans[0]._test_only_get_ptr()},
478 new long[0], 1000000, 42, this.logger._test_only_get_ptr());
479 assert bindings.LDKCResult_RouteLightningErrorZ_result_ok(res);
480 byte[] serialized_route = bindings.Route_write(bindings.LDKCResult_RouteLightningErrorZ_get_ok(res));
481 must_free_objs.add(new WeakReference<>(serialized_route));
482 Result_RouteDecodeErrorZ copy = Route.read(serialized_route);
483 assert copy instanceof Result_RouteDecodeErrorZ.Result_RouteDecodeErrorZ_OK;
484 bindings.CResult_RouteLightningErrorZ_free(res);
485 return ((Result_RouteDecodeErrorZ.Result_RouteDecodeErrorZ_OK) copy).res;
490 static class DescriptorHolder { SocketDescriptor val; }
492 boolean running = false;
493 final LinkedList<Runnable> runqueue = new LinkedList();
495 Thread t = new Thread(() -> {
499 synchronized (runqueue) {
500 while (runqueue.isEmpty()) {
504 r = runqueue.pollFirst();
507 synchronized (runqueue) {
509 runqueue.notifyAll();
511 } catch (InterruptedException e) {
516 void wait_events_processed(Peer peer1, Peer peer2) {
517 if (use_nio_peer_handler) {
518 peer1.nio_peer_handler.check_events();
519 peer2.nio_peer_handler.check_events();
520 try { Thread.sleep(400); } catch (InterruptedException e) { assert false; }
522 synchronized (runqueue) {
526 peer1.peer_manager.process_events();
527 peer2.peer_manager.process_events();
528 synchronized (runqueue) {
529 if (runqueue.isEmpty() && !running) {
535 try { runqueue.wait(); } catch (InterruptedException e) { assert false; }
540 void do_read_event(PeerManager pm, SocketDescriptor descriptor, byte[] data) {
541 if (!t.isAlive()) t.start();
542 synchronized (runqueue) {
545 Result_boolPeerHandleErrorZ res = pm.read_event(descriptor, data);
546 assert res instanceof Result_boolPeerHandleErrorZ.Result_boolPeerHandleErrorZ_OK;
548 runqueue.notifyAll();
550 must_free_objs.add(new WeakReference<>(data));
553 void connect_peers(final Peer peer1, final Peer peer2) {
554 if (use_nio_peer_handler) {
556 peer1.nio_peer_handler.connect(peer2.chan_manager.get_our_node_id(), new InetSocketAddress("127.0.0.1", peer2.nio_port), 100);
557 } catch (IOException e) { assert false; }
559 DescriptorHolder descriptor1 = new DescriptorHolder();
560 DescriptorHolder descriptor1ref = descriptor1;
561 SocketDescriptor descriptor2 = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
563 public long send_data(byte[] data, boolean resume_read) {
564 do_read_event(peer1.peer_manager, descriptor1ref.val, data);
568 @Override public void disconnect_socket() { assert false; }
569 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 2; }
570 @Override public long hash() { return 2; }
573 descriptor1.val = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
575 public long send_data(byte[] data, boolean resume_read) {
576 do_read_event(peer2.peer_manager, descriptor2, data);
580 @Override public void disconnect_socket() { assert false; }
581 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 1; }
582 @Override public long hash() { return 1; }
585 Result_CVec_u8ZPeerHandleErrorZ conn_res = peer1.peer_manager.new_outbound_connection(peer2.node_id, descriptor1.val);
586 assert conn_res instanceof Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK;
588 Result_NonePeerHandleErrorZ inbound_conn_res = peer2.peer_manager.new_inbound_connection(descriptor2);
589 assert inbound_conn_res instanceof Result_NonePeerHandleErrorZ.Result_NonePeerHandleErrorZ_OK;
590 do_read_event(peer2.peer_manager, descriptor2, ((Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK) conn_res).res);
594 TestState do_test_message_handler() throws InterruptedException {
595 Peer peer1 = new Peer((byte) 1);
596 Peer peer2 = new Peer((byte) 2);
598 connect_peers(peer1, peer2);
599 wait_events_processed(peer1, peer2);
601 Result_NoneAPIErrorZ cc_res = peer1.chan_manager.create_channel(peer2.node_id, 10000, 1000, 42, null);
602 assert cc_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
603 wait_events_processed(peer1, peer2);
605 Event[] events = peer1.get_manager_events(1);
606 assert events[0] instanceof Event.FundingGenerationReady;
607 assert ((Event.FundingGenerationReady) events[0]).channel_value_satoshis == 10000;
608 assert ((Event.FundingGenerationReady) events[0]).user_channel_id == 42;
609 byte[] funding_spk = ((Event.FundingGenerationReady) events[0]).output_script;
610 assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
611 byte[] chan_id = ((Event.FundingGenerationReady) events[0]).temporary_channel_id;
613 NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
615 Transaction funding = new Transaction(bitcoinj_net);
616 funding.addInput(new TransactionInput(bitcoinj_net, funding, new byte[0]));
617 funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
618 funding.getInput(0).getWitness().setPush(0, new byte[]{0x1});
619 funding.addOutput(Coin.SATOSHI.multiply(10000), new Script(funding_spk));
620 Result_NoneAPIErrorZ funding_res = peer1.chan_manager.funding_transaction_generated(chan_id, funding.bitcoinSerialize());
621 assert funding_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
622 wait_events_processed(peer1, peer2);
624 assert peer1.broadcast_set.size() == 1;
625 assert Arrays.equals(peer1.broadcast_set.get(0), funding.bitcoinSerialize());
626 peer1.broadcast_set.clear();
628 Block b = new Block(bitcoinj_net, 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
629 peer1.connect_block(b, 1, 0);
630 peer2.connect_block(b, 1, 0);
632 for (int height = 2; height < 10; height++) {
633 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[0]));
634 peer1.connect_block(b, height, 0);
635 peer2.connect_block(b, height, 0);
637 wait_events_processed(peer1, peer2);
639 peer1.chan_manager.list_channels();
640 ChannelDetails[] peer1_chans = peer1.chan_manager.list_usable_channels();
641 ChannelDetails[] peer2_chans = peer2.chan_manager.list_usable_channels();
642 assert peer1_chans.length == 1;
643 assert peer2_chans.length == 1;
644 assert peer1_chans[0].get_channel_value_satoshis() == 10000;
645 assert peer1_chans[0].get_is_usable();
646 Option_u64Z short_chan_id = peer1_chans[0].get_short_channel_id();
647 assert short_chan_id instanceof Option_u64Z.Some;
648 assert ((Option_u64Z.Some)short_chan_id).some == (1L << 40); // 0th output in the 0th transaction in the 1st block
649 assert Arrays.equals(peer1_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
650 assert Arrays.equals(peer2_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
652 Result_InvoiceSignOrCreationErrorZ invoice = UtilMethods.create_invoice_from_channelmanager(peer2.chan_manager, peer2.keys_interface, Currency.LDKCurrency_Bitcoin, Option_u64Z.none(), "Invoice Description");
653 assert invoice instanceof Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK;
654 System.out.println("Got invoice: " + ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
656 Result_InvoiceNoneZ parsed_invoice = Invoice.from_str(((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
657 assert parsed_invoice instanceof Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK;
658 assert Arrays.equals(((Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK) parsed_invoice).res.payment_hash(), ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash());
659 SignedRawInvoice signed_raw = ((Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK) parsed_invoice).res.into_signed_raw();
660 RawInvoice raw_invoice = signed_raw.raw_invoice();
661 byte[] desc_hash = raw_invoice.hash();
662 Description raw_invoice_description = raw_invoice.description();
663 String description_string = raw_invoice_description.into_inner();
664 assert description_string.equals("Invoice Description");
665 byte[] payment_hash = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash();
666 byte[] payment_secret = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_secret();
668 Route route = peer1.get_route(peer2.node_id, peer1_chans);
669 Result_NonePaymentSendFailureZ payment_res = peer1.chan_manager.send_payment(route, payment_hash, payment_secret);
670 assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_OK;
671 wait_events_processed(peer1, peer2);
673 RouteHop[][] hops = new RouteHop[1][1];
674 byte[] hop_pubkey = new byte[33];
677 hops[0][0] = RouteHop.of(hop_pubkey, NodeFeatures.known(), 42, ChannelFeatures.known(), 100, 0);
678 Route r2 = Route.of(hops);
679 payment_res = peer1.chan_manager.send_payment(r2, payment_hash, payment_secret);
680 assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_Err;
682 if (!use_chan_manager_constructor) {
683 peer1.get_monitor_events(0);
684 peer2.get_monitor_events(0);
686 // The events are combined across manager + monitors but peer1 still has no events
690 if (use_nio_peer_handler) {
691 peer1.nio_peer_handler.interrupt();
692 peer2.nio_peer_handler.interrupt();
694 if (use_chan_manager_constructor) {
695 peer1.constructor.interrupt();
696 peer2.constructor.interrupt();
698 WeakReference<Peer> op1 = new WeakReference<Peer>(peer1);
699 peer1 = new Peer(peer1);
700 peer2 = new Peer(peer2);
701 return new TestState(op1, peer1, peer2, b.getHash());
703 return new TestState(null, peer1, peer2, b.getHash());
706 boolean cross_reload_ref_pollution = false;
708 private final WeakReference<Peer> ref_block;
709 private final Peer peer1;
710 private final Peer peer2;
711 public Sha256Hash best_blockhash;
713 public TestState(WeakReference<Peer> ref_block, Peer peer1, Peer peer2, Sha256Hash best_blockhash) {
714 this.ref_block = ref_block;
717 this.best_blockhash = best_blockhash;
720 void do_test_message_handler_b(TestState state) {
721 GcCheck obj = new GcCheck();
722 if (state.ref_block != null) {
723 // Ensure the original peers get freed before we move on. Note that we have to be in a different function
724 // scope to do so as the (at least current OpenJDK) JRE won't release anything created in the same scope.
725 while (!cross_reload_ref_pollution && state.ref_block.get() != null) {
727 System.runFinalization();
729 connect_peers(state.peer1, state.peer2);
731 wait_events_processed(state.peer1, state.peer2);
733 Event[] events = state.peer2.get_manager_events(1);
734 assert events[0] instanceof Event.PendingHTLCsForwardable;
735 state.peer2.chan_manager.process_pending_htlc_forwards();
737 events = state.peer2.get_manager_events(1);
738 assert events[0] instanceof Event.PaymentReceived;
739 byte[] payment_preimage = ((Event.PaymentReceived)events[0]).payment_preimage;
740 assert !Arrays.equals(payment_preimage, new byte[32]);
741 state.peer2.chan_manager.claim_funds(payment_preimage);
742 wait_events_processed(state.peer1, state.peer2);
744 events = state.peer1.get_manager_events(1);
745 assert events[0] instanceof Event.PaymentSent;
746 assert Arrays.equals(((Event.PaymentSent) events[0]).payment_preimage, payment_preimage);
747 wait_events_processed(state.peer1, state.peer2);
749 ChannelDetails[] peer1_chans = state.peer1.chan_manager.list_channels();
752 Result_NoneAPIErrorZ close_res = state.peer1.chan_manager.close_channel(peer1_chans[0].get_channel_id());
753 assert close_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
754 wait_events_processed(state.peer1, state.peer2);
756 assert state.peer1.broadcast_set.size() == 1;
757 assert state.peer2.broadcast_set.size() == 1;
759 state.peer1.chan_manager.force_close_all_channels();
760 wait_events_processed(state.peer1, state.peer2);
762 assert state.peer1.broadcast_set.size() == 1;
763 assert state.peer2.broadcast_set.size() == 1;
765 NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
766 Transaction tx = new Transaction(bitcoinj_net, state.peer1.broadcast_set.getFirst());
767 Block b = new Block(bitcoinj_net, 2, state.best_blockhash, Sha256Hash.ZERO_HASH, 42, 0, 0,
768 Arrays.asList(new Transaction[]{tx}));
769 TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] watch_outputs = state.peer2.connect_block(b, 10, 1);
770 if (watch_outputs != null) { // We only process watch_outputs manually when we use a manually-build Watch impl
771 assert watch_outputs.length == 1;
772 assert Arrays.equals(watch_outputs[0].a, tx.getTxId().getReversedBytes());
773 assert watch_outputs[0].b.length == 2;
774 assert watch_outputs[0].b[0].a == 0;
775 assert watch_outputs[0].b[1].a == 1;
778 for (int i = 11; i < 21; i++) {
779 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, new ArrayList<>());
780 state.peer2.connect_block(b, i, 0);
783 Event[] broadcastable_event = state.peer2.get_monitor_events(1);
784 for (ChannelMonitor mon : state.peer2.monitors.values()) {
785 // This used to be buggy and double-free, so go ahead and fetch them!
786 byte[][] txn = mon.get_latest_holder_commitment_txn(state.peer2.logger);
788 assert broadcastable_event.length == 1;
789 assert broadcastable_event[0] instanceof Event.SpendableOutputs;
790 if (state.peer2.explicit_keys_manager != null) {
791 Result_TransactionNoneZ tx_res = state.peer2.explicit_keys_manager.spend_spendable_outputs(((Event.SpendableOutputs) broadcastable_event[0]).outputs, new TxOut[0], new byte[] {0x00}, 253);
792 assert tx_res instanceof Result_TransactionNoneZ.Result_TransactionNoneZ_OK;
793 Transaction built_tx = new Transaction(bitcoinj_net, ((Result_TransactionNoneZ.Result_TransactionNoneZ_OK) tx_res).res);
794 assert built_tx.getOutputs().size() == 1;
795 assert Arrays.equals(built_tx.getOutput(0).getScriptBytes(), new byte[]{0x00});
799 if (use_nio_peer_handler) {
800 state.peer1.peer_manager.disconnect_by_node_id(state.peer2.chan_manager.get_our_node_id(), false);
801 wait_events_processed(state.peer1, state.peer2);
802 assert state.peer1.peer_manager.get_peer_node_ids().length == 0;
803 assert state.peer2.peer_manager.get_peer_node_ids().length == 0;
804 state.peer1.nio_peer_handler.interrupt();
805 state.peer2.nio_peer_handler.interrupt();
808 state.peer1.get_monitor_events(0);
809 state.peer2.get_monitor_events(0);
811 if (use_chan_manager_constructor) {
812 state.peer1.constructor.interrupt();
813 state.peer2.constructor.interrupt();
819 java.util.LinkedList<WeakReference<Object>> must_free_objs = new java.util.LinkedList();
821 int gc_exp_count = 0;
823 GcCheck() { gc_exp_count += 1; }
825 protected void finalize() throws Throwable {
831 public class HumanObjectPeerTest {
832 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_chan_manager_constructor) throws InterruptedException {
833 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_chan_manager_constructor);
834 HumanObjectPeerTestInstance.TestState state = instance.do_test_message_handler();
835 instance.do_test_message_handler_b(state);
838 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_chan_manager_constructor) throws InterruptedException {
839 HumanObjectPeerTestInstance instance = do_test_run(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_peer_refs, nio_peer_handler, use_chan_manager_constructor);
840 while (instance.gc_count != instance.gc_exp_count) {
842 System.runFinalization();
844 for (WeakReference<Object> o : instance.must_free_objs)
845 assert o.get() == null;
848 public void test_message_handler() throws InterruptedException {
849 for (int i = 0; i < (1 << 7) - 1; i++) {
850 boolean nice_close = (i & (1 << 0)) != 0;
851 boolean use_km_wrapper = (i & (1 << 1)) != 0;
852 boolean use_manual_watch = (i & (1 << 2)) != 0;
853 boolean reload_peers = (i & (1 << 3)) != 0;
854 boolean break_cross_refs = (i & (1 << 4)) != 0;
855 boolean nio_peer_handler = (i & (1 << 5)) != 0;
856 boolean use_chan_manager_constructor = (i & (1 << 6)) != 0;
857 if (break_cross_refs && !reload_peers) {
858 // There are no cross refs to break without reloading peers.
861 if (use_chan_manager_constructor && (use_manual_watch || !nio_peer_handler)) {
862 // ChannelManagerConstructor requires a ChainMonitor as the Watch and creates a NioPeerHandler for us.
865 System.err.println("Running test with flags " + i);
866 do_test(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_refs, nio_peer_handler, use_chan_manager_constructor);