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;
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;
18 class HumanObjectPeerTestInstance {
20 KeysInterface manual_keysif(KeysInterface underlying_if) {
21 return KeysInterface.new_impl(new KeysInterface.KeysInterfaceInterface() {
23 public byte[] get_node_secret() {
24 return underlying_if.get_node_secret();
28 public byte[] get_destination_script() {
29 return underlying_if.get_destination_script();
33 public byte[] get_shutdown_pubkey() {
34 return underlying_if.get_shutdown_pubkey();
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() {
42 public byte[] get_per_commitment_point(long idx) {
43 return underlying_ck.get_per_commitment_point(idx);
47 public byte[] release_commitment_secret(long idx) {
48 return underlying_ck.release_commitment_secret(idx);
52 public TwoTuple<Long, Long> key_derivation_params() {
53 return new TwoTuple<Long, Long>((long)0, (long)1);
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);
62 public Result_SignatureNoneZ sign_holder_commitment(HolderCommitmentTransaction holder_commitment_tx) {
63 return underlying_ck.sign_holder_commitment(holder_commitment_tx);
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);
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);
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);
82 public Result_SignatureNoneZ sign_closing_transaction(byte[] closing_tx) {
83 return underlying_ck.sign_closing_transaction(closing_tx);
87 public Result_SignatureNoneZ sign_channel_announcement(UnsignedChannelAnnouncement msg) {
88 return underlying_ck.sign_channel_announcement(msg);
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);
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));
104 public byte[] get_secure_random_bytes() {
105 return underlying_if.get_secure_random_bytes();
110 Watch get_manual_watch() {
111 return Watch.new_impl(new Watch.WatchInterface() {
112 public Result_NoneChannelMonitorUpdateErrZ watch_channel(OutPoint funding_txo, ChannelMonitor monitor) {
113 synchronized (monitors) {
114 assert monitors.put(Arrays.toString(funding_txo.get_txid()), monitor) == null;
116 return new Result_NoneChannelMonitorUpdateErrZ.Result_NoneChannelMonitorUpdateErrZ_OK();
119 public Result_NoneChannelMonitorUpdateErrZ update_channel(OutPoint funding_txo, ChannelMonitorUpdate update) {
120 synchronized (monitors) {
121 String txid = Arrays.toString(funding_txo.get_txid());
122 assert monitors.containsKey(txid);
123 Result_NoneMonitorUpdateErrorZ update_res = monitors.get(txid).update_monitor(update, tx_broadcaster, logger);
124 assert update_res instanceof Result_NoneMonitorUpdateErrorZ.Result_NoneMonitorUpdateErrorZ_OK;
126 return new Result_NoneChannelMonitorUpdateErrZ.Result_NoneChannelMonitorUpdateErrZ_OK();
130 public MonitorEvent[] release_pending_monitor_events() {
131 synchronized (monitors) {
132 assert monitors.size() <= 1;
133 for (ChannelMonitor mon : monitors.values()) {
134 return mon.get_and_clear_pending_monitor_events();
137 return new MonitorEvent[0];
143 final FeeEstimator fee_estimator;
144 final BroadcasterInterface tx_broadcaster;
145 final KeysInterface keys_interface;
146 final ChainMonitor chain_monitor;
147 final ChannelManager chan_manager;
148 final EventsProvider chan_manager_events;
149 final NetGraphMsgHandler router;
150 final PeerManager peer_manager;
151 final HashMap<String, ChannelMonitor> monitors; // Wow I forgot just how terrible Java is - we can't put a byte array here.
153 final LinkedList<byte[]> broadcast_set = new LinkedList<>();
155 Peer(byte seed, boolean use_km_wrapper, boolean use_manual_watch) {
156 logger = Logger.new_impl((String arg) -> System.out.println(seed + ": " + arg));
157 fee_estimator = FeeEstimator.new_impl((confirmation_target -> 253));
158 tx_broadcaster = BroadcasterInterface.new_impl(tx -> {
159 broadcast_set.add(tx);
161 this.monitors = new HashMap<>();
163 if (use_manual_watch) {
164 chain_watch = get_manual_watch();
165 chain_monitor = null;
167 chain_monitor = ChainMonitor.constructor_new(null, tx_broadcaster, logger, fee_estimator);
168 chain_watch = chain_monitor.as_Watch();
171 byte[] key_seed = new byte[32];
172 for (byte i = 0; i < 32; i++) {
173 key_seed[i] = (byte) (i ^ seed);
175 if (use_km_wrapper) {
176 KeysManager underlying = KeysManager.constructor_new(key_seed, LDKNetwork.LDKNetwork_Bitcoin, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000) & 0xffffffff);
177 this.keys_interface = manual_keysif(underlying.as_KeysInterface());
179 KeysManager keys = KeysManager.constructor_new(key_seed, LDKNetwork.LDKNetwork_Bitcoin, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000) & 0xffffffff);
180 this.keys_interface = keys.as_KeysInterface();
182 this.chan_manager = ChannelManager.constructor_new(LDKNetwork.LDKNetwork_Bitcoin, FeeEstimator.new_impl(confirmation_target -> 0), chain_watch, tx_broadcaster, logger, this.keys_interface, UserConfig.constructor_default(), 1);
183 this.node_id = chan_manager.get_our_node_id();
184 this.chan_manager_events = chan_manager.as_EventsProvider();
185 this.router = NetGraphMsgHandler.constructor_new(null, logger);
187 byte[] random_data = new byte[32];
188 for (byte i = 0; i < 32; i++) {
189 random_data[i] = (byte) ((i ^ seed) ^ 0xf0);
191 this.peer_manager = PeerManager.constructor_new(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger);
195 TwoTuple<byte[], TxOut[]>[] connect_block(Block b, int height, long expected_monitor_update_len) {
196 byte[] header = Arrays.copyOfRange(b.bitcoinSerialize(), 0, 80);
197 TwoTuple<Long, byte[]>[] txn;
198 if (b.hasTransactions()) {
199 assert b.getTransactions().size() == 1;
200 TwoTuple<Long, byte[]> txp = new TwoTuple<>((long) 1, b.getTransactions().get(0).bitcoinSerialize());
201 txn = new TwoTuple[]{txp};
203 txn = new TwoTuple[0];
204 chan_manager.block_connected(header, txn, height);
205 if (chain_monitor != null) {
206 chain_monitor.block_connected(header, txn, height);
208 synchronized (monitors) {
209 assert monitors.size() == 1;
210 for (ChannelMonitor mon : monitors.values()) {
211 TwoTuple<byte[], TxOut[]>[] ret = mon.block_connected(header, txn, height, tx_broadcaster, fee_estimator, logger);
212 assert ret.length == expected_monitor_update_len;
220 Route get_route(byte[] dest_node, ChannelDetails[] our_chans) {
221 try (LockedNetworkGraph netgraph = this.router.read_locked_graph()) {
222 NetworkGraph graph = netgraph.graph();
223 long res = bindings.get_route(this.node_id, graph._test_only_get_ptr(), dest_node, new long[]{our_chans[0]._test_only_get_ptr()},
224 new long[0], 1000, 42, this.logger._test_only_get_ptr());
225 assert bindings.LDKCResult_RouteLightningErrorZ_result_ok(res);
226 byte[] serialized_route = bindings.Route_write(bindings.LDKCResult_RouteLightningErrorZ_get_ok(res));
227 must_free_objs.add(new WeakReference<>(serialized_route));
228 Route copy = Route.constructor_read(serialized_route);
229 bindings.CResult_RouteLightningErrorZ_free(res);
235 class DescriptorHolder { SocketDescriptor val; }
237 void do_read_event(ConcurrentLinkedQueue<Thread> list, PeerManager pm, SocketDescriptor descriptor, byte[] data) {
238 Thread thread = new Thread(() -> {
239 Result_boolPeerHandleErrorZ res = pm.read_event(descriptor, data);
240 assert res instanceof Result_boolPeerHandleErrorZ.Result_boolPeerHandleErrorZ_OK;
241 //assert ((Result_boolPeerHandleErrorZ.Result_boolPeerHandleErrorZ_OK) res).res;
245 must_free_objs.add(new WeakReference<>(data));
248 void do_test_message_handler(boolean nice_close, boolean use_km_wrapper, boolean use_manual_watch) throws InterruptedException {
249 GcCheck obj = new GcCheck();
250 Peer peer1 = new Peer((byte) 1, use_km_wrapper, use_manual_watch);
251 Peer peer2 = new Peer((byte) 2, use_km_wrapper, use_manual_watch);
253 ConcurrentLinkedQueue<Thread> list = new ConcurrentLinkedQueue<Thread>();
254 DescriptorHolder descriptor1 = new DescriptorHolder();
255 DescriptorHolder descriptor1ref = descriptor1;
256 SocketDescriptor descriptor2 = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
258 public long send_data(byte[] data, boolean resume_read) {
259 do_read_event(list, peer1.peer_manager, descriptor1ref.val, data);
263 @Override public void disconnect_socket() { assert false; }
264 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 2; }
265 @Override public long hash() { return 2; }
268 descriptor1.val = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
270 public long send_data(byte[] data, boolean resume_read) {
271 do_read_event(list, peer2.peer_manager, descriptor2, data);
275 @Override public void disconnect_socket() { assert false; }
276 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 1; }
277 @Override public long hash() { return 1; }
280 Result_CVec_u8ZPeerHandleErrorZ conn_res = peer1.peer_manager.new_outbound_connection(peer2.node_id, descriptor1.val);
281 assert conn_res instanceof Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK;
283 Result_NonePeerHandleErrorZ inbound_conn_res = peer2.peer_manager.new_inbound_connection(descriptor2);
284 assert inbound_conn_res instanceof Result_NonePeerHandleErrorZ.Result_NonePeerHandleErrorZ_OK;
285 do_read_event(list, peer2.peer_manager, descriptor2, ((Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK) conn_res).res);
287 while (!list.isEmpty()) { list.poll().join(); }
289 Result_NoneAPIErrorZ cc_res = peer1.chan_manager.create_channel(peer2.node_id, 10000, 1000, 42, null);
290 assert cc_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
292 peer1.peer_manager.process_events();
293 while (!list.isEmpty()) { list.poll().join(); }
294 peer2.peer_manager.process_events();
295 while (!list.isEmpty()) { list.poll().join(); }
297 Event[] events = peer1.chan_manager_events.get_and_clear_pending_events();
298 assert events.length == 1;
299 assert events[0] instanceof Event.FundingGenerationReady;
300 assert ((Event.FundingGenerationReady) events[0]).channel_value_satoshis == 10000;
301 assert ((Event.FundingGenerationReady) events[0]).user_channel_id == 42;
302 byte[] funding_spk = ((Event.FundingGenerationReady) events[0]).output_script;
303 assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
304 byte[] chan_id = ((Event.FundingGenerationReady) events[0]).temporary_channel_id;
306 NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
308 Transaction funding = new Transaction(bitcoinj_net);
309 funding.addInput(new TransactionInput(bitcoinj_net, funding, new byte[0]));
310 funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
311 funding.getInput(0).getWitness().setPush(0, new byte[]{0x1});
312 funding.addOutput(Coin.SATOSHI.multiply(10000), new Script(funding_spk));
313 peer1.chan_manager.funding_transaction_generated(chan_id, OutPoint.constructor_new(funding.getTxId().getReversedBytes(), (short) 0));
315 peer1.peer_manager.process_events();
316 while (!list.isEmpty()) { list.poll().join(); }
317 peer2.peer_manager.process_events();
318 while (!list.isEmpty()) { list.poll().join(); }
320 events = peer1.chan_manager_events.get_and_clear_pending_events();
321 assert events.length == 1;
322 assert events[0] instanceof Event.FundingBroadcastSafe;
323 assert ((Event.FundingBroadcastSafe) events[0]).user_channel_id == 42;
325 Block b = new Block(bitcoinj_net, 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
326 peer1.connect_block(b, 1, 0);
327 peer2.connect_block(b, 1, 0);
329 for (int height = 2; height < 10; height++) {
330 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[0]));
331 peer1.connect_block(b, height, 0);
332 peer2.connect_block(b, height, 0);
335 peer1.peer_manager.process_events();
336 peer2.peer_manager.process_events();
337 while (!list.isEmpty()) { list.poll().join(); }
339 peer1.chan_manager.list_channels();
340 ChannelDetails[] peer1_chans = peer1.chan_manager.list_channels();
341 ChannelDetails[] peer2_chans = peer2.chan_manager.list_channels();
342 assert peer1_chans.length == 1;
343 assert peer2_chans.length == 1;
344 assert peer1_chans[0].get_channel_value_satoshis() == 10000;
345 assert peer1_chans[0].get_is_live();
346 assert Arrays.equals(peer1_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
347 assert Arrays.equals(peer2_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
349 byte[] payment_preimage = new byte[32];
350 for (int i = 0; i < 32; i++) payment_preimage[i] = (byte) (i ^ 0x0f);
351 byte[] payment_hash = Sha256Hash.hash(payment_preimage);
352 Route route = peer1.get_route(peer2.node_id, peer1_chans);
353 Result_NonePaymentSendFailureZ payment_res = peer1.chan_manager.send_payment(route, payment_hash, new byte[32]);
354 assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_OK;
356 peer1.peer_manager.process_events();
357 while (!list.isEmpty()) { list.poll().join(); }
358 peer2.peer_manager.process_events();
359 while (!list.isEmpty()) { list.poll().join(); }
360 peer1.peer_manager.process_events();
361 while (!list.isEmpty()) { list.poll().join(); }
363 events = peer2.chan_manager_events.get_and_clear_pending_events();
364 assert events.length == 1;
365 assert events[0] instanceof Event.PendingHTLCsForwardable;
366 peer2.chan_manager.process_pending_htlc_forwards();
368 events = peer2.chan_manager_events.get_and_clear_pending_events();
369 assert events.length == 1;
370 assert events[0] instanceof Event.PaymentReceived;
371 peer2.chan_manager.claim_funds(payment_preimage, new byte[32], ((Event.PaymentReceived) events[0]).amt);
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(); }
380 events = peer1.chan_manager_events.get_and_clear_pending_events();
381 assert events.length == 1;
382 assert events[0] instanceof Event.PaymentSent;
383 assert Arrays.equals(((Event.PaymentSent) events[0]).payment_preimage, payment_preimage);
386 Result_NoneAPIErrorZ close_res = peer1.chan_manager.close_channel(peer1_chans[0].get_channel_id());
387 assert close_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
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 peer1.peer_manager.process_events();
394 while (!list.isEmpty()) { list.poll().join(); }
395 peer2.peer_manager.process_events();
396 while (!list.isEmpty()) { list.poll().join(); }
398 assert peer1.broadcast_set.size() == 1;
399 assert peer2.broadcast_set.size() == 1;
401 peer1.chan_manager.force_close_all_channels();
403 peer1.peer_manager.process_events();
404 while (!list.isEmpty()) { list.poll().join(); }
405 peer2.peer_manager.process_events();
406 while (!list.isEmpty()) { list.poll().join(); }
407 peer1.peer_manager.process_events();
408 while (!list.isEmpty()) { list.poll().join(); }
409 peer2.peer_manager.process_events();
410 while (!list.isEmpty()) { list.poll().join(); }
412 assert peer1.broadcast_set.size() == 1;
413 assert peer2.broadcast_set.size() == 0;
415 Transaction tx = new Transaction(bitcoinj_net, peer1.broadcast_set.getFirst());
416 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0,
417 Arrays.asList(new Transaction[]{tx}));
418 TwoTuple<byte[], TxOut[]>[] watch_outputs = peer2.connect_block(b, 1, 1);
419 if (watch_outputs != null) { // We only process watch_outputs manually when we use a manually-build Watch impl
420 assert watch_outputs.length == 1;
421 assert Arrays.equals(watch_outputs[0].a, tx.getTxId().getReversedBytes());
422 assert watch_outputs[0].b.length == 1;
427 java.util.LinkedList<WeakReference<Object>> must_free_objs = new java.util.LinkedList();
428 boolean gc_ran = false;
431 protected void finalize() throws Throwable {
437 public class HumanObjectPeerTest {
438 void do_test(boolean nice_close, boolean use_km_wrapper, boolean use_manual_watch) throws InterruptedException {
439 HumanObjectPeerTestInstance instance = new HumanObjectPeerTestInstance();
440 instance.do_test_message_handler(nice_close, use_km_wrapper, use_manual_watch);
441 while (!instance.gc_ran) {
443 System.runFinalization();
445 for (WeakReference<Object> o : instance.must_free_objs)
446 assert o.get() == null;
449 public void test_message_handler_force_close() throws InterruptedException {
450 do_test(false, false, false);
453 public void test_message_handler_nice_close() throws InterruptedException {
454 do_test(true, false, false);
457 public void test_message_handler_nice_close_wrapper() throws InterruptedException {
458 do_test(true, true, true);
461 public void test_message_handler_force_close_wrapper() throws InterruptedException {
462 do_test(false, true, true);