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