Expose human functions that use Result objects
[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
11 import java.lang.ref.WeakReference;
12 import java.util.Arrays;
13 import java.util.HashMap;
14 import java.util.concurrent.ConcurrentLinkedQueue;
15
16 public class HumanObjectPeerTest {
17     class Peer {
18         final long logger;
19         final long fee_estimator;
20         final long tx_broadcaster;
21         final KeysManager keys;
22         final KeysInterface keys_interface;
23         final ChannelManager chan_manager;
24         final EventsProvider chan_manager_events;
25         final NetGraphMsgHandler router;
26         final PeerManager peer_manager;
27         HashMap<String, Long> monitors; // Wow I forgot just how terrible Java is - we can't put a byte array here.
28         byte[] node_id;
29
30         Peer(byte seed) {
31             bindings.LDKLogger log_trait = (String arg) -> System.out.println(seed + ": " + arg);
32             logger = bindings.LDKLogger_new(log_trait);
33             this.fee_estimator = bindings.LDKFeeEstimator_new(confirmation_target -> 0);
34             this.tx_broadcaster = bindings.LDKBroadcasterInterface_new(tx -> {
35                 // We should broadcast
36             });
37             this.monitors = new HashMap<>();
38             Watch chain_monitor = new Watch(new bindings.LDKWatch() {
39                 @Override
40                 public long watch_channel(long funding_txo, long monitor) {
41                     synchronized (monitors) {
42                         assert monitors.put(Arrays.toString(bindings.OutPoint_get_txid(funding_txo)), monitor) == null;
43                     }
44                     bindings.OutPoint_free(funding_txo);
45                     return bindings.CResult_NoneChannelMonitorUpdateErrZ_ok();
46                 }
47
48                 @Override
49                 public long update_channel(long funding_txo, long update) {
50                     synchronized (monitors) {
51                         String txid = Arrays.toString(bindings.OutPoint_get_txid(funding_txo));
52                         assert monitors.containsKey(txid);
53                         long update_res = bindings.ChannelMonitor_update_monitor(monitors.get(txid), update, tx_broadcaster, logger);
54                         assert bindings.LDKCResult_NoneMonitorUpdateErrorZ_result_ok(update_res);
55                         bindings.CResult_NoneMonitorUpdateErrorZ_free(update_res);
56                     }
57                     bindings.OutPoint_free(funding_txo);
58                     bindings.ChannelMonitorUpdate_free(update);
59                     return bindings.CResult_NoneChannelMonitorUpdateErrZ_ok();
60                 }
61
62                 @Override
63                 public long[] release_pending_monitor_events() {
64                     synchronized (monitors) {
65                         assert monitors.size() <= 1;
66                         for (Long mon : monitors.values()) {
67                             return bindings.ChannelMonitor_get_and_clear_pending_monitor_events(mon);
68                         }
69                     }
70                     return new long[0];
71                 }
72             });
73
74             byte[] key_seed = new byte[32];
75             for (byte i = 0; i < 32; i++) {
76                 key_seed[i] = (byte) (i ^ seed);
77             }
78             this.keys = KeysManager.constructor_new(key_seed, LDKNetwork.LDKNetwork_Bitcoin, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000) & 0xffffffff);
79             this.keys_interface = keys.as_KeysInterface();
80             this.chan_manager = ChannelManager.constructor_new(LDKNetwork.LDKNetwork_Bitcoin, new FeeEstimator(confirmation_target -> 0), chain_monitor,
81                     new BroadcasterInterface(tx -> {
82                     }), new Logger(log_trait), keys.as_KeysInterface(), UserConfig.constructor_default(), 1);
83             this.node_id = chan_manager.get_our_node_id();
84             this.chan_manager_events = chan_manager.as_EventsProvider();
85             this.router = NetGraphMsgHandler.constructor_new(null, new Logger(log_trait));
86
87             byte[] random_data = new byte[32];
88             for (byte i = 0; i < 32; i++) {
89                 random_data[i] = (byte) ((i ^ seed) ^ 0xf0);
90             }
91             this.peer_manager = PeerManager.constructor_new(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, new Logger(log_trait));
92             System.gc();
93         }
94
95         void connect_block(Block b, Transaction t, int height) {
96             byte[] header = Arrays.copyOfRange(b.bitcoinSerialize(), 0, 80);
97             long[] txn;
98             if (t != null)
99                 txn = new long[]{bindings.C2Tuple_usizeTransactionZ_new(1, bindings.new_txpointer_copy_data(t.bitcoinSerialize()))};
100             else
101                 txn = new long[0];
102             bindings.ChannelManager_block_connected(chan_manager._test_only_get_ptr(), header, txn, height);
103             synchronized (monitors) {
104                 for (Long mon : monitors.values()) {
105                     if (t != null)
106                         txn = new long[]{bindings.C2Tuple_usizeTransactionZ_new(1, bindings.new_txpointer_copy_data(t.bitcoinSerialize()))};
107                     else
108                         txn = new long[0];
109                     long[] ret = bindings.ChannelMonitor_block_connected(mon, header, txn, height, tx_broadcaster, fee_estimator, logger);
110                     for (long r : ret) bindings.C2Tuple_TxidCVec_TxOutZZ_free(r);
111                 }
112             }
113         }
114
115         void free() {
116             // Note that we can't rely on finalizer order, so don't bother trying to rely on it here
117             bindings.Logger_free(logger);
118             bindings.FeeEstimator_free(fee_estimator);
119             bindings.BroadcasterInterface_free(tx_broadcaster);
120             synchronized (monitors) {
121                 for (Long mon : monitors.values()) {
122                     bindings.ChannelMonitor_free(mon);
123                 }
124             }
125         }
126
127         Route get_route(byte[] dest_node, ChannelDetails[] our_chans) {
128             try (LockedNetworkGraph netgraph = this.router.read_locked_graph()) {
129                 NetworkGraph graph = netgraph.graph();
130                 long res = bindings.get_route(this.node_id, graph._test_only_get_ptr(), dest_node, new long[] {our_chans[0]._test_only_get_ptr()},
131                         new long[0], 1000, 42, this.logger);
132                 assert bindings.LDKCResult_RouteLightningErrorZ_result_ok(res);
133                 Route copy = Route.constructor_read(bindings.Route_write(bindings.LDKCResult_RouteLightningErrorZ_get_ok(res)));
134                 bindings.CResult_RouteLightningErrorZ_free(res);
135                 return copy;
136             }
137         }
138     }
139
140     class LongHolder { long val; }
141
142     java.util.LinkedList<WeakReference<Object>> must_free_objs = new java.util.LinkedList();
143     void do_read_event(ConcurrentLinkedQueue<Thread> list, PeerManager pm, long descriptor, byte[] data) {
144         Thread thread = new Thread(() -> {
145             long res = bindings.PeerManager_read_event(pm._test_only_get_ptr(), descriptor, data);
146             assert bindings.LDKCResult_boolPeerHandleErrorZ_result_ok(res);
147             //assert bindings.deref_bool(bindings.LDKCResult_boolPeerHandleErrorZ_get_inner(res));
148             bindings.CResult_boolPeerHandleErrorZ_free(res);
149         });
150         thread.start();
151         list.add(thread);
152         must_free_objs.add(new WeakReference<>(data));
153     }
154
155     boolean gc_ran = false;
156     class GcCheck {
157         @Override
158         protected void finalize() throws Throwable {
159             gc_ran = true;
160             super.finalize();
161         }
162     }
163     void do_test_message_handler() throws InterruptedException {
164         GcCheck obj = new GcCheck();
165         Peer peer1 = new Peer((byte) 1);
166         Peer peer2 = new Peer((byte) 2);
167
168         ConcurrentLinkedQueue<Thread> list = new ConcurrentLinkedQueue<Thread>();
169         LongHolder descriptor1 = new LongHolder();
170         LongHolder descriptor1ref = descriptor1;
171         bindings.LDKSocketDescriptor sock1 = new bindings.LDKSocketDescriptor() {
172             @Override
173             public long send_data(byte[] data, boolean resume_read) {
174                 do_read_event(list, peer1.peer_manager, descriptor1ref.val, data);
175                 return data.length;
176             }
177
178             @Override public void disconnect_socket() { assert false; }
179             @Override public boolean eq(long other_arg) { return bindings.LDKSocketDescriptor_get_obj_from_jcalls(other_arg).hash() == 2; }
180             @Override public long hash() { return 2; }
181         };
182         long descriptor2 = bindings.LDKSocketDescriptor_new(sock1);
183
184         bindings.LDKSocketDescriptor sock2 = new bindings.LDKSocketDescriptor() {
185             @Override
186             public long send_data(byte[] data, boolean resume_read) {
187                 do_read_event(list, peer2.peer_manager, descriptor2, data);
188                 return data.length;
189             }
190
191             @Override public void disconnect_socket() { assert false; }
192             @Override public boolean eq(long other_arg) { return bindings.LDKSocketDescriptor_get_obj_from_jcalls(other_arg).hash() == 1; }
193             @Override public long hash() { return 1; }
194         };
195         descriptor1.val = bindings.LDKSocketDescriptor_new(sock2);
196
197         long init_vec = bindings.PeerManager_new_outbound_connection(peer1.peer_manager._test_only_get_ptr(), peer2.node_id, descriptor1.val);
198         assert (bindings.LDKCResult_CVec_u8ZPeerHandleErrorZ_result_ok(init_vec));
199
200         long con_res = bindings.PeerManager_new_inbound_connection(peer2.peer_manager._test_only_get_ptr(), descriptor2);
201         assert (bindings.LDKCResult_NonePeerHandleErrorZ_result_ok(con_res));
202         bindings.CResult_NonePeerHandleErrorZ_free(con_res);
203         do_read_event(list, peer2.peer_manager, descriptor2, bindings.LDKCResult_CVec_u8ZPeerHandleErrorZ_get_ok(init_vec));
204         bindings.CResult_CVec_u8ZPeerHandleErrorZ_free(init_vec);
205
206         while (!list.isEmpty()) { list.poll().join(); }
207
208         long cc_res = bindings.ChannelManager_create_channel(peer1.chan_manager._test_only_get_ptr(), peer2.node_id, 10000, 1000, 42, 0);
209         assert bindings.LDKCResult_NoneAPIErrorZ_result_ok(cc_res);
210         bindings.CResult_NoneAPIErrorZ_free(cc_res);
211
212         peer1.peer_manager.process_events();
213         while (!list.isEmpty()) { list.poll().join(); }
214         peer2.peer_manager.process_events();
215         while (!list.isEmpty()) { list.poll().join(); }
216
217         Event[] events = peer1.chan_manager_events.get_and_clear_pending_events();
218         assert events.length == 1;
219         assert events[0] instanceof Event.FundingGenerationReady;
220         assert ((Event.FundingGenerationReady)events[0]).channel_value_satoshis == 10000;
221         assert ((Event.FundingGenerationReady)events[0]).user_channel_id == 42;
222         byte[] funding_spk = ((Event.FundingGenerationReady)events[0]).output_script;
223         assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
224         byte[] chan_id = ((Event.FundingGenerationReady)events[0]).temporary_channel_id;
225
226         Transaction funding = new Transaction(NetworkParameters.fromID(NetworkParameters.ID_MAINNET));
227         funding.addInput(new TransactionInput(NetworkParameters.fromID(NetworkParameters.ID_MAINNET), funding, new byte[0]));
228         funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
229         funding.getInput(0).getWitness().setPush(0, new byte[]{0x1});
230         funding.addOutput(Coin.SATOSHI.multiply(10000), new Script(funding_spk));
231         peer1.chan_manager.funding_transaction_generated(chan_id, OutPoint.constructor_new(funding.getTxId().getReversedBytes(), (short) 0));
232
233         peer1.peer_manager.process_events();
234         while (!list.isEmpty()) { list.poll().join(); }
235         peer2.peer_manager.process_events();
236         while (!list.isEmpty()) { list.poll().join(); }
237
238         events = peer1.chan_manager_events.get_and_clear_pending_events();
239         assert events.length == 1;
240         assert events[0] instanceof Event.FundingBroadcastSafe;
241         assert ((Event.FundingBroadcastSafe)events[0]).user_channel_id == 42;
242
243         Block b = new Block(NetworkParameters.fromID(NetworkParameters.ID_MAINNET), 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
244         peer1.connect_block(b, funding, 1);
245         peer2.connect_block(b, funding, 1);
246
247         for (int height = 2; height < 10; height++) {
248             b = new Block(NetworkParameters.fromID(NetworkParameters.ID_MAINNET), 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
249             peer1.connect_block(b, null, height);
250             peer2.connect_block(b, null, height);
251         }
252
253         peer1.peer_manager.process_events();
254         peer2.peer_manager.process_events();
255         while (!list.isEmpty()) { list.poll().join(); }
256
257         peer1.chan_manager.list_channels();
258         ChannelDetails[] peer1_chans = peer1.chan_manager.list_channels();
259         ChannelDetails[] peer2_chans = peer2.chan_manager.list_channels();
260         assert peer1_chans.length == 1;
261         assert peer2_chans.length == 1;
262         assert peer1_chans[0].get_channel_value_satoshis() == 10000;
263         assert peer1_chans[0].get_is_live();
264         assert Arrays.equals(peer1_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
265         assert Arrays.equals(peer2_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
266
267         byte[] payment_preimage = new byte[32];
268         for (int i = 0; i < 32; i++) payment_preimage[i] = (byte) (i ^ 0x0f);
269         byte[] payment_hash = Sha256Hash.hash(payment_preimage);
270         Route route = peer1.get_route(peer2.node_id, peer1_chans);
271         Result_NonePaymentSendFailureZ payment_res = peer1.chan_manager.send_payment(route, payment_hash, new byte[32]);
272         assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_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         peer1.peer_manager.process_events();
279         while (!list.isEmpty()) { list.poll().join(); }
280
281         long[] peer2_events = bindings.EventsProvider_get_and_clear_pending_events(peer2.chan_manager_events._test_only_get_ptr());
282         assert peer2_events.length == 1;
283         bindings.LDKEvent forwardable = bindings.LDKEvent_ref_from_ptr(peer2_events[0]);
284         assert forwardable instanceof bindings.LDKEvent.PendingHTLCsForwardable;
285         bindings.CVec_EventZ_free(peer2_events);
286         bindings.ChannelManager_process_pending_htlc_forwards(peer2.chan_manager._test_only_get_ptr());
287
288         peer2_events = bindings.EventsProvider_get_and_clear_pending_events(peer2.chan_manager_events._test_only_get_ptr());
289         assert peer2_events.length == 1;
290         bindings.LDKEvent payment_recvd = bindings.LDKEvent_ref_from_ptr(peer2_events[0]);
291         assert payment_recvd instanceof bindings.LDKEvent.PaymentReceived;
292         peer2.chan_manager.claim_funds(payment_preimage, new byte[32], ((bindings.LDKEvent.PaymentReceived) payment_recvd).amt);
293         bindings.CVec_EventZ_free(peer2_events);
294
295         peer2.peer_manager.process_events();
296         while (!list.isEmpty()) { list.poll().join(); }
297         peer1.peer_manager.process_events();
298         while (!list.isEmpty()) { list.poll().join(); }
299
300         long[] peer1_events = bindings.EventsProvider_get_and_clear_pending_events(peer1.chan_manager_events._test_only_get_ptr());
301         assert peer1_events.length == 1;
302         bindings.LDKEvent sent = bindings.LDKEvent_ref_from_ptr(peer1_events[0]);
303         assert sent instanceof bindings.LDKEvent.PaymentSent;
304         assert Arrays.equals(((bindings.LDKEvent.PaymentSent) sent).payment_preimage, payment_preimage);
305         bindings.CVec_EventZ_free(peer1_events);
306
307         peer1.free();
308         peer2.free();
309         bindings.SocketDescriptor_free(descriptor2);
310         bindings.SocketDescriptor_free(descriptor1.val);
311     }
312
313     @Test
314     public void test_message_handler() throws InterruptedException {
315         do_test_message_handler();
316         while (!gc_ran) {
317             System.gc();
318             System.runFinalization();
319         }
320         for (WeakReference<Object> o : must_free_objs)
321             assert o.get() == null;
322     }
323 }