1 package org.ldk.structs;
3 import org.ldk.impl.bindings;
4 import org.ldk.enums.*;
6 import java.util.Arrays;
7 import java.lang.ref.Reference;
8 import javax.annotation.Nullable;
12 * Manager which keeps track of a number of channels and sends messages to the appropriate
13 * channel, also tracking HTLC preimages and forwarding onion packets appropriately.
15 * Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
16 * to individual Channels.
18 * Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
19 * all peers during write/read (though does not modify this instance, only the instance being
20 * serialized). This will result in any channels which have not yet exchanged funding_created (ie
21 * called funding_transaction_generated for outbound channels).
23 * Note that you can be a bit lazier about writing out ChannelManager than you can be with
24 * ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
25 * returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
26 * happens out-of-band (and will prevent any other ChannelManager operations from occurring during
27 * the serialization process). If the deserialized version is out-of-date compared to the
28 * ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
29 * ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
31 * Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
32 * tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
33 * the \"reorg path\" (ie call block_disconnected() until you get to a common block and then call
34 * block_connected() to step towards your best block) upon deserialization before using the
37 * Note that ChannelManager is responsible for tracking liveness of its channels and generating
38 * ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
39 * spam due to quick disconnection/reconnection, updates are not sent until the channel has been
40 * offline for a full minute. In order to track this, you must call
41 * timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
43 * Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
44 * a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
45 * essentially you should default to using a SimpleRefChannelManager, and use a
46 * SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
47 * you're using lightning-net-tokio.
49 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
50 public class ChannelManager extends CommonBase {
51 ChannelManager(Object _dummy, long ptr) { super(ptr); }
52 @Override @SuppressWarnings("deprecation")
53 protected void finalize() throws Throwable {
55 if (ptr != 0) { bindings.ChannelManager_free(ptr); }
59 * Constructs a new ChannelManager to hold several channels and route between them.
61 * This is the main \"logic hub\" for all channel-related actions, and implements
62 * ChannelMessageHandler.
64 * Non-proportional fees are fixed according to our risk using the provided fee estimator.
66 * Users need to notify the new ChannelManager when a new block is connected or
67 * disconnected using its `block_connected` and `block_disconnected` methods, starting
68 * from after `params.latest_hash`.
70 public static ChannelManager of(FeeEstimator fee_est, Watch chain_monitor, BroadcasterInterface tx_broadcaster, Logger logger, KeysInterface keys_manager, UserConfig config, ChainParameters params) {
71 long ret = bindings.ChannelManager_new(fee_est == null ? 0 : fee_est.ptr, chain_monitor == null ? 0 : chain_monitor.ptr, tx_broadcaster == null ? 0 : tx_broadcaster.ptr, logger == null ? 0 : logger.ptr, keys_manager == null ? 0 : keys_manager.ptr, config == null ? 0 : config.ptr & ~1, params == null ? 0 : params.ptr & ~1);
72 Reference.reachabilityFence(fee_est);
73 Reference.reachabilityFence(chain_monitor);
74 Reference.reachabilityFence(tx_broadcaster);
75 Reference.reachabilityFence(logger);
76 Reference.reachabilityFence(keys_manager);
77 Reference.reachabilityFence(config);
78 Reference.reachabilityFence(params);
79 if (ret >= 0 && ret <= 4096) { return null; }
80 org.ldk.structs.ChannelManager ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.ChannelManager(null, ret); }
81 ret_hu_conv.ptrs_to.add(ret_hu_conv);
82 ret_hu_conv.ptrs_to.add(fee_est);
83 ret_hu_conv.ptrs_to.add(chain_monitor);
84 ret_hu_conv.ptrs_to.add(tx_broadcaster);
85 ret_hu_conv.ptrs_to.add(logger);
86 ret_hu_conv.ptrs_to.add(keys_manager);
91 * Gets the current configuration applied to all new channels, as
93 public UserConfig get_current_default_configuration() {
94 long ret = bindings.ChannelManager_get_current_default_configuration(this.ptr);
95 Reference.reachabilityFence(this);
96 if (ret >= 0 && ret <= 4096) { return null; }
97 org.ldk.structs.UserConfig ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.UserConfig(null, ret); }
98 ret_hu_conv.ptrs_to.add(this);
103 * Creates a new outbound channel to the given remote node and with the given value.
105 * `user_channel_id` will be provided back as in
106 * [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
107 * correspond with which `create_channel` call. Note that the `user_channel_id` defaults to 0
108 * for inbound channels, so you may wish to avoid using 0 for `user_channel_id` here.
109 * `user_channel_id` has no meaning inside of LDK, it is simply copied to events and otherwise
112 * Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
113 * greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
115 * Note that we do not check if you are currently connected to the given peer. If no
116 * connection is available, the outbound `open_channel` message may fail to send, resulting in
117 * the channel eventually being silently forgotten (dropped on reload).
119 * Returns the new Channel's temporary `channel_id`. This ID will appear as
120 * [`Event::FundingGenerationReady::temporary_channel_id`] and in
121 * [`ChannelDetails::channel_id`] until after
122 * [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
123 * one derived from the funding transaction's TXID. If the counterparty rejects the channel
124 * immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
126 * [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
127 * [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
128 * [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
130 * Note that override_config (or a relevant inner pointer) may be NULL or all-0s to represent None
132 public Result__u832APIErrorZ create_channel(byte[] their_network_key, long channel_value_satoshis, long push_msat, long user_channel_id, @Nullable UserConfig override_config) {
133 long ret = bindings.ChannelManager_create_channel(this.ptr, InternalUtils.check_arr_len(their_network_key, 33), channel_value_satoshis, push_msat, user_channel_id, override_config == null ? 0 : override_config.ptr & ~1);
134 Reference.reachabilityFence(this);
135 Reference.reachabilityFence(their_network_key);
136 Reference.reachabilityFence(channel_value_satoshis);
137 Reference.reachabilityFence(push_msat);
138 Reference.reachabilityFence(user_channel_id);
139 Reference.reachabilityFence(override_config);
140 if (ret >= 0 && ret <= 4096) { return null; }
141 Result__u832APIErrorZ ret_hu_conv = Result__u832APIErrorZ.constr_from_ptr(ret);
146 * Gets the list of open channels, in random order. See ChannelDetail field documentation for
149 public ChannelDetails[] list_channels() {
150 long[] ret = bindings.ChannelManager_list_channels(this.ptr);
151 Reference.reachabilityFence(this);
152 int ret_conv_16_len = ret.length;
153 ChannelDetails[] ret_conv_16_arr = new ChannelDetails[ret_conv_16_len];
154 for (int q = 0; q < ret_conv_16_len; q++) {
155 long ret_conv_16 = ret[q];
156 org.ldk.structs.ChannelDetails ret_conv_16_hu_conv = null; if (ret_conv_16 < 0 || ret_conv_16 > 4096) { ret_conv_16_hu_conv = new org.ldk.structs.ChannelDetails(null, ret_conv_16); }
157 ret_conv_16_hu_conv.ptrs_to.add(this);
158 ret_conv_16_arr[q] = ret_conv_16_hu_conv;
160 return ret_conv_16_arr;
164 * Gets the list of usable channels, in random order. Useful as an argument to [`find_route`]
165 * to ensure non-announced channels are used.
167 * These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
168 * documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
171 * [`find_route`]: crate::routing::router::find_route
173 public ChannelDetails[] list_usable_channels() {
174 long[] ret = bindings.ChannelManager_list_usable_channels(this.ptr);
175 Reference.reachabilityFence(this);
176 int ret_conv_16_len = ret.length;
177 ChannelDetails[] ret_conv_16_arr = new ChannelDetails[ret_conv_16_len];
178 for (int q = 0; q < ret_conv_16_len; q++) {
179 long ret_conv_16 = ret[q];
180 org.ldk.structs.ChannelDetails ret_conv_16_hu_conv = null; if (ret_conv_16 < 0 || ret_conv_16 > 4096) { ret_conv_16_hu_conv = new org.ldk.structs.ChannelDetails(null, ret_conv_16); }
181 ret_conv_16_hu_conv.ptrs_to.add(this);
182 ret_conv_16_arr[q] = ret_conv_16_hu_conv;
184 return ret_conv_16_arr;
188 * Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
189 * will be accepted on the given channel, and after additional timeout/the closing of all
190 * pending HTLCs, the channel will be closed on chain.
192 * If we are the channel initiator, we will pay between our [`Background`] and
193 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
195 * If our counterparty is the channel initiator, we will require a channel closing
196 * transaction feerate of at least our [`Background`] feerate or the feerate which
197 * would appear on a force-closure transaction, whichever is lower. We will allow our
198 * counterparty to pay as much fee as they'd like, however.
200 * May generate a SendShutdown message event on success, which should be relayed.
202 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
203 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
204 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
206 public Result_NoneAPIErrorZ close_channel(byte[] channel_id, byte[] counterparty_node_id) {
207 long ret = bindings.ChannelManager_close_channel(this.ptr, InternalUtils.check_arr_len(channel_id, 32), InternalUtils.check_arr_len(counterparty_node_id, 33));
208 Reference.reachabilityFence(this);
209 Reference.reachabilityFence(channel_id);
210 Reference.reachabilityFence(counterparty_node_id);
211 if (ret >= 0 && ret <= 4096) { return null; }
212 Result_NoneAPIErrorZ ret_hu_conv = Result_NoneAPIErrorZ.constr_from_ptr(ret);
217 * Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
218 * will be accepted on the given channel, and after additional timeout/the closing of all
219 * pending HTLCs, the channel will be closed on chain.
221 * `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
222 * the channel being closed or not:
223 * If we are the channel initiator, we will pay at least this feerate on the closing
224 * transaction. The upper-bound is set by
225 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
226 * estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
227 * If our counterparty is the channel initiator, we will refuse to accept a channel closure
228 * transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
229 * will appear on a force-closure transaction, whichever is lower).
231 * May generate a SendShutdown message event on success, which should be relayed.
233 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
234 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
235 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
237 public Result_NoneAPIErrorZ close_channel_with_target_feerate(byte[] channel_id, byte[] counterparty_node_id, int target_feerate_sats_per_1000_weight) {
238 long ret = bindings.ChannelManager_close_channel_with_target_feerate(this.ptr, InternalUtils.check_arr_len(channel_id, 32), InternalUtils.check_arr_len(counterparty_node_id, 33), target_feerate_sats_per_1000_weight);
239 Reference.reachabilityFence(this);
240 Reference.reachabilityFence(channel_id);
241 Reference.reachabilityFence(counterparty_node_id);
242 Reference.reachabilityFence(target_feerate_sats_per_1000_weight);
243 if (ret >= 0 && ret <= 4096) { return null; }
244 Result_NoneAPIErrorZ ret_hu_conv = Result_NoneAPIErrorZ.constr_from_ptr(ret);
249 * Force closes a channel, immediately broadcasting the latest local commitment transaction to
250 * the chain and rejecting new HTLCs on the given channel. Fails if `channel_id` is unknown to
251 * the manager, or if the `counterparty_node_id` isn't the counterparty of the corresponding
254 public Result_NoneAPIErrorZ force_close_channel(byte[] channel_id, byte[] counterparty_node_id) {
255 long ret = bindings.ChannelManager_force_close_channel(this.ptr, InternalUtils.check_arr_len(channel_id, 32), InternalUtils.check_arr_len(counterparty_node_id, 33));
256 Reference.reachabilityFence(this);
257 Reference.reachabilityFence(channel_id);
258 Reference.reachabilityFence(counterparty_node_id);
259 if (ret >= 0 && ret <= 4096) { return null; }
260 Result_NoneAPIErrorZ ret_hu_conv = Result_NoneAPIErrorZ.constr_from_ptr(ret);
265 * Force close all channels, immediately broadcasting the latest local commitment transaction
266 * for each to the chain and rejecting new HTLCs on each.
268 public void force_close_all_channels() {
269 bindings.ChannelManager_force_close_all_channels(this.ptr);
270 Reference.reachabilityFence(this);
274 * Sends a payment along a given route.
276 * Value parameters are provided via the last hop in route, see documentation for RouteHop
277 * fields for more info.
279 * Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
280 * payment), we don't do anything to stop you! We always try to ensure that if the provided
281 * next hop knows the preimage to payment_hash they can claim an additional amount as
282 * specified in the last hop in the route! Thus, you should probably do your own
283 * payment_preimage tracking (which you should already be doing as they represent \"proof of
284 * payment\") and prevent double-sends yourself.
286 * May generate SendHTLCs message(s) event on success, which should be relayed.
288 * Each path may have a different return value, and PaymentSendValue may return a Vec with
289 * each entry matching the corresponding-index entry in the route paths, see
290 * PaymentSendFailure for more info.
292 * In general, a path may raise:
293 * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
294 * node public key) is specified.
295 * APIError::ChannelUnavailable if the next-hop channel is not available for updates
296 * (including due to previous monitor update failure or new permanent monitor update
298 * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
301 * Note that depending on the type of the PaymentSendFailure the HTLC may have been
302 * irrevocably committed to on our end. In such a case, do NOT retry the payment with a
303 * different route unless you intend to pay twice!
305 * payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
306 * the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
307 * newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
308 * must not contain multiple paths as multi-path payments require a recipient-provided
310 * If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
311 * bit set (either as required or as available). If multiple paths are present in the Route,
312 * we assume the invoice had the basic_mpp feature set.
314 * Note that payment_secret (or a relevant inner pointer) may be NULL or all-0s to represent None
316 public Result_PaymentIdPaymentSendFailureZ send_payment(Route route, byte[] payment_hash, @Nullable byte[] payment_secret) {
317 long ret = bindings.ChannelManager_send_payment(this.ptr, route == null ? 0 : route.ptr & ~1, InternalUtils.check_arr_len(payment_hash, 32), InternalUtils.check_arr_len(payment_secret, 32));
318 Reference.reachabilityFence(this);
319 Reference.reachabilityFence(route);
320 Reference.reachabilityFence(payment_hash);
321 Reference.reachabilityFence(payment_secret);
322 if (ret >= 0 && ret <= 4096) { return null; }
323 Result_PaymentIdPaymentSendFailureZ ret_hu_conv = Result_PaymentIdPaymentSendFailureZ.constr_from_ptr(ret);
324 this.ptrs_to.add(route);
329 * Retries a payment along the given [`Route`].
331 * Errors returned are a superset of those returned from [`send_payment`], so see
332 * [`send_payment`] documentation for more details on errors. This method will also error if the
333 * retry amount puts the payment more than 10% over the payment's total amount, if the payment
334 * for the given `payment_id` cannot be found (likely due to timeout or success), or if
335 * further retries have been disabled with [`abandon_payment`].
337 * [`send_payment`]: [`ChannelManager::send_payment`]
338 * [`abandon_payment`]: [`ChannelManager::abandon_payment`]
340 public Result_NonePaymentSendFailureZ retry_payment(Route route, byte[] payment_id) {
341 long ret = bindings.ChannelManager_retry_payment(this.ptr, route == null ? 0 : route.ptr & ~1, InternalUtils.check_arr_len(payment_id, 32));
342 Reference.reachabilityFence(this);
343 Reference.reachabilityFence(route);
344 Reference.reachabilityFence(payment_id);
345 if (ret >= 0 && ret <= 4096) { return null; }
346 Result_NonePaymentSendFailureZ ret_hu_conv = Result_NonePaymentSendFailureZ.constr_from_ptr(ret);
347 this.ptrs_to.add(route);
352 * Signals that no further retries for the given payment will occur.
354 * After this method returns, any future calls to [`retry_payment`] for the given `payment_id`
355 * will fail with [`PaymentSendFailure::ParameterError`]. If no such event has been generated,
356 * an [`Event::PaymentFailed`] event will be generated as soon as there are no remaining
357 * pending HTLCs for this payment.
359 * Note that calling this method does *not* prevent a payment from succeeding. You must still
360 * wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
361 * determine the ultimate status of a payment.
363 * [`retry_payment`]: Self::retry_payment
364 * [`Event::PaymentFailed`]: events::Event::PaymentFailed
365 * [`Event::PaymentSent`]: events::Event::PaymentSent
367 public void abandon_payment(byte[] payment_id) {
368 bindings.ChannelManager_abandon_payment(this.ptr, InternalUtils.check_arr_len(payment_id, 32));
369 Reference.reachabilityFence(this);
370 Reference.reachabilityFence(payment_id);
374 * Send a spontaneous payment, which is a payment that does not require the recipient to have
375 * generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
376 * the preimage, it must be a cryptographically secure random value that no intermediate node
377 * would be able to guess -- otherwise, an intermediate node may claim the payment and it will
378 * never reach the recipient.
380 * See [`send_payment`] documentation for more details on the return value of this function.
382 * Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
383 * [`send_payment`] for more information about the risks of duplicate preimage usage.
385 * Note that `route` must have exactly one path.
387 * [`send_payment`]: Self::send_payment
389 * Note that payment_preimage (or a relevant inner pointer) may be NULL or all-0s to represent None
391 public Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ send_spontaneous_payment(Route route, @Nullable byte[] payment_preimage) {
392 long ret = bindings.ChannelManager_send_spontaneous_payment(this.ptr, route == null ? 0 : route.ptr & ~1, InternalUtils.check_arr_len(payment_preimage, 32));
393 Reference.reachabilityFence(this);
394 Reference.reachabilityFence(route);
395 Reference.reachabilityFence(payment_preimage);
396 if (ret >= 0 && ret <= 4096) { return null; }
397 Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ ret_hu_conv = Result_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ.constr_from_ptr(ret);
398 this.ptrs_to.add(route);
403 * Call this upon creation of a funding transaction for the given channel.
405 * Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
406 * or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
408 * Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
409 * for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
411 * May panic if the output found in the funding transaction is duplicative with some other
412 * channel (note that this should be trivially prevented by using unique funding transaction
415 * Do NOT broadcast the funding transaction yourself. When we have safely received our
416 * counterparty's signature the funding transaction will automatically be broadcast via the
417 * [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
419 * Note that this includes RBF or similar transaction replacement strategies - lightning does
420 * not currently support replacing a funding transaction on an existing channel. Instead,
421 * create a new channel with a conflicting funding transaction.
423 * [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
424 * [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
426 public Result_NoneAPIErrorZ funding_transaction_generated(byte[] temporary_channel_id, byte[] counterparty_node_id, byte[] funding_transaction) {
427 long ret = bindings.ChannelManager_funding_transaction_generated(this.ptr, InternalUtils.check_arr_len(temporary_channel_id, 32), InternalUtils.check_arr_len(counterparty_node_id, 33), funding_transaction);
428 Reference.reachabilityFence(this);
429 Reference.reachabilityFence(temporary_channel_id);
430 Reference.reachabilityFence(counterparty_node_id);
431 Reference.reachabilityFence(funding_transaction);
432 if (ret >= 0 && ret <= 4096) { return null; }
433 Result_NoneAPIErrorZ ret_hu_conv = Result_NoneAPIErrorZ.constr_from_ptr(ret);
438 * Regenerates channel_announcements and generates a signed node_announcement from the given
439 * arguments, providing them in corresponding events via
440 * [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
441 * on-chain. This effectively re-broadcasts all channel announcements and sends our node
442 * announcement to ensure that the lightning P2P network is aware of the channels we have and
443 * our network addresses.
445 * `rgb` is a node \"color\" and `alias` is a printable human-readable string to describe this
446 * node to humans. They carry no in-protocol meaning.
448 * `addresses` represent the set (possibly empty) of socket addresses on which this node
449 * accepts incoming connections. These will be included in the node_announcement, publicly
450 * tying these addresses together and to this node. If you wish to preserve user privacy,
451 * addresses should likely contain only Tor Onion addresses.
453 * Panics if `addresses` is absurdly large (more than 500).
455 * [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
457 public void broadcast_node_announcement(byte[] rgb, byte[] alias, NetAddress[] addresses) {
458 bindings.ChannelManager_broadcast_node_announcement(this.ptr, InternalUtils.check_arr_len(rgb, 3), InternalUtils.check_arr_len(alias, 32), addresses != null ? Arrays.stream(addresses).mapToLong(addresses_conv_12 -> addresses_conv_12.ptr).toArray() : null);
459 Reference.reachabilityFence(this);
460 Reference.reachabilityFence(rgb);
461 Reference.reachabilityFence(alias);
462 Reference.reachabilityFence(addresses);
466 * Processes HTLCs which are pending waiting on random forward delay.
468 * Should only really ever be called in response to a PendingHTLCsForwardable event.
469 * Will likely generate further events.
471 public void process_pending_htlc_forwards() {
472 bindings.ChannelManager_process_pending_htlc_forwards(this.ptr);
473 Reference.reachabilityFence(this);
477 * Performs actions which should happen on startup and roughly once per minute thereafter.
479 * This currently includes:
480 * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
481 * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
482 * than a minute, informing the network that they should no longer attempt to route over
485 * Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
488 public void timer_tick_occurred() {
489 bindings.ChannelManager_timer_tick_occurred(this.ptr);
490 Reference.reachabilityFence(this);
494 * Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
495 * after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
496 * along the path (including in our own channel on which we received it).
498 * Note that in some cases around unclean shutdown, it is possible the payment may have
499 * already been claimed by you via [`ChannelManager::claim_funds`] prior to you seeing (a
500 * second copy of) the [`events::Event::PaymentReceived`] event. Alternatively, the payment
501 * may have already been failed automatically by LDK if it was nearing its expiration time.
503 * While LDK will never claim a payment automatically on your behalf (i.e. without you calling
504 * [`ChannelManager::claim_funds`]), you should still monitor for
505 * [`events::Event::PaymentClaimed`] events even for payments you intend to fail, especially on
506 * startup during which time claims that were in-progress at shutdown may be replayed.
508 public void fail_htlc_backwards(byte[] payment_hash) {
509 bindings.ChannelManager_fail_htlc_backwards(this.ptr, InternalUtils.check_arr_len(payment_hash, 32));
510 Reference.reachabilityFence(this);
511 Reference.reachabilityFence(payment_hash);
515 * Provides a payment preimage in response to [`Event::PaymentReceived`], generating any
516 * [`MessageSendEvent`]s needed to claim the payment.
518 * Note that calling this method does *not* guarantee that the payment has been claimed. You
519 * must* wait for an [`Event::PaymentClaimed`] event which upon a successful claim will be
520 * provided to your [`EventHandler`] when [`process_pending_events`] is next called.
522 * Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
523 * [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
524 * event matches your expectation. If you fail to do so and call this method, you may provide
525 * the sender \"proof-of-payment\" when they did not fulfill the full expected payment.
527 * [`Event::PaymentReceived`]: crate::util::events::Event::PaymentReceived
528 * [`Event::PaymentClaimed`]: crate::util::events::Event::PaymentClaimed
529 * [`process_pending_events`]: EventsProvider::process_pending_events
530 * [`create_inbound_payment`]: Self::create_inbound_payment
531 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
532 * [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
534 public void claim_funds(byte[] payment_preimage) {
535 bindings.ChannelManager_claim_funds(this.ptr, InternalUtils.check_arr_len(payment_preimage, 32));
536 Reference.reachabilityFence(this);
537 Reference.reachabilityFence(payment_preimage);
541 * Gets the node_id held by this ChannelManager
543 public byte[] get_our_node_id() {
544 byte[] ret = bindings.ChannelManager_get_our_node_id(this.ptr);
545 Reference.reachabilityFence(this);
550 * Accepts a request to open a channel after a [`Event::OpenChannelRequest`].
552 * The `temporary_channel_id` parameter indicates which inbound channel should be accepted,
553 * and the `counterparty_node_id` parameter is the id of the peer which has requested to open
556 * The `user_channel_id` parameter will be provided back in
557 * [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
558 * with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
560 * Note that this method will return an error and reject the channel, if it requires support
561 * for zero confirmations. Instead, `accept_inbound_channel_from_trusted_peer_0conf` must be
562 * used to accept such channels.
564 * [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
565 * [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
567 public Result_NoneAPIErrorZ accept_inbound_channel(byte[] temporary_channel_id, byte[] counterparty_node_id, long user_channel_id) {
568 long ret = bindings.ChannelManager_accept_inbound_channel(this.ptr, InternalUtils.check_arr_len(temporary_channel_id, 32), InternalUtils.check_arr_len(counterparty_node_id, 33), user_channel_id);
569 Reference.reachabilityFence(this);
570 Reference.reachabilityFence(temporary_channel_id);
571 Reference.reachabilityFence(counterparty_node_id);
572 Reference.reachabilityFence(user_channel_id);
573 if (ret >= 0 && ret <= 4096) { return null; }
574 Result_NoneAPIErrorZ ret_hu_conv = Result_NoneAPIErrorZ.constr_from_ptr(ret);
579 * Accepts a request to open a channel after a [`events::Event::OpenChannelRequest`], treating
580 * it as confirmed immediately.
582 * The `user_channel_id` parameter will be provided back in
583 * [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
584 * with which `accept_inbound_channel`/`accept_inbound_channel_from_trusted_peer_0conf` call.
586 * Unlike [`ChannelManager::accept_inbound_channel`], this method accepts the incoming channel
587 * and (if the counterparty agrees), enables forwarding of payments immediately.
589 * This fully trusts that the counterparty has honestly and correctly constructed the funding
590 * transaction and blindly assumes that it will eventually confirm.
592 * If it does not confirm before we decide to close the channel, or if the funding transaction
593 * does not pay to the correct script the correct amount, *you will lose funds*.
595 * [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
596 * [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
598 public Result_NoneAPIErrorZ accept_inbound_channel_from_trusted_peer_0conf(byte[] temporary_channel_id, byte[] counterparty_node_id, long user_channel_id) {
599 long ret = bindings.ChannelManager_accept_inbound_channel_from_trusted_peer_0conf(this.ptr, InternalUtils.check_arr_len(temporary_channel_id, 32), InternalUtils.check_arr_len(counterparty_node_id, 33), user_channel_id);
600 Reference.reachabilityFence(this);
601 Reference.reachabilityFence(temporary_channel_id);
602 Reference.reachabilityFence(counterparty_node_id);
603 Reference.reachabilityFence(user_channel_id);
604 if (ret >= 0 && ret <= 4096) { return null; }
605 Result_NoneAPIErrorZ ret_hu_conv = Result_NoneAPIErrorZ.constr_from_ptr(ret);
610 * Gets a payment secret and payment hash for use in an invoice given to a third party wishing
613 * This differs from [`create_inbound_payment_for_hash`] only in that it generates the
614 * [`PaymentHash`] and [`PaymentPreimage`] for you.
616 * The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
617 * will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
618 * passed directly to [`claim_funds`].
620 * See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
622 * Note that a malicious eavesdropper can intuit whether an inbound payment was created by
623 * `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
627 * If you register an inbound payment with this method, then serialize the `ChannelManager`, then
628 * deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
630 * Errors if `min_value_msat` is greater than total bitcoin supply.
632 * [`claim_funds`]: Self::claim_funds
633 * [`PaymentReceived`]: events::Event::PaymentReceived
634 * [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
635 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
637 public Result_C2Tuple_PaymentHashPaymentSecretZNoneZ create_inbound_payment(Option_u64Z min_value_msat, int invoice_expiry_delta_secs) {
638 long ret = bindings.ChannelManager_create_inbound_payment(this.ptr, min_value_msat.ptr, invoice_expiry_delta_secs);
639 Reference.reachabilityFence(this);
640 Reference.reachabilityFence(min_value_msat);
641 Reference.reachabilityFence(invoice_expiry_delta_secs);
642 if (ret >= 0 && ret <= 4096) { return null; }
643 Result_C2Tuple_PaymentHashPaymentSecretZNoneZ ret_hu_conv = Result_C2Tuple_PaymentHashPaymentSecretZNoneZ.constr_from_ptr(ret);
648 * Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
649 * serialized state with LDK node(s) running 0.0.103 and earlier.
651 * May panic if `invoice_expiry_delta_secs` is greater than one year.
654 * This method is deprecated and will be removed soon.
656 * [`create_inbound_payment`]: Self::create_inbound_payment
658 public Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ create_inbound_payment_legacy(Option_u64Z min_value_msat, int invoice_expiry_delta_secs) {
659 long ret = bindings.ChannelManager_create_inbound_payment_legacy(this.ptr, min_value_msat.ptr, invoice_expiry_delta_secs);
660 Reference.reachabilityFence(this);
661 Reference.reachabilityFence(min_value_msat);
662 Reference.reachabilityFence(invoice_expiry_delta_secs);
663 if (ret >= 0 && ret <= 4096) { return null; }
664 Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ ret_hu_conv = Result_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ.constr_from_ptr(ret);
669 * Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
670 * stored external to LDK.
672 * A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
673 * payment secret fetched via this method or [`create_inbound_payment`], and which is at least
674 * the `min_value_msat` provided here, if one is provided.
676 * The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
677 * note that LDK will not stop you from registering duplicate payment hashes for inbound
680 * `min_value_msat` should be set if the invoice being generated contains a value. Any payment
681 * received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
682 * before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
683 * sender \"proof-of-payment\" unless they have paid the required amount.
685 * `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
686 * in excess of the current time. This should roughly match the expiry time set in the invoice.
687 * After this many seconds, we will remove the inbound payment, resulting in any attempts to
688 * pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
689 * invoices when no timeout is set.
691 * Note that we use block header time to time-out pending inbound payments (with some margin
692 * to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
693 * accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
694 * If you need exact expiry semantics, you should enforce them upon receipt of
695 * [`PaymentReceived`].
697 * Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
698 * set to at least [`MIN_FINAL_CLTV_EXPIRY`].
700 * Note that a malicious eavesdropper can intuit whether an inbound payment was created by
701 * `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
705 * If you register an inbound payment with this method, then serialize the `ChannelManager`, then
706 * deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
708 * Errors if `min_value_msat` is greater than total bitcoin supply.
710 * [`create_inbound_payment`]: Self::create_inbound_payment
711 * [`PaymentReceived`]: events::Event::PaymentReceived
713 public Result_PaymentSecretNoneZ create_inbound_payment_for_hash(byte[] payment_hash, Option_u64Z min_value_msat, int invoice_expiry_delta_secs) {
714 long ret = bindings.ChannelManager_create_inbound_payment_for_hash(this.ptr, InternalUtils.check_arr_len(payment_hash, 32), min_value_msat.ptr, invoice_expiry_delta_secs);
715 Reference.reachabilityFence(this);
716 Reference.reachabilityFence(payment_hash);
717 Reference.reachabilityFence(min_value_msat);
718 Reference.reachabilityFence(invoice_expiry_delta_secs);
719 if (ret >= 0 && ret <= 4096) { return null; }
720 Result_PaymentSecretNoneZ ret_hu_conv = Result_PaymentSecretNoneZ.constr_from_ptr(ret);
725 * Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
726 * serialized state with LDK node(s) running 0.0.103 and earlier.
728 * May panic if `invoice_expiry_delta_secs` is greater than one year.
731 * This method is deprecated and will be removed soon.
733 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
735 public Result_PaymentSecretAPIErrorZ create_inbound_payment_for_hash_legacy(byte[] payment_hash, Option_u64Z min_value_msat, int invoice_expiry_delta_secs) {
736 long ret = bindings.ChannelManager_create_inbound_payment_for_hash_legacy(this.ptr, InternalUtils.check_arr_len(payment_hash, 32), min_value_msat.ptr, invoice_expiry_delta_secs);
737 Reference.reachabilityFence(this);
738 Reference.reachabilityFence(payment_hash);
739 Reference.reachabilityFence(min_value_msat);
740 Reference.reachabilityFence(invoice_expiry_delta_secs);
741 if (ret >= 0 && ret <= 4096) { return null; }
742 Result_PaymentSecretAPIErrorZ ret_hu_conv = Result_PaymentSecretAPIErrorZ.constr_from_ptr(ret);
747 * Gets an LDK-generated payment preimage from a payment hash and payment secret that were
748 * previously returned from [`create_inbound_payment`].
750 * [`create_inbound_payment`]: Self::create_inbound_payment
752 public Result_PaymentPreimageAPIErrorZ get_payment_preimage(byte[] payment_hash, byte[] payment_secret) {
753 long ret = bindings.ChannelManager_get_payment_preimage(this.ptr, InternalUtils.check_arr_len(payment_hash, 32), InternalUtils.check_arr_len(payment_secret, 32));
754 Reference.reachabilityFence(this);
755 Reference.reachabilityFence(payment_hash);
756 Reference.reachabilityFence(payment_secret);
757 if (ret >= 0 && ret <= 4096) { return null; }
758 Result_PaymentPreimageAPIErrorZ ret_hu_conv = Result_PaymentPreimageAPIErrorZ.constr_from_ptr(ret);
763 * Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
764 * are used when constructing the phantom invoice's route hints.
766 * [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
768 public long get_phantom_scid() {
769 long ret = bindings.ChannelManager_get_phantom_scid(this.ptr);
770 Reference.reachabilityFence(this);
775 * Gets route hints for use in receiving [phantom node payments].
777 * [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
779 public PhantomRouteHints get_phantom_route_hints() {
780 long ret = bindings.ChannelManager_get_phantom_route_hints(this.ptr);
781 Reference.reachabilityFence(this);
782 if (ret >= 0 && ret <= 4096) { return null; }
783 org.ldk.structs.PhantomRouteHints ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.PhantomRouteHints(null, ret); }
784 ret_hu_conv.ptrs_to.add(this);
789 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
790 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
792 public MessageSendEventsProvider as_MessageSendEventsProvider() {
793 long ret = bindings.ChannelManager_as_MessageSendEventsProvider(this.ptr);
794 Reference.reachabilityFence(this);
795 if (ret >= 0 && ret <= 4096) { return null; }
796 MessageSendEventsProvider ret_hu_conv = new MessageSendEventsProvider(null, ret);
797 ret_hu_conv.ptrs_to.add(this);
802 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
803 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
805 public EventsProvider as_EventsProvider() {
806 long ret = bindings.ChannelManager_as_EventsProvider(this.ptr);
807 Reference.reachabilityFence(this);
808 if (ret >= 0 && ret <= 4096) { return null; }
809 EventsProvider ret_hu_conv = new EventsProvider(null, ret);
810 ret_hu_conv.ptrs_to.add(this);
815 * Constructs a new Listen which calls the relevant methods on this_arg.
816 * This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
818 public Listen as_Listen() {
819 long ret = bindings.ChannelManager_as_Listen(this.ptr);
820 Reference.reachabilityFence(this);
821 if (ret >= 0 && ret <= 4096) { return null; }
822 Listen ret_hu_conv = new Listen(null, ret);
823 ret_hu_conv.ptrs_to.add(this);
828 * Constructs a new Confirm which calls the relevant methods on this_arg.
829 * This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
831 public Confirm as_Confirm() {
832 long ret = bindings.ChannelManager_as_Confirm(this.ptr);
833 Reference.reachabilityFence(this);
834 if (ret >= 0 && ret <= 4096) { return null; }
835 Confirm ret_hu_conv = new Confirm(null, ret);
836 ret_hu_conv.ptrs_to.add(this);
841 * Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
842 * indicating whether persistence is necessary. Only one listener on
843 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
846 * Note that this method is not available with the `no-std` feature.
848 public boolean await_persistable_update_timeout(long max_wait) {
849 boolean ret = bindings.ChannelManager_await_persistable_update_timeout(this.ptr, max_wait);
850 Reference.reachabilityFence(this);
851 Reference.reachabilityFence(max_wait);
856 * Blocks until ChannelManager needs to be persisted. Only one listener on
857 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
860 public void await_persistable_update() {
861 bindings.ChannelManager_await_persistable_update(this.ptr);
862 Reference.reachabilityFence(this);
866 * Gets the latest best block which was connected either via the [`chain::Listen`] or
867 * [`chain::Confirm`] interfaces.
869 public BestBlock current_best_block() {
870 long ret = bindings.ChannelManager_current_best_block(this.ptr);
871 Reference.reachabilityFence(this);
872 if (ret >= 0 && ret <= 4096) { return null; }
873 org.ldk.structs.BestBlock ret_hu_conv = null; if (ret < 0 || ret > 4096) { ret_hu_conv = new org.ldk.structs.BestBlock(null, ret); }
874 ret_hu_conv.ptrs_to.add(this);
879 * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
880 * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
882 public ChannelMessageHandler as_ChannelMessageHandler() {
883 long ret = bindings.ChannelManager_as_ChannelMessageHandler(this.ptr);
884 Reference.reachabilityFence(this);
885 if (ret >= 0 && ret <= 4096) { return null; }
886 ChannelMessageHandler ret_hu_conv = new ChannelMessageHandler(null, ret);
887 ret_hu_conv.ptrs_to.add(this);
892 * Serialize the ChannelManager object into a byte array which can be read by ChannelManager_read
894 public byte[] write() {
895 byte[] ret = bindings.ChannelManager_write(this.ptr);
896 Reference.reachabilityFence(this);
901 * Constructs a new Payer which calls the relevant methods on this_arg.
902 * This copies the `inner` pointer in this_arg and thus the returned Payer must be freed before this_arg is
904 public Payer as_Payer() {
905 long ret = bindings.ChannelManager_as_Payer(this.ptr);
906 Reference.reachabilityFence(this);
907 if (ret >= 0 && ret <= 4096) { return null; }
908 Payer ret_hu_conv = new Payer(null, ret);
909 ret_hu_conv.ptrs_to.add(this);