Fix missing-ptrs_to error by working around it in test
[ldk-java] / src / test / java / org / ldk / HumanObjectPeerTest.java
1 package org.ldk;
2
3 import org.bitcoinj.core.*;
4 import org.bitcoinj.core.Transaction;
5 import org.bitcoinj.script.Script;
6 import org.junit.jupiter.api.Test;
7 import org.ldk.enums.LDKNetwork;
8 import org.ldk.impl.bindings;
9 import org.ldk.structs.*;
10 import org.ldk.util.TwoTuple;
11
12 import java.lang.ref.WeakReference;
13 import java.util.Arrays;
14 import java.util.HashMap;
15 import java.util.LinkedList;
16
17 class HumanObjectPeerTestInstance {
18     private final boolean nice_close;
19     private final boolean use_km_wrapper;
20     private final boolean use_manual_watch;
21     private final boolean reload_peers;
22     private final boolean break_cross_peer_refs;
23
24     HumanObjectPeerTestInstance(boolean nice_close, boolean use_km_wrapper, boolean use_manual_watch, boolean reload_peers, boolean break_cross_peer_refs) {
25         this.nice_close = nice_close;
26         this.use_km_wrapper = use_km_wrapper;
27         this.use_manual_watch = use_manual_watch;
28         this.reload_peers = reload_peers;
29         this.break_cross_peer_refs = break_cross_peer_refs;
30     }
31
32     class Peer {
33         KeysInterface manual_keysif(KeysInterface underlying_if) {
34             return KeysInterface.new_impl(new KeysInterface.KeysInterfaceInterface() {
35                 @Override public byte[] get_node_secret() { return underlying_if.get_node_secret(); }
36                 @Override public byte[] get_destination_script() { return underlying_if.get_destination_script(); }
37                 @Override public byte[] get_shutdown_pubkey() { return underlying_if.get_shutdown_pubkey(); }
38
39                 @Override
40                 public ChannelKeys get_channel_keys(boolean inbound, long channel_value_satoshis) {
41                     ChannelKeys underlying_ck = underlying_if.get_channel_keys(inbound, channel_value_satoshis);
42                     ChannelKeys.ChannelKeysInterface cki = new ChannelKeys.ChannelKeysInterface() {
43                         @Override
44                         public byte[] get_per_commitment_point(long idx) {
45                             return underlying_ck.get_per_commitment_point(idx);
46                         }
47
48                         @Override
49                         public byte[] release_commitment_secret(long idx) {
50                             return underlying_ck.release_commitment_secret(idx);
51                         }
52
53                         @Override
54                         public TwoTuple<Long, Long> key_derivation_params() {
55                             return new TwoTuple<Long, Long>((long)0, (long)1);
56                         }
57
58                         @Override
59                         public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_counterparty_commitment(CommitmentTransaction commitment_tx) {
60                             return underlying_ck.sign_counterparty_commitment(commitment_tx);
61                         }
62
63                         @Override
64                         public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_holder_commitment_and_htlcs(HolderCommitmentTransaction holder_commitment_tx) {
65                             return underlying_ck.sign_holder_commitment_and_htlcs(holder_commitment_tx);
66                         }
67
68                         @Override
69                         public Result_SignatureNoneZ sign_justice_transaction(byte[] justice_tx, long input, long amount, byte[] per_commitment_key, HTLCOutputInCommitment htlc) {
70                             return underlying_ck.sign_justice_transaction(justice_tx, input, amount, per_commitment_key, htlc);
71                         }
72
73                         @Override
74                         public Result_SignatureNoneZ sign_counterparty_htlc_transaction(byte[] htlc_tx, long input, long amount, byte[] per_commitment_point, HTLCOutputInCommitment htlc) {
75                             return underlying_ck.sign_counterparty_htlc_transaction(htlc_tx, input, amount, per_commitment_point, htlc);
76                         }
77
78                         @Override
79                         public Result_SignatureNoneZ sign_closing_transaction(byte[] closing_tx) {
80                             return underlying_ck.sign_closing_transaction(closing_tx);
81                         }
82
83                         @Override
84                         public Result_SignatureNoneZ sign_channel_announcement(UnsignedChannelAnnouncement msg) {
85                             return underlying_ck.sign_channel_announcement(msg);
86                         }
87
88                         @Override
89                         public void ready_channel(ChannelTransactionParameters params) {
90                             underlying_ck.ready_channel(params);
91                         }
92
93                         @Override
94                         public byte[] write() {
95                             return underlying_ck.write();
96                         }
97                     };
98                     ChannelKeys resp = ChannelKeys.new_impl(cki, underlying_ck.get_pubkeys());
99                     must_free_objs.add(new WeakReference<>(cki));
100                     must_free_objs.add(new WeakReference<>(resp));
101                     must_free_objs.add(new WeakReference<>(underlying_ck));
102                     return resp;
103                 }
104
105                 @Override
106                 public byte[] get_secure_random_bytes() {
107                     return underlying_if.get_secure_random_bytes();
108                 }
109
110                 @Override
111                 public Result_ChanKeySignerDecodeErrorZ read_chan_signer(byte[] reader) {
112                     return underlying_if.read_chan_signer(reader);
113                 }
114             });
115         }
116
117         Watch get_manual_watch() {
118             Watch.WatchInterface watch_impl = new Watch.WatchInterface() {
119                 public Result_NoneChannelMonitorUpdateErrZ watch_channel(OutPoint funding_txo, ChannelMonitor monitor) {
120                     synchronized (monitors) {
121                         assert monitors.put(Arrays.toString(funding_txo.get_txid()), monitor) == null;
122                     }
123                     return new Result_NoneChannelMonitorUpdateErrZ.Result_NoneChannelMonitorUpdateErrZ_OK();
124                 }
125
126                 public Result_NoneChannelMonitorUpdateErrZ update_channel(OutPoint funding_txo, ChannelMonitorUpdate update) {
127                     synchronized (monitors) {
128                         String txid = Arrays.toString(funding_txo.get_txid());
129                         assert monitors.containsKey(txid);
130                         Result_NoneMonitorUpdateErrorZ update_res = monitors.get(txid).update_monitor(update, tx_broadcaster, fee_estimator, logger);
131                         assert update_res instanceof Result_NoneMonitorUpdateErrorZ.Result_NoneMonitorUpdateErrorZ_OK;
132                     }
133                     return new Result_NoneChannelMonitorUpdateErrZ.Result_NoneChannelMonitorUpdateErrZ_OK();
134                 }
135
136                 @Override
137                 public MonitorEvent[] release_pending_monitor_events() {
138                     synchronized (monitors) {
139                         assert monitors.size() <= 1;
140                         for (ChannelMonitor mon : monitors.values()) {
141                             return mon.get_and_clear_pending_monitor_events();
142                         }
143                     }
144                     return new MonitorEvent[0];
145                 }
146             };
147             Watch watch = Watch.new_impl(watch_impl);
148             must_free_objs.add(new WeakReference<>(watch_impl));
149             must_free_objs.add(new WeakReference<>(watch));
150             return watch;
151         }
152
153         final byte seed;
154         final Logger logger;
155         final FeeEstimator fee_estimator;
156         final BroadcasterInterface tx_broadcaster;
157         final KeysInterface keys_interface;
158         final ChainMonitor chain_monitor;
159         final NetGraphMsgHandler router;
160         final Watch chain_watch;
161         ChannelManager chan_manager;
162         EventsProvider chan_manager_events;
163         PeerManager peer_manager;
164         final HashMap<String, ChannelMonitor> monitors; // Wow I forgot just how terrible Java is - we can't put a byte array here.
165         byte[] node_id;
166         final LinkedList<byte[]> broadcast_set = new LinkedList<>();
167
168         private TwoTuple<OutPoint, byte[]> test_mon_roundtrip(ChannelMonitor mon) {
169             // Because get_funding_txo() returns an OutPoint in a tuple that is a reference to an OutPoint inside the
170             // ChannelMonitor, its a good test to ensure that the OutPoint isn't freed (or is cloned) before the
171             // ChannelMonitor is. This used to be broken.
172             Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ roundtrip_monitor = UtilMethods.constructor_BlockHashChannelMonitorZ_read(mon.write(), keys_interface);
173             assert roundtrip_monitor instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
174             TwoTuple<OutPoint, byte[]> funding_txo = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_monitor).res.b.get_funding_txo();
175             System.gc(); System.runFinalization(); // Give the GC a chance to run.
176             return funding_txo;
177         }
178
179         private Peer(Object _dummy, byte seed) {
180             logger = Logger.new_impl((String arg) -> System.out.println(seed + ": " + arg));
181             fee_estimator = FeeEstimator.new_impl((confirmation_target -> 253));
182             tx_broadcaster = BroadcasterInterface.new_impl(tx -> {
183                 broadcast_set.add(tx);
184             });
185             monitors = new HashMap<>();
186             this.seed = seed;
187             Persist persister = Persist.new_impl(new Persist.PersistInterface() {
188                 @Override
189                 public Result_NoneChannelMonitorUpdateErrZ persist_new_channel(OutPoint id, ChannelMonitor data) {
190                     synchronized (monitors) {
191                         String key = Arrays.toString(id.to_channel_id());
192                         assert monitors.put(key, data) == null;
193                         TwoTuple<OutPoint, byte[]> res = test_mon_roundtrip(data);
194                         assert Arrays.equals(res.a.get_txid(), id.get_txid());
195                         assert res.a.get_index() == id.get_index();
196                     }
197                     return new Result_NoneChannelMonitorUpdateErrZ.Result_NoneChannelMonitorUpdateErrZ_OK();
198                 }
199
200                 @Override
201                 public Result_NoneChannelMonitorUpdateErrZ update_persisted_channel(OutPoint id, ChannelMonitorUpdate update, ChannelMonitor data) {
202                     synchronized (monitors) {
203                         String key = Arrays.toString(id.to_channel_id());
204                         assert monitors.put(key, data) != null;
205                         TwoTuple<OutPoint, byte[]> res = test_mon_roundtrip(data);
206                         assert Arrays.equals(res.a.get_txid(), id.get_txid());
207                         assert res.a.get_index() == id.get_index();
208                     }
209                     return new Result_NoneChannelMonitorUpdateErrZ.Result_NoneChannelMonitorUpdateErrZ_OK();
210                 }
211             });
212             if (use_manual_watch) {
213                 chain_watch = get_manual_watch();
214                 chain_monitor = null;
215             } else {
216                 chain_monitor = ChainMonitor.constructor_new(null, tx_broadcaster, logger, fee_estimator, persister);
217                 chain_watch = chain_monitor.as_Watch();
218             }
219
220             byte[] key_seed = new byte[32];
221             for (byte i = 0; i < 32; i++) {
222                 key_seed[i] = (byte) (i ^ seed);
223             }
224             if (use_km_wrapper) {
225                 KeysManager underlying = KeysManager.constructor_new(key_seed, LDKNetwork.LDKNetwork_Bitcoin, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000) & 0xffffffff);
226                 this.keys_interface = manual_keysif(underlying.as_KeysInterface());
227             } else {
228                 KeysManager keys = KeysManager.constructor_new(key_seed, LDKNetwork.LDKNetwork_Bitcoin, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000) & 0xffffffff);
229                 this.keys_interface = keys.as_KeysInterface();
230             }
231             this.router = NetGraphMsgHandler.constructor_new(new byte[32], null, logger);
232         }
233         Peer(byte seed) {
234             this(null, seed);
235             this.chan_manager = ChannelManager.constructor_new(LDKNetwork.LDKNetwork_Bitcoin, FeeEstimator.new_impl(confirmation_target -> 0), chain_watch, tx_broadcaster, logger, this.keys_interface, UserConfig.constructor_default(), 1);
236             this.node_id = chan_manager.get_our_node_id();
237             this.chan_manager_events = chan_manager.as_EventsProvider();
238
239             byte[] random_data = new byte[32];
240             for (byte i = 0; i < 32; i++) {
241                 random_data[i] = (byte) ((i ^ seed) ^ 0xf0);
242             }
243             this.peer_manager = PeerManager.constructor_new(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger);
244             System.gc();
245         }
246         Object ptr_to;
247         Peer(Peer orig) {
248             this(null, orig.seed);
249             ChannelMonitor[] monitors = new ChannelMonitor[1];
250             synchronized (monitors) {
251                 assert orig.monitors.size() == 1;
252                 monitors[0] = orig.monitors.values().stream().iterator().next();
253                 if (break_cross_peer_refs) {
254                     Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ res = UtilMethods.constructor_BlockHashChannelMonitorZ_read(monitors[0].write(), keys_interface);
255                     assert res instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
256                     monitors[0] = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) res).res.b;
257                 }
258             }
259             byte[] serialized = orig.chan_manager.write();
260             Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ read_res =
261                     UtilMethods.constructor_BlockHashChannelManagerZ_read(serialized, this.keys_interface, this.fee_estimator, this.chain_watch, this.tx_broadcaster, this.logger, UserConfig.constructor_default(), monitors);
262             if (!break_cross_peer_refs && (use_manual_watch || use_km_wrapper)) {
263                 // When we pass monitors[0] into chain_watch.watch_channel we create a reference from the new Peer to a
264                 // field in the old peer, preventing freeing of the original Peer until the new Peer is freed. Thus, we
265                 // shouldn't bother waiting for the original to be freed later on.
266                 cross_reload_ref_pollution = true;
267             }
268             this.chain_watch.watch_channel(monitors[0].get_funding_txo().a, monitors[0]);
269             assert read_res instanceof Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK;
270             this.chan_manager = ((Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK) read_res).res.b;
271             this.node_id = chan_manager.get_our_node_id();
272             this.chan_manager_events = chan_manager.as_EventsProvider();
273
274             if (cross_reload_ref_pollution) {
275                 // This really, really needs to be handled at the bindings layer, but its rather complicated -
276                 // ChannelSigners can be cloned and passed around without java being involved, resulting in them being
277                 // owned by both one or more ChannelMonitors and a ChannelManager, with only one having proper pointers
278                 // to the ChannelSigner. Ideally, the ChannelSigner would have a global reference to the Java
279                 // implementation class, but that results in circular references. Instead, we need some ability to,
280                 // while cloning ChannelSigners, add new references in the calling Java struct (ie ChannelMonitor) to
281                 // the ChannelSigner.
282                 this.ptr_to = orig.chan_manager;
283             }
284
285             byte[] random_data = new byte[32];
286             for (byte i = 0; i < 32; i++) {
287                 random_data[i] = (byte) ((i ^ seed) ^ 0xf0);
288             }
289             this.peer_manager = PeerManager.constructor_new(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger);
290         }
291
292         TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] connect_block(Block b, int height, long expected_monitor_update_len) {
293             byte[] header = Arrays.copyOfRange(b.bitcoinSerialize(), 0, 80);
294             TwoTuple<Long, byte[]>[] txn;
295             if (b.hasTransactions()) {
296                 assert b.getTransactions().size() == 1;
297                 TwoTuple<Long, byte[]> txp = new TwoTuple<>((long) 1, b.getTransactions().get(0).bitcoinSerialize());
298                 txn = new TwoTuple[]{txp};
299             } else
300                 txn = new TwoTuple[0];
301             chan_manager.block_connected(header, txn, height);
302             if (chain_monitor != null) {
303                 chain_monitor.block_connected(header, txn, height);
304             } else {
305                 synchronized (monitors) {
306                     assert monitors.size() == 1;
307                     for (ChannelMonitor mon : monitors.values()) {
308                         TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] ret = mon.block_connected(header, txn, height, tx_broadcaster, fee_estimator, logger);
309                         assert ret.length == expected_monitor_update_len;
310                         return ret;
311                     }
312                 }
313             }
314             return null;
315         }
316
317         Route get_route(byte[] dest_node, ChannelDetails[] our_chans) {
318             try (LockedNetworkGraph netgraph = this.router.read_locked_graph()) {
319                 NetworkGraph graph = netgraph.graph();
320                 long res = bindings.get_route(this.node_id, graph._test_only_get_ptr(), dest_node, new long[]{our_chans[0]._test_only_get_ptr()},
321                         new long[0], 1000, 42, this.logger._test_only_get_ptr());
322                 assert bindings.LDKCResult_RouteLightningErrorZ_result_ok(res);
323                 byte[] serialized_route = bindings.Route_write(bindings.LDKCResult_RouteLightningErrorZ_get_ok(res));
324                 must_free_objs.add(new WeakReference<>(serialized_route));
325                 Result_RouteDecodeErrorZ copy = Route.constructor_read(serialized_route);
326                 assert copy instanceof Result_RouteDecodeErrorZ.Result_RouteDecodeErrorZ_OK;
327                 bindings.CResult_RouteLightningErrorZ_free(res);
328                 return ((Result_RouteDecodeErrorZ.Result_RouteDecodeErrorZ_OK) copy).res;
329             }
330         }
331     }
332
333     static class DescriptorHolder { SocketDescriptor val; }
334
335     boolean running = false;
336     final LinkedList<Runnable> runqueue = new LinkedList();
337     boolean ran = false;
338     Thread t = new Thread(() -> {
339             while (true) {
340                 try {
341                     Runnable r;
342                     synchronized (runqueue) {
343                         while (runqueue.isEmpty()) {
344                             runqueue.wait();
345                         }
346                         running = true;
347                         r = runqueue.pollFirst();
348                     }
349                     r.run();
350                     synchronized (runqueue) {
351                         running = false;
352                         runqueue.notifyAll();
353                     }
354                 } catch (InterruptedException e) {
355                     return;
356                 }
357             }
358     });
359     void wait_events_processed(Peer peer1, Peer peer2) {
360         synchronized (runqueue) {
361             ran = false;
362         }
363         while (true) {
364             peer1.peer_manager.process_events();
365             peer2.peer_manager.process_events();
366             synchronized (runqueue) {
367                 if (runqueue.isEmpty() && !running) {
368                     if (ran) {
369                         ran = false;
370                         continue;
371                     } else { break; }
372                 }
373                 try { runqueue.wait(); } catch (InterruptedException e) { assert false; }
374             }
375         }
376     }
377     void do_read_event(PeerManager pm, SocketDescriptor descriptor, byte[] data) {
378         if (!t.isAlive()) t.start();
379         synchronized (runqueue) {
380             ran = true;
381             runqueue.add(() -> {
382                 Result_boolPeerHandleErrorZ res = pm.read_event(descriptor, data);
383                 assert res instanceof Result_boolPeerHandleErrorZ.Result_boolPeerHandleErrorZ_OK;
384             });
385             runqueue.notifyAll();
386         }
387         must_free_objs.add(new WeakReference<>(data));
388     }
389
390     void connect_peers(final Peer peer1, final Peer peer2) {
391         DescriptorHolder descriptor1 = new DescriptorHolder();
392         DescriptorHolder descriptor1ref = descriptor1;
393         SocketDescriptor descriptor2 = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
394             @Override
395             public long send_data(byte[] data, boolean resume_read) {
396                 do_read_event(peer1.peer_manager, descriptor1ref.val, data);
397                 return data.length;
398             }
399
400             @Override public void disconnect_socket() { assert false; }
401             @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 2; }
402             @Override public long hash() { return 2; }
403         });
404
405         descriptor1.val = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
406             @Override
407             public long send_data(byte[] data, boolean resume_read) {
408                 do_read_event(peer2.peer_manager, descriptor2, data);
409                 return data.length;
410             }
411
412             @Override public void disconnect_socket() { assert false; }
413             @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 1; }
414             @Override public long hash() { return 1; }
415         });
416
417         Result_CVec_u8ZPeerHandleErrorZ conn_res = peer1.peer_manager.new_outbound_connection(peer2.node_id, descriptor1.val);
418         assert conn_res instanceof Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK;
419
420         Result_NonePeerHandleErrorZ inbound_conn_res = peer2.peer_manager.new_inbound_connection(descriptor2);
421         assert inbound_conn_res instanceof Result_NonePeerHandleErrorZ.Result_NonePeerHandleErrorZ_OK;
422         do_read_event(peer2.peer_manager, descriptor2, ((Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK) conn_res).res);
423     }
424
425     TestState do_test_message_handler() throws InterruptedException {
426         Peer peer1 = new Peer((byte) 1);
427         Peer peer2 = new Peer((byte) 2);
428
429         connect_peers(peer1, peer2);
430         wait_events_processed(peer1, peer2);
431
432         Result_NoneAPIErrorZ cc_res = peer1.chan_manager.create_channel(peer2.node_id, 10000, 1000, 42, null);
433         assert cc_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
434         wait_events_processed(peer1, peer2);
435
436         Event[] events = peer1.chan_manager_events.get_and_clear_pending_events();
437         assert events.length == 1;
438         assert events[0] instanceof Event.FundingGenerationReady;
439         assert ((Event.FundingGenerationReady) events[0]).channel_value_satoshis == 10000;
440         assert ((Event.FundingGenerationReady) events[0]).user_channel_id == 42;
441         byte[] funding_spk = ((Event.FundingGenerationReady) events[0]).output_script;
442         assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
443         byte[] chan_id = ((Event.FundingGenerationReady) events[0]).temporary_channel_id;
444
445         NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
446
447         Transaction funding = new Transaction(bitcoinj_net);
448         funding.addInput(new TransactionInput(bitcoinj_net, funding, new byte[0]));
449         funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
450         funding.getInput(0).getWitness().setPush(0, new byte[]{0x1});
451         funding.addOutput(Coin.SATOSHI.multiply(10000), new Script(funding_spk));
452         peer1.chan_manager.funding_transaction_generated(chan_id, OutPoint.constructor_new(funding.getTxId().getReversedBytes(), (short) 0));
453         wait_events_processed(peer1, peer2);
454
455         events = peer1.chan_manager_events.get_and_clear_pending_events();
456         assert events.length == 1;
457         assert events[0] instanceof Event.FundingBroadcastSafe;
458         assert ((Event.FundingBroadcastSafe) events[0]).user_channel_id == 42;
459
460         Block b = new Block(bitcoinj_net, 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
461         peer1.connect_block(b, 1, 0);
462         peer2.connect_block(b, 1, 0);
463
464         for (int height = 2; height < 10; height++) {
465             b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[0]));
466             peer1.connect_block(b, height, 0);
467             peer2.connect_block(b, height, 0);
468         }
469         wait_events_processed(peer1, peer2);
470
471         peer1.chan_manager.list_channels();
472         ChannelDetails[] peer1_chans = peer1.chan_manager.list_channels();
473         ChannelDetails[] peer2_chans = peer2.chan_manager.list_channels();
474         assert peer1_chans.length == 1;
475         assert peer2_chans.length == 1;
476         assert peer1_chans[0].get_channel_value_satoshis() == 10000;
477         assert peer1_chans[0].get_is_live();
478         assert Arrays.equals(peer1_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
479         assert Arrays.equals(peer2_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
480
481         byte[] payment_preimage = new byte[32];
482         for (int i = 0; i < 32; i++) payment_preimage[i] = (byte) (i ^ 0x0f);
483         byte[] payment_hash = Sha256Hash.hash(payment_preimage);
484         Route route = peer1.get_route(peer2.node_id, peer1_chans);
485         Result_NonePaymentSendFailureZ payment_res = peer1.chan_manager.send_payment(route, payment_hash, new byte[32]);
486         assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_OK;
487         wait_events_processed(peer1, peer2);
488
489         if (reload_peers) {
490             WeakReference<Peer> op1 = new WeakReference<Peer>(peer1);
491             peer1 = new Peer(peer1);
492             peer2 = new Peer(peer2);
493             return new TestState(op1, peer1, peer2, payment_preimage, b.getHash());
494         }
495         return new TestState(null, peer1, peer2, payment_preimage, b.getHash());
496     }
497
498     boolean cross_reload_ref_pollution = false;
499     class TestState {
500         private final WeakReference<Peer> ref_block;
501         private final Peer peer1;
502         private final Peer peer2;
503         private final byte[] payment_preimage;
504         public Sha256Hash best_blockhash;
505
506         public TestState(WeakReference<Peer> ref_block, Peer peer1, Peer peer2, byte[] payment_preimage, Sha256Hash best_blockhash) {
507             this.ref_block = ref_block;
508             this.peer1 = peer1;
509             this.peer2 = peer2;
510             this.payment_preimage = payment_preimage;
511             this.best_blockhash = best_blockhash;
512         }
513     }
514     void do_test_message_handler_b(TestState state) {
515         GcCheck obj = new GcCheck();
516         if (state.ref_block != null) {
517             // Ensure the original peers get freed before we move on. Note that we have to be in a different function
518             // scope to do so as the (at least current OpenJDK) JRE won't release anything created in the same scope.
519             while (!cross_reload_ref_pollution && state.ref_block.get() != null) {
520                 System.gc();
521                 System.runFinalization();
522             }
523             connect_peers(state.peer1, state.peer2);
524             wait_events_processed(state.peer1, state.peer2);
525         }
526
527         Event[] events = state.peer2.chan_manager_events.get_and_clear_pending_events();
528         assert events.length == 1;
529         assert events[0] instanceof Event.PendingHTLCsForwardable;
530         state.peer2.chan_manager.process_pending_htlc_forwards();
531
532         events = state.peer2.chan_manager_events.get_and_clear_pending_events();
533         assert events.length == 1;
534         assert events[0] instanceof Event.PaymentReceived;
535         state.peer2.chan_manager.claim_funds(state.payment_preimage, new byte[32], ((Event.PaymentReceived) events[0]).amt);
536         wait_events_processed(state.peer1, state.peer2);
537
538         events = state.peer1.chan_manager_events.get_and_clear_pending_events();
539         assert events.length == 1;
540         assert events[0] instanceof Event.PaymentSent;
541         assert Arrays.equals(((Event.PaymentSent) events[0]).payment_preimage, state.payment_preimage);
542         wait_events_processed(state.peer1, state.peer2);
543
544         ChannelDetails[] peer1_chans = state.peer1.chan_manager.list_channels();
545
546         if (nice_close) {
547             Result_NoneAPIErrorZ close_res = state.peer1.chan_manager.close_channel(peer1_chans[0].get_channel_id());
548             assert close_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
549             wait_events_processed(state.peer1, state.peer2);
550
551             assert state.peer1.broadcast_set.size() == 1;
552             assert state.peer2.broadcast_set.size() == 1;
553         } else {
554             state.peer1.chan_manager.force_close_all_channels();
555             wait_events_processed(state.peer1, state.peer2);
556
557             assert state.peer1.broadcast_set.size() == 1;
558             assert state.peer2.broadcast_set.size() == 0;
559
560             NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
561             Transaction tx = new Transaction(bitcoinj_net, state.peer1.broadcast_set.getFirst());
562             Block b = new Block(bitcoinj_net, 2, state.best_blockhash, Sha256Hash.ZERO_HASH, 42, 0, 0,
563                     Arrays.asList(new Transaction[]{tx}));
564             TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] watch_outputs = state.peer2.connect_block(b, 1, 1);
565             if (watch_outputs != null) { // We only process watch_outputs manually when we use a manually-build Watch impl
566                 assert watch_outputs.length == 1;
567                 assert Arrays.equals(watch_outputs[0].a, tx.getTxId().getReversedBytes());
568                 assert watch_outputs[0].b.length == 1;
569             }
570
571             // This used to be buggy and double-free, so go ahead and fetch them!
572             for (ChannelMonitor mon : state.peer2.monitors.values()) {
573                 byte[][] txn = mon.get_latest_holder_commitment_txn(state.peer2.logger);
574             }
575         }
576     }
577
578     java.util.LinkedList<WeakReference<Object>> must_free_objs = new java.util.LinkedList();
579     boolean gc_ran = false;
580     class GcCheck {
581         @Override
582         protected void finalize() throws Throwable {
583             gc_ran = true;
584             super.finalize();
585         }
586     }
587 }
588 public class HumanObjectPeerTest {
589     HumanObjectPeerTestInstance do_test_run(boolean nice_close, boolean use_km_wrapper, boolean use_manual_watch, boolean reload_peers, boolean break_cross_peer_refs) throws InterruptedException {
590         HumanObjectPeerTestInstance instance = new HumanObjectPeerTestInstance(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_peer_refs);
591         HumanObjectPeerTestInstance.TestState state = instance.do_test_message_handler();
592         instance.do_test_message_handler_b(state);
593         return instance;
594     }
595     void do_test(boolean nice_close, boolean use_km_wrapper, boolean use_manual_watch, boolean reload_peers, boolean break_cross_peer_refs) throws InterruptedException {
596         HumanObjectPeerTestInstance instance = do_test_run(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_peer_refs);
597         while (!instance.gc_ran) {
598             System.gc();
599             System.runFinalization();
600         }
601         for (WeakReference<Object> o : instance.must_free_objs)
602             assert o.get() == null;
603     }
604     @Test
605     public void test_message_handler() throws InterruptedException {
606         for (int i = 0; i < (1 << 5) - 1; i++) {
607             boolean nice_close =       (i & (1 << 0)) != 0;
608             boolean use_km_wrapper =   (i & (1 << 1)) != 0;
609             boolean use_manual_watch = (i & (1 << 2)) != 0;
610             boolean reload_peers =     (i & (1 << 3)) != 0;
611             boolean break_cross_refs = (i & (1 << 4)) != 0;
612             if (break_cross_refs && !reload_peers) {
613                 // There are no cross refs to break without reloading peers.
614                 continue;
615             }
616             System.err.println("Running test with flags " + i);
617             do_test(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_refs);
618         }
619     }
620 }