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