Write tuple getters (and test them, exposing memory leak)
[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 import java.util.concurrent.ConcurrentLinkedQueue;
17
18 class HumanObjectPeerTestInstance {
19     class Peer {
20         final Logger logger;
21         final FeeEstimator fee_estimator;
22         final BroadcasterInterface tx_broadcaster;
23         final KeysManager keys;
24         final KeysInterface keys_interface;
25         final ChannelManager chan_manager;
26         final EventsProvider chan_manager_events;
27         final NetGraphMsgHandler router;
28         final PeerManager peer_manager;
29         final HashMap<String, ChannelMonitor> monitors; // Wow I forgot just how terrible Java is - we can't put a byte array here.
30         byte[] node_id;
31         final LinkedList<org.ldk.structs.Transaction> broadcast_set = new LinkedList<>();
32
33         Peer(byte seed) {
34             logger = new Logger((String arg) -> System.out.println(seed + ": " + arg));
35             fee_estimator = new FeeEstimator((confirmation_target -> 253));
36             tx_broadcaster = new BroadcasterInterface(tx -> {
37                 broadcast_set.add(tx);
38             });
39             this.monitors = new HashMap<>();
40             Watch chain_monitor = new Watch(new Watch.WatchInterface() {
41                 public Result_NoneChannelMonitorUpdateErrZ watch_channel(OutPoint funding_txo, ChannelMonitor monitor) {
42                     synchronized (monitors) {
43                         assert monitors.put(Arrays.toString(funding_txo.get_txid()), monitor) == null;
44                     }
45                     return new Result_NoneChannelMonitorUpdateErrZ.Result_NoneChannelMonitorUpdateErrZ_OK();
46                 }
47
48                 public Result_NoneChannelMonitorUpdateErrZ update_channel(OutPoint funding_txo, ChannelMonitorUpdate update) {
49                     synchronized (monitors) {
50                         String txid = Arrays.toString(funding_txo.get_txid());
51                         assert monitors.containsKey(txid);
52                         Result_NoneMonitorUpdateErrorZ update_res = monitors.get(txid).update_monitor(update, tx_broadcaster, logger);
53                         assert update_res instanceof Result_NoneMonitorUpdateErrorZ.Result_NoneMonitorUpdateErrorZ_OK;
54                     }
55                     return new Result_NoneChannelMonitorUpdateErrZ.Result_NoneChannelMonitorUpdateErrZ_OK();
56                 }
57
58                 @Override
59                 public MonitorEvent[] release_pending_monitor_events() {
60                     synchronized (monitors) {
61                         assert monitors.size() <= 1;
62                         for (ChannelMonitor mon : monitors.values()) {
63                             return mon.get_and_clear_pending_monitor_events();
64                         }
65                     }
66                     return new MonitorEvent[0];
67                 }
68             });
69
70             byte[] key_seed = new byte[32];
71             for (byte i = 0; i < 32; i++) {
72                 key_seed[i] = (byte) (i ^ seed);
73             }
74             this.keys = KeysManager.constructor_new(key_seed, LDKNetwork.LDKNetwork_Bitcoin, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000) & 0xffffffff);
75             this.keys_interface = keys.as_KeysInterface();
76             this.chan_manager = ChannelManager.constructor_new(LDKNetwork.LDKNetwork_Bitcoin, new FeeEstimator(confirmation_target -> 0), chain_monitor, tx_broadcaster, logger, keys.as_KeysInterface(), UserConfig.constructor_default(), 1);
77             this.node_id = chan_manager.get_our_node_id();
78             this.chan_manager_events = chan_manager.as_EventsProvider();
79             this.router = NetGraphMsgHandler.constructor_new(null, logger);
80
81             byte[] random_data = new byte[32];
82             for (byte i = 0; i < 32; i++) {
83                 random_data[i] = (byte) ((i ^ seed) ^ 0xf0);
84             }
85             this.peer_manager = PeerManager.constructor_new(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger);
86             System.gc();
87         }
88
89         TwoTuple<byte[], TxOut[]>[] connect_block(Block b, int height) {
90             byte[] header = Arrays.copyOfRange(b.bitcoinSerialize(), 0, 80);
91             TwoTuple<Long, org.ldk.structs.Transaction>[] txn;
92             if (b.hasTransactions()) {
93                 assert b.getTransactions().size() == 1;
94                 TwoTuple<Long, org.ldk.structs.Transaction> txp = new TwoTuple<>((long) 1, new org.ldk.structs.Transaction(b.getTransactions().get(0).bitcoinSerialize()));
95                 txn = new TwoTuple[]{txp};
96             } else
97                 txn = new TwoTuple[0];
98             chan_manager.block_connected(header, txn, height);
99             synchronized (monitors) {
100                 assert monitors.size() == 1;
101                 for (ChannelMonitor mon : monitors.values()) {
102                     return mon.block_connected(header, txn, height, tx_broadcaster, fee_estimator, logger);
103                 }
104             }
105             return null;
106         }
107
108         Route get_route(byte[] dest_node, ChannelDetails[] our_chans) {
109             try (LockedNetworkGraph netgraph = this.router.read_locked_graph()) {
110                 NetworkGraph graph = netgraph.graph();
111                 long res = bindings.get_route(this.node_id, graph._test_only_get_ptr(), dest_node, new long[]{our_chans[0]._test_only_get_ptr()},
112                         new long[0], 1000, 42, this.logger._test_only_get_ptr());
113                 assert bindings.LDKCResult_RouteLightningErrorZ_result_ok(res);
114                 byte[] serialized_route = bindings.Route_write(bindings.LDKCResult_RouteLightningErrorZ_get_ok(res));
115                 must_free_objs.add(new WeakReference<>(serialized_route));
116                 Route copy = Route.constructor_read(serialized_route);
117                 bindings.CResult_RouteLightningErrorZ_free(res);
118                 return copy;
119             }
120         }
121     }
122
123     class LongHolder { long val; }
124
125     java.util.LinkedList<WeakReference<Object>> must_free_objs = new java.util.LinkedList();
126
127     void do_read_event(ConcurrentLinkedQueue<Thread> list, PeerManager pm, long descriptor, byte[] data) {
128         Thread thread = new Thread(() -> {
129             long res = bindings.PeerManager_read_event(pm._test_only_get_ptr(), descriptor, data);
130             assert bindings.LDKCResult_boolPeerHandleErrorZ_result_ok(res);
131             //assert bindings.deref_bool(bindings.LDKCResult_boolPeerHandleErrorZ_get_inner(res));
132             bindings.CResult_boolPeerHandleErrorZ_free(res);
133         });
134         thread.start();
135         list.add(thread);
136         must_free_objs.add(new WeakReference<>(data));
137     }
138
139     boolean gc_ran = false;
140
141     class GcCheck {
142         @Override
143         protected void finalize() throws Throwable {
144             gc_ran = true;
145             super.finalize();
146         }
147     }
148
149     void do_test_message_handler(boolean nice_close) throws InterruptedException {
150         GcCheck obj = new GcCheck();
151         Peer peer1 = new Peer((byte) 1);
152         Peer peer2 = new Peer((byte) 2);
153
154         ConcurrentLinkedQueue<Thread> list = new ConcurrentLinkedQueue<Thread>();
155         LongHolder descriptor1 = new LongHolder();
156         LongHolder descriptor1ref = descriptor1;
157         bindings.LDKSocketDescriptor sock1 = new bindings.LDKSocketDescriptor() {
158             @Override
159             public long send_data(byte[] data, boolean resume_read) {
160                 do_read_event(list, peer1.peer_manager, descriptor1ref.val, data);
161                 return data.length;
162             }
163
164             @Override public void disconnect_socket() { assert false; }
165             @Override public boolean eq(long other_arg) { return bindings.LDKSocketDescriptor_get_obj_from_jcalls(other_arg).hash() == 2; }
166             @Override public long hash() { return 2; }
167         };
168         long descriptor2 = bindings.LDKSocketDescriptor_new(sock1);
169
170         bindings.LDKSocketDescriptor sock2 = new bindings.LDKSocketDescriptor() {
171             @Override
172             public long send_data(byte[] data, boolean resume_read) {
173                 do_read_event(list, peer2.peer_manager, descriptor2, data);
174                 return data.length;
175             }
176
177             @Override public void disconnect_socket() { assert false; }
178             @Override public boolean eq(long other_arg) { return bindings.LDKSocketDescriptor_get_obj_from_jcalls(other_arg).hash() == 1; }
179             @Override public long hash() { return 1; }
180         };
181         descriptor1.val = bindings.LDKSocketDescriptor_new(sock2);
182
183         long init_vec = bindings.PeerManager_new_outbound_connection(peer1.peer_manager._test_only_get_ptr(), peer2.node_id, descriptor1.val);
184         assert (bindings.LDKCResult_CVec_u8ZPeerHandleErrorZ_result_ok(init_vec));
185
186         long con_res = bindings.PeerManager_new_inbound_connection(peer2.peer_manager._test_only_get_ptr(), descriptor2);
187         assert (bindings.LDKCResult_NonePeerHandleErrorZ_result_ok(con_res));
188         bindings.CResult_NonePeerHandleErrorZ_free(con_res);
189         do_read_event(list, peer2.peer_manager, descriptor2, bindings.LDKCResult_CVec_u8ZPeerHandleErrorZ_get_ok(init_vec));
190         bindings.CResult_CVec_u8ZPeerHandleErrorZ_free(init_vec);
191
192         while (!list.isEmpty()) { list.poll().join(); }
193
194         Result_NoneAPIErrorZ cc_res = peer1.chan_manager.create_channel(peer2.node_id, 10000, 1000, 42, null);
195         assert cc_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
196
197         peer1.peer_manager.process_events();
198         while (!list.isEmpty()) { list.poll().join(); }
199         peer2.peer_manager.process_events();
200         while (!list.isEmpty()) { list.poll().join(); }
201
202         Event[] events = peer1.chan_manager_events.get_and_clear_pending_events();
203         assert events.length == 1;
204         assert events[0] instanceof Event.FundingGenerationReady;
205         assert ((Event.FundingGenerationReady) events[0]).channel_value_satoshis == 10000;
206         assert ((Event.FundingGenerationReady) events[0]).user_channel_id == 42;
207         byte[] funding_spk = ((Event.FundingGenerationReady) events[0]).output_script;
208         assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
209         byte[] chan_id = ((Event.FundingGenerationReady) events[0]).temporary_channel_id;
210
211         NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
212
213         Transaction funding = new Transaction(bitcoinj_net);
214         funding.addInput(new TransactionInput(bitcoinj_net, funding, new byte[0]));
215         funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
216         funding.getInput(0).getWitness().setPush(0, new byte[]{0x1});
217         funding.addOutput(Coin.SATOSHI.multiply(10000), new Script(funding_spk));
218         peer1.chan_manager.funding_transaction_generated(chan_id, OutPoint.constructor_new(funding.getTxId().getReversedBytes(), (short) 0));
219
220         peer1.peer_manager.process_events();
221         while (!list.isEmpty()) { list.poll().join(); }
222         peer2.peer_manager.process_events();
223         while (!list.isEmpty()) { list.poll().join(); }
224
225         events = peer1.chan_manager_events.get_and_clear_pending_events();
226         assert events.length == 1;
227         assert events[0] instanceof Event.FundingBroadcastSafe;
228         assert ((Event.FundingBroadcastSafe) events[0]).user_channel_id == 42;
229
230         Block b = new Block(bitcoinj_net, 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
231         assert peer1.connect_block(b, 1).length == 0;
232         assert peer2.connect_block(b, 1).length == 0;
233
234         for (int height = 2; height < 10; height++) {
235             b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[0]));
236             assert peer1.connect_block(b, height).length == 0;
237             assert peer2.connect_block(b, height).length == 0;
238         }
239
240         peer1.peer_manager.process_events();
241         peer2.peer_manager.process_events();
242         while (!list.isEmpty()) { list.poll().join(); }
243
244         peer1.chan_manager.list_channels();
245         ChannelDetails[] peer1_chans = peer1.chan_manager.list_channels();
246         ChannelDetails[] peer2_chans = peer2.chan_manager.list_channels();
247         assert peer1_chans.length == 1;
248         assert peer2_chans.length == 1;
249         assert peer1_chans[0].get_channel_value_satoshis() == 10000;
250         assert peer1_chans[0].get_is_live();
251         assert Arrays.equals(peer1_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
252         assert Arrays.equals(peer2_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
253
254         byte[] payment_preimage = new byte[32];
255         for (int i = 0; i < 32; i++) payment_preimage[i] = (byte) (i ^ 0x0f);
256         byte[] payment_hash = Sha256Hash.hash(payment_preimage);
257         Route route = peer1.get_route(peer2.node_id, peer1_chans);
258         Result_NonePaymentSendFailureZ payment_res = peer1.chan_manager.send_payment(route, payment_hash, new byte[32]);
259         assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_OK;
260
261         peer1.peer_manager.process_events();
262         while (!list.isEmpty()) { list.poll().join(); }
263         peer2.peer_manager.process_events();
264         while (!list.isEmpty()) { list.poll().join(); }
265         peer1.peer_manager.process_events();
266         while (!list.isEmpty()) { list.poll().join(); }
267
268         events = peer2.chan_manager_events.get_and_clear_pending_events();
269         assert events.length == 1;
270         assert events[0] instanceof Event.PendingHTLCsForwardable;
271         peer2.chan_manager.process_pending_htlc_forwards();
272
273         events = peer2.chan_manager_events.get_and_clear_pending_events();
274         assert events.length == 1;
275         assert events[0] instanceof Event.PaymentReceived;
276         peer2.chan_manager.claim_funds(payment_preimage, new byte[32], ((Event.PaymentReceived) events[0]).amt);
277
278         peer2.peer_manager.process_events();
279         while (!list.isEmpty()) { list.poll().join(); }
280         peer1.peer_manager.process_events();
281         while (!list.isEmpty()) { list.poll().join(); }
282         peer2.peer_manager.process_events();
283         while (!list.isEmpty()) { list.poll().join(); }
284
285         events = peer1.chan_manager_events.get_and_clear_pending_events();
286         assert events.length == 1;
287         assert events[0] instanceof Event.PaymentSent;
288         assert Arrays.equals(((Event.PaymentSent) events[0]).payment_preimage, payment_preimage);
289
290         if (nice_close) {
291             Result_NoneAPIErrorZ close_res = peer1.chan_manager.close_channel(peer1_chans[0].get_channel_id());
292             assert close_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
293
294             peer1.peer_manager.process_events();
295             while (!list.isEmpty()) { list.poll().join(); }
296             peer2.peer_manager.process_events();
297             while (!list.isEmpty()) { list.poll().join(); }
298             peer1.peer_manager.process_events();
299             while (!list.isEmpty()) { list.poll().join(); }
300             peer2.peer_manager.process_events();
301             while (!list.isEmpty()) { list.poll().join(); }
302
303             assert peer1.broadcast_set.size() == 1;
304             assert peer2.broadcast_set.size() == 1;
305         } else {
306             peer1.chan_manager.force_close_all_channels();
307
308             peer1.peer_manager.process_events();
309             while (!list.isEmpty()) { list.poll().join(); }
310             peer2.peer_manager.process_events();
311             while (!list.isEmpty()) { list.poll().join(); }
312             peer1.peer_manager.process_events();
313             while (!list.isEmpty()) { list.poll().join(); }
314             peer2.peer_manager.process_events();
315             while (!list.isEmpty()) { list.poll().join(); }
316
317             assert peer1.broadcast_set.size() == 1;
318             assert peer2.broadcast_set.size() == 0;
319
320             Transaction tx = new Transaction(bitcoinj_net, peer1.broadcast_set.getFirst().get_contents());
321             b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0,
322                     Arrays.asList(new Transaction[]{tx}));
323             TwoTuple<byte[], TxOut[]>[] watch_outputs =  peer2.connect_block(b, 1);
324             assert watch_outputs.length == 1;
325             assert Arrays.equals(watch_outputs[0].a, tx.getTxId().getReversedBytes());
326             assert watch_outputs[0].b.length == 1;
327         }
328
329         bindings.SocketDescriptor_free(descriptor2);
330         bindings.SocketDescriptor_free(descriptor1.val);
331     }
332
333 }
334 public class HumanObjectPeerTest {
335     @Test
336     public void test_message_handler_force_close() throws InterruptedException {
337         HumanObjectPeerTestInstance instance = new HumanObjectPeerTestInstance();
338         instance.do_test_message_handler(false);
339         while (!instance.gc_ran) {
340             System.gc();
341             System.runFinalization();
342         }
343         for (WeakReference<Object> o : instance.must_free_objs)
344             assert o.get() == null;
345     }
346     @Test
347     public void test_message_handler_nice_close() throws InterruptedException {
348         HumanObjectPeerTestInstance instance = new HumanObjectPeerTestInstance();
349         instance.do_test_message_handler(true);
350         while (!instance.gc_ran) {
351             System.gc();
352             System.runFinalization();
353         }
354         for (WeakReference<Object> o : instance.must_free_objs)
355             assert o.get() == null;
356     }
357 }