3 import org.bitcoinj.core.*;
4 import org.bitcoinj.script.Script;
5 import org.junit.jupiter.api.Test;
6 import org.ldk.batteries.ChannelManagerConstructor;
7 import org.ldk.batteries.NioPeerHandler;
8 import org.ldk.enums.*;
9 import org.ldk.enums.Currency;
10 import org.ldk.structs.*;
11 import org.ldk.util.UInt128;
12 import org.ldk.util.UInt5;
14 import java.io.IOException;
15 import java.lang.ref.WeakReference;
16 import java.net.InetSocketAddress;
18 import java.util.function.IntConsumer;
20 class HumanObjectPeerTestInstance {
21 private final boolean nice_close;
22 private final boolean use_km_wrapper;
23 private final boolean use_manual_watch;
24 private final boolean reload_peers;
25 private final boolean break_cross_peer_refs;
26 private final boolean use_nio_peer_handler;
27 private final boolean use_filter;
28 private final boolean use_ignore_handler;
29 private final boolean use_chan_manager_constructor;
30 private final boolean use_invoice_payer;
31 TxOut gossip_txout = null;
33 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, boolean use_ignore_handler, boolean use_chan_manager_constructor, boolean use_invoice_payer) {
34 this.nice_close = nice_close;
35 this.use_km_wrapper = use_km_wrapper;
36 this.use_manual_watch = use_manual_watch;
37 this.reload_peers = reload_peers;
38 this.break_cross_peer_refs = break_cross_peer_refs;
39 this.use_nio_peer_handler = use_nio_peer_handler;
40 this.use_filter = use_filter;
41 this.use_ignore_handler = use_ignore_handler;
42 this.use_chan_manager_constructor = use_chan_manager_constructor;
43 this.use_invoice_payer = use_invoice_payer;
47 NodeSigner manual_node_signer(KeysManager underlying_km) {
48 NodeSigner underlying_ns = underlying_km.as_NodeSigner();
49 must_free_objs.add(new WeakReference<>(underlying_ns));
50 return NodeSigner.new_impl(new NodeSigner.NodeSignerInterface() {
51 @Override public byte[] get_inbound_payment_key_material() { return underlying_ns.get_inbound_payment_key_material(); }
52 @Override public Result_PublicKeyNoneZ get_node_id(Recipient recipient) { return underlying_ns.get_node_id(recipient); }
53 @Override public Result_SharedSecretNoneZ ecdh(Recipient recipient, byte[] other_key, Option_ScalarZ tweak) {
54 return underlying_ns.ecdh(recipient, other_key, tweak);
56 @Override public Result_RecoverableSignatureNoneZ sign_invoice(byte[] hrp_bytes, UInt5[] invoice_data, Recipient recipient) {
57 return underlying_ns.sign_invoice(hrp_bytes, invoice_data, recipient);
59 @Override public Result_SignatureNoneZ sign_gossip_message(UnsignedGossipMessage msg) {
60 return underlying_ns.sign_gossip_message(msg);
64 SignerProvider manual_signer_provider(KeysManager underlying_km) {
65 SignerProvider underlying_sp = underlying_km.as_SignerProvider();
66 must_free_objs.add(new WeakReference<>(underlying_sp));
67 return SignerProvider.new_impl(new SignerProvider.SignerProviderInterface() {
68 @Override public byte[] get_destination_script() { return underlying_sp.get_destination_script(); }
69 @Override public ShutdownScript get_shutdown_scriptpubkey() { return underlying_sp.get_shutdown_scriptpubkey(); }
70 @Override public byte[] generate_channel_keys_id(boolean inbound, long channel_value_satoshis, UInt128 user_channel_id) {
71 return underlying_sp.generate_channel_keys_id(inbound, channel_value_satoshis, user_channel_id);
74 public WriteableEcdsaChannelSigner derive_channel_signer(long channel_value_satoshis, byte[] channel_keys_id) {
75 WriteableEcdsaChannelSigner underlying_wecs = underlying_sp.derive_channel_signer(channel_value_satoshis, channel_keys_id);
76 EcdsaChannelSigner underlying_ecs = underlying_wecs.get_ecdsa_channel_signer();
77 ChannelSigner underlying_cs = underlying_ecs.get_channel_signer();
78 ChannelSigner.ChannelSignerInterface csi = new ChannelSigner.ChannelSignerInterface() {
79 @Override public byte[] get_per_commitment_point(long idx) { return underlying_cs.get_per_commitment_point(idx); }
80 @Override public byte[] release_commitment_secret(long idx) { return underlying_cs.release_commitment_secret(idx); }
81 @Override public Result_NoneNoneZ validate_holder_commitment(HolderCommitmentTransaction holder_tx, byte[][] preimages) {
82 return underlying_cs.validate_holder_commitment(holder_tx, preimages);
84 @Override public byte[] channel_keys_id() { return underlying_cs.channel_keys_id(); }
85 @Override public void provide_channel_parameters(ChannelTransactionParameters channel_parameters) {
86 underlying_cs.provide_channel_parameters(channel_parameters);
89 EcdsaChannelSigner.EcdsaChannelSignerInterface ecsi = new EcdsaChannelSigner.EcdsaChannelSignerInterface() {
90 @Override public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_counterparty_commitment(CommitmentTransaction commitment_tx, byte[][] preimages) {
91 return underlying_ecs.sign_counterparty_commitment(commitment_tx, preimages);
93 @Override public Result_NoneNoneZ validate_counterparty_revocation(long idx, byte[] secret) {
94 return underlying_ecs.validate_counterparty_revocation(idx, secret);
96 @Override public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_holder_commitment_and_htlcs(HolderCommitmentTransaction commitment_tx) {
97 return underlying_ecs.sign_holder_commitment_and_htlcs(commitment_tx);
99 @Override public Result_SignatureNoneZ sign_justice_revoked_output(byte[] justice_tx, long input, long amount, byte[] per_commitment_key) {
100 return underlying_ecs.sign_justice_revoked_output(justice_tx, input, amount, per_commitment_key);
102 @Override public Result_SignatureNoneZ sign_justice_revoked_htlc(byte[] justice_tx, long input, long amount, byte[] per_commitment_key, HTLCOutputInCommitment htlc) {
103 return underlying_ecs.sign_justice_revoked_htlc(justice_tx, input, amount, per_commitment_key, htlc);
105 @Override public Result_SignatureNoneZ sign_counterparty_htlc_transaction(byte[] htlc_tx, long input, long amount, byte[] per_commitment_point, HTLCOutputInCommitment htlc) {
106 return underlying_ecs.sign_counterparty_htlc_transaction(htlc_tx, input, amount, per_commitment_point, htlc);
108 @Override public Result_SignatureNoneZ sign_closing_transaction(ClosingTransaction closing_tx) {
109 return underlying_ecs.sign_closing_transaction(closing_tx);
111 @Override public Result_SignatureNoneZ sign_holder_anchor_input(byte[] anchor_tx, long input) {
112 return underlying_ecs.sign_holder_anchor_input(anchor_tx, input);
114 @Override public Result_SignatureNoneZ sign_channel_announcement_with_funding_key(UnsignedChannelAnnouncement msg) {
115 return underlying_ecs.sign_channel_announcement_with_funding_key(msg);
118 WriteableEcdsaChannelSigner.WriteableEcdsaChannelSignerInterface wecsi = new WriteableEcdsaChannelSigner.WriteableEcdsaChannelSignerInterface() {
119 @Override public byte[] write() { return underlying_wecs.write(); }
121 WriteableEcdsaChannelSigner resp = WriteableEcdsaChannelSigner.new_impl(wecsi, ecsi, csi, underlying_cs.get_pubkeys());
122 must_free_objs.add(new WeakReference<>(wecsi));
123 must_free_objs.add(new WeakReference<>(ecsi));
124 must_free_objs.add(new WeakReference<>(csi));
125 must_free_objs.add(new WeakReference<>(resp));
126 must_free_objs.add(new WeakReference<>(underlying_wecs));
127 must_free_objs.add(new WeakReference<>(underlying_ecs));
128 must_free_objs.add(new WeakReference<>(underlying_cs));
133 public Result_WriteableEcdsaChannelSignerDecodeErrorZ read_chan_signer(byte[] reader) {
134 return underlying_sp.read_chan_signer(reader);
139 Watch get_manual_watch() {
140 Watch.WatchInterface watch_impl = new Watch.WatchInterface() {
141 public ChannelMonitorUpdateStatus watch_channel(OutPoint funding_txo, ChannelMonitor monitor) {
142 synchronized (monitors) {
143 assert monitors.put(Arrays.toString(funding_txo.get_txid()), monitor) == null;
145 return ChannelMonitorUpdateStatus.LDKChannelMonitorUpdateStatus_Completed;
148 public ChannelMonitorUpdateStatus update_channel(OutPoint funding_txo, ChannelMonitorUpdate update) {
149 synchronized (monitors) {
150 String txid = Arrays.toString(funding_txo.get_txid());
151 assert monitors.containsKey(txid);
152 Result_NoneNoneZ update_res = monitors.get(txid).update_monitor(update, tx_broadcaster, fee_estimator, logger);
153 assert update_res instanceof Result_NoneNoneZ.Result_NoneNoneZ_OK;
155 return ChannelMonitorUpdateStatus.LDKChannelMonitorUpdateStatus_Completed;
159 public ThreeTuple_OutPointCVec_MonitorEventZPublicKeyZ[] release_pending_monitor_events() {
160 synchronized (monitors) {
161 assert monitors.size() <= 1;
162 for (ChannelMonitor mon : monitors.values()) {
163 ThreeTuple_OutPointCVec_MonitorEventZPublicKeyZ[] res = new ThreeTuple_OutPointCVec_MonitorEventZPublicKeyZ[1];
164 res[0] = ThreeTuple_OutPointCVec_MonitorEventZPublicKeyZ.of(mon.get_funding_txo().get_a(), mon.get_and_clear_pending_monitor_events(), mon.get_counterparty_node_id());
168 return new ThreeTuple_OutPointCVec_MonitorEventZPublicKeyZ[0];
171 Watch watch = Watch.new_impl(watch_impl);
172 must_free_objs.add(new WeakReference<>(watch_impl));
173 must_free_objs.add(new WeakReference<>(watch));
177 UserConfig get_config() {
178 ChannelHandshakeConfig channel_config = ChannelHandshakeConfig.with_default();
179 channel_config.set_announced_channel(true);
180 UserConfig config = UserConfig.with_default();
181 config.set_channel_handshake_config(channel_config);
185 NioPeerHandler nio_peer_handler;
189 final FeeEstimator fee_estimator;
190 final BroadcasterInterface tx_broadcaster;
191 final KeysManager explicit_keys_manager;
192 final NodeSigner node_signer;
193 final SignerProvider signer_provider;
194 final EntropySource entropy_source;
195 final ChainMonitor chain_monitor;
196 NetworkGraph net_graph;
197 P2PGossipSync route_handler;
198 final Watch chain_watch;
199 final HashSet<String> filter_additions;
200 Option_FilterZ filter;
201 ChannelManager chan_manager;
202 PeerManager peer_manager;
203 final HashMap<String, ChannelMonitor> monitors; // Wow I forgot just how terrible Java is - we can't put a byte array here.
205 byte[] connected_peer_node_id = null;
206 final LinkedList<byte[]> broadcast_set = new LinkedList<>();
207 final LinkedList<Event> pending_manager_events = new LinkedList<>();
208 private final CustomMessageHandler custom_message_handler;
209 final LinkedList<byte[]> received_custom_messages = new LinkedList<>();
210 final LinkedList<byte[]> custom_messages_to_send = new LinkedList<>();
211 ChannelManagerConstructor constructor = null;
212 GcCheck obj = new GcCheck();
214 private ChannelMonitor test_mon_roundtrip(OutPoint expected_id, byte[] data) {
215 // Because get_funding_txo() returns an OutPoint in a tuple that is a reference to an OutPoint inside the
216 // ChannelMonitor, its a good test to ensure that the OutPoint isn't freed (or is cloned) before the
217 // ChannelMonitor is. This used to be broken.
218 Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ roundtrip_monitor = UtilMethods.C2Tuple_BlockHashChannelMonitorZ_read(data, this.entropy_source, this.signer_provider);
219 assert roundtrip_monitor instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
220 must_free_objs.add(new WeakReference<>(roundtrip_monitor));
221 TwoTuple_OutPointScriptZ funding_txo = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_monitor).res.get_b().get_funding_txo();
222 must_free_objs.add(new WeakReference<>(funding_txo));
223 System.gc(); System.runFinalization(); // Give the GC a chance to run.
224 assert Arrays.equals(funding_txo.get_a().get_txid(), expected_id.get_txid());
225 assert funding_txo.get_a().get_index() == expected_id.get_index();
226 Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ roundtrip_two = UtilMethods.C2Tuple_BlockHashChannelMonitorZ_read(data, this.entropy_source, this.signer_provider);
227 assert roundtrip_two instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
228 must_free_objs.add(new WeakReference<>(((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_two).res.get_b()));
229 must_free_objs.add(new WeakReference<>(((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_two).res));
230 must_free_objs.add(new WeakReference<>(roundtrip_two));
231 return ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_two).res.get_b();
234 private Peer(Object _dummy, byte seed) {
235 logger = Logger.new_impl((org.ldk.structs.Record arg)->{
236 if (arg.get_level() == Level.LDKLevel_Error)
237 System.err.println(seed + ": " + arg.get_module_path() + " - " + arg.get_args());
239 System.out.println(seed + ": " + arg.get_module_path() + " - " + arg.get_args());
241 fee_estimator = FeeEstimator.new_impl((confirmation_target -> 253));
242 tx_broadcaster = BroadcasterInterface.new_impl(tx -> {
243 synchronized (broadcast_set) {
244 broadcast_set.add(tx);
245 broadcast_set.notifyAll();
248 monitors = new HashMap<>();
250 Persist persister = Persist.new_impl(new Persist.PersistInterface() {
252 public ChannelMonitorUpdateStatus persist_new_channel(OutPoint id, ChannelMonitor data, MonitorUpdateId update_id) {
253 synchronized (monitors) {
254 String key = Arrays.toString(id.to_channel_id());
255 ChannelMonitor res = test_mon_roundtrip(id, data.write());
256 assert monitors.put(key, res) == null;
258 return ChannelMonitorUpdateStatus.LDKChannelMonitorUpdateStatus_Completed;
262 public ChannelMonitorUpdateStatus update_persisted_channel(OutPoint id, ChannelMonitorUpdate update, ChannelMonitor data, MonitorUpdateId update_id) {
263 synchronized (monitors) {
264 String key = Arrays.toString(id.to_channel_id());
265 ChannelMonitor res = test_mon_roundtrip(id, data.write());
266 // Note that we use a serialization-roundtrip copy of data here, not the original, as this can
267 // expose the JVM JIT bug where it finalize()s things still being called.
268 assert monitors.put(key, res) != null;
270 return ChannelMonitorUpdateStatus.LDKChannelMonitorUpdateStatus_Completed;
274 filter_additions = new HashSet<>();
276 this.filter = Option_FilterZ.some(Filter.new_impl(new Filter.FilterInterface() {
277 @Override public void register_tx(byte[] txid, byte[] script_pubkey) {
278 filter_additions.add(Arrays.toString(txid));
280 @Override public void register_output(WatchedOutput output) {
281 filter_additions.add(Arrays.toString(output.get_outpoint().get_txid()) + ":" + output.get_outpoint().get_index());
285 this.filter = Option_FilterZ.none();
288 if (use_manual_watch) {
289 chain_watch = get_manual_watch();
290 chain_monitor = null;
292 chain_monitor = ChainMonitor.of(filter, tx_broadcaster, logger, fee_estimator, persister);
293 chain_watch = chain_monitor.as_Watch();
296 byte[] key_seed = new byte[32];
297 for (byte i = 0; i < 32; i++) {
298 key_seed[i] = (byte) (i ^ seed);
300 KeysManager keys = KeysManager.of(key_seed, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000));
301 if (use_km_wrapper) {
302 this.signer_provider = manual_signer_provider(keys);
303 this.node_signer = manual_node_signer(keys);
304 this.entropy_source = EntropySource.new_impl(new EntropySource.EntropySourceInterface() {
305 @Override public byte[] get_secure_random_bytes() { return keys.as_EntropySource().get_secure_random_bytes(); }
307 this.explicit_keys_manager = null;
309 this.signer_provider = keys.as_SignerProvider();
310 this.entropy_source = keys.as_EntropySource();
311 this.node_signer = keys.as_NodeSigner();
312 this.explicit_keys_manager = keys;
315 this.custom_message_handler = CustomMessageHandler.new_impl(new CustomMessageHandler.CustomMessageHandlerInterface() {
317 public Result_NoneLightningErrorZ handle_custom_message(Type msg, byte[] sender_node_id) {
318 synchronized (received_custom_messages) {
319 received_custom_messages.add(msg.write());
320 received_custom_messages.notifyAll();
322 return Result_NoneLightningErrorZ.ok();
326 public TwoTuple_PublicKeyTypeZ[] get_and_clear_pending_msg() {
328 synchronized (custom_messages_to_send) {
329 bytes = custom_messages_to_send.toArray(new byte[0][0]);
330 custom_messages_to_send.clear();
332 TwoTuple_PublicKeyTypeZ[] ret = new TwoTuple_PublicKeyTypeZ[bytes.length];
333 for (int i = 0; i < bytes.length; i++) {
334 final int msg_idx = i;
335 ret[i] = TwoTuple_PublicKeyTypeZ.of(connected_peer_node_id, Type.new_impl(new Type.TypeInterface() {
336 @Override public short type_id() { return 4096; }
337 @Override public String debug_str() { return "Custom Java Message"; }
338 @Override public byte[] write() { return bytes[msg_idx]; }
343 }, (message_type, buffer) -> {
344 assert message_type == 4096;
345 return Result_COption_TypeZDecodeErrorZ.ok(Option_TypeZ.some(Type.new_impl(new Type.TypeInterface() {
346 @Override public short type_id() { return 4096; }
347 @Override public String debug_str() { return "Custom Java-Decoded Message"; }
348 @Override public byte[] write() { return buffer; }
352 private void bind_nio() {
353 if (!use_nio_peer_handler) return;
354 if (use_chan_manager_constructor) {
355 this.nio_peer_handler = this.constructor.nio_peer_handler;
357 try { this.nio_peer_handler = new NioPeerHandler(peer_manager); } catch (IOException e) { assert false; }
359 for (short i = 10_000; true; i++) {
361 nio_peer_handler.bind_listener(new InetSocketAddress("127.0.0.1", i));
364 } catch (IOException e) { assert i < 10_500; }
367 private void setup_route_handler() {
368 this.route_handler = P2PGossipSync.of(this.net_graph,
369 Option_UtxoLookupZ.some(UtxoLookup.new_impl((genesis_hash, short_channel_id) -> UtxoResult.sync(Result_TxOutUtxoLookupErrorZ.ok(gossip_txout)))), this.logger);
373 this.net_graph = NetworkGraph.of(Network.LDKNetwork_Bitcoin, this.logger);
374 this.setup_route_handler();
376 if (use_chan_manager_constructor) {
377 this.constructor = new ChannelManagerConstructor(Network.LDKNetwork_Bitcoin, get_config(), new byte[32], 0,
378 this.explicit_keys_manager, this.fee_estimator, this.chain_monitor, this.net_graph,
379 ProbabilisticScoringParameters.with_default(), this.tx_broadcaster, this.logger);
380 constructor.chain_sync_completed(new ChannelManagerConstructor.EventHandler() {
381 @Override public void handle_event(Event event) {
382 synchronized (pending_manager_events) {
383 pending_manager_events.add(event);
384 pending_manager_events.notifyAll();
387 @Override public void persist_manager(byte[] channel_manager_bytes) { assert channel_manager_bytes.length > 1; }
388 @Override public void persist_network_graph(byte[] graph_bytes) { assert graph_bytes.length > 1; }
389 @Override public void persist_scorer(byte[] scorer_bytes) { assert scorer_bytes.length > 1; }
390 }, !use_ignore_handler);
391 this.chan_manager = constructor.channel_manager;
392 this.peer_manager = constructor.peer_manager;
393 must_free_objs.add(new WeakReference<>(this.chan_manager));
395 Router router = Router.new_impl(new Router.RouterInterface() {
397 public Result_RouteLightningErrorZ find_route_with_id(byte[] payer, RouteParameters route_params, ChannelDetails[] first_hops, InFlightHtlcs inflight_htlcs, byte[] _payment_hash, byte[] _payment_id) {
398 return find_route(payer, route_params, first_hops, inflight_htlcs);
402 public Result_RouteLightningErrorZ find_route(byte[] payer, RouteParameters params, ChannelDetails[] first_hops, InFlightHtlcs inflight_htlcs) {
404 try (ReadOnlyNetworkGraph graph = net_graph.read_only()) {
405 assert graph.channel(424242) == null;
406 long[] channels = graph.list_channels();
407 if (channels.length != 1) {
408 // If we're using a NioPeerHandler, the handling of announcement signatures and
409 // channel broadcasting may be done async, so just wait until the channel shows up.
410 assert use_nio_peer_handler;
413 ChannelInfo chan = graph.channel(channels[0]);
414 assert Arrays.equals(chan.get_node_one().as_slice(), chan.get_node_one().write());
415 assert Arrays.equals(chan.get_node_one().as_slice(), chan_manager.get_our_node_id()) ||
416 Arrays.equals(chan.get_node_two().as_slice(), chan_manager.get_our_node_id());
420 return UtilMethods.find_route(payer, params, net_graph, first_hops, logger, Score.new_impl(new Score.ScoreInterface() {
421 @Override public void payment_path_failed(RouteHop[] path, long scid) {}
422 @Override public long channel_penalty_msat(long short_channel_id, NodeId source, NodeId target, ChannelUsage usage) { return 0; }
423 @Override public void payment_path_successful(RouteHop[] path) {}
424 @Override public void probe_failed(RouteHop[] path, long short_channel_id) { assert false; }
425 @Override public void probe_successful(RouteHop[] path) { assert false; }
426 @Override public byte[] write() { assert false; return null; }
430 ChainParameters params = ChainParameters.of(Network.LDKNetwork_Bitcoin, BestBlock.of(new byte[32], 0));
431 this.chan_manager = ChannelManager.of(this.fee_estimator, chain_watch, tx_broadcaster, router, logger,
432 this.entropy_source, this.node_signer, this.signer_provider, get_config(), params);
433 this.peer_manager = PeerManager.of(chan_manager.as_ChannelMessageHandler(), route_handler.as_RoutingMessageHandler(),
434 IgnoringMessageHandler.of().as_OnionMessageHandler(), 0xdeadbeef,
435 this.entropy_source.get_secure_random_bytes(), logger, this.custom_message_handler, this.node_signer);
438 this.node_id = chan_manager.get_our_node_id();
446 this(null, orig.seed);
447 if (use_chan_manager_constructor) {
448 byte[][] monitors = {orig.monitors.values().stream().iterator().next().write()};
449 byte[] serialized = orig.chan_manager.write();
450 byte[] serialized_graph = orig.net_graph.write();
451 byte[] serialized_scorer = orig.constructor.scorer.write();
453 Filter filter_nullable = null;
454 if (this.filter instanceof Option_FilterZ.Some) {
455 filter_nullable = ((Option_FilterZ.Some) this.filter).some;
457 this.constructor = new ChannelManagerConstructor(serialized, monitors, get_config(),
458 this.explicit_keys_manager, this.fee_estimator, this.chain_monitor, filter_nullable,
459 serialized_graph, ProbabilisticScoringParameters.with_default(), serialized_scorer,
460 this.tx_broadcaster, this.logger);
462 // Test that ChannelManagerConstructor correctly rejects duplicate ChannelMonitors
463 byte[][] monitors_dupd = new byte[2][];
464 monitors_dupd[0] = monitors[0];
465 monitors_dupd[1] = monitors[0];
466 ChannelManagerConstructor constr = new ChannelManagerConstructor(serialized, monitors_dupd, get_config(),
467 this.explicit_keys_manager, this.fee_estimator, this.chain_monitor, filter_nullable,
468 serialized_graph, ProbabilisticScoringParameters.with_default(), serialized_scorer,
469 this.tx_broadcaster, this.logger);
471 } catch (ChannelManagerConstructor.InvalidSerializedDataException e) {}
472 this.net_graph = this.constructor.net_graph;
473 setup_route_handler();
474 constructor.chain_sync_completed(new ChannelManagerConstructor.EventHandler() {
475 @Override public void handle_event(Event event) {
476 synchronized (pending_manager_events) {
477 pending_manager_events.add(event);
478 pending_manager_events.notifyAll();
481 @Override public void persist_manager(byte[] channel_manager_bytes) { assert channel_manager_bytes.length > 1; }
482 @Override public void persist_network_graph(byte[] graph_bytes) { assert graph_bytes.length > 1; }
483 @Override public void persist_scorer(byte[] scorer_bytes) { assert scorer_bytes.length > 1; }
484 }, !use_ignore_handler);
485 this.chan_manager = constructor.channel_manager;
486 this.peer_manager = constructor.peer_manager;
487 must_free_objs.add(new WeakReference<>(this.chan_manager));
488 // If we are using a ChannelManagerConstructor, we may have pending events waiting on the old peer
489 // which have been removed from the ChannelManager but which we still need to handle.
490 this.pending_manager_events.addAll(orig.pending_manager_events);
491 if (!this.pending_manager_events.isEmpty()) {
492 // However, this implies cross_reload_ref_pollution
493 cross_reload_ref_pollution = true;
495 } catch (ChannelManagerConstructor.InvalidSerializedDataException e) {
499 this.net_graph = NetworkGraph.of(Network.LDKNetwork_Bitcoin, this.logger);
500 Router router = Router.new_impl(new Router.RouterInterface() {
502 public Result_RouteLightningErrorZ find_route_with_id(byte[] payer, RouteParameters route_params, ChannelDetails[] first_hops, InFlightHtlcs inflight_htlcs, byte[] _payment_hash, byte[] _payment_id) {
503 return find_route(payer, route_params, first_hops, inflight_htlcs);
507 public Result_RouteLightningErrorZ find_route(byte[] payer, RouteParameters params, ChannelDetails[] first_hops, InFlightHtlcs inflight_htlcs) {
509 try (ReadOnlyNetworkGraph graph = net_graph.read_only()) {
510 assert graph.channel(424242) == null;
511 long[] channels = graph.list_channels();
512 if (channels.length != 1) {
513 // If we're using a NioPeerHandler, the handling of announcement signatures and
514 // channel broadcasting may be done async, so just wait until the channel shows up.
515 assert use_nio_peer_handler;
518 ChannelInfo chan = graph.channel(channels[0]);
519 assert Arrays.equals(chan.get_node_one().as_slice(), chan.get_node_one().write());
520 assert Arrays.equals(chan.get_node_one().as_slice(), chan_manager.get_our_node_id()) ||
521 Arrays.equals(chan.get_node_two().as_slice(), chan_manager.get_our_node_id());
525 return UtilMethods.find_route(payer, params, net_graph, first_hops, logger, Score.new_impl(new Score.ScoreInterface() {
526 @Override public void payment_path_failed(RouteHop[] path, long scid) {}
527 @Override public long channel_penalty_msat(long short_channel_id, NodeId source, NodeId target, ChannelUsage usage) { return 0; }
528 @Override public void payment_path_successful(RouteHop[] path) {}
529 @Override public void probe_failed(RouteHop[] path, long short_channel_id) { assert false; }
530 @Override public void probe_successful(RouteHop[] path) { assert false; }
531 @Override public byte[] write() { assert false; return null; }
535 this.setup_route_handler();
536 ChannelMonitor[] monitors = new ChannelMonitor[1];
537 assert orig.monitors.size() == 1;
538 if (!break_cross_peer_refs) {
539 monitors[0] = orig.monitors.values().stream().iterator().next();
541 byte[] serialized = orig.monitors.values().stream().iterator().next().write();
542 Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ res =
543 UtilMethods.C2Tuple_BlockHashChannelMonitorZ_read(serialized, this.entropy_source, this.signer_provider);
544 assert res instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
545 monitors[0] = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) res).res.get_b();
547 byte[] serialized = orig.chan_manager.write();
548 Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ read_res =
549 UtilMethods.C2Tuple_BlockHashChannelManagerZ_read(serialized, this.entropy_source, this.node_signer, this.signer_provider, this.fee_estimator, this.chain_watch, this.tx_broadcaster, router, this.logger, get_config(), monitors);
550 assert read_res instanceof Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK;
551 this.chan_manager = ((Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK) read_res).res.get_b();
552 this.chain_watch.watch_channel(monitors[0].get_funding_txo().get_a(), monitors[0]);
553 this.peer_manager = PeerManager.of(chan_manager.as_ChannelMessageHandler(), route_handler.as_RoutingMessageHandler(),
554 IgnoringMessageHandler.of().as_OnionMessageHandler(), (int)(System.currentTimeMillis() / 1000),
555 this.entropy_source.get_secure_random_bytes(), logger, this.custom_message_handler, this.node_signer);
556 if (!break_cross_peer_refs && (use_manual_watch || use_km_wrapper)) {
557 // When we pass monitors[0] into chain_watch.watch_channel we create a reference from the new Peer to a
558 // field in the old peer, preventing freeing of the original Peer until the new Peer is freed. Thus, we
559 // shouldn't bother waiting for the original to be freed later on.
560 cross_reload_ref_pollution = true;
563 this.node_id = chan_manager.get_our_node_id();
566 if (cross_reload_ref_pollution) {
567 // This really, really needs to be handled at the bindings layer, but its rather complicated -
568 // ChannelSigners can be cloned and passed around without java being involved, resulting in them being
569 // owned by both one or more ChannelMonitors and a ChannelManager, with only one having proper pointers
570 // to the ChannelSigner. Ideally, the ChannelSigner would have a global reference to the Java
571 // implementation class, but that results in circular references. Instead, we need some ability to,
572 // while cloning ChannelSigners, add new references in the calling Java struct (ie ChannelMonitor) to
573 // the ChannelSigner.
574 this.ptr_to = orig.chan_manager;
579 TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ[] connect_block(Block b, int height, long expected_monitor_update_len) {
580 byte[] header = Arrays.copyOfRange(b.bitcoinSerialize(), 0, 80);
581 TwoTuple_usizeTransactionZ[] txn;
582 if (b.hasTransactions()) {
583 assert b.getTransactions().size() == 1;
584 TwoTuple_usizeTransactionZ txp = TwoTuple_usizeTransactionZ.of((long) 0, b.getTransactions().get(0).bitcoinSerialize());
585 txn = new TwoTuple_usizeTransactionZ[]{txp};
587 txn = new TwoTuple_usizeTransactionZ[0];
588 if (chain_monitor != null) {
589 chan_manager.as_Listen().block_connected(b.bitcoinSerialize(), height);
590 chain_monitor.as_Listen().block_connected(b.bitcoinSerialize(), height);
592 chan_manager.as_Confirm().transactions_confirmed(header, txn, height);
593 chan_manager.as_Confirm().best_block_updated(header, height);
594 // Connect manually if we aren't using a ChainMonitor and are implementing Watch ourselves
595 synchronized (monitors) {
596 assert monitors.size() == 1;
597 for (ChannelMonitor mon : monitors.values()) {
598 TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ[] ret = mon.block_connected(header, txn, height, tx_broadcaster, fee_estimator, logger);
599 assert ret.length == expected_monitor_update_len;
607 Event[] get_monitor_events(int expected_len) {
608 if (use_chan_manager_constructor) {
610 synchronized (this.pending_manager_events) {
611 if (expected_len != 0 && this.pending_manager_events.size() == expected_len) {
615 if (expected_len == 0) {
616 try { Thread.sleep(500); } catch (InterruptedException e) { assert false; }
622 synchronized (this.pending_manager_events) {
623 Event[] res = this.pending_manager_events.toArray(new Event[0]);
624 this.pending_manager_events.clear();
625 assert res.length == expected_len;
628 } else if (chain_monitor != null) {
629 ArrayList<Event> l = new ArrayList<Event>();
630 chain_monitor.as_EventsProvider().process_pending_events(EventHandler.new_impl(l::add));
631 assert l.size() == expected_len;
632 return l.toArray(new Event[0]);
634 synchronized (monitors) {
635 assert monitors.size() == 1;
636 for (ChannelMonitor mon : monitors.values()) {
637 Event[] res = mon.get_and_clear_pending_events();
638 assert res.length == expected_len;
646 Event[] get_manager_events(int expected_len, Peer peer1, Peer peer2) {
647 assert expected_len != 0;
648 if (!use_nio_peer_handler) {
649 maybe_exchange_peer_messages(peer1, peer2);
651 Event[] res = new Event[0];
652 if (use_chan_manager_constructor) {
653 while (res.length < expected_len) {
654 synchronized (this.pending_manager_events) {
655 if (this.pending_manager_events.size() >= expected_len) {
656 res = this.pending_manager_events.toArray(res);
657 assert res.length == expected_len;
658 this.pending_manager_events.clear();
660 if (res.length < expected_len) {
661 try { this.pending_manager_events.wait(); } catch (InterruptedException e) { assert false; }
666 ArrayList<Event> l = new ArrayList<Event>();
667 while (l.size() < expected_len) {
669 if (use_nio_peer_handler) {
670 peer1.nio_peer_handler.check_events();
671 peer2.nio_peer_handler.check_events();
673 chan_manager.as_EventsProvider().process_pending_events(EventHandler.new_impl(l::add));
675 return l.toArray(new Event[0]);
677 assert res.length == expected_len;
682 static class DescriptorHolder { SocketDescriptor val; }
684 boolean running = false;
685 final LinkedList<Runnable> runqueue = new LinkedList();
687 Thread t = new Thread(() -> {
691 synchronized (runqueue) {
692 while (runqueue.isEmpty()) {
696 r = runqueue.pollFirst();
699 synchronized (runqueue) {
701 runqueue.notifyAll();
703 } catch (InterruptedException e) {
709 void maybe_exchange_peer_messages(Peer peer1, Peer peer2) {
710 if (!use_nio_peer_handler) {
712 peer1.peer_manager.process_events();
713 peer2.peer_manager.process_events();
714 synchronized (runqueue) {
715 if (runqueue.isEmpty() && !running) {
721 try { runqueue.wait(); } catch (InterruptedException e) { assert false; }
724 } else if (!use_chan_manager_constructor) {
725 peer1.nio_peer_handler.check_events();
726 peer2.nio_peer_handler.check_events();
729 void do_read_event(PeerManager pm, SocketDescriptor descriptor, byte[] data) {
730 if (!t.isAlive()) t.start();
731 synchronized (runqueue) {
734 Result_boolPeerHandleErrorZ res = pm.read_event(descriptor, data);
735 assert res instanceof Result_boolPeerHandleErrorZ.Result_boolPeerHandleErrorZ_OK;
737 runqueue.notifyAll();
739 must_free_objs.add(new WeakReference<>(data));
742 void connect_peers(final Peer peer1, final Peer peer2) {
743 peer2.connected_peer_node_id = peer1.node_id;
744 peer1.connected_peer_node_id = peer2.node_id;
745 if (use_nio_peer_handler) {
747 peer1.nio_peer_handler.connect(peer2.chan_manager.get_our_node_id(), new InetSocketAddress("127.0.0.1", peer2.nio_port), 100);
748 } catch (IOException e) { assert false; }
749 while (peer1.peer_manager.get_peer_node_ids().length == 0 || peer2.peer_manager.get_peer_node_ids().length == 0) {
753 DescriptorHolder descriptor1 = new DescriptorHolder();
754 DescriptorHolder descriptor1ref = descriptor1;
755 SocketDescriptor descriptor2 = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
757 public long send_data(byte[] data, boolean resume_read) {
758 do_read_event(peer1.peer_manager, descriptor1ref.val, data);
762 @Override public void disconnect_socket() { assert false; }
763 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 2; }
764 @Override public long hash() { return 2; }
767 descriptor1.val = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
769 public long send_data(byte[] data, boolean resume_read) {
770 do_read_event(peer2.peer_manager, descriptor2, data);
774 @Override public void disconnect_socket() { assert false; }
775 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 1; }
776 @Override public long hash() { return 1; }
779 Result_CVec_u8ZPeerHandleErrorZ conn_res = peer1.peer_manager.new_outbound_connection(peer2.node_id, descriptor1.val, Option_NetAddressZ.none());
780 assert conn_res instanceof Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK;
782 Result_NonePeerHandleErrorZ inbound_conn_res = peer2.peer_manager.new_inbound_connection(descriptor2, Option_NetAddressZ.none());
783 assert inbound_conn_res instanceof Result_NonePeerHandleErrorZ.Result_NonePeerHandleErrorZ_OK;
784 do_read_event(peer2.peer_manager, descriptor2, ((Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK) conn_res).res);
786 maybe_exchange_peer_messages(peer1, peer2);
790 TestState do_test_message_handler() throws InterruptedException {
791 Peer peer1 = new Peer((byte) 1);
792 Peer peer2 = new Peer((byte) 2);
794 connect_peers(peer1, peer2);
796 UInt128 user_id = new UInt128(new byte[] {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16});
798 Result__u832APIErrorZ cc_res = peer1.chan_manager.create_channel(peer2.node_id, 100000, 1000, user_id, null);
799 assert cc_res instanceof Result__u832APIErrorZ.Result__u832APIErrorZ_OK;
801 // Previously, this was a SEGFAULT instead of get_funding_txo() returning null.
802 ChannelDetails pre_funding_chan = peer1.chan_manager.list_channels()[0];
803 assert pre_funding_chan.get_funding_txo() == null;
805 Event[] events = peer1.get_manager_events(1, peer1, peer2);
806 assert events[0] instanceof Event.FundingGenerationReady;
807 assert ((Event.FundingGenerationReady) events[0]).channel_value_satoshis == 100000;
808 assert ((Event.FundingGenerationReady) events[0]).user_channel_id.equals(user_id);
809 byte[] funding_spk = ((Event.FundingGenerationReady) events[0]).output_script;
810 assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
811 byte[] chan_id = ((Event.FundingGenerationReady) events[0]).temporary_channel_id;
813 NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
815 Transaction funding = new Transaction(bitcoinj_net);
816 funding.addInput(new TransactionInput(bitcoinj_net, funding, new byte[0]));
817 funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
818 funding.getInput(0).getWitness().setPush(0, new byte[]{0x1});
819 funding.addOutput(Coin.SATOSHI.multiply(100000), new Script(funding_spk));
820 Result_NoneAPIErrorZ funding_res = peer1.chan_manager.funding_transaction_generated(chan_id, peer2.node_id, funding.bitcoinSerialize());
821 assert funding_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
823 gossip_txout = new TxOut(100000, funding_spk);
825 maybe_exchange_peer_messages(peer1, peer2);
826 synchronized (peer1.broadcast_set) {
827 while (peer1.broadcast_set.size() != 1) {
828 peer1.broadcast_set.wait();
832 assert peer1.broadcast_set.size() == 1;
833 assert Arrays.equals(peer1.broadcast_set.get(0), funding.bitcoinSerialize());
834 peer1.broadcast_set.clear();
836 Block b = new Block(bitcoinj_net, 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
837 peer1.connect_block(b, 1, 0);
838 peer2.connect_block(b, 1, 0);
840 for (int height = 2; height < 10; height++) {
841 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[0]));
842 peer1.connect_block(b, height, 0);
843 peer2.connect_block(b, height, 0);
846 maybe_exchange_peer_messages(peer1, peer2);
847 while (peer1.chan_manager.list_usable_channels().length != 1 || peer2.chan_manager.list_usable_channels().length != 1) ;
849 events = peer1.get_manager_events(1, peer1, peer2);
850 assert events[0] instanceof Event.ChannelReady;
852 events = peer2.get_manager_events(1, peer1, peer2);
853 assert events[0] instanceof Event.ChannelReady;
855 ChannelDetails[] peer1_chans = peer1.chan_manager.list_usable_channels();
856 ChannelDetails[] peer2_chans = peer2.chan_manager.list_usable_channels();
857 assert peer1_chans.length == 1;
858 assert peer2_chans.length == 1;
859 assert peer1_chans[0].get_channel_value_satoshis() == 100000;
860 assert peer1_chans[0].get_is_usable();
861 Option_u64Z short_chan_id = peer1_chans[0].get_short_channel_id();
862 assert short_chan_id instanceof Option_u64Z.Some;
863 assert ((Option_u64Z.Some)short_chan_id).some == (1L << 40); // 0th output in the 0th transaction in the 1st block
864 assert Arrays.equals(peer1_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
865 assert Arrays.equals(peer2_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
867 Result_InvoiceSignOrCreationErrorZ invoice = UtilMethods.create_invoice_from_channelmanager(peer2.chan_manager, peer2.node_signer, peer2.logger, Currency.LDKCurrency_Bitcoin, Option_u64Z.some(10000000), "Invoice Description", 7200, Option_u16Z.none());
868 assert invoice instanceof Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK;
869 System.out.println("Got invoice: " + ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
871 Result_InvoiceParseOrSemanticErrorZ parsed_invoice = Invoice.from_str(((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
872 assert parsed_invoice instanceof Result_InvoiceParseOrSemanticErrorZ.Result_InvoiceParseOrSemanticErrorZ_OK;
873 assert Arrays.equals(((Result_InvoiceParseOrSemanticErrorZ.Result_InvoiceParseOrSemanticErrorZ_OK) parsed_invoice).res.payment_hash(), ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash());
874 SignedRawInvoice signed_raw = ((Result_InvoiceParseOrSemanticErrorZ.Result_InvoiceParseOrSemanticErrorZ_OK) parsed_invoice).res.into_signed_raw();
875 RawInvoice raw_invoice = signed_raw.raw_invoice();
876 byte[] desc_hash = raw_invoice.signable_hash();
877 Description raw_invoice_description = raw_invoice.description();
878 String description_string = raw_invoice_description.into_inner();
879 assert description_string.equals("Invoice Description");
881 if (!use_invoice_payer) {
882 byte[] payment_hash = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash();
883 byte[] payment_secret = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_secret();
884 byte[] dest_node_id = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.recover_payee_pub_key();
885 assert Arrays.equals(dest_node_id, peer2.node_id);
886 InvoiceFeatures invoice_features = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.features();
887 RouteHint[] route_hints = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.route_hints();
889 PaymentParameters payee = PaymentParameters.of(peer2.node_id, invoice_features, route_hints, Option_u64Z.none(), 6*24*14, (byte)1, (byte)2, new long[0], 42);
890 RouteParameters route_params = RouteParameters.of(payee, 10000000);
891 Result_RouteLightningErrorZ route_res = UtilMethods.find_route(
892 peer1.chan_manager.get_our_node_id(), route_params, peer1.net_graph,
893 peer1_chans, peer1.logger, ProbabilisticScorer.of(ProbabilisticScoringParameters.with_default(), peer1.net_graph, peer1.logger).as_Score(), new byte[32]);
894 assert route_res instanceof Result_RouteLightningErrorZ.Result_RouteLightningErrorZ_OK;
895 Route route = ((Result_RouteLightningErrorZ.Result_RouteLightningErrorZ_OK) route_res).res;
896 assert route.get_paths().length == 1;
897 assert route.get_paths()[0].length == 1;
898 assert route.get_paths()[0][0].get_fee_msat() == 10000000;
900 byte[] payment_id = new byte[] { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31 };
901 Result_NonePaymentSendFailureZ payment_res = peer1.chan_manager.send_payment(route, payment_hash, payment_secret, payment_id);
902 assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_OK;
904 RouteHop[][] hops = new RouteHop[1][1];
905 byte[] hop_pubkey = new byte[33];
908 NodeFeatures node_features = NodeFeatures.empty();
909 ChannelFeatures channel_features = ChannelFeatures.empty();
910 hops[0][0] = RouteHop.of(hop_pubkey, node_features, 42, channel_features, 100, 0);
911 Route r2 = Route.of(hops, payee);
912 payment_res = peer1.chan_manager.send_payment(r2, payment_hash, payment_secret, payment_id);
913 assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_Err;
915 Result_PaymentIdPaymentErrorZ send_res = UtilMethods.pay_invoice(((Result_InvoiceParseOrSemanticErrorZ.Result_InvoiceParseOrSemanticErrorZ_OK) parsed_invoice).res, Retry.attempts(0), peer1.chan_manager);
916 assert send_res instanceof Result_PaymentIdPaymentErrorZ.Result_PaymentIdPaymentErrorZ_OK;
920 if (use_chan_manager_constructor) {
921 peer1.constructor.interrupt();
922 peer2.constructor.interrupt();
923 } else if (use_nio_peer_handler) {
924 peer1.nio_peer_handler.interrupt();
925 peer2.nio_peer_handler.interrupt();
927 WeakReference<Peer> op1 = new WeakReference<Peer>(peer1);
928 peer1 = new Peer(peer1);
929 peer2 = new Peer(peer2);
930 return new TestState(op1, peer1, peer2, b.getHash());
932 return new TestState(null, peer1, peer2, b.getHash());
935 boolean cross_reload_ref_pollution = false;
937 private final WeakReference<Peer> ref_block;
938 private final Peer peer1;
939 private final Peer peer2;
940 public Sha256Hash best_blockhash;
942 public TestState(WeakReference<Peer> ref_block, Peer peer1, Peer peer2, Sha256Hash best_blockhash) {
943 this.ref_block = ref_block;
946 this.best_blockhash = best_blockhash;
949 void do_test_message_handler_b(TestState state) throws Exception {
950 GcCheck obj = new GcCheck();
951 if (state.ref_block != null) {
952 // Ensure the original peers get freed before we move on. Note that we have to be in a different function
953 // scope to do so as the (at least current OpenJDK) JRE won't release anything created in the same scope.
954 while (!cross_reload_ref_pollution && state.ref_block.get() != null) {
956 System.runFinalization();
958 connect_peers(state.peer1, state.peer2);
961 Event[] events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
962 assert events[0] instanceof Event.PendingHTLCsForwardable;
963 state.peer2.chan_manager.process_pending_htlc_forwards();
965 events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
966 assert events[0] instanceof Event.PaymentClaimable;
967 assert ((Event.PaymentClaimable)events[0]).purpose instanceof PaymentPurpose.InvoicePayment;
968 byte[] payment_preimage = ((PaymentPurpose.InvoicePayment)((Event.PaymentClaimable)events[0]).purpose).payment_preimage;
969 assert !Arrays.equals(payment_preimage, new byte[32]);
970 state.peer2.chan_manager.claim_funds(payment_preimage);
972 events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
973 assert events[0] instanceof Event.PaymentClaimed;
974 assert ((Event.PaymentClaimed)events[0]).purpose instanceof PaymentPurpose.InvoicePayment;
975 payment_preimage = ((PaymentPurpose.InvoicePayment)((Event.PaymentClaimed)events[0]).purpose).payment_preimage;
976 assert !Arrays.equals(payment_preimage, new byte[32]);
978 events = state.peer1.get_manager_events(2, state.peer1, state.peer2);
979 assert events[0] instanceof Event.PaymentSent;
980 assert Arrays.equals(((Event.PaymentSent) events[0]).payment_preimage, payment_preimage);
981 assert events[1] instanceof Event.PaymentPathSuccessful;
982 assert Arrays.equals(((Event.PaymentPathSuccessful) events[1]).payment_hash, ((Event.PaymentSent) events[0]).payment_hash);
984 if (use_nio_peer_handler) {
985 // We receive PaymentSent immediately upon receipt of the payment preimage, but we expect to not have an
986 // HTLC transaction to broadcast below, which requires a bit more time to fully complete the
987 // commitment-transaction-update dance between both peers.
991 if (state.peer1.chain_monitor != null) {
992 Balance[] peer1_balances = state.peer1.chain_monitor.get_claimable_balances(state.peer1.chan_manager.list_channels());
993 assert peer1_balances.length == 0;
994 Balance[] peer2_balances = state.peer2.chain_monitor.get_claimable_balances(state.peer2.chan_manager.list_channels());
995 assert peer2_balances.length == 0;
998 ChannelDetails[] peer1_chans = state.peer1.chan_manager.list_channels();
1001 Result_NoneAPIErrorZ close_res = state.peer1.chan_manager.close_channel(peer1_chans[0].get_channel_id(), state.peer2.node_id);
1002 assert close_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
1003 maybe_exchange_peer_messages(state.peer1, state.peer2);
1004 synchronized (state.peer1.broadcast_set) {
1005 while (state.peer1.broadcast_set.size() != 1) state.peer1.broadcast_set.wait();
1007 synchronized (state.peer2.broadcast_set) {
1008 while (state.peer2.broadcast_set.size() != 1) state.peer2.broadcast_set.wait();
1011 state.peer1.chan_manager.force_close_all_channels_broadcasting_latest_txn();
1012 maybe_exchange_peer_messages(state.peer1, state.peer2);
1013 synchronized (state.peer1.broadcast_set) {
1014 while (state.peer1.broadcast_set.size() != 1) state.peer1.broadcast_set.wait();
1016 synchronized (state.peer2.broadcast_set) {
1017 while (state.peer2.broadcast_set.size() != 1) state.peer2.broadcast_set.wait();
1021 assert state.peer1.broadcast_set.size() == 1;
1022 assert state.peer2.broadcast_set.size() == 1;
1024 events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
1025 assert events[0] instanceof Event.ChannelClosed;
1026 events = state.peer1.get_manager_events(1, state.peer1, state.peer2);
1027 assert events[0] instanceof Event.ChannelClosed;
1029 if (state.peer1.chain_monitor != null) {
1030 Balance[] peer1_balances = state.peer1.chain_monitor.get_claimable_balances(state.peer1.chan_manager.list_channels());
1031 assert peer1_balances.length == 1;
1032 for (Balance bal : peer1_balances) {
1033 assert bal instanceof Balance.ClaimableOnChannelClose;
1034 long expected_tx_fee = 183;
1035 assert ((Balance.ClaimableOnChannelClose) bal).claimable_amount_satoshis == 100000 - 1 - 10000 - expected_tx_fee;
1037 Balance[] peer2_balances = state.peer2.chain_monitor.get_claimable_balances(state.peer2.chan_manager.list_channels());
1038 assert peer2_balances.length == 1;
1039 for (Balance bal : peer2_balances) {
1040 assert bal instanceof Balance.ClaimableOnChannelClose;
1041 assert ((Balance.ClaimableOnChannelClose) bal).claimable_amount_satoshis == 10000 + 1;
1046 NetworkParameters bitcoinj_net = NetworkParameters.fromID(NetworkParameters.ID_MAINNET);
1047 Transaction tx = new Transaction(bitcoinj_net, state.peer1.broadcast_set.getFirst());
1048 Block b = new Block(bitcoinj_net, 2, state.best_blockhash, Sha256Hash.ZERO_HASH, 42, 0, 0,
1049 Arrays.asList(new Transaction[]{tx}));
1050 TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ[] watch_outputs = state.peer2.connect_block(b, 10, 1);
1051 if (watch_outputs != null) { // We only process watch_outputs manually when we use a manually-build Watch impl
1052 assert watch_outputs.length == 1;
1053 assert Arrays.equals(watch_outputs[0].get_a(), tx.getTxId().getReversedBytes());
1054 assert watch_outputs[0].get_b().length == 2;
1055 assert watch_outputs[0].get_b()[0].get_a() == 0;
1056 assert watch_outputs[0].get_b()[1].get_a() == 1;
1059 for (int i = 11; i < 21; i++) {
1060 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, new ArrayList<>());
1061 state.peer2.connect_block(b, i, 0);
1064 Event[] broadcastable_event = state.peer2.get_monitor_events(1);
1065 for (ChannelMonitor mon : state.peer2.monitors.values()) {
1066 // This used to be buggy and double-free, so go ahead and fetch them!
1067 byte[][] txn = mon.get_latest_holder_commitment_txn(state.peer2.logger);
1069 assert broadcastable_event.length == 1;
1070 assert broadcastable_event[0] instanceof Event.SpendableOutputs;
1071 if (state.peer2.explicit_keys_manager != null) {
1072 TxOut[] additional_outputs = new TxOut[]{new TxOut(420, new byte[]{0x42})};
1073 Result_TransactionNoneZ tx_res = state.peer2.explicit_keys_manager.spend_spendable_outputs(((Event.SpendableOutputs) broadcastable_event[0]).outputs, additional_outputs, new byte[]{0x00}, 253);
1074 assert tx_res instanceof Result_TransactionNoneZ.Result_TransactionNoneZ_OK;
1075 Transaction built_tx = new Transaction(bitcoinj_net, ((Result_TransactionNoneZ.Result_TransactionNoneZ_OK) tx_res).res);
1076 assert built_tx.getOutputs().size() == 2;
1077 assert Arrays.equals(built_tx.getOutput(1).getScriptBytes(), new byte[]{0x00});
1078 assert Arrays.equals(built_tx.getOutput(0).getScriptBytes(), new byte[]{0x42});
1079 assert built_tx.getOutput(0).getValue().value == 420;
1083 // Test exchanging a custom message (note that ChannelManagerConstructor) always loads an IgnorimgMessageHandler
1084 // so we cannot exchange custom messages with it
1085 if (!use_chan_manager_constructor) {
1086 byte[] custom_message_bytes = new byte[]{0x42, 0x44, 0x43, 0x00};
1087 synchronized(state.peer1.custom_messages_to_send) {
1088 state.peer1.custom_messages_to_send.add(custom_message_bytes);
1090 state.peer1.peer_manager.process_events();
1091 synchronized (state.peer2.received_custom_messages) {
1093 if (state.peer2.received_custom_messages.isEmpty()) {
1094 state.peer2.received_custom_messages.wait();
1097 assert state.peer2.received_custom_messages.size() == 1;
1098 assert Arrays.equals(state.peer2.received_custom_messages.get(0), custom_message_bytes);
1104 if (use_nio_peer_handler) {
1105 state.peer1.peer_manager.disconnect_by_node_id(state.peer2.chan_manager.get_our_node_id());
1106 while (state.peer1.peer_manager.get_peer_node_ids().length != 0) Thread.yield();
1107 while (state.peer2.peer_manager.get_peer_node_ids().length != 0) Thread.yield();
1108 state.peer1.nio_peer_handler.interrupt();
1109 state.peer2.nio_peer_handler.interrupt();
1112 state.peer1.get_monitor_events(0);
1113 state.peer2.get_monitor_events(0);
1115 if (use_chan_manager_constructor) {
1116 state.peer1.constructor.interrupt();
1117 state.peer2.constructor.interrupt();
1122 if (state.peer1.net_graph != null)
1123 state.peer1.net_graph.write();
1125 // Construct the only Option_Enum::Variant(OpaqueStruct) we have in the codebase as this used to cause double-frees:
1126 byte[] serd = new byte[] {(byte)0xd9,(byte)0x77,(byte)0xcb,(byte)0x9b,(byte)0x53,(byte)0xd9,(byte)0x3a,(byte)0x6f,(byte)0xf6,(byte)0x4b,(byte)0xb5,(byte)0xf1,(byte)0xe1,(byte)0x58,(byte)0xb4,(byte)0x09,(byte)0x4b,(byte)0x66,(byte)0xe7,(byte)0x98,(byte)0xfb,(byte)0x12,(byte)0x91,(byte)0x11,(byte)0x68,(byte)0xa3,(byte)0xcc,(byte)0xdf,(byte)0x80,(byte)0xa8,(byte)0x30,(byte)0x96,(byte)0x34,(byte)0x0a,(byte)0x6a,(byte)0x95,(byte)0xda,(byte)0x0a,(byte)0xe8,(byte)0xd9,(byte)0xf7,(byte)0x76,(byte)0x52,(byte)0x8e,(byte)0xec,(byte)0xdb,(byte)0xb7,(byte)0x47,(byte)0xeb,(byte)0x6b,(byte)0x54,(byte)0x54,(byte)0x95,(byte)0xa4,(byte)0x31,(byte)0x9e,(byte)0xd5,(byte)0x37,(byte)0x8e,(byte)0x35,(byte)0xb2,(byte)0x1e,(byte)0x07,(byte)0x3a,(byte)0x00,(byte)0x00,(byte)0x00,(byte)0x00,(byte)0x01,(byte)0x19,(byte)0xd6,(byte)0x68,(byte)0x9c,(byte)0x08,(byte)0x5a,(byte)0xe1,(byte)0x65,(byte)0x83,(byte)0x1e,(byte)0x93,(byte)0x4f,(byte)0xf7,(byte)0x63,(byte)0xae,(byte)0x46,(byte)0xa2,(byte)0xa6,(byte)0xc1,(byte)0x72,(byte)0xb3,(byte)0xf1,(byte)0xb6,(byte)0x0a,(byte)0x8c,(byte)0xe2,(byte)0x6f,(byte)0x00,(byte)0x08,(byte)0x3a,(byte)0x84,(byte)0x00,(byte)0x00,(byte)0x03,(byte)0x4d,(byte)0x01,(byte)0x34,(byte)0x13,(byte)0xa7,(byte)0x00,(byte)0x00,(byte)0x00,(byte)0x90,(byte)0x00,(byte)0x00,(byte)0x00,(byte)0x00,(byte)0x00,(byte)0x0f,(byte)0x42,(byte)0x40,(byte)0x00,(byte)0x00,(byte)0x27,(byte)0x10,(byte)0x00,(byte)0x00,(byte)0x00,(byte)0x14,(byte)0xde,(byte)0xad,(byte)0xbe,(byte)0xef,(byte)0x42,(byte)0x42,(byte)0x42,(byte)0x42};
1127 Result_ChannelUpdateDecodeErrorZ upd_msg = ChannelUpdate.read(serd);
1128 assert upd_msg instanceof Result_ChannelUpdateDecodeErrorZ.Result_ChannelUpdateDecodeErrorZ_OK;
1129 assert ((Result_ChannelUpdateDecodeErrorZ.Result_ChannelUpdateDecodeErrorZ_OK) upd_msg).res.get_contents().get_htlc_maximum_msat() == 0xdeadbeef42424242L;
1130 Option_NetworkUpdateZ upd = Option_NetworkUpdateZ.some(NetworkUpdate.channel_update_message(((Result_ChannelUpdateDecodeErrorZ.Result_ChannelUpdateDecodeErrorZ_OK) upd_msg).res));
1132 if (use_chan_manager_constructor) {
1133 // Lock the scorer twice back-to-back to check that the try-with-resources AutoCloseable on the scorer works.
1134 try (ChannelManagerConstructor.ScorerWrapper score = state.peer1.constructor.get_locked_scorer()) {
1135 score.prob_scorer.debug_log_liquidity_stats();
1137 try (ChannelManagerConstructor.ScorerWrapper score = state.peer1.constructor.get_locked_scorer()) {
1138 score.prob_scorer.clear_manual_penalties();
1143 java.util.LinkedList<WeakReference<Object>> must_free_objs = new java.util.LinkedList();
1145 int gc_exp_count = 0;
1147 GcCheck() { gc_exp_count += 1; }
1149 protected void finalize() throws Throwable {
1155 public class HumanObjectPeerTest {
1156 static 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, boolean use_ignoring_routing_handler, boolean use_chan_manager_constructor, boolean use_invoice_payer) throws Exception {
1157 HumanObjectPeerTestInstance instance = new HumanObjectPeerTestInstance(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_peer_refs, nio_peer_handler, !nio_peer_handler, use_ignoring_routing_handler, use_chan_manager_constructor, use_invoice_payer);
1158 HumanObjectPeerTestInstance.TestState state = instance.do_test_message_handler();
1159 instance.do_test_message_handler_b(state);
1162 static 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, boolean use_ignoring_routing_handler, boolean use_chan_manager_constructor, boolean use_invoice_payer) throws Exception {
1163 HumanObjectPeerTestInstance instance = do_test_run(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_peer_refs, nio_peer_handler, use_ignoring_routing_handler, use_chan_manager_constructor, use_invoice_payer);
1164 while (instance.gc_count != instance.gc_exp_count) {
1166 System.runFinalization();
1168 for (WeakReference<Object> o : instance.must_free_objs)
1169 assert o.get() == null;
1171 public static final int TEST_ITERATIONS = (1 << 9);
1172 public static void do_test_message_handler(IntConsumer statusFunction) throws Exception {
1173 Thread gc_thread = new Thread(() -> {
1176 System.runFinalization();
1177 try { Thread.sleep(0, 1); } catch (InterruptedException e) { break; }
1179 }, "Test GC Thread");
1181 for (int i = 0; i < TEST_ITERATIONS; i++) {
1182 boolean nice_close = (i & (1 << 0)) != 0;
1183 boolean use_km_wrapper = (i & (1 << 1)) != 0;
1184 boolean use_manual_watch = (i & (1 << 2)) != 0;
1185 boolean reload_peers = (i & (1 << 3)) != 0;
1186 boolean break_cross_refs = (i & (1 << 4)) != 0;
1187 boolean use_ignoring_routing_handler = (i & (1 << 5)) != 0;
1188 boolean use_chan_manager_constructor = (i & (1 << 6)) != 0;
1189 boolean use_invoice_payer = (i & (1 << 7)) != 0;
1190 boolean nio_peer_handler = (i & (1 << 8)) != 0;
1191 if (break_cross_refs && !reload_peers) {
1192 // There are no cross refs to break without reloading peers.
1195 if (use_chan_manager_constructor && (use_manual_watch || !nio_peer_handler)) {
1196 // ChannelManagerConstructor requires a ChainMonitor as the Watch and creates a NioPeerHandler for us.
1199 if (!use_chan_manager_constructor && (use_ignoring_routing_handler)) {
1200 // We rely on the ChannelManagerConstructor to convert null into an IgnoringMessageHandler, so don't
1201 // try to run with an IgnoringMessageHandler unless we're also using a ChannelManagerConstructor.
1204 if (use_chan_manager_constructor && use_ignoring_routing_handler && use_invoice_payer) {
1205 // As documented on ChannelManagerConstructor, if we provide a `null` NetworkGraph (because we want to
1206 // use an IgnoringMessageHandler), no InvoicePayer will be constructored for us, thus we cannot use an
1207 // InvoicePayer to send payments in this case.
1210 if (use_chan_manager_constructor && use_km_wrapper) {
1211 // ChannelManagerConstructor requires a full KeysManager, so using wrapped keys interfaces doesn't make
1215 statusFunction.accept(i);
1216 do_test(nice_close, use_km_wrapper, use_manual_watch, reload_peers, break_cross_refs, nio_peer_handler, use_ignoring_routing_handler, use_chan_manager_constructor, use_invoice_payer);
1218 gc_thread.interrupt();
1222 public void test_message_handler() throws Exception {
1223 do_test_message_handler(i -> System.err.println("Running test with flags " + i));
1226 // This is used in the test jar to test the built jar is runnable
1227 public static void main(String[] args) {
1229 do_test_message_handler(i -> System.err.println("Running test with flags " + i));
1230 } catch (Exception e) {
1231 System.err.println("Caught exception:");
1232 System.err.println(e);