_ Git - ldk-java/blob - src/test/java/org/ldk/HumanObjectPeerTest.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.batteries.NioPeerHandler;
   7 import org.ldk.enums.LDKCurrency;
   8 import org.ldk.enums.LDKNetwork;
   9 import org.ldk.impl.bindings;
  10 import org.ldk.structs.*;
  11 import org.ldk.util.TwoTuple;
  12
  13 import java.io.IOException;
  14 import java.lang.ref.WeakReference;
  15 import java.net.InetSocketAddress;
  16 import java.util.*;
  17
  18 class HumanObjectPeerTestInstance {
  19     private final boolean nice_close;
  20     private final boolean use_km_wrapper;
  21     private final boolean use_manual_watch;
  22     private final boolean reload_peers;
  23     private final boolean break_cross_peer_refs;
  24     private final boolean use_nio_peer_handler;
  25     private final boolean use_filter;
  26
  27     HumanObjectPeerTestInstance(boolean nice_close, boolean use_km_wrapper, boolean use_manual_watch, boolean reload_peers, boolean break_cross_peer_refs, boolean use_nio_peer_handler, boolean use_filter) {
  28         this.nice_close = nice_close;
  29         this.use_km_wrapper = use_km_wrapper;
  30         this.use_manual_watch = use_manual_watch;
  31         this.reload_peers = reload_peers;
  32         this.break_cross_peer_refs = break_cross_peer_refs;
  33         this.use_nio_peer_handler = use_nio_peer_handler;
  34         this.use_filter = use_filter;
  35     }
  36
  37     class Peer {
  38         KeysInterface manual_keysif(KeysInterface underlying_if) {
  39             return KeysInterface.new_impl(new KeysInterface.KeysInterfaceInterface() {
  40                 @Override public byte[] get_node_secret() { return underlying_if.get_node_secret(); }
  41                 @Override public byte[] get_destination_script() { return underlying_if.get_destination_script(); }
  42                 @Override public byte[] get_shutdown_pubkey() { return underlying_if.get_shutdown_pubkey(); }
  43
  44                 @Override
  45                 public Sign get_channel_signer(boolean inbound, long channel_value_satoshis) {
  46                     Sign underlying_ck = underlying_if.get_channel_signer(inbound, channel_value_satoshis);
  47                     // TODO: Expose the underlying signer from a Sign
  48                     /*BaseSign.BaseSignInterface si = new BaseSign.BaseSignInterface() {
  49                         @Override
  50                         public byte[] get_per_commitment_point(long idx) {
  51                             return underlying_ck.get_per_commitment_point(idx);
  52                         }
  53
  54                         @Override
  55                         public byte[] release_commitment_secret(long idx) {
  56                             return underlying_ck.release_commitment_secret(idx);
  57                         }
  58
  59                         @Override
  60                         public byte[] channel_keys_id() {
  61                             return new byte[32];
  62                         }
  63
  64                         @Override
  65                         public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_counterparty_commitment(CommitmentTransaction commitment_tx) {
  66                             return underlying_ck.sign_counterparty_commitment(commitment_tx);
  67                         }
  68
  69                         @Override
  70                         public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_holder_commitment_and_htlcs(HolderCommitmentTransaction holder_commitment_tx) {
  71                             return underlying_ck.sign_holder_commitment_and_htlcs(holder_commitment_tx);
  72                         }
  73
  74                         @Override
  75                         public Result_SignatureNoneZ sign_justice_transaction(byte[] justice_tx, long input, long amount, byte[] per_commitment_key, HTLCOutputInCommitment htlc) {
  76                             return underlying_ck.sign_justice_transaction(justice_tx, input, amount, per_commitment_key, htlc);
  77                         }
  78
  79                         @Override
  80                         public Result_SignatureNoneZ sign_counterparty_htlc_transaction(byte[] htlc_tx, long input, long amount, byte[] per_commitment_point, HTLCOutputInCommitment htlc) {
  81                             return underlying_ck.sign_counterparty_htlc_transaction(htlc_tx, input, amount, per_commitment_point, htlc);
  82                         }
  83
  84                         @Override
  85                         public Result_SignatureNoneZ sign_closing_transaction(byte[] closing_tx) {
  86                             return underlying_ck.sign_closing_transaction(closing_tx);
  87                         }
  88
  89                         @Override
  90                         public Result_SignatureNoneZ sign_channel_announcement(UnsignedChannelAnnouncement msg) {
  91                             return underlying_ck.sign_channel_announcement(msg);
  92                         }
  93
  94                         @Override
  95                         public void ready_channel(ChannelTransactionParameters params) {
  96                             underlying_ck.ready_channel(params);
  97                         }
  98
  99                         @Override
 100                         public byte[] write() {
 101                             return underlying_ck.write();
 102                         }
 103                     };*/
 104                     //Sign resp = Sign.new_impl(si, underlying_ck.get_pubkeys());
 105                     //must_free_objs.add(new WeakReference<>(si));
 106                     //must_free_objs.add(new WeakReference<>(resp));
 107                     must_free_objs.add(new WeakReference<>(underlying_ck));
 108                     //return resp;
 109                     return underlying_ck;
 110                 }
 111
 112                 @Override
 113                 public byte[] get_secure_random_bytes() {
 114                     return underlying_if.get_secure_random_bytes();
 115                 }
 116
 117                 @Override
 118                 public Result_SignDecodeErrorZ read_chan_signer(byte[] reader) {
 119                     return underlying_if.read_chan_signer(reader);
 120                 }
 121
 122                 @Override
 123                 public Result_RecoverableSignatureNoneZ sign_invoice(byte[] invoice_preimage) {
 124                     return underlying_if.sign_invoice(invoice_preimage);
 125                 }
 126             });
 127         }
 128
 129         Watch get_manual_watch() {
 130             Watch.WatchInterface watch_impl = new Watch.WatchInterface() {
 131                 public Result_NoneChannelMonitorUpdateErrZ watch_channel(OutPoint funding_txo, ChannelMonitor monitor) {
 132                     synchronized (monitors) {
 133                         assert monitors.put(Arrays.toString(funding_txo.get_txid()), monitor) == null;
 134                     }
 135                     return Result_NoneChannelMonitorUpdateErrZ.constructor_ok();
 136                 }
 137
 138                 public Result_NoneChannelMonitorUpdateErrZ update_channel(OutPoint funding_txo, ChannelMonitorUpdate update) {
 139                     synchronized (monitors) {
 140                         String txid = Arrays.toString(funding_txo.get_txid());
 141                         assert monitors.containsKey(txid);
 142                         Result_NoneMonitorUpdateErrorZ update_res = monitors.get(txid).update_monitor(update, tx_broadcaster, fee_estimator, logger);
 143                         assert update_res instanceof Result_NoneMonitorUpdateErrorZ.Result_NoneMonitorUpdateErrorZ_OK;
 144                     }
 145                     return Result_NoneChannelMonitorUpdateErrZ.constructor_ok();
 146                 }
 147
 148                 @Override
 149                 public MonitorEvent[] release_pending_monitor_events() {
 150                     synchronized (monitors) {
 151                         assert monitors.size() <= 1;
 152                         for (ChannelMonitor mon : monitors.values()) {
 153                             return mon.get_and_clear_pending_monitor_events();
 154                         }
 155                     }
 156                     return new MonitorEvent[0];
 157                 }
 158             };
 159             Watch watch = Watch.new_impl(watch_impl);
 160             must_free_objs.add(new WeakReference<>(watch_impl));
 161             must_free_objs.add(new WeakReference<>(watch));
 162             return watch;
 163         }
 164
 165         NioPeerHandler nio_peer_handler;
 166         short nio_port;
 167         final byte seed;
 168         final Logger logger;
 169         final FeeEstimator fee_estimator;
 170         final BroadcasterInterface tx_broadcaster;
 171         final KeysManager explicit_keys_manager;
 172         final KeysInterface keys_interface;
 173         final ChainMonitor chain_monitor;
 174         final NetGraphMsgHandler router;
 175         final Watch chain_watch;
 176         final HashSet<String> filter_additions;
 177         final Filter filter;
 178         ChannelManager chan_manager;
 179         EventsProvider chan_manager_events;
 180         PeerManager peer_manager;
 181         final HashMap<String, ChannelMonitor> monitors; // Wow I forgot just how terrible Java is - we can't put a byte array here.
 182         byte[] node_id;
 183         final LinkedList<byte[]> broadcast_set = new LinkedList<>();
 184         GcCheck obj = new GcCheck();
 185
 186         private TwoTuple<OutPoint, byte[]> test_mon_roundtrip(ChannelMonitor mon) {
 187             // Because get_funding_txo() returns an OutPoint in a tuple that is a reference to an OutPoint inside the
 188             // ChannelMonitor, its a good test to ensure that the OutPoint isn't freed (or is cloned) before the
 189             // ChannelMonitor is. This used to be broken.
 190             Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ roundtrip_monitor = UtilMethods.constructor_BlockHashChannelMonitorZ_read(mon.write(), keys_interface);
 191             assert roundtrip_monitor instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
 192             TwoTuple<OutPoint, byte[]> funding_txo = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_monitor).res.b.get_funding_txo();
 193             System.gc(); System.runFinalization(); // Give the GC a chance to run.
 194             return funding_txo;
 195         }
 196
 197         private Peer(Object _dummy, byte seed) {
 198             logger = Logger.new_impl((String arg) -> System.out.println(seed + ": " + arg));
 199             fee_estimator = FeeEstimator.new_impl((confirmation_target -> 253));
 200             tx_broadcaster = BroadcasterInterface.new_impl(tx -> {
 201                 broadcast_set.add(tx);
 202             });
 203             monitors = new HashMap<>();
 204             this.seed = seed;
 205             Persist persister = Persist.new_impl(new Persist.PersistInterface() {
 206                 @Override
 207                 public Result_NoneChannelMonitorUpdateErrZ persist_new_channel(OutPoint id, ChannelMonitor data) {
 208                     synchronized (monitors) {
 209                         String key = Arrays.toString(id.to_channel_id());
 210                         assert monitors.put(key, data) == null;
 211                         TwoTuple<OutPoint, byte[]> res = test_mon_roundtrip(data);
 212                         assert Arrays.equals(res.a.get_txid(), id.get_txid());
 213                         assert res.a.get_index() == id.get_index();
 214                     }
 215                     return Result_NoneChannelMonitorUpdateErrZ.constructor_ok();
 216                 }
 217
 218                 @Override
 219                 public Result_NoneChannelMonitorUpdateErrZ update_persisted_channel(OutPoint id, ChannelMonitorUpdate update, ChannelMonitor data) {
 220                     synchronized (monitors) {
 221                         String key = Arrays.toString(id.to_channel_id());
 222                         assert monitors.put(key, data) != null;
 223                         TwoTuple<OutPoint, byte[]> res = test_mon_roundtrip(data);
 224                         assert Arrays.equals(res.a.get_txid(), id.get_txid());
 225                         assert res.a.get_index() == id.get_index();
 226                     }
 227                     return Result_NoneChannelMonitorUpdateErrZ.constructor_ok();
 228                 }
 229             });
 230
 231             filter_additions = new HashSet<>();
 232             if (use_filter) {
 233                 this.filter = Filter.new_impl(new Filter.FilterInterface() {
 234                     @Override public void register_tx(byte[] txid, byte[] script_pubkey) {
 235                         filter_additions.add(Arrays.toString(txid));
 236                     }
 237                     @Override public Option_C2Tuple_usizeTransactionZZ register_output(WatchedOutput output) {
 238                         filter_additions.add(Arrays.toString(output.get_outpoint().get_txid()) + ":" + output.get_outpoint().get_index());
 239                         return Option_C2Tuple_usizeTransactionZZ.constructor_none();
 240                     }
 241                 });
 242             } else {
 243                 this.filter = null;
 244             }
 245
 246             if (use_manual_watch) {
 247                 chain_watch = get_manual_watch();
 248                 chain_monitor = null;
 249             } else {
 250                 chain_monitor = ChainMonitor.constructor_new(filter, tx_broadcaster, logger, fee_estimator, persister);
 251                 chain_watch = chain_monitor.as_Watch();
 252             }
 253
 254             byte[] key_seed = new byte[32];
 255             for (byte i = 0; i < 32; i++) {
 256                 key_seed[i] = (byte) (i ^ seed);
 257             }
 258             KeysManager keys = KeysManager.constructor_new(key_seed, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000));
 259             if (use_km_wrapper) {
 260                 this.keys_interface = manual_keysif(keys.as_KeysInterface());
 261                 this.explicit_keys_manager = null;
 262             } else {
 263                 this.keys_interface = keys.as_KeysInterface();
 264                 this.explicit_keys_manager = keys;
 265             }
 266             this.router = NetGraphMsgHandler.constructor_new(new byte[32], null, logger);
 267         }
 268         private void bind_nio() {
 269             if (!use_nio_peer_handler) return;
 270             try { this.nio_peer_handler = new NioPeerHandler(peer_manager); } catch (IOException e) { assert false; }
 271             for (short i = 10_000; true; i++) {
 272                 try {
 273                     nio_peer_handler.bind_listener(new InetSocketAddress("127.0.0.1", i));
 274                     nio_port = i;
 275                     break;
 276                 } catch (IOException e) { assert i < 10_500; }
 277             }
 278         }
 279         Peer(byte seed) {
 280             this(null, seed);
 281             this.chan_manager = ChannelManager.constructor_new(FeeEstimator.new_impl(confirmation_target -> 0), chain_watch, tx_broadcaster, logger, this.keys_interface, UserConfig.constructor_default(), LDKNetwork.LDKNetwork_Bitcoin, BestBlock.constructor_new(new byte[32], 0));
 282             this.node_id = chan_manager.get_our_node_id();
 283             this.chan_manager_events = chan_manager.as_EventsProvider();
 284
 285             byte[] random_data = new byte[32];
 286             for (byte i = 0; i < 32; i++) {
 287                 random_data[i] = (byte) ((i ^ seed) ^ 0xf0);
 288             }
 289             this.peer_manager = PeerManager.constructor_new(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger);
 290             bind_nio();
 291             System.gc();
 292         }
 293         Object ptr_to;
 294         Peer(Peer orig) {
 295             this(null, orig.seed);
 296             // TODO: Optionally test ChannelManagerConstructor
 297             ChannelMonitor[] monitors = new ChannelMonitor[1];
 298             synchronized (monitors) {
 299                 assert orig.monitors.size() == 1;
 300                 if (!break_cross_peer_refs) {
 301                     monitors[0] = orig.monitors.values().stream().iterator().next();
 302                 } else {
 303                     byte[] serialized = orig.monitors.values().stream().iterator().next().write();
 304                     Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ res =
 305                             UtilMethods.constructor_BlockHashChannelMonitorZ_read(serialized, this.keys_interface);
 306                     assert res instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
 307                     monitors[0] = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) res).res.b;
 308                 }
 309             }
 310             byte[] serialized = orig.chan_manager.write();
 311             Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ read_res =
 312                     UtilMethods.constructor_BlockHashChannelManagerZ_read(serialized, this.keys_interface, this.fee_estimator, this.chain_watch, this.tx_broadcaster, this.logger, UserConfig.constructor_default(), monitors);
 313             assert read_res instanceof Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK;
 314             this.chan_manager = ((Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK) read_res).res.b;
 315             this.chain_watch.watch_channel(monitors[0].get_funding_txo().a, monitors[0]);
 316             if (!break_cross_peer_refs && (use_manual_watch || use_km_wrapper)) {
 317                 // When we pass monitors[0] into chain_watch.watch_channel we create a reference from the new Peer to a
 318                 // field in the old peer, preventing freeing of the original Peer until the new Peer is freed. Thus, we
 319                 // shouldn't bother waiting for the original to be freed later on.
 320                 cross_reload_ref_pollution = true;
 321             }
 322             this.node_id = chan_manager.get_our_node_id();
 323             this.chan_manager_events = chan_manager.as_EventsProvider();
 324
 325             if (cross_reload_ref_pollution) {
 326                 // This really, really needs to be handled at the bindings layer, but its rather complicated -
 327                 // ChannelSigners can be cloned and passed around without java being involved, resulting in them being
 328                 // owned by both one or more ChannelMonitors and a ChannelManager, with only one having proper pointers
 329                 // to the ChannelSigner. Ideally, the ChannelSigner would have a global reference to the Java
 330                 // implementation class, but that results in circular references. Instead, we need some ability to,
 331                 // while cloning ChannelSigners, add new references in the calling Java struct (ie ChannelMonitor) to
 332                 // the ChannelSigner.
 333                 this.ptr_to = orig.chan_manager;
 334             }
 335
 336             byte[] random_data = new byte[32];
 337             for (byte i = 0; i < 32; i++) {
 338                 random_data[i] = (byte) ((i ^ seed) ^ 0xf0);
 339             }
 340             this.peer_manager = PeerManager.constructor_new(chan_manager.as_ChannelMessageHandler(), router.as_RoutingMessageHandler(), keys_interface.get_node_secret(), random_data, logger);
 341             bind_nio();
 342         }
 343
 344         TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] connect_block(Block b, int height, long expected_monitor_update_len) {
 345             byte[] header = Arrays.copyOfRange(b.bitcoinSerialize(), 0, 80);
 346             TwoTuple<Long, byte[]>[] txn;
 347             if (b.hasTransactions()) {
 348                 assert b.getTransactions().size() == 1;
 349                 TwoTuple<Long, byte[]> txp = new TwoTuple<>((long) 0, b.getTransactions().get(0).bitcoinSerialize());
 350                 txn = new TwoTuple[]{txp};
 351             } else
 352                 txn = new TwoTuple[0];
 353             if (chain_monitor != null) {
 354                 chan_manager.as_Listen().block_connected(b.bitcoinSerialize(), height);
 355                 chain_monitor.as_Listen().block_connected(b.bitcoinSerialize(), height);
 356             } else {
 357                 chan_manager.as_Confirm().transactions_confirmed(header, txn, height);
 358                 chan_manager.as_Confirm().best_block_updated(header, height);
 359                 // Connect manually if we aren't using a ChainMonitor and are implementing Watch ourselves
 360                 synchronized (monitors) {
 361                     assert monitors.size() == 1;
 362                     for (ChannelMonitor mon : monitors.values()) {
 363                         TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] ret = mon.block_connected(header, txn, height, tx_broadcaster, fee_estimator, logger);
 364                         assert ret.length == expected_monitor_update_len;
 365                         return ret;
 366                     }
 367                 }
 368             }
 369             return null;
 370         }
 371
 372         Event[] get_monitor_events() {
 373             if (chain_monitor != null) {
 374                 return chain_monitor.as_EventsProvider().get_and_clear_pending_events();
 375             } else {
 376                 synchronized (monitors) {
 377                     assert monitors.size() == 1;
 378                     for (ChannelMonitor mon : monitors.values()) {
 379                         return mon.get_and_clear_pending_events();
 380                     }
 381                     return null;
 382                 }
 383             }
 384         }
 385
 386         Route get_route(byte[] dest_node, ChannelDetails[] our_chans) {
 387             try (LockedNetworkGraph netgraph = this.router.read_locked_graph()) {
 388                 NetworkGraph graph = netgraph.graph();
 389                 long res = bindings.get_route(this.node_id, graph._test_only_get_ptr(), dest_node, 0L, new long[]{our_chans[0]._test_only_get_ptr()},
 390                         new long[0], 1000000, 42, this.logger._test_only_get_ptr());
 391                 assert bindings.LDKCResult_RouteLightningErrorZ_result_ok(res);
 392                 byte[] serialized_route = bindings.Route_write(bindings.LDKCResult_RouteLightningErrorZ_get_ok(res));
 393                 must_free_objs.add(new WeakReference<>(serialized_route));
 394                 Result_RouteDecodeErrorZ copy = Route.constructor_read(serialized_route);
 395                 assert copy instanceof Result_RouteDecodeErrorZ.Result_RouteDecodeErrorZ_OK;
 396                 bindings.CResult_RouteLightningErrorZ_free(res);
 397                 return ((Result_RouteDecodeErrorZ.Result_RouteDecodeErrorZ_OK) copy).res;
 398             }
 399         }
 400     }
 401
 402     static class DescriptorHolder { SocketDescriptor val; }
 403
 404     boolean running = false;
 405     final LinkedList<Runnable> runqueue = new LinkedList();
 406     boolean ran = false;
 407     Thread t = new Thread(() -> {
 408             while (true) {
 409                 try {
 410                     Runnable r;
 411                     synchronized (runqueue) {
 412                         while (runqueue.isEmpty()) {
 413                             runqueue.wait();
 414                         }
 415                         running = true;
 416                         r = runqueue.pollFirst();
 417                     }
 418                     r.run();
 419                     synchronized (runqueue) {
 420                         running = false;
 421                         runqueue.notifyAll();
 422                     }
 423                 } catch (InterruptedException e) {
 424                     return;
 425                 }
 426             }
 427     });
 428     void wait_events_processed(Peer peer1, Peer peer2) {
 429         if (use_nio_peer_handler) {
 430             peer1.nio_peer_handler.check_events();
 431             peer2.nio_peer_handler.check_events();
 432             try { Thread.sleep(400); } catch (InterruptedException e) { assert false; }
 433         } else {
 434             synchronized (runqueue) {
 435                 ran = false;
 436             }
 437             while (true) {
 438                 peer1.peer_manager.process_events();
 439                 peer2.peer_manager.process_events();
 440                 synchronized (runqueue) {
 441                     if (runqueue.isEmpty() && !running) {
 442                         if (ran) {
 443                             ran = false;
 444                             continue;
 445                         } else { break; }
 446                     }
 447                     try { runqueue.wait(); } catch (InterruptedException e) { assert false; }
 448                 }
 449             }
 450         }
 451     }
 452     void do_read_event(PeerManager pm, SocketDescriptor descriptor, byte[] data) {
 453         if (!t.isAlive()) t.start();
 454         synchronized (runqueue) {
 455             ran = true;
 456             runqueue.add(() -> {
 457                 Result_boolPeerHandleErrorZ res = pm.read_event(descriptor, data);
 458                 assert res instanceof Result_boolPeerHandleErrorZ.Result_boolPeerHandleErrorZ_OK;
 459             });
 460             runqueue.notifyAll();
 461         }
 462         must_free_objs.add(new WeakReference<>(data));
 463     }
 464
 465     void connect_peers(final Peer peer1, final Peer peer2) {
 466         if (use_nio_peer_handler) {
 467             try {
 468                 peer1.nio_peer_handler.connect(peer2.chan_manager.get_our_node_id(), new InetSocketAddress("127.0.0.1", peer2.nio_port), 100);
 469             } catch (IOException e) { assert false; }
 470         } else {
 471             DescriptorHolder descriptor1 = new DescriptorHolder();
 472             DescriptorHolder descriptor1ref = descriptor1;
 473             SocketDescriptor descriptor2 = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
 474                 @Override
 475                 public long send_data(byte[] data, boolean resume_read) {
 476                     do_read_event(peer1.peer_manager, descriptor1ref.val, data);
 477                     return data.length;
 478                 }
 479
 480                 @Override public void disconnect_socket() { assert false; }
 481                 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 2; }
 482                 @Override public long hash() { return 2; }
 483             });
 484
 485             descriptor1.val = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
 486                 @Override
 487                 public long send_data(byte[] data, boolean resume_read) {
 488                     do_read_event(peer2.peer_manager, descriptor2, data);
 489                     return data.length;
 490                 }
 491
 492                 @Override public void disconnect_socket() { assert false; }
 493                 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 1; }
 494                 @Override public long hash() { return 1; }
 495             });
 496
 497             Result_CVec_u8ZPeerHandleErrorZ conn_res = peer1.peer_manager.new_outbound_connection(peer2.node_id, descriptor1.val);
 498             assert conn_res instanceof Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK;
 499
 500             Result_NonePeerHandleErrorZ inbound_conn_res = peer2.peer_manager.new_inbound_connection(descriptor2);
 501             assert inbound_conn_res instanceof Result_NonePeerHandleErrorZ.Result_NonePeerHandleErrorZ_OK;
 502             do_read_event(peer2.peer_manager, descriptor2, ((Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK) conn_res).res);
 503         }
 504     }
 505
 506     TestState do_test_message_handler() throws InterruptedException {
 507         Peer peer1 = new Peer((byte) 1);
 508         Peer peer2 = new Peer((byte) 2);
 509
 510         connect_peers(peer1, peer2);
 511         wait_events_processed(peer1, peer2);
 512
 513         Result_NoneAPIErrorZ cc_res = peer1.chan_manager.create_channel(peer2.node_id, 10000, 1000, 42, null);
 514         assert cc_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
 515         wait_events_processed(peer1, peer2);
 516
 517         Event[] events = peer1.chan_manager_events.get_and_clear_pending_events();
 518         assert events.length == 1;
 519         assert events[0] instanceof Event.FundingGenerationReady;
 520         assert ((Event.FundingGenerationReady) events[0]).channel_value_satoshis == 10000;
 521         assert ((Event.FundingGenerationReady) events[0]).user_channel_id == 42;
 522         byte[] funding_spk = ((Event.FundingGenerationReady) events[0]).output_script;
 523         assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
 524         byte[] chan_id = ((Event.FundingGenerationReady) events[0]).temporary_channel_id;
 525
 526         NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
 527
 528         Transaction funding = new Transaction(bitcoinj_net);
 529         funding.addInput(new TransactionInput(bitcoinj_net, funding, new byte[0]));
 530         funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
 531         funding.getInput(0).getWitness().setPush(0, new byte[]{0x1});
 532         funding.addOutput(Coin.SATOSHI.multiply(10000), new Script(funding_spk));
 533         Result_NoneAPIErrorZ funding_res = peer1.chan_manager.funding_transaction_generated(chan_id, funding.bitcoinSerialize());
 534         assert funding_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
 535         wait_events_processed(peer1, peer2);
 536
 537         assert peer1.broadcast_set.size() == 1;
 538         assert Arrays.equals(peer1.broadcast_set.get(0), funding.bitcoinSerialize());
 539         peer1.broadcast_set.clear();
 540
 541         Block b = new Block(bitcoinj_net, 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
 542         peer1.connect_block(b, 1, 0);
 543         peer2.connect_block(b, 1, 0);
 544
 545         for (int height = 2; height < 10; height++) {
 546             b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[0]));
 547             peer1.connect_block(b, height, 0);
 548             peer2.connect_block(b, height, 0);
 549         }
 550         wait_events_processed(peer1, peer2);
 551
 552         peer1.chan_manager.list_channels();
 553         ChannelDetails[] peer1_chans = peer1.chan_manager.list_usable_channels();
 554         ChannelDetails[] peer2_chans = peer2.chan_manager.list_usable_channels();
 555         assert peer1_chans.length == 1;
 556         assert peer2_chans.length == 1;
 557         assert peer1_chans[0].get_channel_value_satoshis() == 10000;
 558         assert peer1_chans[0].get_is_live();
 559         Option_u64Z short_chan_id = peer1_chans[0].get_short_channel_id();
 560         assert short_chan_id instanceof Option_u64Z.Some;
 561         assert ((Option_u64Z.Some)short_chan_id).some == (1L << 40); // 0th output in the 0th transaction in the 1st block
 562         assert Arrays.equals(peer1_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
 563         assert Arrays.equals(peer2_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
 564
 565         Result_InvoiceSignOrCreationErrorZ invoice = UtilMethods.constructor_invoice_from_channelmanager(peer2.chan_manager, peer2.keys_interface, LDKCurrency.LDKCurrency_Bitcoin, Option_u64Z.constructor_none(), "");
 566         assert invoice instanceof Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK;
 567         System.out.println("Got invoice: " + ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
 568         Result_InvoiceNoneZ parsed_invoice = Invoice.constructor_from_str(((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
 569         assert parsed_invoice instanceof Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK;
 570         assert Arrays.equals(((Result_InvoiceNoneZ.Result_InvoiceNoneZ_OK) parsed_invoice).res.payment_hash(), ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash());
 571         byte[] payment_hash = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash();
 572         byte[] payment_secret = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_secret();
 573
 574         Route route = peer1.get_route(peer2.node_id, peer1_chans);
 575         Result_NonePaymentSendFailureZ payment_res = peer1.chan_manager.send_payment(route, payment_hash, payment_secret);
 576         assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_OK;
 577         wait_events_processed(peer1, peer2);
 578
 579         RouteHop[][] hops = new RouteHop[1][1];
 580         byte[] hop_pubkey = new byte[33];
 581         hop_pubkey[0] = 3;
 582         hop_pubkey[1] = 42;
 583         hops[0][0] = RouteHop.constructor_new(hop_pubkey, NodeFeatures.constructor_known(), 42, ChannelFeatures.constructor_known(), 100, 0);
 584         Route r2 = Route.constructor_new(hops);
 585         payment_res = peer1.chan_manager.send_payment(r2, payment_hash, payment_secret);
 586         assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_Err;
 587
 588         assert peer1.get_monitor_events().length == 0;
 589         assert peer2.get_monitor_events().length == 0;
 590
 591         if (reload_peers) {
 592             if (use_nio_peer_handler) {
 593                 peer1.nio_peer_handler.interrupt();
 594                 peer2.nio_peer_handler.interrupt();
 595             }
 596             WeakReference<Peer> op1 = new WeakReference<Peer>(peer1);
 597             peer1 = new Peer(peer1);
 598             peer2 = new Peer(peer2);
 599             return new TestState(op1, peer1, peer2, b.getHash());
 600         }
 601         return new TestState(null, peer1, peer2, b.getHash());
 602     }
 603
 604     boolean cross_reload_ref_pollution = false;
 605     class TestState {
 606         private final WeakReference<Peer> ref_block;
 607         private final Peer peer1;
 608         private final Peer peer2;
 609         public Sha256Hash best_blockhash;
 610
 611         public TestState(WeakReference<Peer> ref_block, Peer peer1, Peer peer2, Sha256Hash best_blockhash) {
 612             this.ref_block = ref_block;
 613             this.peer1 = peer1;
 614             this.peer2 = peer2;
 615             this.best_blockhash = best_blockhash;
 616         }
 617     }
 618     void do_test_message_handler_b(TestState state) {
 619         GcCheck obj = new GcCheck();
 620         if (state.ref_block != null) {
 621             // Ensure the original peers get freed before we move on. Note that we have to be in a different function
 622             // scope to do so as the (at least current OpenJDK) JRE won't release anything created in the same scope.
 623             while (!cross_reload_ref_pollution && state.ref_block.get() != null) {
 624                 System.gc();
 625                 System.runFinalization();
 626             }
 627             connect_peers(state.peer1, state.peer2);
 628         }
 629         wait_events_processed(state.peer1, state.peer2);
 630
 631         Event[] events = state.peer2.chan_manager_events.get_and_clear_pending_events();
 632         assert events.length == 1;
 633         assert events[0] instanceof Event.PendingHTLCsForwardable;
 634         state.peer2.chan_manager.process_pending_htlc_forwards();
 635
 636         events = state.peer2.chan_manager_events.get_and_clear_pending_events();
 637         assert events.length == 1;
 638         assert events[0] instanceof Event.PaymentReceived;
 639         byte[] payment_preimage = ((Event.PaymentReceived)events[0]).payment_preimage;
 640         assert !Arrays.equals(payment_preimage, new byte[32]);
 641         state.peer2.chan_manager.claim_funds(payment_preimage);
 642         wait_events_processed(state.peer1, state.peer2);
 643
 644         events = state.peer1.chan_manager_events.get_and_clear_pending_events();
 645         assert events.length == 1;
 646         assert events[0] instanceof Event.PaymentSent;
 647         assert Arrays.equals(((Event.PaymentSent) events[0]).payment_preimage, payment_preimage);
 648         wait_events_processed(state.peer1, state.peer2);
 649
 650         ChannelDetails[] peer1_chans = state.peer1.chan_manager.list_channels();
 651
 652         if (nice_close) {
 653             Result_NoneAPIErrorZ close_res = state.peer1.chan_manager.close_channel(peer1_chans[0].get_channel_id());
 654             assert close_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
 655             wait_events_processed(state.peer1, state.peer2);
 656
 657             assert state.peer1.broadcast_set.size() == 1;
 658             assert state.peer2.broadcast_set.size() == 1;
 659         } else {
 660             state.peer1.chan_manager.force_close_all_channels();
 661             wait_events_processed(state.peer1, state.peer2);
 662
 663             assert state.peer1.broadcast_set.size() == 1;
 664             assert state.peer2.broadcast_set.size() == 1;
 665
 666             NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
 667             Transaction tx = new Transaction(bitcoinj_net, state.peer1.broadcast_set.getFirst());
 668             Block b = new Block(bitcoinj_net, 2, state.best_blockhash, Sha256Hash.ZERO_HASH, 42, 0, 0,
 669                     Arrays.asList(new Transaction[]{tx}));
 670             TwoTuple<byte[], TwoTuple<Integer, TxOut>[]>[] watch_outputs = state.peer2.connect_block(b, 10, 1);
 671             if (watch_outputs != null) { // We only process watch_outputs manually when we use a manually-build Watch impl
 672                 assert watch_outputs.length == 1;
 673                 assert Arrays.equals(watch_outputs[0].a, tx.getTxId().getReversedBytes());
 674                 assert watch_outputs[0].b.length == 2;
 675                 assert watch_outputs[0].b[0].a == 0;
 676                 assert watch_outputs[0].b[1].a == 1;
 677             }
 678
 679             for (int i = 11; i < 21; i++) {
 680                 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, new ArrayList<>());
 681                 state.peer2.connect_block(b, i, 0);
 682             }
 683
 684             Event[] broadcastable_event = null;
 685             if (state.peer2.chain_monitor != null) {
 686                 broadcastable_event = state.peer2.chain_monitor.as_EventsProvider().get_and_clear_pending_events();
 687             }
 688             // This used to be buggy and double-free, so go ahead and fetch them!
 689             for (ChannelMonitor mon : state.peer2.monitors.values()) {
 690                 byte[][] txn = mon.get_latest_holder_commitment_txn(state.peer2.logger);
 691                 if (state.peer2.chain_monitor == null) {
 692                     broadcastable_event = mon.get_and_clear_pending_events();
 693                 }
 694             }
 695             assert broadcastable_event.length == 1;
 696             assert broadcastable_event[0] instanceof Event.SpendableOutputs;
 697             if (state.peer2.explicit_keys_manager != null) {
 698                 Result_TransactionNoneZ tx_res = state.peer2.explicit_keys_manager.spend_spendable_outputs(((Event.SpendableOutputs) broadcastable_event[0]).outputs, new TxOut[0], new byte[] {0x00}, 253);
 699                 assert tx_res instanceof Result_TransactionNoneZ.Result_TransactionNoneZ_OK;
 700                 Transaction built_tx = new Transaction(bitcoinj_net, ((Result_TransactionNoneZ.Result_TransactionNoneZ_OK) tx_res).res);
 701                 assert built_tx.getOutputs().size() == 1;
 702                 assert Arrays.equals(built_tx.getOutput(0).getScriptBytes(), new byte[]{0x00});
 703             }
 704         }
 705
 706         if (use_nio_peer_handler) {
 707             state.peer1.peer_manager.disconnect_by_node_id(state.peer2.chan_manager.get_our_node_id(), false);
 708             wait_events_processed(state.peer1, state.peer2);
 709             assert state.peer1.peer_manager.get_peer_node_ids().length == 0;
 710             assert state.peer2.peer_manager.get_peer_node_ids().length == 0;
 711             state.peer1.nio_peer_handler.interrupt();
 712             state.peer2.nio_peer_handler.interrupt();
 713         }
 714
 715         assert state.peer1.get_monitor_events().length == 0;
 716         assert state.peer2.get_monitor_events().length == 0;
 717     }
 718
 719     java.util.LinkedList<WeakReference<Object>> must_free_objs = new java.util.LinkedList();
 720     int gc_count = 0;
 721     int gc_exp_count = 0;
 722     class GcCheck {
 723         GcCheck() { gc_exp_count += 1; }
 724         @Override
 725         protected void finalize() throws Throwable {
 726             gc_count += 1;
 727             super.finalize();
 728         }
 729     }
 730 }
 731 public class HumanObjectPeerTest {
 732     HumanObjectPeerTestInstance do_test_run(boolean nice_close, boolean use_km_wrapper, boolean use_manual_watch, boolean reload_peers, boolean break_cross_peer_refs, boolean nio_peer_handler) throws InterruptedException {
 733         HumanObjectPeerTestInstance instance = new HumanObjectPeerTestInstance(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_peer_refs, nio_peer_handler, !nio_peer_handler);
 734         HumanObjectPeerTestInstance.TestState state = instance.do_test_message_handler();
 735         instance.do_test_message_handler_b(state);
 736         return instance;
 737     }
 738     void do_test(boolean nice_close, boolean use_km_wrapper, boolean use_manual_watch, boolean reload_peers, boolean break_cross_peer_refs, boolean nio_peer_handler) throws InterruptedException {
 739         HumanObjectPeerTestInstance instance = do_test_run(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_peer_refs, nio_peer_handler);
 740         while (instance.gc_count != instance.gc_exp_count) {
 741             System.gc();
 742             System.runFinalization();
 743         }
 744         for (WeakReference<Object> o : instance.must_free_objs)
 745             assert o.get() == null;
 746     }
 747     @Test
 748     public void test_message_handler() throws InterruptedException {
 749         for (int i = 0; i < (1 << 6) - 1; i++) {
 750             boolean nice_close =       (i & (1 << 0)) != 0;
 751             boolean use_km_wrapper =   (i & (1 << 1)) != 0;
 752             boolean use_manual_watch = (i & (1 << 2)) != 0;
 753             boolean reload_peers =     (i & (1 << 3)) != 0;
 754             boolean break_cross_refs = (i & (1 << 4)) != 0;
 755             boolean nio_peer_handler = (i & (1 << 5)) != 0;
 756             if (break_cross_refs && !reload_peers) {
 757                 // There are no cross refs to break without reloading peers.
 758                 continue;
 759             }
 760             System.err.println("Running test with flags " + i);
 761             do_test(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_refs, nio_peer_handler);
 762         }
 763     }
 764 }