1 #ifndef LDK_C_BINDINGS_H
2 #define LDK_C_BINDINGS_H
4 /* Generated with cbindgen:0.20.0 */
6 /* Warning, this file is autogenerated by cbindgen. Don't modify this manually. */
11 #include "ldk_rust_types.h"
14 * An error when accessing the chain via [`Access`].
16 typedef enum LDKAccessError {
18 * The requested chain is unknown.
20 LDKAccessError_UnknownChain,
22 * The requested transaction doesn't exist or hasn't confirmed.
24 LDKAccessError_UnknownTx,
26 * Must be last for serialization purposes
28 LDKAccessError_Sentinel,
32 * An enum which can either contain a or not
34 typedef enum LDKCOption_NoneZ {
36 * When we're in this state, this COption_NoneZ contains a
38 LDKCOption_NoneZ_Some,
40 * When we're in this state, this COption_NoneZ contains nothing
42 LDKCOption_NoneZ_None,
44 * Must be last for serialization purposes
46 LDKCOption_NoneZ_Sentinel,
50 * An error enum representing a failure to persist a channel monitor update.
52 typedef enum LDKChannelMonitorUpdateErr {
54 * Used to indicate a temporary failure (eg connection to a watchtower or remote backup of
55 * our state failed, but is expected to succeed at some point in the future).
57 * Such a failure will \"freeze\" a channel, preventing us from revoking old states or
58 * submitting new commitment transactions to the counterparty. Once the update(s) that failed
59 * have been successfully applied, a [`MonitorEvent::UpdateCompleted`] event should be returned
60 * via [`Watch::release_pending_monitor_events`] which will then restore the channel to an
63 * Note that a given ChannelManager will *never* re-generate a given ChannelMonitorUpdate. If
64 * you return a TemporaryFailure you must ensure that it is written to disk safely before
65 * writing out the latest ChannelManager state.
67 * Even when a channel has been \"frozen\" updates to the ChannelMonitor can continue to occur
68 * (eg if an inbound HTLC which we forwarded was claimed upstream resulting in us attempting
69 * to claim it on this channel) and those updates must be applied wherever they can be. At
70 * least one such updated ChannelMonitor must be persisted otherwise PermanentFailure should
71 * be returned to get things on-chain ASAP using only the in-memory copy. Obviously updates to
72 * the channel which would invalidate previous ChannelMonitors are not made when a channel has
75 * Note that even if updates made after TemporaryFailure succeed you must still provide a
76 * [`MonitorEvent::UpdateCompleted`] to ensure you have the latest monitor and re-enable
77 * normal channel operation. Note that this is normally generated through a call to
78 * [`ChainMonitor::channel_monitor_updated`].
80 * Note that the update being processed here will not be replayed for you when you return a
81 * [`MonitorEvent::UpdateCompleted`] event via [`Watch::release_pending_monitor_events`], so
82 * you must store the update itself on your own local disk prior to returning a
83 * TemporaryFailure. You may, of course, employ a journaling approach, storing only the
84 * ChannelMonitorUpdate on disk without updating the monitor itself, replaying the journal at
87 * For deployments where a copy of ChannelMonitors and other local state are backed up in a
88 * remote location (with local copies persisted immediately), it is anticipated that all
89 * updates will return TemporaryFailure until the remote copies could be updated.
91 * [`ChainMonitor::channel_monitor_updated`]: chainmonitor::ChainMonitor::channel_monitor_updated
93 LDKChannelMonitorUpdateErr_TemporaryFailure,
95 * Used to indicate no further channel monitor updates will be allowed (eg we've moved on to a
96 * different watchtower and cannot update with all watchtowers that were previously informed
99 * At reception of this error, ChannelManager will force-close the channel and return at
100 * least a final ChannelMonitorUpdate::ChannelForceClosed which must be delivered to at
101 * least one ChannelMonitor copy. Revocation secret MUST NOT be released and offchain channel
102 * update must be rejected.
104 * This failure may also signal a failure to update the local persisted copy of one of
105 * the channel monitor instance.
107 * Note that even when you fail a holder commitment transaction update, you must store the
108 * update to ensure you can claim from it in case of a duplicate copy of this ChannelMonitor
109 * broadcasts it (e.g distributed channel-monitor deployment)
111 * In case of distributed watchtowers deployment, the new version must be written to disk, as
112 * state may have been stored but rejected due to a block forcing a commitment broadcast. This
113 * storage is used to claim outputs of rejected state confirmed onchain by another watchtower,
114 * lagging behind on block processing.
116 LDKChannelMonitorUpdateErr_PermanentFailure,
118 * Must be last for serialization purposes
120 LDKChannelMonitorUpdateErr_Sentinel,
121 } LDKChannelMonitorUpdateErr;
124 * An enum that represents the speed at which we want a transaction to confirm used for feerate
127 typedef enum LDKConfirmationTarget {
129 * We are happy with this transaction confirming slowly when feerate drops some.
131 LDKConfirmationTarget_Background,
133 * We'd like this transaction to confirm without major delay, but 12-18 blocks is fine.
135 LDKConfirmationTarget_Normal,
137 * We'd like this transaction to confirm in the next few blocks.
139 LDKConfirmationTarget_HighPriority,
141 * Must be last for serialization purposes
143 LDKConfirmationTarget_Sentinel,
144 } LDKConfirmationTarget;
147 * Errors that may occur when constructing a new `RawInvoice` or `Invoice`
149 typedef enum LDKCreationError {
151 * The supplied description string was longer than 639 __bytes__ (see [`Description::new(…)`](./struct.Description.html#method.new))
153 LDKCreationError_DescriptionTooLong,
155 * The specified route has too many hops and can't be encoded
157 LDKCreationError_RouteTooLong,
159 * The Unix timestamp of the supplied date is less than zero or greater than 35-bits
161 LDKCreationError_TimestampOutOfBounds,
163 * The supplied millisatoshi amount was greater than the total bitcoin supply.
165 LDKCreationError_InvalidAmount,
167 * Route hints were required for this invoice and were missing. Applies to
168 * [phantom invoices].
170 * [phantom invoices]: crate::utils::create_phantom_invoice
172 LDKCreationError_MissingRouteHints,
174 * Must be last for serialization purposes
176 LDKCreationError_Sentinel,
180 * Enum representing the crypto currencies (or networks) supported by this library
182 typedef enum LDKCurrency {
190 LDKCurrency_BitcoinTestnet,
204 * Must be last for serialization purposes
206 LDKCurrency_Sentinel,
210 * Represents an IO Error. Note that some information is lost in the conversion from Rust.
212 typedef enum LDKIOError {
214 LDKIOError_PermissionDenied,
215 LDKIOError_ConnectionRefused,
216 LDKIOError_ConnectionReset,
217 LDKIOError_ConnectionAborted,
218 LDKIOError_NotConnected,
219 LDKIOError_AddrInUse,
220 LDKIOError_AddrNotAvailable,
221 LDKIOError_BrokenPipe,
222 LDKIOError_AlreadyExists,
223 LDKIOError_WouldBlock,
224 LDKIOError_InvalidInput,
225 LDKIOError_InvalidData,
227 LDKIOError_WriteZero,
228 LDKIOError_Interrupted,
230 LDKIOError_UnexpectedEof,
232 * Must be last for serialization purposes
238 * An enum representing the available verbosity levels of the logger.
240 typedef enum LDKLevel {
242 * Designates extremely verbose information, including gossip-induced messages
246 * Designates very low priority, often extremely verbose, information
250 * Designates lower priority information
254 * Designates useful information
258 * Designates hazardous situations
262 * Designates very serious errors
266 * Must be last for serialization purposes
272 * An enum representing the possible Bitcoin or test networks which we can run on
274 typedef enum LDKNetwork {
276 * The main Bitcoin blockchain.
280 * The testnet3 blockchain.
284 * A local test blockchain.
288 * A blockchain on which blocks are signed instead of mined.
292 * Must be last for serialization purposes
298 * Specifies the recipient of an invoice, to indicate to [`KeysInterface::sign_invoice`] what node
299 * secret key should be used to sign the invoice.
301 typedef enum LDKRecipient {
303 * The invoice should be signed with the local node secret key.
307 * The invoice should be signed with the phantom node secret key. This secret key must be the
308 * same for all nodes participating in the [phantom node payment].
310 * [phantom node payment]: PhantomKeysManager
312 LDKRecipient_PhantomNode,
314 * Must be last for serialization purposes
316 LDKRecipient_Sentinel,
320 * Represents an error returned from libsecp256k1 during validation of some secp256k1 data
322 typedef enum LDKSecp256k1Error {
324 * Signature failed verification
326 LDKSecp256k1Error_IncorrectSignature,
328 * Badly sized message ("messages" are actually fixed-sized digests; see the MESSAGE_SIZE constant)
330 LDKSecp256k1Error_InvalidMessage,
334 LDKSecp256k1Error_InvalidPublicKey,
338 LDKSecp256k1Error_InvalidSignature,
342 LDKSecp256k1Error_InvalidSecretKey,
346 LDKSecp256k1Error_InvalidRecoveryId,
348 * Invalid tweak for add_assign or mul_assign
350 LDKSecp256k1Error_InvalidTweak,
352 * tweak_add_check failed on an xonly public key
354 LDKSecp256k1Error_TweakCheckFailed,
356 * Didn't pass enough memory to context creation with preallocated memory
358 LDKSecp256k1Error_NotEnoughMemory,
360 * Must be last for serialization purposes
362 LDKSecp256k1Error_Sentinel,
366 * Errors that may occur when converting a `RawInvoice` to an `Invoice`. They relate to the
367 * requirements sections in BOLT #11
369 typedef enum LDKSemanticError {
371 * The invoice is missing the mandatory payment hash
373 LDKSemanticError_NoPaymentHash,
375 * The invoice has multiple payment hashes which isn't allowed
377 LDKSemanticError_MultiplePaymentHashes,
379 * No description or description hash are part of the invoice
381 LDKSemanticError_NoDescription,
383 * The invoice contains multiple descriptions and/or description hashes which isn't allowed
385 LDKSemanticError_MultipleDescriptions,
387 * The invoice is missing the mandatory payment secret, which all modern lightning nodes
390 LDKSemanticError_NoPaymentSecret,
392 * The invoice contains multiple payment secrets
394 LDKSemanticError_MultiplePaymentSecrets,
396 * The invoice's features are invalid
398 LDKSemanticError_InvalidFeatures,
400 * The recovery id doesn't fit the signature/pub key
402 LDKSemanticError_InvalidRecoveryId,
404 * The invoice's signature is invalid
406 LDKSemanticError_InvalidSignature,
408 * The invoice's amount was not a whole number of millisatoshis
410 LDKSemanticError_ImpreciseAmount,
412 * Must be last for serialization purposes
414 LDKSemanticError_Sentinel,
418 * SI prefixes for the human readable part
420 typedef enum LDKSiPrefix {
438 * Must be last for serialization purposes
440 LDKSiPrefix_Sentinel,
444 * A Rust str object, ie a reference to a UTF8-valid string.
445 * This is *not* null-terminated so cannot be used directly as a C string!
447 typedef struct LDKStr {
449 * A pointer to the string's bytes, in UTF8 encoding
451 const uint8_t *chars;
453 * The number of bytes (not characters!) pointed to by `chars`
457 * Whether the data pointed to by `chars` should be freed or not.
463 * A serialized transaction, in (pointer, length) form.
465 * This type optionally owns its own memory, and thus the semantics around access change based on
466 * the `data_is_owned` flag. If `data_is_owned` is set, you must call `Transaction_free` to free
467 * the underlying buffer before the object goes out of scope. If `data_is_owned` is not set, any
468 * access to the buffer after the scope in which the object was provided to you is invalid. eg,
469 * access after you return from the call in which a `!data_is_owned` `Transaction` is provided to
470 * you would be invalid.
472 * Note that, while it may change in the future, because transactions on the Rust side are stored
473 * in a deserialized form, all `Transaction`s generated on the Rust side will have `data_is_owned`
474 * set. Similarly, while it may change in the future, all `Transaction`s you pass to Rust may have
475 * `data_is_owned` either set or unset at your discretion.
477 typedef struct LDKTransaction {
479 * The serialized transaction data.
481 * This is non-const for your convenience, an object passed to Rust is never written to.
485 * The length of the serialized transaction
489 * Whether the data pointed to by `data` should be freed or not.
495 * A dynamically-allocated array of u8s of arbitrary size.
496 * This corresponds to std::vector in C++
498 typedef struct LDKCVec_u8Z {
500 * The elements in the array.
501 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
505 * The number of elements pointed to by `data`.
511 * A transaction output including a scriptPubKey and value.
512 * This type *does* own its own memory, so must be free'd appropriately.
514 typedef struct LDKTxOut {
516 * The script_pubkey in this output
518 struct LDKCVec_u8Z script_pubkey;
520 * The value, in satoshis, of this output
526 * The contents of CResult_NoneNoneZ
528 typedef union LDKCResult_NoneNoneZPtr {
530 * Note that this value is always NULL, as there are no contents in the OK variant
534 * Note that this value is always NULL, as there are no contents in the Err variant
537 } LDKCResult_NoneNoneZPtr;
540 * A CResult_NoneNoneZ represents the result of a fallible operation,
541 * containing a () on success and a () on failure.
542 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
544 typedef struct LDKCResult_NoneNoneZ {
546 * The contents of this CResult_NoneNoneZ, accessible via either
547 * `err` or `result` depending on the state of `result_ok`.
549 union LDKCResult_NoneNoneZPtr contents;
551 * Whether this CResult_NoneNoneZ represents a success state.
554 } LDKCResult_NoneNoneZ;
559 * Implements the per-commitment secret storage scheme from
560 * [BOLT 3](https://github.com/lightningnetwork/lightning-rfc/blob/dcbf8583976df087c79c3ce0b535311212e6812d/03-transactions.md#efficient-per-commitment-secret-storage).
562 * Allows us to keep track of all of the revocation secrets of our counterparty in just 50*32 bytes
565 typedef struct MUST_USE_STRUCT LDKCounterpartyCommitmentSecrets {
567 * A pointer to the opaque Rust object.
568 * Nearly everywhere, inner must be non-null, however in places where
569 * the Rust equivalent takes an Option, it may be set to null to indicate None.
571 LDKnativeCounterpartyCommitmentSecrets *inner;
573 * Indicates that this is the only struct which contains the same pointer.
574 * Rust functions which take ownership of an object provided via an argument require
575 * this to be true and invalidate the object pointed to by inner.
578 } LDKCounterpartyCommitmentSecrets;
583 * An error in decoding a message or struct.
585 typedef struct MUST_USE_STRUCT LDKDecodeError {
587 * A pointer to the opaque Rust object.
588 * Nearly everywhere, inner must be non-null, however in places where
589 * the Rust equivalent takes an Option, it may be set to null to indicate None.
591 LDKnativeDecodeError *inner;
593 * Indicates that this is the only struct which contains the same pointer.
594 * Rust functions which take ownership of an object provided via an argument require
595 * this to be true and invalidate the object pointed to by inner.
601 * The contents of CResult_CounterpartyCommitmentSecretsDecodeErrorZ
603 typedef union LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZPtr {
605 * A pointer to the contents in the success state.
606 * Reading from this pointer when `result_ok` is not set is undefined.
608 struct LDKCounterpartyCommitmentSecrets *result;
610 * A pointer to the contents in the error state.
611 * Reading from this pointer when `result_ok` is set is undefined.
613 struct LDKDecodeError *err;
614 } LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZPtr;
617 * A CResult_CounterpartyCommitmentSecretsDecodeErrorZ represents the result of a fallible operation,
618 * containing a crate::lightning::ln::chan_utils::CounterpartyCommitmentSecrets on success and a crate::lightning::ln::msgs::DecodeError on failure.
619 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
621 typedef struct LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZ {
623 * The contents of this CResult_CounterpartyCommitmentSecretsDecodeErrorZ, accessible via either
624 * `err` or `result` depending on the state of `result_ok`.
626 union LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZPtr contents;
628 * Whether this CResult_CounterpartyCommitmentSecretsDecodeErrorZ represents a success state.
631 } LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZ;
634 * Represents a valid secp256k1 secret key serialized as a 32 byte array.
636 typedef struct LDKSecretKey {
638 * The bytes of the secret key
644 * The contents of CResult_SecretKeyErrorZ
646 typedef union LDKCResult_SecretKeyErrorZPtr {
648 * A pointer to the contents in the success state.
649 * Reading from this pointer when `result_ok` is not set is undefined.
651 struct LDKSecretKey *result;
653 * A pointer to the contents in the error state.
654 * Reading from this pointer when `result_ok` is set is undefined.
656 enum LDKSecp256k1Error *err;
657 } LDKCResult_SecretKeyErrorZPtr;
660 * A CResult_SecretKeyErrorZ represents the result of a fallible operation,
661 * containing a crate::c_types::SecretKey on success and a crate::c_types::Secp256k1Error on failure.
662 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
664 typedef struct LDKCResult_SecretKeyErrorZ {
666 * The contents of this CResult_SecretKeyErrorZ, accessible via either
667 * `err` or `result` depending on the state of `result_ok`.
669 union LDKCResult_SecretKeyErrorZPtr contents;
671 * Whether this CResult_SecretKeyErrorZ represents a success state.
674 } LDKCResult_SecretKeyErrorZ;
677 * Represents a valid secp256k1 public key serialized in "compressed form" as a 33 byte array.
679 typedef struct LDKPublicKey {
681 * The bytes of the public key
683 uint8_t compressed_form[33];
687 * The contents of CResult_PublicKeyErrorZ
689 typedef union LDKCResult_PublicKeyErrorZPtr {
691 * A pointer to the contents in the success state.
692 * Reading from this pointer when `result_ok` is not set is undefined.
694 struct LDKPublicKey *result;
696 * A pointer to the contents in the error state.
697 * Reading from this pointer when `result_ok` is set is undefined.
699 enum LDKSecp256k1Error *err;
700 } LDKCResult_PublicKeyErrorZPtr;
703 * A CResult_PublicKeyErrorZ represents the result of a fallible operation,
704 * containing a crate::c_types::PublicKey on success and a crate::c_types::Secp256k1Error on failure.
705 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
707 typedef struct LDKCResult_PublicKeyErrorZ {
709 * The contents of this CResult_PublicKeyErrorZ, accessible via either
710 * `err` or `result` depending on the state of `result_ok`.
712 union LDKCResult_PublicKeyErrorZPtr contents;
714 * Whether this CResult_PublicKeyErrorZ represents a success state.
717 } LDKCResult_PublicKeyErrorZ;
722 * The set of public keys which are used in the creation of one commitment transaction.
723 * These are derived from the channel base keys and per-commitment data.
725 * A broadcaster key is provided from potential broadcaster of the computed transaction.
726 * A countersignatory key is coming from a protocol participant unable to broadcast the
729 * These keys are assumed to be good, either because the code derived them from
730 * channel basepoints via the new function, or they were obtained via
731 * CommitmentTransaction.trust().keys() because we trusted the source of the
732 * pre-calculated keys.
734 typedef struct MUST_USE_STRUCT LDKTxCreationKeys {
736 * A pointer to the opaque Rust object.
737 * Nearly everywhere, inner must be non-null, however in places where
738 * the Rust equivalent takes an Option, it may be set to null to indicate None.
740 LDKnativeTxCreationKeys *inner;
742 * Indicates that this is the only struct which contains the same pointer.
743 * Rust functions which take ownership of an object provided via an argument require
744 * this to be true and invalidate the object pointed to by inner.
750 * The contents of CResult_TxCreationKeysDecodeErrorZ
752 typedef union LDKCResult_TxCreationKeysDecodeErrorZPtr {
754 * A pointer to the contents in the success state.
755 * Reading from this pointer when `result_ok` is not set is undefined.
757 struct LDKTxCreationKeys *result;
759 * A pointer to the contents in the error state.
760 * Reading from this pointer when `result_ok` is set is undefined.
762 struct LDKDecodeError *err;
763 } LDKCResult_TxCreationKeysDecodeErrorZPtr;
766 * A CResult_TxCreationKeysDecodeErrorZ represents the result of a fallible operation,
767 * containing a crate::lightning::ln::chan_utils::TxCreationKeys on success and a crate::lightning::ln::msgs::DecodeError on failure.
768 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
770 typedef struct LDKCResult_TxCreationKeysDecodeErrorZ {
772 * The contents of this CResult_TxCreationKeysDecodeErrorZ, accessible via either
773 * `err` or `result` depending on the state of `result_ok`.
775 union LDKCResult_TxCreationKeysDecodeErrorZPtr contents;
777 * Whether this CResult_TxCreationKeysDecodeErrorZ represents a success state.
780 } LDKCResult_TxCreationKeysDecodeErrorZ;
785 * One counterparty's public keys which do not change over the life of a channel.
787 typedef struct MUST_USE_STRUCT LDKChannelPublicKeys {
789 * A pointer to the opaque Rust object.
790 * Nearly everywhere, inner must be non-null, however in places where
791 * the Rust equivalent takes an Option, it may be set to null to indicate None.
793 LDKnativeChannelPublicKeys *inner;
795 * Indicates that this is the only struct which contains the same pointer.
796 * Rust functions which take ownership of an object provided via an argument require
797 * this to be true and invalidate the object pointed to by inner.
800 } LDKChannelPublicKeys;
803 * The contents of CResult_ChannelPublicKeysDecodeErrorZ
805 typedef union LDKCResult_ChannelPublicKeysDecodeErrorZPtr {
807 * A pointer to the contents in the success state.
808 * Reading from this pointer when `result_ok` is not set is undefined.
810 struct LDKChannelPublicKeys *result;
812 * A pointer to the contents in the error state.
813 * Reading from this pointer when `result_ok` is set is undefined.
815 struct LDKDecodeError *err;
816 } LDKCResult_ChannelPublicKeysDecodeErrorZPtr;
819 * A CResult_ChannelPublicKeysDecodeErrorZ represents the result of a fallible operation,
820 * containing a crate::lightning::ln::chan_utils::ChannelPublicKeys on success and a crate::lightning::ln::msgs::DecodeError on failure.
821 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
823 typedef struct LDKCResult_ChannelPublicKeysDecodeErrorZ {
825 * The contents of this CResult_ChannelPublicKeysDecodeErrorZ, accessible via either
826 * `err` or `result` depending on the state of `result_ok`.
828 union LDKCResult_ChannelPublicKeysDecodeErrorZPtr contents;
830 * Whether this CResult_ChannelPublicKeysDecodeErrorZ represents a success state.
833 } LDKCResult_ChannelPublicKeysDecodeErrorZ;
836 * The contents of CResult_TxCreationKeysErrorZ
838 typedef union LDKCResult_TxCreationKeysErrorZPtr {
840 * A pointer to the contents in the success state.
841 * Reading from this pointer when `result_ok` is not set is undefined.
843 struct LDKTxCreationKeys *result;
845 * A pointer to the contents in the error state.
846 * Reading from this pointer when `result_ok` is set is undefined.
848 enum LDKSecp256k1Error *err;
849 } LDKCResult_TxCreationKeysErrorZPtr;
852 * A CResult_TxCreationKeysErrorZ represents the result of a fallible operation,
853 * containing a crate::lightning::ln::chan_utils::TxCreationKeys on success and a crate::c_types::Secp256k1Error on failure.
854 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
856 typedef struct LDKCResult_TxCreationKeysErrorZ {
858 * The contents of this CResult_TxCreationKeysErrorZ, accessible via either
859 * `err` or `result` depending on the state of `result_ok`.
861 union LDKCResult_TxCreationKeysErrorZPtr contents;
863 * Whether this CResult_TxCreationKeysErrorZ represents a success state.
866 } LDKCResult_TxCreationKeysErrorZ;
869 * An enum which can either contain a u32 or not
871 typedef enum LDKCOption_u32Z_Tag {
873 * When we're in this state, this COption_u32Z contains a u32
875 LDKCOption_u32Z_Some,
877 * When we're in this state, this COption_u32Z contains nothing
879 LDKCOption_u32Z_None,
881 * Must be last for serialization purposes
883 LDKCOption_u32Z_Sentinel,
884 } LDKCOption_u32Z_Tag;
886 typedef struct LDKCOption_u32Z {
887 LDKCOption_u32Z_Tag tag;
898 * Information about an HTLC as it appears in a commitment transaction
900 typedef struct MUST_USE_STRUCT LDKHTLCOutputInCommitment {
902 * A pointer to the opaque Rust object.
903 * Nearly everywhere, inner must be non-null, however in places where
904 * the Rust equivalent takes an Option, it may be set to null to indicate None.
906 LDKnativeHTLCOutputInCommitment *inner;
908 * Indicates that this is the only struct which contains the same pointer.
909 * Rust functions which take ownership of an object provided via an argument require
910 * this to be true and invalidate the object pointed to by inner.
913 } LDKHTLCOutputInCommitment;
916 * The contents of CResult_HTLCOutputInCommitmentDecodeErrorZ
918 typedef union LDKCResult_HTLCOutputInCommitmentDecodeErrorZPtr {
920 * A pointer to the contents in the success state.
921 * Reading from this pointer when `result_ok` is not set is undefined.
923 struct LDKHTLCOutputInCommitment *result;
925 * A pointer to the contents in the error state.
926 * Reading from this pointer when `result_ok` is set is undefined.
928 struct LDKDecodeError *err;
929 } LDKCResult_HTLCOutputInCommitmentDecodeErrorZPtr;
932 * A CResult_HTLCOutputInCommitmentDecodeErrorZ represents the result of a fallible operation,
933 * containing a crate::lightning::ln::chan_utils::HTLCOutputInCommitment on success and a crate::lightning::ln::msgs::DecodeError on failure.
934 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
936 typedef struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ {
938 * The contents of this CResult_HTLCOutputInCommitmentDecodeErrorZ, accessible via either
939 * `err` or `result` depending on the state of `result_ok`.
941 union LDKCResult_HTLCOutputInCommitmentDecodeErrorZPtr contents;
943 * Whether this CResult_HTLCOutputInCommitmentDecodeErrorZ represents a success state.
946 } LDKCResult_HTLCOutputInCommitmentDecodeErrorZ;
951 * Late-bound per-channel counterparty data used to build transactions.
953 typedef struct MUST_USE_STRUCT LDKCounterpartyChannelTransactionParameters {
955 * A pointer to the opaque Rust object.
956 * Nearly everywhere, inner must be non-null, however in places where
957 * the Rust equivalent takes an Option, it may be set to null to indicate None.
959 LDKnativeCounterpartyChannelTransactionParameters *inner;
961 * Indicates that this is the only struct which contains the same pointer.
962 * Rust functions which take ownership of an object provided via an argument require
963 * this to be true and invalidate the object pointed to by inner.
966 } LDKCounterpartyChannelTransactionParameters;
969 * The contents of CResult_CounterpartyChannelTransactionParametersDecodeErrorZ
971 typedef union LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZPtr {
973 * A pointer to the contents in the success state.
974 * Reading from this pointer when `result_ok` is not set is undefined.
976 struct LDKCounterpartyChannelTransactionParameters *result;
978 * A pointer to the contents in the error state.
979 * Reading from this pointer when `result_ok` is set is undefined.
981 struct LDKDecodeError *err;
982 } LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZPtr;
985 * A CResult_CounterpartyChannelTransactionParametersDecodeErrorZ represents the result of a fallible operation,
986 * containing a crate::lightning::ln::chan_utils::CounterpartyChannelTransactionParameters on success and a crate::lightning::ln::msgs::DecodeError on failure.
987 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
989 typedef struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ {
991 * The contents of this CResult_CounterpartyChannelTransactionParametersDecodeErrorZ, accessible via either
992 * `err` or `result` depending on the state of `result_ok`.
994 union LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZPtr contents;
996 * Whether this CResult_CounterpartyChannelTransactionParametersDecodeErrorZ represents a success state.
999 } LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ;
1004 * Per-channel data used to build transactions in conjunction with the per-commitment data (CommitmentTransaction).
1005 * The fields are organized by holder/counterparty.
1007 * Normally, this is converted to the broadcaster/countersignatory-organized DirectedChannelTransactionParameters
1008 * before use, via the as_holder_broadcastable and as_counterparty_broadcastable functions.
1010 typedef struct MUST_USE_STRUCT LDKChannelTransactionParameters {
1012 * A pointer to the opaque Rust object.
1013 * Nearly everywhere, inner must be non-null, however in places where
1014 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1016 LDKnativeChannelTransactionParameters *inner;
1018 * Indicates that this is the only struct which contains the same pointer.
1019 * Rust functions which take ownership of an object provided via an argument require
1020 * this to be true and invalidate the object pointed to by inner.
1023 } LDKChannelTransactionParameters;
1026 * The contents of CResult_ChannelTransactionParametersDecodeErrorZ
1028 typedef union LDKCResult_ChannelTransactionParametersDecodeErrorZPtr {
1030 * A pointer to the contents in the success state.
1031 * Reading from this pointer when `result_ok` is not set is undefined.
1033 struct LDKChannelTransactionParameters *result;
1035 * A pointer to the contents in the error state.
1036 * Reading from this pointer when `result_ok` is set is undefined.
1038 struct LDKDecodeError *err;
1039 } LDKCResult_ChannelTransactionParametersDecodeErrorZPtr;
1042 * A CResult_ChannelTransactionParametersDecodeErrorZ represents the result of a fallible operation,
1043 * containing a crate::lightning::ln::chan_utils::ChannelTransactionParameters on success and a crate::lightning::ln::msgs::DecodeError on failure.
1044 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1046 typedef struct LDKCResult_ChannelTransactionParametersDecodeErrorZ {
1048 * The contents of this CResult_ChannelTransactionParametersDecodeErrorZ, accessible via either
1049 * `err` or `result` depending on the state of `result_ok`.
1051 union LDKCResult_ChannelTransactionParametersDecodeErrorZPtr contents;
1053 * Whether this CResult_ChannelTransactionParametersDecodeErrorZ represents a success state.
1056 } LDKCResult_ChannelTransactionParametersDecodeErrorZ;
1059 * Represents a secp256k1 signature serialized as two 32-byte numbers
1061 typedef struct LDKSignature {
1063 * The bytes of the signature in "compact" form
1065 uint8_t compact_form[64];
1069 * A dynamically-allocated array of crate::c_types::Signatures of arbitrary size.
1070 * This corresponds to std::vector in C++
1072 typedef struct LDKCVec_SignatureZ {
1074 * The elements in the array.
1075 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1077 struct LDKSignature *data;
1079 * The number of elements pointed to by `data`.
1082 } LDKCVec_SignatureZ;
1087 * Information needed to build and sign a holder's commitment transaction.
1089 * The transaction is only signed once we are ready to broadcast.
1091 typedef struct MUST_USE_STRUCT LDKHolderCommitmentTransaction {
1093 * A pointer to the opaque Rust object.
1094 * Nearly everywhere, inner must be non-null, however in places where
1095 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1097 LDKnativeHolderCommitmentTransaction *inner;
1099 * Indicates that this is the only struct which contains the same pointer.
1100 * Rust functions which take ownership of an object provided via an argument require
1101 * this to be true and invalidate the object pointed to by inner.
1104 } LDKHolderCommitmentTransaction;
1107 * The contents of CResult_HolderCommitmentTransactionDecodeErrorZ
1109 typedef union LDKCResult_HolderCommitmentTransactionDecodeErrorZPtr {
1111 * A pointer to the contents in the success state.
1112 * Reading from this pointer when `result_ok` is not set is undefined.
1114 struct LDKHolderCommitmentTransaction *result;
1116 * A pointer to the contents in the error state.
1117 * Reading from this pointer when `result_ok` is set is undefined.
1119 struct LDKDecodeError *err;
1120 } LDKCResult_HolderCommitmentTransactionDecodeErrorZPtr;
1123 * A CResult_HolderCommitmentTransactionDecodeErrorZ represents the result of a fallible operation,
1124 * containing a crate::lightning::ln::chan_utils::HolderCommitmentTransaction on success and a crate::lightning::ln::msgs::DecodeError on failure.
1125 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1127 typedef struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ {
1129 * The contents of this CResult_HolderCommitmentTransactionDecodeErrorZ, accessible via either
1130 * `err` or `result` depending on the state of `result_ok`.
1132 union LDKCResult_HolderCommitmentTransactionDecodeErrorZPtr contents;
1134 * Whether this CResult_HolderCommitmentTransactionDecodeErrorZ represents a success state.
1137 } LDKCResult_HolderCommitmentTransactionDecodeErrorZ;
1142 * A pre-built Bitcoin commitment transaction and its txid.
1144 typedef struct MUST_USE_STRUCT LDKBuiltCommitmentTransaction {
1146 * A pointer to the opaque Rust object.
1147 * Nearly everywhere, inner must be non-null, however in places where
1148 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1150 LDKnativeBuiltCommitmentTransaction *inner;
1152 * Indicates that this is the only struct which contains the same pointer.
1153 * Rust functions which take ownership of an object provided via an argument require
1154 * this to be true and invalidate the object pointed to by inner.
1157 } LDKBuiltCommitmentTransaction;
1160 * The contents of CResult_BuiltCommitmentTransactionDecodeErrorZ
1162 typedef union LDKCResult_BuiltCommitmentTransactionDecodeErrorZPtr {
1164 * A pointer to the contents in the success state.
1165 * Reading from this pointer when `result_ok` is not set is undefined.
1167 struct LDKBuiltCommitmentTransaction *result;
1169 * A pointer to the contents in the error state.
1170 * Reading from this pointer when `result_ok` is set is undefined.
1172 struct LDKDecodeError *err;
1173 } LDKCResult_BuiltCommitmentTransactionDecodeErrorZPtr;
1176 * A CResult_BuiltCommitmentTransactionDecodeErrorZ represents the result of a fallible operation,
1177 * containing a crate::lightning::ln::chan_utils::BuiltCommitmentTransaction on success and a crate::lightning::ln::msgs::DecodeError on failure.
1178 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1180 typedef struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ {
1182 * The contents of this CResult_BuiltCommitmentTransactionDecodeErrorZ, accessible via either
1183 * `err` or `result` depending on the state of `result_ok`.
1185 union LDKCResult_BuiltCommitmentTransactionDecodeErrorZPtr contents;
1187 * Whether this CResult_BuiltCommitmentTransactionDecodeErrorZ represents a success state.
1190 } LDKCResult_BuiltCommitmentTransactionDecodeErrorZ;
1195 * A wrapper on ClosingTransaction indicating that the built bitcoin
1196 * transaction is trusted.
1198 * See trust() and verify() functions on CommitmentTransaction.
1200 * This structure implements Deref.
1202 typedef struct MUST_USE_STRUCT LDKTrustedClosingTransaction {
1204 * A pointer to the opaque Rust object.
1205 * Nearly everywhere, inner must be non-null, however in places where
1206 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1208 LDKnativeTrustedClosingTransaction *inner;
1210 * Indicates that this is the only struct which contains the same pointer.
1211 * Rust functions which take ownership of an object provided via an argument require
1212 * this to be true and invalidate the object pointed to by inner.
1215 } LDKTrustedClosingTransaction;
1218 * The contents of CResult_TrustedClosingTransactionNoneZ
1220 typedef union LDKCResult_TrustedClosingTransactionNoneZPtr {
1222 * A pointer to the contents in the success state.
1223 * Reading from this pointer when `result_ok` is not set is undefined.
1225 struct LDKTrustedClosingTransaction *result;
1227 * Note that this value is always NULL, as there are no contents in the Err variant
1230 } LDKCResult_TrustedClosingTransactionNoneZPtr;
1233 * A CResult_TrustedClosingTransactionNoneZ represents the result of a fallible operation,
1234 * containing a crate::lightning::ln::chan_utils::TrustedClosingTransaction on success and a () on failure.
1235 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1237 typedef struct LDKCResult_TrustedClosingTransactionNoneZ {
1239 * The contents of this CResult_TrustedClosingTransactionNoneZ, accessible via either
1240 * `err` or `result` depending on the state of `result_ok`.
1242 union LDKCResult_TrustedClosingTransactionNoneZPtr contents;
1244 * Whether this CResult_TrustedClosingTransactionNoneZ represents a success state.
1247 } LDKCResult_TrustedClosingTransactionNoneZ;
1252 * This class tracks the per-transaction information needed to build a commitment transaction and will
1253 * actually build it and sign. It is used for holder transactions that we sign only when needed
1254 * and for transactions we sign for the counterparty.
1256 * This class can be used inside a signer implementation to generate a signature given the relevant
1259 typedef struct MUST_USE_STRUCT LDKCommitmentTransaction {
1261 * A pointer to the opaque Rust object.
1262 * Nearly everywhere, inner must be non-null, however in places where
1263 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1265 LDKnativeCommitmentTransaction *inner;
1267 * Indicates that this is the only struct which contains the same pointer.
1268 * Rust functions which take ownership of an object provided via an argument require
1269 * this to be true and invalidate the object pointed to by inner.
1272 } LDKCommitmentTransaction;
1275 * The contents of CResult_CommitmentTransactionDecodeErrorZ
1277 typedef union LDKCResult_CommitmentTransactionDecodeErrorZPtr {
1279 * A pointer to the contents in the success state.
1280 * Reading from this pointer when `result_ok` is not set is undefined.
1282 struct LDKCommitmentTransaction *result;
1284 * A pointer to the contents in the error state.
1285 * Reading from this pointer when `result_ok` is set is undefined.
1287 struct LDKDecodeError *err;
1288 } LDKCResult_CommitmentTransactionDecodeErrorZPtr;
1291 * A CResult_CommitmentTransactionDecodeErrorZ represents the result of a fallible operation,
1292 * containing a crate::lightning::ln::chan_utils::CommitmentTransaction on success and a crate::lightning::ln::msgs::DecodeError on failure.
1293 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1295 typedef struct LDKCResult_CommitmentTransactionDecodeErrorZ {
1297 * The contents of this CResult_CommitmentTransactionDecodeErrorZ, accessible via either
1298 * `err` or `result` depending on the state of `result_ok`.
1300 union LDKCResult_CommitmentTransactionDecodeErrorZPtr contents;
1302 * Whether this CResult_CommitmentTransactionDecodeErrorZ represents a success state.
1305 } LDKCResult_CommitmentTransactionDecodeErrorZ;
1310 * A wrapper on CommitmentTransaction indicating that the derived fields (the built bitcoin
1311 * transaction and the transaction creation keys) are trusted.
1313 * See trust() and verify() functions on CommitmentTransaction.
1315 * This structure implements Deref.
1317 typedef struct MUST_USE_STRUCT LDKTrustedCommitmentTransaction {
1319 * A pointer to the opaque Rust object.
1320 * Nearly everywhere, inner must be non-null, however in places where
1321 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1323 LDKnativeTrustedCommitmentTransaction *inner;
1325 * Indicates that this is the only struct which contains the same pointer.
1326 * Rust functions which take ownership of an object provided via an argument require
1327 * this to be true and invalidate the object pointed to by inner.
1330 } LDKTrustedCommitmentTransaction;
1333 * The contents of CResult_TrustedCommitmentTransactionNoneZ
1335 typedef union LDKCResult_TrustedCommitmentTransactionNoneZPtr {
1337 * A pointer to the contents in the success state.
1338 * Reading from this pointer when `result_ok` is not set is undefined.
1340 struct LDKTrustedCommitmentTransaction *result;
1342 * Note that this value is always NULL, as there are no contents in the Err variant
1345 } LDKCResult_TrustedCommitmentTransactionNoneZPtr;
1348 * A CResult_TrustedCommitmentTransactionNoneZ represents the result of a fallible operation,
1349 * containing a crate::lightning::ln::chan_utils::TrustedCommitmentTransaction on success and a () on failure.
1350 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1352 typedef struct LDKCResult_TrustedCommitmentTransactionNoneZ {
1354 * The contents of this CResult_TrustedCommitmentTransactionNoneZ, accessible via either
1355 * `err` or `result` depending on the state of `result_ok`.
1357 union LDKCResult_TrustedCommitmentTransactionNoneZPtr contents;
1359 * Whether this CResult_TrustedCommitmentTransactionNoneZ represents a success state.
1362 } LDKCResult_TrustedCommitmentTransactionNoneZ;
1365 * The contents of CResult_CVec_SignatureZNoneZ
1367 typedef union LDKCResult_CVec_SignatureZNoneZPtr {
1369 * A pointer to the contents in the success state.
1370 * Reading from this pointer when `result_ok` is not set is undefined.
1372 struct LDKCVec_SignatureZ *result;
1374 * Note that this value is always NULL, as there are no contents in the Err variant
1377 } LDKCResult_CVec_SignatureZNoneZPtr;
1380 * A CResult_CVec_SignatureZNoneZ represents the result of a fallible operation,
1381 * containing a crate::c_types::derived::CVec_SignatureZ on success and a () on failure.
1382 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1384 typedef struct LDKCResult_CVec_SignatureZNoneZ {
1386 * The contents of this CResult_CVec_SignatureZNoneZ, accessible via either
1387 * `err` or `result` depending on the state of `result_ok`.
1389 union LDKCResult_CVec_SignatureZNoneZPtr contents;
1391 * Whether this CResult_CVec_SignatureZNoneZ represents a success state.
1394 } LDKCResult_CVec_SignatureZNoneZ;
1399 * A script pubkey for shutting down a channel as defined by [BOLT #2].
1401 * [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
1403 typedef struct MUST_USE_STRUCT LDKShutdownScript {
1405 * A pointer to the opaque Rust object.
1406 * Nearly everywhere, inner must be non-null, however in places where
1407 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1409 LDKnativeShutdownScript *inner;
1411 * Indicates that this is the only struct which contains the same pointer.
1412 * Rust functions which take ownership of an object provided via an argument require
1413 * this to be true and invalidate the object pointed to by inner.
1416 } LDKShutdownScript;
1419 * The contents of CResult_ShutdownScriptDecodeErrorZ
1421 typedef union LDKCResult_ShutdownScriptDecodeErrorZPtr {
1423 * A pointer to the contents in the success state.
1424 * Reading from this pointer when `result_ok` is not set is undefined.
1426 struct LDKShutdownScript *result;
1428 * A pointer to the contents in the error state.
1429 * Reading from this pointer when `result_ok` is set is undefined.
1431 struct LDKDecodeError *err;
1432 } LDKCResult_ShutdownScriptDecodeErrorZPtr;
1435 * A CResult_ShutdownScriptDecodeErrorZ represents the result of a fallible operation,
1436 * containing a crate::lightning::ln::script::ShutdownScript on success and a crate::lightning::ln::msgs::DecodeError on failure.
1437 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1439 typedef struct LDKCResult_ShutdownScriptDecodeErrorZ {
1441 * The contents of this CResult_ShutdownScriptDecodeErrorZ, accessible via either
1442 * `err` or `result` depending on the state of `result_ok`.
1444 union LDKCResult_ShutdownScriptDecodeErrorZPtr contents;
1446 * Whether this CResult_ShutdownScriptDecodeErrorZ represents a success state.
1449 } LDKCResult_ShutdownScriptDecodeErrorZ;
1454 * An error occurring when converting from [`Script`] to [`ShutdownScript`].
1456 typedef struct MUST_USE_STRUCT LDKInvalidShutdownScript {
1458 * A pointer to the opaque Rust object.
1459 * Nearly everywhere, inner must be non-null, however in places where
1460 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1462 LDKnativeInvalidShutdownScript *inner;
1464 * Indicates that this is the only struct which contains the same pointer.
1465 * Rust functions which take ownership of an object provided via an argument require
1466 * this to be true and invalidate the object pointed to by inner.
1469 } LDKInvalidShutdownScript;
1472 * The contents of CResult_ShutdownScriptInvalidShutdownScriptZ
1474 typedef union LDKCResult_ShutdownScriptInvalidShutdownScriptZPtr {
1476 * A pointer to the contents in the success state.
1477 * Reading from this pointer when `result_ok` is not set is undefined.
1479 struct LDKShutdownScript *result;
1481 * A pointer to the contents in the error state.
1482 * Reading from this pointer when `result_ok` is set is undefined.
1484 struct LDKInvalidShutdownScript *err;
1485 } LDKCResult_ShutdownScriptInvalidShutdownScriptZPtr;
1488 * A CResult_ShutdownScriptInvalidShutdownScriptZ represents the result of a fallible operation,
1489 * containing a crate::lightning::ln::script::ShutdownScript on success and a crate::lightning::ln::script::InvalidShutdownScript on failure.
1490 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1492 typedef struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ {
1494 * The contents of this CResult_ShutdownScriptInvalidShutdownScriptZ, accessible via either
1495 * `err` or `result` depending on the state of `result_ok`.
1497 union LDKCResult_ShutdownScriptInvalidShutdownScriptZPtr contents;
1499 * Whether this CResult_ShutdownScriptInvalidShutdownScriptZ represents a success state.
1502 } LDKCResult_ShutdownScriptInvalidShutdownScriptZ;
1505 * The contents of CResult_NoneErrorZ
1507 typedef union LDKCResult_NoneErrorZPtr {
1509 * Note that this value is always NULL, as there are no contents in the OK variant
1513 * A pointer to the contents in the error state.
1514 * Reading from this pointer when `result_ok` is set is undefined.
1516 enum LDKIOError *err;
1517 } LDKCResult_NoneErrorZPtr;
1520 * A CResult_NoneErrorZ represents the result of a fallible operation,
1521 * containing a () on success and a crate::c_types::IOError on failure.
1522 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1524 typedef struct LDKCResult_NoneErrorZ {
1526 * The contents of this CResult_NoneErrorZ, accessible via either
1527 * `err` or `result` depending on the state of `result_ok`.
1529 union LDKCResult_NoneErrorZPtr contents;
1531 * Whether this CResult_NoneErrorZ represents a success state.
1534 } LDKCResult_NoneErrorZ;
1541 typedef struct MUST_USE_STRUCT LDKRouteHop {
1543 * A pointer to the opaque Rust object.
1544 * Nearly everywhere, inner must be non-null, however in places where
1545 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1547 LDKnativeRouteHop *inner;
1549 * Indicates that this is the only struct which contains the same pointer.
1550 * Rust functions which take ownership of an object provided via an argument require
1551 * this to be true and invalidate the object pointed to by inner.
1557 * The contents of CResult_RouteHopDecodeErrorZ
1559 typedef union LDKCResult_RouteHopDecodeErrorZPtr {
1561 * A pointer to the contents in the success state.
1562 * Reading from this pointer when `result_ok` is not set is undefined.
1564 struct LDKRouteHop *result;
1566 * A pointer to the contents in the error state.
1567 * Reading from this pointer when `result_ok` is set is undefined.
1569 struct LDKDecodeError *err;
1570 } LDKCResult_RouteHopDecodeErrorZPtr;
1573 * A CResult_RouteHopDecodeErrorZ represents the result of a fallible operation,
1574 * containing a crate::lightning::routing::router::RouteHop on success and a crate::lightning::ln::msgs::DecodeError on failure.
1575 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1577 typedef struct LDKCResult_RouteHopDecodeErrorZ {
1579 * The contents of this CResult_RouteHopDecodeErrorZ, accessible via either
1580 * `err` or `result` depending on the state of `result_ok`.
1582 union LDKCResult_RouteHopDecodeErrorZPtr contents;
1584 * Whether this CResult_RouteHopDecodeErrorZ represents a success state.
1587 } LDKCResult_RouteHopDecodeErrorZ;
1590 * A dynamically-allocated array of crate::lightning::routing::router::RouteHops of arbitrary size.
1591 * This corresponds to std::vector in C++
1593 typedef struct LDKCVec_RouteHopZ {
1595 * The elements in the array.
1596 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1598 struct LDKRouteHop *data;
1600 * The number of elements pointed to by `data`.
1603 } LDKCVec_RouteHopZ;
1606 * A dynamically-allocated array of crate::c_types::derived::CVec_RouteHopZs of arbitrary size.
1607 * This corresponds to std::vector in C++
1609 typedef struct LDKCVec_CVec_RouteHopZZ {
1611 * The elements in the array.
1612 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1614 struct LDKCVec_RouteHopZ *data;
1616 * The number of elements pointed to by `data`.
1619 } LDKCVec_CVec_RouteHopZZ;
1624 * A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
1625 * it can take multiple paths. Each path is composed of one or more hops through the network.
1627 typedef struct MUST_USE_STRUCT LDKRoute {
1629 * A pointer to the opaque Rust object.
1630 * Nearly everywhere, inner must be non-null, however in places where
1631 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1633 LDKnativeRoute *inner;
1635 * Indicates that this is the only struct which contains the same pointer.
1636 * Rust functions which take ownership of an object provided via an argument require
1637 * this to be true and invalidate the object pointed to by inner.
1643 * The contents of CResult_RouteDecodeErrorZ
1645 typedef union LDKCResult_RouteDecodeErrorZPtr {
1647 * A pointer to the contents in the success state.
1648 * Reading from this pointer when `result_ok` is not set is undefined.
1650 struct LDKRoute *result;
1652 * A pointer to the contents in the error state.
1653 * Reading from this pointer when `result_ok` is set is undefined.
1655 struct LDKDecodeError *err;
1656 } LDKCResult_RouteDecodeErrorZPtr;
1659 * A CResult_RouteDecodeErrorZ represents the result of a fallible operation,
1660 * containing a crate::lightning::routing::router::Route on success and a crate::lightning::ln::msgs::DecodeError on failure.
1661 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1663 typedef struct LDKCResult_RouteDecodeErrorZ {
1665 * The contents of this CResult_RouteDecodeErrorZ, accessible via either
1666 * `err` or `result` depending on the state of `result_ok`.
1668 union LDKCResult_RouteDecodeErrorZPtr contents;
1670 * Whether this CResult_RouteDecodeErrorZ represents a success state.
1673 } LDKCResult_RouteDecodeErrorZ;
1678 * Parameters needed to find a [`Route`].
1680 * Passed to [`find_route`] and also provided in [`Event::PaymentPathFailed`] for retrying a failed
1683 * [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
1685 typedef struct MUST_USE_STRUCT LDKRouteParameters {
1687 * A pointer to the opaque Rust object.
1688 * Nearly everywhere, inner must be non-null, however in places where
1689 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1691 LDKnativeRouteParameters *inner;
1693 * Indicates that this is the only struct which contains the same pointer.
1694 * Rust functions which take ownership of an object provided via an argument require
1695 * this to be true and invalidate the object pointed to by inner.
1698 } LDKRouteParameters;
1701 * The contents of CResult_RouteParametersDecodeErrorZ
1703 typedef union LDKCResult_RouteParametersDecodeErrorZPtr {
1705 * A pointer to the contents in the success state.
1706 * Reading from this pointer when `result_ok` is not set is undefined.
1708 struct LDKRouteParameters *result;
1710 * A pointer to the contents in the error state.
1711 * Reading from this pointer when `result_ok` is set is undefined.
1713 struct LDKDecodeError *err;
1714 } LDKCResult_RouteParametersDecodeErrorZPtr;
1717 * A CResult_RouteParametersDecodeErrorZ represents the result of a fallible operation,
1718 * containing a crate::lightning::routing::router::RouteParameters on success and a crate::lightning::ln::msgs::DecodeError on failure.
1719 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1721 typedef struct LDKCResult_RouteParametersDecodeErrorZ {
1723 * The contents of this CResult_RouteParametersDecodeErrorZ, accessible via either
1724 * `err` or `result` depending on the state of `result_ok`.
1726 union LDKCResult_RouteParametersDecodeErrorZPtr contents;
1728 * Whether this CResult_RouteParametersDecodeErrorZ represents a success state.
1731 } LDKCResult_RouteParametersDecodeErrorZ;
1736 * A list of hops along a payment path terminating with a channel to the recipient.
1738 typedef struct MUST_USE_STRUCT LDKRouteHint {
1740 * A pointer to the opaque Rust object.
1741 * Nearly everywhere, inner must be non-null, however in places where
1742 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1744 LDKnativeRouteHint *inner;
1746 * Indicates that this is the only struct which contains the same pointer.
1747 * Rust functions which take ownership of an object provided via an argument require
1748 * this to be true and invalidate the object pointed to by inner.
1754 * A dynamically-allocated array of crate::lightning::routing::router::RouteHints of arbitrary size.
1755 * This corresponds to std::vector in C++
1757 typedef struct LDKCVec_RouteHintZ {
1759 * The elements in the array.
1760 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1762 struct LDKRouteHint *data;
1764 * The number of elements pointed to by `data`.
1767 } LDKCVec_RouteHintZ;
1770 * An enum which can either contain a u64 or not
1772 typedef enum LDKCOption_u64Z_Tag {
1774 * When we're in this state, this COption_u64Z contains a u64
1776 LDKCOption_u64Z_Some,
1778 * When we're in this state, this COption_u64Z contains nothing
1780 LDKCOption_u64Z_None,
1782 * Must be last for serialization purposes
1784 LDKCOption_u64Z_Sentinel,
1785 } LDKCOption_u64Z_Tag;
1787 typedef struct LDKCOption_u64Z {
1788 LDKCOption_u64Z_Tag tag;
1799 * The recipient of a payment.
1801 typedef struct MUST_USE_STRUCT LDKPaymentParameters {
1803 * A pointer to the opaque Rust object.
1804 * Nearly everywhere, inner must be non-null, however in places where
1805 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1807 LDKnativePaymentParameters *inner;
1809 * Indicates that this is the only struct which contains the same pointer.
1810 * Rust functions which take ownership of an object provided via an argument require
1811 * this to be true and invalidate the object pointed to by inner.
1814 } LDKPaymentParameters;
1817 * The contents of CResult_PaymentParametersDecodeErrorZ
1819 typedef union LDKCResult_PaymentParametersDecodeErrorZPtr {
1821 * A pointer to the contents in the success state.
1822 * Reading from this pointer when `result_ok` is not set is undefined.
1824 struct LDKPaymentParameters *result;
1826 * A pointer to the contents in the error state.
1827 * Reading from this pointer when `result_ok` is set is undefined.
1829 struct LDKDecodeError *err;
1830 } LDKCResult_PaymentParametersDecodeErrorZPtr;
1833 * A CResult_PaymentParametersDecodeErrorZ represents the result of a fallible operation,
1834 * containing a crate::lightning::routing::router::PaymentParameters on success and a crate::lightning::ln::msgs::DecodeError on failure.
1835 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1837 typedef struct LDKCResult_PaymentParametersDecodeErrorZ {
1839 * The contents of this CResult_PaymentParametersDecodeErrorZ, accessible via either
1840 * `err` or `result` depending on the state of `result_ok`.
1842 union LDKCResult_PaymentParametersDecodeErrorZPtr contents;
1844 * Whether this CResult_PaymentParametersDecodeErrorZ represents a success state.
1847 } LDKCResult_PaymentParametersDecodeErrorZ;
1852 * A channel descriptor for a hop along a payment path.
1854 typedef struct MUST_USE_STRUCT LDKRouteHintHop {
1856 * A pointer to the opaque Rust object.
1857 * Nearly everywhere, inner must be non-null, however in places where
1858 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1860 LDKnativeRouteHintHop *inner;
1862 * Indicates that this is the only struct which contains the same pointer.
1863 * Rust functions which take ownership of an object provided via an argument require
1864 * this to be true and invalidate the object pointed to by inner.
1870 * A dynamically-allocated array of crate::lightning::routing::router::RouteHintHops of arbitrary size.
1871 * This corresponds to std::vector in C++
1873 typedef struct LDKCVec_RouteHintHopZ {
1875 * The elements in the array.
1876 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1878 struct LDKRouteHintHop *data;
1880 * The number of elements pointed to by `data`.
1883 } LDKCVec_RouteHintHopZ;
1886 * The contents of CResult_RouteHintDecodeErrorZ
1888 typedef union LDKCResult_RouteHintDecodeErrorZPtr {
1890 * A pointer to the contents in the success state.
1891 * Reading from this pointer when `result_ok` is not set is undefined.
1893 struct LDKRouteHint *result;
1895 * A pointer to the contents in the error state.
1896 * Reading from this pointer when `result_ok` is set is undefined.
1898 struct LDKDecodeError *err;
1899 } LDKCResult_RouteHintDecodeErrorZPtr;
1902 * A CResult_RouteHintDecodeErrorZ represents the result of a fallible operation,
1903 * containing a crate::lightning::routing::router::RouteHint on success and a crate::lightning::ln::msgs::DecodeError on failure.
1904 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1906 typedef struct LDKCResult_RouteHintDecodeErrorZ {
1908 * The contents of this CResult_RouteHintDecodeErrorZ, accessible via either
1909 * `err` or `result` depending on the state of `result_ok`.
1911 union LDKCResult_RouteHintDecodeErrorZPtr contents;
1913 * Whether this CResult_RouteHintDecodeErrorZ represents a success state.
1916 } LDKCResult_RouteHintDecodeErrorZ;
1919 * The contents of CResult_RouteHintHopDecodeErrorZ
1921 typedef union LDKCResult_RouteHintHopDecodeErrorZPtr {
1923 * A pointer to the contents in the success state.
1924 * Reading from this pointer when `result_ok` is not set is undefined.
1926 struct LDKRouteHintHop *result;
1928 * A pointer to the contents in the error state.
1929 * Reading from this pointer when `result_ok` is set is undefined.
1931 struct LDKDecodeError *err;
1932 } LDKCResult_RouteHintHopDecodeErrorZPtr;
1935 * A CResult_RouteHintHopDecodeErrorZ represents the result of a fallible operation,
1936 * containing a crate::lightning::routing::router::RouteHintHop on success and a crate::lightning::ln::msgs::DecodeError on failure.
1937 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1939 typedef struct LDKCResult_RouteHintHopDecodeErrorZ {
1941 * The contents of this CResult_RouteHintHopDecodeErrorZ, accessible via either
1942 * `err` or `result` depending on the state of `result_ok`.
1944 union LDKCResult_RouteHintHopDecodeErrorZPtr contents;
1946 * Whether this CResult_RouteHintHopDecodeErrorZ represents a success state.
1949 } LDKCResult_RouteHintHopDecodeErrorZ;
1954 * Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
1956 typedef struct MUST_USE_STRUCT LDKChannelDetails {
1958 * A pointer to the opaque Rust object.
1959 * Nearly everywhere, inner must be non-null, however in places where
1960 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1962 LDKnativeChannelDetails *inner;
1964 * Indicates that this is the only struct which contains the same pointer.
1965 * Rust functions which take ownership of an object provided via an argument require
1966 * this to be true and invalidate the object pointed to by inner.
1969 } LDKChannelDetails;
1972 * A dynamically-allocated array of crate::lightning::ln::channelmanager::ChannelDetailss of arbitrary size.
1973 * This corresponds to std::vector in C++
1975 typedef struct LDKCVec_ChannelDetailsZ {
1977 * The elements in the array.
1978 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1980 struct LDKChannelDetails *data;
1982 * The number of elements pointed to by `data`.
1985 } LDKCVec_ChannelDetailsZ;
1990 * An Err type for failure to process messages.
1992 typedef struct MUST_USE_STRUCT LDKLightningError {
1994 * A pointer to the opaque Rust object.
1995 * Nearly everywhere, inner must be non-null, however in places where
1996 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1998 LDKnativeLightningError *inner;
2000 * Indicates that this is the only struct which contains the same pointer.
2001 * Rust functions which take ownership of an object provided via an argument require
2002 * this to be true and invalidate the object pointed to by inner.
2005 } LDKLightningError;
2008 * The contents of CResult_RouteLightningErrorZ
2010 typedef union LDKCResult_RouteLightningErrorZPtr {
2012 * A pointer to the contents in the success state.
2013 * Reading from this pointer when `result_ok` is not set is undefined.
2015 struct LDKRoute *result;
2017 * A pointer to the contents in the error state.
2018 * Reading from this pointer when `result_ok` is set is undefined.
2020 struct LDKLightningError *err;
2021 } LDKCResult_RouteLightningErrorZPtr;
2024 * A CResult_RouteLightningErrorZ represents the result of a fallible operation,
2025 * containing a crate::lightning::routing::router::Route on success and a crate::lightning::ln::msgs::LightningError on failure.
2026 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2028 typedef struct LDKCResult_RouteLightningErrorZ {
2030 * The contents of this CResult_RouteLightningErrorZ, accessible via either
2031 * `err` or `result` depending on the state of `result_ok`.
2033 union LDKCResult_RouteLightningErrorZPtr contents;
2035 * Whether this CResult_RouteLightningErrorZ represents a success state.
2038 } LDKCResult_RouteLightningErrorZ;
2041 * The contents of CResult_TxOutAccessErrorZ
2043 typedef union LDKCResult_TxOutAccessErrorZPtr {
2045 * A pointer to the contents in the success state.
2046 * Reading from this pointer when `result_ok` is not set is undefined.
2048 struct LDKTxOut *result;
2050 * A pointer to the contents in the error state.
2051 * Reading from this pointer when `result_ok` is set is undefined.
2053 enum LDKAccessError *err;
2054 } LDKCResult_TxOutAccessErrorZPtr;
2057 * A CResult_TxOutAccessErrorZ represents the result of a fallible operation,
2058 * containing a crate::c_types::TxOut on success and a crate::lightning::chain::AccessError on failure.
2059 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2061 typedef struct LDKCResult_TxOutAccessErrorZ {
2063 * The contents of this CResult_TxOutAccessErrorZ, accessible via either
2064 * `err` or `result` depending on the state of `result_ok`.
2066 union LDKCResult_TxOutAccessErrorZPtr contents;
2068 * Whether this CResult_TxOutAccessErrorZ represents a success state.
2071 } LDKCResult_TxOutAccessErrorZ;
2074 * A tuple of 2 elements. See the individual fields for the types contained.
2076 typedef struct LDKC2Tuple_usizeTransactionZ {
2078 * The element at position 0
2082 * The element at position 1
2084 struct LDKTransaction b;
2085 } LDKC2Tuple_usizeTransactionZ;
2088 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_usizeTransactionZs of arbitrary size.
2089 * This corresponds to std::vector in C++
2091 typedef struct LDKCVec_C2Tuple_usizeTransactionZZ {
2093 * The elements in the array.
2094 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
2096 struct LDKC2Tuple_usizeTransactionZ *data;
2098 * The number of elements pointed to by `data`.
2101 } LDKCVec_C2Tuple_usizeTransactionZZ;
2104 * Arbitrary 32 bytes, which could represent one of a few different things. You probably want to
2105 * look up the corresponding function in rust-lightning's docs.
2107 typedef struct LDKThirtyTwoBytes {
2109 * The thirty-two bytes
2112 } LDKThirtyTwoBytes;
2115 * A dynamically-allocated array of crate::c_types::ThirtyTwoBytess of arbitrary size.
2116 * This corresponds to std::vector in C++
2118 typedef struct LDKCVec_TxidZ {
2120 * The elements in the array.
2121 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
2123 struct LDKThirtyTwoBytes *data;
2125 * The number of elements pointed to by `data`.
2131 * The contents of CResult_NoneChannelMonitorUpdateErrZ
2133 typedef union LDKCResult_NoneChannelMonitorUpdateErrZPtr {
2135 * Note that this value is always NULL, as there are no contents in the OK variant
2139 * A pointer to the contents in the error state.
2140 * Reading from this pointer when `result_ok` is set is undefined.
2142 enum LDKChannelMonitorUpdateErr *err;
2143 } LDKCResult_NoneChannelMonitorUpdateErrZPtr;
2146 * A CResult_NoneChannelMonitorUpdateErrZ represents the result of a fallible operation,
2147 * containing a () on success and a crate::lightning::chain::ChannelMonitorUpdateErr on failure.
2148 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2150 typedef struct LDKCResult_NoneChannelMonitorUpdateErrZ {
2152 * The contents of this CResult_NoneChannelMonitorUpdateErrZ, accessible via either
2153 * `err` or `result` depending on the state of `result_ok`.
2155 union LDKCResult_NoneChannelMonitorUpdateErrZPtr contents;
2157 * Whether this CResult_NoneChannelMonitorUpdateErrZ represents a success state.
2160 } LDKCResult_NoneChannelMonitorUpdateErrZ;
2165 * Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
2166 * chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
2167 * preimage claim backward will lead to loss of funds.
2169 typedef struct MUST_USE_STRUCT LDKHTLCUpdate {
2171 * A pointer to the opaque Rust object.
2172 * Nearly everywhere, inner must be non-null, however in places where
2173 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2175 LDKnativeHTLCUpdate *inner;
2177 * Indicates that this is the only struct which contains the same pointer.
2178 * Rust functions which take ownership of an object provided via an argument require
2179 * this to be true and invalidate the object pointed to by inner.
2187 * A reference to a transaction output.
2189 * Differs from bitcoin::blockdata::transaction::OutPoint as the index is a u16 instead of u32
2190 * due to LN's restrictions on index values. Should reduce (possibly) unsafe conversions this way.
2192 typedef struct MUST_USE_STRUCT LDKOutPoint {
2194 * A pointer to the opaque Rust object.
2195 * Nearly everywhere, inner must be non-null, however in places where
2196 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2198 LDKnativeOutPoint *inner;
2200 * Indicates that this is the only struct which contains the same pointer.
2201 * Rust functions which take ownership of an object provided via an argument require
2202 * this to be true and invalidate the object pointed to by inner.
2208 * An event to be processed by the ChannelManager.
2210 typedef enum LDKMonitorEvent_Tag {
2212 * A monitor event containing an HTLCUpdate.
2214 LDKMonitorEvent_HTLCEvent,
2216 * A monitor event that the Channel's commitment transaction was confirmed.
2218 LDKMonitorEvent_CommitmentTxConfirmed,
2220 * Indicates a [`ChannelMonitor`] update has completed. See
2221 * [`ChannelMonitorUpdateErr::TemporaryFailure`] for more information on how this is used.
2223 * [`ChannelMonitorUpdateErr::TemporaryFailure`]: super::ChannelMonitorUpdateErr::TemporaryFailure
2225 LDKMonitorEvent_UpdateCompleted,
2227 * Indicates a [`ChannelMonitor`] update has failed. See
2228 * [`ChannelMonitorUpdateErr::PermanentFailure`] for more information on how this is used.
2230 * [`ChannelMonitorUpdateErr::PermanentFailure`]: super::ChannelMonitorUpdateErr::PermanentFailure
2232 LDKMonitorEvent_UpdateFailed,
2234 * Must be last for serialization purposes
2236 LDKMonitorEvent_Sentinel,
2237 } LDKMonitorEvent_Tag;
2239 typedef struct LDKMonitorEvent_LDKUpdateCompleted_Body {
2241 * The funding outpoint of the [`ChannelMonitor`] that was updated
2243 struct LDKOutPoint funding_txo;
2245 * The Update ID from [`ChannelMonitorUpdate::update_id`] which was applied or
2246 * [`ChannelMonitor::get_latest_update_id`].
2248 * Note that this should only be set to a given update's ID if all previous updates for the
2249 * same [`ChannelMonitor`] have been applied and persisted.
2251 uint64_t monitor_update_id;
2252 } LDKMonitorEvent_LDKUpdateCompleted_Body;
2254 typedef struct MUST_USE_STRUCT LDKMonitorEvent {
2255 LDKMonitorEvent_Tag tag;
2258 struct LDKHTLCUpdate htlc_event;
2261 struct LDKOutPoint commitment_tx_confirmed;
2263 LDKMonitorEvent_LDKUpdateCompleted_Body update_completed;
2265 struct LDKOutPoint update_failed;
2271 * A dynamically-allocated array of crate::lightning::chain::channelmonitor::MonitorEvents of arbitrary size.
2272 * This corresponds to std::vector in C++
2274 typedef struct LDKCVec_MonitorEventZ {
2276 * The elements in the array.
2277 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
2279 struct LDKMonitorEvent *data;
2281 * The number of elements pointed to by `data`.
2284 } LDKCVec_MonitorEventZ;
2287 * An enum which can either contain a crate::c_types::derived::C2Tuple_usizeTransactionZ or not
2289 typedef enum LDKCOption_C2Tuple_usizeTransactionZZ_Tag {
2291 * When we're in this state, this COption_C2Tuple_usizeTransactionZZ contains a crate::c_types::derived::C2Tuple_usizeTransactionZ
2293 LDKCOption_C2Tuple_usizeTransactionZZ_Some,
2295 * When we're in this state, this COption_C2Tuple_usizeTransactionZZ contains nothing
2297 LDKCOption_C2Tuple_usizeTransactionZZ_None,
2299 * Must be last for serialization purposes
2301 LDKCOption_C2Tuple_usizeTransactionZZ_Sentinel,
2302 } LDKCOption_C2Tuple_usizeTransactionZZ_Tag;
2304 typedef struct LDKCOption_C2Tuple_usizeTransactionZZ {
2305 LDKCOption_C2Tuple_usizeTransactionZZ_Tag tag;
2308 struct LDKC2Tuple_usizeTransactionZ some;
2311 } LDKCOption_C2Tuple_usizeTransactionZZ;
2314 * The reason the channel was closed. See individual variants more details.
2316 typedef enum LDKClosureReason_Tag {
2318 * Closure generated from receiving a peer error message.
2320 * Our counterparty may have broadcasted their latest commitment state, and we have
2323 LDKClosureReason_CounterpartyForceClosed,
2325 * Closure generated from [`ChannelManager::force_close_channel`], called by the user.
2327 * [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel.
2329 LDKClosureReason_HolderForceClosed,
2331 * The channel was closed after negotiating a cooperative close and we've now broadcasted
2332 * the cooperative close transaction. Note the shutdown may have been initiated by us.
2334 LDKClosureReason_CooperativeClosure,
2336 * A commitment transaction was confirmed on chain, closing the channel. Most likely this
2337 * commitment transaction came from our counterparty, but it may also have come from
2338 * a copy of our own `ChannelMonitor`.
2340 LDKClosureReason_CommitmentTxConfirmed,
2342 * The funding transaction failed to confirm in a timely manner on an inbound channel.
2344 LDKClosureReason_FundingTimedOut,
2346 * Closure generated from processing an event, likely a HTLC forward/relay/reception.
2348 LDKClosureReason_ProcessingError,
2350 * The `PeerManager` informed us that we've disconnected from the peer. We close channels
2351 * if the `PeerManager` informed us that it is unlikely we'll be able to connect to the
2352 * peer again in the future or if the peer disconnected before we finished negotiating
2353 * the channel open. The first case may be caused by incompatible features which our
2354 * counterparty, or we, require.
2356 LDKClosureReason_DisconnectedPeer,
2358 * Closure generated from `ChannelManager::read` if the ChannelMonitor is newer than
2359 * the ChannelManager deserialized.
2361 LDKClosureReason_OutdatedChannelManager,
2363 * Must be last for serialization purposes
2365 LDKClosureReason_Sentinel,
2366 } LDKClosureReason_Tag;
2368 typedef struct LDKClosureReason_LDKCounterpartyForceClosed_Body {
2370 * The error which the peer sent us.
2372 * The string should be sanitized before it is used (e.g emitted to logs
2373 * or printed to stdout). Otherwise, a well crafted error message may exploit
2374 * a security vulnerability in the terminal emulator or the logging subsystem.
2376 struct LDKStr peer_msg;
2377 } LDKClosureReason_LDKCounterpartyForceClosed_Body;
2379 typedef struct LDKClosureReason_LDKProcessingError_Body {
2381 * A developer-readable error message which we generated.
2384 } LDKClosureReason_LDKProcessingError_Body;
2386 typedef struct MUST_USE_STRUCT LDKClosureReason {
2387 LDKClosureReason_Tag tag;
2389 LDKClosureReason_LDKCounterpartyForceClosed_Body counterparty_force_closed;
2390 LDKClosureReason_LDKProcessingError_Body processing_error;
2395 * An enum which can either contain a crate::lightning::util::events::ClosureReason or not
2397 typedef enum LDKCOption_ClosureReasonZ_Tag {
2399 * When we're in this state, this COption_ClosureReasonZ contains a crate::lightning::util::events::ClosureReason
2401 LDKCOption_ClosureReasonZ_Some,
2403 * When we're in this state, this COption_ClosureReasonZ contains nothing
2405 LDKCOption_ClosureReasonZ_None,
2407 * Must be last for serialization purposes
2409 LDKCOption_ClosureReasonZ_Sentinel,
2410 } LDKCOption_ClosureReasonZ_Tag;
2412 typedef struct LDKCOption_ClosureReasonZ {
2413 LDKCOption_ClosureReasonZ_Tag tag;
2416 struct LDKClosureReason some;
2419 } LDKCOption_ClosureReasonZ;
2422 * The contents of CResult_COption_ClosureReasonZDecodeErrorZ
2424 typedef union LDKCResult_COption_ClosureReasonZDecodeErrorZPtr {
2426 * A pointer to the contents in the success state.
2427 * Reading from this pointer when `result_ok` is not set is undefined.
2429 struct LDKCOption_ClosureReasonZ *result;
2431 * A pointer to the contents in the error state.
2432 * Reading from this pointer when `result_ok` is set is undefined.
2434 struct LDKDecodeError *err;
2435 } LDKCResult_COption_ClosureReasonZDecodeErrorZPtr;
2438 * A CResult_COption_ClosureReasonZDecodeErrorZ represents the result of a fallible operation,
2439 * containing a crate::c_types::derived::COption_ClosureReasonZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
2440 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2442 typedef struct LDKCResult_COption_ClosureReasonZDecodeErrorZ {
2444 * The contents of this CResult_COption_ClosureReasonZDecodeErrorZ, accessible via either
2445 * `err` or `result` depending on the state of `result_ok`.
2447 union LDKCResult_COption_ClosureReasonZDecodeErrorZPtr contents;
2449 * Whether this CResult_COption_ClosureReasonZDecodeErrorZ represents a success state.
2452 } LDKCResult_COption_ClosureReasonZDecodeErrorZ;
2457 * A channel_update message to be sent or received from a peer
2459 typedef struct MUST_USE_STRUCT LDKChannelUpdate {
2461 * A pointer to the opaque Rust object.
2462 * Nearly everywhere, inner must be non-null, however in places where
2463 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2465 LDKnativeChannelUpdate *inner;
2467 * Indicates that this is the only struct which contains the same pointer.
2468 * Rust functions which take ownership of an object provided via an argument require
2469 * this to be true and invalidate the object pointed to by inner.
2475 * Update to the [`NetworkGraph`] based on payment failure information conveyed via the Onion
2476 * return packet by a node along the route. See [BOLT #4] for details.
2478 * [BOLT #4]: https://github.com/lightningnetwork/lightning-rfc/blob/master/04-onion-routing.md
2480 typedef enum LDKNetworkUpdate_Tag {
2482 * An error indicating a `channel_update` messages should be applied via
2483 * [`NetworkGraph::update_channel`].
2485 LDKNetworkUpdate_ChannelUpdateMessage,
2487 * An error indicating only that a channel has been closed, which should be applied via
2488 * [`NetworkGraph::close_channel_from_update`].
2490 LDKNetworkUpdate_ChannelClosed,
2492 * An error indicating only that a node has failed, which should be applied via
2493 * [`NetworkGraph::fail_node`].
2495 LDKNetworkUpdate_NodeFailure,
2497 * Must be last for serialization purposes
2499 LDKNetworkUpdate_Sentinel,
2500 } LDKNetworkUpdate_Tag;
2502 typedef struct LDKNetworkUpdate_LDKChannelUpdateMessage_Body {
2504 * The update to apply via [`NetworkGraph::update_channel`].
2506 struct LDKChannelUpdate msg;
2507 } LDKNetworkUpdate_LDKChannelUpdateMessage_Body;
2509 typedef struct LDKNetworkUpdate_LDKChannelClosed_Body {
2511 * The short channel id of the closed channel.
2513 uint64_t short_channel_id;
2515 * Whether the channel should be permanently removed or temporarily disabled until a new
2516 * `channel_update` message is received.
2519 } LDKNetworkUpdate_LDKChannelClosed_Body;
2521 typedef struct LDKNetworkUpdate_LDKNodeFailure_Body {
2523 * The node id of the failed node.
2525 struct LDKPublicKey node_id;
2527 * Whether the node should be permanently removed from consideration or can be restored
2528 * when a new `channel_update` message is received.
2531 } LDKNetworkUpdate_LDKNodeFailure_Body;
2533 typedef struct MUST_USE_STRUCT LDKNetworkUpdate {
2534 LDKNetworkUpdate_Tag tag;
2536 LDKNetworkUpdate_LDKChannelUpdateMessage_Body channel_update_message;
2537 LDKNetworkUpdate_LDKChannelClosed_Body channel_closed;
2538 LDKNetworkUpdate_LDKNodeFailure_Body node_failure;
2543 * An enum which can either contain a crate::lightning::routing::network_graph::NetworkUpdate or not
2545 typedef enum LDKCOption_NetworkUpdateZ_Tag {
2547 * When we're in this state, this COption_NetworkUpdateZ contains a crate::lightning::routing::network_graph::NetworkUpdate
2549 LDKCOption_NetworkUpdateZ_Some,
2551 * When we're in this state, this COption_NetworkUpdateZ contains nothing
2553 LDKCOption_NetworkUpdateZ_None,
2555 * Must be last for serialization purposes
2557 LDKCOption_NetworkUpdateZ_Sentinel,
2558 } LDKCOption_NetworkUpdateZ_Tag;
2560 typedef struct LDKCOption_NetworkUpdateZ {
2561 LDKCOption_NetworkUpdateZ_Tag tag;
2564 struct LDKNetworkUpdate some;
2567 } LDKCOption_NetworkUpdateZ;
2572 * Information about a spendable output to a P2WSH script. See
2573 * SpendableOutputDescriptor::DelayedPaymentOutput for more details on how to spend this.
2575 typedef struct MUST_USE_STRUCT LDKDelayedPaymentOutputDescriptor {
2577 * A pointer to the opaque Rust object.
2578 * Nearly everywhere, inner must be non-null, however in places where
2579 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2581 LDKnativeDelayedPaymentOutputDescriptor *inner;
2583 * Indicates that this is the only struct which contains the same pointer.
2584 * Rust functions which take ownership of an object provided via an argument require
2585 * this to be true and invalidate the object pointed to by inner.
2588 } LDKDelayedPaymentOutputDescriptor;
2593 * Information about a spendable output to our \"payment key\". See
2594 * SpendableOutputDescriptor::StaticPaymentOutput for more details on how to spend this.
2596 typedef struct MUST_USE_STRUCT LDKStaticPaymentOutputDescriptor {
2598 * A pointer to the opaque Rust object.
2599 * Nearly everywhere, inner must be non-null, however in places where
2600 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2602 LDKnativeStaticPaymentOutputDescriptor *inner;
2604 * Indicates that this is the only struct which contains the same pointer.
2605 * Rust functions which take ownership of an object provided via an argument require
2606 * this to be true and invalidate the object pointed to by inner.
2609 } LDKStaticPaymentOutputDescriptor;
2612 * When on-chain outputs are created by rust-lightning (which our counterparty is not able to
2613 * claim at any point in the future) an event is generated which you must track and be able to
2614 * spend on-chain. The information needed to do this is provided in this enum, including the
2615 * outpoint describing which txid and output index is available, the full output which exists at
2616 * that txid/index, and any keys or other information required to sign.
2618 typedef enum LDKSpendableOutputDescriptor_Tag {
2620 * An output to a script which was provided via KeysInterface directly, either from
2621 * `get_destination_script()` or `get_shutdown_scriptpubkey()`, thus you should already know
2622 * how to spend it. No secret keys are provided as rust-lightning was never given any key.
2623 * These may include outputs from a transaction punishing our counterparty or claiming an HTLC
2624 * on-chain using the payment preimage or after it has timed out.
2626 LDKSpendableOutputDescriptor_StaticOutput,
2628 * An output to a P2WSH script which can be spent with a single signature after a CSV delay.
2630 * The witness in the spending input should be:
2631 * <BIP 143 signature> <empty vector> (MINIMALIF standard rule) <provided witnessScript>
2633 * Note that the nSequence field in the spending input must be set to to_self_delay
2634 * (which means the transaction is not broadcastable until at least to_self_delay
2635 * blocks after the outpoint confirms).
2637 * These are generally the result of a \"revocable\" output to us, spendable only by us unless
2638 * it is an output from an old state which we broadcast (which should never happen).
2640 * To derive the delayed_payment key which is used to sign for this input, you must pass the
2641 * holder delayed_payment_base_key (ie the private key which corresponds to the pubkey in
2642 * Sign::pubkeys().delayed_payment_basepoint) and the provided per_commitment_point to
2643 * chan_utils::derive_private_key. The public key can be generated without the secret key
2644 * using chan_utils::derive_public_key and only the delayed_payment_basepoint which appears in
2647 * To derive the revocation_pubkey provided here (which is used in the witness
2648 * script generation), you must pass the counterparty revocation_basepoint (which appears in the
2649 * call to Sign::ready_channel) and the provided per_commitment point
2650 * to chan_utils::derive_public_revocation_key.
2652 * The witness script which is hashed and included in the output script_pubkey may be
2653 * regenerated by passing the revocation_pubkey (derived as above), our delayed_payment pubkey
2654 * (derived as above), and the to_self_delay contained here to
2655 * chan_utils::get_revokeable_redeemscript.
2657 LDKSpendableOutputDescriptor_DelayedPaymentOutput,
2659 * An output to a P2WPKH, spendable exclusively by our payment key (ie the private key which
2660 * corresponds to the public key in Sign::pubkeys().payment_point).
2661 * The witness in the spending input, is, thus, simply:
2662 * <BIP 143 signature> <payment key>
2664 * These are generally the result of our counterparty having broadcast the current state,
2665 * allowing us to claim the non-HTLC-encumbered outputs immediately.
2667 LDKSpendableOutputDescriptor_StaticPaymentOutput,
2669 * Must be last for serialization purposes
2671 LDKSpendableOutputDescriptor_Sentinel,
2672 } LDKSpendableOutputDescriptor_Tag;
2674 typedef struct LDKSpendableOutputDescriptor_LDKStaticOutput_Body {
2676 * The outpoint which is spendable
2678 struct LDKOutPoint outpoint;
2680 * The output which is referenced by the given outpoint.
2682 struct LDKTxOut output;
2683 } LDKSpendableOutputDescriptor_LDKStaticOutput_Body;
2685 typedef struct MUST_USE_STRUCT LDKSpendableOutputDescriptor {
2686 LDKSpendableOutputDescriptor_Tag tag;
2688 LDKSpendableOutputDescriptor_LDKStaticOutput_Body static_output;
2690 struct LDKDelayedPaymentOutputDescriptor delayed_payment_output;
2693 struct LDKStaticPaymentOutputDescriptor static_payment_output;
2696 } LDKSpendableOutputDescriptor;
2699 * A dynamically-allocated array of crate::lightning::chain::keysinterface::SpendableOutputDescriptors of arbitrary size.
2700 * This corresponds to std::vector in C++
2702 typedef struct LDKCVec_SpendableOutputDescriptorZ {
2704 * The elements in the array.
2705 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
2707 struct LDKSpendableOutputDescriptor *data;
2709 * The number of elements pointed to by `data`.
2712 } LDKCVec_SpendableOutputDescriptorZ;
2715 * Some information provided on receipt of payment depends on whether the payment received is a
2716 * spontaneous payment or a \"conventional\" lightning payment that's paying an invoice.
2718 typedef enum LDKPaymentPurpose_Tag {
2720 * Information for receiving a payment that we generated an invoice for.
2722 LDKPaymentPurpose_InvoicePayment,
2724 * Because this is a spontaneous payment, the payer generated their own preimage rather than us
2725 * (the payee) providing a preimage.
2727 LDKPaymentPurpose_SpontaneousPayment,
2729 * Must be last for serialization purposes
2731 LDKPaymentPurpose_Sentinel,
2732 } LDKPaymentPurpose_Tag;
2734 typedef struct LDKPaymentPurpose_LDKInvoicePayment_Body {
2736 * The preimage to the payment_hash, if the payment hash (and secret) were fetched via
2737 * [`ChannelManager::create_inbound_payment`]. If provided, this can be handed directly to
2738 * [`ChannelManager::claim_funds`].
2740 * [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
2741 * [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
2743 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
2745 struct LDKThirtyTwoBytes payment_preimage;
2747 * The \"payment secret\". This authenticates the sender to the recipient, preventing a
2748 * number of deanonymization attacks during the routing process.
2749 * It is provided here for your reference, however its accuracy is enforced directly by
2750 * [`ChannelManager`] using the values you previously provided to
2751 * [`ChannelManager::create_inbound_payment`] or
2752 * [`ChannelManager::create_inbound_payment_for_hash`].
2754 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
2755 * [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
2756 * [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
2758 struct LDKThirtyTwoBytes payment_secret;
2759 } LDKPaymentPurpose_LDKInvoicePayment_Body;
2761 typedef struct MUST_USE_STRUCT LDKPaymentPurpose {
2762 LDKPaymentPurpose_Tag tag;
2764 LDKPaymentPurpose_LDKInvoicePayment_Body invoice_payment;
2766 struct LDKThirtyTwoBytes spontaneous_payment;
2769 } LDKPaymentPurpose;
2772 * An Event which you should probably take some action in response to.
2774 * Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
2775 * them directly as they don't round-trip exactly (for example FundingGenerationReady is never
2776 * written as it makes no sense to respond to it after reconnecting to peers).
2778 typedef enum LDKEvent_Tag {
2780 * Used to indicate that the client should generate a funding transaction with the given
2781 * parameters and then call [`ChannelManager::funding_transaction_generated`].
2782 * Generated in [`ChannelManager`] message handling.
2783 * Note that *all inputs* in the funding transaction must spend SegWit outputs or your
2784 * counterparty can steal your funds!
2786 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
2787 * [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
2789 LDKEvent_FundingGenerationReady,
2791 * Indicates we've received money! Just gotta dig out that payment preimage and feed it to
2792 * [`ChannelManager::claim_funds`] to get it....
2793 * Note that if the preimage is not known, you should call
2794 * [`ChannelManager::fail_htlc_backwards`] to free up resources for this HTLC and avoid
2795 * network congestion.
2796 * If you fail to call either [`ChannelManager::claim_funds`] or
2797 * [`ChannelManager::fail_htlc_backwards`] within the HTLC's timeout, the HTLC will be
2798 * automatically failed.
2801 * LDK will not stop an inbound payment from being paid multiple times, so multiple
2802 * `PaymentReceived` events may be generated for the same payment.
2804 * [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
2805 * [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
2807 LDKEvent_PaymentReceived,
2809 * Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
2810 * and we got back the payment preimage for it).
2812 * Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed`
2813 * event. In this situation, you SHOULD treat this payment as having succeeded.
2815 LDKEvent_PaymentSent,
2817 * Indicates an outbound HTLC we sent failed. Probably some intermediary node dropped
2818 * something. You may wish to retry with a different route.
2820 * Note that this does *not* indicate that all paths for an MPP payment have failed, see
2821 * [`Event::PaymentFailed`] and [`all_paths_failed`].
2823 * [`all_paths_failed`]: Self::PaymentPathFailed::all_paths_failed
2825 LDKEvent_PaymentPathFailed,
2827 * Indicates an outbound payment failed. Individual [`Event::PaymentPathFailed`] events
2828 * provide failure information for each MPP part in the payment.
2830 * This event is provided once there are no further pending HTLCs for the payment and the
2831 * payment is no longer retryable, either due to a several-block timeout or because
2832 * [`ChannelManager::abandon_payment`] was previously called for the corresponding payment.
2834 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
2836 LDKEvent_PaymentFailed,
2838 * Used to indicate that [`ChannelManager::process_pending_htlc_forwards`] should be called at
2839 * a time in the future.
2841 * [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
2843 LDKEvent_PendingHTLCsForwardable,
2845 * Used to indicate that an output which you should know how to spend was confirmed on chain
2846 * and is now spendable.
2847 * Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
2848 * counterparty spending them due to some kind of timeout. Thus, you need to store them
2849 * somewhere and spend them when you create on-chain transactions.
2851 LDKEvent_SpendableOutputs,
2853 * This event is generated when a payment has been successfully forwarded through us and a
2854 * forwarding fee earned.
2856 LDKEvent_PaymentForwarded,
2858 * Used to indicate that a channel with the given `channel_id` is in the process of closure.
2860 LDKEvent_ChannelClosed,
2862 * Used to indicate to the user that they can abandon the funding transaction and recycle the
2863 * inputs for another purpose.
2865 LDKEvent_DiscardFunding,
2867 * Indicates that a path for an outbound payment was successful.
2869 * Always generated after [`Event::PaymentSent`] and thus useful for scoring channels. See
2870 * [`Event::PaymentSent`] for obtaining the payment preimage.
2872 LDKEvent_PaymentPathSuccessful,
2874 * Indicates a request to open a new channel by a peer.
2876 * To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the
2877 * request, call [`ChannelManager::force_close_channel`].
2879 * The event is only triggered when a new open channel request is received and the
2880 * [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.
2882 * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
2883 * [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
2884 * [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
2886 LDKEvent_OpenChannelRequest,
2888 * Must be last for serialization purposes
2893 typedef struct LDKEvent_LDKFundingGenerationReady_Body {
2895 * The random channel_id we picked which you'll need to pass into
2896 * ChannelManager::funding_transaction_generated.
2898 struct LDKThirtyTwoBytes temporary_channel_id;
2900 * The value, in satoshis, that the output should have.
2902 uint64_t channel_value_satoshis;
2904 * The script which should be used in the transaction output.
2906 struct LDKCVec_u8Z output_script;
2908 * The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
2909 * an inbound channel.
2911 * [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
2913 uint64_t user_channel_id;
2914 } LDKEvent_LDKFundingGenerationReady_Body;
2916 typedef struct LDKEvent_LDKPaymentReceived_Body {
2918 * The hash for which the preimage should be handed to the ChannelManager. Note that LDK will
2919 * not stop you from registering duplicate payment hashes for inbound payments.
2921 struct LDKThirtyTwoBytes payment_hash;
2923 * The value, in thousandths of a satoshi, that this payment is for.
2927 * Information for claiming this received payment, based on whether the purpose of the
2928 * payment is to pay an invoice or to send a spontaneous payment.
2930 struct LDKPaymentPurpose purpose;
2931 } LDKEvent_LDKPaymentReceived_Body;
2933 typedef struct LDKEvent_LDKPaymentSent_Body {
2935 * The id returned by [`ChannelManager::send_payment`] and used with
2936 * [`ChannelManager::retry_payment`].
2938 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
2939 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
2941 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
2943 struct LDKThirtyTwoBytes payment_id;
2945 * The preimage to the hash given to ChannelManager::send_payment.
2946 * Note that this serves as a payment receipt, if you wish to have such a thing, you must
2949 struct LDKThirtyTwoBytes payment_preimage;
2951 * The hash that was given to [`ChannelManager::send_payment`].
2953 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
2955 struct LDKThirtyTwoBytes payment_hash;
2957 * The total fee which was spent at intermediate hops in this payment, across all paths.
2959 * Note that, like [`Route::get_total_fees`] this does *not* include any potential
2960 * overpayment to the recipient node.
2962 * If the recipient or an intermediate node misbehaves and gives us free money, this may
2963 * overstate the amount paid, though this is unlikely.
2965 * [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
2967 struct LDKCOption_u64Z fee_paid_msat;
2968 } LDKEvent_LDKPaymentSent_Body;
2970 typedef struct LDKEvent_LDKPaymentPathFailed_Body {
2972 * The id returned by [`ChannelManager::send_payment`] and used with
2973 * [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
2975 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
2976 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
2977 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
2979 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
2981 struct LDKThirtyTwoBytes payment_id;
2983 * The hash that was given to [`ChannelManager::send_payment`].
2985 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
2987 struct LDKThirtyTwoBytes payment_hash;
2989 * Indicates the payment was rejected for some reason by the recipient. This implies that
2990 * the payment has failed, not just the route in question. If this is not set, you may
2991 * retry the payment via a different route.
2993 bool rejected_by_dest;
2995 * Any failure information conveyed via the Onion return packet by a node along the failed
2998 * Should be applied to the [`NetworkGraph`] so that routing decisions can take into
2999 * account the update. [`NetGraphMsgHandler`] is capable of doing this.
3001 * [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
3002 * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
3004 struct LDKCOption_NetworkUpdateZ network_update;
3006 * For both single-path and multi-path payments, this is set if all paths of the payment have
3007 * failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
3008 * larger MPP payment were still in flight when this event was generated.
3010 * Note that if you are retrying individual MPP parts, using this value to determine if a
3011 * payment has fully failed is race-y. Because multiple failures can happen prior to events
3012 * being processed, you may retry in response to a first failure, with a second failure
3013 * (with `all_paths_failed` set) still pending. Then, when the second failure is processed
3014 * you will see `all_paths_failed` set even though the retry of the first failure still
3015 * has an associated in-flight HTLC. See (1) for an example of such a failure.
3017 * If you wish to retry individual MPP parts and learn when a payment has failed, you must
3018 * call [`ChannelManager::abandon_payment`] and wait for a [`Event::PaymentFailed`] event.
3020 * (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
3022 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
3024 bool all_paths_failed;
3026 * The payment path that failed.
3028 struct LDKCVec_RouteHopZ path;
3030 * The channel responsible for the failed payment path.
3032 * If this is `Some`, then the corresponding channel should be avoided when the payment is
3033 * retried. May be `None` for older [`Event`] serializations.
3035 struct LDKCOption_u64Z short_channel_id;
3037 * Parameters needed to compute a new [`Route`] when retrying the failed payment path.
3039 * See [`find_route`] for details.
3041 * [`Route`]: crate::routing::router::Route
3042 * [`find_route`]: crate::routing::router::find_route
3044 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
3046 struct LDKRouteParameters retry;
3047 } LDKEvent_LDKPaymentPathFailed_Body;
3049 typedef struct LDKEvent_LDKPaymentFailed_Body {
3051 * The id returned by [`ChannelManager::send_payment`] and used with
3052 * [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
3054 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
3055 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
3056 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
3058 struct LDKThirtyTwoBytes payment_id;
3060 * The hash that was given to [`ChannelManager::send_payment`].
3062 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
3064 struct LDKThirtyTwoBytes payment_hash;
3065 } LDKEvent_LDKPaymentFailed_Body;
3067 typedef struct LDKEvent_LDKPendingHTLCsForwardable_Body {
3069 * The minimum amount of time that should be waited prior to calling
3070 * process_pending_htlc_forwards. To increase the effort required to correlate payments,
3071 * you should wait a random amount of time in roughly the range (now + time_forwardable,
3072 * now + 5*time_forwardable).
3074 uint64_t time_forwardable;
3075 } LDKEvent_LDKPendingHTLCsForwardable_Body;
3077 typedef struct LDKEvent_LDKSpendableOutputs_Body {
3079 * The outputs which you should store as spendable by you.
3081 struct LDKCVec_SpendableOutputDescriptorZ outputs;
3082 } LDKEvent_LDKSpendableOutputs_Body;
3084 typedef struct LDKEvent_LDKPaymentForwarded_Body {
3086 * The fee, in milli-satoshis, which was earned as a result of the payment.
3088 * Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
3089 * was pending, the amount the next hop claimed will have been rounded down to the nearest
3090 * whole satoshi. Thus, the fee calculated here may be higher than expected as we still
3091 * claimed the full value in millisatoshis from the source. In this case,
3092 * `claim_from_onchain_tx` will be set.
3094 * If the channel which sent us the payment has been force-closed, we will claim the funds
3095 * via an on-chain transaction. In that case we do not yet know the on-chain transaction
3096 * fees which we will spend and will instead set this to `None`. It is possible duplicate
3097 * `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
3100 struct LDKCOption_u64Z fee_earned_msat;
3102 * If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
3105 bool claim_from_onchain_tx;
3106 } LDKEvent_LDKPaymentForwarded_Body;
3108 typedef struct LDKEvent_LDKChannelClosed_Body {
3110 * The channel_id of the channel which has been closed. Note that on-chain transactions
3111 * resolving the channel are likely still awaiting confirmation.
3113 struct LDKThirtyTwoBytes channel_id;
3115 * The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
3116 * an inbound channel. This will always be zero for objects serialized with LDK versions
3119 * [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
3121 uint64_t user_channel_id;
3123 * The reason the channel was closed.
3125 struct LDKClosureReason reason;
3126 } LDKEvent_LDKChannelClosed_Body;
3128 typedef struct LDKEvent_LDKDiscardFunding_Body {
3130 * The channel_id of the channel which has been closed.
3132 struct LDKThirtyTwoBytes channel_id;
3134 * The full transaction received from the user
3136 struct LDKTransaction transaction;
3137 } LDKEvent_LDKDiscardFunding_Body;
3139 typedef struct LDKEvent_LDKPaymentPathSuccessful_Body {
3141 * The id returned by [`ChannelManager::send_payment`] and used with
3142 * [`ChannelManager::retry_payment`].
3144 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
3145 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
3147 struct LDKThirtyTwoBytes payment_id;
3149 * The hash that was given to [`ChannelManager::send_payment`].
3151 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
3153 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
3155 struct LDKThirtyTwoBytes payment_hash;
3157 * The payment path that was successful.
3159 * May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
3161 struct LDKCVec_RouteHopZ path;
3162 } LDKEvent_LDKPaymentPathSuccessful_Body;
3164 typedef struct LDKEvent_LDKOpenChannelRequest_Body {
3166 * The temporary channel ID of the channel requested to be opened.
3168 * When responding to the request, the `temporary_channel_id` should be passed
3169 * back to the ChannelManager with [`ChannelManager::accept_inbound_channel`] to accept,
3170 * or to [`ChannelManager::force_close_channel`] to reject.
3172 * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
3173 * [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
3175 struct LDKThirtyTwoBytes temporary_channel_id;
3177 * The node_id of the counterparty requesting to open the channel.
3179 struct LDKPublicKey counterparty_node_id;
3181 * The channel value of the requested channel.
3183 uint64_t funding_satoshis;
3185 * Our starting balance in the channel if the request is accepted, in milli-satoshi.
3188 } LDKEvent_LDKOpenChannelRequest_Body;
3190 typedef struct MUST_USE_STRUCT LDKEvent {
3193 LDKEvent_LDKFundingGenerationReady_Body funding_generation_ready;
3194 LDKEvent_LDKPaymentReceived_Body payment_received;
3195 LDKEvent_LDKPaymentSent_Body payment_sent;
3196 LDKEvent_LDKPaymentPathFailed_Body payment_path_failed;
3197 LDKEvent_LDKPaymentFailed_Body payment_failed;
3198 LDKEvent_LDKPendingHTLCsForwardable_Body pending_htl_cs_forwardable;
3199 LDKEvent_LDKSpendableOutputs_Body spendable_outputs;
3200 LDKEvent_LDKPaymentForwarded_Body payment_forwarded;
3201 LDKEvent_LDKChannelClosed_Body channel_closed;
3202 LDKEvent_LDKDiscardFunding_Body discard_funding;
3203 LDKEvent_LDKPaymentPathSuccessful_Body payment_path_successful;
3204 LDKEvent_LDKOpenChannelRequest_Body open_channel_request;
3209 * An enum which can either contain a crate::lightning::util::events::Event or not
3211 typedef enum LDKCOption_EventZ_Tag {
3213 * When we're in this state, this COption_EventZ contains a crate::lightning::util::events::Event
3215 LDKCOption_EventZ_Some,
3217 * When we're in this state, this COption_EventZ contains nothing
3219 LDKCOption_EventZ_None,
3221 * Must be last for serialization purposes
3223 LDKCOption_EventZ_Sentinel,
3224 } LDKCOption_EventZ_Tag;
3226 typedef struct LDKCOption_EventZ {
3227 LDKCOption_EventZ_Tag tag;
3230 struct LDKEvent some;
3233 } LDKCOption_EventZ;
3236 * The contents of CResult_COption_EventZDecodeErrorZ
3238 typedef union LDKCResult_COption_EventZDecodeErrorZPtr {
3240 * A pointer to the contents in the success state.
3241 * Reading from this pointer when `result_ok` is not set is undefined.
3243 struct LDKCOption_EventZ *result;
3245 * A pointer to the contents in the error state.
3246 * Reading from this pointer when `result_ok` is set is undefined.
3248 struct LDKDecodeError *err;
3249 } LDKCResult_COption_EventZDecodeErrorZPtr;
3252 * A CResult_COption_EventZDecodeErrorZ represents the result of a fallible operation,
3253 * containing a crate::c_types::derived::COption_EventZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
3254 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3256 typedef struct LDKCResult_COption_EventZDecodeErrorZ {
3258 * The contents of this CResult_COption_EventZDecodeErrorZ, accessible via either
3259 * `err` or `result` depending on the state of `result_ok`.
3261 union LDKCResult_COption_EventZDecodeErrorZPtr contents;
3263 * Whether this CResult_COption_EventZDecodeErrorZ represents a success state.
3266 } LDKCResult_COption_EventZDecodeErrorZ;
3271 * An accept_channel message to be sent or received from a peer
3273 typedef struct MUST_USE_STRUCT LDKAcceptChannel {
3275 * A pointer to the opaque Rust object.
3276 * Nearly everywhere, inner must be non-null, however in places where
3277 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3279 LDKnativeAcceptChannel *inner;
3281 * Indicates that this is the only struct which contains the same pointer.
3282 * Rust functions which take ownership of an object provided via an argument require
3283 * this to be true and invalidate the object pointed to by inner.
3291 * An open_channel message to be sent or received from a peer
3293 typedef struct MUST_USE_STRUCT LDKOpenChannel {
3295 * A pointer to the opaque Rust object.
3296 * Nearly everywhere, inner must be non-null, however in places where
3297 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3299 LDKnativeOpenChannel *inner;
3301 * Indicates that this is the only struct which contains the same pointer.
3302 * Rust functions which take ownership of an object provided via an argument require
3303 * this to be true and invalidate the object pointed to by inner.
3311 * A funding_created message to be sent or received from a peer
3313 typedef struct MUST_USE_STRUCT LDKFundingCreated {
3315 * A pointer to the opaque Rust object.
3316 * Nearly everywhere, inner must be non-null, however in places where
3317 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3319 LDKnativeFundingCreated *inner;
3321 * Indicates that this is the only struct which contains the same pointer.
3322 * Rust functions which take ownership of an object provided via an argument require
3323 * this to be true and invalidate the object pointed to by inner.
3326 } LDKFundingCreated;
3331 * A funding_signed message to be sent or received from a peer
3333 typedef struct MUST_USE_STRUCT LDKFundingSigned {
3335 * A pointer to the opaque Rust object.
3336 * Nearly everywhere, inner must be non-null, however in places where
3337 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3339 LDKnativeFundingSigned *inner;
3341 * Indicates that this is the only struct which contains the same pointer.
3342 * Rust functions which take ownership of an object provided via an argument require
3343 * this to be true and invalidate the object pointed to by inner.
3351 * A funding_locked message to be sent or received from a peer
3353 typedef struct MUST_USE_STRUCT LDKFundingLocked {
3355 * A pointer to the opaque Rust object.
3356 * Nearly everywhere, inner must be non-null, however in places where
3357 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3359 LDKnativeFundingLocked *inner;
3361 * Indicates that this is the only struct which contains the same pointer.
3362 * Rust functions which take ownership of an object provided via an argument require
3363 * this to be true and invalidate the object pointed to by inner.
3371 * An announcement_signatures message to be sent or received from a peer
3373 typedef struct MUST_USE_STRUCT LDKAnnouncementSignatures {
3375 * A pointer to the opaque Rust object.
3376 * Nearly everywhere, inner must be non-null, however in places where
3377 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3379 LDKnativeAnnouncementSignatures *inner;
3381 * Indicates that this is the only struct which contains the same pointer.
3382 * Rust functions which take ownership of an object provided via an argument require
3383 * this to be true and invalidate the object pointed to by inner.
3386 } LDKAnnouncementSignatures;
3391 * Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
3392 * transaction updates if they were pending.
3394 typedef struct MUST_USE_STRUCT LDKCommitmentUpdate {
3396 * A pointer to the opaque Rust object.
3397 * Nearly everywhere, inner must be non-null, however in places where
3398 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3400 LDKnativeCommitmentUpdate *inner;
3402 * Indicates that this is the only struct which contains the same pointer.
3403 * Rust functions which take ownership of an object provided via an argument require
3404 * this to be true and invalidate the object pointed to by inner.
3407 } LDKCommitmentUpdate;
3412 * A revoke_and_ack message to be sent or received from a peer
3414 typedef struct MUST_USE_STRUCT LDKRevokeAndACK {
3416 * A pointer to the opaque Rust object.
3417 * Nearly everywhere, inner must be non-null, however in places where
3418 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3420 LDKnativeRevokeAndACK *inner;
3422 * Indicates that this is the only struct which contains the same pointer.
3423 * Rust functions which take ownership of an object provided via an argument require
3424 * this to be true and invalidate the object pointed to by inner.
3432 * A closing_signed message to be sent or received from a peer
3434 typedef struct MUST_USE_STRUCT LDKClosingSigned {
3436 * A pointer to the opaque Rust object.
3437 * Nearly everywhere, inner must be non-null, however in places where
3438 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3440 LDKnativeClosingSigned *inner;
3442 * Indicates that this is the only struct which contains the same pointer.
3443 * Rust functions which take ownership of an object provided via an argument require
3444 * this to be true and invalidate the object pointed to by inner.
3452 * A shutdown message to be sent or received from a peer
3454 typedef struct MUST_USE_STRUCT LDKShutdown {
3456 * A pointer to the opaque Rust object.
3457 * Nearly everywhere, inner must be non-null, however in places where
3458 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3460 LDKnativeShutdown *inner;
3462 * Indicates that this is the only struct which contains the same pointer.
3463 * Rust functions which take ownership of an object provided via an argument require
3464 * this to be true and invalidate the object pointed to by inner.
3472 * A channel_reestablish message to be sent or received from a peer
3474 typedef struct MUST_USE_STRUCT LDKChannelReestablish {
3476 * A pointer to the opaque Rust object.
3477 * Nearly everywhere, inner must be non-null, however in places where
3478 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3480 LDKnativeChannelReestablish *inner;
3482 * Indicates that this is the only struct which contains the same pointer.
3483 * Rust functions which take ownership of an object provided via an argument require
3484 * this to be true and invalidate the object pointed to by inner.
3487 } LDKChannelReestablish;
3492 * A channel_announcement message to be sent or received from a peer
3494 typedef struct MUST_USE_STRUCT LDKChannelAnnouncement {
3496 * A pointer to the opaque Rust object.
3497 * Nearly everywhere, inner must be non-null, however in places where
3498 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3500 LDKnativeChannelAnnouncement *inner;
3502 * Indicates that this is the only struct which contains the same pointer.
3503 * Rust functions which take ownership of an object provided via an argument require
3504 * this to be true and invalidate the object pointed to by inner.
3507 } LDKChannelAnnouncement;
3512 * A node_announcement message to be sent or received from a peer
3514 typedef struct MUST_USE_STRUCT LDKNodeAnnouncement {
3516 * A pointer to the opaque Rust object.
3517 * Nearly everywhere, inner must be non-null, however in places where
3518 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3520 LDKnativeNodeAnnouncement *inner;
3522 * Indicates that this is the only struct which contains the same pointer.
3523 * Rust functions which take ownership of an object provided via an argument require
3524 * this to be true and invalidate the object pointed to by inner.
3527 } LDKNodeAnnouncement;
3532 * An error message to be sent or received from a peer
3534 typedef struct MUST_USE_STRUCT LDKErrorMessage {
3536 * A pointer to the opaque Rust object.
3537 * Nearly everywhere, inner must be non-null, however in places where
3538 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3540 LDKnativeErrorMessage *inner;
3542 * Indicates that this is the only struct which contains the same pointer.
3543 * Rust functions which take ownership of an object provided via an argument require
3544 * this to be true and invalidate the object pointed to by inner.
3552 * A warning message to be sent or received from a peer
3554 typedef struct MUST_USE_STRUCT LDKWarningMessage {
3556 * A pointer to the opaque Rust object.
3557 * Nearly everywhere, inner must be non-null, however in places where
3558 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3560 LDKnativeWarningMessage *inner;
3562 * Indicates that this is the only struct which contains the same pointer.
3563 * Rust functions which take ownership of an object provided via an argument require
3564 * this to be true and invalidate the object pointed to by inner.
3567 } LDKWarningMessage;
3570 * Used to put an error message in a LightningError
3572 typedef enum LDKErrorAction_Tag {
3574 * The peer took some action which made us think they were useless. Disconnect them.
3576 LDKErrorAction_DisconnectPeer,
3578 * The peer did something harmless that we weren't able to process, just log and ignore
3580 LDKErrorAction_IgnoreError,
3582 * The peer did something harmless that we weren't able to meaningfully process.
3583 * If the error is logged, log it at the given level.
3585 LDKErrorAction_IgnoreAndLog,
3587 * The peer provided us with a gossip message which we'd already seen. In most cases this
3588 * should be ignored, but it may result in the message being forwarded if it is a duplicate of
3589 * our own channel announcements.
3591 LDKErrorAction_IgnoreDuplicateGossip,
3593 * The peer did something incorrect. Tell them.
3595 LDKErrorAction_SendErrorMessage,
3597 * The peer did something incorrect. Tell them without closing any channels.
3599 LDKErrorAction_SendWarningMessage,
3601 * Must be last for serialization purposes
3603 LDKErrorAction_Sentinel,
3604 } LDKErrorAction_Tag;
3606 typedef struct LDKErrorAction_LDKDisconnectPeer_Body {
3608 * An error message which we should make an effort to send before we disconnect.
3610 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
3612 struct LDKErrorMessage msg;
3613 } LDKErrorAction_LDKDisconnectPeer_Body;
3615 typedef struct LDKErrorAction_LDKSendErrorMessage_Body {
3617 * The message to send.
3619 struct LDKErrorMessage msg;
3620 } LDKErrorAction_LDKSendErrorMessage_Body;
3622 typedef struct LDKErrorAction_LDKSendWarningMessage_Body {
3624 * The message to send.
3626 struct LDKWarningMessage msg;
3628 * The peer may have done something harmless that we weren't able to meaningfully process,
3629 * though we should still tell them about it.
3630 * If this event is logged, log it at the given level.
3632 enum LDKLevel log_level;
3633 } LDKErrorAction_LDKSendWarningMessage_Body;
3635 typedef struct MUST_USE_STRUCT LDKErrorAction {
3636 LDKErrorAction_Tag tag;
3638 LDKErrorAction_LDKDisconnectPeer_Body disconnect_peer;
3640 enum LDKLevel ignore_and_log;
3642 LDKErrorAction_LDKSendErrorMessage_Body send_error_message;
3643 LDKErrorAction_LDKSendWarningMessage_Body send_warning_message;
3650 * A query_channel_range message is used to query a peer for channel
3651 * UTXOs in a range of blocks. The recipient of a query makes a best
3652 * effort to reply to the query using one or more reply_channel_range
3655 typedef struct MUST_USE_STRUCT LDKQueryChannelRange {
3657 * A pointer to the opaque Rust object.
3658 * Nearly everywhere, inner must be non-null, however in places where
3659 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3661 LDKnativeQueryChannelRange *inner;
3663 * Indicates that this is the only struct which contains the same pointer.
3664 * Rust functions which take ownership of an object provided via an argument require
3665 * this to be true and invalidate the object pointed to by inner.
3668 } LDKQueryChannelRange;
3673 * A query_short_channel_ids message is used to query a peer for
3674 * routing gossip messages related to one or more short_channel_ids.
3675 * The query recipient will reply with the latest, if available,
3676 * channel_announcement, channel_update and node_announcement messages
3677 * it maintains for the requested short_channel_ids followed by a
3678 * reply_short_channel_ids_end message. The short_channel_ids sent in
3679 * this query are encoded. We only support encoding_type=0 uncompressed
3680 * serialization and do not support encoding_type=1 zlib serialization.
3682 typedef struct MUST_USE_STRUCT LDKQueryShortChannelIds {
3684 * A pointer to the opaque Rust object.
3685 * Nearly everywhere, inner must be non-null, however in places where
3686 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3688 LDKnativeQueryShortChannelIds *inner;
3690 * Indicates that this is the only struct which contains the same pointer.
3691 * Rust functions which take ownership of an object provided via an argument require
3692 * this to be true and invalidate the object pointed to by inner.
3695 } LDKQueryShortChannelIds;
3700 * A reply_channel_range message is a reply to a query_channel_range
3701 * message. Multiple reply_channel_range messages can be sent in reply
3702 * to a single query_channel_range message. The query recipient makes a
3703 * best effort to respond based on their local network view which may
3704 * not be a perfect view of the network. The short_channel_ids in the
3705 * reply are encoded. We only support encoding_type=0 uncompressed
3706 * serialization and do not support encoding_type=1 zlib serialization.
3708 typedef struct MUST_USE_STRUCT LDKReplyChannelRange {
3710 * A pointer to the opaque Rust object.
3711 * Nearly everywhere, inner must be non-null, however in places where
3712 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3714 LDKnativeReplyChannelRange *inner;
3716 * Indicates that this is the only struct which contains the same pointer.
3717 * Rust functions which take ownership of an object provided via an argument require
3718 * this to be true and invalidate the object pointed to by inner.
3721 } LDKReplyChannelRange;
3724 * An event generated by ChannelManager which indicates a message should be sent to a peer (or
3725 * broadcast to most peers).
3726 * These events are handled by PeerManager::process_events if you are using a PeerManager.
3728 typedef enum LDKMessageSendEvent_Tag {
3730 * Used to indicate that we've accepted a channel open and should send the accept_channel
3731 * message provided to the given peer.
3733 LDKMessageSendEvent_SendAcceptChannel,
3735 * Used to indicate that we've initiated a channel open and should send the open_channel
3736 * message provided to the given peer.
3738 LDKMessageSendEvent_SendOpenChannel,
3740 * Used to indicate that a funding_created message should be sent to the peer with the given node_id.
3742 LDKMessageSendEvent_SendFundingCreated,
3744 * Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
3746 LDKMessageSendEvent_SendFundingSigned,
3748 * Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
3750 LDKMessageSendEvent_SendFundingLocked,
3752 * Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
3754 LDKMessageSendEvent_SendAnnouncementSignatures,
3756 * Used to indicate that a series of HTLC update messages, as well as a commitment_signed
3757 * message should be sent to the peer with the given node_id.
3759 LDKMessageSendEvent_UpdateHTLCs,
3761 * Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
3763 LDKMessageSendEvent_SendRevokeAndACK,
3765 * Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
3767 LDKMessageSendEvent_SendClosingSigned,
3769 * Used to indicate that a shutdown message should be sent to the peer with the given node_id.
3771 LDKMessageSendEvent_SendShutdown,
3773 * Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
3775 LDKMessageSendEvent_SendChannelReestablish,
3777 * Used to indicate that a channel_announcement and channel_update should be broadcast to all
3778 * peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
3780 * Note that after doing so, you very likely (unless you did so very recently) want to call
3781 * ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
3782 * This ensures that any nodes which see our channel_announcement also have a relevant
3783 * node_announcement, including relevant feature flags which may be important for routing
3786 LDKMessageSendEvent_BroadcastChannelAnnouncement,
3788 * Used to indicate that a node_announcement should be broadcast to all peers.
3790 LDKMessageSendEvent_BroadcastNodeAnnouncement,
3792 * Used to indicate that a channel_update should be broadcast to all peers.
3794 LDKMessageSendEvent_BroadcastChannelUpdate,
3796 * Used to indicate that a channel_update should be sent to a single peer.
3797 * In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
3798 * private channel and we shouldn't be informing all of our peers of channel parameters.
3800 LDKMessageSendEvent_SendChannelUpdate,
3802 * Broadcast an error downstream to be handled
3804 LDKMessageSendEvent_HandleError,
3806 * Query a peer for channels with funding transaction UTXOs in a block range.
3808 LDKMessageSendEvent_SendChannelRangeQuery,
3810 * Request routing gossip messages from a peer for a list of channels identified by
3811 * their short_channel_ids.
3813 LDKMessageSendEvent_SendShortIdsQuery,
3815 * Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
3816 * emitted during processing of the query.
3818 LDKMessageSendEvent_SendReplyChannelRange,
3820 * Must be last for serialization purposes
3822 LDKMessageSendEvent_Sentinel,
3823 } LDKMessageSendEvent_Tag;
3825 typedef struct LDKMessageSendEvent_LDKSendAcceptChannel_Body {
3827 * The node_id of the node which should receive this message
3829 struct LDKPublicKey node_id;
3831 * The message which should be sent.
3833 struct LDKAcceptChannel msg;
3834 } LDKMessageSendEvent_LDKSendAcceptChannel_Body;
3836 typedef struct LDKMessageSendEvent_LDKSendOpenChannel_Body {
3838 * The node_id of the node which should receive this message
3840 struct LDKPublicKey node_id;
3842 * The message which should be sent.
3844 struct LDKOpenChannel msg;
3845 } LDKMessageSendEvent_LDKSendOpenChannel_Body;
3847 typedef struct LDKMessageSendEvent_LDKSendFundingCreated_Body {
3849 * The node_id of the node which should receive this message
3851 struct LDKPublicKey node_id;
3853 * The message which should be sent.
3855 struct LDKFundingCreated msg;
3856 } LDKMessageSendEvent_LDKSendFundingCreated_Body;
3858 typedef struct LDKMessageSendEvent_LDKSendFundingSigned_Body {
3860 * The node_id of the node which should receive this message
3862 struct LDKPublicKey node_id;
3864 * The message which should be sent.
3866 struct LDKFundingSigned msg;
3867 } LDKMessageSendEvent_LDKSendFundingSigned_Body;
3869 typedef struct LDKMessageSendEvent_LDKSendFundingLocked_Body {
3871 * The node_id of the node which should receive these message(s)
3873 struct LDKPublicKey node_id;
3875 * The funding_locked message which should be sent.
3877 struct LDKFundingLocked msg;
3878 } LDKMessageSendEvent_LDKSendFundingLocked_Body;
3880 typedef struct LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body {
3882 * The node_id of the node which should receive these message(s)
3884 struct LDKPublicKey node_id;
3886 * The announcement_signatures message which should be sent.
3888 struct LDKAnnouncementSignatures msg;
3889 } LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body;
3891 typedef struct LDKMessageSendEvent_LDKUpdateHTLCs_Body {
3893 * The node_id of the node which should receive these message(s)
3895 struct LDKPublicKey node_id;
3897 * The update messages which should be sent. ALL messages in the struct should be sent!
3899 struct LDKCommitmentUpdate updates;
3900 } LDKMessageSendEvent_LDKUpdateHTLCs_Body;
3902 typedef struct LDKMessageSendEvent_LDKSendRevokeAndACK_Body {
3904 * The node_id of the node which should receive this message
3906 struct LDKPublicKey node_id;
3908 * The message which should be sent.
3910 struct LDKRevokeAndACK msg;
3911 } LDKMessageSendEvent_LDKSendRevokeAndACK_Body;
3913 typedef struct LDKMessageSendEvent_LDKSendClosingSigned_Body {
3915 * The node_id of the node which should receive this message
3917 struct LDKPublicKey node_id;
3919 * The message which should be sent.
3921 struct LDKClosingSigned msg;
3922 } LDKMessageSendEvent_LDKSendClosingSigned_Body;
3924 typedef struct LDKMessageSendEvent_LDKSendShutdown_Body {
3926 * The node_id of the node which should receive this message
3928 struct LDKPublicKey node_id;
3930 * The message which should be sent.
3932 struct LDKShutdown msg;
3933 } LDKMessageSendEvent_LDKSendShutdown_Body;
3935 typedef struct LDKMessageSendEvent_LDKSendChannelReestablish_Body {
3937 * The node_id of the node which should receive this message
3939 struct LDKPublicKey node_id;
3941 * The message which should be sent.
3943 struct LDKChannelReestablish msg;
3944 } LDKMessageSendEvent_LDKSendChannelReestablish_Body;
3946 typedef struct LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body {
3948 * The channel_announcement which should be sent.
3950 struct LDKChannelAnnouncement msg;
3952 * The followup channel_update which should be sent.
3954 struct LDKChannelUpdate update_msg;
3955 } LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body;
3957 typedef struct LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body {
3959 * The node_announcement which should be sent.
3961 struct LDKNodeAnnouncement msg;
3962 } LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body;
3964 typedef struct LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body {
3966 * The channel_update which should be sent.
3968 struct LDKChannelUpdate msg;
3969 } LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body;
3971 typedef struct LDKMessageSendEvent_LDKSendChannelUpdate_Body {
3973 * The node_id of the node which should receive this message
3975 struct LDKPublicKey node_id;
3977 * The channel_update which should be sent.
3979 struct LDKChannelUpdate msg;
3980 } LDKMessageSendEvent_LDKSendChannelUpdate_Body;
3982 typedef struct LDKMessageSendEvent_LDKHandleError_Body {
3984 * The node_id of the node which should receive this message
3986 struct LDKPublicKey node_id;
3988 * The action which should be taken.
3990 struct LDKErrorAction action;
3991 } LDKMessageSendEvent_LDKHandleError_Body;
3993 typedef struct LDKMessageSendEvent_LDKSendChannelRangeQuery_Body {
3995 * The node_id of this message recipient
3997 struct LDKPublicKey node_id;
3999 * The query_channel_range which should be sent.
4001 struct LDKQueryChannelRange msg;
4002 } LDKMessageSendEvent_LDKSendChannelRangeQuery_Body;
4004 typedef struct LDKMessageSendEvent_LDKSendShortIdsQuery_Body {
4006 * The node_id of this message recipient
4008 struct LDKPublicKey node_id;
4010 * The query_short_channel_ids which should be sent.
4012 struct LDKQueryShortChannelIds msg;
4013 } LDKMessageSendEvent_LDKSendShortIdsQuery_Body;
4015 typedef struct LDKMessageSendEvent_LDKSendReplyChannelRange_Body {
4017 * The node_id of this message recipient
4019 struct LDKPublicKey node_id;
4021 * The reply_channel_range which should be sent.
4023 struct LDKReplyChannelRange msg;
4024 } LDKMessageSendEvent_LDKSendReplyChannelRange_Body;
4026 typedef struct MUST_USE_STRUCT LDKMessageSendEvent {
4027 LDKMessageSendEvent_Tag tag;
4029 LDKMessageSendEvent_LDKSendAcceptChannel_Body send_accept_channel;
4030 LDKMessageSendEvent_LDKSendOpenChannel_Body send_open_channel;
4031 LDKMessageSendEvent_LDKSendFundingCreated_Body send_funding_created;
4032 LDKMessageSendEvent_LDKSendFundingSigned_Body send_funding_signed;
4033 LDKMessageSendEvent_LDKSendFundingLocked_Body send_funding_locked;
4034 LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body send_announcement_signatures;
4035 LDKMessageSendEvent_LDKUpdateHTLCs_Body update_htl_cs;
4036 LDKMessageSendEvent_LDKSendRevokeAndACK_Body send_revoke_and_ack;
4037 LDKMessageSendEvent_LDKSendClosingSigned_Body send_closing_signed;
4038 LDKMessageSendEvent_LDKSendShutdown_Body send_shutdown;
4039 LDKMessageSendEvent_LDKSendChannelReestablish_Body send_channel_reestablish;
4040 LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body broadcast_channel_announcement;
4041 LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body broadcast_node_announcement;
4042 LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body broadcast_channel_update;
4043 LDKMessageSendEvent_LDKSendChannelUpdate_Body send_channel_update;
4044 LDKMessageSendEvent_LDKHandleError_Body handle_error;
4045 LDKMessageSendEvent_LDKSendChannelRangeQuery_Body send_channel_range_query;
4046 LDKMessageSendEvent_LDKSendShortIdsQuery_Body send_short_ids_query;
4047 LDKMessageSendEvent_LDKSendReplyChannelRange_Body send_reply_channel_range;
4049 } LDKMessageSendEvent;
4052 * A dynamically-allocated array of crate::lightning::util::events::MessageSendEvents of arbitrary size.
4053 * This corresponds to std::vector in C++
4055 typedef struct LDKCVec_MessageSendEventZ {
4057 * The elements in the array.
4058 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4060 struct LDKMessageSendEvent *data;
4062 * The number of elements pointed to by `data`.
4065 } LDKCVec_MessageSendEventZ;
4070 * [`Score`] implementation that uses a fixed penalty.
4072 typedef struct MUST_USE_STRUCT LDKFixedPenaltyScorer {
4074 * A pointer to the opaque Rust object.
4075 * Nearly everywhere, inner must be non-null, however in places where
4076 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4078 LDKnativeFixedPenaltyScorer *inner;
4080 * Indicates that this is the only struct which contains the same pointer.
4081 * Rust functions which take ownership of an object provided via an argument require
4082 * this to be true and invalidate the object pointed to by inner.
4085 } LDKFixedPenaltyScorer;
4088 * The contents of CResult_FixedPenaltyScorerDecodeErrorZ
4090 typedef union LDKCResult_FixedPenaltyScorerDecodeErrorZPtr {
4092 * A pointer to the contents in the success state.
4093 * Reading from this pointer when `result_ok` is not set is undefined.
4095 struct LDKFixedPenaltyScorer *result;
4097 * A pointer to the contents in the error state.
4098 * Reading from this pointer when `result_ok` is set is undefined.
4100 struct LDKDecodeError *err;
4101 } LDKCResult_FixedPenaltyScorerDecodeErrorZPtr;
4104 * A CResult_FixedPenaltyScorerDecodeErrorZ represents the result of a fallible operation,
4105 * containing a crate::lightning::routing::scoring::FixedPenaltyScorer on success and a crate::lightning::ln::msgs::DecodeError on failure.
4106 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4108 typedef struct LDKCResult_FixedPenaltyScorerDecodeErrorZ {
4110 * The contents of this CResult_FixedPenaltyScorerDecodeErrorZ, accessible via either
4111 * `err` or `result` depending on the state of `result_ok`.
4113 union LDKCResult_FixedPenaltyScorerDecodeErrorZPtr contents;
4115 * Whether this CResult_FixedPenaltyScorerDecodeErrorZ represents a success state.
4118 } LDKCResult_FixedPenaltyScorerDecodeErrorZ;
4123 * Parameters for configuring [`Scorer`].
4125 typedef struct MUST_USE_STRUCT LDKScoringParameters {
4127 * A pointer to the opaque Rust object.
4128 * Nearly everywhere, inner must be non-null, however in places where
4129 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4131 LDKnativeScoringParameters *inner;
4133 * Indicates that this is the only struct which contains the same pointer.
4134 * Rust functions which take ownership of an object provided via an argument require
4135 * this to be true and invalidate the object pointed to by inner.
4138 } LDKScoringParameters;
4141 * The contents of CResult_ScoringParametersDecodeErrorZ
4143 typedef union LDKCResult_ScoringParametersDecodeErrorZPtr {
4145 * A pointer to the contents in the success state.
4146 * Reading from this pointer when `result_ok` is not set is undefined.
4148 struct LDKScoringParameters *result;
4150 * A pointer to the contents in the error state.
4151 * Reading from this pointer when `result_ok` is set is undefined.
4153 struct LDKDecodeError *err;
4154 } LDKCResult_ScoringParametersDecodeErrorZPtr;
4157 * A CResult_ScoringParametersDecodeErrorZ represents the result of a fallible operation,
4158 * containing a crate::lightning::routing::scoring::ScoringParameters on success and a crate::lightning::ln::msgs::DecodeError on failure.
4159 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4161 typedef struct LDKCResult_ScoringParametersDecodeErrorZ {
4163 * The contents of this CResult_ScoringParametersDecodeErrorZ, accessible via either
4164 * `err` or `result` depending on the state of `result_ok`.
4166 union LDKCResult_ScoringParametersDecodeErrorZPtr contents;
4168 * Whether this CResult_ScoringParametersDecodeErrorZ represents a success state.
4171 } LDKCResult_ScoringParametersDecodeErrorZ;
4176 * [`Score`] implementation that provides reasonable default behavior.
4178 * Used to apply a fixed penalty to each channel, thus avoiding long paths when shorter paths with
4179 * slightly higher fees are available. Will further penalize channels that fail to relay payments.
4181 * See [module-level documentation] for usage and [`ScoringParameters`] for customization.
4185 * Mixing the `no-std` feature between serialization and deserialization results in undefined
4188 * [module-level documentation]: crate::routing::scoring
4190 typedef struct MUST_USE_STRUCT LDKScorer {
4192 * A pointer to the opaque Rust object.
4193 * Nearly everywhere, inner must be non-null, however in places where
4194 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4196 LDKnativeScorer *inner;
4198 * Indicates that this is the only struct which contains the same pointer.
4199 * Rust functions which take ownership of an object provided via an argument require
4200 * this to be true and invalidate the object pointed to by inner.
4206 * The contents of CResult_ScorerDecodeErrorZ
4208 typedef union LDKCResult_ScorerDecodeErrorZPtr {
4210 * A pointer to the contents in the success state.
4211 * Reading from this pointer when `result_ok` is not set is undefined.
4213 struct LDKScorer *result;
4215 * A pointer to the contents in the error state.
4216 * Reading from this pointer when `result_ok` is set is undefined.
4218 struct LDKDecodeError *err;
4219 } LDKCResult_ScorerDecodeErrorZPtr;
4222 * A CResult_ScorerDecodeErrorZ represents the result of a fallible operation,
4223 * containing a crate::lightning::routing::scoring::Scorer on success and a crate::lightning::ln::msgs::DecodeError on failure.
4224 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4226 typedef struct LDKCResult_ScorerDecodeErrorZ {
4228 * The contents of this CResult_ScorerDecodeErrorZ, accessible via either
4229 * `err` or `result` depending on the state of `result_ok`.
4231 union LDKCResult_ScorerDecodeErrorZPtr contents;
4233 * Whether this CResult_ScorerDecodeErrorZ represents a success state.
4236 } LDKCResult_ScorerDecodeErrorZ;
4241 * Parameters for configuring [`ProbabilisticScorer`].
4243 typedef struct MUST_USE_STRUCT LDKProbabilisticScoringParameters {
4245 * A pointer to the opaque Rust object.
4246 * Nearly everywhere, inner must be non-null, however in places where
4247 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4249 LDKnativeProbabilisticScoringParameters *inner;
4251 * Indicates that this is the only struct which contains the same pointer.
4252 * Rust functions which take ownership of an object provided via an argument require
4253 * this to be true and invalidate the object pointed to by inner.
4256 } LDKProbabilisticScoringParameters;
4259 * The contents of CResult_ProbabilisticScoringParametersDecodeErrorZ
4261 typedef union LDKCResult_ProbabilisticScoringParametersDecodeErrorZPtr {
4263 * A pointer to the contents in the success state.
4264 * Reading from this pointer when `result_ok` is not set is undefined.
4266 struct LDKProbabilisticScoringParameters *result;
4268 * A pointer to the contents in the error state.
4269 * Reading from this pointer when `result_ok` is set is undefined.
4271 struct LDKDecodeError *err;
4272 } LDKCResult_ProbabilisticScoringParametersDecodeErrorZPtr;
4275 * A CResult_ProbabilisticScoringParametersDecodeErrorZ represents the result of a fallible operation,
4276 * containing a crate::lightning::routing::scoring::ProbabilisticScoringParameters on success and a crate::lightning::ln::msgs::DecodeError on failure.
4277 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4279 typedef struct LDKCResult_ProbabilisticScoringParametersDecodeErrorZ {
4281 * The contents of this CResult_ProbabilisticScoringParametersDecodeErrorZ, accessible via either
4282 * `err` or `result` depending on the state of `result_ok`.
4284 union LDKCResult_ProbabilisticScoringParametersDecodeErrorZPtr contents;
4286 * Whether this CResult_ProbabilisticScoringParametersDecodeErrorZ represents a success state.
4289 } LDKCResult_ProbabilisticScoringParametersDecodeErrorZ;
4294 * Features used within an `init` message.
4296 typedef struct MUST_USE_STRUCT LDKInitFeatures {
4298 * A pointer to the opaque Rust object.
4299 * Nearly everywhere, inner must be non-null, however in places where
4300 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4302 LDKnativeInitFeatures *inner;
4304 * Indicates that this is the only struct which contains the same pointer.
4305 * Rust functions which take ownership of an object provided via an argument require
4306 * this to be true and invalidate the object pointed to by inner.
4312 * The contents of CResult_InitFeaturesDecodeErrorZ
4314 typedef union LDKCResult_InitFeaturesDecodeErrorZPtr {
4316 * A pointer to the contents in the success state.
4317 * Reading from this pointer when `result_ok` is not set is undefined.
4319 struct LDKInitFeatures *result;
4321 * A pointer to the contents in the error state.
4322 * Reading from this pointer when `result_ok` is set is undefined.
4324 struct LDKDecodeError *err;
4325 } LDKCResult_InitFeaturesDecodeErrorZPtr;
4328 * A CResult_InitFeaturesDecodeErrorZ represents the result of a fallible operation,
4329 * containing a crate::lightning::ln::features::InitFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
4330 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4332 typedef struct LDKCResult_InitFeaturesDecodeErrorZ {
4334 * The contents of this CResult_InitFeaturesDecodeErrorZ, accessible via either
4335 * `err` or `result` depending on the state of `result_ok`.
4337 union LDKCResult_InitFeaturesDecodeErrorZPtr contents;
4339 * Whether this CResult_InitFeaturesDecodeErrorZ represents a success state.
4342 } LDKCResult_InitFeaturesDecodeErrorZ;
4347 * Features used within a `channel_announcement` message.
4349 typedef struct MUST_USE_STRUCT LDKChannelFeatures {
4351 * A pointer to the opaque Rust object.
4352 * Nearly everywhere, inner must be non-null, however in places where
4353 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4355 LDKnativeChannelFeatures *inner;
4357 * Indicates that this is the only struct which contains the same pointer.
4358 * Rust functions which take ownership of an object provided via an argument require
4359 * this to be true and invalidate the object pointed to by inner.
4362 } LDKChannelFeatures;
4365 * The contents of CResult_ChannelFeaturesDecodeErrorZ
4367 typedef union LDKCResult_ChannelFeaturesDecodeErrorZPtr {
4369 * A pointer to the contents in the success state.
4370 * Reading from this pointer when `result_ok` is not set is undefined.
4372 struct LDKChannelFeatures *result;
4374 * A pointer to the contents in the error state.
4375 * Reading from this pointer when `result_ok` is set is undefined.
4377 struct LDKDecodeError *err;
4378 } LDKCResult_ChannelFeaturesDecodeErrorZPtr;
4381 * A CResult_ChannelFeaturesDecodeErrorZ represents the result of a fallible operation,
4382 * containing a crate::lightning::ln::features::ChannelFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
4383 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4385 typedef struct LDKCResult_ChannelFeaturesDecodeErrorZ {
4387 * The contents of this CResult_ChannelFeaturesDecodeErrorZ, accessible via either
4388 * `err` or `result` depending on the state of `result_ok`.
4390 union LDKCResult_ChannelFeaturesDecodeErrorZPtr contents;
4392 * Whether this CResult_ChannelFeaturesDecodeErrorZ represents a success state.
4395 } LDKCResult_ChannelFeaturesDecodeErrorZ;
4400 * Features used within a `node_announcement` message.
4402 typedef struct MUST_USE_STRUCT LDKNodeFeatures {
4404 * A pointer to the opaque Rust object.
4405 * Nearly everywhere, inner must be non-null, however in places where
4406 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4408 LDKnativeNodeFeatures *inner;
4410 * Indicates that this is the only struct which contains the same pointer.
4411 * Rust functions which take ownership of an object provided via an argument require
4412 * this to be true and invalidate the object pointed to by inner.
4418 * The contents of CResult_NodeFeaturesDecodeErrorZ
4420 typedef union LDKCResult_NodeFeaturesDecodeErrorZPtr {
4422 * A pointer to the contents in the success state.
4423 * Reading from this pointer when `result_ok` is not set is undefined.
4425 struct LDKNodeFeatures *result;
4427 * A pointer to the contents in the error state.
4428 * Reading from this pointer when `result_ok` is set is undefined.
4430 struct LDKDecodeError *err;
4431 } LDKCResult_NodeFeaturesDecodeErrorZPtr;
4434 * A CResult_NodeFeaturesDecodeErrorZ represents the result of a fallible operation,
4435 * containing a crate::lightning::ln::features::NodeFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
4436 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4438 typedef struct LDKCResult_NodeFeaturesDecodeErrorZ {
4440 * The contents of this CResult_NodeFeaturesDecodeErrorZ, accessible via either
4441 * `err` or `result` depending on the state of `result_ok`.
4443 union LDKCResult_NodeFeaturesDecodeErrorZPtr contents;
4445 * Whether this CResult_NodeFeaturesDecodeErrorZ represents a success state.
4448 } LDKCResult_NodeFeaturesDecodeErrorZ;
4453 * Features used within an invoice.
4455 typedef struct MUST_USE_STRUCT LDKInvoiceFeatures {
4457 * A pointer to the opaque Rust object.
4458 * Nearly everywhere, inner must be non-null, however in places where
4459 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4461 LDKnativeInvoiceFeatures *inner;
4463 * Indicates that this is the only struct which contains the same pointer.
4464 * Rust functions which take ownership of an object provided via an argument require
4465 * this to be true and invalidate the object pointed to by inner.
4468 } LDKInvoiceFeatures;
4471 * The contents of CResult_InvoiceFeaturesDecodeErrorZ
4473 typedef union LDKCResult_InvoiceFeaturesDecodeErrorZPtr {
4475 * A pointer to the contents in the success state.
4476 * Reading from this pointer when `result_ok` is not set is undefined.
4478 struct LDKInvoiceFeatures *result;
4480 * A pointer to the contents in the error state.
4481 * Reading from this pointer when `result_ok` is set is undefined.
4483 struct LDKDecodeError *err;
4484 } LDKCResult_InvoiceFeaturesDecodeErrorZPtr;
4487 * A CResult_InvoiceFeaturesDecodeErrorZ represents the result of a fallible operation,
4488 * containing a crate::lightning::ln::features::InvoiceFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
4489 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4491 typedef struct LDKCResult_InvoiceFeaturesDecodeErrorZ {
4493 * The contents of this CResult_InvoiceFeaturesDecodeErrorZ, accessible via either
4494 * `err` or `result` depending on the state of `result_ok`.
4496 union LDKCResult_InvoiceFeaturesDecodeErrorZPtr contents;
4498 * Whether this CResult_InvoiceFeaturesDecodeErrorZ represents a success state.
4501 } LDKCResult_InvoiceFeaturesDecodeErrorZ;
4506 * Features used within the channel_type field in an OpenChannel message.
4508 * A channel is always of some known \"type\", describing the transaction formats used and the exact
4509 * semantics of our interaction with our peer.
4511 * Note that because a channel is a specific type which is proposed by the opener and accepted by
4512 * the counterparty, only required features are allowed here.
4514 * This is serialized differently from other feature types - it is not prefixed by a length, and
4515 * thus must only appear inside a TLV where its length is known in advance.
4517 typedef struct MUST_USE_STRUCT LDKChannelTypeFeatures {
4519 * A pointer to the opaque Rust object.
4520 * Nearly everywhere, inner must be non-null, however in places where
4521 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4523 LDKnativeChannelTypeFeatures *inner;
4525 * Indicates that this is the only struct which contains the same pointer.
4526 * Rust functions which take ownership of an object provided via an argument require
4527 * this to be true and invalidate the object pointed to by inner.
4530 } LDKChannelTypeFeatures;
4533 * The contents of CResult_ChannelTypeFeaturesDecodeErrorZ
4535 typedef union LDKCResult_ChannelTypeFeaturesDecodeErrorZPtr {
4537 * A pointer to the contents in the success state.
4538 * Reading from this pointer when `result_ok` is not set is undefined.
4540 struct LDKChannelTypeFeatures *result;
4542 * A pointer to the contents in the error state.
4543 * Reading from this pointer when `result_ok` is set is undefined.
4545 struct LDKDecodeError *err;
4546 } LDKCResult_ChannelTypeFeaturesDecodeErrorZPtr;
4549 * A CResult_ChannelTypeFeaturesDecodeErrorZ represents the result of a fallible operation,
4550 * containing a crate::lightning::ln::features::ChannelTypeFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
4551 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4553 typedef struct LDKCResult_ChannelTypeFeaturesDecodeErrorZ {
4555 * The contents of this CResult_ChannelTypeFeaturesDecodeErrorZ, accessible via either
4556 * `err` or `result` depending on the state of `result_ok`.
4558 union LDKCResult_ChannelTypeFeaturesDecodeErrorZPtr contents;
4560 * Whether this CResult_ChannelTypeFeaturesDecodeErrorZ represents a success state.
4563 } LDKCResult_ChannelTypeFeaturesDecodeErrorZ;
4566 * The contents of CResult_DelayedPaymentOutputDescriptorDecodeErrorZ
4568 typedef union LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZPtr {
4570 * A pointer to the contents in the success state.
4571 * Reading from this pointer when `result_ok` is not set is undefined.
4573 struct LDKDelayedPaymentOutputDescriptor *result;
4575 * A pointer to the contents in the error state.
4576 * Reading from this pointer when `result_ok` is set is undefined.
4578 struct LDKDecodeError *err;
4579 } LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZPtr;
4582 * A CResult_DelayedPaymentOutputDescriptorDecodeErrorZ represents the result of a fallible operation,
4583 * containing a crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor on success and a crate::lightning::ln::msgs::DecodeError on failure.
4584 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4586 typedef struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ {
4588 * The contents of this CResult_DelayedPaymentOutputDescriptorDecodeErrorZ, accessible via either
4589 * `err` or `result` depending on the state of `result_ok`.
4591 union LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZPtr contents;
4593 * Whether this CResult_DelayedPaymentOutputDescriptorDecodeErrorZ represents a success state.
4596 } LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ;
4599 * The contents of CResult_StaticPaymentOutputDescriptorDecodeErrorZ
4601 typedef union LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZPtr {
4603 * A pointer to the contents in the success state.
4604 * Reading from this pointer when `result_ok` is not set is undefined.
4606 struct LDKStaticPaymentOutputDescriptor *result;
4608 * A pointer to the contents in the error state.
4609 * Reading from this pointer when `result_ok` is set is undefined.
4611 struct LDKDecodeError *err;
4612 } LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZPtr;
4615 * A CResult_StaticPaymentOutputDescriptorDecodeErrorZ represents the result of a fallible operation,
4616 * containing a crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor on success and a crate::lightning::ln::msgs::DecodeError on failure.
4617 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4619 typedef struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ {
4621 * The contents of this CResult_StaticPaymentOutputDescriptorDecodeErrorZ, accessible via either
4622 * `err` or `result` depending on the state of `result_ok`.
4624 union LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZPtr contents;
4626 * Whether this CResult_StaticPaymentOutputDescriptorDecodeErrorZ represents a success state.
4629 } LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ;
4632 * The contents of CResult_SpendableOutputDescriptorDecodeErrorZ
4634 typedef union LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr {
4636 * A pointer to the contents in the success state.
4637 * Reading from this pointer when `result_ok` is not set is undefined.
4639 struct LDKSpendableOutputDescriptor *result;
4641 * A pointer to the contents in the error state.
4642 * Reading from this pointer when `result_ok` is set is undefined.
4644 struct LDKDecodeError *err;
4645 } LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr;
4648 * A CResult_SpendableOutputDescriptorDecodeErrorZ represents the result of a fallible operation,
4649 * containing a crate::lightning::chain::keysinterface::SpendableOutputDescriptor on success and a crate::lightning::ln::msgs::DecodeError on failure.
4650 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4652 typedef struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ {
4654 * The contents of this CResult_SpendableOutputDescriptorDecodeErrorZ, accessible via either
4655 * `err` or `result` depending on the state of `result_ok`.
4657 union LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr contents;
4659 * Whether this CResult_SpendableOutputDescriptorDecodeErrorZ represents a success state.
4662 } LDKCResult_SpendableOutputDescriptorDecodeErrorZ;
4665 * A dynamically-allocated array of crate::c_types::ThirtyTwoBytess of arbitrary size.
4666 * This corresponds to std::vector in C++
4668 typedef struct LDKCVec_PaymentPreimageZ {
4670 * The elements in the array.
4671 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4673 struct LDKThirtyTwoBytes *data;
4675 * The number of elements pointed to by `data`.
4678 } LDKCVec_PaymentPreimageZ;
4681 * A tuple of 2 elements. See the individual fields for the types contained.
4683 typedef struct LDKC2Tuple_SignatureCVec_SignatureZZ {
4685 * The element at position 0
4687 struct LDKSignature a;
4689 * The element at position 1
4691 struct LDKCVec_SignatureZ b;
4692 } LDKC2Tuple_SignatureCVec_SignatureZZ;
4695 * The contents of CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ
4697 typedef union LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr {
4699 * A pointer to the contents in the success state.
4700 * Reading from this pointer when `result_ok` is not set is undefined.
4702 struct LDKC2Tuple_SignatureCVec_SignatureZZ *result;
4704 * Note that this value is always NULL, as there are no contents in the Err variant
4707 } LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr;
4710 * A CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ represents the result of a fallible operation,
4711 * containing a crate::c_types::derived::C2Tuple_SignatureCVec_SignatureZZ on success and a () on failure.
4712 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4714 typedef struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ {
4716 * The contents of this CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ, accessible via either
4717 * `err` or `result` depending on the state of `result_ok`.
4719 union LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr contents;
4721 * Whether this CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ represents a success state.
4724 } LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ;
4727 * The contents of CResult_SignatureNoneZ
4729 typedef union LDKCResult_SignatureNoneZPtr {
4731 * A pointer to the contents in the success state.
4732 * Reading from this pointer when `result_ok` is not set is undefined.
4734 struct LDKSignature *result;
4736 * Note that this value is always NULL, as there are no contents in the Err variant
4739 } LDKCResult_SignatureNoneZPtr;
4742 * A CResult_SignatureNoneZ represents the result of a fallible operation,
4743 * containing a crate::c_types::Signature on success and a () on failure.
4744 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4746 typedef struct LDKCResult_SignatureNoneZ {
4748 * The contents of this CResult_SignatureNoneZ, accessible via either
4749 * `err` or `result` depending on the state of `result_ok`.
4751 union LDKCResult_SignatureNoneZPtr contents;
4753 * Whether this CResult_SignatureNoneZ represents a success state.
4756 } LDKCResult_SignatureNoneZ;
4759 * A tuple of 2 elements. See the individual fields for the types contained.
4761 typedef struct LDKC2Tuple_SignatureSignatureZ {
4763 * The element at position 0
4765 struct LDKSignature a;
4767 * The element at position 1
4769 struct LDKSignature b;
4770 } LDKC2Tuple_SignatureSignatureZ;
4773 * The contents of CResult_C2Tuple_SignatureSignatureZNoneZ
4775 typedef union LDKCResult_C2Tuple_SignatureSignatureZNoneZPtr {
4777 * A pointer to the contents in the success state.
4778 * Reading from this pointer when `result_ok` is not set is undefined.
4780 struct LDKC2Tuple_SignatureSignatureZ *result;
4782 * Note that this value is always NULL, as there are no contents in the Err variant
4785 } LDKCResult_C2Tuple_SignatureSignatureZNoneZPtr;
4788 * A CResult_C2Tuple_SignatureSignatureZNoneZ represents the result of a fallible operation,
4789 * containing a crate::c_types::derived::C2Tuple_SignatureSignatureZ on success and a () on failure.
4790 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4792 typedef struct LDKCResult_C2Tuple_SignatureSignatureZNoneZ {
4794 * The contents of this CResult_C2Tuple_SignatureSignatureZNoneZ, accessible via either
4795 * `err` or `result` depending on the state of `result_ok`.
4797 union LDKCResult_C2Tuple_SignatureSignatureZNoneZPtr contents;
4799 * Whether this CResult_C2Tuple_SignatureSignatureZNoneZ represents a success state.
4802 } LDKCResult_C2Tuple_SignatureSignatureZNoneZ;
4805 * The contents of CResult_SecretKeyNoneZ
4807 typedef union LDKCResult_SecretKeyNoneZPtr {
4809 * A pointer to the contents in the success state.
4810 * Reading from this pointer when `result_ok` is not set is undefined.
4812 struct LDKSecretKey *result;
4814 * Note that this value is always NULL, as there are no contents in the Err variant
4817 } LDKCResult_SecretKeyNoneZPtr;
4820 * A CResult_SecretKeyNoneZ represents the result of a fallible operation,
4821 * containing a crate::c_types::SecretKey on success and a () on failure.
4822 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4824 typedef struct LDKCResult_SecretKeyNoneZ {
4826 * The contents of this CResult_SecretKeyNoneZ, accessible via either
4827 * `err` or `result` depending on the state of `result_ok`.
4829 union LDKCResult_SecretKeyNoneZPtr contents;
4831 * Whether this CResult_SecretKeyNoneZ represents a success state.
4834 } LDKCResult_SecretKeyNoneZ;
4839 * This class tracks the per-transaction information needed to build a closing transaction and will
4840 * actually build it and sign.
4842 * This class can be used inside a signer implementation to generate a signature given the relevant
4845 typedef struct MUST_USE_STRUCT LDKClosingTransaction {
4847 * A pointer to the opaque Rust object.
4848 * Nearly everywhere, inner must be non-null, however in places where
4849 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4851 LDKnativeClosingTransaction *inner;
4853 * Indicates that this is the only struct which contains the same pointer.
4854 * Rust functions which take ownership of an object provided via an argument require
4855 * this to be true and invalidate the object pointed to by inner.
4858 } LDKClosingTransaction;
4863 * The unsigned part of a channel_announcement
4865 typedef struct MUST_USE_STRUCT LDKUnsignedChannelAnnouncement {
4867 * A pointer to the opaque Rust object.
4868 * Nearly everywhere, inner must be non-null, however in places where
4869 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4871 LDKnativeUnsignedChannelAnnouncement *inner;
4873 * Indicates that this is the only struct which contains the same pointer.
4874 * Rust functions which take ownership of an object provided via an argument require
4875 * this to be true and invalidate the object pointed to by inner.
4878 } LDKUnsignedChannelAnnouncement;
4881 * A trait to sign lightning channel transactions as described in BOLT 3.
4883 * Signing services could be implemented on a hardware wallet. In this case,
4884 * the current Sign would be a front-end on top of a communication
4885 * channel connected to your secure device and lightning key material wouldn't
4886 * reside on a hot server. Nevertheless, a this deployment would still need
4887 * to trust the ChannelManager to avoid loss of funds as this latest component
4888 * could ask to sign commitment transaction with HTLCs paying to attacker pubkeys.
4890 * A more secure iteration would be to use hashlock (or payment points) to pair
4891 * invoice/incoming HTLCs with outgoing HTLCs to implement a no-trust-ChannelManager
4892 * at the price of more state and computation on the hardware wallet side. In the future,
4893 * we are looking forward to design such interface.
4895 * In any case, ChannelMonitor or fallback watchtowers are always going to be trusted
4896 * to act, as liveness and breach reply correctness are always going to be hard requirements
4897 * of LN security model, orthogonal of key management issues.
4899 typedef struct LDKBaseSign {
4901 * An opaque pointer which is passed to your function implementations as an argument.
4902 * This has no meaning in the LDK, and can be NULL or any other value.
4906 * Gets the per-commitment point for a specific commitment number
4908 * Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
4910 struct LDKPublicKey (*get_per_commitment_point)(const void *this_arg, uint64_t idx);
4912 * Gets the commitment secret for a specific commitment number as part of the revocation process
4914 * An external signer implementation should error here if the commitment was already signed
4915 * and should refuse to sign it in the future.
4917 * May be called more than once for the same index.
4919 * Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
4921 struct LDKThirtyTwoBytes (*release_commitment_secret)(const void *this_arg, uint64_t idx);
4923 * Validate the counterparty's signatures on the holder commitment transaction and HTLCs.
4925 * This is required in order for the signer to make sure that releasing a commitment
4926 * secret won't leave us without a broadcastable holder transaction.
4927 * Policy checks should be implemented in this function, including checking the amount
4928 * sent to us and checking the HTLCs.
4930 * The preimages of outgoing HTLCs that were fulfilled since the last commitment are provided.
4931 * A validating signer should ensure that an HTLC output is removed only when the matching
4932 * preimage is provided, or when the value to holder is restored.
4934 * NOTE: all the relevant preimages will be provided, but there may also be additional
4935 * irrelevant or duplicate preimages.
4937 struct LDKCResult_NoneNoneZ (*validate_holder_commitment)(const void *this_arg, const struct LDKHolderCommitmentTransaction *NONNULL_PTR holder_tx, struct LDKCVec_PaymentPreimageZ preimages);
4939 * Gets the holder's channel public keys and basepoints
4941 struct LDKChannelPublicKeys pubkeys;
4943 * Fill in the pubkeys field as a reference to it will be given to Rust after this returns
4944 * Note that this takes a pointer to this object, not the this_ptr like other methods do
4945 * This function pointer may be NULL if pubkeys is filled in when this object is created and never needs updating.
4947 void (*set_pubkeys)(const struct LDKBaseSign*NONNULL_PTR );
4949 * Gets an arbitrary identifier describing the set of keys which are provided back to you in
4950 * some SpendableOutputDescriptor types. This should be sufficient to identify this
4951 * Sign object uniquely and lookup or re-derive its keys.
4953 struct LDKThirtyTwoBytes (*channel_keys_id)(const void *this_arg);
4955 * Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
4957 * Note that if signing fails or is rejected, the channel will be force-closed.
4959 * Policy checks should be implemented in this function, including checking the amount
4960 * sent to us and checking the HTLCs.
4962 * The preimages of outgoing HTLCs that were fulfilled since the last commitment are provided.
4963 * A validating signer should ensure that an HTLC output is removed only when the matching
4964 * preimage is provided, or when the value to holder is restored.
4966 * NOTE: all the relevant preimages will be provided, but there may also be additional
4967 * irrelevant or duplicate preimages.
4969 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ (*sign_counterparty_commitment)(const void *this_arg, const struct LDKCommitmentTransaction *NONNULL_PTR commitment_tx, struct LDKCVec_PaymentPreimageZ preimages);
4971 * Validate the counterparty's revocation.
4973 * This is required in order for the signer to make sure that the state has moved
4974 * forward and it is safe to sign the next counterparty commitment.
4976 struct LDKCResult_NoneNoneZ (*validate_counterparty_revocation)(const void *this_arg, uint64_t idx, const uint8_t (*secret)[32]);
4978 * Create a signatures for a holder's commitment transaction and its claiming HTLC transactions.
4979 * This will only ever be called with a non-revoked commitment_tx. This will be called with the
4980 * latest commitment_tx when we initiate a force-close.
4981 * This will be called with the previous latest, just to get claiming HTLC signatures, if we are
4982 * reacting to a ChannelMonitor replica that decided to broadcast before it had been updated to
4984 * This may be called multiple times for the same transaction.
4986 * An external signer implementation should check that the commitment has not been revoked.
4988 * May return Err if key derivation fails. Callers, such as ChannelMonitor, will panic in such a case.
4990 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ (*sign_holder_commitment_and_htlcs)(const void *this_arg, const struct LDKHolderCommitmentTransaction *NONNULL_PTR commitment_tx);
4992 * Create a signature for the given input in a transaction spending an HTLC transaction output
4993 * or a commitment transaction `to_local` output when our counterparty broadcasts an old state.
4995 * A justice transaction may claim multiple outputs at the same time if timelocks are
4996 * similar, but only a signature for the input at index `input` should be signed for here.
4997 * It may be called multiple times for same output(s) if a fee-bump is needed with regards
4998 * to an upcoming timelock expiration.
5000 * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
5002 * per_commitment_key is revocation secret which was provided by our counterparty when they
5003 * revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
5004 * not allow the spending of any funds by itself (you need our holder revocation_secret to do
5007 struct LDKCResult_SignatureNoneZ (*sign_justice_revoked_output)(const void *this_arg, struct LDKTransaction justice_tx, uintptr_t input, uint64_t amount, const uint8_t (*per_commitment_key)[32]);
5009 * Create a signature for the given input in a transaction spending a commitment transaction
5010 * HTLC output when our counterparty broadcasts an old state.
5012 * A justice transaction may claim multiple outputs at the same time if timelocks are
5013 * similar, but only a signature for the input at index `input` should be signed for here.
5014 * It may be called multiple times for same output(s) if a fee-bump is needed with regards
5015 * to an upcoming timelock expiration.
5017 * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
5019 * per_commitment_key is revocation secret which was provided by our counterparty when they
5020 * revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
5021 * not allow the spending of any funds by itself (you need our holder revocation_secret to do
5024 * htlc holds HTLC elements (hash, timelock), thus changing the format of the witness script
5025 * (which is committed to in the BIP 143 signatures).
5027 struct LDKCResult_SignatureNoneZ (*sign_justice_revoked_htlc)(const void *this_arg, struct LDKTransaction justice_tx, uintptr_t input, uint64_t amount, const uint8_t (*per_commitment_key)[32], const struct LDKHTLCOutputInCommitment *NONNULL_PTR htlc);
5029 * Create a signature for a claiming transaction for a HTLC output on a counterparty's commitment
5030 * transaction, either offered or received.
5032 * Such a transaction may claim multiples offered outputs at same time if we know the
5033 * preimage for each when we create it, but only the input at index `input` should be
5034 * signed for here. It may be called multiple times for same output(s) if a fee-bump is
5035 * needed with regards to an upcoming timelock expiration.
5037 * Witness_script is either a offered or received script as defined in BOLT3 for HTLC
5040 * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
5042 * Per_commitment_point is the dynamic point corresponding to the channel state
5043 * detected onchain. It has been generated by our counterparty and is used to derive
5044 * channel state keys, which are then included in the witness script and committed to in the
5045 * BIP 143 signature.
5047 struct LDKCResult_SignatureNoneZ (*sign_counterparty_htlc_transaction)(const void *this_arg, struct LDKTransaction htlc_tx, uintptr_t input, uint64_t amount, struct LDKPublicKey per_commitment_point, const struct LDKHTLCOutputInCommitment *NONNULL_PTR htlc);
5049 * Create a signature for a (proposed) closing transaction.
5051 * Note that, due to rounding, there may be one \"missing\" satoshi, and either party may have
5052 * chosen to forgo their output as dust.
5054 struct LDKCResult_SignatureNoneZ (*sign_closing_transaction)(const void *this_arg, const struct LDKClosingTransaction *NONNULL_PTR closing_tx);
5056 * Signs a channel announcement message with our funding key and our node secret key (aka
5057 * node_id or network_key), proving it comes from one of the channel participants.
5059 * The first returned signature should be from our node secret key, the second from our
5062 * Note that if this fails or is rejected, the channel will not be publicly announced and
5063 * our counterparty may (though likely will not) close the channel on us for violating the
5066 struct LDKCResult_C2Tuple_SignatureSignatureZNoneZ (*sign_channel_announcement)(const void *this_arg, const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR msg);
5068 * Set the counterparty static channel data, including basepoints,
5069 * counterparty_selected/holder_selected_contest_delay and funding outpoint.
5070 * This is done as soon as the funding outpoint is known. Since these are static channel data,
5071 * they MUST NOT be allowed to change to different values once set.
5073 * channel_parameters.is_populated() MUST be true.
5075 * We bind holder_selected_contest_delay late here for API convenience.
5077 * Will be called before any signatures are applied.
5079 void (*ready_channel)(void *this_arg, const struct LDKChannelTransactionParameters *NONNULL_PTR channel_parameters);
5081 * Frees any resources associated with this object given its this_arg pointer.
5082 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
5084 void (*free)(void *this_arg);
5088 * A cloneable signer.
5090 * Although we require signers to be cloneable, it may be useful for developers to be able to use
5091 * signers in an un-sized way, for example as `dyn BaseSign`. Therefore we separate the Clone trait,
5092 * which implies Sized, into this derived trait.
5094 typedef struct LDKSign {
5096 * An opaque pointer which is passed to your function implementations as an argument.
5097 * This has no meaning in the LDK, and can be NULL or any other value.
5101 * Implementation of BaseSign for this object.
5103 struct LDKBaseSign BaseSign;
5105 * Serialize the object into a byte array
5107 struct LDKCVec_u8Z (*write)(const void *this_arg);
5109 * Called, if set, after this Sign has been cloned into a duplicate object.
5110 * The new Sign is provided, and should be mutated as needed to perform a
5111 * deep copy of the object pointed to by this_arg or avoid any double-freeing.
5113 void (*cloned)(struct LDKSign *NONNULL_PTR new_Sign);
5115 * Frees any resources associated with this object given its this_arg pointer.
5116 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
5118 void (*free)(void *this_arg);
5122 * The contents of CResult_SignDecodeErrorZ
5124 typedef union LDKCResult_SignDecodeErrorZPtr {
5126 * A pointer to the contents in the success state.
5127 * Reading from this pointer when `result_ok` is not set is undefined.
5129 struct LDKSign *result;
5131 * A pointer to the contents in the error state.
5132 * Reading from this pointer when `result_ok` is set is undefined.
5134 struct LDKDecodeError *err;
5135 } LDKCResult_SignDecodeErrorZPtr;
5138 * A CResult_SignDecodeErrorZ represents the result of a fallible operation,
5139 * containing a crate::lightning::chain::keysinterface::Sign on success and a crate::lightning::ln::msgs::DecodeError on failure.
5140 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5142 typedef struct LDKCResult_SignDecodeErrorZ {
5144 * The contents of this CResult_SignDecodeErrorZ, accessible via either
5145 * `err` or `result` depending on the state of `result_ok`.
5147 union LDKCResult_SignDecodeErrorZPtr contents;
5149 * Whether this CResult_SignDecodeErrorZ represents a success state.
5152 } LDKCResult_SignDecodeErrorZ;
5155 * Integer in the range `0..32`
5157 typedef struct LDKu5 {
5162 * A dynamically-allocated array of crate::c_types::u5s of arbitrary size.
5163 * This corresponds to std::vector in C++
5165 typedef struct LDKCVec_u5Z {
5167 * The elements in the array.
5168 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5172 * The number of elements pointed to by `data`.
5178 * Represents a secp256k1 signature serialized as two 32-byte numbers as well as a tag which
5179 * allows recovering the exact public key which created the signature given the message.
5181 typedef struct LDKRecoverableSignature {
5183 * The bytes of the signature in "compact" form plus a "Recovery ID" which allows for
5186 uint8_t serialized_form[68];
5187 } LDKRecoverableSignature;
5190 * The contents of CResult_RecoverableSignatureNoneZ
5192 typedef union LDKCResult_RecoverableSignatureNoneZPtr {
5194 * A pointer to the contents in the success state.
5195 * Reading from this pointer when `result_ok` is not set is undefined.
5197 struct LDKRecoverableSignature *result;
5199 * Note that this value is always NULL, as there are no contents in the Err variant
5202 } LDKCResult_RecoverableSignatureNoneZPtr;
5205 * A CResult_RecoverableSignatureNoneZ represents the result of a fallible operation,
5206 * containing a crate::c_types::RecoverableSignature on success and a () on failure.
5207 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5209 typedef struct LDKCResult_RecoverableSignatureNoneZ {
5211 * The contents of this CResult_RecoverableSignatureNoneZ, accessible via either
5212 * `err` or `result` depending on the state of `result_ok`.
5214 union LDKCResult_RecoverableSignatureNoneZPtr contents;
5216 * Whether this CResult_RecoverableSignatureNoneZ represents a success state.
5219 } LDKCResult_RecoverableSignatureNoneZ;
5222 * A dynamically-allocated array of crate::c_types::derived::CVec_u8Zs of arbitrary size.
5223 * This corresponds to std::vector in C++
5225 typedef struct LDKCVec_CVec_u8ZZ {
5227 * The elements in the array.
5228 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5230 struct LDKCVec_u8Z *data;
5232 * The number of elements pointed to by `data`.
5235 } LDKCVec_CVec_u8ZZ;
5238 * The contents of CResult_CVec_CVec_u8ZZNoneZ
5240 typedef union LDKCResult_CVec_CVec_u8ZZNoneZPtr {
5242 * A pointer to the contents in the success state.
5243 * Reading from this pointer when `result_ok` is not set is undefined.
5245 struct LDKCVec_CVec_u8ZZ *result;
5247 * Note that this value is always NULL, as there are no contents in the Err variant
5250 } LDKCResult_CVec_CVec_u8ZZNoneZPtr;
5253 * A CResult_CVec_CVec_u8ZZNoneZ represents the result of a fallible operation,
5254 * containing a crate::c_types::derived::CVec_CVec_u8ZZ on success and a () on failure.
5255 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5257 typedef struct LDKCResult_CVec_CVec_u8ZZNoneZ {
5259 * The contents of this CResult_CVec_CVec_u8ZZNoneZ, accessible via either
5260 * `err` or `result` depending on the state of `result_ok`.
5262 union LDKCResult_CVec_CVec_u8ZZNoneZPtr contents;
5264 * Whether this CResult_CVec_CVec_u8ZZNoneZ represents a success state.
5267 } LDKCResult_CVec_CVec_u8ZZNoneZ;
5272 * A simple implementation of Sign that just keeps the private keys in memory.
5274 * This implementation performs no policy checks and is insufficient by itself as
5275 * a secure external signer.
5277 typedef struct MUST_USE_STRUCT LDKInMemorySigner {
5279 * A pointer to the opaque Rust object.
5280 * Nearly everywhere, inner must be non-null, however in places where
5281 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5283 LDKnativeInMemorySigner *inner;
5285 * Indicates that this is the only struct which contains the same pointer.
5286 * Rust functions which take ownership of an object provided via an argument require
5287 * this to be true and invalidate the object pointed to by inner.
5290 } LDKInMemorySigner;
5293 * The contents of CResult_InMemorySignerDecodeErrorZ
5295 typedef union LDKCResult_InMemorySignerDecodeErrorZPtr {
5297 * A pointer to the contents in the success state.
5298 * Reading from this pointer when `result_ok` is not set is undefined.
5300 struct LDKInMemorySigner *result;
5302 * A pointer to the contents in the error state.
5303 * Reading from this pointer when `result_ok` is set is undefined.
5305 struct LDKDecodeError *err;
5306 } LDKCResult_InMemorySignerDecodeErrorZPtr;
5309 * A CResult_InMemorySignerDecodeErrorZ represents the result of a fallible operation,
5310 * containing a crate::lightning::chain::keysinterface::InMemorySigner on success and a crate::lightning::ln::msgs::DecodeError on failure.
5311 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5313 typedef struct LDKCResult_InMemorySignerDecodeErrorZ {
5315 * The contents of this CResult_InMemorySignerDecodeErrorZ, accessible via either
5316 * `err` or `result` depending on the state of `result_ok`.
5318 union LDKCResult_InMemorySignerDecodeErrorZPtr contents;
5320 * Whether this CResult_InMemorySignerDecodeErrorZ represents a success state.
5323 } LDKCResult_InMemorySignerDecodeErrorZ;
5326 * A dynamically-allocated array of crate::c_types::TxOuts of arbitrary size.
5327 * This corresponds to std::vector in C++
5329 typedef struct LDKCVec_TxOutZ {
5331 * The elements in the array.
5332 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5334 struct LDKTxOut *data;
5336 * The number of elements pointed to by `data`.
5342 * The contents of CResult_TransactionNoneZ
5344 typedef union LDKCResult_TransactionNoneZPtr {
5346 * A pointer to the contents in the success state.
5347 * Reading from this pointer when `result_ok` is not set is undefined.
5349 struct LDKTransaction *result;
5351 * Note that this value is always NULL, as there are no contents in the Err variant
5354 } LDKCResult_TransactionNoneZPtr;
5357 * A CResult_TransactionNoneZ represents the result of a fallible operation,
5358 * containing a crate::c_types::Transaction on success and a () on failure.
5359 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5361 typedef struct LDKCResult_TransactionNoneZ {
5363 * The contents of this CResult_TransactionNoneZ, accessible via either
5364 * `err` or `result` depending on the state of `result_ok`.
5366 union LDKCResult_TransactionNoneZPtr contents;
5368 * Whether this CResult_TransactionNoneZ represents a success state.
5371 } LDKCResult_TransactionNoneZ;
5376 * A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
5377 * on-chain transactions to ensure no loss of funds occurs.
5379 * You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
5380 * information and are actively monitoring the chain.
5382 * Pending Events or updated HTLCs which have not yet been read out by
5383 * get_and_clear_pending_monitor_events or get_and_clear_pending_events are serialized to disk and
5384 * reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
5385 * gotten are fully handled before re-serializing the new state.
5387 * Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
5388 * tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
5389 * the \"reorg path\" (ie disconnecting blocks until you find a common ancestor from both the
5390 * returned block hash and the the current chain and then reconnecting blocks to get to the
5391 * best chain) upon deserializing the object!
5393 typedef struct MUST_USE_STRUCT LDKChannelMonitor {
5395 * A pointer to the opaque Rust object.
5396 * Nearly everywhere, inner must be non-null, however in places where
5397 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5399 LDKnativeChannelMonitor *inner;
5401 * Indicates that this is the only struct which contains the same pointer.
5402 * Rust functions which take ownership of an object provided via an argument require
5403 * this to be true and invalidate the object pointed to by inner.
5406 } LDKChannelMonitor;
5409 * A tuple of 2 elements. See the individual fields for the types contained.
5411 typedef struct LDKC2Tuple_BlockHashChannelMonitorZ {
5413 * The element at position 0
5415 struct LDKThirtyTwoBytes a;
5417 * The element at position 1
5419 struct LDKChannelMonitor b;
5420 } LDKC2Tuple_BlockHashChannelMonitorZ;
5423 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_BlockHashChannelMonitorZs of arbitrary size.
5424 * This corresponds to std::vector in C++
5426 typedef struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ {
5428 * The elements in the array.
5429 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5431 struct LDKC2Tuple_BlockHashChannelMonitorZ *data;
5433 * The number of elements pointed to by `data`.
5436 } LDKCVec_C2Tuple_BlockHashChannelMonitorZZ;
5439 * The contents of CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ
5441 typedef union LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZPtr {
5443 * A pointer to the contents in the success state.
5444 * Reading from this pointer when `result_ok` is not set is undefined.
5446 struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ *result;
5448 * A pointer to the contents in the error state.
5449 * Reading from this pointer when `result_ok` is set is undefined.
5451 enum LDKIOError *err;
5452 } LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZPtr;
5455 * A CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ represents the result of a fallible operation,
5456 * containing a crate::c_types::derived::CVec_C2Tuple_BlockHashChannelMonitorZZ on success and a crate::c_types::IOError on failure.
5457 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5459 typedef struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ {
5461 * The contents of this CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ, accessible via either
5462 * `err` or `result` depending on the state of `result_ok`.
5464 union LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZPtr contents;
5466 * Whether this CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ represents a success state.
5469 } LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ;
5472 * An enum which can either contain a u16 or not
5474 typedef enum LDKCOption_u16Z_Tag {
5476 * When we're in this state, this COption_u16Z contains a u16
5478 LDKCOption_u16Z_Some,
5480 * When we're in this state, this COption_u16Z contains nothing
5482 LDKCOption_u16Z_None,
5484 * Must be last for serialization purposes
5486 LDKCOption_u16Z_Sentinel,
5487 } LDKCOption_u16Z_Tag;
5489 typedef struct LDKCOption_u16Z {
5490 LDKCOption_u16Z_Tag tag;
5499 * Indicates an error on the client's part (usually some variant of attempting to use too-low or
5502 typedef enum LDKAPIError_Tag {
5504 * Indicates the API was wholly misused (see err for more). Cases where these can be returned
5505 * are documented, but generally indicates some precondition of a function was violated.
5507 LDKAPIError_APIMisuseError,
5509 * Due to a high feerate, we were unable to complete the request.
5510 * For example, this may be returned if the feerate implies we cannot open a channel at the
5511 * requested value, but opening a larger channel would succeed.
5513 LDKAPIError_FeeRateTooHigh,
5515 * A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
5516 * too-many-hops, etc).
5518 LDKAPIError_RouteError,
5520 * We were unable to complete the request as the Channel required to do so is unable to
5521 * complete the request (or was not found). This can take many forms, including disconnected
5522 * peer, channel at capacity, channel shutting down, etc.
5524 LDKAPIError_ChannelUnavailable,
5526 * An attempt to call watch/update_channel returned an Err (ie you did this!), causing the
5527 * attempted action to fail.
5529 LDKAPIError_MonitorUpdateFailed,
5531 * [`KeysInterface::get_shutdown_scriptpubkey`] returned a shutdown scriptpubkey incompatible
5532 * with the channel counterparty as negotiated in [`InitFeatures`].
5534 * Using a SegWit v0 script should resolve this issue. If you cannot, you won't be able to open
5535 * a channel or cooperatively close one with this peer (and will have to force-close instead).
5537 * [`KeysInterface::get_shutdown_scriptpubkey`]: crate::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey
5538 * [`InitFeatures`]: crate::ln::features::InitFeatures
5540 LDKAPIError_IncompatibleShutdownScript,
5542 * Must be last for serialization purposes
5544 LDKAPIError_Sentinel,
5547 typedef struct LDKAPIError_LDKAPIMisuseError_Body {
5549 * A human-readable error message
5552 } LDKAPIError_LDKAPIMisuseError_Body;
5554 typedef struct LDKAPIError_LDKFeeRateTooHigh_Body {
5556 * A human-readable error message
5560 * The feerate which was too high.
5563 } LDKAPIError_LDKFeeRateTooHigh_Body;
5565 typedef struct LDKAPIError_LDKRouteError_Body {
5567 * A human-readable error message
5570 } LDKAPIError_LDKRouteError_Body;
5572 typedef struct LDKAPIError_LDKChannelUnavailable_Body {
5574 * A human-readable error message
5577 } LDKAPIError_LDKChannelUnavailable_Body;
5579 typedef struct LDKAPIError_LDKIncompatibleShutdownScript_Body {
5581 * The incompatible shutdown script.
5583 struct LDKShutdownScript script;
5584 } LDKAPIError_LDKIncompatibleShutdownScript_Body;
5586 typedef struct MUST_USE_STRUCT LDKAPIError {
5587 LDKAPIError_Tag tag;
5589 LDKAPIError_LDKAPIMisuseError_Body api_misuse_error;
5590 LDKAPIError_LDKFeeRateTooHigh_Body fee_rate_too_high;
5591 LDKAPIError_LDKRouteError_Body route_error;
5592 LDKAPIError_LDKChannelUnavailable_Body channel_unavailable;
5593 LDKAPIError_LDKIncompatibleShutdownScript_Body incompatible_shutdown_script;
5598 * The contents of CResult_NoneAPIErrorZ
5600 typedef union LDKCResult_NoneAPIErrorZPtr {
5602 * Note that this value is always NULL, as there are no contents in the OK variant
5606 * A pointer to the contents in the error state.
5607 * Reading from this pointer when `result_ok` is set is undefined.
5609 struct LDKAPIError *err;
5610 } LDKCResult_NoneAPIErrorZPtr;
5613 * A CResult_NoneAPIErrorZ represents the result of a fallible operation,
5614 * containing a () on success and a crate::lightning::util::errors::APIError on failure.
5615 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5617 typedef struct LDKCResult_NoneAPIErrorZ {
5619 * The contents of this CResult_NoneAPIErrorZ, accessible via either
5620 * `err` or `result` depending on the state of `result_ok`.
5622 union LDKCResult_NoneAPIErrorZPtr contents;
5624 * Whether this CResult_NoneAPIErrorZ represents a success state.
5627 } LDKCResult_NoneAPIErrorZ;
5630 * A dynamically-allocated array of crate::c_types::derived::CResult_NoneAPIErrorZs of arbitrary size.
5631 * This corresponds to std::vector in C++
5633 typedef struct LDKCVec_CResult_NoneAPIErrorZZ {
5635 * The elements in the array.
5636 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5638 struct LDKCResult_NoneAPIErrorZ *data;
5640 * The number of elements pointed to by `data`.
5643 } LDKCVec_CResult_NoneAPIErrorZZ;
5646 * A dynamically-allocated array of crate::lightning::util::errors::APIErrors of arbitrary size.
5647 * This corresponds to std::vector in C++
5649 typedef struct LDKCVec_APIErrorZ {
5651 * The elements in the array.
5652 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5654 struct LDKAPIError *data;
5656 * The number of elements pointed to by `data`.
5659 } LDKCVec_APIErrorZ;
5662 * The contents of CResult__u832APIErrorZ
5664 typedef union LDKCResult__u832APIErrorZPtr {
5666 * A pointer to the contents in the success state.
5667 * Reading from this pointer when `result_ok` is not set is undefined.
5669 struct LDKThirtyTwoBytes *result;
5671 * A pointer to the contents in the error state.
5672 * Reading from this pointer when `result_ok` is set is undefined.
5674 struct LDKAPIError *err;
5675 } LDKCResult__u832APIErrorZPtr;
5678 * A CResult__u832APIErrorZ represents the result of a fallible operation,
5679 * containing a crate::c_types::ThirtyTwoBytes on success and a crate::lightning::util::errors::APIError on failure.
5680 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5682 typedef struct LDKCResult__u832APIErrorZ {
5684 * The contents of this CResult__u832APIErrorZ, accessible via either
5685 * `err` or `result` depending on the state of `result_ok`.
5687 union LDKCResult__u832APIErrorZPtr contents;
5689 * Whether this CResult__u832APIErrorZ represents a success state.
5692 } LDKCResult__u832APIErrorZ;
5695 * If a payment fails to send, it can be in one of several states. This enum is returned as the
5696 * Err() type describing which state the payment is in, see the description of individual enum
5699 typedef enum LDKPaymentSendFailure_Tag {
5701 * A parameter which was passed to send_payment was invalid, preventing us from attempting to
5702 * send the payment at all. No channel state has been changed or messages sent to peers, and
5703 * once you've changed the parameter at error, you can freely retry the payment in full.
5705 LDKPaymentSendFailure_ParameterError,
5707 * A parameter in a single path which was passed to send_payment was invalid, preventing us
5708 * from attempting to send the payment at all. No channel state has been changed or messages
5709 * sent to peers, and once you've changed the parameter at error, you can freely retry the
5712 * The results here are ordered the same as the paths in the route object which was passed to
5715 LDKPaymentSendFailure_PathParameterError,
5717 * All paths which were attempted failed to send, with no channel state change taking place.
5718 * You can freely retry the payment in full (though you probably want to do so over different
5719 * paths than the ones selected).
5721 LDKPaymentSendFailure_AllFailedRetrySafe,
5723 * Some paths which were attempted failed to send, though possibly not all. At least some
5724 * paths have irrevocably committed to the HTLC and retrying the payment in full would result
5725 * in over-/re-payment.
5727 * The results here are ordered the same as the paths in the route object which was passed to
5728 * send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
5729 * retried (though there is currently no API with which to do so).
5731 * Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
5732 * as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
5733 * case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
5734 * with the latest update_id.
5736 LDKPaymentSendFailure_PartialFailure,
5738 * Must be last for serialization purposes
5740 LDKPaymentSendFailure_Sentinel,
5741 } LDKPaymentSendFailure_Tag;
5743 typedef struct LDKPaymentSendFailure_LDKPartialFailure_Body {
5745 * The errors themselves, in the same order as the route hops.
5747 struct LDKCVec_CResult_NoneAPIErrorZZ results;
5749 * If some paths failed without irrevocably committing to the new HTLC(s), this will
5750 * contain a [`RouteParameters`] object which can be used to calculate a new route that
5751 * will pay all remaining unpaid balance.
5753 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
5755 struct LDKRouteParameters failed_paths_retry;
5757 * The payment id for the payment, which is now at least partially pending.
5759 struct LDKThirtyTwoBytes payment_id;
5760 } LDKPaymentSendFailure_LDKPartialFailure_Body;
5762 typedef struct MUST_USE_STRUCT LDKPaymentSendFailure {
5763 LDKPaymentSendFailure_Tag tag;
5766 struct LDKAPIError parameter_error;
5769 struct LDKCVec_CResult_NoneAPIErrorZZ path_parameter_error;
5772 struct LDKCVec_APIErrorZ all_failed_retry_safe;
5774 LDKPaymentSendFailure_LDKPartialFailure_Body partial_failure;
5776 } LDKPaymentSendFailure;
5779 * The contents of CResult_PaymentIdPaymentSendFailureZ
5781 typedef union LDKCResult_PaymentIdPaymentSendFailureZPtr {
5783 * A pointer to the contents in the success state.
5784 * Reading from this pointer when `result_ok` is not set is undefined.
5786 struct LDKThirtyTwoBytes *result;
5788 * A pointer to the contents in the error state.
5789 * Reading from this pointer when `result_ok` is set is undefined.
5791 struct LDKPaymentSendFailure *err;
5792 } LDKCResult_PaymentIdPaymentSendFailureZPtr;
5795 * A CResult_PaymentIdPaymentSendFailureZ represents the result of a fallible operation,
5796 * containing a crate::c_types::ThirtyTwoBytes on success and a crate::lightning::ln::channelmanager::PaymentSendFailure on failure.
5797 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5799 typedef struct LDKCResult_PaymentIdPaymentSendFailureZ {
5801 * The contents of this CResult_PaymentIdPaymentSendFailureZ, accessible via either
5802 * `err` or `result` depending on the state of `result_ok`.
5804 union LDKCResult_PaymentIdPaymentSendFailureZPtr contents;
5806 * Whether this CResult_PaymentIdPaymentSendFailureZ represents a success state.
5809 } LDKCResult_PaymentIdPaymentSendFailureZ;
5812 * The contents of CResult_NonePaymentSendFailureZ
5814 typedef union LDKCResult_NonePaymentSendFailureZPtr {
5816 * Note that this value is always NULL, as there are no contents in the OK variant
5820 * A pointer to the contents in the error state.
5821 * Reading from this pointer when `result_ok` is set is undefined.
5823 struct LDKPaymentSendFailure *err;
5824 } LDKCResult_NonePaymentSendFailureZPtr;
5827 * A CResult_NonePaymentSendFailureZ represents the result of a fallible operation,
5828 * containing a () on success and a crate::lightning::ln::channelmanager::PaymentSendFailure on failure.
5829 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5831 typedef struct LDKCResult_NonePaymentSendFailureZ {
5833 * The contents of this CResult_NonePaymentSendFailureZ, accessible via either
5834 * `err` or `result` depending on the state of `result_ok`.
5836 union LDKCResult_NonePaymentSendFailureZPtr contents;
5838 * Whether this CResult_NonePaymentSendFailureZ represents a success state.
5841 } LDKCResult_NonePaymentSendFailureZ;
5844 * A tuple of 2 elements. See the individual fields for the types contained.
5846 typedef struct LDKC2Tuple_PaymentHashPaymentIdZ {
5848 * The element at position 0
5850 struct LDKThirtyTwoBytes a;
5852 * The element at position 1
5854 struct LDKThirtyTwoBytes b;
5855 } LDKC2Tuple_PaymentHashPaymentIdZ;
5858 * The contents of CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ
5860 typedef union LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZPtr {
5862 * A pointer to the contents in the success state.
5863 * Reading from this pointer when `result_ok` is not set is undefined.
5865 struct LDKC2Tuple_PaymentHashPaymentIdZ *result;
5867 * A pointer to the contents in the error state.
5868 * Reading from this pointer when `result_ok` is set is undefined.
5870 struct LDKPaymentSendFailure *err;
5871 } LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZPtr;
5874 * A CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ represents the result of a fallible operation,
5875 * containing a crate::c_types::derived::C2Tuple_PaymentHashPaymentIdZ on success and a crate::lightning::ln::channelmanager::PaymentSendFailure on failure.
5876 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5878 typedef struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ {
5880 * The contents of this CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ, accessible via either
5881 * `err` or `result` depending on the state of `result_ok`.
5883 union LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZPtr contents;
5885 * Whether this CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ represents a success state.
5888 } LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ;
5891 * A 4-byte byte array.
5893 typedef struct LDKFourBytes {
5901 * A 16-byte byte array.
5903 typedef struct LDKSixteenBytes {
5911 * A 12-byte byte array.
5913 typedef struct LDKTwelveBytes {
5921 * An address which can be used to connect to a remote peer
5923 typedef enum LDKNetAddress_Tag {
5925 * An IPv4 address/port on which the peer is listening.
5929 * An IPv6 address/port on which the peer is listening.
5933 * An old-style Tor onion address/port on which the peer is listening.
5935 * This field is deprecated and the Tor network generally no longer supports V2 Onion
5936 * addresses. Thus, the details are not parsed here.
5938 LDKNetAddress_OnionV2,
5940 * A new-style Tor onion address/port on which the peer is listening.
5941 * To create the human-readable \"hostname\", concatenate ed25519_pubkey, checksum, and version,
5942 * wrap as base32 and append \".onion\".
5944 LDKNetAddress_OnionV3,
5946 * Must be last for serialization purposes
5948 LDKNetAddress_Sentinel,
5949 } LDKNetAddress_Tag;
5951 typedef struct LDKNetAddress_LDKIPv4_Body {
5953 * The 4-byte IPv4 address
5955 struct LDKFourBytes addr;
5957 * The port on which the node is listening
5960 } LDKNetAddress_LDKIPv4_Body;
5962 typedef struct LDKNetAddress_LDKIPv6_Body {
5964 * The 16-byte IPv6 address
5966 struct LDKSixteenBytes addr;
5968 * The port on which the node is listening
5971 } LDKNetAddress_LDKIPv6_Body;
5973 typedef struct LDKNetAddress_LDKOnionV3_Body {
5975 * The ed25519 long-term public key of the peer
5977 struct LDKThirtyTwoBytes ed25519_pubkey;
5979 * The checksum of the pubkey and version, as included in the onion address
5983 * The version byte, as defined by the Tor Onion v3 spec.
5987 * The port on which the node is listening
5990 } LDKNetAddress_LDKOnionV3_Body;
5992 typedef struct MUST_USE_STRUCT LDKNetAddress {
5993 LDKNetAddress_Tag tag;
5995 LDKNetAddress_LDKIPv4_Body i_pv4;
5996 LDKNetAddress_LDKIPv6_Body i_pv6;
5998 struct LDKTwelveBytes onion_v2;
6000 LDKNetAddress_LDKOnionV3_Body onion_v3;
6005 * A dynamically-allocated array of crate::lightning::ln::msgs::NetAddresss of arbitrary size.
6006 * This corresponds to std::vector in C++
6008 typedef struct LDKCVec_NetAddressZ {
6010 * The elements in the array.
6011 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6013 struct LDKNetAddress *data;
6015 * The number of elements pointed to by `data`.
6018 } LDKCVec_NetAddressZ;
6021 * A tuple of 2 elements. See the individual fields for the types contained.
6023 typedef struct LDKC2Tuple_PaymentHashPaymentSecretZ {
6025 * The element at position 0
6027 struct LDKThirtyTwoBytes a;
6029 * The element at position 1
6031 struct LDKThirtyTwoBytes b;
6032 } LDKC2Tuple_PaymentHashPaymentSecretZ;
6035 * The contents of CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ
6037 typedef union LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZPtr {
6039 * A pointer to the contents in the success state.
6040 * Reading from this pointer when `result_ok` is not set is undefined.
6042 struct LDKC2Tuple_PaymentHashPaymentSecretZ *result;
6044 * Note that this value is always NULL, as there are no contents in the Err variant
6047 } LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZPtr;
6050 * A CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ represents the result of a fallible operation,
6051 * containing a crate::c_types::derived::C2Tuple_PaymentHashPaymentSecretZ on success and a () on failure.
6052 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6054 typedef struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ {
6056 * The contents of this CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ, accessible via either
6057 * `err` or `result` depending on the state of `result_ok`.
6059 union LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZPtr contents;
6061 * Whether this CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ represents a success state.
6064 } LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ;
6067 * The contents of CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ
6069 typedef union LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZPtr {
6071 * A pointer to the contents in the success state.
6072 * Reading from this pointer when `result_ok` is not set is undefined.
6074 struct LDKC2Tuple_PaymentHashPaymentSecretZ *result;
6076 * A pointer to the contents in the error state.
6077 * Reading from this pointer when `result_ok` is set is undefined.
6079 struct LDKAPIError *err;
6080 } LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZPtr;
6083 * A CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ represents the result of a fallible operation,
6084 * containing a crate::c_types::derived::C2Tuple_PaymentHashPaymentSecretZ on success and a crate::lightning::util::errors::APIError on failure.
6085 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6087 typedef struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ {
6089 * The contents of this CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ, accessible via either
6090 * `err` or `result` depending on the state of `result_ok`.
6092 union LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZPtr contents;
6094 * Whether this CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ represents a success state.
6097 } LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ;
6100 * The contents of CResult_PaymentSecretNoneZ
6102 typedef union LDKCResult_PaymentSecretNoneZPtr {
6104 * A pointer to the contents in the success state.
6105 * Reading from this pointer when `result_ok` is not set is undefined.
6107 struct LDKThirtyTwoBytes *result;
6109 * Note that this value is always NULL, as there are no contents in the Err variant
6112 } LDKCResult_PaymentSecretNoneZPtr;
6115 * A CResult_PaymentSecretNoneZ represents the result of a fallible operation,
6116 * containing a crate::c_types::ThirtyTwoBytes on success and a () on failure.
6117 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6119 typedef struct LDKCResult_PaymentSecretNoneZ {
6121 * The contents of this CResult_PaymentSecretNoneZ, accessible via either
6122 * `err` or `result` depending on the state of `result_ok`.
6124 union LDKCResult_PaymentSecretNoneZPtr contents;
6126 * Whether this CResult_PaymentSecretNoneZ represents a success state.
6129 } LDKCResult_PaymentSecretNoneZ;
6132 * The contents of CResult_PaymentSecretAPIErrorZ
6134 typedef union LDKCResult_PaymentSecretAPIErrorZPtr {
6136 * A pointer to the contents in the success state.
6137 * Reading from this pointer when `result_ok` is not set is undefined.
6139 struct LDKThirtyTwoBytes *result;
6141 * A pointer to the contents in the error state.
6142 * Reading from this pointer when `result_ok` is set is undefined.
6144 struct LDKAPIError *err;
6145 } LDKCResult_PaymentSecretAPIErrorZPtr;
6148 * A CResult_PaymentSecretAPIErrorZ represents the result of a fallible operation,
6149 * containing a crate::c_types::ThirtyTwoBytes on success and a crate::lightning::util::errors::APIError on failure.
6150 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6152 typedef struct LDKCResult_PaymentSecretAPIErrorZ {
6154 * The contents of this CResult_PaymentSecretAPIErrorZ, accessible via either
6155 * `err` or `result` depending on the state of `result_ok`.
6157 union LDKCResult_PaymentSecretAPIErrorZPtr contents;
6159 * Whether this CResult_PaymentSecretAPIErrorZ represents a success state.
6162 } LDKCResult_PaymentSecretAPIErrorZ;
6165 * The contents of CResult_PaymentPreimageAPIErrorZ
6167 typedef union LDKCResult_PaymentPreimageAPIErrorZPtr {
6169 * A pointer to the contents in the success state.
6170 * Reading from this pointer when `result_ok` is not set is undefined.
6172 struct LDKThirtyTwoBytes *result;
6174 * A pointer to the contents in the error state.
6175 * Reading from this pointer when `result_ok` is set is undefined.
6177 struct LDKAPIError *err;
6178 } LDKCResult_PaymentPreimageAPIErrorZPtr;
6181 * A CResult_PaymentPreimageAPIErrorZ represents the result of a fallible operation,
6182 * containing a crate::c_types::ThirtyTwoBytes on success and a crate::lightning::util::errors::APIError on failure.
6183 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6185 typedef struct LDKCResult_PaymentPreimageAPIErrorZ {
6187 * The contents of this CResult_PaymentPreimageAPIErrorZ, accessible via either
6188 * `err` or `result` depending on the state of `result_ok`.
6190 union LDKCResult_PaymentPreimageAPIErrorZPtr contents;
6192 * Whether this CResult_PaymentPreimageAPIErrorZ represents a success state.
6195 } LDKCResult_PaymentPreimageAPIErrorZ;
6200 * Information needed for constructing an invoice route hint for this channel.
6202 typedef struct MUST_USE_STRUCT LDKCounterpartyForwardingInfo {
6204 * A pointer to the opaque Rust object.
6205 * Nearly everywhere, inner must be non-null, however in places where
6206 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6208 LDKnativeCounterpartyForwardingInfo *inner;
6210 * Indicates that this is the only struct which contains the same pointer.
6211 * Rust functions which take ownership of an object provided via an argument require
6212 * this to be true and invalidate the object pointed to by inner.
6215 } LDKCounterpartyForwardingInfo;
6218 * The contents of CResult_CounterpartyForwardingInfoDecodeErrorZ
6220 typedef union LDKCResult_CounterpartyForwardingInfoDecodeErrorZPtr {
6222 * A pointer to the contents in the success state.
6223 * Reading from this pointer when `result_ok` is not set is undefined.
6225 struct LDKCounterpartyForwardingInfo *result;
6227 * A pointer to the contents in the error state.
6228 * Reading from this pointer when `result_ok` is set is undefined.
6230 struct LDKDecodeError *err;
6231 } LDKCResult_CounterpartyForwardingInfoDecodeErrorZPtr;
6234 * A CResult_CounterpartyForwardingInfoDecodeErrorZ represents the result of a fallible operation,
6235 * containing a crate::lightning::ln::channelmanager::CounterpartyForwardingInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
6236 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6238 typedef struct LDKCResult_CounterpartyForwardingInfoDecodeErrorZ {
6240 * The contents of this CResult_CounterpartyForwardingInfoDecodeErrorZ, accessible via either
6241 * `err` or `result` depending on the state of `result_ok`.
6243 union LDKCResult_CounterpartyForwardingInfoDecodeErrorZPtr contents;
6245 * Whether this CResult_CounterpartyForwardingInfoDecodeErrorZ represents a success state.
6248 } LDKCResult_CounterpartyForwardingInfoDecodeErrorZ;
6253 * Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
6254 * to better separate parameters.
6256 typedef struct MUST_USE_STRUCT LDKChannelCounterparty {
6258 * A pointer to the opaque Rust object.
6259 * Nearly everywhere, inner must be non-null, however in places where
6260 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6262 LDKnativeChannelCounterparty *inner;
6264 * Indicates that this is the only struct which contains the same pointer.
6265 * Rust functions which take ownership of an object provided via an argument require
6266 * this to be true and invalidate the object pointed to by inner.
6269 } LDKChannelCounterparty;
6272 * The contents of CResult_ChannelCounterpartyDecodeErrorZ
6274 typedef union LDKCResult_ChannelCounterpartyDecodeErrorZPtr {
6276 * A pointer to the contents in the success state.
6277 * Reading from this pointer when `result_ok` is not set is undefined.
6279 struct LDKChannelCounterparty *result;
6281 * A pointer to the contents in the error state.
6282 * Reading from this pointer when `result_ok` is set is undefined.
6284 struct LDKDecodeError *err;
6285 } LDKCResult_ChannelCounterpartyDecodeErrorZPtr;
6288 * A CResult_ChannelCounterpartyDecodeErrorZ represents the result of a fallible operation,
6289 * containing a crate::lightning::ln::channelmanager::ChannelCounterparty on success and a crate::lightning::ln::msgs::DecodeError on failure.
6290 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6292 typedef struct LDKCResult_ChannelCounterpartyDecodeErrorZ {
6294 * The contents of this CResult_ChannelCounterpartyDecodeErrorZ, accessible via either
6295 * `err` or `result` depending on the state of `result_ok`.
6297 union LDKCResult_ChannelCounterpartyDecodeErrorZPtr contents;
6299 * Whether this CResult_ChannelCounterpartyDecodeErrorZ represents a success state.
6302 } LDKCResult_ChannelCounterpartyDecodeErrorZ;
6305 * The contents of CResult_ChannelDetailsDecodeErrorZ
6307 typedef union LDKCResult_ChannelDetailsDecodeErrorZPtr {
6309 * A pointer to the contents in the success state.
6310 * Reading from this pointer when `result_ok` is not set is undefined.
6312 struct LDKChannelDetails *result;
6314 * A pointer to the contents in the error state.
6315 * Reading from this pointer when `result_ok` is set is undefined.
6317 struct LDKDecodeError *err;
6318 } LDKCResult_ChannelDetailsDecodeErrorZPtr;
6321 * A CResult_ChannelDetailsDecodeErrorZ represents the result of a fallible operation,
6322 * containing a crate::lightning::ln::channelmanager::ChannelDetails on success and a crate::lightning::ln::msgs::DecodeError on failure.
6323 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6325 typedef struct LDKCResult_ChannelDetailsDecodeErrorZ {
6327 * The contents of this CResult_ChannelDetailsDecodeErrorZ, accessible via either
6328 * `err` or `result` depending on the state of `result_ok`.
6330 union LDKCResult_ChannelDetailsDecodeErrorZPtr contents;
6332 * Whether this CResult_ChannelDetailsDecodeErrorZ represents a success state.
6335 } LDKCResult_ChannelDetailsDecodeErrorZ;
6340 * Route hints used in constructing invoices for [phantom node payents].
6342 * [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
6344 typedef struct MUST_USE_STRUCT LDKPhantomRouteHints {
6346 * A pointer to the opaque Rust object.
6347 * Nearly everywhere, inner must be non-null, however in places where
6348 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6350 LDKnativePhantomRouteHints *inner;
6352 * Indicates that this is the only struct which contains the same pointer.
6353 * Rust functions which take ownership of an object provided via an argument require
6354 * this to be true and invalidate the object pointed to by inner.
6357 } LDKPhantomRouteHints;
6360 * The contents of CResult_PhantomRouteHintsDecodeErrorZ
6362 typedef union LDKCResult_PhantomRouteHintsDecodeErrorZPtr {
6364 * A pointer to the contents in the success state.
6365 * Reading from this pointer when `result_ok` is not set is undefined.
6367 struct LDKPhantomRouteHints *result;
6369 * A pointer to the contents in the error state.
6370 * Reading from this pointer when `result_ok` is set is undefined.
6372 struct LDKDecodeError *err;
6373 } LDKCResult_PhantomRouteHintsDecodeErrorZPtr;
6376 * A CResult_PhantomRouteHintsDecodeErrorZ represents the result of a fallible operation,
6377 * containing a crate::lightning::ln::channelmanager::PhantomRouteHints on success and a crate::lightning::ln::msgs::DecodeError on failure.
6378 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6380 typedef struct LDKCResult_PhantomRouteHintsDecodeErrorZ {
6382 * The contents of this CResult_PhantomRouteHintsDecodeErrorZ, accessible via either
6383 * `err` or `result` depending on the state of `result_ok`.
6385 union LDKCResult_PhantomRouteHintsDecodeErrorZPtr contents;
6387 * Whether this CResult_PhantomRouteHintsDecodeErrorZ represents a success state.
6390 } LDKCResult_PhantomRouteHintsDecodeErrorZ;
6393 * A dynamically-allocated array of crate::lightning::chain::channelmonitor::ChannelMonitors of arbitrary size.
6394 * This corresponds to std::vector in C++
6396 typedef struct LDKCVec_ChannelMonitorZ {
6398 * The elements in the array.
6399 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6401 struct LDKChannelMonitor *data;
6403 * The number of elements pointed to by `data`.
6406 } LDKCVec_ChannelMonitorZ;
6411 * An update generated by the underlying Channel itself which contains some new information the
6412 * ChannelMonitor should be made aware of.
6414 typedef struct MUST_USE_STRUCT LDKChannelMonitorUpdate {
6416 * A pointer to the opaque Rust object.
6417 * Nearly everywhere, inner must be non-null, however in places where
6418 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6420 LDKnativeChannelMonitorUpdate *inner;
6422 * Indicates that this is the only struct which contains the same pointer.
6423 * Rust functions which take ownership of an object provided via an argument require
6424 * this to be true and invalidate the object pointed to by inner.
6427 } LDKChannelMonitorUpdate;
6430 * The `Watch` trait defines behavior for watching on-chain activity pertaining to channels as
6431 * blocks are connected and disconnected.
6433 * Each channel is associated with a [`ChannelMonitor`]. Implementations of this trait are
6434 * responsible for maintaining a set of monitors such that they can be updated accordingly as
6435 * channel state changes and HTLCs are resolved. See method documentation for specific
6438 * Implementations **must** ensure that updates are successfully applied and persisted upon method
6439 * completion. If an update fails with a [`PermanentFailure`], then it must immediately shut down
6440 * without taking any further action such as persisting the current state.
6442 * If an implementation maintains multiple instances of a channel's monitor (e.g., by storing
6443 * backup copies), then it must ensure that updates are applied across all instances. Otherwise, it
6444 * could result in a revoked transaction being broadcast, allowing the counterparty to claim all
6445 * funds in the channel. See [`ChannelMonitorUpdateErr`] for more details about how to handle
6446 * multiple instances.
6448 * [`PermanentFailure`]: ChannelMonitorUpdateErr::PermanentFailure
6450 typedef struct LDKWatch {
6452 * An opaque pointer which is passed to your function implementations as an argument.
6453 * This has no meaning in the LDK, and can be NULL or any other value.
6457 * Watches a channel identified by `funding_txo` using `monitor`.
6459 * Implementations are responsible for watching the chain for the funding transaction along
6460 * with any spends of outputs returned by [`get_outputs_to_watch`]. In practice, this means
6461 * calling [`block_connected`] and [`block_disconnected`] on the monitor.
6463 * Note: this interface MUST error with `ChannelMonitorUpdateErr::PermanentFailure` if
6464 * the given `funding_txo` has previously been registered via `watch_channel`.
6466 * [`get_outputs_to_watch`]: channelmonitor::ChannelMonitor::get_outputs_to_watch
6467 * [`block_connected`]: channelmonitor::ChannelMonitor::block_connected
6468 * [`block_disconnected`]: channelmonitor::ChannelMonitor::block_disconnected
6470 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*watch_channel)(const void *this_arg, struct LDKOutPoint funding_txo, struct LDKChannelMonitor monitor);
6472 * Updates a channel identified by `funding_txo` by applying `update` to its monitor.
6474 * Implementations must call [`update_monitor`] with the given update. See
6475 * [`ChannelMonitorUpdateErr`] for invariants around returning an error.
6477 * [`update_monitor`]: channelmonitor::ChannelMonitor::update_monitor
6479 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*update_channel)(const void *this_arg, struct LDKOutPoint funding_txo, struct LDKChannelMonitorUpdate update);
6481 * Returns any monitor events since the last call. Subsequent calls must only return new
6484 * Note that after any block- or transaction-connection calls to a [`ChannelMonitor`], no
6485 * further events may be returned here until the [`ChannelMonitor`] has been fully persisted
6488 * For details on asynchronous [`ChannelMonitor`] updating and returning
6489 * [`MonitorEvent::UpdateCompleted`] here, see [`ChannelMonitorUpdateErr::TemporaryFailure`].
6491 struct LDKCVec_MonitorEventZ (*release_pending_monitor_events)(const void *this_arg);
6493 * Frees any resources associated with this object given its this_arg pointer.
6494 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6496 void (*free)(void *this_arg);
6500 * An interface to send a transaction to the Bitcoin network.
6502 typedef struct LDKBroadcasterInterface {
6504 * An opaque pointer which is passed to your function implementations as an argument.
6505 * This has no meaning in the LDK, and can be NULL or any other value.
6509 * Sends a transaction out to (hopefully) be mined.
6511 void (*broadcast_transaction)(const void *this_arg, struct LDKTransaction tx);
6513 * Frees any resources associated with this object given its this_arg pointer.
6514 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6516 void (*free)(void *this_arg);
6517 } LDKBroadcasterInterface;
6520 * A "slice" referencing some byte array. This is simply a length-tagged pointer which does not
6521 * own the memory pointed to by data.
6523 typedef struct LDKu8slice {
6525 * A pointer to the byte buffer
6527 const uint8_t *data;
6529 * The number of bytes pointed to by `data`.
6535 * A trait to describe an object which can get user secrets and key material.
6537 typedef struct LDKKeysInterface {
6539 * An opaque pointer which is passed to your function implementations as an argument.
6540 * This has no meaning in the LDK, and can be NULL or any other value.
6544 * Get node secret key (aka node_id or network_key) based on the provided [`Recipient`].
6546 * This method must return the same value each time it is called with a given `Recipient`
6549 struct LDKCResult_SecretKeyNoneZ (*get_node_secret)(const void *this_arg, enum LDKRecipient recipient);
6551 * Get a script pubkey which we send funds to when claiming on-chain contestable outputs.
6553 * This method should return a different value each time it is called, to avoid linking
6554 * on-chain funds across channels as controlled to the same user.
6556 struct LDKCVec_u8Z (*get_destination_script)(const void *this_arg);
6558 * Get a script pubkey which we will send funds to when closing a channel.
6560 * This method should return a different value each time it is called, to avoid linking
6561 * on-chain funds across channels as controlled to the same user.
6563 struct LDKShutdownScript (*get_shutdown_scriptpubkey)(const void *this_arg);
6565 * Get a new set of Sign for per-channel secrets. These MUST be unique even if you
6566 * restarted with some stale data!
6568 * This method must return a different value each time it is called.
6570 struct LDKSign (*get_channel_signer)(const void *this_arg, bool inbound, uint64_t channel_value_satoshis);
6572 * Gets a unique, cryptographically-secure, random 32 byte value. This is used for encrypting
6573 * onion packets and for temporary channel IDs. There is no requirement that these be
6574 * persisted anywhere, though they must be unique across restarts.
6576 * This method must return a different value each time it is called.
6578 struct LDKThirtyTwoBytes (*get_secure_random_bytes)(const void *this_arg);
6580 * Reads a `Signer` for this `KeysInterface` from the given input stream.
6581 * This is only called during deserialization of other objects which contain
6582 * `Sign`-implementing objects (ie `ChannelMonitor`s and `ChannelManager`s).
6583 * The bytes are exactly those which `<Self::Signer as Writeable>::write()` writes, and
6584 * contain no versioning scheme. You may wish to include your own version prefix and ensure
6585 * you've read all of the provided bytes to ensure no corruption occurred.
6587 struct LDKCResult_SignDecodeErrorZ (*read_chan_signer)(const void *this_arg, struct LDKu8slice reader);
6590 * By parameterizing by the raw invoice bytes instead of the hash, we allow implementors of
6591 * this trait to parse the invoice and make sure they're signing what they expect, rather than
6592 * blindly signing the hash.
6593 * The hrp is ascii bytes, while the invoice data is base32.
6595 * The secret key used to sign the invoice is dependent on the [`Recipient`].
6597 struct LDKCResult_RecoverableSignatureNoneZ (*sign_invoice)(const void *this_arg, struct LDKu8slice hrp_bytes, struct LDKCVec_u5Z invoice_data, enum LDKRecipient receipient);
6599 * Get secret key material as bytes for use in encrypting and decrypting inbound payment data.
6601 * If the implementor of this trait supports [phantom node payments], then every node that is
6602 * intended to be included in the phantom invoice route hints must return the same value from
6605 * This method must return the same value each time it is called.
6607 * [phantom node payments]: PhantomKeysManager
6609 struct LDKThirtyTwoBytes (*get_inbound_payment_key_material)(const void *this_arg);
6611 * Frees any resources associated with this object given its this_arg pointer.
6612 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6614 void (*free)(void *this_arg);
6618 * A trait which should be implemented to provide feerate information on a number of time
6621 * Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
6622 * called from inside the library in response to chain events, P2P events, or timer events).
6624 typedef struct LDKFeeEstimator {
6626 * An opaque pointer which is passed to your function implementations as an argument.
6627 * This has no meaning in the LDK, and can be NULL or any other value.
6631 * Gets estimated satoshis of fee required per 1000 Weight-Units.
6633 * Must return a value no smaller than 253 (ie 1 satoshi-per-byte rounded up to ensure later
6634 * round-downs don't put us below 1 satoshi-per-byte).
6636 * This method can be implemented with the following unit conversions:
6637 * * max(satoshis-per-byte * 250, 253)
6638 * * max(satoshis-per-kbyte / 4, 253)
6640 uint32_t (*get_est_sat_per_1000_weight)(const void *this_arg, enum LDKConfirmationTarget confirmation_target);
6642 * Frees any resources associated with this object given its this_arg pointer.
6643 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6645 void (*free)(void *this_arg);
6651 * A Record, unit of logging output with Metadata to enable filtering
6652 * Module_path, file, line to inform on log's source
6654 typedef struct MUST_USE_STRUCT LDKRecord {
6656 * A pointer to the opaque Rust object.
6657 * Nearly everywhere, inner must be non-null, however in places where
6658 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6660 LDKnativeRecord *inner;
6662 * Indicates that this is the only struct which contains the same pointer.
6663 * Rust functions which take ownership of an object provided via an argument require
6664 * this to be true and invalidate the object pointed to by inner.
6670 * A trait encapsulating the operations required of a logger
6672 typedef struct LDKLogger {
6674 * An opaque pointer which is passed to your function implementations as an argument.
6675 * This has no meaning in the LDK, and can be NULL or any other value.
6681 void (*log)(const void *this_arg, const struct LDKRecord *NONNULL_PTR record);
6683 * Frees any resources associated with this object given its this_arg pointer.
6684 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6686 void (*free)(void *this_arg);
6692 * Manager which keeps track of a number of channels and sends messages to the appropriate
6693 * channel, also tracking HTLC preimages and forwarding onion packets appropriately.
6695 * Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
6696 * to individual Channels.
6698 * Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
6699 * all peers during write/read (though does not modify this instance, only the instance being
6700 * serialized). This will result in any channels which have not yet exchanged funding_created (ie
6701 * called funding_transaction_generated for outbound channels).
6703 * Note that you can be a bit lazier about writing out ChannelManager than you can be with
6704 * ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
6705 * returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
6706 * happens out-of-band (and will prevent any other ChannelManager operations from occurring during
6707 * the serialization process). If the deserialized version is out-of-date compared to the
6708 * ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
6709 * ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
6711 * Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
6712 * tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
6713 * the \"reorg path\" (ie call block_disconnected() until you get to a common block and then call
6714 * block_connected() to step towards your best block) upon deserialization before using the
6717 * Note that ChannelManager is responsible for tracking liveness of its channels and generating
6718 * ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
6719 * spam due to quick disconnection/reconnection, updates are not sent until the channel has been
6720 * offline for a full minute. In order to track this, you must call
6721 * timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
6723 * Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
6724 * a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
6725 * essentially you should default to using a SimpleRefChannelManager, and use a
6726 * SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
6727 * you're using lightning-net-tokio.
6729 typedef struct MUST_USE_STRUCT LDKChannelManager {
6731 * A pointer to the opaque Rust object.
6732 * Nearly everywhere, inner must be non-null, however in places where
6733 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6735 LDKnativeChannelManager *inner;
6737 * Indicates that this is the only struct which contains the same pointer.
6738 * Rust functions which take ownership of an object provided via an argument require
6739 * this to be true and invalidate the object pointed to by inner.
6742 } LDKChannelManager;
6745 * A tuple of 2 elements. See the individual fields for the types contained.
6747 typedef struct LDKC2Tuple_BlockHashChannelManagerZ {
6749 * The element at position 0
6751 struct LDKThirtyTwoBytes a;
6753 * The element at position 1
6755 struct LDKChannelManager b;
6756 } LDKC2Tuple_BlockHashChannelManagerZ;
6759 * The contents of CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ
6761 typedef union LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr {
6763 * A pointer to the contents in the success state.
6764 * Reading from this pointer when `result_ok` is not set is undefined.
6766 struct LDKC2Tuple_BlockHashChannelManagerZ *result;
6768 * A pointer to the contents in the error state.
6769 * Reading from this pointer when `result_ok` is set is undefined.
6771 struct LDKDecodeError *err;
6772 } LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr;
6775 * A CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ represents the result of a fallible operation,
6776 * containing a crate::c_types::derived::C2Tuple_BlockHashChannelManagerZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
6777 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6779 typedef struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ {
6781 * The contents of this CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ, accessible via either
6782 * `err` or `result` depending on the state of `result_ok`.
6784 union LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr contents;
6786 * Whether this CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ represents a success state.
6789 } LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ;
6794 * Options which apply on a per-channel basis and may change at runtime or based on negotiation
6795 * with our counterparty.
6797 typedef struct MUST_USE_STRUCT LDKChannelConfig {
6799 * A pointer to the opaque Rust object.
6800 * Nearly everywhere, inner must be non-null, however in places where
6801 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6803 LDKnativeChannelConfig *inner;
6805 * Indicates that this is the only struct which contains the same pointer.
6806 * Rust functions which take ownership of an object provided via an argument require
6807 * this to be true and invalidate the object pointed to by inner.
6813 * The contents of CResult_ChannelConfigDecodeErrorZ
6815 typedef union LDKCResult_ChannelConfigDecodeErrorZPtr {
6817 * A pointer to the contents in the success state.
6818 * Reading from this pointer when `result_ok` is not set is undefined.
6820 struct LDKChannelConfig *result;
6822 * A pointer to the contents in the error state.
6823 * Reading from this pointer when `result_ok` is set is undefined.
6825 struct LDKDecodeError *err;
6826 } LDKCResult_ChannelConfigDecodeErrorZPtr;
6829 * A CResult_ChannelConfigDecodeErrorZ represents the result of a fallible operation,
6830 * containing a crate::lightning::util::config::ChannelConfig on success and a crate::lightning::ln::msgs::DecodeError on failure.
6831 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6833 typedef struct LDKCResult_ChannelConfigDecodeErrorZ {
6835 * The contents of this CResult_ChannelConfigDecodeErrorZ, accessible via either
6836 * `err` or `result` depending on the state of `result_ok`.
6838 union LDKCResult_ChannelConfigDecodeErrorZPtr contents;
6840 * Whether this CResult_ChannelConfigDecodeErrorZ represents a success state.
6843 } LDKCResult_ChannelConfigDecodeErrorZ;
6846 * The contents of CResult_OutPointDecodeErrorZ
6848 typedef union LDKCResult_OutPointDecodeErrorZPtr {
6850 * A pointer to the contents in the success state.
6851 * Reading from this pointer when `result_ok` is not set is undefined.
6853 struct LDKOutPoint *result;
6855 * A pointer to the contents in the error state.
6856 * Reading from this pointer when `result_ok` is set is undefined.
6858 struct LDKDecodeError *err;
6859 } LDKCResult_OutPointDecodeErrorZPtr;
6862 * A CResult_OutPointDecodeErrorZ represents the result of a fallible operation,
6863 * containing a crate::lightning::chain::transaction::OutPoint on success and a crate::lightning::ln::msgs::DecodeError on failure.
6864 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6866 typedef struct LDKCResult_OutPointDecodeErrorZ {
6868 * The contents of this CResult_OutPointDecodeErrorZ, accessible via either
6869 * `err` or `result` depending on the state of `result_ok`.
6871 union LDKCResult_OutPointDecodeErrorZPtr contents;
6873 * Whether this CResult_OutPointDecodeErrorZ represents a success state.
6876 } LDKCResult_OutPointDecodeErrorZ;
6879 * Defines a type identifier for sending messages over the wire.
6881 * Messages implementing this trait specify a type and must be [`Writeable`].
6883 typedef struct LDKType {
6885 * An opaque pointer which is passed to your function implementations as an argument.
6886 * This has no meaning in the LDK, and can be NULL or any other value.
6890 * Returns the type identifying the message payload.
6892 uint16_t (*type_id)(const void *this_arg);
6894 * Return a human-readable "debug" string describing this object
6896 struct LDKStr (*debug_str)(const void *this_arg);
6898 * Serialize the object into a byte array
6900 struct LDKCVec_u8Z (*write)(const void *this_arg);
6902 * Frees any resources associated with this object given its this_arg pointer.
6903 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6905 void (*free)(void *this_arg);
6909 * An enum which can either contain a crate::lightning::ln::wire::Type or not
6911 typedef enum LDKCOption_TypeZ_Tag {
6913 * When we're in this state, this COption_TypeZ contains a crate::lightning::ln::wire::Type
6915 LDKCOption_TypeZ_Some,
6917 * When we're in this state, this COption_TypeZ contains nothing
6919 LDKCOption_TypeZ_None,
6921 * Must be last for serialization purposes
6923 LDKCOption_TypeZ_Sentinel,
6924 } LDKCOption_TypeZ_Tag;
6926 typedef struct LDKCOption_TypeZ {
6927 LDKCOption_TypeZ_Tag tag;
6930 struct LDKType some;
6936 * The contents of CResult_COption_TypeZDecodeErrorZ
6938 typedef union LDKCResult_COption_TypeZDecodeErrorZPtr {
6940 * A pointer to the contents in the success state.
6941 * Reading from this pointer when `result_ok` is not set is undefined.
6943 struct LDKCOption_TypeZ *result;
6945 * A pointer to the contents in the error state.
6946 * Reading from this pointer when `result_ok` is set is undefined.
6948 struct LDKDecodeError *err;
6949 } LDKCResult_COption_TypeZDecodeErrorZPtr;
6952 * A CResult_COption_TypeZDecodeErrorZ represents the result of a fallible operation,
6953 * containing a crate::c_types::derived::COption_TypeZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
6954 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6956 typedef struct LDKCResult_COption_TypeZDecodeErrorZ {
6958 * The contents of this CResult_COption_TypeZDecodeErrorZ, accessible via either
6959 * `err` or `result` depending on the state of `result_ok`.
6961 union LDKCResult_COption_TypeZDecodeErrorZPtr contents;
6963 * Whether this CResult_COption_TypeZDecodeErrorZ represents a success state.
6966 } LDKCResult_COption_TypeZDecodeErrorZ;
6969 * An error that may occur when making a payment.
6971 typedef enum LDKPaymentError_Tag {
6973 * An error resulting from the provided [`Invoice`] or payment hash.
6975 LDKPaymentError_Invoice,
6977 * An error occurring when finding a route.
6979 LDKPaymentError_Routing,
6981 * An error occurring when sending a payment.
6983 LDKPaymentError_Sending,
6985 * Must be last for serialization purposes
6987 LDKPaymentError_Sentinel,
6988 } LDKPaymentError_Tag;
6990 typedef struct MUST_USE_STRUCT LDKPaymentError {
6991 LDKPaymentError_Tag tag;
6994 struct LDKStr invoice;
6997 struct LDKLightningError routing;
7000 struct LDKPaymentSendFailure sending;
7006 * The contents of CResult_PaymentIdPaymentErrorZ
7008 typedef union LDKCResult_PaymentIdPaymentErrorZPtr {
7010 * A pointer to the contents in the success state.
7011 * Reading from this pointer when `result_ok` is not set is undefined.
7013 struct LDKThirtyTwoBytes *result;
7015 * A pointer to the contents in the error state.
7016 * Reading from this pointer when `result_ok` is set is undefined.
7018 struct LDKPaymentError *err;
7019 } LDKCResult_PaymentIdPaymentErrorZPtr;
7022 * A CResult_PaymentIdPaymentErrorZ represents the result of a fallible operation,
7023 * containing a crate::c_types::ThirtyTwoBytes on success and a crate::lightning_invoice::payment::PaymentError on failure.
7024 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7026 typedef struct LDKCResult_PaymentIdPaymentErrorZ {
7028 * The contents of this CResult_PaymentIdPaymentErrorZ, accessible via either
7029 * `err` or `result` depending on the state of `result_ok`.
7031 union LDKCResult_PaymentIdPaymentErrorZPtr contents;
7033 * Whether this CResult_PaymentIdPaymentErrorZ represents a success state.
7036 } LDKCResult_PaymentIdPaymentErrorZ;
7039 * The contents of CResult_SiPrefixNoneZ
7041 typedef union LDKCResult_SiPrefixNoneZPtr {
7043 * A pointer to the contents in the success state.
7044 * Reading from this pointer when `result_ok` is not set is undefined.
7046 enum LDKSiPrefix *result;
7048 * Note that this value is always NULL, as there are no contents in the Err variant
7051 } LDKCResult_SiPrefixNoneZPtr;
7054 * A CResult_SiPrefixNoneZ represents the result of a fallible operation,
7055 * containing a crate::lightning_invoice::SiPrefix on success and a () on failure.
7056 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7058 typedef struct LDKCResult_SiPrefixNoneZ {
7060 * The contents of this CResult_SiPrefixNoneZ, accessible via either
7061 * `err` or `result` depending on the state of `result_ok`.
7063 union LDKCResult_SiPrefixNoneZPtr contents;
7065 * Whether this CResult_SiPrefixNoneZ represents a success state.
7068 } LDKCResult_SiPrefixNoneZ;
7073 * Represents a syntactically and semantically correct lightning BOLT11 invoice.
7075 * There are three ways to construct an `Invoice`:
7076 * 1. using `InvoiceBuilder`
7077 * 2. using `Invoice::from_signed(SignedRawInvoice)`
7078 * 3. using `str::parse::<Invoice>(&str)`
7080 typedef struct MUST_USE_STRUCT LDKInvoice {
7082 * A pointer to the opaque Rust object.
7083 * Nearly everywhere, inner must be non-null, however in places where
7084 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7086 LDKnativeInvoice *inner;
7088 * Indicates that this is the only struct which contains the same pointer.
7089 * Rust functions which take ownership of an object provided via an argument require
7090 * this to be true and invalidate the object pointed to by inner.
7096 * The contents of CResult_InvoiceNoneZ
7098 typedef union LDKCResult_InvoiceNoneZPtr {
7100 * A pointer to the contents in the success state.
7101 * Reading from this pointer when `result_ok` is not set is undefined.
7103 struct LDKInvoice *result;
7105 * Note that this value is always NULL, as there are no contents in the Err variant
7108 } LDKCResult_InvoiceNoneZPtr;
7111 * A CResult_InvoiceNoneZ represents the result of a fallible operation,
7112 * containing a crate::lightning_invoice::Invoice on success and a () on failure.
7113 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7115 typedef struct LDKCResult_InvoiceNoneZ {
7117 * The contents of this CResult_InvoiceNoneZ, accessible via either
7118 * `err` or `result` depending on the state of `result_ok`.
7120 union LDKCResult_InvoiceNoneZPtr contents;
7122 * Whether this CResult_InvoiceNoneZ represents a success state.
7125 } LDKCResult_InvoiceNoneZ;
7130 * Represents a signed `RawInvoice` with cached hash. The signature is not checked and may be
7134 * The hash has to be either from the deserialized invoice or from the serialized `raw_invoice`.
7136 typedef struct MUST_USE_STRUCT LDKSignedRawInvoice {
7138 * A pointer to the opaque Rust object.
7139 * Nearly everywhere, inner must be non-null, however in places where
7140 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7142 LDKnativeSignedRawInvoice *inner;
7144 * Indicates that this is the only struct which contains the same pointer.
7145 * Rust functions which take ownership of an object provided via an argument require
7146 * this to be true and invalidate the object pointed to by inner.
7149 } LDKSignedRawInvoice;
7152 * The contents of CResult_SignedRawInvoiceNoneZ
7154 typedef union LDKCResult_SignedRawInvoiceNoneZPtr {
7156 * A pointer to the contents in the success state.
7157 * Reading from this pointer when `result_ok` is not set is undefined.
7159 struct LDKSignedRawInvoice *result;
7161 * Note that this value is always NULL, as there are no contents in the Err variant
7164 } LDKCResult_SignedRawInvoiceNoneZPtr;
7167 * A CResult_SignedRawInvoiceNoneZ represents the result of a fallible operation,
7168 * containing a crate::lightning_invoice::SignedRawInvoice on success and a () on failure.
7169 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7171 typedef struct LDKCResult_SignedRawInvoiceNoneZ {
7173 * The contents of this CResult_SignedRawInvoiceNoneZ, accessible via either
7174 * `err` or `result` depending on the state of `result_ok`.
7176 union LDKCResult_SignedRawInvoiceNoneZPtr contents;
7178 * Whether this CResult_SignedRawInvoiceNoneZ represents a success state.
7181 } LDKCResult_SignedRawInvoiceNoneZ;
7186 * Represents an syntactically correct Invoice for a payment on the lightning network,
7187 * but without the signature information.
7188 * De- and encoding should not lead to information loss but may lead to different hashes.
7190 * For methods without docs see the corresponding methods in `Invoice`.
7192 typedef struct MUST_USE_STRUCT LDKRawInvoice {
7194 * A pointer to the opaque Rust object.
7195 * Nearly everywhere, inner must be non-null, however in places where
7196 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7198 LDKnativeRawInvoice *inner;
7200 * Indicates that this is the only struct which contains the same pointer.
7201 * Rust functions which take ownership of an object provided via an argument require
7202 * this to be true and invalidate the object pointed to by inner.
7210 * Recoverable signature
7212 typedef struct MUST_USE_STRUCT LDKInvoiceSignature {
7214 * A pointer to the opaque Rust object.
7215 * Nearly everywhere, inner must be non-null, however in places where
7216 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7218 LDKnativeInvoiceSignature *inner;
7220 * Indicates that this is the only struct which contains the same pointer.
7221 * Rust functions which take ownership of an object provided via an argument require
7222 * this to be true and invalidate the object pointed to by inner.
7225 } LDKInvoiceSignature;
7228 * A tuple of 3 elements. See the individual fields for the types contained.
7230 typedef struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ {
7232 * The element at position 0
7234 struct LDKRawInvoice a;
7236 * The element at position 1
7238 struct LDKThirtyTwoBytes b;
7240 * The element at position 2
7242 struct LDKInvoiceSignature c;
7243 } LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ;
7250 typedef struct MUST_USE_STRUCT LDKPayeePubKey {
7252 * A pointer to the opaque Rust object.
7253 * Nearly everywhere, inner must be non-null, however in places where
7254 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7256 LDKnativePayeePubKey *inner;
7258 * Indicates that this is the only struct which contains the same pointer.
7259 * Rust functions which take ownership of an object provided via an argument require
7260 * this to be true and invalidate the object pointed to by inner.
7266 * The contents of CResult_PayeePubKeyErrorZ
7268 typedef union LDKCResult_PayeePubKeyErrorZPtr {
7270 * A pointer to the contents in the success state.
7271 * Reading from this pointer when `result_ok` is not set is undefined.
7273 struct LDKPayeePubKey *result;
7275 * A pointer to the contents in the error state.
7276 * Reading from this pointer when `result_ok` is set is undefined.
7278 enum LDKSecp256k1Error *err;
7279 } LDKCResult_PayeePubKeyErrorZPtr;
7282 * A CResult_PayeePubKeyErrorZ represents the result of a fallible operation,
7283 * containing a crate::lightning_invoice::PayeePubKey on success and a crate::c_types::Secp256k1Error on failure.
7284 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7286 typedef struct LDKCResult_PayeePubKeyErrorZ {
7288 * The contents of this CResult_PayeePubKeyErrorZ, accessible via either
7289 * `err` or `result` depending on the state of `result_ok`.
7291 union LDKCResult_PayeePubKeyErrorZPtr contents;
7293 * Whether this CResult_PayeePubKeyErrorZ represents a success state.
7296 } LDKCResult_PayeePubKeyErrorZ;
7301 * Private routing information
7304 * The encoded route has to be <1024 5bit characters long (<=639 bytes or <=12 hops)
7307 typedef struct MUST_USE_STRUCT LDKPrivateRoute {
7309 * A pointer to the opaque Rust object.
7310 * Nearly everywhere, inner must be non-null, however in places where
7311 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7313 LDKnativePrivateRoute *inner;
7315 * Indicates that this is the only struct which contains the same pointer.
7316 * Rust functions which take ownership of an object provided via an argument require
7317 * this to be true and invalidate the object pointed to by inner.
7323 * A dynamically-allocated array of crate::lightning_invoice::PrivateRoutes of arbitrary size.
7324 * This corresponds to std::vector in C++
7326 typedef struct LDKCVec_PrivateRouteZ {
7328 * The elements in the array.
7329 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7331 struct LDKPrivateRoute *data;
7333 * The number of elements pointed to by `data`.
7336 } LDKCVec_PrivateRouteZ;
7341 * A timestamp that refers to a date after 1 January 1970.
7345 * The Unix timestamp representing the stored time has to be positive and no greater than
7346 * [`MAX_TIMESTAMP`].
7348 typedef struct MUST_USE_STRUCT LDKPositiveTimestamp {
7350 * A pointer to the opaque Rust object.
7351 * Nearly everywhere, inner must be non-null, however in places where
7352 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7354 LDKnativePositiveTimestamp *inner;
7356 * Indicates that this is the only struct which contains the same pointer.
7357 * Rust functions which take ownership of an object provided via an argument require
7358 * this to be true and invalidate the object pointed to by inner.
7361 } LDKPositiveTimestamp;
7364 * The contents of CResult_PositiveTimestampCreationErrorZ
7366 typedef union LDKCResult_PositiveTimestampCreationErrorZPtr {
7368 * A pointer to the contents in the success state.
7369 * Reading from this pointer when `result_ok` is not set is undefined.
7371 struct LDKPositiveTimestamp *result;
7373 * A pointer to the contents in the error state.
7374 * Reading from this pointer when `result_ok` is set is undefined.
7376 enum LDKCreationError *err;
7377 } LDKCResult_PositiveTimestampCreationErrorZPtr;
7380 * A CResult_PositiveTimestampCreationErrorZ represents the result of a fallible operation,
7381 * containing a crate::lightning_invoice::PositiveTimestamp on success and a crate::lightning_invoice::CreationError on failure.
7382 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7384 typedef struct LDKCResult_PositiveTimestampCreationErrorZ {
7386 * The contents of this CResult_PositiveTimestampCreationErrorZ, accessible via either
7387 * `err` or `result` depending on the state of `result_ok`.
7389 union LDKCResult_PositiveTimestampCreationErrorZPtr contents;
7391 * Whether this CResult_PositiveTimestampCreationErrorZ represents a success state.
7394 } LDKCResult_PositiveTimestampCreationErrorZ;
7397 * The contents of CResult_NoneSemanticErrorZ
7399 typedef union LDKCResult_NoneSemanticErrorZPtr {
7401 * Note that this value is always NULL, as there are no contents in the OK variant
7405 * A pointer to the contents in the error state.
7406 * Reading from this pointer when `result_ok` is set is undefined.
7408 enum LDKSemanticError *err;
7409 } LDKCResult_NoneSemanticErrorZPtr;
7412 * A CResult_NoneSemanticErrorZ represents the result of a fallible operation,
7413 * containing a () on success and a crate::lightning_invoice::SemanticError on failure.
7414 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7416 typedef struct LDKCResult_NoneSemanticErrorZ {
7418 * The contents of this CResult_NoneSemanticErrorZ, accessible via either
7419 * `err` or `result` depending on the state of `result_ok`.
7421 union LDKCResult_NoneSemanticErrorZPtr contents;
7423 * Whether this CResult_NoneSemanticErrorZ represents a success state.
7426 } LDKCResult_NoneSemanticErrorZ;
7429 * The contents of CResult_InvoiceSemanticErrorZ
7431 typedef union LDKCResult_InvoiceSemanticErrorZPtr {
7433 * A pointer to the contents in the success state.
7434 * Reading from this pointer when `result_ok` is not set is undefined.
7436 struct LDKInvoice *result;
7438 * A pointer to the contents in the error state.
7439 * Reading from this pointer when `result_ok` is set is undefined.
7441 enum LDKSemanticError *err;
7442 } LDKCResult_InvoiceSemanticErrorZPtr;
7445 * A CResult_InvoiceSemanticErrorZ represents the result of a fallible operation,
7446 * containing a crate::lightning_invoice::Invoice on success and a crate::lightning_invoice::SemanticError on failure.
7447 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7449 typedef struct LDKCResult_InvoiceSemanticErrorZ {
7451 * The contents of this CResult_InvoiceSemanticErrorZ, accessible via either
7452 * `err` or `result` depending on the state of `result_ok`.
7454 union LDKCResult_InvoiceSemanticErrorZPtr contents;
7456 * Whether this CResult_InvoiceSemanticErrorZ represents a success state.
7459 } LDKCResult_InvoiceSemanticErrorZ;
7464 * Description string
7467 * The description can be at most 639 __bytes__ long
7469 typedef struct MUST_USE_STRUCT LDKDescription {
7471 * A pointer to the opaque Rust object.
7472 * Nearly everywhere, inner must be non-null, however in places where
7473 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7475 LDKnativeDescription *inner;
7477 * Indicates that this is the only struct which contains the same pointer.
7478 * Rust functions which take ownership of an object provided via an argument require
7479 * this to be true and invalidate the object pointed to by inner.
7485 * The contents of CResult_DescriptionCreationErrorZ
7487 typedef union LDKCResult_DescriptionCreationErrorZPtr {
7489 * A pointer to the contents in the success state.
7490 * Reading from this pointer when `result_ok` is not set is undefined.
7492 struct LDKDescription *result;
7494 * A pointer to the contents in the error state.
7495 * Reading from this pointer when `result_ok` is set is undefined.
7497 enum LDKCreationError *err;
7498 } LDKCResult_DescriptionCreationErrorZPtr;
7501 * A CResult_DescriptionCreationErrorZ represents the result of a fallible operation,
7502 * containing a crate::lightning_invoice::Description on success and a crate::lightning_invoice::CreationError on failure.
7503 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7505 typedef struct LDKCResult_DescriptionCreationErrorZ {
7507 * The contents of this CResult_DescriptionCreationErrorZ, accessible via either
7508 * `err` or `result` depending on the state of `result_ok`.
7510 union LDKCResult_DescriptionCreationErrorZPtr contents;
7512 * Whether this CResult_DescriptionCreationErrorZ represents a success state.
7515 } LDKCResult_DescriptionCreationErrorZ;
7518 * The contents of CResult_PrivateRouteCreationErrorZ
7520 typedef union LDKCResult_PrivateRouteCreationErrorZPtr {
7522 * A pointer to the contents in the success state.
7523 * Reading from this pointer when `result_ok` is not set is undefined.
7525 struct LDKPrivateRoute *result;
7527 * A pointer to the contents in the error state.
7528 * Reading from this pointer when `result_ok` is set is undefined.
7530 enum LDKCreationError *err;
7531 } LDKCResult_PrivateRouteCreationErrorZPtr;
7534 * A CResult_PrivateRouteCreationErrorZ represents the result of a fallible operation,
7535 * containing a crate::lightning_invoice::PrivateRoute on success and a crate::lightning_invoice::CreationError on failure.
7536 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7538 typedef struct LDKCResult_PrivateRouteCreationErrorZ {
7540 * The contents of this CResult_PrivateRouteCreationErrorZ, accessible via either
7541 * `err` or `result` depending on the state of `result_ok`.
7543 union LDKCResult_PrivateRouteCreationErrorZPtr contents;
7545 * Whether this CResult_PrivateRouteCreationErrorZ represents a success state.
7548 } LDKCResult_PrivateRouteCreationErrorZ;
7551 * The contents of CResult_StringErrorZ
7553 typedef union LDKCResult_StringErrorZPtr {
7555 * A pointer to the contents in the success state.
7556 * Reading from this pointer when `result_ok` is not set is undefined.
7558 struct LDKStr *result;
7560 * A pointer to the contents in the error state.
7561 * Reading from this pointer when `result_ok` is set is undefined.
7563 enum LDKSecp256k1Error *err;
7564 } LDKCResult_StringErrorZPtr;
7567 * A CResult_StringErrorZ represents the result of a fallible operation,
7568 * containing a crate::c_types::Str on success and a crate::c_types::Secp256k1Error on failure.
7569 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7571 typedef struct LDKCResult_StringErrorZ {
7573 * The contents of this CResult_StringErrorZ, accessible via either
7574 * `err` or `result` depending on the state of `result_ok`.
7576 union LDKCResult_StringErrorZPtr contents;
7578 * Whether this CResult_StringErrorZ represents a success state.
7581 } LDKCResult_StringErrorZ;
7584 * The contents of CResult_ChannelMonitorUpdateDecodeErrorZ
7586 typedef union LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr {
7588 * A pointer to the contents in the success state.
7589 * Reading from this pointer when `result_ok` is not set is undefined.
7591 struct LDKChannelMonitorUpdate *result;
7593 * A pointer to the contents in the error state.
7594 * Reading from this pointer when `result_ok` is set is undefined.
7596 struct LDKDecodeError *err;
7597 } LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr;
7600 * A CResult_ChannelMonitorUpdateDecodeErrorZ represents the result of a fallible operation,
7601 * containing a crate::lightning::chain::channelmonitor::ChannelMonitorUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
7602 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7604 typedef struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ {
7606 * The contents of this CResult_ChannelMonitorUpdateDecodeErrorZ, accessible via either
7607 * `err` or `result` depending on the state of `result_ok`.
7609 union LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr contents;
7611 * Whether this CResult_ChannelMonitorUpdateDecodeErrorZ represents a success state.
7614 } LDKCResult_ChannelMonitorUpdateDecodeErrorZ;
7617 * An enum which can either contain a crate::lightning::chain::channelmonitor::MonitorEvent or not
7619 typedef enum LDKCOption_MonitorEventZ_Tag {
7621 * When we're in this state, this COption_MonitorEventZ contains a crate::lightning::chain::channelmonitor::MonitorEvent
7623 LDKCOption_MonitorEventZ_Some,
7625 * When we're in this state, this COption_MonitorEventZ contains nothing
7627 LDKCOption_MonitorEventZ_None,
7629 * Must be last for serialization purposes
7631 LDKCOption_MonitorEventZ_Sentinel,
7632 } LDKCOption_MonitorEventZ_Tag;
7634 typedef struct LDKCOption_MonitorEventZ {
7635 LDKCOption_MonitorEventZ_Tag tag;
7638 struct LDKMonitorEvent some;
7641 } LDKCOption_MonitorEventZ;
7644 * The contents of CResult_COption_MonitorEventZDecodeErrorZ
7646 typedef union LDKCResult_COption_MonitorEventZDecodeErrorZPtr {
7648 * A pointer to the contents in the success state.
7649 * Reading from this pointer when `result_ok` is not set is undefined.
7651 struct LDKCOption_MonitorEventZ *result;
7653 * A pointer to the contents in the error state.
7654 * Reading from this pointer when `result_ok` is set is undefined.
7656 struct LDKDecodeError *err;
7657 } LDKCResult_COption_MonitorEventZDecodeErrorZPtr;
7660 * A CResult_COption_MonitorEventZDecodeErrorZ represents the result of a fallible operation,
7661 * containing a crate::c_types::derived::COption_MonitorEventZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
7662 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7664 typedef struct LDKCResult_COption_MonitorEventZDecodeErrorZ {
7666 * The contents of this CResult_COption_MonitorEventZDecodeErrorZ, accessible via either
7667 * `err` or `result` depending on the state of `result_ok`.
7669 union LDKCResult_COption_MonitorEventZDecodeErrorZPtr contents;
7671 * Whether this CResult_COption_MonitorEventZDecodeErrorZ represents a success state.
7674 } LDKCResult_COption_MonitorEventZDecodeErrorZ;
7677 * The contents of CResult_HTLCUpdateDecodeErrorZ
7679 typedef union LDKCResult_HTLCUpdateDecodeErrorZPtr {
7681 * A pointer to the contents in the success state.
7682 * Reading from this pointer when `result_ok` is not set is undefined.
7684 struct LDKHTLCUpdate *result;
7686 * A pointer to the contents in the error state.
7687 * Reading from this pointer when `result_ok` is set is undefined.
7689 struct LDKDecodeError *err;
7690 } LDKCResult_HTLCUpdateDecodeErrorZPtr;
7693 * A CResult_HTLCUpdateDecodeErrorZ represents the result of a fallible operation,
7694 * containing a crate::lightning::chain::channelmonitor::HTLCUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
7695 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7697 typedef struct LDKCResult_HTLCUpdateDecodeErrorZ {
7699 * The contents of this CResult_HTLCUpdateDecodeErrorZ, accessible via either
7700 * `err` or `result` depending on the state of `result_ok`.
7702 union LDKCResult_HTLCUpdateDecodeErrorZPtr contents;
7704 * Whether this CResult_HTLCUpdateDecodeErrorZ represents a success state.
7707 } LDKCResult_HTLCUpdateDecodeErrorZ;
7710 * A tuple of 2 elements. See the individual fields for the types contained.
7712 typedef struct LDKC2Tuple_OutPointScriptZ {
7714 * The element at position 0
7716 struct LDKOutPoint a;
7718 * The element at position 1
7720 struct LDKCVec_u8Z b;
7721 } LDKC2Tuple_OutPointScriptZ;
7724 * A tuple of 2 elements. See the individual fields for the types contained.
7726 typedef struct LDKC2Tuple_u32ScriptZ {
7728 * The element at position 0
7732 * The element at position 1
7734 struct LDKCVec_u8Z b;
7735 } LDKC2Tuple_u32ScriptZ;
7738 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_u32ScriptZs of arbitrary size.
7739 * This corresponds to std::vector in C++
7741 typedef struct LDKCVec_C2Tuple_u32ScriptZZ {
7743 * The elements in the array.
7744 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7746 struct LDKC2Tuple_u32ScriptZ *data;
7748 * The number of elements pointed to by `data`.
7751 } LDKCVec_C2Tuple_u32ScriptZZ;
7754 * A tuple of 2 elements. See the individual fields for the types contained.
7756 typedef struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ {
7758 * The element at position 0
7760 struct LDKThirtyTwoBytes a;
7762 * The element at position 1
7764 struct LDKCVec_C2Tuple_u32ScriptZZ b;
7765 } LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ;
7768 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZs of arbitrary size.
7769 * This corresponds to std::vector in C++
7771 typedef struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ {
7773 * The elements in the array.
7774 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7776 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ *data;
7778 * The number of elements pointed to by `data`.
7781 } LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ;
7784 * A dynamically-allocated array of crate::lightning::util::events::Events of arbitrary size.
7785 * This corresponds to std::vector in C++
7787 typedef struct LDKCVec_EventZ {
7789 * The elements in the array.
7790 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7792 struct LDKEvent *data;
7794 * The number of elements pointed to by `data`.
7800 * A dynamically-allocated array of crate::c_types::Transactions of arbitrary size.
7801 * This corresponds to std::vector in C++
7803 typedef struct LDKCVec_TransactionZ {
7805 * The elements in the array.
7806 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7808 struct LDKTransaction *data;
7810 * The number of elements pointed to by `data`.
7813 } LDKCVec_TransactionZ;
7816 * A tuple of 2 elements. See the individual fields for the types contained.
7818 typedef struct LDKC2Tuple_u32TxOutZ {
7820 * The element at position 0
7824 * The element at position 1
7827 } LDKC2Tuple_u32TxOutZ;
7830 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_u32TxOutZs of arbitrary size.
7831 * This corresponds to std::vector in C++
7833 typedef struct LDKCVec_C2Tuple_u32TxOutZZ {
7835 * The elements in the array.
7836 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7838 struct LDKC2Tuple_u32TxOutZ *data;
7840 * The number of elements pointed to by `data`.
7843 } LDKCVec_C2Tuple_u32TxOutZZ;
7846 * A tuple of 2 elements. See the individual fields for the types contained.
7848 typedef struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ {
7850 * The element at position 0
7852 struct LDKThirtyTwoBytes a;
7854 * The element at position 1
7856 struct LDKCVec_C2Tuple_u32TxOutZZ b;
7857 } LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ;
7860 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZs of arbitrary size.
7861 * This corresponds to std::vector in C++
7863 typedef struct LDKCVec_TransactionOutputsZ {
7865 * The elements in the array.
7866 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7868 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ *data;
7870 * The number of elements pointed to by `data`.
7873 } LDKCVec_TransactionOutputsZ;
7876 * Details about the balance(s) available for spending once the channel appears on chain.
7878 * See [`ChannelMonitor::get_claimable_balances`] for more details on when these will or will not
7881 typedef enum LDKBalance_Tag {
7883 * The channel is not yet closed (or the commitment or closing transaction has not yet
7884 * appeared in a block). The given balance is claimable (less on-chain fees) if the channel is
7887 LDKBalance_ClaimableOnChannelClose,
7889 * The channel has been closed, and the given balance is ours but awaiting confirmations until
7890 * we consider it spendable.
7892 LDKBalance_ClaimableAwaitingConfirmations,
7894 * The channel has been closed, and the given balance should be ours but awaiting spending
7895 * transaction confirmation. If the spending transaction does not confirm in time, it is
7896 * possible our counterparty can take the funds by broadcasting an HTLC timeout on-chain.
7898 * Once the spending transaction confirms, before it has reached enough confirmations to be
7899 * considered safe from chain reorganizations, the balance will instead be provided via
7900 * [`Balance::ClaimableAwaitingConfirmations`].
7902 LDKBalance_ContentiousClaimable,
7904 * HTLCs which we sent to our counterparty which are claimable after a timeout (less on-chain
7905 * fees) if the counterparty does not know the preimage for the HTLCs. These are somewhat
7906 * likely to be claimed by our counterparty before we do.
7908 LDKBalance_MaybeClaimableHTLCAwaitingTimeout,
7910 * Must be last for serialization purposes
7912 LDKBalance_Sentinel,
7915 typedef struct LDKBalance_LDKClaimableOnChannelClose_Body {
7917 * The amount available to claim, in satoshis, excluding the on-chain fees which will be
7918 * required to do so.
7920 uint64_t claimable_amount_satoshis;
7921 } LDKBalance_LDKClaimableOnChannelClose_Body;
7923 typedef struct LDKBalance_LDKClaimableAwaitingConfirmations_Body {
7925 * The amount available to claim, in satoshis, possibly excluding the on-chain fees which
7926 * were spent in broadcasting the transaction.
7928 uint64_t claimable_amount_satoshis;
7930 * The height at which an [`Event::SpendableOutputs`] event will be generated for this
7933 uint32_t confirmation_height;
7934 } LDKBalance_LDKClaimableAwaitingConfirmations_Body;
7936 typedef struct LDKBalance_LDKContentiousClaimable_Body {
7938 * The amount available to claim, in satoshis, excluding the on-chain fees which will be
7939 * required to do so.
7941 uint64_t claimable_amount_satoshis;
7943 * The height at which the counterparty may be able to claim the balance if we have not
7946 uint32_t timeout_height;
7947 } LDKBalance_LDKContentiousClaimable_Body;
7949 typedef struct LDKBalance_LDKMaybeClaimableHTLCAwaitingTimeout_Body {
7951 * The amount available to claim, in satoshis, excluding the on-chain fees which will be
7952 * required to do so.
7954 uint64_t claimable_amount_satoshis;
7956 * The height at which we will be able to claim the balance if our counterparty has not
7959 uint32_t claimable_height;
7960 } LDKBalance_LDKMaybeClaimableHTLCAwaitingTimeout_Body;
7962 typedef struct MUST_USE_STRUCT LDKBalance {
7965 LDKBalance_LDKClaimableOnChannelClose_Body claimable_on_channel_close;
7966 LDKBalance_LDKClaimableAwaitingConfirmations_Body claimable_awaiting_confirmations;
7967 LDKBalance_LDKContentiousClaimable_Body contentious_claimable;
7968 LDKBalance_LDKMaybeClaimableHTLCAwaitingTimeout_Body maybe_claimable_htlc_awaiting_timeout;
7973 * A dynamically-allocated array of crate::lightning::chain::channelmonitor::Balances of arbitrary size.
7974 * This corresponds to std::vector in C++
7976 typedef struct LDKCVec_BalanceZ {
7978 * The elements in the array.
7979 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7981 struct LDKBalance *data;
7983 * The number of elements pointed to by `data`.
7989 * The contents of CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ
7991 typedef union LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr {
7993 * A pointer to the contents in the success state.
7994 * Reading from this pointer when `result_ok` is not set is undefined.
7996 struct LDKC2Tuple_BlockHashChannelMonitorZ *result;
7998 * A pointer to the contents in the error state.
7999 * Reading from this pointer when `result_ok` is set is undefined.
8001 struct LDKDecodeError *err;
8002 } LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr;
8005 * A CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ represents the result of a fallible operation,
8006 * containing a crate::c_types::derived::C2Tuple_BlockHashChannelMonitorZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
8007 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8009 typedef struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ {
8011 * The contents of this CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ, accessible via either
8012 * `err` or `result` depending on the state of `result_ok`.
8014 union LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr contents;
8016 * Whether this CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ represents a success state.
8019 } LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ;
8022 * The contents of CResult_NoneLightningErrorZ
8024 typedef union LDKCResult_NoneLightningErrorZPtr {
8026 * Note that this value is always NULL, as there are no contents in the OK variant
8030 * A pointer to the contents in the error state.
8031 * Reading from this pointer when `result_ok` is set is undefined.
8033 struct LDKLightningError *err;
8034 } LDKCResult_NoneLightningErrorZPtr;
8037 * A CResult_NoneLightningErrorZ represents the result of a fallible operation,
8038 * containing a () on success and a crate::lightning::ln::msgs::LightningError on failure.
8039 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8041 typedef struct LDKCResult_NoneLightningErrorZ {
8043 * The contents of this CResult_NoneLightningErrorZ, accessible via either
8044 * `err` or `result` depending on the state of `result_ok`.
8046 union LDKCResult_NoneLightningErrorZPtr contents;
8048 * Whether this CResult_NoneLightningErrorZ represents a success state.
8051 } LDKCResult_NoneLightningErrorZ;
8054 * A tuple of 2 elements. See the individual fields for the types contained.
8056 typedef struct LDKC2Tuple_PublicKeyTypeZ {
8058 * The element at position 0
8060 struct LDKPublicKey a;
8062 * The element at position 1
8065 } LDKC2Tuple_PublicKeyTypeZ;
8068 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_PublicKeyTypeZs of arbitrary size.
8069 * This corresponds to std::vector in C++
8071 typedef struct LDKCVec_C2Tuple_PublicKeyTypeZZ {
8073 * The elements in the array.
8074 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
8076 struct LDKC2Tuple_PublicKeyTypeZ *data;
8078 * The number of elements pointed to by `data`.
8081 } LDKCVec_C2Tuple_PublicKeyTypeZZ;
8084 * The contents of CResult_boolLightningErrorZ
8086 typedef union LDKCResult_boolLightningErrorZPtr {
8088 * A pointer to the contents in the success state.
8089 * Reading from this pointer when `result_ok` is not set is undefined.
8093 * A pointer to the contents in the error state.
8094 * Reading from this pointer when `result_ok` is set is undefined.
8096 struct LDKLightningError *err;
8097 } LDKCResult_boolLightningErrorZPtr;
8100 * A CResult_boolLightningErrorZ represents the result of a fallible operation,
8101 * containing a bool on success and a crate::lightning::ln::msgs::LightningError on failure.
8102 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8104 typedef struct LDKCResult_boolLightningErrorZ {
8106 * The contents of this CResult_boolLightningErrorZ, accessible via either
8107 * `err` or `result` depending on the state of `result_ok`.
8109 union LDKCResult_boolLightningErrorZPtr contents;
8111 * Whether this CResult_boolLightningErrorZ represents a success state.
8114 } LDKCResult_boolLightningErrorZ;
8117 * A tuple of 3 elements. See the individual fields for the types contained.
8119 typedef struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ {
8121 * The element at position 0
8123 struct LDKChannelAnnouncement a;
8125 * The element at position 1
8127 struct LDKChannelUpdate b;
8129 * The element at position 2
8131 struct LDKChannelUpdate c;
8132 } LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ;
8135 * A dynamically-allocated array of crate::c_types::derived::C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZs of arbitrary size.
8136 * This corresponds to std::vector in C++
8138 typedef struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ {
8140 * The elements in the array.
8141 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
8143 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ *data;
8145 * The number of elements pointed to by `data`.
8148 } LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ;
8151 * A dynamically-allocated array of crate::lightning::ln::msgs::NodeAnnouncements of arbitrary size.
8152 * This corresponds to std::vector in C++
8154 typedef struct LDKCVec_NodeAnnouncementZ {
8156 * The elements in the array.
8157 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
8159 struct LDKNodeAnnouncement *data;
8161 * The number of elements pointed to by `data`.
8164 } LDKCVec_NodeAnnouncementZ;
8167 * A dynamically-allocated array of crate::c_types::PublicKeys of arbitrary size.
8168 * This corresponds to std::vector in C++
8170 typedef struct LDKCVec_PublicKeyZ {
8172 * The elements in the array.
8173 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
8175 struct LDKPublicKey *data;
8177 * The number of elements pointed to by `data`.
8180 } LDKCVec_PublicKeyZ;
8185 * Error for PeerManager errors. If you get one of these, you must disconnect the socket and
8186 * generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
8189 typedef struct MUST_USE_STRUCT LDKPeerHandleError {
8191 * A pointer to the opaque Rust object.
8192 * Nearly everywhere, inner must be non-null, however in places where
8193 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8195 LDKnativePeerHandleError *inner;
8197 * Indicates that this is the only struct which contains the same pointer.
8198 * Rust functions which take ownership of an object provided via an argument require
8199 * this to be true and invalidate the object pointed to by inner.
8202 } LDKPeerHandleError;
8205 * The contents of CResult_CVec_u8ZPeerHandleErrorZ
8207 typedef union LDKCResult_CVec_u8ZPeerHandleErrorZPtr {
8209 * A pointer to the contents in the success state.
8210 * Reading from this pointer when `result_ok` is not set is undefined.
8212 struct LDKCVec_u8Z *result;
8214 * A pointer to the contents in the error state.
8215 * Reading from this pointer when `result_ok` is set is undefined.
8217 struct LDKPeerHandleError *err;
8218 } LDKCResult_CVec_u8ZPeerHandleErrorZPtr;
8221 * A CResult_CVec_u8ZPeerHandleErrorZ represents the result of a fallible operation,
8222 * containing a crate::c_types::derived::CVec_u8Z on success and a crate::lightning::ln::peer_handler::PeerHandleError on failure.
8223 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8225 typedef struct LDKCResult_CVec_u8ZPeerHandleErrorZ {
8227 * The contents of this CResult_CVec_u8ZPeerHandleErrorZ, accessible via either
8228 * `err` or `result` depending on the state of `result_ok`.
8230 union LDKCResult_CVec_u8ZPeerHandleErrorZPtr contents;
8232 * Whether this CResult_CVec_u8ZPeerHandleErrorZ represents a success state.
8235 } LDKCResult_CVec_u8ZPeerHandleErrorZ;
8238 * The contents of CResult_NonePeerHandleErrorZ
8240 typedef union LDKCResult_NonePeerHandleErrorZPtr {
8242 * Note that this value is always NULL, as there are no contents in the OK variant
8246 * A pointer to the contents in the error state.
8247 * Reading from this pointer when `result_ok` is set is undefined.
8249 struct LDKPeerHandleError *err;
8250 } LDKCResult_NonePeerHandleErrorZPtr;
8253 * A CResult_NonePeerHandleErrorZ represents the result of a fallible operation,
8254 * containing a () on success and a crate::lightning::ln::peer_handler::PeerHandleError on failure.
8255 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8257 typedef struct LDKCResult_NonePeerHandleErrorZ {
8259 * The contents of this CResult_NonePeerHandleErrorZ, accessible via either
8260 * `err` or `result` depending on the state of `result_ok`.
8262 union LDKCResult_NonePeerHandleErrorZPtr contents;
8264 * Whether this CResult_NonePeerHandleErrorZ represents a success state.
8267 } LDKCResult_NonePeerHandleErrorZ;
8270 * The contents of CResult_boolPeerHandleErrorZ
8272 typedef union LDKCResult_boolPeerHandleErrorZPtr {
8274 * A pointer to the contents in the success state.
8275 * Reading from this pointer when `result_ok` is not set is undefined.
8279 * A pointer to the contents in the error state.
8280 * Reading from this pointer when `result_ok` is set is undefined.
8282 struct LDKPeerHandleError *err;
8283 } LDKCResult_boolPeerHandleErrorZPtr;
8286 * A CResult_boolPeerHandleErrorZ represents the result of a fallible operation,
8287 * containing a bool on success and a crate::lightning::ln::peer_handler::PeerHandleError on failure.
8288 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8290 typedef struct LDKCResult_boolPeerHandleErrorZ {
8292 * The contents of this CResult_boolPeerHandleErrorZ, accessible via either
8293 * `err` or `result` depending on the state of `result_ok`.
8295 union LDKCResult_boolPeerHandleErrorZPtr contents;
8297 * Whether this CResult_boolPeerHandleErrorZ represents a success state.
8300 } LDKCResult_boolPeerHandleErrorZ;
8305 * Represents the compressed public key of a node
8307 typedef struct MUST_USE_STRUCT LDKNodeId {
8309 * A pointer to the opaque Rust object.
8310 * Nearly everywhere, inner must be non-null, however in places where
8311 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8313 LDKnativeNodeId *inner;
8315 * Indicates that this is the only struct which contains the same pointer.
8316 * Rust functions which take ownership of an object provided via an argument require
8317 * this to be true and invalidate the object pointed to by inner.
8323 * The contents of CResult_NodeIdDecodeErrorZ
8325 typedef union LDKCResult_NodeIdDecodeErrorZPtr {
8327 * A pointer to the contents in the success state.
8328 * Reading from this pointer when `result_ok` is not set is undefined.
8330 struct LDKNodeId *result;
8332 * A pointer to the contents in the error state.
8333 * Reading from this pointer when `result_ok` is set is undefined.
8335 struct LDKDecodeError *err;
8336 } LDKCResult_NodeIdDecodeErrorZPtr;
8339 * A CResult_NodeIdDecodeErrorZ represents the result of a fallible operation,
8340 * containing a crate::lightning::routing::network_graph::NodeId on success and a crate::lightning::ln::msgs::DecodeError on failure.
8341 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8343 typedef struct LDKCResult_NodeIdDecodeErrorZ {
8345 * The contents of this CResult_NodeIdDecodeErrorZ, accessible via either
8346 * `err` or `result` depending on the state of `result_ok`.
8348 union LDKCResult_NodeIdDecodeErrorZPtr contents;
8350 * Whether this CResult_NodeIdDecodeErrorZ represents a success state.
8353 } LDKCResult_NodeIdDecodeErrorZ;
8356 * The contents of CResult_COption_NetworkUpdateZDecodeErrorZ
8358 typedef union LDKCResult_COption_NetworkUpdateZDecodeErrorZPtr {
8360 * A pointer to the contents in the success state.
8361 * Reading from this pointer when `result_ok` is not set is undefined.
8363 struct LDKCOption_NetworkUpdateZ *result;
8365 * A pointer to the contents in the error state.
8366 * Reading from this pointer when `result_ok` is set is undefined.
8368 struct LDKDecodeError *err;
8369 } LDKCResult_COption_NetworkUpdateZDecodeErrorZPtr;
8372 * A CResult_COption_NetworkUpdateZDecodeErrorZ represents the result of a fallible operation,
8373 * containing a crate::c_types::derived::COption_NetworkUpdateZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
8374 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8376 typedef struct LDKCResult_COption_NetworkUpdateZDecodeErrorZ {
8378 * The contents of this CResult_COption_NetworkUpdateZDecodeErrorZ, accessible via either
8379 * `err` or `result` depending on the state of `result_ok`.
8381 union LDKCResult_COption_NetworkUpdateZDecodeErrorZPtr contents;
8383 * Whether this CResult_COption_NetworkUpdateZDecodeErrorZ represents a success state.
8386 } LDKCResult_COption_NetworkUpdateZDecodeErrorZ;
8389 * The `Access` trait defines behavior for accessing chain data and state, such as blocks and
8392 typedef struct LDKAccess {
8394 * An opaque pointer which is passed to your function implementations as an argument.
8395 * This has no meaning in the LDK, and can be NULL or any other value.
8399 * Returns the transaction output of a funding transaction encoded by [`short_channel_id`].
8400 * Returns an error if `genesis_hash` is for a different chain or if such a transaction output
8403 * [`short_channel_id`]: https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md#definition-of-short_channel_id
8405 struct LDKCResult_TxOutAccessErrorZ (*get_utxo)(const void *this_arg, const uint8_t (*genesis_hash)[32], uint64_t short_channel_id);
8407 * Frees any resources associated with this object given its this_arg pointer.
8408 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
8410 void (*free)(void *this_arg);
8414 * An enum which can either contain a crate::lightning::chain::Access or not
8416 typedef enum LDKCOption_AccessZ_Tag {
8418 * When we're in this state, this COption_AccessZ contains a crate::lightning::chain::Access
8420 LDKCOption_AccessZ_Some,
8422 * When we're in this state, this COption_AccessZ contains nothing
8424 LDKCOption_AccessZ_None,
8426 * Must be last for serialization purposes
8428 LDKCOption_AccessZ_Sentinel,
8429 } LDKCOption_AccessZ_Tag;
8431 typedef struct LDKCOption_AccessZ {
8432 LDKCOption_AccessZ_Tag tag;
8435 struct LDKAccess some;
8438 } LDKCOption_AccessZ;
8443 * Details about one direction of a channel as received within a [`ChannelUpdate`].
8445 typedef struct MUST_USE_STRUCT LDKChannelUpdateInfo {
8447 * A pointer to the opaque Rust object.
8448 * Nearly everywhere, inner must be non-null, however in places where
8449 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8451 LDKnativeChannelUpdateInfo *inner;
8453 * Indicates that this is the only struct which contains the same pointer.
8454 * Rust functions which take ownership of an object provided via an argument require
8455 * this to be true and invalidate the object pointed to by inner.
8458 } LDKChannelUpdateInfo;
8461 * The contents of CResult_ChannelUpdateInfoDecodeErrorZ
8463 typedef union LDKCResult_ChannelUpdateInfoDecodeErrorZPtr {
8465 * A pointer to the contents in the success state.
8466 * Reading from this pointer when `result_ok` is not set is undefined.
8468 struct LDKChannelUpdateInfo *result;
8470 * A pointer to the contents in the error state.
8471 * Reading from this pointer when `result_ok` is set is undefined.
8473 struct LDKDecodeError *err;
8474 } LDKCResult_ChannelUpdateInfoDecodeErrorZPtr;
8477 * A CResult_ChannelUpdateInfoDecodeErrorZ represents the result of a fallible operation,
8478 * containing a crate::lightning::routing::network_graph::ChannelUpdateInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
8479 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8481 typedef struct LDKCResult_ChannelUpdateInfoDecodeErrorZ {
8483 * The contents of this CResult_ChannelUpdateInfoDecodeErrorZ, accessible via either
8484 * `err` or `result` depending on the state of `result_ok`.
8486 union LDKCResult_ChannelUpdateInfoDecodeErrorZPtr contents;
8488 * Whether this CResult_ChannelUpdateInfoDecodeErrorZ represents a success state.
8491 } LDKCResult_ChannelUpdateInfoDecodeErrorZ;
8496 * Details about a channel (both directions).
8497 * Received within a channel announcement.
8499 typedef struct MUST_USE_STRUCT LDKChannelInfo {
8501 * A pointer to the opaque Rust object.
8502 * Nearly everywhere, inner must be non-null, however in places where
8503 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8505 LDKnativeChannelInfo *inner;
8507 * Indicates that this is the only struct which contains the same pointer.
8508 * Rust functions which take ownership of an object provided via an argument require
8509 * this to be true and invalidate the object pointed to by inner.
8515 * The contents of CResult_ChannelInfoDecodeErrorZ
8517 typedef union LDKCResult_ChannelInfoDecodeErrorZPtr {
8519 * A pointer to the contents in the success state.
8520 * Reading from this pointer when `result_ok` is not set is undefined.
8522 struct LDKChannelInfo *result;
8524 * A pointer to the contents in the error state.
8525 * Reading from this pointer when `result_ok` is set is undefined.
8527 struct LDKDecodeError *err;
8528 } LDKCResult_ChannelInfoDecodeErrorZPtr;
8531 * A CResult_ChannelInfoDecodeErrorZ represents the result of a fallible operation,
8532 * containing a crate::lightning::routing::network_graph::ChannelInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
8533 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8535 typedef struct LDKCResult_ChannelInfoDecodeErrorZ {
8537 * The contents of this CResult_ChannelInfoDecodeErrorZ, accessible via either
8538 * `err` or `result` depending on the state of `result_ok`.
8540 union LDKCResult_ChannelInfoDecodeErrorZPtr contents;
8542 * Whether this CResult_ChannelInfoDecodeErrorZ represents a success state.
8545 } LDKCResult_ChannelInfoDecodeErrorZ;
8550 * Fees for routing via a given channel or a node
8552 typedef struct MUST_USE_STRUCT LDKRoutingFees {
8554 * A pointer to the opaque Rust object.
8555 * Nearly everywhere, inner must be non-null, however in places where
8556 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8558 LDKnativeRoutingFees *inner;
8560 * Indicates that this is the only struct which contains the same pointer.
8561 * Rust functions which take ownership of an object provided via an argument require
8562 * this to be true and invalidate the object pointed to by inner.
8568 * The contents of CResult_RoutingFeesDecodeErrorZ
8570 typedef union LDKCResult_RoutingFeesDecodeErrorZPtr {
8572 * A pointer to the contents in the success state.
8573 * Reading from this pointer when `result_ok` is not set is undefined.
8575 struct LDKRoutingFees *result;
8577 * A pointer to the contents in the error state.
8578 * Reading from this pointer when `result_ok` is set is undefined.
8580 struct LDKDecodeError *err;
8581 } LDKCResult_RoutingFeesDecodeErrorZPtr;
8584 * A CResult_RoutingFeesDecodeErrorZ represents the result of a fallible operation,
8585 * containing a crate::lightning::routing::network_graph::RoutingFees on success and a crate::lightning::ln::msgs::DecodeError on failure.
8586 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8588 typedef struct LDKCResult_RoutingFeesDecodeErrorZ {
8590 * The contents of this CResult_RoutingFeesDecodeErrorZ, accessible via either
8591 * `err` or `result` depending on the state of `result_ok`.
8593 union LDKCResult_RoutingFeesDecodeErrorZPtr contents;
8595 * Whether this CResult_RoutingFeesDecodeErrorZ represents a success state.
8598 } LDKCResult_RoutingFeesDecodeErrorZ;
8603 * Information received in the latest node_announcement from this node.
8605 typedef struct MUST_USE_STRUCT LDKNodeAnnouncementInfo {
8607 * A pointer to the opaque Rust object.
8608 * Nearly everywhere, inner must be non-null, however in places where
8609 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8611 LDKnativeNodeAnnouncementInfo *inner;
8613 * Indicates that this is the only struct which contains the same pointer.
8614 * Rust functions which take ownership of an object provided via an argument require
8615 * this to be true and invalidate the object pointed to by inner.
8618 } LDKNodeAnnouncementInfo;
8621 * The contents of CResult_NodeAnnouncementInfoDecodeErrorZ
8623 typedef union LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr {
8625 * A pointer to the contents in the success state.
8626 * Reading from this pointer when `result_ok` is not set is undefined.
8628 struct LDKNodeAnnouncementInfo *result;
8630 * A pointer to the contents in the error state.
8631 * Reading from this pointer when `result_ok` is set is undefined.
8633 struct LDKDecodeError *err;
8634 } LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr;
8637 * A CResult_NodeAnnouncementInfoDecodeErrorZ represents the result of a fallible operation,
8638 * containing a crate::lightning::routing::network_graph::NodeAnnouncementInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
8639 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8641 typedef struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ {
8643 * The contents of this CResult_NodeAnnouncementInfoDecodeErrorZ, accessible via either
8644 * `err` or `result` depending on the state of `result_ok`.
8646 union LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr contents;
8648 * Whether this CResult_NodeAnnouncementInfoDecodeErrorZ represents a success state.
8651 } LDKCResult_NodeAnnouncementInfoDecodeErrorZ;
8654 * A dynamically-allocated array of u64s of arbitrary size.
8655 * This corresponds to std::vector in C++
8657 typedef struct LDKCVec_u64Z {
8659 * The elements in the array.
8660 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
8664 * The number of elements pointed to by `data`.
8672 * Details about a node in the network, known from the network announcement.
8674 typedef struct MUST_USE_STRUCT LDKNodeInfo {
8676 * A pointer to the opaque Rust object.
8677 * Nearly everywhere, inner must be non-null, however in places where
8678 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8680 LDKnativeNodeInfo *inner;
8682 * Indicates that this is the only struct which contains the same pointer.
8683 * Rust functions which take ownership of an object provided via an argument require
8684 * this to be true and invalidate the object pointed to by inner.
8690 * The contents of CResult_NodeInfoDecodeErrorZ
8692 typedef union LDKCResult_NodeInfoDecodeErrorZPtr {
8694 * A pointer to the contents in the success state.
8695 * Reading from this pointer when `result_ok` is not set is undefined.
8697 struct LDKNodeInfo *result;
8699 * A pointer to the contents in the error state.
8700 * Reading from this pointer when `result_ok` is set is undefined.
8702 struct LDKDecodeError *err;
8703 } LDKCResult_NodeInfoDecodeErrorZPtr;
8706 * A CResult_NodeInfoDecodeErrorZ represents the result of a fallible operation,
8707 * containing a crate::lightning::routing::network_graph::NodeInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
8708 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8710 typedef struct LDKCResult_NodeInfoDecodeErrorZ {
8712 * The contents of this CResult_NodeInfoDecodeErrorZ, accessible via either
8713 * `err` or `result` depending on the state of `result_ok`.
8715 union LDKCResult_NodeInfoDecodeErrorZPtr contents;
8717 * Whether this CResult_NodeInfoDecodeErrorZ represents a success state.
8720 } LDKCResult_NodeInfoDecodeErrorZ;
8725 * Represents the network as nodes and channels between them
8727 typedef struct MUST_USE_STRUCT LDKNetworkGraph {
8729 * A pointer to the opaque Rust object.
8730 * Nearly everywhere, inner must be non-null, however in places where
8731 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8733 LDKnativeNetworkGraph *inner;
8735 * Indicates that this is the only struct which contains the same pointer.
8736 * Rust functions which take ownership of an object provided via an argument require
8737 * this to be true and invalidate the object pointed to by inner.
8743 * The contents of CResult_NetworkGraphDecodeErrorZ
8745 typedef union LDKCResult_NetworkGraphDecodeErrorZPtr {
8747 * A pointer to the contents in the success state.
8748 * Reading from this pointer when `result_ok` is not set is undefined.
8750 struct LDKNetworkGraph *result;
8752 * A pointer to the contents in the error state.
8753 * Reading from this pointer when `result_ok` is set is undefined.
8755 struct LDKDecodeError *err;
8756 } LDKCResult_NetworkGraphDecodeErrorZPtr;
8759 * A CResult_NetworkGraphDecodeErrorZ represents the result of a fallible operation,
8760 * containing a crate::lightning::routing::network_graph::NetworkGraph on success and a crate::lightning::ln::msgs::DecodeError on failure.
8761 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8763 typedef struct LDKCResult_NetworkGraphDecodeErrorZ {
8765 * The contents of this CResult_NetworkGraphDecodeErrorZ, accessible via either
8766 * `err` or `result` depending on the state of `result_ok`.
8768 union LDKCResult_NetworkGraphDecodeErrorZPtr contents;
8770 * Whether this CResult_NetworkGraphDecodeErrorZ represents a success state.
8773 } LDKCResult_NetworkGraphDecodeErrorZ;
8776 * An enum which can either contain a crate::c_types::derived::CVec_NetAddressZ or not
8778 typedef enum LDKCOption_CVec_NetAddressZZ_Tag {
8780 * When we're in this state, this COption_CVec_NetAddressZZ contains a crate::c_types::derived::CVec_NetAddressZ
8782 LDKCOption_CVec_NetAddressZZ_Some,
8784 * When we're in this state, this COption_CVec_NetAddressZZ contains nothing
8786 LDKCOption_CVec_NetAddressZZ_None,
8788 * Must be last for serialization purposes
8790 LDKCOption_CVec_NetAddressZZ_Sentinel,
8791 } LDKCOption_CVec_NetAddressZZ_Tag;
8793 typedef struct LDKCOption_CVec_NetAddressZZ {
8794 LDKCOption_CVec_NetAddressZZ_Tag tag;
8797 struct LDKCVec_NetAddressZ some;
8800 } LDKCOption_CVec_NetAddressZZ;
8803 * The contents of CResult_NetAddressDecodeErrorZ
8805 typedef union LDKCResult_NetAddressDecodeErrorZPtr {
8807 * A pointer to the contents in the success state.
8808 * Reading from this pointer when `result_ok` is not set is undefined.
8810 struct LDKNetAddress *result;
8812 * A pointer to the contents in the error state.
8813 * Reading from this pointer when `result_ok` is set is undefined.
8815 struct LDKDecodeError *err;
8816 } LDKCResult_NetAddressDecodeErrorZPtr;
8819 * A CResult_NetAddressDecodeErrorZ represents the result of a fallible operation,
8820 * containing a crate::lightning::ln::msgs::NetAddress on success and a crate::lightning::ln::msgs::DecodeError on failure.
8821 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8823 typedef struct LDKCResult_NetAddressDecodeErrorZ {
8825 * The contents of this CResult_NetAddressDecodeErrorZ, accessible via either
8826 * `err` or `result` depending on the state of `result_ok`.
8828 union LDKCResult_NetAddressDecodeErrorZPtr contents;
8830 * Whether this CResult_NetAddressDecodeErrorZ represents a success state.
8833 } LDKCResult_NetAddressDecodeErrorZ;
8838 * An update_add_htlc message to be sent or received from a peer
8840 typedef struct MUST_USE_STRUCT LDKUpdateAddHTLC {
8842 * A pointer to the opaque Rust object.
8843 * Nearly everywhere, inner must be non-null, however in places where
8844 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8846 LDKnativeUpdateAddHTLC *inner;
8848 * Indicates that this is the only struct which contains the same pointer.
8849 * Rust functions which take ownership of an object provided via an argument require
8850 * this to be true and invalidate the object pointed to by inner.
8856 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateAddHTLCs of arbitrary size.
8857 * This corresponds to std::vector in C++
8859 typedef struct LDKCVec_UpdateAddHTLCZ {
8861 * The elements in the array.
8862 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
8864 struct LDKUpdateAddHTLC *data;
8866 * The number of elements pointed to by `data`.
8869 } LDKCVec_UpdateAddHTLCZ;
8874 * An update_fulfill_htlc message to be sent or received from a peer
8876 typedef struct MUST_USE_STRUCT LDKUpdateFulfillHTLC {
8878 * A pointer to the opaque Rust object.
8879 * Nearly everywhere, inner must be non-null, however in places where
8880 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8882 LDKnativeUpdateFulfillHTLC *inner;
8884 * Indicates that this is the only struct which contains the same pointer.
8885 * Rust functions which take ownership of an object provided via an argument require
8886 * this to be true and invalidate the object pointed to by inner.
8889 } LDKUpdateFulfillHTLC;
8892 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateFulfillHTLCs of arbitrary size.
8893 * This corresponds to std::vector in C++
8895 typedef struct LDKCVec_UpdateFulfillHTLCZ {
8897 * The elements in the array.
8898 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
8900 struct LDKUpdateFulfillHTLC *data;
8902 * The number of elements pointed to by `data`.
8905 } LDKCVec_UpdateFulfillHTLCZ;
8910 * An update_fail_htlc message to be sent or received from a peer
8912 typedef struct MUST_USE_STRUCT LDKUpdateFailHTLC {
8914 * A pointer to the opaque Rust object.
8915 * Nearly everywhere, inner must be non-null, however in places where
8916 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8918 LDKnativeUpdateFailHTLC *inner;
8920 * Indicates that this is the only struct which contains the same pointer.
8921 * Rust functions which take ownership of an object provided via an argument require
8922 * this to be true and invalidate the object pointed to by inner.
8925 } LDKUpdateFailHTLC;
8928 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateFailHTLCs of arbitrary size.
8929 * This corresponds to std::vector in C++
8931 typedef struct LDKCVec_UpdateFailHTLCZ {
8933 * The elements in the array.
8934 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
8936 struct LDKUpdateFailHTLC *data;
8938 * The number of elements pointed to by `data`.
8941 } LDKCVec_UpdateFailHTLCZ;
8946 * An update_fail_malformed_htlc message to be sent or received from a peer
8948 typedef struct MUST_USE_STRUCT LDKUpdateFailMalformedHTLC {
8950 * A pointer to the opaque Rust object.
8951 * Nearly everywhere, inner must be non-null, however in places where
8952 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8954 LDKnativeUpdateFailMalformedHTLC *inner;
8956 * Indicates that this is the only struct which contains the same pointer.
8957 * Rust functions which take ownership of an object provided via an argument require
8958 * this to be true and invalidate the object pointed to by inner.
8961 } LDKUpdateFailMalformedHTLC;
8964 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateFailMalformedHTLCs of arbitrary size.
8965 * This corresponds to std::vector in C++
8967 typedef struct LDKCVec_UpdateFailMalformedHTLCZ {
8969 * The elements in the array.
8970 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
8972 struct LDKUpdateFailMalformedHTLC *data;
8974 * The number of elements pointed to by `data`.
8977 } LDKCVec_UpdateFailMalformedHTLCZ;
8980 * The contents of CResult_AcceptChannelDecodeErrorZ
8982 typedef union LDKCResult_AcceptChannelDecodeErrorZPtr {
8984 * A pointer to the contents in the success state.
8985 * Reading from this pointer when `result_ok` is not set is undefined.
8987 struct LDKAcceptChannel *result;
8989 * A pointer to the contents in the error state.
8990 * Reading from this pointer when `result_ok` is set is undefined.
8992 struct LDKDecodeError *err;
8993 } LDKCResult_AcceptChannelDecodeErrorZPtr;
8996 * A CResult_AcceptChannelDecodeErrorZ represents the result of a fallible operation,
8997 * containing a crate::lightning::ln::msgs::AcceptChannel on success and a crate::lightning::ln::msgs::DecodeError on failure.
8998 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9000 typedef struct LDKCResult_AcceptChannelDecodeErrorZ {
9002 * The contents of this CResult_AcceptChannelDecodeErrorZ, accessible via either
9003 * `err` or `result` depending on the state of `result_ok`.
9005 union LDKCResult_AcceptChannelDecodeErrorZPtr contents;
9007 * Whether this CResult_AcceptChannelDecodeErrorZ represents a success state.
9010 } LDKCResult_AcceptChannelDecodeErrorZ;
9013 * The contents of CResult_AnnouncementSignaturesDecodeErrorZ
9015 typedef union LDKCResult_AnnouncementSignaturesDecodeErrorZPtr {
9017 * A pointer to the contents in the success state.
9018 * Reading from this pointer when `result_ok` is not set is undefined.
9020 struct LDKAnnouncementSignatures *result;
9022 * A pointer to the contents in the error state.
9023 * Reading from this pointer when `result_ok` is set is undefined.
9025 struct LDKDecodeError *err;
9026 } LDKCResult_AnnouncementSignaturesDecodeErrorZPtr;
9029 * A CResult_AnnouncementSignaturesDecodeErrorZ represents the result of a fallible operation,
9030 * containing a crate::lightning::ln::msgs::AnnouncementSignatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
9031 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9033 typedef struct LDKCResult_AnnouncementSignaturesDecodeErrorZ {
9035 * The contents of this CResult_AnnouncementSignaturesDecodeErrorZ, accessible via either
9036 * `err` or `result` depending on the state of `result_ok`.
9038 union LDKCResult_AnnouncementSignaturesDecodeErrorZPtr contents;
9040 * Whether this CResult_AnnouncementSignaturesDecodeErrorZ represents a success state.
9043 } LDKCResult_AnnouncementSignaturesDecodeErrorZ;
9046 * The contents of CResult_ChannelReestablishDecodeErrorZ
9048 typedef union LDKCResult_ChannelReestablishDecodeErrorZPtr {
9050 * A pointer to the contents in the success state.
9051 * Reading from this pointer when `result_ok` is not set is undefined.
9053 struct LDKChannelReestablish *result;
9055 * A pointer to the contents in the error state.
9056 * Reading from this pointer when `result_ok` is set is undefined.
9058 struct LDKDecodeError *err;
9059 } LDKCResult_ChannelReestablishDecodeErrorZPtr;
9062 * A CResult_ChannelReestablishDecodeErrorZ represents the result of a fallible operation,
9063 * containing a crate::lightning::ln::msgs::ChannelReestablish on success and a crate::lightning::ln::msgs::DecodeError on failure.
9064 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9066 typedef struct LDKCResult_ChannelReestablishDecodeErrorZ {
9068 * The contents of this CResult_ChannelReestablishDecodeErrorZ, accessible via either
9069 * `err` or `result` depending on the state of `result_ok`.
9071 union LDKCResult_ChannelReestablishDecodeErrorZPtr contents;
9073 * Whether this CResult_ChannelReestablishDecodeErrorZ represents a success state.
9076 } LDKCResult_ChannelReestablishDecodeErrorZ;
9079 * The contents of CResult_ClosingSignedDecodeErrorZ
9081 typedef union LDKCResult_ClosingSignedDecodeErrorZPtr {
9083 * A pointer to the contents in the success state.
9084 * Reading from this pointer when `result_ok` is not set is undefined.
9086 struct LDKClosingSigned *result;
9088 * A pointer to the contents in the error state.
9089 * Reading from this pointer when `result_ok` is set is undefined.
9091 struct LDKDecodeError *err;
9092 } LDKCResult_ClosingSignedDecodeErrorZPtr;
9095 * A CResult_ClosingSignedDecodeErrorZ represents the result of a fallible operation,
9096 * containing a crate::lightning::ln::msgs::ClosingSigned on success and a crate::lightning::ln::msgs::DecodeError on failure.
9097 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9099 typedef struct LDKCResult_ClosingSignedDecodeErrorZ {
9101 * The contents of this CResult_ClosingSignedDecodeErrorZ, accessible via either
9102 * `err` or `result` depending on the state of `result_ok`.
9104 union LDKCResult_ClosingSignedDecodeErrorZPtr contents;
9106 * Whether this CResult_ClosingSignedDecodeErrorZ represents a success state.
9109 } LDKCResult_ClosingSignedDecodeErrorZ;
9114 * The minimum and maximum fees which the sender is willing to place on the closing transaction.
9115 * This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
9118 typedef struct MUST_USE_STRUCT LDKClosingSignedFeeRange {
9120 * A pointer to the opaque Rust object.
9121 * Nearly everywhere, inner must be non-null, however in places where
9122 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9124 LDKnativeClosingSignedFeeRange *inner;
9126 * Indicates that this is the only struct which contains the same pointer.
9127 * Rust functions which take ownership of an object provided via an argument require
9128 * this to be true and invalidate the object pointed to by inner.
9131 } LDKClosingSignedFeeRange;
9134 * The contents of CResult_ClosingSignedFeeRangeDecodeErrorZ
9136 typedef union LDKCResult_ClosingSignedFeeRangeDecodeErrorZPtr {
9138 * A pointer to the contents in the success state.
9139 * Reading from this pointer when `result_ok` is not set is undefined.
9141 struct LDKClosingSignedFeeRange *result;
9143 * A pointer to the contents in the error state.
9144 * Reading from this pointer when `result_ok` is set is undefined.
9146 struct LDKDecodeError *err;
9147 } LDKCResult_ClosingSignedFeeRangeDecodeErrorZPtr;
9150 * A CResult_ClosingSignedFeeRangeDecodeErrorZ represents the result of a fallible operation,
9151 * containing a crate::lightning::ln::msgs::ClosingSignedFeeRange on success and a crate::lightning::ln::msgs::DecodeError on failure.
9152 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9154 typedef struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ {
9156 * The contents of this CResult_ClosingSignedFeeRangeDecodeErrorZ, accessible via either
9157 * `err` or `result` depending on the state of `result_ok`.
9159 union LDKCResult_ClosingSignedFeeRangeDecodeErrorZPtr contents;
9161 * Whether this CResult_ClosingSignedFeeRangeDecodeErrorZ represents a success state.
9164 } LDKCResult_ClosingSignedFeeRangeDecodeErrorZ;
9169 * A commitment_signed message to be sent or received from a peer
9171 typedef struct MUST_USE_STRUCT LDKCommitmentSigned {
9173 * A pointer to the opaque Rust object.
9174 * Nearly everywhere, inner must be non-null, however in places where
9175 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9177 LDKnativeCommitmentSigned *inner;
9179 * Indicates that this is the only struct which contains the same pointer.
9180 * Rust functions which take ownership of an object provided via an argument require
9181 * this to be true and invalidate the object pointed to by inner.
9184 } LDKCommitmentSigned;
9187 * The contents of CResult_CommitmentSignedDecodeErrorZ
9189 typedef union LDKCResult_CommitmentSignedDecodeErrorZPtr {
9191 * A pointer to the contents in the success state.
9192 * Reading from this pointer when `result_ok` is not set is undefined.
9194 struct LDKCommitmentSigned *result;
9196 * A pointer to the contents in the error state.
9197 * Reading from this pointer when `result_ok` is set is undefined.
9199 struct LDKDecodeError *err;
9200 } LDKCResult_CommitmentSignedDecodeErrorZPtr;
9203 * A CResult_CommitmentSignedDecodeErrorZ represents the result of a fallible operation,
9204 * containing a crate::lightning::ln::msgs::CommitmentSigned on success and a crate::lightning::ln::msgs::DecodeError on failure.
9205 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9207 typedef struct LDKCResult_CommitmentSignedDecodeErrorZ {
9209 * The contents of this CResult_CommitmentSignedDecodeErrorZ, accessible via either
9210 * `err` or `result` depending on the state of `result_ok`.
9212 union LDKCResult_CommitmentSignedDecodeErrorZPtr contents;
9214 * Whether this CResult_CommitmentSignedDecodeErrorZ represents a success state.
9217 } LDKCResult_CommitmentSignedDecodeErrorZ;
9220 * The contents of CResult_FundingCreatedDecodeErrorZ
9222 typedef union LDKCResult_FundingCreatedDecodeErrorZPtr {
9224 * A pointer to the contents in the success state.
9225 * Reading from this pointer when `result_ok` is not set is undefined.
9227 struct LDKFundingCreated *result;
9229 * A pointer to the contents in the error state.
9230 * Reading from this pointer when `result_ok` is set is undefined.
9232 struct LDKDecodeError *err;
9233 } LDKCResult_FundingCreatedDecodeErrorZPtr;
9236 * A CResult_FundingCreatedDecodeErrorZ represents the result of a fallible operation,
9237 * containing a crate::lightning::ln::msgs::FundingCreated on success and a crate::lightning::ln::msgs::DecodeError on failure.
9238 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9240 typedef struct LDKCResult_FundingCreatedDecodeErrorZ {
9242 * The contents of this CResult_FundingCreatedDecodeErrorZ, accessible via either
9243 * `err` or `result` depending on the state of `result_ok`.
9245 union LDKCResult_FundingCreatedDecodeErrorZPtr contents;
9247 * Whether this CResult_FundingCreatedDecodeErrorZ represents a success state.
9250 } LDKCResult_FundingCreatedDecodeErrorZ;
9253 * The contents of CResult_FundingSignedDecodeErrorZ
9255 typedef union LDKCResult_FundingSignedDecodeErrorZPtr {
9257 * A pointer to the contents in the success state.
9258 * Reading from this pointer when `result_ok` is not set is undefined.
9260 struct LDKFundingSigned *result;
9262 * A pointer to the contents in the error state.
9263 * Reading from this pointer when `result_ok` is set is undefined.
9265 struct LDKDecodeError *err;
9266 } LDKCResult_FundingSignedDecodeErrorZPtr;
9269 * A CResult_FundingSignedDecodeErrorZ represents the result of a fallible operation,
9270 * containing a crate::lightning::ln::msgs::FundingSigned on success and a crate::lightning::ln::msgs::DecodeError on failure.
9271 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9273 typedef struct LDKCResult_FundingSignedDecodeErrorZ {
9275 * The contents of this CResult_FundingSignedDecodeErrorZ, accessible via either
9276 * `err` or `result` depending on the state of `result_ok`.
9278 union LDKCResult_FundingSignedDecodeErrorZPtr contents;
9280 * Whether this CResult_FundingSignedDecodeErrorZ represents a success state.
9283 } LDKCResult_FundingSignedDecodeErrorZ;
9286 * The contents of CResult_FundingLockedDecodeErrorZ
9288 typedef union LDKCResult_FundingLockedDecodeErrorZPtr {
9290 * A pointer to the contents in the success state.
9291 * Reading from this pointer when `result_ok` is not set is undefined.
9293 struct LDKFundingLocked *result;
9295 * A pointer to the contents in the error state.
9296 * Reading from this pointer when `result_ok` is set is undefined.
9298 struct LDKDecodeError *err;
9299 } LDKCResult_FundingLockedDecodeErrorZPtr;
9302 * A CResult_FundingLockedDecodeErrorZ represents the result of a fallible operation,
9303 * containing a crate::lightning::ln::msgs::FundingLocked on success and a crate::lightning::ln::msgs::DecodeError on failure.
9304 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9306 typedef struct LDKCResult_FundingLockedDecodeErrorZ {
9308 * The contents of this CResult_FundingLockedDecodeErrorZ, accessible via either
9309 * `err` or `result` depending on the state of `result_ok`.
9311 union LDKCResult_FundingLockedDecodeErrorZPtr contents;
9313 * Whether this CResult_FundingLockedDecodeErrorZ represents a success state.
9316 } LDKCResult_FundingLockedDecodeErrorZ;
9321 * An init message to be sent or received from a peer
9323 typedef struct MUST_USE_STRUCT LDKInit {
9325 * A pointer to the opaque Rust object.
9326 * Nearly everywhere, inner must be non-null, however in places where
9327 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9329 LDKnativeInit *inner;
9331 * Indicates that this is the only struct which contains the same pointer.
9332 * Rust functions which take ownership of an object provided via an argument require
9333 * this to be true and invalidate the object pointed to by inner.
9339 * The contents of CResult_InitDecodeErrorZ
9341 typedef union LDKCResult_InitDecodeErrorZPtr {
9343 * A pointer to the contents in the success state.
9344 * Reading from this pointer when `result_ok` is not set is undefined.
9346 struct LDKInit *result;
9348 * A pointer to the contents in the error state.
9349 * Reading from this pointer when `result_ok` is set is undefined.
9351 struct LDKDecodeError *err;
9352 } LDKCResult_InitDecodeErrorZPtr;
9355 * A CResult_InitDecodeErrorZ represents the result of a fallible operation,
9356 * containing a crate::lightning::ln::msgs::Init on success and a crate::lightning::ln::msgs::DecodeError on failure.
9357 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9359 typedef struct LDKCResult_InitDecodeErrorZ {
9361 * The contents of this CResult_InitDecodeErrorZ, accessible via either
9362 * `err` or `result` depending on the state of `result_ok`.
9364 union LDKCResult_InitDecodeErrorZPtr contents;
9366 * Whether this CResult_InitDecodeErrorZ represents a success state.
9369 } LDKCResult_InitDecodeErrorZ;
9372 * The contents of CResult_OpenChannelDecodeErrorZ
9374 typedef union LDKCResult_OpenChannelDecodeErrorZPtr {
9376 * A pointer to the contents in the success state.
9377 * Reading from this pointer when `result_ok` is not set is undefined.
9379 struct LDKOpenChannel *result;
9381 * A pointer to the contents in the error state.
9382 * Reading from this pointer when `result_ok` is set is undefined.
9384 struct LDKDecodeError *err;
9385 } LDKCResult_OpenChannelDecodeErrorZPtr;
9388 * A CResult_OpenChannelDecodeErrorZ represents the result of a fallible operation,
9389 * containing a crate::lightning::ln::msgs::OpenChannel on success and a crate::lightning::ln::msgs::DecodeError on failure.
9390 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9392 typedef struct LDKCResult_OpenChannelDecodeErrorZ {
9394 * The contents of this CResult_OpenChannelDecodeErrorZ, accessible via either
9395 * `err` or `result` depending on the state of `result_ok`.
9397 union LDKCResult_OpenChannelDecodeErrorZPtr contents;
9399 * Whether this CResult_OpenChannelDecodeErrorZ represents a success state.
9402 } LDKCResult_OpenChannelDecodeErrorZ;
9405 * The contents of CResult_RevokeAndACKDecodeErrorZ
9407 typedef union LDKCResult_RevokeAndACKDecodeErrorZPtr {
9409 * A pointer to the contents in the success state.
9410 * Reading from this pointer when `result_ok` is not set is undefined.
9412 struct LDKRevokeAndACK *result;
9414 * A pointer to the contents in the error state.
9415 * Reading from this pointer when `result_ok` is set is undefined.
9417 struct LDKDecodeError *err;
9418 } LDKCResult_RevokeAndACKDecodeErrorZPtr;
9421 * A CResult_RevokeAndACKDecodeErrorZ represents the result of a fallible operation,
9422 * containing a crate::lightning::ln::msgs::RevokeAndACK on success and a crate::lightning::ln::msgs::DecodeError on failure.
9423 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9425 typedef struct LDKCResult_RevokeAndACKDecodeErrorZ {
9427 * The contents of this CResult_RevokeAndACKDecodeErrorZ, accessible via either
9428 * `err` or `result` depending on the state of `result_ok`.
9430 union LDKCResult_RevokeAndACKDecodeErrorZPtr contents;
9432 * Whether this CResult_RevokeAndACKDecodeErrorZ represents a success state.
9435 } LDKCResult_RevokeAndACKDecodeErrorZ;
9438 * The contents of CResult_ShutdownDecodeErrorZ
9440 typedef union LDKCResult_ShutdownDecodeErrorZPtr {
9442 * A pointer to the contents in the success state.
9443 * Reading from this pointer when `result_ok` is not set is undefined.
9445 struct LDKShutdown *result;
9447 * A pointer to the contents in the error state.
9448 * Reading from this pointer when `result_ok` is set is undefined.
9450 struct LDKDecodeError *err;
9451 } LDKCResult_ShutdownDecodeErrorZPtr;
9454 * A CResult_ShutdownDecodeErrorZ represents the result of a fallible operation,
9455 * containing a crate::lightning::ln::msgs::Shutdown on success and a crate::lightning::ln::msgs::DecodeError on failure.
9456 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9458 typedef struct LDKCResult_ShutdownDecodeErrorZ {
9460 * The contents of this CResult_ShutdownDecodeErrorZ, accessible via either
9461 * `err` or `result` depending on the state of `result_ok`.
9463 union LDKCResult_ShutdownDecodeErrorZPtr contents;
9465 * Whether this CResult_ShutdownDecodeErrorZ represents a success state.
9468 } LDKCResult_ShutdownDecodeErrorZ;
9471 * The contents of CResult_UpdateFailHTLCDecodeErrorZ
9473 typedef union LDKCResult_UpdateFailHTLCDecodeErrorZPtr {
9475 * A pointer to the contents in the success state.
9476 * Reading from this pointer when `result_ok` is not set is undefined.
9478 struct LDKUpdateFailHTLC *result;
9480 * A pointer to the contents in the error state.
9481 * Reading from this pointer when `result_ok` is set is undefined.
9483 struct LDKDecodeError *err;
9484 } LDKCResult_UpdateFailHTLCDecodeErrorZPtr;
9487 * A CResult_UpdateFailHTLCDecodeErrorZ represents the result of a fallible operation,
9488 * containing a crate::lightning::ln::msgs::UpdateFailHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
9489 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9491 typedef struct LDKCResult_UpdateFailHTLCDecodeErrorZ {
9493 * The contents of this CResult_UpdateFailHTLCDecodeErrorZ, accessible via either
9494 * `err` or `result` depending on the state of `result_ok`.
9496 union LDKCResult_UpdateFailHTLCDecodeErrorZPtr contents;
9498 * Whether this CResult_UpdateFailHTLCDecodeErrorZ represents a success state.
9501 } LDKCResult_UpdateFailHTLCDecodeErrorZ;
9504 * The contents of CResult_UpdateFailMalformedHTLCDecodeErrorZ
9506 typedef union LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr {
9508 * A pointer to the contents in the success state.
9509 * Reading from this pointer when `result_ok` is not set is undefined.
9511 struct LDKUpdateFailMalformedHTLC *result;
9513 * A pointer to the contents in the error state.
9514 * Reading from this pointer when `result_ok` is set is undefined.
9516 struct LDKDecodeError *err;
9517 } LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr;
9520 * A CResult_UpdateFailMalformedHTLCDecodeErrorZ represents the result of a fallible operation,
9521 * containing a crate::lightning::ln::msgs::UpdateFailMalformedHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
9522 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9524 typedef struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ {
9526 * The contents of this CResult_UpdateFailMalformedHTLCDecodeErrorZ, accessible via either
9527 * `err` or `result` depending on the state of `result_ok`.
9529 union LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr contents;
9531 * Whether this CResult_UpdateFailMalformedHTLCDecodeErrorZ represents a success state.
9534 } LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ;
9539 * An update_fee message to be sent or received from a peer
9541 typedef struct MUST_USE_STRUCT LDKUpdateFee {
9543 * A pointer to the opaque Rust object.
9544 * Nearly everywhere, inner must be non-null, however in places where
9545 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9547 LDKnativeUpdateFee *inner;
9549 * Indicates that this is the only struct which contains the same pointer.
9550 * Rust functions which take ownership of an object provided via an argument require
9551 * this to be true and invalidate the object pointed to by inner.
9557 * The contents of CResult_UpdateFeeDecodeErrorZ
9559 typedef union LDKCResult_UpdateFeeDecodeErrorZPtr {
9561 * A pointer to the contents in the success state.
9562 * Reading from this pointer when `result_ok` is not set is undefined.
9564 struct LDKUpdateFee *result;
9566 * A pointer to the contents in the error state.
9567 * Reading from this pointer when `result_ok` is set is undefined.
9569 struct LDKDecodeError *err;
9570 } LDKCResult_UpdateFeeDecodeErrorZPtr;
9573 * A CResult_UpdateFeeDecodeErrorZ represents the result of a fallible operation,
9574 * containing a crate::lightning::ln::msgs::UpdateFee on success and a crate::lightning::ln::msgs::DecodeError on failure.
9575 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9577 typedef struct LDKCResult_UpdateFeeDecodeErrorZ {
9579 * The contents of this CResult_UpdateFeeDecodeErrorZ, accessible via either
9580 * `err` or `result` depending on the state of `result_ok`.
9582 union LDKCResult_UpdateFeeDecodeErrorZPtr contents;
9584 * Whether this CResult_UpdateFeeDecodeErrorZ represents a success state.
9587 } LDKCResult_UpdateFeeDecodeErrorZ;
9590 * The contents of CResult_UpdateFulfillHTLCDecodeErrorZ
9592 typedef union LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr {
9594 * A pointer to the contents in the success state.
9595 * Reading from this pointer when `result_ok` is not set is undefined.
9597 struct LDKUpdateFulfillHTLC *result;
9599 * A pointer to the contents in the error state.
9600 * Reading from this pointer when `result_ok` is set is undefined.
9602 struct LDKDecodeError *err;
9603 } LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr;
9606 * A CResult_UpdateFulfillHTLCDecodeErrorZ represents the result of a fallible operation,
9607 * containing a crate::lightning::ln::msgs::UpdateFulfillHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
9608 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9610 typedef struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ {
9612 * The contents of this CResult_UpdateFulfillHTLCDecodeErrorZ, accessible via either
9613 * `err` or `result` depending on the state of `result_ok`.
9615 union LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr contents;
9617 * Whether this CResult_UpdateFulfillHTLCDecodeErrorZ represents a success state.
9620 } LDKCResult_UpdateFulfillHTLCDecodeErrorZ;
9623 * The contents of CResult_UpdateAddHTLCDecodeErrorZ
9625 typedef union LDKCResult_UpdateAddHTLCDecodeErrorZPtr {
9627 * A pointer to the contents in the success state.
9628 * Reading from this pointer when `result_ok` is not set is undefined.
9630 struct LDKUpdateAddHTLC *result;
9632 * A pointer to the contents in the error state.
9633 * Reading from this pointer when `result_ok` is set is undefined.
9635 struct LDKDecodeError *err;
9636 } LDKCResult_UpdateAddHTLCDecodeErrorZPtr;
9639 * A CResult_UpdateAddHTLCDecodeErrorZ represents the result of a fallible operation,
9640 * containing a crate::lightning::ln::msgs::UpdateAddHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
9641 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9643 typedef struct LDKCResult_UpdateAddHTLCDecodeErrorZ {
9645 * The contents of this CResult_UpdateAddHTLCDecodeErrorZ, accessible via either
9646 * `err` or `result` depending on the state of `result_ok`.
9648 union LDKCResult_UpdateAddHTLCDecodeErrorZPtr contents;
9650 * Whether this CResult_UpdateAddHTLCDecodeErrorZ represents a success state.
9653 } LDKCResult_UpdateAddHTLCDecodeErrorZ;
9658 * A ping message to be sent or received from a peer
9660 typedef struct MUST_USE_STRUCT LDKPing {
9662 * A pointer to the opaque Rust object.
9663 * Nearly everywhere, inner must be non-null, however in places where
9664 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9666 LDKnativePing *inner;
9668 * Indicates that this is the only struct which contains the same pointer.
9669 * Rust functions which take ownership of an object provided via an argument require
9670 * this to be true and invalidate the object pointed to by inner.
9676 * The contents of CResult_PingDecodeErrorZ
9678 typedef union LDKCResult_PingDecodeErrorZPtr {
9680 * A pointer to the contents in the success state.
9681 * Reading from this pointer when `result_ok` is not set is undefined.
9683 struct LDKPing *result;
9685 * A pointer to the contents in the error state.
9686 * Reading from this pointer when `result_ok` is set is undefined.
9688 struct LDKDecodeError *err;
9689 } LDKCResult_PingDecodeErrorZPtr;
9692 * A CResult_PingDecodeErrorZ represents the result of a fallible operation,
9693 * containing a crate::lightning::ln::msgs::Ping on success and a crate::lightning::ln::msgs::DecodeError on failure.
9694 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9696 typedef struct LDKCResult_PingDecodeErrorZ {
9698 * The contents of this CResult_PingDecodeErrorZ, accessible via either
9699 * `err` or `result` depending on the state of `result_ok`.
9701 union LDKCResult_PingDecodeErrorZPtr contents;
9703 * Whether this CResult_PingDecodeErrorZ represents a success state.
9706 } LDKCResult_PingDecodeErrorZ;
9711 * A pong message to be sent or received from a peer
9713 typedef struct MUST_USE_STRUCT LDKPong {
9715 * A pointer to the opaque Rust object.
9716 * Nearly everywhere, inner must be non-null, however in places where
9717 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9719 LDKnativePong *inner;
9721 * Indicates that this is the only struct which contains the same pointer.
9722 * Rust functions which take ownership of an object provided via an argument require
9723 * this to be true and invalidate the object pointed to by inner.
9729 * The contents of CResult_PongDecodeErrorZ
9731 typedef union LDKCResult_PongDecodeErrorZPtr {
9733 * A pointer to the contents in the success state.
9734 * Reading from this pointer when `result_ok` is not set is undefined.
9736 struct LDKPong *result;
9738 * A pointer to the contents in the error state.
9739 * Reading from this pointer when `result_ok` is set is undefined.
9741 struct LDKDecodeError *err;
9742 } LDKCResult_PongDecodeErrorZPtr;
9745 * A CResult_PongDecodeErrorZ represents the result of a fallible operation,
9746 * containing a crate::lightning::ln::msgs::Pong on success and a crate::lightning::ln::msgs::DecodeError on failure.
9747 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9749 typedef struct LDKCResult_PongDecodeErrorZ {
9751 * The contents of this CResult_PongDecodeErrorZ, accessible via either
9752 * `err` or `result` depending on the state of `result_ok`.
9754 union LDKCResult_PongDecodeErrorZPtr contents;
9756 * Whether this CResult_PongDecodeErrorZ represents a success state.
9759 } LDKCResult_PongDecodeErrorZ;
9762 * The contents of CResult_UnsignedChannelAnnouncementDecodeErrorZ
9764 typedef union LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr {
9766 * A pointer to the contents in the success state.
9767 * Reading from this pointer when `result_ok` is not set is undefined.
9769 struct LDKUnsignedChannelAnnouncement *result;
9771 * A pointer to the contents in the error state.
9772 * Reading from this pointer when `result_ok` is set is undefined.
9774 struct LDKDecodeError *err;
9775 } LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr;
9778 * A CResult_UnsignedChannelAnnouncementDecodeErrorZ represents the result of a fallible operation,
9779 * containing a crate::lightning::ln::msgs::UnsignedChannelAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
9780 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9782 typedef struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ {
9784 * The contents of this CResult_UnsignedChannelAnnouncementDecodeErrorZ, accessible via either
9785 * `err` or `result` depending on the state of `result_ok`.
9787 union LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr contents;
9789 * Whether this CResult_UnsignedChannelAnnouncementDecodeErrorZ represents a success state.
9792 } LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ;
9795 * The contents of CResult_ChannelAnnouncementDecodeErrorZ
9797 typedef union LDKCResult_ChannelAnnouncementDecodeErrorZPtr {
9799 * A pointer to the contents in the success state.
9800 * Reading from this pointer when `result_ok` is not set is undefined.
9802 struct LDKChannelAnnouncement *result;
9804 * A pointer to the contents in the error state.
9805 * Reading from this pointer when `result_ok` is set is undefined.
9807 struct LDKDecodeError *err;
9808 } LDKCResult_ChannelAnnouncementDecodeErrorZPtr;
9811 * A CResult_ChannelAnnouncementDecodeErrorZ represents the result of a fallible operation,
9812 * containing a crate::lightning::ln::msgs::ChannelAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
9813 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9815 typedef struct LDKCResult_ChannelAnnouncementDecodeErrorZ {
9817 * The contents of this CResult_ChannelAnnouncementDecodeErrorZ, accessible via either
9818 * `err` or `result` depending on the state of `result_ok`.
9820 union LDKCResult_ChannelAnnouncementDecodeErrorZPtr contents;
9822 * Whether this CResult_ChannelAnnouncementDecodeErrorZ represents a success state.
9825 } LDKCResult_ChannelAnnouncementDecodeErrorZ;
9830 * The unsigned part of a channel_update
9832 typedef struct MUST_USE_STRUCT LDKUnsignedChannelUpdate {
9834 * A pointer to the opaque Rust object.
9835 * Nearly everywhere, inner must be non-null, however in places where
9836 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9838 LDKnativeUnsignedChannelUpdate *inner;
9840 * Indicates that this is the only struct which contains the same pointer.
9841 * Rust functions which take ownership of an object provided via an argument require
9842 * this to be true and invalidate the object pointed to by inner.
9845 } LDKUnsignedChannelUpdate;
9848 * The contents of CResult_UnsignedChannelUpdateDecodeErrorZ
9850 typedef union LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr {
9852 * A pointer to the contents in the success state.
9853 * Reading from this pointer when `result_ok` is not set is undefined.
9855 struct LDKUnsignedChannelUpdate *result;
9857 * A pointer to the contents in the error state.
9858 * Reading from this pointer when `result_ok` is set is undefined.
9860 struct LDKDecodeError *err;
9861 } LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr;
9864 * A CResult_UnsignedChannelUpdateDecodeErrorZ represents the result of a fallible operation,
9865 * containing a crate::lightning::ln::msgs::UnsignedChannelUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
9866 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9868 typedef struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ {
9870 * The contents of this CResult_UnsignedChannelUpdateDecodeErrorZ, accessible via either
9871 * `err` or `result` depending on the state of `result_ok`.
9873 union LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr contents;
9875 * Whether this CResult_UnsignedChannelUpdateDecodeErrorZ represents a success state.
9878 } LDKCResult_UnsignedChannelUpdateDecodeErrorZ;
9881 * The contents of CResult_ChannelUpdateDecodeErrorZ
9883 typedef union LDKCResult_ChannelUpdateDecodeErrorZPtr {
9885 * A pointer to the contents in the success state.
9886 * Reading from this pointer when `result_ok` is not set is undefined.
9888 struct LDKChannelUpdate *result;
9890 * A pointer to the contents in the error state.
9891 * Reading from this pointer when `result_ok` is set is undefined.
9893 struct LDKDecodeError *err;
9894 } LDKCResult_ChannelUpdateDecodeErrorZPtr;
9897 * A CResult_ChannelUpdateDecodeErrorZ represents the result of a fallible operation,
9898 * containing a crate::lightning::ln::msgs::ChannelUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
9899 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9901 typedef struct LDKCResult_ChannelUpdateDecodeErrorZ {
9903 * The contents of this CResult_ChannelUpdateDecodeErrorZ, accessible via either
9904 * `err` or `result` depending on the state of `result_ok`.
9906 union LDKCResult_ChannelUpdateDecodeErrorZPtr contents;
9908 * Whether this CResult_ChannelUpdateDecodeErrorZ represents a success state.
9911 } LDKCResult_ChannelUpdateDecodeErrorZ;
9914 * The contents of CResult_ErrorMessageDecodeErrorZ
9916 typedef union LDKCResult_ErrorMessageDecodeErrorZPtr {
9918 * A pointer to the contents in the success state.
9919 * Reading from this pointer when `result_ok` is not set is undefined.
9921 struct LDKErrorMessage *result;
9923 * A pointer to the contents in the error state.
9924 * Reading from this pointer when `result_ok` is set is undefined.
9926 struct LDKDecodeError *err;
9927 } LDKCResult_ErrorMessageDecodeErrorZPtr;
9930 * A CResult_ErrorMessageDecodeErrorZ represents the result of a fallible operation,
9931 * containing a crate::lightning::ln::msgs::ErrorMessage on success and a crate::lightning::ln::msgs::DecodeError on failure.
9932 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9934 typedef struct LDKCResult_ErrorMessageDecodeErrorZ {
9936 * The contents of this CResult_ErrorMessageDecodeErrorZ, accessible via either
9937 * `err` or `result` depending on the state of `result_ok`.
9939 union LDKCResult_ErrorMessageDecodeErrorZPtr contents;
9941 * Whether this CResult_ErrorMessageDecodeErrorZ represents a success state.
9944 } LDKCResult_ErrorMessageDecodeErrorZ;
9947 * The contents of CResult_WarningMessageDecodeErrorZ
9949 typedef union LDKCResult_WarningMessageDecodeErrorZPtr {
9951 * A pointer to the contents in the success state.
9952 * Reading from this pointer when `result_ok` is not set is undefined.
9954 struct LDKWarningMessage *result;
9956 * A pointer to the contents in the error state.
9957 * Reading from this pointer when `result_ok` is set is undefined.
9959 struct LDKDecodeError *err;
9960 } LDKCResult_WarningMessageDecodeErrorZPtr;
9963 * A CResult_WarningMessageDecodeErrorZ represents the result of a fallible operation,
9964 * containing a crate::lightning::ln::msgs::WarningMessage on success and a crate::lightning::ln::msgs::DecodeError on failure.
9965 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9967 typedef struct LDKCResult_WarningMessageDecodeErrorZ {
9969 * The contents of this CResult_WarningMessageDecodeErrorZ, accessible via either
9970 * `err` or `result` depending on the state of `result_ok`.
9972 union LDKCResult_WarningMessageDecodeErrorZPtr contents;
9974 * Whether this CResult_WarningMessageDecodeErrorZ represents a success state.
9977 } LDKCResult_WarningMessageDecodeErrorZ;
9982 * The unsigned part of a node_announcement
9984 typedef struct MUST_USE_STRUCT LDKUnsignedNodeAnnouncement {
9986 * A pointer to the opaque Rust object.
9987 * Nearly everywhere, inner must be non-null, however in places where
9988 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9990 LDKnativeUnsignedNodeAnnouncement *inner;
9992 * Indicates that this is the only struct which contains the same pointer.
9993 * Rust functions which take ownership of an object provided via an argument require
9994 * this to be true and invalidate the object pointed to by inner.
9997 } LDKUnsignedNodeAnnouncement;
10000 * The contents of CResult_UnsignedNodeAnnouncementDecodeErrorZ
10002 typedef union LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr {
10004 * A pointer to the contents in the success state.
10005 * Reading from this pointer when `result_ok` is not set is undefined.
10007 struct LDKUnsignedNodeAnnouncement *result;
10009 * A pointer to the contents in the error state.
10010 * Reading from this pointer when `result_ok` is set is undefined.
10012 struct LDKDecodeError *err;
10013 } LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr;
10016 * A CResult_UnsignedNodeAnnouncementDecodeErrorZ represents the result of a fallible operation,
10017 * containing a crate::lightning::ln::msgs::UnsignedNodeAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
10018 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10020 typedef struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ {
10022 * The contents of this CResult_UnsignedNodeAnnouncementDecodeErrorZ, accessible via either
10023 * `err` or `result` depending on the state of `result_ok`.
10025 union LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr contents;
10027 * Whether this CResult_UnsignedNodeAnnouncementDecodeErrorZ represents a success state.
10030 } LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ;
10033 * The contents of CResult_NodeAnnouncementDecodeErrorZ
10035 typedef union LDKCResult_NodeAnnouncementDecodeErrorZPtr {
10037 * A pointer to the contents in the success state.
10038 * Reading from this pointer when `result_ok` is not set is undefined.
10040 struct LDKNodeAnnouncement *result;
10042 * A pointer to the contents in the error state.
10043 * Reading from this pointer when `result_ok` is set is undefined.
10045 struct LDKDecodeError *err;
10046 } LDKCResult_NodeAnnouncementDecodeErrorZPtr;
10049 * A CResult_NodeAnnouncementDecodeErrorZ represents the result of a fallible operation,
10050 * containing a crate::lightning::ln::msgs::NodeAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
10051 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10053 typedef struct LDKCResult_NodeAnnouncementDecodeErrorZ {
10055 * The contents of this CResult_NodeAnnouncementDecodeErrorZ, accessible via either
10056 * `err` or `result` depending on the state of `result_ok`.
10058 union LDKCResult_NodeAnnouncementDecodeErrorZPtr contents;
10060 * Whether this CResult_NodeAnnouncementDecodeErrorZ represents a success state.
10063 } LDKCResult_NodeAnnouncementDecodeErrorZ;
10066 * The contents of CResult_QueryShortChannelIdsDecodeErrorZ
10068 typedef union LDKCResult_QueryShortChannelIdsDecodeErrorZPtr {
10070 * A pointer to the contents in the success state.
10071 * Reading from this pointer when `result_ok` is not set is undefined.
10073 struct LDKQueryShortChannelIds *result;
10075 * A pointer to the contents in the error state.
10076 * Reading from this pointer when `result_ok` is set is undefined.
10078 struct LDKDecodeError *err;
10079 } LDKCResult_QueryShortChannelIdsDecodeErrorZPtr;
10082 * A CResult_QueryShortChannelIdsDecodeErrorZ represents the result of a fallible operation,
10083 * containing a crate::lightning::ln::msgs::QueryShortChannelIds on success and a crate::lightning::ln::msgs::DecodeError on failure.
10084 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10086 typedef struct LDKCResult_QueryShortChannelIdsDecodeErrorZ {
10088 * The contents of this CResult_QueryShortChannelIdsDecodeErrorZ, accessible via either
10089 * `err` or `result` depending on the state of `result_ok`.
10091 union LDKCResult_QueryShortChannelIdsDecodeErrorZPtr contents;
10093 * Whether this CResult_QueryShortChannelIdsDecodeErrorZ represents a success state.
10096 } LDKCResult_QueryShortChannelIdsDecodeErrorZ;
10101 * A reply_short_channel_ids_end message is sent as a reply to a
10102 * query_short_channel_ids message. The query recipient makes a best
10103 * effort to respond based on their local network view which may not be
10104 * a perfect view of the network.
10106 typedef struct MUST_USE_STRUCT LDKReplyShortChannelIdsEnd {
10108 * A pointer to the opaque Rust object.
10109 * Nearly everywhere, inner must be non-null, however in places where
10110 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10112 LDKnativeReplyShortChannelIdsEnd *inner;
10114 * Indicates that this is the only struct which contains the same pointer.
10115 * Rust functions which take ownership of an object provided via an argument require
10116 * this to be true and invalidate the object pointed to by inner.
10119 } LDKReplyShortChannelIdsEnd;
10122 * The contents of CResult_ReplyShortChannelIdsEndDecodeErrorZ
10124 typedef union LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr {
10126 * A pointer to the contents in the success state.
10127 * Reading from this pointer when `result_ok` is not set is undefined.
10129 struct LDKReplyShortChannelIdsEnd *result;
10131 * A pointer to the contents in the error state.
10132 * Reading from this pointer when `result_ok` is set is undefined.
10134 struct LDKDecodeError *err;
10135 } LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr;
10138 * A CResult_ReplyShortChannelIdsEndDecodeErrorZ represents the result of a fallible operation,
10139 * containing a crate::lightning::ln::msgs::ReplyShortChannelIdsEnd on success and a crate::lightning::ln::msgs::DecodeError on failure.
10140 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10142 typedef struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ {
10144 * The contents of this CResult_ReplyShortChannelIdsEndDecodeErrorZ, accessible via either
10145 * `err` or `result` depending on the state of `result_ok`.
10147 union LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr contents;
10149 * Whether this CResult_ReplyShortChannelIdsEndDecodeErrorZ represents a success state.
10152 } LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ;
10155 * The contents of CResult_QueryChannelRangeDecodeErrorZ
10157 typedef union LDKCResult_QueryChannelRangeDecodeErrorZPtr {
10159 * A pointer to the contents in the success state.
10160 * Reading from this pointer when `result_ok` is not set is undefined.
10162 struct LDKQueryChannelRange *result;
10164 * A pointer to the contents in the error state.
10165 * Reading from this pointer when `result_ok` is set is undefined.
10167 struct LDKDecodeError *err;
10168 } LDKCResult_QueryChannelRangeDecodeErrorZPtr;
10171 * A CResult_QueryChannelRangeDecodeErrorZ represents the result of a fallible operation,
10172 * containing a crate::lightning::ln::msgs::QueryChannelRange on success and a crate::lightning::ln::msgs::DecodeError on failure.
10173 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10175 typedef struct LDKCResult_QueryChannelRangeDecodeErrorZ {
10177 * The contents of this CResult_QueryChannelRangeDecodeErrorZ, accessible via either
10178 * `err` or `result` depending on the state of `result_ok`.
10180 union LDKCResult_QueryChannelRangeDecodeErrorZPtr contents;
10182 * Whether this CResult_QueryChannelRangeDecodeErrorZ represents a success state.
10185 } LDKCResult_QueryChannelRangeDecodeErrorZ;
10188 * The contents of CResult_ReplyChannelRangeDecodeErrorZ
10190 typedef union LDKCResult_ReplyChannelRangeDecodeErrorZPtr {
10192 * A pointer to the contents in the success state.
10193 * Reading from this pointer when `result_ok` is not set is undefined.
10195 struct LDKReplyChannelRange *result;
10197 * A pointer to the contents in the error state.
10198 * Reading from this pointer when `result_ok` is set is undefined.
10200 struct LDKDecodeError *err;
10201 } LDKCResult_ReplyChannelRangeDecodeErrorZPtr;
10204 * A CResult_ReplyChannelRangeDecodeErrorZ represents the result of a fallible operation,
10205 * containing a crate::lightning::ln::msgs::ReplyChannelRange on success and a crate::lightning::ln::msgs::DecodeError on failure.
10206 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10208 typedef struct LDKCResult_ReplyChannelRangeDecodeErrorZ {
10210 * The contents of this CResult_ReplyChannelRangeDecodeErrorZ, accessible via either
10211 * `err` or `result` depending on the state of `result_ok`.
10213 union LDKCResult_ReplyChannelRangeDecodeErrorZPtr contents;
10215 * Whether this CResult_ReplyChannelRangeDecodeErrorZ represents a success state.
10218 } LDKCResult_ReplyChannelRangeDecodeErrorZ;
10223 * A gossip_timestamp_filter message is used by a node to request
10224 * gossip relay for messages in the requested time range when the
10225 * gossip_queries feature has been negotiated.
10227 typedef struct MUST_USE_STRUCT LDKGossipTimestampFilter {
10229 * A pointer to the opaque Rust object.
10230 * Nearly everywhere, inner must be non-null, however in places where
10231 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10233 LDKnativeGossipTimestampFilter *inner;
10235 * Indicates that this is the only struct which contains the same pointer.
10236 * Rust functions which take ownership of an object provided via an argument require
10237 * this to be true and invalidate the object pointed to by inner.
10240 } LDKGossipTimestampFilter;
10243 * The contents of CResult_GossipTimestampFilterDecodeErrorZ
10245 typedef union LDKCResult_GossipTimestampFilterDecodeErrorZPtr {
10247 * A pointer to the contents in the success state.
10248 * Reading from this pointer when `result_ok` is not set is undefined.
10250 struct LDKGossipTimestampFilter *result;
10252 * A pointer to the contents in the error state.
10253 * Reading from this pointer when `result_ok` is set is undefined.
10255 struct LDKDecodeError *err;
10256 } LDKCResult_GossipTimestampFilterDecodeErrorZPtr;
10259 * A CResult_GossipTimestampFilterDecodeErrorZ represents the result of a fallible operation,
10260 * containing a crate::lightning::ln::msgs::GossipTimestampFilter on success and a crate::lightning::ln::msgs::DecodeError on failure.
10261 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10263 typedef struct LDKCResult_GossipTimestampFilterDecodeErrorZ {
10265 * The contents of this CResult_GossipTimestampFilterDecodeErrorZ, accessible via either
10266 * `err` or `result` depending on the state of `result_ok`.
10268 union LDKCResult_GossipTimestampFilterDecodeErrorZPtr contents;
10270 * Whether this CResult_GossipTimestampFilterDecodeErrorZ represents a success state.
10273 } LDKCResult_GossipTimestampFilterDecodeErrorZ;
10276 * A dynamically-allocated array of crate::lightning::ln::channelmanager::PhantomRouteHintss of arbitrary size.
10277 * This corresponds to std::vector in C++
10279 typedef struct LDKCVec_PhantomRouteHintsZ {
10281 * The elements in the array.
10282 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
10284 struct LDKPhantomRouteHints *data;
10286 * The number of elements pointed to by `data`.
10289 } LDKCVec_PhantomRouteHintsZ;
10292 * When signing using a fallible method either an user-supplied `SignError` or a `CreationError`
10295 typedef enum LDKSignOrCreationError_Tag {
10297 * An error occurred during signing
10299 LDKSignOrCreationError_SignError,
10301 * An error occurred while building the transaction
10303 LDKSignOrCreationError_CreationError,
10305 * Must be last for serialization purposes
10307 LDKSignOrCreationError_Sentinel,
10308 } LDKSignOrCreationError_Tag;
10310 typedef struct MUST_USE_STRUCT LDKSignOrCreationError {
10311 LDKSignOrCreationError_Tag tag;
10314 enum LDKCreationError creation_error;
10317 } LDKSignOrCreationError;
10320 * The contents of CResult_InvoiceSignOrCreationErrorZ
10322 typedef union LDKCResult_InvoiceSignOrCreationErrorZPtr {
10324 * A pointer to the contents in the success state.
10325 * Reading from this pointer when `result_ok` is not set is undefined.
10327 struct LDKInvoice *result;
10329 * A pointer to the contents in the error state.
10330 * Reading from this pointer when `result_ok` is set is undefined.
10332 struct LDKSignOrCreationError *err;
10333 } LDKCResult_InvoiceSignOrCreationErrorZPtr;
10336 * A CResult_InvoiceSignOrCreationErrorZ represents the result of a fallible operation,
10337 * containing a crate::lightning_invoice::Invoice on success and a crate::lightning_invoice::SignOrCreationError on failure.
10338 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10340 typedef struct LDKCResult_InvoiceSignOrCreationErrorZ {
10342 * The contents of this CResult_InvoiceSignOrCreationErrorZ, accessible via either
10343 * `err` or `result` depending on the state of `result_ok`.
10345 union LDKCResult_InvoiceSignOrCreationErrorZPtr contents;
10347 * Whether this CResult_InvoiceSignOrCreationErrorZ represents a success state.
10350 } LDKCResult_InvoiceSignOrCreationErrorZ;
10355 * A transaction output watched by a [`ChannelMonitor`] for spends on-chain.
10357 * Used to convey to a [`Filter`] such an output with a given spending condition. Any transaction
10358 * spending the output must be given to [`ChannelMonitor::block_connected`] either directly or via
10359 * the return value of [`Filter::register_output`].
10361 * If `block_hash` is `Some`, this indicates the output was created in the corresponding block and
10362 * may have been spent there. See [`Filter::register_output`] for details.
10364 * [`ChannelMonitor`]: channelmonitor::ChannelMonitor
10365 * [`ChannelMonitor::block_connected`]: channelmonitor::ChannelMonitor::block_connected
10367 typedef struct MUST_USE_STRUCT LDKWatchedOutput {
10369 * A pointer to the opaque Rust object.
10370 * Nearly everywhere, inner must be non-null, however in places where
10371 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10373 LDKnativeWatchedOutput *inner;
10375 * Indicates that this is the only struct which contains the same pointer.
10376 * Rust functions which take ownership of an object provided via an argument require
10377 * this to be true and invalidate the object pointed to by inner.
10380 } LDKWatchedOutput;
10383 * The `Filter` trait defines behavior for indicating chain activity of interest pertaining to
10386 * This is useful in order to have a [`Watch`] implementation convey to a chain source which
10387 * transactions to be notified of. Notification may take the form of pre-filtering blocks or, in
10388 * the case of [BIP 157]/[BIP 158], only fetching a block if the compact filter matches. If
10389 * receiving full blocks from a chain source, any further filtering is unnecessary.
10391 * After an output has been registered, subsequent block retrievals from the chain source must not
10392 * exclude any transactions matching the new criteria nor any in-block descendants of such
10395 * Note that use as part of a [`Watch`] implementation involves reentrancy. Therefore, the `Filter`
10396 * should not block on I/O. Implementations should instead queue the newly monitored data to be
10397 * processed later. Then, in order to block until the data has been processed, any [`Watch`]
10398 * invocation that has called the `Filter` must return [`TemporaryFailure`].
10400 * [`TemporaryFailure`]: ChannelMonitorUpdateErr::TemporaryFailure
10401 * [BIP 157]: https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki
10402 * [BIP 158]: https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki
10404 typedef struct LDKFilter {
10406 * An opaque pointer which is passed to your function implementations as an argument.
10407 * This has no meaning in the LDK, and can be NULL or any other value.
10411 * Registers interest in a transaction with `txid` and having an output with `script_pubkey` as
10412 * a spending condition.
10414 void (*register_tx)(const void *this_arg, const uint8_t (*txid)[32], struct LDKu8slice script_pubkey);
10416 * Registers interest in spends of a transaction output.
10418 * Optionally, when `output.block_hash` is set, should return any transaction spending the
10419 * output that is found in the corresponding block along with its index.
10421 * This return value is useful for Electrum clients in order to supply in-block descendant
10422 * transactions which otherwise were not included. This is not necessary for other clients if
10423 * such descendant transactions were already included (e.g., when a BIP 157 client provides the
10426 struct LDKCOption_C2Tuple_usizeTransactionZZ (*register_output)(const void *this_arg, struct LDKWatchedOutput output);
10428 * Frees any resources associated with this object given its this_arg pointer.
10429 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
10431 void (*free)(void *this_arg);
10435 * An enum which can either contain a crate::lightning::chain::Filter or not
10437 typedef enum LDKCOption_FilterZ_Tag {
10439 * When we're in this state, this COption_FilterZ contains a crate::lightning::chain::Filter
10441 LDKCOption_FilterZ_Some,
10443 * When we're in this state, this COption_FilterZ contains nothing
10445 LDKCOption_FilterZ_None,
10447 * Must be last for serialization purposes
10449 LDKCOption_FilterZ_Sentinel,
10450 } LDKCOption_FilterZ_Tag;
10452 typedef struct LDKCOption_FilterZ {
10453 LDKCOption_FilterZ_Tag tag;
10456 struct LDKFilter some;
10459 } LDKCOption_FilterZ;
10464 * A read-only reference to a current ChannelMonitor.
10466 * Note that this holds a mutex in [`ChainMonitor`] and may block other events until it is
10469 typedef struct MUST_USE_STRUCT LDKLockedChannelMonitor {
10471 * A pointer to the opaque Rust object.
10472 * Nearly everywhere, inner must be non-null, however in places where
10473 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10475 LDKnativeLockedChannelMonitor *inner;
10477 * Indicates that this is the only struct which contains the same pointer.
10478 * Rust functions which take ownership of an object provided via an argument require
10479 * this to be true and invalidate the object pointed to by inner.
10482 } LDKLockedChannelMonitor;
10485 * The contents of CResult_LockedChannelMonitorNoneZ
10487 typedef union LDKCResult_LockedChannelMonitorNoneZPtr {
10489 * A pointer to the contents in the success state.
10490 * Reading from this pointer when `result_ok` is not set is undefined.
10492 struct LDKLockedChannelMonitor *result;
10494 * Note that this value is always NULL, as there are no contents in the Err variant
10497 } LDKCResult_LockedChannelMonitorNoneZPtr;
10500 * A CResult_LockedChannelMonitorNoneZ represents the result of a fallible operation,
10501 * containing a crate::lightning::chain::chainmonitor::LockedChannelMonitor on success and a () on failure.
10502 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10504 typedef struct LDKCResult_LockedChannelMonitorNoneZ {
10506 * The contents of this CResult_LockedChannelMonitorNoneZ, accessible via either
10507 * `err` or `result` depending on the state of `result_ok`.
10509 union LDKCResult_LockedChannelMonitorNoneZPtr contents;
10511 * Whether this CResult_LockedChannelMonitorNoneZ represents a success state.
10514 } LDKCResult_LockedChannelMonitorNoneZ;
10517 * A dynamically-allocated array of crate::lightning::chain::transaction::OutPoints of arbitrary size.
10518 * This corresponds to std::vector in C++
10520 typedef struct LDKCVec_OutPointZ {
10522 * The elements in the array.
10523 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
10525 struct LDKOutPoint *data;
10527 * The number of elements pointed to by `data`.
10530 } LDKCVec_OutPointZ;
10533 * A trait indicating an object may generate message send events
10535 typedef struct LDKMessageSendEventsProvider {
10537 * An opaque pointer which is passed to your function implementations as an argument.
10538 * This has no meaning in the LDK, and can be NULL or any other value.
10542 * Gets the list of pending events which were generated by previous actions, clearing the list
10545 struct LDKCVec_MessageSendEventZ (*get_and_clear_pending_msg_events)(const void *this_arg);
10547 * Frees any resources associated with this object given its this_arg pointer.
10548 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
10550 void (*free)(void *this_arg);
10551 } LDKMessageSendEventsProvider;
10554 * A trait implemented for objects handling events from [`EventsProvider`].
10556 typedef struct LDKEventHandler {
10558 * An opaque pointer which is passed to your function implementations as an argument.
10559 * This has no meaning in the LDK, and can be NULL or any other value.
10563 * Handles the given [`Event`].
10565 * See [`EventsProvider`] for details that must be considered when implementing this method.
10567 void (*handle_event)(const void *this_arg, const struct LDKEvent *NONNULL_PTR event);
10569 * Frees any resources associated with this object given its this_arg pointer.
10570 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
10572 void (*free)(void *this_arg);
10576 * A trait indicating an object may generate events.
10578 * Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
10582 * See [`process_pending_events`] for requirements around event processing.
10584 * When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
10585 * event since the last invocation. The handler must either act upon the event immediately
10586 * or preserve it for later handling.
10588 * Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
10589 * consult the provider's documentation on the implication of processing events and how a handler
10590 * may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
10591 * [`ChainMonitor::process_pending_events`]).
10593 * (C-not implementable) As there is likely no reason for a user to implement this trait on their
10596 * [`process_pending_events`]: Self::process_pending_events
10597 * [`handle_event`]: EventHandler::handle_event
10598 * [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
10599 * [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
10601 typedef struct LDKEventsProvider {
10603 * An opaque pointer which is passed to your function implementations as an argument.
10604 * This has no meaning in the LDK, and can be NULL or any other value.
10608 * Processes any events generated since the last call using the given event handler.
10610 * Subsequent calls must only process new events. However, handlers must be capable of handling
10611 * duplicate events across process restarts. This may occur if the provider was recovered from
10612 * an old state (i.e., it hadn't been successfully persisted after processing pending events).
10614 void (*process_pending_events)(const void *this_arg, struct LDKEventHandler handler);
10616 * Frees any resources associated with this object given its this_arg pointer.
10617 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
10619 void (*free)(void *this_arg);
10620 } LDKEventsProvider;
10625 * Configuration we set when applicable.
10627 * Default::default() provides sane defaults.
10629 typedef struct MUST_USE_STRUCT LDKChannelHandshakeConfig {
10631 * A pointer to the opaque Rust object.
10632 * Nearly everywhere, inner must be non-null, however in places where
10633 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10635 LDKnativeChannelHandshakeConfig *inner;
10637 * Indicates that this is the only struct which contains the same pointer.
10638 * Rust functions which take ownership of an object provided via an argument require
10639 * this to be true and invalidate the object pointed to by inner.
10642 } LDKChannelHandshakeConfig;
10647 * Optional channel limits which are applied during channel creation.
10649 * These limits are only applied to our counterparty's limits, not our own.
10651 * Use 0/<type>::max_value() as appropriate to skip checking.
10653 * Provides sane defaults for most configurations.
10655 * Most additional limits are disabled except those with which specify a default in individual
10656 * field documentation. Note that this may result in barely-usable channels, but since they
10657 * are applied mostly only to incoming channels that's not much of a problem.
10659 typedef struct MUST_USE_STRUCT LDKChannelHandshakeLimits {
10661 * A pointer to the opaque Rust object.
10662 * Nearly everywhere, inner must be non-null, however in places where
10663 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10665 LDKnativeChannelHandshakeLimits *inner;
10667 * Indicates that this is the only struct which contains the same pointer.
10668 * Rust functions which take ownership of an object provided via an argument require
10669 * this to be true and invalidate the object pointed to by inner.
10672 } LDKChannelHandshakeLimits;
10677 * Top-level config which holds ChannelHandshakeLimits and ChannelConfig.
10679 * Default::default() provides sane defaults for most configurations
10680 * (but currently with 0 relay fees!)
10682 typedef struct MUST_USE_STRUCT LDKUserConfig {
10684 * A pointer to the opaque Rust object.
10685 * Nearly everywhere, inner must be non-null, however in places where
10686 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10688 LDKnativeUserConfig *inner;
10690 * Indicates that this is the only struct which contains the same pointer.
10691 * Rust functions which take ownership of an object provided via an argument require
10692 * this to be true and invalidate the object pointed to by inner.
10700 * The best known block as identified by its hash and height.
10702 typedef struct MUST_USE_STRUCT LDKBestBlock {
10704 * A pointer to the opaque Rust object.
10705 * Nearly everywhere, inner must be non-null, however in places where
10706 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10708 LDKnativeBestBlock *inner;
10710 * Indicates that this is the only struct which contains the same pointer.
10711 * Rust functions which take ownership of an object provided via an argument require
10712 * this to be true and invalidate the object pointed to by inner.
10718 * The `Listen` trait is used to notify when blocks have been connected or disconnected from the
10721 * Useful when needing to replay chain data upon startup or as new chain events occur. Clients
10722 * sourcing chain data using a block-oriented API should prefer this interface over [`Confirm`].
10723 * Such clients fetch the entire header chain whereas clients using [`Confirm`] only fetch headers
10726 typedef struct LDKListen {
10728 * An opaque pointer which is passed to your function implementations as an argument.
10729 * This has no meaning in the LDK, and can be NULL or any other value.
10733 * Notifies the listener that a block was added at the given height.
10735 void (*block_connected)(const void *this_arg, struct LDKu8slice block, uint32_t height);
10737 * Notifies the listener that a block was removed at the given height.
10739 void (*block_disconnected)(const void *this_arg, const uint8_t (*header)[80], uint32_t height);
10741 * Frees any resources associated with this object given its this_arg pointer.
10742 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
10744 void (*free)(void *this_arg);
10748 * The `Confirm` trait is used to notify when transactions have been confirmed on chain or
10749 * unconfirmed during a chain reorganization.
10751 * Clients sourcing chain data using a transaction-oriented API should prefer this interface over
10752 * [`Listen`]. For instance, an Electrum client may implement [`Filter`] by subscribing to activity
10753 * related to registered transactions and outputs. Upon notification, it would pass along the
10754 * matching transactions using this interface.
10758 * The intended use is as follows:
10759 * - Call [`transactions_confirmed`] to process any on-chain activity of interest.
10760 * - Call [`transaction_unconfirmed`] to process any transaction returned by [`get_relevant_txids`]
10761 * that has been reorganized out of the chain.
10762 * - Call [`best_block_updated`] whenever a new chain tip becomes available.
10766 * Clients must call these methods in chain order. Specifically:
10767 * - Transactions confirmed in a block must be given before transactions confirmed in a later
10769 * - Dependent transactions within the same block must be given in topological order, possibly in
10771 * - Unconfirmed transactions must be given after the original confirmations and before any
10774 * See individual method documentation for further details.
10776 * [`transactions_confirmed`]: Self::transactions_confirmed
10777 * [`transaction_unconfirmed`]: Self::transaction_unconfirmed
10778 * [`best_block_updated`]: Self::best_block_updated
10779 * [`get_relevant_txids`]: Self::get_relevant_txids
10781 typedef struct LDKConfirm {
10783 * An opaque pointer which is passed to your function implementations as an argument.
10784 * This has no meaning in the LDK, and can be NULL or any other value.
10788 * Processes transactions confirmed in a block with a given header and height.
10790 * Should be called for any transactions registered by [`Filter::register_tx`] or any
10791 * transactions spending an output registered by [`Filter::register_output`]. Such transactions
10792 * appearing in the same block do not need to be included in the same call; instead, multiple
10793 * calls with additional transactions may be made so long as they are made in [chain order].
10795 * May be called before or after [`best_block_updated`] for the corresponding block. However,
10796 * in the event of a chain reorganization, it must not be called with a `header` that is no
10797 * longer in the chain as of the last call to [`best_block_updated`].
10799 * [chain order]: Confirm#Order
10800 * [`best_block_updated`]: Self::best_block_updated
10802 void (*transactions_confirmed)(const void *this_arg, const uint8_t (*header)[80], struct LDKCVec_C2Tuple_usizeTransactionZZ txdata, uint32_t height);
10804 * Processes a transaction that is no longer confirmed as result of a chain reorganization.
10806 * Should be called for any transaction returned by [`get_relevant_txids`] if it has been
10807 * reorganized out of the best chain. Once called, the given transaction should not be returned
10808 * by [`get_relevant_txids`] unless it has been reconfirmed via [`transactions_confirmed`].
10810 * [`get_relevant_txids`]: Self::get_relevant_txids
10811 * [`transactions_confirmed`]: Self::transactions_confirmed
10813 void (*transaction_unconfirmed)(const void *this_arg, const uint8_t (*txid)[32]);
10815 * Processes an update to the best header connected at the given height.
10817 * Should be called when a new header is available but may be skipped for intermediary blocks
10818 * if they become available at the same time.
10820 void (*best_block_updated)(const void *this_arg, const uint8_t (*header)[80], uint32_t height);
10822 * Returns transactions that should be monitored for reorganization out of the chain.
10824 * Should include any transactions passed to [`transactions_confirmed`] that have insufficient
10825 * confirmations to be safe from a chain reorganization. Should not include any transactions
10826 * passed to [`transaction_unconfirmed`] unless later reconfirmed.
10828 * May be called to determine the subset of transactions that must still be monitored for
10829 * reorganization. Will be idempotent between calls but may change as a result of calls to the
10830 * other interface methods. Thus, this is useful to determine which transactions may need to be
10831 * given to [`transaction_unconfirmed`].
10833 * [`transactions_confirmed`]: Self::transactions_confirmed
10834 * [`transaction_unconfirmed`]: Self::transaction_unconfirmed
10836 struct LDKCVec_TxidZ (*get_relevant_txids)(const void *this_arg);
10838 * Frees any resources associated with this object given its this_arg pointer.
10839 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
10841 void (*free)(void *this_arg);
10847 * An opaque identifier describing a specific [`Persist`] method call.
10849 typedef struct MUST_USE_STRUCT LDKMonitorUpdateId {
10851 * A pointer to the opaque Rust object.
10852 * Nearly everywhere, inner must be non-null, however in places where
10853 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10855 LDKnativeMonitorUpdateId *inner;
10857 * Indicates that this is the only struct which contains the same pointer.
10858 * Rust functions which take ownership of an object provided via an argument require
10859 * this to be true and invalidate the object pointed to by inner.
10862 } LDKMonitorUpdateId;
10865 * `Persist` defines behavior for persisting channel monitors: this could mean
10866 * writing once to disk, and/or uploading to one or more backup services.
10868 * Each method can return three possible values:
10869 * * If persistence (including any relevant `fsync()` calls) happens immediately, the
10870 * implementation should return `Ok(())`, indicating normal channel operation should continue.
10871 * * If persistence happens asynchronously, implementations should first ensure the
10872 * [`ChannelMonitor`] or [`ChannelMonitorUpdate`] are written durably to disk, and then return
10873 * `Err(ChannelMonitorUpdateErr::TemporaryFailure)` while the update continues in the
10874 * background. Once the update completes, [`ChainMonitor::channel_monitor_updated`] should be
10875 * called with the corresponding [`MonitorUpdateId`].
10877 * Note that unlike the direct [`chain::Watch`] interface,
10878 * [`ChainMonitor::channel_monitor_updated`] must be called once for *each* update which occurs.
10880 * * If persistence fails for some reason, implementations should return
10881 * `Err(ChannelMonitorUpdateErr::PermanentFailure)`, in which case the channel will likely be
10882 * closed without broadcasting the latest state. See
10883 * [`ChannelMonitorUpdateErr::PermanentFailure`] for more details.
10885 typedef struct LDKPersist {
10887 * An opaque pointer which is passed to your function implementations as an argument.
10888 * This has no meaning in the LDK, and can be NULL or any other value.
10892 * Persist a new channel's data in response to a [`chain::Watch::watch_channel`] call. This is
10893 * called by [`ChannelManager`] for new channels, or may be called directly, e.g. on startup.
10895 * The data can be stored any way you want, but the identifier provided by LDK is the
10896 * channel's outpoint (and it is up to you to maintain a correct mapping between the outpoint
10897 * and the stored channel data). Note that you **must** persist every new monitor to disk.
10899 * The `update_id` is used to identify this call to [`ChainMonitor::channel_monitor_updated`],
10900 * if you return [`ChannelMonitorUpdateErr::TemporaryFailure`].
10902 * See [`Writeable::write`] on [`ChannelMonitor`] for writing out a `ChannelMonitor`
10903 * and [`ChannelMonitorUpdateErr`] for requirements when returning errors.
10905 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
10906 * [`Writeable::write`]: crate::util::ser::Writeable::write
10908 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*persist_new_channel)(const void *this_arg, struct LDKOutPoint channel_id, const struct LDKChannelMonitor *NONNULL_PTR data, struct LDKMonitorUpdateId update_id);
10910 * Update one channel's data. The provided [`ChannelMonitor`] has already applied the given
10913 * Note that on every update, you **must** persist either the [`ChannelMonitorUpdate`] or the
10914 * updated monitor itself to disk/backups. See the [`Persist`] trait documentation for more
10917 * During blockchain synchronization operations, this may be called with no
10918 * [`ChannelMonitorUpdate`], in which case the full [`ChannelMonitor`] needs to be persisted.
10919 * Note that after the full [`ChannelMonitor`] is persisted any previous
10920 * [`ChannelMonitorUpdate`]s which were persisted should be discarded - they can no longer be
10921 * applied to the persisted [`ChannelMonitor`] as they were already applied.
10923 * If an implementer chooses to persist the updates only, they need to make
10924 * sure that all the updates are applied to the `ChannelMonitors` *before*
10925 * the set of channel monitors is given to the `ChannelManager`
10926 * deserialization routine. See [`ChannelMonitor::update_monitor`] for
10927 * applying a monitor update to a monitor. If full `ChannelMonitors` are
10928 * persisted, then there is no need to persist individual updates.
10930 * Note that there could be a performance tradeoff between persisting complete
10931 * channel monitors on every update vs. persisting only updates and applying
10932 * them in batches. The size of each monitor grows `O(number of state updates)`
10933 * whereas updates are small and `O(1)`.
10935 * The `update_id` is used to identify this call to [`ChainMonitor::channel_monitor_updated`],
10936 * if you return [`ChannelMonitorUpdateErr::TemporaryFailure`].
10938 * See [`Writeable::write`] on [`ChannelMonitor`] for writing out a `ChannelMonitor`,
10939 * [`Writeable::write`] on [`ChannelMonitorUpdate`] for writing out an update, and
10940 * [`ChannelMonitorUpdateErr`] for requirements when returning errors.
10942 * [`Writeable::write`]: crate::util::ser::Writeable::write
10944 * Note that update (or a relevant inner pointer) may be NULL or all-0s to represent None
10946 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*update_persisted_channel)(const void *this_arg, struct LDKOutPoint channel_id, const struct LDKChannelMonitorUpdate *NONNULL_PTR update, const struct LDKChannelMonitor *NONNULL_PTR data, struct LDKMonitorUpdateId update_id);
10948 * Frees any resources associated with this object given its this_arg pointer.
10949 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
10951 void (*free)(void *this_arg);
10957 * An implementation of [`chain::Watch`] for monitoring channels.
10959 * Connected and disconnected blocks must be provided to `ChainMonitor` as documented by
10960 * [`chain::Watch`]. May be used in conjunction with [`ChannelManager`] to monitor channels locally
10961 * or used independently to monitor channels remotely. See the [module-level documentation] for
10964 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
10965 * [module-level documentation]: crate::chain::chainmonitor
10967 typedef struct MUST_USE_STRUCT LDKChainMonitor {
10969 * A pointer to the opaque Rust object.
10970 * Nearly everywhere, inner must be non-null, however in places where
10971 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10973 LDKnativeChainMonitor *inner;
10975 * Indicates that this is the only struct which contains the same pointer.
10976 * Rust functions which take ownership of an object provided via an argument require
10977 * this to be true and invalidate the object pointed to by inner.
10985 * Simple KeysInterface implementor that takes a 32-byte seed for use as a BIP 32 extended key
10986 * and derives keys from that.
10988 * Your node_id is seed/0'
10989 * ChannelMonitor closes may use seed/1'
10990 * Cooperative closes may use seed/2'
10991 * The two close keys may be needed to claim on-chain funds!
10993 * This struct cannot be used for nodes that wish to support receiving phantom payments;
10994 * [`PhantomKeysManager`] must be used instead.
10996 * Note that switching between this struct and [`PhantomKeysManager`] will invalidate any
10997 * previously issued invoices and attempts to pay previous invoices will fail.
10999 typedef struct MUST_USE_STRUCT LDKKeysManager {
11001 * A pointer to the opaque Rust object.
11002 * Nearly everywhere, inner must be non-null, however in places where
11003 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11005 LDKnativeKeysManager *inner;
11007 * Indicates that this is the only struct which contains the same pointer.
11008 * Rust functions which take ownership of an object provided via an argument require
11009 * this to be true and invalidate the object pointed to by inner.
11017 * Similar to [`KeysManager`], but allows the node using this struct to receive phantom node
11020 * A phantom node payment is a payment made to a phantom invoice, which is an invoice that can be
11021 * paid to one of multiple nodes. This works because we encode the invoice route hints such that
11022 * LDK will recognize an incoming payment as destined for a phantom node, and collect the payment
11023 * itself without ever needing to forward to this fake node.
11025 * Phantom node payments are useful for load balancing between multiple LDK nodes. They also
11026 * provide some fault tolerance, because payers will automatically retry paying other provided
11027 * nodes in the case that one node goes down.
11029 * Note that multi-path payments are not supported in phantom invoices for security reasons.
11030 * Switching between this struct and [`KeysManager`] will invalidate any previously issued
11031 * invoices and attempts to pay previous invoices will fail.
11033 typedef struct MUST_USE_STRUCT LDKPhantomKeysManager {
11035 * A pointer to the opaque Rust object.
11036 * Nearly everywhere, inner must be non-null, however in places where
11037 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11039 LDKnativePhantomKeysManager *inner;
11041 * Indicates that this is the only struct which contains the same pointer.
11042 * Rust functions which take ownership of an object provided via an argument require
11043 * this to be true and invalidate the object pointed to by inner.
11046 } LDKPhantomKeysManager;
11051 * Chain-related parameters used to construct a new `ChannelManager`.
11053 * Typically, the block-specific parameters are derived from the best block hash for the network,
11054 * as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
11055 * are not needed when deserializing a previously constructed `ChannelManager`.
11057 typedef struct MUST_USE_STRUCT LDKChainParameters {
11059 * A pointer to the opaque Rust object.
11060 * Nearly everywhere, inner must be non-null, however in places where
11061 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11063 LDKnativeChainParameters *inner;
11065 * Indicates that this is the only struct which contains the same pointer.
11066 * Rust functions which take ownership of an object provided via an argument require
11067 * this to be true and invalidate the object pointed to by inner.
11070 } LDKChainParameters;
11073 * A 3-byte byte array.
11075 typedef struct LDKThreeBytes {
11083 * A trait to describe an object which can receive channel messages.
11085 * Messages MAY be called in parallel when they originate from different their_node_ids, however
11086 * they MUST NOT be called in parallel when the two calls have the same their_node_id.
11088 typedef struct LDKChannelMessageHandler {
11090 * An opaque pointer which is passed to your function implementations as an argument.
11091 * This has no meaning in the LDK, and can be NULL or any other value.
11095 * Handle an incoming open_channel message from the given peer.
11097 void (*handle_open_channel)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKInitFeatures their_features, const struct LDKOpenChannel *NONNULL_PTR msg);
11099 * Handle an incoming accept_channel message from the given peer.
11101 void (*handle_accept_channel)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKInitFeatures their_features, const struct LDKAcceptChannel *NONNULL_PTR msg);
11103 * Handle an incoming funding_created message from the given peer.
11105 void (*handle_funding_created)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingCreated *NONNULL_PTR msg);
11107 * Handle an incoming funding_signed message from the given peer.
11109 void (*handle_funding_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingSigned *NONNULL_PTR msg);
11111 * Handle an incoming funding_locked message from the given peer.
11113 void (*handle_funding_locked)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingLocked *NONNULL_PTR msg);
11115 * Handle an incoming shutdown message from the given peer.
11117 void (*handle_shutdown)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKInitFeatures *NONNULL_PTR their_features, const struct LDKShutdown *NONNULL_PTR msg);
11119 * Handle an incoming closing_signed message from the given peer.
11121 void (*handle_closing_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKClosingSigned *NONNULL_PTR msg);
11123 * Handle an incoming update_add_htlc message from the given peer.
11125 void (*handle_update_add_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateAddHTLC *NONNULL_PTR msg);
11127 * Handle an incoming update_fulfill_htlc message from the given peer.
11129 void (*handle_update_fulfill_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFulfillHTLC *NONNULL_PTR msg);
11131 * Handle an incoming update_fail_htlc message from the given peer.
11133 void (*handle_update_fail_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFailHTLC *NONNULL_PTR msg);
11135 * Handle an incoming update_fail_malformed_htlc message from the given peer.
11137 void (*handle_update_fail_malformed_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR msg);
11139 * Handle an incoming commitment_signed message from the given peer.
11141 void (*handle_commitment_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKCommitmentSigned *NONNULL_PTR msg);
11143 * Handle an incoming revoke_and_ack message from the given peer.
11145 void (*handle_revoke_and_ack)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKRevokeAndACK *NONNULL_PTR msg);
11147 * Handle an incoming update_fee message from the given peer.
11149 void (*handle_update_fee)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFee *NONNULL_PTR msg);
11151 * Handle an incoming announcement_signatures message from the given peer.
11153 void (*handle_announcement_signatures)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKAnnouncementSignatures *NONNULL_PTR msg);
11155 * Indicates a connection to the peer failed/an existing connection was lost. If no connection
11156 * is believed to be possible in the future (eg they're sending us messages we don't
11157 * understand or indicate they require unknown feature bits), no_connection_possible is set
11158 * and any outstanding channels should be failed.
11160 void (*peer_disconnected)(const void *this_arg, struct LDKPublicKey their_node_id, bool no_connection_possible);
11162 * Handle a peer reconnecting, possibly generating channel_reestablish message(s).
11164 void (*peer_connected)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKInit *NONNULL_PTR msg);
11166 * Handle an incoming channel_reestablish message from the given peer.
11168 void (*handle_channel_reestablish)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKChannelReestablish *NONNULL_PTR msg);
11170 * Handle an incoming channel update from the given peer.
11172 void (*handle_channel_update)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKChannelUpdate *NONNULL_PTR msg);
11174 * Handle an incoming error message from the given peer.
11176 void (*handle_error)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKErrorMessage *NONNULL_PTR msg);
11178 * Implementation of MessageSendEventsProvider for this object.
11180 struct LDKMessageSendEventsProvider MessageSendEventsProvider;
11182 * Frees any resources associated with this object given its this_arg pointer.
11183 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
11185 void (*free)(void *this_arg);
11186 } LDKChannelMessageHandler;
11191 * Arguments for the creation of a ChannelManager that are not deserialized.
11193 * At a high-level, the process for deserializing a ChannelManager and resuming normal operation
11195 * 1) Deserialize all stored [`ChannelMonitor`]s.
11196 * 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
11197 * `<(BlockHash, ChannelManager)>::read(reader, args)`
11198 * This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
11199 * [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
11200 * 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
11201 * same way you would handle a [`chain::Filter`] call using
11202 * [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
11203 * 4) Reconnect blocks on your [`ChannelMonitor`]s.
11204 * 5) Disconnect/connect blocks on the [`ChannelManager`].
11205 * 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
11206 * Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
11207 * will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
11209 * 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
11210 * [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
11212 * Note that the ordering of #4-7 is not of importance, however all four must occur before you
11213 * call any other methods on the newly-deserialized [`ChannelManager`].
11215 * Note that because some channels may be closed during deserialization, it is critical that you
11216 * always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
11217 * you. If you deserialize an old ChannelManager (during which force-closure transactions may be
11218 * broadcast), and then later deserialize a newer version of the same ChannelManager (which will
11219 * not force-close the same channels but consider them live), you may end up revoking a state for
11220 * which you've already broadcasted the transaction.
11222 * [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
11224 typedef struct MUST_USE_STRUCT LDKChannelManagerReadArgs {
11226 * A pointer to the opaque Rust object.
11227 * Nearly everywhere, inner must be non-null, however in places where
11228 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11230 LDKnativeChannelManagerReadArgs *inner;
11232 * Indicates that this is the only struct which contains the same pointer.
11233 * Rust functions which take ownership of an object provided via an argument require
11234 * this to be true and invalidate the object pointed to by inner.
11237 } LDKChannelManagerReadArgs;
11242 * Proof that the sender knows the per-commitment secret of the previous commitment transaction.
11243 * This is used to convince the recipient that the channel is at a certain commitment
11244 * number even if they lost that data due to a local failure. Of course, the peer may lie
11245 * and even later commitments may have been revoked.
11247 typedef struct MUST_USE_STRUCT LDKDataLossProtect {
11249 * A pointer to the opaque Rust object.
11250 * Nearly everywhere, inner must be non-null, however in places where
11251 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11253 LDKnativeDataLossProtect *inner;
11255 * Indicates that this is the only struct which contains the same pointer.
11256 * Rust functions which take ownership of an object provided via an argument require
11257 * this to be true and invalidate the object pointed to by inner.
11260 } LDKDataLossProtect;
11263 * A trait to describe an object which can receive routing messages.
11265 * # Implementor DoS Warnings
11267 * For `gossip_queries` messages there are potential DoS vectors when handling
11268 * inbound queries. Implementors using an on-disk network graph should be aware of
11269 * repeated disk I/O for queries accessing different parts of the network graph.
11271 typedef struct LDKRoutingMessageHandler {
11273 * An opaque pointer which is passed to your function implementations as an argument.
11274 * This has no meaning in the LDK, and can be NULL or any other value.
11278 * Handle an incoming node_announcement message, returning true if it should be forwarded on,
11279 * false or returning an Err otherwise.
11281 struct LDKCResult_boolLightningErrorZ (*handle_node_announcement)(const void *this_arg, const struct LDKNodeAnnouncement *NONNULL_PTR msg);
11283 * Handle a channel_announcement message, returning true if it should be forwarded on, false
11284 * or returning an Err otherwise.
11286 struct LDKCResult_boolLightningErrorZ (*handle_channel_announcement)(const void *this_arg, const struct LDKChannelAnnouncement *NONNULL_PTR msg);
11288 * Handle an incoming channel_update message, returning true if it should be forwarded on,
11289 * false or returning an Err otherwise.
11291 struct LDKCResult_boolLightningErrorZ (*handle_channel_update)(const void *this_arg, const struct LDKChannelUpdate *NONNULL_PTR msg);
11293 * Gets a subset of the channel announcements and updates required to dump our routing table
11294 * to a remote node, starting at the short_channel_id indicated by starting_point and
11295 * including the batch_amount entries immediately higher in numerical value than starting_point.
11297 struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ (*get_next_channel_announcements)(const void *this_arg, uint64_t starting_point, uint8_t batch_amount);
11299 * Gets a subset of the node announcements required to dump our routing table to a remote node,
11300 * starting at the node *after* the provided publickey and including batch_amount entries
11301 * immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
11302 * If None is provided for starting_point, we start at the first node.
11304 * Note that starting_point (or a relevant inner pointer) may be NULL or all-0s to represent None
11306 struct LDKCVec_NodeAnnouncementZ (*get_next_node_announcements)(const void *this_arg, struct LDKPublicKey starting_point, uint8_t batch_amount);
11308 * Called when a connection is established with a peer. This can be used to
11309 * perform routing table synchronization using a strategy defined by the
11312 void (*sync_routing_table)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKInit *NONNULL_PTR init);
11314 * Handles the reply of a query we initiated to learn about channels
11315 * for a given range of blocks. We can expect to receive one or more
11316 * replies to a single query.
11318 struct LDKCResult_NoneLightningErrorZ (*handle_reply_channel_range)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKReplyChannelRange msg);
11320 * Handles the reply of a query we initiated asking for routing gossip
11321 * messages for a list of channels. We should receive this message when
11322 * a node has completed its best effort to send us the pertaining routing
11325 struct LDKCResult_NoneLightningErrorZ (*handle_reply_short_channel_ids_end)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKReplyShortChannelIdsEnd msg);
11327 * Handles when a peer asks us to send a list of short_channel_ids
11328 * for the requested range of blocks.
11330 struct LDKCResult_NoneLightningErrorZ (*handle_query_channel_range)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKQueryChannelRange msg);
11332 * Handles when a peer asks us to send routing gossip messages for a
11333 * list of short_channel_ids.
11335 struct LDKCResult_NoneLightningErrorZ (*handle_query_short_channel_ids)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKQueryShortChannelIds msg);
11337 * Implementation of MessageSendEventsProvider for this object.
11339 struct LDKMessageSendEventsProvider MessageSendEventsProvider;
11341 * Frees any resources associated with this object given its this_arg pointer.
11342 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
11344 void (*free)(void *this_arg);
11345 } LDKRoutingMessageHandler;
11348 * Trait to be implemented by custom message (unrelated to the channel/gossip LN layers)
11351 typedef struct LDKCustomMessageReader {
11353 * An opaque pointer which is passed to your function implementations as an argument.
11354 * This has no meaning in the LDK, and can be NULL or any other value.
11358 * Decodes a custom message to `CustomMessageType`. If the given message type is known to the
11359 * implementation and the message could be decoded, must return `Ok(Some(message))`. If the
11360 * message type is unknown to the implementation, must return `Ok(None)`. If a decoding error
11361 * occur, must return `Err(DecodeError::X)` where `X` details the encountered error.
11363 struct LDKCResult_COption_TypeZDecodeErrorZ (*read)(const void *this_arg, uint16_t message_type, struct LDKu8slice buffer);
11365 * Frees any resources associated with this object given its this_arg pointer.
11366 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
11368 void (*free)(void *this_arg);
11369 } LDKCustomMessageReader;
11372 * Handler for BOLT1-compliant messages.
11374 typedef struct LDKCustomMessageHandler {
11376 * An opaque pointer which is passed to your function implementations as an argument.
11377 * This has no meaning in the LDK, and can be NULL or any other value.
11381 * Called with the message type that was received and the buffer to be read.
11382 * Can return a `MessageHandlingError` if the message could not be handled.
11384 struct LDKCResult_NoneLightningErrorZ (*handle_custom_message)(const void *this_arg, struct LDKType msg, struct LDKPublicKey sender_node_id);
11386 * Gets the list of pending messages which were generated by the custom message
11387 * handler, clearing the list in the process. The first tuple element must
11388 * correspond to the intended recipients node ids. If no connection to one of the
11389 * specified node does not exist, the message is simply not sent to it.
11391 struct LDKCVec_C2Tuple_PublicKeyTypeZZ (*get_and_clear_pending_msg)(const void *this_arg);
11393 * Implementation of CustomMessageReader for this object.
11395 struct LDKCustomMessageReader CustomMessageReader;
11397 * Frees any resources associated with this object given its this_arg pointer.
11398 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
11400 void (*free)(void *this_arg);
11401 } LDKCustomMessageHandler;
11406 * A dummy struct which implements `RoutingMessageHandler` without storing any routing information
11407 * or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
11409 typedef struct MUST_USE_STRUCT LDKIgnoringMessageHandler {
11411 * A pointer to the opaque Rust object.
11412 * Nearly everywhere, inner must be non-null, however in places where
11413 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11415 LDKnativeIgnoringMessageHandler *inner;
11417 * Indicates that this is the only struct which contains the same pointer.
11418 * Rust functions which take ownership of an object provided via an argument require
11419 * this to be true and invalidate the object pointed to by inner.
11422 } LDKIgnoringMessageHandler;
11427 * A dummy struct which implements `ChannelMessageHandler` without having any channels.
11428 * You can provide one of these as the route_handler in a MessageHandler.
11430 typedef struct MUST_USE_STRUCT LDKErroringMessageHandler {
11432 * A pointer to the opaque Rust object.
11433 * Nearly everywhere, inner must be non-null, however in places where
11434 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11436 LDKnativeErroringMessageHandler *inner;
11438 * Indicates that this is the only struct which contains the same pointer.
11439 * Rust functions which take ownership of an object provided via an argument require
11440 * this to be true and invalidate the object pointed to by inner.
11443 } LDKErroringMessageHandler;
11448 * Provides references to trait impls which handle different types of messages.
11450 typedef struct MUST_USE_STRUCT LDKMessageHandler {
11452 * A pointer to the opaque Rust object.
11453 * Nearly everywhere, inner must be non-null, however in places where
11454 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11456 LDKnativeMessageHandler *inner;
11458 * Indicates that this is the only struct which contains the same pointer.
11459 * Rust functions which take ownership of an object provided via an argument require
11460 * this to be true and invalidate the object pointed to by inner.
11463 } LDKMessageHandler;
11466 * Provides an object which can be used to send data to and which uniquely identifies a connection
11467 * to a remote host. You will need to be able to generate multiple of these which meet Eq and
11468 * implement Hash to meet the PeerManager API.
11470 * For efficiency, Clone should be relatively cheap for this type.
11472 * Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
11473 * has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
11474 * having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
11475 * further calls to the [`PeerManager`] related to the original socket occur. This allows you to
11476 * use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
11477 * to simply use another value which is guaranteed to be globally unique instead.
11479 typedef struct LDKSocketDescriptor {
11481 * An opaque pointer which is passed to your function implementations as an argument.
11482 * This has no meaning in the LDK, and can be NULL or any other value.
11486 * Attempts to send some data from the given slice to the peer.
11488 * Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
11489 * Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
11490 * called and further write attempts may occur until that time.
11492 * If the returned size is smaller than `data.len()`, a
11493 * [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
11494 * written. Additionally, until a `send_data` event completes fully, no further
11495 * [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
11496 * prevent denial-of-service issues, you should not read or buffer any data from the socket
11499 * If a [`PeerManager::read_event`] call on this descriptor had previously returned true
11500 * (indicating that read events should be paused to prevent DoS in the send buffer),
11501 * `resume_read` may be set indicating that read events on this descriptor should resume. A
11502 * `resume_read` of false carries no meaning, and should not cause any action.
11504 uintptr_t (*send_data)(void *this_arg, struct LDKu8slice data, bool resume_read);
11506 * Disconnect the socket pointed to by this SocketDescriptor.
11508 * You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
11509 * call (doing so is a noop).
11511 void (*disconnect_socket)(void *this_arg);
11513 * Checks if two objects are equal given this object's this_arg pointer and another object.
11515 bool (*eq)(const void *this_arg, const struct LDKSocketDescriptor *NONNULL_PTR other_arg);
11517 * Calculate a succinct non-cryptographic hash for an object given its this_arg pointer.
11518 * This is used, for example, for inclusion of this object in a hash map.
11520 uint64_t (*hash)(const void *this_arg);
11522 * Called, if set, after this SocketDescriptor has been cloned into a duplicate object.
11523 * The new SocketDescriptor is provided, and should be mutated as needed to perform a
11524 * deep copy of the object pointed to by this_arg or avoid any double-freeing.
11526 void (*cloned)(struct LDKSocketDescriptor *NONNULL_PTR new_SocketDescriptor);
11528 * Frees any resources associated with this object given its this_arg pointer.
11529 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
11531 void (*free)(void *this_arg);
11532 } LDKSocketDescriptor;
11537 * A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
11538 * socket events into messages which it passes on to its [`MessageHandler`].
11540 * Locks are taken internally, so you must never assume that reentrancy from a
11541 * [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
11543 * Calls to [`read_event`] will decode relevant messages and pass them to the
11544 * [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
11545 * parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
11546 * [`PeerManager`] functions related to the same connection must occur only in serial, making new
11547 * calls only after previous ones have returned.
11549 * Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
11550 * a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
11551 * essentially you should default to using a SimpleRefPeerManager, and use a
11552 * SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
11553 * you're using lightning-net-tokio.
11555 * [`read_event`]: PeerManager::read_event
11557 typedef struct MUST_USE_STRUCT LDKPeerManager {
11559 * A pointer to the opaque Rust object.
11560 * Nearly everywhere, inner must be non-null, however in places where
11561 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11563 LDKnativePeerManager *inner;
11565 * Indicates that this is the only struct which contains the same pointer.
11566 * Rust functions which take ownership of an object provided via an argument require
11567 * this to be true and invalidate the object pointed to by inner.
11575 * Static channel fields used to build transactions given per-commitment fields, organized by
11576 * broadcaster/countersignatory.
11578 * This is derived from the holder/counterparty-organized ChannelTransactionParameters via the
11579 * as_holder_broadcastable and as_counterparty_broadcastable functions.
11581 typedef struct MUST_USE_STRUCT LDKDirectedChannelTransactionParameters {
11583 * A pointer to the opaque Rust object.
11584 * Nearly everywhere, inner must be non-null, however in places where
11585 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11587 LDKnativeDirectedChannelTransactionParameters *inner;
11589 * Indicates that this is the only struct which contains the same pointer.
11590 * Rust functions which take ownership of an object provided via an argument require
11591 * this to be true and invalidate the object pointed to by inner.
11594 } LDKDirectedChannelTransactionParameters;
11599 * A read-only view of [`NetworkGraph`].
11601 typedef struct MUST_USE_STRUCT LDKReadOnlyNetworkGraph {
11603 * A pointer to the opaque Rust object.
11604 * Nearly everywhere, inner must be non-null, however in places where
11605 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11607 LDKnativeReadOnlyNetworkGraph *inner;
11609 * Indicates that this is the only struct which contains the same pointer.
11610 * Rust functions which take ownership of an object provided via an argument require
11611 * this to be true and invalidate the object pointed to by inner.
11614 } LDKReadOnlyNetworkGraph;
11619 * Receives and validates network updates from peers,
11620 * stores authentic and relevant data as a network graph.
11621 * This network graph is then used for routing payments.
11622 * Provides interface to help with initial routing sync by
11623 * serving historical announcements.
11625 * Serves as an [`EventHandler`] for applying updates from [`Event::PaymentPathFailed`] to the
11626 * [`NetworkGraph`].
11628 typedef struct MUST_USE_STRUCT LDKNetGraphMsgHandler {
11630 * A pointer to the opaque Rust object.
11631 * Nearly everywhere, inner must be non-null, however in places where
11632 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11634 LDKnativeNetGraphMsgHandler *inner;
11636 * Indicates that this is the only struct which contains the same pointer.
11637 * Rust functions which take ownership of an object provided via an argument require
11638 * this to be true and invalidate the object pointed to by inner.
11641 } LDKNetGraphMsgHandler;
11646 * A wrapper around [`ChannelInfo`] representing information about the channel as directed from a
11647 * source node to a target node.
11649 typedef struct MUST_USE_STRUCT LDKDirectedChannelInfo {
11651 * A pointer to the opaque Rust object.
11652 * Nearly everywhere, inner must be non-null, however in places where
11653 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11655 LDKnativeDirectedChannelInfo *inner;
11657 * Indicates that this is the only struct which contains the same pointer.
11658 * Rust functions which take ownership of an object provided via an argument require
11659 * this to be true and invalidate the object pointed to by inner.
11662 } LDKDirectedChannelInfo;
11665 * The effective capacity of a channel for routing purposes.
11667 * While this may be smaller than the actual channel capacity, amounts greater than
11668 * [`Self::as_msat`] should not be routed through the channel.
11670 typedef enum LDKEffectiveCapacity_Tag {
11672 * The available liquidity in the channel known from being a channel counterparty, and thus a
11675 LDKEffectiveCapacity_ExactLiquidity,
11677 * The maximum HTLC amount in one direction as advertised on the gossip network.
11679 LDKEffectiveCapacity_MaximumHTLC,
11681 * The total capacity of the channel as determined by the funding transaction.
11683 LDKEffectiveCapacity_Total,
11685 * A capacity sufficient to route any payment, typically used for private channels provided by
11688 LDKEffectiveCapacity_Infinite,
11690 * A capacity that is unknown possibly because either the chain state is unavailable to know
11691 * the total capacity or the `htlc_maximum_msat` was not advertised on the gossip network.
11693 LDKEffectiveCapacity_Unknown,
11695 * Must be last for serialization purposes
11697 LDKEffectiveCapacity_Sentinel,
11698 } LDKEffectiveCapacity_Tag;
11700 typedef struct LDKEffectiveCapacity_LDKExactLiquidity_Body {
11702 * Either the inbound or outbound liquidity depending on the direction, denominated in
11705 uint64_t liquidity_msat;
11706 } LDKEffectiveCapacity_LDKExactLiquidity_Body;
11708 typedef struct LDKEffectiveCapacity_LDKMaximumHTLC_Body {
11710 * The maximum HTLC amount denominated in millisatoshi.
11712 uint64_t amount_msat;
11713 } LDKEffectiveCapacity_LDKMaximumHTLC_Body;
11715 typedef struct LDKEffectiveCapacity_LDKTotal_Body {
11717 * The funding amount denominated in millisatoshi.
11719 uint64_t capacity_msat;
11720 } LDKEffectiveCapacity_LDKTotal_Body;
11722 typedef struct MUST_USE_STRUCT LDKEffectiveCapacity {
11723 LDKEffectiveCapacity_Tag tag;
11725 LDKEffectiveCapacity_LDKExactLiquidity_Body exact_liquidity;
11726 LDKEffectiveCapacity_LDKMaximumHTLC_Body maximum_htlc;
11727 LDKEffectiveCapacity_LDKTotal_Body total;
11729 } LDKEffectiveCapacity;
11732 * An interface used to score payment channels for path finding.
11734 *\tScoring is in terms of fees willing to be paid in order to avoid routing through a channel.
11736 typedef struct LDKScore {
11738 * An opaque pointer which is passed to your function implementations as an argument.
11739 * This has no meaning in the LDK, and can be NULL or any other value.
11743 * Returns the fee in msats willing to be paid to avoid routing `send_amt_msat` through the
11744 * given channel in the direction from `source` to `target`.
11746 * The channel's capacity (less any other MPP parts that are also being considered for use in
11747 * the same payment) is given by `capacity_msat`. It may be determined from various sources
11748 * such as a chain data, network gossip, or invoice hints. For invoice hints, a capacity near
11749 * [`u64::max_value`] is given to indicate sufficient capacity for the invoice's full amount.
11750 * Thus, implementations should be overflow-safe.
11752 uint64_t (*channel_penalty_msat)(const void *this_arg, uint64_t short_channel_id, uint64_t send_amt_msat, uint64_t capacity_msat, const struct LDKNodeId *NONNULL_PTR source, const struct LDKNodeId *NONNULL_PTR target);
11754 * Handles updating channel penalties after failing to route through a channel.
11756 void (*payment_path_failed)(void *this_arg, struct LDKCVec_RouteHopZ path, uint64_t short_channel_id);
11758 * Handles updating channel penalties after successfully routing along a path.
11760 void (*payment_path_successful)(void *this_arg, struct LDKCVec_RouteHopZ path);
11762 * Serialize the object into a byte array
11764 struct LDKCVec_u8Z (*write)(const void *this_arg);
11766 * Frees any resources associated with this object given its this_arg pointer.
11767 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
11769 void (*free)(void *this_arg);
11773 * A scorer that is accessed under a lock.
11775 * Needed so that calls to [`Score::channel_penalty_msat`] in [`find_route`] can be made while
11776 * having shared ownership of a scorer but without requiring internal locking in [`Score`]
11777 * implementations. Internal locking would be detrimental to route finding performance and could
11778 * result in [`Score::channel_penalty_msat`] returning a different value for the same channel.
11780 * [`find_route`]: crate::routing::router::find_route
11782 typedef struct LDKLockableScore {
11784 * An opaque pointer which is passed to your function implementations as an argument.
11785 * This has no meaning in the LDK, and can be NULL or any other value.
11789 * Returns the locked scorer.
11791 struct LDKScore (*lock)(const void *this_arg);
11793 * Frees any resources associated with this object given its this_arg pointer.
11794 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
11796 void (*free)(void *this_arg);
11797 } LDKLockableScore;
11802 * A concrete implementation of [`LockableScore`] which supports multi-threading.
11804 typedef struct MUST_USE_STRUCT LDKMultiThreadedLockableScore {
11806 * A pointer to the opaque Rust object.
11807 * Nearly everywhere, inner must be non-null, however in places where
11808 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11810 LDKnativeMultiThreadedLockableScore *inner;
11812 * Indicates that this is the only struct which contains the same pointer.
11813 * Rust functions which take ownership of an object provided via an argument require
11814 * this to be true and invalidate the object pointed to by inner.
11817 } LDKMultiThreadedLockableScore;
11822 * FilesystemPersister persists channel data on disk, where each channel's
11823 * data is stored in a file named after its funding outpoint.
11825 * Warning: this module does the best it can with calls to persist data, but it
11826 * can only guarantee that the data is passed to the drive. It is up to the
11827 * drive manufacturers to do the actual persistence properly, which they often
11828 * don't (especially on consumer-grade hardware). Therefore, it is up to the
11829 * user to validate their entire storage stack, to ensure the writes are
11831 * Corollary: especially when dealing with larger amounts of money, it is best
11832 * practice to have multiple channel data backups and not rely only on one
11833 * FilesystemPersister.
11835 typedef struct MUST_USE_STRUCT LDKFilesystemPersister {
11837 * A pointer to the opaque Rust object.
11838 * Nearly everywhere, inner must be non-null, however in places where
11839 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11841 LDKnativeFilesystemPersister *inner;
11843 * Indicates that this is the only struct which contains the same pointer.
11844 * Rust functions which take ownership of an object provided via an argument require
11845 * this to be true and invalidate the object pointed to by inner.
11848 } LDKFilesystemPersister;
11853 * `BackgroundProcessor` takes care of tasks that (1) need to happen periodically to keep
11854 * Rust-Lightning running properly, and (2) either can or should be run in the background. Its
11855 * responsibilities are:
11856 * * Processing [`Event`]s with a user-provided [`EventHandler`].
11857 * * Monitoring whether the [`ChannelManager`] needs to be re-persisted to disk, and if so,
11858 * writing it to disk/backups by invoking the callback given to it at startup.
11859 * [`ChannelManager`] persistence should be done in the background.
11860 * * Calling [`ChannelManager::timer_tick_occurred`] and [`PeerManager::timer_tick_occurred`]
11861 * at the appropriate intervals.
11862 * * Calling [`NetworkGraph::remove_stale_channels`] (if a [`NetGraphMsgHandler`] is provided to
11863 * [`BackgroundProcessor::start`]).
11865 * It will also call [`PeerManager::process_events`] periodically though this shouldn't be relied
11866 * upon as doing so may result in high latency.
11870 * If [`ChannelManager`] persistence fails and the persisted manager becomes out-of-date, then
11871 * there is a risk of channels force-closing on startup when the manager realizes it's outdated.
11872 * However, as long as [`ChannelMonitor`] backups are sound, no funds besides those used for
11873 * unilateral chain closure fees are at risk.
11875 * [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
11876 * [`Event`]: lightning::util::events::Event
11877 *BackgroundProcessor will immediately stop on drop. It should be stored until shutdown.
11879 typedef struct MUST_USE_STRUCT LDKBackgroundProcessor {
11881 * A pointer to the opaque Rust object.
11882 * Nearly everywhere, inner must be non-null, however in places where
11883 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11885 LDKnativeBackgroundProcessor *inner;
11887 * Indicates that this is the only struct which contains the same pointer.
11888 * Rust functions which take ownership of an object provided via an argument require
11889 * this to be true and invalidate the object pointed to by inner.
11892 } LDKBackgroundProcessor;
11895 * Trait which handles persisting a [`ChannelManager`] to disk.
11897 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
11899 typedef struct LDKChannelManagerPersister {
11901 * An opaque pointer which is passed to your function implementations as an argument.
11902 * This has no meaning in the LDK, and can be NULL or any other value.
11906 * Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
11907 * (which will cause the [`BackgroundProcessor`] which called this method to exit.
11909 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
11911 struct LDKCResult_NoneErrorZ (*persist_manager)(const void *this_arg, const struct LDKChannelManager *NONNULL_PTR channel_manager);
11913 * Frees any resources associated with this object given its this_arg pointer.
11914 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
11916 void (*free)(void *this_arg);
11917 } LDKChannelManagerPersister;
11922 * Data of the `RawInvoice` that is encoded in the data part
11924 typedef struct MUST_USE_STRUCT LDKRawDataPart {
11926 * A pointer to the opaque Rust object.
11927 * Nearly everywhere, inner must be non-null, however in places where
11928 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11930 LDKnativeRawDataPart *inner;
11932 * Indicates that this is the only struct which contains the same pointer.
11933 * Rust functions which take ownership of an object provided via an argument require
11934 * this to be true and invalidate the object pointed to by inner.
11944 typedef struct MUST_USE_STRUCT LDKSha256 {
11946 * A pointer to the opaque Rust object.
11947 * Nearly everywhere, inner must be non-null, however in places where
11948 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11950 LDKnativeSha256 *inner;
11952 * Indicates that this is the only struct which contains the same pointer.
11953 * Rust functions which take ownership of an object provided via an argument require
11954 * this to be true and invalidate the object pointed to by inner.
11962 * Positive duration that defines when (relatively to the timestamp) in the future the invoice
11965 typedef struct MUST_USE_STRUCT LDKExpiryTime {
11967 * A pointer to the opaque Rust object.
11968 * Nearly everywhere, inner must be non-null, however in places where
11969 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11971 LDKnativeExpiryTime *inner;
11973 * Indicates that this is the only struct which contains the same pointer.
11974 * Rust functions which take ownership of an object provided via an argument require
11975 * this to be true and invalidate the object pointed to by inner.
11983 * `min_final_cltv_expiry` to use for the last HTLC in the route
11985 typedef struct MUST_USE_STRUCT LDKMinFinalCltvExpiry {
11987 * A pointer to the opaque Rust object.
11988 * Nearly everywhere, inner must be non-null, however in places where
11989 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11991 LDKnativeMinFinalCltvExpiry *inner;
11993 * Indicates that this is the only struct which contains the same pointer.
11994 * Rust functions which take ownership of an object provided via an argument require
11995 * this to be true and invalidate the object pointed to by inner.
11998 } LDKMinFinalCltvExpiry;
12001 * A 20-byte byte array.
12003 typedef struct LDKTwentyBytes {
12011 * Fallback address in case no LN payment is possible
12013 typedef enum LDKFallback_Tag {
12014 LDKFallback_SegWitProgram,
12015 LDKFallback_PubKeyHash,
12016 LDKFallback_ScriptHash,
12018 * Must be last for serialization purposes
12020 LDKFallback_Sentinel,
12023 typedef struct LDKFallback_LDKSegWitProgram_Body {
12024 struct LDKu5 version;
12025 struct LDKCVec_u8Z program;
12026 } LDKFallback_LDKSegWitProgram_Body;
12028 typedef struct MUST_USE_STRUCT LDKFallback {
12029 LDKFallback_Tag tag;
12031 LDKFallback_LDKSegWitProgram_Body seg_wit_program;
12033 struct LDKTwentyBytes pub_key_hash;
12036 struct LDKTwentyBytes script_hash;
12042 * A trait defining behavior of an [`Invoice`] payer.
12044 typedef struct LDKPayer {
12046 * An opaque pointer which is passed to your function implementations as an argument.
12047 * This has no meaning in the LDK, and can be NULL or any other value.
12051 * Returns the payer's node id.
12053 struct LDKPublicKey (*node_id)(const void *this_arg);
12055 * Returns the payer's channels.
12057 struct LDKCVec_ChannelDetailsZ (*first_hops)(const void *this_arg);
12059 * Sends a payment over the Lightning Network using the given [`Route`].
12061 * Note that payment_secret (or a relevant inner pointer) may be NULL or all-0s to represent None
12063 struct LDKCResult_PaymentIdPaymentSendFailureZ (*send_payment)(const void *this_arg, const struct LDKRoute *NONNULL_PTR route, struct LDKThirtyTwoBytes payment_hash, struct LDKThirtyTwoBytes payment_secret);
12065 * Sends a spontaneous payment over the Lightning Network using the given [`Route`].
12067 struct LDKCResult_PaymentIdPaymentSendFailureZ (*send_spontaneous_payment)(const void *this_arg, const struct LDKRoute *NONNULL_PTR route, struct LDKThirtyTwoBytes payment_preimage);
12069 * Retries a failed payment path for the [`PaymentId`] using the given [`Route`].
12071 struct LDKCResult_NonePaymentSendFailureZ (*retry_payment)(const void *this_arg, const struct LDKRoute *NONNULL_PTR route, struct LDKThirtyTwoBytes payment_id);
12073 * Signals that no further retries for the given payment will occur.
12075 void (*abandon_payment)(const void *this_arg, struct LDKThirtyTwoBytes payment_id);
12077 * Frees any resources associated with this object given its this_arg pointer.
12078 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
12080 void (*free)(void *this_arg);
12084 * A trait defining behavior for routing an [`Invoice`] payment.
12086 typedef struct LDKRouter {
12088 * An opaque pointer which is passed to your function implementations as an argument.
12089 * This has no meaning in the LDK, and can be NULL or any other value.
12093 * Finds a [`Route`] between `payer` and `payee` for a payment with the given values.
12095 * Note that first_hops (or a relevant inner pointer) may be NULL or all-0s to represent None
12097 struct LDKCResult_RouteLightningErrorZ (*find_route)(const void *this_arg, struct LDKPublicKey payer, const struct LDKRouteParameters *NONNULL_PTR route_params, const uint8_t (*payment_hash)[32], struct LDKCVec_ChannelDetailsZ *first_hops, const struct LDKScore *NONNULL_PTR scorer);
12099 * Frees any resources associated with this object given its this_arg pointer.
12100 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
12102 void (*free)(void *this_arg);
12108 * A utility for paying [`Invoice`]s and sending spontaneous payments.
12110 * See [module-level documentation] for details.
12112 * [module-level documentation]: crate::payment
12114 typedef struct MUST_USE_STRUCT LDKInvoicePayer {
12116 * A pointer to the opaque Rust object.
12117 * Nearly everywhere, inner must be non-null, however in places where
12118 * the Rust equivalent takes an Option, it may be set to null to indicate None.
12120 LDKnativeInvoicePayer *inner;
12122 * Indicates that this is the only struct which contains the same pointer.
12123 * Rust functions which take ownership of an object provided via an argument require
12124 * this to be true and invalidate the object pointed to by inner.
12132 * Number of attempts to retry payment path failures for an [`Invoice`].
12134 * Note that this is the number of *path* failures, not full payment retries. For multi-path
12135 * payments, if this is less than the total number of paths, we will never even retry all of the
12138 typedef struct MUST_USE_STRUCT LDKRetryAttempts {
12140 * A pointer to the opaque Rust object.
12141 * Nearly everywhere, inner must be non-null, however in places where
12142 * the Rust equivalent takes an Option, it may be set to null to indicate None.
12144 LDKnativeRetryAttempts *inner;
12146 * Indicates that this is the only struct which contains the same pointer.
12147 * Rust functions which take ownership of an object provided via an argument require
12148 * this to be true and invalidate the object pointed to by inner.
12151 } LDKRetryAttempts;
12156 * A [`Router`] implemented using [`find_route`].
12158 typedef struct MUST_USE_STRUCT LDKDefaultRouter {
12160 * A pointer to the opaque Rust object.
12161 * Nearly everywhere, inner must be non-null, however in places where
12162 * the Rust equivalent takes an Option, it may be set to null to indicate None.
12164 LDKnativeDefaultRouter *inner;
12166 * Indicates that this is the only struct which contains the same pointer.
12167 * Rust functions which take ownership of an object provided via an argument require
12168 * this to be true and invalidate the object pointed to by inner.
12171 } LDKDefaultRouter;
12173 extern const uintptr_t MAX_BUF_SIZE;
12175 extern const uint64_t MIN_RELAY_FEE_SAT_PER_1000_WEIGHT;
12177 extern const uint64_t CLOSED_CHANNEL_UPDATE_ID;
12179 extern const uint32_t ANTI_REORG_DELAY;
12181 extern const uint16_t BREAKDOWN_TIMEOUT;
12183 extern const uint16_t MIN_CLTV_EXPIRY_DELTA;
12185 extern const uint32_t MIN_FINAL_CLTV_EXPIRY;
12187 extern const uintptr_t REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH;
12189 extern const uint64_t UNKNOWN_CHANNEL_CAPACITY_MSAT;
12191 extern const uint32_t DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA;
12193 extern const uint64_t MAX_TIMESTAMP;
12195 extern const uint64_t DEFAULT_EXPIRY_TIME;
12197 extern const uint64_t DEFAULT_MIN_FINAL_CLTV_EXPIRY;
12199 extern const uint8_t TAG_PAYMENT_HASH;
12201 extern const uint8_t TAG_DESCRIPTION;
12203 extern const uint8_t TAG_PAYEE_PUB_KEY;
12205 extern const uint8_t TAG_DESCRIPTION_HASH;
12207 extern const uint8_t TAG_EXPIRY_TIME;
12209 extern const uint8_t TAG_MIN_FINAL_CLTV_EXPIRY;
12211 extern const uint8_t TAG_FALLBACK;
12213 extern const uint8_t TAG_PRIVATE_ROUTE;
12215 extern const uint8_t TAG_PAYMENT_SECRET;
12217 extern const uint8_t TAG_FEATURES;
12219 struct LDKStr _ldk_get_compiled_version(void);
12221 struct LDKStr _ldk_c_bindings_get_compiled_version(void);
12224 * Frees the data buffer, if data_is_owned is set and datalen > 0.
12226 void Transaction_free(struct LDKTransaction _res);
12229 * Convenience function for constructing a new TxOut
12231 struct LDKTxOut TxOut_new(struct LDKCVec_u8Z script_pubkey, uint64_t value);
12234 * Frees the data pointed to by script_pubkey.
12236 void TxOut_free(struct LDKTxOut _res);
12239 * Creates a new TxOut which has the same data as `orig` but with a new script buffer.
12241 struct LDKTxOut TxOut_clone(const struct LDKTxOut *NONNULL_PTR orig);
12244 * Frees the data buffer, if chars_is_owned is set and len > 0.
12246 void Str_free(struct LDKStr _res);
12248 #if defined(LDK_DEBUG_BUILD)
12250 * This function exists for memory safety testing purposes. It should never be used in production
12253 const void *__unmangle_inner_ptr(const void *ptr);
12257 * Creates a new CResult_NoneNoneZ in the success state.
12259 struct LDKCResult_NoneNoneZ CResult_NoneNoneZ_ok(void);
12262 * Creates a new CResult_NoneNoneZ in the error state.
12264 struct LDKCResult_NoneNoneZ CResult_NoneNoneZ_err(void);
12267 * Checks if the given object is currently in the success state
12269 bool CResult_NoneNoneZ_is_ok(const struct LDKCResult_NoneNoneZ *NONNULL_PTR o);
12272 * Frees any resources used by the CResult_NoneNoneZ.
12274 void CResult_NoneNoneZ_free(struct LDKCResult_NoneNoneZ _res);
12277 * Creates a new CResult_NoneNoneZ which has the same data as `orig`
12278 * but with all dynamically-allocated buffers duplicated in new buffers.
12280 struct LDKCResult_NoneNoneZ CResult_NoneNoneZ_clone(const struct LDKCResult_NoneNoneZ *NONNULL_PTR orig);
12283 * Creates a new CResult_CounterpartyCommitmentSecretsDecodeErrorZ in the success state.
12285 struct LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZ CResult_CounterpartyCommitmentSecretsDecodeErrorZ_ok(struct LDKCounterpartyCommitmentSecrets o);
12288 * Creates a new CResult_CounterpartyCommitmentSecretsDecodeErrorZ in the error state.
12290 struct LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZ CResult_CounterpartyCommitmentSecretsDecodeErrorZ_err(struct LDKDecodeError e);
12293 * Checks if the given object is currently in the success state
12295 bool CResult_CounterpartyCommitmentSecretsDecodeErrorZ_is_ok(const struct LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZ *NONNULL_PTR o);
12298 * Frees any resources used by the CResult_CounterpartyCommitmentSecretsDecodeErrorZ.
12300 void CResult_CounterpartyCommitmentSecretsDecodeErrorZ_free(struct LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZ _res);
12303 * Creates a new CResult_CounterpartyCommitmentSecretsDecodeErrorZ which has the same data as `orig`
12304 * but with all dynamically-allocated buffers duplicated in new buffers.
12306 struct LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZ CResult_CounterpartyCommitmentSecretsDecodeErrorZ_clone(const struct LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZ *NONNULL_PTR orig);
12309 * Creates a new CResult_SecretKeyErrorZ in the success state.
12311 struct LDKCResult_SecretKeyErrorZ CResult_SecretKeyErrorZ_ok(struct LDKSecretKey o);
12314 * Creates a new CResult_SecretKeyErrorZ in the error state.
12316 struct LDKCResult_SecretKeyErrorZ CResult_SecretKeyErrorZ_err(enum LDKSecp256k1Error e);
12319 * Checks if the given object is currently in the success state
12321 bool CResult_SecretKeyErrorZ_is_ok(const struct LDKCResult_SecretKeyErrorZ *NONNULL_PTR o);
12324 * Frees any resources used by the CResult_SecretKeyErrorZ.
12326 void CResult_SecretKeyErrorZ_free(struct LDKCResult_SecretKeyErrorZ _res);
12329 * Creates a new CResult_PublicKeyErrorZ in the success state.
12331 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_ok(struct LDKPublicKey o);
12334 * Creates a new CResult_PublicKeyErrorZ in the error state.
12336 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_err(enum LDKSecp256k1Error e);
12339 * Checks if the given object is currently in the success state
12341 bool CResult_PublicKeyErrorZ_is_ok(const struct LDKCResult_PublicKeyErrorZ *NONNULL_PTR o);
12344 * Frees any resources used by the CResult_PublicKeyErrorZ.
12346 void CResult_PublicKeyErrorZ_free(struct LDKCResult_PublicKeyErrorZ _res);
12349 * Creates a new CResult_PublicKeyErrorZ which has the same data as `orig`
12350 * but with all dynamically-allocated buffers duplicated in new buffers.
12352 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_clone(const struct LDKCResult_PublicKeyErrorZ *NONNULL_PTR orig);
12355 * Creates a new CResult_TxCreationKeysDecodeErrorZ in the success state.
12357 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_ok(struct LDKTxCreationKeys o);
12360 * Creates a new CResult_TxCreationKeysDecodeErrorZ in the error state.
12362 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_err(struct LDKDecodeError e);
12365 * Checks if the given object is currently in the success state
12367 bool CResult_TxCreationKeysDecodeErrorZ_is_ok(const struct LDKCResult_TxCreationKeysDecodeErrorZ *NONNULL_PTR o);
12370 * Frees any resources used by the CResult_TxCreationKeysDecodeErrorZ.
12372 void CResult_TxCreationKeysDecodeErrorZ_free(struct LDKCResult_TxCreationKeysDecodeErrorZ _res);
12375 * Creates a new CResult_TxCreationKeysDecodeErrorZ which has the same data as `orig`
12376 * but with all dynamically-allocated buffers duplicated in new buffers.
12378 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_clone(const struct LDKCResult_TxCreationKeysDecodeErrorZ *NONNULL_PTR orig);
12381 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ in the success state.
12383 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_ok(struct LDKChannelPublicKeys o);
12386 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ in the error state.
12388 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_err(struct LDKDecodeError e);
12391 * Checks if the given object is currently in the success state
12393 bool CResult_ChannelPublicKeysDecodeErrorZ_is_ok(const struct LDKCResult_ChannelPublicKeysDecodeErrorZ *NONNULL_PTR o);
12396 * Frees any resources used by the CResult_ChannelPublicKeysDecodeErrorZ.
12398 void CResult_ChannelPublicKeysDecodeErrorZ_free(struct LDKCResult_ChannelPublicKeysDecodeErrorZ _res);
12401 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ which has the same data as `orig`
12402 * but with all dynamically-allocated buffers duplicated in new buffers.
12404 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_clone(const struct LDKCResult_ChannelPublicKeysDecodeErrorZ *NONNULL_PTR orig);
12407 * Creates a new CResult_TxCreationKeysErrorZ in the success state.
12409 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_ok(struct LDKTxCreationKeys o);
12412 * Creates a new CResult_TxCreationKeysErrorZ in the error state.
12414 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_err(enum LDKSecp256k1Error e);
12417 * Checks if the given object is currently in the success state
12419 bool CResult_TxCreationKeysErrorZ_is_ok(const struct LDKCResult_TxCreationKeysErrorZ *NONNULL_PTR o);
12422 * Frees any resources used by the CResult_TxCreationKeysErrorZ.
12424 void CResult_TxCreationKeysErrorZ_free(struct LDKCResult_TxCreationKeysErrorZ _res);
12427 * Creates a new CResult_TxCreationKeysErrorZ which has the same data as `orig`
12428 * but with all dynamically-allocated buffers duplicated in new buffers.
12430 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_clone(const struct LDKCResult_TxCreationKeysErrorZ *NONNULL_PTR orig);
12433 * Constructs a new COption_u32Z containing a u32
12435 struct LDKCOption_u32Z COption_u32Z_some(uint32_t o);
12438 * Constructs a new COption_u32Z containing nothing
12440 struct LDKCOption_u32Z COption_u32Z_none(void);
12443 * Frees any resources associated with the u32, if we are in the Some state
12445 void COption_u32Z_free(struct LDKCOption_u32Z _res);
12448 * Creates a new COption_u32Z which has the same data as `orig`
12449 * but with all dynamically-allocated buffers duplicated in new buffers.
12451 struct LDKCOption_u32Z COption_u32Z_clone(const struct LDKCOption_u32Z *NONNULL_PTR orig);
12454 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ in the success state.
12456 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_ok(struct LDKHTLCOutputInCommitment o);
12459 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ in the error state.
12461 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_err(struct LDKDecodeError e);
12464 * Checks if the given object is currently in the success state
12466 bool CResult_HTLCOutputInCommitmentDecodeErrorZ_is_ok(const struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ *NONNULL_PTR o);
12469 * Frees any resources used by the CResult_HTLCOutputInCommitmentDecodeErrorZ.
12471 void CResult_HTLCOutputInCommitmentDecodeErrorZ_free(struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ _res);
12474 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ which has the same data as `orig`
12475 * but with all dynamically-allocated buffers duplicated in new buffers.
12477 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_clone(const struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ *NONNULL_PTR orig);
12480 * Constructs a new COption_NoneZ containing a
12482 enum LDKCOption_NoneZ COption_NoneZ_some(void);
12485 * Constructs a new COption_NoneZ containing nothing
12487 enum LDKCOption_NoneZ COption_NoneZ_none(void);
12490 * Frees any resources associated with the , if we are in the Some state
12492 void COption_NoneZ_free(enum LDKCOption_NoneZ _res);
12495 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ in the success state.
12497 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_ok(struct LDKCounterpartyChannelTransactionParameters o);
12500 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ in the error state.
12502 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_err(struct LDKDecodeError e);
12505 * Checks if the given object is currently in the success state
12507 bool CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_is_ok(const struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ *NONNULL_PTR o);
12510 * Frees any resources used by the CResult_CounterpartyChannelTransactionParametersDecodeErrorZ.
12512 void CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_free(struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ _res);
12515 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ which has the same data as `orig`
12516 * but with all dynamically-allocated buffers duplicated in new buffers.
12518 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_clone(const struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ *NONNULL_PTR orig);
12521 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ in the success state.
12523 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_ok(struct LDKChannelTransactionParameters o);
12526 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ in the error state.
12528 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_err(struct LDKDecodeError e);
12531 * Checks if the given object is currently in the success state
12533 bool CResult_ChannelTransactionParametersDecodeErrorZ_is_ok(const struct LDKCResult_ChannelTransactionParametersDecodeErrorZ *NONNULL_PTR o);
12536 * Frees any resources used by the CResult_ChannelTransactionParametersDecodeErrorZ.
12538 void CResult_ChannelTransactionParametersDecodeErrorZ_free(struct LDKCResult_ChannelTransactionParametersDecodeErrorZ _res);
12541 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ which has the same data as `orig`
12542 * but with all dynamically-allocated buffers duplicated in new buffers.
12544 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_clone(const struct LDKCResult_ChannelTransactionParametersDecodeErrorZ *NONNULL_PTR orig);
12547 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12549 void CVec_SignatureZ_free(struct LDKCVec_SignatureZ _res);
12552 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ in the success state.
12554 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_ok(struct LDKHolderCommitmentTransaction o);
12557 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ in the error state.
12559 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
12562 * Checks if the given object is currently in the success state
12564 bool CResult_HolderCommitmentTransactionDecodeErrorZ_is_ok(const struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ *NONNULL_PTR o);
12567 * Frees any resources used by the CResult_HolderCommitmentTransactionDecodeErrorZ.
12569 void CResult_HolderCommitmentTransactionDecodeErrorZ_free(struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ _res);
12572 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ which has the same data as `orig`
12573 * but with all dynamically-allocated buffers duplicated in new buffers.
12575 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
12578 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ in the success state.
12580 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_ok(struct LDKBuiltCommitmentTransaction o);
12583 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ in the error state.
12585 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
12588 * Checks if the given object is currently in the success state
12590 bool CResult_BuiltCommitmentTransactionDecodeErrorZ_is_ok(const struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ *NONNULL_PTR o);
12593 * Frees any resources used by the CResult_BuiltCommitmentTransactionDecodeErrorZ.
12595 void CResult_BuiltCommitmentTransactionDecodeErrorZ_free(struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ _res);
12598 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ which has the same data as `orig`
12599 * but with all dynamically-allocated buffers duplicated in new buffers.
12601 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
12604 * Creates a new CResult_TrustedClosingTransactionNoneZ in the success state.
12606 struct LDKCResult_TrustedClosingTransactionNoneZ CResult_TrustedClosingTransactionNoneZ_ok(struct LDKTrustedClosingTransaction o);
12609 * Creates a new CResult_TrustedClosingTransactionNoneZ in the error state.
12611 struct LDKCResult_TrustedClosingTransactionNoneZ CResult_TrustedClosingTransactionNoneZ_err(void);
12614 * Checks if the given object is currently in the success state
12616 bool CResult_TrustedClosingTransactionNoneZ_is_ok(const struct LDKCResult_TrustedClosingTransactionNoneZ *NONNULL_PTR o);
12619 * Frees any resources used by the CResult_TrustedClosingTransactionNoneZ.
12621 void CResult_TrustedClosingTransactionNoneZ_free(struct LDKCResult_TrustedClosingTransactionNoneZ _res);
12624 * Creates a new CResult_CommitmentTransactionDecodeErrorZ in the success state.
12626 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_ok(struct LDKCommitmentTransaction o);
12629 * Creates a new CResult_CommitmentTransactionDecodeErrorZ in the error state.
12631 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
12634 * Checks if the given object is currently in the success state
12636 bool CResult_CommitmentTransactionDecodeErrorZ_is_ok(const struct LDKCResult_CommitmentTransactionDecodeErrorZ *NONNULL_PTR o);
12639 * Frees any resources used by the CResult_CommitmentTransactionDecodeErrorZ.
12641 void CResult_CommitmentTransactionDecodeErrorZ_free(struct LDKCResult_CommitmentTransactionDecodeErrorZ _res);
12644 * Creates a new CResult_CommitmentTransactionDecodeErrorZ which has the same data as `orig`
12645 * but with all dynamically-allocated buffers duplicated in new buffers.
12647 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_CommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
12650 * Creates a new CResult_TrustedCommitmentTransactionNoneZ in the success state.
12652 struct LDKCResult_TrustedCommitmentTransactionNoneZ CResult_TrustedCommitmentTransactionNoneZ_ok(struct LDKTrustedCommitmentTransaction o);
12655 * Creates a new CResult_TrustedCommitmentTransactionNoneZ in the error state.
12657 struct LDKCResult_TrustedCommitmentTransactionNoneZ CResult_TrustedCommitmentTransactionNoneZ_err(void);
12660 * Checks if the given object is currently in the success state
12662 bool CResult_TrustedCommitmentTransactionNoneZ_is_ok(const struct LDKCResult_TrustedCommitmentTransactionNoneZ *NONNULL_PTR o);
12665 * Frees any resources used by the CResult_TrustedCommitmentTransactionNoneZ.
12667 void CResult_TrustedCommitmentTransactionNoneZ_free(struct LDKCResult_TrustedCommitmentTransactionNoneZ _res);
12670 * Creates a new CResult_CVec_SignatureZNoneZ in the success state.
12672 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_ok(struct LDKCVec_SignatureZ o);
12675 * Creates a new CResult_CVec_SignatureZNoneZ in the error state.
12677 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_err(void);
12680 * Checks if the given object is currently in the success state
12682 bool CResult_CVec_SignatureZNoneZ_is_ok(const struct LDKCResult_CVec_SignatureZNoneZ *NONNULL_PTR o);
12685 * Frees any resources used by the CResult_CVec_SignatureZNoneZ.
12687 void CResult_CVec_SignatureZNoneZ_free(struct LDKCResult_CVec_SignatureZNoneZ _res);
12690 * Creates a new CResult_CVec_SignatureZNoneZ which has the same data as `orig`
12691 * but with all dynamically-allocated buffers duplicated in new buffers.
12693 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_clone(const struct LDKCResult_CVec_SignatureZNoneZ *NONNULL_PTR orig);
12696 * Creates a new CResult_ShutdownScriptDecodeErrorZ in the success state.
12698 struct LDKCResult_ShutdownScriptDecodeErrorZ CResult_ShutdownScriptDecodeErrorZ_ok(struct LDKShutdownScript o);
12701 * Creates a new CResult_ShutdownScriptDecodeErrorZ in the error state.
12703 struct LDKCResult_ShutdownScriptDecodeErrorZ CResult_ShutdownScriptDecodeErrorZ_err(struct LDKDecodeError e);
12706 * Checks if the given object is currently in the success state
12708 bool CResult_ShutdownScriptDecodeErrorZ_is_ok(const struct LDKCResult_ShutdownScriptDecodeErrorZ *NONNULL_PTR o);
12711 * Frees any resources used by the CResult_ShutdownScriptDecodeErrorZ.
12713 void CResult_ShutdownScriptDecodeErrorZ_free(struct LDKCResult_ShutdownScriptDecodeErrorZ _res);
12716 * Creates a new CResult_ShutdownScriptDecodeErrorZ which has the same data as `orig`
12717 * but with all dynamically-allocated buffers duplicated in new buffers.
12719 struct LDKCResult_ShutdownScriptDecodeErrorZ CResult_ShutdownScriptDecodeErrorZ_clone(const struct LDKCResult_ShutdownScriptDecodeErrorZ *NONNULL_PTR orig);
12722 * Creates a new CResult_ShutdownScriptInvalidShutdownScriptZ in the success state.
12724 struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ CResult_ShutdownScriptInvalidShutdownScriptZ_ok(struct LDKShutdownScript o);
12727 * Creates a new CResult_ShutdownScriptInvalidShutdownScriptZ in the error state.
12729 struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ CResult_ShutdownScriptInvalidShutdownScriptZ_err(struct LDKInvalidShutdownScript e);
12732 * Checks if the given object is currently in the success state
12734 bool CResult_ShutdownScriptInvalidShutdownScriptZ_is_ok(const struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ *NONNULL_PTR o);
12737 * Frees any resources used by the CResult_ShutdownScriptInvalidShutdownScriptZ.
12739 void CResult_ShutdownScriptInvalidShutdownScriptZ_free(struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ _res);
12742 * Creates a new CResult_ShutdownScriptInvalidShutdownScriptZ which has the same data as `orig`
12743 * but with all dynamically-allocated buffers duplicated in new buffers.
12745 struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ CResult_ShutdownScriptInvalidShutdownScriptZ_clone(const struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ *NONNULL_PTR orig);
12748 * Creates a new CResult_NoneErrorZ in the success state.
12750 struct LDKCResult_NoneErrorZ CResult_NoneErrorZ_ok(void);
12753 * Creates a new CResult_NoneErrorZ in the error state.
12755 struct LDKCResult_NoneErrorZ CResult_NoneErrorZ_err(enum LDKIOError e);
12758 * Checks if the given object is currently in the success state
12760 bool CResult_NoneErrorZ_is_ok(const struct LDKCResult_NoneErrorZ *NONNULL_PTR o);
12763 * Frees any resources used by the CResult_NoneErrorZ.
12765 void CResult_NoneErrorZ_free(struct LDKCResult_NoneErrorZ _res);
12768 * Creates a new CResult_NoneErrorZ which has the same data as `orig`
12769 * but with all dynamically-allocated buffers duplicated in new buffers.
12771 struct LDKCResult_NoneErrorZ CResult_NoneErrorZ_clone(const struct LDKCResult_NoneErrorZ *NONNULL_PTR orig);
12774 * Creates a new CResult_RouteHopDecodeErrorZ in the success state.
12776 struct LDKCResult_RouteHopDecodeErrorZ CResult_RouteHopDecodeErrorZ_ok(struct LDKRouteHop o);
12779 * Creates a new CResult_RouteHopDecodeErrorZ in the error state.
12781 struct LDKCResult_RouteHopDecodeErrorZ CResult_RouteHopDecodeErrorZ_err(struct LDKDecodeError e);
12784 * Checks if the given object is currently in the success state
12786 bool CResult_RouteHopDecodeErrorZ_is_ok(const struct LDKCResult_RouteHopDecodeErrorZ *NONNULL_PTR o);
12789 * Frees any resources used by the CResult_RouteHopDecodeErrorZ.
12791 void CResult_RouteHopDecodeErrorZ_free(struct LDKCResult_RouteHopDecodeErrorZ _res);
12794 * Creates a new CResult_RouteHopDecodeErrorZ which has the same data as `orig`
12795 * but with all dynamically-allocated buffers duplicated in new buffers.
12797 struct LDKCResult_RouteHopDecodeErrorZ CResult_RouteHopDecodeErrorZ_clone(const struct LDKCResult_RouteHopDecodeErrorZ *NONNULL_PTR orig);
12800 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12802 void CVec_RouteHopZ_free(struct LDKCVec_RouteHopZ _res);
12805 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12807 void CVec_CVec_RouteHopZZ_free(struct LDKCVec_CVec_RouteHopZZ _res);
12810 * Creates a new CResult_RouteDecodeErrorZ in the success state.
12812 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_ok(struct LDKRoute o);
12815 * Creates a new CResult_RouteDecodeErrorZ in the error state.
12817 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_err(struct LDKDecodeError e);
12820 * Checks if the given object is currently in the success state
12822 bool CResult_RouteDecodeErrorZ_is_ok(const struct LDKCResult_RouteDecodeErrorZ *NONNULL_PTR o);
12825 * Frees any resources used by the CResult_RouteDecodeErrorZ.
12827 void CResult_RouteDecodeErrorZ_free(struct LDKCResult_RouteDecodeErrorZ _res);
12830 * Creates a new CResult_RouteDecodeErrorZ which has the same data as `orig`
12831 * but with all dynamically-allocated buffers duplicated in new buffers.
12833 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_clone(const struct LDKCResult_RouteDecodeErrorZ *NONNULL_PTR orig);
12836 * Creates a new CResult_RouteParametersDecodeErrorZ in the success state.
12838 struct LDKCResult_RouteParametersDecodeErrorZ CResult_RouteParametersDecodeErrorZ_ok(struct LDKRouteParameters o);
12841 * Creates a new CResult_RouteParametersDecodeErrorZ in the error state.
12843 struct LDKCResult_RouteParametersDecodeErrorZ CResult_RouteParametersDecodeErrorZ_err(struct LDKDecodeError e);
12846 * Checks if the given object is currently in the success state
12848 bool CResult_RouteParametersDecodeErrorZ_is_ok(const struct LDKCResult_RouteParametersDecodeErrorZ *NONNULL_PTR o);
12851 * Frees any resources used by the CResult_RouteParametersDecodeErrorZ.
12853 void CResult_RouteParametersDecodeErrorZ_free(struct LDKCResult_RouteParametersDecodeErrorZ _res);
12856 * Creates a new CResult_RouteParametersDecodeErrorZ which has the same data as `orig`
12857 * but with all dynamically-allocated buffers duplicated in new buffers.
12859 struct LDKCResult_RouteParametersDecodeErrorZ CResult_RouteParametersDecodeErrorZ_clone(const struct LDKCResult_RouteParametersDecodeErrorZ *NONNULL_PTR orig);
12862 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12864 void CVec_RouteHintZ_free(struct LDKCVec_RouteHintZ _res);
12867 * Constructs a new COption_u64Z containing a u64
12869 struct LDKCOption_u64Z COption_u64Z_some(uint64_t o);
12872 * Constructs a new COption_u64Z containing nothing
12874 struct LDKCOption_u64Z COption_u64Z_none(void);
12877 * Frees any resources associated with the u64, if we are in the Some state
12879 void COption_u64Z_free(struct LDKCOption_u64Z _res);
12882 * Creates a new COption_u64Z which has the same data as `orig`
12883 * but with all dynamically-allocated buffers duplicated in new buffers.
12885 struct LDKCOption_u64Z COption_u64Z_clone(const struct LDKCOption_u64Z *NONNULL_PTR orig);
12888 * Creates a new CResult_PaymentParametersDecodeErrorZ in the success state.
12890 struct LDKCResult_PaymentParametersDecodeErrorZ CResult_PaymentParametersDecodeErrorZ_ok(struct LDKPaymentParameters o);
12893 * Creates a new CResult_PaymentParametersDecodeErrorZ in the error state.
12895 struct LDKCResult_PaymentParametersDecodeErrorZ CResult_PaymentParametersDecodeErrorZ_err(struct LDKDecodeError e);
12898 * Checks if the given object is currently in the success state
12900 bool CResult_PaymentParametersDecodeErrorZ_is_ok(const struct LDKCResult_PaymentParametersDecodeErrorZ *NONNULL_PTR o);
12903 * Frees any resources used by the CResult_PaymentParametersDecodeErrorZ.
12905 void CResult_PaymentParametersDecodeErrorZ_free(struct LDKCResult_PaymentParametersDecodeErrorZ _res);
12908 * Creates a new CResult_PaymentParametersDecodeErrorZ which has the same data as `orig`
12909 * but with all dynamically-allocated buffers duplicated in new buffers.
12911 struct LDKCResult_PaymentParametersDecodeErrorZ CResult_PaymentParametersDecodeErrorZ_clone(const struct LDKCResult_PaymentParametersDecodeErrorZ *NONNULL_PTR orig);
12914 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12916 void CVec_RouteHintHopZ_free(struct LDKCVec_RouteHintHopZ _res);
12919 * Creates a new CResult_RouteHintDecodeErrorZ in the success state.
12921 struct LDKCResult_RouteHintDecodeErrorZ CResult_RouteHintDecodeErrorZ_ok(struct LDKRouteHint o);
12924 * Creates a new CResult_RouteHintDecodeErrorZ in the error state.
12926 struct LDKCResult_RouteHintDecodeErrorZ CResult_RouteHintDecodeErrorZ_err(struct LDKDecodeError e);
12929 * Checks if the given object is currently in the success state
12931 bool CResult_RouteHintDecodeErrorZ_is_ok(const struct LDKCResult_RouteHintDecodeErrorZ *NONNULL_PTR o);
12934 * Frees any resources used by the CResult_RouteHintDecodeErrorZ.
12936 void CResult_RouteHintDecodeErrorZ_free(struct LDKCResult_RouteHintDecodeErrorZ _res);
12939 * Creates a new CResult_RouteHintDecodeErrorZ which has the same data as `orig`
12940 * but with all dynamically-allocated buffers duplicated in new buffers.
12942 struct LDKCResult_RouteHintDecodeErrorZ CResult_RouteHintDecodeErrorZ_clone(const struct LDKCResult_RouteHintDecodeErrorZ *NONNULL_PTR orig);
12945 * Creates a new CResult_RouteHintHopDecodeErrorZ in the success state.
12947 struct LDKCResult_RouteHintHopDecodeErrorZ CResult_RouteHintHopDecodeErrorZ_ok(struct LDKRouteHintHop o);
12950 * Creates a new CResult_RouteHintHopDecodeErrorZ in the error state.
12952 struct LDKCResult_RouteHintHopDecodeErrorZ CResult_RouteHintHopDecodeErrorZ_err(struct LDKDecodeError e);
12955 * Checks if the given object is currently in the success state
12957 bool CResult_RouteHintHopDecodeErrorZ_is_ok(const struct LDKCResult_RouteHintHopDecodeErrorZ *NONNULL_PTR o);
12960 * Frees any resources used by the CResult_RouteHintHopDecodeErrorZ.
12962 void CResult_RouteHintHopDecodeErrorZ_free(struct LDKCResult_RouteHintHopDecodeErrorZ _res);
12965 * Creates a new CResult_RouteHintHopDecodeErrorZ which has the same data as `orig`
12966 * but with all dynamically-allocated buffers duplicated in new buffers.
12968 struct LDKCResult_RouteHintHopDecodeErrorZ CResult_RouteHintHopDecodeErrorZ_clone(const struct LDKCResult_RouteHintHopDecodeErrorZ *NONNULL_PTR orig);
12971 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12973 void CVec_ChannelDetailsZ_free(struct LDKCVec_ChannelDetailsZ _res);
12976 * Creates a new CResult_RouteLightningErrorZ in the success state.
12978 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_ok(struct LDKRoute o);
12981 * Creates a new CResult_RouteLightningErrorZ in the error state.
12983 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_err(struct LDKLightningError e);
12986 * Checks if the given object is currently in the success state
12988 bool CResult_RouteLightningErrorZ_is_ok(const struct LDKCResult_RouteLightningErrorZ *NONNULL_PTR o);
12991 * Frees any resources used by the CResult_RouteLightningErrorZ.
12993 void CResult_RouteLightningErrorZ_free(struct LDKCResult_RouteLightningErrorZ _res);
12996 * Creates a new CResult_RouteLightningErrorZ which has the same data as `orig`
12997 * but with all dynamically-allocated buffers duplicated in new buffers.
12999 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_clone(const struct LDKCResult_RouteLightningErrorZ *NONNULL_PTR orig);
13002 * Creates a new CResult_TxOutAccessErrorZ in the success state.
13004 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_ok(struct LDKTxOut o);
13007 * Creates a new CResult_TxOutAccessErrorZ in the error state.
13009 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_err(enum LDKAccessError e);
13012 * Checks if the given object is currently in the success state
13014 bool CResult_TxOutAccessErrorZ_is_ok(const struct LDKCResult_TxOutAccessErrorZ *NONNULL_PTR o);
13017 * Frees any resources used by the CResult_TxOutAccessErrorZ.
13019 void CResult_TxOutAccessErrorZ_free(struct LDKCResult_TxOutAccessErrorZ _res);
13022 * Creates a new CResult_TxOutAccessErrorZ which has the same data as `orig`
13023 * but with all dynamically-allocated buffers duplicated in new buffers.
13025 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_clone(const struct LDKCResult_TxOutAccessErrorZ *NONNULL_PTR orig);
13028 * Creates a new tuple which has the same data as `orig`
13029 * but with all dynamically-allocated buffers duplicated in new buffers.
13031 struct LDKC2Tuple_usizeTransactionZ C2Tuple_usizeTransactionZ_clone(const struct LDKC2Tuple_usizeTransactionZ *NONNULL_PTR orig);
13034 * Creates a new C2Tuple_usizeTransactionZ from the contained elements.
13036 struct LDKC2Tuple_usizeTransactionZ C2Tuple_usizeTransactionZ_new(uintptr_t a, struct LDKTransaction b);
13039 * Frees any resources used by the C2Tuple_usizeTransactionZ.
13041 void C2Tuple_usizeTransactionZ_free(struct LDKC2Tuple_usizeTransactionZ _res);
13044 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13046 void CVec_C2Tuple_usizeTransactionZZ_free(struct LDKCVec_C2Tuple_usizeTransactionZZ _res);
13049 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13051 void CVec_TxidZ_free(struct LDKCVec_TxidZ _res);
13054 * Creates a new CResult_NoneChannelMonitorUpdateErrZ in the success state.
13056 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_ok(void);
13059 * Creates a new CResult_NoneChannelMonitorUpdateErrZ in the error state.
13061 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_err(enum LDKChannelMonitorUpdateErr e);
13064 * Checks if the given object is currently in the success state
13066 bool CResult_NoneChannelMonitorUpdateErrZ_is_ok(const struct LDKCResult_NoneChannelMonitorUpdateErrZ *NONNULL_PTR o);
13069 * Frees any resources used by the CResult_NoneChannelMonitorUpdateErrZ.
13071 void CResult_NoneChannelMonitorUpdateErrZ_free(struct LDKCResult_NoneChannelMonitorUpdateErrZ _res);
13074 * Creates a new CResult_NoneChannelMonitorUpdateErrZ which has the same data as `orig`
13075 * but with all dynamically-allocated buffers duplicated in new buffers.
13077 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_clone(const struct LDKCResult_NoneChannelMonitorUpdateErrZ *NONNULL_PTR orig);
13080 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13082 void CVec_MonitorEventZ_free(struct LDKCVec_MonitorEventZ _res);
13085 * Constructs a new COption_C2Tuple_usizeTransactionZZ containing a crate::c_types::derived::C2Tuple_usizeTransactionZ
13087 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_some(struct LDKC2Tuple_usizeTransactionZ o);
13090 * Constructs a new COption_C2Tuple_usizeTransactionZZ containing nothing
13092 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_none(void);
13095 * Frees any resources associated with the crate::c_types::derived::C2Tuple_usizeTransactionZ, if we are in the Some state
13097 void COption_C2Tuple_usizeTransactionZZ_free(struct LDKCOption_C2Tuple_usizeTransactionZZ _res);
13100 * Creates a new COption_C2Tuple_usizeTransactionZZ which has the same data as `orig`
13101 * but with all dynamically-allocated buffers duplicated in new buffers.
13103 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_clone(const struct LDKCOption_C2Tuple_usizeTransactionZZ *NONNULL_PTR orig);
13106 * Constructs a new COption_ClosureReasonZ containing a crate::lightning::util::events::ClosureReason
13108 struct LDKCOption_ClosureReasonZ COption_ClosureReasonZ_some(struct LDKClosureReason o);
13111 * Constructs a new COption_ClosureReasonZ containing nothing
13113 struct LDKCOption_ClosureReasonZ COption_ClosureReasonZ_none(void);
13116 * Frees any resources associated with the crate::lightning::util::events::ClosureReason, if we are in the Some state
13118 void COption_ClosureReasonZ_free(struct LDKCOption_ClosureReasonZ _res);
13121 * Creates a new COption_ClosureReasonZ which has the same data as `orig`
13122 * but with all dynamically-allocated buffers duplicated in new buffers.
13124 struct LDKCOption_ClosureReasonZ COption_ClosureReasonZ_clone(const struct LDKCOption_ClosureReasonZ *NONNULL_PTR orig);
13127 * Creates a new CResult_COption_ClosureReasonZDecodeErrorZ in the success state.
13129 struct LDKCResult_COption_ClosureReasonZDecodeErrorZ CResult_COption_ClosureReasonZDecodeErrorZ_ok(struct LDKCOption_ClosureReasonZ o);
13132 * Creates a new CResult_COption_ClosureReasonZDecodeErrorZ in the error state.
13134 struct LDKCResult_COption_ClosureReasonZDecodeErrorZ CResult_COption_ClosureReasonZDecodeErrorZ_err(struct LDKDecodeError e);
13137 * Checks if the given object is currently in the success state
13139 bool CResult_COption_ClosureReasonZDecodeErrorZ_is_ok(const struct LDKCResult_COption_ClosureReasonZDecodeErrorZ *NONNULL_PTR o);
13142 * Frees any resources used by the CResult_COption_ClosureReasonZDecodeErrorZ.
13144 void CResult_COption_ClosureReasonZDecodeErrorZ_free(struct LDKCResult_COption_ClosureReasonZDecodeErrorZ _res);
13147 * Creates a new CResult_COption_ClosureReasonZDecodeErrorZ which has the same data as `orig`
13148 * but with all dynamically-allocated buffers duplicated in new buffers.
13150 struct LDKCResult_COption_ClosureReasonZDecodeErrorZ CResult_COption_ClosureReasonZDecodeErrorZ_clone(const struct LDKCResult_COption_ClosureReasonZDecodeErrorZ *NONNULL_PTR orig);
13153 * Constructs a new COption_NetworkUpdateZ containing a crate::lightning::routing::network_graph::NetworkUpdate
13155 struct LDKCOption_NetworkUpdateZ COption_NetworkUpdateZ_some(struct LDKNetworkUpdate o);
13158 * Constructs a new COption_NetworkUpdateZ containing nothing
13160 struct LDKCOption_NetworkUpdateZ COption_NetworkUpdateZ_none(void);
13163 * Frees any resources associated with the crate::lightning::routing::network_graph::NetworkUpdate, if we are in the Some state
13165 void COption_NetworkUpdateZ_free(struct LDKCOption_NetworkUpdateZ _res);
13168 * Creates a new COption_NetworkUpdateZ which has the same data as `orig`
13169 * but with all dynamically-allocated buffers duplicated in new buffers.
13171 struct LDKCOption_NetworkUpdateZ COption_NetworkUpdateZ_clone(const struct LDKCOption_NetworkUpdateZ *NONNULL_PTR orig);
13174 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13176 void CVec_SpendableOutputDescriptorZ_free(struct LDKCVec_SpendableOutputDescriptorZ _res);
13179 * Constructs a new COption_EventZ containing a crate::lightning::util::events::Event
13181 struct LDKCOption_EventZ COption_EventZ_some(struct LDKEvent o);
13184 * Constructs a new COption_EventZ containing nothing
13186 struct LDKCOption_EventZ COption_EventZ_none(void);
13189 * Frees any resources associated with the crate::lightning::util::events::Event, if we are in the Some state
13191 void COption_EventZ_free(struct LDKCOption_EventZ _res);
13194 * Creates a new COption_EventZ which has the same data as `orig`
13195 * but with all dynamically-allocated buffers duplicated in new buffers.
13197 struct LDKCOption_EventZ COption_EventZ_clone(const struct LDKCOption_EventZ *NONNULL_PTR orig);
13200 * Creates a new CResult_COption_EventZDecodeErrorZ in the success state.
13202 struct LDKCResult_COption_EventZDecodeErrorZ CResult_COption_EventZDecodeErrorZ_ok(struct LDKCOption_EventZ o);
13205 * Creates a new CResult_COption_EventZDecodeErrorZ in the error state.
13207 struct LDKCResult_COption_EventZDecodeErrorZ CResult_COption_EventZDecodeErrorZ_err(struct LDKDecodeError e);
13210 * Checks if the given object is currently in the success state
13212 bool CResult_COption_EventZDecodeErrorZ_is_ok(const struct LDKCResult_COption_EventZDecodeErrorZ *NONNULL_PTR o);
13215 * Frees any resources used by the CResult_COption_EventZDecodeErrorZ.
13217 void CResult_COption_EventZDecodeErrorZ_free(struct LDKCResult_COption_EventZDecodeErrorZ _res);
13220 * Creates a new CResult_COption_EventZDecodeErrorZ which has the same data as `orig`
13221 * but with all dynamically-allocated buffers duplicated in new buffers.
13223 struct LDKCResult_COption_EventZDecodeErrorZ CResult_COption_EventZDecodeErrorZ_clone(const struct LDKCResult_COption_EventZDecodeErrorZ *NONNULL_PTR orig);
13226 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13228 void CVec_MessageSendEventZ_free(struct LDKCVec_MessageSendEventZ _res);
13231 * Creates a new CResult_FixedPenaltyScorerDecodeErrorZ in the success state.
13233 struct LDKCResult_FixedPenaltyScorerDecodeErrorZ CResult_FixedPenaltyScorerDecodeErrorZ_ok(struct LDKFixedPenaltyScorer o);
13236 * Creates a new CResult_FixedPenaltyScorerDecodeErrorZ in the error state.
13238 struct LDKCResult_FixedPenaltyScorerDecodeErrorZ CResult_FixedPenaltyScorerDecodeErrorZ_err(struct LDKDecodeError e);
13241 * Checks if the given object is currently in the success state
13243 bool CResult_FixedPenaltyScorerDecodeErrorZ_is_ok(const struct LDKCResult_FixedPenaltyScorerDecodeErrorZ *NONNULL_PTR o);
13246 * Frees any resources used by the CResult_FixedPenaltyScorerDecodeErrorZ.
13248 void CResult_FixedPenaltyScorerDecodeErrorZ_free(struct LDKCResult_FixedPenaltyScorerDecodeErrorZ _res);
13251 * Creates a new CResult_ScoringParametersDecodeErrorZ in the success state.
13253 struct LDKCResult_ScoringParametersDecodeErrorZ CResult_ScoringParametersDecodeErrorZ_ok(struct LDKScoringParameters o);
13256 * Creates a new CResult_ScoringParametersDecodeErrorZ in the error state.
13258 struct LDKCResult_ScoringParametersDecodeErrorZ CResult_ScoringParametersDecodeErrorZ_err(struct LDKDecodeError e);
13261 * Checks if the given object is currently in the success state
13263 bool CResult_ScoringParametersDecodeErrorZ_is_ok(const struct LDKCResult_ScoringParametersDecodeErrorZ *NONNULL_PTR o);
13266 * Frees any resources used by the CResult_ScoringParametersDecodeErrorZ.
13268 void CResult_ScoringParametersDecodeErrorZ_free(struct LDKCResult_ScoringParametersDecodeErrorZ _res);
13271 * Creates a new CResult_ScorerDecodeErrorZ in the success state.
13273 struct LDKCResult_ScorerDecodeErrorZ CResult_ScorerDecodeErrorZ_ok(struct LDKScorer o);
13276 * Creates a new CResult_ScorerDecodeErrorZ in the error state.
13278 struct LDKCResult_ScorerDecodeErrorZ CResult_ScorerDecodeErrorZ_err(struct LDKDecodeError e);
13281 * Checks if the given object is currently in the success state
13283 bool CResult_ScorerDecodeErrorZ_is_ok(const struct LDKCResult_ScorerDecodeErrorZ *NONNULL_PTR o);
13286 * Frees any resources used by the CResult_ScorerDecodeErrorZ.
13288 void CResult_ScorerDecodeErrorZ_free(struct LDKCResult_ScorerDecodeErrorZ _res);
13291 * Creates a new CResult_ProbabilisticScoringParametersDecodeErrorZ in the success state.
13293 struct LDKCResult_ProbabilisticScoringParametersDecodeErrorZ CResult_ProbabilisticScoringParametersDecodeErrorZ_ok(struct LDKProbabilisticScoringParameters o);
13296 * Creates a new CResult_ProbabilisticScoringParametersDecodeErrorZ in the error state.
13298 struct LDKCResult_ProbabilisticScoringParametersDecodeErrorZ CResult_ProbabilisticScoringParametersDecodeErrorZ_err(struct LDKDecodeError e);
13301 * Checks if the given object is currently in the success state
13303 bool CResult_ProbabilisticScoringParametersDecodeErrorZ_is_ok(const struct LDKCResult_ProbabilisticScoringParametersDecodeErrorZ *NONNULL_PTR o);
13306 * Frees any resources used by the CResult_ProbabilisticScoringParametersDecodeErrorZ.
13308 void CResult_ProbabilisticScoringParametersDecodeErrorZ_free(struct LDKCResult_ProbabilisticScoringParametersDecodeErrorZ _res);
13311 * Creates a new CResult_ProbabilisticScoringParametersDecodeErrorZ which has the same data as `orig`
13312 * but with all dynamically-allocated buffers duplicated in new buffers.
13314 struct LDKCResult_ProbabilisticScoringParametersDecodeErrorZ CResult_ProbabilisticScoringParametersDecodeErrorZ_clone(const struct LDKCResult_ProbabilisticScoringParametersDecodeErrorZ *NONNULL_PTR orig);
13317 * Creates a new CResult_InitFeaturesDecodeErrorZ in the success state.
13319 struct LDKCResult_InitFeaturesDecodeErrorZ CResult_InitFeaturesDecodeErrorZ_ok(struct LDKInitFeatures o);
13322 * Creates a new CResult_InitFeaturesDecodeErrorZ in the error state.
13324 struct LDKCResult_InitFeaturesDecodeErrorZ CResult_InitFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
13327 * Checks if the given object is currently in the success state
13329 bool CResult_InitFeaturesDecodeErrorZ_is_ok(const struct LDKCResult_InitFeaturesDecodeErrorZ *NONNULL_PTR o);
13332 * Frees any resources used by the CResult_InitFeaturesDecodeErrorZ.
13334 void CResult_InitFeaturesDecodeErrorZ_free(struct LDKCResult_InitFeaturesDecodeErrorZ _res);
13337 * Creates a new CResult_ChannelFeaturesDecodeErrorZ in the success state.
13339 struct LDKCResult_ChannelFeaturesDecodeErrorZ CResult_ChannelFeaturesDecodeErrorZ_ok(struct LDKChannelFeatures o);
13342 * Creates a new CResult_ChannelFeaturesDecodeErrorZ in the error state.
13344 struct LDKCResult_ChannelFeaturesDecodeErrorZ CResult_ChannelFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
13347 * Checks if the given object is currently in the success state
13349 bool CResult_ChannelFeaturesDecodeErrorZ_is_ok(const struct LDKCResult_ChannelFeaturesDecodeErrorZ *NONNULL_PTR o);
13352 * Frees any resources used by the CResult_ChannelFeaturesDecodeErrorZ.
13354 void CResult_ChannelFeaturesDecodeErrorZ_free(struct LDKCResult_ChannelFeaturesDecodeErrorZ _res);
13357 * Creates a new CResult_NodeFeaturesDecodeErrorZ in the success state.
13359 struct LDKCResult_NodeFeaturesDecodeErrorZ CResult_NodeFeaturesDecodeErrorZ_ok(struct LDKNodeFeatures o);
13362 * Creates a new CResult_NodeFeaturesDecodeErrorZ in the error state.
13364 struct LDKCResult_NodeFeaturesDecodeErrorZ CResult_NodeFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
13367 * Checks if the given object is currently in the success state
13369 bool CResult_NodeFeaturesDecodeErrorZ_is_ok(const struct LDKCResult_NodeFeaturesDecodeErrorZ *NONNULL_PTR o);
13372 * Frees any resources used by the CResult_NodeFeaturesDecodeErrorZ.
13374 void CResult_NodeFeaturesDecodeErrorZ_free(struct LDKCResult_NodeFeaturesDecodeErrorZ _res);
13377 * Creates a new CResult_InvoiceFeaturesDecodeErrorZ in the success state.
13379 struct LDKCResult_InvoiceFeaturesDecodeErrorZ CResult_InvoiceFeaturesDecodeErrorZ_ok(struct LDKInvoiceFeatures o);
13382 * Creates a new CResult_InvoiceFeaturesDecodeErrorZ in the error state.
13384 struct LDKCResult_InvoiceFeaturesDecodeErrorZ CResult_InvoiceFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
13387 * Checks if the given object is currently in the success state
13389 bool CResult_InvoiceFeaturesDecodeErrorZ_is_ok(const struct LDKCResult_InvoiceFeaturesDecodeErrorZ *NONNULL_PTR o);
13392 * Frees any resources used by the CResult_InvoiceFeaturesDecodeErrorZ.
13394 void CResult_InvoiceFeaturesDecodeErrorZ_free(struct LDKCResult_InvoiceFeaturesDecodeErrorZ _res);
13397 * Creates a new CResult_ChannelTypeFeaturesDecodeErrorZ in the success state.
13399 struct LDKCResult_ChannelTypeFeaturesDecodeErrorZ CResult_ChannelTypeFeaturesDecodeErrorZ_ok(struct LDKChannelTypeFeatures o);
13402 * Creates a new CResult_ChannelTypeFeaturesDecodeErrorZ in the error state.
13404 struct LDKCResult_ChannelTypeFeaturesDecodeErrorZ CResult_ChannelTypeFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
13407 * Checks if the given object is currently in the success state
13409 bool CResult_ChannelTypeFeaturesDecodeErrorZ_is_ok(const struct LDKCResult_ChannelTypeFeaturesDecodeErrorZ *NONNULL_PTR o);
13412 * Frees any resources used by the CResult_ChannelTypeFeaturesDecodeErrorZ.
13414 void CResult_ChannelTypeFeaturesDecodeErrorZ_free(struct LDKCResult_ChannelTypeFeaturesDecodeErrorZ _res);
13417 * Creates a new CResult_DelayedPaymentOutputDescriptorDecodeErrorZ in the success state.
13419 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_ok(struct LDKDelayedPaymentOutputDescriptor o);
13422 * Creates a new CResult_DelayedPaymentOutputDescriptorDecodeErrorZ in the error state.
13424 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e);
13427 * Checks if the given object is currently in the success state
13429 bool CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_is_ok(const struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ *NONNULL_PTR o);
13432 * Frees any resources used by the CResult_DelayedPaymentOutputDescriptorDecodeErrorZ.
13434 void CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_free(struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ _res);
13437 * Creates a new CResult_DelayedPaymentOutputDescriptorDecodeErrorZ which has the same data as `orig`
13438 * but with all dynamically-allocated buffers duplicated in new buffers.
13440 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ *NONNULL_PTR orig);
13443 * Creates a new CResult_StaticPaymentOutputDescriptorDecodeErrorZ in the success state.
13445 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ CResult_StaticPaymentOutputDescriptorDecodeErrorZ_ok(struct LDKStaticPaymentOutputDescriptor o);
13448 * Creates a new CResult_StaticPaymentOutputDescriptorDecodeErrorZ in the error state.
13450 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ CResult_StaticPaymentOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e);
13453 * Checks if the given object is currently in the success state
13455 bool CResult_StaticPaymentOutputDescriptorDecodeErrorZ_is_ok(const struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ *NONNULL_PTR o);
13458 * Frees any resources used by the CResult_StaticPaymentOutputDescriptorDecodeErrorZ.
13460 void CResult_StaticPaymentOutputDescriptorDecodeErrorZ_free(struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ _res);
13463 * Creates a new CResult_StaticPaymentOutputDescriptorDecodeErrorZ which has the same data as `orig`
13464 * but with all dynamically-allocated buffers duplicated in new buffers.
13466 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ CResult_StaticPaymentOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ *NONNULL_PTR orig);
13469 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ in the success state.
13471 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_ok(struct LDKSpendableOutputDescriptor o);
13474 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ in the error state.
13476 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e);
13479 * Checks if the given object is currently in the success state
13481 bool CResult_SpendableOutputDescriptorDecodeErrorZ_is_ok(const struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ *NONNULL_PTR o);
13484 * Frees any resources used by the CResult_SpendableOutputDescriptorDecodeErrorZ.
13486 void CResult_SpendableOutputDescriptorDecodeErrorZ_free(struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ _res);
13489 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ which has the same data as `orig`
13490 * but with all dynamically-allocated buffers duplicated in new buffers.
13492 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ *NONNULL_PTR orig);
13495 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13497 void CVec_PaymentPreimageZ_free(struct LDKCVec_PaymentPreimageZ _res);
13500 * Creates a new tuple which has the same data as `orig`
13501 * but with all dynamically-allocated buffers duplicated in new buffers.
13503 struct LDKC2Tuple_SignatureCVec_SignatureZZ C2Tuple_SignatureCVec_SignatureZZ_clone(const struct LDKC2Tuple_SignatureCVec_SignatureZZ *NONNULL_PTR orig);
13506 * Creates a new C2Tuple_SignatureCVec_SignatureZZ from the contained elements.
13508 struct LDKC2Tuple_SignatureCVec_SignatureZZ C2Tuple_SignatureCVec_SignatureZZ_new(struct LDKSignature a, struct LDKCVec_SignatureZ b);
13511 * Frees any resources used by the C2Tuple_SignatureCVec_SignatureZZ.
13513 void C2Tuple_SignatureCVec_SignatureZZ_free(struct LDKC2Tuple_SignatureCVec_SignatureZZ _res);
13516 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ in the success state.
13518 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_ok(struct LDKC2Tuple_SignatureCVec_SignatureZZ o);
13521 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ in the error state.
13523 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_err(void);
13526 * Checks if the given object is currently in the success state
13528 bool CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_is_ok(const struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ *NONNULL_PTR o);
13531 * Frees any resources used by the CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ.
13533 void CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_free(struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ _res);
13536 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ which has the same data as `orig`
13537 * but with all dynamically-allocated buffers duplicated in new buffers.
13539 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_clone(const struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ *NONNULL_PTR orig);
13542 * Creates a new CResult_SignatureNoneZ in the success state.
13544 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_ok(struct LDKSignature o);
13547 * Creates a new CResult_SignatureNoneZ in the error state.
13549 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_err(void);
13552 * Checks if the given object is currently in the success state
13554 bool CResult_SignatureNoneZ_is_ok(const struct LDKCResult_SignatureNoneZ *NONNULL_PTR o);
13557 * Frees any resources used by the CResult_SignatureNoneZ.
13559 void CResult_SignatureNoneZ_free(struct LDKCResult_SignatureNoneZ _res);
13562 * Creates a new CResult_SignatureNoneZ which has the same data as `orig`
13563 * but with all dynamically-allocated buffers duplicated in new buffers.
13565 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_clone(const struct LDKCResult_SignatureNoneZ *NONNULL_PTR orig);
13568 * Creates a new tuple which has the same data as `orig`
13569 * but with all dynamically-allocated buffers duplicated in new buffers.
13571 struct LDKC2Tuple_SignatureSignatureZ C2Tuple_SignatureSignatureZ_clone(const struct LDKC2Tuple_SignatureSignatureZ *NONNULL_PTR orig);
13574 * Creates a new C2Tuple_SignatureSignatureZ from the contained elements.
13576 struct LDKC2Tuple_SignatureSignatureZ C2Tuple_SignatureSignatureZ_new(struct LDKSignature a, struct LDKSignature b);
13579 * Frees any resources used by the C2Tuple_SignatureSignatureZ.
13581 void C2Tuple_SignatureSignatureZ_free(struct LDKC2Tuple_SignatureSignatureZ _res);
13584 * Creates a new CResult_C2Tuple_SignatureSignatureZNoneZ in the success state.
13586 struct LDKCResult_C2Tuple_SignatureSignatureZNoneZ CResult_C2Tuple_SignatureSignatureZNoneZ_ok(struct LDKC2Tuple_SignatureSignatureZ o);
13589 * Creates a new CResult_C2Tuple_SignatureSignatureZNoneZ in the error state.
13591 struct LDKCResult_C2Tuple_SignatureSignatureZNoneZ CResult_C2Tuple_SignatureSignatureZNoneZ_err(void);
13594 * Checks if the given object is currently in the success state
13596 bool CResult_C2Tuple_SignatureSignatureZNoneZ_is_ok(const struct LDKCResult_C2Tuple_SignatureSignatureZNoneZ *NONNULL_PTR o);
13599 * Frees any resources used by the CResult_C2Tuple_SignatureSignatureZNoneZ.
13601 void CResult_C2Tuple_SignatureSignatureZNoneZ_free(struct LDKCResult_C2Tuple_SignatureSignatureZNoneZ _res);
13604 * Creates a new CResult_C2Tuple_SignatureSignatureZNoneZ which has the same data as `orig`
13605 * but with all dynamically-allocated buffers duplicated in new buffers.
13607 struct LDKCResult_C2Tuple_SignatureSignatureZNoneZ CResult_C2Tuple_SignatureSignatureZNoneZ_clone(const struct LDKCResult_C2Tuple_SignatureSignatureZNoneZ *NONNULL_PTR orig);
13610 * Creates a new CResult_SecretKeyNoneZ in the success state.
13612 struct LDKCResult_SecretKeyNoneZ CResult_SecretKeyNoneZ_ok(struct LDKSecretKey o);
13615 * Creates a new CResult_SecretKeyNoneZ in the error state.
13617 struct LDKCResult_SecretKeyNoneZ CResult_SecretKeyNoneZ_err(void);
13620 * Checks if the given object is currently in the success state
13622 bool CResult_SecretKeyNoneZ_is_ok(const struct LDKCResult_SecretKeyNoneZ *NONNULL_PTR o);
13625 * Frees any resources used by the CResult_SecretKeyNoneZ.
13627 void CResult_SecretKeyNoneZ_free(struct LDKCResult_SecretKeyNoneZ _res);
13630 * Creates a new CResult_SignDecodeErrorZ in the success state.
13632 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_ok(struct LDKSign o);
13635 * Creates a new CResult_SignDecodeErrorZ in the error state.
13637 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_err(struct LDKDecodeError e);
13640 * Checks if the given object is currently in the success state
13642 bool CResult_SignDecodeErrorZ_is_ok(const struct LDKCResult_SignDecodeErrorZ *NONNULL_PTR o);
13645 * Frees any resources used by the CResult_SignDecodeErrorZ.
13647 void CResult_SignDecodeErrorZ_free(struct LDKCResult_SignDecodeErrorZ _res);
13650 * Creates a new CResult_SignDecodeErrorZ which has the same data as `orig`
13651 * but with all dynamically-allocated buffers duplicated in new buffers.
13653 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_clone(const struct LDKCResult_SignDecodeErrorZ *NONNULL_PTR orig);
13656 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13658 void CVec_u5Z_free(struct LDKCVec_u5Z _res);
13661 * Creates a new CResult_RecoverableSignatureNoneZ in the success state.
13663 struct LDKCResult_RecoverableSignatureNoneZ CResult_RecoverableSignatureNoneZ_ok(struct LDKRecoverableSignature o);
13666 * Creates a new CResult_RecoverableSignatureNoneZ in the error state.
13668 struct LDKCResult_RecoverableSignatureNoneZ CResult_RecoverableSignatureNoneZ_err(void);
13671 * Checks if the given object is currently in the success state
13673 bool CResult_RecoverableSignatureNoneZ_is_ok(const struct LDKCResult_RecoverableSignatureNoneZ *NONNULL_PTR o);
13676 * Frees any resources used by the CResult_RecoverableSignatureNoneZ.
13678 void CResult_RecoverableSignatureNoneZ_free(struct LDKCResult_RecoverableSignatureNoneZ _res);
13681 * Creates a new CResult_RecoverableSignatureNoneZ which has the same data as `orig`
13682 * but with all dynamically-allocated buffers duplicated in new buffers.
13684 struct LDKCResult_RecoverableSignatureNoneZ CResult_RecoverableSignatureNoneZ_clone(const struct LDKCResult_RecoverableSignatureNoneZ *NONNULL_PTR orig);
13687 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13689 void CVec_u8Z_free(struct LDKCVec_u8Z _res);
13692 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13694 void CVec_CVec_u8ZZ_free(struct LDKCVec_CVec_u8ZZ _res);
13697 * Creates a new CResult_CVec_CVec_u8ZZNoneZ in the success state.
13699 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_ok(struct LDKCVec_CVec_u8ZZ o);
13702 * Creates a new CResult_CVec_CVec_u8ZZNoneZ in the error state.
13704 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_err(void);
13707 * Checks if the given object is currently in the success state
13709 bool CResult_CVec_CVec_u8ZZNoneZ_is_ok(const struct LDKCResult_CVec_CVec_u8ZZNoneZ *NONNULL_PTR o);
13712 * Frees any resources used by the CResult_CVec_CVec_u8ZZNoneZ.
13714 void CResult_CVec_CVec_u8ZZNoneZ_free(struct LDKCResult_CVec_CVec_u8ZZNoneZ _res);
13717 * Creates a new CResult_CVec_CVec_u8ZZNoneZ which has the same data as `orig`
13718 * but with all dynamically-allocated buffers duplicated in new buffers.
13720 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_clone(const struct LDKCResult_CVec_CVec_u8ZZNoneZ *NONNULL_PTR orig);
13723 * Creates a new CResult_InMemorySignerDecodeErrorZ in the success state.
13725 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_ok(struct LDKInMemorySigner o);
13728 * Creates a new CResult_InMemorySignerDecodeErrorZ in the error state.
13730 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_err(struct LDKDecodeError e);
13733 * Checks if the given object is currently in the success state
13735 bool CResult_InMemorySignerDecodeErrorZ_is_ok(const struct LDKCResult_InMemorySignerDecodeErrorZ *NONNULL_PTR o);
13738 * Frees any resources used by the CResult_InMemorySignerDecodeErrorZ.
13740 void CResult_InMemorySignerDecodeErrorZ_free(struct LDKCResult_InMemorySignerDecodeErrorZ _res);
13743 * Creates a new CResult_InMemorySignerDecodeErrorZ which has the same data as `orig`
13744 * but with all dynamically-allocated buffers duplicated in new buffers.
13746 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_clone(const struct LDKCResult_InMemorySignerDecodeErrorZ *NONNULL_PTR orig);
13749 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13751 void CVec_TxOutZ_free(struct LDKCVec_TxOutZ _res);
13754 * Creates a new CResult_TransactionNoneZ in the success state.
13756 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_ok(struct LDKTransaction o);
13759 * Creates a new CResult_TransactionNoneZ in the error state.
13761 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_err(void);
13764 * Checks if the given object is currently in the success state
13766 bool CResult_TransactionNoneZ_is_ok(const struct LDKCResult_TransactionNoneZ *NONNULL_PTR o);
13769 * Frees any resources used by the CResult_TransactionNoneZ.
13771 void CResult_TransactionNoneZ_free(struct LDKCResult_TransactionNoneZ _res);
13774 * Creates a new CResult_TransactionNoneZ which has the same data as `orig`
13775 * but with all dynamically-allocated buffers duplicated in new buffers.
13777 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_clone(const struct LDKCResult_TransactionNoneZ *NONNULL_PTR orig);
13780 * Creates a new C2Tuple_BlockHashChannelMonitorZ from the contained elements.
13782 struct LDKC2Tuple_BlockHashChannelMonitorZ C2Tuple_BlockHashChannelMonitorZ_new(struct LDKThirtyTwoBytes a, struct LDKChannelMonitor b);
13785 * Frees any resources used by the C2Tuple_BlockHashChannelMonitorZ.
13787 void C2Tuple_BlockHashChannelMonitorZ_free(struct LDKC2Tuple_BlockHashChannelMonitorZ _res);
13790 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13792 void CVec_C2Tuple_BlockHashChannelMonitorZZ_free(struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ _res);
13795 * Creates a new CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ in the success state.
13797 struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_ok(struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ o);
13800 * Creates a new CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ in the error state.
13802 struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_err(enum LDKIOError e);
13805 * Checks if the given object is currently in the success state
13807 bool CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_is_ok(const struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ *NONNULL_PTR o);
13810 * Frees any resources used by the CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ.
13812 void CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_free(struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ _res);
13815 * Constructs a new COption_u16Z containing a u16
13817 struct LDKCOption_u16Z COption_u16Z_some(uint16_t o);
13820 * Constructs a new COption_u16Z containing nothing
13822 struct LDKCOption_u16Z COption_u16Z_none(void);
13825 * Frees any resources associated with the u16, if we are in the Some state
13827 void COption_u16Z_free(struct LDKCOption_u16Z _res);
13830 * Creates a new COption_u16Z which has the same data as `orig`
13831 * but with all dynamically-allocated buffers duplicated in new buffers.
13833 struct LDKCOption_u16Z COption_u16Z_clone(const struct LDKCOption_u16Z *NONNULL_PTR orig);
13836 * Creates a new CResult_NoneAPIErrorZ in the success state.
13838 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_ok(void);
13841 * Creates a new CResult_NoneAPIErrorZ in the error state.
13843 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_err(struct LDKAPIError e);
13846 * Checks if the given object is currently in the success state
13848 bool CResult_NoneAPIErrorZ_is_ok(const struct LDKCResult_NoneAPIErrorZ *NONNULL_PTR o);
13851 * Frees any resources used by the CResult_NoneAPIErrorZ.
13853 void CResult_NoneAPIErrorZ_free(struct LDKCResult_NoneAPIErrorZ _res);
13856 * Creates a new CResult_NoneAPIErrorZ which has the same data as `orig`
13857 * but with all dynamically-allocated buffers duplicated in new buffers.
13859 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_clone(const struct LDKCResult_NoneAPIErrorZ *NONNULL_PTR orig);
13862 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13864 void CVec_CResult_NoneAPIErrorZZ_free(struct LDKCVec_CResult_NoneAPIErrorZZ _res);
13867 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13869 void CVec_APIErrorZ_free(struct LDKCVec_APIErrorZ _res);
13872 * Creates a new CResult__u832APIErrorZ in the success state.
13874 struct LDKCResult__u832APIErrorZ CResult__u832APIErrorZ_ok(struct LDKThirtyTwoBytes o);
13877 * Creates a new CResult__u832APIErrorZ in the error state.
13879 struct LDKCResult__u832APIErrorZ CResult__u832APIErrorZ_err(struct LDKAPIError e);
13882 * Checks if the given object is currently in the success state
13884 bool CResult__u832APIErrorZ_is_ok(const struct LDKCResult__u832APIErrorZ *NONNULL_PTR o);
13887 * Frees any resources used by the CResult__u832APIErrorZ.
13889 void CResult__u832APIErrorZ_free(struct LDKCResult__u832APIErrorZ _res);
13892 * Creates a new CResult__u832APIErrorZ which has the same data as `orig`
13893 * but with all dynamically-allocated buffers duplicated in new buffers.
13895 struct LDKCResult__u832APIErrorZ CResult__u832APIErrorZ_clone(const struct LDKCResult__u832APIErrorZ *NONNULL_PTR orig);
13898 * Creates a new CResult_PaymentIdPaymentSendFailureZ in the success state.
13900 struct LDKCResult_PaymentIdPaymentSendFailureZ CResult_PaymentIdPaymentSendFailureZ_ok(struct LDKThirtyTwoBytes o);
13903 * Creates a new CResult_PaymentIdPaymentSendFailureZ in the error state.
13905 struct LDKCResult_PaymentIdPaymentSendFailureZ CResult_PaymentIdPaymentSendFailureZ_err(struct LDKPaymentSendFailure e);
13908 * Checks if the given object is currently in the success state
13910 bool CResult_PaymentIdPaymentSendFailureZ_is_ok(const struct LDKCResult_PaymentIdPaymentSendFailureZ *NONNULL_PTR o);
13913 * Frees any resources used by the CResult_PaymentIdPaymentSendFailureZ.
13915 void CResult_PaymentIdPaymentSendFailureZ_free(struct LDKCResult_PaymentIdPaymentSendFailureZ _res);
13918 * Creates a new CResult_PaymentIdPaymentSendFailureZ which has the same data as `orig`
13919 * but with all dynamically-allocated buffers duplicated in new buffers.
13921 struct LDKCResult_PaymentIdPaymentSendFailureZ CResult_PaymentIdPaymentSendFailureZ_clone(const struct LDKCResult_PaymentIdPaymentSendFailureZ *NONNULL_PTR orig);
13924 * Creates a new CResult_NonePaymentSendFailureZ in the success state.
13926 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_ok(void);
13929 * Creates a new CResult_NonePaymentSendFailureZ in the error state.
13931 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_err(struct LDKPaymentSendFailure e);
13934 * Checks if the given object is currently in the success state
13936 bool CResult_NonePaymentSendFailureZ_is_ok(const struct LDKCResult_NonePaymentSendFailureZ *NONNULL_PTR o);
13939 * Frees any resources used by the CResult_NonePaymentSendFailureZ.
13941 void CResult_NonePaymentSendFailureZ_free(struct LDKCResult_NonePaymentSendFailureZ _res);
13944 * Creates a new CResult_NonePaymentSendFailureZ which has the same data as `orig`
13945 * but with all dynamically-allocated buffers duplicated in new buffers.
13947 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_clone(const struct LDKCResult_NonePaymentSendFailureZ *NONNULL_PTR orig);
13950 * Creates a new tuple which has the same data as `orig`
13951 * but with all dynamically-allocated buffers duplicated in new buffers.
13953 struct LDKC2Tuple_PaymentHashPaymentIdZ C2Tuple_PaymentHashPaymentIdZ_clone(const struct LDKC2Tuple_PaymentHashPaymentIdZ *NONNULL_PTR orig);
13956 * Creates a new C2Tuple_PaymentHashPaymentIdZ from the contained elements.
13958 struct LDKC2Tuple_PaymentHashPaymentIdZ C2Tuple_PaymentHashPaymentIdZ_new(struct LDKThirtyTwoBytes a, struct LDKThirtyTwoBytes b);
13961 * Frees any resources used by the C2Tuple_PaymentHashPaymentIdZ.
13963 void C2Tuple_PaymentHashPaymentIdZ_free(struct LDKC2Tuple_PaymentHashPaymentIdZ _res);
13966 * Creates a new CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ in the success state.
13968 struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ_ok(struct LDKC2Tuple_PaymentHashPaymentIdZ o);
13971 * Creates a new CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ in the error state.
13973 struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ_err(struct LDKPaymentSendFailure e);
13976 * Checks if the given object is currently in the success state
13978 bool CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ_is_ok(const struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ *NONNULL_PTR o);
13981 * Frees any resources used by the CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ.
13983 void CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ_free(struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ _res);
13986 * Creates a new CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ which has the same data as `orig`
13987 * but with all dynamically-allocated buffers duplicated in new buffers.
13989 struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ_clone(const struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ *NONNULL_PTR orig);
13992 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13994 void CVec_NetAddressZ_free(struct LDKCVec_NetAddressZ _res);
13997 * Creates a new tuple which has the same data as `orig`
13998 * but with all dynamically-allocated buffers duplicated in new buffers.
14000 struct LDKC2Tuple_PaymentHashPaymentSecretZ C2Tuple_PaymentHashPaymentSecretZ_clone(const struct LDKC2Tuple_PaymentHashPaymentSecretZ *NONNULL_PTR orig);
14003 * Creates a new C2Tuple_PaymentHashPaymentSecretZ from the contained elements.
14005 struct LDKC2Tuple_PaymentHashPaymentSecretZ C2Tuple_PaymentHashPaymentSecretZ_new(struct LDKThirtyTwoBytes a, struct LDKThirtyTwoBytes b);
14008 * Frees any resources used by the C2Tuple_PaymentHashPaymentSecretZ.
14010 void C2Tuple_PaymentHashPaymentSecretZ_free(struct LDKC2Tuple_PaymentHashPaymentSecretZ _res);
14013 * Creates a new CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ in the success state.
14015 struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ_ok(struct LDKC2Tuple_PaymentHashPaymentSecretZ o);
14018 * Creates a new CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ in the error state.
14020 struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ_err(void);
14023 * Checks if the given object is currently in the success state
14025 bool CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ_is_ok(const struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ *NONNULL_PTR o);
14028 * Frees any resources used by the CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ.
14030 void CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ_free(struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ _res);
14033 * Creates a new CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ which has the same data as `orig`
14034 * but with all dynamically-allocated buffers duplicated in new buffers.
14036 struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ_clone(const struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ *NONNULL_PTR orig);
14039 * Creates a new CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ in the success state.
14041 struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ_ok(struct LDKC2Tuple_PaymentHashPaymentSecretZ o);
14044 * Creates a new CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ in the error state.
14046 struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ_err(struct LDKAPIError e);
14049 * Checks if the given object is currently in the success state
14051 bool CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ_is_ok(const struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ *NONNULL_PTR o);
14054 * Frees any resources used by the CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ.
14056 void CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ_free(struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ _res);
14059 * Creates a new CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ which has the same data as `orig`
14060 * but with all dynamically-allocated buffers duplicated in new buffers.
14062 struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ_clone(const struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ *NONNULL_PTR orig);
14065 * Creates a new CResult_PaymentSecretNoneZ in the success state.
14067 struct LDKCResult_PaymentSecretNoneZ CResult_PaymentSecretNoneZ_ok(struct LDKThirtyTwoBytes o);
14070 * Creates a new CResult_PaymentSecretNoneZ in the error state.
14072 struct LDKCResult_PaymentSecretNoneZ CResult_PaymentSecretNoneZ_err(void);
14075 * Checks if the given object is currently in the success state
14077 bool CResult_PaymentSecretNoneZ_is_ok(const struct LDKCResult_PaymentSecretNoneZ *NONNULL_PTR o);
14080 * Frees any resources used by the CResult_PaymentSecretNoneZ.
14082 void CResult_PaymentSecretNoneZ_free(struct LDKCResult_PaymentSecretNoneZ _res);
14085 * Creates a new CResult_PaymentSecretNoneZ which has the same data as `orig`
14086 * but with all dynamically-allocated buffers duplicated in new buffers.
14088 struct LDKCResult_PaymentSecretNoneZ CResult_PaymentSecretNoneZ_clone(const struct LDKCResult_PaymentSecretNoneZ *NONNULL_PTR orig);
14091 * Creates a new CResult_PaymentSecretAPIErrorZ in the success state.
14093 struct LDKCResult_PaymentSecretAPIErrorZ CResult_PaymentSecretAPIErrorZ_ok(struct LDKThirtyTwoBytes o);
14096 * Creates a new CResult_PaymentSecretAPIErrorZ in the error state.
14098 struct LDKCResult_PaymentSecretAPIErrorZ CResult_PaymentSecretAPIErrorZ_err(struct LDKAPIError e);
14101 * Checks if the given object is currently in the success state
14103 bool CResult_PaymentSecretAPIErrorZ_is_ok(const struct LDKCResult_PaymentSecretAPIErrorZ *NONNULL_PTR o);
14106 * Frees any resources used by the CResult_PaymentSecretAPIErrorZ.
14108 void CResult_PaymentSecretAPIErrorZ_free(struct LDKCResult_PaymentSecretAPIErrorZ _res);
14111 * Creates a new CResult_PaymentSecretAPIErrorZ which has the same data as `orig`
14112 * but with all dynamically-allocated buffers duplicated in new buffers.
14114 struct LDKCResult_PaymentSecretAPIErrorZ CResult_PaymentSecretAPIErrorZ_clone(const struct LDKCResult_PaymentSecretAPIErrorZ *NONNULL_PTR orig);
14117 * Creates a new CResult_PaymentPreimageAPIErrorZ in the success state.
14119 struct LDKCResult_PaymentPreimageAPIErrorZ CResult_PaymentPreimageAPIErrorZ_ok(struct LDKThirtyTwoBytes o);
14122 * Creates a new CResult_PaymentPreimageAPIErrorZ in the error state.
14124 struct LDKCResult_PaymentPreimageAPIErrorZ CResult_PaymentPreimageAPIErrorZ_err(struct LDKAPIError e);
14127 * Checks if the given object is currently in the success state
14129 bool CResult_PaymentPreimageAPIErrorZ_is_ok(const struct LDKCResult_PaymentPreimageAPIErrorZ *NONNULL_PTR o);
14132 * Frees any resources used by the CResult_PaymentPreimageAPIErrorZ.
14134 void CResult_PaymentPreimageAPIErrorZ_free(struct LDKCResult_PaymentPreimageAPIErrorZ _res);
14137 * Creates a new CResult_PaymentPreimageAPIErrorZ which has the same data as `orig`
14138 * but with all dynamically-allocated buffers duplicated in new buffers.
14140 struct LDKCResult_PaymentPreimageAPIErrorZ CResult_PaymentPreimageAPIErrorZ_clone(const struct LDKCResult_PaymentPreimageAPIErrorZ *NONNULL_PTR orig);
14143 * Creates a new CResult_CounterpartyForwardingInfoDecodeErrorZ in the success state.
14145 struct LDKCResult_CounterpartyForwardingInfoDecodeErrorZ CResult_CounterpartyForwardingInfoDecodeErrorZ_ok(struct LDKCounterpartyForwardingInfo o);
14148 * Creates a new CResult_CounterpartyForwardingInfoDecodeErrorZ in the error state.
14150 struct LDKCResult_CounterpartyForwardingInfoDecodeErrorZ CResult_CounterpartyForwardingInfoDecodeErrorZ_err(struct LDKDecodeError e);
14153 * Checks if the given object is currently in the success state
14155 bool CResult_CounterpartyForwardingInfoDecodeErrorZ_is_ok(const struct LDKCResult_CounterpartyForwardingInfoDecodeErrorZ *NONNULL_PTR o);
14158 * Frees any resources used by the CResult_CounterpartyForwardingInfoDecodeErrorZ.
14160 void CResult_CounterpartyForwardingInfoDecodeErrorZ_free(struct LDKCResult_CounterpartyForwardingInfoDecodeErrorZ _res);
14163 * Creates a new CResult_CounterpartyForwardingInfoDecodeErrorZ which has the same data as `orig`
14164 * but with all dynamically-allocated buffers duplicated in new buffers.
14166 struct LDKCResult_CounterpartyForwardingInfoDecodeErrorZ CResult_CounterpartyForwardingInfoDecodeErrorZ_clone(const struct LDKCResult_CounterpartyForwardingInfoDecodeErrorZ *NONNULL_PTR orig);
14169 * Creates a new CResult_ChannelCounterpartyDecodeErrorZ in the success state.
14171 struct LDKCResult_ChannelCounterpartyDecodeErrorZ CResult_ChannelCounterpartyDecodeErrorZ_ok(struct LDKChannelCounterparty o);
14174 * Creates a new CResult_ChannelCounterpartyDecodeErrorZ in the error state.
14176 struct LDKCResult_ChannelCounterpartyDecodeErrorZ CResult_ChannelCounterpartyDecodeErrorZ_err(struct LDKDecodeError e);
14179 * Checks if the given object is currently in the success state
14181 bool CResult_ChannelCounterpartyDecodeErrorZ_is_ok(const struct LDKCResult_ChannelCounterpartyDecodeErrorZ *NONNULL_PTR o);
14184 * Frees any resources used by the CResult_ChannelCounterpartyDecodeErrorZ.
14186 void CResult_ChannelCounterpartyDecodeErrorZ_free(struct LDKCResult_ChannelCounterpartyDecodeErrorZ _res);
14189 * Creates a new CResult_ChannelCounterpartyDecodeErrorZ which has the same data as `orig`
14190 * but with all dynamically-allocated buffers duplicated in new buffers.
14192 struct LDKCResult_ChannelCounterpartyDecodeErrorZ CResult_ChannelCounterpartyDecodeErrorZ_clone(const struct LDKCResult_ChannelCounterpartyDecodeErrorZ *NONNULL_PTR orig);
14195 * Creates a new CResult_ChannelDetailsDecodeErrorZ in the success state.
14197 struct LDKCResult_ChannelDetailsDecodeErrorZ CResult_ChannelDetailsDecodeErrorZ_ok(struct LDKChannelDetails o);
14200 * Creates a new CResult_ChannelDetailsDecodeErrorZ in the error state.
14202 struct LDKCResult_ChannelDetailsDecodeErrorZ CResult_ChannelDetailsDecodeErrorZ_err(struct LDKDecodeError e);
14205 * Checks if the given object is currently in the success state
14207 bool CResult_ChannelDetailsDecodeErrorZ_is_ok(const struct LDKCResult_ChannelDetailsDecodeErrorZ *NONNULL_PTR o);
14210 * Frees any resources used by the CResult_ChannelDetailsDecodeErrorZ.
14212 void CResult_ChannelDetailsDecodeErrorZ_free(struct LDKCResult_ChannelDetailsDecodeErrorZ _res);
14215 * Creates a new CResult_ChannelDetailsDecodeErrorZ which has the same data as `orig`
14216 * but with all dynamically-allocated buffers duplicated in new buffers.
14218 struct LDKCResult_ChannelDetailsDecodeErrorZ CResult_ChannelDetailsDecodeErrorZ_clone(const struct LDKCResult_ChannelDetailsDecodeErrorZ *NONNULL_PTR orig);
14221 * Creates a new CResult_PhantomRouteHintsDecodeErrorZ in the success state.
14223 struct LDKCResult_PhantomRouteHintsDecodeErrorZ CResult_PhantomRouteHintsDecodeErrorZ_ok(struct LDKPhantomRouteHints o);
14226 * Creates a new CResult_PhantomRouteHintsDecodeErrorZ in the error state.
14228 struct LDKCResult_PhantomRouteHintsDecodeErrorZ CResult_PhantomRouteHintsDecodeErrorZ_err(struct LDKDecodeError e);
14231 * Checks if the given object is currently in the success state
14233 bool CResult_PhantomRouteHintsDecodeErrorZ_is_ok(const struct LDKCResult_PhantomRouteHintsDecodeErrorZ *NONNULL_PTR o);
14236 * Frees any resources used by the CResult_PhantomRouteHintsDecodeErrorZ.
14238 void CResult_PhantomRouteHintsDecodeErrorZ_free(struct LDKCResult_PhantomRouteHintsDecodeErrorZ _res);
14241 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14243 void CVec_ChannelMonitorZ_free(struct LDKCVec_ChannelMonitorZ _res);
14246 * Creates a new C2Tuple_BlockHashChannelManagerZ from the contained elements.
14248 struct LDKC2Tuple_BlockHashChannelManagerZ C2Tuple_BlockHashChannelManagerZ_new(struct LDKThirtyTwoBytes a, struct LDKChannelManager b);
14251 * Frees any resources used by the C2Tuple_BlockHashChannelManagerZ.
14253 void C2Tuple_BlockHashChannelManagerZ_free(struct LDKC2Tuple_BlockHashChannelManagerZ _res);
14256 * Creates a new CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ in the success state.
14258 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_ok(struct LDKC2Tuple_BlockHashChannelManagerZ o);
14261 * Creates a new CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ in the error state.
14263 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_err(struct LDKDecodeError e);
14266 * Checks if the given object is currently in the success state
14268 bool CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_is_ok(const struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ *NONNULL_PTR o);
14271 * Frees any resources used by the CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.
14273 void CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_free(struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ _res);
14276 * Creates a new CResult_ChannelConfigDecodeErrorZ in the success state.
14278 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_ok(struct LDKChannelConfig o);
14281 * Creates a new CResult_ChannelConfigDecodeErrorZ in the error state.
14283 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_err(struct LDKDecodeError e);
14286 * Checks if the given object is currently in the success state
14288 bool CResult_ChannelConfigDecodeErrorZ_is_ok(const struct LDKCResult_ChannelConfigDecodeErrorZ *NONNULL_PTR o);
14291 * Frees any resources used by the CResult_ChannelConfigDecodeErrorZ.
14293 void CResult_ChannelConfigDecodeErrorZ_free(struct LDKCResult_ChannelConfigDecodeErrorZ _res);
14296 * Creates a new CResult_ChannelConfigDecodeErrorZ which has the same data as `orig`
14297 * but with all dynamically-allocated buffers duplicated in new buffers.
14299 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_clone(const struct LDKCResult_ChannelConfigDecodeErrorZ *NONNULL_PTR orig);
14302 * Creates a new CResult_OutPointDecodeErrorZ in the success state.
14304 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_ok(struct LDKOutPoint o);
14307 * Creates a new CResult_OutPointDecodeErrorZ in the error state.
14309 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_err(struct LDKDecodeError e);
14312 * Checks if the given object is currently in the success state
14314 bool CResult_OutPointDecodeErrorZ_is_ok(const struct LDKCResult_OutPointDecodeErrorZ *NONNULL_PTR o);
14317 * Frees any resources used by the CResult_OutPointDecodeErrorZ.
14319 void CResult_OutPointDecodeErrorZ_free(struct LDKCResult_OutPointDecodeErrorZ _res);
14322 * Creates a new CResult_OutPointDecodeErrorZ which has the same data as `orig`
14323 * but with all dynamically-allocated buffers duplicated in new buffers.
14325 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_clone(const struct LDKCResult_OutPointDecodeErrorZ *NONNULL_PTR orig);
14328 * Constructs a new COption_TypeZ containing a crate::lightning::ln::wire::Type
14330 struct LDKCOption_TypeZ COption_TypeZ_some(struct LDKType o);
14333 * Constructs a new COption_TypeZ containing nothing
14335 struct LDKCOption_TypeZ COption_TypeZ_none(void);
14338 * Frees any resources associated with the crate::lightning::ln::wire::Type, if we are in the Some state
14340 void COption_TypeZ_free(struct LDKCOption_TypeZ _res);
14343 * Creates a new CResult_COption_TypeZDecodeErrorZ in the success state.
14345 struct LDKCResult_COption_TypeZDecodeErrorZ CResult_COption_TypeZDecodeErrorZ_ok(struct LDKCOption_TypeZ o);
14348 * Creates a new CResult_COption_TypeZDecodeErrorZ in the error state.
14350 struct LDKCResult_COption_TypeZDecodeErrorZ CResult_COption_TypeZDecodeErrorZ_err(struct LDKDecodeError e);
14353 * Checks if the given object is currently in the success state
14355 bool CResult_COption_TypeZDecodeErrorZ_is_ok(const struct LDKCResult_COption_TypeZDecodeErrorZ *NONNULL_PTR o);
14358 * Frees any resources used by the CResult_COption_TypeZDecodeErrorZ.
14360 void CResult_COption_TypeZDecodeErrorZ_free(struct LDKCResult_COption_TypeZDecodeErrorZ _res);
14363 * Creates a new CResult_PaymentIdPaymentErrorZ in the success state.
14365 struct LDKCResult_PaymentIdPaymentErrorZ CResult_PaymentIdPaymentErrorZ_ok(struct LDKThirtyTwoBytes o);
14368 * Creates a new CResult_PaymentIdPaymentErrorZ in the error state.
14370 struct LDKCResult_PaymentIdPaymentErrorZ CResult_PaymentIdPaymentErrorZ_err(struct LDKPaymentError e);
14373 * Checks if the given object is currently in the success state
14375 bool CResult_PaymentIdPaymentErrorZ_is_ok(const struct LDKCResult_PaymentIdPaymentErrorZ *NONNULL_PTR o);
14378 * Frees any resources used by the CResult_PaymentIdPaymentErrorZ.
14380 void CResult_PaymentIdPaymentErrorZ_free(struct LDKCResult_PaymentIdPaymentErrorZ _res);
14383 * Creates a new CResult_PaymentIdPaymentErrorZ which has the same data as `orig`
14384 * but with all dynamically-allocated buffers duplicated in new buffers.
14386 struct LDKCResult_PaymentIdPaymentErrorZ CResult_PaymentIdPaymentErrorZ_clone(const struct LDKCResult_PaymentIdPaymentErrorZ *NONNULL_PTR orig);
14389 * Creates a new CResult_SiPrefixNoneZ in the success state.
14391 struct LDKCResult_SiPrefixNoneZ CResult_SiPrefixNoneZ_ok(enum LDKSiPrefix o);
14394 * Creates a new CResult_SiPrefixNoneZ in the error state.
14396 struct LDKCResult_SiPrefixNoneZ CResult_SiPrefixNoneZ_err(void);
14399 * Checks if the given object is currently in the success state
14401 bool CResult_SiPrefixNoneZ_is_ok(const struct LDKCResult_SiPrefixNoneZ *NONNULL_PTR o);
14404 * Frees any resources used by the CResult_SiPrefixNoneZ.
14406 void CResult_SiPrefixNoneZ_free(struct LDKCResult_SiPrefixNoneZ _res);
14409 * Creates a new CResult_SiPrefixNoneZ which has the same data as `orig`
14410 * but with all dynamically-allocated buffers duplicated in new buffers.
14412 struct LDKCResult_SiPrefixNoneZ CResult_SiPrefixNoneZ_clone(const struct LDKCResult_SiPrefixNoneZ *NONNULL_PTR orig);
14415 * Creates a new CResult_InvoiceNoneZ in the success state.
14417 struct LDKCResult_InvoiceNoneZ CResult_InvoiceNoneZ_ok(struct LDKInvoice o);
14420 * Creates a new CResult_InvoiceNoneZ in the error state.
14422 struct LDKCResult_InvoiceNoneZ CResult_InvoiceNoneZ_err(void);
14425 * Checks if the given object is currently in the success state
14427 bool CResult_InvoiceNoneZ_is_ok(const struct LDKCResult_InvoiceNoneZ *NONNULL_PTR o);
14430 * Frees any resources used by the CResult_InvoiceNoneZ.
14432 void CResult_InvoiceNoneZ_free(struct LDKCResult_InvoiceNoneZ _res);
14435 * Creates a new CResult_InvoiceNoneZ which has the same data as `orig`
14436 * but with all dynamically-allocated buffers duplicated in new buffers.
14438 struct LDKCResult_InvoiceNoneZ CResult_InvoiceNoneZ_clone(const struct LDKCResult_InvoiceNoneZ *NONNULL_PTR orig);
14441 * Creates a new CResult_SignedRawInvoiceNoneZ in the success state.
14443 struct LDKCResult_SignedRawInvoiceNoneZ CResult_SignedRawInvoiceNoneZ_ok(struct LDKSignedRawInvoice o);
14446 * Creates a new CResult_SignedRawInvoiceNoneZ in the error state.
14448 struct LDKCResult_SignedRawInvoiceNoneZ CResult_SignedRawInvoiceNoneZ_err(void);
14451 * Checks if the given object is currently in the success state
14453 bool CResult_SignedRawInvoiceNoneZ_is_ok(const struct LDKCResult_SignedRawInvoiceNoneZ *NONNULL_PTR o);
14456 * Frees any resources used by the CResult_SignedRawInvoiceNoneZ.
14458 void CResult_SignedRawInvoiceNoneZ_free(struct LDKCResult_SignedRawInvoiceNoneZ _res);
14461 * Creates a new CResult_SignedRawInvoiceNoneZ which has the same data as `orig`
14462 * but with all dynamically-allocated buffers duplicated in new buffers.
14464 struct LDKCResult_SignedRawInvoiceNoneZ CResult_SignedRawInvoiceNoneZ_clone(const struct LDKCResult_SignedRawInvoiceNoneZ *NONNULL_PTR orig);
14467 * Creates a new tuple which has the same data as `orig`
14468 * but with all dynamically-allocated buffers duplicated in new buffers.
14470 struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ C3Tuple_RawInvoice_u832InvoiceSignatureZ_clone(const struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ *NONNULL_PTR orig);
14473 * Creates a new C3Tuple_RawInvoice_u832InvoiceSignatureZ from the contained elements.
14475 struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ C3Tuple_RawInvoice_u832InvoiceSignatureZ_new(struct LDKRawInvoice a, struct LDKThirtyTwoBytes b, struct LDKInvoiceSignature c);
14478 * Frees any resources used by the C3Tuple_RawInvoice_u832InvoiceSignatureZ.
14480 void C3Tuple_RawInvoice_u832InvoiceSignatureZ_free(struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ _res);
14483 * Creates a new CResult_PayeePubKeyErrorZ in the success state.
14485 struct LDKCResult_PayeePubKeyErrorZ CResult_PayeePubKeyErrorZ_ok(struct LDKPayeePubKey o);
14488 * Creates a new CResult_PayeePubKeyErrorZ in the error state.
14490 struct LDKCResult_PayeePubKeyErrorZ CResult_PayeePubKeyErrorZ_err(enum LDKSecp256k1Error e);
14493 * Checks if the given object is currently in the success state
14495 bool CResult_PayeePubKeyErrorZ_is_ok(const struct LDKCResult_PayeePubKeyErrorZ *NONNULL_PTR o);
14498 * Frees any resources used by the CResult_PayeePubKeyErrorZ.
14500 void CResult_PayeePubKeyErrorZ_free(struct LDKCResult_PayeePubKeyErrorZ _res);
14503 * Creates a new CResult_PayeePubKeyErrorZ which has the same data as `orig`
14504 * but with all dynamically-allocated buffers duplicated in new buffers.
14506 struct LDKCResult_PayeePubKeyErrorZ CResult_PayeePubKeyErrorZ_clone(const struct LDKCResult_PayeePubKeyErrorZ *NONNULL_PTR orig);
14509 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14511 void CVec_PrivateRouteZ_free(struct LDKCVec_PrivateRouteZ _res);
14514 * Creates a new CResult_PositiveTimestampCreationErrorZ in the success state.
14516 struct LDKCResult_PositiveTimestampCreationErrorZ CResult_PositiveTimestampCreationErrorZ_ok(struct LDKPositiveTimestamp o);
14519 * Creates a new CResult_PositiveTimestampCreationErrorZ in the error state.
14521 struct LDKCResult_PositiveTimestampCreationErrorZ CResult_PositiveTimestampCreationErrorZ_err(enum LDKCreationError e);
14524 * Checks if the given object is currently in the success state
14526 bool CResult_PositiveTimestampCreationErrorZ_is_ok(const struct LDKCResult_PositiveTimestampCreationErrorZ *NONNULL_PTR o);
14529 * Frees any resources used by the CResult_PositiveTimestampCreationErrorZ.
14531 void CResult_PositiveTimestampCreationErrorZ_free(struct LDKCResult_PositiveTimestampCreationErrorZ _res);
14534 * Creates a new CResult_PositiveTimestampCreationErrorZ which has the same data as `orig`
14535 * but with all dynamically-allocated buffers duplicated in new buffers.
14537 struct LDKCResult_PositiveTimestampCreationErrorZ CResult_PositiveTimestampCreationErrorZ_clone(const struct LDKCResult_PositiveTimestampCreationErrorZ *NONNULL_PTR orig);
14540 * Creates a new CResult_NoneSemanticErrorZ in the success state.
14542 struct LDKCResult_NoneSemanticErrorZ CResult_NoneSemanticErrorZ_ok(void);
14545 * Creates a new CResult_NoneSemanticErrorZ in the error state.
14547 struct LDKCResult_NoneSemanticErrorZ CResult_NoneSemanticErrorZ_err(enum LDKSemanticError e);
14550 * Checks if the given object is currently in the success state
14552 bool CResult_NoneSemanticErrorZ_is_ok(const struct LDKCResult_NoneSemanticErrorZ *NONNULL_PTR o);
14555 * Frees any resources used by the CResult_NoneSemanticErrorZ.
14557 void CResult_NoneSemanticErrorZ_free(struct LDKCResult_NoneSemanticErrorZ _res);
14560 * Creates a new CResult_NoneSemanticErrorZ which has the same data as `orig`
14561 * but with all dynamically-allocated buffers duplicated in new buffers.
14563 struct LDKCResult_NoneSemanticErrorZ CResult_NoneSemanticErrorZ_clone(const struct LDKCResult_NoneSemanticErrorZ *NONNULL_PTR orig);
14566 * Creates a new CResult_InvoiceSemanticErrorZ in the success state.
14568 struct LDKCResult_InvoiceSemanticErrorZ CResult_InvoiceSemanticErrorZ_ok(struct LDKInvoice o);
14571 * Creates a new CResult_InvoiceSemanticErrorZ in the error state.
14573 struct LDKCResult_InvoiceSemanticErrorZ CResult_InvoiceSemanticErrorZ_err(enum LDKSemanticError e);
14576 * Checks if the given object is currently in the success state
14578 bool CResult_InvoiceSemanticErrorZ_is_ok(const struct LDKCResult_InvoiceSemanticErrorZ *NONNULL_PTR o);
14581 * Frees any resources used by the CResult_InvoiceSemanticErrorZ.
14583 void CResult_InvoiceSemanticErrorZ_free(struct LDKCResult_InvoiceSemanticErrorZ _res);
14586 * Creates a new CResult_InvoiceSemanticErrorZ which has the same data as `orig`
14587 * but with all dynamically-allocated buffers duplicated in new buffers.
14589 struct LDKCResult_InvoiceSemanticErrorZ CResult_InvoiceSemanticErrorZ_clone(const struct LDKCResult_InvoiceSemanticErrorZ *NONNULL_PTR orig);
14592 * Creates a new CResult_DescriptionCreationErrorZ in the success state.
14594 struct LDKCResult_DescriptionCreationErrorZ CResult_DescriptionCreationErrorZ_ok(struct LDKDescription o);
14597 * Creates a new CResult_DescriptionCreationErrorZ in the error state.
14599 struct LDKCResult_DescriptionCreationErrorZ CResult_DescriptionCreationErrorZ_err(enum LDKCreationError e);
14602 * Checks if the given object is currently in the success state
14604 bool CResult_DescriptionCreationErrorZ_is_ok(const struct LDKCResult_DescriptionCreationErrorZ *NONNULL_PTR o);
14607 * Frees any resources used by the CResult_DescriptionCreationErrorZ.
14609 void CResult_DescriptionCreationErrorZ_free(struct LDKCResult_DescriptionCreationErrorZ _res);
14612 * Creates a new CResult_DescriptionCreationErrorZ which has the same data as `orig`
14613 * but with all dynamically-allocated buffers duplicated in new buffers.
14615 struct LDKCResult_DescriptionCreationErrorZ CResult_DescriptionCreationErrorZ_clone(const struct LDKCResult_DescriptionCreationErrorZ *NONNULL_PTR orig);
14618 * Creates a new CResult_PrivateRouteCreationErrorZ in the success state.
14620 struct LDKCResult_PrivateRouteCreationErrorZ CResult_PrivateRouteCreationErrorZ_ok(struct LDKPrivateRoute o);
14623 * Creates a new CResult_PrivateRouteCreationErrorZ in the error state.
14625 struct LDKCResult_PrivateRouteCreationErrorZ CResult_PrivateRouteCreationErrorZ_err(enum LDKCreationError e);
14628 * Checks if the given object is currently in the success state
14630 bool CResult_PrivateRouteCreationErrorZ_is_ok(const struct LDKCResult_PrivateRouteCreationErrorZ *NONNULL_PTR o);
14633 * Frees any resources used by the CResult_PrivateRouteCreationErrorZ.
14635 void CResult_PrivateRouteCreationErrorZ_free(struct LDKCResult_PrivateRouteCreationErrorZ _res);
14638 * Creates a new CResult_PrivateRouteCreationErrorZ which has the same data as `orig`
14639 * but with all dynamically-allocated buffers duplicated in new buffers.
14641 struct LDKCResult_PrivateRouteCreationErrorZ CResult_PrivateRouteCreationErrorZ_clone(const struct LDKCResult_PrivateRouteCreationErrorZ *NONNULL_PTR orig);
14644 * Creates a new CResult_StringErrorZ in the success state.
14646 struct LDKCResult_StringErrorZ CResult_StringErrorZ_ok(struct LDKStr o);
14649 * Creates a new CResult_StringErrorZ in the error state.
14651 struct LDKCResult_StringErrorZ CResult_StringErrorZ_err(enum LDKSecp256k1Error e);
14654 * Checks if the given object is currently in the success state
14656 bool CResult_StringErrorZ_is_ok(const struct LDKCResult_StringErrorZ *NONNULL_PTR o);
14659 * Frees any resources used by the CResult_StringErrorZ.
14661 void CResult_StringErrorZ_free(struct LDKCResult_StringErrorZ _res);
14664 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ in the success state.
14666 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_ok(struct LDKChannelMonitorUpdate o);
14669 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ in the error state.
14671 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_err(struct LDKDecodeError e);
14674 * Checks if the given object is currently in the success state
14676 bool CResult_ChannelMonitorUpdateDecodeErrorZ_is_ok(const struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ *NONNULL_PTR o);
14679 * Frees any resources used by the CResult_ChannelMonitorUpdateDecodeErrorZ.
14681 void CResult_ChannelMonitorUpdateDecodeErrorZ_free(struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ _res);
14684 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ which has the same data as `orig`
14685 * but with all dynamically-allocated buffers duplicated in new buffers.
14687 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_clone(const struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ *NONNULL_PTR orig);
14690 * Constructs a new COption_MonitorEventZ containing a crate::lightning::chain::channelmonitor::MonitorEvent
14692 struct LDKCOption_MonitorEventZ COption_MonitorEventZ_some(struct LDKMonitorEvent o);
14695 * Constructs a new COption_MonitorEventZ containing nothing
14697 struct LDKCOption_MonitorEventZ COption_MonitorEventZ_none(void);
14700 * Frees any resources associated with the crate::lightning::chain::channelmonitor::MonitorEvent, if we are in the Some state
14702 void COption_MonitorEventZ_free(struct LDKCOption_MonitorEventZ _res);
14705 * Creates a new COption_MonitorEventZ which has the same data as `orig`
14706 * but with all dynamically-allocated buffers duplicated in new buffers.
14708 struct LDKCOption_MonitorEventZ COption_MonitorEventZ_clone(const struct LDKCOption_MonitorEventZ *NONNULL_PTR orig);
14711 * Creates a new CResult_COption_MonitorEventZDecodeErrorZ in the success state.
14713 struct LDKCResult_COption_MonitorEventZDecodeErrorZ CResult_COption_MonitorEventZDecodeErrorZ_ok(struct LDKCOption_MonitorEventZ o);
14716 * Creates a new CResult_COption_MonitorEventZDecodeErrorZ in the error state.
14718 struct LDKCResult_COption_MonitorEventZDecodeErrorZ CResult_COption_MonitorEventZDecodeErrorZ_err(struct LDKDecodeError e);
14721 * Checks if the given object is currently in the success state
14723 bool CResult_COption_MonitorEventZDecodeErrorZ_is_ok(const struct LDKCResult_COption_MonitorEventZDecodeErrorZ *NONNULL_PTR o);
14726 * Frees any resources used by the CResult_COption_MonitorEventZDecodeErrorZ.
14728 void CResult_COption_MonitorEventZDecodeErrorZ_free(struct LDKCResult_COption_MonitorEventZDecodeErrorZ _res);
14731 * Creates a new CResult_COption_MonitorEventZDecodeErrorZ which has the same data as `orig`
14732 * but with all dynamically-allocated buffers duplicated in new buffers.
14734 struct LDKCResult_COption_MonitorEventZDecodeErrorZ CResult_COption_MonitorEventZDecodeErrorZ_clone(const struct LDKCResult_COption_MonitorEventZDecodeErrorZ *NONNULL_PTR orig);
14737 * Creates a new CResult_HTLCUpdateDecodeErrorZ in the success state.
14739 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_ok(struct LDKHTLCUpdate o);
14742 * Creates a new CResult_HTLCUpdateDecodeErrorZ in the error state.
14744 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_err(struct LDKDecodeError e);
14747 * Checks if the given object is currently in the success state
14749 bool CResult_HTLCUpdateDecodeErrorZ_is_ok(const struct LDKCResult_HTLCUpdateDecodeErrorZ *NONNULL_PTR o);
14752 * Frees any resources used by the CResult_HTLCUpdateDecodeErrorZ.
14754 void CResult_HTLCUpdateDecodeErrorZ_free(struct LDKCResult_HTLCUpdateDecodeErrorZ _res);
14757 * Creates a new CResult_HTLCUpdateDecodeErrorZ which has the same data as `orig`
14758 * but with all dynamically-allocated buffers duplicated in new buffers.
14760 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_clone(const struct LDKCResult_HTLCUpdateDecodeErrorZ *NONNULL_PTR orig);
14763 * Creates a new tuple which has the same data as `orig`
14764 * but with all dynamically-allocated buffers duplicated in new buffers.
14766 struct LDKC2Tuple_OutPointScriptZ C2Tuple_OutPointScriptZ_clone(const struct LDKC2Tuple_OutPointScriptZ *NONNULL_PTR orig);
14769 * Creates a new C2Tuple_OutPointScriptZ from the contained elements.
14771 struct LDKC2Tuple_OutPointScriptZ C2Tuple_OutPointScriptZ_new(struct LDKOutPoint a, struct LDKCVec_u8Z b);
14774 * Frees any resources used by the C2Tuple_OutPointScriptZ.
14776 void C2Tuple_OutPointScriptZ_free(struct LDKC2Tuple_OutPointScriptZ _res);
14779 * Creates a new tuple which has the same data as `orig`
14780 * but with all dynamically-allocated buffers duplicated in new buffers.
14782 struct LDKC2Tuple_u32ScriptZ C2Tuple_u32ScriptZ_clone(const struct LDKC2Tuple_u32ScriptZ *NONNULL_PTR orig);
14785 * Creates a new C2Tuple_u32ScriptZ from the contained elements.
14787 struct LDKC2Tuple_u32ScriptZ C2Tuple_u32ScriptZ_new(uint32_t a, struct LDKCVec_u8Z b);
14790 * Frees any resources used by the C2Tuple_u32ScriptZ.
14792 void C2Tuple_u32ScriptZ_free(struct LDKC2Tuple_u32ScriptZ _res);
14795 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14797 void CVec_C2Tuple_u32ScriptZZ_free(struct LDKCVec_C2Tuple_u32ScriptZZ _res);
14800 * Creates a new tuple which has the same data as `orig`
14801 * but with all dynamically-allocated buffers duplicated in new buffers.
14803 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_clone(const struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ *NONNULL_PTR orig);
14806 * Creates a new C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ from the contained elements.
14808 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_new(struct LDKThirtyTwoBytes a, struct LDKCVec_C2Tuple_u32ScriptZZ b);
14811 * Frees any resources used by the C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ.
14813 void C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_free(struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ _res);
14816 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14818 void CVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ_free(struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ _res);
14821 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14823 void CVec_EventZ_free(struct LDKCVec_EventZ _res);
14826 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14828 void CVec_TransactionZ_free(struct LDKCVec_TransactionZ _res);
14831 * Creates a new tuple which has the same data as `orig`
14832 * but with all dynamically-allocated buffers duplicated in new buffers.
14834 struct LDKC2Tuple_u32TxOutZ C2Tuple_u32TxOutZ_clone(const struct LDKC2Tuple_u32TxOutZ *NONNULL_PTR orig);
14837 * Creates a new C2Tuple_u32TxOutZ from the contained elements.
14839 struct LDKC2Tuple_u32TxOutZ C2Tuple_u32TxOutZ_new(uint32_t a, struct LDKTxOut b);
14842 * Frees any resources used by the C2Tuple_u32TxOutZ.
14844 void C2Tuple_u32TxOutZ_free(struct LDKC2Tuple_u32TxOutZ _res);
14847 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14849 void CVec_C2Tuple_u32TxOutZZ_free(struct LDKCVec_C2Tuple_u32TxOutZZ _res);
14852 * Creates a new tuple which has the same data as `orig`
14853 * but with all dynamically-allocated buffers duplicated in new buffers.
14855 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_clone(const struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ *NONNULL_PTR orig);
14858 * Creates a new C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ from the contained elements.
14860 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_new(struct LDKThirtyTwoBytes a, struct LDKCVec_C2Tuple_u32TxOutZZ b);
14863 * Frees any resources used by the C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ.
14865 void C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_free(struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ _res);
14868 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14870 void CVec_TransactionOutputsZ_free(struct LDKCVec_TransactionOutputsZ _res);
14873 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14875 void CVec_BalanceZ_free(struct LDKCVec_BalanceZ _res);
14878 * Creates a new CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ in the success state.
14880 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_ok(struct LDKC2Tuple_BlockHashChannelMonitorZ o);
14883 * Creates a new CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ in the error state.
14885 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_err(struct LDKDecodeError e);
14888 * Checks if the given object is currently in the success state
14890 bool CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_is_ok(const struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ *NONNULL_PTR o);
14893 * Frees any resources used by the CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.
14895 void CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_free(struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ _res);
14898 * Creates a new CResult_NoneLightningErrorZ in the success state.
14900 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_ok(void);
14903 * Creates a new CResult_NoneLightningErrorZ in the error state.
14905 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_err(struct LDKLightningError e);
14908 * Checks if the given object is currently in the success state
14910 bool CResult_NoneLightningErrorZ_is_ok(const struct LDKCResult_NoneLightningErrorZ *NONNULL_PTR o);
14913 * Frees any resources used by the CResult_NoneLightningErrorZ.
14915 void CResult_NoneLightningErrorZ_free(struct LDKCResult_NoneLightningErrorZ _res);
14918 * Creates a new CResult_NoneLightningErrorZ which has the same data as `orig`
14919 * but with all dynamically-allocated buffers duplicated in new buffers.
14921 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_clone(const struct LDKCResult_NoneLightningErrorZ *NONNULL_PTR orig);
14924 * Creates a new C2Tuple_PublicKeyTypeZ from the contained elements.
14926 struct LDKC2Tuple_PublicKeyTypeZ C2Tuple_PublicKeyTypeZ_new(struct LDKPublicKey a, struct LDKType b);
14929 * Frees any resources used by the C2Tuple_PublicKeyTypeZ.
14931 void C2Tuple_PublicKeyTypeZ_free(struct LDKC2Tuple_PublicKeyTypeZ _res);
14934 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14936 void CVec_C2Tuple_PublicKeyTypeZZ_free(struct LDKCVec_C2Tuple_PublicKeyTypeZZ _res);
14939 * Creates a new CResult_boolLightningErrorZ in the success state.
14941 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_ok(bool o);
14944 * Creates a new CResult_boolLightningErrorZ in the error state.
14946 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_err(struct LDKLightningError e);
14949 * Checks if the given object is currently in the success state
14951 bool CResult_boolLightningErrorZ_is_ok(const struct LDKCResult_boolLightningErrorZ *NONNULL_PTR o);
14954 * Frees any resources used by the CResult_boolLightningErrorZ.
14956 void CResult_boolLightningErrorZ_free(struct LDKCResult_boolLightningErrorZ _res);
14959 * Creates a new CResult_boolLightningErrorZ which has the same data as `orig`
14960 * but with all dynamically-allocated buffers duplicated in new buffers.
14962 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_clone(const struct LDKCResult_boolLightningErrorZ *NONNULL_PTR orig);
14965 * Creates a new tuple which has the same data as `orig`
14966 * but with all dynamically-allocated buffers duplicated in new buffers.
14968 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_clone(const struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ *NONNULL_PTR orig);
14971 * Creates a new C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ from the contained elements.
14973 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_new(struct LDKChannelAnnouncement a, struct LDKChannelUpdate b, struct LDKChannelUpdate c);
14976 * Frees any resources used by the C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ.
14978 void C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_free(struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ _res);
14981 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14983 void CVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ_free(struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ _res);
14986 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14988 void CVec_NodeAnnouncementZ_free(struct LDKCVec_NodeAnnouncementZ _res);
14991 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14993 void CVec_PublicKeyZ_free(struct LDKCVec_PublicKeyZ _res);
14996 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ in the success state.
14998 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_ok(struct LDKCVec_u8Z o);
15001 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ in the error state.
15003 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_err(struct LDKPeerHandleError e);
15006 * Checks if the given object is currently in the success state
15008 bool CResult_CVec_u8ZPeerHandleErrorZ_is_ok(const struct LDKCResult_CVec_u8ZPeerHandleErrorZ *NONNULL_PTR o);
15011 * Frees any resources used by the CResult_CVec_u8ZPeerHandleErrorZ.
15013 void CResult_CVec_u8ZPeerHandleErrorZ_free(struct LDKCResult_CVec_u8ZPeerHandleErrorZ _res);
15016 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ which has the same data as `orig`
15017 * but with all dynamically-allocated buffers duplicated in new buffers.
15019 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_clone(const struct LDKCResult_CVec_u8ZPeerHandleErrorZ *NONNULL_PTR orig);
15022 * Creates a new CResult_NonePeerHandleErrorZ in the success state.
15024 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_ok(void);
15027 * Creates a new CResult_NonePeerHandleErrorZ in the error state.
15029 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_err(struct LDKPeerHandleError e);
15032 * Checks if the given object is currently in the success state
15034 bool CResult_NonePeerHandleErrorZ_is_ok(const struct LDKCResult_NonePeerHandleErrorZ *NONNULL_PTR o);
15037 * Frees any resources used by the CResult_NonePeerHandleErrorZ.
15039 void CResult_NonePeerHandleErrorZ_free(struct LDKCResult_NonePeerHandleErrorZ _res);
15042 * Creates a new CResult_NonePeerHandleErrorZ which has the same data as `orig`
15043 * but with all dynamically-allocated buffers duplicated in new buffers.
15045 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_clone(const struct LDKCResult_NonePeerHandleErrorZ *NONNULL_PTR orig);
15048 * Creates a new CResult_boolPeerHandleErrorZ in the success state.
15050 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_ok(bool o);
15053 * Creates a new CResult_boolPeerHandleErrorZ in the error state.
15055 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_err(struct LDKPeerHandleError e);
15058 * Checks if the given object is currently in the success state
15060 bool CResult_boolPeerHandleErrorZ_is_ok(const struct LDKCResult_boolPeerHandleErrorZ *NONNULL_PTR o);
15063 * Frees any resources used by the CResult_boolPeerHandleErrorZ.
15065 void CResult_boolPeerHandleErrorZ_free(struct LDKCResult_boolPeerHandleErrorZ _res);
15068 * Creates a new CResult_boolPeerHandleErrorZ which has the same data as `orig`
15069 * but with all dynamically-allocated buffers duplicated in new buffers.
15071 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_clone(const struct LDKCResult_boolPeerHandleErrorZ *NONNULL_PTR orig);
15074 * Creates a new CResult_NodeIdDecodeErrorZ in the success state.
15076 struct LDKCResult_NodeIdDecodeErrorZ CResult_NodeIdDecodeErrorZ_ok(struct LDKNodeId o);
15079 * Creates a new CResult_NodeIdDecodeErrorZ in the error state.
15081 struct LDKCResult_NodeIdDecodeErrorZ CResult_NodeIdDecodeErrorZ_err(struct LDKDecodeError e);
15084 * Checks if the given object is currently in the success state
15086 bool CResult_NodeIdDecodeErrorZ_is_ok(const struct LDKCResult_NodeIdDecodeErrorZ *NONNULL_PTR o);
15089 * Frees any resources used by the CResult_NodeIdDecodeErrorZ.
15091 void CResult_NodeIdDecodeErrorZ_free(struct LDKCResult_NodeIdDecodeErrorZ _res);
15094 * Creates a new CResult_NodeIdDecodeErrorZ which has the same data as `orig`
15095 * but with all dynamically-allocated buffers duplicated in new buffers.
15097 struct LDKCResult_NodeIdDecodeErrorZ CResult_NodeIdDecodeErrorZ_clone(const struct LDKCResult_NodeIdDecodeErrorZ *NONNULL_PTR orig);
15100 * Creates a new CResult_COption_NetworkUpdateZDecodeErrorZ in the success state.
15102 struct LDKCResult_COption_NetworkUpdateZDecodeErrorZ CResult_COption_NetworkUpdateZDecodeErrorZ_ok(struct LDKCOption_NetworkUpdateZ o);
15105 * Creates a new CResult_COption_NetworkUpdateZDecodeErrorZ in the error state.
15107 struct LDKCResult_COption_NetworkUpdateZDecodeErrorZ CResult_COption_NetworkUpdateZDecodeErrorZ_err(struct LDKDecodeError e);
15110 * Checks if the given object is currently in the success state
15112 bool CResult_COption_NetworkUpdateZDecodeErrorZ_is_ok(const struct LDKCResult_COption_NetworkUpdateZDecodeErrorZ *NONNULL_PTR o);
15115 * Frees any resources used by the CResult_COption_NetworkUpdateZDecodeErrorZ.
15117 void CResult_COption_NetworkUpdateZDecodeErrorZ_free(struct LDKCResult_COption_NetworkUpdateZDecodeErrorZ _res);
15120 * Creates a new CResult_COption_NetworkUpdateZDecodeErrorZ which has the same data as `orig`
15121 * but with all dynamically-allocated buffers duplicated in new buffers.
15123 struct LDKCResult_COption_NetworkUpdateZDecodeErrorZ CResult_COption_NetworkUpdateZDecodeErrorZ_clone(const struct LDKCResult_COption_NetworkUpdateZDecodeErrorZ *NONNULL_PTR orig);
15126 * Constructs a new COption_AccessZ containing a crate::lightning::chain::Access
15128 struct LDKCOption_AccessZ COption_AccessZ_some(struct LDKAccess o);
15131 * Constructs a new COption_AccessZ containing nothing
15133 struct LDKCOption_AccessZ COption_AccessZ_none(void);
15136 * Frees any resources associated with the crate::lightning::chain::Access, if we are in the Some state
15138 void COption_AccessZ_free(struct LDKCOption_AccessZ _res);
15141 * Creates a new CResult_ChannelUpdateInfoDecodeErrorZ in the success state.
15143 struct LDKCResult_ChannelUpdateInfoDecodeErrorZ CResult_ChannelUpdateInfoDecodeErrorZ_ok(struct LDKChannelUpdateInfo o);
15146 * Creates a new CResult_ChannelUpdateInfoDecodeErrorZ in the error state.
15148 struct LDKCResult_ChannelUpdateInfoDecodeErrorZ CResult_ChannelUpdateInfoDecodeErrorZ_err(struct LDKDecodeError e);
15151 * Checks if the given object is currently in the success state
15153 bool CResult_ChannelUpdateInfoDecodeErrorZ_is_ok(const struct LDKCResult_ChannelUpdateInfoDecodeErrorZ *NONNULL_PTR o);
15156 * Frees any resources used by the CResult_ChannelUpdateInfoDecodeErrorZ.
15158 void CResult_ChannelUpdateInfoDecodeErrorZ_free(struct LDKCResult_ChannelUpdateInfoDecodeErrorZ _res);
15161 * Creates a new CResult_ChannelUpdateInfoDecodeErrorZ which has the same data as `orig`
15162 * but with all dynamically-allocated buffers duplicated in new buffers.
15164 struct LDKCResult_ChannelUpdateInfoDecodeErrorZ CResult_ChannelUpdateInfoDecodeErrorZ_clone(const struct LDKCResult_ChannelUpdateInfoDecodeErrorZ *NONNULL_PTR orig);
15167 * Creates a new CResult_ChannelInfoDecodeErrorZ in the success state.
15169 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_ok(struct LDKChannelInfo o);
15172 * Creates a new CResult_ChannelInfoDecodeErrorZ in the error state.
15174 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_err(struct LDKDecodeError e);
15177 * Checks if the given object is currently in the success state
15179 bool CResult_ChannelInfoDecodeErrorZ_is_ok(const struct LDKCResult_ChannelInfoDecodeErrorZ *NONNULL_PTR o);
15182 * Frees any resources used by the CResult_ChannelInfoDecodeErrorZ.
15184 void CResult_ChannelInfoDecodeErrorZ_free(struct LDKCResult_ChannelInfoDecodeErrorZ _res);
15187 * Creates a new CResult_ChannelInfoDecodeErrorZ which has the same data as `orig`
15188 * but with all dynamically-allocated buffers duplicated in new buffers.
15190 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_clone(const struct LDKCResult_ChannelInfoDecodeErrorZ *NONNULL_PTR orig);
15193 * Creates a new CResult_RoutingFeesDecodeErrorZ in the success state.
15195 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_ok(struct LDKRoutingFees o);
15198 * Creates a new CResult_RoutingFeesDecodeErrorZ in the error state.
15200 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_err(struct LDKDecodeError e);
15203 * Checks if the given object is currently in the success state
15205 bool CResult_RoutingFeesDecodeErrorZ_is_ok(const struct LDKCResult_RoutingFeesDecodeErrorZ *NONNULL_PTR o);
15208 * Frees any resources used by the CResult_RoutingFeesDecodeErrorZ.
15210 void CResult_RoutingFeesDecodeErrorZ_free(struct LDKCResult_RoutingFeesDecodeErrorZ _res);
15213 * Creates a new CResult_RoutingFeesDecodeErrorZ which has the same data as `orig`
15214 * but with all dynamically-allocated buffers duplicated in new buffers.
15216 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_clone(const struct LDKCResult_RoutingFeesDecodeErrorZ *NONNULL_PTR orig);
15219 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ in the success state.
15221 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_ok(struct LDKNodeAnnouncementInfo o);
15224 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ in the error state.
15226 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_err(struct LDKDecodeError e);
15229 * Checks if the given object is currently in the success state
15231 bool CResult_NodeAnnouncementInfoDecodeErrorZ_is_ok(const struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ *NONNULL_PTR o);
15234 * Frees any resources used by the CResult_NodeAnnouncementInfoDecodeErrorZ.
15236 void CResult_NodeAnnouncementInfoDecodeErrorZ_free(struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ _res);
15239 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ which has the same data as `orig`
15240 * but with all dynamically-allocated buffers duplicated in new buffers.
15242 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_clone(const struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ *NONNULL_PTR orig);
15245 * Frees the buffer pointed to by `data` if `datalen` is non-0.
15247 void CVec_u64Z_free(struct LDKCVec_u64Z _res);
15250 * Creates a new CResult_NodeInfoDecodeErrorZ in the success state.
15252 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_ok(struct LDKNodeInfo o);
15255 * Creates a new CResult_NodeInfoDecodeErrorZ in the error state.
15257 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_err(struct LDKDecodeError e);
15260 * Checks if the given object is currently in the success state
15262 bool CResult_NodeInfoDecodeErrorZ_is_ok(const struct LDKCResult_NodeInfoDecodeErrorZ *NONNULL_PTR o);
15265 * Frees any resources used by the CResult_NodeInfoDecodeErrorZ.
15267 void CResult_NodeInfoDecodeErrorZ_free(struct LDKCResult_NodeInfoDecodeErrorZ _res);
15270 * Creates a new CResult_NodeInfoDecodeErrorZ which has the same data as `orig`
15271 * but with all dynamically-allocated buffers duplicated in new buffers.
15273 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_clone(const struct LDKCResult_NodeInfoDecodeErrorZ *NONNULL_PTR orig);
15276 * Creates a new CResult_NetworkGraphDecodeErrorZ in the success state.
15278 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_ok(struct LDKNetworkGraph o);
15281 * Creates a new CResult_NetworkGraphDecodeErrorZ in the error state.
15283 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_err(struct LDKDecodeError e);
15286 * Checks if the given object is currently in the success state
15288 bool CResult_NetworkGraphDecodeErrorZ_is_ok(const struct LDKCResult_NetworkGraphDecodeErrorZ *NONNULL_PTR o);
15291 * Frees any resources used by the CResult_NetworkGraphDecodeErrorZ.
15293 void CResult_NetworkGraphDecodeErrorZ_free(struct LDKCResult_NetworkGraphDecodeErrorZ _res);
15296 * Creates a new CResult_NetworkGraphDecodeErrorZ which has the same data as `orig`
15297 * but with all dynamically-allocated buffers duplicated in new buffers.
15299 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_clone(const struct LDKCResult_NetworkGraphDecodeErrorZ *NONNULL_PTR orig);
15302 * Constructs a new COption_CVec_NetAddressZZ containing a crate::c_types::derived::CVec_NetAddressZ
15304 struct LDKCOption_CVec_NetAddressZZ COption_CVec_NetAddressZZ_some(struct LDKCVec_NetAddressZ o);
15307 * Constructs a new COption_CVec_NetAddressZZ containing nothing
15309 struct LDKCOption_CVec_NetAddressZZ COption_CVec_NetAddressZZ_none(void);
15312 * Frees any resources associated with the crate::c_types::derived::CVec_NetAddressZ, if we are in the Some state
15314 void COption_CVec_NetAddressZZ_free(struct LDKCOption_CVec_NetAddressZZ _res);
15317 * Creates a new COption_CVec_NetAddressZZ which has the same data as `orig`
15318 * but with all dynamically-allocated buffers duplicated in new buffers.
15320 struct LDKCOption_CVec_NetAddressZZ COption_CVec_NetAddressZZ_clone(const struct LDKCOption_CVec_NetAddressZZ *NONNULL_PTR orig);
15323 * Creates a new CResult_NetAddressDecodeErrorZ in the success state.
15325 struct LDKCResult_NetAddressDecodeErrorZ CResult_NetAddressDecodeErrorZ_ok(struct LDKNetAddress o);
15328 * Creates a new CResult_NetAddressDecodeErrorZ in the error state.
15330 struct LDKCResult_NetAddressDecodeErrorZ CResult_NetAddressDecodeErrorZ_err(struct LDKDecodeError e);
15333 * Checks if the given object is currently in the success state
15335 bool CResult_NetAddressDecodeErrorZ_is_ok(const struct LDKCResult_NetAddressDecodeErrorZ *NONNULL_PTR o);
15338 * Frees any resources used by the CResult_NetAddressDecodeErrorZ.
15340 void CResult_NetAddressDecodeErrorZ_free(struct LDKCResult_NetAddressDecodeErrorZ _res);
15343 * Creates a new CResult_NetAddressDecodeErrorZ which has the same data as `orig`
15344 * but with all dynamically-allocated buffers duplicated in new buffers.
15346 struct LDKCResult_NetAddressDecodeErrorZ CResult_NetAddressDecodeErrorZ_clone(const struct LDKCResult_NetAddressDecodeErrorZ *NONNULL_PTR orig);
15349 * Frees the buffer pointed to by `data` if `datalen` is non-0.
15351 void CVec_UpdateAddHTLCZ_free(struct LDKCVec_UpdateAddHTLCZ _res);
15354 * Frees the buffer pointed to by `data` if `datalen` is non-0.
15356 void CVec_UpdateFulfillHTLCZ_free(struct LDKCVec_UpdateFulfillHTLCZ _res);
15359 * Frees the buffer pointed to by `data` if `datalen` is non-0.
15361 void CVec_UpdateFailHTLCZ_free(struct LDKCVec_UpdateFailHTLCZ _res);
15364 * Frees the buffer pointed to by `data` if `datalen` is non-0.
15366 void CVec_UpdateFailMalformedHTLCZ_free(struct LDKCVec_UpdateFailMalformedHTLCZ _res);
15369 * Creates a new CResult_AcceptChannelDecodeErrorZ in the success state.
15371 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_ok(struct LDKAcceptChannel o);
15374 * Creates a new CResult_AcceptChannelDecodeErrorZ in the error state.
15376 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_err(struct LDKDecodeError e);
15379 * Checks if the given object is currently in the success state
15381 bool CResult_AcceptChannelDecodeErrorZ_is_ok(const struct LDKCResult_AcceptChannelDecodeErrorZ *NONNULL_PTR o);
15384 * Frees any resources used by the CResult_AcceptChannelDecodeErrorZ.
15386 void CResult_AcceptChannelDecodeErrorZ_free(struct LDKCResult_AcceptChannelDecodeErrorZ _res);
15389 * Creates a new CResult_AcceptChannelDecodeErrorZ which has the same data as `orig`
15390 * but with all dynamically-allocated buffers duplicated in new buffers.
15392 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_clone(const struct LDKCResult_AcceptChannelDecodeErrorZ *NONNULL_PTR orig);
15395 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ in the success state.
15397 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_ok(struct LDKAnnouncementSignatures o);
15400 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ in the error state.
15402 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_err(struct LDKDecodeError e);
15405 * Checks if the given object is currently in the success state
15407 bool CResult_AnnouncementSignaturesDecodeErrorZ_is_ok(const struct LDKCResult_AnnouncementSignaturesDecodeErrorZ *NONNULL_PTR o);
15410 * Frees any resources used by the CResult_AnnouncementSignaturesDecodeErrorZ.
15412 void CResult_AnnouncementSignaturesDecodeErrorZ_free(struct LDKCResult_AnnouncementSignaturesDecodeErrorZ _res);
15415 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ which has the same data as `orig`
15416 * but with all dynamically-allocated buffers duplicated in new buffers.
15418 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_clone(const struct LDKCResult_AnnouncementSignaturesDecodeErrorZ *NONNULL_PTR orig);
15421 * Creates a new CResult_ChannelReestablishDecodeErrorZ in the success state.
15423 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_ok(struct LDKChannelReestablish o);
15426 * Creates a new CResult_ChannelReestablishDecodeErrorZ in the error state.
15428 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_err(struct LDKDecodeError e);
15431 * Checks if the given object is currently in the success state
15433 bool CResult_ChannelReestablishDecodeErrorZ_is_ok(const struct LDKCResult_ChannelReestablishDecodeErrorZ *NONNULL_PTR o);
15436 * Frees any resources used by the CResult_ChannelReestablishDecodeErrorZ.
15438 void CResult_ChannelReestablishDecodeErrorZ_free(struct LDKCResult_ChannelReestablishDecodeErrorZ _res);
15441 * Creates a new CResult_ChannelReestablishDecodeErrorZ which has the same data as `orig`
15442 * but with all dynamically-allocated buffers duplicated in new buffers.
15444 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_clone(const struct LDKCResult_ChannelReestablishDecodeErrorZ *NONNULL_PTR orig);
15447 * Creates a new CResult_ClosingSignedDecodeErrorZ in the success state.
15449 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_ok(struct LDKClosingSigned o);
15452 * Creates a new CResult_ClosingSignedDecodeErrorZ in the error state.
15454 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_err(struct LDKDecodeError e);
15457 * Checks if the given object is currently in the success state
15459 bool CResult_ClosingSignedDecodeErrorZ_is_ok(const struct LDKCResult_ClosingSignedDecodeErrorZ *NONNULL_PTR o);
15462 * Frees any resources used by the CResult_ClosingSignedDecodeErrorZ.
15464 void CResult_ClosingSignedDecodeErrorZ_free(struct LDKCResult_ClosingSignedDecodeErrorZ _res);
15467 * Creates a new CResult_ClosingSignedDecodeErrorZ which has the same data as `orig`
15468 * but with all dynamically-allocated buffers duplicated in new buffers.
15470 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_clone(const struct LDKCResult_ClosingSignedDecodeErrorZ *NONNULL_PTR orig);
15473 * Creates a new CResult_ClosingSignedFeeRangeDecodeErrorZ in the success state.
15475 struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ CResult_ClosingSignedFeeRangeDecodeErrorZ_ok(struct LDKClosingSignedFeeRange o);
15478 * Creates a new CResult_ClosingSignedFeeRangeDecodeErrorZ in the error state.
15480 struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ CResult_ClosingSignedFeeRangeDecodeErrorZ_err(struct LDKDecodeError e);
15483 * Checks if the given object is currently in the success state
15485 bool CResult_ClosingSignedFeeRangeDecodeErrorZ_is_ok(const struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ *NONNULL_PTR o);
15488 * Frees any resources used by the CResult_ClosingSignedFeeRangeDecodeErrorZ.
15490 void CResult_ClosingSignedFeeRangeDecodeErrorZ_free(struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ _res);
15493 * Creates a new CResult_ClosingSignedFeeRangeDecodeErrorZ which has the same data as `orig`
15494 * but with all dynamically-allocated buffers duplicated in new buffers.
15496 struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ CResult_ClosingSignedFeeRangeDecodeErrorZ_clone(const struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ *NONNULL_PTR orig);
15499 * Creates a new CResult_CommitmentSignedDecodeErrorZ in the success state.
15501 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_ok(struct LDKCommitmentSigned o);
15504 * Creates a new CResult_CommitmentSignedDecodeErrorZ in the error state.
15506 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_err(struct LDKDecodeError e);
15509 * Checks if the given object is currently in the success state
15511 bool CResult_CommitmentSignedDecodeErrorZ_is_ok(const struct LDKCResult_CommitmentSignedDecodeErrorZ *NONNULL_PTR o);
15514 * Frees any resources used by the CResult_CommitmentSignedDecodeErrorZ.
15516 void CResult_CommitmentSignedDecodeErrorZ_free(struct LDKCResult_CommitmentSignedDecodeErrorZ _res);
15519 * Creates a new CResult_CommitmentSignedDecodeErrorZ which has the same data as `orig`
15520 * but with all dynamically-allocated buffers duplicated in new buffers.
15522 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_clone(const struct LDKCResult_CommitmentSignedDecodeErrorZ *NONNULL_PTR orig);
15525 * Creates a new CResult_FundingCreatedDecodeErrorZ in the success state.
15527 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_ok(struct LDKFundingCreated o);
15530 * Creates a new CResult_FundingCreatedDecodeErrorZ in the error state.
15532 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_err(struct LDKDecodeError e);
15535 * Checks if the given object is currently in the success state
15537 bool CResult_FundingCreatedDecodeErrorZ_is_ok(const struct LDKCResult_FundingCreatedDecodeErrorZ *NONNULL_PTR o);
15540 * Frees any resources used by the CResult_FundingCreatedDecodeErrorZ.
15542 void CResult_FundingCreatedDecodeErrorZ_free(struct LDKCResult_FundingCreatedDecodeErrorZ _res);
15545 * Creates a new CResult_FundingCreatedDecodeErrorZ which has the same data as `orig`
15546 * but with all dynamically-allocated buffers duplicated in new buffers.
15548 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_clone(const struct LDKCResult_FundingCreatedDecodeErrorZ *NONNULL_PTR orig);
15551 * Creates a new CResult_FundingSignedDecodeErrorZ in the success state.
15553 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_ok(struct LDKFundingSigned o);
15556 * Creates a new CResult_FundingSignedDecodeErrorZ in the error state.
15558 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_err(struct LDKDecodeError e);
15561 * Checks if the given object is currently in the success state
15563 bool CResult_FundingSignedDecodeErrorZ_is_ok(const struct LDKCResult_FundingSignedDecodeErrorZ *NONNULL_PTR o);
15566 * Frees any resources used by the CResult_FundingSignedDecodeErrorZ.
15568 void CResult_FundingSignedDecodeErrorZ_free(struct LDKCResult_FundingSignedDecodeErrorZ _res);
15571 * Creates a new CResult_FundingSignedDecodeErrorZ which has the same data as `orig`
15572 * but with all dynamically-allocated buffers duplicated in new buffers.
15574 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_clone(const struct LDKCResult_FundingSignedDecodeErrorZ *NONNULL_PTR orig);
15577 * Creates a new CResult_FundingLockedDecodeErrorZ in the success state.
15579 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_ok(struct LDKFundingLocked o);
15582 * Creates a new CResult_FundingLockedDecodeErrorZ in the error state.
15584 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_err(struct LDKDecodeError e);
15587 * Checks if the given object is currently in the success state
15589 bool CResult_FundingLockedDecodeErrorZ_is_ok(const struct LDKCResult_FundingLockedDecodeErrorZ *NONNULL_PTR o);
15592 * Frees any resources used by the CResult_FundingLockedDecodeErrorZ.
15594 void CResult_FundingLockedDecodeErrorZ_free(struct LDKCResult_FundingLockedDecodeErrorZ _res);
15597 * Creates a new CResult_FundingLockedDecodeErrorZ which has the same data as `orig`
15598 * but with all dynamically-allocated buffers duplicated in new buffers.
15600 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_clone(const struct LDKCResult_FundingLockedDecodeErrorZ *NONNULL_PTR orig);
15603 * Creates a new CResult_InitDecodeErrorZ in the success state.
15605 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_ok(struct LDKInit o);
15608 * Creates a new CResult_InitDecodeErrorZ in the error state.
15610 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_err(struct LDKDecodeError e);
15613 * Checks if the given object is currently in the success state
15615 bool CResult_InitDecodeErrorZ_is_ok(const struct LDKCResult_InitDecodeErrorZ *NONNULL_PTR o);
15618 * Frees any resources used by the CResult_InitDecodeErrorZ.
15620 void CResult_InitDecodeErrorZ_free(struct LDKCResult_InitDecodeErrorZ _res);
15623 * Creates a new CResult_InitDecodeErrorZ which has the same data as `orig`
15624 * but with all dynamically-allocated buffers duplicated in new buffers.
15626 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_clone(const struct LDKCResult_InitDecodeErrorZ *NONNULL_PTR orig);
15629 * Creates a new CResult_OpenChannelDecodeErrorZ in the success state.
15631 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_ok(struct LDKOpenChannel o);
15634 * Creates a new CResult_OpenChannelDecodeErrorZ in the error state.
15636 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_err(struct LDKDecodeError e);
15639 * Checks if the given object is currently in the success state
15641 bool CResult_OpenChannelDecodeErrorZ_is_ok(const struct LDKCResult_OpenChannelDecodeErrorZ *NONNULL_PTR o);
15644 * Frees any resources used by the CResult_OpenChannelDecodeErrorZ.
15646 void CResult_OpenChannelDecodeErrorZ_free(struct LDKCResult_OpenChannelDecodeErrorZ _res);
15649 * Creates a new CResult_OpenChannelDecodeErrorZ which has the same data as `orig`
15650 * but with all dynamically-allocated buffers duplicated in new buffers.
15652 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_clone(const struct LDKCResult_OpenChannelDecodeErrorZ *NONNULL_PTR orig);
15655 * Creates a new CResult_RevokeAndACKDecodeErrorZ in the success state.
15657 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_ok(struct LDKRevokeAndACK o);
15660 * Creates a new CResult_RevokeAndACKDecodeErrorZ in the error state.
15662 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_err(struct LDKDecodeError e);
15665 * Checks if the given object is currently in the success state
15667 bool CResult_RevokeAndACKDecodeErrorZ_is_ok(const struct LDKCResult_RevokeAndACKDecodeErrorZ *NONNULL_PTR o);
15670 * Frees any resources used by the CResult_RevokeAndACKDecodeErrorZ.
15672 void CResult_RevokeAndACKDecodeErrorZ_free(struct LDKCResult_RevokeAndACKDecodeErrorZ _res);
15675 * Creates a new CResult_RevokeAndACKDecodeErrorZ which has the same data as `orig`
15676 * but with all dynamically-allocated buffers duplicated in new buffers.
15678 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_clone(const struct LDKCResult_RevokeAndACKDecodeErrorZ *NONNULL_PTR orig);
15681 * Creates a new CResult_ShutdownDecodeErrorZ in the success state.
15683 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_ok(struct LDKShutdown o);
15686 * Creates a new CResult_ShutdownDecodeErrorZ in the error state.
15688 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_err(struct LDKDecodeError e);
15691 * Checks if the given object is currently in the success state
15693 bool CResult_ShutdownDecodeErrorZ_is_ok(const struct LDKCResult_ShutdownDecodeErrorZ *NONNULL_PTR o);
15696 * Frees any resources used by the CResult_ShutdownDecodeErrorZ.
15698 void CResult_ShutdownDecodeErrorZ_free(struct LDKCResult_ShutdownDecodeErrorZ _res);
15701 * Creates a new CResult_ShutdownDecodeErrorZ which has the same data as `orig`
15702 * but with all dynamically-allocated buffers duplicated in new buffers.
15704 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_clone(const struct LDKCResult_ShutdownDecodeErrorZ *NONNULL_PTR orig);
15707 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ in the success state.
15709 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_ok(struct LDKUpdateFailHTLC o);
15712 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ in the error state.
15714 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_err(struct LDKDecodeError e);
15717 * Checks if the given object is currently in the success state
15719 bool CResult_UpdateFailHTLCDecodeErrorZ_is_ok(const struct LDKCResult_UpdateFailHTLCDecodeErrorZ *NONNULL_PTR o);
15722 * Frees any resources used by the CResult_UpdateFailHTLCDecodeErrorZ.
15724 void CResult_UpdateFailHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFailHTLCDecodeErrorZ _res);
15727 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ which has the same data as `orig`
15728 * but with all dynamically-allocated buffers duplicated in new buffers.
15730 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFailHTLCDecodeErrorZ *NONNULL_PTR orig);
15733 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ in the success state.
15735 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_ok(struct LDKUpdateFailMalformedHTLC o);
15738 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ in the error state.
15740 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_err(struct LDKDecodeError e);
15743 * Checks if the given object is currently in the success state
15745 bool CResult_UpdateFailMalformedHTLCDecodeErrorZ_is_ok(const struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ *NONNULL_PTR o);
15748 * Frees any resources used by the CResult_UpdateFailMalformedHTLCDecodeErrorZ.
15750 void CResult_UpdateFailMalformedHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ _res);
15753 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ which has the same data as `orig`
15754 * but with all dynamically-allocated buffers duplicated in new buffers.
15756 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ *NONNULL_PTR orig);
15759 * Creates a new CResult_UpdateFeeDecodeErrorZ in the success state.
15761 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_ok(struct LDKUpdateFee o);
15764 * Creates a new CResult_UpdateFeeDecodeErrorZ in the error state.
15766 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_err(struct LDKDecodeError e);
15769 * Checks if the given object is currently in the success state
15771 bool CResult_UpdateFeeDecodeErrorZ_is_ok(const struct LDKCResult_UpdateFeeDecodeErrorZ *NONNULL_PTR o);
15774 * Frees any resources used by the CResult_UpdateFeeDecodeErrorZ.
15776 void CResult_UpdateFeeDecodeErrorZ_free(struct LDKCResult_UpdateFeeDecodeErrorZ _res);
15779 * Creates a new CResult_UpdateFeeDecodeErrorZ which has the same data as `orig`
15780 * but with all dynamically-allocated buffers duplicated in new buffers.
15782 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_clone(const struct LDKCResult_UpdateFeeDecodeErrorZ *NONNULL_PTR orig);
15785 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ in the success state.
15787 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_ok(struct LDKUpdateFulfillHTLC o);
15790 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ in the error state.
15792 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_err(struct LDKDecodeError e);
15795 * Checks if the given object is currently in the success state
15797 bool CResult_UpdateFulfillHTLCDecodeErrorZ_is_ok(const struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ *NONNULL_PTR o);
15800 * Frees any resources used by the CResult_UpdateFulfillHTLCDecodeErrorZ.
15802 void CResult_UpdateFulfillHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ _res);
15805 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ which has the same data as `orig`
15806 * but with all dynamically-allocated buffers duplicated in new buffers.
15808 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ *NONNULL_PTR orig);
15811 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ in the success state.
15813 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_ok(struct LDKUpdateAddHTLC o);
15816 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ in the error state.
15818 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_err(struct LDKDecodeError e);
15821 * Checks if the given object is currently in the success state
15823 bool CResult_UpdateAddHTLCDecodeErrorZ_is_ok(const struct LDKCResult_UpdateAddHTLCDecodeErrorZ *NONNULL_PTR o);
15826 * Frees any resources used by the CResult_UpdateAddHTLCDecodeErrorZ.
15828 void CResult_UpdateAddHTLCDecodeErrorZ_free(struct LDKCResult_UpdateAddHTLCDecodeErrorZ _res);
15831 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ which has the same data as `orig`
15832 * but with all dynamically-allocated buffers duplicated in new buffers.
15834 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateAddHTLCDecodeErrorZ *NONNULL_PTR orig);
15837 * Creates a new CResult_PingDecodeErrorZ in the success state.
15839 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_ok(struct LDKPing o);
15842 * Creates a new CResult_PingDecodeErrorZ in the error state.
15844 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_err(struct LDKDecodeError e);
15847 * Checks if the given object is currently in the success state
15849 bool CResult_PingDecodeErrorZ_is_ok(const struct LDKCResult_PingDecodeErrorZ *NONNULL_PTR o);
15852 * Frees any resources used by the CResult_PingDecodeErrorZ.
15854 void CResult_PingDecodeErrorZ_free(struct LDKCResult_PingDecodeErrorZ _res);
15857 * Creates a new CResult_PingDecodeErrorZ which has the same data as `orig`
15858 * but with all dynamically-allocated buffers duplicated in new buffers.
15860 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_clone(const struct LDKCResult_PingDecodeErrorZ *NONNULL_PTR orig);
15863 * Creates a new CResult_PongDecodeErrorZ in the success state.
15865 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_ok(struct LDKPong o);
15868 * Creates a new CResult_PongDecodeErrorZ in the error state.
15870 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_err(struct LDKDecodeError e);
15873 * Checks if the given object is currently in the success state
15875 bool CResult_PongDecodeErrorZ_is_ok(const struct LDKCResult_PongDecodeErrorZ *NONNULL_PTR o);
15878 * Frees any resources used by the CResult_PongDecodeErrorZ.
15880 void CResult_PongDecodeErrorZ_free(struct LDKCResult_PongDecodeErrorZ _res);
15883 * Creates a new CResult_PongDecodeErrorZ which has the same data as `orig`
15884 * but with all dynamically-allocated buffers duplicated in new buffers.
15886 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_clone(const struct LDKCResult_PongDecodeErrorZ *NONNULL_PTR orig);
15889 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ in the success state.
15891 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_ok(struct LDKUnsignedChannelAnnouncement o);
15894 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ in the error state.
15896 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
15899 * Checks if the given object is currently in the success state
15901 bool CResult_UnsignedChannelAnnouncementDecodeErrorZ_is_ok(const struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ *NONNULL_PTR o);
15904 * Frees any resources used by the CResult_UnsignedChannelAnnouncementDecodeErrorZ.
15906 void CResult_UnsignedChannelAnnouncementDecodeErrorZ_free(struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ _res);
15909 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ which has the same data as `orig`
15910 * but with all dynamically-allocated buffers duplicated in new buffers.
15912 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_clone(const struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ *NONNULL_PTR orig);
15915 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ in the success state.
15917 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_ok(struct LDKChannelAnnouncement o);
15920 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ in the error state.
15922 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
15925 * Checks if the given object is currently in the success state
15927 bool CResult_ChannelAnnouncementDecodeErrorZ_is_ok(const struct LDKCResult_ChannelAnnouncementDecodeErrorZ *NONNULL_PTR o);
15930 * Frees any resources used by the CResult_ChannelAnnouncementDecodeErrorZ.
15932 void CResult_ChannelAnnouncementDecodeErrorZ_free(struct LDKCResult_ChannelAnnouncementDecodeErrorZ _res);
15935 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ which has the same data as `orig`
15936 * but with all dynamically-allocated buffers duplicated in new buffers.
15938 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_clone(const struct LDKCResult_ChannelAnnouncementDecodeErrorZ *NONNULL_PTR orig);
15941 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ in the success state.
15943 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_ok(struct LDKUnsignedChannelUpdate o);
15946 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ in the error state.
15948 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_err(struct LDKDecodeError e);
15951 * Checks if the given object is currently in the success state
15953 bool CResult_UnsignedChannelUpdateDecodeErrorZ_is_ok(const struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ *NONNULL_PTR o);
15956 * Frees any resources used by the CResult_UnsignedChannelUpdateDecodeErrorZ.
15958 void CResult_UnsignedChannelUpdateDecodeErrorZ_free(struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ _res);
15961 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ which has the same data as `orig`
15962 * but with all dynamically-allocated buffers duplicated in new buffers.
15964 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_clone(const struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ *NONNULL_PTR orig);
15967 * Creates a new CResult_ChannelUpdateDecodeErrorZ in the success state.
15969 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_ok(struct LDKChannelUpdate o);
15972 * Creates a new CResult_ChannelUpdateDecodeErrorZ in the error state.
15974 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_err(struct LDKDecodeError e);
15977 * Checks if the given object is currently in the success state
15979 bool CResult_ChannelUpdateDecodeErrorZ_is_ok(const struct LDKCResult_ChannelUpdateDecodeErrorZ *NONNULL_PTR o);
15982 * Frees any resources used by the CResult_ChannelUpdateDecodeErrorZ.
15984 void CResult_ChannelUpdateDecodeErrorZ_free(struct LDKCResult_ChannelUpdateDecodeErrorZ _res);
15987 * Creates a new CResult_ChannelUpdateDecodeErrorZ which has the same data as `orig`
15988 * but with all dynamically-allocated buffers duplicated in new buffers.
15990 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_clone(const struct LDKCResult_ChannelUpdateDecodeErrorZ *NONNULL_PTR orig);
15993 * Creates a new CResult_ErrorMessageDecodeErrorZ in the success state.
15995 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_ok(struct LDKErrorMessage o);
15998 * Creates a new CResult_ErrorMessageDecodeErrorZ in the error state.
16000 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_err(struct LDKDecodeError e);
16003 * Checks if the given object is currently in the success state
16005 bool CResult_ErrorMessageDecodeErrorZ_is_ok(const struct LDKCResult_ErrorMessageDecodeErrorZ *NONNULL_PTR o);
16008 * Frees any resources used by the CResult_ErrorMessageDecodeErrorZ.
16010 void CResult_ErrorMessageDecodeErrorZ_free(struct LDKCResult_ErrorMessageDecodeErrorZ _res);
16013 * Creates a new CResult_ErrorMessageDecodeErrorZ which has the same data as `orig`
16014 * but with all dynamically-allocated buffers duplicated in new buffers.
16016 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_clone(const struct LDKCResult_ErrorMessageDecodeErrorZ *NONNULL_PTR orig);
16019 * Creates a new CResult_WarningMessageDecodeErrorZ in the success state.
16021 struct LDKCResult_WarningMessageDecodeErrorZ CResult_WarningMessageDecodeErrorZ_ok(struct LDKWarningMessage o);
16024 * Creates a new CResult_WarningMessageDecodeErrorZ in the error state.
16026 struct LDKCResult_WarningMessageDecodeErrorZ CResult_WarningMessageDecodeErrorZ_err(struct LDKDecodeError e);
16029 * Checks if the given object is currently in the success state
16031 bool CResult_WarningMessageDecodeErrorZ_is_ok(const struct LDKCResult_WarningMessageDecodeErrorZ *NONNULL_PTR o);
16034 * Frees any resources used by the CResult_WarningMessageDecodeErrorZ.
16036 void CResult_WarningMessageDecodeErrorZ_free(struct LDKCResult_WarningMessageDecodeErrorZ _res);
16039 * Creates a new CResult_WarningMessageDecodeErrorZ which has the same data as `orig`
16040 * but with all dynamically-allocated buffers duplicated in new buffers.
16042 struct LDKCResult_WarningMessageDecodeErrorZ CResult_WarningMessageDecodeErrorZ_clone(const struct LDKCResult_WarningMessageDecodeErrorZ *NONNULL_PTR orig);
16045 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ in the success state.
16047 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_ok(struct LDKUnsignedNodeAnnouncement o);
16050 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ in the error state.
16052 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
16055 * Checks if the given object is currently in the success state
16057 bool CResult_UnsignedNodeAnnouncementDecodeErrorZ_is_ok(const struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ *NONNULL_PTR o);
16060 * Frees any resources used by the CResult_UnsignedNodeAnnouncementDecodeErrorZ.
16062 void CResult_UnsignedNodeAnnouncementDecodeErrorZ_free(struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ _res);
16065 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ which has the same data as `orig`
16066 * but with all dynamically-allocated buffers duplicated in new buffers.
16068 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_clone(const struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ *NONNULL_PTR orig);
16071 * Creates a new CResult_NodeAnnouncementDecodeErrorZ in the success state.
16073 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_ok(struct LDKNodeAnnouncement o);
16076 * Creates a new CResult_NodeAnnouncementDecodeErrorZ in the error state.
16078 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
16081 * Checks if the given object is currently in the success state
16083 bool CResult_NodeAnnouncementDecodeErrorZ_is_ok(const struct LDKCResult_NodeAnnouncementDecodeErrorZ *NONNULL_PTR o);
16086 * Frees any resources used by the CResult_NodeAnnouncementDecodeErrorZ.
16088 void CResult_NodeAnnouncementDecodeErrorZ_free(struct LDKCResult_NodeAnnouncementDecodeErrorZ _res);
16091 * Creates a new CResult_NodeAnnouncementDecodeErrorZ which has the same data as `orig`
16092 * but with all dynamically-allocated buffers duplicated in new buffers.
16094 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_clone(const struct LDKCResult_NodeAnnouncementDecodeErrorZ *NONNULL_PTR orig);
16097 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ in the success state.
16099 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_ok(struct LDKQueryShortChannelIds o);
16102 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ in the error state.
16104 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_err(struct LDKDecodeError e);
16107 * Checks if the given object is currently in the success state
16109 bool CResult_QueryShortChannelIdsDecodeErrorZ_is_ok(const struct LDKCResult_QueryShortChannelIdsDecodeErrorZ *NONNULL_PTR o);
16112 * Frees any resources used by the CResult_QueryShortChannelIdsDecodeErrorZ.
16114 void CResult_QueryShortChannelIdsDecodeErrorZ_free(struct LDKCResult_QueryShortChannelIdsDecodeErrorZ _res);
16117 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ which has the same data as `orig`
16118 * but with all dynamically-allocated buffers duplicated in new buffers.
16120 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_clone(const struct LDKCResult_QueryShortChannelIdsDecodeErrorZ *NONNULL_PTR orig);
16123 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ in the success state.
16125 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_ok(struct LDKReplyShortChannelIdsEnd o);
16128 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ in the error state.
16130 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_err(struct LDKDecodeError e);
16133 * Checks if the given object is currently in the success state
16135 bool CResult_ReplyShortChannelIdsEndDecodeErrorZ_is_ok(const struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ *NONNULL_PTR o);
16138 * Frees any resources used by the CResult_ReplyShortChannelIdsEndDecodeErrorZ.
16140 void CResult_ReplyShortChannelIdsEndDecodeErrorZ_free(struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ _res);
16143 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ which has the same data as `orig`
16144 * but with all dynamically-allocated buffers duplicated in new buffers.
16146 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_clone(const struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ *NONNULL_PTR orig);
16149 * Creates a new CResult_QueryChannelRangeDecodeErrorZ in the success state.
16151 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_ok(struct LDKQueryChannelRange o);
16154 * Creates a new CResult_QueryChannelRangeDecodeErrorZ in the error state.
16156 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_err(struct LDKDecodeError e);
16159 * Checks if the given object is currently in the success state
16161 bool CResult_QueryChannelRangeDecodeErrorZ_is_ok(const struct LDKCResult_QueryChannelRangeDecodeErrorZ *NONNULL_PTR o);
16164 * Frees any resources used by the CResult_QueryChannelRangeDecodeErrorZ.
16166 void CResult_QueryChannelRangeDecodeErrorZ_free(struct LDKCResult_QueryChannelRangeDecodeErrorZ _res);
16169 * Creates a new CResult_QueryChannelRangeDecodeErrorZ which has the same data as `orig`
16170 * but with all dynamically-allocated buffers duplicated in new buffers.
16172 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_clone(const struct LDKCResult_QueryChannelRangeDecodeErrorZ *NONNULL_PTR orig);
16175 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ in the success state.
16177 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_ok(struct LDKReplyChannelRange o);
16180 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ in the error state.
16182 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_err(struct LDKDecodeError e);
16185 * Checks if the given object is currently in the success state
16187 bool CResult_ReplyChannelRangeDecodeErrorZ_is_ok(const struct LDKCResult_ReplyChannelRangeDecodeErrorZ *NONNULL_PTR o);
16190 * Frees any resources used by the CResult_ReplyChannelRangeDecodeErrorZ.
16192 void CResult_ReplyChannelRangeDecodeErrorZ_free(struct LDKCResult_ReplyChannelRangeDecodeErrorZ _res);
16195 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ which has the same data as `orig`
16196 * but with all dynamically-allocated buffers duplicated in new buffers.
16198 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_clone(const struct LDKCResult_ReplyChannelRangeDecodeErrorZ *NONNULL_PTR orig);
16201 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ in the success state.
16203 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_ok(struct LDKGossipTimestampFilter o);
16206 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ in the error state.
16208 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_err(struct LDKDecodeError e);
16211 * Checks if the given object is currently in the success state
16213 bool CResult_GossipTimestampFilterDecodeErrorZ_is_ok(const struct LDKCResult_GossipTimestampFilterDecodeErrorZ *NONNULL_PTR o);
16216 * Frees any resources used by the CResult_GossipTimestampFilterDecodeErrorZ.
16218 void CResult_GossipTimestampFilterDecodeErrorZ_free(struct LDKCResult_GossipTimestampFilterDecodeErrorZ _res);
16221 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ which has the same data as `orig`
16222 * but with all dynamically-allocated buffers duplicated in new buffers.
16224 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_clone(const struct LDKCResult_GossipTimestampFilterDecodeErrorZ *NONNULL_PTR orig);
16227 * Frees the buffer pointed to by `data` if `datalen` is non-0.
16229 void CVec_PhantomRouteHintsZ_free(struct LDKCVec_PhantomRouteHintsZ _res);
16232 * Creates a new CResult_InvoiceSignOrCreationErrorZ in the success state.
16234 struct LDKCResult_InvoiceSignOrCreationErrorZ CResult_InvoiceSignOrCreationErrorZ_ok(struct LDKInvoice o);
16237 * Creates a new CResult_InvoiceSignOrCreationErrorZ in the error state.
16239 struct LDKCResult_InvoiceSignOrCreationErrorZ CResult_InvoiceSignOrCreationErrorZ_err(struct LDKSignOrCreationError e);
16242 * Checks if the given object is currently in the success state
16244 bool CResult_InvoiceSignOrCreationErrorZ_is_ok(const struct LDKCResult_InvoiceSignOrCreationErrorZ *NONNULL_PTR o);
16247 * Frees any resources used by the CResult_InvoiceSignOrCreationErrorZ.
16249 void CResult_InvoiceSignOrCreationErrorZ_free(struct LDKCResult_InvoiceSignOrCreationErrorZ _res);
16252 * Creates a new CResult_InvoiceSignOrCreationErrorZ which has the same data as `orig`
16253 * but with all dynamically-allocated buffers duplicated in new buffers.
16255 struct LDKCResult_InvoiceSignOrCreationErrorZ CResult_InvoiceSignOrCreationErrorZ_clone(const struct LDKCResult_InvoiceSignOrCreationErrorZ *NONNULL_PTR orig);
16258 * Constructs a new COption_FilterZ containing a crate::lightning::chain::Filter
16260 struct LDKCOption_FilterZ COption_FilterZ_some(struct LDKFilter o);
16263 * Constructs a new COption_FilterZ containing nothing
16265 struct LDKCOption_FilterZ COption_FilterZ_none(void);
16268 * Frees any resources associated with the crate::lightning::chain::Filter, if we are in the Some state
16270 void COption_FilterZ_free(struct LDKCOption_FilterZ _res);
16273 * Creates a new CResult_LockedChannelMonitorNoneZ in the success state.
16275 struct LDKCResult_LockedChannelMonitorNoneZ CResult_LockedChannelMonitorNoneZ_ok(struct LDKLockedChannelMonitor o);
16278 * Creates a new CResult_LockedChannelMonitorNoneZ in the error state.
16280 struct LDKCResult_LockedChannelMonitorNoneZ CResult_LockedChannelMonitorNoneZ_err(void);
16283 * Checks if the given object is currently in the success state
16285 bool CResult_LockedChannelMonitorNoneZ_is_ok(const struct LDKCResult_LockedChannelMonitorNoneZ *NONNULL_PTR o);
16288 * Frees any resources used by the CResult_LockedChannelMonitorNoneZ.
16290 void CResult_LockedChannelMonitorNoneZ_free(struct LDKCResult_LockedChannelMonitorNoneZ _res);
16293 * Frees the buffer pointed to by `data` if `datalen` is non-0.
16295 void CVec_OutPointZ_free(struct LDKCVec_OutPointZ _res);
16298 * Frees any resources used by the PaymentPurpose
16300 void PaymentPurpose_free(struct LDKPaymentPurpose this_ptr);
16303 * Creates a copy of the PaymentPurpose
16305 struct LDKPaymentPurpose PaymentPurpose_clone(const struct LDKPaymentPurpose *NONNULL_PTR orig);
16308 * Utility method to constructs a new InvoicePayment-variant PaymentPurpose
16310 struct LDKPaymentPurpose PaymentPurpose_invoice_payment(struct LDKThirtyTwoBytes payment_preimage, struct LDKThirtyTwoBytes payment_secret);
16313 * Utility method to constructs a new SpontaneousPayment-variant PaymentPurpose
16315 struct LDKPaymentPurpose PaymentPurpose_spontaneous_payment(struct LDKThirtyTwoBytes a);
16318 * Frees any resources used by the ClosureReason
16320 void ClosureReason_free(struct LDKClosureReason this_ptr);
16323 * Creates a copy of the ClosureReason
16325 struct LDKClosureReason ClosureReason_clone(const struct LDKClosureReason *NONNULL_PTR orig);
16328 * Utility method to constructs a new CounterpartyForceClosed-variant ClosureReason
16330 struct LDKClosureReason ClosureReason_counterparty_force_closed(struct LDKStr peer_msg);
16333 * Utility method to constructs a new HolderForceClosed-variant ClosureReason
16335 struct LDKClosureReason ClosureReason_holder_force_closed(void);
16338 * Utility method to constructs a new CooperativeClosure-variant ClosureReason
16340 struct LDKClosureReason ClosureReason_cooperative_closure(void);
16343 * Utility method to constructs a new CommitmentTxConfirmed-variant ClosureReason
16345 struct LDKClosureReason ClosureReason_commitment_tx_confirmed(void);
16348 * Utility method to constructs a new FundingTimedOut-variant ClosureReason
16350 struct LDKClosureReason ClosureReason_funding_timed_out(void);
16353 * Utility method to constructs a new ProcessingError-variant ClosureReason
16355 struct LDKClosureReason ClosureReason_processing_error(struct LDKStr err);
16358 * Utility method to constructs a new DisconnectedPeer-variant ClosureReason
16360 struct LDKClosureReason ClosureReason_disconnected_peer(void);
16363 * Utility method to constructs a new OutdatedChannelManager-variant ClosureReason
16365 struct LDKClosureReason ClosureReason_outdated_channel_manager(void);
16368 * Serialize the ClosureReason object into a byte array which can be read by ClosureReason_read
16370 struct LDKCVec_u8Z ClosureReason_write(const struct LDKClosureReason *NONNULL_PTR obj);
16373 * Read a ClosureReason from a byte array, created by ClosureReason_write
16375 struct LDKCResult_COption_ClosureReasonZDecodeErrorZ ClosureReason_read(struct LDKu8slice ser);
16378 * Frees any resources used by the Event
16380 void Event_free(struct LDKEvent this_ptr);
16383 * Creates a copy of the Event
16385 struct LDKEvent Event_clone(const struct LDKEvent *NONNULL_PTR orig);
16388 * Utility method to constructs a new FundingGenerationReady-variant Event
16390 struct LDKEvent Event_funding_generation_ready(struct LDKThirtyTwoBytes temporary_channel_id, uint64_t channel_value_satoshis, struct LDKCVec_u8Z output_script, uint64_t user_channel_id);
16393 * Utility method to constructs a new PaymentReceived-variant Event
16395 struct LDKEvent Event_payment_received(struct LDKThirtyTwoBytes payment_hash, uint64_t amt, struct LDKPaymentPurpose purpose);
16398 * Utility method to constructs a new PaymentSent-variant Event
16400 struct LDKEvent Event_payment_sent(struct LDKThirtyTwoBytes payment_id, struct LDKThirtyTwoBytes payment_preimage, struct LDKThirtyTwoBytes payment_hash, struct LDKCOption_u64Z fee_paid_msat);
16403 * Utility method to constructs a new PaymentPathFailed-variant Event
16405 struct LDKEvent Event_payment_path_failed(struct LDKThirtyTwoBytes payment_id, struct LDKThirtyTwoBytes payment_hash, bool rejected_by_dest, struct LDKCOption_NetworkUpdateZ network_update, bool all_paths_failed, struct LDKCVec_RouteHopZ path, struct LDKCOption_u64Z short_channel_id, struct LDKRouteParameters retry);
16408 * Utility method to constructs a new PaymentFailed-variant Event
16410 struct LDKEvent Event_payment_failed(struct LDKThirtyTwoBytes payment_id, struct LDKThirtyTwoBytes payment_hash);
16413 * Utility method to constructs a new PendingHTLCsForwardable-variant Event
16415 struct LDKEvent Event_pending_htlcs_forwardable(uint64_t time_forwardable);
16418 * Utility method to constructs a new SpendableOutputs-variant Event
16420 struct LDKEvent Event_spendable_outputs(struct LDKCVec_SpendableOutputDescriptorZ outputs);
16423 * Utility method to constructs a new PaymentForwarded-variant Event
16425 struct LDKEvent Event_payment_forwarded(struct LDKCOption_u64Z fee_earned_msat, bool claim_from_onchain_tx);
16428 * Utility method to constructs a new ChannelClosed-variant Event
16430 struct LDKEvent Event_channel_closed(struct LDKThirtyTwoBytes channel_id, uint64_t user_channel_id, struct LDKClosureReason reason);
16433 * Utility method to constructs a new DiscardFunding-variant Event
16435 struct LDKEvent Event_discard_funding(struct LDKThirtyTwoBytes channel_id, struct LDKTransaction transaction);
16438 * Utility method to constructs a new PaymentPathSuccessful-variant Event
16440 struct LDKEvent Event_payment_path_successful(struct LDKThirtyTwoBytes payment_id, struct LDKThirtyTwoBytes payment_hash, struct LDKCVec_RouteHopZ path);
16443 * Utility method to constructs a new OpenChannelRequest-variant Event
16445 struct LDKEvent Event_open_channel_request(struct LDKThirtyTwoBytes temporary_channel_id, struct LDKPublicKey counterparty_node_id, uint64_t funding_satoshis, uint64_t push_msat);
16448 * Serialize the Event object into a byte array which can be read by Event_read
16450 struct LDKCVec_u8Z Event_write(const struct LDKEvent *NONNULL_PTR obj);
16453 * Read a Event from a byte array, created by Event_write
16455 struct LDKCResult_COption_EventZDecodeErrorZ Event_read(struct LDKu8slice ser);
16458 * Frees any resources used by the MessageSendEvent
16460 void MessageSendEvent_free(struct LDKMessageSendEvent this_ptr);
16463 * Creates a copy of the MessageSendEvent
16465 struct LDKMessageSendEvent MessageSendEvent_clone(const struct LDKMessageSendEvent *NONNULL_PTR orig);
16468 * Utility method to constructs a new SendAcceptChannel-variant MessageSendEvent
16470 struct LDKMessageSendEvent MessageSendEvent_send_accept_channel(struct LDKPublicKey node_id, struct LDKAcceptChannel msg);
16473 * Utility method to constructs a new SendOpenChannel-variant MessageSendEvent
16475 struct LDKMessageSendEvent MessageSendEvent_send_open_channel(struct LDKPublicKey node_id, struct LDKOpenChannel msg);
16478 * Utility method to constructs a new SendFundingCreated-variant MessageSendEvent
16480 struct LDKMessageSendEvent MessageSendEvent_send_funding_created(struct LDKPublicKey node_id, struct LDKFundingCreated msg);
16483 * Utility method to constructs a new SendFundingSigned-variant MessageSendEvent
16485 struct LDKMessageSendEvent MessageSendEvent_send_funding_signed(struct LDKPublicKey node_id, struct LDKFundingSigned msg);
16488 * Utility method to constructs a new SendFundingLocked-variant MessageSendEvent
16490 struct LDKMessageSendEvent MessageSendEvent_send_funding_locked(struct LDKPublicKey node_id, struct LDKFundingLocked msg);
16493 * Utility method to constructs a new SendAnnouncementSignatures-variant MessageSendEvent
16495 struct LDKMessageSendEvent MessageSendEvent_send_announcement_signatures(struct LDKPublicKey node_id, struct LDKAnnouncementSignatures msg);
16498 * Utility method to constructs a new UpdateHTLCs-variant MessageSendEvent
16500 struct LDKMessageSendEvent MessageSendEvent_update_htlcs(struct LDKPublicKey node_id, struct LDKCommitmentUpdate updates);
16503 * Utility method to constructs a new SendRevokeAndACK-variant MessageSendEvent
16505 struct LDKMessageSendEvent MessageSendEvent_send_revoke_and_ack(struct LDKPublicKey node_id, struct LDKRevokeAndACK msg);
16508 * Utility method to constructs a new SendClosingSigned-variant MessageSendEvent
16510 struct LDKMessageSendEvent MessageSendEvent_send_closing_signed(struct LDKPublicKey node_id, struct LDKClosingSigned msg);
16513 * Utility method to constructs a new SendShutdown-variant MessageSendEvent
16515 struct LDKMessageSendEvent MessageSendEvent_send_shutdown(struct LDKPublicKey node_id, struct LDKShutdown msg);
16518 * Utility method to constructs a new SendChannelReestablish-variant MessageSendEvent
16520 struct LDKMessageSendEvent MessageSendEvent_send_channel_reestablish(struct LDKPublicKey node_id, struct LDKChannelReestablish msg);
16523 * Utility method to constructs a new BroadcastChannelAnnouncement-variant MessageSendEvent
16525 struct LDKMessageSendEvent MessageSendEvent_broadcast_channel_announcement(struct LDKChannelAnnouncement msg, struct LDKChannelUpdate update_msg);
16528 * Utility method to constructs a new BroadcastNodeAnnouncement-variant MessageSendEvent
16530 struct LDKMessageSendEvent MessageSendEvent_broadcast_node_announcement(struct LDKNodeAnnouncement msg);
16533 * Utility method to constructs a new BroadcastChannelUpdate-variant MessageSendEvent
16535 struct LDKMessageSendEvent MessageSendEvent_broadcast_channel_update(struct LDKChannelUpdate msg);
16538 * Utility method to constructs a new SendChannelUpdate-variant MessageSendEvent
16540 struct LDKMessageSendEvent MessageSendEvent_send_channel_update(struct LDKPublicKey node_id, struct LDKChannelUpdate msg);
16543 * Utility method to constructs a new HandleError-variant MessageSendEvent
16545 struct LDKMessageSendEvent MessageSendEvent_handle_error(struct LDKPublicKey node_id, struct LDKErrorAction action);
16548 * Utility method to constructs a new SendChannelRangeQuery-variant MessageSendEvent
16550 struct LDKMessageSendEvent MessageSendEvent_send_channel_range_query(struct LDKPublicKey node_id, struct LDKQueryChannelRange msg);
16553 * Utility method to constructs a new SendShortIdsQuery-variant MessageSendEvent
16555 struct LDKMessageSendEvent MessageSendEvent_send_short_ids_query(struct LDKPublicKey node_id, struct LDKQueryShortChannelIds msg);
16558 * Utility method to constructs a new SendReplyChannelRange-variant MessageSendEvent
16560 struct LDKMessageSendEvent MessageSendEvent_send_reply_channel_range(struct LDKPublicKey node_id, struct LDKReplyChannelRange msg);
16563 * Calls the free function if one is set
16565 void MessageSendEventsProvider_free(struct LDKMessageSendEventsProvider this_ptr);
16568 * Calls the free function if one is set
16570 void EventsProvider_free(struct LDKEventsProvider this_ptr);
16573 * Calls the free function if one is set
16575 void EventHandler_free(struct LDKEventHandler this_ptr);
16578 * Frees any resources used by the APIError
16580 void APIError_free(struct LDKAPIError this_ptr);
16583 * Creates a copy of the APIError
16585 struct LDKAPIError APIError_clone(const struct LDKAPIError *NONNULL_PTR orig);
16588 * Utility method to constructs a new APIMisuseError-variant APIError
16590 struct LDKAPIError APIError_apimisuse_error(struct LDKStr err);
16593 * Utility method to constructs a new FeeRateTooHigh-variant APIError
16595 struct LDKAPIError APIError_fee_rate_too_high(struct LDKStr err, uint32_t feerate);
16598 * Utility method to constructs a new RouteError-variant APIError
16600 struct LDKAPIError APIError_route_error(struct LDKStr err);
16603 * Utility method to constructs a new ChannelUnavailable-variant APIError
16605 struct LDKAPIError APIError_channel_unavailable(struct LDKStr err);
16608 * Utility method to constructs a new MonitorUpdateFailed-variant APIError
16610 struct LDKAPIError APIError_monitor_update_failed(void);
16613 * Utility method to constructs a new IncompatibleShutdownScript-variant APIError
16615 struct LDKAPIError APIError_incompatible_shutdown_script(struct LDKShutdownScript script);
16618 * Creates a digital signature of a message given a SecretKey, like the node's secret.
16619 * A receiver knowing the PublicKey (e.g. the node's id) and the message can be sure that the signature was generated by the caller.
16620 * Signatures are EC recoverable, meaning that given the message and the signature the PublicKey of the signer can be extracted.
16622 struct LDKCResult_StringErrorZ sign(struct LDKu8slice msg, const uint8_t (*sk)[32]);
16625 * Recovers the PublicKey of the signer of the message given the message and the signature.
16627 struct LDKCResult_PublicKeyErrorZ recover_pk(struct LDKu8slice msg, struct LDKStr sig);
16630 * Verifies a message was signed by a PrivateKey that derives to a given PublicKey, given a message, a signature,
16631 * and the PublicKey.
16633 bool verify(struct LDKu8slice msg, struct LDKStr sig, struct LDKPublicKey pk);
16636 * Construct the invoice's HRP and signatureless data into a preimage to be hashed.
16638 struct LDKCVec_u8Z construct_invoice_preimage(struct LDKu8slice hrp_bytes, struct LDKCVec_u5Z data_without_signature);
16641 * Creates a copy of the Level
16643 enum LDKLevel Level_clone(const enum LDKLevel *NONNULL_PTR orig);
16646 * Utility method to constructs a new Gossip-variant Level
16648 enum LDKLevel Level_gossip(void);
16651 * Utility method to constructs a new Trace-variant Level
16653 enum LDKLevel Level_trace(void);
16656 * Utility method to constructs a new Debug-variant Level
16658 enum LDKLevel Level_debug(void);
16661 * Utility method to constructs a new Info-variant Level
16663 enum LDKLevel Level_info(void);
16666 * Utility method to constructs a new Warn-variant Level
16668 enum LDKLevel Level_warn(void);
16671 * Utility method to constructs a new Error-variant Level
16673 enum LDKLevel Level_error(void);
16676 * Checks if two Levels contain equal inner contents.
16677 * This ignores pointers and is_owned flags and looks at the values in fields.
16679 bool Level_eq(const enum LDKLevel *NONNULL_PTR a, const enum LDKLevel *NONNULL_PTR b);
16682 * Checks if two Levels contain equal inner contents.
16684 uint64_t Level_hash(const enum LDKLevel *NONNULL_PTR o);
16687 * Returns the most verbose logging level.
16689 MUST_USE_RES enum LDKLevel Level_max(void);
16692 * Frees any resources used by the Record, if is_owned is set and inner is non-NULL.
16694 void Record_free(struct LDKRecord this_obj);
16697 * The verbosity level of the message.
16699 enum LDKLevel Record_get_level(const struct LDKRecord *NONNULL_PTR this_ptr);
16702 * The verbosity level of the message.
16704 void Record_set_level(struct LDKRecord *NONNULL_PTR this_ptr, enum LDKLevel val);
16707 * The message body.
16709 struct LDKStr Record_get_args(const struct LDKRecord *NONNULL_PTR this_ptr);
16712 * The message body.
16714 void Record_set_args(struct LDKRecord *NONNULL_PTR this_ptr, struct LDKStr val);
16717 * The module path of the message.
16719 struct LDKStr Record_get_module_path(const struct LDKRecord *NONNULL_PTR this_ptr);
16722 * The module path of the message.
16724 void Record_set_module_path(struct LDKRecord *NONNULL_PTR this_ptr, struct LDKStr val);
16727 * The source file containing the message.
16729 struct LDKStr Record_get_file(const struct LDKRecord *NONNULL_PTR this_ptr);
16732 * The source file containing the message.
16734 void Record_set_file(struct LDKRecord *NONNULL_PTR this_ptr, struct LDKStr val);
16737 * The line containing the message.
16739 uint32_t Record_get_line(const struct LDKRecord *NONNULL_PTR this_ptr);
16742 * The line containing the message.
16744 void Record_set_line(struct LDKRecord *NONNULL_PTR this_ptr, uint32_t val);
16747 * Creates a copy of the Record
16749 struct LDKRecord Record_clone(const struct LDKRecord *NONNULL_PTR orig);
16752 * Calls the free function if one is set
16754 void Logger_free(struct LDKLogger this_ptr);
16757 * Frees any resources used by the ChannelHandshakeConfig, if is_owned is set and inner is non-NULL.
16759 void ChannelHandshakeConfig_free(struct LDKChannelHandshakeConfig this_obj);
16762 * Confirmations we will wait for before considering the channel locked in.
16763 * Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
16764 * equivalent limit applied to outbound channels).
16766 * Default value: 6.
16768 uint32_t ChannelHandshakeConfig_get_minimum_depth(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
16771 * Confirmations we will wait for before considering the channel locked in.
16772 * Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
16773 * equivalent limit applied to outbound channels).
16775 * Default value: 6.
16777 void ChannelHandshakeConfig_set_minimum_depth(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint32_t val);
16780 * Set to the number of blocks we require our counterparty to wait to claim their money (ie
16781 * the number of blocks we have to punish our counterparty if they broadcast a revoked
16784 * This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
16785 * be online to check for revoked transactions on-chain at least once every our_to_self_delay
16786 * blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
16787 * possibly with time in between to RBF the spending transaction).
16789 * Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
16790 * case of an honest unilateral channel close, which implicitly decrease the economic value of
16793 * Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
16794 * can tweak config to ask for more security, not less.
16796 uint16_t ChannelHandshakeConfig_get_our_to_self_delay(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
16799 * Set to the number of blocks we require our counterparty to wait to claim their money (ie
16800 * the number of blocks we have to punish our counterparty if they broadcast a revoked
16803 * This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
16804 * be online to check for revoked transactions on-chain at least once every our_to_self_delay
16805 * blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
16806 * possibly with time in between to RBF the spending transaction).
16808 * Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
16809 * case of an honest unilateral channel close, which implicitly decrease the economic value of
16812 * Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
16813 * can tweak config to ask for more security, not less.
16815 void ChannelHandshakeConfig_set_our_to_self_delay(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint16_t val);
16818 * Set to the smallest value HTLC we will accept to process.
16820 * This value is sent to our counterparty on channel-open and we close the channel any time
16821 * our counterparty misbehaves by sending us an HTLC with a value smaller than this.
16823 * Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
16826 uint64_t ChannelHandshakeConfig_get_our_htlc_minimum_msat(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
16829 * Set to the smallest value HTLC we will accept to process.
16831 * This value is sent to our counterparty on channel-open and we close the channel any time
16832 * our counterparty misbehaves by sending us an HTLC with a value smaller than this.
16834 * Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
16837 void ChannelHandshakeConfig_set_our_htlc_minimum_msat(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint64_t val);
16840 * Constructs a new ChannelHandshakeConfig given each field
16842 MUST_USE_RES struct LDKChannelHandshakeConfig ChannelHandshakeConfig_new(uint32_t minimum_depth_arg, uint16_t our_to_self_delay_arg, uint64_t our_htlc_minimum_msat_arg);
16845 * Creates a copy of the ChannelHandshakeConfig
16847 struct LDKChannelHandshakeConfig ChannelHandshakeConfig_clone(const struct LDKChannelHandshakeConfig *NONNULL_PTR orig);
16850 * Creates a "default" ChannelHandshakeConfig. See struct and individual field documentaiton for details on which values are used.
16852 MUST_USE_RES struct LDKChannelHandshakeConfig ChannelHandshakeConfig_default(void);
16855 * Frees any resources used by the ChannelHandshakeLimits, if is_owned is set and inner is non-NULL.
16857 void ChannelHandshakeLimits_free(struct LDKChannelHandshakeLimits this_obj);
16860 * Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
16861 * only applies to inbound channels.
16863 * Default value: 0.
16865 uint64_t ChannelHandshakeLimits_get_min_funding_satoshis(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
16868 * Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
16869 * only applies to inbound channels.
16871 * Default value: 0.
16873 void ChannelHandshakeLimits_set_min_funding_satoshis(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
16876 * The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
16877 * you to limit the maximum minimum-size they can require.
16879 * Default value: u64::max_value.
16881 uint64_t ChannelHandshakeLimits_get_max_htlc_minimum_msat(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
16884 * The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
16885 * you to limit the maximum minimum-size they can require.
16887 * Default value: u64::max_value.
16889 void ChannelHandshakeLimits_set_max_htlc_minimum_msat(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
16892 * The remote node sets a limit on the maximum value of pending HTLCs to them at any given
16893 * time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
16895 * Default value: 0.
16897 uint64_t ChannelHandshakeLimits_get_min_max_htlc_value_in_flight_msat(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
16900 * The remote node sets a limit on the maximum value of pending HTLCs to them at any given
16901 * time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
16903 * Default value: 0.
16905 void ChannelHandshakeLimits_set_min_max_htlc_value_in_flight_msat(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
16908 * The remote node will require we keep a certain amount in direct payment to ourselves at all
16909 * time, ensuring that we are able to be punished if we broadcast an old state. This allows to
16910 * you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
16912 * Default value: u64::max_value.
16914 uint64_t ChannelHandshakeLimits_get_max_channel_reserve_satoshis(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
16917 * The remote node will require we keep a certain amount in direct payment to ourselves at all
16918 * time, ensuring that we are able to be punished if we broadcast an old state. This allows to
16919 * you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
16921 * Default value: u64::max_value.
16923 void ChannelHandshakeLimits_set_max_channel_reserve_satoshis(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
16926 * The remote node sets a limit on the maximum number of pending HTLCs to them at any given
16927 * time. This allows you to set a minimum such value.
16929 * Default value: 0.
16931 uint16_t ChannelHandshakeLimits_get_min_max_accepted_htlcs(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
16934 * The remote node sets a limit on the maximum number of pending HTLCs to them at any given
16935 * time. This allows you to set a minimum such value.
16937 * Default value: 0.
16939 void ChannelHandshakeLimits_set_min_max_accepted_htlcs(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint16_t val);
16942 * Before a channel is usable the funding transaction will need to be confirmed by at least a
16943 * certain number of blocks, specified by the node which is not the funder (as the funder can
16944 * assume they aren't going to double-spend themselves).
16945 * This config allows you to set a limit on the maximum amount of time to wait.
16947 * Default value: 144, or roughly one day and only applies to outbound channels.
16949 uint32_t ChannelHandshakeLimits_get_max_minimum_depth(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
16952 * Before a channel is usable the funding transaction will need to be confirmed by at least a
16953 * certain number of blocks, specified by the node which is not the funder (as the funder can
16954 * assume they aren't going to double-spend themselves).
16955 * This config allows you to set a limit on the maximum amount of time to wait.
16957 * Default value: 144, or roughly one day and only applies to outbound channels.
16959 void ChannelHandshakeLimits_set_max_minimum_depth(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint32_t val);
16962 * Set to force an incoming channel to match our announced channel preference in
16963 * [`ChannelConfig::announced_channel`].
16965 * For a node which is not online reliably, this should be set to true and
16966 * [`ChannelConfig::announced_channel`] set to false, ensuring that no announced (aka public)
16967 * channels will ever be opened.
16969 * Default value: true.
16971 bool ChannelHandshakeLimits_get_force_announced_channel_preference(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
16974 * Set to force an incoming channel to match our announced channel preference in
16975 * [`ChannelConfig::announced_channel`].
16977 * For a node which is not online reliably, this should be set to true and
16978 * [`ChannelConfig::announced_channel`] set to false, ensuring that no announced (aka public)
16979 * channels will ever be opened.
16981 * Default value: true.
16983 void ChannelHandshakeLimits_set_force_announced_channel_preference(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, bool val);
16986 * Set to the amount of time we're willing to wait to claim money back to us.
16988 * Not checking this value would be a security issue, as our peer would be able to set it to
16989 * max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
16991 * Default value: 2016, which we also enforce as a maximum value so you can tweak config to
16992 * reduce the loss of having useless locked funds (if your peer accepts)
16994 uint16_t ChannelHandshakeLimits_get_their_to_self_delay(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
16997 * Set to the amount of time we're willing to wait to claim money back to us.
16999 * Not checking this value would be a security issue, as our peer would be able to set it to
17000 * max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
17002 * Default value: 2016, which we also enforce as a maximum value so you can tweak config to
17003 * reduce the loss of having useless locked funds (if your peer accepts)
17005 void ChannelHandshakeLimits_set_their_to_self_delay(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint16_t val);
17008 * Constructs a new ChannelHandshakeLimits given each field
17010 MUST_USE_RES struct LDKChannelHandshakeLimits ChannelHandshakeLimits_new(uint64_t min_funding_satoshis_arg, uint64_t max_htlc_minimum_msat_arg, uint64_t min_max_htlc_value_in_flight_msat_arg, uint64_t max_channel_reserve_satoshis_arg, uint16_t min_max_accepted_htlcs_arg, uint32_t max_minimum_depth_arg, bool force_announced_channel_preference_arg, uint16_t their_to_self_delay_arg);
17013 * Creates a copy of the ChannelHandshakeLimits
17015 struct LDKChannelHandshakeLimits ChannelHandshakeLimits_clone(const struct LDKChannelHandshakeLimits *NONNULL_PTR orig);
17018 * Creates a "default" ChannelHandshakeLimits. See struct and individual field documentaiton for details on which values are used.
17020 MUST_USE_RES struct LDKChannelHandshakeLimits ChannelHandshakeLimits_default(void);
17023 * Frees any resources used by the ChannelConfig, if is_owned is set and inner is non-NULL.
17025 void ChannelConfig_free(struct LDKChannelConfig this_obj);
17028 * Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
17029 * over the channel.
17030 * This may be allowed to change at runtime in a later update, however doing so must result in
17031 * update messages sent to notify all nodes of our updated relay fee.
17033 * Default value: 0.
17035 uint32_t ChannelConfig_get_forwarding_fee_proportional_millionths(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
17038 * Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
17039 * over the channel.
17040 * This may be allowed to change at runtime in a later update, however doing so must result in
17041 * update messages sent to notify all nodes of our updated relay fee.
17043 * Default value: 0.
17045 void ChannelConfig_set_forwarding_fee_proportional_millionths(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint32_t val);
17048 * Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
17049 * excess of [`forwarding_fee_proportional_millionths`].
17050 * This may be allowed to change at runtime in a later update, however doing so must result in
17051 * update messages sent to notify all nodes of our updated relay fee.
17053 * The default value of a single satoshi roughly matches the market rate on many routing nodes
17054 * as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
17057 * Default value: 1000.
17059 * [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
17061 uint32_t ChannelConfig_get_forwarding_fee_base_msat(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
17064 * Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
17065 * excess of [`forwarding_fee_proportional_millionths`].
17066 * This may be allowed to change at runtime in a later update, however doing so must result in
17067 * update messages sent to notify all nodes of our updated relay fee.
17069 * The default value of a single satoshi roughly matches the market rate on many routing nodes
17070 * as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
17073 * Default value: 1000.
17075 * [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
17077 void ChannelConfig_set_forwarding_fee_base_msat(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint32_t val);
17080 * The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
17081 * the channel this config applies to.
17083 * This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
17084 * HTLC balance when a channel appears on-chain whereas
17085 * [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
17086 * (non-HTLC-encumbered) balance.
17088 * Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
17089 * we (or one of our watchtowers) MUST be online to check for broadcast of the current
17090 * commitment transaction at least once per this many blocks (minus some margin to allow us
17091 * enough time to broadcast and confirm a transaction, possibly with time in between to RBF
17092 * the spending transaction).
17094 * Default value: 72 (12 hours at an average of 6 blocks/hour).
17095 * Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
17096 * [`MIN_CLTV_EXPIRY_DELTA`] instead.
17098 * [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
17100 uint16_t ChannelConfig_get_cltv_expiry_delta(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
17103 * The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
17104 * the channel this config applies to.
17106 * This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
17107 * HTLC balance when a channel appears on-chain whereas
17108 * [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
17109 * (non-HTLC-encumbered) balance.
17111 * Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
17112 * we (or one of our watchtowers) MUST be online to check for broadcast of the current
17113 * commitment transaction at least once per this many blocks (minus some margin to allow us
17114 * enough time to broadcast and confirm a transaction, possibly with time in between to RBF
17115 * the spending transaction).
17117 * Default value: 72 (12 hours at an average of 6 blocks/hour).
17118 * Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
17119 * [`MIN_CLTV_EXPIRY_DELTA`] instead.
17121 * [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
17123 void ChannelConfig_set_cltv_expiry_delta(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint16_t val);
17126 * Set to announce the channel publicly and notify all nodes that they can route via this
17129 * This should only be set to true for nodes which expect to be online reliably.
17131 * As the node which funds a channel picks this value this will only apply for new outbound
17132 * channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
17134 * This cannot be changed after the initial channel handshake.
17136 * Default value: false.
17138 bool ChannelConfig_get_announced_channel(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
17141 * Set to announce the channel publicly and notify all nodes that they can route via this
17144 * This should only be set to true for nodes which expect to be online reliably.
17146 * As the node which funds a channel picks this value this will only apply for new outbound
17147 * channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
17149 * This cannot be changed after the initial channel handshake.
17151 * Default value: false.
17153 void ChannelConfig_set_announced_channel(struct LDKChannelConfig *NONNULL_PTR this_ptr, bool val);
17156 * When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
17157 * supports it, they will then enforce the mutual-close output to us matches what we provided
17158 * at intialization, preventing us from closing to an alternate pubkey.
17160 * This is set to true by default to provide a slight increase in security, though ultimately
17161 * any attacker who is able to take control of a channel can just as easily send the funds via
17162 * lightning payments, so we never require that our counterparties support this option.
17164 * This cannot be changed after a channel has been initialized.
17166 * Default value: true.
17168 bool ChannelConfig_get_commit_upfront_shutdown_pubkey(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
17171 * When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
17172 * supports it, they will then enforce the mutual-close output to us matches what we provided
17173 * at intialization, preventing us from closing to an alternate pubkey.
17175 * This is set to true by default to provide a slight increase in security, though ultimately
17176 * any attacker who is able to take control of a channel can just as easily send the funds via
17177 * lightning payments, so we never require that our counterparties support this option.
17179 * This cannot be changed after a channel has been initialized.
17181 * Default value: true.
17183 void ChannelConfig_set_commit_upfront_shutdown_pubkey(struct LDKChannelConfig *NONNULL_PTR this_ptr, bool val);
17186 * Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
17187 * small to claim on-chain.
17189 * When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
17190 * not be claimable on-chain, instead being turned into additional miner fees if either
17191 * party force-closes the channel. Because the threshold is per-HTLC, our total exposure
17192 * to such payments may be sustantial if there are many dust HTLCs present when the
17193 * channel is force-closed.
17195 * This limit is applied for sent, forwarded, and received HTLCs and limits the total
17196 * exposure across all three types per-channel. Setting this too low may prevent the
17197 * sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
17198 * important to prevent stealing of dust HTLCs by miners.
17200 * Default value: 5_000_000 msat.
17202 uint64_t ChannelConfig_get_max_dust_htlc_exposure_msat(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
17205 * Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
17206 * small to claim on-chain.
17208 * When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
17209 * not be claimable on-chain, instead being turned into additional miner fees if either
17210 * party force-closes the channel. Because the threshold is per-HTLC, our total exposure
17211 * to such payments may be sustantial if there are many dust HTLCs present when the
17212 * channel is force-closed.
17214 * This limit is applied for sent, forwarded, and received HTLCs and limits the total
17215 * exposure across all three types per-channel. Setting this too low may prevent the
17216 * sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
17217 * important to prevent stealing of dust HTLCs by miners.
17219 * Default value: 5_000_000 msat.
17221 void ChannelConfig_set_max_dust_htlc_exposure_msat(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint64_t val);
17224 * The additional fee we're willing to pay to avoid waiting for the counterparty's
17225 * `to_self_delay` to reclaim funds.
17227 * When we close a channel cooperatively with our counterparty, we negotiate a fee for the
17228 * closing transaction which both sides find acceptable, ultimately paid by the channel
17229 * funder/initiator.
17231 * When we are the funder, because we have to pay the channel closing fee, we bound the
17232 * acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
17233 * this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
17234 * [`Normal`] feerate during normal operation, this value represents the additional fee we're
17235 * willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
17238 * When we are not the funder, we require the closing transaction fee pay at least our
17239 * [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
17240 * Thus, this value is ignored when we are not the funder.
17242 * Default value: 1000 satoshis.
17244 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
17245 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
17247 uint64_t ChannelConfig_get_force_close_avoidance_max_fee_satoshis(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
17250 * The additional fee we're willing to pay to avoid waiting for the counterparty's
17251 * `to_self_delay` to reclaim funds.
17253 * When we close a channel cooperatively with our counterparty, we negotiate a fee for the
17254 * closing transaction which both sides find acceptable, ultimately paid by the channel
17255 * funder/initiator.
17257 * When we are the funder, because we have to pay the channel closing fee, we bound the
17258 * acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
17259 * this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
17260 * [`Normal`] feerate during normal operation, this value represents the additional fee we're
17261 * willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
17264 * When we are not the funder, we require the closing transaction fee pay at least our
17265 * [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
17266 * Thus, this value is ignored when we are not the funder.
17268 * Default value: 1000 satoshis.
17270 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
17271 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
17273 void ChannelConfig_set_force_close_avoidance_max_fee_satoshis(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint64_t val);
17276 * Constructs a new ChannelConfig given each field
17278 MUST_USE_RES struct LDKChannelConfig ChannelConfig_new(uint32_t forwarding_fee_proportional_millionths_arg, uint32_t forwarding_fee_base_msat_arg, uint16_t cltv_expiry_delta_arg, bool announced_channel_arg, bool commit_upfront_shutdown_pubkey_arg, uint64_t max_dust_htlc_exposure_msat_arg, uint64_t force_close_avoidance_max_fee_satoshis_arg);
17281 * Creates a copy of the ChannelConfig
17283 struct LDKChannelConfig ChannelConfig_clone(const struct LDKChannelConfig *NONNULL_PTR orig);
17286 * Creates a "default" ChannelConfig. See struct and individual field documentaiton for details on which values are used.
17288 MUST_USE_RES struct LDKChannelConfig ChannelConfig_default(void);
17291 * Serialize the ChannelConfig object into a byte array which can be read by ChannelConfig_read
17293 struct LDKCVec_u8Z ChannelConfig_write(const struct LDKChannelConfig *NONNULL_PTR obj);
17296 * Read a ChannelConfig from a byte array, created by ChannelConfig_write
17298 struct LDKCResult_ChannelConfigDecodeErrorZ ChannelConfig_read(struct LDKu8slice ser);
17301 * Frees any resources used by the UserConfig, if is_owned is set and inner is non-NULL.
17303 void UserConfig_free(struct LDKUserConfig this_obj);
17306 * Channel config that we propose to our counterparty.
17308 struct LDKChannelHandshakeConfig UserConfig_get_own_channel_config(const struct LDKUserConfig *NONNULL_PTR this_ptr);
17311 * Channel config that we propose to our counterparty.
17313 void UserConfig_set_own_channel_config(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelHandshakeConfig val);
17316 * Limits applied to our counterparty's proposed channel config settings.
17318 struct LDKChannelHandshakeLimits UserConfig_get_peer_channel_config_limits(const struct LDKUserConfig *NONNULL_PTR this_ptr);
17321 * Limits applied to our counterparty's proposed channel config settings.
17323 void UserConfig_set_peer_channel_config_limits(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelHandshakeLimits val);
17326 * Channel config which affects behavior during channel lifetime.
17328 struct LDKChannelConfig UserConfig_get_channel_options(const struct LDKUserConfig *NONNULL_PTR this_ptr);
17331 * Channel config which affects behavior during channel lifetime.
17333 void UserConfig_set_channel_options(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelConfig val);
17336 * If this is set to false, we will reject any HTLCs which were to be forwarded over private
17337 * channels. This prevents us from taking on HTLC-forwarding risk when we intend to run as a
17338 * node which is not online reliably.
17340 * For nodes which are not online reliably, you should set all channels to *not* be announced
17341 * (using [`ChannelConfig::announced_channel`] and
17342 * [`ChannelHandshakeLimits::force_announced_channel_preference`]) and set this to false to
17343 * ensure you are not exposed to any forwarding risk.
17345 * Note that because you cannot change a channel's announced state after creation, there is no
17346 * way to disable forwarding on public channels retroactively. Thus, in order to change a node
17347 * from a publicly-announced forwarding node to a private non-forwarding node you must close
17348 * all your channels and open new ones. For privacy, you should also change your node_id
17349 * (swapping all private and public key material for new ones) at that time.
17351 * Default value: false.
17353 bool UserConfig_get_accept_forwards_to_priv_channels(const struct LDKUserConfig *NONNULL_PTR this_ptr);
17356 * If this is set to false, we will reject any HTLCs which were to be forwarded over private
17357 * channels. This prevents us from taking on HTLC-forwarding risk when we intend to run as a
17358 * node which is not online reliably.
17360 * For nodes which are not online reliably, you should set all channels to *not* be announced
17361 * (using [`ChannelConfig::announced_channel`] and
17362 * [`ChannelHandshakeLimits::force_announced_channel_preference`]) and set this to false to
17363 * ensure you are not exposed to any forwarding risk.
17365 * Note that because you cannot change a channel's announced state after creation, there is no
17366 * way to disable forwarding on public channels retroactively. Thus, in order to change a node
17367 * from a publicly-announced forwarding node to a private non-forwarding node you must close
17368 * all your channels and open new ones. For privacy, you should also change your node_id
17369 * (swapping all private and public key material for new ones) at that time.
17371 * Default value: false.
17373 void UserConfig_set_accept_forwards_to_priv_channels(struct LDKUserConfig *NONNULL_PTR this_ptr, bool val);
17376 * If this is set to false, we do not accept inbound requests to open a new channel.
17377 * Default value: true.
17379 bool UserConfig_get_accept_inbound_channels(const struct LDKUserConfig *NONNULL_PTR this_ptr);
17382 * If this is set to false, we do not accept inbound requests to open a new channel.
17383 * Default value: true.
17385 void UserConfig_set_accept_inbound_channels(struct LDKUserConfig *NONNULL_PTR this_ptr, bool val);
17388 * If this is set to true, the user needs to manually accept inbound requests to open a new
17391 * When set to true, [`Event::OpenChannelRequest`] will be triggered once a request to open a
17392 * new inbound channel is received through a [`msgs::OpenChannel`] message. In that case, a
17393 * [`msgs::AcceptChannel`] message will not be sent back to the counterparty node unless the
17394 * user explicitly chooses to accept the request.
17396 * Default value: false.
17398 * [`Event::OpenChannelRequest`]: crate::util::events::Event::OpenChannelRequest
17399 * [`msgs::OpenChannel`]: crate::ln::msgs::OpenChannel
17400 * [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
17402 bool UserConfig_get_manually_accept_inbound_channels(const struct LDKUserConfig *NONNULL_PTR this_ptr);
17405 * If this is set to true, the user needs to manually accept inbound requests to open a new
17408 * When set to true, [`Event::OpenChannelRequest`] will be triggered once a request to open a
17409 * new inbound channel is received through a [`msgs::OpenChannel`] message. In that case, a
17410 * [`msgs::AcceptChannel`] message will not be sent back to the counterparty node unless the
17411 * user explicitly chooses to accept the request.
17413 * Default value: false.
17415 * [`Event::OpenChannelRequest`]: crate::util::events::Event::OpenChannelRequest
17416 * [`msgs::OpenChannel`]: crate::ln::msgs::OpenChannel
17417 * [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
17419 void UserConfig_set_manually_accept_inbound_channels(struct LDKUserConfig *NONNULL_PTR this_ptr, bool val);
17422 * Constructs a new UserConfig given each field
17424 MUST_USE_RES struct LDKUserConfig UserConfig_new(struct LDKChannelHandshakeConfig own_channel_config_arg, struct LDKChannelHandshakeLimits peer_channel_config_limits_arg, struct LDKChannelConfig channel_options_arg, bool accept_forwards_to_priv_channels_arg, bool accept_inbound_channels_arg, bool manually_accept_inbound_channels_arg);
17427 * Creates a copy of the UserConfig
17429 struct LDKUserConfig UserConfig_clone(const struct LDKUserConfig *NONNULL_PTR orig);
17432 * Creates a "default" UserConfig. See struct and individual field documentaiton for details on which values are used.
17434 MUST_USE_RES struct LDKUserConfig UserConfig_default(void);
17437 * Frees any resources used by the BestBlock, if is_owned is set and inner is non-NULL.
17439 void BestBlock_free(struct LDKBestBlock this_obj);
17442 * Creates a copy of the BestBlock
17444 struct LDKBestBlock BestBlock_clone(const struct LDKBestBlock *NONNULL_PTR orig);
17447 * Constructs a `BestBlock` that represents the genesis block at height 0 of the given
17450 MUST_USE_RES struct LDKBestBlock BestBlock_from_genesis(enum LDKNetwork network);
17453 * Returns a `BestBlock` as identified by the given block hash and height.
17455 MUST_USE_RES struct LDKBestBlock BestBlock_new(struct LDKThirtyTwoBytes block_hash, uint32_t height);
17458 * Returns the best block hash.
17460 MUST_USE_RES struct LDKThirtyTwoBytes BestBlock_block_hash(const struct LDKBestBlock *NONNULL_PTR this_arg);
17463 * Returns the best block height.
17465 MUST_USE_RES uint32_t BestBlock_height(const struct LDKBestBlock *NONNULL_PTR this_arg);
17468 * Creates a copy of the AccessError
17470 enum LDKAccessError AccessError_clone(const enum LDKAccessError *NONNULL_PTR orig);
17473 * Utility method to constructs a new UnknownChain-variant AccessError
17475 enum LDKAccessError AccessError_unknown_chain(void);
17478 * Utility method to constructs a new UnknownTx-variant AccessError
17480 enum LDKAccessError AccessError_unknown_tx(void);
17483 * Calls the free function if one is set
17485 void Access_free(struct LDKAccess this_ptr);
17488 * Calls the free function if one is set
17490 void Listen_free(struct LDKListen this_ptr);
17493 * Calls the free function if one is set
17495 void Confirm_free(struct LDKConfirm this_ptr);
17498 * Creates a copy of the ChannelMonitorUpdateErr
17500 enum LDKChannelMonitorUpdateErr ChannelMonitorUpdateErr_clone(const enum LDKChannelMonitorUpdateErr *NONNULL_PTR orig);
17503 * Utility method to constructs a new TemporaryFailure-variant ChannelMonitorUpdateErr
17505 enum LDKChannelMonitorUpdateErr ChannelMonitorUpdateErr_temporary_failure(void);
17508 * Utility method to constructs a new PermanentFailure-variant ChannelMonitorUpdateErr
17510 enum LDKChannelMonitorUpdateErr ChannelMonitorUpdateErr_permanent_failure(void);
17513 * Calls the free function if one is set
17515 void Watch_free(struct LDKWatch this_ptr);
17518 * Calls the free function if one is set
17520 void Filter_free(struct LDKFilter this_ptr);
17523 * Frees any resources used by the WatchedOutput, if is_owned is set and inner is non-NULL.
17525 void WatchedOutput_free(struct LDKWatchedOutput this_obj);
17528 * First block where the transaction output may have been spent.
17530 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
17532 struct LDKThirtyTwoBytes WatchedOutput_get_block_hash(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
17535 * First block where the transaction output may have been spent.
17537 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
17539 void WatchedOutput_set_block_hash(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17542 * Outpoint identifying the transaction output.
17544 struct LDKOutPoint WatchedOutput_get_outpoint(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
17547 * Outpoint identifying the transaction output.
17549 void WatchedOutput_set_outpoint(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKOutPoint val);
17552 * Spending condition of the transaction output.
17554 struct LDKu8slice WatchedOutput_get_script_pubkey(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
17557 * Spending condition of the transaction output.
17559 void WatchedOutput_set_script_pubkey(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
17562 * Constructs a new WatchedOutput given each field
17564 MUST_USE_RES struct LDKWatchedOutput WatchedOutput_new(struct LDKThirtyTwoBytes block_hash_arg, struct LDKOutPoint outpoint_arg, struct LDKCVec_u8Z script_pubkey_arg);
17567 * Creates a copy of the WatchedOutput
17569 struct LDKWatchedOutput WatchedOutput_clone(const struct LDKWatchedOutput *NONNULL_PTR orig);
17572 * Checks if two WatchedOutputs contain equal inner contents.
17574 uint64_t WatchedOutput_hash(const struct LDKWatchedOutput *NONNULL_PTR o);
17577 * Calls the free function if one is set
17579 void BroadcasterInterface_free(struct LDKBroadcasterInterface this_ptr);
17582 * Creates a copy of the ConfirmationTarget
17584 enum LDKConfirmationTarget ConfirmationTarget_clone(const enum LDKConfirmationTarget *NONNULL_PTR orig);
17587 * Utility method to constructs a new Background-variant ConfirmationTarget
17589 enum LDKConfirmationTarget ConfirmationTarget_background(void);
17592 * Utility method to constructs a new Normal-variant ConfirmationTarget
17594 enum LDKConfirmationTarget ConfirmationTarget_normal(void);
17597 * Utility method to constructs a new HighPriority-variant ConfirmationTarget
17599 enum LDKConfirmationTarget ConfirmationTarget_high_priority(void);
17602 * Checks if two ConfirmationTargets contain equal inner contents.
17603 * This ignores pointers and is_owned flags and looks at the values in fields.
17605 bool ConfirmationTarget_eq(const enum LDKConfirmationTarget *NONNULL_PTR a, const enum LDKConfirmationTarget *NONNULL_PTR b);
17608 * Calls the free function if one is set
17610 void FeeEstimator_free(struct LDKFeeEstimator this_ptr);
17613 * Frees any resources used by the MonitorUpdateId, if is_owned is set and inner is non-NULL.
17615 void MonitorUpdateId_free(struct LDKMonitorUpdateId this_obj);
17618 * Creates a copy of the MonitorUpdateId
17620 struct LDKMonitorUpdateId MonitorUpdateId_clone(const struct LDKMonitorUpdateId *NONNULL_PTR orig);
17623 * Checks if two MonitorUpdateIds contain equal inner contents.
17625 uint64_t MonitorUpdateId_hash(const struct LDKMonitorUpdateId *NONNULL_PTR o);
17628 * Checks if two MonitorUpdateIds contain equal inner contents.
17629 * This ignores pointers and is_owned flags and looks at the values in fields.
17630 * Two objects with NULL inner values will be considered "equal" here.
17632 bool MonitorUpdateId_eq(const struct LDKMonitorUpdateId *NONNULL_PTR a, const struct LDKMonitorUpdateId *NONNULL_PTR b);
17635 * Calls the free function if one is set
17637 void Persist_free(struct LDKPersist this_ptr);
17640 * Frees any resources used by the LockedChannelMonitor, if is_owned is set and inner is non-NULL.
17642 void LockedChannelMonitor_free(struct LDKLockedChannelMonitor this_obj);
17645 * Frees any resources used by the ChainMonitor, if is_owned is set and inner is non-NULL.
17647 void ChainMonitor_free(struct LDKChainMonitor this_obj);
17650 * Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
17652 * When an optional chain source implementing [`chain::Filter`] is provided, the chain monitor
17653 * will call back to it indicating transactions and outputs of interest. This allows clients to
17654 * pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may
17655 * always need to fetch full blocks absent another means for determining which blocks contain
17656 * transactions relevant to the watched channels.
17658 MUST_USE_RES struct LDKChainMonitor ChainMonitor_new(struct LDKCOption_FilterZ chain_source, struct LDKBroadcasterInterface broadcaster, struct LDKLogger logger, struct LDKFeeEstimator feeest, struct LDKPersist persister);
17661 * Gets the balances in the contained [`ChannelMonitor`]s which are claimable on-chain or
17662 * claims which are awaiting confirmation.
17664 * Includes the balances from each [`ChannelMonitor`] *except* those included in
17665 * `ignored_channels`, allowing you to filter out balances from channels which are still open
17666 * (and whose balance should likely be pulled from the [`ChannelDetails`]).
17668 * See [`ChannelMonitor::get_claimable_balances`] for more details on the exact criteria for
17669 * inclusion in the return value.
17671 MUST_USE_RES struct LDKCVec_BalanceZ ChainMonitor_get_claimable_balances(const struct LDKChainMonitor *NONNULL_PTR this_arg, struct LDKCVec_ChannelDetailsZ ignored_channels);
17674 * Gets the [`LockedChannelMonitor`] for a given funding outpoint, returning an `Err` if no
17675 * such [`ChannelMonitor`] is currently being monitored for.
17677 * Note that the result holds a mutex over our monitor set, and should not be held
17680 MUST_USE_RES struct LDKCResult_LockedChannelMonitorNoneZ ChainMonitor_get_monitor(const struct LDKChainMonitor *NONNULL_PTR this_arg, struct LDKOutPoint funding_txo);
17683 * Lists the funding outpoint of each [`ChannelMonitor`] being monitored.
17685 * Note that [`ChannelMonitor`]s are not removed when a channel is closed as they are always
17686 * monitoring for on-chain state resolutions.
17688 MUST_USE_RES struct LDKCVec_OutPointZ ChainMonitor_list_monitors(const struct LDKChainMonitor *NONNULL_PTR this_arg);
17691 * Indicates the persistence of a [`ChannelMonitor`] has completed after
17692 * [`ChannelMonitorUpdateErr::TemporaryFailure`] was returned from an update operation.
17694 * Thus, the anticipated use is, at a high level:
17695 * 1) This [`ChainMonitor`] calls [`Persist::update_persisted_channel`] which stores the
17696 * update to disk and begins updating any remote (e.g. watchtower/backup) copies,
17697 * returning [`ChannelMonitorUpdateErr::TemporaryFailure`],
17698 * 2) once all remote copies are updated, you call this function with the
17699 * `completed_update_id` that completed, and once all pending updates have completed the
17700 * channel will be re-enabled.
17702 * Returns an [`APIError::APIMisuseError`] if `funding_txo` does not match any currently
17703 * registered [`ChannelMonitor`]s.
17705 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChainMonitor_channel_monitor_updated(const struct LDKChainMonitor *NONNULL_PTR this_arg, struct LDKOutPoint funding_txo, struct LDKMonitorUpdateId completed_update_id);
17708 * Constructs a new Listen which calls the relevant methods on this_arg.
17709 * This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
17711 struct LDKListen ChainMonitor_as_Listen(const struct LDKChainMonitor *NONNULL_PTR this_arg);
17714 * Constructs a new Confirm which calls the relevant methods on this_arg.
17715 * This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
17717 struct LDKConfirm ChainMonitor_as_Confirm(const struct LDKChainMonitor *NONNULL_PTR this_arg);
17720 * Constructs a new Watch which calls the relevant methods on this_arg.
17721 * This copies the `inner` pointer in this_arg and thus the returned Watch must be freed before this_arg is
17723 struct LDKWatch ChainMonitor_as_Watch(const struct LDKChainMonitor *NONNULL_PTR this_arg);
17726 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
17727 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
17729 struct LDKEventsProvider ChainMonitor_as_EventsProvider(const struct LDKChainMonitor *NONNULL_PTR this_arg);
17732 * Frees any resources used by the ChannelMonitorUpdate, if is_owned is set and inner is non-NULL.
17734 void ChannelMonitorUpdate_free(struct LDKChannelMonitorUpdate this_obj);
17737 * The sequence number of this update. Updates *must* be replayed in-order according to this
17738 * sequence number (and updates may panic if they are not). The update_id values are strictly
17739 * increasing and increase by one for each new update, with one exception specified below.
17741 * This sequence number is also used to track up to which points updates which returned
17742 * ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
17743 * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
17745 * The only instance where update_id values are not strictly increasing is the case where we
17746 * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
17747 * its docs for more details.
17749 uint64_t ChannelMonitorUpdate_get_update_id(const struct LDKChannelMonitorUpdate *NONNULL_PTR this_ptr);
17752 * The sequence number of this update. Updates *must* be replayed in-order according to this
17753 * sequence number (and updates may panic if they are not). The update_id values are strictly
17754 * increasing and increase by one for each new update, with one exception specified below.
17756 * This sequence number is also used to track up to which points updates which returned
17757 * ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
17758 * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
17760 * The only instance where update_id values are not strictly increasing is the case where we
17761 * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
17762 * its docs for more details.
17764 void ChannelMonitorUpdate_set_update_id(struct LDKChannelMonitorUpdate *NONNULL_PTR this_ptr, uint64_t val);
17767 * Creates a copy of the ChannelMonitorUpdate
17769 struct LDKChannelMonitorUpdate ChannelMonitorUpdate_clone(const struct LDKChannelMonitorUpdate *NONNULL_PTR orig);
17772 * Serialize the ChannelMonitorUpdate object into a byte array which can be read by ChannelMonitorUpdate_read
17774 struct LDKCVec_u8Z ChannelMonitorUpdate_write(const struct LDKChannelMonitorUpdate *NONNULL_PTR obj);
17777 * Read a ChannelMonitorUpdate from a byte array, created by ChannelMonitorUpdate_write
17779 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ ChannelMonitorUpdate_read(struct LDKu8slice ser);
17782 * Frees any resources used by the MonitorEvent
17784 void MonitorEvent_free(struct LDKMonitorEvent this_ptr);
17787 * Creates a copy of the MonitorEvent
17789 struct LDKMonitorEvent MonitorEvent_clone(const struct LDKMonitorEvent *NONNULL_PTR orig);
17792 * Utility method to constructs a new HTLCEvent-variant MonitorEvent
17794 struct LDKMonitorEvent MonitorEvent_htlcevent(struct LDKHTLCUpdate a);
17797 * Utility method to constructs a new CommitmentTxConfirmed-variant MonitorEvent
17799 struct LDKMonitorEvent MonitorEvent_commitment_tx_confirmed(struct LDKOutPoint a);
17802 * Utility method to constructs a new UpdateCompleted-variant MonitorEvent
17804 struct LDKMonitorEvent MonitorEvent_update_completed(struct LDKOutPoint funding_txo, uint64_t monitor_update_id);
17807 * Utility method to constructs a new UpdateFailed-variant MonitorEvent
17809 struct LDKMonitorEvent MonitorEvent_update_failed(struct LDKOutPoint a);
17812 * Serialize the MonitorEvent object into a byte array which can be read by MonitorEvent_read
17814 struct LDKCVec_u8Z MonitorEvent_write(const struct LDKMonitorEvent *NONNULL_PTR obj);
17817 * Read a MonitorEvent from a byte array, created by MonitorEvent_write
17819 struct LDKCResult_COption_MonitorEventZDecodeErrorZ MonitorEvent_read(struct LDKu8slice ser);
17822 * Frees any resources used by the HTLCUpdate, if is_owned is set and inner is non-NULL.
17824 void HTLCUpdate_free(struct LDKHTLCUpdate this_obj);
17827 * Creates a copy of the HTLCUpdate
17829 struct LDKHTLCUpdate HTLCUpdate_clone(const struct LDKHTLCUpdate *NONNULL_PTR orig);
17832 * Serialize the HTLCUpdate object into a byte array which can be read by HTLCUpdate_read
17834 struct LDKCVec_u8Z HTLCUpdate_write(const struct LDKHTLCUpdate *NONNULL_PTR obj);
17837 * Read a HTLCUpdate from a byte array, created by HTLCUpdate_write
17839 struct LDKCResult_HTLCUpdateDecodeErrorZ HTLCUpdate_read(struct LDKu8slice ser);
17842 * Frees any resources used by the Balance
17844 void Balance_free(struct LDKBalance this_ptr);
17847 * Creates a copy of the Balance
17849 struct LDKBalance Balance_clone(const struct LDKBalance *NONNULL_PTR orig);
17852 * Utility method to constructs a new ClaimableOnChannelClose-variant Balance
17854 struct LDKBalance Balance_claimable_on_channel_close(uint64_t claimable_amount_satoshis);
17857 * Utility method to constructs a new ClaimableAwaitingConfirmations-variant Balance
17859 struct LDKBalance Balance_claimable_awaiting_confirmations(uint64_t claimable_amount_satoshis, uint32_t confirmation_height);
17862 * Utility method to constructs a new ContentiousClaimable-variant Balance
17864 struct LDKBalance Balance_contentious_claimable(uint64_t claimable_amount_satoshis, uint32_t timeout_height);
17867 * Utility method to constructs a new MaybeClaimableHTLCAwaitingTimeout-variant Balance
17869 struct LDKBalance Balance_maybe_claimable_htlcawaiting_timeout(uint64_t claimable_amount_satoshis, uint32_t claimable_height);
17872 * Checks if two Balances contain equal inner contents.
17873 * This ignores pointers and is_owned flags and looks at the values in fields.
17875 bool Balance_eq(const struct LDKBalance *NONNULL_PTR a, const struct LDKBalance *NONNULL_PTR b);
17878 * Frees any resources used by the ChannelMonitor, if is_owned is set and inner is non-NULL.
17880 void ChannelMonitor_free(struct LDKChannelMonitor this_obj);
17883 * Serialize the ChannelMonitor object into a byte array which can be read by ChannelMonitor_read
17885 struct LDKCVec_u8Z ChannelMonitor_write(const struct LDKChannelMonitor *NONNULL_PTR obj);
17888 * Updates a ChannelMonitor on the basis of some new information provided by the Channel
17891 * panics if the given update is not the next update by update_id.
17893 MUST_USE_RES struct LDKCResult_NoneNoneZ ChannelMonitor_update_monitor(const struct LDKChannelMonitor *NONNULL_PTR this_arg, const struct LDKChannelMonitorUpdate *NONNULL_PTR updates, const struct LDKBroadcasterInterface *NONNULL_PTR broadcaster, const struct LDKFeeEstimator *NONNULL_PTR fee_estimator, const struct LDKLogger *NONNULL_PTR logger);
17896 * Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
17899 MUST_USE_RES uint64_t ChannelMonitor_get_latest_update_id(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
17902 * Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
17904 MUST_USE_RES struct LDKC2Tuple_OutPointScriptZ ChannelMonitor_get_funding_txo(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
17907 * Gets a list of txids, with their output scripts (in the order they appear in the
17908 * transaction), which we must learn about spends of via block_connected().
17910 MUST_USE_RES struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ ChannelMonitor_get_outputs_to_watch(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
17913 * Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
17914 * calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
17915 * have been registered.
17917 void ChannelMonitor_load_outputs_to_watch(const struct LDKChannelMonitor *NONNULL_PTR this_arg, const struct LDKFilter *NONNULL_PTR filter);
17920 * Get the list of HTLCs who's status has been updated on chain. This should be called by
17921 * ChannelManager via [`chain::Watch::release_pending_monitor_events`].
17923 MUST_USE_RES struct LDKCVec_MonitorEventZ ChannelMonitor_get_and_clear_pending_monitor_events(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
17926 * Gets the list of pending events which were generated by previous actions, clearing the list
17929 * This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
17930 * EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
17931 * no internal locking in ChannelMonitors.
17933 MUST_USE_RES struct LDKCVec_EventZ ChannelMonitor_get_and_clear_pending_events(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
17936 * Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
17937 * the Channel was out-of-date. You may use it to get a broadcastable holder toxic tx in case of
17938 * fallen-behind, i.e when receiving a channel_reestablish with a proof that our counterparty side knows
17939 * a higher revocation secret than the holder commitment number we are aware of. Broadcasting these
17940 * transactions are UNSAFE, as they allow counterparty side to punish you. Nevertheless you may want to
17941 * broadcast them if counterparty don't close channel with his higher commitment transaction after a
17942 * substantial amount of time (a month or even a year) to get back funds. Best may be to contact
17943 * out-of-band the other node operator to coordinate with him if option is available to you.
17944 * In any-case, choice is up to the user.
17946 MUST_USE_RES struct LDKCVec_TransactionZ ChannelMonitor_get_latest_holder_commitment_txn(const struct LDKChannelMonitor *NONNULL_PTR this_arg, const struct LDKLogger *NONNULL_PTR logger);
17949 * Processes transactions in a newly connected block, which may result in any of the following:
17950 * - update the monitor's state against resolved HTLCs
17951 * - punish the counterparty in the case of seeing a revoked commitment transaction
17952 * - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
17953 * - detect settled outputs for later spending
17954 * - schedule and bump any in-flight claims
17956 * Returns any new outputs to watch from `txdata`; after called, these are also included in
17957 * [`get_outputs_to_watch`].
17959 * [`get_outputs_to_watch`]: #method.get_outputs_to_watch
17961 MUST_USE_RES struct LDKCVec_TransactionOutputsZ ChannelMonitor_block_connected(const struct LDKChannelMonitor *NONNULL_PTR this_arg, const uint8_t (*header)[80], struct LDKCVec_C2Tuple_usizeTransactionZZ txdata, uint32_t height, struct LDKBroadcasterInterface broadcaster, struct LDKFeeEstimator fee_estimator, struct LDKLogger logger);
17964 * Determines if the disconnected block contained any transactions of interest and updates
17967 void ChannelMonitor_block_disconnected(const struct LDKChannelMonitor *NONNULL_PTR this_arg, const uint8_t (*header)[80], uint32_t height, struct LDKBroadcasterInterface broadcaster, struct LDKFeeEstimator fee_estimator, struct LDKLogger logger);
17970 * Processes transactions confirmed in a block with the given header and height, returning new
17971 * outputs to watch. See [`block_connected`] for details.
17973 * Used instead of [`block_connected`] by clients that are notified of transactions rather than
17974 * blocks. See [`chain::Confirm`] for calling expectations.
17976 * [`block_connected`]: Self::block_connected
17978 MUST_USE_RES struct LDKCVec_TransactionOutputsZ ChannelMonitor_transactions_confirmed(const struct LDKChannelMonitor *NONNULL_PTR this_arg, const uint8_t (*header)[80], struct LDKCVec_C2Tuple_usizeTransactionZZ txdata, uint32_t height, struct LDKBroadcasterInterface broadcaster, struct LDKFeeEstimator fee_estimator, struct LDKLogger logger);
17981 * Processes a transaction that was reorganized out of the chain.
17983 * Used instead of [`block_disconnected`] by clients that are notified of transactions rather
17984 * than blocks. See [`chain::Confirm`] for calling expectations.
17986 * [`block_disconnected`]: Self::block_disconnected
17988 void ChannelMonitor_transaction_unconfirmed(const struct LDKChannelMonitor *NONNULL_PTR this_arg, const uint8_t (*txid)[32], struct LDKBroadcasterInterface broadcaster, struct LDKFeeEstimator fee_estimator, struct LDKLogger logger);
17991 * Updates the monitor with the current best chain tip, returning new outputs to watch. See
17992 * [`block_connected`] for details.
17994 * Used instead of [`block_connected`] by clients that are notified of transactions rather than
17995 * blocks. See [`chain::Confirm`] for calling expectations.
17997 * [`block_connected`]: Self::block_connected
17999 MUST_USE_RES struct LDKCVec_TransactionOutputsZ ChannelMonitor_best_block_updated(const struct LDKChannelMonitor *NONNULL_PTR this_arg, const uint8_t (*header)[80], uint32_t height, struct LDKBroadcasterInterface broadcaster, struct LDKFeeEstimator fee_estimator, struct LDKLogger logger);
18002 * Returns the set of txids that should be monitored for re-organization out of the chain.
18004 MUST_USE_RES struct LDKCVec_TxidZ ChannelMonitor_get_relevant_txids(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
18007 * Gets the latest best block which was connected either via the [`chain::Listen`] or
18008 * [`chain::Confirm`] interfaces.
18010 MUST_USE_RES struct LDKBestBlock ChannelMonitor_current_best_block(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
18013 * Gets the balances in this channel which are either claimable by us if we were to
18014 * force-close the channel now or which are claimable on-chain (possibly awaiting
18017 * Any balances in the channel which are available on-chain (excluding on-chain fees) are
18018 * included here until an [`Event::SpendableOutputs`] event has been generated for the
18019 * balance, or until our counterparty has claimed the balance and accrued several
18020 * confirmations on the claim transaction.
18022 * Note that the balances available when you or your counterparty have broadcasted revoked
18023 * state(s) may not be fully captured here.
18025 * See [`Balance`] for additional details on the types of claimable balances which
18026 * may be returned here and their meanings.
18028 MUST_USE_RES struct LDKCVec_BalanceZ ChannelMonitor_get_claimable_balances(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
18031 * Read a C2Tuple_BlockHashChannelMonitorZ from a byte array, created by C2Tuple_BlockHashChannelMonitorZ_write
18033 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ C2Tuple_BlockHashChannelMonitorZ_read(struct LDKu8slice ser, const struct LDKKeysInterface *NONNULL_PTR arg);
18036 * Frees any resources used by the OutPoint, if is_owned is set and inner is non-NULL.
18038 void OutPoint_free(struct LDKOutPoint this_obj);
18041 * The referenced transaction's txid.
18043 const uint8_t (*OutPoint_get_txid(const struct LDKOutPoint *NONNULL_PTR this_ptr))[32];
18046 * The referenced transaction's txid.
18048 void OutPoint_set_txid(struct LDKOutPoint *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
18051 * The index of the referenced output in its transaction's vout.
18053 uint16_t OutPoint_get_index(const struct LDKOutPoint *NONNULL_PTR this_ptr);
18056 * The index of the referenced output in its transaction's vout.
18058 void OutPoint_set_index(struct LDKOutPoint *NONNULL_PTR this_ptr, uint16_t val);
18061 * Constructs a new OutPoint given each field
18063 MUST_USE_RES struct LDKOutPoint OutPoint_new(struct LDKThirtyTwoBytes txid_arg, uint16_t index_arg);
18066 * Creates a copy of the OutPoint
18068 struct LDKOutPoint OutPoint_clone(const struct LDKOutPoint *NONNULL_PTR orig);
18071 * Checks if two OutPoints contain equal inner contents.
18072 * This ignores pointers and is_owned flags and looks at the values in fields.
18073 * Two objects with NULL inner values will be considered "equal" here.
18075 bool OutPoint_eq(const struct LDKOutPoint *NONNULL_PTR a, const struct LDKOutPoint *NONNULL_PTR b);
18078 * Checks if two OutPoints contain equal inner contents.
18080 uint64_t OutPoint_hash(const struct LDKOutPoint *NONNULL_PTR o);
18083 * Convert an `OutPoint` to a lightning channel id.
18085 MUST_USE_RES struct LDKThirtyTwoBytes OutPoint_to_channel_id(const struct LDKOutPoint *NONNULL_PTR this_arg);
18088 * Serialize the OutPoint object into a byte array which can be read by OutPoint_read
18090 struct LDKCVec_u8Z OutPoint_write(const struct LDKOutPoint *NONNULL_PTR obj);
18093 * Read a OutPoint from a byte array, created by OutPoint_write
18095 struct LDKCResult_OutPointDecodeErrorZ OutPoint_read(struct LDKu8slice ser);
18098 * Frees any resources used by the DelayedPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
18100 void DelayedPaymentOutputDescriptor_free(struct LDKDelayedPaymentOutputDescriptor this_obj);
18103 * The outpoint which is spendable
18105 struct LDKOutPoint DelayedPaymentOutputDescriptor_get_outpoint(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
18108 * The outpoint which is spendable
18110 void DelayedPaymentOutputDescriptor_set_outpoint(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKOutPoint val);
18113 * Per commitment point to derive delayed_payment_key by key holder
18115 struct LDKPublicKey DelayedPaymentOutputDescriptor_get_per_commitment_point(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
18118 * Per commitment point to derive delayed_payment_key by key holder
18120 void DelayedPaymentOutputDescriptor_set_per_commitment_point(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKPublicKey val);
18123 * The nSequence value which must be set in the spending input to satisfy the OP_CSV in
18124 * the witness_script.
18126 uint16_t DelayedPaymentOutputDescriptor_get_to_self_delay(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
18129 * The nSequence value which must be set in the spending input to satisfy the OP_CSV in
18130 * the witness_script.
18132 void DelayedPaymentOutputDescriptor_set_to_self_delay(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint16_t val);
18135 * The output which is referenced by the given outpoint
18137 void DelayedPaymentOutputDescriptor_set_output(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKTxOut val);
18140 * The revocation point specific to the commitment transaction which was broadcast. Used to
18141 * derive the witnessScript for this output.
18143 struct LDKPublicKey DelayedPaymentOutputDescriptor_get_revocation_pubkey(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
18146 * The revocation point specific to the commitment transaction which was broadcast. Used to
18147 * derive the witnessScript for this output.
18149 void DelayedPaymentOutputDescriptor_set_revocation_pubkey(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKPublicKey val);
18152 * Arbitrary identification information returned by a call to
18153 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
18154 * the channel to spend the output.
18156 const uint8_t (*DelayedPaymentOutputDescriptor_get_channel_keys_id(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr))[32];
18159 * Arbitrary identification information returned by a call to
18160 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
18161 * the channel to spend the output.
18163 void DelayedPaymentOutputDescriptor_set_channel_keys_id(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
18166 * The value of the channel which this output originated from, possibly indirectly.
18168 uint64_t DelayedPaymentOutputDescriptor_get_channel_value_satoshis(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
18171 * The value of the channel which this output originated from, possibly indirectly.
18173 void DelayedPaymentOutputDescriptor_set_channel_value_satoshis(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint64_t val);
18176 * Constructs a new DelayedPaymentOutputDescriptor given each field
18178 MUST_USE_RES struct LDKDelayedPaymentOutputDescriptor DelayedPaymentOutputDescriptor_new(struct LDKOutPoint outpoint_arg, struct LDKPublicKey per_commitment_point_arg, uint16_t to_self_delay_arg, struct LDKTxOut output_arg, struct LDKPublicKey revocation_pubkey_arg, struct LDKThirtyTwoBytes channel_keys_id_arg, uint64_t channel_value_satoshis_arg);
18181 * Creates a copy of the DelayedPaymentOutputDescriptor
18183 struct LDKDelayedPaymentOutputDescriptor DelayedPaymentOutputDescriptor_clone(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR orig);
18186 * Serialize the DelayedPaymentOutputDescriptor object into a byte array which can be read by DelayedPaymentOutputDescriptor_read
18188 struct LDKCVec_u8Z DelayedPaymentOutputDescriptor_write(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR obj);
18191 * Read a DelayedPaymentOutputDescriptor from a byte array, created by DelayedPaymentOutputDescriptor_write
18193 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ DelayedPaymentOutputDescriptor_read(struct LDKu8slice ser);
18196 * Frees any resources used by the StaticPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
18198 void StaticPaymentOutputDescriptor_free(struct LDKStaticPaymentOutputDescriptor this_obj);
18201 * The outpoint which is spendable
18203 struct LDKOutPoint StaticPaymentOutputDescriptor_get_outpoint(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr);
18206 * The outpoint which is spendable
18208 void StaticPaymentOutputDescriptor_set_outpoint(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKOutPoint val);
18211 * The output which is referenced by the given outpoint
18213 void StaticPaymentOutputDescriptor_set_output(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKTxOut val);
18216 * Arbitrary identification information returned by a call to
18217 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
18218 * the channel to spend the output.
18220 const uint8_t (*StaticPaymentOutputDescriptor_get_channel_keys_id(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr))[32];
18223 * Arbitrary identification information returned by a call to
18224 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
18225 * the channel to spend the output.
18227 void StaticPaymentOutputDescriptor_set_channel_keys_id(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
18230 * The value of the channel which this transactions spends.
18232 uint64_t StaticPaymentOutputDescriptor_get_channel_value_satoshis(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr);
18235 * The value of the channel which this transactions spends.
18237 void StaticPaymentOutputDescriptor_set_channel_value_satoshis(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint64_t val);
18240 * Constructs a new StaticPaymentOutputDescriptor given each field
18242 MUST_USE_RES struct LDKStaticPaymentOutputDescriptor StaticPaymentOutputDescriptor_new(struct LDKOutPoint outpoint_arg, struct LDKTxOut output_arg, struct LDKThirtyTwoBytes channel_keys_id_arg, uint64_t channel_value_satoshis_arg);
18245 * Creates a copy of the StaticPaymentOutputDescriptor
18247 struct LDKStaticPaymentOutputDescriptor StaticPaymentOutputDescriptor_clone(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR orig);
18250 * Serialize the StaticPaymentOutputDescriptor object into a byte array which can be read by StaticPaymentOutputDescriptor_read
18252 struct LDKCVec_u8Z StaticPaymentOutputDescriptor_write(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR obj);
18255 * Read a StaticPaymentOutputDescriptor from a byte array, created by StaticPaymentOutputDescriptor_write
18257 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ StaticPaymentOutputDescriptor_read(struct LDKu8slice ser);
18260 * Frees any resources used by the SpendableOutputDescriptor
18262 void SpendableOutputDescriptor_free(struct LDKSpendableOutputDescriptor this_ptr);
18265 * Creates a copy of the SpendableOutputDescriptor
18267 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_clone(const struct LDKSpendableOutputDescriptor *NONNULL_PTR orig);
18270 * Utility method to constructs a new StaticOutput-variant SpendableOutputDescriptor
18272 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_static_output(struct LDKOutPoint outpoint, struct LDKTxOut output);
18275 * Utility method to constructs a new DelayedPaymentOutput-variant SpendableOutputDescriptor
18277 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_delayed_payment_output(struct LDKDelayedPaymentOutputDescriptor a);
18280 * Utility method to constructs a new StaticPaymentOutput-variant SpendableOutputDescriptor
18282 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_static_payment_output(struct LDKStaticPaymentOutputDescriptor a);
18285 * Serialize the SpendableOutputDescriptor object into a byte array which can be read by SpendableOutputDescriptor_read
18287 struct LDKCVec_u8Z SpendableOutputDescriptor_write(const struct LDKSpendableOutputDescriptor *NONNULL_PTR obj);
18290 * Read a SpendableOutputDescriptor from a byte array, created by SpendableOutputDescriptor_write
18292 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ SpendableOutputDescriptor_read(struct LDKu8slice ser);
18295 * Calls the free function if one is set
18297 void BaseSign_free(struct LDKBaseSign this_ptr);
18300 * Creates a copy of a Sign
18302 struct LDKSign Sign_clone(const struct LDKSign *NONNULL_PTR orig);
18305 * Calls the free function if one is set
18307 void Sign_free(struct LDKSign this_ptr);
18310 * Creates a copy of the Recipient
18312 enum LDKRecipient Recipient_clone(const enum LDKRecipient *NONNULL_PTR orig);
18315 * Utility method to constructs a new Node-variant Recipient
18317 enum LDKRecipient Recipient_node(void);
18320 * Utility method to constructs a new PhantomNode-variant Recipient
18322 enum LDKRecipient Recipient_phantom_node(void);
18325 * Calls the free function if one is set
18327 void KeysInterface_free(struct LDKKeysInterface this_ptr);
18330 * Frees any resources used by the InMemorySigner, if is_owned is set and inner is non-NULL.
18332 void InMemorySigner_free(struct LDKInMemorySigner this_obj);
18335 * Private key of anchor tx
18337 const uint8_t (*InMemorySigner_get_funding_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
18340 * Private key of anchor tx
18342 void InMemorySigner_set_funding_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
18345 * Holder secret key for blinded revocation pubkey
18347 const uint8_t (*InMemorySigner_get_revocation_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
18350 * Holder secret key for blinded revocation pubkey
18352 void InMemorySigner_set_revocation_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
18355 * Holder secret key used for our balance in counterparty-broadcasted commitment transactions
18357 const uint8_t (*InMemorySigner_get_payment_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
18360 * Holder secret key used for our balance in counterparty-broadcasted commitment transactions
18362 void InMemorySigner_set_payment_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
18365 * Holder secret key used in HTLC tx
18367 const uint8_t (*InMemorySigner_get_delayed_payment_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
18370 * Holder secret key used in HTLC tx
18372 void InMemorySigner_set_delayed_payment_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
18375 * Holder htlc secret key used in commitment tx htlc outputs
18377 const uint8_t (*InMemorySigner_get_htlc_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
18380 * Holder htlc secret key used in commitment tx htlc outputs
18382 void InMemorySigner_set_htlc_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
18387 const uint8_t (*InMemorySigner_get_commitment_seed(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
18392 void InMemorySigner_set_commitment_seed(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
18395 * Creates a copy of the InMemorySigner
18397 struct LDKInMemorySigner InMemorySigner_clone(const struct LDKInMemorySigner *NONNULL_PTR orig);
18400 * Create a new InMemorySigner
18402 MUST_USE_RES struct LDKInMemorySigner InMemorySigner_new(struct LDKSecretKey node_secret, struct LDKSecretKey funding_key, struct LDKSecretKey revocation_base_key, struct LDKSecretKey payment_key, struct LDKSecretKey delayed_payment_base_key, struct LDKSecretKey htlc_base_key, struct LDKThirtyTwoBytes commitment_seed, uint64_t channel_value_satoshis, struct LDKThirtyTwoBytes channel_keys_id);
18405 * Counterparty pubkeys.
18406 * Will panic if ready_channel wasn't called.
18408 MUST_USE_RES struct LDKChannelPublicKeys InMemorySigner_counterparty_pubkeys(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18411 * The contest_delay value specified by our counterparty and applied on holder-broadcastable
18412 * transactions, ie the amount of time that we have to wait to recover our funds if we
18413 * broadcast a transaction.
18414 * Will panic if ready_channel wasn't called.
18416 MUST_USE_RES uint16_t InMemorySigner_counterparty_selected_contest_delay(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18419 * The contest_delay value specified by us and applied on transactions broadcastable
18420 * by our counterparty, ie the amount of time that they have to wait to recover their funds
18421 * if they broadcast a transaction.
18422 * Will panic if ready_channel wasn't called.
18424 MUST_USE_RES uint16_t InMemorySigner_holder_selected_contest_delay(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18427 * Whether the holder is the initiator
18428 * Will panic if ready_channel wasn't called.
18430 MUST_USE_RES bool InMemorySigner_is_outbound(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18434 * Will panic if ready_channel wasn't called.
18436 MUST_USE_RES struct LDKOutPoint InMemorySigner_funding_outpoint(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18439 * Obtain a ChannelTransactionParameters for this channel, to be used when verifying or
18440 * building transactions.
18442 * Will panic if ready_channel wasn't called.
18444 MUST_USE_RES struct LDKChannelTransactionParameters InMemorySigner_get_channel_parameters(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18447 * Whether anchors should be used.
18448 * Will panic if ready_channel wasn't called.
18450 MUST_USE_RES bool InMemorySigner_opt_anchors(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18453 * Sign the single input of spend_tx at index `input_idx` which spends the output
18454 * described by descriptor, returning the witness stack for the input.
18456 * Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
18457 * is not spending the outpoint described by `descriptor.outpoint`,
18458 * or if an output descriptor script_pubkey does not match the one we can spend.
18460 MUST_USE_RES struct LDKCResult_CVec_CVec_u8ZZNoneZ InMemorySigner_sign_counterparty_payment_input(const struct LDKInMemorySigner *NONNULL_PTR this_arg, struct LDKTransaction spend_tx, uintptr_t input_idx, const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR descriptor);
18463 * Sign the single input of spend_tx at index `input_idx` which spends the output
18464 * described by descriptor, returning the witness stack for the input.
18466 * Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
18467 * is not spending the outpoint described by `descriptor.outpoint`, does not have a
18468 * sequence set to `descriptor.to_self_delay`, or if an output descriptor
18469 * script_pubkey does not match the one we can spend.
18471 MUST_USE_RES struct LDKCResult_CVec_CVec_u8ZZNoneZ InMemorySigner_sign_dynamic_p2wsh_input(const struct LDKInMemorySigner *NONNULL_PTR this_arg, struct LDKTransaction spend_tx, uintptr_t input_idx, const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR descriptor);
18474 * Constructs a new BaseSign which calls the relevant methods on this_arg.
18475 * This copies the `inner` pointer in this_arg and thus the returned BaseSign must be freed before this_arg is
18477 struct LDKBaseSign InMemorySigner_as_BaseSign(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18480 * Constructs a new Sign which calls the relevant methods on this_arg.
18481 * This copies the `inner` pointer in this_arg and thus the returned Sign must be freed before this_arg is
18483 struct LDKSign InMemorySigner_as_Sign(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18486 * Serialize the InMemorySigner object into a byte array which can be read by InMemorySigner_read
18488 struct LDKCVec_u8Z InMemorySigner_write(const struct LDKInMemorySigner *NONNULL_PTR obj);
18491 * Read a InMemorySigner from a byte array, created by InMemorySigner_write
18493 struct LDKCResult_InMemorySignerDecodeErrorZ InMemorySigner_read(struct LDKu8slice ser, struct LDKSecretKey arg);
18496 * Frees any resources used by the KeysManager, if is_owned is set and inner is non-NULL.
18498 void KeysManager_free(struct LDKKeysManager this_obj);
18501 * Constructs a KeysManager from a 32-byte seed. If the seed is in some way biased (eg your
18502 * CSRNG is busted) this may panic (but more importantly, you will possibly lose funds).
18503 * starting_time isn't strictly required to actually be a time, but it must absolutely,
18504 * without a doubt, be unique to this instance. ie if you start multiple times with the same
18505 * seed, starting_time must be unique to each run. Thus, the easiest way to achieve this is to
18506 * simply use the current time (with very high precision).
18508 * The seed MUST be backed up safely prior to use so that the keys can be re-created, however,
18509 * obviously, starting_time should be unique every time you reload the library - it is only
18510 * used to generate new ephemeral key data (which will be stored by the individual channel if
18513 * Note that the seed is required to recover certain on-chain funds independent of
18514 * ChannelMonitor data, though a current copy of ChannelMonitor data is also required for any
18515 * channel, and some on-chain during-closing funds.
18517 * Note that until the 0.1 release there is no guarantee of backward compatibility between
18518 * versions. Once the library is more fully supported, the docs will be updated to include a
18519 * detailed description of the guarantee.
18521 MUST_USE_RES struct LDKKeysManager KeysManager_new(const uint8_t (*seed)[32], uint64_t starting_time_secs, uint32_t starting_time_nanos);
18524 * Derive an old Sign containing per-channel secrets based on a key derivation parameters.
18526 * Key derivation parameters are accessible through a per-channel secrets
18527 * Sign::channel_keys_id and is provided inside DynamicOuputP2WSH in case of
18528 * onchain output detection for which a corresponding delayed_payment_key must be derived.
18530 MUST_USE_RES struct LDKInMemorySigner KeysManager_derive_channel_keys(const struct LDKKeysManager *NONNULL_PTR this_arg, uint64_t channel_value_satoshis, const uint8_t (*params)[32]);
18533 * Creates a Transaction which spends the given descriptors to the given outputs, plus an
18534 * output to the given change destination (if sufficient change value remains). The
18535 * transaction will have a feerate, at least, of the given value.
18537 * Returns `Err(())` if the output value is greater than the input value minus required fee,
18538 * if a descriptor was duplicated, or if an output descriptor `script_pubkey`
18539 * does not match the one we can spend.
18541 * We do not enforce that outputs meet the dust limit or that any output scripts are standard.
18543 * May panic if the `SpendableOutputDescriptor`s were not generated by Channels which used
18544 * this KeysManager or one of the `InMemorySigner` created by this KeysManager.
18546 MUST_USE_RES struct LDKCResult_TransactionNoneZ KeysManager_spend_spendable_outputs(const struct LDKKeysManager *NONNULL_PTR this_arg, struct LDKCVec_SpendableOutputDescriptorZ descriptors, struct LDKCVec_TxOutZ outputs, struct LDKCVec_u8Z change_destination_script, uint32_t feerate_sat_per_1000_weight);
18549 * Constructs a new KeysInterface which calls the relevant methods on this_arg.
18550 * This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is
18552 struct LDKKeysInterface KeysManager_as_KeysInterface(const struct LDKKeysManager *NONNULL_PTR this_arg);
18555 * Frees any resources used by the PhantomKeysManager, if is_owned is set and inner is non-NULL.
18557 void PhantomKeysManager_free(struct LDKPhantomKeysManager this_obj);
18560 * Constructs a new KeysInterface which calls the relevant methods on this_arg.
18561 * This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is
18563 struct LDKKeysInterface PhantomKeysManager_as_KeysInterface(const struct LDKPhantomKeysManager *NONNULL_PTR this_arg);
18566 * Constructs a `PhantomKeysManager` given a 32-byte seed and an additional `cross_node_seed`
18567 * that is shared across all nodes that intend to participate in [phantom node payments] together.
18569 * See [`KeysManager::new`] for more information on `seed`, `starting_time_secs`, and
18570 * `starting_time_nanos`.
18572 * `cross_node_seed` must be the same across all phantom payment-receiving nodes and also the
18573 * same across restarts, or else inbound payments may fail.
18575 * [phantom node payments]: PhantomKeysManager
18577 MUST_USE_RES struct LDKPhantomKeysManager PhantomKeysManager_new(const uint8_t (*seed)[32], uint64_t starting_time_secs, uint32_t starting_time_nanos, const uint8_t (*cross_node_seed)[32]);
18580 * See [`KeysManager::spend_spendable_outputs`] for documentation on this method.
18582 MUST_USE_RES struct LDKCResult_TransactionNoneZ PhantomKeysManager_spend_spendable_outputs(const struct LDKPhantomKeysManager *NONNULL_PTR this_arg, struct LDKCVec_SpendableOutputDescriptorZ descriptors, struct LDKCVec_TxOutZ outputs, struct LDKCVec_u8Z change_destination_script, uint32_t feerate_sat_per_1000_weight);
18585 * See [`KeysManager::derive_channel_keys`] for documentation on this method.
18587 MUST_USE_RES struct LDKInMemorySigner PhantomKeysManager_derive_channel_keys(const struct LDKPhantomKeysManager *NONNULL_PTR this_arg, uint64_t channel_value_satoshis, const uint8_t (*params)[32]);
18590 * Frees any resources used by the ChannelManager, if is_owned is set and inner is non-NULL.
18592 void ChannelManager_free(struct LDKChannelManager this_obj);
18595 * Frees any resources used by the ChainParameters, if is_owned is set and inner is non-NULL.
18597 void ChainParameters_free(struct LDKChainParameters this_obj);
18600 * The network for determining the `chain_hash` in Lightning messages.
18602 enum LDKNetwork ChainParameters_get_network(const struct LDKChainParameters *NONNULL_PTR this_ptr);
18605 * The network for determining the `chain_hash` in Lightning messages.
18607 void ChainParameters_set_network(struct LDKChainParameters *NONNULL_PTR this_ptr, enum LDKNetwork val);
18610 * The hash and height of the latest block successfully connected.
18612 * Used to track on-chain channel funding outputs and send payments with reliable timelocks.
18614 struct LDKBestBlock ChainParameters_get_best_block(const struct LDKChainParameters *NONNULL_PTR this_ptr);
18617 * The hash and height of the latest block successfully connected.
18619 * Used to track on-chain channel funding outputs and send payments with reliable timelocks.
18621 void ChainParameters_set_best_block(struct LDKChainParameters *NONNULL_PTR this_ptr, struct LDKBestBlock val);
18624 * Constructs a new ChainParameters given each field
18626 MUST_USE_RES struct LDKChainParameters ChainParameters_new(enum LDKNetwork network_arg, struct LDKBestBlock best_block_arg);
18629 * Creates a copy of the ChainParameters
18631 struct LDKChainParameters ChainParameters_clone(const struct LDKChainParameters *NONNULL_PTR orig);
18634 * Frees any resources used by the CounterpartyForwardingInfo, if is_owned is set and inner is non-NULL.
18636 void CounterpartyForwardingInfo_free(struct LDKCounterpartyForwardingInfo this_obj);
18639 * Base routing fee in millisatoshis.
18641 uint32_t CounterpartyForwardingInfo_get_fee_base_msat(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr);
18644 * Base routing fee in millisatoshis.
18646 void CounterpartyForwardingInfo_set_fee_base_msat(struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr, uint32_t val);
18649 * Amount in millionths of a satoshi the channel will charge per transferred satoshi.
18651 uint32_t CounterpartyForwardingInfo_get_fee_proportional_millionths(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr);
18654 * Amount in millionths of a satoshi the channel will charge per transferred satoshi.
18656 void CounterpartyForwardingInfo_set_fee_proportional_millionths(struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr, uint32_t val);
18659 * The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
18660 * such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
18661 * `cltv_expiry_delta` for more details.
18663 uint16_t CounterpartyForwardingInfo_get_cltv_expiry_delta(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr);
18666 * The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
18667 * such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
18668 * `cltv_expiry_delta` for more details.
18670 void CounterpartyForwardingInfo_set_cltv_expiry_delta(struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr, uint16_t val);
18673 * Constructs a new CounterpartyForwardingInfo given each field
18675 MUST_USE_RES struct LDKCounterpartyForwardingInfo CounterpartyForwardingInfo_new(uint32_t fee_base_msat_arg, uint32_t fee_proportional_millionths_arg, uint16_t cltv_expiry_delta_arg);
18678 * Creates a copy of the CounterpartyForwardingInfo
18680 struct LDKCounterpartyForwardingInfo CounterpartyForwardingInfo_clone(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR orig);
18683 * Frees any resources used by the ChannelCounterparty, if is_owned is set and inner is non-NULL.
18685 void ChannelCounterparty_free(struct LDKChannelCounterparty this_obj);
18688 * The node_id of our counterparty
18690 struct LDKPublicKey ChannelCounterparty_get_node_id(const struct LDKChannelCounterparty *NONNULL_PTR this_ptr);
18693 * The node_id of our counterparty
18695 void ChannelCounterparty_set_node_id(struct LDKChannelCounterparty *NONNULL_PTR this_ptr, struct LDKPublicKey val);
18698 * The Features the channel counterparty provided upon last connection.
18699 * Useful for routing as it is the most up-to-date copy of the counterparty's features and
18700 * many routing-relevant features are present in the init context.
18702 struct LDKInitFeatures ChannelCounterparty_get_features(const struct LDKChannelCounterparty *NONNULL_PTR this_ptr);
18705 * The Features the channel counterparty provided upon last connection.
18706 * Useful for routing as it is the most up-to-date copy of the counterparty's features and
18707 * many routing-relevant features are present in the init context.
18709 void ChannelCounterparty_set_features(struct LDKChannelCounterparty *NONNULL_PTR this_ptr, struct LDKInitFeatures val);
18712 * The value, in satoshis, that must always be held in the channel for our counterparty. This
18713 * value ensures that if our counterparty broadcasts a revoked state, we can punish them by
18714 * claiming at least this value on chain.
18716 * This value is not included in [`inbound_capacity_msat`] as it can never be spent.
18718 * [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
18720 uint64_t ChannelCounterparty_get_unspendable_punishment_reserve(const struct LDKChannelCounterparty *NONNULL_PTR this_ptr);
18723 * The value, in satoshis, that must always be held in the channel for our counterparty. This
18724 * value ensures that if our counterparty broadcasts a revoked state, we can punish them by
18725 * claiming at least this value on chain.
18727 * This value is not included in [`inbound_capacity_msat`] as it can never be spent.
18729 * [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
18731 void ChannelCounterparty_set_unspendable_punishment_reserve(struct LDKChannelCounterparty *NONNULL_PTR this_ptr, uint64_t val);
18734 * Information on the fees and requirements that the counterparty requires when forwarding
18735 * payments to us through this channel.
18737 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
18739 struct LDKCounterpartyForwardingInfo ChannelCounterparty_get_forwarding_info(const struct LDKChannelCounterparty *NONNULL_PTR this_ptr);
18742 * Information on the fees and requirements that the counterparty requires when forwarding
18743 * payments to us through this channel.
18745 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
18747 void ChannelCounterparty_set_forwarding_info(struct LDKChannelCounterparty *NONNULL_PTR this_ptr, struct LDKCounterpartyForwardingInfo val);
18750 * Constructs a new ChannelCounterparty given each field
18752 MUST_USE_RES struct LDKChannelCounterparty ChannelCounterparty_new(struct LDKPublicKey node_id_arg, struct LDKInitFeatures features_arg, uint64_t unspendable_punishment_reserve_arg, struct LDKCounterpartyForwardingInfo forwarding_info_arg);
18755 * Creates a copy of the ChannelCounterparty
18757 struct LDKChannelCounterparty ChannelCounterparty_clone(const struct LDKChannelCounterparty *NONNULL_PTR orig);
18760 * Frees any resources used by the ChannelDetails, if is_owned is set and inner is non-NULL.
18762 void ChannelDetails_free(struct LDKChannelDetails this_obj);
18765 * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
18766 * thereafter this is the txid of the funding transaction xor the funding transaction output).
18767 * Note that this means this value is *not* persistent - it can change once during the
18768 * lifetime of the channel.
18770 const uint8_t (*ChannelDetails_get_channel_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr))[32];
18773 * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
18774 * thereafter this is the txid of the funding transaction xor the funding transaction output).
18775 * Note that this means this value is *not* persistent - it can change once during the
18776 * lifetime of the channel.
18778 void ChannelDetails_set_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
18781 * Parameters which apply to our counterparty. See individual fields for more information.
18783 struct LDKChannelCounterparty ChannelDetails_get_counterparty(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
18786 * Parameters which apply to our counterparty. See individual fields for more information.
18788 void ChannelDetails_set_counterparty(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKChannelCounterparty val);
18791 * The Channel's funding transaction output, if we've negotiated the funding transaction with
18792 * our counterparty already.
18794 * Note that, if this has been set, `channel_id` will be equivalent to
18795 * `funding_txo.unwrap().to_channel_id()`.
18797 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
18799 struct LDKOutPoint ChannelDetails_get_funding_txo(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
18802 * The Channel's funding transaction output, if we've negotiated the funding transaction with
18803 * our counterparty already.
18805 * Note that, if this has been set, `channel_id` will be equivalent to
18806 * `funding_txo.unwrap().to_channel_id()`.
18808 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
18810 void ChannelDetails_set_funding_txo(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKOutPoint val);
18813 * The position of the funding transaction in the chain. None if the funding transaction has
18814 * not yet been confirmed and the channel fully opened.
18816 struct LDKCOption_u64Z ChannelDetails_get_short_channel_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
18819 * The position of the funding transaction in the chain. None if the funding transaction has
18820 * not yet been confirmed and the channel fully opened.
18822 void ChannelDetails_set_short_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
18825 * The value, in satoshis, of this channel as appears in the funding output
18827 uint64_t ChannelDetails_get_channel_value_satoshis(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
18830 * The value, in satoshis, of this channel as appears in the funding output
18832 void ChannelDetails_set_channel_value_satoshis(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
18835 * The value, in satoshis, that must always be held in the channel for us. This value ensures
18836 * that if we broadcast a revoked state, our counterparty can punish us by claiming at least
18837 * this value on chain.
18839 * This value is not included in [`outbound_capacity_msat`] as it can never be spent.
18841 * This value will be `None` for outbound channels until the counterparty accepts the channel.
18843 * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
18845 struct LDKCOption_u64Z ChannelDetails_get_unspendable_punishment_reserve(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
18848 * The value, in satoshis, that must always be held in the channel for us. This value ensures
18849 * that if we broadcast a revoked state, our counterparty can punish us by claiming at least
18850 * this value on chain.
18852 * This value is not included in [`outbound_capacity_msat`] as it can never be spent.
18854 * This value will be `None` for outbound channels until the counterparty accepts the channel.
18856 * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
18858 void ChannelDetails_set_unspendable_punishment_reserve(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
18861 * The `user_channel_id` passed in to create_channel, or 0 if the channel was inbound.
18863 uint64_t ChannelDetails_get_user_channel_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
18866 * The `user_channel_id` passed in to create_channel, or 0 if the channel was inbound.
18868 void ChannelDetails_set_user_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
18871 * Our total balance. This is the amount we would get if we close the channel.
18872 * This value is not exact. Due to various in-flight changes and feerate changes, exactly this
18873 * amount is not likely to be recoverable on close.
18875 * This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
18876 * balance is not available for inclusion in new outbound HTLCs). This further does not include
18877 * any pending outgoing HTLCs which are awaiting some other resolution to be sent.
18878 * This does not consider any on-chain fees.
18880 * See also [`ChannelDetails::outbound_capacity_msat`]
18882 uint64_t ChannelDetails_get_balance_msat(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
18885 * Our total balance. This is the amount we would get if we close the channel.
18886 * This value is not exact. Due to various in-flight changes and feerate changes, exactly this
18887 * amount is not likely to be recoverable on close.
18889 * This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
18890 * balance is not available for inclusion in new outbound HTLCs). This further does not include
18891 * any pending outgoing HTLCs which are awaiting some other resolution to be sent.
18892 * This does not consider any on-chain fees.
18894 * See also [`ChannelDetails::outbound_capacity_msat`]
18896 void ChannelDetails_set_balance_msat(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
18899 * The available outbound capacity for sending HTLCs to the remote peer. This does not include
18900 * any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
18901 * available for inclusion in new outbound HTLCs). This further does not include any pending
18902 * outgoing HTLCs which are awaiting some other resolution to be sent.
18904 * See also [`ChannelDetails::balance_msat`]
18906 * This value is not exact. Due to various in-flight changes, feerate changes, and our
18907 * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
18908 * should be able to spend nearly this amount.
18910 uint64_t ChannelDetails_get_outbound_capacity_msat(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
18913 * The available outbound capacity for sending HTLCs to the remote peer. This does not include
18914 * any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
18915 * available for inclusion in new outbound HTLCs). This further does not include any pending
18916 * outgoing HTLCs which are awaiting some other resolution to be sent.
18918 * See also [`ChannelDetails::balance_msat`]
18920 * This value is not exact. Due to various in-flight changes, feerate changes, and our
18921 * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
18922 * should be able to spend nearly this amount.
18924 void ChannelDetails_set_outbound_capacity_msat(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
18927 * The available inbound capacity for the remote peer to send HTLCs to us. This does not
18928 * include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
18929 * available for inclusion in new inbound HTLCs).
18930 * Note that there are some corner cases not fully handled here, so the actual available
18931 * inbound capacity may be slightly higher than this.
18933 * This value is not exact. Due to various in-flight changes, feerate changes, and our
18934 * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
18935 * However, our counterparty should be able to spend nearly this amount.
18937 uint64_t ChannelDetails_get_inbound_capacity_msat(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
18940 * The available inbound capacity for the remote peer to send HTLCs to us. This does not
18941 * include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
18942 * available for inclusion in new inbound HTLCs).
18943 * Note that there are some corner cases not fully handled here, so the actual available
18944 * inbound capacity may be slightly higher than this.
18946 * This value is not exact. Due to various in-flight changes, feerate changes, and our
18947 * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
18948 * However, our counterparty should be able to spend nearly this amount.
18950 void ChannelDetails_set_inbound_capacity_msat(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
18953 * The number of required confirmations on the funding transaction before the funding will be
18954 * considered \"locked\". This number is selected by the channel fundee (i.e. us if
18955 * [`is_outbound`] is *not* set), and can be selected for inbound channels with
18956 * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
18957 * [`ChannelHandshakeLimits::max_minimum_depth`].
18959 * This value will be `None` for outbound channels until the counterparty accepts the channel.
18961 * [`is_outbound`]: ChannelDetails::is_outbound
18962 * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
18963 * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
18965 struct LDKCOption_u32Z ChannelDetails_get_confirmations_required(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
18968 * The number of required confirmations on the funding transaction before the funding will be
18969 * considered \"locked\". This number is selected by the channel fundee (i.e. us if
18970 * [`is_outbound`] is *not* set), and can be selected for inbound channels with
18971 * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
18972 * [`ChannelHandshakeLimits::max_minimum_depth`].
18974 * This value will be `None` for outbound channels until the counterparty accepts the channel.
18976 * [`is_outbound`]: ChannelDetails::is_outbound
18977 * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
18978 * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
18980 void ChannelDetails_set_confirmations_required(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u32Z val);
18983 * The number of blocks (after our commitment transaction confirms) that we will need to wait
18984 * until we can claim our funds after we force-close the channel. During this time our
18985 * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
18986 * force-closes the channel and broadcasts a commitment transaction we do not have to wait any
18987 * time to claim our non-HTLC-encumbered funds.
18989 * This value will be `None` for outbound channels until the counterparty accepts the channel.
18991 struct LDKCOption_u16Z ChannelDetails_get_force_close_spend_delay(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
18994 * The number of blocks (after our commitment transaction confirms) that we will need to wait
18995 * until we can claim our funds after we force-close the channel. During this time our
18996 * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
18997 * force-closes the channel and broadcasts a commitment transaction we do not have to wait any
18998 * time to claim our non-HTLC-encumbered funds.
19000 * This value will be `None` for outbound channels until the counterparty accepts the channel.
19002 void ChannelDetails_set_force_close_spend_delay(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u16Z val);
19005 * True if the channel was initiated (and thus funded) by us.
19007 bool ChannelDetails_get_is_outbound(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19010 * True if the channel was initiated (and thus funded) by us.
19012 void ChannelDetails_set_is_outbound(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
19015 * True if the channel is confirmed, funding_locked messages have been exchanged, and the
19016 * channel is not currently being shut down. `funding_locked` message exchange implies the
19017 * required confirmation count has been reached (and we were connected to the peer at some
19018 * point after the funding transaction received enough confirmations). The required
19019 * confirmation count is provided in [`confirmations_required`].
19021 * [`confirmations_required`]: ChannelDetails::confirmations_required
19023 bool ChannelDetails_get_is_funding_locked(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19026 * True if the channel is confirmed, funding_locked messages have been exchanged, and the
19027 * channel is not currently being shut down. `funding_locked` message exchange implies the
19028 * required confirmation count has been reached (and we were connected to the peer at some
19029 * point after the funding transaction received enough confirmations). The required
19030 * confirmation count is provided in [`confirmations_required`].
19032 * [`confirmations_required`]: ChannelDetails::confirmations_required
19034 void ChannelDetails_set_is_funding_locked(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
19037 * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
19038 * the peer is connected, and (c) the channel is not currently negotiating a shutdown.
19040 * This is a strict superset of `is_funding_locked`.
19042 bool ChannelDetails_get_is_usable(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19045 * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
19046 * the peer is connected, and (c) the channel is not currently negotiating a shutdown.
19048 * This is a strict superset of `is_funding_locked`.
19050 void ChannelDetails_set_is_usable(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
19053 * True if this channel is (or will be) publicly-announced.
19055 bool ChannelDetails_get_is_public(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19058 * True if this channel is (or will be) publicly-announced.
19060 void ChannelDetails_set_is_public(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
19063 * Constructs a new ChannelDetails given each field
19065 MUST_USE_RES struct LDKChannelDetails ChannelDetails_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKChannelCounterparty counterparty_arg, struct LDKOutPoint funding_txo_arg, struct LDKCOption_u64Z short_channel_id_arg, uint64_t channel_value_satoshis_arg, struct LDKCOption_u64Z unspendable_punishment_reserve_arg, uint64_t user_channel_id_arg, uint64_t balance_msat_arg, uint64_t outbound_capacity_msat_arg, uint64_t inbound_capacity_msat_arg, struct LDKCOption_u32Z confirmations_required_arg, struct LDKCOption_u16Z force_close_spend_delay_arg, bool is_outbound_arg, bool is_funding_locked_arg, bool is_usable_arg, bool is_public_arg);
19068 * Creates a copy of the ChannelDetails
19070 struct LDKChannelDetails ChannelDetails_clone(const struct LDKChannelDetails *NONNULL_PTR orig);
19073 * Frees any resources used by the PaymentSendFailure
19075 void PaymentSendFailure_free(struct LDKPaymentSendFailure this_ptr);
19078 * Creates a copy of the PaymentSendFailure
19080 struct LDKPaymentSendFailure PaymentSendFailure_clone(const struct LDKPaymentSendFailure *NONNULL_PTR orig);
19083 * Utility method to constructs a new ParameterError-variant PaymentSendFailure
19085 struct LDKPaymentSendFailure PaymentSendFailure_parameter_error(struct LDKAPIError a);
19088 * Utility method to constructs a new PathParameterError-variant PaymentSendFailure
19090 struct LDKPaymentSendFailure PaymentSendFailure_path_parameter_error(struct LDKCVec_CResult_NoneAPIErrorZZ a);
19093 * Utility method to constructs a new AllFailedRetrySafe-variant PaymentSendFailure
19095 struct LDKPaymentSendFailure PaymentSendFailure_all_failed_retry_safe(struct LDKCVec_APIErrorZ a);
19098 * Utility method to constructs a new PartialFailure-variant PaymentSendFailure
19100 struct LDKPaymentSendFailure PaymentSendFailure_partial_failure(struct LDKCVec_CResult_NoneAPIErrorZZ results, struct LDKRouteParameters failed_paths_retry, struct LDKThirtyTwoBytes payment_id);
19103 * Frees any resources used by the PhantomRouteHints, if is_owned is set and inner is non-NULL.
19105 void PhantomRouteHints_free(struct LDKPhantomRouteHints this_obj);
19108 * The list of channels to be included in the invoice route hints.
19110 struct LDKCVec_ChannelDetailsZ PhantomRouteHints_get_channels(const struct LDKPhantomRouteHints *NONNULL_PTR this_ptr);
19113 * The list of channels to be included in the invoice route hints.
19115 void PhantomRouteHints_set_channels(struct LDKPhantomRouteHints *NONNULL_PTR this_ptr, struct LDKCVec_ChannelDetailsZ val);
19118 * A fake scid used for representing the phantom node's fake channel in generating the invoice
19121 uint64_t PhantomRouteHints_get_phantom_scid(const struct LDKPhantomRouteHints *NONNULL_PTR this_ptr);
19124 * A fake scid used for representing the phantom node's fake channel in generating the invoice
19127 void PhantomRouteHints_set_phantom_scid(struct LDKPhantomRouteHints *NONNULL_PTR this_ptr, uint64_t val);
19130 * The pubkey of the real backing node that would ultimately receive the payment.
19132 struct LDKPublicKey PhantomRouteHints_get_real_node_pubkey(const struct LDKPhantomRouteHints *NONNULL_PTR this_ptr);
19135 * The pubkey of the real backing node that would ultimately receive the payment.
19137 void PhantomRouteHints_set_real_node_pubkey(struct LDKPhantomRouteHints *NONNULL_PTR this_ptr, struct LDKPublicKey val);
19140 * Constructs a new PhantomRouteHints given each field
19142 MUST_USE_RES struct LDKPhantomRouteHints PhantomRouteHints_new(struct LDKCVec_ChannelDetailsZ channels_arg, uint64_t phantom_scid_arg, struct LDKPublicKey real_node_pubkey_arg);
19145 * Constructs a new ChannelManager to hold several channels and route between them.
19147 * This is the main \"logic hub\" for all channel-related actions, and implements
19148 * ChannelMessageHandler.
19150 * Non-proportional fees are fixed according to our risk using the provided fee estimator.
19152 * panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
19154 * Users need to notify the new ChannelManager when a new block is connected or
19155 * disconnected using its `block_connected` and `block_disconnected` methods, starting
19156 * from after `params.latest_hash`.
19158 MUST_USE_RES struct LDKChannelManager ChannelManager_new(struct LDKFeeEstimator fee_est, struct LDKWatch chain_monitor, struct LDKBroadcasterInterface tx_broadcaster, struct LDKLogger logger, struct LDKKeysInterface keys_manager, struct LDKUserConfig config, struct LDKChainParameters params);
19161 * Gets the current configuration applied to all new channels, as
19163 MUST_USE_RES struct LDKUserConfig ChannelManager_get_current_default_configuration(const struct LDKChannelManager *NONNULL_PTR this_arg);
19166 * Creates a new outbound channel to the given remote node and with the given value.
19168 * `user_channel_id` will be provided back as in
19169 * [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
19170 * correspond with which `create_channel` call. Note that the `user_channel_id` defaults to 0
19171 * for inbound channels, so you may wish to avoid using 0 for `user_channel_id` here.
19172 * `user_channel_id` has no meaning inside of LDK, it is simply copied to events and otherwise
19175 * Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
19176 * greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
19178 * Note that we do not check if you are currently connected to the given peer. If no
19179 * connection is available, the outbound `open_channel` message may fail to send, resulting in
19180 * the channel eventually being silently forgotten (dropped on reload).
19182 * Returns the new Channel's temporary `channel_id`. This ID will appear as
19183 * [`Event::FundingGenerationReady::temporary_channel_id`] and in
19184 * [`ChannelDetails::channel_id`] until after
19185 * [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
19186 * one derived from the funding transaction's TXID. If the counterparty rejects the channel
19187 * immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
19189 * [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
19190 * [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
19191 * [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
19193 * Note that override_config (or a relevant inner pointer) may be NULL or all-0s to represent None
19195 MUST_USE_RES struct LDKCResult__u832APIErrorZ ChannelManager_create_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKPublicKey their_network_key, uint64_t channel_value_satoshis, uint64_t push_msat, uint64_t user_channel_id, struct LDKUserConfig override_config);
19198 * Gets the list of open channels, in random order. See ChannelDetail field documentation for
19199 * more information.
19201 MUST_USE_RES struct LDKCVec_ChannelDetailsZ ChannelManager_list_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
19204 * Gets the list of usable channels, in random order. Useful as an argument to
19205 * get_route to ensure non-announced channels are used.
19207 * These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
19208 * documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
19211 MUST_USE_RES struct LDKCVec_ChannelDetailsZ ChannelManager_list_usable_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
19214 * Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
19215 * will be accepted on the given channel, and after additional timeout/the closing of all
19216 * pending HTLCs, the channel will be closed on chain.
19218 * * If we are the channel initiator, we will pay between our [`Background`] and
19219 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
19221 * * If our counterparty is the channel initiator, we will require a channel closing
19222 * transaction feerate of at least our [`Background`] feerate or the feerate which
19223 * would appear on a force-closure transaction, whichever is lower. We will allow our
19224 * counterparty to pay as much fee as they'd like, however.
19226 * May generate a SendShutdown message event on success, which should be relayed.
19228 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
19229 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
19230 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
19232 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_close_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*channel_id)[32]);
19235 * Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
19236 * will be accepted on the given channel, and after additional timeout/the closing of all
19237 * pending HTLCs, the channel will be closed on chain.
19239 * `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
19240 * the channel being closed or not:
19241 * * If we are the channel initiator, we will pay at least this feerate on the closing
19242 * transaction. The upper-bound is set by
19243 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
19244 * estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
19245 * * If our counterparty is the channel initiator, we will refuse to accept a channel closure
19246 * transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
19247 * will appear on a force-closure transaction, whichever is lower).
19249 * May generate a SendShutdown message event on success, which should be relayed.
19251 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
19252 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
19253 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
19255 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_close_channel_with_target_feerate(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*channel_id)[32], uint32_t target_feerate_sats_per_1000_weight);
19258 * Force closes a channel, immediately broadcasting the latest local commitment transaction to
19259 * the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
19261 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_force_close_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*channel_id)[32]);
19264 * Force close all channels, immediately broadcasting the latest local commitment transaction
19265 * for each to the chain and rejecting new HTLCs on each.
19267 void ChannelManager_force_close_all_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
19270 * Sends a payment along a given route.
19272 * Value parameters are provided via the last hop in route, see documentation for RouteHop
19273 * fields for more info.
19275 * Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
19276 * payment), we don't do anything to stop you! We always try to ensure that if the provided
19277 * next hop knows the preimage to payment_hash they can claim an additional amount as
19278 * specified in the last hop in the route! Thus, you should probably do your own
19279 * payment_preimage tracking (which you should already be doing as they represent \"proof of
19280 * payment\") and prevent double-sends yourself.
19282 * May generate SendHTLCs message(s) event on success, which should be relayed.
19284 * Each path may have a different return value, and PaymentSendValue may return a Vec with
19285 * each entry matching the corresponding-index entry in the route paths, see
19286 * PaymentSendFailure for more info.
19288 * In general, a path may raise:
19289 * * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
19290 * node public key) is specified.
19291 * * APIError::ChannelUnavailable if the next-hop channel is not available for updates
19292 * (including due to previous monitor update failure or new permanent monitor update
19294 * * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
19295 * relevant updates.
19297 * Note that depending on the type of the PaymentSendFailure the HTLC may have been
19298 * irrevocably committed to on our end. In such a case, do NOT retry the payment with a
19299 * different route unless you intend to pay twice!
19301 * payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
19302 * the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
19303 * newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
19304 * must not contain multiple paths as multi-path payments require a recipient-provided
19306 * If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
19307 * bit set (either as required or as available). If multiple paths are present in the Route,
19308 * we assume the invoice had the basic_mpp feature set.
19310 * Note that payment_secret (or a relevant inner pointer) may be NULL or all-0s to represent None
19312 MUST_USE_RES struct LDKCResult_PaymentIdPaymentSendFailureZ ChannelManager_send_payment(const struct LDKChannelManager *NONNULL_PTR this_arg, const struct LDKRoute *NONNULL_PTR route, struct LDKThirtyTwoBytes payment_hash, struct LDKThirtyTwoBytes payment_secret);
19315 * Retries a payment along the given [`Route`].
19317 * Errors returned are a superset of those returned from [`send_payment`], so see
19318 * [`send_payment`] documentation for more details on errors. This method will also error if the
19319 * retry amount puts the payment more than 10% over the payment's total amount, if the payment
19320 * for the given `payment_id` cannot be found (likely due to timeout or success), or if
19321 * further retries have been disabled with [`abandon_payment`].
19323 * [`send_payment`]: [`ChannelManager::send_payment`]
19324 * [`abandon_payment`]: [`ChannelManager::abandon_payment`]
19326 MUST_USE_RES struct LDKCResult_NonePaymentSendFailureZ ChannelManager_retry_payment(const struct LDKChannelManager *NONNULL_PTR this_arg, const struct LDKRoute *NONNULL_PTR route, struct LDKThirtyTwoBytes payment_id);
19329 * Signals that no further retries for the given payment will occur.
19331 * After this method returns, any future calls to [`retry_payment`] for the given `payment_id`
19332 * will fail with [`PaymentSendFailure::ParameterError`]. If no such event has been generated,
19333 * an [`Event::PaymentFailed`] event will be generated as soon as there are no remaining
19334 * pending HTLCs for this payment.
19336 * Note that calling this method does *not* prevent a payment from succeeding. You must still
19337 * wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
19338 * determine the ultimate status of a payment.
19340 * [`retry_payment`]: Self::retry_payment
19341 * [`Event::PaymentFailed`]: events::Event::PaymentFailed
19342 * [`Event::PaymentSent`]: events::Event::PaymentSent
19344 void ChannelManager_abandon_payment(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThirtyTwoBytes payment_id);
19347 * Send a spontaneous payment, which is a payment that does not require the recipient to have
19348 * generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
19349 * the preimage, it must be a cryptographically secure random value that no intermediate node
19350 * would be able to guess -- otherwise, an intermediate node may claim the payment and it will
19351 * never reach the recipient.
19353 * See [`send_payment`] documentation for more details on the return value of this function.
19355 * Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
19356 * [`send_payment`] for more information about the risks of duplicate preimage usage.
19358 * Note that `route` must have exactly one path.
19360 * [`send_payment`]: Self::send_payment
19362 * Note that payment_preimage (or a relevant inner pointer) may be NULL or all-0s to represent None
19364 MUST_USE_RES struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ ChannelManager_send_spontaneous_payment(const struct LDKChannelManager *NONNULL_PTR this_arg, const struct LDKRoute *NONNULL_PTR route, struct LDKThirtyTwoBytes payment_preimage);
19367 * Call this upon creation of a funding transaction for the given channel.
19369 * Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
19370 * or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
19372 * Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
19373 * for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
19375 * May panic if the output found in the funding transaction is duplicative with some other
19376 * channel (note that this should be trivially prevented by using unique funding transaction
19377 * keys per-channel).
19379 * Do NOT broadcast the funding transaction yourself. When we have safely received our
19380 * counterparty's signature the funding transaction will automatically be broadcast via the
19381 * [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
19383 * Note that this includes RBF or similar transaction replacement strategies - lightning does
19384 * not currently support replacing a funding transaction on an existing channel. Instead,
19385 * create a new channel with a conflicting funding transaction.
19387 * [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
19388 * [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
19390 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_funding_transaction_generated(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*temporary_channel_id)[32], struct LDKTransaction funding_transaction);
19393 * Regenerates channel_announcements and generates a signed node_announcement from the given
19394 * arguments, providing them in corresponding events via
19395 * [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
19396 * on-chain. This effectively re-broadcasts all channel announcements and sends our node
19397 * announcement to ensure that the lightning P2P network is aware of the channels we have and
19398 * our network addresses.
19400 * `rgb` is a node \"color\" and `alias` is a printable human-readable string to describe this
19401 * node to humans. They carry no in-protocol meaning.
19403 * `addresses` represent the set (possibly empty) of socket addresses on which this node
19404 * accepts incoming connections. These will be included in the node_announcement, publicly
19405 * tying these addresses together and to this node. If you wish to preserve user privacy,
19406 * addresses should likely contain only Tor Onion addresses.
19408 * Panics if `addresses` is absurdly large (more than 500).
19410 * [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
19412 void ChannelManager_broadcast_node_announcement(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThreeBytes rgb, struct LDKThirtyTwoBytes alias, struct LDKCVec_NetAddressZ addresses);
19415 * Processes HTLCs which are pending waiting on random forward delay.
19417 * Should only really ever be called in response to a PendingHTLCsForwardable event.
19418 * Will likely generate further events.
19420 void ChannelManager_process_pending_htlc_forwards(const struct LDKChannelManager *NONNULL_PTR this_arg);
19423 * Performs actions which should happen on startup and roughly once per minute thereafter.
19425 * This currently includes:
19426 * * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
19427 * * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
19428 * than a minute, informing the network that they should no longer attempt to route over
19431 * Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
19432 * estimate fetches.
19434 void ChannelManager_timer_tick_occurred(const struct LDKChannelManager *NONNULL_PTR this_arg);
19437 * Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
19438 * after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
19439 * along the path (including in our own channel on which we received it).
19440 * Returns false if no payment was found to fail backwards, true if the process of failing the
19441 * HTLC backwards has been started.
19443 MUST_USE_RES bool ChannelManager_fail_htlc_backwards(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*payment_hash)[32]);
19446 * Provides a payment preimage in response to [`Event::PaymentReceived`], generating any
19447 * [`MessageSendEvent`]s needed to claim the payment.
19449 * Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
19450 * [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
19451 * event matches your expectation. If you fail to do so and call this method, you may provide
19452 * the sender \"proof-of-payment\" when they did not fulfill the full expected payment.
19454 * Returns whether any HTLCs were claimed, and thus if any new [`MessageSendEvent`]s are now
19455 * pending for processing via [`get_and_clear_pending_msg_events`].
19457 * [`Event::PaymentReceived`]: crate::util::events::Event::PaymentReceived
19458 * [`create_inbound_payment`]: Self::create_inbound_payment
19459 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
19460 * [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
19462 MUST_USE_RES bool ChannelManager_claim_funds(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThirtyTwoBytes payment_preimage);
19465 * Gets the node_id held by this ChannelManager
19467 MUST_USE_RES struct LDKPublicKey ChannelManager_get_our_node_id(const struct LDKChannelManager *NONNULL_PTR this_arg);
19470 * Called to accept a request to open a channel after [`Event::OpenChannelRequest`] has been
19473 * The `temporary_channel_id` parameter indicates which inbound channel should be accepted.
19475 * [`Event::OpenChannelRequest`]: crate::util::events::Event::OpenChannelRequest
19477 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_accept_inbound_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*temporary_channel_id)[32]);
19480 * Gets a payment secret and payment hash for use in an invoice given to a third party wishing
19483 * This differs from [`create_inbound_payment_for_hash`] only in that it generates the
19484 * [`PaymentHash`] and [`PaymentPreimage`] for you.
19486 * The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
19487 * will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
19488 * passed directly to [`claim_funds`].
19490 * See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
19492 * Note that a malicious eavesdropper can intuit whether an inbound payment was created by
19493 * `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
19497 * If you register an inbound payment with this method, then serialize the `ChannelManager`, then
19498 * deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
19500 * Errors if `min_value_msat` is greater than total bitcoin supply.
19502 * [`claim_funds`]: Self::claim_funds
19503 * [`PaymentReceived`]: events::Event::PaymentReceived
19504 * [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
19505 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
19507 MUST_USE_RES struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ ChannelManager_create_inbound_payment(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKCOption_u64Z min_value_msat, uint32_t invoice_expiry_delta_secs);
19510 * Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
19511 * serialized state with LDK node(s) running 0.0.103 and earlier.
19514 * This method is deprecated and will be removed soon.
19516 * [`create_inbound_payment`]: Self::create_inbound_payment
19518 MUST_USE_RES struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ ChannelManager_create_inbound_payment_legacy(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKCOption_u64Z min_value_msat, uint32_t invoice_expiry_delta_secs);
19521 * Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
19522 * stored external to LDK.
19524 * A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
19525 * payment secret fetched via this method or [`create_inbound_payment`], and which is at least
19526 * the `min_value_msat` provided here, if one is provided.
19528 * The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
19529 * note that LDK will not stop you from registering duplicate payment hashes for inbound
19532 * `min_value_msat` should be set if the invoice being generated contains a value. Any payment
19533 * received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
19534 * before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
19535 * sender \"proof-of-payment\" unless they have paid the required amount.
19537 * `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
19538 * in excess of the current time. This should roughly match the expiry time set in the invoice.
19539 * After this many seconds, we will remove the inbound payment, resulting in any attempts to
19540 * pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
19541 * invoices when no timeout is set.
19543 * Note that we use block header time to time-out pending inbound payments (with some margin
19544 * to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
19545 * accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
19546 * If you need exact expiry semantics, you should enforce them upon receipt of
19547 * [`PaymentReceived`].
19549 * May panic if `invoice_expiry_delta_secs` is greater than one year.
19551 * Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
19552 * set to at least [`MIN_FINAL_CLTV_EXPIRY`].
19554 * Note that a malicious eavesdropper can intuit whether an inbound payment was created by
19555 * `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
19559 * If you register an inbound payment with this method, then serialize the `ChannelManager`, then
19560 * deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
19562 * Errors if `min_value_msat` is greater than total bitcoin supply.
19564 * [`create_inbound_payment`]: Self::create_inbound_payment
19565 * [`PaymentReceived`]: events::Event::PaymentReceived
19567 MUST_USE_RES struct LDKCResult_PaymentSecretNoneZ ChannelManager_create_inbound_payment_for_hash(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThirtyTwoBytes payment_hash, struct LDKCOption_u64Z min_value_msat, uint32_t invoice_expiry_delta_secs);
19570 * Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
19571 * serialized state with LDK node(s) running 0.0.103 and earlier.
19574 * This method is deprecated and will be removed soon.
19576 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
19578 MUST_USE_RES struct LDKCResult_PaymentSecretAPIErrorZ ChannelManager_create_inbound_payment_for_hash_legacy(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThirtyTwoBytes payment_hash, struct LDKCOption_u64Z min_value_msat, uint32_t invoice_expiry_delta_secs);
19581 * Gets an LDK-generated payment preimage from a payment hash and payment secret that were
19582 * previously returned from [`create_inbound_payment`].
19584 * [`create_inbound_payment`]: Self::create_inbound_payment
19586 MUST_USE_RES struct LDKCResult_PaymentPreimageAPIErrorZ ChannelManager_get_payment_preimage(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThirtyTwoBytes payment_hash, struct LDKThirtyTwoBytes payment_secret);
19589 * Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
19590 * are used when constructing the phantom invoice's route hints.
19592 * [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
19594 MUST_USE_RES uint64_t ChannelManager_get_phantom_scid(const struct LDKChannelManager *NONNULL_PTR this_arg);
19597 * Gets route hints for use in receiving [phantom node payments].
19599 * [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
19601 MUST_USE_RES struct LDKPhantomRouteHints ChannelManager_get_phantom_route_hints(const struct LDKChannelManager *NONNULL_PTR this_arg);
19604 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
19605 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
19607 struct LDKMessageSendEventsProvider ChannelManager_as_MessageSendEventsProvider(const struct LDKChannelManager *NONNULL_PTR this_arg);
19610 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
19611 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
19613 struct LDKEventsProvider ChannelManager_as_EventsProvider(const struct LDKChannelManager *NONNULL_PTR this_arg);
19616 * Constructs a new Listen which calls the relevant methods on this_arg.
19617 * This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
19619 struct LDKListen ChannelManager_as_Listen(const struct LDKChannelManager *NONNULL_PTR this_arg);
19622 * Constructs a new Confirm which calls the relevant methods on this_arg.
19623 * This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
19625 struct LDKConfirm ChannelManager_as_Confirm(const struct LDKChannelManager *NONNULL_PTR this_arg);
19628 * Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
19629 * indicating whether persistence is necessary. Only one listener on
19630 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
19633 * Note that this method is not available with the `no-std` feature.
19635 MUST_USE_RES bool ChannelManager_await_persistable_update_timeout(const struct LDKChannelManager *NONNULL_PTR this_arg, uint64_t max_wait);
19638 * Blocks until ChannelManager needs to be persisted. Only one listener on
19639 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
19642 void ChannelManager_await_persistable_update(const struct LDKChannelManager *NONNULL_PTR this_arg);
19645 * Gets the latest best block which was connected either via the [`chain::Listen`] or
19646 * [`chain::Confirm`] interfaces.
19648 MUST_USE_RES struct LDKBestBlock ChannelManager_current_best_block(const struct LDKChannelManager *NONNULL_PTR this_arg);
19651 * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
19652 * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
19654 struct LDKChannelMessageHandler ChannelManager_as_ChannelMessageHandler(const struct LDKChannelManager *NONNULL_PTR this_arg);
19657 * Serialize the CounterpartyForwardingInfo object into a byte array which can be read by CounterpartyForwardingInfo_read
19659 struct LDKCVec_u8Z CounterpartyForwardingInfo_write(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR obj);
19662 * Read a CounterpartyForwardingInfo from a byte array, created by CounterpartyForwardingInfo_write
19664 struct LDKCResult_CounterpartyForwardingInfoDecodeErrorZ CounterpartyForwardingInfo_read(struct LDKu8slice ser);
19667 * Serialize the ChannelCounterparty object into a byte array which can be read by ChannelCounterparty_read
19669 struct LDKCVec_u8Z ChannelCounterparty_write(const struct LDKChannelCounterparty *NONNULL_PTR obj);
19672 * Read a ChannelCounterparty from a byte array, created by ChannelCounterparty_write
19674 struct LDKCResult_ChannelCounterpartyDecodeErrorZ ChannelCounterparty_read(struct LDKu8slice ser);
19677 * Serialize the ChannelDetails object into a byte array which can be read by ChannelDetails_read
19679 struct LDKCVec_u8Z ChannelDetails_write(const struct LDKChannelDetails *NONNULL_PTR obj);
19682 * Read a ChannelDetails from a byte array, created by ChannelDetails_write
19684 struct LDKCResult_ChannelDetailsDecodeErrorZ ChannelDetails_read(struct LDKu8slice ser);
19687 * Serialize the PhantomRouteHints object into a byte array which can be read by PhantomRouteHints_read
19689 struct LDKCVec_u8Z PhantomRouteHints_write(const struct LDKPhantomRouteHints *NONNULL_PTR obj);
19692 * Read a PhantomRouteHints from a byte array, created by PhantomRouteHints_write
19694 struct LDKCResult_PhantomRouteHintsDecodeErrorZ PhantomRouteHints_read(struct LDKu8slice ser);
19697 * Serialize the ChannelManager object into a byte array which can be read by ChannelManager_read
19699 struct LDKCVec_u8Z ChannelManager_write(const struct LDKChannelManager *NONNULL_PTR obj);
19702 * Frees any resources used by the ChannelManagerReadArgs, if is_owned is set and inner is non-NULL.
19704 void ChannelManagerReadArgs_free(struct LDKChannelManagerReadArgs this_obj);
19707 * The keys provider which will give us relevant keys. Some keys will be loaded during
19708 * deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
19711 const struct LDKKeysInterface *ChannelManagerReadArgs_get_keys_manager(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
19714 * The keys provider which will give us relevant keys. Some keys will be loaded during
19715 * deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
19718 void ChannelManagerReadArgs_set_keys_manager(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKKeysInterface val);
19721 * The fee_estimator for use in the ChannelManager in the future.
19723 * No calls to the FeeEstimator will be made during deserialization.
19725 const struct LDKFeeEstimator *ChannelManagerReadArgs_get_fee_estimator(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
19728 * The fee_estimator for use in the ChannelManager in the future.
19730 * No calls to the FeeEstimator will be made during deserialization.
19732 void ChannelManagerReadArgs_set_fee_estimator(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKFeeEstimator val);
19735 * The chain::Watch for use in the ChannelManager in the future.
19737 * No calls to the chain::Watch will be made during deserialization. It is assumed that
19738 * you have deserialized ChannelMonitors separately and will add them to your
19739 * chain::Watch after deserializing this ChannelManager.
19741 const struct LDKWatch *ChannelManagerReadArgs_get_chain_monitor(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
19744 * The chain::Watch for use in the ChannelManager in the future.
19746 * No calls to the chain::Watch will be made during deserialization. It is assumed that
19747 * you have deserialized ChannelMonitors separately and will add them to your
19748 * chain::Watch after deserializing this ChannelManager.
19750 void ChannelManagerReadArgs_set_chain_monitor(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKWatch val);
19753 * The BroadcasterInterface which will be used in the ChannelManager in the future and may be
19754 * used to broadcast the latest local commitment transactions of channels which must be
19755 * force-closed during deserialization.
19757 const struct LDKBroadcasterInterface *ChannelManagerReadArgs_get_tx_broadcaster(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
19760 * The BroadcasterInterface which will be used in the ChannelManager in the future and may be
19761 * used to broadcast the latest local commitment transactions of channels which must be
19762 * force-closed during deserialization.
19764 void ChannelManagerReadArgs_set_tx_broadcaster(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKBroadcasterInterface val);
19767 * The Logger for use in the ChannelManager and which may be used to log information during
19770 const struct LDKLogger *ChannelManagerReadArgs_get_logger(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
19773 * The Logger for use in the ChannelManager and which may be used to log information during
19776 void ChannelManagerReadArgs_set_logger(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKLogger val);
19779 * Default settings used for new channels. Any existing channels will continue to use the
19780 * runtime settings which were stored when the ChannelManager was serialized.
19782 struct LDKUserConfig ChannelManagerReadArgs_get_default_config(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
19785 * Default settings used for new channels. Any existing channels will continue to use the
19786 * runtime settings which were stored when the ChannelManager was serialized.
19788 void ChannelManagerReadArgs_set_default_config(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKUserConfig val);
19791 * Simple utility function to create a ChannelManagerReadArgs which creates the monitor
19792 * HashMap for you. This is primarily useful for C bindings where it is not practical to
19793 * populate a HashMap directly from C.
19795 MUST_USE_RES struct LDKChannelManagerReadArgs ChannelManagerReadArgs_new(struct LDKKeysInterface keys_manager, struct LDKFeeEstimator fee_estimator, struct LDKWatch chain_monitor, struct LDKBroadcasterInterface tx_broadcaster, struct LDKLogger logger, struct LDKUserConfig default_config, struct LDKCVec_ChannelMonitorZ channel_monitors);
19798 * Read a C2Tuple_BlockHashChannelManagerZ from a byte array, created by C2Tuple_BlockHashChannelManagerZ_write
19800 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ C2Tuple_BlockHashChannelManagerZ_read(struct LDKu8slice ser, struct LDKChannelManagerReadArgs arg);
19803 * Frees any resources used by the DecodeError, if is_owned is set and inner is non-NULL.
19805 void DecodeError_free(struct LDKDecodeError this_obj);
19808 * Creates a copy of the DecodeError
19810 struct LDKDecodeError DecodeError_clone(const struct LDKDecodeError *NONNULL_PTR orig);
19813 * Frees any resources used by the Init, if is_owned is set and inner is non-NULL.
19815 void Init_free(struct LDKInit this_obj);
19818 * The relevant features which the sender supports
19820 struct LDKInitFeatures Init_get_features(const struct LDKInit *NONNULL_PTR this_ptr);
19823 * The relevant features which the sender supports
19825 void Init_set_features(struct LDKInit *NONNULL_PTR this_ptr, struct LDKInitFeatures val);
19828 * Constructs a new Init given each field
19830 MUST_USE_RES struct LDKInit Init_new(struct LDKInitFeatures features_arg);
19833 * Creates a copy of the Init
19835 struct LDKInit Init_clone(const struct LDKInit *NONNULL_PTR orig);
19838 * Frees any resources used by the ErrorMessage, if is_owned is set and inner is non-NULL.
19840 void ErrorMessage_free(struct LDKErrorMessage this_obj);
19843 * The channel ID involved in the error.
19845 * All-0s indicates a general error unrelated to a specific channel, after which all channels
19846 * with the sending peer should be closed.
19848 const uint8_t (*ErrorMessage_get_channel_id(const struct LDKErrorMessage *NONNULL_PTR this_ptr))[32];
19851 * The channel ID involved in the error.
19853 * All-0s indicates a general error unrelated to a specific channel, after which all channels
19854 * with the sending peer should be closed.
19856 void ErrorMessage_set_channel_id(struct LDKErrorMessage *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
19859 * A possibly human-readable error description.
19860 * The string should be sanitized before it is used (e.g. emitted to logs or printed to
19861 * stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
19862 * the terminal emulator or the logging subsystem.
19864 struct LDKStr ErrorMessage_get_data(const struct LDKErrorMessage *NONNULL_PTR this_ptr);
19867 * A possibly human-readable error description.
19868 * The string should be sanitized before it is used (e.g. emitted to logs or printed to
19869 * stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
19870 * the terminal emulator or the logging subsystem.
19872 void ErrorMessage_set_data(struct LDKErrorMessage *NONNULL_PTR this_ptr, struct LDKStr val);
19875 * Constructs a new ErrorMessage given each field
19877 MUST_USE_RES struct LDKErrorMessage ErrorMessage_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKStr data_arg);
19880 * Creates a copy of the ErrorMessage
19882 struct LDKErrorMessage ErrorMessage_clone(const struct LDKErrorMessage *NONNULL_PTR orig);
19885 * Frees any resources used by the WarningMessage, if is_owned is set and inner is non-NULL.
19887 void WarningMessage_free(struct LDKWarningMessage this_obj);
19890 * The channel ID involved in the warning.
19892 * All-0s indicates a warning unrelated to a specific channel.
19894 const uint8_t (*WarningMessage_get_channel_id(const struct LDKWarningMessage *NONNULL_PTR this_ptr))[32];
19897 * The channel ID involved in the warning.
19899 * All-0s indicates a warning unrelated to a specific channel.
19901 void WarningMessage_set_channel_id(struct LDKWarningMessage *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
19904 * A possibly human-readable warning description.
19905 * The string should be sanitized before it is used (e.g. emitted to logs or printed to
19906 * stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
19907 * the terminal emulator or the logging subsystem.
19909 struct LDKStr WarningMessage_get_data(const struct LDKWarningMessage *NONNULL_PTR this_ptr);
19912 * A possibly human-readable warning description.
19913 * The string should be sanitized before it is used (e.g. emitted to logs or printed to
19914 * stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
19915 * the terminal emulator or the logging subsystem.
19917 void WarningMessage_set_data(struct LDKWarningMessage *NONNULL_PTR this_ptr, struct LDKStr val);
19920 * Constructs a new WarningMessage given each field
19922 MUST_USE_RES struct LDKWarningMessage WarningMessage_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKStr data_arg);
19925 * Creates a copy of the WarningMessage
19927 struct LDKWarningMessage WarningMessage_clone(const struct LDKWarningMessage *NONNULL_PTR orig);
19930 * Frees any resources used by the Ping, if is_owned is set and inner is non-NULL.
19932 void Ping_free(struct LDKPing this_obj);
19935 * The desired response length
19937 uint16_t Ping_get_ponglen(const struct LDKPing *NONNULL_PTR this_ptr);
19940 * The desired response length
19942 void Ping_set_ponglen(struct LDKPing *NONNULL_PTR this_ptr, uint16_t val);
19945 * The ping packet size.
19946 * This field is not sent on the wire. byteslen zeros are sent.
19948 uint16_t Ping_get_byteslen(const struct LDKPing *NONNULL_PTR this_ptr);
19951 * The ping packet size.
19952 * This field is not sent on the wire. byteslen zeros are sent.
19954 void Ping_set_byteslen(struct LDKPing *NONNULL_PTR this_ptr, uint16_t val);
19957 * Constructs a new Ping given each field
19959 MUST_USE_RES struct LDKPing Ping_new(uint16_t ponglen_arg, uint16_t byteslen_arg);
19962 * Creates a copy of the Ping
19964 struct LDKPing Ping_clone(const struct LDKPing *NONNULL_PTR orig);
19967 * Frees any resources used by the Pong, if is_owned is set and inner is non-NULL.
19969 void Pong_free(struct LDKPong this_obj);
19972 * The pong packet size.
19973 * This field is not sent on the wire. byteslen zeros are sent.
19975 uint16_t Pong_get_byteslen(const struct LDKPong *NONNULL_PTR this_ptr);
19978 * The pong packet size.
19979 * This field is not sent on the wire. byteslen zeros are sent.
19981 void Pong_set_byteslen(struct LDKPong *NONNULL_PTR this_ptr, uint16_t val);
19984 * Constructs a new Pong given each field
19986 MUST_USE_RES struct LDKPong Pong_new(uint16_t byteslen_arg);
19989 * Creates a copy of the Pong
19991 struct LDKPong Pong_clone(const struct LDKPong *NONNULL_PTR orig);
19994 * Frees any resources used by the OpenChannel, if is_owned is set and inner is non-NULL.
19996 void OpenChannel_free(struct LDKOpenChannel this_obj);
19999 * The genesis hash of the blockchain where the channel is to be opened
20001 const uint8_t (*OpenChannel_get_chain_hash(const struct LDKOpenChannel *NONNULL_PTR this_ptr))[32];
20004 * The genesis hash of the blockchain where the channel is to be opened
20006 void OpenChannel_set_chain_hash(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20009 * A temporary channel ID, until the funding outpoint is announced
20011 const uint8_t (*OpenChannel_get_temporary_channel_id(const struct LDKOpenChannel *NONNULL_PTR this_ptr))[32];
20014 * A temporary channel ID, until the funding outpoint is announced
20016 void OpenChannel_set_temporary_channel_id(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20019 * The channel value
20021 uint64_t OpenChannel_get_funding_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20024 * The channel value
20026 void OpenChannel_set_funding_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
20029 * The amount to push to the counterparty as part of the open, in milli-satoshi
20031 uint64_t OpenChannel_get_push_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20034 * The amount to push to the counterparty as part of the open, in milli-satoshi
20036 void OpenChannel_set_push_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
20039 * The threshold below which outputs on transactions broadcast by sender will be omitted
20041 uint64_t OpenChannel_get_dust_limit_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20044 * The threshold below which outputs on transactions broadcast by sender will be omitted
20046 void OpenChannel_set_dust_limit_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
20049 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
20051 uint64_t OpenChannel_get_max_htlc_value_in_flight_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20054 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
20056 void OpenChannel_set_max_htlc_value_in_flight_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
20059 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
20061 uint64_t OpenChannel_get_channel_reserve_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20064 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
20066 void OpenChannel_set_channel_reserve_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
20069 * The minimum HTLC size incoming to sender, in milli-satoshi
20071 uint64_t OpenChannel_get_htlc_minimum_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20074 * The minimum HTLC size incoming to sender, in milli-satoshi
20076 void OpenChannel_set_htlc_minimum_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
20079 * The feerate per 1000-weight of sender generated transactions, until updated by update_fee
20081 uint32_t OpenChannel_get_feerate_per_kw(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20084 * The feerate per 1000-weight of sender generated transactions, until updated by update_fee
20086 void OpenChannel_set_feerate_per_kw(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint32_t val);
20089 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
20091 uint16_t OpenChannel_get_to_self_delay(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20094 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
20096 void OpenChannel_set_to_self_delay(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint16_t val);
20099 * The maximum number of inbound HTLCs towards sender
20101 uint16_t OpenChannel_get_max_accepted_htlcs(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20104 * The maximum number of inbound HTLCs towards sender
20106 void OpenChannel_set_max_accepted_htlcs(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint16_t val);
20109 * The sender's key controlling the funding transaction
20111 struct LDKPublicKey OpenChannel_get_funding_pubkey(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20114 * The sender's key controlling the funding transaction
20116 void OpenChannel_set_funding_pubkey(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20119 * Used to derive a revocation key for transactions broadcast by counterparty
20121 struct LDKPublicKey OpenChannel_get_revocation_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20124 * Used to derive a revocation key for transactions broadcast by counterparty
20126 void OpenChannel_set_revocation_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20129 * A payment key to sender for transactions broadcast by counterparty
20131 struct LDKPublicKey OpenChannel_get_payment_point(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20134 * A payment key to sender for transactions broadcast by counterparty
20136 void OpenChannel_set_payment_point(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20139 * Used to derive a payment key to sender for transactions broadcast by sender
20141 struct LDKPublicKey OpenChannel_get_delayed_payment_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20144 * Used to derive a payment key to sender for transactions broadcast by sender
20146 void OpenChannel_set_delayed_payment_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20149 * Used to derive an HTLC payment key to sender
20151 struct LDKPublicKey OpenChannel_get_htlc_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20154 * Used to derive an HTLC payment key to sender
20156 void OpenChannel_set_htlc_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20159 * The first to-be-broadcast-by-sender transaction's per commitment point
20161 struct LDKPublicKey OpenChannel_get_first_per_commitment_point(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20164 * The first to-be-broadcast-by-sender transaction's per commitment point
20166 void OpenChannel_set_first_per_commitment_point(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20171 uint8_t OpenChannel_get_channel_flags(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20176 void OpenChannel_set_channel_flags(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint8_t val);
20179 * The channel type that this channel will represent. If none is set, we derive the channel
20180 * type from the intersection of our feature bits with our counterparty's feature bits from
20181 * the Init message.
20183 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20185 struct LDKChannelTypeFeatures OpenChannel_get_channel_type(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20188 * The channel type that this channel will represent. If none is set, we derive the channel
20189 * type from the intersection of our feature bits with our counterparty's feature bits from
20190 * the Init message.
20192 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20194 void OpenChannel_set_channel_type(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKChannelTypeFeatures val);
20197 * Creates a copy of the OpenChannel
20199 struct LDKOpenChannel OpenChannel_clone(const struct LDKOpenChannel *NONNULL_PTR orig);
20202 * Frees any resources used by the AcceptChannel, if is_owned is set and inner is non-NULL.
20204 void AcceptChannel_free(struct LDKAcceptChannel this_obj);
20207 * A temporary channel ID, until the funding outpoint is announced
20209 const uint8_t (*AcceptChannel_get_temporary_channel_id(const struct LDKAcceptChannel *NONNULL_PTR this_ptr))[32];
20212 * A temporary channel ID, until the funding outpoint is announced
20214 void AcceptChannel_set_temporary_channel_id(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20217 * The threshold below which outputs on transactions broadcast by sender will be omitted
20219 uint64_t AcceptChannel_get_dust_limit_satoshis(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20222 * The threshold below which outputs on transactions broadcast by sender will be omitted
20224 void AcceptChannel_set_dust_limit_satoshis(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
20227 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
20229 uint64_t AcceptChannel_get_max_htlc_value_in_flight_msat(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20232 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
20234 void AcceptChannel_set_max_htlc_value_in_flight_msat(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
20237 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
20239 uint64_t AcceptChannel_get_channel_reserve_satoshis(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20242 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
20244 void AcceptChannel_set_channel_reserve_satoshis(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
20247 * The minimum HTLC size incoming to sender, in milli-satoshi
20249 uint64_t AcceptChannel_get_htlc_minimum_msat(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20252 * The minimum HTLC size incoming to sender, in milli-satoshi
20254 void AcceptChannel_set_htlc_minimum_msat(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
20257 * Minimum depth of the funding transaction before the channel is considered open
20259 uint32_t AcceptChannel_get_minimum_depth(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20262 * Minimum depth of the funding transaction before the channel is considered open
20264 void AcceptChannel_set_minimum_depth(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint32_t val);
20267 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
20269 uint16_t AcceptChannel_get_to_self_delay(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20272 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
20274 void AcceptChannel_set_to_self_delay(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint16_t val);
20277 * The maximum number of inbound HTLCs towards sender
20279 uint16_t AcceptChannel_get_max_accepted_htlcs(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20282 * The maximum number of inbound HTLCs towards sender
20284 void AcceptChannel_set_max_accepted_htlcs(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint16_t val);
20287 * The sender's key controlling the funding transaction
20289 struct LDKPublicKey AcceptChannel_get_funding_pubkey(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20292 * The sender's key controlling the funding transaction
20294 void AcceptChannel_set_funding_pubkey(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20297 * Used to derive a revocation key for transactions broadcast by counterparty
20299 struct LDKPublicKey AcceptChannel_get_revocation_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20302 * Used to derive a revocation key for transactions broadcast by counterparty
20304 void AcceptChannel_set_revocation_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20307 * A payment key to sender for transactions broadcast by counterparty
20309 struct LDKPublicKey AcceptChannel_get_payment_point(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20312 * A payment key to sender for transactions broadcast by counterparty
20314 void AcceptChannel_set_payment_point(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20317 * Used to derive a payment key to sender for transactions broadcast by sender
20319 struct LDKPublicKey AcceptChannel_get_delayed_payment_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20322 * Used to derive a payment key to sender for transactions broadcast by sender
20324 void AcceptChannel_set_delayed_payment_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20327 * Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
20329 struct LDKPublicKey AcceptChannel_get_htlc_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20332 * Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
20334 void AcceptChannel_set_htlc_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20337 * The first to-be-broadcast-by-sender transaction's per commitment point
20339 struct LDKPublicKey AcceptChannel_get_first_per_commitment_point(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20342 * The first to-be-broadcast-by-sender transaction's per commitment point
20344 void AcceptChannel_set_first_per_commitment_point(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20347 * The channel type that this channel will represent. If none is set, we derive the channel
20348 * type from the intersection of our feature bits with our counterparty's feature bits from
20349 * the Init message.
20351 * This is required to match the equivalent field in [`OpenChannel::channel_type`].
20353 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20355 struct LDKChannelTypeFeatures AcceptChannel_get_channel_type(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20358 * The channel type that this channel will represent. If none is set, we derive the channel
20359 * type from the intersection of our feature bits with our counterparty's feature bits from
20360 * the Init message.
20362 * This is required to match the equivalent field in [`OpenChannel::channel_type`].
20364 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20366 void AcceptChannel_set_channel_type(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKChannelTypeFeatures val);
20369 * Creates a copy of the AcceptChannel
20371 struct LDKAcceptChannel AcceptChannel_clone(const struct LDKAcceptChannel *NONNULL_PTR orig);
20374 * Frees any resources used by the FundingCreated, if is_owned is set and inner is non-NULL.
20376 void FundingCreated_free(struct LDKFundingCreated this_obj);
20379 * A temporary channel ID, until the funding is established
20381 const uint8_t (*FundingCreated_get_temporary_channel_id(const struct LDKFundingCreated *NONNULL_PTR this_ptr))[32];
20384 * A temporary channel ID, until the funding is established
20386 void FundingCreated_set_temporary_channel_id(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20389 * The funding transaction ID
20391 const uint8_t (*FundingCreated_get_funding_txid(const struct LDKFundingCreated *NONNULL_PTR this_ptr))[32];
20394 * The funding transaction ID
20396 void FundingCreated_set_funding_txid(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20399 * The specific output index funding this channel
20401 uint16_t FundingCreated_get_funding_output_index(const struct LDKFundingCreated *NONNULL_PTR this_ptr);
20404 * The specific output index funding this channel
20406 void FundingCreated_set_funding_output_index(struct LDKFundingCreated *NONNULL_PTR this_ptr, uint16_t val);
20409 * The signature of the channel initiator (funder) on the initial commitment transaction
20411 struct LDKSignature FundingCreated_get_signature(const struct LDKFundingCreated *NONNULL_PTR this_ptr);
20414 * The signature of the channel initiator (funder) on the initial commitment transaction
20416 void FundingCreated_set_signature(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKSignature val);
20419 * Constructs a new FundingCreated given each field
20421 MUST_USE_RES struct LDKFundingCreated FundingCreated_new(struct LDKThirtyTwoBytes temporary_channel_id_arg, struct LDKThirtyTwoBytes funding_txid_arg, uint16_t funding_output_index_arg, struct LDKSignature signature_arg);
20424 * Creates a copy of the FundingCreated
20426 struct LDKFundingCreated FundingCreated_clone(const struct LDKFundingCreated *NONNULL_PTR orig);
20429 * Frees any resources used by the FundingSigned, if is_owned is set and inner is non-NULL.
20431 void FundingSigned_free(struct LDKFundingSigned this_obj);
20436 const uint8_t (*FundingSigned_get_channel_id(const struct LDKFundingSigned *NONNULL_PTR this_ptr))[32];
20441 void FundingSigned_set_channel_id(struct LDKFundingSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20444 * The signature of the channel acceptor (fundee) on the initial commitment transaction
20446 struct LDKSignature FundingSigned_get_signature(const struct LDKFundingSigned *NONNULL_PTR this_ptr);
20449 * The signature of the channel acceptor (fundee) on the initial commitment transaction
20451 void FundingSigned_set_signature(struct LDKFundingSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
20454 * Constructs a new FundingSigned given each field
20456 MUST_USE_RES struct LDKFundingSigned FundingSigned_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKSignature signature_arg);
20459 * Creates a copy of the FundingSigned
20461 struct LDKFundingSigned FundingSigned_clone(const struct LDKFundingSigned *NONNULL_PTR orig);
20464 * Frees any resources used by the FundingLocked, if is_owned is set and inner is non-NULL.
20466 void FundingLocked_free(struct LDKFundingLocked this_obj);
20471 const uint8_t (*FundingLocked_get_channel_id(const struct LDKFundingLocked *NONNULL_PTR this_ptr))[32];
20476 void FundingLocked_set_channel_id(struct LDKFundingLocked *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20479 * The per-commitment point of the second commitment transaction
20481 struct LDKPublicKey FundingLocked_get_next_per_commitment_point(const struct LDKFundingLocked *NONNULL_PTR this_ptr);
20484 * The per-commitment point of the second commitment transaction
20486 void FundingLocked_set_next_per_commitment_point(struct LDKFundingLocked *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20489 * Constructs a new FundingLocked given each field
20491 MUST_USE_RES struct LDKFundingLocked FundingLocked_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKPublicKey next_per_commitment_point_arg);
20494 * Creates a copy of the FundingLocked
20496 struct LDKFundingLocked FundingLocked_clone(const struct LDKFundingLocked *NONNULL_PTR orig);
20499 * Frees any resources used by the Shutdown, if is_owned is set and inner is non-NULL.
20501 void Shutdown_free(struct LDKShutdown this_obj);
20506 const uint8_t (*Shutdown_get_channel_id(const struct LDKShutdown *NONNULL_PTR this_ptr))[32];
20511 void Shutdown_set_channel_id(struct LDKShutdown *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20514 * The destination of this peer's funds on closing.
20515 * Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
20517 struct LDKu8slice Shutdown_get_scriptpubkey(const struct LDKShutdown *NONNULL_PTR this_ptr);
20520 * The destination of this peer's funds on closing.
20521 * Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
20523 void Shutdown_set_scriptpubkey(struct LDKShutdown *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
20526 * Constructs a new Shutdown given each field
20528 MUST_USE_RES struct LDKShutdown Shutdown_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKCVec_u8Z scriptpubkey_arg);
20531 * Creates a copy of the Shutdown
20533 struct LDKShutdown Shutdown_clone(const struct LDKShutdown *NONNULL_PTR orig);
20536 * Frees any resources used by the ClosingSignedFeeRange, if is_owned is set and inner is non-NULL.
20538 void ClosingSignedFeeRange_free(struct LDKClosingSignedFeeRange this_obj);
20541 * The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
20544 uint64_t ClosingSignedFeeRange_get_min_fee_satoshis(const struct LDKClosingSignedFeeRange *NONNULL_PTR this_ptr);
20547 * The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
20550 void ClosingSignedFeeRange_set_min_fee_satoshis(struct LDKClosingSignedFeeRange *NONNULL_PTR this_ptr, uint64_t val);
20553 * The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
20556 uint64_t ClosingSignedFeeRange_get_max_fee_satoshis(const struct LDKClosingSignedFeeRange *NONNULL_PTR this_ptr);
20559 * The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
20562 void ClosingSignedFeeRange_set_max_fee_satoshis(struct LDKClosingSignedFeeRange *NONNULL_PTR this_ptr, uint64_t val);
20565 * Constructs a new ClosingSignedFeeRange given each field
20567 MUST_USE_RES struct LDKClosingSignedFeeRange ClosingSignedFeeRange_new(uint64_t min_fee_satoshis_arg, uint64_t max_fee_satoshis_arg);
20570 * Creates a copy of the ClosingSignedFeeRange
20572 struct LDKClosingSignedFeeRange ClosingSignedFeeRange_clone(const struct LDKClosingSignedFeeRange *NONNULL_PTR orig);
20575 * Frees any resources used by the ClosingSigned, if is_owned is set and inner is non-NULL.
20577 void ClosingSigned_free(struct LDKClosingSigned this_obj);
20582 const uint8_t (*ClosingSigned_get_channel_id(const struct LDKClosingSigned *NONNULL_PTR this_ptr))[32];
20587 void ClosingSigned_set_channel_id(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20590 * The proposed total fee for the closing transaction
20592 uint64_t ClosingSigned_get_fee_satoshis(const struct LDKClosingSigned *NONNULL_PTR this_ptr);
20595 * The proposed total fee for the closing transaction
20597 void ClosingSigned_set_fee_satoshis(struct LDKClosingSigned *NONNULL_PTR this_ptr, uint64_t val);
20600 * A signature on the closing transaction
20602 struct LDKSignature ClosingSigned_get_signature(const struct LDKClosingSigned *NONNULL_PTR this_ptr);
20605 * A signature on the closing transaction
20607 void ClosingSigned_set_signature(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
20610 * The minimum and maximum fees which the sender is willing to accept, provided only by new
20613 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20615 struct LDKClosingSignedFeeRange ClosingSigned_get_fee_range(const struct LDKClosingSigned *NONNULL_PTR this_ptr);
20618 * The minimum and maximum fees which the sender is willing to accept, provided only by new
20621 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20623 void ClosingSigned_set_fee_range(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKClosingSignedFeeRange val);
20626 * Constructs a new ClosingSigned given each field
20628 MUST_USE_RES struct LDKClosingSigned ClosingSigned_new(struct LDKThirtyTwoBytes channel_id_arg, uint64_t fee_satoshis_arg, struct LDKSignature signature_arg, struct LDKClosingSignedFeeRange fee_range_arg);
20631 * Creates a copy of the ClosingSigned
20633 struct LDKClosingSigned ClosingSigned_clone(const struct LDKClosingSigned *NONNULL_PTR orig);
20636 * Frees any resources used by the UpdateAddHTLC, if is_owned is set and inner is non-NULL.
20638 void UpdateAddHTLC_free(struct LDKUpdateAddHTLC this_obj);
20643 const uint8_t (*UpdateAddHTLC_get_channel_id(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr))[32];
20648 void UpdateAddHTLC_set_channel_id(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20653 uint64_t UpdateAddHTLC_get_htlc_id(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
20658 void UpdateAddHTLC_set_htlc_id(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint64_t val);
20661 * The HTLC value in milli-satoshi
20663 uint64_t UpdateAddHTLC_get_amount_msat(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
20666 * The HTLC value in milli-satoshi
20668 void UpdateAddHTLC_set_amount_msat(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint64_t val);
20671 * The payment hash, the pre-image of which controls HTLC redemption
20673 const uint8_t (*UpdateAddHTLC_get_payment_hash(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr))[32];
20676 * The payment hash, the pre-image of which controls HTLC redemption
20678 void UpdateAddHTLC_set_payment_hash(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20681 * The expiry height of the HTLC
20683 uint32_t UpdateAddHTLC_get_cltv_expiry(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
20686 * The expiry height of the HTLC
20688 void UpdateAddHTLC_set_cltv_expiry(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint32_t val);
20691 * Creates a copy of the UpdateAddHTLC
20693 struct LDKUpdateAddHTLC UpdateAddHTLC_clone(const struct LDKUpdateAddHTLC *NONNULL_PTR orig);
20696 * Frees any resources used by the UpdateFulfillHTLC, if is_owned is set and inner is non-NULL.
20698 void UpdateFulfillHTLC_free(struct LDKUpdateFulfillHTLC this_obj);
20703 const uint8_t (*UpdateFulfillHTLC_get_channel_id(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr))[32];
20708 void UpdateFulfillHTLC_set_channel_id(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20713 uint64_t UpdateFulfillHTLC_get_htlc_id(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr);
20718 void UpdateFulfillHTLC_set_htlc_id(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, uint64_t val);
20721 * The pre-image of the payment hash, allowing HTLC redemption
20723 const uint8_t (*UpdateFulfillHTLC_get_payment_preimage(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr))[32];
20726 * The pre-image of the payment hash, allowing HTLC redemption
20728 void UpdateFulfillHTLC_set_payment_preimage(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20731 * Constructs a new UpdateFulfillHTLC given each field
20733 MUST_USE_RES struct LDKUpdateFulfillHTLC UpdateFulfillHTLC_new(struct LDKThirtyTwoBytes channel_id_arg, uint64_t htlc_id_arg, struct LDKThirtyTwoBytes payment_preimage_arg);
20736 * Creates a copy of the UpdateFulfillHTLC
20738 struct LDKUpdateFulfillHTLC UpdateFulfillHTLC_clone(const struct LDKUpdateFulfillHTLC *NONNULL_PTR orig);
20741 * Frees any resources used by the UpdateFailHTLC, if is_owned is set and inner is non-NULL.
20743 void UpdateFailHTLC_free(struct LDKUpdateFailHTLC this_obj);
20748 const uint8_t (*UpdateFailHTLC_get_channel_id(const struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr))[32];
20753 void UpdateFailHTLC_set_channel_id(struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20758 uint64_t UpdateFailHTLC_get_htlc_id(const struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr);
20763 void UpdateFailHTLC_set_htlc_id(struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr, uint64_t val);
20766 * Creates a copy of the UpdateFailHTLC
20768 struct LDKUpdateFailHTLC UpdateFailHTLC_clone(const struct LDKUpdateFailHTLC *NONNULL_PTR orig);
20771 * Frees any resources used by the UpdateFailMalformedHTLC, if is_owned is set and inner is non-NULL.
20773 void UpdateFailMalformedHTLC_free(struct LDKUpdateFailMalformedHTLC this_obj);
20778 const uint8_t (*UpdateFailMalformedHTLC_get_channel_id(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr))[32];
20783 void UpdateFailMalformedHTLC_set_channel_id(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20788 uint64_t UpdateFailMalformedHTLC_get_htlc_id(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr);
20793 void UpdateFailMalformedHTLC_set_htlc_id(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, uint64_t val);
20798 uint16_t UpdateFailMalformedHTLC_get_failure_code(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr);
20803 void UpdateFailMalformedHTLC_set_failure_code(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, uint16_t val);
20806 * Creates a copy of the UpdateFailMalformedHTLC
20808 struct LDKUpdateFailMalformedHTLC UpdateFailMalformedHTLC_clone(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR orig);
20811 * Frees any resources used by the CommitmentSigned, if is_owned is set and inner is non-NULL.
20813 void CommitmentSigned_free(struct LDKCommitmentSigned this_obj);
20818 const uint8_t (*CommitmentSigned_get_channel_id(const struct LDKCommitmentSigned *NONNULL_PTR this_ptr))[32];
20823 void CommitmentSigned_set_channel_id(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20826 * A signature on the commitment transaction
20828 struct LDKSignature CommitmentSigned_get_signature(const struct LDKCommitmentSigned *NONNULL_PTR this_ptr);
20831 * A signature on the commitment transaction
20833 void CommitmentSigned_set_signature(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
20836 * Signatures on the HTLC transactions
20838 void CommitmentSigned_set_htlc_signatures(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKCVec_SignatureZ val);
20841 * Constructs a new CommitmentSigned given each field
20843 MUST_USE_RES struct LDKCommitmentSigned CommitmentSigned_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKSignature signature_arg, struct LDKCVec_SignatureZ htlc_signatures_arg);
20846 * Creates a copy of the CommitmentSigned
20848 struct LDKCommitmentSigned CommitmentSigned_clone(const struct LDKCommitmentSigned *NONNULL_PTR orig);
20851 * Frees any resources used by the RevokeAndACK, if is_owned is set and inner is non-NULL.
20853 void RevokeAndACK_free(struct LDKRevokeAndACK this_obj);
20858 const uint8_t (*RevokeAndACK_get_channel_id(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr))[32];
20863 void RevokeAndACK_set_channel_id(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20866 * The secret corresponding to the per-commitment point
20868 const uint8_t (*RevokeAndACK_get_per_commitment_secret(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr))[32];
20871 * The secret corresponding to the per-commitment point
20873 void RevokeAndACK_set_per_commitment_secret(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20876 * The next sender-broadcast commitment transaction's per-commitment point
20878 struct LDKPublicKey RevokeAndACK_get_next_per_commitment_point(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr);
20881 * The next sender-broadcast commitment transaction's per-commitment point
20883 void RevokeAndACK_set_next_per_commitment_point(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20886 * Constructs a new RevokeAndACK given each field
20888 MUST_USE_RES struct LDKRevokeAndACK RevokeAndACK_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKThirtyTwoBytes per_commitment_secret_arg, struct LDKPublicKey next_per_commitment_point_arg);
20891 * Creates a copy of the RevokeAndACK
20893 struct LDKRevokeAndACK RevokeAndACK_clone(const struct LDKRevokeAndACK *NONNULL_PTR orig);
20896 * Frees any resources used by the UpdateFee, if is_owned is set and inner is non-NULL.
20898 void UpdateFee_free(struct LDKUpdateFee this_obj);
20903 const uint8_t (*UpdateFee_get_channel_id(const struct LDKUpdateFee *NONNULL_PTR this_ptr))[32];
20908 void UpdateFee_set_channel_id(struct LDKUpdateFee *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20911 * Fee rate per 1000-weight of the transaction
20913 uint32_t UpdateFee_get_feerate_per_kw(const struct LDKUpdateFee *NONNULL_PTR this_ptr);
20916 * Fee rate per 1000-weight of the transaction
20918 void UpdateFee_set_feerate_per_kw(struct LDKUpdateFee *NONNULL_PTR this_ptr, uint32_t val);
20921 * Constructs a new UpdateFee given each field
20923 MUST_USE_RES struct LDKUpdateFee UpdateFee_new(struct LDKThirtyTwoBytes channel_id_arg, uint32_t feerate_per_kw_arg);
20926 * Creates a copy of the UpdateFee
20928 struct LDKUpdateFee UpdateFee_clone(const struct LDKUpdateFee *NONNULL_PTR orig);
20931 * Frees any resources used by the DataLossProtect, if is_owned is set and inner is non-NULL.
20933 void DataLossProtect_free(struct LDKDataLossProtect this_obj);
20936 * Proof that the sender knows the per-commitment secret of a specific commitment transaction
20937 * belonging to the recipient
20939 const uint8_t (*DataLossProtect_get_your_last_per_commitment_secret(const struct LDKDataLossProtect *NONNULL_PTR this_ptr))[32];
20942 * Proof that the sender knows the per-commitment secret of a specific commitment transaction
20943 * belonging to the recipient
20945 void DataLossProtect_set_your_last_per_commitment_secret(struct LDKDataLossProtect *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20948 * The sender's per-commitment point for their current commitment transaction
20950 struct LDKPublicKey DataLossProtect_get_my_current_per_commitment_point(const struct LDKDataLossProtect *NONNULL_PTR this_ptr);
20953 * The sender's per-commitment point for their current commitment transaction
20955 void DataLossProtect_set_my_current_per_commitment_point(struct LDKDataLossProtect *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20958 * Constructs a new DataLossProtect given each field
20960 MUST_USE_RES struct LDKDataLossProtect DataLossProtect_new(struct LDKThirtyTwoBytes your_last_per_commitment_secret_arg, struct LDKPublicKey my_current_per_commitment_point_arg);
20963 * Creates a copy of the DataLossProtect
20965 struct LDKDataLossProtect DataLossProtect_clone(const struct LDKDataLossProtect *NONNULL_PTR orig);
20968 * Frees any resources used by the ChannelReestablish, if is_owned is set and inner is non-NULL.
20970 void ChannelReestablish_free(struct LDKChannelReestablish this_obj);
20975 const uint8_t (*ChannelReestablish_get_channel_id(const struct LDKChannelReestablish *NONNULL_PTR this_ptr))[32];
20980 void ChannelReestablish_set_channel_id(struct LDKChannelReestablish *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20983 * The next commitment number for the sender
20985 uint64_t ChannelReestablish_get_next_local_commitment_number(const struct LDKChannelReestablish *NONNULL_PTR this_ptr);
20988 * The next commitment number for the sender
20990 void ChannelReestablish_set_next_local_commitment_number(struct LDKChannelReestablish *NONNULL_PTR this_ptr, uint64_t val);
20993 * The next commitment number for the recipient
20995 uint64_t ChannelReestablish_get_next_remote_commitment_number(const struct LDKChannelReestablish *NONNULL_PTR this_ptr);
20998 * The next commitment number for the recipient
21000 void ChannelReestablish_set_next_remote_commitment_number(struct LDKChannelReestablish *NONNULL_PTR this_ptr, uint64_t val);
21003 * Creates a copy of the ChannelReestablish
21005 struct LDKChannelReestablish ChannelReestablish_clone(const struct LDKChannelReestablish *NONNULL_PTR orig);
21008 * Frees any resources used by the AnnouncementSignatures, if is_owned is set and inner is non-NULL.
21010 void AnnouncementSignatures_free(struct LDKAnnouncementSignatures this_obj);
21015 const uint8_t (*AnnouncementSignatures_get_channel_id(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr))[32];
21020 void AnnouncementSignatures_set_channel_id(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21023 * The short channel ID
21025 uint64_t AnnouncementSignatures_get_short_channel_id(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
21028 * The short channel ID
21030 void AnnouncementSignatures_set_short_channel_id(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, uint64_t val);
21033 * A signature by the node key
21035 struct LDKSignature AnnouncementSignatures_get_node_signature(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
21038 * A signature by the node key
21040 void AnnouncementSignatures_set_node_signature(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKSignature val);
21043 * A signature by the funding key
21045 struct LDKSignature AnnouncementSignatures_get_bitcoin_signature(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
21048 * A signature by the funding key
21050 void AnnouncementSignatures_set_bitcoin_signature(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKSignature val);
21053 * Constructs a new AnnouncementSignatures given each field
21055 MUST_USE_RES struct LDKAnnouncementSignatures AnnouncementSignatures_new(struct LDKThirtyTwoBytes channel_id_arg, uint64_t short_channel_id_arg, struct LDKSignature node_signature_arg, struct LDKSignature bitcoin_signature_arg);
21058 * Creates a copy of the AnnouncementSignatures
21060 struct LDKAnnouncementSignatures AnnouncementSignatures_clone(const struct LDKAnnouncementSignatures *NONNULL_PTR orig);
21063 * Frees any resources used by the NetAddress
21065 void NetAddress_free(struct LDKNetAddress this_ptr);
21068 * Creates a copy of the NetAddress
21070 struct LDKNetAddress NetAddress_clone(const struct LDKNetAddress *NONNULL_PTR orig);
21073 * Utility method to constructs a new IPv4-variant NetAddress
21075 struct LDKNetAddress NetAddress_ipv4(struct LDKFourBytes addr, uint16_t port);
21078 * Utility method to constructs a new IPv6-variant NetAddress
21080 struct LDKNetAddress NetAddress_ipv6(struct LDKSixteenBytes addr, uint16_t port);
21083 * Utility method to constructs a new OnionV2-variant NetAddress
21085 struct LDKNetAddress NetAddress_onion_v2(struct LDKTwelveBytes a);
21088 * Utility method to constructs a new OnionV3-variant NetAddress
21090 struct LDKNetAddress NetAddress_onion_v3(struct LDKThirtyTwoBytes ed25519_pubkey, uint16_t checksum, uint8_t version, uint16_t port);
21093 * Serialize the NetAddress object into a byte array which can be read by NetAddress_read
21095 struct LDKCVec_u8Z NetAddress_write(const struct LDKNetAddress *NONNULL_PTR obj);
21098 * Read a NetAddress from a byte array, created by NetAddress_write
21100 struct LDKCResult_NetAddressDecodeErrorZ NetAddress_read(struct LDKu8slice ser);
21103 * Frees any resources used by the UnsignedNodeAnnouncement, if is_owned is set and inner is non-NULL.
21105 void UnsignedNodeAnnouncement_free(struct LDKUnsignedNodeAnnouncement this_obj);
21108 * The advertised features
21110 struct LDKNodeFeatures UnsignedNodeAnnouncement_get_features(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
21113 * The advertised features
21115 void UnsignedNodeAnnouncement_set_features(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
21118 * A strictly monotonic announcement counter, with gaps allowed
21120 uint32_t UnsignedNodeAnnouncement_get_timestamp(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
21123 * A strictly monotonic announcement counter, with gaps allowed
21125 void UnsignedNodeAnnouncement_set_timestamp(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, uint32_t val);
21128 * The node_id this announcement originated from (don't rebroadcast the node_announcement back
21131 struct LDKPublicKey UnsignedNodeAnnouncement_get_node_id(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
21134 * The node_id this announcement originated from (don't rebroadcast the node_announcement back
21137 void UnsignedNodeAnnouncement_set_node_id(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
21140 * An RGB color for UI purposes
21142 const uint8_t (*UnsignedNodeAnnouncement_get_rgb(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr))[3];
21145 * An RGB color for UI purposes
21147 void UnsignedNodeAnnouncement_set_rgb(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKThreeBytes val);
21150 * An alias, for UI purposes. This should be sanitized before use. There is no guarantee
21153 const uint8_t (*UnsignedNodeAnnouncement_get_alias(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr))[32];
21156 * An alias, for UI purposes. This should be sanitized before use. There is no guarantee
21159 void UnsignedNodeAnnouncement_set_alias(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21162 * List of addresses on which this node is reachable
21164 void UnsignedNodeAnnouncement_set_addresses(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKCVec_NetAddressZ val);
21167 * Creates a copy of the UnsignedNodeAnnouncement
21169 struct LDKUnsignedNodeAnnouncement UnsignedNodeAnnouncement_clone(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR orig);
21172 * Frees any resources used by the NodeAnnouncement, if is_owned is set and inner is non-NULL.
21174 void NodeAnnouncement_free(struct LDKNodeAnnouncement this_obj);
21177 * The signature by the node key
21179 struct LDKSignature NodeAnnouncement_get_signature(const struct LDKNodeAnnouncement *NONNULL_PTR this_ptr);
21182 * The signature by the node key
21184 void NodeAnnouncement_set_signature(struct LDKNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
21187 * The actual content of the announcement
21189 struct LDKUnsignedNodeAnnouncement NodeAnnouncement_get_contents(const struct LDKNodeAnnouncement *NONNULL_PTR this_ptr);
21192 * The actual content of the announcement
21194 void NodeAnnouncement_set_contents(struct LDKNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKUnsignedNodeAnnouncement val);
21197 * Constructs a new NodeAnnouncement given each field
21199 MUST_USE_RES struct LDKNodeAnnouncement NodeAnnouncement_new(struct LDKSignature signature_arg, struct LDKUnsignedNodeAnnouncement contents_arg);
21202 * Creates a copy of the NodeAnnouncement
21204 struct LDKNodeAnnouncement NodeAnnouncement_clone(const struct LDKNodeAnnouncement *NONNULL_PTR orig);
21207 * Frees any resources used by the UnsignedChannelAnnouncement, if is_owned is set and inner is non-NULL.
21209 void UnsignedChannelAnnouncement_free(struct LDKUnsignedChannelAnnouncement this_obj);
21212 * The advertised channel features
21214 struct LDKChannelFeatures UnsignedChannelAnnouncement_get_features(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
21217 * The advertised channel features
21219 void UnsignedChannelAnnouncement_set_features(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
21222 * The genesis hash of the blockchain where the channel is to be opened
21224 const uint8_t (*UnsignedChannelAnnouncement_get_chain_hash(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr))[32];
21227 * The genesis hash of the blockchain where the channel is to be opened
21229 void UnsignedChannelAnnouncement_set_chain_hash(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21232 * The short channel ID
21234 uint64_t UnsignedChannelAnnouncement_get_short_channel_id(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
21237 * The short channel ID
21239 void UnsignedChannelAnnouncement_set_short_channel_id(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, uint64_t val);
21242 * One of the two node_ids which are endpoints of this channel
21244 struct LDKPublicKey UnsignedChannelAnnouncement_get_node_id_1(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
21247 * One of the two node_ids which are endpoints of this channel
21249 void UnsignedChannelAnnouncement_set_node_id_1(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
21252 * The other of the two node_ids which are endpoints of this channel
21254 struct LDKPublicKey UnsignedChannelAnnouncement_get_node_id_2(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
21257 * The other of the two node_ids which are endpoints of this channel
21259 void UnsignedChannelAnnouncement_set_node_id_2(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
21262 * The funding key for the first node
21264 struct LDKPublicKey UnsignedChannelAnnouncement_get_bitcoin_key_1(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
21267 * The funding key for the first node
21269 void UnsignedChannelAnnouncement_set_bitcoin_key_1(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
21272 * The funding key for the second node
21274 struct LDKPublicKey UnsignedChannelAnnouncement_get_bitcoin_key_2(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
21277 * The funding key for the second node
21279 void UnsignedChannelAnnouncement_set_bitcoin_key_2(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
21282 * Creates a copy of the UnsignedChannelAnnouncement
21284 struct LDKUnsignedChannelAnnouncement UnsignedChannelAnnouncement_clone(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR orig);
21287 * Frees any resources used by the ChannelAnnouncement, if is_owned is set and inner is non-NULL.
21289 void ChannelAnnouncement_free(struct LDKChannelAnnouncement this_obj);
21292 * Authentication of the announcement by the first public node
21294 struct LDKSignature ChannelAnnouncement_get_node_signature_1(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
21297 * Authentication of the announcement by the first public node
21299 void ChannelAnnouncement_set_node_signature_1(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
21302 * Authentication of the announcement by the second public node
21304 struct LDKSignature ChannelAnnouncement_get_node_signature_2(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
21307 * Authentication of the announcement by the second public node
21309 void ChannelAnnouncement_set_node_signature_2(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
21312 * Proof of funding UTXO ownership by the first public node
21314 struct LDKSignature ChannelAnnouncement_get_bitcoin_signature_1(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
21317 * Proof of funding UTXO ownership by the first public node
21319 void ChannelAnnouncement_set_bitcoin_signature_1(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
21322 * Proof of funding UTXO ownership by the second public node
21324 struct LDKSignature ChannelAnnouncement_get_bitcoin_signature_2(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
21327 * Proof of funding UTXO ownership by the second public node
21329 void ChannelAnnouncement_set_bitcoin_signature_2(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
21332 * The actual announcement
21334 struct LDKUnsignedChannelAnnouncement ChannelAnnouncement_get_contents(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
21337 * The actual announcement
21339 void ChannelAnnouncement_set_contents(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKUnsignedChannelAnnouncement val);
21342 * Constructs a new ChannelAnnouncement given each field
21344 MUST_USE_RES struct LDKChannelAnnouncement ChannelAnnouncement_new(struct LDKSignature node_signature_1_arg, struct LDKSignature node_signature_2_arg, struct LDKSignature bitcoin_signature_1_arg, struct LDKSignature bitcoin_signature_2_arg, struct LDKUnsignedChannelAnnouncement contents_arg);
21347 * Creates a copy of the ChannelAnnouncement
21349 struct LDKChannelAnnouncement ChannelAnnouncement_clone(const struct LDKChannelAnnouncement *NONNULL_PTR orig);
21352 * Frees any resources used by the UnsignedChannelUpdate, if is_owned is set and inner is non-NULL.
21354 void UnsignedChannelUpdate_free(struct LDKUnsignedChannelUpdate this_obj);
21357 * The genesis hash of the blockchain where the channel is to be opened
21359 const uint8_t (*UnsignedChannelUpdate_get_chain_hash(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr))[32];
21362 * The genesis hash of the blockchain where the channel is to be opened
21364 void UnsignedChannelUpdate_set_chain_hash(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21367 * The short channel ID
21369 uint64_t UnsignedChannelUpdate_get_short_channel_id(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
21372 * The short channel ID
21374 void UnsignedChannelUpdate_set_short_channel_id(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint64_t val);
21377 * A strictly monotonic announcement counter, with gaps allowed, specific to this channel
21379 uint32_t UnsignedChannelUpdate_get_timestamp(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
21382 * A strictly monotonic announcement counter, with gaps allowed, specific to this channel
21384 void UnsignedChannelUpdate_set_timestamp(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
21389 uint8_t UnsignedChannelUpdate_get_flags(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
21394 void UnsignedChannelUpdate_set_flags(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint8_t val);
21397 * The number of blocks such that if:
21398 * `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
21399 * then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
21400 * the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
21401 * cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
21402 * then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
21403 * forwarding. Note that the HTLC sender is the one who originally sets this value when
21404 * constructing the route.
21406 uint16_t UnsignedChannelUpdate_get_cltv_expiry_delta(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
21409 * The number of blocks such that if:
21410 * `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
21411 * then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
21412 * the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
21413 * cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
21414 * then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
21415 * forwarding. Note that the HTLC sender is the one who originally sets this value when
21416 * constructing the route.
21418 void UnsignedChannelUpdate_set_cltv_expiry_delta(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint16_t val);
21421 * The minimum HTLC size incoming to sender, in milli-satoshi
21423 uint64_t UnsignedChannelUpdate_get_htlc_minimum_msat(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
21426 * The minimum HTLC size incoming to sender, in milli-satoshi
21428 void UnsignedChannelUpdate_set_htlc_minimum_msat(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint64_t val);
21431 * The base HTLC fee charged by sender, in milli-satoshi
21433 uint32_t UnsignedChannelUpdate_get_fee_base_msat(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
21436 * The base HTLC fee charged by sender, in milli-satoshi
21438 void UnsignedChannelUpdate_set_fee_base_msat(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
21441 * The amount to fee multiplier, in micro-satoshi
21443 uint32_t UnsignedChannelUpdate_get_fee_proportional_millionths(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
21446 * The amount to fee multiplier, in micro-satoshi
21448 void UnsignedChannelUpdate_set_fee_proportional_millionths(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
21451 * Creates a copy of the UnsignedChannelUpdate
21453 struct LDKUnsignedChannelUpdate UnsignedChannelUpdate_clone(const struct LDKUnsignedChannelUpdate *NONNULL_PTR orig);
21456 * Frees any resources used by the ChannelUpdate, if is_owned is set and inner is non-NULL.
21458 void ChannelUpdate_free(struct LDKChannelUpdate this_obj);
21461 * A signature of the channel update
21463 struct LDKSignature ChannelUpdate_get_signature(const struct LDKChannelUpdate *NONNULL_PTR this_ptr);
21466 * A signature of the channel update
21468 void ChannelUpdate_set_signature(struct LDKChannelUpdate *NONNULL_PTR this_ptr, struct LDKSignature val);
21471 * The actual channel update
21473 struct LDKUnsignedChannelUpdate ChannelUpdate_get_contents(const struct LDKChannelUpdate *NONNULL_PTR this_ptr);
21476 * The actual channel update
21478 void ChannelUpdate_set_contents(struct LDKChannelUpdate *NONNULL_PTR this_ptr, struct LDKUnsignedChannelUpdate val);
21481 * Constructs a new ChannelUpdate given each field
21483 MUST_USE_RES struct LDKChannelUpdate ChannelUpdate_new(struct LDKSignature signature_arg, struct LDKUnsignedChannelUpdate contents_arg);
21486 * Creates a copy of the ChannelUpdate
21488 struct LDKChannelUpdate ChannelUpdate_clone(const struct LDKChannelUpdate *NONNULL_PTR orig);
21491 * Frees any resources used by the QueryChannelRange, if is_owned is set and inner is non-NULL.
21493 void QueryChannelRange_free(struct LDKQueryChannelRange this_obj);
21496 * The genesis hash of the blockchain being queried
21498 const uint8_t (*QueryChannelRange_get_chain_hash(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr))[32];
21501 * The genesis hash of the blockchain being queried
21503 void QueryChannelRange_set_chain_hash(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21506 * The height of the first block for the channel UTXOs being queried
21508 uint32_t QueryChannelRange_get_first_blocknum(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr);
21511 * The height of the first block for the channel UTXOs being queried
21513 void QueryChannelRange_set_first_blocknum(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, uint32_t val);
21516 * The number of blocks to include in the query results
21518 uint32_t QueryChannelRange_get_number_of_blocks(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr);
21521 * The number of blocks to include in the query results
21523 void QueryChannelRange_set_number_of_blocks(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, uint32_t val);
21526 * Constructs a new QueryChannelRange given each field
21528 MUST_USE_RES struct LDKQueryChannelRange QueryChannelRange_new(struct LDKThirtyTwoBytes chain_hash_arg, uint32_t first_blocknum_arg, uint32_t number_of_blocks_arg);
21531 * Creates a copy of the QueryChannelRange
21533 struct LDKQueryChannelRange QueryChannelRange_clone(const struct LDKQueryChannelRange *NONNULL_PTR orig);
21536 * Frees any resources used by the ReplyChannelRange, if is_owned is set and inner is non-NULL.
21538 void ReplyChannelRange_free(struct LDKReplyChannelRange this_obj);
21541 * The genesis hash of the blockchain being queried
21543 const uint8_t (*ReplyChannelRange_get_chain_hash(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr))[32];
21546 * The genesis hash of the blockchain being queried
21548 void ReplyChannelRange_set_chain_hash(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21551 * The height of the first block in the range of the reply
21553 uint32_t ReplyChannelRange_get_first_blocknum(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
21556 * The height of the first block in the range of the reply
21558 void ReplyChannelRange_set_first_blocknum(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, uint32_t val);
21561 * The number of blocks included in the range of the reply
21563 uint32_t ReplyChannelRange_get_number_of_blocks(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
21566 * The number of blocks included in the range of the reply
21568 void ReplyChannelRange_set_number_of_blocks(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, uint32_t val);
21571 * True when this is the final reply for a query
21573 bool ReplyChannelRange_get_sync_complete(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
21576 * True when this is the final reply for a query
21578 void ReplyChannelRange_set_sync_complete(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, bool val);
21581 * The short_channel_ids in the channel range
21583 void ReplyChannelRange_set_short_channel_ids(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
21586 * Constructs a new ReplyChannelRange given each field
21588 MUST_USE_RES struct LDKReplyChannelRange ReplyChannelRange_new(struct LDKThirtyTwoBytes chain_hash_arg, uint32_t first_blocknum_arg, uint32_t number_of_blocks_arg, bool sync_complete_arg, struct LDKCVec_u64Z short_channel_ids_arg);
21591 * Creates a copy of the ReplyChannelRange
21593 struct LDKReplyChannelRange ReplyChannelRange_clone(const struct LDKReplyChannelRange *NONNULL_PTR orig);
21596 * Frees any resources used by the QueryShortChannelIds, if is_owned is set and inner is non-NULL.
21598 void QueryShortChannelIds_free(struct LDKQueryShortChannelIds this_obj);
21601 * The genesis hash of the blockchain being queried
21603 const uint8_t (*QueryShortChannelIds_get_chain_hash(const struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr))[32];
21606 * The genesis hash of the blockchain being queried
21608 void QueryShortChannelIds_set_chain_hash(struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21611 * The short_channel_ids that are being queried
21613 void QueryShortChannelIds_set_short_channel_ids(struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
21616 * Constructs a new QueryShortChannelIds given each field
21618 MUST_USE_RES struct LDKQueryShortChannelIds QueryShortChannelIds_new(struct LDKThirtyTwoBytes chain_hash_arg, struct LDKCVec_u64Z short_channel_ids_arg);
21621 * Creates a copy of the QueryShortChannelIds
21623 struct LDKQueryShortChannelIds QueryShortChannelIds_clone(const struct LDKQueryShortChannelIds *NONNULL_PTR orig);
21626 * Frees any resources used by the ReplyShortChannelIdsEnd, if is_owned is set and inner is non-NULL.
21628 void ReplyShortChannelIdsEnd_free(struct LDKReplyShortChannelIdsEnd this_obj);
21631 * The genesis hash of the blockchain that was queried
21633 const uint8_t (*ReplyShortChannelIdsEnd_get_chain_hash(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr))[32];
21636 * The genesis hash of the blockchain that was queried
21638 void ReplyShortChannelIdsEnd_set_chain_hash(struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21641 * Indicates if the query recipient maintains up-to-date channel
21642 * information for the chain_hash
21644 bool ReplyShortChannelIdsEnd_get_full_information(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr);
21647 * Indicates if the query recipient maintains up-to-date channel
21648 * information for the chain_hash
21650 void ReplyShortChannelIdsEnd_set_full_information(struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr, bool val);
21653 * Constructs a new ReplyShortChannelIdsEnd given each field
21655 MUST_USE_RES struct LDKReplyShortChannelIdsEnd ReplyShortChannelIdsEnd_new(struct LDKThirtyTwoBytes chain_hash_arg, bool full_information_arg);
21658 * Creates a copy of the ReplyShortChannelIdsEnd
21660 struct LDKReplyShortChannelIdsEnd ReplyShortChannelIdsEnd_clone(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR orig);
21663 * Frees any resources used by the GossipTimestampFilter, if is_owned is set and inner is non-NULL.
21665 void GossipTimestampFilter_free(struct LDKGossipTimestampFilter this_obj);
21668 * The genesis hash of the blockchain for channel and node information
21670 const uint8_t (*GossipTimestampFilter_get_chain_hash(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr))[32];
21673 * The genesis hash of the blockchain for channel and node information
21675 void GossipTimestampFilter_set_chain_hash(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21678 * The starting unix timestamp
21680 uint32_t GossipTimestampFilter_get_first_timestamp(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr);
21683 * The starting unix timestamp
21685 void GossipTimestampFilter_set_first_timestamp(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, uint32_t val);
21688 * The range of information in seconds
21690 uint32_t GossipTimestampFilter_get_timestamp_range(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr);
21693 * The range of information in seconds
21695 void GossipTimestampFilter_set_timestamp_range(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, uint32_t val);
21698 * Constructs a new GossipTimestampFilter given each field
21700 MUST_USE_RES struct LDKGossipTimestampFilter GossipTimestampFilter_new(struct LDKThirtyTwoBytes chain_hash_arg, uint32_t first_timestamp_arg, uint32_t timestamp_range_arg);
21703 * Creates a copy of the GossipTimestampFilter
21705 struct LDKGossipTimestampFilter GossipTimestampFilter_clone(const struct LDKGossipTimestampFilter *NONNULL_PTR orig);
21708 * Frees any resources used by the ErrorAction
21710 void ErrorAction_free(struct LDKErrorAction this_ptr);
21713 * Creates a copy of the ErrorAction
21715 struct LDKErrorAction ErrorAction_clone(const struct LDKErrorAction *NONNULL_PTR orig);
21718 * Utility method to constructs a new DisconnectPeer-variant ErrorAction
21720 struct LDKErrorAction ErrorAction_disconnect_peer(struct LDKErrorMessage msg);
21723 * Utility method to constructs a new IgnoreError-variant ErrorAction
21725 struct LDKErrorAction ErrorAction_ignore_error(void);
21728 * Utility method to constructs a new IgnoreAndLog-variant ErrorAction
21730 struct LDKErrorAction ErrorAction_ignore_and_log(enum LDKLevel a);
21733 * Utility method to constructs a new IgnoreDuplicateGossip-variant ErrorAction
21735 struct LDKErrorAction ErrorAction_ignore_duplicate_gossip(void);
21738 * Utility method to constructs a new SendErrorMessage-variant ErrorAction
21740 struct LDKErrorAction ErrorAction_send_error_message(struct LDKErrorMessage msg);
21743 * Utility method to constructs a new SendWarningMessage-variant ErrorAction
21745 struct LDKErrorAction ErrorAction_send_warning_message(struct LDKWarningMessage msg, enum LDKLevel log_level);
21748 * Frees any resources used by the LightningError, if is_owned is set and inner is non-NULL.
21750 void LightningError_free(struct LDKLightningError this_obj);
21753 * A human-readable message describing the error
21755 struct LDKStr LightningError_get_err(const struct LDKLightningError *NONNULL_PTR this_ptr);
21758 * A human-readable message describing the error
21760 void LightningError_set_err(struct LDKLightningError *NONNULL_PTR this_ptr, struct LDKStr val);
21763 * The action which should be taken against the offending peer.
21765 struct LDKErrorAction LightningError_get_action(const struct LDKLightningError *NONNULL_PTR this_ptr);
21768 * The action which should be taken against the offending peer.
21770 void LightningError_set_action(struct LDKLightningError *NONNULL_PTR this_ptr, struct LDKErrorAction val);
21773 * Constructs a new LightningError given each field
21775 MUST_USE_RES struct LDKLightningError LightningError_new(struct LDKStr err_arg, struct LDKErrorAction action_arg);
21778 * Creates a copy of the LightningError
21780 struct LDKLightningError LightningError_clone(const struct LDKLightningError *NONNULL_PTR orig);
21783 * Frees any resources used by the CommitmentUpdate, if is_owned is set and inner is non-NULL.
21785 void CommitmentUpdate_free(struct LDKCommitmentUpdate this_obj);
21788 * update_add_htlc messages which should be sent
21790 struct LDKCVec_UpdateAddHTLCZ CommitmentUpdate_get_update_add_htlcs(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
21793 * update_add_htlc messages which should be sent
21795 void CommitmentUpdate_set_update_add_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateAddHTLCZ val);
21798 * update_fulfill_htlc messages which should be sent
21800 struct LDKCVec_UpdateFulfillHTLCZ CommitmentUpdate_get_update_fulfill_htlcs(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
21803 * update_fulfill_htlc messages which should be sent
21805 void CommitmentUpdate_set_update_fulfill_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFulfillHTLCZ val);
21808 * update_fail_htlc messages which should be sent
21810 struct LDKCVec_UpdateFailHTLCZ CommitmentUpdate_get_update_fail_htlcs(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
21813 * update_fail_htlc messages which should be sent
21815 void CommitmentUpdate_set_update_fail_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFailHTLCZ val);
21818 * update_fail_malformed_htlc messages which should be sent
21820 struct LDKCVec_UpdateFailMalformedHTLCZ CommitmentUpdate_get_update_fail_malformed_htlcs(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
21823 * update_fail_malformed_htlc messages which should be sent
21825 void CommitmentUpdate_set_update_fail_malformed_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFailMalformedHTLCZ val);
21828 * An update_fee message which should be sent
21830 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
21832 struct LDKUpdateFee CommitmentUpdate_get_update_fee(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
21835 * An update_fee message which should be sent
21837 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
21839 void CommitmentUpdate_set_update_fee(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKUpdateFee val);
21842 * Finally, the commitment_signed message which should be sent
21844 struct LDKCommitmentSigned CommitmentUpdate_get_commitment_signed(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
21847 * Finally, the commitment_signed message which should be sent
21849 void CommitmentUpdate_set_commitment_signed(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCommitmentSigned val);
21852 * Constructs a new CommitmentUpdate given each field
21854 MUST_USE_RES struct LDKCommitmentUpdate CommitmentUpdate_new(struct LDKCVec_UpdateAddHTLCZ update_add_htlcs_arg, struct LDKCVec_UpdateFulfillHTLCZ update_fulfill_htlcs_arg, struct LDKCVec_UpdateFailHTLCZ update_fail_htlcs_arg, struct LDKCVec_UpdateFailMalformedHTLCZ update_fail_malformed_htlcs_arg, struct LDKUpdateFee update_fee_arg, struct LDKCommitmentSigned commitment_signed_arg);
21857 * Creates a copy of the CommitmentUpdate
21859 struct LDKCommitmentUpdate CommitmentUpdate_clone(const struct LDKCommitmentUpdate *NONNULL_PTR orig);
21862 * Calls the free function if one is set
21864 void ChannelMessageHandler_free(struct LDKChannelMessageHandler this_ptr);
21867 * Calls the free function if one is set
21869 void RoutingMessageHandler_free(struct LDKRoutingMessageHandler this_ptr);
21872 * Serialize the AcceptChannel object into a byte array which can be read by AcceptChannel_read
21874 struct LDKCVec_u8Z AcceptChannel_write(const struct LDKAcceptChannel *NONNULL_PTR obj);
21877 * Read a AcceptChannel from a byte array, created by AcceptChannel_write
21879 struct LDKCResult_AcceptChannelDecodeErrorZ AcceptChannel_read(struct LDKu8slice ser);
21882 * Serialize the AnnouncementSignatures object into a byte array which can be read by AnnouncementSignatures_read
21884 struct LDKCVec_u8Z AnnouncementSignatures_write(const struct LDKAnnouncementSignatures *NONNULL_PTR obj);
21887 * Read a AnnouncementSignatures from a byte array, created by AnnouncementSignatures_write
21889 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ AnnouncementSignatures_read(struct LDKu8slice ser);
21892 * Serialize the ChannelReestablish object into a byte array which can be read by ChannelReestablish_read
21894 struct LDKCVec_u8Z ChannelReestablish_write(const struct LDKChannelReestablish *NONNULL_PTR obj);
21897 * Read a ChannelReestablish from a byte array, created by ChannelReestablish_write
21899 struct LDKCResult_ChannelReestablishDecodeErrorZ ChannelReestablish_read(struct LDKu8slice ser);
21902 * Serialize the ClosingSigned object into a byte array which can be read by ClosingSigned_read
21904 struct LDKCVec_u8Z ClosingSigned_write(const struct LDKClosingSigned *NONNULL_PTR obj);
21907 * Read a ClosingSigned from a byte array, created by ClosingSigned_write
21909 struct LDKCResult_ClosingSignedDecodeErrorZ ClosingSigned_read(struct LDKu8slice ser);
21912 * Serialize the ClosingSignedFeeRange object into a byte array which can be read by ClosingSignedFeeRange_read
21914 struct LDKCVec_u8Z ClosingSignedFeeRange_write(const struct LDKClosingSignedFeeRange *NONNULL_PTR obj);
21917 * Read a ClosingSignedFeeRange from a byte array, created by ClosingSignedFeeRange_write
21919 struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ ClosingSignedFeeRange_read(struct LDKu8slice ser);
21922 * Serialize the CommitmentSigned object into a byte array which can be read by CommitmentSigned_read
21924 struct LDKCVec_u8Z CommitmentSigned_write(const struct LDKCommitmentSigned *NONNULL_PTR obj);
21927 * Read a CommitmentSigned from a byte array, created by CommitmentSigned_write
21929 struct LDKCResult_CommitmentSignedDecodeErrorZ CommitmentSigned_read(struct LDKu8slice ser);
21932 * Serialize the FundingCreated object into a byte array which can be read by FundingCreated_read
21934 struct LDKCVec_u8Z FundingCreated_write(const struct LDKFundingCreated *NONNULL_PTR obj);
21937 * Read a FundingCreated from a byte array, created by FundingCreated_write
21939 struct LDKCResult_FundingCreatedDecodeErrorZ FundingCreated_read(struct LDKu8slice ser);
21942 * Serialize the FundingSigned object into a byte array which can be read by FundingSigned_read
21944 struct LDKCVec_u8Z FundingSigned_write(const struct LDKFundingSigned *NONNULL_PTR obj);
21947 * Read a FundingSigned from a byte array, created by FundingSigned_write
21949 struct LDKCResult_FundingSignedDecodeErrorZ FundingSigned_read(struct LDKu8slice ser);
21952 * Serialize the FundingLocked object into a byte array which can be read by FundingLocked_read
21954 struct LDKCVec_u8Z FundingLocked_write(const struct LDKFundingLocked *NONNULL_PTR obj);
21957 * Read a FundingLocked from a byte array, created by FundingLocked_write
21959 struct LDKCResult_FundingLockedDecodeErrorZ FundingLocked_read(struct LDKu8slice ser);
21962 * Serialize the Init object into a byte array which can be read by Init_read
21964 struct LDKCVec_u8Z Init_write(const struct LDKInit *NONNULL_PTR obj);
21967 * Read a Init from a byte array, created by Init_write
21969 struct LDKCResult_InitDecodeErrorZ Init_read(struct LDKu8slice ser);
21972 * Serialize the OpenChannel object into a byte array which can be read by OpenChannel_read
21974 struct LDKCVec_u8Z OpenChannel_write(const struct LDKOpenChannel *NONNULL_PTR obj);
21977 * Read a OpenChannel from a byte array, created by OpenChannel_write
21979 struct LDKCResult_OpenChannelDecodeErrorZ OpenChannel_read(struct LDKu8slice ser);
21982 * Serialize the RevokeAndACK object into a byte array which can be read by RevokeAndACK_read
21984 struct LDKCVec_u8Z RevokeAndACK_write(const struct LDKRevokeAndACK *NONNULL_PTR obj);
21987 * Read a RevokeAndACK from a byte array, created by RevokeAndACK_write
21989 struct LDKCResult_RevokeAndACKDecodeErrorZ RevokeAndACK_read(struct LDKu8slice ser);
21992 * Serialize the Shutdown object into a byte array which can be read by Shutdown_read
21994 struct LDKCVec_u8Z Shutdown_write(const struct LDKShutdown *NONNULL_PTR obj);
21997 * Read a Shutdown from a byte array, created by Shutdown_write
21999 struct LDKCResult_ShutdownDecodeErrorZ Shutdown_read(struct LDKu8slice ser);
22002 * Serialize the UpdateFailHTLC object into a byte array which can be read by UpdateFailHTLC_read
22004 struct LDKCVec_u8Z UpdateFailHTLC_write(const struct LDKUpdateFailHTLC *NONNULL_PTR obj);
22007 * Read a UpdateFailHTLC from a byte array, created by UpdateFailHTLC_write
22009 struct LDKCResult_UpdateFailHTLCDecodeErrorZ UpdateFailHTLC_read(struct LDKu8slice ser);
22012 * Serialize the UpdateFailMalformedHTLC object into a byte array which can be read by UpdateFailMalformedHTLC_read
22014 struct LDKCVec_u8Z UpdateFailMalformedHTLC_write(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR obj);
22017 * Read a UpdateFailMalformedHTLC from a byte array, created by UpdateFailMalformedHTLC_write
22019 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ UpdateFailMalformedHTLC_read(struct LDKu8slice ser);
22022 * Serialize the UpdateFee object into a byte array which can be read by UpdateFee_read
22024 struct LDKCVec_u8Z UpdateFee_write(const struct LDKUpdateFee *NONNULL_PTR obj);
22027 * Read a UpdateFee from a byte array, created by UpdateFee_write
22029 struct LDKCResult_UpdateFeeDecodeErrorZ UpdateFee_read(struct LDKu8slice ser);
22032 * Serialize the UpdateFulfillHTLC object into a byte array which can be read by UpdateFulfillHTLC_read
22034 struct LDKCVec_u8Z UpdateFulfillHTLC_write(const struct LDKUpdateFulfillHTLC *NONNULL_PTR obj);
22037 * Read a UpdateFulfillHTLC from a byte array, created by UpdateFulfillHTLC_write
22039 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ UpdateFulfillHTLC_read(struct LDKu8slice ser);
22042 * Serialize the UpdateAddHTLC object into a byte array which can be read by UpdateAddHTLC_read
22044 struct LDKCVec_u8Z UpdateAddHTLC_write(const struct LDKUpdateAddHTLC *NONNULL_PTR obj);
22047 * Read a UpdateAddHTLC from a byte array, created by UpdateAddHTLC_write
22049 struct LDKCResult_UpdateAddHTLCDecodeErrorZ UpdateAddHTLC_read(struct LDKu8slice ser);
22052 * Serialize the Ping object into a byte array which can be read by Ping_read
22054 struct LDKCVec_u8Z Ping_write(const struct LDKPing *NONNULL_PTR obj);
22057 * Read a Ping from a byte array, created by Ping_write
22059 struct LDKCResult_PingDecodeErrorZ Ping_read(struct LDKu8slice ser);
22062 * Serialize the Pong object into a byte array which can be read by Pong_read
22064 struct LDKCVec_u8Z Pong_write(const struct LDKPong *NONNULL_PTR obj);
22067 * Read a Pong from a byte array, created by Pong_write
22069 struct LDKCResult_PongDecodeErrorZ Pong_read(struct LDKu8slice ser);
22072 * Serialize the UnsignedChannelAnnouncement object into a byte array which can be read by UnsignedChannelAnnouncement_read
22074 struct LDKCVec_u8Z UnsignedChannelAnnouncement_write(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR obj);
22077 * Read a UnsignedChannelAnnouncement from a byte array, created by UnsignedChannelAnnouncement_write
22079 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ UnsignedChannelAnnouncement_read(struct LDKu8slice ser);
22082 * Serialize the ChannelAnnouncement object into a byte array which can be read by ChannelAnnouncement_read
22084 struct LDKCVec_u8Z ChannelAnnouncement_write(const struct LDKChannelAnnouncement *NONNULL_PTR obj);
22087 * Read a ChannelAnnouncement from a byte array, created by ChannelAnnouncement_write
22089 struct LDKCResult_ChannelAnnouncementDecodeErrorZ ChannelAnnouncement_read(struct LDKu8slice ser);
22092 * Serialize the UnsignedChannelUpdate object into a byte array which can be read by UnsignedChannelUpdate_read
22094 struct LDKCVec_u8Z UnsignedChannelUpdate_write(const struct LDKUnsignedChannelUpdate *NONNULL_PTR obj);
22097 * Read a UnsignedChannelUpdate from a byte array, created by UnsignedChannelUpdate_write
22099 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ UnsignedChannelUpdate_read(struct LDKu8slice ser);
22102 * Serialize the ChannelUpdate object into a byte array which can be read by ChannelUpdate_read
22104 struct LDKCVec_u8Z ChannelUpdate_write(const struct LDKChannelUpdate *NONNULL_PTR obj);
22107 * Read a ChannelUpdate from a byte array, created by ChannelUpdate_write
22109 struct LDKCResult_ChannelUpdateDecodeErrorZ ChannelUpdate_read(struct LDKu8slice ser);
22112 * Serialize the ErrorMessage object into a byte array which can be read by ErrorMessage_read
22114 struct LDKCVec_u8Z ErrorMessage_write(const struct LDKErrorMessage *NONNULL_PTR obj);
22117 * Read a ErrorMessage from a byte array, created by ErrorMessage_write
22119 struct LDKCResult_ErrorMessageDecodeErrorZ ErrorMessage_read(struct LDKu8slice ser);
22122 * Serialize the WarningMessage object into a byte array which can be read by WarningMessage_read
22124 struct LDKCVec_u8Z WarningMessage_write(const struct LDKWarningMessage *NONNULL_PTR obj);
22127 * Read a WarningMessage from a byte array, created by WarningMessage_write
22129 struct LDKCResult_WarningMessageDecodeErrorZ WarningMessage_read(struct LDKu8slice ser);
22132 * Serialize the UnsignedNodeAnnouncement object into a byte array which can be read by UnsignedNodeAnnouncement_read
22134 struct LDKCVec_u8Z UnsignedNodeAnnouncement_write(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR obj);
22137 * Read a UnsignedNodeAnnouncement from a byte array, created by UnsignedNodeAnnouncement_write
22139 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ UnsignedNodeAnnouncement_read(struct LDKu8slice ser);
22142 * Serialize the NodeAnnouncement object into a byte array which can be read by NodeAnnouncement_read
22144 struct LDKCVec_u8Z NodeAnnouncement_write(const struct LDKNodeAnnouncement *NONNULL_PTR obj);
22147 * Read a NodeAnnouncement from a byte array, created by NodeAnnouncement_write
22149 struct LDKCResult_NodeAnnouncementDecodeErrorZ NodeAnnouncement_read(struct LDKu8slice ser);
22152 * Read a QueryShortChannelIds from a byte array, created by QueryShortChannelIds_write
22154 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ QueryShortChannelIds_read(struct LDKu8slice ser);
22157 * Serialize the QueryShortChannelIds object into a byte array which can be read by QueryShortChannelIds_read
22159 struct LDKCVec_u8Z QueryShortChannelIds_write(const struct LDKQueryShortChannelIds *NONNULL_PTR obj);
22162 * Serialize the ReplyShortChannelIdsEnd object into a byte array which can be read by ReplyShortChannelIdsEnd_read
22164 struct LDKCVec_u8Z ReplyShortChannelIdsEnd_write(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR obj);
22167 * Read a ReplyShortChannelIdsEnd from a byte array, created by ReplyShortChannelIdsEnd_write
22169 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ ReplyShortChannelIdsEnd_read(struct LDKu8slice ser);
22172 *\n\t * Calculates the overflow safe ending block height for the query.\n\t * Overflow returns `0xffffffff`, otherwise returns `first_blocknum + number_of_blocks`\n\t
22174 MUST_USE_RES uint32_t QueryChannelRange_end_blocknum(const struct LDKQueryChannelRange *NONNULL_PTR this_arg);
22177 * Serialize the QueryChannelRange object into a byte array which can be read by QueryChannelRange_read
22179 struct LDKCVec_u8Z QueryChannelRange_write(const struct LDKQueryChannelRange *NONNULL_PTR obj);
22182 * Read a QueryChannelRange from a byte array, created by QueryChannelRange_write
22184 struct LDKCResult_QueryChannelRangeDecodeErrorZ QueryChannelRange_read(struct LDKu8slice ser);
22187 * Read a ReplyChannelRange from a byte array, created by ReplyChannelRange_write
22189 struct LDKCResult_ReplyChannelRangeDecodeErrorZ ReplyChannelRange_read(struct LDKu8slice ser);
22192 * Serialize the ReplyChannelRange object into a byte array which can be read by ReplyChannelRange_read
22194 struct LDKCVec_u8Z ReplyChannelRange_write(const struct LDKReplyChannelRange *NONNULL_PTR obj);
22197 * Serialize the GossipTimestampFilter object into a byte array which can be read by GossipTimestampFilter_read
22199 struct LDKCVec_u8Z GossipTimestampFilter_write(const struct LDKGossipTimestampFilter *NONNULL_PTR obj);
22202 * Read a GossipTimestampFilter from a byte array, created by GossipTimestampFilter_write
22204 struct LDKCResult_GossipTimestampFilterDecodeErrorZ GossipTimestampFilter_read(struct LDKu8slice ser);
22207 * Calls the free function if one is set
22209 void CustomMessageHandler_free(struct LDKCustomMessageHandler this_ptr);
22212 * Frees any resources used by the IgnoringMessageHandler, if is_owned is set and inner is non-NULL.
22214 void IgnoringMessageHandler_free(struct LDKIgnoringMessageHandler this_obj);
22217 * Constructs a new IgnoringMessageHandler given each field
22219 MUST_USE_RES struct LDKIgnoringMessageHandler IgnoringMessageHandler_new(void);
22222 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
22223 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
22225 struct LDKMessageSendEventsProvider IgnoringMessageHandler_as_MessageSendEventsProvider(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
22228 * Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg.
22229 * This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is
22231 struct LDKRoutingMessageHandler IgnoringMessageHandler_as_RoutingMessageHandler(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
22234 * Constructs a new CustomMessageReader which calls the relevant methods on this_arg.
22235 * This copies the `inner` pointer in this_arg and thus the returned CustomMessageReader must be freed before this_arg is
22237 struct LDKCustomMessageReader IgnoringMessageHandler_as_CustomMessageReader(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
22240 * Constructs a new CustomMessageHandler which calls the relevant methods on this_arg.
22241 * This copies the `inner` pointer in this_arg and thus the returned CustomMessageHandler must be freed before this_arg is
22243 struct LDKCustomMessageHandler IgnoringMessageHandler_as_CustomMessageHandler(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
22246 * Frees any resources used by the ErroringMessageHandler, if is_owned is set and inner is non-NULL.
22248 void ErroringMessageHandler_free(struct LDKErroringMessageHandler this_obj);
22251 * Constructs a new ErroringMessageHandler
22253 MUST_USE_RES struct LDKErroringMessageHandler ErroringMessageHandler_new(void);
22256 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
22257 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
22259 struct LDKMessageSendEventsProvider ErroringMessageHandler_as_MessageSendEventsProvider(const struct LDKErroringMessageHandler *NONNULL_PTR this_arg);
22262 * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
22263 * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
22265 struct LDKChannelMessageHandler ErroringMessageHandler_as_ChannelMessageHandler(const struct LDKErroringMessageHandler *NONNULL_PTR this_arg);
22268 * Frees any resources used by the MessageHandler, if is_owned is set and inner is non-NULL.
22270 void MessageHandler_free(struct LDKMessageHandler this_obj);
22273 * A message handler which handles messages specific to channels. Usually this is just a
22274 * [`ChannelManager`] object or an [`ErroringMessageHandler`].
22276 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
22278 const struct LDKChannelMessageHandler *MessageHandler_get_chan_handler(const struct LDKMessageHandler *NONNULL_PTR this_ptr);
22281 * A message handler which handles messages specific to channels. Usually this is just a
22282 * [`ChannelManager`] object or an [`ErroringMessageHandler`].
22284 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
22286 void MessageHandler_set_chan_handler(struct LDKMessageHandler *NONNULL_PTR this_ptr, struct LDKChannelMessageHandler val);
22289 * A message handler which handles messages updating our knowledge of the network channel
22290 * graph. Usually this is just a [`NetGraphMsgHandler`] object or an
22291 * [`IgnoringMessageHandler`].
22293 * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
22295 const struct LDKRoutingMessageHandler *MessageHandler_get_route_handler(const struct LDKMessageHandler *NONNULL_PTR this_ptr);
22298 * A message handler which handles messages updating our knowledge of the network channel
22299 * graph. Usually this is just a [`NetGraphMsgHandler`] object or an
22300 * [`IgnoringMessageHandler`].
22302 * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
22304 void MessageHandler_set_route_handler(struct LDKMessageHandler *NONNULL_PTR this_ptr, struct LDKRoutingMessageHandler val);
22307 * Constructs a new MessageHandler given each field
22309 MUST_USE_RES struct LDKMessageHandler MessageHandler_new(struct LDKChannelMessageHandler chan_handler_arg, struct LDKRoutingMessageHandler route_handler_arg);
22312 * Creates a copy of a SocketDescriptor
22314 struct LDKSocketDescriptor SocketDescriptor_clone(const struct LDKSocketDescriptor *NONNULL_PTR orig);
22317 * Calls the free function if one is set
22319 void SocketDescriptor_free(struct LDKSocketDescriptor this_ptr);
22322 * Frees any resources used by the PeerHandleError, if is_owned is set and inner is non-NULL.
22324 void PeerHandleError_free(struct LDKPeerHandleError this_obj);
22327 * Used to indicate that we probably can't make any future connections to this peer, implying
22328 * we should go ahead and force-close any channels we have with it.
22330 bool PeerHandleError_get_no_connection_possible(const struct LDKPeerHandleError *NONNULL_PTR this_ptr);
22333 * Used to indicate that we probably can't make any future connections to this peer, implying
22334 * we should go ahead and force-close any channels we have with it.
22336 void PeerHandleError_set_no_connection_possible(struct LDKPeerHandleError *NONNULL_PTR this_ptr, bool val);
22339 * Constructs a new PeerHandleError given each field
22341 MUST_USE_RES struct LDKPeerHandleError PeerHandleError_new(bool no_connection_possible_arg);
22344 * Creates a copy of the PeerHandleError
22346 struct LDKPeerHandleError PeerHandleError_clone(const struct LDKPeerHandleError *NONNULL_PTR orig);
22349 * Frees any resources used by the PeerManager, if is_owned is set and inner is non-NULL.
22351 void PeerManager_free(struct LDKPeerManager this_obj);
22354 * Constructs a new PeerManager with the given message handlers and node_id secret key
22355 * ephemeral_random_data is used to derive per-connection ephemeral keys and must be
22356 * cryptographically secure random bytes.
22358 MUST_USE_RES struct LDKPeerManager PeerManager_new(struct LDKMessageHandler message_handler, struct LDKSecretKey our_node_secret, const uint8_t (*ephemeral_random_data)[32], struct LDKLogger logger, struct LDKCustomMessageHandler custom_message_handler);
22361 * Get the list of node ids for peers which have completed the initial handshake.
22363 * For outbound connections, this will be the same as the their_node_id parameter passed in to
22364 * new_outbound_connection, however entries will only appear once the initial handshake has
22365 * completed and we are sure the remote peer has the private key for the given node_id.
22367 MUST_USE_RES struct LDKCVec_PublicKeyZ PeerManager_get_peer_node_ids(const struct LDKPeerManager *NONNULL_PTR this_arg);
22370 * Indicates a new outbound connection has been established to a node with the given node_id.
22371 * Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
22372 * descriptor but must disconnect the connection immediately.
22374 * Returns a small number of bytes to send to the remote node (currently always 50).
22376 * Panics if descriptor is duplicative with some other descriptor which has not yet been
22377 * [`socket_disconnected()`].
22379 * [`socket_disconnected()`]: PeerManager::socket_disconnected
22381 MUST_USE_RES struct LDKCResult_CVec_u8ZPeerHandleErrorZ PeerManager_new_outbound_connection(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKPublicKey their_node_id, struct LDKSocketDescriptor descriptor);
22384 * Indicates a new inbound connection has been established.
22386 * May refuse the connection by returning an Err, but will never write bytes to the remote end
22387 * (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
22388 * call socket_disconnected for the new descriptor but must disconnect the connection
22391 * Panics if descriptor is duplicative with some other descriptor which has not yet been
22392 * [`socket_disconnected()`].
22394 * [`socket_disconnected()`]: PeerManager::socket_disconnected
22396 MUST_USE_RES struct LDKCResult_NonePeerHandleErrorZ PeerManager_new_inbound_connection(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKSocketDescriptor descriptor);
22399 * Indicates that there is room to write data to the given socket descriptor.
22401 * May return an Err to indicate that the connection should be closed.
22403 * May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
22404 * returning. Thus, be very careful with reentrancy issues! The invariants around calling
22405 * [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
22406 * ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
22409 * [`send_data`]: SocketDescriptor::send_data
22410 * [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
22412 MUST_USE_RES struct LDKCResult_NonePeerHandleErrorZ PeerManager_write_buffer_space_avail(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKSocketDescriptor *NONNULL_PTR descriptor);
22415 * Indicates that data was read from the given socket descriptor.
22417 * May return an Err to indicate that the connection should be closed.
22419 * Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
22420 * Thus, however, you should call [`process_events`] after any `read_event` to generate
22421 * [`send_data`] calls to handle responses.
22423 * If `Ok(true)` is returned, further read_events should not be triggered until a
22424 * [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
22427 * [`send_data`]: SocketDescriptor::send_data
22428 * [`process_events`]: PeerManager::process_events
22430 MUST_USE_RES struct LDKCResult_boolPeerHandleErrorZ PeerManager_read_event(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKSocketDescriptor *NONNULL_PTR peer_descriptor, struct LDKu8slice data);
22433 * Checks for any events generated by our handlers and processes them. Includes sending most
22434 * response messages as well as messages generated by calls to handler functions directly (eg
22435 * functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
22437 * May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
22440 * You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
22441 * or one of the other clients provided in our language bindings.
22443 * [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
22444 * [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
22445 * [`send_data`]: SocketDescriptor::send_data
22447 void PeerManager_process_events(const struct LDKPeerManager *NONNULL_PTR this_arg);
22450 * Indicates that the given socket descriptor's connection is now closed.
22452 void PeerManager_socket_disconnected(const struct LDKPeerManager *NONNULL_PTR this_arg, const struct LDKSocketDescriptor *NONNULL_PTR descriptor);
22455 * Disconnect a peer given its node id.
22457 * Set `no_connection_possible` to true to prevent any further connection with this peer,
22458 * force-closing any channels we have with it.
22460 * If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
22461 * peer. Thus, be very careful about reentrancy issues.
22463 * [`disconnect_socket`]: SocketDescriptor::disconnect_socket
22465 void PeerManager_disconnect_by_node_id(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKPublicKey node_id, bool no_connection_possible);
22468 * Disconnects all currently-connected peers. This is useful on platforms where there may be
22469 * an indication that TCP sockets have stalled even if we weren't around to time them out
22470 * using regular ping/pongs.
22472 void PeerManager_disconnect_all_peers(const struct LDKPeerManager *NONNULL_PTR this_arg);
22475 * Send pings to each peer and disconnect those which did not respond to the last round of
22478 * This may be called on any timescale you want, however, roughly once every five to ten
22479 * seconds is preferred. The call rate determines both how often we send a ping to our peers
22480 * and how much time they have to respond before we disconnect them.
22482 * May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
22485 * [`send_data`]: SocketDescriptor::send_data
22487 void PeerManager_timer_tick_occurred(const struct LDKPeerManager *NONNULL_PTR this_arg);
22490 * Gets the weight for an HTLC-Success transaction.
22492 uint64_t htlc_success_tx_weight(bool opt_anchors);
22495 * Gets the weight for an HTLC-Timeout transaction.
22497 uint64_t htlc_timeout_tx_weight(bool opt_anchors);
22500 * Build the commitment secret from the seed and the commitment number
22502 struct LDKThirtyTwoBytes build_commitment_secret(const uint8_t (*commitment_seed)[32], uint64_t idx);
22505 * Build a closing transaction
22507 struct LDKTransaction build_closing_transaction(uint64_t to_holder_value_sat, uint64_t to_counterparty_value_sat, struct LDKCVec_u8Z to_holder_script, struct LDKCVec_u8Z to_counterparty_script, struct LDKOutPoint funding_outpoint);
22510 * Frees any resources used by the CounterpartyCommitmentSecrets, if is_owned is set and inner is non-NULL.
22512 void CounterpartyCommitmentSecrets_free(struct LDKCounterpartyCommitmentSecrets this_obj);
22515 * Creates a copy of the CounterpartyCommitmentSecrets
22517 struct LDKCounterpartyCommitmentSecrets CounterpartyCommitmentSecrets_clone(const struct LDKCounterpartyCommitmentSecrets *NONNULL_PTR orig);
22520 * Creates a new empty `CounterpartyCommitmentSecrets` structure.
22522 MUST_USE_RES struct LDKCounterpartyCommitmentSecrets CounterpartyCommitmentSecrets_new(void);
22525 * Returns the minimum index of all stored secrets. Note that indexes start
22526 * at 1 << 48 and get decremented by one for each new secret.
22528 MUST_USE_RES uint64_t CounterpartyCommitmentSecrets_get_min_seen_secret(const struct LDKCounterpartyCommitmentSecrets *NONNULL_PTR this_arg);
22531 * Inserts the `secret` at `idx`. Returns `Ok(())` if the secret
22532 * was generated in accordance with BOLT 3 and is consistent with previous secrets.
22534 MUST_USE_RES struct LDKCResult_NoneNoneZ CounterpartyCommitmentSecrets_provide_secret(struct LDKCounterpartyCommitmentSecrets *NONNULL_PTR this_arg, uint64_t idx, struct LDKThirtyTwoBytes secret);
22537 * Returns the secret at `idx`.
22538 * Returns `None` if `idx` is < [`CounterpartyCommitmentSecrets::get_min_seen_secret`].
22540 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
22542 MUST_USE_RES struct LDKThirtyTwoBytes CounterpartyCommitmentSecrets_get_secret(const struct LDKCounterpartyCommitmentSecrets *NONNULL_PTR this_arg, uint64_t idx);
22545 * Serialize the CounterpartyCommitmentSecrets object into a byte array which can be read by CounterpartyCommitmentSecrets_read
22547 struct LDKCVec_u8Z CounterpartyCommitmentSecrets_write(const struct LDKCounterpartyCommitmentSecrets *NONNULL_PTR obj);
22550 * Read a CounterpartyCommitmentSecrets from a byte array, created by CounterpartyCommitmentSecrets_write
22552 struct LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZ CounterpartyCommitmentSecrets_read(struct LDKu8slice ser);
22555 * Derives a per-commitment-transaction private key (eg an htlc key or delayed_payment key)
22556 * from the base secret and the per_commitment_point.
22558 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
22559 * generated (ie our own).
22561 struct LDKCResult_SecretKeyErrorZ derive_private_key(struct LDKPublicKey per_commitment_point, const uint8_t (*base_secret)[32]);
22564 * Derives a per-commitment-transaction public key (eg an htlc key or a delayed_payment key)
22565 * from the base point and the per_commitment_key. This is the public equivalent of
22566 * derive_private_key - using only public keys to derive a public key instead of private keys.
22568 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
22569 * generated (ie our own).
22571 struct LDKCResult_PublicKeyErrorZ derive_public_key(struct LDKPublicKey per_commitment_point, struct LDKPublicKey base_point);
22574 * Derives a per-commitment-transaction revocation key from its constituent parts.
22576 * Only the cheating participant owns a valid witness to propagate a revoked
22577 * commitment transaction, thus per_commitment_secret always come from cheater
22578 * and revocation_base_secret always come from punisher, which is the broadcaster
22579 * of the transaction spending with this key knowledge.
22581 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
22582 * generated (ie our own).
22584 struct LDKCResult_SecretKeyErrorZ derive_private_revocation_key(const uint8_t (*per_commitment_secret)[32], const uint8_t (*countersignatory_revocation_base_secret)[32]);
22587 * Derives a per-commitment-transaction revocation public key from its constituent parts. This is
22588 * the public equivalend of derive_private_revocation_key - using only public keys to derive a
22589 * public key instead of private keys.
22591 * Only the cheating participant owns a valid witness to propagate a revoked
22592 * commitment transaction, thus per_commitment_point always come from cheater
22593 * and revocation_base_point always come from punisher, which is the broadcaster
22594 * of the transaction spending with this key knowledge.
22596 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
22597 * generated (ie our own).
22599 struct LDKCResult_PublicKeyErrorZ derive_public_revocation_key(struct LDKPublicKey per_commitment_point, struct LDKPublicKey countersignatory_revocation_base_point);
22602 * Frees any resources used by the TxCreationKeys, if is_owned is set and inner is non-NULL.
22604 void TxCreationKeys_free(struct LDKTxCreationKeys this_obj);
22607 * The broadcaster's per-commitment public key which was used to derive the other keys.
22609 struct LDKPublicKey TxCreationKeys_get_per_commitment_point(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
22612 * The broadcaster's per-commitment public key which was used to derive the other keys.
22614 void TxCreationKeys_set_per_commitment_point(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
22617 * The revocation key which is used to allow the broadcaster of the commitment
22618 * transaction to provide their counterparty the ability to punish them if they broadcast
22621 struct LDKPublicKey TxCreationKeys_get_revocation_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
22624 * The revocation key which is used to allow the broadcaster of the commitment
22625 * transaction to provide their counterparty the ability to punish them if they broadcast
22628 void TxCreationKeys_set_revocation_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
22631 * Broadcaster's HTLC Key
22633 struct LDKPublicKey TxCreationKeys_get_broadcaster_htlc_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
22636 * Broadcaster's HTLC Key
22638 void TxCreationKeys_set_broadcaster_htlc_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
22641 * Countersignatory's HTLC Key
22643 struct LDKPublicKey TxCreationKeys_get_countersignatory_htlc_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
22646 * Countersignatory's HTLC Key
22648 void TxCreationKeys_set_countersignatory_htlc_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
22651 * Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
22653 struct LDKPublicKey TxCreationKeys_get_broadcaster_delayed_payment_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
22656 * Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
22658 void TxCreationKeys_set_broadcaster_delayed_payment_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
22661 * Constructs a new TxCreationKeys given each field
22663 MUST_USE_RES struct LDKTxCreationKeys TxCreationKeys_new(struct LDKPublicKey per_commitment_point_arg, struct LDKPublicKey revocation_key_arg, struct LDKPublicKey broadcaster_htlc_key_arg, struct LDKPublicKey countersignatory_htlc_key_arg, struct LDKPublicKey broadcaster_delayed_payment_key_arg);
22666 * Creates a copy of the TxCreationKeys
22668 struct LDKTxCreationKeys TxCreationKeys_clone(const struct LDKTxCreationKeys *NONNULL_PTR orig);
22671 * Serialize the TxCreationKeys object into a byte array which can be read by TxCreationKeys_read
22673 struct LDKCVec_u8Z TxCreationKeys_write(const struct LDKTxCreationKeys *NONNULL_PTR obj);
22676 * Read a TxCreationKeys from a byte array, created by TxCreationKeys_write
22678 struct LDKCResult_TxCreationKeysDecodeErrorZ TxCreationKeys_read(struct LDKu8slice ser);
22681 * Frees any resources used by the ChannelPublicKeys, if is_owned is set and inner is non-NULL.
22683 void ChannelPublicKeys_free(struct LDKChannelPublicKeys this_obj);
22686 * The public key which is used to sign all commitment transactions, as it appears in the
22687 * on-chain channel lock-in 2-of-2 multisig output.
22689 struct LDKPublicKey ChannelPublicKeys_get_funding_pubkey(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
22692 * The public key which is used to sign all commitment transactions, as it appears in the
22693 * on-chain channel lock-in 2-of-2 multisig output.
22695 void ChannelPublicKeys_set_funding_pubkey(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
22698 * The base point which is used (with derive_public_revocation_key) to derive per-commitment
22699 * revocation keys. This is combined with the per-commitment-secret generated by the
22700 * counterparty to create a secret which the counterparty can reveal to revoke previous
22703 struct LDKPublicKey ChannelPublicKeys_get_revocation_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
22706 * The base point which is used (with derive_public_revocation_key) to derive per-commitment
22707 * revocation keys. This is combined with the per-commitment-secret generated by the
22708 * counterparty to create a secret which the counterparty can reveal to revoke previous
22711 void ChannelPublicKeys_set_revocation_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
22714 * The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
22715 * spendable primary channel balance on the broadcaster's commitment transaction. This key is
22716 * static across every commitment transaction.
22718 struct LDKPublicKey ChannelPublicKeys_get_payment_point(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
22721 * The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
22722 * spendable primary channel balance on the broadcaster's commitment transaction. This key is
22723 * static across every commitment transaction.
22725 void ChannelPublicKeys_set_payment_point(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
22728 * The base point which is used (with derive_public_key) to derive a per-commitment payment
22729 * public key which receives non-HTLC-encumbered funds which are only available for spending
22730 * after some delay (or can be claimed via the revocation path).
22732 struct LDKPublicKey ChannelPublicKeys_get_delayed_payment_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
22735 * The base point which is used (with derive_public_key) to derive a per-commitment payment
22736 * public key which receives non-HTLC-encumbered funds which are only available for spending
22737 * after some delay (or can be claimed via the revocation path).
22739 void ChannelPublicKeys_set_delayed_payment_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
22742 * The base point which is used (with derive_public_key) to derive a per-commitment public key
22743 * which is used to encumber HTLC-in-flight outputs.
22745 struct LDKPublicKey ChannelPublicKeys_get_htlc_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
22748 * The base point which is used (with derive_public_key) to derive a per-commitment public key
22749 * which is used to encumber HTLC-in-flight outputs.
22751 void ChannelPublicKeys_set_htlc_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
22754 * Constructs a new ChannelPublicKeys given each field
22756 MUST_USE_RES struct LDKChannelPublicKeys ChannelPublicKeys_new(struct LDKPublicKey funding_pubkey_arg, struct LDKPublicKey revocation_basepoint_arg, struct LDKPublicKey payment_point_arg, struct LDKPublicKey delayed_payment_basepoint_arg, struct LDKPublicKey htlc_basepoint_arg);
22759 * Creates a copy of the ChannelPublicKeys
22761 struct LDKChannelPublicKeys ChannelPublicKeys_clone(const struct LDKChannelPublicKeys *NONNULL_PTR orig);
22764 * Serialize the ChannelPublicKeys object into a byte array which can be read by ChannelPublicKeys_read
22766 struct LDKCVec_u8Z ChannelPublicKeys_write(const struct LDKChannelPublicKeys *NONNULL_PTR obj);
22769 * Read a ChannelPublicKeys from a byte array, created by ChannelPublicKeys_write
22771 struct LDKCResult_ChannelPublicKeysDecodeErrorZ ChannelPublicKeys_read(struct LDKu8slice ser);
22774 * Create per-state keys from channel base points and the per-commitment point.
22775 * Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
22777 MUST_USE_RES struct LDKCResult_TxCreationKeysErrorZ TxCreationKeys_derive_new(struct LDKPublicKey per_commitment_point, struct LDKPublicKey broadcaster_delayed_payment_base, struct LDKPublicKey broadcaster_htlc_base, struct LDKPublicKey countersignatory_revocation_base, struct LDKPublicKey countersignatory_htlc_base);
22780 * Generate per-state keys from channel static keys.
22781 * Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
22783 MUST_USE_RES struct LDKCResult_TxCreationKeysErrorZ TxCreationKeys_from_channel_static_keys(struct LDKPublicKey per_commitment_point, const struct LDKChannelPublicKeys *NONNULL_PTR broadcaster_keys, const struct LDKChannelPublicKeys *NONNULL_PTR countersignatory_keys);
22786 * A script either spendable by the revocation
22787 * key or the broadcaster_delayed_payment_key and satisfying the relative-locktime OP_CSV constrain.
22788 * Encumbering a `to_holder` output on a commitment transaction or 2nd-stage HTLC transactions.
22790 struct LDKCVec_u8Z get_revokeable_redeemscript(struct LDKPublicKey revocation_key, uint16_t contest_delay, struct LDKPublicKey broadcaster_delayed_payment_key);
22793 * Frees any resources used by the HTLCOutputInCommitment, if is_owned is set and inner is non-NULL.
22795 void HTLCOutputInCommitment_free(struct LDKHTLCOutputInCommitment this_obj);
22798 * Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
22799 * Note that this is not the same as whether it is ountbound *from us*. To determine that you
22800 * need to compare this value to whether the commitment transaction in question is that of
22801 * the counterparty or our own.
22803 bool HTLCOutputInCommitment_get_offered(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
22806 * Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
22807 * Note that this is not the same as whether it is ountbound *from us*. To determine that you
22808 * need to compare this value to whether the commitment transaction in question is that of
22809 * the counterparty or our own.
22811 void HTLCOutputInCommitment_set_offered(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, bool val);
22814 * The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
22815 * this divided by 1000.
22817 uint64_t HTLCOutputInCommitment_get_amount_msat(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
22820 * The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
22821 * this divided by 1000.
22823 void HTLCOutputInCommitment_set_amount_msat(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, uint64_t val);
22826 * The CLTV lock-time at which this HTLC expires.
22828 uint32_t HTLCOutputInCommitment_get_cltv_expiry(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
22831 * The CLTV lock-time at which this HTLC expires.
22833 void HTLCOutputInCommitment_set_cltv_expiry(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, uint32_t val);
22836 * The hash of the preimage which unlocks this HTLC.
22838 const uint8_t (*HTLCOutputInCommitment_get_payment_hash(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr))[32];
22841 * The hash of the preimage which unlocks this HTLC.
22843 void HTLCOutputInCommitment_set_payment_hash(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
22846 * The position within the commitment transactions' outputs. This may be None if the value is
22847 * below the dust limit (in which case no output appears in the commitment transaction and the
22848 * value is spent to additional transaction fees).
22850 struct LDKCOption_u32Z HTLCOutputInCommitment_get_transaction_output_index(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
22853 * The position within the commitment transactions' outputs. This may be None if the value is
22854 * below the dust limit (in which case no output appears in the commitment transaction and the
22855 * value is spent to additional transaction fees).
22857 void HTLCOutputInCommitment_set_transaction_output_index(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, struct LDKCOption_u32Z val);
22860 * Constructs a new HTLCOutputInCommitment given each field
22862 MUST_USE_RES struct LDKHTLCOutputInCommitment HTLCOutputInCommitment_new(bool offered_arg, uint64_t amount_msat_arg, uint32_t cltv_expiry_arg, struct LDKThirtyTwoBytes payment_hash_arg, struct LDKCOption_u32Z transaction_output_index_arg);
22865 * Creates a copy of the HTLCOutputInCommitment
22867 struct LDKHTLCOutputInCommitment HTLCOutputInCommitment_clone(const struct LDKHTLCOutputInCommitment *NONNULL_PTR orig);
22870 * Serialize the HTLCOutputInCommitment object into a byte array which can be read by HTLCOutputInCommitment_read
22872 struct LDKCVec_u8Z HTLCOutputInCommitment_write(const struct LDKHTLCOutputInCommitment *NONNULL_PTR obj);
22875 * Read a HTLCOutputInCommitment from a byte array, created by HTLCOutputInCommitment_write
22877 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ HTLCOutputInCommitment_read(struct LDKu8slice ser);
22880 * Gets the witness redeemscript for an HTLC output in a commitment transaction. Note that htlc
22881 * does not need to have its previous_output_index filled.
22883 struct LDKCVec_u8Z get_htlc_redeemscript(const struct LDKHTLCOutputInCommitment *NONNULL_PTR htlc, bool opt_anchors, const struct LDKTxCreationKeys *NONNULL_PTR keys);
22886 * Gets the redeemscript for a funding output from the two funding public keys.
22887 * Note that the order of funding public keys does not matter.
22889 struct LDKCVec_u8Z make_funding_redeemscript(struct LDKPublicKey broadcaster, struct LDKPublicKey countersignatory);
22892 * Builds an unsigned HTLC-Success or HTLC-Timeout transaction from the given channel and HTLC
22893 * parameters. This is used by [`TrustedCommitmentTransaction::get_htlc_sigs`] to fetch the
22894 * transaction which needs signing, and can be used to construct an HTLC transaction which is
22895 * broadcastable given a counterparty HTLC signature.
22897 * Panics if htlc.transaction_output_index.is_none() (as such HTLCs do not appear in the
22898 * commitment transaction).
22900 struct LDKTransaction build_htlc_transaction(const uint8_t (*commitment_txid)[32], uint32_t feerate_per_kw, uint16_t contest_delay, const struct LDKHTLCOutputInCommitment *NONNULL_PTR htlc, bool opt_anchors, struct LDKPublicKey broadcaster_delayed_payment_key, struct LDKPublicKey revocation_key);
22903 * Gets the witnessScript for an anchor output from the funding public key.
22904 * The witness in the spending input must be:
22905 * <BIP 143 funding_signature>
22906 * After 16 blocks of confirmation, an alternative satisfying witness could be:
22908 * (empty vector required to satisfy compliance with MINIMALIF-standard rule)
22910 struct LDKCVec_u8Z get_anchor_redeemscript(struct LDKPublicKey funding_pubkey);
22913 * Frees any resources used by the ChannelTransactionParameters, if is_owned is set and inner is non-NULL.
22915 void ChannelTransactionParameters_free(struct LDKChannelTransactionParameters this_obj);
22918 * Holder public keys
22920 struct LDKChannelPublicKeys ChannelTransactionParameters_get_holder_pubkeys(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
22923 * Holder public keys
22925 void ChannelTransactionParameters_set_holder_pubkeys(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKChannelPublicKeys val);
22928 * The contest delay selected by the holder, which applies to counterparty-broadcast transactions
22930 uint16_t ChannelTransactionParameters_get_holder_selected_contest_delay(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
22933 * The contest delay selected by the holder, which applies to counterparty-broadcast transactions
22935 void ChannelTransactionParameters_set_holder_selected_contest_delay(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, uint16_t val);
22938 * Whether the holder is the initiator of this channel.
22939 * This is an input to the commitment number obscure factor computation.
22941 bool ChannelTransactionParameters_get_is_outbound_from_holder(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
22944 * Whether the holder is the initiator of this channel.
22945 * This is an input to the commitment number obscure factor computation.
22947 void ChannelTransactionParameters_set_is_outbound_from_holder(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, bool val);
22950 * The late-bound counterparty channel transaction parameters.
22951 * These parameters are populated at the point in the protocol where the counterparty provides them.
22953 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
22955 struct LDKCounterpartyChannelTransactionParameters ChannelTransactionParameters_get_counterparty_parameters(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
22958 * The late-bound counterparty channel transaction parameters.
22959 * These parameters are populated at the point in the protocol where the counterparty provides them.
22961 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
22963 void ChannelTransactionParameters_set_counterparty_parameters(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKCounterpartyChannelTransactionParameters val);
22966 * The late-bound funding outpoint
22968 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
22970 struct LDKOutPoint ChannelTransactionParameters_get_funding_outpoint(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
22973 * The late-bound funding outpoint
22975 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
22977 void ChannelTransactionParameters_set_funding_outpoint(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKOutPoint val);
22980 * Are anchors used for this channel. Boolean is serialization backwards-compatible
22982 enum LDKCOption_NoneZ ChannelTransactionParameters_get_opt_anchors(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
22985 * Are anchors used for this channel. Boolean is serialization backwards-compatible
22987 void ChannelTransactionParameters_set_opt_anchors(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, enum LDKCOption_NoneZ val);
22990 * Constructs a new ChannelTransactionParameters given each field
22992 MUST_USE_RES struct LDKChannelTransactionParameters ChannelTransactionParameters_new(struct LDKChannelPublicKeys holder_pubkeys_arg, uint16_t holder_selected_contest_delay_arg, bool is_outbound_from_holder_arg, struct LDKCounterpartyChannelTransactionParameters counterparty_parameters_arg, struct LDKOutPoint funding_outpoint_arg, enum LDKCOption_NoneZ opt_anchors_arg);
22995 * Creates a copy of the ChannelTransactionParameters
22997 struct LDKChannelTransactionParameters ChannelTransactionParameters_clone(const struct LDKChannelTransactionParameters *NONNULL_PTR orig);
23000 * Frees any resources used by the CounterpartyChannelTransactionParameters, if is_owned is set and inner is non-NULL.
23002 void CounterpartyChannelTransactionParameters_free(struct LDKCounterpartyChannelTransactionParameters this_obj);
23005 * Counter-party public keys
23007 struct LDKChannelPublicKeys CounterpartyChannelTransactionParameters_get_pubkeys(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr);
23010 * Counter-party public keys
23012 void CounterpartyChannelTransactionParameters_set_pubkeys(struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKChannelPublicKeys val);
23015 * The contest delay selected by the counterparty, which applies to holder-broadcast transactions
23017 uint16_t CounterpartyChannelTransactionParameters_get_selected_contest_delay(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr);
23020 * The contest delay selected by the counterparty, which applies to holder-broadcast transactions
23022 void CounterpartyChannelTransactionParameters_set_selected_contest_delay(struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr, uint16_t val);
23025 * Constructs a new CounterpartyChannelTransactionParameters given each field
23027 MUST_USE_RES struct LDKCounterpartyChannelTransactionParameters CounterpartyChannelTransactionParameters_new(struct LDKChannelPublicKeys pubkeys_arg, uint16_t selected_contest_delay_arg);
23030 * Creates a copy of the CounterpartyChannelTransactionParameters
23032 struct LDKCounterpartyChannelTransactionParameters CounterpartyChannelTransactionParameters_clone(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR orig);
23035 * Whether the late bound parameters are populated.
23037 MUST_USE_RES bool ChannelTransactionParameters_is_populated(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
23040 * Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
23041 * given that the holder is the broadcaster.
23043 * self.is_populated() must be true before calling this function.
23045 MUST_USE_RES struct LDKDirectedChannelTransactionParameters ChannelTransactionParameters_as_holder_broadcastable(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
23048 * Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
23049 * given that the counterparty is the broadcaster.
23051 * self.is_populated() must be true before calling this function.
23053 MUST_USE_RES struct LDKDirectedChannelTransactionParameters ChannelTransactionParameters_as_counterparty_broadcastable(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
23056 * Serialize the CounterpartyChannelTransactionParameters object into a byte array which can be read by CounterpartyChannelTransactionParameters_read
23058 struct LDKCVec_u8Z CounterpartyChannelTransactionParameters_write(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR obj);
23061 * Read a CounterpartyChannelTransactionParameters from a byte array, created by CounterpartyChannelTransactionParameters_write
23063 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CounterpartyChannelTransactionParameters_read(struct LDKu8slice ser);
23066 * Serialize the ChannelTransactionParameters object into a byte array which can be read by ChannelTransactionParameters_read
23068 struct LDKCVec_u8Z ChannelTransactionParameters_write(const struct LDKChannelTransactionParameters *NONNULL_PTR obj);
23071 * Read a ChannelTransactionParameters from a byte array, created by ChannelTransactionParameters_write
23073 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ ChannelTransactionParameters_read(struct LDKu8slice ser);
23076 * Frees any resources used by the DirectedChannelTransactionParameters, if is_owned is set and inner is non-NULL.
23078 void DirectedChannelTransactionParameters_free(struct LDKDirectedChannelTransactionParameters this_obj);
23081 * Get the channel pubkeys for the broadcaster
23083 MUST_USE_RES struct LDKChannelPublicKeys DirectedChannelTransactionParameters_broadcaster_pubkeys(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
23086 * Get the channel pubkeys for the countersignatory
23088 MUST_USE_RES struct LDKChannelPublicKeys DirectedChannelTransactionParameters_countersignatory_pubkeys(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
23091 * Get the contest delay applicable to the transactions.
23092 * Note that the contest delay was selected by the countersignatory.
23094 MUST_USE_RES uint16_t DirectedChannelTransactionParameters_contest_delay(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
23097 * Whether the channel is outbound from the broadcaster.
23099 * The boolean representing the side that initiated the channel is
23100 * an input to the commitment number obscure factor computation.
23102 MUST_USE_RES bool DirectedChannelTransactionParameters_is_outbound(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
23105 * The funding outpoint
23107 MUST_USE_RES struct LDKOutPoint DirectedChannelTransactionParameters_funding_outpoint(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
23110 * Whether to use anchors for this channel
23112 MUST_USE_RES bool DirectedChannelTransactionParameters_opt_anchors(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
23115 * Frees any resources used by the HolderCommitmentTransaction, if is_owned is set and inner is non-NULL.
23117 void HolderCommitmentTransaction_free(struct LDKHolderCommitmentTransaction this_obj);
23120 * Our counterparty's signature for the transaction
23122 struct LDKSignature HolderCommitmentTransaction_get_counterparty_sig(const struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr);
23125 * Our counterparty's signature for the transaction
23127 void HolderCommitmentTransaction_set_counterparty_sig(struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKSignature val);
23130 * All non-dust counterparty HTLC signatures, in the order they appear in the transaction
23132 void HolderCommitmentTransaction_set_counterparty_htlc_sigs(struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKCVec_SignatureZ val);
23135 * Creates a copy of the HolderCommitmentTransaction
23137 struct LDKHolderCommitmentTransaction HolderCommitmentTransaction_clone(const struct LDKHolderCommitmentTransaction *NONNULL_PTR orig);
23140 * Serialize the HolderCommitmentTransaction object into a byte array which can be read by HolderCommitmentTransaction_read
23142 struct LDKCVec_u8Z HolderCommitmentTransaction_write(const struct LDKHolderCommitmentTransaction *NONNULL_PTR obj);
23145 * Read a HolderCommitmentTransaction from a byte array, created by HolderCommitmentTransaction_write
23147 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ HolderCommitmentTransaction_read(struct LDKu8slice ser);
23150 * Create a new holder transaction with the given counterparty signatures.
23151 * The funding keys are used to figure out which signature should go first when building the transaction for broadcast.
23153 MUST_USE_RES struct LDKHolderCommitmentTransaction HolderCommitmentTransaction_new(struct LDKCommitmentTransaction commitment_tx, struct LDKSignature counterparty_sig, struct LDKCVec_SignatureZ counterparty_htlc_sigs, struct LDKPublicKey holder_funding_key, struct LDKPublicKey counterparty_funding_key);
23156 * Frees any resources used by the BuiltCommitmentTransaction, if is_owned is set and inner is non-NULL.
23158 void BuiltCommitmentTransaction_free(struct LDKBuiltCommitmentTransaction this_obj);
23161 * The commitment transaction
23163 struct LDKTransaction BuiltCommitmentTransaction_get_transaction(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr);
23166 * The commitment transaction
23168 void BuiltCommitmentTransaction_set_transaction(struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKTransaction val);
23171 * The txid for the commitment transaction.
23173 * This is provided as a performance optimization, instead of calling transaction.txid()
23176 const uint8_t (*BuiltCommitmentTransaction_get_txid(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr))[32];
23179 * The txid for the commitment transaction.
23181 * This is provided as a performance optimization, instead of calling transaction.txid()
23184 void BuiltCommitmentTransaction_set_txid(struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
23187 * Constructs a new BuiltCommitmentTransaction given each field
23189 MUST_USE_RES struct LDKBuiltCommitmentTransaction BuiltCommitmentTransaction_new(struct LDKTransaction transaction_arg, struct LDKThirtyTwoBytes txid_arg);
23192 * Creates a copy of the BuiltCommitmentTransaction
23194 struct LDKBuiltCommitmentTransaction BuiltCommitmentTransaction_clone(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR orig);
23197 * Serialize the BuiltCommitmentTransaction object into a byte array which can be read by BuiltCommitmentTransaction_read
23199 struct LDKCVec_u8Z BuiltCommitmentTransaction_write(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR obj);
23202 * Read a BuiltCommitmentTransaction from a byte array, created by BuiltCommitmentTransaction_write
23204 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ BuiltCommitmentTransaction_read(struct LDKu8slice ser);
23207 * Get the SIGHASH_ALL sighash value of the transaction.
23209 * This can be used to verify a signature.
23211 MUST_USE_RES struct LDKThirtyTwoBytes BuiltCommitmentTransaction_get_sighash_all(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_arg, struct LDKu8slice funding_redeemscript, uint64_t channel_value_satoshis);
23214 * Sign a transaction, either because we are counter-signing the counterparty's transaction or
23215 * because we are about to broadcast a holder transaction.
23217 MUST_USE_RES struct LDKSignature BuiltCommitmentTransaction_sign(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_arg, const uint8_t (*funding_key)[32], struct LDKu8slice funding_redeemscript, uint64_t channel_value_satoshis);
23220 * Frees any resources used by the ClosingTransaction, if is_owned is set and inner is non-NULL.
23222 void ClosingTransaction_free(struct LDKClosingTransaction this_obj);
23225 * Creates a copy of the ClosingTransaction
23227 struct LDKClosingTransaction ClosingTransaction_clone(const struct LDKClosingTransaction *NONNULL_PTR orig);
23230 * Checks if two ClosingTransactions contain equal inner contents.
23232 uint64_t ClosingTransaction_hash(const struct LDKClosingTransaction *NONNULL_PTR o);
23235 * Construct an object of the class
23237 MUST_USE_RES struct LDKClosingTransaction ClosingTransaction_new(uint64_t to_holder_value_sat, uint64_t to_counterparty_value_sat, struct LDKCVec_u8Z to_holder_script, struct LDKCVec_u8Z to_counterparty_script, struct LDKOutPoint funding_outpoint);
23240 * Trust our pre-built transaction.
23242 * Applies a wrapper which allows access to the transaction.
23244 * This should only be used if you fully trust the builder of this object. It should not
23245 * be used by an external signer - instead use the verify function.
23247 MUST_USE_RES struct LDKTrustedClosingTransaction ClosingTransaction_trust(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
23250 * Verify our pre-built transaction.
23252 * Applies a wrapper which allows access to the transaction.
23254 * An external validating signer must call this method before signing
23255 * or using the built transaction.
23257 MUST_USE_RES struct LDKCResult_TrustedClosingTransactionNoneZ ClosingTransaction_verify(const struct LDKClosingTransaction *NONNULL_PTR this_arg, struct LDKOutPoint funding_outpoint);
23260 * The value to be sent to the holder, or zero if the output will be omitted
23262 MUST_USE_RES uint64_t ClosingTransaction_to_holder_value_sat(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
23265 * The value to be sent to the counterparty, or zero if the output will be omitted
23267 MUST_USE_RES uint64_t ClosingTransaction_to_counterparty_value_sat(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
23270 * The destination of the holder's output
23272 MUST_USE_RES struct LDKu8slice ClosingTransaction_to_holder_script(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
23275 * The destination of the counterparty's output
23277 MUST_USE_RES struct LDKu8slice ClosingTransaction_to_counterparty_script(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
23280 * Frees any resources used by the TrustedClosingTransaction, if is_owned is set and inner is non-NULL.
23282 void TrustedClosingTransaction_free(struct LDKTrustedClosingTransaction this_obj);
23285 * The pre-built Bitcoin commitment transaction
23287 MUST_USE_RES struct LDKTransaction TrustedClosingTransaction_built_transaction(const struct LDKTrustedClosingTransaction *NONNULL_PTR this_arg);
23290 * Get the SIGHASH_ALL sighash value of the transaction.
23292 * This can be used to verify a signature.
23294 MUST_USE_RES struct LDKThirtyTwoBytes TrustedClosingTransaction_get_sighash_all(const struct LDKTrustedClosingTransaction *NONNULL_PTR this_arg, struct LDKu8slice funding_redeemscript, uint64_t channel_value_satoshis);
23297 * Sign a transaction, either because we are counter-signing the counterparty's transaction or
23298 * because we are about to broadcast a holder transaction.
23300 MUST_USE_RES struct LDKSignature TrustedClosingTransaction_sign(const struct LDKTrustedClosingTransaction *NONNULL_PTR this_arg, const uint8_t (*funding_key)[32], struct LDKu8slice funding_redeemscript, uint64_t channel_value_satoshis);
23303 * Frees any resources used by the CommitmentTransaction, if is_owned is set and inner is non-NULL.
23305 void CommitmentTransaction_free(struct LDKCommitmentTransaction this_obj);
23308 * Creates a copy of the CommitmentTransaction
23310 struct LDKCommitmentTransaction CommitmentTransaction_clone(const struct LDKCommitmentTransaction *NONNULL_PTR orig);
23313 * Serialize the CommitmentTransaction object into a byte array which can be read by CommitmentTransaction_read
23315 struct LDKCVec_u8Z CommitmentTransaction_write(const struct LDKCommitmentTransaction *NONNULL_PTR obj);
23318 * Read a CommitmentTransaction from a byte array, created by CommitmentTransaction_write
23320 struct LDKCResult_CommitmentTransactionDecodeErrorZ CommitmentTransaction_read(struct LDKu8slice ser);
23323 * The backwards-counting commitment number
23325 MUST_USE_RES uint64_t CommitmentTransaction_commitment_number(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
23328 * The value to be sent to the broadcaster
23330 MUST_USE_RES uint64_t CommitmentTransaction_to_broadcaster_value_sat(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
23333 * The value to be sent to the counterparty
23335 MUST_USE_RES uint64_t CommitmentTransaction_to_countersignatory_value_sat(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
23338 * The feerate paid per 1000-weight-unit in this commitment transaction.
23340 MUST_USE_RES uint32_t CommitmentTransaction_feerate_per_kw(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
23343 * Trust our pre-built transaction and derived transaction creation public keys.
23345 * Applies a wrapper which allows access to these fields.
23347 * This should only be used if you fully trust the builder of this object. It should not
23348 * be used by an external signer - instead use the verify function.
23350 MUST_USE_RES struct LDKTrustedCommitmentTransaction CommitmentTransaction_trust(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
23353 * Verify our pre-built transaction and derived transaction creation public keys.
23355 * Applies a wrapper which allows access to these fields.
23357 * An external validating signer must call this method before signing
23358 * or using the built transaction.
23360 MUST_USE_RES struct LDKCResult_TrustedCommitmentTransactionNoneZ CommitmentTransaction_verify(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg, const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR channel_parameters, const struct LDKChannelPublicKeys *NONNULL_PTR broadcaster_keys, const struct LDKChannelPublicKeys *NONNULL_PTR countersignatory_keys);
23363 * Frees any resources used by the TrustedCommitmentTransaction, if is_owned is set and inner is non-NULL.
23365 void TrustedCommitmentTransaction_free(struct LDKTrustedCommitmentTransaction this_obj);
23368 * The transaction ID of the built Bitcoin transaction
23370 MUST_USE_RES struct LDKThirtyTwoBytes TrustedCommitmentTransaction_txid(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
23373 * The pre-built Bitcoin commitment transaction
23375 MUST_USE_RES struct LDKBuiltCommitmentTransaction TrustedCommitmentTransaction_built_transaction(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
23378 * The pre-calculated transaction creation public keys.
23380 MUST_USE_RES struct LDKTxCreationKeys TrustedCommitmentTransaction_keys(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
23383 * Should anchors be used.
23385 MUST_USE_RES bool TrustedCommitmentTransaction_opt_anchors(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
23388 * Get a signature for each HTLC which was included in the commitment transaction (ie for
23389 * which HTLCOutputInCommitment::transaction_output_index.is_some()).
23391 * The returned Vec has one entry for each HTLC, and in the same order.
23393 * This function is only valid in the holder commitment context, it always uses SigHashType::All.
23395 MUST_USE_RES struct LDKCResult_CVec_SignatureZNoneZ TrustedCommitmentTransaction_get_htlc_sigs(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg, const uint8_t (*htlc_base_key)[32], const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR channel_parameters);
23398 * Commitment transaction numbers which appear in the transactions themselves are XOR'd with a
23399 * shared secret first. This prevents on-chain observers from discovering how many commitment
23400 * transactions occurred in a channel before it was closed.
23402 * This function gets the shared secret from relevant channel public keys and can be used to
23403 * \"decrypt\" the commitment transaction number given a commitment transaction on-chain.
23405 uint64_t get_commitment_transaction_number_obscure_factor(struct LDKPublicKey broadcaster_payment_basepoint, struct LDKPublicKey countersignatory_payment_basepoint, bool outbound_from_broadcaster);
23408 * Checks if two InitFeaturess contain equal inner contents.
23409 * This ignores pointers and is_owned flags and looks at the values in fields.
23410 * Two objects with NULL inner values will be considered "equal" here.
23412 bool InitFeatures_eq(const struct LDKInitFeatures *NONNULL_PTR a, const struct LDKInitFeatures *NONNULL_PTR b);
23415 * Checks if two NodeFeaturess contain equal inner contents.
23416 * This ignores pointers and is_owned flags and looks at the values in fields.
23417 * Two objects with NULL inner values will be considered "equal" here.
23419 bool NodeFeatures_eq(const struct LDKNodeFeatures *NONNULL_PTR a, const struct LDKNodeFeatures *NONNULL_PTR b);
23422 * Checks if two ChannelFeaturess contain equal inner contents.
23423 * This ignores pointers and is_owned flags and looks at the values in fields.
23424 * Two objects with NULL inner values will be considered "equal" here.
23426 bool ChannelFeatures_eq(const struct LDKChannelFeatures *NONNULL_PTR a, const struct LDKChannelFeatures *NONNULL_PTR b);
23429 * Checks if two InvoiceFeaturess contain equal inner contents.
23430 * This ignores pointers and is_owned flags and looks at the values in fields.
23431 * Two objects with NULL inner values will be considered "equal" here.
23433 bool InvoiceFeatures_eq(const struct LDKInvoiceFeatures *NONNULL_PTR a, const struct LDKInvoiceFeatures *NONNULL_PTR b);
23436 * Checks if two ChannelTypeFeaturess contain equal inner contents.
23437 * This ignores pointers and is_owned flags and looks at the values in fields.
23438 * Two objects with NULL inner values will be considered "equal" here.
23440 bool ChannelTypeFeatures_eq(const struct LDKChannelTypeFeatures *NONNULL_PTR a, const struct LDKChannelTypeFeatures *NONNULL_PTR b);
23443 * Creates a copy of the InitFeatures
23445 struct LDKInitFeatures InitFeatures_clone(const struct LDKInitFeatures *NONNULL_PTR orig);
23448 * Creates a copy of the NodeFeatures
23450 struct LDKNodeFeatures NodeFeatures_clone(const struct LDKNodeFeatures *NONNULL_PTR orig);
23453 * Creates a copy of the ChannelFeatures
23455 struct LDKChannelFeatures ChannelFeatures_clone(const struct LDKChannelFeatures *NONNULL_PTR orig);
23458 * Creates a copy of the InvoiceFeatures
23460 struct LDKInvoiceFeatures InvoiceFeatures_clone(const struct LDKInvoiceFeatures *NONNULL_PTR orig);
23463 * Creates a copy of the ChannelTypeFeatures
23465 struct LDKChannelTypeFeatures ChannelTypeFeatures_clone(const struct LDKChannelTypeFeatures *NONNULL_PTR orig);
23468 * Frees any resources used by the InitFeatures, if is_owned is set and inner is non-NULL.
23470 void InitFeatures_free(struct LDKInitFeatures this_obj);
23473 * Frees any resources used by the NodeFeatures, if is_owned is set and inner is non-NULL.
23475 void NodeFeatures_free(struct LDKNodeFeatures this_obj);
23478 * Frees any resources used by the ChannelFeatures, if is_owned is set and inner is non-NULL.
23480 void ChannelFeatures_free(struct LDKChannelFeatures this_obj);
23483 * Frees any resources used by the InvoiceFeatures, if is_owned is set and inner is non-NULL.
23485 void InvoiceFeatures_free(struct LDKInvoiceFeatures this_obj);
23488 * Frees any resources used by the ChannelTypeFeatures, if is_owned is set and inner is non-NULL.
23490 void ChannelTypeFeatures_free(struct LDKChannelTypeFeatures this_obj);
23493 * Create a blank Features with no features set
23495 MUST_USE_RES struct LDKInitFeatures InitFeatures_empty(void);
23498 * Creates a Features with the bits set which are known by the implementation
23500 MUST_USE_RES struct LDKInitFeatures InitFeatures_known(void);
23503 * Returns true if this `Features` object contains unknown feature flags which are set as
23506 MUST_USE_RES bool InitFeatures_requires_unknown_bits(const struct LDKInitFeatures *NONNULL_PTR this_arg);
23509 * Create a blank Features with no features set
23511 MUST_USE_RES struct LDKNodeFeatures NodeFeatures_empty(void);
23514 * Creates a Features with the bits set which are known by the implementation
23516 MUST_USE_RES struct LDKNodeFeatures NodeFeatures_known(void);
23519 * Returns true if this `Features` object contains unknown feature flags which are set as
23522 MUST_USE_RES bool NodeFeatures_requires_unknown_bits(const struct LDKNodeFeatures *NONNULL_PTR this_arg);
23525 * Create a blank Features with no features set
23527 MUST_USE_RES struct LDKChannelFeatures ChannelFeatures_empty(void);
23530 * Creates a Features with the bits set which are known by the implementation
23532 MUST_USE_RES struct LDKChannelFeatures ChannelFeatures_known(void);
23535 * Returns true if this `Features` object contains unknown feature flags which are set as
23538 MUST_USE_RES bool ChannelFeatures_requires_unknown_bits(const struct LDKChannelFeatures *NONNULL_PTR this_arg);
23541 * Create a blank Features with no features set
23543 MUST_USE_RES struct LDKInvoiceFeatures InvoiceFeatures_empty(void);
23546 * Creates a Features with the bits set which are known by the implementation
23548 MUST_USE_RES struct LDKInvoiceFeatures InvoiceFeatures_known(void);
23551 * Returns true if this `Features` object contains unknown feature flags which are set as
23554 MUST_USE_RES bool InvoiceFeatures_requires_unknown_bits(const struct LDKInvoiceFeatures *NONNULL_PTR this_arg);
23557 * Create a blank Features with no features set
23559 MUST_USE_RES struct LDKChannelTypeFeatures ChannelTypeFeatures_empty(void);
23562 * Creates a Features with the bits set which are known by the implementation
23564 MUST_USE_RES struct LDKChannelTypeFeatures ChannelTypeFeatures_known(void);
23567 * Returns true if this `Features` object contains unknown feature flags which are set as
23570 MUST_USE_RES bool ChannelTypeFeatures_requires_unknown_bits(const struct LDKChannelTypeFeatures *NONNULL_PTR this_arg);
23573 * Serialize the InitFeatures object into a byte array which can be read by InitFeatures_read
23575 struct LDKCVec_u8Z InitFeatures_write(const struct LDKInitFeatures *NONNULL_PTR obj);
23578 * Read a InitFeatures from a byte array, created by InitFeatures_write
23580 struct LDKCResult_InitFeaturesDecodeErrorZ InitFeatures_read(struct LDKu8slice ser);
23583 * Serialize the ChannelFeatures object into a byte array which can be read by ChannelFeatures_read
23585 struct LDKCVec_u8Z ChannelFeatures_write(const struct LDKChannelFeatures *NONNULL_PTR obj);
23588 * Read a ChannelFeatures from a byte array, created by ChannelFeatures_write
23590 struct LDKCResult_ChannelFeaturesDecodeErrorZ ChannelFeatures_read(struct LDKu8slice ser);
23593 * Serialize the NodeFeatures object into a byte array which can be read by NodeFeatures_read
23595 struct LDKCVec_u8Z NodeFeatures_write(const struct LDKNodeFeatures *NONNULL_PTR obj);
23598 * Read a NodeFeatures from a byte array, created by NodeFeatures_write
23600 struct LDKCResult_NodeFeaturesDecodeErrorZ NodeFeatures_read(struct LDKu8slice ser);
23603 * Serialize the InvoiceFeatures object into a byte array which can be read by InvoiceFeatures_read
23605 struct LDKCVec_u8Z InvoiceFeatures_write(const struct LDKInvoiceFeatures *NONNULL_PTR obj);
23608 * Read a InvoiceFeatures from a byte array, created by InvoiceFeatures_write
23610 struct LDKCResult_InvoiceFeaturesDecodeErrorZ InvoiceFeatures_read(struct LDKu8slice ser);
23613 * Serialize the ChannelTypeFeatures object into a byte array which can be read by ChannelTypeFeatures_read
23615 struct LDKCVec_u8Z ChannelTypeFeatures_write(const struct LDKChannelTypeFeatures *NONNULL_PTR obj);
23618 * Read a ChannelTypeFeatures from a byte array, created by ChannelTypeFeatures_write
23620 struct LDKCResult_ChannelTypeFeaturesDecodeErrorZ ChannelTypeFeatures_read(struct LDKu8slice ser);
23623 * Frees any resources used by the ShutdownScript, if is_owned is set and inner is non-NULL.
23625 void ShutdownScript_free(struct LDKShutdownScript this_obj);
23628 * Creates a copy of the ShutdownScript
23630 struct LDKShutdownScript ShutdownScript_clone(const struct LDKShutdownScript *NONNULL_PTR orig);
23633 * Frees any resources used by the InvalidShutdownScript, if is_owned is set and inner is non-NULL.
23635 void InvalidShutdownScript_free(struct LDKInvalidShutdownScript this_obj);
23638 * The script that did not meet the requirements from [BOLT #2].
23640 * [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
23642 struct LDKu8slice InvalidShutdownScript_get_script(const struct LDKInvalidShutdownScript *NONNULL_PTR this_ptr);
23645 * The script that did not meet the requirements from [BOLT #2].
23647 * [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
23649 void InvalidShutdownScript_set_script(struct LDKInvalidShutdownScript *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
23652 * Constructs a new InvalidShutdownScript given each field
23654 MUST_USE_RES struct LDKInvalidShutdownScript InvalidShutdownScript_new(struct LDKCVec_u8Z script_arg);
23657 * Creates a copy of the InvalidShutdownScript
23659 struct LDKInvalidShutdownScript InvalidShutdownScript_clone(const struct LDKInvalidShutdownScript *NONNULL_PTR orig);
23662 * Serialize the ShutdownScript object into a byte array which can be read by ShutdownScript_read
23664 struct LDKCVec_u8Z ShutdownScript_write(const struct LDKShutdownScript *NONNULL_PTR obj);
23667 * Read a ShutdownScript from a byte array, created by ShutdownScript_write
23669 struct LDKCResult_ShutdownScriptDecodeErrorZ ShutdownScript_read(struct LDKu8slice ser);
23672 * Generates a P2WPKH script pubkey from the given [`WPubkeyHash`].
23674 MUST_USE_RES struct LDKShutdownScript ShutdownScript_new_p2wpkh(const uint8_t (*pubkey_hash)[20]);
23677 * Generates a P2WSH script pubkey from the given [`WScriptHash`].
23679 MUST_USE_RES struct LDKShutdownScript ShutdownScript_new_p2wsh(const uint8_t (*script_hash)[32]);
23682 * Generates a witness script pubkey from the given segwit version and program.
23684 * Note for version-zero witness scripts you must use [`ShutdownScript::new_p2wpkh`] or
23685 * [`ShutdownScript::new_p2wsh`] instead.
23689 * This function may return an error if `program` is invalid for the segwit `version`.
23691 MUST_USE_RES struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ ShutdownScript_new_witness_program(uint8_t version, struct LDKu8slice program);
23694 * Converts the shutdown script into the underlying [`Script`].
23696 MUST_USE_RES struct LDKCVec_u8Z ShutdownScript_into_inner(struct LDKShutdownScript this_arg);
23699 * Returns the [`PublicKey`] used for a P2WPKH shutdown script if constructed directly from it.
23701 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
23703 MUST_USE_RES struct LDKPublicKey ShutdownScript_as_legacy_pubkey(const struct LDKShutdownScript *NONNULL_PTR this_arg);
23706 * Returns whether the shutdown script is compatible with the features as defined by BOLT #2.
23708 * Specifically, checks for compliance with feature `option_shutdown_anysegwit`.
23710 MUST_USE_RES bool ShutdownScript_is_compatible(const struct LDKShutdownScript *NONNULL_PTR this_arg, const struct LDKInitFeatures *NONNULL_PTR features);
23713 * Calls the free function if one is set
23715 void CustomMessageReader_free(struct LDKCustomMessageReader this_ptr);
23718 * Calls the free function if one is set
23720 void Type_free(struct LDKType this_ptr);
23723 * Frees any resources used by the NodeId, if is_owned is set and inner is non-NULL.
23725 void NodeId_free(struct LDKNodeId this_obj);
23728 * Creates a copy of the NodeId
23730 struct LDKNodeId NodeId_clone(const struct LDKNodeId *NONNULL_PTR orig);
23733 * Create a new NodeId from a public key
23735 MUST_USE_RES struct LDKNodeId NodeId_from_pubkey(struct LDKPublicKey pubkey);
23738 * Get the public key slice from this NodeId
23740 MUST_USE_RES struct LDKu8slice NodeId_as_slice(const struct LDKNodeId *NONNULL_PTR this_arg);
23743 * Checks if two NodeIds contain equal inner contents.
23745 uint64_t NodeId_hash(const struct LDKNodeId *NONNULL_PTR o);
23748 * Serialize the NodeId object into a byte array which can be read by NodeId_read
23750 struct LDKCVec_u8Z NodeId_write(const struct LDKNodeId *NONNULL_PTR obj);
23753 * Read a NodeId from a byte array, created by NodeId_write
23755 struct LDKCResult_NodeIdDecodeErrorZ NodeId_read(struct LDKu8slice ser);
23758 * Frees any resources used by the NetworkGraph, if is_owned is set and inner is non-NULL.
23760 void NetworkGraph_free(struct LDKNetworkGraph this_obj);
23763 * Creates a copy of the NetworkGraph
23765 struct LDKNetworkGraph NetworkGraph_clone(const struct LDKNetworkGraph *NONNULL_PTR orig);
23768 * Frees any resources used by the ReadOnlyNetworkGraph, if is_owned is set and inner is non-NULL.
23770 void ReadOnlyNetworkGraph_free(struct LDKReadOnlyNetworkGraph this_obj);
23773 * Frees any resources used by the NetworkUpdate
23775 void NetworkUpdate_free(struct LDKNetworkUpdate this_ptr);
23778 * Creates a copy of the NetworkUpdate
23780 struct LDKNetworkUpdate NetworkUpdate_clone(const struct LDKNetworkUpdate *NONNULL_PTR orig);
23783 * Utility method to constructs a new ChannelUpdateMessage-variant NetworkUpdate
23785 struct LDKNetworkUpdate NetworkUpdate_channel_update_message(struct LDKChannelUpdate msg);
23788 * Utility method to constructs a new ChannelClosed-variant NetworkUpdate
23790 struct LDKNetworkUpdate NetworkUpdate_channel_closed(uint64_t short_channel_id, bool is_permanent);
23793 * Utility method to constructs a new NodeFailure-variant NetworkUpdate
23795 struct LDKNetworkUpdate NetworkUpdate_node_failure(struct LDKPublicKey node_id, bool is_permanent);
23798 * Serialize the NetworkUpdate object into a byte array which can be read by NetworkUpdate_read
23800 struct LDKCVec_u8Z NetworkUpdate_write(const struct LDKNetworkUpdate *NONNULL_PTR obj);
23803 * Read a NetworkUpdate from a byte array, created by NetworkUpdate_write
23805 struct LDKCResult_COption_NetworkUpdateZDecodeErrorZ NetworkUpdate_read(struct LDKu8slice ser);
23808 * Constructs a new EventHandler which calls the relevant methods on this_arg.
23809 * This copies the `inner` pointer in this_arg and thus the returned EventHandler must be freed before this_arg is
23811 struct LDKEventHandler NetGraphMsgHandler_as_EventHandler(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
23814 * Frees any resources used by the NetGraphMsgHandler, if is_owned is set and inner is non-NULL.
23816 void NetGraphMsgHandler_free(struct LDKNetGraphMsgHandler this_obj);
23819 * Creates a new tracker of the actual state of the network of channels and nodes,
23820 * assuming an existing Network Graph.
23821 * Chain monitor is used to make sure announced channels exist on-chain,
23822 * channel data is correct, and that the announcement is signed with
23823 * channel owners' keys.
23825 MUST_USE_RES struct LDKNetGraphMsgHandler NetGraphMsgHandler_new(const struct LDKNetworkGraph *NONNULL_PTR network_graph, struct LDKCOption_AccessZ chain_access, struct LDKLogger logger);
23828 * Adds a provider used to check new announcements. Does not affect
23829 * existing announcements unless they are updated.
23830 * Add, update or remove the provider would replace the current one.
23832 void NetGraphMsgHandler_add_chain_access(struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg, struct LDKCOption_AccessZ chain_access);
23835 * Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg.
23836 * This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is
23838 struct LDKRoutingMessageHandler NetGraphMsgHandler_as_RoutingMessageHandler(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
23841 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
23842 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
23844 struct LDKMessageSendEventsProvider NetGraphMsgHandler_as_MessageSendEventsProvider(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
23847 * Frees any resources used by the ChannelUpdateInfo, if is_owned is set and inner is non-NULL.
23849 void ChannelUpdateInfo_free(struct LDKChannelUpdateInfo this_obj);
23852 * When the last update to the channel direction was issued.
23853 * Value is opaque, as set in the announcement.
23855 uint32_t ChannelUpdateInfo_get_last_update(const struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr);
23858 * When the last update to the channel direction was issued.
23859 * Value is opaque, as set in the announcement.
23861 void ChannelUpdateInfo_set_last_update(struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr, uint32_t val);
23864 * Whether the channel can be currently used for payments (in this one direction).
23866 bool ChannelUpdateInfo_get_enabled(const struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr);
23869 * Whether the channel can be currently used for payments (in this one direction).
23871 void ChannelUpdateInfo_set_enabled(struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr, bool val);
23874 * The difference in CLTV values that you must have when routing through this channel.
23876 uint16_t ChannelUpdateInfo_get_cltv_expiry_delta(const struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr);
23879 * The difference in CLTV values that you must have when routing through this channel.
23881 void ChannelUpdateInfo_set_cltv_expiry_delta(struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr, uint16_t val);
23884 * The minimum value, which must be relayed to the next hop via the channel
23886 uint64_t ChannelUpdateInfo_get_htlc_minimum_msat(const struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr);
23889 * The minimum value, which must be relayed to the next hop via the channel
23891 void ChannelUpdateInfo_set_htlc_minimum_msat(struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr, uint64_t val);
23894 * The maximum value which may be relayed to the next hop via the channel.
23896 struct LDKCOption_u64Z ChannelUpdateInfo_get_htlc_maximum_msat(const struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr);
23899 * The maximum value which may be relayed to the next hop via the channel.
23901 void ChannelUpdateInfo_set_htlc_maximum_msat(struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
23904 * Fees charged when the channel is used for routing
23906 struct LDKRoutingFees ChannelUpdateInfo_get_fees(const struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr);
23909 * Fees charged when the channel is used for routing
23911 void ChannelUpdateInfo_set_fees(struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
23914 * Most recent update for the channel received from the network
23915 * Mostly redundant with the data we store in fields explicitly.
23916 * Everything else is useful only for sending out for initial routing sync.
23917 * Not stored if contains excess data to prevent DoS.
23919 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
23921 struct LDKChannelUpdate ChannelUpdateInfo_get_last_update_message(const struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr);
23924 * Most recent update for the channel received from the network
23925 * Mostly redundant with the data we store in fields explicitly.
23926 * Everything else is useful only for sending out for initial routing sync.
23927 * Not stored if contains excess data to prevent DoS.
23929 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
23931 void ChannelUpdateInfo_set_last_update_message(struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr, struct LDKChannelUpdate val);
23934 * Constructs a new ChannelUpdateInfo given each field
23936 MUST_USE_RES struct LDKChannelUpdateInfo ChannelUpdateInfo_new(uint32_t last_update_arg, bool enabled_arg, uint16_t cltv_expiry_delta_arg, uint64_t htlc_minimum_msat_arg, struct LDKCOption_u64Z htlc_maximum_msat_arg, struct LDKRoutingFees fees_arg, struct LDKChannelUpdate last_update_message_arg);
23939 * Creates a copy of the ChannelUpdateInfo
23941 struct LDKChannelUpdateInfo ChannelUpdateInfo_clone(const struct LDKChannelUpdateInfo *NONNULL_PTR orig);
23944 * Serialize the ChannelUpdateInfo object into a byte array which can be read by ChannelUpdateInfo_read
23946 struct LDKCVec_u8Z ChannelUpdateInfo_write(const struct LDKChannelUpdateInfo *NONNULL_PTR obj);
23949 * Read a ChannelUpdateInfo from a byte array, created by ChannelUpdateInfo_write
23951 struct LDKCResult_ChannelUpdateInfoDecodeErrorZ ChannelUpdateInfo_read(struct LDKu8slice ser);
23954 * Frees any resources used by the ChannelInfo, if is_owned is set and inner is non-NULL.
23956 void ChannelInfo_free(struct LDKChannelInfo this_obj);
23959 * Protocol features of a channel communicated during its announcement
23961 struct LDKChannelFeatures ChannelInfo_get_features(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
23964 * Protocol features of a channel communicated during its announcement
23966 void ChannelInfo_set_features(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
23969 * Source node of the first direction of a channel
23971 struct LDKNodeId ChannelInfo_get_node_one(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
23974 * Source node of the first direction of a channel
23976 void ChannelInfo_set_node_one(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKNodeId val);
23979 * Details about the first direction of a channel
23981 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
23983 struct LDKChannelUpdateInfo ChannelInfo_get_one_to_two(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
23986 * Details about the first direction of a channel
23988 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
23990 void ChannelInfo_set_one_to_two(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelUpdateInfo val);
23993 * Source node of the second direction of a channel
23995 struct LDKNodeId ChannelInfo_get_node_two(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
23998 * Source node of the second direction of a channel
24000 void ChannelInfo_set_node_two(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKNodeId val);
24003 * Details about the second direction of a channel
24005 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24007 struct LDKChannelUpdateInfo ChannelInfo_get_two_to_one(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
24010 * Details about the second direction of a channel
24012 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
24014 void ChannelInfo_set_two_to_one(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelUpdateInfo val);
24017 * The channel capacity as seen on-chain, if chain lookup is available.
24019 struct LDKCOption_u64Z ChannelInfo_get_capacity_sats(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
24022 * The channel capacity as seen on-chain, if chain lookup is available.
24024 void ChannelInfo_set_capacity_sats(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
24027 * An initial announcement of the channel
24028 * Mostly redundant with the data we store in fields explicitly.
24029 * Everything else is useful only for sending out for initial routing sync.
24030 * Not stored if contains excess data to prevent DoS.
24032 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24034 struct LDKChannelAnnouncement ChannelInfo_get_announcement_message(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
24037 * An initial announcement of the channel
24038 * Mostly redundant with the data we store in fields explicitly.
24039 * Everything else is useful only for sending out for initial routing sync.
24040 * Not stored if contains excess data to prevent DoS.
24042 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
24044 void ChannelInfo_set_announcement_message(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelAnnouncement val);
24047 * Creates a copy of the ChannelInfo
24049 struct LDKChannelInfo ChannelInfo_clone(const struct LDKChannelInfo *NONNULL_PTR orig);
24052 * Serialize the ChannelInfo object into a byte array which can be read by ChannelInfo_read
24054 struct LDKCVec_u8Z ChannelInfo_write(const struct LDKChannelInfo *NONNULL_PTR obj);
24057 * Read a ChannelInfo from a byte array, created by ChannelInfo_write
24059 struct LDKCResult_ChannelInfoDecodeErrorZ ChannelInfo_read(struct LDKu8slice ser);
24062 * Frees any resources used by the DirectedChannelInfo, if is_owned is set and inner is non-NULL.
24064 void DirectedChannelInfo_free(struct LDKDirectedChannelInfo this_obj);
24067 * Creates a copy of the DirectedChannelInfo
24069 struct LDKDirectedChannelInfo DirectedChannelInfo_clone(const struct LDKDirectedChannelInfo *NONNULL_PTR orig);
24072 * Returns information for the channel.
24074 MUST_USE_RES struct LDKChannelInfo DirectedChannelInfo_channel(const struct LDKDirectedChannelInfo *NONNULL_PTR this_arg);
24077 * Returns information for the direction.
24079 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24081 MUST_USE_RES struct LDKChannelUpdateInfo DirectedChannelInfo_direction(const struct LDKDirectedChannelInfo *NONNULL_PTR this_arg);
24084 * Returns the [`EffectiveCapacity`] of the channel in the direction.
24086 * This is either the total capacity from the funding transaction, if known, or the
24087 * `htlc_maximum_msat` for the direction as advertised by the gossip network, if known,
24088 * whichever is smaller.
24090 MUST_USE_RES struct LDKEffectiveCapacity DirectedChannelInfo_effective_capacity(const struct LDKDirectedChannelInfo *NONNULL_PTR this_arg);
24093 * Frees any resources used by the EffectiveCapacity
24095 void EffectiveCapacity_free(struct LDKEffectiveCapacity this_ptr);
24098 * Creates a copy of the EffectiveCapacity
24100 struct LDKEffectiveCapacity EffectiveCapacity_clone(const struct LDKEffectiveCapacity *NONNULL_PTR orig);
24103 * Utility method to constructs a new ExactLiquidity-variant EffectiveCapacity
24105 struct LDKEffectiveCapacity EffectiveCapacity_exact_liquidity(uint64_t liquidity_msat);
24108 * Utility method to constructs a new MaximumHTLC-variant EffectiveCapacity
24110 struct LDKEffectiveCapacity EffectiveCapacity_maximum_htlc(uint64_t amount_msat);
24113 * Utility method to constructs a new Total-variant EffectiveCapacity
24115 struct LDKEffectiveCapacity EffectiveCapacity_total(uint64_t capacity_msat);
24118 * Utility method to constructs a new Infinite-variant EffectiveCapacity
24120 struct LDKEffectiveCapacity EffectiveCapacity_infinite(void);
24123 * Utility method to constructs a new Unknown-variant EffectiveCapacity
24125 struct LDKEffectiveCapacity EffectiveCapacity_unknown(void);
24128 * Returns the effective capacity denominated in millisatoshi.
24130 MUST_USE_RES uint64_t EffectiveCapacity_as_msat(const struct LDKEffectiveCapacity *NONNULL_PTR this_arg);
24133 * Frees any resources used by the RoutingFees, if is_owned is set and inner is non-NULL.
24135 void RoutingFees_free(struct LDKRoutingFees this_obj);
24138 * Flat routing fee in satoshis
24140 uint32_t RoutingFees_get_base_msat(const struct LDKRoutingFees *NONNULL_PTR this_ptr);
24143 * Flat routing fee in satoshis
24145 void RoutingFees_set_base_msat(struct LDKRoutingFees *NONNULL_PTR this_ptr, uint32_t val);
24148 * Liquidity-based routing fee in millionths of a routed amount.
24149 * In other words, 10000 is 1%.
24151 uint32_t RoutingFees_get_proportional_millionths(const struct LDKRoutingFees *NONNULL_PTR this_ptr);
24154 * Liquidity-based routing fee in millionths of a routed amount.
24155 * In other words, 10000 is 1%.
24157 void RoutingFees_set_proportional_millionths(struct LDKRoutingFees *NONNULL_PTR this_ptr, uint32_t val);
24160 * Constructs a new RoutingFees given each field
24162 MUST_USE_RES struct LDKRoutingFees RoutingFees_new(uint32_t base_msat_arg, uint32_t proportional_millionths_arg);
24165 * Checks if two RoutingFeess contain equal inner contents.
24166 * This ignores pointers and is_owned flags and looks at the values in fields.
24167 * Two objects with NULL inner values will be considered "equal" here.
24169 bool RoutingFees_eq(const struct LDKRoutingFees *NONNULL_PTR a, const struct LDKRoutingFees *NONNULL_PTR b);
24172 * Creates a copy of the RoutingFees
24174 struct LDKRoutingFees RoutingFees_clone(const struct LDKRoutingFees *NONNULL_PTR orig);
24177 * Checks if two RoutingFeess contain equal inner contents.
24179 uint64_t RoutingFees_hash(const struct LDKRoutingFees *NONNULL_PTR o);
24182 * Serialize the RoutingFees object into a byte array which can be read by RoutingFees_read
24184 struct LDKCVec_u8Z RoutingFees_write(const struct LDKRoutingFees *NONNULL_PTR obj);
24187 * Read a RoutingFees from a byte array, created by RoutingFees_write
24189 struct LDKCResult_RoutingFeesDecodeErrorZ RoutingFees_read(struct LDKu8slice ser);
24192 * Frees any resources used by the NodeAnnouncementInfo, if is_owned is set and inner is non-NULL.
24194 void NodeAnnouncementInfo_free(struct LDKNodeAnnouncementInfo this_obj);
24197 * Protocol features the node announced support for
24199 struct LDKNodeFeatures NodeAnnouncementInfo_get_features(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
24202 * Protocol features the node announced support for
24204 void NodeAnnouncementInfo_set_features(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
24207 * When the last known update to the node state was issued.
24208 * Value is opaque, as set in the announcement.
24210 uint32_t NodeAnnouncementInfo_get_last_update(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
24213 * When the last known update to the node state was issued.
24214 * Value is opaque, as set in the announcement.
24216 void NodeAnnouncementInfo_set_last_update(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, uint32_t val);
24219 * Color assigned to the node
24221 const uint8_t (*NodeAnnouncementInfo_get_rgb(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr))[3];
24224 * Color assigned to the node
24226 void NodeAnnouncementInfo_set_rgb(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKThreeBytes val);
24229 * Moniker assigned to the node.
24230 * May be invalid or malicious (eg control chars),
24231 * should not be exposed to the user.
24233 const uint8_t (*NodeAnnouncementInfo_get_alias(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr))[32];
24236 * Moniker assigned to the node.
24237 * May be invalid or malicious (eg control chars),
24238 * should not be exposed to the user.
24240 void NodeAnnouncementInfo_set_alias(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
24243 * Internet-level addresses via which one can connect to the node
24245 void NodeAnnouncementInfo_set_addresses(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKCVec_NetAddressZ val);
24248 * An initial announcement of the node
24249 * Mostly redundant with the data we store in fields explicitly.
24250 * Everything else is useful only for sending out for initial routing sync.
24251 * Not stored if contains excess data to prevent DoS.
24253 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24255 struct LDKNodeAnnouncement NodeAnnouncementInfo_get_announcement_message(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
24258 * An initial announcement of the node
24259 * Mostly redundant with the data we store in fields explicitly.
24260 * Everything else is useful only for sending out for initial routing sync.
24261 * Not stored if contains excess data to prevent DoS.
24263 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
24265 void NodeAnnouncementInfo_set_announcement_message(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKNodeAnnouncement val);
24268 * Constructs a new NodeAnnouncementInfo given each field
24270 MUST_USE_RES struct LDKNodeAnnouncementInfo NodeAnnouncementInfo_new(struct LDKNodeFeatures features_arg, uint32_t last_update_arg, struct LDKThreeBytes rgb_arg, struct LDKThirtyTwoBytes alias_arg, struct LDKCVec_NetAddressZ addresses_arg, struct LDKNodeAnnouncement announcement_message_arg);
24273 * Creates a copy of the NodeAnnouncementInfo
24275 struct LDKNodeAnnouncementInfo NodeAnnouncementInfo_clone(const struct LDKNodeAnnouncementInfo *NONNULL_PTR orig);
24278 * Serialize the NodeAnnouncementInfo object into a byte array which can be read by NodeAnnouncementInfo_read
24280 struct LDKCVec_u8Z NodeAnnouncementInfo_write(const struct LDKNodeAnnouncementInfo *NONNULL_PTR obj);
24283 * Read a NodeAnnouncementInfo from a byte array, created by NodeAnnouncementInfo_write
24285 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ NodeAnnouncementInfo_read(struct LDKu8slice ser);
24288 * Frees any resources used by the NodeInfo, if is_owned is set and inner is non-NULL.
24290 void NodeInfo_free(struct LDKNodeInfo this_obj);
24293 * All valid channels a node has announced
24295 void NodeInfo_set_channels(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
24298 * Lowest fees enabling routing via any of the enabled, known channels to a node.
24299 * The two fields (flat and proportional fee) are independent,
24300 * meaning they don't have to refer to the same channel.
24302 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24304 struct LDKRoutingFees NodeInfo_get_lowest_inbound_channel_fees(const struct LDKNodeInfo *NONNULL_PTR this_ptr);
24307 * Lowest fees enabling routing via any of the enabled, known channels to a node.
24308 * The two fields (flat and proportional fee) are independent,
24309 * meaning they don't have to refer to the same channel.
24311 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
24313 void NodeInfo_set_lowest_inbound_channel_fees(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
24316 * More information about a node from node_announcement.
24317 * Optional because we store a Node entry after learning about it from
24318 * a channel announcement, but before receiving a node announcement.
24320 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24322 struct LDKNodeAnnouncementInfo NodeInfo_get_announcement_info(const struct LDKNodeInfo *NONNULL_PTR this_ptr);
24325 * More information about a node from node_announcement.
24326 * Optional because we store a Node entry after learning about it from
24327 * a channel announcement, but before receiving a node announcement.
24329 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
24331 void NodeInfo_set_announcement_info(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKNodeAnnouncementInfo val);
24334 * Constructs a new NodeInfo given each field
24336 MUST_USE_RES struct LDKNodeInfo NodeInfo_new(struct LDKCVec_u64Z channels_arg, struct LDKRoutingFees lowest_inbound_channel_fees_arg, struct LDKNodeAnnouncementInfo announcement_info_arg);
24339 * Creates a copy of the NodeInfo
24341 struct LDKNodeInfo NodeInfo_clone(const struct LDKNodeInfo *NONNULL_PTR orig);
24344 * Serialize the NodeInfo object into a byte array which can be read by NodeInfo_read
24346 struct LDKCVec_u8Z NodeInfo_write(const struct LDKNodeInfo *NONNULL_PTR obj);
24349 * Read a NodeInfo from a byte array, created by NodeInfo_write
24351 struct LDKCResult_NodeInfoDecodeErrorZ NodeInfo_read(struct LDKu8slice ser);
24354 * Serialize the NetworkGraph object into a byte array which can be read by NetworkGraph_read
24356 struct LDKCVec_u8Z NetworkGraph_write(const struct LDKNetworkGraph *NONNULL_PTR obj);
24359 * Read a NetworkGraph from a byte array, created by NetworkGraph_write
24361 struct LDKCResult_NetworkGraphDecodeErrorZ NetworkGraph_read(struct LDKu8slice ser);
24364 * Creates a new, empty, network graph.
24366 MUST_USE_RES struct LDKNetworkGraph NetworkGraph_new(struct LDKThirtyTwoBytes genesis_hash);
24369 * Returns a read-only view of the network graph.
24371 MUST_USE_RES struct LDKReadOnlyNetworkGraph NetworkGraph_read_only(const struct LDKNetworkGraph *NONNULL_PTR this_arg);
24374 * For an already known node (from channel announcements), update its stored properties from a
24375 * given node announcement.
24377 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
24378 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
24379 * routing messages from a source using a protocol other than the lightning P2P protocol.
24381 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_node_from_announcement(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKNodeAnnouncement *NONNULL_PTR msg);
24384 * For an already known node (from channel announcements), update its stored properties from a
24385 * given node announcement without verifying the associated signatures. Because we aren't
24386 * given the associated signatures here we cannot relay the node announcement to any of our
24389 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_node_from_unsigned_announcement(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR msg);
24392 * Store or update channel info from a channel announcement.
24394 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
24395 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
24396 * routing messages from a source using a protocol other than the lightning P2P protocol.
24398 * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
24399 * the corresponding UTXO exists on chain and is correctly-formatted.
24401 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel_from_announcement(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKChannelAnnouncement *NONNULL_PTR msg, struct LDKCOption_AccessZ chain_access);
24404 * Store or update channel info from a channel announcement without verifying the associated
24405 * signatures. Because we aren't given the associated signatures here we cannot relay the
24406 * channel announcement to any of our peers.
24408 * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
24409 * the corresponding UTXO exists on chain and is correctly-formatted.
24411 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel_from_unsigned_announcement(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR msg, struct LDKCOption_AccessZ chain_access);
24414 * Close a channel if a corresponding HTLC fail was sent.
24415 * If permanent, removes a channel from the local storage.
24416 * May cause the removal of nodes too, if this was their last channel.
24417 * If not permanent, makes channels unavailable for routing.
24419 void NetworkGraph_close_channel_from_update(const struct LDKNetworkGraph *NONNULL_PTR this_arg, uint64_t short_channel_id, bool is_permanent);
24422 * Marks a node in the graph as failed.
24424 void NetworkGraph_fail_node(const struct LDKNetworkGraph *NONNULL_PTR this_arg, struct LDKPublicKey _node_id, bool is_permanent);
24427 * Removes information about channels that we haven't heard any updates about in some time.
24428 * This can be used regularly to prune the network graph of channels that likely no longer
24431 * While there is no formal requirement that nodes regularly re-broadcast their channel
24432 * updates every two weeks, the non-normative section of BOLT 7 currently suggests that
24433 * pruning occur for updates which are at least two weeks old, which we implement here.
24435 * Note that for users of the `lightning-background-processor` crate this method may be
24436 * automatically called regularly for you.
24438 * This method is only available with the `std` feature. See
24439 * [`NetworkGraph::remove_stale_channels_with_time`] for `no-std` use.
24441 void NetworkGraph_remove_stale_channels(const struct LDKNetworkGraph *NONNULL_PTR this_arg);
24444 * Removes information about channels that we haven't heard any updates about in some time.
24445 * This can be used regularly to prune the network graph of channels that likely no longer
24448 * While there is no formal requirement that nodes regularly re-broadcast their channel
24449 * updates every two weeks, the non-normative section of BOLT 7 currently suggests that
24450 * pruning occur for updates which are at least two weeks old, which we implement here.
24452 * This function takes the current unix time as an argument. For users with the `std` feature
24453 * enabled, [`NetworkGraph::remove_stale_channels`] may be preferable.
24455 void NetworkGraph_remove_stale_channels_with_time(const struct LDKNetworkGraph *NONNULL_PTR this_arg, uint64_t current_time_unix);
24458 * For an already known (from announcement) channel, update info about one of the directions
24461 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
24462 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
24463 * routing messages from a source using a protocol other than the lightning P2P protocol.
24465 * If built with `no-std`, any updates with a timestamp more than two weeks in the past or
24466 * materially in the future will be rejected.
24468 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKChannelUpdate *NONNULL_PTR msg);
24471 * For an already known (from announcement) channel, update info about one of the directions
24472 * of the channel without verifying the associated signatures. Because we aren't given the
24473 * associated signatures here we cannot relay the channel update to any of our peers.
24475 * If built with `no-std`, any updates with a timestamp more than two weeks in the past or
24476 * materially in the future will be rejected.
24478 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel_unsigned(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKUnsignedChannelUpdate *NONNULL_PTR msg);
24481 * Get network addresses by node id.
24482 * Returns None if the requested node is completely unknown,
24483 * or if node announcement for the node was never received.
24485 MUST_USE_RES struct LDKCOption_CVec_NetAddressZZ ReadOnlyNetworkGraph_get_addresses(const struct LDKReadOnlyNetworkGraph *NONNULL_PTR this_arg, struct LDKPublicKey pubkey);
24488 * Frees any resources used by the RouteHop, if is_owned is set and inner is non-NULL.
24490 void RouteHop_free(struct LDKRouteHop this_obj);
24493 * The node_id of the node at this hop.
24495 struct LDKPublicKey RouteHop_get_pubkey(const struct LDKRouteHop *NONNULL_PTR this_ptr);
24498 * The node_id of the node at this hop.
24500 void RouteHop_set_pubkey(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKPublicKey val);
24503 * The node_announcement features of the node at this hop. For the last hop, these may be
24504 * amended to match the features present in the invoice this node generated.
24506 struct LDKNodeFeatures RouteHop_get_node_features(const struct LDKRouteHop *NONNULL_PTR this_ptr);
24509 * The node_announcement features of the node at this hop. For the last hop, these may be
24510 * amended to match the features present in the invoice this node generated.
24512 void RouteHop_set_node_features(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
24515 * The channel that should be used from the previous hop to reach this node.
24517 uint64_t RouteHop_get_short_channel_id(const struct LDKRouteHop *NONNULL_PTR this_ptr);
24520 * The channel that should be used from the previous hop to reach this node.
24522 void RouteHop_set_short_channel_id(struct LDKRouteHop *NONNULL_PTR this_ptr, uint64_t val);
24525 * The channel_announcement features of the channel that should be used from the previous hop
24526 * to reach this node.
24528 struct LDKChannelFeatures RouteHop_get_channel_features(const struct LDKRouteHop *NONNULL_PTR this_ptr);
24531 * The channel_announcement features of the channel that should be used from the previous hop
24532 * to reach this node.
24534 void RouteHop_set_channel_features(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
24537 * The fee taken on this hop (for paying for the use of the *next* channel in the path).
24538 * For the last hop, this should be the full value of the payment (might be more than
24539 * requested if we had to match htlc_minimum_msat).
24541 uint64_t RouteHop_get_fee_msat(const struct LDKRouteHop *NONNULL_PTR this_ptr);
24544 * The fee taken on this hop (for paying for the use of the *next* channel in the path).
24545 * For the last hop, this should be the full value of the payment (might be more than
24546 * requested if we had to match htlc_minimum_msat).
24548 void RouteHop_set_fee_msat(struct LDKRouteHop *NONNULL_PTR this_ptr, uint64_t val);
24551 * The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
24552 * expected at the destination, in excess of the current block height.
24554 uint32_t RouteHop_get_cltv_expiry_delta(const struct LDKRouteHop *NONNULL_PTR this_ptr);
24557 * The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
24558 * expected at the destination, in excess of the current block height.
24560 void RouteHop_set_cltv_expiry_delta(struct LDKRouteHop *NONNULL_PTR this_ptr, uint32_t val);
24563 * Constructs a new RouteHop given each field
24565 MUST_USE_RES struct LDKRouteHop RouteHop_new(struct LDKPublicKey pubkey_arg, struct LDKNodeFeatures node_features_arg, uint64_t short_channel_id_arg, struct LDKChannelFeatures channel_features_arg, uint64_t fee_msat_arg, uint32_t cltv_expiry_delta_arg);
24568 * Creates a copy of the RouteHop
24570 struct LDKRouteHop RouteHop_clone(const struct LDKRouteHop *NONNULL_PTR orig);
24573 * Checks if two RouteHops contain equal inner contents.
24575 uint64_t RouteHop_hash(const struct LDKRouteHop *NONNULL_PTR o);
24578 * Checks if two RouteHops contain equal inner contents.
24579 * This ignores pointers and is_owned flags and looks at the values in fields.
24580 * Two objects with NULL inner values will be considered "equal" here.
24582 bool RouteHop_eq(const struct LDKRouteHop *NONNULL_PTR a, const struct LDKRouteHop *NONNULL_PTR b);
24585 * Serialize the RouteHop object into a byte array which can be read by RouteHop_read
24587 struct LDKCVec_u8Z RouteHop_write(const struct LDKRouteHop *NONNULL_PTR obj);
24590 * Read a RouteHop from a byte array, created by RouteHop_write
24592 struct LDKCResult_RouteHopDecodeErrorZ RouteHop_read(struct LDKu8slice ser);
24595 * Frees any resources used by the Route, if is_owned is set and inner is non-NULL.
24597 void Route_free(struct LDKRoute this_obj);
24600 * The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
24601 * last RouteHop in each path must be the same.
24602 * Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
24603 * destination. Thus, this must always be at least length one. While the maximum length of any
24604 * given path is variable, keeping the length of any path to less than 20 should currently
24605 * ensure it is viable.
24607 struct LDKCVec_CVec_RouteHopZZ Route_get_paths(const struct LDKRoute *NONNULL_PTR this_ptr);
24610 * The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
24611 * last RouteHop in each path must be the same.
24612 * Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
24613 * destination. Thus, this must always be at least length one. While the maximum length of any
24614 * given path is variable, keeping the length of any path to less than 20 should currently
24615 * ensure it is viable.
24617 void Route_set_paths(struct LDKRoute *NONNULL_PTR this_ptr, struct LDKCVec_CVec_RouteHopZZ val);
24620 * The `payment_params` parameter passed to [`find_route`].
24621 * This is used by `ChannelManager` to track information which may be required for retries,
24622 * provided back to you via [`Event::PaymentPathFailed`].
24624 * [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
24626 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24628 struct LDKPaymentParameters Route_get_payment_params(const struct LDKRoute *NONNULL_PTR this_ptr);
24631 * The `payment_params` parameter passed to [`find_route`].
24632 * This is used by `ChannelManager` to track information which may be required for retries,
24633 * provided back to you via [`Event::PaymentPathFailed`].
24635 * [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
24637 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
24639 void Route_set_payment_params(struct LDKRoute *NONNULL_PTR this_ptr, struct LDKPaymentParameters val);
24642 * Constructs a new Route given each field
24644 MUST_USE_RES struct LDKRoute Route_new(struct LDKCVec_CVec_RouteHopZZ paths_arg, struct LDKPaymentParameters payment_params_arg);
24647 * Creates a copy of the Route
24649 struct LDKRoute Route_clone(const struct LDKRoute *NONNULL_PTR orig);
24652 * Checks if two Routes contain equal inner contents.
24654 uint64_t Route_hash(const struct LDKRoute *NONNULL_PTR o);
24657 * Checks if two Routes contain equal inner contents.
24658 * This ignores pointers and is_owned flags and looks at the values in fields.
24659 * Two objects with NULL inner values will be considered "equal" here.
24661 bool Route_eq(const struct LDKRoute *NONNULL_PTR a, const struct LDKRoute *NONNULL_PTR b);
24664 * Returns the total amount of fees paid on this [`Route`].
24666 * This doesn't include any extra payment made to the recipient, which can happen in excess of
24667 * the amount passed to [`find_route`]'s `params.final_value_msat`.
24669 MUST_USE_RES uint64_t Route_get_total_fees(const struct LDKRoute *NONNULL_PTR this_arg);
24672 * Returns the total amount paid on this [`Route`], excluding the fees.
24674 MUST_USE_RES uint64_t Route_get_total_amount(const struct LDKRoute *NONNULL_PTR this_arg);
24677 * Serialize the Route object into a byte array which can be read by Route_read
24679 struct LDKCVec_u8Z Route_write(const struct LDKRoute *NONNULL_PTR obj);
24682 * Read a Route from a byte array, created by Route_write
24684 struct LDKCResult_RouteDecodeErrorZ Route_read(struct LDKu8slice ser);
24687 * Frees any resources used by the RouteParameters, if is_owned is set and inner is non-NULL.
24689 void RouteParameters_free(struct LDKRouteParameters this_obj);
24692 * The parameters of the failed payment path.
24694 struct LDKPaymentParameters RouteParameters_get_payment_params(const struct LDKRouteParameters *NONNULL_PTR this_ptr);
24697 * The parameters of the failed payment path.
24699 void RouteParameters_set_payment_params(struct LDKRouteParameters *NONNULL_PTR this_ptr, struct LDKPaymentParameters val);
24702 * The amount in msats sent on the failed payment path.
24704 uint64_t RouteParameters_get_final_value_msat(const struct LDKRouteParameters *NONNULL_PTR this_ptr);
24707 * The amount in msats sent on the failed payment path.
24709 void RouteParameters_set_final_value_msat(struct LDKRouteParameters *NONNULL_PTR this_ptr, uint64_t val);
24712 * The CLTV on the final hop of the failed payment path.
24714 uint32_t RouteParameters_get_final_cltv_expiry_delta(const struct LDKRouteParameters *NONNULL_PTR this_ptr);
24717 * The CLTV on the final hop of the failed payment path.
24719 void RouteParameters_set_final_cltv_expiry_delta(struct LDKRouteParameters *NONNULL_PTR this_ptr, uint32_t val);
24722 * Constructs a new RouteParameters given each field
24724 MUST_USE_RES struct LDKRouteParameters RouteParameters_new(struct LDKPaymentParameters payment_params_arg, uint64_t final_value_msat_arg, uint32_t final_cltv_expiry_delta_arg);
24727 * Creates a copy of the RouteParameters
24729 struct LDKRouteParameters RouteParameters_clone(const struct LDKRouteParameters *NONNULL_PTR orig);
24732 * Serialize the RouteParameters object into a byte array which can be read by RouteParameters_read
24734 struct LDKCVec_u8Z RouteParameters_write(const struct LDKRouteParameters *NONNULL_PTR obj);
24737 * Read a RouteParameters from a byte array, created by RouteParameters_write
24739 struct LDKCResult_RouteParametersDecodeErrorZ RouteParameters_read(struct LDKu8slice ser);
24742 * Frees any resources used by the PaymentParameters, if is_owned is set and inner is non-NULL.
24744 void PaymentParameters_free(struct LDKPaymentParameters this_obj);
24747 * The node id of the payee.
24749 struct LDKPublicKey PaymentParameters_get_payee_pubkey(const struct LDKPaymentParameters *NONNULL_PTR this_ptr);
24752 * The node id of the payee.
24754 void PaymentParameters_set_payee_pubkey(struct LDKPaymentParameters *NONNULL_PTR this_ptr, struct LDKPublicKey val);
24757 * Features supported by the payee.
24759 * May be set from the payee's invoice or via [`for_keysend`]. May be `None` if the invoice
24760 * does not contain any features.
24762 * [`for_keysend`]: Self::for_keysend
24764 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24766 struct LDKInvoiceFeatures PaymentParameters_get_features(const struct LDKPaymentParameters *NONNULL_PTR this_ptr);
24769 * Features supported by the payee.
24771 * May be set from the payee's invoice or via [`for_keysend`]. May be `None` if the invoice
24772 * does not contain any features.
24774 * [`for_keysend`]: Self::for_keysend
24776 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
24778 void PaymentParameters_set_features(struct LDKPaymentParameters *NONNULL_PTR this_ptr, struct LDKInvoiceFeatures val);
24781 * Hints for routing to the payee, containing channels connecting the payee to public nodes.
24783 struct LDKCVec_RouteHintZ PaymentParameters_get_route_hints(const struct LDKPaymentParameters *NONNULL_PTR this_ptr);
24786 * Hints for routing to the payee, containing channels connecting the payee to public nodes.
24788 void PaymentParameters_set_route_hints(struct LDKPaymentParameters *NONNULL_PTR this_ptr, struct LDKCVec_RouteHintZ val);
24791 * Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
24793 struct LDKCOption_u64Z PaymentParameters_get_expiry_time(const struct LDKPaymentParameters *NONNULL_PTR this_ptr);
24796 * Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
24798 void PaymentParameters_set_expiry_time(struct LDKPaymentParameters *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
24801 * The maximum total CLTV delta we accept for the route.
24803 uint32_t PaymentParameters_get_max_total_cltv_expiry_delta(const struct LDKPaymentParameters *NONNULL_PTR this_ptr);
24806 * The maximum total CLTV delta we accept for the route.
24808 void PaymentParameters_set_max_total_cltv_expiry_delta(struct LDKPaymentParameters *NONNULL_PTR this_ptr, uint32_t val);
24811 * Constructs a new PaymentParameters given each field
24813 MUST_USE_RES struct LDKPaymentParameters PaymentParameters_new(struct LDKPublicKey payee_pubkey_arg, struct LDKInvoiceFeatures features_arg, struct LDKCVec_RouteHintZ route_hints_arg, struct LDKCOption_u64Z expiry_time_arg, uint32_t max_total_cltv_expiry_delta_arg);
24816 * Creates a copy of the PaymentParameters
24818 struct LDKPaymentParameters PaymentParameters_clone(const struct LDKPaymentParameters *NONNULL_PTR orig);
24821 * Checks if two PaymentParameterss contain equal inner contents.
24823 uint64_t PaymentParameters_hash(const struct LDKPaymentParameters *NONNULL_PTR o);
24826 * Checks if two PaymentParameterss contain equal inner contents.
24827 * This ignores pointers and is_owned flags and looks at the values in fields.
24828 * Two objects with NULL inner values will be considered "equal" here.
24830 bool PaymentParameters_eq(const struct LDKPaymentParameters *NONNULL_PTR a, const struct LDKPaymentParameters *NONNULL_PTR b);
24833 * Serialize the PaymentParameters object into a byte array which can be read by PaymentParameters_read
24835 struct LDKCVec_u8Z PaymentParameters_write(const struct LDKPaymentParameters *NONNULL_PTR obj);
24838 * Read a PaymentParameters from a byte array, created by PaymentParameters_write
24840 struct LDKCResult_PaymentParametersDecodeErrorZ PaymentParameters_read(struct LDKu8slice ser);
24843 * Creates a payee with the node id of the given `pubkey`.
24845 MUST_USE_RES struct LDKPaymentParameters PaymentParameters_from_node_id(struct LDKPublicKey payee_pubkey);
24848 * Creates a payee with the node id of the given `pubkey` to use for keysend payments.
24850 MUST_USE_RES struct LDKPaymentParameters PaymentParameters_for_keysend(struct LDKPublicKey payee_pubkey);
24853 * Frees any resources used by the RouteHint, if is_owned is set and inner is non-NULL.
24855 void RouteHint_free(struct LDKRouteHint this_obj);
24857 struct LDKCVec_RouteHintHopZ RouteHint_get_a(const struct LDKRouteHint *NONNULL_PTR this_ptr);
24859 void RouteHint_set_a(struct LDKRouteHint *NONNULL_PTR this_ptr, struct LDKCVec_RouteHintHopZ val);
24862 * Constructs a new RouteHint given each field
24864 MUST_USE_RES struct LDKRouteHint RouteHint_new(struct LDKCVec_RouteHintHopZ a_arg);
24867 * Creates a copy of the RouteHint
24869 struct LDKRouteHint RouteHint_clone(const struct LDKRouteHint *NONNULL_PTR orig);
24872 * Checks if two RouteHints contain equal inner contents.
24874 uint64_t RouteHint_hash(const struct LDKRouteHint *NONNULL_PTR o);
24877 * Checks if two RouteHints contain equal inner contents.
24878 * This ignores pointers and is_owned flags and looks at the values in fields.
24879 * Two objects with NULL inner values will be considered "equal" here.
24881 bool RouteHint_eq(const struct LDKRouteHint *NONNULL_PTR a, const struct LDKRouteHint *NONNULL_PTR b);
24884 * Serialize the RouteHint object into a byte array which can be read by RouteHint_read
24886 struct LDKCVec_u8Z RouteHint_write(const struct LDKRouteHint *NONNULL_PTR obj);
24889 * Read a RouteHint from a byte array, created by RouteHint_write
24891 struct LDKCResult_RouteHintDecodeErrorZ RouteHint_read(struct LDKu8slice ser);
24894 * Frees any resources used by the RouteHintHop, if is_owned is set and inner is non-NULL.
24896 void RouteHintHop_free(struct LDKRouteHintHop this_obj);
24899 * The node_id of the non-target end of the route
24901 struct LDKPublicKey RouteHintHop_get_src_node_id(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
24904 * The node_id of the non-target end of the route
24906 void RouteHintHop_set_src_node_id(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKPublicKey val);
24909 * The short_channel_id of this channel
24911 uint64_t RouteHintHop_get_short_channel_id(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
24914 * The short_channel_id of this channel
24916 void RouteHintHop_set_short_channel_id(struct LDKRouteHintHop *NONNULL_PTR this_ptr, uint64_t val);
24919 * The fees which must be paid to use this channel
24921 struct LDKRoutingFees RouteHintHop_get_fees(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
24924 * The fees which must be paid to use this channel
24926 void RouteHintHop_set_fees(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
24929 * The difference in CLTV values between this node and the next node.
24931 uint16_t RouteHintHop_get_cltv_expiry_delta(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
24934 * The difference in CLTV values between this node and the next node.
24936 void RouteHintHop_set_cltv_expiry_delta(struct LDKRouteHintHop *NONNULL_PTR this_ptr, uint16_t val);
24939 * The minimum value, in msat, which must be relayed to the next hop.
24941 struct LDKCOption_u64Z RouteHintHop_get_htlc_minimum_msat(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
24944 * The minimum value, in msat, which must be relayed to the next hop.
24946 void RouteHintHop_set_htlc_minimum_msat(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
24949 * The maximum value in msat available for routing with a single HTLC.
24951 struct LDKCOption_u64Z RouteHintHop_get_htlc_maximum_msat(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
24954 * The maximum value in msat available for routing with a single HTLC.
24956 void RouteHintHop_set_htlc_maximum_msat(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
24959 * Constructs a new RouteHintHop given each field
24961 MUST_USE_RES struct LDKRouteHintHop RouteHintHop_new(struct LDKPublicKey src_node_id_arg, uint64_t short_channel_id_arg, struct LDKRoutingFees fees_arg, uint16_t cltv_expiry_delta_arg, struct LDKCOption_u64Z htlc_minimum_msat_arg, struct LDKCOption_u64Z htlc_maximum_msat_arg);
24964 * Creates a copy of the RouteHintHop
24966 struct LDKRouteHintHop RouteHintHop_clone(const struct LDKRouteHintHop *NONNULL_PTR orig);
24969 * Checks if two RouteHintHops contain equal inner contents.
24971 uint64_t RouteHintHop_hash(const struct LDKRouteHintHop *NONNULL_PTR o);
24974 * Checks if two RouteHintHops contain equal inner contents.
24975 * This ignores pointers and is_owned flags and looks at the values in fields.
24976 * Two objects with NULL inner values will be considered "equal" here.
24978 bool RouteHintHop_eq(const struct LDKRouteHintHop *NONNULL_PTR a, const struct LDKRouteHintHop *NONNULL_PTR b);
24981 * Serialize the RouteHintHop object into a byte array which can be read by RouteHintHop_read
24983 struct LDKCVec_u8Z RouteHintHop_write(const struct LDKRouteHintHop *NONNULL_PTR obj);
24986 * Read a RouteHintHop from a byte array, created by RouteHintHop_write
24988 struct LDKCResult_RouteHintHopDecodeErrorZ RouteHintHop_read(struct LDKu8slice ser);
24991 * Finds a route from us (payer) to the given target node (payee).
24993 * If the payee provided features in their invoice, they should be provided via `params.payee`.
24994 * Without this, MPP will only be used if the payee's features are available in the network graph.
24996 * Private routing paths between a public node and the target may be included in `params.payee`.
24998 * If some channels aren't announced, it may be useful to fill in `first_hops` with the results
24999 * from [`ChannelManager::list_usable_channels`]. If it is filled in, the view of our local
25000 * channels from [`NetworkGraph`] will be ignored, and only those in `first_hops` will be used.
25002 * The fees on channels from us to the next hop are ignored as they are assumed to all be equal.
25003 * However, the enabled/disabled bit on such channels as well as the `htlc_minimum_msat` /
25004 * `htlc_maximum_msat` *are* checked as they may change based on the receiving node.
25008 * May be used to re-compute a [`Route`] when handling a [`Event::PaymentPathFailed`]. Any
25009 * adjustments to the [`NetworkGraph`] and channel scores should be made prior to calling this
25014 * Panics if first_hops contains channels without short_channel_ids;
25015 * [`ChannelManager::list_usable_channels`] will never include such channels.
25017 * [`ChannelManager::list_usable_channels`]: crate::ln::channelmanager::ChannelManager::list_usable_channels
25018 * [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
25020 * Note that first_hops (or a relevant inner pointer) may be NULL or all-0s to represent None
25022 struct LDKCResult_RouteLightningErrorZ find_route(struct LDKPublicKey our_node_pubkey, const struct LDKRouteParameters *NONNULL_PTR route_params, const struct LDKNetworkGraph *NONNULL_PTR network, struct LDKCVec_ChannelDetailsZ *first_hops, struct LDKLogger logger, const struct LDKScore *NONNULL_PTR scorer);
25025 * Calls the free function if one is set
25027 void Score_free(struct LDKScore this_ptr);
25030 * Calls the free function if one is set
25032 void LockableScore_free(struct LDKLockableScore this_ptr);
25035 * Frees any resources used by the MultiThreadedLockableScore, if is_owned is set and inner is non-NULL.
25037 void MultiThreadedLockableScore_free(struct LDKMultiThreadedLockableScore this_obj);
25040 * Creates a new [`MultiThreadedLockableScore`] given an underlying [`Score`].
25042 MUST_USE_RES struct LDKMultiThreadedLockableScore MultiThreadedLockableScore_new(struct LDKScore score);
25045 * Frees any resources used by the FixedPenaltyScorer, if is_owned is set and inner is non-NULL.
25047 void FixedPenaltyScorer_free(struct LDKFixedPenaltyScorer this_obj);
25050 * Serialize the FixedPenaltyScorer object into a byte array which can be read by FixedPenaltyScorer_read
25052 struct LDKCVec_u8Z FixedPenaltyScorer_write(const struct LDKFixedPenaltyScorer *NONNULL_PTR obj);
25055 * Read a FixedPenaltyScorer from a byte array, created by FixedPenaltyScorer_write
25057 struct LDKCResult_FixedPenaltyScorerDecodeErrorZ FixedPenaltyScorer_read(struct LDKu8slice ser);
25060 * Creates a new scorer using `penalty_msat`.
25062 MUST_USE_RES struct LDKFixedPenaltyScorer FixedPenaltyScorer_with_penalty(uint64_t penalty_msat);
25065 * Constructs a new Score which calls the relevant methods on this_arg.
25066 * This copies the `inner` pointer in this_arg and thus the returned Score must be freed before this_arg is
25068 struct LDKScore FixedPenaltyScorer_as_Score(const struct LDKFixedPenaltyScorer *NONNULL_PTR this_arg);
25071 * Frees any resources used by the Scorer, if is_owned is set and inner is non-NULL.
25073 void Scorer_free(struct LDKScorer this_obj);
25076 * Frees any resources used by the ScoringParameters, if is_owned is set and inner is non-NULL.
25078 void ScoringParameters_free(struct LDKScoringParameters this_obj);
25081 * A fixed penalty in msats to apply to each channel.
25083 * Default value: 500 msat
25085 uint64_t ScoringParameters_get_base_penalty_msat(const struct LDKScoringParameters *NONNULL_PTR this_ptr);
25088 * A fixed penalty in msats to apply to each channel.
25090 * Default value: 500 msat
25092 void ScoringParameters_set_base_penalty_msat(struct LDKScoringParameters *NONNULL_PTR this_ptr, uint64_t val);
25095 * A penalty in msats to apply to a channel upon failing to relay a payment.
25097 * This accumulates for each failure but may be reduced over time based on
25098 * [`failure_penalty_half_life`] or when successfully routing through a channel.
25100 * Default value: 1,024,000 msat
25102 * [`failure_penalty_half_life`]: Self::failure_penalty_half_life
25104 uint64_t ScoringParameters_get_failure_penalty_msat(const struct LDKScoringParameters *NONNULL_PTR this_ptr);
25107 * A penalty in msats to apply to a channel upon failing to relay a payment.
25109 * This accumulates for each failure but may be reduced over time based on
25110 * [`failure_penalty_half_life`] or when successfully routing through a channel.
25112 * Default value: 1,024,000 msat
25114 * [`failure_penalty_half_life`]: Self::failure_penalty_half_life
25116 void ScoringParameters_set_failure_penalty_msat(struct LDKScoringParameters *NONNULL_PTR this_ptr, uint64_t val);
25119 * When the amount being sent over a channel is this many 1024ths of the total channel
25120 * capacity, we begin applying [`overuse_penalty_msat_per_1024th`].
25122 * Default value: 128 1024ths (i.e. begin penalizing when an HTLC uses 1/8th of a channel)
25124 * [`overuse_penalty_msat_per_1024th`]: Self::overuse_penalty_msat_per_1024th
25126 uint16_t ScoringParameters_get_overuse_penalty_start_1024th(const struct LDKScoringParameters *NONNULL_PTR this_ptr);
25129 * When the amount being sent over a channel is this many 1024ths of the total channel
25130 * capacity, we begin applying [`overuse_penalty_msat_per_1024th`].
25132 * Default value: 128 1024ths (i.e. begin penalizing when an HTLC uses 1/8th of a channel)
25134 * [`overuse_penalty_msat_per_1024th`]: Self::overuse_penalty_msat_per_1024th
25136 void ScoringParameters_set_overuse_penalty_start_1024th(struct LDKScoringParameters *NONNULL_PTR this_ptr, uint16_t val);
25139 * A penalty applied, per whole 1024ths of the channel capacity which the amount being sent
25140 * over the channel exceeds [`overuse_penalty_start_1024th`] by.
25142 * Default value: 20 msat (i.e. 2560 msat penalty to use 1/4th of a channel, 7680 msat penalty
25143 * to use half a channel, and 12,560 msat penalty to use 3/4ths of a channel)
25145 * [`overuse_penalty_start_1024th`]: Self::overuse_penalty_start_1024th
25147 uint64_t ScoringParameters_get_overuse_penalty_msat_per_1024th(const struct LDKScoringParameters *NONNULL_PTR this_ptr);
25150 * A penalty applied, per whole 1024ths of the channel capacity which the amount being sent
25151 * over the channel exceeds [`overuse_penalty_start_1024th`] by.
25153 * Default value: 20 msat (i.e. 2560 msat penalty to use 1/4th of a channel, 7680 msat penalty
25154 * to use half a channel, and 12,560 msat penalty to use 3/4ths of a channel)
25156 * [`overuse_penalty_start_1024th`]: Self::overuse_penalty_start_1024th
25158 void ScoringParameters_set_overuse_penalty_msat_per_1024th(struct LDKScoringParameters *NONNULL_PTR this_ptr, uint64_t val);
25161 * The time required to elapse before any accumulated [`failure_penalty_msat`] penalties are
25164 * Successfully routing through a channel will immediately cut the penalty in half as well.
25166 * Default value: 1 hour
25170 * When built with the `no-std` feature, time will never elapse. Therefore, this penalty will
25173 * [`failure_penalty_msat`]: Self::failure_penalty_msat
25175 uint64_t ScoringParameters_get_failure_penalty_half_life(const struct LDKScoringParameters *NONNULL_PTR this_ptr);
25178 * The time required to elapse before any accumulated [`failure_penalty_msat`] penalties are
25181 * Successfully routing through a channel will immediately cut the penalty in half as well.
25183 * Default value: 1 hour
25187 * When built with the `no-std` feature, time will never elapse. Therefore, this penalty will
25190 * [`failure_penalty_msat`]: Self::failure_penalty_msat
25192 void ScoringParameters_set_failure_penalty_half_life(struct LDKScoringParameters *NONNULL_PTR this_ptr, uint64_t val);
25195 * Constructs a new ScoringParameters given each field
25197 MUST_USE_RES struct LDKScoringParameters ScoringParameters_new(uint64_t base_penalty_msat_arg, uint64_t failure_penalty_msat_arg, uint16_t overuse_penalty_start_1024th_arg, uint64_t overuse_penalty_msat_per_1024th_arg, uint64_t failure_penalty_half_life_arg);
25200 * Serialize the ScoringParameters object into a byte array which can be read by ScoringParameters_read
25202 struct LDKCVec_u8Z ScoringParameters_write(const struct LDKScoringParameters *NONNULL_PTR obj);
25205 * Read a ScoringParameters from a byte array, created by ScoringParameters_write
25207 struct LDKCResult_ScoringParametersDecodeErrorZ ScoringParameters_read(struct LDKu8slice ser);
25210 * Creates a new scorer using the given scoring parameters.
25212 MUST_USE_RES struct LDKScorer Scorer_new(struct LDKScoringParameters params);
25215 * Creates a "default" Scorer. See struct and individual field documentaiton for details on which values are used.
25217 MUST_USE_RES struct LDKScorer Scorer_default(void);
25220 * Creates a "default" ScoringParameters. See struct and individual field documentaiton for details on which values are used.
25222 MUST_USE_RES struct LDKScoringParameters ScoringParameters_default(void);
25225 * Constructs a new Score which calls the relevant methods on this_arg.
25226 * This copies the `inner` pointer in this_arg and thus the returned Score must be freed before this_arg is
25228 struct LDKScore Scorer_as_Score(const struct LDKScorer *NONNULL_PTR this_arg);
25231 * Serialize the Scorer object into a byte array which can be read by Scorer_read
25233 struct LDKCVec_u8Z Scorer_write(const struct LDKScorer *NONNULL_PTR obj);
25236 * Read a Scorer from a byte array, created by Scorer_write
25238 struct LDKCResult_ScorerDecodeErrorZ Scorer_read(struct LDKu8slice ser);
25241 * Frees any resources used by the ProbabilisticScoringParameters, if is_owned is set and inner is non-NULL.
25243 void ProbabilisticScoringParameters_free(struct LDKProbabilisticScoringParameters this_obj);
25246 * A multiplier used to determine the amount in msats willing to be paid to avoid routing
25247 * through a channel, as per multiplying by the negative `log10` of the channel's success
25248 * probability for a payment.
25250 * The success probability is determined by the effective channel capacity, the payment amount,
25251 * and knowledge learned from prior successful and unsuccessful payments. The lower bound of
25252 * the success probability is 0.01, effectively limiting the penalty to the range
25253 * `0..=2*liquidity_penalty_multiplier_msat`. The knowledge learned is decayed over time based
25254 * on [`liquidity_offset_half_life`].
25256 * Default value: 10,000 msat
25258 * [`liquidity_offset_half_life`]: Self::liquidity_offset_half_life
25260 uint64_t ProbabilisticScoringParameters_get_liquidity_penalty_multiplier_msat(const struct LDKProbabilisticScoringParameters *NONNULL_PTR this_ptr);
25263 * A multiplier used to determine the amount in msats willing to be paid to avoid routing
25264 * through a channel, as per multiplying by the negative `log10` of the channel's success
25265 * probability for a payment.
25267 * The success probability is determined by the effective channel capacity, the payment amount,
25268 * and knowledge learned from prior successful and unsuccessful payments. The lower bound of
25269 * the success probability is 0.01, effectively limiting the penalty to the range
25270 * `0..=2*liquidity_penalty_multiplier_msat`. The knowledge learned is decayed over time based
25271 * on [`liquidity_offset_half_life`].
25273 * Default value: 10,000 msat
25275 * [`liquidity_offset_half_life`]: Self::liquidity_offset_half_life
25277 void ProbabilisticScoringParameters_set_liquidity_penalty_multiplier_msat(struct LDKProbabilisticScoringParameters *NONNULL_PTR this_ptr, uint64_t val);
25280 * The time required to elapse before any knowledge learned about channel liquidity balances is
25283 * The bounds are defined in terms of offsets and are initially zero. Increasing the offsets
25284 * gives tighter bounds on the channel liquidity balance. Thus, halving the offsets decreases
25285 * the certainty of the channel liquidity balance.
25287 * Default value: 1 hour
25291 * When built with the `no-std` feature, time will never elapse. Therefore, the channel
25292 * liquidity knowledge will never decay except when the bounds cross.
25294 uint64_t ProbabilisticScoringParameters_get_liquidity_offset_half_life(const struct LDKProbabilisticScoringParameters *NONNULL_PTR this_ptr);
25297 * The time required to elapse before any knowledge learned about channel liquidity balances is
25300 * The bounds are defined in terms of offsets and are initially zero. Increasing the offsets
25301 * gives tighter bounds on the channel liquidity balance. Thus, halving the offsets decreases
25302 * the certainty of the channel liquidity balance.
25304 * Default value: 1 hour
25308 * When built with the `no-std` feature, time will never elapse. Therefore, the channel
25309 * liquidity knowledge will never decay except when the bounds cross.
25311 void ProbabilisticScoringParameters_set_liquidity_offset_half_life(struct LDKProbabilisticScoringParameters *NONNULL_PTR this_ptr, uint64_t val);
25314 * Constructs a new ProbabilisticScoringParameters given each field
25316 MUST_USE_RES struct LDKProbabilisticScoringParameters ProbabilisticScoringParameters_new(uint64_t liquidity_penalty_multiplier_msat_arg, uint64_t liquidity_offset_half_life_arg);
25319 * Creates a copy of the ProbabilisticScoringParameters
25321 struct LDKProbabilisticScoringParameters ProbabilisticScoringParameters_clone(const struct LDKProbabilisticScoringParameters *NONNULL_PTR orig);
25324 * Serialize the ProbabilisticScoringParameters object into a byte array which can be read by ProbabilisticScoringParameters_read
25326 struct LDKCVec_u8Z ProbabilisticScoringParameters_write(const struct LDKProbabilisticScoringParameters *NONNULL_PTR obj);
25329 * Read a ProbabilisticScoringParameters from a byte array, created by ProbabilisticScoringParameters_write
25331 struct LDKCResult_ProbabilisticScoringParametersDecodeErrorZ ProbabilisticScoringParameters_read(struct LDKu8slice ser);
25334 * Creates a "default" ProbabilisticScoringParameters. See struct and individual field documentaiton for details on which values are used.
25336 MUST_USE_RES struct LDKProbabilisticScoringParameters ProbabilisticScoringParameters_default(void);
25339 * Frees any resources used by the FilesystemPersister, if is_owned is set and inner is non-NULL.
25341 void FilesystemPersister_free(struct LDKFilesystemPersister this_obj);
25344 * Initialize a new FilesystemPersister and set the path to the individual channels'
25347 MUST_USE_RES struct LDKFilesystemPersister FilesystemPersister_new(struct LDKStr path_to_channel_data);
25350 * Get the directory which was provided when this persister was initialized.
25352 MUST_USE_RES struct LDKStr FilesystemPersister_get_data_dir(const struct LDKFilesystemPersister *NONNULL_PTR this_arg);
25355 * Writes the provided `ChannelManager` to the path provided at `FilesystemPersister`
25356 * initialization, within a file called \"manager\".
25358 MUST_USE_RES struct LDKCResult_NoneErrorZ FilesystemPersister_persist_manager(struct LDKStr data_dir, const struct LDKChannelManager *NONNULL_PTR manager);
25361 * Read `ChannelMonitor`s from disk.
25363 MUST_USE_RES struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ FilesystemPersister_read_channelmonitors(const struct LDKFilesystemPersister *NONNULL_PTR this_arg, struct LDKKeysInterface keys_manager);
25366 * Constructs a new Persist which calls the relevant methods on this_arg.
25367 * This copies the `inner` pointer in this_arg and thus the returned Persist must be freed before this_arg is
25369 struct LDKPersist FilesystemPersister_as_Persist(const struct LDKFilesystemPersister *NONNULL_PTR this_arg);
25372 * Frees any resources used by the BackgroundProcessor, if is_owned is set and inner is non-NULL.
25374 void BackgroundProcessor_free(struct LDKBackgroundProcessor this_obj);
25377 * Calls the free function if one is set
25379 void ChannelManagerPersister_free(struct LDKChannelManagerPersister this_ptr);
25382 * Start a background thread that takes care of responsibilities enumerated in the [top-level
25385 * The thread runs indefinitely unless the object is dropped, [`stop`] is called, or
25386 * `persist_manager` returns an error. In case of an error, the error is retrieved by calling
25387 * either [`join`] or [`stop`].
25389 * # Data Persistence
25391 * `persist_manager` is responsible for writing out the [`ChannelManager`] to disk, and/or
25392 * uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
25393 * [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
25394 * provided implementation.
25396 * Typically, users should either implement [`ChannelManagerPersister`] to never return an
25397 * error or call [`join`] and handle any error that may arise. For the latter case,
25398 * `BackgroundProcessor` must be restarted by calling `start` again after handling the error.
25402 * `event_handler` is responsible for handling events that users should be notified of (e.g.,
25403 * payment failed). [`BackgroundProcessor`] may decorate the given [`EventHandler`] with common
25404 * functionality implemented by other handlers.
25405 * * [`NetGraphMsgHandler`] if given will update the [`NetworkGraph`] based on payment failures.
25407 * [top-level documentation]: BackgroundProcessor
25408 * [`join`]: Self::join
25409 * [`stop`]: Self::stop
25410 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
25411 * [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
25412 * [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
25413 * [`NetworkGraph`]: lightning::routing::network_graph::NetworkGraph
25415 * Note that net_graph_msg_handler (or a relevant inner pointer) may be NULL or all-0s to represent None
25417 MUST_USE_RES struct LDKBackgroundProcessor BackgroundProcessor_start(struct LDKChannelManagerPersister persister, struct LDKEventHandler event_handler, const struct LDKChainMonitor *NONNULL_PTR chain_monitor, const struct LDKChannelManager *NONNULL_PTR channel_manager, struct LDKNetGraphMsgHandler net_graph_msg_handler, const struct LDKPeerManager *NONNULL_PTR peer_manager, struct LDKLogger logger);
25420 * Join `BackgroundProcessor`'s thread, returning any error that occurred while persisting
25421 * [`ChannelManager`].
25425 * This function panics if the background thread has panicked such as while persisting or
25428 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
25430 MUST_USE_RES struct LDKCResult_NoneErrorZ BackgroundProcessor_join(struct LDKBackgroundProcessor this_arg);
25433 * Stop `BackgroundProcessor`'s thread, returning any error that occurred while persisting
25434 * [`ChannelManager`].
25438 * This function panics if the background thread has panicked such as while persisting or
25441 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
25443 MUST_USE_RES struct LDKCResult_NoneErrorZ BackgroundProcessor_stop(struct LDKBackgroundProcessor this_arg);
25446 * Frees any resources used by the Invoice, if is_owned is set and inner is non-NULL.
25448 void Invoice_free(struct LDKInvoice this_obj);
25451 * Checks if two Invoices contain equal inner contents.
25452 * This ignores pointers and is_owned flags and looks at the values in fields.
25453 * Two objects with NULL inner values will be considered "equal" here.
25455 bool Invoice_eq(const struct LDKInvoice *NONNULL_PTR a, const struct LDKInvoice *NONNULL_PTR b);
25458 * Creates a copy of the Invoice
25460 struct LDKInvoice Invoice_clone(const struct LDKInvoice *NONNULL_PTR orig);
25463 * Frees any resources used by the SignedRawInvoice, if is_owned is set and inner is non-NULL.
25465 void SignedRawInvoice_free(struct LDKSignedRawInvoice this_obj);
25468 * Checks if two SignedRawInvoices contain equal inner contents.
25469 * This ignores pointers and is_owned flags and looks at the values in fields.
25470 * Two objects with NULL inner values will be considered "equal" here.
25472 bool SignedRawInvoice_eq(const struct LDKSignedRawInvoice *NONNULL_PTR a, const struct LDKSignedRawInvoice *NONNULL_PTR b);
25475 * Creates a copy of the SignedRawInvoice
25477 struct LDKSignedRawInvoice SignedRawInvoice_clone(const struct LDKSignedRawInvoice *NONNULL_PTR orig);
25480 * Frees any resources used by the RawInvoice, if is_owned is set and inner is non-NULL.
25482 void RawInvoice_free(struct LDKRawInvoice this_obj);
25487 struct LDKRawDataPart RawInvoice_get_data(const struct LDKRawInvoice *NONNULL_PTR this_ptr);
25492 void RawInvoice_set_data(struct LDKRawInvoice *NONNULL_PTR this_ptr, struct LDKRawDataPart val);
25495 * Checks if two RawInvoices contain equal inner contents.
25496 * This ignores pointers and is_owned flags and looks at the values in fields.
25497 * Two objects with NULL inner values will be considered "equal" here.
25499 bool RawInvoice_eq(const struct LDKRawInvoice *NONNULL_PTR a, const struct LDKRawInvoice *NONNULL_PTR b);
25502 * Creates a copy of the RawInvoice
25504 struct LDKRawInvoice RawInvoice_clone(const struct LDKRawInvoice *NONNULL_PTR orig);
25507 * Frees any resources used by the RawDataPart, if is_owned is set and inner is non-NULL.
25509 void RawDataPart_free(struct LDKRawDataPart this_obj);
25512 * generation time of the invoice
25514 struct LDKPositiveTimestamp RawDataPart_get_timestamp(const struct LDKRawDataPart *NONNULL_PTR this_ptr);
25517 * generation time of the invoice
25519 void RawDataPart_set_timestamp(struct LDKRawDataPart *NONNULL_PTR this_ptr, struct LDKPositiveTimestamp val);
25522 * Checks if two RawDataParts contain equal inner contents.
25523 * This ignores pointers and is_owned flags and looks at the values in fields.
25524 * Two objects with NULL inner values will be considered "equal" here.
25526 bool RawDataPart_eq(const struct LDKRawDataPart *NONNULL_PTR a, const struct LDKRawDataPart *NONNULL_PTR b);
25529 * Creates a copy of the RawDataPart
25531 struct LDKRawDataPart RawDataPart_clone(const struct LDKRawDataPart *NONNULL_PTR orig);
25534 * Frees any resources used by the PositiveTimestamp, if is_owned is set and inner is non-NULL.
25536 void PositiveTimestamp_free(struct LDKPositiveTimestamp this_obj);
25539 * Checks if two PositiveTimestamps contain equal inner contents.
25540 * This ignores pointers and is_owned flags and looks at the values in fields.
25541 * Two objects with NULL inner values will be considered "equal" here.
25543 bool PositiveTimestamp_eq(const struct LDKPositiveTimestamp *NONNULL_PTR a, const struct LDKPositiveTimestamp *NONNULL_PTR b);
25546 * Creates a copy of the PositiveTimestamp
25548 struct LDKPositiveTimestamp PositiveTimestamp_clone(const struct LDKPositiveTimestamp *NONNULL_PTR orig);
25551 * Creates a copy of the SiPrefix
25553 enum LDKSiPrefix SiPrefix_clone(const enum LDKSiPrefix *NONNULL_PTR orig);
25556 * Utility method to constructs a new Milli-variant SiPrefix
25558 enum LDKSiPrefix SiPrefix_milli(void);
25561 * Utility method to constructs a new Micro-variant SiPrefix
25563 enum LDKSiPrefix SiPrefix_micro(void);
25566 * Utility method to constructs a new Nano-variant SiPrefix
25568 enum LDKSiPrefix SiPrefix_nano(void);
25571 * Utility method to constructs a new Pico-variant SiPrefix
25573 enum LDKSiPrefix SiPrefix_pico(void);
25576 * Checks if two SiPrefixs contain equal inner contents.
25577 * This ignores pointers and is_owned flags and looks at the values in fields.
25579 bool SiPrefix_eq(const enum LDKSiPrefix *NONNULL_PTR a, const enum LDKSiPrefix *NONNULL_PTR b);
25582 * Returns the multiplier to go from a BTC value to picoBTC implied by this SiPrefix.
25583 * This is effectively 10^12 * the prefix multiplier
25585 MUST_USE_RES uint64_t SiPrefix_multiplier(const enum LDKSiPrefix *NONNULL_PTR this_arg);
25588 * Creates a copy of the Currency
25590 enum LDKCurrency Currency_clone(const enum LDKCurrency *NONNULL_PTR orig);
25593 * Utility method to constructs a new Bitcoin-variant Currency
25595 enum LDKCurrency Currency_bitcoin(void);
25598 * Utility method to constructs a new BitcoinTestnet-variant Currency
25600 enum LDKCurrency Currency_bitcoin_testnet(void);
25603 * Utility method to constructs a new Regtest-variant Currency
25605 enum LDKCurrency Currency_regtest(void);
25608 * Utility method to constructs a new Simnet-variant Currency
25610 enum LDKCurrency Currency_simnet(void);
25613 * Utility method to constructs a new Signet-variant Currency
25615 enum LDKCurrency Currency_signet(void);
25618 * Checks if two Currencys contain equal inner contents.
25620 uint64_t Currency_hash(const enum LDKCurrency *NONNULL_PTR o);
25623 * Checks if two Currencys contain equal inner contents.
25624 * This ignores pointers and is_owned flags and looks at the values in fields.
25626 bool Currency_eq(const enum LDKCurrency *NONNULL_PTR a, const enum LDKCurrency *NONNULL_PTR b);
25629 * Frees any resources used by the Sha256, if is_owned is set and inner is non-NULL.
25631 void Sha256_free(struct LDKSha256 this_obj);
25634 * Creates a copy of the Sha256
25636 struct LDKSha256 Sha256_clone(const struct LDKSha256 *NONNULL_PTR orig);
25639 * Checks if two Sha256s contain equal inner contents.
25641 uint64_t Sha256_hash(const struct LDKSha256 *NONNULL_PTR o);
25644 * Checks if two Sha256s contain equal inner contents.
25645 * This ignores pointers and is_owned flags and looks at the values in fields.
25646 * Two objects with NULL inner values will be considered "equal" here.
25648 bool Sha256_eq(const struct LDKSha256 *NONNULL_PTR a, const struct LDKSha256 *NONNULL_PTR b);
25651 * Frees any resources used by the Description, if is_owned is set and inner is non-NULL.
25653 void Description_free(struct LDKDescription this_obj);
25656 * Creates a copy of the Description
25658 struct LDKDescription Description_clone(const struct LDKDescription *NONNULL_PTR orig);
25661 * Checks if two Descriptions contain equal inner contents.
25663 uint64_t Description_hash(const struct LDKDescription *NONNULL_PTR o);
25666 * Checks if two Descriptions contain equal inner contents.
25667 * This ignores pointers and is_owned flags and looks at the values in fields.
25668 * Two objects with NULL inner values will be considered "equal" here.
25670 bool Description_eq(const struct LDKDescription *NONNULL_PTR a, const struct LDKDescription *NONNULL_PTR b);
25673 * Frees any resources used by the PayeePubKey, if is_owned is set and inner is non-NULL.
25675 void PayeePubKey_free(struct LDKPayeePubKey this_obj);
25677 struct LDKPublicKey PayeePubKey_get_a(const struct LDKPayeePubKey *NONNULL_PTR this_ptr);
25679 void PayeePubKey_set_a(struct LDKPayeePubKey *NONNULL_PTR this_ptr, struct LDKPublicKey val);
25682 * Constructs a new PayeePubKey given each field
25684 MUST_USE_RES struct LDKPayeePubKey PayeePubKey_new(struct LDKPublicKey a_arg);
25687 * Creates a copy of the PayeePubKey
25689 struct LDKPayeePubKey PayeePubKey_clone(const struct LDKPayeePubKey *NONNULL_PTR orig);
25692 * Checks if two PayeePubKeys contain equal inner contents.
25694 uint64_t PayeePubKey_hash(const struct LDKPayeePubKey *NONNULL_PTR o);
25697 * Checks if two PayeePubKeys contain equal inner contents.
25698 * This ignores pointers and is_owned flags and looks at the values in fields.
25699 * Two objects with NULL inner values will be considered "equal" here.
25701 bool PayeePubKey_eq(const struct LDKPayeePubKey *NONNULL_PTR a, const struct LDKPayeePubKey *NONNULL_PTR b);
25704 * Frees any resources used by the ExpiryTime, if is_owned is set and inner is non-NULL.
25706 void ExpiryTime_free(struct LDKExpiryTime this_obj);
25709 * Creates a copy of the ExpiryTime
25711 struct LDKExpiryTime ExpiryTime_clone(const struct LDKExpiryTime *NONNULL_PTR orig);
25714 * Checks if two ExpiryTimes contain equal inner contents.
25716 uint64_t ExpiryTime_hash(const struct LDKExpiryTime *NONNULL_PTR o);
25719 * Checks if two ExpiryTimes contain equal inner contents.
25720 * This ignores pointers and is_owned flags and looks at the values in fields.
25721 * Two objects with NULL inner values will be considered "equal" here.
25723 bool ExpiryTime_eq(const struct LDKExpiryTime *NONNULL_PTR a, const struct LDKExpiryTime *NONNULL_PTR b);
25726 * Frees any resources used by the MinFinalCltvExpiry, if is_owned is set and inner is non-NULL.
25728 void MinFinalCltvExpiry_free(struct LDKMinFinalCltvExpiry this_obj);
25730 uint64_t MinFinalCltvExpiry_get_a(const struct LDKMinFinalCltvExpiry *NONNULL_PTR this_ptr);
25732 void MinFinalCltvExpiry_set_a(struct LDKMinFinalCltvExpiry *NONNULL_PTR this_ptr, uint64_t val);
25735 * Constructs a new MinFinalCltvExpiry given each field
25737 MUST_USE_RES struct LDKMinFinalCltvExpiry MinFinalCltvExpiry_new(uint64_t a_arg);
25740 * Creates a copy of the MinFinalCltvExpiry
25742 struct LDKMinFinalCltvExpiry MinFinalCltvExpiry_clone(const struct LDKMinFinalCltvExpiry *NONNULL_PTR orig);
25745 * Checks if two MinFinalCltvExpirys contain equal inner contents.
25747 uint64_t MinFinalCltvExpiry_hash(const struct LDKMinFinalCltvExpiry *NONNULL_PTR o);
25750 * Checks if two MinFinalCltvExpirys contain equal inner contents.
25751 * This ignores pointers and is_owned flags and looks at the values in fields.
25752 * Two objects with NULL inner values will be considered "equal" here.
25754 bool MinFinalCltvExpiry_eq(const struct LDKMinFinalCltvExpiry *NONNULL_PTR a, const struct LDKMinFinalCltvExpiry *NONNULL_PTR b);
25757 * Frees any resources used by the Fallback
25759 void Fallback_free(struct LDKFallback this_ptr);
25762 * Creates a copy of the Fallback
25764 struct LDKFallback Fallback_clone(const struct LDKFallback *NONNULL_PTR orig);
25767 * Utility method to constructs a new SegWitProgram-variant Fallback
25769 struct LDKFallback Fallback_seg_wit_program(struct LDKu5 version, struct LDKCVec_u8Z program);
25772 * Utility method to constructs a new PubKeyHash-variant Fallback
25774 struct LDKFallback Fallback_pub_key_hash(struct LDKTwentyBytes a);
25777 * Utility method to constructs a new ScriptHash-variant Fallback
25779 struct LDKFallback Fallback_script_hash(struct LDKTwentyBytes a);
25782 * Checks if two Fallbacks contain equal inner contents.
25784 uint64_t Fallback_hash(const struct LDKFallback *NONNULL_PTR o);
25787 * Checks if two Fallbacks contain equal inner contents.
25788 * This ignores pointers and is_owned flags and looks at the values in fields.
25790 bool Fallback_eq(const struct LDKFallback *NONNULL_PTR a, const struct LDKFallback *NONNULL_PTR b);
25793 * Frees any resources used by the InvoiceSignature, if is_owned is set and inner is non-NULL.
25795 void InvoiceSignature_free(struct LDKInvoiceSignature this_obj);
25798 * Creates a copy of the InvoiceSignature
25800 struct LDKInvoiceSignature InvoiceSignature_clone(const struct LDKInvoiceSignature *NONNULL_PTR orig);
25803 * Checks if two InvoiceSignatures contain equal inner contents.
25804 * This ignores pointers and is_owned flags and looks at the values in fields.
25805 * Two objects with NULL inner values will be considered "equal" here.
25807 bool InvoiceSignature_eq(const struct LDKInvoiceSignature *NONNULL_PTR a, const struct LDKInvoiceSignature *NONNULL_PTR b);
25810 * Frees any resources used by the PrivateRoute, if is_owned is set and inner is non-NULL.
25812 void PrivateRoute_free(struct LDKPrivateRoute this_obj);
25815 * Creates a copy of the PrivateRoute
25817 struct LDKPrivateRoute PrivateRoute_clone(const struct LDKPrivateRoute *NONNULL_PTR orig);
25820 * Checks if two PrivateRoutes contain equal inner contents.
25822 uint64_t PrivateRoute_hash(const struct LDKPrivateRoute *NONNULL_PTR o);
25825 * Checks if two PrivateRoutes contain equal inner contents.
25826 * This ignores pointers and is_owned flags and looks at the values in fields.
25827 * Two objects with NULL inner values will be considered "equal" here.
25829 bool PrivateRoute_eq(const struct LDKPrivateRoute *NONNULL_PTR a, const struct LDKPrivateRoute *NONNULL_PTR b);
25832 * Disassembles the `SignedRawInvoice` into its three parts:
25834 * 2. hash of the raw invoice
25837 MUST_USE_RES struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ SignedRawInvoice_into_parts(struct LDKSignedRawInvoice this_arg);
25840 * The `RawInvoice` which was signed.
25842 MUST_USE_RES struct LDKRawInvoice SignedRawInvoice_raw_invoice(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
25845 * The hash of the `RawInvoice` that was signed.
25847 MUST_USE_RES const uint8_t (*SignedRawInvoice_hash(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg))[32];
25850 * InvoiceSignature for the invoice.
25852 MUST_USE_RES struct LDKInvoiceSignature SignedRawInvoice_signature(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
25855 * Recovers the public key used for signing the invoice from the recoverable signature.
25857 MUST_USE_RES struct LDKCResult_PayeePubKeyErrorZ SignedRawInvoice_recover_payee_pub_key(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
25860 * Checks if the signature is valid for the included payee public key or if none exists if it's
25861 * valid for the recovered signature (which should always be true?).
25863 MUST_USE_RES bool SignedRawInvoice_check_signature(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
25866 * Calculate the hash of the encoded `RawInvoice`
25868 MUST_USE_RES struct LDKThirtyTwoBytes RawInvoice_hash(const struct LDKRawInvoice *NONNULL_PTR this_arg);
25872 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
25874 MUST_USE_RES struct LDKSha256 RawInvoice_payment_hash(const struct LDKRawInvoice *NONNULL_PTR this_arg);
25878 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
25880 MUST_USE_RES struct LDKDescription RawInvoice_description(const struct LDKRawInvoice *NONNULL_PTR this_arg);
25884 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
25886 MUST_USE_RES struct LDKPayeePubKey RawInvoice_payee_pub_key(const struct LDKRawInvoice *NONNULL_PTR this_arg);
25890 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
25892 MUST_USE_RES struct LDKSha256 RawInvoice_description_hash(const struct LDKRawInvoice *NONNULL_PTR this_arg);
25896 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
25898 MUST_USE_RES struct LDKExpiryTime RawInvoice_expiry_time(const struct LDKRawInvoice *NONNULL_PTR this_arg);
25902 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
25904 MUST_USE_RES struct LDKMinFinalCltvExpiry RawInvoice_min_final_cltv_expiry(const struct LDKRawInvoice *NONNULL_PTR this_arg);
25908 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
25910 MUST_USE_RES struct LDKThirtyTwoBytes RawInvoice_payment_secret(const struct LDKRawInvoice *NONNULL_PTR this_arg);
25914 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
25916 MUST_USE_RES struct LDKInvoiceFeatures RawInvoice_features(const struct LDKRawInvoice *NONNULL_PTR this_arg);
25918 MUST_USE_RES struct LDKCVec_PrivateRouteZ RawInvoice_private_routes(const struct LDKRawInvoice *NONNULL_PTR this_arg);
25920 MUST_USE_RES struct LDKCOption_u64Z RawInvoice_amount_pico_btc(const struct LDKRawInvoice *NONNULL_PTR this_arg);
25922 MUST_USE_RES enum LDKCurrency RawInvoice_currency(const struct LDKRawInvoice *NONNULL_PTR this_arg);
25925 * Creates a `PositiveTimestamp` from a Unix timestamp in the range `0..=MAX_TIMESTAMP`.
25927 * Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
25929 MUST_USE_RES struct LDKCResult_PositiveTimestampCreationErrorZ PositiveTimestamp_from_unix_timestamp(uint64_t unix_seconds);
25932 * Creates a `PositiveTimestamp` from a [`SystemTime`] with a corresponding Unix timestamp in
25933 * the range `0..=MAX_TIMESTAMP`.
25935 * Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
25937 MUST_USE_RES struct LDKCResult_PositiveTimestampCreationErrorZ PositiveTimestamp_from_system_time(uint64_t time);
25940 * Creates a `PositiveTimestamp` from a [`Duration`] since the Unix epoch in the range
25941 * `0..=MAX_TIMESTAMP`.
25943 * Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
25945 MUST_USE_RES struct LDKCResult_PositiveTimestampCreationErrorZ PositiveTimestamp_from_duration_since_epoch(uint64_t duration);
25948 * Returns the Unix timestamp representing the stored time
25950 MUST_USE_RES uint64_t PositiveTimestamp_as_unix_timestamp(const struct LDKPositiveTimestamp *NONNULL_PTR this_arg);
25953 * Returns the duration of the stored time since the Unix epoch
25955 MUST_USE_RES uint64_t PositiveTimestamp_as_duration_since_epoch(const struct LDKPositiveTimestamp *NONNULL_PTR this_arg);
25958 * Returns the [`SystemTime`] representing the stored time
25960 MUST_USE_RES uint64_t PositiveTimestamp_as_time(const struct LDKPositiveTimestamp *NONNULL_PTR this_arg);
25963 * Transform the `Invoice` into it's unchecked version
25965 MUST_USE_RES struct LDKSignedRawInvoice Invoice_into_signed_raw(struct LDKInvoice this_arg);
25968 * Check that the invoice is signed correctly and that key recovery works
25970 MUST_USE_RES struct LDKCResult_NoneSemanticErrorZ Invoice_check_signature(const struct LDKInvoice *NONNULL_PTR this_arg);
25973 * Constructs an `Invoice` from a `SignedRawInvoice` by checking all its invariants.
25975 * use lightning_invoice::*;
25977 * let invoice = \"lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\\
25978 * h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\\
25979 * 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\\
25980 * h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\\
25981 * j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\\
25982 * ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\\
25983 * guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\\
25984 * ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\\
25985 * p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\\
25986 * 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\\
25987 * j5r6drg6k6zcqj0fcwg\";
25989 * let signed = invoice.parse::<SignedRawInvoice>().unwrap();
25991 * assert!(Invoice::from_signed(signed).is_ok());
25994 MUST_USE_RES struct LDKCResult_InvoiceSemanticErrorZ Invoice_from_signed(struct LDKSignedRawInvoice signed_invoice);
25997 * Returns the `Invoice`'s timestamp (should equal its creation time)
25999 MUST_USE_RES uint64_t Invoice_timestamp(const struct LDKInvoice *NONNULL_PTR this_arg);
26002 * Returns the `Invoice`'s timestamp as a duration since the Unix epoch
26004 MUST_USE_RES uint64_t Invoice_duration_since_epoch(const struct LDKInvoice *NONNULL_PTR this_arg);
26007 * Returns the hash to which we will receive the preimage on completion of the payment
26009 MUST_USE_RES const uint8_t (*Invoice_payment_hash(const struct LDKInvoice *NONNULL_PTR this_arg))[32];
26012 * Get the payee's public key if one was included in the invoice
26014 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
26016 MUST_USE_RES struct LDKPublicKey Invoice_payee_pub_key(const struct LDKInvoice *NONNULL_PTR this_arg);
26019 * Get the payment secret if one was included in the invoice
26021 MUST_USE_RES const uint8_t (*Invoice_payment_secret(const struct LDKInvoice *NONNULL_PTR this_arg))[32];
26024 * Get the invoice features if they were included in the invoice
26026 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
26028 MUST_USE_RES struct LDKInvoiceFeatures Invoice_features(const struct LDKInvoice *NONNULL_PTR this_arg);
26031 * Recover the payee's public key (only to be used if none was included in the invoice)
26033 MUST_USE_RES struct LDKPublicKey Invoice_recover_payee_pub_key(const struct LDKInvoice *NONNULL_PTR this_arg);
26036 * Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
26038 MUST_USE_RES uint64_t Invoice_expiry_time(const struct LDKInvoice *NONNULL_PTR this_arg);
26041 * Returns whether the invoice has expired.
26043 MUST_USE_RES bool Invoice_is_expired(const struct LDKInvoice *NONNULL_PTR this_arg);
26046 * Returns whether the expiry time would pass at the given point in time.
26047 * `at_time` is the timestamp as a duration since the Unix epoch.
26049 MUST_USE_RES bool Invoice_would_expire(const struct LDKInvoice *NONNULL_PTR this_arg, uint64_t at_time);
26052 * Returns the invoice's `min_final_cltv_expiry` time, if present, otherwise
26053 * [`DEFAULT_MIN_FINAL_CLTV_EXPIRY`].
26055 MUST_USE_RES uint64_t Invoice_min_final_cltv_expiry(const struct LDKInvoice *NONNULL_PTR this_arg);
26058 * Returns a list of all routes included in the invoice
26060 MUST_USE_RES struct LDKCVec_PrivateRouteZ Invoice_private_routes(const struct LDKInvoice *NONNULL_PTR this_arg);
26063 * Returns a list of all routes included in the invoice as the underlying hints
26065 MUST_USE_RES struct LDKCVec_RouteHintZ Invoice_route_hints(const struct LDKInvoice *NONNULL_PTR this_arg);
26068 * Returns the currency for which the invoice was issued
26070 MUST_USE_RES enum LDKCurrency Invoice_currency(const struct LDKInvoice *NONNULL_PTR this_arg);
26073 * Returns the amount if specified in the invoice as millisatoshis.
26075 MUST_USE_RES struct LDKCOption_u64Z Invoice_amount_milli_satoshis(const struct LDKInvoice *NONNULL_PTR this_arg);
26078 * Creates a new `Description` if `description` is at most 1023 __bytes__ long,
26079 * returns `CreationError::DescriptionTooLong` otherwise
26081 * Please note that single characters may use more than one byte due to UTF8 encoding.
26083 MUST_USE_RES struct LDKCResult_DescriptionCreationErrorZ Description_new(struct LDKStr description);
26086 * Returns the underlying description `String`
26088 MUST_USE_RES struct LDKStr Description_into_inner(struct LDKDescription this_arg);
26091 * Construct an `ExpiryTime` from seconds.
26093 MUST_USE_RES struct LDKExpiryTime ExpiryTime_from_seconds(uint64_t seconds);
26096 * Construct an `ExpiryTime` from a `Duration`.
26098 MUST_USE_RES struct LDKExpiryTime ExpiryTime_from_duration(uint64_t duration);
26101 * Returns the expiry time in seconds
26103 MUST_USE_RES uint64_t ExpiryTime_as_seconds(const struct LDKExpiryTime *NONNULL_PTR this_arg);
26106 * Returns a reference to the underlying `Duration` (=expiry time)
26108 MUST_USE_RES uint64_t ExpiryTime_as_duration(const struct LDKExpiryTime *NONNULL_PTR this_arg);
26111 * Creates a new (partial) route from a list of hops
26113 MUST_USE_RES struct LDKCResult_PrivateRouteCreationErrorZ PrivateRoute_new(struct LDKRouteHint hops);
26116 * Returns the underlying list of hops
26118 MUST_USE_RES struct LDKRouteHint PrivateRoute_into_inner(struct LDKPrivateRoute this_arg);
26121 * Creates a copy of the CreationError
26123 enum LDKCreationError CreationError_clone(const enum LDKCreationError *NONNULL_PTR orig);
26126 * Utility method to constructs a new DescriptionTooLong-variant CreationError
26128 enum LDKCreationError CreationError_description_too_long(void);
26131 * Utility method to constructs a new RouteTooLong-variant CreationError
26133 enum LDKCreationError CreationError_route_too_long(void);
26136 * Utility method to constructs a new TimestampOutOfBounds-variant CreationError
26138 enum LDKCreationError CreationError_timestamp_out_of_bounds(void);
26141 * Utility method to constructs a new InvalidAmount-variant CreationError
26143 enum LDKCreationError CreationError_invalid_amount(void);
26146 * Utility method to constructs a new MissingRouteHints-variant CreationError
26148 enum LDKCreationError CreationError_missing_route_hints(void);
26151 * Checks if two CreationErrors contain equal inner contents.
26152 * This ignores pointers and is_owned flags and looks at the values in fields.
26154 bool CreationError_eq(const enum LDKCreationError *NONNULL_PTR a, const enum LDKCreationError *NONNULL_PTR b);
26157 * Get the string representation of a CreationError object
26159 struct LDKStr CreationError_to_str(const enum LDKCreationError *NONNULL_PTR o);
26162 * Creates a copy of the SemanticError
26164 enum LDKSemanticError SemanticError_clone(const enum LDKSemanticError *NONNULL_PTR orig);
26167 * Utility method to constructs a new NoPaymentHash-variant SemanticError
26169 enum LDKSemanticError SemanticError_no_payment_hash(void);
26172 * Utility method to constructs a new MultiplePaymentHashes-variant SemanticError
26174 enum LDKSemanticError SemanticError_multiple_payment_hashes(void);
26177 * Utility method to constructs a new NoDescription-variant SemanticError
26179 enum LDKSemanticError SemanticError_no_description(void);
26182 * Utility method to constructs a new MultipleDescriptions-variant SemanticError
26184 enum LDKSemanticError SemanticError_multiple_descriptions(void);
26187 * Utility method to constructs a new NoPaymentSecret-variant SemanticError
26189 enum LDKSemanticError SemanticError_no_payment_secret(void);
26192 * Utility method to constructs a new MultiplePaymentSecrets-variant SemanticError
26194 enum LDKSemanticError SemanticError_multiple_payment_secrets(void);
26197 * Utility method to constructs a new InvalidFeatures-variant SemanticError
26199 enum LDKSemanticError SemanticError_invalid_features(void);
26202 * Utility method to constructs a new InvalidRecoveryId-variant SemanticError
26204 enum LDKSemanticError SemanticError_invalid_recovery_id(void);
26207 * Utility method to constructs a new InvalidSignature-variant SemanticError
26209 enum LDKSemanticError SemanticError_invalid_signature(void);
26212 * Utility method to constructs a new ImpreciseAmount-variant SemanticError
26214 enum LDKSemanticError SemanticError_imprecise_amount(void);
26217 * Checks if two SemanticErrors contain equal inner contents.
26218 * This ignores pointers and is_owned flags and looks at the values in fields.
26220 bool SemanticError_eq(const enum LDKSemanticError *NONNULL_PTR a, const enum LDKSemanticError *NONNULL_PTR b);
26223 * Get the string representation of a SemanticError object
26225 struct LDKStr SemanticError_to_str(const enum LDKSemanticError *NONNULL_PTR o);
26228 * Frees any resources used by the SignOrCreationError
26230 void SignOrCreationError_free(struct LDKSignOrCreationError this_ptr);
26233 * Creates a copy of the SignOrCreationError
26235 struct LDKSignOrCreationError SignOrCreationError_clone(const struct LDKSignOrCreationError *NONNULL_PTR orig);
26238 * Utility method to constructs a new SignError-variant SignOrCreationError
26240 struct LDKSignOrCreationError SignOrCreationError_sign_error(void);
26243 * Utility method to constructs a new CreationError-variant SignOrCreationError
26245 struct LDKSignOrCreationError SignOrCreationError_creation_error(enum LDKCreationError a);
26248 * Checks if two SignOrCreationErrors contain equal inner contents.
26249 * This ignores pointers and is_owned flags and looks at the values in fields.
26251 bool SignOrCreationError_eq(const struct LDKSignOrCreationError *NONNULL_PTR a, const struct LDKSignOrCreationError *NONNULL_PTR b);
26254 * Get the string representation of a SignOrCreationError object
26256 struct LDKStr SignOrCreationError_to_str(const struct LDKSignOrCreationError *NONNULL_PTR o);
26259 * Frees any resources used by the InvoicePayer, if is_owned is set and inner is non-NULL.
26261 void InvoicePayer_free(struct LDKInvoicePayer this_obj);
26264 * Calls the free function if one is set
26266 void Payer_free(struct LDKPayer this_ptr);
26269 * Calls the free function if one is set
26271 void Router_free(struct LDKRouter this_ptr);
26274 * Frees any resources used by the RetryAttempts, if is_owned is set and inner is non-NULL.
26276 void RetryAttempts_free(struct LDKRetryAttempts this_obj);
26278 uintptr_t RetryAttempts_get_a(const struct LDKRetryAttempts *NONNULL_PTR this_ptr);
26280 void RetryAttempts_set_a(struct LDKRetryAttempts *NONNULL_PTR this_ptr, uintptr_t val);
26283 * Constructs a new RetryAttempts given each field
26285 MUST_USE_RES struct LDKRetryAttempts RetryAttempts_new(uintptr_t a_arg);
26288 * Creates a copy of the RetryAttempts
26290 struct LDKRetryAttempts RetryAttempts_clone(const struct LDKRetryAttempts *NONNULL_PTR orig);
26293 * Checks if two RetryAttemptss contain equal inner contents.
26294 * This ignores pointers and is_owned flags and looks at the values in fields.
26295 * Two objects with NULL inner values will be considered "equal" here.
26297 bool RetryAttempts_eq(const struct LDKRetryAttempts *NONNULL_PTR a, const struct LDKRetryAttempts *NONNULL_PTR b);
26300 * Checks if two RetryAttemptss contain equal inner contents.
26302 uint64_t RetryAttempts_hash(const struct LDKRetryAttempts *NONNULL_PTR o);
26305 * Frees any resources used by the PaymentError
26307 void PaymentError_free(struct LDKPaymentError this_ptr);
26310 * Creates a copy of the PaymentError
26312 struct LDKPaymentError PaymentError_clone(const struct LDKPaymentError *NONNULL_PTR orig);
26315 * Utility method to constructs a new Invoice-variant PaymentError
26317 struct LDKPaymentError PaymentError_invoice(struct LDKStr a);
26320 * Utility method to constructs a new Routing-variant PaymentError
26322 struct LDKPaymentError PaymentError_routing(struct LDKLightningError a);
26325 * Utility method to constructs a new Sending-variant PaymentError
26327 struct LDKPaymentError PaymentError_sending(struct LDKPaymentSendFailure a);
26330 * Creates an invoice payer that retries failed payment paths.
26332 * Will forward any [`Event::PaymentPathFailed`] events to the decorated `event_handler` once
26333 * `retry_attempts` has been exceeded for a given [`Invoice`].
26335 MUST_USE_RES struct LDKInvoicePayer InvoicePayer_new(struct LDKPayer payer, struct LDKRouter router, const struct LDKMultiThreadedLockableScore *NONNULL_PTR scorer, struct LDKLogger logger, struct LDKEventHandler event_handler, struct LDKRetryAttempts retry_attempts);
26338 * Pays the given [`Invoice`], caching it for later use in case a retry is needed.
26340 * You should ensure that the `invoice.payment_hash()` is unique and the same payment_hash has
26341 * never been paid before. Because [`InvoicePayer`] is stateless no effort is made to do so
26344 MUST_USE_RES struct LDKCResult_PaymentIdPaymentErrorZ InvoicePayer_pay_invoice(const struct LDKInvoicePayer *NONNULL_PTR this_arg, const struct LDKInvoice *NONNULL_PTR invoice);
26347 * Pays the given zero-value [`Invoice`] using the given amount, caching it for later use in
26348 * case a retry is needed.
26350 * You should ensure that the `invoice.payment_hash()` is unique and the same payment_hash has
26351 * never been paid before. Because [`InvoicePayer`] is stateless no effort is made to do so
26354 MUST_USE_RES struct LDKCResult_PaymentIdPaymentErrorZ InvoicePayer_pay_zero_value_invoice(const struct LDKInvoicePayer *NONNULL_PTR this_arg, const struct LDKInvoice *NONNULL_PTR invoice, uint64_t amount_msats);
26357 * Pays `pubkey` an amount using the hash of the given preimage, caching it for later use in
26358 * case a retry is needed.
26360 * You should ensure that `payment_preimage` is unique and that its `payment_hash` has never
26361 * been paid before. Because [`InvoicePayer`] is stateless no effort is made to do so for you.
26363 MUST_USE_RES struct LDKCResult_PaymentIdPaymentErrorZ InvoicePayer_pay_pubkey(const struct LDKInvoicePayer *NONNULL_PTR this_arg, struct LDKPublicKey pubkey, struct LDKThirtyTwoBytes payment_preimage, uint64_t amount_msats, uint32_t final_cltv_expiry_delta);
26366 * Removes the payment cached by the given payment hash.
26368 * Should be called once a payment has failed or succeeded if not using [`InvoicePayer`] as an
26369 * [`EventHandler`]. Otherwise, calling this method is unnecessary.
26371 void InvoicePayer_remove_cached_payment(const struct LDKInvoicePayer *NONNULL_PTR this_arg, const uint8_t (*payment_hash)[32]);
26374 * Constructs a new EventHandler which calls the relevant methods on this_arg.
26375 * This copies the `inner` pointer in this_arg and thus the returned EventHandler must be freed before this_arg is
26377 struct LDKEventHandler InvoicePayer_as_EventHandler(const struct LDKInvoicePayer *NONNULL_PTR this_arg);
26380 * Utility to create an invoice that can be paid to one of multiple nodes, or a \"phantom invoice.\"
26381 * See [`PhantomKeysManager`] for more information on phantom node payments.
26383 * `phantom_route_hints` parameter:
26384 * * Contains channel info for all nodes participating in the phantom invoice
26385 * * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each
26386 * participating node
26387 * * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is
26388 * updated when a channel becomes disabled or closes
26389 * * Note that if too many channels are included in [`PhantomRouteHints::channels`], the invoice
26390 * may be too long for QR code scanning. To fix this, `PhantomRouteHints::channels` may be pared
26393 * `payment_hash` and `payment_secret` come from [`ChannelManager::create_inbound_payment`] or
26394 * [`ChannelManager::create_inbound_payment_for_hash`]. These values can be retrieved from any
26395 * participating node.
26397 * Note that the provided `keys_manager`'s `KeysInterface` implementation must support phantom
26398 * invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
26401 * [`PhantomKeysManager`]: lightning::chain::keysinterface::PhantomKeysManager
26402 * [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints
26403 * [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels
26405 struct LDKCResult_InvoiceSignOrCreationErrorZ create_phantom_invoice(struct LDKCOption_u64Z amt_msat, struct LDKStr description, struct LDKThirtyTwoBytes payment_hash, struct LDKThirtyTwoBytes payment_secret, struct LDKCVec_PhantomRouteHintsZ phantom_route_hints, struct LDKKeysInterface keys_manager, enum LDKCurrency network);
26408 * Utility to construct an invoice. Generally, unless you want to do something like a custom
26409 * cltv_expiry, this is what you should be using to create an invoice. The reason being, this
26410 * method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
26411 * doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
26412 * that the payment secret is valid when the invoice is paid.
26414 struct LDKCResult_InvoiceSignOrCreationErrorZ create_invoice_from_channelmanager(const struct LDKChannelManager *NONNULL_PTR channelmanager, struct LDKKeysInterface keys_manager, enum LDKCurrency network, struct LDKCOption_u64Z amt_msat, struct LDKStr description);
26417 * See [`create_invoice_from_channelmanager`]
26418 * This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
26419 * available and the current time is supplied by the caller.
26421 struct LDKCResult_InvoiceSignOrCreationErrorZ create_invoice_from_channelmanager_and_duration_since_epoch(const struct LDKChannelManager *NONNULL_PTR channelmanager, struct LDKKeysInterface keys_manager, enum LDKCurrency network, struct LDKCOption_u64Z amt_msat, struct LDKStr description, uint64_t duration_since_epoch);
26424 * Frees any resources used by the DefaultRouter, if is_owned is set and inner is non-NULL.
26426 void DefaultRouter_free(struct LDKDefaultRouter this_obj);
26429 * Creates a new router using the given [`NetworkGraph`] and [`Logger`].
26431 MUST_USE_RES struct LDKDefaultRouter DefaultRouter_new(const struct LDKNetworkGraph *NONNULL_PTR network_graph, struct LDKLogger logger);
26434 * Constructs a new Router which calls the relevant methods on this_arg.
26435 * This copies the `inner` pointer in this_arg and thus the returned Router must be freed before this_arg is
26437 struct LDKRouter DefaultRouter_as_Router(const struct LDKDefaultRouter *NONNULL_PTR this_arg);
26440 * Constructs a new Payer which calls the relevant methods on this_arg.
26441 * This copies the `inner` pointer in this_arg and thus the returned Payer must be freed before this_arg is
26443 struct LDKPayer ChannelManager_as_Payer(const struct LDKChannelManager *NONNULL_PTR this_arg);
26446 * Read a SiPrefix object from a string
26448 struct LDKCResult_SiPrefixNoneZ SiPrefix_from_str(struct LDKStr s);
26451 * Read a Invoice object from a string
26453 struct LDKCResult_InvoiceNoneZ Invoice_from_str(struct LDKStr s);
26456 * Read a SignedRawInvoice object from a string
26458 struct LDKCResult_SignedRawInvoiceNoneZ SignedRawInvoice_from_str(struct LDKStr s);
26461 * Get the string representation of a Invoice object
26463 struct LDKStr Invoice_to_str(const struct LDKInvoice *NONNULL_PTR o);
26466 * Get the string representation of a SignedRawInvoice object
26468 struct LDKStr SignedRawInvoice_to_str(const struct LDKSignedRawInvoice *NONNULL_PTR o);
26471 * Get the string representation of a Currency object
26473 struct LDKStr Currency_to_str(const enum LDKCurrency *NONNULL_PTR o);
26476 * Get the string representation of a SiPrefix object
26478 struct LDKStr SiPrefix_to_str(const enum LDKSiPrefix *NONNULL_PTR o);
26480 #endif /* LDK_C_BINDINGS_H */
26482 #include "ldk_ver.h"