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