3 import org.bitcoinj.base.BitcoinNetwork;
4 import org.bitcoinj.base.Coin;
5 import org.bitcoinj.base.Sha256Hash;
6 import org.bitcoinj.core.*;
7 import org.bitcoinj.params.BitcoinNetworkParams;
8 import org.bitcoinj.script.Script;
9 import org.junit.jupiter.api.Test;
10 import org.ldk.batteries.ChannelManagerConstructor;
11 import org.ldk.batteries.NioPeerHandler;
12 import org.ldk.enums.*;
13 import org.ldk.enums.Currency;
14 import org.ldk.structs.*;
15 import org.ldk.util.UInt128;
16 import org.ldk.util.UInt5;
18 import java.io.IOException;
19 import java.lang.ref.WeakReference;
20 import java.net.InetSocketAddress;
22 import java.util.function.IntConsumer;
24 class HumanObjectPeerTestInstance {
25 private final boolean nice_close;
26 private final boolean use_km_wrapper;
27 private final boolean use_manual_watch;
28 private final boolean reload_peers;
29 private final boolean break_cross_peer_refs;
30 private final boolean use_nio_peer_handler;
31 private final boolean use_filter;
32 private final boolean use_ignore_handler;
33 private final boolean use_chan_manager_constructor;
34 private final boolean use_invoice_payer;
35 TxOut gossip_txout = null;
37 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) {
38 this.nice_close = nice_close;
39 this.use_km_wrapper = use_km_wrapper;
40 this.use_manual_watch = use_manual_watch;
41 this.reload_peers = reload_peers;
42 this.break_cross_peer_refs = break_cross_peer_refs;
43 this.use_nio_peer_handler = use_nio_peer_handler;
44 this.use_filter = use_filter;
45 this.use_ignore_handler = use_ignore_handler;
46 this.use_chan_manager_constructor = use_chan_manager_constructor;
47 this.use_invoice_payer = use_invoice_payer;
51 NodeSigner manual_node_signer(KeysManager underlying_km) {
52 NodeSigner underlying_ns = underlying_km.as_NodeSigner();
53 must_free_objs.add(new WeakReference<>(underlying_ns));
54 return NodeSigner.new_impl(new NodeSigner.NodeSignerInterface() {
55 @Override public byte[] get_inbound_payment_key_material() { return underlying_ns.get_inbound_payment_key_material(); }
56 @Override public Result_PublicKeyNoneZ get_node_id(Recipient recipient) { return underlying_ns.get_node_id(recipient); }
57 @Override public Result_SharedSecretNoneZ ecdh(Recipient recipient, byte[] other_key, Option_ScalarZ tweak) {
58 return underlying_ns.ecdh(recipient, other_key, tweak);
60 @Override public Result_RecoverableSignatureNoneZ sign_invoice(byte[] hrp_bytes, UInt5[] invoice_data, Recipient recipient) {
61 return underlying_ns.sign_invoice(hrp_bytes, invoice_data, recipient);
63 @Override public Result_SignatureNoneZ sign_gossip_message(UnsignedGossipMessage msg) {
64 return underlying_ns.sign_gossip_message(msg);
68 SignerProvider manual_signer_provider(KeysManager underlying_km) {
69 SignerProvider underlying_sp = underlying_km.as_SignerProvider();
70 must_free_objs.add(new WeakReference<>(underlying_sp));
71 return SignerProvider.new_impl(new SignerProvider.SignerProviderInterface() {
72 @Override public byte[] get_destination_script() { return underlying_sp.get_destination_script(); }
73 @Override public ShutdownScript get_shutdown_scriptpubkey() { return underlying_sp.get_shutdown_scriptpubkey(); }
74 @Override public byte[] generate_channel_keys_id(boolean inbound, long channel_value_satoshis, UInt128 user_channel_id) {
75 return underlying_sp.generate_channel_keys_id(inbound, channel_value_satoshis, user_channel_id);
78 public WriteableEcdsaChannelSigner derive_channel_signer(long channel_value_satoshis, byte[] channel_keys_id) {
79 WriteableEcdsaChannelSigner underlying_wecs = underlying_sp.derive_channel_signer(channel_value_satoshis, channel_keys_id);
80 EcdsaChannelSigner underlying_ecs = underlying_wecs.get_ecdsa_channel_signer();
81 ChannelSigner underlying_cs = underlying_ecs.get_channel_signer();
82 ChannelSigner.ChannelSignerInterface csi = new ChannelSigner.ChannelSignerInterface() {
83 @Override public byte[] get_per_commitment_point(long idx) { return underlying_cs.get_per_commitment_point(idx); }
84 @Override public byte[] release_commitment_secret(long idx) { return underlying_cs.release_commitment_secret(idx); }
85 @Override public Result_NoneNoneZ validate_holder_commitment(HolderCommitmentTransaction holder_tx, byte[][] preimages) {
86 return underlying_cs.validate_holder_commitment(holder_tx, preimages);
88 @Override public byte[] channel_keys_id() { return underlying_cs.channel_keys_id(); }
89 @Override public void provide_channel_parameters(ChannelTransactionParameters channel_parameters) {
90 underlying_cs.provide_channel_parameters(channel_parameters);
93 EcdsaChannelSigner.EcdsaChannelSignerInterface ecsi = new EcdsaChannelSigner.EcdsaChannelSignerInterface() {
94 @Override public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_counterparty_commitment(CommitmentTransaction commitment_tx, byte[][] preimages) {
95 return underlying_ecs.sign_counterparty_commitment(commitment_tx, preimages);
97 @Override public Result_NoneNoneZ validate_counterparty_revocation(long idx, byte[] secret) {
98 return underlying_ecs.validate_counterparty_revocation(idx, secret);
100 @Override public Result_C2Tuple_SignatureCVec_SignatureZZNoneZ sign_holder_commitment_and_htlcs(HolderCommitmentTransaction commitment_tx) {
101 return underlying_ecs.sign_holder_commitment_and_htlcs(commitment_tx);
103 @Override public Result_SignatureNoneZ sign_justice_revoked_output(byte[] justice_tx, long input, long amount, byte[] per_commitment_key) {
104 return underlying_ecs.sign_justice_revoked_output(justice_tx, input, amount, per_commitment_key);
106 @Override public Result_SignatureNoneZ sign_justice_revoked_htlc(byte[] justice_tx, long input, long amount, byte[] per_commitment_key, HTLCOutputInCommitment htlc) {
107 return underlying_ecs.sign_justice_revoked_htlc(justice_tx, input, amount, per_commitment_key, htlc);
109 @Override public Result_SignatureNoneZ sign_counterparty_htlc_transaction(byte[] htlc_tx, long input, long amount, byte[] per_commitment_point, HTLCOutputInCommitment htlc) {
110 return underlying_ecs.sign_counterparty_htlc_transaction(htlc_tx, input, amount, per_commitment_point, htlc);
112 @Override public Result_SignatureNoneZ sign_closing_transaction(ClosingTransaction closing_tx) {
113 return underlying_ecs.sign_closing_transaction(closing_tx);
115 @Override public Result_SignatureNoneZ sign_holder_anchor_input(byte[] anchor_tx, long input) {
116 return underlying_ecs.sign_holder_anchor_input(anchor_tx, input);
118 @Override public Result_SignatureNoneZ sign_channel_announcement_with_funding_key(UnsignedChannelAnnouncement msg) {
119 return underlying_ecs.sign_channel_announcement_with_funding_key(msg);
122 WriteableEcdsaChannelSigner.WriteableEcdsaChannelSignerInterface wecsi = new WriteableEcdsaChannelSigner.WriteableEcdsaChannelSignerInterface() {
123 @Override public byte[] write() { return underlying_wecs.write(); }
125 WriteableEcdsaChannelSigner resp = WriteableEcdsaChannelSigner.new_impl(wecsi, ecsi, csi, underlying_cs.get_pubkeys());
126 must_free_objs.add(new WeakReference<>(wecsi));
127 must_free_objs.add(new WeakReference<>(ecsi));
128 must_free_objs.add(new WeakReference<>(csi));
129 must_free_objs.add(new WeakReference<>(resp));
130 must_free_objs.add(new WeakReference<>(underlying_wecs));
131 must_free_objs.add(new WeakReference<>(underlying_ecs));
132 must_free_objs.add(new WeakReference<>(underlying_cs));
137 public Result_WriteableEcdsaChannelSignerDecodeErrorZ read_chan_signer(byte[] reader) {
138 return underlying_sp.read_chan_signer(reader);
143 Watch get_manual_watch() {
144 Watch.WatchInterface watch_impl = new Watch.WatchInterface() {
145 public ChannelMonitorUpdateStatus watch_channel(OutPoint funding_txo, ChannelMonitor monitor) {
146 synchronized (monitors) {
147 assert monitors.put(Arrays.toString(funding_txo.get_txid()), monitor) == null;
149 return ChannelMonitorUpdateStatus.LDKChannelMonitorUpdateStatus_Completed;
152 public ChannelMonitorUpdateStatus update_channel(OutPoint funding_txo, ChannelMonitorUpdate update) {
153 synchronized (monitors) {
154 String txid = Arrays.toString(funding_txo.get_txid());
155 assert monitors.containsKey(txid);
156 Result_NoneNoneZ update_res = monitors.get(txid).update_monitor(update, tx_broadcaster, fee_estimator, logger);
157 assert update_res instanceof Result_NoneNoneZ.Result_NoneNoneZ_OK;
159 return ChannelMonitorUpdateStatus.LDKChannelMonitorUpdateStatus_Completed;
163 public ThreeTuple_OutPointCVec_MonitorEventZPublicKeyZ[] release_pending_monitor_events() {
164 synchronized (monitors) {
165 assert monitors.size() <= 1;
166 for (ChannelMonitor mon : monitors.values()) {
167 ThreeTuple_OutPointCVec_MonitorEventZPublicKeyZ[] res = new ThreeTuple_OutPointCVec_MonitorEventZPublicKeyZ[1];
168 res[0] = ThreeTuple_OutPointCVec_MonitorEventZPublicKeyZ.of(mon.get_funding_txo().get_a(), mon.get_and_clear_pending_monitor_events(), mon.get_counterparty_node_id());
172 return new ThreeTuple_OutPointCVec_MonitorEventZPublicKeyZ[0];
175 Watch watch = Watch.new_impl(watch_impl);
176 must_free_objs.add(new WeakReference<>(watch_impl));
177 must_free_objs.add(new WeakReference<>(watch));
181 UserConfig get_config() {
182 ChannelHandshakeConfig channel_config = ChannelHandshakeConfig.with_default();
183 channel_config.set_announced_channel(true);
184 UserConfig config = UserConfig.with_default();
185 config.set_channel_handshake_config(channel_config);
189 NioPeerHandler nio_peer_handler;
193 final FeeEstimator fee_estimator;
194 final BroadcasterInterface tx_broadcaster;
195 final KeysManager explicit_keys_manager;
196 final NodeSigner node_signer;
197 final SignerProvider signer_provider;
198 final EntropySource entropy_source;
199 final ChainMonitor chain_monitor;
200 NetworkGraph net_graph;
201 P2PGossipSync route_handler;
202 final Watch chain_watch;
203 final HashSet<String> filter_additions;
204 Option_FilterZ filter;
205 ChannelManager chan_manager;
206 PeerManager peer_manager;
207 final HashMap<String, ChannelMonitor> monitors; // Wow I forgot just how terrible Java is - we can't put a byte array here.
209 byte[] connected_peer_node_id = null;
210 final LinkedList<byte[]> broadcast_set = new LinkedList<>();
211 final LinkedList<Event> pending_manager_events = new LinkedList<>();
212 private final CustomMessageHandler custom_message_handler;
213 final LinkedList<byte[]> received_custom_messages = new LinkedList<>();
214 final LinkedList<byte[]> custom_messages_to_send = new LinkedList<>();
215 ChannelManagerConstructor constructor = null;
216 GcCheck obj = new GcCheck();
218 private ChannelMonitor test_mon_roundtrip(OutPoint expected_id, byte[] data) {
219 // Because get_funding_txo() returns an OutPoint in a tuple that is a reference to an OutPoint inside the
220 // ChannelMonitor, its a good test to ensure that the OutPoint isn't freed (or is cloned) before the
221 // ChannelMonitor is. This used to be broken.
222 Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ roundtrip_monitor = UtilMethods.C2Tuple_BlockHashChannelMonitorZ_read(data, this.entropy_source, this.signer_provider);
223 assert roundtrip_monitor instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
224 must_free_objs.add(new WeakReference<>(roundtrip_monitor));
225 TwoTuple_OutPointScriptZ funding_txo = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_monitor).res.get_b().get_funding_txo();
226 must_free_objs.add(new WeakReference<>(funding_txo));
227 System.gc(); System.runFinalization(); // Give the GC a chance to run.
228 assert Arrays.equals(funding_txo.get_a().get_txid(), expected_id.get_txid());
229 assert funding_txo.get_a().get_index() == expected_id.get_index();
230 Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ roundtrip_two = UtilMethods.C2Tuple_BlockHashChannelMonitorZ_read(data, this.entropy_source, this.signer_provider);
231 assert roundtrip_two instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
232 must_free_objs.add(new WeakReference<>(((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_two).res.get_b()));
233 must_free_objs.add(new WeakReference<>(((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_two).res));
234 must_free_objs.add(new WeakReference<>(roundtrip_two));
235 return ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) roundtrip_two).res.get_b();
238 private Peer(Object _dummy, byte seed) {
239 logger = Logger.new_impl((org.ldk.structs.Record arg)->{
240 if (arg.get_level() == Level.LDKLevel_Error)
241 System.err.println(seed + ": " + arg.get_module_path() + " - " + arg.get_args());
243 System.out.println(seed + ": " + arg.get_module_path() + " - " + arg.get_args());
245 fee_estimator = FeeEstimator.new_impl((confirmation_target -> 253));
246 tx_broadcaster = BroadcasterInterface.new_impl(tx -> {
247 synchronized (broadcast_set) {
248 broadcast_set.add(tx);
249 broadcast_set.notifyAll();
252 monitors = new HashMap<>();
254 Persist persister = Persist.new_impl(new Persist.PersistInterface() {
256 public ChannelMonitorUpdateStatus persist_new_channel(OutPoint id, ChannelMonitor data, MonitorUpdateId update_id) {
257 synchronized (monitors) {
258 String key = Arrays.toString(id.to_channel_id());
259 ChannelMonitor res = test_mon_roundtrip(id, data.write());
260 assert monitors.put(key, res) == null;
262 return ChannelMonitorUpdateStatus.LDKChannelMonitorUpdateStatus_Completed;
266 public ChannelMonitorUpdateStatus update_persisted_channel(OutPoint id, ChannelMonitorUpdate update, ChannelMonitor data, MonitorUpdateId update_id) {
267 synchronized (monitors) {
268 String key = Arrays.toString(id.to_channel_id());
269 ChannelMonitor res = test_mon_roundtrip(id, data.write());
270 // Note that we use a serialization-roundtrip copy of data here, not the original, as this can
271 // expose the JVM JIT bug where it finalize()s things still being called.
272 assert monitors.put(key, res) != null;
274 return ChannelMonitorUpdateStatus.LDKChannelMonitorUpdateStatus_Completed;
278 filter_additions = new HashSet<>();
280 this.filter = Option_FilterZ.some(Filter.new_impl(new Filter.FilterInterface() {
281 @Override public void register_tx(byte[] txid, byte[] script_pubkey) {
282 filter_additions.add(Arrays.toString(txid));
284 @Override public void register_output(WatchedOutput output) {
285 filter_additions.add(Arrays.toString(output.get_outpoint().get_txid()) + ":" + output.get_outpoint().get_index());
289 this.filter = Option_FilterZ.none();
292 if (use_manual_watch) {
293 chain_watch = get_manual_watch();
294 chain_monitor = null;
296 chain_monitor = ChainMonitor.of(filter, tx_broadcaster, logger, fee_estimator, persister);
297 chain_watch = chain_monitor.as_Watch();
300 byte[] key_seed = new byte[32];
301 for (byte i = 0; i < 32; i++) {
302 key_seed[i] = (byte) (i ^ seed);
304 KeysManager keys = KeysManager.of(key_seed, System.currentTimeMillis() / 1000, (int) (System.currentTimeMillis() * 1000));
305 if (use_km_wrapper) {
306 this.signer_provider = manual_signer_provider(keys);
307 this.node_signer = manual_node_signer(keys);
308 this.entropy_source = EntropySource.new_impl(new EntropySource.EntropySourceInterface() {
309 @Override public byte[] get_secure_random_bytes() { return keys.as_EntropySource().get_secure_random_bytes(); }
311 this.explicit_keys_manager = null;
313 this.signer_provider = keys.as_SignerProvider();
314 this.entropy_source = keys.as_EntropySource();
315 this.node_signer = keys.as_NodeSigner();
316 this.explicit_keys_manager = keys;
319 this.custom_message_handler = CustomMessageHandler.new_impl(new CustomMessageHandler.CustomMessageHandlerInterface() {
321 public Result_NoneLightningErrorZ handle_custom_message(Type msg, byte[] sender_node_id) {
322 synchronized (received_custom_messages) {
323 received_custom_messages.add(msg.write());
324 received_custom_messages.notifyAll();
326 return Result_NoneLightningErrorZ.ok();
330 public TwoTuple_PublicKeyTypeZ[] get_and_clear_pending_msg() {
332 synchronized (custom_messages_to_send) {
333 bytes = custom_messages_to_send.toArray(new byte[0][0]);
334 custom_messages_to_send.clear();
336 TwoTuple_PublicKeyTypeZ[] ret = new TwoTuple_PublicKeyTypeZ[bytes.length];
337 for (int i = 0; i < bytes.length; i++) {
338 final int msg_idx = i;
339 ret[i] = TwoTuple_PublicKeyTypeZ.of(connected_peer_node_id, Type.new_impl(new Type.TypeInterface() {
340 @Override public short type_id() { return 4096; }
341 @Override public String debug_str() { return "Custom Java Message"; }
342 @Override public byte[] write() { return bytes[msg_idx]; }
347 }, (message_type, buffer) -> {
348 assert message_type == 4096;
349 return Result_COption_TypeZDecodeErrorZ.ok(Option_TypeZ.some(Type.new_impl(new Type.TypeInterface() {
350 @Override public short type_id() { return 4096; }
351 @Override public String debug_str() { return "Custom Java-Decoded Message"; }
352 @Override public byte[] write() { return buffer; }
356 private void bind_nio() {
357 if (!use_nio_peer_handler) return;
358 if (use_chan_manager_constructor) {
359 this.nio_peer_handler = this.constructor.nio_peer_handler;
361 try { this.nio_peer_handler = new NioPeerHandler(peer_manager); } catch (IOException e) { assert false; }
363 for (short i = 10_000; true; i++) {
365 nio_peer_handler.bind_listener(new InetSocketAddress("127.0.0.1", i));
368 } catch (IOException e) { assert i < 10_500; }
371 private void setup_route_handler() {
372 this.route_handler = P2PGossipSync.of(this.net_graph,
373 Option_UtxoLookupZ.some(UtxoLookup.new_impl((genesis_hash, short_channel_id) -> UtxoResult.sync(Result_TxOutUtxoLookupErrorZ.ok(gossip_txout)))), this.logger);
377 this.net_graph = NetworkGraph.of(Network.LDKNetwork_Bitcoin, this.logger);
378 this.setup_route_handler();
380 if (use_chan_manager_constructor) {
381 this.constructor = new ChannelManagerConstructor(Network.LDKNetwork_Bitcoin, get_config(), new byte[32], 0,
382 this.explicit_keys_manager.as_EntropySource(), this.explicit_keys_manager.as_NodeSigner(), this.explicit_keys_manager.as_SignerProvider(),
383 this.fee_estimator, this.chain_monitor, this.net_graph,
384 ProbabilisticScoringParameters.with_default(), (ChannelManagerConstructor.RouterWrapper)
385 (payer_node_id, route_params, first_hops, inflight_htlcs, payment_hash, payment_id, default_router) -> {
386 assert payment_hash != null && payment_id != null;
387 Router r = default_router.as_Router();
388 must_free_objs.add(new WeakReference<>(r));
389 return r.find_route_with_id(payer_node_id, route_params, first_hops, inflight_htlcs, payment_hash, payment_id);
391 this.tx_broadcaster, this.logger);
392 constructor.chain_sync_completed(new ChannelManagerConstructor.EventHandler() {
393 @Override public void handle_event(Event event) {
394 synchronized (pending_manager_events) {
395 pending_manager_events.add(event);
396 pending_manager_events.notifyAll();
399 @Override public void persist_manager(byte[] channel_manager_bytes) { assert channel_manager_bytes.length > 1; }
400 @Override public void persist_network_graph(byte[] graph_bytes) { assert graph_bytes.length > 1; }
401 @Override public void persist_scorer(byte[] scorer_bytes) { assert scorer_bytes.length > 1; }
402 }, !use_ignore_handler);
403 this.chan_manager = constructor.channel_manager;
404 this.peer_manager = constructor.peer_manager;
405 must_free_objs.add(new WeakReference<>(this.chan_manager));
407 Router router = Router.new_impl(new Router.RouterInterface() {
409 public Result_RouteLightningErrorZ find_route_with_id(byte[] payer, RouteParameters route_params, ChannelDetails[] first_hops, InFlightHtlcs inflight_htlcs, byte[] _payment_hash, byte[] _payment_id) {
410 return find_route(payer, route_params, first_hops, inflight_htlcs);
414 public Result_RouteLightningErrorZ find_route(byte[] payer, RouteParameters params, ChannelDetails[] first_hops, InFlightHtlcs inflight_htlcs) {
416 try (ReadOnlyNetworkGraph graph = net_graph.read_only()) {
417 assert graph.channel(424242) == null;
418 long[] channels = graph.list_channels();
419 if (channels.length != 1) {
420 // If we're using a NioPeerHandler, the handling of announcement signatures and
421 // channel broadcasting may be done async, so just wait until the channel shows up.
422 assert use_nio_peer_handler;
425 ChannelInfo chan = graph.channel(channels[0]);
426 assert Arrays.equals(chan.get_node_one().as_slice(), chan.get_node_one().write());
427 assert Arrays.equals(chan.get_node_one().as_slice(), chan_manager.get_our_node_id()) ||
428 Arrays.equals(chan.get_node_two().as_slice(), chan_manager.get_our_node_id());
432 return UtilMethods.find_route(payer, params, net_graph, first_hops, logger, Score.new_impl(new Score.ScoreInterface() {
433 @Override public void payment_path_failed(Path path, long scid) {}
434 @Override public long channel_penalty_msat(long short_channel_id, NodeId source, NodeId target, ChannelUsage usage) { return 0; }
435 @Override public void payment_path_successful(Path path) {}
436 @Override public void probe_failed(Path path, long short_channel_id) { assert false; }
437 @Override public void probe_successful(Path path) { assert false; }
438 @Override public byte[] write() { assert false; return null; }
442 ChainParameters params = ChainParameters.of(Network.LDKNetwork_Bitcoin, BestBlock.of(new byte[32], 0));
443 this.chan_manager = ChannelManager.of(this.fee_estimator, chain_watch, tx_broadcaster, router, logger,
444 this.entropy_source, this.node_signer, this.signer_provider, get_config(), params);
445 this.peer_manager = PeerManager.of(chan_manager.as_ChannelMessageHandler(), route_handler.as_RoutingMessageHandler(),
446 IgnoringMessageHandler.of().as_OnionMessageHandler(), 0xdeadbeef,
447 this.entropy_source.get_secure_random_bytes(), logger, this.custom_message_handler, this.node_signer);
450 this.node_id = chan_manager.get_our_node_id();
458 this(null, orig.seed);
459 if (use_chan_manager_constructor) {
460 byte[][] monitors = {orig.monitors.values().stream().iterator().next().write()};
461 byte[] serialized = orig.chan_manager.write();
462 byte[] serialized_graph = orig.net_graph.write();
463 byte[] serialized_scorer = orig.constructor.scorer.write();
465 Filter filter_nullable = null;
466 if (this.filter instanceof Option_FilterZ.Some) {
467 filter_nullable = ((Option_FilterZ.Some) this.filter).some;
469 this.constructor = new ChannelManagerConstructor(serialized, monitors, get_config(),
470 this.explicit_keys_manager.as_EntropySource(), this.explicit_keys_manager.as_NodeSigner(), this.explicit_keys_manager.as_SignerProvider(),
471 this.fee_estimator, this.chain_monitor, filter_nullable,
472 serialized_graph, ProbabilisticScoringParameters.with_default(), serialized_scorer, null,
473 this.tx_broadcaster, this.logger);
475 // Test that ChannelManagerConstructor correctly rejects duplicate ChannelMonitors
476 byte[][] monitors_dupd = new byte[2][];
477 monitors_dupd[0] = monitors[0];
478 monitors_dupd[1] = monitors[0];
479 ChannelManagerConstructor constr = new ChannelManagerConstructor(serialized, monitors_dupd, get_config(),
480 this.explicit_keys_manager.as_EntropySource(), this.explicit_keys_manager.as_NodeSigner(), this.explicit_keys_manager.as_SignerProvider(),
481 this.fee_estimator, this.chain_monitor, filter_nullable,
482 serialized_graph, ProbabilisticScoringParameters.with_default(), serialized_scorer, null,
483 this.tx_broadcaster, this.logger);
485 } catch (ChannelManagerConstructor.InvalidSerializedDataException e) {}
486 this.net_graph = this.constructor.net_graph;
487 setup_route_handler();
488 constructor.chain_sync_completed(new ChannelManagerConstructor.EventHandler() {
489 @Override public void handle_event(Event event) {
490 synchronized (pending_manager_events) {
491 pending_manager_events.add(event);
492 pending_manager_events.notifyAll();
495 @Override public void persist_manager(byte[] channel_manager_bytes) { assert channel_manager_bytes.length > 1; }
496 @Override public void persist_network_graph(byte[] graph_bytes) { assert graph_bytes.length > 1; }
497 @Override public void persist_scorer(byte[] scorer_bytes) { assert scorer_bytes.length > 1; }
498 }, !use_ignore_handler);
499 this.chan_manager = constructor.channel_manager;
500 this.peer_manager = constructor.peer_manager;
501 must_free_objs.add(new WeakReference<>(this.chan_manager));
502 // If we are using a ChannelManagerConstructor, we may have pending events waiting on the old peer
503 // which have been removed from the ChannelManager but which we still need to handle.
504 this.pending_manager_events.addAll(orig.pending_manager_events);
505 if (!this.pending_manager_events.isEmpty()) {
506 // However, this implies cross_reload_ref_pollution
507 cross_reload_ref_pollution = true;
509 } catch (ChannelManagerConstructor.InvalidSerializedDataException e) {
513 this.net_graph = NetworkGraph.of(Network.LDKNetwork_Bitcoin, this.logger);
514 Router router = Router.new_impl(new Router.RouterInterface() {
516 public Result_RouteLightningErrorZ find_route_with_id(byte[] payer, RouteParameters route_params, ChannelDetails[] first_hops, InFlightHtlcs inflight_htlcs, byte[] _payment_hash, byte[] _payment_id) {
517 return find_route(payer, route_params, first_hops, inflight_htlcs);
521 public Result_RouteLightningErrorZ find_route(byte[] payer, RouteParameters params, ChannelDetails[] first_hops, InFlightHtlcs inflight_htlcs) {
523 try (ReadOnlyNetworkGraph graph = net_graph.read_only()) {
524 assert graph.channel(424242) == null;
525 long[] channels = graph.list_channels();
526 if (channels.length != 1) {
527 // If we're using a NioPeerHandler, the handling of announcement signatures and
528 // channel broadcasting may be done async, so just wait until the channel shows up.
529 assert use_nio_peer_handler;
532 ChannelInfo chan = graph.channel(channels[0]);
533 assert Arrays.equals(chan.get_node_one().as_slice(), chan.get_node_one().write());
534 assert Arrays.equals(chan.get_node_one().as_slice(), chan_manager.get_our_node_id()) ||
535 Arrays.equals(chan.get_node_two().as_slice(), chan_manager.get_our_node_id());
539 return UtilMethods.find_route(payer, params, net_graph, first_hops, logger, Score.new_impl(new Score.ScoreInterface() {
540 @Override public void payment_path_failed(Path path, long scid) {}
541 @Override public long channel_penalty_msat(long short_channel_id, NodeId source, NodeId target, ChannelUsage usage) { return 0; }
542 @Override public void payment_path_successful(Path path) {}
543 @Override public void probe_failed(Path path, long short_channel_id) { assert false; }
544 @Override public void probe_successful(Path path) { assert false; }
545 @Override public byte[] write() { assert false; return null; }
549 this.setup_route_handler();
550 ChannelMonitor[] monitors = new ChannelMonitor[1];
551 assert orig.monitors.size() == 1;
552 if (!break_cross_peer_refs) {
553 monitors[0] = orig.monitors.values().stream().iterator().next();
555 byte[] serialized = orig.monitors.values().stream().iterator().next().write();
556 Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ res =
557 UtilMethods.C2Tuple_BlockHashChannelMonitorZ_read(serialized, this.entropy_source, this.signer_provider);
558 assert res instanceof Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK;
559 monitors[0] = ((Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.Result_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_OK) res).res.get_b();
561 byte[] serialized = orig.chan_manager.write();
562 Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ read_res =
563 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);
564 assert read_res instanceof Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK;
565 this.chan_manager = ((Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.Result_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_OK) read_res).res.get_b();
566 this.chain_watch.watch_channel(monitors[0].get_funding_txo().get_a(), monitors[0]);
567 this.peer_manager = PeerManager.of(chan_manager.as_ChannelMessageHandler(), route_handler.as_RoutingMessageHandler(),
568 IgnoringMessageHandler.of().as_OnionMessageHandler(), (int)(System.currentTimeMillis() / 1000),
569 this.entropy_source.get_secure_random_bytes(), logger, this.custom_message_handler, this.node_signer);
570 if (!break_cross_peer_refs && (use_manual_watch || use_km_wrapper)) {
571 // When we pass monitors[0] into chain_watch.watch_channel we create a reference from the new Peer to a
572 // field in the old peer, preventing freeing of the original Peer until the new Peer is freed. Thus, we
573 // shouldn't bother waiting for the original to be freed later on.
574 cross_reload_ref_pollution = true;
577 this.node_id = chan_manager.get_our_node_id();
580 if (cross_reload_ref_pollution) {
581 // This really, really needs to be handled at the bindings layer, but its rather complicated -
582 // ChannelSigners can be cloned and passed around without java being involved, resulting in them being
583 // owned by both one or more ChannelMonitors and a ChannelManager, with only one having proper pointers
584 // to the ChannelSigner. Ideally, the ChannelSigner would have a global reference to the Java
585 // implementation class, but that results in circular references. Instead, we need some ability to,
586 // while cloning ChannelSigners, add new references in the calling Java struct (ie ChannelMonitor) to
587 // the ChannelSigner.
588 this.ptr_to = orig.chan_manager;
593 TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ[] connect_block(Block b, int height, long expected_monitor_update_len) {
594 byte[] header = Arrays.copyOfRange(b.bitcoinSerialize(), 0, 80);
595 TwoTuple_usizeTransactionZ[] txn;
596 if (b.hasTransactions()) {
597 assert b.getTransactions().size() == 1;
598 TwoTuple_usizeTransactionZ txp = TwoTuple_usizeTransactionZ.of((long) 0, b.getTransactions().get(0).bitcoinSerialize());
599 txn = new TwoTuple_usizeTransactionZ[]{txp};
601 txn = new TwoTuple_usizeTransactionZ[0];
602 if (chain_monitor != null) {
603 chan_manager.as_Listen().block_connected(b.bitcoinSerialize(), height);
604 chain_monitor.as_Listen().block_connected(b.bitcoinSerialize(), height);
606 chan_manager.as_Confirm().transactions_confirmed(header, txn, height);
607 chan_manager.as_Confirm().best_block_updated(header, height);
608 // Connect manually if we aren't using a ChainMonitor and are implementing Watch ourselves
609 synchronized (monitors) {
610 assert monitors.size() == 1;
611 for (ChannelMonitor mon : monitors.values()) {
612 TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ[] ret = mon.block_connected(header, txn, height, tx_broadcaster, fee_estimator, logger);
613 assert ret.length == expected_monitor_update_len;
621 Event[] get_monitor_events(int expected_len) {
622 if (use_chan_manager_constructor) {
624 synchronized (this.pending_manager_events) {
625 if (expected_len != 0 && this.pending_manager_events.size() == expected_len) {
629 if (expected_len == 0) {
630 try { Thread.sleep(500); } catch (InterruptedException e) { assert false; }
636 synchronized (this.pending_manager_events) {
637 Event[] res = this.pending_manager_events.toArray(new Event[0]);
638 this.pending_manager_events.clear();
639 assert res.length == expected_len;
642 } else if (chain_monitor != null) {
643 ArrayList<Event> l = new ArrayList<Event>();
644 chain_monitor.as_EventsProvider().process_pending_events(EventHandler.new_impl(l::add));
645 assert l.size() == expected_len;
646 return l.toArray(new Event[0]);
648 synchronized (monitors) {
649 assert monitors.size() == 1;
650 for (ChannelMonitor mon : monitors.values()) {
651 Event[] res = mon.get_and_clear_pending_events();
652 assert res.length == expected_len;
660 Event[] get_manager_events(int expected_len, Peer peer1, Peer peer2) {
661 assert expected_len != 0;
662 if (!use_nio_peer_handler) {
663 maybe_exchange_peer_messages(peer1, peer2);
665 Event[] res = new Event[0];
666 if (use_chan_manager_constructor) {
667 while (res.length < expected_len) {
668 synchronized (this.pending_manager_events) {
669 if (this.pending_manager_events.size() >= expected_len) {
670 res = this.pending_manager_events.toArray(res);
671 assert res.length == expected_len;
672 this.pending_manager_events.clear();
674 if (res.length < expected_len) {
675 try { this.pending_manager_events.wait(); } catch (InterruptedException e) { assert false; }
680 ArrayList<Event> l = new ArrayList<Event>();
681 while (l.size() < expected_len) {
683 if (use_nio_peer_handler) {
684 peer1.nio_peer_handler.check_events();
685 peer2.nio_peer_handler.check_events();
687 chan_manager.as_EventsProvider().process_pending_events(EventHandler.new_impl(l::add));
689 return l.toArray(new Event[0]);
691 assert res.length == expected_len;
696 static class DescriptorHolder { SocketDescriptor val; }
698 boolean running = false;
699 final LinkedList<Runnable> runqueue = new LinkedList();
701 Thread t = new Thread(() -> {
705 synchronized (runqueue) {
706 while (runqueue.isEmpty()) {
710 r = runqueue.pollFirst();
713 synchronized (runqueue) {
715 runqueue.notifyAll();
717 } catch (InterruptedException e) {
723 void maybe_exchange_peer_messages(Peer peer1, Peer peer2) {
724 if (!use_nio_peer_handler) {
726 peer1.peer_manager.process_events();
727 peer2.peer_manager.process_events();
728 synchronized (runqueue) {
729 if (runqueue.isEmpty() && !running) {
735 try { runqueue.wait(); } catch (InterruptedException e) { assert false; }
738 } else if (!use_chan_manager_constructor) {
739 peer1.nio_peer_handler.check_events();
740 peer2.nio_peer_handler.check_events();
743 void do_read_event(PeerManager pm, SocketDescriptor descriptor, byte[] data) {
744 if (!t.isAlive()) t.start();
745 synchronized (runqueue) {
748 Result_boolPeerHandleErrorZ res = pm.read_event(descriptor, data);
749 assert res instanceof Result_boolPeerHandleErrorZ.Result_boolPeerHandleErrorZ_OK;
751 runqueue.notifyAll();
753 must_free_objs.add(new WeakReference<>(data));
756 void connect_peers(final Peer peer1, final Peer peer2) {
757 peer2.connected_peer_node_id = peer1.node_id;
758 peer1.connected_peer_node_id = peer2.node_id;
759 if (use_nio_peer_handler) {
761 peer1.nio_peer_handler.connect(peer2.chan_manager.get_our_node_id(), new InetSocketAddress("127.0.0.1", peer2.nio_port), 100);
762 } catch (IOException e) { assert false; }
763 while (peer1.peer_manager.get_peer_node_ids().length == 0 || peer2.peer_manager.get_peer_node_ids().length == 0) {
767 DescriptorHolder descriptor1 = new DescriptorHolder();
768 DescriptorHolder descriptor1ref = descriptor1;
769 SocketDescriptor descriptor2 = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
771 public long send_data(byte[] data, boolean resume_read) {
772 do_read_event(peer1.peer_manager, descriptor1ref.val, data);
776 @Override public void disconnect_socket() { assert false; }
777 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 2; }
778 @Override public long hash() { return 2; }
781 descriptor1.val = SocketDescriptor.new_impl(new SocketDescriptor.SocketDescriptorInterface() {
783 public long send_data(byte[] data, boolean resume_read) {
784 do_read_event(peer2.peer_manager, descriptor2, data);
788 @Override public void disconnect_socket() { assert false; }
789 @Override public boolean eq(SocketDescriptor other_arg) { return other_arg.hash() == 1; }
790 @Override public long hash() { return 1; }
793 Result_CVec_u8ZPeerHandleErrorZ conn_res = peer1.peer_manager.new_outbound_connection(peer2.node_id, descriptor1.val, Option_NetAddressZ.none());
794 assert conn_res instanceof Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK;
796 Result_NonePeerHandleErrorZ inbound_conn_res = peer2.peer_manager.new_inbound_connection(descriptor2, Option_NetAddressZ.none());
797 assert inbound_conn_res instanceof Result_NonePeerHandleErrorZ.Result_NonePeerHandleErrorZ_OK;
798 do_read_event(peer2.peer_manager, descriptor2, ((Result_CVec_u8ZPeerHandleErrorZ.Result_CVec_u8ZPeerHandleErrorZ_OK) conn_res).res);
800 maybe_exchange_peer_messages(peer1, peer2);
804 TestState do_test_message_handler() throws InterruptedException {
805 Peer peer1 = new Peer((byte) 1);
806 Peer peer2 = new Peer((byte) 2);
808 connect_peers(peer1, peer2);
810 UInt128 user_id = new UInt128(new byte[] {1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16});
812 Result__u832APIErrorZ cc_res = peer1.chan_manager.create_channel(peer2.node_id, 100000, 1000, user_id, null);
813 assert cc_res instanceof Result__u832APIErrorZ.Result__u832APIErrorZ_OK;
815 // Previously, this was a SEGFAULT instead of get_funding_txo() returning null.
816 ChannelDetails pre_funding_chan = peer1.chan_manager.list_channels()[0];
817 assert pre_funding_chan.get_funding_txo() == null;
819 Event[] events = peer1.get_manager_events(1, peer1, peer2);
820 assert events[0] instanceof Event.FundingGenerationReady;
821 assert ((Event.FundingGenerationReady) events[0]).channel_value_satoshis == 100000;
822 assert ((Event.FundingGenerationReady) events[0]).user_channel_id.equals(user_id);
823 byte[] funding_spk = ((Event.FundingGenerationReady) events[0]).output_script;
824 assert funding_spk.length == 34 && funding_spk[0] == 0 && funding_spk[1] == 32; // P2WSH
825 byte[] chan_id = ((Event.FundingGenerationReady) events[0]).temporary_channel_id;
827 BitcoinNetworkParams bitcoinj_net = BitcoinNetworkParams.of(BitcoinNetwork.MAINNET);
829 Transaction funding = new Transaction(bitcoinj_net);
830 funding.addInput(new TransactionInput(bitcoinj_net, funding, new byte[0]));
831 funding.getInputs().get(0).setWitness(new TransactionWitness(2)); // Make sure we don't complain about lack of witness
832 funding.getInput(0).getWitness().setPush(0, new byte[]{0x1});
833 funding.addOutput(Coin.SATOSHI.multiply(100000), new Script(funding_spk));
834 Result_NoneAPIErrorZ funding_res = peer1.chan_manager.funding_transaction_generated(chan_id, peer2.node_id, funding.bitcoinSerialize());
835 assert funding_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
837 gossip_txout = new TxOut(100000, funding_spk);
839 maybe_exchange_peer_messages(peer1, peer2);
840 synchronized (peer1.broadcast_set) {
841 while (peer1.broadcast_set.size() != 1) {
842 peer1.broadcast_set.wait();
846 events = peer1.get_manager_events(1, peer1, peer2);
847 assert events[0] instanceof Event.ChannelPending;
849 events = peer2.get_manager_events(1, peer1, peer2);
850 assert events[0] instanceof Event.ChannelPending;
852 assert peer1.broadcast_set.size() == 1;
853 assert Arrays.equals(peer1.broadcast_set.get(0), funding.bitcoinSerialize());
854 peer1.broadcast_set.clear();
856 Block b = new Block(bitcoinj_net, 2, Sha256Hash.ZERO_HASH, Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[]{funding}));
857 peer1.connect_block(b, 1, 0);
858 peer2.connect_block(b, 1, 0);
860 for (int height = 2; height < 10; height++) {
861 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, Arrays.asList(new Transaction[0]));
862 peer1.connect_block(b, height, 0);
863 peer2.connect_block(b, height, 0);
866 maybe_exchange_peer_messages(peer1, peer2);
867 while (peer1.chan_manager.list_usable_channels().length != 1 || peer2.chan_manager.list_usable_channels().length != 1) ;
869 events = peer1.get_manager_events(1, peer1, peer2);
870 assert events[0] instanceof Event.ChannelReady;
872 events = peer2.get_manager_events(1, peer1, peer2);
873 assert events[0] instanceof Event.ChannelReady;
875 ChannelDetails[] peer1_chans = peer1.chan_manager.list_usable_channels();
876 ChannelDetails[] peer2_chans = peer2.chan_manager.list_usable_channels();
877 assert peer1_chans.length == 1;
878 assert peer2_chans.length == 1;
879 assert peer1_chans[0].get_channel_value_satoshis() == 100000;
880 assert peer1_chans[0].get_is_usable();
881 Option_u64Z short_chan_id = peer1_chans[0].get_short_channel_id();
882 assert short_chan_id instanceof Option_u64Z.Some;
883 assert ((Option_u64Z.Some)short_chan_id).some == (1L << 40); // 0th output in the 0th transaction in the 1st block
884 assert Arrays.equals(peer1_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
885 assert Arrays.equals(peer2_chans[0].get_channel_id(), funding.getTxId().getReversedBytes());
887 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());
888 assert invoice instanceof Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK;
889 System.out.println("Got invoice: " + ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
891 Result_InvoiceParseOrSemanticErrorZ parsed_invoice = Invoice.from_str(((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.to_str());
892 assert parsed_invoice instanceof Result_InvoiceParseOrSemanticErrorZ.Result_InvoiceParseOrSemanticErrorZ_OK;
893 //assert ((Result_InvoiceParseOrSemanticErrorZ.Result_InvoiceParseOrSemanticErrorZ_OK) parsed_invoice).res.fallback_addresses().length == 0;
894 assert Arrays.equals(((Result_InvoiceParseOrSemanticErrorZ.Result_InvoiceParseOrSemanticErrorZ_OK) parsed_invoice).res.payment_hash(), ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash());
895 SignedRawInvoice signed_raw = ((Result_InvoiceParseOrSemanticErrorZ.Result_InvoiceParseOrSemanticErrorZ_OK) parsed_invoice).res.into_signed_raw();
896 RawInvoice raw_invoice = signed_raw.raw_invoice();
897 byte[] desc_hash = raw_invoice.signable_hash();
898 Description raw_invoice_description = raw_invoice.description();
899 String description_string = raw_invoice_description.into_inner();
900 assert description_string.equals("Invoice Description");
902 if (!use_invoice_payer) {
903 byte[] payment_hash = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_hash();
904 byte[] payment_secret = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.payment_secret();
905 byte[] dest_node_id = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.recover_payee_pub_key();
906 assert Arrays.equals(dest_node_id, peer2.node_id);
907 InvoiceFeatures invoice_features = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.features();
908 RouteHint[] route_hints = ((Result_InvoiceSignOrCreationErrorZ.Result_InvoiceSignOrCreationErrorZ_OK) invoice).res.route_hints();
910 PaymentParameters payee = PaymentParameters.of(peer2.node_id, invoice_features, Hints.clear(route_hints), Option_u64Z.none(), 6*24*14, (byte)1, (byte)2, new long[0], 42);
911 RouteParameters route_params = RouteParameters.of(payee, 10000000);
912 Result_RouteLightningErrorZ route_res = UtilMethods.find_route(
913 peer1.chan_manager.get_our_node_id(), route_params, peer1.net_graph,
914 peer1_chans, peer1.logger, ProbabilisticScorer.of(ProbabilisticScoringParameters.with_default(), peer1.net_graph, peer1.logger).as_Score(), new byte[32]);
915 assert route_res instanceof Result_RouteLightningErrorZ.Result_RouteLightningErrorZ_OK;
916 Route route = ((Result_RouteLightningErrorZ.Result_RouteLightningErrorZ_OK) route_res).res;
917 assert route.get_paths().length == 1;
918 assert route.get_paths()[0].get_hops().length == 1;
919 assert route.get_paths()[0].final_value_msat() == 10000000;
921 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 };
922 Result_NonePaymentSendFailureZ payment_res = peer1.chan_manager.send_payment_with_route(route, payment_hash, RecipientOnionFields.secret_only(payment_secret), payment_id);
923 assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_OK;
925 RouteHop[] hops = new RouteHop[1];
926 byte[] hop_pubkey = new byte[33];
929 NodeFeatures node_features = NodeFeatures.empty();
930 ChannelFeatures channel_features = ChannelFeatures.empty();
931 hops[0] = RouteHop.of(hop_pubkey, node_features, 42, channel_features, 100, 0);
932 Path[] paths = new Path[1];
933 paths[0] = Path.of(hops, null);
934 Route r2 = Route.of(paths, payee);
935 payment_res = peer1.chan_manager.send_payment_with_route(r2, payment_hash, RecipientOnionFields.secret_only(payment_secret), payment_id);
936 assert payment_res instanceof Result_NonePaymentSendFailureZ.Result_NonePaymentSendFailureZ_Err;
938 Result_PaymentIdPaymentErrorZ send_res = UtilMethods.pay_invoice(((Result_InvoiceParseOrSemanticErrorZ.Result_InvoiceParseOrSemanticErrorZ_OK) parsed_invoice).res, Retry.attempts(0), peer1.chan_manager);
939 assert send_res instanceof Result_PaymentIdPaymentErrorZ.Result_PaymentIdPaymentErrorZ_OK;
943 if (use_chan_manager_constructor) {
944 peer1.constructor.interrupt();
945 peer2.constructor.interrupt();
946 } else if (use_nio_peer_handler) {
947 peer1.nio_peer_handler.interrupt();
948 peer2.nio_peer_handler.interrupt();
950 WeakReference<Peer> op1 = new WeakReference<Peer>(peer1);
951 peer1 = new Peer(peer1);
952 peer2 = new Peer(peer2);
953 return new TestState(op1, peer1, peer2, b.getHash());
955 return new TestState(null, peer1, peer2, b.getHash());
958 boolean cross_reload_ref_pollution = false;
960 private final WeakReference<Peer> ref_block;
961 private final Peer peer1;
962 private final Peer peer2;
963 public Sha256Hash best_blockhash;
965 public TestState(WeakReference<Peer> ref_block, Peer peer1, Peer peer2, Sha256Hash best_blockhash) {
966 this.ref_block = ref_block;
969 this.best_blockhash = best_blockhash;
972 void do_test_message_handler_b(TestState state) throws Exception {
973 GcCheck obj = new GcCheck();
974 if (state.ref_block != null) {
975 // Ensure the original peers get freed before we move on. Note that we have to be in a different function
976 // scope to do so as the (at least current OpenJDK) JRE won't release anything created in the same scope.
977 while (!cross_reload_ref_pollution && state.ref_block.get() != null) {
979 System.runFinalization();
981 connect_peers(state.peer1, state.peer2);
984 Event[] events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
985 assert events[0] instanceof Event.PendingHTLCsForwardable;
986 state.peer2.chan_manager.process_pending_htlc_forwards();
988 events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
989 assert events[0] instanceof Event.PaymentClaimable;
990 assert ((Event.PaymentClaimable)events[0]).purpose instanceof PaymentPurpose.InvoicePayment;
991 byte[] payment_preimage = ((PaymentPurpose.InvoicePayment)((Event.PaymentClaimable)events[0]).purpose).payment_preimage;
992 assert !Arrays.equals(payment_preimage, new byte[32]);
993 state.peer2.chan_manager.claim_funds(payment_preimage);
995 events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
996 assert events[0] instanceof Event.PaymentClaimed;
997 assert ((Event.PaymentClaimed)events[0]).purpose instanceof PaymentPurpose.InvoicePayment;
998 payment_preimage = ((PaymentPurpose.InvoicePayment)((Event.PaymentClaimed)events[0]).purpose).payment_preimage;
999 assert !Arrays.equals(payment_preimage, new byte[32]);
1001 events = state.peer1.get_manager_events(2, state.peer1, state.peer2);
1002 assert events[0] instanceof Event.PaymentSent;
1003 assert Arrays.equals(((Event.PaymentSent) events[0]).payment_preimage, payment_preimage);
1004 assert events[1] instanceof Event.PaymentPathSuccessful;
1005 assert Arrays.equals(((Event.PaymentPathSuccessful) events[1]).payment_hash, ((Event.PaymentSent) events[0]).payment_hash);
1007 if (use_nio_peer_handler) {
1008 // We receive PaymentSent immediately upon receipt of the payment preimage, but we expect to not have an
1009 // HTLC transaction to broadcast below, which requires a bit more time to fully complete the
1010 // commitment-transaction-update dance between both peers.
1014 if (state.peer1.chain_monitor != null) {
1015 Balance[] peer1_balances = state.peer1.chain_monitor.get_claimable_balances(state.peer1.chan_manager.list_channels());
1016 assert peer1_balances.length == 0;
1017 Balance[] peer2_balances = state.peer2.chain_monitor.get_claimable_balances(state.peer2.chan_manager.list_channels());
1018 assert peer2_balances.length == 0;
1021 ChannelDetails[] peer1_chans = state.peer1.chan_manager.list_channels();
1024 Result_NoneAPIErrorZ close_res = state.peer1.chan_manager.close_channel(peer1_chans[0].get_channel_id(), state.peer2.node_id);
1025 assert close_res instanceof Result_NoneAPIErrorZ.Result_NoneAPIErrorZ_OK;
1026 maybe_exchange_peer_messages(state.peer1, state.peer2);
1027 synchronized (state.peer1.broadcast_set) {
1028 while (state.peer1.broadcast_set.size() != 1) state.peer1.broadcast_set.wait();
1030 synchronized (state.peer2.broadcast_set) {
1031 while (state.peer2.broadcast_set.size() != 1) state.peer2.broadcast_set.wait();
1034 state.peer1.chan_manager.force_close_all_channels_broadcasting_latest_txn();
1035 maybe_exchange_peer_messages(state.peer1, state.peer2);
1036 synchronized (state.peer1.broadcast_set) {
1037 while (state.peer1.broadcast_set.size() != 1) state.peer1.broadcast_set.wait();
1039 synchronized (state.peer2.broadcast_set) {
1040 while (state.peer2.broadcast_set.size() != 1) state.peer2.broadcast_set.wait();
1044 assert state.peer1.broadcast_set.size() == 1;
1045 assert state.peer2.broadcast_set.size() == 1;
1047 events = state.peer2.get_manager_events(1, state.peer1, state.peer2);
1048 assert events[0] instanceof Event.ChannelClosed;
1049 events = state.peer1.get_manager_events(1, state.peer1, state.peer2);
1050 assert events[0] instanceof Event.ChannelClosed;
1052 if (state.peer1.chain_monitor != null) {
1053 Balance[] peer1_balances = state.peer1.chain_monitor.get_claimable_balances(state.peer1.chan_manager.list_channels());
1054 assert peer1_balances.length == 1;
1055 for (Balance bal : peer1_balances) {
1056 assert bal instanceof Balance.ClaimableOnChannelClose;
1057 long expected_tx_fee = 183;
1058 assert ((Balance.ClaimableOnChannelClose) bal).claimable_amount_satoshis == 100000 - 1 - 10000 - expected_tx_fee;
1060 Balance[] peer2_balances = state.peer2.chain_monitor.get_claimable_balances(state.peer2.chan_manager.list_channels());
1061 assert peer2_balances.length == 1;
1062 for (Balance bal : peer2_balances) {
1063 assert bal instanceof Balance.ClaimableOnChannelClose;
1064 assert ((Balance.ClaimableOnChannelClose) bal).claimable_amount_satoshis == 10000 + 1;
1069 BitcoinNetworkParams bitcoinj_net = BitcoinNetworkParams.of(BitcoinNetwork.MAINNET);
1070 Transaction tx = new Transaction(bitcoinj_net, state.peer1.broadcast_set.getFirst());
1071 Block b = new Block(bitcoinj_net, 2, state.best_blockhash, Sha256Hash.ZERO_HASH, 42, 0, 0,
1072 Arrays.asList(new Transaction[]{tx}));
1073 TwoTuple_TxidCVec_C2Tuple_u32TxOutZZZ[] watch_outputs = state.peer2.connect_block(b, 10, 1);
1074 if (watch_outputs != null) { // We only process watch_outputs manually when we use a manually-build Watch impl
1075 assert watch_outputs.length == 1;
1076 assert Arrays.equals(watch_outputs[0].get_a(), tx.getTxId().getReversedBytes());
1077 assert watch_outputs[0].get_b().length == 2;
1078 assert watch_outputs[0].get_b()[0].get_a() == 0;
1079 assert watch_outputs[0].get_b()[1].get_a() == 1;
1082 for (int i = 11; i < 21; i++) {
1083 b = new Block(bitcoinj_net, 2, b.getHash(), Sha256Hash.ZERO_HASH, 42, 0, 0, new ArrayList<>());
1084 state.peer2.connect_block(b, i, 0);
1087 Event[] broadcastable_event = state.peer2.get_monitor_events(1);
1088 for (ChannelMonitor mon : state.peer2.monitors.values()) {
1089 // This used to be buggy and double-free, so go ahead and fetch them!
1090 byte[][] txn = mon.get_latest_holder_commitment_txn(state.peer2.logger);
1092 assert broadcastable_event.length == 1;
1093 assert broadcastable_event[0] instanceof Event.SpendableOutputs;
1094 if (state.peer2.explicit_keys_manager != null) {
1095 TxOut[] additional_outputs = new TxOut[]{new TxOut(420, new byte[]{0x42})};
1096 Result_TransactionNoneZ tx_res = state.peer2.explicit_keys_manager.spend_spendable_outputs(((Event.SpendableOutputs) broadcastable_event[0]).outputs, additional_outputs, new byte[]{0x00}, 253);
1097 assert tx_res instanceof Result_TransactionNoneZ.Result_TransactionNoneZ_OK;
1098 Transaction built_tx = new Transaction(bitcoinj_net, ((Result_TransactionNoneZ.Result_TransactionNoneZ_OK) tx_res).res);
1099 assert built_tx.getOutputs().size() == 2;
1100 assert Arrays.equals(built_tx.getOutput(1).getScriptBytes(), new byte[]{0x00});
1101 assert Arrays.equals(built_tx.getOutput(0).getScriptBytes(), new byte[]{0x42});
1102 assert built_tx.getOutput(0).getValue().value == 420;
1106 // Test exchanging a custom message (note that ChannelManagerConstructor) always loads an IgnorimgMessageHandler
1107 // so we cannot exchange custom messages with it
1108 if (!use_chan_manager_constructor) {
1109 byte[] custom_message_bytes = new byte[]{0x42, 0x44, 0x43, 0x00};
1110 synchronized(state.peer1.custom_messages_to_send) {
1111 state.peer1.custom_messages_to_send.add(custom_message_bytes);
1113 state.peer1.peer_manager.process_events();
1114 synchronized (state.peer2.received_custom_messages) {
1116 if (state.peer2.received_custom_messages.isEmpty()) {
1117 state.peer2.received_custom_messages.wait();
1120 assert state.peer2.received_custom_messages.size() == 1;
1121 assert Arrays.equals(state.peer2.received_custom_messages.get(0), custom_message_bytes);
1127 if (use_nio_peer_handler) {
1128 state.peer1.peer_manager.disconnect_by_node_id(state.peer2.chan_manager.get_our_node_id());
1129 while (state.peer1.peer_manager.get_peer_node_ids().length != 0) Thread.yield();
1130 while (state.peer2.peer_manager.get_peer_node_ids().length != 0) Thread.yield();
1131 state.peer1.nio_peer_handler.interrupt();
1132 state.peer2.nio_peer_handler.interrupt();
1135 state.peer1.get_monitor_events(0);
1136 state.peer2.get_monitor_events(0);
1138 if (use_chan_manager_constructor) {
1139 state.peer1.constructor.interrupt();
1140 state.peer2.constructor.interrupt();
1145 if (state.peer1.net_graph != null)
1146 state.peer1.net_graph.write();
1148 // Construct the only Option_Enum::Variant(OpaqueStruct) we have in the codebase as this used to cause double-frees:
1149 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};
1150 Result_ChannelUpdateDecodeErrorZ upd_msg = ChannelUpdate.read(serd);
1151 assert upd_msg instanceof Result_ChannelUpdateDecodeErrorZ.Result_ChannelUpdateDecodeErrorZ_OK;
1152 assert ((Result_ChannelUpdateDecodeErrorZ.Result_ChannelUpdateDecodeErrorZ_OK) upd_msg).res.get_contents().get_htlc_maximum_msat() == 0xdeadbeef42424242L;
1153 Option_NetworkUpdateZ upd = Option_NetworkUpdateZ.some(NetworkUpdate.channel_update_message(((Result_ChannelUpdateDecodeErrorZ.Result_ChannelUpdateDecodeErrorZ_OK) upd_msg).res));
1155 if (use_chan_manager_constructor) {
1156 // Lock the scorer twice back-to-back to check that the try-with-resources AutoCloseable on the scorer works.
1157 try (ChannelManagerConstructor.ScorerWrapper score = state.peer1.constructor.get_locked_scorer()) {
1158 score.prob_scorer.debug_log_liquidity_stats();
1160 try (ChannelManagerConstructor.ScorerWrapper score = state.peer1.constructor.get_locked_scorer()) {
1161 score.prob_scorer.clear_manual_penalties();
1166 java.util.LinkedList<WeakReference<Object>> must_free_objs = new java.util.LinkedList();
1168 int gc_exp_count = 0;
1170 GcCheck() { gc_exp_count += 1; }
1172 protected void finalize() throws Throwable {
1178 public class HumanObjectPeerTest {
1179 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 {
1180 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);
1181 HumanObjectPeerTestInstance.TestState state = instance.do_test_message_handler();
1182 instance.do_test_message_handler_b(state);
1185 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 {
1186 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);
1187 while (instance.gc_count != instance.gc_exp_count) {
1189 System.runFinalization();
1191 for (WeakReference<Object> o : instance.must_free_objs)
1192 assert o.get() == null;
1194 public static final int TEST_ITERATIONS = (1 << 9);
1195 public static void do_test_message_handler(IntConsumer statusFunction) throws Exception {
1196 Thread gc_thread = new Thread(() -> {
1199 System.runFinalization();
1200 try { Thread.sleep(0, 1); } catch (InterruptedException e) { break; }
1202 }, "Test GC Thread");
1204 for (int i = 0; i < TEST_ITERATIONS; i++) {
1205 boolean nice_close = (i & (1 << 0)) != 0;
1206 boolean use_km_wrapper = (i & (1 << 1)) != 0;
1207 boolean use_manual_watch = (i & (1 << 2)) != 0;
1208 boolean reload_peers = (i & (1 << 3)) != 0;
1209 boolean break_cross_refs = (i & (1 << 4)) != 0;
1210 boolean use_ignoring_routing_handler = (i & (1 << 5)) != 0;
1211 boolean use_chan_manager_constructor = (i & (1 << 6)) != 0;
1212 boolean use_invoice_payer = (i & (1 << 7)) != 0;
1213 boolean nio_peer_handler = (i & (1 << 8)) != 0;
1214 if (break_cross_refs && !reload_peers) {
1215 // There are no cross refs to break without reloading peers.
1218 if (use_chan_manager_constructor && (use_manual_watch || !nio_peer_handler)) {
1219 // ChannelManagerConstructor requires a ChainMonitor as the Watch and creates a NioPeerHandler for us.
1222 if (!use_chan_manager_constructor && (use_ignoring_routing_handler)) {
1223 // We rely on the ChannelManagerConstructor to convert null into an IgnoringMessageHandler, so don't
1224 // try to run with an IgnoringMessageHandler unless we're also using a ChannelManagerConstructor.
1227 if (use_chan_manager_constructor && use_ignoring_routing_handler && use_invoice_payer) {
1228 // As documented on ChannelManagerConstructor, if we provide a `null` NetworkGraph (because we want to
1229 // use an IgnoringMessageHandler), no InvoicePayer will be constructored for us, thus we cannot use an
1230 // InvoicePayer to send payments in this case.
1233 if (use_chan_manager_constructor && use_km_wrapper) {
1234 // ChannelManagerConstructor requires a full KeysManager, so using wrapped keys interfaces doesn't make
1238 statusFunction.accept(i);
1239 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);
1241 gc_thread.interrupt();
1245 public void test_message_handler() throws Exception {
1246 do_test_message_handler(i -> System.err.println("Running test with flags " + i));
1249 // This is used in the test jar to test the built jar is runnable
1250 public static void main(String[] args) {
1252 do_test_message_handler(i -> System.err.println("Running test with flags " + i));
1253 } catch (Exception e) {
1254 System.err.println("Caught exception:");
1255 System.err.println(e);