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