Fix returning traits in trait calls, move towards clone on return
[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         KeysInterface manual_keysif(KeysInterface underlying_if) {
21             return KeysInterface.new_impl(new KeysInterface.KeysInterfaceInterface() {
22                 @Override
23                 public byte[] get_node_secret() {
24                     return underlying_if.get_node_secret();
25                 }
26
27                 @Override
28                 public byte[] get_destination_script() {
29                     return underlying_if.get_destination_script();
30                 }
31
32                 @Override
33                 public byte[] get_shutdown_pubkey() {
34                     return underlying_if.get_shutdown_pubkey();
35                 }
36
37                 @Override
38                 public ChannelKeys get_channel_keys(boolean inbound, long channel_value_satoshis) {
39                     ChannelKeys underlying_ck = underlying_if.get_channel_keys(inbound, channel_value_satoshis);
40                     ChannelKeys.ChannelKeysInterface cki = new ChannelKeys.ChannelKeysInterface() {
41                         @Override
42                         public byte[] get_per_commitment_point(long idx) {
43                             return underlying_ck.get_per_commitment_point(idx);
44                         }
45
46                         @Override
47                         public byte[] release_commitment_secret(long idx) {
48                             return underlying_ck.release_commitment_secret(idx);
49                         }
50
51                         @Override
52                         public TwoTuple<Long, Long> key_derivation_params() {
53                             return new TwoTuple<Long, Long>((long)0, (long)1);
54                         }
55
56                         @Override
57                         public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_counterparty_commitment(int feerate_per_kw, byte[] commitment_tx, PreCalculatedTxCreationKeys keys, HTLCOutputInCommitment[] htlcs) {
58                             return underlying_ck.sign_counterparty_commitment(feerate_per_kw, commitment_tx, keys, htlcs);
59                         }
60
61                         @Override
62                         public Result_SignatureNoneZ sign_holder_commitment(HolderCommitmentTransaction holder_commitment_tx) {
63                             return underlying_ck.sign_holder_commitment(holder_commitment_tx);
64                         }
65
66                         @Override
67                         public Result_CVec_SignatureZNoneZ sign_holder_commitment_htlc_transactions(HolderCommitmentTransaction holder_commitment_tx) {
68                             return underlying_ck.sign_holder_commitment_htlc_transactions(holder_commitment_tx);
69                         }
70
71                         @Override
72                         public Result_SignatureNoneZ sign_justice_transaction(byte[] justice_tx, long input, long amount, byte[] per_commitment_key, HTLCOutputInCommitment htlc) {
73                             return underlying_ck.sign_justice_transaction(justice_tx, input, amount, per_commitment_key, htlc);
74                         }
75
76                         @Override
77                         public Result_SignatureNoneZ sign_counterparty_htlc_transaction(byte[] htlc_tx, long input, long amount, byte[] per_commitment_point, HTLCOutputInCommitment htlc) {
78                             return underlying_ck.sign_counterparty_htlc_transaction(htlc_tx, input, amount, per_commitment_point, htlc);
79                         }
80
81                         @Override
82                         public Result_SignatureNoneZ sign_closing_transaction(byte[] closing_tx) {
83                             return underlying_ck.sign_closing_transaction(closing_tx);
84                         }
85
86                         @Override
87                         public Result_SignatureNoneZ sign_channel_announcement(UnsignedChannelAnnouncement msg) {
88                             return underlying_ck.sign_channel_announcement(msg);
89                         }
90
91                         @Override
92                         public void on_accept(ChannelPublicKeys channel_points, short counterparty_selected_contest_delay, short holder_selected_contest_delay) {
93                             underlying_ck.on_accept(channel_points, counterparty_selected_contest_delay, holder_selected_contest_delay);
94                         }
95                     };
96                     ChannelKeys resp = ChannelKeys.new_impl(cki, underlying_ck.get_pubkeys());
97                     must_free_objs.add(new WeakReference<>(cki));
98                     must_free_objs.add(new WeakReference<>(resp));
99                     must_free_objs.add(new WeakReference<>(underlying_ck));
100                     return resp;
101                 }
102
103                 @Override
104                 public byte[] get_secure_random_bytes() {
105                     return underlying_if.get_secure_random_bytes();
106                 }
107             });
108         }
109
110         final Logger logger;
111         final FeeEstimator fee_estimator;
112         final BroadcasterInterface tx_broadcaster;
113         final KeysInterface keys_interface;
114         final ChannelManager chan_manager;
115         final EventsProvider chan_manager_events;
116         final NetGraphMsgHandler router;
117         final PeerManager peer_manager;
118         final HashMap<String, ChannelMonitor> monitors; // Wow I forgot just how terrible Java is - we can't put a byte array here.
119         byte[] node_id;
120         final LinkedList<byte[]> broadcast_set = new LinkedList<>();
121
122         Peer(byte seed, boolean use_km_wrapper) {
123             logger = Logger.new_impl((String arg) -> System.out.println(seed + ": " + arg));
124             fee_estimator = FeeEstimator.new_impl((confirmation_target -> 253));
125             tx_broadcaster = BroadcasterInterface.new_impl(tx -> {
126                 broadcast_set.add(tx);
127             });
128             this.monitors = new HashMap<>();
129             Watch chain_monitor = Watch.new_impl(new Watch.WatchInterface() {
130                 public Result_NoneChannelMonitorUpdateErrZ watch_channel(OutPoint funding_txo, ChannelMonitor monitor) {
131                     synchronized (monitors) {
132                         assert monitors.put(Arrays.toString(funding_txo.get_txid()), monitor) == null;
133                     }
134                     return new Result_NoneChannelMonitorUpdateErrZ.Result_NoneChannelMonitorUpdateErrZ_OK();
135                 }
136
137                 public Result_NoneChannelMonitorUpdateErrZ update_channel(OutPoint funding_txo, ChannelMonitorUpdate update) {
138                     synchronized (monitors) {
139                         String txid = Arrays.toString(funding_txo.get_txid());
140                         assert monitors.containsKey(txid);
141                         Result_NoneMonitorUpdateErrorZ update_res = monitors.get(txid).update_monitor(update, tx_broadcaster, logger);
142                         assert update_res instanceof Result_NoneMonitorUpdateErrorZ.Result_NoneMonitorUpdateErrorZ_OK;
143                     }
144                     return new Result_NoneChannelMonitorUpdateErrZ.Result_NoneChannelMonitorUpdateErrZ_OK();
145                 }
146
147                 @Override
148                 public MonitorEvent[] release_pending_monitor_events() {
149                     synchronized (monitors) {
150                         assert monitors.size() <= 1;
151                         for (ChannelMonitor mon : monitors.values()) {
152                             return mon.get_and_clear_pending_monitor_events();
153                         }
154                     }
155                     return new MonitorEvent[0];
156                 }
157             });
158
159             byte[] key_seed = new byte[32];
160             for (byte i = 0; i < 32; i++) {
161                 key_seed[i] = (byte) (i ^ seed);
162             }
163             if (use_km_wrapper) {
164                 KeysManager underlying = KeysManager.constructor_new(key_seed, LDKNetwork.LDKNetwork_Bitcoin, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000) & 0xffffffff);
165                 this.keys_interface = manual_keysif(underlying.as_KeysInterface());
166             } else {
167                 KeysManager keys = KeysManager.constructor_new(key_seed, LDKNetwork.LDKNetwork_Bitcoin, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000) & 0xffffffff);
168                 this.keys_interface = keys.as_KeysInterface();
169             }
170             this.chan_manager = ChannelManager.constructor_new(LDKNetwork.LDKNetwork_Bitcoin, FeeEstimator.new_impl(confirmation_target -> 0), chain_monitor, tx_broadcaster, logger, this.keys_interface, UserConfig.constructor_default(), 1);
171             this.node_id = chan_manager.get_our_node_id();
172             this.chan_manager_events = chan_manager.as_EventsProvider();
173             this.router = NetGraphMsgHandler.constructor_new(null, logger);
174
175             byte[] random_data = new byte[32];
176             for (byte i = 0; i < 32; i++) {
177                 random_data[i] = (byte) ((i ^ seed) ^ 0xf0);
178             }
179             this.peer_manager = PeerManager.constructor_new(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger);
180             System.gc();
181         }
182
183         TwoTuple<byte[], TxOut[]>[] connect_block(Block b, int height) {
184             byte[] header = Arrays.copyOfRange(b.bitcoinSerialize(), 0, 80);
185             TwoTuple<Long, byte[]>[] txn;
186             if (b.hasTransactions()) {
187                 assert b.getTransactions().size() == 1;
188                 TwoTuple<Long, byte[]> txp = new TwoTuple<>((long) 1, b.getTransactions().get(0).bitcoinSerialize());
189                 txn = new TwoTuple[]{txp};
190             } else
191                 txn = new TwoTuple[0];
192             chan_manager.block_connected(header, txn, height);
193             synchronized (monitors) {
194                 assert monitors.size() == 1;
195                 for (ChannelMonitor mon : monitors.values()) {
196                     return mon.block_connected(header, txn, height, tx_broadcaster, fee_estimator, logger);
197                 }
198             }
199             return null;
200         }
201
202         Route get_route(byte[] dest_node, ChannelDetails[] our_chans) {
203             try (LockedNetworkGraph netgraph = this.router.read_locked_graph()) {
204                 NetworkGraph graph = netgraph.graph();
205                 long res = bindings.get_route(this.node_id, graph._test_only_get_ptr(), dest_node, new long[]{our_chans[0]._test_only_get_ptr()},
206                         new long[0], 1000, 42, this.logger._test_only_get_ptr());
207                 assert bindings.LDKCResult_RouteLightningErrorZ_result_ok(res);
208                 byte[] serialized_route = bindings.Route_write(bindings.LDKCResult_RouteLightningErrorZ_get_ok(res));
209                 must_free_objs.add(new WeakReference<>(serialized_route));
210                 Route copy = Route.constructor_read(serialized_route);
211                 bindings.CResult_RouteLightningErrorZ_free(res);
212                 return copy;
213             }
214         }
215     }
216
217     class LongHolder { long val; }
218
219     java.util.LinkedList<WeakReference<Object>> must_free_objs = new java.util.LinkedList();
220
221     void do_read_event(ConcurrentLinkedQueue<Thread> list, PeerManager pm, long descriptor, byte[] data) {
222         Thread thread = new Thread(() -> {
223             long res = bindings.PeerManager_read_event(pm._test_only_get_ptr(), descriptor, data);
224             assert bindings.LDKCResult_boolPeerHandleErrorZ_result_ok(res);
225             //assert bindings.deref_bool(bindings.LDKCResult_boolPeerHandleErrorZ_get_inner(res));
226             bindings.CResult_boolPeerHandleErrorZ_free(res);
227         });
228         thread.start();
229         list.add(thread);
230         must_free_objs.add(new WeakReference<>(data));
231     }
232
233     boolean gc_ran = false;
234
235     class GcCheck {
236         @Override
237         protected void finalize() throws Throwable {
238             gc_ran = true;
239             super.finalize();
240         }
241     }
242
243     void do_test_message_handler(boolean nice_close, boolean use_km_wrapper) throws InterruptedException {
244         GcCheck obj = new GcCheck();
245         Peer peer1 = new Peer((byte) 1, use_km_wrapper);
246         Peer peer2 = new Peer((byte) 2, use_km_wrapper);
247
248         ConcurrentLinkedQueue<Thread> list = new ConcurrentLinkedQueue<Thread>();
249         LongHolder descriptor1 = new LongHolder();
250         LongHolder descriptor1ref = descriptor1;
251         bindings.LDKSocketDescriptor sock1 = new bindings.LDKSocketDescriptor() {
252             @Override
253             public long send_data(byte[] data, boolean resume_read) {
254                 do_read_event(list, peer1.peer_manager, descriptor1ref.val, data);
255                 return data.length;
256             }
257
258             @Override public void disconnect_socket() { assert false; }
259             @Override public boolean eq(long other_arg) { return bindings.LDKSocketDescriptor_get_obj_from_jcalls(other_arg).hash() == 2; }
260             @Override public long hash() { return 2; }
261         };
262         long descriptor2 = bindings.LDKSocketDescriptor_new(sock1);
263
264         bindings.LDKSocketDescriptor sock2 = new bindings.LDKSocketDescriptor() {
265             @Override
266             public long send_data(byte[] data, boolean resume_read) {
267                 do_read_event(list, peer2.peer_manager, descriptor2, data);
268                 return data.length;
269             }
270
271             @Override public void disconnect_socket() { assert false; }
272             @Override public boolean eq(long other_arg) { return bindings.LDKSocketDescriptor_get_obj_from_jcalls(other_arg).hash() == 1; }
273             @Override public long hash() { return 1; }
274         };
275         descriptor1.val = bindings.LDKSocketDescriptor_new(sock2);
276
277         long init_vec = bindings.PeerManager_new_outbound_connection(peer1.peer_manager._test_only_get_ptr(), peer2.node_id, descriptor1.val);
278         assert (bindings.LDKCResult_CVec_u8ZPeerHandleErrorZ_result_ok(init_vec));
279
280         long con_res = bindings.PeerManager_new_inbound_connection(peer2.peer_manager._test_only_get_ptr(), descriptor2);
281         assert (bindings.LDKCResult_NonePeerHandleErrorZ_result_ok(con_res));
282         bindings.CResult_NonePeerHandleErrorZ_free(con_res);
283         do_read_event(list, peer2.peer_manager, descriptor2, bindings.LDKCResult_CVec_u8ZPeerHandleErrorZ_get_ok(init_vec));
284         bindings.CResult_CVec_u8ZPeerHandleErrorZ_free(init_vec);
285
286         while (!list.isEmpty()) { list.poll().join(); }
287
288         Result_NoneAPIErrorZ cc_res = peer1.chan_manager.create_channel(peer2.node_id, 10000, 1000, 42, null);
289         assert cc_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
290
291         peer1.peer_manager.process_events();
292         while (!list.isEmpty()) { list.poll().join(); }
293         peer2.peer_manager.process_events();
294         while (!list.isEmpty()) { list.poll().join(); }
295
296         Event[] events = peer1.chan_manager_events.get_and_clear_pending_events();
297         assert events.length == 1;
298         assert events[0] instanceof Event.FundingGenerationReady;
299         assert ((Event.FundingGenerationReady) events[0]).channel_value_satoshis == 10000;
300         assert ((Event.FundingGenerationReady) events[0]).user_channel_id == 42;
301         byte[] funding_spk = ((Event.FundingGenerationReady) events[0]).output_script;
302         assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
303         byte[] chan_id = ((Event.FundingGenerationReady) events[0]).temporary_channel_id;
304
305         NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
306
307         Transaction funding = new Transaction(bitcoinj_net);
308         funding.addInput(new TransactionInput(bitcoinj_net, funding, new byte[0]));
309         funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
310         funding.getInput(0).getWitness().setPush(0, new byte[]{0x1});
311         funding.addOutput(Coin.SATOSHI.multiply(10000), new Script(funding_spk));
312         peer1.chan_manager.funding_transaction_generated(chan_id, OutPoint.constructor_new(funding.getTxId().getReversedBytes(), (short) 0));
313
314         peer1.peer_manager.process_events();
315         while (!list.isEmpty()) { list.poll().join(); }
316         peer2.peer_manager.process_events();
317         while (!list.isEmpty()) { list.poll().join(); }
318
319         events = peer1.chan_manager_events.get_and_clear_pending_events();
320         assert events.length == 1;
321         assert events[0] instanceof Event.FundingBroadcastSafe;
322         assert ((Event.FundingBroadcastSafe) events[0]).user_channel_id == 42;
323
324         Block b = new Block(bitcoinj_net, 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
325         assert peer1.connect_block(b, 1).length == 0;
326         assert peer2.connect_block(b, 1).length == 0;
327
328         for (int height = 2; height < 10; height++) {
329             b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[0]));
330             assert peer1.connect_block(b, height).length == 0;
331             assert peer2.connect_block(b, height).length == 0;
332         }
333
334         peer1.peer_manager.process_events();
335         peer2.peer_manager.process_events();
336         while (!list.isEmpty()) { list.poll().join(); }
337
338         peer1.chan_manager.list_channels();
339         ChannelDetails[] peer1_chans = peer1.chan_manager.list_channels();
340         ChannelDetails[] peer2_chans = peer2.chan_manager.list_channels();
341         assert peer1_chans.length == 1;
342         assert peer2_chans.length == 1;
343         assert peer1_chans[0].get_channel_value_satoshis() == 10000;
344         assert peer1_chans[0].get_is_live();
345         assert Arrays.equals(peer1_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
346         assert Arrays.equals(peer2_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
347
348         byte[] payment_preimage = new byte[32];
349         for (int i = 0; i < 32; i++) payment_preimage[i] = (byte) (i ^ 0x0f);
350         byte[] payment_hash = Sha256Hash.hash(payment_preimage);
351         Route route = peer1.get_route(peer2.node_id, peer1_chans);
352         Result_NonePaymentSendFailureZ payment_res = peer1.chan_manager.send_payment(route, payment_hash, new byte[32]);
353         assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_OK;
354
355         peer1.peer_manager.process_events();
356         while (!list.isEmpty()) { list.poll().join(); }
357         peer2.peer_manager.process_events();
358         while (!list.isEmpty()) { list.poll().join(); }
359         peer1.peer_manager.process_events();
360         while (!list.isEmpty()) { list.poll().join(); }
361
362         events = peer2.chan_manager_events.get_and_clear_pending_events();
363         assert events.length == 1;
364         assert events[0] instanceof Event.PendingHTLCsForwardable;
365         peer2.chan_manager.process_pending_htlc_forwards();
366
367         events = peer2.chan_manager_events.get_and_clear_pending_events();
368         assert events.length == 1;
369         assert events[0] instanceof Event.PaymentReceived;
370         peer2.chan_manager.claim_funds(payment_preimage, new byte[32], ((Event.PaymentReceived) events[0]).amt);
371
372         peer2.peer_manager.process_events();
373         while (!list.isEmpty()) { list.poll().join(); }
374         peer1.peer_manager.process_events();
375         while (!list.isEmpty()) { list.poll().join(); }
376         peer2.peer_manager.process_events();
377         while (!list.isEmpty()) { list.poll().join(); }
378
379         events = peer1.chan_manager_events.get_and_clear_pending_events();
380         assert events.length == 1;
381         assert events[0] instanceof Event.PaymentSent;
382         assert Arrays.equals(((Event.PaymentSent) events[0]).payment_preimage, payment_preimage);
383
384         if (nice_close) {
385             Result_NoneAPIErrorZ close_res = peer1.chan_manager.close_channel(peer1_chans[0].get_channel_id());
386             assert close_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
387
388             peer1.peer_manager.process_events();
389             while (!list.isEmpty()) { list.poll().join(); }
390             peer2.peer_manager.process_events();
391             while (!list.isEmpty()) { list.poll().join(); }
392             peer1.peer_manager.process_events();
393             while (!list.isEmpty()) { list.poll().join(); }
394             peer2.peer_manager.process_events();
395             while (!list.isEmpty()) { list.poll().join(); }
396
397             assert peer1.broadcast_set.size() == 1;
398             assert peer2.broadcast_set.size() == 1;
399         } else {
400             peer1.chan_manager.force_close_all_channels();
401
402             peer1.peer_manager.process_events();
403             while (!list.isEmpty()) { list.poll().join(); }
404             peer2.peer_manager.process_events();
405             while (!list.isEmpty()) { list.poll().join(); }
406             peer1.peer_manager.process_events();
407             while (!list.isEmpty()) { list.poll().join(); }
408             peer2.peer_manager.process_events();
409             while (!list.isEmpty()) { list.poll().join(); }
410
411             assert peer1.broadcast_set.size() == 1;
412             assert peer2.broadcast_set.size() == 0;
413
414             Transaction tx = new Transaction(bitcoinj_net, peer1.broadcast_set.getFirst());
415             b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0,
416                     Arrays.asList(new Transaction[]{tx}));
417             TwoTuple<byte[], TxOut[]>[] watch_outputs =  peer2.connect_block(b, 1);
418             assert watch_outputs.length == 1;
419             assert Arrays.equals(watch_outputs[0].a, tx.getTxId().getReversedBytes());
420             assert watch_outputs[0].b.length == 1;
421         }
422
423         bindings.SocketDescriptor_free(descriptor2);
424         bindings.SocketDescriptor_free(descriptor1.val);
425     }
426
427 }
428 public class HumanObjectPeerTest {
429     void do_test(boolean nice_close, boolean use_km_wrapper) throws InterruptedException {
430         HumanObjectPeerTestInstance instance = new HumanObjectPeerTestInstance();
431         instance.do_test_message_handler(nice_close, use_km_wrapper);
432         while (!instance.gc_ran) {
433             System.gc();
434             System.runFinalization();
435         }
436         for (WeakReference<Object> o : instance.must_free_objs)
437             assert o.get() == null;
438     }
439     @Test
440     public void test_message_handler_force_close() throws InterruptedException {
441         do_test(false, false);
442     }
443     @Test
444     public void test_message_handler_nice_close() throws InterruptedException {
445         do_test(true, false);
446     }
447     @Test
448     public void test_message_handler_nice_close_wrapper() throws InterruptedException {
449         do_test(true, true);
450     }
451     @Test
452     public void test_message_handler_force_close_wrapper() throws InterruptedException {
453         do_test(false, true);
454     }
455 }