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_chan_manager_constructor;
28 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) {
29 this.nice_close = nice_close;
30 this.use_km_wrapper = use_km_wrapper;
31 this.use_manual_watch = use_manual_watch;
32 this.reload_peers = reload_peers;
33 this.break_cross_peer_refs = break_cross_peer_refs;
34 this.use_nio_peer_handler = use_nio_peer_handler;
35 this.use_filter = use_filter;
36 this.use_chan_manager_constructor = use_chan_manager_constructor;
40 KeysInterface manual_keysif(KeysInterface underlying_if) {
41 return KeysInterface.new_impl(new KeysInterface.KeysInterfaceInterface() {
42 @Override public byte[] get_node_secret() { return underlying_if.get_node_secret(); }
43 @Override public byte[] get_destination_script() { return underlying_if.get_destination_script(); }
44 @Override public byte[] get_shutdown_pubkey() { return underlying_if.get_shutdown_pubkey(); }
47 public Sign get_channel_signer(boolean inbound, long channel_value_satoshis) {
48 Sign underlying_ck = underlying_if.get_channel_signer(inbound, channel_value_satoshis);
49 // TODO: Expose the underlying signer from a Sign
50 /*BaseSign.BaseSignInterface si = new BaseSign.BaseSignInterface() {
52 public byte[] get_per_commitment_point(long idx) {
53 return underlying_ck.get_per_commitment_point(idx);
57 public byte[] release_commitment_secret(long idx) {
58 return underlying_ck.release_commitment_secret(idx);
62 public byte[] channel_keys_id() {
67 public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_counterparty_commitment(CommitmentTransaction commitment_tx) {
68 return underlying_ck.sign_counterparty_commitment(commitment_tx);
72 public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_holder_commitment_and_htlcs(HolderCommitmentTransaction holder_commitment_tx) {
73 return underlying_ck.sign_holder_commitment_and_htlcs(holder_commitment_tx);
77 public Result_SignatureNoneZ sign_justice_transaction(byte[] justice_tx, long input, long amount, byte[] per_commitment_key, HTLCOutputInCommitment htlc) {
78 return underlying_ck.sign_justice_transaction(justice_tx, input, amount, per_commitment_key, htlc);
82 public Result_SignatureNoneZ sign_counterparty_htlc_transaction(byte[] htlc_tx, long input, long amount, byte[] per_commitment_point, HTLCOutputInCommitment htlc) {
83 return underlying_ck.sign_counterparty_htlc_transaction(htlc_tx, input, amount, per_commitment_point, htlc);
87 public Result_SignatureNoneZ sign_closing_transaction(byte[] closing_tx) {
88 return underlying_ck.sign_closing_transaction(closing_tx);
92 public Result_SignatureNoneZ sign_channel_announcement(UnsignedChannelAnnouncement msg) {
93 return underlying_ck.sign_channel_announcement(msg);
97 public void ready_channel(ChannelTransactionParameters params) {
98 underlying_ck.ready_channel(params);
102 public byte[] write() {
103 return underlying_ck.write();
106 //Sign resp = Sign.new_impl(si, underlying_ck.get_pubkeys());
107 //must_free_objs.add(new WeakReference<>(si));
108 //must_free_objs.add(new WeakReference<>(resp));
109 must_free_objs.add(new WeakReference<>(underlying_ck));
111 return underlying_ck;
115 public byte[] get_secure_random_bytes() {
116 return underlying_if.get_secure_random_bytes();
120 public Result_SignDecodeErrorZ read_chan_signer(byte[] reader) {
121 return underlying_if.read_chan_signer(reader);
125 public Result_RecoverableSignatureNoneZ sign_invoice(byte[] invoice_preimage) {
126 return underlying_if.sign_invoice(invoice_preimage);
131 Watch get_manual_watch() {
132 Watch.WatchInterface watch_impl = new Watch.WatchInterface() {
133 public Result_NoneChannelMonitorUpdateErrZ watch_channel(OutPoint funding_txo, ChannelMonitor monitor) {
134 synchronized (monitors) {
135 assert monitors.put(Arrays.toString(funding_txo.get_txid()), monitor) == null;
137 return Result_NoneChannelMonitorUpdateErrZ.ok();
140 public Result_NoneChannelMonitorUpdateErrZ update_channel(OutPoint funding_txo, ChannelMonitorUpdate update) {
141 synchronized (monitors) {
142 String txid = Arrays.toString(funding_txo.get_txid());
143 assert monitors.containsKey(txid);
144 Result_NoneMonitorUpdateErrorZ update_res = monitors.get(txid).update_monitor(update, tx_broadcaster, fee_estimator, logger);
145 assert update_res instanceof Result_NoneMonitorUpdateErrorZ.Result_NoneMonitorUpdateErrorZ_OK;
147 return Result_NoneChannelMonitorUpdateErrZ.ok();
151 public MonitorEvent[] release_pending_monitor_events() {
152 synchronized (monitors) {
153 assert monitors.size() <= 1;
154 for (ChannelMonitor mon : monitors.values()) {
155 return mon.get_and_clear_pending_monitor_events();
158 return new MonitorEvent[0];
161 Watch watch = Watch.new_impl(watch_impl);
162 must_free_objs.add(new WeakReference<>(watch_impl));
163 must_free_objs.add(new WeakReference<>(watch));
167 NioPeerHandler nio_peer_handler;
171 final FeeEstimator fee_estimator;
172 final BroadcasterInterface tx_broadcaster;
173 final KeysManager explicit_keys_manager;
174 final KeysInterface keys_interface;
175 final ChainMonitor chain_monitor;
176 final NetGraphMsgHandler router;
177 final Watch chain_watch;
178 final HashSet<String> filter_additions;
180 ChannelManager chan_manager;
181 PeerManager peer_manager;
182 final HashMap<String, ChannelMonitor> monitors; // Wow I forgot just how terrible Java is - we can't put a byte array here.
184 final LinkedList<byte[]> broadcast_set = new LinkedList<>();
185 final LinkedList<Event> pending_manager_events = new LinkedList<>();
186 ChannelManagerConstructor constructor = null;
187 GcCheck obj = new GcCheck();
189 private TwoTuple<OutPoint, byte[]> test_mon_roundtrip(ChannelMonitor mon) {
190 // Because get_funding_txo() returns an OutPoint in a tuple that is a reference to an OutPoint inside the
191 // ChannelMonitor, its a good test to ensure that the OutPoint isn't freed (or is cloned) before the
192 // ChannelMonitor is. This used to be broken.
193 Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ roundtrip_monitor = UtilMethods.BlockHashChannelMonitorZ_read(mon.write(), keys_interface);
194 assert roundtrip_monitor instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
195 TwoTuple<OutPoint, byte[]> funding_txo = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_monitor).res.b.get_funding_txo();
196 System.gc(); System.runFinalization(); // Give the GC a chance to run.
200 private Peer(Object _dummy, byte seed) {
201 logger = Logger.new_impl((String arg) -> System.out.println(seed + ": " + arg));
202 fee_estimator = FeeEstimator.new_impl((confirmation_target -> 253));
203 tx_broadcaster = BroadcasterInterface.new_impl(tx -> {
204 synchronized (broadcast_set) {
205 broadcast_set.add(tx);
206 broadcast_set.notifyAll();
209 monitors = new HashMap<>();
211 Persist persister = Persist.new_impl(new Persist.PersistInterface() {
213 public Result_NoneChannelMonitorUpdateErrZ persist_new_channel(OutPoint id, ChannelMonitor data) {
214 synchronized (monitors) {
215 String key = Arrays.toString(id.to_channel_id());
216 assert monitors.put(key, data) == null;
217 TwoTuple<OutPoint, byte[]> res = test_mon_roundtrip(data);
218 assert Arrays.equals(res.a.get_txid(), id.get_txid());
219 assert res.a.get_index() == id.get_index();
221 return Result_NoneChannelMonitorUpdateErrZ.ok();
225 public Result_NoneChannelMonitorUpdateErrZ update_persisted_channel(OutPoint id, ChannelMonitorUpdate update, ChannelMonitor data) {
226 synchronized (monitors) {
227 String key = Arrays.toString(id.to_channel_id());
228 assert monitors.put(key, data) != null;
229 TwoTuple<OutPoint, byte[]> res = test_mon_roundtrip(data);
230 assert Arrays.equals(res.a.get_txid(), id.get_txid());
231 assert res.a.get_index() == id.get_index();
233 return Result_NoneChannelMonitorUpdateErrZ.ok();
237 filter_additions = new HashSet<>();
239 this.filter = Filter.new_impl(new Filter.FilterInterface() {
240 @Override public void register_tx(byte[] txid, byte[] script_pubkey) {
241 filter_additions.add(Arrays.toString(txid));
243 @Override public Option_C2Tuple_usizeTransactionZZ register_output(WatchedOutput output) {
244 filter_additions.add(Arrays.toString(output.get_outpoint().get_txid()) + ":" + output.get_outpoint().get_index());
245 return Option_C2Tuple_usizeTransactionZZ.none();
252 if (use_manual_watch) {
253 chain_watch = get_manual_watch();
254 chain_monitor = null;
256 chain_monitor = ChainMonitor.of(filter, tx_broadcaster, logger, fee_estimator, persister);
257 chain_watch = chain_monitor.as_Watch();
260 byte[] key_seed = new byte[32];
261 for (byte i = 0; i < 32; i++) {
262 key_seed[i] = (byte) (i ^ seed);
264 KeysManager keys = KeysManager.of(key_seed, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000));
265 if (use_km_wrapper) {
266 this.keys_interface = manual_keysif(keys.as_KeysInterface());
267 this.explicit_keys_manager = null;
269 this.keys_interface = keys.as_KeysInterface();
270 this.explicit_keys_manager = keys;
272 this.router = NetGraphMsgHandler.of(new byte[32], null, logger);
274 private void bind_nio() {
275 if (!use_nio_peer_handler) return;
276 if (use_chan_manager_constructor) {
277 this.nio_peer_handler = this.constructor.nio_peer_handler;
279 try { this.nio_peer_handler = new NioPeerHandler(peer_manager); } catch (IOException e) { assert false; }
281 for (short i = 10_000; true; i++) {
283 nio_peer_handler.bind_listener(new InetSocketAddress("127.0.0.1", i));
286 } catch (IOException e) { assert i < 10_500; }
291 if (use_chan_manager_constructor) {
292 this.constructor = new ChannelManagerConstructor(Network.LDKNetwork_Bitcoin, UserConfig.with_default(), new byte[32], 0,
293 this.keys_interface, this.fee_estimator, this.chain_monitor, this.router, this.tx_broadcaster, this.logger);
294 constructor.chain_sync_completed(new ChannelManagerConstructor.ChannelManagerPersister() {
295 @Override public void handle_event(Event event) {
296 synchronized (pending_manager_events) {
297 pending_manager_events.add(event);
298 pending_manager_events.notifyAll();
301 @Override public void persist_manager(byte[] channel_manager_bytes) { }
303 this.chan_manager = constructor.channel_manager;
304 this.peer_manager = constructor.peer_manager;
305 must_free_objs.add(new WeakReference<>(this.chan_manager));
307 ChainParameters params = ChainParameters.of(Network.LDKNetwork_Bitcoin, BestBlock.of(new byte[32], 0));
308 this.chan_manager = ChannelManager.of(this.fee_estimator, chain_watch, tx_broadcaster, logger, this.keys_interface, UserConfig.with_default(), params);
309 byte[] random_data = keys_interface.get_secure_random_bytes();
310 this.peer_manager = PeerManager.of(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger);
313 this.node_id = chan_manager.get_our_node_id();
320 this(null, orig.seed);
321 if (use_chan_manager_constructor) {
322 byte[][] monitors = {orig.monitors.values().stream().iterator().next().write()};
323 byte[] serialized = orig.chan_manager.write();
325 this.constructor = new ChannelManagerConstructor(serialized, monitors, this.keys_interface,
326 this.fee_estimator, this.chain_monitor, this.filter, this.router, this.tx_broadcaster, this.logger);
327 constructor.chain_sync_completed(new ChannelManagerConstructor.ChannelManagerPersister() {
328 @Override public void handle_event(Event event) {
329 synchronized (pending_manager_events) {
330 pending_manager_events.add(event);
331 pending_manager_events.notifyAll();
334 @Override public void persist_manager(byte[] channel_manager_bytes) { }
336 this.chan_manager = constructor.channel_manager;
337 this.peer_manager = constructor.peer_manager;
338 must_free_objs.add(new WeakReference<>(this.chan_manager));
339 // If we are using a ChannelManagerConstructor, we may have pending events waiting on the old peer
340 // which have been removed from the ChannelManager but which we still need to handle.
341 this.pending_manager_events.addAll(orig.pending_manager_events);
342 if (!this.pending_manager_events.isEmpty()) {
343 // However, this implies cross_reload_ref_pollution
344 cross_reload_ref_pollution = true;
346 } catch (ChannelManagerConstructor.InvalidSerializedDataException e) {
350 ChannelMonitor[] monitors = new ChannelMonitor[1];
351 assert orig.monitors.size() == 1;
352 if (!break_cross_peer_refs) {
353 monitors[0] = orig.monitors.values().stream().iterator().next();
355 byte[] serialized = orig.monitors.values().stream().iterator().next().write();
356 Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ res =
357 UtilMethods.BlockHashChannelMonitorZ_read(serialized, this.keys_interface);
358 assert res instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
359 monitors[0] = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) res).res.b;
361 byte[] serialized = orig.chan_manager.write();
362 Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ read_res =
363 UtilMethods.BlockHashChannelManagerZ_read(serialized, this.keys_interface, this.fee_estimator, this.chain_watch, this.tx_broadcaster, this.logger, UserConfig.with_default(), monitors);
364 assert read_res instanceof Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK;
365 this.chan_manager = ((Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK) read_res).res.b;
366 this.chain_watch.watch_channel(monitors[0].get_funding_txo().a, monitors[0]);
367 byte[] random_data = keys_interface.get_secure_random_bytes();
368 this.peer_manager = PeerManager.of(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger);
369 if (!break_cross_peer_refs && (use_manual_watch || use_km_wrapper)) {
370 // When we pass monitors[0] into chain_watch.watch_channel we create a reference from the new Peer to a
371 // field in the old peer, preventing freeing of the original Peer until the new Peer is freed. Thus, we
372 // shouldn't bother waiting for the original to be freed later on.
373 cross_reload_ref_pollution = true;
376 this.node_id = chan_manager.get_our_node_id();
379 if (cross_reload_ref_pollution) {
380 // This really, really needs to be handled at the bindings layer, but its rather complicated -
381 // ChannelSigners can be cloned and passed around without java being involved, resulting in them being
382 // owned by both one or more ChannelMonitors and a ChannelManager, with only one having proper pointers
383 // to the ChannelSigner. Ideally, the ChannelSigner would have a global reference to the Java
384 // implementation class, but that results in circular references. Instead, we need some ability to,
385 // while cloning ChannelSigners, add new references in the calling Java struct (ie ChannelMonitor) to
386 // the ChannelSigner.
387 this.ptr_to = orig.chan_manager;
391 TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] connect_block(Block b, int height, long expected_monitor_update_len) {
392 byte[] header = Arrays.copyOfRange(b.bitcoinSerialize(), 0, 80);
393 TwoTuple<Long, byte[]>[] txn;
394 if (b.hasTransactions()) {
395 assert b.getTransactions().size() == 1;
396 TwoTuple<Long, byte[]> txp = new TwoTuple<>((long) 0, b.getTransactions().get(0).bitcoinSerialize());
397 txn = new TwoTuple[]{txp};
399 txn = new TwoTuple[0];
400 if (chain_monitor != null) {
401 chan_manager.as_Listen().block_connected(b.bitcoinSerialize(), height);
402 chain_monitor.as_Listen().block_connected(b.bitcoinSerialize(), height);
404 chan_manager.as_Confirm().transactions_confirmed(header, txn, height);
405 chan_manager.as_Confirm().best_block_updated(header, height);
406 // Connect manually if we aren't using a ChainMonitor and are implementing Watch ourselves
407 synchronized (monitors) {
408 assert monitors.size() == 1;
409 for (ChannelMonitor mon : monitors.values()) {
410 TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] ret = mon.block_connected(header, txn, height, tx_broadcaster, fee_estimator, logger);
411 assert ret.length == expected_monitor_update_len;
419 Event[] get_monitor_events(int expected_len) {
420 if (use_chan_manager_constructor) {
422 synchronized (this.pending_manager_events) {
423 if (expected_len != 0 && this.pending_manager_events.size() == expected_len) {
427 if (expected_len == 0) {
428 try { Thread.sleep(500); } catch (InterruptedException e) { assert false; }
434 synchronized (this.pending_manager_events) {
435 Event[] res = this.pending_manager_events.toArray(new Event[0]);
436 this.pending_manager_events.clear();
437 assert res.length == expected_len;
440 } else if (chain_monitor != null) {
441 ArrayList<Event> l = new ArrayList<Event>();
442 chain_monitor.as_EventsProvider().process_pending_events(EventHandler.new_impl(l::add));
443 assert l.size() == expected_len;
444 return l.toArray(new Event[0]);
446 synchronized (monitors) {
447 assert monitors.size() == 1;
448 for (ChannelMonitor mon : monitors.values()) {
449 Event[] res = mon.get_and_clear_pending_events();
450 assert res.length == expected_len;
458 Event[] get_manager_events(int expected_len, Peer peer1, Peer peer2) {
459 assert expected_len != 0;
460 if (!use_nio_peer_handler) {
461 maybe_exchange_peer_messages(peer1, peer2);
463 Event[] res = new Event[0];
464 if (use_chan_manager_constructor) {
465 while (res.length < expected_len) {
466 synchronized (this.pending_manager_events) {
467 res = this.pending_manager_events.toArray(res);
468 assert res.length == expected_len || res.length == 0; // We don't handle partial results
469 this.pending_manager_events.clear();
470 if (res.length < expected_len) {
471 try { this.pending_manager_events.wait(); } catch (InterruptedException e) { assert false; }
476 ArrayList<Event> l = new ArrayList<Event>();
477 while (l.size() < expected_len) {
479 if (use_nio_peer_handler) {
480 peer1.nio_peer_handler.check_events();
481 peer2.nio_peer_handler.check_events();
483 chan_manager.as_EventsProvider().process_pending_events(EventHandler.new_impl(l::add));
484 assert l.size() == expected_len || l.size() == 0; // We don't handle partial results
486 return l.toArray(new Event[0]);
488 assert res.length == expected_len;
493 static class DescriptorHolder { SocketDescriptor val; }
495 boolean running = false;
496 final LinkedList<Runnable> runqueue = new LinkedList();
498 Thread t = new Thread(() -> {
502 synchronized (runqueue) {
503 while (runqueue.isEmpty()) {
507 r = runqueue.pollFirst();
510 synchronized (runqueue) {
512 runqueue.notifyAll();
514 } catch (InterruptedException e) {
520 void maybe_exchange_peer_messages(Peer peer1, Peer peer2) {
521 if (!use_nio_peer_handler) {
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; }
538 } else if (!use_chan_manager_constructor) {
539 peer1.nio_peer_handler.check_events();
540 peer2.nio_peer_handler.check_events();
543 void do_read_event(PeerManager pm, SocketDescriptor descriptor, byte[] data) {
544 if (!t.isAlive()) t.start();
545 synchronized (runqueue) {
548 Result_boolPeerHandleErrorZ res = pm.read_event(descriptor, data);
549 assert res instanceof Result_boolPeerHandleErrorZ.Result_boolPeerHandleErrorZ_OK;
551 runqueue.notifyAll();
553 must_free_objs.add(new WeakReference<>(data));
556 void connect_peers(final Peer peer1, final Peer peer2) {
557 if (use_nio_peer_handler) {
559 peer1.nio_peer_handler.connect(peer2.chan_manager.get_our_node_id(), new InetSocketAddress("127.0.0.1", peer2.nio_port), 100);
560 } catch (IOException e) { assert false; }
561 while (peer1.peer_manager.get_peer_node_ids().length == 0 || peer2.peer_manager.get_peer_node_ids().length == 0) {
565 DescriptorHolder descriptor1 = new DescriptorHolder();
566 DescriptorHolder descriptor1ref = descriptor1;
567 SocketDescriptor descriptor2 = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
569 public long send_data(byte[] data, boolean resume_read) {
570 do_read_event(peer1.peer_manager, descriptor1ref.val, data);
574 @Override public void disconnect_socket() { assert false; }
575 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 2; }
576 @Override public long hash() { return 2; }
579 descriptor1.val = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
581 public long send_data(byte[] data, boolean resume_read) {
582 do_read_event(peer2.peer_manager, descriptor2, data);
586 @Override public void disconnect_socket() { assert false; }
587 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 1; }
588 @Override public long hash() { return 1; }
591 Result_CVec_u8ZPeerHandleErrorZ conn_res = peer1.peer_manager.new_outbound_connection(peer2.node_id, descriptor1.val);
592 assert conn_res instanceof Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK;
594 Result_NonePeerHandleErrorZ inbound_conn_res = peer2.peer_manager.new_inbound_connection(descriptor2);
595 assert inbound_conn_res instanceof Result_NonePeerHandleErrorZ.Result_NonePeerHandleErrorZ_OK;
596 do_read_event(peer2.peer_manager, descriptor2, ((Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK) conn_res).res);
598 maybe_exchange_peer_messages(peer1, peer2);
602 TestState do_test_message_handler() throws InterruptedException {
603 Peer peer1 = new Peer((byte) 1);
604 Peer peer2 = new Peer((byte) 2);
606 connect_peers(peer1, peer2);
608 Result_NoneAPIErrorZ cc_res = peer1.chan_manager.create_channel(peer2.node_id, 10000, 1000, 42, null);
609 assert cc_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
611 Event[] events = peer1.get_manager_events(1, peer1, peer2);
612 assert events[0] instanceof Event.FundingGenerationReady;
613 assert ((Event.FundingGenerationReady) events[0]).channel_value_satoshis == 10000;
614 assert ((Event.FundingGenerationReady) events[0]).user_channel_id == 42;
615 byte[] funding_spk = ((Event.FundingGenerationReady) events[0]).output_script;
616 assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
617 byte[] chan_id = ((Event.FundingGenerationReady) events[0]).temporary_channel_id;
619 NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
621 Transaction funding = new Transaction(bitcoinj_net);
622 funding.addInput(new TransactionInput(bitcoinj_net, funding, new byte[0]));
623 funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
624 funding.getInput(0).getWitness().setPush(0, new byte[]{0x1});
625 funding.addOutput(Coin.SATOSHI.multiply(10000), new Script(funding_spk));
626 Result_NoneAPIErrorZ funding_res = peer1.chan_manager.funding_transaction_generated(chan_id, funding.bitcoinSerialize());
627 assert funding_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
629 maybe_exchange_peer_messages(peer1, peer2);
630 synchronized (peer1.broadcast_set) {
631 while (peer1.broadcast_set.size() != 1) {
632 peer1.broadcast_set.wait();
636 assert peer1.broadcast_set.size() == 1;
637 assert Arrays.equals(peer1.broadcast_set.get(0), funding.bitcoinSerialize());
638 peer1.broadcast_set.clear();
640 Block b = new Block(bitcoinj_net, 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
641 peer1.connect_block(b, 1, 0);
642 peer2.connect_block(b, 1, 0);
644 for (int height = 2; height < 10; height++) {
645 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[0]));
646 peer1.connect_block(b, height, 0);
647 peer2.connect_block(b, height, 0);
650 maybe_exchange_peer_messages(peer1, peer2);
651 while (peer1.chan_manager.list_usable_channels().length != 1 || peer2.chan_manager.list_usable_channels().length != 1)
653 peer1.chan_manager.list_channels();
654 ChannelDetails[] peer1_chans = peer1.chan_manager.list_usable_channels();
655 ChannelDetails[] peer2_chans = peer2.chan_manager.list_usable_channels();
656 assert peer1_chans.length == 1;
657 assert peer2_chans.length == 1;
658 assert peer1_chans[0].get_channel_value_satoshis() == 10000;
659 assert peer1_chans[0].get_is_usable();
660 Option_u64Z short_chan_id = peer1_chans[0].get_short_channel_id();
661 assert short_chan_id instanceof Option_u64Z.Some;
662 assert ((Option_u64Z.Some)short_chan_id).some == (1L << 40); // 0th output in the 0th transaction in the 1st block
663 assert Arrays.equals(peer1_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
664 assert Arrays.equals(peer2_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
666 Result_InvoiceSignOrCreationErrorZ invoice = UtilMethods.create_invoice_from_channelmanager(peer2.chan_manager, peer2.keys_interface, Currency.LDKCurrency_Bitcoin, Option_u64Z.none(), "Invoice Description");
667 assert invoice instanceof Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK;
668 System.out.println("Got invoice: " + ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
670 Result_InvoiceNoneZ parsed_invoice = Invoice.from_str(((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
671 assert parsed_invoice instanceof Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK;
672 assert Arrays.equals(((Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK) parsed_invoice).res.payment_hash(), ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash());
673 SignedRawInvoice signed_raw = ((Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK) parsed_invoice).res.into_signed_raw();
674 RawInvoice raw_invoice = signed_raw.raw_invoice();
675 byte[] desc_hash = raw_invoice.hash();
676 Description raw_invoice_description = raw_invoice.description();
677 String description_string = raw_invoice_description.into_inner();
678 assert description_string.equals("Invoice Description");
679 byte[] payment_hash = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash();
680 byte[] payment_secret = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_secret();
681 byte[] dest_node_id = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.recover_payee_pub_key();
682 assert Arrays.equals(dest_node_id, peer2.node_id);
683 InvoiceFeatures invoice_features = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.features();
684 RouteHint[] route_hints = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.route_hints();
687 try (LockedNetworkGraph netgraph = peer1.router.read_locked_graph()) {
688 NetworkGraph graph = netgraph.graph();
689 Result_RouteLightningErrorZ route_res = UtilMethods.get_route(peer1.chan_manager.get_our_node_id(), graph, peer2.node_id, invoice_features, peer1_chans, route_hints, 1000000, 42, peer1.logger);
690 assert route_res instanceof Result_RouteLightningErrorZ.Result_RouteLightningErrorZ_OK;
691 route = ((Result_RouteLightningErrorZ.Result_RouteLightningErrorZ_OK) route_res).res;
694 Result_NonePaymentSendFailureZ payment_res = peer1.chan_manager.send_payment(route, payment_hash, payment_secret);
695 assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_OK;
697 RouteHop[][] hops = new RouteHop[1][1];
698 byte[] hop_pubkey = new byte[33];
701 hops[0][0] = RouteHop.of(hop_pubkey, NodeFeatures.known(), 42, ChannelFeatures.known(), 100, 0);
702 Route r2 = Route.of(hops);
703 payment_res = peer1.chan_manager.send_payment(r2, payment_hash, payment_secret);
704 assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_Err;
707 if (use_chan_manager_constructor) {
708 peer1.constructor.interrupt();
709 peer2.constructor.interrupt();
710 } else if (use_nio_peer_handler) {
711 peer1.nio_peer_handler.interrupt();
712 peer2.nio_peer_handler.interrupt();
714 WeakReference<Peer> op1 = new WeakReference<Peer>(peer1);
715 peer1 = new Peer(peer1);
716 peer2 = new Peer(peer2);
717 return new TestState(op1, peer1, peer2, b.getHash());
719 return new TestState(null, peer1, peer2, b.getHash());
722 boolean cross_reload_ref_pollution = false;
724 private final WeakReference<Peer> ref_block;
725 private final Peer peer1;
726 private final Peer peer2;
727 public Sha256Hash best_blockhash;
729 public TestState(WeakReference<Peer> ref_block, Peer peer1, Peer peer2, Sha256Hash best_blockhash) {
730 this.ref_block = ref_block;
733 this.best_blockhash = best_blockhash;
736 void do_test_message_handler_b(TestState state) throws InterruptedException {
737 GcCheck obj = new GcCheck();
738 if (state.ref_block != null) {
739 // Ensure the original peers get freed before we move on. Note that we have to be in a different function
740 // scope to do so as the (at least current OpenJDK) JRE won't release anything created in the same scope.
741 while (!cross_reload_ref_pollution && state.ref_block.get() != null) {
743 System.runFinalization();
745 connect_peers(state.peer1, state.peer2);
748 Event[] events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
749 assert events[0] instanceof Event.PendingHTLCsForwardable;
750 state.peer2.chan_manager.process_pending_htlc_forwards();
752 events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
753 assert events[0] instanceof Event.PaymentReceived;
754 byte[] payment_preimage = ((Event.PaymentReceived)events[0]).payment_preimage;
755 assert !Arrays.equals(payment_preimage, new byte[32]);
756 state.peer2.chan_manager.claim_funds(payment_preimage);
758 events = state.peer1.get_manager_events(1, state.peer1, state.peer2);
759 assert events[0] instanceof Event.PaymentSent;
760 assert Arrays.equals(((Event.PaymentSent) events[0]).payment_preimage, payment_preimage);
762 if (use_nio_peer_handler) {
763 // We receive PaymentSent immediately upon receipt of the payment preimage, but we expect to not have an
764 // HTLC transaction to broadcast below, which requires a bit more time to fully complete the
765 // commitment-transaction-update dance between both peers.
769 ChannelDetails[] peer1_chans = state.peer1.chan_manager.list_channels();
772 Result_NoneAPIErrorZ close_res = state.peer1.chan_manager.close_channel(peer1_chans[0].get_channel_id());
773 assert close_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
774 maybe_exchange_peer_messages(state.peer1, state.peer2);
775 synchronized (state.peer1.broadcast_set) {
776 while (state.peer1.broadcast_set.size() != 1) state.peer1.broadcast_set.wait();
778 synchronized (state.peer2.broadcast_set) {
779 while (state.peer2.broadcast_set.size() != 1) state.peer2.broadcast_set.wait();
782 assert state.peer1.broadcast_set.size() == 1;
783 assert state.peer2.broadcast_set.size() == 1;
785 state.peer1.chan_manager.force_close_all_channels();
786 maybe_exchange_peer_messages(state.peer1, state.peer2);
787 synchronized (state.peer1.broadcast_set) {
788 while (state.peer1.broadcast_set.size() != 1) state.peer1.broadcast_set.wait();
790 synchronized (state.peer2.broadcast_set) {
791 while (state.peer2.broadcast_set.size() != 1) state.peer2.broadcast_set.wait();
794 assert state.peer1.broadcast_set.size() == 1;
795 assert state.peer2.broadcast_set.size() == 1;
797 NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
798 Transaction tx = new Transaction(bitcoinj_net, state.peer1.broadcast_set.getFirst());
799 Block b = new Block(bitcoinj_net, 2, state.best_blockhash, Sha256Hash.ZERO_HASH, 42, 0, 0,
800 Arrays.asList(new Transaction[]{tx}));
801 TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] watch_outputs = state.peer2.connect_block(b, 10, 1);
802 if (watch_outputs != null) { // We only process watch_outputs manually when we use a manually-build Watch impl
803 assert watch_outputs.length == 1;
804 assert Arrays.equals(watch_outputs[0].a, tx.getTxId().getReversedBytes());
805 assert watch_outputs[0].b.length == 2;
806 assert watch_outputs[0].b[0].a == 0;
807 assert watch_outputs[0].b[1].a == 1;
810 for (int i = 11; i < 21; i++) {
811 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, new ArrayList<>());
812 state.peer2.connect_block(b, i, 0);
815 Event[] broadcastable_event = state.peer2.get_monitor_events(1);
816 for (ChannelMonitor mon : state.peer2.monitors.values()) {
817 // This used to be buggy and double-free, so go ahead and fetch them!
818 byte[][] txn = mon.get_latest_holder_commitment_txn(state.peer2.logger);
820 assert broadcastable_event.length == 1;
821 assert broadcastable_event[0] instanceof Event.SpendableOutputs;
822 if (state.peer2.explicit_keys_manager != null) {
823 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);
824 assert tx_res instanceof Result_TransactionNoneZ.Result_TransactionNoneZ_OK;
825 Transaction built_tx = new Transaction(bitcoinj_net, ((Result_TransactionNoneZ.Result_TransactionNoneZ_OK) tx_res).res);
826 assert built_tx.getOutputs().size() == 1;
827 assert Arrays.equals(built_tx.getOutput(0).getScriptBytes(), new byte[]{0x00});
831 if (use_nio_peer_handler) {
832 state.peer1.peer_manager.disconnect_by_node_id(state.peer2.chan_manager.get_our_node_id(), false);
833 while (state.peer1.peer_manager.get_peer_node_ids().length != 0) Thread.yield();
834 while (state.peer2.peer_manager.get_peer_node_ids().length != 0) Thread.yield();
835 state.peer1.nio_peer_handler.interrupt();
836 state.peer2.nio_peer_handler.interrupt();
839 state.peer1.get_monitor_events(0);
840 state.peer2.get_monitor_events(0);
842 if (use_chan_manager_constructor) {
843 state.peer1.constructor.interrupt();
844 state.peer2.constructor.interrupt();
850 java.util.LinkedList<WeakReference<Object>> must_free_objs = new java.util.LinkedList();
852 int gc_exp_count = 0;
854 GcCheck() { gc_exp_count += 1; }
856 protected void finalize() throws Throwable {
862 public class HumanObjectPeerTest {
863 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 {
864 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);
865 HumanObjectPeerTestInstance.TestState state = instance.do_test_message_handler();
866 instance.do_test_message_handler_b(state);
869 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 {
870 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);
871 while (instance.gc_count != instance.gc_exp_count) {
873 System.runFinalization();
875 for (WeakReference<Object> o : instance.must_free_objs)
876 assert o.get() == null;
879 public void test_message_handler() throws InterruptedException {
880 for (int i = 0; i < (1 << 7) - 1; i++) {
881 boolean nice_close = (i & (1 << 0)) != 0;
882 boolean use_km_wrapper = (i & (1 << 1)) != 0;
883 boolean use_manual_watch = (i & (1 << 2)) != 0;
884 boolean reload_peers = (i & (1 << 3)) != 0;
885 boolean break_cross_refs = (i & (1 << 4)) != 0;
886 boolean nio_peer_handler = (i & (1 << 5)) != 0;
887 boolean use_chan_manager_constructor = (i & (1 << 6)) != 0;
888 if (break_cross_refs && !reload_peers) {
889 // There are no cross refs to break without reloading peers.
892 if (use_chan_manager_constructor && (use_manual_watch || !nio_peer_handler)) {
893 // ChannelManagerConstructor requires a ChainMonitor as the Watch and creates a NioPeerHandler for us.
896 System.err.println("Running test with flags " + i);
897 do_test(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_refs, nio_peer_handler, use_chan_manager_constructor);
901 // This is used in the test jar to test the built jar is runnable
902 public static void main(String[] args) {
904 new HumanObjectPeerTest().test_message_handler();
905 } catch (Exception e) {
906 System.err.println("Caught exception:");
907 System.err.println(e);