1 #ifndef LDK_C_BINDINGS_H
2 #define LDK_C_BINDINGS_H
4 /* Generated with cbindgen:0.17.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;
2774 * Features used within the channel_type field in an OpenChannel message.
2776 * A channel is always of some known \"type\", describing the transaction formats used and the exact
2777 * semantics of our interaction with our peer.
2779 * Note that because a channel is a specific type which is proposed by the opener and accepted by
2780 * the counterparty, only required features are allowed here.
2782 * This is serialized differently from other feature types - it is not prefixed by a length, and
2783 * thus must only appear inside a TLV where its length is known in advance.
2785 typedef struct MUST_USE_STRUCT LDKChannelTypeFeatures {
2787 * A pointer to the opaque Rust object.
2788 * Nearly everywhere, inner must be non-null, however in places where
2789 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2791 LDKnativeChannelTypeFeatures *inner;
2793 * Indicates that this is the only struct which contains the same pointer.
2794 * Rust functions which take ownership of an object provided via an argument require
2795 * this to be true and invalidate the object pointed to by inner.
2798 } LDKChannelTypeFeatures;
2801 * An Event which you should probably take some action in response to.
2803 * Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
2804 * them directly as they don't round-trip exactly (for example FundingGenerationReady is never
2805 * written as it makes no sense to respond to it after reconnecting to peers).
2807 typedef enum LDKEvent_Tag {
2809 * Used to indicate that the client should generate a funding transaction with the given
2810 * parameters and then call [`ChannelManager::funding_transaction_generated`].
2811 * Generated in [`ChannelManager`] message handling.
2812 * Note that *all inputs* in the funding transaction must spend SegWit outputs or your
2813 * counterparty can steal your funds!
2815 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
2816 * [`ChannelManager::funding_transaction_generated`]: crate::ln::channelmanager::ChannelManager::funding_transaction_generated
2818 LDKEvent_FundingGenerationReady,
2820 * Indicates we've received money! Just gotta dig out that payment preimage and feed it to
2821 * [`ChannelManager::claim_funds`] to get it....
2822 * Note that if the preimage is not known, you should call
2823 * [`ChannelManager::fail_htlc_backwards`] to free up resources for this HTLC and avoid
2824 * network congestion.
2825 * If you fail to call either [`ChannelManager::claim_funds`] or
2826 * [`ChannelManager::fail_htlc_backwards`] within the HTLC's timeout, the HTLC will be
2827 * automatically failed.
2830 * LDK will not stop an inbound payment from being paid multiple times, so multiple
2831 * `PaymentReceived` events may be generated for the same payment.
2833 * [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
2834 * [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
2836 LDKEvent_PaymentReceived,
2838 * Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
2839 * and we got back the payment preimage for it).
2841 * Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed`
2842 * event. In this situation, you SHOULD treat this payment as having succeeded.
2844 LDKEvent_PaymentSent,
2846 * Indicates an outbound HTLC we sent failed. Probably some intermediary node dropped
2847 * something. You may wish to retry with a different route.
2849 * Note that this does *not* indicate that all paths for an MPP payment have failed, see
2850 * [`Event::PaymentFailed`] and [`all_paths_failed`].
2852 * [`all_paths_failed`]: Self::PaymentPathFailed::all_paths_failed
2854 LDKEvent_PaymentPathFailed,
2856 * Indicates an outbound payment failed. Individual [`Event::PaymentPathFailed`] events
2857 * provide failure information for each MPP part in the payment.
2859 * This event is provided once there are no further pending HTLCs for the payment and the
2860 * payment is no longer retryable, either due to a several-block timeout or because
2861 * [`ChannelManager::abandon_payment`] was previously called for the corresponding payment.
2863 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
2865 LDKEvent_PaymentFailed,
2867 * Used to indicate that [`ChannelManager::process_pending_htlc_forwards`] should be called at
2868 * a time in the future.
2870 * [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
2872 LDKEvent_PendingHTLCsForwardable,
2874 * Used to indicate that an output which you should know how to spend was confirmed on chain
2875 * and is now spendable.
2876 * Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
2877 * counterparty spending them due to some kind of timeout. Thus, you need to store them
2878 * somewhere and spend them when you create on-chain transactions.
2880 LDKEvent_SpendableOutputs,
2882 * This event is generated when a payment has been successfully forwarded through us and a
2883 * forwarding fee earned.
2885 LDKEvent_PaymentForwarded,
2887 * Used to indicate that a channel with the given `channel_id` is in the process of closure.
2889 LDKEvent_ChannelClosed,
2891 * Used to indicate to the user that they can abandon the funding transaction and recycle the
2892 * inputs for another purpose.
2894 LDKEvent_DiscardFunding,
2896 * Indicates that a path for an outbound payment was successful.
2898 * Always generated after [`Event::PaymentSent`] and thus useful for scoring channels. See
2899 * [`Event::PaymentSent`] for obtaining the payment preimage.
2901 LDKEvent_PaymentPathSuccessful,
2903 * Indicates a request to open a new channel by a peer.
2905 * To accept the request, call [`ChannelManager::accept_inbound_channel`]. To reject the
2906 * request, call [`ChannelManager::force_close_channel`].
2908 * The event is only triggered when a new open channel request is received and the
2909 * [`UserConfig::manually_accept_inbound_channels`] config flag is set to true.
2911 * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
2912 * [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
2913 * [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
2915 LDKEvent_OpenChannelRequest,
2917 * Must be last for serialization purposes
2922 typedef struct LDKEvent_LDKFundingGenerationReady_Body {
2924 * The random channel_id we picked which you'll need to pass into
2925 * ChannelManager::funding_transaction_generated.
2927 struct LDKThirtyTwoBytes temporary_channel_id;
2929 * The value, in satoshis, that the output should have.
2931 uint64_t channel_value_satoshis;
2933 * The script which should be used in the transaction output.
2935 struct LDKCVec_u8Z output_script;
2937 * The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
2938 * an inbound channel.
2940 * [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
2942 uint64_t user_channel_id;
2943 } LDKEvent_LDKFundingGenerationReady_Body;
2945 typedef struct LDKEvent_LDKPaymentReceived_Body {
2947 * The hash for which the preimage should be handed to the ChannelManager. Note that LDK will
2948 * not stop you from registering duplicate payment hashes for inbound payments.
2950 struct LDKThirtyTwoBytes payment_hash;
2952 * The value, in thousandths of a satoshi, that this payment is for.
2956 * Information for claiming this received payment, based on whether the purpose of the
2957 * payment is to pay an invoice or to send a spontaneous payment.
2959 struct LDKPaymentPurpose purpose;
2960 } LDKEvent_LDKPaymentReceived_Body;
2962 typedef struct LDKEvent_LDKPaymentSent_Body {
2964 * The id returned by [`ChannelManager::send_payment`] and used with
2965 * [`ChannelManager::retry_payment`].
2967 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
2968 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
2970 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
2972 struct LDKThirtyTwoBytes payment_id;
2974 * The preimage to the hash given to ChannelManager::send_payment.
2975 * Note that this serves as a payment receipt, if you wish to have such a thing, you must
2978 struct LDKThirtyTwoBytes payment_preimage;
2980 * The hash that was given to [`ChannelManager::send_payment`].
2982 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
2984 struct LDKThirtyTwoBytes payment_hash;
2986 * The total fee which was spent at intermediate hops in this payment, across all paths.
2988 * Note that, like [`Route::get_total_fees`] this does *not* include any potential
2989 * overpayment to the recipient node.
2991 * If the recipient or an intermediate node misbehaves and gives us free money, this may
2992 * overstate the amount paid, though this is unlikely.
2994 * [`Route::get_total_fees`]: crate::routing::router::Route::get_total_fees
2996 struct LDKCOption_u64Z fee_paid_msat;
2997 } LDKEvent_LDKPaymentSent_Body;
2999 typedef struct LDKEvent_LDKPaymentPathFailed_Body {
3001 * The id returned by [`ChannelManager::send_payment`] and used with
3002 * [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
3004 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
3005 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
3006 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
3008 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
3010 struct LDKThirtyTwoBytes payment_id;
3012 * The hash that was given to [`ChannelManager::send_payment`].
3014 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
3016 struct LDKThirtyTwoBytes payment_hash;
3018 * Indicates the payment was rejected for some reason by the recipient. This implies that
3019 * the payment has failed, not just the route in question. If this is not set, you may
3020 * retry the payment via a different route.
3022 bool rejected_by_dest;
3024 * Any failure information conveyed via the Onion return packet by a node along the failed
3027 * Should be applied to the [`NetworkGraph`] so that routing decisions can take into
3028 * account the update. [`NetGraphMsgHandler`] is capable of doing this.
3030 * [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
3031 * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
3033 struct LDKCOption_NetworkUpdateZ network_update;
3035 * For both single-path and multi-path payments, this is set if all paths of the payment have
3036 * failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
3037 * larger MPP payment were still in flight when this event was generated.
3039 * Note that if you are retrying individual MPP parts, using this value to determine if a
3040 * payment has fully failed is race-y. Because multiple failures can happen prior to events
3041 * being processed, you may retry in response to a first failure, with a second failure
3042 * (with `all_paths_failed` set) still pending. Then, when the second failure is processed
3043 * you will see `all_paths_failed` set even though the retry of the first failure still
3044 * has an associated in-flight HTLC. See (1) for an example of such a failure.
3046 * If you wish to retry individual MPP parts and learn when a payment has failed, you must
3047 * call [`ChannelManager::abandon_payment`] and wait for a [`Event::PaymentFailed`] event.
3049 * (1) <https://github.com/lightningdevkit/rust-lightning/issues/1164>
3051 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
3053 bool all_paths_failed;
3055 * The payment path that failed.
3057 struct LDKCVec_RouteHopZ path;
3059 * The channel responsible for the failed payment path.
3061 * If this is `Some`, then the corresponding channel should be avoided when the payment is
3062 * retried. May be `None` for older [`Event`] serializations.
3064 struct LDKCOption_u64Z short_channel_id;
3066 * Parameters needed to compute a new [`Route`] when retrying the failed payment path.
3068 * See [`find_route`] for details.
3070 * [`Route`]: crate::routing::router::Route
3071 * [`find_route`]: crate::routing::router::find_route
3073 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
3075 struct LDKRouteParameters retry;
3076 } LDKEvent_LDKPaymentPathFailed_Body;
3078 typedef struct LDKEvent_LDKPaymentFailed_Body {
3080 * The id returned by [`ChannelManager::send_payment`] and used with
3081 * [`ChannelManager::retry_payment`] and [`ChannelManager::abandon_payment`].
3083 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
3084 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
3085 * [`ChannelManager::abandon_payment`]: crate::ln::channelmanager::ChannelManager::abandon_payment
3087 struct LDKThirtyTwoBytes payment_id;
3089 * The hash that was given to [`ChannelManager::send_payment`].
3091 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
3093 struct LDKThirtyTwoBytes payment_hash;
3094 } LDKEvent_LDKPaymentFailed_Body;
3096 typedef struct LDKEvent_LDKPendingHTLCsForwardable_Body {
3098 * The minimum amount of time that should be waited prior to calling
3099 * process_pending_htlc_forwards. To increase the effort required to correlate payments,
3100 * you should wait a random amount of time in roughly the range (now + time_forwardable,
3101 * now + 5*time_forwardable).
3103 uint64_t time_forwardable;
3104 } LDKEvent_LDKPendingHTLCsForwardable_Body;
3106 typedef struct LDKEvent_LDKSpendableOutputs_Body {
3108 * The outputs which you should store as spendable by you.
3110 struct LDKCVec_SpendableOutputDescriptorZ outputs;
3111 } LDKEvent_LDKSpendableOutputs_Body;
3113 typedef struct LDKEvent_LDKPaymentForwarded_Body {
3115 * The fee, in milli-satoshis, which was earned as a result of the payment.
3117 * Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
3118 * was pending, the amount the next hop claimed will have been rounded down to the nearest
3119 * whole satoshi. Thus, the fee calculated here may be higher than expected as we still
3120 * claimed the full value in millisatoshis from the source. In this case,
3121 * `claim_from_onchain_tx` will be set.
3123 * If the channel which sent us the payment has been force-closed, we will claim the funds
3124 * via an on-chain transaction. In that case we do not yet know the on-chain transaction
3125 * fees which we will spend and will instead set this to `None`. It is possible duplicate
3126 * `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
3129 struct LDKCOption_u64Z fee_earned_msat;
3131 * If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
3134 bool claim_from_onchain_tx;
3135 } LDKEvent_LDKPaymentForwarded_Body;
3137 typedef struct LDKEvent_LDKChannelClosed_Body {
3139 * The channel_id of the channel which has been closed. Note that on-chain transactions
3140 * resolving the channel are likely still awaiting confirmation.
3142 struct LDKThirtyTwoBytes channel_id;
3144 * The `user_channel_id` value passed in to [`ChannelManager::create_channel`] for outbound
3145 * channels, or to [`ChannelManager::accept_inbound_channel`] for inbound channels if
3146 * [`UserConfig::manually_accept_inbound_channels`] config flag is set to true. Otherwise
3147 * `user_channel_id` will be 0 for an inbound channel.
3148 * This will always be zero for objects serialized with LDK versions prior to 0.0.102.
3150 * [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
3151 * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
3152 * [`UserConfig::manually_accept_inbound_channels`]: crate::util::config::UserConfig::manually_accept_inbound_channels
3154 uint64_t user_channel_id;
3156 * The reason the channel was closed.
3158 struct LDKClosureReason reason;
3159 } LDKEvent_LDKChannelClosed_Body;
3161 typedef struct LDKEvent_LDKDiscardFunding_Body {
3163 * The channel_id of the channel which has been closed.
3165 struct LDKThirtyTwoBytes channel_id;
3167 * The full transaction received from the user
3169 struct LDKTransaction transaction;
3170 } LDKEvent_LDKDiscardFunding_Body;
3172 typedef struct LDKEvent_LDKPaymentPathSuccessful_Body {
3174 * The id returned by [`ChannelManager::send_payment`] and used with
3175 * [`ChannelManager::retry_payment`].
3177 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
3178 * [`ChannelManager::retry_payment`]: crate::ln::channelmanager::ChannelManager::retry_payment
3180 struct LDKThirtyTwoBytes payment_id;
3182 * The hash that was given to [`ChannelManager::send_payment`].
3184 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
3186 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
3188 struct LDKThirtyTwoBytes payment_hash;
3190 * The payment path that was successful.
3192 * May contain a closed channel if the HTLC sent along the path was fulfilled on chain.
3194 struct LDKCVec_RouteHopZ path;
3195 } LDKEvent_LDKPaymentPathSuccessful_Body;
3197 typedef struct LDKEvent_LDKOpenChannelRequest_Body {
3199 * The temporary channel ID of the channel requested to be opened.
3201 * When responding to the request, the `temporary_channel_id` should be passed
3202 * back to the ChannelManager with [`ChannelManager::accept_inbound_channel`] to accept,
3203 * or to [`ChannelManager::force_close_channel`] to reject.
3205 * [`ChannelManager::accept_inbound_channel`]: crate::ln::channelmanager::ChannelManager::accept_inbound_channel
3206 * [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel
3208 struct LDKThirtyTwoBytes temporary_channel_id;
3210 * The node_id of the counterparty requesting to open the channel.
3212 struct LDKPublicKey counterparty_node_id;
3214 * The channel value of the requested channel.
3216 uint64_t funding_satoshis;
3218 * Our starting balance in the channel if the request is accepted, in milli-satoshi.
3222 * The features that this channel will operate with. If you reject the channel, a
3223 * well-behaved counterparty may automatically re-attempt the channel with a new set of
3226 * Note that if [`ChannelTypeFeatures::supports_scid_privacy`] returns true on this type,
3227 * the resulting [`ChannelManager`] will not be readable by versions of LDK prior to
3230 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
3232 struct LDKChannelTypeFeatures channel_type;
3233 } LDKEvent_LDKOpenChannelRequest_Body;
3235 typedef struct MUST_USE_STRUCT LDKEvent {
3238 LDKEvent_LDKFundingGenerationReady_Body funding_generation_ready;
3239 LDKEvent_LDKPaymentReceived_Body payment_received;
3240 LDKEvent_LDKPaymentSent_Body payment_sent;
3241 LDKEvent_LDKPaymentPathFailed_Body payment_path_failed;
3242 LDKEvent_LDKPaymentFailed_Body payment_failed;
3243 LDKEvent_LDKPendingHTLCsForwardable_Body pending_htl_cs_forwardable;
3244 LDKEvent_LDKSpendableOutputs_Body spendable_outputs;
3245 LDKEvent_LDKPaymentForwarded_Body payment_forwarded;
3246 LDKEvent_LDKChannelClosed_Body channel_closed;
3247 LDKEvent_LDKDiscardFunding_Body discard_funding;
3248 LDKEvent_LDKPaymentPathSuccessful_Body payment_path_successful;
3249 LDKEvent_LDKOpenChannelRequest_Body open_channel_request;
3254 * An enum which can either contain a crate::lightning::util::events::Event or not
3256 typedef enum LDKCOption_EventZ_Tag {
3258 * When we're in this state, this COption_EventZ contains a crate::lightning::util::events::Event
3260 LDKCOption_EventZ_Some,
3262 * When we're in this state, this COption_EventZ contains nothing
3264 LDKCOption_EventZ_None,
3266 * Must be last for serialization purposes
3268 LDKCOption_EventZ_Sentinel,
3269 } LDKCOption_EventZ_Tag;
3271 typedef struct LDKCOption_EventZ {
3272 LDKCOption_EventZ_Tag tag;
3275 struct LDKEvent some;
3278 } LDKCOption_EventZ;
3281 * The contents of CResult_COption_EventZDecodeErrorZ
3283 typedef union LDKCResult_COption_EventZDecodeErrorZPtr {
3285 * A pointer to the contents in the success state.
3286 * Reading from this pointer when `result_ok` is not set is undefined.
3288 struct LDKCOption_EventZ *result;
3290 * A pointer to the contents in the error state.
3291 * Reading from this pointer when `result_ok` is set is undefined.
3293 struct LDKDecodeError *err;
3294 } LDKCResult_COption_EventZDecodeErrorZPtr;
3297 * A CResult_COption_EventZDecodeErrorZ represents the result of a fallible operation,
3298 * containing a crate::c_types::derived::COption_EventZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
3299 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3301 typedef struct LDKCResult_COption_EventZDecodeErrorZ {
3303 * The contents of this CResult_COption_EventZDecodeErrorZ, accessible via either
3304 * `err` or `result` depending on the state of `result_ok`.
3306 union LDKCResult_COption_EventZDecodeErrorZPtr contents;
3308 * Whether this CResult_COption_EventZDecodeErrorZ represents a success state.
3311 } LDKCResult_COption_EventZDecodeErrorZ;
3316 * An accept_channel message to be sent or received from a peer
3318 typedef struct MUST_USE_STRUCT LDKAcceptChannel {
3320 * A pointer to the opaque Rust object.
3321 * Nearly everywhere, inner must be non-null, however in places where
3322 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3324 LDKnativeAcceptChannel *inner;
3326 * Indicates that this is the only struct which contains the same pointer.
3327 * Rust functions which take ownership of an object provided via an argument require
3328 * this to be true and invalidate the object pointed to by inner.
3336 * An open_channel message to be sent or received from a peer
3338 typedef struct MUST_USE_STRUCT LDKOpenChannel {
3340 * A pointer to the opaque Rust object.
3341 * Nearly everywhere, inner must be non-null, however in places where
3342 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3344 LDKnativeOpenChannel *inner;
3346 * Indicates that this is the only struct which contains the same pointer.
3347 * Rust functions which take ownership of an object provided via an argument require
3348 * this to be true and invalidate the object pointed to by inner.
3356 * A funding_created message to be sent or received from a peer
3358 typedef struct MUST_USE_STRUCT LDKFundingCreated {
3360 * A pointer to the opaque Rust object.
3361 * Nearly everywhere, inner must be non-null, however in places where
3362 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3364 LDKnativeFundingCreated *inner;
3366 * Indicates that this is the only struct which contains the same pointer.
3367 * Rust functions which take ownership of an object provided via an argument require
3368 * this to be true and invalidate the object pointed to by inner.
3371 } LDKFundingCreated;
3376 * A funding_signed message to be sent or received from a peer
3378 typedef struct MUST_USE_STRUCT LDKFundingSigned {
3380 * A pointer to the opaque Rust object.
3381 * Nearly everywhere, inner must be non-null, however in places where
3382 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3384 LDKnativeFundingSigned *inner;
3386 * Indicates that this is the only struct which contains the same pointer.
3387 * Rust functions which take ownership of an object provided via an argument require
3388 * this to be true and invalidate the object pointed to by inner.
3396 * A funding_locked message to be sent or received from a peer
3398 typedef struct MUST_USE_STRUCT LDKFundingLocked {
3400 * A pointer to the opaque Rust object.
3401 * Nearly everywhere, inner must be non-null, however in places where
3402 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3404 LDKnativeFundingLocked *inner;
3406 * Indicates that this is the only struct which contains the same pointer.
3407 * Rust functions which take ownership of an object provided via an argument require
3408 * this to be true and invalidate the object pointed to by inner.
3416 * An announcement_signatures message to be sent or received from a peer
3418 typedef struct MUST_USE_STRUCT LDKAnnouncementSignatures {
3420 * A pointer to the opaque Rust object.
3421 * Nearly everywhere, inner must be non-null, however in places where
3422 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3424 LDKnativeAnnouncementSignatures *inner;
3426 * Indicates that this is the only struct which contains the same pointer.
3427 * Rust functions which take ownership of an object provided via an argument require
3428 * this to be true and invalidate the object pointed to by inner.
3431 } LDKAnnouncementSignatures;
3436 * Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
3437 * transaction updates if they were pending.
3439 typedef struct MUST_USE_STRUCT LDKCommitmentUpdate {
3441 * A pointer to the opaque Rust object.
3442 * Nearly everywhere, inner must be non-null, however in places where
3443 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3445 LDKnativeCommitmentUpdate *inner;
3447 * Indicates that this is the only struct which contains the same pointer.
3448 * Rust functions which take ownership of an object provided via an argument require
3449 * this to be true and invalidate the object pointed to by inner.
3452 } LDKCommitmentUpdate;
3457 * A revoke_and_ack message to be sent or received from a peer
3459 typedef struct MUST_USE_STRUCT LDKRevokeAndACK {
3461 * A pointer to the opaque Rust object.
3462 * Nearly everywhere, inner must be non-null, however in places where
3463 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3465 LDKnativeRevokeAndACK *inner;
3467 * Indicates that this is the only struct which contains the same pointer.
3468 * Rust functions which take ownership of an object provided via an argument require
3469 * this to be true and invalidate the object pointed to by inner.
3477 * A closing_signed message to be sent or received from a peer
3479 typedef struct MUST_USE_STRUCT LDKClosingSigned {
3481 * A pointer to the opaque Rust object.
3482 * Nearly everywhere, inner must be non-null, however in places where
3483 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3485 LDKnativeClosingSigned *inner;
3487 * Indicates that this is the only struct which contains the same pointer.
3488 * Rust functions which take ownership of an object provided via an argument require
3489 * this to be true and invalidate the object pointed to by inner.
3497 * A shutdown message to be sent or received from a peer
3499 typedef struct MUST_USE_STRUCT LDKShutdown {
3501 * A pointer to the opaque Rust object.
3502 * Nearly everywhere, inner must be non-null, however in places where
3503 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3505 LDKnativeShutdown *inner;
3507 * Indicates that this is the only struct which contains the same pointer.
3508 * Rust functions which take ownership of an object provided via an argument require
3509 * this to be true and invalidate the object pointed to by inner.
3517 * A channel_reestablish message to be sent or received from a peer
3519 typedef struct MUST_USE_STRUCT LDKChannelReestablish {
3521 * A pointer to the opaque Rust object.
3522 * Nearly everywhere, inner must be non-null, however in places where
3523 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3525 LDKnativeChannelReestablish *inner;
3527 * Indicates that this is the only struct which contains the same pointer.
3528 * Rust functions which take ownership of an object provided via an argument require
3529 * this to be true and invalidate the object pointed to by inner.
3532 } LDKChannelReestablish;
3537 * A channel_announcement message to be sent or received from a peer
3539 typedef struct MUST_USE_STRUCT LDKChannelAnnouncement {
3541 * A pointer to the opaque Rust object.
3542 * Nearly everywhere, inner must be non-null, however in places where
3543 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3545 LDKnativeChannelAnnouncement *inner;
3547 * Indicates that this is the only struct which contains the same pointer.
3548 * Rust functions which take ownership of an object provided via an argument require
3549 * this to be true and invalidate the object pointed to by inner.
3552 } LDKChannelAnnouncement;
3557 * A node_announcement message to be sent or received from a peer
3559 typedef struct MUST_USE_STRUCT LDKNodeAnnouncement {
3561 * A pointer to the opaque Rust object.
3562 * Nearly everywhere, inner must be non-null, however in places where
3563 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3565 LDKnativeNodeAnnouncement *inner;
3567 * Indicates that this is the only struct which contains the same pointer.
3568 * Rust functions which take ownership of an object provided via an argument require
3569 * this to be true and invalidate the object pointed to by inner.
3572 } LDKNodeAnnouncement;
3577 * An error message to be sent or received from a peer
3579 typedef struct MUST_USE_STRUCT LDKErrorMessage {
3581 * A pointer to the opaque Rust object.
3582 * Nearly everywhere, inner must be non-null, however in places where
3583 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3585 LDKnativeErrorMessage *inner;
3587 * Indicates that this is the only struct which contains the same pointer.
3588 * Rust functions which take ownership of an object provided via an argument require
3589 * this to be true and invalidate the object pointed to by inner.
3597 * A warning message to be sent or received from a peer
3599 typedef struct MUST_USE_STRUCT LDKWarningMessage {
3601 * A pointer to the opaque Rust object.
3602 * Nearly everywhere, inner must be non-null, however in places where
3603 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3605 LDKnativeWarningMessage *inner;
3607 * Indicates that this is the only struct which contains the same pointer.
3608 * Rust functions which take ownership of an object provided via an argument require
3609 * this to be true and invalidate the object pointed to by inner.
3612 } LDKWarningMessage;
3615 * Used to put an error message in a LightningError
3617 typedef enum LDKErrorAction_Tag {
3619 * The peer took some action which made us think they were useless. Disconnect them.
3621 LDKErrorAction_DisconnectPeer,
3623 * The peer did something harmless that we weren't able to process, just log and ignore
3625 LDKErrorAction_IgnoreError,
3627 * The peer did something harmless that we weren't able to meaningfully process.
3628 * If the error is logged, log it at the given level.
3630 LDKErrorAction_IgnoreAndLog,
3632 * The peer provided us with a gossip message which we'd already seen. In most cases this
3633 * should be ignored, but it may result in the message being forwarded if it is a duplicate of
3634 * our own channel announcements.
3636 LDKErrorAction_IgnoreDuplicateGossip,
3638 * The peer did something incorrect. Tell them.
3640 LDKErrorAction_SendErrorMessage,
3642 * The peer did something incorrect. Tell them without closing any channels.
3644 LDKErrorAction_SendWarningMessage,
3646 * Must be last for serialization purposes
3648 LDKErrorAction_Sentinel,
3649 } LDKErrorAction_Tag;
3651 typedef struct LDKErrorAction_LDKDisconnectPeer_Body {
3653 * An error message which we should make an effort to send before we disconnect.
3655 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
3657 struct LDKErrorMessage msg;
3658 } LDKErrorAction_LDKDisconnectPeer_Body;
3660 typedef struct LDKErrorAction_LDKSendErrorMessage_Body {
3662 * The message to send.
3664 struct LDKErrorMessage msg;
3665 } LDKErrorAction_LDKSendErrorMessage_Body;
3667 typedef struct LDKErrorAction_LDKSendWarningMessage_Body {
3669 * The message to send.
3671 struct LDKWarningMessage msg;
3673 * The peer may have done something harmless that we weren't able to meaningfully process,
3674 * though we should still tell them about it.
3675 * If this event is logged, log it at the given level.
3677 enum LDKLevel log_level;
3678 } LDKErrorAction_LDKSendWarningMessage_Body;
3680 typedef struct MUST_USE_STRUCT LDKErrorAction {
3681 LDKErrorAction_Tag tag;
3683 LDKErrorAction_LDKDisconnectPeer_Body disconnect_peer;
3685 enum LDKLevel ignore_and_log;
3687 LDKErrorAction_LDKSendErrorMessage_Body send_error_message;
3688 LDKErrorAction_LDKSendWarningMessage_Body send_warning_message;
3695 * A query_channel_range message is used to query a peer for channel
3696 * UTXOs in a range of blocks. The recipient of a query makes a best
3697 * effort to reply to the query using one or more reply_channel_range
3700 typedef struct MUST_USE_STRUCT LDKQueryChannelRange {
3702 * A pointer to the opaque Rust object.
3703 * Nearly everywhere, inner must be non-null, however in places where
3704 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3706 LDKnativeQueryChannelRange *inner;
3708 * Indicates that this is the only struct which contains the same pointer.
3709 * Rust functions which take ownership of an object provided via an argument require
3710 * this to be true and invalidate the object pointed to by inner.
3713 } LDKQueryChannelRange;
3718 * A query_short_channel_ids message is used to query a peer for
3719 * routing gossip messages related to one or more short_channel_ids.
3720 * The query recipient will reply with the latest, if available,
3721 * channel_announcement, channel_update and node_announcement messages
3722 * it maintains for the requested short_channel_ids followed by a
3723 * reply_short_channel_ids_end message. The short_channel_ids sent in
3724 * this query are encoded. We only support encoding_type=0 uncompressed
3725 * serialization and do not support encoding_type=1 zlib serialization.
3727 typedef struct MUST_USE_STRUCT LDKQueryShortChannelIds {
3729 * A pointer to the opaque Rust object.
3730 * Nearly everywhere, inner must be non-null, however in places where
3731 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3733 LDKnativeQueryShortChannelIds *inner;
3735 * Indicates that this is the only struct which contains the same pointer.
3736 * Rust functions which take ownership of an object provided via an argument require
3737 * this to be true and invalidate the object pointed to by inner.
3740 } LDKQueryShortChannelIds;
3745 * A reply_channel_range message is a reply to a query_channel_range
3746 * message. Multiple reply_channel_range messages can be sent in reply
3747 * to a single query_channel_range message. The query recipient makes a
3748 * best effort to respond based on their local network view which may
3749 * not be a perfect view of the network. The short_channel_ids in the
3750 * reply are encoded. We only support encoding_type=0 uncompressed
3751 * serialization and do not support encoding_type=1 zlib serialization.
3753 typedef struct MUST_USE_STRUCT LDKReplyChannelRange {
3755 * A pointer to the opaque Rust object.
3756 * Nearly everywhere, inner must be non-null, however in places where
3757 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3759 LDKnativeReplyChannelRange *inner;
3761 * Indicates that this is the only struct which contains the same pointer.
3762 * Rust functions which take ownership of an object provided via an argument require
3763 * this to be true and invalidate the object pointed to by inner.
3766 } LDKReplyChannelRange;
3771 * A gossip_timestamp_filter message is used by a node to request
3772 * gossip relay for messages in the requested time range when the
3773 * gossip_queries feature has been negotiated.
3775 typedef struct MUST_USE_STRUCT LDKGossipTimestampFilter {
3777 * A pointer to the opaque Rust object.
3778 * Nearly everywhere, inner must be non-null, however in places where
3779 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3781 LDKnativeGossipTimestampFilter *inner;
3783 * Indicates that this is the only struct which contains the same pointer.
3784 * Rust functions which take ownership of an object provided via an argument require
3785 * this to be true and invalidate the object pointed to by inner.
3788 } LDKGossipTimestampFilter;
3791 * An event generated by ChannelManager which indicates a message should be sent to a peer (or
3792 * broadcast to most peers).
3793 * These events are handled by PeerManager::process_events if you are using a PeerManager.
3795 typedef enum LDKMessageSendEvent_Tag {
3797 * Used to indicate that we've accepted a channel open and should send the accept_channel
3798 * message provided to the given peer.
3800 LDKMessageSendEvent_SendAcceptChannel,
3802 * Used to indicate that we've initiated a channel open and should send the open_channel
3803 * message provided to the given peer.
3805 LDKMessageSendEvent_SendOpenChannel,
3807 * Used to indicate that a funding_created message should be sent to the peer with the given node_id.
3809 LDKMessageSendEvent_SendFundingCreated,
3811 * Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
3813 LDKMessageSendEvent_SendFundingSigned,
3815 * Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
3817 LDKMessageSendEvent_SendFundingLocked,
3819 * Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
3821 LDKMessageSendEvent_SendAnnouncementSignatures,
3823 * Used to indicate that a series of HTLC update messages, as well as a commitment_signed
3824 * message should be sent to the peer with the given node_id.
3826 LDKMessageSendEvent_UpdateHTLCs,
3828 * Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
3830 LDKMessageSendEvent_SendRevokeAndACK,
3832 * Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
3834 LDKMessageSendEvent_SendClosingSigned,
3836 * Used to indicate that a shutdown message should be sent to the peer with the given node_id.
3838 LDKMessageSendEvent_SendShutdown,
3840 * Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
3842 LDKMessageSendEvent_SendChannelReestablish,
3844 * Used to indicate that a channel_announcement and channel_update should be broadcast to all
3845 * peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
3847 * Note that after doing so, you very likely (unless you did so very recently) want to call
3848 * ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
3849 * This ensures that any nodes which see our channel_announcement also have a relevant
3850 * node_announcement, including relevant feature flags which may be important for routing
3853 LDKMessageSendEvent_BroadcastChannelAnnouncement,
3855 * Used to indicate that a node_announcement should be broadcast to all peers.
3857 LDKMessageSendEvent_BroadcastNodeAnnouncement,
3859 * Used to indicate that a channel_update should be broadcast to all peers.
3861 LDKMessageSendEvent_BroadcastChannelUpdate,
3863 * Used to indicate that a channel_update should be sent to a single peer.
3864 * In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
3865 * private channel and we shouldn't be informing all of our peers of channel parameters.
3867 LDKMessageSendEvent_SendChannelUpdate,
3869 * Broadcast an error downstream to be handled
3871 LDKMessageSendEvent_HandleError,
3873 * Query a peer for channels with funding transaction UTXOs in a block range.
3875 LDKMessageSendEvent_SendChannelRangeQuery,
3877 * Request routing gossip messages from a peer for a list of channels identified by
3878 * their short_channel_ids.
3880 LDKMessageSendEvent_SendShortIdsQuery,
3882 * Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
3883 * emitted during processing of the query.
3885 LDKMessageSendEvent_SendReplyChannelRange,
3887 * Sends a timestamp filter for inbound gossip. This should be sent on each new connection to
3888 * enable receiving gossip messages from the peer.
3890 LDKMessageSendEvent_SendGossipTimestampFilter,
3892 * Must be last for serialization purposes
3894 LDKMessageSendEvent_Sentinel,
3895 } LDKMessageSendEvent_Tag;
3897 typedef struct LDKMessageSendEvent_LDKSendAcceptChannel_Body {
3899 * The node_id of the node which should receive this message
3901 struct LDKPublicKey node_id;
3903 * The message which should be sent.
3905 struct LDKAcceptChannel msg;
3906 } LDKMessageSendEvent_LDKSendAcceptChannel_Body;
3908 typedef struct LDKMessageSendEvent_LDKSendOpenChannel_Body {
3910 * The node_id of the node which should receive this message
3912 struct LDKPublicKey node_id;
3914 * The message which should be sent.
3916 struct LDKOpenChannel msg;
3917 } LDKMessageSendEvent_LDKSendOpenChannel_Body;
3919 typedef struct LDKMessageSendEvent_LDKSendFundingCreated_Body {
3921 * The node_id of the node which should receive this message
3923 struct LDKPublicKey node_id;
3925 * The message which should be sent.
3927 struct LDKFundingCreated msg;
3928 } LDKMessageSendEvent_LDKSendFundingCreated_Body;
3930 typedef struct LDKMessageSendEvent_LDKSendFundingSigned_Body {
3932 * The node_id of the node which should receive this message
3934 struct LDKPublicKey node_id;
3936 * The message which should be sent.
3938 struct LDKFundingSigned msg;
3939 } LDKMessageSendEvent_LDKSendFundingSigned_Body;
3941 typedef struct LDKMessageSendEvent_LDKSendFundingLocked_Body {
3943 * The node_id of the node which should receive these message(s)
3945 struct LDKPublicKey node_id;
3947 * The funding_locked message which should be sent.
3949 struct LDKFundingLocked msg;
3950 } LDKMessageSendEvent_LDKSendFundingLocked_Body;
3952 typedef struct LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body {
3954 * The node_id of the node which should receive these message(s)
3956 struct LDKPublicKey node_id;
3958 * The announcement_signatures message which should be sent.
3960 struct LDKAnnouncementSignatures msg;
3961 } LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body;
3963 typedef struct LDKMessageSendEvent_LDKUpdateHTLCs_Body {
3965 * The node_id of the node which should receive these message(s)
3967 struct LDKPublicKey node_id;
3969 * The update messages which should be sent. ALL messages in the struct should be sent!
3971 struct LDKCommitmentUpdate updates;
3972 } LDKMessageSendEvent_LDKUpdateHTLCs_Body;
3974 typedef struct LDKMessageSendEvent_LDKSendRevokeAndACK_Body {
3976 * The node_id of the node which should receive this message
3978 struct LDKPublicKey node_id;
3980 * The message which should be sent.
3982 struct LDKRevokeAndACK msg;
3983 } LDKMessageSendEvent_LDKSendRevokeAndACK_Body;
3985 typedef struct LDKMessageSendEvent_LDKSendClosingSigned_Body {
3987 * The node_id of the node which should receive this message
3989 struct LDKPublicKey node_id;
3991 * The message which should be sent.
3993 struct LDKClosingSigned msg;
3994 } LDKMessageSendEvent_LDKSendClosingSigned_Body;
3996 typedef struct LDKMessageSendEvent_LDKSendShutdown_Body {
3998 * The node_id of the node which should receive this message
4000 struct LDKPublicKey node_id;
4002 * The message which should be sent.
4004 struct LDKShutdown msg;
4005 } LDKMessageSendEvent_LDKSendShutdown_Body;
4007 typedef struct LDKMessageSendEvent_LDKSendChannelReestablish_Body {
4009 * The node_id of the node which should receive this message
4011 struct LDKPublicKey node_id;
4013 * The message which should be sent.
4015 struct LDKChannelReestablish msg;
4016 } LDKMessageSendEvent_LDKSendChannelReestablish_Body;
4018 typedef struct LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body {
4020 * The channel_announcement which should be sent.
4022 struct LDKChannelAnnouncement msg;
4024 * The followup channel_update which should be sent.
4026 struct LDKChannelUpdate update_msg;
4027 } LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body;
4029 typedef struct LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body {
4031 * The node_announcement which should be sent.
4033 struct LDKNodeAnnouncement msg;
4034 } LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body;
4036 typedef struct LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body {
4038 * The channel_update which should be sent.
4040 struct LDKChannelUpdate msg;
4041 } LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body;
4043 typedef struct LDKMessageSendEvent_LDKSendChannelUpdate_Body {
4045 * The node_id of the node which should receive this message
4047 struct LDKPublicKey node_id;
4049 * The channel_update which should be sent.
4051 struct LDKChannelUpdate msg;
4052 } LDKMessageSendEvent_LDKSendChannelUpdate_Body;
4054 typedef struct LDKMessageSendEvent_LDKHandleError_Body {
4056 * The node_id of the node which should receive this message
4058 struct LDKPublicKey node_id;
4060 * The action which should be taken.
4062 struct LDKErrorAction action;
4063 } LDKMessageSendEvent_LDKHandleError_Body;
4065 typedef struct LDKMessageSendEvent_LDKSendChannelRangeQuery_Body {
4067 * The node_id of this message recipient
4069 struct LDKPublicKey node_id;
4071 * The query_channel_range which should be sent.
4073 struct LDKQueryChannelRange msg;
4074 } LDKMessageSendEvent_LDKSendChannelRangeQuery_Body;
4076 typedef struct LDKMessageSendEvent_LDKSendShortIdsQuery_Body {
4078 * The node_id of this message recipient
4080 struct LDKPublicKey node_id;
4082 * The query_short_channel_ids which should be sent.
4084 struct LDKQueryShortChannelIds msg;
4085 } LDKMessageSendEvent_LDKSendShortIdsQuery_Body;
4087 typedef struct LDKMessageSendEvent_LDKSendReplyChannelRange_Body {
4089 * The node_id of this message recipient
4091 struct LDKPublicKey node_id;
4093 * The reply_channel_range which should be sent.
4095 struct LDKReplyChannelRange msg;
4096 } LDKMessageSendEvent_LDKSendReplyChannelRange_Body;
4098 typedef struct LDKMessageSendEvent_LDKSendGossipTimestampFilter_Body {
4100 * The node_id of this message recipient
4102 struct LDKPublicKey node_id;
4104 * The gossip_timestamp_filter which should be sent.
4106 struct LDKGossipTimestampFilter msg;
4107 } LDKMessageSendEvent_LDKSendGossipTimestampFilter_Body;
4109 typedef struct MUST_USE_STRUCT LDKMessageSendEvent {
4110 LDKMessageSendEvent_Tag tag;
4112 LDKMessageSendEvent_LDKSendAcceptChannel_Body send_accept_channel;
4113 LDKMessageSendEvent_LDKSendOpenChannel_Body send_open_channel;
4114 LDKMessageSendEvent_LDKSendFundingCreated_Body send_funding_created;
4115 LDKMessageSendEvent_LDKSendFundingSigned_Body send_funding_signed;
4116 LDKMessageSendEvent_LDKSendFundingLocked_Body send_funding_locked;
4117 LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body send_announcement_signatures;
4118 LDKMessageSendEvent_LDKUpdateHTLCs_Body update_htl_cs;
4119 LDKMessageSendEvent_LDKSendRevokeAndACK_Body send_revoke_and_ack;
4120 LDKMessageSendEvent_LDKSendClosingSigned_Body send_closing_signed;
4121 LDKMessageSendEvent_LDKSendShutdown_Body send_shutdown;
4122 LDKMessageSendEvent_LDKSendChannelReestablish_Body send_channel_reestablish;
4123 LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body broadcast_channel_announcement;
4124 LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body broadcast_node_announcement;
4125 LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body broadcast_channel_update;
4126 LDKMessageSendEvent_LDKSendChannelUpdate_Body send_channel_update;
4127 LDKMessageSendEvent_LDKHandleError_Body handle_error;
4128 LDKMessageSendEvent_LDKSendChannelRangeQuery_Body send_channel_range_query;
4129 LDKMessageSendEvent_LDKSendShortIdsQuery_Body send_short_ids_query;
4130 LDKMessageSendEvent_LDKSendReplyChannelRange_Body send_reply_channel_range;
4131 LDKMessageSendEvent_LDKSendGossipTimestampFilter_Body send_gossip_timestamp_filter;
4133 } LDKMessageSendEvent;
4136 * A dynamically-allocated array of crate::lightning::util::events::MessageSendEvents of arbitrary size.
4137 * This corresponds to std::vector in C++
4139 typedef struct LDKCVec_MessageSendEventZ {
4141 * The elements in the array.
4142 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4144 struct LDKMessageSendEvent *data;
4146 * The number of elements pointed to by `data`.
4149 } LDKCVec_MessageSendEventZ;
4154 * [`Score`] implementation that uses a fixed penalty.
4156 typedef struct MUST_USE_STRUCT LDKFixedPenaltyScorer {
4158 * A pointer to the opaque Rust object.
4159 * Nearly everywhere, inner must be non-null, however in places where
4160 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4162 LDKnativeFixedPenaltyScorer *inner;
4164 * Indicates that this is the only struct which contains the same pointer.
4165 * Rust functions which take ownership of an object provided via an argument require
4166 * this to be true and invalidate the object pointed to by inner.
4169 } LDKFixedPenaltyScorer;
4172 * The contents of CResult_FixedPenaltyScorerDecodeErrorZ
4174 typedef union LDKCResult_FixedPenaltyScorerDecodeErrorZPtr {
4176 * A pointer to the contents in the success state.
4177 * Reading from this pointer when `result_ok` is not set is undefined.
4179 struct LDKFixedPenaltyScorer *result;
4181 * A pointer to the contents in the error state.
4182 * Reading from this pointer when `result_ok` is set is undefined.
4184 struct LDKDecodeError *err;
4185 } LDKCResult_FixedPenaltyScorerDecodeErrorZPtr;
4188 * A CResult_FixedPenaltyScorerDecodeErrorZ represents the result of a fallible operation,
4189 * containing a crate::lightning::routing::scoring::FixedPenaltyScorer on success and a crate::lightning::ln::msgs::DecodeError on failure.
4190 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4192 typedef struct LDKCResult_FixedPenaltyScorerDecodeErrorZ {
4194 * The contents of this CResult_FixedPenaltyScorerDecodeErrorZ, accessible via either
4195 * `err` or `result` depending on the state of `result_ok`.
4197 union LDKCResult_FixedPenaltyScorerDecodeErrorZPtr contents;
4199 * Whether this CResult_FixedPenaltyScorerDecodeErrorZ represents a success state.
4202 } LDKCResult_FixedPenaltyScorerDecodeErrorZ;
4207 * Parameters for configuring [`Scorer`].
4209 typedef struct MUST_USE_STRUCT LDKScoringParameters {
4211 * A pointer to the opaque Rust object.
4212 * Nearly everywhere, inner must be non-null, however in places where
4213 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4215 LDKnativeScoringParameters *inner;
4217 * Indicates that this is the only struct which contains the same pointer.
4218 * Rust functions which take ownership of an object provided via an argument require
4219 * this to be true and invalidate the object pointed to by inner.
4222 } LDKScoringParameters;
4225 * The contents of CResult_ScoringParametersDecodeErrorZ
4227 typedef union LDKCResult_ScoringParametersDecodeErrorZPtr {
4229 * A pointer to the contents in the success state.
4230 * Reading from this pointer when `result_ok` is not set is undefined.
4232 struct LDKScoringParameters *result;
4234 * A pointer to the contents in the error state.
4235 * Reading from this pointer when `result_ok` is set is undefined.
4237 struct LDKDecodeError *err;
4238 } LDKCResult_ScoringParametersDecodeErrorZPtr;
4241 * A CResult_ScoringParametersDecodeErrorZ represents the result of a fallible operation,
4242 * containing a crate::lightning::routing::scoring::ScoringParameters on success and a crate::lightning::ln::msgs::DecodeError on failure.
4243 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4245 typedef struct LDKCResult_ScoringParametersDecodeErrorZ {
4247 * The contents of this CResult_ScoringParametersDecodeErrorZ, accessible via either
4248 * `err` or `result` depending on the state of `result_ok`.
4250 union LDKCResult_ScoringParametersDecodeErrorZPtr contents;
4252 * Whether this CResult_ScoringParametersDecodeErrorZ represents a success state.
4255 } LDKCResult_ScoringParametersDecodeErrorZ;
4260 * [`Score`] implementation that provides reasonable default behavior.
4262 * Used to apply a fixed penalty to each channel, thus avoiding long paths when shorter paths with
4263 * slightly higher fees are available. Will further penalize channels that fail to relay payments.
4265 * See [module-level documentation] for usage and [`ScoringParameters`] for customization.
4269 * Mixing the `no-std` feature between serialization and deserialization results in undefined
4272 * [module-level documentation]: crate::routing::scoring
4274 typedef struct MUST_USE_STRUCT LDKScorer {
4276 * A pointer to the opaque Rust object.
4277 * Nearly everywhere, inner must be non-null, however in places where
4278 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4280 LDKnativeScorer *inner;
4282 * Indicates that this is the only struct which contains the same pointer.
4283 * Rust functions which take ownership of an object provided via an argument require
4284 * this to be true and invalidate the object pointed to by inner.
4290 * The contents of CResult_ScorerDecodeErrorZ
4292 typedef union LDKCResult_ScorerDecodeErrorZPtr {
4294 * A pointer to the contents in the success state.
4295 * Reading from this pointer when `result_ok` is not set is undefined.
4297 struct LDKScorer *result;
4299 * A pointer to the contents in the error state.
4300 * Reading from this pointer when `result_ok` is set is undefined.
4302 struct LDKDecodeError *err;
4303 } LDKCResult_ScorerDecodeErrorZPtr;
4306 * A CResult_ScorerDecodeErrorZ represents the result of a fallible operation,
4307 * containing a crate::lightning::routing::scoring::Scorer on success and a crate::lightning::ln::msgs::DecodeError on failure.
4308 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4310 typedef struct LDKCResult_ScorerDecodeErrorZ {
4312 * The contents of this CResult_ScorerDecodeErrorZ, accessible via either
4313 * `err` or `result` depending on the state of `result_ok`.
4315 union LDKCResult_ScorerDecodeErrorZPtr contents;
4317 * Whether this CResult_ScorerDecodeErrorZ represents a success state.
4320 } LDKCResult_ScorerDecodeErrorZ;
4325 * Represents the network as nodes and channels between them
4327 typedef struct MUST_USE_STRUCT LDKNetworkGraph {
4329 * A pointer to the opaque Rust object.
4330 * Nearly everywhere, inner must be non-null, however in places where
4331 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4333 LDKnativeNetworkGraph *inner;
4335 * Indicates that this is the only struct which contains the same pointer.
4336 * Rust functions which take ownership of an object provided via an argument require
4337 * this to be true and invalidate the object pointed to by inner.
4345 * [`Score`] implementation using channel success probability distributions.
4347 * Based on *Optimally Reliable & Cheap Payment Flows on the Lightning Network* by Rene Pickhardt
4348 * and Stefan Richter [[1]]. Given the uncertainty of channel liquidity balances, probability
4349 * distributions are defined based on knowledge learned from successful and unsuccessful attempts.
4350 * Then the negative `log10` of the success probability is used to determine the cost of routing a
4351 * specific HTLC amount through a channel.
4353 * Knowledge about channel liquidity balances takes the form of upper and lower bounds on the
4354 * possible liquidity. Certainty of the bounds is decreased over time using a decay function. See
4355 * [`ProbabilisticScoringParameters`] for details.
4357 * Since the scorer aims to learn the current channel liquidity balances, it works best for nodes
4358 * with high payment volume or that actively probe the [`NetworkGraph`]. Nodes with low payment
4359 * volume are more likely to experience failed payment paths, which would need to be retried.
4363 * Mixing the `no-std` feature between serialization and deserialization results in undefined
4366 * [1]: https://arxiv.org/abs/2107.05322
4368 typedef struct MUST_USE_STRUCT LDKProbabilisticScorer {
4370 * A pointer to the opaque Rust object.
4371 * Nearly everywhere, inner must be non-null, however in places where
4372 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4374 LDKnativeProbabilisticScorer *inner;
4376 * Indicates that this is the only struct which contains the same pointer.
4377 * Rust functions which take ownership of an object provided via an argument require
4378 * this to be true and invalidate the object pointed to by inner.
4381 } LDKProbabilisticScorer;
4384 * The contents of CResult_ProbabilisticScorerDecodeErrorZ
4386 typedef union LDKCResult_ProbabilisticScorerDecodeErrorZPtr {
4388 * A pointer to the contents in the success state.
4389 * Reading from this pointer when `result_ok` is not set is undefined.
4391 struct LDKProbabilisticScorer *result;
4393 * A pointer to the contents in the error state.
4394 * Reading from this pointer when `result_ok` is set is undefined.
4396 struct LDKDecodeError *err;
4397 } LDKCResult_ProbabilisticScorerDecodeErrorZPtr;
4400 * A CResult_ProbabilisticScorerDecodeErrorZ represents the result of a fallible operation,
4401 * containing a crate::lightning::routing::scoring::ProbabilisticScorer on success and a crate::lightning::ln::msgs::DecodeError on failure.
4402 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4404 typedef struct LDKCResult_ProbabilisticScorerDecodeErrorZ {
4406 * The contents of this CResult_ProbabilisticScorerDecodeErrorZ, accessible via either
4407 * `err` or `result` depending on the state of `result_ok`.
4409 union LDKCResult_ProbabilisticScorerDecodeErrorZPtr contents;
4411 * Whether this CResult_ProbabilisticScorerDecodeErrorZ represents a success state.
4414 } LDKCResult_ProbabilisticScorerDecodeErrorZ;
4419 * Features used within an `init` message.
4421 typedef struct MUST_USE_STRUCT LDKInitFeatures {
4423 * A pointer to the opaque Rust object.
4424 * Nearly everywhere, inner must be non-null, however in places where
4425 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4427 LDKnativeInitFeatures *inner;
4429 * Indicates that this is the only struct which contains the same pointer.
4430 * Rust functions which take ownership of an object provided via an argument require
4431 * this to be true and invalidate the object pointed to by inner.
4437 * The contents of CResult_InitFeaturesDecodeErrorZ
4439 typedef union LDKCResult_InitFeaturesDecodeErrorZPtr {
4441 * A pointer to the contents in the success state.
4442 * Reading from this pointer when `result_ok` is not set is undefined.
4444 struct LDKInitFeatures *result;
4446 * A pointer to the contents in the error state.
4447 * Reading from this pointer when `result_ok` is set is undefined.
4449 struct LDKDecodeError *err;
4450 } LDKCResult_InitFeaturesDecodeErrorZPtr;
4453 * A CResult_InitFeaturesDecodeErrorZ represents the result of a fallible operation,
4454 * containing a crate::lightning::ln::features::InitFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
4455 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4457 typedef struct LDKCResult_InitFeaturesDecodeErrorZ {
4459 * The contents of this CResult_InitFeaturesDecodeErrorZ, accessible via either
4460 * `err` or `result` depending on the state of `result_ok`.
4462 union LDKCResult_InitFeaturesDecodeErrorZPtr contents;
4464 * Whether this CResult_InitFeaturesDecodeErrorZ represents a success state.
4467 } LDKCResult_InitFeaturesDecodeErrorZ;
4472 * Features used within a `channel_announcement` message.
4474 typedef struct MUST_USE_STRUCT LDKChannelFeatures {
4476 * A pointer to the opaque Rust object.
4477 * Nearly everywhere, inner must be non-null, however in places where
4478 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4480 LDKnativeChannelFeatures *inner;
4482 * Indicates that this is the only struct which contains the same pointer.
4483 * Rust functions which take ownership of an object provided via an argument require
4484 * this to be true and invalidate the object pointed to by inner.
4487 } LDKChannelFeatures;
4490 * The contents of CResult_ChannelFeaturesDecodeErrorZ
4492 typedef union LDKCResult_ChannelFeaturesDecodeErrorZPtr {
4494 * A pointer to the contents in the success state.
4495 * Reading from this pointer when `result_ok` is not set is undefined.
4497 struct LDKChannelFeatures *result;
4499 * A pointer to the contents in the error state.
4500 * Reading from this pointer when `result_ok` is set is undefined.
4502 struct LDKDecodeError *err;
4503 } LDKCResult_ChannelFeaturesDecodeErrorZPtr;
4506 * A CResult_ChannelFeaturesDecodeErrorZ represents the result of a fallible operation,
4507 * containing a crate::lightning::ln::features::ChannelFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
4508 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4510 typedef struct LDKCResult_ChannelFeaturesDecodeErrorZ {
4512 * The contents of this CResult_ChannelFeaturesDecodeErrorZ, accessible via either
4513 * `err` or `result` depending on the state of `result_ok`.
4515 union LDKCResult_ChannelFeaturesDecodeErrorZPtr contents;
4517 * Whether this CResult_ChannelFeaturesDecodeErrorZ represents a success state.
4520 } LDKCResult_ChannelFeaturesDecodeErrorZ;
4525 * Features used within a `node_announcement` message.
4527 typedef struct MUST_USE_STRUCT LDKNodeFeatures {
4529 * A pointer to the opaque Rust object.
4530 * Nearly everywhere, inner must be non-null, however in places where
4531 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4533 LDKnativeNodeFeatures *inner;
4535 * Indicates that this is the only struct which contains the same pointer.
4536 * Rust functions which take ownership of an object provided via an argument require
4537 * this to be true and invalidate the object pointed to by inner.
4543 * The contents of CResult_NodeFeaturesDecodeErrorZ
4545 typedef union LDKCResult_NodeFeaturesDecodeErrorZPtr {
4547 * A pointer to the contents in the success state.
4548 * Reading from this pointer when `result_ok` is not set is undefined.
4550 struct LDKNodeFeatures *result;
4552 * A pointer to the contents in the error state.
4553 * Reading from this pointer when `result_ok` is set is undefined.
4555 struct LDKDecodeError *err;
4556 } LDKCResult_NodeFeaturesDecodeErrorZPtr;
4559 * A CResult_NodeFeaturesDecodeErrorZ represents the result of a fallible operation,
4560 * containing a crate::lightning::ln::features::NodeFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
4561 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4563 typedef struct LDKCResult_NodeFeaturesDecodeErrorZ {
4565 * The contents of this CResult_NodeFeaturesDecodeErrorZ, accessible via either
4566 * `err` or `result` depending on the state of `result_ok`.
4568 union LDKCResult_NodeFeaturesDecodeErrorZPtr contents;
4570 * Whether this CResult_NodeFeaturesDecodeErrorZ represents a success state.
4573 } LDKCResult_NodeFeaturesDecodeErrorZ;
4578 * Features used within an invoice.
4580 typedef struct MUST_USE_STRUCT LDKInvoiceFeatures {
4582 * A pointer to the opaque Rust object.
4583 * Nearly everywhere, inner must be non-null, however in places where
4584 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4586 LDKnativeInvoiceFeatures *inner;
4588 * Indicates that this is the only struct which contains the same pointer.
4589 * Rust functions which take ownership of an object provided via an argument require
4590 * this to be true and invalidate the object pointed to by inner.
4593 } LDKInvoiceFeatures;
4596 * The contents of CResult_InvoiceFeaturesDecodeErrorZ
4598 typedef union LDKCResult_InvoiceFeaturesDecodeErrorZPtr {
4600 * A pointer to the contents in the success state.
4601 * Reading from this pointer when `result_ok` is not set is undefined.
4603 struct LDKInvoiceFeatures *result;
4605 * A pointer to the contents in the error state.
4606 * Reading from this pointer when `result_ok` is set is undefined.
4608 struct LDKDecodeError *err;
4609 } LDKCResult_InvoiceFeaturesDecodeErrorZPtr;
4612 * A CResult_InvoiceFeaturesDecodeErrorZ represents the result of a fallible operation,
4613 * containing a crate::lightning::ln::features::InvoiceFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
4614 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4616 typedef struct LDKCResult_InvoiceFeaturesDecodeErrorZ {
4618 * The contents of this CResult_InvoiceFeaturesDecodeErrorZ, accessible via either
4619 * `err` or `result` depending on the state of `result_ok`.
4621 union LDKCResult_InvoiceFeaturesDecodeErrorZPtr contents;
4623 * Whether this CResult_InvoiceFeaturesDecodeErrorZ represents a success state.
4626 } LDKCResult_InvoiceFeaturesDecodeErrorZ;
4629 * The contents of CResult_ChannelTypeFeaturesDecodeErrorZ
4631 typedef union LDKCResult_ChannelTypeFeaturesDecodeErrorZPtr {
4633 * A pointer to the contents in the success state.
4634 * Reading from this pointer when `result_ok` is not set is undefined.
4636 struct LDKChannelTypeFeatures *result;
4638 * A pointer to the contents in the error state.
4639 * Reading from this pointer when `result_ok` is set is undefined.
4641 struct LDKDecodeError *err;
4642 } LDKCResult_ChannelTypeFeaturesDecodeErrorZPtr;
4645 * A CResult_ChannelTypeFeaturesDecodeErrorZ represents the result of a fallible operation,
4646 * containing a crate::lightning::ln::features::ChannelTypeFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
4647 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4649 typedef struct LDKCResult_ChannelTypeFeaturesDecodeErrorZ {
4651 * The contents of this CResult_ChannelTypeFeaturesDecodeErrorZ, accessible via either
4652 * `err` or `result` depending on the state of `result_ok`.
4654 union LDKCResult_ChannelTypeFeaturesDecodeErrorZPtr contents;
4656 * Whether this CResult_ChannelTypeFeaturesDecodeErrorZ represents a success state.
4659 } LDKCResult_ChannelTypeFeaturesDecodeErrorZ;
4662 * The contents of CResult_DelayedPaymentOutputDescriptorDecodeErrorZ
4664 typedef union LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZPtr {
4666 * A pointer to the contents in the success state.
4667 * Reading from this pointer when `result_ok` is not set is undefined.
4669 struct LDKDelayedPaymentOutputDescriptor *result;
4671 * A pointer to the contents in the error state.
4672 * Reading from this pointer when `result_ok` is set is undefined.
4674 struct LDKDecodeError *err;
4675 } LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZPtr;
4678 * A CResult_DelayedPaymentOutputDescriptorDecodeErrorZ represents the result of a fallible operation,
4679 * containing a crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor on success and a crate::lightning::ln::msgs::DecodeError on failure.
4680 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4682 typedef struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ {
4684 * The contents of this CResult_DelayedPaymentOutputDescriptorDecodeErrorZ, accessible via either
4685 * `err` or `result` depending on the state of `result_ok`.
4687 union LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZPtr contents;
4689 * Whether this CResult_DelayedPaymentOutputDescriptorDecodeErrorZ represents a success state.
4692 } LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ;
4695 * The contents of CResult_StaticPaymentOutputDescriptorDecodeErrorZ
4697 typedef union LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZPtr {
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 LDKStaticPaymentOutputDescriptor *result;
4704 * A pointer to the contents in the error state.
4705 * Reading from this pointer when `result_ok` is set is undefined.
4707 struct LDKDecodeError *err;
4708 } LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZPtr;
4711 * A CResult_StaticPaymentOutputDescriptorDecodeErrorZ represents the result of a fallible operation,
4712 * containing a crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor on success and a crate::lightning::ln::msgs::DecodeError on failure.
4713 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4715 typedef struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ {
4717 * The contents of this CResult_StaticPaymentOutputDescriptorDecodeErrorZ, accessible via either
4718 * `err` or `result` depending on the state of `result_ok`.
4720 union LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZPtr contents;
4722 * Whether this CResult_StaticPaymentOutputDescriptorDecodeErrorZ represents a success state.
4725 } LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ;
4728 * The contents of CResult_SpendableOutputDescriptorDecodeErrorZ
4730 typedef union LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr {
4732 * A pointer to the contents in the success state.
4733 * Reading from this pointer when `result_ok` is not set is undefined.
4735 struct LDKSpendableOutputDescriptor *result;
4737 * A pointer to the contents in the error state.
4738 * Reading from this pointer when `result_ok` is set is undefined.
4740 struct LDKDecodeError *err;
4741 } LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr;
4744 * A CResult_SpendableOutputDescriptorDecodeErrorZ represents the result of a fallible operation,
4745 * containing a crate::lightning::chain::keysinterface::SpendableOutputDescriptor on success and a crate::lightning::ln::msgs::DecodeError on failure.
4746 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4748 typedef struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ {
4750 * The contents of this CResult_SpendableOutputDescriptorDecodeErrorZ, accessible via either
4751 * `err` or `result` depending on the state of `result_ok`.
4753 union LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr contents;
4755 * Whether this CResult_SpendableOutputDescriptorDecodeErrorZ represents a success state.
4758 } LDKCResult_SpendableOutputDescriptorDecodeErrorZ;
4761 * A dynamically-allocated array of crate::c_types::ThirtyTwoBytess of arbitrary size.
4762 * This corresponds to std::vector in C++
4764 typedef struct LDKCVec_PaymentPreimageZ {
4766 * The elements in the array.
4767 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4769 struct LDKThirtyTwoBytes *data;
4771 * The number of elements pointed to by `data`.
4774 } LDKCVec_PaymentPreimageZ;
4777 * A tuple of 2 elements. See the individual fields for the types contained.
4779 typedef struct LDKC2Tuple_SignatureCVec_SignatureZZ {
4781 * The element at position 0
4783 struct LDKSignature a;
4785 * The element at position 1
4787 struct LDKCVec_SignatureZ b;
4788 } LDKC2Tuple_SignatureCVec_SignatureZZ;
4791 * The contents of CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ
4793 typedef union LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr {
4795 * A pointer to the contents in the success state.
4796 * Reading from this pointer when `result_ok` is not set is undefined.
4798 struct LDKC2Tuple_SignatureCVec_SignatureZZ *result;
4800 * Note that this value is always NULL, as there are no contents in the Err variant
4803 } LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr;
4806 * A CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ represents the result of a fallible operation,
4807 * containing a crate::c_types::derived::C2Tuple_SignatureCVec_SignatureZZ on success and a () on failure.
4808 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4810 typedef struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ {
4812 * The contents of this CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ, accessible via either
4813 * `err` or `result` depending on the state of `result_ok`.
4815 union LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr contents;
4817 * Whether this CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ represents a success state.
4820 } LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ;
4823 * The contents of CResult_SignatureNoneZ
4825 typedef union LDKCResult_SignatureNoneZPtr {
4827 * A pointer to the contents in the success state.
4828 * Reading from this pointer when `result_ok` is not set is undefined.
4830 struct LDKSignature *result;
4832 * Note that this value is always NULL, as there are no contents in the Err variant
4835 } LDKCResult_SignatureNoneZPtr;
4838 * A CResult_SignatureNoneZ represents the result of a fallible operation,
4839 * containing a crate::c_types::Signature on success and a () on failure.
4840 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4842 typedef struct LDKCResult_SignatureNoneZ {
4844 * The contents of this CResult_SignatureNoneZ, accessible via either
4845 * `err` or `result` depending on the state of `result_ok`.
4847 union LDKCResult_SignatureNoneZPtr contents;
4849 * Whether this CResult_SignatureNoneZ represents a success state.
4852 } LDKCResult_SignatureNoneZ;
4855 * A tuple of 2 elements. See the individual fields for the types contained.
4857 typedef struct LDKC2Tuple_SignatureSignatureZ {
4859 * The element at position 0
4861 struct LDKSignature a;
4863 * The element at position 1
4865 struct LDKSignature b;
4866 } LDKC2Tuple_SignatureSignatureZ;
4869 * The contents of CResult_C2Tuple_SignatureSignatureZNoneZ
4871 typedef union LDKCResult_C2Tuple_SignatureSignatureZNoneZPtr {
4873 * A pointer to the contents in the success state.
4874 * Reading from this pointer when `result_ok` is not set is undefined.
4876 struct LDKC2Tuple_SignatureSignatureZ *result;
4878 * Note that this value is always NULL, as there are no contents in the Err variant
4881 } LDKCResult_C2Tuple_SignatureSignatureZNoneZPtr;
4884 * A CResult_C2Tuple_SignatureSignatureZNoneZ represents the result of a fallible operation,
4885 * containing a crate::c_types::derived::C2Tuple_SignatureSignatureZ on success and a () on failure.
4886 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4888 typedef struct LDKCResult_C2Tuple_SignatureSignatureZNoneZ {
4890 * The contents of this CResult_C2Tuple_SignatureSignatureZNoneZ, accessible via either
4891 * `err` or `result` depending on the state of `result_ok`.
4893 union LDKCResult_C2Tuple_SignatureSignatureZNoneZPtr contents;
4895 * Whether this CResult_C2Tuple_SignatureSignatureZNoneZ represents a success state.
4898 } LDKCResult_C2Tuple_SignatureSignatureZNoneZ;
4901 * The contents of CResult_SecretKeyNoneZ
4903 typedef union LDKCResult_SecretKeyNoneZPtr {
4905 * A pointer to the contents in the success state.
4906 * Reading from this pointer when `result_ok` is not set is undefined.
4908 struct LDKSecretKey *result;
4910 * Note that this value is always NULL, as there are no contents in the Err variant
4913 } LDKCResult_SecretKeyNoneZPtr;
4916 * A CResult_SecretKeyNoneZ represents the result of a fallible operation,
4917 * containing a crate::c_types::SecretKey on success and a () on failure.
4918 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4920 typedef struct LDKCResult_SecretKeyNoneZ {
4922 * The contents of this CResult_SecretKeyNoneZ, accessible via either
4923 * `err` or `result` depending on the state of `result_ok`.
4925 union LDKCResult_SecretKeyNoneZPtr contents;
4927 * Whether this CResult_SecretKeyNoneZ represents a success state.
4930 } LDKCResult_SecretKeyNoneZ;
4935 * This class tracks the per-transaction information needed to build a closing transaction and will
4936 * actually build it and sign.
4938 * This class can be used inside a signer implementation to generate a signature given the relevant
4941 typedef struct MUST_USE_STRUCT LDKClosingTransaction {
4943 * A pointer to the opaque Rust object.
4944 * Nearly everywhere, inner must be non-null, however in places where
4945 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4947 LDKnativeClosingTransaction *inner;
4949 * Indicates that this is the only struct which contains the same pointer.
4950 * Rust functions which take ownership of an object provided via an argument require
4951 * this to be true and invalidate the object pointed to by inner.
4954 } LDKClosingTransaction;
4959 * The unsigned part of a channel_announcement
4961 typedef struct MUST_USE_STRUCT LDKUnsignedChannelAnnouncement {
4963 * A pointer to the opaque Rust object.
4964 * Nearly everywhere, inner must be non-null, however in places where
4965 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4967 LDKnativeUnsignedChannelAnnouncement *inner;
4969 * Indicates that this is the only struct which contains the same pointer.
4970 * Rust functions which take ownership of an object provided via an argument require
4971 * this to be true and invalidate the object pointed to by inner.
4974 } LDKUnsignedChannelAnnouncement;
4977 * A trait to sign lightning channel transactions as described in BOLT 3.
4979 * Signing services could be implemented on a hardware wallet. In this case,
4980 * the current Sign would be a front-end on top of a communication
4981 * channel connected to your secure device and lightning key material wouldn't
4982 * reside on a hot server. Nevertheless, a this deployment would still need
4983 * to trust the ChannelManager to avoid loss of funds as this latest component
4984 * could ask to sign commitment transaction with HTLCs paying to attacker pubkeys.
4986 * A more secure iteration would be to use hashlock (or payment points) to pair
4987 * invoice/incoming HTLCs with outgoing HTLCs to implement a no-trust-ChannelManager
4988 * at the price of more state and computation on the hardware wallet side. In the future,
4989 * we are looking forward to design such interface.
4991 * In any case, ChannelMonitor or fallback watchtowers are always going to be trusted
4992 * to act, as liveness and breach reply correctness are always going to be hard requirements
4993 * of LN security model, orthogonal of key management issues.
4995 typedef struct LDKBaseSign {
4997 * An opaque pointer which is passed to your function implementations as an argument.
4998 * This has no meaning in the LDK, and can be NULL or any other value.
5002 * Gets the per-commitment point for a specific commitment number
5004 * Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
5006 struct LDKPublicKey (*get_per_commitment_point)(const void *this_arg, uint64_t idx);
5008 * Gets the commitment secret for a specific commitment number as part of the revocation process
5010 * An external signer implementation should error here if the commitment was already signed
5011 * and should refuse to sign it in the future.
5013 * May be called more than once for the same index.
5015 * Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
5017 struct LDKThirtyTwoBytes (*release_commitment_secret)(const void *this_arg, uint64_t idx);
5019 * Validate the counterparty's signatures on the holder commitment transaction and HTLCs.
5021 * This is required in order for the signer to make sure that releasing a commitment
5022 * secret won't leave us without a broadcastable holder transaction.
5023 * Policy checks should be implemented in this function, including checking the amount
5024 * sent to us and checking the HTLCs.
5026 * The preimages of outgoing HTLCs that were fulfilled since the last commitment are provided.
5027 * A validating signer should ensure that an HTLC output is removed only when the matching
5028 * preimage is provided, or when the value to holder is restored.
5030 * NOTE: all the relevant preimages will be provided, but there may also be additional
5031 * irrelevant or duplicate preimages.
5033 struct LDKCResult_NoneNoneZ (*validate_holder_commitment)(const void *this_arg, const struct LDKHolderCommitmentTransaction *NONNULL_PTR holder_tx, struct LDKCVec_PaymentPreimageZ preimages);
5035 * Gets the holder's channel public keys and basepoints
5037 struct LDKChannelPublicKeys pubkeys;
5039 * Fill in the pubkeys field as a reference to it will be given to Rust after this returns
5040 * Note that this takes a pointer to this object, not the this_ptr like other methods do
5041 * This function pointer may be NULL if pubkeys is filled in when this object is created and never needs updating.
5043 void (*set_pubkeys)(const struct LDKBaseSign*NONNULL_PTR );
5045 * Gets an arbitrary identifier describing the set of keys which are provided back to you in
5046 * some SpendableOutputDescriptor types. This should be sufficient to identify this
5047 * Sign object uniquely and lookup or re-derive its keys.
5049 struct LDKThirtyTwoBytes (*channel_keys_id)(const void *this_arg);
5051 * Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
5053 * Note that if signing fails or is rejected, the channel will be force-closed.
5055 * Policy checks should be implemented in this function, including checking the amount
5056 * sent to us and checking the HTLCs.
5058 * The preimages of outgoing HTLCs that were fulfilled since the last commitment are provided.
5059 * A validating signer should ensure that an HTLC output is removed only when the matching
5060 * preimage is provided, or when the value to holder is restored.
5062 * NOTE: all the relevant preimages will be provided, but there may also be additional
5063 * irrelevant or duplicate preimages.
5065 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ (*sign_counterparty_commitment)(const void *this_arg, const struct LDKCommitmentTransaction *NONNULL_PTR commitment_tx, struct LDKCVec_PaymentPreimageZ preimages);
5067 * Validate the counterparty's revocation.
5069 * This is required in order for the signer to make sure that the state has moved
5070 * forward and it is safe to sign the next counterparty commitment.
5072 struct LDKCResult_NoneNoneZ (*validate_counterparty_revocation)(const void *this_arg, uint64_t idx, const uint8_t (*secret)[32]);
5074 * Create a signatures for a holder's commitment transaction and its claiming HTLC transactions.
5075 * This will only ever be called with a non-revoked commitment_tx. This will be called with the
5076 * latest commitment_tx when we initiate a force-close.
5077 * This will be called with the previous latest, just to get claiming HTLC signatures, if we are
5078 * reacting to a ChannelMonitor replica that decided to broadcast before it had been updated to
5080 * This may be called multiple times for the same transaction.
5082 * An external signer implementation should check that the commitment has not been revoked.
5084 * May return Err if key derivation fails. Callers, such as ChannelMonitor, will panic in such a case.
5086 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ (*sign_holder_commitment_and_htlcs)(const void *this_arg, const struct LDKHolderCommitmentTransaction *NONNULL_PTR commitment_tx);
5088 * Create a signature for the given input in a transaction spending an HTLC transaction output
5089 * or a commitment transaction `to_local` output when our counterparty broadcasts an old state.
5091 * A justice transaction may claim multiple outputs at the same time if timelocks are
5092 * similar, but only a signature for the input at index `input` should be signed for here.
5093 * It may be called multiple times for same output(s) if a fee-bump is needed with regards
5094 * to an upcoming timelock expiration.
5096 * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
5098 * per_commitment_key is revocation secret which was provided by our counterparty when they
5099 * revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
5100 * not allow the spending of any funds by itself (you need our holder revocation_secret to do
5103 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]);
5105 * Create a signature for the given input in a transaction spending a commitment transaction
5106 * HTLC output when our counterparty broadcasts an old state.
5108 * A justice transaction may claim multiple outputs at the same time if timelocks are
5109 * similar, but only a signature for the input at index `input` should be signed for here.
5110 * It may be called multiple times for same output(s) if a fee-bump is needed with regards
5111 * to an upcoming timelock expiration.
5113 * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
5115 * per_commitment_key is revocation secret which was provided by our counterparty when they
5116 * revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
5117 * not allow the spending of any funds by itself (you need our holder revocation_secret to do
5120 * htlc holds HTLC elements (hash, timelock), thus changing the format of the witness script
5121 * (which is committed to in the BIP 143 signatures).
5123 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);
5125 * Create a signature for a claiming transaction for a HTLC output on a counterparty's commitment
5126 * transaction, either offered or received.
5128 * Such a transaction may claim multiples offered outputs at same time if we know the
5129 * preimage for each when we create it, but only the input at index `input` should be
5130 * signed for here. It may be called multiple times for same output(s) if a fee-bump is
5131 * needed with regards to an upcoming timelock expiration.
5133 * Witness_script is either a offered or received script as defined in BOLT3 for HTLC
5136 * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
5138 * Per_commitment_point is the dynamic point corresponding to the channel state
5139 * detected onchain. It has been generated by our counterparty and is used to derive
5140 * channel state keys, which are then included in the witness script and committed to in the
5141 * BIP 143 signature.
5143 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);
5145 * Create a signature for a (proposed) closing transaction.
5147 * Note that, due to rounding, there may be one \"missing\" satoshi, and either party may have
5148 * chosen to forgo their output as dust.
5150 struct LDKCResult_SignatureNoneZ (*sign_closing_transaction)(const void *this_arg, const struct LDKClosingTransaction *NONNULL_PTR closing_tx);
5152 * Signs a channel announcement message with our funding key and our node secret key (aka
5153 * node_id or network_key), proving it comes from one of the channel participants.
5155 * The first returned signature should be from our node secret key, the second from our
5158 * Note that if this fails or is rejected, the channel will not be publicly announced and
5159 * our counterparty may (though likely will not) close the channel on us for violating the
5162 struct LDKCResult_C2Tuple_SignatureSignatureZNoneZ (*sign_channel_announcement)(const void *this_arg, const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR msg);
5164 * Set the counterparty static channel data, including basepoints,
5165 * counterparty_selected/holder_selected_contest_delay and funding outpoint.
5166 * This is done as soon as the funding outpoint is known. Since these are static channel data,
5167 * they MUST NOT be allowed to change to different values once set.
5169 * channel_parameters.is_populated() MUST be true.
5171 * We bind holder_selected_contest_delay late here for API convenience.
5173 * Will be called before any signatures are applied.
5175 void (*ready_channel)(void *this_arg, const struct LDKChannelTransactionParameters *NONNULL_PTR channel_parameters);
5177 * Frees any resources associated with this object given its this_arg pointer.
5178 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
5180 void (*free)(void *this_arg);
5184 * A cloneable signer.
5186 * Although we require signers to be cloneable, it may be useful for developers to be able to use
5187 * signers in an un-sized way, for example as `dyn BaseSign`. Therefore we separate the Clone trait,
5188 * which implies Sized, into this derived trait.
5190 typedef struct LDKSign {
5192 * An opaque pointer which is passed to your function implementations as an argument.
5193 * This has no meaning in the LDK, and can be NULL or any other value.
5197 * Implementation of BaseSign for this object.
5199 struct LDKBaseSign BaseSign;
5201 * Serialize the object into a byte array
5203 struct LDKCVec_u8Z (*write)(const void *this_arg);
5205 * Called, if set, after this Sign has been cloned into a duplicate object.
5206 * The new Sign is provided, and should be mutated as needed to perform a
5207 * deep copy of the object pointed to by this_arg or avoid any double-freeing.
5209 void (*cloned)(struct LDKSign *NONNULL_PTR new_Sign);
5211 * Frees any resources associated with this object given its this_arg pointer.
5212 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
5214 void (*free)(void *this_arg);
5218 * The contents of CResult_SignDecodeErrorZ
5220 typedef union LDKCResult_SignDecodeErrorZPtr {
5222 * A pointer to the contents in the success state.
5223 * Reading from this pointer when `result_ok` is not set is undefined.
5225 struct LDKSign *result;
5227 * A pointer to the contents in the error state.
5228 * Reading from this pointer when `result_ok` is set is undefined.
5230 struct LDKDecodeError *err;
5231 } LDKCResult_SignDecodeErrorZPtr;
5234 * A CResult_SignDecodeErrorZ represents the result of a fallible operation,
5235 * containing a crate::lightning::chain::keysinterface::Sign on success and a crate::lightning::ln::msgs::DecodeError on failure.
5236 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5238 typedef struct LDKCResult_SignDecodeErrorZ {
5240 * The contents of this CResult_SignDecodeErrorZ, accessible via either
5241 * `err` or `result` depending on the state of `result_ok`.
5243 union LDKCResult_SignDecodeErrorZPtr contents;
5245 * Whether this CResult_SignDecodeErrorZ represents a success state.
5248 } LDKCResult_SignDecodeErrorZ;
5251 * Integer in the range `0..32`
5253 typedef struct LDKu5 {
5258 * A dynamically-allocated array of crate::c_types::u5s of arbitrary size.
5259 * This corresponds to std::vector in C++
5261 typedef struct LDKCVec_u5Z {
5263 * The elements in the array.
5264 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5268 * The number of elements pointed to by `data`.
5274 * Represents a secp256k1 signature serialized as two 32-byte numbers as well as a tag which
5275 * allows recovering the exact public key which created the signature given the message.
5277 typedef struct LDKRecoverableSignature {
5279 * The bytes of the signature in "compact" form plus a "Recovery ID" which allows for
5282 uint8_t serialized_form[68];
5283 } LDKRecoverableSignature;
5286 * The contents of CResult_RecoverableSignatureNoneZ
5288 typedef union LDKCResult_RecoverableSignatureNoneZPtr {
5290 * A pointer to the contents in the success state.
5291 * Reading from this pointer when `result_ok` is not set is undefined.
5293 struct LDKRecoverableSignature *result;
5295 * Note that this value is always NULL, as there are no contents in the Err variant
5298 } LDKCResult_RecoverableSignatureNoneZPtr;
5301 * A CResult_RecoverableSignatureNoneZ represents the result of a fallible operation,
5302 * containing a crate::c_types::RecoverableSignature on success and a () on failure.
5303 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5305 typedef struct LDKCResult_RecoverableSignatureNoneZ {
5307 * The contents of this CResult_RecoverableSignatureNoneZ, accessible via either
5308 * `err` or `result` depending on the state of `result_ok`.
5310 union LDKCResult_RecoverableSignatureNoneZPtr contents;
5312 * Whether this CResult_RecoverableSignatureNoneZ represents a success state.
5315 } LDKCResult_RecoverableSignatureNoneZ;
5318 * A dynamically-allocated array of crate::c_types::derived::CVec_u8Zs of arbitrary size.
5319 * This corresponds to std::vector in C++
5321 typedef struct LDKCVec_CVec_u8ZZ {
5323 * The elements in the array.
5324 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5326 struct LDKCVec_u8Z *data;
5328 * The number of elements pointed to by `data`.
5331 } LDKCVec_CVec_u8ZZ;
5334 * The contents of CResult_CVec_CVec_u8ZZNoneZ
5336 typedef union LDKCResult_CVec_CVec_u8ZZNoneZPtr {
5338 * A pointer to the contents in the success state.
5339 * Reading from this pointer when `result_ok` is not set is undefined.
5341 struct LDKCVec_CVec_u8ZZ *result;
5343 * Note that this value is always NULL, as there are no contents in the Err variant
5346 } LDKCResult_CVec_CVec_u8ZZNoneZPtr;
5349 * A CResult_CVec_CVec_u8ZZNoneZ represents the result of a fallible operation,
5350 * containing a crate::c_types::derived::CVec_CVec_u8ZZ on success and a () on failure.
5351 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5353 typedef struct LDKCResult_CVec_CVec_u8ZZNoneZ {
5355 * The contents of this CResult_CVec_CVec_u8ZZNoneZ, accessible via either
5356 * `err` or `result` depending on the state of `result_ok`.
5358 union LDKCResult_CVec_CVec_u8ZZNoneZPtr contents;
5360 * Whether this CResult_CVec_CVec_u8ZZNoneZ represents a success state.
5363 } LDKCResult_CVec_CVec_u8ZZNoneZ;
5368 * A simple implementation of Sign that just keeps the private keys in memory.
5370 * This implementation performs no policy checks and is insufficient by itself as
5371 * a secure external signer.
5373 typedef struct MUST_USE_STRUCT LDKInMemorySigner {
5375 * A pointer to the opaque Rust object.
5376 * Nearly everywhere, inner must be non-null, however in places where
5377 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5379 LDKnativeInMemorySigner *inner;
5381 * Indicates that this is the only struct which contains the same pointer.
5382 * Rust functions which take ownership of an object provided via an argument require
5383 * this to be true and invalidate the object pointed to by inner.
5386 } LDKInMemorySigner;
5389 * The contents of CResult_InMemorySignerDecodeErrorZ
5391 typedef union LDKCResult_InMemorySignerDecodeErrorZPtr {
5393 * A pointer to the contents in the success state.
5394 * Reading from this pointer when `result_ok` is not set is undefined.
5396 struct LDKInMemorySigner *result;
5398 * A pointer to the contents in the error state.
5399 * Reading from this pointer when `result_ok` is set is undefined.
5401 struct LDKDecodeError *err;
5402 } LDKCResult_InMemorySignerDecodeErrorZPtr;
5405 * A CResult_InMemorySignerDecodeErrorZ represents the result of a fallible operation,
5406 * containing a crate::lightning::chain::keysinterface::InMemorySigner on success and a crate::lightning::ln::msgs::DecodeError on failure.
5407 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5409 typedef struct LDKCResult_InMemorySignerDecodeErrorZ {
5411 * The contents of this CResult_InMemorySignerDecodeErrorZ, accessible via either
5412 * `err` or `result` depending on the state of `result_ok`.
5414 union LDKCResult_InMemorySignerDecodeErrorZPtr contents;
5416 * Whether this CResult_InMemorySignerDecodeErrorZ represents a success state.
5419 } LDKCResult_InMemorySignerDecodeErrorZ;
5422 * A dynamically-allocated array of crate::c_types::TxOuts of arbitrary size.
5423 * This corresponds to std::vector in C++
5425 typedef struct LDKCVec_TxOutZ {
5427 * The elements in the array.
5428 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5430 struct LDKTxOut *data;
5432 * The number of elements pointed to by `data`.
5438 * The contents of CResult_TransactionNoneZ
5440 typedef union LDKCResult_TransactionNoneZPtr {
5442 * A pointer to the contents in the success state.
5443 * Reading from this pointer when `result_ok` is not set is undefined.
5445 struct LDKTransaction *result;
5447 * Note that this value is always NULL, as there are no contents in the Err variant
5450 } LDKCResult_TransactionNoneZPtr;
5453 * A CResult_TransactionNoneZ represents the result of a fallible operation,
5454 * containing a crate::c_types::Transaction on success and a () on failure.
5455 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5457 typedef struct LDKCResult_TransactionNoneZ {
5459 * The contents of this CResult_TransactionNoneZ, accessible via either
5460 * `err` or `result` depending on the state of `result_ok`.
5462 union LDKCResult_TransactionNoneZPtr contents;
5464 * Whether this CResult_TransactionNoneZ represents a success state.
5467 } LDKCResult_TransactionNoneZ;
5472 * A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
5473 * on-chain transactions to ensure no loss of funds occurs.
5475 * You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
5476 * information and are actively monitoring the chain.
5478 * Pending Events or updated HTLCs which have not yet been read out by
5479 * get_and_clear_pending_monitor_events or get_and_clear_pending_events are serialized to disk and
5480 * reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
5481 * gotten are fully handled before re-serializing the new state.
5483 * Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
5484 * tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
5485 * the \"reorg path\" (ie disconnecting blocks until you find a common ancestor from both the
5486 * returned block hash and the the current chain and then reconnecting blocks to get to the
5487 * best chain) upon deserializing the object!
5489 typedef struct MUST_USE_STRUCT LDKChannelMonitor {
5491 * A pointer to the opaque Rust object.
5492 * Nearly everywhere, inner must be non-null, however in places where
5493 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5495 LDKnativeChannelMonitor *inner;
5497 * Indicates that this is the only struct which contains the same pointer.
5498 * Rust functions which take ownership of an object provided via an argument require
5499 * this to be true and invalidate the object pointed to by inner.
5502 } LDKChannelMonitor;
5505 * A tuple of 2 elements. See the individual fields for the types contained.
5507 typedef struct LDKC2Tuple_BlockHashChannelMonitorZ {
5509 * The element at position 0
5511 struct LDKThirtyTwoBytes a;
5513 * The element at position 1
5515 struct LDKChannelMonitor b;
5516 } LDKC2Tuple_BlockHashChannelMonitorZ;
5519 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_BlockHashChannelMonitorZs of arbitrary size.
5520 * This corresponds to std::vector in C++
5522 typedef struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ {
5524 * The elements in the array.
5525 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5527 struct LDKC2Tuple_BlockHashChannelMonitorZ *data;
5529 * The number of elements pointed to by `data`.
5532 } LDKCVec_C2Tuple_BlockHashChannelMonitorZZ;
5535 * The contents of CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ
5537 typedef union LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZPtr {
5539 * A pointer to the contents in the success state.
5540 * Reading from this pointer when `result_ok` is not set is undefined.
5542 struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ *result;
5544 * A pointer to the contents in the error state.
5545 * Reading from this pointer when `result_ok` is set is undefined.
5547 enum LDKIOError *err;
5548 } LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZPtr;
5551 * A CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ represents the result of a fallible operation,
5552 * containing a crate::c_types::derived::CVec_C2Tuple_BlockHashChannelMonitorZZ on success and a crate::c_types::IOError on failure.
5553 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5555 typedef struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ {
5557 * The contents of this CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ, accessible via either
5558 * `err` or `result` depending on the state of `result_ok`.
5560 union LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZPtr contents;
5562 * Whether this CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ represents a success state.
5565 } LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ;
5568 * An enum which can either contain a u16 or not
5570 typedef enum LDKCOption_u16Z_Tag {
5572 * When we're in this state, this COption_u16Z contains a u16
5574 LDKCOption_u16Z_Some,
5576 * When we're in this state, this COption_u16Z contains nothing
5578 LDKCOption_u16Z_None,
5580 * Must be last for serialization purposes
5582 LDKCOption_u16Z_Sentinel,
5583 } LDKCOption_u16Z_Tag;
5585 typedef struct LDKCOption_u16Z {
5586 LDKCOption_u16Z_Tag tag;
5595 * Indicates an error on the client's part (usually some variant of attempting to use too-low or
5598 typedef enum LDKAPIError_Tag {
5600 * Indicates the API was wholly misused (see err for more). Cases where these can be returned
5601 * are documented, but generally indicates some precondition of a function was violated.
5603 LDKAPIError_APIMisuseError,
5605 * Due to a high feerate, we were unable to complete the request.
5606 * For example, this may be returned if the feerate implies we cannot open a channel at the
5607 * requested value, but opening a larger channel would succeed.
5609 LDKAPIError_FeeRateTooHigh,
5611 * A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
5612 * too-many-hops, etc).
5614 LDKAPIError_RouteError,
5616 * We were unable to complete the request as the Channel required to do so is unable to
5617 * complete the request (or was not found). This can take many forms, including disconnected
5618 * peer, channel at capacity, channel shutting down, etc.
5620 LDKAPIError_ChannelUnavailable,
5622 * An attempt to call watch/update_channel returned an Err (ie you did this!), causing the
5623 * attempted action to fail.
5625 LDKAPIError_MonitorUpdateFailed,
5627 * [`KeysInterface::get_shutdown_scriptpubkey`] returned a shutdown scriptpubkey incompatible
5628 * with the channel counterparty as negotiated in [`InitFeatures`].
5630 * Using a SegWit v0 script should resolve this issue. If you cannot, you won't be able to open
5631 * a channel or cooperatively close one with this peer (and will have to force-close instead).
5633 * [`KeysInterface::get_shutdown_scriptpubkey`]: crate::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey
5634 * [`InitFeatures`]: crate::ln::features::InitFeatures
5636 LDKAPIError_IncompatibleShutdownScript,
5638 * Must be last for serialization purposes
5640 LDKAPIError_Sentinel,
5643 typedef struct LDKAPIError_LDKAPIMisuseError_Body {
5645 * A human-readable error message
5648 } LDKAPIError_LDKAPIMisuseError_Body;
5650 typedef struct LDKAPIError_LDKFeeRateTooHigh_Body {
5652 * A human-readable error message
5656 * The feerate which was too high.
5659 } LDKAPIError_LDKFeeRateTooHigh_Body;
5661 typedef struct LDKAPIError_LDKRouteError_Body {
5663 * A human-readable error message
5666 } LDKAPIError_LDKRouteError_Body;
5668 typedef struct LDKAPIError_LDKChannelUnavailable_Body {
5670 * A human-readable error message
5673 } LDKAPIError_LDKChannelUnavailable_Body;
5675 typedef struct LDKAPIError_LDKIncompatibleShutdownScript_Body {
5677 * The incompatible shutdown script.
5679 struct LDKShutdownScript script;
5680 } LDKAPIError_LDKIncompatibleShutdownScript_Body;
5682 typedef struct MUST_USE_STRUCT LDKAPIError {
5683 LDKAPIError_Tag tag;
5685 LDKAPIError_LDKAPIMisuseError_Body api_misuse_error;
5686 LDKAPIError_LDKFeeRateTooHigh_Body fee_rate_too_high;
5687 LDKAPIError_LDKRouteError_Body route_error;
5688 LDKAPIError_LDKChannelUnavailable_Body channel_unavailable;
5689 LDKAPIError_LDKIncompatibleShutdownScript_Body incompatible_shutdown_script;
5694 * The contents of CResult_NoneAPIErrorZ
5696 typedef union LDKCResult_NoneAPIErrorZPtr {
5698 * Note that this value is always NULL, as there are no contents in the OK variant
5702 * A pointer to the contents in the error state.
5703 * Reading from this pointer when `result_ok` is set is undefined.
5705 struct LDKAPIError *err;
5706 } LDKCResult_NoneAPIErrorZPtr;
5709 * A CResult_NoneAPIErrorZ represents the result of a fallible operation,
5710 * containing a () on success and a crate::lightning::util::errors::APIError on failure.
5711 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5713 typedef struct LDKCResult_NoneAPIErrorZ {
5715 * The contents of this CResult_NoneAPIErrorZ, accessible via either
5716 * `err` or `result` depending on the state of `result_ok`.
5718 union LDKCResult_NoneAPIErrorZPtr contents;
5720 * Whether this CResult_NoneAPIErrorZ represents a success state.
5723 } LDKCResult_NoneAPIErrorZ;
5726 * A dynamically-allocated array of crate::c_types::derived::CResult_NoneAPIErrorZs of arbitrary size.
5727 * This corresponds to std::vector in C++
5729 typedef struct LDKCVec_CResult_NoneAPIErrorZZ {
5731 * The elements in the array.
5732 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5734 struct LDKCResult_NoneAPIErrorZ *data;
5736 * The number of elements pointed to by `data`.
5739 } LDKCVec_CResult_NoneAPIErrorZZ;
5742 * A dynamically-allocated array of crate::lightning::util::errors::APIErrors of arbitrary size.
5743 * This corresponds to std::vector in C++
5745 typedef struct LDKCVec_APIErrorZ {
5747 * The elements in the array.
5748 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5750 struct LDKAPIError *data;
5752 * The number of elements pointed to by `data`.
5755 } LDKCVec_APIErrorZ;
5758 * The contents of CResult__u832APIErrorZ
5760 typedef union LDKCResult__u832APIErrorZPtr {
5762 * A pointer to the contents in the success state.
5763 * Reading from this pointer when `result_ok` is not set is undefined.
5765 struct LDKThirtyTwoBytes *result;
5767 * A pointer to the contents in the error state.
5768 * Reading from this pointer when `result_ok` is set is undefined.
5770 struct LDKAPIError *err;
5771 } LDKCResult__u832APIErrorZPtr;
5774 * A CResult__u832APIErrorZ represents the result of a fallible operation,
5775 * containing a crate::c_types::ThirtyTwoBytes on success and a crate::lightning::util::errors::APIError on failure.
5776 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5778 typedef struct LDKCResult__u832APIErrorZ {
5780 * The contents of this CResult__u832APIErrorZ, accessible via either
5781 * `err` or `result` depending on the state of `result_ok`.
5783 union LDKCResult__u832APIErrorZPtr contents;
5785 * Whether this CResult__u832APIErrorZ represents a success state.
5788 } LDKCResult__u832APIErrorZ;
5791 * If a payment fails to send, it can be in one of several states. This enum is returned as the
5792 * Err() type describing which state the payment is in, see the description of individual enum
5795 typedef enum LDKPaymentSendFailure_Tag {
5797 * A parameter which was passed to send_payment was invalid, preventing us from attempting to
5798 * send the payment at all. No channel state has been changed or messages sent to peers, and
5799 * once you've changed the parameter at error, you can freely retry the payment in full.
5801 LDKPaymentSendFailure_ParameterError,
5803 * A parameter in a single path which was passed to send_payment was invalid, preventing us
5804 * from attempting to send the payment at all. No channel state has been changed or messages
5805 * sent to peers, and once you've changed the parameter at error, you can freely retry the
5808 * The results here are ordered the same as the paths in the route object which was passed to
5811 LDKPaymentSendFailure_PathParameterError,
5813 * All paths which were attempted failed to send, with no channel state change taking place.
5814 * You can freely retry the payment in full (though you probably want to do so over different
5815 * paths than the ones selected).
5817 LDKPaymentSendFailure_AllFailedRetrySafe,
5819 * Some paths which were attempted failed to send, though possibly not all. At least some
5820 * paths have irrevocably committed to the HTLC and retrying the payment in full would result
5821 * in over-/re-payment.
5823 * The results here are ordered the same as the paths in the route object which was passed to
5824 * send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
5825 * retried (though there is currently no API with which to do so).
5827 * Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
5828 * as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
5829 * case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
5830 * with the latest update_id.
5832 LDKPaymentSendFailure_PartialFailure,
5834 * Must be last for serialization purposes
5836 LDKPaymentSendFailure_Sentinel,
5837 } LDKPaymentSendFailure_Tag;
5839 typedef struct LDKPaymentSendFailure_LDKPartialFailure_Body {
5841 * The errors themselves, in the same order as the route hops.
5843 struct LDKCVec_CResult_NoneAPIErrorZZ results;
5845 * If some paths failed without irrevocably committing to the new HTLC(s), this will
5846 * contain a [`RouteParameters`] object which can be used to calculate a new route that
5847 * will pay all remaining unpaid balance.
5849 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
5851 struct LDKRouteParameters failed_paths_retry;
5853 * The payment id for the payment, which is now at least partially pending.
5855 struct LDKThirtyTwoBytes payment_id;
5856 } LDKPaymentSendFailure_LDKPartialFailure_Body;
5858 typedef struct MUST_USE_STRUCT LDKPaymentSendFailure {
5859 LDKPaymentSendFailure_Tag tag;
5862 struct LDKAPIError parameter_error;
5865 struct LDKCVec_CResult_NoneAPIErrorZZ path_parameter_error;
5868 struct LDKCVec_APIErrorZ all_failed_retry_safe;
5870 LDKPaymentSendFailure_LDKPartialFailure_Body partial_failure;
5872 } LDKPaymentSendFailure;
5875 * The contents of CResult_PaymentIdPaymentSendFailureZ
5877 typedef union LDKCResult_PaymentIdPaymentSendFailureZPtr {
5879 * A pointer to the contents in the success state.
5880 * Reading from this pointer when `result_ok` is not set is undefined.
5882 struct LDKThirtyTwoBytes *result;
5884 * A pointer to the contents in the error state.
5885 * Reading from this pointer when `result_ok` is set is undefined.
5887 struct LDKPaymentSendFailure *err;
5888 } LDKCResult_PaymentIdPaymentSendFailureZPtr;
5891 * A CResult_PaymentIdPaymentSendFailureZ represents the result of a fallible operation,
5892 * containing a crate::c_types::ThirtyTwoBytes on success and a crate::lightning::ln::channelmanager::PaymentSendFailure on failure.
5893 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5895 typedef struct LDKCResult_PaymentIdPaymentSendFailureZ {
5897 * The contents of this CResult_PaymentIdPaymentSendFailureZ, accessible via either
5898 * `err` or `result` depending on the state of `result_ok`.
5900 union LDKCResult_PaymentIdPaymentSendFailureZPtr contents;
5902 * Whether this CResult_PaymentIdPaymentSendFailureZ represents a success state.
5905 } LDKCResult_PaymentIdPaymentSendFailureZ;
5908 * The contents of CResult_NonePaymentSendFailureZ
5910 typedef union LDKCResult_NonePaymentSendFailureZPtr {
5912 * Note that this value is always NULL, as there are no contents in the OK variant
5916 * A pointer to the contents in the error state.
5917 * Reading from this pointer when `result_ok` is set is undefined.
5919 struct LDKPaymentSendFailure *err;
5920 } LDKCResult_NonePaymentSendFailureZPtr;
5923 * A CResult_NonePaymentSendFailureZ represents the result of a fallible operation,
5924 * containing a () on success and a crate::lightning::ln::channelmanager::PaymentSendFailure on failure.
5925 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5927 typedef struct LDKCResult_NonePaymentSendFailureZ {
5929 * The contents of this CResult_NonePaymentSendFailureZ, accessible via either
5930 * `err` or `result` depending on the state of `result_ok`.
5932 union LDKCResult_NonePaymentSendFailureZPtr contents;
5934 * Whether this CResult_NonePaymentSendFailureZ represents a success state.
5937 } LDKCResult_NonePaymentSendFailureZ;
5940 * A tuple of 2 elements. See the individual fields for the types contained.
5942 typedef struct LDKC2Tuple_PaymentHashPaymentIdZ {
5944 * The element at position 0
5946 struct LDKThirtyTwoBytes a;
5948 * The element at position 1
5950 struct LDKThirtyTwoBytes b;
5951 } LDKC2Tuple_PaymentHashPaymentIdZ;
5954 * The contents of CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ
5956 typedef union LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZPtr {
5958 * A pointer to the contents in the success state.
5959 * Reading from this pointer when `result_ok` is not set is undefined.
5961 struct LDKC2Tuple_PaymentHashPaymentIdZ *result;
5963 * A pointer to the contents in the error state.
5964 * Reading from this pointer when `result_ok` is set is undefined.
5966 struct LDKPaymentSendFailure *err;
5967 } LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZPtr;
5970 * A CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ represents the result of a fallible operation,
5971 * containing a crate::c_types::derived::C2Tuple_PaymentHashPaymentIdZ on success and a crate::lightning::ln::channelmanager::PaymentSendFailure on failure.
5972 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5974 typedef struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ {
5976 * The contents of this CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ, accessible via either
5977 * `err` or `result` depending on the state of `result_ok`.
5979 union LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZPtr contents;
5981 * Whether this CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ represents a success state.
5984 } LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ;
5987 * A 4-byte byte array.
5989 typedef struct LDKFourBytes {
5997 * A 16-byte byte array.
5999 typedef struct LDKSixteenBytes {
6007 * A 12-byte byte array.
6009 typedef struct LDKTwelveBytes {
6017 * An address which can be used to connect to a remote peer
6019 typedef enum LDKNetAddress_Tag {
6021 * An IPv4 address/port on which the peer is listening.
6025 * An IPv6 address/port on which the peer is listening.
6029 * An old-style Tor onion address/port on which the peer is listening.
6031 * This field is deprecated and the Tor network generally no longer supports V2 Onion
6032 * addresses. Thus, the details are not parsed here.
6034 LDKNetAddress_OnionV2,
6036 * A new-style Tor onion address/port on which the peer is listening.
6037 * To create the human-readable \"hostname\", concatenate ed25519_pubkey, checksum, and version,
6038 * wrap as base32 and append \".onion\".
6040 LDKNetAddress_OnionV3,
6042 * Must be last for serialization purposes
6044 LDKNetAddress_Sentinel,
6045 } LDKNetAddress_Tag;
6047 typedef struct LDKNetAddress_LDKIPv4_Body {
6049 * The 4-byte IPv4 address
6051 struct LDKFourBytes addr;
6053 * The port on which the node is listening
6056 } LDKNetAddress_LDKIPv4_Body;
6058 typedef struct LDKNetAddress_LDKIPv6_Body {
6060 * The 16-byte IPv6 address
6062 struct LDKSixteenBytes addr;
6064 * The port on which the node is listening
6067 } LDKNetAddress_LDKIPv6_Body;
6069 typedef struct LDKNetAddress_LDKOnionV3_Body {
6071 * The ed25519 long-term public key of the peer
6073 struct LDKThirtyTwoBytes ed25519_pubkey;
6075 * The checksum of the pubkey and version, as included in the onion address
6079 * The version byte, as defined by the Tor Onion v3 spec.
6083 * The port on which the node is listening
6086 } LDKNetAddress_LDKOnionV3_Body;
6088 typedef struct MUST_USE_STRUCT LDKNetAddress {
6089 LDKNetAddress_Tag tag;
6091 LDKNetAddress_LDKIPv4_Body i_pv4;
6092 LDKNetAddress_LDKIPv6_Body i_pv6;
6094 struct LDKTwelveBytes onion_v2;
6096 LDKNetAddress_LDKOnionV3_Body onion_v3;
6101 * A dynamically-allocated array of crate::lightning::ln::msgs::NetAddresss of arbitrary size.
6102 * This corresponds to std::vector in C++
6104 typedef struct LDKCVec_NetAddressZ {
6106 * The elements in the array.
6107 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6109 struct LDKNetAddress *data;
6111 * The number of elements pointed to by `data`.
6114 } LDKCVec_NetAddressZ;
6117 * A tuple of 2 elements. See the individual fields for the types contained.
6119 typedef struct LDKC2Tuple_PaymentHashPaymentSecretZ {
6121 * The element at position 0
6123 struct LDKThirtyTwoBytes a;
6125 * The element at position 1
6127 struct LDKThirtyTwoBytes b;
6128 } LDKC2Tuple_PaymentHashPaymentSecretZ;
6131 * The contents of CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ
6133 typedef union LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZPtr {
6135 * A pointer to the contents in the success state.
6136 * Reading from this pointer when `result_ok` is not set is undefined.
6138 struct LDKC2Tuple_PaymentHashPaymentSecretZ *result;
6140 * Note that this value is always NULL, as there are no contents in the Err variant
6143 } LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZPtr;
6146 * A CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ represents the result of a fallible operation,
6147 * containing a crate::c_types::derived::C2Tuple_PaymentHashPaymentSecretZ on success and a () on failure.
6148 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6150 typedef struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ {
6152 * The contents of this CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ, accessible via either
6153 * `err` or `result` depending on the state of `result_ok`.
6155 union LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZPtr contents;
6157 * Whether this CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ represents a success state.
6160 } LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ;
6163 * The contents of CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ
6165 typedef union LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZPtr {
6167 * A pointer to the contents in the success state.
6168 * Reading from this pointer when `result_ok` is not set is undefined.
6170 struct LDKC2Tuple_PaymentHashPaymentSecretZ *result;
6172 * A pointer to the contents in the error state.
6173 * Reading from this pointer when `result_ok` is set is undefined.
6175 struct LDKAPIError *err;
6176 } LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZPtr;
6179 * A CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ represents the result of a fallible operation,
6180 * containing a crate::c_types::derived::C2Tuple_PaymentHashPaymentSecretZ on success and a crate::lightning::util::errors::APIError on failure.
6181 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6183 typedef struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ {
6185 * The contents of this CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ, accessible via either
6186 * `err` or `result` depending on the state of `result_ok`.
6188 union LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZPtr contents;
6190 * Whether this CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ represents a success state.
6193 } LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ;
6196 * The contents of CResult_PaymentSecretNoneZ
6198 typedef union LDKCResult_PaymentSecretNoneZPtr {
6200 * A pointer to the contents in the success state.
6201 * Reading from this pointer when `result_ok` is not set is undefined.
6203 struct LDKThirtyTwoBytes *result;
6205 * Note that this value is always NULL, as there are no contents in the Err variant
6208 } LDKCResult_PaymentSecretNoneZPtr;
6211 * A CResult_PaymentSecretNoneZ represents the result of a fallible operation,
6212 * containing a crate::c_types::ThirtyTwoBytes on success and a () on failure.
6213 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6215 typedef struct LDKCResult_PaymentSecretNoneZ {
6217 * The contents of this CResult_PaymentSecretNoneZ, accessible via either
6218 * `err` or `result` depending on the state of `result_ok`.
6220 union LDKCResult_PaymentSecretNoneZPtr contents;
6222 * Whether this CResult_PaymentSecretNoneZ represents a success state.
6225 } LDKCResult_PaymentSecretNoneZ;
6228 * The contents of CResult_PaymentSecretAPIErrorZ
6230 typedef union LDKCResult_PaymentSecretAPIErrorZPtr {
6232 * A pointer to the contents in the success state.
6233 * Reading from this pointer when `result_ok` is not set is undefined.
6235 struct LDKThirtyTwoBytes *result;
6237 * A pointer to the contents in the error state.
6238 * Reading from this pointer when `result_ok` is set is undefined.
6240 struct LDKAPIError *err;
6241 } LDKCResult_PaymentSecretAPIErrorZPtr;
6244 * A CResult_PaymentSecretAPIErrorZ represents the result of a fallible operation,
6245 * containing a crate::c_types::ThirtyTwoBytes on success and a crate::lightning::util::errors::APIError on failure.
6246 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6248 typedef struct LDKCResult_PaymentSecretAPIErrorZ {
6250 * The contents of this CResult_PaymentSecretAPIErrorZ, accessible via either
6251 * `err` or `result` depending on the state of `result_ok`.
6253 union LDKCResult_PaymentSecretAPIErrorZPtr contents;
6255 * Whether this CResult_PaymentSecretAPIErrorZ represents a success state.
6258 } LDKCResult_PaymentSecretAPIErrorZ;
6261 * The contents of CResult_PaymentPreimageAPIErrorZ
6263 typedef union LDKCResult_PaymentPreimageAPIErrorZPtr {
6265 * A pointer to the contents in the success state.
6266 * Reading from this pointer when `result_ok` is not set is undefined.
6268 struct LDKThirtyTwoBytes *result;
6270 * A pointer to the contents in the error state.
6271 * Reading from this pointer when `result_ok` is set is undefined.
6273 struct LDKAPIError *err;
6274 } LDKCResult_PaymentPreimageAPIErrorZPtr;
6277 * A CResult_PaymentPreimageAPIErrorZ represents the result of a fallible operation,
6278 * containing a crate::c_types::ThirtyTwoBytes on success and a crate::lightning::util::errors::APIError on failure.
6279 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6281 typedef struct LDKCResult_PaymentPreimageAPIErrorZ {
6283 * The contents of this CResult_PaymentPreimageAPIErrorZ, accessible via either
6284 * `err` or `result` depending on the state of `result_ok`.
6286 union LDKCResult_PaymentPreimageAPIErrorZPtr contents;
6288 * Whether this CResult_PaymentPreimageAPIErrorZ represents a success state.
6291 } LDKCResult_PaymentPreimageAPIErrorZ;
6296 * Information needed for constructing an invoice route hint for this channel.
6298 typedef struct MUST_USE_STRUCT LDKCounterpartyForwardingInfo {
6300 * A pointer to the opaque Rust object.
6301 * Nearly everywhere, inner must be non-null, however in places where
6302 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6304 LDKnativeCounterpartyForwardingInfo *inner;
6306 * Indicates that this is the only struct which contains the same pointer.
6307 * Rust functions which take ownership of an object provided via an argument require
6308 * this to be true and invalidate the object pointed to by inner.
6311 } LDKCounterpartyForwardingInfo;
6314 * The contents of CResult_CounterpartyForwardingInfoDecodeErrorZ
6316 typedef union LDKCResult_CounterpartyForwardingInfoDecodeErrorZPtr {
6318 * A pointer to the contents in the success state.
6319 * Reading from this pointer when `result_ok` is not set is undefined.
6321 struct LDKCounterpartyForwardingInfo *result;
6323 * A pointer to the contents in the error state.
6324 * Reading from this pointer when `result_ok` is set is undefined.
6326 struct LDKDecodeError *err;
6327 } LDKCResult_CounterpartyForwardingInfoDecodeErrorZPtr;
6330 * A CResult_CounterpartyForwardingInfoDecodeErrorZ represents the result of a fallible operation,
6331 * containing a crate::lightning::ln::channelmanager::CounterpartyForwardingInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
6332 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6334 typedef struct LDKCResult_CounterpartyForwardingInfoDecodeErrorZ {
6336 * The contents of this CResult_CounterpartyForwardingInfoDecodeErrorZ, accessible via either
6337 * `err` or `result` depending on the state of `result_ok`.
6339 union LDKCResult_CounterpartyForwardingInfoDecodeErrorZPtr contents;
6341 * Whether this CResult_CounterpartyForwardingInfoDecodeErrorZ represents a success state.
6344 } LDKCResult_CounterpartyForwardingInfoDecodeErrorZ;
6349 * Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
6350 * to better separate parameters.
6352 typedef struct MUST_USE_STRUCT LDKChannelCounterparty {
6354 * A pointer to the opaque Rust object.
6355 * Nearly everywhere, inner must be non-null, however in places where
6356 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6358 LDKnativeChannelCounterparty *inner;
6360 * Indicates that this is the only struct which contains the same pointer.
6361 * Rust functions which take ownership of an object provided via an argument require
6362 * this to be true and invalidate the object pointed to by inner.
6365 } LDKChannelCounterparty;
6368 * The contents of CResult_ChannelCounterpartyDecodeErrorZ
6370 typedef union LDKCResult_ChannelCounterpartyDecodeErrorZPtr {
6372 * A pointer to the contents in the success state.
6373 * Reading from this pointer when `result_ok` is not set is undefined.
6375 struct LDKChannelCounterparty *result;
6377 * A pointer to the contents in the error state.
6378 * Reading from this pointer when `result_ok` is set is undefined.
6380 struct LDKDecodeError *err;
6381 } LDKCResult_ChannelCounterpartyDecodeErrorZPtr;
6384 * A CResult_ChannelCounterpartyDecodeErrorZ represents the result of a fallible operation,
6385 * containing a crate::lightning::ln::channelmanager::ChannelCounterparty on success and a crate::lightning::ln::msgs::DecodeError on failure.
6386 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6388 typedef struct LDKCResult_ChannelCounterpartyDecodeErrorZ {
6390 * The contents of this CResult_ChannelCounterpartyDecodeErrorZ, accessible via either
6391 * `err` or `result` depending on the state of `result_ok`.
6393 union LDKCResult_ChannelCounterpartyDecodeErrorZPtr contents;
6395 * Whether this CResult_ChannelCounterpartyDecodeErrorZ represents a success state.
6398 } LDKCResult_ChannelCounterpartyDecodeErrorZ;
6401 * The contents of CResult_ChannelDetailsDecodeErrorZ
6403 typedef union LDKCResult_ChannelDetailsDecodeErrorZPtr {
6405 * A pointer to the contents in the success state.
6406 * Reading from this pointer when `result_ok` is not set is undefined.
6408 struct LDKChannelDetails *result;
6410 * A pointer to the contents in the error state.
6411 * Reading from this pointer when `result_ok` is set is undefined.
6413 struct LDKDecodeError *err;
6414 } LDKCResult_ChannelDetailsDecodeErrorZPtr;
6417 * A CResult_ChannelDetailsDecodeErrorZ represents the result of a fallible operation,
6418 * containing a crate::lightning::ln::channelmanager::ChannelDetails on success and a crate::lightning::ln::msgs::DecodeError on failure.
6419 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6421 typedef struct LDKCResult_ChannelDetailsDecodeErrorZ {
6423 * The contents of this CResult_ChannelDetailsDecodeErrorZ, accessible via either
6424 * `err` or `result` depending on the state of `result_ok`.
6426 union LDKCResult_ChannelDetailsDecodeErrorZPtr contents;
6428 * Whether this CResult_ChannelDetailsDecodeErrorZ represents a success state.
6431 } LDKCResult_ChannelDetailsDecodeErrorZ;
6436 * Route hints used in constructing invoices for [phantom node payents].
6438 * [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
6440 typedef struct MUST_USE_STRUCT LDKPhantomRouteHints {
6442 * A pointer to the opaque Rust object.
6443 * Nearly everywhere, inner must be non-null, however in places where
6444 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6446 LDKnativePhantomRouteHints *inner;
6448 * Indicates that this is the only struct which contains the same pointer.
6449 * Rust functions which take ownership of an object provided via an argument require
6450 * this to be true and invalidate the object pointed to by inner.
6453 } LDKPhantomRouteHints;
6456 * The contents of CResult_PhantomRouteHintsDecodeErrorZ
6458 typedef union LDKCResult_PhantomRouteHintsDecodeErrorZPtr {
6460 * A pointer to the contents in the success state.
6461 * Reading from this pointer when `result_ok` is not set is undefined.
6463 struct LDKPhantomRouteHints *result;
6465 * A pointer to the contents in the error state.
6466 * Reading from this pointer when `result_ok` is set is undefined.
6468 struct LDKDecodeError *err;
6469 } LDKCResult_PhantomRouteHintsDecodeErrorZPtr;
6472 * A CResult_PhantomRouteHintsDecodeErrorZ represents the result of a fallible operation,
6473 * containing a crate::lightning::ln::channelmanager::PhantomRouteHints on success and a crate::lightning::ln::msgs::DecodeError on failure.
6474 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6476 typedef struct LDKCResult_PhantomRouteHintsDecodeErrorZ {
6478 * The contents of this CResult_PhantomRouteHintsDecodeErrorZ, accessible via either
6479 * `err` or `result` depending on the state of `result_ok`.
6481 union LDKCResult_PhantomRouteHintsDecodeErrorZPtr contents;
6483 * Whether this CResult_PhantomRouteHintsDecodeErrorZ represents a success state.
6486 } LDKCResult_PhantomRouteHintsDecodeErrorZ;
6489 * A dynamically-allocated array of crate::lightning::chain::channelmonitor::ChannelMonitors of arbitrary size.
6490 * This corresponds to std::vector in C++
6492 typedef struct LDKCVec_ChannelMonitorZ {
6494 * The elements in the array.
6495 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6497 struct LDKChannelMonitor *data;
6499 * The number of elements pointed to by `data`.
6502 } LDKCVec_ChannelMonitorZ;
6507 * An update generated by the underlying Channel itself which contains some new information the
6508 * ChannelMonitor should be made aware of.
6510 typedef struct MUST_USE_STRUCT LDKChannelMonitorUpdate {
6512 * A pointer to the opaque Rust object.
6513 * Nearly everywhere, inner must be non-null, however in places where
6514 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6516 LDKnativeChannelMonitorUpdate *inner;
6518 * Indicates that this is the only struct which contains the same pointer.
6519 * Rust functions which take ownership of an object provided via an argument require
6520 * this to be true and invalidate the object pointed to by inner.
6523 } LDKChannelMonitorUpdate;
6526 * The `Watch` trait defines behavior for watching on-chain activity pertaining to channels as
6527 * blocks are connected and disconnected.
6529 * Each channel is associated with a [`ChannelMonitor`]. Implementations of this trait are
6530 * responsible for maintaining a set of monitors such that they can be updated accordingly as
6531 * channel state changes and HTLCs are resolved. See method documentation for specific
6534 * Implementations **must** ensure that updates are successfully applied and persisted upon method
6535 * completion. If an update fails with a [`PermanentFailure`], then it must immediately shut down
6536 * without taking any further action such as persisting the current state.
6538 * If an implementation maintains multiple instances of a channel's monitor (e.g., by storing
6539 * backup copies), then it must ensure that updates are applied across all instances. Otherwise, it
6540 * could result in a revoked transaction being broadcast, allowing the counterparty to claim all
6541 * funds in the channel. See [`ChannelMonitorUpdateErr`] for more details about how to handle
6542 * multiple instances.
6544 * [`PermanentFailure`]: ChannelMonitorUpdateErr::PermanentFailure
6546 typedef struct LDKWatch {
6548 * An opaque pointer which is passed to your function implementations as an argument.
6549 * This has no meaning in the LDK, and can be NULL or any other value.
6553 * Watches a channel identified by `funding_txo` using `monitor`.
6555 * Implementations are responsible for watching the chain for the funding transaction along
6556 * with any spends of outputs returned by [`get_outputs_to_watch`]. In practice, this means
6557 * calling [`block_connected`] and [`block_disconnected`] on the monitor.
6559 * Note: this interface MUST error with `ChannelMonitorUpdateErr::PermanentFailure` if
6560 * the given `funding_txo` has previously been registered via `watch_channel`.
6562 * [`get_outputs_to_watch`]: channelmonitor::ChannelMonitor::get_outputs_to_watch
6563 * [`block_connected`]: channelmonitor::ChannelMonitor::block_connected
6564 * [`block_disconnected`]: channelmonitor::ChannelMonitor::block_disconnected
6566 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*watch_channel)(const void *this_arg, struct LDKOutPoint funding_txo, struct LDKChannelMonitor monitor);
6568 * Updates a channel identified by `funding_txo` by applying `update` to its monitor.
6570 * Implementations must call [`update_monitor`] with the given update. See
6571 * [`ChannelMonitorUpdateErr`] for invariants around returning an error.
6573 * [`update_monitor`]: channelmonitor::ChannelMonitor::update_monitor
6575 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*update_channel)(const void *this_arg, struct LDKOutPoint funding_txo, struct LDKChannelMonitorUpdate update);
6577 * Returns any monitor events since the last call. Subsequent calls must only return new
6580 * Note that after any block- or transaction-connection calls to a [`ChannelMonitor`], no
6581 * further events may be returned here until the [`ChannelMonitor`] has been fully persisted
6584 * For details on asynchronous [`ChannelMonitor`] updating and returning
6585 * [`MonitorEvent::UpdateCompleted`] here, see [`ChannelMonitorUpdateErr::TemporaryFailure`].
6587 struct LDKCVec_MonitorEventZ (*release_pending_monitor_events)(const void *this_arg);
6589 * Frees any resources associated with this object given its this_arg pointer.
6590 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6592 void (*free)(void *this_arg);
6596 * An interface to send a transaction to the Bitcoin network.
6598 typedef struct LDKBroadcasterInterface {
6600 * An opaque pointer which is passed to your function implementations as an argument.
6601 * This has no meaning in the LDK, and can be NULL or any other value.
6605 * Sends a transaction out to (hopefully) be mined.
6607 void (*broadcast_transaction)(const void *this_arg, struct LDKTransaction tx);
6609 * Frees any resources associated with this object given its this_arg pointer.
6610 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6612 void (*free)(void *this_arg);
6613 } LDKBroadcasterInterface;
6616 * A "slice" referencing some byte array. This is simply a length-tagged pointer which does not
6617 * own the memory pointed to by data.
6619 typedef struct LDKu8slice {
6621 * A pointer to the byte buffer
6623 const uint8_t *data;
6625 * The number of bytes pointed to by `data`.
6631 * A trait to describe an object which can get user secrets and key material.
6633 typedef struct LDKKeysInterface {
6635 * An opaque pointer which is passed to your function implementations as an argument.
6636 * This has no meaning in the LDK, and can be NULL or any other value.
6640 * Get node secret key (aka node_id or network_key) based on the provided [`Recipient`].
6642 * This method must return the same value each time it is called with a given `Recipient`
6645 struct LDKCResult_SecretKeyNoneZ (*get_node_secret)(const void *this_arg, enum LDKRecipient recipient);
6647 * Get a script pubkey which we send funds to when claiming on-chain contestable outputs.
6649 * This method should return a different value each time it is called, to avoid linking
6650 * on-chain funds across channels as controlled to the same user.
6652 struct LDKCVec_u8Z (*get_destination_script)(const void *this_arg);
6654 * Get a script pubkey which we will send funds to when closing a channel.
6656 * This method should return a different value each time it is called, to avoid linking
6657 * on-chain funds across channels as controlled to the same user.
6659 struct LDKShutdownScript (*get_shutdown_scriptpubkey)(const void *this_arg);
6661 * Get a new set of Sign for per-channel secrets. These MUST be unique even if you
6662 * restarted with some stale data!
6664 * This method must return a different value each time it is called.
6666 struct LDKSign (*get_channel_signer)(const void *this_arg, bool inbound, uint64_t channel_value_satoshis);
6668 * Gets a unique, cryptographically-secure, random 32 byte value. This is used for encrypting
6669 * onion packets and for temporary channel IDs. There is no requirement that these be
6670 * persisted anywhere, though they must be unique across restarts.
6672 * This method must return a different value each time it is called.
6674 struct LDKThirtyTwoBytes (*get_secure_random_bytes)(const void *this_arg);
6676 * Reads a `Signer` for this `KeysInterface` from the given input stream.
6677 * This is only called during deserialization of other objects which contain
6678 * `Sign`-implementing objects (ie `ChannelMonitor`s and `ChannelManager`s).
6679 * The bytes are exactly those which `<Self::Signer as Writeable>::write()` writes, and
6680 * contain no versioning scheme. You may wish to include your own version prefix and ensure
6681 * you've read all of the provided bytes to ensure no corruption occurred.
6683 struct LDKCResult_SignDecodeErrorZ (*read_chan_signer)(const void *this_arg, struct LDKu8slice reader);
6686 * By parameterizing by the raw invoice bytes instead of the hash, we allow implementors of
6687 * this trait to parse the invoice and make sure they're signing what they expect, rather than
6688 * blindly signing the hash.
6689 * The hrp is ascii bytes, while the invoice data is base32.
6691 * The secret key used to sign the invoice is dependent on the [`Recipient`].
6693 struct LDKCResult_RecoverableSignatureNoneZ (*sign_invoice)(const void *this_arg, struct LDKu8slice hrp_bytes, struct LDKCVec_u5Z invoice_data, enum LDKRecipient receipient);
6695 * Get secret key material as bytes for use in encrypting and decrypting inbound payment data.
6697 * If the implementor of this trait supports [phantom node payments], then every node that is
6698 * intended to be included in the phantom invoice route hints must return the same value from
6701 * This method must return the same value each time it is called.
6703 * [phantom node payments]: PhantomKeysManager
6705 struct LDKThirtyTwoBytes (*get_inbound_payment_key_material)(const void *this_arg);
6707 * Frees any resources associated with this object given its this_arg pointer.
6708 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6710 void (*free)(void *this_arg);
6714 * A trait which should be implemented to provide feerate information on a number of time
6717 * Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
6718 * called from inside the library in response to chain events, P2P events, or timer events).
6720 typedef struct LDKFeeEstimator {
6722 * An opaque pointer which is passed to your function implementations as an argument.
6723 * This has no meaning in the LDK, and can be NULL or any other value.
6727 * Gets estimated satoshis of fee required per 1000 Weight-Units.
6729 * Must return a value no smaller than 253 (ie 1 satoshi-per-byte rounded up to ensure later
6730 * round-downs don't put us below 1 satoshi-per-byte).
6732 * This method can be implemented with the following unit conversions:
6733 * * max(satoshis-per-byte * 250, 253)
6734 * * max(satoshis-per-kbyte / 4, 253)
6736 uint32_t (*get_est_sat_per_1000_weight)(const void *this_arg, enum LDKConfirmationTarget confirmation_target);
6738 * Frees any resources associated with this object given its this_arg pointer.
6739 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6741 void (*free)(void *this_arg);
6747 * A Record, unit of logging output with Metadata to enable filtering
6748 * Module_path, file, line to inform on log's source
6750 typedef struct MUST_USE_STRUCT LDKRecord {
6752 * A pointer to the opaque Rust object.
6753 * Nearly everywhere, inner must be non-null, however in places where
6754 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6756 LDKnativeRecord *inner;
6758 * Indicates that this is the only struct which contains the same pointer.
6759 * Rust functions which take ownership of an object provided via an argument require
6760 * this to be true and invalidate the object pointed to by inner.
6766 * A trait encapsulating the operations required of a logger
6768 typedef struct LDKLogger {
6770 * An opaque pointer which is passed to your function implementations as an argument.
6771 * This has no meaning in the LDK, and can be NULL or any other value.
6777 void (*log)(const void *this_arg, const struct LDKRecord *NONNULL_PTR record);
6779 * Frees any resources associated with this object given its this_arg pointer.
6780 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6782 void (*free)(void *this_arg);
6788 * Manager which keeps track of a number of channels and sends messages to the appropriate
6789 * channel, also tracking HTLC preimages and forwarding onion packets appropriately.
6791 * Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
6792 * to individual Channels.
6794 * Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
6795 * all peers during write/read (though does not modify this instance, only the instance being
6796 * serialized). This will result in any channels which have not yet exchanged funding_created (ie
6797 * called funding_transaction_generated for outbound channels).
6799 * Note that you can be a bit lazier about writing out ChannelManager than you can be with
6800 * ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
6801 * returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
6802 * happens out-of-band (and will prevent any other ChannelManager operations from occurring during
6803 * the serialization process). If the deserialized version is out-of-date compared to the
6804 * ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
6805 * ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
6807 * Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
6808 * tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
6809 * the \"reorg path\" (ie call block_disconnected() until you get to a common block and then call
6810 * block_connected() to step towards your best block) upon deserialization before using the
6813 * Note that ChannelManager is responsible for tracking liveness of its channels and generating
6814 * ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
6815 * spam due to quick disconnection/reconnection, updates are not sent until the channel has been
6816 * offline for a full minute. In order to track this, you must call
6817 * timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
6819 * Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
6820 * a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
6821 * essentially you should default to using a SimpleRefChannelManager, and use a
6822 * SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
6823 * you're using lightning-net-tokio.
6825 typedef struct MUST_USE_STRUCT LDKChannelManager {
6827 * A pointer to the opaque Rust object.
6828 * Nearly everywhere, inner must be non-null, however in places where
6829 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6831 LDKnativeChannelManager *inner;
6833 * Indicates that this is the only struct which contains the same pointer.
6834 * Rust functions which take ownership of an object provided via an argument require
6835 * this to be true and invalidate the object pointed to by inner.
6838 } LDKChannelManager;
6841 * A tuple of 2 elements. See the individual fields for the types contained.
6843 typedef struct LDKC2Tuple_BlockHashChannelManagerZ {
6845 * The element at position 0
6847 struct LDKThirtyTwoBytes a;
6849 * The element at position 1
6851 struct LDKChannelManager b;
6852 } LDKC2Tuple_BlockHashChannelManagerZ;
6855 * The contents of CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ
6857 typedef union LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr {
6859 * A pointer to the contents in the success state.
6860 * Reading from this pointer when `result_ok` is not set is undefined.
6862 struct LDKC2Tuple_BlockHashChannelManagerZ *result;
6864 * A pointer to the contents in the error state.
6865 * Reading from this pointer when `result_ok` is set is undefined.
6867 struct LDKDecodeError *err;
6868 } LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr;
6871 * A CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ represents the result of a fallible operation,
6872 * containing a crate::c_types::derived::C2Tuple_BlockHashChannelManagerZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
6873 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6875 typedef struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ {
6877 * The contents of this CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ, accessible via either
6878 * `err` or `result` depending on the state of `result_ok`.
6880 union LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr contents;
6882 * Whether this CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ represents a success state.
6885 } LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ;
6890 * Options which apply on a per-channel basis and may change at runtime or based on negotiation
6891 * with our counterparty.
6893 typedef struct MUST_USE_STRUCT LDKChannelConfig {
6895 * A pointer to the opaque Rust object.
6896 * Nearly everywhere, inner must be non-null, however in places where
6897 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6899 LDKnativeChannelConfig *inner;
6901 * Indicates that this is the only struct which contains the same pointer.
6902 * Rust functions which take ownership of an object provided via an argument require
6903 * this to be true and invalidate the object pointed to by inner.
6909 * The contents of CResult_ChannelConfigDecodeErrorZ
6911 typedef union LDKCResult_ChannelConfigDecodeErrorZPtr {
6913 * A pointer to the contents in the success state.
6914 * Reading from this pointer when `result_ok` is not set is undefined.
6916 struct LDKChannelConfig *result;
6918 * A pointer to the contents in the error state.
6919 * Reading from this pointer when `result_ok` is set is undefined.
6921 struct LDKDecodeError *err;
6922 } LDKCResult_ChannelConfigDecodeErrorZPtr;
6925 * A CResult_ChannelConfigDecodeErrorZ represents the result of a fallible operation,
6926 * containing a crate::lightning::util::config::ChannelConfig on success and a crate::lightning::ln::msgs::DecodeError on failure.
6927 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6929 typedef struct LDKCResult_ChannelConfigDecodeErrorZ {
6931 * The contents of this CResult_ChannelConfigDecodeErrorZ, accessible via either
6932 * `err` or `result` depending on the state of `result_ok`.
6934 union LDKCResult_ChannelConfigDecodeErrorZPtr contents;
6936 * Whether this CResult_ChannelConfigDecodeErrorZ represents a success state.
6939 } LDKCResult_ChannelConfigDecodeErrorZ;
6942 * The contents of CResult_OutPointDecodeErrorZ
6944 typedef union LDKCResult_OutPointDecodeErrorZPtr {
6946 * A pointer to the contents in the success state.
6947 * Reading from this pointer when `result_ok` is not set is undefined.
6949 struct LDKOutPoint *result;
6951 * A pointer to the contents in the error state.
6952 * Reading from this pointer when `result_ok` is set is undefined.
6954 struct LDKDecodeError *err;
6955 } LDKCResult_OutPointDecodeErrorZPtr;
6958 * A CResult_OutPointDecodeErrorZ represents the result of a fallible operation,
6959 * containing a crate::lightning::chain::transaction::OutPoint on success and a crate::lightning::ln::msgs::DecodeError on failure.
6960 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6962 typedef struct LDKCResult_OutPointDecodeErrorZ {
6964 * The contents of this CResult_OutPointDecodeErrorZ, accessible via either
6965 * `err` or `result` depending on the state of `result_ok`.
6967 union LDKCResult_OutPointDecodeErrorZPtr contents;
6969 * Whether this CResult_OutPointDecodeErrorZ represents a success state.
6972 } LDKCResult_OutPointDecodeErrorZ;
6975 * Defines a type identifier for sending messages over the wire.
6977 * Messages implementing this trait specify a type and must be [`Writeable`].
6979 typedef struct LDKType {
6981 * An opaque pointer which is passed to your function implementations as an argument.
6982 * This has no meaning in the LDK, and can be NULL or any other value.
6986 * Returns the type identifying the message payload.
6988 uint16_t (*type_id)(const void *this_arg);
6990 * Return a human-readable "debug" string describing this object
6992 struct LDKStr (*debug_str)(const void *this_arg);
6994 * Serialize the object into a byte array
6996 struct LDKCVec_u8Z (*write)(const void *this_arg);
6998 * Frees any resources associated with this object given its this_arg pointer.
6999 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
7001 void (*free)(void *this_arg);
7005 * An enum which can either contain a crate::lightning::ln::wire::Type or not
7007 typedef enum LDKCOption_TypeZ_Tag {
7009 * When we're in this state, this COption_TypeZ contains a crate::lightning::ln::wire::Type
7011 LDKCOption_TypeZ_Some,
7013 * When we're in this state, this COption_TypeZ contains nothing
7015 LDKCOption_TypeZ_None,
7017 * Must be last for serialization purposes
7019 LDKCOption_TypeZ_Sentinel,
7020 } LDKCOption_TypeZ_Tag;
7022 typedef struct LDKCOption_TypeZ {
7023 LDKCOption_TypeZ_Tag tag;
7026 struct LDKType some;
7032 * The contents of CResult_COption_TypeZDecodeErrorZ
7034 typedef union LDKCResult_COption_TypeZDecodeErrorZPtr {
7036 * A pointer to the contents in the success state.
7037 * Reading from this pointer when `result_ok` is not set is undefined.
7039 struct LDKCOption_TypeZ *result;
7041 * A pointer to the contents in the error state.
7042 * Reading from this pointer when `result_ok` is set is undefined.
7044 struct LDKDecodeError *err;
7045 } LDKCResult_COption_TypeZDecodeErrorZPtr;
7048 * A CResult_COption_TypeZDecodeErrorZ represents the result of a fallible operation,
7049 * containing a crate::c_types::derived::COption_TypeZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
7050 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7052 typedef struct LDKCResult_COption_TypeZDecodeErrorZ {
7054 * The contents of this CResult_COption_TypeZDecodeErrorZ, accessible via either
7055 * `err` or `result` depending on the state of `result_ok`.
7057 union LDKCResult_COption_TypeZDecodeErrorZPtr contents;
7059 * Whether this CResult_COption_TypeZDecodeErrorZ represents a success state.
7062 } LDKCResult_COption_TypeZDecodeErrorZ;
7065 * An error that may occur when making a payment.
7067 typedef enum LDKPaymentError_Tag {
7069 * An error resulting from the provided [`Invoice`] or payment hash.
7071 LDKPaymentError_Invoice,
7073 * An error occurring when finding a route.
7075 LDKPaymentError_Routing,
7077 * An error occurring when sending a payment.
7079 LDKPaymentError_Sending,
7081 * Must be last for serialization purposes
7083 LDKPaymentError_Sentinel,
7084 } LDKPaymentError_Tag;
7086 typedef struct MUST_USE_STRUCT LDKPaymentError {
7087 LDKPaymentError_Tag tag;
7090 struct LDKStr invoice;
7093 struct LDKLightningError routing;
7096 struct LDKPaymentSendFailure sending;
7102 * The contents of CResult_PaymentIdPaymentErrorZ
7104 typedef union LDKCResult_PaymentIdPaymentErrorZPtr {
7106 * A pointer to the contents in the success state.
7107 * Reading from this pointer when `result_ok` is not set is undefined.
7109 struct LDKThirtyTwoBytes *result;
7111 * A pointer to the contents in the error state.
7112 * Reading from this pointer when `result_ok` is set is undefined.
7114 struct LDKPaymentError *err;
7115 } LDKCResult_PaymentIdPaymentErrorZPtr;
7118 * A CResult_PaymentIdPaymentErrorZ represents the result of a fallible operation,
7119 * containing a crate::c_types::ThirtyTwoBytes on success and a crate::lightning_invoice::payment::PaymentError on failure.
7120 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7122 typedef struct LDKCResult_PaymentIdPaymentErrorZ {
7124 * The contents of this CResult_PaymentIdPaymentErrorZ, accessible via either
7125 * `err` or `result` depending on the state of `result_ok`.
7127 union LDKCResult_PaymentIdPaymentErrorZPtr contents;
7129 * Whether this CResult_PaymentIdPaymentErrorZ represents a success state.
7132 } LDKCResult_PaymentIdPaymentErrorZ;
7135 * The contents of CResult_SiPrefixNoneZ
7137 typedef union LDKCResult_SiPrefixNoneZPtr {
7139 * A pointer to the contents in the success state.
7140 * Reading from this pointer when `result_ok` is not set is undefined.
7142 enum LDKSiPrefix *result;
7144 * Note that this value is always NULL, as there are no contents in the Err variant
7147 } LDKCResult_SiPrefixNoneZPtr;
7150 * A CResult_SiPrefixNoneZ represents the result of a fallible operation,
7151 * containing a crate::lightning_invoice::SiPrefix on success and a () on failure.
7152 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7154 typedef struct LDKCResult_SiPrefixNoneZ {
7156 * The contents of this CResult_SiPrefixNoneZ, accessible via either
7157 * `err` or `result` depending on the state of `result_ok`.
7159 union LDKCResult_SiPrefixNoneZPtr contents;
7161 * Whether this CResult_SiPrefixNoneZ represents a success state.
7164 } LDKCResult_SiPrefixNoneZ;
7169 * Represents a syntactically and semantically correct lightning BOLT11 invoice.
7171 * There are three ways to construct an `Invoice`:
7172 * 1. using `InvoiceBuilder`
7173 * 2. using `Invoice::from_signed(SignedRawInvoice)`
7174 * 3. using `str::parse::<Invoice>(&str)`
7176 typedef struct MUST_USE_STRUCT LDKInvoice {
7178 * A pointer to the opaque Rust object.
7179 * Nearly everywhere, inner must be non-null, however in places where
7180 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7182 LDKnativeInvoice *inner;
7184 * Indicates that this is the only struct which contains the same pointer.
7185 * Rust functions which take ownership of an object provided via an argument require
7186 * this to be true and invalidate the object pointed to by inner.
7192 * The contents of CResult_InvoiceNoneZ
7194 typedef union LDKCResult_InvoiceNoneZPtr {
7196 * A pointer to the contents in the success state.
7197 * Reading from this pointer when `result_ok` is not set is undefined.
7199 struct LDKInvoice *result;
7201 * Note that this value is always NULL, as there are no contents in the Err variant
7204 } LDKCResult_InvoiceNoneZPtr;
7207 * A CResult_InvoiceNoneZ represents the result of a fallible operation,
7208 * containing a crate::lightning_invoice::Invoice on success and a () on failure.
7209 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7211 typedef struct LDKCResult_InvoiceNoneZ {
7213 * The contents of this CResult_InvoiceNoneZ, accessible via either
7214 * `err` or `result` depending on the state of `result_ok`.
7216 union LDKCResult_InvoiceNoneZPtr contents;
7218 * Whether this CResult_InvoiceNoneZ represents a success state.
7221 } LDKCResult_InvoiceNoneZ;
7226 * Represents a signed `RawInvoice` with cached hash. The signature is not checked and may be
7230 * The hash has to be either from the deserialized invoice or from the serialized `raw_invoice`.
7232 typedef struct MUST_USE_STRUCT LDKSignedRawInvoice {
7234 * A pointer to the opaque Rust object.
7235 * Nearly everywhere, inner must be non-null, however in places where
7236 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7238 LDKnativeSignedRawInvoice *inner;
7240 * Indicates that this is the only struct which contains the same pointer.
7241 * Rust functions which take ownership of an object provided via an argument require
7242 * this to be true and invalidate the object pointed to by inner.
7245 } LDKSignedRawInvoice;
7248 * The contents of CResult_SignedRawInvoiceNoneZ
7250 typedef union LDKCResult_SignedRawInvoiceNoneZPtr {
7252 * A pointer to the contents in the success state.
7253 * Reading from this pointer when `result_ok` is not set is undefined.
7255 struct LDKSignedRawInvoice *result;
7257 * Note that this value is always NULL, as there are no contents in the Err variant
7260 } LDKCResult_SignedRawInvoiceNoneZPtr;
7263 * A CResult_SignedRawInvoiceNoneZ represents the result of a fallible operation,
7264 * containing a crate::lightning_invoice::SignedRawInvoice on success and a () on failure.
7265 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7267 typedef struct LDKCResult_SignedRawInvoiceNoneZ {
7269 * The contents of this CResult_SignedRawInvoiceNoneZ, accessible via either
7270 * `err` or `result` depending on the state of `result_ok`.
7272 union LDKCResult_SignedRawInvoiceNoneZPtr contents;
7274 * Whether this CResult_SignedRawInvoiceNoneZ represents a success state.
7277 } LDKCResult_SignedRawInvoiceNoneZ;
7282 * Represents an syntactically correct Invoice for a payment on the lightning network,
7283 * but without the signature information.
7284 * De- and encoding should not lead to information loss but may lead to different hashes.
7286 * For methods without docs see the corresponding methods in `Invoice`.
7288 typedef struct MUST_USE_STRUCT LDKRawInvoice {
7290 * A pointer to the opaque Rust object.
7291 * Nearly everywhere, inner must be non-null, however in places where
7292 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7294 LDKnativeRawInvoice *inner;
7296 * Indicates that this is the only struct which contains the same pointer.
7297 * Rust functions which take ownership of an object provided via an argument require
7298 * this to be true and invalidate the object pointed to by inner.
7306 * Recoverable signature
7308 typedef struct MUST_USE_STRUCT LDKInvoiceSignature {
7310 * A pointer to the opaque Rust object.
7311 * Nearly everywhere, inner must be non-null, however in places where
7312 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7314 LDKnativeInvoiceSignature *inner;
7316 * Indicates that this is the only struct which contains the same pointer.
7317 * Rust functions which take ownership of an object provided via an argument require
7318 * this to be true and invalidate the object pointed to by inner.
7321 } LDKInvoiceSignature;
7324 * A tuple of 3 elements. See the individual fields for the types contained.
7326 typedef struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ {
7328 * The element at position 0
7330 struct LDKRawInvoice a;
7332 * The element at position 1
7334 struct LDKThirtyTwoBytes b;
7336 * The element at position 2
7338 struct LDKInvoiceSignature c;
7339 } LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ;
7346 typedef struct MUST_USE_STRUCT LDKPayeePubKey {
7348 * A pointer to the opaque Rust object.
7349 * Nearly everywhere, inner must be non-null, however in places where
7350 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7352 LDKnativePayeePubKey *inner;
7354 * Indicates that this is the only struct which contains the same pointer.
7355 * Rust functions which take ownership of an object provided via an argument require
7356 * this to be true and invalidate the object pointed to by inner.
7362 * The contents of CResult_PayeePubKeyErrorZ
7364 typedef union LDKCResult_PayeePubKeyErrorZPtr {
7366 * A pointer to the contents in the success state.
7367 * Reading from this pointer when `result_ok` is not set is undefined.
7369 struct LDKPayeePubKey *result;
7371 * A pointer to the contents in the error state.
7372 * Reading from this pointer when `result_ok` is set is undefined.
7374 enum LDKSecp256k1Error *err;
7375 } LDKCResult_PayeePubKeyErrorZPtr;
7378 * A CResult_PayeePubKeyErrorZ represents the result of a fallible operation,
7379 * containing a crate::lightning_invoice::PayeePubKey on success and a crate::c_types::Secp256k1Error on failure.
7380 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7382 typedef struct LDKCResult_PayeePubKeyErrorZ {
7384 * The contents of this CResult_PayeePubKeyErrorZ, accessible via either
7385 * `err` or `result` depending on the state of `result_ok`.
7387 union LDKCResult_PayeePubKeyErrorZPtr contents;
7389 * Whether this CResult_PayeePubKeyErrorZ represents a success state.
7392 } LDKCResult_PayeePubKeyErrorZ;
7397 * Private routing information
7400 * The encoded route has to be <1024 5bit characters long (<=639 bytes or <=12 hops)
7403 typedef struct MUST_USE_STRUCT LDKPrivateRoute {
7405 * A pointer to the opaque Rust object.
7406 * Nearly everywhere, inner must be non-null, however in places where
7407 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7409 LDKnativePrivateRoute *inner;
7411 * Indicates that this is the only struct which contains the same pointer.
7412 * Rust functions which take ownership of an object provided via an argument require
7413 * this to be true and invalidate the object pointed to by inner.
7419 * A dynamically-allocated array of crate::lightning_invoice::PrivateRoutes of arbitrary size.
7420 * This corresponds to std::vector in C++
7422 typedef struct LDKCVec_PrivateRouteZ {
7424 * The elements in the array.
7425 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7427 struct LDKPrivateRoute *data;
7429 * The number of elements pointed to by `data`.
7432 } LDKCVec_PrivateRouteZ;
7437 * A timestamp that refers to a date after 1 January 1970.
7441 * The Unix timestamp representing the stored time has to be positive and no greater than
7442 * [`MAX_TIMESTAMP`].
7444 typedef struct MUST_USE_STRUCT LDKPositiveTimestamp {
7446 * A pointer to the opaque Rust object.
7447 * Nearly everywhere, inner must be non-null, however in places where
7448 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7450 LDKnativePositiveTimestamp *inner;
7452 * Indicates that this is the only struct which contains the same pointer.
7453 * Rust functions which take ownership of an object provided via an argument require
7454 * this to be true and invalidate the object pointed to by inner.
7457 } LDKPositiveTimestamp;
7460 * The contents of CResult_PositiveTimestampCreationErrorZ
7462 typedef union LDKCResult_PositiveTimestampCreationErrorZPtr {
7464 * A pointer to the contents in the success state.
7465 * Reading from this pointer when `result_ok` is not set is undefined.
7467 struct LDKPositiveTimestamp *result;
7469 * A pointer to the contents in the error state.
7470 * Reading from this pointer when `result_ok` is set is undefined.
7472 enum LDKCreationError *err;
7473 } LDKCResult_PositiveTimestampCreationErrorZPtr;
7476 * A CResult_PositiveTimestampCreationErrorZ represents the result of a fallible operation,
7477 * containing a crate::lightning_invoice::PositiveTimestamp on success and a crate::lightning_invoice::CreationError on failure.
7478 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7480 typedef struct LDKCResult_PositiveTimestampCreationErrorZ {
7482 * The contents of this CResult_PositiveTimestampCreationErrorZ, accessible via either
7483 * `err` or `result` depending on the state of `result_ok`.
7485 union LDKCResult_PositiveTimestampCreationErrorZPtr contents;
7487 * Whether this CResult_PositiveTimestampCreationErrorZ represents a success state.
7490 } LDKCResult_PositiveTimestampCreationErrorZ;
7493 * The contents of CResult_NoneSemanticErrorZ
7495 typedef union LDKCResult_NoneSemanticErrorZPtr {
7497 * Note that this value is always NULL, as there are no contents in the OK variant
7501 * A pointer to the contents in the error state.
7502 * Reading from this pointer when `result_ok` is set is undefined.
7504 enum LDKSemanticError *err;
7505 } LDKCResult_NoneSemanticErrorZPtr;
7508 * A CResult_NoneSemanticErrorZ represents the result of a fallible operation,
7509 * containing a () on success and a crate::lightning_invoice::SemanticError on failure.
7510 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7512 typedef struct LDKCResult_NoneSemanticErrorZ {
7514 * The contents of this CResult_NoneSemanticErrorZ, accessible via either
7515 * `err` or `result` depending on the state of `result_ok`.
7517 union LDKCResult_NoneSemanticErrorZPtr contents;
7519 * Whether this CResult_NoneSemanticErrorZ represents a success state.
7522 } LDKCResult_NoneSemanticErrorZ;
7525 * The contents of CResult_InvoiceSemanticErrorZ
7527 typedef union LDKCResult_InvoiceSemanticErrorZPtr {
7529 * A pointer to the contents in the success state.
7530 * Reading from this pointer when `result_ok` is not set is undefined.
7532 struct LDKInvoice *result;
7534 * A pointer to the contents in the error state.
7535 * Reading from this pointer when `result_ok` is set is undefined.
7537 enum LDKSemanticError *err;
7538 } LDKCResult_InvoiceSemanticErrorZPtr;
7541 * A CResult_InvoiceSemanticErrorZ represents the result of a fallible operation,
7542 * containing a crate::lightning_invoice::Invoice on success and a crate::lightning_invoice::SemanticError on failure.
7543 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7545 typedef struct LDKCResult_InvoiceSemanticErrorZ {
7547 * The contents of this CResult_InvoiceSemanticErrorZ, accessible via either
7548 * `err` or `result` depending on the state of `result_ok`.
7550 union LDKCResult_InvoiceSemanticErrorZPtr contents;
7552 * Whether this CResult_InvoiceSemanticErrorZ represents a success state.
7555 } LDKCResult_InvoiceSemanticErrorZ;
7560 * Description string
7563 * The description can be at most 639 __bytes__ long
7565 typedef struct MUST_USE_STRUCT LDKDescription {
7567 * A pointer to the opaque Rust object.
7568 * Nearly everywhere, inner must be non-null, however in places where
7569 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7571 LDKnativeDescription *inner;
7573 * Indicates that this is the only struct which contains the same pointer.
7574 * Rust functions which take ownership of an object provided via an argument require
7575 * this to be true and invalidate the object pointed to by inner.
7581 * The contents of CResult_DescriptionCreationErrorZ
7583 typedef union LDKCResult_DescriptionCreationErrorZPtr {
7585 * A pointer to the contents in the success state.
7586 * Reading from this pointer when `result_ok` is not set is undefined.
7588 struct LDKDescription *result;
7590 * A pointer to the contents in the error state.
7591 * Reading from this pointer when `result_ok` is set is undefined.
7593 enum LDKCreationError *err;
7594 } LDKCResult_DescriptionCreationErrorZPtr;
7597 * A CResult_DescriptionCreationErrorZ represents the result of a fallible operation,
7598 * containing a crate::lightning_invoice::Description on success and a crate::lightning_invoice::CreationError on failure.
7599 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7601 typedef struct LDKCResult_DescriptionCreationErrorZ {
7603 * The contents of this CResult_DescriptionCreationErrorZ, accessible via either
7604 * `err` or `result` depending on the state of `result_ok`.
7606 union LDKCResult_DescriptionCreationErrorZPtr contents;
7608 * Whether this CResult_DescriptionCreationErrorZ represents a success state.
7611 } LDKCResult_DescriptionCreationErrorZ;
7614 * The contents of CResult_PrivateRouteCreationErrorZ
7616 typedef union LDKCResult_PrivateRouteCreationErrorZPtr {
7618 * A pointer to the contents in the success state.
7619 * Reading from this pointer when `result_ok` is not set is undefined.
7621 struct LDKPrivateRoute *result;
7623 * A pointer to the contents in the error state.
7624 * Reading from this pointer when `result_ok` is set is undefined.
7626 enum LDKCreationError *err;
7627 } LDKCResult_PrivateRouteCreationErrorZPtr;
7630 * A CResult_PrivateRouteCreationErrorZ represents the result of a fallible operation,
7631 * containing a crate::lightning_invoice::PrivateRoute on success and a crate::lightning_invoice::CreationError on failure.
7632 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7634 typedef struct LDKCResult_PrivateRouteCreationErrorZ {
7636 * The contents of this CResult_PrivateRouteCreationErrorZ, accessible via either
7637 * `err` or `result` depending on the state of `result_ok`.
7639 union LDKCResult_PrivateRouteCreationErrorZPtr contents;
7641 * Whether this CResult_PrivateRouteCreationErrorZ represents a success state.
7644 } LDKCResult_PrivateRouteCreationErrorZ;
7647 * The contents of CResult_StringErrorZ
7649 typedef union LDKCResult_StringErrorZPtr {
7651 * A pointer to the contents in the success state.
7652 * Reading from this pointer when `result_ok` is not set is undefined.
7654 struct LDKStr *result;
7656 * A pointer to the contents in the error state.
7657 * Reading from this pointer when `result_ok` is set is undefined.
7659 enum LDKSecp256k1Error *err;
7660 } LDKCResult_StringErrorZPtr;
7663 * A CResult_StringErrorZ represents the result of a fallible operation,
7664 * containing a crate::c_types::Str on success and a crate::c_types::Secp256k1Error on failure.
7665 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7667 typedef struct LDKCResult_StringErrorZ {
7669 * The contents of this CResult_StringErrorZ, accessible via either
7670 * `err` or `result` depending on the state of `result_ok`.
7672 union LDKCResult_StringErrorZPtr contents;
7674 * Whether this CResult_StringErrorZ represents a success state.
7677 } LDKCResult_StringErrorZ;
7680 * The contents of CResult_ChannelMonitorUpdateDecodeErrorZ
7682 typedef union LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr {
7684 * A pointer to the contents in the success state.
7685 * Reading from this pointer when `result_ok` is not set is undefined.
7687 struct LDKChannelMonitorUpdate *result;
7689 * A pointer to the contents in the error state.
7690 * Reading from this pointer when `result_ok` is set is undefined.
7692 struct LDKDecodeError *err;
7693 } LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr;
7696 * A CResult_ChannelMonitorUpdateDecodeErrorZ represents the result of a fallible operation,
7697 * containing a crate::lightning::chain::channelmonitor::ChannelMonitorUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
7698 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7700 typedef struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ {
7702 * The contents of this CResult_ChannelMonitorUpdateDecodeErrorZ, accessible via either
7703 * `err` or `result` depending on the state of `result_ok`.
7705 union LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr contents;
7707 * Whether this CResult_ChannelMonitorUpdateDecodeErrorZ represents a success state.
7710 } LDKCResult_ChannelMonitorUpdateDecodeErrorZ;
7713 * An enum which can either contain a crate::lightning::chain::channelmonitor::MonitorEvent or not
7715 typedef enum LDKCOption_MonitorEventZ_Tag {
7717 * When we're in this state, this COption_MonitorEventZ contains a crate::lightning::chain::channelmonitor::MonitorEvent
7719 LDKCOption_MonitorEventZ_Some,
7721 * When we're in this state, this COption_MonitorEventZ contains nothing
7723 LDKCOption_MonitorEventZ_None,
7725 * Must be last for serialization purposes
7727 LDKCOption_MonitorEventZ_Sentinel,
7728 } LDKCOption_MonitorEventZ_Tag;
7730 typedef struct LDKCOption_MonitorEventZ {
7731 LDKCOption_MonitorEventZ_Tag tag;
7734 struct LDKMonitorEvent some;
7737 } LDKCOption_MonitorEventZ;
7740 * The contents of CResult_COption_MonitorEventZDecodeErrorZ
7742 typedef union LDKCResult_COption_MonitorEventZDecodeErrorZPtr {
7744 * A pointer to the contents in the success state.
7745 * Reading from this pointer when `result_ok` is not set is undefined.
7747 struct LDKCOption_MonitorEventZ *result;
7749 * A pointer to the contents in the error state.
7750 * Reading from this pointer when `result_ok` is set is undefined.
7752 struct LDKDecodeError *err;
7753 } LDKCResult_COption_MonitorEventZDecodeErrorZPtr;
7756 * A CResult_COption_MonitorEventZDecodeErrorZ represents the result of a fallible operation,
7757 * containing a crate::c_types::derived::COption_MonitorEventZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
7758 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7760 typedef struct LDKCResult_COption_MonitorEventZDecodeErrorZ {
7762 * The contents of this CResult_COption_MonitorEventZDecodeErrorZ, accessible via either
7763 * `err` or `result` depending on the state of `result_ok`.
7765 union LDKCResult_COption_MonitorEventZDecodeErrorZPtr contents;
7767 * Whether this CResult_COption_MonitorEventZDecodeErrorZ represents a success state.
7770 } LDKCResult_COption_MonitorEventZDecodeErrorZ;
7773 * The contents of CResult_HTLCUpdateDecodeErrorZ
7775 typedef union LDKCResult_HTLCUpdateDecodeErrorZPtr {
7777 * A pointer to the contents in the success state.
7778 * Reading from this pointer when `result_ok` is not set is undefined.
7780 struct LDKHTLCUpdate *result;
7782 * A pointer to the contents in the error state.
7783 * Reading from this pointer when `result_ok` is set is undefined.
7785 struct LDKDecodeError *err;
7786 } LDKCResult_HTLCUpdateDecodeErrorZPtr;
7789 * A CResult_HTLCUpdateDecodeErrorZ represents the result of a fallible operation,
7790 * containing a crate::lightning::chain::channelmonitor::HTLCUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
7791 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7793 typedef struct LDKCResult_HTLCUpdateDecodeErrorZ {
7795 * The contents of this CResult_HTLCUpdateDecodeErrorZ, accessible via either
7796 * `err` or `result` depending on the state of `result_ok`.
7798 union LDKCResult_HTLCUpdateDecodeErrorZPtr contents;
7800 * Whether this CResult_HTLCUpdateDecodeErrorZ represents a success state.
7803 } LDKCResult_HTLCUpdateDecodeErrorZ;
7806 * A tuple of 2 elements. See the individual fields for the types contained.
7808 typedef struct LDKC2Tuple_OutPointScriptZ {
7810 * The element at position 0
7812 struct LDKOutPoint a;
7814 * The element at position 1
7816 struct LDKCVec_u8Z b;
7817 } LDKC2Tuple_OutPointScriptZ;
7820 * A tuple of 2 elements. See the individual fields for the types contained.
7822 typedef struct LDKC2Tuple_u32ScriptZ {
7824 * The element at position 0
7828 * The element at position 1
7830 struct LDKCVec_u8Z b;
7831 } LDKC2Tuple_u32ScriptZ;
7834 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_u32ScriptZs of arbitrary size.
7835 * This corresponds to std::vector in C++
7837 typedef struct LDKCVec_C2Tuple_u32ScriptZZ {
7839 * The elements in the array.
7840 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7842 struct LDKC2Tuple_u32ScriptZ *data;
7844 * The number of elements pointed to by `data`.
7847 } LDKCVec_C2Tuple_u32ScriptZZ;
7850 * A tuple of 2 elements. See the individual fields for the types contained.
7852 typedef struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ {
7854 * The element at position 0
7856 struct LDKThirtyTwoBytes a;
7858 * The element at position 1
7860 struct LDKCVec_C2Tuple_u32ScriptZZ b;
7861 } LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ;
7864 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZs of arbitrary size.
7865 * This corresponds to std::vector in C++
7867 typedef struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ {
7869 * The elements in the array.
7870 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7872 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ *data;
7874 * The number of elements pointed to by `data`.
7877 } LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ;
7880 * A dynamically-allocated array of crate::lightning::util::events::Events of arbitrary size.
7881 * This corresponds to std::vector in C++
7883 typedef struct LDKCVec_EventZ {
7885 * The elements in the array.
7886 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7888 struct LDKEvent *data;
7890 * The number of elements pointed to by `data`.
7896 * A dynamically-allocated array of crate::c_types::Transactions of arbitrary size.
7897 * This corresponds to std::vector in C++
7899 typedef struct LDKCVec_TransactionZ {
7901 * The elements in the array.
7902 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7904 struct LDKTransaction *data;
7906 * The number of elements pointed to by `data`.
7909 } LDKCVec_TransactionZ;
7912 * A tuple of 2 elements. See the individual fields for the types contained.
7914 typedef struct LDKC2Tuple_u32TxOutZ {
7916 * The element at position 0
7920 * The element at position 1
7923 } LDKC2Tuple_u32TxOutZ;
7926 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_u32TxOutZs of arbitrary size.
7927 * This corresponds to std::vector in C++
7929 typedef struct LDKCVec_C2Tuple_u32TxOutZZ {
7931 * The elements in the array.
7932 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7934 struct LDKC2Tuple_u32TxOutZ *data;
7936 * The number of elements pointed to by `data`.
7939 } LDKCVec_C2Tuple_u32TxOutZZ;
7942 * A tuple of 2 elements. See the individual fields for the types contained.
7944 typedef struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ {
7946 * The element at position 0
7948 struct LDKThirtyTwoBytes a;
7950 * The element at position 1
7952 struct LDKCVec_C2Tuple_u32TxOutZZ b;
7953 } LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ;
7956 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZs of arbitrary size.
7957 * This corresponds to std::vector in C++
7959 typedef struct LDKCVec_TransactionOutputsZ {
7961 * The elements in the array.
7962 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7964 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ *data;
7966 * The number of elements pointed to by `data`.
7969 } LDKCVec_TransactionOutputsZ;
7972 * Details about the balance(s) available for spending once the channel appears on chain.
7974 * See [`ChannelMonitor::get_claimable_balances`] for more details on when these will or will not
7977 typedef enum LDKBalance_Tag {
7979 * The channel is not yet closed (or the commitment or closing transaction has not yet
7980 * appeared in a block). The given balance is claimable (less on-chain fees) if the channel is
7983 LDKBalance_ClaimableOnChannelClose,
7985 * The channel has been closed, and the given balance is ours but awaiting confirmations until
7986 * we consider it spendable.
7988 LDKBalance_ClaimableAwaitingConfirmations,
7990 * The channel has been closed, and the given balance should be ours but awaiting spending
7991 * transaction confirmation. If the spending transaction does not confirm in time, it is
7992 * possible our counterparty can take the funds by broadcasting an HTLC timeout on-chain.
7994 * Once the spending transaction confirms, before it has reached enough confirmations to be
7995 * considered safe from chain reorganizations, the balance will instead be provided via
7996 * [`Balance::ClaimableAwaitingConfirmations`].
7998 LDKBalance_ContentiousClaimable,
8000 * HTLCs which we sent to our counterparty which are claimable after a timeout (less on-chain
8001 * fees) if the counterparty does not know the preimage for the HTLCs. These are somewhat
8002 * likely to be claimed by our counterparty before we do.
8004 LDKBalance_MaybeClaimableHTLCAwaitingTimeout,
8006 * Must be last for serialization purposes
8008 LDKBalance_Sentinel,
8011 typedef struct LDKBalance_LDKClaimableOnChannelClose_Body {
8013 * The amount available to claim, in satoshis, excluding the on-chain fees which will be
8014 * required to do so.
8016 uint64_t claimable_amount_satoshis;
8017 } LDKBalance_LDKClaimableOnChannelClose_Body;
8019 typedef struct LDKBalance_LDKClaimableAwaitingConfirmations_Body {
8021 * The amount available to claim, in satoshis, possibly excluding the on-chain fees which
8022 * were spent in broadcasting the transaction.
8024 uint64_t claimable_amount_satoshis;
8026 * The height at which an [`Event::SpendableOutputs`] event will be generated for this
8029 uint32_t confirmation_height;
8030 } LDKBalance_LDKClaimableAwaitingConfirmations_Body;
8032 typedef struct LDKBalance_LDKContentiousClaimable_Body {
8034 * The amount available to claim, in satoshis, excluding the on-chain fees which will be
8035 * required to do so.
8037 uint64_t claimable_amount_satoshis;
8039 * The height at which the counterparty may be able to claim the balance if we have not
8042 uint32_t timeout_height;
8043 } LDKBalance_LDKContentiousClaimable_Body;
8045 typedef struct LDKBalance_LDKMaybeClaimableHTLCAwaitingTimeout_Body {
8047 * The amount available to claim, in satoshis, excluding the on-chain fees which will be
8048 * required to do so.
8050 uint64_t claimable_amount_satoshis;
8052 * The height at which we will be able to claim the balance if our counterparty has not
8055 uint32_t claimable_height;
8056 } LDKBalance_LDKMaybeClaimableHTLCAwaitingTimeout_Body;
8058 typedef struct MUST_USE_STRUCT LDKBalance {
8061 LDKBalance_LDKClaimableOnChannelClose_Body claimable_on_channel_close;
8062 LDKBalance_LDKClaimableAwaitingConfirmations_Body claimable_awaiting_confirmations;
8063 LDKBalance_LDKContentiousClaimable_Body contentious_claimable;
8064 LDKBalance_LDKMaybeClaimableHTLCAwaitingTimeout_Body maybe_claimable_htlc_awaiting_timeout;
8069 * A dynamically-allocated array of crate::lightning::chain::channelmonitor::Balances of arbitrary size.
8070 * This corresponds to std::vector in C++
8072 typedef struct LDKCVec_BalanceZ {
8074 * The elements in the array.
8075 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
8077 struct LDKBalance *data;
8079 * The number of elements pointed to by `data`.
8085 * The contents of CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ
8087 typedef union LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr {
8089 * A pointer to the contents in the success state.
8090 * Reading from this pointer when `result_ok` is not set is undefined.
8092 struct LDKC2Tuple_BlockHashChannelMonitorZ *result;
8094 * A pointer to the contents in the error state.
8095 * Reading from this pointer when `result_ok` is set is undefined.
8097 struct LDKDecodeError *err;
8098 } LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr;
8101 * A CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ represents the result of a fallible operation,
8102 * containing a crate::c_types::derived::C2Tuple_BlockHashChannelMonitorZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
8103 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8105 typedef struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ {
8107 * The contents of this CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ, accessible via either
8108 * `err` or `result` depending on the state of `result_ok`.
8110 union LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr contents;
8112 * Whether this CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ represents a success state.
8115 } LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ;
8118 * The contents of CResult_NoneLightningErrorZ
8120 typedef union LDKCResult_NoneLightningErrorZPtr {
8122 * Note that this value is always NULL, as there are no contents in the OK variant
8126 * A pointer to the contents in the error state.
8127 * Reading from this pointer when `result_ok` is set is undefined.
8129 struct LDKLightningError *err;
8130 } LDKCResult_NoneLightningErrorZPtr;
8133 * A CResult_NoneLightningErrorZ represents the result of a fallible operation,
8134 * containing a () on success and a crate::lightning::ln::msgs::LightningError on failure.
8135 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8137 typedef struct LDKCResult_NoneLightningErrorZ {
8139 * The contents of this CResult_NoneLightningErrorZ, accessible via either
8140 * `err` or `result` depending on the state of `result_ok`.
8142 union LDKCResult_NoneLightningErrorZPtr contents;
8144 * Whether this CResult_NoneLightningErrorZ represents a success state.
8147 } LDKCResult_NoneLightningErrorZ;
8150 * A tuple of 2 elements. See the individual fields for the types contained.
8152 typedef struct LDKC2Tuple_PublicKeyTypeZ {
8154 * The element at position 0
8156 struct LDKPublicKey a;
8158 * The element at position 1
8161 } LDKC2Tuple_PublicKeyTypeZ;
8164 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_PublicKeyTypeZs of arbitrary size.
8165 * This corresponds to std::vector in C++
8167 typedef struct LDKCVec_C2Tuple_PublicKeyTypeZZ {
8169 * The elements in the array.
8170 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
8172 struct LDKC2Tuple_PublicKeyTypeZ *data;
8174 * The number of elements pointed to by `data`.
8177 } LDKCVec_C2Tuple_PublicKeyTypeZZ;
8180 * The contents of CResult_boolLightningErrorZ
8182 typedef union LDKCResult_boolLightningErrorZPtr {
8184 * A pointer to the contents in the success state.
8185 * Reading from this pointer when `result_ok` is not set is undefined.
8189 * A pointer to the contents in the error state.
8190 * Reading from this pointer when `result_ok` is set is undefined.
8192 struct LDKLightningError *err;
8193 } LDKCResult_boolLightningErrorZPtr;
8196 * A CResult_boolLightningErrorZ represents the result of a fallible operation,
8197 * containing a bool on success and a crate::lightning::ln::msgs::LightningError on failure.
8198 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8200 typedef struct LDKCResult_boolLightningErrorZ {
8202 * The contents of this CResult_boolLightningErrorZ, accessible via either
8203 * `err` or `result` depending on the state of `result_ok`.
8205 union LDKCResult_boolLightningErrorZPtr contents;
8207 * Whether this CResult_boolLightningErrorZ represents a success state.
8210 } LDKCResult_boolLightningErrorZ;
8213 * A tuple of 3 elements. See the individual fields for the types contained.
8215 typedef struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ {
8217 * The element at position 0
8219 struct LDKChannelAnnouncement a;
8221 * The element at position 1
8223 struct LDKChannelUpdate b;
8225 * The element at position 2
8227 struct LDKChannelUpdate c;
8228 } LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ;
8231 * A dynamically-allocated array of crate::c_types::derived::C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZs of arbitrary size.
8232 * This corresponds to std::vector in C++
8234 typedef struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ {
8236 * The elements in the array.
8237 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
8239 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ *data;
8241 * The number of elements pointed to by `data`.
8244 } LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ;
8247 * A dynamically-allocated array of crate::lightning::ln::msgs::NodeAnnouncements of arbitrary size.
8248 * This corresponds to std::vector in C++
8250 typedef struct LDKCVec_NodeAnnouncementZ {
8252 * The elements in the array.
8253 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
8255 struct LDKNodeAnnouncement *data;
8257 * The number of elements pointed to by `data`.
8260 } LDKCVec_NodeAnnouncementZ;
8263 * A dynamically-allocated array of crate::c_types::PublicKeys of arbitrary size.
8264 * This corresponds to std::vector in C++
8266 typedef struct LDKCVec_PublicKeyZ {
8268 * The elements in the array.
8269 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
8271 struct LDKPublicKey *data;
8273 * The number of elements pointed to by `data`.
8276 } LDKCVec_PublicKeyZ;
8279 * An enum which can either contain a crate::lightning::ln::msgs::NetAddress or not
8281 typedef enum LDKCOption_NetAddressZ_Tag {
8283 * When we're in this state, this COption_NetAddressZ contains a crate::lightning::ln::msgs::NetAddress
8285 LDKCOption_NetAddressZ_Some,
8287 * When we're in this state, this COption_NetAddressZ contains nothing
8289 LDKCOption_NetAddressZ_None,
8291 * Must be last for serialization purposes
8293 LDKCOption_NetAddressZ_Sentinel,
8294 } LDKCOption_NetAddressZ_Tag;
8296 typedef struct LDKCOption_NetAddressZ {
8297 LDKCOption_NetAddressZ_Tag tag;
8300 struct LDKNetAddress some;
8303 } LDKCOption_NetAddressZ;
8308 * Error for PeerManager errors. If you get one of these, you must disconnect the socket and
8309 * generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
8312 typedef struct MUST_USE_STRUCT LDKPeerHandleError {
8314 * A pointer to the opaque Rust object.
8315 * Nearly everywhere, inner must be non-null, however in places where
8316 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8318 LDKnativePeerHandleError *inner;
8320 * Indicates that this is the only struct which contains the same pointer.
8321 * Rust functions which take ownership of an object provided via an argument require
8322 * this to be true and invalidate the object pointed to by inner.
8325 } LDKPeerHandleError;
8328 * The contents of CResult_CVec_u8ZPeerHandleErrorZ
8330 typedef union LDKCResult_CVec_u8ZPeerHandleErrorZPtr {
8332 * A pointer to the contents in the success state.
8333 * Reading from this pointer when `result_ok` is not set is undefined.
8335 struct LDKCVec_u8Z *result;
8337 * A pointer to the contents in the error state.
8338 * Reading from this pointer when `result_ok` is set is undefined.
8340 struct LDKPeerHandleError *err;
8341 } LDKCResult_CVec_u8ZPeerHandleErrorZPtr;
8344 * A CResult_CVec_u8ZPeerHandleErrorZ represents the result of a fallible operation,
8345 * containing a crate::c_types::derived::CVec_u8Z on success and a crate::lightning::ln::peer_handler::PeerHandleError on failure.
8346 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8348 typedef struct LDKCResult_CVec_u8ZPeerHandleErrorZ {
8350 * The contents of this CResult_CVec_u8ZPeerHandleErrorZ, accessible via either
8351 * `err` or `result` depending on the state of `result_ok`.
8353 union LDKCResult_CVec_u8ZPeerHandleErrorZPtr contents;
8355 * Whether this CResult_CVec_u8ZPeerHandleErrorZ represents a success state.
8358 } LDKCResult_CVec_u8ZPeerHandleErrorZ;
8361 * The contents of CResult_NonePeerHandleErrorZ
8363 typedef union LDKCResult_NonePeerHandleErrorZPtr {
8365 * Note that this value is always NULL, as there are no contents in the OK variant
8369 * A pointer to the contents in the error state.
8370 * Reading from this pointer when `result_ok` is set is undefined.
8372 struct LDKPeerHandleError *err;
8373 } LDKCResult_NonePeerHandleErrorZPtr;
8376 * A CResult_NonePeerHandleErrorZ represents the result of a fallible operation,
8377 * containing a () on success and a crate::lightning::ln::peer_handler::PeerHandleError on failure.
8378 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8380 typedef struct LDKCResult_NonePeerHandleErrorZ {
8382 * The contents of this CResult_NonePeerHandleErrorZ, accessible via either
8383 * `err` or `result` depending on the state of `result_ok`.
8385 union LDKCResult_NonePeerHandleErrorZPtr contents;
8387 * Whether this CResult_NonePeerHandleErrorZ represents a success state.
8390 } LDKCResult_NonePeerHandleErrorZ;
8393 * The contents of CResult_boolPeerHandleErrorZ
8395 typedef union LDKCResult_boolPeerHandleErrorZPtr {
8397 * A pointer to the contents in the success state.
8398 * Reading from this pointer when `result_ok` is not set is undefined.
8402 * A pointer to the contents in the error state.
8403 * Reading from this pointer when `result_ok` is set is undefined.
8405 struct LDKPeerHandleError *err;
8406 } LDKCResult_boolPeerHandleErrorZPtr;
8409 * A CResult_boolPeerHandleErrorZ represents the result of a fallible operation,
8410 * containing a bool on success and a crate::lightning::ln::peer_handler::PeerHandleError on failure.
8411 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8413 typedef struct LDKCResult_boolPeerHandleErrorZ {
8415 * The contents of this CResult_boolPeerHandleErrorZ, accessible via either
8416 * `err` or `result` depending on the state of `result_ok`.
8418 union LDKCResult_boolPeerHandleErrorZPtr contents;
8420 * Whether this CResult_boolPeerHandleErrorZ represents a success state.
8423 } LDKCResult_boolPeerHandleErrorZ;
8428 * Represents the compressed public key of a node
8430 typedef struct MUST_USE_STRUCT LDKNodeId {
8432 * A pointer to the opaque Rust object.
8433 * Nearly everywhere, inner must be non-null, however in places where
8434 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8436 LDKnativeNodeId *inner;
8438 * Indicates that this is the only struct which contains the same pointer.
8439 * Rust functions which take ownership of an object provided via an argument require
8440 * this to be true and invalidate the object pointed to by inner.
8446 * The contents of CResult_NodeIdDecodeErrorZ
8448 typedef union LDKCResult_NodeIdDecodeErrorZPtr {
8450 * A pointer to the contents in the success state.
8451 * Reading from this pointer when `result_ok` is not set is undefined.
8453 struct LDKNodeId *result;
8455 * A pointer to the contents in the error state.
8456 * Reading from this pointer when `result_ok` is set is undefined.
8458 struct LDKDecodeError *err;
8459 } LDKCResult_NodeIdDecodeErrorZPtr;
8462 * A CResult_NodeIdDecodeErrorZ represents the result of a fallible operation,
8463 * containing a crate::lightning::routing::network_graph::NodeId on success and a crate::lightning::ln::msgs::DecodeError on failure.
8464 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8466 typedef struct LDKCResult_NodeIdDecodeErrorZ {
8468 * The contents of this CResult_NodeIdDecodeErrorZ, accessible via either
8469 * `err` or `result` depending on the state of `result_ok`.
8471 union LDKCResult_NodeIdDecodeErrorZPtr contents;
8473 * Whether this CResult_NodeIdDecodeErrorZ represents a success state.
8476 } LDKCResult_NodeIdDecodeErrorZ;
8479 * The contents of CResult_COption_NetworkUpdateZDecodeErrorZ
8481 typedef union LDKCResult_COption_NetworkUpdateZDecodeErrorZPtr {
8483 * A pointer to the contents in the success state.
8484 * Reading from this pointer when `result_ok` is not set is undefined.
8486 struct LDKCOption_NetworkUpdateZ *result;
8488 * A pointer to the contents in the error state.
8489 * Reading from this pointer when `result_ok` is set is undefined.
8491 struct LDKDecodeError *err;
8492 } LDKCResult_COption_NetworkUpdateZDecodeErrorZPtr;
8495 * A CResult_COption_NetworkUpdateZDecodeErrorZ represents the result of a fallible operation,
8496 * containing a crate::c_types::derived::COption_NetworkUpdateZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
8497 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8499 typedef struct LDKCResult_COption_NetworkUpdateZDecodeErrorZ {
8501 * The contents of this CResult_COption_NetworkUpdateZDecodeErrorZ, accessible via either
8502 * `err` or `result` depending on the state of `result_ok`.
8504 union LDKCResult_COption_NetworkUpdateZDecodeErrorZPtr contents;
8506 * Whether this CResult_COption_NetworkUpdateZDecodeErrorZ represents a success state.
8509 } LDKCResult_COption_NetworkUpdateZDecodeErrorZ;
8512 * The `Access` trait defines behavior for accessing chain data and state, such as blocks and
8515 typedef struct LDKAccess {
8517 * An opaque pointer which is passed to your function implementations as an argument.
8518 * This has no meaning in the LDK, and can be NULL or any other value.
8522 * Returns the transaction output of a funding transaction encoded by [`short_channel_id`].
8523 * Returns an error if `genesis_hash` is for a different chain or if such a transaction output
8526 * [`short_channel_id`]: https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md#definition-of-short_channel_id
8528 struct LDKCResult_TxOutAccessErrorZ (*get_utxo)(const void *this_arg, const uint8_t (*genesis_hash)[32], uint64_t short_channel_id);
8530 * Frees any resources associated with this object given its this_arg pointer.
8531 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
8533 void (*free)(void *this_arg);
8537 * An enum which can either contain a crate::lightning::chain::Access or not
8539 typedef enum LDKCOption_AccessZ_Tag {
8541 * When we're in this state, this COption_AccessZ contains a crate::lightning::chain::Access
8543 LDKCOption_AccessZ_Some,
8545 * When we're in this state, this COption_AccessZ contains nothing
8547 LDKCOption_AccessZ_None,
8549 * Must be last for serialization purposes
8551 LDKCOption_AccessZ_Sentinel,
8552 } LDKCOption_AccessZ_Tag;
8554 typedef struct LDKCOption_AccessZ {
8555 LDKCOption_AccessZ_Tag tag;
8558 struct LDKAccess some;
8561 } LDKCOption_AccessZ;
8566 * Details about one direction of a channel as received within a [`ChannelUpdate`].
8568 typedef struct MUST_USE_STRUCT LDKChannelUpdateInfo {
8570 * A pointer to the opaque Rust object.
8571 * Nearly everywhere, inner must be non-null, however in places where
8572 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8574 LDKnativeChannelUpdateInfo *inner;
8576 * Indicates that this is the only struct which contains the same pointer.
8577 * Rust functions which take ownership of an object provided via an argument require
8578 * this to be true and invalidate the object pointed to by inner.
8581 } LDKChannelUpdateInfo;
8584 * The contents of CResult_ChannelUpdateInfoDecodeErrorZ
8586 typedef union LDKCResult_ChannelUpdateInfoDecodeErrorZPtr {
8588 * A pointer to the contents in the success state.
8589 * Reading from this pointer when `result_ok` is not set is undefined.
8591 struct LDKChannelUpdateInfo *result;
8593 * A pointer to the contents in the error state.
8594 * Reading from this pointer when `result_ok` is set is undefined.
8596 struct LDKDecodeError *err;
8597 } LDKCResult_ChannelUpdateInfoDecodeErrorZPtr;
8600 * A CResult_ChannelUpdateInfoDecodeErrorZ represents the result of a fallible operation,
8601 * containing a crate::lightning::routing::network_graph::ChannelUpdateInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
8602 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8604 typedef struct LDKCResult_ChannelUpdateInfoDecodeErrorZ {
8606 * The contents of this CResult_ChannelUpdateInfoDecodeErrorZ, accessible via either
8607 * `err` or `result` depending on the state of `result_ok`.
8609 union LDKCResult_ChannelUpdateInfoDecodeErrorZPtr contents;
8611 * Whether this CResult_ChannelUpdateInfoDecodeErrorZ represents a success state.
8614 } LDKCResult_ChannelUpdateInfoDecodeErrorZ;
8619 * Details about a channel (both directions).
8620 * Received within a channel announcement.
8622 typedef struct MUST_USE_STRUCT LDKChannelInfo {
8624 * A pointer to the opaque Rust object.
8625 * Nearly everywhere, inner must be non-null, however in places where
8626 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8628 LDKnativeChannelInfo *inner;
8630 * Indicates that this is the only struct which contains the same pointer.
8631 * Rust functions which take ownership of an object provided via an argument require
8632 * this to be true and invalidate the object pointed to by inner.
8638 * The contents of CResult_ChannelInfoDecodeErrorZ
8640 typedef union LDKCResult_ChannelInfoDecodeErrorZPtr {
8642 * A pointer to the contents in the success state.
8643 * Reading from this pointer when `result_ok` is not set is undefined.
8645 struct LDKChannelInfo *result;
8647 * A pointer to the contents in the error state.
8648 * Reading from this pointer when `result_ok` is set is undefined.
8650 struct LDKDecodeError *err;
8651 } LDKCResult_ChannelInfoDecodeErrorZPtr;
8654 * A CResult_ChannelInfoDecodeErrorZ represents the result of a fallible operation,
8655 * containing a crate::lightning::routing::network_graph::ChannelInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
8656 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8658 typedef struct LDKCResult_ChannelInfoDecodeErrorZ {
8660 * The contents of this CResult_ChannelInfoDecodeErrorZ, accessible via either
8661 * `err` or `result` depending on the state of `result_ok`.
8663 union LDKCResult_ChannelInfoDecodeErrorZPtr contents;
8665 * Whether this CResult_ChannelInfoDecodeErrorZ represents a success state.
8668 } LDKCResult_ChannelInfoDecodeErrorZ;
8673 * Fees for routing via a given channel or a node
8675 typedef struct MUST_USE_STRUCT LDKRoutingFees {
8677 * A pointer to the opaque Rust object.
8678 * Nearly everywhere, inner must be non-null, however in places where
8679 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8681 LDKnativeRoutingFees *inner;
8683 * Indicates that this is the only struct which contains the same pointer.
8684 * Rust functions which take ownership of an object provided via an argument require
8685 * this to be true and invalidate the object pointed to by inner.
8691 * The contents of CResult_RoutingFeesDecodeErrorZ
8693 typedef union LDKCResult_RoutingFeesDecodeErrorZPtr {
8695 * A pointer to the contents in the success state.
8696 * Reading from this pointer when `result_ok` is not set is undefined.
8698 struct LDKRoutingFees *result;
8700 * A pointer to the contents in the error state.
8701 * Reading from this pointer when `result_ok` is set is undefined.
8703 struct LDKDecodeError *err;
8704 } LDKCResult_RoutingFeesDecodeErrorZPtr;
8707 * A CResult_RoutingFeesDecodeErrorZ represents the result of a fallible operation,
8708 * containing a crate::lightning::routing::network_graph::RoutingFees on success and a crate::lightning::ln::msgs::DecodeError on failure.
8709 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8711 typedef struct LDKCResult_RoutingFeesDecodeErrorZ {
8713 * The contents of this CResult_RoutingFeesDecodeErrorZ, accessible via either
8714 * `err` or `result` depending on the state of `result_ok`.
8716 union LDKCResult_RoutingFeesDecodeErrorZPtr contents;
8718 * Whether this CResult_RoutingFeesDecodeErrorZ represents a success state.
8721 } LDKCResult_RoutingFeesDecodeErrorZ;
8726 * Information received in the latest node_announcement from this node.
8728 typedef struct MUST_USE_STRUCT LDKNodeAnnouncementInfo {
8730 * A pointer to the opaque Rust object.
8731 * Nearly everywhere, inner must be non-null, however in places where
8732 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8734 LDKnativeNodeAnnouncementInfo *inner;
8736 * Indicates that this is the only struct which contains the same pointer.
8737 * Rust functions which take ownership of an object provided via an argument require
8738 * this to be true and invalidate the object pointed to by inner.
8741 } LDKNodeAnnouncementInfo;
8744 * The contents of CResult_NodeAnnouncementInfoDecodeErrorZ
8746 typedef union LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr {
8748 * A pointer to the contents in the success state.
8749 * Reading from this pointer when `result_ok` is not set is undefined.
8751 struct LDKNodeAnnouncementInfo *result;
8753 * A pointer to the contents in the error state.
8754 * Reading from this pointer when `result_ok` is set is undefined.
8756 struct LDKDecodeError *err;
8757 } LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr;
8760 * A CResult_NodeAnnouncementInfoDecodeErrorZ represents the result of a fallible operation,
8761 * containing a crate::lightning::routing::network_graph::NodeAnnouncementInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
8762 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8764 typedef struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ {
8766 * The contents of this CResult_NodeAnnouncementInfoDecodeErrorZ, accessible via either
8767 * `err` or `result` depending on the state of `result_ok`.
8769 union LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr contents;
8771 * Whether this CResult_NodeAnnouncementInfoDecodeErrorZ represents a success state.
8774 } LDKCResult_NodeAnnouncementInfoDecodeErrorZ;
8777 * A dynamically-allocated array of u64s of arbitrary size.
8778 * This corresponds to std::vector in C++
8780 typedef struct LDKCVec_u64Z {
8782 * The elements in the array.
8783 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
8787 * The number of elements pointed to by `data`.
8795 * Details about a node in the network, known from the network announcement.
8797 typedef struct MUST_USE_STRUCT LDKNodeInfo {
8799 * A pointer to the opaque Rust object.
8800 * Nearly everywhere, inner must be non-null, however in places where
8801 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8803 LDKnativeNodeInfo *inner;
8805 * Indicates that this is the only struct which contains the same pointer.
8806 * Rust functions which take ownership of an object provided via an argument require
8807 * this to be true and invalidate the object pointed to by inner.
8813 * The contents of CResult_NodeInfoDecodeErrorZ
8815 typedef union LDKCResult_NodeInfoDecodeErrorZPtr {
8817 * A pointer to the contents in the success state.
8818 * Reading from this pointer when `result_ok` is not set is undefined.
8820 struct LDKNodeInfo *result;
8822 * A pointer to the contents in the error state.
8823 * Reading from this pointer when `result_ok` is set is undefined.
8825 struct LDKDecodeError *err;
8826 } LDKCResult_NodeInfoDecodeErrorZPtr;
8829 * A CResult_NodeInfoDecodeErrorZ represents the result of a fallible operation,
8830 * containing a crate::lightning::routing::network_graph::NodeInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
8831 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8833 typedef struct LDKCResult_NodeInfoDecodeErrorZ {
8835 * The contents of this CResult_NodeInfoDecodeErrorZ, accessible via either
8836 * `err` or `result` depending on the state of `result_ok`.
8838 union LDKCResult_NodeInfoDecodeErrorZPtr contents;
8840 * Whether this CResult_NodeInfoDecodeErrorZ represents a success state.
8843 } LDKCResult_NodeInfoDecodeErrorZ;
8846 * The contents of CResult_NetworkGraphDecodeErrorZ
8848 typedef union LDKCResult_NetworkGraphDecodeErrorZPtr {
8850 * A pointer to the contents in the success state.
8851 * Reading from this pointer when `result_ok` is not set is undefined.
8853 struct LDKNetworkGraph *result;
8855 * A pointer to the contents in the error state.
8856 * Reading from this pointer when `result_ok` is set is undefined.
8858 struct LDKDecodeError *err;
8859 } LDKCResult_NetworkGraphDecodeErrorZPtr;
8862 * A CResult_NetworkGraphDecodeErrorZ represents the result of a fallible operation,
8863 * containing a crate::lightning::routing::network_graph::NetworkGraph on success and a crate::lightning::ln::msgs::DecodeError on failure.
8864 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8866 typedef struct LDKCResult_NetworkGraphDecodeErrorZ {
8868 * The contents of this CResult_NetworkGraphDecodeErrorZ, accessible via either
8869 * `err` or `result` depending on the state of `result_ok`.
8871 union LDKCResult_NetworkGraphDecodeErrorZPtr contents;
8873 * Whether this CResult_NetworkGraphDecodeErrorZ represents a success state.
8876 } LDKCResult_NetworkGraphDecodeErrorZ;
8879 * An enum which can either contain a crate::c_types::derived::CVec_NetAddressZ or not
8881 typedef enum LDKCOption_CVec_NetAddressZZ_Tag {
8883 * When we're in this state, this COption_CVec_NetAddressZZ contains a crate::c_types::derived::CVec_NetAddressZ
8885 LDKCOption_CVec_NetAddressZZ_Some,
8887 * When we're in this state, this COption_CVec_NetAddressZZ contains nothing
8889 LDKCOption_CVec_NetAddressZZ_None,
8891 * Must be last for serialization purposes
8893 LDKCOption_CVec_NetAddressZZ_Sentinel,
8894 } LDKCOption_CVec_NetAddressZZ_Tag;
8896 typedef struct LDKCOption_CVec_NetAddressZZ {
8897 LDKCOption_CVec_NetAddressZZ_Tag tag;
8900 struct LDKCVec_NetAddressZ some;
8903 } LDKCOption_CVec_NetAddressZZ;
8906 * The contents of CResult_NetAddressDecodeErrorZ
8908 typedef union LDKCResult_NetAddressDecodeErrorZPtr {
8910 * A pointer to the contents in the success state.
8911 * Reading from this pointer when `result_ok` is not set is undefined.
8913 struct LDKNetAddress *result;
8915 * A pointer to the contents in the error state.
8916 * Reading from this pointer when `result_ok` is set is undefined.
8918 struct LDKDecodeError *err;
8919 } LDKCResult_NetAddressDecodeErrorZPtr;
8922 * A CResult_NetAddressDecodeErrorZ represents the result of a fallible operation,
8923 * containing a crate::lightning::ln::msgs::NetAddress on success and a crate::lightning::ln::msgs::DecodeError on failure.
8924 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8926 typedef struct LDKCResult_NetAddressDecodeErrorZ {
8928 * The contents of this CResult_NetAddressDecodeErrorZ, accessible via either
8929 * `err` or `result` depending on the state of `result_ok`.
8931 union LDKCResult_NetAddressDecodeErrorZPtr contents;
8933 * Whether this CResult_NetAddressDecodeErrorZ represents a success state.
8936 } LDKCResult_NetAddressDecodeErrorZ;
8941 * An update_add_htlc message to be sent or received from a peer
8943 typedef struct MUST_USE_STRUCT LDKUpdateAddHTLC {
8945 * A pointer to the opaque Rust object.
8946 * Nearly everywhere, inner must be non-null, however in places where
8947 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8949 LDKnativeUpdateAddHTLC *inner;
8951 * Indicates that this is the only struct which contains the same pointer.
8952 * Rust functions which take ownership of an object provided via an argument require
8953 * this to be true and invalidate the object pointed to by inner.
8959 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateAddHTLCs of arbitrary size.
8960 * This corresponds to std::vector in C++
8962 typedef struct LDKCVec_UpdateAddHTLCZ {
8964 * The elements in the array.
8965 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
8967 struct LDKUpdateAddHTLC *data;
8969 * The number of elements pointed to by `data`.
8972 } LDKCVec_UpdateAddHTLCZ;
8977 * An update_fulfill_htlc message to be sent or received from a peer
8979 typedef struct MUST_USE_STRUCT LDKUpdateFulfillHTLC {
8981 * A pointer to the opaque Rust object.
8982 * Nearly everywhere, inner must be non-null, however in places where
8983 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8985 LDKnativeUpdateFulfillHTLC *inner;
8987 * Indicates that this is the only struct which contains the same pointer.
8988 * Rust functions which take ownership of an object provided via an argument require
8989 * this to be true and invalidate the object pointed to by inner.
8992 } LDKUpdateFulfillHTLC;
8995 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateFulfillHTLCs of arbitrary size.
8996 * This corresponds to std::vector in C++
8998 typedef struct LDKCVec_UpdateFulfillHTLCZ {
9000 * The elements in the array.
9001 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
9003 struct LDKUpdateFulfillHTLC *data;
9005 * The number of elements pointed to by `data`.
9008 } LDKCVec_UpdateFulfillHTLCZ;
9013 * An update_fail_htlc message to be sent or received from a peer
9015 typedef struct MUST_USE_STRUCT LDKUpdateFailHTLC {
9017 * A pointer to the opaque Rust object.
9018 * Nearly everywhere, inner must be non-null, however in places where
9019 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9021 LDKnativeUpdateFailHTLC *inner;
9023 * Indicates that this is the only struct which contains the same pointer.
9024 * Rust functions which take ownership of an object provided via an argument require
9025 * this to be true and invalidate the object pointed to by inner.
9028 } LDKUpdateFailHTLC;
9031 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateFailHTLCs of arbitrary size.
9032 * This corresponds to std::vector in C++
9034 typedef struct LDKCVec_UpdateFailHTLCZ {
9036 * The elements in the array.
9037 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
9039 struct LDKUpdateFailHTLC *data;
9041 * The number of elements pointed to by `data`.
9044 } LDKCVec_UpdateFailHTLCZ;
9049 * An update_fail_malformed_htlc message to be sent or received from a peer
9051 typedef struct MUST_USE_STRUCT LDKUpdateFailMalformedHTLC {
9053 * A pointer to the opaque Rust object.
9054 * Nearly everywhere, inner must be non-null, however in places where
9055 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9057 LDKnativeUpdateFailMalformedHTLC *inner;
9059 * Indicates that this is the only struct which contains the same pointer.
9060 * Rust functions which take ownership of an object provided via an argument require
9061 * this to be true and invalidate the object pointed to by inner.
9064 } LDKUpdateFailMalformedHTLC;
9067 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateFailMalformedHTLCs of arbitrary size.
9068 * This corresponds to std::vector in C++
9070 typedef struct LDKCVec_UpdateFailMalformedHTLCZ {
9072 * The elements in the array.
9073 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
9075 struct LDKUpdateFailMalformedHTLC *data;
9077 * The number of elements pointed to by `data`.
9080 } LDKCVec_UpdateFailMalformedHTLCZ;
9083 * The contents of CResult_AcceptChannelDecodeErrorZ
9085 typedef union LDKCResult_AcceptChannelDecodeErrorZPtr {
9087 * A pointer to the contents in the success state.
9088 * Reading from this pointer when `result_ok` is not set is undefined.
9090 struct LDKAcceptChannel *result;
9092 * A pointer to the contents in the error state.
9093 * Reading from this pointer when `result_ok` is set is undefined.
9095 struct LDKDecodeError *err;
9096 } LDKCResult_AcceptChannelDecodeErrorZPtr;
9099 * A CResult_AcceptChannelDecodeErrorZ represents the result of a fallible operation,
9100 * containing a crate::lightning::ln::msgs::AcceptChannel on success and a crate::lightning::ln::msgs::DecodeError on failure.
9101 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9103 typedef struct LDKCResult_AcceptChannelDecodeErrorZ {
9105 * The contents of this CResult_AcceptChannelDecodeErrorZ, accessible via either
9106 * `err` or `result` depending on the state of `result_ok`.
9108 union LDKCResult_AcceptChannelDecodeErrorZPtr contents;
9110 * Whether this CResult_AcceptChannelDecodeErrorZ represents a success state.
9113 } LDKCResult_AcceptChannelDecodeErrorZ;
9116 * The contents of CResult_AnnouncementSignaturesDecodeErrorZ
9118 typedef union LDKCResult_AnnouncementSignaturesDecodeErrorZPtr {
9120 * A pointer to the contents in the success state.
9121 * Reading from this pointer when `result_ok` is not set is undefined.
9123 struct LDKAnnouncementSignatures *result;
9125 * A pointer to the contents in the error state.
9126 * Reading from this pointer when `result_ok` is set is undefined.
9128 struct LDKDecodeError *err;
9129 } LDKCResult_AnnouncementSignaturesDecodeErrorZPtr;
9132 * A CResult_AnnouncementSignaturesDecodeErrorZ represents the result of a fallible operation,
9133 * containing a crate::lightning::ln::msgs::AnnouncementSignatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
9134 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9136 typedef struct LDKCResult_AnnouncementSignaturesDecodeErrorZ {
9138 * The contents of this CResult_AnnouncementSignaturesDecodeErrorZ, accessible via either
9139 * `err` or `result` depending on the state of `result_ok`.
9141 union LDKCResult_AnnouncementSignaturesDecodeErrorZPtr contents;
9143 * Whether this CResult_AnnouncementSignaturesDecodeErrorZ represents a success state.
9146 } LDKCResult_AnnouncementSignaturesDecodeErrorZ;
9149 * The contents of CResult_ChannelReestablishDecodeErrorZ
9151 typedef union LDKCResult_ChannelReestablishDecodeErrorZPtr {
9153 * A pointer to the contents in the success state.
9154 * Reading from this pointer when `result_ok` is not set is undefined.
9156 struct LDKChannelReestablish *result;
9158 * A pointer to the contents in the error state.
9159 * Reading from this pointer when `result_ok` is set is undefined.
9161 struct LDKDecodeError *err;
9162 } LDKCResult_ChannelReestablishDecodeErrorZPtr;
9165 * A CResult_ChannelReestablishDecodeErrorZ represents the result of a fallible operation,
9166 * containing a crate::lightning::ln::msgs::ChannelReestablish on success and a crate::lightning::ln::msgs::DecodeError on failure.
9167 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9169 typedef struct LDKCResult_ChannelReestablishDecodeErrorZ {
9171 * The contents of this CResult_ChannelReestablishDecodeErrorZ, accessible via either
9172 * `err` or `result` depending on the state of `result_ok`.
9174 union LDKCResult_ChannelReestablishDecodeErrorZPtr contents;
9176 * Whether this CResult_ChannelReestablishDecodeErrorZ represents a success state.
9179 } LDKCResult_ChannelReestablishDecodeErrorZ;
9182 * The contents of CResult_ClosingSignedDecodeErrorZ
9184 typedef union LDKCResult_ClosingSignedDecodeErrorZPtr {
9186 * A pointer to the contents in the success state.
9187 * Reading from this pointer when `result_ok` is not set is undefined.
9189 struct LDKClosingSigned *result;
9191 * A pointer to the contents in the error state.
9192 * Reading from this pointer when `result_ok` is set is undefined.
9194 struct LDKDecodeError *err;
9195 } LDKCResult_ClosingSignedDecodeErrorZPtr;
9198 * A CResult_ClosingSignedDecodeErrorZ represents the result of a fallible operation,
9199 * containing a crate::lightning::ln::msgs::ClosingSigned on success and a crate::lightning::ln::msgs::DecodeError on failure.
9200 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9202 typedef struct LDKCResult_ClosingSignedDecodeErrorZ {
9204 * The contents of this CResult_ClosingSignedDecodeErrorZ, accessible via either
9205 * `err` or `result` depending on the state of `result_ok`.
9207 union LDKCResult_ClosingSignedDecodeErrorZPtr contents;
9209 * Whether this CResult_ClosingSignedDecodeErrorZ represents a success state.
9212 } LDKCResult_ClosingSignedDecodeErrorZ;
9217 * The minimum and maximum fees which the sender is willing to place on the closing transaction.
9218 * This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
9221 typedef struct MUST_USE_STRUCT LDKClosingSignedFeeRange {
9223 * A pointer to the opaque Rust object.
9224 * Nearly everywhere, inner must be non-null, however in places where
9225 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9227 LDKnativeClosingSignedFeeRange *inner;
9229 * Indicates that this is the only struct which contains the same pointer.
9230 * Rust functions which take ownership of an object provided via an argument require
9231 * this to be true and invalidate the object pointed to by inner.
9234 } LDKClosingSignedFeeRange;
9237 * The contents of CResult_ClosingSignedFeeRangeDecodeErrorZ
9239 typedef union LDKCResult_ClosingSignedFeeRangeDecodeErrorZPtr {
9241 * A pointer to the contents in the success state.
9242 * Reading from this pointer when `result_ok` is not set is undefined.
9244 struct LDKClosingSignedFeeRange *result;
9246 * A pointer to the contents in the error state.
9247 * Reading from this pointer when `result_ok` is set is undefined.
9249 struct LDKDecodeError *err;
9250 } LDKCResult_ClosingSignedFeeRangeDecodeErrorZPtr;
9253 * A CResult_ClosingSignedFeeRangeDecodeErrorZ represents the result of a fallible operation,
9254 * containing a crate::lightning::ln::msgs::ClosingSignedFeeRange on success and a crate::lightning::ln::msgs::DecodeError on failure.
9255 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9257 typedef struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ {
9259 * The contents of this CResult_ClosingSignedFeeRangeDecodeErrorZ, accessible via either
9260 * `err` or `result` depending on the state of `result_ok`.
9262 union LDKCResult_ClosingSignedFeeRangeDecodeErrorZPtr contents;
9264 * Whether this CResult_ClosingSignedFeeRangeDecodeErrorZ represents a success state.
9267 } LDKCResult_ClosingSignedFeeRangeDecodeErrorZ;
9272 * A commitment_signed message to be sent or received from a peer
9274 typedef struct MUST_USE_STRUCT LDKCommitmentSigned {
9276 * A pointer to the opaque Rust object.
9277 * Nearly everywhere, inner must be non-null, however in places where
9278 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9280 LDKnativeCommitmentSigned *inner;
9282 * Indicates that this is the only struct which contains the same pointer.
9283 * Rust functions which take ownership of an object provided via an argument require
9284 * this to be true and invalidate the object pointed to by inner.
9287 } LDKCommitmentSigned;
9290 * The contents of CResult_CommitmentSignedDecodeErrorZ
9292 typedef union LDKCResult_CommitmentSignedDecodeErrorZPtr {
9294 * A pointer to the contents in the success state.
9295 * Reading from this pointer when `result_ok` is not set is undefined.
9297 struct LDKCommitmentSigned *result;
9299 * A pointer to the contents in the error state.
9300 * Reading from this pointer when `result_ok` is set is undefined.
9302 struct LDKDecodeError *err;
9303 } LDKCResult_CommitmentSignedDecodeErrorZPtr;
9306 * A CResult_CommitmentSignedDecodeErrorZ represents the result of a fallible operation,
9307 * containing a crate::lightning::ln::msgs::CommitmentSigned on success and a crate::lightning::ln::msgs::DecodeError on failure.
9308 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9310 typedef struct LDKCResult_CommitmentSignedDecodeErrorZ {
9312 * The contents of this CResult_CommitmentSignedDecodeErrorZ, accessible via either
9313 * `err` or `result` depending on the state of `result_ok`.
9315 union LDKCResult_CommitmentSignedDecodeErrorZPtr contents;
9317 * Whether this CResult_CommitmentSignedDecodeErrorZ represents a success state.
9320 } LDKCResult_CommitmentSignedDecodeErrorZ;
9323 * The contents of CResult_FundingCreatedDecodeErrorZ
9325 typedef union LDKCResult_FundingCreatedDecodeErrorZPtr {
9327 * A pointer to the contents in the success state.
9328 * Reading from this pointer when `result_ok` is not set is undefined.
9330 struct LDKFundingCreated *result;
9332 * A pointer to the contents in the error state.
9333 * Reading from this pointer when `result_ok` is set is undefined.
9335 struct LDKDecodeError *err;
9336 } LDKCResult_FundingCreatedDecodeErrorZPtr;
9339 * A CResult_FundingCreatedDecodeErrorZ represents the result of a fallible operation,
9340 * containing a crate::lightning::ln::msgs::FundingCreated on success and a crate::lightning::ln::msgs::DecodeError on failure.
9341 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9343 typedef struct LDKCResult_FundingCreatedDecodeErrorZ {
9345 * The contents of this CResult_FundingCreatedDecodeErrorZ, accessible via either
9346 * `err` or `result` depending on the state of `result_ok`.
9348 union LDKCResult_FundingCreatedDecodeErrorZPtr contents;
9350 * Whether this CResult_FundingCreatedDecodeErrorZ represents a success state.
9353 } LDKCResult_FundingCreatedDecodeErrorZ;
9356 * The contents of CResult_FundingSignedDecodeErrorZ
9358 typedef union LDKCResult_FundingSignedDecodeErrorZPtr {
9360 * A pointer to the contents in the success state.
9361 * Reading from this pointer when `result_ok` is not set is undefined.
9363 struct LDKFundingSigned *result;
9365 * A pointer to the contents in the error state.
9366 * Reading from this pointer when `result_ok` is set is undefined.
9368 struct LDKDecodeError *err;
9369 } LDKCResult_FundingSignedDecodeErrorZPtr;
9372 * A CResult_FundingSignedDecodeErrorZ represents the result of a fallible operation,
9373 * containing a crate::lightning::ln::msgs::FundingSigned on success and a crate::lightning::ln::msgs::DecodeError on failure.
9374 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9376 typedef struct LDKCResult_FundingSignedDecodeErrorZ {
9378 * The contents of this CResult_FundingSignedDecodeErrorZ, accessible via either
9379 * `err` or `result` depending on the state of `result_ok`.
9381 union LDKCResult_FundingSignedDecodeErrorZPtr contents;
9383 * Whether this CResult_FundingSignedDecodeErrorZ represents a success state.
9386 } LDKCResult_FundingSignedDecodeErrorZ;
9389 * The contents of CResult_FundingLockedDecodeErrorZ
9391 typedef union LDKCResult_FundingLockedDecodeErrorZPtr {
9393 * A pointer to the contents in the success state.
9394 * Reading from this pointer when `result_ok` is not set is undefined.
9396 struct LDKFundingLocked *result;
9398 * A pointer to the contents in the error state.
9399 * Reading from this pointer when `result_ok` is set is undefined.
9401 struct LDKDecodeError *err;
9402 } LDKCResult_FundingLockedDecodeErrorZPtr;
9405 * A CResult_FundingLockedDecodeErrorZ represents the result of a fallible operation,
9406 * containing a crate::lightning::ln::msgs::FundingLocked on success and a crate::lightning::ln::msgs::DecodeError on failure.
9407 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9409 typedef struct LDKCResult_FundingLockedDecodeErrorZ {
9411 * The contents of this CResult_FundingLockedDecodeErrorZ, accessible via either
9412 * `err` or `result` depending on the state of `result_ok`.
9414 union LDKCResult_FundingLockedDecodeErrorZPtr contents;
9416 * Whether this CResult_FundingLockedDecodeErrorZ represents a success state.
9419 } LDKCResult_FundingLockedDecodeErrorZ;
9424 * An init message to be sent or received from a peer
9426 typedef struct MUST_USE_STRUCT LDKInit {
9428 * A pointer to the opaque Rust object.
9429 * Nearly everywhere, inner must be non-null, however in places where
9430 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9432 LDKnativeInit *inner;
9434 * Indicates that this is the only struct which contains the same pointer.
9435 * Rust functions which take ownership of an object provided via an argument require
9436 * this to be true and invalidate the object pointed to by inner.
9442 * The contents of CResult_InitDecodeErrorZ
9444 typedef union LDKCResult_InitDecodeErrorZPtr {
9446 * A pointer to the contents in the success state.
9447 * Reading from this pointer when `result_ok` is not set is undefined.
9449 struct LDKInit *result;
9451 * A pointer to the contents in the error state.
9452 * Reading from this pointer when `result_ok` is set is undefined.
9454 struct LDKDecodeError *err;
9455 } LDKCResult_InitDecodeErrorZPtr;
9458 * A CResult_InitDecodeErrorZ represents the result of a fallible operation,
9459 * containing a crate::lightning::ln::msgs::Init on success and a crate::lightning::ln::msgs::DecodeError on failure.
9460 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9462 typedef struct LDKCResult_InitDecodeErrorZ {
9464 * The contents of this CResult_InitDecodeErrorZ, accessible via either
9465 * `err` or `result` depending on the state of `result_ok`.
9467 union LDKCResult_InitDecodeErrorZPtr contents;
9469 * Whether this CResult_InitDecodeErrorZ represents a success state.
9472 } LDKCResult_InitDecodeErrorZ;
9475 * The contents of CResult_OpenChannelDecodeErrorZ
9477 typedef union LDKCResult_OpenChannelDecodeErrorZPtr {
9479 * A pointer to the contents in the success state.
9480 * Reading from this pointer when `result_ok` is not set is undefined.
9482 struct LDKOpenChannel *result;
9484 * A pointer to the contents in the error state.
9485 * Reading from this pointer when `result_ok` is set is undefined.
9487 struct LDKDecodeError *err;
9488 } LDKCResult_OpenChannelDecodeErrorZPtr;
9491 * A CResult_OpenChannelDecodeErrorZ represents the result of a fallible operation,
9492 * containing a crate::lightning::ln::msgs::OpenChannel on success and a crate::lightning::ln::msgs::DecodeError on failure.
9493 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9495 typedef struct LDKCResult_OpenChannelDecodeErrorZ {
9497 * The contents of this CResult_OpenChannelDecodeErrorZ, accessible via either
9498 * `err` or `result` depending on the state of `result_ok`.
9500 union LDKCResult_OpenChannelDecodeErrorZPtr contents;
9502 * Whether this CResult_OpenChannelDecodeErrorZ represents a success state.
9505 } LDKCResult_OpenChannelDecodeErrorZ;
9508 * The contents of CResult_RevokeAndACKDecodeErrorZ
9510 typedef union LDKCResult_RevokeAndACKDecodeErrorZPtr {
9512 * A pointer to the contents in the success state.
9513 * Reading from this pointer when `result_ok` is not set is undefined.
9515 struct LDKRevokeAndACK *result;
9517 * A pointer to the contents in the error state.
9518 * Reading from this pointer when `result_ok` is set is undefined.
9520 struct LDKDecodeError *err;
9521 } LDKCResult_RevokeAndACKDecodeErrorZPtr;
9524 * A CResult_RevokeAndACKDecodeErrorZ represents the result of a fallible operation,
9525 * containing a crate::lightning::ln::msgs::RevokeAndACK on success and a crate::lightning::ln::msgs::DecodeError on failure.
9526 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9528 typedef struct LDKCResult_RevokeAndACKDecodeErrorZ {
9530 * The contents of this CResult_RevokeAndACKDecodeErrorZ, accessible via either
9531 * `err` or `result` depending on the state of `result_ok`.
9533 union LDKCResult_RevokeAndACKDecodeErrorZPtr contents;
9535 * Whether this CResult_RevokeAndACKDecodeErrorZ represents a success state.
9538 } LDKCResult_RevokeAndACKDecodeErrorZ;
9541 * The contents of CResult_ShutdownDecodeErrorZ
9543 typedef union LDKCResult_ShutdownDecodeErrorZPtr {
9545 * A pointer to the contents in the success state.
9546 * Reading from this pointer when `result_ok` is not set is undefined.
9548 struct LDKShutdown *result;
9550 * A pointer to the contents in the error state.
9551 * Reading from this pointer when `result_ok` is set is undefined.
9553 struct LDKDecodeError *err;
9554 } LDKCResult_ShutdownDecodeErrorZPtr;
9557 * A CResult_ShutdownDecodeErrorZ represents the result of a fallible operation,
9558 * containing a crate::lightning::ln::msgs::Shutdown on success and a crate::lightning::ln::msgs::DecodeError on failure.
9559 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9561 typedef struct LDKCResult_ShutdownDecodeErrorZ {
9563 * The contents of this CResult_ShutdownDecodeErrorZ, accessible via either
9564 * `err` or `result` depending on the state of `result_ok`.
9566 union LDKCResult_ShutdownDecodeErrorZPtr contents;
9568 * Whether this CResult_ShutdownDecodeErrorZ represents a success state.
9571 } LDKCResult_ShutdownDecodeErrorZ;
9574 * The contents of CResult_UpdateFailHTLCDecodeErrorZ
9576 typedef union LDKCResult_UpdateFailHTLCDecodeErrorZPtr {
9578 * A pointer to the contents in the success state.
9579 * Reading from this pointer when `result_ok` is not set is undefined.
9581 struct LDKUpdateFailHTLC *result;
9583 * A pointer to the contents in the error state.
9584 * Reading from this pointer when `result_ok` is set is undefined.
9586 struct LDKDecodeError *err;
9587 } LDKCResult_UpdateFailHTLCDecodeErrorZPtr;
9590 * A CResult_UpdateFailHTLCDecodeErrorZ represents the result of a fallible operation,
9591 * containing a crate::lightning::ln::msgs::UpdateFailHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
9592 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9594 typedef struct LDKCResult_UpdateFailHTLCDecodeErrorZ {
9596 * The contents of this CResult_UpdateFailHTLCDecodeErrorZ, accessible via either
9597 * `err` or `result` depending on the state of `result_ok`.
9599 union LDKCResult_UpdateFailHTLCDecodeErrorZPtr contents;
9601 * Whether this CResult_UpdateFailHTLCDecodeErrorZ represents a success state.
9604 } LDKCResult_UpdateFailHTLCDecodeErrorZ;
9607 * The contents of CResult_UpdateFailMalformedHTLCDecodeErrorZ
9609 typedef union LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr {
9611 * A pointer to the contents in the success state.
9612 * Reading from this pointer when `result_ok` is not set is undefined.
9614 struct LDKUpdateFailMalformedHTLC *result;
9616 * A pointer to the contents in the error state.
9617 * Reading from this pointer when `result_ok` is set is undefined.
9619 struct LDKDecodeError *err;
9620 } LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr;
9623 * A CResult_UpdateFailMalformedHTLCDecodeErrorZ represents the result of a fallible operation,
9624 * containing a crate::lightning::ln::msgs::UpdateFailMalformedHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
9625 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9627 typedef struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ {
9629 * The contents of this CResult_UpdateFailMalformedHTLCDecodeErrorZ, accessible via either
9630 * `err` or `result` depending on the state of `result_ok`.
9632 union LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr contents;
9634 * Whether this CResult_UpdateFailMalformedHTLCDecodeErrorZ represents a success state.
9637 } LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ;
9642 * An update_fee message to be sent or received from a peer
9644 typedef struct MUST_USE_STRUCT LDKUpdateFee {
9646 * A pointer to the opaque Rust object.
9647 * Nearly everywhere, inner must be non-null, however in places where
9648 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9650 LDKnativeUpdateFee *inner;
9652 * Indicates that this is the only struct which contains the same pointer.
9653 * Rust functions which take ownership of an object provided via an argument require
9654 * this to be true and invalidate the object pointed to by inner.
9660 * The contents of CResult_UpdateFeeDecodeErrorZ
9662 typedef union LDKCResult_UpdateFeeDecodeErrorZPtr {
9664 * A pointer to the contents in the success state.
9665 * Reading from this pointer when `result_ok` is not set is undefined.
9667 struct LDKUpdateFee *result;
9669 * A pointer to the contents in the error state.
9670 * Reading from this pointer when `result_ok` is set is undefined.
9672 struct LDKDecodeError *err;
9673 } LDKCResult_UpdateFeeDecodeErrorZPtr;
9676 * A CResult_UpdateFeeDecodeErrorZ represents the result of a fallible operation,
9677 * containing a crate::lightning::ln::msgs::UpdateFee on success and a crate::lightning::ln::msgs::DecodeError on failure.
9678 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9680 typedef struct LDKCResult_UpdateFeeDecodeErrorZ {
9682 * The contents of this CResult_UpdateFeeDecodeErrorZ, accessible via either
9683 * `err` or `result` depending on the state of `result_ok`.
9685 union LDKCResult_UpdateFeeDecodeErrorZPtr contents;
9687 * Whether this CResult_UpdateFeeDecodeErrorZ represents a success state.
9690 } LDKCResult_UpdateFeeDecodeErrorZ;
9693 * The contents of CResult_UpdateFulfillHTLCDecodeErrorZ
9695 typedef union LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr {
9697 * A pointer to the contents in the success state.
9698 * Reading from this pointer when `result_ok` is not set is undefined.
9700 struct LDKUpdateFulfillHTLC *result;
9702 * A pointer to the contents in the error state.
9703 * Reading from this pointer when `result_ok` is set is undefined.
9705 struct LDKDecodeError *err;
9706 } LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr;
9709 * A CResult_UpdateFulfillHTLCDecodeErrorZ represents the result of a fallible operation,
9710 * containing a crate::lightning::ln::msgs::UpdateFulfillHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
9711 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9713 typedef struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ {
9715 * The contents of this CResult_UpdateFulfillHTLCDecodeErrorZ, accessible via either
9716 * `err` or `result` depending on the state of `result_ok`.
9718 union LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr contents;
9720 * Whether this CResult_UpdateFulfillHTLCDecodeErrorZ represents a success state.
9723 } LDKCResult_UpdateFulfillHTLCDecodeErrorZ;
9726 * The contents of CResult_UpdateAddHTLCDecodeErrorZ
9728 typedef union LDKCResult_UpdateAddHTLCDecodeErrorZPtr {
9730 * A pointer to the contents in the success state.
9731 * Reading from this pointer when `result_ok` is not set is undefined.
9733 struct LDKUpdateAddHTLC *result;
9735 * A pointer to the contents in the error state.
9736 * Reading from this pointer when `result_ok` is set is undefined.
9738 struct LDKDecodeError *err;
9739 } LDKCResult_UpdateAddHTLCDecodeErrorZPtr;
9742 * A CResult_UpdateAddHTLCDecodeErrorZ represents the result of a fallible operation,
9743 * containing a crate::lightning::ln::msgs::UpdateAddHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
9744 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9746 typedef struct LDKCResult_UpdateAddHTLCDecodeErrorZ {
9748 * The contents of this CResult_UpdateAddHTLCDecodeErrorZ, accessible via either
9749 * `err` or `result` depending on the state of `result_ok`.
9751 union LDKCResult_UpdateAddHTLCDecodeErrorZPtr contents;
9753 * Whether this CResult_UpdateAddHTLCDecodeErrorZ represents a success state.
9756 } LDKCResult_UpdateAddHTLCDecodeErrorZ;
9761 * A ping message to be sent or received from a peer
9763 typedef struct MUST_USE_STRUCT LDKPing {
9765 * A pointer to the opaque Rust object.
9766 * Nearly everywhere, inner must be non-null, however in places where
9767 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9769 LDKnativePing *inner;
9771 * Indicates that this is the only struct which contains the same pointer.
9772 * Rust functions which take ownership of an object provided via an argument require
9773 * this to be true and invalidate the object pointed to by inner.
9779 * The contents of CResult_PingDecodeErrorZ
9781 typedef union LDKCResult_PingDecodeErrorZPtr {
9783 * A pointer to the contents in the success state.
9784 * Reading from this pointer when `result_ok` is not set is undefined.
9786 struct LDKPing *result;
9788 * A pointer to the contents in the error state.
9789 * Reading from this pointer when `result_ok` is set is undefined.
9791 struct LDKDecodeError *err;
9792 } LDKCResult_PingDecodeErrorZPtr;
9795 * A CResult_PingDecodeErrorZ represents the result of a fallible operation,
9796 * containing a crate::lightning::ln::msgs::Ping on success and a crate::lightning::ln::msgs::DecodeError on failure.
9797 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9799 typedef struct LDKCResult_PingDecodeErrorZ {
9801 * The contents of this CResult_PingDecodeErrorZ, accessible via either
9802 * `err` or `result` depending on the state of `result_ok`.
9804 union LDKCResult_PingDecodeErrorZPtr contents;
9806 * Whether this CResult_PingDecodeErrorZ represents a success state.
9809 } LDKCResult_PingDecodeErrorZ;
9814 * A pong message to be sent or received from a peer
9816 typedef struct MUST_USE_STRUCT LDKPong {
9818 * A pointer to the opaque Rust object.
9819 * Nearly everywhere, inner must be non-null, however in places where
9820 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9822 LDKnativePong *inner;
9824 * Indicates that this is the only struct which contains the same pointer.
9825 * Rust functions which take ownership of an object provided via an argument require
9826 * this to be true and invalidate the object pointed to by inner.
9832 * The contents of CResult_PongDecodeErrorZ
9834 typedef union LDKCResult_PongDecodeErrorZPtr {
9836 * A pointer to the contents in the success state.
9837 * Reading from this pointer when `result_ok` is not set is undefined.
9839 struct LDKPong *result;
9841 * A pointer to the contents in the error state.
9842 * Reading from this pointer when `result_ok` is set is undefined.
9844 struct LDKDecodeError *err;
9845 } LDKCResult_PongDecodeErrorZPtr;
9848 * A CResult_PongDecodeErrorZ represents the result of a fallible operation,
9849 * containing a crate::lightning::ln::msgs::Pong on success and a crate::lightning::ln::msgs::DecodeError on failure.
9850 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9852 typedef struct LDKCResult_PongDecodeErrorZ {
9854 * The contents of this CResult_PongDecodeErrorZ, accessible via either
9855 * `err` or `result` depending on the state of `result_ok`.
9857 union LDKCResult_PongDecodeErrorZPtr contents;
9859 * Whether this CResult_PongDecodeErrorZ represents a success state.
9862 } LDKCResult_PongDecodeErrorZ;
9865 * The contents of CResult_UnsignedChannelAnnouncementDecodeErrorZ
9867 typedef union LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr {
9869 * A pointer to the contents in the success state.
9870 * Reading from this pointer when `result_ok` is not set is undefined.
9872 struct LDKUnsignedChannelAnnouncement *result;
9874 * A pointer to the contents in the error state.
9875 * Reading from this pointer when `result_ok` is set is undefined.
9877 struct LDKDecodeError *err;
9878 } LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr;
9881 * A CResult_UnsignedChannelAnnouncementDecodeErrorZ represents the result of a fallible operation,
9882 * containing a crate::lightning::ln::msgs::UnsignedChannelAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
9883 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9885 typedef struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ {
9887 * The contents of this CResult_UnsignedChannelAnnouncementDecodeErrorZ, accessible via either
9888 * `err` or `result` depending on the state of `result_ok`.
9890 union LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr contents;
9892 * Whether this CResult_UnsignedChannelAnnouncementDecodeErrorZ represents a success state.
9895 } LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ;
9898 * The contents of CResult_ChannelAnnouncementDecodeErrorZ
9900 typedef union LDKCResult_ChannelAnnouncementDecodeErrorZPtr {
9902 * A pointer to the contents in the success state.
9903 * Reading from this pointer when `result_ok` is not set is undefined.
9905 struct LDKChannelAnnouncement *result;
9907 * A pointer to the contents in the error state.
9908 * Reading from this pointer when `result_ok` is set is undefined.
9910 struct LDKDecodeError *err;
9911 } LDKCResult_ChannelAnnouncementDecodeErrorZPtr;
9914 * A CResult_ChannelAnnouncementDecodeErrorZ represents the result of a fallible operation,
9915 * containing a crate::lightning::ln::msgs::ChannelAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
9916 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9918 typedef struct LDKCResult_ChannelAnnouncementDecodeErrorZ {
9920 * The contents of this CResult_ChannelAnnouncementDecodeErrorZ, accessible via either
9921 * `err` or `result` depending on the state of `result_ok`.
9923 union LDKCResult_ChannelAnnouncementDecodeErrorZPtr contents;
9925 * Whether this CResult_ChannelAnnouncementDecodeErrorZ represents a success state.
9928 } LDKCResult_ChannelAnnouncementDecodeErrorZ;
9933 * The unsigned part of a channel_update
9935 typedef struct MUST_USE_STRUCT LDKUnsignedChannelUpdate {
9937 * A pointer to the opaque Rust object.
9938 * Nearly everywhere, inner must be non-null, however in places where
9939 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9941 LDKnativeUnsignedChannelUpdate *inner;
9943 * Indicates that this is the only struct which contains the same pointer.
9944 * Rust functions which take ownership of an object provided via an argument require
9945 * this to be true and invalidate the object pointed to by inner.
9948 } LDKUnsignedChannelUpdate;
9951 * The contents of CResult_UnsignedChannelUpdateDecodeErrorZ
9953 typedef union LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr {
9955 * A pointer to the contents in the success state.
9956 * Reading from this pointer when `result_ok` is not set is undefined.
9958 struct LDKUnsignedChannelUpdate *result;
9960 * A pointer to the contents in the error state.
9961 * Reading from this pointer when `result_ok` is set is undefined.
9963 struct LDKDecodeError *err;
9964 } LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr;
9967 * A CResult_UnsignedChannelUpdateDecodeErrorZ represents the result of a fallible operation,
9968 * containing a crate::lightning::ln::msgs::UnsignedChannelUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
9969 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9971 typedef struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ {
9973 * The contents of this CResult_UnsignedChannelUpdateDecodeErrorZ, accessible via either
9974 * `err` or `result` depending on the state of `result_ok`.
9976 union LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr contents;
9978 * Whether this CResult_UnsignedChannelUpdateDecodeErrorZ represents a success state.
9981 } LDKCResult_UnsignedChannelUpdateDecodeErrorZ;
9984 * The contents of CResult_ChannelUpdateDecodeErrorZ
9986 typedef union LDKCResult_ChannelUpdateDecodeErrorZPtr {
9988 * A pointer to the contents in the success state.
9989 * Reading from this pointer when `result_ok` is not set is undefined.
9991 struct LDKChannelUpdate *result;
9993 * A pointer to the contents in the error state.
9994 * Reading from this pointer when `result_ok` is set is undefined.
9996 struct LDKDecodeError *err;
9997 } LDKCResult_ChannelUpdateDecodeErrorZPtr;
10000 * A CResult_ChannelUpdateDecodeErrorZ represents the result of a fallible operation,
10001 * containing a crate::lightning::ln::msgs::ChannelUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
10002 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10004 typedef struct LDKCResult_ChannelUpdateDecodeErrorZ {
10006 * The contents of this CResult_ChannelUpdateDecodeErrorZ, accessible via either
10007 * `err` or `result` depending on the state of `result_ok`.
10009 union LDKCResult_ChannelUpdateDecodeErrorZPtr contents;
10011 * Whether this CResult_ChannelUpdateDecodeErrorZ represents a success state.
10014 } LDKCResult_ChannelUpdateDecodeErrorZ;
10017 * The contents of CResult_ErrorMessageDecodeErrorZ
10019 typedef union LDKCResult_ErrorMessageDecodeErrorZPtr {
10021 * A pointer to the contents in the success state.
10022 * Reading from this pointer when `result_ok` is not set is undefined.
10024 struct LDKErrorMessage *result;
10026 * A pointer to the contents in the error state.
10027 * Reading from this pointer when `result_ok` is set is undefined.
10029 struct LDKDecodeError *err;
10030 } LDKCResult_ErrorMessageDecodeErrorZPtr;
10033 * A CResult_ErrorMessageDecodeErrorZ represents the result of a fallible operation,
10034 * containing a crate::lightning::ln::msgs::ErrorMessage on success and a crate::lightning::ln::msgs::DecodeError on failure.
10035 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10037 typedef struct LDKCResult_ErrorMessageDecodeErrorZ {
10039 * The contents of this CResult_ErrorMessageDecodeErrorZ, accessible via either
10040 * `err` or `result` depending on the state of `result_ok`.
10042 union LDKCResult_ErrorMessageDecodeErrorZPtr contents;
10044 * Whether this CResult_ErrorMessageDecodeErrorZ represents a success state.
10047 } LDKCResult_ErrorMessageDecodeErrorZ;
10050 * The contents of CResult_WarningMessageDecodeErrorZ
10052 typedef union LDKCResult_WarningMessageDecodeErrorZPtr {
10054 * A pointer to the contents in the success state.
10055 * Reading from this pointer when `result_ok` is not set is undefined.
10057 struct LDKWarningMessage *result;
10059 * A pointer to the contents in the error state.
10060 * Reading from this pointer when `result_ok` is set is undefined.
10062 struct LDKDecodeError *err;
10063 } LDKCResult_WarningMessageDecodeErrorZPtr;
10066 * A CResult_WarningMessageDecodeErrorZ represents the result of a fallible operation,
10067 * containing a crate::lightning::ln::msgs::WarningMessage on success and a crate::lightning::ln::msgs::DecodeError on failure.
10068 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10070 typedef struct LDKCResult_WarningMessageDecodeErrorZ {
10072 * The contents of this CResult_WarningMessageDecodeErrorZ, accessible via either
10073 * `err` or `result` depending on the state of `result_ok`.
10075 union LDKCResult_WarningMessageDecodeErrorZPtr contents;
10077 * Whether this CResult_WarningMessageDecodeErrorZ represents a success state.
10080 } LDKCResult_WarningMessageDecodeErrorZ;
10085 * The unsigned part of a node_announcement
10087 typedef struct MUST_USE_STRUCT LDKUnsignedNodeAnnouncement {
10089 * A pointer to the opaque Rust object.
10090 * Nearly everywhere, inner must be non-null, however in places where
10091 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10093 LDKnativeUnsignedNodeAnnouncement *inner;
10095 * Indicates that this is the only struct which contains the same pointer.
10096 * Rust functions which take ownership of an object provided via an argument require
10097 * this to be true and invalidate the object pointed to by inner.
10100 } LDKUnsignedNodeAnnouncement;
10103 * The contents of CResult_UnsignedNodeAnnouncementDecodeErrorZ
10105 typedef union LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr {
10107 * A pointer to the contents in the success state.
10108 * Reading from this pointer when `result_ok` is not set is undefined.
10110 struct LDKUnsignedNodeAnnouncement *result;
10112 * A pointer to the contents in the error state.
10113 * Reading from this pointer when `result_ok` is set is undefined.
10115 struct LDKDecodeError *err;
10116 } LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr;
10119 * A CResult_UnsignedNodeAnnouncementDecodeErrorZ represents the result of a fallible operation,
10120 * containing a crate::lightning::ln::msgs::UnsignedNodeAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
10121 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10123 typedef struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ {
10125 * The contents of this CResult_UnsignedNodeAnnouncementDecodeErrorZ, accessible via either
10126 * `err` or `result` depending on the state of `result_ok`.
10128 union LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr contents;
10130 * Whether this CResult_UnsignedNodeAnnouncementDecodeErrorZ represents a success state.
10133 } LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ;
10136 * The contents of CResult_NodeAnnouncementDecodeErrorZ
10138 typedef union LDKCResult_NodeAnnouncementDecodeErrorZPtr {
10140 * A pointer to the contents in the success state.
10141 * Reading from this pointer when `result_ok` is not set is undefined.
10143 struct LDKNodeAnnouncement *result;
10145 * A pointer to the contents in the error state.
10146 * Reading from this pointer when `result_ok` is set is undefined.
10148 struct LDKDecodeError *err;
10149 } LDKCResult_NodeAnnouncementDecodeErrorZPtr;
10152 * A CResult_NodeAnnouncementDecodeErrorZ represents the result of a fallible operation,
10153 * containing a crate::lightning::ln::msgs::NodeAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
10154 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10156 typedef struct LDKCResult_NodeAnnouncementDecodeErrorZ {
10158 * The contents of this CResult_NodeAnnouncementDecodeErrorZ, accessible via either
10159 * `err` or `result` depending on the state of `result_ok`.
10161 union LDKCResult_NodeAnnouncementDecodeErrorZPtr contents;
10163 * Whether this CResult_NodeAnnouncementDecodeErrorZ represents a success state.
10166 } LDKCResult_NodeAnnouncementDecodeErrorZ;
10169 * The contents of CResult_QueryShortChannelIdsDecodeErrorZ
10171 typedef union LDKCResult_QueryShortChannelIdsDecodeErrorZPtr {
10173 * A pointer to the contents in the success state.
10174 * Reading from this pointer when `result_ok` is not set is undefined.
10176 struct LDKQueryShortChannelIds *result;
10178 * A pointer to the contents in the error state.
10179 * Reading from this pointer when `result_ok` is set is undefined.
10181 struct LDKDecodeError *err;
10182 } LDKCResult_QueryShortChannelIdsDecodeErrorZPtr;
10185 * A CResult_QueryShortChannelIdsDecodeErrorZ represents the result of a fallible operation,
10186 * containing a crate::lightning::ln::msgs::QueryShortChannelIds on success and a crate::lightning::ln::msgs::DecodeError on failure.
10187 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10189 typedef struct LDKCResult_QueryShortChannelIdsDecodeErrorZ {
10191 * The contents of this CResult_QueryShortChannelIdsDecodeErrorZ, accessible via either
10192 * `err` or `result` depending on the state of `result_ok`.
10194 union LDKCResult_QueryShortChannelIdsDecodeErrorZPtr contents;
10196 * Whether this CResult_QueryShortChannelIdsDecodeErrorZ represents a success state.
10199 } LDKCResult_QueryShortChannelIdsDecodeErrorZ;
10204 * A reply_short_channel_ids_end message is sent as a reply to a
10205 * query_short_channel_ids message. The query recipient makes a best
10206 * effort to respond based on their local network view which may not be
10207 * a perfect view of the network.
10209 typedef struct MUST_USE_STRUCT LDKReplyShortChannelIdsEnd {
10211 * A pointer to the opaque Rust object.
10212 * Nearly everywhere, inner must be non-null, however in places where
10213 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10215 LDKnativeReplyShortChannelIdsEnd *inner;
10217 * Indicates that this is the only struct which contains the same pointer.
10218 * Rust functions which take ownership of an object provided via an argument require
10219 * this to be true and invalidate the object pointed to by inner.
10222 } LDKReplyShortChannelIdsEnd;
10225 * The contents of CResult_ReplyShortChannelIdsEndDecodeErrorZ
10227 typedef union LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr {
10229 * A pointer to the contents in the success state.
10230 * Reading from this pointer when `result_ok` is not set is undefined.
10232 struct LDKReplyShortChannelIdsEnd *result;
10234 * A pointer to the contents in the error state.
10235 * Reading from this pointer when `result_ok` is set is undefined.
10237 struct LDKDecodeError *err;
10238 } LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr;
10241 * A CResult_ReplyShortChannelIdsEndDecodeErrorZ represents the result of a fallible operation,
10242 * containing a crate::lightning::ln::msgs::ReplyShortChannelIdsEnd on success and a crate::lightning::ln::msgs::DecodeError on failure.
10243 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10245 typedef struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ {
10247 * The contents of this CResult_ReplyShortChannelIdsEndDecodeErrorZ, accessible via either
10248 * `err` or `result` depending on the state of `result_ok`.
10250 union LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr contents;
10252 * Whether this CResult_ReplyShortChannelIdsEndDecodeErrorZ represents a success state.
10255 } LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ;
10258 * The contents of CResult_QueryChannelRangeDecodeErrorZ
10260 typedef union LDKCResult_QueryChannelRangeDecodeErrorZPtr {
10262 * A pointer to the contents in the success state.
10263 * Reading from this pointer when `result_ok` is not set is undefined.
10265 struct LDKQueryChannelRange *result;
10267 * A pointer to the contents in the error state.
10268 * Reading from this pointer when `result_ok` is set is undefined.
10270 struct LDKDecodeError *err;
10271 } LDKCResult_QueryChannelRangeDecodeErrorZPtr;
10274 * A CResult_QueryChannelRangeDecodeErrorZ represents the result of a fallible operation,
10275 * containing a crate::lightning::ln::msgs::QueryChannelRange on success and a crate::lightning::ln::msgs::DecodeError on failure.
10276 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10278 typedef struct LDKCResult_QueryChannelRangeDecodeErrorZ {
10280 * The contents of this CResult_QueryChannelRangeDecodeErrorZ, accessible via either
10281 * `err` or `result` depending on the state of `result_ok`.
10283 union LDKCResult_QueryChannelRangeDecodeErrorZPtr contents;
10285 * Whether this CResult_QueryChannelRangeDecodeErrorZ represents a success state.
10288 } LDKCResult_QueryChannelRangeDecodeErrorZ;
10291 * The contents of CResult_ReplyChannelRangeDecodeErrorZ
10293 typedef union LDKCResult_ReplyChannelRangeDecodeErrorZPtr {
10295 * A pointer to the contents in the success state.
10296 * Reading from this pointer when `result_ok` is not set is undefined.
10298 struct LDKReplyChannelRange *result;
10300 * A pointer to the contents in the error state.
10301 * Reading from this pointer when `result_ok` is set is undefined.
10303 struct LDKDecodeError *err;
10304 } LDKCResult_ReplyChannelRangeDecodeErrorZPtr;
10307 * A CResult_ReplyChannelRangeDecodeErrorZ represents the result of a fallible operation,
10308 * containing a crate::lightning::ln::msgs::ReplyChannelRange on success and a crate::lightning::ln::msgs::DecodeError on failure.
10309 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10311 typedef struct LDKCResult_ReplyChannelRangeDecodeErrorZ {
10313 * The contents of this CResult_ReplyChannelRangeDecodeErrorZ, accessible via either
10314 * `err` or `result` depending on the state of `result_ok`.
10316 union LDKCResult_ReplyChannelRangeDecodeErrorZPtr contents;
10318 * Whether this CResult_ReplyChannelRangeDecodeErrorZ represents a success state.
10321 } LDKCResult_ReplyChannelRangeDecodeErrorZ;
10324 * The contents of CResult_GossipTimestampFilterDecodeErrorZ
10326 typedef union LDKCResult_GossipTimestampFilterDecodeErrorZPtr {
10328 * A pointer to the contents in the success state.
10329 * Reading from this pointer when `result_ok` is not set is undefined.
10331 struct LDKGossipTimestampFilter *result;
10333 * A pointer to the contents in the error state.
10334 * Reading from this pointer when `result_ok` is set is undefined.
10336 struct LDKDecodeError *err;
10337 } LDKCResult_GossipTimestampFilterDecodeErrorZPtr;
10340 * A CResult_GossipTimestampFilterDecodeErrorZ represents the result of a fallible operation,
10341 * containing a crate::lightning::ln::msgs::GossipTimestampFilter on success and a crate::lightning::ln::msgs::DecodeError on failure.
10342 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10344 typedef struct LDKCResult_GossipTimestampFilterDecodeErrorZ {
10346 * The contents of this CResult_GossipTimestampFilterDecodeErrorZ, accessible via either
10347 * `err` or `result` depending on the state of `result_ok`.
10349 union LDKCResult_GossipTimestampFilterDecodeErrorZPtr contents;
10351 * Whether this CResult_GossipTimestampFilterDecodeErrorZ represents a success state.
10354 } LDKCResult_GossipTimestampFilterDecodeErrorZ;
10357 * A dynamically-allocated array of crate::lightning::ln::channelmanager::PhantomRouteHintss of arbitrary size.
10358 * This corresponds to std::vector in C++
10360 typedef struct LDKCVec_PhantomRouteHintsZ {
10362 * The elements in the array.
10363 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
10365 struct LDKPhantomRouteHints *data;
10367 * The number of elements pointed to by `data`.
10370 } LDKCVec_PhantomRouteHintsZ;
10373 * When signing using a fallible method either an user-supplied `SignError` or a `CreationError`
10376 typedef enum LDKSignOrCreationError_Tag {
10378 * An error occurred during signing
10380 LDKSignOrCreationError_SignError,
10382 * An error occurred while building the transaction
10384 LDKSignOrCreationError_CreationError,
10386 * Must be last for serialization purposes
10388 LDKSignOrCreationError_Sentinel,
10389 } LDKSignOrCreationError_Tag;
10391 typedef struct MUST_USE_STRUCT LDKSignOrCreationError {
10392 LDKSignOrCreationError_Tag tag;
10395 enum LDKCreationError creation_error;
10398 } LDKSignOrCreationError;
10401 * The contents of CResult_InvoiceSignOrCreationErrorZ
10403 typedef union LDKCResult_InvoiceSignOrCreationErrorZPtr {
10405 * A pointer to the contents in the success state.
10406 * Reading from this pointer when `result_ok` is not set is undefined.
10408 struct LDKInvoice *result;
10410 * A pointer to the contents in the error state.
10411 * Reading from this pointer when `result_ok` is set is undefined.
10413 struct LDKSignOrCreationError *err;
10414 } LDKCResult_InvoiceSignOrCreationErrorZPtr;
10417 * A CResult_InvoiceSignOrCreationErrorZ represents the result of a fallible operation,
10418 * containing a crate::lightning_invoice::Invoice on success and a crate::lightning_invoice::SignOrCreationError on failure.
10419 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10421 typedef struct LDKCResult_InvoiceSignOrCreationErrorZ {
10423 * The contents of this CResult_InvoiceSignOrCreationErrorZ, accessible via either
10424 * `err` or `result` depending on the state of `result_ok`.
10426 union LDKCResult_InvoiceSignOrCreationErrorZPtr contents;
10428 * Whether this CResult_InvoiceSignOrCreationErrorZ represents a success state.
10431 } LDKCResult_InvoiceSignOrCreationErrorZ;
10436 * A transaction output watched by a [`ChannelMonitor`] for spends on-chain.
10438 * Used to convey to a [`Filter`] such an output with a given spending condition. Any transaction
10439 * spending the output must be given to [`ChannelMonitor::block_connected`] either directly or via
10440 * the return value of [`Filter::register_output`].
10442 * If `block_hash` is `Some`, this indicates the output was created in the corresponding block and
10443 * may have been spent there. See [`Filter::register_output`] for details.
10445 * [`ChannelMonitor`]: channelmonitor::ChannelMonitor
10446 * [`ChannelMonitor::block_connected`]: channelmonitor::ChannelMonitor::block_connected
10448 typedef struct MUST_USE_STRUCT LDKWatchedOutput {
10450 * A pointer to the opaque Rust object.
10451 * Nearly everywhere, inner must be non-null, however in places where
10452 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10454 LDKnativeWatchedOutput *inner;
10456 * Indicates that this is the only struct which contains the same pointer.
10457 * Rust functions which take ownership of an object provided via an argument require
10458 * this to be true and invalidate the object pointed to by inner.
10461 } LDKWatchedOutput;
10464 * The `Filter` trait defines behavior for indicating chain activity of interest pertaining to
10467 * This is useful in order to have a [`Watch`] implementation convey to a chain source which
10468 * transactions to be notified of. Notification may take the form of pre-filtering blocks or, in
10469 * the case of [BIP 157]/[BIP 158], only fetching a block if the compact filter matches. If
10470 * receiving full blocks from a chain source, any further filtering is unnecessary.
10472 * After an output has been registered, subsequent block retrievals from the chain source must not
10473 * exclude any transactions matching the new criteria nor any in-block descendants of such
10476 * Note that use as part of a [`Watch`] implementation involves reentrancy. Therefore, the `Filter`
10477 * should not block on I/O. Implementations should instead queue the newly monitored data to be
10478 * processed later. Then, in order to block until the data has been processed, any [`Watch`]
10479 * invocation that has called the `Filter` must return [`TemporaryFailure`].
10481 * [`TemporaryFailure`]: ChannelMonitorUpdateErr::TemporaryFailure
10482 * [BIP 157]: https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki
10483 * [BIP 158]: https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki
10485 typedef struct LDKFilter {
10487 * An opaque pointer which is passed to your function implementations as an argument.
10488 * This has no meaning in the LDK, and can be NULL or any other value.
10492 * Registers interest in a transaction with `txid` and having an output with `script_pubkey` as
10493 * a spending condition.
10495 void (*register_tx)(const void *this_arg, const uint8_t (*txid)[32], struct LDKu8slice script_pubkey);
10497 * Registers interest in spends of a transaction output.
10499 * Optionally, when `output.block_hash` is set, should return any transaction spending the
10500 * output that is found in the corresponding block along with its index.
10502 * This return value is useful for Electrum clients in order to supply in-block descendant
10503 * transactions which otherwise were not included. This is not necessary for other clients if
10504 * such descendant transactions were already included (e.g., when a BIP 157 client provides the
10507 struct LDKCOption_C2Tuple_usizeTransactionZZ (*register_output)(const void *this_arg, struct LDKWatchedOutput output);
10509 * Frees any resources associated with this object given its this_arg pointer.
10510 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
10512 void (*free)(void *this_arg);
10516 * An enum which can either contain a crate::lightning::chain::Filter or not
10518 typedef enum LDKCOption_FilterZ_Tag {
10520 * When we're in this state, this COption_FilterZ contains a crate::lightning::chain::Filter
10522 LDKCOption_FilterZ_Some,
10524 * When we're in this state, this COption_FilterZ contains nothing
10526 LDKCOption_FilterZ_None,
10528 * Must be last for serialization purposes
10530 LDKCOption_FilterZ_Sentinel,
10531 } LDKCOption_FilterZ_Tag;
10533 typedef struct LDKCOption_FilterZ {
10534 LDKCOption_FilterZ_Tag tag;
10537 struct LDKFilter some;
10540 } LDKCOption_FilterZ;
10545 * A read-only reference to a current ChannelMonitor.
10547 * Note that this holds a mutex in [`ChainMonitor`] and may block other events until it is
10550 typedef struct MUST_USE_STRUCT LDKLockedChannelMonitor {
10552 * A pointer to the opaque Rust object.
10553 * Nearly everywhere, inner must be non-null, however in places where
10554 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10556 LDKnativeLockedChannelMonitor *inner;
10558 * Indicates that this is the only struct which contains the same pointer.
10559 * Rust functions which take ownership of an object provided via an argument require
10560 * this to be true and invalidate the object pointed to by inner.
10563 } LDKLockedChannelMonitor;
10566 * The contents of CResult_LockedChannelMonitorNoneZ
10568 typedef union LDKCResult_LockedChannelMonitorNoneZPtr {
10570 * A pointer to the contents in the success state.
10571 * Reading from this pointer when `result_ok` is not set is undefined.
10573 struct LDKLockedChannelMonitor *result;
10575 * Note that this value is always NULL, as there are no contents in the Err variant
10578 } LDKCResult_LockedChannelMonitorNoneZPtr;
10581 * A CResult_LockedChannelMonitorNoneZ represents the result of a fallible operation,
10582 * containing a crate::lightning::chain::chainmonitor::LockedChannelMonitor on success and a () on failure.
10583 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
10585 typedef struct LDKCResult_LockedChannelMonitorNoneZ {
10587 * The contents of this CResult_LockedChannelMonitorNoneZ, accessible via either
10588 * `err` or `result` depending on the state of `result_ok`.
10590 union LDKCResult_LockedChannelMonitorNoneZPtr contents;
10592 * Whether this CResult_LockedChannelMonitorNoneZ represents a success state.
10595 } LDKCResult_LockedChannelMonitorNoneZ;
10598 * A dynamically-allocated array of crate::lightning::chain::transaction::OutPoints of arbitrary size.
10599 * This corresponds to std::vector in C++
10601 typedef struct LDKCVec_OutPointZ {
10603 * The elements in the array.
10604 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
10606 struct LDKOutPoint *data;
10608 * The number of elements pointed to by `data`.
10611 } LDKCVec_OutPointZ;
10614 * A trait indicating an object may generate message send events
10616 typedef struct LDKMessageSendEventsProvider {
10618 * An opaque pointer which is passed to your function implementations as an argument.
10619 * This has no meaning in the LDK, and can be NULL or any other value.
10623 * Gets the list of pending events which were generated by previous actions, clearing the list
10626 struct LDKCVec_MessageSendEventZ (*get_and_clear_pending_msg_events)(const void *this_arg);
10628 * Frees any resources associated with this object given its this_arg pointer.
10629 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
10631 void (*free)(void *this_arg);
10632 } LDKMessageSendEventsProvider;
10635 * A trait implemented for objects handling events from [`EventsProvider`].
10637 typedef struct LDKEventHandler {
10639 * An opaque pointer which is passed to your function implementations as an argument.
10640 * This has no meaning in the LDK, and can be NULL or any other value.
10644 * Handles the given [`Event`].
10646 * See [`EventsProvider`] for details that must be considered when implementing this method.
10648 void (*handle_event)(const void *this_arg, const struct LDKEvent *NONNULL_PTR event);
10650 * Frees any resources associated with this object given its this_arg pointer.
10651 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
10653 void (*free)(void *this_arg);
10657 * A trait indicating an object may generate events.
10659 * Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
10663 * See [`process_pending_events`] for requirements around event processing.
10665 * When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
10666 * event since the last invocation. The handler must either act upon the event immediately
10667 * or preserve it for later handling.
10669 * Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
10670 * consult the provider's documentation on the implication of processing events and how a handler
10671 * may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
10672 * [`ChainMonitor::process_pending_events`]).
10674 * (C-not implementable) As there is likely no reason for a user to implement this trait on their
10677 * [`process_pending_events`]: Self::process_pending_events
10678 * [`handle_event`]: EventHandler::handle_event
10679 * [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
10680 * [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
10682 typedef struct LDKEventsProvider {
10684 * An opaque pointer which is passed to your function implementations as an argument.
10685 * This has no meaning in the LDK, and can be NULL or any other value.
10689 * Processes any events generated since the last call using the given event handler.
10691 * Subsequent calls must only process new events. However, handlers must be capable of handling
10692 * duplicate events across process restarts. This may occur if the provider was recovered from
10693 * an old state (i.e., it hadn't been successfully persisted after processing pending events).
10695 void (*process_pending_events)(const void *this_arg, struct LDKEventHandler handler);
10697 * Frees any resources associated with this object given its this_arg pointer.
10698 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
10700 void (*free)(void *this_arg);
10701 } LDKEventsProvider;
10706 * Configuration we set when applicable.
10708 * Default::default() provides sane defaults.
10710 typedef struct MUST_USE_STRUCT LDKChannelHandshakeConfig {
10712 * A pointer to the opaque Rust object.
10713 * Nearly everywhere, inner must be non-null, however in places where
10714 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10716 LDKnativeChannelHandshakeConfig *inner;
10718 * Indicates that this is the only struct which contains the same pointer.
10719 * Rust functions which take ownership of an object provided via an argument require
10720 * this to be true and invalidate the object pointed to by inner.
10723 } LDKChannelHandshakeConfig;
10728 * Optional channel limits which are applied during channel creation.
10730 * These limits are only applied to our counterparty's limits, not our own.
10732 * Use 0/<type>::max_value() as appropriate to skip checking.
10734 * Provides sane defaults for most configurations.
10736 * Most additional limits are disabled except those with which specify a default in individual
10737 * field documentation. Note that this may result in barely-usable channels, but since they
10738 * are applied mostly only to incoming channels that's not much of a problem.
10740 typedef struct MUST_USE_STRUCT LDKChannelHandshakeLimits {
10742 * A pointer to the opaque Rust object.
10743 * Nearly everywhere, inner must be non-null, however in places where
10744 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10746 LDKnativeChannelHandshakeLimits *inner;
10748 * Indicates that this is the only struct which contains the same pointer.
10749 * Rust functions which take ownership of an object provided via an argument require
10750 * this to be true and invalidate the object pointed to by inner.
10753 } LDKChannelHandshakeLimits;
10758 * Top-level config which holds ChannelHandshakeLimits and ChannelConfig.
10760 * Default::default() provides sane defaults for most configurations
10761 * (but currently with 0 relay fees!)
10763 typedef struct MUST_USE_STRUCT LDKUserConfig {
10765 * A pointer to the opaque Rust object.
10766 * Nearly everywhere, inner must be non-null, however in places where
10767 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10769 LDKnativeUserConfig *inner;
10771 * Indicates that this is the only struct which contains the same pointer.
10772 * Rust functions which take ownership of an object provided via an argument require
10773 * this to be true and invalidate the object pointed to by inner.
10781 * The best known block as identified by its hash and height.
10783 typedef struct MUST_USE_STRUCT LDKBestBlock {
10785 * A pointer to the opaque Rust object.
10786 * Nearly everywhere, inner must be non-null, however in places where
10787 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10789 LDKnativeBestBlock *inner;
10791 * Indicates that this is the only struct which contains the same pointer.
10792 * Rust functions which take ownership of an object provided via an argument require
10793 * this to be true and invalidate the object pointed to by inner.
10799 * The `Listen` trait is used to notify when blocks have been connected or disconnected from the
10802 * Useful when needing to replay chain data upon startup or as new chain events occur. Clients
10803 * sourcing chain data using a block-oriented API should prefer this interface over [`Confirm`].
10804 * Such clients fetch the entire header chain whereas clients using [`Confirm`] only fetch headers
10807 typedef struct LDKListen {
10809 * An opaque pointer which is passed to your function implementations as an argument.
10810 * This has no meaning in the LDK, and can be NULL or any other value.
10814 * Notifies the listener that a block was added at the given height.
10816 void (*block_connected)(const void *this_arg, struct LDKu8slice block, uint32_t height);
10818 * Notifies the listener that a block was removed at the given height.
10820 void (*block_disconnected)(const void *this_arg, const uint8_t (*header)[80], uint32_t height);
10822 * Frees any resources associated with this object given its this_arg pointer.
10823 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
10825 void (*free)(void *this_arg);
10829 * The `Confirm` trait is used to notify when transactions have been confirmed on chain or
10830 * unconfirmed during a chain reorganization.
10832 * Clients sourcing chain data using a transaction-oriented API should prefer this interface over
10833 * [`Listen`]. For instance, an Electrum client may implement [`Filter`] by subscribing to activity
10834 * related to registered transactions and outputs. Upon notification, it would pass along the
10835 * matching transactions using this interface.
10839 * The intended use is as follows:
10840 * - Call [`transactions_confirmed`] to process any on-chain activity of interest.
10841 * - Call [`transaction_unconfirmed`] to process any transaction returned by [`get_relevant_txids`]
10842 * that has been reorganized out of the chain.
10843 * - Call [`best_block_updated`] whenever a new chain tip becomes available.
10847 * Clients must call these methods in chain order. Specifically:
10848 * - Transactions confirmed in a block must be given before transactions confirmed in a later
10850 * - Dependent transactions within the same block must be given in topological order, possibly in
10852 * - Unconfirmed transactions must be given after the original confirmations and before any
10855 * See individual method documentation for further details.
10857 * [`transactions_confirmed`]: Self::transactions_confirmed
10858 * [`transaction_unconfirmed`]: Self::transaction_unconfirmed
10859 * [`best_block_updated`]: Self::best_block_updated
10860 * [`get_relevant_txids`]: Self::get_relevant_txids
10862 typedef struct LDKConfirm {
10864 * An opaque pointer which is passed to your function implementations as an argument.
10865 * This has no meaning in the LDK, and can be NULL or any other value.
10869 * Processes transactions confirmed in a block with a given header and height.
10871 * Should be called for any transactions registered by [`Filter::register_tx`] or any
10872 * transactions spending an output registered by [`Filter::register_output`]. Such transactions
10873 * appearing in the same block do not need to be included in the same call; instead, multiple
10874 * calls with additional transactions may be made so long as they are made in [chain order].
10876 * May be called before or after [`best_block_updated`] for the corresponding block. However,
10877 * in the event of a chain reorganization, it must not be called with a `header` that is no
10878 * longer in the chain as of the last call to [`best_block_updated`].
10880 * [chain order]: Confirm#Order
10881 * [`best_block_updated`]: Self::best_block_updated
10883 void (*transactions_confirmed)(const void *this_arg, const uint8_t (*header)[80], struct LDKCVec_C2Tuple_usizeTransactionZZ txdata, uint32_t height);
10885 * Processes a transaction that is no longer confirmed as result of a chain reorganization.
10887 * Should be called for any transaction returned by [`get_relevant_txids`] if it has been
10888 * reorganized out of the best chain. Once called, the given transaction should not be returned
10889 * by [`get_relevant_txids`] unless it has been reconfirmed via [`transactions_confirmed`].
10891 * [`get_relevant_txids`]: Self::get_relevant_txids
10892 * [`transactions_confirmed`]: Self::transactions_confirmed
10894 void (*transaction_unconfirmed)(const void *this_arg, const uint8_t (*txid)[32]);
10896 * Processes an update to the best header connected at the given height.
10898 * Should be called when a new header is available but may be skipped for intermediary blocks
10899 * if they become available at the same time.
10901 void (*best_block_updated)(const void *this_arg, const uint8_t (*header)[80], uint32_t height);
10903 * Returns transactions that should be monitored for reorganization out of the chain.
10905 * Should include any transactions passed to [`transactions_confirmed`] that have insufficient
10906 * confirmations to be safe from a chain reorganization. Should not include any transactions
10907 * passed to [`transaction_unconfirmed`] unless later reconfirmed.
10909 * May be called to determine the subset of transactions that must still be monitored for
10910 * reorganization. Will be idempotent between calls but may change as a result of calls to the
10911 * other interface methods. Thus, this is useful to determine which transactions may need to be
10912 * given to [`transaction_unconfirmed`].
10914 * [`transactions_confirmed`]: Self::transactions_confirmed
10915 * [`transaction_unconfirmed`]: Self::transaction_unconfirmed
10917 struct LDKCVec_TxidZ (*get_relevant_txids)(const void *this_arg);
10919 * Frees any resources associated with this object given its this_arg pointer.
10920 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
10922 void (*free)(void *this_arg);
10928 * An opaque identifier describing a specific [`Persist`] method call.
10930 typedef struct MUST_USE_STRUCT LDKMonitorUpdateId {
10932 * A pointer to the opaque Rust object.
10933 * Nearly everywhere, inner must be non-null, however in places where
10934 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10936 LDKnativeMonitorUpdateId *inner;
10938 * Indicates that this is the only struct which contains the same pointer.
10939 * Rust functions which take ownership of an object provided via an argument require
10940 * this to be true and invalidate the object pointed to by inner.
10943 } LDKMonitorUpdateId;
10946 * `Persist` defines behavior for persisting channel monitors: this could mean
10947 * writing once to disk, and/or uploading to one or more backup services.
10949 * Each method can return three possible values:
10950 * * If persistence (including any relevant `fsync()` calls) happens immediately, the
10951 * implementation should return `Ok(())`, indicating normal channel operation should continue.
10952 * * If persistence happens asynchronously, implementations should first ensure the
10953 * [`ChannelMonitor`] or [`ChannelMonitorUpdate`] are written durably to disk, and then return
10954 * `Err(ChannelMonitorUpdateErr::TemporaryFailure)` while the update continues in the
10955 * background. Once the update completes, [`ChainMonitor::channel_monitor_updated`] should be
10956 * called with the corresponding [`MonitorUpdateId`].
10958 * Note that unlike the direct [`chain::Watch`] interface,
10959 * [`ChainMonitor::channel_monitor_updated`] must be called once for *each* update which occurs.
10961 * * If persistence fails for some reason, implementations should return
10962 * `Err(ChannelMonitorUpdateErr::PermanentFailure)`, in which case the channel will likely be
10963 * closed without broadcasting the latest state. See
10964 * [`ChannelMonitorUpdateErr::PermanentFailure`] for more details.
10966 typedef struct LDKPersist {
10968 * An opaque pointer which is passed to your function implementations as an argument.
10969 * This has no meaning in the LDK, and can be NULL or any other value.
10973 * Persist a new channel's data in response to a [`chain::Watch::watch_channel`] call. This is
10974 * called by [`ChannelManager`] for new channels, or may be called directly, e.g. on startup.
10976 * The data can be stored any way you want, but the identifier provided by LDK is the
10977 * channel's outpoint (and it is up to you to maintain a correct mapping between the outpoint
10978 * and the stored channel data). Note that you **must** persist every new monitor to disk.
10980 * The `update_id` is used to identify this call to [`ChainMonitor::channel_monitor_updated`],
10981 * if you return [`ChannelMonitorUpdateErr::TemporaryFailure`].
10983 * See [`Writeable::write`] on [`ChannelMonitor`] for writing out a `ChannelMonitor`
10984 * and [`ChannelMonitorUpdateErr`] for requirements when returning errors.
10986 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
10987 * [`Writeable::write`]: crate::util::ser::Writeable::write
10989 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*persist_new_channel)(const void *this_arg, struct LDKOutPoint channel_id, const struct LDKChannelMonitor *NONNULL_PTR data, struct LDKMonitorUpdateId update_id);
10991 * Update one channel's data. The provided [`ChannelMonitor`] has already applied the given
10994 * Note that on every update, you **must** persist either the [`ChannelMonitorUpdate`] or the
10995 * updated monitor itself to disk/backups. See the [`Persist`] trait documentation for more
10998 * During blockchain synchronization operations, this may be called with no
10999 * [`ChannelMonitorUpdate`], in which case the full [`ChannelMonitor`] needs to be persisted.
11000 * Note that after the full [`ChannelMonitor`] is persisted any previous
11001 * [`ChannelMonitorUpdate`]s which were persisted should be discarded - they can no longer be
11002 * applied to the persisted [`ChannelMonitor`] as they were already applied.
11004 * If an implementer chooses to persist the updates only, they need to make
11005 * sure that all the updates are applied to the `ChannelMonitors` *before*
11006 * the set of channel monitors is given to the `ChannelManager`
11007 * deserialization routine. See [`ChannelMonitor::update_monitor`] for
11008 * applying a monitor update to a monitor. If full `ChannelMonitors` are
11009 * persisted, then there is no need to persist individual updates.
11011 * Note that there could be a performance tradeoff between persisting complete
11012 * channel monitors on every update vs. persisting only updates and applying
11013 * them in batches. The size of each monitor grows `O(number of state updates)`
11014 * whereas updates are small and `O(1)`.
11016 * The `update_id` is used to identify this call to [`ChainMonitor::channel_monitor_updated`],
11017 * if you return [`ChannelMonitorUpdateErr::TemporaryFailure`].
11019 * See [`Writeable::write`] on [`ChannelMonitor`] for writing out a `ChannelMonitor`,
11020 * [`Writeable::write`] on [`ChannelMonitorUpdate`] for writing out an update, and
11021 * [`ChannelMonitorUpdateErr`] for requirements when returning errors.
11023 * [`Writeable::write`]: crate::util::ser::Writeable::write
11025 * Note that update (or a relevant inner pointer) may be NULL or all-0s to represent None
11027 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);
11029 * Frees any resources associated with this object given its this_arg pointer.
11030 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
11032 void (*free)(void *this_arg);
11038 * An implementation of [`chain::Watch`] for monitoring channels.
11040 * Connected and disconnected blocks must be provided to `ChainMonitor` as documented by
11041 * [`chain::Watch`]. May be used in conjunction with [`ChannelManager`] to monitor channels locally
11042 * or used independently to monitor channels remotely. See the [module-level documentation] for
11045 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
11046 * [module-level documentation]: crate::chain::chainmonitor
11048 typedef struct MUST_USE_STRUCT LDKChainMonitor {
11050 * A pointer to the opaque Rust object.
11051 * Nearly everywhere, inner must be non-null, however in places where
11052 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11054 LDKnativeChainMonitor *inner;
11056 * Indicates that this is the only struct which contains the same pointer.
11057 * Rust functions which take ownership of an object provided via an argument require
11058 * this to be true and invalidate the object pointed to by inner.
11066 * Simple KeysInterface implementor that takes a 32-byte seed for use as a BIP 32 extended key
11067 * and derives keys from that.
11069 * Your node_id is seed/0'
11070 * ChannelMonitor closes may use seed/1'
11071 * Cooperative closes may use seed/2'
11072 * The two close keys may be needed to claim on-chain funds!
11074 * This struct cannot be used for nodes that wish to support receiving phantom payments;
11075 * [`PhantomKeysManager`] must be used instead.
11077 * Note that switching between this struct and [`PhantomKeysManager`] will invalidate any
11078 * previously issued invoices and attempts to pay previous invoices will fail.
11080 typedef struct MUST_USE_STRUCT LDKKeysManager {
11082 * A pointer to the opaque Rust object.
11083 * Nearly everywhere, inner must be non-null, however in places where
11084 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11086 LDKnativeKeysManager *inner;
11088 * Indicates that this is the only struct which contains the same pointer.
11089 * Rust functions which take ownership of an object provided via an argument require
11090 * this to be true and invalidate the object pointed to by inner.
11098 * Similar to [`KeysManager`], but allows the node using this struct to receive phantom node
11101 * A phantom node payment is a payment made to a phantom invoice, which is an invoice that can be
11102 * paid to one of multiple nodes. This works because we encode the invoice route hints such that
11103 * LDK will recognize an incoming payment as destined for a phantom node, and collect the payment
11104 * itself without ever needing to forward to this fake node.
11106 * Phantom node payments are useful for load balancing between multiple LDK nodes. They also
11107 * provide some fault tolerance, because payers will automatically retry paying other provided
11108 * nodes in the case that one node goes down.
11110 * Note that multi-path payments are not supported in phantom invoices for security reasons.
11111 * Switching between this struct and [`KeysManager`] will invalidate any previously issued
11112 * invoices and attempts to pay previous invoices will fail.
11114 typedef struct MUST_USE_STRUCT LDKPhantomKeysManager {
11116 * A pointer to the opaque Rust object.
11117 * Nearly everywhere, inner must be non-null, however in places where
11118 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11120 LDKnativePhantomKeysManager *inner;
11122 * Indicates that this is the only struct which contains the same pointer.
11123 * Rust functions which take ownership of an object provided via an argument require
11124 * this to be true and invalidate the object pointed to by inner.
11127 } LDKPhantomKeysManager;
11132 * Chain-related parameters used to construct a new `ChannelManager`.
11134 * Typically, the block-specific parameters are derived from the best block hash for the network,
11135 * as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
11136 * are not needed when deserializing a previously constructed `ChannelManager`.
11138 typedef struct MUST_USE_STRUCT LDKChainParameters {
11140 * A pointer to the opaque Rust object.
11141 * Nearly everywhere, inner must be non-null, however in places where
11142 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11144 LDKnativeChainParameters *inner;
11146 * Indicates that this is the only struct which contains the same pointer.
11147 * Rust functions which take ownership of an object provided via an argument require
11148 * this to be true and invalidate the object pointed to by inner.
11151 } LDKChainParameters;
11154 * A 3-byte byte array.
11156 typedef struct LDKThreeBytes {
11164 * A trait to describe an object which can receive channel messages.
11166 * Messages MAY be called in parallel when they originate from different their_node_ids, however
11167 * they MUST NOT be called in parallel when the two calls have the same their_node_id.
11169 typedef struct LDKChannelMessageHandler {
11171 * An opaque pointer which is passed to your function implementations as an argument.
11172 * This has no meaning in the LDK, and can be NULL or any other value.
11176 * Handle an incoming open_channel message from the given peer.
11178 void (*handle_open_channel)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKInitFeatures their_features, const struct LDKOpenChannel *NONNULL_PTR msg);
11180 * Handle an incoming accept_channel message from the given peer.
11182 void (*handle_accept_channel)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKInitFeatures their_features, const struct LDKAcceptChannel *NONNULL_PTR msg);
11184 * Handle an incoming funding_created message from the given peer.
11186 void (*handle_funding_created)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingCreated *NONNULL_PTR msg);
11188 * Handle an incoming funding_signed message from the given peer.
11190 void (*handle_funding_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingSigned *NONNULL_PTR msg);
11192 * Handle an incoming funding_locked message from the given peer.
11194 void (*handle_funding_locked)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingLocked *NONNULL_PTR msg);
11196 * Handle an incoming shutdown message from the given peer.
11198 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);
11200 * Handle an incoming closing_signed message from the given peer.
11202 void (*handle_closing_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKClosingSigned *NONNULL_PTR msg);
11204 * Handle an incoming update_add_htlc message from the given peer.
11206 void (*handle_update_add_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateAddHTLC *NONNULL_PTR msg);
11208 * Handle an incoming update_fulfill_htlc message from the given peer.
11210 void (*handle_update_fulfill_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFulfillHTLC *NONNULL_PTR msg);
11212 * Handle an incoming update_fail_htlc message from the given peer.
11214 void (*handle_update_fail_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFailHTLC *NONNULL_PTR msg);
11216 * Handle an incoming update_fail_malformed_htlc message from the given peer.
11218 void (*handle_update_fail_malformed_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR msg);
11220 * Handle an incoming commitment_signed message from the given peer.
11222 void (*handle_commitment_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKCommitmentSigned *NONNULL_PTR msg);
11224 * Handle an incoming revoke_and_ack message from the given peer.
11226 void (*handle_revoke_and_ack)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKRevokeAndACK *NONNULL_PTR msg);
11228 * Handle an incoming update_fee message from the given peer.
11230 void (*handle_update_fee)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFee *NONNULL_PTR msg);
11232 * Handle an incoming announcement_signatures message from the given peer.
11234 void (*handle_announcement_signatures)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKAnnouncementSignatures *NONNULL_PTR msg);
11236 * Indicates a connection to the peer failed/an existing connection was lost. If no connection
11237 * is believed to be possible in the future (eg they're sending us messages we don't
11238 * understand or indicate they require unknown feature bits), no_connection_possible is set
11239 * and any outstanding channels should be failed.
11241 void (*peer_disconnected)(const void *this_arg, struct LDKPublicKey their_node_id, bool no_connection_possible);
11243 * Handle a peer reconnecting, possibly generating channel_reestablish message(s).
11245 void (*peer_connected)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKInit *NONNULL_PTR msg);
11247 * Handle an incoming channel_reestablish message from the given peer.
11249 void (*handle_channel_reestablish)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKChannelReestablish *NONNULL_PTR msg);
11251 * Handle an incoming channel update from the given peer.
11253 void (*handle_channel_update)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKChannelUpdate *NONNULL_PTR msg);
11255 * Handle an incoming error message from the given peer.
11257 void (*handle_error)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKErrorMessage *NONNULL_PTR msg);
11259 * Implementation of MessageSendEventsProvider for this object.
11261 struct LDKMessageSendEventsProvider MessageSendEventsProvider;
11263 * Frees any resources associated with this object given its this_arg pointer.
11264 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
11266 void (*free)(void *this_arg);
11267 } LDKChannelMessageHandler;
11272 * Arguments for the creation of a ChannelManager that are not deserialized.
11274 * At a high-level, the process for deserializing a ChannelManager and resuming normal operation
11276 * 1) Deserialize all stored [`ChannelMonitor`]s.
11277 * 2) Deserialize the [`ChannelManager`] by filling in this struct and calling:
11278 * `<(BlockHash, ChannelManager)>::read(reader, args)`
11279 * This may result in closing some channels if the [`ChannelMonitor`] is newer than the stored
11280 * [`ChannelManager`] state to ensure no loss of funds. Thus, transactions may be broadcasted.
11281 * 3) If you are not fetching full blocks, register all relevant [`ChannelMonitor`] outpoints the
11282 * same way you would handle a [`chain::Filter`] call using
11283 * [`ChannelMonitor::get_outputs_to_watch`] and [`ChannelMonitor::get_funding_txo`].
11284 * 4) Reconnect blocks on your [`ChannelMonitor`]s.
11285 * 5) Disconnect/connect blocks on the [`ChannelManager`].
11286 * 6) Re-persist the [`ChannelMonitor`]s to ensure the latest state is on disk.
11287 * Note that if you're using a [`ChainMonitor`] for your [`chain::Watch`] implementation, you
11288 * will likely accomplish this as a side-effect of calling [`chain::Watch::watch_channel`] in
11290 * 7) Move the [`ChannelMonitor`]s into your local [`chain::Watch`]. If you're using a
11291 * [`ChainMonitor`], this is done by calling [`chain::Watch::watch_channel`].
11293 * Note that the ordering of #4-7 is not of importance, however all four must occur before you
11294 * call any other methods on the newly-deserialized [`ChannelManager`].
11296 * Note that because some channels may be closed during deserialization, it is critical that you
11297 * always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
11298 * you. If you deserialize an old ChannelManager (during which force-closure transactions may be
11299 * broadcast), and then later deserialize a newer version of the same ChannelManager (which will
11300 * not force-close the same channels but consider them live), you may end up revoking a state for
11301 * which you've already broadcasted the transaction.
11303 * [`ChainMonitor`]: crate::chain::chainmonitor::ChainMonitor
11305 typedef struct MUST_USE_STRUCT LDKChannelManagerReadArgs {
11307 * A pointer to the opaque Rust object.
11308 * Nearly everywhere, inner must be non-null, however in places where
11309 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11311 LDKnativeChannelManagerReadArgs *inner;
11313 * Indicates that this is the only struct which contains the same pointer.
11314 * Rust functions which take ownership of an object provided via an argument require
11315 * this to be true and invalidate the object pointed to by inner.
11318 } LDKChannelManagerReadArgs;
11323 * Proof that the sender knows the per-commitment secret of the previous commitment transaction.
11324 * This is used to convince the recipient that the channel is at a certain commitment
11325 * number even if they lost that data due to a local failure. Of course, the peer may lie
11326 * and even later commitments may have been revoked.
11328 typedef struct MUST_USE_STRUCT LDKDataLossProtect {
11330 * A pointer to the opaque Rust object.
11331 * Nearly everywhere, inner must be non-null, however in places where
11332 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11334 LDKnativeDataLossProtect *inner;
11336 * Indicates that this is the only struct which contains the same pointer.
11337 * Rust functions which take ownership of an object provided via an argument require
11338 * this to be true and invalidate the object pointed to by inner.
11341 } LDKDataLossProtect;
11344 * A trait to describe an object which can receive routing messages.
11346 * # Implementor DoS Warnings
11348 * For `gossip_queries` messages there are potential DoS vectors when handling
11349 * inbound queries. Implementors using an on-disk network graph should be aware of
11350 * repeated disk I/O for queries accessing different parts of the network graph.
11352 typedef struct LDKRoutingMessageHandler {
11354 * An opaque pointer which is passed to your function implementations as an argument.
11355 * This has no meaning in the LDK, and can be NULL or any other value.
11359 * Handle an incoming node_announcement message, returning true if it should be forwarded on,
11360 * false or returning an Err otherwise.
11362 struct LDKCResult_boolLightningErrorZ (*handle_node_announcement)(const void *this_arg, const struct LDKNodeAnnouncement *NONNULL_PTR msg);
11364 * Handle a channel_announcement message, returning true if it should be forwarded on, false
11365 * or returning an Err otherwise.
11367 struct LDKCResult_boolLightningErrorZ (*handle_channel_announcement)(const void *this_arg, const struct LDKChannelAnnouncement *NONNULL_PTR msg);
11369 * Handle an incoming channel_update message, returning true if it should be forwarded on,
11370 * false or returning an Err otherwise.
11372 struct LDKCResult_boolLightningErrorZ (*handle_channel_update)(const void *this_arg, const struct LDKChannelUpdate *NONNULL_PTR msg);
11374 * Gets a subset of the channel announcements and updates required to dump our routing table
11375 * to a remote node, starting at the short_channel_id indicated by starting_point and
11376 * including the batch_amount entries immediately higher in numerical value than starting_point.
11378 struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ (*get_next_channel_announcements)(const void *this_arg, uint64_t starting_point, uint8_t batch_amount);
11380 * Gets a subset of the node announcements required to dump our routing table to a remote node,
11381 * starting at the node *after* the provided publickey and including batch_amount entries
11382 * immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
11383 * If None is provided for starting_point, we start at the first node.
11385 * Note that starting_point (or a relevant inner pointer) may be NULL or all-0s to represent None
11387 struct LDKCVec_NodeAnnouncementZ (*get_next_node_announcements)(const void *this_arg, struct LDKPublicKey starting_point, uint8_t batch_amount);
11389 * Called when a connection is established with a peer. This can be used to
11390 * perform routing table synchronization using a strategy defined by the
11393 void (*peer_connected)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKInit *NONNULL_PTR init);
11395 * Handles the reply of a query we initiated to learn about channels
11396 * for a given range of blocks. We can expect to receive one or more
11397 * replies to a single query.
11399 struct LDKCResult_NoneLightningErrorZ (*handle_reply_channel_range)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKReplyChannelRange msg);
11401 * Handles the reply of a query we initiated asking for routing gossip
11402 * messages for a list of channels. We should receive this message when
11403 * a node has completed its best effort to send us the pertaining routing
11406 struct LDKCResult_NoneLightningErrorZ (*handle_reply_short_channel_ids_end)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKReplyShortChannelIdsEnd msg);
11408 * Handles when a peer asks us to send a list of short_channel_ids
11409 * for the requested range of blocks.
11411 struct LDKCResult_NoneLightningErrorZ (*handle_query_channel_range)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKQueryChannelRange msg);
11413 * Handles when a peer asks us to send routing gossip messages for a
11414 * list of short_channel_ids.
11416 struct LDKCResult_NoneLightningErrorZ (*handle_query_short_channel_ids)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKQueryShortChannelIds msg);
11418 * Implementation of MessageSendEventsProvider for this object.
11420 struct LDKMessageSendEventsProvider MessageSendEventsProvider;
11422 * Frees any resources associated with this object given its this_arg pointer.
11423 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
11425 void (*free)(void *this_arg);
11426 } LDKRoutingMessageHandler;
11429 * Trait to be implemented by custom message (unrelated to the channel/gossip LN layers)
11432 typedef struct LDKCustomMessageReader {
11434 * An opaque pointer which is passed to your function implementations as an argument.
11435 * This has no meaning in the LDK, and can be NULL or any other value.
11439 * Decodes a custom message to `CustomMessageType`. If the given message type is known to the
11440 * implementation and the message could be decoded, must return `Ok(Some(message))`. If the
11441 * message type is unknown to the implementation, must return `Ok(None)`. If a decoding error
11442 * occur, must return `Err(DecodeError::X)` where `X` details the encountered error.
11444 struct LDKCResult_COption_TypeZDecodeErrorZ (*read)(const void *this_arg, uint16_t message_type, struct LDKu8slice buffer);
11446 * Frees any resources associated with this object given its this_arg pointer.
11447 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
11449 void (*free)(void *this_arg);
11450 } LDKCustomMessageReader;
11453 * Handler for BOLT1-compliant messages.
11455 typedef struct LDKCustomMessageHandler {
11457 * An opaque pointer which is passed to your function implementations as an argument.
11458 * This has no meaning in the LDK, and can be NULL or any other value.
11462 * Called with the message type that was received and the buffer to be read.
11463 * Can return a `MessageHandlingError` if the message could not be handled.
11465 struct LDKCResult_NoneLightningErrorZ (*handle_custom_message)(const void *this_arg, struct LDKType msg, struct LDKPublicKey sender_node_id);
11467 * Gets the list of pending messages which were generated by the custom message
11468 * handler, clearing the list in the process. The first tuple element must
11469 * correspond to the intended recipients node ids. If no connection to one of the
11470 * specified node does not exist, the message is simply not sent to it.
11472 struct LDKCVec_C2Tuple_PublicKeyTypeZZ (*get_and_clear_pending_msg)(const void *this_arg);
11474 * Implementation of CustomMessageReader for this object.
11476 struct LDKCustomMessageReader CustomMessageReader;
11478 * Frees any resources associated with this object given its this_arg pointer.
11479 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
11481 void (*free)(void *this_arg);
11482 } LDKCustomMessageHandler;
11487 * A dummy struct which implements `RoutingMessageHandler` without storing any routing information
11488 * or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
11490 typedef struct MUST_USE_STRUCT LDKIgnoringMessageHandler {
11492 * A pointer to the opaque Rust object.
11493 * Nearly everywhere, inner must be non-null, however in places where
11494 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11496 LDKnativeIgnoringMessageHandler *inner;
11498 * Indicates that this is the only struct which contains the same pointer.
11499 * Rust functions which take ownership of an object provided via an argument require
11500 * this to be true and invalidate the object pointed to by inner.
11503 } LDKIgnoringMessageHandler;
11508 * A dummy struct which implements `ChannelMessageHandler` without having any channels.
11509 * You can provide one of these as the route_handler in a MessageHandler.
11511 typedef struct MUST_USE_STRUCT LDKErroringMessageHandler {
11513 * A pointer to the opaque Rust object.
11514 * Nearly everywhere, inner must be non-null, however in places where
11515 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11517 LDKnativeErroringMessageHandler *inner;
11519 * Indicates that this is the only struct which contains the same pointer.
11520 * Rust functions which take ownership of an object provided via an argument require
11521 * this to be true and invalidate the object pointed to by inner.
11524 } LDKErroringMessageHandler;
11529 * Provides references to trait impls which handle different types of messages.
11531 typedef struct MUST_USE_STRUCT LDKMessageHandler {
11533 * A pointer to the opaque Rust object.
11534 * Nearly everywhere, inner must be non-null, however in places where
11535 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11537 LDKnativeMessageHandler *inner;
11539 * Indicates that this is the only struct which contains the same pointer.
11540 * Rust functions which take ownership of an object provided via an argument require
11541 * this to be true and invalidate the object pointed to by inner.
11544 } LDKMessageHandler;
11547 * Provides an object which can be used to send data to and which uniquely identifies a connection
11548 * to a remote host. You will need to be able to generate multiple of these which meet Eq and
11549 * implement Hash to meet the PeerManager API.
11551 * For efficiency, Clone should be relatively cheap for this type.
11553 * Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
11554 * has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
11555 * having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
11556 * further calls to the [`PeerManager`] related to the original socket occur. This allows you to
11557 * use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
11558 * to simply use another value which is guaranteed to be globally unique instead.
11560 typedef struct LDKSocketDescriptor {
11562 * An opaque pointer which is passed to your function implementations as an argument.
11563 * This has no meaning in the LDK, and can be NULL or any other value.
11567 * Attempts to send some data from the given slice to the peer.
11569 * Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
11570 * Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
11571 * called and further write attempts may occur until that time.
11573 * If the returned size is smaller than `data.len()`, a
11574 * [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
11575 * written. Additionally, until a `send_data` event completes fully, no further
11576 * [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
11577 * prevent denial-of-service issues, you should not read or buffer any data from the socket
11580 * If a [`PeerManager::read_event`] call on this descriptor had previously returned true
11581 * (indicating that read events should be paused to prevent DoS in the send buffer),
11582 * `resume_read` may be set indicating that read events on this descriptor should resume. A
11583 * `resume_read` of false carries no meaning, and should not cause any action.
11585 uintptr_t (*send_data)(void *this_arg, struct LDKu8slice data, bool resume_read);
11587 * Disconnect the socket pointed to by this SocketDescriptor.
11589 * You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
11590 * call (doing so is a noop).
11592 void (*disconnect_socket)(void *this_arg);
11594 * Checks if two objects are equal given this object's this_arg pointer and another object.
11596 bool (*eq)(const void *this_arg, const struct LDKSocketDescriptor *NONNULL_PTR other_arg);
11598 * Calculate a succinct non-cryptographic hash for an object given its this_arg pointer.
11599 * This is used, for example, for inclusion of this object in a hash map.
11601 uint64_t (*hash)(const void *this_arg);
11603 * Called, if set, after this SocketDescriptor has been cloned into a duplicate object.
11604 * The new SocketDescriptor is provided, and should be mutated as needed to perform a
11605 * deep copy of the object pointed to by this_arg or avoid any double-freeing.
11607 void (*cloned)(struct LDKSocketDescriptor *NONNULL_PTR new_SocketDescriptor);
11609 * Frees any resources associated with this object given its this_arg pointer.
11610 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
11612 void (*free)(void *this_arg);
11613 } LDKSocketDescriptor;
11618 * A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
11619 * socket events into messages which it passes on to its [`MessageHandler`].
11621 * Locks are taken internally, so you must never assume that reentrancy from a
11622 * [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
11624 * Calls to [`read_event`] will decode relevant messages and pass them to the
11625 * [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
11626 * parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
11627 * [`PeerManager`] functions related to the same connection must occur only in serial, making new
11628 * calls only after previous ones have returned.
11630 * Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
11631 * a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
11632 * essentially you should default to using a SimpleRefPeerManager, and use a
11633 * SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
11634 * you're using lightning-net-tokio.
11636 * [`read_event`]: PeerManager::read_event
11638 typedef struct MUST_USE_STRUCT LDKPeerManager {
11640 * A pointer to the opaque Rust object.
11641 * Nearly everywhere, inner must be non-null, however in places where
11642 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11644 LDKnativePeerManager *inner;
11646 * Indicates that this is the only struct which contains the same pointer.
11647 * Rust functions which take ownership of an object provided via an argument require
11648 * this to be true and invalidate the object pointed to by inner.
11656 * Static channel fields used to build transactions given per-commitment fields, organized by
11657 * broadcaster/countersignatory.
11659 * This is derived from the holder/counterparty-organized ChannelTransactionParameters via the
11660 * as_holder_broadcastable and as_counterparty_broadcastable functions.
11662 typedef struct MUST_USE_STRUCT LDKDirectedChannelTransactionParameters {
11664 * A pointer to the opaque Rust object.
11665 * Nearly everywhere, inner must be non-null, however in places where
11666 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11668 LDKnativeDirectedChannelTransactionParameters *inner;
11670 * Indicates that this is the only struct which contains the same pointer.
11671 * Rust functions which take ownership of an object provided via an argument require
11672 * this to be true and invalidate the object pointed to by inner.
11675 } LDKDirectedChannelTransactionParameters;
11680 * A read-only view of [`NetworkGraph`].
11682 typedef struct MUST_USE_STRUCT LDKReadOnlyNetworkGraph {
11684 * A pointer to the opaque Rust object.
11685 * Nearly everywhere, inner must be non-null, however in places where
11686 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11688 LDKnativeReadOnlyNetworkGraph *inner;
11690 * Indicates that this is the only struct which contains the same pointer.
11691 * Rust functions which take ownership of an object provided via an argument require
11692 * this to be true and invalidate the object pointed to by inner.
11695 } LDKReadOnlyNetworkGraph;
11700 * Receives and validates network updates from peers,
11701 * stores authentic and relevant data as a network graph.
11702 * This network graph is then used for routing payments.
11703 * Provides interface to help with initial routing sync by
11704 * serving historical announcements.
11706 * Serves as an [`EventHandler`] for applying updates from [`Event::PaymentPathFailed`] to the
11707 * [`NetworkGraph`].
11709 typedef struct MUST_USE_STRUCT LDKNetGraphMsgHandler {
11711 * A pointer to the opaque Rust object.
11712 * Nearly everywhere, inner must be non-null, however in places where
11713 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11715 LDKnativeNetGraphMsgHandler *inner;
11717 * Indicates that this is the only struct which contains the same pointer.
11718 * Rust functions which take ownership of an object provided via an argument require
11719 * this to be true and invalidate the object pointed to by inner.
11722 } LDKNetGraphMsgHandler;
11727 * A wrapper around [`ChannelInfo`] representing information about the channel as directed from a
11728 * source node to a target node.
11730 typedef struct MUST_USE_STRUCT LDKDirectedChannelInfo {
11732 * A pointer to the opaque Rust object.
11733 * Nearly everywhere, inner must be non-null, however in places where
11734 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11736 LDKnativeDirectedChannelInfo *inner;
11738 * Indicates that this is the only struct which contains the same pointer.
11739 * Rust functions which take ownership of an object provided via an argument require
11740 * this to be true and invalidate the object pointed to by inner.
11743 } LDKDirectedChannelInfo;
11746 * The effective capacity of a channel for routing purposes.
11748 * While this may be smaller than the actual channel capacity, amounts greater than
11749 * [`Self::as_msat`] should not be routed through the channel.
11751 typedef enum LDKEffectiveCapacity_Tag {
11753 * The available liquidity in the channel known from being a channel counterparty, and thus a
11756 LDKEffectiveCapacity_ExactLiquidity,
11758 * The maximum HTLC amount in one direction as advertised on the gossip network.
11760 LDKEffectiveCapacity_MaximumHTLC,
11762 * The total capacity of the channel as determined by the funding transaction.
11764 LDKEffectiveCapacity_Total,
11766 * A capacity sufficient to route any payment, typically used for private channels provided by
11769 LDKEffectiveCapacity_Infinite,
11771 * A capacity that is unknown possibly because either the chain state is unavailable to know
11772 * the total capacity or the `htlc_maximum_msat` was not advertised on the gossip network.
11774 LDKEffectiveCapacity_Unknown,
11776 * Must be last for serialization purposes
11778 LDKEffectiveCapacity_Sentinel,
11779 } LDKEffectiveCapacity_Tag;
11781 typedef struct LDKEffectiveCapacity_LDKExactLiquidity_Body {
11783 * Either the inbound or outbound liquidity depending on the direction, denominated in
11786 uint64_t liquidity_msat;
11787 } LDKEffectiveCapacity_LDKExactLiquidity_Body;
11789 typedef struct LDKEffectiveCapacity_LDKMaximumHTLC_Body {
11791 * The maximum HTLC amount denominated in millisatoshi.
11793 uint64_t amount_msat;
11794 } LDKEffectiveCapacity_LDKMaximumHTLC_Body;
11796 typedef struct LDKEffectiveCapacity_LDKTotal_Body {
11798 * The funding amount denominated in millisatoshi.
11800 uint64_t capacity_msat;
11801 } LDKEffectiveCapacity_LDKTotal_Body;
11803 typedef struct MUST_USE_STRUCT LDKEffectiveCapacity {
11804 LDKEffectiveCapacity_Tag tag;
11806 LDKEffectiveCapacity_LDKExactLiquidity_Body exact_liquidity;
11807 LDKEffectiveCapacity_LDKMaximumHTLC_Body maximum_htlc;
11808 LDKEffectiveCapacity_LDKTotal_Body total;
11810 } LDKEffectiveCapacity;
11813 * An interface used to score payment channels for path finding.
11815 *\tScoring is in terms of fees willing to be paid in order to avoid routing through a channel.
11817 typedef struct LDKScore {
11819 * An opaque pointer which is passed to your function implementations as an argument.
11820 * This has no meaning in the LDK, and can be NULL or any other value.
11824 * Returns the fee in msats willing to be paid to avoid routing `send_amt_msat` through the
11825 * given channel in the direction from `source` to `target`.
11827 * The channel's capacity (less any other MPP parts that are also being considered for use in
11828 * the same payment) is given by `capacity_msat`. It may be determined from various sources
11829 * such as a chain data, network gossip, or invoice hints. For invoice hints, a capacity near
11830 * [`u64::max_value`] is given to indicate sufficient capacity for the invoice's full amount.
11831 * Thus, implementations should be overflow-safe.
11833 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);
11835 * Handles updating channel penalties after failing to route through a channel.
11837 void (*payment_path_failed)(void *this_arg, struct LDKCVec_RouteHopZ path, uint64_t short_channel_id);
11839 * Handles updating channel penalties after successfully routing along a path.
11841 void (*payment_path_successful)(void *this_arg, struct LDKCVec_RouteHopZ path);
11843 * Serialize the object into a byte array
11845 struct LDKCVec_u8Z (*write)(const void *this_arg);
11847 * Frees any resources associated with this object given its this_arg pointer.
11848 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
11850 void (*free)(void *this_arg);
11854 * A scorer that is accessed under a lock.
11856 * Needed so that calls to [`Score::channel_penalty_msat`] in [`find_route`] can be made while
11857 * having shared ownership of a scorer but without requiring internal locking in [`Score`]
11858 * implementations. Internal locking would be detrimental to route finding performance and could
11859 * result in [`Score::channel_penalty_msat`] returning a different value for the same channel.
11861 * [`find_route`]: crate::routing::router::find_route
11863 typedef struct LDKLockableScore {
11865 * An opaque pointer which is passed to your function implementations as an argument.
11866 * This has no meaning in the LDK, and can be NULL or any other value.
11870 * Returns the locked scorer.
11872 struct LDKScore (*lock)(const void *this_arg);
11874 * Frees any resources associated with this object given its this_arg pointer.
11875 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
11877 void (*free)(void *this_arg);
11878 } LDKLockableScore;
11883 * A concrete implementation of [`LockableScore`] which supports multi-threading.
11885 typedef struct MUST_USE_STRUCT LDKMultiThreadedLockableScore {
11887 * A pointer to the opaque Rust object.
11888 * Nearly everywhere, inner must be non-null, however in places where
11889 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11891 LDKnativeMultiThreadedLockableScore *inner;
11893 * Indicates that this is the only struct which contains the same pointer.
11894 * Rust functions which take ownership of an object provided via an argument require
11895 * this to be true and invalidate the object pointed to by inner.
11898 } LDKMultiThreadedLockableScore;
11903 * Parameters for configuring [`ProbabilisticScorer`].
11905 * Used to configure base, liquidity, and amount penalties, the sum of which comprises the channel
11906 * penalty (i.e., the amount in msats willing to be paid to avoid routing through the channel).
11908 typedef struct MUST_USE_STRUCT LDKProbabilisticScoringParameters {
11910 * A pointer to the opaque Rust object.
11911 * Nearly everywhere, inner must be non-null, however in places where
11912 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11914 LDKnativeProbabilisticScoringParameters *inner;
11916 * Indicates that this is the only struct which contains the same pointer.
11917 * Rust functions which take ownership of an object provided via an argument require
11918 * this to be true and invalidate the object pointed to by inner.
11921 } LDKProbabilisticScoringParameters;
11926 * FilesystemPersister persists channel data on disk, where each channel's
11927 * data is stored in a file named after its funding outpoint.
11929 * Warning: this module does the best it can with calls to persist data, but it
11930 * can only guarantee that the data is passed to the drive. It is up to the
11931 * drive manufacturers to do the actual persistence properly, which they often
11932 * don't (especially on consumer-grade hardware). Therefore, it is up to the
11933 * user to validate their entire storage stack, to ensure the writes are
11935 * Corollary: especially when dealing with larger amounts of money, it is best
11936 * practice to have multiple channel data backups and not rely only on one
11937 * FilesystemPersister.
11939 typedef struct MUST_USE_STRUCT LDKFilesystemPersister {
11941 * A pointer to the opaque Rust object.
11942 * Nearly everywhere, inner must be non-null, however in places where
11943 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11945 LDKnativeFilesystemPersister *inner;
11947 * Indicates that this is the only struct which contains the same pointer.
11948 * Rust functions which take ownership of an object provided via an argument require
11949 * this to be true and invalidate the object pointed to by inner.
11952 } LDKFilesystemPersister;
11957 * `BackgroundProcessor` takes care of tasks that (1) need to happen periodically to keep
11958 * Rust-Lightning running properly, and (2) either can or should be run in the background. Its
11959 * responsibilities are:
11960 * * Processing [`Event`]s with a user-provided [`EventHandler`].
11961 * * Monitoring whether the [`ChannelManager`] needs to be re-persisted to disk, and if so,
11962 * writing it to disk/backups by invoking the callback given to it at startup.
11963 * [`ChannelManager`] persistence should be done in the background.
11964 * * Calling [`ChannelManager::timer_tick_occurred`] and [`PeerManager::timer_tick_occurred`]
11965 * at the appropriate intervals.
11966 * * Calling [`NetworkGraph::remove_stale_channels`] (if a [`NetGraphMsgHandler`] is provided to
11967 * [`BackgroundProcessor::start`]).
11969 * It will also call [`PeerManager::process_events`] periodically though this shouldn't be relied
11970 * upon as doing so may result in high latency.
11974 * If [`ChannelManager`] persistence fails and the persisted manager becomes out-of-date, then
11975 * there is a risk of channels force-closing on startup when the manager realizes it's outdated.
11976 * However, as long as [`ChannelMonitor`] backups are sound, no funds besides those used for
11977 * unilateral chain closure fees are at risk.
11979 * [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
11980 * [`Event`]: lightning::util::events::Event
11981 *BackgroundProcessor will immediately stop on drop. It should be stored until shutdown.
11983 typedef struct MUST_USE_STRUCT LDKBackgroundProcessor {
11985 * A pointer to the opaque Rust object.
11986 * Nearly everywhere, inner must be non-null, however in places where
11987 * the Rust equivalent takes an Option, it may be set to null to indicate None.
11989 LDKnativeBackgroundProcessor *inner;
11991 * Indicates that this is the only struct which contains the same pointer.
11992 * Rust functions which take ownership of an object provided via an argument require
11993 * this to be true and invalidate the object pointed to by inner.
11996 } LDKBackgroundProcessor;
11999 * Trait that handles persisting a [`ChannelManager`] and [`NetworkGraph`] to disk.
12001 typedef struct LDKPersister {
12003 * An opaque pointer which is passed to your function implementations as an argument.
12004 * This has no meaning in the LDK, and can be NULL or any other value.
12008 * Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
12009 * (which will cause the [`BackgroundProcessor`] which called this method to exit).
12011 struct LDKCResult_NoneErrorZ (*persist_manager)(const void *this_arg, const struct LDKChannelManager *NONNULL_PTR channel_manager);
12013 * Persist the given [`NetworkGraph`] to disk, returning an error if persistence failed.
12015 struct LDKCResult_NoneErrorZ (*persist_graph)(const void *this_arg, const struct LDKNetworkGraph *NONNULL_PTR network_graph);
12017 * Frees any resources associated with this object given its this_arg pointer.
12018 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
12020 void (*free)(void *this_arg);
12026 * Data of the `RawInvoice` that is encoded in the data part
12028 typedef struct MUST_USE_STRUCT LDKRawDataPart {
12030 * A pointer to the opaque Rust object.
12031 * Nearly everywhere, inner must be non-null, however in places where
12032 * the Rust equivalent takes an Option, it may be set to null to indicate None.
12034 LDKnativeRawDataPart *inner;
12036 * Indicates that this is the only struct which contains the same pointer.
12037 * Rust functions which take ownership of an object provided via an argument require
12038 * this to be true and invalidate the object pointed to by inner.
12048 typedef struct MUST_USE_STRUCT LDKSha256 {
12050 * A pointer to the opaque Rust object.
12051 * Nearly everywhere, inner must be non-null, however in places where
12052 * the Rust equivalent takes an Option, it may be set to null to indicate None.
12054 LDKnativeSha256 *inner;
12056 * Indicates that this is the only struct which contains the same pointer.
12057 * Rust functions which take ownership of an object provided via an argument require
12058 * this to be true and invalidate the object pointed to by inner.
12066 * Positive duration that defines when (relatively to the timestamp) in the future the invoice
12069 typedef struct MUST_USE_STRUCT LDKExpiryTime {
12071 * A pointer to the opaque Rust object.
12072 * Nearly everywhere, inner must be non-null, however in places where
12073 * the Rust equivalent takes an Option, it may be set to null to indicate None.
12075 LDKnativeExpiryTime *inner;
12077 * Indicates that this is the only struct which contains the same pointer.
12078 * Rust functions which take ownership of an object provided via an argument require
12079 * this to be true and invalidate the object pointed to by inner.
12087 * `min_final_cltv_expiry` to use for the last HTLC in the route
12089 typedef struct MUST_USE_STRUCT LDKMinFinalCltvExpiry {
12091 * A pointer to the opaque Rust object.
12092 * Nearly everywhere, inner must be non-null, however in places where
12093 * the Rust equivalent takes an Option, it may be set to null to indicate None.
12095 LDKnativeMinFinalCltvExpiry *inner;
12097 * Indicates that this is the only struct which contains the same pointer.
12098 * Rust functions which take ownership of an object provided via an argument require
12099 * this to be true and invalidate the object pointed to by inner.
12102 } LDKMinFinalCltvExpiry;
12105 * A 20-byte byte array.
12107 typedef struct LDKTwentyBytes {
12115 * Fallback address in case no LN payment is possible
12117 typedef enum LDKFallback_Tag {
12118 LDKFallback_SegWitProgram,
12119 LDKFallback_PubKeyHash,
12120 LDKFallback_ScriptHash,
12122 * Must be last for serialization purposes
12124 LDKFallback_Sentinel,
12127 typedef struct LDKFallback_LDKSegWitProgram_Body {
12128 struct LDKu5 version;
12129 struct LDKCVec_u8Z program;
12130 } LDKFallback_LDKSegWitProgram_Body;
12132 typedef struct MUST_USE_STRUCT LDKFallback {
12133 LDKFallback_Tag tag;
12135 LDKFallback_LDKSegWitProgram_Body seg_wit_program;
12137 struct LDKTwentyBytes pub_key_hash;
12140 struct LDKTwentyBytes script_hash;
12146 * A trait defining behavior of an [`Invoice`] payer.
12148 typedef struct LDKPayer {
12150 * An opaque pointer which is passed to your function implementations as an argument.
12151 * This has no meaning in the LDK, and can be NULL or any other value.
12155 * Returns the payer's node id.
12157 struct LDKPublicKey (*node_id)(const void *this_arg);
12159 * Returns the payer's channels.
12161 struct LDKCVec_ChannelDetailsZ (*first_hops)(const void *this_arg);
12163 * Sends a payment over the Lightning Network using the given [`Route`].
12165 * Note that payment_secret (or a relevant inner pointer) may be NULL or all-0s to represent None
12167 struct LDKCResult_PaymentIdPaymentSendFailureZ (*send_payment)(const void *this_arg, const struct LDKRoute *NONNULL_PTR route, struct LDKThirtyTwoBytes payment_hash, struct LDKThirtyTwoBytes payment_secret);
12169 * Sends a spontaneous payment over the Lightning Network using the given [`Route`].
12171 struct LDKCResult_PaymentIdPaymentSendFailureZ (*send_spontaneous_payment)(const void *this_arg, const struct LDKRoute *NONNULL_PTR route, struct LDKThirtyTwoBytes payment_preimage);
12173 * Retries a failed payment path for the [`PaymentId`] using the given [`Route`].
12175 struct LDKCResult_NonePaymentSendFailureZ (*retry_payment)(const void *this_arg, const struct LDKRoute *NONNULL_PTR route, struct LDKThirtyTwoBytes payment_id);
12177 * Signals that no further retries for the given payment will occur.
12179 void (*abandon_payment)(const void *this_arg, struct LDKThirtyTwoBytes payment_id);
12181 * Frees any resources associated with this object given its this_arg pointer.
12182 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
12184 void (*free)(void *this_arg);
12188 * A trait defining behavior for routing an [`Invoice`] payment.
12190 typedef struct LDKRouter {
12192 * An opaque pointer which is passed to your function implementations as an argument.
12193 * This has no meaning in the LDK, and can be NULL or any other value.
12197 * Finds a [`Route`] between `payer` and `payee` for a payment with the given values.
12199 * Note that first_hops (or a relevant inner pointer) may be NULL or all-0s to represent None
12201 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);
12203 * Frees any resources associated with this object given its this_arg pointer.
12204 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
12206 void (*free)(void *this_arg);
12212 * A utility for paying [`Invoice`]s and sending spontaneous payments.
12214 * See [module-level documentation] for details.
12216 * [module-level documentation]: crate::payment
12218 typedef struct MUST_USE_STRUCT LDKInvoicePayer {
12220 * A pointer to the opaque Rust object.
12221 * Nearly everywhere, inner must be non-null, however in places where
12222 * the Rust equivalent takes an Option, it may be set to null to indicate None.
12224 LDKnativeInvoicePayer *inner;
12226 * Indicates that this is the only struct which contains the same pointer.
12227 * Rust functions which take ownership of an object provided via an argument require
12228 * this to be true and invalidate the object pointed to by inner.
12236 * Number of attempts to retry payment path failures for an [`Invoice`].
12238 * Note that this is the number of *path* failures, not full payment retries. For multi-path
12239 * payments, if this is less than the total number of paths, we will never even retry all of the
12242 typedef struct MUST_USE_STRUCT LDKRetryAttempts {
12244 * A pointer to the opaque Rust object.
12245 * Nearly everywhere, inner must be non-null, however in places where
12246 * the Rust equivalent takes an Option, it may be set to null to indicate None.
12248 LDKnativeRetryAttempts *inner;
12250 * Indicates that this is the only struct which contains the same pointer.
12251 * Rust functions which take ownership of an object provided via an argument require
12252 * this to be true and invalidate the object pointed to by inner.
12255 } LDKRetryAttempts;
12260 * A [`Router`] implemented using [`find_route`].
12262 typedef struct MUST_USE_STRUCT LDKDefaultRouter {
12264 * A pointer to the opaque Rust object.
12265 * Nearly everywhere, inner must be non-null, however in places where
12266 * the Rust equivalent takes an Option, it may be set to null to indicate None.
12268 LDKnativeDefaultRouter *inner;
12270 * Indicates that this is the only struct which contains the same pointer.
12271 * Rust functions which take ownership of an object provided via an argument require
12272 * this to be true and invalidate the object pointed to by inner.
12275 } LDKDefaultRouter;
12277 extern const uintptr_t MAX_BUF_SIZE;
12279 extern const uint64_t MIN_RELAY_FEE_SAT_PER_1000_WEIGHT;
12281 extern const uint64_t CLOSED_CHANNEL_UPDATE_ID;
12283 extern const uint32_t ANTI_REORG_DELAY;
12285 extern const uint16_t BREAKDOWN_TIMEOUT;
12287 extern const uint16_t MIN_CLTV_EXPIRY_DELTA;
12289 extern const uint32_t MIN_FINAL_CLTV_EXPIRY;
12291 extern const uintptr_t REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH;
12293 extern const uint64_t UNKNOWN_CHANNEL_CAPACITY_MSAT;
12295 extern const uint32_t DEFAULT_MAX_TOTAL_CLTV_EXPIRY_DELTA;
12297 extern const uint64_t MAX_TIMESTAMP;
12299 extern const uint64_t DEFAULT_EXPIRY_TIME;
12301 extern const uint64_t DEFAULT_MIN_FINAL_CLTV_EXPIRY;
12303 extern const uint8_t TAG_PAYMENT_HASH;
12305 extern const uint8_t TAG_DESCRIPTION;
12307 extern const uint8_t TAG_PAYEE_PUB_KEY;
12309 extern const uint8_t TAG_DESCRIPTION_HASH;
12311 extern const uint8_t TAG_EXPIRY_TIME;
12313 extern const uint8_t TAG_MIN_FINAL_CLTV_EXPIRY;
12315 extern const uint8_t TAG_FALLBACK;
12317 extern const uint8_t TAG_PRIVATE_ROUTE;
12319 extern const uint8_t TAG_PAYMENT_SECRET;
12321 extern const uint8_t TAG_FEATURES;
12323 struct LDKStr _ldk_get_compiled_version(void);
12325 struct LDKStr _ldk_c_bindings_get_compiled_version(void);
12328 * Frees the data buffer, if data_is_owned is set and datalen > 0.
12330 void Transaction_free(struct LDKTransaction _res);
12333 * Convenience function for constructing a new TxOut
12335 struct LDKTxOut TxOut_new(struct LDKCVec_u8Z script_pubkey, uint64_t value);
12338 * Frees the data pointed to by script_pubkey.
12340 void TxOut_free(struct LDKTxOut _res);
12343 * Creates a new TxOut which has the same data as `orig` but with a new script buffer.
12345 struct LDKTxOut TxOut_clone(const struct LDKTxOut *NONNULL_PTR orig);
12348 * Frees the data buffer, if chars_is_owned is set and len > 0.
12350 void Str_free(struct LDKStr _res);
12352 #if defined(LDK_DEBUG_BUILD)
12354 * This function exists for memory safety testing purposes. It should never be used in production
12357 const void *__unmangle_inner_ptr(const void *ptr);
12361 * Creates a new CResult_NoneNoneZ in the success state.
12363 struct LDKCResult_NoneNoneZ CResult_NoneNoneZ_ok(void);
12366 * Creates a new CResult_NoneNoneZ in the error state.
12368 struct LDKCResult_NoneNoneZ CResult_NoneNoneZ_err(void);
12371 * Checks if the given object is currently in the success state
12373 bool CResult_NoneNoneZ_is_ok(const struct LDKCResult_NoneNoneZ *NONNULL_PTR o);
12376 * Frees any resources used by the CResult_NoneNoneZ.
12378 void CResult_NoneNoneZ_free(struct LDKCResult_NoneNoneZ _res);
12381 * Creates a new CResult_NoneNoneZ which has the same data as `orig`
12382 * but with all dynamically-allocated buffers duplicated in new buffers.
12384 struct LDKCResult_NoneNoneZ CResult_NoneNoneZ_clone(const struct LDKCResult_NoneNoneZ *NONNULL_PTR orig);
12387 * Creates a new CResult_CounterpartyCommitmentSecretsDecodeErrorZ in the success state.
12389 struct LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZ CResult_CounterpartyCommitmentSecretsDecodeErrorZ_ok(struct LDKCounterpartyCommitmentSecrets o);
12392 * Creates a new CResult_CounterpartyCommitmentSecretsDecodeErrorZ in the error state.
12394 struct LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZ CResult_CounterpartyCommitmentSecretsDecodeErrorZ_err(struct LDKDecodeError e);
12397 * Checks if the given object is currently in the success state
12399 bool CResult_CounterpartyCommitmentSecretsDecodeErrorZ_is_ok(const struct LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZ *NONNULL_PTR o);
12402 * Frees any resources used by the CResult_CounterpartyCommitmentSecretsDecodeErrorZ.
12404 void CResult_CounterpartyCommitmentSecretsDecodeErrorZ_free(struct LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZ _res);
12407 * Creates a new CResult_CounterpartyCommitmentSecretsDecodeErrorZ which has the same data as `orig`
12408 * but with all dynamically-allocated buffers duplicated in new buffers.
12410 struct LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZ CResult_CounterpartyCommitmentSecretsDecodeErrorZ_clone(const struct LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZ *NONNULL_PTR orig);
12413 * Creates a new CResult_SecretKeyErrorZ in the success state.
12415 struct LDKCResult_SecretKeyErrorZ CResult_SecretKeyErrorZ_ok(struct LDKSecretKey o);
12418 * Creates a new CResult_SecretKeyErrorZ in the error state.
12420 struct LDKCResult_SecretKeyErrorZ CResult_SecretKeyErrorZ_err(enum LDKSecp256k1Error e);
12423 * Checks if the given object is currently in the success state
12425 bool CResult_SecretKeyErrorZ_is_ok(const struct LDKCResult_SecretKeyErrorZ *NONNULL_PTR o);
12428 * Frees any resources used by the CResult_SecretKeyErrorZ.
12430 void CResult_SecretKeyErrorZ_free(struct LDKCResult_SecretKeyErrorZ _res);
12433 * Creates a new CResult_SecretKeyErrorZ which has the same data as `orig`
12434 * but with all dynamically-allocated buffers duplicated in new buffers.
12436 struct LDKCResult_SecretKeyErrorZ CResult_SecretKeyErrorZ_clone(const struct LDKCResult_SecretKeyErrorZ *NONNULL_PTR orig);
12439 * Creates a new CResult_PublicKeyErrorZ in the success state.
12441 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_ok(struct LDKPublicKey o);
12444 * Creates a new CResult_PublicKeyErrorZ in the error state.
12446 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_err(enum LDKSecp256k1Error e);
12449 * Checks if the given object is currently in the success state
12451 bool CResult_PublicKeyErrorZ_is_ok(const struct LDKCResult_PublicKeyErrorZ *NONNULL_PTR o);
12454 * Frees any resources used by the CResult_PublicKeyErrorZ.
12456 void CResult_PublicKeyErrorZ_free(struct LDKCResult_PublicKeyErrorZ _res);
12459 * Creates a new CResult_PublicKeyErrorZ which has the same data as `orig`
12460 * but with all dynamically-allocated buffers duplicated in new buffers.
12462 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_clone(const struct LDKCResult_PublicKeyErrorZ *NONNULL_PTR orig);
12465 * Creates a new CResult_TxCreationKeysDecodeErrorZ in the success state.
12467 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_ok(struct LDKTxCreationKeys o);
12470 * Creates a new CResult_TxCreationKeysDecodeErrorZ in the error state.
12472 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_err(struct LDKDecodeError e);
12475 * Checks if the given object is currently in the success state
12477 bool CResult_TxCreationKeysDecodeErrorZ_is_ok(const struct LDKCResult_TxCreationKeysDecodeErrorZ *NONNULL_PTR o);
12480 * Frees any resources used by the CResult_TxCreationKeysDecodeErrorZ.
12482 void CResult_TxCreationKeysDecodeErrorZ_free(struct LDKCResult_TxCreationKeysDecodeErrorZ _res);
12485 * Creates a new CResult_TxCreationKeysDecodeErrorZ which has the same data as `orig`
12486 * but with all dynamically-allocated buffers duplicated in new buffers.
12488 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_clone(const struct LDKCResult_TxCreationKeysDecodeErrorZ *NONNULL_PTR orig);
12491 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ in the success state.
12493 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_ok(struct LDKChannelPublicKeys o);
12496 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ in the error state.
12498 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_err(struct LDKDecodeError e);
12501 * Checks if the given object is currently in the success state
12503 bool CResult_ChannelPublicKeysDecodeErrorZ_is_ok(const struct LDKCResult_ChannelPublicKeysDecodeErrorZ *NONNULL_PTR o);
12506 * Frees any resources used by the CResult_ChannelPublicKeysDecodeErrorZ.
12508 void CResult_ChannelPublicKeysDecodeErrorZ_free(struct LDKCResult_ChannelPublicKeysDecodeErrorZ _res);
12511 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ which has the same data as `orig`
12512 * but with all dynamically-allocated buffers duplicated in new buffers.
12514 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_clone(const struct LDKCResult_ChannelPublicKeysDecodeErrorZ *NONNULL_PTR orig);
12517 * Creates a new CResult_TxCreationKeysErrorZ in the success state.
12519 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_ok(struct LDKTxCreationKeys o);
12522 * Creates a new CResult_TxCreationKeysErrorZ in the error state.
12524 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_err(enum LDKSecp256k1Error e);
12527 * Checks if the given object is currently in the success state
12529 bool CResult_TxCreationKeysErrorZ_is_ok(const struct LDKCResult_TxCreationKeysErrorZ *NONNULL_PTR o);
12532 * Frees any resources used by the CResult_TxCreationKeysErrorZ.
12534 void CResult_TxCreationKeysErrorZ_free(struct LDKCResult_TxCreationKeysErrorZ _res);
12537 * Creates a new CResult_TxCreationKeysErrorZ which has the same data as `orig`
12538 * but with all dynamically-allocated buffers duplicated in new buffers.
12540 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_clone(const struct LDKCResult_TxCreationKeysErrorZ *NONNULL_PTR orig);
12543 * Constructs a new COption_u32Z containing a u32
12545 struct LDKCOption_u32Z COption_u32Z_some(uint32_t o);
12548 * Constructs a new COption_u32Z containing nothing
12550 struct LDKCOption_u32Z COption_u32Z_none(void);
12553 * Frees any resources associated with the u32, if we are in the Some state
12555 void COption_u32Z_free(struct LDKCOption_u32Z _res);
12558 * Creates a new COption_u32Z which has the same data as `orig`
12559 * but with all dynamically-allocated buffers duplicated in new buffers.
12561 struct LDKCOption_u32Z COption_u32Z_clone(const struct LDKCOption_u32Z *NONNULL_PTR orig);
12564 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ in the success state.
12566 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_ok(struct LDKHTLCOutputInCommitment o);
12569 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ in the error state.
12571 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_err(struct LDKDecodeError e);
12574 * Checks if the given object is currently in the success state
12576 bool CResult_HTLCOutputInCommitmentDecodeErrorZ_is_ok(const struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ *NONNULL_PTR o);
12579 * Frees any resources used by the CResult_HTLCOutputInCommitmentDecodeErrorZ.
12581 void CResult_HTLCOutputInCommitmentDecodeErrorZ_free(struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ _res);
12584 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ which has the same data as `orig`
12585 * but with all dynamically-allocated buffers duplicated in new buffers.
12587 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_clone(const struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ *NONNULL_PTR orig);
12590 * Constructs a new COption_NoneZ containing a
12592 enum LDKCOption_NoneZ COption_NoneZ_some(void);
12595 * Constructs a new COption_NoneZ containing nothing
12597 enum LDKCOption_NoneZ COption_NoneZ_none(void);
12600 * Frees any resources associated with the , if we are in the Some state
12602 void COption_NoneZ_free(enum LDKCOption_NoneZ _res);
12605 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ in the success state.
12607 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_ok(struct LDKCounterpartyChannelTransactionParameters o);
12610 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ in the error state.
12612 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_err(struct LDKDecodeError e);
12615 * Checks if the given object is currently in the success state
12617 bool CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_is_ok(const struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ *NONNULL_PTR o);
12620 * Frees any resources used by the CResult_CounterpartyChannelTransactionParametersDecodeErrorZ.
12622 void CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_free(struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ _res);
12625 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ which has the same data as `orig`
12626 * but with all dynamically-allocated buffers duplicated in new buffers.
12628 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_clone(const struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ *NONNULL_PTR orig);
12631 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ in the success state.
12633 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_ok(struct LDKChannelTransactionParameters o);
12636 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ in the error state.
12638 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_err(struct LDKDecodeError e);
12641 * Checks if the given object is currently in the success state
12643 bool CResult_ChannelTransactionParametersDecodeErrorZ_is_ok(const struct LDKCResult_ChannelTransactionParametersDecodeErrorZ *NONNULL_PTR o);
12646 * Frees any resources used by the CResult_ChannelTransactionParametersDecodeErrorZ.
12648 void CResult_ChannelTransactionParametersDecodeErrorZ_free(struct LDKCResult_ChannelTransactionParametersDecodeErrorZ _res);
12651 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ which has the same data as `orig`
12652 * but with all dynamically-allocated buffers duplicated in new buffers.
12654 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_clone(const struct LDKCResult_ChannelTransactionParametersDecodeErrorZ *NONNULL_PTR orig);
12657 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12659 void CVec_SignatureZ_free(struct LDKCVec_SignatureZ _res);
12662 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ in the success state.
12664 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_ok(struct LDKHolderCommitmentTransaction o);
12667 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ in the error state.
12669 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
12672 * Checks if the given object is currently in the success state
12674 bool CResult_HolderCommitmentTransactionDecodeErrorZ_is_ok(const struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ *NONNULL_PTR o);
12677 * Frees any resources used by the CResult_HolderCommitmentTransactionDecodeErrorZ.
12679 void CResult_HolderCommitmentTransactionDecodeErrorZ_free(struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ _res);
12682 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ which has the same data as `orig`
12683 * but with all dynamically-allocated buffers duplicated in new buffers.
12685 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
12688 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ in the success state.
12690 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_ok(struct LDKBuiltCommitmentTransaction o);
12693 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ in the error state.
12695 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
12698 * Checks if the given object is currently in the success state
12700 bool CResult_BuiltCommitmentTransactionDecodeErrorZ_is_ok(const struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ *NONNULL_PTR o);
12703 * Frees any resources used by the CResult_BuiltCommitmentTransactionDecodeErrorZ.
12705 void CResult_BuiltCommitmentTransactionDecodeErrorZ_free(struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ _res);
12708 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ which has the same data as `orig`
12709 * but with all dynamically-allocated buffers duplicated in new buffers.
12711 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
12714 * Creates a new CResult_TrustedClosingTransactionNoneZ in the success state.
12716 struct LDKCResult_TrustedClosingTransactionNoneZ CResult_TrustedClosingTransactionNoneZ_ok(struct LDKTrustedClosingTransaction o);
12719 * Creates a new CResult_TrustedClosingTransactionNoneZ in the error state.
12721 struct LDKCResult_TrustedClosingTransactionNoneZ CResult_TrustedClosingTransactionNoneZ_err(void);
12724 * Checks if the given object is currently in the success state
12726 bool CResult_TrustedClosingTransactionNoneZ_is_ok(const struct LDKCResult_TrustedClosingTransactionNoneZ *NONNULL_PTR o);
12729 * Frees any resources used by the CResult_TrustedClosingTransactionNoneZ.
12731 void CResult_TrustedClosingTransactionNoneZ_free(struct LDKCResult_TrustedClosingTransactionNoneZ _res);
12734 * Creates a new CResult_CommitmentTransactionDecodeErrorZ in the success state.
12736 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_ok(struct LDKCommitmentTransaction o);
12739 * Creates a new CResult_CommitmentTransactionDecodeErrorZ in the error state.
12741 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
12744 * Checks if the given object is currently in the success state
12746 bool CResult_CommitmentTransactionDecodeErrorZ_is_ok(const struct LDKCResult_CommitmentTransactionDecodeErrorZ *NONNULL_PTR o);
12749 * Frees any resources used by the CResult_CommitmentTransactionDecodeErrorZ.
12751 void CResult_CommitmentTransactionDecodeErrorZ_free(struct LDKCResult_CommitmentTransactionDecodeErrorZ _res);
12754 * Creates a new CResult_CommitmentTransactionDecodeErrorZ which has the same data as `orig`
12755 * but with all dynamically-allocated buffers duplicated in new buffers.
12757 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_CommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
12760 * Creates a new CResult_TrustedCommitmentTransactionNoneZ in the success state.
12762 struct LDKCResult_TrustedCommitmentTransactionNoneZ CResult_TrustedCommitmentTransactionNoneZ_ok(struct LDKTrustedCommitmentTransaction o);
12765 * Creates a new CResult_TrustedCommitmentTransactionNoneZ in the error state.
12767 struct LDKCResult_TrustedCommitmentTransactionNoneZ CResult_TrustedCommitmentTransactionNoneZ_err(void);
12770 * Checks if the given object is currently in the success state
12772 bool CResult_TrustedCommitmentTransactionNoneZ_is_ok(const struct LDKCResult_TrustedCommitmentTransactionNoneZ *NONNULL_PTR o);
12775 * Frees any resources used by the CResult_TrustedCommitmentTransactionNoneZ.
12777 void CResult_TrustedCommitmentTransactionNoneZ_free(struct LDKCResult_TrustedCommitmentTransactionNoneZ _res);
12780 * Creates a new CResult_CVec_SignatureZNoneZ in the success state.
12782 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_ok(struct LDKCVec_SignatureZ o);
12785 * Creates a new CResult_CVec_SignatureZNoneZ in the error state.
12787 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_err(void);
12790 * Checks if the given object is currently in the success state
12792 bool CResult_CVec_SignatureZNoneZ_is_ok(const struct LDKCResult_CVec_SignatureZNoneZ *NONNULL_PTR o);
12795 * Frees any resources used by the CResult_CVec_SignatureZNoneZ.
12797 void CResult_CVec_SignatureZNoneZ_free(struct LDKCResult_CVec_SignatureZNoneZ _res);
12800 * Creates a new CResult_CVec_SignatureZNoneZ which has the same data as `orig`
12801 * but with all dynamically-allocated buffers duplicated in new buffers.
12803 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_clone(const struct LDKCResult_CVec_SignatureZNoneZ *NONNULL_PTR orig);
12806 * Creates a new CResult_ShutdownScriptDecodeErrorZ in the success state.
12808 struct LDKCResult_ShutdownScriptDecodeErrorZ CResult_ShutdownScriptDecodeErrorZ_ok(struct LDKShutdownScript o);
12811 * Creates a new CResult_ShutdownScriptDecodeErrorZ in the error state.
12813 struct LDKCResult_ShutdownScriptDecodeErrorZ CResult_ShutdownScriptDecodeErrorZ_err(struct LDKDecodeError e);
12816 * Checks if the given object is currently in the success state
12818 bool CResult_ShutdownScriptDecodeErrorZ_is_ok(const struct LDKCResult_ShutdownScriptDecodeErrorZ *NONNULL_PTR o);
12821 * Frees any resources used by the CResult_ShutdownScriptDecodeErrorZ.
12823 void CResult_ShutdownScriptDecodeErrorZ_free(struct LDKCResult_ShutdownScriptDecodeErrorZ _res);
12826 * Creates a new CResult_ShutdownScriptDecodeErrorZ which has the same data as `orig`
12827 * but with all dynamically-allocated buffers duplicated in new buffers.
12829 struct LDKCResult_ShutdownScriptDecodeErrorZ CResult_ShutdownScriptDecodeErrorZ_clone(const struct LDKCResult_ShutdownScriptDecodeErrorZ *NONNULL_PTR orig);
12832 * Creates a new CResult_ShutdownScriptInvalidShutdownScriptZ in the success state.
12834 struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ CResult_ShutdownScriptInvalidShutdownScriptZ_ok(struct LDKShutdownScript o);
12837 * Creates a new CResult_ShutdownScriptInvalidShutdownScriptZ in the error state.
12839 struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ CResult_ShutdownScriptInvalidShutdownScriptZ_err(struct LDKInvalidShutdownScript e);
12842 * Checks if the given object is currently in the success state
12844 bool CResult_ShutdownScriptInvalidShutdownScriptZ_is_ok(const struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ *NONNULL_PTR o);
12847 * Frees any resources used by the CResult_ShutdownScriptInvalidShutdownScriptZ.
12849 void CResult_ShutdownScriptInvalidShutdownScriptZ_free(struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ _res);
12852 * Creates a new CResult_ShutdownScriptInvalidShutdownScriptZ which has the same data as `orig`
12853 * but with all dynamically-allocated buffers duplicated in new buffers.
12855 struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ CResult_ShutdownScriptInvalidShutdownScriptZ_clone(const struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ *NONNULL_PTR orig);
12858 * Creates a new CResult_NoneErrorZ in the success state.
12860 struct LDKCResult_NoneErrorZ CResult_NoneErrorZ_ok(void);
12863 * Creates a new CResult_NoneErrorZ in the error state.
12865 struct LDKCResult_NoneErrorZ CResult_NoneErrorZ_err(enum LDKIOError e);
12868 * Checks if the given object is currently in the success state
12870 bool CResult_NoneErrorZ_is_ok(const struct LDKCResult_NoneErrorZ *NONNULL_PTR o);
12873 * Frees any resources used by the CResult_NoneErrorZ.
12875 void CResult_NoneErrorZ_free(struct LDKCResult_NoneErrorZ _res);
12878 * Creates a new CResult_NoneErrorZ which has the same data as `orig`
12879 * but with all dynamically-allocated buffers duplicated in new buffers.
12881 struct LDKCResult_NoneErrorZ CResult_NoneErrorZ_clone(const struct LDKCResult_NoneErrorZ *NONNULL_PTR orig);
12884 * Creates a new CResult_RouteHopDecodeErrorZ in the success state.
12886 struct LDKCResult_RouteHopDecodeErrorZ CResult_RouteHopDecodeErrorZ_ok(struct LDKRouteHop o);
12889 * Creates a new CResult_RouteHopDecodeErrorZ in the error state.
12891 struct LDKCResult_RouteHopDecodeErrorZ CResult_RouteHopDecodeErrorZ_err(struct LDKDecodeError e);
12894 * Checks if the given object is currently in the success state
12896 bool CResult_RouteHopDecodeErrorZ_is_ok(const struct LDKCResult_RouteHopDecodeErrorZ *NONNULL_PTR o);
12899 * Frees any resources used by the CResult_RouteHopDecodeErrorZ.
12901 void CResult_RouteHopDecodeErrorZ_free(struct LDKCResult_RouteHopDecodeErrorZ _res);
12904 * Creates a new CResult_RouteHopDecodeErrorZ which has the same data as `orig`
12905 * but with all dynamically-allocated buffers duplicated in new buffers.
12907 struct LDKCResult_RouteHopDecodeErrorZ CResult_RouteHopDecodeErrorZ_clone(const struct LDKCResult_RouteHopDecodeErrorZ *NONNULL_PTR orig);
12910 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12912 void CVec_RouteHopZ_free(struct LDKCVec_RouteHopZ _res);
12915 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12917 void CVec_CVec_RouteHopZZ_free(struct LDKCVec_CVec_RouteHopZZ _res);
12920 * Creates a new CResult_RouteDecodeErrorZ in the success state.
12922 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_ok(struct LDKRoute o);
12925 * Creates a new CResult_RouteDecodeErrorZ in the error state.
12927 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_err(struct LDKDecodeError e);
12930 * Checks if the given object is currently in the success state
12932 bool CResult_RouteDecodeErrorZ_is_ok(const struct LDKCResult_RouteDecodeErrorZ *NONNULL_PTR o);
12935 * Frees any resources used by the CResult_RouteDecodeErrorZ.
12937 void CResult_RouteDecodeErrorZ_free(struct LDKCResult_RouteDecodeErrorZ _res);
12940 * Creates a new CResult_RouteDecodeErrorZ which has the same data as `orig`
12941 * but with all dynamically-allocated buffers duplicated in new buffers.
12943 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_clone(const struct LDKCResult_RouteDecodeErrorZ *NONNULL_PTR orig);
12946 * Creates a new CResult_RouteParametersDecodeErrorZ in the success state.
12948 struct LDKCResult_RouteParametersDecodeErrorZ CResult_RouteParametersDecodeErrorZ_ok(struct LDKRouteParameters o);
12951 * Creates a new CResult_RouteParametersDecodeErrorZ in the error state.
12953 struct LDKCResult_RouteParametersDecodeErrorZ CResult_RouteParametersDecodeErrorZ_err(struct LDKDecodeError e);
12956 * Checks if the given object is currently in the success state
12958 bool CResult_RouteParametersDecodeErrorZ_is_ok(const struct LDKCResult_RouteParametersDecodeErrorZ *NONNULL_PTR o);
12961 * Frees any resources used by the CResult_RouteParametersDecodeErrorZ.
12963 void CResult_RouteParametersDecodeErrorZ_free(struct LDKCResult_RouteParametersDecodeErrorZ _res);
12966 * Creates a new CResult_RouteParametersDecodeErrorZ which has the same data as `orig`
12967 * but with all dynamically-allocated buffers duplicated in new buffers.
12969 struct LDKCResult_RouteParametersDecodeErrorZ CResult_RouteParametersDecodeErrorZ_clone(const struct LDKCResult_RouteParametersDecodeErrorZ *NONNULL_PTR orig);
12972 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12974 void CVec_RouteHintZ_free(struct LDKCVec_RouteHintZ _res);
12977 * Constructs a new COption_u64Z containing a u64
12979 struct LDKCOption_u64Z COption_u64Z_some(uint64_t o);
12982 * Constructs a new COption_u64Z containing nothing
12984 struct LDKCOption_u64Z COption_u64Z_none(void);
12987 * Frees any resources associated with the u64, if we are in the Some state
12989 void COption_u64Z_free(struct LDKCOption_u64Z _res);
12992 * Creates a new COption_u64Z which has the same data as `orig`
12993 * but with all dynamically-allocated buffers duplicated in new buffers.
12995 struct LDKCOption_u64Z COption_u64Z_clone(const struct LDKCOption_u64Z *NONNULL_PTR orig);
12998 * Creates a new CResult_PaymentParametersDecodeErrorZ in the success state.
13000 struct LDKCResult_PaymentParametersDecodeErrorZ CResult_PaymentParametersDecodeErrorZ_ok(struct LDKPaymentParameters o);
13003 * Creates a new CResult_PaymentParametersDecodeErrorZ in the error state.
13005 struct LDKCResult_PaymentParametersDecodeErrorZ CResult_PaymentParametersDecodeErrorZ_err(struct LDKDecodeError e);
13008 * Checks if the given object is currently in the success state
13010 bool CResult_PaymentParametersDecodeErrorZ_is_ok(const struct LDKCResult_PaymentParametersDecodeErrorZ *NONNULL_PTR o);
13013 * Frees any resources used by the CResult_PaymentParametersDecodeErrorZ.
13015 void CResult_PaymentParametersDecodeErrorZ_free(struct LDKCResult_PaymentParametersDecodeErrorZ _res);
13018 * Creates a new CResult_PaymentParametersDecodeErrorZ which has the same data as `orig`
13019 * but with all dynamically-allocated buffers duplicated in new buffers.
13021 struct LDKCResult_PaymentParametersDecodeErrorZ CResult_PaymentParametersDecodeErrorZ_clone(const struct LDKCResult_PaymentParametersDecodeErrorZ *NONNULL_PTR orig);
13024 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13026 void CVec_RouteHintHopZ_free(struct LDKCVec_RouteHintHopZ _res);
13029 * Creates a new CResult_RouteHintDecodeErrorZ in the success state.
13031 struct LDKCResult_RouteHintDecodeErrorZ CResult_RouteHintDecodeErrorZ_ok(struct LDKRouteHint o);
13034 * Creates a new CResult_RouteHintDecodeErrorZ in the error state.
13036 struct LDKCResult_RouteHintDecodeErrorZ CResult_RouteHintDecodeErrorZ_err(struct LDKDecodeError e);
13039 * Checks if the given object is currently in the success state
13041 bool CResult_RouteHintDecodeErrorZ_is_ok(const struct LDKCResult_RouteHintDecodeErrorZ *NONNULL_PTR o);
13044 * Frees any resources used by the CResult_RouteHintDecodeErrorZ.
13046 void CResult_RouteHintDecodeErrorZ_free(struct LDKCResult_RouteHintDecodeErrorZ _res);
13049 * Creates a new CResult_RouteHintDecodeErrorZ which has the same data as `orig`
13050 * but with all dynamically-allocated buffers duplicated in new buffers.
13052 struct LDKCResult_RouteHintDecodeErrorZ CResult_RouteHintDecodeErrorZ_clone(const struct LDKCResult_RouteHintDecodeErrorZ *NONNULL_PTR orig);
13055 * Creates a new CResult_RouteHintHopDecodeErrorZ in the success state.
13057 struct LDKCResult_RouteHintHopDecodeErrorZ CResult_RouteHintHopDecodeErrorZ_ok(struct LDKRouteHintHop o);
13060 * Creates a new CResult_RouteHintHopDecodeErrorZ in the error state.
13062 struct LDKCResult_RouteHintHopDecodeErrorZ CResult_RouteHintHopDecodeErrorZ_err(struct LDKDecodeError e);
13065 * Checks if the given object is currently in the success state
13067 bool CResult_RouteHintHopDecodeErrorZ_is_ok(const struct LDKCResult_RouteHintHopDecodeErrorZ *NONNULL_PTR o);
13070 * Frees any resources used by the CResult_RouteHintHopDecodeErrorZ.
13072 void CResult_RouteHintHopDecodeErrorZ_free(struct LDKCResult_RouteHintHopDecodeErrorZ _res);
13075 * Creates a new CResult_RouteHintHopDecodeErrorZ which has the same data as `orig`
13076 * but with all dynamically-allocated buffers duplicated in new buffers.
13078 struct LDKCResult_RouteHintHopDecodeErrorZ CResult_RouteHintHopDecodeErrorZ_clone(const struct LDKCResult_RouteHintHopDecodeErrorZ *NONNULL_PTR orig);
13081 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13083 void CVec_ChannelDetailsZ_free(struct LDKCVec_ChannelDetailsZ _res);
13086 * Creates a new CResult_RouteLightningErrorZ in the success state.
13088 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_ok(struct LDKRoute o);
13091 * Creates a new CResult_RouteLightningErrorZ in the error state.
13093 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_err(struct LDKLightningError e);
13096 * Checks if the given object is currently in the success state
13098 bool CResult_RouteLightningErrorZ_is_ok(const struct LDKCResult_RouteLightningErrorZ *NONNULL_PTR o);
13101 * Frees any resources used by the CResult_RouteLightningErrorZ.
13103 void CResult_RouteLightningErrorZ_free(struct LDKCResult_RouteLightningErrorZ _res);
13106 * Creates a new CResult_RouteLightningErrorZ which has the same data as `orig`
13107 * but with all dynamically-allocated buffers duplicated in new buffers.
13109 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_clone(const struct LDKCResult_RouteLightningErrorZ *NONNULL_PTR orig);
13112 * Creates a new CResult_TxOutAccessErrorZ in the success state.
13114 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_ok(struct LDKTxOut o);
13117 * Creates a new CResult_TxOutAccessErrorZ in the error state.
13119 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_err(enum LDKAccessError e);
13122 * Checks if the given object is currently in the success state
13124 bool CResult_TxOutAccessErrorZ_is_ok(const struct LDKCResult_TxOutAccessErrorZ *NONNULL_PTR o);
13127 * Frees any resources used by the CResult_TxOutAccessErrorZ.
13129 void CResult_TxOutAccessErrorZ_free(struct LDKCResult_TxOutAccessErrorZ _res);
13132 * Creates a new CResult_TxOutAccessErrorZ which has the same data as `orig`
13133 * but with all dynamically-allocated buffers duplicated in new buffers.
13135 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_clone(const struct LDKCResult_TxOutAccessErrorZ *NONNULL_PTR orig);
13138 * Creates a new tuple which has the same data as `orig`
13139 * but with all dynamically-allocated buffers duplicated in new buffers.
13141 struct LDKC2Tuple_usizeTransactionZ C2Tuple_usizeTransactionZ_clone(const struct LDKC2Tuple_usizeTransactionZ *NONNULL_PTR orig);
13144 * Creates a new C2Tuple_usizeTransactionZ from the contained elements.
13146 struct LDKC2Tuple_usizeTransactionZ C2Tuple_usizeTransactionZ_new(uintptr_t a, struct LDKTransaction b);
13149 * Frees any resources used by the C2Tuple_usizeTransactionZ.
13151 void C2Tuple_usizeTransactionZ_free(struct LDKC2Tuple_usizeTransactionZ _res);
13154 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13156 void CVec_C2Tuple_usizeTransactionZZ_free(struct LDKCVec_C2Tuple_usizeTransactionZZ _res);
13159 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13161 void CVec_TxidZ_free(struct LDKCVec_TxidZ _res);
13164 * Creates a new CResult_NoneChannelMonitorUpdateErrZ in the success state.
13166 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_ok(void);
13169 * Creates a new CResult_NoneChannelMonitorUpdateErrZ in the error state.
13171 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_err(enum LDKChannelMonitorUpdateErr e);
13174 * Checks if the given object is currently in the success state
13176 bool CResult_NoneChannelMonitorUpdateErrZ_is_ok(const struct LDKCResult_NoneChannelMonitorUpdateErrZ *NONNULL_PTR o);
13179 * Frees any resources used by the CResult_NoneChannelMonitorUpdateErrZ.
13181 void CResult_NoneChannelMonitorUpdateErrZ_free(struct LDKCResult_NoneChannelMonitorUpdateErrZ _res);
13184 * Creates a new CResult_NoneChannelMonitorUpdateErrZ which has the same data as `orig`
13185 * but with all dynamically-allocated buffers duplicated in new buffers.
13187 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_clone(const struct LDKCResult_NoneChannelMonitorUpdateErrZ *NONNULL_PTR orig);
13190 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13192 void CVec_MonitorEventZ_free(struct LDKCVec_MonitorEventZ _res);
13195 * Constructs a new COption_C2Tuple_usizeTransactionZZ containing a crate::c_types::derived::C2Tuple_usizeTransactionZ
13197 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_some(struct LDKC2Tuple_usizeTransactionZ o);
13200 * Constructs a new COption_C2Tuple_usizeTransactionZZ containing nothing
13202 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_none(void);
13205 * Frees any resources associated with the crate::c_types::derived::C2Tuple_usizeTransactionZ, if we are in the Some state
13207 void COption_C2Tuple_usizeTransactionZZ_free(struct LDKCOption_C2Tuple_usizeTransactionZZ _res);
13210 * Creates a new COption_C2Tuple_usizeTransactionZZ which has the same data as `orig`
13211 * but with all dynamically-allocated buffers duplicated in new buffers.
13213 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_clone(const struct LDKCOption_C2Tuple_usizeTransactionZZ *NONNULL_PTR orig);
13216 * Constructs a new COption_ClosureReasonZ containing a crate::lightning::util::events::ClosureReason
13218 struct LDKCOption_ClosureReasonZ COption_ClosureReasonZ_some(struct LDKClosureReason o);
13221 * Constructs a new COption_ClosureReasonZ containing nothing
13223 struct LDKCOption_ClosureReasonZ COption_ClosureReasonZ_none(void);
13226 * Frees any resources associated with the crate::lightning::util::events::ClosureReason, if we are in the Some state
13228 void COption_ClosureReasonZ_free(struct LDKCOption_ClosureReasonZ _res);
13231 * Creates a new COption_ClosureReasonZ which has the same data as `orig`
13232 * but with all dynamically-allocated buffers duplicated in new buffers.
13234 struct LDKCOption_ClosureReasonZ COption_ClosureReasonZ_clone(const struct LDKCOption_ClosureReasonZ *NONNULL_PTR orig);
13237 * Creates a new CResult_COption_ClosureReasonZDecodeErrorZ in the success state.
13239 struct LDKCResult_COption_ClosureReasonZDecodeErrorZ CResult_COption_ClosureReasonZDecodeErrorZ_ok(struct LDKCOption_ClosureReasonZ o);
13242 * Creates a new CResult_COption_ClosureReasonZDecodeErrorZ in the error state.
13244 struct LDKCResult_COption_ClosureReasonZDecodeErrorZ CResult_COption_ClosureReasonZDecodeErrorZ_err(struct LDKDecodeError e);
13247 * Checks if the given object is currently in the success state
13249 bool CResult_COption_ClosureReasonZDecodeErrorZ_is_ok(const struct LDKCResult_COption_ClosureReasonZDecodeErrorZ *NONNULL_PTR o);
13252 * Frees any resources used by the CResult_COption_ClosureReasonZDecodeErrorZ.
13254 void CResult_COption_ClosureReasonZDecodeErrorZ_free(struct LDKCResult_COption_ClosureReasonZDecodeErrorZ _res);
13257 * Creates a new CResult_COption_ClosureReasonZDecodeErrorZ which has the same data as `orig`
13258 * but with all dynamically-allocated buffers duplicated in new buffers.
13260 struct LDKCResult_COption_ClosureReasonZDecodeErrorZ CResult_COption_ClosureReasonZDecodeErrorZ_clone(const struct LDKCResult_COption_ClosureReasonZDecodeErrorZ *NONNULL_PTR orig);
13263 * Constructs a new COption_NetworkUpdateZ containing a crate::lightning::routing::network_graph::NetworkUpdate
13265 struct LDKCOption_NetworkUpdateZ COption_NetworkUpdateZ_some(struct LDKNetworkUpdate o);
13268 * Constructs a new COption_NetworkUpdateZ containing nothing
13270 struct LDKCOption_NetworkUpdateZ COption_NetworkUpdateZ_none(void);
13273 * Frees any resources associated with the crate::lightning::routing::network_graph::NetworkUpdate, if we are in the Some state
13275 void COption_NetworkUpdateZ_free(struct LDKCOption_NetworkUpdateZ _res);
13278 * Creates a new COption_NetworkUpdateZ which has the same data as `orig`
13279 * but with all dynamically-allocated buffers duplicated in new buffers.
13281 struct LDKCOption_NetworkUpdateZ COption_NetworkUpdateZ_clone(const struct LDKCOption_NetworkUpdateZ *NONNULL_PTR orig);
13284 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13286 void CVec_SpendableOutputDescriptorZ_free(struct LDKCVec_SpendableOutputDescriptorZ _res);
13289 * Constructs a new COption_EventZ containing a crate::lightning::util::events::Event
13291 struct LDKCOption_EventZ COption_EventZ_some(struct LDKEvent o);
13294 * Constructs a new COption_EventZ containing nothing
13296 struct LDKCOption_EventZ COption_EventZ_none(void);
13299 * Frees any resources associated with the crate::lightning::util::events::Event, if we are in the Some state
13301 void COption_EventZ_free(struct LDKCOption_EventZ _res);
13304 * Creates a new COption_EventZ which has the same data as `orig`
13305 * but with all dynamically-allocated buffers duplicated in new buffers.
13307 struct LDKCOption_EventZ COption_EventZ_clone(const struct LDKCOption_EventZ *NONNULL_PTR orig);
13310 * Creates a new CResult_COption_EventZDecodeErrorZ in the success state.
13312 struct LDKCResult_COption_EventZDecodeErrorZ CResult_COption_EventZDecodeErrorZ_ok(struct LDKCOption_EventZ o);
13315 * Creates a new CResult_COption_EventZDecodeErrorZ in the error state.
13317 struct LDKCResult_COption_EventZDecodeErrorZ CResult_COption_EventZDecodeErrorZ_err(struct LDKDecodeError e);
13320 * Checks if the given object is currently in the success state
13322 bool CResult_COption_EventZDecodeErrorZ_is_ok(const struct LDKCResult_COption_EventZDecodeErrorZ *NONNULL_PTR o);
13325 * Frees any resources used by the CResult_COption_EventZDecodeErrorZ.
13327 void CResult_COption_EventZDecodeErrorZ_free(struct LDKCResult_COption_EventZDecodeErrorZ _res);
13330 * Creates a new CResult_COption_EventZDecodeErrorZ which has the same data as `orig`
13331 * but with all dynamically-allocated buffers duplicated in new buffers.
13333 struct LDKCResult_COption_EventZDecodeErrorZ CResult_COption_EventZDecodeErrorZ_clone(const struct LDKCResult_COption_EventZDecodeErrorZ *NONNULL_PTR orig);
13336 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13338 void CVec_MessageSendEventZ_free(struct LDKCVec_MessageSendEventZ _res);
13341 * Creates a new CResult_FixedPenaltyScorerDecodeErrorZ in the success state.
13343 struct LDKCResult_FixedPenaltyScorerDecodeErrorZ CResult_FixedPenaltyScorerDecodeErrorZ_ok(struct LDKFixedPenaltyScorer o);
13346 * Creates a new CResult_FixedPenaltyScorerDecodeErrorZ in the error state.
13348 struct LDKCResult_FixedPenaltyScorerDecodeErrorZ CResult_FixedPenaltyScorerDecodeErrorZ_err(struct LDKDecodeError e);
13351 * Checks if the given object is currently in the success state
13353 bool CResult_FixedPenaltyScorerDecodeErrorZ_is_ok(const struct LDKCResult_FixedPenaltyScorerDecodeErrorZ *NONNULL_PTR o);
13356 * Frees any resources used by the CResult_FixedPenaltyScorerDecodeErrorZ.
13358 void CResult_FixedPenaltyScorerDecodeErrorZ_free(struct LDKCResult_FixedPenaltyScorerDecodeErrorZ _res);
13361 * Creates a new CResult_FixedPenaltyScorerDecodeErrorZ which has the same data as `orig`
13362 * but with all dynamically-allocated buffers duplicated in new buffers.
13364 struct LDKCResult_FixedPenaltyScorerDecodeErrorZ CResult_FixedPenaltyScorerDecodeErrorZ_clone(const struct LDKCResult_FixedPenaltyScorerDecodeErrorZ *NONNULL_PTR orig);
13367 * Creates a new CResult_ScoringParametersDecodeErrorZ in the success state.
13369 struct LDKCResult_ScoringParametersDecodeErrorZ CResult_ScoringParametersDecodeErrorZ_ok(struct LDKScoringParameters o);
13372 * Creates a new CResult_ScoringParametersDecodeErrorZ in the error state.
13374 struct LDKCResult_ScoringParametersDecodeErrorZ CResult_ScoringParametersDecodeErrorZ_err(struct LDKDecodeError e);
13377 * Checks if the given object is currently in the success state
13379 bool CResult_ScoringParametersDecodeErrorZ_is_ok(const struct LDKCResult_ScoringParametersDecodeErrorZ *NONNULL_PTR o);
13382 * Frees any resources used by the CResult_ScoringParametersDecodeErrorZ.
13384 void CResult_ScoringParametersDecodeErrorZ_free(struct LDKCResult_ScoringParametersDecodeErrorZ _res);
13387 * Creates a new CResult_ScoringParametersDecodeErrorZ which has the same data as `orig`
13388 * but with all dynamically-allocated buffers duplicated in new buffers.
13390 struct LDKCResult_ScoringParametersDecodeErrorZ CResult_ScoringParametersDecodeErrorZ_clone(const struct LDKCResult_ScoringParametersDecodeErrorZ *NONNULL_PTR orig);
13393 * Creates a new CResult_ScorerDecodeErrorZ in the success state.
13395 struct LDKCResult_ScorerDecodeErrorZ CResult_ScorerDecodeErrorZ_ok(struct LDKScorer o);
13398 * Creates a new CResult_ScorerDecodeErrorZ in the error state.
13400 struct LDKCResult_ScorerDecodeErrorZ CResult_ScorerDecodeErrorZ_err(struct LDKDecodeError e);
13403 * Checks if the given object is currently in the success state
13405 bool CResult_ScorerDecodeErrorZ_is_ok(const struct LDKCResult_ScorerDecodeErrorZ *NONNULL_PTR o);
13408 * Frees any resources used by the CResult_ScorerDecodeErrorZ.
13410 void CResult_ScorerDecodeErrorZ_free(struct LDKCResult_ScorerDecodeErrorZ _res);
13413 * Creates a new CResult_ProbabilisticScorerDecodeErrorZ in the success state.
13415 struct LDKCResult_ProbabilisticScorerDecodeErrorZ CResult_ProbabilisticScorerDecodeErrorZ_ok(struct LDKProbabilisticScorer o);
13418 * Creates a new CResult_ProbabilisticScorerDecodeErrorZ in the error state.
13420 struct LDKCResult_ProbabilisticScorerDecodeErrorZ CResult_ProbabilisticScorerDecodeErrorZ_err(struct LDKDecodeError e);
13423 * Checks if the given object is currently in the success state
13425 bool CResult_ProbabilisticScorerDecodeErrorZ_is_ok(const struct LDKCResult_ProbabilisticScorerDecodeErrorZ *NONNULL_PTR o);
13428 * Frees any resources used by the CResult_ProbabilisticScorerDecodeErrorZ.
13430 void CResult_ProbabilisticScorerDecodeErrorZ_free(struct LDKCResult_ProbabilisticScorerDecodeErrorZ _res);
13433 * Creates a new CResult_InitFeaturesDecodeErrorZ in the success state.
13435 struct LDKCResult_InitFeaturesDecodeErrorZ CResult_InitFeaturesDecodeErrorZ_ok(struct LDKInitFeatures o);
13438 * Creates a new CResult_InitFeaturesDecodeErrorZ in the error state.
13440 struct LDKCResult_InitFeaturesDecodeErrorZ CResult_InitFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
13443 * Checks if the given object is currently in the success state
13445 bool CResult_InitFeaturesDecodeErrorZ_is_ok(const struct LDKCResult_InitFeaturesDecodeErrorZ *NONNULL_PTR o);
13448 * Frees any resources used by the CResult_InitFeaturesDecodeErrorZ.
13450 void CResult_InitFeaturesDecodeErrorZ_free(struct LDKCResult_InitFeaturesDecodeErrorZ _res);
13453 * Creates a new CResult_ChannelFeaturesDecodeErrorZ in the success state.
13455 struct LDKCResult_ChannelFeaturesDecodeErrorZ CResult_ChannelFeaturesDecodeErrorZ_ok(struct LDKChannelFeatures o);
13458 * Creates a new CResult_ChannelFeaturesDecodeErrorZ in the error state.
13460 struct LDKCResult_ChannelFeaturesDecodeErrorZ CResult_ChannelFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
13463 * Checks if the given object is currently in the success state
13465 bool CResult_ChannelFeaturesDecodeErrorZ_is_ok(const struct LDKCResult_ChannelFeaturesDecodeErrorZ *NONNULL_PTR o);
13468 * Frees any resources used by the CResult_ChannelFeaturesDecodeErrorZ.
13470 void CResult_ChannelFeaturesDecodeErrorZ_free(struct LDKCResult_ChannelFeaturesDecodeErrorZ _res);
13473 * Creates a new CResult_NodeFeaturesDecodeErrorZ in the success state.
13475 struct LDKCResult_NodeFeaturesDecodeErrorZ CResult_NodeFeaturesDecodeErrorZ_ok(struct LDKNodeFeatures o);
13478 * Creates a new CResult_NodeFeaturesDecodeErrorZ in the error state.
13480 struct LDKCResult_NodeFeaturesDecodeErrorZ CResult_NodeFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
13483 * Checks if the given object is currently in the success state
13485 bool CResult_NodeFeaturesDecodeErrorZ_is_ok(const struct LDKCResult_NodeFeaturesDecodeErrorZ *NONNULL_PTR o);
13488 * Frees any resources used by the CResult_NodeFeaturesDecodeErrorZ.
13490 void CResult_NodeFeaturesDecodeErrorZ_free(struct LDKCResult_NodeFeaturesDecodeErrorZ _res);
13493 * Creates a new CResult_InvoiceFeaturesDecodeErrorZ in the success state.
13495 struct LDKCResult_InvoiceFeaturesDecodeErrorZ CResult_InvoiceFeaturesDecodeErrorZ_ok(struct LDKInvoiceFeatures o);
13498 * Creates a new CResult_InvoiceFeaturesDecodeErrorZ in the error state.
13500 struct LDKCResult_InvoiceFeaturesDecodeErrorZ CResult_InvoiceFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
13503 * Checks if the given object is currently in the success state
13505 bool CResult_InvoiceFeaturesDecodeErrorZ_is_ok(const struct LDKCResult_InvoiceFeaturesDecodeErrorZ *NONNULL_PTR o);
13508 * Frees any resources used by the CResult_InvoiceFeaturesDecodeErrorZ.
13510 void CResult_InvoiceFeaturesDecodeErrorZ_free(struct LDKCResult_InvoiceFeaturesDecodeErrorZ _res);
13513 * Creates a new CResult_ChannelTypeFeaturesDecodeErrorZ in the success state.
13515 struct LDKCResult_ChannelTypeFeaturesDecodeErrorZ CResult_ChannelTypeFeaturesDecodeErrorZ_ok(struct LDKChannelTypeFeatures o);
13518 * Creates a new CResult_ChannelTypeFeaturesDecodeErrorZ in the error state.
13520 struct LDKCResult_ChannelTypeFeaturesDecodeErrorZ CResult_ChannelTypeFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
13523 * Checks if the given object is currently in the success state
13525 bool CResult_ChannelTypeFeaturesDecodeErrorZ_is_ok(const struct LDKCResult_ChannelTypeFeaturesDecodeErrorZ *NONNULL_PTR o);
13528 * Frees any resources used by the CResult_ChannelTypeFeaturesDecodeErrorZ.
13530 void CResult_ChannelTypeFeaturesDecodeErrorZ_free(struct LDKCResult_ChannelTypeFeaturesDecodeErrorZ _res);
13533 * Creates a new CResult_DelayedPaymentOutputDescriptorDecodeErrorZ in the success state.
13535 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_ok(struct LDKDelayedPaymentOutputDescriptor o);
13538 * Creates a new CResult_DelayedPaymentOutputDescriptorDecodeErrorZ in the error state.
13540 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e);
13543 * Checks if the given object is currently in the success state
13545 bool CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_is_ok(const struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ *NONNULL_PTR o);
13548 * Frees any resources used by the CResult_DelayedPaymentOutputDescriptorDecodeErrorZ.
13550 void CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_free(struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ _res);
13553 * Creates a new CResult_DelayedPaymentOutputDescriptorDecodeErrorZ which has the same data as `orig`
13554 * but with all dynamically-allocated buffers duplicated in new buffers.
13556 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ *NONNULL_PTR orig);
13559 * Creates a new CResult_StaticPaymentOutputDescriptorDecodeErrorZ in the success state.
13561 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ CResult_StaticPaymentOutputDescriptorDecodeErrorZ_ok(struct LDKStaticPaymentOutputDescriptor o);
13564 * Creates a new CResult_StaticPaymentOutputDescriptorDecodeErrorZ in the error state.
13566 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ CResult_StaticPaymentOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e);
13569 * Checks if the given object is currently in the success state
13571 bool CResult_StaticPaymentOutputDescriptorDecodeErrorZ_is_ok(const struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ *NONNULL_PTR o);
13574 * Frees any resources used by the CResult_StaticPaymentOutputDescriptorDecodeErrorZ.
13576 void CResult_StaticPaymentOutputDescriptorDecodeErrorZ_free(struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ _res);
13579 * Creates a new CResult_StaticPaymentOutputDescriptorDecodeErrorZ which has the same data as `orig`
13580 * but with all dynamically-allocated buffers duplicated in new buffers.
13582 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ CResult_StaticPaymentOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ *NONNULL_PTR orig);
13585 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ in the success state.
13587 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_ok(struct LDKSpendableOutputDescriptor o);
13590 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ in the error state.
13592 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e);
13595 * Checks if the given object is currently in the success state
13597 bool CResult_SpendableOutputDescriptorDecodeErrorZ_is_ok(const struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ *NONNULL_PTR o);
13600 * Frees any resources used by the CResult_SpendableOutputDescriptorDecodeErrorZ.
13602 void CResult_SpendableOutputDescriptorDecodeErrorZ_free(struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ _res);
13605 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ which has the same data as `orig`
13606 * but with all dynamically-allocated buffers duplicated in new buffers.
13608 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ *NONNULL_PTR orig);
13611 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13613 void CVec_PaymentPreimageZ_free(struct LDKCVec_PaymentPreimageZ _res);
13616 * Creates a new tuple which has the same data as `orig`
13617 * but with all dynamically-allocated buffers duplicated in new buffers.
13619 struct LDKC2Tuple_SignatureCVec_SignatureZZ C2Tuple_SignatureCVec_SignatureZZ_clone(const struct LDKC2Tuple_SignatureCVec_SignatureZZ *NONNULL_PTR orig);
13622 * Creates a new C2Tuple_SignatureCVec_SignatureZZ from the contained elements.
13624 struct LDKC2Tuple_SignatureCVec_SignatureZZ C2Tuple_SignatureCVec_SignatureZZ_new(struct LDKSignature a, struct LDKCVec_SignatureZ b);
13627 * Frees any resources used by the C2Tuple_SignatureCVec_SignatureZZ.
13629 void C2Tuple_SignatureCVec_SignatureZZ_free(struct LDKC2Tuple_SignatureCVec_SignatureZZ _res);
13632 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ in the success state.
13634 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_ok(struct LDKC2Tuple_SignatureCVec_SignatureZZ o);
13637 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ in the error state.
13639 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_err(void);
13642 * Checks if the given object is currently in the success state
13644 bool CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_is_ok(const struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ *NONNULL_PTR o);
13647 * Frees any resources used by the CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ.
13649 void CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_free(struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ _res);
13652 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ which has the same data as `orig`
13653 * but with all dynamically-allocated buffers duplicated in new buffers.
13655 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_clone(const struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ *NONNULL_PTR orig);
13658 * Creates a new CResult_SignatureNoneZ in the success state.
13660 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_ok(struct LDKSignature o);
13663 * Creates a new CResult_SignatureNoneZ in the error state.
13665 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_err(void);
13668 * Checks if the given object is currently in the success state
13670 bool CResult_SignatureNoneZ_is_ok(const struct LDKCResult_SignatureNoneZ *NONNULL_PTR o);
13673 * Frees any resources used by the CResult_SignatureNoneZ.
13675 void CResult_SignatureNoneZ_free(struct LDKCResult_SignatureNoneZ _res);
13678 * Creates a new CResult_SignatureNoneZ which has the same data as `orig`
13679 * but with all dynamically-allocated buffers duplicated in new buffers.
13681 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_clone(const struct LDKCResult_SignatureNoneZ *NONNULL_PTR orig);
13684 * Creates a new tuple which has the same data as `orig`
13685 * but with all dynamically-allocated buffers duplicated in new buffers.
13687 struct LDKC2Tuple_SignatureSignatureZ C2Tuple_SignatureSignatureZ_clone(const struct LDKC2Tuple_SignatureSignatureZ *NONNULL_PTR orig);
13690 * Creates a new C2Tuple_SignatureSignatureZ from the contained elements.
13692 struct LDKC2Tuple_SignatureSignatureZ C2Tuple_SignatureSignatureZ_new(struct LDKSignature a, struct LDKSignature b);
13695 * Frees any resources used by the C2Tuple_SignatureSignatureZ.
13697 void C2Tuple_SignatureSignatureZ_free(struct LDKC2Tuple_SignatureSignatureZ _res);
13700 * Creates a new CResult_C2Tuple_SignatureSignatureZNoneZ in the success state.
13702 struct LDKCResult_C2Tuple_SignatureSignatureZNoneZ CResult_C2Tuple_SignatureSignatureZNoneZ_ok(struct LDKC2Tuple_SignatureSignatureZ o);
13705 * Creates a new CResult_C2Tuple_SignatureSignatureZNoneZ in the error state.
13707 struct LDKCResult_C2Tuple_SignatureSignatureZNoneZ CResult_C2Tuple_SignatureSignatureZNoneZ_err(void);
13710 * Checks if the given object is currently in the success state
13712 bool CResult_C2Tuple_SignatureSignatureZNoneZ_is_ok(const struct LDKCResult_C2Tuple_SignatureSignatureZNoneZ *NONNULL_PTR o);
13715 * Frees any resources used by the CResult_C2Tuple_SignatureSignatureZNoneZ.
13717 void CResult_C2Tuple_SignatureSignatureZNoneZ_free(struct LDKCResult_C2Tuple_SignatureSignatureZNoneZ _res);
13720 * Creates a new CResult_C2Tuple_SignatureSignatureZNoneZ which has the same data as `orig`
13721 * but with all dynamically-allocated buffers duplicated in new buffers.
13723 struct LDKCResult_C2Tuple_SignatureSignatureZNoneZ CResult_C2Tuple_SignatureSignatureZNoneZ_clone(const struct LDKCResult_C2Tuple_SignatureSignatureZNoneZ *NONNULL_PTR orig);
13726 * Creates a new CResult_SecretKeyNoneZ in the success state.
13728 struct LDKCResult_SecretKeyNoneZ CResult_SecretKeyNoneZ_ok(struct LDKSecretKey o);
13731 * Creates a new CResult_SecretKeyNoneZ in the error state.
13733 struct LDKCResult_SecretKeyNoneZ CResult_SecretKeyNoneZ_err(void);
13736 * Checks if the given object is currently in the success state
13738 bool CResult_SecretKeyNoneZ_is_ok(const struct LDKCResult_SecretKeyNoneZ *NONNULL_PTR o);
13741 * Frees any resources used by the CResult_SecretKeyNoneZ.
13743 void CResult_SecretKeyNoneZ_free(struct LDKCResult_SecretKeyNoneZ _res);
13746 * Creates a new CResult_SecretKeyNoneZ which has the same data as `orig`
13747 * but with all dynamically-allocated buffers duplicated in new buffers.
13749 struct LDKCResult_SecretKeyNoneZ CResult_SecretKeyNoneZ_clone(const struct LDKCResult_SecretKeyNoneZ *NONNULL_PTR orig);
13752 * Creates a new CResult_SignDecodeErrorZ in the success state.
13754 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_ok(struct LDKSign o);
13757 * Creates a new CResult_SignDecodeErrorZ in the error state.
13759 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_err(struct LDKDecodeError e);
13762 * Checks if the given object is currently in the success state
13764 bool CResult_SignDecodeErrorZ_is_ok(const struct LDKCResult_SignDecodeErrorZ *NONNULL_PTR o);
13767 * Frees any resources used by the CResult_SignDecodeErrorZ.
13769 void CResult_SignDecodeErrorZ_free(struct LDKCResult_SignDecodeErrorZ _res);
13772 * Creates a new CResult_SignDecodeErrorZ which has the same data as `orig`
13773 * but with all dynamically-allocated buffers duplicated in new buffers.
13775 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_clone(const struct LDKCResult_SignDecodeErrorZ *NONNULL_PTR orig);
13778 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13780 void CVec_u5Z_free(struct LDKCVec_u5Z _res);
13783 * Creates a new CResult_RecoverableSignatureNoneZ in the success state.
13785 struct LDKCResult_RecoverableSignatureNoneZ CResult_RecoverableSignatureNoneZ_ok(struct LDKRecoverableSignature o);
13788 * Creates a new CResult_RecoverableSignatureNoneZ in the error state.
13790 struct LDKCResult_RecoverableSignatureNoneZ CResult_RecoverableSignatureNoneZ_err(void);
13793 * Checks if the given object is currently in the success state
13795 bool CResult_RecoverableSignatureNoneZ_is_ok(const struct LDKCResult_RecoverableSignatureNoneZ *NONNULL_PTR o);
13798 * Frees any resources used by the CResult_RecoverableSignatureNoneZ.
13800 void CResult_RecoverableSignatureNoneZ_free(struct LDKCResult_RecoverableSignatureNoneZ _res);
13803 * Creates a new CResult_RecoverableSignatureNoneZ which has the same data as `orig`
13804 * but with all dynamically-allocated buffers duplicated in new buffers.
13806 struct LDKCResult_RecoverableSignatureNoneZ CResult_RecoverableSignatureNoneZ_clone(const struct LDKCResult_RecoverableSignatureNoneZ *NONNULL_PTR orig);
13809 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13811 void CVec_u8Z_free(struct LDKCVec_u8Z _res);
13814 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13816 void CVec_CVec_u8ZZ_free(struct LDKCVec_CVec_u8ZZ _res);
13819 * Creates a new CResult_CVec_CVec_u8ZZNoneZ in the success state.
13821 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_ok(struct LDKCVec_CVec_u8ZZ o);
13824 * Creates a new CResult_CVec_CVec_u8ZZNoneZ in the error state.
13826 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_err(void);
13829 * Checks if the given object is currently in the success state
13831 bool CResult_CVec_CVec_u8ZZNoneZ_is_ok(const struct LDKCResult_CVec_CVec_u8ZZNoneZ *NONNULL_PTR o);
13834 * Frees any resources used by the CResult_CVec_CVec_u8ZZNoneZ.
13836 void CResult_CVec_CVec_u8ZZNoneZ_free(struct LDKCResult_CVec_CVec_u8ZZNoneZ _res);
13839 * Creates a new CResult_CVec_CVec_u8ZZNoneZ which has the same data as `orig`
13840 * but with all dynamically-allocated buffers duplicated in new buffers.
13842 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_clone(const struct LDKCResult_CVec_CVec_u8ZZNoneZ *NONNULL_PTR orig);
13845 * Creates a new CResult_InMemorySignerDecodeErrorZ in the success state.
13847 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_ok(struct LDKInMemorySigner o);
13850 * Creates a new CResult_InMemorySignerDecodeErrorZ in the error state.
13852 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_err(struct LDKDecodeError e);
13855 * Checks if the given object is currently in the success state
13857 bool CResult_InMemorySignerDecodeErrorZ_is_ok(const struct LDKCResult_InMemorySignerDecodeErrorZ *NONNULL_PTR o);
13860 * Frees any resources used by the CResult_InMemorySignerDecodeErrorZ.
13862 void CResult_InMemorySignerDecodeErrorZ_free(struct LDKCResult_InMemorySignerDecodeErrorZ _res);
13865 * Creates a new CResult_InMemorySignerDecodeErrorZ which has the same data as `orig`
13866 * but with all dynamically-allocated buffers duplicated in new buffers.
13868 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_clone(const struct LDKCResult_InMemorySignerDecodeErrorZ *NONNULL_PTR orig);
13871 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13873 void CVec_TxOutZ_free(struct LDKCVec_TxOutZ _res);
13876 * Creates a new CResult_TransactionNoneZ in the success state.
13878 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_ok(struct LDKTransaction o);
13881 * Creates a new CResult_TransactionNoneZ in the error state.
13883 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_err(void);
13886 * Checks if the given object is currently in the success state
13888 bool CResult_TransactionNoneZ_is_ok(const struct LDKCResult_TransactionNoneZ *NONNULL_PTR o);
13891 * Frees any resources used by the CResult_TransactionNoneZ.
13893 void CResult_TransactionNoneZ_free(struct LDKCResult_TransactionNoneZ _res);
13896 * Creates a new CResult_TransactionNoneZ which has the same data as `orig`
13897 * but with all dynamically-allocated buffers duplicated in new buffers.
13899 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_clone(const struct LDKCResult_TransactionNoneZ *NONNULL_PTR orig);
13902 * Creates a new C2Tuple_BlockHashChannelMonitorZ from the contained elements.
13904 struct LDKC2Tuple_BlockHashChannelMonitorZ C2Tuple_BlockHashChannelMonitorZ_new(struct LDKThirtyTwoBytes a, struct LDKChannelMonitor b);
13907 * Frees any resources used by the C2Tuple_BlockHashChannelMonitorZ.
13909 void C2Tuple_BlockHashChannelMonitorZ_free(struct LDKC2Tuple_BlockHashChannelMonitorZ _res);
13912 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13914 void CVec_C2Tuple_BlockHashChannelMonitorZZ_free(struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ _res);
13917 * Creates a new CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ in the success state.
13919 struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_ok(struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ o);
13922 * Creates a new CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ in the error state.
13924 struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_err(enum LDKIOError e);
13927 * Checks if the given object is currently in the success state
13929 bool CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_is_ok(const struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ *NONNULL_PTR o);
13932 * Frees any resources used by the CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ.
13934 void CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_free(struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ _res);
13937 * Constructs a new COption_u16Z containing a u16
13939 struct LDKCOption_u16Z COption_u16Z_some(uint16_t o);
13942 * Constructs a new COption_u16Z containing nothing
13944 struct LDKCOption_u16Z COption_u16Z_none(void);
13947 * Frees any resources associated with the u16, if we are in the Some state
13949 void COption_u16Z_free(struct LDKCOption_u16Z _res);
13952 * Creates a new COption_u16Z which has the same data as `orig`
13953 * but with all dynamically-allocated buffers duplicated in new buffers.
13955 struct LDKCOption_u16Z COption_u16Z_clone(const struct LDKCOption_u16Z *NONNULL_PTR orig);
13958 * Creates a new CResult_NoneAPIErrorZ in the success state.
13960 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_ok(void);
13963 * Creates a new CResult_NoneAPIErrorZ in the error state.
13965 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_err(struct LDKAPIError e);
13968 * Checks if the given object is currently in the success state
13970 bool CResult_NoneAPIErrorZ_is_ok(const struct LDKCResult_NoneAPIErrorZ *NONNULL_PTR o);
13973 * Frees any resources used by the CResult_NoneAPIErrorZ.
13975 void CResult_NoneAPIErrorZ_free(struct LDKCResult_NoneAPIErrorZ _res);
13978 * Creates a new CResult_NoneAPIErrorZ which has the same data as `orig`
13979 * but with all dynamically-allocated buffers duplicated in new buffers.
13981 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_clone(const struct LDKCResult_NoneAPIErrorZ *NONNULL_PTR orig);
13984 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13986 void CVec_CResult_NoneAPIErrorZZ_free(struct LDKCVec_CResult_NoneAPIErrorZZ _res);
13989 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13991 void CVec_APIErrorZ_free(struct LDKCVec_APIErrorZ _res);
13994 * Creates a new CResult__u832APIErrorZ in the success state.
13996 struct LDKCResult__u832APIErrorZ CResult__u832APIErrorZ_ok(struct LDKThirtyTwoBytes o);
13999 * Creates a new CResult__u832APIErrorZ in the error state.
14001 struct LDKCResult__u832APIErrorZ CResult__u832APIErrorZ_err(struct LDKAPIError e);
14004 * Checks if the given object is currently in the success state
14006 bool CResult__u832APIErrorZ_is_ok(const struct LDKCResult__u832APIErrorZ *NONNULL_PTR o);
14009 * Frees any resources used by the CResult__u832APIErrorZ.
14011 void CResult__u832APIErrorZ_free(struct LDKCResult__u832APIErrorZ _res);
14014 * Creates a new CResult__u832APIErrorZ which has the same data as `orig`
14015 * but with all dynamically-allocated buffers duplicated in new buffers.
14017 struct LDKCResult__u832APIErrorZ CResult__u832APIErrorZ_clone(const struct LDKCResult__u832APIErrorZ *NONNULL_PTR orig);
14020 * Creates a new CResult_PaymentIdPaymentSendFailureZ in the success state.
14022 struct LDKCResult_PaymentIdPaymentSendFailureZ CResult_PaymentIdPaymentSendFailureZ_ok(struct LDKThirtyTwoBytes o);
14025 * Creates a new CResult_PaymentIdPaymentSendFailureZ in the error state.
14027 struct LDKCResult_PaymentIdPaymentSendFailureZ CResult_PaymentIdPaymentSendFailureZ_err(struct LDKPaymentSendFailure e);
14030 * Checks if the given object is currently in the success state
14032 bool CResult_PaymentIdPaymentSendFailureZ_is_ok(const struct LDKCResult_PaymentIdPaymentSendFailureZ *NONNULL_PTR o);
14035 * Frees any resources used by the CResult_PaymentIdPaymentSendFailureZ.
14037 void CResult_PaymentIdPaymentSendFailureZ_free(struct LDKCResult_PaymentIdPaymentSendFailureZ _res);
14040 * Creates a new CResult_PaymentIdPaymentSendFailureZ which has the same data as `orig`
14041 * but with all dynamically-allocated buffers duplicated in new buffers.
14043 struct LDKCResult_PaymentIdPaymentSendFailureZ CResult_PaymentIdPaymentSendFailureZ_clone(const struct LDKCResult_PaymentIdPaymentSendFailureZ *NONNULL_PTR orig);
14046 * Creates a new CResult_NonePaymentSendFailureZ in the success state.
14048 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_ok(void);
14051 * Creates a new CResult_NonePaymentSendFailureZ in the error state.
14053 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_err(struct LDKPaymentSendFailure e);
14056 * Checks if the given object is currently in the success state
14058 bool CResult_NonePaymentSendFailureZ_is_ok(const struct LDKCResult_NonePaymentSendFailureZ *NONNULL_PTR o);
14061 * Frees any resources used by the CResult_NonePaymentSendFailureZ.
14063 void CResult_NonePaymentSendFailureZ_free(struct LDKCResult_NonePaymentSendFailureZ _res);
14066 * Creates a new CResult_NonePaymentSendFailureZ which has the same data as `orig`
14067 * but with all dynamically-allocated buffers duplicated in new buffers.
14069 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_clone(const struct LDKCResult_NonePaymentSendFailureZ *NONNULL_PTR orig);
14072 * Creates a new tuple which has the same data as `orig`
14073 * but with all dynamically-allocated buffers duplicated in new buffers.
14075 struct LDKC2Tuple_PaymentHashPaymentIdZ C2Tuple_PaymentHashPaymentIdZ_clone(const struct LDKC2Tuple_PaymentHashPaymentIdZ *NONNULL_PTR orig);
14078 * Creates a new C2Tuple_PaymentHashPaymentIdZ from the contained elements.
14080 struct LDKC2Tuple_PaymentHashPaymentIdZ C2Tuple_PaymentHashPaymentIdZ_new(struct LDKThirtyTwoBytes a, struct LDKThirtyTwoBytes b);
14083 * Frees any resources used by the C2Tuple_PaymentHashPaymentIdZ.
14085 void C2Tuple_PaymentHashPaymentIdZ_free(struct LDKC2Tuple_PaymentHashPaymentIdZ _res);
14088 * Creates a new CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ in the success state.
14090 struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ_ok(struct LDKC2Tuple_PaymentHashPaymentIdZ o);
14093 * Creates a new CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ in the error state.
14095 struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ_err(struct LDKPaymentSendFailure e);
14098 * Checks if the given object is currently in the success state
14100 bool CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ_is_ok(const struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ *NONNULL_PTR o);
14103 * Frees any resources used by the CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ.
14105 void CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ_free(struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ _res);
14108 * Creates a new CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ which has the same data as `orig`
14109 * but with all dynamically-allocated buffers duplicated in new buffers.
14111 struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ_clone(const struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ *NONNULL_PTR orig);
14114 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14116 void CVec_NetAddressZ_free(struct LDKCVec_NetAddressZ _res);
14119 * Creates a new tuple which has the same data as `orig`
14120 * but with all dynamically-allocated buffers duplicated in new buffers.
14122 struct LDKC2Tuple_PaymentHashPaymentSecretZ C2Tuple_PaymentHashPaymentSecretZ_clone(const struct LDKC2Tuple_PaymentHashPaymentSecretZ *NONNULL_PTR orig);
14125 * Creates a new C2Tuple_PaymentHashPaymentSecretZ from the contained elements.
14127 struct LDKC2Tuple_PaymentHashPaymentSecretZ C2Tuple_PaymentHashPaymentSecretZ_new(struct LDKThirtyTwoBytes a, struct LDKThirtyTwoBytes b);
14130 * Frees any resources used by the C2Tuple_PaymentHashPaymentSecretZ.
14132 void C2Tuple_PaymentHashPaymentSecretZ_free(struct LDKC2Tuple_PaymentHashPaymentSecretZ _res);
14135 * Creates a new CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ in the success state.
14137 struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ_ok(struct LDKC2Tuple_PaymentHashPaymentSecretZ o);
14140 * Creates a new CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ in the error state.
14142 struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ_err(void);
14145 * Checks if the given object is currently in the success state
14147 bool CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ_is_ok(const struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ *NONNULL_PTR o);
14150 * Frees any resources used by the CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ.
14152 void CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ_free(struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ _res);
14155 * Creates a new CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ which has the same data as `orig`
14156 * but with all dynamically-allocated buffers duplicated in new buffers.
14158 struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ CResult_C2Tuple_PaymentHashPaymentSecretZNoneZ_clone(const struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZNoneZ *NONNULL_PTR orig);
14161 * Creates a new CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ in the success state.
14163 struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ_ok(struct LDKC2Tuple_PaymentHashPaymentSecretZ o);
14166 * Creates a new CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ in the error state.
14168 struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ_err(struct LDKAPIError e);
14171 * Checks if the given object is currently in the success state
14173 bool CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ_is_ok(const struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ *NONNULL_PTR o);
14176 * Frees any resources used by the CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ.
14178 void CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ_free(struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ _res);
14181 * Creates a new CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ which has the same data as `orig`
14182 * but with all dynamically-allocated buffers duplicated in new buffers.
14184 struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ CResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ_clone(const struct LDKCResult_C2Tuple_PaymentHashPaymentSecretZAPIErrorZ *NONNULL_PTR orig);
14187 * Creates a new CResult_PaymentSecretNoneZ in the success state.
14189 struct LDKCResult_PaymentSecretNoneZ CResult_PaymentSecretNoneZ_ok(struct LDKThirtyTwoBytes o);
14192 * Creates a new CResult_PaymentSecretNoneZ in the error state.
14194 struct LDKCResult_PaymentSecretNoneZ CResult_PaymentSecretNoneZ_err(void);
14197 * Checks if the given object is currently in the success state
14199 bool CResult_PaymentSecretNoneZ_is_ok(const struct LDKCResult_PaymentSecretNoneZ *NONNULL_PTR o);
14202 * Frees any resources used by the CResult_PaymentSecretNoneZ.
14204 void CResult_PaymentSecretNoneZ_free(struct LDKCResult_PaymentSecretNoneZ _res);
14207 * Creates a new CResult_PaymentSecretNoneZ which has the same data as `orig`
14208 * but with all dynamically-allocated buffers duplicated in new buffers.
14210 struct LDKCResult_PaymentSecretNoneZ CResult_PaymentSecretNoneZ_clone(const struct LDKCResult_PaymentSecretNoneZ *NONNULL_PTR orig);
14213 * Creates a new CResult_PaymentSecretAPIErrorZ in the success state.
14215 struct LDKCResult_PaymentSecretAPIErrorZ CResult_PaymentSecretAPIErrorZ_ok(struct LDKThirtyTwoBytes o);
14218 * Creates a new CResult_PaymentSecretAPIErrorZ in the error state.
14220 struct LDKCResult_PaymentSecretAPIErrorZ CResult_PaymentSecretAPIErrorZ_err(struct LDKAPIError e);
14223 * Checks if the given object is currently in the success state
14225 bool CResult_PaymentSecretAPIErrorZ_is_ok(const struct LDKCResult_PaymentSecretAPIErrorZ *NONNULL_PTR o);
14228 * Frees any resources used by the CResult_PaymentSecretAPIErrorZ.
14230 void CResult_PaymentSecretAPIErrorZ_free(struct LDKCResult_PaymentSecretAPIErrorZ _res);
14233 * Creates a new CResult_PaymentSecretAPIErrorZ which has the same data as `orig`
14234 * but with all dynamically-allocated buffers duplicated in new buffers.
14236 struct LDKCResult_PaymentSecretAPIErrorZ CResult_PaymentSecretAPIErrorZ_clone(const struct LDKCResult_PaymentSecretAPIErrorZ *NONNULL_PTR orig);
14239 * Creates a new CResult_PaymentPreimageAPIErrorZ in the success state.
14241 struct LDKCResult_PaymentPreimageAPIErrorZ CResult_PaymentPreimageAPIErrorZ_ok(struct LDKThirtyTwoBytes o);
14244 * Creates a new CResult_PaymentPreimageAPIErrorZ in the error state.
14246 struct LDKCResult_PaymentPreimageAPIErrorZ CResult_PaymentPreimageAPIErrorZ_err(struct LDKAPIError e);
14249 * Checks if the given object is currently in the success state
14251 bool CResult_PaymentPreimageAPIErrorZ_is_ok(const struct LDKCResult_PaymentPreimageAPIErrorZ *NONNULL_PTR o);
14254 * Frees any resources used by the CResult_PaymentPreimageAPIErrorZ.
14256 void CResult_PaymentPreimageAPIErrorZ_free(struct LDKCResult_PaymentPreimageAPIErrorZ _res);
14259 * Creates a new CResult_PaymentPreimageAPIErrorZ which has the same data as `orig`
14260 * but with all dynamically-allocated buffers duplicated in new buffers.
14262 struct LDKCResult_PaymentPreimageAPIErrorZ CResult_PaymentPreimageAPIErrorZ_clone(const struct LDKCResult_PaymentPreimageAPIErrorZ *NONNULL_PTR orig);
14265 * Creates a new CResult_CounterpartyForwardingInfoDecodeErrorZ in the success state.
14267 struct LDKCResult_CounterpartyForwardingInfoDecodeErrorZ CResult_CounterpartyForwardingInfoDecodeErrorZ_ok(struct LDKCounterpartyForwardingInfo o);
14270 * Creates a new CResult_CounterpartyForwardingInfoDecodeErrorZ in the error state.
14272 struct LDKCResult_CounterpartyForwardingInfoDecodeErrorZ CResult_CounterpartyForwardingInfoDecodeErrorZ_err(struct LDKDecodeError e);
14275 * Checks if the given object is currently in the success state
14277 bool CResult_CounterpartyForwardingInfoDecodeErrorZ_is_ok(const struct LDKCResult_CounterpartyForwardingInfoDecodeErrorZ *NONNULL_PTR o);
14280 * Frees any resources used by the CResult_CounterpartyForwardingInfoDecodeErrorZ.
14282 void CResult_CounterpartyForwardingInfoDecodeErrorZ_free(struct LDKCResult_CounterpartyForwardingInfoDecodeErrorZ _res);
14285 * Creates a new CResult_CounterpartyForwardingInfoDecodeErrorZ which has the same data as `orig`
14286 * but with all dynamically-allocated buffers duplicated in new buffers.
14288 struct LDKCResult_CounterpartyForwardingInfoDecodeErrorZ CResult_CounterpartyForwardingInfoDecodeErrorZ_clone(const struct LDKCResult_CounterpartyForwardingInfoDecodeErrorZ *NONNULL_PTR orig);
14291 * Creates a new CResult_ChannelCounterpartyDecodeErrorZ in the success state.
14293 struct LDKCResult_ChannelCounterpartyDecodeErrorZ CResult_ChannelCounterpartyDecodeErrorZ_ok(struct LDKChannelCounterparty o);
14296 * Creates a new CResult_ChannelCounterpartyDecodeErrorZ in the error state.
14298 struct LDKCResult_ChannelCounterpartyDecodeErrorZ CResult_ChannelCounterpartyDecodeErrorZ_err(struct LDKDecodeError e);
14301 * Checks if the given object is currently in the success state
14303 bool CResult_ChannelCounterpartyDecodeErrorZ_is_ok(const struct LDKCResult_ChannelCounterpartyDecodeErrorZ *NONNULL_PTR o);
14306 * Frees any resources used by the CResult_ChannelCounterpartyDecodeErrorZ.
14308 void CResult_ChannelCounterpartyDecodeErrorZ_free(struct LDKCResult_ChannelCounterpartyDecodeErrorZ _res);
14311 * Creates a new CResult_ChannelCounterpartyDecodeErrorZ which has the same data as `orig`
14312 * but with all dynamically-allocated buffers duplicated in new buffers.
14314 struct LDKCResult_ChannelCounterpartyDecodeErrorZ CResult_ChannelCounterpartyDecodeErrorZ_clone(const struct LDKCResult_ChannelCounterpartyDecodeErrorZ *NONNULL_PTR orig);
14317 * Creates a new CResult_ChannelDetailsDecodeErrorZ in the success state.
14319 struct LDKCResult_ChannelDetailsDecodeErrorZ CResult_ChannelDetailsDecodeErrorZ_ok(struct LDKChannelDetails o);
14322 * Creates a new CResult_ChannelDetailsDecodeErrorZ in the error state.
14324 struct LDKCResult_ChannelDetailsDecodeErrorZ CResult_ChannelDetailsDecodeErrorZ_err(struct LDKDecodeError e);
14327 * Checks if the given object is currently in the success state
14329 bool CResult_ChannelDetailsDecodeErrorZ_is_ok(const struct LDKCResult_ChannelDetailsDecodeErrorZ *NONNULL_PTR o);
14332 * Frees any resources used by the CResult_ChannelDetailsDecodeErrorZ.
14334 void CResult_ChannelDetailsDecodeErrorZ_free(struct LDKCResult_ChannelDetailsDecodeErrorZ _res);
14337 * Creates a new CResult_ChannelDetailsDecodeErrorZ which has the same data as `orig`
14338 * but with all dynamically-allocated buffers duplicated in new buffers.
14340 struct LDKCResult_ChannelDetailsDecodeErrorZ CResult_ChannelDetailsDecodeErrorZ_clone(const struct LDKCResult_ChannelDetailsDecodeErrorZ *NONNULL_PTR orig);
14343 * Creates a new CResult_PhantomRouteHintsDecodeErrorZ in the success state.
14345 struct LDKCResult_PhantomRouteHintsDecodeErrorZ CResult_PhantomRouteHintsDecodeErrorZ_ok(struct LDKPhantomRouteHints o);
14348 * Creates a new CResult_PhantomRouteHintsDecodeErrorZ in the error state.
14350 struct LDKCResult_PhantomRouteHintsDecodeErrorZ CResult_PhantomRouteHintsDecodeErrorZ_err(struct LDKDecodeError e);
14353 * Checks if the given object is currently in the success state
14355 bool CResult_PhantomRouteHintsDecodeErrorZ_is_ok(const struct LDKCResult_PhantomRouteHintsDecodeErrorZ *NONNULL_PTR o);
14358 * Frees any resources used by the CResult_PhantomRouteHintsDecodeErrorZ.
14360 void CResult_PhantomRouteHintsDecodeErrorZ_free(struct LDKCResult_PhantomRouteHintsDecodeErrorZ _res);
14363 * Creates a new CResult_PhantomRouteHintsDecodeErrorZ which has the same data as `orig`
14364 * but with all dynamically-allocated buffers duplicated in new buffers.
14366 struct LDKCResult_PhantomRouteHintsDecodeErrorZ CResult_PhantomRouteHintsDecodeErrorZ_clone(const struct LDKCResult_PhantomRouteHintsDecodeErrorZ *NONNULL_PTR orig);
14369 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14371 void CVec_ChannelMonitorZ_free(struct LDKCVec_ChannelMonitorZ _res);
14374 * Creates a new C2Tuple_BlockHashChannelManagerZ from the contained elements.
14376 struct LDKC2Tuple_BlockHashChannelManagerZ C2Tuple_BlockHashChannelManagerZ_new(struct LDKThirtyTwoBytes a, struct LDKChannelManager b);
14379 * Frees any resources used by the C2Tuple_BlockHashChannelManagerZ.
14381 void C2Tuple_BlockHashChannelManagerZ_free(struct LDKC2Tuple_BlockHashChannelManagerZ _res);
14384 * Creates a new CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ in the success state.
14386 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_ok(struct LDKC2Tuple_BlockHashChannelManagerZ o);
14389 * Creates a new CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ in the error state.
14391 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_err(struct LDKDecodeError e);
14394 * Checks if the given object is currently in the success state
14396 bool CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_is_ok(const struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ *NONNULL_PTR o);
14399 * Frees any resources used by the CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.
14401 void CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_free(struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ _res);
14404 * Creates a new CResult_ChannelConfigDecodeErrorZ in the success state.
14406 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_ok(struct LDKChannelConfig o);
14409 * Creates a new CResult_ChannelConfigDecodeErrorZ in the error state.
14411 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_err(struct LDKDecodeError e);
14414 * Checks if the given object is currently in the success state
14416 bool CResult_ChannelConfigDecodeErrorZ_is_ok(const struct LDKCResult_ChannelConfigDecodeErrorZ *NONNULL_PTR o);
14419 * Frees any resources used by the CResult_ChannelConfigDecodeErrorZ.
14421 void CResult_ChannelConfigDecodeErrorZ_free(struct LDKCResult_ChannelConfigDecodeErrorZ _res);
14424 * Creates a new CResult_ChannelConfigDecodeErrorZ which has the same data as `orig`
14425 * but with all dynamically-allocated buffers duplicated in new buffers.
14427 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_clone(const struct LDKCResult_ChannelConfigDecodeErrorZ *NONNULL_PTR orig);
14430 * Creates a new CResult_OutPointDecodeErrorZ in the success state.
14432 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_ok(struct LDKOutPoint o);
14435 * Creates a new CResult_OutPointDecodeErrorZ in the error state.
14437 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_err(struct LDKDecodeError e);
14440 * Checks if the given object is currently in the success state
14442 bool CResult_OutPointDecodeErrorZ_is_ok(const struct LDKCResult_OutPointDecodeErrorZ *NONNULL_PTR o);
14445 * Frees any resources used by the CResult_OutPointDecodeErrorZ.
14447 void CResult_OutPointDecodeErrorZ_free(struct LDKCResult_OutPointDecodeErrorZ _res);
14450 * Creates a new CResult_OutPointDecodeErrorZ which has the same data as `orig`
14451 * but with all dynamically-allocated buffers duplicated in new buffers.
14453 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_clone(const struct LDKCResult_OutPointDecodeErrorZ *NONNULL_PTR orig);
14456 * Constructs a new COption_TypeZ containing a crate::lightning::ln::wire::Type
14458 struct LDKCOption_TypeZ COption_TypeZ_some(struct LDKType o);
14461 * Constructs a new COption_TypeZ containing nothing
14463 struct LDKCOption_TypeZ COption_TypeZ_none(void);
14466 * Frees any resources associated with the crate::lightning::ln::wire::Type, if we are in the Some state
14468 void COption_TypeZ_free(struct LDKCOption_TypeZ _res);
14471 * Creates a new CResult_COption_TypeZDecodeErrorZ in the success state.
14473 struct LDKCResult_COption_TypeZDecodeErrorZ CResult_COption_TypeZDecodeErrorZ_ok(struct LDKCOption_TypeZ o);
14476 * Creates a new CResult_COption_TypeZDecodeErrorZ in the error state.
14478 struct LDKCResult_COption_TypeZDecodeErrorZ CResult_COption_TypeZDecodeErrorZ_err(struct LDKDecodeError e);
14481 * Checks if the given object is currently in the success state
14483 bool CResult_COption_TypeZDecodeErrorZ_is_ok(const struct LDKCResult_COption_TypeZDecodeErrorZ *NONNULL_PTR o);
14486 * Frees any resources used by the CResult_COption_TypeZDecodeErrorZ.
14488 void CResult_COption_TypeZDecodeErrorZ_free(struct LDKCResult_COption_TypeZDecodeErrorZ _res);
14491 * Creates a new CResult_PaymentIdPaymentErrorZ in the success state.
14493 struct LDKCResult_PaymentIdPaymentErrorZ CResult_PaymentIdPaymentErrorZ_ok(struct LDKThirtyTwoBytes o);
14496 * Creates a new CResult_PaymentIdPaymentErrorZ in the error state.
14498 struct LDKCResult_PaymentIdPaymentErrorZ CResult_PaymentIdPaymentErrorZ_err(struct LDKPaymentError e);
14501 * Checks if the given object is currently in the success state
14503 bool CResult_PaymentIdPaymentErrorZ_is_ok(const struct LDKCResult_PaymentIdPaymentErrorZ *NONNULL_PTR o);
14506 * Frees any resources used by the CResult_PaymentIdPaymentErrorZ.
14508 void CResult_PaymentIdPaymentErrorZ_free(struct LDKCResult_PaymentIdPaymentErrorZ _res);
14511 * Creates a new CResult_PaymentIdPaymentErrorZ which has the same data as `orig`
14512 * but with all dynamically-allocated buffers duplicated in new buffers.
14514 struct LDKCResult_PaymentIdPaymentErrorZ CResult_PaymentIdPaymentErrorZ_clone(const struct LDKCResult_PaymentIdPaymentErrorZ *NONNULL_PTR orig);
14517 * Creates a new CResult_SiPrefixNoneZ in the success state.
14519 struct LDKCResult_SiPrefixNoneZ CResult_SiPrefixNoneZ_ok(enum LDKSiPrefix o);
14522 * Creates a new CResult_SiPrefixNoneZ in the error state.
14524 struct LDKCResult_SiPrefixNoneZ CResult_SiPrefixNoneZ_err(void);
14527 * Checks if the given object is currently in the success state
14529 bool CResult_SiPrefixNoneZ_is_ok(const struct LDKCResult_SiPrefixNoneZ *NONNULL_PTR o);
14532 * Frees any resources used by the CResult_SiPrefixNoneZ.
14534 void CResult_SiPrefixNoneZ_free(struct LDKCResult_SiPrefixNoneZ _res);
14537 * Creates a new CResult_SiPrefixNoneZ which has the same data as `orig`
14538 * but with all dynamically-allocated buffers duplicated in new buffers.
14540 struct LDKCResult_SiPrefixNoneZ CResult_SiPrefixNoneZ_clone(const struct LDKCResult_SiPrefixNoneZ *NONNULL_PTR orig);
14543 * Creates a new CResult_InvoiceNoneZ in the success state.
14545 struct LDKCResult_InvoiceNoneZ CResult_InvoiceNoneZ_ok(struct LDKInvoice o);
14548 * Creates a new CResult_InvoiceNoneZ in the error state.
14550 struct LDKCResult_InvoiceNoneZ CResult_InvoiceNoneZ_err(void);
14553 * Checks if the given object is currently in the success state
14555 bool CResult_InvoiceNoneZ_is_ok(const struct LDKCResult_InvoiceNoneZ *NONNULL_PTR o);
14558 * Frees any resources used by the CResult_InvoiceNoneZ.
14560 void CResult_InvoiceNoneZ_free(struct LDKCResult_InvoiceNoneZ _res);
14563 * Creates a new CResult_InvoiceNoneZ which has the same data as `orig`
14564 * but with all dynamically-allocated buffers duplicated in new buffers.
14566 struct LDKCResult_InvoiceNoneZ CResult_InvoiceNoneZ_clone(const struct LDKCResult_InvoiceNoneZ *NONNULL_PTR orig);
14569 * Creates a new CResult_SignedRawInvoiceNoneZ in the success state.
14571 struct LDKCResult_SignedRawInvoiceNoneZ CResult_SignedRawInvoiceNoneZ_ok(struct LDKSignedRawInvoice o);
14574 * Creates a new CResult_SignedRawInvoiceNoneZ in the error state.
14576 struct LDKCResult_SignedRawInvoiceNoneZ CResult_SignedRawInvoiceNoneZ_err(void);
14579 * Checks if the given object is currently in the success state
14581 bool CResult_SignedRawInvoiceNoneZ_is_ok(const struct LDKCResult_SignedRawInvoiceNoneZ *NONNULL_PTR o);
14584 * Frees any resources used by the CResult_SignedRawInvoiceNoneZ.
14586 void CResult_SignedRawInvoiceNoneZ_free(struct LDKCResult_SignedRawInvoiceNoneZ _res);
14589 * Creates a new CResult_SignedRawInvoiceNoneZ which has the same data as `orig`
14590 * but with all dynamically-allocated buffers duplicated in new buffers.
14592 struct LDKCResult_SignedRawInvoiceNoneZ CResult_SignedRawInvoiceNoneZ_clone(const struct LDKCResult_SignedRawInvoiceNoneZ *NONNULL_PTR orig);
14595 * Creates a new tuple which has the same data as `orig`
14596 * but with all dynamically-allocated buffers duplicated in new buffers.
14598 struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ C3Tuple_RawInvoice_u832InvoiceSignatureZ_clone(const struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ *NONNULL_PTR orig);
14601 * Creates a new C3Tuple_RawInvoice_u832InvoiceSignatureZ from the contained elements.
14603 struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ C3Tuple_RawInvoice_u832InvoiceSignatureZ_new(struct LDKRawInvoice a, struct LDKThirtyTwoBytes b, struct LDKInvoiceSignature c);
14606 * Frees any resources used by the C3Tuple_RawInvoice_u832InvoiceSignatureZ.
14608 void C3Tuple_RawInvoice_u832InvoiceSignatureZ_free(struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ _res);
14611 * Creates a new CResult_PayeePubKeyErrorZ in the success state.
14613 struct LDKCResult_PayeePubKeyErrorZ CResult_PayeePubKeyErrorZ_ok(struct LDKPayeePubKey o);
14616 * Creates a new CResult_PayeePubKeyErrorZ in the error state.
14618 struct LDKCResult_PayeePubKeyErrorZ CResult_PayeePubKeyErrorZ_err(enum LDKSecp256k1Error e);
14621 * Checks if the given object is currently in the success state
14623 bool CResult_PayeePubKeyErrorZ_is_ok(const struct LDKCResult_PayeePubKeyErrorZ *NONNULL_PTR o);
14626 * Frees any resources used by the CResult_PayeePubKeyErrorZ.
14628 void CResult_PayeePubKeyErrorZ_free(struct LDKCResult_PayeePubKeyErrorZ _res);
14631 * Creates a new CResult_PayeePubKeyErrorZ which has the same data as `orig`
14632 * but with all dynamically-allocated buffers duplicated in new buffers.
14634 struct LDKCResult_PayeePubKeyErrorZ CResult_PayeePubKeyErrorZ_clone(const struct LDKCResult_PayeePubKeyErrorZ *NONNULL_PTR orig);
14637 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14639 void CVec_PrivateRouteZ_free(struct LDKCVec_PrivateRouteZ _res);
14642 * Creates a new CResult_PositiveTimestampCreationErrorZ in the success state.
14644 struct LDKCResult_PositiveTimestampCreationErrorZ CResult_PositiveTimestampCreationErrorZ_ok(struct LDKPositiveTimestamp o);
14647 * Creates a new CResult_PositiveTimestampCreationErrorZ in the error state.
14649 struct LDKCResult_PositiveTimestampCreationErrorZ CResult_PositiveTimestampCreationErrorZ_err(enum LDKCreationError e);
14652 * Checks if the given object is currently in the success state
14654 bool CResult_PositiveTimestampCreationErrorZ_is_ok(const struct LDKCResult_PositiveTimestampCreationErrorZ *NONNULL_PTR o);
14657 * Frees any resources used by the CResult_PositiveTimestampCreationErrorZ.
14659 void CResult_PositiveTimestampCreationErrorZ_free(struct LDKCResult_PositiveTimestampCreationErrorZ _res);
14662 * Creates a new CResult_PositiveTimestampCreationErrorZ which has the same data as `orig`
14663 * but with all dynamically-allocated buffers duplicated in new buffers.
14665 struct LDKCResult_PositiveTimestampCreationErrorZ CResult_PositiveTimestampCreationErrorZ_clone(const struct LDKCResult_PositiveTimestampCreationErrorZ *NONNULL_PTR orig);
14668 * Creates a new CResult_NoneSemanticErrorZ in the success state.
14670 struct LDKCResult_NoneSemanticErrorZ CResult_NoneSemanticErrorZ_ok(void);
14673 * Creates a new CResult_NoneSemanticErrorZ in the error state.
14675 struct LDKCResult_NoneSemanticErrorZ CResult_NoneSemanticErrorZ_err(enum LDKSemanticError e);
14678 * Checks if the given object is currently in the success state
14680 bool CResult_NoneSemanticErrorZ_is_ok(const struct LDKCResult_NoneSemanticErrorZ *NONNULL_PTR o);
14683 * Frees any resources used by the CResult_NoneSemanticErrorZ.
14685 void CResult_NoneSemanticErrorZ_free(struct LDKCResult_NoneSemanticErrorZ _res);
14688 * Creates a new CResult_NoneSemanticErrorZ which has the same data as `orig`
14689 * but with all dynamically-allocated buffers duplicated in new buffers.
14691 struct LDKCResult_NoneSemanticErrorZ CResult_NoneSemanticErrorZ_clone(const struct LDKCResult_NoneSemanticErrorZ *NONNULL_PTR orig);
14694 * Creates a new CResult_InvoiceSemanticErrorZ in the success state.
14696 struct LDKCResult_InvoiceSemanticErrorZ CResult_InvoiceSemanticErrorZ_ok(struct LDKInvoice o);
14699 * Creates a new CResult_InvoiceSemanticErrorZ in the error state.
14701 struct LDKCResult_InvoiceSemanticErrorZ CResult_InvoiceSemanticErrorZ_err(enum LDKSemanticError e);
14704 * Checks if the given object is currently in the success state
14706 bool CResult_InvoiceSemanticErrorZ_is_ok(const struct LDKCResult_InvoiceSemanticErrorZ *NONNULL_PTR o);
14709 * Frees any resources used by the CResult_InvoiceSemanticErrorZ.
14711 void CResult_InvoiceSemanticErrorZ_free(struct LDKCResult_InvoiceSemanticErrorZ _res);
14714 * Creates a new CResult_InvoiceSemanticErrorZ which has the same data as `orig`
14715 * but with all dynamically-allocated buffers duplicated in new buffers.
14717 struct LDKCResult_InvoiceSemanticErrorZ CResult_InvoiceSemanticErrorZ_clone(const struct LDKCResult_InvoiceSemanticErrorZ *NONNULL_PTR orig);
14720 * Creates a new CResult_DescriptionCreationErrorZ in the success state.
14722 struct LDKCResult_DescriptionCreationErrorZ CResult_DescriptionCreationErrorZ_ok(struct LDKDescription o);
14725 * Creates a new CResult_DescriptionCreationErrorZ in the error state.
14727 struct LDKCResult_DescriptionCreationErrorZ CResult_DescriptionCreationErrorZ_err(enum LDKCreationError e);
14730 * Checks if the given object is currently in the success state
14732 bool CResult_DescriptionCreationErrorZ_is_ok(const struct LDKCResult_DescriptionCreationErrorZ *NONNULL_PTR o);
14735 * Frees any resources used by the CResult_DescriptionCreationErrorZ.
14737 void CResult_DescriptionCreationErrorZ_free(struct LDKCResult_DescriptionCreationErrorZ _res);
14740 * Creates a new CResult_DescriptionCreationErrorZ which has the same data as `orig`
14741 * but with all dynamically-allocated buffers duplicated in new buffers.
14743 struct LDKCResult_DescriptionCreationErrorZ CResult_DescriptionCreationErrorZ_clone(const struct LDKCResult_DescriptionCreationErrorZ *NONNULL_PTR orig);
14746 * Creates a new CResult_PrivateRouteCreationErrorZ in the success state.
14748 struct LDKCResult_PrivateRouteCreationErrorZ CResult_PrivateRouteCreationErrorZ_ok(struct LDKPrivateRoute o);
14751 * Creates a new CResult_PrivateRouteCreationErrorZ in the error state.
14753 struct LDKCResult_PrivateRouteCreationErrorZ CResult_PrivateRouteCreationErrorZ_err(enum LDKCreationError e);
14756 * Checks if the given object is currently in the success state
14758 bool CResult_PrivateRouteCreationErrorZ_is_ok(const struct LDKCResult_PrivateRouteCreationErrorZ *NONNULL_PTR o);
14761 * Frees any resources used by the CResult_PrivateRouteCreationErrorZ.
14763 void CResult_PrivateRouteCreationErrorZ_free(struct LDKCResult_PrivateRouteCreationErrorZ _res);
14766 * Creates a new CResult_PrivateRouteCreationErrorZ which has the same data as `orig`
14767 * but with all dynamically-allocated buffers duplicated in new buffers.
14769 struct LDKCResult_PrivateRouteCreationErrorZ CResult_PrivateRouteCreationErrorZ_clone(const struct LDKCResult_PrivateRouteCreationErrorZ *NONNULL_PTR orig);
14772 * Creates a new CResult_StringErrorZ in the success state.
14774 struct LDKCResult_StringErrorZ CResult_StringErrorZ_ok(struct LDKStr o);
14777 * Creates a new CResult_StringErrorZ in the error state.
14779 struct LDKCResult_StringErrorZ CResult_StringErrorZ_err(enum LDKSecp256k1Error e);
14782 * Checks if the given object is currently in the success state
14784 bool CResult_StringErrorZ_is_ok(const struct LDKCResult_StringErrorZ *NONNULL_PTR o);
14787 * Frees any resources used by the CResult_StringErrorZ.
14789 void CResult_StringErrorZ_free(struct LDKCResult_StringErrorZ _res);
14792 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ in the success state.
14794 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_ok(struct LDKChannelMonitorUpdate o);
14797 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ in the error state.
14799 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_err(struct LDKDecodeError e);
14802 * Checks if the given object is currently in the success state
14804 bool CResult_ChannelMonitorUpdateDecodeErrorZ_is_ok(const struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ *NONNULL_PTR o);
14807 * Frees any resources used by the CResult_ChannelMonitorUpdateDecodeErrorZ.
14809 void CResult_ChannelMonitorUpdateDecodeErrorZ_free(struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ _res);
14812 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ which has the same data as `orig`
14813 * but with all dynamically-allocated buffers duplicated in new buffers.
14815 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_clone(const struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ *NONNULL_PTR orig);
14818 * Constructs a new COption_MonitorEventZ containing a crate::lightning::chain::channelmonitor::MonitorEvent
14820 struct LDKCOption_MonitorEventZ COption_MonitorEventZ_some(struct LDKMonitorEvent o);
14823 * Constructs a new COption_MonitorEventZ containing nothing
14825 struct LDKCOption_MonitorEventZ COption_MonitorEventZ_none(void);
14828 * Frees any resources associated with the crate::lightning::chain::channelmonitor::MonitorEvent, if we are in the Some state
14830 void COption_MonitorEventZ_free(struct LDKCOption_MonitorEventZ _res);
14833 * Creates a new COption_MonitorEventZ which has the same data as `orig`
14834 * but with all dynamically-allocated buffers duplicated in new buffers.
14836 struct LDKCOption_MonitorEventZ COption_MonitorEventZ_clone(const struct LDKCOption_MonitorEventZ *NONNULL_PTR orig);
14839 * Creates a new CResult_COption_MonitorEventZDecodeErrorZ in the success state.
14841 struct LDKCResult_COption_MonitorEventZDecodeErrorZ CResult_COption_MonitorEventZDecodeErrorZ_ok(struct LDKCOption_MonitorEventZ o);
14844 * Creates a new CResult_COption_MonitorEventZDecodeErrorZ in the error state.
14846 struct LDKCResult_COption_MonitorEventZDecodeErrorZ CResult_COption_MonitorEventZDecodeErrorZ_err(struct LDKDecodeError e);
14849 * Checks if the given object is currently in the success state
14851 bool CResult_COption_MonitorEventZDecodeErrorZ_is_ok(const struct LDKCResult_COption_MonitorEventZDecodeErrorZ *NONNULL_PTR o);
14854 * Frees any resources used by the CResult_COption_MonitorEventZDecodeErrorZ.
14856 void CResult_COption_MonitorEventZDecodeErrorZ_free(struct LDKCResult_COption_MonitorEventZDecodeErrorZ _res);
14859 * Creates a new CResult_COption_MonitorEventZDecodeErrorZ which has the same data as `orig`
14860 * but with all dynamically-allocated buffers duplicated in new buffers.
14862 struct LDKCResult_COption_MonitorEventZDecodeErrorZ CResult_COption_MonitorEventZDecodeErrorZ_clone(const struct LDKCResult_COption_MonitorEventZDecodeErrorZ *NONNULL_PTR orig);
14865 * Creates a new CResult_HTLCUpdateDecodeErrorZ in the success state.
14867 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_ok(struct LDKHTLCUpdate o);
14870 * Creates a new CResult_HTLCUpdateDecodeErrorZ in the error state.
14872 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_err(struct LDKDecodeError e);
14875 * Checks if the given object is currently in the success state
14877 bool CResult_HTLCUpdateDecodeErrorZ_is_ok(const struct LDKCResult_HTLCUpdateDecodeErrorZ *NONNULL_PTR o);
14880 * Frees any resources used by the CResult_HTLCUpdateDecodeErrorZ.
14882 void CResult_HTLCUpdateDecodeErrorZ_free(struct LDKCResult_HTLCUpdateDecodeErrorZ _res);
14885 * Creates a new CResult_HTLCUpdateDecodeErrorZ which has the same data as `orig`
14886 * but with all dynamically-allocated buffers duplicated in new buffers.
14888 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_clone(const struct LDKCResult_HTLCUpdateDecodeErrorZ *NONNULL_PTR orig);
14891 * Creates a new tuple which has the same data as `orig`
14892 * but with all dynamically-allocated buffers duplicated in new buffers.
14894 struct LDKC2Tuple_OutPointScriptZ C2Tuple_OutPointScriptZ_clone(const struct LDKC2Tuple_OutPointScriptZ *NONNULL_PTR orig);
14897 * Creates a new C2Tuple_OutPointScriptZ from the contained elements.
14899 struct LDKC2Tuple_OutPointScriptZ C2Tuple_OutPointScriptZ_new(struct LDKOutPoint a, struct LDKCVec_u8Z b);
14902 * Frees any resources used by the C2Tuple_OutPointScriptZ.
14904 void C2Tuple_OutPointScriptZ_free(struct LDKC2Tuple_OutPointScriptZ _res);
14907 * Creates a new tuple which has the same data as `orig`
14908 * but with all dynamically-allocated buffers duplicated in new buffers.
14910 struct LDKC2Tuple_u32ScriptZ C2Tuple_u32ScriptZ_clone(const struct LDKC2Tuple_u32ScriptZ *NONNULL_PTR orig);
14913 * Creates a new C2Tuple_u32ScriptZ from the contained elements.
14915 struct LDKC2Tuple_u32ScriptZ C2Tuple_u32ScriptZ_new(uint32_t a, struct LDKCVec_u8Z b);
14918 * Frees any resources used by the C2Tuple_u32ScriptZ.
14920 void C2Tuple_u32ScriptZ_free(struct LDKC2Tuple_u32ScriptZ _res);
14923 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14925 void CVec_C2Tuple_u32ScriptZZ_free(struct LDKCVec_C2Tuple_u32ScriptZZ _res);
14928 * Creates a new tuple which has the same data as `orig`
14929 * but with all dynamically-allocated buffers duplicated in new buffers.
14931 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_clone(const struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ *NONNULL_PTR orig);
14934 * Creates a new C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ from the contained elements.
14936 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_new(struct LDKThirtyTwoBytes a, struct LDKCVec_C2Tuple_u32ScriptZZ b);
14939 * Frees any resources used by the C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ.
14941 void C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_free(struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ _res);
14944 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14946 void CVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ_free(struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ _res);
14949 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14951 void CVec_EventZ_free(struct LDKCVec_EventZ _res);
14954 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14956 void CVec_TransactionZ_free(struct LDKCVec_TransactionZ _res);
14959 * Creates a new tuple which has the same data as `orig`
14960 * but with all dynamically-allocated buffers duplicated in new buffers.
14962 struct LDKC2Tuple_u32TxOutZ C2Tuple_u32TxOutZ_clone(const struct LDKC2Tuple_u32TxOutZ *NONNULL_PTR orig);
14965 * Creates a new C2Tuple_u32TxOutZ from the contained elements.
14967 struct LDKC2Tuple_u32TxOutZ C2Tuple_u32TxOutZ_new(uint32_t a, struct LDKTxOut b);
14970 * Frees any resources used by the C2Tuple_u32TxOutZ.
14972 void C2Tuple_u32TxOutZ_free(struct LDKC2Tuple_u32TxOutZ _res);
14975 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14977 void CVec_C2Tuple_u32TxOutZZ_free(struct LDKCVec_C2Tuple_u32TxOutZZ _res);
14980 * Creates a new tuple which has the same data as `orig`
14981 * but with all dynamically-allocated buffers duplicated in new buffers.
14983 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_clone(const struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ *NONNULL_PTR orig);
14986 * Creates a new C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ from the contained elements.
14988 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_new(struct LDKThirtyTwoBytes a, struct LDKCVec_C2Tuple_u32TxOutZZ b);
14991 * Frees any resources used by the C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ.
14993 void C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_free(struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ _res);
14996 * Frees the buffer pointed to by `data` if `datalen` is non-0.
14998 void CVec_TransactionOutputsZ_free(struct LDKCVec_TransactionOutputsZ _res);
15001 * Frees the buffer pointed to by `data` if `datalen` is non-0.
15003 void CVec_BalanceZ_free(struct LDKCVec_BalanceZ _res);
15006 * Creates a new CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ in the success state.
15008 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_ok(struct LDKC2Tuple_BlockHashChannelMonitorZ o);
15011 * Creates a new CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ in the error state.
15013 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_err(struct LDKDecodeError e);
15016 * Checks if the given object is currently in the success state
15018 bool CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_is_ok(const struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ *NONNULL_PTR o);
15021 * Frees any resources used by the CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.
15023 void CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_free(struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ _res);
15026 * Creates a new CResult_NoneLightningErrorZ in the success state.
15028 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_ok(void);
15031 * Creates a new CResult_NoneLightningErrorZ in the error state.
15033 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_err(struct LDKLightningError e);
15036 * Checks if the given object is currently in the success state
15038 bool CResult_NoneLightningErrorZ_is_ok(const struct LDKCResult_NoneLightningErrorZ *NONNULL_PTR o);
15041 * Frees any resources used by the CResult_NoneLightningErrorZ.
15043 void CResult_NoneLightningErrorZ_free(struct LDKCResult_NoneLightningErrorZ _res);
15046 * Creates a new CResult_NoneLightningErrorZ which has the same data as `orig`
15047 * but with all dynamically-allocated buffers duplicated in new buffers.
15049 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_clone(const struct LDKCResult_NoneLightningErrorZ *NONNULL_PTR orig);
15052 * Creates a new C2Tuple_PublicKeyTypeZ from the contained elements.
15054 struct LDKC2Tuple_PublicKeyTypeZ C2Tuple_PublicKeyTypeZ_new(struct LDKPublicKey a, struct LDKType b);
15057 * Frees any resources used by the C2Tuple_PublicKeyTypeZ.
15059 void C2Tuple_PublicKeyTypeZ_free(struct LDKC2Tuple_PublicKeyTypeZ _res);
15062 * Frees the buffer pointed to by `data` if `datalen` is non-0.
15064 void CVec_C2Tuple_PublicKeyTypeZZ_free(struct LDKCVec_C2Tuple_PublicKeyTypeZZ _res);
15067 * Creates a new CResult_boolLightningErrorZ in the success state.
15069 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_ok(bool o);
15072 * Creates a new CResult_boolLightningErrorZ in the error state.
15074 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_err(struct LDKLightningError e);
15077 * Checks if the given object is currently in the success state
15079 bool CResult_boolLightningErrorZ_is_ok(const struct LDKCResult_boolLightningErrorZ *NONNULL_PTR o);
15082 * Frees any resources used by the CResult_boolLightningErrorZ.
15084 void CResult_boolLightningErrorZ_free(struct LDKCResult_boolLightningErrorZ _res);
15087 * Creates a new CResult_boolLightningErrorZ which has the same data as `orig`
15088 * but with all dynamically-allocated buffers duplicated in new buffers.
15090 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_clone(const struct LDKCResult_boolLightningErrorZ *NONNULL_PTR orig);
15093 * Creates a new tuple which has the same data as `orig`
15094 * but with all dynamically-allocated buffers duplicated in new buffers.
15096 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_clone(const struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ *NONNULL_PTR orig);
15099 * Creates a new C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ from the contained elements.
15101 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_new(struct LDKChannelAnnouncement a, struct LDKChannelUpdate b, struct LDKChannelUpdate c);
15104 * Frees any resources used by the C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ.
15106 void C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_free(struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ _res);
15109 * Frees the buffer pointed to by `data` if `datalen` is non-0.
15111 void CVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ_free(struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ _res);
15114 * Frees the buffer pointed to by `data` if `datalen` is non-0.
15116 void CVec_NodeAnnouncementZ_free(struct LDKCVec_NodeAnnouncementZ _res);
15119 * Frees the buffer pointed to by `data` if `datalen` is non-0.
15121 void CVec_PublicKeyZ_free(struct LDKCVec_PublicKeyZ _res);
15124 * Constructs a new COption_NetAddressZ containing a crate::lightning::ln::msgs::NetAddress
15126 struct LDKCOption_NetAddressZ COption_NetAddressZ_some(struct LDKNetAddress o);
15129 * Constructs a new COption_NetAddressZ containing nothing
15131 struct LDKCOption_NetAddressZ COption_NetAddressZ_none(void);
15134 * Frees any resources associated with the crate::lightning::ln::msgs::NetAddress, if we are in the Some state
15136 void COption_NetAddressZ_free(struct LDKCOption_NetAddressZ _res);
15139 * Creates a new COption_NetAddressZ which has the same data as `orig`
15140 * but with all dynamically-allocated buffers duplicated in new buffers.
15142 struct LDKCOption_NetAddressZ COption_NetAddressZ_clone(const struct LDKCOption_NetAddressZ *NONNULL_PTR orig);
15145 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ in the success state.
15147 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_ok(struct LDKCVec_u8Z o);
15150 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ in the error state.
15152 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_err(struct LDKPeerHandleError e);
15155 * Checks if the given object is currently in the success state
15157 bool CResult_CVec_u8ZPeerHandleErrorZ_is_ok(const struct LDKCResult_CVec_u8ZPeerHandleErrorZ *NONNULL_PTR o);
15160 * Frees any resources used by the CResult_CVec_u8ZPeerHandleErrorZ.
15162 void CResult_CVec_u8ZPeerHandleErrorZ_free(struct LDKCResult_CVec_u8ZPeerHandleErrorZ _res);
15165 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ which has the same data as `orig`
15166 * but with all dynamically-allocated buffers duplicated in new buffers.
15168 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_clone(const struct LDKCResult_CVec_u8ZPeerHandleErrorZ *NONNULL_PTR orig);
15171 * Creates a new CResult_NonePeerHandleErrorZ in the success state.
15173 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_ok(void);
15176 * Creates a new CResult_NonePeerHandleErrorZ in the error state.
15178 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_err(struct LDKPeerHandleError e);
15181 * Checks if the given object is currently in the success state
15183 bool CResult_NonePeerHandleErrorZ_is_ok(const struct LDKCResult_NonePeerHandleErrorZ *NONNULL_PTR o);
15186 * Frees any resources used by the CResult_NonePeerHandleErrorZ.
15188 void CResult_NonePeerHandleErrorZ_free(struct LDKCResult_NonePeerHandleErrorZ _res);
15191 * Creates a new CResult_NonePeerHandleErrorZ which has the same data as `orig`
15192 * but with all dynamically-allocated buffers duplicated in new buffers.
15194 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_clone(const struct LDKCResult_NonePeerHandleErrorZ *NONNULL_PTR orig);
15197 * Creates a new CResult_boolPeerHandleErrorZ in the success state.
15199 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_ok(bool o);
15202 * Creates a new CResult_boolPeerHandleErrorZ in the error state.
15204 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_err(struct LDKPeerHandleError e);
15207 * Checks if the given object is currently in the success state
15209 bool CResult_boolPeerHandleErrorZ_is_ok(const struct LDKCResult_boolPeerHandleErrorZ *NONNULL_PTR o);
15212 * Frees any resources used by the CResult_boolPeerHandleErrorZ.
15214 void CResult_boolPeerHandleErrorZ_free(struct LDKCResult_boolPeerHandleErrorZ _res);
15217 * Creates a new CResult_boolPeerHandleErrorZ which has the same data as `orig`
15218 * but with all dynamically-allocated buffers duplicated in new buffers.
15220 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_clone(const struct LDKCResult_boolPeerHandleErrorZ *NONNULL_PTR orig);
15223 * Creates a new CResult_NodeIdDecodeErrorZ in the success state.
15225 struct LDKCResult_NodeIdDecodeErrorZ CResult_NodeIdDecodeErrorZ_ok(struct LDKNodeId o);
15228 * Creates a new CResult_NodeIdDecodeErrorZ in the error state.
15230 struct LDKCResult_NodeIdDecodeErrorZ CResult_NodeIdDecodeErrorZ_err(struct LDKDecodeError e);
15233 * Checks if the given object is currently in the success state
15235 bool CResult_NodeIdDecodeErrorZ_is_ok(const struct LDKCResult_NodeIdDecodeErrorZ *NONNULL_PTR o);
15238 * Frees any resources used by the CResult_NodeIdDecodeErrorZ.
15240 void CResult_NodeIdDecodeErrorZ_free(struct LDKCResult_NodeIdDecodeErrorZ _res);
15243 * Creates a new CResult_NodeIdDecodeErrorZ which has the same data as `orig`
15244 * but with all dynamically-allocated buffers duplicated in new buffers.
15246 struct LDKCResult_NodeIdDecodeErrorZ CResult_NodeIdDecodeErrorZ_clone(const struct LDKCResult_NodeIdDecodeErrorZ *NONNULL_PTR orig);
15249 * Creates a new CResult_COption_NetworkUpdateZDecodeErrorZ in the success state.
15251 struct LDKCResult_COption_NetworkUpdateZDecodeErrorZ CResult_COption_NetworkUpdateZDecodeErrorZ_ok(struct LDKCOption_NetworkUpdateZ o);
15254 * Creates a new CResult_COption_NetworkUpdateZDecodeErrorZ in the error state.
15256 struct LDKCResult_COption_NetworkUpdateZDecodeErrorZ CResult_COption_NetworkUpdateZDecodeErrorZ_err(struct LDKDecodeError e);
15259 * Checks if the given object is currently in the success state
15261 bool CResult_COption_NetworkUpdateZDecodeErrorZ_is_ok(const struct LDKCResult_COption_NetworkUpdateZDecodeErrorZ *NONNULL_PTR o);
15264 * Frees any resources used by the CResult_COption_NetworkUpdateZDecodeErrorZ.
15266 void CResult_COption_NetworkUpdateZDecodeErrorZ_free(struct LDKCResult_COption_NetworkUpdateZDecodeErrorZ _res);
15269 * Creates a new CResult_COption_NetworkUpdateZDecodeErrorZ which has the same data as `orig`
15270 * but with all dynamically-allocated buffers duplicated in new buffers.
15272 struct LDKCResult_COption_NetworkUpdateZDecodeErrorZ CResult_COption_NetworkUpdateZDecodeErrorZ_clone(const struct LDKCResult_COption_NetworkUpdateZDecodeErrorZ *NONNULL_PTR orig);
15275 * Constructs a new COption_AccessZ containing a crate::lightning::chain::Access
15277 struct LDKCOption_AccessZ COption_AccessZ_some(struct LDKAccess o);
15280 * Constructs a new COption_AccessZ containing nothing
15282 struct LDKCOption_AccessZ COption_AccessZ_none(void);
15285 * Frees any resources associated with the crate::lightning::chain::Access, if we are in the Some state
15287 void COption_AccessZ_free(struct LDKCOption_AccessZ _res);
15290 * Creates a new CResult_ChannelUpdateInfoDecodeErrorZ in the success state.
15292 struct LDKCResult_ChannelUpdateInfoDecodeErrorZ CResult_ChannelUpdateInfoDecodeErrorZ_ok(struct LDKChannelUpdateInfo o);
15295 * Creates a new CResult_ChannelUpdateInfoDecodeErrorZ in the error state.
15297 struct LDKCResult_ChannelUpdateInfoDecodeErrorZ CResult_ChannelUpdateInfoDecodeErrorZ_err(struct LDKDecodeError e);
15300 * Checks if the given object is currently in the success state
15302 bool CResult_ChannelUpdateInfoDecodeErrorZ_is_ok(const struct LDKCResult_ChannelUpdateInfoDecodeErrorZ *NONNULL_PTR o);
15305 * Frees any resources used by the CResult_ChannelUpdateInfoDecodeErrorZ.
15307 void CResult_ChannelUpdateInfoDecodeErrorZ_free(struct LDKCResult_ChannelUpdateInfoDecodeErrorZ _res);
15310 * Creates a new CResult_ChannelUpdateInfoDecodeErrorZ which has the same data as `orig`
15311 * but with all dynamically-allocated buffers duplicated in new buffers.
15313 struct LDKCResult_ChannelUpdateInfoDecodeErrorZ CResult_ChannelUpdateInfoDecodeErrorZ_clone(const struct LDKCResult_ChannelUpdateInfoDecodeErrorZ *NONNULL_PTR orig);
15316 * Creates a new CResult_ChannelInfoDecodeErrorZ in the success state.
15318 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_ok(struct LDKChannelInfo o);
15321 * Creates a new CResult_ChannelInfoDecodeErrorZ in the error state.
15323 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_err(struct LDKDecodeError e);
15326 * Checks if the given object is currently in the success state
15328 bool CResult_ChannelInfoDecodeErrorZ_is_ok(const struct LDKCResult_ChannelInfoDecodeErrorZ *NONNULL_PTR o);
15331 * Frees any resources used by the CResult_ChannelInfoDecodeErrorZ.
15333 void CResult_ChannelInfoDecodeErrorZ_free(struct LDKCResult_ChannelInfoDecodeErrorZ _res);
15336 * Creates a new CResult_ChannelInfoDecodeErrorZ which has the same data as `orig`
15337 * but with all dynamically-allocated buffers duplicated in new buffers.
15339 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_clone(const struct LDKCResult_ChannelInfoDecodeErrorZ *NONNULL_PTR orig);
15342 * Creates a new CResult_RoutingFeesDecodeErrorZ in the success state.
15344 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_ok(struct LDKRoutingFees o);
15347 * Creates a new CResult_RoutingFeesDecodeErrorZ in the error state.
15349 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_err(struct LDKDecodeError e);
15352 * Checks if the given object is currently in the success state
15354 bool CResult_RoutingFeesDecodeErrorZ_is_ok(const struct LDKCResult_RoutingFeesDecodeErrorZ *NONNULL_PTR o);
15357 * Frees any resources used by the CResult_RoutingFeesDecodeErrorZ.
15359 void CResult_RoutingFeesDecodeErrorZ_free(struct LDKCResult_RoutingFeesDecodeErrorZ _res);
15362 * Creates a new CResult_RoutingFeesDecodeErrorZ which has the same data as `orig`
15363 * but with all dynamically-allocated buffers duplicated in new buffers.
15365 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_clone(const struct LDKCResult_RoutingFeesDecodeErrorZ *NONNULL_PTR orig);
15368 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ in the success state.
15370 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_ok(struct LDKNodeAnnouncementInfo o);
15373 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ in the error state.
15375 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_err(struct LDKDecodeError e);
15378 * Checks if the given object is currently in the success state
15380 bool CResult_NodeAnnouncementInfoDecodeErrorZ_is_ok(const struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ *NONNULL_PTR o);
15383 * Frees any resources used by the CResult_NodeAnnouncementInfoDecodeErrorZ.
15385 void CResult_NodeAnnouncementInfoDecodeErrorZ_free(struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ _res);
15388 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ which has the same data as `orig`
15389 * but with all dynamically-allocated buffers duplicated in new buffers.
15391 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_clone(const struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ *NONNULL_PTR orig);
15394 * Frees the buffer pointed to by `data` if `datalen` is non-0.
15396 void CVec_u64Z_free(struct LDKCVec_u64Z _res);
15399 * Creates a new CResult_NodeInfoDecodeErrorZ in the success state.
15401 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_ok(struct LDKNodeInfo o);
15404 * Creates a new CResult_NodeInfoDecodeErrorZ in the error state.
15406 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_err(struct LDKDecodeError e);
15409 * Checks if the given object is currently in the success state
15411 bool CResult_NodeInfoDecodeErrorZ_is_ok(const struct LDKCResult_NodeInfoDecodeErrorZ *NONNULL_PTR o);
15414 * Frees any resources used by the CResult_NodeInfoDecodeErrorZ.
15416 void CResult_NodeInfoDecodeErrorZ_free(struct LDKCResult_NodeInfoDecodeErrorZ _res);
15419 * Creates a new CResult_NodeInfoDecodeErrorZ which has the same data as `orig`
15420 * but with all dynamically-allocated buffers duplicated in new buffers.
15422 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_clone(const struct LDKCResult_NodeInfoDecodeErrorZ *NONNULL_PTR orig);
15425 * Creates a new CResult_NetworkGraphDecodeErrorZ in the success state.
15427 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_ok(struct LDKNetworkGraph o);
15430 * Creates a new CResult_NetworkGraphDecodeErrorZ in the error state.
15432 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_err(struct LDKDecodeError e);
15435 * Checks if the given object is currently in the success state
15437 bool CResult_NetworkGraphDecodeErrorZ_is_ok(const struct LDKCResult_NetworkGraphDecodeErrorZ *NONNULL_PTR o);
15440 * Frees any resources used by the CResult_NetworkGraphDecodeErrorZ.
15442 void CResult_NetworkGraphDecodeErrorZ_free(struct LDKCResult_NetworkGraphDecodeErrorZ _res);
15445 * Creates a new CResult_NetworkGraphDecodeErrorZ which has the same data as `orig`
15446 * but with all dynamically-allocated buffers duplicated in new buffers.
15448 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_clone(const struct LDKCResult_NetworkGraphDecodeErrorZ *NONNULL_PTR orig);
15451 * Constructs a new COption_CVec_NetAddressZZ containing a crate::c_types::derived::CVec_NetAddressZ
15453 struct LDKCOption_CVec_NetAddressZZ COption_CVec_NetAddressZZ_some(struct LDKCVec_NetAddressZ o);
15456 * Constructs a new COption_CVec_NetAddressZZ containing nothing
15458 struct LDKCOption_CVec_NetAddressZZ COption_CVec_NetAddressZZ_none(void);
15461 * Frees any resources associated with the crate::c_types::derived::CVec_NetAddressZ, if we are in the Some state
15463 void COption_CVec_NetAddressZZ_free(struct LDKCOption_CVec_NetAddressZZ _res);
15466 * Creates a new COption_CVec_NetAddressZZ which has the same data as `orig`
15467 * but with all dynamically-allocated buffers duplicated in new buffers.
15469 struct LDKCOption_CVec_NetAddressZZ COption_CVec_NetAddressZZ_clone(const struct LDKCOption_CVec_NetAddressZZ *NONNULL_PTR orig);
15472 * Creates a new CResult_NetAddressDecodeErrorZ in the success state.
15474 struct LDKCResult_NetAddressDecodeErrorZ CResult_NetAddressDecodeErrorZ_ok(struct LDKNetAddress o);
15477 * Creates a new CResult_NetAddressDecodeErrorZ in the error state.
15479 struct LDKCResult_NetAddressDecodeErrorZ CResult_NetAddressDecodeErrorZ_err(struct LDKDecodeError e);
15482 * Checks if the given object is currently in the success state
15484 bool CResult_NetAddressDecodeErrorZ_is_ok(const struct LDKCResult_NetAddressDecodeErrorZ *NONNULL_PTR o);
15487 * Frees any resources used by the CResult_NetAddressDecodeErrorZ.
15489 void CResult_NetAddressDecodeErrorZ_free(struct LDKCResult_NetAddressDecodeErrorZ _res);
15492 * Creates a new CResult_NetAddressDecodeErrorZ which has the same data as `orig`
15493 * but with all dynamically-allocated buffers duplicated in new buffers.
15495 struct LDKCResult_NetAddressDecodeErrorZ CResult_NetAddressDecodeErrorZ_clone(const struct LDKCResult_NetAddressDecodeErrorZ *NONNULL_PTR orig);
15498 * Frees the buffer pointed to by `data` if `datalen` is non-0.
15500 void CVec_UpdateAddHTLCZ_free(struct LDKCVec_UpdateAddHTLCZ _res);
15503 * Frees the buffer pointed to by `data` if `datalen` is non-0.
15505 void CVec_UpdateFulfillHTLCZ_free(struct LDKCVec_UpdateFulfillHTLCZ _res);
15508 * Frees the buffer pointed to by `data` if `datalen` is non-0.
15510 void CVec_UpdateFailHTLCZ_free(struct LDKCVec_UpdateFailHTLCZ _res);
15513 * Frees the buffer pointed to by `data` if `datalen` is non-0.
15515 void CVec_UpdateFailMalformedHTLCZ_free(struct LDKCVec_UpdateFailMalformedHTLCZ _res);
15518 * Creates a new CResult_AcceptChannelDecodeErrorZ in the success state.
15520 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_ok(struct LDKAcceptChannel o);
15523 * Creates a new CResult_AcceptChannelDecodeErrorZ in the error state.
15525 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_err(struct LDKDecodeError e);
15528 * Checks if the given object is currently in the success state
15530 bool CResult_AcceptChannelDecodeErrorZ_is_ok(const struct LDKCResult_AcceptChannelDecodeErrorZ *NONNULL_PTR o);
15533 * Frees any resources used by the CResult_AcceptChannelDecodeErrorZ.
15535 void CResult_AcceptChannelDecodeErrorZ_free(struct LDKCResult_AcceptChannelDecodeErrorZ _res);
15538 * Creates a new CResult_AcceptChannelDecodeErrorZ which has the same data as `orig`
15539 * but with all dynamically-allocated buffers duplicated in new buffers.
15541 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_clone(const struct LDKCResult_AcceptChannelDecodeErrorZ *NONNULL_PTR orig);
15544 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ in the success state.
15546 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_ok(struct LDKAnnouncementSignatures o);
15549 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ in the error state.
15551 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_err(struct LDKDecodeError e);
15554 * Checks if the given object is currently in the success state
15556 bool CResult_AnnouncementSignaturesDecodeErrorZ_is_ok(const struct LDKCResult_AnnouncementSignaturesDecodeErrorZ *NONNULL_PTR o);
15559 * Frees any resources used by the CResult_AnnouncementSignaturesDecodeErrorZ.
15561 void CResult_AnnouncementSignaturesDecodeErrorZ_free(struct LDKCResult_AnnouncementSignaturesDecodeErrorZ _res);
15564 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ which has the same data as `orig`
15565 * but with all dynamically-allocated buffers duplicated in new buffers.
15567 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_clone(const struct LDKCResult_AnnouncementSignaturesDecodeErrorZ *NONNULL_PTR orig);
15570 * Creates a new CResult_ChannelReestablishDecodeErrorZ in the success state.
15572 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_ok(struct LDKChannelReestablish o);
15575 * Creates a new CResult_ChannelReestablishDecodeErrorZ in the error state.
15577 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_err(struct LDKDecodeError e);
15580 * Checks if the given object is currently in the success state
15582 bool CResult_ChannelReestablishDecodeErrorZ_is_ok(const struct LDKCResult_ChannelReestablishDecodeErrorZ *NONNULL_PTR o);
15585 * Frees any resources used by the CResult_ChannelReestablishDecodeErrorZ.
15587 void CResult_ChannelReestablishDecodeErrorZ_free(struct LDKCResult_ChannelReestablishDecodeErrorZ _res);
15590 * Creates a new CResult_ChannelReestablishDecodeErrorZ which has the same data as `orig`
15591 * but with all dynamically-allocated buffers duplicated in new buffers.
15593 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_clone(const struct LDKCResult_ChannelReestablishDecodeErrorZ *NONNULL_PTR orig);
15596 * Creates a new CResult_ClosingSignedDecodeErrorZ in the success state.
15598 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_ok(struct LDKClosingSigned o);
15601 * Creates a new CResult_ClosingSignedDecodeErrorZ in the error state.
15603 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_err(struct LDKDecodeError e);
15606 * Checks if the given object is currently in the success state
15608 bool CResult_ClosingSignedDecodeErrorZ_is_ok(const struct LDKCResult_ClosingSignedDecodeErrorZ *NONNULL_PTR o);
15611 * Frees any resources used by the CResult_ClosingSignedDecodeErrorZ.
15613 void CResult_ClosingSignedDecodeErrorZ_free(struct LDKCResult_ClosingSignedDecodeErrorZ _res);
15616 * Creates a new CResult_ClosingSignedDecodeErrorZ which has the same data as `orig`
15617 * but with all dynamically-allocated buffers duplicated in new buffers.
15619 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_clone(const struct LDKCResult_ClosingSignedDecodeErrorZ *NONNULL_PTR orig);
15622 * Creates a new CResult_ClosingSignedFeeRangeDecodeErrorZ in the success state.
15624 struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ CResult_ClosingSignedFeeRangeDecodeErrorZ_ok(struct LDKClosingSignedFeeRange o);
15627 * Creates a new CResult_ClosingSignedFeeRangeDecodeErrorZ in the error state.
15629 struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ CResult_ClosingSignedFeeRangeDecodeErrorZ_err(struct LDKDecodeError e);
15632 * Checks if the given object is currently in the success state
15634 bool CResult_ClosingSignedFeeRangeDecodeErrorZ_is_ok(const struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ *NONNULL_PTR o);
15637 * Frees any resources used by the CResult_ClosingSignedFeeRangeDecodeErrorZ.
15639 void CResult_ClosingSignedFeeRangeDecodeErrorZ_free(struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ _res);
15642 * Creates a new CResult_ClosingSignedFeeRangeDecodeErrorZ which has the same data as `orig`
15643 * but with all dynamically-allocated buffers duplicated in new buffers.
15645 struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ CResult_ClosingSignedFeeRangeDecodeErrorZ_clone(const struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ *NONNULL_PTR orig);
15648 * Creates a new CResult_CommitmentSignedDecodeErrorZ in the success state.
15650 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_ok(struct LDKCommitmentSigned o);
15653 * Creates a new CResult_CommitmentSignedDecodeErrorZ in the error state.
15655 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_err(struct LDKDecodeError e);
15658 * Checks if the given object is currently in the success state
15660 bool CResult_CommitmentSignedDecodeErrorZ_is_ok(const struct LDKCResult_CommitmentSignedDecodeErrorZ *NONNULL_PTR o);
15663 * Frees any resources used by the CResult_CommitmentSignedDecodeErrorZ.
15665 void CResult_CommitmentSignedDecodeErrorZ_free(struct LDKCResult_CommitmentSignedDecodeErrorZ _res);
15668 * Creates a new CResult_CommitmentSignedDecodeErrorZ which has the same data as `orig`
15669 * but with all dynamically-allocated buffers duplicated in new buffers.
15671 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_clone(const struct LDKCResult_CommitmentSignedDecodeErrorZ *NONNULL_PTR orig);
15674 * Creates a new CResult_FundingCreatedDecodeErrorZ in the success state.
15676 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_ok(struct LDKFundingCreated o);
15679 * Creates a new CResult_FundingCreatedDecodeErrorZ in the error state.
15681 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_err(struct LDKDecodeError e);
15684 * Checks if the given object is currently in the success state
15686 bool CResult_FundingCreatedDecodeErrorZ_is_ok(const struct LDKCResult_FundingCreatedDecodeErrorZ *NONNULL_PTR o);
15689 * Frees any resources used by the CResult_FundingCreatedDecodeErrorZ.
15691 void CResult_FundingCreatedDecodeErrorZ_free(struct LDKCResult_FundingCreatedDecodeErrorZ _res);
15694 * Creates a new CResult_FundingCreatedDecodeErrorZ which has the same data as `orig`
15695 * but with all dynamically-allocated buffers duplicated in new buffers.
15697 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_clone(const struct LDKCResult_FundingCreatedDecodeErrorZ *NONNULL_PTR orig);
15700 * Creates a new CResult_FundingSignedDecodeErrorZ in the success state.
15702 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_ok(struct LDKFundingSigned o);
15705 * Creates a new CResult_FundingSignedDecodeErrorZ in the error state.
15707 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_err(struct LDKDecodeError e);
15710 * Checks if the given object is currently in the success state
15712 bool CResult_FundingSignedDecodeErrorZ_is_ok(const struct LDKCResult_FundingSignedDecodeErrorZ *NONNULL_PTR o);
15715 * Frees any resources used by the CResult_FundingSignedDecodeErrorZ.
15717 void CResult_FundingSignedDecodeErrorZ_free(struct LDKCResult_FundingSignedDecodeErrorZ _res);
15720 * Creates a new CResult_FundingSignedDecodeErrorZ which has the same data as `orig`
15721 * but with all dynamically-allocated buffers duplicated in new buffers.
15723 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_clone(const struct LDKCResult_FundingSignedDecodeErrorZ *NONNULL_PTR orig);
15726 * Creates a new CResult_FundingLockedDecodeErrorZ in the success state.
15728 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_ok(struct LDKFundingLocked o);
15731 * Creates a new CResult_FundingLockedDecodeErrorZ in the error state.
15733 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_err(struct LDKDecodeError e);
15736 * Checks if the given object is currently in the success state
15738 bool CResult_FundingLockedDecodeErrorZ_is_ok(const struct LDKCResult_FundingLockedDecodeErrorZ *NONNULL_PTR o);
15741 * Frees any resources used by the CResult_FundingLockedDecodeErrorZ.
15743 void CResult_FundingLockedDecodeErrorZ_free(struct LDKCResult_FundingLockedDecodeErrorZ _res);
15746 * Creates a new CResult_FundingLockedDecodeErrorZ which has the same data as `orig`
15747 * but with all dynamically-allocated buffers duplicated in new buffers.
15749 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_clone(const struct LDKCResult_FundingLockedDecodeErrorZ *NONNULL_PTR orig);
15752 * Creates a new CResult_InitDecodeErrorZ in the success state.
15754 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_ok(struct LDKInit o);
15757 * Creates a new CResult_InitDecodeErrorZ in the error state.
15759 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_err(struct LDKDecodeError e);
15762 * Checks if the given object is currently in the success state
15764 bool CResult_InitDecodeErrorZ_is_ok(const struct LDKCResult_InitDecodeErrorZ *NONNULL_PTR o);
15767 * Frees any resources used by the CResult_InitDecodeErrorZ.
15769 void CResult_InitDecodeErrorZ_free(struct LDKCResult_InitDecodeErrorZ _res);
15772 * Creates a new CResult_InitDecodeErrorZ which has the same data as `orig`
15773 * but with all dynamically-allocated buffers duplicated in new buffers.
15775 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_clone(const struct LDKCResult_InitDecodeErrorZ *NONNULL_PTR orig);
15778 * Creates a new CResult_OpenChannelDecodeErrorZ in the success state.
15780 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_ok(struct LDKOpenChannel o);
15783 * Creates a new CResult_OpenChannelDecodeErrorZ in the error state.
15785 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_err(struct LDKDecodeError e);
15788 * Checks if the given object is currently in the success state
15790 bool CResult_OpenChannelDecodeErrorZ_is_ok(const struct LDKCResult_OpenChannelDecodeErrorZ *NONNULL_PTR o);
15793 * Frees any resources used by the CResult_OpenChannelDecodeErrorZ.
15795 void CResult_OpenChannelDecodeErrorZ_free(struct LDKCResult_OpenChannelDecodeErrorZ _res);
15798 * Creates a new CResult_OpenChannelDecodeErrorZ which has the same data as `orig`
15799 * but with all dynamically-allocated buffers duplicated in new buffers.
15801 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_clone(const struct LDKCResult_OpenChannelDecodeErrorZ *NONNULL_PTR orig);
15804 * Creates a new CResult_RevokeAndACKDecodeErrorZ in the success state.
15806 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_ok(struct LDKRevokeAndACK o);
15809 * Creates a new CResult_RevokeAndACKDecodeErrorZ in the error state.
15811 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_err(struct LDKDecodeError e);
15814 * Checks if the given object is currently in the success state
15816 bool CResult_RevokeAndACKDecodeErrorZ_is_ok(const struct LDKCResult_RevokeAndACKDecodeErrorZ *NONNULL_PTR o);
15819 * Frees any resources used by the CResult_RevokeAndACKDecodeErrorZ.
15821 void CResult_RevokeAndACKDecodeErrorZ_free(struct LDKCResult_RevokeAndACKDecodeErrorZ _res);
15824 * Creates a new CResult_RevokeAndACKDecodeErrorZ which has the same data as `orig`
15825 * but with all dynamically-allocated buffers duplicated in new buffers.
15827 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_clone(const struct LDKCResult_RevokeAndACKDecodeErrorZ *NONNULL_PTR orig);
15830 * Creates a new CResult_ShutdownDecodeErrorZ in the success state.
15832 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_ok(struct LDKShutdown o);
15835 * Creates a new CResult_ShutdownDecodeErrorZ in the error state.
15837 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_err(struct LDKDecodeError e);
15840 * Checks if the given object is currently in the success state
15842 bool CResult_ShutdownDecodeErrorZ_is_ok(const struct LDKCResult_ShutdownDecodeErrorZ *NONNULL_PTR o);
15845 * Frees any resources used by the CResult_ShutdownDecodeErrorZ.
15847 void CResult_ShutdownDecodeErrorZ_free(struct LDKCResult_ShutdownDecodeErrorZ _res);
15850 * Creates a new CResult_ShutdownDecodeErrorZ which has the same data as `orig`
15851 * but with all dynamically-allocated buffers duplicated in new buffers.
15853 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_clone(const struct LDKCResult_ShutdownDecodeErrorZ *NONNULL_PTR orig);
15856 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ in the success state.
15858 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_ok(struct LDKUpdateFailHTLC o);
15861 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ in the error state.
15863 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_err(struct LDKDecodeError e);
15866 * Checks if the given object is currently in the success state
15868 bool CResult_UpdateFailHTLCDecodeErrorZ_is_ok(const struct LDKCResult_UpdateFailHTLCDecodeErrorZ *NONNULL_PTR o);
15871 * Frees any resources used by the CResult_UpdateFailHTLCDecodeErrorZ.
15873 void CResult_UpdateFailHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFailHTLCDecodeErrorZ _res);
15876 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ which has the same data as `orig`
15877 * but with all dynamically-allocated buffers duplicated in new buffers.
15879 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFailHTLCDecodeErrorZ *NONNULL_PTR orig);
15882 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ in the success state.
15884 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_ok(struct LDKUpdateFailMalformedHTLC o);
15887 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ in the error state.
15889 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_err(struct LDKDecodeError e);
15892 * Checks if the given object is currently in the success state
15894 bool CResult_UpdateFailMalformedHTLCDecodeErrorZ_is_ok(const struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ *NONNULL_PTR o);
15897 * Frees any resources used by the CResult_UpdateFailMalformedHTLCDecodeErrorZ.
15899 void CResult_UpdateFailMalformedHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ _res);
15902 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ which has the same data as `orig`
15903 * but with all dynamically-allocated buffers duplicated in new buffers.
15905 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ *NONNULL_PTR orig);
15908 * Creates a new CResult_UpdateFeeDecodeErrorZ in the success state.
15910 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_ok(struct LDKUpdateFee o);
15913 * Creates a new CResult_UpdateFeeDecodeErrorZ in the error state.
15915 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_err(struct LDKDecodeError e);
15918 * Checks if the given object is currently in the success state
15920 bool CResult_UpdateFeeDecodeErrorZ_is_ok(const struct LDKCResult_UpdateFeeDecodeErrorZ *NONNULL_PTR o);
15923 * Frees any resources used by the CResult_UpdateFeeDecodeErrorZ.
15925 void CResult_UpdateFeeDecodeErrorZ_free(struct LDKCResult_UpdateFeeDecodeErrorZ _res);
15928 * Creates a new CResult_UpdateFeeDecodeErrorZ which has the same data as `orig`
15929 * but with all dynamically-allocated buffers duplicated in new buffers.
15931 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_clone(const struct LDKCResult_UpdateFeeDecodeErrorZ *NONNULL_PTR orig);
15934 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ in the success state.
15936 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_ok(struct LDKUpdateFulfillHTLC o);
15939 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ in the error state.
15941 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_err(struct LDKDecodeError e);
15944 * Checks if the given object is currently in the success state
15946 bool CResult_UpdateFulfillHTLCDecodeErrorZ_is_ok(const struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ *NONNULL_PTR o);
15949 * Frees any resources used by the CResult_UpdateFulfillHTLCDecodeErrorZ.
15951 void CResult_UpdateFulfillHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ _res);
15954 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ which has the same data as `orig`
15955 * but with all dynamically-allocated buffers duplicated in new buffers.
15957 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ *NONNULL_PTR orig);
15960 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ in the success state.
15962 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_ok(struct LDKUpdateAddHTLC o);
15965 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ in the error state.
15967 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_err(struct LDKDecodeError e);
15970 * Checks if the given object is currently in the success state
15972 bool CResult_UpdateAddHTLCDecodeErrorZ_is_ok(const struct LDKCResult_UpdateAddHTLCDecodeErrorZ *NONNULL_PTR o);
15975 * Frees any resources used by the CResult_UpdateAddHTLCDecodeErrorZ.
15977 void CResult_UpdateAddHTLCDecodeErrorZ_free(struct LDKCResult_UpdateAddHTLCDecodeErrorZ _res);
15980 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ which has the same data as `orig`
15981 * but with all dynamically-allocated buffers duplicated in new buffers.
15983 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateAddHTLCDecodeErrorZ *NONNULL_PTR orig);
15986 * Creates a new CResult_PingDecodeErrorZ in the success state.
15988 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_ok(struct LDKPing o);
15991 * Creates a new CResult_PingDecodeErrorZ in the error state.
15993 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_err(struct LDKDecodeError e);
15996 * Checks if the given object is currently in the success state
15998 bool CResult_PingDecodeErrorZ_is_ok(const struct LDKCResult_PingDecodeErrorZ *NONNULL_PTR o);
16001 * Frees any resources used by the CResult_PingDecodeErrorZ.
16003 void CResult_PingDecodeErrorZ_free(struct LDKCResult_PingDecodeErrorZ _res);
16006 * Creates a new CResult_PingDecodeErrorZ which has the same data as `orig`
16007 * but with all dynamically-allocated buffers duplicated in new buffers.
16009 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_clone(const struct LDKCResult_PingDecodeErrorZ *NONNULL_PTR orig);
16012 * Creates a new CResult_PongDecodeErrorZ in the success state.
16014 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_ok(struct LDKPong o);
16017 * Creates a new CResult_PongDecodeErrorZ in the error state.
16019 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_err(struct LDKDecodeError e);
16022 * Checks if the given object is currently in the success state
16024 bool CResult_PongDecodeErrorZ_is_ok(const struct LDKCResult_PongDecodeErrorZ *NONNULL_PTR o);
16027 * Frees any resources used by the CResult_PongDecodeErrorZ.
16029 void CResult_PongDecodeErrorZ_free(struct LDKCResult_PongDecodeErrorZ _res);
16032 * Creates a new CResult_PongDecodeErrorZ which has the same data as `orig`
16033 * but with all dynamically-allocated buffers duplicated in new buffers.
16035 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_clone(const struct LDKCResult_PongDecodeErrorZ *NONNULL_PTR orig);
16038 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ in the success state.
16040 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_ok(struct LDKUnsignedChannelAnnouncement o);
16043 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ in the error state.
16045 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
16048 * Checks if the given object is currently in the success state
16050 bool CResult_UnsignedChannelAnnouncementDecodeErrorZ_is_ok(const struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ *NONNULL_PTR o);
16053 * Frees any resources used by the CResult_UnsignedChannelAnnouncementDecodeErrorZ.
16055 void CResult_UnsignedChannelAnnouncementDecodeErrorZ_free(struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ _res);
16058 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ which has the same data as `orig`
16059 * but with all dynamically-allocated buffers duplicated in new buffers.
16061 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_clone(const struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ *NONNULL_PTR orig);
16064 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ in the success state.
16066 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_ok(struct LDKChannelAnnouncement o);
16069 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ in the error state.
16071 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
16074 * Checks if the given object is currently in the success state
16076 bool CResult_ChannelAnnouncementDecodeErrorZ_is_ok(const struct LDKCResult_ChannelAnnouncementDecodeErrorZ *NONNULL_PTR o);
16079 * Frees any resources used by the CResult_ChannelAnnouncementDecodeErrorZ.
16081 void CResult_ChannelAnnouncementDecodeErrorZ_free(struct LDKCResult_ChannelAnnouncementDecodeErrorZ _res);
16084 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ which has the same data as `orig`
16085 * but with all dynamically-allocated buffers duplicated in new buffers.
16087 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_clone(const struct LDKCResult_ChannelAnnouncementDecodeErrorZ *NONNULL_PTR orig);
16090 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ in the success state.
16092 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_ok(struct LDKUnsignedChannelUpdate o);
16095 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ in the error state.
16097 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_err(struct LDKDecodeError e);
16100 * Checks if the given object is currently in the success state
16102 bool CResult_UnsignedChannelUpdateDecodeErrorZ_is_ok(const struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ *NONNULL_PTR o);
16105 * Frees any resources used by the CResult_UnsignedChannelUpdateDecodeErrorZ.
16107 void CResult_UnsignedChannelUpdateDecodeErrorZ_free(struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ _res);
16110 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ which has the same data as `orig`
16111 * but with all dynamically-allocated buffers duplicated in new buffers.
16113 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_clone(const struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ *NONNULL_PTR orig);
16116 * Creates a new CResult_ChannelUpdateDecodeErrorZ in the success state.
16118 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_ok(struct LDKChannelUpdate o);
16121 * Creates a new CResult_ChannelUpdateDecodeErrorZ in the error state.
16123 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_err(struct LDKDecodeError e);
16126 * Checks if the given object is currently in the success state
16128 bool CResult_ChannelUpdateDecodeErrorZ_is_ok(const struct LDKCResult_ChannelUpdateDecodeErrorZ *NONNULL_PTR o);
16131 * Frees any resources used by the CResult_ChannelUpdateDecodeErrorZ.
16133 void CResult_ChannelUpdateDecodeErrorZ_free(struct LDKCResult_ChannelUpdateDecodeErrorZ _res);
16136 * Creates a new CResult_ChannelUpdateDecodeErrorZ which has the same data as `orig`
16137 * but with all dynamically-allocated buffers duplicated in new buffers.
16139 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_clone(const struct LDKCResult_ChannelUpdateDecodeErrorZ *NONNULL_PTR orig);
16142 * Creates a new CResult_ErrorMessageDecodeErrorZ in the success state.
16144 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_ok(struct LDKErrorMessage o);
16147 * Creates a new CResult_ErrorMessageDecodeErrorZ in the error state.
16149 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_err(struct LDKDecodeError e);
16152 * Checks if the given object is currently in the success state
16154 bool CResult_ErrorMessageDecodeErrorZ_is_ok(const struct LDKCResult_ErrorMessageDecodeErrorZ *NONNULL_PTR o);
16157 * Frees any resources used by the CResult_ErrorMessageDecodeErrorZ.
16159 void CResult_ErrorMessageDecodeErrorZ_free(struct LDKCResult_ErrorMessageDecodeErrorZ _res);
16162 * Creates a new CResult_ErrorMessageDecodeErrorZ which has the same data as `orig`
16163 * but with all dynamically-allocated buffers duplicated in new buffers.
16165 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_clone(const struct LDKCResult_ErrorMessageDecodeErrorZ *NONNULL_PTR orig);
16168 * Creates a new CResult_WarningMessageDecodeErrorZ in the success state.
16170 struct LDKCResult_WarningMessageDecodeErrorZ CResult_WarningMessageDecodeErrorZ_ok(struct LDKWarningMessage o);
16173 * Creates a new CResult_WarningMessageDecodeErrorZ in the error state.
16175 struct LDKCResult_WarningMessageDecodeErrorZ CResult_WarningMessageDecodeErrorZ_err(struct LDKDecodeError e);
16178 * Checks if the given object is currently in the success state
16180 bool CResult_WarningMessageDecodeErrorZ_is_ok(const struct LDKCResult_WarningMessageDecodeErrorZ *NONNULL_PTR o);
16183 * Frees any resources used by the CResult_WarningMessageDecodeErrorZ.
16185 void CResult_WarningMessageDecodeErrorZ_free(struct LDKCResult_WarningMessageDecodeErrorZ _res);
16188 * Creates a new CResult_WarningMessageDecodeErrorZ which has the same data as `orig`
16189 * but with all dynamically-allocated buffers duplicated in new buffers.
16191 struct LDKCResult_WarningMessageDecodeErrorZ CResult_WarningMessageDecodeErrorZ_clone(const struct LDKCResult_WarningMessageDecodeErrorZ *NONNULL_PTR orig);
16194 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ in the success state.
16196 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_ok(struct LDKUnsignedNodeAnnouncement o);
16199 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ in the error state.
16201 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
16204 * Checks if the given object is currently in the success state
16206 bool CResult_UnsignedNodeAnnouncementDecodeErrorZ_is_ok(const struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ *NONNULL_PTR o);
16209 * Frees any resources used by the CResult_UnsignedNodeAnnouncementDecodeErrorZ.
16211 void CResult_UnsignedNodeAnnouncementDecodeErrorZ_free(struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ _res);
16214 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ which has the same data as `orig`
16215 * but with all dynamically-allocated buffers duplicated in new buffers.
16217 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_clone(const struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ *NONNULL_PTR orig);
16220 * Creates a new CResult_NodeAnnouncementDecodeErrorZ in the success state.
16222 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_ok(struct LDKNodeAnnouncement o);
16225 * Creates a new CResult_NodeAnnouncementDecodeErrorZ in the error state.
16227 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
16230 * Checks if the given object is currently in the success state
16232 bool CResult_NodeAnnouncementDecodeErrorZ_is_ok(const struct LDKCResult_NodeAnnouncementDecodeErrorZ *NONNULL_PTR o);
16235 * Frees any resources used by the CResult_NodeAnnouncementDecodeErrorZ.
16237 void CResult_NodeAnnouncementDecodeErrorZ_free(struct LDKCResult_NodeAnnouncementDecodeErrorZ _res);
16240 * Creates a new CResult_NodeAnnouncementDecodeErrorZ which has the same data as `orig`
16241 * but with all dynamically-allocated buffers duplicated in new buffers.
16243 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_clone(const struct LDKCResult_NodeAnnouncementDecodeErrorZ *NONNULL_PTR orig);
16246 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ in the success state.
16248 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_ok(struct LDKQueryShortChannelIds o);
16251 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ in the error state.
16253 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_err(struct LDKDecodeError e);
16256 * Checks if the given object is currently in the success state
16258 bool CResult_QueryShortChannelIdsDecodeErrorZ_is_ok(const struct LDKCResult_QueryShortChannelIdsDecodeErrorZ *NONNULL_PTR o);
16261 * Frees any resources used by the CResult_QueryShortChannelIdsDecodeErrorZ.
16263 void CResult_QueryShortChannelIdsDecodeErrorZ_free(struct LDKCResult_QueryShortChannelIdsDecodeErrorZ _res);
16266 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ which has the same data as `orig`
16267 * but with all dynamically-allocated buffers duplicated in new buffers.
16269 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_clone(const struct LDKCResult_QueryShortChannelIdsDecodeErrorZ *NONNULL_PTR orig);
16272 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ in the success state.
16274 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_ok(struct LDKReplyShortChannelIdsEnd o);
16277 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ in the error state.
16279 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_err(struct LDKDecodeError e);
16282 * Checks if the given object is currently in the success state
16284 bool CResult_ReplyShortChannelIdsEndDecodeErrorZ_is_ok(const struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ *NONNULL_PTR o);
16287 * Frees any resources used by the CResult_ReplyShortChannelIdsEndDecodeErrorZ.
16289 void CResult_ReplyShortChannelIdsEndDecodeErrorZ_free(struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ _res);
16292 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ which has the same data as `orig`
16293 * but with all dynamically-allocated buffers duplicated in new buffers.
16295 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_clone(const struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ *NONNULL_PTR orig);
16298 * Creates a new CResult_QueryChannelRangeDecodeErrorZ in the success state.
16300 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_ok(struct LDKQueryChannelRange o);
16303 * Creates a new CResult_QueryChannelRangeDecodeErrorZ in the error state.
16305 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_err(struct LDKDecodeError e);
16308 * Checks if the given object is currently in the success state
16310 bool CResult_QueryChannelRangeDecodeErrorZ_is_ok(const struct LDKCResult_QueryChannelRangeDecodeErrorZ *NONNULL_PTR o);
16313 * Frees any resources used by the CResult_QueryChannelRangeDecodeErrorZ.
16315 void CResult_QueryChannelRangeDecodeErrorZ_free(struct LDKCResult_QueryChannelRangeDecodeErrorZ _res);
16318 * Creates a new CResult_QueryChannelRangeDecodeErrorZ which has the same data as `orig`
16319 * but with all dynamically-allocated buffers duplicated in new buffers.
16321 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_clone(const struct LDKCResult_QueryChannelRangeDecodeErrorZ *NONNULL_PTR orig);
16324 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ in the success state.
16326 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_ok(struct LDKReplyChannelRange o);
16329 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ in the error state.
16331 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_err(struct LDKDecodeError e);
16334 * Checks if the given object is currently in the success state
16336 bool CResult_ReplyChannelRangeDecodeErrorZ_is_ok(const struct LDKCResult_ReplyChannelRangeDecodeErrorZ *NONNULL_PTR o);
16339 * Frees any resources used by the CResult_ReplyChannelRangeDecodeErrorZ.
16341 void CResult_ReplyChannelRangeDecodeErrorZ_free(struct LDKCResult_ReplyChannelRangeDecodeErrorZ _res);
16344 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ which has the same data as `orig`
16345 * but with all dynamically-allocated buffers duplicated in new buffers.
16347 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_clone(const struct LDKCResult_ReplyChannelRangeDecodeErrorZ *NONNULL_PTR orig);
16350 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ in the success state.
16352 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_ok(struct LDKGossipTimestampFilter o);
16355 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ in the error state.
16357 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_err(struct LDKDecodeError e);
16360 * Checks if the given object is currently in the success state
16362 bool CResult_GossipTimestampFilterDecodeErrorZ_is_ok(const struct LDKCResult_GossipTimestampFilterDecodeErrorZ *NONNULL_PTR o);
16365 * Frees any resources used by the CResult_GossipTimestampFilterDecodeErrorZ.
16367 void CResult_GossipTimestampFilterDecodeErrorZ_free(struct LDKCResult_GossipTimestampFilterDecodeErrorZ _res);
16370 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ which has the same data as `orig`
16371 * but with all dynamically-allocated buffers duplicated in new buffers.
16373 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_clone(const struct LDKCResult_GossipTimestampFilterDecodeErrorZ *NONNULL_PTR orig);
16376 * Frees the buffer pointed to by `data` if `datalen` is non-0.
16378 void CVec_PhantomRouteHintsZ_free(struct LDKCVec_PhantomRouteHintsZ _res);
16381 * Creates a new CResult_InvoiceSignOrCreationErrorZ in the success state.
16383 struct LDKCResult_InvoiceSignOrCreationErrorZ CResult_InvoiceSignOrCreationErrorZ_ok(struct LDKInvoice o);
16386 * Creates a new CResult_InvoiceSignOrCreationErrorZ in the error state.
16388 struct LDKCResult_InvoiceSignOrCreationErrorZ CResult_InvoiceSignOrCreationErrorZ_err(struct LDKSignOrCreationError e);
16391 * Checks if the given object is currently in the success state
16393 bool CResult_InvoiceSignOrCreationErrorZ_is_ok(const struct LDKCResult_InvoiceSignOrCreationErrorZ *NONNULL_PTR o);
16396 * Frees any resources used by the CResult_InvoiceSignOrCreationErrorZ.
16398 void CResult_InvoiceSignOrCreationErrorZ_free(struct LDKCResult_InvoiceSignOrCreationErrorZ _res);
16401 * Creates a new CResult_InvoiceSignOrCreationErrorZ which has the same data as `orig`
16402 * but with all dynamically-allocated buffers duplicated in new buffers.
16404 struct LDKCResult_InvoiceSignOrCreationErrorZ CResult_InvoiceSignOrCreationErrorZ_clone(const struct LDKCResult_InvoiceSignOrCreationErrorZ *NONNULL_PTR orig);
16407 * Constructs a new COption_FilterZ containing a crate::lightning::chain::Filter
16409 struct LDKCOption_FilterZ COption_FilterZ_some(struct LDKFilter o);
16412 * Constructs a new COption_FilterZ containing nothing
16414 struct LDKCOption_FilterZ COption_FilterZ_none(void);
16417 * Frees any resources associated with the crate::lightning::chain::Filter, if we are in the Some state
16419 void COption_FilterZ_free(struct LDKCOption_FilterZ _res);
16422 * Creates a new CResult_LockedChannelMonitorNoneZ in the success state.
16424 struct LDKCResult_LockedChannelMonitorNoneZ CResult_LockedChannelMonitorNoneZ_ok(struct LDKLockedChannelMonitor o);
16427 * Creates a new CResult_LockedChannelMonitorNoneZ in the error state.
16429 struct LDKCResult_LockedChannelMonitorNoneZ CResult_LockedChannelMonitorNoneZ_err(void);
16432 * Checks if the given object is currently in the success state
16434 bool CResult_LockedChannelMonitorNoneZ_is_ok(const struct LDKCResult_LockedChannelMonitorNoneZ *NONNULL_PTR o);
16437 * Frees any resources used by the CResult_LockedChannelMonitorNoneZ.
16439 void CResult_LockedChannelMonitorNoneZ_free(struct LDKCResult_LockedChannelMonitorNoneZ _res);
16442 * Frees the buffer pointed to by `data` if `datalen` is non-0.
16444 void CVec_OutPointZ_free(struct LDKCVec_OutPointZ _res);
16447 * Frees any resources used by the PaymentPurpose
16449 void PaymentPurpose_free(struct LDKPaymentPurpose this_ptr);
16452 * Creates a copy of the PaymentPurpose
16454 struct LDKPaymentPurpose PaymentPurpose_clone(const struct LDKPaymentPurpose *NONNULL_PTR orig);
16457 * Utility method to constructs a new InvoicePayment-variant PaymentPurpose
16459 struct LDKPaymentPurpose PaymentPurpose_invoice_payment(struct LDKThirtyTwoBytes payment_preimage, struct LDKThirtyTwoBytes payment_secret);
16462 * Utility method to constructs a new SpontaneousPayment-variant PaymentPurpose
16464 struct LDKPaymentPurpose PaymentPurpose_spontaneous_payment(struct LDKThirtyTwoBytes a);
16467 * Frees any resources used by the ClosureReason
16469 void ClosureReason_free(struct LDKClosureReason this_ptr);
16472 * Creates a copy of the ClosureReason
16474 struct LDKClosureReason ClosureReason_clone(const struct LDKClosureReason *NONNULL_PTR orig);
16477 * Utility method to constructs a new CounterpartyForceClosed-variant ClosureReason
16479 struct LDKClosureReason ClosureReason_counterparty_force_closed(struct LDKStr peer_msg);
16482 * Utility method to constructs a new HolderForceClosed-variant ClosureReason
16484 struct LDKClosureReason ClosureReason_holder_force_closed(void);
16487 * Utility method to constructs a new CooperativeClosure-variant ClosureReason
16489 struct LDKClosureReason ClosureReason_cooperative_closure(void);
16492 * Utility method to constructs a new CommitmentTxConfirmed-variant ClosureReason
16494 struct LDKClosureReason ClosureReason_commitment_tx_confirmed(void);
16497 * Utility method to constructs a new FundingTimedOut-variant ClosureReason
16499 struct LDKClosureReason ClosureReason_funding_timed_out(void);
16502 * Utility method to constructs a new ProcessingError-variant ClosureReason
16504 struct LDKClosureReason ClosureReason_processing_error(struct LDKStr err);
16507 * Utility method to constructs a new DisconnectedPeer-variant ClosureReason
16509 struct LDKClosureReason ClosureReason_disconnected_peer(void);
16512 * Utility method to constructs a new OutdatedChannelManager-variant ClosureReason
16514 struct LDKClosureReason ClosureReason_outdated_channel_manager(void);
16517 * Serialize the ClosureReason object into a byte array which can be read by ClosureReason_read
16519 struct LDKCVec_u8Z ClosureReason_write(const struct LDKClosureReason *NONNULL_PTR obj);
16522 * Read a ClosureReason from a byte array, created by ClosureReason_write
16524 struct LDKCResult_COption_ClosureReasonZDecodeErrorZ ClosureReason_read(struct LDKu8slice ser);
16527 * Frees any resources used by the Event
16529 void Event_free(struct LDKEvent this_ptr);
16532 * Creates a copy of the Event
16534 struct LDKEvent Event_clone(const struct LDKEvent *NONNULL_PTR orig);
16537 * Utility method to constructs a new FundingGenerationReady-variant Event
16539 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);
16542 * Utility method to constructs a new PaymentReceived-variant Event
16544 struct LDKEvent Event_payment_received(struct LDKThirtyTwoBytes payment_hash, uint64_t amt, struct LDKPaymentPurpose purpose);
16547 * Utility method to constructs a new PaymentSent-variant Event
16549 struct LDKEvent Event_payment_sent(struct LDKThirtyTwoBytes payment_id, struct LDKThirtyTwoBytes payment_preimage, struct LDKThirtyTwoBytes payment_hash, struct LDKCOption_u64Z fee_paid_msat);
16552 * Utility method to constructs a new PaymentPathFailed-variant Event
16554 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);
16557 * Utility method to constructs a new PaymentFailed-variant Event
16559 struct LDKEvent Event_payment_failed(struct LDKThirtyTwoBytes payment_id, struct LDKThirtyTwoBytes payment_hash);
16562 * Utility method to constructs a new PendingHTLCsForwardable-variant Event
16564 struct LDKEvent Event_pending_htlcs_forwardable(uint64_t time_forwardable);
16567 * Utility method to constructs a new SpendableOutputs-variant Event
16569 struct LDKEvent Event_spendable_outputs(struct LDKCVec_SpendableOutputDescriptorZ outputs);
16572 * Utility method to constructs a new PaymentForwarded-variant Event
16574 struct LDKEvent Event_payment_forwarded(struct LDKCOption_u64Z fee_earned_msat, bool claim_from_onchain_tx);
16577 * Utility method to constructs a new ChannelClosed-variant Event
16579 struct LDKEvent Event_channel_closed(struct LDKThirtyTwoBytes channel_id, uint64_t user_channel_id, struct LDKClosureReason reason);
16582 * Utility method to constructs a new DiscardFunding-variant Event
16584 struct LDKEvent Event_discard_funding(struct LDKThirtyTwoBytes channel_id, struct LDKTransaction transaction);
16587 * Utility method to constructs a new PaymentPathSuccessful-variant Event
16589 struct LDKEvent Event_payment_path_successful(struct LDKThirtyTwoBytes payment_id, struct LDKThirtyTwoBytes payment_hash, struct LDKCVec_RouteHopZ path);
16592 * Utility method to constructs a new OpenChannelRequest-variant Event
16594 struct LDKEvent Event_open_channel_request(struct LDKThirtyTwoBytes temporary_channel_id, struct LDKPublicKey counterparty_node_id, uint64_t funding_satoshis, uint64_t push_msat, struct LDKChannelTypeFeatures channel_type);
16597 * Serialize the Event object into a byte array which can be read by Event_read
16599 struct LDKCVec_u8Z Event_write(const struct LDKEvent *NONNULL_PTR obj);
16602 * Read a Event from a byte array, created by Event_write
16604 struct LDKCResult_COption_EventZDecodeErrorZ Event_read(struct LDKu8slice ser);
16607 * Frees any resources used by the MessageSendEvent
16609 void MessageSendEvent_free(struct LDKMessageSendEvent this_ptr);
16612 * Creates a copy of the MessageSendEvent
16614 struct LDKMessageSendEvent MessageSendEvent_clone(const struct LDKMessageSendEvent *NONNULL_PTR orig);
16617 * Utility method to constructs a new SendAcceptChannel-variant MessageSendEvent
16619 struct LDKMessageSendEvent MessageSendEvent_send_accept_channel(struct LDKPublicKey node_id, struct LDKAcceptChannel msg);
16622 * Utility method to constructs a new SendOpenChannel-variant MessageSendEvent
16624 struct LDKMessageSendEvent MessageSendEvent_send_open_channel(struct LDKPublicKey node_id, struct LDKOpenChannel msg);
16627 * Utility method to constructs a new SendFundingCreated-variant MessageSendEvent
16629 struct LDKMessageSendEvent MessageSendEvent_send_funding_created(struct LDKPublicKey node_id, struct LDKFundingCreated msg);
16632 * Utility method to constructs a new SendFundingSigned-variant MessageSendEvent
16634 struct LDKMessageSendEvent MessageSendEvent_send_funding_signed(struct LDKPublicKey node_id, struct LDKFundingSigned msg);
16637 * Utility method to constructs a new SendFundingLocked-variant MessageSendEvent
16639 struct LDKMessageSendEvent MessageSendEvent_send_funding_locked(struct LDKPublicKey node_id, struct LDKFundingLocked msg);
16642 * Utility method to constructs a new SendAnnouncementSignatures-variant MessageSendEvent
16644 struct LDKMessageSendEvent MessageSendEvent_send_announcement_signatures(struct LDKPublicKey node_id, struct LDKAnnouncementSignatures msg);
16647 * Utility method to constructs a new UpdateHTLCs-variant MessageSendEvent
16649 struct LDKMessageSendEvent MessageSendEvent_update_htlcs(struct LDKPublicKey node_id, struct LDKCommitmentUpdate updates);
16652 * Utility method to constructs a new SendRevokeAndACK-variant MessageSendEvent
16654 struct LDKMessageSendEvent MessageSendEvent_send_revoke_and_ack(struct LDKPublicKey node_id, struct LDKRevokeAndACK msg);
16657 * Utility method to constructs a new SendClosingSigned-variant MessageSendEvent
16659 struct LDKMessageSendEvent MessageSendEvent_send_closing_signed(struct LDKPublicKey node_id, struct LDKClosingSigned msg);
16662 * Utility method to constructs a new SendShutdown-variant MessageSendEvent
16664 struct LDKMessageSendEvent MessageSendEvent_send_shutdown(struct LDKPublicKey node_id, struct LDKShutdown msg);
16667 * Utility method to constructs a new SendChannelReestablish-variant MessageSendEvent
16669 struct LDKMessageSendEvent MessageSendEvent_send_channel_reestablish(struct LDKPublicKey node_id, struct LDKChannelReestablish msg);
16672 * Utility method to constructs a new BroadcastChannelAnnouncement-variant MessageSendEvent
16674 struct LDKMessageSendEvent MessageSendEvent_broadcast_channel_announcement(struct LDKChannelAnnouncement msg, struct LDKChannelUpdate update_msg);
16677 * Utility method to constructs a new BroadcastNodeAnnouncement-variant MessageSendEvent
16679 struct LDKMessageSendEvent MessageSendEvent_broadcast_node_announcement(struct LDKNodeAnnouncement msg);
16682 * Utility method to constructs a new BroadcastChannelUpdate-variant MessageSendEvent
16684 struct LDKMessageSendEvent MessageSendEvent_broadcast_channel_update(struct LDKChannelUpdate msg);
16687 * Utility method to constructs a new SendChannelUpdate-variant MessageSendEvent
16689 struct LDKMessageSendEvent MessageSendEvent_send_channel_update(struct LDKPublicKey node_id, struct LDKChannelUpdate msg);
16692 * Utility method to constructs a new HandleError-variant MessageSendEvent
16694 struct LDKMessageSendEvent MessageSendEvent_handle_error(struct LDKPublicKey node_id, struct LDKErrorAction action);
16697 * Utility method to constructs a new SendChannelRangeQuery-variant MessageSendEvent
16699 struct LDKMessageSendEvent MessageSendEvent_send_channel_range_query(struct LDKPublicKey node_id, struct LDKQueryChannelRange msg);
16702 * Utility method to constructs a new SendShortIdsQuery-variant MessageSendEvent
16704 struct LDKMessageSendEvent MessageSendEvent_send_short_ids_query(struct LDKPublicKey node_id, struct LDKQueryShortChannelIds msg);
16707 * Utility method to constructs a new SendReplyChannelRange-variant MessageSendEvent
16709 struct LDKMessageSendEvent MessageSendEvent_send_reply_channel_range(struct LDKPublicKey node_id, struct LDKReplyChannelRange msg);
16712 * Utility method to constructs a new SendGossipTimestampFilter-variant MessageSendEvent
16714 struct LDKMessageSendEvent MessageSendEvent_send_gossip_timestamp_filter(struct LDKPublicKey node_id, struct LDKGossipTimestampFilter msg);
16717 * Calls the free function if one is set
16719 void MessageSendEventsProvider_free(struct LDKMessageSendEventsProvider this_ptr);
16722 * Calls the free function if one is set
16724 void EventsProvider_free(struct LDKEventsProvider this_ptr);
16727 * Calls the free function if one is set
16729 void EventHandler_free(struct LDKEventHandler this_ptr);
16732 * Frees any resources used by the APIError
16734 void APIError_free(struct LDKAPIError this_ptr);
16737 * Creates a copy of the APIError
16739 struct LDKAPIError APIError_clone(const struct LDKAPIError *NONNULL_PTR orig);
16742 * Utility method to constructs a new APIMisuseError-variant APIError
16744 struct LDKAPIError APIError_apimisuse_error(struct LDKStr err);
16747 * Utility method to constructs a new FeeRateTooHigh-variant APIError
16749 struct LDKAPIError APIError_fee_rate_too_high(struct LDKStr err, uint32_t feerate);
16752 * Utility method to constructs a new RouteError-variant APIError
16754 struct LDKAPIError APIError_route_error(struct LDKStr err);
16757 * Utility method to constructs a new ChannelUnavailable-variant APIError
16759 struct LDKAPIError APIError_channel_unavailable(struct LDKStr err);
16762 * Utility method to constructs a new MonitorUpdateFailed-variant APIError
16764 struct LDKAPIError APIError_monitor_update_failed(void);
16767 * Utility method to constructs a new IncompatibleShutdownScript-variant APIError
16769 struct LDKAPIError APIError_incompatible_shutdown_script(struct LDKShutdownScript script);
16772 * Creates a digital signature of a message given a SecretKey, like the node's secret.
16773 * 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.
16774 * Signatures are EC recoverable, meaning that given the message and the signature the PublicKey of the signer can be extracted.
16776 struct LDKCResult_StringErrorZ sign(struct LDKu8slice msg, const uint8_t (*sk)[32]);
16779 * Recovers the PublicKey of the signer of the message given the message and the signature.
16781 struct LDKCResult_PublicKeyErrorZ recover_pk(struct LDKu8slice msg, struct LDKStr sig);
16784 * Verifies a message was signed by a PrivateKey that derives to a given PublicKey, given a message, a signature,
16785 * and the PublicKey.
16787 bool verify(struct LDKu8slice msg, struct LDKStr sig, struct LDKPublicKey pk);
16790 * Construct the invoice's HRP and signatureless data into a preimage to be hashed.
16792 struct LDKCVec_u8Z construct_invoice_preimage(struct LDKu8slice hrp_bytes, struct LDKCVec_u5Z data_without_signature);
16795 * Creates a copy of the Level
16797 enum LDKLevel Level_clone(const enum LDKLevel *NONNULL_PTR orig);
16800 * Utility method to constructs a new Gossip-variant Level
16802 enum LDKLevel Level_gossip(void);
16805 * Utility method to constructs a new Trace-variant Level
16807 enum LDKLevel Level_trace(void);
16810 * Utility method to constructs a new Debug-variant Level
16812 enum LDKLevel Level_debug(void);
16815 * Utility method to constructs a new Info-variant Level
16817 enum LDKLevel Level_info(void);
16820 * Utility method to constructs a new Warn-variant Level
16822 enum LDKLevel Level_warn(void);
16825 * Utility method to constructs a new Error-variant Level
16827 enum LDKLevel Level_error(void);
16830 * Checks if two Levels contain equal inner contents.
16831 * This ignores pointers and is_owned flags and looks at the values in fields.
16833 bool Level_eq(const enum LDKLevel *NONNULL_PTR a, const enum LDKLevel *NONNULL_PTR b);
16836 * Checks if two Levels contain equal inner contents.
16838 uint64_t Level_hash(const enum LDKLevel *NONNULL_PTR o);
16841 * Returns the most verbose logging level.
16843 MUST_USE_RES enum LDKLevel Level_max(void);
16846 * Frees any resources used by the Record, if is_owned is set and inner is non-NULL.
16848 void Record_free(struct LDKRecord this_obj);
16851 * The verbosity level of the message.
16853 enum LDKLevel Record_get_level(const struct LDKRecord *NONNULL_PTR this_ptr);
16856 * The verbosity level of the message.
16858 void Record_set_level(struct LDKRecord *NONNULL_PTR this_ptr, enum LDKLevel val);
16861 * The message body.
16863 struct LDKStr Record_get_args(const struct LDKRecord *NONNULL_PTR this_ptr);
16866 * The message body.
16868 void Record_set_args(struct LDKRecord *NONNULL_PTR this_ptr, struct LDKStr val);
16871 * The module path of the message.
16873 struct LDKStr Record_get_module_path(const struct LDKRecord *NONNULL_PTR this_ptr);
16876 * The module path of the message.
16878 void Record_set_module_path(struct LDKRecord *NONNULL_PTR this_ptr, struct LDKStr val);
16881 * The source file containing the message.
16883 struct LDKStr Record_get_file(const struct LDKRecord *NONNULL_PTR this_ptr);
16886 * The source file containing the message.
16888 void Record_set_file(struct LDKRecord *NONNULL_PTR this_ptr, struct LDKStr val);
16891 * The line containing the message.
16893 uint32_t Record_get_line(const struct LDKRecord *NONNULL_PTR this_ptr);
16896 * The line containing the message.
16898 void Record_set_line(struct LDKRecord *NONNULL_PTR this_ptr, uint32_t val);
16901 * Creates a copy of the Record
16903 struct LDKRecord Record_clone(const struct LDKRecord *NONNULL_PTR orig);
16906 * Calls the free function if one is set
16908 void Logger_free(struct LDKLogger this_ptr);
16911 * Frees any resources used by the ChannelHandshakeConfig, if is_owned is set and inner is non-NULL.
16913 void ChannelHandshakeConfig_free(struct LDKChannelHandshakeConfig this_obj);
16916 * Confirmations we will wait for before considering the channel locked in.
16917 * Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
16918 * equivalent limit applied to outbound channels).
16920 * Default value: 6.
16922 uint32_t ChannelHandshakeConfig_get_minimum_depth(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
16925 * Confirmations we will wait for before considering the channel locked in.
16926 * Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
16927 * equivalent limit applied to outbound channels).
16929 * Default value: 6.
16931 void ChannelHandshakeConfig_set_minimum_depth(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint32_t val);
16934 * Set to the number of blocks we require our counterparty to wait to claim their money (ie
16935 * the number of blocks we have to punish our counterparty if they broadcast a revoked
16938 * This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
16939 * be online to check for revoked transactions on-chain at least once every our_to_self_delay
16940 * blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
16941 * possibly with time in between to RBF the spending transaction).
16943 * Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
16944 * case of an honest unilateral channel close, which implicitly decrease the economic value of
16947 * Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
16948 * can tweak config to ask for more security, not less.
16950 uint16_t ChannelHandshakeConfig_get_our_to_self_delay(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
16953 * Set to the number of blocks we require our counterparty to wait to claim their money (ie
16954 * the number of blocks we have to punish our counterparty if they broadcast a revoked
16957 * This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
16958 * be online to check for revoked transactions on-chain at least once every our_to_self_delay
16959 * blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
16960 * possibly with time in between to RBF the spending transaction).
16962 * Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
16963 * case of an honest unilateral channel close, which implicitly decrease the economic value of
16966 * Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
16967 * can tweak config to ask for more security, not less.
16969 void ChannelHandshakeConfig_set_our_to_self_delay(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint16_t val);
16972 * Set to the smallest value HTLC we will accept to process.
16974 * This value is sent to our counterparty on channel-open and we close the channel any time
16975 * our counterparty misbehaves by sending us an HTLC with a value smaller than this.
16977 * Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
16980 uint64_t ChannelHandshakeConfig_get_our_htlc_minimum_msat(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
16983 * Set to the smallest value HTLC we will accept to process.
16985 * This value is sent to our counterparty on channel-open and we close the channel any time
16986 * our counterparty misbehaves by sending us an HTLC with a value smaller than this.
16988 * Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
16991 void ChannelHandshakeConfig_set_our_htlc_minimum_msat(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint64_t val);
16994 * If set, we attempt to negotiate the `scid_privacy` (referred to as `scid_alias` in the
16995 * BOLTs) option for outbound private channels. This provides better privacy by not including
16996 * our real on-chain channel UTXO in each invoice and requiring that our counterparty only
16997 * relay HTLCs to us using the channel's SCID alias.
16999 * If this option is set, channels may be created that will not be readable by LDK versions
17000 * prior to 0.0.106, causing [`ChannelManager`]'s read method to return a
17001 * [`DecodeError:InvalidValue`].
17003 * Note that setting this to true does *not* prevent us from opening channels with
17004 * counterparties that do not support the `scid_alias` option; we will simply fall back to a
17005 * private channel without that option.
17007 * Ignored if the channel is negotiated to be announced, see
17008 * [`ChannelConfig::announced_channel`] and
17009 * [`ChannelHandshakeLimits::force_announced_channel_preference`] for more.
17011 * Default value: false. This value is likely to change to true in the future.
17013 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
17014 * [`DecodeError:InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
17016 bool ChannelHandshakeConfig_get_negotiate_scid_privacy(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
17019 * If set, we attempt to negotiate the `scid_privacy` (referred to as `scid_alias` in the
17020 * BOLTs) option for outbound private channels. This provides better privacy by not including
17021 * our real on-chain channel UTXO in each invoice and requiring that our counterparty only
17022 * relay HTLCs to us using the channel's SCID alias.
17024 * If this option is set, channels may be created that will not be readable by LDK versions
17025 * prior to 0.0.106, causing [`ChannelManager`]'s read method to return a
17026 * [`DecodeError:InvalidValue`].
17028 * Note that setting this to true does *not* prevent us from opening channels with
17029 * counterparties that do not support the `scid_alias` option; we will simply fall back to a
17030 * private channel without that option.
17032 * Ignored if the channel is negotiated to be announced, see
17033 * [`ChannelConfig::announced_channel`] and
17034 * [`ChannelHandshakeLimits::force_announced_channel_preference`] for more.
17036 * Default value: false. This value is likely to change to true in the future.
17038 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
17039 * [`DecodeError:InvalidValue`]: crate::ln::msgs::DecodeError::InvalidValue
17041 void ChannelHandshakeConfig_set_negotiate_scid_privacy(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, bool val);
17044 * Constructs a new ChannelHandshakeConfig given each field
17046 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, bool negotiate_scid_privacy_arg);
17049 * Creates a copy of the ChannelHandshakeConfig
17051 struct LDKChannelHandshakeConfig ChannelHandshakeConfig_clone(const struct LDKChannelHandshakeConfig *NONNULL_PTR orig);
17054 * Creates a "default" ChannelHandshakeConfig. See struct and individual field documentaiton for details on which values are used.
17056 MUST_USE_RES struct LDKChannelHandshakeConfig ChannelHandshakeConfig_default(void);
17059 * Frees any resources used by the ChannelHandshakeLimits, if is_owned is set and inner is non-NULL.
17061 void ChannelHandshakeLimits_free(struct LDKChannelHandshakeLimits this_obj);
17064 * Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
17065 * only applies to inbound channels.
17067 * Default value: 0.
17069 uint64_t ChannelHandshakeLimits_get_min_funding_satoshis(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
17072 * Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
17073 * only applies to inbound channels.
17075 * Default value: 0.
17077 void ChannelHandshakeLimits_set_min_funding_satoshis(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
17080 * The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
17081 * you to limit the maximum minimum-size they can require.
17083 * Default value: u64::max_value.
17085 uint64_t ChannelHandshakeLimits_get_max_htlc_minimum_msat(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
17088 * The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
17089 * you to limit the maximum minimum-size they can require.
17091 * Default value: u64::max_value.
17093 void ChannelHandshakeLimits_set_max_htlc_minimum_msat(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
17096 * The remote node sets a limit on the maximum value of pending HTLCs to them at any given
17097 * time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
17099 * Default value: 0.
17101 uint64_t ChannelHandshakeLimits_get_min_max_htlc_value_in_flight_msat(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
17104 * The remote node sets a limit on the maximum value of pending HTLCs to them at any given
17105 * time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
17107 * Default value: 0.
17109 void ChannelHandshakeLimits_set_min_max_htlc_value_in_flight_msat(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
17112 * The remote node will require we keep a certain amount in direct payment to ourselves at all
17113 * time, ensuring that we are able to be punished if we broadcast an old state. This allows to
17114 * you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
17116 * Default value: u64::max_value.
17118 uint64_t ChannelHandshakeLimits_get_max_channel_reserve_satoshis(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
17121 * The remote node will require we keep a certain amount in direct payment to ourselves at all
17122 * time, ensuring that we are able to be punished if we broadcast an old state. This allows to
17123 * you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
17125 * Default value: u64::max_value.
17127 void ChannelHandshakeLimits_set_max_channel_reserve_satoshis(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
17130 * The remote node sets a limit on the maximum number of pending HTLCs to them at any given
17131 * time. This allows you to set a minimum such value.
17133 * Default value: 0.
17135 uint16_t ChannelHandshakeLimits_get_min_max_accepted_htlcs(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
17138 * The remote node sets a limit on the maximum number of pending HTLCs to them at any given
17139 * time. This allows you to set a minimum such value.
17141 * Default value: 0.
17143 void ChannelHandshakeLimits_set_min_max_accepted_htlcs(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint16_t val);
17146 * Before a channel is usable the funding transaction will need to be confirmed by at least a
17147 * certain number of blocks, specified by the node which is not the funder (as the funder can
17148 * assume they aren't going to double-spend themselves).
17149 * This config allows you to set a limit on the maximum amount of time to wait.
17151 * Default value: 144, or roughly one day and only applies to outbound channels.
17153 uint32_t ChannelHandshakeLimits_get_max_minimum_depth(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
17156 * Before a channel is usable the funding transaction will need to be confirmed by at least a
17157 * certain number of blocks, specified by the node which is not the funder (as the funder can
17158 * assume they aren't going to double-spend themselves).
17159 * This config allows you to set a limit on the maximum amount of time to wait.
17161 * Default value: 144, or roughly one day and only applies to outbound channels.
17163 void ChannelHandshakeLimits_set_max_minimum_depth(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint32_t val);
17166 * Set to force an incoming channel to match our announced channel preference in
17167 * [`ChannelConfig::announced_channel`].
17169 * For a node which is not online reliably, this should be set to true and
17170 * [`ChannelConfig::announced_channel`] set to false, ensuring that no announced (aka public)
17171 * channels will ever be opened.
17173 * Default value: true.
17175 bool ChannelHandshakeLimits_get_force_announced_channel_preference(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
17178 * Set to force an incoming channel to match our announced channel preference in
17179 * [`ChannelConfig::announced_channel`].
17181 * For a node which is not online reliably, this should be set to true and
17182 * [`ChannelConfig::announced_channel`] set to false, ensuring that no announced (aka public)
17183 * channels will ever be opened.
17185 * Default value: true.
17187 void ChannelHandshakeLimits_set_force_announced_channel_preference(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, bool val);
17190 * Set to the amount of time we're willing to wait to claim money back to us.
17192 * Not checking this value would be a security issue, as our peer would be able to set it to
17193 * max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
17195 * Default value: 2016, which we also enforce as a maximum value so you can tweak config to
17196 * reduce the loss of having useless locked funds (if your peer accepts)
17198 uint16_t ChannelHandshakeLimits_get_their_to_self_delay(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
17201 * Set to the amount of time we're willing to wait to claim money back to us.
17203 * Not checking this value would be a security issue, as our peer would be able to set it to
17204 * max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
17206 * Default value: 2016, which we also enforce as a maximum value so you can tweak config to
17207 * reduce the loss of having useless locked funds (if your peer accepts)
17209 void ChannelHandshakeLimits_set_their_to_self_delay(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint16_t val);
17212 * Constructs a new ChannelHandshakeLimits given each field
17214 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);
17217 * Creates a copy of the ChannelHandshakeLimits
17219 struct LDKChannelHandshakeLimits ChannelHandshakeLimits_clone(const struct LDKChannelHandshakeLimits *NONNULL_PTR orig);
17222 * Creates a "default" ChannelHandshakeLimits. See struct and individual field documentaiton for details on which values are used.
17224 MUST_USE_RES struct LDKChannelHandshakeLimits ChannelHandshakeLimits_default(void);
17227 * Frees any resources used by the ChannelConfig, if is_owned is set and inner is non-NULL.
17229 void ChannelConfig_free(struct LDKChannelConfig this_obj);
17232 * Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
17233 * over the channel.
17234 * This may be allowed to change at runtime in a later update, however doing so must result in
17235 * update messages sent to notify all nodes of our updated relay fee.
17237 * Default value: 0.
17239 uint32_t ChannelConfig_get_forwarding_fee_proportional_millionths(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
17242 * Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
17243 * over the channel.
17244 * This may be allowed to change at runtime in a later update, however doing so must result in
17245 * update messages sent to notify all nodes of our updated relay fee.
17247 * Default value: 0.
17249 void ChannelConfig_set_forwarding_fee_proportional_millionths(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint32_t val);
17252 * Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
17253 * excess of [`forwarding_fee_proportional_millionths`].
17254 * This may be allowed to change at runtime in a later update, however doing so must result in
17255 * update messages sent to notify all nodes of our updated relay fee.
17257 * The default value of a single satoshi roughly matches the market rate on many routing nodes
17258 * as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
17261 * Default value: 1000.
17263 * [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
17265 uint32_t ChannelConfig_get_forwarding_fee_base_msat(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
17268 * Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
17269 * excess of [`forwarding_fee_proportional_millionths`].
17270 * This may be allowed to change at runtime in a later update, however doing so must result in
17271 * update messages sent to notify all nodes of our updated relay fee.
17273 * The default value of a single satoshi roughly matches the market rate on many routing nodes
17274 * as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
17277 * Default value: 1000.
17279 * [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
17281 void ChannelConfig_set_forwarding_fee_base_msat(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint32_t val);
17284 * The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
17285 * the channel this config applies to.
17287 * This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
17288 * HTLC balance when a channel appears on-chain whereas
17289 * [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
17290 * (non-HTLC-encumbered) balance.
17292 * Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
17293 * we (or one of our watchtowers) MUST be online to check for broadcast of the current
17294 * commitment transaction at least once per this many blocks (minus some margin to allow us
17295 * enough time to broadcast and confirm a transaction, possibly with time in between to RBF
17296 * the spending transaction).
17298 * Default value: 72 (12 hours at an average of 6 blocks/hour).
17299 * Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
17300 * [`MIN_CLTV_EXPIRY_DELTA`] instead.
17302 * [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
17304 uint16_t ChannelConfig_get_cltv_expiry_delta(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
17307 * The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
17308 * the channel this config applies to.
17310 * This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
17311 * HTLC balance when a channel appears on-chain whereas
17312 * [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
17313 * (non-HTLC-encumbered) balance.
17315 * Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
17316 * we (or one of our watchtowers) MUST be online to check for broadcast of the current
17317 * commitment transaction at least once per this many blocks (minus some margin to allow us
17318 * enough time to broadcast and confirm a transaction, possibly with time in between to RBF
17319 * the spending transaction).
17321 * Default value: 72 (12 hours at an average of 6 blocks/hour).
17322 * Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
17323 * [`MIN_CLTV_EXPIRY_DELTA`] instead.
17325 * [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
17327 void ChannelConfig_set_cltv_expiry_delta(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint16_t val);
17330 * Set to announce the channel publicly and notify all nodes that they can route via this
17333 * This should only be set to true for nodes which expect to be online reliably.
17335 * As the node which funds a channel picks this value this will only apply for new outbound
17336 * channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
17338 * This cannot be changed after the initial channel handshake.
17340 * Default value: false.
17342 bool ChannelConfig_get_announced_channel(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
17345 * Set to announce the channel publicly and notify all nodes that they can route via this
17348 * This should only be set to true for nodes which expect to be online reliably.
17350 * As the node which funds a channel picks this value this will only apply for new outbound
17351 * channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
17353 * This cannot be changed after the initial channel handshake.
17355 * Default value: false.
17357 void ChannelConfig_set_announced_channel(struct LDKChannelConfig *NONNULL_PTR this_ptr, bool val);
17360 * When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
17361 * supports it, they will then enforce the mutual-close output to us matches what we provided
17362 * at intialization, preventing us from closing to an alternate pubkey.
17364 * This is set to true by default to provide a slight increase in security, though ultimately
17365 * any attacker who is able to take control of a channel can just as easily send the funds via
17366 * lightning payments, so we never require that our counterparties support this option.
17368 * This cannot be changed after a channel has been initialized.
17370 * Default value: true.
17372 bool ChannelConfig_get_commit_upfront_shutdown_pubkey(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
17375 * When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
17376 * supports it, they will then enforce the mutual-close output to us matches what we provided
17377 * at intialization, preventing us from closing to an alternate pubkey.
17379 * This is set to true by default to provide a slight increase in security, though ultimately
17380 * any attacker who is able to take control of a channel can just as easily send the funds via
17381 * lightning payments, so we never require that our counterparties support this option.
17383 * This cannot be changed after a channel has been initialized.
17385 * Default value: true.
17387 void ChannelConfig_set_commit_upfront_shutdown_pubkey(struct LDKChannelConfig *NONNULL_PTR this_ptr, bool val);
17390 * Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
17391 * small to claim on-chain.
17393 * When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
17394 * not be claimable on-chain, instead being turned into additional miner fees if either
17395 * party force-closes the channel. Because the threshold is per-HTLC, our total exposure
17396 * to such payments may be sustantial if there are many dust HTLCs present when the
17397 * channel is force-closed.
17399 * This limit is applied for sent, forwarded, and received HTLCs and limits the total
17400 * exposure across all three types per-channel. Setting this too low may prevent the
17401 * sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
17402 * important to prevent stealing of dust HTLCs by miners.
17404 * Default value: 5_000_000 msat.
17406 uint64_t ChannelConfig_get_max_dust_htlc_exposure_msat(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
17409 * Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
17410 * small to claim on-chain.
17412 * When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
17413 * not be claimable on-chain, instead being turned into additional miner fees if either
17414 * party force-closes the channel. Because the threshold is per-HTLC, our total exposure
17415 * to such payments may be sustantial if there are many dust HTLCs present when the
17416 * channel is force-closed.
17418 * This limit is applied for sent, forwarded, and received HTLCs and limits the total
17419 * exposure across all three types per-channel. Setting this too low may prevent the
17420 * sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
17421 * important to prevent stealing of dust HTLCs by miners.
17423 * Default value: 5_000_000 msat.
17425 void ChannelConfig_set_max_dust_htlc_exposure_msat(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint64_t val);
17428 * The additional fee we're willing to pay to avoid waiting for the counterparty's
17429 * `to_self_delay` to reclaim funds.
17431 * When we close a channel cooperatively with our counterparty, we negotiate a fee for the
17432 * closing transaction which both sides find acceptable, ultimately paid by the channel
17433 * funder/initiator.
17435 * When we are the funder, because we have to pay the channel closing fee, we bound the
17436 * acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
17437 * this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
17438 * [`Normal`] feerate during normal operation, this value represents the additional fee we're
17439 * willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
17442 * When we are not the funder, we require the closing transaction fee pay at least our
17443 * [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
17444 * Thus, this value is ignored when we are not the funder.
17446 * Default value: 1000 satoshis.
17448 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
17449 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
17451 uint64_t ChannelConfig_get_force_close_avoidance_max_fee_satoshis(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
17454 * The additional fee we're willing to pay to avoid waiting for the counterparty's
17455 * `to_self_delay` to reclaim funds.
17457 * When we close a channel cooperatively with our counterparty, we negotiate a fee for the
17458 * closing transaction which both sides find acceptable, ultimately paid by the channel
17459 * funder/initiator.
17461 * When we are the funder, because we have to pay the channel closing fee, we bound the
17462 * acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
17463 * this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
17464 * [`Normal`] feerate during normal operation, this value represents the additional fee we're
17465 * willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
17468 * When we are not the funder, we require the closing transaction fee pay at least our
17469 * [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
17470 * Thus, this value is ignored when we are not the funder.
17472 * Default value: 1000 satoshis.
17474 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
17475 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
17477 void ChannelConfig_set_force_close_avoidance_max_fee_satoshis(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint64_t val);
17480 * Constructs a new ChannelConfig given each field
17482 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);
17485 * Creates a copy of the ChannelConfig
17487 struct LDKChannelConfig ChannelConfig_clone(const struct LDKChannelConfig *NONNULL_PTR orig);
17490 * Creates a "default" ChannelConfig. See struct and individual field documentaiton for details on which values are used.
17492 MUST_USE_RES struct LDKChannelConfig ChannelConfig_default(void);
17495 * Serialize the ChannelConfig object into a byte array which can be read by ChannelConfig_read
17497 struct LDKCVec_u8Z ChannelConfig_write(const struct LDKChannelConfig *NONNULL_PTR obj);
17500 * Read a ChannelConfig from a byte array, created by ChannelConfig_write
17502 struct LDKCResult_ChannelConfigDecodeErrorZ ChannelConfig_read(struct LDKu8slice ser);
17505 * Frees any resources used by the UserConfig, if is_owned is set and inner is non-NULL.
17507 void UserConfig_free(struct LDKUserConfig this_obj);
17510 * Channel config that we propose to our counterparty.
17512 struct LDKChannelHandshakeConfig UserConfig_get_own_channel_config(const struct LDKUserConfig *NONNULL_PTR this_ptr);
17515 * Channel config that we propose to our counterparty.
17517 void UserConfig_set_own_channel_config(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelHandshakeConfig val);
17520 * Limits applied to our counterparty's proposed channel config settings.
17522 struct LDKChannelHandshakeLimits UserConfig_get_peer_channel_config_limits(const struct LDKUserConfig *NONNULL_PTR this_ptr);
17525 * Limits applied to our counterparty's proposed channel config settings.
17527 void UserConfig_set_peer_channel_config_limits(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelHandshakeLimits val);
17530 * Channel config which affects behavior during channel lifetime.
17532 struct LDKChannelConfig UserConfig_get_channel_options(const struct LDKUserConfig *NONNULL_PTR this_ptr);
17535 * Channel config which affects behavior during channel lifetime.
17537 void UserConfig_set_channel_options(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelConfig val);
17540 * If this is set to false, we will reject any HTLCs which were to be forwarded over private
17541 * channels. This prevents us from taking on HTLC-forwarding risk when we intend to run as a
17542 * node which is not online reliably.
17544 * For nodes which are not online reliably, you should set all channels to *not* be announced
17545 * (using [`ChannelConfig::announced_channel`] and
17546 * [`ChannelHandshakeLimits::force_announced_channel_preference`]) and set this to false to
17547 * ensure you are not exposed to any forwarding risk.
17549 * Note that because you cannot change a channel's announced state after creation, there is no
17550 * way to disable forwarding on public channels retroactively. Thus, in order to change a node
17551 * from a publicly-announced forwarding node to a private non-forwarding node you must close
17552 * all your channels and open new ones. For privacy, you should also change your node_id
17553 * (swapping all private and public key material for new ones) at that time.
17555 * Default value: false.
17557 bool UserConfig_get_accept_forwards_to_priv_channels(const struct LDKUserConfig *NONNULL_PTR this_ptr);
17560 * If this is set to false, we will reject any HTLCs which were to be forwarded over private
17561 * channels. This prevents us from taking on HTLC-forwarding risk when we intend to run as a
17562 * node which is not online reliably.
17564 * For nodes which are not online reliably, you should set all channels to *not* be announced
17565 * (using [`ChannelConfig::announced_channel`] and
17566 * [`ChannelHandshakeLimits::force_announced_channel_preference`]) and set this to false to
17567 * ensure you are not exposed to any forwarding risk.
17569 * Note that because you cannot change a channel's announced state after creation, there is no
17570 * way to disable forwarding on public channels retroactively. Thus, in order to change a node
17571 * from a publicly-announced forwarding node to a private non-forwarding node you must close
17572 * all your channels and open new ones. For privacy, you should also change your node_id
17573 * (swapping all private and public key material for new ones) at that time.
17575 * Default value: false.
17577 void UserConfig_set_accept_forwards_to_priv_channels(struct LDKUserConfig *NONNULL_PTR this_ptr, bool val);
17580 * If this is set to false, we do not accept inbound requests to open a new channel.
17581 * Default value: true.
17583 bool UserConfig_get_accept_inbound_channels(const struct LDKUserConfig *NONNULL_PTR this_ptr);
17586 * If this is set to false, we do not accept inbound requests to open a new channel.
17587 * Default value: true.
17589 void UserConfig_set_accept_inbound_channels(struct LDKUserConfig *NONNULL_PTR this_ptr, bool val);
17592 * If this is set to true, the user needs to manually accept inbound requests to open a new
17595 * When set to true, [`Event::OpenChannelRequest`] will be triggered once a request to open a
17596 * new inbound channel is received through a [`msgs::OpenChannel`] message. In that case, a
17597 * [`msgs::AcceptChannel`] message will not be sent back to the counterparty node unless the
17598 * user explicitly chooses to accept the request.
17600 * Default value: false.
17602 * [`Event::OpenChannelRequest`]: crate::util::events::Event::OpenChannelRequest
17603 * [`msgs::OpenChannel`]: crate::ln::msgs::OpenChannel
17604 * [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
17606 bool UserConfig_get_manually_accept_inbound_channels(const struct LDKUserConfig *NONNULL_PTR this_ptr);
17609 * If this is set to true, the user needs to manually accept inbound requests to open a new
17612 * When set to true, [`Event::OpenChannelRequest`] will be triggered once a request to open a
17613 * new inbound channel is received through a [`msgs::OpenChannel`] message. In that case, a
17614 * [`msgs::AcceptChannel`] message will not be sent back to the counterparty node unless the
17615 * user explicitly chooses to accept the request.
17617 * Default value: false.
17619 * [`Event::OpenChannelRequest`]: crate::util::events::Event::OpenChannelRequest
17620 * [`msgs::OpenChannel`]: crate::ln::msgs::OpenChannel
17621 * [`msgs::AcceptChannel`]: crate::ln::msgs::AcceptChannel
17623 void UserConfig_set_manually_accept_inbound_channels(struct LDKUserConfig *NONNULL_PTR this_ptr, bool val);
17626 * Constructs a new UserConfig given each field
17628 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);
17631 * Creates a copy of the UserConfig
17633 struct LDKUserConfig UserConfig_clone(const struct LDKUserConfig *NONNULL_PTR orig);
17636 * Creates a "default" UserConfig. See struct and individual field documentaiton for details on which values are used.
17638 MUST_USE_RES struct LDKUserConfig UserConfig_default(void);
17641 * Frees any resources used by the BestBlock, if is_owned is set and inner is non-NULL.
17643 void BestBlock_free(struct LDKBestBlock this_obj);
17646 * Creates a copy of the BestBlock
17648 struct LDKBestBlock BestBlock_clone(const struct LDKBestBlock *NONNULL_PTR orig);
17651 * Constructs a `BestBlock` that represents the genesis block at height 0 of the given
17654 MUST_USE_RES struct LDKBestBlock BestBlock_from_genesis(enum LDKNetwork network);
17657 * Returns a `BestBlock` as identified by the given block hash and height.
17659 MUST_USE_RES struct LDKBestBlock BestBlock_new(struct LDKThirtyTwoBytes block_hash, uint32_t height);
17662 * Returns the best block hash.
17664 MUST_USE_RES struct LDKThirtyTwoBytes BestBlock_block_hash(const struct LDKBestBlock *NONNULL_PTR this_arg);
17667 * Returns the best block height.
17669 MUST_USE_RES uint32_t BestBlock_height(const struct LDKBestBlock *NONNULL_PTR this_arg);
17672 * Creates a copy of the AccessError
17674 enum LDKAccessError AccessError_clone(const enum LDKAccessError *NONNULL_PTR orig);
17677 * Utility method to constructs a new UnknownChain-variant AccessError
17679 enum LDKAccessError AccessError_unknown_chain(void);
17682 * Utility method to constructs a new UnknownTx-variant AccessError
17684 enum LDKAccessError AccessError_unknown_tx(void);
17687 * Calls the free function if one is set
17689 void Access_free(struct LDKAccess this_ptr);
17692 * Calls the free function if one is set
17694 void Listen_free(struct LDKListen this_ptr);
17697 * Calls the free function if one is set
17699 void Confirm_free(struct LDKConfirm this_ptr);
17702 * Creates a copy of the ChannelMonitorUpdateErr
17704 enum LDKChannelMonitorUpdateErr ChannelMonitorUpdateErr_clone(const enum LDKChannelMonitorUpdateErr *NONNULL_PTR orig);
17707 * Utility method to constructs a new TemporaryFailure-variant ChannelMonitorUpdateErr
17709 enum LDKChannelMonitorUpdateErr ChannelMonitorUpdateErr_temporary_failure(void);
17712 * Utility method to constructs a new PermanentFailure-variant ChannelMonitorUpdateErr
17714 enum LDKChannelMonitorUpdateErr ChannelMonitorUpdateErr_permanent_failure(void);
17717 * Calls the free function if one is set
17719 void Watch_free(struct LDKWatch this_ptr);
17722 * Calls the free function if one is set
17724 void Filter_free(struct LDKFilter this_ptr);
17727 * Frees any resources used by the WatchedOutput, if is_owned is set and inner is non-NULL.
17729 void WatchedOutput_free(struct LDKWatchedOutput this_obj);
17732 * First block where the transaction output may have been spent.
17734 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
17736 struct LDKThirtyTwoBytes WatchedOutput_get_block_hash(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
17739 * First block where the transaction output may have been spent.
17741 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
17743 void WatchedOutput_set_block_hash(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17746 * Outpoint identifying the transaction output.
17748 struct LDKOutPoint WatchedOutput_get_outpoint(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
17751 * Outpoint identifying the transaction output.
17753 void WatchedOutput_set_outpoint(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKOutPoint val);
17756 * Spending condition of the transaction output.
17758 struct LDKu8slice WatchedOutput_get_script_pubkey(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
17761 * Spending condition of the transaction output.
17763 void WatchedOutput_set_script_pubkey(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
17766 * Constructs a new WatchedOutput given each field
17768 MUST_USE_RES struct LDKWatchedOutput WatchedOutput_new(struct LDKThirtyTwoBytes block_hash_arg, struct LDKOutPoint outpoint_arg, struct LDKCVec_u8Z script_pubkey_arg);
17771 * Creates a copy of the WatchedOutput
17773 struct LDKWatchedOutput WatchedOutput_clone(const struct LDKWatchedOutput *NONNULL_PTR orig);
17776 * Checks if two WatchedOutputs contain equal inner contents.
17778 uint64_t WatchedOutput_hash(const struct LDKWatchedOutput *NONNULL_PTR o);
17781 * Calls the free function if one is set
17783 void BroadcasterInterface_free(struct LDKBroadcasterInterface this_ptr);
17786 * Creates a copy of the ConfirmationTarget
17788 enum LDKConfirmationTarget ConfirmationTarget_clone(const enum LDKConfirmationTarget *NONNULL_PTR orig);
17791 * Utility method to constructs a new Background-variant ConfirmationTarget
17793 enum LDKConfirmationTarget ConfirmationTarget_background(void);
17796 * Utility method to constructs a new Normal-variant ConfirmationTarget
17798 enum LDKConfirmationTarget ConfirmationTarget_normal(void);
17801 * Utility method to constructs a new HighPriority-variant ConfirmationTarget
17803 enum LDKConfirmationTarget ConfirmationTarget_high_priority(void);
17806 * Checks if two ConfirmationTargets contain equal inner contents.
17807 * This ignores pointers and is_owned flags and looks at the values in fields.
17809 bool ConfirmationTarget_eq(const enum LDKConfirmationTarget *NONNULL_PTR a, const enum LDKConfirmationTarget *NONNULL_PTR b);
17812 * Calls the free function if one is set
17814 void FeeEstimator_free(struct LDKFeeEstimator this_ptr);
17817 * Frees any resources used by the MonitorUpdateId, if is_owned is set and inner is non-NULL.
17819 void MonitorUpdateId_free(struct LDKMonitorUpdateId this_obj);
17822 * Creates a copy of the MonitorUpdateId
17824 struct LDKMonitorUpdateId MonitorUpdateId_clone(const struct LDKMonitorUpdateId *NONNULL_PTR orig);
17827 * Checks if two MonitorUpdateIds contain equal inner contents.
17829 uint64_t MonitorUpdateId_hash(const struct LDKMonitorUpdateId *NONNULL_PTR o);
17832 * Checks if two MonitorUpdateIds contain equal inner contents.
17833 * This ignores pointers and is_owned flags and looks at the values in fields.
17834 * Two objects with NULL inner values will be considered "equal" here.
17836 bool MonitorUpdateId_eq(const struct LDKMonitorUpdateId *NONNULL_PTR a, const struct LDKMonitorUpdateId *NONNULL_PTR b);
17839 * Calls the free function if one is set
17841 void Persist_free(struct LDKPersist this_ptr);
17844 * Frees any resources used by the LockedChannelMonitor, if is_owned is set and inner is non-NULL.
17846 void LockedChannelMonitor_free(struct LDKLockedChannelMonitor this_obj);
17849 * Frees any resources used by the ChainMonitor, if is_owned is set and inner is non-NULL.
17851 void ChainMonitor_free(struct LDKChainMonitor this_obj);
17854 * Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
17856 * When an optional chain source implementing [`chain::Filter`] is provided, the chain monitor
17857 * will call back to it indicating transactions and outputs of interest. This allows clients to
17858 * pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may
17859 * always need to fetch full blocks absent another means for determining which blocks contain
17860 * transactions relevant to the watched channels.
17862 MUST_USE_RES struct LDKChainMonitor ChainMonitor_new(struct LDKCOption_FilterZ chain_source, struct LDKBroadcasterInterface broadcaster, struct LDKLogger logger, struct LDKFeeEstimator feeest, struct LDKPersist persister);
17865 * Gets the balances in the contained [`ChannelMonitor`]s which are claimable on-chain or
17866 * claims which are awaiting confirmation.
17868 * Includes the balances from each [`ChannelMonitor`] *except* those included in
17869 * `ignored_channels`, allowing you to filter out balances from channels which are still open
17870 * (and whose balance should likely be pulled from the [`ChannelDetails`]).
17872 * See [`ChannelMonitor::get_claimable_balances`] for more details on the exact criteria for
17873 * inclusion in the return value.
17875 MUST_USE_RES struct LDKCVec_BalanceZ ChainMonitor_get_claimable_balances(const struct LDKChainMonitor *NONNULL_PTR this_arg, struct LDKCVec_ChannelDetailsZ ignored_channels);
17878 * Gets the [`LockedChannelMonitor`] for a given funding outpoint, returning an `Err` if no
17879 * such [`ChannelMonitor`] is currently being monitored for.
17881 * Note that the result holds a mutex over our monitor set, and should not be held
17884 MUST_USE_RES struct LDKCResult_LockedChannelMonitorNoneZ ChainMonitor_get_monitor(const struct LDKChainMonitor *NONNULL_PTR this_arg, struct LDKOutPoint funding_txo);
17887 * Lists the funding outpoint of each [`ChannelMonitor`] being monitored.
17889 * Note that [`ChannelMonitor`]s are not removed when a channel is closed as they are always
17890 * monitoring for on-chain state resolutions.
17892 MUST_USE_RES struct LDKCVec_OutPointZ ChainMonitor_list_monitors(const struct LDKChainMonitor *NONNULL_PTR this_arg);
17895 * Indicates the persistence of a [`ChannelMonitor`] has completed after
17896 * [`ChannelMonitorUpdateErr::TemporaryFailure`] was returned from an update operation.
17898 * Thus, the anticipated use is, at a high level:
17899 * 1) This [`ChainMonitor`] calls [`Persist::update_persisted_channel`] which stores the
17900 * update to disk and begins updating any remote (e.g. watchtower/backup) copies,
17901 * returning [`ChannelMonitorUpdateErr::TemporaryFailure`],
17902 * 2) once all remote copies are updated, you call this function with the
17903 * `completed_update_id` that completed, and once all pending updates have completed the
17904 * channel will be re-enabled.
17906 * Returns an [`APIError::APIMisuseError`] if `funding_txo` does not match any currently
17907 * registered [`ChannelMonitor`]s.
17909 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);
17912 * Constructs a new Listen which calls the relevant methods on this_arg.
17913 * This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
17915 struct LDKListen ChainMonitor_as_Listen(const struct LDKChainMonitor *NONNULL_PTR this_arg);
17918 * Constructs a new Confirm which calls the relevant methods on this_arg.
17919 * This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
17921 struct LDKConfirm ChainMonitor_as_Confirm(const struct LDKChainMonitor *NONNULL_PTR this_arg);
17924 * Constructs a new Watch which calls the relevant methods on this_arg.
17925 * This copies the `inner` pointer in this_arg and thus the returned Watch must be freed before this_arg is
17927 struct LDKWatch ChainMonitor_as_Watch(const struct LDKChainMonitor *NONNULL_PTR this_arg);
17930 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
17931 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
17933 struct LDKEventsProvider ChainMonitor_as_EventsProvider(const struct LDKChainMonitor *NONNULL_PTR this_arg);
17936 * Frees any resources used by the ChannelMonitorUpdate, if is_owned is set and inner is non-NULL.
17938 void ChannelMonitorUpdate_free(struct LDKChannelMonitorUpdate this_obj);
17941 * The sequence number of this update. Updates *must* be replayed in-order according to this
17942 * sequence number (and updates may panic if they are not). The update_id values are strictly
17943 * increasing and increase by one for each new update, with one exception specified below.
17945 * This sequence number is also used to track up to which points updates which returned
17946 * ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
17947 * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
17949 * The only instance where update_id values are not strictly increasing is the case where we
17950 * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
17951 * its docs for more details.
17953 uint64_t ChannelMonitorUpdate_get_update_id(const struct LDKChannelMonitorUpdate *NONNULL_PTR this_ptr);
17956 * The sequence number of this update. Updates *must* be replayed in-order according to this
17957 * sequence number (and updates may panic if they are not). The update_id values are strictly
17958 * increasing and increase by one for each new update, with one exception specified below.
17960 * This sequence number is also used to track up to which points updates which returned
17961 * ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
17962 * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
17964 * The only instance where update_id values are not strictly increasing is the case where we
17965 * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
17966 * its docs for more details.
17968 void ChannelMonitorUpdate_set_update_id(struct LDKChannelMonitorUpdate *NONNULL_PTR this_ptr, uint64_t val);
17971 * Creates a copy of the ChannelMonitorUpdate
17973 struct LDKChannelMonitorUpdate ChannelMonitorUpdate_clone(const struct LDKChannelMonitorUpdate *NONNULL_PTR orig);
17976 * Serialize the ChannelMonitorUpdate object into a byte array which can be read by ChannelMonitorUpdate_read
17978 struct LDKCVec_u8Z ChannelMonitorUpdate_write(const struct LDKChannelMonitorUpdate *NONNULL_PTR obj);
17981 * Read a ChannelMonitorUpdate from a byte array, created by ChannelMonitorUpdate_write
17983 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ ChannelMonitorUpdate_read(struct LDKu8slice ser);
17986 * Frees any resources used by the MonitorEvent
17988 void MonitorEvent_free(struct LDKMonitorEvent this_ptr);
17991 * Creates a copy of the MonitorEvent
17993 struct LDKMonitorEvent MonitorEvent_clone(const struct LDKMonitorEvent *NONNULL_PTR orig);
17996 * Utility method to constructs a new HTLCEvent-variant MonitorEvent
17998 struct LDKMonitorEvent MonitorEvent_htlcevent(struct LDKHTLCUpdate a);
18001 * Utility method to constructs a new CommitmentTxConfirmed-variant MonitorEvent
18003 struct LDKMonitorEvent MonitorEvent_commitment_tx_confirmed(struct LDKOutPoint a);
18006 * Utility method to constructs a new UpdateCompleted-variant MonitorEvent
18008 struct LDKMonitorEvent MonitorEvent_update_completed(struct LDKOutPoint funding_txo, uint64_t monitor_update_id);
18011 * Utility method to constructs a new UpdateFailed-variant MonitorEvent
18013 struct LDKMonitorEvent MonitorEvent_update_failed(struct LDKOutPoint a);
18016 * Serialize the MonitorEvent object into a byte array which can be read by MonitorEvent_read
18018 struct LDKCVec_u8Z MonitorEvent_write(const struct LDKMonitorEvent *NONNULL_PTR obj);
18021 * Read a MonitorEvent from a byte array, created by MonitorEvent_write
18023 struct LDKCResult_COption_MonitorEventZDecodeErrorZ MonitorEvent_read(struct LDKu8slice ser);
18026 * Frees any resources used by the HTLCUpdate, if is_owned is set and inner is non-NULL.
18028 void HTLCUpdate_free(struct LDKHTLCUpdate this_obj);
18031 * Creates a copy of the HTLCUpdate
18033 struct LDKHTLCUpdate HTLCUpdate_clone(const struct LDKHTLCUpdate *NONNULL_PTR orig);
18036 * Serialize the HTLCUpdate object into a byte array which can be read by HTLCUpdate_read
18038 struct LDKCVec_u8Z HTLCUpdate_write(const struct LDKHTLCUpdate *NONNULL_PTR obj);
18041 * Read a HTLCUpdate from a byte array, created by HTLCUpdate_write
18043 struct LDKCResult_HTLCUpdateDecodeErrorZ HTLCUpdate_read(struct LDKu8slice ser);
18046 * Frees any resources used by the Balance
18048 void Balance_free(struct LDKBalance this_ptr);
18051 * Creates a copy of the Balance
18053 struct LDKBalance Balance_clone(const struct LDKBalance *NONNULL_PTR orig);
18056 * Utility method to constructs a new ClaimableOnChannelClose-variant Balance
18058 struct LDKBalance Balance_claimable_on_channel_close(uint64_t claimable_amount_satoshis);
18061 * Utility method to constructs a new ClaimableAwaitingConfirmations-variant Balance
18063 struct LDKBalance Balance_claimable_awaiting_confirmations(uint64_t claimable_amount_satoshis, uint32_t confirmation_height);
18066 * Utility method to constructs a new ContentiousClaimable-variant Balance
18068 struct LDKBalance Balance_contentious_claimable(uint64_t claimable_amount_satoshis, uint32_t timeout_height);
18071 * Utility method to constructs a new MaybeClaimableHTLCAwaitingTimeout-variant Balance
18073 struct LDKBalance Balance_maybe_claimable_htlcawaiting_timeout(uint64_t claimable_amount_satoshis, uint32_t claimable_height);
18076 * Checks if two Balances contain equal inner contents.
18077 * This ignores pointers and is_owned flags and looks at the values in fields.
18079 bool Balance_eq(const struct LDKBalance *NONNULL_PTR a, const struct LDKBalance *NONNULL_PTR b);
18082 * Frees any resources used by the ChannelMonitor, if is_owned is set and inner is non-NULL.
18084 void ChannelMonitor_free(struct LDKChannelMonitor this_obj);
18087 * Serialize the ChannelMonitor object into a byte array which can be read by ChannelMonitor_read
18089 struct LDKCVec_u8Z ChannelMonitor_write(const struct LDKChannelMonitor *NONNULL_PTR obj);
18092 * Updates a ChannelMonitor on the basis of some new information provided by the Channel
18095 * panics if the given update is not the next update by update_id.
18097 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);
18100 * Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
18103 MUST_USE_RES uint64_t ChannelMonitor_get_latest_update_id(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
18106 * Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
18108 MUST_USE_RES struct LDKC2Tuple_OutPointScriptZ ChannelMonitor_get_funding_txo(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
18111 * Gets a list of txids, with their output scripts (in the order they appear in the
18112 * transaction), which we must learn about spends of via block_connected().
18114 MUST_USE_RES struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ ChannelMonitor_get_outputs_to_watch(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
18117 * Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
18118 * calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
18119 * have been registered.
18121 void ChannelMonitor_load_outputs_to_watch(const struct LDKChannelMonitor *NONNULL_PTR this_arg, const struct LDKFilter *NONNULL_PTR filter);
18124 * Get the list of HTLCs who's status has been updated on chain. This should be called by
18125 * ChannelManager via [`chain::Watch::release_pending_monitor_events`].
18127 MUST_USE_RES struct LDKCVec_MonitorEventZ ChannelMonitor_get_and_clear_pending_monitor_events(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
18130 * Gets the list of pending events which were generated by previous actions, clearing the list
18133 * This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
18134 * EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
18135 * no internal locking in ChannelMonitors.
18137 MUST_USE_RES struct LDKCVec_EventZ ChannelMonitor_get_and_clear_pending_events(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
18140 * Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
18141 * the Channel was out-of-date. You may use it to get a broadcastable holder toxic tx in case of
18142 * fallen-behind, i.e when receiving a channel_reestablish with a proof that our counterparty side knows
18143 * a higher revocation secret than the holder commitment number we are aware of. Broadcasting these
18144 * transactions are UNSAFE, as they allow counterparty side to punish you. Nevertheless you may want to
18145 * broadcast them if counterparty don't close channel with his higher commitment transaction after a
18146 * substantial amount of time (a month or even a year) to get back funds. Best may be to contact
18147 * out-of-band the other node operator to coordinate with him if option is available to you.
18148 * In any-case, choice is up to the user.
18150 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);
18153 * Processes transactions in a newly connected block, which may result in any of the following:
18154 * - update the monitor's state against resolved HTLCs
18155 * - punish the counterparty in the case of seeing a revoked commitment transaction
18156 * - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
18157 * - detect settled outputs for later spending
18158 * - schedule and bump any in-flight claims
18160 * Returns any new outputs to watch from `txdata`; after called, these are also included in
18161 * [`get_outputs_to_watch`].
18163 * [`get_outputs_to_watch`]: #method.get_outputs_to_watch
18165 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);
18168 * Determines if the disconnected block contained any transactions of interest and updates
18171 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);
18174 * Processes transactions confirmed in a block with the given header and height, returning new
18175 * outputs to watch. See [`block_connected`] for details.
18177 * Used instead of [`block_connected`] by clients that are notified of transactions rather than
18178 * blocks. See [`chain::Confirm`] for calling expectations.
18180 * [`block_connected`]: Self::block_connected
18182 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);
18185 * Processes a transaction that was reorganized out of the chain.
18187 * Used instead of [`block_disconnected`] by clients that are notified of transactions rather
18188 * than blocks. See [`chain::Confirm`] for calling expectations.
18190 * [`block_disconnected`]: Self::block_disconnected
18192 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);
18195 * Updates the monitor with the current best chain tip, returning new outputs to watch. See
18196 * [`block_connected`] for details.
18198 * Used instead of [`block_connected`] by clients that are notified of transactions rather than
18199 * blocks. See [`chain::Confirm`] for calling expectations.
18201 * [`block_connected`]: Self::block_connected
18203 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);
18206 * Returns the set of txids that should be monitored for re-organization out of the chain.
18208 MUST_USE_RES struct LDKCVec_TxidZ ChannelMonitor_get_relevant_txids(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
18211 * Gets the latest best block which was connected either via the [`chain::Listen`] or
18212 * [`chain::Confirm`] interfaces.
18214 MUST_USE_RES struct LDKBestBlock ChannelMonitor_current_best_block(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
18217 * Gets the balances in this channel which are either claimable by us if we were to
18218 * force-close the channel now or which are claimable on-chain (possibly awaiting
18221 * Any balances in the channel which are available on-chain (excluding on-chain fees) are
18222 * included here until an [`Event::SpendableOutputs`] event has been generated for the
18223 * balance, or until our counterparty has claimed the balance and accrued several
18224 * confirmations on the claim transaction.
18226 * Note that the balances available when you or your counterparty have broadcasted revoked
18227 * state(s) may not be fully captured here.
18229 * See [`Balance`] for additional details on the types of claimable balances which
18230 * may be returned here and their meanings.
18232 MUST_USE_RES struct LDKCVec_BalanceZ ChannelMonitor_get_claimable_balances(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
18235 * Read a C2Tuple_BlockHashChannelMonitorZ from a byte array, created by C2Tuple_BlockHashChannelMonitorZ_write
18237 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ C2Tuple_BlockHashChannelMonitorZ_read(struct LDKu8slice ser, const struct LDKKeysInterface *NONNULL_PTR arg);
18240 * Frees any resources used by the OutPoint, if is_owned is set and inner is non-NULL.
18242 void OutPoint_free(struct LDKOutPoint this_obj);
18245 * The referenced transaction's txid.
18247 const uint8_t (*OutPoint_get_txid(const struct LDKOutPoint *NONNULL_PTR this_ptr))[32];
18250 * The referenced transaction's txid.
18252 void OutPoint_set_txid(struct LDKOutPoint *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
18255 * The index of the referenced output in its transaction's vout.
18257 uint16_t OutPoint_get_index(const struct LDKOutPoint *NONNULL_PTR this_ptr);
18260 * The index of the referenced output in its transaction's vout.
18262 void OutPoint_set_index(struct LDKOutPoint *NONNULL_PTR this_ptr, uint16_t val);
18265 * Constructs a new OutPoint given each field
18267 MUST_USE_RES struct LDKOutPoint OutPoint_new(struct LDKThirtyTwoBytes txid_arg, uint16_t index_arg);
18270 * Creates a copy of the OutPoint
18272 struct LDKOutPoint OutPoint_clone(const struct LDKOutPoint *NONNULL_PTR orig);
18275 * Checks if two OutPoints contain equal inner contents.
18276 * This ignores pointers and is_owned flags and looks at the values in fields.
18277 * Two objects with NULL inner values will be considered "equal" here.
18279 bool OutPoint_eq(const struct LDKOutPoint *NONNULL_PTR a, const struct LDKOutPoint *NONNULL_PTR b);
18282 * Checks if two OutPoints contain equal inner contents.
18284 uint64_t OutPoint_hash(const struct LDKOutPoint *NONNULL_PTR o);
18287 * Convert an `OutPoint` to a lightning channel id.
18289 MUST_USE_RES struct LDKThirtyTwoBytes OutPoint_to_channel_id(const struct LDKOutPoint *NONNULL_PTR this_arg);
18292 * Serialize the OutPoint object into a byte array which can be read by OutPoint_read
18294 struct LDKCVec_u8Z OutPoint_write(const struct LDKOutPoint *NONNULL_PTR obj);
18297 * Read a OutPoint from a byte array, created by OutPoint_write
18299 struct LDKCResult_OutPointDecodeErrorZ OutPoint_read(struct LDKu8slice ser);
18302 * Frees any resources used by the DelayedPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
18304 void DelayedPaymentOutputDescriptor_free(struct LDKDelayedPaymentOutputDescriptor this_obj);
18307 * The outpoint which is spendable
18309 struct LDKOutPoint DelayedPaymentOutputDescriptor_get_outpoint(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
18312 * The outpoint which is spendable
18314 void DelayedPaymentOutputDescriptor_set_outpoint(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKOutPoint val);
18317 * Per commitment point to derive delayed_payment_key by key holder
18319 struct LDKPublicKey DelayedPaymentOutputDescriptor_get_per_commitment_point(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
18322 * Per commitment point to derive delayed_payment_key by key holder
18324 void DelayedPaymentOutputDescriptor_set_per_commitment_point(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKPublicKey val);
18327 * The nSequence value which must be set in the spending input to satisfy the OP_CSV in
18328 * the witness_script.
18330 uint16_t DelayedPaymentOutputDescriptor_get_to_self_delay(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
18333 * The nSequence value which must be set in the spending input to satisfy the OP_CSV in
18334 * the witness_script.
18336 void DelayedPaymentOutputDescriptor_set_to_self_delay(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint16_t val);
18339 * The output which is referenced by the given outpoint
18341 void DelayedPaymentOutputDescriptor_set_output(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKTxOut val);
18344 * The revocation point specific to the commitment transaction which was broadcast. Used to
18345 * derive the witnessScript for this output.
18347 struct LDKPublicKey DelayedPaymentOutputDescriptor_get_revocation_pubkey(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
18350 * The revocation point specific to the commitment transaction which was broadcast. Used to
18351 * derive the witnessScript for this output.
18353 void DelayedPaymentOutputDescriptor_set_revocation_pubkey(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKPublicKey val);
18356 * Arbitrary identification information returned by a call to
18357 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
18358 * the channel to spend the output.
18360 const uint8_t (*DelayedPaymentOutputDescriptor_get_channel_keys_id(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr))[32];
18363 * Arbitrary identification information returned by a call to
18364 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
18365 * the channel to spend the output.
18367 void DelayedPaymentOutputDescriptor_set_channel_keys_id(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
18370 * The value of the channel which this output originated from, possibly indirectly.
18372 uint64_t DelayedPaymentOutputDescriptor_get_channel_value_satoshis(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
18375 * The value of the channel which this output originated from, possibly indirectly.
18377 void DelayedPaymentOutputDescriptor_set_channel_value_satoshis(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint64_t val);
18380 * Constructs a new DelayedPaymentOutputDescriptor given each field
18382 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);
18385 * Creates a copy of the DelayedPaymentOutputDescriptor
18387 struct LDKDelayedPaymentOutputDescriptor DelayedPaymentOutputDescriptor_clone(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR orig);
18390 * Serialize the DelayedPaymentOutputDescriptor object into a byte array which can be read by DelayedPaymentOutputDescriptor_read
18392 struct LDKCVec_u8Z DelayedPaymentOutputDescriptor_write(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR obj);
18395 * Read a DelayedPaymentOutputDescriptor from a byte array, created by DelayedPaymentOutputDescriptor_write
18397 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ DelayedPaymentOutputDescriptor_read(struct LDKu8slice ser);
18400 * Frees any resources used by the StaticPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
18402 void StaticPaymentOutputDescriptor_free(struct LDKStaticPaymentOutputDescriptor this_obj);
18405 * The outpoint which is spendable
18407 struct LDKOutPoint StaticPaymentOutputDescriptor_get_outpoint(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr);
18410 * The outpoint which is spendable
18412 void StaticPaymentOutputDescriptor_set_outpoint(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKOutPoint val);
18415 * The output which is referenced by the given outpoint
18417 void StaticPaymentOutputDescriptor_set_output(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKTxOut val);
18420 * Arbitrary identification information returned by a call to
18421 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
18422 * the channel to spend the output.
18424 const uint8_t (*StaticPaymentOutputDescriptor_get_channel_keys_id(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr))[32];
18427 * Arbitrary identification information returned by a call to
18428 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
18429 * the channel to spend the output.
18431 void StaticPaymentOutputDescriptor_set_channel_keys_id(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
18434 * The value of the channel which this transactions spends.
18436 uint64_t StaticPaymentOutputDescriptor_get_channel_value_satoshis(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr);
18439 * The value of the channel which this transactions spends.
18441 void StaticPaymentOutputDescriptor_set_channel_value_satoshis(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint64_t val);
18444 * Constructs a new StaticPaymentOutputDescriptor given each field
18446 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);
18449 * Creates a copy of the StaticPaymentOutputDescriptor
18451 struct LDKStaticPaymentOutputDescriptor StaticPaymentOutputDescriptor_clone(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR orig);
18454 * Serialize the StaticPaymentOutputDescriptor object into a byte array which can be read by StaticPaymentOutputDescriptor_read
18456 struct LDKCVec_u8Z StaticPaymentOutputDescriptor_write(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR obj);
18459 * Read a StaticPaymentOutputDescriptor from a byte array, created by StaticPaymentOutputDescriptor_write
18461 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ StaticPaymentOutputDescriptor_read(struct LDKu8slice ser);
18464 * Frees any resources used by the SpendableOutputDescriptor
18466 void SpendableOutputDescriptor_free(struct LDKSpendableOutputDescriptor this_ptr);
18469 * Creates a copy of the SpendableOutputDescriptor
18471 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_clone(const struct LDKSpendableOutputDescriptor *NONNULL_PTR orig);
18474 * Utility method to constructs a new StaticOutput-variant SpendableOutputDescriptor
18476 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_static_output(struct LDKOutPoint outpoint, struct LDKTxOut output);
18479 * Utility method to constructs a new DelayedPaymentOutput-variant SpendableOutputDescriptor
18481 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_delayed_payment_output(struct LDKDelayedPaymentOutputDescriptor a);
18484 * Utility method to constructs a new StaticPaymentOutput-variant SpendableOutputDescriptor
18486 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_static_payment_output(struct LDKStaticPaymentOutputDescriptor a);
18489 * Serialize the SpendableOutputDescriptor object into a byte array which can be read by SpendableOutputDescriptor_read
18491 struct LDKCVec_u8Z SpendableOutputDescriptor_write(const struct LDKSpendableOutputDescriptor *NONNULL_PTR obj);
18494 * Read a SpendableOutputDescriptor from a byte array, created by SpendableOutputDescriptor_write
18496 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ SpendableOutputDescriptor_read(struct LDKu8slice ser);
18499 * Calls the free function if one is set
18501 void BaseSign_free(struct LDKBaseSign this_ptr);
18504 * Creates a copy of a Sign
18506 struct LDKSign Sign_clone(const struct LDKSign *NONNULL_PTR orig);
18509 * Calls the free function if one is set
18511 void Sign_free(struct LDKSign this_ptr);
18514 * Creates a copy of the Recipient
18516 enum LDKRecipient Recipient_clone(const enum LDKRecipient *NONNULL_PTR orig);
18519 * Utility method to constructs a new Node-variant Recipient
18521 enum LDKRecipient Recipient_node(void);
18524 * Utility method to constructs a new PhantomNode-variant Recipient
18526 enum LDKRecipient Recipient_phantom_node(void);
18529 * Calls the free function if one is set
18531 void KeysInterface_free(struct LDKKeysInterface this_ptr);
18534 * Frees any resources used by the InMemorySigner, if is_owned is set and inner is non-NULL.
18536 void InMemorySigner_free(struct LDKInMemorySigner this_obj);
18539 * Private key of anchor tx
18541 const uint8_t (*InMemorySigner_get_funding_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
18544 * Private key of anchor tx
18546 void InMemorySigner_set_funding_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
18549 * Holder secret key for blinded revocation pubkey
18551 const uint8_t (*InMemorySigner_get_revocation_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
18554 * Holder secret key for blinded revocation pubkey
18556 void InMemorySigner_set_revocation_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
18559 * Holder secret key used for our balance in counterparty-broadcasted commitment transactions
18561 const uint8_t (*InMemorySigner_get_payment_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
18564 * Holder secret key used for our balance in counterparty-broadcasted commitment transactions
18566 void InMemorySigner_set_payment_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
18569 * Holder secret key used in HTLC tx
18571 const uint8_t (*InMemorySigner_get_delayed_payment_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
18574 * Holder secret key used in HTLC tx
18576 void InMemorySigner_set_delayed_payment_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
18579 * Holder htlc secret key used in commitment tx htlc outputs
18581 const uint8_t (*InMemorySigner_get_htlc_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
18584 * Holder htlc secret key used in commitment tx htlc outputs
18586 void InMemorySigner_set_htlc_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
18591 const uint8_t (*InMemorySigner_get_commitment_seed(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
18596 void InMemorySigner_set_commitment_seed(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
18599 * Creates a copy of the InMemorySigner
18601 struct LDKInMemorySigner InMemorySigner_clone(const struct LDKInMemorySigner *NONNULL_PTR orig);
18604 * Create a new InMemorySigner
18606 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);
18609 * Counterparty pubkeys.
18610 * Will panic if ready_channel wasn't called.
18612 MUST_USE_RES struct LDKChannelPublicKeys InMemorySigner_counterparty_pubkeys(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18615 * The contest_delay value specified by our counterparty and applied on holder-broadcastable
18616 * transactions, ie the amount of time that we have to wait to recover our funds if we
18617 * broadcast a transaction.
18618 * Will panic if ready_channel wasn't called.
18620 MUST_USE_RES uint16_t InMemorySigner_counterparty_selected_contest_delay(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18623 * The contest_delay value specified by us and applied on transactions broadcastable
18624 * by our counterparty, ie the amount of time that they have to wait to recover their funds
18625 * if they broadcast a transaction.
18626 * Will panic if ready_channel wasn't called.
18628 MUST_USE_RES uint16_t InMemorySigner_holder_selected_contest_delay(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18631 * Whether the holder is the initiator
18632 * Will panic if ready_channel wasn't called.
18634 MUST_USE_RES bool InMemorySigner_is_outbound(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18638 * Will panic if ready_channel wasn't called.
18640 MUST_USE_RES struct LDKOutPoint InMemorySigner_funding_outpoint(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18643 * Obtain a ChannelTransactionParameters for this channel, to be used when verifying or
18644 * building transactions.
18646 * Will panic if ready_channel wasn't called.
18648 MUST_USE_RES struct LDKChannelTransactionParameters InMemorySigner_get_channel_parameters(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18651 * Whether anchors should be used.
18652 * Will panic if ready_channel wasn't called.
18654 MUST_USE_RES bool InMemorySigner_opt_anchors(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18657 * Sign the single input of spend_tx at index `input_idx` which spends the output
18658 * described by descriptor, returning the witness stack for the input.
18660 * Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
18661 * is not spending the outpoint described by `descriptor.outpoint`,
18662 * or if an output descriptor script_pubkey does not match the one we can spend.
18664 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);
18667 * Sign the single input of spend_tx at index `input_idx` which spends the output
18668 * described by descriptor, returning the witness stack for the input.
18670 * Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
18671 * is not spending the outpoint described by `descriptor.outpoint`, does not have a
18672 * sequence set to `descriptor.to_self_delay`, or if an output descriptor
18673 * script_pubkey does not match the one we can spend.
18675 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);
18678 * Constructs a new BaseSign which calls the relevant methods on this_arg.
18679 * This copies the `inner` pointer in this_arg and thus the returned BaseSign must be freed before this_arg is
18681 struct LDKBaseSign InMemorySigner_as_BaseSign(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18684 * Constructs a new Sign which calls the relevant methods on this_arg.
18685 * This copies the `inner` pointer in this_arg and thus the returned Sign must be freed before this_arg is
18687 struct LDKSign InMemorySigner_as_Sign(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
18690 * Serialize the InMemorySigner object into a byte array which can be read by InMemorySigner_read
18692 struct LDKCVec_u8Z InMemorySigner_write(const struct LDKInMemorySigner *NONNULL_PTR obj);
18695 * Read a InMemorySigner from a byte array, created by InMemorySigner_write
18697 struct LDKCResult_InMemorySignerDecodeErrorZ InMemorySigner_read(struct LDKu8slice ser, struct LDKSecretKey arg);
18700 * Frees any resources used by the KeysManager, if is_owned is set and inner is non-NULL.
18702 void KeysManager_free(struct LDKKeysManager this_obj);
18705 * Constructs a KeysManager from a 32-byte seed. If the seed is in some way biased (eg your
18706 * CSRNG is busted) this may panic (but more importantly, you will possibly lose funds).
18707 * starting_time isn't strictly required to actually be a time, but it must absolutely,
18708 * without a doubt, be unique to this instance. ie if you start multiple times with the same
18709 * seed, starting_time must be unique to each run. Thus, the easiest way to achieve this is to
18710 * simply use the current time (with very high precision).
18712 * The seed MUST be backed up safely prior to use so that the keys can be re-created, however,
18713 * obviously, starting_time should be unique every time you reload the library - it is only
18714 * used to generate new ephemeral key data (which will be stored by the individual channel if
18717 * Note that the seed is required to recover certain on-chain funds independent of
18718 * ChannelMonitor data, though a current copy of ChannelMonitor data is also required for any
18719 * channel, and some on-chain during-closing funds.
18721 * Note that until the 0.1 release there is no guarantee of backward compatibility between
18722 * versions. Once the library is more fully supported, the docs will be updated to include a
18723 * detailed description of the guarantee.
18725 MUST_USE_RES struct LDKKeysManager KeysManager_new(const uint8_t (*seed)[32], uint64_t starting_time_secs, uint32_t starting_time_nanos);
18728 * Derive an old Sign containing per-channel secrets based on a key derivation parameters.
18730 * Key derivation parameters are accessible through a per-channel secrets
18731 * Sign::channel_keys_id and is provided inside DynamicOuputP2WSH in case of
18732 * onchain output detection for which a corresponding delayed_payment_key must be derived.
18734 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]);
18737 * Creates a Transaction which spends the given descriptors to the given outputs, plus an
18738 * output to the given change destination (if sufficient change value remains). The
18739 * transaction will have a feerate, at least, of the given value.
18741 * Returns `Err(())` if the output value is greater than the input value minus required fee,
18742 * if a descriptor was duplicated, or if an output descriptor `script_pubkey`
18743 * does not match the one we can spend.
18745 * We do not enforce that outputs meet the dust limit or that any output scripts are standard.
18747 * May panic if the `SpendableOutputDescriptor`s were not generated by Channels which used
18748 * this KeysManager or one of the `InMemorySigner` created by this KeysManager.
18750 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);
18753 * Constructs a new KeysInterface which calls the relevant methods on this_arg.
18754 * This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is
18756 struct LDKKeysInterface KeysManager_as_KeysInterface(const struct LDKKeysManager *NONNULL_PTR this_arg);
18759 * Frees any resources used by the PhantomKeysManager, if is_owned is set and inner is non-NULL.
18761 void PhantomKeysManager_free(struct LDKPhantomKeysManager this_obj);
18764 * Constructs a new KeysInterface which calls the relevant methods on this_arg.
18765 * This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is
18767 struct LDKKeysInterface PhantomKeysManager_as_KeysInterface(const struct LDKPhantomKeysManager *NONNULL_PTR this_arg);
18770 * Constructs a `PhantomKeysManager` given a 32-byte seed and an additional `cross_node_seed`
18771 * that is shared across all nodes that intend to participate in [phantom node payments] together.
18773 * See [`KeysManager::new`] for more information on `seed`, `starting_time_secs`, and
18774 * `starting_time_nanos`.
18776 * `cross_node_seed` must be the same across all phantom payment-receiving nodes and also the
18777 * same across restarts, or else inbound payments may fail.
18779 * [phantom node payments]: PhantomKeysManager
18781 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]);
18784 * See [`KeysManager::spend_spendable_outputs`] for documentation on this method.
18786 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);
18789 * See [`KeysManager::derive_channel_keys`] for documentation on this method.
18791 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]);
18794 * Frees any resources used by the ChannelManager, if is_owned is set and inner is non-NULL.
18796 void ChannelManager_free(struct LDKChannelManager this_obj);
18799 * Frees any resources used by the ChainParameters, if is_owned is set and inner is non-NULL.
18801 void ChainParameters_free(struct LDKChainParameters this_obj);
18804 * The network for determining the `chain_hash` in Lightning messages.
18806 enum LDKNetwork ChainParameters_get_network(const struct LDKChainParameters *NONNULL_PTR this_ptr);
18809 * The network for determining the `chain_hash` in Lightning messages.
18811 void ChainParameters_set_network(struct LDKChainParameters *NONNULL_PTR this_ptr, enum LDKNetwork val);
18814 * The hash and height of the latest block successfully connected.
18816 * Used to track on-chain channel funding outputs and send payments with reliable timelocks.
18818 struct LDKBestBlock ChainParameters_get_best_block(const struct LDKChainParameters *NONNULL_PTR this_ptr);
18821 * The hash and height of the latest block successfully connected.
18823 * Used to track on-chain channel funding outputs and send payments with reliable timelocks.
18825 void ChainParameters_set_best_block(struct LDKChainParameters *NONNULL_PTR this_ptr, struct LDKBestBlock val);
18828 * Constructs a new ChainParameters given each field
18830 MUST_USE_RES struct LDKChainParameters ChainParameters_new(enum LDKNetwork network_arg, struct LDKBestBlock best_block_arg);
18833 * Creates a copy of the ChainParameters
18835 struct LDKChainParameters ChainParameters_clone(const struct LDKChainParameters *NONNULL_PTR orig);
18838 * Frees any resources used by the CounterpartyForwardingInfo, if is_owned is set and inner is non-NULL.
18840 void CounterpartyForwardingInfo_free(struct LDKCounterpartyForwardingInfo this_obj);
18843 * Base routing fee in millisatoshis.
18845 uint32_t CounterpartyForwardingInfo_get_fee_base_msat(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr);
18848 * Base routing fee in millisatoshis.
18850 void CounterpartyForwardingInfo_set_fee_base_msat(struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr, uint32_t val);
18853 * Amount in millionths of a satoshi the channel will charge per transferred satoshi.
18855 uint32_t CounterpartyForwardingInfo_get_fee_proportional_millionths(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr);
18858 * Amount in millionths of a satoshi the channel will charge per transferred satoshi.
18860 void CounterpartyForwardingInfo_set_fee_proportional_millionths(struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr, uint32_t val);
18863 * The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
18864 * such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
18865 * `cltv_expiry_delta` for more details.
18867 uint16_t CounterpartyForwardingInfo_get_cltv_expiry_delta(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr);
18870 * The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
18871 * such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
18872 * `cltv_expiry_delta` for more details.
18874 void CounterpartyForwardingInfo_set_cltv_expiry_delta(struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr, uint16_t val);
18877 * Constructs a new CounterpartyForwardingInfo given each field
18879 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);
18882 * Creates a copy of the CounterpartyForwardingInfo
18884 struct LDKCounterpartyForwardingInfo CounterpartyForwardingInfo_clone(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR orig);
18887 * Frees any resources used by the ChannelCounterparty, if is_owned is set and inner is non-NULL.
18889 void ChannelCounterparty_free(struct LDKChannelCounterparty this_obj);
18892 * The node_id of our counterparty
18894 struct LDKPublicKey ChannelCounterparty_get_node_id(const struct LDKChannelCounterparty *NONNULL_PTR this_ptr);
18897 * The node_id of our counterparty
18899 void ChannelCounterparty_set_node_id(struct LDKChannelCounterparty *NONNULL_PTR this_ptr, struct LDKPublicKey val);
18902 * The Features the channel counterparty provided upon last connection.
18903 * Useful for routing as it is the most up-to-date copy of the counterparty's features and
18904 * many routing-relevant features are present in the init context.
18906 struct LDKInitFeatures ChannelCounterparty_get_features(const struct LDKChannelCounterparty *NONNULL_PTR this_ptr);
18909 * The Features the channel counterparty provided upon last connection.
18910 * Useful for routing as it is the most up-to-date copy of the counterparty's features and
18911 * many routing-relevant features are present in the init context.
18913 void ChannelCounterparty_set_features(struct LDKChannelCounterparty *NONNULL_PTR this_ptr, struct LDKInitFeatures val);
18916 * The value, in satoshis, that must always be held in the channel for our counterparty. This
18917 * value ensures that if our counterparty broadcasts a revoked state, we can punish them by
18918 * claiming at least this value on chain.
18920 * This value is not included in [`inbound_capacity_msat`] as it can never be spent.
18922 * [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
18924 uint64_t ChannelCounterparty_get_unspendable_punishment_reserve(const struct LDKChannelCounterparty *NONNULL_PTR this_ptr);
18927 * The value, in satoshis, that must always be held in the channel for our counterparty. This
18928 * value ensures that if our counterparty broadcasts a revoked state, we can punish them by
18929 * claiming at least this value on chain.
18931 * This value is not included in [`inbound_capacity_msat`] as it can never be spent.
18933 * [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
18935 void ChannelCounterparty_set_unspendable_punishment_reserve(struct LDKChannelCounterparty *NONNULL_PTR this_ptr, uint64_t val);
18938 * Information on the fees and requirements that the counterparty requires when forwarding
18939 * payments to us through this channel.
18941 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
18943 struct LDKCounterpartyForwardingInfo ChannelCounterparty_get_forwarding_info(const struct LDKChannelCounterparty *NONNULL_PTR this_ptr);
18946 * Information on the fees and requirements that the counterparty requires when forwarding
18947 * payments to us through this channel.
18949 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
18951 void ChannelCounterparty_set_forwarding_info(struct LDKChannelCounterparty *NONNULL_PTR this_ptr, struct LDKCounterpartyForwardingInfo val);
18954 * Constructs a new ChannelCounterparty given each field
18956 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);
18959 * Creates a copy of the ChannelCounterparty
18961 struct LDKChannelCounterparty ChannelCounterparty_clone(const struct LDKChannelCounterparty *NONNULL_PTR orig);
18964 * Frees any resources used by the ChannelDetails, if is_owned is set and inner is non-NULL.
18966 void ChannelDetails_free(struct LDKChannelDetails this_obj);
18969 * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
18970 * thereafter this is the txid of the funding transaction xor the funding transaction output).
18971 * Note that this means this value is *not* persistent - it can change once during the
18972 * lifetime of the channel.
18974 const uint8_t (*ChannelDetails_get_channel_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr))[32];
18977 * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
18978 * thereafter this is the txid of the funding transaction xor the funding transaction output).
18979 * Note that this means this value is *not* persistent - it can change once during the
18980 * lifetime of the channel.
18982 void ChannelDetails_set_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
18985 * Parameters which apply to our counterparty. See individual fields for more information.
18987 struct LDKChannelCounterparty ChannelDetails_get_counterparty(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
18990 * Parameters which apply to our counterparty. See individual fields for more information.
18992 void ChannelDetails_set_counterparty(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKChannelCounterparty val);
18995 * The Channel's funding transaction output, if we've negotiated the funding transaction with
18996 * our counterparty already.
18998 * Note that, if this has been set, `channel_id` will be equivalent to
18999 * `funding_txo.unwrap().to_channel_id()`.
19001 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
19003 struct LDKOutPoint ChannelDetails_get_funding_txo(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19006 * The Channel's funding transaction output, if we've negotiated the funding transaction with
19007 * our counterparty already.
19009 * Note that, if this has been set, `channel_id` will be equivalent to
19010 * `funding_txo.unwrap().to_channel_id()`.
19012 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
19014 void ChannelDetails_set_funding_txo(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKOutPoint val);
19017 * The features which this channel operates with. See individual features for more info.
19019 * `None` until negotiation completes and the channel type is finalized.
19021 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
19023 struct LDKChannelTypeFeatures ChannelDetails_get_channel_type(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19026 * The features which this channel operates with. See individual features for more info.
19028 * `None` until negotiation completes and the channel type is finalized.
19030 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
19032 void ChannelDetails_set_channel_type(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKChannelTypeFeatures val);
19035 * The position of the funding transaction in the chain. None if the funding transaction has
19036 * not yet been confirmed and the channel fully opened.
19038 * Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
19039 * payments instead of this. See [`get_inbound_payment_scid`].
19041 * [`inbound_scid_alias`]: Self::inbound_scid_alias
19042 * [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
19044 struct LDKCOption_u64Z ChannelDetails_get_short_channel_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19047 * The position of the funding transaction in the chain. None if the funding transaction has
19048 * not yet been confirmed and the channel fully opened.
19050 * Note that if [`inbound_scid_alias`] is set, it must be used for invoices and inbound
19051 * payments instead of this. See [`get_inbound_payment_scid`].
19053 * [`inbound_scid_alias`]: Self::inbound_scid_alias
19054 * [`get_inbound_payment_scid`]: Self::get_inbound_payment_scid
19056 void ChannelDetails_set_short_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
19059 * An optional [`short_channel_id`] alias for this channel, randomly generated by our
19060 * counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
19061 * counterparty will recognize the alias provided here in place of the [`short_channel_id`]
19062 * when they see a payment to be routed to us.
19064 * Our counterparty may choose to rotate this value at any time, though will always recognize
19065 * previous values for inbound payment forwarding.
19067 * [`short_channel_id`]: Self::short_channel_id
19069 struct LDKCOption_u64Z ChannelDetails_get_inbound_scid_alias(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19072 * An optional [`short_channel_id`] alias for this channel, randomly generated by our
19073 * counterparty and usable in place of [`short_channel_id`] in invoice route hints. Our
19074 * counterparty will recognize the alias provided here in place of the [`short_channel_id`]
19075 * when they see a payment to be routed to us.
19077 * Our counterparty may choose to rotate this value at any time, though will always recognize
19078 * previous values for inbound payment forwarding.
19080 * [`short_channel_id`]: Self::short_channel_id
19082 void ChannelDetails_set_inbound_scid_alias(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
19085 * The value, in satoshis, of this channel as appears in the funding output
19087 uint64_t ChannelDetails_get_channel_value_satoshis(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19090 * The value, in satoshis, of this channel as appears in the funding output
19092 void ChannelDetails_set_channel_value_satoshis(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
19095 * The value, in satoshis, that must always be held in the channel for us. This value ensures
19096 * that if we broadcast a revoked state, our counterparty can punish us by claiming at least
19097 * this value on chain.
19099 * This value is not included in [`outbound_capacity_msat`] as it can never be spent.
19101 * This value will be `None` for outbound channels until the counterparty accepts the channel.
19103 * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
19105 struct LDKCOption_u64Z ChannelDetails_get_unspendable_punishment_reserve(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19108 * The value, in satoshis, that must always be held in the channel for us. This value ensures
19109 * that if we broadcast a revoked state, our counterparty can punish us by claiming at least
19110 * this value on chain.
19112 * This value is not included in [`outbound_capacity_msat`] as it can never be spent.
19114 * This value will be `None` for outbound channels until the counterparty accepts the channel.
19116 * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
19118 void ChannelDetails_set_unspendable_punishment_reserve(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
19121 * The `user_channel_id` passed in to create_channel, or 0 if the channel was inbound.
19123 uint64_t ChannelDetails_get_user_channel_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19126 * The `user_channel_id` passed in to create_channel, or 0 if the channel was inbound.
19128 void ChannelDetails_set_user_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
19131 * Our total balance. This is the amount we would get if we close the channel.
19132 * This value is not exact. Due to various in-flight changes and feerate changes, exactly this
19133 * amount is not likely to be recoverable on close.
19135 * This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
19136 * balance is not available for inclusion in new outbound HTLCs). This further does not include
19137 * any pending outgoing HTLCs which are awaiting some other resolution to be sent.
19138 * This does not consider any on-chain fees.
19140 * See also [`ChannelDetails::outbound_capacity_msat`]
19142 uint64_t ChannelDetails_get_balance_msat(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19145 * Our total balance. This is the amount we would get if we close the channel.
19146 * This value is not exact. Due to various in-flight changes and feerate changes, exactly this
19147 * amount is not likely to be recoverable on close.
19149 * This does not include any pending HTLCs which are not yet fully resolved (and, thus, whose
19150 * balance is not available for inclusion in new outbound HTLCs). This further does not include
19151 * any pending outgoing HTLCs which are awaiting some other resolution to be sent.
19152 * This does not consider any on-chain fees.
19154 * See also [`ChannelDetails::outbound_capacity_msat`]
19156 void ChannelDetails_set_balance_msat(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
19159 * The available outbound capacity for sending HTLCs to the remote peer. This does not include
19160 * any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
19161 * available for inclusion in new outbound HTLCs). This further does not include any pending
19162 * outgoing HTLCs which are awaiting some other resolution to be sent.
19164 * See also [`ChannelDetails::balance_msat`]
19166 * This value is not exact. Due to various in-flight changes, feerate changes, and our
19167 * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
19168 * should be able to spend nearly this amount.
19170 uint64_t ChannelDetails_get_outbound_capacity_msat(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19173 * The available outbound capacity for sending HTLCs to the remote peer. This does not include
19174 * any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
19175 * available for inclusion in new outbound HTLCs). This further does not include any pending
19176 * outgoing HTLCs which are awaiting some other resolution to be sent.
19178 * See also [`ChannelDetails::balance_msat`]
19180 * This value is not exact. Due to various in-flight changes, feerate changes, and our
19181 * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
19182 * should be able to spend nearly this amount.
19184 void ChannelDetails_set_outbound_capacity_msat(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
19187 * The available inbound capacity for the remote peer to send HTLCs to us. This does not
19188 * include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
19189 * available for inclusion in new inbound HTLCs).
19190 * Note that there are some corner cases not fully handled here, so the actual available
19191 * inbound capacity may be slightly higher than this.
19193 * This value is not exact. Due to various in-flight changes, feerate changes, and our
19194 * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
19195 * However, our counterparty should be able to spend nearly this amount.
19197 uint64_t ChannelDetails_get_inbound_capacity_msat(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19200 * The available inbound capacity for the remote peer to send HTLCs to us. This does not
19201 * include any pending HTLCs which are not yet fully resolved (and, thus, whose balance is not
19202 * available for inclusion in new inbound HTLCs).
19203 * Note that there are some corner cases not fully handled here, so the actual available
19204 * inbound capacity may be slightly higher than this.
19206 * This value is not exact. Due to various in-flight changes, feerate changes, and our
19207 * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
19208 * However, our counterparty should be able to spend nearly this amount.
19210 void ChannelDetails_set_inbound_capacity_msat(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
19213 * The number of required confirmations on the funding transaction before the funding will be
19214 * considered \"locked\". This number is selected by the channel fundee (i.e. us if
19215 * [`is_outbound`] is *not* set), and can be selected for inbound channels with
19216 * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
19217 * [`ChannelHandshakeLimits::max_minimum_depth`].
19219 * This value will be `None` for outbound channels until the counterparty accepts the channel.
19221 * [`is_outbound`]: ChannelDetails::is_outbound
19222 * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
19223 * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
19225 struct LDKCOption_u32Z ChannelDetails_get_confirmations_required(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19228 * The number of required confirmations on the funding transaction before the funding will be
19229 * considered \"locked\". This number is selected by the channel fundee (i.e. us if
19230 * [`is_outbound`] is *not* set), and can be selected for inbound channels with
19231 * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
19232 * [`ChannelHandshakeLimits::max_minimum_depth`].
19234 * This value will be `None` for outbound channels until the counterparty accepts the channel.
19236 * [`is_outbound`]: ChannelDetails::is_outbound
19237 * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
19238 * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
19240 void ChannelDetails_set_confirmations_required(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u32Z val);
19243 * The number of blocks (after our commitment transaction confirms) that we will need to wait
19244 * until we can claim our funds after we force-close the channel. During this time our
19245 * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
19246 * force-closes the channel and broadcasts a commitment transaction we do not have to wait any
19247 * time to claim our non-HTLC-encumbered funds.
19249 * This value will be `None` for outbound channels until the counterparty accepts the channel.
19251 struct LDKCOption_u16Z ChannelDetails_get_force_close_spend_delay(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19254 * The number of blocks (after our commitment transaction confirms) that we will need to wait
19255 * until we can claim our funds after we force-close the channel. During this time our
19256 * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
19257 * force-closes the channel and broadcasts a commitment transaction we do not have to wait any
19258 * time to claim our non-HTLC-encumbered funds.
19260 * This value will be `None` for outbound channels until the counterparty accepts the channel.
19262 void ChannelDetails_set_force_close_spend_delay(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u16Z val);
19265 * True if the channel was initiated (and thus funded) by us.
19267 bool ChannelDetails_get_is_outbound(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19270 * True if the channel was initiated (and thus funded) by us.
19272 void ChannelDetails_set_is_outbound(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
19275 * True if the channel is confirmed, funding_locked messages have been exchanged, and the
19276 * channel is not currently being shut down. `funding_locked` message exchange implies the
19277 * required confirmation count has been reached (and we were connected to the peer at some
19278 * point after the funding transaction received enough confirmations). The required
19279 * confirmation count is provided in [`confirmations_required`].
19281 * [`confirmations_required`]: ChannelDetails::confirmations_required
19283 bool ChannelDetails_get_is_funding_locked(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19286 * True if the channel is confirmed, funding_locked messages have been exchanged, and the
19287 * channel is not currently being shut down. `funding_locked` message exchange implies the
19288 * required confirmation count has been reached (and we were connected to the peer at some
19289 * point after the funding transaction received enough confirmations). The required
19290 * confirmation count is provided in [`confirmations_required`].
19292 * [`confirmations_required`]: ChannelDetails::confirmations_required
19294 void ChannelDetails_set_is_funding_locked(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
19297 * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
19298 * the peer is connected, and (c) the channel is not currently negotiating a shutdown.
19300 * This is a strict superset of `is_funding_locked`.
19302 bool ChannelDetails_get_is_usable(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19305 * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
19306 * the peer is connected, and (c) the channel is not currently negotiating a shutdown.
19308 * This is a strict superset of `is_funding_locked`.
19310 void ChannelDetails_set_is_usable(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
19313 * True if this channel is (or will be) publicly-announced.
19315 bool ChannelDetails_get_is_public(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
19318 * True if this channel is (or will be) publicly-announced.
19320 void ChannelDetails_set_is_public(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
19323 * Constructs a new ChannelDetails given each field
19325 MUST_USE_RES struct LDKChannelDetails ChannelDetails_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKChannelCounterparty counterparty_arg, struct LDKOutPoint funding_txo_arg, struct LDKChannelTypeFeatures channel_type_arg, struct LDKCOption_u64Z short_channel_id_arg, struct LDKCOption_u64Z inbound_scid_alias_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);
19328 * Creates a copy of the ChannelDetails
19330 struct LDKChannelDetails ChannelDetails_clone(const struct LDKChannelDetails *NONNULL_PTR orig);
19333 * Gets the current SCID which should be used to identify this channel for inbound payments.
19334 * This should be used for providing invoice hints or in any other context where our
19335 * counterparty will forward a payment to us.
19337 * This is either the [`ChannelDetails::inbound_scid_alias`], if set, or the
19338 * [`ChannelDetails::short_channel_id`]. See those for more information.
19340 MUST_USE_RES struct LDKCOption_u64Z ChannelDetails_get_inbound_payment_scid(const struct LDKChannelDetails *NONNULL_PTR this_arg);
19343 * Frees any resources used by the PaymentSendFailure
19345 void PaymentSendFailure_free(struct LDKPaymentSendFailure this_ptr);
19348 * Creates a copy of the PaymentSendFailure
19350 struct LDKPaymentSendFailure PaymentSendFailure_clone(const struct LDKPaymentSendFailure *NONNULL_PTR orig);
19353 * Utility method to constructs a new ParameterError-variant PaymentSendFailure
19355 struct LDKPaymentSendFailure PaymentSendFailure_parameter_error(struct LDKAPIError a);
19358 * Utility method to constructs a new PathParameterError-variant PaymentSendFailure
19360 struct LDKPaymentSendFailure PaymentSendFailure_path_parameter_error(struct LDKCVec_CResult_NoneAPIErrorZZ a);
19363 * Utility method to constructs a new AllFailedRetrySafe-variant PaymentSendFailure
19365 struct LDKPaymentSendFailure PaymentSendFailure_all_failed_retry_safe(struct LDKCVec_APIErrorZ a);
19368 * Utility method to constructs a new PartialFailure-variant PaymentSendFailure
19370 struct LDKPaymentSendFailure PaymentSendFailure_partial_failure(struct LDKCVec_CResult_NoneAPIErrorZZ results, struct LDKRouteParameters failed_paths_retry, struct LDKThirtyTwoBytes payment_id);
19373 * Frees any resources used by the PhantomRouteHints, if is_owned is set and inner is non-NULL.
19375 void PhantomRouteHints_free(struct LDKPhantomRouteHints this_obj);
19378 * The list of channels to be included in the invoice route hints.
19380 struct LDKCVec_ChannelDetailsZ PhantomRouteHints_get_channels(const struct LDKPhantomRouteHints *NONNULL_PTR this_ptr);
19383 * The list of channels to be included in the invoice route hints.
19385 void PhantomRouteHints_set_channels(struct LDKPhantomRouteHints *NONNULL_PTR this_ptr, struct LDKCVec_ChannelDetailsZ val);
19388 * A fake scid used for representing the phantom node's fake channel in generating the invoice
19391 uint64_t PhantomRouteHints_get_phantom_scid(const struct LDKPhantomRouteHints *NONNULL_PTR this_ptr);
19394 * A fake scid used for representing the phantom node's fake channel in generating the invoice
19397 void PhantomRouteHints_set_phantom_scid(struct LDKPhantomRouteHints *NONNULL_PTR this_ptr, uint64_t val);
19400 * The pubkey of the real backing node that would ultimately receive the payment.
19402 struct LDKPublicKey PhantomRouteHints_get_real_node_pubkey(const struct LDKPhantomRouteHints *NONNULL_PTR this_ptr);
19405 * The pubkey of the real backing node that would ultimately receive the payment.
19407 void PhantomRouteHints_set_real_node_pubkey(struct LDKPhantomRouteHints *NONNULL_PTR this_ptr, struct LDKPublicKey val);
19410 * Constructs a new PhantomRouteHints given each field
19412 MUST_USE_RES struct LDKPhantomRouteHints PhantomRouteHints_new(struct LDKCVec_ChannelDetailsZ channels_arg, uint64_t phantom_scid_arg, struct LDKPublicKey real_node_pubkey_arg);
19415 * Creates a copy of the PhantomRouteHints
19417 struct LDKPhantomRouteHints PhantomRouteHints_clone(const struct LDKPhantomRouteHints *NONNULL_PTR orig);
19420 * Constructs a new ChannelManager to hold several channels and route between them.
19422 * This is the main \"logic hub\" for all channel-related actions, and implements
19423 * ChannelMessageHandler.
19425 * Non-proportional fees are fixed according to our risk using the provided fee estimator.
19427 * panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
19429 * Users need to notify the new ChannelManager when a new block is connected or
19430 * disconnected using its `block_connected` and `block_disconnected` methods, starting
19431 * from after `params.latest_hash`.
19433 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);
19436 * Gets the current configuration applied to all new channels, as
19438 MUST_USE_RES struct LDKUserConfig ChannelManager_get_current_default_configuration(const struct LDKChannelManager *NONNULL_PTR this_arg);
19441 * Creates a new outbound channel to the given remote node and with the given value.
19443 * `user_channel_id` will be provided back as in
19444 * [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
19445 * correspond with which `create_channel` call. Note that the `user_channel_id` defaults to 0
19446 * for inbound channels, so you may wish to avoid using 0 for `user_channel_id` here.
19447 * `user_channel_id` has no meaning inside of LDK, it is simply copied to events and otherwise
19450 * Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
19451 * greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
19453 * Note that we do not check if you are currently connected to the given peer. If no
19454 * connection is available, the outbound `open_channel` message may fail to send, resulting in
19455 * the channel eventually being silently forgotten (dropped on reload).
19457 * Returns the new Channel's temporary `channel_id`. This ID will appear as
19458 * [`Event::FundingGenerationReady::temporary_channel_id`] and in
19459 * [`ChannelDetails::channel_id`] until after
19460 * [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
19461 * one derived from the funding transaction's TXID. If the counterparty rejects the channel
19462 * immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
19464 * [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
19465 * [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
19466 * [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
19468 * Note that override_config (or a relevant inner pointer) may be NULL or all-0s to represent None
19470 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);
19473 * Gets the list of open channels, in random order. See ChannelDetail field documentation for
19474 * more information.
19476 MUST_USE_RES struct LDKCVec_ChannelDetailsZ ChannelManager_list_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
19479 * Gets the list of usable channels, in random order. Useful as an argument to
19480 * get_route to ensure non-announced channels are used.
19482 * These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
19483 * documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
19486 MUST_USE_RES struct LDKCVec_ChannelDetailsZ ChannelManager_list_usable_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
19489 * Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
19490 * will be accepted on the given channel, and after additional timeout/the closing of all
19491 * pending HTLCs, the channel will be closed on chain.
19493 * * If we are the channel initiator, we will pay between our [`Background`] and
19494 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
19496 * * If our counterparty is the channel initiator, we will require a channel closing
19497 * transaction feerate of at least our [`Background`] feerate or the feerate which
19498 * would appear on a force-closure transaction, whichever is lower. We will allow our
19499 * counterparty to pay as much fee as they'd like, however.
19501 * May generate a SendShutdown message event on success, which should be relayed.
19503 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
19504 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
19505 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
19507 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_close_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*channel_id)[32]);
19510 * Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
19511 * will be accepted on the given channel, and after additional timeout/the closing of all
19512 * pending HTLCs, the channel will be closed on chain.
19514 * `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
19515 * the channel being closed or not:
19516 * * If we are the channel initiator, we will pay at least this feerate on the closing
19517 * transaction. The upper-bound is set by
19518 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
19519 * estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
19520 * * If our counterparty is the channel initiator, we will refuse to accept a channel closure
19521 * transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
19522 * will appear on a force-closure transaction, whichever is lower).
19524 * May generate a SendShutdown message event on success, which should be relayed.
19526 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
19527 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
19528 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
19530 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);
19533 * Force closes a channel, immediately broadcasting the latest local commitment transaction to
19534 * the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
19536 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_force_close_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*channel_id)[32]);
19539 * Force close all channels, immediately broadcasting the latest local commitment transaction
19540 * for each to the chain and rejecting new HTLCs on each.
19542 void ChannelManager_force_close_all_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
19545 * Sends a payment along a given route.
19547 * Value parameters are provided via the last hop in route, see documentation for RouteHop
19548 * fields for more info.
19550 * Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
19551 * payment), we don't do anything to stop you! We always try to ensure that if the provided
19552 * next hop knows the preimage to payment_hash they can claim an additional amount as
19553 * specified in the last hop in the route! Thus, you should probably do your own
19554 * payment_preimage tracking (which you should already be doing as they represent \"proof of
19555 * payment\") and prevent double-sends yourself.
19557 * May generate SendHTLCs message(s) event on success, which should be relayed.
19559 * Each path may have a different return value, and PaymentSendValue may return a Vec with
19560 * each entry matching the corresponding-index entry in the route paths, see
19561 * PaymentSendFailure for more info.
19563 * In general, a path may raise:
19564 * * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
19565 * node public key) is specified.
19566 * * APIError::ChannelUnavailable if the next-hop channel is not available for updates
19567 * (including due to previous monitor update failure or new permanent monitor update
19569 * * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
19570 * relevant updates.
19572 * Note that depending on the type of the PaymentSendFailure the HTLC may have been
19573 * irrevocably committed to on our end. In such a case, do NOT retry the payment with a
19574 * different route unless you intend to pay twice!
19576 * payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
19577 * the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
19578 * newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
19579 * must not contain multiple paths as multi-path payments require a recipient-provided
19581 * If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
19582 * bit set (either as required or as available). If multiple paths are present in the Route,
19583 * we assume the invoice had the basic_mpp feature set.
19585 * Note that payment_secret (or a relevant inner pointer) may be NULL or all-0s to represent None
19587 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);
19590 * Retries a payment along the given [`Route`].
19592 * Errors returned are a superset of those returned from [`send_payment`], so see
19593 * [`send_payment`] documentation for more details on errors. This method will also error if the
19594 * retry amount puts the payment more than 10% over the payment's total amount, if the payment
19595 * for the given `payment_id` cannot be found (likely due to timeout or success), or if
19596 * further retries have been disabled with [`abandon_payment`].
19598 * [`send_payment`]: [`ChannelManager::send_payment`]
19599 * [`abandon_payment`]: [`ChannelManager::abandon_payment`]
19601 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);
19604 * Signals that no further retries for the given payment will occur.
19606 * After this method returns, any future calls to [`retry_payment`] for the given `payment_id`
19607 * will fail with [`PaymentSendFailure::ParameterError`]. If no such event has been generated,
19608 * an [`Event::PaymentFailed`] event will be generated as soon as there are no remaining
19609 * pending HTLCs for this payment.
19611 * Note that calling this method does *not* prevent a payment from succeeding. You must still
19612 * wait until you receive either a [`Event::PaymentFailed`] or [`Event::PaymentSent`] event to
19613 * determine the ultimate status of a payment.
19615 * [`retry_payment`]: Self::retry_payment
19616 * [`Event::PaymentFailed`]: events::Event::PaymentFailed
19617 * [`Event::PaymentSent`]: events::Event::PaymentSent
19619 void ChannelManager_abandon_payment(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThirtyTwoBytes payment_id);
19622 * Send a spontaneous payment, which is a payment that does not require the recipient to have
19623 * generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
19624 * the preimage, it must be a cryptographically secure random value that no intermediate node
19625 * would be able to guess -- otherwise, an intermediate node may claim the payment and it will
19626 * never reach the recipient.
19628 * See [`send_payment`] documentation for more details on the return value of this function.
19630 * Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
19631 * [`send_payment`] for more information about the risks of duplicate preimage usage.
19633 * Note that `route` must have exactly one path.
19635 * [`send_payment`]: Self::send_payment
19637 * Note that payment_preimage (or a relevant inner pointer) may be NULL or all-0s to represent None
19639 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);
19642 * Call this upon creation of a funding transaction for the given channel.
19644 * Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
19645 * or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
19647 * Returns [`APIError::ChannelUnavailable`] if a funding transaction has already been provided
19648 * for the channel or if the channel has been closed as indicated by [`Event::ChannelClosed`].
19650 * May panic if the output found in the funding transaction is duplicative with some other
19651 * channel (note that this should be trivially prevented by using unique funding transaction
19652 * keys per-channel).
19654 * Do NOT broadcast the funding transaction yourself. When we have safely received our
19655 * counterparty's signature the funding transaction will automatically be broadcast via the
19656 * [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
19658 * Note that this includes RBF or similar transaction replacement strategies - lightning does
19659 * not currently support replacing a funding transaction on an existing channel. Instead,
19660 * create a new channel with a conflicting funding transaction.
19662 * [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
19663 * [`Event::ChannelClosed`]: crate::util::events::Event::ChannelClosed
19665 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);
19668 * Regenerates channel_announcements and generates a signed node_announcement from the given
19669 * arguments, providing them in corresponding events via
19670 * [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
19671 * on-chain. This effectively re-broadcasts all channel announcements and sends our node
19672 * announcement to ensure that the lightning P2P network is aware of the channels we have and
19673 * our network addresses.
19675 * `rgb` is a node \"color\" and `alias` is a printable human-readable string to describe this
19676 * node to humans. They carry no in-protocol meaning.
19678 * `addresses` represent the set (possibly empty) of socket addresses on which this node
19679 * accepts incoming connections. These will be included in the node_announcement, publicly
19680 * tying these addresses together and to this node. If you wish to preserve user privacy,
19681 * addresses should likely contain only Tor Onion addresses.
19683 * Panics if `addresses` is absurdly large (more than 500).
19685 * [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
19687 void ChannelManager_broadcast_node_announcement(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThreeBytes rgb, struct LDKThirtyTwoBytes alias, struct LDKCVec_NetAddressZ addresses);
19690 * Processes HTLCs which are pending waiting on random forward delay.
19692 * Should only really ever be called in response to a PendingHTLCsForwardable event.
19693 * Will likely generate further events.
19695 void ChannelManager_process_pending_htlc_forwards(const struct LDKChannelManager *NONNULL_PTR this_arg);
19698 * Performs actions which should happen on startup and roughly once per minute thereafter.
19700 * This currently includes:
19701 * * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
19702 * * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
19703 * than a minute, informing the network that they should no longer attempt to route over
19706 * Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
19707 * estimate fetches.
19709 void ChannelManager_timer_tick_occurred(const struct LDKChannelManager *NONNULL_PTR this_arg);
19712 * Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
19713 * after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
19714 * along the path (including in our own channel on which we received it).
19715 * Returns false if no payment was found to fail backwards, true if the process of failing the
19716 * HTLC backwards has been started.
19718 MUST_USE_RES bool ChannelManager_fail_htlc_backwards(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*payment_hash)[32]);
19721 * Provides a payment preimage in response to [`Event::PaymentReceived`], generating any
19722 * [`MessageSendEvent`]s needed to claim the payment.
19724 * Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
19725 * [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
19726 * event matches your expectation. If you fail to do so and call this method, you may provide
19727 * the sender \"proof-of-payment\" when they did not fulfill the full expected payment.
19729 * Returns whether any HTLCs were claimed, and thus if any new [`MessageSendEvent`]s are now
19730 * pending for processing via [`get_and_clear_pending_msg_events`].
19732 * [`Event::PaymentReceived`]: crate::util::events::Event::PaymentReceived
19733 * [`create_inbound_payment`]: Self::create_inbound_payment
19734 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
19735 * [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
19737 MUST_USE_RES bool ChannelManager_claim_funds(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThirtyTwoBytes payment_preimage);
19740 * Gets the node_id held by this ChannelManager
19742 MUST_USE_RES struct LDKPublicKey ChannelManager_get_our_node_id(const struct LDKChannelManager *NONNULL_PTR this_arg);
19745 * Called to accept a request to open a channel after [`Event::OpenChannelRequest`] has been
19748 * The `temporary_channel_id` parameter indicates which inbound channel should be accepted.
19750 * For inbound channels, the `user_channel_id` parameter will be provided back in
19751 * [`Event::ChannelClosed::user_channel_id`] to allow tracking of which events correspond
19752 * with which `accept_inbound_channel` call.
19754 * [`Event::OpenChannelRequest`]: events::Event::OpenChannelRequest
19755 * [`Event::ChannelClosed::user_channel_id`]: events::Event::ChannelClosed::user_channel_id
19757 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_accept_inbound_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*temporary_channel_id)[32], uint64_t user_channel_id);
19760 * Gets a payment secret and payment hash for use in an invoice given to a third party wishing
19763 * This differs from [`create_inbound_payment_for_hash`] only in that it generates the
19764 * [`PaymentHash`] and [`PaymentPreimage`] for you.
19766 * The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
19767 * will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
19768 * passed directly to [`claim_funds`].
19770 * See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
19772 * Note that a malicious eavesdropper can intuit whether an inbound payment was created by
19773 * `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
19777 * If you register an inbound payment with this method, then serialize the `ChannelManager`, then
19778 * deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
19780 * Errors if `min_value_msat` is greater than total bitcoin supply.
19782 * [`claim_funds`]: Self::claim_funds
19783 * [`PaymentReceived`]: events::Event::PaymentReceived
19784 * [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
19785 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
19787 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);
19790 * Legacy version of [`create_inbound_payment`]. Use this method if you wish to share
19791 * serialized state with LDK node(s) running 0.0.103 and earlier.
19793 * May panic if `invoice_expiry_delta_secs` is greater than one year.
19796 * This method is deprecated and will be removed soon.
19798 * [`create_inbound_payment`]: Self::create_inbound_payment
19800 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);
19803 * Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
19804 * stored external to LDK.
19806 * A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
19807 * payment secret fetched via this method or [`create_inbound_payment`], and which is at least
19808 * the `min_value_msat` provided here, if one is provided.
19810 * The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) should be globally unique, though
19811 * note that LDK will not stop you from registering duplicate payment hashes for inbound
19814 * `min_value_msat` should be set if the invoice being generated contains a value. Any payment
19815 * received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
19816 * before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
19817 * sender \"proof-of-payment\" unless they have paid the required amount.
19819 * `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
19820 * in excess of the current time. This should roughly match the expiry time set in the invoice.
19821 * After this many seconds, we will remove the inbound payment, resulting in any attempts to
19822 * pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
19823 * invoices when no timeout is set.
19825 * Note that we use block header time to time-out pending inbound payments (with some margin
19826 * to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
19827 * accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
19828 * If you need exact expiry semantics, you should enforce them upon receipt of
19829 * [`PaymentReceived`].
19831 * Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
19832 * set to at least [`MIN_FINAL_CLTV_EXPIRY`].
19834 * Note that a malicious eavesdropper can intuit whether an inbound payment was created by
19835 * `create_inbound_payment` or `create_inbound_payment_for_hash` based on runtime.
19839 * If you register an inbound payment with this method, then serialize the `ChannelManager`, then
19840 * deserialize it with a node running 0.0.103 and earlier, the payment will fail to be received.
19842 * Errors if `min_value_msat` is greater than total bitcoin supply.
19844 * [`create_inbound_payment`]: Self::create_inbound_payment
19845 * [`PaymentReceived`]: events::Event::PaymentReceived
19847 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);
19850 * Legacy version of [`create_inbound_payment_for_hash`]. Use this method if you wish to share
19851 * serialized state with LDK node(s) running 0.0.103 and earlier.
19853 * May panic if `invoice_expiry_delta_secs` is greater than one year.
19856 * This method is deprecated and will be removed soon.
19858 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
19860 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);
19863 * Gets an LDK-generated payment preimage from a payment hash and payment secret that were
19864 * previously returned from [`create_inbound_payment`].
19866 * [`create_inbound_payment`]: Self::create_inbound_payment
19868 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);
19871 * Gets a fake short channel id for use in receiving [phantom node payments]. These fake scids
19872 * are used when constructing the phantom invoice's route hints.
19874 * [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
19876 MUST_USE_RES uint64_t ChannelManager_get_phantom_scid(const struct LDKChannelManager *NONNULL_PTR this_arg);
19879 * Gets route hints for use in receiving [phantom node payments].
19881 * [phantom node payments]: crate::chain::keysinterface::PhantomKeysManager
19883 MUST_USE_RES struct LDKPhantomRouteHints ChannelManager_get_phantom_route_hints(const struct LDKChannelManager *NONNULL_PTR this_arg);
19886 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
19887 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
19889 struct LDKMessageSendEventsProvider ChannelManager_as_MessageSendEventsProvider(const struct LDKChannelManager *NONNULL_PTR this_arg);
19892 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
19893 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
19895 struct LDKEventsProvider ChannelManager_as_EventsProvider(const struct LDKChannelManager *NONNULL_PTR this_arg);
19898 * Constructs a new Listen which calls the relevant methods on this_arg.
19899 * This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
19901 struct LDKListen ChannelManager_as_Listen(const struct LDKChannelManager *NONNULL_PTR this_arg);
19904 * Constructs a new Confirm which calls the relevant methods on this_arg.
19905 * This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
19907 struct LDKConfirm ChannelManager_as_Confirm(const struct LDKChannelManager *NONNULL_PTR this_arg);
19910 * Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
19911 * indicating whether persistence is necessary. Only one listener on
19912 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
19915 * Note that this method is not available with the `no-std` feature.
19917 MUST_USE_RES bool ChannelManager_await_persistable_update_timeout(const struct LDKChannelManager *NONNULL_PTR this_arg, uint64_t max_wait);
19920 * Blocks until ChannelManager needs to be persisted. Only one listener on
19921 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
19924 void ChannelManager_await_persistable_update(const struct LDKChannelManager *NONNULL_PTR this_arg);
19927 * Gets the latest best block which was connected either via the [`chain::Listen`] or
19928 * [`chain::Confirm`] interfaces.
19930 MUST_USE_RES struct LDKBestBlock ChannelManager_current_best_block(const struct LDKChannelManager *NONNULL_PTR this_arg);
19933 * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
19934 * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
19936 struct LDKChannelMessageHandler ChannelManager_as_ChannelMessageHandler(const struct LDKChannelManager *NONNULL_PTR this_arg);
19939 * Serialize the CounterpartyForwardingInfo object into a byte array which can be read by CounterpartyForwardingInfo_read
19941 struct LDKCVec_u8Z CounterpartyForwardingInfo_write(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR obj);
19944 * Read a CounterpartyForwardingInfo from a byte array, created by CounterpartyForwardingInfo_write
19946 struct LDKCResult_CounterpartyForwardingInfoDecodeErrorZ CounterpartyForwardingInfo_read(struct LDKu8slice ser);
19949 * Serialize the ChannelCounterparty object into a byte array which can be read by ChannelCounterparty_read
19951 struct LDKCVec_u8Z ChannelCounterparty_write(const struct LDKChannelCounterparty *NONNULL_PTR obj);
19954 * Read a ChannelCounterparty from a byte array, created by ChannelCounterparty_write
19956 struct LDKCResult_ChannelCounterpartyDecodeErrorZ ChannelCounterparty_read(struct LDKu8slice ser);
19959 * Serialize the ChannelDetails object into a byte array which can be read by ChannelDetails_read
19961 struct LDKCVec_u8Z ChannelDetails_write(const struct LDKChannelDetails *NONNULL_PTR obj);
19964 * Read a ChannelDetails from a byte array, created by ChannelDetails_write
19966 struct LDKCResult_ChannelDetailsDecodeErrorZ ChannelDetails_read(struct LDKu8slice ser);
19969 * Serialize the PhantomRouteHints object into a byte array which can be read by PhantomRouteHints_read
19971 struct LDKCVec_u8Z PhantomRouteHints_write(const struct LDKPhantomRouteHints *NONNULL_PTR obj);
19974 * Read a PhantomRouteHints from a byte array, created by PhantomRouteHints_write
19976 struct LDKCResult_PhantomRouteHintsDecodeErrorZ PhantomRouteHints_read(struct LDKu8slice ser);
19979 * Serialize the ChannelManager object into a byte array which can be read by ChannelManager_read
19981 struct LDKCVec_u8Z ChannelManager_write(const struct LDKChannelManager *NONNULL_PTR obj);
19984 * Frees any resources used by the ChannelManagerReadArgs, if is_owned is set and inner is non-NULL.
19986 void ChannelManagerReadArgs_free(struct LDKChannelManagerReadArgs this_obj);
19989 * The keys provider which will give us relevant keys. Some keys will be loaded during
19990 * deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
19993 const struct LDKKeysInterface *ChannelManagerReadArgs_get_keys_manager(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
19996 * The keys provider which will give us relevant keys. Some keys will be loaded during
19997 * deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
20000 void ChannelManagerReadArgs_set_keys_manager(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKKeysInterface val);
20003 * The fee_estimator for use in the ChannelManager in the future.
20005 * No calls to the FeeEstimator will be made during deserialization.
20007 const struct LDKFeeEstimator *ChannelManagerReadArgs_get_fee_estimator(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
20010 * The fee_estimator for use in the ChannelManager in the future.
20012 * No calls to the FeeEstimator will be made during deserialization.
20014 void ChannelManagerReadArgs_set_fee_estimator(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKFeeEstimator val);
20017 * The chain::Watch for use in the ChannelManager in the future.
20019 * No calls to the chain::Watch will be made during deserialization. It is assumed that
20020 * you have deserialized ChannelMonitors separately and will add them to your
20021 * chain::Watch after deserializing this ChannelManager.
20023 const struct LDKWatch *ChannelManagerReadArgs_get_chain_monitor(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
20026 * The chain::Watch for use in the ChannelManager in the future.
20028 * No calls to the chain::Watch will be made during deserialization. It is assumed that
20029 * you have deserialized ChannelMonitors separately and will add them to your
20030 * chain::Watch after deserializing this ChannelManager.
20032 void ChannelManagerReadArgs_set_chain_monitor(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKWatch val);
20035 * The BroadcasterInterface which will be used in the ChannelManager in the future and may be
20036 * used to broadcast the latest local commitment transactions of channels which must be
20037 * force-closed during deserialization.
20039 const struct LDKBroadcasterInterface *ChannelManagerReadArgs_get_tx_broadcaster(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
20042 * The BroadcasterInterface which will be used in the ChannelManager in the future and may be
20043 * used to broadcast the latest local commitment transactions of channels which must be
20044 * force-closed during deserialization.
20046 void ChannelManagerReadArgs_set_tx_broadcaster(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKBroadcasterInterface val);
20049 * The Logger for use in the ChannelManager and which may be used to log information during
20052 const struct LDKLogger *ChannelManagerReadArgs_get_logger(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
20055 * The Logger for use in the ChannelManager and which may be used to log information during
20058 void ChannelManagerReadArgs_set_logger(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKLogger val);
20061 * Default settings used for new channels. Any existing channels will continue to use the
20062 * runtime settings which were stored when the ChannelManager was serialized.
20064 struct LDKUserConfig ChannelManagerReadArgs_get_default_config(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
20067 * Default settings used for new channels. Any existing channels will continue to use the
20068 * runtime settings which were stored when the ChannelManager was serialized.
20070 void ChannelManagerReadArgs_set_default_config(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKUserConfig val);
20073 * Simple utility function to create a ChannelManagerReadArgs which creates the monitor
20074 * HashMap for you. This is primarily useful for C bindings where it is not practical to
20075 * populate a HashMap directly from C.
20077 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);
20080 * Read a C2Tuple_BlockHashChannelManagerZ from a byte array, created by C2Tuple_BlockHashChannelManagerZ_write
20082 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ C2Tuple_BlockHashChannelManagerZ_read(struct LDKu8slice ser, struct LDKChannelManagerReadArgs arg);
20085 * Frees any resources used by the DecodeError, if is_owned is set and inner is non-NULL.
20087 void DecodeError_free(struct LDKDecodeError this_obj);
20090 * Creates a copy of the DecodeError
20092 struct LDKDecodeError DecodeError_clone(const struct LDKDecodeError *NONNULL_PTR orig);
20095 * Frees any resources used by the Init, if is_owned is set and inner is non-NULL.
20097 void Init_free(struct LDKInit this_obj);
20100 * The relevant features which the sender supports
20102 struct LDKInitFeatures Init_get_features(const struct LDKInit *NONNULL_PTR this_ptr);
20105 * The relevant features which the sender supports
20107 void Init_set_features(struct LDKInit *NONNULL_PTR this_ptr, struct LDKInitFeatures val);
20110 * The receipient's network address. This adds the option to report a remote IP address
20111 * back to a connecting peer using the init message. A node can decide to use that information
20112 * to discover a potential update to its public IPv4 address (NAT) and use
20113 * that for a node_announcement update message containing the new address.
20115 struct LDKCOption_NetAddressZ Init_get_remote_network_address(const struct LDKInit *NONNULL_PTR this_ptr);
20118 * The receipient's network address. This adds the option to report a remote IP address
20119 * back to a connecting peer using the init message. A node can decide to use that information
20120 * to discover a potential update to its public IPv4 address (NAT) and use
20121 * that for a node_announcement update message containing the new address.
20123 void Init_set_remote_network_address(struct LDKInit *NONNULL_PTR this_ptr, struct LDKCOption_NetAddressZ val);
20126 * Constructs a new Init given each field
20128 MUST_USE_RES struct LDKInit Init_new(struct LDKInitFeatures features_arg, struct LDKCOption_NetAddressZ remote_network_address_arg);
20131 * Creates a copy of the Init
20133 struct LDKInit Init_clone(const struct LDKInit *NONNULL_PTR orig);
20136 * Frees any resources used by the ErrorMessage, if is_owned is set and inner is non-NULL.
20138 void ErrorMessage_free(struct LDKErrorMessage this_obj);
20141 * The channel ID involved in the error.
20143 * All-0s indicates a general error unrelated to a specific channel, after which all channels
20144 * with the sending peer should be closed.
20146 const uint8_t (*ErrorMessage_get_channel_id(const struct LDKErrorMessage *NONNULL_PTR this_ptr))[32];
20149 * The channel ID involved in the error.
20151 * All-0s indicates a general error unrelated to a specific channel, after which all channels
20152 * with the sending peer should be closed.
20154 void ErrorMessage_set_channel_id(struct LDKErrorMessage *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20157 * A possibly human-readable error description.
20158 * The string should be sanitized before it is used (e.g. emitted to logs or printed to
20159 * stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
20160 * the terminal emulator or the logging subsystem.
20162 struct LDKStr ErrorMessage_get_data(const struct LDKErrorMessage *NONNULL_PTR this_ptr);
20165 * A possibly human-readable error description.
20166 * The string should be sanitized before it is used (e.g. emitted to logs or printed to
20167 * stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
20168 * the terminal emulator or the logging subsystem.
20170 void ErrorMessage_set_data(struct LDKErrorMessage *NONNULL_PTR this_ptr, struct LDKStr val);
20173 * Constructs a new ErrorMessage given each field
20175 MUST_USE_RES struct LDKErrorMessage ErrorMessage_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKStr data_arg);
20178 * Creates a copy of the ErrorMessage
20180 struct LDKErrorMessage ErrorMessage_clone(const struct LDKErrorMessage *NONNULL_PTR orig);
20183 * Frees any resources used by the WarningMessage, if is_owned is set and inner is non-NULL.
20185 void WarningMessage_free(struct LDKWarningMessage this_obj);
20188 * The channel ID involved in the warning.
20190 * All-0s indicates a warning unrelated to a specific channel.
20192 const uint8_t (*WarningMessage_get_channel_id(const struct LDKWarningMessage *NONNULL_PTR this_ptr))[32];
20195 * The channel ID involved in the warning.
20197 * All-0s indicates a warning unrelated to a specific channel.
20199 void WarningMessage_set_channel_id(struct LDKWarningMessage *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20202 * A possibly human-readable warning description.
20203 * The string should be sanitized before it is used (e.g. emitted to logs or printed to
20204 * stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
20205 * the terminal emulator or the logging subsystem.
20207 struct LDKStr WarningMessage_get_data(const struct LDKWarningMessage *NONNULL_PTR this_ptr);
20210 * A possibly human-readable warning description.
20211 * The string should be sanitized before it is used (e.g. emitted to logs or printed to
20212 * stdout). Otherwise, a well crafted error message may trigger a security vulnerability in
20213 * the terminal emulator or the logging subsystem.
20215 void WarningMessage_set_data(struct LDKWarningMessage *NONNULL_PTR this_ptr, struct LDKStr val);
20218 * Constructs a new WarningMessage given each field
20220 MUST_USE_RES struct LDKWarningMessage WarningMessage_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKStr data_arg);
20223 * Creates a copy of the WarningMessage
20225 struct LDKWarningMessage WarningMessage_clone(const struct LDKWarningMessage *NONNULL_PTR orig);
20228 * Frees any resources used by the Ping, if is_owned is set and inner is non-NULL.
20230 void Ping_free(struct LDKPing this_obj);
20233 * The desired response length
20235 uint16_t Ping_get_ponglen(const struct LDKPing *NONNULL_PTR this_ptr);
20238 * The desired response length
20240 void Ping_set_ponglen(struct LDKPing *NONNULL_PTR this_ptr, uint16_t val);
20243 * The ping packet size.
20244 * This field is not sent on the wire. byteslen zeros are sent.
20246 uint16_t Ping_get_byteslen(const struct LDKPing *NONNULL_PTR this_ptr);
20249 * The ping packet size.
20250 * This field is not sent on the wire. byteslen zeros are sent.
20252 void Ping_set_byteslen(struct LDKPing *NONNULL_PTR this_ptr, uint16_t val);
20255 * Constructs a new Ping given each field
20257 MUST_USE_RES struct LDKPing Ping_new(uint16_t ponglen_arg, uint16_t byteslen_arg);
20260 * Creates a copy of the Ping
20262 struct LDKPing Ping_clone(const struct LDKPing *NONNULL_PTR orig);
20265 * Frees any resources used by the Pong, if is_owned is set and inner is non-NULL.
20267 void Pong_free(struct LDKPong this_obj);
20270 * The pong packet size.
20271 * This field is not sent on the wire. byteslen zeros are sent.
20273 uint16_t Pong_get_byteslen(const struct LDKPong *NONNULL_PTR this_ptr);
20276 * The pong packet size.
20277 * This field is not sent on the wire. byteslen zeros are sent.
20279 void Pong_set_byteslen(struct LDKPong *NONNULL_PTR this_ptr, uint16_t val);
20282 * Constructs a new Pong given each field
20284 MUST_USE_RES struct LDKPong Pong_new(uint16_t byteslen_arg);
20287 * Creates a copy of the Pong
20289 struct LDKPong Pong_clone(const struct LDKPong *NONNULL_PTR orig);
20292 * Frees any resources used by the OpenChannel, if is_owned is set and inner is non-NULL.
20294 void OpenChannel_free(struct LDKOpenChannel this_obj);
20297 * The genesis hash of the blockchain where the channel is to be opened
20299 const uint8_t (*OpenChannel_get_chain_hash(const struct LDKOpenChannel *NONNULL_PTR this_ptr))[32];
20302 * The genesis hash of the blockchain where the channel is to be opened
20304 void OpenChannel_set_chain_hash(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20307 * A temporary channel ID, until the funding outpoint is announced
20309 const uint8_t (*OpenChannel_get_temporary_channel_id(const struct LDKOpenChannel *NONNULL_PTR this_ptr))[32];
20312 * A temporary channel ID, until the funding outpoint is announced
20314 void OpenChannel_set_temporary_channel_id(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20317 * The channel value
20319 uint64_t OpenChannel_get_funding_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20322 * The channel value
20324 void OpenChannel_set_funding_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
20327 * The amount to push to the counterparty as part of the open, in milli-satoshi
20329 uint64_t OpenChannel_get_push_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20332 * The amount to push to the counterparty as part of the open, in milli-satoshi
20334 void OpenChannel_set_push_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
20337 * The threshold below which outputs on transactions broadcast by sender will be omitted
20339 uint64_t OpenChannel_get_dust_limit_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20342 * The threshold below which outputs on transactions broadcast by sender will be omitted
20344 void OpenChannel_set_dust_limit_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
20347 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
20349 uint64_t OpenChannel_get_max_htlc_value_in_flight_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20352 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
20354 void OpenChannel_set_max_htlc_value_in_flight_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
20357 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
20359 uint64_t OpenChannel_get_channel_reserve_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20362 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
20364 void OpenChannel_set_channel_reserve_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
20367 * The minimum HTLC size incoming to sender, in milli-satoshi
20369 uint64_t OpenChannel_get_htlc_minimum_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20372 * The minimum HTLC size incoming to sender, in milli-satoshi
20374 void OpenChannel_set_htlc_minimum_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
20377 * The feerate per 1000-weight of sender generated transactions, until updated by update_fee
20379 uint32_t OpenChannel_get_feerate_per_kw(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20382 * The feerate per 1000-weight of sender generated transactions, until updated by update_fee
20384 void OpenChannel_set_feerate_per_kw(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint32_t val);
20387 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
20389 uint16_t OpenChannel_get_to_self_delay(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20392 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
20394 void OpenChannel_set_to_self_delay(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint16_t val);
20397 * The maximum number of inbound HTLCs towards sender
20399 uint16_t OpenChannel_get_max_accepted_htlcs(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20402 * The maximum number of inbound HTLCs towards sender
20404 void OpenChannel_set_max_accepted_htlcs(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint16_t val);
20407 * The sender's key controlling the funding transaction
20409 struct LDKPublicKey OpenChannel_get_funding_pubkey(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20412 * The sender's key controlling the funding transaction
20414 void OpenChannel_set_funding_pubkey(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20417 * Used to derive a revocation key for transactions broadcast by counterparty
20419 struct LDKPublicKey OpenChannel_get_revocation_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20422 * Used to derive a revocation key for transactions broadcast by counterparty
20424 void OpenChannel_set_revocation_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20427 * A payment key to sender for transactions broadcast by counterparty
20429 struct LDKPublicKey OpenChannel_get_payment_point(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20432 * A payment key to sender for transactions broadcast by counterparty
20434 void OpenChannel_set_payment_point(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20437 * Used to derive a payment key to sender for transactions broadcast by sender
20439 struct LDKPublicKey OpenChannel_get_delayed_payment_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20442 * Used to derive a payment key to sender for transactions broadcast by sender
20444 void OpenChannel_set_delayed_payment_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20447 * Used to derive an HTLC payment key to sender
20449 struct LDKPublicKey OpenChannel_get_htlc_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20452 * Used to derive an HTLC payment key to sender
20454 void OpenChannel_set_htlc_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20457 * The first to-be-broadcast-by-sender transaction's per commitment point
20459 struct LDKPublicKey OpenChannel_get_first_per_commitment_point(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20462 * The first to-be-broadcast-by-sender transaction's per commitment point
20464 void OpenChannel_set_first_per_commitment_point(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20469 uint8_t OpenChannel_get_channel_flags(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20474 void OpenChannel_set_channel_flags(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint8_t val);
20477 * The channel type that this channel will represent. If none is set, we derive the channel
20478 * type from the intersection of our feature bits with our counterparty's feature bits from
20479 * the Init message.
20481 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20483 struct LDKChannelTypeFeatures OpenChannel_get_channel_type(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
20486 * The channel type that this channel will represent. If none is set, we derive the channel
20487 * type from the intersection of our feature bits with our counterparty's feature bits from
20488 * the Init message.
20490 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20492 void OpenChannel_set_channel_type(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKChannelTypeFeatures val);
20495 * Creates a copy of the OpenChannel
20497 struct LDKOpenChannel OpenChannel_clone(const struct LDKOpenChannel *NONNULL_PTR orig);
20500 * Frees any resources used by the AcceptChannel, if is_owned is set and inner is non-NULL.
20502 void AcceptChannel_free(struct LDKAcceptChannel this_obj);
20505 * A temporary channel ID, until the funding outpoint is announced
20507 const uint8_t (*AcceptChannel_get_temporary_channel_id(const struct LDKAcceptChannel *NONNULL_PTR this_ptr))[32];
20510 * A temporary channel ID, until the funding outpoint is announced
20512 void AcceptChannel_set_temporary_channel_id(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20515 * The threshold below which outputs on transactions broadcast by sender will be omitted
20517 uint64_t AcceptChannel_get_dust_limit_satoshis(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20520 * The threshold below which outputs on transactions broadcast by sender will be omitted
20522 void AcceptChannel_set_dust_limit_satoshis(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
20525 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
20527 uint64_t AcceptChannel_get_max_htlc_value_in_flight_msat(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20530 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
20532 void AcceptChannel_set_max_htlc_value_in_flight_msat(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
20535 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
20537 uint64_t AcceptChannel_get_channel_reserve_satoshis(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20540 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
20542 void AcceptChannel_set_channel_reserve_satoshis(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
20545 * The minimum HTLC size incoming to sender, in milli-satoshi
20547 uint64_t AcceptChannel_get_htlc_minimum_msat(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20550 * The minimum HTLC size incoming to sender, in milli-satoshi
20552 void AcceptChannel_set_htlc_minimum_msat(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
20555 * Minimum depth of the funding transaction before the channel is considered open
20557 uint32_t AcceptChannel_get_minimum_depth(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20560 * Minimum depth of the funding transaction before the channel is considered open
20562 void AcceptChannel_set_minimum_depth(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint32_t val);
20565 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
20567 uint16_t AcceptChannel_get_to_self_delay(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20570 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
20572 void AcceptChannel_set_to_self_delay(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint16_t val);
20575 * The maximum number of inbound HTLCs towards sender
20577 uint16_t AcceptChannel_get_max_accepted_htlcs(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20580 * The maximum number of inbound HTLCs towards sender
20582 void AcceptChannel_set_max_accepted_htlcs(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint16_t val);
20585 * The sender's key controlling the funding transaction
20587 struct LDKPublicKey AcceptChannel_get_funding_pubkey(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20590 * The sender's key controlling the funding transaction
20592 void AcceptChannel_set_funding_pubkey(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20595 * Used to derive a revocation key for transactions broadcast by counterparty
20597 struct LDKPublicKey AcceptChannel_get_revocation_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20600 * Used to derive a revocation key for transactions broadcast by counterparty
20602 void AcceptChannel_set_revocation_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20605 * A payment key to sender for transactions broadcast by counterparty
20607 struct LDKPublicKey AcceptChannel_get_payment_point(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20610 * A payment key to sender for transactions broadcast by counterparty
20612 void AcceptChannel_set_payment_point(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20615 * Used to derive a payment key to sender for transactions broadcast by sender
20617 struct LDKPublicKey AcceptChannel_get_delayed_payment_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20620 * Used to derive a payment key to sender for transactions broadcast by sender
20622 void AcceptChannel_set_delayed_payment_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20625 * Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
20627 struct LDKPublicKey AcceptChannel_get_htlc_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20630 * Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
20632 void AcceptChannel_set_htlc_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20635 * The first to-be-broadcast-by-sender transaction's per commitment point
20637 struct LDKPublicKey AcceptChannel_get_first_per_commitment_point(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20640 * The first to-be-broadcast-by-sender transaction's per commitment point
20642 void AcceptChannel_set_first_per_commitment_point(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20645 * The channel type that this channel will represent. If none is set, we derive the channel
20646 * type from the intersection of our feature bits with our counterparty's feature bits from
20647 * the Init message.
20649 * This is required to match the equivalent field in [`OpenChannel::channel_type`].
20651 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20653 struct LDKChannelTypeFeatures AcceptChannel_get_channel_type(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
20656 * The channel type that this channel will represent. If none is set, we derive the channel
20657 * type from the intersection of our feature bits with our counterparty's feature bits from
20658 * the Init message.
20660 * This is required to match the equivalent field in [`OpenChannel::channel_type`].
20662 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20664 void AcceptChannel_set_channel_type(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKChannelTypeFeatures val);
20667 * Creates a copy of the AcceptChannel
20669 struct LDKAcceptChannel AcceptChannel_clone(const struct LDKAcceptChannel *NONNULL_PTR orig);
20672 * Frees any resources used by the FundingCreated, if is_owned is set and inner is non-NULL.
20674 void FundingCreated_free(struct LDKFundingCreated this_obj);
20677 * A temporary channel ID, until the funding is established
20679 const uint8_t (*FundingCreated_get_temporary_channel_id(const struct LDKFundingCreated *NONNULL_PTR this_ptr))[32];
20682 * A temporary channel ID, until the funding is established
20684 void FundingCreated_set_temporary_channel_id(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20687 * The funding transaction ID
20689 const uint8_t (*FundingCreated_get_funding_txid(const struct LDKFundingCreated *NONNULL_PTR this_ptr))[32];
20692 * The funding transaction ID
20694 void FundingCreated_set_funding_txid(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20697 * The specific output index funding this channel
20699 uint16_t FundingCreated_get_funding_output_index(const struct LDKFundingCreated *NONNULL_PTR this_ptr);
20702 * The specific output index funding this channel
20704 void FundingCreated_set_funding_output_index(struct LDKFundingCreated *NONNULL_PTR this_ptr, uint16_t val);
20707 * The signature of the channel initiator (funder) on the initial commitment transaction
20709 struct LDKSignature FundingCreated_get_signature(const struct LDKFundingCreated *NONNULL_PTR this_ptr);
20712 * The signature of the channel initiator (funder) on the initial commitment transaction
20714 void FundingCreated_set_signature(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKSignature val);
20717 * Constructs a new FundingCreated given each field
20719 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);
20722 * Creates a copy of the FundingCreated
20724 struct LDKFundingCreated FundingCreated_clone(const struct LDKFundingCreated *NONNULL_PTR orig);
20727 * Frees any resources used by the FundingSigned, if is_owned is set and inner is non-NULL.
20729 void FundingSigned_free(struct LDKFundingSigned this_obj);
20734 const uint8_t (*FundingSigned_get_channel_id(const struct LDKFundingSigned *NONNULL_PTR this_ptr))[32];
20739 void FundingSigned_set_channel_id(struct LDKFundingSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20742 * The signature of the channel acceptor (fundee) on the initial commitment transaction
20744 struct LDKSignature FundingSigned_get_signature(const struct LDKFundingSigned *NONNULL_PTR this_ptr);
20747 * The signature of the channel acceptor (fundee) on the initial commitment transaction
20749 void FundingSigned_set_signature(struct LDKFundingSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
20752 * Constructs a new FundingSigned given each field
20754 MUST_USE_RES struct LDKFundingSigned FundingSigned_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKSignature signature_arg);
20757 * Creates a copy of the FundingSigned
20759 struct LDKFundingSigned FundingSigned_clone(const struct LDKFundingSigned *NONNULL_PTR orig);
20762 * Frees any resources used by the FundingLocked, if is_owned is set and inner is non-NULL.
20764 void FundingLocked_free(struct LDKFundingLocked this_obj);
20769 const uint8_t (*FundingLocked_get_channel_id(const struct LDKFundingLocked *NONNULL_PTR this_ptr))[32];
20774 void FundingLocked_set_channel_id(struct LDKFundingLocked *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20777 * The per-commitment point of the second commitment transaction
20779 struct LDKPublicKey FundingLocked_get_next_per_commitment_point(const struct LDKFundingLocked *NONNULL_PTR this_ptr);
20782 * The per-commitment point of the second commitment transaction
20784 void FundingLocked_set_next_per_commitment_point(struct LDKFundingLocked *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20787 * If set, provides a short_channel_id alias for this channel. The sender will accept payments
20788 * to be forwarded over this SCID and forward them to this messages' recipient.
20790 struct LDKCOption_u64Z FundingLocked_get_short_channel_id_alias(const struct LDKFundingLocked *NONNULL_PTR this_ptr);
20793 * If set, provides a short_channel_id alias for this channel. The sender will accept payments
20794 * to be forwarded over this SCID and forward them to this messages' recipient.
20796 void FundingLocked_set_short_channel_id_alias(struct LDKFundingLocked *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
20799 * Constructs a new FundingLocked given each field
20801 MUST_USE_RES struct LDKFundingLocked FundingLocked_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKPublicKey next_per_commitment_point_arg, struct LDKCOption_u64Z short_channel_id_alias_arg);
20804 * Creates a copy of the FundingLocked
20806 struct LDKFundingLocked FundingLocked_clone(const struct LDKFundingLocked *NONNULL_PTR orig);
20809 * Frees any resources used by the Shutdown, if is_owned is set and inner is non-NULL.
20811 void Shutdown_free(struct LDKShutdown this_obj);
20816 const uint8_t (*Shutdown_get_channel_id(const struct LDKShutdown *NONNULL_PTR this_ptr))[32];
20821 void Shutdown_set_channel_id(struct LDKShutdown *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20824 * The destination of this peer's funds on closing.
20825 * Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
20827 struct LDKu8slice Shutdown_get_scriptpubkey(const struct LDKShutdown *NONNULL_PTR this_ptr);
20830 * The destination of this peer's funds on closing.
20831 * Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
20833 void Shutdown_set_scriptpubkey(struct LDKShutdown *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
20836 * Constructs a new Shutdown given each field
20838 MUST_USE_RES struct LDKShutdown Shutdown_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKCVec_u8Z scriptpubkey_arg);
20841 * Creates a copy of the Shutdown
20843 struct LDKShutdown Shutdown_clone(const struct LDKShutdown *NONNULL_PTR orig);
20846 * Frees any resources used by the ClosingSignedFeeRange, if is_owned is set and inner is non-NULL.
20848 void ClosingSignedFeeRange_free(struct LDKClosingSignedFeeRange this_obj);
20851 * The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
20854 uint64_t ClosingSignedFeeRange_get_min_fee_satoshis(const struct LDKClosingSignedFeeRange *NONNULL_PTR this_ptr);
20857 * The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
20860 void ClosingSignedFeeRange_set_min_fee_satoshis(struct LDKClosingSignedFeeRange *NONNULL_PTR this_ptr, uint64_t val);
20863 * The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
20866 uint64_t ClosingSignedFeeRange_get_max_fee_satoshis(const struct LDKClosingSignedFeeRange *NONNULL_PTR this_ptr);
20869 * The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
20872 void ClosingSignedFeeRange_set_max_fee_satoshis(struct LDKClosingSignedFeeRange *NONNULL_PTR this_ptr, uint64_t val);
20875 * Constructs a new ClosingSignedFeeRange given each field
20877 MUST_USE_RES struct LDKClosingSignedFeeRange ClosingSignedFeeRange_new(uint64_t min_fee_satoshis_arg, uint64_t max_fee_satoshis_arg);
20880 * Creates a copy of the ClosingSignedFeeRange
20882 struct LDKClosingSignedFeeRange ClosingSignedFeeRange_clone(const struct LDKClosingSignedFeeRange *NONNULL_PTR orig);
20885 * Frees any resources used by the ClosingSigned, if is_owned is set and inner is non-NULL.
20887 void ClosingSigned_free(struct LDKClosingSigned this_obj);
20892 const uint8_t (*ClosingSigned_get_channel_id(const struct LDKClosingSigned *NONNULL_PTR this_ptr))[32];
20897 void ClosingSigned_set_channel_id(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20900 * The proposed total fee for the closing transaction
20902 uint64_t ClosingSigned_get_fee_satoshis(const struct LDKClosingSigned *NONNULL_PTR this_ptr);
20905 * The proposed total fee for the closing transaction
20907 void ClosingSigned_set_fee_satoshis(struct LDKClosingSigned *NONNULL_PTR this_ptr, uint64_t val);
20910 * A signature on the closing transaction
20912 struct LDKSignature ClosingSigned_get_signature(const struct LDKClosingSigned *NONNULL_PTR this_ptr);
20915 * A signature on the closing transaction
20917 void ClosingSigned_set_signature(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
20920 * The minimum and maximum fees which the sender is willing to accept, provided only by new
20923 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20925 struct LDKClosingSignedFeeRange ClosingSigned_get_fee_range(const struct LDKClosingSigned *NONNULL_PTR this_ptr);
20928 * The minimum and maximum fees which the sender is willing to accept, provided only by new
20931 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20933 void ClosingSigned_set_fee_range(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKClosingSignedFeeRange val);
20936 * Constructs a new ClosingSigned given each field
20938 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);
20941 * Creates a copy of the ClosingSigned
20943 struct LDKClosingSigned ClosingSigned_clone(const struct LDKClosingSigned *NONNULL_PTR orig);
20946 * Frees any resources used by the UpdateAddHTLC, if is_owned is set and inner is non-NULL.
20948 void UpdateAddHTLC_free(struct LDKUpdateAddHTLC this_obj);
20953 const uint8_t (*UpdateAddHTLC_get_channel_id(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr))[32];
20958 void UpdateAddHTLC_set_channel_id(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20963 uint64_t UpdateAddHTLC_get_htlc_id(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
20968 void UpdateAddHTLC_set_htlc_id(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint64_t val);
20971 * The HTLC value in milli-satoshi
20973 uint64_t UpdateAddHTLC_get_amount_msat(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
20976 * The HTLC value in milli-satoshi
20978 void UpdateAddHTLC_set_amount_msat(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint64_t val);
20981 * The payment hash, the pre-image of which controls HTLC redemption
20983 const uint8_t (*UpdateAddHTLC_get_payment_hash(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr))[32];
20986 * The payment hash, the pre-image of which controls HTLC redemption
20988 void UpdateAddHTLC_set_payment_hash(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20991 * The expiry height of the HTLC
20993 uint32_t UpdateAddHTLC_get_cltv_expiry(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
20996 * The expiry height of the HTLC
20998 void UpdateAddHTLC_set_cltv_expiry(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint32_t val);
21001 * Creates a copy of the UpdateAddHTLC
21003 struct LDKUpdateAddHTLC UpdateAddHTLC_clone(const struct LDKUpdateAddHTLC *NONNULL_PTR orig);
21006 * Frees any resources used by the UpdateFulfillHTLC, if is_owned is set and inner is non-NULL.
21008 void UpdateFulfillHTLC_free(struct LDKUpdateFulfillHTLC this_obj);
21013 const uint8_t (*UpdateFulfillHTLC_get_channel_id(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr))[32];
21018 void UpdateFulfillHTLC_set_channel_id(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21023 uint64_t UpdateFulfillHTLC_get_htlc_id(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr);
21028 void UpdateFulfillHTLC_set_htlc_id(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, uint64_t val);
21031 * The pre-image of the payment hash, allowing HTLC redemption
21033 const uint8_t (*UpdateFulfillHTLC_get_payment_preimage(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr))[32];
21036 * The pre-image of the payment hash, allowing HTLC redemption
21038 void UpdateFulfillHTLC_set_payment_preimage(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21041 * Constructs a new UpdateFulfillHTLC given each field
21043 MUST_USE_RES struct LDKUpdateFulfillHTLC UpdateFulfillHTLC_new(struct LDKThirtyTwoBytes channel_id_arg, uint64_t htlc_id_arg, struct LDKThirtyTwoBytes payment_preimage_arg);
21046 * Creates a copy of the UpdateFulfillHTLC
21048 struct LDKUpdateFulfillHTLC UpdateFulfillHTLC_clone(const struct LDKUpdateFulfillHTLC *NONNULL_PTR orig);
21051 * Frees any resources used by the UpdateFailHTLC, if is_owned is set and inner is non-NULL.
21053 void UpdateFailHTLC_free(struct LDKUpdateFailHTLC this_obj);
21058 const uint8_t (*UpdateFailHTLC_get_channel_id(const struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr))[32];
21063 void UpdateFailHTLC_set_channel_id(struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21068 uint64_t UpdateFailHTLC_get_htlc_id(const struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr);
21073 void UpdateFailHTLC_set_htlc_id(struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr, uint64_t val);
21076 * Creates a copy of the UpdateFailHTLC
21078 struct LDKUpdateFailHTLC UpdateFailHTLC_clone(const struct LDKUpdateFailHTLC *NONNULL_PTR orig);
21081 * Frees any resources used by the UpdateFailMalformedHTLC, if is_owned is set and inner is non-NULL.
21083 void UpdateFailMalformedHTLC_free(struct LDKUpdateFailMalformedHTLC this_obj);
21088 const uint8_t (*UpdateFailMalformedHTLC_get_channel_id(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr))[32];
21093 void UpdateFailMalformedHTLC_set_channel_id(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21098 uint64_t UpdateFailMalformedHTLC_get_htlc_id(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr);
21103 void UpdateFailMalformedHTLC_set_htlc_id(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, uint64_t val);
21108 uint16_t UpdateFailMalformedHTLC_get_failure_code(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr);
21113 void UpdateFailMalformedHTLC_set_failure_code(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, uint16_t val);
21116 * Creates a copy of the UpdateFailMalformedHTLC
21118 struct LDKUpdateFailMalformedHTLC UpdateFailMalformedHTLC_clone(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR orig);
21121 * Frees any resources used by the CommitmentSigned, if is_owned is set and inner is non-NULL.
21123 void CommitmentSigned_free(struct LDKCommitmentSigned this_obj);
21128 const uint8_t (*CommitmentSigned_get_channel_id(const struct LDKCommitmentSigned *NONNULL_PTR this_ptr))[32];
21133 void CommitmentSigned_set_channel_id(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21136 * A signature on the commitment transaction
21138 struct LDKSignature CommitmentSigned_get_signature(const struct LDKCommitmentSigned *NONNULL_PTR this_ptr);
21141 * A signature on the commitment transaction
21143 void CommitmentSigned_set_signature(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
21146 * Signatures on the HTLC transactions
21148 void CommitmentSigned_set_htlc_signatures(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKCVec_SignatureZ val);
21151 * Constructs a new CommitmentSigned given each field
21153 MUST_USE_RES struct LDKCommitmentSigned CommitmentSigned_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKSignature signature_arg, struct LDKCVec_SignatureZ htlc_signatures_arg);
21156 * Creates a copy of the CommitmentSigned
21158 struct LDKCommitmentSigned CommitmentSigned_clone(const struct LDKCommitmentSigned *NONNULL_PTR orig);
21161 * Frees any resources used by the RevokeAndACK, if is_owned is set and inner is non-NULL.
21163 void RevokeAndACK_free(struct LDKRevokeAndACK this_obj);
21168 const uint8_t (*RevokeAndACK_get_channel_id(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr))[32];
21173 void RevokeAndACK_set_channel_id(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21176 * The secret corresponding to the per-commitment point
21178 const uint8_t (*RevokeAndACK_get_per_commitment_secret(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr))[32];
21181 * The secret corresponding to the per-commitment point
21183 void RevokeAndACK_set_per_commitment_secret(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21186 * The next sender-broadcast commitment transaction's per-commitment point
21188 struct LDKPublicKey RevokeAndACK_get_next_per_commitment_point(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr);
21191 * The next sender-broadcast commitment transaction's per-commitment point
21193 void RevokeAndACK_set_next_per_commitment_point(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKPublicKey val);
21196 * Constructs a new RevokeAndACK given each field
21198 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);
21201 * Creates a copy of the RevokeAndACK
21203 struct LDKRevokeAndACK RevokeAndACK_clone(const struct LDKRevokeAndACK *NONNULL_PTR orig);
21206 * Frees any resources used by the UpdateFee, if is_owned is set and inner is non-NULL.
21208 void UpdateFee_free(struct LDKUpdateFee this_obj);
21213 const uint8_t (*UpdateFee_get_channel_id(const struct LDKUpdateFee *NONNULL_PTR this_ptr))[32];
21218 void UpdateFee_set_channel_id(struct LDKUpdateFee *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21221 * Fee rate per 1000-weight of the transaction
21223 uint32_t UpdateFee_get_feerate_per_kw(const struct LDKUpdateFee *NONNULL_PTR this_ptr);
21226 * Fee rate per 1000-weight of the transaction
21228 void UpdateFee_set_feerate_per_kw(struct LDKUpdateFee *NONNULL_PTR this_ptr, uint32_t val);
21231 * Constructs a new UpdateFee given each field
21233 MUST_USE_RES struct LDKUpdateFee UpdateFee_new(struct LDKThirtyTwoBytes channel_id_arg, uint32_t feerate_per_kw_arg);
21236 * Creates a copy of the UpdateFee
21238 struct LDKUpdateFee UpdateFee_clone(const struct LDKUpdateFee *NONNULL_PTR orig);
21241 * Frees any resources used by the DataLossProtect, if is_owned is set and inner is non-NULL.
21243 void DataLossProtect_free(struct LDKDataLossProtect this_obj);
21246 * Proof that the sender knows the per-commitment secret of a specific commitment transaction
21247 * belonging to the recipient
21249 const uint8_t (*DataLossProtect_get_your_last_per_commitment_secret(const struct LDKDataLossProtect *NONNULL_PTR this_ptr))[32];
21252 * Proof that the sender knows the per-commitment secret of a specific commitment transaction
21253 * belonging to the recipient
21255 void DataLossProtect_set_your_last_per_commitment_secret(struct LDKDataLossProtect *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21258 * The sender's per-commitment point for their current commitment transaction
21260 struct LDKPublicKey DataLossProtect_get_my_current_per_commitment_point(const struct LDKDataLossProtect *NONNULL_PTR this_ptr);
21263 * The sender's per-commitment point for their current commitment transaction
21265 void DataLossProtect_set_my_current_per_commitment_point(struct LDKDataLossProtect *NONNULL_PTR this_ptr, struct LDKPublicKey val);
21268 * Constructs a new DataLossProtect given each field
21270 MUST_USE_RES struct LDKDataLossProtect DataLossProtect_new(struct LDKThirtyTwoBytes your_last_per_commitment_secret_arg, struct LDKPublicKey my_current_per_commitment_point_arg);
21273 * Creates a copy of the DataLossProtect
21275 struct LDKDataLossProtect DataLossProtect_clone(const struct LDKDataLossProtect *NONNULL_PTR orig);
21278 * Frees any resources used by the ChannelReestablish, if is_owned is set and inner is non-NULL.
21280 void ChannelReestablish_free(struct LDKChannelReestablish this_obj);
21285 const uint8_t (*ChannelReestablish_get_channel_id(const struct LDKChannelReestablish *NONNULL_PTR this_ptr))[32];
21290 void ChannelReestablish_set_channel_id(struct LDKChannelReestablish *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21293 * The next commitment number for the sender
21295 uint64_t ChannelReestablish_get_next_local_commitment_number(const struct LDKChannelReestablish *NONNULL_PTR this_ptr);
21298 * The next commitment number for the sender
21300 void ChannelReestablish_set_next_local_commitment_number(struct LDKChannelReestablish *NONNULL_PTR this_ptr, uint64_t val);
21303 * The next commitment number for the recipient
21305 uint64_t ChannelReestablish_get_next_remote_commitment_number(const struct LDKChannelReestablish *NONNULL_PTR this_ptr);
21308 * The next commitment number for the recipient
21310 void ChannelReestablish_set_next_remote_commitment_number(struct LDKChannelReestablish *NONNULL_PTR this_ptr, uint64_t val);
21313 * Creates a copy of the ChannelReestablish
21315 struct LDKChannelReestablish ChannelReestablish_clone(const struct LDKChannelReestablish *NONNULL_PTR orig);
21318 * Frees any resources used by the AnnouncementSignatures, if is_owned is set and inner is non-NULL.
21320 void AnnouncementSignatures_free(struct LDKAnnouncementSignatures this_obj);
21325 const uint8_t (*AnnouncementSignatures_get_channel_id(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr))[32];
21330 void AnnouncementSignatures_set_channel_id(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21333 * The short channel ID
21335 uint64_t AnnouncementSignatures_get_short_channel_id(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
21338 * The short channel ID
21340 void AnnouncementSignatures_set_short_channel_id(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, uint64_t val);
21343 * A signature by the node key
21345 struct LDKSignature AnnouncementSignatures_get_node_signature(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
21348 * A signature by the node key
21350 void AnnouncementSignatures_set_node_signature(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKSignature val);
21353 * A signature by the funding key
21355 struct LDKSignature AnnouncementSignatures_get_bitcoin_signature(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
21358 * A signature by the funding key
21360 void AnnouncementSignatures_set_bitcoin_signature(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKSignature val);
21363 * Constructs a new AnnouncementSignatures given each field
21365 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);
21368 * Creates a copy of the AnnouncementSignatures
21370 struct LDKAnnouncementSignatures AnnouncementSignatures_clone(const struct LDKAnnouncementSignatures *NONNULL_PTR orig);
21373 * Frees any resources used by the NetAddress
21375 void NetAddress_free(struct LDKNetAddress this_ptr);
21378 * Creates a copy of the NetAddress
21380 struct LDKNetAddress NetAddress_clone(const struct LDKNetAddress *NONNULL_PTR orig);
21383 * Utility method to constructs a new IPv4-variant NetAddress
21385 struct LDKNetAddress NetAddress_ipv4(struct LDKFourBytes addr, uint16_t port);
21388 * Utility method to constructs a new IPv6-variant NetAddress
21390 struct LDKNetAddress NetAddress_ipv6(struct LDKSixteenBytes addr, uint16_t port);
21393 * Utility method to constructs a new OnionV2-variant NetAddress
21395 struct LDKNetAddress NetAddress_onion_v2(struct LDKTwelveBytes a);
21398 * Utility method to constructs a new OnionV3-variant NetAddress
21400 struct LDKNetAddress NetAddress_onion_v3(struct LDKThirtyTwoBytes ed25519_pubkey, uint16_t checksum, uint8_t version, uint16_t port);
21403 * Serialize the NetAddress object into a byte array which can be read by NetAddress_read
21405 struct LDKCVec_u8Z NetAddress_write(const struct LDKNetAddress *NONNULL_PTR obj);
21408 * Read a NetAddress from a byte array, created by NetAddress_write
21410 struct LDKCResult_NetAddressDecodeErrorZ NetAddress_read(struct LDKu8slice ser);
21413 * Frees any resources used by the UnsignedNodeAnnouncement, if is_owned is set and inner is non-NULL.
21415 void UnsignedNodeAnnouncement_free(struct LDKUnsignedNodeAnnouncement this_obj);
21418 * The advertised features
21420 struct LDKNodeFeatures UnsignedNodeAnnouncement_get_features(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
21423 * The advertised features
21425 void UnsignedNodeAnnouncement_set_features(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
21428 * A strictly monotonic announcement counter, with gaps allowed
21430 uint32_t UnsignedNodeAnnouncement_get_timestamp(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
21433 * A strictly monotonic announcement counter, with gaps allowed
21435 void UnsignedNodeAnnouncement_set_timestamp(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, uint32_t val);
21438 * The node_id this announcement originated from (don't rebroadcast the node_announcement back
21441 struct LDKPublicKey UnsignedNodeAnnouncement_get_node_id(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
21444 * The node_id this announcement originated from (don't rebroadcast the node_announcement back
21447 void UnsignedNodeAnnouncement_set_node_id(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
21450 * An RGB color for UI purposes
21452 const uint8_t (*UnsignedNodeAnnouncement_get_rgb(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr))[3];
21455 * An RGB color for UI purposes
21457 void UnsignedNodeAnnouncement_set_rgb(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKThreeBytes val);
21460 * An alias, for UI purposes. This should be sanitized before use. There is no guarantee
21463 const uint8_t (*UnsignedNodeAnnouncement_get_alias(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr))[32];
21466 * An alias, for UI purposes. This should be sanitized before use. There is no guarantee
21469 void UnsignedNodeAnnouncement_set_alias(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21472 * List of addresses on which this node is reachable
21474 void UnsignedNodeAnnouncement_set_addresses(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKCVec_NetAddressZ val);
21477 * Creates a copy of the UnsignedNodeAnnouncement
21479 struct LDKUnsignedNodeAnnouncement UnsignedNodeAnnouncement_clone(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR orig);
21482 * Frees any resources used by the NodeAnnouncement, if is_owned is set and inner is non-NULL.
21484 void NodeAnnouncement_free(struct LDKNodeAnnouncement this_obj);
21487 * The signature by the node key
21489 struct LDKSignature NodeAnnouncement_get_signature(const struct LDKNodeAnnouncement *NONNULL_PTR this_ptr);
21492 * The signature by the node key
21494 void NodeAnnouncement_set_signature(struct LDKNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
21497 * The actual content of the announcement
21499 struct LDKUnsignedNodeAnnouncement NodeAnnouncement_get_contents(const struct LDKNodeAnnouncement *NONNULL_PTR this_ptr);
21502 * The actual content of the announcement
21504 void NodeAnnouncement_set_contents(struct LDKNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKUnsignedNodeAnnouncement val);
21507 * Constructs a new NodeAnnouncement given each field
21509 MUST_USE_RES struct LDKNodeAnnouncement NodeAnnouncement_new(struct LDKSignature signature_arg, struct LDKUnsignedNodeAnnouncement contents_arg);
21512 * Creates a copy of the NodeAnnouncement
21514 struct LDKNodeAnnouncement NodeAnnouncement_clone(const struct LDKNodeAnnouncement *NONNULL_PTR orig);
21517 * Frees any resources used by the UnsignedChannelAnnouncement, if is_owned is set and inner is non-NULL.
21519 void UnsignedChannelAnnouncement_free(struct LDKUnsignedChannelAnnouncement this_obj);
21522 * The advertised channel features
21524 struct LDKChannelFeatures UnsignedChannelAnnouncement_get_features(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
21527 * The advertised channel features
21529 void UnsignedChannelAnnouncement_set_features(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
21532 * The genesis hash of the blockchain where the channel is to be opened
21534 const uint8_t (*UnsignedChannelAnnouncement_get_chain_hash(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr))[32];
21537 * The genesis hash of the blockchain where the channel is to be opened
21539 void UnsignedChannelAnnouncement_set_chain_hash(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21542 * The short channel ID
21544 uint64_t UnsignedChannelAnnouncement_get_short_channel_id(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
21547 * The short channel ID
21549 void UnsignedChannelAnnouncement_set_short_channel_id(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, uint64_t val);
21552 * One of the two node_ids which are endpoints of this channel
21554 struct LDKPublicKey UnsignedChannelAnnouncement_get_node_id_1(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
21557 * One of the two node_ids which are endpoints of this channel
21559 void UnsignedChannelAnnouncement_set_node_id_1(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
21562 * The other of the two node_ids which are endpoints of this channel
21564 struct LDKPublicKey UnsignedChannelAnnouncement_get_node_id_2(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
21567 * The other of the two node_ids which are endpoints of this channel
21569 void UnsignedChannelAnnouncement_set_node_id_2(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
21572 * The funding key for the first node
21574 struct LDKPublicKey UnsignedChannelAnnouncement_get_bitcoin_key_1(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
21577 * The funding key for the first node
21579 void UnsignedChannelAnnouncement_set_bitcoin_key_1(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
21582 * The funding key for the second node
21584 struct LDKPublicKey UnsignedChannelAnnouncement_get_bitcoin_key_2(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
21587 * The funding key for the second node
21589 void UnsignedChannelAnnouncement_set_bitcoin_key_2(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
21592 * Creates a copy of the UnsignedChannelAnnouncement
21594 struct LDKUnsignedChannelAnnouncement UnsignedChannelAnnouncement_clone(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR orig);
21597 * Frees any resources used by the ChannelAnnouncement, if is_owned is set and inner is non-NULL.
21599 void ChannelAnnouncement_free(struct LDKChannelAnnouncement this_obj);
21602 * Authentication of the announcement by the first public node
21604 struct LDKSignature ChannelAnnouncement_get_node_signature_1(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
21607 * Authentication of the announcement by the first public node
21609 void ChannelAnnouncement_set_node_signature_1(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
21612 * Authentication of the announcement by the second public node
21614 struct LDKSignature ChannelAnnouncement_get_node_signature_2(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
21617 * Authentication of the announcement by the second public node
21619 void ChannelAnnouncement_set_node_signature_2(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
21622 * Proof of funding UTXO ownership by the first public node
21624 struct LDKSignature ChannelAnnouncement_get_bitcoin_signature_1(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
21627 * Proof of funding UTXO ownership by the first public node
21629 void ChannelAnnouncement_set_bitcoin_signature_1(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
21632 * Proof of funding UTXO ownership by the second public node
21634 struct LDKSignature ChannelAnnouncement_get_bitcoin_signature_2(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
21637 * Proof of funding UTXO ownership by the second public node
21639 void ChannelAnnouncement_set_bitcoin_signature_2(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
21642 * The actual announcement
21644 struct LDKUnsignedChannelAnnouncement ChannelAnnouncement_get_contents(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
21647 * The actual announcement
21649 void ChannelAnnouncement_set_contents(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKUnsignedChannelAnnouncement val);
21652 * Constructs a new ChannelAnnouncement given each field
21654 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);
21657 * Creates a copy of the ChannelAnnouncement
21659 struct LDKChannelAnnouncement ChannelAnnouncement_clone(const struct LDKChannelAnnouncement *NONNULL_PTR orig);
21662 * Frees any resources used by the UnsignedChannelUpdate, if is_owned is set and inner is non-NULL.
21664 void UnsignedChannelUpdate_free(struct LDKUnsignedChannelUpdate this_obj);
21667 * The genesis hash of the blockchain where the channel is to be opened
21669 const uint8_t (*UnsignedChannelUpdate_get_chain_hash(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr))[32];
21672 * The genesis hash of the blockchain where the channel is to be opened
21674 void UnsignedChannelUpdate_set_chain_hash(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21677 * The short channel ID
21679 uint64_t UnsignedChannelUpdate_get_short_channel_id(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
21682 * The short channel ID
21684 void UnsignedChannelUpdate_set_short_channel_id(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint64_t val);
21687 * A strictly monotonic announcement counter, with gaps allowed, specific to this channel
21689 uint32_t UnsignedChannelUpdate_get_timestamp(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
21692 * A strictly monotonic announcement counter, with gaps allowed, specific to this channel
21694 void UnsignedChannelUpdate_set_timestamp(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
21699 uint8_t UnsignedChannelUpdate_get_flags(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
21704 void UnsignedChannelUpdate_set_flags(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint8_t val);
21707 * The number of blocks such that if:
21708 * `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
21709 * then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
21710 * the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
21711 * cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
21712 * then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
21713 * forwarding. Note that the HTLC sender is the one who originally sets this value when
21714 * constructing the route.
21716 uint16_t UnsignedChannelUpdate_get_cltv_expiry_delta(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
21719 * The number of blocks such that if:
21720 * `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
21721 * then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
21722 * the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
21723 * cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
21724 * then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
21725 * forwarding. Note that the HTLC sender is the one who originally sets this value when
21726 * constructing the route.
21728 void UnsignedChannelUpdate_set_cltv_expiry_delta(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint16_t val);
21731 * The minimum HTLC size incoming to sender, in milli-satoshi
21733 uint64_t UnsignedChannelUpdate_get_htlc_minimum_msat(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
21736 * The minimum HTLC size incoming to sender, in milli-satoshi
21738 void UnsignedChannelUpdate_set_htlc_minimum_msat(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint64_t val);
21741 * The base HTLC fee charged by sender, in milli-satoshi
21743 uint32_t UnsignedChannelUpdate_get_fee_base_msat(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
21746 * The base HTLC fee charged by sender, in milli-satoshi
21748 void UnsignedChannelUpdate_set_fee_base_msat(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
21751 * The amount to fee multiplier, in micro-satoshi
21753 uint32_t UnsignedChannelUpdate_get_fee_proportional_millionths(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
21756 * The amount to fee multiplier, in micro-satoshi
21758 void UnsignedChannelUpdate_set_fee_proportional_millionths(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
21761 * Creates a copy of the UnsignedChannelUpdate
21763 struct LDKUnsignedChannelUpdate UnsignedChannelUpdate_clone(const struct LDKUnsignedChannelUpdate *NONNULL_PTR orig);
21766 * Frees any resources used by the ChannelUpdate, if is_owned is set and inner is non-NULL.
21768 void ChannelUpdate_free(struct LDKChannelUpdate this_obj);
21771 * A signature of the channel update
21773 struct LDKSignature ChannelUpdate_get_signature(const struct LDKChannelUpdate *NONNULL_PTR this_ptr);
21776 * A signature of the channel update
21778 void ChannelUpdate_set_signature(struct LDKChannelUpdate *NONNULL_PTR this_ptr, struct LDKSignature val);
21781 * The actual channel update
21783 struct LDKUnsignedChannelUpdate ChannelUpdate_get_contents(const struct LDKChannelUpdate *NONNULL_PTR this_ptr);
21786 * The actual channel update
21788 void ChannelUpdate_set_contents(struct LDKChannelUpdate *NONNULL_PTR this_ptr, struct LDKUnsignedChannelUpdate val);
21791 * Constructs a new ChannelUpdate given each field
21793 MUST_USE_RES struct LDKChannelUpdate ChannelUpdate_new(struct LDKSignature signature_arg, struct LDKUnsignedChannelUpdate contents_arg);
21796 * Creates a copy of the ChannelUpdate
21798 struct LDKChannelUpdate ChannelUpdate_clone(const struct LDKChannelUpdate *NONNULL_PTR orig);
21801 * Frees any resources used by the QueryChannelRange, if is_owned is set and inner is non-NULL.
21803 void QueryChannelRange_free(struct LDKQueryChannelRange this_obj);
21806 * The genesis hash of the blockchain being queried
21808 const uint8_t (*QueryChannelRange_get_chain_hash(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr))[32];
21811 * The genesis hash of the blockchain being queried
21813 void QueryChannelRange_set_chain_hash(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21816 * The height of the first block for the channel UTXOs being queried
21818 uint32_t QueryChannelRange_get_first_blocknum(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr);
21821 * The height of the first block for the channel UTXOs being queried
21823 void QueryChannelRange_set_first_blocknum(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, uint32_t val);
21826 * The number of blocks to include in the query results
21828 uint32_t QueryChannelRange_get_number_of_blocks(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr);
21831 * The number of blocks to include in the query results
21833 void QueryChannelRange_set_number_of_blocks(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, uint32_t val);
21836 * Constructs a new QueryChannelRange given each field
21838 MUST_USE_RES struct LDKQueryChannelRange QueryChannelRange_new(struct LDKThirtyTwoBytes chain_hash_arg, uint32_t first_blocknum_arg, uint32_t number_of_blocks_arg);
21841 * Creates a copy of the QueryChannelRange
21843 struct LDKQueryChannelRange QueryChannelRange_clone(const struct LDKQueryChannelRange *NONNULL_PTR orig);
21846 * Frees any resources used by the ReplyChannelRange, if is_owned is set and inner is non-NULL.
21848 void ReplyChannelRange_free(struct LDKReplyChannelRange this_obj);
21851 * The genesis hash of the blockchain being queried
21853 const uint8_t (*ReplyChannelRange_get_chain_hash(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr))[32];
21856 * The genesis hash of the blockchain being queried
21858 void ReplyChannelRange_set_chain_hash(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21861 * The height of the first block in the range of the reply
21863 uint32_t ReplyChannelRange_get_first_blocknum(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
21866 * The height of the first block in the range of the reply
21868 void ReplyChannelRange_set_first_blocknum(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, uint32_t val);
21871 * The number of blocks included in the range of the reply
21873 uint32_t ReplyChannelRange_get_number_of_blocks(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
21876 * The number of blocks included in the range of the reply
21878 void ReplyChannelRange_set_number_of_blocks(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, uint32_t val);
21881 * True when this is the final reply for a query
21883 bool ReplyChannelRange_get_sync_complete(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
21886 * True when this is the final reply for a query
21888 void ReplyChannelRange_set_sync_complete(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, bool val);
21891 * The short_channel_ids in the channel range
21893 void ReplyChannelRange_set_short_channel_ids(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
21896 * Constructs a new ReplyChannelRange given each field
21898 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);
21901 * Creates a copy of the ReplyChannelRange
21903 struct LDKReplyChannelRange ReplyChannelRange_clone(const struct LDKReplyChannelRange *NONNULL_PTR orig);
21906 * Frees any resources used by the QueryShortChannelIds, if is_owned is set and inner is non-NULL.
21908 void QueryShortChannelIds_free(struct LDKQueryShortChannelIds this_obj);
21911 * The genesis hash of the blockchain being queried
21913 const uint8_t (*QueryShortChannelIds_get_chain_hash(const struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr))[32];
21916 * The genesis hash of the blockchain being queried
21918 void QueryShortChannelIds_set_chain_hash(struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21921 * The short_channel_ids that are being queried
21923 void QueryShortChannelIds_set_short_channel_ids(struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
21926 * Constructs a new QueryShortChannelIds given each field
21928 MUST_USE_RES struct LDKQueryShortChannelIds QueryShortChannelIds_new(struct LDKThirtyTwoBytes chain_hash_arg, struct LDKCVec_u64Z short_channel_ids_arg);
21931 * Creates a copy of the QueryShortChannelIds
21933 struct LDKQueryShortChannelIds QueryShortChannelIds_clone(const struct LDKQueryShortChannelIds *NONNULL_PTR orig);
21936 * Frees any resources used by the ReplyShortChannelIdsEnd, if is_owned is set and inner is non-NULL.
21938 void ReplyShortChannelIdsEnd_free(struct LDKReplyShortChannelIdsEnd this_obj);
21941 * The genesis hash of the blockchain that was queried
21943 const uint8_t (*ReplyShortChannelIdsEnd_get_chain_hash(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr))[32];
21946 * The genesis hash of the blockchain that was queried
21948 void ReplyShortChannelIdsEnd_set_chain_hash(struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21951 * Indicates if the query recipient maintains up-to-date channel
21952 * information for the chain_hash
21954 bool ReplyShortChannelIdsEnd_get_full_information(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr);
21957 * Indicates if the query recipient maintains up-to-date channel
21958 * information for the chain_hash
21960 void ReplyShortChannelIdsEnd_set_full_information(struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr, bool val);
21963 * Constructs a new ReplyShortChannelIdsEnd given each field
21965 MUST_USE_RES struct LDKReplyShortChannelIdsEnd ReplyShortChannelIdsEnd_new(struct LDKThirtyTwoBytes chain_hash_arg, bool full_information_arg);
21968 * Creates a copy of the ReplyShortChannelIdsEnd
21970 struct LDKReplyShortChannelIdsEnd ReplyShortChannelIdsEnd_clone(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR orig);
21973 * Frees any resources used by the GossipTimestampFilter, if is_owned is set and inner is non-NULL.
21975 void GossipTimestampFilter_free(struct LDKGossipTimestampFilter this_obj);
21978 * The genesis hash of the blockchain for channel and node information
21980 const uint8_t (*GossipTimestampFilter_get_chain_hash(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr))[32];
21983 * The genesis hash of the blockchain for channel and node information
21985 void GossipTimestampFilter_set_chain_hash(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
21988 * The starting unix timestamp
21990 uint32_t GossipTimestampFilter_get_first_timestamp(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr);
21993 * The starting unix timestamp
21995 void GossipTimestampFilter_set_first_timestamp(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, uint32_t val);
21998 * The range of information in seconds
22000 uint32_t GossipTimestampFilter_get_timestamp_range(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr);
22003 * The range of information in seconds
22005 void GossipTimestampFilter_set_timestamp_range(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, uint32_t val);
22008 * Constructs a new GossipTimestampFilter given each field
22010 MUST_USE_RES struct LDKGossipTimestampFilter GossipTimestampFilter_new(struct LDKThirtyTwoBytes chain_hash_arg, uint32_t first_timestamp_arg, uint32_t timestamp_range_arg);
22013 * Creates a copy of the GossipTimestampFilter
22015 struct LDKGossipTimestampFilter GossipTimestampFilter_clone(const struct LDKGossipTimestampFilter *NONNULL_PTR orig);
22018 * Frees any resources used by the ErrorAction
22020 void ErrorAction_free(struct LDKErrorAction this_ptr);
22023 * Creates a copy of the ErrorAction
22025 struct LDKErrorAction ErrorAction_clone(const struct LDKErrorAction *NONNULL_PTR orig);
22028 * Utility method to constructs a new DisconnectPeer-variant ErrorAction
22030 struct LDKErrorAction ErrorAction_disconnect_peer(struct LDKErrorMessage msg);
22033 * Utility method to constructs a new IgnoreError-variant ErrorAction
22035 struct LDKErrorAction ErrorAction_ignore_error(void);
22038 * Utility method to constructs a new IgnoreAndLog-variant ErrorAction
22040 struct LDKErrorAction ErrorAction_ignore_and_log(enum LDKLevel a);
22043 * Utility method to constructs a new IgnoreDuplicateGossip-variant ErrorAction
22045 struct LDKErrorAction ErrorAction_ignore_duplicate_gossip(void);
22048 * Utility method to constructs a new SendErrorMessage-variant ErrorAction
22050 struct LDKErrorAction ErrorAction_send_error_message(struct LDKErrorMessage msg);
22053 * Utility method to constructs a new SendWarningMessage-variant ErrorAction
22055 struct LDKErrorAction ErrorAction_send_warning_message(struct LDKWarningMessage msg, enum LDKLevel log_level);
22058 * Frees any resources used by the LightningError, if is_owned is set and inner is non-NULL.
22060 void LightningError_free(struct LDKLightningError this_obj);
22063 * A human-readable message describing the error
22065 struct LDKStr LightningError_get_err(const struct LDKLightningError *NONNULL_PTR this_ptr);
22068 * A human-readable message describing the error
22070 void LightningError_set_err(struct LDKLightningError *NONNULL_PTR this_ptr, struct LDKStr val);
22073 * The action which should be taken against the offending peer.
22075 struct LDKErrorAction LightningError_get_action(const struct LDKLightningError *NONNULL_PTR this_ptr);
22078 * The action which should be taken against the offending peer.
22080 void LightningError_set_action(struct LDKLightningError *NONNULL_PTR this_ptr, struct LDKErrorAction val);
22083 * Constructs a new LightningError given each field
22085 MUST_USE_RES struct LDKLightningError LightningError_new(struct LDKStr err_arg, struct LDKErrorAction action_arg);
22088 * Creates a copy of the LightningError
22090 struct LDKLightningError LightningError_clone(const struct LDKLightningError *NONNULL_PTR orig);
22093 * Frees any resources used by the CommitmentUpdate, if is_owned is set and inner is non-NULL.
22095 void CommitmentUpdate_free(struct LDKCommitmentUpdate this_obj);
22098 * update_add_htlc messages which should be sent
22100 struct LDKCVec_UpdateAddHTLCZ CommitmentUpdate_get_update_add_htlcs(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
22103 * update_add_htlc messages which should be sent
22105 void CommitmentUpdate_set_update_add_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateAddHTLCZ val);
22108 * update_fulfill_htlc messages which should be sent
22110 struct LDKCVec_UpdateFulfillHTLCZ CommitmentUpdate_get_update_fulfill_htlcs(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
22113 * update_fulfill_htlc messages which should be sent
22115 void CommitmentUpdate_set_update_fulfill_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFulfillHTLCZ val);
22118 * update_fail_htlc messages which should be sent
22120 struct LDKCVec_UpdateFailHTLCZ CommitmentUpdate_get_update_fail_htlcs(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
22123 * update_fail_htlc messages which should be sent
22125 void CommitmentUpdate_set_update_fail_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFailHTLCZ val);
22128 * update_fail_malformed_htlc messages which should be sent
22130 struct LDKCVec_UpdateFailMalformedHTLCZ CommitmentUpdate_get_update_fail_malformed_htlcs(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
22133 * update_fail_malformed_htlc messages which should be sent
22135 void CommitmentUpdate_set_update_fail_malformed_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFailMalformedHTLCZ val);
22138 * An update_fee message which should be sent
22140 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
22142 struct LDKUpdateFee CommitmentUpdate_get_update_fee(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
22145 * An update_fee message which should be sent
22147 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
22149 void CommitmentUpdate_set_update_fee(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKUpdateFee val);
22152 * Finally, the commitment_signed message which should be sent
22154 struct LDKCommitmentSigned CommitmentUpdate_get_commitment_signed(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
22157 * Finally, the commitment_signed message which should be sent
22159 void CommitmentUpdate_set_commitment_signed(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCommitmentSigned val);
22162 * Constructs a new CommitmentUpdate given each field
22164 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);
22167 * Creates a copy of the CommitmentUpdate
22169 struct LDKCommitmentUpdate CommitmentUpdate_clone(const struct LDKCommitmentUpdate *NONNULL_PTR orig);
22172 * Calls the free function if one is set
22174 void ChannelMessageHandler_free(struct LDKChannelMessageHandler this_ptr);
22177 * Calls the free function if one is set
22179 void RoutingMessageHandler_free(struct LDKRoutingMessageHandler this_ptr);
22182 * Serialize the AcceptChannel object into a byte array which can be read by AcceptChannel_read
22184 struct LDKCVec_u8Z AcceptChannel_write(const struct LDKAcceptChannel *NONNULL_PTR obj);
22187 * Read a AcceptChannel from a byte array, created by AcceptChannel_write
22189 struct LDKCResult_AcceptChannelDecodeErrorZ AcceptChannel_read(struct LDKu8slice ser);
22192 * Serialize the AnnouncementSignatures object into a byte array which can be read by AnnouncementSignatures_read
22194 struct LDKCVec_u8Z AnnouncementSignatures_write(const struct LDKAnnouncementSignatures *NONNULL_PTR obj);
22197 * Read a AnnouncementSignatures from a byte array, created by AnnouncementSignatures_write
22199 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ AnnouncementSignatures_read(struct LDKu8slice ser);
22202 * Serialize the ChannelReestablish object into a byte array which can be read by ChannelReestablish_read
22204 struct LDKCVec_u8Z ChannelReestablish_write(const struct LDKChannelReestablish *NONNULL_PTR obj);
22207 * Read a ChannelReestablish from a byte array, created by ChannelReestablish_write
22209 struct LDKCResult_ChannelReestablishDecodeErrorZ ChannelReestablish_read(struct LDKu8slice ser);
22212 * Serialize the ClosingSigned object into a byte array which can be read by ClosingSigned_read
22214 struct LDKCVec_u8Z ClosingSigned_write(const struct LDKClosingSigned *NONNULL_PTR obj);
22217 * Read a ClosingSigned from a byte array, created by ClosingSigned_write
22219 struct LDKCResult_ClosingSignedDecodeErrorZ ClosingSigned_read(struct LDKu8slice ser);
22222 * Serialize the ClosingSignedFeeRange object into a byte array which can be read by ClosingSignedFeeRange_read
22224 struct LDKCVec_u8Z ClosingSignedFeeRange_write(const struct LDKClosingSignedFeeRange *NONNULL_PTR obj);
22227 * Read a ClosingSignedFeeRange from a byte array, created by ClosingSignedFeeRange_write
22229 struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ ClosingSignedFeeRange_read(struct LDKu8slice ser);
22232 * Serialize the CommitmentSigned object into a byte array which can be read by CommitmentSigned_read
22234 struct LDKCVec_u8Z CommitmentSigned_write(const struct LDKCommitmentSigned *NONNULL_PTR obj);
22237 * Read a CommitmentSigned from a byte array, created by CommitmentSigned_write
22239 struct LDKCResult_CommitmentSignedDecodeErrorZ CommitmentSigned_read(struct LDKu8slice ser);
22242 * Serialize the FundingCreated object into a byte array which can be read by FundingCreated_read
22244 struct LDKCVec_u8Z FundingCreated_write(const struct LDKFundingCreated *NONNULL_PTR obj);
22247 * Read a FundingCreated from a byte array, created by FundingCreated_write
22249 struct LDKCResult_FundingCreatedDecodeErrorZ FundingCreated_read(struct LDKu8slice ser);
22252 * Serialize the FundingSigned object into a byte array which can be read by FundingSigned_read
22254 struct LDKCVec_u8Z FundingSigned_write(const struct LDKFundingSigned *NONNULL_PTR obj);
22257 * Read a FundingSigned from a byte array, created by FundingSigned_write
22259 struct LDKCResult_FundingSignedDecodeErrorZ FundingSigned_read(struct LDKu8slice ser);
22262 * Serialize the FundingLocked object into a byte array which can be read by FundingLocked_read
22264 struct LDKCVec_u8Z FundingLocked_write(const struct LDKFundingLocked *NONNULL_PTR obj);
22267 * Read a FundingLocked from a byte array, created by FundingLocked_write
22269 struct LDKCResult_FundingLockedDecodeErrorZ FundingLocked_read(struct LDKu8slice ser);
22272 * Serialize the Init object into a byte array which can be read by Init_read
22274 struct LDKCVec_u8Z Init_write(const struct LDKInit *NONNULL_PTR obj);
22277 * Read a Init from a byte array, created by Init_write
22279 struct LDKCResult_InitDecodeErrorZ Init_read(struct LDKu8slice ser);
22282 * Serialize the OpenChannel object into a byte array which can be read by OpenChannel_read
22284 struct LDKCVec_u8Z OpenChannel_write(const struct LDKOpenChannel *NONNULL_PTR obj);
22287 * Read a OpenChannel from a byte array, created by OpenChannel_write
22289 struct LDKCResult_OpenChannelDecodeErrorZ OpenChannel_read(struct LDKu8slice ser);
22292 * Serialize the RevokeAndACK object into a byte array which can be read by RevokeAndACK_read
22294 struct LDKCVec_u8Z RevokeAndACK_write(const struct LDKRevokeAndACK *NONNULL_PTR obj);
22297 * Read a RevokeAndACK from a byte array, created by RevokeAndACK_write
22299 struct LDKCResult_RevokeAndACKDecodeErrorZ RevokeAndACK_read(struct LDKu8slice ser);
22302 * Serialize the Shutdown object into a byte array which can be read by Shutdown_read
22304 struct LDKCVec_u8Z Shutdown_write(const struct LDKShutdown *NONNULL_PTR obj);
22307 * Read a Shutdown from a byte array, created by Shutdown_write
22309 struct LDKCResult_ShutdownDecodeErrorZ Shutdown_read(struct LDKu8slice ser);
22312 * Serialize the UpdateFailHTLC object into a byte array which can be read by UpdateFailHTLC_read
22314 struct LDKCVec_u8Z UpdateFailHTLC_write(const struct LDKUpdateFailHTLC *NONNULL_PTR obj);
22317 * Read a UpdateFailHTLC from a byte array, created by UpdateFailHTLC_write
22319 struct LDKCResult_UpdateFailHTLCDecodeErrorZ UpdateFailHTLC_read(struct LDKu8slice ser);
22322 * Serialize the UpdateFailMalformedHTLC object into a byte array which can be read by UpdateFailMalformedHTLC_read
22324 struct LDKCVec_u8Z UpdateFailMalformedHTLC_write(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR obj);
22327 * Read a UpdateFailMalformedHTLC from a byte array, created by UpdateFailMalformedHTLC_write
22329 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ UpdateFailMalformedHTLC_read(struct LDKu8slice ser);
22332 * Serialize the UpdateFee object into a byte array which can be read by UpdateFee_read
22334 struct LDKCVec_u8Z UpdateFee_write(const struct LDKUpdateFee *NONNULL_PTR obj);
22337 * Read a UpdateFee from a byte array, created by UpdateFee_write
22339 struct LDKCResult_UpdateFeeDecodeErrorZ UpdateFee_read(struct LDKu8slice ser);
22342 * Serialize the UpdateFulfillHTLC object into a byte array which can be read by UpdateFulfillHTLC_read
22344 struct LDKCVec_u8Z UpdateFulfillHTLC_write(const struct LDKUpdateFulfillHTLC *NONNULL_PTR obj);
22347 * Read a UpdateFulfillHTLC from a byte array, created by UpdateFulfillHTLC_write
22349 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ UpdateFulfillHTLC_read(struct LDKu8slice ser);
22352 * Serialize the UpdateAddHTLC object into a byte array which can be read by UpdateAddHTLC_read
22354 struct LDKCVec_u8Z UpdateAddHTLC_write(const struct LDKUpdateAddHTLC *NONNULL_PTR obj);
22357 * Read a UpdateAddHTLC from a byte array, created by UpdateAddHTLC_write
22359 struct LDKCResult_UpdateAddHTLCDecodeErrorZ UpdateAddHTLC_read(struct LDKu8slice ser);
22362 * Serialize the Ping object into a byte array which can be read by Ping_read
22364 struct LDKCVec_u8Z Ping_write(const struct LDKPing *NONNULL_PTR obj);
22367 * Read a Ping from a byte array, created by Ping_write
22369 struct LDKCResult_PingDecodeErrorZ Ping_read(struct LDKu8slice ser);
22372 * Serialize the Pong object into a byte array which can be read by Pong_read
22374 struct LDKCVec_u8Z Pong_write(const struct LDKPong *NONNULL_PTR obj);
22377 * Read a Pong from a byte array, created by Pong_write
22379 struct LDKCResult_PongDecodeErrorZ Pong_read(struct LDKu8slice ser);
22382 * Serialize the UnsignedChannelAnnouncement object into a byte array which can be read by UnsignedChannelAnnouncement_read
22384 struct LDKCVec_u8Z UnsignedChannelAnnouncement_write(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR obj);
22387 * Read a UnsignedChannelAnnouncement from a byte array, created by UnsignedChannelAnnouncement_write
22389 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ UnsignedChannelAnnouncement_read(struct LDKu8slice ser);
22392 * Serialize the ChannelAnnouncement object into a byte array which can be read by ChannelAnnouncement_read
22394 struct LDKCVec_u8Z ChannelAnnouncement_write(const struct LDKChannelAnnouncement *NONNULL_PTR obj);
22397 * Read a ChannelAnnouncement from a byte array, created by ChannelAnnouncement_write
22399 struct LDKCResult_ChannelAnnouncementDecodeErrorZ ChannelAnnouncement_read(struct LDKu8slice ser);
22402 * Serialize the UnsignedChannelUpdate object into a byte array which can be read by UnsignedChannelUpdate_read
22404 struct LDKCVec_u8Z UnsignedChannelUpdate_write(const struct LDKUnsignedChannelUpdate *NONNULL_PTR obj);
22407 * Read a UnsignedChannelUpdate from a byte array, created by UnsignedChannelUpdate_write
22409 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ UnsignedChannelUpdate_read(struct LDKu8slice ser);
22412 * Serialize the ChannelUpdate object into a byte array which can be read by ChannelUpdate_read
22414 struct LDKCVec_u8Z ChannelUpdate_write(const struct LDKChannelUpdate *NONNULL_PTR obj);
22417 * Read a ChannelUpdate from a byte array, created by ChannelUpdate_write
22419 struct LDKCResult_ChannelUpdateDecodeErrorZ ChannelUpdate_read(struct LDKu8slice ser);
22422 * Serialize the ErrorMessage object into a byte array which can be read by ErrorMessage_read
22424 struct LDKCVec_u8Z ErrorMessage_write(const struct LDKErrorMessage *NONNULL_PTR obj);
22427 * Read a ErrorMessage from a byte array, created by ErrorMessage_write
22429 struct LDKCResult_ErrorMessageDecodeErrorZ ErrorMessage_read(struct LDKu8slice ser);
22432 * Serialize the WarningMessage object into a byte array which can be read by WarningMessage_read
22434 struct LDKCVec_u8Z WarningMessage_write(const struct LDKWarningMessage *NONNULL_PTR obj);
22437 * Read a WarningMessage from a byte array, created by WarningMessage_write
22439 struct LDKCResult_WarningMessageDecodeErrorZ WarningMessage_read(struct LDKu8slice ser);
22442 * Serialize the UnsignedNodeAnnouncement object into a byte array which can be read by UnsignedNodeAnnouncement_read
22444 struct LDKCVec_u8Z UnsignedNodeAnnouncement_write(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR obj);
22447 * Read a UnsignedNodeAnnouncement from a byte array, created by UnsignedNodeAnnouncement_write
22449 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ UnsignedNodeAnnouncement_read(struct LDKu8slice ser);
22452 * Serialize the NodeAnnouncement object into a byte array which can be read by NodeAnnouncement_read
22454 struct LDKCVec_u8Z NodeAnnouncement_write(const struct LDKNodeAnnouncement *NONNULL_PTR obj);
22457 * Read a NodeAnnouncement from a byte array, created by NodeAnnouncement_write
22459 struct LDKCResult_NodeAnnouncementDecodeErrorZ NodeAnnouncement_read(struct LDKu8slice ser);
22462 * Read a QueryShortChannelIds from a byte array, created by QueryShortChannelIds_write
22464 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ QueryShortChannelIds_read(struct LDKu8slice ser);
22467 * Serialize the QueryShortChannelIds object into a byte array which can be read by QueryShortChannelIds_read
22469 struct LDKCVec_u8Z QueryShortChannelIds_write(const struct LDKQueryShortChannelIds *NONNULL_PTR obj);
22472 * Serialize the ReplyShortChannelIdsEnd object into a byte array which can be read by ReplyShortChannelIdsEnd_read
22474 struct LDKCVec_u8Z ReplyShortChannelIdsEnd_write(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR obj);
22477 * Read a ReplyShortChannelIdsEnd from a byte array, created by ReplyShortChannelIdsEnd_write
22479 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ ReplyShortChannelIdsEnd_read(struct LDKu8slice ser);
22482 *\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
22484 MUST_USE_RES uint32_t QueryChannelRange_end_blocknum(const struct LDKQueryChannelRange *NONNULL_PTR this_arg);
22487 * Serialize the QueryChannelRange object into a byte array which can be read by QueryChannelRange_read
22489 struct LDKCVec_u8Z QueryChannelRange_write(const struct LDKQueryChannelRange *NONNULL_PTR obj);
22492 * Read a QueryChannelRange from a byte array, created by QueryChannelRange_write
22494 struct LDKCResult_QueryChannelRangeDecodeErrorZ QueryChannelRange_read(struct LDKu8slice ser);
22497 * Read a ReplyChannelRange from a byte array, created by ReplyChannelRange_write
22499 struct LDKCResult_ReplyChannelRangeDecodeErrorZ ReplyChannelRange_read(struct LDKu8slice ser);
22502 * Serialize the ReplyChannelRange object into a byte array which can be read by ReplyChannelRange_read
22504 struct LDKCVec_u8Z ReplyChannelRange_write(const struct LDKReplyChannelRange *NONNULL_PTR obj);
22507 * Serialize the GossipTimestampFilter object into a byte array which can be read by GossipTimestampFilter_read
22509 struct LDKCVec_u8Z GossipTimestampFilter_write(const struct LDKGossipTimestampFilter *NONNULL_PTR obj);
22512 * Read a GossipTimestampFilter from a byte array, created by GossipTimestampFilter_write
22514 struct LDKCResult_GossipTimestampFilterDecodeErrorZ GossipTimestampFilter_read(struct LDKu8slice ser);
22517 * Calls the free function if one is set
22519 void CustomMessageHandler_free(struct LDKCustomMessageHandler this_ptr);
22522 * Frees any resources used by the IgnoringMessageHandler, if is_owned is set and inner is non-NULL.
22524 void IgnoringMessageHandler_free(struct LDKIgnoringMessageHandler this_obj);
22527 * Constructs a new IgnoringMessageHandler given each field
22529 MUST_USE_RES struct LDKIgnoringMessageHandler IgnoringMessageHandler_new(void);
22532 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
22533 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
22535 struct LDKMessageSendEventsProvider IgnoringMessageHandler_as_MessageSendEventsProvider(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
22538 * Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg.
22539 * This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is
22541 struct LDKRoutingMessageHandler IgnoringMessageHandler_as_RoutingMessageHandler(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
22544 * Constructs a new CustomMessageReader which calls the relevant methods on this_arg.
22545 * This copies the `inner` pointer in this_arg and thus the returned CustomMessageReader must be freed before this_arg is
22547 struct LDKCustomMessageReader IgnoringMessageHandler_as_CustomMessageReader(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
22550 * Constructs a new CustomMessageHandler which calls the relevant methods on this_arg.
22551 * This copies the `inner` pointer in this_arg and thus the returned CustomMessageHandler must be freed before this_arg is
22553 struct LDKCustomMessageHandler IgnoringMessageHandler_as_CustomMessageHandler(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
22556 * Frees any resources used by the ErroringMessageHandler, if is_owned is set and inner is non-NULL.
22558 void ErroringMessageHandler_free(struct LDKErroringMessageHandler this_obj);
22561 * Constructs a new ErroringMessageHandler
22563 MUST_USE_RES struct LDKErroringMessageHandler ErroringMessageHandler_new(void);
22566 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
22567 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
22569 struct LDKMessageSendEventsProvider ErroringMessageHandler_as_MessageSendEventsProvider(const struct LDKErroringMessageHandler *NONNULL_PTR this_arg);
22572 * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
22573 * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
22575 struct LDKChannelMessageHandler ErroringMessageHandler_as_ChannelMessageHandler(const struct LDKErroringMessageHandler *NONNULL_PTR this_arg);
22578 * Frees any resources used by the MessageHandler, if is_owned is set and inner is non-NULL.
22580 void MessageHandler_free(struct LDKMessageHandler this_obj);
22583 * A message handler which handles messages specific to channels. Usually this is just a
22584 * [`ChannelManager`] object or an [`ErroringMessageHandler`].
22586 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
22588 const struct LDKChannelMessageHandler *MessageHandler_get_chan_handler(const struct LDKMessageHandler *NONNULL_PTR this_ptr);
22591 * A message handler which handles messages specific to channels. Usually this is just a
22592 * [`ChannelManager`] object or an [`ErroringMessageHandler`].
22594 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
22596 void MessageHandler_set_chan_handler(struct LDKMessageHandler *NONNULL_PTR this_ptr, struct LDKChannelMessageHandler val);
22599 * A message handler which handles messages updating our knowledge of the network channel
22600 * graph. Usually this is just a [`NetGraphMsgHandler`] object or an
22601 * [`IgnoringMessageHandler`].
22603 * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
22605 const struct LDKRoutingMessageHandler *MessageHandler_get_route_handler(const struct LDKMessageHandler *NONNULL_PTR this_ptr);
22608 * A message handler which handles messages updating our knowledge of the network channel
22609 * graph. Usually this is just a [`NetGraphMsgHandler`] object or an
22610 * [`IgnoringMessageHandler`].
22612 * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
22614 void MessageHandler_set_route_handler(struct LDKMessageHandler *NONNULL_PTR this_ptr, struct LDKRoutingMessageHandler val);
22617 * Constructs a new MessageHandler given each field
22619 MUST_USE_RES struct LDKMessageHandler MessageHandler_new(struct LDKChannelMessageHandler chan_handler_arg, struct LDKRoutingMessageHandler route_handler_arg);
22622 * Creates a copy of a SocketDescriptor
22624 struct LDKSocketDescriptor SocketDescriptor_clone(const struct LDKSocketDescriptor *NONNULL_PTR orig);
22627 * Calls the free function if one is set
22629 void SocketDescriptor_free(struct LDKSocketDescriptor this_ptr);
22632 * Frees any resources used by the PeerHandleError, if is_owned is set and inner is non-NULL.
22634 void PeerHandleError_free(struct LDKPeerHandleError this_obj);
22637 * Used to indicate that we probably can't make any future connections to this peer, implying
22638 * we should go ahead and force-close any channels we have with it.
22640 bool PeerHandleError_get_no_connection_possible(const struct LDKPeerHandleError *NONNULL_PTR this_ptr);
22643 * Used to indicate that we probably can't make any future connections to this peer, implying
22644 * we should go ahead and force-close any channels we have with it.
22646 void PeerHandleError_set_no_connection_possible(struct LDKPeerHandleError *NONNULL_PTR this_ptr, bool val);
22649 * Constructs a new PeerHandleError given each field
22651 MUST_USE_RES struct LDKPeerHandleError PeerHandleError_new(bool no_connection_possible_arg);
22654 * Creates a copy of the PeerHandleError
22656 struct LDKPeerHandleError PeerHandleError_clone(const struct LDKPeerHandleError *NONNULL_PTR orig);
22659 * Frees any resources used by the PeerManager, if is_owned is set and inner is non-NULL.
22661 void PeerManager_free(struct LDKPeerManager this_obj);
22664 * Constructs a new PeerManager with the given message handlers and node_id secret key
22665 * ephemeral_random_data is used to derive per-connection ephemeral keys and must be
22666 * cryptographically secure random bytes.
22668 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);
22671 * Get the list of node ids for peers which have completed the initial handshake.
22673 * For outbound connections, this will be the same as the their_node_id parameter passed in to
22674 * new_outbound_connection, however entries will only appear once the initial handshake has
22675 * completed and we are sure the remote peer has the private key for the given node_id.
22677 MUST_USE_RES struct LDKCVec_PublicKeyZ PeerManager_get_peer_node_ids(const struct LDKPeerManager *NONNULL_PTR this_arg);
22680 * Indicates a new outbound connection has been established to a node with the given node_id
22681 * and an optional remote network address.
22683 * The remote network address adds the option to report a remote IP address back to a connecting
22684 * peer using the init message.
22685 * The user should pass the remote network address of the host they are connected to.
22687 * Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
22688 * descriptor but must disconnect the connection immediately.
22690 * Returns a small number of bytes to send to the remote node (currently always 50).
22692 * Panics if descriptor is duplicative with some other descriptor which has not yet been
22693 * [`socket_disconnected()`].
22695 * [`socket_disconnected()`]: PeerManager::socket_disconnected
22697 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, struct LDKCOption_NetAddressZ remote_network_address);
22700 * Indicates a new inbound connection has been established to a node with an optional remote
22703 * The remote network address adds the option to report a remote IP address back to a connecting
22704 * peer using the init message.
22705 * The user should pass the remote network address of the host they are connected to.
22707 * May refuse the connection by returning an Err, but will never write bytes to the remote end
22708 * (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
22709 * call socket_disconnected for the new descriptor but must disconnect the connection
22712 * Panics if descriptor is duplicative with some other descriptor which has not yet been
22713 * [`socket_disconnected()`].
22715 * [`socket_disconnected()`]: PeerManager::socket_disconnected
22717 MUST_USE_RES struct LDKCResult_NonePeerHandleErrorZ PeerManager_new_inbound_connection(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKSocketDescriptor descriptor, struct LDKCOption_NetAddressZ remote_network_address);
22720 * Indicates that there is room to write data to the given socket descriptor.
22722 * May return an Err to indicate that the connection should be closed.
22724 * May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
22725 * returning. Thus, be very careful with reentrancy issues! The invariants around calling
22726 * [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
22727 * ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
22730 * [`send_data`]: SocketDescriptor::send_data
22731 * [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
22733 MUST_USE_RES struct LDKCResult_NonePeerHandleErrorZ PeerManager_write_buffer_space_avail(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKSocketDescriptor *NONNULL_PTR descriptor);
22736 * Indicates that data was read from the given socket descriptor.
22738 * May return an Err to indicate that the connection should be closed.
22740 * Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
22741 * Thus, however, you should call [`process_events`] after any `read_event` to generate
22742 * [`send_data`] calls to handle responses.
22744 * If `Ok(true)` is returned, further read_events should not be triggered until a
22745 * [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
22748 * [`send_data`]: SocketDescriptor::send_data
22749 * [`process_events`]: PeerManager::process_events
22751 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);
22754 * Checks for any events generated by our handlers and processes them. Includes sending most
22755 * response messages as well as messages generated by calls to handler functions directly (eg
22756 * functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
22758 * May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
22761 * You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
22762 * or one of the other clients provided in our language bindings.
22764 * [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
22765 * [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
22766 * [`send_data`]: SocketDescriptor::send_data
22768 void PeerManager_process_events(const struct LDKPeerManager *NONNULL_PTR this_arg);
22771 * Indicates that the given socket descriptor's connection is now closed.
22773 void PeerManager_socket_disconnected(const struct LDKPeerManager *NONNULL_PTR this_arg, const struct LDKSocketDescriptor *NONNULL_PTR descriptor);
22776 * Disconnect a peer given its node id.
22778 * Set `no_connection_possible` to true to prevent any further connection with this peer,
22779 * force-closing any channels we have with it.
22781 * If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
22782 * peer. Thus, be very careful about reentrancy issues.
22784 * [`disconnect_socket`]: SocketDescriptor::disconnect_socket
22786 void PeerManager_disconnect_by_node_id(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKPublicKey node_id, bool no_connection_possible);
22789 * Disconnects all currently-connected peers. This is useful on platforms where there may be
22790 * an indication that TCP sockets have stalled even if we weren't around to time them out
22791 * using regular ping/pongs.
22793 void PeerManager_disconnect_all_peers(const struct LDKPeerManager *NONNULL_PTR this_arg);
22796 * Send pings to each peer and disconnect those which did not respond to the last round of
22799 * This may be called on any timescale you want, however, roughly once every ten seconds is
22800 * preferred. The call rate determines both how often we send a ping to our peers and how much
22801 * time they have to respond before we disconnect them.
22803 * May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
22806 * [`send_data`]: SocketDescriptor::send_data
22808 void PeerManager_timer_tick_occurred(const struct LDKPeerManager *NONNULL_PTR this_arg);
22811 * Gets the weight for an HTLC-Success transaction.
22813 uint64_t htlc_success_tx_weight(bool opt_anchors);
22816 * Gets the weight for an HTLC-Timeout transaction.
22818 uint64_t htlc_timeout_tx_weight(bool opt_anchors);
22821 * Build the commitment secret from the seed and the commitment number
22823 struct LDKThirtyTwoBytes build_commitment_secret(const uint8_t (*commitment_seed)[32], uint64_t idx);
22826 * Build a closing transaction
22828 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);
22831 * Frees any resources used by the CounterpartyCommitmentSecrets, if is_owned is set and inner is non-NULL.
22833 void CounterpartyCommitmentSecrets_free(struct LDKCounterpartyCommitmentSecrets this_obj);
22836 * Creates a copy of the CounterpartyCommitmentSecrets
22838 struct LDKCounterpartyCommitmentSecrets CounterpartyCommitmentSecrets_clone(const struct LDKCounterpartyCommitmentSecrets *NONNULL_PTR orig);
22841 * Creates a new empty `CounterpartyCommitmentSecrets` structure.
22843 MUST_USE_RES struct LDKCounterpartyCommitmentSecrets CounterpartyCommitmentSecrets_new(void);
22846 * Returns the minimum index of all stored secrets. Note that indexes start
22847 * at 1 << 48 and get decremented by one for each new secret.
22849 MUST_USE_RES uint64_t CounterpartyCommitmentSecrets_get_min_seen_secret(const struct LDKCounterpartyCommitmentSecrets *NONNULL_PTR this_arg);
22852 * Inserts the `secret` at `idx`. Returns `Ok(())` if the secret
22853 * was generated in accordance with BOLT 3 and is consistent with previous secrets.
22855 MUST_USE_RES struct LDKCResult_NoneNoneZ CounterpartyCommitmentSecrets_provide_secret(struct LDKCounterpartyCommitmentSecrets *NONNULL_PTR this_arg, uint64_t idx, struct LDKThirtyTwoBytes secret);
22858 * Returns the secret at `idx`.
22859 * Returns `None` if `idx` is < [`CounterpartyCommitmentSecrets::get_min_seen_secret`].
22861 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
22863 MUST_USE_RES struct LDKThirtyTwoBytes CounterpartyCommitmentSecrets_get_secret(const struct LDKCounterpartyCommitmentSecrets *NONNULL_PTR this_arg, uint64_t idx);
22866 * Serialize the CounterpartyCommitmentSecrets object into a byte array which can be read by CounterpartyCommitmentSecrets_read
22868 struct LDKCVec_u8Z CounterpartyCommitmentSecrets_write(const struct LDKCounterpartyCommitmentSecrets *NONNULL_PTR obj);
22871 * Read a CounterpartyCommitmentSecrets from a byte array, created by CounterpartyCommitmentSecrets_write
22873 struct LDKCResult_CounterpartyCommitmentSecretsDecodeErrorZ CounterpartyCommitmentSecrets_read(struct LDKu8slice ser);
22876 * Derives a per-commitment-transaction private key (eg an htlc key or delayed_payment key)
22877 * from the base secret and the per_commitment_point.
22879 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
22880 * generated (ie our own).
22882 struct LDKCResult_SecretKeyErrorZ derive_private_key(struct LDKPublicKey per_commitment_point, const uint8_t (*base_secret)[32]);
22885 * Derives a per-commitment-transaction public key (eg an htlc key or a delayed_payment key)
22886 * from the base point and the per_commitment_key. This is the public equivalent of
22887 * derive_private_key - using only public keys to derive a public key instead of private keys.
22889 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
22890 * generated (ie our own).
22892 struct LDKCResult_PublicKeyErrorZ derive_public_key(struct LDKPublicKey per_commitment_point, struct LDKPublicKey base_point);
22895 * Derives a per-commitment-transaction revocation key from its constituent parts.
22897 * Only the cheating participant owns a valid witness to propagate a revoked
22898 * commitment transaction, thus per_commitment_secret always come from cheater
22899 * and revocation_base_secret always come from punisher, which is the broadcaster
22900 * of the transaction spending with this key knowledge.
22902 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
22903 * generated (ie our own).
22905 struct LDKCResult_SecretKeyErrorZ derive_private_revocation_key(const uint8_t (*per_commitment_secret)[32], const uint8_t (*countersignatory_revocation_base_secret)[32]);
22908 * Derives a per-commitment-transaction revocation public key from its constituent parts. This is
22909 * the public equivalend of derive_private_revocation_key - using only public keys to derive a
22910 * public key instead of private keys.
22912 * Only the cheating participant owns a valid witness to propagate a revoked
22913 * commitment transaction, thus per_commitment_point always come from cheater
22914 * and revocation_base_point always come from punisher, which is the broadcaster
22915 * of the transaction spending with this key knowledge.
22917 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
22918 * generated (ie our own).
22920 struct LDKCResult_PublicKeyErrorZ derive_public_revocation_key(struct LDKPublicKey per_commitment_point, struct LDKPublicKey countersignatory_revocation_base_point);
22923 * Frees any resources used by the TxCreationKeys, if is_owned is set and inner is non-NULL.
22925 void TxCreationKeys_free(struct LDKTxCreationKeys this_obj);
22928 * The broadcaster's per-commitment public key which was used to derive the other keys.
22930 struct LDKPublicKey TxCreationKeys_get_per_commitment_point(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
22933 * The broadcaster's per-commitment public key which was used to derive the other keys.
22935 void TxCreationKeys_set_per_commitment_point(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
22938 * The revocation key which is used to allow the broadcaster of the commitment
22939 * transaction to provide their counterparty the ability to punish them if they broadcast
22942 struct LDKPublicKey TxCreationKeys_get_revocation_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
22945 * The revocation key which is used to allow the broadcaster of the commitment
22946 * transaction to provide their counterparty the ability to punish them if they broadcast
22949 void TxCreationKeys_set_revocation_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
22952 * Broadcaster's HTLC Key
22954 struct LDKPublicKey TxCreationKeys_get_broadcaster_htlc_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
22957 * Broadcaster's HTLC Key
22959 void TxCreationKeys_set_broadcaster_htlc_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
22962 * Countersignatory's HTLC Key
22964 struct LDKPublicKey TxCreationKeys_get_countersignatory_htlc_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
22967 * Countersignatory's HTLC Key
22969 void TxCreationKeys_set_countersignatory_htlc_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
22972 * Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
22974 struct LDKPublicKey TxCreationKeys_get_broadcaster_delayed_payment_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
22977 * Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
22979 void TxCreationKeys_set_broadcaster_delayed_payment_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
22982 * Constructs a new TxCreationKeys given each field
22984 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);
22987 * Creates a copy of the TxCreationKeys
22989 struct LDKTxCreationKeys TxCreationKeys_clone(const struct LDKTxCreationKeys *NONNULL_PTR orig);
22992 * Serialize the TxCreationKeys object into a byte array which can be read by TxCreationKeys_read
22994 struct LDKCVec_u8Z TxCreationKeys_write(const struct LDKTxCreationKeys *NONNULL_PTR obj);
22997 * Read a TxCreationKeys from a byte array, created by TxCreationKeys_write
22999 struct LDKCResult_TxCreationKeysDecodeErrorZ TxCreationKeys_read(struct LDKu8slice ser);
23002 * Frees any resources used by the ChannelPublicKeys, if is_owned is set and inner is non-NULL.
23004 void ChannelPublicKeys_free(struct LDKChannelPublicKeys this_obj);
23007 * The public key which is used to sign all commitment transactions, as it appears in the
23008 * on-chain channel lock-in 2-of-2 multisig output.
23010 struct LDKPublicKey ChannelPublicKeys_get_funding_pubkey(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
23013 * The public key which is used to sign all commitment transactions, as it appears in the
23014 * on-chain channel lock-in 2-of-2 multisig output.
23016 void ChannelPublicKeys_set_funding_pubkey(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
23019 * The base point which is used (with derive_public_revocation_key) to derive per-commitment
23020 * revocation keys. This is combined with the per-commitment-secret generated by the
23021 * counterparty to create a secret which the counterparty can reveal to revoke previous
23024 struct LDKPublicKey ChannelPublicKeys_get_revocation_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
23027 * The base point which is used (with derive_public_revocation_key) to derive per-commitment
23028 * revocation keys. This is combined with the per-commitment-secret generated by the
23029 * counterparty to create a secret which the counterparty can reveal to revoke previous
23032 void ChannelPublicKeys_set_revocation_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
23035 * The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
23036 * spendable primary channel balance on the broadcaster's commitment transaction. This key is
23037 * static across every commitment transaction.
23039 struct LDKPublicKey ChannelPublicKeys_get_payment_point(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
23042 * The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
23043 * spendable primary channel balance on the broadcaster's commitment transaction. This key is
23044 * static across every commitment transaction.
23046 void ChannelPublicKeys_set_payment_point(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
23049 * The base point which is used (with derive_public_key) to derive a per-commitment payment
23050 * public key which receives non-HTLC-encumbered funds which are only available for spending
23051 * after some delay (or can be claimed via the revocation path).
23053 struct LDKPublicKey ChannelPublicKeys_get_delayed_payment_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
23056 * The base point which is used (with derive_public_key) to derive a per-commitment payment
23057 * public key which receives non-HTLC-encumbered funds which are only available for spending
23058 * after some delay (or can be claimed via the revocation path).
23060 void ChannelPublicKeys_set_delayed_payment_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
23063 * The base point which is used (with derive_public_key) to derive a per-commitment public key
23064 * which is used to encumber HTLC-in-flight outputs.
23066 struct LDKPublicKey ChannelPublicKeys_get_htlc_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
23069 * The base point which is used (with derive_public_key) to derive a per-commitment public key
23070 * which is used to encumber HTLC-in-flight outputs.
23072 void ChannelPublicKeys_set_htlc_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
23075 * Constructs a new ChannelPublicKeys given each field
23077 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);
23080 * Creates a copy of the ChannelPublicKeys
23082 struct LDKChannelPublicKeys ChannelPublicKeys_clone(const struct LDKChannelPublicKeys *NONNULL_PTR orig);
23085 * Serialize the ChannelPublicKeys object into a byte array which can be read by ChannelPublicKeys_read
23087 struct LDKCVec_u8Z ChannelPublicKeys_write(const struct LDKChannelPublicKeys *NONNULL_PTR obj);
23090 * Read a ChannelPublicKeys from a byte array, created by ChannelPublicKeys_write
23092 struct LDKCResult_ChannelPublicKeysDecodeErrorZ ChannelPublicKeys_read(struct LDKu8slice ser);
23095 * Create per-state keys from channel base points and the per-commitment point.
23096 * Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
23098 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);
23101 * Generate per-state keys from channel static keys.
23102 * Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
23104 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);
23107 * A script either spendable by the revocation
23108 * key or the broadcaster_delayed_payment_key and satisfying the relative-locktime OP_CSV constrain.
23109 * Encumbering a `to_holder` output on a commitment transaction or 2nd-stage HTLC transactions.
23111 struct LDKCVec_u8Z get_revokeable_redeemscript(struct LDKPublicKey revocation_key, uint16_t contest_delay, struct LDKPublicKey broadcaster_delayed_payment_key);
23114 * Frees any resources used by the HTLCOutputInCommitment, if is_owned is set and inner is non-NULL.
23116 void HTLCOutputInCommitment_free(struct LDKHTLCOutputInCommitment this_obj);
23119 * Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
23120 * Note that this is not the same as whether it is ountbound *from us*. To determine that you
23121 * need to compare this value to whether the commitment transaction in question is that of
23122 * the counterparty or our own.
23124 bool HTLCOutputInCommitment_get_offered(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
23127 * Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
23128 * Note that this is not the same as whether it is ountbound *from us*. To determine that you
23129 * need to compare this value to whether the commitment transaction in question is that of
23130 * the counterparty or our own.
23132 void HTLCOutputInCommitment_set_offered(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, bool val);
23135 * The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
23136 * this divided by 1000.
23138 uint64_t HTLCOutputInCommitment_get_amount_msat(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
23141 * The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
23142 * this divided by 1000.
23144 void HTLCOutputInCommitment_set_amount_msat(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, uint64_t val);
23147 * The CLTV lock-time at which this HTLC expires.
23149 uint32_t HTLCOutputInCommitment_get_cltv_expiry(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
23152 * The CLTV lock-time at which this HTLC expires.
23154 void HTLCOutputInCommitment_set_cltv_expiry(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, uint32_t val);
23157 * The hash of the preimage which unlocks this HTLC.
23159 const uint8_t (*HTLCOutputInCommitment_get_payment_hash(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr))[32];
23162 * The hash of the preimage which unlocks this HTLC.
23164 void HTLCOutputInCommitment_set_payment_hash(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
23167 * The position within the commitment transactions' outputs. This may be None if the value is
23168 * below the dust limit (in which case no output appears in the commitment transaction and the
23169 * value is spent to additional transaction fees).
23171 struct LDKCOption_u32Z HTLCOutputInCommitment_get_transaction_output_index(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
23174 * The position within the commitment transactions' outputs. This may be None if the value is
23175 * below the dust limit (in which case no output appears in the commitment transaction and the
23176 * value is spent to additional transaction fees).
23178 void HTLCOutputInCommitment_set_transaction_output_index(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, struct LDKCOption_u32Z val);
23181 * Constructs a new HTLCOutputInCommitment given each field
23183 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);
23186 * Creates a copy of the HTLCOutputInCommitment
23188 struct LDKHTLCOutputInCommitment HTLCOutputInCommitment_clone(const struct LDKHTLCOutputInCommitment *NONNULL_PTR orig);
23191 * Serialize the HTLCOutputInCommitment object into a byte array which can be read by HTLCOutputInCommitment_read
23193 struct LDKCVec_u8Z HTLCOutputInCommitment_write(const struct LDKHTLCOutputInCommitment *NONNULL_PTR obj);
23196 * Read a HTLCOutputInCommitment from a byte array, created by HTLCOutputInCommitment_write
23198 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ HTLCOutputInCommitment_read(struct LDKu8slice ser);
23201 * Gets the witness redeemscript for an HTLC output in a commitment transaction. Note that htlc
23202 * does not need to have its previous_output_index filled.
23204 struct LDKCVec_u8Z get_htlc_redeemscript(const struct LDKHTLCOutputInCommitment *NONNULL_PTR htlc, bool opt_anchors, const struct LDKTxCreationKeys *NONNULL_PTR keys);
23207 * Gets the redeemscript for a funding output from the two funding public keys.
23208 * Note that the order of funding public keys does not matter.
23210 struct LDKCVec_u8Z make_funding_redeemscript(struct LDKPublicKey broadcaster, struct LDKPublicKey countersignatory);
23213 * Builds an unsigned HTLC-Success or HTLC-Timeout transaction from the given channel and HTLC
23214 * parameters. This is used by [`TrustedCommitmentTransaction::get_htlc_sigs`] to fetch the
23215 * transaction which needs signing, and can be used to construct an HTLC transaction which is
23216 * broadcastable given a counterparty HTLC signature.
23218 * Panics if htlc.transaction_output_index.is_none() (as such HTLCs do not appear in the
23219 * commitment transaction).
23221 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);
23224 * Gets the witnessScript for an anchor output from the funding public key.
23225 * The witness in the spending input must be:
23226 * <BIP 143 funding_signature>
23227 * After 16 blocks of confirmation, an alternative satisfying witness could be:
23229 * (empty vector required to satisfy compliance with MINIMALIF-standard rule)
23231 struct LDKCVec_u8Z get_anchor_redeemscript(struct LDKPublicKey funding_pubkey);
23234 * Frees any resources used by the ChannelTransactionParameters, if is_owned is set and inner is non-NULL.
23236 void ChannelTransactionParameters_free(struct LDKChannelTransactionParameters this_obj);
23239 * Holder public keys
23241 struct LDKChannelPublicKeys ChannelTransactionParameters_get_holder_pubkeys(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
23244 * Holder public keys
23246 void ChannelTransactionParameters_set_holder_pubkeys(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKChannelPublicKeys val);
23249 * The contest delay selected by the holder, which applies to counterparty-broadcast transactions
23251 uint16_t ChannelTransactionParameters_get_holder_selected_contest_delay(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
23254 * The contest delay selected by the holder, which applies to counterparty-broadcast transactions
23256 void ChannelTransactionParameters_set_holder_selected_contest_delay(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, uint16_t val);
23259 * Whether the holder is the initiator of this channel.
23260 * This is an input to the commitment number obscure factor computation.
23262 bool ChannelTransactionParameters_get_is_outbound_from_holder(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
23265 * Whether the holder is the initiator of this channel.
23266 * This is an input to the commitment number obscure factor computation.
23268 void ChannelTransactionParameters_set_is_outbound_from_holder(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, bool val);
23271 * The late-bound counterparty channel transaction parameters.
23272 * These parameters are populated at the point in the protocol where the counterparty provides them.
23274 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
23276 struct LDKCounterpartyChannelTransactionParameters ChannelTransactionParameters_get_counterparty_parameters(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
23279 * The late-bound counterparty channel transaction parameters.
23280 * These parameters are populated at the point in the protocol where the counterparty provides them.
23282 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
23284 void ChannelTransactionParameters_set_counterparty_parameters(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKCounterpartyChannelTransactionParameters val);
23287 * The late-bound funding outpoint
23289 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
23291 struct LDKOutPoint ChannelTransactionParameters_get_funding_outpoint(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
23294 * The late-bound funding outpoint
23296 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
23298 void ChannelTransactionParameters_set_funding_outpoint(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKOutPoint val);
23301 * Are anchors used for this channel. Boolean is serialization backwards-compatible
23303 enum LDKCOption_NoneZ ChannelTransactionParameters_get_opt_anchors(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
23306 * Are anchors used for this channel. Boolean is serialization backwards-compatible
23308 void ChannelTransactionParameters_set_opt_anchors(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, enum LDKCOption_NoneZ val);
23311 * Constructs a new ChannelTransactionParameters given each field
23313 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);
23316 * Creates a copy of the ChannelTransactionParameters
23318 struct LDKChannelTransactionParameters ChannelTransactionParameters_clone(const struct LDKChannelTransactionParameters *NONNULL_PTR orig);
23321 * Frees any resources used by the CounterpartyChannelTransactionParameters, if is_owned is set and inner is non-NULL.
23323 void CounterpartyChannelTransactionParameters_free(struct LDKCounterpartyChannelTransactionParameters this_obj);
23326 * Counter-party public keys
23328 struct LDKChannelPublicKeys CounterpartyChannelTransactionParameters_get_pubkeys(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr);
23331 * Counter-party public keys
23333 void CounterpartyChannelTransactionParameters_set_pubkeys(struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKChannelPublicKeys val);
23336 * The contest delay selected by the counterparty, which applies to holder-broadcast transactions
23338 uint16_t CounterpartyChannelTransactionParameters_get_selected_contest_delay(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr);
23341 * The contest delay selected by the counterparty, which applies to holder-broadcast transactions
23343 void CounterpartyChannelTransactionParameters_set_selected_contest_delay(struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr, uint16_t val);
23346 * Constructs a new CounterpartyChannelTransactionParameters given each field
23348 MUST_USE_RES struct LDKCounterpartyChannelTransactionParameters CounterpartyChannelTransactionParameters_new(struct LDKChannelPublicKeys pubkeys_arg, uint16_t selected_contest_delay_arg);
23351 * Creates a copy of the CounterpartyChannelTransactionParameters
23353 struct LDKCounterpartyChannelTransactionParameters CounterpartyChannelTransactionParameters_clone(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR orig);
23356 * Whether the late bound parameters are populated.
23358 MUST_USE_RES bool ChannelTransactionParameters_is_populated(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
23361 * Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
23362 * given that the holder is the broadcaster.
23364 * self.is_populated() must be true before calling this function.
23366 MUST_USE_RES struct LDKDirectedChannelTransactionParameters ChannelTransactionParameters_as_holder_broadcastable(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
23369 * Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
23370 * given that the counterparty is the broadcaster.
23372 * self.is_populated() must be true before calling this function.
23374 MUST_USE_RES struct LDKDirectedChannelTransactionParameters ChannelTransactionParameters_as_counterparty_broadcastable(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
23377 * Serialize the CounterpartyChannelTransactionParameters object into a byte array which can be read by CounterpartyChannelTransactionParameters_read
23379 struct LDKCVec_u8Z CounterpartyChannelTransactionParameters_write(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR obj);
23382 * Read a CounterpartyChannelTransactionParameters from a byte array, created by CounterpartyChannelTransactionParameters_write
23384 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CounterpartyChannelTransactionParameters_read(struct LDKu8slice ser);
23387 * Serialize the ChannelTransactionParameters object into a byte array which can be read by ChannelTransactionParameters_read
23389 struct LDKCVec_u8Z ChannelTransactionParameters_write(const struct LDKChannelTransactionParameters *NONNULL_PTR obj);
23392 * Read a ChannelTransactionParameters from a byte array, created by ChannelTransactionParameters_write
23394 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ ChannelTransactionParameters_read(struct LDKu8slice ser);
23397 * Frees any resources used by the DirectedChannelTransactionParameters, if is_owned is set and inner is non-NULL.
23399 void DirectedChannelTransactionParameters_free(struct LDKDirectedChannelTransactionParameters this_obj);
23402 * Get the channel pubkeys for the broadcaster
23404 MUST_USE_RES struct LDKChannelPublicKeys DirectedChannelTransactionParameters_broadcaster_pubkeys(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
23407 * Get the channel pubkeys for the countersignatory
23409 MUST_USE_RES struct LDKChannelPublicKeys DirectedChannelTransactionParameters_countersignatory_pubkeys(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
23412 * Get the contest delay applicable to the transactions.
23413 * Note that the contest delay was selected by the countersignatory.
23415 MUST_USE_RES uint16_t DirectedChannelTransactionParameters_contest_delay(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
23418 * Whether the channel is outbound from the broadcaster.
23420 * The boolean representing the side that initiated the channel is
23421 * an input to the commitment number obscure factor computation.
23423 MUST_USE_RES bool DirectedChannelTransactionParameters_is_outbound(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
23426 * The funding outpoint
23428 MUST_USE_RES struct LDKOutPoint DirectedChannelTransactionParameters_funding_outpoint(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
23431 * Whether to use anchors for this channel
23433 MUST_USE_RES bool DirectedChannelTransactionParameters_opt_anchors(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
23436 * Frees any resources used by the HolderCommitmentTransaction, if is_owned is set and inner is non-NULL.
23438 void HolderCommitmentTransaction_free(struct LDKHolderCommitmentTransaction this_obj);
23441 * Our counterparty's signature for the transaction
23443 struct LDKSignature HolderCommitmentTransaction_get_counterparty_sig(const struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr);
23446 * Our counterparty's signature for the transaction
23448 void HolderCommitmentTransaction_set_counterparty_sig(struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKSignature val);
23451 * All non-dust counterparty HTLC signatures, in the order they appear in the transaction
23453 void HolderCommitmentTransaction_set_counterparty_htlc_sigs(struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKCVec_SignatureZ val);
23456 * Creates a copy of the HolderCommitmentTransaction
23458 struct LDKHolderCommitmentTransaction HolderCommitmentTransaction_clone(const struct LDKHolderCommitmentTransaction *NONNULL_PTR orig);
23461 * Serialize the HolderCommitmentTransaction object into a byte array which can be read by HolderCommitmentTransaction_read
23463 struct LDKCVec_u8Z HolderCommitmentTransaction_write(const struct LDKHolderCommitmentTransaction *NONNULL_PTR obj);
23466 * Read a HolderCommitmentTransaction from a byte array, created by HolderCommitmentTransaction_write
23468 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ HolderCommitmentTransaction_read(struct LDKu8slice ser);
23471 * Create a new holder transaction with the given counterparty signatures.
23472 * The funding keys are used to figure out which signature should go first when building the transaction for broadcast.
23474 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);
23477 * Frees any resources used by the BuiltCommitmentTransaction, if is_owned is set and inner is non-NULL.
23479 void BuiltCommitmentTransaction_free(struct LDKBuiltCommitmentTransaction this_obj);
23482 * The commitment transaction
23484 struct LDKTransaction BuiltCommitmentTransaction_get_transaction(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr);
23487 * The commitment transaction
23489 void BuiltCommitmentTransaction_set_transaction(struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKTransaction val);
23492 * The txid for the commitment transaction.
23494 * This is provided as a performance optimization, instead of calling transaction.txid()
23497 const uint8_t (*BuiltCommitmentTransaction_get_txid(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr))[32];
23500 * The txid for the commitment transaction.
23502 * This is provided as a performance optimization, instead of calling transaction.txid()
23505 void BuiltCommitmentTransaction_set_txid(struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
23508 * Constructs a new BuiltCommitmentTransaction given each field
23510 MUST_USE_RES struct LDKBuiltCommitmentTransaction BuiltCommitmentTransaction_new(struct LDKTransaction transaction_arg, struct LDKThirtyTwoBytes txid_arg);
23513 * Creates a copy of the BuiltCommitmentTransaction
23515 struct LDKBuiltCommitmentTransaction BuiltCommitmentTransaction_clone(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR orig);
23518 * Serialize the BuiltCommitmentTransaction object into a byte array which can be read by BuiltCommitmentTransaction_read
23520 struct LDKCVec_u8Z BuiltCommitmentTransaction_write(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR obj);
23523 * Read a BuiltCommitmentTransaction from a byte array, created by BuiltCommitmentTransaction_write
23525 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ BuiltCommitmentTransaction_read(struct LDKu8slice ser);
23528 * Get the SIGHASH_ALL sighash value of the transaction.
23530 * This can be used to verify a signature.
23532 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);
23535 * Sign a transaction, either because we are counter-signing the counterparty's transaction or
23536 * because we are about to broadcast a holder transaction.
23538 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);
23541 * Frees any resources used by the ClosingTransaction, if is_owned is set and inner is non-NULL.
23543 void ClosingTransaction_free(struct LDKClosingTransaction this_obj);
23546 * Creates a copy of the ClosingTransaction
23548 struct LDKClosingTransaction ClosingTransaction_clone(const struct LDKClosingTransaction *NONNULL_PTR orig);
23551 * Checks if two ClosingTransactions contain equal inner contents.
23553 uint64_t ClosingTransaction_hash(const struct LDKClosingTransaction *NONNULL_PTR o);
23556 * Construct an object of the class
23558 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);
23561 * Trust our pre-built transaction.
23563 * Applies a wrapper which allows access to the transaction.
23565 * This should only be used if you fully trust the builder of this object. It should not
23566 * be used by an external signer - instead use the verify function.
23568 MUST_USE_RES struct LDKTrustedClosingTransaction ClosingTransaction_trust(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
23571 * Verify our pre-built transaction.
23573 * Applies a wrapper which allows access to the transaction.
23575 * An external validating signer must call this method before signing
23576 * or using the built transaction.
23578 MUST_USE_RES struct LDKCResult_TrustedClosingTransactionNoneZ ClosingTransaction_verify(const struct LDKClosingTransaction *NONNULL_PTR this_arg, struct LDKOutPoint funding_outpoint);
23581 * The value to be sent to the holder, or zero if the output will be omitted
23583 MUST_USE_RES uint64_t ClosingTransaction_to_holder_value_sat(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
23586 * The value to be sent to the counterparty, or zero if the output will be omitted
23588 MUST_USE_RES uint64_t ClosingTransaction_to_counterparty_value_sat(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
23591 * The destination of the holder's output
23593 MUST_USE_RES struct LDKu8slice ClosingTransaction_to_holder_script(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
23596 * The destination of the counterparty's output
23598 MUST_USE_RES struct LDKu8slice ClosingTransaction_to_counterparty_script(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
23601 * Frees any resources used by the TrustedClosingTransaction, if is_owned is set and inner is non-NULL.
23603 void TrustedClosingTransaction_free(struct LDKTrustedClosingTransaction this_obj);
23606 * The pre-built Bitcoin commitment transaction
23608 MUST_USE_RES struct LDKTransaction TrustedClosingTransaction_built_transaction(const struct LDKTrustedClosingTransaction *NONNULL_PTR this_arg);
23611 * Get the SIGHASH_ALL sighash value of the transaction.
23613 * This can be used to verify a signature.
23615 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);
23618 * Sign a transaction, either because we are counter-signing the counterparty's transaction or
23619 * because we are about to broadcast a holder transaction.
23621 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);
23624 * Frees any resources used by the CommitmentTransaction, if is_owned is set and inner is non-NULL.
23626 void CommitmentTransaction_free(struct LDKCommitmentTransaction this_obj);
23629 * Creates a copy of the CommitmentTransaction
23631 struct LDKCommitmentTransaction CommitmentTransaction_clone(const struct LDKCommitmentTransaction *NONNULL_PTR orig);
23634 * Serialize the CommitmentTransaction object into a byte array which can be read by CommitmentTransaction_read
23636 struct LDKCVec_u8Z CommitmentTransaction_write(const struct LDKCommitmentTransaction *NONNULL_PTR obj);
23639 * Read a CommitmentTransaction from a byte array, created by CommitmentTransaction_write
23641 struct LDKCResult_CommitmentTransactionDecodeErrorZ CommitmentTransaction_read(struct LDKu8slice ser);
23644 * The backwards-counting commitment number
23646 MUST_USE_RES uint64_t CommitmentTransaction_commitment_number(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
23649 * The value to be sent to the broadcaster
23651 MUST_USE_RES uint64_t CommitmentTransaction_to_broadcaster_value_sat(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
23654 * The value to be sent to the counterparty
23656 MUST_USE_RES uint64_t CommitmentTransaction_to_countersignatory_value_sat(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
23659 * The feerate paid per 1000-weight-unit in this commitment transaction.
23661 MUST_USE_RES uint32_t CommitmentTransaction_feerate_per_kw(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
23664 * Trust our pre-built transaction and derived transaction creation public keys.
23666 * Applies a wrapper which allows access to these fields.
23668 * This should only be used if you fully trust the builder of this object. It should not
23669 * be used by an external signer - instead use the verify function.
23671 MUST_USE_RES struct LDKTrustedCommitmentTransaction CommitmentTransaction_trust(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
23674 * Verify our pre-built transaction and derived transaction creation public keys.
23676 * Applies a wrapper which allows access to these fields.
23678 * An external validating signer must call this method before signing
23679 * or using the built transaction.
23681 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);
23684 * Frees any resources used by the TrustedCommitmentTransaction, if is_owned is set and inner is non-NULL.
23686 void TrustedCommitmentTransaction_free(struct LDKTrustedCommitmentTransaction this_obj);
23689 * The transaction ID of the built Bitcoin transaction
23691 MUST_USE_RES struct LDKThirtyTwoBytes TrustedCommitmentTransaction_txid(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
23694 * The pre-built Bitcoin commitment transaction
23696 MUST_USE_RES struct LDKBuiltCommitmentTransaction TrustedCommitmentTransaction_built_transaction(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
23699 * The pre-calculated transaction creation public keys.
23701 MUST_USE_RES struct LDKTxCreationKeys TrustedCommitmentTransaction_keys(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
23704 * Should anchors be used.
23706 MUST_USE_RES bool TrustedCommitmentTransaction_opt_anchors(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
23709 * Get a signature for each HTLC which was included in the commitment transaction (ie for
23710 * which HTLCOutputInCommitment::transaction_output_index.is_some()).
23712 * The returned Vec has one entry for each HTLC, and in the same order.
23714 * This function is only valid in the holder commitment context, it always uses SigHashType::All.
23716 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);
23719 * Commitment transaction numbers which appear in the transactions themselves are XOR'd with a
23720 * shared secret first. This prevents on-chain observers from discovering how many commitment
23721 * transactions occurred in a channel before it was closed.
23723 * This function gets the shared secret from relevant channel public keys and can be used to
23724 * \"decrypt\" the commitment transaction number given a commitment transaction on-chain.
23726 uint64_t get_commitment_transaction_number_obscure_factor(struct LDKPublicKey broadcaster_payment_basepoint, struct LDKPublicKey countersignatory_payment_basepoint, bool outbound_from_broadcaster);
23729 * Checks if two InitFeaturess contain equal inner contents.
23730 * This ignores pointers and is_owned flags and looks at the values in fields.
23731 * Two objects with NULL inner values will be considered "equal" here.
23733 bool InitFeatures_eq(const struct LDKInitFeatures *NONNULL_PTR a, const struct LDKInitFeatures *NONNULL_PTR b);
23736 * Checks if two NodeFeaturess contain equal inner contents.
23737 * This ignores pointers and is_owned flags and looks at the values in fields.
23738 * Two objects with NULL inner values will be considered "equal" here.
23740 bool NodeFeatures_eq(const struct LDKNodeFeatures *NONNULL_PTR a, const struct LDKNodeFeatures *NONNULL_PTR b);
23743 * Checks if two ChannelFeaturess contain equal inner contents.
23744 * This ignores pointers and is_owned flags and looks at the values in fields.
23745 * Two objects with NULL inner values will be considered "equal" here.
23747 bool ChannelFeatures_eq(const struct LDKChannelFeatures *NONNULL_PTR a, const struct LDKChannelFeatures *NONNULL_PTR b);
23750 * Checks if two InvoiceFeaturess contain equal inner contents.
23751 * This ignores pointers and is_owned flags and looks at the values in fields.
23752 * Two objects with NULL inner values will be considered "equal" here.
23754 bool InvoiceFeatures_eq(const struct LDKInvoiceFeatures *NONNULL_PTR a, const struct LDKInvoiceFeatures *NONNULL_PTR b);
23757 * Checks if two ChannelTypeFeaturess contain equal inner contents.
23758 * This ignores pointers and is_owned flags and looks at the values in fields.
23759 * Two objects with NULL inner values will be considered "equal" here.
23761 bool ChannelTypeFeatures_eq(const struct LDKChannelTypeFeatures *NONNULL_PTR a, const struct LDKChannelTypeFeatures *NONNULL_PTR b);
23764 * Creates a copy of the InitFeatures
23766 struct LDKInitFeatures InitFeatures_clone(const struct LDKInitFeatures *NONNULL_PTR orig);
23769 * Creates a copy of the NodeFeatures
23771 struct LDKNodeFeatures NodeFeatures_clone(const struct LDKNodeFeatures *NONNULL_PTR orig);
23774 * Creates a copy of the ChannelFeatures
23776 struct LDKChannelFeatures ChannelFeatures_clone(const struct LDKChannelFeatures *NONNULL_PTR orig);
23779 * Creates a copy of the InvoiceFeatures
23781 struct LDKInvoiceFeatures InvoiceFeatures_clone(const struct LDKInvoiceFeatures *NONNULL_PTR orig);
23784 * Creates a copy of the ChannelTypeFeatures
23786 struct LDKChannelTypeFeatures ChannelTypeFeatures_clone(const struct LDKChannelTypeFeatures *NONNULL_PTR orig);
23789 * Frees any resources used by the InitFeatures, if is_owned is set and inner is non-NULL.
23791 void InitFeatures_free(struct LDKInitFeatures this_obj);
23794 * Frees any resources used by the NodeFeatures, if is_owned is set and inner is non-NULL.
23796 void NodeFeatures_free(struct LDKNodeFeatures this_obj);
23799 * Frees any resources used by the ChannelFeatures, if is_owned is set and inner is non-NULL.
23801 void ChannelFeatures_free(struct LDKChannelFeatures this_obj);
23804 * Frees any resources used by the InvoiceFeatures, if is_owned is set and inner is non-NULL.
23806 void InvoiceFeatures_free(struct LDKInvoiceFeatures this_obj);
23809 * Frees any resources used by the ChannelTypeFeatures, if is_owned is set and inner is non-NULL.
23811 void ChannelTypeFeatures_free(struct LDKChannelTypeFeatures this_obj);
23814 * Create a blank Features with no features set
23816 MUST_USE_RES struct LDKInitFeatures InitFeatures_empty(void);
23819 * Creates a Features with the bits set which are known by the implementation
23821 MUST_USE_RES struct LDKInitFeatures InitFeatures_known(void);
23824 * Returns true if this `Features` object contains unknown feature flags which are set as
23827 MUST_USE_RES bool InitFeatures_requires_unknown_bits(const struct LDKInitFeatures *NONNULL_PTR this_arg);
23830 * Create a blank Features with no features set
23832 MUST_USE_RES struct LDKNodeFeatures NodeFeatures_empty(void);
23835 * Creates a Features with the bits set which are known by the implementation
23837 MUST_USE_RES struct LDKNodeFeatures NodeFeatures_known(void);
23840 * Returns true if this `Features` object contains unknown feature flags which are set as
23843 MUST_USE_RES bool NodeFeatures_requires_unknown_bits(const struct LDKNodeFeatures *NONNULL_PTR this_arg);
23846 * Create a blank Features with no features set
23848 MUST_USE_RES struct LDKChannelFeatures ChannelFeatures_empty(void);
23851 * Creates a Features with the bits set which are known by the implementation
23853 MUST_USE_RES struct LDKChannelFeatures ChannelFeatures_known(void);
23856 * Returns true if this `Features` object contains unknown feature flags which are set as
23859 MUST_USE_RES bool ChannelFeatures_requires_unknown_bits(const struct LDKChannelFeatures *NONNULL_PTR this_arg);
23862 * Create a blank Features with no features set
23864 MUST_USE_RES struct LDKInvoiceFeatures InvoiceFeatures_empty(void);
23867 * Creates a Features with the bits set which are known by the implementation
23869 MUST_USE_RES struct LDKInvoiceFeatures InvoiceFeatures_known(void);
23872 * Returns true if this `Features` object contains unknown feature flags which are set as
23875 MUST_USE_RES bool InvoiceFeatures_requires_unknown_bits(const struct LDKInvoiceFeatures *NONNULL_PTR this_arg);
23878 * Create a blank Features with no features set
23880 MUST_USE_RES struct LDKChannelTypeFeatures ChannelTypeFeatures_empty(void);
23883 * Creates a Features with the bits set which are known by the implementation
23885 MUST_USE_RES struct LDKChannelTypeFeatures ChannelTypeFeatures_known(void);
23888 * Returns true if this `Features` object contains unknown feature flags which are set as
23891 MUST_USE_RES bool ChannelTypeFeatures_requires_unknown_bits(const struct LDKChannelTypeFeatures *NONNULL_PTR this_arg);
23894 * Serialize the InitFeatures object into a byte array which can be read by InitFeatures_read
23896 struct LDKCVec_u8Z InitFeatures_write(const struct LDKInitFeatures *NONNULL_PTR obj);
23899 * Read a InitFeatures from a byte array, created by InitFeatures_write
23901 struct LDKCResult_InitFeaturesDecodeErrorZ InitFeatures_read(struct LDKu8slice ser);
23904 * Serialize the ChannelFeatures object into a byte array which can be read by ChannelFeatures_read
23906 struct LDKCVec_u8Z ChannelFeatures_write(const struct LDKChannelFeatures *NONNULL_PTR obj);
23909 * Read a ChannelFeatures from a byte array, created by ChannelFeatures_write
23911 struct LDKCResult_ChannelFeaturesDecodeErrorZ ChannelFeatures_read(struct LDKu8slice ser);
23914 * Serialize the NodeFeatures object into a byte array which can be read by NodeFeatures_read
23916 struct LDKCVec_u8Z NodeFeatures_write(const struct LDKNodeFeatures *NONNULL_PTR obj);
23919 * Read a NodeFeatures from a byte array, created by NodeFeatures_write
23921 struct LDKCResult_NodeFeaturesDecodeErrorZ NodeFeatures_read(struct LDKu8slice ser);
23924 * Serialize the InvoiceFeatures object into a byte array which can be read by InvoiceFeatures_read
23926 struct LDKCVec_u8Z InvoiceFeatures_write(const struct LDKInvoiceFeatures *NONNULL_PTR obj);
23929 * Read a InvoiceFeatures from a byte array, created by InvoiceFeatures_write
23931 struct LDKCResult_InvoiceFeaturesDecodeErrorZ InvoiceFeatures_read(struct LDKu8slice ser);
23934 * Serialize the ChannelTypeFeatures object into a byte array which can be read by ChannelTypeFeatures_read
23936 struct LDKCVec_u8Z ChannelTypeFeatures_write(const struct LDKChannelTypeFeatures *NONNULL_PTR obj);
23939 * Read a ChannelTypeFeatures from a byte array, created by ChannelTypeFeatures_write
23941 struct LDKCResult_ChannelTypeFeaturesDecodeErrorZ ChannelTypeFeatures_read(struct LDKu8slice ser);
23944 * Frees any resources used by the ShutdownScript, if is_owned is set and inner is non-NULL.
23946 void ShutdownScript_free(struct LDKShutdownScript this_obj);
23949 * Creates a copy of the ShutdownScript
23951 struct LDKShutdownScript ShutdownScript_clone(const struct LDKShutdownScript *NONNULL_PTR orig);
23954 * Frees any resources used by the InvalidShutdownScript, if is_owned is set and inner is non-NULL.
23956 void InvalidShutdownScript_free(struct LDKInvalidShutdownScript this_obj);
23959 * The script that did not meet the requirements from [BOLT #2].
23961 * [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
23963 struct LDKu8slice InvalidShutdownScript_get_script(const struct LDKInvalidShutdownScript *NONNULL_PTR this_ptr);
23966 * The script that did not meet the requirements from [BOLT #2].
23968 * [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
23970 void InvalidShutdownScript_set_script(struct LDKInvalidShutdownScript *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
23973 * Constructs a new InvalidShutdownScript given each field
23975 MUST_USE_RES struct LDKInvalidShutdownScript InvalidShutdownScript_new(struct LDKCVec_u8Z script_arg);
23978 * Creates a copy of the InvalidShutdownScript
23980 struct LDKInvalidShutdownScript InvalidShutdownScript_clone(const struct LDKInvalidShutdownScript *NONNULL_PTR orig);
23983 * Serialize the ShutdownScript object into a byte array which can be read by ShutdownScript_read
23985 struct LDKCVec_u8Z ShutdownScript_write(const struct LDKShutdownScript *NONNULL_PTR obj);
23988 * Read a ShutdownScript from a byte array, created by ShutdownScript_write
23990 struct LDKCResult_ShutdownScriptDecodeErrorZ ShutdownScript_read(struct LDKu8slice ser);
23993 * Generates a P2WPKH script pubkey from the given [`WPubkeyHash`].
23995 MUST_USE_RES struct LDKShutdownScript ShutdownScript_new_p2wpkh(const uint8_t (*pubkey_hash)[20]);
23998 * Generates a P2WSH script pubkey from the given [`WScriptHash`].
24000 MUST_USE_RES struct LDKShutdownScript ShutdownScript_new_p2wsh(const uint8_t (*script_hash)[32]);
24003 * Generates a witness script pubkey from the given segwit version and program.
24005 * Note for version-zero witness scripts you must use [`ShutdownScript::new_p2wpkh`] or
24006 * [`ShutdownScript::new_p2wsh`] instead.
24010 * This function may return an error if `program` is invalid for the segwit `version`.
24012 MUST_USE_RES struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ ShutdownScript_new_witness_program(uint8_t version, struct LDKu8slice program);
24015 * Converts the shutdown script into the underlying [`Script`].
24017 MUST_USE_RES struct LDKCVec_u8Z ShutdownScript_into_inner(struct LDKShutdownScript this_arg);
24020 * Returns the [`PublicKey`] used for a P2WPKH shutdown script if constructed directly from it.
24022 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24024 MUST_USE_RES struct LDKPublicKey ShutdownScript_as_legacy_pubkey(const struct LDKShutdownScript *NONNULL_PTR this_arg);
24027 * Returns whether the shutdown script is compatible with the features as defined by BOLT #2.
24029 * Specifically, checks for compliance with feature `option_shutdown_anysegwit`.
24031 MUST_USE_RES bool ShutdownScript_is_compatible(const struct LDKShutdownScript *NONNULL_PTR this_arg, const struct LDKInitFeatures *NONNULL_PTR features);
24034 * Calls the free function if one is set
24036 void CustomMessageReader_free(struct LDKCustomMessageReader this_ptr);
24039 * Calls the free function if one is set
24041 void Type_free(struct LDKType this_ptr);
24044 * Frees any resources used by the NodeId, if is_owned is set and inner is non-NULL.
24046 void NodeId_free(struct LDKNodeId this_obj);
24049 * Creates a copy of the NodeId
24051 struct LDKNodeId NodeId_clone(const struct LDKNodeId *NONNULL_PTR orig);
24054 * Create a new NodeId from a public key
24056 MUST_USE_RES struct LDKNodeId NodeId_from_pubkey(struct LDKPublicKey pubkey);
24059 * Get the public key slice from this NodeId
24061 MUST_USE_RES struct LDKu8slice NodeId_as_slice(const struct LDKNodeId *NONNULL_PTR this_arg);
24064 * Checks if two NodeIds contain equal inner contents.
24066 uint64_t NodeId_hash(const struct LDKNodeId *NONNULL_PTR o);
24069 * Serialize the NodeId object into a byte array which can be read by NodeId_read
24071 struct LDKCVec_u8Z NodeId_write(const struct LDKNodeId *NONNULL_PTR obj);
24074 * Read a NodeId from a byte array, created by NodeId_write
24076 struct LDKCResult_NodeIdDecodeErrorZ NodeId_read(struct LDKu8slice ser);
24079 * Frees any resources used by the NetworkGraph, if is_owned is set and inner is non-NULL.
24081 void NetworkGraph_free(struct LDKNetworkGraph this_obj);
24084 * Creates a copy of the NetworkGraph
24086 struct LDKNetworkGraph NetworkGraph_clone(const struct LDKNetworkGraph *NONNULL_PTR orig);
24089 * Frees any resources used by the ReadOnlyNetworkGraph, if is_owned is set and inner is non-NULL.
24091 void ReadOnlyNetworkGraph_free(struct LDKReadOnlyNetworkGraph this_obj);
24094 * Frees any resources used by the NetworkUpdate
24096 void NetworkUpdate_free(struct LDKNetworkUpdate this_ptr);
24099 * Creates a copy of the NetworkUpdate
24101 struct LDKNetworkUpdate NetworkUpdate_clone(const struct LDKNetworkUpdate *NONNULL_PTR orig);
24104 * Utility method to constructs a new ChannelUpdateMessage-variant NetworkUpdate
24106 struct LDKNetworkUpdate NetworkUpdate_channel_update_message(struct LDKChannelUpdate msg);
24109 * Utility method to constructs a new ChannelClosed-variant NetworkUpdate
24111 struct LDKNetworkUpdate NetworkUpdate_channel_closed(uint64_t short_channel_id, bool is_permanent);
24114 * Utility method to constructs a new NodeFailure-variant NetworkUpdate
24116 struct LDKNetworkUpdate NetworkUpdate_node_failure(struct LDKPublicKey node_id, bool is_permanent);
24119 * Serialize the NetworkUpdate object into a byte array which can be read by NetworkUpdate_read
24121 struct LDKCVec_u8Z NetworkUpdate_write(const struct LDKNetworkUpdate *NONNULL_PTR obj);
24124 * Read a NetworkUpdate from a byte array, created by NetworkUpdate_write
24126 struct LDKCResult_COption_NetworkUpdateZDecodeErrorZ NetworkUpdate_read(struct LDKu8slice ser);
24129 * Constructs a new EventHandler which calls the relevant methods on this_arg.
24130 * This copies the `inner` pointer in this_arg and thus the returned EventHandler must be freed before this_arg is
24132 struct LDKEventHandler NetGraphMsgHandler_as_EventHandler(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
24135 * Frees any resources used by the NetGraphMsgHandler, if is_owned is set and inner is non-NULL.
24137 void NetGraphMsgHandler_free(struct LDKNetGraphMsgHandler this_obj);
24140 * Creates a new tracker of the actual state of the network of channels and nodes,
24141 * assuming an existing Network Graph.
24142 * Chain monitor is used to make sure announced channels exist on-chain,
24143 * channel data is correct, and that the announcement is signed with
24144 * channel owners' keys.
24146 MUST_USE_RES struct LDKNetGraphMsgHandler NetGraphMsgHandler_new(const struct LDKNetworkGraph *NONNULL_PTR network_graph, struct LDKCOption_AccessZ chain_access, struct LDKLogger logger);
24149 * Adds a provider used to check new announcements. Does not affect
24150 * existing announcements unless they are updated.
24151 * Add, update or remove the provider would replace the current one.
24153 void NetGraphMsgHandler_add_chain_access(struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg, struct LDKCOption_AccessZ chain_access);
24156 * Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg.
24157 * This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is
24159 struct LDKRoutingMessageHandler NetGraphMsgHandler_as_RoutingMessageHandler(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
24162 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
24163 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
24165 struct LDKMessageSendEventsProvider NetGraphMsgHandler_as_MessageSendEventsProvider(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
24168 * Frees any resources used by the ChannelUpdateInfo, if is_owned is set and inner is non-NULL.
24170 void ChannelUpdateInfo_free(struct LDKChannelUpdateInfo this_obj);
24173 * When the last update to the channel direction was issued.
24174 * Value is opaque, as set in the announcement.
24176 uint32_t ChannelUpdateInfo_get_last_update(const struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr);
24179 * When the last update to the channel direction was issued.
24180 * Value is opaque, as set in the announcement.
24182 void ChannelUpdateInfo_set_last_update(struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr, uint32_t val);
24185 * Whether the channel can be currently used for payments (in this one direction).
24187 bool ChannelUpdateInfo_get_enabled(const struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr);
24190 * Whether the channel can be currently used for payments (in this one direction).
24192 void ChannelUpdateInfo_set_enabled(struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr, bool val);
24195 * The difference in CLTV values that you must have when routing through this channel.
24197 uint16_t ChannelUpdateInfo_get_cltv_expiry_delta(const struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr);
24200 * The difference in CLTV values that you must have when routing through this channel.
24202 void ChannelUpdateInfo_set_cltv_expiry_delta(struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr, uint16_t val);
24205 * The minimum value, which must be relayed to the next hop via the channel
24207 uint64_t ChannelUpdateInfo_get_htlc_minimum_msat(const struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr);
24210 * The minimum value, which must be relayed to the next hop via the channel
24212 void ChannelUpdateInfo_set_htlc_minimum_msat(struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr, uint64_t val);
24215 * The maximum value which may be relayed to the next hop via the channel.
24217 struct LDKCOption_u64Z ChannelUpdateInfo_get_htlc_maximum_msat(const struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr);
24220 * The maximum value which may be relayed to the next hop via the channel.
24222 void ChannelUpdateInfo_set_htlc_maximum_msat(struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
24225 * Fees charged when the channel is used for routing
24227 struct LDKRoutingFees ChannelUpdateInfo_get_fees(const struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr);
24230 * Fees charged when the channel is used for routing
24232 void ChannelUpdateInfo_set_fees(struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
24235 * Most recent update for the channel received from the network
24236 * Mostly redundant with the data we store in fields explicitly.
24237 * Everything else is useful only for sending out for initial routing sync.
24238 * Not stored if contains excess data to prevent DoS.
24240 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24242 struct LDKChannelUpdate ChannelUpdateInfo_get_last_update_message(const struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr);
24245 * Most recent update for the channel received from the network
24246 * Mostly redundant with the data we store in fields explicitly.
24247 * Everything else is useful only for sending out for initial routing sync.
24248 * Not stored if contains excess data to prevent DoS.
24250 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
24252 void ChannelUpdateInfo_set_last_update_message(struct LDKChannelUpdateInfo *NONNULL_PTR this_ptr, struct LDKChannelUpdate val);
24255 * Constructs a new ChannelUpdateInfo given each field
24257 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);
24260 * Creates a copy of the ChannelUpdateInfo
24262 struct LDKChannelUpdateInfo ChannelUpdateInfo_clone(const struct LDKChannelUpdateInfo *NONNULL_PTR orig);
24265 * Serialize the ChannelUpdateInfo object into a byte array which can be read by ChannelUpdateInfo_read
24267 struct LDKCVec_u8Z ChannelUpdateInfo_write(const struct LDKChannelUpdateInfo *NONNULL_PTR obj);
24270 * Read a ChannelUpdateInfo from a byte array, created by ChannelUpdateInfo_write
24272 struct LDKCResult_ChannelUpdateInfoDecodeErrorZ ChannelUpdateInfo_read(struct LDKu8slice ser);
24275 * Frees any resources used by the ChannelInfo, if is_owned is set and inner is non-NULL.
24277 void ChannelInfo_free(struct LDKChannelInfo this_obj);
24280 * Protocol features of a channel communicated during its announcement
24282 struct LDKChannelFeatures ChannelInfo_get_features(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
24285 * Protocol features of a channel communicated during its announcement
24287 void ChannelInfo_set_features(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
24290 * Source node of the first direction of a channel
24292 struct LDKNodeId ChannelInfo_get_node_one(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
24295 * Source node of the first direction of a channel
24297 void ChannelInfo_set_node_one(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKNodeId val);
24300 * Details about the first direction of a channel
24302 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24304 struct LDKChannelUpdateInfo ChannelInfo_get_one_to_two(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
24307 * Details about the first direction of a channel
24309 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
24311 void ChannelInfo_set_one_to_two(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelUpdateInfo val);
24314 * Source node of the second direction of a channel
24316 struct LDKNodeId ChannelInfo_get_node_two(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
24319 * Source node of the second direction of a channel
24321 void ChannelInfo_set_node_two(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKNodeId val);
24324 * Details about the second direction of a channel
24326 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24328 struct LDKChannelUpdateInfo ChannelInfo_get_two_to_one(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
24331 * Details about the second direction of a channel
24333 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
24335 void ChannelInfo_set_two_to_one(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelUpdateInfo val);
24338 * The channel capacity as seen on-chain, if chain lookup is available.
24340 struct LDKCOption_u64Z ChannelInfo_get_capacity_sats(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
24343 * The channel capacity as seen on-chain, if chain lookup is available.
24345 void ChannelInfo_set_capacity_sats(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
24348 * An initial announcement of the channel
24349 * Mostly redundant with the data we store in fields explicitly.
24350 * Everything else is useful only for sending out for initial routing sync.
24351 * Not stored if contains excess data to prevent DoS.
24353 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24355 struct LDKChannelAnnouncement ChannelInfo_get_announcement_message(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
24358 * An initial announcement of the channel
24359 * Mostly redundant with the data we store in fields explicitly.
24360 * Everything else is useful only for sending out for initial routing sync.
24361 * Not stored if contains excess data to prevent DoS.
24363 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
24365 void ChannelInfo_set_announcement_message(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelAnnouncement val);
24368 * Creates a copy of the ChannelInfo
24370 struct LDKChannelInfo ChannelInfo_clone(const struct LDKChannelInfo *NONNULL_PTR orig);
24373 * Serialize the ChannelInfo object into a byte array which can be read by ChannelInfo_read
24375 struct LDKCVec_u8Z ChannelInfo_write(const struct LDKChannelInfo *NONNULL_PTR obj);
24378 * Read a ChannelInfo from a byte array, created by ChannelInfo_write
24380 struct LDKCResult_ChannelInfoDecodeErrorZ ChannelInfo_read(struct LDKu8slice ser);
24383 * Frees any resources used by the DirectedChannelInfo, if is_owned is set and inner is non-NULL.
24385 void DirectedChannelInfo_free(struct LDKDirectedChannelInfo this_obj);
24388 * Creates a copy of the DirectedChannelInfo
24390 struct LDKDirectedChannelInfo DirectedChannelInfo_clone(const struct LDKDirectedChannelInfo *NONNULL_PTR orig);
24393 * Returns information for the channel.
24395 MUST_USE_RES struct LDKChannelInfo DirectedChannelInfo_channel(const struct LDKDirectedChannelInfo *NONNULL_PTR this_arg);
24398 * Returns information for the direction.
24400 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24402 MUST_USE_RES struct LDKChannelUpdateInfo DirectedChannelInfo_direction(const struct LDKDirectedChannelInfo *NONNULL_PTR this_arg);
24405 * Returns the [`EffectiveCapacity`] of the channel in the direction.
24407 * This is either the total capacity from the funding transaction, if known, or the
24408 * `htlc_maximum_msat` for the direction as advertised by the gossip network, if known,
24409 * whichever is smaller.
24411 MUST_USE_RES struct LDKEffectiveCapacity DirectedChannelInfo_effective_capacity(const struct LDKDirectedChannelInfo *NONNULL_PTR this_arg);
24414 * Frees any resources used by the EffectiveCapacity
24416 void EffectiveCapacity_free(struct LDKEffectiveCapacity this_ptr);
24419 * Creates a copy of the EffectiveCapacity
24421 struct LDKEffectiveCapacity EffectiveCapacity_clone(const struct LDKEffectiveCapacity *NONNULL_PTR orig);
24424 * Utility method to constructs a new ExactLiquidity-variant EffectiveCapacity
24426 struct LDKEffectiveCapacity EffectiveCapacity_exact_liquidity(uint64_t liquidity_msat);
24429 * Utility method to constructs a new MaximumHTLC-variant EffectiveCapacity
24431 struct LDKEffectiveCapacity EffectiveCapacity_maximum_htlc(uint64_t amount_msat);
24434 * Utility method to constructs a new Total-variant EffectiveCapacity
24436 struct LDKEffectiveCapacity EffectiveCapacity_total(uint64_t capacity_msat);
24439 * Utility method to constructs a new Infinite-variant EffectiveCapacity
24441 struct LDKEffectiveCapacity EffectiveCapacity_infinite(void);
24444 * Utility method to constructs a new Unknown-variant EffectiveCapacity
24446 struct LDKEffectiveCapacity EffectiveCapacity_unknown(void);
24449 * Returns the effective capacity denominated in millisatoshi.
24451 MUST_USE_RES uint64_t EffectiveCapacity_as_msat(const struct LDKEffectiveCapacity *NONNULL_PTR this_arg);
24454 * Frees any resources used by the RoutingFees, if is_owned is set and inner is non-NULL.
24456 void RoutingFees_free(struct LDKRoutingFees this_obj);
24459 * Flat routing fee in satoshis
24461 uint32_t RoutingFees_get_base_msat(const struct LDKRoutingFees *NONNULL_PTR this_ptr);
24464 * Flat routing fee in satoshis
24466 void RoutingFees_set_base_msat(struct LDKRoutingFees *NONNULL_PTR this_ptr, uint32_t val);
24469 * Liquidity-based routing fee in millionths of a routed amount.
24470 * In other words, 10000 is 1%.
24472 uint32_t RoutingFees_get_proportional_millionths(const struct LDKRoutingFees *NONNULL_PTR this_ptr);
24475 * Liquidity-based routing fee in millionths of a routed amount.
24476 * In other words, 10000 is 1%.
24478 void RoutingFees_set_proportional_millionths(struct LDKRoutingFees *NONNULL_PTR this_ptr, uint32_t val);
24481 * Constructs a new RoutingFees given each field
24483 MUST_USE_RES struct LDKRoutingFees RoutingFees_new(uint32_t base_msat_arg, uint32_t proportional_millionths_arg);
24486 * Checks if two RoutingFeess contain equal inner contents.
24487 * This ignores pointers and is_owned flags and looks at the values in fields.
24488 * Two objects with NULL inner values will be considered "equal" here.
24490 bool RoutingFees_eq(const struct LDKRoutingFees *NONNULL_PTR a, const struct LDKRoutingFees *NONNULL_PTR b);
24493 * Creates a copy of the RoutingFees
24495 struct LDKRoutingFees RoutingFees_clone(const struct LDKRoutingFees *NONNULL_PTR orig);
24498 * Checks if two RoutingFeess contain equal inner contents.
24500 uint64_t RoutingFees_hash(const struct LDKRoutingFees *NONNULL_PTR o);
24503 * Serialize the RoutingFees object into a byte array which can be read by RoutingFees_read
24505 struct LDKCVec_u8Z RoutingFees_write(const struct LDKRoutingFees *NONNULL_PTR obj);
24508 * Read a RoutingFees from a byte array, created by RoutingFees_write
24510 struct LDKCResult_RoutingFeesDecodeErrorZ RoutingFees_read(struct LDKu8slice ser);
24513 * Frees any resources used by the NodeAnnouncementInfo, if is_owned is set and inner is non-NULL.
24515 void NodeAnnouncementInfo_free(struct LDKNodeAnnouncementInfo this_obj);
24518 * Protocol features the node announced support for
24520 struct LDKNodeFeatures NodeAnnouncementInfo_get_features(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
24523 * Protocol features the node announced support for
24525 void NodeAnnouncementInfo_set_features(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
24528 * When the last known update to the node state was issued.
24529 * Value is opaque, as set in the announcement.
24531 uint32_t NodeAnnouncementInfo_get_last_update(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
24534 * When the last known update to the node state was issued.
24535 * Value is opaque, as set in the announcement.
24537 void NodeAnnouncementInfo_set_last_update(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, uint32_t val);
24540 * Color assigned to the node
24542 const uint8_t (*NodeAnnouncementInfo_get_rgb(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr))[3];
24545 * Color assigned to the node
24547 void NodeAnnouncementInfo_set_rgb(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKThreeBytes val);
24550 * Moniker assigned to the node.
24551 * May be invalid or malicious (eg control chars),
24552 * should not be exposed to the user.
24554 const uint8_t (*NodeAnnouncementInfo_get_alias(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr))[32];
24557 * Moniker assigned to the node.
24558 * May be invalid or malicious (eg control chars),
24559 * should not be exposed to the user.
24561 void NodeAnnouncementInfo_set_alias(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
24564 * Internet-level addresses via which one can connect to the node
24566 void NodeAnnouncementInfo_set_addresses(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKCVec_NetAddressZ val);
24569 * An initial announcement of the node
24570 * Mostly redundant with the data we store in fields explicitly.
24571 * Everything else is useful only for sending out for initial routing sync.
24572 * Not stored if contains excess data to prevent DoS.
24574 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24576 struct LDKNodeAnnouncement NodeAnnouncementInfo_get_announcement_message(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
24579 * An initial announcement of the node
24580 * Mostly redundant with the data we store in fields explicitly.
24581 * Everything else is useful only for sending out for initial routing sync.
24582 * Not stored if contains excess data to prevent DoS.
24584 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
24586 void NodeAnnouncementInfo_set_announcement_message(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKNodeAnnouncement val);
24589 * Constructs a new NodeAnnouncementInfo given each field
24591 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);
24594 * Creates a copy of the NodeAnnouncementInfo
24596 struct LDKNodeAnnouncementInfo NodeAnnouncementInfo_clone(const struct LDKNodeAnnouncementInfo *NONNULL_PTR orig);
24599 * Serialize the NodeAnnouncementInfo object into a byte array which can be read by NodeAnnouncementInfo_read
24601 struct LDKCVec_u8Z NodeAnnouncementInfo_write(const struct LDKNodeAnnouncementInfo *NONNULL_PTR obj);
24604 * Read a NodeAnnouncementInfo from a byte array, created by NodeAnnouncementInfo_write
24606 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ NodeAnnouncementInfo_read(struct LDKu8slice ser);
24609 * Frees any resources used by the NodeInfo, if is_owned is set and inner is non-NULL.
24611 void NodeInfo_free(struct LDKNodeInfo this_obj);
24614 * All valid channels a node has announced
24616 void NodeInfo_set_channels(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
24619 * Lowest fees enabling routing via any of the enabled, known channels to a node.
24620 * The two fields (flat and proportional fee) are independent,
24621 * meaning they don't have to refer to the same channel.
24623 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24625 struct LDKRoutingFees NodeInfo_get_lowest_inbound_channel_fees(const struct LDKNodeInfo *NONNULL_PTR this_ptr);
24628 * Lowest fees enabling routing via any of the enabled, known channels to a node.
24629 * The two fields (flat and proportional fee) are independent,
24630 * meaning they don't have to refer to the same channel.
24632 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
24634 void NodeInfo_set_lowest_inbound_channel_fees(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
24637 * More information about a node from node_announcement.
24638 * Optional because we store a Node entry after learning about it from
24639 * a channel announcement, but before receiving a node announcement.
24641 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24643 struct LDKNodeAnnouncementInfo NodeInfo_get_announcement_info(const struct LDKNodeInfo *NONNULL_PTR this_ptr);
24646 * More information about a node from node_announcement.
24647 * Optional because we store a Node entry after learning about it from
24648 * a channel announcement, but before receiving a node announcement.
24650 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
24652 void NodeInfo_set_announcement_info(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKNodeAnnouncementInfo val);
24655 * Constructs a new NodeInfo given each field
24657 MUST_USE_RES struct LDKNodeInfo NodeInfo_new(struct LDKCVec_u64Z channels_arg, struct LDKRoutingFees lowest_inbound_channel_fees_arg, struct LDKNodeAnnouncementInfo announcement_info_arg);
24660 * Creates a copy of the NodeInfo
24662 struct LDKNodeInfo NodeInfo_clone(const struct LDKNodeInfo *NONNULL_PTR orig);
24665 * Serialize the NodeInfo object into a byte array which can be read by NodeInfo_read
24667 struct LDKCVec_u8Z NodeInfo_write(const struct LDKNodeInfo *NONNULL_PTR obj);
24670 * Read a NodeInfo from a byte array, created by NodeInfo_write
24672 struct LDKCResult_NodeInfoDecodeErrorZ NodeInfo_read(struct LDKu8slice ser);
24675 * Serialize the NetworkGraph object into a byte array which can be read by NetworkGraph_read
24677 struct LDKCVec_u8Z NetworkGraph_write(const struct LDKNetworkGraph *NONNULL_PTR obj);
24680 * Read a NetworkGraph from a byte array, created by NetworkGraph_write
24682 struct LDKCResult_NetworkGraphDecodeErrorZ NetworkGraph_read(struct LDKu8slice ser);
24685 * Creates a new, empty, network graph.
24687 MUST_USE_RES struct LDKNetworkGraph NetworkGraph_new(struct LDKThirtyTwoBytes genesis_hash);
24690 * Returns a read-only view of the network graph.
24692 MUST_USE_RES struct LDKReadOnlyNetworkGraph NetworkGraph_read_only(const struct LDKNetworkGraph *NONNULL_PTR this_arg);
24695 * For an already known node (from channel announcements), update its stored properties from a
24696 * given node announcement.
24698 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
24699 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
24700 * routing messages from a source using a protocol other than the lightning P2P protocol.
24702 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_node_from_announcement(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKNodeAnnouncement *NONNULL_PTR msg);
24705 * For an already known node (from channel announcements), update its stored properties from a
24706 * given node announcement without verifying the associated signatures. Because we aren't
24707 * given the associated signatures here we cannot relay the node announcement to any of our
24710 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);
24713 * Store or update channel info from a channel announcement.
24715 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
24716 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
24717 * routing messages from a source using a protocol other than the lightning P2P protocol.
24719 * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
24720 * the corresponding UTXO exists on chain and is correctly-formatted.
24722 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);
24725 * Store or update channel info from a channel announcement without verifying the associated
24726 * signatures. Because we aren't given the associated signatures here we cannot relay the
24727 * channel announcement to any of our peers.
24729 * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
24730 * the corresponding UTXO exists on chain and is correctly-formatted.
24732 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);
24735 * Close a channel if a corresponding HTLC fail was sent.
24736 * If permanent, removes a channel from the local storage.
24737 * May cause the removal of nodes too, if this was their last channel.
24738 * If not permanent, makes channels unavailable for routing.
24740 void NetworkGraph_close_channel_from_update(const struct LDKNetworkGraph *NONNULL_PTR this_arg, uint64_t short_channel_id, bool is_permanent);
24743 * Marks a node in the graph as failed.
24745 void NetworkGraph_fail_node(const struct LDKNetworkGraph *NONNULL_PTR this_arg, struct LDKPublicKey _node_id, bool is_permanent);
24748 * Removes information about channels that we haven't heard any updates about in some time.
24749 * This can be used regularly to prune the network graph of channels that likely no longer
24752 * While there is no formal requirement that nodes regularly re-broadcast their channel
24753 * updates every two weeks, the non-normative section of BOLT 7 currently suggests that
24754 * pruning occur for updates which are at least two weeks old, which we implement here.
24756 * Note that for users of the `lightning-background-processor` crate this method may be
24757 * automatically called regularly for you.
24759 * This method is only available with the `std` feature. See
24760 * [`NetworkGraph::remove_stale_channels_with_time`] for `no-std` use.
24762 void NetworkGraph_remove_stale_channels(const struct LDKNetworkGraph *NONNULL_PTR this_arg);
24765 * Removes information about channels that we haven't heard any updates about in some time.
24766 * This can be used regularly to prune the network graph of channels that likely no longer
24769 * While there is no formal requirement that nodes regularly re-broadcast their channel
24770 * updates every two weeks, the non-normative section of BOLT 7 currently suggests that
24771 * pruning occur for updates which are at least two weeks old, which we implement here.
24773 * This function takes the current unix time as an argument. For users with the `std` feature
24774 * enabled, [`NetworkGraph::remove_stale_channels`] may be preferable.
24776 void NetworkGraph_remove_stale_channels_with_time(const struct LDKNetworkGraph *NONNULL_PTR this_arg, uint64_t current_time_unix);
24779 * For an already known (from announcement) channel, update info about one of the directions
24782 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
24783 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
24784 * routing messages from a source using a protocol other than the lightning P2P protocol.
24786 * If built with `no-std`, any updates with a timestamp more than two weeks in the past or
24787 * materially in the future will be rejected.
24789 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKChannelUpdate *NONNULL_PTR msg);
24792 * For an already known (from announcement) channel, update info about one of the directions
24793 * of the channel without verifying the associated signatures. Because we aren't given the
24794 * associated signatures here we cannot relay the channel update to any of our peers.
24796 * If built with `no-std`, any updates with a timestamp more than two weeks in the past or
24797 * materially in the future will be rejected.
24799 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel_unsigned(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKUnsignedChannelUpdate *NONNULL_PTR msg);
24802 * Get network addresses by node id.
24803 * Returns None if the requested node is completely unknown,
24804 * or if node announcement for the node was never received.
24806 MUST_USE_RES struct LDKCOption_CVec_NetAddressZZ ReadOnlyNetworkGraph_get_addresses(const struct LDKReadOnlyNetworkGraph *NONNULL_PTR this_arg, struct LDKPublicKey pubkey);
24809 * Frees any resources used by the RouteHop, if is_owned is set and inner is non-NULL.
24811 void RouteHop_free(struct LDKRouteHop this_obj);
24814 * The node_id of the node at this hop.
24816 struct LDKPublicKey RouteHop_get_pubkey(const struct LDKRouteHop *NONNULL_PTR this_ptr);
24819 * The node_id of the node at this hop.
24821 void RouteHop_set_pubkey(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKPublicKey val);
24824 * The node_announcement features of the node at this hop. For the last hop, these may be
24825 * amended to match the features present in the invoice this node generated.
24827 struct LDKNodeFeatures RouteHop_get_node_features(const struct LDKRouteHop *NONNULL_PTR this_ptr);
24830 * The node_announcement features of the node at this hop. For the last hop, these may be
24831 * amended to match the features present in the invoice this node generated.
24833 void RouteHop_set_node_features(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
24836 * The channel that should be used from the previous hop to reach this node.
24838 uint64_t RouteHop_get_short_channel_id(const struct LDKRouteHop *NONNULL_PTR this_ptr);
24841 * The channel that should be used from the previous hop to reach this node.
24843 void RouteHop_set_short_channel_id(struct LDKRouteHop *NONNULL_PTR this_ptr, uint64_t val);
24846 * The channel_announcement features of the channel that should be used from the previous hop
24847 * to reach this node.
24849 struct LDKChannelFeatures RouteHop_get_channel_features(const struct LDKRouteHop *NONNULL_PTR this_ptr);
24852 * The channel_announcement features of the channel that should be used from the previous hop
24853 * to reach this node.
24855 void RouteHop_set_channel_features(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
24858 * The fee taken on this hop (for paying for the use of the *next* channel in the path).
24859 * For the last hop, this should be the full value of the payment (might be more than
24860 * requested if we had to match htlc_minimum_msat).
24862 uint64_t RouteHop_get_fee_msat(const struct LDKRouteHop *NONNULL_PTR this_ptr);
24865 * The fee taken on this hop (for paying for the use of the *next* channel in the path).
24866 * For the last hop, this should be the full value of the payment (might be more than
24867 * requested if we had to match htlc_minimum_msat).
24869 void RouteHop_set_fee_msat(struct LDKRouteHop *NONNULL_PTR this_ptr, uint64_t val);
24872 * The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
24873 * expected at the destination, in excess of the current block height.
24875 uint32_t RouteHop_get_cltv_expiry_delta(const struct LDKRouteHop *NONNULL_PTR this_ptr);
24878 * The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
24879 * expected at the destination, in excess of the current block height.
24881 void RouteHop_set_cltv_expiry_delta(struct LDKRouteHop *NONNULL_PTR this_ptr, uint32_t val);
24884 * Constructs a new RouteHop given each field
24886 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);
24889 * Creates a copy of the RouteHop
24891 struct LDKRouteHop RouteHop_clone(const struct LDKRouteHop *NONNULL_PTR orig);
24894 * Checks if two RouteHops contain equal inner contents.
24896 uint64_t RouteHop_hash(const struct LDKRouteHop *NONNULL_PTR o);
24899 * Checks if two RouteHops contain equal inner contents.
24900 * This ignores pointers and is_owned flags and looks at the values in fields.
24901 * Two objects with NULL inner values will be considered "equal" here.
24903 bool RouteHop_eq(const struct LDKRouteHop *NONNULL_PTR a, const struct LDKRouteHop *NONNULL_PTR b);
24906 * Serialize the RouteHop object into a byte array which can be read by RouteHop_read
24908 struct LDKCVec_u8Z RouteHop_write(const struct LDKRouteHop *NONNULL_PTR obj);
24911 * Read a RouteHop from a byte array, created by RouteHop_write
24913 struct LDKCResult_RouteHopDecodeErrorZ RouteHop_read(struct LDKu8slice ser);
24916 * Frees any resources used by the Route, if is_owned is set and inner is non-NULL.
24918 void Route_free(struct LDKRoute this_obj);
24921 * The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
24922 * last RouteHop in each path must be the same.
24923 * Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
24924 * destination. Thus, this must always be at least length one. While the maximum length of any
24925 * given path is variable, keeping the length of any path to less than 20 should currently
24926 * ensure it is viable.
24928 struct LDKCVec_CVec_RouteHopZZ Route_get_paths(const struct LDKRoute *NONNULL_PTR this_ptr);
24931 * The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
24932 * last RouteHop in each path must be the same.
24933 * Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
24934 * destination. Thus, this must always be at least length one. While the maximum length of any
24935 * given path is variable, keeping the length of any path to less than 20 should currently
24936 * ensure it is viable.
24938 void Route_set_paths(struct LDKRoute *NONNULL_PTR this_ptr, struct LDKCVec_CVec_RouteHopZZ val);
24941 * The `payment_params` parameter passed to [`find_route`].
24942 * This is used by `ChannelManager` to track information which may be required for retries,
24943 * provided back to you via [`Event::PaymentPathFailed`].
24945 * [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
24947 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
24949 struct LDKPaymentParameters Route_get_payment_params(const struct LDKRoute *NONNULL_PTR this_ptr);
24952 * The `payment_params` parameter passed to [`find_route`].
24953 * This is used by `ChannelManager` to track information which may be required for retries,
24954 * provided back to you via [`Event::PaymentPathFailed`].
24956 * [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
24958 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
24960 void Route_set_payment_params(struct LDKRoute *NONNULL_PTR this_ptr, struct LDKPaymentParameters val);
24963 * Constructs a new Route given each field
24965 MUST_USE_RES struct LDKRoute Route_new(struct LDKCVec_CVec_RouteHopZZ paths_arg, struct LDKPaymentParameters payment_params_arg);
24968 * Creates a copy of the Route
24970 struct LDKRoute Route_clone(const struct LDKRoute *NONNULL_PTR orig);
24973 * Checks if two Routes contain equal inner contents.
24975 uint64_t Route_hash(const struct LDKRoute *NONNULL_PTR o);
24978 * Checks if two Routes contain equal inner contents.
24979 * This ignores pointers and is_owned flags and looks at the values in fields.
24980 * Two objects with NULL inner values will be considered "equal" here.
24982 bool Route_eq(const struct LDKRoute *NONNULL_PTR a, const struct LDKRoute *NONNULL_PTR b);
24985 * Returns the total amount of fees paid on this [`Route`].
24987 * This doesn't include any extra payment made to the recipient, which can happen in excess of
24988 * the amount passed to [`find_route`]'s `params.final_value_msat`.
24990 MUST_USE_RES uint64_t Route_get_total_fees(const struct LDKRoute *NONNULL_PTR this_arg);
24993 * Returns the total amount paid on this [`Route`], excluding the fees.
24995 MUST_USE_RES uint64_t Route_get_total_amount(const struct LDKRoute *NONNULL_PTR this_arg);
24998 * Serialize the Route object into a byte array which can be read by Route_read
25000 struct LDKCVec_u8Z Route_write(const struct LDKRoute *NONNULL_PTR obj);
25003 * Read a Route from a byte array, created by Route_write
25005 struct LDKCResult_RouteDecodeErrorZ Route_read(struct LDKu8slice ser);
25008 * Frees any resources used by the RouteParameters, if is_owned is set and inner is non-NULL.
25010 void RouteParameters_free(struct LDKRouteParameters this_obj);
25013 * The parameters of the failed payment path.
25015 struct LDKPaymentParameters RouteParameters_get_payment_params(const struct LDKRouteParameters *NONNULL_PTR this_ptr);
25018 * The parameters of the failed payment path.
25020 void RouteParameters_set_payment_params(struct LDKRouteParameters *NONNULL_PTR this_ptr, struct LDKPaymentParameters val);
25023 * The amount in msats sent on the failed payment path.
25025 uint64_t RouteParameters_get_final_value_msat(const struct LDKRouteParameters *NONNULL_PTR this_ptr);
25028 * The amount in msats sent on the failed payment path.
25030 void RouteParameters_set_final_value_msat(struct LDKRouteParameters *NONNULL_PTR this_ptr, uint64_t val);
25033 * The CLTV on the final hop of the failed payment path.
25035 uint32_t RouteParameters_get_final_cltv_expiry_delta(const struct LDKRouteParameters *NONNULL_PTR this_ptr);
25038 * The CLTV on the final hop of the failed payment path.
25040 void RouteParameters_set_final_cltv_expiry_delta(struct LDKRouteParameters *NONNULL_PTR this_ptr, uint32_t val);
25043 * Constructs a new RouteParameters given each field
25045 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);
25048 * Creates a copy of the RouteParameters
25050 struct LDKRouteParameters RouteParameters_clone(const struct LDKRouteParameters *NONNULL_PTR orig);
25053 * Serialize the RouteParameters object into a byte array which can be read by RouteParameters_read
25055 struct LDKCVec_u8Z RouteParameters_write(const struct LDKRouteParameters *NONNULL_PTR obj);
25058 * Read a RouteParameters from a byte array, created by RouteParameters_write
25060 struct LDKCResult_RouteParametersDecodeErrorZ RouteParameters_read(struct LDKu8slice ser);
25063 * Frees any resources used by the PaymentParameters, if is_owned is set and inner is non-NULL.
25065 void PaymentParameters_free(struct LDKPaymentParameters this_obj);
25068 * The node id of the payee.
25070 struct LDKPublicKey PaymentParameters_get_payee_pubkey(const struct LDKPaymentParameters *NONNULL_PTR this_ptr);
25073 * The node id of the payee.
25075 void PaymentParameters_set_payee_pubkey(struct LDKPaymentParameters *NONNULL_PTR this_ptr, struct LDKPublicKey val);
25078 * Features supported by the payee.
25080 * May be set from the payee's invoice or via [`for_keysend`]. May be `None` if the invoice
25081 * does not contain any features.
25083 * [`for_keysend`]: Self::for_keysend
25085 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
25087 struct LDKInvoiceFeatures PaymentParameters_get_features(const struct LDKPaymentParameters *NONNULL_PTR this_ptr);
25090 * Features supported by the payee.
25092 * May be set from the payee's invoice or via [`for_keysend`]. May be `None` if the invoice
25093 * does not contain any features.
25095 * [`for_keysend`]: Self::for_keysend
25097 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
25099 void PaymentParameters_set_features(struct LDKPaymentParameters *NONNULL_PTR this_ptr, struct LDKInvoiceFeatures val);
25102 * Hints for routing to the payee, containing channels connecting the payee to public nodes.
25104 struct LDKCVec_RouteHintZ PaymentParameters_get_route_hints(const struct LDKPaymentParameters *NONNULL_PTR this_ptr);
25107 * Hints for routing to the payee, containing channels connecting the payee to public nodes.
25109 void PaymentParameters_set_route_hints(struct LDKPaymentParameters *NONNULL_PTR this_ptr, struct LDKCVec_RouteHintZ val);
25112 * Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
25114 struct LDKCOption_u64Z PaymentParameters_get_expiry_time(const struct LDKPaymentParameters *NONNULL_PTR this_ptr);
25117 * Expiration of a payment to the payee, in seconds relative to the UNIX epoch.
25119 void PaymentParameters_set_expiry_time(struct LDKPaymentParameters *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
25122 * The maximum total CLTV delta we accept for the route.
25124 uint32_t PaymentParameters_get_max_total_cltv_expiry_delta(const struct LDKPaymentParameters *NONNULL_PTR this_ptr);
25127 * The maximum total CLTV delta we accept for the route.
25129 void PaymentParameters_set_max_total_cltv_expiry_delta(struct LDKPaymentParameters *NONNULL_PTR this_ptr, uint32_t val);
25132 * Constructs a new PaymentParameters given each field
25134 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);
25137 * Creates a copy of the PaymentParameters
25139 struct LDKPaymentParameters PaymentParameters_clone(const struct LDKPaymentParameters *NONNULL_PTR orig);
25142 * Checks if two PaymentParameterss contain equal inner contents.
25144 uint64_t PaymentParameters_hash(const struct LDKPaymentParameters *NONNULL_PTR o);
25147 * Checks if two PaymentParameterss contain equal inner contents.
25148 * This ignores pointers and is_owned flags and looks at the values in fields.
25149 * Two objects with NULL inner values will be considered "equal" here.
25151 bool PaymentParameters_eq(const struct LDKPaymentParameters *NONNULL_PTR a, const struct LDKPaymentParameters *NONNULL_PTR b);
25154 * Serialize the PaymentParameters object into a byte array which can be read by PaymentParameters_read
25156 struct LDKCVec_u8Z PaymentParameters_write(const struct LDKPaymentParameters *NONNULL_PTR obj);
25159 * Read a PaymentParameters from a byte array, created by PaymentParameters_write
25161 struct LDKCResult_PaymentParametersDecodeErrorZ PaymentParameters_read(struct LDKu8slice ser);
25164 * Creates a payee with the node id of the given `pubkey`.
25166 MUST_USE_RES struct LDKPaymentParameters PaymentParameters_from_node_id(struct LDKPublicKey payee_pubkey);
25169 * Creates a payee with the node id of the given `pubkey` to use for keysend payments.
25171 MUST_USE_RES struct LDKPaymentParameters PaymentParameters_for_keysend(struct LDKPublicKey payee_pubkey);
25174 * Frees any resources used by the RouteHint, if is_owned is set and inner is non-NULL.
25176 void RouteHint_free(struct LDKRouteHint this_obj);
25178 struct LDKCVec_RouteHintHopZ RouteHint_get_a(const struct LDKRouteHint *NONNULL_PTR this_ptr);
25180 void RouteHint_set_a(struct LDKRouteHint *NONNULL_PTR this_ptr, struct LDKCVec_RouteHintHopZ val);
25183 * Constructs a new RouteHint given each field
25185 MUST_USE_RES struct LDKRouteHint RouteHint_new(struct LDKCVec_RouteHintHopZ a_arg);
25188 * Creates a copy of the RouteHint
25190 struct LDKRouteHint RouteHint_clone(const struct LDKRouteHint *NONNULL_PTR orig);
25193 * Checks if two RouteHints contain equal inner contents.
25195 uint64_t RouteHint_hash(const struct LDKRouteHint *NONNULL_PTR o);
25198 * Checks if two RouteHints contain equal inner contents.
25199 * This ignores pointers and is_owned flags and looks at the values in fields.
25200 * Two objects with NULL inner values will be considered "equal" here.
25202 bool RouteHint_eq(const struct LDKRouteHint *NONNULL_PTR a, const struct LDKRouteHint *NONNULL_PTR b);
25205 * Serialize the RouteHint object into a byte array which can be read by RouteHint_read
25207 struct LDKCVec_u8Z RouteHint_write(const struct LDKRouteHint *NONNULL_PTR obj);
25210 * Read a RouteHint from a byte array, created by RouteHint_write
25212 struct LDKCResult_RouteHintDecodeErrorZ RouteHint_read(struct LDKu8slice ser);
25215 * Frees any resources used by the RouteHintHop, if is_owned is set and inner is non-NULL.
25217 void RouteHintHop_free(struct LDKRouteHintHop this_obj);
25220 * The node_id of the non-target end of the route
25222 struct LDKPublicKey RouteHintHop_get_src_node_id(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
25225 * The node_id of the non-target end of the route
25227 void RouteHintHop_set_src_node_id(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKPublicKey val);
25230 * The short_channel_id of this channel
25232 uint64_t RouteHintHop_get_short_channel_id(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
25235 * The short_channel_id of this channel
25237 void RouteHintHop_set_short_channel_id(struct LDKRouteHintHop *NONNULL_PTR this_ptr, uint64_t val);
25240 * The fees which must be paid to use this channel
25242 struct LDKRoutingFees RouteHintHop_get_fees(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
25245 * The fees which must be paid to use this channel
25247 void RouteHintHop_set_fees(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
25250 * The difference in CLTV values between this node and the next node.
25252 uint16_t RouteHintHop_get_cltv_expiry_delta(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
25255 * The difference in CLTV values between this node and the next node.
25257 void RouteHintHop_set_cltv_expiry_delta(struct LDKRouteHintHop *NONNULL_PTR this_ptr, uint16_t val);
25260 * The minimum value, in msat, which must be relayed to the next hop.
25262 struct LDKCOption_u64Z RouteHintHop_get_htlc_minimum_msat(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
25265 * The minimum value, in msat, which must be relayed to the next hop.
25267 void RouteHintHop_set_htlc_minimum_msat(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
25270 * The maximum value in msat available for routing with a single HTLC.
25272 struct LDKCOption_u64Z RouteHintHop_get_htlc_maximum_msat(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
25275 * The maximum value in msat available for routing with a single HTLC.
25277 void RouteHintHop_set_htlc_maximum_msat(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
25280 * Constructs a new RouteHintHop given each field
25282 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);
25285 * Creates a copy of the RouteHintHop
25287 struct LDKRouteHintHop RouteHintHop_clone(const struct LDKRouteHintHop *NONNULL_PTR orig);
25290 * Checks if two RouteHintHops contain equal inner contents.
25292 uint64_t RouteHintHop_hash(const struct LDKRouteHintHop *NONNULL_PTR o);
25295 * Checks if two RouteHintHops contain equal inner contents.
25296 * This ignores pointers and is_owned flags and looks at the values in fields.
25297 * Two objects with NULL inner values will be considered "equal" here.
25299 bool RouteHintHop_eq(const struct LDKRouteHintHop *NONNULL_PTR a, const struct LDKRouteHintHop *NONNULL_PTR b);
25302 * Serialize the RouteHintHop object into a byte array which can be read by RouteHintHop_read
25304 struct LDKCVec_u8Z RouteHintHop_write(const struct LDKRouteHintHop *NONNULL_PTR obj);
25307 * Read a RouteHintHop from a byte array, created by RouteHintHop_write
25309 struct LDKCResult_RouteHintHopDecodeErrorZ RouteHintHop_read(struct LDKu8slice ser);
25312 * Finds a route from us (payer) to the given target node (payee).
25314 * If the payee provided features in their invoice, they should be provided via `params.payee`.
25315 * Without this, MPP will only be used if the payee's features are available in the network graph.
25317 * Private routing paths between a public node and the target may be included in `params.payee`.
25319 * If some channels aren't announced, it may be useful to fill in `first_hops` with the results
25320 * from [`ChannelManager::list_usable_channels`]. If it is filled in, the view of our local
25321 * channels from [`NetworkGraph`] will be ignored, and only those in `first_hops` will be used.
25323 * The fees on channels from us to the next hop are ignored as they are assumed to all be equal.
25324 * However, the enabled/disabled bit on such channels as well as the `htlc_minimum_msat` /
25325 * `htlc_maximum_msat` *are* checked as they may change based on the receiving node.
25329 * May be used to re-compute a [`Route`] when handling a [`Event::PaymentPathFailed`]. Any
25330 * adjustments to the [`NetworkGraph`] and channel scores should be made prior to calling this
25335 * Panics if first_hops contains channels without short_channel_ids;
25336 * [`ChannelManager::list_usable_channels`] will never include such channels.
25338 * [`ChannelManager::list_usable_channels`]: crate::ln::channelmanager::ChannelManager::list_usable_channels
25339 * [`Event::PaymentPathFailed`]: crate::util::events::Event::PaymentPathFailed
25341 * Note that first_hops (or a relevant inner pointer) may be NULL or all-0s to represent None
25343 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, const uint8_t (*random_seed_bytes)[32]);
25346 * Calls the free function if one is set
25348 void Score_free(struct LDKScore this_ptr);
25351 * Calls the free function if one is set
25353 void LockableScore_free(struct LDKLockableScore this_ptr);
25356 * Frees any resources used by the MultiThreadedLockableScore, if is_owned is set and inner is non-NULL.
25358 void MultiThreadedLockableScore_free(struct LDKMultiThreadedLockableScore this_obj);
25361 * Creates a new [`MultiThreadedLockableScore`] given an underlying [`Score`].
25363 MUST_USE_RES struct LDKMultiThreadedLockableScore MultiThreadedLockableScore_new(struct LDKScore score);
25366 * Frees any resources used by the FixedPenaltyScorer, if is_owned is set and inner is non-NULL.
25368 void FixedPenaltyScorer_free(struct LDKFixedPenaltyScorer this_obj);
25371 * Creates a copy of the FixedPenaltyScorer
25373 struct LDKFixedPenaltyScorer FixedPenaltyScorer_clone(const struct LDKFixedPenaltyScorer *NONNULL_PTR orig);
25376 * Creates a new scorer using `penalty_msat`.
25378 MUST_USE_RES struct LDKFixedPenaltyScorer FixedPenaltyScorer_with_penalty(uint64_t penalty_msat);
25381 * Constructs a new Score which calls the relevant methods on this_arg.
25382 * This copies the `inner` pointer in this_arg and thus the returned Score must be freed before this_arg is
25384 struct LDKScore FixedPenaltyScorer_as_Score(const struct LDKFixedPenaltyScorer *NONNULL_PTR this_arg);
25387 * Serialize the FixedPenaltyScorer object into a byte array which can be read by FixedPenaltyScorer_read
25389 struct LDKCVec_u8Z FixedPenaltyScorer_write(const struct LDKFixedPenaltyScorer *NONNULL_PTR obj);
25392 * Read a FixedPenaltyScorer from a byte array, created by FixedPenaltyScorer_write
25394 struct LDKCResult_FixedPenaltyScorerDecodeErrorZ FixedPenaltyScorer_read(struct LDKu8slice ser, uint64_t arg);
25397 * Frees any resources used by the Scorer, if is_owned is set and inner is non-NULL.
25399 void Scorer_free(struct LDKScorer this_obj);
25402 * Frees any resources used by the ScoringParameters, if is_owned is set and inner is non-NULL.
25404 void ScoringParameters_free(struct LDKScoringParameters this_obj);
25407 * A fixed penalty in msats to apply to each channel.
25409 * Default value: 500 msat
25411 uint64_t ScoringParameters_get_base_penalty_msat(const struct LDKScoringParameters *NONNULL_PTR this_ptr);
25414 * A fixed penalty in msats to apply to each channel.
25416 * Default value: 500 msat
25418 void ScoringParameters_set_base_penalty_msat(struct LDKScoringParameters *NONNULL_PTR this_ptr, uint64_t val);
25421 * A penalty in msats to apply to a channel upon failing to relay a payment.
25423 * This accumulates for each failure but may be reduced over time based on
25424 * [`failure_penalty_half_life`] or when successfully routing through a channel.
25426 * Default value: 1,024,000 msat
25428 * [`failure_penalty_half_life`]: Self::failure_penalty_half_life
25430 uint64_t ScoringParameters_get_failure_penalty_msat(const struct LDKScoringParameters *NONNULL_PTR this_ptr);
25433 * A penalty in msats to apply to a channel upon failing to relay a payment.
25435 * This accumulates for each failure but may be reduced over time based on
25436 * [`failure_penalty_half_life`] or when successfully routing through a channel.
25438 * Default value: 1,024,000 msat
25440 * [`failure_penalty_half_life`]: Self::failure_penalty_half_life
25442 void ScoringParameters_set_failure_penalty_msat(struct LDKScoringParameters *NONNULL_PTR this_ptr, uint64_t val);
25445 * When the amount being sent over a channel is this many 1024ths of the total channel
25446 * capacity, we begin applying [`overuse_penalty_msat_per_1024th`].
25448 * Default value: 128 1024ths (i.e. begin penalizing when an HTLC uses 1/8th of a channel)
25450 * [`overuse_penalty_msat_per_1024th`]: Self::overuse_penalty_msat_per_1024th
25452 uint16_t ScoringParameters_get_overuse_penalty_start_1024th(const struct LDKScoringParameters *NONNULL_PTR this_ptr);
25455 * When the amount being sent over a channel is this many 1024ths of the total channel
25456 * capacity, we begin applying [`overuse_penalty_msat_per_1024th`].
25458 * Default value: 128 1024ths (i.e. begin penalizing when an HTLC uses 1/8th of a channel)
25460 * [`overuse_penalty_msat_per_1024th`]: Self::overuse_penalty_msat_per_1024th
25462 void ScoringParameters_set_overuse_penalty_start_1024th(struct LDKScoringParameters *NONNULL_PTR this_ptr, uint16_t val);
25465 * A penalty applied, per whole 1024ths of the channel capacity which the amount being sent
25466 * over the channel exceeds [`overuse_penalty_start_1024th`] by.
25468 * Default value: 20 msat (i.e. 2560 msat penalty to use 1/4th of a channel, 7680 msat penalty
25469 * to use half a channel, and 12,560 msat penalty to use 3/4ths of a channel)
25471 * [`overuse_penalty_start_1024th`]: Self::overuse_penalty_start_1024th
25473 uint64_t ScoringParameters_get_overuse_penalty_msat_per_1024th(const struct LDKScoringParameters *NONNULL_PTR this_ptr);
25476 * A penalty applied, per whole 1024ths of the channel capacity which the amount being sent
25477 * over the channel exceeds [`overuse_penalty_start_1024th`] by.
25479 * Default value: 20 msat (i.e. 2560 msat penalty to use 1/4th of a channel, 7680 msat penalty
25480 * to use half a channel, and 12,560 msat penalty to use 3/4ths of a channel)
25482 * [`overuse_penalty_start_1024th`]: Self::overuse_penalty_start_1024th
25484 void ScoringParameters_set_overuse_penalty_msat_per_1024th(struct LDKScoringParameters *NONNULL_PTR this_ptr, uint64_t val);
25487 * The time required to elapse before any accumulated [`failure_penalty_msat`] penalties are
25490 * Successfully routing through a channel will immediately cut the penalty in half as well.
25492 * Default value: 1 hour
25496 * When built with the `no-std` feature, time will never elapse. Therefore, this penalty will
25499 * [`failure_penalty_msat`]: Self::failure_penalty_msat
25501 uint64_t ScoringParameters_get_failure_penalty_half_life(const struct LDKScoringParameters *NONNULL_PTR this_ptr);
25504 * The time required to elapse before any accumulated [`failure_penalty_msat`] penalties are
25507 * Successfully routing through a channel will immediately cut the penalty in half as well.
25509 * Default value: 1 hour
25513 * When built with the `no-std` feature, time will never elapse. Therefore, this penalty will
25516 * [`failure_penalty_msat`]: Self::failure_penalty_msat
25518 void ScoringParameters_set_failure_penalty_half_life(struct LDKScoringParameters *NONNULL_PTR this_ptr, uint64_t val);
25521 * Constructs a new ScoringParameters given each field
25523 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);
25526 * Creates a copy of the ScoringParameters
25528 struct LDKScoringParameters ScoringParameters_clone(const struct LDKScoringParameters *NONNULL_PTR orig);
25531 * Serialize the ScoringParameters object into a byte array which can be read by ScoringParameters_read
25533 struct LDKCVec_u8Z ScoringParameters_write(const struct LDKScoringParameters *NONNULL_PTR obj);
25536 * Read a ScoringParameters from a byte array, created by ScoringParameters_write
25538 struct LDKCResult_ScoringParametersDecodeErrorZ ScoringParameters_read(struct LDKu8slice ser);
25541 * Creates a new scorer using the given scoring parameters.
25543 MUST_USE_RES struct LDKScorer Scorer_new(struct LDKScoringParameters params);
25546 * Creates a "default" Scorer. See struct and individual field documentaiton for details on which values are used.
25548 MUST_USE_RES struct LDKScorer Scorer_default(void);
25551 * Creates a "default" ScoringParameters. See struct and individual field documentaiton for details on which values are used.
25553 MUST_USE_RES struct LDKScoringParameters ScoringParameters_default(void);
25556 * Constructs a new Score which calls the relevant methods on this_arg.
25557 * This copies the `inner` pointer in this_arg and thus the returned Score must be freed before this_arg is
25559 struct LDKScore Scorer_as_Score(const struct LDKScorer *NONNULL_PTR this_arg);
25562 * Serialize the Scorer object into a byte array which can be read by Scorer_read
25564 struct LDKCVec_u8Z Scorer_write(const struct LDKScorer *NONNULL_PTR obj);
25567 * Read a Scorer from a byte array, created by Scorer_write
25569 struct LDKCResult_ScorerDecodeErrorZ Scorer_read(struct LDKu8slice ser);
25572 * Frees any resources used by the ProbabilisticScorer, if is_owned is set and inner is non-NULL.
25574 void ProbabilisticScorer_free(struct LDKProbabilisticScorer this_obj);
25577 * Frees any resources used by the ProbabilisticScoringParameters, if is_owned is set and inner is non-NULL.
25579 void ProbabilisticScoringParameters_free(struct LDKProbabilisticScoringParameters this_obj);
25582 * A fixed penalty in msats to apply to each channel.
25584 * Default value: 500 msat
25586 uint64_t ProbabilisticScoringParameters_get_base_penalty_msat(const struct LDKProbabilisticScoringParameters *NONNULL_PTR this_ptr);
25589 * A fixed penalty in msats to apply to each channel.
25591 * Default value: 500 msat
25593 void ProbabilisticScoringParameters_set_base_penalty_msat(struct LDKProbabilisticScoringParameters *NONNULL_PTR this_ptr, uint64_t val);
25596 * A multiplier used in conjunction with the negative `log10` of the channel's success
25597 * probability for a payment to determine the liquidity penalty.
25599 * The penalty is based in part on the knowledge learned from prior successful and unsuccessful
25600 * payments. This knowledge is decayed over time based on [`liquidity_offset_half_life`]. The
25601 * penalty is effectively limited to `2 * liquidity_penalty_multiplier_msat` (corresponding to
25602 * lower bounding the success probability to `0.01`) when the amount falls within the
25603 * uncertainty bounds of the channel liquidity balance. Amounts above the upper bound will
25604 * result in a `u64::max_value` penalty, however.
25606 * Default value: 40,000 msat
25608 * [`liquidity_offset_half_life`]: Self::liquidity_offset_half_life
25610 uint64_t ProbabilisticScoringParameters_get_liquidity_penalty_multiplier_msat(const struct LDKProbabilisticScoringParameters *NONNULL_PTR this_ptr);
25613 * A multiplier used in conjunction with the negative `log10` of the channel's success
25614 * probability for a payment to determine the liquidity penalty.
25616 * The penalty is based in part on the knowledge learned from prior successful and unsuccessful
25617 * payments. This knowledge is decayed over time based on [`liquidity_offset_half_life`]. The
25618 * penalty is effectively limited to `2 * liquidity_penalty_multiplier_msat` (corresponding to
25619 * lower bounding the success probability to `0.01`) when the amount falls within the
25620 * uncertainty bounds of the channel liquidity balance. Amounts above the upper bound will
25621 * result in a `u64::max_value` penalty, however.
25623 * Default value: 40,000 msat
25625 * [`liquidity_offset_half_life`]: Self::liquidity_offset_half_life
25627 void ProbabilisticScoringParameters_set_liquidity_penalty_multiplier_msat(struct LDKProbabilisticScoringParameters *NONNULL_PTR this_ptr, uint64_t val);
25630 * The time required to elapse before any knowledge learned about channel liquidity balances is
25633 * The bounds are defined in terms of offsets and are initially zero. Increasing the offsets
25634 * gives tighter bounds on the channel liquidity balance. Thus, halving the offsets decreases
25635 * the certainty of the channel liquidity balance.
25637 * Default value: 1 hour
25641 * When built with the `no-std` feature, time will never elapse. Therefore, the channel
25642 * liquidity knowledge will never decay except when the bounds cross.
25644 uint64_t ProbabilisticScoringParameters_get_liquidity_offset_half_life(const struct LDKProbabilisticScoringParameters *NONNULL_PTR this_ptr);
25647 * The time required to elapse before any knowledge learned about channel liquidity balances is
25650 * The bounds are defined in terms of offsets and are initially zero. Increasing the offsets
25651 * gives tighter bounds on the channel liquidity balance. Thus, halving the offsets decreases
25652 * the certainty of the channel liquidity balance.
25654 * Default value: 1 hour
25658 * When built with the `no-std` feature, time will never elapse. Therefore, the channel
25659 * liquidity knowledge will never decay except when the bounds cross.
25661 void ProbabilisticScoringParameters_set_liquidity_offset_half_life(struct LDKProbabilisticScoringParameters *NONNULL_PTR this_ptr, uint64_t val);
25664 * A multiplier used in conjunction with a payment amount and the negative `log10` of the
25665 * channel's success probability for the payment to determine the amount penalty.
25667 * The purpose of the amount penalty is to avoid having fees dominate the channel cost (i.e.,
25668 * fees plus penalty) for large payments. The penalty is computed as the product of this
25669 * multiplier and `2^20`ths of the payment amount, weighted by the negative `log10` of the
25670 * success probability.
25672 * `-log10(success_probability) * amount_penalty_multiplier_msat * amount_msat / 2^20`
25674 * In practice, this means for 0.1 success probability (`-log10(0.1) == 1`) each `2^20`th of
25675 * the amount will result in a penalty of the multiplier. And, as the success probability
25676 * decreases, the negative `log10` weighting will increase dramatically. For higher success
25677 * probabilities, the multiplier will have a decreasing effect as the negative `log10` will
25680 * Default value: 256 msat
25682 uint64_t ProbabilisticScoringParameters_get_amount_penalty_multiplier_msat(const struct LDKProbabilisticScoringParameters *NONNULL_PTR this_ptr);
25685 * A multiplier used in conjunction with a payment amount and the negative `log10` of the
25686 * channel's success probability for the payment to determine the amount penalty.
25688 * The purpose of the amount penalty is to avoid having fees dominate the channel cost (i.e.,
25689 * fees plus penalty) for large payments. The penalty is computed as the product of this
25690 * multiplier and `2^20`ths of the payment amount, weighted by the negative `log10` of the
25691 * success probability.
25693 * `-log10(success_probability) * amount_penalty_multiplier_msat * amount_msat / 2^20`
25695 * In practice, this means for 0.1 success probability (`-log10(0.1) == 1`) each `2^20`th of
25696 * the amount will result in a penalty of the multiplier. And, as the success probability
25697 * decreases, the negative `log10` weighting will increase dramatically. For higher success
25698 * probabilities, the multiplier will have a decreasing effect as the negative `log10` will
25701 * Default value: 256 msat
25703 void ProbabilisticScoringParameters_set_amount_penalty_multiplier_msat(struct LDKProbabilisticScoringParameters *NONNULL_PTR this_ptr, uint64_t val);
25706 * Constructs a new ProbabilisticScoringParameters given each field
25708 MUST_USE_RES struct LDKProbabilisticScoringParameters ProbabilisticScoringParameters_new(uint64_t base_penalty_msat_arg, uint64_t liquidity_penalty_multiplier_msat_arg, uint64_t liquidity_offset_half_life_arg, uint64_t amount_penalty_multiplier_msat_arg);
25711 * Creates a copy of the ProbabilisticScoringParameters
25713 struct LDKProbabilisticScoringParameters ProbabilisticScoringParameters_clone(const struct LDKProbabilisticScoringParameters *NONNULL_PTR orig);
25716 * Creates a new scorer using the given scoring parameters for sending payments from a node
25717 * through a network graph.
25719 MUST_USE_RES struct LDKProbabilisticScorer ProbabilisticScorer_new(struct LDKProbabilisticScoringParameters params, const struct LDKNetworkGraph *NONNULL_PTR network_graph);
25722 * Creates a "default" ProbabilisticScoringParameters. See struct and individual field documentaiton for details on which values are used.
25724 MUST_USE_RES struct LDKProbabilisticScoringParameters ProbabilisticScoringParameters_default(void);
25727 * Constructs a new Score which calls the relevant methods on this_arg.
25728 * This copies the `inner` pointer in this_arg and thus the returned Score must be freed before this_arg is
25730 struct LDKScore ProbabilisticScorer_as_Score(const struct LDKProbabilisticScorer *NONNULL_PTR this_arg);
25733 * Serialize the ProbabilisticScorer object into a byte array which can be read by ProbabilisticScorer_read
25735 struct LDKCVec_u8Z ProbabilisticScorer_write(const struct LDKProbabilisticScorer *NONNULL_PTR obj);
25738 * Read a ProbabilisticScorer from a byte array, created by ProbabilisticScorer_write
25740 struct LDKCResult_ProbabilisticScorerDecodeErrorZ ProbabilisticScorer_read(struct LDKu8slice ser, struct LDKProbabilisticScoringParameters arg_a, const struct LDKNetworkGraph *NONNULL_PTR arg_b);
25743 * Frees any resources used by the FilesystemPersister, if is_owned is set and inner is non-NULL.
25745 void FilesystemPersister_free(struct LDKFilesystemPersister this_obj);
25748 * Initialize a new FilesystemPersister and set the path to the individual channels'
25751 MUST_USE_RES struct LDKFilesystemPersister FilesystemPersister_new(struct LDKStr path_to_channel_data);
25754 * Get the directory which was provided when this persister was initialized.
25756 MUST_USE_RES struct LDKStr FilesystemPersister_get_data_dir(const struct LDKFilesystemPersister *NONNULL_PTR this_arg);
25759 * Writes the provided `ChannelManager` to the path provided at `FilesystemPersister`
25760 * initialization, within a file called \"manager\".
25762 MUST_USE_RES struct LDKCResult_NoneErrorZ FilesystemPersister_persist_manager(struct LDKStr data_dir, const struct LDKChannelManager *NONNULL_PTR manager);
25765 * Write the provided `NetworkGraph` to the path provided at `FilesystemPersister`
25766 * initialization, within a file called \"network_graph\"
25768 MUST_USE_RES struct LDKCResult_NoneErrorZ FilesystemPersister_persist_network_graph(struct LDKStr data_dir, const struct LDKNetworkGraph *NONNULL_PTR network_graph);
25771 * Read `ChannelMonitor`s from disk.
25773 MUST_USE_RES struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ FilesystemPersister_read_channelmonitors(const struct LDKFilesystemPersister *NONNULL_PTR this_arg, struct LDKKeysInterface keys_manager);
25776 * Constructs a new Persist which calls the relevant methods on this_arg.
25777 * This copies the `inner` pointer in this_arg and thus the returned Persist must be freed before this_arg is
25779 struct LDKPersist FilesystemPersister_as_Persist(const struct LDKFilesystemPersister *NONNULL_PTR this_arg);
25782 * Frees any resources used by the BackgroundProcessor, if is_owned is set and inner is non-NULL.
25784 void BackgroundProcessor_free(struct LDKBackgroundProcessor this_obj);
25787 * Calls the free function if one is set
25789 void Persister_free(struct LDKPersister this_ptr);
25792 * Start a background thread that takes care of responsibilities enumerated in the [top-level
25795 * The thread runs indefinitely unless the object is dropped, [`stop`] is called, or
25796 * [`Persister::persist_manager`] returns an error. In case of an error, the error is retrieved by calling
25797 * either [`join`] or [`stop`].
25799 * # Data Persistence
25801 * [`Persister::persist_manager`] is responsible for writing out the [`ChannelManager`] to disk, and/or
25802 * uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
25803 * [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
25804 * provided implementation.
25806 * [`Persister::persist_graph`] is responsible for writing out the [`NetworkGraph`] to disk. See
25807 * [`NetworkGraph::write`] for writing out a [`NetworkGraph`]. See [`FilesystemPersister::persist_network_graph`]
25808 * for Rust-Lightning's provided implementation.
25810 * Typically, users should either implement [`Persister::persist_manager`] to never return an
25811 * error or call [`join`] and handle any error that may arise. For the latter case,
25812 * `BackgroundProcessor` must be restarted by calling `start` again after handling the error.
25816 * `event_handler` is responsible for handling events that users should be notified of (e.g.,
25817 * payment failed). [`BackgroundProcessor`] may decorate the given [`EventHandler`] with common
25818 * functionality implemented by other handlers.
25819 * * [`NetGraphMsgHandler`] if given will update the [`NetworkGraph`] based on payment failures.
25821 * [top-level documentation]: BackgroundProcessor
25822 * [`join`]: Self::join
25823 * [`stop`]: Self::stop
25824 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
25825 * [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
25826 * [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
25827 * [`FilesystemPersister::persist_network_graph`]: lightning_persister::FilesystemPersister::persist_network_graph
25828 * [`NetworkGraph`]: lightning::routing::network_graph::NetworkGraph
25829 * [`NetworkGraph::write`]: lightning::routing::network_graph::NetworkGraph#impl-Writeable
25831 * Note that net_graph_msg_handler (or a relevant inner pointer) may be NULL or all-0s to represent None
25833 MUST_USE_RES struct LDKBackgroundProcessor BackgroundProcessor_start(struct LDKPersister 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);
25836 * Join `BackgroundProcessor`'s thread, returning any error that occurred while persisting
25837 * [`ChannelManager`].
25841 * This function panics if the background thread has panicked such as while persisting or
25844 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
25846 MUST_USE_RES struct LDKCResult_NoneErrorZ BackgroundProcessor_join(struct LDKBackgroundProcessor this_arg);
25849 * Stop `BackgroundProcessor`'s thread, returning any error that occurred while persisting
25850 * [`ChannelManager`].
25854 * This function panics if the background thread has panicked such as while persisting or
25857 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
25859 MUST_USE_RES struct LDKCResult_NoneErrorZ BackgroundProcessor_stop(struct LDKBackgroundProcessor this_arg);
25862 * Frees any resources used by the Invoice, if is_owned is set and inner is non-NULL.
25864 void Invoice_free(struct LDKInvoice this_obj);
25867 * Checks if two Invoices contain equal inner contents.
25868 * This ignores pointers and is_owned flags and looks at the values in fields.
25869 * Two objects with NULL inner values will be considered "equal" here.
25871 bool Invoice_eq(const struct LDKInvoice *NONNULL_PTR a, const struct LDKInvoice *NONNULL_PTR b);
25874 * Creates a copy of the Invoice
25876 struct LDKInvoice Invoice_clone(const struct LDKInvoice *NONNULL_PTR orig);
25879 * Frees any resources used by the SignedRawInvoice, if is_owned is set and inner is non-NULL.
25881 void SignedRawInvoice_free(struct LDKSignedRawInvoice this_obj);
25884 * Checks if two SignedRawInvoices contain equal inner contents.
25885 * This ignores pointers and is_owned flags and looks at the values in fields.
25886 * Two objects with NULL inner values will be considered "equal" here.
25888 bool SignedRawInvoice_eq(const struct LDKSignedRawInvoice *NONNULL_PTR a, const struct LDKSignedRawInvoice *NONNULL_PTR b);
25891 * Creates a copy of the SignedRawInvoice
25893 struct LDKSignedRawInvoice SignedRawInvoice_clone(const struct LDKSignedRawInvoice *NONNULL_PTR orig);
25896 * Frees any resources used by the RawInvoice, if is_owned is set and inner is non-NULL.
25898 void RawInvoice_free(struct LDKRawInvoice this_obj);
25903 struct LDKRawDataPart RawInvoice_get_data(const struct LDKRawInvoice *NONNULL_PTR this_ptr);
25908 void RawInvoice_set_data(struct LDKRawInvoice *NONNULL_PTR this_ptr, struct LDKRawDataPart val);
25911 * Checks if two RawInvoices contain equal inner contents.
25912 * This ignores pointers and is_owned flags and looks at the values in fields.
25913 * Two objects with NULL inner values will be considered "equal" here.
25915 bool RawInvoice_eq(const struct LDKRawInvoice *NONNULL_PTR a, const struct LDKRawInvoice *NONNULL_PTR b);
25918 * Creates a copy of the RawInvoice
25920 struct LDKRawInvoice RawInvoice_clone(const struct LDKRawInvoice *NONNULL_PTR orig);
25923 * Frees any resources used by the RawDataPart, if is_owned is set and inner is non-NULL.
25925 void RawDataPart_free(struct LDKRawDataPart this_obj);
25928 * generation time of the invoice
25930 struct LDKPositiveTimestamp RawDataPart_get_timestamp(const struct LDKRawDataPart *NONNULL_PTR this_ptr);
25933 * generation time of the invoice
25935 void RawDataPart_set_timestamp(struct LDKRawDataPart *NONNULL_PTR this_ptr, struct LDKPositiveTimestamp val);
25938 * Checks if two RawDataParts contain equal inner contents.
25939 * This ignores pointers and is_owned flags and looks at the values in fields.
25940 * Two objects with NULL inner values will be considered "equal" here.
25942 bool RawDataPart_eq(const struct LDKRawDataPart *NONNULL_PTR a, const struct LDKRawDataPart *NONNULL_PTR b);
25945 * Creates a copy of the RawDataPart
25947 struct LDKRawDataPart RawDataPart_clone(const struct LDKRawDataPart *NONNULL_PTR orig);
25950 * Frees any resources used by the PositiveTimestamp, if is_owned is set and inner is non-NULL.
25952 void PositiveTimestamp_free(struct LDKPositiveTimestamp this_obj);
25955 * Checks if two PositiveTimestamps contain equal inner contents.
25956 * This ignores pointers and is_owned flags and looks at the values in fields.
25957 * Two objects with NULL inner values will be considered "equal" here.
25959 bool PositiveTimestamp_eq(const struct LDKPositiveTimestamp *NONNULL_PTR a, const struct LDKPositiveTimestamp *NONNULL_PTR b);
25962 * Creates a copy of the PositiveTimestamp
25964 struct LDKPositiveTimestamp PositiveTimestamp_clone(const struct LDKPositiveTimestamp *NONNULL_PTR orig);
25967 * Creates a copy of the SiPrefix
25969 enum LDKSiPrefix SiPrefix_clone(const enum LDKSiPrefix *NONNULL_PTR orig);
25972 * Utility method to constructs a new Milli-variant SiPrefix
25974 enum LDKSiPrefix SiPrefix_milli(void);
25977 * Utility method to constructs a new Micro-variant SiPrefix
25979 enum LDKSiPrefix SiPrefix_micro(void);
25982 * Utility method to constructs a new Nano-variant SiPrefix
25984 enum LDKSiPrefix SiPrefix_nano(void);
25987 * Utility method to constructs a new Pico-variant SiPrefix
25989 enum LDKSiPrefix SiPrefix_pico(void);
25992 * Checks if two SiPrefixs contain equal inner contents.
25993 * This ignores pointers and is_owned flags and looks at the values in fields.
25995 bool SiPrefix_eq(const enum LDKSiPrefix *NONNULL_PTR a, const enum LDKSiPrefix *NONNULL_PTR b);
25998 * Returns the multiplier to go from a BTC value to picoBTC implied by this SiPrefix.
25999 * This is effectively 10^12 * the prefix multiplier
26001 MUST_USE_RES uint64_t SiPrefix_multiplier(const enum LDKSiPrefix *NONNULL_PTR this_arg);
26004 * Creates a copy of the Currency
26006 enum LDKCurrency Currency_clone(const enum LDKCurrency *NONNULL_PTR orig);
26009 * Utility method to constructs a new Bitcoin-variant Currency
26011 enum LDKCurrency Currency_bitcoin(void);
26014 * Utility method to constructs a new BitcoinTestnet-variant Currency
26016 enum LDKCurrency Currency_bitcoin_testnet(void);
26019 * Utility method to constructs a new Regtest-variant Currency
26021 enum LDKCurrency Currency_regtest(void);
26024 * Utility method to constructs a new Simnet-variant Currency
26026 enum LDKCurrency Currency_simnet(void);
26029 * Utility method to constructs a new Signet-variant Currency
26031 enum LDKCurrency Currency_signet(void);
26034 * Checks if two Currencys contain equal inner contents.
26036 uint64_t Currency_hash(const enum LDKCurrency *NONNULL_PTR o);
26039 * Checks if two Currencys contain equal inner contents.
26040 * This ignores pointers and is_owned flags and looks at the values in fields.
26042 bool Currency_eq(const enum LDKCurrency *NONNULL_PTR a, const enum LDKCurrency *NONNULL_PTR b);
26045 * Frees any resources used by the Sha256, if is_owned is set and inner is non-NULL.
26047 void Sha256_free(struct LDKSha256 this_obj);
26050 * Creates a copy of the Sha256
26052 struct LDKSha256 Sha256_clone(const struct LDKSha256 *NONNULL_PTR orig);
26055 * Checks if two Sha256s contain equal inner contents.
26057 uint64_t Sha256_hash(const struct LDKSha256 *NONNULL_PTR o);
26060 * Checks if two Sha256s contain equal inner contents.
26061 * This ignores pointers and is_owned flags and looks at the values in fields.
26062 * Two objects with NULL inner values will be considered "equal" here.
26064 bool Sha256_eq(const struct LDKSha256 *NONNULL_PTR a, const struct LDKSha256 *NONNULL_PTR b);
26067 * Frees any resources used by the Description, if is_owned is set and inner is non-NULL.
26069 void Description_free(struct LDKDescription this_obj);
26072 * Creates a copy of the Description
26074 struct LDKDescription Description_clone(const struct LDKDescription *NONNULL_PTR orig);
26077 * Checks if two Descriptions contain equal inner contents.
26079 uint64_t Description_hash(const struct LDKDescription *NONNULL_PTR o);
26082 * Checks if two Descriptions contain equal inner contents.
26083 * This ignores pointers and is_owned flags and looks at the values in fields.
26084 * Two objects with NULL inner values will be considered "equal" here.
26086 bool Description_eq(const struct LDKDescription *NONNULL_PTR a, const struct LDKDescription *NONNULL_PTR b);
26089 * Frees any resources used by the PayeePubKey, if is_owned is set and inner is non-NULL.
26091 void PayeePubKey_free(struct LDKPayeePubKey this_obj);
26093 struct LDKPublicKey PayeePubKey_get_a(const struct LDKPayeePubKey *NONNULL_PTR this_ptr);
26095 void PayeePubKey_set_a(struct LDKPayeePubKey *NONNULL_PTR this_ptr, struct LDKPublicKey val);
26098 * Constructs a new PayeePubKey given each field
26100 MUST_USE_RES struct LDKPayeePubKey PayeePubKey_new(struct LDKPublicKey a_arg);
26103 * Creates a copy of the PayeePubKey
26105 struct LDKPayeePubKey PayeePubKey_clone(const struct LDKPayeePubKey *NONNULL_PTR orig);
26108 * Checks if two PayeePubKeys contain equal inner contents.
26110 uint64_t PayeePubKey_hash(const struct LDKPayeePubKey *NONNULL_PTR o);
26113 * Checks if two PayeePubKeys contain equal inner contents.
26114 * This ignores pointers and is_owned flags and looks at the values in fields.
26115 * Two objects with NULL inner values will be considered "equal" here.
26117 bool PayeePubKey_eq(const struct LDKPayeePubKey *NONNULL_PTR a, const struct LDKPayeePubKey *NONNULL_PTR b);
26120 * Frees any resources used by the ExpiryTime, if is_owned is set and inner is non-NULL.
26122 void ExpiryTime_free(struct LDKExpiryTime this_obj);
26125 * Creates a copy of the ExpiryTime
26127 struct LDKExpiryTime ExpiryTime_clone(const struct LDKExpiryTime *NONNULL_PTR orig);
26130 * Checks if two ExpiryTimes contain equal inner contents.
26132 uint64_t ExpiryTime_hash(const struct LDKExpiryTime *NONNULL_PTR o);
26135 * Checks if two ExpiryTimes contain equal inner contents.
26136 * This ignores pointers and is_owned flags and looks at the values in fields.
26137 * Two objects with NULL inner values will be considered "equal" here.
26139 bool ExpiryTime_eq(const struct LDKExpiryTime *NONNULL_PTR a, const struct LDKExpiryTime *NONNULL_PTR b);
26142 * Frees any resources used by the MinFinalCltvExpiry, if is_owned is set and inner is non-NULL.
26144 void MinFinalCltvExpiry_free(struct LDKMinFinalCltvExpiry this_obj);
26146 uint64_t MinFinalCltvExpiry_get_a(const struct LDKMinFinalCltvExpiry *NONNULL_PTR this_ptr);
26148 void MinFinalCltvExpiry_set_a(struct LDKMinFinalCltvExpiry *NONNULL_PTR this_ptr, uint64_t val);
26151 * Constructs a new MinFinalCltvExpiry given each field
26153 MUST_USE_RES struct LDKMinFinalCltvExpiry MinFinalCltvExpiry_new(uint64_t a_arg);
26156 * Creates a copy of the MinFinalCltvExpiry
26158 struct LDKMinFinalCltvExpiry MinFinalCltvExpiry_clone(const struct LDKMinFinalCltvExpiry *NONNULL_PTR orig);
26161 * Checks if two MinFinalCltvExpirys contain equal inner contents.
26163 uint64_t MinFinalCltvExpiry_hash(const struct LDKMinFinalCltvExpiry *NONNULL_PTR o);
26166 * Checks if two MinFinalCltvExpirys contain equal inner contents.
26167 * This ignores pointers and is_owned flags and looks at the values in fields.
26168 * Two objects with NULL inner values will be considered "equal" here.
26170 bool MinFinalCltvExpiry_eq(const struct LDKMinFinalCltvExpiry *NONNULL_PTR a, const struct LDKMinFinalCltvExpiry *NONNULL_PTR b);
26173 * Frees any resources used by the Fallback
26175 void Fallback_free(struct LDKFallback this_ptr);
26178 * Creates a copy of the Fallback
26180 struct LDKFallback Fallback_clone(const struct LDKFallback *NONNULL_PTR orig);
26183 * Utility method to constructs a new SegWitProgram-variant Fallback
26185 struct LDKFallback Fallback_seg_wit_program(struct LDKu5 version, struct LDKCVec_u8Z program);
26188 * Utility method to constructs a new PubKeyHash-variant Fallback
26190 struct LDKFallback Fallback_pub_key_hash(struct LDKTwentyBytes a);
26193 * Utility method to constructs a new ScriptHash-variant Fallback
26195 struct LDKFallback Fallback_script_hash(struct LDKTwentyBytes a);
26198 * Checks if two Fallbacks contain equal inner contents.
26200 uint64_t Fallback_hash(const struct LDKFallback *NONNULL_PTR o);
26203 * Checks if two Fallbacks contain equal inner contents.
26204 * This ignores pointers and is_owned flags and looks at the values in fields.
26206 bool Fallback_eq(const struct LDKFallback *NONNULL_PTR a, const struct LDKFallback *NONNULL_PTR b);
26209 * Frees any resources used by the InvoiceSignature, if is_owned is set and inner is non-NULL.
26211 void InvoiceSignature_free(struct LDKInvoiceSignature this_obj);
26214 * Creates a copy of the InvoiceSignature
26216 struct LDKInvoiceSignature InvoiceSignature_clone(const struct LDKInvoiceSignature *NONNULL_PTR orig);
26219 * Checks if two InvoiceSignatures contain equal inner contents.
26220 * This ignores pointers and is_owned flags and looks at the values in fields.
26221 * Two objects with NULL inner values will be considered "equal" here.
26223 bool InvoiceSignature_eq(const struct LDKInvoiceSignature *NONNULL_PTR a, const struct LDKInvoiceSignature *NONNULL_PTR b);
26226 * Frees any resources used by the PrivateRoute, if is_owned is set and inner is non-NULL.
26228 void PrivateRoute_free(struct LDKPrivateRoute this_obj);
26231 * Creates a copy of the PrivateRoute
26233 struct LDKPrivateRoute PrivateRoute_clone(const struct LDKPrivateRoute *NONNULL_PTR orig);
26236 * Checks if two PrivateRoutes contain equal inner contents.
26238 uint64_t PrivateRoute_hash(const struct LDKPrivateRoute *NONNULL_PTR o);
26241 * Checks if two PrivateRoutes contain equal inner contents.
26242 * This ignores pointers and is_owned flags and looks at the values in fields.
26243 * Two objects with NULL inner values will be considered "equal" here.
26245 bool PrivateRoute_eq(const struct LDKPrivateRoute *NONNULL_PTR a, const struct LDKPrivateRoute *NONNULL_PTR b);
26248 * Disassembles the `SignedRawInvoice` into its three parts:
26250 * 2. hash of the raw invoice
26253 MUST_USE_RES struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ SignedRawInvoice_into_parts(struct LDKSignedRawInvoice this_arg);
26256 * The `RawInvoice` which was signed.
26258 MUST_USE_RES struct LDKRawInvoice SignedRawInvoice_raw_invoice(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
26261 * The hash of the `RawInvoice` that was signed.
26263 MUST_USE_RES const uint8_t (*SignedRawInvoice_hash(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg))[32];
26266 * InvoiceSignature for the invoice.
26268 MUST_USE_RES struct LDKInvoiceSignature SignedRawInvoice_signature(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
26271 * Recovers the public key used for signing the invoice from the recoverable signature.
26273 MUST_USE_RES struct LDKCResult_PayeePubKeyErrorZ SignedRawInvoice_recover_payee_pub_key(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
26276 * Checks if the signature is valid for the included payee public key or if none exists if it's
26277 * valid for the recovered signature (which should always be true?).
26279 MUST_USE_RES bool SignedRawInvoice_check_signature(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
26282 * Calculate the hash of the encoded `RawInvoice`
26284 MUST_USE_RES struct LDKThirtyTwoBytes RawInvoice_hash(const struct LDKRawInvoice *NONNULL_PTR this_arg);
26288 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
26290 MUST_USE_RES struct LDKSha256 RawInvoice_payment_hash(const struct LDKRawInvoice *NONNULL_PTR this_arg);
26294 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
26296 MUST_USE_RES struct LDKDescription RawInvoice_description(const struct LDKRawInvoice *NONNULL_PTR this_arg);
26300 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
26302 MUST_USE_RES struct LDKPayeePubKey RawInvoice_payee_pub_key(const struct LDKRawInvoice *NONNULL_PTR this_arg);
26306 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
26308 MUST_USE_RES struct LDKSha256 RawInvoice_description_hash(const struct LDKRawInvoice *NONNULL_PTR this_arg);
26312 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
26314 MUST_USE_RES struct LDKExpiryTime RawInvoice_expiry_time(const struct LDKRawInvoice *NONNULL_PTR this_arg);
26318 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
26320 MUST_USE_RES struct LDKMinFinalCltvExpiry RawInvoice_min_final_cltv_expiry(const struct LDKRawInvoice *NONNULL_PTR this_arg);
26324 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
26326 MUST_USE_RES struct LDKThirtyTwoBytes RawInvoice_payment_secret(const struct LDKRawInvoice *NONNULL_PTR this_arg);
26330 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
26332 MUST_USE_RES struct LDKInvoiceFeatures RawInvoice_features(const struct LDKRawInvoice *NONNULL_PTR this_arg);
26334 MUST_USE_RES struct LDKCVec_PrivateRouteZ RawInvoice_private_routes(const struct LDKRawInvoice *NONNULL_PTR this_arg);
26336 MUST_USE_RES struct LDKCOption_u64Z RawInvoice_amount_pico_btc(const struct LDKRawInvoice *NONNULL_PTR this_arg);
26338 MUST_USE_RES enum LDKCurrency RawInvoice_currency(const struct LDKRawInvoice *NONNULL_PTR this_arg);
26341 * Creates a `PositiveTimestamp` from a Unix timestamp in the range `0..=MAX_TIMESTAMP`.
26343 * Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
26345 MUST_USE_RES struct LDKCResult_PositiveTimestampCreationErrorZ PositiveTimestamp_from_unix_timestamp(uint64_t unix_seconds);
26348 * Creates a `PositiveTimestamp` from a [`SystemTime`] with a corresponding Unix timestamp in
26349 * the range `0..=MAX_TIMESTAMP`.
26351 * Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
26353 MUST_USE_RES struct LDKCResult_PositiveTimestampCreationErrorZ PositiveTimestamp_from_system_time(uint64_t time);
26356 * Creates a `PositiveTimestamp` from a [`Duration`] since the Unix epoch in the range
26357 * `0..=MAX_TIMESTAMP`.
26359 * Otherwise, returns a [`CreationError::TimestampOutOfBounds`].
26361 MUST_USE_RES struct LDKCResult_PositiveTimestampCreationErrorZ PositiveTimestamp_from_duration_since_epoch(uint64_t duration);
26364 * Returns the Unix timestamp representing the stored time
26366 MUST_USE_RES uint64_t PositiveTimestamp_as_unix_timestamp(const struct LDKPositiveTimestamp *NONNULL_PTR this_arg);
26369 * Returns the duration of the stored time since the Unix epoch
26371 MUST_USE_RES uint64_t PositiveTimestamp_as_duration_since_epoch(const struct LDKPositiveTimestamp *NONNULL_PTR this_arg);
26374 * Returns the [`SystemTime`] representing the stored time
26376 MUST_USE_RES uint64_t PositiveTimestamp_as_time(const struct LDKPositiveTimestamp *NONNULL_PTR this_arg);
26379 * Transform the `Invoice` into it's unchecked version
26381 MUST_USE_RES struct LDKSignedRawInvoice Invoice_into_signed_raw(struct LDKInvoice this_arg);
26384 * Check that the invoice is signed correctly and that key recovery works
26386 MUST_USE_RES struct LDKCResult_NoneSemanticErrorZ Invoice_check_signature(const struct LDKInvoice *NONNULL_PTR this_arg);
26389 * Constructs an `Invoice` from a `SignedRawInvoice` by checking all its invariants.
26391 * use lightning_invoice::*;
26393 * let invoice = \"lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\\
26394 * h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\\
26395 * 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\\
26396 * h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\\
26397 * j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\\
26398 * ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\\
26399 * guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\\
26400 * ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\\
26401 * p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\\
26402 * 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\\
26403 * j5r6drg6k6zcqj0fcwg\";
26405 * let signed = invoice.parse::<SignedRawInvoice>().unwrap();
26407 * assert!(Invoice::from_signed(signed).is_ok());
26410 MUST_USE_RES struct LDKCResult_InvoiceSemanticErrorZ Invoice_from_signed(struct LDKSignedRawInvoice signed_invoice);
26413 * Returns the `Invoice`'s timestamp (should equal its creation time)
26415 MUST_USE_RES uint64_t Invoice_timestamp(const struct LDKInvoice *NONNULL_PTR this_arg);
26418 * Returns the `Invoice`'s timestamp as a duration since the Unix epoch
26420 MUST_USE_RES uint64_t Invoice_duration_since_epoch(const struct LDKInvoice *NONNULL_PTR this_arg);
26423 * Returns the hash to which we will receive the preimage on completion of the payment
26425 MUST_USE_RES const uint8_t (*Invoice_payment_hash(const struct LDKInvoice *NONNULL_PTR this_arg))[32];
26428 * Get the payee's public key if one was included in the invoice
26430 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
26432 MUST_USE_RES struct LDKPublicKey Invoice_payee_pub_key(const struct LDKInvoice *NONNULL_PTR this_arg);
26435 * Get the payment secret if one was included in the invoice
26437 MUST_USE_RES const uint8_t (*Invoice_payment_secret(const struct LDKInvoice *NONNULL_PTR this_arg))[32];
26440 * Get the invoice features if they were included in the invoice
26442 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
26444 MUST_USE_RES struct LDKInvoiceFeatures Invoice_features(const struct LDKInvoice *NONNULL_PTR this_arg);
26447 * Recover the payee's public key (only to be used if none was included in the invoice)
26449 MUST_USE_RES struct LDKPublicKey Invoice_recover_payee_pub_key(const struct LDKInvoice *NONNULL_PTR this_arg);
26452 * Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
26454 MUST_USE_RES uint64_t Invoice_expiry_time(const struct LDKInvoice *NONNULL_PTR this_arg);
26457 * Returns whether the invoice has expired.
26459 MUST_USE_RES bool Invoice_is_expired(const struct LDKInvoice *NONNULL_PTR this_arg);
26462 * Returns whether the expiry time would pass at the given point in time.
26463 * `at_time` is the timestamp as a duration since the Unix epoch.
26465 MUST_USE_RES bool Invoice_would_expire(const struct LDKInvoice *NONNULL_PTR this_arg, uint64_t at_time);
26468 * Returns the invoice's `min_final_cltv_expiry` time, if present, otherwise
26469 * [`DEFAULT_MIN_FINAL_CLTV_EXPIRY`].
26471 MUST_USE_RES uint64_t Invoice_min_final_cltv_expiry(const struct LDKInvoice *NONNULL_PTR this_arg);
26474 * Returns a list of all routes included in the invoice
26476 MUST_USE_RES struct LDKCVec_PrivateRouteZ Invoice_private_routes(const struct LDKInvoice *NONNULL_PTR this_arg);
26479 * Returns a list of all routes included in the invoice as the underlying hints
26481 MUST_USE_RES struct LDKCVec_RouteHintZ Invoice_route_hints(const struct LDKInvoice *NONNULL_PTR this_arg);
26484 * Returns the currency for which the invoice was issued
26486 MUST_USE_RES enum LDKCurrency Invoice_currency(const struct LDKInvoice *NONNULL_PTR this_arg);
26489 * Returns the amount if specified in the invoice as millisatoshis.
26491 MUST_USE_RES struct LDKCOption_u64Z Invoice_amount_milli_satoshis(const struct LDKInvoice *NONNULL_PTR this_arg);
26494 * Creates a new `Description` if `description` is at most 1023 __bytes__ long,
26495 * returns `CreationError::DescriptionTooLong` otherwise
26497 * Please note that single characters may use more than one byte due to UTF8 encoding.
26499 MUST_USE_RES struct LDKCResult_DescriptionCreationErrorZ Description_new(struct LDKStr description);
26502 * Returns the underlying description `String`
26504 MUST_USE_RES struct LDKStr Description_into_inner(struct LDKDescription this_arg);
26507 * Construct an `ExpiryTime` from seconds.
26509 MUST_USE_RES struct LDKExpiryTime ExpiryTime_from_seconds(uint64_t seconds);
26512 * Construct an `ExpiryTime` from a `Duration`.
26514 MUST_USE_RES struct LDKExpiryTime ExpiryTime_from_duration(uint64_t duration);
26517 * Returns the expiry time in seconds
26519 MUST_USE_RES uint64_t ExpiryTime_as_seconds(const struct LDKExpiryTime *NONNULL_PTR this_arg);
26522 * Returns a reference to the underlying `Duration` (=expiry time)
26524 MUST_USE_RES uint64_t ExpiryTime_as_duration(const struct LDKExpiryTime *NONNULL_PTR this_arg);
26527 * Creates a new (partial) route from a list of hops
26529 MUST_USE_RES struct LDKCResult_PrivateRouteCreationErrorZ PrivateRoute_new(struct LDKRouteHint hops);
26532 * Returns the underlying list of hops
26534 MUST_USE_RES struct LDKRouteHint PrivateRoute_into_inner(struct LDKPrivateRoute this_arg);
26537 * Creates a copy of the CreationError
26539 enum LDKCreationError CreationError_clone(const enum LDKCreationError *NONNULL_PTR orig);
26542 * Utility method to constructs a new DescriptionTooLong-variant CreationError
26544 enum LDKCreationError CreationError_description_too_long(void);
26547 * Utility method to constructs a new RouteTooLong-variant CreationError
26549 enum LDKCreationError CreationError_route_too_long(void);
26552 * Utility method to constructs a new TimestampOutOfBounds-variant CreationError
26554 enum LDKCreationError CreationError_timestamp_out_of_bounds(void);
26557 * Utility method to constructs a new InvalidAmount-variant CreationError
26559 enum LDKCreationError CreationError_invalid_amount(void);
26562 * Utility method to constructs a new MissingRouteHints-variant CreationError
26564 enum LDKCreationError CreationError_missing_route_hints(void);
26567 * Checks if two CreationErrors contain equal inner contents.
26568 * This ignores pointers and is_owned flags and looks at the values in fields.
26570 bool CreationError_eq(const enum LDKCreationError *NONNULL_PTR a, const enum LDKCreationError *NONNULL_PTR b);
26573 * Get the string representation of a CreationError object
26575 struct LDKStr CreationError_to_str(const enum LDKCreationError *NONNULL_PTR o);
26578 * Creates a copy of the SemanticError
26580 enum LDKSemanticError SemanticError_clone(const enum LDKSemanticError *NONNULL_PTR orig);
26583 * Utility method to constructs a new NoPaymentHash-variant SemanticError
26585 enum LDKSemanticError SemanticError_no_payment_hash(void);
26588 * Utility method to constructs a new MultiplePaymentHashes-variant SemanticError
26590 enum LDKSemanticError SemanticError_multiple_payment_hashes(void);
26593 * Utility method to constructs a new NoDescription-variant SemanticError
26595 enum LDKSemanticError SemanticError_no_description(void);
26598 * Utility method to constructs a new MultipleDescriptions-variant SemanticError
26600 enum LDKSemanticError SemanticError_multiple_descriptions(void);
26603 * Utility method to constructs a new NoPaymentSecret-variant SemanticError
26605 enum LDKSemanticError SemanticError_no_payment_secret(void);
26608 * Utility method to constructs a new MultiplePaymentSecrets-variant SemanticError
26610 enum LDKSemanticError SemanticError_multiple_payment_secrets(void);
26613 * Utility method to constructs a new InvalidFeatures-variant SemanticError
26615 enum LDKSemanticError SemanticError_invalid_features(void);
26618 * Utility method to constructs a new InvalidRecoveryId-variant SemanticError
26620 enum LDKSemanticError SemanticError_invalid_recovery_id(void);
26623 * Utility method to constructs a new InvalidSignature-variant SemanticError
26625 enum LDKSemanticError SemanticError_invalid_signature(void);
26628 * Utility method to constructs a new ImpreciseAmount-variant SemanticError
26630 enum LDKSemanticError SemanticError_imprecise_amount(void);
26633 * Checks if two SemanticErrors contain equal inner contents.
26634 * This ignores pointers and is_owned flags and looks at the values in fields.
26636 bool SemanticError_eq(const enum LDKSemanticError *NONNULL_PTR a, const enum LDKSemanticError *NONNULL_PTR b);
26639 * Get the string representation of a SemanticError object
26641 struct LDKStr SemanticError_to_str(const enum LDKSemanticError *NONNULL_PTR o);
26644 * Frees any resources used by the SignOrCreationError
26646 void SignOrCreationError_free(struct LDKSignOrCreationError this_ptr);
26649 * Creates a copy of the SignOrCreationError
26651 struct LDKSignOrCreationError SignOrCreationError_clone(const struct LDKSignOrCreationError *NONNULL_PTR orig);
26654 * Utility method to constructs a new SignError-variant SignOrCreationError
26656 struct LDKSignOrCreationError SignOrCreationError_sign_error(void);
26659 * Utility method to constructs a new CreationError-variant SignOrCreationError
26661 struct LDKSignOrCreationError SignOrCreationError_creation_error(enum LDKCreationError a);
26664 * Checks if two SignOrCreationErrors contain equal inner contents.
26665 * This ignores pointers and is_owned flags and looks at the values in fields.
26667 bool SignOrCreationError_eq(const struct LDKSignOrCreationError *NONNULL_PTR a, const struct LDKSignOrCreationError *NONNULL_PTR b);
26670 * Get the string representation of a SignOrCreationError object
26672 struct LDKStr SignOrCreationError_to_str(const struct LDKSignOrCreationError *NONNULL_PTR o);
26675 * Frees any resources used by the InvoicePayer, if is_owned is set and inner is non-NULL.
26677 void InvoicePayer_free(struct LDKInvoicePayer this_obj);
26680 * Calls the free function if one is set
26682 void Payer_free(struct LDKPayer this_ptr);
26685 * Calls the free function if one is set
26687 void Router_free(struct LDKRouter this_ptr);
26690 * Frees any resources used by the RetryAttempts, if is_owned is set and inner is non-NULL.
26692 void RetryAttempts_free(struct LDKRetryAttempts this_obj);
26694 uintptr_t RetryAttempts_get_a(const struct LDKRetryAttempts *NONNULL_PTR this_ptr);
26696 void RetryAttempts_set_a(struct LDKRetryAttempts *NONNULL_PTR this_ptr, uintptr_t val);
26699 * Constructs a new RetryAttempts given each field
26701 MUST_USE_RES struct LDKRetryAttempts RetryAttempts_new(uintptr_t a_arg);
26704 * Creates a copy of the RetryAttempts
26706 struct LDKRetryAttempts RetryAttempts_clone(const struct LDKRetryAttempts *NONNULL_PTR orig);
26709 * Checks if two RetryAttemptss contain equal inner contents.
26710 * This ignores pointers and is_owned flags and looks at the values in fields.
26711 * Two objects with NULL inner values will be considered "equal" here.
26713 bool RetryAttempts_eq(const struct LDKRetryAttempts *NONNULL_PTR a, const struct LDKRetryAttempts *NONNULL_PTR b);
26716 * Checks if two RetryAttemptss contain equal inner contents.
26718 uint64_t RetryAttempts_hash(const struct LDKRetryAttempts *NONNULL_PTR o);
26721 * Frees any resources used by the PaymentError
26723 void PaymentError_free(struct LDKPaymentError this_ptr);
26726 * Creates a copy of the PaymentError
26728 struct LDKPaymentError PaymentError_clone(const struct LDKPaymentError *NONNULL_PTR orig);
26731 * Utility method to constructs a new Invoice-variant PaymentError
26733 struct LDKPaymentError PaymentError_invoice(struct LDKStr a);
26736 * Utility method to constructs a new Routing-variant PaymentError
26738 struct LDKPaymentError PaymentError_routing(struct LDKLightningError a);
26741 * Utility method to constructs a new Sending-variant PaymentError
26743 struct LDKPaymentError PaymentError_sending(struct LDKPaymentSendFailure a);
26746 * Creates an invoice payer that retries failed payment paths.
26748 * Will forward any [`Event::PaymentPathFailed`] events to the decorated `event_handler` once
26749 * `retry_attempts` has been exceeded for a given [`Invoice`].
26751 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);
26754 * Pays the given [`Invoice`], caching it for later use in case a retry is needed.
26756 * You should ensure that the `invoice.payment_hash()` is unique and the same payment_hash has
26757 * never been paid before. Because [`InvoicePayer`] is stateless no effort is made to do so
26760 MUST_USE_RES struct LDKCResult_PaymentIdPaymentErrorZ InvoicePayer_pay_invoice(const struct LDKInvoicePayer *NONNULL_PTR this_arg, const struct LDKInvoice *NONNULL_PTR invoice);
26763 * Pays the given zero-value [`Invoice`] using the given amount, caching it for later use in
26764 * case a retry is needed.
26766 * You should ensure that the `invoice.payment_hash()` is unique and the same payment_hash has
26767 * never been paid before. Because [`InvoicePayer`] is stateless no effort is made to do so
26770 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);
26773 * Pays `pubkey` an amount using the hash of the given preimage, caching it for later use in
26774 * case a retry is needed.
26776 * You should ensure that `payment_preimage` is unique and that its `payment_hash` has never
26777 * been paid before. Because [`InvoicePayer`] is stateless no effort is made to do so for you.
26779 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);
26782 * Removes the payment cached by the given payment hash.
26784 * Should be called once a payment has failed or succeeded if not using [`InvoicePayer`] as an
26785 * [`EventHandler`]. Otherwise, calling this method is unnecessary.
26787 void InvoicePayer_remove_cached_payment(const struct LDKInvoicePayer *NONNULL_PTR this_arg, const uint8_t (*payment_hash)[32]);
26790 * Constructs a new EventHandler which calls the relevant methods on this_arg.
26791 * This copies the `inner` pointer in this_arg and thus the returned EventHandler must be freed before this_arg is
26793 struct LDKEventHandler InvoicePayer_as_EventHandler(const struct LDKInvoicePayer *NONNULL_PTR this_arg);
26796 * Utility to create an invoice that can be paid to one of multiple nodes, or a \"phantom invoice.\"
26797 * See [`PhantomKeysManager`] for more information on phantom node payments.
26799 * `phantom_route_hints` parameter:
26800 * * Contains channel info for all nodes participating in the phantom invoice
26801 * * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each
26802 * participating node
26803 * * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is
26804 * updated when a channel becomes disabled or closes
26805 * * Note that if too many channels are included in [`PhantomRouteHints::channels`], the invoice
26806 * may be too long for QR code scanning. To fix this, `PhantomRouteHints::channels` may be pared
26809 * `payment_hash` and `payment_secret` come from [`ChannelManager::create_inbound_payment`] or
26810 * [`ChannelManager::create_inbound_payment_for_hash`]. These values can be retrieved from any
26811 * participating node.
26813 * Note that the provided `keys_manager`'s `KeysInterface` implementation must support phantom
26814 * invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
26817 * [`PhantomKeysManager`]: lightning::chain::keysinterface::PhantomKeysManager
26818 * [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints
26819 * [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels
26821 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);
26824 * Utility to create an invoice that can be paid to one of multiple nodes, or a \"phantom invoice.\"
26825 * See [`PhantomKeysManager`] for more information on phantom node payments.
26827 * `phantom_route_hints` parameter:
26828 * * Contains channel info for all nodes participating in the phantom invoice
26829 * * Entries are retrieved from a call to [`ChannelManager::get_phantom_route_hints`] on each
26830 * participating node
26831 * * It is fine to cache `phantom_route_hints` and reuse it across invoices, as long as the data is
26832 * updated when a channel becomes disabled or closes
26833 * * Note that if too many channels are included in [`PhantomRouteHints::channels`], the invoice
26834 * may be too long for QR code scanning. To fix this, `PhantomRouteHints::channels` may be pared
26837 * `description_hash` is a SHA-256 hash of the description text
26839 * `payment_hash` and `payment_secret` come from [`ChannelManager::create_inbound_payment`] or
26840 * [`ChannelManager::create_inbound_payment_for_hash`]. These values can be retrieved from any
26841 * participating node.
26843 * Note that the provided `keys_manager`'s `KeysInterface` implementation must support phantom
26844 * invoices in its `sign_invoice` implementation ([`PhantomKeysManager`] satisfies this
26847 * [`PhantomKeysManager`]: lightning::chain::keysinterface::PhantomKeysManager
26848 * [`ChannelManager::get_phantom_route_hints`]: lightning::ln::channelmanager::ChannelManager::get_phantom_route_hints
26849 * [`PhantomRouteHints::channels`]: lightning::ln::channelmanager::PhantomRouteHints::channels
26851 struct LDKCResult_InvoiceSignOrCreationErrorZ create_phantom_invoice_with_description_hash(struct LDKCOption_u64Z amt_msat, struct LDKSha256 description_hash, struct LDKThirtyTwoBytes payment_hash, struct LDKThirtyTwoBytes payment_secret, struct LDKCVec_PhantomRouteHintsZ phantom_route_hints, struct LDKKeysInterface keys_manager, enum LDKCurrency network);
26854 * Utility to construct an invoice. Generally, unless you want to do something like a custom
26855 * cltv_expiry, this is what you should be using to create an invoice. The reason being, this
26856 * method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
26857 * doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
26858 * that the payment secret is valid when the invoice is paid.
26860 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);
26863 * Utility to construct an invoice. Generally, unless you want to do something like a custom
26864 * cltv_expiry, this is what you should be using to create an invoice. The reason being, this
26865 * method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
26866 * doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
26867 * that the payment secret is valid when the invoice is paid.
26868 * Use this variant if you want to pass the `description_hash` to the invoice.
26870 struct LDKCResult_InvoiceSignOrCreationErrorZ create_invoice_from_channelmanager_with_description_hash(const struct LDKChannelManager *NONNULL_PTR channelmanager, struct LDKKeysInterface keys_manager, enum LDKCurrency network, struct LDKCOption_u64Z amt_msat, struct LDKSha256 description_hash);
26873 * See [`create_invoice_from_channelmanager_with_description_hash`]
26874 * This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
26875 * available and the current time is supplied by the caller.
26877 struct LDKCResult_InvoiceSignOrCreationErrorZ create_invoice_from_channelmanager_with_description_hash_and_duration_since_epoch(const struct LDKChannelManager *NONNULL_PTR channelmanager, struct LDKKeysInterface keys_manager, enum LDKCurrency network, struct LDKCOption_u64Z amt_msat, struct LDKSha256 description_hash, uint64_t duration_since_epoch);
26880 * See [`create_invoice_from_channelmanager`]
26881 * This version can be used in a `no_std` environment, where [`std::time::SystemTime`] is not
26882 * available and the current time is supplied by the caller.
26884 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);
26887 * Frees any resources used by the DefaultRouter, if is_owned is set and inner is non-NULL.
26889 void DefaultRouter_free(struct LDKDefaultRouter this_obj);
26892 * Creates a new router using the given [`NetworkGraph`], a [`Logger`], and a randomness source
26893 * `random_seed_bytes`.
26895 MUST_USE_RES struct LDKDefaultRouter DefaultRouter_new(const struct LDKNetworkGraph *NONNULL_PTR network_graph, struct LDKLogger logger, struct LDKThirtyTwoBytes random_seed_bytes);
26898 * Constructs a new Router which calls the relevant methods on this_arg.
26899 * This copies the `inner` pointer in this_arg and thus the returned Router must be freed before this_arg is
26901 struct LDKRouter DefaultRouter_as_Router(const struct LDKDefaultRouter *NONNULL_PTR this_arg);
26904 * Constructs a new Payer which calls the relevant methods on this_arg.
26905 * This copies the `inner` pointer in this_arg and thus the returned Payer must be freed before this_arg is
26907 struct LDKPayer ChannelManager_as_Payer(const struct LDKChannelManager *NONNULL_PTR this_arg);
26910 * Read a SiPrefix object from a string
26912 struct LDKCResult_SiPrefixNoneZ SiPrefix_from_str(struct LDKStr s);
26915 * Read a Invoice object from a string
26917 struct LDKCResult_InvoiceNoneZ Invoice_from_str(struct LDKStr s);
26920 * Read a SignedRawInvoice object from a string
26922 struct LDKCResult_SignedRawInvoiceNoneZ SignedRawInvoice_from_str(struct LDKStr s);
26925 * Get the string representation of a Invoice object
26927 struct LDKStr Invoice_to_str(const struct LDKInvoice *NONNULL_PTR o);
26930 * Get the string representation of a SignedRawInvoice object
26932 struct LDKStr SignedRawInvoice_to_str(const struct LDKSignedRawInvoice *NONNULL_PTR o);
26935 * Get the string representation of a Currency object
26937 struct LDKStr Currency_to_str(const enum LDKCurrency *NONNULL_PTR o);
26940 * Get the string representation of a SiPrefix object
26942 struct LDKStr SiPrefix_to_str(const enum LDKSiPrefix *NONNULL_PTR o);
26944 #endif /* LDK_C_BINDINGS_H */
26946 #include "ldk_ver.h"