63a4e169569afc547f428c72259a9ed0a455756e
[ldk-java] / src / test / java / org / ldk / PeerTest.java
1 package org.ldk;
2
3 import org.bitcoinj.core.*;
4 import org.bitcoinj.script.Script;
5 import org.junit.jupiter.api.Test;
6 import org.ldk.enums.Network;
7 import org.ldk.enums.Recipient;
8 import org.ldk.impl.bindings;
9
10 import java.lang.ref.Reference;
11 import java.util.ArrayList;
12 import java.util.Arrays;
13 import java.util.HashMap;
14 import java.util.LinkedList;
15 import java.util.concurrent.ConcurrentHashMap;
16 import java.util.concurrent.ConcurrentLinkedQueue;
17
18 public class PeerTest {
19     class Peer {
20         final long logger;
21         final long fee_estimator;
22         final long tx_broadcaster;
23         final long chain_monitor;
24         final long keys;
25         final long keys_interface;
26         final long config;
27         final long chan_manager;
28         final long chan_manager_events;
29         final long chan_handler;
30         final long router;
31         final long router_wrapper;
32         final long route_handler;
33         final long message_handler;
34         final long ignoring_message_handler;
35         final long custom_message_handler;
36         final long onion_message_handler;
37         final long peer_manager;
38         HashMap<String, Long> monitors; // Wow I forgot just how terrible Java is - we can't put a byte array here.
39         byte[] node_id;
40         bindings.LDKFeeEstimator fee_est;
41         bindings.LDKBroadcasterInterface broad_trait;
42         bindings.LDKLogger log_trait;
43         bindings.LDKWatch watcher;
44
45         Peer(byte seed) {
46             this.log_trait = (long arg) -> {
47                 System.out.println(seed + ": " + bindings.Record_get_args(arg));
48                 bindings.Record_free(arg);
49             };
50             logger = bindings.LDKLogger_new(this.log_trait);
51             this.fee_est = confirmation_target -> 0;
52             this.fee_estimator = bindings.LDKFeeEstimator_new(this.fee_est);
53             this.broad_trait = tx -> {
54                 // We should broadcast
55             };
56             this.tx_broadcaster = bindings.LDKBroadcasterInterface_new(this.broad_trait);
57             this.monitors = new HashMap<>();
58             this.watcher = new bindings.LDKWatch() {
59                 @Override
60                 public long watch_channel(long funding_txo, long monitor) {
61                     synchronized (monitors) {
62                         assert monitors.put(Arrays.toString(bindings.OutPoint_get_txid(funding_txo)), monitor) == null;
63                     }
64                     bindings.OutPoint_free(funding_txo);
65                     return bindings.CResult_NoneChannelMonitorUpdateErrZ_ok();
66                 }
67
68                 @Override
69                 public long update_channel(long funding_txo, long update) {
70                     synchronized (monitors) {
71                         String txid = Arrays.toString(bindings.OutPoint_get_txid(funding_txo));
72                         assert monitors.containsKey(txid);
73                         long update_res = bindings.ChannelMonitor_update_monitor(monitors.get(txid), update, tx_broadcaster, fee_estimator, logger);
74                         assert bindings.CResult_NoneNoneZ_is_ok(update_res);
75                         bindings.CResult_NoneNoneZ_free(update_res);
76                     }
77                     bindings.OutPoint_free(funding_txo);
78                     bindings.ChannelMonitorUpdate_free(update);
79                     return bindings.CResult_NoneChannelMonitorUpdateErrZ_ok();
80                 }
81
82                 @Override
83                 public long[] release_pending_monitor_events() {
84                     synchronized (monitors) {
85                         assert monitors.size() <= 1;
86                         for (Long mon : monitors.values()) {
87                             long funding_info = bindings.ChannelMonitor_get_funding_txo(mon);
88                             long funding_txo = bindings.C2Tuple_OutPointScriptZ_get_a(funding_info);
89                             long[] mon_events = bindings.ChannelMonitor_get_and_clear_pending_monitor_events(mon);
90                             byte[] counterparty_pk = bindings.ChannelMonitor_get_counterparty_node_id(mon);
91                             long funding_mon_tuple = bindings.C3Tuple_OutPointCVec_MonitorEventZPublicKeyZ_new(funding_txo, mon_events, counterparty_pk);
92                             bindings.C2Tuple_OutPointScriptZ_free(funding_info);
93                             return new long[] {funding_mon_tuple};
94                         }
95                     }
96                     return new long[0];
97                 }
98             };
99             this.chain_monitor = bindings.LDKWatch_new(this.watcher);
100
101             byte[] key_seed = new byte[32];
102             for (byte i = 0; i < 32; i++) { key_seed[i] = (byte) (i ^ seed); }
103             this.keys = bindings.KeysManager_new(key_seed, System.currentTimeMillis() / 1000, (int)(System.currentTimeMillis() * 1000) & 0xffffffff);
104             this.keys_interface = bindings.KeysManager_as_KeysInterface(keys);
105             this.config = bindings.UserConfig_default();
106             long params = bindings.ChainParameters_new(Network.LDKNetwork_Bitcoin, bindings.BestBlock_new(new byte[32], 0));
107             this.chan_manager = bindings.ChannelManager_new(fee_estimator, chain_monitor, tx_broadcaster, logger, keys_interface, config, params);
108             this.node_id = bindings.ChannelManager_get_our_node_id(chan_manager);
109             this.chan_manager_events = bindings.ChannelManager_as_EventsProvider(chan_manager);
110
111             this.chan_handler = bindings.ChannelManager_as_ChannelMessageHandler(chan_manager);
112             this.router = bindings.NetworkGraph_new(new byte[32], logger);
113             this.router_wrapper = bindings.P2PGossipSync_new(router, bindings.COption_AccessZ_none(), logger);
114             this.route_handler = bindings.P2PGossipSync_as_RoutingMessageHandler(router_wrapper);
115             this.ignoring_message_handler = bindings.IgnoringMessageHandler_new();
116             this.custom_message_handler = bindings.IgnoringMessageHandler_as_CustomMessageHandler(this.ignoring_message_handler);
117             this.onion_message_handler = bindings.IgnoringMessageHandler_as_OnionMessageHandler(this.ignoring_message_handler);
118             this.message_handler = bindings.MessageHandler_new(chan_handler, route_handler, this.onion_message_handler);
119
120             byte[] random_data = new byte[32];
121             for (byte i = 0; i < 32; i++) { random_data[i] = (byte) ((i ^ seed) ^ 0xf0); }
122
123             long node_id_result = bindings.KeysInterface_get_node_secret(keys_interface, Recipient.LDKRecipient_Node);
124             assert bindings.CResult_SecretKeyNoneZ_is_ok(node_id_result);
125             this.peer_manager = bindings.PeerManager_new(message_handler, bindings.CResult_SecretKeyNoneZ_get_ok(node_id_result),
126                     System.currentTimeMillis() / 1000, random_data, logger, this.custom_message_handler);
127             bindings.CResult_SecretKeyNoneZ_free(node_id_result);
128         }
129
130         void connect_block(Block b, Transaction t, int height) {
131             long listen = bindings.ChannelManager_as_Listen(chan_manager);
132             bindings.Listen_block_connected(listen, b.bitcoinSerialize(), height);
133             bindings.Listen_free(listen);
134             synchronized (monitors) {
135                 for (Long mon : monitors.values()) {
136                     long[] txn;
137                     if (t != null)
138                         txn = new long[]{bindings.C2Tuple_usizeTransactionZ_new(1, t.bitcoinSerialize())};
139                     else
140                         txn = new long[0];
141                     byte[] header = Arrays.copyOfRange(b.bitcoinSerialize(), 0, 80);
142                     long[] ret = bindings.ChannelMonitor_block_connected(mon, header, txn, height, tx_broadcaster, fee_estimator, logger);
143                     for (long r : ret) {
144                         bindings.C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_free(r);
145                     }
146                 }
147             }
148         }
149
150         void free() {
151             // Note that we can't rely on finalizer order, so don't bother trying to rely on it here
152             bindings.Logger_free(logger);
153             bindings.FeeEstimator_free(fee_estimator);
154             bindings.BroadcasterInterface_free(tx_broadcaster);
155             bindings.Watch_free(chain_monitor);
156             bindings.KeysManager_free(keys);
157             bindings.KeysInterface_free(keys_interface);
158             bindings.UserConfig_free(config);
159             bindings.ChannelManager_free(chan_manager);
160             bindings.EventsProvider_free(chan_manager_events);
161             bindings.ChannelMessageHandler_free(chan_handler);
162             bindings.NetworkGraph_free(router);
163             bindings.P2PGossipSync_free(router_wrapper);
164             bindings.RoutingMessageHandler_free(route_handler);
165             bindings.CustomMessageHandler_free(custom_message_handler);
166             bindings.OnionMessageHandler_free(onion_message_handler);
167             //MessageHandler was actually moved into the route_handler!: bindings.MessageHandler_free(message_handler);
168             bindings.PeerManager_free(peer_manager);
169             synchronized (monitors) {
170                 for (Long mon : monitors.values()) {
171                     bindings.ChannelMonitor_free(mon);
172                 }
173             }
174         }
175     }
176
177     class LongHolder { long val; }
178     class PendingWrite {
179         long pm;
180         long descriptor;
181         byte[] array;
182         PendingWrite(long pm, long descriptor, byte[] array) { this.pm = pm; this.descriptor = descriptor; this.array = array; }
183         void process() {
184             long res = bindings.PeerManager_read_event(pm, descriptor, array);
185             assert bindings.CResult_boolPeerHandleErrorZ_is_ok(res);
186             assert !bindings.CResult_boolPeerHandleErrorZ_get_ok(res);
187             bindings.CResult_boolPeerHandleErrorZ_free(res);
188         }
189     }
190     ConcurrentLinkedQueue<PendingWrite> pending_writes = new ConcurrentLinkedQueue<>();
191
192     void do_read_event(ConcurrentLinkedQueue<Thread> list, long pm, long descriptor, byte[] arr) {
193         pending_writes.add(new PendingWrite(pm, descriptor, arr));
194         Thread thread = new Thread(() -> {
195             synchronized (pending_writes) {
196                 while (true) {
197                     PendingWrite write = pending_writes.poll();
198                     if (write == null) break;
199                     write.process();
200                 }
201             }
202         });
203         thread.start();
204         list.add(thread);
205     }
206
207     void deliver_peer_messages(ConcurrentLinkedQueue<Thread> list, long peer1, long peer2) throws InterruptedException {
208         bindings.PeerManager_process_events(peer1);
209         bindings.PeerManager_process_events(peer2);
210         while (!list.isEmpty()) {
211             list.poll().join();
212             bindings.PeerManager_process_events(peer1);
213             bindings.PeerManager_process_events(peer2);
214         }
215     }
216
217     @Test
218     void test_message_handler() throws InterruptedException {
219         Peer peer1 = new Peer((byte) 1);
220         Peer peer2 = new Peer((byte) 2);
221
222         ConcurrentLinkedQueue<Thread> list = new ConcurrentLinkedQueue<Thread>();
223         LongHolder descriptor1 = new LongHolder();
224         LongHolder descriptor1ref = descriptor1;
225         bindings.LDKSocketDescriptor sock1 = new bindings.LDKSocketDescriptor() {
226             @Override
227             public long send_data(byte[] data, boolean resume_read) {
228                 do_read_event(list, peer1.peer_manager, descriptor1ref.val, data);
229                 return data.length;
230             }
231
232             @Override public void disconnect_socket() { assert false; }
233             @Override public boolean eq(long other_arg) { boolean ret = bindings.SocketDescriptor_hash(other_arg) == 2; bindings.SocketDescriptor_free(other_arg); return ret; }
234             @Override public long hash() { return 2; }
235         };
236         long descriptor2 = bindings.LDKSocketDescriptor_new(sock1);
237
238         bindings.LDKSocketDescriptor sock2 = new bindings.LDKSocketDescriptor() {
239             @Override
240             public long send_data(byte[] data, boolean resume_read) {
241                 do_read_event(list, peer2.peer_manager, descriptor2, data);
242                 return data.length;
243             }
244
245             @Override public void disconnect_socket() { assert false; }
246             @Override public boolean eq(long other_arg) { boolean ret = bindings.SocketDescriptor_hash(other_arg) == 1; bindings.SocketDescriptor_free(other_arg); return ret; }
247             @Override public long hash() { return 1; }
248         };
249         descriptor1.val = bindings.LDKSocketDescriptor_new(sock2);
250
251         long no_netaddr = bindings.COption_NetAddressZ_none();
252         long init_vec = bindings.PeerManager_new_outbound_connection(peer1.peer_manager, peer2.node_id, descriptor1.val, no_netaddr);
253         assert(bindings.CResult_CVec_u8ZPeerHandleErrorZ_is_ok(init_vec));
254
255         long con_res = bindings.PeerManager_new_inbound_connection(peer2.peer_manager, descriptor2, no_netaddr);
256         assert(bindings.CResult_NonePeerHandleErrorZ_is_ok(con_res));
257         bindings.CResult_NonePeerHandleErrorZ_free(con_res);
258         do_read_event(list, peer2.peer_manager, descriptor2, bindings.CResult_CVec_u8ZPeerHandleErrorZ_get_ok(init_vec));
259         bindings.CResult_CVec_u8ZPeerHandleErrorZ_free(init_vec);
260         bindings.COption_NetAddressZ_free(no_netaddr);
261
262         deliver_peer_messages(list, peer1.peer_manager, peer2.peer_manager);
263
264         long cc_res = bindings.ChannelManager_create_channel(peer1.chan_manager, peer2.node_id, 10000, 1000, 42, 0);
265         assert bindings.CResult_NoneAPIErrorZ_is_ok(cc_res);
266         bindings.CResult_NoneAPIErrorZ_free(cc_res);
267
268         deliver_peer_messages(list, peer1.peer_manager, peer2.peer_manager);
269
270         ArrayList<Long> events = new ArrayList();
271         bindings.LDKEventHandler events_adder = events::add;
272         long handler = bindings.LDKEventHandler_new(events_adder);
273
274         bindings.EventsProvider_process_pending_events(peer1.chan_manager_events, handler);
275         assert events.size() == 1;
276         bindings.LDKEvent event = bindings.LDKEvent_ref_from_ptr(events.get(0));
277         assert event instanceof bindings.LDKEvent.FundingGenerationReady;
278         assert ((bindings.LDKEvent.FundingGenerationReady)event).channel_value_satoshis == 10000;
279         assert ((bindings.LDKEvent.FundingGenerationReady)event).user_channel_id == 42;
280         byte[] funding_spk = ((bindings.LDKEvent.FundingGenerationReady)event).output_script;
281         assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
282         byte[] chan_id = ((bindings.LDKEvent.FundingGenerationReady)event).temporary_channel_id;
283         bindings.Event_free(events.remove(0));
284
285         Transaction funding = new Transaction(NetworkParameters.fromID(NetworkParameters.ID_MAINNET));
286         funding.addInput(new TransactionInput(NetworkParameters.fromID(NetworkParameters.ID_MAINNET), funding, new byte[0]));
287         funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
288         funding.getInput(0).getWitness().setPush(0, new byte[] {0x1});
289         funding.addOutput(Coin.SATOSHI.multiply(10000), new Script(funding_spk));
290         bindings.ChannelManager_funding_transaction_generated(peer1.chan_manager, chan_id, peer2.node_id, funding.bitcoinSerialize());
291
292         deliver_peer_messages(list, peer1.peer_manager, peer2.peer_manager);
293
294         Block b = new Block(NetworkParameters.fromID(NetworkParameters.ID_MAINNET), 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
295         peer1.connect_block(b, funding, 1);
296         peer2.connect_block(b, funding, 1);
297
298         for (int height = 2; height < 10; height++) {
299             b = new Block(NetworkParameters.fromID(NetworkParameters.ID_MAINNET), 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[0]));
300             peer1.connect_block(b, null, height);
301             peer2.connect_block(b, null, height);
302         }
303
304         deliver_peer_messages(list, peer1.peer_manager, peer2.peer_manager);
305
306         long[] peer1_chans = bindings.ChannelManager_list_channels(peer1.chan_manager);
307         long[] peer2_chans = bindings.ChannelManager_list_channels(peer2.chan_manager);
308         assert peer1_chans.length == 1;
309         assert peer2_chans.length == 1;
310         assert bindings.ChannelDetails_get_channel_value_satoshis(peer1_chans[0]) == 10000;
311         assert bindings.ChannelDetails_get_is_usable(peer1_chans[0]);
312         assert Arrays.equals(bindings.ChannelDetails_get_channel_id(peer1_chans[0]), funding.getTxId().getReversedBytes());
313         assert Arrays.equals(bindings.ChannelDetails_get_channel_id(peer2_chans[0]), funding.getTxId().getReversedBytes());
314         for (long chan : peer2_chans) bindings.ChannelDetails_free(chan);
315
316         long no_min_val = bindings.COption_u64Z_none();
317         long inbound_payment = bindings.ChannelManager_create_inbound_payment(peer2.chan_manager, no_min_val, 7200);
318         assert bindings.CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ_is_ok(inbound_payment);
319         long payment_tuple = bindings.CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ_get_ok(inbound_payment);
320         bindings.COption_u64Z_free(no_min_val);
321
322         long scorer = bindings.ProbabilisticScorer_new(bindings.ProbabilisticScoringParameters_default(), peer1.router, peer1.logger);
323         long scorer_interface = bindings.ProbabilisticScorer_as_Score(scorer);
324
325         long no_u64 = bindings.COption_u64Z_none();
326         long invoice_features = bindings.InvoiceFeatures_known();
327         long payee = bindings.PaymentParameters_new(peer2.node_id, invoice_features, new long[0], no_u64, 6*24*14, (byte)1, (byte)1, new long[0]);
328         bindings.InvoiceFeatures_free(invoice_features);
329         bindings.COption_u64Z_free(no_u64);
330         long route_params = bindings.RouteParameters_new(payee, 1000, 42);
331         long route = bindings.find_route(peer1.node_id, route_params, peer1.router, peer1_chans, peer1.logger,
332                 scorer_interface, new byte[32]);
333         bindings.RouteParameters_free(route_params);
334         bindings.PaymentParameters_free(payee);
335         bindings.Score_free(scorer_interface);
336         bindings.ProbabilisticScorer_free(scorer);
337
338         for (long chan : peer1_chans) bindings.ChannelDetails_free(chan);
339         assert bindings.CResult_RouteLightningErrorZ_is_ok(route);
340         long payment_res = bindings.ChannelManager_send_payment(peer1.chan_manager, bindings.CResult_RouteLightningErrorZ_get_ok(route),
341                 bindings.C2Tuple_PaymentHashPaymentSecretZ_get_a(payment_tuple), bindings.C2Tuple_PaymentHashPaymentSecretZ_get_b(payment_tuple));
342         bindings.CResult_RouteLightningErrorZ_free(route);
343         bindings.CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ_is_ok(inbound_payment);
344         assert bindings.CResult_NonePaymentSendFailureZ_is_ok(payment_res);
345         bindings.CResult_NonePaymentSendFailureZ_free(payment_res);
346
347         deliver_peer_messages(list, peer1.peer_manager, peer2.peer_manager);
348
349         bindings.EventsProvider_process_pending_events(peer2.chan_manager_events, handler);
350         assert events.size() == 1;
351         bindings.LDKEvent forwardable = bindings.LDKEvent_ref_from_ptr(events.get(0));
352         assert forwardable instanceof bindings.LDKEvent.PendingHTLCsForwardable;
353         bindings.Event_free(events.remove(0));
354         bindings.ChannelManager_process_pending_htlc_forwards(peer2.chan_manager);
355
356         bindings.EventsProvider_process_pending_events(peer2.chan_manager_events, handler);
357         assert events.size() == 1;
358         bindings.LDKEvent payment_recvd = bindings.LDKEvent_ref_from_ptr(events.get(0));
359         assert payment_recvd instanceof bindings.LDKEvent.PaymentReceived;
360         bindings.LDKPaymentPurpose purpose = bindings.LDKPaymentPurpose_ref_from_ptr(((bindings.LDKEvent.PaymentReceived) payment_recvd).purpose);
361         assert purpose instanceof bindings.LDKPaymentPurpose.InvoicePayment;
362         bindings.ChannelManager_claim_funds(peer2.chan_manager, ((bindings.LDKPaymentPurpose.InvoicePayment) purpose).payment_preimage);
363         bindings.Event_free(events.remove(0));
364
365         bindings.EventsProvider_process_pending_events(peer2.chan_manager_events, handler);
366         assert events.size() == 1;
367         bindings.LDKEvent payment_claimed = bindings.LDKEvent_ref_from_ptr(events.get(0));
368         assert payment_claimed instanceof bindings.LDKEvent.PaymentClaimed;
369         bindings.Event_free(events.remove(0));
370
371         deliver_peer_messages(list, peer1.peer_manager, peer2.peer_manager);
372
373         bindings.EventsProvider_process_pending_events(peer1.chan_manager_events, handler);
374         assert events.size() == 2;
375         bindings.LDKEvent sent = bindings.LDKEvent_ref_from_ptr(events.get(0));
376         assert sent instanceof bindings.LDKEvent.PaymentSent;
377         bindings.Event_free(events.remove(0));
378         bindings.LDKEvent sent_path = bindings.LDKEvent_ref_from_ptr(events.get(0));
379         assert sent_path instanceof bindings.LDKEvent.PaymentPathSuccessful;
380         bindings.Event_free(events.remove(0));
381         Reference.reachabilityFence(events_adder);
382
383         bindings.EventHandler_free(handler);
384
385         peer1.free();
386         peer2.free();
387         bindings.SocketDescriptor_free(descriptor2);
388         bindings.SocketDescriptor_free(descriptor1.val);
389     }
390 }