clone traits before passing to jcalls and map to human types
[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 DescriptorHolder { SocketDescriptor val; }
218
219     void do_read_event(ConcurrentLinkedQueue<Thread> list, PeerManager pm, SocketDescriptor descriptor, byte[] data) {
220         Thread thread = new Thread(() -> {
221             Result_boolPeerHandleErrorZ res = pm.read_event(descriptor, data);
222             assert res instanceof Result_boolPeerHandleErrorZ.Result_boolPeerHandleErrorZ_OK;
223             //assert ((Result_boolPeerHandleErrorZ.Result_boolPeerHandleErrorZ_OK) res).res;
224         });
225         thread.start();
226         list.add(thread);
227         must_free_objs.add(new WeakReference<>(data));
228     }
229
230     void do_test_message_handler(boolean nice_close, boolean use_km_wrapper) throws InterruptedException {
231         GcCheck obj = new GcCheck();
232         Peer peer1 = new Peer((byte) 1, use_km_wrapper);
233         Peer peer2 = new Peer((byte) 2, use_km_wrapper);
234
235         ConcurrentLinkedQueue<Thread> list = new ConcurrentLinkedQueue<Thread>();
236         DescriptorHolder descriptor1 = new DescriptorHolder();
237         DescriptorHolder descriptor1ref = descriptor1;
238         SocketDescriptor descriptor2 = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
239             @Override
240             public long send_data(byte[] data, boolean resume_read) {
241                 do_read_event(list, peer1.peer_manager, descriptor1ref.val, data);
242                 return data.length;
243             }
244
245             @Override public void disconnect_socket() { assert false; }
246             @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 2; }
247             @Override public long hash() { return 2; }
248         });
249
250         descriptor1.val = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
251             @Override
252             public long send_data(byte[] data, boolean resume_read) {
253                 do_read_event(list, peer2.peer_manager, descriptor2, data);
254                 return data.length;
255             }
256
257             @Override public void disconnect_socket() { assert false; }
258             @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 1; }
259             @Override public long hash() { return 1; }
260         });
261
262         Result_CVec_u8ZPeerHandleErrorZ conn_res = peer1.peer_manager.new_outbound_connection(peer2.node_id, descriptor1.val);
263         assert conn_res instanceof Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK;
264
265         Result_NonePeerHandleErrorZ inbound_conn_res = peer2.peer_manager.new_inbound_connection(descriptor2);
266         assert inbound_conn_res instanceof Result_NonePeerHandleErrorZ.Result_NonePeerHandleErrorZ_OK;
267         do_read_event(list, peer2.peer_manager, descriptor2, ((Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK) conn_res).res);
268
269         while (!list.isEmpty()) { list.poll().join(); }
270
271         Result_NoneAPIErrorZ cc_res = peer1.chan_manager.create_channel(peer2.node_id, 10000, 1000, 42, null);
272         assert cc_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
273
274         peer1.peer_manager.process_events();
275         while (!list.isEmpty()) { list.poll().join(); }
276         peer2.peer_manager.process_events();
277         while (!list.isEmpty()) { list.poll().join(); }
278
279         Event[] events = peer1.chan_manager_events.get_and_clear_pending_events();
280         assert events.length == 1;
281         assert events[0] instanceof Event.FundingGenerationReady;
282         assert ((Event.FundingGenerationReady) events[0]).channel_value_satoshis == 10000;
283         assert ((Event.FundingGenerationReady) events[0]).user_channel_id == 42;
284         byte[] funding_spk = ((Event.FundingGenerationReady) events[0]).output_script;
285         assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
286         byte[] chan_id = ((Event.FundingGenerationReady) events[0]).temporary_channel_id;
287
288         NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
289
290         Transaction funding = new Transaction(bitcoinj_net);
291         funding.addInput(new TransactionInput(bitcoinj_net, funding, new byte[0]));
292         funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
293         funding.getInput(0).getWitness().setPush(0, new byte[]{0x1});
294         funding.addOutput(Coin.SATOSHI.multiply(10000), new Script(funding_spk));
295         peer1.chan_manager.funding_transaction_generated(chan_id, OutPoint.constructor_new(funding.getTxId().getReversedBytes(), (short) 0));
296
297         peer1.peer_manager.process_events();
298         while (!list.isEmpty()) { list.poll().join(); }
299         peer2.peer_manager.process_events();
300         while (!list.isEmpty()) { list.poll().join(); }
301
302         events = peer1.chan_manager_events.get_and_clear_pending_events();
303         assert events.length == 1;
304         assert events[0] instanceof Event.FundingBroadcastSafe;
305         assert ((Event.FundingBroadcastSafe) events[0]).user_channel_id == 42;
306
307         Block b = new Block(bitcoinj_net, 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
308         assert peer1.connect_block(b, 1).length == 0;
309         assert peer2.connect_block(b, 1).length == 0;
310
311         for (int height = 2; height < 10; height++) {
312             b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[0]));
313             assert peer1.connect_block(b, height).length == 0;
314             assert peer2.connect_block(b, height).length == 0;
315         }
316
317         peer1.peer_manager.process_events();
318         peer2.peer_manager.process_events();
319         while (!list.isEmpty()) { list.poll().join(); }
320
321         peer1.chan_manager.list_channels();
322         ChannelDetails[] peer1_chans = peer1.chan_manager.list_channels();
323         ChannelDetails[] peer2_chans = peer2.chan_manager.list_channels();
324         assert peer1_chans.length == 1;
325         assert peer2_chans.length == 1;
326         assert peer1_chans[0].get_channel_value_satoshis() == 10000;
327         assert peer1_chans[0].get_is_live();
328         assert Arrays.equals(peer1_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
329         assert Arrays.equals(peer2_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
330
331         byte[] payment_preimage = new byte[32];
332         for (int i = 0; i < 32; i++) payment_preimage[i] = (byte) (i ^ 0x0f);
333         byte[] payment_hash = Sha256Hash.hash(payment_preimage);
334         Route route = peer1.get_route(peer2.node_id, peer1_chans);
335         Result_NonePaymentSendFailureZ payment_res = peer1.chan_manager.send_payment(route, payment_hash, new byte[32]);
336         assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_OK;
337
338         peer1.peer_manager.process_events();
339         while (!list.isEmpty()) { list.poll().join(); }
340         peer2.peer_manager.process_events();
341         while (!list.isEmpty()) { list.poll().join(); }
342         peer1.peer_manager.process_events();
343         while (!list.isEmpty()) { list.poll().join(); }
344
345         events = peer2.chan_manager_events.get_and_clear_pending_events();
346         assert events.length == 1;
347         assert events[0] instanceof Event.PendingHTLCsForwardable;
348         peer2.chan_manager.process_pending_htlc_forwards();
349
350         events = peer2.chan_manager_events.get_and_clear_pending_events();
351         assert events.length == 1;
352         assert events[0] instanceof Event.PaymentReceived;
353         peer2.chan_manager.claim_funds(payment_preimage, new byte[32], ((Event.PaymentReceived) events[0]).amt);
354
355         peer2.peer_manager.process_events();
356         while (!list.isEmpty()) { list.poll().join(); }
357         peer1.peer_manager.process_events();
358         while (!list.isEmpty()) { list.poll().join(); }
359         peer2.peer_manager.process_events();
360         while (!list.isEmpty()) { list.poll().join(); }
361
362         events = peer1.chan_manager_events.get_and_clear_pending_events();
363         assert events.length == 1;
364         assert events[0] instanceof Event.PaymentSent;
365         assert Arrays.equals(((Event.PaymentSent) events[0]).payment_preimage, payment_preimage);
366
367         if (nice_close) {
368             Result_NoneAPIErrorZ close_res = peer1.chan_manager.close_channel(peer1_chans[0].get_channel_id());
369             assert close_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
370
371             peer1.peer_manager.process_events();
372             while (!list.isEmpty()) { list.poll().join(); }
373             peer2.peer_manager.process_events();
374             while (!list.isEmpty()) { list.poll().join(); }
375             peer1.peer_manager.process_events();
376             while (!list.isEmpty()) { list.poll().join(); }
377             peer2.peer_manager.process_events();
378             while (!list.isEmpty()) { list.poll().join(); }
379
380             assert peer1.broadcast_set.size() == 1;
381             assert peer2.broadcast_set.size() == 1;
382         } else {
383             peer1.chan_manager.force_close_all_channels();
384
385             peer1.peer_manager.process_events();
386             while (!list.isEmpty()) { list.poll().join(); }
387             peer2.peer_manager.process_events();
388             while (!list.isEmpty()) { list.poll().join(); }
389             peer1.peer_manager.process_events();
390             while (!list.isEmpty()) { list.poll().join(); }
391             peer2.peer_manager.process_events();
392             while (!list.isEmpty()) { list.poll().join(); }
393
394             assert peer1.broadcast_set.size() == 1;
395             assert peer2.broadcast_set.size() == 0;
396
397             Transaction tx = new Transaction(bitcoinj_net, peer1.broadcast_set.getFirst());
398             b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0,
399                     Arrays.asList(new Transaction[]{tx}));
400             TwoTuple<byte[], TxOut[]>[] watch_outputs =  peer2.connect_block(b, 1);
401             assert watch_outputs.length == 1;
402             assert Arrays.equals(watch_outputs[0].a, tx.getTxId().getReversedBytes());
403             assert watch_outputs[0].b.length == 1;
404         }
405     }
406
407
408     java.util.LinkedList<WeakReference<Object>> must_free_objs = new java.util.LinkedList();
409     boolean gc_ran = false;
410     class GcCheck {
411         @Override
412         protected void finalize() throws Throwable {
413             gc_ran = true;
414             super.finalize();
415         }
416     }
417 }
418 public class HumanObjectPeerTest {
419     void do_test(boolean nice_close, boolean use_km_wrapper) throws InterruptedException {
420         HumanObjectPeerTestInstance instance = new HumanObjectPeerTestInstance();
421         instance.do_test_message_handler(nice_close, use_km_wrapper);
422         while (!instance.gc_ran) {
423             System.gc();
424             System.runFinalization();
425         }
426         for (WeakReference<Object> o : instance.must_free_objs)
427             assert o.get() == null;
428     }
429     @Test
430     public void test_message_handler_force_close() throws InterruptedException {
431         do_test(false, false);
432     }
433     @Test
434     public void test_message_handler_nice_close() throws InterruptedException {
435         do_test(true, false);
436     }
437     @Test
438     public void test_message_handler_nice_close_wrapper() throws InterruptedException {
439         do_test(true, true);
440     }
441     @Test
442     public void test_message_handler_force_close_wrapper() throws InterruptedException {
443         do_test(false, true);
444     }
445 }