1 #ifndef LDK_C_BINDINGS_H
2 #define LDK_C_BINDINGS_H
4 /* Generated with cbindgen:0.19.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 error enum representing a failure to persist a channel monitor update.
34 typedef enum LDKChannelMonitorUpdateErr {
36 * Used to indicate a temporary failure (eg connection to a watchtower or remote backup of
37 * our state failed, but is expected to succeed at some point in the future).
39 * Such a failure will \"freeze\" a channel, preventing us from revoking old states or
40 * submitting new commitment transactions to the counterparty. Once the update(s) which failed
41 * have been successfully applied, ChannelManager::channel_monitor_updated can be used to
42 * restore the channel to an operational state.
44 * Note that a given ChannelManager will *never* re-generate a given ChannelMonitorUpdate. If
45 * you return a TemporaryFailure you must ensure that it is written to disk safely before
46 * writing out the latest ChannelManager state.
48 * Even when a channel has been \"frozen\" updates to the ChannelMonitor can continue to occur
49 * (eg if an inbound HTLC which we forwarded was claimed upstream resulting in us attempting
50 * to claim it on this channel) and those updates must be applied wherever they can be. At
51 * least one such updated ChannelMonitor must be persisted otherwise PermanentFailure should
52 * be returned to get things on-chain ASAP using only the in-memory copy. Obviously updates to
53 * the channel which would invalidate previous ChannelMonitors are not made when a channel has
56 * Note that even if updates made after TemporaryFailure succeed you must still call
57 * channel_monitor_updated to ensure you have the latest monitor and re-enable normal channel
60 * Note that the update being processed here will not be replayed for you when you call
61 * ChannelManager::channel_monitor_updated, so you must store the update itself along
62 * with the persisted ChannelMonitor on your own local disk prior to returning a
63 * TemporaryFailure. You may, of course, employ a journaling approach, storing only the
64 * ChannelMonitorUpdate on disk without updating the monitor itself, replaying the journal at
67 * For deployments where a copy of ChannelMonitors and other local state are backed up in a
68 * remote location (with local copies persisted immediately), it is anticipated that all
69 * updates will return TemporaryFailure until the remote copies could be updated.
71 LDKChannelMonitorUpdateErr_TemporaryFailure,
73 * Used to indicate no further channel monitor updates will be allowed (eg we've moved on to a
74 * different watchtower and cannot update with all watchtowers that were previously informed
77 * At reception of this error, ChannelManager will force-close the channel and return at
78 * least a final ChannelMonitorUpdate::ChannelForceClosed which must be delivered to at
79 * least one ChannelMonitor copy. Revocation secret MUST NOT be released and offchain channel
80 * update must be rejected.
82 * This failure may also signal a failure to update the local persisted copy of one of
83 * the channel monitor instance.
85 * Note that even when you fail a holder commitment transaction update, you must store the
86 * update to ensure you can claim from it in case of a duplicate copy of this ChannelMonitor
87 * broadcasts it (e.g distributed channel-monitor deployment)
89 * In case of distributed watchtowers deployment, the new version must be written to disk, as
90 * state may have been stored but rejected due to a block forcing a commitment broadcast. This
91 * storage is used to claim outputs of rejected state confirmed onchain by another watchtower,
92 * lagging behind on block processing.
94 LDKChannelMonitorUpdateErr_PermanentFailure,
96 * Must be last for serialization purposes
98 LDKChannelMonitorUpdateErr_Sentinel,
99 } LDKChannelMonitorUpdateErr;
102 * An enum that represents the speed at which we want a transaction to confirm used for feerate
105 typedef enum LDKConfirmationTarget {
107 * We are happy with this transaction confirming slowly when feerate drops some.
109 LDKConfirmationTarget_Background,
111 * We'd like this transaction to confirm without major delay, but 12-18 blocks is fine.
113 LDKConfirmationTarget_Normal,
115 * We'd like this transaction to confirm in the next few blocks.
117 LDKConfirmationTarget_HighPriority,
119 * Must be last for serialization purposes
121 LDKConfirmationTarget_Sentinel,
122 } LDKConfirmationTarget;
125 * Errors that may occur when constructing a new `RawInvoice` or `Invoice`
127 typedef enum LDKCreationError {
129 * The supplied description string was longer than 639 __bytes__ (see [`Description::new(…)`](./struct.Description.html#method.new))
131 LDKCreationError_DescriptionTooLong,
133 * The specified route has too many hops and can't be encoded
135 LDKCreationError_RouteTooLong,
137 * The unix timestamp of the supplied date is <0 or can't be represented as `SystemTime`
139 LDKCreationError_TimestampOutOfBounds,
141 * The supplied expiry time could cause an overflow if added to a `PositiveTimestamp`
143 LDKCreationError_ExpiryTimeOutOfBounds,
145 * Must be last for serialization purposes
147 LDKCreationError_Sentinel,
151 * Enum representing the crypto currencies (or networks) supported by this library
153 typedef enum LDKCurrency {
161 LDKCurrency_BitcoinTestnet,
167 * Bitcoin simnet/signet
171 * Must be last for serialization purposes
173 LDKCurrency_Sentinel,
177 * Represents an IO Error. Note that some information is lost in the conversion from Rust.
179 typedef enum LDKIOError {
181 LDKIOError_PermissionDenied,
182 LDKIOError_ConnectionRefused,
183 LDKIOError_ConnectionReset,
184 LDKIOError_ConnectionAborted,
185 LDKIOError_NotConnected,
186 LDKIOError_AddrInUse,
187 LDKIOError_AddrNotAvailable,
188 LDKIOError_BrokenPipe,
189 LDKIOError_AlreadyExists,
190 LDKIOError_WouldBlock,
191 LDKIOError_InvalidInput,
192 LDKIOError_InvalidData,
194 LDKIOError_WriteZero,
195 LDKIOError_Interrupted,
197 LDKIOError_UnexpectedEof,
199 * Must be last for serialization purposes
205 * An enum representing the available verbosity levels of the logger.
207 typedef enum LDKLevel {
209 *Designates logger being silent
213 * Designates very serious errors
217 * Designates hazardous situations
221 * Designates useful information
225 * Designates lower priority information
229 * Designates very low priority, often extremely verbose, information
233 * Must be last for serialization purposes
239 * An enum representing the possible Bitcoin or test networks which we can run on
241 typedef enum LDKNetwork {
243 * The main Bitcoin blockchain.
247 * The testnet3 blockchain.
251 * A local test blockchain.
255 * A blockchain on which blocks are signed instead of mined.
259 * Must be last for serialization purposes
265 * Represents an error returned from libsecp256k1 during validation of some secp256k1 data
267 typedef enum LDKSecp256k1Error {
269 * Signature failed verification
271 LDKSecp256k1Error_IncorrectSignature,
273 * Badly sized message ("messages" are actually fixed-sized digests; see the MESSAGE_SIZE constant)
275 LDKSecp256k1Error_InvalidMessage,
279 LDKSecp256k1Error_InvalidPublicKey,
283 LDKSecp256k1Error_InvalidSignature,
287 LDKSecp256k1Error_InvalidSecretKey,
291 LDKSecp256k1Error_InvalidRecoveryId,
293 * Invalid tweak for add_assign or mul_assign
295 LDKSecp256k1Error_InvalidTweak,
297 * tweak_add_check failed on an xonly public key
299 LDKSecp256k1Error_TweakCheckFailed,
301 * Didn't pass enough memory to context creation with preallocated memory
303 LDKSecp256k1Error_NotEnoughMemory,
305 * Must be last for serialization purposes
307 LDKSecp256k1Error_Sentinel,
311 * Errors that may occur when converting a `RawInvoice` to an `Invoice`. They relate to the
312 * requirements sections in BOLT #11
314 typedef enum LDKSemanticError {
316 * The invoice is missing the mandatory payment hash
318 LDKSemanticError_NoPaymentHash,
320 * The invoice has multiple payment hashes which isn't allowed
322 LDKSemanticError_MultiplePaymentHashes,
324 * No description or description hash are part of the invoice
326 LDKSemanticError_NoDescription,
328 * The invoice contains multiple descriptions and/or description hashes which isn't allowed
330 LDKSemanticError_MultipleDescriptions,
332 * The invoice contains multiple payment secrets
334 LDKSemanticError_MultiplePaymentSecrets,
336 * The invoice's features are invalid
338 LDKSemanticError_InvalidFeatures,
340 * The recovery id doesn't fit the signature/pub key
342 LDKSemanticError_InvalidRecoveryId,
344 * The invoice's signature is invalid
346 LDKSemanticError_InvalidSignature,
348 * Must be last for serialization purposes
350 LDKSemanticError_Sentinel,
354 * SI prefixes for the human readable part
356 typedef enum LDKSiPrefix {
374 * Must be last for serialization purposes
376 LDKSiPrefix_Sentinel,
380 * A Rust str object, ie a reference to a UTF8-valid string.
381 * This is *not* null-terminated so cannot be used directly as a C string!
383 typedef struct LDKStr {
385 * A pointer to the string's bytes, in UTF8 encoding
387 const uint8_t *chars;
389 * The number of bytes (not characters!) pointed to by `chars`
393 * Whether the data pointed to by `chars` should be freed or not.
399 * A serialized transaction, in (pointer, length) form.
401 * This type optionally owns its own memory, and thus the semantics around access change based on
402 * the `data_is_owned` flag. If `data_is_owned` is set, you must call `Transaction_free` to free
403 * the underlying buffer before the object goes out of scope. If `data_is_owned` is not set, any
404 * access to the buffer after the scope in which the object was provided to you is invalid. eg,
405 * access after you return from the call in which a `!data_is_owned` `Transaction` is provided to
406 * you would be invalid.
408 * Note that, while it may change in the future, because transactions on the Rust side are stored
409 * in a deserialized form, all `Transaction`s generated on the Rust side will have `data_is_owned`
410 * set. Similarly, while it may change in the future, all `Transaction`s you pass to Rust may have
411 * `data_is_owned` either set or unset at your discretion.
413 typedef struct LDKTransaction {
415 * The serialized transaction data.
417 * This is non-const for your convenience, an object passed to Rust is never written to.
421 * The length of the serialized transaction
425 * Whether the data pointed to by `data` should be freed or not.
431 * A dynamically-allocated array of u8s of arbitrary size.
432 * This corresponds to std::vector in C++
434 typedef struct LDKCVec_u8Z {
436 * The elements in the array.
437 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
441 * The number of elements pointed to by `data`.
447 * A transaction output including a scriptPubKey and value.
448 * This type *does* own its own memory, so must be free'd appropriately.
450 typedef struct LDKTxOut {
452 * The script_pubkey in this output
454 struct LDKCVec_u8Z script_pubkey;
456 * The value, in satoshis, of this output
462 * Represents a valid secp256k1 secret key serialized as a 32 byte array.
464 typedef struct LDKSecretKey {
466 * The bytes of the secret key
472 * The contents of CResult_SecretKeyErrorZ
474 typedef union LDKCResult_SecretKeyErrorZPtr {
476 * A pointer to the contents in the success state.
477 * Reading from this pointer when `result_ok` is not set is undefined.
479 struct LDKSecretKey *result;
481 * A pointer to the contents in the error state.
482 * Reading from this pointer when `result_ok` is set is undefined.
484 enum LDKSecp256k1Error *err;
485 } LDKCResult_SecretKeyErrorZPtr;
488 * A CResult_SecretKeyErrorZ represents the result of a fallible operation,
489 * containing a crate::c_types::SecretKey on success and a crate::c_types::Secp256k1Error on failure.
490 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
492 typedef struct LDKCResult_SecretKeyErrorZ {
494 * The contents of this CResult_SecretKeyErrorZ, accessible via either
495 * `err` or `result` depending on the state of `result_ok`.
497 union LDKCResult_SecretKeyErrorZPtr contents;
499 * Whether this CResult_SecretKeyErrorZ represents a success state.
502 } LDKCResult_SecretKeyErrorZ;
505 * Represents a valid secp256k1 public key serialized in "compressed form" as a 33 byte array.
507 typedef struct LDKPublicKey {
509 * The bytes of the public key
511 uint8_t compressed_form[33];
515 * The contents of CResult_PublicKeyErrorZ
517 typedef union LDKCResult_PublicKeyErrorZPtr {
519 * A pointer to the contents in the success state.
520 * Reading from this pointer when `result_ok` is not set is undefined.
522 struct LDKPublicKey *result;
524 * A pointer to the contents in the error state.
525 * Reading from this pointer when `result_ok` is set is undefined.
527 enum LDKSecp256k1Error *err;
528 } LDKCResult_PublicKeyErrorZPtr;
531 * A CResult_PublicKeyErrorZ represents the result of a fallible operation,
532 * containing a crate::c_types::PublicKey on success and a crate::c_types::Secp256k1Error on failure.
533 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
535 typedef struct LDKCResult_PublicKeyErrorZ {
537 * The contents of this CResult_PublicKeyErrorZ, accessible via either
538 * `err` or `result` depending on the state of `result_ok`.
540 union LDKCResult_PublicKeyErrorZPtr contents;
542 * Whether this CResult_PublicKeyErrorZ represents a success state.
545 } LDKCResult_PublicKeyErrorZ;
550 * The set of public keys which are used in the creation of one commitment transaction.
551 * These are derived from the channel base keys and per-commitment data.
553 * A broadcaster key is provided from potential broadcaster of the computed transaction.
554 * A countersignatory key is coming from a protocol participant unable to broadcast the
557 * These keys are assumed to be good, either because the code derived them from
558 * channel basepoints via the new function, or they were obtained via
559 * CommitmentTransaction.trust().keys() because we trusted the source of the
560 * pre-calculated keys.
562 typedef struct MUST_USE_STRUCT LDKTxCreationKeys {
564 * A pointer to the opaque Rust object.
565 * Nearly everywhere, inner must be non-null, however in places where
566 * the Rust equivalent takes an Option, it may be set to null to indicate None.
568 LDKnativeTxCreationKeys *inner;
570 * Indicates that this is the only struct which contains the same pointer.
571 * Rust functions which take ownership of an object provided via an argument require
572 * this to be true and invalidate the object pointed to by inner.
580 * An error in decoding a message or struct.
582 typedef struct MUST_USE_STRUCT LDKDecodeError {
584 * A pointer to the opaque Rust object.
585 * Nearly everywhere, inner must be non-null, however in places where
586 * the Rust equivalent takes an Option, it may be set to null to indicate None.
588 LDKnativeDecodeError *inner;
590 * Indicates that this is the only struct which contains the same pointer.
591 * Rust functions which take ownership of an object provided via an argument require
592 * this to be true and invalidate the object pointed to by inner.
598 * The contents of CResult_TxCreationKeysDecodeErrorZ
600 typedef union LDKCResult_TxCreationKeysDecodeErrorZPtr {
602 * A pointer to the contents in the success state.
603 * Reading from this pointer when `result_ok` is not set is undefined.
605 struct LDKTxCreationKeys *result;
607 * A pointer to the contents in the error state.
608 * Reading from this pointer when `result_ok` is set is undefined.
610 struct LDKDecodeError *err;
611 } LDKCResult_TxCreationKeysDecodeErrorZPtr;
614 * A CResult_TxCreationKeysDecodeErrorZ represents the result of a fallible operation,
615 * containing a crate::lightning::ln::chan_utils::TxCreationKeys on success and a crate::lightning::ln::msgs::DecodeError on failure.
616 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
618 typedef struct LDKCResult_TxCreationKeysDecodeErrorZ {
620 * The contents of this CResult_TxCreationKeysDecodeErrorZ, accessible via either
621 * `err` or `result` depending on the state of `result_ok`.
623 union LDKCResult_TxCreationKeysDecodeErrorZPtr contents;
625 * Whether this CResult_TxCreationKeysDecodeErrorZ represents a success state.
628 } LDKCResult_TxCreationKeysDecodeErrorZ;
633 * One counterparty's public keys which do not change over the life of a channel.
635 typedef struct MUST_USE_STRUCT LDKChannelPublicKeys {
637 * A pointer to the opaque Rust object.
638 * Nearly everywhere, inner must be non-null, however in places where
639 * the Rust equivalent takes an Option, it may be set to null to indicate None.
641 LDKnativeChannelPublicKeys *inner;
643 * Indicates that this is the only struct which contains the same pointer.
644 * Rust functions which take ownership of an object provided via an argument require
645 * this to be true and invalidate the object pointed to by inner.
648 } LDKChannelPublicKeys;
651 * The contents of CResult_ChannelPublicKeysDecodeErrorZ
653 typedef union LDKCResult_ChannelPublicKeysDecodeErrorZPtr {
655 * A pointer to the contents in the success state.
656 * Reading from this pointer when `result_ok` is not set is undefined.
658 struct LDKChannelPublicKeys *result;
660 * A pointer to the contents in the error state.
661 * Reading from this pointer when `result_ok` is set is undefined.
663 struct LDKDecodeError *err;
664 } LDKCResult_ChannelPublicKeysDecodeErrorZPtr;
667 * A CResult_ChannelPublicKeysDecodeErrorZ represents the result of a fallible operation,
668 * containing a crate::lightning::ln::chan_utils::ChannelPublicKeys on success and a crate::lightning::ln::msgs::DecodeError on failure.
669 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
671 typedef struct LDKCResult_ChannelPublicKeysDecodeErrorZ {
673 * The contents of this CResult_ChannelPublicKeysDecodeErrorZ, accessible via either
674 * `err` or `result` depending on the state of `result_ok`.
676 union LDKCResult_ChannelPublicKeysDecodeErrorZPtr contents;
678 * Whether this CResult_ChannelPublicKeysDecodeErrorZ represents a success state.
681 } LDKCResult_ChannelPublicKeysDecodeErrorZ;
684 * The contents of CResult_TxCreationKeysErrorZ
686 typedef union LDKCResult_TxCreationKeysErrorZPtr {
688 * A pointer to the contents in the success state.
689 * Reading from this pointer when `result_ok` is not set is undefined.
691 struct LDKTxCreationKeys *result;
693 * A pointer to the contents in the error state.
694 * Reading from this pointer when `result_ok` is set is undefined.
696 enum LDKSecp256k1Error *err;
697 } LDKCResult_TxCreationKeysErrorZPtr;
700 * A CResult_TxCreationKeysErrorZ represents the result of a fallible operation,
701 * containing a crate::lightning::ln::chan_utils::TxCreationKeys on success and a crate::c_types::Secp256k1Error on failure.
702 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
704 typedef struct LDKCResult_TxCreationKeysErrorZ {
706 * The contents of this CResult_TxCreationKeysErrorZ, accessible via either
707 * `err` or `result` depending on the state of `result_ok`.
709 union LDKCResult_TxCreationKeysErrorZPtr contents;
711 * Whether this CResult_TxCreationKeysErrorZ represents a success state.
714 } LDKCResult_TxCreationKeysErrorZ;
717 * An enum which can either contain a u32 or not
719 typedef enum LDKCOption_u32Z_Tag {
721 * When we're in this state, this COption_u32Z contains a u32
723 LDKCOption_u32Z_Some,
725 * When we're in this state, this COption_u32Z contains nothing
727 LDKCOption_u32Z_None,
729 * Must be last for serialization purposes
731 LDKCOption_u32Z_Sentinel,
732 } LDKCOption_u32Z_Tag;
734 typedef struct LDKCOption_u32Z {
735 LDKCOption_u32Z_Tag tag;
746 * Information about an HTLC as it appears in a commitment transaction
748 typedef struct MUST_USE_STRUCT LDKHTLCOutputInCommitment {
750 * A pointer to the opaque Rust object.
751 * Nearly everywhere, inner must be non-null, however in places where
752 * the Rust equivalent takes an Option, it may be set to null to indicate None.
754 LDKnativeHTLCOutputInCommitment *inner;
756 * Indicates that this is the only struct which contains the same pointer.
757 * Rust functions which take ownership of an object provided via an argument require
758 * this to be true and invalidate the object pointed to by inner.
761 } LDKHTLCOutputInCommitment;
764 * The contents of CResult_HTLCOutputInCommitmentDecodeErrorZ
766 typedef union LDKCResult_HTLCOutputInCommitmentDecodeErrorZPtr {
768 * A pointer to the contents in the success state.
769 * Reading from this pointer when `result_ok` is not set is undefined.
771 struct LDKHTLCOutputInCommitment *result;
773 * A pointer to the contents in the error state.
774 * Reading from this pointer when `result_ok` is set is undefined.
776 struct LDKDecodeError *err;
777 } LDKCResult_HTLCOutputInCommitmentDecodeErrorZPtr;
780 * A CResult_HTLCOutputInCommitmentDecodeErrorZ represents the result of a fallible operation,
781 * containing a crate::lightning::ln::chan_utils::HTLCOutputInCommitment on success and a crate::lightning::ln::msgs::DecodeError on failure.
782 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
784 typedef struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ {
786 * The contents of this CResult_HTLCOutputInCommitmentDecodeErrorZ, accessible via either
787 * `err` or `result` depending on the state of `result_ok`.
789 union LDKCResult_HTLCOutputInCommitmentDecodeErrorZPtr contents;
791 * Whether this CResult_HTLCOutputInCommitmentDecodeErrorZ represents a success state.
794 } LDKCResult_HTLCOutputInCommitmentDecodeErrorZ;
799 * Late-bound per-channel counterparty data used to build transactions.
801 typedef struct MUST_USE_STRUCT LDKCounterpartyChannelTransactionParameters {
803 * A pointer to the opaque Rust object.
804 * Nearly everywhere, inner must be non-null, however in places where
805 * the Rust equivalent takes an Option, it may be set to null to indicate None.
807 LDKnativeCounterpartyChannelTransactionParameters *inner;
809 * Indicates that this is the only struct which contains the same pointer.
810 * Rust functions which take ownership of an object provided via an argument require
811 * this to be true and invalidate the object pointed to by inner.
814 } LDKCounterpartyChannelTransactionParameters;
817 * The contents of CResult_CounterpartyChannelTransactionParametersDecodeErrorZ
819 typedef union LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZPtr {
821 * A pointer to the contents in the success state.
822 * Reading from this pointer when `result_ok` is not set is undefined.
824 struct LDKCounterpartyChannelTransactionParameters *result;
826 * A pointer to the contents in the error state.
827 * Reading from this pointer when `result_ok` is set is undefined.
829 struct LDKDecodeError *err;
830 } LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZPtr;
833 * A CResult_CounterpartyChannelTransactionParametersDecodeErrorZ represents the result of a fallible operation,
834 * containing a crate::lightning::ln::chan_utils::CounterpartyChannelTransactionParameters on success and a crate::lightning::ln::msgs::DecodeError on failure.
835 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
837 typedef struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ {
839 * The contents of this CResult_CounterpartyChannelTransactionParametersDecodeErrorZ, accessible via either
840 * `err` or `result` depending on the state of `result_ok`.
842 union LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZPtr contents;
844 * Whether this CResult_CounterpartyChannelTransactionParametersDecodeErrorZ represents a success state.
847 } LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ;
852 * Per-channel data used to build transactions in conjunction with the per-commitment data (CommitmentTransaction).
853 * The fields are organized by holder/counterparty.
855 * Normally, this is converted to the broadcaster/countersignatory-organized DirectedChannelTransactionParameters
856 * before use, via the as_holder_broadcastable and as_counterparty_broadcastable functions.
858 typedef struct MUST_USE_STRUCT LDKChannelTransactionParameters {
860 * A pointer to the opaque Rust object.
861 * Nearly everywhere, inner must be non-null, however in places where
862 * the Rust equivalent takes an Option, it may be set to null to indicate None.
864 LDKnativeChannelTransactionParameters *inner;
866 * Indicates that this is the only struct which contains the same pointer.
867 * Rust functions which take ownership of an object provided via an argument require
868 * this to be true and invalidate the object pointed to by inner.
871 } LDKChannelTransactionParameters;
874 * The contents of CResult_ChannelTransactionParametersDecodeErrorZ
876 typedef union LDKCResult_ChannelTransactionParametersDecodeErrorZPtr {
878 * A pointer to the contents in the success state.
879 * Reading from this pointer when `result_ok` is not set is undefined.
881 struct LDKChannelTransactionParameters *result;
883 * A pointer to the contents in the error state.
884 * Reading from this pointer when `result_ok` is set is undefined.
886 struct LDKDecodeError *err;
887 } LDKCResult_ChannelTransactionParametersDecodeErrorZPtr;
890 * A CResult_ChannelTransactionParametersDecodeErrorZ represents the result of a fallible operation,
891 * containing a crate::lightning::ln::chan_utils::ChannelTransactionParameters on success and a crate::lightning::ln::msgs::DecodeError on failure.
892 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
894 typedef struct LDKCResult_ChannelTransactionParametersDecodeErrorZ {
896 * The contents of this CResult_ChannelTransactionParametersDecodeErrorZ, accessible via either
897 * `err` or `result` depending on the state of `result_ok`.
899 union LDKCResult_ChannelTransactionParametersDecodeErrorZPtr contents;
901 * Whether this CResult_ChannelTransactionParametersDecodeErrorZ represents a success state.
904 } LDKCResult_ChannelTransactionParametersDecodeErrorZ;
907 * Represents a secp256k1 signature serialized as two 32-byte numbers
909 typedef struct LDKSignature {
911 * The bytes of the signature in "compact" form
913 uint8_t compact_form[64];
917 * A dynamically-allocated array of crate::c_types::Signatures of arbitrary size.
918 * This corresponds to std::vector in C++
920 typedef struct LDKCVec_SignatureZ {
922 * The elements in the array.
923 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
925 struct LDKSignature *data;
927 * The number of elements pointed to by `data`.
930 } LDKCVec_SignatureZ;
935 * Information needed to build and sign a holder's commitment transaction.
937 * The transaction is only signed once we are ready to broadcast.
939 typedef struct MUST_USE_STRUCT LDKHolderCommitmentTransaction {
941 * A pointer to the opaque Rust object.
942 * Nearly everywhere, inner must be non-null, however in places where
943 * the Rust equivalent takes an Option, it may be set to null to indicate None.
945 LDKnativeHolderCommitmentTransaction *inner;
947 * Indicates that this is the only struct which contains the same pointer.
948 * Rust functions which take ownership of an object provided via an argument require
949 * this to be true and invalidate the object pointed to by inner.
952 } LDKHolderCommitmentTransaction;
955 * The contents of CResult_HolderCommitmentTransactionDecodeErrorZ
957 typedef union LDKCResult_HolderCommitmentTransactionDecodeErrorZPtr {
959 * A pointer to the contents in the success state.
960 * Reading from this pointer when `result_ok` is not set is undefined.
962 struct LDKHolderCommitmentTransaction *result;
964 * A pointer to the contents in the error state.
965 * Reading from this pointer when `result_ok` is set is undefined.
967 struct LDKDecodeError *err;
968 } LDKCResult_HolderCommitmentTransactionDecodeErrorZPtr;
971 * A CResult_HolderCommitmentTransactionDecodeErrorZ represents the result of a fallible operation,
972 * containing a crate::lightning::ln::chan_utils::HolderCommitmentTransaction on success and a crate::lightning::ln::msgs::DecodeError on failure.
973 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
975 typedef struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ {
977 * The contents of this CResult_HolderCommitmentTransactionDecodeErrorZ, accessible via either
978 * `err` or `result` depending on the state of `result_ok`.
980 union LDKCResult_HolderCommitmentTransactionDecodeErrorZPtr contents;
982 * Whether this CResult_HolderCommitmentTransactionDecodeErrorZ represents a success state.
985 } LDKCResult_HolderCommitmentTransactionDecodeErrorZ;
990 * A pre-built Bitcoin commitment transaction and its txid.
992 typedef struct MUST_USE_STRUCT LDKBuiltCommitmentTransaction {
994 * A pointer to the opaque Rust object.
995 * Nearly everywhere, inner must be non-null, however in places where
996 * the Rust equivalent takes an Option, it may be set to null to indicate None.
998 LDKnativeBuiltCommitmentTransaction *inner;
1000 * Indicates that this is the only struct which contains the same pointer.
1001 * Rust functions which take ownership of an object provided via an argument require
1002 * this to be true and invalidate the object pointed to by inner.
1005 } LDKBuiltCommitmentTransaction;
1008 * The contents of CResult_BuiltCommitmentTransactionDecodeErrorZ
1010 typedef union LDKCResult_BuiltCommitmentTransactionDecodeErrorZPtr {
1012 * A pointer to the contents in the success state.
1013 * Reading from this pointer when `result_ok` is not set is undefined.
1015 struct LDKBuiltCommitmentTransaction *result;
1017 * A pointer to the contents in the error state.
1018 * Reading from this pointer when `result_ok` is set is undefined.
1020 struct LDKDecodeError *err;
1021 } LDKCResult_BuiltCommitmentTransactionDecodeErrorZPtr;
1024 * A CResult_BuiltCommitmentTransactionDecodeErrorZ represents the result of a fallible operation,
1025 * containing a crate::lightning::ln::chan_utils::BuiltCommitmentTransaction on success and a crate::lightning::ln::msgs::DecodeError on failure.
1026 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1028 typedef struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ {
1030 * The contents of this CResult_BuiltCommitmentTransactionDecodeErrorZ, accessible via either
1031 * `err` or `result` depending on the state of `result_ok`.
1033 union LDKCResult_BuiltCommitmentTransactionDecodeErrorZPtr contents;
1035 * Whether this CResult_BuiltCommitmentTransactionDecodeErrorZ represents a success state.
1038 } LDKCResult_BuiltCommitmentTransactionDecodeErrorZ;
1043 * This class tracks the per-transaction information needed to build a commitment transaction and to
1044 * actually build it and sign. It is used for holder transactions that we sign only when needed
1045 * and for transactions we sign for the counterparty.
1047 * This class can be used inside a signer implementation to generate a signature given the relevant
1050 typedef struct MUST_USE_STRUCT LDKCommitmentTransaction {
1052 * A pointer to the opaque Rust object.
1053 * Nearly everywhere, inner must be non-null, however in places where
1054 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1056 LDKnativeCommitmentTransaction *inner;
1058 * Indicates that this is the only struct which contains the same pointer.
1059 * Rust functions which take ownership of an object provided via an argument require
1060 * this to be true and invalidate the object pointed to by inner.
1063 } LDKCommitmentTransaction;
1066 * The contents of CResult_CommitmentTransactionDecodeErrorZ
1068 typedef union LDKCResult_CommitmentTransactionDecodeErrorZPtr {
1070 * A pointer to the contents in the success state.
1071 * Reading from this pointer when `result_ok` is not set is undefined.
1073 struct LDKCommitmentTransaction *result;
1075 * A pointer to the contents in the error state.
1076 * Reading from this pointer when `result_ok` is set is undefined.
1078 struct LDKDecodeError *err;
1079 } LDKCResult_CommitmentTransactionDecodeErrorZPtr;
1082 * A CResult_CommitmentTransactionDecodeErrorZ represents the result of a fallible operation,
1083 * containing a crate::lightning::ln::chan_utils::CommitmentTransaction on success and a crate::lightning::ln::msgs::DecodeError on failure.
1084 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1086 typedef struct LDKCResult_CommitmentTransactionDecodeErrorZ {
1088 * The contents of this CResult_CommitmentTransactionDecodeErrorZ, accessible via either
1089 * `err` or `result` depending on the state of `result_ok`.
1091 union LDKCResult_CommitmentTransactionDecodeErrorZPtr contents;
1093 * Whether this CResult_CommitmentTransactionDecodeErrorZ represents a success state.
1096 } LDKCResult_CommitmentTransactionDecodeErrorZ;
1101 * A wrapper on CommitmentTransaction indicating that the derived fields (the built bitcoin
1102 * transaction and the transaction creation keys) are trusted.
1104 * See trust() and verify() functions on CommitmentTransaction.
1106 * This structure implements Deref.
1108 typedef struct MUST_USE_STRUCT LDKTrustedCommitmentTransaction {
1110 * A pointer to the opaque Rust object.
1111 * Nearly everywhere, inner must be non-null, however in places where
1112 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1114 LDKnativeTrustedCommitmentTransaction *inner;
1116 * Indicates that this is the only struct which contains the same pointer.
1117 * Rust functions which take ownership of an object provided via an argument require
1118 * this to be true and invalidate the object pointed to by inner.
1121 } LDKTrustedCommitmentTransaction;
1124 * The contents of CResult_TrustedCommitmentTransactionNoneZ
1126 typedef union LDKCResult_TrustedCommitmentTransactionNoneZPtr {
1128 * A pointer to the contents in the success state.
1129 * Reading from this pointer when `result_ok` is not set is undefined.
1131 struct LDKTrustedCommitmentTransaction *result;
1133 * Note that this value is always NULL, as there are no contents in the Err variant
1136 } LDKCResult_TrustedCommitmentTransactionNoneZPtr;
1139 * A CResult_TrustedCommitmentTransactionNoneZ represents the result of a fallible operation,
1140 * containing a crate::lightning::ln::chan_utils::TrustedCommitmentTransaction on success and a () on failure.
1141 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1143 typedef struct LDKCResult_TrustedCommitmentTransactionNoneZ {
1145 * The contents of this CResult_TrustedCommitmentTransactionNoneZ, accessible via either
1146 * `err` or `result` depending on the state of `result_ok`.
1148 union LDKCResult_TrustedCommitmentTransactionNoneZPtr contents;
1150 * Whether this CResult_TrustedCommitmentTransactionNoneZ represents a success state.
1153 } LDKCResult_TrustedCommitmentTransactionNoneZ;
1156 * The contents of CResult_CVec_SignatureZNoneZ
1158 typedef union LDKCResult_CVec_SignatureZNoneZPtr {
1160 * A pointer to the contents in the success state.
1161 * Reading from this pointer when `result_ok` is not set is undefined.
1163 struct LDKCVec_SignatureZ *result;
1165 * Note that this value is always NULL, as there are no contents in the Err variant
1168 } LDKCResult_CVec_SignatureZNoneZPtr;
1171 * A CResult_CVec_SignatureZNoneZ represents the result of a fallible operation,
1172 * containing a crate::c_types::derived::CVec_SignatureZ on success and a () on failure.
1173 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1175 typedef struct LDKCResult_CVec_SignatureZNoneZ {
1177 * The contents of this CResult_CVec_SignatureZNoneZ, accessible via either
1178 * `err` or `result` depending on the state of `result_ok`.
1180 union LDKCResult_CVec_SignatureZNoneZPtr contents;
1182 * Whether this CResult_CVec_SignatureZNoneZ represents a success state.
1185 } LDKCResult_CVec_SignatureZNoneZ;
1188 * The contents of CResult_NoneErrorZ
1190 typedef union LDKCResult_NoneErrorZPtr {
1192 * Note that this value is always NULL, as there are no contents in the OK variant
1196 * A pointer to the contents in the error state.
1197 * Reading from this pointer when `result_ok` is set is undefined.
1199 enum LDKIOError *err;
1200 } LDKCResult_NoneErrorZPtr;
1203 * A CResult_NoneErrorZ represents the result of a fallible operation,
1204 * containing a () on success and a crate::c_types::IOError on failure.
1205 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1207 typedef struct LDKCResult_NoneErrorZ {
1209 * The contents of this CResult_NoneErrorZ, accessible via either
1210 * `err` or `result` depending on the state of `result_ok`.
1212 union LDKCResult_NoneErrorZPtr contents;
1214 * Whether this CResult_NoneErrorZ represents a success state.
1217 } LDKCResult_NoneErrorZ;
1224 typedef struct MUST_USE_STRUCT LDKRouteHop {
1226 * A pointer to the opaque Rust object.
1227 * Nearly everywhere, inner must be non-null, however in places where
1228 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1230 LDKnativeRouteHop *inner;
1232 * Indicates that this is the only struct which contains the same pointer.
1233 * Rust functions which take ownership of an object provided via an argument require
1234 * this to be true and invalidate the object pointed to by inner.
1240 * The contents of CResult_RouteHopDecodeErrorZ
1242 typedef union LDKCResult_RouteHopDecodeErrorZPtr {
1244 * A pointer to the contents in the success state.
1245 * Reading from this pointer when `result_ok` is not set is undefined.
1247 struct LDKRouteHop *result;
1249 * A pointer to the contents in the error state.
1250 * Reading from this pointer when `result_ok` is set is undefined.
1252 struct LDKDecodeError *err;
1253 } LDKCResult_RouteHopDecodeErrorZPtr;
1256 * A CResult_RouteHopDecodeErrorZ represents the result of a fallible operation,
1257 * containing a crate::lightning::routing::router::RouteHop on success and a crate::lightning::ln::msgs::DecodeError on failure.
1258 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1260 typedef struct LDKCResult_RouteHopDecodeErrorZ {
1262 * The contents of this CResult_RouteHopDecodeErrorZ, accessible via either
1263 * `err` or `result` depending on the state of `result_ok`.
1265 union LDKCResult_RouteHopDecodeErrorZPtr contents;
1267 * Whether this CResult_RouteHopDecodeErrorZ represents a success state.
1270 } LDKCResult_RouteHopDecodeErrorZ;
1273 * A dynamically-allocated array of crate::lightning::routing::router::RouteHops of arbitrary size.
1274 * This corresponds to std::vector in C++
1276 typedef struct LDKCVec_RouteHopZ {
1278 * The elements in the array.
1279 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1281 struct LDKRouteHop *data;
1283 * The number of elements pointed to by `data`.
1286 } LDKCVec_RouteHopZ;
1289 * A dynamically-allocated array of crate::c_types::derived::CVec_RouteHopZs of arbitrary size.
1290 * This corresponds to std::vector in C++
1292 typedef struct LDKCVec_CVec_RouteHopZZ {
1294 * The elements in the array.
1295 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1297 struct LDKCVec_RouteHopZ *data;
1299 * The number of elements pointed to by `data`.
1302 } LDKCVec_CVec_RouteHopZZ;
1307 * A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
1308 * it can take multiple paths. Each path is composed of one or more hops through the network.
1310 typedef struct MUST_USE_STRUCT LDKRoute {
1312 * A pointer to the opaque Rust object.
1313 * Nearly everywhere, inner must be non-null, however in places where
1314 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1316 LDKnativeRoute *inner;
1318 * Indicates that this is the only struct which contains the same pointer.
1319 * Rust functions which take ownership of an object provided via an argument require
1320 * this to be true and invalidate the object pointed to by inner.
1326 * The contents of CResult_RouteDecodeErrorZ
1328 typedef union LDKCResult_RouteDecodeErrorZPtr {
1330 * A pointer to the contents in the success state.
1331 * Reading from this pointer when `result_ok` is not set is undefined.
1333 struct LDKRoute *result;
1335 * A pointer to the contents in the error state.
1336 * Reading from this pointer when `result_ok` is set is undefined.
1338 struct LDKDecodeError *err;
1339 } LDKCResult_RouteDecodeErrorZPtr;
1342 * A CResult_RouteDecodeErrorZ represents the result of a fallible operation,
1343 * containing a crate::lightning::routing::router::Route on success and a crate::lightning::ln::msgs::DecodeError on failure.
1344 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1346 typedef struct LDKCResult_RouteDecodeErrorZ {
1348 * The contents of this CResult_RouteDecodeErrorZ, accessible via either
1349 * `err` or `result` depending on the state of `result_ok`.
1351 union LDKCResult_RouteDecodeErrorZPtr contents;
1353 * Whether this CResult_RouteDecodeErrorZ represents a success state.
1356 } LDKCResult_RouteDecodeErrorZ;
1359 * An enum which can either contain a u64 or not
1361 typedef enum LDKCOption_u64Z_Tag {
1363 * When we're in this state, this COption_u64Z contains a u64
1365 LDKCOption_u64Z_Some,
1367 * When we're in this state, this COption_u64Z contains nothing
1369 LDKCOption_u64Z_None,
1371 * Must be last for serialization purposes
1373 LDKCOption_u64Z_Sentinel,
1374 } LDKCOption_u64Z_Tag;
1376 typedef struct LDKCOption_u64Z {
1377 LDKCOption_u64Z_Tag tag;
1388 * Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
1390 typedef struct MUST_USE_STRUCT LDKChannelDetails {
1392 * A pointer to the opaque Rust object.
1393 * Nearly everywhere, inner must be non-null, however in places where
1394 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1396 LDKnativeChannelDetails *inner;
1398 * Indicates that this is the only struct which contains the same pointer.
1399 * Rust functions which take ownership of an object provided via an argument require
1400 * this to be true and invalidate the object pointed to by inner.
1403 } LDKChannelDetails;
1406 * A dynamically-allocated array of crate::lightning::ln::channelmanager::ChannelDetailss of arbitrary size.
1407 * This corresponds to std::vector in C++
1409 typedef struct LDKCVec_ChannelDetailsZ {
1411 * The elements in the array.
1412 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1414 struct LDKChannelDetails *data;
1416 * The number of elements pointed to by `data`.
1419 } LDKCVec_ChannelDetailsZ;
1424 * A channel descriptor which provides a last-hop route to get_route
1426 typedef struct MUST_USE_STRUCT LDKRouteHintHop {
1428 * A pointer to the opaque Rust object.
1429 * Nearly everywhere, inner must be non-null, however in places where
1430 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1432 LDKnativeRouteHintHop *inner;
1434 * Indicates that this is the only struct which contains the same pointer.
1435 * Rust functions which take ownership of an object provided via an argument require
1436 * this to be true and invalidate the object pointed to by inner.
1442 * A dynamically-allocated array of crate::lightning::routing::router::RouteHintHops of arbitrary size.
1443 * This corresponds to std::vector in C++
1445 typedef struct LDKCVec_RouteHintHopZ {
1447 * The elements in the array.
1448 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1450 struct LDKRouteHintHop *data;
1452 * The number of elements pointed to by `data`.
1455 } LDKCVec_RouteHintHopZ;
1460 * An Err type for failure to process messages.
1462 typedef struct MUST_USE_STRUCT LDKLightningError {
1464 * A pointer to the opaque Rust object.
1465 * Nearly everywhere, inner must be non-null, however in places where
1466 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1468 LDKnativeLightningError *inner;
1470 * Indicates that this is the only struct which contains the same pointer.
1471 * Rust functions which take ownership of an object provided via an argument require
1472 * this to be true and invalidate the object pointed to by inner.
1475 } LDKLightningError;
1478 * The contents of CResult_RouteLightningErrorZ
1480 typedef union LDKCResult_RouteLightningErrorZPtr {
1482 * A pointer to the contents in the success state.
1483 * Reading from this pointer when `result_ok` is not set is undefined.
1485 struct LDKRoute *result;
1487 * A pointer to the contents in the error state.
1488 * Reading from this pointer when `result_ok` is set is undefined.
1490 struct LDKLightningError *err;
1491 } LDKCResult_RouteLightningErrorZPtr;
1494 * A CResult_RouteLightningErrorZ represents the result of a fallible operation,
1495 * containing a crate::lightning::routing::router::Route on success and a crate::lightning::ln::msgs::LightningError on failure.
1496 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1498 typedef struct LDKCResult_RouteLightningErrorZ {
1500 * The contents of this CResult_RouteLightningErrorZ, accessible via either
1501 * `err` or `result` depending on the state of `result_ok`.
1503 union LDKCResult_RouteLightningErrorZPtr contents;
1505 * Whether this CResult_RouteLightningErrorZ represents a success state.
1508 } LDKCResult_RouteLightningErrorZ;
1511 * The contents of CResult_TxOutAccessErrorZ
1513 typedef union LDKCResult_TxOutAccessErrorZPtr {
1515 * A pointer to the contents in the success state.
1516 * Reading from this pointer when `result_ok` is not set is undefined.
1518 struct LDKTxOut *result;
1520 * A pointer to the contents in the error state.
1521 * Reading from this pointer when `result_ok` is set is undefined.
1523 enum LDKAccessError *err;
1524 } LDKCResult_TxOutAccessErrorZPtr;
1527 * A CResult_TxOutAccessErrorZ represents the result of a fallible operation,
1528 * containing a crate::c_types::TxOut on success and a crate::lightning::chain::AccessError on failure.
1529 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1531 typedef struct LDKCResult_TxOutAccessErrorZ {
1533 * The contents of this CResult_TxOutAccessErrorZ, accessible via either
1534 * `err` or `result` depending on the state of `result_ok`.
1536 union LDKCResult_TxOutAccessErrorZPtr contents;
1538 * Whether this CResult_TxOutAccessErrorZ represents a success state.
1541 } LDKCResult_TxOutAccessErrorZ;
1544 * A tuple of 2 elements. See the individual fields for the types contained.
1546 typedef struct LDKC2Tuple_usizeTransactionZ {
1548 * The element at position 0
1552 * The element at position 1
1554 struct LDKTransaction b;
1555 } LDKC2Tuple_usizeTransactionZ;
1558 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_usizeTransactionZs of arbitrary size.
1559 * This corresponds to std::vector in C++
1561 typedef struct LDKCVec_C2Tuple_usizeTransactionZZ {
1563 * The elements in the array.
1564 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1566 struct LDKC2Tuple_usizeTransactionZ *data;
1568 * The number of elements pointed to by `data`.
1571 } LDKCVec_C2Tuple_usizeTransactionZZ;
1574 * Arbitrary 32 bytes, which could represent one of a few different things. You probably want to
1575 * look up the corresponding function in rust-lightning's docs.
1577 typedef struct LDKThirtyTwoBytes {
1579 * The thirty-two bytes
1582 } LDKThirtyTwoBytes;
1585 * A dynamically-allocated array of crate::c_types::ThirtyTwoBytess of arbitrary size.
1586 * This corresponds to std::vector in C++
1588 typedef struct LDKCVec_TxidZ {
1590 * The elements in the array.
1591 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1593 struct LDKThirtyTwoBytes *data;
1595 * The number of elements pointed to by `data`.
1601 * The contents of CResult_NoneChannelMonitorUpdateErrZ
1603 typedef union LDKCResult_NoneChannelMonitorUpdateErrZPtr {
1605 * Note that this value is always NULL, as there are no contents in the OK variant
1609 * A pointer to the contents in the error state.
1610 * Reading from this pointer when `result_ok` is set is undefined.
1612 enum LDKChannelMonitorUpdateErr *err;
1613 } LDKCResult_NoneChannelMonitorUpdateErrZPtr;
1616 * A CResult_NoneChannelMonitorUpdateErrZ represents the result of a fallible operation,
1617 * containing a () on success and a crate::lightning::chain::channelmonitor::ChannelMonitorUpdateErr on failure.
1618 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1620 typedef struct LDKCResult_NoneChannelMonitorUpdateErrZ {
1622 * The contents of this CResult_NoneChannelMonitorUpdateErrZ, accessible via either
1623 * `err` or `result` depending on the state of `result_ok`.
1625 union LDKCResult_NoneChannelMonitorUpdateErrZPtr contents;
1627 * Whether this CResult_NoneChannelMonitorUpdateErrZ represents a success state.
1630 } LDKCResult_NoneChannelMonitorUpdateErrZ;
1635 * Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
1636 * chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
1637 * preimage claim backward will lead to loss of funds.
1639 typedef struct MUST_USE_STRUCT LDKHTLCUpdate {
1641 * A pointer to the opaque Rust object.
1642 * Nearly everywhere, inner must be non-null, however in places where
1643 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1645 LDKnativeHTLCUpdate *inner;
1647 * Indicates that this is the only struct which contains the same pointer.
1648 * Rust functions which take ownership of an object provided via an argument require
1649 * this to be true and invalidate the object pointed to by inner.
1657 * A reference to a transaction output.
1659 * Differs from bitcoin::blockdata::transaction::OutPoint as the index is a u16 instead of u32
1660 * due to LN's restrictions on index values. Should reduce (possibly) unsafe conversions this way.
1662 typedef struct MUST_USE_STRUCT LDKOutPoint {
1664 * A pointer to the opaque Rust object.
1665 * Nearly everywhere, inner must be non-null, however in places where
1666 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1668 LDKnativeOutPoint *inner;
1670 * Indicates that this is the only struct which contains the same pointer.
1671 * Rust functions which take ownership of an object provided via an argument require
1672 * this to be true and invalidate the object pointed to by inner.
1678 * An event to be processed by the ChannelManager.
1680 typedef enum LDKMonitorEvent_Tag {
1682 * A monitor event containing an HTLCUpdate.
1684 LDKMonitorEvent_HTLCEvent,
1686 * A monitor event that the Channel's commitment transaction was broadcasted.
1688 LDKMonitorEvent_CommitmentTxBroadcasted,
1690 * Must be last for serialization purposes
1692 LDKMonitorEvent_Sentinel,
1693 } LDKMonitorEvent_Tag;
1695 typedef struct MUST_USE_STRUCT LDKMonitorEvent {
1696 LDKMonitorEvent_Tag tag;
1699 struct LDKHTLCUpdate htlc_event;
1702 struct LDKOutPoint commitment_tx_broadcasted;
1708 * A dynamically-allocated array of crate::lightning::chain::channelmonitor::MonitorEvents of arbitrary size.
1709 * This corresponds to std::vector in C++
1711 typedef struct LDKCVec_MonitorEventZ {
1713 * The elements in the array.
1714 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1716 struct LDKMonitorEvent *data;
1718 * The number of elements pointed to by `data`.
1721 } LDKCVec_MonitorEventZ;
1724 * An enum which can either contain a crate::c_types::derived::C2Tuple_usizeTransactionZ or not
1726 typedef enum LDKCOption_C2Tuple_usizeTransactionZZ_Tag {
1728 * When we're in this state, this COption_C2Tuple_usizeTransactionZZ contains a crate::c_types::derived::C2Tuple_usizeTransactionZ
1730 LDKCOption_C2Tuple_usizeTransactionZZ_Some,
1732 * When we're in this state, this COption_C2Tuple_usizeTransactionZZ contains nothing
1734 LDKCOption_C2Tuple_usizeTransactionZZ_None,
1736 * Must be last for serialization purposes
1738 LDKCOption_C2Tuple_usizeTransactionZZ_Sentinel,
1739 } LDKCOption_C2Tuple_usizeTransactionZZ_Tag;
1741 typedef struct LDKCOption_C2Tuple_usizeTransactionZZ {
1742 LDKCOption_C2Tuple_usizeTransactionZZ_Tag tag;
1745 struct LDKC2Tuple_usizeTransactionZ some;
1748 } LDKCOption_C2Tuple_usizeTransactionZZ;
1753 * Information about a spendable output to a P2WSH script. See
1754 * SpendableOutputDescriptor::DelayedPaymentOutput for more details on how to spend this.
1756 typedef struct MUST_USE_STRUCT LDKDelayedPaymentOutputDescriptor {
1758 * A pointer to the opaque Rust object.
1759 * Nearly everywhere, inner must be non-null, however in places where
1760 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1762 LDKnativeDelayedPaymentOutputDescriptor *inner;
1764 * Indicates that this is the only struct which contains the same pointer.
1765 * Rust functions which take ownership of an object provided via an argument require
1766 * this to be true and invalidate the object pointed to by inner.
1769 } LDKDelayedPaymentOutputDescriptor;
1774 * Information about a spendable output to our \"payment key\". See
1775 * SpendableOutputDescriptor::StaticPaymentOutput for more details on how to spend this.
1777 typedef struct MUST_USE_STRUCT LDKStaticPaymentOutputDescriptor {
1779 * A pointer to the opaque Rust object.
1780 * Nearly everywhere, inner must be non-null, however in places where
1781 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1783 LDKnativeStaticPaymentOutputDescriptor *inner;
1785 * Indicates that this is the only struct which contains the same pointer.
1786 * Rust functions which take ownership of an object provided via an argument require
1787 * this to be true and invalidate the object pointed to by inner.
1790 } LDKStaticPaymentOutputDescriptor;
1793 * When on-chain outputs are created by rust-lightning (which our counterparty is not able to
1794 * claim at any point in the future) an event is generated which you must track and be able to
1795 * spend on-chain. The information needed to do this is provided in this enum, including the
1796 * outpoint describing which txid and output index is available, the full output which exists at
1797 * that txid/index, and any keys or other information required to sign.
1799 typedef enum LDKSpendableOutputDescriptor_Tag {
1801 * An output to a script which was provided via KeysInterface directly, either from
1802 * `get_destination_script()` or `get_shutdown_pubkey()`, thus you should already know how to
1803 * spend it. No secret keys are provided as rust-lightning was never given any key.
1804 * These may include outputs from a transaction punishing our counterparty or claiming an HTLC
1805 * on-chain using the payment preimage or after it has timed out.
1807 LDKSpendableOutputDescriptor_StaticOutput,
1809 * An output to a P2WSH script which can be spent with a single signature after a CSV delay.
1811 * The witness in the spending input should be:
1812 * <BIP 143 signature> <empty vector> (MINIMALIF standard rule) <provided witnessScript>
1814 * Note that the nSequence field in the spending input must be set to to_self_delay
1815 * (which means the transaction is not broadcastable until at least to_self_delay
1816 * blocks after the outpoint confirms).
1818 * These are generally the result of a \"revocable\" output to us, spendable only by us unless
1819 * it is an output from an old state which we broadcast (which should never happen).
1821 * To derive the delayed_payment key which is used to sign for this input, you must pass the
1822 * holder delayed_payment_base_key (ie the private key which corresponds to the pubkey in
1823 * Sign::pubkeys().delayed_payment_basepoint) and the provided per_commitment_point to
1824 * chan_utils::derive_private_key. The public key can be generated without the secret key
1825 * using chan_utils::derive_public_key and only the delayed_payment_basepoint which appears in
1828 * To derive the revocation_pubkey provided here (which is used in the witness
1829 * script generation), you must pass the counterparty revocation_basepoint (which appears in the
1830 * call to Sign::ready_channel) and the provided per_commitment point
1831 * to chan_utils::derive_public_revocation_key.
1833 * The witness script which is hashed and included in the output script_pubkey may be
1834 * regenerated by passing the revocation_pubkey (derived as above), our delayed_payment pubkey
1835 * (derived as above), and the to_self_delay contained here to
1836 * chan_utils::get_revokeable_redeemscript.
1838 LDKSpendableOutputDescriptor_DelayedPaymentOutput,
1840 * An output to a P2WPKH, spendable exclusively by our payment key (ie the private key which
1841 * corresponds to the public key in Sign::pubkeys().payment_point).
1842 * The witness in the spending input, is, thus, simply:
1843 * <BIP 143 signature> <payment key>
1845 * These are generally the result of our counterparty having broadcast the current state,
1846 * allowing us to claim the non-HTLC-encumbered outputs immediately.
1848 LDKSpendableOutputDescriptor_StaticPaymentOutput,
1850 * Must be last for serialization purposes
1852 LDKSpendableOutputDescriptor_Sentinel,
1853 } LDKSpendableOutputDescriptor_Tag;
1855 typedef struct LDKSpendableOutputDescriptor_LDKStaticOutput_Body {
1857 * The outpoint which is spendable
1859 struct LDKOutPoint outpoint;
1861 * The output which is referenced by the given outpoint.
1863 struct LDKTxOut output;
1864 } LDKSpendableOutputDescriptor_LDKStaticOutput_Body;
1866 typedef struct MUST_USE_STRUCT LDKSpendableOutputDescriptor {
1867 LDKSpendableOutputDescriptor_Tag tag;
1869 LDKSpendableOutputDescriptor_LDKStaticOutput_Body static_output;
1871 struct LDKDelayedPaymentOutputDescriptor delayed_payment_output;
1874 struct LDKStaticPaymentOutputDescriptor static_payment_output;
1877 } LDKSpendableOutputDescriptor;
1880 * A dynamically-allocated array of crate::lightning::chain::keysinterface::SpendableOutputDescriptors of arbitrary size.
1881 * This corresponds to std::vector in C++
1883 typedef struct LDKCVec_SpendableOutputDescriptorZ {
1885 * The elements in the array.
1886 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1888 struct LDKSpendableOutputDescriptor *data;
1890 * The number of elements pointed to by `data`.
1893 } LDKCVec_SpendableOutputDescriptorZ;
1898 * An accept_channel message to be sent or received from a peer
1900 typedef struct MUST_USE_STRUCT LDKAcceptChannel {
1902 * A pointer to the opaque Rust object.
1903 * Nearly everywhere, inner must be non-null, however in places where
1904 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1906 LDKnativeAcceptChannel *inner;
1908 * Indicates that this is the only struct which contains the same pointer.
1909 * Rust functions which take ownership of an object provided via an argument require
1910 * this to be true and invalidate the object pointed to by inner.
1918 * An open_channel message to be sent or received from a peer
1920 typedef struct MUST_USE_STRUCT LDKOpenChannel {
1922 * A pointer to the opaque Rust object.
1923 * Nearly everywhere, inner must be non-null, however in places where
1924 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1926 LDKnativeOpenChannel *inner;
1928 * Indicates that this is the only struct which contains the same pointer.
1929 * Rust functions which take ownership of an object provided via an argument require
1930 * this to be true and invalidate the object pointed to by inner.
1938 * A funding_created message to be sent or received from a peer
1940 typedef struct MUST_USE_STRUCT LDKFundingCreated {
1942 * A pointer to the opaque Rust object.
1943 * Nearly everywhere, inner must be non-null, however in places where
1944 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1946 LDKnativeFundingCreated *inner;
1948 * Indicates that this is the only struct which contains the same pointer.
1949 * Rust functions which take ownership of an object provided via an argument require
1950 * this to be true and invalidate the object pointed to by inner.
1953 } LDKFundingCreated;
1958 * A funding_signed message to be sent or received from a peer
1960 typedef struct MUST_USE_STRUCT LDKFundingSigned {
1962 * A pointer to the opaque Rust object.
1963 * Nearly everywhere, inner must be non-null, however in places where
1964 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1966 LDKnativeFundingSigned *inner;
1968 * Indicates that this is the only struct which contains the same pointer.
1969 * Rust functions which take ownership of an object provided via an argument require
1970 * this to be true and invalidate the object pointed to by inner.
1978 * A funding_locked message to be sent or received from a peer
1980 typedef struct MUST_USE_STRUCT LDKFundingLocked {
1982 * A pointer to the opaque Rust object.
1983 * Nearly everywhere, inner must be non-null, however in places where
1984 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1986 LDKnativeFundingLocked *inner;
1988 * Indicates that this is the only struct which contains the same pointer.
1989 * Rust functions which take ownership of an object provided via an argument require
1990 * this to be true and invalidate the object pointed to by inner.
1998 * An announcement_signatures message to be sent or received from a peer
2000 typedef struct MUST_USE_STRUCT LDKAnnouncementSignatures {
2002 * A pointer to the opaque Rust object.
2003 * Nearly everywhere, inner must be non-null, however in places where
2004 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2006 LDKnativeAnnouncementSignatures *inner;
2008 * Indicates that this is the only struct which contains the same pointer.
2009 * Rust functions which take ownership of an object provided via an argument require
2010 * this to be true and invalidate the object pointed to by inner.
2013 } LDKAnnouncementSignatures;
2018 * Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
2019 * transaction updates if they were pending.
2021 typedef struct MUST_USE_STRUCT LDKCommitmentUpdate {
2023 * A pointer to the opaque Rust object.
2024 * Nearly everywhere, inner must be non-null, however in places where
2025 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2027 LDKnativeCommitmentUpdate *inner;
2029 * Indicates that this is the only struct which contains the same pointer.
2030 * Rust functions which take ownership of an object provided via an argument require
2031 * this to be true and invalidate the object pointed to by inner.
2034 } LDKCommitmentUpdate;
2039 * A revoke_and_ack message to be sent or received from a peer
2041 typedef struct MUST_USE_STRUCT LDKRevokeAndACK {
2043 * A pointer to the opaque Rust object.
2044 * Nearly everywhere, inner must be non-null, however in places where
2045 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2047 LDKnativeRevokeAndACK *inner;
2049 * Indicates that this is the only struct which contains the same pointer.
2050 * Rust functions which take ownership of an object provided via an argument require
2051 * this to be true and invalidate the object pointed to by inner.
2059 * A closing_signed message to be sent or received from a peer
2061 typedef struct MUST_USE_STRUCT LDKClosingSigned {
2063 * A pointer to the opaque Rust object.
2064 * Nearly everywhere, inner must be non-null, however in places where
2065 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2067 LDKnativeClosingSigned *inner;
2069 * Indicates that this is the only struct which contains the same pointer.
2070 * Rust functions which take ownership of an object provided via an argument require
2071 * this to be true and invalidate the object pointed to by inner.
2079 * A shutdown message to be sent or received from a peer
2081 typedef struct MUST_USE_STRUCT LDKShutdown {
2083 * A pointer to the opaque Rust object.
2084 * Nearly everywhere, inner must be non-null, however in places where
2085 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2087 LDKnativeShutdown *inner;
2089 * Indicates that this is the only struct which contains the same pointer.
2090 * Rust functions which take ownership of an object provided via an argument require
2091 * this to be true and invalidate the object pointed to by inner.
2099 * A channel_reestablish message to be sent or received from a peer
2101 typedef struct MUST_USE_STRUCT LDKChannelReestablish {
2103 * A pointer to the opaque Rust object.
2104 * Nearly everywhere, inner must be non-null, however in places where
2105 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2107 LDKnativeChannelReestablish *inner;
2109 * Indicates that this is the only struct which contains the same pointer.
2110 * Rust functions which take ownership of an object provided via an argument require
2111 * this to be true and invalidate the object pointed to by inner.
2114 } LDKChannelReestablish;
2119 * A channel_announcement message to be sent or received from a peer
2121 typedef struct MUST_USE_STRUCT LDKChannelAnnouncement {
2123 * A pointer to the opaque Rust object.
2124 * Nearly everywhere, inner must be non-null, however in places where
2125 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2127 LDKnativeChannelAnnouncement *inner;
2129 * Indicates that this is the only struct which contains the same pointer.
2130 * Rust functions which take ownership of an object provided via an argument require
2131 * this to be true and invalidate the object pointed to by inner.
2134 } LDKChannelAnnouncement;
2139 * A channel_update message to be sent or received from a peer
2141 typedef struct MUST_USE_STRUCT LDKChannelUpdate {
2143 * A pointer to the opaque Rust object.
2144 * Nearly everywhere, inner must be non-null, however in places where
2145 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2147 LDKnativeChannelUpdate *inner;
2149 * Indicates that this is the only struct which contains the same pointer.
2150 * Rust functions which take ownership of an object provided via an argument require
2151 * this to be true and invalidate the object pointed to by inner.
2159 * A node_announcement message to be sent or received from a peer
2161 typedef struct MUST_USE_STRUCT LDKNodeAnnouncement {
2163 * A pointer to the opaque Rust object.
2164 * Nearly everywhere, inner must be non-null, however in places where
2165 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2167 LDKnativeNodeAnnouncement *inner;
2169 * Indicates that this is the only struct which contains the same pointer.
2170 * Rust functions which take ownership of an object provided via an argument require
2171 * this to be true and invalidate the object pointed to by inner.
2174 } LDKNodeAnnouncement;
2179 * An error message to be sent or received from a peer
2181 typedef struct MUST_USE_STRUCT LDKErrorMessage {
2183 * A pointer to the opaque Rust object.
2184 * Nearly everywhere, inner must be non-null, however in places where
2185 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2187 LDKnativeErrorMessage *inner;
2189 * Indicates that this is the only struct which contains the same pointer.
2190 * Rust functions which take ownership of an object provided via an argument require
2191 * this to be true and invalidate the object pointed to by inner.
2197 * Used to put an error message in a LightningError
2199 typedef enum LDKErrorAction_Tag {
2201 * The peer took some action which made us think they were useless. Disconnect them.
2203 LDKErrorAction_DisconnectPeer,
2205 * The peer did something harmless that we weren't able to process, just log and ignore
2207 LDKErrorAction_IgnoreError,
2209 * The peer did something incorrect. Tell them.
2211 LDKErrorAction_SendErrorMessage,
2213 * Must be last for serialization purposes
2215 LDKErrorAction_Sentinel,
2216 } LDKErrorAction_Tag;
2218 typedef struct LDKErrorAction_LDKDisconnectPeer_Body {
2220 * An error message which we should make an effort to send before we disconnect.
2222 struct LDKErrorMessage msg;
2223 } LDKErrorAction_LDKDisconnectPeer_Body;
2225 typedef struct LDKErrorAction_LDKSendErrorMessage_Body {
2227 * The message to send.
2229 struct LDKErrorMessage msg;
2230 } LDKErrorAction_LDKSendErrorMessage_Body;
2232 typedef struct MUST_USE_STRUCT LDKErrorAction {
2233 LDKErrorAction_Tag tag;
2235 LDKErrorAction_LDKDisconnectPeer_Body disconnect_peer;
2236 LDKErrorAction_LDKSendErrorMessage_Body send_error_message;
2241 * The information we received from a peer along the route of a payment we originated. This is
2242 * returned by ChannelMessageHandler::handle_update_fail_htlc to be passed into
2243 * RoutingMessageHandler::handle_htlc_fail_channel_update to update our network map.
2245 typedef enum LDKHTLCFailChannelUpdate_Tag {
2247 * We received an error which included a full ChannelUpdate message.
2249 LDKHTLCFailChannelUpdate_ChannelUpdateMessage,
2251 * We received an error which indicated only that a channel has been closed
2253 LDKHTLCFailChannelUpdate_ChannelClosed,
2255 * We received an error which indicated only that a node has failed
2257 LDKHTLCFailChannelUpdate_NodeFailure,
2259 * Must be last for serialization purposes
2261 LDKHTLCFailChannelUpdate_Sentinel,
2262 } LDKHTLCFailChannelUpdate_Tag;
2264 typedef struct LDKHTLCFailChannelUpdate_LDKChannelUpdateMessage_Body {
2266 * The unwrapped message we received
2268 struct LDKChannelUpdate msg;
2269 } LDKHTLCFailChannelUpdate_LDKChannelUpdateMessage_Body;
2271 typedef struct LDKHTLCFailChannelUpdate_LDKChannelClosed_Body {
2273 * The short_channel_id which has now closed.
2275 uint64_t short_channel_id;
2277 * when this true, this channel should be permanently removed from the
2278 * consideration. Otherwise, this channel can be restored as new channel_update is received
2281 } LDKHTLCFailChannelUpdate_LDKChannelClosed_Body;
2283 typedef struct LDKHTLCFailChannelUpdate_LDKNodeFailure_Body {
2285 * The node_id that has failed.
2287 struct LDKPublicKey node_id;
2289 * when this true, node should be permanently removed from the
2290 * consideration. Otherwise, the channels connected to this node can be
2291 * restored as new channel_update is received
2294 } LDKHTLCFailChannelUpdate_LDKNodeFailure_Body;
2296 typedef struct MUST_USE_STRUCT LDKHTLCFailChannelUpdate {
2297 LDKHTLCFailChannelUpdate_Tag tag;
2299 LDKHTLCFailChannelUpdate_LDKChannelUpdateMessage_Body channel_update_message;
2300 LDKHTLCFailChannelUpdate_LDKChannelClosed_Body channel_closed;
2301 LDKHTLCFailChannelUpdate_LDKNodeFailure_Body node_failure;
2303 } LDKHTLCFailChannelUpdate;
2308 * A query_channel_range message is used to query a peer for channel
2309 * UTXOs in a range of blocks. The recipient of a query makes a best
2310 * effort to reply to the query using one or more reply_channel_range
2313 typedef struct MUST_USE_STRUCT LDKQueryChannelRange {
2315 * A pointer to the opaque Rust object.
2316 * Nearly everywhere, inner must be non-null, however in places where
2317 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2319 LDKnativeQueryChannelRange *inner;
2321 * Indicates that this is the only struct which contains the same pointer.
2322 * Rust functions which take ownership of an object provided via an argument require
2323 * this to be true and invalidate the object pointed to by inner.
2326 } LDKQueryChannelRange;
2331 * A query_short_channel_ids message is used to query a peer for
2332 * routing gossip messages related to one or more short_channel_ids.
2333 * The query recipient will reply with the latest, if available,
2334 * channel_announcement, channel_update and node_announcement messages
2335 * it maintains for the requested short_channel_ids followed by a
2336 * reply_short_channel_ids_end message. The short_channel_ids sent in
2337 * this query are encoded. We only support encoding_type=0 uncompressed
2338 * serialization and do not support encoding_type=1 zlib serialization.
2340 typedef struct MUST_USE_STRUCT LDKQueryShortChannelIds {
2342 * A pointer to the opaque Rust object.
2343 * Nearly everywhere, inner must be non-null, however in places where
2344 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2346 LDKnativeQueryShortChannelIds *inner;
2348 * Indicates that this is the only struct which contains the same pointer.
2349 * Rust functions which take ownership of an object provided via an argument require
2350 * this to be true and invalidate the object pointed to by inner.
2353 } LDKQueryShortChannelIds;
2358 * A reply_channel_range message is a reply to a query_channel_range
2359 * message. Multiple reply_channel_range messages can be sent in reply
2360 * to a single query_channel_range message. The query recipient makes a
2361 * best effort to respond based on their local network view which may
2362 * not be a perfect view of the network. The short_channel_ids in the
2363 * reply are encoded. We only support encoding_type=0 uncompressed
2364 * serialization and do not support encoding_type=1 zlib serialization.
2366 typedef struct MUST_USE_STRUCT LDKReplyChannelRange {
2368 * A pointer to the opaque Rust object.
2369 * Nearly everywhere, inner must be non-null, however in places where
2370 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2372 LDKnativeReplyChannelRange *inner;
2374 * Indicates that this is the only struct which contains the same pointer.
2375 * Rust functions which take ownership of an object provided via an argument require
2376 * this to be true and invalidate the object pointed to by inner.
2379 } LDKReplyChannelRange;
2382 * An event generated by ChannelManager which indicates a message should be sent to a peer (or
2383 * broadcast to most peers).
2384 * These events are handled by PeerManager::process_events if you are using a PeerManager.
2386 typedef enum LDKMessageSendEvent_Tag {
2388 * Used to indicate that we've accepted a channel open and should send the accept_channel
2389 * message provided to the given peer.
2391 LDKMessageSendEvent_SendAcceptChannel,
2393 * Used to indicate that we've initiated a channel open and should send the open_channel
2394 * message provided to the given peer.
2396 LDKMessageSendEvent_SendOpenChannel,
2398 * Used to indicate that a funding_created message should be sent to the peer with the given node_id.
2400 LDKMessageSendEvent_SendFundingCreated,
2402 * Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
2404 LDKMessageSendEvent_SendFundingSigned,
2406 * Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
2408 LDKMessageSendEvent_SendFundingLocked,
2410 * Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
2412 LDKMessageSendEvent_SendAnnouncementSignatures,
2414 * Used to indicate that a series of HTLC update messages, as well as a commitment_signed
2415 * message should be sent to the peer with the given node_id.
2417 LDKMessageSendEvent_UpdateHTLCs,
2419 * Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
2421 LDKMessageSendEvent_SendRevokeAndACK,
2423 * Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
2425 LDKMessageSendEvent_SendClosingSigned,
2427 * Used to indicate that a shutdown message should be sent to the peer with the given node_id.
2429 LDKMessageSendEvent_SendShutdown,
2431 * Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
2433 LDKMessageSendEvent_SendChannelReestablish,
2435 * Used to indicate that a channel_announcement and channel_update should be broadcast to all
2436 * peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
2438 * Note that after doing so, you very likely (unless you did so very recently) want to call
2439 * ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
2440 * This ensures that any nodes which see our channel_announcement also have a relevant
2441 * node_announcement, including relevant feature flags which may be important for routing
2444 LDKMessageSendEvent_BroadcastChannelAnnouncement,
2446 * Used to indicate that a node_announcement should be broadcast to all peers.
2448 LDKMessageSendEvent_BroadcastNodeAnnouncement,
2450 * Used to indicate that a channel_update should be broadcast to all peers.
2452 LDKMessageSendEvent_BroadcastChannelUpdate,
2454 * Broadcast an error downstream to be handled
2456 LDKMessageSendEvent_HandleError,
2458 * When a payment fails we may receive updates back from the hop where it failed. In such
2459 * cases this event is generated so that we can inform the network graph of this information.
2461 LDKMessageSendEvent_PaymentFailureNetworkUpdate,
2463 * Query a peer for channels with funding transaction UTXOs in a block range.
2465 LDKMessageSendEvent_SendChannelRangeQuery,
2467 * Request routing gossip messages from a peer for a list of channels identified by
2468 * their short_channel_ids.
2470 LDKMessageSendEvent_SendShortIdsQuery,
2472 * Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
2473 * emitted during processing of the query.
2475 LDKMessageSendEvent_SendReplyChannelRange,
2477 * Must be last for serialization purposes
2479 LDKMessageSendEvent_Sentinel,
2480 } LDKMessageSendEvent_Tag;
2482 typedef struct LDKMessageSendEvent_LDKSendAcceptChannel_Body {
2484 * The node_id of the node which should receive this message
2486 struct LDKPublicKey node_id;
2488 * The message which should be sent.
2490 struct LDKAcceptChannel msg;
2491 } LDKMessageSendEvent_LDKSendAcceptChannel_Body;
2493 typedef struct LDKMessageSendEvent_LDKSendOpenChannel_Body {
2495 * The node_id of the node which should receive this message
2497 struct LDKPublicKey node_id;
2499 * The message which should be sent.
2501 struct LDKOpenChannel msg;
2502 } LDKMessageSendEvent_LDKSendOpenChannel_Body;
2504 typedef struct LDKMessageSendEvent_LDKSendFundingCreated_Body {
2506 * The node_id of the node which should receive this message
2508 struct LDKPublicKey node_id;
2510 * The message which should be sent.
2512 struct LDKFundingCreated msg;
2513 } LDKMessageSendEvent_LDKSendFundingCreated_Body;
2515 typedef struct LDKMessageSendEvent_LDKSendFundingSigned_Body {
2517 * The node_id of the node which should receive this message
2519 struct LDKPublicKey node_id;
2521 * The message which should be sent.
2523 struct LDKFundingSigned msg;
2524 } LDKMessageSendEvent_LDKSendFundingSigned_Body;
2526 typedef struct LDKMessageSendEvent_LDKSendFundingLocked_Body {
2528 * The node_id of the node which should receive these message(s)
2530 struct LDKPublicKey node_id;
2532 * The funding_locked message which should be sent.
2534 struct LDKFundingLocked msg;
2535 } LDKMessageSendEvent_LDKSendFundingLocked_Body;
2537 typedef struct LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body {
2539 * The node_id of the node which should receive these message(s)
2541 struct LDKPublicKey node_id;
2543 * The announcement_signatures message which should be sent.
2545 struct LDKAnnouncementSignatures msg;
2546 } LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body;
2548 typedef struct LDKMessageSendEvent_LDKUpdateHTLCs_Body {
2550 * The node_id of the node which should receive these message(s)
2552 struct LDKPublicKey node_id;
2554 * The update messages which should be sent. ALL messages in the struct should be sent!
2556 struct LDKCommitmentUpdate updates;
2557 } LDKMessageSendEvent_LDKUpdateHTLCs_Body;
2559 typedef struct LDKMessageSendEvent_LDKSendRevokeAndACK_Body {
2561 * The node_id of the node which should receive this message
2563 struct LDKPublicKey node_id;
2565 * The message which should be sent.
2567 struct LDKRevokeAndACK msg;
2568 } LDKMessageSendEvent_LDKSendRevokeAndACK_Body;
2570 typedef struct LDKMessageSendEvent_LDKSendClosingSigned_Body {
2572 * The node_id of the node which should receive this message
2574 struct LDKPublicKey node_id;
2576 * The message which should be sent.
2578 struct LDKClosingSigned msg;
2579 } LDKMessageSendEvent_LDKSendClosingSigned_Body;
2581 typedef struct LDKMessageSendEvent_LDKSendShutdown_Body {
2583 * The node_id of the node which should receive this message
2585 struct LDKPublicKey node_id;
2587 * The message which should be sent.
2589 struct LDKShutdown msg;
2590 } LDKMessageSendEvent_LDKSendShutdown_Body;
2592 typedef struct LDKMessageSendEvent_LDKSendChannelReestablish_Body {
2594 * The node_id of the node which should receive this message
2596 struct LDKPublicKey node_id;
2598 * The message which should be sent.
2600 struct LDKChannelReestablish msg;
2601 } LDKMessageSendEvent_LDKSendChannelReestablish_Body;
2603 typedef struct LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body {
2605 * The channel_announcement which should be sent.
2607 struct LDKChannelAnnouncement msg;
2609 * The followup channel_update which should be sent.
2611 struct LDKChannelUpdate update_msg;
2612 } LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body;
2614 typedef struct LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body {
2616 * The node_announcement which should be sent.
2618 struct LDKNodeAnnouncement msg;
2619 } LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body;
2621 typedef struct LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body {
2623 * The channel_update which should be sent.
2625 struct LDKChannelUpdate msg;
2626 } LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body;
2628 typedef struct LDKMessageSendEvent_LDKHandleError_Body {
2630 * The node_id of the node which should receive this message
2632 struct LDKPublicKey node_id;
2634 * The action which should be taken.
2636 struct LDKErrorAction action;
2637 } LDKMessageSendEvent_LDKHandleError_Body;
2639 typedef struct LDKMessageSendEvent_LDKPaymentFailureNetworkUpdate_Body {
2641 * The channel/node update which should be sent to NetGraphMsgHandler
2643 struct LDKHTLCFailChannelUpdate update;
2644 } LDKMessageSendEvent_LDKPaymentFailureNetworkUpdate_Body;
2646 typedef struct LDKMessageSendEvent_LDKSendChannelRangeQuery_Body {
2648 * The node_id of this message recipient
2650 struct LDKPublicKey node_id;
2652 * The query_channel_range which should be sent.
2654 struct LDKQueryChannelRange msg;
2655 } LDKMessageSendEvent_LDKSendChannelRangeQuery_Body;
2657 typedef struct LDKMessageSendEvent_LDKSendShortIdsQuery_Body {
2659 * The node_id of this message recipient
2661 struct LDKPublicKey node_id;
2663 * The query_short_channel_ids which should be sent.
2665 struct LDKQueryShortChannelIds msg;
2666 } LDKMessageSendEvent_LDKSendShortIdsQuery_Body;
2668 typedef struct LDKMessageSendEvent_LDKSendReplyChannelRange_Body {
2670 * The node_id of this message recipient
2672 struct LDKPublicKey node_id;
2674 * The reply_channel_range which should be sent.
2676 struct LDKReplyChannelRange msg;
2677 } LDKMessageSendEvent_LDKSendReplyChannelRange_Body;
2679 typedef struct MUST_USE_STRUCT LDKMessageSendEvent {
2680 LDKMessageSendEvent_Tag tag;
2682 LDKMessageSendEvent_LDKSendAcceptChannel_Body send_accept_channel;
2683 LDKMessageSendEvent_LDKSendOpenChannel_Body send_open_channel;
2684 LDKMessageSendEvent_LDKSendFundingCreated_Body send_funding_created;
2685 LDKMessageSendEvent_LDKSendFundingSigned_Body send_funding_signed;
2686 LDKMessageSendEvent_LDKSendFundingLocked_Body send_funding_locked;
2687 LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body send_announcement_signatures;
2688 LDKMessageSendEvent_LDKUpdateHTLCs_Body update_htl_cs;
2689 LDKMessageSendEvent_LDKSendRevokeAndACK_Body send_revoke_and_ack;
2690 LDKMessageSendEvent_LDKSendClosingSigned_Body send_closing_signed;
2691 LDKMessageSendEvent_LDKSendShutdown_Body send_shutdown;
2692 LDKMessageSendEvent_LDKSendChannelReestablish_Body send_channel_reestablish;
2693 LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body broadcast_channel_announcement;
2694 LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body broadcast_node_announcement;
2695 LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body broadcast_channel_update;
2696 LDKMessageSendEvent_LDKHandleError_Body handle_error;
2697 LDKMessageSendEvent_LDKPaymentFailureNetworkUpdate_Body payment_failure_network_update;
2698 LDKMessageSendEvent_LDKSendChannelRangeQuery_Body send_channel_range_query;
2699 LDKMessageSendEvent_LDKSendShortIdsQuery_Body send_short_ids_query;
2700 LDKMessageSendEvent_LDKSendReplyChannelRange_Body send_reply_channel_range;
2702 } LDKMessageSendEvent;
2705 * A dynamically-allocated array of crate::lightning::util::events::MessageSendEvents of arbitrary size.
2706 * This corresponds to std::vector in C++
2708 typedef struct LDKCVec_MessageSendEventZ {
2710 * The elements in the array.
2711 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
2713 struct LDKMessageSendEvent *data;
2715 * The number of elements pointed to by `data`.
2718 } LDKCVec_MessageSendEventZ;
2723 * Features used within an `init` message.
2725 typedef struct MUST_USE_STRUCT LDKInitFeatures {
2727 * A pointer to the opaque Rust object.
2728 * Nearly everywhere, inner must be non-null, however in places where
2729 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2731 LDKnativeInitFeatures *inner;
2733 * Indicates that this is the only struct which contains the same pointer.
2734 * Rust functions which take ownership of an object provided via an argument require
2735 * this to be true and invalidate the object pointed to by inner.
2741 * The contents of CResult_InitFeaturesDecodeErrorZ
2743 typedef union LDKCResult_InitFeaturesDecodeErrorZPtr {
2745 * A pointer to the contents in the success state.
2746 * Reading from this pointer when `result_ok` is not set is undefined.
2748 struct LDKInitFeatures *result;
2750 * A pointer to the contents in the error state.
2751 * Reading from this pointer when `result_ok` is set is undefined.
2753 struct LDKDecodeError *err;
2754 } LDKCResult_InitFeaturesDecodeErrorZPtr;
2757 * A CResult_InitFeaturesDecodeErrorZ represents the result of a fallible operation,
2758 * containing a crate::lightning::ln::features::InitFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
2759 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2761 typedef struct LDKCResult_InitFeaturesDecodeErrorZ {
2763 * The contents of this CResult_InitFeaturesDecodeErrorZ, accessible via either
2764 * `err` or `result` depending on the state of `result_ok`.
2766 union LDKCResult_InitFeaturesDecodeErrorZPtr contents;
2768 * Whether this CResult_InitFeaturesDecodeErrorZ represents a success state.
2771 } LDKCResult_InitFeaturesDecodeErrorZ;
2776 * Features used within a `node_announcement` message.
2778 typedef struct MUST_USE_STRUCT LDKNodeFeatures {
2780 * A pointer to the opaque Rust object.
2781 * Nearly everywhere, inner must be non-null, however in places where
2782 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2784 LDKnativeNodeFeatures *inner;
2786 * Indicates that this is the only struct which contains the same pointer.
2787 * Rust functions which take ownership of an object provided via an argument require
2788 * this to be true and invalidate the object pointed to by inner.
2794 * The contents of CResult_NodeFeaturesDecodeErrorZ
2796 typedef union LDKCResult_NodeFeaturesDecodeErrorZPtr {
2798 * A pointer to the contents in the success state.
2799 * Reading from this pointer when `result_ok` is not set is undefined.
2801 struct LDKNodeFeatures *result;
2803 * A pointer to the contents in the error state.
2804 * Reading from this pointer when `result_ok` is set is undefined.
2806 struct LDKDecodeError *err;
2807 } LDKCResult_NodeFeaturesDecodeErrorZPtr;
2810 * A CResult_NodeFeaturesDecodeErrorZ represents the result of a fallible operation,
2811 * containing a crate::lightning::ln::features::NodeFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
2812 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2814 typedef struct LDKCResult_NodeFeaturesDecodeErrorZ {
2816 * The contents of this CResult_NodeFeaturesDecodeErrorZ, accessible via either
2817 * `err` or `result` depending on the state of `result_ok`.
2819 union LDKCResult_NodeFeaturesDecodeErrorZPtr contents;
2821 * Whether this CResult_NodeFeaturesDecodeErrorZ represents a success state.
2824 } LDKCResult_NodeFeaturesDecodeErrorZ;
2829 * Features used within a `channel_announcement` message.
2831 typedef struct MUST_USE_STRUCT LDKChannelFeatures {
2833 * A pointer to the opaque Rust object.
2834 * Nearly everywhere, inner must be non-null, however in places where
2835 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2837 LDKnativeChannelFeatures *inner;
2839 * Indicates that this is the only struct which contains the same pointer.
2840 * Rust functions which take ownership of an object provided via an argument require
2841 * this to be true and invalidate the object pointed to by inner.
2844 } LDKChannelFeatures;
2847 * The contents of CResult_ChannelFeaturesDecodeErrorZ
2849 typedef union LDKCResult_ChannelFeaturesDecodeErrorZPtr {
2851 * A pointer to the contents in the success state.
2852 * Reading from this pointer when `result_ok` is not set is undefined.
2854 struct LDKChannelFeatures *result;
2856 * A pointer to the contents in the error state.
2857 * Reading from this pointer when `result_ok` is set is undefined.
2859 struct LDKDecodeError *err;
2860 } LDKCResult_ChannelFeaturesDecodeErrorZPtr;
2863 * A CResult_ChannelFeaturesDecodeErrorZ represents the result of a fallible operation,
2864 * containing a crate::lightning::ln::features::ChannelFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
2865 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2867 typedef struct LDKCResult_ChannelFeaturesDecodeErrorZ {
2869 * The contents of this CResult_ChannelFeaturesDecodeErrorZ, accessible via either
2870 * `err` or `result` depending on the state of `result_ok`.
2872 union LDKCResult_ChannelFeaturesDecodeErrorZPtr contents;
2874 * Whether this CResult_ChannelFeaturesDecodeErrorZ represents a success state.
2877 } LDKCResult_ChannelFeaturesDecodeErrorZ;
2882 * Features used within an invoice.
2884 typedef struct MUST_USE_STRUCT LDKInvoiceFeatures {
2886 * A pointer to the opaque Rust object.
2887 * Nearly everywhere, inner must be non-null, however in places where
2888 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2890 LDKnativeInvoiceFeatures *inner;
2892 * Indicates that this is the only struct which contains the same pointer.
2893 * Rust functions which take ownership of an object provided via an argument require
2894 * this to be true and invalidate the object pointed to by inner.
2897 } LDKInvoiceFeatures;
2900 * The contents of CResult_InvoiceFeaturesDecodeErrorZ
2902 typedef union LDKCResult_InvoiceFeaturesDecodeErrorZPtr {
2904 * A pointer to the contents in the success state.
2905 * Reading from this pointer when `result_ok` is not set is undefined.
2907 struct LDKInvoiceFeatures *result;
2909 * A pointer to the contents in the error state.
2910 * Reading from this pointer when `result_ok` is set is undefined.
2912 struct LDKDecodeError *err;
2913 } LDKCResult_InvoiceFeaturesDecodeErrorZPtr;
2916 * A CResult_InvoiceFeaturesDecodeErrorZ represents the result of a fallible operation,
2917 * containing a crate::lightning::ln::features::InvoiceFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
2918 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2920 typedef struct LDKCResult_InvoiceFeaturesDecodeErrorZ {
2922 * The contents of this CResult_InvoiceFeaturesDecodeErrorZ, accessible via either
2923 * `err` or `result` depending on the state of `result_ok`.
2925 union LDKCResult_InvoiceFeaturesDecodeErrorZPtr contents;
2927 * Whether this CResult_InvoiceFeaturesDecodeErrorZ represents a success state.
2930 } LDKCResult_InvoiceFeaturesDecodeErrorZ;
2933 * The contents of CResult_DelayedPaymentOutputDescriptorDecodeErrorZ
2935 typedef union LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZPtr {
2937 * A pointer to the contents in the success state.
2938 * Reading from this pointer when `result_ok` is not set is undefined.
2940 struct LDKDelayedPaymentOutputDescriptor *result;
2942 * A pointer to the contents in the error state.
2943 * Reading from this pointer when `result_ok` is set is undefined.
2945 struct LDKDecodeError *err;
2946 } LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZPtr;
2949 * A CResult_DelayedPaymentOutputDescriptorDecodeErrorZ represents the result of a fallible operation,
2950 * containing a crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor on success and a crate::lightning::ln::msgs::DecodeError on failure.
2951 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2953 typedef struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ {
2955 * The contents of this CResult_DelayedPaymentOutputDescriptorDecodeErrorZ, accessible via either
2956 * `err` or `result` depending on the state of `result_ok`.
2958 union LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZPtr contents;
2960 * Whether this CResult_DelayedPaymentOutputDescriptorDecodeErrorZ represents a success state.
2963 } LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ;
2966 * The contents of CResult_StaticPaymentOutputDescriptorDecodeErrorZ
2968 typedef union LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZPtr {
2970 * A pointer to the contents in the success state.
2971 * Reading from this pointer when `result_ok` is not set is undefined.
2973 struct LDKStaticPaymentOutputDescriptor *result;
2975 * A pointer to the contents in the error state.
2976 * Reading from this pointer when `result_ok` is set is undefined.
2978 struct LDKDecodeError *err;
2979 } LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZPtr;
2982 * A CResult_StaticPaymentOutputDescriptorDecodeErrorZ represents the result of a fallible operation,
2983 * containing a crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor on success and a crate::lightning::ln::msgs::DecodeError on failure.
2984 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2986 typedef struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ {
2988 * The contents of this CResult_StaticPaymentOutputDescriptorDecodeErrorZ, accessible via either
2989 * `err` or `result` depending on the state of `result_ok`.
2991 union LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZPtr contents;
2993 * Whether this CResult_StaticPaymentOutputDescriptorDecodeErrorZ represents a success state.
2996 } LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ;
2999 * The contents of CResult_SpendableOutputDescriptorDecodeErrorZ
3001 typedef union LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr {
3003 * A pointer to the contents in the success state.
3004 * Reading from this pointer when `result_ok` is not set is undefined.
3006 struct LDKSpendableOutputDescriptor *result;
3008 * A pointer to the contents in the error state.
3009 * Reading from this pointer when `result_ok` is set is undefined.
3011 struct LDKDecodeError *err;
3012 } LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr;
3015 * A CResult_SpendableOutputDescriptorDecodeErrorZ represents the result of a fallible operation,
3016 * containing a crate::lightning::chain::keysinterface::SpendableOutputDescriptor on success and a crate::lightning::ln::msgs::DecodeError on failure.
3017 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3019 typedef struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ {
3021 * The contents of this CResult_SpendableOutputDescriptorDecodeErrorZ, accessible via either
3022 * `err` or `result` depending on the state of `result_ok`.
3024 union LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr contents;
3026 * Whether this CResult_SpendableOutputDescriptorDecodeErrorZ represents a success state.
3029 } LDKCResult_SpendableOutputDescriptorDecodeErrorZ;
3032 * A tuple of 2 elements. See the individual fields for the types contained.
3034 typedef struct LDKC2Tuple_SignatureCVec_SignatureZZ {
3036 * The element at position 0
3038 struct LDKSignature a;
3040 * The element at position 1
3042 struct LDKCVec_SignatureZ b;
3043 } LDKC2Tuple_SignatureCVec_SignatureZZ;
3046 * The contents of CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ
3048 typedef union LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr {
3050 * A pointer to the contents in the success state.
3051 * Reading from this pointer when `result_ok` is not set is undefined.
3053 struct LDKC2Tuple_SignatureCVec_SignatureZZ *result;
3055 * Note that this value is always NULL, as there are no contents in the Err variant
3058 } LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr;
3061 * A CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ represents the result of a fallible operation,
3062 * containing a crate::c_types::derived::C2Tuple_SignatureCVec_SignatureZZ on success and a () on failure.
3063 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3065 typedef struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ {
3067 * The contents of this CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ, accessible via either
3068 * `err` or `result` depending on the state of `result_ok`.
3070 union LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr contents;
3072 * Whether this CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ represents a success state.
3075 } LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ;
3078 * The contents of CResult_SignatureNoneZ
3080 typedef union LDKCResult_SignatureNoneZPtr {
3082 * A pointer to the contents in the success state.
3083 * Reading from this pointer when `result_ok` is not set is undefined.
3085 struct LDKSignature *result;
3087 * Note that this value is always NULL, as there are no contents in the Err variant
3090 } LDKCResult_SignatureNoneZPtr;
3093 * A CResult_SignatureNoneZ represents the result of a fallible operation,
3094 * containing a crate::c_types::Signature on success and a () on failure.
3095 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3097 typedef struct LDKCResult_SignatureNoneZ {
3099 * The contents of this CResult_SignatureNoneZ, accessible via either
3100 * `err` or `result` depending on the state of `result_ok`.
3102 union LDKCResult_SignatureNoneZPtr contents;
3104 * Whether this CResult_SignatureNoneZ represents a success state.
3107 } LDKCResult_SignatureNoneZ;
3112 * The unsigned part of a channel_announcement
3114 typedef struct MUST_USE_STRUCT LDKUnsignedChannelAnnouncement {
3116 * A pointer to the opaque Rust object.
3117 * Nearly everywhere, inner must be non-null, however in places where
3118 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3120 LDKnativeUnsignedChannelAnnouncement *inner;
3122 * Indicates that this is the only struct which contains the same pointer.
3123 * Rust functions which take ownership of an object provided via an argument require
3124 * this to be true and invalidate the object pointed to by inner.
3127 } LDKUnsignedChannelAnnouncement;
3130 * A trait to sign lightning channel transactions as described in BOLT 3.
3132 * Signing services could be implemented on a hardware wallet. In this case,
3133 * the current Sign would be a front-end on top of a communication
3134 * channel connected to your secure device and lightning key material wouldn't
3135 * reside on a hot server. Nevertheless, a this deployment would still need
3136 * to trust the ChannelManager to avoid loss of funds as this latest component
3137 * could ask to sign commitment transaction with HTLCs paying to attacker pubkeys.
3139 * A more secure iteration would be to use hashlock (or payment points) to pair
3140 * invoice/incoming HTLCs with outgoing HTLCs to implement a no-trust-ChannelManager
3141 * at the price of more state and computation on the hardware wallet side. In the future,
3142 * we are looking forward to design such interface.
3144 * In any case, ChannelMonitor or fallback watchtowers are always going to be trusted
3145 * to act, as liveness and breach reply correctness are always going to be hard requirements
3146 * of LN security model, orthogonal of key management issues.
3148 typedef struct LDKBaseSign {
3150 * An opaque pointer which is passed to your function implementations as an argument.
3151 * This has no meaning in the LDK, and can be NULL or any other value.
3155 * Gets the per-commitment point for a specific commitment number
3157 * Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
3159 struct LDKPublicKey (*get_per_commitment_point)(const void *this_arg, uint64_t idx);
3161 * Gets the commitment secret for a specific commitment number as part of the revocation process
3163 * An external signer implementation should error here if the commitment was already signed
3164 * and should refuse to sign it in the future.
3166 * May be called more than once for the same index.
3168 * Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
3170 struct LDKThirtyTwoBytes (*release_commitment_secret)(const void *this_arg, uint64_t idx);
3172 * Gets the holder's channel public keys and basepoints
3174 struct LDKChannelPublicKeys pubkeys;
3176 * Fill in the pubkeys field as a reference to it will be given to Rust after this returns
3177 * Note that this takes a pointer to this object, not the this_ptr like other methods do
3178 * This function pointer may be NULL if pubkeys is filled in when this object is created and never needs updating.
3180 void (*set_pubkeys)(const struct LDKBaseSign*NONNULL_PTR );
3182 * Gets an arbitrary identifier describing the set of keys which are provided back to you in
3183 * some SpendableOutputDescriptor types. This should be sufficient to identify this
3184 * Sign object uniquely and lookup or re-derive its keys.
3186 struct LDKThirtyTwoBytes (*channel_keys_id)(const void *this_arg);
3188 * Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
3190 * Note that if signing fails or is rejected, the channel will be force-closed.
3192 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ (*sign_counterparty_commitment)(const void *this_arg, const struct LDKCommitmentTransaction *NONNULL_PTR commitment_tx);
3194 * Create a signatures for a holder's commitment transaction and its claiming HTLC transactions.
3195 * This will only ever be called with a non-revoked commitment_tx. This will be called with the
3196 * latest commitment_tx when we initiate a force-close.
3197 * This will be called with the previous latest, just to get claiming HTLC signatures, if we are
3198 * reacting to a ChannelMonitor replica that decided to broadcast before it had been updated to
3200 * This may be called multiple times for the same transaction.
3202 * An external signer implementation should check that the commitment has not been revoked.
3204 * May return Err if key derivation fails. Callers, such as ChannelMonitor, will panic in such a case.
3206 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ (*sign_holder_commitment_and_htlcs)(const void *this_arg, const struct LDKHolderCommitmentTransaction *NONNULL_PTR commitment_tx);
3208 * Create a signature for the given input in a transaction spending an HTLC transaction output
3209 * or a commitment transaction `to_local` output when our counterparty broadcasts an old state.
3211 * A justice transaction may claim multiple outputs at the same time if timelocks are
3212 * similar, but only a signature for the input at index `input` should be signed for here.
3213 * It may be called multiple times for same output(s) if a fee-bump is needed with regards
3214 * to an upcoming timelock expiration.
3216 * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
3218 * per_commitment_key is revocation secret which was provided by our counterparty when they
3219 * revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
3220 * not allow the spending of any funds by itself (you need our holder revocation_secret to do
3223 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]);
3225 * Create a signature for the given input in a transaction spending a commitment transaction
3226 * HTLC output when our counterparty broadcasts an old state.
3228 * A justice transaction may claim multiple outputs at the same time if timelocks are
3229 * similar, but only a signature for the input at index `input` should be signed for here.
3230 * It may be called multiple times for same output(s) if a fee-bump is needed with regards
3231 * to an upcoming timelock expiration.
3233 * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
3235 * per_commitment_key is revocation secret which was provided by our counterparty when they
3236 * revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
3237 * not allow the spending of any funds by itself (you need our holder revocation_secret to do
3240 * htlc holds HTLC elements (hash, timelock), thus changing the format of the witness script
3241 * (which is committed to in the BIP 143 signatures).
3243 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);
3245 * Create a signature for a claiming transaction for a HTLC output on a counterparty's commitment
3246 * transaction, either offered or received.
3248 * Such a transaction may claim multiples offered outputs at same time if we know the
3249 * preimage for each when we create it, but only the input at index `input` should be
3250 * signed for here. It may be called multiple times for same output(s) if a fee-bump is
3251 * needed with regards to an upcoming timelock expiration.
3253 * Witness_script is either a offered or received script as defined in BOLT3 for HTLC
3256 * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
3258 * Per_commitment_point is the dynamic point corresponding to the channel state
3259 * detected onchain. It has been generated by our counterparty and is used to derive
3260 * channel state keys, which are then included in the witness script and committed to in the
3261 * BIP 143 signature.
3263 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);
3265 * Create a signature for a (proposed) closing transaction.
3267 * Note that, due to rounding, there may be one \"missing\" satoshi, and either party may have
3268 * chosen to forgo their output as dust.
3270 struct LDKCResult_SignatureNoneZ (*sign_closing_transaction)(const void *this_arg, struct LDKTransaction closing_tx);
3272 * Signs a channel announcement message with our funding key, proving it comes from one
3273 * of the channel participants.
3275 * Note that if this fails or is rejected, the channel will not be publicly announced and
3276 * our counterparty may (though likely will not) close the channel on us for violating the
3279 struct LDKCResult_SignatureNoneZ (*sign_channel_announcement)(const void *this_arg, const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR msg);
3281 * Set the counterparty static channel data, including basepoints,
3282 * counterparty_selected/holder_selected_contest_delay and funding outpoint.
3283 * This is done as soon as the funding outpoint is known. Since these are static channel data,
3284 * they MUST NOT be allowed to change to different values once set.
3286 * channel_parameters.is_populated() MUST be true.
3288 * We bind holder_selected_contest_delay late here for API convenience.
3290 * Will be called before any signatures are applied.
3292 void (*ready_channel)(void *this_arg, const struct LDKChannelTransactionParameters *NONNULL_PTR channel_parameters);
3294 * Frees any resources associated with this object given its this_arg pointer.
3295 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
3297 void (*free)(void *this_arg);
3301 * A cloneable signer.
3303 * Although we require signers to be cloneable, it may be useful for developers to be able to use
3304 * signers in an un-sized way, for example as `dyn BaseSign`. Therefore we separate the Clone trait,
3305 * which implies Sized, into this derived trait.
3307 typedef struct LDKSign {
3309 * An opaque pointer which is passed to your function implementations as an argument.
3310 * This has no meaning in the LDK, and can be NULL or any other value.
3314 * Implementation of BaseSign for this object.
3316 struct LDKBaseSign BaseSign;
3318 * Creates a copy of the BaseSign, for a copy of this Sign.
3319 * Because BaseSign doesn't natively support copying itself, you have to provide a full copy implementation here.
3321 struct LDKBaseSign (*BaseSign_clone)(const struct LDKBaseSign *NONNULL_PTR orig_BaseSign);
3323 * Serialize the object into a byte array
3325 struct LDKCVec_u8Z (*write)(const void *this_arg);
3327 * Creates a copy of the object pointed to by this_arg, for a copy of this Sign.
3328 * Note that the ultimate copy of the Sign will have all function pointers the same as the original.
3329 * May be NULL if no action needs to be taken, the this_arg pointer will be copied into the new Sign.
3331 void *(*clone)(const void *this_arg);
3333 * Frees any resources associated with this object given its this_arg pointer.
3334 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
3336 void (*free)(void *this_arg);
3340 * The contents of CResult_SignDecodeErrorZ
3342 typedef union LDKCResult_SignDecodeErrorZPtr {
3344 * A pointer to the contents in the success state.
3345 * Reading from this pointer when `result_ok` is not set is undefined.
3347 struct LDKSign *result;
3349 * A pointer to the contents in the error state.
3350 * Reading from this pointer when `result_ok` is set is undefined.
3352 struct LDKDecodeError *err;
3353 } LDKCResult_SignDecodeErrorZPtr;
3356 * A CResult_SignDecodeErrorZ represents the result of a fallible operation,
3357 * containing a crate::lightning::chain::keysinterface::Sign on success and a crate::lightning::ln::msgs::DecodeError on failure.
3358 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3360 typedef struct LDKCResult_SignDecodeErrorZ {
3362 * The contents of this CResult_SignDecodeErrorZ, accessible via either
3363 * `err` or `result` depending on the state of `result_ok`.
3365 union LDKCResult_SignDecodeErrorZPtr contents;
3367 * Whether this CResult_SignDecodeErrorZ represents a success state.
3370 } LDKCResult_SignDecodeErrorZ;
3373 * Represents a secp256k1 signature serialized as two 32-byte numbers as well as a tag which
3374 * allows recovering the exact public key which created the signature given the message.
3376 typedef struct LDKRecoverableSignature {
3378 * The bytes of the signature in "compact" form plus a "Recovery ID" which allows for
3381 uint8_t serialized_form[68];
3382 } LDKRecoverableSignature;
3385 * The contents of CResult_RecoverableSignatureNoneZ
3387 typedef union LDKCResult_RecoverableSignatureNoneZPtr {
3389 * A pointer to the contents in the success state.
3390 * Reading from this pointer when `result_ok` is not set is undefined.
3392 struct LDKRecoverableSignature *result;
3394 * Note that this value is always NULL, as there are no contents in the Err variant
3397 } LDKCResult_RecoverableSignatureNoneZPtr;
3400 * A CResult_RecoverableSignatureNoneZ represents the result of a fallible operation,
3401 * containing a crate::c_types::RecoverableSignature on success and a () on failure.
3402 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3404 typedef struct LDKCResult_RecoverableSignatureNoneZ {
3406 * The contents of this CResult_RecoverableSignatureNoneZ, accessible via either
3407 * `err` or `result` depending on the state of `result_ok`.
3409 union LDKCResult_RecoverableSignatureNoneZPtr contents;
3411 * Whether this CResult_RecoverableSignatureNoneZ represents a success state.
3414 } LDKCResult_RecoverableSignatureNoneZ;
3417 * A dynamically-allocated array of crate::c_types::derived::CVec_u8Zs of arbitrary size.
3418 * This corresponds to std::vector in C++
3420 typedef struct LDKCVec_CVec_u8ZZ {
3422 * The elements in the array.
3423 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
3425 struct LDKCVec_u8Z *data;
3427 * The number of elements pointed to by `data`.
3430 } LDKCVec_CVec_u8ZZ;
3433 * The contents of CResult_CVec_CVec_u8ZZNoneZ
3435 typedef union LDKCResult_CVec_CVec_u8ZZNoneZPtr {
3437 * A pointer to the contents in the success state.
3438 * Reading from this pointer when `result_ok` is not set is undefined.
3440 struct LDKCVec_CVec_u8ZZ *result;
3442 * Note that this value is always NULL, as there are no contents in the Err variant
3445 } LDKCResult_CVec_CVec_u8ZZNoneZPtr;
3448 * A CResult_CVec_CVec_u8ZZNoneZ represents the result of a fallible operation,
3449 * containing a crate::c_types::derived::CVec_CVec_u8ZZ on success and a () on failure.
3450 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3452 typedef struct LDKCResult_CVec_CVec_u8ZZNoneZ {
3454 * The contents of this CResult_CVec_CVec_u8ZZNoneZ, accessible via either
3455 * `err` or `result` depending on the state of `result_ok`.
3457 union LDKCResult_CVec_CVec_u8ZZNoneZPtr contents;
3459 * Whether this CResult_CVec_CVec_u8ZZNoneZ represents a success state.
3462 } LDKCResult_CVec_CVec_u8ZZNoneZ;
3467 * A simple implementation of Sign that just keeps the private keys in memory.
3469 * This implementation performs no policy checks and is insufficient by itself as
3470 * a secure external signer.
3472 typedef struct MUST_USE_STRUCT LDKInMemorySigner {
3474 * A pointer to the opaque Rust object.
3475 * Nearly everywhere, inner must be non-null, however in places where
3476 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3478 LDKnativeInMemorySigner *inner;
3480 * Indicates that this is the only struct which contains the same pointer.
3481 * Rust functions which take ownership of an object provided via an argument require
3482 * this to be true and invalidate the object pointed to by inner.
3485 } LDKInMemorySigner;
3488 * The contents of CResult_InMemorySignerDecodeErrorZ
3490 typedef union LDKCResult_InMemorySignerDecodeErrorZPtr {
3492 * A pointer to the contents in the success state.
3493 * Reading from this pointer when `result_ok` is not set is undefined.
3495 struct LDKInMemorySigner *result;
3497 * A pointer to the contents in the error state.
3498 * Reading from this pointer when `result_ok` is set is undefined.
3500 struct LDKDecodeError *err;
3501 } LDKCResult_InMemorySignerDecodeErrorZPtr;
3504 * A CResult_InMemorySignerDecodeErrorZ represents the result of a fallible operation,
3505 * containing a crate::lightning::chain::keysinterface::InMemorySigner on success and a crate::lightning::ln::msgs::DecodeError on failure.
3506 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3508 typedef struct LDKCResult_InMemorySignerDecodeErrorZ {
3510 * The contents of this CResult_InMemorySignerDecodeErrorZ, accessible via either
3511 * `err` or `result` depending on the state of `result_ok`.
3513 union LDKCResult_InMemorySignerDecodeErrorZPtr contents;
3515 * Whether this CResult_InMemorySignerDecodeErrorZ represents a success state.
3518 } LDKCResult_InMemorySignerDecodeErrorZ;
3521 * A dynamically-allocated array of crate::c_types::TxOuts of arbitrary size.
3522 * This corresponds to std::vector in C++
3524 typedef struct LDKCVec_TxOutZ {
3526 * The elements in the array.
3527 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
3529 struct LDKTxOut *data;
3531 * The number of elements pointed to by `data`.
3537 * The contents of CResult_TransactionNoneZ
3539 typedef union LDKCResult_TransactionNoneZPtr {
3541 * A pointer to the contents in the success state.
3542 * Reading from this pointer when `result_ok` is not set is undefined.
3544 struct LDKTransaction *result;
3546 * Note that this value is always NULL, as there are no contents in the Err variant
3549 } LDKCResult_TransactionNoneZPtr;
3552 * A CResult_TransactionNoneZ represents the result of a fallible operation,
3553 * containing a crate::c_types::Transaction on success and a () on failure.
3554 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3556 typedef struct LDKCResult_TransactionNoneZ {
3558 * The contents of this CResult_TransactionNoneZ, accessible via either
3559 * `err` or `result` depending on the state of `result_ok`.
3561 union LDKCResult_TransactionNoneZPtr contents;
3563 * Whether this CResult_TransactionNoneZ represents a success state.
3566 } LDKCResult_TransactionNoneZ;
3571 * A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
3572 * on-chain transactions to ensure no loss of funds occurs.
3574 * You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
3575 * information and are actively monitoring the chain.
3577 * Pending Events or updated HTLCs which have not yet been read out by
3578 * get_and_clear_pending_monitor_events or get_and_clear_pending_events are serialized to disk and
3579 * reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
3580 * gotten are fully handled before re-serializing the new state.
3582 * Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
3583 * tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
3584 * the \"reorg path\" (ie disconnecting blocks until you find a common ancestor from both the
3585 * returned block hash and the the current chain and then reconnecting blocks to get to the
3586 * best chain) upon deserializing the object!
3588 typedef struct MUST_USE_STRUCT LDKChannelMonitor {
3590 * A pointer to the opaque Rust object.
3591 * Nearly everywhere, inner must be non-null, however in places where
3592 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3594 LDKnativeChannelMonitor *inner;
3596 * Indicates that this is the only struct which contains the same pointer.
3597 * Rust functions which take ownership of an object provided via an argument require
3598 * this to be true and invalidate the object pointed to by inner.
3601 } LDKChannelMonitor;
3604 * A tuple of 2 elements. See the individual fields for the types contained.
3606 typedef struct LDKC2Tuple_BlockHashChannelMonitorZ {
3608 * The element at position 0
3610 struct LDKThirtyTwoBytes a;
3612 * The element at position 1
3614 struct LDKChannelMonitor b;
3615 } LDKC2Tuple_BlockHashChannelMonitorZ;
3618 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_BlockHashChannelMonitorZs of arbitrary size.
3619 * This corresponds to std::vector in C++
3621 typedef struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ {
3623 * The elements in the array.
3624 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
3626 struct LDKC2Tuple_BlockHashChannelMonitorZ *data;
3628 * The number of elements pointed to by `data`.
3631 } LDKCVec_C2Tuple_BlockHashChannelMonitorZZ;
3634 * The contents of CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ
3636 typedef union LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZPtr {
3638 * A pointer to the contents in the success state.
3639 * Reading from this pointer when `result_ok` is not set is undefined.
3641 struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ *result;
3643 * A pointer to the contents in the error state.
3644 * Reading from this pointer when `result_ok` is set is undefined.
3646 enum LDKIOError *err;
3647 } LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZPtr;
3650 * A CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ represents the result of a fallible operation,
3651 * containing a crate::c_types::derived::CVec_C2Tuple_BlockHashChannelMonitorZZ on success and a crate::c_types::IOError on failure.
3652 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3654 typedef struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ {
3656 * The contents of this CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ, accessible via either
3657 * `err` or `result` depending on the state of `result_ok`.
3659 union LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZPtr contents;
3661 * Whether this CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ represents a success state.
3664 } LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ;
3667 * Indicates an error on the client's part (usually some variant of attempting to use too-low or
3670 typedef enum LDKAPIError_Tag {
3672 * Indicates the API was wholly misused (see err for more). Cases where these can be returned
3673 * are documented, but generally indicates some precondition of a function was violated.
3675 LDKAPIError_APIMisuseError,
3677 * Due to a high feerate, we were unable to complete the request.
3678 * For example, this may be returned if the feerate implies we cannot open a channel at the
3679 * requested value, but opening a larger channel would succeed.
3681 LDKAPIError_FeeRateTooHigh,
3683 * A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
3684 * too-many-hops, etc).
3686 LDKAPIError_RouteError,
3688 * We were unable to complete the request as the Channel required to do so is unable to
3689 * complete the request (or was not found). This can take many forms, including disconnected
3690 * peer, channel at capacity, channel shutting down, etc.
3692 LDKAPIError_ChannelUnavailable,
3694 * An attempt to call watch/update_channel returned an Err (ie you did this!), causing the
3695 * attempted action to fail.
3697 LDKAPIError_MonitorUpdateFailed,
3699 * Must be last for serialization purposes
3701 LDKAPIError_Sentinel,
3704 typedef struct LDKAPIError_LDKAPIMisuseError_Body {
3706 * A human-readable error message
3709 } LDKAPIError_LDKAPIMisuseError_Body;
3711 typedef struct LDKAPIError_LDKFeeRateTooHigh_Body {
3713 * A human-readable error message
3717 * The feerate which was too high.
3720 } LDKAPIError_LDKFeeRateTooHigh_Body;
3722 typedef struct LDKAPIError_LDKRouteError_Body {
3724 * A human-readable error message
3727 } LDKAPIError_LDKRouteError_Body;
3729 typedef struct LDKAPIError_LDKChannelUnavailable_Body {
3731 * A human-readable error message
3734 } LDKAPIError_LDKChannelUnavailable_Body;
3736 typedef struct MUST_USE_STRUCT LDKAPIError {
3737 LDKAPIError_Tag tag;
3739 LDKAPIError_LDKAPIMisuseError_Body api_misuse_error;
3740 LDKAPIError_LDKFeeRateTooHigh_Body fee_rate_too_high;
3741 LDKAPIError_LDKRouteError_Body route_error;
3742 LDKAPIError_LDKChannelUnavailable_Body channel_unavailable;
3747 * The contents of CResult_NoneAPIErrorZ
3749 typedef union LDKCResult_NoneAPIErrorZPtr {
3751 * Note that this value is always NULL, as there are no contents in the OK variant
3755 * A pointer to the contents in the error state.
3756 * Reading from this pointer when `result_ok` is set is undefined.
3758 struct LDKAPIError *err;
3759 } LDKCResult_NoneAPIErrorZPtr;
3762 * A CResult_NoneAPIErrorZ represents the result of a fallible operation,
3763 * containing a () on success and a crate::lightning::util::errors::APIError on failure.
3764 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3766 typedef struct LDKCResult_NoneAPIErrorZ {
3768 * The contents of this CResult_NoneAPIErrorZ, accessible via either
3769 * `err` or `result` depending on the state of `result_ok`.
3771 union LDKCResult_NoneAPIErrorZPtr contents;
3773 * Whether this CResult_NoneAPIErrorZ represents a success state.
3776 } LDKCResult_NoneAPIErrorZ;
3779 * A dynamically-allocated array of crate::c_types::derived::CResult_NoneAPIErrorZs of arbitrary size.
3780 * This corresponds to std::vector in C++
3782 typedef struct LDKCVec_CResult_NoneAPIErrorZZ {
3784 * The elements in the array.
3785 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
3787 struct LDKCResult_NoneAPIErrorZ *data;
3789 * The number of elements pointed to by `data`.
3792 } LDKCVec_CResult_NoneAPIErrorZZ;
3795 * A dynamically-allocated array of crate::lightning::util::errors::APIErrors of arbitrary size.
3796 * This corresponds to std::vector in C++
3798 typedef struct LDKCVec_APIErrorZ {
3800 * The elements in the array.
3801 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
3803 struct LDKAPIError *data;
3805 * The number of elements pointed to by `data`.
3808 } LDKCVec_APIErrorZ;
3811 * If a payment fails to send, it can be in one of several states. This enum is returned as the
3812 * Err() type describing which state the payment is in, see the description of individual enum
3815 typedef enum LDKPaymentSendFailure_Tag {
3817 * A parameter which was passed to send_payment was invalid, preventing us from attempting to
3818 * send the payment at all. No channel state has been changed or messages sent to peers, and
3819 * once you've changed the parameter at error, you can freely retry the payment in full.
3821 LDKPaymentSendFailure_ParameterError,
3823 * A parameter in a single path which was passed to send_payment was invalid, preventing us
3824 * from attempting to send the payment at all. No channel state has been changed or messages
3825 * sent to peers, and once you've changed the parameter at error, you can freely retry the
3828 * The results here are ordered the same as the paths in the route object which was passed to
3831 LDKPaymentSendFailure_PathParameterError,
3833 * All paths which were attempted failed to send, with no channel state change taking place.
3834 * You can freely retry the payment in full (though you probably want to do so over different
3835 * paths than the ones selected).
3837 LDKPaymentSendFailure_AllFailedRetrySafe,
3839 * Some paths which were attempted failed to send, though possibly not all. At least some
3840 * paths have irrevocably committed to the HTLC and retrying the payment in full would result
3841 * in over-/re-payment.
3843 * The results here are ordered the same as the paths in the route object which was passed to
3844 * send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
3845 * retried (though there is currently no API with which to do so).
3847 * Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
3848 * as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
3849 * case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
3850 * with the latest update_id.
3852 LDKPaymentSendFailure_PartialFailure,
3854 * Must be last for serialization purposes
3856 LDKPaymentSendFailure_Sentinel,
3857 } LDKPaymentSendFailure_Tag;
3859 typedef struct MUST_USE_STRUCT LDKPaymentSendFailure {
3860 LDKPaymentSendFailure_Tag tag;
3863 struct LDKAPIError parameter_error;
3866 struct LDKCVec_CResult_NoneAPIErrorZZ path_parameter_error;
3869 struct LDKCVec_APIErrorZ all_failed_retry_safe;
3872 struct LDKCVec_CResult_NoneAPIErrorZZ partial_failure;
3875 } LDKPaymentSendFailure;
3878 * The contents of CResult_NonePaymentSendFailureZ
3880 typedef union LDKCResult_NonePaymentSendFailureZPtr {
3882 * Note that this value is always NULL, as there are no contents in the OK variant
3886 * A pointer to the contents in the error state.
3887 * Reading from this pointer when `result_ok` is set is undefined.
3889 struct LDKPaymentSendFailure *err;
3890 } LDKCResult_NonePaymentSendFailureZPtr;
3893 * A CResult_NonePaymentSendFailureZ represents the result of a fallible operation,
3894 * containing a () on success and a crate::lightning::ln::channelmanager::PaymentSendFailure on failure.
3895 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3897 typedef struct LDKCResult_NonePaymentSendFailureZ {
3899 * The contents of this CResult_NonePaymentSendFailureZ, accessible via either
3900 * `err` or `result` depending on the state of `result_ok`.
3902 union LDKCResult_NonePaymentSendFailureZPtr contents;
3904 * Whether this CResult_NonePaymentSendFailureZ represents a success state.
3907 } LDKCResult_NonePaymentSendFailureZ;
3910 * A 4-byte byte array.
3912 typedef struct LDKFourBytes {
3920 * A 16-byte byte array.
3922 typedef struct LDKSixteenBytes {
3930 * A 10-byte byte array.
3932 typedef struct LDKTenBytes {
3940 * An address which can be used to connect to a remote peer
3942 typedef enum LDKNetAddress_Tag {
3944 * An IPv4 address/port on which the peer is listening.
3948 * An IPv6 address/port on which the peer is listening.
3952 * An old-style Tor onion address/port on which the peer is listening.
3954 LDKNetAddress_OnionV2,
3956 * A new-style Tor onion address/port on which the peer is listening.
3957 * To create the human-readable \"hostname\", concatenate ed25519_pubkey, checksum, and version,
3958 * wrap as base32 and append \".onion\".
3960 LDKNetAddress_OnionV3,
3962 * Must be last for serialization purposes
3964 LDKNetAddress_Sentinel,
3965 } LDKNetAddress_Tag;
3967 typedef struct LDKNetAddress_LDKIPv4_Body {
3969 * The 4-byte IPv4 address
3971 struct LDKFourBytes addr;
3973 * The port on which the node is listening
3976 } LDKNetAddress_LDKIPv4_Body;
3978 typedef struct LDKNetAddress_LDKIPv6_Body {
3980 * The 16-byte IPv6 address
3982 struct LDKSixteenBytes addr;
3984 * The port on which the node is listening
3987 } LDKNetAddress_LDKIPv6_Body;
3989 typedef struct LDKNetAddress_LDKOnionV2_Body {
3991 * The bytes (usually encoded in base32 with \".onion\" appended)
3993 struct LDKTenBytes addr;
3995 * The port on which the node is listening
3998 } LDKNetAddress_LDKOnionV2_Body;
4000 typedef struct LDKNetAddress_LDKOnionV3_Body {
4002 * The ed25519 long-term public key of the peer
4004 struct LDKThirtyTwoBytes ed25519_pubkey;
4006 * The checksum of the pubkey and version, as included in the onion address
4010 * The version byte, as defined by the Tor Onion v3 spec.
4014 * The port on which the node is listening
4017 } LDKNetAddress_LDKOnionV3_Body;
4019 typedef struct MUST_USE_STRUCT LDKNetAddress {
4020 LDKNetAddress_Tag tag;
4022 LDKNetAddress_LDKIPv4_Body i_pv4;
4023 LDKNetAddress_LDKIPv6_Body i_pv6;
4024 LDKNetAddress_LDKOnionV2_Body onion_v2;
4025 LDKNetAddress_LDKOnionV3_Body onion_v3;
4030 * A dynamically-allocated array of crate::lightning::ln::msgs::NetAddresss of arbitrary size.
4031 * This corresponds to std::vector in C++
4033 typedef struct LDKCVec_NetAddressZ {
4035 * The elements in the array.
4036 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4038 struct LDKNetAddress *data;
4040 * The number of elements pointed to by `data`.
4043 } LDKCVec_NetAddressZ;
4046 * A tuple of 2 elements. See the individual fields for the types contained.
4048 typedef struct LDKC2Tuple_PaymentHashPaymentSecretZ {
4050 * The element at position 0
4052 struct LDKThirtyTwoBytes a;
4054 * The element at position 1
4056 struct LDKThirtyTwoBytes b;
4057 } LDKC2Tuple_PaymentHashPaymentSecretZ;
4060 * The contents of CResult_PaymentSecretAPIErrorZ
4062 typedef union LDKCResult_PaymentSecretAPIErrorZPtr {
4064 * A pointer to the contents in the success state.
4065 * Reading from this pointer when `result_ok` is not set is undefined.
4067 struct LDKThirtyTwoBytes *result;
4069 * A pointer to the contents in the error state.
4070 * Reading from this pointer when `result_ok` is set is undefined.
4072 struct LDKAPIError *err;
4073 } LDKCResult_PaymentSecretAPIErrorZPtr;
4076 * A CResult_PaymentSecretAPIErrorZ represents the result of a fallible operation,
4077 * containing a crate::c_types::ThirtyTwoBytes on success and a crate::lightning::util::errors::APIError on failure.
4078 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4080 typedef struct LDKCResult_PaymentSecretAPIErrorZ {
4082 * The contents of this CResult_PaymentSecretAPIErrorZ, accessible via either
4083 * `err` or `result` depending on the state of `result_ok`.
4085 union LDKCResult_PaymentSecretAPIErrorZPtr contents;
4087 * Whether this CResult_PaymentSecretAPIErrorZ represents a success state.
4090 } LDKCResult_PaymentSecretAPIErrorZ;
4093 * A dynamically-allocated array of crate::lightning::chain::channelmonitor::ChannelMonitors of arbitrary size.
4094 * This corresponds to std::vector in C++
4096 typedef struct LDKCVec_ChannelMonitorZ {
4098 * The elements in the array.
4099 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4101 struct LDKChannelMonitor *data;
4103 * The number of elements pointed to by `data`.
4106 } LDKCVec_ChannelMonitorZ;
4111 * An update generated by the underlying Channel itself which contains some new information the
4112 * ChannelMonitor should be made aware of.
4114 typedef struct MUST_USE_STRUCT LDKChannelMonitorUpdate {
4116 * A pointer to the opaque Rust object.
4117 * Nearly everywhere, inner must be non-null, however in places where
4118 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4120 LDKnativeChannelMonitorUpdate *inner;
4122 * Indicates that this is the only struct which contains the same pointer.
4123 * Rust functions which take ownership of an object provided via an argument require
4124 * this to be true and invalidate the object pointed to by inner.
4127 } LDKChannelMonitorUpdate;
4130 * The `Watch` trait defines behavior for watching on-chain activity pertaining to channels as
4131 * blocks are connected and disconnected.
4133 * Each channel is associated with a [`ChannelMonitor`]. Implementations of this trait are
4134 * responsible for maintaining a set of monitors such that they can be updated accordingly as
4135 * channel state changes and HTLCs are resolved. See method documentation for specific
4138 * Implementations **must** ensure that updates are successfully applied and persisted upon method
4139 * completion. If an update fails with a [`PermanentFailure`], then it must immediately shut down
4140 * without taking any further action such as persisting the current state.
4142 * If an implementation maintains multiple instances of a channel's monitor (e.g., by storing
4143 * backup copies), then it must ensure that updates are applied across all instances. Otherwise, it
4144 * could result in a revoked transaction being broadcast, allowing the counterparty to claim all
4145 * funds in the channel. See [`ChannelMonitorUpdateErr`] for more details about how to handle
4146 * multiple instances.
4148 * [`ChannelMonitor`]: channelmonitor::ChannelMonitor
4149 * [`ChannelMonitorUpdateErr`]: channelmonitor::ChannelMonitorUpdateErr
4150 * [`PermanentFailure`]: channelmonitor::ChannelMonitorUpdateErr::PermanentFailure
4152 typedef struct LDKWatch {
4154 * An opaque pointer which is passed to your function implementations as an argument.
4155 * This has no meaning in the LDK, and can be NULL or any other value.
4159 * Watches a channel identified by `funding_txo` using `monitor`.
4161 * Implementations are responsible for watching the chain for the funding transaction along
4162 * with any spends of outputs returned by [`get_outputs_to_watch`]. In practice, this means
4163 * calling [`block_connected`] and [`block_disconnected`] on the monitor.
4165 * [`get_outputs_to_watch`]: channelmonitor::ChannelMonitor::get_outputs_to_watch
4166 * [`block_connected`]: channelmonitor::ChannelMonitor::block_connected
4167 * [`block_disconnected`]: channelmonitor::ChannelMonitor::block_disconnected
4169 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*watch_channel)(const void *this_arg, struct LDKOutPoint funding_txo, struct LDKChannelMonitor monitor);
4171 * Updates a channel identified by `funding_txo` by applying `update` to its monitor.
4173 * Implementations must call [`update_monitor`] with the given update. See
4174 * [`ChannelMonitorUpdateErr`] for invariants around returning an error.
4176 * [`update_monitor`]: channelmonitor::ChannelMonitor::update_monitor
4177 * [`ChannelMonitorUpdateErr`]: channelmonitor::ChannelMonitorUpdateErr
4179 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*update_channel)(const void *this_arg, struct LDKOutPoint funding_txo, struct LDKChannelMonitorUpdate update);
4181 * Returns any monitor events since the last call. Subsequent calls must only return new
4184 struct LDKCVec_MonitorEventZ (*release_pending_monitor_events)(const void *this_arg);
4186 * Frees any resources associated with this object given its this_arg pointer.
4187 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4189 void (*free)(void *this_arg);
4193 * An interface to send a transaction to the Bitcoin network.
4195 typedef struct LDKBroadcasterInterface {
4197 * An opaque pointer which is passed to your function implementations as an argument.
4198 * This has no meaning in the LDK, and can be NULL or any other value.
4202 * Sends a transaction out to (hopefully) be mined.
4204 void (*broadcast_transaction)(const void *this_arg, struct LDKTransaction tx);
4206 * Frees any resources associated with this object given its this_arg pointer.
4207 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4209 void (*free)(void *this_arg);
4210 } LDKBroadcasterInterface;
4213 * A "slice" referencing some byte array. This is simply a length-tagged pointer which does not
4214 * own the memory pointed to by data.
4216 typedef struct LDKu8slice {
4218 * A pointer to the byte buffer
4220 const uint8_t *data;
4222 * The number of bytes pointed to by `data`.
4228 * A trait to describe an object which can get user secrets and key material.
4230 typedef struct LDKKeysInterface {
4232 * An opaque pointer which is passed to your function implementations as an argument.
4233 * This has no meaning in the LDK, and can be NULL or any other value.
4237 * Get node secret key (aka node_id or network_key).
4239 * This method must return the same value each time it is called.
4241 struct LDKSecretKey (*get_node_secret)(const void *this_arg);
4243 * Get a script pubkey which we send funds to when claiming on-chain contestable outputs.
4245 * This method should return a different value each time it is called, to avoid linking
4246 * on-chain funds across channels as controlled to the same user.
4248 struct LDKCVec_u8Z (*get_destination_script)(const void *this_arg);
4250 * Get a public key which we will send funds to (in the form of a P2WPKH output) when closing
4253 * This method should return a different value each time it is called, to avoid linking
4254 * on-chain funds across channels as controlled to the same user.
4256 struct LDKPublicKey (*get_shutdown_pubkey)(const void *this_arg);
4258 * Get a new set of Sign for per-channel secrets. These MUST be unique even if you
4259 * restarted with some stale data!
4261 * This method must return a different value each time it is called.
4263 struct LDKSign (*get_channel_signer)(const void *this_arg, bool inbound, uint64_t channel_value_satoshis);
4265 * Gets a unique, cryptographically-secure, random 32 byte value. This is used for encrypting
4266 * onion packets and for temporary channel IDs. There is no requirement that these be
4267 * persisted anywhere, though they must be unique across restarts.
4269 * This method must return a different value each time it is called.
4271 struct LDKThirtyTwoBytes (*get_secure_random_bytes)(const void *this_arg);
4273 * Reads a `Signer` for this `KeysInterface` from the given input stream.
4274 * This is only called during deserialization of other objects which contain
4275 * `Sign`-implementing objects (ie `ChannelMonitor`s and `ChannelManager`s).
4276 * The bytes are exactly those which `<Self::Signer as Writeable>::write()` writes, and
4277 * contain no versioning scheme. You may wish to include your own version prefix and ensure
4278 * you've read all of the provided bytes to ensure no corruption occurred.
4280 struct LDKCResult_SignDecodeErrorZ (*read_chan_signer)(const void *this_arg, struct LDKu8slice reader);
4282 * Sign an invoice's preimage (note that this is the preimage of the invoice, not the HTLC's
4283 * preimage). By parameterizing by the preimage instead of the hash, we allow implementors of
4284 * this trait to parse the invoice and make sure they're signing what they expect, rather than
4285 * blindly signing the hash.
4287 struct LDKCResult_RecoverableSignatureNoneZ (*sign_invoice)(const void *this_arg, struct LDKCVec_u8Z invoice_preimage);
4289 * Frees any resources associated with this object given its this_arg pointer.
4290 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4292 void (*free)(void *this_arg);
4296 * A trait which should be implemented to provide feerate information on a number of time
4299 * Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
4300 * called from inside the library in response to chain events, P2P events, or timer events).
4302 typedef struct LDKFeeEstimator {
4304 * An opaque pointer which is passed to your function implementations as an argument.
4305 * This has no meaning in the LDK, and can be NULL or any other value.
4309 * Gets estimated satoshis of fee required per 1000 Weight-Units.
4311 * Must be no smaller than 253 (ie 1 satoshi-per-byte rounded up to ensure later round-downs
4312 * don't put us below 1 satoshi-per-byte).
4314 * This translates to:
4315 * * satoshis-per-byte * 250
4316 * * ceil(satoshis-per-kbyte / 4)
4318 uint32_t (*get_est_sat_per_1000_weight)(const void *this_arg, enum LDKConfirmationTarget confirmation_target);
4320 * Frees any resources associated with this object given its this_arg pointer.
4321 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4323 void (*free)(void *this_arg);
4327 * A trait encapsulating the operations required of a logger
4329 typedef struct LDKLogger {
4331 * An opaque pointer which is passed to your function implementations as an argument.
4332 * This has no meaning in the LDK, and can be NULL or any other value.
4338 void (*log)(const void *this_arg, const char *record);
4340 * Frees any resources associated with this object given its this_arg pointer.
4341 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4343 void (*free)(void *this_arg);
4349 * Manager which keeps track of a number of channels and sends messages to the appropriate
4350 * channel, also tracking HTLC preimages and forwarding onion packets appropriately.
4352 * Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
4353 * to individual Channels.
4355 * Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
4356 * all peers during write/read (though does not modify this instance, only the instance being
4357 * serialized). This will result in any channels which have not yet exchanged funding_created (ie
4358 * called funding_transaction_generated for outbound channels).
4360 * Note that you can be a bit lazier about writing out ChannelManager than you can be with
4361 * ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
4362 * returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
4363 * happens out-of-band (and will prevent any other ChannelManager operations from occurring during
4364 * the serialization process). If the deserialized version is out-of-date compared to the
4365 * ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
4366 * ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
4368 * Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
4369 * tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
4370 * the \"reorg path\" (ie call block_disconnected() until you get to a common block and then call
4371 * block_connected() to step towards your best block) upon deserialization before using the
4374 * Note that ChannelManager is responsible for tracking liveness of its channels and generating
4375 * ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
4376 * spam due to quick disconnection/reconnection, updates are not sent until the channel has been
4377 * offline for a full minute. In order to track this, you must call
4378 * timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
4380 * Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
4381 * a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
4382 * essentially you should default to using a SimpleRefChannelManager, and use a
4383 * SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
4384 * you're using lightning-net-tokio.
4386 typedef struct MUST_USE_STRUCT LDKChannelManager {
4388 * A pointer to the opaque Rust object.
4389 * Nearly everywhere, inner must be non-null, however in places where
4390 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4392 LDKnativeChannelManager *inner;
4394 * Indicates that this is the only struct which contains the same pointer.
4395 * Rust functions which take ownership of an object provided via an argument require
4396 * this to be true and invalidate the object pointed to by inner.
4399 } LDKChannelManager;
4402 * A tuple of 2 elements. See the individual fields for the types contained.
4404 typedef struct LDKC2Tuple_BlockHashChannelManagerZ {
4406 * The element at position 0
4408 struct LDKThirtyTwoBytes a;
4410 * The element at position 1
4412 struct LDKChannelManager b;
4413 } LDKC2Tuple_BlockHashChannelManagerZ;
4416 * The contents of CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ
4418 typedef union LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr {
4420 * A pointer to the contents in the success state.
4421 * Reading from this pointer when `result_ok` is not set is undefined.
4423 struct LDKC2Tuple_BlockHashChannelManagerZ *result;
4425 * A pointer to the contents in the error state.
4426 * Reading from this pointer when `result_ok` is set is undefined.
4428 struct LDKDecodeError *err;
4429 } LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr;
4432 * A CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ represents the result of a fallible operation,
4433 * containing a crate::c_types::derived::C2Tuple_BlockHashChannelManagerZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
4434 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4436 typedef struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ {
4438 * The contents of this CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ, accessible via either
4439 * `err` or `result` depending on the state of `result_ok`.
4441 union LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr contents;
4443 * Whether this CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ represents a success state.
4446 } LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ;
4451 * Options which apply on a per-channel basis and may change at runtime or based on negotiation
4452 * with our counterparty.
4454 typedef struct MUST_USE_STRUCT LDKChannelConfig {
4456 * A pointer to the opaque Rust object.
4457 * Nearly everywhere, inner must be non-null, however in places where
4458 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4460 LDKnativeChannelConfig *inner;
4462 * Indicates that this is the only struct which contains the same pointer.
4463 * Rust functions which take ownership of an object provided via an argument require
4464 * this to be true and invalidate the object pointed to by inner.
4470 * The contents of CResult_ChannelConfigDecodeErrorZ
4472 typedef union LDKCResult_ChannelConfigDecodeErrorZPtr {
4474 * A pointer to the contents in the success state.
4475 * Reading from this pointer when `result_ok` is not set is undefined.
4477 struct LDKChannelConfig *result;
4479 * A pointer to the contents in the error state.
4480 * Reading from this pointer when `result_ok` is set is undefined.
4482 struct LDKDecodeError *err;
4483 } LDKCResult_ChannelConfigDecodeErrorZPtr;
4486 * A CResult_ChannelConfigDecodeErrorZ represents the result of a fallible operation,
4487 * containing a crate::lightning::util::config::ChannelConfig on success and a crate::lightning::ln::msgs::DecodeError on failure.
4488 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4490 typedef struct LDKCResult_ChannelConfigDecodeErrorZ {
4492 * The contents of this CResult_ChannelConfigDecodeErrorZ, accessible via either
4493 * `err` or `result` depending on the state of `result_ok`.
4495 union LDKCResult_ChannelConfigDecodeErrorZPtr contents;
4497 * Whether this CResult_ChannelConfigDecodeErrorZ represents a success state.
4500 } LDKCResult_ChannelConfigDecodeErrorZ;
4503 * The contents of CResult_OutPointDecodeErrorZ
4505 typedef union LDKCResult_OutPointDecodeErrorZPtr {
4507 * A pointer to the contents in the success state.
4508 * Reading from this pointer when `result_ok` is not set is undefined.
4510 struct LDKOutPoint *result;
4512 * A pointer to the contents in the error state.
4513 * Reading from this pointer when `result_ok` is set is undefined.
4515 struct LDKDecodeError *err;
4516 } LDKCResult_OutPointDecodeErrorZPtr;
4519 * A CResult_OutPointDecodeErrorZ represents the result of a fallible operation,
4520 * containing a crate::lightning::chain::transaction::OutPoint on success and a crate::lightning::ln::msgs::DecodeError on failure.
4521 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4523 typedef struct LDKCResult_OutPointDecodeErrorZ {
4525 * The contents of this CResult_OutPointDecodeErrorZ, accessible via either
4526 * `err` or `result` depending on the state of `result_ok`.
4528 union LDKCResult_OutPointDecodeErrorZPtr contents;
4530 * Whether this CResult_OutPointDecodeErrorZ represents a success state.
4533 } LDKCResult_OutPointDecodeErrorZ;
4536 * The contents of CResult_SiPrefixNoneZ
4538 typedef union LDKCResult_SiPrefixNoneZPtr {
4540 * A pointer to the contents in the success state.
4541 * Reading from this pointer when `result_ok` is not set is undefined.
4543 enum LDKSiPrefix *result;
4545 * Note that this value is always NULL, as there are no contents in the Err variant
4548 } LDKCResult_SiPrefixNoneZPtr;
4551 * A CResult_SiPrefixNoneZ represents the result of a fallible operation,
4552 * containing a crate::lightning_invoice::SiPrefix on success and a () on failure.
4553 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4555 typedef struct LDKCResult_SiPrefixNoneZ {
4557 * The contents of this CResult_SiPrefixNoneZ, accessible via either
4558 * `err` or `result` depending on the state of `result_ok`.
4560 union LDKCResult_SiPrefixNoneZPtr contents;
4562 * Whether this CResult_SiPrefixNoneZ represents a success state.
4565 } LDKCResult_SiPrefixNoneZ;
4570 * Represents a syntactically and semantically correct lightning BOLT11 invoice.
4572 * There are three ways to construct an `Invoice`:
4573 * 1. using `InvoiceBuilder`
4574 * 2. using `Invoice::from_signed(SignedRawInvoice)`
4575 * 3. using `str::parse::<Invoice>(&str)`
4577 typedef struct MUST_USE_STRUCT LDKInvoice {
4579 * A pointer to the opaque Rust object.
4580 * Nearly everywhere, inner must be non-null, however in places where
4581 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4583 LDKnativeInvoice *inner;
4585 * Indicates that this is the only struct which contains the same pointer.
4586 * Rust functions which take ownership of an object provided via an argument require
4587 * this to be true and invalidate the object pointed to by inner.
4593 * The contents of CResult_InvoiceNoneZ
4595 typedef union LDKCResult_InvoiceNoneZPtr {
4597 * A pointer to the contents in the success state.
4598 * Reading from this pointer when `result_ok` is not set is undefined.
4600 struct LDKInvoice *result;
4602 * Note that this value is always NULL, as there are no contents in the Err variant
4605 } LDKCResult_InvoiceNoneZPtr;
4608 * A CResult_InvoiceNoneZ represents the result of a fallible operation,
4609 * containing a crate::lightning_invoice::Invoice on success and a () on failure.
4610 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4612 typedef struct LDKCResult_InvoiceNoneZ {
4614 * The contents of this CResult_InvoiceNoneZ, accessible via either
4615 * `err` or `result` depending on the state of `result_ok`.
4617 union LDKCResult_InvoiceNoneZPtr contents;
4619 * Whether this CResult_InvoiceNoneZ represents a success state.
4622 } LDKCResult_InvoiceNoneZ;
4627 * Represents a signed `RawInvoice` with cached hash. The signature is not checked and may be
4631 * The hash has to be either from the deserialized invoice or from the serialized `raw_invoice`.
4633 typedef struct MUST_USE_STRUCT LDKSignedRawInvoice {
4635 * A pointer to the opaque Rust object.
4636 * Nearly everywhere, inner must be non-null, however in places where
4637 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4639 LDKnativeSignedRawInvoice *inner;
4641 * Indicates that this is the only struct which contains the same pointer.
4642 * Rust functions which take ownership of an object provided via an argument require
4643 * this to be true and invalidate the object pointed to by inner.
4646 } LDKSignedRawInvoice;
4649 * The contents of CResult_SignedRawInvoiceNoneZ
4651 typedef union LDKCResult_SignedRawInvoiceNoneZPtr {
4653 * A pointer to the contents in the success state.
4654 * Reading from this pointer when `result_ok` is not set is undefined.
4656 struct LDKSignedRawInvoice *result;
4658 * Note that this value is always NULL, as there are no contents in the Err variant
4661 } LDKCResult_SignedRawInvoiceNoneZPtr;
4664 * A CResult_SignedRawInvoiceNoneZ represents the result of a fallible operation,
4665 * containing a crate::lightning_invoice::SignedRawInvoice on success and a () on failure.
4666 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4668 typedef struct LDKCResult_SignedRawInvoiceNoneZ {
4670 * The contents of this CResult_SignedRawInvoiceNoneZ, accessible via either
4671 * `err` or `result` depending on the state of `result_ok`.
4673 union LDKCResult_SignedRawInvoiceNoneZPtr contents;
4675 * Whether this CResult_SignedRawInvoiceNoneZ represents a success state.
4678 } LDKCResult_SignedRawInvoiceNoneZ;
4683 * Represents an syntactically correct Invoice for a payment on the lightning network,
4684 * but without the signature information.
4685 * De- and encoding should not lead to information loss but may lead to different hashes.
4687 * For methods without docs see the corresponding methods in `Invoice`.
4689 typedef struct MUST_USE_STRUCT LDKRawInvoice {
4691 * A pointer to the opaque Rust object.
4692 * Nearly everywhere, inner must be non-null, however in places where
4693 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4695 LDKnativeRawInvoice *inner;
4697 * Indicates that this is the only struct which contains the same pointer.
4698 * Rust functions which take ownership of an object provided via an argument require
4699 * this to be true and invalidate the object pointed to by inner.
4707 * Recoverable signature
4709 typedef struct MUST_USE_STRUCT LDKInvoiceSignature {
4711 * A pointer to the opaque Rust object.
4712 * Nearly everywhere, inner must be non-null, however in places where
4713 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4715 LDKnativeInvoiceSignature *inner;
4717 * Indicates that this is the only struct which contains the same pointer.
4718 * Rust functions which take ownership of an object provided via an argument require
4719 * this to be true and invalidate the object pointed to by inner.
4722 } LDKInvoiceSignature;
4725 * A tuple of 3 elements. See the individual fields for the types contained.
4727 typedef struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ {
4729 * The element at position 0
4731 struct LDKRawInvoice a;
4733 * The element at position 1
4735 struct LDKThirtyTwoBytes b;
4737 * The element at position 2
4739 struct LDKInvoiceSignature c;
4740 } LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ;
4747 typedef struct MUST_USE_STRUCT LDKPayeePubKey {
4749 * A pointer to the opaque Rust object.
4750 * Nearly everywhere, inner must be non-null, however in places where
4751 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4753 LDKnativePayeePubKey *inner;
4755 * Indicates that this is the only struct which contains the same pointer.
4756 * Rust functions which take ownership of an object provided via an argument require
4757 * this to be true and invalidate the object pointed to by inner.
4763 * The contents of CResult_PayeePubKeyErrorZ
4765 typedef union LDKCResult_PayeePubKeyErrorZPtr {
4767 * A pointer to the contents in the success state.
4768 * Reading from this pointer when `result_ok` is not set is undefined.
4770 struct LDKPayeePubKey *result;
4772 * A pointer to the contents in the error state.
4773 * Reading from this pointer when `result_ok` is set is undefined.
4775 enum LDKSecp256k1Error *err;
4776 } LDKCResult_PayeePubKeyErrorZPtr;
4779 * A CResult_PayeePubKeyErrorZ represents the result of a fallible operation,
4780 * containing a crate::lightning_invoice::PayeePubKey on success and a crate::c_types::Secp256k1Error on failure.
4781 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4783 typedef struct LDKCResult_PayeePubKeyErrorZ {
4785 * The contents of this CResult_PayeePubKeyErrorZ, accessible via either
4786 * `err` or `result` depending on the state of `result_ok`.
4788 union LDKCResult_PayeePubKeyErrorZPtr contents;
4790 * Whether this CResult_PayeePubKeyErrorZ represents a success state.
4793 } LDKCResult_PayeePubKeyErrorZ;
4798 * Private routing information
4801 * The encoded route has to be <1024 5bit characters long (<=639 bytes or <=12 hops)
4804 typedef struct MUST_USE_STRUCT LDKRouteHint {
4806 * A pointer to the opaque Rust object.
4807 * Nearly everywhere, inner must be non-null, however in places where
4808 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4810 LDKnativeRouteHint *inner;
4812 * Indicates that this is the only struct which contains the same pointer.
4813 * Rust functions which take ownership of an object provided via an argument require
4814 * this to be true and invalidate the object pointed to by inner.
4820 * A dynamically-allocated array of crate::lightning_invoice::RouteHints of arbitrary size.
4821 * This corresponds to std::vector in C++
4823 typedef struct LDKCVec_RouteHintZ {
4825 * The elements in the array.
4826 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4828 struct LDKRouteHint *data;
4830 * The number of elements pointed to by `data`.
4833 } LDKCVec_RouteHintZ;
4838 * A timestamp that refers to a date after 1 January 1970 which means its representation as UNIX
4839 * timestamp is positive.
4842 * The UNIX timestamp representing the stored time has to be positive and small enough so that
4843 * a `EpiryTime` can be added to it without an overflow.
4845 typedef struct MUST_USE_STRUCT LDKPositiveTimestamp {
4847 * A pointer to the opaque Rust object.
4848 * Nearly everywhere, inner must be non-null, however in places where
4849 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4851 LDKnativePositiveTimestamp *inner;
4853 * Indicates that this is the only struct which contains the same pointer.
4854 * Rust functions which take ownership of an object provided via an argument require
4855 * this to be true and invalidate the object pointed to by inner.
4858 } LDKPositiveTimestamp;
4861 * The contents of CResult_PositiveTimestampCreationErrorZ
4863 typedef union LDKCResult_PositiveTimestampCreationErrorZPtr {
4865 * A pointer to the contents in the success state.
4866 * Reading from this pointer when `result_ok` is not set is undefined.
4868 struct LDKPositiveTimestamp *result;
4870 * A pointer to the contents in the error state.
4871 * Reading from this pointer when `result_ok` is set is undefined.
4873 enum LDKCreationError *err;
4874 } LDKCResult_PositiveTimestampCreationErrorZPtr;
4877 * A CResult_PositiveTimestampCreationErrorZ represents the result of a fallible operation,
4878 * containing a crate::lightning_invoice::PositiveTimestamp on success and a crate::lightning_invoice::CreationError on failure.
4879 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4881 typedef struct LDKCResult_PositiveTimestampCreationErrorZ {
4883 * The contents of this CResult_PositiveTimestampCreationErrorZ, accessible via either
4884 * `err` or `result` depending on the state of `result_ok`.
4886 union LDKCResult_PositiveTimestampCreationErrorZPtr contents;
4888 * Whether this CResult_PositiveTimestampCreationErrorZ represents a success state.
4891 } LDKCResult_PositiveTimestampCreationErrorZ;
4894 * The contents of CResult_NoneSemanticErrorZ
4896 typedef union LDKCResult_NoneSemanticErrorZPtr {
4898 * Note that this value is always NULL, as there are no contents in the OK variant
4902 * A pointer to the contents in the error state.
4903 * Reading from this pointer when `result_ok` is set is undefined.
4905 enum LDKSemanticError *err;
4906 } LDKCResult_NoneSemanticErrorZPtr;
4909 * A CResult_NoneSemanticErrorZ represents the result of a fallible operation,
4910 * containing a () on success and a crate::lightning_invoice::SemanticError on failure.
4911 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4913 typedef struct LDKCResult_NoneSemanticErrorZ {
4915 * The contents of this CResult_NoneSemanticErrorZ, accessible via either
4916 * `err` or `result` depending on the state of `result_ok`.
4918 union LDKCResult_NoneSemanticErrorZPtr contents;
4920 * Whether this CResult_NoneSemanticErrorZ represents a success state.
4923 } LDKCResult_NoneSemanticErrorZ;
4926 * The contents of CResult_InvoiceSemanticErrorZ
4928 typedef union LDKCResult_InvoiceSemanticErrorZPtr {
4930 * A pointer to the contents in the success state.
4931 * Reading from this pointer when `result_ok` is not set is undefined.
4933 struct LDKInvoice *result;
4935 * A pointer to the contents in the error state.
4936 * Reading from this pointer when `result_ok` is set is undefined.
4938 enum LDKSemanticError *err;
4939 } LDKCResult_InvoiceSemanticErrorZPtr;
4942 * A CResult_InvoiceSemanticErrorZ represents the result of a fallible operation,
4943 * containing a crate::lightning_invoice::Invoice on success and a crate::lightning_invoice::SemanticError on failure.
4944 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4946 typedef struct LDKCResult_InvoiceSemanticErrorZ {
4948 * The contents of this CResult_InvoiceSemanticErrorZ, accessible via either
4949 * `err` or `result` depending on the state of `result_ok`.
4951 union LDKCResult_InvoiceSemanticErrorZPtr contents;
4953 * Whether this CResult_InvoiceSemanticErrorZ represents a success state.
4956 } LDKCResult_InvoiceSemanticErrorZ;
4961 * Description string
4964 * The description can be at most 639 __bytes__ long
4966 typedef struct MUST_USE_STRUCT LDKDescription {
4968 * A pointer to the opaque Rust object.
4969 * Nearly everywhere, inner must be non-null, however in places where
4970 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4972 LDKnativeDescription *inner;
4974 * Indicates that this is the only struct which contains the same pointer.
4975 * Rust functions which take ownership of an object provided via an argument require
4976 * this to be true and invalidate the object pointed to by inner.
4982 * The contents of CResult_DescriptionCreationErrorZ
4984 typedef union LDKCResult_DescriptionCreationErrorZPtr {
4986 * A pointer to the contents in the success state.
4987 * Reading from this pointer when `result_ok` is not set is undefined.
4989 struct LDKDescription *result;
4991 * A pointer to the contents in the error state.
4992 * Reading from this pointer when `result_ok` is set is undefined.
4994 enum LDKCreationError *err;
4995 } LDKCResult_DescriptionCreationErrorZPtr;
4998 * A CResult_DescriptionCreationErrorZ represents the result of a fallible operation,
4999 * containing a crate::lightning_invoice::Description on success and a crate::lightning_invoice::CreationError on failure.
5000 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5002 typedef struct LDKCResult_DescriptionCreationErrorZ {
5004 * The contents of this CResult_DescriptionCreationErrorZ, accessible via either
5005 * `err` or `result` depending on the state of `result_ok`.
5007 union LDKCResult_DescriptionCreationErrorZPtr contents;
5009 * Whether this CResult_DescriptionCreationErrorZ represents a success state.
5012 } LDKCResult_DescriptionCreationErrorZ;
5017 * Positive duration that defines when (relatively to the timestamp) in the future the invoice
5021 * The number of seconds this expiry time represents has to be in the range
5022 * `0...(SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME)` to avoid overflows when adding it to a
5025 typedef struct MUST_USE_STRUCT LDKExpiryTime {
5027 * A pointer to the opaque Rust object.
5028 * Nearly everywhere, inner must be non-null, however in places where
5029 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5031 LDKnativeExpiryTime *inner;
5033 * Indicates that this is the only struct which contains the same pointer.
5034 * Rust functions which take ownership of an object provided via an argument require
5035 * this to be true and invalidate the object pointed to by inner.
5041 * The contents of CResult_ExpiryTimeCreationErrorZ
5043 typedef union LDKCResult_ExpiryTimeCreationErrorZPtr {
5045 * A pointer to the contents in the success state.
5046 * Reading from this pointer when `result_ok` is not set is undefined.
5048 struct LDKExpiryTime *result;
5050 * A pointer to the contents in the error state.
5051 * Reading from this pointer when `result_ok` is set is undefined.
5053 enum LDKCreationError *err;
5054 } LDKCResult_ExpiryTimeCreationErrorZPtr;
5057 * A CResult_ExpiryTimeCreationErrorZ represents the result of a fallible operation,
5058 * containing a crate::lightning_invoice::ExpiryTime on success and a crate::lightning_invoice::CreationError on failure.
5059 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5061 typedef struct LDKCResult_ExpiryTimeCreationErrorZ {
5063 * The contents of this CResult_ExpiryTimeCreationErrorZ, accessible via either
5064 * `err` or `result` depending on the state of `result_ok`.
5066 union LDKCResult_ExpiryTimeCreationErrorZPtr contents;
5068 * Whether this CResult_ExpiryTimeCreationErrorZ represents a success state.
5071 } LDKCResult_ExpiryTimeCreationErrorZ;
5074 * The contents of CResult_RouteHintCreationErrorZ
5076 typedef union LDKCResult_RouteHintCreationErrorZPtr {
5078 * A pointer to the contents in the success state.
5079 * Reading from this pointer when `result_ok` is not set is undefined.
5081 struct LDKRouteHint *result;
5083 * A pointer to the contents in the error state.
5084 * Reading from this pointer when `result_ok` is set is undefined.
5086 enum LDKCreationError *err;
5087 } LDKCResult_RouteHintCreationErrorZPtr;
5090 * A CResult_RouteHintCreationErrorZ represents the result of a fallible operation,
5091 * containing a crate::lightning_invoice::RouteHint on success and a crate::lightning_invoice::CreationError on failure.
5092 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5094 typedef struct LDKCResult_RouteHintCreationErrorZ {
5096 * The contents of this CResult_RouteHintCreationErrorZ, accessible via either
5097 * `err` or `result` depending on the state of `result_ok`.
5099 union LDKCResult_RouteHintCreationErrorZPtr contents;
5101 * Whether this CResult_RouteHintCreationErrorZ represents a success state.
5104 } LDKCResult_RouteHintCreationErrorZ;
5107 * The contents of CResult_StringErrorZ
5109 typedef union LDKCResult_StringErrorZPtr {
5111 * A pointer to the contents in the success state.
5112 * Reading from this pointer when `result_ok` is not set is undefined.
5114 struct LDKStr *result;
5116 * A pointer to the contents in the error state.
5117 * Reading from this pointer when `result_ok` is set is undefined.
5119 enum LDKSecp256k1Error *err;
5120 } LDKCResult_StringErrorZPtr;
5123 * A CResult_StringErrorZ represents the result of a fallible operation,
5124 * containing a crate::c_types::Str on success and a crate::c_types::Secp256k1Error on failure.
5125 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5127 typedef struct LDKCResult_StringErrorZ {
5129 * The contents of this CResult_StringErrorZ, accessible via either
5130 * `err` or `result` depending on the state of `result_ok`.
5132 union LDKCResult_StringErrorZPtr contents;
5134 * Whether this CResult_StringErrorZ represents a success state.
5137 } LDKCResult_StringErrorZ;
5140 * The contents of CResult_ChannelMonitorUpdateDecodeErrorZ
5142 typedef union LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr {
5144 * A pointer to the contents in the success state.
5145 * Reading from this pointer when `result_ok` is not set is undefined.
5147 struct LDKChannelMonitorUpdate *result;
5149 * A pointer to the contents in the error state.
5150 * Reading from this pointer when `result_ok` is set is undefined.
5152 struct LDKDecodeError *err;
5153 } LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr;
5156 * A CResult_ChannelMonitorUpdateDecodeErrorZ represents the result of a fallible operation,
5157 * containing a crate::lightning::chain::channelmonitor::ChannelMonitorUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
5158 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5160 typedef struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ {
5162 * The contents of this CResult_ChannelMonitorUpdateDecodeErrorZ, accessible via either
5163 * `err` or `result` depending on the state of `result_ok`.
5165 union LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr contents;
5167 * Whether this CResult_ChannelMonitorUpdateDecodeErrorZ represents a success state.
5170 } LDKCResult_ChannelMonitorUpdateDecodeErrorZ;
5173 * The contents of CResult_HTLCUpdateDecodeErrorZ
5175 typedef union LDKCResult_HTLCUpdateDecodeErrorZPtr {
5177 * A pointer to the contents in the success state.
5178 * Reading from this pointer when `result_ok` is not set is undefined.
5180 struct LDKHTLCUpdate *result;
5182 * A pointer to the contents in the error state.
5183 * Reading from this pointer when `result_ok` is set is undefined.
5185 struct LDKDecodeError *err;
5186 } LDKCResult_HTLCUpdateDecodeErrorZPtr;
5189 * A CResult_HTLCUpdateDecodeErrorZ represents the result of a fallible operation,
5190 * containing a crate::lightning::chain::channelmonitor::HTLCUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
5191 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5193 typedef struct LDKCResult_HTLCUpdateDecodeErrorZ {
5195 * The contents of this CResult_HTLCUpdateDecodeErrorZ, accessible via either
5196 * `err` or `result` depending on the state of `result_ok`.
5198 union LDKCResult_HTLCUpdateDecodeErrorZPtr contents;
5200 * Whether this CResult_HTLCUpdateDecodeErrorZ represents a success state.
5203 } LDKCResult_HTLCUpdateDecodeErrorZ;
5208 * General Err type for ChannelMonitor actions. Generally, this implies that the data provided is
5209 * inconsistent with the ChannelMonitor being called. eg for ChannelMonitor::update_monitor this
5210 * means you tried to update a monitor for a different channel or the ChannelMonitorUpdate was
5212 * Contains a developer-readable error message.
5214 typedef struct MUST_USE_STRUCT LDKMonitorUpdateError {
5216 * A pointer to the opaque Rust object.
5217 * Nearly everywhere, inner must be non-null, however in places where
5218 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5220 LDKnativeMonitorUpdateError *inner;
5222 * Indicates that this is the only struct which contains the same pointer.
5223 * Rust functions which take ownership of an object provided via an argument require
5224 * this to be true and invalidate the object pointed to by inner.
5227 } LDKMonitorUpdateError;
5230 * The contents of CResult_NoneMonitorUpdateErrorZ
5232 typedef union LDKCResult_NoneMonitorUpdateErrorZPtr {
5234 * Note that this value is always NULL, as there are no contents in the OK variant
5238 * A pointer to the contents in the error state.
5239 * Reading from this pointer when `result_ok` is set is undefined.
5241 struct LDKMonitorUpdateError *err;
5242 } LDKCResult_NoneMonitorUpdateErrorZPtr;
5245 * A CResult_NoneMonitorUpdateErrorZ represents the result of a fallible operation,
5246 * containing a () on success and a crate::lightning::chain::channelmonitor::MonitorUpdateError on failure.
5247 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5249 typedef struct LDKCResult_NoneMonitorUpdateErrorZ {
5251 * The contents of this CResult_NoneMonitorUpdateErrorZ, accessible via either
5252 * `err` or `result` depending on the state of `result_ok`.
5254 union LDKCResult_NoneMonitorUpdateErrorZPtr contents;
5256 * Whether this CResult_NoneMonitorUpdateErrorZ represents a success state.
5259 } LDKCResult_NoneMonitorUpdateErrorZ;
5262 * A tuple of 2 elements. See the individual fields for the types contained.
5264 typedef struct LDKC2Tuple_OutPointScriptZ {
5266 * The element at position 0
5268 struct LDKOutPoint a;
5270 * The element at position 1
5272 struct LDKCVec_u8Z b;
5273 } LDKC2Tuple_OutPointScriptZ;
5276 * A tuple of 2 elements. See the individual fields for the types contained.
5278 typedef struct LDKC2Tuple_u32ScriptZ {
5280 * The element at position 0
5284 * The element at position 1
5286 struct LDKCVec_u8Z b;
5287 } LDKC2Tuple_u32ScriptZ;
5290 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_u32ScriptZs of arbitrary size.
5291 * This corresponds to std::vector in C++
5293 typedef struct LDKCVec_C2Tuple_u32ScriptZZ {
5295 * The elements in the array.
5296 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5298 struct LDKC2Tuple_u32ScriptZ *data;
5300 * The number of elements pointed to by `data`.
5303 } LDKCVec_C2Tuple_u32ScriptZZ;
5306 * A tuple of 2 elements. See the individual fields for the types contained.
5308 typedef struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ {
5310 * The element at position 0
5312 struct LDKThirtyTwoBytes a;
5314 * The element at position 1
5316 struct LDKCVec_C2Tuple_u32ScriptZZ b;
5317 } LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ;
5320 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZs of arbitrary size.
5321 * This corresponds to std::vector in C++
5323 typedef struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ {
5325 * The elements in the array.
5326 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5328 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ *data;
5330 * The number of elements pointed to by `data`.
5333 } LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ;
5336 * An Event which you should probably take some action in response to.
5338 * Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
5339 * them directly as they don't round-trip exactly (for example FundingGenerationReady is never
5340 * written as it makes no sense to respond to it after reconnecting to peers).
5342 typedef enum LDKEvent_Tag {
5344 * Used to indicate that the client should generate a funding transaction with the given
5345 * parameters and then call ChannelManager::funding_transaction_generated.
5346 * Generated in ChannelManager message handling.
5347 * Note that *all inputs* in the funding transaction must spend SegWit outputs or your
5348 * counterparty can steal your funds!
5350 LDKEvent_FundingGenerationReady,
5352 * Indicates we've received money! Just gotta dig out that payment preimage and feed it to
5353 * ChannelManager::claim_funds to get it....
5354 * Note that if the preimage is not known or the amount paid is incorrect, you should call
5355 * ChannelManager::fail_htlc_backwards to free up resources for this HTLC and avoid
5356 * network congestion.
5357 * The amount paid should be considered 'incorrect' when it is less than or more than twice
5358 * the amount expected.
5359 * If you fail to call either ChannelManager::claim_funds or
5360 * ChannelManager::fail_htlc_backwards within the HTLC's timeout, the HTLC will be
5361 * automatically failed.
5363 LDKEvent_PaymentReceived,
5365 * Indicates an outbound payment we made succeeded (ie it made it all the way to its target
5366 * and we got back the payment preimage for it).
5368 LDKEvent_PaymentSent,
5370 * Indicates an outbound payment we made failed. Probably some intermediary node dropped
5371 * something. You may wish to retry with a different route.
5373 LDKEvent_PaymentFailed,
5375 * Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
5376 * time in the future.
5378 LDKEvent_PendingHTLCsForwardable,
5380 * Used to indicate that an output was generated on-chain which you should know how to spend.
5381 * Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
5382 * counterparty spending them due to some kind of timeout. Thus, you need to store them
5383 * somewhere and spend them when you create on-chain transactions.
5385 LDKEvent_SpendableOutputs,
5387 * Must be last for serialization purposes
5392 typedef struct LDKEvent_LDKFundingGenerationReady_Body {
5394 * The random channel_id we picked which you'll need to pass into
5395 * ChannelManager::funding_transaction_generated.
5397 struct LDKThirtyTwoBytes temporary_channel_id;
5399 * The value, in satoshis, that the output should have.
5401 uint64_t channel_value_satoshis;
5403 * The script which should be used in the transaction output.
5405 struct LDKCVec_u8Z output_script;
5407 * The value passed in to ChannelManager::create_channel
5409 uint64_t user_channel_id;
5410 } LDKEvent_LDKFundingGenerationReady_Body;
5412 typedef struct LDKEvent_LDKPaymentReceived_Body {
5414 * The hash for which the preimage should be handed to the ChannelManager.
5416 struct LDKThirtyTwoBytes payment_hash;
5418 * The preimage to the payment_hash, if the payment hash (and secret) were fetched via
5419 * [`ChannelManager::create_inbound_payment`]. If provided, this can be handed directly to
5420 * [`ChannelManager::claim_funds`].
5422 * [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
5423 * [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
5425 struct LDKThirtyTwoBytes payment_preimage;
5427 * The \"payment secret\". This authenticates the sender to the recipient, preventing a
5428 * number of deanonymization attacks during the routing process.
5429 * It is provided here for your reference, however its accuracy is enforced directly by
5430 * [`ChannelManager`] using the values you previously provided to
5431 * [`ChannelManager::create_inbound_payment`] or
5432 * [`ChannelManager::create_inbound_payment_for_hash`].
5434 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
5435 * [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
5436 * [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
5438 struct LDKThirtyTwoBytes payment_secret;
5440 * The value, in thousandths of a satoshi, that this payment is for. Note that you must
5441 * compare this to the expected value before accepting the payment (as otherwise you are
5442 * providing proof-of-payment for less than the value you expected!).
5446 * This is the `user_payment_id` which was provided to
5447 * [`ChannelManager::create_inbound_payment_for_hash`] or
5448 * [`ChannelManager::create_inbound_payment`]. It has no meaning inside of LDK and is
5449 * simply copied here. It may be used to correlate PaymentReceived events with invoice
5450 * metadata stored elsewhere.
5452 * [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
5453 * [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
5455 uint64_t user_payment_id;
5456 } LDKEvent_LDKPaymentReceived_Body;
5458 typedef struct LDKEvent_LDKPaymentSent_Body {
5460 * The preimage to the hash given to ChannelManager::send_payment.
5461 * Note that this serves as a payment receipt, if you wish to have such a thing, you must
5464 struct LDKThirtyTwoBytes payment_preimage;
5465 } LDKEvent_LDKPaymentSent_Body;
5467 typedef struct LDKEvent_LDKPaymentFailed_Body {
5469 * The hash which was given to ChannelManager::send_payment.
5471 struct LDKThirtyTwoBytes payment_hash;
5473 * Indicates the payment was rejected for some reason by the recipient. This implies that
5474 * the payment has failed, not just the route in question. If this is not set, you may
5475 * retry the payment via a different route.
5477 bool rejected_by_dest;
5478 } LDKEvent_LDKPaymentFailed_Body;
5480 typedef struct LDKEvent_LDKPendingHTLCsForwardable_Body {
5482 * The minimum amount of time that should be waited prior to calling
5483 * process_pending_htlc_forwards. To increase the effort required to correlate payments,
5484 * you should wait a random amount of time in roughly the range (now + time_forwardable,
5485 * now + 5*time_forwardable).
5487 uint64_t time_forwardable;
5488 } LDKEvent_LDKPendingHTLCsForwardable_Body;
5490 typedef struct LDKEvent_LDKSpendableOutputs_Body {
5492 * The outputs which you should store as spendable by you.
5494 struct LDKCVec_SpendableOutputDescriptorZ outputs;
5495 } LDKEvent_LDKSpendableOutputs_Body;
5497 typedef struct MUST_USE_STRUCT LDKEvent {
5500 LDKEvent_LDKFundingGenerationReady_Body funding_generation_ready;
5501 LDKEvent_LDKPaymentReceived_Body payment_received;
5502 LDKEvent_LDKPaymentSent_Body payment_sent;
5503 LDKEvent_LDKPaymentFailed_Body payment_failed;
5504 LDKEvent_LDKPendingHTLCsForwardable_Body pending_htl_cs_forwardable;
5505 LDKEvent_LDKSpendableOutputs_Body spendable_outputs;
5510 * A dynamically-allocated array of crate::lightning::util::events::Events of arbitrary size.
5511 * This corresponds to std::vector in C++
5513 typedef struct LDKCVec_EventZ {
5515 * The elements in the array.
5516 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5518 struct LDKEvent *data;
5520 * The number of elements pointed to by `data`.
5526 * A dynamically-allocated array of crate::c_types::Transactions of arbitrary size.
5527 * This corresponds to std::vector in C++
5529 typedef struct LDKCVec_TransactionZ {
5531 * The elements in the array.
5532 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5534 struct LDKTransaction *data;
5536 * The number of elements pointed to by `data`.
5539 } LDKCVec_TransactionZ;
5542 * A tuple of 2 elements. See the individual fields for the types contained.
5544 typedef struct LDKC2Tuple_u32TxOutZ {
5546 * The element at position 0
5550 * The element at position 1
5553 } LDKC2Tuple_u32TxOutZ;
5556 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_u32TxOutZs of arbitrary size.
5557 * This corresponds to std::vector in C++
5559 typedef struct LDKCVec_C2Tuple_u32TxOutZZ {
5561 * The elements in the array.
5562 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5564 struct LDKC2Tuple_u32TxOutZ *data;
5566 * The number of elements pointed to by `data`.
5569 } LDKCVec_C2Tuple_u32TxOutZZ;
5572 * A tuple of 2 elements. See the individual fields for the types contained.
5574 typedef struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ {
5576 * The element at position 0
5578 struct LDKThirtyTwoBytes a;
5580 * The element at position 1
5582 struct LDKCVec_C2Tuple_u32TxOutZZ b;
5583 } LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ;
5586 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZs of arbitrary size.
5587 * This corresponds to std::vector in C++
5589 typedef struct LDKCVec_TransactionOutputsZ {
5591 * The elements in the array.
5592 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5594 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ *data;
5596 * The number of elements pointed to by `data`.
5599 } LDKCVec_TransactionOutputsZ;
5602 * The contents of CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ
5604 typedef union LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr {
5606 * A pointer to the contents in the success state.
5607 * Reading from this pointer when `result_ok` is not set is undefined.
5609 struct LDKC2Tuple_BlockHashChannelMonitorZ *result;
5611 * A pointer to the contents in the error state.
5612 * Reading from this pointer when `result_ok` is set is undefined.
5614 struct LDKDecodeError *err;
5615 } LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr;
5618 * A CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ represents the result of a fallible operation,
5619 * containing a crate::c_types::derived::C2Tuple_BlockHashChannelMonitorZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
5620 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5622 typedef struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ {
5624 * The contents of this CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ, accessible via either
5625 * `err` or `result` depending on the state of `result_ok`.
5627 union LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr contents;
5629 * Whether this CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ represents a success state.
5632 } LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ;
5635 * The contents of CResult_boolLightningErrorZ
5637 typedef union LDKCResult_boolLightningErrorZPtr {
5639 * A pointer to the contents in the success state.
5640 * Reading from this pointer when `result_ok` is not set is undefined.
5644 * A pointer to the contents in the error state.
5645 * Reading from this pointer when `result_ok` is set is undefined.
5647 struct LDKLightningError *err;
5648 } LDKCResult_boolLightningErrorZPtr;
5651 * A CResult_boolLightningErrorZ represents the result of a fallible operation,
5652 * containing a bool on success and a crate::lightning::ln::msgs::LightningError on failure.
5653 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5655 typedef struct LDKCResult_boolLightningErrorZ {
5657 * The contents of this CResult_boolLightningErrorZ, accessible via either
5658 * `err` or `result` depending on the state of `result_ok`.
5660 union LDKCResult_boolLightningErrorZPtr contents;
5662 * Whether this CResult_boolLightningErrorZ represents a success state.
5665 } LDKCResult_boolLightningErrorZ;
5668 * A tuple of 3 elements. See the individual fields for the types contained.
5670 typedef struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ {
5672 * The element at position 0
5674 struct LDKChannelAnnouncement a;
5676 * The element at position 1
5678 struct LDKChannelUpdate b;
5680 * The element at position 2
5682 struct LDKChannelUpdate c;
5683 } LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ;
5686 * A dynamically-allocated array of crate::c_types::derived::C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZs of arbitrary size.
5687 * This corresponds to std::vector in C++
5689 typedef struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ {
5691 * The elements in the array.
5692 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5694 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ *data;
5696 * The number of elements pointed to by `data`.
5699 } LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ;
5702 * A dynamically-allocated array of crate::lightning::ln::msgs::NodeAnnouncements of arbitrary size.
5703 * This corresponds to std::vector in C++
5705 typedef struct LDKCVec_NodeAnnouncementZ {
5707 * The elements in the array.
5708 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5710 struct LDKNodeAnnouncement *data;
5712 * The number of elements pointed to by `data`.
5715 } LDKCVec_NodeAnnouncementZ;
5718 * The contents of CResult_NoneLightningErrorZ
5720 typedef union LDKCResult_NoneLightningErrorZPtr {
5722 * Note that this value is always NULL, as there are no contents in the OK variant
5726 * A pointer to the contents in the error state.
5727 * Reading from this pointer when `result_ok` is set is undefined.
5729 struct LDKLightningError *err;
5730 } LDKCResult_NoneLightningErrorZPtr;
5733 * A CResult_NoneLightningErrorZ represents the result of a fallible operation,
5734 * containing a () on success and a crate::lightning::ln::msgs::LightningError on failure.
5735 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5737 typedef struct LDKCResult_NoneLightningErrorZ {
5739 * The contents of this CResult_NoneLightningErrorZ, accessible via either
5740 * `err` or `result` depending on the state of `result_ok`.
5742 union LDKCResult_NoneLightningErrorZPtr contents;
5744 * Whether this CResult_NoneLightningErrorZ represents a success state.
5747 } LDKCResult_NoneLightningErrorZ;
5750 * A dynamically-allocated array of crate::c_types::PublicKeys of arbitrary size.
5751 * This corresponds to std::vector in C++
5753 typedef struct LDKCVec_PublicKeyZ {
5755 * The elements in the array.
5756 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5758 struct LDKPublicKey *data;
5760 * The number of elements pointed to by `data`.
5763 } LDKCVec_PublicKeyZ;
5768 * Error for PeerManager errors. If you get one of these, you must disconnect the socket and
5769 * generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
5772 typedef struct MUST_USE_STRUCT LDKPeerHandleError {
5774 * A pointer to the opaque Rust object.
5775 * Nearly everywhere, inner must be non-null, however in places where
5776 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5778 LDKnativePeerHandleError *inner;
5780 * Indicates that this is the only struct which contains the same pointer.
5781 * Rust functions which take ownership of an object provided via an argument require
5782 * this to be true and invalidate the object pointed to by inner.
5785 } LDKPeerHandleError;
5788 * The contents of CResult_CVec_u8ZPeerHandleErrorZ
5790 typedef union LDKCResult_CVec_u8ZPeerHandleErrorZPtr {
5792 * A pointer to the contents in the success state.
5793 * Reading from this pointer when `result_ok` is not set is undefined.
5795 struct LDKCVec_u8Z *result;
5797 * A pointer to the contents in the error state.
5798 * Reading from this pointer when `result_ok` is set is undefined.
5800 struct LDKPeerHandleError *err;
5801 } LDKCResult_CVec_u8ZPeerHandleErrorZPtr;
5804 * A CResult_CVec_u8ZPeerHandleErrorZ represents the result of a fallible operation,
5805 * containing a crate::c_types::derived::CVec_u8Z on success and a crate::lightning::ln::peer_handler::PeerHandleError on failure.
5806 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5808 typedef struct LDKCResult_CVec_u8ZPeerHandleErrorZ {
5810 * The contents of this CResult_CVec_u8ZPeerHandleErrorZ, accessible via either
5811 * `err` or `result` depending on the state of `result_ok`.
5813 union LDKCResult_CVec_u8ZPeerHandleErrorZPtr contents;
5815 * Whether this CResult_CVec_u8ZPeerHandleErrorZ represents a success state.
5818 } LDKCResult_CVec_u8ZPeerHandleErrorZ;
5821 * The contents of CResult_NonePeerHandleErrorZ
5823 typedef union LDKCResult_NonePeerHandleErrorZPtr {
5825 * Note that this value is always NULL, as there are no contents in the OK variant
5829 * A pointer to the contents in the error state.
5830 * Reading from this pointer when `result_ok` is set is undefined.
5832 struct LDKPeerHandleError *err;
5833 } LDKCResult_NonePeerHandleErrorZPtr;
5836 * A CResult_NonePeerHandleErrorZ represents the result of a fallible operation,
5837 * containing a () on success and a crate::lightning::ln::peer_handler::PeerHandleError on failure.
5838 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5840 typedef struct LDKCResult_NonePeerHandleErrorZ {
5842 * The contents of this CResult_NonePeerHandleErrorZ, accessible via either
5843 * `err` or `result` depending on the state of `result_ok`.
5845 union LDKCResult_NonePeerHandleErrorZPtr contents;
5847 * Whether this CResult_NonePeerHandleErrorZ represents a success state.
5850 } LDKCResult_NonePeerHandleErrorZ;
5853 * The contents of CResult_boolPeerHandleErrorZ
5855 typedef union LDKCResult_boolPeerHandleErrorZPtr {
5857 * A pointer to the contents in the success state.
5858 * Reading from this pointer when `result_ok` is not set is undefined.
5862 * A pointer to the contents in the error state.
5863 * Reading from this pointer when `result_ok` is set is undefined.
5865 struct LDKPeerHandleError *err;
5866 } LDKCResult_boolPeerHandleErrorZPtr;
5869 * A CResult_boolPeerHandleErrorZ represents the result of a fallible operation,
5870 * containing a bool on success and a crate::lightning::ln::peer_handler::PeerHandleError on failure.
5871 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5873 typedef struct LDKCResult_boolPeerHandleErrorZ {
5875 * The contents of this CResult_boolPeerHandleErrorZ, accessible via either
5876 * `err` or `result` depending on the state of `result_ok`.
5878 union LDKCResult_boolPeerHandleErrorZPtr contents;
5880 * Whether this CResult_boolPeerHandleErrorZ represents a success state.
5883 } LDKCResult_boolPeerHandleErrorZ;
5888 * Details about one direction of a channel. Received
5889 * within a channel update.
5891 typedef struct MUST_USE_STRUCT LDKDirectionalChannelInfo {
5893 * A pointer to the opaque Rust object.
5894 * Nearly everywhere, inner must be non-null, however in places where
5895 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5897 LDKnativeDirectionalChannelInfo *inner;
5899 * Indicates that this is the only struct which contains the same pointer.
5900 * Rust functions which take ownership of an object provided via an argument require
5901 * this to be true and invalidate the object pointed to by inner.
5904 } LDKDirectionalChannelInfo;
5907 * The contents of CResult_DirectionalChannelInfoDecodeErrorZ
5909 typedef union LDKCResult_DirectionalChannelInfoDecodeErrorZPtr {
5911 * A pointer to the contents in the success state.
5912 * Reading from this pointer when `result_ok` is not set is undefined.
5914 struct LDKDirectionalChannelInfo *result;
5916 * A pointer to the contents in the error state.
5917 * Reading from this pointer when `result_ok` is set is undefined.
5919 struct LDKDecodeError *err;
5920 } LDKCResult_DirectionalChannelInfoDecodeErrorZPtr;
5923 * A CResult_DirectionalChannelInfoDecodeErrorZ represents the result of a fallible operation,
5924 * containing a crate::lightning::routing::network_graph::DirectionalChannelInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
5925 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5927 typedef struct LDKCResult_DirectionalChannelInfoDecodeErrorZ {
5929 * The contents of this CResult_DirectionalChannelInfoDecodeErrorZ, accessible via either
5930 * `err` or `result` depending on the state of `result_ok`.
5932 union LDKCResult_DirectionalChannelInfoDecodeErrorZPtr contents;
5934 * Whether this CResult_DirectionalChannelInfoDecodeErrorZ represents a success state.
5937 } LDKCResult_DirectionalChannelInfoDecodeErrorZ;
5942 * Details about a channel (both directions).
5943 * Received within a channel announcement.
5945 typedef struct MUST_USE_STRUCT LDKChannelInfo {
5947 * A pointer to the opaque Rust object.
5948 * Nearly everywhere, inner must be non-null, however in places where
5949 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5951 LDKnativeChannelInfo *inner;
5953 * Indicates that this is the only struct which contains the same pointer.
5954 * Rust functions which take ownership of an object provided via an argument require
5955 * this to be true and invalidate the object pointed to by inner.
5961 * The contents of CResult_ChannelInfoDecodeErrorZ
5963 typedef union LDKCResult_ChannelInfoDecodeErrorZPtr {
5965 * A pointer to the contents in the success state.
5966 * Reading from this pointer when `result_ok` is not set is undefined.
5968 struct LDKChannelInfo *result;
5970 * A pointer to the contents in the error state.
5971 * Reading from this pointer when `result_ok` is set is undefined.
5973 struct LDKDecodeError *err;
5974 } LDKCResult_ChannelInfoDecodeErrorZPtr;
5977 * A CResult_ChannelInfoDecodeErrorZ represents the result of a fallible operation,
5978 * containing a crate::lightning::routing::network_graph::ChannelInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
5979 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5981 typedef struct LDKCResult_ChannelInfoDecodeErrorZ {
5983 * The contents of this CResult_ChannelInfoDecodeErrorZ, accessible via either
5984 * `err` or `result` depending on the state of `result_ok`.
5986 union LDKCResult_ChannelInfoDecodeErrorZPtr contents;
5988 * Whether this CResult_ChannelInfoDecodeErrorZ represents a success state.
5991 } LDKCResult_ChannelInfoDecodeErrorZ;
5996 * Fees for routing via a given channel or a node
5998 typedef struct MUST_USE_STRUCT LDKRoutingFees {
6000 * A pointer to the opaque Rust object.
6001 * Nearly everywhere, inner must be non-null, however in places where
6002 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6004 LDKnativeRoutingFees *inner;
6006 * Indicates that this is the only struct which contains the same pointer.
6007 * Rust functions which take ownership of an object provided via an argument require
6008 * this to be true and invalidate the object pointed to by inner.
6014 * The contents of CResult_RoutingFeesDecodeErrorZ
6016 typedef union LDKCResult_RoutingFeesDecodeErrorZPtr {
6018 * A pointer to the contents in the success state.
6019 * Reading from this pointer when `result_ok` is not set is undefined.
6021 struct LDKRoutingFees *result;
6023 * A pointer to the contents in the error state.
6024 * Reading from this pointer when `result_ok` is set is undefined.
6026 struct LDKDecodeError *err;
6027 } LDKCResult_RoutingFeesDecodeErrorZPtr;
6030 * A CResult_RoutingFeesDecodeErrorZ represents the result of a fallible operation,
6031 * containing a crate::lightning::routing::network_graph::RoutingFees on success and a crate::lightning::ln::msgs::DecodeError on failure.
6032 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6034 typedef struct LDKCResult_RoutingFeesDecodeErrorZ {
6036 * The contents of this CResult_RoutingFeesDecodeErrorZ, accessible via either
6037 * `err` or `result` depending on the state of `result_ok`.
6039 union LDKCResult_RoutingFeesDecodeErrorZPtr contents;
6041 * Whether this CResult_RoutingFeesDecodeErrorZ represents a success state.
6044 } LDKCResult_RoutingFeesDecodeErrorZ;
6049 * Information received in the latest node_announcement from this node.
6051 typedef struct MUST_USE_STRUCT LDKNodeAnnouncementInfo {
6053 * A pointer to the opaque Rust object.
6054 * Nearly everywhere, inner must be non-null, however in places where
6055 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6057 LDKnativeNodeAnnouncementInfo *inner;
6059 * Indicates that this is the only struct which contains the same pointer.
6060 * Rust functions which take ownership of an object provided via an argument require
6061 * this to be true and invalidate the object pointed to by inner.
6064 } LDKNodeAnnouncementInfo;
6067 * The contents of CResult_NodeAnnouncementInfoDecodeErrorZ
6069 typedef union LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr {
6071 * A pointer to the contents in the success state.
6072 * Reading from this pointer when `result_ok` is not set is undefined.
6074 struct LDKNodeAnnouncementInfo *result;
6076 * A pointer to the contents in the error state.
6077 * Reading from this pointer when `result_ok` is set is undefined.
6079 struct LDKDecodeError *err;
6080 } LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr;
6083 * A CResult_NodeAnnouncementInfoDecodeErrorZ represents the result of a fallible operation,
6084 * containing a crate::lightning::routing::network_graph::NodeAnnouncementInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
6085 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6087 typedef struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ {
6089 * The contents of this CResult_NodeAnnouncementInfoDecodeErrorZ, accessible via either
6090 * `err` or `result` depending on the state of `result_ok`.
6092 union LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr contents;
6094 * Whether this CResult_NodeAnnouncementInfoDecodeErrorZ represents a success state.
6097 } LDKCResult_NodeAnnouncementInfoDecodeErrorZ;
6100 * A dynamically-allocated array of u64s of arbitrary size.
6101 * This corresponds to std::vector in C++
6103 typedef struct LDKCVec_u64Z {
6105 * The elements in the array.
6106 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6110 * The number of elements pointed to by `data`.
6118 * Details about a node in the network, known from the network announcement.
6120 typedef struct MUST_USE_STRUCT LDKNodeInfo {
6122 * A pointer to the opaque Rust object.
6123 * Nearly everywhere, inner must be non-null, however in places where
6124 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6126 LDKnativeNodeInfo *inner;
6128 * Indicates that this is the only struct which contains the same pointer.
6129 * Rust functions which take ownership of an object provided via an argument require
6130 * this to be true and invalidate the object pointed to by inner.
6136 * The contents of CResult_NodeInfoDecodeErrorZ
6138 typedef union LDKCResult_NodeInfoDecodeErrorZPtr {
6140 * A pointer to the contents in the success state.
6141 * Reading from this pointer when `result_ok` is not set is undefined.
6143 struct LDKNodeInfo *result;
6145 * A pointer to the contents in the error state.
6146 * Reading from this pointer when `result_ok` is set is undefined.
6148 struct LDKDecodeError *err;
6149 } LDKCResult_NodeInfoDecodeErrorZPtr;
6152 * A CResult_NodeInfoDecodeErrorZ represents the result of a fallible operation,
6153 * containing a crate::lightning::routing::network_graph::NodeInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
6154 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6156 typedef struct LDKCResult_NodeInfoDecodeErrorZ {
6158 * The contents of this CResult_NodeInfoDecodeErrorZ, accessible via either
6159 * `err` or `result` depending on the state of `result_ok`.
6161 union LDKCResult_NodeInfoDecodeErrorZPtr contents;
6163 * Whether this CResult_NodeInfoDecodeErrorZ represents a success state.
6166 } LDKCResult_NodeInfoDecodeErrorZ;
6171 * Represents the network as nodes and channels between them
6173 typedef struct MUST_USE_STRUCT LDKNetworkGraph {
6175 * A pointer to the opaque Rust object.
6176 * Nearly everywhere, inner must be non-null, however in places where
6177 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6179 LDKnativeNetworkGraph *inner;
6181 * Indicates that this is the only struct which contains the same pointer.
6182 * Rust functions which take ownership of an object provided via an argument require
6183 * this to be true and invalidate the object pointed to by inner.
6189 * The contents of CResult_NetworkGraphDecodeErrorZ
6191 typedef union LDKCResult_NetworkGraphDecodeErrorZPtr {
6193 * A pointer to the contents in the success state.
6194 * Reading from this pointer when `result_ok` is not set is undefined.
6196 struct LDKNetworkGraph *result;
6198 * A pointer to the contents in the error state.
6199 * Reading from this pointer when `result_ok` is set is undefined.
6201 struct LDKDecodeError *err;
6202 } LDKCResult_NetworkGraphDecodeErrorZPtr;
6205 * A CResult_NetworkGraphDecodeErrorZ represents the result of a fallible operation,
6206 * containing a crate::lightning::routing::network_graph::NetworkGraph on success and a crate::lightning::ln::msgs::DecodeError on failure.
6207 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6209 typedef struct LDKCResult_NetworkGraphDecodeErrorZ {
6211 * The contents of this CResult_NetworkGraphDecodeErrorZ, accessible via either
6212 * `err` or `result` depending on the state of `result_ok`.
6214 union LDKCResult_NetworkGraphDecodeErrorZPtr contents;
6216 * Whether this CResult_NetworkGraphDecodeErrorZ represents a success state.
6219 } LDKCResult_NetworkGraphDecodeErrorZ;
6222 * The contents of CResult_NetAddressu8Z
6224 typedef union LDKCResult_NetAddressu8ZPtr {
6226 * A pointer to the contents in the success state.
6227 * Reading from this pointer when `result_ok` is not set is undefined.
6229 struct LDKNetAddress *result;
6231 * A pointer to the contents in the error state.
6232 * Reading from this pointer when `result_ok` is set is undefined.
6235 } LDKCResult_NetAddressu8ZPtr;
6238 * A CResult_NetAddressu8Z represents the result of a fallible operation,
6239 * containing a crate::lightning::ln::msgs::NetAddress on success and a u8 on failure.
6240 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6242 typedef struct LDKCResult_NetAddressu8Z {
6244 * The contents of this CResult_NetAddressu8Z, accessible via either
6245 * `err` or `result` depending on the state of `result_ok`.
6247 union LDKCResult_NetAddressu8ZPtr contents;
6249 * Whether this CResult_NetAddressu8Z represents a success state.
6252 } LDKCResult_NetAddressu8Z;
6255 * The contents of CResult_CResult_NetAddressu8ZDecodeErrorZ
6257 typedef union LDKCResult_CResult_NetAddressu8ZDecodeErrorZPtr {
6259 * A pointer to the contents in the success state.
6260 * Reading from this pointer when `result_ok` is not set is undefined.
6262 struct LDKCResult_NetAddressu8Z *result;
6264 * A pointer to the contents in the error state.
6265 * Reading from this pointer when `result_ok` is set is undefined.
6267 struct LDKDecodeError *err;
6268 } LDKCResult_CResult_NetAddressu8ZDecodeErrorZPtr;
6271 * A CResult_CResult_NetAddressu8ZDecodeErrorZ represents the result of a fallible operation,
6272 * containing a crate::c_types::derived::CResult_NetAddressu8Z on success and a crate::lightning::ln::msgs::DecodeError on failure.
6273 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6275 typedef struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ {
6277 * The contents of this CResult_CResult_NetAddressu8ZDecodeErrorZ, accessible via either
6278 * `err` or `result` depending on the state of `result_ok`.
6280 union LDKCResult_CResult_NetAddressu8ZDecodeErrorZPtr contents;
6282 * Whether this CResult_CResult_NetAddressu8ZDecodeErrorZ represents a success state.
6285 } LDKCResult_CResult_NetAddressu8ZDecodeErrorZ;
6288 * The contents of CResult_NetAddressDecodeErrorZ
6290 typedef union LDKCResult_NetAddressDecodeErrorZPtr {
6292 * A pointer to the contents in the success state.
6293 * Reading from this pointer when `result_ok` is not set is undefined.
6295 struct LDKNetAddress *result;
6297 * A pointer to the contents in the error state.
6298 * Reading from this pointer when `result_ok` is set is undefined.
6300 struct LDKDecodeError *err;
6301 } LDKCResult_NetAddressDecodeErrorZPtr;
6304 * A CResult_NetAddressDecodeErrorZ represents the result of a fallible operation,
6305 * containing a crate::lightning::ln::msgs::NetAddress on success and a crate::lightning::ln::msgs::DecodeError on failure.
6306 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6308 typedef struct LDKCResult_NetAddressDecodeErrorZ {
6310 * The contents of this CResult_NetAddressDecodeErrorZ, accessible via either
6311 * `err` or `result` depending on the state of `result_ok`.
6313 union LDKCResult_NetAddressDecodeErrorZPtr contents;
6315 * Whether this CResult_NetAddressDecodeErrorZ represents a success state.
6318 } LDKCResult_NetAddressDecodeErrorZ;
6323 * An update_add_htlc message to be sent or received from a peer
6325 typedef struct MUST_USE_STRUCT LDKUpdateAddHTLC {
6327 * A pointer to the opaque Rust object.
6328 * Nearly everywhere, inner must be non-null, however in places where
6329 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6331 LDKnativeUpdateAddHTLC *inner;
6333 * Indicates that this is the only struct which contains the same pointer.
6334 * Rust functions which take ownership of an object provided via an argument require
6335 * this to be true and invalidate the object pointed to by inner.
6341 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateAddHTLCs of arbitrary size.
6342 * This corresponds to std::vector in C++
6344 typedef struct LDKCVec_UpdateAddHTLCZ {
6346 * The elements in the array.
6347 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6349 struct LDKUpdateAddHTLC *data;
6351 * The number of elements pointed to by `data`.
6354 } LDKCVec_UpdateAddHTLCZ;
6359 * An update_fulfill_htlc message to be sent or received from a peer
6361 typedef struct MUST_USE_STRUCT LDKUpdateFulfillHTLC {
6363 * A pointer to the opaque Rust object.
6364 * Nearly everywhere, inner must be non-null, however in places where
6365 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6367 LDKnativeUpdateFulfillHTLC *inner;
6369 * Indicates that this is the only struct which contains the same pointer.
6370 * Rust functions which take ownership of an object provided via an argument require
6371 * this to be true and invalidate the object pointed to by inner.
6374 } LDKUpdateFulfillHTLC;
6377 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateFulfillHTLCs of arbitrary size.
6378 * This corresponds to std::vector in C++
6380 typedef struct LDKCVec_UpdateFulfillHTLCZ {
6382 * The elements in the array.
6383 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6385 struct LDKUpdateFulfillHTLC *data;
6387 * The number of elements pointed to by `data`.
6390 } LDKCVec_UpdateFulfillHTLCZ;
6395 * An update_fail_htlc message to be sent or received from a peer
6397 typedef struct MUST_USE_STRUCT LDKUpdateFailHTLC {
6399 * A pointer to the opaque Rust object.
6400 * Nearly everywhere, inner must be non-null, however in places where
6401 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6403 LDKnativeUpdateFailHTLC *inner;
6405 * Indicates that this is the only struct which contains the same pointer.
6406 * Rust functions which take ownership of an object provided via an argument require
6407 * this to be true and invalidate the object pointed to by inner.
6410 } LDKUpdateFailHTLC;
6413 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateFailHTLCs of arbitrary size.
6414 * This corresponds to std::vector in C++
6416 typedef struct LDKCVec_UpdateFailHTLCZ {
6418 * The elements in the array.
6419 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6421 struct LDKUpdateFailHTLC *data;
6423 * The number of elements pointed to by `data`.
6426 } LDKCVec_UpdateFailHTLCZ;
6431 * An update_fail_malformed_htlc message to be sent or received from a peer
6433 typedef struct MUST_USE_STRUCT LDKUpdateFailMalformedHTLC {
6435 * A pointer to the opaque Rust object.
6436 * Nearly everywhere, inner must be non-null, however in places where
6437 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6439 LDKnativeUpdateFailMalformedHTLC *inner;
6441 * Indicates that this is the only struct which contains the same pointer.
6442 * Rust functions which take ownership of an object provided via an argument require
6443 * this to be true and invalidate the object pointed to by inner.
6446 } LDKUpdateFailMalformedHTLC;
6449 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateFailMalformedHTLCs of arbitrary size.
6450 * This corresponds to std::vector in C++
6452 typedef struct LDKCVec_UpdateFailMalformedHTLCZ {
6454 * The elements in the array.
6455 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6457 struct LDKUpdateFailMalformedHTLC *data;
6459 * The number of elements pointed to by `data`.
6462 } LDKCVec_UpdateFailMalformedHTLCZ;
6465 * The contents of CResult_AcceptChannelDecodeErrorZ
6467 typedef union LDKCResult_AcceptChannelDecodeErrorZPtr {
6469 * A pointer to the contents in the success state.
6470 * Reading from this pointer when `result_ok` is not set is undefined.
6472 struct LDKAcceptChannel *result;
6474 * A pointer to the contents in the error state.
6475 * Reading from this pointer when `result_ok` is set is undefined.
6477 struct LDKDecodeError *err;
6478 } LDKCResult_AcceptChannelDecodeErrorZPtr;
6481 * A CResult_AcceptChannelDecodeErrorZ represents the result of a fallible operation,
6482 * containing a crate::lightning::ln::msgs::AcceptChannel on success and a crate::lightning::ln::msgs::DecodeError on failure.
6483 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6485 typedef struct LDKCResult_AcceptChannelDecodeErrorZ {
6487 * The contents of this CResult_AcceptChannelDecodeErrorZ, accessible via either
6488 * `err` or `result` depending on the state of `result_ok`.
6490 union LDKCResult_AcceptChannelDecodeErrorZPtr contents;
6492 * Whether this CResult_AcceptChannelDecodeErrorZ represents a success state.
6495 } LDKCResult_AcceptChannelDecodeErrorZ;
6498 * The contents of CResult_AnnouncementSignaturesDecodeErrorZ
6500 typedef union LDKCResult_AnnouncementSignaturesDecodeErrorZPtr {
6502 * A pointer to the contents in the success state.
6503 * Reading from this pointer when `result_ok` is not set is undefined.
6505 struct LDKAnnouncementSignatures *result;
6507 * A pointer to the contents in the error state.
6508 * Reading from this pointer when `result_ok` is set is undefined.
6510 struct LDKDecodeError *err;
6511 } LDKCResult_AnnouncementSignaturesDecodeErrorZPtr;
6514 * A CResult_AnnouncementSignaturesDecodeErrorZ represents the result of a fallible operation,
6515 * containing a crate::lightning::ln::msgs::AnnouncementSignatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
6516 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6518 typedef struct LDKCResult_AnnouncementSignaturesDecodeErrorZ {
6520 * The contents of this CResult_AnnouncementSignaturesDecodeErrorZ, accessible via either
6521 * `err` or `result` depending on the state of `result_ok`.
6523 union LDKCResult_AnnouncementSignaturesDecodeErrorZPtr contents;
6525 * Whether this CResult_AnnouncementSignaturesDecodeErrorZ represents a success state.
6528 } LDKCResult_AnnouncementSignaturesDecodeErrorZ;
6531 * The contents of CResult_ChannelReestablishDecodeErrorZ
6533 typedef union LDKCResult_ChannelReestablishDecodeErrorZPtr {
6535 * A pointer to the contents in the success state.
6536 * Reading from this pointer when `result_ok` is not set is undefined.
6538 struct LDKChannelReestablish *result;
6540 * A pointer to the contents in the error state.
6541 * Reading from this pointer when `result_ok` is set is undefined.
6543 struct LDKDecodeError *err;
6544 } LDKCResult_ChannelReestablishDecodeErrorZPtr;
6547 * A CResult_ChannelReestablishDecodeErrorZ represents the result of a fallible operation,
6548 * containing a crate::lightning::ln::msgs::ChannelReestablish on success and a crate::lightning::ln::msgs::DecodeError on failure.
6549 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6551 typedef struct LDKCResult_ChannelReestablishDecodeErrorZ {
6553 * The contents of this CResult_ChannelReestablishDecodeErrorZ, accessible via either
6554 * `err` or `result` depending on the state of `result_ok`.
6556 union LDKCResult_ChannelReestablishDecodeErrorZPtr contents;
6558 * Whether this CResult_ChannelReestablishDecodeErrorZ represents a success state.
6561 } LDKCResult_ChannelReestablishDecodeErrorZ;
6564 * The contents of CResult_ClosingSignedDecodeErrorZ
6566 typedef union LDKCResult_ClosingSignedDecodeErrorZPtr {
6568 * A pointer to the contents in the success state.
6569 * Reading from this pointer when `result_ok` is not set is undefined.
6571 struct LDKClosingSigned *result;
6573 * A pointer to the contents in the error state.
6574 * Reading from this pointer when `result_ok` is set is undefined.
6576 struct LDKDecodeError *err;
6577 } LDKCResult_ClosingSignedDecodeErrorZPtr;
6580 * A CResult_ClosingSignedDecodeErrorZ represents the result of a fallible operation,
6581 * containing a crate::lightning::ln::msgs::ClosingSigned on success and a crate::lightning::ln::msgs::DecodeError on failure.
6582 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6584 typedef struct LDKCResult_ClosingSignedDecodeErrorZ {
6586 * The contents of this CResult_ClosingSignedDecodeErrorZ, accessible via either
6587 * `err` or `result` depending on the state of `result_ok`.
6589 union LDKCResult_ClosingSignedDecodeErrorZPtr contents;
6591 * Whether this CResult_ClosingSignedDecodeErrorZ represents a success state.
6594 } LDKCResult_ClosingSignedDecodeErrorZ;
6599 * A commitment_signed message to be sent or received from a peer
6601 typedef struct MUST_USE_STRUCT LDKCommitmentSigned {
6603 * A pointer to the opaque Rust object.
6604 * Nearly everywhere, inner must be non-null, however in places where
6605 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6607 LDKnativeCommitmentSigned *inner;
6609 * Indicates that this is the only struct which contains the same pointer.
6610 * Rust functions which take ownership of an object provided via an argument require
6611 * this to be true and invalidate the object pointed to by inner.
6614 } LDKCommitmentSigned;
6617 * The contents of CResult_CommitmentSignedDecodeErrorZ
6619 typedef union LDKCResult_CommitmentSignedDecodeErrorZPtr {
6621 * A pointer to the contents in the success state.
6622 * Reading from this pointer when `result_ok` is not set is undefined.
6624 struct LDKCommitmentSigned *result;
6626 * A pointer to the contents in the error state.
6627 * Reading from this pointer when `result_ok` is set is undefined.
6629 struct LDKDecodeError *err;
6630 } LDKCResult_CommitmentSignedDecodeErrorZPtr;
6633 * A CResult_CommitmentSignedDecodeErrorZ represents the result of a fallible operation,
6634 * containing a crate::lightning::ln::msgs::CommitmentSigned on success and a crate::lightning::ln::msgs::DecodeError on failure.
6635 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6637 typedef struct LDKCResult_CommitmentSignedDecodeErrorZ {
6639 * The contents of this CResult_CommitmentSignedDecodeErrorZ, accessible via either
6640 * `err` or `result` depending on the state of `result_ok`.
6642 union LDKCResult_CommitmentSignedDecodeErrorZPtr contents;
6644 * Whether this CResult_CommitmentSignedDecodeErrorZ represents a success state.
6647 } LDKCResult_CommitmentSignedDecodeErrorZ;
6650 * The contents of CResult_FundingCreatedDecodeErrorZ
6652 typedef union LDKCResult_FundingCreatedDecodeErrorZPtr {
6654 * A pointer to the contents in the success state.
6655 * Reading from this pointer when `result_ok` is not set is undefined.
6657 struct LDKFundingCreated *result;
6659 * A pointer to the contents in the error state.
6660 * Reading from this pointer when `result_ok` is set is undefined.
6662 struct LDKDecodeError *err;
6663 } LDKCResult_FundingCreatedDecodeErrorZPtr;
6666 * A CResult_FundingCreatedDecodeErrorZ represents the result of a fallible operation,
6667 * containing a crate::lightning::ln::msgs::FundingCreated on success and a crate::lightning::ln::msgs::DecodeError on failure.
6668 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6670 typedef struct LDKCResult_FundingCreatedDecodeErrorZ {
6672 * The contents of this CResult_FundingCreatedDecodeErrorZ, accessible via either
6673 * `err` or `result` depending on the state of `result_ok`.
6675 union LDKCResult_FundingCreatedDecodeErrorZPtr contents;
6677 * Whether this CResult_FundingCreatedDecodeErrorZ represents a success state.
6680 } LDKCResult_FundingCreatedDecodeErrorZ;
6683 * The contents of CResult_FundingSignedDecodeErrorZ
6685 typedef union LDKCResult_FundingSignedDecodeErrorZPtr {
6687 * A pointer to the contents in the success state.
6688 * Reading from this pointer when `result_ok` is not set is undefined.
6690 struct LDKFundingSigned *result;
6692 * A pointer to the contents in the error state.
6693 * Reading from this pointer when `result_ok` is set is undefined.
6695 struct LDKDecodeError *err;
6696 } LDKCResult_FundingSignedDecodeErrorZPtr;
6699 * A CResult_FundingSignedDecodeErrorZ represents the result of a fallible operation,
6700 * containing a crate::lightning::ln::msgs::FundingSigned on success and a crate::lightning::ln::msgs::DecodeError on failure.
6701 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6703 typedef struct LDKCResult_FundingSignedDecodeErrorZ {
6705 * The contents of this CResult_FundingSignedDecodeErrorZ, accessible via either
6706 * `err` or `result` depending on the state of `result_ok`.
6708 union LDKCResult_FundingSignedDecodeErrorZPtr contents;
6710 * Whether this CResult_FundingSignedDecodeErrorZ represents a success state.
6713 } LDKCResult_FundingSignedDecodeErrorZ;
6716 * The contents of CResult_FundingLockedDecodeErrorZ
6718 typedef union LDKCResult_FundingLockedDecodeErrorZPtr {
6720 * A pointer to the contents in the success state.
6721 * Reading from this pointer when `result_ok` is not set is undefined.
6723 struct LDKFundingLocked *result;
6725 * A pointer to the contents in the error state.
6726 * Reading from this pointer when `result_ok` is set is undefined.
6728 struct LDKDecodeError *err;
6729 } LDKCResult_FundingLockedDecodeErrorZPtr;
6732 * A CResult_FundingLockedDecodeErrorZ represents the result of a fallible operation,
6733 * containing a crate::lightning::ln::msgs::FundingLocked on success and a crate::lightning::ln::msgs::DecodeError on failure.
6734 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6736 typedef struct LDKCResult_FundingLockedDecodeErrorZ {
6738 * The contents of this CResult_FundingLockedDecodeErrorZ, accessible via either
6739 * `err` or `result` depending on the state of `result_ok`.
6741 union LDKCResult_FundingLockedDecodeErrorZPtr contents;
6743 * Whether this CResult_FundingLockedDecodeErrorZ represents a success state.
6746 } LDKCResult_FundingLockedDecodeErrorZ;
6751 * An init message to be sent or received from a peer
6753 typedef struct MUST_USE_STRUCT LDKInit {
6755 * A pointer to the opaque Rust object.
6756 * Nearly everywhere, inner must be non-null, however in places where
6757 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6759 LDKnativeInit *inner;
6761 * Indicates that this is the only struct which contains the same pointer.
6762 * Rust functions which take ownership of an object provided via an argument require
6763 * this to be true and invalidate the object pointed to by inner.
6769 * The contents of CResult_InitDecodeErrorZ
6771 typedef union LDKCResult_InitDecodeErrorZPtr {
6773 * A pointer to the contents in the success state.
6774 * Reading from this pointer when `result_ok` is not set is undefined.
6776 struct LDKInit *result;
6778 * A pointer to the contents in the error state.
6779 * Reading from this pointer when `result_ok` is set is undefined.
6781 struct LDKDecodeError *err;
6782 } LDKCResult_InitDecodeErrorZPtr;
6785 * A CResult_InitDecodeErrorZ represents the result of a fallible operation,
6786 * containing a crate::lightning::ln::msgs::Init on success and a crate::lightning::ln::msgs::DecodeError on failure.
6787 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6789 typedef struct LDKCResult_InitDecodeErrorZ {
6791 * The contents of this CResult_InitDecodeErrorZ, accessible via either
6792 * `err` or `result` depending on the state of `result_ok`.
6794 union LDKCResult_InitDecodeErrorZPtr contents;
6796 * Whether this CResult_InitDecodeErrorZ represents a success state.
6799 } LDKCResult_InitDecodeErrorZ;
6802 * The contents of CResult_OpenChannelDecodeErrorZ
6804 typedef union LDKCResult_OpenChannelDecodeErrorZPtr {
6806 * A pointer to the contents in the success state.
6807 * Reading from this pointer when `result_ok` is not set is undefined.
6809 struct LDKOpenChannel *result;
6811 * A pointer to the contents in the error state.
6812 * Reading from this pointer when `result_ok` is set is undefined.
6814 struct LDKDecodeError *err;
6815 } LDKCResult_OpenChannelDecodeErrorZPtr;
6818 * A CResult_OpenChannelDecodeErrorZ represents the result of a fallible operation,
6819 * containing a crate::lightning::ln::msgs::OpenChannel on success and a crate::lightning::ln::msgs::DecodeError on failure.
6820 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6822 typedef struct LDKCResult_OpenChannelDecodeErrorZ {
6824 * The contents of this CResult_OpenChannelDecodeErrorZ, accessible via either
6825 * `err` or `result` depending on the state of `result_ok`.
6827 union LDKCResult_OpenChannelDecodeErrorZPtr contents;
6829 * Whether this CResult_OpenChannelDecodeErrorZ represents a success state.
6832 } LDKCResult_OpenChannelDecodeErrorZ;
6835 * The contents of CResult_RevokeAndACKDecodeErrorZ
6837 typedef union LDKCResult_RevokeAndACKDecodeErrorZPtr {
6839 * A pointer to the contents in the success state.
6840 * Reading from this pointer when `result_ok` is not set is undefined.
6842 struct LDKRevokeAndACK *result;
6844 * A pointer to the contents in the error state.
6845 * Reading from this pointer when `result_ok` is set is undefined.
6847 struct LDKDecodeError *err;
6848 } LDKCResult_RevokeAndACKDecodeErrorZPtr;
6851 * A CResult_RevokeAndACKDecodeErrorZ represents the result of a fallible operation,
6852 * containing a crate::lightning::ln::msgs::RevokeAndACK on success and a crate::lightning::ln::msgs::DecodeError on failure.
6853 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6855 typedef struct LDKCResult_RevokeAndACKDecodeErrorZ {
6857 * The contents of this CResult_RevokeAndACKDecodeErrorZ, accessible via either
6858 * `err` or `result` depending on the state of `result_ok`.
6860 union LDKCResult_RevokeAndACKDecodeErrorZPtr contents;
6862 * Whether this CResult_RevokeAndACKDecodeErrorZ represents a success state.
6865 } LDKCResult_RevokeAndACKDecodeErrorZ;
6868 * The contents of CResult_ShutdownDecodeErrorZ
6870 typedef union LDKCResult_ShutdownDecodeErrorZPtr {
6872 * A pointer to the contents in the success state.
6873 * Reading from this pointer when `result_ok` is not set is undefined.
6875 struct LDKShutdown *result;
6877 * A pointer to the contents in the error state.
6878 * Reading from this pointer when `result_ok` is set is undefined.
6880 struct LDKDecodeError *err;
6881 } LDKCResult_ShutdownDecodeErrorZPtr;
6884 * A CResult_ShutdownDecodeErrorZ represents the result of a fallible operation,
6885 * containing a crate::lightning::ln::msgs::Shutdown on success and a crate::lightning::ln::msgs::DecodeError on failure.
6886 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6888 typedef struct LDKCResult_ShutdownDecodeErrorZ {
6890 * The contents of this CResult_ShutdownDecodeErrorZ, accessible via either
6891 * `err` or `result` depending on the state of `result_ok`.
6893 union LDKCResult_ShutdownDecodeErrorZPtr contents;
6895 * Whether this CResult_ShutdownDecodeErrorZ represents a success state.
6898 } LDKCResult_ShutdownDecodeErrorZ;
6901 * The contents of CResult_UpdateFailHTLCDecodeErrorZ
6903 typedef union LDKCResult_UpdateFailHTLCDecodeErrorZPtr {
6905 * A pointer to the contents in the success state.
6906 * Reading from this pointer when `result_ok` is not set is undefined.
6908 struct LDKUpdateFailHTLC *result;
6910 * A pointer to the contents in the error state.
6911 * Reading from this pointer when `result_ok` is set is undefined.
6913 struct LDKDecodeError *err;
6914 } LDKCResult_UpdateFailHTLCDecodeErrorZPtr;
6917 * A CResult_UpdateFailHTLCDecodeErrorZ represents the result of a fallible operation,
6918 * containing a crate::lightning::ln::msgs::UpdateFailHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
6919 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6921 typedef struct LDKCResult_UpdateFailHTLCDecodeErrorZ {
6923 * The contents of this CResult_UpdateFailHTLCDecodeErrorZ, accessible via either
6924 * `err` or `result` depending on the state of `result_ok`.
6926 union LDKCResult_UpdateFailHTLCDecodeErrorZPtr contents;
6928 * Whether this CResult_UpdateFailHTLCDecodeErrorZ represents a success state.
6931 } LDKCResult_UpdateFailHTLCDecodeErrorZ;
6934 * The contents of CResult_UpdateFailMalformedHTLCDecodeErrorZ
6936 typedef union LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr {
6938 * A pointer to the contents in the success state.
6939 * Reading from this pointer when `result_ok` is not set is undefined.
6941 struct LDKUpdateFailMalformedHTLC *result;
6943 * A pointer to the contents in the error state.
6944 * Reading from this pointer when `result_ok` is set is undefined.
6946 struct LDKDecodeError *err;
6947 } LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr;
6950 * A CResult_UpdateFailMalformedHTLCDecodeErrorZ represents the result of a fallible operation,
6951 * containing a crate::lightning::ln::msgs::UpdateFailMalformedHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
6952 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6954 typedef struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ {
6956 * The contents of this CResult_UpdateFailMalformedHTLCDecodeErrorZ, accessible via either
6957 * `err` or `result` depending on the state of `result_ok`.
6959 union LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr contents;
6961 * Whether this CResult_UpdateFailMalformedHTLCDecodeErrorZ represents a success state.
6964 } LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ;
6969 * An update_fee message to be sent or received from a peer
6971 typedef struct MUST_USE_STRUCT LDKUpdateFee {
6973 * A pointer to the opaque Rust object.
6974 * Nearly everywhere, inner must be non-null, however in places where
6975 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6977 LDKnativeUpdateFee *inner;
6979 * Indicates that this is the only struct which contains the same pointer.
6980 * Rust functions which take ownership of an object provided via an argument require
6981 * this to be true and invalidate the object pointed to by inner.
6987 * The contents of CResult_UpdateFeeDecodeErrorZ
6989 typedef union LDKCResult_UpdateFeeDecodeErrorZPtr {
6991 * A pointer to the contents in the success state.
6992 * Reading from this pointer when `result_ok` is not set is undefined.
6994 struct LDKUpdateFee *result;
6996 * A pointer to the contents in the error state.
6997 * Reading from this pointer when `result_ok` is set is undefined.
6999 struct LDKDecodeError *err;
7000 } LDKCResult_UpdateFeeDecodeErrorZPtr;
7003 * A CResult_UpdateFeeDecodeErrorZ represents the result of a fallible operation,
7004 * containing a crate::lightning::ln::msgs::UpdateFee on success and a crate::lightning::ln::msgs::DecodeError on failure.
7005 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7007 typedef struct LDKCResult_UpdateFeeDecodeErrorZ {
7009 * The contents of this CResult_UpdateFeeDecodeErrorZ, accessible via either
7010 * `err` or `result` depending on the state of `result_ok`.
7012 union LDKCResult_UpdateFeeDecodeErrorZPtr contents;
7014 * Whether this CResult_UpdateFeeDecodeErrorZ represents a success state.
7017 } LDKCResult_UpdateFeeDecodeErrorZ;
7020 * The contents of CResult_UpdateFulfillHTLCDecodeErrorZ
7022 typedef union LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr {
7024 * A pointer to the contents in the success state.
7025 * Reading from this pointer when `result_ok` is not set is undefined.
7027 struct LDKUpdateFulfillHTLC *result;
7029 * A pointer to the contents in the error state.
7030 * Reading from this pointer when `result_ok` is set is undefined.
7032 struct LDKDecodeError *err;
7033 } LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr;
7036 * A CResult_UpdateFulfillHTLCDecodeErrorZ represents the result of a fallible operation,
7037 * containing a crate::lightning::ln::msgs::UpdateFulfillHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
7038 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7040 typedef struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ {
7042 * The contents of this CResult_UpdateFulfillHTLCDecodeErrorZ, accessible via either
7043 * `err` or `result` depending on the state of `result_ok`.
7045 union LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr contents;
7047 * Whether this CResult_UpdateFulfillHTLCDecodeErrorZ represents a success state.
7050 } LDKCResult_UpdateFulfillHTLCDecodeErrorZ;
7053 * The contents of CResult_UpdateAddHTLCDecodeErrorZ
7055 typedef union LDKCResult_UpdateAddHTLCDecodeErrorZPtr {
7057 * A pointer to the contents in the success state.
7058 * Reading from this pointer when `result_ok` is not set is undefined.
7060 struct LDKUpdateAddHTLC *result;
7062 * A pointer to the contents in the error state.
7063 * Reading from this pointer when `result_ok` is set is undefined.
7065 struct LDKDecodeError *err;
7066 } LDKCResult_UpdateAddHTLCDecodeErrorZPtr;
7069 * A CResult_UpdateAddHTLCDecodeErrorZ represents the result of a fallible operation,
7070 * containing a crate::lightning::ln::msgs::UpdateAddHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
7071 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7073 typedef struct LDKCResult_UpdateAddHTLCDecodeErrorZ {
7075 * The contents of this CResult_UpdateAddHTLCDecodeErrorZ, accessible via either
7076 * `err` or `result` depending on the state of `result_ok`.
7078 union LDKCResult_UpdateAddHTLCDecodeErrorZPtr contents;
7080 * Whether this CResult_UpdateAddHTLCDecodeErrorZ represents a success state.
7083 } LDKCResult_UpdateAddHTLCDecodeErrorZ;
7088 * A ping message to be sent or received from a peer
7090 typedef struct MUST_USE_STRUCT LDKPing {
7092 * A pointer to the opaque Rust object.
7093 * Nearly everywhere, inner must be non-null, however in places where
7094 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7096 LDKnativePing *inner;
7098 * Indicates that this is the only struct which contains the same pointer.
7099 * Rust functions which take ownership of an object provided via an argument require
7100 * this to be true and invalidate the object pointed to by inner.
7106 * The contents of CResult_PingDecodeErrorZ
7108 typedef union LDKCResult_PingDecodeErrorZPtr {
7110 * A pointer to the contents in the success state.
7111 * Reading from this pointer when `result_ok` is not set is undefined.
7113 struct LDKPing *result;
7115 * A pointer to the contents in the error state.
7116 * Reading from this pointer when `result_ok` is set is undefined.
7118 struct LDKDecodeError *err;
7119 } LDKCResult_PingDecodeErrorZPtr;
7122 * A CResult_PingDecodeErrorZ represents the result of a fallible operation,
7123 * containing a crate::lightning::ln::msgs::Ping on success and a crate::lightning::ln::msgs::DecodeError on failure.
7124 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7126 typedef struct LDKCResult_PingDecodeErrorZ {
7128 * The contents of this CResult_PingDecodeErrorZ, accessible via either
7129 * `err` or `result` depending on the state of `result_ok`.
7131 union LDKCResult_PingDecodeErrorZPtr contents;
7133 * Whether this CResult_PingDecodeErrorZ represents a success state.
7136 } LDKCResult_PingDecodeErrorZ;
7141 * A pong message to be sent or received from a peer
7143 typedef struct MUST_USE_STRUCT LDKPong {
7145 * A pointer to the opaque Rust object.
7146 * Nearly everywhere, inner must be non-null, however in places where
7147 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7149 LDKnativePong *inner;
7151 * Indicates that this is the only struct which contains the same pointer.
7152 * Rust functions which take ownership of an object provided via an argument require
7153 * this to be true and invalidate the object pointed to by inner.
7159 * The contents of CResult_PongDecodeErrorZ
7161 typedef union LDKCResult_PongDecodeErrorZPtr {
7163 * A pointer to the contents in the success state.
7164 * Reading from this pointer when `result_ok` is not set is undefined.
7166 struct LDKPong *result;
7168 * A pointer to the contents in the error state.
7169 * Reading from this pointer when `result_ok` is set is undefined.
7171 struct LDKDecodeError *err;
7172 } LDKCResult_PongDecodeErrorZPtr;
7175 * A CResult_PongDecodeErrorZ represents the result of a fallible operation,
7176 * containing a crate::lightning::ln::msgs::Pong on success and a crate::lightning::ln::msgs::DecodeError on failure.
7177 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7179 typedef struct LDKCResult_PongDecodeErrorZ {
7181 * The contents of this CResult_PongDecodeErrorZ, accessible via either
7182 * `err` or `result` depending on the state of `result_ok`.
7184 union LDKCResult_PongDecodeErrorZPtr contents;
7186 * Whether this CResult_PongDecodeErrorZ represents a success state.
7189 } LDKCResult_PongDecodeErrorZ;
7192 * The contents of CResult_UnsignedChannelAnnouncementDecodeErrorZ
7194 typedef union LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr {
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 LDKUnsignedChannelAnnouncement *result;
7201 * A pointer to the contents in the error state.
7202 * Reading from this pointer when `result_ok` is set is undefined.
7204 struct LDKDecodeError *err;
7205 } LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr;
7208 * A CResult_UnsignedChannelAnnouncementDecodeErrorZ represents the result of a fallible operation,
7209 * containing a crate::lightning::ln::msgs::UnsignedChannelAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
7210 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7212 typedef struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ {
7214 * The contents of this CResult_UnsignedChannelAnnouncementDecodeErrorZ, accessible via either
7215 * `err` or `result` depending on the state of `result_ok`.
7217 union LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr contents;
7219 * Whether this CResult_UnsignedChannelAnnouncementDecodeErrorZ represents a success state.
7222 } LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ;
7225 * The contents of CResult_ChannelAnnouncementDecodeErrorZ
7227 typedef union LDKCResult_ChannelAnnouncementDecodeErrorZPtr {
7229 * A pointer to the contents in the success state.
7230 * Reading from this pointer when `result_ok` is not set is undefined.
7232 struct LDKChannelAnnouncement *result;
7234 * A pointer to the contents in the error state.
7235 * Reading from this pointer when `result_ok` is set is undefined.
7237 struct LDKDecodeError *err;
7238 } LDKCResult_ChannelAnnouncementDecodeErrorZPtr;
7241 * A CResult_ChannelAnnouncementDecodeErrorZ represents the result of a fallible operation,
7242 * containing a crate::lightning::ln::msgs::ChannelAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
7243 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7245 typedef struct LDKCResult_ChannelAnnouncementDecodeErrorZ {
7247 * The contents of this CResult_ChannelAnnouncementDecodeErrorZ, accessible via either
7248 * `err` or `result` depending on the state of `result_ok`.
7250 union LDKCResult_ChannelAnnouncementDecodeErrorZPtr contents;
7252 * Whether this CResult_ChannelAnnouncementDecodeErrorZ represents a success state.
7255 } LDKCResult_ChannelAnnouncementDecodeErrorZ;
7260 * The unsigned part of a channel_update
7262 typedef struct MUST_USE_STRUCT LDKUnsignedChannelUpdate {
7264 * A pointer to the opaque Rust object.
7265 * Nearly everywhere, inner must be non-null, however in places where
7266 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7268 LDKnativeUnsignedChannelUpdate *inner;
7270 * Indicates that this is the only struct which contains the same pointer.
7271 * Rust functions which take ownership of an object provided via an argument require
7272 * this to be true and invalidate the object pointed to by inner.
7275 } LDKUnsignedChannelUpdate;
7278 * The contents of CResult_UnsignedChannelUpdateDecodeErrorZ
7280 typedef union LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr {
7282 * A pointer to the contents in the success state.
7283 * Reading from this pointer when `result_ok` is not set is undefined.
7285 struct LDKUnsignedChannelUpdate *result;
7287 * A pointer to the contents in the error state.
7288 * Reading from this pointer when `result_ok` is set is undefined.
7290 struct LDKDecodeError *err;
7291 } LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr;
7294 * A CResult_UnsignedChannelUpdateDecodeErrorZ represents the result of a fallible operation,
7295 * containing a crate::lightning::ln::msgs::UnsignedChannelUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
7296 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7298 typedef struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ {
7300 * The contents of this CResult_UnsignedChannelUpdateDecodeErrorZ, accessible via either
7301 * `err` or `result` depending on the state of `result_ok`.
7303 union LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr contents;
7305 * Whether this CResult_UnsignedChannelUpdateDecodeErrorZ represents a success state.
7308 } LDKCResult_UnsignedChannelUpdateDecodeErrorZ;
7311 * The contents of CResult_ChannelUpdateDecodeErrorZ
7313 typedef union LDKCResult_ChannelUpdateDecodeErrorZPtr {
7315 * A pointer to the contents in the success state.
7316 * Reading from this pointer when `result_ok` is not set is undefined.
7318 struct LDKChannelUpdate *result;
7320 * A pointer to the contents in the error state.
7321 * Reading from this pointer when `result_ok` is set is undefined.
7323 struct LDKDecodeError *err;
7324 } LDKCResult_ChannelUpdateDecodeErrorZPtr;
7327 * A CResult_ChannelUpdateDecodeErrorZ represents the result of a fallible operation,
7328 * containing a crate::lightning::ln::msgs::ChannelUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
7329 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7331 typedef struct LDKCResult_ChannelUpdateDecodeErrorZ {
7333 * The contents of this CResult_ChannelUpdateDecodeErrorZ, accessible via either
7334 * `err` or `result` depending on the state of `result_ok`.
7336 union LDKCResult_ChannelUpdateDecodeErrorZPtr contents;
7338 * Whether this CResult_ChannelUpdateDecodeErrorZ represents a success state.
7341 } LDKCResult_ChannelUpdateDecodeErrorZ;
7344 * The contents of CResult_ErrorMessageDecodeErrorZ
7346 typedef union LDKCResult_ErrorMessageDecodeErrorZPtr {
7348 * A pointer to the contents in the success state.
7349 * Reading from this pointer when `result_ok` is not set is undefined.
7351 struct LDKErrorMessage *result;
7353 * A pointer to the contents in the error state.
7354 * Reading from this pointer when `result_ok` is set is undefined.
7356 struct LDKDecodeError *err;
7357 } LDKCResult_ErrorMessageDecodeErrorZPtr;
7360 * A CResult_ErrorMessageDecodeErrorZ represents the result of a fallible operation,
7361 * containing a crate::lightning::ln::msgs::ErrorMessage on success and a crate::lightning::ln::msgs::DecodeError on failure.
7362 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7364 typedef struct LDKCResult_ErrorMessageDecodeErrorZ {
7366 * The contents of this CResult_ErrorMessageDecodeErrorZ, accessible via either
7367 * `err` or `result` depending on the state of `result_ok`.
7369 union LDKCResult_ErrorMessageDecodeErrorZPtr contents;
7371 * Whether this CResult_ErrorMessageDecodeErrorZ represents a success state.
7374 } LDKCResult_ErrorMessageDecodeErrorZ;
7379 * The unsigned part of a node_announcement
7381 typedef struct MUST_USE_STRUCT LDKUnsignedNodeAnnouncement {
7383 * A pointer to the opaque Rust object.
7384 * Nearly everywhere, inner must be non-null, however in places where
7385 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7387 LDKnativeUnsignedNodeAnnouncement *inner;
7389 * Indicates that this is the only struct which contains the same pointer.
7390 * Rust functions which take ownership of an object provided via an argument require
7391 * this to be true and invalidate the object pointed to by inner.
7394 } LDKUnsignedNodeAnnouncement;
7397 * The contents of CResult_UnsignedNodeAnnouncementDecodeErrorZ
7399 typedef union LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr {
7401 * A pointer to the contents in the success state.
7402 * Reading from this pointer when `result_ok` is not set is undefined.
7404 struct LDKUnsignedNodeAnnouncement *result;
7406 * A pointer to the contents in the error state.
7407 * Reading from this pointer when `result_ok` is set is undefined.
7409 struct LDKDecodeError *err;
7410 } LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr;
7413 * A CResult_UnsignedNodeAnnouncementDecodeErrorZ represents the result of a fallible operation,
7414 * containing a crate::lightning::ln::msgs::UnsignedNodeAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
7415 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7417 typedef struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ {
7419 * The contents of this CResult_UnsignedNodeAnnouncementDecodeErrorZ, accessible via either
7420 * `err` or `result` depending on the state of `result_ok`.
7422 union LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr contents;
7424 * Whether this CResult_UnsignedNodeAnnouncementDecodeErrorZ represents a success state.
7427 } LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ;
7430 * The contents of CResult_NodeAnnouncementDecodeErrorZ
7432 typedef union LDKCResult_NodeAnnouncementDecodeErrorZPtr {
7434 * A pointer to the contents in the success state.
7435 * Reading from this pointer when `result_ok` is not set is undefined.
7437 struct LDKNodeAnnouncement *result;
7439 * A pointer to the contents in the error state.
7440 * Reading from this pointer when `result_ok` is set is undefined.
7442 struct LDKDecodeError *err;
7443 } LDKCResult_NodeAnnouncementDecodeErrorZPtr;
7446 * A CResult_NodeAnnouncementDecodeErrorZ represents the result of a fallible operation,
7447 * containing a crate::lightning::ln::msgs::NodeAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
7448 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7450 typedef struct LDKCResult_NodeAnnouncementDecodeErrorZ {
7452 * The contents of this CResult_NodeAnnouncementDecodeErrorZ, accessible via either
7453 * `err` or `result` depending on the state of `result_ok`.
7455 union LDKCResult_NodeAnnouncementDecodeErrorZPtr contents;
7457 * Whether this CResult_NodeAnnouncementDecodeErrorZ represents a success state.
7460 } LDKCResult_NodeAnnouncementDecodeErrorZ;
7463 * The contents of CResult_QueryShortChannelIdsDecodeErrorZ
7465 typedef union LDKCResult_QueryShortChannelIdsDecodeErrorZPtr {
7467 * A pointer to the contents in the success state.
7468 * Reading from this pointer when `result_ok` is not set is undefined.
7470 struct LDKQueryShortChannelIds *result;
7472 * A pointer to the contents in the error state.
7473 * Reading from this pointer when `result_ok` is set is undefined.
7475 struct LDKDecodeError *err;
7476 } LDKCResult_QueryShortChannelIdsDecodeErrorZPtr;
7479 * A CResult_QueryShortChannelIdsDecodeErrorZ represents the result of a fallible operation,
7480 * containing a crate::lightning::ln::msgs::QueryShortChannelIds on success and a crate::lightning::ln::msgs::DecodeError on failure.
7481 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7483 typedef struct LDKCResult_QueryShortChannelIdsDecodeErrorZ {
7485 * The contents of this CResult_QueryShortChannelIdsDecodeErrorZ, accessible via either
7486 * `err` or `result` depending on the state of `result_ok`.
7488 union LDKCResult_QueryShortChannelIdsDecodeErrorZPtr contents;
7490 * Whether this CResult_QueryShortChannelIdsDecodeErrorZ represents a success state.
7493 } LDKCResult_QueryShortChannelIdsDecodeErrorZ;
7498 * A reply_short_channel_ids_end message is sent as a reply to a
7499 * query_short_channel_ids message. The query recipient makes a best
7500 * effort to respond based on their local network view which may not be
7501 * a perfect view of the network.
7503 typedef struct MUST_USE_STRUCT LDKReplyShortChannelIdsEnd {
7505 * A pointer to the opaque Rust object.
7506 * Nearly everywhere, inner must be non-null, however in places where
7507 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7509 LDKnativeReplyShortChannelIdsEnd *inner;
7511 * Indicates that this is the only struct which contains the same pointer.
7512 * Rust functions which take ownership of an object provided via an argument require
7513 * this to be true and invalidate the object pointed to by inner.
7516 } LDKReplyShortChannelIdsEnd;
7519 * The contents of CResult_ReplyShortChannelIdsEndDecodeErrorZ
7521 typedef union LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr {
7523 * A pointer to the contents in the success state.
7524 * Reading from this pointer when `result_ok` is not set is undefined.
7526 struct LDKReplyShortChannelIdsEnd *result;
7528 * A pointer to the contents in the error state.
7529 * Reading from this pointer when `result_ok` is set is undefined.
7531 struct LDKDecodeError *err;
7532 } LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr;
7535 * A CResult_ReplyShortChannelIdsEndDecodeErrorZ represents the result of a fallible operation,
7536 * containing a crate::lightning::ln::msgs::ReplyShortChannelIdsEnd on success and a crate::lightning::ln::msgs::DecodeError on failure.
7537 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7539 typedef struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ {
7541 * The contents of this CResult_ReplyShortChannelIdsEndDecodeErrorZ, accessible via either
7542 * `err` or `result` depending on the state of `result_ok`.
7544 union LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr contents;
7546 * Whether this CResult_ReplyShortChannelIdsEndDecodeErrorZ represents a success state.
7549 } LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ;
7552 * The contents of CResult_QueryChannelRangeDecodeErrorZ
7554 typedef union LDKCResult_QueryChannelRangeDecodeErrorZPtr {
7556 * A pointer to the contents in the success state.
7557 * Reading from this pointer when `result_ok` is not set is undefined.
7559 struct LDKQueryChannelRange *result;
7561 * A pointer to the contents in the error state.
7562 * Reading from this pointer when `result_ok` is set is undefined.
7564 struct LDKDecodeError *err;
7565 } LDKCResult_QueryChannelRangeDecodeErrorZPtr;
7568 * A CResult_QueryChannelRangeDecodeErrorZ represents the result of a fallible operation,
7569 * containing a crate::lightning::ln::msgs::QueryChannelRange on success and a crate::lightning::ln::msgs::DecodeError on failure.
7570 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7572 typedef struct LDKCResult_QueryChannelRangeDecodeErrorZ {
7574 * The contents of this CResult_QueryChannelRangeDecodeErrorZ, accessible via either
7575 * `err` or `result` depending on the state of `result_ok`.
7577 union LDKCResult_QueryChannelRangeDecodeErrorZPtr contents;
7579 * Whether this CResult_QueryChannelRangeDecodeErrorZ represents a success state.
7582 } LDKCResult_QueryChannelRangeDecodeErrorZ;
7585 * The contents of CResult_ReplyChannelRangeDecodeErrorZ
7587 typedef union LDKCResult_ReplyChannelRangeDecodeErrorZPtr {
7589 * A pointer to the contents in the success state.
7590 * Reading from this pointer when `result_ok` is not set is undefined.
7592 struct LDKReplyChannelRange *result;
7594 * A pointer to the contents in the error state.
7595 * Reading from this pointer when `result_ok` is set is undefined.
7597 struct LDKDecodeError *err;
7598 } LDKCResult_ReplyChannelRangeDecodeErrorZPtr;
7601 * A CResult_ReplyChannelRangeDecodeErrorZ represents the result of a fallible operation,
7602 * containing a crate::lightning::ln::msgs::ReplyChannelRange on success and a crate::lightning::ln::msgs::DecodeError on failure.
7603 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7605 typedef struct LDKCResult_ReplyChannelRangeDecodeErrorZ {
7607 * The contents of this CResult_ReplyChannelRangeDecodeErrorZ, accessible via either
7608 * `err` or `result` depending on the state of `result_ok`.
7610 union LDKCResult_ReplyChannelRangeDecodeErrorZPtr contents;
7612 * Whether this CResult_ReplyChannelRangeDecodeErrorZ represents a success state.
7615 } LDKCResult_ReplyChannelRangeDecodeErrorZ;
7620 * A gossip_timestamp_filter message is used by a node to request
7621 * gossip relay for messages in the requested time range when the
7622 * gossip_queries feature has been negotiated.
7624 typedef struct MUST_USE_STRUCT LDKGossipTimestampFilter {
7626 * A pointer to the opaque Rust object.
7627 * Nearly everywhere, inner must be non-null, however in places where
7628 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7630 LDKnativeGossipTimestampFilter *inner;
7632 * Indicates that this is the only struct which contains the same pointer.
7633 * Rust functions which take ownership of an object provided via an argument require
7634 * this to be true and invalidate the object pointed to by inner.
7637 } LDKGossipTimestampFilter;
7640 * The contents of CResult_GossipTimestampFilterDecodeErrorZ
7642 typedef union LDKCResult_GossipTimestampFilterDecodeErrorZPtr {
7644 * A pointer to the contents in the success state.
7645 * Reading from this pointer when `result_ok` is not set is undefined.
7647 struct LDKGossipTimestampFilter *result;
7649 * A pointer to the contents in the error state.
7650 * Reading from this pointer when `result_ok` is set is undefined.
7652 struct LDKDecodeError *err;
7653 } LDKCResult_GossipTimestampFilterDecodeErrorZPtr;
7656 * A CResult_GossipTimestampFilterDecodeErrorZ represents the result of a fallible operation,
7657 * containing a crate::lightning::ln::msgs::GossipTimestampFilter on success and a crate::lightning::ln::msgs::DecodeError on failure.
7658 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7660 typedef struct LDKCResult_GossipTimestampFilterDecodeErrorZ {
7662 * The contents of this CResult_GossipTimestampFilterDecodeErrorZ, accessible via either
7663 * `err` or `result` depending on the state of `result_ok`.
7665 union LDKCResult_GossipTimestampFilterDecodeErrorZPtr contents;
7667 * Whether this CResult_GossipTimestampFilterDecodeErrorZ represents a success state.
7670 } LDKCResult_GossipTimestampFilterDecodeErrorZ;
7673 * When signing using a fallible method either an user-supplied `SignError` or a `CreationError`
7676 typedef enum LDKSignOrCreationError_Tag {
7678 * An error occurred during signing
7680 LDKSignOrCreationError_SignError,
7682 * An error occurred while building the transaction
7684 LDKSignOrCreationError_CreationError,
7686 * Must be last for serialization purposes
7688 LDKSignOrCreationError_Sentinel,
7689 } LDKSignOrCreationError_Tag;
7691 typedef struct MUST_USE_STRUCT LDKSignOrCreationError {
7692 LDKSignOrCreationError_Tag tag;
7695 enum LDKCreationError creation_error;
7698 } LDKSignOrCreationError;
7701 * The contents of CResult_InvoiceSignOrCreationErrorZ
7703 typedef union LDKCResult_InvoiceSignOrCreationErrorZPtr {
7705 * A pointer to the contents in the success state.
7706 * Reading from this pointer when `result_ok` is not set is undefined.
7708 struct LDKInvoice *result;
7710 * A pointer to the contents in the error state.
7711 * Reading from this pointer when `result_ok` is set is undefined.
7713 struct LDKSignOrCreationError *err;
7714 } LDKCResult_InvoiceSignOrCreationErrorZPtr;
7717 * A CResult_InvoiceSignOrCreationErrorZ represents the result of a fallible operation,
7718 * containing a crate::lightning_invoice::Invoice on success and a crate::lightning_invoice::SignOrCreationError on failure.
7719 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7721 typedef struct LDKCResult_InvoiceSignOrCreationErrorZ {
7723 * The contents of this CResult_InvoiceSignOrCreationErrorZ, accessible via either
7724 * `err` or `result` depending on the state of `result_ok`.
7726 union LDKCResult_InvoiceSignOrCreationErrorZPtr contents;
7728 * Whether this CResult_InvoiceSignOrCreationErrorZ represents a success state.
7731 } LDKCResult_InvoiceSignOrCreationErrorZ;
7734 * A trait indicating an object may generate message send events
7736 typedef struct LDKMessageSendEventsProvider {
7738 * An opaque pointer which is passed to your function implementations as an argument.
7739 * This has no meaning in the LDK, and can be NULL or any other value.
7743 * Gets the list of pending events which were generated by previous actions, clearing the list
7746 struct LDKCVec_MessageSendEventZ (*get_and_clear_pending_msg_events)(const void *this_arg);
7748 * Frees any resources associated with this object given its this_arg pointer.
7749 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
7751 void (*free)(void *this_arg);
7752 } LDKMessageSendEventsProvider;
7755 * A trait implemented for objects handling events from [`EventsProvider`].
7757 typedef struct LDKEventHandler {
7759 * An opaque pointer which is passed to your function implementations as an argument.
7760 * This has no meaning in the LDK, and can be NULL or any other value.
7764 * Handles the given [`Event`].
7766 * See [`EventsProvider`] for details that must be considered when implementing this method.
7768 void (*handle_event)(const void *this_arg, struct LDKEvent event);
7770 * Frees any resources associated with this object given its this_arg pointer.
7771 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
7773 void (*free)(void *this_arg);
7777 * A trait indicating an object may generate events.
7779 * Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
7783 * See [`process_pending_events`] for requirements around event processing.
7785 * When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
7786 * event since the last invocation. The handler must either act upon the event immediately
7787 * or preserve it for later handling.
7789 * Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
7790 * consult the provider's documentation on the implication of processing events and how a handler
7791 * may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
7792 * [`ChainMonitor::process_pending_events`]).
7794 * (C-not implementable) As there is likely no reason for a user to implement this trait on their
7797 * [`process_pending_events`]: Self::process_pending_events
7798 * [`handle_event`]: EventHandler::handle_event
7799 * [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
7800 * [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
7802 typedef struct LDKEventsProvider {
7804 * An opaque pointer which is passed to your function implementations as an argument.
7805 * This has no meaning in the LDK, and can be NULL or any other value.
7809 * Processes any events generated since the last call using the given event handler.
7811 * Subsequent calls must only process new events. However, handlers must be capable of handling
7812 * duplicate events across process restarts. This may occur if the provider was recovered from
7813 * an old state (i.e., it hadn't been successfully persisted after processing pending events).
7815 void (*process_pending_events)(const void *this_arg, struct LDKEventHandler handler);
7817 * Frees any resources associated with this object given its this_arg pointer.
7818 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
7820 void (*free)(void *this_arg);
7821 } LDKEventsProvider;
7826 * Configuration we set when applicable.
7828 * Default::default() provides sane defaults.
7830 typedef struct MUST_USE_STRUCT LDKChannelHandshakeConfig {
7832 * A pointer to the opaque Rust object.
7833 * Nearly everywhere, inner must be non-null, however in places where
7834 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7836 LDKnativeChannelHandshakeConfig *inner;
7838 * Indicates that this is the only struct which contains the same pointer.
7839 * Rust functions which take ownership of an object provided via an argument require
7840 * this to be true and invalidate the object pointed to by inner.
7843 } LDKChannelHandshakeConfig;
7848 * Optional channel limits which are applied during channel creation.
7850 * These limits are only applied to our counterparty's limits, not our own.
7852 * Use 0/<type>::max_value() as appropriate to skip checking.
7854 * Provides sane defaults for most configurations.
7856 * Most additional limits are disabled except those with which specify a default in individual
7857 * field documentation. Note that this may result in barely-usable channels, but since they
7858 * are applied mostly only to incoming channels that's not much of a problem.
7860 typedef struct MUST_USE_STRUCT LDKChannelHandshakeLimits {
7862 * A pointer to the opaque Rust object.
7863 * Nearly everywhere, inner must be non-null, however in places where
7864 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7866 LDKnativeChannelHandshakeLimits *inner;
7868 * Indicates that this is the only struct which contains the same pointer.
7869 * Rust functions which take ownership of an object provided via an argument require
7870 * this to be true and invalidate the object pointed to by inner.
7873 } LDKChannelHandshakeLimits;
7878 * Top-level config which holds ChannelHandshakeLimits and ChannelConfig.
7880 * Default::default() provides sane defaults for most configurations
7881 * (but currently with 0 relay fees!)
7883 typedef struct MUST_USE_STRUCT LDKUserConfig {
7885 * A pointer to the opaque Rust object.
7886 * Nearly everywhere, inner must be non-null, however in places where
7887 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7889 LDKnativeUserConfig *inner;
7891 * Indicates that this is the only struct which contains the same pointer.
7892 * Rust functions which take ownership of an object provided via an argument require
7893 * this to be true and invalidate the object pointed to by inner.
7899 * The `Access` trait defines behavior for accessing chain data and state, such as blocks and
7902 typedef struct LDKAccess {
7904 * An opaque pointer which is passed to your function implementations as an argument.
7905 * This has no meaning in the LDK, and can be NULL or any other value.
7909 * Returns the transaction output of a funding transaction encoded by [`short_channel_id`].
7910 * Returns an error if `genesis_hash` is for a different chain or if such a transaction output
7913 * [`short_channel_id`]: https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md#definition-of-short_channel_id
7915 struct LDKCResult_TxOutAccessErrorZ (*get_utxo)(const void *this_arg, const uint8_t (*genesis_hash)[32], uint64_t short_channel_id);
7917 * Frees any resources associated with this object given its this_arg pointer.
7918 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
7920 void (*free)(void *this_arg);
7924 * The `Listen` trait is used to notify when blocks have been connected or disconnected from the
7927 * Useful when needing to replay chain data upon startup or as new chain events occur. Clients
7928 * sourcing chain data using a block-oriented API should prefer this interface over [`Confirm`].
7929 * Such clients fetch the entire header chain whereas clients using [`Confirm`] only fetch headers
7932 typedef struct LDKListen {
7934 * An opaque pointer which is passed to your function implementations as an argument.
7935 * This has no meaning in the LDK, and can be NULL or any other value.
7939 * Notifies the listener that a block was added at the given height.
7941 void (*block_connected)(const void *this_arg, struct LDKu8slice block, uint32_t height);
7943 * Notifies the listener that a block was removed at the given height.
7945 void (*block_disconnected)(const void *this_arg, const uint8_t (*header)[80], uint32_t height);
7947 * Frees any resources associated with this object given its this_arg pointer.
7948 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
7950 void (*free)(void *this_arg);
7954 * The `Confirm` trait is used to notify when transactions have been confirmed on chain or
7955 * unconfirmed during a chain reorganization.
7957 * Clients sourcing chain data using a transaction-oriented API should prefer this interface over
7958 * [`Listen`]. For instance, an Electrum client may implement [`Filter`] by subscribing to activity
7959 * related to registered transactions and outputs. Upon notification, it would pass along the
7960 * matching transactions using this interface.
7964 * The intended use is as follows:
7965 * - Call [`transactions_confirmed`] to process any on-chain activity of interest.
7966 * - Call [`transaction_unconfirmed`] to process any transaction returned by [`get_relevant_txids`]
7967 * that has been reorganized out of the chain.
7968 * - Call [`best_block_updated`] whenever a new chain tip becomes available.
7972 * Clients must call these methods in chain order. Specifically:
7973 * - Transactions confirmed in a block must be given before transactions confirmed in a later
7975 * - Dependent transactions within the same block must be given in topological order, possibly in
7977 * - Unconfirmed transactions must be given after the original confirmations and before any
7980 * See individual method documentation for further details.
7982 * [`transactions_confirmed`]: Self::transactions_confirmed
7983 * [`transaction_unconfirmed`]: Self::transaction_unconfirmed
7984 * [`best_block_updated`]: Self::best_block_updated
7985 * [`get_relevant_txids`]: Self::get_relevant_txids
7987 typedef struct LDKConfirm {
7989 * An opaque pointer which is passed to your function implementations as an argument.
7990 * This has no meaning in the LDK, and can be NULL or any other value.
7994 * Processes transactions confirmed in a block with a given header and height.
7996 * Should be called for any transactions registered by [`Filter::register_tx`] or any
7997 * transactions spending an output registered by [`Filter::register_output`]. Such transactions
7998 * appearing in the same block do not need to be included in the same call; instead, multiple
7999 * calls with additional transactions may be made so long as they are made in [chain order].
8001 * May be called before or after [`best_block_updated`] for the corresponding block. However,
8002 * in the event of a chain reorganization, it must not be called with a `header` that is no
8003 * longer in the chain as of the last call to [`best_block_updated`].
8005 * [chain order]: Confirm#Order
8006 * [`best_block_updated`]: Self::best_block_updated
8008 void (*transactions_confirmed)(const void *this_arg, const uint8_t (*header)[80], struct LDKCVec_C2Tuple_usizeTransactionZZ txdata, uint32_t height);
8010 * Processes a transaction that is no longer confirmed as result of a chain reorganization.
8012 * Should be called for any transaction returned by [`get_relevant_txids`] if it has been
8013 * reorganized out of the best chain. Once called, the given transaction should not be returned
8014 * by [`get_relevant_txids`] unless it has been reconfirmed via [`transactions_confirmed`].
8016 * [`get_relevant_txids`]: Self::get_relevant_txids
8017 * [`transactions_confirmed`]: Self::transactions_confirmed
8019 void (*transaction_unconfirmed)(const void *this_arg, const uint8_t (*txid)[32]);
8021 * Processes an update to the best header connected at the given height.
8023 * Should be called when a new header is available but may be skipped for intermediary blocks
8024 * if they become available at the same time.
8026 void (*best_block_updated)(const void *this_arg, const uint8_t (*header)[80], uint32_t height);
8028 * Returns transactions that should be monitored for reorganization out of the chain.
8030 * Should include any transactions passed to [`transactions_confirmed`] that have insufficient
8031 * confirmations to be safe from a chain reorganization. Should not include any transactions
8032 * passed to [`transaction_unconfirmed`] unless later reconfirmed.
8034 * May be called to determine the subset of transactions that must still be monitored for
8035 * reorganization. Will be idempotent between calls but may change as a result of calls to the
8036 * other interface methods. Thus, this is useful to determine which transactions may need to be
8037 * given to [`transaction_unconfirmed`].
8039 * [`transactions_confirmed`]: Self::transactions_confirmed
8040 * [`transaction_unconfirmed`]: Self::transaction_unconfirmed
8042 struct LDKCVec_TxidZ (*get_relevant_txids)(const void *this_arg);
8044 * Frees any resources associated with this object given its this_arg pointer.
8045 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
8047 void (*free)(void *this_arg);
8053 * A transaction output watched by a [`ChannelMonitor`] for spends on-chain.
8055 * Used to convey to a [`Filter`] such an output with a given spending condition. Any transaction
8056 * spending the output must be given to [`ChannelMonitor::block_connected`] either directly or via
8057 * the return value of [`Filter::register_output`].
8059 * If `block_hash` is `Some`, this indicates the output was created in the corresponding block and
8060 * may have been spent there. See [`Filter::register_output`] for details.
8062 * [`ChannelMonitor`]: channelmonitor::ChannelMonitor
8063 * [`ChannelMonitor::block_connected`]: channelmonitor::ChannelMonitor::block_connected
8065 typedef struct MUST_USE_STRUCT LDKWatchedOutput {
8067 * A pointer to the opaque Rust object.
8068 * Nearly everywhere, inner must be non-null, however in places where
8069 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8071 LDKnativeWatchedOutput *inner;
8073 * Indicates that this is the only struct which contains the same pointer.
8074 * Rust functions which take ownership of an object provided via an argument require
8075 * this to be true and invalidate the object pointed to by inner.
8081 * The `Filter` trait defines behavior for indicating chain activity of interest pertaining to
8084 * This is useful in order to have a [`Watch`] implementation convey to a chain source which
8085 * transactions to be notified of. Notification may take the form of pre-filtering blocks or, in
8086 * the case of [BIP 157]/[BIP 158], only fetching a block if the compact filter matches. If
8087 * receiving full blocks from a chain source, any further filtering is unnecessary.
8089 * After an output has been registered, subsequent block retrievals from the chain source must not
8090 * exclude any transactions matching the new criteria nor any in-block descendants of such
8093 * Note that use as part of a [`Watch`] implementation involves reentrancy. Therefore, the `Filter`
8094 * should not block on I/O. Implementations should instead queue the newly monitored data to be
8095 * processed later. Then, in order to block until the data has been processed, any [`Watch`]
8096 * invocation that has called the `Filter` must return [`TemporaryFailure`].
8098 * [`TemporaryFailure`]: channelmonitor::ChannelMonitorUpdateErr::TemporaryFailure
8099 * [BIP 157]: https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki
8100 * [BIP 158]: https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki
8102 typedef struct LDKFilter {
8104 * An opaque pointer which is passed to your function implementations as an argument.
8105 * This has no meaning in the LDK, and can be NULL or any other value.
8109 * Registers interest in a transaction with `txid` and having an output with `script_pubkey` as
8110 * a spending condition.
8112 void (*register_tx)(const void *this_arg, const uint8_t (*txid)[32], struct LDKu8slice script_pubkey);
8114 * Registers interest in spends of a transaction output.
8116 * Optionally, when `output.block_hash` is set, should return any transaction spending the
8117 * output that is found in the corresponding block along with its index.
8119 * This return value is useful for Electrum clients in order to supply in-block descendant
8120 * transactions which otherwise were not included. This is not necessary for other clients if
8121 * such descendant transactions were already included (e.g., when a BIP 157 client provides the
8124 struct LDKCOption_C2Tuple_usizeTransactionZZ (*register_output)(const void *this_arg, struct LDKWatchedOutput output);
8126 * Frees any resources associated with this object given its this_arg pointer.
8127 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
8129 void (*free)(void *this_arg);
8133 * `Persist` defines behavior for persisting channel monitors: this could mean
8134 * writing once to disk, and/or uploading to one or more backup services.
8136 * Note that for every new monitor, you **must** persist the new `ChannelMonitor`
8137 * to disk/backups. And, on every update, you **must** persist either the
8138 * `ChannelMonitorUpdate` or the updated monitor itself. Otherwise, there is risk
8139 * of situations such as revoking a transaction, then crashing before this
8140 * revocation can be persisted, then unintentionally broadcasting a revoked
8141 * transaction and losing money. This is a risk because previous channel states
8142 * are toxic, so it's important that whatever channel state is persisted is
8145 typedef struct LDKPersist {
8147 * An opaque pointer which is passed to your function implementations as an argument.
8148 * This has no meaning in the LDK, and can be NULL or any other value.
8152 * Persist a new channel's data. The data can be stored any way you want, but
8153 * the identifier provided by Rust-Lightning is the channel's outpoint (and
8154 * it is up to you to maintain a correct mapping between the outpoint and the
8155 * stored channel data). Note that you **must** persist every new monitor to
8156 * disk. See the `Persist` trait documentation for more details.
8158 * See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`,
8159 * and [`ChannelMonitorUpdateErr`] for requirements when returning errors.
8161 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*persist_new_channel)(const void *this_arg, struct LDKOutPoint id, const struct LDKChannelMonitor *NONNULL_PTR data);
8163 * Update one channel's data. The provided `ChannelMonitor` has already
8164 * applied the given update.
8166 * Note that on every update, you **must** persist either the
8167 * `ChannelMonitorUpdate` or the updated monitor itself to disk/backups. See
8168 * the `Persist` trait documentation for more details.
8170 * If an implementer chooses to persist the updates only, they need to make
8171 * sure that all the updates are applied to the `ChannelMonitors` *before*
8172 * the set of channel monitors is given to the `ChannelManager`
8173 * deserialization routine. See [`ChannelMonitor::update_monitor`] for
8174 * applying a monitor update to a monitor. If full `ChannelMonitors` are
8175 * persisted, then there is no need to persist individual updates.
8177 * Note that there could be a performance tradeoff between persisting complete
8178 * channel monitors on every update vs. persisting only updates and applying
8179 * them in batches. The size of each monitor grows `O(number of state updates)`
8180 * whereas updates are small and `O(1)`.
8182 * See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`,
8183 * [`ChannelMonitorUpdate::write`] for writing out an update, and
8184 * [`ChannelMonitorUpdateErr`] for requirements when returning errors.
8186 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*update_persisted_channel)(const void *this_arg, struct LDKOutPoint id, const struct LDKChannelMonitorUpdate *NONNULL_PTR update, const struct LDKChannelMonitor *NONNULL_PTR data);
8188 * Frees any resources associated with this object given its this_arg pointer.
8189 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
8191 void (*free)(void *this_arg);
8197 * An implementation of [`chain::Watch`] for monitoring channels.
8199 * Connected and disconnected blocks must be provided to `ChainMonitor` as documented by
8200 * [`chain::Watch`]. May be used in conjunction with [`ChannelManager`] to monitor channels locally
8201 * or used independently to monitor channels remotely. See the [module-level documentation] for
8204 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
8205 * [module-level documentation]: crate::chain::chainmonitor
8207 typedef struct MUST_USE_STRUCT LDKChainMonitor {
8209 * A pointer to the opaque Rust object.
8210 * Nearly everywhere, inner must be non-null, however in places where
8211 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8213 LDKnativeChainMonitor *inner;
8215 * Indicates that this is the only struct which contains the same pointer.
8216 * Rust functions which take ownership of an object provided via an argument require
8217 * this to be true and invalidate the object pointed to by inner.
8225 * Simple KeysInterface implementor that takes a 32-byte seed for use as a BIP 32 extended key
8226 * and derives keys from that.
8228 * Your node_id is seed/0'
8229 * ChannelMonitor closes may use seed/1'
8230 * Cooperative closes may use seed/2'
8231 * The two close keys may be needed to claim on-chain funds!
8233 typedef struct MUST_USE_STRUCT LDKKeysManager {
8235 * A pointer to the opaque Rust object.
8236 * Nearly everywhere, inner must be non-null, however in places where
8237 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8239 LDKnativeKeysManager *inner;
8241 * Indicates that this is the only struct which contains the same pointer.
8242 * Rust functions which take ownership of an object provided via an argument require
8243 * this to be true and invalidate the object pointed to by inner.
8251 * Chain-related parameters used to construct a new `ChannelManager`.
8253 * Typically, the block-specific parameters are derived from the best block hash for the network,
8254 * as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
8255 * are not needed when deserializing a previously constructed `ChannelManager`.
8257 typedef struct MUST_USE_STRUCT LDKChainParameters {
8259 * A pointer to the opaque Rust object.
8260 * Nearly everywhere, inner must be non-null, however in places where
8261 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8263 LDKnativeChainParameters *inner;
8265 * Indicates that this is the only struct which contains the same pointer.
8266 * Rust functions which take ownership of an object provided via an argument require
8267 * this to be true and invalidate the object pointed to by inner.
8270 } LDKChainParameters;
8275 * The best known block as identified by its hash and height.
8277 typedef struct MUST_USE_STRUCT LDKBestBlock {
8279 * A pointer to the opaque Rust object.
8280 * Nearly everywhere, inner must be non-null, however in places where
8281 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8283 LDKnativeBestBlock *inner;
8285 * Indicates that this is the only struct which contains the same pointer.
8286 * Rust functions which take ownership of an object provided via an argument require
8287 * this to be true and invalidate the object pointed to by inner.
8293 * A 3-byte byte array.
8295 typedef struct LDKThreeBytes {
8303 * A trait to describe an object which can receive channel messages.
8305 * Messages MAY be called in parallel when they originate from different their_node_ids, however
8306 * they MUST NOT be called in parallel when the two calls have the same their_node_id.
8308 typedef struct LDKChannelMessageHandler {
8310 * An opaque pointer which is passed to your function implementations as an argument.
8311 * This has no meaning in the LDK, and can be NULL or any other value.
8315 * Handle an incoming open_channel message from the given peer.
8317 void (*handle_open_channel)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKInitFeatures their_features, const struct LDKOpenChannel *NONNULL_PTR msg);
8319 * Handle an incoming accept_channel message from the given peer.
8321 void (*handle_accept_channel)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKInitFeatures their_features, const struct LDKAcceptChannel *NONNULL_PTR msg);
8323 * Handle an incoming funding_created message from the given peer.
8325 void (*handle_funding_created)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingCreated *NONNULL_PTR msg);
8327 * Handle an incoming funding_signed message from the given peer.
8329 void (*handle_funding_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingSigned *NONNULL_PTR msg);
8331 * Handle an incoming funding_locked message from the given peer.
8333 void (*handle_funding_locked)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingLocked *NONNULL_PTR msg);
8335 * Handle an incoming shutdown message from the given peer.
8337 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);
8339 * Handle an incoming closing_signed message from the given peer.
8341 void (*handle_closing_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKClosingSigned *NONNULL_PTR msg);
8343 * Handle an incoming update_add_htlc message from the given peer.
8345 void (*handle_update_add_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateAddHTLC *NONNULL_PTR msg);
8347 * Handle an incoming update_fulfill_htlc message from the given peer.
8349 void (*handle_update_fulfill_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFulfillHTLC *NONNULL_PTR msg);
8351 * Handle an incoming update_fail_htlc message from the given peer.
8353 void (*handle_update_fail_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFailHTLC *NONNULL_PTR msg);
8355 * Handle an incoming update_fail_malformed_htlc message from the given peer.
8357 void (*handle_update_fail_malformed_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR msg);
8359 * Handle an incoming commitment_signed message from the given peer.
8361 void (*handle_commitment_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKCommitmentSigned *NONNULL_PTR msg);
8363 * Handle an incoming revoke_and_ack message from the given peer.
8365 void (*handle_revoke_and_ack)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKRevokeAndACK *NONNULL_PTR msg);
8367 * Handle an incoming update_fee message from the given peer.
8369 void (*handle_update_fee)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFee *NONNULL_PTR msg);
8371 * Handle an incoming announcement_signatures message from the given peer.
8373 void (*handle_announcement_signatures)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKAnnouncementSignatures *NONNULL_PTR msg);
8375 * Indicates a connection to the peer failed/an existing connection was lost. If no connection
8376 * is believed to be possible in the future (eg they're sending us messages we don't
8377 * understand or indicate they require unknown feature bits), no_connection_possible is set
8378 * and any outstanding channels should be failed.
8380 void (*peer_disconnected)(const void *this_arg, struct LDKPublicKey their_node_id, bool no_connection_possible);
8382 * Handle a peer reconnecting, possibly generating channel_reestablish message(s).
8384 void (*peer_connected)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKInit *NONNULL_PTR msg);
8386 * Handle an incoming channel_reestablish message from the given peer.
8388 void (*handle_channel_reestablish)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKChannelReestablish *NONNULL_PTR msg);
8390 * Handle an incoming channel update from the given peer.
8392 void (*handle_channel_update)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKChannelUpdate *NONNULL_PTR msg);
8394 * Handle an incoming error message from the given peer.
8396 void (*handle_error)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKErrorMessage *NONNULL_PTR msg);
8398 * Implementation of MessageSendEventsProvider for this object.
8400 struct LDKMessageSendEventsProvider MessageSendEventsProvider;
8402 * Frees any resources associated with this object given its this_arg pointer.
8403 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
8405 void (*free)(void *this_arg);
8406 } LDKChannelMessageHandler;
8411 * Arguments for the creation of a ChannelManager that are not deserialized.
8413 * At a high-level, the process for deserializing a ChannelManager and resuming normal operation
8415 * 1) Deserialize all stored ChannelMonitors.
8416 * 2) Deserialize the ChannelManager by filling in this struct and calling:
8417 * <(BlockHash, ChannelManager)>::read(reader, args)
8418 * This may result in closing some Channels if the ChannelMonitor is newer than the stored
8419 * ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
8420 * 3) If you are not fetching full blocks, register all relevant ChannelMonitor outpoints the same
8421 * way you would handle a `chain::Filter` call using ChannelMonitor::get_outputs_to_watch() and
8422 * ChannelMonitor::get_funding_txo().
8423 * 4) Reconnect blocks on your ChannelMonitors.
8424 * 5) Disconnect/connect blocks on the ChannelManager.
8425 * 6) Move the ChannelMonitors into your local chain::Watch.
8427 * Note that the ordering of #4-6 is not of importance, however all three must occur before you
8428 * call any other methods on the newly-deserialized ChannelManager.
8430 * Note that because some channels may be closed during deserialization, it is critical that you
8431 * always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
8432 * you. If you deserialize an old ChannelManager (during which force-closure transactions may be
8433 * broadcast), and then later deserialize a newer version of the same ChannelManager (which will
8434 * not force-close the same channels but consider them live), you may end up revoking a state for
8435 * which you've already broadcasted the transaction.
8437 typedef struct MUST_USE_STRUCT LDKChannelManagerReadArgs {
8439 * A pointer to the opaque Rust object.
8440 * Nearly everywhere, inner must be non-null, however in places where
8441 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8443 LDKnativeChannelManagerReadArgs *inner;
8445 * Indicates that this is the only struct which contains the same pointer.
8446 * Rust functions which take ownership of an object provided via an argument require
8447 * this to be true and invalidate the object pointed to by inner.
8450 } LDKChannelManagerReadArgs;
8455 * Proof that the sender knows the per-commitment secret of the previous commitment transaction.
8456 * This is used to convince the recipient that the channel is at a certain commitment
8457 * number even if they lost that data due to a local failure. Of course, the peer may lie
8458 * and even later commitments may have been revoked.
8460 typedef struct MUST_USE_STRUCT LDKDataLossProtect {
8462 * A pointer to the opaque Rust object.
8463 * Nearly everywhere, inner must be non-null, however in places where
8464 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8466 LDKnativeDataLossProtect *inner;
8468 * Indicates that this is the only struct which contains the same pointer.
8469 * Rust functions which take ownership of an object provided via an argument require
8470 * this to be true and invalidate the object pointed to by inner.
8473 } LDKDataLossProtect;
8476 * A trait to describe an object which can receive routing messages.
8478 * # Implementor DoS Warnings
8480 * For `gossip_queries` messages there are potential DoS vectors when handling
8481 * inbound queries. Implementors using an on-disk network graph should be aware of
8482 * repeated disk I/O for queries accessing different parts of the network graph.
8484 typedef struct LDKRoutingMessageHandler {
8486 * An opaque pointer which is passed to your function implementations as an argument.
8487 * This has no meaning in the LDK, and can be NULL or any other value.
8491 * Handle an incoming node_announcement message, returning true if it should be forwarded on,
8492 * false or returning an Err otherwise.
8494 struct LDKCResult_boolLightningErrorZ (*handle_node_announcement)(const void *this_arg, const struct LDKNodeAnnouncement *NONNULL_PTR msg);
8496 * Handle a channel_announcement message, returning true if it should be forwarded on, false
8497 * or returning an Err otherwise.
8499 struct LDKCResult_boolLightningErrorZ (*handle_channel_announcement)(const void *this_arg, const struct LDKChannelAnnouncement *NONNULL_PTR msg);
8501 * Handle an incoming channel_update message, returning true if it should be forwarded on,
8502 * false or returning an Err otherwise.
8504 struct LDKCResult_boolLightningErrorZ (*handle_channel_update)(const void *this_arg, const struct LDKChannelUpdate *NONNULL_PTR msg);
8506 * Handle some updates to the route graph that we learned due to an outbound failed payment.
8508 void (*handle_htlc_fail_channel_update)(const void *this_arg, const struct LDKHTLCFailChannelUpdate *NONNULL_PTR update);
8510 * Gets a subset of the channel announcements and updates required to dump our routing table
8511 * to a remote node, starting at the short_channel_id indicated by starting_point and
8512 * including the batch_amount entries immediately higher in numerical value than starting_point.
8514 struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ (*get_next_channel_announcements)(const void *this_arg, uint64_t starting_point, uint8_t batch_amount);
8516 * Gets a subset of the node announcements required to dump our routing table to a remote node,
8517 * starting at the node *after* the provided publickey and including batch_amount entries
8518 * immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
8519 * If None is provided for starting_point, we start at the first node.
8521 struct LDKCVec_NodeAnnouncementZ (*get_next_node_announcements)(const void *this_arg, struct LDKPublicKey starting_point, uint8_t batch_amount);
8523 * Called when a connection is established with a peer. This can be used to
8524 * perform routing table synchronization using a strategy defined by the
8527 void (*sync_routing_table)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKInit *NONNULL_PTR init);
8529 * Handles the reply of a query we initiated to learn about channels
8530 * for a given range of blocks. We can expect to receive one or more
8531 * replies to a single query.
8533 struct LDKCResult_NoneLightningErrorZ (*handle_reply_channel_range)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKReplyChannelRange msg);
8535 * Handles the reply of a query we initiated asking for routing gossip
8536 * messages for a list of channels. We should receive this message when
8537 * a node has completed its best effort to send us the pertaining routing
8540 struct LDKCResult_NoneLightningErrorZ (*handle_reply_short_channel_ids_end)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKReplyShortChannelIdsEnd msg);
8542 * Handles when a peer asks us to send a list of short_channel_ids
8543 * for the requested range of blocks.
8545 struct LDKCResult_NoneLightningErrorZ (*handle_query_channel_range)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKQueryChannelRange msg);
8547 * Handles when a peer asks us to send routing gossip messages for a
8548 * list of short_channel_ids.
8550 struct LDKCResult_NoneLightningErrorZ (*handle_query_short_channel_ids)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKQueryShortChannelIds msg);
8552 * Implementation of MessageSendEventsProvider for this object.
8554 struct LDKMessageSendEventsProvider MessageSendEventsProvider;
8556 * Frees any resources associated with this object given its this_arg pointer.
8557 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
8559 void (*free)(void *this_arg);
8560 } LDKRoutingMessageHandler;
8565 * A dummy struct which implements `RoutingMessageHandler` without storing any routing information
8566 * or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
8568 typedef struct MUST_USE_STRUCT LDKIgnoringMessageHandler {
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 LDKnativeIgnoringMessageHandler *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 } LDKIgnoringMessageHandler;
8586 * A dummy struct which implements `ChannelMessageHandler` without having any channels.
8587 * You can provide one of these as the route_handler in a MessageHandler.
8589 typedef struct MUST_USE_STRUCT LDKErroringMessageHandler {
8591 * A pointer to the opaque Rust object.
8592 * Nearly everywhere, inner must be non-null, however in places where
8593 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8595 LDKnativeErroringMessageHandler *inner;
8597 * Indicates that this is the only struct which contains the same pointer.
8598 * Rust functions which take ownership of an object provided via an argument require
8599 * this to be true and invalidate the object pointed to by inner.
8602 } LDKErroringMessageHandler;
8607 * Provides references to trait impls which handle different types of messages.
8609 typedef struct MUST_USE_STRUCT LDKMessageHandler {
8611 * A pointer to the opaque Rust object.
8612 * Nearly everywhere, inner must be non-null, however in places where
8613 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8615 LDKnativeMessageHandler *inner;
8617 * Indicates that this is the only struct which contains the same pointer.
8618 * Rust functions which take ownership of an object provided via an argument require
8619 * this to be true and invalidate the object pointed to by inner.
8622 } LDKMessageHandler;
8625 * Provides an object which can be used to send data to and which uniquely identifies a connection
8626 * to a remote host. You will need to be able to generate multiple of these which meet Eq and
8627 * implement Hash to meet the PeerManager API.
8629 * For efficiency, Clone should be relatively cheap for this type.
8631 * You probably want to just extend an int and put a file descriptor in a struct and implement
8632 * send_data. Note that if you are using a higher-level net library that may call close() itself,
8633 * be careful to ensure you don't have races whereby you might register a new connection with an
8634 * fd which is the same as a previous one which has yet to be removed via
8635 * PeerManager::socket_disconnected().
8637 typedef struct LDKSocketDescriptor {
8639 * An opaque pointer which is passed to your function implementations as an argument.
8640 * This has no meaning in the LDK, and can be NULL or any other value.
8644 * Attempts to send some data from the given slice to the peer.
8646 * Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
8647 * Note that in the disconnected case, socket_disconnected must still fire and further write
8648 * attempts may occur until that time.
8650 * If the returned size is smaller than data.len(), a write_available event must
8651 * trigger the next time more data can be written. Additionally, until the a send_data event
8652 * completes fully, no further read_events should trigger on the same peer!
8654 * If a read_event on this descriptor had previously returned true (indicating that read
8655 * events should be paused to prevent DoS in the send buffer), resume_read may be set
8656 * indicating that read events on this descriptor should resume. A resume_read of false does
8657 * *not* imply that further read events should be paused.
8659 uintptr_t (*send_data)(void *this_arg, struct LDKu8slice data, bool resume_read);
8661 * Disconnect the socket pointed to by this SocketDescriptor. Once this function returns, no
8662 * more calls to write_buffer_space_avail, read_event or socket_disconnected may be made with
8663 * this descriptor. No socket_disconnected call should be generated as a result of this call,
8664 * though races may occur whereby disconnect_socket is called after a call to
8665 * socket_disconnected but prior to socket_disconnected returning.
8667 void (*disconnect_socket)(void *this_arg);
8669 * Checks if two objects are equal given this object's this_arg pointer and another object.
8671 bool (*eq)(const void *this_arg, const struct LDKSocketDescriptor *NONNULL_PTR other_arg);
8673 * Calculate a succinct non-cryptographic hash for an object given its this_arg pointer.
8674 * This is used, for example, for inclusion of this object in a hash map.
8676 uint64_t (*hash)(const void *this_arg);
8678 * Creates a copy of the object pointed to by this_arg, for a copy of this SocketDescriptor.
8679 * Note that the ultimate copy of the SocketDescriptor will have all function pointers the same as the original.
8680 * May be NULL if no action needs to be taken, the this_arg pointer will be copied into the new SocketDescriptor.
8682 void *(*clone)(const void *this_arg);
8684 * Frees any resources associated with this object given its this_arg pointer.
8685 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
8687 void (*free)(void *this_arg);
8688 } LDKSocketDescriptor;
8693 * A PeerManager manages a set of peers, described by their SocketDescriptor and marshalls socket
8694 * events into messages which it passes on to its MessageHandlers.
8696 * Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
8697 * a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
8698 * essentially you should default to using a SimpleRefPeerManager, and use a
8699 * SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
8700 * you're using lightning-net-tokio.
8702 typedef struct MUST_USE_STRUCT LDKPeerManager {
8704 * A pointer to the opaque Rust object.
8705 * Nearly everywhere, inner must be non-null, however in places where
8706 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8708 LDKnativePeerManager *inner;
8710 * Indicates that this is the only struct which contains the same pointer.
8711 * Rust functions which take ownership of an object provided via an argument require
8712 * this to be true and invalidate the object pointed to by inner.
8720 * Static channel fields used to build transactions given per-commitment fields, organized by
8721 * broadcaster/countersignatory.
8723 * This is derived from the holder/counterparty-organized ChannelTransactionParameters via the
8724 * as_holder_broadcastable and as_counterparty_broadcastable functions.
8726 typedef struct MUST_USE_STRUCT LDKDirectedChannelTransactionParameters {
8728 * A pointer to the opaque Rust object.
8729 * Nearly everywhere, inner must be non-null, however in places where
8730 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8732 LDKnativeDirectedChannelTransactionParameters *inner;
8734 * Indicates that this is the only struct which contains the same pointer.
8735 * Rust functions which take ownership of an object provided via an argument require
8736 * this to be true and invalidate the object pointed to by inner.
8739 } LDKDirectedChannelTransactionParameters;
8744 * A simple newtype for RwLockReadGuard<'a, NetworkGraph>.
8745 * This exists only to make accessing a RwLock<NetworkGraph> possible from
8746 * the C bindings, as it can be done directly in Rust code.
8748 typedef struct MUST_USE_STRUCT LDKLockedNetworkGraph {
8750 * A pointer to the opaque Rust object.
8751 * Nearly everywhere, inner must be non-null, however in places where
8752 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8754 LDKnativeLockedNetworkGraph *inner;
8756 * Indicates that this is the only struct which contains the same pointer.
8757 * Rust functions which take ownership of an object provided via an argument require
8758 * this to be true and invalidate the object pointed to by inner.
8761 } LDKLockedNetworkGraph;
8766 * Receives and validates network updates from peers,
8767 * stores authentic and relevant data as a network graph.
8768 * This network graph is then used for routing payments.
8769 * Provides interface to help with initial routing sync by
8770 * serving historical announcements.
8772 typedef struct MUST_USE_STRUCT LDKNetGraphMsgHandler {
8774 * A pointer to the opaque Rust object.
8775 * Nearly everywhere, inner must be non-null, however in places where
8776 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8778 LDKnativeNetGraphMsgHandler *inner;
8780 * Indicates that this is the only struct which contains the same pointer.
8781 * Rust functions which take ownership of an object provided via an argument require
8782 * this to be true and invalidate the object pointed to by inner.
8785 } LDKNetGraphMsgHandler;
8790 * FilesystemPersister persists channel data on disk, where each channel's
8791 * data is stored in a file named after its funding outpoint.
8793 * Warning: this module does the best it can with calls to persist data, but it
8794 * can only guarantee that the data is passed to the drive. It is up to the
8795 * drive manufacturers to do the actual persistence properly, which they often
8796 * don't (especially on consumer-grade hardware). Therefore, it is up to the
8797 * user to validate their entire storage stack, to ensure the writes are
8799 * Corollary: especially when dealing with larger amounts of money, it is best
8800 * practice to have multiple channel data backups and not rely only on one
8801 * FilesystemPersister.
8803 typedef struct MUST_USE_STRUCT LDKFilesystemPersister {
8805 * A pointer to the opaque Rust object.
8806 * Nearly everywhere, inner must be non-null, however in places where
8807 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8809 LDKnativeFilesystemPersister *inner;
8811 * Indicates that this is the only struct which contains the same pointer.
8812 * Rust functions which take ownership of an object provided via an argument require
8813 * this to be true and invalidate the object pointed to by inner.
8816 } LDKFilesystemPersister;
8821 * BackgroundProcessor takes care of tasks that (1) need to happen periodically to keep
8822 * Rust-Lightning running properly, and (2) either can or should be run in the background. Its
8823 * responsibilities are:
8824 * * Monitoring whether the ChannelManager needs to be re-persisted to disk, and if so,
8825 * writing it to disk/backups by invoking the callback given to it at startup.
8826 * ChannelManager persistence should be done in the background.
8827 * * Calling `ChannelManager::timer_tick_occurred()` and
8828 * `PeerManager::timer_tick_occurred()` every minute (can be done in the
8831 * Note that if ChannelManager persistence fails and the persisted manager becomes out-of-date,
8832 * then there is a risk of channels force-closing on startup when the manager realizes it's
8833 * outdated. However, as long as `ChannelMonitor` backups are sound, no funds besides those used
8834 * for unilateral chain closure fees are at risk.
8836 typedef struct MUST_USE_STRUCT LDKBackgroundProcessor {
8838 * A pointer to the opaque Rust object.
8839 * Nearly everywhere, inner must be non-null, however in places where
8840 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8842 LDKnativeBackgroundProcessor *inner;
8844 * Indicates that this is the only struct which contains the same pointer.
8845 * Rust functions which take ownership of an object provided via an argument require
8846 * this to be true and invalidate the object pointed to by inner.
8849 } LDKBackgroundProcessor;
8852 * Trait which handles persisting a [`ChannelManager`] to disk.
8854 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
8856 typedef struct LDKChannelManagerPersister {
8858 * An opaque pointer which is passed to your function implementations as an argument.
8859 * This has no meaning in the LDK, and can be NULL or any other value.
8863 * Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
8864 * (which will cause the [`BackgroundProcessor`] which called this method to exit.
8866 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
8868 struct LDKCResult_NoneErrorZ (*persist_manager)(const void *this_arg, const struct LDKChannelManager *NONNULL_PTR channel_manager);
8870 * Frees any resources associated with this object given its this_arg pointer.
8871 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
8873 void (*free)(void *this_arg);
8874 } LDKChannelManagerPersister;
8879 * Data of the `RawInvoice` that is encoded in the data part
8881 typedef struct MUST_USE_STRUCT LDKRawDataPart {
8883 * A pointer to the opaque Rust object.
8884 * Nearly everywhere, inner must be non-null, however in places where
8885 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8887 LDKnativeRawDataPart *inner;
8889 * Indicates that this is the only struct which contains the same pointer.
8890 * Rust functions which take ownership of an object provided via an argument require
8891 * this to be true and invalidate the object pointed to by inner.
8901 typedef struct MUST_USE_STRUCT LDKSha256 {
8903 * A pointer to the opaque Rust object.
8904 * Nearly everywhere, inner must be non-null, however in places where
8905 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8907 LDKnativeSha256 *inner;
8909 * Indicates that this is the only struct which contains the same pointer.
8910 * Rust functions which take ownership of an object provided via an argument require
8911 * this to be true and invalidate the object pointed to by inner.
8919 * `min_final_cltv_expiry` to use for the last HTLC in the route
8921 typedef struct MUST_USE_STRUCT LDKMinFinalCltvExpiry {
8923 * A pointer to the opaque Rust object.
8924 * Nearly everywhere, inner must be non-null, however in places where
8925 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8927 LDKnativeMinFinalCltvExpiry *inner;
8929 * Indicates that this is the only struct which contains the same pointer.
8930 * Rust functions which take ownership of an object provided via an argument require
8931 * this to be true and invalidate the object pointed to by inner.
8934 } LDKMinFinalCltvExpiry;
8937 * Integer in the range `0..32`
8939 typedef struct LDKu5 {
8944 * A 20-byte byte array.
8946 typedef struct LDKTwentyBytes {
8954 * Fallback address in case no LN payment is possible
8956 typedef enum LDKFallback_Tag {
8957 LDKFallback_SegWitProgram,
8958 LDKFallback_PubKeyHash,
8959 LDKFallback_ScriptHash,
8961 * Must be last for serialization purposes
8963 LDKFallback_Sentinel,
8966 typedef struct LDKFallback_LDKSegWitProgram_Body {
8967 struct LDKu5 version;
8968 struct LDKCVec_u8Z program;
8969 } LDKFallback_LDKSegWitProgram_Body;
8971 typedef struct MUST_USE_STRUCT LDKFallback {
8972 LDKFallback_Tag tag;
8974 LDKFallback_LDKSegWitProgram_Body seg_wit_program;
8976 struct LDKTwentyBytes pub_key_hash;
8979 struct LDKTwentyBytes script_hash;
8984 extern const uintptr_t MAX_BUF_SIZE;
8986 extern const uint64_t MIN_RELAY_FEE_SAT_PER_1000_WEIGHT;
8988 extern const uint64_t CLOSED_CHANNEL_UPDATE_ID;
8990 extern const uint32_t ANTI_REORG_DELAY;
8992 extern const uint16_t BREAKDOWN_TIMEOUT;
8994 extern const uint16_t MIN_CLTV_EXPIRY_DELTA;
8996 extern const uint32_t MIN_FINAL_CLTV_EXPIRY;
8998 extern const uintptr_t REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH;
9000 extern const uint8_t TAG_PAYMENT_HASH;
9002 extern const uint8_t TAG_DESCRIPTION;
9004 extern const uint8_t TAG_PAYEE_PUB_KEY;
9006 extern const uint8_t TAG_DESCRIPTION_HASH;
9008 extern const uint8_t TAG_EXPIRY_TIME;
9010 extern const uint8_t TAG_MIN_FINAL_CLTV_EXPIRY;
9012 extern const uint8_t TAG_FALLBACK;
9014 extern const uint8_t TAG_ROUTE;
9016 extern const uint8_t TAG_PAYMENT_SECRET;
9018 extern const uint8_t TAG_FEATURES;
9020 struct LDKStr _ldk_get_compiled_version(void);
9022 struct LDKStr _ldk_c_bindings_get_compiled_version(void);
9025 * Frees the data buffer, if data_is_owned is set and datalen > 0.
9027 void Transaction_free(struct LDKTransaction _res);
9030 * Frees the data pointed to by script_pubkey.
9032 void TxOut_free(struct LDKTxOut _res);
9035 * Creates a new TxOut which has the same data as `orig` but with a new script buffer.
9037 struct LDKTxOut TxOut_clone(const struct LDKTxOut *NONNULL_PTR orig);
9040 * Frees the data buffer, if chars_is_owned is set and len > 0.
9042 void Str_free(struct LDKStr _res);
9045 * Creates a new CResult_SecretKeyErrorZ in the success state.
9047 struct LDKCResult_SecretKeyErrorZ CResult_SecretKeyErrorZ_ok(struct LDKSecretKey o);
9050 * Creates a new CResult_SecretKeyErrorZ in the error state.
9052 struct LDKCResult_SecretKeyErrorZ CResult_SecretKeyErrorZ_err(enum LDKSecp256k1Error e);
9055 * Frees any resources used by the CResult_SecretKeyErrorZ.
9057 void CResult_SecretKeyErrorZ_free(struct LDKCResult_SecretKeyErrorZ _res);
9060 * Creates a new CResult_PublicKeyErrorZ in the success state.
9062 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_ok(struct LDKPublicKey o);
9065 * Creates a new CResult_PublicKeyErrorZ in the error state.
9067 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_err(enum LDKSecp256k1Error e);
9070 * Frees any resources used by the CResult_PublicKeyErrorZ.
9072 void CResult_PublicKeyErrorZ_free(struct LDKCResult_PublicKeyErrorZ _res);
9075 * Creates a new CResult_PublicKeyErrorZ which has the same data as `orig`
9076 * but with all dynamically-allocated buffers duplicated in new buffers.
9078 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_clone(const struct LDKCResult_PublicKeyErrorZ *NONNULL_PTR orig);
9081 * Creates a new CResult_TxCreationKeysDecodeErrorZ in the success state.
9083 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_ok(struct LDKTxCreationKeys o);
9086 * Creates a new CResult_TxCreationKeysDecodeErrorZ in the error state.
9088 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_err(struct LDKDecodeError e);
9091 * Frees any resources used by the CResult_TxCreationKeysDecodeErrorZ.
9093 void CResult_TxCreationKeysDecodeErrorZ_free(struct LDKCResult_TxCreationKeysDecodeErrorZ _res);
9096 * Creates a new CResult_TxCreationKeysDecodeErrorZ which has the same data as `orig`
9097 * but with all dynamically-allocated buffers duplicated in new buffers.
9099 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_clone(const struct LDKCResult_TxCreationKeysDecodeErrorZ *NONNULL_PTR orig);
9102 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ in the success state.
9104 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_ok(struct LDKChannelPublicKeys o);
9107 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ in the error state.
9109 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_err(struct LDKDecodeError e);
9112 * Frees any resources used by the CResult_ChannelPublicKeysDecodeErrorZ.
9114 void CResult_ChannelPublicKeysDecodeErrorZ_free(struct LDKCResult_ChannelPublicKeysDecodeErrorZ _res);
9117 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ which has the same data as `orig`
9118 * but with all dynamically-allocated buffers duplicated in new buffers.
9120 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_clone(const struct LDKCResult_ChannelPublicKeysDecodeErrorZ *NONNULL_PTR orig);
9123 * Creates a new CResult_TxCreationKeysErrorZ in the success state.
9125 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_ok(struct LDKTxCreationKeys o);
9128 * Creates a new CResult_TxCreationKeysErrorZ in the error state.
9130 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_err(enum LDKSecp256k1Error e);
9133 * Frees any resources used by the CResult_TxCreationKeysErrorZ.
9135 void CResult_TxCreationKeysErrorZ_free(struct LDKCResult_TxCreationKeysErrorZ _res);
9138 * Creates a new CResult_TxCreationKeysErrorZ which has the same data as `orig`
9139 * but with all dynamically-allocated buffers duplicated in new buffers.
9141 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_clone(const struct LDKCResult_TxCreationKeysErrorZ *NONNULL_PTR orig);
9144 * Constructs a new COption_u32Z containing a u32
9146 struct LDKCOption_u32Z COption_u32Z_some(uint32_t o);
9149 * Constructs a new COption_u32Z containing nothing
9151 struct LDKCOption_u32Z COption_u32Z_none(void);
9154 * Frees any resources associated with the u32, if we are in the Some state
9156 void COption_u32Z_free(struct LDKCOption_u32Z _res);
9159 * Creates a new COption_u32Z which has the same data as `orig`
9160 * but with all dynamically-allocated buffers duplicated in new buffers.
9162 struct LDKCOption_u32Z COption_u32Z_clone(const struct LDKCOption_u32Z *NONNULL_PTR orig);
9165 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ in the success state.
9167 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_ok(struct LDKHTLCOutputInCommitment o);
9170 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ in the error state.
9172 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_err(struct LDKDecodeError e);
9175 * Frees any resources used by the CResult_HTLCOutputInCommitmentDecodeErrorZ.
9177 void CResult_HTLCOutputInCommitmentDecodeErrorZ_free(struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ _res);
9180 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ which has the same data as `orig`
9181 * but with all dynamically-allocated buffers duplicated in new buffers.
9183 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_clone(const struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ *NONNULL_PTR orig);
9186 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ in the success state.
9188 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_ok(struct LDKCounterpartyChannelTransactionParameters o);
9191 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ in the error state.
9193 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_err(struct LDKDecodeError e);
9196 * Frees any resources used by the CResult_CounterpartyChannelTransactionParametersDecodeErrorZ.
9198 void CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_free(struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ _res);
9201 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ which has the same data as `orig`
9202 * but with all dynamically-allocated buffers duplicated in new buffers.
9204 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_clone(const struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ *NONNULL_PTR orig);
9207 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ in the success state.
9209 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_ok(struct LDKChannelTransactionParameters o);
9212 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ in the error state.
9214 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_err(struct LDKDecodeError e);
9217 * Frees any resources used by the CResult_ChannelTransactionParametersDecodeErrorZ.
9219 void CResult_ChannelTransactionParametersDecodeErrorZ_free(struct LDKCResult_ChannelTransactionParametersDecodeErrorZ _res);
9222 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ which has the same data as `orig`
9223 * but with all dynamically-allocated buffers duplicated in new buffers.
9225 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_clone(const struct LDKCResult_ChannelTransactionParametersDecodeErrorZ *NONNULL_PTR orig);
9228 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9230 void CVec_SignatureZ_free(struct LDKCVec_SignatureZ _res);
9233 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ in the success state.
9235 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_ok(struct LDKHolderCommitmentTransaction o);
9238 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ in the error state.
9240 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
9243 * Frees any resources used by the CResult_HolderCommitmentTransactionDecodeErrorZ.
9245 void CResult_HolderCommitmentTransactionDecodeErrorZ_free(struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ _res);
9248 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ which has the same data as `orig`
9249 * but with all dynamically-allocated buffers duplicated in new buffers.
9251 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
9254 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ in the success state.
9256 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_ok(struct LDKBuiltCommitmentTransaction o);
9259 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ in the error state.
9261 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
9264 * Frees any resources used by the CResult_BuiltCommitmentTransactionDecodeErrorZ.
9266 void CResult_BuiltCommitmentTransactionDecodeErrorZ_free(struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ _res);
9269 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ which has the same data as `orig`
9270 * but with all dynamically-allocated buffers duplicated in new buffers.
9272 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
9275 * Creates a new CResult_CommitmentTransactionDecodeErrorZ in the success state.
9277 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_ok(struct LDKCommitmentTransaction o);
9280 * Creates a new CResult_CommitmentTransactionDecodeErrorZ in the error state.
9282 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
9285 * Frees any resources used by the CResult_CommitmentTransactionDecodeErrorZ.
9287 void CResult_CommitmentTransactionDecodeErrorZ_free(struct LDKCResult_CommitmentTransactionDecodeErrorZ _res);
9290 * Creates a new CResult_CommitmentTransactionDecodeErrorZ which has the same data as `orig`
9291 * but with all dynamically-allocated buffers duplicated in new buffers.
9293 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_CommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
9296 * Creates a new CResult_TrustedCommitmentTransactionNoneZ in the success state.
9298 struct LDKCResult_TrustedCommitmentTransactionNoneZ CResult_TrustedCommitmentTransactionNoneZ_ok(struct LDKTrustedCommitmentTransaction o);
9301 * Creates a new CResult_TrustedCommitmentTransactionNoneZ in the error state.
9303 struct LDKCResult_TrustedCommitmentTransactionNoneZ CResult_TrustedCommitmentTransactionNoneZ_err(void);
9306 * Frees any resources used by the CResult_TrustedCommitmentTransactionNoneZ.
9308 void CResult_TrustedCommitmentTransactionNoneZ_free(struct LDKCResult_TrustedCommitmentTransactionNoneZ _res);
9311 * Creates a new CResult_CVec_SignatureZNoneZ in the success state.
9313 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_ok(struct LDKCVec_SignatureZ o);
9316 * Creates a new CResult_CVec_SignatureZNoneZ in the error state.
9318 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_err(void);
9321 * Frees any resources used by the CResult_CVec_SignatureZNoneZ.
9323 void CResult_CVec_SignatureZNoneZ_free(struct LDKCResult_CVec_SignatureZNoneZ _res);
9326 * Creates a new CResult_CVec_SignatureZNoneZ which has the same data as `orig`
9327 * but with all dynamically-allocated buffers duplicated in new buffers.
9329 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_clone(const struct LDKCResult_CVec_SignatureZNoneZ *NONNULL_PTR orig);
9332 * Creates a new CResult_NoneErrorZ in the success state.
9334 struct LDKCResult_NoneErrorZ CResult_NoneErrorZ_ok(void);
9337 * Creates a new CResult_NoneErrorZ in the error state.
9339 struct LDKCResult_NoneErrorZ CResult_NoneErrorZ_err(enum LDKIOError e);
9342 * Frees any resources used by the CResult_NoneErrorZ.
9344 void CResult_NoneErrorZ_free(struct LDKCResult_NoneErrorZ _res);
9347 * Creates a new CResult_NoneErrorZ which has the same data as `orig`
9348 * but with all dynamically-allocated buffers duplicated in new buffers.
9350 struct LDKCResult_NoneErrorZ CResult_NoneErrorZ_clone(const struct LDKCResult_NoneErrorZ *NONNULL_PTR orig);
9353 * Creates a new CResult_RouteHopDecodeErrorZ in the success state.
9355 struct LDKCResult_RouteHopDecodeErrorZ CResult_RouteHopDecodeErrorZ_ok(struct LDKRouteHop o);
9358 * Creates a new CResult_RouteHopDecodeErrorZ in the error state.
9360 struct LDKCResult_RouteHopDecodeErrorZ CResult_RouteHopDecodeErrorZ_err(struct LDKDecodeError e);
9363 * Frees any resources used by the CResult_RouteHopDecodeErrorZ.
9365 void CResult_RouteHopDecodeErrorZ_free(struct LDKCResult_RouteHopDecodeErrorZ _res);
9368 * Creates a new CResult_RouteHopDecodeErrorZ which has the same data as `orig`
9369 * but with all dynamically-allocated buffers duplicated in new buffers.
9371 struct LDKCResult_RouteHopDecodeErrorZ CResult_RouteHopDecodeErrorZ_clone(const struct LDKCResult_RouteHopDecodeErrorZ *NONNULL_PTR orig);
9374 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9376 void CVec_RouteHopZ_free(struct LDKCVec_RouteHopZ _res);
9379 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9381 void CVec_CVec_RouteHopZZ_free(struct LDKCVec_CVec_RouteHopZZ _res);
9384 * Creates a new CResult_RouteDecodeErrorZ in the success state.
9386 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_ok(struct LDKRoute o);
9389 * Creates a new CResult_RouteDecodeErrorZ in the error state.
9391 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_err(struct LDKDecodeError e);
9394 * Frees any resources used by the CResult_RouteDecodeErrorZ.
9396 void CResult_RouteDecodeErrorZ_free(struct LDKCResult_RouteDecodeErrorZ _res);
9399 * Creates a new CResult_RouteDecodeErrorZ which has the same data as `orig`
9400 * but with all dynamically-allocated buffers duplicated in new buffers.
9402 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_clone(const struct LDKCResult_RouteDecodeErrorZ *NONNULL_PTR orig);
9405 * Constructs a new COption_u64Z containing a u64
9407 struct LDKCOption_u64Z COption_u64Z_some(uint64_t o);
9410 * Constructs a new COption_u64Z containing nothing
9412 struct LDKCOption_u64Z COption_u64Z_none(void);
9415 * Frees any resources associated with the u64, if we are in the Some state
9417 void COption_u64Z_free(struct LDKCOption_u64Z _res);
9420 * Creates a new COption_u64Z which has the same data as `orig`
9421 * but with all dynamically-allocated buffers duplicated in new buffers.
9423 struct LDKCOption_u64Z COption_u64Z_clone(const struct LDKCOption_u64Z *NONNULL_PTR orig);
9426 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9428 void CVec_ChannelDetailsZ_free(struct LDKCVec_ChannelDetailsZ _res);
9431 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9433 void CVec_RouteHintHopZ_free(struct LDKCVec_RouteHintHopZ _res);
9436 * Creates a new CResult_RouteLightningErrorZ in the success state.
9438 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_ok(struct LDKRoute o);
9441 * Creates a new CResult_RouteLightningErrorZ in the error state.
9443 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_err(struct LDKLightningError e);
9446 * Frees any resources used by the CResult_RouteLightningErrorZ.
9448 void CResult_RouteLightningErrorZ_free(struct LDKCResult_RouteLightningErrorZ _res);
9451 * Creates a new CResult_RouteLightningErrorZ which has the same data as `orig`
9452 * but with all dynamically-allocated buffers duplicated in new buffers.
9454 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_clone(const struct LDKCResult_RouteLightningErrorZ *NONNULL_PTR orig);
9457 * Creates a new CResult_TxOutAccessErrorZ in the success state.
9459 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_ok(struct LDKTxOut o);
9462 * Creates a new CResult_TxOutAccessErrorZ in the error state.
9464 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_err(enum LDKAccessError e);
9467 * Frees any resources used by the CResult_TxOutAccessErrorZ.
9469 void CResult_TxOutAccessErrorZ_free(struct LDKCResult_TxOutAccessErrorZ _res);
9472 * Creates a new CResult_TxOutAccessErrorZ which has the same data as `orig`
9473 * but with all dynamically-allocated buffers duplicated in new buffers.
9475 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_clone(const struct LDKCResult_TxOutAccessErrorZ *NONNULL_PTR orig);
9478 * Creates a new tuple which has the same data as `orig`
9479 * but with all dynamically-allocated buffers duplicated in new buffers.
9481 struct LDKC2Tuple_usizeTransactionZ C2Tuple_usizeTransactionZ_clone(const struct LDKC2Tuple_usizeTransactionZ *NONNULL_PTR orig);
9484 * Creates a new C2Tuple_usizeTransactionZ from the contained elements.
9486 struct LDKC2Tuple_usizeTransactionZ C2Tuple_usizeTransactionZ_new(uintptr_t a, struct LDKTransaction b);
9489 * Frees any resources used by the C2Tuple_usizeTransactionZ.
9491 void C2Tuple_usizeTransactionZ_free(struct LDKC2Tuple_usizeTransactionZ _res);
9494 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9496 void CVec_C2Tuple_usizeTransactionZZ_free(struct LDKCVec_C2Tuple_usizeTransactionZZ _res);
9499 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9501 void CVec_TxidZ_free(struct LDKCVec_TxidZ _res);
9504 * Creates a new CResult_NoneChannelMonitorUpdateErrZ in the success state.
9506 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_ok(void);
9509 * Creates a new CResult_NoneChannelMonitorUpdateErrZ in the error state.
9511 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_err(enum LDKChannelMonitorUpdateErr e);
9514 * Frees any resources used by the CResult_NoneChannelMonitorUpdateErrZ.
9516 void CResult_NoneChannelMonitorUpdateErrZ_free(struct LDKCResult_NoneChannelMonitorUpdateErrZ _res);
9519 * Creates a new CResult_NoneChannelMonitorUpdateErrZ which has the same data as `orig`
9520 * but with all dynamically-allocated buffers duplicated in new buffers.
9522 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_clone(const struct LDKCResult_NoneChannelMonitorUpdateErrZ *NONNULL_PTR orig);
9525 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9527 void CVec_MonitorEventZ_free(struct LDKCVec_MonitorEventZ _res);
9530 * Constructs a new COption_C2Tuple_usizeTransactionZZ containing a crate::c_types::derived::C2Tuple_usizeTransactionZ
9532 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_some(struct LDKC2Tuple_usizeTransactionZ o);
9535 * Constructs a new COption_C2Tuple_usizeTransactionZZ containing nothing
9537 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_none(void);
9540 * Frees any resources associated with the crate::c_types::derived::C2Tuple_usizeTransactionZ, if we are in the Some state
9542 void COption_C2Tuple_usizeTransactionZZ_free(struct LDKCOption_C2Tuple_usizeTransactionZZ _res);
9545 * Creates a new COption_C2Tuple_usizeTransactionZZ which has the same data as `orig`
9546 * but with all dynamically-allocated buffers duplicated in new buffers.
9548 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_clone(const struct LDKCOption_C2Tuple_usizeTransactionZZ *NONNULL_PTR orig);
9551 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9553 void CVec_SpendableOutputDescriptorZ_free(struct LDKCVec_SpendableOutputDescriptorZ _res);
9556 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9558 void CVec_MessageSendEventZ_free(struct LDKCVec_MessageSendEventZ _res);
9561 * Creates a new CResult_InitFeaturesDecodeErrorZ in the success state.
9563 struct LDKCResult_InitFeaturesDecodeErrorZ CResult_InitFeaturesDecodeErrorZ_ok(struct LDKInitFeatures o);
9566 * Creates a new CResult_InitFeaturesDecodeErrorZ in the error state.
9568 struct LDKCResult_InitFeaturesDecodeErrorZ CResult_InitFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
9571 * Frees any resources used by the CResult_InitFeaturesDecodeErrorZ.
9573 void CResult_InitFeaturesDecodeErrorZ_free(struct LDKCResult_InitFeaturesDecodeErrorZ _res);
9576 * Creates a new CResult_NodeFeaturesDecodeErrorZ in the success state.
9578 struct LDKCResult_NodeFeaturesDecodeErrorZ CResult_NodeFeaturesDecodeErrorZ_ok(struct LDKNodeFeatures o);
9581 * Creates a new CResult_NodeFeaturesDecodeErrorZ in the error state.
9583 struct LDKCResult_NodeFeaturesDecodeErrorZ CResult_NodeFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
9586 * Frees any resources used by the CResult_NodeFeaturesDecodeErrorZ.
9588 void CResult_NodeFeaturesDecodeErrorZ_free(struct LDKCResult_NodeFeaturesDecodeErrorZ _res);
9591 * Creates a new CResult_ChannelFeaturesDecodeErrorZ in the success state.
9593 struct LDKCResult_ChannelFeaturesDecodeErrorZ CResult_ChannelFeaturesDecodeErrorZ_ok(struct LDKChannelFeatures o);
9596 * Creates a new CResult_ChannelFeaturesDecodeErrorZ in the error state.
9598 struct LDKCResult_ChannelFeaturesDecodeErrorZ CResult_ChannelFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
9601 * Frees any resources used by the CResult_ChannelFeaturesDecodeErrorZ.
9603 void CResult_ChannelFeaturesDecodeErrorZ_free(struct LDKCResult_ChannelFeaturesDecodeErrorZ _res);
9606 * Creates a new CResult_InvoiceFeaturesDecodeErrorZ in the success state.
9608 struct LDKCResult_InvoiceFeaturesDecodeErrorZ CResult_InvoiceFeaturesDecodeErrorZ_ok(struct LDKInvoiceFeatures o);
9611 * Creates a new CResult_InvoiceFeaturesDecodeErrorZ in the error state.
9613 struct LDKCResult_InvoiceFeaturesDecodeErrorZ CResult_InvoiceFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
9616 * Frees any resources used by the CResult_InvoiceFeaturesDecodeErrorZ.
9618 void CResult_InvoiceFeaturesDecodeErrorZ_free(struct LDKCResult_InvoiceFeaturesDecodeErrorZ _res);
9621 * Creates a new CResult_DelayedPaymentOutputDescriptorDecodeErrorZ in the success state.
9623 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_ok(struct LDKDelayedPaymentOutputDescriptor o);
9626 * Creates a new CResult_DelayedPaymentOutputDescriptorDecodeErrorZ in the error state.
9628 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e);
9631 * Frees any resources used by the CResult_DelayedPaymentOutputDescriptorDecodeErrorZ.
9633 void CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_free(struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ _res);
9636 * Creates a new CResult_DelayedPaymentOutputDescriptorDecodeErrorZ which has the same data as `orig`
9637 * but with all dynamically-allocated buffers duplicated in new buffers.
9639 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ *NONNULL_PTR orig);
9642 * Creates a new CResult_StaticPaymentOutputDescriptorDecodeErrorZ in the success state.
9644 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ CResult_StaticPaymentOutputDescriptorDecodeErrorZ_ok(struct LDKStaticPaymentOutputDescriptor o);
9647 * Creates a new CResult_StaticPaymentOutputDescriptorDecodeErrorZ in the error state.
9649 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ CResult_StaticPaymentOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e);
9652 * Frees any resources used by the CResult_StaticPaymentOutputDescriptorDecodeErrorZ.
9654 void CResult_StaticPaymentOutputDescriptorDecodeErrorZ_free(struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ _res);
9657 * Creates a new CResult_StaticPaymentOutputDescriptorDecodeErrorZ which has the same data as `orig`
9658 * but with all dynamically-allocated buffers duplicated in new buffers.
9660 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ CResult_StaticPaymentOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ *NONNULL_PTR orig);
9663 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ in the success state.
9665 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_ok(struct LDKSpendableOutputDescriptor o);
9668 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ in the error state.
9670 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e);
9673 * Frees any resources used by the CResult_SpendableOutputDescriptorDecodeErrorZ.
9675 void CResult_SpendableOutputDescriptorDecodeErrorZ_free(struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ _res);
9678 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ which has the same data as `orig`
9679 * but with all dynamically-allocated buffers duplicated in new buffers.
9681 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ *NONNULL_PTR orig);
9684 * Creates a new tuple which has the same data as `orig`
9685 * but with all dynamically-allocated buffers duplicated in new buffers.
9687 struct LDKC2Tuple_SignatureCVec_SignatureZZ C2Tuple_SignatureCVec_SignatureZZ_clone(const struct LDKC2Tuple_SignatureCVec_SignatureZZ *NONNULL_PTR orig);
9690 * Creates a new C2Tuple_SignatureCVec_SignatureZZ from the contained elements.
9692 struct LDKC2Tuple_SignatureCVec_SignatureZZ C2Tuple_SignatureCVec_SignatureZZ_new(struct LDKSignature a, struct LDKCVec_SignatureZ b);
9695 * Frees any resources used by the C2Tuple_SignatureCVec_SignatureZZ.
9697 void C2Tuple_SignatureCVec_SignatureZZ_free(struct LDKC2Tuple_SignatureCVec_SignatureZZ _res);
9700 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ in the success state.
9702 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_ok(struct LDKC2Tuple_SignatureCVec_SignatureZZ o);
9705 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ in the error state.
9707 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_err(void);
9710 * Frees any resources used by the CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ.
9712 void CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_free(struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ _res);
9715 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ which has the same data as `orig`
9716 * but with all dynamically-allocated buffers duplicated in new buffers.
9718 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_clone(const struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ *NONNULL_PTR orig);
9721 * Creates a new CResult_SignatureNoneZ in the success state.
9723 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_ok(struct LDKSignature o);
9726 * Creates a new CResult_SignatureNoneZ in the error state.
9728 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_err(void);
9731 * Frees any resources used by the CResult_SignatureNoneZ.
9733 void CResult_SignatureNoneZ_free(struct LDKCResult_SignatureNoneZ _res);
9736 * Creates a new CResult_SignatureNoneZ which has the same data as `orig`
9737 * but with all dynamically-allocated buffers duplicated in new buffers.
9739 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_clone(const struct LDKCResult_SignatureNoneZ *NONNULL_PTR orig);
9742 * Creates a new CResult_SignDecodeErrorZ in the success state.
9744 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_ok(struct LDKSign o);
9747 * Creates a new CResult_SignDecodeErrorZ in the error state.
9749 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_err(struct LDKDecodeError e);
9752 * Frees any resources used by the CResult_SignDecodeErrorZ.
9754 void CResult_SignDecodeErrorZ_free(struct LDKCResult_SignDecodeErrorZ _res);
9757 * Creates a new CResult_SignDecodeErrorZ which has the same data as `orig`
9758 * but with all dynamically-allocated buffers duplicated in new buffers.
9760 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_clone(const struct LDKCResult_SignDecodeErrorZ *NONNULL_PTR orig);
9763 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9765 void CVec_u8Z_free(struct LDKCVec_u8Z _res);
9768 * Creates a new CResult_RecoverableSignatureNoneZ in the success state.
9770 struct LDKCResult_RecoverableSignatureNoneZ CResult_RecoverableSignatureNoneZ_ok(struct LDKRecoverableSignature o);
9773 * Creates a new CResult_RecoverableSignatureNoneZ in the error state.
9775 struct LDKCResult_RecoverableSignatureNoneZ CResult_RecoverableSignatureNoneZ_err(void);
9778 * Frees any resources used by the CResult_RecoverableSignatureNoneZ.
9780 void CResult_RecoverableSignatureNoneZ_free(struct LDKCResult_RecoverableSignatureNoneZ _res);
9783 * Creates a new CResult_RecoverableSignatureNoneZ which has the same data as `orig`
9784 * but with all dynamically-allocated buffers duplicated in new buffers.
9786 struct LDKCResult_RecoverableSignatureNoneZ CResult_RecoverableSignatureNoneZ_clone(const struct LDKCResult_RecoverableSignatureNoneZ *NONNULL_PTR orig);
9789 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9791 void CVec_CVec_u8ZZ_free(struct LDKCVec_CVec_u8ZZ _res);
9794 * Creates a new CResult_CVec_CVec_u8ZZNoneZ in the success state.
9796 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_ok(struct LDKCVec_CVec_u8ZZ o);
9799 * Creates a new CResult_CVec_CVec_u8ZZNoneZ in the error state.
9801 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_err(void);
9804 * Frees any resources used by the CResult_CVec_CVec_u8ZZNoneZ.
9806 void CResult_CVec_CVec_u8ZZNoneZ_free(struct LDKCResult_CVec_CVec_u8ZZNoneZ _res);
9809 * Creates a new CResult_CVec_CVec_u8ZZNoneZ which has the same data as `orig`
9810 * but with all dynamically-allocated buffers duplicated in new buffers.
9812 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_clone(const struct LDKCResult_CVec_CVec_u8ZZNoneZ *NONNULL_PTR orig);
9815 * Creates a new CResult_InMemorySignerDecodeErrorZ in the success state.
9817 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_ok(struct LDKInMemorySigner o);
9820 * Creates a new CResult_InMemorySignerDecodeErrorZ in the error state.
9822 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_err(struct LDKDecodeError e);
9825 * Frees any resources used by the CResult_InMemorySignerDecodeErrorZ.
9827 void CResult_InMemorySignerDecodeErrorZ_free(struct LDKCResult_InMemorySignerDecodeErrorZ _res);
9830 * Creates a new CResult_InMemorySignerDecodeErrorZ which has the same data as `orig`
9831 * but with all dynamically-allocated buffers duplicated in new buffers.
9833 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_clone(const struct LDKCResult_InMemorySignerDecodeErrorZ *NONNULL_PTR orig);
9836 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9838 void CVec_TxOutZ_free(struct LDKCVec_TxOutZ _res);
9841 * Creates a new CResult_TransactionNoneZ in the success state.
9843 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_ok(struct LDKTransaction o);
9846 * Creates a new CResult_TransactionNoneZ in the error state.
9848 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_err(void);
9851 * Frees any resources used by the CResult_TransactionNoneZ.
9853 void CResult_TransactionNoneZ_free(struct LDKCResult_TransactionNoneZ _res);
9856 * Creates a new CResult_TransactionNoneZ which has the same data as `orig`
9857 * but with all dynamically-allocated buffers duplicated in new buffers.
9859 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_clone(const struct LDKCResult_TransactionNoneZ *NONNULL_PTR orig);
9862 * Creates a new C2Tuple_BlockHashChannelMonitorZ from the contained elements.
9864 struct LDKC2Tuple_BlockHashChannelMonitorZ C2Tuple_BlockHashChannelMonitorZ_new(struct LDKThirtyTwoBytes a, struct LDKChannelMonitor b);
9867 * Frees any resources used by the C2Tuple_BlockHashChannelMonitorZ.
9869 void C2Tuple_BlockHashChannelMonitorZ_free(struct LDKC2Tuple_BlockHashChannelMonitorZ _res);
9872 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9874 void CVec_C2Tuple_BlockHashChannelMonitorZZ_free(struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ _res);
9877 * Creates a new CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ in the success state.
9879 struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_ok(struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ o);
9882 * Creates a new CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ in the error state.
9884 struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_err(enum LDKIOError e);
9887 * Frees any resources used by the CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ.
9889 void CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_free(struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ _res);
9892 * Creates a new CResult_NoneAPIErrorZ in the success state.
9894 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_ok(void);
9897 * Creates a new CResult_NoneAPIErrorZ in the error state.
9899 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_err(struct LDKAPIError e);
9902 * Frees any resources used by the CResult_NoneAPIErrorZ.
9904 void CResult_NoneAPIErrorZ_free(struct LDKCResult_NoneAPIErrorZ _res);
9907 * Creates a new CResult_NoneAPIErrorZ which has the same data as `orig`
9908 * but with all dynamically-allocated buffers duplicated in new buffers.
9910 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_clone(const struct LDKCResult_NoneAPIErrorZ *NONNULL_PTR orig);
9913 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9915 void CVec_CResult_NoneAPIErrorZZ_free(struct LDKCVec_CResult_NoneAPIErrorZZ _res);
9918 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9920 void CVec_APIErrorZ_free(struct LDKCVec_APIErrorZ _res);
9923 * Creates a new CResult_NonePaymentSendFailureZ in the success state.
9925 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_ok(void);
9928 * Creates a new CResult_NonePaymentSendFailureZ in the error state.
9930 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_err(struct LDKPaymentSendFailure e);
9933 * Frees any resources used by the CResult_NonePaymentSendFailureZ.
9935 void CResult_NonePaymentSendFailureZ_free(struct LDKCResult_NonePaymentSendFailureZ _res);
9938 * Creates a new CResult_NonePaymentSendFailureZ which has the same data as `orig`
9939 * but with all dynamically-allocated buffers duplicated in new buffers.
9941 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_clone(const struct LDKCResult_NonePaymentSendFailureZ *NONNULL_PTR orig);
9944 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9946 void CVec_NetAddressZ_free(struct LDKCVec_NetAddressZ _res);
9949 * Creates a new tuple which has the same data as `orig`
9950 * but with all dynamically-allocated buffers duplicated in new buffers.
9952 struct LDKC2Tuple_PaymentHashPaymentSecretZ C2Tuple_PaymentHashPaymentSecretZ_clone(const struct LDKC2Tuple_PaymentHashPaymentSecretZ *NONNULL_PTR orig);
9955 * Creates a new C2Tuple_PaymentHashPaymentSecretZ from the contained elements.
9957 struct LDKC2Tuple_PaymentHashPaymentSecretZ C2Tuple_PaymentHashPaymentSecretZ_new(struct LDKThirtyTwoBytes a, struct LDKThirtyTwoBytes b);
9960 * Frees any resources used by the C2Tuple_PaymentHashPaymentSecretZ.
9962 void C2Tuple_PaymentHashPaymentSecretZ_free(struct LDKC2Tuple_PaymentHashPaymentSecretZ _res);
9965 * Creates a new CResult_PaymentSecretAPIErrorZ in the success state.
9967 struct LDKCResult_PaymentSecretAPIErrorZ CResult_PaymentSecretAPIErrorZ_ok(struct LDKThirtyTwoBytes o);
9970 * Creates a new CResult_PaymentSecretAPIErrorZ in the error state.
9972 struct LDKCResult_PaymentSecretAPIErrorZ CResult_PaymentSecretAPIErrorZ_err(struct LDKAPIError e);
9975 * Frees any resources used by the CResult_PaymentSecretAPIErrorZ.
9977 void CResult_PaymentSecretAPIErrorZ_free(struct LDKCResult_PaymentSecretAPIErrorZ _res);
9980 * Creates a new CResult_PaymentSecretAPIErrorZ which has the same data as `orig`
9981 * but with all dynamically-allocated buffers duplicated in new buffers.
9983 struct LDKCResult_PaymentSecretAPIErrorZ CResult_PaymentSecretAPIErrorZ_clone(const struct LDKCResult_PaymentSecretAPIErrorZ *NONNULL_PTR orig);
9986 * Frees the buffer pointed to by `data` if `datalen` is non-0.
9988 void CVec_ChannelMonitorZ_free(struct LDKCVec_ChannelMonitorZ _res);
9991 * Creates a new C2Tuple_BlockHashChannelManagerZ from the contained elements.
9993 struct LDKC2Tuple_BlockHashChannelManagerZ C2Tuple_BlockHashChannelManagerZ_new(struct LDKThirtyTwoBytes a, struct LDKChannelManager b);
9996 * Frees any resources used by the C2Tuple_BlockHashChannelManagerZ.
9998 void C2Tuple_BlockHashChannelManagerZ_free(struct LDKC2Tuple_BlockHashChannelManagerZ _res);
10001 * Creates a new CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ in the success state.
10003 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_ok(struct LDKC2Tuple_BlockHashChannelManagerZ o);
10006 * Creates a new CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ in the error state.
10008 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_err(struct LDKDecodeError e);
10011 * Frees any resources used by the CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.
10013 void CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_free(struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ _res);
10016 * Creates a new CResult_ChannelConfigDecodeErrorZ in the success state.
10018 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_ok(struct LDKChannelConfig o);
10021 * Creates a new CResult_ChannelConfigDecodeErrorZ in the error state.
10023 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_err(struct LDKDecodeError e);
10026 * Frees any resources used by the CResult_ChannelConfigDecodeErrorZ.
10028 void CResult_ChannelConfigDecodeErrorZ_free(struct LDKCResult_ChannelConfigDecodeErrorZ _res);
10031 * Creates a new CResult_ChannelConfigDecodeErrorZ which has the same data as `orig`
10032 * but with all dynamically-allocated buffers duplicated in new buffers.
10034 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_clone(const struct LDKCResult_ChannelConfigDecodeErrorZ *NONNULL_PTR orig);
10037 * Creates a new CResult_OutPointDecodeErrorZ in the success state.
10039 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_ok(struct LDKOutPoint o);
10042 * Creates a new CResult_OutPointDecodeErrorZ in the error state.
10044 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_err(struct LDKDecodeError e);
10047 * Frees any resources used by the CResult_OutPointDecodeErrorZ.
10049 void CResult_OutPointDecodeErrorZ_free(struct LDKCResult_OutPointDecodeErrorZ _res);
10052 * Creates a new CResult_OutPointDecodeErrorZ which has the same data as `orig`
10053 * but with all dynamically-allocated buffers duplicated in new buffers.
10055 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_clone(const struct LDKCResult_OutPointDecodeErrorZ *NONNULL_PTR orig);
10058 * Creates a new CResult_SiPrefixNoneZ in the success state.
10060 struct LDKCResult_SiPrefixNoneZ CResult_SiPrefixNoneZ_ok(enum LDKSiPrefix o);
10063 * Creates a new CResult_SiPrefixNoneZ in the error state.
10065 struct LDKCResult_SiPrefixNoneZ CResult_SiPrefixNoneZ_err(void);
10068 * Frees any resources used by the CResult_SiPrefixNoneZ.
10070 void CResult_SiPrefixNoneZ_free(struct LDKCResult_SiPrefixNoneZ _res);
10073 * Creates a new CResult_SiPrefixNoneZ which has the same data as `orig`
10074 * but with all dynamically-allocated buffers duplicated in new buffers.
10076 struct LDKCResult_SiPrefixNoneZ CResult_SiPrefixNoneZ_clone(const struct LDKCResult_SiPrefixNoneZ *NONNULL_PTR orig);
10079 * Creates a new CResult_InvoiceNoneZ in the success state.
10081 struct LDKCResult_InvoiceNoneZ CResult_InvoiceNoneZ_ok(struct LDKInvoice o);
10084 * Creates a new CResult_InvoiceNoneZ in the error state.
10086 struct LDKCResult_InvoiceNoneZ CResult_InvoiceNoneZ_err(void);
10089 * Frees any resources used by the CResult_InvoiceNoneZ.
10091 void CResult_InvoiceNoneZ_free(struct LDKCResult_InvoiceNoneZ _res);
10094 * Creates a new CResult_InvoiceNoneZ which has the same data as `orig`
10095 * but with all dynamically-allocated buffers duplicated in new buffers.
10097 struct LDKCResult_InvoiceNoneZ CResult_InvoiceNoneZ_clone(const struct LDKCResult_InvoiceNoneZ *NONNULL_PTR orig);
10100 * Creates a new CResult_SignedRawInvoiceNoneZ in the success state.
10102 struct LDKCResult_SignedRawInvoiceNoneZ CResult_SignedRawInvoiceNoneZ_ok(struct LDKSignedRawInvoice o);
10105 * Creates a new CResult_SignedRawInvoiceNoneZ in the error state.
10107 struct LDKCResult_SignedRawInvoiceNoneZ CResult_SignedRawInvoiceNoneZ_err(void);
10110 * Frees any resources used by the CResult_SignedRawInvoiceNoneZ.
10112 void CResult_SignedRawInvoiceNoneZ_free(struct LDKCResult_SignedRawInvoiceNoneZ _res);
10115 * Creates a new CResult_SignedRawInvoiceNoneZ which has the same data as `orig`
10116 * but with all dynamically-allocated buffers duplicated in new buffers.
10118 struct LDKCResult_SignedRawInvoiceNoneZ CResult_SignedRawInvoiceNoneZ_clone(const struct LDKCResult_SignedRawInvoiceNoneZ *NONNULL_PTR orig);
10121 * Creates a new tuple which has the same data as `orig`
10122 * but with all dynamically-allocated buffers duplicated in new buffers.
10124 struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ C3Tuple_RawInvoice_u832InvoiceSignatureZ_clone(const struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ *NONNULL_PTR orig);
10127 * Creates a new C3Tuple_RawInvoice_u832InvoiceSignatureZ from the contained elements.
10129 struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ C3Tuple_RawInvoice_u832InvoiceSignatureZ_new(struct LDKRawInvoice a, struct LDKThirtyTwoBytes b, struct LDKInvoiceSignature c);
10132 * Frees any resources used by the C3Tuple_RawInvoice_u832InvoiceSignatureZ.
10134 void C3Tuple_RawInvoice_u832InvoiceSignatureZ_free(struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ _res);
10137 * Creates a new CResult_PayeePubKeyErrorZ in the success state.
10139 struct LDKCResult_PayeePubKeyErrorZ CResult_PayeePubKeyErrorZ_ok(struct LDKPayeePubKey o);
10142 * Creates a new CResult_PayeePubKeyErrorZ in the error state.
10144 struct LDKCResult_PayeePubKeyErrorZ CResult_PayeePubKeyErrorZ_err(enum LDKSecp256k1Error e);
10147 * Frees any resources used by the CResult_PayeePubKeyErrorZ.
10149 void CResult_PayeePubKeyErrorZ_free(struct LDKCResult_PayeePubKeyErrorZ _res);
10152 * Creates a new CResult_PayeePubKeyErrorZ which has the same data as `orig`
10153 * but with all dynamically-allocated buffers duplicated in new buffers.
10155 struct LDKCResult_PayeePubKeyErrorZ CResult_PayeePubKeyErrorZ_clone(const struct LDKCResult_PayeePubKeyErrorZ *NONNULL_PTR orig);
10158 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10160 void CVec_RouteHintZ_free(struct LDKCVec_RouteHintZ _res);
10163 * Creates a new CResult_PositiveTimestampCreationErrorZ in the success state.
10165 struct LDKCResult_PositiveTimestampCreationErrorZ CResult_PositiveTimestampCreationErrorZ_ok(struct LDKPositiveTimestamp o);
10168 * Creates a new CResult_PositiveTimestampCreationErrorZ in the error state.
10170 struct LDKCResult_PositiveTimestampCreationErrorZ CResult_PositiveTimestampCreationErrorZ_err(enum LDKCreationError e);
10173 * Frees any resources used by the CResult_PositiveTimestampCreationErrorZ.
10175 void CResult_PositiveTimestampCreationErrorZ_free(struct LDKCResult_PositiveTimestampCreationErrorZ _res);
10178 * Creates a new CResult_PositiveTimestampCreationErrorZ which has the same data as `orig`
10179 * but with all dynamically-allocated buffers duplicated in new buffers.
10181 struct LDKCResult_PositiveTimestampCreationErrorZ CResult_PositiveTimestampCreationErrorZ_clone(const struct LDKCResult_PositiveTimestampCreationErrorZ *NONNULL_PTR orig);
10184 * Creates a new CResult_NoneSemanticErrorZ in the success state.
10186 struct LDKCResult_NoneSemanticErrorZ CResult_NoneSemanticErrorZ_ok(void);
10189 * Creates a new CResult_NoneSemanticErrorZ in the error state.
10191 struct LDKCResult_NoneSemanticErrorZ CResult_NoneSemanticErrorZ_err(enum LDKSemanticError e);
10194 * Frees any resources used by the CResult_NoneSemanticErrorZ.
10196 void CResult_NoneSemanticErrorZ_free(struct LDKCResult_NoneSemanticErrorZ _res);
10199 * Creates a new CResult_NoneSemanticErrorZ which has the same data as `orig`
10200 * but with all dynamically-allocated buffers duplicated in new buffers.
10202 struct LDKCResult_NoneSemanticErrorZ CResult_NoneSemanticErrorZ_clone(const struct LDKCResult_NoneSemanticErrorZ *NONNULL_PTR orig);
10205 * Creates a new CResult_InvoiceSemanticErrorZ in the success state.
10207 struct LDKCResult_InvoiceSemanticErrorZ CResult_InvoiceSemanticErrorZ_ok(struct LDKInvoice o);
10210 * Creates a new CResult_InvoiceSemanticErrorZ in the error state.
10212 struct LDKCResult_InvoiceSemanticErrorZ CResult_InvoiceSemanticErrorZ_err(enum LDKSemanticError e);
10215 * Frees any resources used by the CResult_InvoiceSemanticErrorZ.
10217 void CResult_InvoiceSemanticErrorZ_free(struct LDKCResult_InvoiceSemanticErrorZ _res);
10220 * Creates a new CResult_InvoiceSemanticErrorZ which has the same data as `orig`
10221 * but with all dynamically-allocated buffers duplicated in new buffers.
10223 struct LDKCResult_InvoiceSemanticErrorZ CResult_InvoiceSemanticErrorZ_clone(const struct LDKCResult_InvoiceSemanticErrorZ *NONNULL_PTR orig);
10226 * Creates a new CResult_DescriptionCreationErrorZ in the success state.
10228 struct LDKCResult_DescriptionCreationErrorZ CResult_DescriptionCreationErrorZ_ok(struct LDKDescription o);
10231 * Creates a new CResult_DescriptionCreationErrorZ in the error state.
10233 struct LDKCResult_DescriptionCreationErrorZ CResult_DescriptionCreationErrorZ_err(enum LDKCreationError e);
10236 * Frees any resources used by the CResult_DescriptionCreationErrorZ.
10238 void CResult_DescriptionCreationErrorZ_free(struct LDKCResult_DescriptionCreationErrorZ _res);
10241 * Creates a new CResult_DescriptionCreationErrorZ which has the same data as `orig`
10242 * but with all dynamically-allocated buffers duplicated in new buffers.
10244 struct LDKCResult_DescriptionCreationErrorZ CResult_DescriptionCreationErrorZ_clone(const struct LDKCResult_DescriptionCreationErrorZ *NONNULL_PTR orig);
10247 * Creates a new CResult_ExpiryTimeCreationErrorZ in the success state.
10249 struct LDKCResult_ExpiryTimeCreationErrorZ CResult_ExpiryTimeCreationErrorZ_ok(struct LDKExpiryTime o);
10252 * Creates a new CResult_ExpiryTimeCreationErrorZ in the error state.
10254 struct LDKCResult_ExpiryTimeCreationErrorZ CResult_ExpiryTimeCreationErrorZ_err(enum LDKCreationError e);
10257 * Frees any resources used by the CResult_ExpiryTimeCreationErrorZ.
10259 void CResult_ExpiryTimeCreationErrorZ_free(struct LDKCResult_ExpiryTimeCreationErrorZ _res);
10262 * Creates a new CResult_ExpiryTimeCreationErrorZ which has the same data as `orig`
10263 * but with all dynamically-allocated buffers duplicated in new buffers.
10265 struct LDKCResult_ExpiryTimeCreationErrorZ CResult_ExpiryTimeCreationErrorZ_clone(const struct LDKCResult_ExpiryTimeCreationErrorZ *NONNULL_PTR orig);
10268 * Creates a new CResult_RouteHintCreationErrorZ in the success state.
10270 struct LDKCResult_RouteHintCreationErrorZ CResult_RouteHintCreationErrorZ_ok(struct LDKRouteHint o);
10273 * Creates a new CResult_RouteHintCreationErrorZ in the error state.
10275 struct LDKCResult_RouteHintCreationErrorZ CResult_RouteHintCreationErrorZ_err(enum LDKCreationError e);
10278 * Frees any resources used by the CResult_RouteHintCreationErrorZ.
10280 void CResult_RouteHintCreationErrorZ_free(struct LDKCResult_RouteHintCreationErrorZ _res);
10283 * Creates a new CResult_RouteHintCreationErrorZ which has the same data as `orig`
10284 * but with all dynamically-allocated buffers duplicated in new buffers.
10286 struct LDKCResult_RouteHintCreationErrorZ CResult_RouteHintCreationErrorZ_clone(const struct LDKCResult_RouteHintCreationErrorZ *NONNULL_PTR orig);
10289 * Creates a new CResult_StringErrorZ in the success state.
10291 struct LDKCResult_StringErrorZ CResult_StringErrorZ_ok(struct LDKStr o);
10294 * Creates a new CResult_StringErrorZ in the error state.
10296 struct LDKCResult_StringErrorZ CResult_StringErrorZ_err(enum LDKSecp256k1Error e);
10299 * Frees any resources used by the CResult_StringErrorZ.
10301 void CResult_StringErrorZ_free(struct LDKCResult_StringErrorZ _res);
10304 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ in the success state.
10306 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_ok(struct LDKChannelMonitorUpdate o);
10309 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ in the error state.
10311 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_err(struct LDKDecodeError e);
10314 * Frees any resources used by the CResult_ChannelMonitorUpdateDecodeErrorZ.
10316 void CResult_ChannelMonitorUpdateDecodeErrorZ_free(struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ _res);
10319 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ which has the same data as `orig`
10320 * but with all dynamically-allocated buffers duplicated in new buffers.
10322 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_clone(const struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ *NONNULL_PTR orig);
10325 * Creates a new CResult_HTLCUpdateDecodeErrorZ in the success state.
10327 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_ok(struct LDKHTLCUpdate o);
10330 * Creates a new CResult_HTLCUpdateDecodeErrorZ in the error state.
10332 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_err(struct LDKDecodeError e);
10335 * Frees any resources used by the CResult_HTLCUpdateDecodeErrorZ.
10337 void CResult_HTLCUpdateDecodeErrorZ_free(struct LDKCResult_HTLCUpdateDecodeErrorZ _res);
10340 * Creates a new CResult_HTLCUpdateDecodeErrorZ which has the same data as `orig`
10341 * but with all dynamically-allocated buffers duplicated in new buffers.
10343 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_clone(const struct LDKCResult_HTLCUpdateDecodeErrorZ *NONNULL_PTR orig);
10346 * Creates a new CResult_NoneMonitorUpdateErrorZ in the success state.
10348 struct LDKCResult_NoneMonitorUpdateErrorZ CResult_NoneMonitorUpdateErrorZ_ok(void);
10351 * Creates a new CResult_NoneMonitorUpdateErrorZ in the error state.
10353 struct LDKCResult_NoneMonitorUpdateErrorZ CResult_NoneMonitorUpdateErrorZ_err(struct LDKMonitorUpdateError e);
10356 * Frees any resources used by the CResult_NoneMonitorUpdateErrorZ.
10358 void CResult_NoneMonitorUpdateErrorZ_free(struct LDKCResult_NoneMonitorUpdateErrorZ _res);
10361 * Creates a new CResult_NoneMonitorUpdateErrorZ which has the same data as `orig`
10362 * but with all dynamically-allocated buffers duplicated in new buffers.
10364 struct LDKCResult_NoneMonitorUpdateErrorZ CResult_NoneMonitorUpdateErrorZ_clone(const struct LDKCResult_NoneMonitorUpdateErrorZ *NONNULL_PTR orig);
10367 * Creates a new tuple which has the same data as `orig`
10368 * but with all dynamically-allocated buffers duplicated in new buffers.
10370 struct LDKC2Tuple_OutPointScriptZ C2Tuple_OutPointScriptZ_clone(const struct LDKC2Tuple_OutPointScriptZ *NONNULL_PTR orig);
10373 * Creates a new C2Tuple_OutPointScriptZ from the contained elements.
10375 struct LDKC2Tuple_OutPointScriptZ C2Tuple_OutPointScriptZ_new(struct LDKOutPoint a, struct LDKCVec_u8Z b);
10378 * Frees any resources used by the C2Tuple_OutPointScriptZ.
10380 void C2Tuple_OutPointScriptZ_free(struct LDKC2Tuple_OutPointScriptZ _res);
10383 * Creates a new tuple which has the same data as `orig`
10384 * but with all dynamically-allocated buffers duplicated in new buffers.
10386 struct LDKC2Tuple_u32ScriptZ C2Tuple_u32ScriptZ_clone(const struct LDKC2Tuple_u32ScriptZ *NONNULL_PTR orig);
10389 * Creates a new C2Tuple_u32ScriptZ from the contained elements.
10391 struct LDKC2Tuple_u32ScriptZ C2Tuple_u32ScriptZ_new(uint32_t a, struct LDKCVec_u8Z b);
10394 * Frees any resources used by the C2Tuple_u32ScriptZ.
10396 void C2Tuple_u32ScriptZ_free(struct LDKC2Tuple_u32ScriptZ _res);
10399 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10401 void CVec_C2Tuple_u32ScriptZZ_free(struct LDKCVec_C2Tuple_u32ScriptZZ _res);
10404 * Creates a new tuple which has the same data as `orig`
10405 * but with all dynamically-allocated buffers duplicated in new buffers.
10407 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_clone(const struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ *NONNULL_PTR orig);
10410 * Creates a new C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ from the contained elements.
10412 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_new(struct LDKThirtyTwoBytes a, struct LDKCVec_C2Tuple_u32ScriptZZ b);
10415 * Frees any resources used by the C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ.
10417 void C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_free(struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ _res);
10420 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10422 void CVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ_free(struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ _res);
10425 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10427 void CVec_EventZ_free(struct LDKCVec_EventZ _res);
10430 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10432 void CVec_TransactionZ_free(struct LDKCVec_TransactionZ _res);
10435 * Creates a new tuple which has the same data as `orig`
10436 * but with all dynamically-allocated buffers duplicated in new buffers.
10438 struct LDKC2Tuple_u32TxOutZ C2Tuple_u32TxOutZ_clone(const struct LDKC2Tuple_u32TxOutZ *NONNULL_PTR orig);
10441 * Creates a new C2Tuple_u32TxOutZ from the contained elements.
10443 struct LDKC2Tuple_u32TxOutZ C2Tuple_u32TxOutZ_new(uint32_t a, struct LDKTxOut b);
10446 * Frees any resources used by the C2Tuple_u32TxOutZ.
10448 void C2Tuple_u32TxOutZ_free(struct LDKC2Tuple_u32TxOutZ _res);
10451 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10453 void CVec_C2Tuple_u32TxOutZZ_free(struct LDKCVec_C2Tuple_u32TxOutZZ _res);
10456 * Creates a new tuple which has the same data as `orig`
10457 * but with all dynamically-allocated buffers duplicated in new buffers.
10459 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_clone(const struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ *NONNULL_PTR orig);
10462 * Creates a new C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ from the contained elements.
10464 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_new(struct LDKThirtyTwoBytes a, struct LDKCVec_C2Tuple_u32TxOutZZ b);
10467 * Frees any resources used by the C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ.
10469 void C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_free(struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ _res);
10472 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10474 void CVec_TransactionOutputsZ_free(struct LDKCVec_TransactionOutputsZ _res);
10477 * Creates a new CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ in the success state.
10479 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_ok(struct LDKC2Tuple_BlockHashChannelMonitorZ o);
10482 * Creates a new CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ in the error state.
10484 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_err(struct LDKDecodeError e);
10487 * Frees any resources used by the CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.
10489 void CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_free(struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ _res);
10492 * Creates a new CResult_boolLightningErrorZ in the success state.
10494 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_ok(bool o);
10497 * Creates a new CResult_boolLightningErrorZ in the error state.
10499 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_err(struct LDKLightningError e);
10502 * Frees any resources used by the CResult_boolLightningErrorZ.
10504 void CResult_boolLightningErrorZ_free(struct LDKCResult_boolLightningErrorZ _res);
10507 * Creates a new CResult_boolLightningErrorZ which has the same data as `orig`
10508 * but with all dynamically-allocated buffers duplicated in new buffers.
10510 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_clone(const struct LDKCResult_boolLightningErrorZ *NONNULL_PTR orig);
10513 * Creates a new tuple which has the same data as `orig`
10514 * but with all dynamically-allocated buffers duplicated in new buffers.
10516 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_clone(const struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ *NONNULL_PTR orig);
10519 * Creates a new C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ from the contained elements.
10521 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_new(struct LDKChannelAnnouncement a, struct LDKChannelUpdate b, struct LDKChannelUpdate c);
10524 * Frees any resources used by the C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ.
10526 void C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_free(struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ _res);
10529 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10531 void CVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ_free(struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ _res);
10534 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10536 void CVec_NodeAnnouncementZ_free(struct LDKCVec_NodeAnnouncementZ _res);
10539 * Creates a new CResult_NoneLightningErrorZ in the success state.
10541 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_ok(void);
10544 * Creates a new CResult_NoneLightningErrorZ in the error state.
10546 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_err(struct LDKLightningError e);
10549 * Frees any resources used by the CResult_NoneLightningErrorZ.
10551 void CResult_NoneLightningErrorZ_free(struct LDKCResult_NoneLightningErrorZ _res);
10554 * Creates a new CResult_NoneLightningErrorZ which has the same data as `orig`
10555 * but with all dynamically-allocated buffers duplicated in new buffers.
10557 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_clone(const struct LDKCResult_NoneLightningErrorZ *NONNULL_PTR orig);
10560 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10562 void CVec_PublicKeyZ_free(struct LDKCVec_PublicKeyZ _res);
10565 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ in the success state.
10567 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_ok(struct LDKCVec_u8Z o);
10570 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ in the error state.
10572 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_err(struct LDKPeerHandleError e);
10575 * Frees any resources used by the CResult_CVec_u8ZPeerHandleErrorZ.
10577 void CResult_CVec_u8ZPeerHandleErrorZ_free(struct LDKCResult_CVec_u8ZPeerHandleErrorZ _res);
10580 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ which has the same data as `orig`
10581 * but with all dynamically-allocated buffers duplicated in new buffers.
10583 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_clone(const struct LDKCResult_CVec_u8ZPeerHandleErrorZ *NONNULL_PTR orig);
10586 * Creates a new CResult_NonePeerHandleErrorZ in the success state.
10588 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_ok(void);
10591 * Creates a new CResult_NonePeerHandleErrorZ in the error state.
10593 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_err(struct LDKPeerHandleError e);
10596 * Frees any resources used by the CResult_NonePeerHandleErrorZ.
10598 void CResult_NonePeerHandleErrorZ_free(struct LDKCResult_NonePeerHandleErrorZ _res);
10601 * Creates a new CResult_NonePeerHandleErrorZ which has the same data as `orig`
10602 * but with all dynamically-allocated buffers duplicated in new buffers.
10604 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_clone(const struct LDKCResult_NonePeerHandleErrorZ *NONNULL_PTR orig);
10607 * Creates a new CResult_boolPeerHandleErrorZ in the success state.
10609 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_ok(bool o);
10612 * Creates a new CResult_boolPeerHandleErrorZ in the error state.
10614 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_err(struct LDKPeerHandleError e);
10617 * Frees any resources used by the CResult_boolPeerHandleErrorZ.
10619 void CResult_boolPeerHandleErrorZ_free(struct LDKCResult_boolPeerHandleErrorZ _res);
10622 * Creates a new CResult_boolPeerHandleErrorZ which has the same data as `orig`
10623 * but with all dynamically-allocated buffers duplicated in new buffers.
10625 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_clone(const struct LDKCResult_boolPeerHandleErrorZ *NONNULL_PTR orig);
10628 * Creates a new CResult_DirectionalChannelInfoDecodeErrorZ in the success state.
10630 struct LDKCResult_DirectionalChannelInfoDecodeErrorZ CResult_DirectionalChannelInfoDecodeErrorZ_ok(struct LDKDirectionalChannelInfo o);
10633 * Creates a new CResult_DirectionalChannelInfoDecodeErrorZ in the error state.
10635 struct LDKCResult_DirectionalChannelInfoDecodeErrorZ CResult_DirectionalChannelInfoDecodeErrorZ_err(struct LDKDecodeError e);
10638 * Frees any resources used by the CResult_DirectionalChannelInfoDecodeErrorZ.
10640 void CResult_DirectionalChannelInfoDecodeErrorZ_free(struct LDKCResult_DirectionalChannelInfoDecodeErrorZ _res);
10643 * Creates a new CResult_DirectionalChannelInfoDecodeErrorZ which has the same data as `orig`
10644 * but with all dynamically-allocated buffers duplicated in new buffers.
10646 struct LDKCResult_DirectionalChannelInfoDecodeErrorZ CResult_DirectionalChannelInfoDecodeErrorZ_clone(const struct LDKCResult_DirectionalChannelInfoDecodeErrorZ *NONNULL_PTR orig);
10649 * Creates a new CResult_ChannelInfoDecodeErrorZ in the success state.
10651 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_ok(struct LDKChannelInfo o);
10654 * Creates a new CResult_ChannelInfoDecodeErrorZ in the error state.
10656 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_err(struct LDKDecodeError e);
10659 * Frees any resources used by the CResult_ChannelInfoDecodeErrorZ.
10661 void CResult_ChannelInfoDecodeErrorZ_free(struct LDKCResult_ChannelInfoDecodeErrorZ _res);
10664 * Creates a new CResult_ChannelInfoDecodeErrorZ which has the same data as `orig`
10665 * but with all dynamically-allocated buffers duplicated in new buffers.
10667 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_clone(const struct LDKCResult_ChannelInfoDecodeErrorZ *NONNULL_PTR orig);
10670 * Creates a new CResult_RoutingFeesDecodeErrorZ in the success state.
10672 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_ok(struct LDKRoutingFees o);
10675 * Creates a new CResult_RoutingFeesDecodeErrorZ in the error state.
10677 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_err(struct LDKDecodeError e);
10680 * Frees any resources used by the CResult_RoutingFeesDecodeErrorZ.
10682 void CResult_RoutingFeesDecodeErrorZ_free(struct LDKCResult_RoutingFeesDecodeErrorZ _res);
10685 * Creates a new CResult_RoutingFeesDecodeErrorZ which has the same data as `orig`
10686 * but with all dynamically-allocated buffers duplicated in new buffers.
10688 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_clone(const struct LDKCResult_RoutingFeesDecodeErrorZ *NONNULL_PTR orig);
10691 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ in the success state.
10693 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_ok(struct LDKNodeAnnouncementInfo o);
10696 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ in the error state.
10698 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_err(struct LDKDecodeError e);
10701 * Frees any resources used by the CResult_NodeAnnouncementInfoDecodeErrorZ.
10703 void CResult_NodeAnnouncementInfoDecodeErrorZ_free(struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ _res);
10706 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ which has the same data as `orig`
10707 * but with all dynamically-allocated buffers duplicated in new buffers.
10709 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_clone(const struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ *NONNULL_PTR orig);
10712 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10714 void CVec_u64Z_free(struct LDKCVec_u64Z _res);
10717 * Creates a new CResult_NodeInfoDecodeErrorZ in the success state.
10719 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_ok(struct LDKNodeInfo o);
10722 * Creates a new CResult_NodeInfoDecodeErrorZ in the error state.
10724 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_err(struct LDKDecodeError e);
10727 * Frees any resources used by the CResult_NodeInfoDecodeErrorZ.
10729 void CResult_NodeInfoDecodeErrorZ_free(struct LDKCResult_NodeInfoDecodeErrorZ _res);
10732 * Creates a new CResult_NodeInfoDecodeErrorZ which has the same data as `orig`
10733 * but with all dynamically-allocated buffers duplicated in new buffers.
10735 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_clone(const struct LDKCResult_NodeInfoDecodeErrorZ *NONNULL_PTR orig);
10738 * Creates a new CResult_NetworkGraphDecodeErrorZ in the success state.
10740 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_ok(struct LDKNetworkGraph o);
10743 * Creates a new CResult_NetworkGraphDecodeErrorZ in the error state.
10745 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_err(struct LDKDecodeError e);
10748 * Frees any resources used by the CResult_NetworkGraphDecodeErrorZ.
10750 void CResult_NetworkGraphDecodeErrorZ_free(struct LDKCResult_NetworkGraphDecodeErrorZ _res);
10753 * Creates a new CResult_NetworkGraphDecodeErrorZ which has the same data as `orig`
10754 * but with all dynamically-allocated buffers duplicated in new buffers.
10756 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_clone(const struct LDKCResult_NetworkGraphDecodeErrorZ *NONNULL_PTR orig);
10759 * Creates a new CResult_NetAddressu8Z in the success state.
10761 struct LDKCResult_NetAddressu8Z CResult_NetAddressu8Z_ok(struct LDKNetAddress o);
10764 * Creates a new CResult_NetAddressu8Z in the error state.
10766 struct LDKCResult_NetAddressu8Z CResult_NetAddressu8Z_err(uint8_t e);
10769 * Frees any resources used by the CResult_NetAddressu8Z.
10771 void CResult_NetAddressu8Z_free(struct LDKCResult_NetAddressu8Z _res);
10774 * Creates a new CResult_NetAddressu8Z which has the same data as `orig`
10775 * but with all dynamically-allocated buffers duplicated in new buffers.
10777 struct LDKCResult_NetAddressu8Z CResult_NetAddressu8Z_clone(const struct LDKCResult_NetAddressu8Z *NONNULL_PTR orig);
10780 * Creates a new CResult_CResult_NetAddressu8ZDecodeErrorZ in the success state.
10782 struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ CResult_CResult_NetAddressu8ZDecodeErrorZ_ok(struct LDKCResult_NetAddressu8Z o);
10785 * Creates a new CResult_CResult_NetAddressu8ZDecodeErrorZ in the error state.
10787 struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ CResult_CResult_NetAddressu8ZDecodeErrorZ_err(struct LDKDecodeError e);
10790 * Frees any resources used by the CResult_CResult_NetAddressu8ZDecodeErrorZ.
10792 void CResult_CResult_NetAddressu8ZDecodeErrorZ_free(struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ _res);
10795 * Creates a new CResult_CResult_NetAddressu8ZDecodeErrorZ which has the same data as `orig`
10796 * but with all dynamically-allocated buffers duplicated in new buffers.
10798 struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ CResult_CResult_NetAddressu8ZDecodeErrorZ_clone(const struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ *NONNULL_PTR orig);
10801 * Creates a new CResult_NetAddressDecodeErrorZ in the success state.
10803 struct LDKCResult_NetAddressDecodeErrorZ CResult_NetAddressDecodeErrorZ_ok(struct LDKNetAddress o);
10806 * Creates a new CResult_NetAddressDecodeErrorZ in the error state.
10808 struct LDKCResult_NetAddressDecodeErrorZ CResult_NetAddressDecodeErrorZ_err(struct LDKDecodeError e);
10811 * Frees any resources used by the CResult_NetAddressDecodeErrorZ.
10813 void CResult_NetAddressDecodeErrorZ_free(struct LDKCResult_NetAddressDecodeErrorZ _res);
10816 * Creates a new CResult_NetAddressDecodeErrorZ which has the same data as `orig`
10817 * but with all dynamically-allocated buffers duplicated in new buffers.
10819 struct LDKCResult_NetAddressDecodeErrorZ CResult_NetAddressDecodeErrorZ_clone(const struct LDKCResult_NetAddressDecodeErrorZ *NONNULL_PTR orig);
10822 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10824 void CVec_UpdateAddHTLCZ_free(struct LDKCVec_UpdateAddHTLCZ _res);
10827 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10829 void CVec_UpdateFulfillHTLCZ_free(struct LDKCVec_UpdateFulfillHTLCZ _res);
10832 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10834 void CVec_UpdateFailHTLCZ_free(struct LDKCVec_UpdateFailHTLCZ _res);
10837 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10839 void CVec_UpdateFailMalformedHTLCZ_free(struct LDKCVec_UpdateFailMalformedHTLCZ _res);
10842 * Creates a new CResult_AcceptChannelDecodeErrorZ in the success state.
10844 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_ok(struct LDKAcceptChannel o);
10847 * Creates a new CResult_AcceptChannelDecodeErrorZ in the error state.
10849 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_err(struct LDKDecodeError e);
10852 * Frees any resources used by the CResult_AcceptChannelDecodeErrorZ.
10854 void CResult_AcceptChannelDecodeErrorZ_free(struct LDKCResult_AcceptChannelDecodeErrorZ _res);
10857 * Creates a new CResult_AcceptChannelDecodeErrorZ which has the same data as `orig`
10858 * but with all dynamically-allocated buffers duplicated in new buffers.
10860 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_clone(const struct LDKCResult_AcceptChannelDecodeErrorZ *NONNULL_PTR orig);
10863 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ in the success state.
10865 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_ok(struct LDKAnnouncementSignatures o);
10868 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ in the error state.
10870 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_err(struct LDKDecodeError e);
10873 * Frees any resources used by the CResult_AnnouncementSignaturesDecodeErrorZ.
10875 void CResult_AnnouncementSignaturesDecodeErrorZ_free(struct LDKCResult_AnnouncementSignaturesDecodeErrorZ _res);
10878 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ which has the same data as `orig`
10879 * but with all dynamically-allocated buffers duplicated in new buffers.
10881 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_clone(const struct LDKCResult_AnnouncementSignaturesDecodeErrorZ *NONNULL_PTR orig);
10884 * Creates a new CResult_ChannelReestablishDecodeErrorZ in the success state.
10886 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_ok(struct LDKChannelReestablish o);
10889 * Creates a new CResult_ChannelReestablishDecodeErrorZ in the error state.
10891 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_err(struct LDKDecodeError e);
10894 * Frees any resources used by the CResult_ChannelReestablishDecodeErrorZ.
10896 void CResult_ChannelReestablishDecodeErrorZ_free(struct LDKCResult_ChannelReestablishDecodeErrorZ _res);
10899 * Creates a new CResult_ChannelReestablishDecodeErrorZ which has the same data as `orig`
10900 * but with all dynamically-allocated buffers duplicated in new buffers.
10902 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_clone(const struct LDKCResult_ChannelReestablishDecodeErrorZ *NONNULL_PTR orig);
10905 * Creates a new CResult_ClosingSignedDecodeErrorZ in the success state.
10907 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_ok(struct LDKClosingSigned o);
10910 * Creates a new CResult_ClosingSignedDecodeErrorZ in the error state.
10912 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_err(struct LDKDecodeError e);
10915 * Frees any resources used by the CResult_ClosingSignedDecodeErrorZ.
10917 void CResult_ClosingSignedDecodeErrorZ_free(struct LDKCResult_ClosingSignedDecodeErrorZ _res);
10920 * Creates a new CResult_ClosingSignedDecodeErrorZ which has the same data as `orig`
10921 * but with all dynamically-allocated buffers duplicated in new buffers.
10923 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_clone(const struct LDKCResult_ClosingSignedDecodeErrorZ *NONNULL_PTR orig);
10926 * Creates a new CResult_CommitmentSignedDecodeErrorZ in the success state.
10928 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_ok(struct LDKCommitmentSigned o);
10931 * Creates a new CResult_CommitmentSignedDecodeErrorZ in the error state.
10933 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_err(struct LDKDecodeError e);
10936 * Frees any resources used by the CResult_CommitmentSignedDecodeErrorZ.
10938 void CResult_CommitmentSignedDecodeErrorZ_free(struct LDKCResult_CommitmentSignedDecodeErrorZ _res);
10941 * Creates a new CResult_CommitmentSignedDecodeErrorZ which has the same data as `orig`
10942 * but with all dynamically-allocated buffers duplicated in new buffers.
10944 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_clone(const struct LDKCResult_CommitmentSignedDecodeErrorZ *NONNULL_PTR orig);
10947 * Creates a new CResult_FundingCreatedDecodeErrorZ in the success state.
10949 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_ok(struct LDKFundingCreated o);
10952 * Creates a new CResult_FundingCreatedDecodeErrorZ in the error state.
10954 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_err(struct LDKDecodeError e);
10957 * Frees any resources used by the CResult_FundingCreatedDecodeErrorZ.
10959 void CResult_FundingCreatedDecodeErrorZ_free(struct LDKCResult_FundingCreatedDecodeErrorZ _res);
10962 * Creates a new CResult_FundingCreatedDecodeErrorZ which has the same data as `orig`
10963 * but with all dynamically-allocated buffers duplicated in new buffers.
10965 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_clone(const struct LDKCResult_FundingCreatedDecodeErrorZ *NONNULL_PTR orig);
10968 * Creates a new CResult_FundingSignedDecodeErrorZ in the success state.
10970 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_ok(struct LDKFundingSigned o);
10973 * Creates a new CResult_FundingSignedDecodeErrorZ in the error state.
10975 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_err(struct LDKDecodeError e);
10978 * Frees any resources used by the CResult_FundingSignedDecodeErrorZ.
10980 void CResult_FundingSignedDecodeErrorZ_free(struct LDKCResult_FundingSignedDecodeErrorZ _res);
10983 * Creates a new CResult_FundingSignedDecodeErrorZ which has the same data as `orig`
10984 * but with all dynamically-allocated buffers duplicated in new buffers.
10986 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_clone(const struct LDKCResult_FundingSignedDecodeErrorZ *NONNULL_PTR orig);
10989 * Creates a new CResult_FundingLockedDecodeErrorZ in the success state.
10991 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_ok(struct LDKFundingLocked o);
10994 * Creates a new CResult_FundingLockedDecodeErrorZ in the error state.
10996 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_err(struct LDKDecodeError e);
10999 * Frees any resources used by the CResult_FundingLockedDecodeErrorZ.
11001 void CResult_FundingLockedDecodeErrorZ_free(struct LDKCResult_FundingLockedDecodeErrorZ _res);
11004 * Creates a new CResult_FundingLockedDecodeErrorZ which has the same data as `orig`
11005 * but with all dynamically-allocated buffers duplicated in new buffers.
11007 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_clone(const struct LDKCResult_FundingLockedDecodeErrorZ *NONNULL_PTR orig);
11010 * Creates a new CResult_InitDecodeErrorZ in the success state.
11012 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_ok(struct LDKInit o);
11015 * Creates a new CResult_InitDecodeErrorZ in the error state.
11017 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_err(struct LDKDecodeError e);
11020 * Frees any resources used by the CResult_InitDecodeErrorZ.
11022 void CResult_InitDecodeErrorZ_free(struct LDKCResult_InitDecodeErrorZ _res);
11025 * Creates a new CResult_InitDecodeErrorZ which has the same data as `orig`
11026 * but with all dynamically-allocated buffers duplicated in new buffers.
11028 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_clone(const struct LDKCResult_InitDecodeErrorZ *NONNULL_PTR orig);
11031 * Creates a new CResult_OpenChannelDecodeErrorZ in the success state.
11033 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_ok(struct LDKOpenChannel o);
11036 * Creates a new CResult_OpenChannelDecodeErrorZ in the error state.
11038 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_err(struct LDKDecodeError e);
11041 * Frees any resources used by the CResult_OpenChannelDecodeErrorZ.
11043 void CResult_OpenChannelDecodeErrorZ_free(struct LDKCResult_OpenChannelDecodeErrorZ _res);
11046 * Creates a new CResult_OpenChannelDecodeErrorZ which has the same data as `orig`
11047 * but with all dynamically-allocated buffers duplicated in new buffers.
11049 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_clone(const struct LDKCResult_OpenChannelDecodeErrorZ *NONNULL_PTR orig);
11052 * Creates a new CResult_RevokeAndACKDecodeErrorZ in the success state.
11054 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_ok(struct LDKRevokeAndACK o);
11057 * Creates a new CResult_RevokeAndACKDecodeErrorZ in the error state.
11059 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_err(struct LDKDecodeError e);
11062 * Frees any resources used by the CResult_RevokeAndACKDecodeErrorZ.
11064 void CResult_RevokeAndACKDecodeErrorZ_free(struct LDKCResult_RevokeAndACKDecodeErrorZ _res);
11067 * Creates a new CResult_RevokeAndACKDecodeErrorZ which has the same data as `orig`
11068 * but with all dynamically-allocated buffers duplicated in new buffers.
11070 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_clone(const struct LDKCResult_RevokeAndACKDecodeErrorZ *NONNULL_PTR orig);
11073 * Creates a new CResult_ShutdownDecodeErrorZ in the success state.
11075 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_ok(struct LDKShutdown o);
11078 * Creates a new CResult_ShutdownDecodeErrorZ in the error state.
11080 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_err(struct LDKDecodeError e);
11083 * Frees any resources used by the CResult_ShutdownDecodeErrorZ.
11085 void CResult_ShutdownDecodeErrorZ_free(struct LDKCResult_ShutdownDecodeErrorZ _res);
11088 * Creates a new CResult_ShutdownDecodeErrorZ which has the same data as `orig`
11089 * but with all dynamically-allocated buffers duplicated in new buffers.
11091 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_clone(const struct LDKCResult_ShutdownDecodeErrorZ *NONNULL_PTR orig);
11094 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ in the success state.
11096 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_ok(struct LDKUpdateFailHTLC o);
11099 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ in the error state.
11101 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_err(struct LDKDecodeError e);
11104 * Frees any resources used by the CResult_UpdateFailHTLCDecodeErrorZ.
11106 void CResult_UpdateFailHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFailHTLCDecodeErrorZ _res);
11109 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ which has the same data as `orig`
11110 * but with all dynamically-allocated buffers duplicated in new buffers.
11112 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFailHTLCDecodeErrorZ *NONNULL_PTR orig);
11115 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ in the success state.
11117 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_ok(struct LDKUpdateFailMalformedHTLC o);
11120 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ in the error state.
11122 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_err(struct LDKDecodeError e);
11125 * Frees any resources used by the CResult_UpdateFailMalformedHTLCDecodeErrorZ.
11127 void CResult_UpdateFailMalformedHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ _res);
11130 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ which has the same data as `orig`
11131 * but with all dynamically-allocated buffers duplicated in new buffers.
11133 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ *NONNULL_PTR orig);
11136 * Creates a new CResult_UpdateFeeDecodeErrorZ in the success state.
11138 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_ok(struct LDKUpdateFee o);
11141 * Creates a new CResult_UpdateFeeDecodeErrorZ in the error state.
11143 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_err(struct LDKDecodeError e);
11146 * Frees any resources used by the CResult_UpdateFeeDecodeErrorZ.
11148 void CResult_UpdateFeeDecodeErrorZ_free(struct LDKCResult_UpdateFeeDecodeErrorZ _res);
11151 * Creates a new CResult_UpdateFeeDecodeErrorZ which has the same data as `orig`
11152 * but with all dynamically-allocated buffers duplicated in new buffers.
11154 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_clone(const struct LDKCResult_UpdateFeeDecodeErrorZ *NONNULL_PTR orig);
11157 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ in the success state.
11159 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_ok(struct LDKUpdateFulfillHTLC o);
11162 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ in the error state.
11164 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_err(struct LDKDecodeError e);
11167 * Frees any resources used by the CResult_UpdateFulfillHTLCDecodeErrorZ.
11169 void CResult_UpdateFulfillHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ _res);
11172 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ which has the same data as `orig`
11173 * but with all dynamically-allocated buffers duplicated in new buffers.
11175 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ *NONNULL_PTR orig);
11178 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ in the success state.
11180 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_ok(struct LDKUpdateAddHTLC o);
11183 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ in the error state.
11185 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_err(struct LDKDecodeError e);
11188 * Frees any resources used by the CResult_UpdateAddHTLCDecodeErrorZ.
11190 void CResult_UpdateAddHTLCDecodeErrorZ_free(struct LDKCResult_UpdateAddHTLCDecodeErrorZ _res);
11193 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ which has the same data as `orig`
11194 * but with all dynamically-allocated buffers duplicated in new buffers.
11196 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateAddHTLCDecodeErrorZ *NONNULL_PTR orig);
11199 * Creates a new CResult_PingDecodeErrorZ in the success state.
11201 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_ok(struct LDKPing o);
11204 * Creates a new CResult_PingDecodeErrorZ in the error state.
11206 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_err(struct LDKDecodeError e);
11209 * Frees any resources used by the CResult_PingDecodeErrorZ.
11211 void CResult_PingDecodeErrorZ_free(struct LDKCResult_PingDecodeErrorZ _res);
11214 * Creates a new CResult_PingDecodeErrorZ which has the same data as `orig`
11215 * but with all dynamically-allocated buffers duplicated in new buffers.
11217 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_clone(const struct LDKCResult_PingDecodeErrorZ *NONNULL_PTR orig);
11220 * Creates a new CResult_PongDecodeErrorZ in the success state.
11222 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_ok(struct LDKPong o);
11225 * Creates a new CResult_PongDecodeErrorZ in the error state.
11227 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_err(struct LDKDecodeError e);
11230 * Frees any resources used by the CResult_PongDecodeErrorZ.
11232 void CResult_PongDecodeErrorZ_free(struct LDKCResult_PongDecodeErrorZ _res);
11235 * Creates a new CResult_PongDecodeErrorZ which has the same data as `orig`
11236 * but with all dynamically-allocated buffers duplicated in new buffers.
11238 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_clone(const struct LDKCResult_PongDecodeErrorZ *NONNULL_PTR orig);
11241 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ in the success state.
11243 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_ok(struct LDKUnsignedChannelAnnouncement o);
11246 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ in the error state.
11248 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
11251 * Frees any resources used by the CResult_UnsignedChannelAnnouncementDecodeErrorZ.
11253 void CResult_UnsignedChannelAnnouncementDecodeErrorZ_free(struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ _res);
11256 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ which has the same data as `orig`
11257 * but with all dynamically-allocated buffers duplicated in new buffers.
11259 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_clone(const struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ *NONNULL_PTR orig);
11262 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ in the success state.
11264 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_ok(struct LDKChannelAnnouncement o);
11267 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ in the error state.
11269 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
11272 * Frees any resources used by the CResult_ChannelAnnouncementDecodeErrorZ.
11274 void CResult_ChannelAnnouncementDecodeErrorZ_free(struct LDKCResult_ChannelAnnouncementDecodeErrorZ _res);
11277 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ which has the same data as `orig`
11278 * but with all dynamically-allocated buffers duplicated in new buffers.
11280 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_clone(const struct LDKCResult_ChannelAnnouncementDecodeErrorZ *NONNULL_PTR orig);
11283 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ in the success state.
11285 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_ok(struct LDKUnsignedChannelUpdate o);
11288 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ in the error state.
11290 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_err(struct LDKDecodeError e);
11293 * Frees any resources used by the CResult_UnsignedChannelUpdateDecodeErrorZ.
11295 void CResult_UnsignedChannelUpdateDecodeErrorZ_free(struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ _res);
11298 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ which has the same data as `orig`
11299 * but with all dynamically-allocated buffers duplicated in new buffers.
11301 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_clone(const struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ *NONNULL_PTR orig);
11304 * Creates a new CResult_ChannelUpdateDecodeErrorZ in the success state.
11306 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_ok(struct LDKChannelUpdate o);
11309 * Creates a new CResult_ChannelUpdateDecodeErrorZ in the error state.
11311 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_err(struct LDKDecodeError e);
11314 * Frees any resources used by the CResult_ChannelUpdateDecodeErrorZ.
11316 void CResult_ChannelUpdateDecodeErrorZ_free(struct LDKCResult_ChannelUpdateDecodeErrorZ _res);
11319 * Creates a new CResult_ChannelUpdateDecodeErrorZ which has the same data as `orig`
11320 * but with all dynamically-allocated buffers duplicated in new buffers.
11322 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_clone(const struct LDKCResult_ChannelUpdateDecodeErrorZ *NONNULL_PTR orig);
11325 * Creates a new CResult_ErrorMessageDecodeErrorZ in the success state.
11327 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_ok(struct LDKErrorMessage o);
11330 * Creates a new CResult_ErrorMessageDecodeErrorZ in the error state.
11332 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_err(struct LDKDecodeError e);
11335 * Frees any resources used by the CResult_ErrorMessageDecodeErrorZ.
11337 void CResult_ErrorMessageDecodeErrorZ_free(struct LDKCResult_ErrorMessageDecodeErrorZ _res);
11340 * Creates a new CResult_ErrorMessageDecodeErrorZ which has the same data as `orig`
11341 * but with all dynamically-allocated buffers duplicated in new buffers.
11343 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_clone(const struct LDKCResult_ErrorMessageDecodeErrorZ *NONNULL_PTR orig);
11346 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ in the success state.
11348 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_ok(struct LDKUnsignedNodeAnnouncement o);
11351 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ in the error state.
11353 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
11356 * Frees any resources used by the CResult_UnsignedNodeAnnouncementDecodeErrorZ.
11358 void CResult_UnsignedNodeAnnouncementDecodeErrorZ_free(struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ _res);
11361 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ which has the same data as `orig`
11362 * but with all dynamically-allocated buffers duplicated in new buffers.
11364 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_clone(const struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ *NONNULL_PTR orig);
11367 * Creates a new CResult_NodeAnnouncementDecodeErrorZ in the success state.
11369 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_ok(struct LDKNodeAnnouncement o);
11372 * Creates a new CResult_NodeAnnouncementDecodeErrorZ in the error state.
11374 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
11377 * Frees any resources used by the CResult_NodeAnnouncementDecodeErrorZ.
11379 void CResult_NodeAnnouncementDecodeErrorZ_free(struct LDKCResult_NodeAnnouncementDecodeErrorZ _res);
11382 * Creates a new CResult_NodeAnnouncementDecodeErrorZ which has the same data as `orig`
11383 * but with all dynamically-allocated buffers duplicated in new buffers.
11385 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_clone(const struct LDKCResult_NodeAnnouncementDecodeErrorZ *NONNULL_PTR orig);
11388 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ in the success state.
11390 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_ok(struct LDKQueryShortChannelIds o);
11393 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ in the error state.
11395 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_err(struct LDKDecodeError e);
11398 * Frees any resources used by the CResult_QueryShortChannelIdsDecodeErrorZ.
11400 void CResult_QueryShortChannelIdsDecodeErrorZ_free(struct LDKCResult_QueryShortChannelIdsDecodeErrorZ _res);
11403 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ which has the same data as `orig`
11404 * but with all dynamically-allocated buffers duplicated in new buffers.
11406 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_clone(const struct LDKCResult_QueryShortChannelIdsDecodeErrorZ *NONNULL_PTR orig);
11409 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ in the success state.
11411 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_ok(struct LDKReplyShortChannelIdsEnd o);
11414 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ in the error state.
11416 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_err(struct LDKDecodeError e);
11419 * Frees any resources used by the CResult_ReplyShortChannelIdsEndDecodeErrorZ.
11421 void CResult_ReplyShortChannelIdsEndDecodeErrorZ_free(struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ _res);
11424 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ which has the same data as `orig`
11425 * but with all dynamically-allocated buffers duplicated in new buffers.
11427 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_clone(const struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ *NONNULL_PTR orig);
11430 * Creates a new CResult_QueryChannelRangeDecodeErrorZ in the success state.
11432 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_ok(struct LDKQueryChannelRange o);
11435 * Creates a new CResult_QueryChannelRangeDecodeErrorZ in the error state.
11437 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_err(struct LDKDecodeError e);
11440 * Frees any resources used by the CResult_QueryChannelRangeDecodeErrorZ.
11442 void CResult_QueryChannelRangeDecodeErrorZ_free(struct LDKCResult_QueryChannelRangeDecodeErrorZ _res);
11445 * Creates a new CResult_QueryChannelRangeDecodeErrorZ which has the same data as `orig`
11446 * but with all dynamically-allocated buffers duplicated in new buffers.
11448 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_clone(const struct LDKCResult_QueryChannelRangeDecodeErrorZ *NONNULL_PTR orig);
11451 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ in the success state.
11453 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_ok(struct LDKReplyChannelRange o);
11456 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ in the error state.
11458 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_err(struct LDKDecodeError e);
11461 * Frees any resources used by the CResult_ReplyChannelRangeDecodeErrorZ.
11463 void CResult_ReplyChannelRangeDecodeErrorZ_free(struct LDKCResult_ReplyChannelRangeDecodeErrorZ _res);
11466 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ which has the same data as `orig`
11467 * but with all dynamically-allocated buffers duplicated in new buffers.
11469 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_clone(const struct LDKCResult_ReplyChannelRangeDecodeErrorZ *NONNULL_PTR orig);
11472 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ in the success state.
11474 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_ok(struct LDKGossipTimestampFilter o);
11477 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ in the error state.
11479 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_err(struct LDKDecodeError e);
11482 * Frees any resources used by the CResult_GossipTimestampFilterDecodeErrorZ.
11484 void CResult_GossipTimestampFilterDecodeErrorZ_free(struct LDKCResult_GossipTimestampFilterDecodeErrorZ _res);
11487 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ which has the same data as `orig`
11488 * but with all dynamically-allocated buffers duplicated in new buffers.
11490 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_clone(const struct LDKCResult_GossipTimestampFilterDecodeErrorZ *NONNULL_PTR orig);
11493 * Creates a new CResult_InvoiceSignOrCreationErrorZ in the success state.
11495 struct LDKCResult_InvoiceSignOrCreationErrorZ CResult_InvoiceSignOrCreationErrorZ_ok(struct LDKInvoice o);
11498 * Creates a new CResult_InvoiceSignOrCreationErrorZ in the error state.
11500 struct LDKCResult_InvoiceSignOrCreationErrorZ CResult_InvoiceSignOrCreationErrorZ_err(struct LDKSignOrCreationError e);
11503 * Frees any resources used by the CResult_InvoiceSignOrCreationErrorZ.
11505 void CResult_InvoiceSignOrCreationErrorZ_free(struct LDKCResult_InvoiceSignOrCreationErrorZ _res);
11508 * Creates a new CResult_InvoiceSignOrCreationErrorZ which has the same data as `orig`
11509 * but with all dynamically-allocated buffers duplicated in new buffers.
11511 struct LDKCResult_InvoiceSignOrCreationErrorZ CResult_InvoiceSignOrCreationErrorZ_clone(const struct LDKCResult_InvoiceSignOrCreationErrorZ *NONNULL_PTR orig);
11514 * Frees any resources used by the Event
11516 void Event_free(struct LDKEvent this_ptr);
11519 * Creates a copy of the Event
11521 struct LDKEvent Event_clone(const struct LDKEvent *NONNULL_PTR orig);
11524 * Serialize the Event object into a byte array which can be read by Event_read
11526 struct LDKCVec_u8Z Event_write(const struct LDKEvent *NONNULL_PTR obj);
11529 * Frees any resources used by the MessageSendEvent
11531 void MessageSendEvent_free(struct LDKMessageSendEvent this_ptr);
11534 * Creates a copy of the MessageSendEvent
11536 struct LDKMessageSendEvent MessageSendEvent_clone(const struct LDKMessageSendEvent *NONNULL_PTR orig);
11539 * Calls the free function if one is set
11541 void MessageSendEventsProvider_free(struct LDKMessageSendEventsProvider this_ptr);
11544 * Calls the free function if one is set
11546 void EventsProvider_free(struct LDKEventsProvider this_ptr);
11549 * Calls the free function if one is set
11551 void EventHandler_free(struct LDKEventHandler this_ptr);
11554 * Frees any resources used by the APIError
11556 void APIError_free(struct LDKAPIError this_ptr);
11559 * Creates a copy of the APIError
11561 struct LDKAPIError APIError_clone(const struct LDKAPIError *NONNULL_PTR orig);
11564 * Creates a digital signature of a message given a SecretKey, like the node's secret.
11565 * 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.
11566 * Signatures are EC recoverable, meaning that given the message and the signature the PublicKey of the signer can be extracted.
11568 struct LDKCResult_StringErrorZ sign(struct LDKu8slice msg, struct LDKSecretKey sk);
11571 * Recovers the PublicKey of the signer of the message given the message and the signature.
11573 struct LDKCResult_PublicKeyErrorZ recover_pk(struct LDKu8slice msg, struct LDKStr sig);
11576 * Verifies a message was signed by a PrivateKey that derives to a given PublicKey, given a message, a signature,
11577 * and the PublicKey.
11579 bool verify(struct LDKu8slice msg, struct LDKStr sig, struct LDKPublicKey pk);
11582 * Creates a copy of the Level
11584 enum LDKLevel Level_clone(const enum LDKLevel *NONNULL_PTR orig);
11587 * Checks if two Levels contain equal inner contents.
11588 * This ignores pointers and is_owned flags and looks at the values in fields.
11590 bool Level_eq(const enum LDKLevel *NONNULL_PTR a, const enum LDKLevel *NONNULL_PTR b);
11593 * Checks if two Levels contain equal inner contents.
11595 uint64_t Level_hash(const enum LDKLevel *NONNULL_PTR o);
11598 * Returns the most verbose logging level.
11600 MUST_USE_RES enum LDKLevel Level_max(void);
11603 * Calls the free function if one is set
11605 void Logger_free(struct LDKLogger this_ptr);
11608 * Frees any resources used by the ChannelHandshakeConfig, if is_owned is set and inner is non-NULL.
11610 void ChannelHandshakeConfig_free(struct LDKChannelHandshakeConfig this_obj);
11613 * Confirmations we will wait for before considering the channel locked in.
11614 * Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
11615 * equivalent limit applied to outbound channels).
11617 * Default value: 6.
11619 uint32_t ChannelHandshakeConfig_get_minimum_depth(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
11622 * Confirmations we will wait for before considering the channel locked in.
11623 * Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
11624 * equivalent limit applied to outbound channels).
11626 * Default value: 6.
11628 void ChannelHandshakeConfig_set_minimum_depth(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint32_t val);
11631 * Set to the number of blocks we require our counterparty to wait to claim their money (ie
11632 * the number of blocks we have to punish our counterparty if they broadcast a revoked
11635 * This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
11636 * be online to check for revoked transactions on-chain at least once every our_to_self_delay
11637 * blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
11638 * possibly with time in between to RBF the spending transaction).
11640 * Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
11641 * case of an honest unilateral channel close, which implicitly decrease the economic value of
11644 * Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
11645 * can tweak config to ask for more security, not less.
11647 uint16_t ChannelHandshakeConfig_get_our_to_self_delay(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
11650 * Set to the number of blocks we require our counterparty to wait to claim their money (ie
11651 * the number of blocks we have to punish our counterparty if they broadcast a revoked
11654 * This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
11655 * be online to check for revoked transactions on-chain at least once every our_to_self_delay
11656 * blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
11657 * possibly with time in between to RBF the spending transaction).
11659 * Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
11660 * case of an honest unilateral channel close, which implicitly decrease the economic value of
11663 * Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
11664 * can tweak config to ask for more security, not less.
11666 void ChannelHandshakeConfig_set_our_to_self_delay(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint16_t val);
11669 * Set to the smallest value HTLC we will accept to process.
11671 * This value is sent to our counterparty on channel-open and we close the channel any time
11672 * our counterparty misbehaves by sending us an HTLC with a value smaller than this.
11674 * Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
11677 uint64_t ChannelHandshakeConfig_get_our_htlc_minimum_msat(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
11680 * Set to the smallest value HTLC we will accept to process.
11682 * This value is sent to our counterparty on channel-open and we close the channel any time
11683 * our counterparty misbehaves by sending us an HTLC with a value smaller than this.
11685 * Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
11688 void ChannelHandshakeConfig_set_our_htlc_minimum_msat(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint64_t val);
11691 * Constructs a new ChannelHandshakeConfig given each field
11693 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);
11696 * Creates a copy of the ChannelHandshakeConfig
11698 struct LDKChannelHandshakeConfig ChannelHandshakeConfig_clone(const struct LDKChannelHandshakeConfig *NONNULL_PTR orig);
11701 * Creates a "default" ChannelHandshakeConfig. See struct and individual field documentaiton for details on which values are used.
11703 MUST_USE_RES struct LDKChannelHandshakeConfig ChannelHandshakeConfig_default(void);
11706 * Frees any resources used by the ChannelHandshakeLimits, if is_owned is set and inner is non-NULL.
11708 void ChannelHandshakeLimits_free(struct LDKChannelHandshakeLimits this_obj);
11711 * Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
11712 * only applies to inbound channels.
11714 * Default value: 0.
11716 uint64_t ChannelHandshakeLimits_get_min_funding_satoshis(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
11719 * Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
11720 * only applies to inbound channels.
11722 * Default value: 0.
11724 void ChannelHandshakeLimits_set_min_funding_satoshis(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
11727 * The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
11728 * you to limit the maximum minimum-size they can require.
11730 * Default value: u64::max_value.
11732 uint64_t ChannelHandshakeLimits_get_max_htlc_minimum_msat(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
11735 * The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
11736 * you to limit the maximum minimum-size they can require.
11738 * Default value: u64::max_value.
11740 void ChannelHandshakeLimits_set_max_htlc_minimum_msat(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
11743 * The remote node sets a limit on the maximum value of pending HTLCs to them at any given
11744 * time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
11746 * Default value: 0.
11748 uint64_t ChannelHandshakeLimits_get_min_max_htlc_value_in_flight_msat(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
11751 * The remote node sets a limit on the maximum value of pending HTLCs to them at any given
11752 * time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
11754 * Default value: 0.
11756 void ChannelHandshakeLimits_set_min_max_htlc_value_in_flight_msat(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
11759 * The remote node will require we keep a certain amount in direct payment to ourselves at all
11760 * time, ensuring that we are able to be punished if we broadcast an old state. This allows to
11761 * you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
11763 * Default value: u64::max_value.
11765 uint64_t ChannelHandshakeLimits_get_max_channel_reserve_satoshis(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
11768 * The remote node will require we keep a certain amount in direct payment to ourselves at all
11769 * time, ensuring that we are able to be punished if we broadcast an old state. This allows to
11770 * you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
11772 * Default value: u64::max_value.
11774 void ChannelHandshakeLimits_set_max_channel_reserve_satoshis(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
11777 * The remote node sets a limit on the maximum number of pending HTLCs to them at any given
11778 * time. This allows you to set a minimum such value.
11780 * Default value: 0.
11782 uint16_t ChannelHandshakeLimits_get_min_max_accepted_htlcs(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
11785 * The remote node sets a limit on the maximum number of pending HTLCs to them at any given
11786 * time. This allows you to set a minimum such value.
11788 * Default value: 0.
11790 void ChannelHandshakeLimits_set_min_max_accepted_htlcs(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint16_t val);
11793 * Before a channel is usable the funding transaction will need to be confirmed by at least a
11794 * certain number of blocks, specified by the node which is not the funder (as the funder can
11795 * assume they aren't going to double-spend themselves).
11796 * This config allows you to set a limit on the maximum amount of time to wait.
11798 * Default value: 144, or roughly one day and only applies to outbound channels.
11800 uint32_t ChannelHandshakeLimits_get_max_minimum_depth(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
11803 * Before a channel is usable the funding transaction will need to be confirmed by at least a
11804 * certain number of blocks, specified by the node which is not the funder (as the funder can
11805 * assume they aren't going to double-spend themselves).
11806 * This config allows you to set a limit on the maximum amount of time to wait.
11808 * Default value: 144, or roughly one day and only applies to outbound channels.
11810 void ChannelHandshakeLimits_set_max_minimum_depth(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint32_t val);
11813 * Set to force the incoming channel to match our announced channel preference in
11816 * Default value: true, to make the default that no announced channels are possible (which is
11817 * appropriate for any nodes which are not online very reliably).
11819 bool ChannelHandshakeLimits_get_force_announced_channel_preference(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
11822 * Set to force the incoming channel to match our announced channel preference in
11825 * Default value: true, to make the default that no announced channels are possible (which is
11826 * appropriate for any nodes which are not online very reliably).
11828 void ChannelHandshakeLimits_set_force_announced_channel_preference(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, bool val);
11831 * Set to the amount of time we're willing to wait to claim money back to us.
11833 * Not checking this value would be a security issue, as our peer would be able to set it to
11834 * max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
11836 * Default value: 2016, which we also enforce as a maximum value so you can tweak config to
11837 * reduce the loss of having useless locked funds (if your peer accepts)
11839 uint16_t ChannelHandshakeLimits_get_their_to_self_delay(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
11842 * Set to the amount of time we're willing to wait to claim money back to us.
11844 * Not checking this value would be a security issue, as our peer would be able to set it to
11845 * max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
11847 * Default value: 2016, which we also enforce as a maximum value so you can tweak config to
11848 * reduce the loss of having useless locked funds (if your peer accepts)
11850 void ChannelHandshakeLimits_set_their_to_self_delay(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint16_t val);
11853 * Constructs a new ChannelHandshakeLimits given each field
11855 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);
11858 * Creates a copy of the ChannelHandshakeLimits
11860 struct LDKChannelHandshakeLimits ChannelHandshakeLimits_clone(const struct LDKChannelHandshakeLimits *NONNULL_PTR orig);
11863 * Creates a "default" ChannelHandshakeLimits. See struct and individual field documentaiton for details on which values are used.
11865 MUST_USE_RES struct LDKChannelHandshakeLimits ChannelHandshakeLimits_default(void);
11868 * Frees any resources used by the ChannelConfig, if is_owned is set and inner is non-NULL.
11870 void ChannelConfig_free(struct LDKChannelConfig this_obj);
11873 * Amount (in millionths of a satoshi) the channel will charge per transferred satoshi.
11874 * This may be allowed to change at runtime in a later update, however doing so must result in
11875 * update messages sent to notify all nodes of our updated relay fee.
11877 * Default value: 0.
11879 uint32_t ChannelConfig_get_fee_proportional_millionths(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
11882 * Amount (in millionths of a satoshi) the channel will charge per transferred satoshi.
11883 * This may be allowed to change at runtime in a later update, however doing so must result in
11884 * update messages sent to notify all nodes of our updated relay fee.
11886 * Default value: 0.
11888 void ChannelConfig_set_fee_proportional_millionths(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint32_t val);
11891 * The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
11892 * the channel this config applies to.
11894 * This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
11895 * HTLC balance when a channel appears on-chain whereas
11896 * [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
11897 * (non-HTLC-encumbered) balance.
11899 * Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
11900 * we (or one of our watchtowers) MUST be online to check for broadcast of the current
11901 * commitment transaction at least once per this many blocks (minus some margin to allow us
11902 * enough time to broadcast and confirm a transaction, possibly with time in between to RBF
11903 * the spending transaction).
11905 * Default value: 72 (12 hours at an average of 6 blocks/hour).
11906 * Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
11907 * [`MIN_CLTV_EXPIRY_DELTA`] instead.
11909 * [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
11911 uint16_t ChannelConfig_get_cltv_expiry_delta(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
11914 * The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
11915 * the channel this config applies to.
11917 * This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
11918 * HTLC balance when a channel appears on-chain whereas
11919 * [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
11920 * (non-HTLC-encumbered) balance.
11922 * Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
11923 * we (or one of our watchtowers) MUST be online to check for broadcast of the current
11924 * commitment transaction at least once per this many blocks (minus some margin to allow us
11925 * enough time to broadcast and confirm a transaction, possibly with time in between to RBF
11926 * the spending transaction).
11928 * Default value: 72 (12 hours at an average of 6 blocks/hour).
11929 * Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
11930 * [`MIN_CLTV_EXPIRY_DELTA`] instead.
11932 * [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
11934 void ChannelConfig_set_cltv_expiry_delta(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint16_t val);
11937 * Set to announce the channel publicly and notify all nodes that they can route via this
11940 * This should only be set to true for nodes which expect to be online reliably.
11942 * As the node which funds a channel picks this value this will only apply for new outbound
11943 * channels unless ChannelHandshakeLimits::force_announced_channel_preferences is set.
11945 * This cannot be changed after the initial channel handshake.
11947 * Default value: false.
11949 bool ChannelConfig_get_announced_channel(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
11952 * Set to announce the channel publicly and notify all nodes that they can route via this
11955 * This should only be set to true for nodes which expect to be online reliably.
11957 * As the node which funds a channel picks this value this will only apply for new outbound
11958 * channels unless ChannelHandshakeLimits::force_announced_channel_preferences is set.
11960 * This cannot be changed after the initial channel handshake.
11962 * Default value: false.
11964 void ChannelConfig_set_announced_channel(struct LDKChannelConfig *NONNULL_PTR this_ptr, bool val);
11967 * When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
11968 * supports it, they will then enforce the mutual-close output to us matches what we provided
11969 * at intialization, preventing us from closing to an alternate pubkey.
11971 * This is set to true by default to provide a slight increase in security, though ultimately
11972 * any attacker who is able to take control of a channel can just as easily send the funds via
11973 * lightning payments, so we never require that our counterparties support this option.
11975 * This cannot be changed after a channel has been initialized.
11977 * Default value: true.
11979 bool ChannelConfig_get_commit_upfront_shutdown_pubkey(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
11982 * When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
11983 * supports it, they will then enforce the mutual-close output to us matches what we provided
11984 * at intialization, preventing us from closing to an alternate pubkey.
11986 * This is set to true by default to provide a slight increase in security, though ultimately
11987 * any attacker who is able to take control of a channel can just as easily send the funds via
11988 * lightning payments, so we never require that our counterparties support this option.
11990 * This cannot be changed after a channel has been initialized.
11992 * Default value: true.
11994 void ChannelConfig_set_commit_upfront_shutdown_pubkey(struct LDKChannelConfig *NONNULL_PTR this_ptr, bool val);
11997 * Constructs a new ChannelConfig given each field
11999 MUST_USE_RES struct LDKChannelConfig ChannelConfig_new(uint32_t fee_proportional_millionths_arg, uint16_t cltv_expiry_delta_arg, bool announced_channel_arg, bool commit_upfront_shutdown_pubkey_arg);
12002 * Creates a copy of the ChannelConfig
12004 struct LDKChannelConfig ChannelConfig_clone(const struct LDKChannelConfig *NONNULL_PTR orig);
12007 * Creates a "default" ChannelConfig. See struct and individual field documentaiton for details on which values are used.
12009 MUST_USE_RES struct LDKChannelConfig ChannelConfig_default(void);
12012 * Serialize the ChannelConfig object into a byte array which can be read by ChannelConfig_read
12014 struct LDKCVec_u8Z ChannelConfig_write(const struct LDKChannelConfig *NONNULL_PTR obj);
12017 * Read a ChannelConfig from a byte array, created by ChannelConfig_write
12019 struct LDKCResult_ChannelConfigDecodeErrorZ ChannelConfig_read(struct LDKu8slice ser);
12022 * Frees any resources used by the UserConfig, if is_owned is set and inner is non-NULL.
12024 void UserConfig_free(struct LDKUserConfig this_obj);
12027 * Channel config that we propose to our counterparty.
12029 struct LDKChannelHandshakeConfig UserConfig_get_own_channel_config(const struct LDKUserConfig *NONNULL_PTR this_ptr);
12032 * Channel config that we propose to our counterparty.
12034 void UserConfig_set_own_channel_config(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelHandshakeConfig val);
12037 * Limits applied to our counterparty's proposed channel config settings.
12039 struct LDKChannelHandshakeLimits UserConfig_get_peer_channel_config_limits(const struct LDKUserConfig *NONNULL_PTR this_ptr);
12042 * Limits applied to our counterparty's proposed channel config settings.
12044 void UserConfig_set_peer_channel_config_limits(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelHandshakeLimits val);
12047 * Channel config which affects behavior during channel lifetime.
12049 struct LDKChannelConfig UserConfig_get_channel_options(const struct LDKUserConfig *NONNULL_PTR this_ptr);
12052 * Channel config which affects behavior during channel lifetime.
12054 void UserConfig_set_channel_options(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelConfig val);
12057 * Constructs a new UserConfig given each field
12059 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);
12062 * Creates a copy of the UserConfig
12064 struct LDKUserConfig UserConfig_clone(const struct LDKUserConfig *NONNULL_PTR orig);
12067 * Creates a "default" UserConfig. See struct and individual field documentaiton for details on which values are used.
12069 MUST_USE_RES struct LDKUserConfig UserConfig_default(void);
12072 * Creates a copy of the AccessError
12074 enum LDKAccessError AccessError_clone(const enum LDKAccessError *NONNULL_PTR orig);
12077 * Calls the free function if one is set
12079 void Access_free(struct LDKAccess this_ptr);
12082 * Calls the free function if one is set
12084 void Listen_free(struct LDKListen this_ptr);
12087 * Calls the free function if one is set
12089 void Confirm_free(struct LDKConfirm this_ptr);
12092 * Calls the free function if one is set
12094 void Watch_free(struct LDKWatch this_ptr);
12097 * Calls the free function if one is set
12099 void Filter_free(struct LDKFilter this_ptr);
12102 * Frees any resources used by the WatchedOutput, if is_owned is set and inner is non-NULL.
12104 void WatchedOutput_free(struct LDKWatchedOutput this_obj);
12107 * First block where the transaction output may have been spent.
12109 struct LDKThirtyTwoBytes WatchedOutput_get_block_hash(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
12112 * First block where the transaction output may have been spent.
12114 void WatchedOutput_set_block_hash(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12117 * Outpoint identifying the transaction output.
12119 struct LDKOutPoint WatchedOutput_get_outpoint(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
12122 * Outpoint identifying the transaction output.
12124 void WatchedOutput_set_outpoint(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKOutPoint val);
12127 * Spending condition of the transaction output.
12129 struct LDKu8slice WatchedOutput_get_script_pubkey(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
12132 * Spending condition of the transaction output.
12134 void WatchedOutput_set_script_pubkey(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
12137 * Constructs a new WatchedOutput given each field
12139 MUST_USE_RES struct LDKWatchedOutput WatchedOutput_new(struct LDKThirtyTwoBytes block_hash_arg, struct LDKOutPoint outpoint_arg, struct LDKCVec_u8Z script_pubkey_arg);
12142 * Calls the free function if one is set
12144 void BroadcasterInterface_free(struct LDKBroadcasterInterface this_ptr);
12147 * Creates a copy of the ConfirmationTarget
12149 enum LDKConfirmationTarget ConfirmationTarget_clone(const enum LDKConfirmationTarget *NONNULL_PTR orig);
12152 * Calls the free function if one is set
12154 void FeeEstimator_free(struct LDKFeeEstimator this_ptr);
12157 * Frees any resources used by the ChainMonitor, if is_owned is set and inner is non-NULL.
12159 void ChainMonitor_free(struct LDKChainMonitor this_obj);
12162 * Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
12164 * When an optional chain source implementing [`chain::Filter`] is provided, the chain monitor
12165 * will call back to it indicating transactions and outputs of interest. This allows clients to
12166 * pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may
12167 * always need to fetch full blocks absent another means for determining which blocks contain
12168 * transactions relevant to the watched channels.
12170 MUST_USE_RES struct LDKChainMonitor ChainMonitor_new(struct LDKFilter *chain_source, struct LDKBroadcasterInterface broadcaster, struct LDKLogger logger, struct LDKFeeEstimator feeest, struct LDKPersist persister);
12173 * Constructs a new Listen which calls the relevant methods on this_arg.
12174 * This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
12176 struct LDKListen ChainMonitor_as_Listen(const struct LDKChainMonitor *NONNULL_PTR this_arg);
12179 * Constructs a new Confirm which calls the relevant methods on this_arg.
12180 * This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
12182 struct LDKConfirm ChainMonitor_as_Confirm(const struct LDKChainMonitor *NONNULL_PTR this_arg);
12185 * Constructs a new Watch which calls the relevant methods on this_arg.
12186 * This copies the `inner` pointer in this_arg and thus the returned Watch must be freed before this_arg is
12188 struct LDKWatch ChainMonitor_as_Watch(const struct LDKChainMonitor *NONNULL_PTR this_arg);
12191 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
12192 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
12194 struct LDKEventsProvider ChainMonitor_as_EventsProvider(const struct LDKChainMonitor *NONNULL_PTR this_arg);
12197 * Frees any resources used by the ChannelMonitorUpdate, if is_owned is set and inner is non-NULL.
12199 void ChannelMonitorUpdate_free(struct LDKChannelMonitorUpdate this_obj);
12202 * The sequence number of this update. Updates *must* be replayed in-order according to this
12203 * sequence number (and updates may panic if they are not). The update_id values are strictly
12204 * increasing and increase by one for each new update, with one exception specified below.
12206 * This sequence number is also used to track up to which points updates which returned
12207 * ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
12208 * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
12210 * The only instance where update_id values are not strictly increasing is the case where we
12211 * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
12212 * its docs for more details.
12214 uint64_t ChannelMonitorUpdate_get_update_id(const struct LDKChannelMonitorUpdate *NONNULL_PTR this_ptr);
12217 * The sequence number of this update. Updates *must* be replayed in-order according to this
12218 * sequence number (and updates may panic if they are not). The update_id values are strictly
12219 * increasing and increase by one for each new update, with one exception specified below.
12221 * This sequence number is also used to track up to which points updates which returned
12222 * ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
12223 * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
12225 * The only instance where update_id values are not strictly increasing is the case where we
12226 * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
12227 * its docs for more details.
12229 void ChannelMonitorUpdate_set_update_id(struct LDKChannelMonitorUpdate *NONNULL_PTR this_ptr, uint64_t val);
12232 * Creates a copy of the ChannelMonitorUpdate
12234 struct LDKChannelMonitorUpdate ChannelMonitorUpdate_clone(const struct LDKChannelMonitorUpdate *NONNULL_PTR orig);
12237 * Serialize the ChannelMonitorUpdate object into a byte array which can be read by ChannelMonitorUpdate_read
12239 struct LDKCVec_u8Z ChannelMonitorUpdate_write(const struct LDKChannelMonitorUpdate *NONNULL_PTR obj);
12242 * Read a ChannelMonitorUpdate from a byte array, created by ChannelMonitorUpdate_write
12244 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ ChannelMonitorUpdate_read(struct LDKu8slice ser);
12247 * Creates a copy of the ChannelMonitorUpdateErr
12249 enum LDKChannelMonitorUpdateErr ChannelMonitorUpdateErr_clone(const enum LDKChannelMonitorUpdateErr *NONNULL_PTR orig);
12252 * Frees any resources used by the MonitorUpdateError, if is_owned is set and inner is non-NULL.
12254 void MonitorUpdateError_free(struct LDKMonitorUpdateError this_obj);
12257 * Creates a copy of the MonitorUpdateError
12259 struct LDKMonitorUpdateError MonitorUpdateError_clone(const struct LDKMonitorUpdateError *NONNULL_PTR orig);
12262 * Frees any resources used by the MonitorEvent
12264 void MonitorEvent_free(struct LDKMonitorEvent this_ptr);
12267 * Creates a copy of the MonitorEvent
12269 struct LDKMonitorEvent MonitorEvent_clone(const struct LDKMonitorEvent *NONNULL_PTR orig);
12272 * Frees any resources used by the HTLCUpdate, if is_owned is set and inner is non-NULL.
12274 void HTLCUpdate_free(struct LDKHTLCUpdate this_obj);
12277 * Creates a copy of the HTLCUpdate
12279 struct LDKHTLCUpdate HTLCUpdate_clone(const struct LDKHTLCUpdate *NONNULL_PTR orig);
12282 * Serialize the HTLCUpdate object into a byte array which can be read by HTLCUpdate_read
12284 struct LDKCVec_u8Z HTLCUpdate_write(const struct LDKHTLCUpdate *NONNULL_PTR obj);
12287 * Read a HTLCUpdate from a byte array, created by HTLCUpdate_write
12289 struct LDKCResult_HTLCUpdateDecodeErrorZ HTLCUpdate_read(struct LDKu8slice ser);
12292 * Frees any resources used by the ChannelMonitor, if is_owned is set and inner is non-NULL.
12294 void ChannelMonitor_free(struct LDKChannelMonitor this_obj);
12297 * Serialize the ChannelMonitor object into a byte array which can be read by ChannelMonitor_read
12299 struct LDKCVec_u8Z ChannelMonitor_write(const struct LDKChannelMonitor *NONNULL_PTR obj);
12302 * Updates a ChannelMonitor on the basis of some new information provided by the Channel
12305 * panics if the given update is not the next update by update_id.
12307 MUST_USE_RES struct LDKCResult_NoneMonitorUpdateErrorZ 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);
12310 * Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
12313 MUST_USE_RES uint64_t ChannelMonitor_get_latest_update_id(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
12316 * Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
12318 MUST_USE_RES struct LDKC2Tuple_OutPointScriptZ ChannelMonitor_get_funding_txo(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
12321 * Gets a list of txids, with their output scripts (in the order they appear in the
12322 * transaction), which we must learn about spends of via block_connected().
12324 MUST_USE_RES struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ ChannelMonitor_get_outputs_to_watch(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
12327 * Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
12328 * calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
12329 * have been registered.
12331 void ChannelMonitor_load_outputs_to_watch(const struct LDKChannelMonitor *NONNULL_PTR this_arg, const struct LDKFilter *NONNULL_PTR filter);
12334 * Get the list of HTLCs who's status has been updated on chain. This should be called by
12335 * ChannelManager via [`chain::Watch::release_pending_monitor_events`].
12337 MUST_USE_RES struct LDKCVec_MonitorEventZ ChannelMonitor_get_and_clear_pending_monitor_events(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
12340 * Gets the list of pending events which were generated by previous actions, clearing the list
12343 * This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
12344 * EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
12345 * no internal locking in ChannelMonitors.
12347 MUST_USE_RES struct LDKCVec_EventZ ChannelMonitor_get_and_clear_pending_events(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
12350 * Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
12351 * the Channel was out-of-date. You may use it to get a broadcastable holder toxic tx in case of
12352 * fallen-behind, i.e when receiving a channel_reestablish with a proof that our counterparty side knows
12353 * a higher revocation secret than the holder commitment number we are aware of. Broadcasting these
12354 * transactions are UNSAFE, as they allow counterparty side to punish you. Nevertheless you may want to
12355 * broadcast them if counterparty don't close channel with his higher commitment transaction after a
12356 * substantial amount of time (a month or even a year) to get back funds. Best may be to contact
12357 * out-of-band the other node operator to coordinate with him if option is available to you.
12358 * In any-case, choice is up to the user.
12360 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);
12363 * Processes transactions in a newly connected block, which may result in any of the following:
12364 * - update the monitor's state against resolved HTLCs
12365 * - punish the counterparty in the case of seeing a revoked commitment transaction
12366 * - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
12367 * - detect settled outputs for later spending
12368 * - schedule and bump any in-flight claims
12370 * Returns any new outputs to watch from `txdata`; after called, these are also included in
12371 * [`get_outputs_to_watch`].
12373 * [`get_outputs_to_watch`]: #method.get_outputs_to_watch
12375 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);
12378 * Determines if the disconnected block contained any transactions of interest and updates
12381 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);
12384 * Processes transactions confirmed in a block with the given header and height, returning new
12385 * outputs to watch. See [`block_connected`] for details.
12387 * Used instead of [`block_connected`] by clients that are notified of transactions rather than
12388 * blocks. See [`chain::Confirm`] for calling expectations.
12390 * [`block_connected`]: Self::block_connected
12392 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);
12395 * Processes a transaction that was reorganized out of the chain.
12397 * Used instead of [`block_disconnected`] by clients that are notified of transactions rather
12398 * than blocks. See [`chain::Confirm`] for calling expectations.
12400 * [`block_disconnected`]: Self::block_disconnected
12402 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);
12405 * Updates the monitor with the current best chain tip, returning new outputs to watch. See
12406 * [`block_connected`] for details.
12408 * Used instead of [`block_connected`] by clients that are notified of transactions rather than
12409 * blocks. See [`chain::Confirm`] for calling expectations.
12411 * [`block_connected`]: Self::block_connected
12413 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);
12416 * Returns the set of txids that should be monitored for re-organization out of the chain.
12418 MUST_USE_RES struct LDKCVec_TxidZ ChannelMonitor_get_relevant_txids(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
12421 * Calls the free function if one is set
12423 void Persist_free(struct LDKPersist this_ptr);
12426 * Read a C2Tuple_BlockHashChannelMonitorZ from a byte array, created by C2Tuple_BlockHashChannelMonitorZ_write
12428 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ C2Tuple_BlockHashChannelMonitorZ_read(struct LDKu8slice ser, const struct LDKKeysInterface *NONNULL_PTR arg);
12431 * Frees any resources used by the OutPoint, if is_owned is set and inner is non-NULL.
12433 void OutPoint_free(struct LDKOutPoint this_obj);
12436 * The referenced transaction's txid.
12438 const uint8_t (*OutPoint_get_txid(const struct LDKOutPoint *NONNULL_PTR this_ptr))[32];
12441 * The referenced transaction's txid.
12443 void OutPoint_set_txid(struct LDKOutPoint *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12446 * The index of the referenced output in its transaction's vout.
12448 uint16_t OutPoint_get_index(const struct LDKOutPoint *NONNULL_PTR this_ptr);
12451 * The index of the referenced output in its transaction's vout.
12453 void OutPoint_set_index(struct LDKOutPoint *NONNULL_PTR this_ptr, uint16_t val);
12456 * Constructs a new OutPoint given each field
12458 MUST_USE_RES struct LDKOutPoint OutPoint_new(struct LDKThirtyTwoBytes txid_arg, uint16_t index_arg);
12461 * Creates a copy of the OutPoint
12463 struct LDKOutPoint OutPoint_clone(const struct LDKOutPoint *NONNULL_PTR orig);
12466 * Checks if two OutPoints contain equal inner contents.
12467 * This ignores pointers and is_owned flags and looks at the values in fields.
12468 * Two objects with NULL inner values will be considered "equal" here.
12470 bool OutPoint_eq(const struct LDKOutPoint *NONNULL_PTR a, const struct LDKOutPoint *NONNULL_PTR b);
12473 * Checks if two OutPoints contain equal inner contents.
12475 uint64_t OutPoint_hash(const struct LDKOutPoint *NONNULL_PTR o);
12478 * Convert an `OutPoint` to a lightning channel id.
12480 MUST_USE_RES struct LDKThirtyTwoBytes OutPoint_to_channel_id(const struct LDKOutPoint *NONNULL_PTR this_arg);
12483 * Serialize the OutPoint object into a byte array which can be read by OutPoint_read
12485 struct LDKCVec_u8Z OutPoint_write(const struct LDKOutPoint *NONNULL_PTR obj);
12488 * Read a OutPoint from a byte array, created by OutPoint_write
12490 struct LDKCResult_OutPointDecodeErrorZ OutPoint_read(struct LDKu8slice ser);
12493 * Frees any resources used by the DelayedPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
12495 void DelayedPaymentOutputDescriptor_free(struct LDKDelayedPaymentOutputDescriptor this_obj);
12498 * The outpoint which is spendable
12500 struct LDKOutPoint DelayedPaymentOutputDescriptor_get_outpoint(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
12503 * The outpoint which is spendable
12505 void DelayedPaymentOutputDescriptor_set_outpoint(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKOutPoint val);
12508 * Per commitment point to derive delayed_payment_key by key holder
12510 struct LDKPublicKey DelayedPaymentOutputDescriptor_get_per_commitment_point(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
12513 * Per commitment point to derive delayed_payment_key by key holder
12515 void DelayedPaymentOutputDescriptor_set_per_commitment_point(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKPublicKey val);
12518 * The nSequence value which must be set in the spending input to satisfy the OP_CSV in
12519 * the witness_script.
12521 uint16_t DelayedPaymentOutputDescriptor_get_to_self_delay(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
12524 * The nSequence value which must be set in the spending input to satisfy the OP_CSV in
12525 * the witness_script.
12527 void DelayedPaymentOutputDescriptor_set_to_self_delay(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint16_t val);
12530 * The output which is referenced by the given outpoint
12532 void DelayedPaymentOutputDescriptor_set_output(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKTxOut val);
12535 * The revocation point specific to the commitment transaction which was broadcast. Used to
12536 * derive the witnessScript for this output.
12538 struct LDKPublicKey DelayedPaymentOutputDescriptor_get_revocation_pubkey(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
12541 * The revocation point specific to the commitment transaction which was broadcast. Used to
12542 * derive the witnessScript for this output.
12544 void DelayedPaymentOutputDescriptor_set_revocation_pubkey(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKPublicKey val);
12547 * Arbitrary identification information returned by a call to
12548 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
12549 * the channel to spend the output.
12551 const uint8_t (*DelayedPaymentOutputDescriptor_get_channel_keys_id(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr))[32];
12554 * Arbitrary identification information returned by a call to
12555 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
12556 * the channel to spend the output.
12558 void DelayedPaymentOutputDescriptor_set_channel_keys_id(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12561 * The value of the channel which this output originated from, possibly indirectly.
12563 uint64_t DelayedPaymentOutputDescriptor_get_channel_value_satoshis(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
12566 * The value of the channel which this output originated from, possibly indirectly.
12568 void DelayedPaymentOutputDescriptor_set_channel_value_satoshis(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint64_t val);
12571 * Constructs a new DelayedPaymentOutputDescriptor given each field
12573 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);
12576 * Creates a copy of the DelayedPaymentOutputDescriptor
12578 struct LDKDelayedPaymentOutputDescriptor DelayedPaymentOutputDescriptor_clone(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR orig);
12581 * Serialize the DelayedPaymentOutputDescriptor object into a byte array which can be read by DelayedPaymentOutputDescriptor_read
12583 struct LDKCVec_u8Z DelayedPaymentOutputDescriptor_write(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR obj);
12586 * Read a DelayedPaymentOutputDescriptor from a byte array, created by DelayedPaymentOutputDescriptor_write
12588 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ DelayedPaymentOutputDescriptor_read(struct LDKu8slice ser);
12591 * Frees any resources used by the StaticPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
12593 void StaticPaymentOutputDescriptor_free(struct LDKStaticPaymentOutputDescriptor this_obj);
12596 * The outpoint which is spendable
12598 struct LDKOutPoint StaticPaymentOutputDescriptor_get_outpoint(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr);
12601 * The outpoint which is spendable
12603 void StaticPaymentOutputDescriptor_set_outpoint(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKOutPoint val);
12606 * The output which is referenced by the given outpoint
12608 void StaticPaymentOutputDescriptor_set_output(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKTxOut val);
12611 * Arbitrary identification information returned by a call to
12612 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
12613 * the channel to spend the output.
12615 const uint8_t (*StaticPaymentOutputDescriptor_get_channel_keys_id(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr))[32];
12618 * Arbitrary identification information returned by a call to
12619 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
12620 * the channel to spend the output.
12622 void StaticPaymentOutputDescriptor_set_channel_keys_id(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12625 * The value of the channel which this transactions spends.
12627 uint64_t StaticPaymentOutputDescriptor_get_channel_value_satoshis(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr);
12630 * The value of the channel which this transactions spends.
12632 void StaticPaymentOutputDescriptor_set_channel_value_satoshis(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint64_t val);
12635 * Constructs a new StaticPaymentOutputDescriptor given each field
12637 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);
12640 * Creates a copy of the StaticPaymentOutputDescriptor
12642 struct LDKStaticPaymentOutputDescriptor StaticPaymentOutputDescriptor_clone(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR orig);
12645 * Serialize the StaticPaymentOutputDescriptor object into a byte array which can be read by StaticPaymentOutputDescriptor_read
12647 struct LDKCVec_u8Z StaticPaymentOutputDescriptor_write(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR obj);
12650 * Read a StaticPaymentOutputDescriptor from a byte array, created by StaticPaymentOutputDescriptor_write
12652 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ StaticPaymentOutputDescriptor_read(struct LDKu8slice ser);
12655 * Frees any resources used by the SpendableOutputDescriptor
12657 void SpendableOutputDescriptor_free(struct LDKSpendableOutputDescriptor this_ptr);
12660 * Creates a copy of the SpendableOutputDescriptor
12662 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_clone(const struct LDKSpendableOutputDescriptor *NONNULL_PTR orig);
12665 * Serialize the SpendableOutputDescriptor object into a byte array which can be read by SpendableOutputDescriptor_read
12667 struct LDKCVec_u8Z SpendableOutputDescriptor_write(const struct LDKSpendableOutputDescriptor *NONNULL_PTR obj);
12670 * Read a SpendableOutputDescriptor from a byte array, created by SpendableOutputDescriptor_write
12672 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ SpendableOutputDescriptor_read(struct LDKu8slice ser);
12675 * Calls the free function if one is set
12677 void BaseSign_free(struct LDKBaseSign this_ptr);
12680 * Creates a copy of a Sign
12682 struct LDKSign Sign_clone(const struct LDKSign *NONNULL_PTR orig);
12685 * Calls the free function if one is set
12687 void Sign_free(struct LDKSign this_ptr);
12690 * Calls the free function if one is set
12692 void KeysInterface_free(struct LDKKeysInterface this_ptr);
12695 * Frees any resources used by the InMemorySigner, if is_owned is set and inner is non-NULL.
12697 void InMemorySigner_free(struct LDKInMemorySigner this_obj);
12700 * Private key of anchor tx
12702 const uint8_t (*InMemorySigner_get_funding_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
12705 * Private key of anchor tx
12707 void InMemorySigner_set_funding_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
12710 * Holder secret key for blinded revocation pubkey
12712 const uint8_t (*InMemorySigner_get_revocation_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
12715 * Holder secret key for blinded revocation pubkey
12717 void InMemorySigner_set_revocation_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
12720 * Holder secret key used for our balance in counterparty-broadcasted commitment transactions
12722 const uint8_t (*InMemorySigner_get_payment_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
12725 * Holder secret key used for our balance in counterparty-broadcasted commitment transactions
12727 void InMemorySigner_set_payment_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
12730 * Holder secret key used in HTLC tx
12732 const uint8_t (*InMemorySigner_get_delayed_payment_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
12735 * Holder secret key used in HTLC tx
12737 void InMemorySigner_set_delayed_payment_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
12740 * Holder htlc secret key used in commitment tx htlc outputs
12742 const uint8_t (*InMemorySigner_get_htlc_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
12745 * Holder htlc secret key used in commitment tx htlc outputs
12747 void InMemorySigner_set_htlc_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
12752 const uint8_t (*InMemorySigner_get_commitment_seed(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
12757 void InMemorySigner_set_commitment_seed(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
12760 * Creates a copy of the InMemorySigner
12762 struct LDKInMemorySigner InMemorySigner_clone(const struct LDKInMemorySigner *NONNULL_PTR orig);
12765 * Create a new InMemorySigner
12767 MUST_USE_RES struct LDKInMemorySigner InMemorySigner_new(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);
12770 * Counterparty pubkeys.
12771 * Will panic if ready_channel wasn't called.
12773 MUST_USE_RES struct LDKChannelPublicKeys InMemorySigner_counterparty_pubkeys(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
12776 * The contest_delay value specified by our counterparty and applied on holder-broadcastable
12777 * transactions, ie the amount of time that we have to wait to recover our funds if we
12778 * broadcast a transaction.
12779 * Will panic if ready_channel wasn't called.
12781 MUST_USE_RES uint16_t InMemorySigner_counterparty_selected_contest_delay(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
12784 * The contest_delay value specified by us and applied on transactions broadcastable
12785 * by our counterparty, ie the amount of time that they have to wait to recover their funds
12786 * if they broadcast a transaction.
12787 * Will panic if ready_channel wasn't called.
12789 MUST_USE_RES uint16_t InMemorySigner_holder_selected_contest_delay(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
12792 * Whether the holder is the initiator
12793 * Will panic if ready_channel wasn't called.
12795 MUST_USE_RES bool InMemorySigner_is_outbound(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
12799 * Will panic if ready_channel wasn't called.
12801 MUST_USE_RES struct LDKOutPoint InMemorySigner_funding_outpoint(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
12804 * Obtain a ChannelTransactionParameters for this channel, to be used when verifying or
12805 * building transactions.
12807 * Will panic if ready_channel wasn't called.
12809 MUST_USE_RES struct LDKChannelTransactionParameters InMemorySigner_get_channel_parameters(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
12812 * Sign the single input of spend_tx at index `input_idx` which spends the output
12813 * described by descriptor, returning the witness stack for the input.
12815 * Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
12816 * or is not spending the outpoint described by `descriptor.outpoint`.
12818 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);
12821 * Sign the single input of spend_tx at index `input_idx` which spends the output
12822 * described by descriptor, returning the witness stack for the input.
12824 * Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
12825 * is not spending the outpoint described by `descriptor.outpoint`, or does not have a
12826 * sequence set to `descriptor.to_self_delay`.
12828 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);
12831 * Constructs a new BaseSign which calls the relevant methods on this_arg.
12832 * This copies the `inner` pointer in this_arg and thus the returned BaseSign must be freed before this_arg is
12834 struct LDKBaseSign InMemorySigner_as_BaseSign(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
12837 * Constructs a new Sign which calls the relevant methods on this_arg.
12838 * This copies the `inner` pointer in this_arg and thus the returned Sign must be freed before this_arg is
12840 struct LDKSign InMemorySigner_as_Sign(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
12843 * Serialize the InMemorySigner object into a byte array which can be read by InMemorySigner_read
12845 struct LDKCVec_u8Z InMemorySigner_write(const struct LDKInMemorySigner *NONNULL_PTR obj);
12848 * Read a InMemorySigner from a byte array, created by InMemorySigner_write
12850 struct LDKCResult_InMemorySignerDecodeErrorZ InMemorySigner_read(struct LDKu8slice ser);
12853 * Frees any resources used by the KeysManager, if is_owned is set and inner is non-NULL.
12855 void KeysManager_free(struct LDKKeysManager this_obj);
12858 * Constructs a KeysManager from a 32-byte seed. If the seed is in some way biased (eg your
12859 * CSRNG is busted) this may panic (but more importantly, you will possibly lose funds).
12860 * starting_time isn't strictly required to actually be a time, but it must absolutely,
12861 * without a doubt, be unique to this instance. ie if you start multiple times with the same
12862 * seed, starting_time must be unique to each run. Thus, the easiest way to achieve this is to
12863 * simply use the current time (with very high precision).
12865 * The seed MUST be backed up safely prior to use so that the keys can be re-created, however,
12866 * obviously, starting_time should be unique every time you reload the library - it is only
12867 * used to generate new ephemeral key data (which will be stored by the individual channel if
12870 * Note that the seed is required to recover certain on-chain funds independent of
12871 * ChannelMonitor data, though a current copy of ChannelMonitor data is also required for any
12872 * channel, and some on-chain during-closing funds.
12874 * Note that until the 0.1 release there is no guarantee of backward compatibility between
12875 * versions. Once the library is more fully supported, the docs will be updated to include a
12876 * detailed description of the guarantee.
12878 MUST_USE_RES struct LDKKeysManager KeysManager_new(const uint8_t (*seed)[32], uint64_t starting_time_secs, uint32_t starting_time_nanos);
12881 * Derive an old Sign containing per-channel secrets based on a key derivation parameters.
12883 * Key derivation parameters are accessible through a per-channel secrets
12884 * Sign::channel_keys_id and is provided inside DynamicOuputP2WSH in case of
12885 * onchain output detection for which a corresponding delayed_payment_key must be derived.
12887 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]);
12890 * Creates a Transaction which spends the given descriptors to the given outputs, plus an
12891 * output to the given change destination (if sufficient change value remains). The
12892 * transaction will have a feerate, at least, of the given value.
12894 * Returns `Err(())` if the output value is greater than the input value minus required fee or
12895 * if a descriptor was duplicated.
12897 * We do not enforce that outputs meet the dust limit or that any output scripts are standard.
12899 * May panic if the `SpendableOutputDescriptor`s were not generated by Channels which used
12900 * this KeysManager or one of the `InMemorySigner` created by this KeysManager.
12902 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);
12905 * Constructs a new KeysInterface which calls the relevant methods on this_arg.
12906 * This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is
12908 struct LDKKeysInterface KeysManager_as_KeysInterface(const struct LDKKeysManager *NONNULL_PTR this_arg);
12911 * Frees any resources used by the ChannelManager, if is_owned is set and inner is non-NULL.
12913 void ChannelManager_free(struct LDKChannelManager this_obj);
12916 * Frees any resources used by the ChainParameters, if is_owned is set and inner is non-NULL.
12918 void ChainParameters_free(struct LDKChainParameters this_obj);
12921 * The network for determining the `chain_hash` in Lightning messages.
12923 enum LDKNetwork ChainParameters_get_network(const struct LDKChainParameters *NONNULL_PTR this_ptr);
12926 * The network for determining the `chain_hash` in Lightning messages.
12928 void ChainParameters_set_network(struct LDKChainParameters *NONNULL_PTR this_ptr, enum LDKNetwork val);
12931 * The hash and height of the latest block successfully connected.
12933 * Used to track on-chain channel funding outputs and send payments with reliable timelocks.
12935 struct LDKBestBlock ChainParameters_get_best_block(const struct LDKChainParameters *NONNULL_PTR this_ptr);
12938 * The hash and height of the latest block successfully connected.
12940 * Used to track on-chain channel funding outputs and send payments with reliable timelocks.
12942 void ChainParameters_set_best_block(struct LDKChainParameters *NONNULL_PTR this_ptr, struct LDKBestBlock val);
12945 * Constructs a new ChainParameters given each field
12947 MUST_USE_RES struct LDKChainParameters ChainParameters_new(enum LDKNetwork network_arg, struct LDKBestBlock best_block_arg);
12950 * Frees any resources used by the BestBlock, if is_owned is set and inner is non-NULL.
12952 void BestBlock_free(struct LDKBestBlock this_obj);
12955 * Creates a copy of the BestBlock
12957 struct LDKBestBlock BestBlock_clone(const struct LDKBestBlock *NONNULL_PTR orig);
12960 * Returns the best block from the genesis of the given network.
12962 MUST_USE_RES struct LDKBestBlock BestBlock_from_genesis(enum LDKNetwork network);
12965 * Returns the best block as identified by the given block hash and height.
12967 MUST_USE_RES struct LDKBestBlock BestBlock_new(struct LDKThirtyTwoBytes block_hash, uint32_t height);
12970 * Returns the best block hash.
12972 MUST_USE_RES struct LDKThirtyTwoBytes BestBlock_block_hash(const struct LDKBestBlock *NONNULL_PTR this_arg);
12975 * Returns the best block height.
12977 MUST_USE_RES uint32_t BestBlock_height(const struct LDKBestBlock *NONNULL_PTR this_arg);
12980 * Frees any resources used by the ChannelDetails, if is_owned is set and inner is non-NULL.
12982 void ChannelDetails_free(struct LDKChannelDetails this_obj);
12985 * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
12986 * thereafter this is the txid of the funding transaction xor the funding transaction output).
12987 * Note that this means this value is *not* persistent - it can change once during the
12988 * lifetime of the channel.
12990 const uint8_t (*ChannelDetails_get_channel_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr))[32];
12993 * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
12994 * thereafter this is the txid of the funding transaction xor the funding transaction output).
12995 * Note that this means this value is *not* persistent - it can change once during the
12996 * lifetime of the channel.
12998 void ChannelDetails_set_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
13001 * The Channel's funding transaction output, if we've negotiated the funding transaction with
13002 * our counterparty already.
13004 * Note that, if this has been set, `channel_id` will be equivalent to
13005 * `funding_txo.unwrap().to_channel_id()`.
13007 struct LDKOutPoint ChannelDetails_get_funding_txo(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
13010 * The Channel's funding transaction output, if we've negotiated the funding transaction with
13011 * our counterparty already.
13013 * Note that, if this has been set, `channel_id` will be equivalent to
13014 * `funding_txo.unwrap().to_channel_id()`.
13016 void ChannelDetails_set_funding_txo(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKOutPoint val);
13019 * The position of the funding transaction in the chain. None if the funding transaction has
13020 * not yet been confirmed and the channel fully opened.
13022 struct LDKCOption_u64Z ChannelDetails_get_short_channel_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
13025 * The position of the funding transaction in the chain. None if the funding transaction has
13026 * not yet been confirmed and the channel fully opened.
13028 void ChannelDetails_set_short_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
13031 * The node_id of our counterparty
13033 struct LDKPublicKey ChannelDetails_get_remote_network_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
13036 * The node_id of our counterparty
13038 void ChannelDetails_set_remote_network_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13041 * The Features the channel counterparty provided upon last connection.
13042 * Useful for routing as it is the most up-to-date copy of the counterparty's features and
13043 * many routing-relevant features are present in the init context.
13045 struct LDKInitFeatures ChannelDetails_get_counterparty_features(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
13048 * The Features the channel counterparty provided upon last connection.
13049 * Useful for routing as it is the most up-to-date copy of the counterparty's features and
13050 * many routing-relevant features are present in the init context.
13052 void ChannelDetails_set_counterparty_features(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKInitFeatures val);
13055 * The value, in satoshis, of this channel as appears in the funding output
13057 uint64_t ChannelDetails_get_channel_value_satoshis(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
13060 * The value, in satoshis, of this channel as appears in the funding output
13062 void ChannelDetails_set_channel_value_satoshis(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
13065 * The user_id passed in to create_channel, or 0 if the channel was inbound.
13067 uint64_t ChannelDetails_get_user_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
13070 * The user_id passed in to create_channel, or 0 if the channel was inbound.
13072 void ChannelDetails_set_user_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
13075 * The available outbound capacity for sending HTLCs to the remote peer. This does not include
13076 * any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
13077 * available for inclusion in new outbound HTLCs). This further does not include any pending
13078 * outgoing HTLCs which are awaiting some other resolution to be sent.
13080 uint64_t ChannelDetails_get_outbound_capacity_msat(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
13083 * The available outbound capacity for sending HTLCs to the remote peer. This does not include
13084 * any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
13085 * available for inclusion in new outbound HTLCs). This further does not include any pending
13086 * outgoing HTLCs which are awaiting some other resolution to be sent.
13088 void ChannelDetails_set_outbound_capacity_msat(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
13091 * The available inbound capacity for the remote peer to send HTLCs to us. This does not
13092 * include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
13093 * available for inclusion in new inbound HTLCs).
13094 * Note that there are some corner cases not fully handled here, so the actual available
13095 * inbound capacity may be slightly higher than this.
13097 uint64_t ChannelDetails_get_inbound_capacity_msat(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
13100 * The available inbound capacity for the remote peer to send HTLCs to us. This does not
13101 * include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
13102 * available for inclusion in new inbound HTLCs).
13103 * Note that there are some corner cases not fully handled here, so the actual available
13104 * inbound capacity may be slightly higher than this.
13106 void ChannelDetails_set_inbound_capacity_msat(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
13109 * True if the channel was initiated (and thus funded) by us.
13111 bool ChannelDetails_get_is_outbound(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
13114 * True if the channel was initiated (and thus funded) by us.
13116 void ChannelDetails_set_is_outbound(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
13119 * True if the channel is confirmed, funding_locked messages have been exchanged, and the
13120 * channel is not currently being shut down. `funding_locked` message exchange implies the
13121 * required confirmation count has been reached (and we were connected to the peer at some
13122 * point after the funding transaction received enough confirmations).
13124 bool ChannelDetails_get_is_funding_locked(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
13127 * True if the channel is confirmed, funding_locked messages have been exchanged, and the
13128 * channel is not currently being shut down. `funding_locked` message exchange implies the
13129 * required confirmation count has been reached (and we were connected to the peer at some
13130 * point after the funding transaction received enough confirmations).
13132 void ChannelDetails_set_is_funding_locked(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
13135 * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
13136 * the peer is connected, (c) no monitor update failure is pending resolution, and (d) the
13137 * channel is not currently negotiating a shutdown.
13139 * This is a strict superset of `is_funding_locked`.
13141 bool ChannelDetails_get_is_usable(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
13144 * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
13145 * the peer is connected, (c) no monitor update failure is pending resolution, and (d) the
13146 * channel is not currently negotiating a shutdown.
13148 * This is a strict superset of `is_funding_locked`.
13150 void ChannelDetails_set_is_usable(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
13153 * True if this channel is (or will be) publicly-announced.
13155 bool ChannelDetails_get_is_public(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
13158 * True if this channel is (or will be) publicly-announced.
13160 void ChannelDetails_set_is_public(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
13163 * Creates a copy of the ChannelDetails
13165 struct LDKChannelDetails ChannelDetails_clone(const struct LDKChannelDetails *NONNULL_PTR orig);
13168 * Frees any resources used by the PaymentSendFailure
13170 void PaymentSendFailure_free(struct LDKPaymentSendFailure this_ptr);
13173 * Creates a copy of the PaymentSendFailure
13175 struct LDKPaymentSendFailure PaymentSendFailure_clone(const struct LDKPaymentSendFailure *NONNULL_PTR orig);
13178 * Constructs a new ChannelManager to hold several channels and route between them.
13180 * This is the main \"logic hub\" for all channel-related actions, and implements
13181 * ChannelMessageHandler.
13183 * Non-proportional fees are fixed according to our risk using the provided fee estimator.
13185 * panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
13187 * Users need to notify the new ChannelManager when a new block is connected or
13188 * disconnected using its `block_connected` and `block_disconnected` methods, starting
13189 * from after `params.latest_hash`.
13191 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);
13194 * Gets the current configuration applied to all new channels, as
13196 MUST_USE_RES struct LDKUserConfig ChannelManager_get_current_default_configuration(const struct LDKChannelManager *NONNULL_PTR this_arg);
13199 * Creates a new outbound channel to the given remote node and with the given value.
13201 * user_id will be provided back as user_channel_id in FundingGenerationReady events to allow
13202 * tracking of which events correspond with which create_channel call. Note that the
13203 * user_channel_id defaults to 0 for inbound channels, so you may wish to avoid using 0 for
13204 * user_id here. user_id has no meaning inside of LDK, it is simply copied to events and
13205 * otherwise ignored.
13207 * If successful, will generate a SendOpenChannel message event, so you should probably poll
13208 * PeerManager::process_events afterwards.
13210 * Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
13211 * greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
13213 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ 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_id, struct LDKUserConfig override_config);
13216 * Gets the list of open channels, in random order. See ChannelDetail field documentation for
13217 * more information.
13219 MUST_USE_RES struct LDKCVec_ChannelDetailsZ ChannelManager_list_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
13222 * Gets the list of usable channels, in random order. Useful as an argument to
13223 * get_route to ensure non-announced channels are used.
13225 * These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
13226 * documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
13229 MUST_USE_RES struct LDKCVec_ChannelDetailsZ ChannelManager_list_usable_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
13232 * Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
13233 * will be accepted on the given channel, and after additional timeout/the closing of all
13234 * pending HTLCs, the channel will be closed on chain.
13236 * May generate a SendShutdown message event on success, which should be relayed.
13238 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_close_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*channel_id)[32]);
13241 * Force closes a channel, immediately broadcasting the latest local commitment transaction to
13242 * the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
13244 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_force_close_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*channel_id)[32]);
13247 * Force close all channels, immediately broadcasting the latest local commitment transaction
13248 * for each to the chain and rejecting new HTLCs on each.
13250 void ChannelManager_force_close_all_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
13253 * Sends a payment along a given route.
13255 * Value parameters are provided via the last hop in route, see documentation for RouteHop
13256 * fields for more info.
13258 * Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
13259 * payment), we don't do anything to stop you! We always try to ensure that if the provided
13260 * next hop knows the preimage to payment_hash they can claim an additional amount as
13261 * specified in the last hop in the route! Thus, you should probably do your own
13262 * payment_preimage tracking (which you should already be doing as they represent \"proof of
13263 * payment\") and prevent double-sends yourself.
13265 * May generate SendHTLCs message(s) event on success, which should be relayed.
13267 * Each path may have a different return value, and PaymentSendValue may return a Vec with
13268 * each entry matching the corresponding-index entry in the route paths, see
13269 * PaymentSendFailure for more info.
13271 * In general, a path may raise:
13272 * * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
13273 * node public key) is specified.
13274 * * APIError::ChannelUnavailable if the next-hop channel is not available for updates
13275 * (including due to previous monitor update failure or new permanent monitor update
13277 * * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
13278 * relevant updates.
13280 * Note that depending on the type of the PaymentSendFailure the HTLC may have been
13281 * irrevocably committed to on our end. In such a case, do NOT retry the payment with a
13282 * different route unless you intend to pay twice!
13284 * payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
13285 * the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
13286 * newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
13287 * must not contain multiple paths as multi-path payments require a recipient-provided
13289 * If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
13290 * bit set (either as required or as available). If multiple paths are present in the Route,
13291 * we assume the invoice had the basic_mpp feature set.
13293 MUST_USE_RES struct LDKCResult_NonePaymentSendFailureZ ChannelManager_send_payment(const struct LDKChannelManager *NONNULL_PTR this_arg, const struct LDKRoute *NONNULL_PTR route, struct LDKThirtyTwoBytes payment_hash, struct LDKThirtyTwoBytes payment_secret);
13296 * Call this upon creation of a funding transaction for the given channel.
13298 * Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
13299 * or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
13301 * Panics if a funding transaction has already been provided for this channel.
13303 * May panic if the output found in the funding transaction is duplicative with some other
13304 * channel (note that this should be trivially prevented by using unique funding transaction
13305 * keys per-channel).
13307 * Do NOT broadcast the funding transaction yourself. When we have safely received our
13308 * counterparty's signature the funding transaction will automatically be broadcast via the
13309 * [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
13311 * Note that this includes RBF or similar transaction replacement strategies - lightning does
13312 * not currently support replacing a funding transaction on an existing channel. Instead,
13313 * create a new channel with a conflicting funding transaction.
13315 * [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
13317 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);
13320 * Regenerates channel_announcements and generates a signed node_announcement from the given
13321 * arguments, providing them in corresponding events via
13322 * [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
13323 * on-chain. This effectively re-broadcasts all channel announcements and sends our node
13324 * announcement to ensure that the lightning P2P network is aware of the channels we have and
13325 * our network addresses.
13327 * `rgb` is a node \"color\" and `alias` is a printable human-readable string to describe this
13328 * node to humans. They carry no in-protocol meaning.
13330 * `addresses` represent the set (possibly empty) of socket addresses on which this node
13331 * accepts incoming connections. These will be included in the node_announcement, publicly
13332 * tying these addresses together and to this node. If you wish to preserve user privacy,
13333 * addresses should likely contain only Tor Onion addresses.
13335 * Panics if `addresses` is absurdly large (more than 500).
13337 * [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
13339 void ChannelManager_broadcast_node_announcement(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThreeBytes rgb, struct LDKThirtyTwoBytes alias, struct LDKCVec_NetAddressZ addresses);
13342 * Processes HTLCs which are pending waiting on random forward delay.
13344 * Should only really ever be called in response to a PendingHTLCsForwardable event.
13345 * Will likely generate further events.
13347 void ChannelManager_process_pending_htlc_forwards(const struct LDKChannelManager *NONNULL_PTR this_arg);
13350 * If a peer is disconnected we mark any channels with that peer as 'disabled'.
13351 * After some time, if channels are still disabled we need to broadcast a ChannelUpdate
13352 * to inform the network about the uselessness of these channels.
13354 * This method handles all the details, and must be called roughly once per minute.
13356 * Note that in some rare cases this may generate a `chain::Watch::update_channel` call.
13358 void ChannelManager_timer_tick_occurred(const struct LDKChannelManager *NONNULL_PTR this_arg);
13361 * Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
13362 * after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
13363 * along the path (including in our own channel on which we received it).
13364 * Returns false if no payment was found to fail backwards, true if the process of failing the
13365 * HTLC backwards has been started.
13367 MUST_USE_RES bool ChannelManager_fail_htlc_backwards(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*payment_hash)[32]);
13370 * Provides a payment preimage in response to a PaymentReceived event, returning true and
13371 * generating message events for the net layer to claim the payment, if possible. Thus, you
13372 * should probably kick the net layer to go send messages if this returns true!
13374 * Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
13375 * [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
13376 * event matches your expectation. If you fail to do so and call this method, you may provide
13377 * the sender \"proof-of-payment\" when they did not fulfill the full expected payment.
13379 * May panic if called except in response to a PaymentReceived event.
13381 * [`create_inbound_payment`]: Self::create_inbound_payment
13382 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
13384 MUST_USE_RES bool ChannelManager_claim_funds(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThirtyTwoBytes payment_preimage);
13387 * Gets the node_id held by this ChannelManager
13389 MUST_USE_RES struct LDKPublicKey ChannelManager_get_our_node_id(const struct LDKChannelManager *NONNULL_PTR this_arg);
13392 * Restores a single, given channel to normal operation after a
13393 * ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
13396 * All ChannelMonitor updates up to and including highest_applied_update_id must have been
13397 * fully committed in every copy of the given channels' ChannelMonitors.
13399 * Note that there is no effect to calling with a highest_applied_update_id other than the
13400 * current latest ChannelMonitorUpdate and one call to this function after multiple
13401 * ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
13402 * exists largely only to prevent races between this and concurrent update_monitor calls.
13404 * Thus, the anticipated use is, at a high level:
13405 * 1) You register a chain::Watch with this ChannelManager,
13406 * 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
13407 * said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
13408 * any time it cannot do so instantly,
13409 * 3) update(s) are applied to each remote copy of a ChannelMonitor,
13410 * 4) once all remote copies are updated, you call this function with the update_id that
13411 * completed, and once it is the latest the Channel will be re-enabled.
13413 void ChannelManager_channel_monitor_updated(const struct LDKChannelManager *NONNULL_PTR this_arg, const struct LDKOutPoint *NONNULL_PTR funding_txo, uint64_t highest_applied_update_id);
13416 * Gets a payment secret and payment hash for use in an invoice given to a third party wishing
13419 * This differs from [`create_inbound_payment_for_hash`] only in that it generates the
13420 * [`PaymentHash`] and [`PaymentPreimage`] for you, returning the first and storing the second.
13422 * The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
13423 * will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
13424 * passed directly to [`claim_funds`].
13426 * See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
13428 * [`claim_funds`]: Self::claim_funds
13429 * [`PaymentReceived`]: events::Event::PaymentReceived
13430 * [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
13431 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
13433 MUST_USE_RES struct LDKC2Tuple_PaymentHashPaymentSecretZ ChannelManager_create_inbound_payment(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKCOption_u64Z min_value_msat, uint32_t invoice_expiry_delta_secs, uint64_t user_payment_id);
13436 * Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
13437 * stored external to LDK.
13439 * A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
13440 * payment secret fetched via this method or [`create_inbound_payment`], and which is at least
13441 * the `min_value_msat` provided here, if one is provided.
13443 * The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
13444 * method may return an Err if another payment with the same payment_hash is still pending.
13446 * `user_payment_id` will be provided back in [`PaymentReceived::user_payment_id`] events to
13447 * allow tracking of which events correspond with which calls to this and
13448 * [`create_inbound_payment`]. `user_payment_id` has no meaning inside of LDK, it is simply
13449 * copied to events and otherwise ignored. It may be used to correlate PaymentReceived events
13450 * with invoice metadata stored elsewhere.
13452 * `min_value_msat` should be set if the invoice being generated contains a value. Any payment
13453 * received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
13454 * before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
13455 * sender \"proof-of-payment\" unless they have paid the required amount.
13457 * `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
13458 * in excess of the current time. This should roughly match the expiry time set in the invoice.
13459 * After this many seconds, we will remove the inbound payment, resulting in any attempts to
13460 * pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
13461 * invoices when no timeout is set.
13463 * Note that we use block header time to time-out pending inbound payments (with some margin
13464 * to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
13465 * accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
13466 * If you need exact expiry semantics, you should enforce them upon receipt of
13467 * [`PaymentReceived`].
13469 * Pending inbound payments are stored in memory and in serialized versions of this
13470 * [`ChannelManager`]. If potentially unbounded numbers of inbound payments may exist and
13471 * space is limited, you may wish to rate-limit inbound payment creation.
13473 * May panic if `invoice_expiry_delta_secs` is greater than one year.
13475 * Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
13476 * set to at least [`MIN_FINAL_CLTV_EXPIRY`].
13478 * [`create_inbound_payment`]: Self::create_inbound_payment
13479 * [`PaymentReceived`]: events::Event::PaymentReceived
13480 * [`PaymentReceived::user_payment_id`]: events::Event::PaymentReceived::user_payment_id
13482 MUST_USE_RES struct LDKCResult_PaymentSecretAPIErrorZ 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, uint64_t user_payment_id);
13485 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
13486 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
13488 struct LDKMessageSendEventsProvider ChannelManager_as_MessageSendEventsProvider(const struct LDKChannelManager *NONNULL_PTR this_arg);
13491 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
13492 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
13494 struct LDKEventsProvider ChannelManager_as_EventsProvider(const struct LDKChannelManager *NONNULL_PTR this_arg);
13497 * Constructs a new Listen which calls the relevant methods on this_arg.
13498 * This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
13500 struct LDKListen ChannelManager_as_Listen(const struct LDKChannelManager *NONNULL_PTR this_arg);
13503 * Constructs a new Confirm which calls the relevant methods on this_arg.
13504 * This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
13506 struct LDKConfirm ChannelManager_as_Confirm(const struct LDKChannelManager *NONNULL_PTR this_arg);
13509 * Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
13510 * indicating whether persistence is necessary. Only one listener on
13511 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
13513 * Note that the feature `allow_wallclock_use` must be enabled to use this function.
13515 MUST_USE_RES bool ChannelManager_await_persistable_update_timeout(const struct LDKChannelManager *NONNULL_PTR this_arg, uint64_t max_wait);
13518 * Blocks until ChannelManager needs to be persisted. Only one listener on
13519 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
13522 void ChannelManager_await_persistable_update(const struct LDKChannelManager *NONNULL_PTR this_arg);
13525 * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
13526 * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
13528 struct LDKChannelMessageHandler ChannelManager_as_ChannelMessageHandler(const struct LDKChannelManager *NONNULL_PTR this_arg);
13531 * Serialize the ChannelManager object into a byte array which can be read by ChannelManager_read
13533 struct LDKCVec_u8Z ChannelManager_write(const struct LDKChannelManager *NONNULL_PTR obj);
13536 * Frees any resources used by the ChannelManagerReadArgs, if is_owned is set and inner is non-NULL.
13538 void ChannelManagerReadArgs_free(struct LDKChannelManagerReadArgs this_obj);
13541 * The keys provider which will give us relevant keys. Some keys will be loaded during
13542 * deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
13545 const struct LDKKeysInterface *ChannelManagerReadArgs_get_keys_manager(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
13548 * The keys provider which will give us relevant keys. Some keys will be loaded during
13549 * deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
13552 void ChannelManagerReadArgs_set_keys_manager(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKKeysInterface val);
13555 * The fee_estimator for use in the ChannelManager in the future.
13557 * No calls to the FeeEstimator will be made during deserialization.
13559 const struct LDKFeeEstimator *ChannelManagerReadArgs_get_fee_estimator(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
13562 * The fee_estimator for use in the ChannelManager in the future.
13564 * No calls to the FeeEstimator will be made during deserialization.
13566 void ChannelManagerReadArgs_set_fee_estimator(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKFeeEstimator val);
13569 * The chain::Watch for use in the ChannelManager in the future.
13571 * No calls to the chain::Watch will be made during deserialization. It is assumed that
13572 * you have deserialized ChannelMonitors separately and will add them to your
13573 * chain::Watch after deserializing this ChannelManager.
13575 const struct LDKWatch *ChannelManagerReadArgs_get_chain_monitor(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
13578 * The chain::Watch for use in the ChannelManager in the future.
13580 * No calls to the chain::Watch will be made during deserialization. It is assumed that
13581 * you have deserialized ChannelMonitors separately and will add them to your
13582 * chain::Watch after deserializing this ChannelManager.
13584 void ChannelManagerReadArgs_set_chain_monitor(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKWatch val);
13587 * The BroadcasterInterface which will be used in the ChannelManager in the future and may be
13588 * used to broadcast the latest local commitment transactions of channels which must be
13589 * force-closed during deserialization.
13591 const struct LDKBroadcasterInterface *ChannelManagerReadArgs_get_tx_broadcaster(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
13594 * The BroadcasterInterface which will be used in the ChannelManager in the future and may be
13595 * used to broadcast the latest local commitment transactions of channels which must be
13596 * force-closed during deserialization.
13598 void ChannelManagerReadArgs_set_tx_broadcaster(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKBroadcasterInterface val);
13601 * The Logger for use in the ChannelManager and which may be used to log information during
13604 const struct LDKLogger *ChannelManagerReadArgs_get_logger(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
13607 * The Logger for use in the ChannelManager and which may be used to log information during
13610 void ChannelManagerReadArgs_set_logger(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKLogger val);
13613 * Default settings used for new channels. Any existing channels will continue to use the
13614 * runtime settings which were stored when the ChannelManager was serialized.
13616 struct LDKUserConfig ChannelManagerReadArgs_get_default_config(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
13619 * Default settings used for new channels. Any existing channels will continue to use the
13620 * runtime settings which were stored when the ChannelManager was serialized.
13622 void ChannelManagerReadArgs_set_default_config(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKUserConfig val);
13625 * Simple utility function to create a ChannelManagerReadArgs which creates the monitor
13626 * HashMap for you. This is primarily useful for C bindings where it is not practical to
13627 * populate a HashMap directly from C.
13629 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);
13632 * Read a C2Tuple_BlockHashChannelManagerZ from a byte array, created by C2Tuple_BlockHashChannelManagerZ_write
13634 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ C2Tuple_BlockHashChannelManagerZ_read(struct LDKu8slice ser, struct LDKChannelManagerReadArgs arg);
13637 * Frees any resources used by the DecodeError, if is_owned is set and inner is non-NULL.
13639 void DecodeError_free(struct LDKDecodeError this_obj);
13642 * Creates a copy of the DecodeError
13644 struct LDKDecodeError DecodeError_clone(const struct LDKDecodeError *NONNULL_PTR orig);
13647 * Frees any resources used by the Init, if is_owned is set and inner is non-NULL.
13649 void Init_free(struct LDKInit this_obj);
13652 * The relevant features which the sender supports
13654 struct LDKInitFeatures Init_get_features(const struct LDKInit *NONNULL_PTR this_ptr);
13657 * The relevant features which the sender supports
13659 void Init_set_features(struct LDKInit *NONNULL_PTR this_ptr, struct LDKInitFeatures val);
13662 * Constructs a new Init given each field
13664 MUST_USE_RES struct LDKInit Init_new(struct LDKInitFeatures features_arg);
13667 * Creates a copy of the Init
13669 struct LDKInit Init_clone(const struct LDKInit *NONNULL_PTR orig);
13672 * Frees any resources used by the ErrorMessage, if is_owned is set and inner is non-NULL.
13674 void ErrorMessage_free(struct LDKErrorMessage this_obj);
13677 * The channel ID involved in the error
13679 const uint8_t (*ErrorMessage_get_channel_id(const struct LDKErrorMessage *NONNULL_PTR this_ptr))[32];
13682 * The channel ID involved in the error
13684 void ErrorMessage_set_channel_id(struct LDKErrorMessage *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
13687 * A possibly human-readable error description.
13688 * The string should be sanitized before it is used (e.g. emitted to logs
13689 * or printed to stdout). Otherwise, a well crafted error message may trigger a security
13690 * vulnerability in the terminal emulator or the logging subsystem.
13692 struct LDKStr ErrorMessage_get_data(const struct LDKErrorMessage *NONNULL_PTR this_ptr);
13695 * A possibly human-readable error description.
13696 * The string should be sanitized before it is used (e.g. emitted to logs
13697 * or printed to stdout). Otherwise, a well crafted error message may trigger a security
13698 * vulnerability in the terminal emulator or the logging subsystem.
13700 void ErrorMessage_set_data(struct LDKErrorMessage *NONNULL_PTR this_ptr, struct LDKStr val);
13703 * Constructs a new ErrorMessage given each field
13705 MUST_USE_RES struct LDKErrorMessage ErrorMessage_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKStr data_arg);
13708 * Creates a copy of the ErrorMessage
13710 struct LDKErrorMessage ErrorMessage_clone(const struct LDKErrorMessage *NONNULL_PTR orig);
13713 * Frees any resources used by the Ping, if is_owned is set and inner is non-NULL.
13715 void Ping_free(struct LDKPing this_obj);
13718 * The desired response length
13720 uint16_t Ping_get_ponglen(const struct LDKPing *NONNULL_PTR this_ptr);
13723 * The desired response length
13725 void Ping_set_ponglen(struct LDKPing *NONNULL_PTR this_ptr, uint16_t val);
13728 * The ping packet size.
13729 * This field is not sent on the wire. byteslen zeros are sent.
13731 uint16_t Ping_get_byteslen(const struct LDKPing *NONNULL_PTR this_ptr);
13734 * The ping packet size.
13735 * This field is not sent on the wire. byteslen zeros are sent.
13737 void Ping_set_byteslen(struct LDKPing *NONNULL_PTR this_ptr, uint16_t val);
13740 * Constructs a new Ping given each field
13742 MUST_USE_RES struct LDKPing Ping_new(uint16_t ponglen_arg, uint16_t byteslen_arg);
13745 * Creates a copy of the Ping
13747 struct LDKPing Ping_clone(const struct LDKPing *NONNULL_PTR orig);
13750 * Frees any resources used by the Pong, if is_owned is set and inner is non-NULL.
13752 void Pong_free(struct LDKPong this_obj);
13755 * The pong packet size.
13756 * This field is not sent on the wire. byteslen zeros are sent.
13758 uint16_t Pong_get_byteslen(const struct LDKPong *NONNULL_PTR this_ptr);
13761 * The pong packet size.
13762 * This field is not sent on the wire. byteslen zeros are sent.
13764 void Pong_set_byteslen(struct LDKPong *NONNULL_PTR this_ptr, uint16_t val);
13767 * Constructs a new Pong given each field
13769 MUST_USE_RES struct LDKPong Pong_new(uint16_t byteslen_arg);
13772 * Creates a copy of the Pong
13774 struct LDKPong Pong_clone(const struct LDKPong *NONNULL_PTR orig);
13777 * Frees any resources used by the OpenChannel, if is_owned is set and inner is non-NULL.
13779 void OpenChannel_free(struct LDKOpenChannel this_obj);
13782 * The genesis hash of the blockchain where the channel is to be opened
13784 const uint8_t (*OpenChannel_get_chain_hash(const struct LDKOpenChannel *NONNULL_PTR this_ptr))[32];
13787 * The genesis hash of the blockchain where the channel is to be opened
13789 void OpenChannel_set_chain_hash(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
13792 * A temporary channel ID, until the funding outpoint is announced
13794 const uint8_t (*OpenChannel_get_temporary_channel_id(const struct LDKOpenChannel *NONNULL_PTR this_ptr))[32];
13797 * A temporary channel ID, until the funding outpoint is announced
13799 void OpenChannel_set_temporary_channel_id(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
13802 * The channel value
13804 uint64_t OpenChannel_get_funding_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
13807 * The channel value
13809 void OpenChannel_set_funding_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
13812 * The amount to push to the counterparty as part of the open, in milli-satoshi
13814 uint64_t OpenChannel_get_push_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
13817 * The amount to push to the counterparty as part of the open, in milli-satoshi
13819 void OpenChannel_set_push_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
13822 * The threshold below which outputs on transactions broadcast by sender will be omitted
13824 uint64_t OpenChannel_get_dust_limit_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
13827 * The threshold below which outputs on transactions broadcast by sender will be omitted
13829 void OpenChannel_set_dust_limit_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
13832 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
13834 uint64_t OpenChannel_get_max_htlc_value_in_flight_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
13837 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
13839 void OpenChannel_set_max_htlc_value_in_flight_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
13842 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
13844 uint64_t OpenChannel_get_channel_reserve_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
13847 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
13849 void OpenChannel_set_channel_reserve_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
13852 * The minimum HTLC size incoming to sender, in milli-satoshi
13854 uint64_t OpenChannel_get_htlc_minimum_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
13857 * The minimum HTLC size incoming to sender, in milli-satoshi
13859 void OpenChannel_set_htlc_minimum_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
13862 * The feerate per 1000-weight of sender generated transactions, until updated by update_fee
13864 uint32_t OpenChannel_get_feerate_per_kw(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
13867 * The feerate per 1000-weight of sender generated transactions, until updated by update_fee
13869 void OpenChannel_set_feerate_per_kw(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint32_t val);
13872 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
13874 uint16_t OpenChannel_get_to_self_delay(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
13877 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
13879 void OpenChannel_set_to_self_delay(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint16_t val);
13882 * The maximum number of inbound HTLCs towards sender
13884 uint16_t OpenChannel_get_max_accepted_htlcs(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
13887 * The maximum number of inbound HTLCs towards sender
13889 void OpenChannel_set_max_accepted_htlcs(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint16_t val);
13892 * The sender's key controlling the funding transaction
13894 struct LDKPublicKey OpenChannel_get_funding_pubkey(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
13897 * The sender's key controlling the funding transaction
13899 void OpenChannel_set_funding_pubkey(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13902 * Used to derive a revocation key for transactions broadcast by counterparty
13904 struct LDKPublicKey OpenChannel_get_revocation_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
13907 * Used to derive a revocation key for transactions broadcast by counterparty
13909 void OpenChannel_set_revocation_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13912 * A payment key to sender for transactions broadcast by counterparty
13914 struct LDKPublicKey OpenChannel_get_payment_point(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
13917 * A payment key to sender for transactions broadcast by counterparty
13919 void OpenChannel_set_payment_point(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13922 * Used to derive a payment key to sender for transactions broadcast by sender
13924 struct LDKPublicKey OpenChannel_get_delayed_payment_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
13927 * Used to derive a payment key to sender for transactions broadcast by sender
13929 void OpenChannel_set_delayed_payment_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13932 * Used to derive an HTLC payment key to sender
13934 struct LDKPublicKey OpenChannel_get_htlc_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
13937 * Used to derive an HTLC payment key to sender
13939 void OpenChannel_set_htlc_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13942 * The first to-be-broadcast-by-sender transaction's per commitment point
13944 struct LDKPublicKey OpenChannel_get_first_per_commitment_point(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
13947 * The first to-be-broadcast-by-sender transaction's per commitment point
13949 void OpenChannel_set_first_per_commitment_point(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
13954 uint8_t OpenChannel_get_channel_flags(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
13959 void OpenChannel_set_channel_flags(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint8_t val);
13962 * Creates a copy of the OpenChannel
13964 struct LDKOpenChannel OpenChannel_clone(const struct LDKOpenChannel *NONNULL_PTR orig);
13967 * Frees any resources used by the AcceptChannel, if is_owned is set and inner is non-NULL.
13969 void AcceptChannel_free(struct LDKAcceptChannel this_obj);
13972 * A temporary channel ID, until the funding outpoint is announced
13974 const uint8_t (*AcceptChannel_get_temporary_channel_id(const struct LDKAcceptChannel *NONNULL_PTR this_ptr))[32];
13977 * A temporary channel ID, until the funding outpoint is announced
13979 void AcceptChannel_set_temporary_channel_id(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
13982 * The threshold below which outputs on transactions broadcast by sender will be omitted
13984 uint64_t AcceptChannel_get_dust_limit_satoshis(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
13987 * The threshold below which outputs on transactions broadcast by sender will be omitted
13989 void AcceptChannel_set_dust_limit_satoshis(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
13992 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
13994 uint64_t AcceptChannel_get_max_htlc_value_in_flight_msat(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
13997 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
13999 void AcceptChannel_set_max_htlc_value_in_flight_msat(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
14002 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
14004 uint64_t AcceptChannel_get_channel_reserve_satoshis(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
14007 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
14009 void AcceptChannel_set_channel_reserve_satoshis(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
14012 * The minimum HTLC size incoming to sender, in milli-satoshi
14014 uint64_t AcceptChannel_get_htlc_minimum_msat(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
14017 * The minimum HTLC size incoming to sender, in milli-satoshi
14019 void AcceptChannel_set_htlc_minimum_msat(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
14022 * Minimum depth of the funding transaction before the channel is considered open
14024 uint32_t AcceptChannel_get_minimum_depth(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
14027 * Minimum depth of the funding transaction before the channel is considered open
14029 void AcceptChannel_set_minimum_depth(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint32_t val);
14032 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
14034 uint16_t AcceptChannel_get_to_self_delay(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
14037 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
14039 void AcceptChannel_set_to_self_delay(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint16_t val);
14042 * The maximum number of inbound HTLCs towards sender
14044 uint16_t AcceptChannel_get_max_accepted_htlcs(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
14047 * The maximum number of inbound HTLCs towards sender
14049 void AcceptChannel_set_max_accepted_htlcs(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint16_t val);
14052 * The sender's key controlling the funding transaction
14054 struct LDKPublicKey AcceptChannel_get_funding_pubkey(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
14057 * The sender's key controlling the funding transaction
14059 void AcceptChannel_set_funding_pubkey(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14062 * Used to derive a revocation key for transactions broadcast by counterparty
14064 struct LDKPublicKey AcceptChannel_get_revocation_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
14067 * Used to derive a revocation key for transactions broadcast by counterparty
14069 void AcceptChannel_set_revocation_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14072 * A payment key to sender for transactions broadcast by counterparty
14074 struct LDKPublicKey AcceptChannel_get_payment_point(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
14077 * A payment key to sender for transactions broadcast by counterparty
14079 void AcceptChannel_set_payment_point(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14082 * Used to derive a payment key to sender for transactions broadcast by sender
14084 struct LDKPublicKey AcceptChannel_get_delayed_payment_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
14087 * Used to derive a payment key to sender for transactions broadcast by sender
14089 void AcceptChannel_set_delayed_payment_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14092 * Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
14094 struct LDKPublicKey AcceptChannel_get_htlc_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
14097 * Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
14099 void AcceptChannel_set_htlc_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14102 * The first to-be-broadcast-by-sender transaction's per commitment point
14104 struct LDKPublicKey AcceptChannel_get_first_per_commitment_point(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
14107 * The first to-be-broadcast-by-sender transaction's per commitment point
14109 void AcceptChannel_set_first_per_commitment_point(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14112 * Creates a copy of the AcceptChannel
14114 struct LDKAcceptChannel AcceptChannel_clone(const struct LDKAcceptChannel *NONNULL_PTR orig);
14117 * Frees any resources used by the FundingCreated, if is_owned is set and inner is non-NULL.
14119 void FundingCreated_free(struct LDKFundingCreated this_obj);
14122 * A temporary channel ID, until the funding is established
14124 const uint8_t (*FundingCreated_get_temporary_channel_id(const struct LDKFundingCreated *NONNULL_PTR this_ptr))[32];
14127 * A temporary channel ID, until the funding is established
14129 void FundingCreated_set_temporary_channel_id(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14132 * The funding transaction ID
14134 const uint8_t (*FundingCreated_get_funding_txid(const struct LDKFundingCreated *NONNULL_PTR this_ptr))[32];
14137 * The funding transaction ID
14139 void FundingCreated_set_funding_txid(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14142 * The specific output index funding this channel
14144 uint16_t FundingCreated_get_funding_output_index(const struct LDKFundingCreated *NONNULL_PTR this_ptr);
14147 * The specific output index funding this channel
14149 void FundingCreated_set_funding_output_index(struct LDKFundingCreated *NONNULL_PTR this_ptr, uint16_t val);
14152 * The signature of the channel initiator (funder) on the funding transaction
14154 struct LDKSignature FundingCreated_get_signature(const struct LDKFundingCreated *NONNULL_PTR this_ptr);
14157 * The signature of the channel initiator (funder) on the funding transaction
14159 void FundingCreated_set_signature(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKSignature val);
14162 * Constructs a new FundingCreated given each field
14164 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);
14167 * Creates a copy of the FundingCreated
14169 struct LDKFundingCreated FundingCreated_clone(const struct LDKFundingCreated *NONNULL_PTR orig);
14172 * Frees any resources used by the FundingSigned, if is_owned is set and inner is non-NULL.
14174 void FundingSigned_free(struct LDKFundingSigned this_obj);
14179 const uint8_t (*FundingSigned_get_channel_id(const struct LDKFundingSigned *NONNULL_PTR this_ptr))[32];
14184 void FundingSigned_set_channel_id(struct LDKFundingSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14187 * The signature of the channel acceptor (fundee) on the funding transaction
14189 struct LDKSignature FundingSigned_get_signature(const struct LDKFundingSigned *NONNULL_PTR this_ptr);
14192 * The signature of the channel acceptor (fundee) on the funding transaction
14194 void FundingSigned_set_signature(struct LDKFundingSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
14197 * Constructs a new FundingSigned given each field
14199 MUST_USE_RES struct LDKFundingSigned FundingSigned_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKSignature signature_arg);
14202 * Creates a copy of the FundingSigned
14204 struct LDKFundingSigned FundingSigned_clone(const struct LDKFundingSigned *NONNULL_PTR orig);
14207 * Frees any resources used by the FundingLocked, if is_owned is set and inner is non-NULL.
14209 void FundingLocked_free(struct LDKFundingLocked this_obj);
14214 const uint8_t (*FundingLocked_get_channel_id(const struct LDKFundingLocked *NONNULL_PTR this_ptr))[32];
14219 void FundingLocked_set_channel_id(struct LDKFundingLocked *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14222 * The per-commitment point of the second commitment transaction
14224 struct LDKPublicKey FundingLocked_get_next_per_commitment_point(const struct LDKFundingLocked *NONNULL_PTR this_ptr);
14227 * The per-commitment point of the second commitment transaction
14229 void FundingLocked_set_next_per_commitment_point(struct LDKFundingLocked *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14232 * Constructs a new FundingLocked given each field
14234 MUST_USE_RES struct LDKFundingLocked FundingLocked_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKPublicKey next_per_commitment_point_arg);
14237 * Creates a copy of the FundingLocked
14239 struct LDKFundingLocked FundingLocked_clone(const struct LDKFundingLocked *NONNULL_PTR orig);
14242 * Frees any resources used by the Shutdown, if is_owned is set and inner is non-NULL.
14244 void Shutdown_free(struct LDKShutdown this_obj);
14249 const uint8_t (*Shutdown_get_channel_id(const struct LDKShutdown *NONNULL_PTR this_ptr))[32];
14254 void Shutdown_set_channel_id(struct LDKShutdown *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14257 * The destination of this peer's funds on closing.
14258 * Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
14260 struct LDKu8slice Shutdown_get_scriptpubkey(const struct LDKShutdown *NONNULL_PTR this_ptr);
14263 * The destination of this peer's funds on closing.
14264 * Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
14266 void Shutdown_set_scriptpubkey(struct LDKShutdown *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
14269 * Constructs a new Shutdown given each field
14271 MUST_USE_RES struct LDKShutdown Shutdown_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKCVec_u8Z scriptpubkey_arg);
14274 * Creates a copy of the Shutdown
14276 struct LDKShutdown Shutdown_clone(const struct LDKShutdown *NONNULL_PTR orig);
14279 * Frees any resources used by the ClosingSigned, if is_owned is set and inner is non-NULL.
14281 void ClosingSigned_free(struct LDKClosingSigned this_obj);
14286 const uint8_t (*ClosingSigned_get_channel_id(const struct LDKClosingSigned *NONNULL_PTR this_ptr))[32];
14291 void ClosingSigned_set_channel_id(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14294 * The proposed total fee for the closing transaction
14296 uint64_t ClosingSigned_get_fee_satoshis(const struct LDKClosingSigned *NONNULL_PTR this_ptr);
14299 * The proposed total fee for the closing transaction
14301 void ClosingSigned_set_fee_satoshis(struct LDKClosingSigned *NONNULL_PTR this_ptr, uint64_t val);
14304 * A signature on the closing transaction
14306 struct LDKSignature ClosingSigned_get_signature(const struct LDKClosingSigned *NONNULL_PTR this_ptr);
14309 * A signature on the closing transaction
14311 void ClosingSigned_set_signature(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
14314 * Constructs a new ClosingSigned given each field
14316 MUST_USE_RES struct LDKClosingSigned ClosingSigned_new(struct LDKThirtyTwoBytes channel_id_arg, uint64_t fee_satoshis_arg, struct LDKSignature signature_arg);
14319 * Creates a copy of the ClosingSigned
14321 struct LDKClosingSigned ClosingSigned_clone(const struct LDKClosingSigned *NONNULL_PTR orig);
14324 * Frees any resources used by the UpdateAddHTLC, if is_owned is set and inner is non-NULL.
14326 void UpdateAddHTLC_free(struct LDKUpdateAddHTLC this_obj);
14331 const uint8_t (*UpdateAddHTLC_get_channel_id(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr))[32];
14336 void UpdateAddHTLC_set_channel_id(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14341 uint64_t UpdateAddHTLC_get_htlc_id(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
14346 void UpdateAddHTLC_set_htlc_id(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint64_t val);
14349 * The HTLC value in milli-satoshi
14351 uint64_t UpdateAddHTLC_get_amount_msat(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
14354 * The HTLC value in milli-satoshi
14356 void UpdateAddHTLC_set_amount_msat(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint64_t val);
14359 * The payment hash, the pre-image of which controls HTLC redemption
14361 const uint8_t (*UpdateAddHTLC_get_payment_hash(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr))[32];
14364 * The payment hash, the pre-image of which controls HTLC redemption
14366 void UpdateAddHTLC_set_payment_hash(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14369 * The expiry height of the HTLC
14371 uint32_t UpdateAddHTLC_get_cltv_expiry(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
14374 * The expiry height of the HTLC
14376 void UpdateAddHTLC_set_cltv_expiry(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint32_t val);
14379 * Creates a copy of the UpdateAddHTLC
14381 struct LDKUpdateAddHTLC UpdateAddHTLC_clone(const struct LDKUpdateAddHTLC *NONNULL_PTR orig);
14384 * Frees any resources used by the UpdateFulfillHTLC, if is_owned is set and inner is non-NULL.
14386 void UpdateFulfillHTLC_free(struct LDKUpdateFulfillHTLC this_obj);
14391 const uint8_t (*UpdateFulfillHTLC_get_channel_id(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr))[32];
14396 void UpdateFulfillHTLC_set_channel_id(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14401 uint64_t UpdateFulfillHTLC_get_htlc_id(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr);
14406 void UpdateFulfillHTLC_set_htlc_id(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, uint64_t val);
14409 * The pre-image of the payment hash, allowing HTLC redemption
14411 const uint8_t (*UpdateFulfillHTLC_get_payment_preimage(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr))[32];
14414 * The pre-image of the payment hash, allowing HTLC redemption
14416 void UpdateFulfillHTLC_set_payment_preimage(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14419 * Constructs a new UpdateFulfillHTLC given each field
14421 MUST_USE_RES struct LDKUpdateFulfillHTLC UpdateFulfillHTLC_new(struct LDKThirtyTwoBytes channel_id_arg, uint64_t htlc_id_arg, struct LDKThirtyTwoBytes payment_preimage_arg);
14424 * Creates a copy of the UpdateFulfillHTLC
14426 struct LDKUpdateFulfillHTLC UpdateFulfillHTLC_clone(const struct LDKUpdateFulfillHTLC *NONNULL_PTR orig);
14429 * Frees any resources used by the UpdateFailHTLC, if is_owned is set and inner is non-NULL.
14431 void UpdateFailHTLC_free(struct LDKUpdateFailHTLC this_obj);
14436 const uint8_t (*UpdateFailHTLC_get_channel_id(const struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr))[32];
14441 void UpdateFailHTLC_set_channel_id(struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14446 uint64_t UpdateFailHTLC_get_htlc_id(const struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr);
14451 void UpdateFailHTLC_set_htlc_id(struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr, uint64_t val);
14454 * Creates a copy of the UpdateFailHTLC
14456 struct LDKUpdateFailHTLC UpdateFailHTLC_clone(const struct LDKUpdateFailHTLC *NONNULL_PTR orig);
14459 * Frees any resources used by the UpdateFailMalformedHTLC, if is_owned is set and inner is non-NULL.
14461 void UpdateFailMalformedHTLC_free(struct LDKUpdateFailMalformedHTLC this_obj);
14466 const uint8_t (*UpdateFailMalformedHTLC_get_channel_id(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr))[32];
14471 void UpdateFailMalformedHTLC_set_channel_id(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14476 uint64_t UpdateFailMalformedHTLC_get_htlc_id(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr);
14481 void UpdateFailMalformedHTLC_set_htlc_id(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, uint64_t val);
14486 uint16_t UpdateFailMalformedHTLC_get_failure_code(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr);
14491 void UpdateFailMalformedHTLC_set_failure_code(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, uint16_t val);
14494 * Creates a copy of the UpdateFailMalformedHTLC
14496 struct LDKUpdateFailMalformedHTLC UpdateFailMalformedHTLC_clone(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR orig);
14499 * Frees any resources used by the CommitmentSigned, if is_owned is set and inner is non-NULL.
14501 void CommitmentSigned_free(struct LDKCommitmentSigned this_obj);
14506 const uint8_t (*CommitmentSigned_get_channel_id(const struct LDKCommitmentSigned *NONNULL_PTR this_ptr))[32];
14511 void CommitmentSigned_set_channel_id(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14514 * A signature on the commitment transaction
14516 struct LDKSignature CommitmentSigned_get_signature(const struct LDKCommitmentSigned *NONNULL_PTR this_ptr);
14519 * A signature on the commitment transaction
14521 void CommitmentSigned_set_signature(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
14524 * Signatures on the HTLC transactions
14526 void CommitmentSigned_set_htlc_signatures(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKCVec_SignatureZ val);
14529 * Constructs a new CommitmentSigned given each field
14531 MUST_USE_RES struct LDKCommitmentSigned CommitmentSigned_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKSignature signature_arg, struct LDKCVec_SignatureZ htlc_signatures_arg);
14534 * Creates a copy of the CommitmentSigned
14536 struct LDKCommitmentSigned CommitmentSigned_clone(const struct LDKCommitmentSigned *NONNULL_PTR orig);
14539 * Frees any resources used by the RevokeAndACK, if is_owned is set and inner is non-NULL.
14541 void RevokeAndACK_free(struct LDKRevokeAndACK this_obj);
14546 const uint8_t (*RevokeAndACK_get_channel_id(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr))[32];
14551 void RevokeAndACK_set_channel_id(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14554 * The secret corresponding to the per-commitment point
14556 const uint8_t (*RevokeAndACK_get_per_commitment_secret(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr))[32];
14559 * The secret corresponding to the per-commitment point
14561 void RevokeAndACK_set_per_commitment_secret(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14564 * The next sender-broadcast commitment transaction's per-commitment point
14566 struct LDKPublicKey RevokeAndACK_get_next_per_commitment_point(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr);
14569 * The next sender-broadcast commitment transaction's per-commitment point
14571 void RevokeAndACK_set_next_per_commitment_point(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14574 * Constructs a new RevokeAndACK given each field
14576 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);
14579 * Creates a copy of the RevokeAndACK
14581 struct LDKRevokeAndACK RevokeAndACK_clone(const struct LDKRevokeAndACK *NONNULL_PTR orig);
14584 * Frees any resources used by the UpdateFee, if is_owned is set and inner is non-NULL.
14586 void UpdateFee_free(struct LDKUpdateFee this_obj);
14591 const uint8_t (*UpdateFee_get_channel_id(const struct LDKUpdateFee *NONNULL_PTR this_ptr))[32];
14596 void UpdateFee_set_channel_id(struct LDKUpdateFee *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14599 * Fee rate per 1000-weight of the transaction
14601 uint32_t UpdateFee_get_feerate_per_kw(const struct LDKUpdateFee *NONNULL_PTR this_ptr);
14604 * Fee rate per 1000-weight of the transaction
14606 void UpdateFee_set_feerate_per_kw(struct LDKUpdateFee *NONNULL_PTR this_ptr, uint32_t val);
14609 * Constructs a new UpdateFee given each field
14611 MUST_USE_RES struct LDKUpdateFee UpdateFee_new(struct LDKThirtyTwoBytes channel_id_arg, uint32_t feerate_per_kw_arg);
14614 * Creates a copy of the UpdateFee
14616 struct LDKUpdateFee UpdateFee_clone(const struct LDKUpdateFee *NONNULL_PTR orig);
14619 * Frees any resources used by the DataLossProtect, if is_owned is set and inner is non-NULL.
14621 void DataLossProtect_free(struct LDKDataLossProtect this_obj);
14624 * Proof that the sender knows the per-commitment secret of a specific commitment transaction
14625 * belonging to the recipient
14627 const uint8_t (*DataLossProtect_get_your_last_per_commitment_secret(const struct LDKDataLossProtect *NONNULL_PTR this_ptr))[32];
14630 * Proof that the sender knows the per-commitment secret of a specific commitment transaction
14631 * belonging to the recipient
14633 void DataLossProtect_set_your_last_per_commitment_secret(struct LDKDataLossProtect *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14636 * The sender's per-commitment point for their current commitment transaction
14638 struct LDKPublicKey DataLossProtect_get_my_current_per_commitment_point(const struct LDKDataLossProtect *NONNULL_PTR this_ptr);
14641 * The sender's per-commitment point for their current commitment transaction
14643 void DataLossProtect_set_my_current_per_commitment_point(struct LDKDataLossProtect *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14646 * Constructs a new DataLossProtect given each field
14648 MUST_USE_RES struct LDKDataLossProtect DataLossProtect_new(struct LDKThirtyTwoBytes your_last_per_commitment_secret_arg, struct LDKPublicKey my_current_per_commitment_point_arg);
14651 * Creates a copy of the DataLossProtect
14653 struct LDKDataLossProtect DataLossProtect_clone(const struct LDKDataLossProtect *NONNULL_PTR orig);
14656 * Frees any resources used by the ChannelReestablish, if is_owned is set and inner is non-NULL.
14658 void ChannelReestablish_free(struct LDKChannelReestablish this_obj);
14663 const uint8_t (*ChannelReestablish_get_channel_id(const struct LDKChannelReestablish *NONNULL_PTR this_ptr))[32];
14668 void ChannelReestablish_set_channel_id(struct LDKChannelReestablish *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14671 * The next commitment number for the sender
14673 uint64_t ChannelReestablish_get_next_local_commitment_number(const struct LDKChannelReestablish *NONNULL_PTR this_ptr);
14676 * The next commitment number for the sender
14678 void ChannelReestablish_set_next_local_commitment_number(struct LDKChannelReestablish *NONNULL_PTR this_ptr, uint64_t val);
14681 * The next commitment number for the recipient
14683 uint64_t ChannelReestablish_get_next_remote_commitment_number(const struct LDKChannelReestablish *NONNULL_PTR this_ptr);
14686 * The next commitment number for the recipient
14688 void ChannelReestablish_set_next_remote_commitment_number(struct LDKChannelReestablish *NONNULL_PTR this_ptr, uint64_t val);
14691 * Creates a copy of the ChannelReestablish
14693 struct LDKChannelReestablish ChannelReestablish_clone(const struct LDKChannelReestablish *NONNULL_PTR orig);
14696 * Frees any resources used by the AnnouncementSignatures, if is_owned is set and inner is non-NULL.
14698 void AnnouncementSignatures_free(struct LDKAnnouncementSignatures this_obj);
14703 const uint8_t (*AnnouncementSignatures_get_channel_id(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr))[32];
14708 void AnnouncementSignatures_set_channel_id(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14711 * The short channel ID
14713 uint64_t AnnouncementSignatures_get_short_channel_id(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
14716 * The short channel ID
14718 void AnnouncementSignatures_set_short_channel_id(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, uint64_t val);
14721 * A signature by the node key
14723 struct LDKSignature AnnouncementSignatures_get_node_signature(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
14726 * A signature by the node key
14728 void AnnouncementSignatures_set_node_signature(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKSignature val);
14731 * A signature by the funding key
14733 struct LDKSignature AnnouncementSignatures_get_bitcoin_signature(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
14736 * A signature by the funding key
14738 void AnnouncementSignatures_set_bitcoin_signature(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKSignature val);
14741 * Constructs a new AnnouncementSignatures given each field
14743 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);
14746 * Creates a copy of the AnnouncementSignatures
14748 struct LDKAnnouncementSignatures AnnouncementSignatures_clone(const struct LDKAnnouncementSignatures *NONNULL_PTR orig);
14751 * Frees any resources used by the NetAddress
14753 void NetAddress_free(struct LDKNetAddress this_ptr);
14756 * Creates a copy of the NetAddress
14758 struct LDKNetAddress NetAddress_clone(const struct LDKNetAddress *NONNULL_PTR orig);
14761 * Serialize the NetAddress object into a byte array which can be read by NetAddress_read
14763 struct LDKCVec_u8Z NetAddress_write(const struct LDKNetAddress *NONNULL_PTR obj);
14766 * Read a Result from a byte array, created by Result_write
14768 struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ Result_read(struct LDKu8slice ser);
14771 * Read a NetAddress from a byte array, created by NetAddress_write
14773 struct LDKCResult_NetAddressDecodeErrorZ NetAddress_read(struct LDKu8slice ser);
14776 * Frees any resources used by the UnsignedNodeAnnouncement, if is_owned is set and inner is non-NULL.
14778 void UnsignedNodeAnnouncement_free(struct LDKUnsignedNodeAnnouncement this_obj);
14781 * The advertised features
14783 struct LDKNodeFeatures UnsignedNodeAnnouncement_get_features(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
14786 * The advertised features
14788 void UnsignedNodeAnnouncement_set_features(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
14791 * A strictly monotonic announcement counter, with gaps allowed
14793 uint32_t UnsignedNodeAnnouncement_get_timestamp(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
14796 * A strictly monotonic announcement counter, with gaps allowed
14798 void UnsignedNodeAnnouncement_set_timestamp(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, uint32_t val);
14801 * The node_id this announcement originated from (don't rebroadcast the node_announcement back
14804 struct LDKPublicKey UnsignedNodeAnnouncement_get_node_id(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
14807 * The node_id this announcement originated from (don't rebroadcast the node_announcement back
14810 void UnsignedNodeAnnouncement_set_node_id(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14813 * An RGB color for UI purposes
14815 const uint8_t (*UnsignedNodeAnnouncement_get_rgb(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr))[3];
14818 * An RGB color for UI purposes
14820 void UnsignedNodeAnnouncement_set_rgb(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKThreeBytes val);
14823 * An alias, for UI purposes. This should be sanitized before use. There is no guarantee
14826 const uint8_t (*UnsignedNodeAnnouncement_get_alias(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr))[32];
14829 * An alias, for UI purposes. This should be sanitized before use. There is no guarantee
14832 void UnsignedNodeAnnouncement_set_alias(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14835 * List of addresses on which this node is reachable
14837 void UnsignedNodeAnnouncement_set_addresses(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKCVec_NetAddressZ val);
14840 * Creates a copy of the UnsignedNodeAnnouncement
14842 struct LDKUnsignedNodeAnnouncement UnsignedNodeAnnouncement_clone(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR orig);
14845 * Frees any resources used by the NodeAnnouncement, if is_owned is set and inner is non-NULL.
14847 void NodeAnnouncement_free(struct LDKNodeAnnouncement this_obj);
14850 * The signature by the node key
14852 struct LDKSignature NodeAnnouncement_get_signature(const struct LDKNodeAnnouncement *NONNULL_PTR this_ptr);
14855 * The signature by the node key
14857 void NodeAnnouncement_set_signature(struct LDKNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
14860 * The actual content of the announcement
14862 struct LDKUnsignedNodeAnnouncement NodeAnnouncement_get_contents(const struct LDKNodeAnnouncement *NONNULL_PTR this_ptr);
14865 * The actual content of the announcement
14867 void NodeAnnouncement_set_contents(struct LDKNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKUnsignedNodeAnnouncement val);
14870 * Constructs a new NodeAnnouncement given each field
14872 MUST_USE_RES struct LDKNodeAnnouncement NodeAnnouncement_new(struct LDKSignature signature_arg, struct LDKUnsignedNodeAnnouncement contents_arg);
14875 * Creates a copy of the NodeAnnouncement
14877 struct LDKNodeAnnouncement NodeAnnouncement_clone(const struct LDKNodeAnnouncement *NONNULL_PTR orig);
14880 * Frees any resources used by the UnsignedChannelAnnouncement, if is_owned is set and inner is non-NULL.
14882 void UnsignedChannelAnnouncement_free(struct LDKUnsignedChannelAnnouncement this_obj);
14885 * The advertised channel features
14887 struct LDKChannelFeatures UnsignedChannelAnnouncement_get_features(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
14890 * The advertised channel features
14892 void UnsignedChannelAnnouncement_set_features(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
14895 * The genesis hash of the blockchain where the channel is to be opened
14897 const uint8_t (*UnsignedChannelAnnouncement_get_chain_hash(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr))[32];
14900 * The genesis hash of the blockchain where the channel is to be opened
14902 void UnsignedChannelAnnouncement_set_chain_hash(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14905 * The short channel ID
14907 uint64_t UnsignedChannelAnnouncement_get_short_channel_id(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
14910 * The short channel ID
14912 void UnsignedChannelAnnouncement_set_short_channel_id(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, uint64_t val);
14915 * One of the two node_ids which are endpoints of this channel
14917 struct LDKPublicKey UnsignedChannelAnnouncement_get_node_id_1(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
14920 * One of the two node_ids which are endpoints of this channel
14922 void UnsignedChannelAnnouncement_set_node_id_1(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14925 * The other of the two node_ids which are endpoints of this channel
14927 struct LDKPublicKey UnsignedChannelAnnouncement_get_node_id_2(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
14930 * The other of the two node_ids which are endpoints of this channel
14932 void UnsignedChannelAnnouncement_set_node_id_2(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14935 * The funding key for the first node
14937 struct LDKPublicKey UnsignedChannelAnnouncement_get_bitcoin_key_1(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
14940 * The funding key for the first node
14942 void UnsignedChannelAnnouncement_set_bitcoin_key_1(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14945 * The funding key for the second node
14947 struct LDKPublicKey UnsignedChannelAnnouncement_get_bitcoin_key_2(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
14950 * The funding key for the second node
14952 void UnsignedChannelAnnouncement_set_bitcoin_key_2(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14955 * Creates a copy of the UnsignedChannelAnnouncement
14957 struct LDKUnsignedChannelAnnouncement UnsignedChannelAnnouncement_clone(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR orig);
14960 * Frees any resources used by the ChannelAnnouncement, if is_owned is set and inner is non-NULL.
14962 void ChannelAnnouncement_free(struct LDKChannelAnnouncement this_obj);
14965 * Authentication of the announcement by the first public node
14967 struct LDKSignature ChannelAnnouncement_get_node_signature_1(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
14970 * Authentication of the announcement by the first public node
14972 void ChannelAnnouncement_set_node_signature_1(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
14975 * Authentication of the announcement by the second public node
14977 struct LDKSignature ChannelAnnouncement_get_node_signature_2(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
14980 * Authentication of the announcement by the second public node
14982 void ChannelAnnouncement_set_node_signature_2(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
14985 * Proof of funding UTXO ownership by the first public node
14987 struct LDKSignature ChannelAnnouncement_get_bitcoin_signature_1(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
14990 * Proof of funding UTXO ownership by the first public node
14992 void ChannelAnnouncement_set_bitcoin_signature_1(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
14995 * Proof of funding UTXO ownership by the second public node
14997 struct LDKSignature ChannelAnnouncement_get_bitcoin_signature_2(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
15000 * Proof of funding UTXO ownership by the second public node
15002 void ChannelAnnouncement_set_bitcoin_signature_2(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
15005 * The actual announcement
15007 struct LDKUnsignedChannelAnnouncement ChannelAnnouncement_get_contents(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
15010 * The actual announcement
15012 void ChannelAnnouncement_set_contents(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKUnsignedChannelAnnouncement val);
15015 * Constructs a new ChannelAnnouncement given each field
15017 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);
15020 * Creates a copy of the ChannelAnnouncement
15022 struct LDKChannelAnnouncement ChannelAnnouncement_clone(const struct LDKChannelAnnouncement *NONNULL_PTR orig);
15025 * Frees any resources used by the UnsignedChannelUpdate, if is_owned is set and inner is non-NULL.
15027 void UnsignedChannelUpdate_free(struct LDKUnsignedChannelUpdate this_obj);
15030 * The genesis hash of the blockchain where the channel is to be opened
15032 const uint8_t (*UnsignedChannelUpdate_get_chain_hash(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr))[32];
15035 * The genesis hash of the blockchain where the channel is to be opened
15037 void UnsignedChannelUpdate_set_chain_hash(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
15040 * The short channel ID
15042 uint64_t UnsignedChannelUpdate_get_short_channel_id(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
15045 * The short channel ID
15047 void UnsignedChannelUpdate_set_short_channel_id(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint64_t val);
15050 * A strictly monotonic announcement counter, with gaps allowed, specific to this channel
15052 uint32_t UnsignedChannelUpdate_get_timestamp(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
15055 * A strictly monotonic announcement counter, with gaps allowed, specific to this channel
15057 void UnsignedChannelUpdate_set_timestamp(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
15062 uint8_t UnsignedChannelUpdate_get_flags(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
15067 void UnsignedChannelUpdate_set_flags(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint8_t val);
15070 * The number of blocks such that if:
15071 * `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
15072 * then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
15073 * the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
15074 * cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
15075 * then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
15076 * forwarding. Note that the HTLC sender is the one who originally sets this value when
15077 * constructing the route.
15079 uint16_t UnsignedChannelUpdate_get_cltv_expiry_delta(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
15082 * The number of blocks such that if:
15083 * `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
15084 * then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
15085 * the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
15086 * cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
15087 * then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
15088 * forwarding. Note that the HTLC sender is the one who originally sets this value when
15089 * constructing the route.
15091 void UnsignedChannelUpdate_set_cltv_expiry_delta(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint16_t val);
15094 * The minimum HTLC size incoming to sender, in milli-satoshi
15096 uint64_t UnsignedChannelUpdate_get_htlc_minimum_msat(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
15099 * The minimum HTLC size incoming to sender, in milli-satoshi
15101 void UnsignedChannelUpdate_set_htlc_minimum_msat(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint64_t val);
15104 * The base HTLC fee charged by sender, in milli-satoshi
15106 uint32_t UnsignedChannelUpdate_get_fee_base_msat(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
15109 * The base HTLC fee charged by sender, in milli-satoshi
15111 void UnsignedChannelUpdate_set_fee_base_msat(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
15114 * The amount to fee multiplier, in micro-satoshi
15116 uint32_t UnsignedChannelUpdate_get_fee_proportional_millionths(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
15119 * The amount to fee multiplier, in micro-satoshi
15121 void UnsignedChannelUpdate_set_fee_proportional_millionths(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
15124 * Creates a copy of the UnsignedChannelUpdate
15126 struct LDKUnsignedChannelUpdate UnsignedChannelUpdate_clone(const struct LDKUnsignedChannelUpdate *NONNULL_PTR orig);
15129 * Frees any resources used by the ChannelUpdate, if is_owned is set and inner is non-NULL.
15131 void ChannelUpdate_free(struct LDKChannelUpdate this_obj);
15134 * A signature of the channel update
15136 struct LDKSignature ChannelUpdate_get_signature(const struct LDKChannelUpdate *NONNULL_PTR this_ptr);
15139 * A signature of the channel update
15141 void ChannelUpdate_set_signature(struct LDKChannelUpdate *NONNULL_PTR this_ptr, struct LDKSignature val);
15144 * The actual channel update
15146 struct LDKUnsignedChannelUpdate ChannelUpdate_get_contents(const struct LDKChannelUpdate *NONNULL_PTR this_ptr);
15149 * The actual channel update
15151 void ChannelUpdate_set_contents(struct LDKChannelUpdate *NONNULL_PTR this_ptr, struct LDKUnsignedChannelUpdate val);
15154 * Constructs a new ChannelUpdate given each field
15156 MUST_USE_RES struct LDKChannelUpdate ChannelUpdate_new(struct LDKSignature signature_arg, struct LDKUnsignedChannelUpdate contents_arg);
15159 * Creates a copy of the ChannelUpdate
15161 struct LDKChannelUpdate ChannelUpdate_clone(const struct LDKChannelUpdate *NONNULL_PTR orig);
15164 * Frees any resources used by the QueryChannelRange, if is_owned is set and inner is non-NULL.
15166 void QueryChannelRange_free(struct LDKQueryChannelRange this_obj);
15169 * The genesis hash of the blockchain being queried
15171 const uint8_t (*QueryChannelRange_get_chain_hash(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr))[32];
15174 * The genesis hash of the blockchain being queried
15176 void QueryChannelRange_set_chain_hash(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
15179 * The height of the first block for the channel UTXOs being queried
15181 uint32_t QueryChannelRange_get_first_blocknum(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr);
15184 * The height of the first block for the channel UTXOs being queried
15186 void QueryChannelRange_set_first_blocknum(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, uint32_t val);
15189 * The number of blocks to include in the query results
15191 uint32_t QueryChannelRange_get_number_of_blocks(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr);
15194 * The number of blocks to include in the query results
15196 void QueryChannelRange_set_number_of_blocks(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, uint32_t val);
15199 * Constructs a new QueryChannelRange given each field
15201 MUST_USE_RES struct LDKQueryChannelRange QueryChannelRange_new(struct LDKThirtyTwoBytes chain_hash_arg, uint32_t first_blocknum_arg, uint32_t number_of_blocks_arg);
15204 * Creates a copy of the QueryChannelRange
15206 struct LDKQueryChannelRange QueryChannelRange_clone(const struct LDKQueryChannelRange *NONNULL_PTR orig);
15209 * Frees any resources used by the ReplyChannelRange, if is_owned is set and inner is non-NULL.
15211 void ReplyChannelRange_free(struct LDKReplyChannelRange this_obj);
15214 * The genesis hash of the blockchain being queried
15216 const uint8_t (*ReplyChannelRange_get_chain_hash(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr))[32];
15219 * The genesis hash of the blockchain being queried
15221 void ReplyChannelRange_set_chain_hash(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
15224 * The height of the first block in the range of the reply
15226 uint32_t ReplyChannelRange_get_first_blocknum(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
15229 * The height of the first block in the range of the reply
15231 void ReplyChannelRange_set_first_blocknum(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, uint32_t val);
15234 * The number of blocks included in the range of the reply
15236 uint32_t ReplyChannelRange_get_number_of_blocks(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
15239 * The number of blocks included in the range of the reply
15241 void ReplyChannelRange_set_number_of_blocks(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, uint32_t val);
15244 * True when this is the final reply for a query
15246 bool ReplyChannelRange_get_sync_complete(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
15249 * True when this is the final reply for a query
15251 void ReplyChannelRange_set_sync_complete(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, bool val);
15254 * The short_channel_ids in the channel range
15256 void ReplyChannelRange_set_short_channel_ids(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
15259 * Constructs a new ReplyChannelRange given each field
15261 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);
15264 * Creates a copy of the ReplyChannelRange
15266 struct LDKReplyChannelRange ReplyChannelRange_clone(const struct LDKReplyChannelRange *NONNULL_PTR orig);
15269 * Frees any resources used by the QueryShortChannelIds, if is_owned is set and inner is non-NULL.
15271 void QueryShortChannelIds_free(struct LDKQueryShortChannelIds this_obj);
15274 * The genesis hash of the blockchain being queried
15276 const uint8_t (*QueryShortChannelIds_get_chain_hash(const struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr))[32];
15279 * The genesis hash of the blockchain being queried
15281 void QueryShortChannelIds_set_chain_hash(struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
15284 * The short_channel_ids that are being queried
15286 void QueryShortChannelIds_set_short_channel_ids(struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
15289 * Constructs a new QueryShortChannelIds given each field
15291 MUST_USE_RES struct LDKQueryShortChannelIds QueryShortChannelIds_new(struct LDKThirtyTwoBytes chain_hash_arg, struct LDKCVec_u64Z short_channel_ids_arg);
15294 * Creates a copy of the QueryShortChannelIds
15296 struct LDKQueryShortChannelIds QueryShortChannelIds_clone(const struct LDKQueryShortChannelIds *NONNULL_PTR orig);
15299 * Frees any resources used by the ReplyShortChannelIdsEnd, if is_owned is set and inner is non-NULL.
15301 void ReplyShortChannelIdsEnd_free(struct LDKReplyShortChannelIdsEnd this_obj);
15304 * The genesis hash of the blockchain that was queried
15306 const uint8_t (*ReplyShortChannelIdsEnd_get_chain_hash(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr))[32];
15309 * The genesis hash of the blockchain that was queried
15311 void ReplyShortChannelIdsEnd_set_chain_hash(struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
15314 * Indicates if the query recipient maintains up-to-date channel
15315 * information for the chain_hash
15317 bool ReplyShortChannelIdsEnd_get_full_information(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr);
15320 * Indicates if the query recipient maintains up-to-date channel
15321 * information for the chain_hash
15323 void ReplyShortChannelIdsEnd_set_full_information(struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr, bool val);
15326 * Constructs a new ReplyShortChannelIdsEnd given each field
15328 MUST_USE_RES struct LDKReplyShortChannelIdsEnd ReplyShortChannelIdsEnd_new(struct LDKThirtyTwoBytes chain_hash_arg, bool full_information_arg);
15331 * Creates a copy of the ReplyShortChannelIdsEnd
15333 struct LDKReplyShortChannelIdsEnd ReplyShortChannelIdsEnd_clone(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR orig);
15336 * Frees any resources used by the GossipTimestampFilter, if is_owned is set and inner is non-NULL.
15338 void GossipTimestampFilter_free(struct LDKGossipTimestampFilter this_obj);
15341 * The genesis hash of the blockchain for channel and node information
15343 const uint8_t (*GossipTimestampFilter_get_chain_hash(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr))[32];
15346 * The genesis hash of the blockchain for channel and node information
15348 void GossipTimestampFilter_set_chain_hash(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
15351 * The starting unix timestamp
15353 uint32_t GossipTimestampFilter_get_first_timestamp(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr);
15356 * The starting unix timestamp
15358 void GossipTimestampFilter_set_first_timestamp(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, uint32_t val);
15361 * The range of information in seconds
15363 uint32_t GossipTimestampFilter_get_timestamp_range(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr);
15366 * The range of information in seconds
15368 void GossipTimestampFilter_set_timestamp_range(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, uint32_t val);
15371 * Constructs a new GossipTimestampFilter given each field
15373 MUST_USE_RES struct LDKGossipTimestampFilter GossipTimestampFilter_new(struct LDKThirtyTwoBytes chain_hash_arg, uint32_t first_timestamp_arg, uint32_t timestamp_range_arg);
15376 * Creates a copy of the GossipTimestampFilter
15378 struct LDKGossipTimestampFilter GossipTimestampFilter_clone(const struct LDKGossipTimestampFilter *NONNULL_PTR orig);
15381 * Frees any resources used by the ErrorAction
15383 void ErrorAction_free(struct LDKErrorAction this_ptr);
15386 * Creates a copy of the ErrorAction
15388 struct LDKErrorAction ErrorAction_clone(const struct LDKErrorAction *NONNULL_PTR orig);
15391 * Frees any resources used by the LightningError, if is_owned is set and inner is non-NULL.
15393 void LightningError_free(struct LDKLightningError this_obj);
15396 * A human-readable message describing the error
15398 struct LDKStr LightningError_get_err(const struct LDKLightningError *NONNULL_PTR this_ptr);
15401 * A human-readable message describing the error
15403 void LightningError_set_err(struct LDKLightningError *NONNULL_PTR this_ptr, struct LDKStr val);
15406 * The action which should be taken against the offending peer.
15408 struct LDKErrorAction LightningError_get_action(const struct LDKLightningError *NONNULL_PTR this_ptr);
15411 * The action which should be taken against the offending peer.
15413 void LightningError_set_action(struct LDKLightningError *NONNULL_PTR this_ptr, struct LDKErrorAction val);
15416 * Constructs a new LightningError given each field
15418 MUST_USE_RES struct LDKLightningError LightningError_new(struct LDKStr err_arg, struct LDKErrorAction action_arg);
15421 * Creates a copy of the LightningError
15423 struct LDKLightningError LightningError_clone(const struct LDKLightningError *NONNULL_PTR orig);
15426 * Frees any resources used by the CommitmentUpdate, if is_owned is set and inner is non-NULL.
15428 void CommitmentUpdate_free(struct LDKCommitmentUpdate this_obj);
15431 * update_add_htlc messages which should be sent
15433 void CommitmentUpdate_set_update_add_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateAddHTLCZ val);
15436 * update_fulfill_htlc messages which should be sent
15438 void CommitmentUpdate_set_update_fulfill_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFulfillHTLCZ val);
15441 * update_fail_htlc messages which should be sent
15443 void CommitmentUpdate_set_update_fail_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFailHTLCZ val);
15446 * update_fail_malformed_htlc messages which should be sent
15448 void CommitmentUpdate_set_update_fail_malformed_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFailMalformedHTLCZ val);
15451 * An update_fee message which should be sent
15453 struct LDKUpdateFee CommitmentUpdate_get_update_fee(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
15456 * An update_fee message which should be sent
15458 void CommitmentUpdate_set_update_fee(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKUpdateFee val);
15461 * Finally, the commitment_signed message which should be sent
15463 struct LDKCommitmentSigned CommitmentUpdate_get_commitment_signed(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
15466 * Finally, the commitment_signed message which should be sent
15468 void CommitmentUpdate_set_commitment_signed(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCommitmentSigned val);
15471 * Constructs a new CommitmentUpdate given each field
15473 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);
15476 * Creates a copy of the CommitmentUpdate
15478 struct LDKCommitmentUpdate CommitmentUpdate_clone(const struct LDKCommitmentUpdate *NONNULL_PTR orig);
15481 * Frees any resources used by the HTLCFailChannelUpdate
15483 void HTLCFailChannelUpdate_free(struct LDKHTLCFailChannelUpdate this_ptr);
15486 * Creates a copy of the HTLCFailChannelUpdate
15488 struct LDKHTLCFailChannelUpdate HTLCFailChannelUpdate_clone(const struct LDKHTLCFailChannelUpdate *NONNULL_PTR orig);
15491 * Calls the free function if one is set
15493 void ChannelMessageHandler_free(struct LDKChannelMessageHandler this_ptr);
15496 * Calls the free function if one is set
15498 void RoutingMessageHandler_free(struct LDKRoutingMessageHandler this_ptr);
15501 * Serialize the AcceptChannel object into a byte array which can be read by AcceptChannel_read
15503 struct LDKCVec_u8Z AcceptChannel_write(const struct LDKAcceptChannel *NONNULL_PTR obj);
15506 * Read a AcceptChannel from a byte array, created by AcceptChannel_write
15508 struct LDKCResult_AcceptChannelDecodeErrorZ AcceptChannel_read(struct LDKu8slice ser);
15511 * Serialize the AnnouncementSignatures object into a byte array which can be read by AnnouncementSignatures_read
15513 struct LDKCVec_u8Z AnnouncementSignatures_write(const struct LDKAnnouncementSignatures *NONNULL_PTR obj);
15516 * Read a AnnouncementSignatures from a byte array, created by AnnouncementSignatures_write
15518 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ AnnouncementSignatures_read(struct LDKu8slice ser);
15521 * Serialize the ChannelReestablish object into a byte array which can be read by ChannelReestablish_read
15523 struct LDKCVec_u8Z ChannelReestablish_write(const struct LDKChannelReestablish *NONNULL_PTR obj);
15526 * Read a ChannelReestablish from a byte array, created by ChannelReestablish_write
15528 struct LDKCResult_ChannelReestablishDecodeErrorZ ChannelReestablish_read(struct LDKu8slice ser);
15531 * Serialize the ClosingSigned object into a byte array which can be read by ClosingSigned_read
15533 struct LDKCVec_u8Z ClosingSigned_write(const struct LDKClosingSigned *NONNULL_PTR obj);
15536 * Read a ClosingSigned from a byte array, created by ClosingSigned_write
15538 struct LDKCResult_ClosingSignedDecodeErrorZ ClosingSigned_read(struct LDKu8slice ser);
15541 * Serialize the CommitmentSigned object into a byte array which can be read by CommitmentSigned_read
15543 struct LDKCVec_u8Z CommitmentSigned_write(const struct LDKCommitmentSigned *NONNULL_PTR obj);
15546 * Read a CommitmentSigned from a byte array, created by CommitmentSigned_write
15548 struct LDKCResult_CommitmentSignedDecodeErrorZ CommitmentSigned_read(struct LDKu8slice ser);
15551 * Serialize the FundingCreated object into a byte array which can be read by FundingCreated_read
15553 struct LDKCVec_u8Z FundingCreated_write(const struct LDKFundingCreated *NONNULL_PTR obj);
15556 * Read a FundingCreated from a byte array, created by FundingCreated_write
15558 struct LDKCResult_FundingCreatedDecodeErrorZ FundingCreated_read(struct LDKu8slice ser);
15561 * Serialize the FundingSigned object into a byte array which can be read by FundingSigned_read
15563 struct LDKCVec_u8Z FundingSigned_write(const struct LDKFundingSigned *NONNULL_PTR obj);
15566 * Read a FundingSigned from a byte array, created by FundingSigned_write
15568 struct LDKCResult_FundingSignedDecodeErrorZ FundingSigned_read(struct LDKu8slice ser);
15571 * Serialize the FundingLocked object into a byte array which can be read by FundingLocked_read
15573 struct LDKCVec_u8Z FundingLocked_write(const struct LDKFundingLocked *NONNULL_PTR obj);
15576 * Read a FundingLocked from a byte array, created by FundingLocked_write
15578 struct LDKCResult_FundingLockedDecodeErrorZ FundingLocked_read(struct LDKu8slice ser);
15581 * Serialize the Init object into a byte array which can be read by Init_read
15583 struct LDKCVec_u8Z Init_write(const struct LDKInit *NONNULL_PTR obj);
15586 * Read a Init from a byte array, created by Init_write
15588 struct LDKCResult_InitDecodeErrorZ Init_read(struct LDKu8slice ser);
15591 * Serialize the OpenChannel object into a byte array which can be read by OpenChannel_read
15593 struct LDKCVec_u8Z OpenChannel_write(const struct LDKOpenChannel *NONNULL_PTR obj);
15596 * Read a OpenChannel from a byte array, created by OpenChannel_write
15598 struct LDKCResult_OpenChannelDecodeErrorZ OpenChannel_read(struct LDKu8slice ser);
15601 * Serialize the RevokeAndACK object into a byte array which can be read by RevokeAndACK_read
15603 struct LDKCVec_u8Z RevokeAndACK_write(const struct LDKRevokeAndACK *NONNULL_PTR obj);
15606 * Read a RevokeAndACK from a byte array, created by RevokeAndACK_write
15608 struct LDKCResult_RevokeAndACKDecodeErrorZ RevokeAndACK_read(struct LDKu8slice ser);
15611 * Serialize the Shutdown object into a byte array which can be read by Shutdown_read
15613 struct LDKCVec_u8Z Shutdown_write(const struct LDKShutdown *NONNULL_PTR obj);
15616 * Read a Shutdown from a byte array, created by Shutdown_write
15618 struct LDKCResult_ShutdownDecodeErrorZ Shutdown_read(struct LDKu8slice ser);
15621 * Serialize the UpdateFailHTLC object into a byte array which can be read by UpdateFailHTLC_read
15623 struct LDKCVec_u8Z UpdateFailHTLC_write(const struct LDKUpdateFailHTLC *NONNULL_PTR obj);
15626 * Read a UpdateFailHTLC from a byte array, created by UpdateFailHTLC_write
15628 struct LDKCResult_UpdateFailHTLCDecodeErrorZ UpdateFailHTLC_read(struct LDKu8slice ser);
15631 * Serialize the UpdateFailMalformedHTLC object into a byte array which can be read by UpdateFailMalformedHTLC_read
15633 struct LDKCVec_u8Z UpdateFailMalformedHTLC_write(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR obj);
15636 * Read a UpdateFailMalformedHTLC from a byte array, created by UpdateFailMalformedHTLC_write
15638 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ UpdateFailMalformedHTLC_read(struct LDKu8slice ser);
15641 * Serialize the UpdateFee object into a byte array which can be read by UpdateFee_read
15643 struct LDKCVec_u8Z UpdateFee_write(const struct LDKUpdateFee *NONNULL_PTR obj);
15646 * Read a UpdateFee from a byte array, created by UpdateFee_write
15648 struct LDKCResult_UpdateFeeDecodeErrorZ UpdateFee_read(struct LDKu8slice ser);
15651 * Serialize the UpdateFulfillHTLC object into a byte array which can be read by UpdateFulfillHTLC_read
15653 struct LDKCVec_u8Z UpdateFulfillHTLC_write(const struct LDKUpdateFulfillHTLC *NONNULL_PTR obj);
15656 * Read a UpdateFulfillHTLC from a byte array, created by UpdateFulfillHTLC_write
15658 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ UpdateFulfillHTLC_read(struct LDKu8slice ser);
15661 * Serialize the UpdateAddHTLC object into a byte array which can be read by UpdateAddHTLC_read
15663 struct LDKCVec_u8Z UpdateAddHTLC_write(const struct LDKUpdateAddHTLC *NONNULL_PTR obj);
15666 * Read a UpdateAddHTLC from a byte array, created by UpdateAddHTLC_write
15668 struct LDKCResult_UpdateAddHTLCDecodeErrorZ UpdateAddHTLC_read(struct LDKu8slice ser);
15671 * Serialize the Ping object into a byte array which can be read by Ping_read
15673 struct LDKCVec_u8Z Ping_write(const struct LDKPing *NONNULL_PTR obj);
15676 * Read a Ping from a byte array, created by Ping_write
15678 struct LDKCResult_PingDecodeErrorZ Ping_read(struct LDKu8slice ser);
15681 * Serialize the Pong object into a byte array which can be read by Pong_read
15683 struct LDKCVec_u8Z Pong_write(const struct LDKPong *NONNULL_PTR obj);
15686 * Read a Pong from a byte array, created by Pong_write
15688 struct LDKCResult_PongDecodeErrorZ Pong_read(struct LDKu8slice ser);
15691 * Serialize the UnsignedChannelAnnouncement object into a byte array which can be read by UnsignedChannelAnnouncement_read
15693 struct LDKCVec_u8Z UnsignedChannelAnnouncement_write(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR obj);
15696 * Read a UnsignedChannelAnnouncement from a byte array, created by UnsignedChannelAnnouncement_write
15698 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ UnsignedChannelAnnouncement_read(struct LDKu8slice ser);
15701 * Serialize the ChannelAnnouncement object into a byte array which can be read by ChannelAnnouncement_read
15703 struct LDKCVec_u8Z ChannelAnnouncement_write(const struct LDKChannelAnnouncement *NONNULL_PTR obj);
15706 * Read a ChannelAnnouncement from a byte array, created by ChannelAnnouncement_write
15708 struct LDKCResult_ChannelAnnouncementDecodeErrorZ ChannelAnnouncement_read(struct LDKu8slice ser);
15711 * Serialize the UnsignedChannelUpdate object into a byte array which can be read by UnsignedChannelUpdate_read
15713 struct LDKCVec_u8Z UnsignedChannelUpdate_write(const struct LDKUnsignedChannelUpdate *NONNULL_PTR obj);
15716 * Read a UnsignedChannelUpdate from a byte array, created by UnsignedChannelUpdate_write
15718 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ UnsignedChannelUpdate_read(struct LDKu8slice ser);
15721 * Serialize the ChannelUpdate object into a byte array which can be read by ChannelUpdate_read
15723 struct LDKCVec_u8Z ChannelUpdate_write(const struct LDKChannelUpdate *NONNULL_PTR obj);
15726 * Read a ChannelUpdate from a byte array, created by ChannelUpdate_write
15728 struct LDKCResult_ChannelUpdateDecodeErrorZ ChannelUpdate_read(struct LDKu8slice ser);
15731 * Serialize the ErrorMessage object into a byte array which can be read by ErrorMessage_read
15733 struct LDKCVec_u8Z ErrorMessage_write(const struct LDKErrorMessage *NONNULL_PTR obj);
15736 * Read a ErrorMessage from a byte array, created by ErrorMessage_write
15738 struct LDKCResult_ErrorMessageDecodeErrorZ ErrorMessage_read(struct LDKu8slice ser);
15741 * Serialize the UnsignedNodeAnnouncement object into a byte array which can be read by UnsignedNodeAnnouncement_read
15743 struct LDKCVec_u8Z UnsignedNodeAnnouncement_write(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR obj);
15746 * Read a UnsignedNodeAnnouncement from a byte array, created by UnsignedNodeAnnouncement_write
15748 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ UnsignedNodeAnnouncement_read(struct LDKu8slice ser);
15751 * Serialize the NodeAnnouncement object into a byte array which can be read by NodeAnnouncement_read
15753 struct LDKCVec_u8Z NodeAnnouncement_write(const struct LDKNodeAnnouncement *NONNULL_PTR obj);
15756 * Read a NodeAnnouncement from a byte array, created by NodeAnnouncement_write
15758 struct LDKCResult_NodeAnnouncementDecodeErrorZ NodeAnnouncement_read(struct LDKu8slice ser);
15761 * Read a QueryShortChannelIds from a byte array, created by QueryShortChannelIds_write
15763 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ QueryShortChannelIds_read(struct LDKu8slice ser);
15766 * Serialize the QueryShortChannelIds object into a byte array which can be read by QueryShortChannelIds_read
15768 struct LDKCVec_u8Z QueryShortChannelIds_write(const struct LDKQueryShortChannelIds *NONNULL_PTR obj);
15771 * Read a ReplyShortChannelIdsEnd from a byte array, created by ReplyShortChannelIdsEnd_write
15773 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ ReplyShortChannelIdsEnd_read(struct LDKu8slice ser);
15776 * Serialize the ReplyShortChannelIdsEnd object into a byte array which can be read by ReplyShortChannelIdsEnd_read
15778 struct LDKCVec_u8Z ReplyShortChannelIdsEnd_write(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR obj);
15781 *\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
15783 MUST_USE_RES uint32_t QueryChannelRange_end_blocknum(const struct LDKQueryChannelRange *NONNULL_PTR this_arg);
15786 * Read a QueryChannelRange from a byte array, created by QueryChannelRange_write
15788 struct LDKCResult_QueryChannelRangeDecodeErrorZ QueryChannelRange_read(struct LDKu8slice ser);
15791 * Serialize the QueryChannelRange object into a byte array which can be read by QueryChannelRange_read
15793 struct LDKCVec_u8Z QueryChannelRange_write(const struct LDKQueryChannelRange *NONNULL_PTR obj);
15796 * Read a ReplyChannelRange from a byte array, created by ReplyChannelRange_write
15798 struct LDKCResult_ReplyChannelRangeDecodeErrorZ ReplyChannelRange_read(struct LDKu8slice ser);
15801 * Serialize the ReplyChannelRange object into a byte array which can be read by ReplyChannelRange_read
15803 struct LDKCVec_u8Z ReplyChannelRange_write(const struct LDKReplyChannelRange *NONNULL_PTR obj);
15806 * Read a GossipTimestampFilter from a byte array, created by GossipTimestampFilter_write
15808 struct LDKCResult_GossipTimestampFilterDecodeErrorZ GossipTimestampFilter_read(struct LDKu8slice ser);
15811 * Serialize the GossipTimestampFilter object into a byte array which can be read by GossipTimestampFilter_read
15813 struct LDKCVec_u8Z GossipTimestampFilter_write(const struct LDKGossipTimestampFilter *NONNULL_PTR obj);
15816 * Frees any resources used by the IgnoringMessageHandler, if is_owned is set and inner is non-NULL.
15818 void IgnoringMessageHandler_free(struct LDKIgnoringMessageHandler this_obj);
15821 * Constructs a new IgnoringMessageHandler given each field
15823 MUST_USE_RES struct LDKIgnoringMessageHandler IgnoringMessageHandler_new(void);
15826 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
15827 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
15829 struct LDKMessageSendEventsProvider IgnoringMessageHandler_as_MessageSendEventsProvider(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
15832 * Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg.
15833 * This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is
15835 struct LDKRoutingMessageHandler IgnoringMessageHandler_as_RoutingMessageHandler(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
15838 * Frees any resources used by the ErroringMessageHandler, if is_owned is set and inner is non-NULL.
15840 void ErroringMessageHandler_free(struct LDKErroringMessageHandler this_obj);
15843 * Constructs a new ErroringMessageHandler
15845 MUST_USE_RES struct LDKErroringMessageHandler ErroringMessageHandler_new(void);
15848 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
15849 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
15851 struct LDKMessageSendEventsProvider ErroringMessageHandler_as_MessageSendEventsProvider(const struct LDKErroringMessageHandler *NONNULL_PTR this_arg);
15854 * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
15855 * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
15857 struct LDKChannelMessageHandler ErroringMessageHandler_as_ChannelMessageHandler(const struct LDKErroringMessageHandler *NONNULL_PTR this_arg);
15860 * Frees any resources used by the MessageHandler, if is_owned is set and inner is non-NULL.
15862 void MessageHandler_free(struct LDKMessageHandler this_obj);
15865 * A message handler which handles messages specific to channels. Usually this is just a
15866 * ChannelManager object or a ErroringMessageHandler.
15868 const struct LDKChannelMessageHandler *MessageHandler_get_chan_handler(const struct LDKMessageHandler *NONNULL_PTR this_ptr);
15871 * A message handler which handles messages specific to channels. Usually this is just a
15872 * ChannelManager object or a ErroringMessageHandler.
15874 void MessageHandler_set_chan_handler(struct LDKMessageHandler *NONNULL_PTR this_ptr, struct LDKChannelMessageHandler val);
15877 * A message handler which handles messages updating our knowledge of the network channel
15878 * graph. Usually this is just a NetGraphMsgHandlerMonitor object or an IgnoringMessageHandler.
15880 const struct LDKRoutingMessageHandler *MessageHandler_get_route_handler(const struct LDKMessageHandler *NONNULL_PTR this_ptr);
15883 * A message handler which handles messages updating our knowledge of the network channel
15884 * graph. Usually this is just a NetGraphMsgHandlerMonitor object or an IgnoringMessageHandler.
15886 void MessageHandler_set_route_handler(struct LDKMessageHandler *NONNULL_PTR this_ptr, struct LDKRoutingMessageHandler val);
15889 * Constructs a new MessageHandler given each field
15891 MUST_USE_RES struct LDKMessageHandler MessageHandler_new(struct LDKChannelMessageHandler chan_handler_arg, struct LDKRoutingMessageHandler route_handler_arg);
15894 * Creates a copy of a SocketDescriptor
15896 struct LDKSocketDescriptor SocketDescriptor_clone(const struct LDKSocketDescriptor *NONNULL_PTR orig);
15899 * Calls the free function if one is set
15901 void SocketDescriptor_free(struct LDKSocketDescriptor this_ptr);
15904 * Frees any resources used by the PeerHandleError, if is_owned is set and inner is non-NULL.
15906 void PeerHandleError_free(struct LDKPeerHandleError this_obj);
15909 * Used to indicate that we probably can't make any future connections to this peer, implying
15910 * we should go ahead and force-close any channels we have with it.
15912 bool PeerHandleError_get_no_connection_possible(const struct LDKPeerHandleError *NONNULL_PTR this_ptr);
15915 * Used to indicate that we probably can't make any future connections to this peer, implying
15916 * we should go ahead and force-close any channels we have with it.
15918 void PeerHandleError_set_no_connection_possible(struct LDKPeerHandleError *NONNULL_PTR this_ptr, bool val);
15921 * Constructs a new PeerHandleError given each field
15923 MUST_USE_RES struct LDKPeerHandleError PeerHandleError_new(bool no_connection_possible_arg);
15926 * Creates a copy of the PeerHandleError
15928 struct LDKPeerHandleError PeerHandleError_clone(const struct LDKPeerHandleError *NONNULL_PTR orig);
15931 * Frees any resources used by the PeerManager, if is_owned is set and inner is non-NULL.
15933 void PeerManager_free(struct LDKPeerManager this_obj);
15936 * Constructs a new PeerManager with the given message handlers and node_id secret key
15937 * ephemeral_random_data is used to derive per-connection ephemeral keys and must be
15938 * cryptographically secure random bytes.
15940 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);
15943 * Get the list of node ids for peers which have completed the initial handshake.
15945 * For outbound connections, this will be the same as the their_node_id parameter passed in to
15946 * new_outbound_connection, however entries will only appear once the initial handshake has
15947 * completed and we are sure the remote peer has the private key for the given node_id.
15949 MUST_USE_RES struct LDKCVec_PublicKeyZ PeerManager_get_peer_node_ids(const struct LDKPeerManager *NONNULL_PTR this_arg);
15952 * Indicates a new outbound connection has been established to a node with the given node_id.
15953 * Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
15954 * descriptor but must disconnect the connection immediately.
15956 * Returns a small number of bytes to send to the remote node (currently always 50).
15958 * Panics if descriptor is duplicative with some other descriptor which has not yet had a
15959 * socket_disconnected().
15961 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);
15964 * Indicates a new inbound connection has been established.
15966 * May refuse the connection by returning an Err, but will never write bytes to the remote end
15967 * (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
15968 * call socket_disconnected for the new descriptor but must disconnect the connection
15971 * Panics if descriptor is duplicative with some other descriptor which has not yet had
15972 * socket_disconnected called.
15974 MUST_USE_RES struct LDKCResult_NonePeerHandleErrorZ PeerManager_new_inbound_connection(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKSocketDescriptor descriptor);
15977 * Indicates that there is room to write data to the given socket descriptor.
15979 * May return an Err to indicate that the connection should be closed.
15981 * Will most likely call send_data on the descriptor passed in (or the descriptor handed into
15982 * new_*\\_connection) before returning. Thus, be very careful with reentrancy issues! The
15983 * invariants around calling write_buffer_space_avail in case a write did not fully complete
15984 * must still hold - be ready to call write_buffer_space_avail again if a write call generated
15985 * here isn't sufficient! Panics if the descriptor was not previously registered in a
15986 * new_\\*_connection event.
15988 MUST_USE_RES struct LDKCResult_NonePeerHandleErrorZ PeerManager_write_buffer_space_avail(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKSocketDescriptor *NONNULL_PTR descriptor);
15991 * Indicates that data was read from the given socket descriptor.
15993 * May return an Err to indicate that the connection should be closed.
15995 * Will *not* call back into send_data on any descriptors to avoid reentrancy complexity.
15996 * Thus, however, you almost certainly want to call process_events() after any read_event to
15997 * generate send_data calls to handle responses.
15999 * If Ok(true) is returned, further read_events should not be triggered until a send_data call
16000 * on this file descriptor has resume_read set (preventing DoS issues in the send buffer).
16002 * Panics if the descriptor was not previously registered in a new_*_connection event.
16004 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);
16007 * Checks for any events generated by our handlers and processes them. Includes sending most
16008 * response messages as well as messages generated by calls to handler functions directly (eg
16009 * functions like ChannelManager::process_pending_htlc_forward or send_payment).
16011 void PeerManager_process_events(const struct LDKPeerManager *NONNULL_PTR this_arg);
16014 * Indicates that the given socket descriptor's connection is now closed.
16016 * This must only be called if the socket has been disconnected by the peer or your own
16017 * decision to disconnect it and must NOT be called in any case where other parts of this
16018 * library (eg PeerHandleError, explicit disconnect_socket calls) instruct you to disconnect
16021 * Panics if the descriptor was not previously registered in a successful new_*_connection event.
16023 void PeerManager_socket_disconnected(const struct LDKPeerManager *NONNULL_PTR this_arg, const struct LDKSocketDescriptor *NONNULL_PTR descriptor);
16026 * Disconnect a peer given its node id.
16028 * Set no_connection_possible to true to prevent any further connection with this peer,
16029 * force-closing any channels we have with it.
16031 * If a peer is connected, this will call `disconnect_socket` on the descriptor for the peer,
16032 * so be careful about reentrancy issues.
16034 void PeerManager_disconnect_by_node_id(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKPublicKey node_id, bool no_connection_possible);
16037 * This function should be called roughly once every 30 seconds.
16038 * It will send pings to each peer and disconnect those which did not respond to the last round of pings.
16039 * Will most likely call send_data on all of the registered descriptors, thus, be very careful with reentrancy issues!
16041 void PeerManager_timer_tick_occurred(const struct LDKPeerManager *NONNULL_PTR this_arg);
16044 * Build the commitment secret from the seed and the commitment number
16046 struct LDKThirtyTwoBytes build_commitment_secret(const uint8_t (*commitment_seed)[32], uint64_t idx);
16049 * Derives a per-commitment-transaction private key (eg an htlc key or delayed_payment key)
16050 * from the base secret and the per_commitment_point.
16052 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
16053 * generated (ie our own).
16055 struct LDKCResult_SecretKeyErrorZ derive_private_key(struct LDKPublicKey per_commitment_point, const uint8_t (*base_secret)[32]);
16058 * Derives a per-commitment-transaction public key (eg an htlc key or a delayed_payment key)
16059 * from the base point and the per_commitment_key. This is the public equivalent of
16060 * derive_private_key - using only public keys to derive a public key instead of private keys.
16062 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
16063 * generated (ie our own).
16065 struct LDKCResult_PublicKeyErrorZ derive_public_key(struct LDKPublicKey per_commitment_point, struct LDKPublicKey base_point);
16068 * Derives a per-commitment-transaction revocation key from its constituent parts.
16070 * Only the cheating participant owns a valid witness to propagate a revoked
16071 * commitment transaction, thus per_commitment_secret always come from cheater
16072 * and revocation_base_secret always come from punisher, which is the broadcaster
16073 * of the transaction spending with this key knowledge.
16075 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
16076 * generated (ie our own).
16078 struct LDKCResult_SecretKeyErrorZ derive_private_revocation_key(const uint8_t (*per_commitment_secret)[32], const uint8_t (*countersignatory_revocation_base_secret)[32]);
16081 * Derives a per-commitment-transaction revocation public key from its constituent parts. This is
16082 * the public equivalend of derive_private_revocation_key - using only public keys to derive a
16083 * public key instead of private keys.
16085 * Only the cheating participant owns a valid witness to propagate a revoked
16086 * commitment transaction, thus per_commitment_point always come from cheater
16087 * and revocation_base_point always come from punisher, which is the broadcaster
16088 * of the transaction spending with this key knowledge.
16090 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
16091 * generated (ie our own).
16093 struct LDKCResult_PublicKeyErrorZ derive_public_revocation_key(struct LDKPublicKey per_commitment_point, struct LDKPublicKey countersignatory_revocation_base_point);
16096 * Frees any resources used by the TxCreationKeys, if is_owned is set and inner is non-NULL.
16098 void TxCreationKeys_free(struct LDKTxCreationKeys this_obj);
16101 * The broadcaster's per-commitment public key which was used to derive the other keys.
16103 struct LDKPublicKey TxCreationKeys_get_per_commitment_point(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
16106 * The broadcaster's per-commitment public key which was used to derive the other keys.
16108 void TxCreationKeys_set_per_commitment_point(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16111 * The revocation key which is used to allow the broadcaster of the commitment
16112 * transaction to provide their counterparty the ability to punish them if they broadcast
16115 struct LDKPublicKey TxCreationKeys_get_revocation_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
16118 * The revocation key which is used to allow the broadcaster of the commitment
16119 * transaction to provide their counterparty the ability to punish them if they broadcast
16122 void TxCreationKeys_set_revocation_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16125 * Broadcaster's HTLC Key
16127 struct LDKPublicKey TxCreationKeys_get_broadcaster_htlc_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
16130 * Broadcaster's HTLC Key
16132 void TxCreationKeys_set_broadcaster_htlc_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16135 * Countersignatory's HTLC Key
16137 struct LDKPublicKey TxCreationKeys_get_countersignatory_htlc_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
16140 * Countersignatory's HTLC Key
16142 void TxCreationKeys_set_countersignatory_htlc_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16145 * Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
16147 struct LDKPublicKey TxCreationKeys_get_broadcaster_delayed_payment_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
16150 * Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
16152 void TxCreationKeys_set_broadcaster_delayed_payment_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16155 * Constructs a new TxCreationKeys given each field
16157 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);
16160 * Creates a copy of the TxCreationKeys
16162 struct LDKTxCreationKeys TxCreationKeys_clone(const struct LDKTxCreationKeys *NONNULL_PTR orig);
16165 * Serialize the TxCreationKeys object into a byte array which can be read by TxCreationKeys_read
16167 struct LDKCVec_u8Z TxCreationKeys_write(const struct LDKTxCreationKeys *NONNULL_PTR obj);
16170 * Read a TxCreationKeys from a byte array, created by TxCreationKeys_write
16172 struct LDKCResult_TxCreationKeysDecodeErrorZ TxCreationKeys_read(struct LDKu8slice ser);
16175 * Frees any resources used by the ChannelPublicKeys, if is_owned is set and inner is non-NULL.
16177 void ChannelPublicKeys_free(struct LDKChannelPublicKeys this_obj);
16180 * The public key which is used to sign all commitment transactions, as it appears in the
16181 * on-chain channel lock-in 2-of-2 multisig output.
16183 struct LDKPublicKey ChannelPublicKeys_get_funding_pubkey(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
16186 * The public key which is used to sign all commitment transactions, as it appears in the
16187 * on-chain channel lock-in 2-of-2 multisig output.
16189 void ChannelPublicKeys_set_funding_pubkey(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16192 * The base point which is used (with derive_public_revocation_key) to derive per-commitment
16193 * revocation keys. This is combined with the per-commitment-secret generated by the
16194 * counterparty to create a secret which the counterparty can reveal to revoke previous
16197 struct LDKPublicKey ChannelPublicKeys_get_revocation_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
16200 * The base point which is used (with derive_public_revocation_key) to derive per-commitment
16201 * revocation keys. This is combined with the per-commitment-secret generated by the
16202 * counterparty to create a secret which the counterparty can reveal to revoke previous
16205 void ChannelPublicKeys_set_revocation_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16208 * The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
16209 * spendable primary channel balance on the broadcaster's commitment transaction. This key is
16210 * static across every commitment transaction.
16212 struct LDKPublicKey ChannelPublicKeys_get_payment_point(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
16215 * The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
16216 * spendable primary channel balance on the broadcaster's commitment transaction. This key is
16217 * static across every commitment transaction.
16219 void ChannelPublicKeys_set_payment_point(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16222 * The base point which is used (with derive_public_key) to derive a per-commitment payment
16223 * public key which receives non-HTLC-encumbered funds which are only available for spending
16224 * after some delay (or can be claimed via the revocation path).
16226 struct LDKPublicKey ChannelPublicKeys_get_delayed_payment_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
16229 * The base point which is used (with derive_public_key) to derive a per-commitment payment
16230 * public key which receives non-HTLC-encumbered funds which are only available for spending
16231 * after some delay (or can be claimed via the revocation path).
16233 void ChannelPublicKeys_set_delayed_payment_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16236 * The base point which is used (with derive_public_key) to derive a per-commitment public key
16237 * which is used to encumber HTLC-in-flight outputs.
16239 struct LDKPublicKey ChannelPublicKeys_get_htlc_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
16242 * The base point which is used (with derive_public_key) to derive a per-commitment public key
16243 * which is used to encumber HTLC-in-flight outputs.
16245 void ChannelPublicKeys_set_htlc_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16248 * Constructs a new ChannelPublicKeys given each field
16250 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);
16253 * Creates a copy of the ChannelPublicKeys
16255 struct LDKChannelPublicKeys ChannelPublicKeys_clone(const struct LDKChannelPublicKeys *NONNULL_PTR orig);
16258 * Serialize the ChannelPublicKeys object into a byte array which can be read by ChannelPublicKeys_read
16260 struct LDKCVec_u8Z ChannelPublicKeys_write(const struct LDKChannelPublicKeys *NONNULL_PTR obj);
16263 * Read a ChannelPublicKeys from a byte array, created by ChannelPublicKeys_write
16265 struct LDKCResult_ChannelPublicKeysDecodeErrorZ ChannelPublicKeys_read(struct LDKu8slice ser);
16268 * Create per-state keys from channel base points and the per-commitment point.
16269 * Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
16271 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);
16274 * Generate per-state keys from channel static keys.
16275 * Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
16277 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);
16280 * A script either spendable by the revocation
16281 * key or the broadcaster_delayed_payment_key and satisfying the relative-locktime OP_CSV constrain.
16282 * Encumbering a `to_holder` output on a commitment transaction or 2nd-stage HTLC transactions.
16284 struct LDKCVec_u8Z get_revokeable_redeemscript(struct LDKPublicKey revocation_key, uint16_t contest_delay, struct LDKPublicKey broadcaster_delayed_payment_key);
16287 * Frees any resources used by the HTLCOutputInCommitment, if is_owned is set and inner is non-NULL.
16289 void HTLCOutputInCommitment_free(struct LDKHTLCOutputInCommitment this_obj);
16292 * Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
16293 * Note that this is not the same as whether it is ountbound *from us*. To determine that you
16294 * need to compare this value to whether the commitment transaction in question is that of
16295 * the counterparty or our own.
16297 bool HTLCOutputInCommitment_get_offered(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
16300 * Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
16301 * Note that this is not the same as whether it is ountbound *from us*. To determine that you
16302 * need to compare this value to whether the commitment transaction in question is that of
16303 * the counterparty or our own.
16305 void HTLCOutputInCommitment_set_offered(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, bool val);
16308 * The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
16309 * this divided by 1000.
16311 uint64_t HTLCOutputInCommitment_get_amount_msat(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
16314 * The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
16315 * this divided by 1000.
16317 void HTLCOutputInCommitment_set_amount_msat(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, uint64_t val);
16320 * The CLTV lock-time at which this HTLC expires.
16322 uint32_t HTLCOutputInCommitment_get_cltv_expiry(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
16325 * The CLTV lock-time at which this HTLC expires.
16327 void HTLCOutputInCommitment_set_cltv_expiry(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, uint32_t val);
16330 * The hash of the preimage which unlocks this HTLC.
16332 const uint8_t (*HTLCOutputInCommitment_get_payment_hash(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr))[32];
16335 * The hash of the preimage which unlocks this HTLC.
16337 void HTLCOutputInCommitment_set_payment_hash(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16340 * The position within the commitment transactions' outputs. This may be None if the value is
16341 * below the dust limit (in which case no output appears in the commitment transaction and the
16342 * value is spent to additional transaction fees).
16344 struct LDKCOption_u32Z HTLCOutputInCommitment_get_transaction_output_index(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
16347 * The position within the commitment transactions' outputs. This may be None if the value is
16348 * below the dust limit (in which case no output appears in the commitment transaction and the
16349 * value is spent to additional transaction fees).
16351 void HTLCOutputInCommitment_set_transaction_output_index(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, struct LDKCOption_u32Z val);
16354 * Constructs a new HTLCOutputInCommitment given each field
16356 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);
16359 * Creates a copy of the HTLCOutputInCommitment
16361 struct LDKHTLCOutputInCommitment HTLCOutputInCommitment_clone(const struct LDKHTLCOutputInCommitment *NONNULL_PTR orig);
16364 * Serialize the HTLCOutputInCommitment object into a byte array which can be read by HTLCOutputInCommitment_read
16366 struct LDKCVec_u8Z HTLCOutputInCommitment_write(const struct LDKHTLCOutputInCommitment *NONNULL_PTR obj);
16369 * Read a HTLCOutputInCommitment from a byte array, created by HTLCOutputInCommitment_write
16371 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ HTLCOutputInCommitment_read(struct LDKu8slice ser);
16374 * Gets the witness redeemscript for an HTLC output in a commitment transaction. Note that htlc
16375 * does not need to have its previous_output_index filled.
16377 struct LDKCVec_u8Z get_htlc_redeemscript(const struct LDKHTLCOutputInCommitment *NONNULL_PTR htlc, const struct LDKTxCreationKeys *NONNULL_PTR keys);
16380 * Gets the redeemscript for a funding output from the two funding public keys.
16381 * Note that the order of funding public keys does not matter.
16383 struct LDKCVec_u8Z make_funding_redeemscript(struct LDKPublicKey broadcaster, struct LDKPublicKey countersignatory);
16386 * panics if htlc.transaction_output_index.is_none()!
16388 struct LDKTransaction build_htlc_transaction(const uint8_t (*prev_hash)[32], uint32_t feerate_per_kw, uint16_t contest_delay, const struct LDKHTLCOutputInCommitment *NONNULL_PTR htlc, struct LDKPublicKey broadcaster_delayed_payment_key, struct LDKPublicKey revocation_key);
16391 * Frees any resources used by the ChannelTransactionParameters, if is_owned is set and inner is non-NULL.
16393 void ChannelTransactionParameters_free(struct LDKChannelTransactionParameters this_obj);
16396 * Holder public keys
16398 struct LDKChannelPublicKeys ChannelTransactionParameters_get_holder_pubkeys(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
16401 * Holder public keys
16403 void ChannelTransactionParameters_set_holder_pubkeys(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKChannelPublicKeys val);
16406 * The contest delay selected by the holder, which applies to counterparty-broadcast transactions
16408 uint16_t ChannelTransactionParameters_get_holder_selected_contest_delay(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
16411 * The contest delay selected by the holder, which applies to counterparty-broadcast transactions
16413 void ChannelTransactionParameters_set_holder_selected_contest_delay(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, uint16_t val);
16416 * Whether the holder is the initiator of this channel.
16417 * This is an input to the commitment number obscure factor computation.
16419 bool ChannelTransactionParameters_get_is_outbound_from_holder(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
16422 * Whether the holder is the initiator of this channel.
16423 * This is an input to the commitment number obscure factor computation.
16425 void ChannelTransactionParameters_set_is_outbound_from_holder(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, bool val);
16428 * The late-bound counterparty channel transaction parameters.
16429 * These parameters are populated at the point in the protocol where the counterparty provides them.
16431 struct LDKCounterpartyChannelTransactionParameters ChannelTransactionParameters_get_counterparty_parameters(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
16434 * The late-bound counterparty channel transaction parameters.
16435 * These parameters are populated at the point in the protocol where the counterparty provides them.
16437 void ChannelTransactionParameters_set_counterparty_parameters(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKCounterpartyChannelTransactionParameters val);
16440 * The late-bound funding outpoint
16442 struct LDKOutPoint ChannelTransactionParameters_get_funding_outpoint(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
16445 * The late-bound funding outpoint
16447 void ChannelTransactionParameters_set_funding_outpoint(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKOutPoint val);
16450 * Constructs a new ChannelTransactionParameters given each field
16452 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);
16455 * Creates a copy of the ChannelTransactionParameters
16457 struct LDKChannelTransactionParameters ChannelTransactionParameters_clone(const struct LDKChannelTransactionParameters *NONNULL_PTR orig);
16460 * Frees any resources used by the CounterpartyChannelTransactionParameters, if is_owned is set and inner is non-NULL.
16462 void CounterpartyChannelTransactionParameters_free(struct LDKCounterpartyChannelTransactionParameters this_obj);
16465 * Counter-party public keys
16467 struct LDKChannelPublicKeys CounterpartyChannelTransactionParameters_get_pubkeys(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr);
16470 * Counter-party public keys
16472 void CounterpartyChannelTransactionParameters_set_pubkeys(struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKChannelPublicKeys val);
16475 * The contest delay selected by the counterparty, which applies to holder-broadcast transactions
16477 uint16_t CounterpartyChannelTransactionParameters_get_selected_contest_delay(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr);
16480 * The contest delay selected by the counterparty, which applies to holder-broadcast transactions
16482 void CounterpartyChannelTransactionParameters_set_selected_contest_delay(struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr, uint16_t val);
16485 * Constructs a new CounterpartyChannelTransactionParameters given each field
16487 MUST_USE_RES struct LDKCounterpartyChannelTransactionParameters CounterpartyChannelTransactionParameters_new(struct LDKChannelPublicKeys pubkeys_arg, uint16_t selected_contest_delay_arg);
16490 * Creates a copy of the CounterpartyChannelTransactionParameters
16492 struct LDKCounterpartyChannelTransactionParameters CounterpartyChannelTransactionParameters_clone(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR orig);
16495 * Whether the late bound parameters are populated.
16497 MUST_USE_RES bool ChannelTransactionParameters_is_populated(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
16500 * Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
16501 * given that the holder is the broadcaster.
16503 * self.is_populated() must be true before calling this function.
16505 MUST_USE_RES struct LDKDirectedChannelTransactionParameters ChannelTransactionParameters_as_holder_broadcastable(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
16508 * Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
16509 * given that the counterparty is the broadcaster.
16511 * self.is_populated() must be true before calling this function.
16513 MUST_USE_RES struct LDKDirectedChannelTransactionParameters ChannelTransactionParameters_as_counterparty_broadcastable(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
16516 * Serialize the CounterpartyChannelTransactionParameters object into a byte array which can be read by CounterpartyChannelTransactionParameters_read
16518 struct LDKCVec_u8Z CounterpartyChannelTransactionParameters_write(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR obj);
16521 * Read a CounterpartyChannelTransactionParameters from a byte array, created by CounterpartyChannelTransactionParameters_write
16523 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CounterpartyChannelTransactionParameters_read(struct LDKu8slice ser);
16526 * Serialize the ChannelTransactionParameters object into a byte array which can be read by ChannelTransactionParameters_read
16528 struct LDKCVec_u8Z ChannelTransactionParameters_write(const struct LDKChannelTransactionParameters *NONNULL_PTR obj);
16531 * Read a ChannelTransactionParameters from a byte array, created by ChannelTransactionParameters_write
16533 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ ChannelTransactionParameters_read(struct LDKu8slice ser);
16536 * Frees any resources used by the DirectedChannelTransactionParameters, if is_owned is set and inner is non-NULL.
16538 void DirectedChannelTransactionParameters_free(struct LDKDirectedChannelTransactionParameters this_obj);
16541 * Get the channel pubkeys for the broadcaster
16543 MUST_USE_RES struct LDKChannelPublicKeys DirectedChannelTransactionParameters_broadcaster_pubkeys(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
16546 * Get the channel pubkeys for the countersignatory
16548 MUST_USE_RES struct LDKChannelPublicKeys DirectedChannelTransactionParameters_countersignatory_pubkeys(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
16551 * Get the contest delay applicable to the transactions.
16552 * Note that the contest delay was selected by the countersignatory.
16554 MUST_USE_RES uint16_t DirectedChannelTransactionParameters_contest_delay(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
16557 * Whether the channel is outbound from the broadcaster.
16559 * The boolean representing the side that initiated the channel is
16560 * an input to the commitment number obscure factor computation.
16562 MUST_USE_RES bool DirectedChannelTransactionParameters_is_outbound(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
16565 * The funding outpoint
16567 MUST_USE_RES struct LDKOutPoint DirectedChannelTransactionParameters_funding_outpoint(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
16570 * Frees any resources used by the HolderCommitmentTransaction, if is_owned is set and inner is non-NULL.
16572 void HolderCommitmentTransaction_free(struct LDKHolderCommitmentTransaction this_obj);
16575 * Our counterparty's signature for the transaction
16577 struct LDKSignature HolderCommitmentTransaction_get_counterparty_sig(const struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr);
16580 * Our counterparty's signature for the transaction
16582 void HolderCommitmentTransaction_set_counterparty_sig(struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKSignature val);
16585 * All non-dust counterparty HTLC signatures, in the order they appear in the transaction
16587 void HolderCommitmentTransaction_set_counterparty_htlc_sigs(struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKCVec_SignatureZ val);
16590 * Creates a copy of the HolderCommitmentTransaction
16592 struct LDKHolderCommitmentTransaction HolderCommitmentTransaction_clone(const struct LDKHolderCommitmentTransaction *NONNULL_PTR orig);
16595 * Serialize the HolderCommitmentTransaction object into a byte array which can be read by HolderCommitmentTransaction_read
16597 struct LDKCVec_u8Z HolderCommitmentTransaction_write(const struct LDKHolderCommitmentTransaction *NONNULL_PTR obj);
16600 * Read a HolderCommitmentTransaction from a byte array, created by HolderCommitmentTransaction_write
16602 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ HolderCommitmentTransaction_read(struct LDKu8slice ser);
16605 * Create a new holder transaction with the given counterparty signatures.
16606 * The funding keys are used to figure out which signature should go first when building the transaction for broadcast.
16608 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);
16611 * Frees any resources used by the BuiltCommitmentTransaction, if is_owned is set and inner is non-NULL.
16613 void BuiltCommitmentTransaction_free(struct LDKBuiltCommitmentTransaction this_obj);
16616 * The commitment transaction
16618 struct LDKTransaction BuiltCommitmentTransaction_get_transaction(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr);
16621 * The commitment transaction
16623 void BuiltCommitmentTransaction_set_transaction(struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKTransaction val);
16626 * The txid for the commitment transaction.
16628 * This is provided as a performance optimization, instead of calling transaction.txid()
16631 const uint8_t (*BuiltCommitmentTransaction_get_txid(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr))[32];
16634 * The txid for the commitment transaction.
16636 * This is provided as a performance optimization, instead of calling transaction.txid()
16639 void BuiltCommitmentTransaction_set_txid(struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16642 * Constructs a new BuiltCommitmentTransaction given each field
16644 MUST_USE_RES struct LDKBuiltCommitmentTransaction BuiltCommitmentTransaction_new(struct LDKTransaction transaction_arg, struct LDKThirtyTwoBytes txid_arg);
16647 * Creates a copy of the BuiltCommitmentTransaction
16649 struct LDKBuiltCommitmentTransaction BuiltCommitmentTransaction_clone(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR orig);
16652 * Serialize the BuiltCommitmentTransaction object into a byte array which can be read by BuiltCommitmentTransaction_read
16654 struct LDKCVec_u8Z BuiltCommitmentTransaction_write(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR obj);
16657 * Read a BuiltCommitmentTransaction from a byte array, created by BuiltCommitmentTransaction_write
16659 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ BuiltCommitmentTransaction_read(struct LDKu8slice ser);
16662 * Get the SIGHASH_ALL sighash value of the transaction.
16664 * This can be used to verify a signature.
16666 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);
16669 * Sign a transaction, either because we are counter-signing the counterparty's transaction or
16670 * because we are about to broadcast a holder transaction.
16672 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);
16675 * Frees any resources used by the CommitmentTransaction, if is_owned is set and inner is non-NULL.
16677 void CommitmentTransaction_free(struct LDKCommitmentTransaction this_obj);
16680 * Creates a copy of the CommitmentTransaction
16682 struct LDKCommitmentTransaction CommitmentTransaction_clone(const struct LDKCommitmentTransaction *NONNULL_PTR orig);
16685 * Serialize the CommitmentTransaction object into a byte array which can be read by CommitmentTransaction_read
16687 struct LDKCVec_u8Z CommitmentTransaction_write(const struct LDKCommitmentTransaction *NONNULL_PTR obj);
16690 * Read a CommitmentTransaction from a byte array, created by CommitmentTransaction_write
16692 struct LDKCResult_CommitmentTransactionDecodeErrorZ CommitmentTransaction_read(struct LDKu8slice ser);
16695 * The backwards-counting commitment number
16697 MUST_USE_RES uint64_t CommitmentTransaction_commitment_number(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
16700 * The value to be sent to the broadcaster
16702 MUST_USE_RES uint64_t CommitmentTransaction_to_broadcaster_value_sat(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
16705 * The value to be sent to the counterparty
16707 MUST_USE_RES uint64_t CommitmentTransaction_to_countersignatory_value_sat(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
16710 * The feerate paid per 1000-weight-unit in this commitment transaction.
16712 MUST_USE_RES uint32_t CommitmentTransaction_feerate_per_kw(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
16715 * Trust our pre-built transaction and derived transaction creation public keys.
16717 * Applies a wrapper which allows access to these fields.
16719 * This should only be used if you fully trust the builder of this object. It should not
16720 *\tbe used by an external signer - instead use the verify function.
16722 MUST_USE_RES struct LDKTrustedCommitmentTransaction CommitmentTransaction_trust(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
16725 * Verify our pre-built transaction and derived transaction creation public keys.
16727 * Applies a wrapper which allows access to these fields.
16729 * An external validating signer must call this method before signing
16730 * or using the built transaction.
16732 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);
16735 * Frees any resources used by the TrustedCommitmentTransaction, if is_owned is set and inner is non-NULL.
16737 void TrustedCommitmentTransaction_free(struct LDKTrustedCommitmentTransaction this_obj);
16740 * The transaction ID of the built Bitcoin transaction
16742 MUST_USE_RES struct LDKThirtyTwoBytes TrustedCommitmentTransaction_txid(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
16745 * The pre-built Bitcoin commitment transaction
16747 MUST_USE_RES struct LDKBuiltCommitmentTransaction TrustedCommitmentTransaction_built_transaction(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
16750 * The pre-calculated transaction creation public keys.
16752 MUST_USE_RES struct LDKTxCreationKeys TrustedCommitmentTransaction_keys(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
16755 * Get a signature for each HTLC which was included in the commitment transaction (ie for
16756 * which HTLCOutputInCommitment::transaction_output_index.is_some()).
16758 * The returned Vec has one entry for each HTLC, and in the same order.
16760 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);
16763 * Get the transaction number obscure factor
16765 uint64_t get_commitment_transaction_number_obscure_factor(struct LDKPublicKey broadcaster_payment_basepoint, struct LDKPublicKey countersignatory_payment_basepoint, bool outbound_from_broadcaster);
16768 * Checks if two InitFeaturess contain equal inner contents.
16769 * This ignores pointers and is_owned flags and looks at the values in fields.
16770 * Two objects with NULL inner values will be considered "equal" here.
16772 bool InitFeatures_eq(const struct LDKInitFeatures *NONNULL_PTR a, const struct LDKInitFeatures *NONNULL_PTR b);
16775 * Checks if two NodeFeaturess contain equal inner contents.
16776 * This ignores pointers and is_owned flags and looks at the values in fields.
16777 * Two objects with NULL inner values will be considered "equal" here.
16779 bool NodeFeatures_eq(const struct LDKNodeFeatures *NONNULL_PTR a, const struct LDKNodeFeatures *NONNULL_PTR b);
16782 * Checks if two ChannelFeaturess contain equal inner contents.
16783 * This ignores pointers and is_owned flags and looks at the values in fields.
16784 * Two objects with NULL inner values will be considered "equal" here.
16786 bool ChannelFeatures_eq(const struct LDKChannelFeatures *NONNULL_PTR a, const struct LDKChannelFeatures *NONNULL_PTR b);
16789 * Checks if two InvoiceFeaturess contain equal inner contents.
16790 * This ignores pointers and is_owned flags and looks at the values in fields.
16791 * Two objects with NULL inner values will be considered "equal" here.
16793 bool InvoiceFeatures_eq(const struct LDKInvoiceFeatures *NONNULL_PTR a, const struct LDKInvoiceFeatures *NONNULL_PTR b);
16796 * Creates a copy of the InitFeatures
16798 struct LDKInitFeatures InitFeatures_clone(const struct LDKInitFeatures *NONNULL_PTR orig);
16801 * Creates a copy of the NodeFeatures
16803 struct LDKNodeFeatures NodeFeatures_clone(const struct LDKNodeFeatures *NONNULL_PTR orig);
16806 * Creates a copy of the ChannelFeatures
16808 struct LDKChannelFeatures ChannelFeatures_clone(const struct LDKChannelFeatures *NONNULL_PTR orig);
16811 * Creates a copy of the InvoiceFeatures
16813 struct LDKInvoiceFeatures InvoiceFeatures_clone(const struct LDKInvoiceFeatures *NONNULL_PTR orig);
16816 * Frees any resources used by the InitFeatures, if is_owned is set and inner is non-NULL.
16818 void InitFeatures_free(struct LDKInitFeatures this_obj);
16821 * Frees any resources used by the NodeFeatures, if is_owned is set and inner is non-NULL.
16823 void NodeFeatures_free(struct LDKNodeFeatures this_obj);
16826 * Frees any resources used by the ChannelFeatures, if is_owned is set and inner is non-NULL.
16828 void ChannelFeatures_free(struct LDKChannelFeatures this_obj);
16831 * Frees any resources used by the InvoiceFeatures, if is_owned is set and inner is non-NULL.
16833 void InvoiceFeatures_free(struct LDKInvoiceFeatures this_obj);
16836 * Create a blank Features with no features set
16838 MUST_USE_RES struct LDKInitFeatures InitFeatures_empty(void);
16841 * Creates a Features with the bits set which are known by the implementation
16843 MUST_USE_RES struct LDKInitFeatures InitFeatures_known(void);
16846 * Create a blank Features with no features set
16848 MUST_USE_RES struct LDKNodeFeatures NodeFeatures_empty(void);
16851 * Creates a Features with the bits set which are known by the implementation
16853 MUST_USE_RES struct LDKNodeFeatures NodeFeatures_known(void);
16856 * Create a blank Features with no features set
16858 MUST_USE_RES struct LDKChannelFeatures ChannelFeatures_empty(void);
16861 * Creates a Features with the bits set which are known by the implementation
16863 MUST_USE_RES struct LDKChannelFeatures ChannelFeatures_known(void);
16866 * Create a blank Features with no features set
16868 MUST_USE_RES struct LDKInvoiceFeatures InvoiceFeatures_empty(void);
16871 * Creates a Features with the bits set which are known by the implementation
16873 MUST_USE_RES struct LDKInvoiceFeatures InvoiceFeatures_known(void);
16876 * Returns whether the `payment_secret` feature is supported.
16878 MUST_USE_RES bool InitFeatures_supports_payment_secret(const struct LDKInitFeatures *NONNULL_PTR this_arg);
16881 * Returns whether the `payment_secret` feature is supported.
16883 MUST_USE_RES bool NodeFeatures_supports_payment_secret(const struct LDKNodeFeatures *NONNULL_PTR this_arg);
16886 * Returns whether the `payment_secret` feature is supported.
16888 MUST_USE_RES bool InvoiceFeatures_supports_payment_secret(const struct LDKInvoiceFeatures *NONNULL_PTR this_arg);
16891 * Serialize the InitFeatures object into a byte array which can be read by InitFeatures_read
16893 struct LDKCVec_u8Z InitFeatures_write(const struct LDKInitFeatures *NONNULL_PTR obj);
16896 * Serialize the NodeFeatures object into a byte array which can be read by NodeFeatures_read
16898 struct LDKCVec_u8Z NodeFeatures_write(const struct LDKNodeFeatures *NONNULL_PTR obj);
16901 * Serialize the ChannelFeatures object into a byte array which can be read by ChannelFeatures_read
16903 struct LDKCVec_u8Z ChannelFeatures_write(const struct LDKChannelFeatures *NONNULL_PTR obj);
16906 * Serialize the InvoiceFeatures object into a byte array which can be read by InvoiceFeatures_read
16908 struct LDKCVec_u8Z InvoiceFeatures_write(const struct LDKInvoiceFeatures *NONNULL_PTR obj);
16911 * Read a InitFeatures from a byte array, created by InitFeatures_write
16913 struct LDKCResult_InitFeaturesDecodeErrorZ InitFeatures_read(struct LDKu8slice ser);
16916 * Read a NodeFeatures from a byte array, created by NodeFeatures_write
16918 struct LDKCResult_NodeFeaturesDecodeErrorZ NodeFeatures_read(struct LDKu8slice ser);
16921 * Read a ChannelFeatures from a byte array, created by ChannelFeatures_write
16923 struct LDKCResult_ChannelFeaturesDecodeErrorZ ChannelFeatures_read(struct LDKu8slice ser);
16926 * Read a InvoiceFeatures from a byte array, created by InvoiceFeatures_write
16928 struct LDKCResult_InvoiceFeaturesDecodeErrorZ InvoiceFeatures_read(struct LDKu8slice ser);
16931 * Frees any resources used by the RouteHop, if is_owned is set and inner is non-NULL.
16933 void RouteHop_free(struct LDKRouteHop this_obj);
16936 * The node_id of the node at this hop.
16938 struct LDKPublicKey RouteHop_get_pubkey(const struct LDKRouteHop *NONNULL_PTR this_ptr);
16941 * The node_id of the node at this hop.
16943 void RouteHop_set_pubkey(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16946 * The node_announcement features of the node at this hop. For the last hop, these may be
16947 * amended to match the features present in the invoice this node generated.
16949 struct LDKNodeFeatures RouteHop_get_node_features(const struct LDKRouteHop *NONNULL_PTR this_ptr);
16952 * The node_announcement features of the node at this hop. For the last hop, these may be
16953 * amended to match the features present in the invoice this node generated.
16955 void RouteHop_set_node_features(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
16958 * The channel that should be used from the previous hop to reach this node.
16960 uint64_t RouteHop_get_short_channel_id(const struct LDKRouteHop *NONNULL_PTR this_ptr);
16963 * The channel that should be used from the previous hop to reach this node.
16965 void RouteHop_set_short_channel_id(struct LDKRouteHop *NONNULL_PTR this_ptr, uint64_t val);
16968 * The channel_announcement features of the channel that should be used from the previous hop
16969 * to reach this node.
16971 struct LDKChannelFeatures RouteHop_get_channel_features(const struct LDKRouteHop *NONNULL_PTR this_ptr);
16974 * The channel_announcement features of the channel that should be used from the previous hop
16975 * to reach this node.
16977 void RouteHop_set_channel_features(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
16980 * The fee taken on this hop (for paying for the use of the *next* channel in the path).
16981 * For the last hop, this should be the full value of the payment (might be more than
16982 * requested if we had to match htlc_minimum_msat).
16984 uint64_t RouteHop_get_fee_msat(const struct LDKRouteHop *NONNULL_PTR this_ptr);
16987 * The fee taken on this hop (for paying for the use of the *next* channel in the path).
16988 * For the last hop, this should be the full value of the payment (might be more than
16989 * requested if we had to match htlc_minimum_msat).
16991 void RouteHop_set_fee_msat(struct LDKRouteHop *NONNULL_PTR this_ptr, uint64_t val);
16994 * The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
16995 * expected at the destination, in excess of the current block height.
16997 uint32_t RouteHop_get_cltv_expiry_delta(const struct LDKRouteHop *NONNULL_PTR this_ptr);
17000 * The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
17001 * expected at the destination, in excess of the current block height.
17003 void RouteHop_set_cltv_expiry_delta(struct LDKRouteHop *NONNULL_PTR this_ptr, uint32_t val);
17006 * Constructs a new RouteHop given each field
17008 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);
17011 * Creates a copy of the RouteHop
17013 struct LDKRouteHop RouteHop_clone(const struct LDKRouteHop *NONNULL_PTR orig);
17016 * Serialize the RouteHop object into a byte array which can be read by RouteHop_read
17018 struct LDKCVec_u8Z RouteHop_write(const struct LDKRouteHop *NONNULL_PTR obj);
17021 * Read a RouteHop from a byte array, created by RouteHop_write
17023 struct LDKCResult_RouteHopDecodeErrorZ RouteHop_read(struct LDKu8slice ser);
17026 * Frees any resources used by the Route, if is_owned is set and inner is non-NULL.
17028 void Route_free(struct LDKRoute this_obj);
17031 * The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
17032 * last RouteHop in each path must be the same.
17033 * Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
17034 * destination. Thus, this must always be at least length one. While the maximum length of any
17035 * given path is variable, keeping the length of any path to less than 20 should currently
17036 * ensure it is viable.
17038 void Route_set_paths(struct LDKRoute *NONNULL_PTR this_ptr, struct LDKCVec_CVec_RouteHopZZ val);
17041 * Constructs a new Route given each field
17043 MUST_USE_RES struct LDKRoute Route_new(struct LDKCVec_CVec_RouteHopZZ paths_arg);
17046 * Creates a copy of the Route
17048 struct LDKRoute Route_clone(const struct LDKRoute *NONNULL_PTR orig);
17051 * Serialize the Route object into a byte array which can be read by Route_read
17053 struct LDKCVec_u8Z Route_write(const struct LDKRoute *NONNULL_PTR obj);
17056 * Read a Route from a byte array, created by Route_write
17058 struct LDKCResult_RouteDecodeErrorZ Route_read(struct LDKu8slice ser);
17061 * Frees any resources used by the RouteHintHop, if is_owned is set and inner is non-NULL.
17063 void RouteHintHop_free(struct LDKRouteHintHop this_obj);
17066 * The node_id of the non-target end of the route
17068 struct LDKPublicKey RouteHintHop_get_src_node_id(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
17071 * The node_id of the non-target end of the route
17073 void RouteHintHop_set_src_node_id(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKPublicKey val);
17076 * The short_channel_id of this channel
17078 uint64_t RouteHintHop_get_short_channel_id(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
17081 * The short_channel_id of this channel
17083 void RouteHintHop_set_short_channel_id(struct LDKRouteHintHop *NONNULL_PTR this_ptr, uint64_t val);
17086 * The fees which must be paid to use this channel
17088 struct LDKRoutingFees RouteHintHop_get_fees(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
17091 * The fees which must be paid to use this channel
17093 void RouteHintHop_set_fees(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
17096 * The difference in CLTV values between this node and the next node.
17098 uint16_t RouteHintHop_get_cltv_expiry_delta(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
17101 * The difference in CLTV values between this node and the next node.
17103 void RouteHintHop_set_cltv_expiry_delta(struct LDKRouteHintHop *NONNULL_PTR this_ptr, uint16_t val);
17106 * The minimum value, in msat, which must be relayed to the next hop.
17108 struct LDKCOption_u64Z RouteHintHop_get_htlc_minimum_msat(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
17111 * The minimum value, in msat, which must be relayed to the next hop.
17113 void RouteHintHop_set_htlc_minimum_msat(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
17116 * The maximum value in msat available for routing with a single HTLC.
17118 struct LDKCOption_u64Z RouteHintHop_get_htlc_maximum_msat(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
17121 * The maximum value in msat available for routing with a single HTLC.
17123 void RouteHintHop_set_htlc_maximum_msat(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
17126 * Constructs a new RouteHintHop given each field
17128 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);
17131 * Checks if two RouteHintHops contain equal inner contents.
17132 * This ignores pointers and is_owned flags and looks at the values in fields.
17133 * Two objects with NULL inner values will be considered "equal" here.
17135 bool RouteHintHop_eq(const struct LDKRouteHintHop *NONNULL_PTR a, const struct LDKRouteHintHop *NONNULL_PTR b);
17138 * Creates a copy of the RouteHintHop
17140 struct LDKRouteHintHop RouteHintHop_clone(const struct LDKRouteHintHop *NONNULL_PTR orig);
17143 * Gets a route from us (payer) to the given target node (payee).
17145 * If the payee provided features in their invoice, they should be provided via payee_features.
17146 * Without this, MPP will only be used if the payee's features are available in the network graph.
17148 * Extra routing hops between known nodes and the target will be used if they are included in
17151 * If some channels aren't announced, it may be useful to fill in a first_hops with the
17152 * results from a local ChannelManager::list_usable_channels() call. If it is filled in, our
17153 * view of our local channels (from net_graph_msg_handler) will be ignored, and only those
17154 * in first_hops will be used.
17156 * Panics if first_hops contains channels without short_channel_ids
17157 * (ChannelManager::list_usable_channels will never include such channels).
17159 * The fees on channels from us to next-hops are ignored (as they are assumed to all be
17160 * equal), however the enabled/disabled bit on such channels as well as the
17161 * htlc_minimum_msat/htlc_maximum_msat *are* checked as they may change based on the receiving node.
17163 struct LDKCResult_RouteLightningErrorZ get_route(struct LDKPublicKey our_node_id, const struct LDKNetworkGraph *NONNULL_PTR network, struct LDKPublicKey payee, struct LDKInvoiceFeatures payee_features, struct LDKCVec_ChannelDetailsZ *first_hops, struct LDKCVec_RouteHintHopZ last_hops, uint64_t final_value_msat, uint32_t final_cltv, struct LDKLogger logger);
17166 * Frees any resources used by the NetworkGraph, if is_owned is set and inner is non-NULL.
17168 void NetworkGraph_free(struct LDKNetworkGraph this_obj);
17171 * Creates a copy of the NetworkGraph
17173 struct LDKNetworkGraph NetworkGraph_clone(const struct LDKNetworkGraph *NONNULL_PTR orig);
17176 * Frees any resources used by the LockedNetworkGraph, if is_owned is set and inner is non-NULL.
17178 void LockedNetworkGraph_free(struct LDKLockedNetworkGraph this_obj);
17181 * Frees any resources used by the NetGraphMsgHandler, if is_owned is set and inner is non-NULL.
17183 void NetGraphMsgHandler_free(struct LDKNetGraphMsgHandler this_obj);
17186 * Creates a new tracker of the actual state of the network of channels and nodes,
17187 * assuming a fresh network graph.
17188 * Chain monitor is used to make sure announced channels exist on-chain,
17189 * channel data is correct, and that the announcement is signed with
17190 * channel owners' keys.
17192 MUST_USE_RES struct LDKNetGraphMsgHandler NetGraphMsgHandler_new(struct LDKThirtyTwoBytes genesis_hash, struct LDKAccess *chain_access, struct LDKLogger logger);
17195 * Creates a new tracker of the actual state of the network of channels and nodes,
17196 * assuming an existing Network Graph.
17198 MUST_USE_RES struct LDKNetGraphMsgHandler NetGraphMsgHandler_from_net_graph(struct LDKAccess *chain_access, struct LDKLogger logger, struct LDKNetworkGraph network_graph);
17201 * Adds a provider used to check new announcements. Does not affect
17202 * existing announcements unless they are updated.
17203 * Add, update or remove the provider would replace the current one.
17205 void NetGraphMsgHandler_add_chain_access(struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg, struct LDKAccess *chain_access);
17208 * Take a read lock on the network_graph and return it in the C-bindings
17209 * newtype helper. This is likely only useful when called via the C
17210 * bindings as you can call `self.network_graph.read().unwrap()` in Rust
17213 MUST_USE_RES struct LDKLockedNetworkGraph NetGraphMsgHandler_read_locked_graph(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
17216 * Get a reference to the NetworkGraph which this read-lock contains.
17218 MUST_USE_RES struct LDKNetworkGraph LockedNetworkGraph_graph(const struct LDKLockedNetworkGraph *NONNULL_PTR this_arg);
17221 * Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg.
17222 * This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is
17224 struct LDKRoutingMessageHandler NetGraphMsgHandler_as_RoutingMessageHandler(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
17227 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
17228 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
17230 struct LDKMessageSendEventsProvider NetGraphMsgHandler_as_MessageSendEventsProvider(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
17233 * Frees any resources used by the DirectionalChannelInfo, if is_owned is set and inner is non-NULL.
17235 void DirectionalChannelInfo_free(struct LDKDirectionalChannelInfo this_obj);
17238 * When the last update to the channel direction was issued.
17239 * Value is opaque, as set in the announcement.
17241 uint32_t DirectionalChannelInfo_get_last_update(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
17244 * When the last update to the channel direction was issued.
17245 * Value is opaque, as set in the announcement.
17247 void DirectionalChannelInfo_set_last_update(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, uint32_t val);
17250 * Whether the channel can be currently used for payments (in this one direction).
17252 bool DirectionalChannelInfo_get_enabled(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
17255 * Whether the channel can be currently used for payments (in this one direction).
17257 void DirectionalChannelInfo_set_enabled(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, bool val);
17260 * The difference in CLTV values that you must have when routing through this channel.
17262 uint16_t DirectionalChannelInfo_get_cltv_expiry_delta(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
17265 * The difference in CLTV values that you must have when routing through this channel.
17267 void DirectionalChannelInfo_set_cltv_expiry_delta(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, uint16_t val);
17270 * The minimum value, which must be relayed to the next hop via the channel
17272 uint64_t DirectionalChannelInfo_get_htlc_minimum_msat(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
17275 * The minimum value, which must be relayed to the next hop via the channel
17277 void DirectionalChannelInfo_set_htlc_minimum_msat(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, uint64_t val);
17280 * The maximum value which may be relayed to the next hop via the channel.
17282 struct LDKCOption_u64Z DirectionalChannelInfo_get_htlc_maximum_msat(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
17285 * The maximum value which may be relayed to the next hop via the channel.
17287 void DirectionalChannelInfo_set_htlc_maximum_msat(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
17290 * Fees charged when the channel is used for routing
17292 struct LDKRoutingFees DirectionalChannelInfo_get_fees(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
17295 * Fees charged when the channel is used for routing
17297 void DirectionalChannelInfo_set_fees(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
17300 * Most recent update for the channel received from the network
17301 * Mostly redundant with the data we store in fields explicitly.
17302 * Everything else is useful only for sending out for initial routing sync.
17303 * Not stored if contains excess data to prevent DoS.
17305 struct LDKChannelUpdate DirectionalChannelInfo_get_last_update_message(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
17308 * Most recent update for the channel received from the network
17309 * Mostly redundant with the data we store in fields explicitly.
17310 * Everything else is useful only for sending out for initial routing sync.
17311 * Not stored if contains excess data to prevent DoS.
17313 void DirectionalChannelInfo_set_last_update_message(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelUpdate val);
17316 * Constructs a new DirectionalChannelInfo given each field
17318 MUST_USE_RES struct LDKDirectionalChannelInfo DirectionalChannelInfo_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);
17321 * Creates a copy of the DirectionalChannelInfo
17323 struct LDKDirectionalChannelInfo DirectionalChannelInfo_clone(const struct LDKDirectionalChannelInfo *NONNULL_PTR orig);
17326 * Serialize the DirectionalChannelInfo object into a byte array which can be read by DirectionalChannelInfo_read
17328 struct LDKCVec_u8Z DirectionalChannelInfo_write(const struct LDKDirectionalChannelInfo *NONNULL_PTR obj);
17331 * Read a DirectionalChannelInfo from a byte array, created by DirectionalChannelInfo_write
17333 struct LDKCResult_DirectionalChannelInfoDecodeErrorZ DirectionalChannelInfo_read(struct LDKu8slice ser);
17336 * Frees any resources used by the ChannelInfo, if is_owned is set and inner is non-NULL.
17338 void ChannelInfo_free(struct LDKChannelInfo this_obj);
17341 * Protocol features of a channel communicated during its announcement
17343 struct LDKChannelFeatures ChannelInfo_get_features(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
17346 * Protocol features of a channel communicated during its announcement
17348 void ChannelInfo_set_features(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
17351 * Source node of the first direction of a channel
17353 struct LDKPublicKey ChannelInfo_get_node_one(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
17356 * Source node of the first direction of a channel
17358 void ChannelInfo_set_node_one(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKPublicKey val);
17361 * Details about the first direction of a channel
17363 struct LDKDirectionalChannelInfo ChannelInfo_get_one_to_two(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
17366 * Details about the first direction of a channel
17368 void ChannelInfo_set_one_to_two(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKDirectionalChannelInfo val);
17371 * Source node of the second direction of a channel
17373 struct LDKPublicKey ChannelInfo_get_node_two(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
17376 * Source node of the second direction of a channel
17378 void ChannelInfo_set_node_two(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKPublicKey val);
17381 * Details about the second direction of a channel
17383 struct LDKDirectionalChannelInfo ChannelInfo_get_two_to_one(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
17386 * Details about the second direction of a channel
17388 void ChannelInfo_set_two_to_one(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKDirectionalChannelInfo val);
17391 * The channel capacity as seen on-chain, if chain lookup is available.
17393 struct LDKCOption_u64Z ChannelInfo_get_capacity_sats(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
17396 * The channel capacity as seen on-chain, if chain lookup is available.
17398 void ChannelInfo_set_capacity_sats(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
17401 * An initial announcement of the channel
17402 * Mostly redundant with the data we store in fields explicitly.
17403 * Everything else is useful only for sending out for initial routing sync.
17404 * Not stored if contains excess data to prevent DoS.
17406 struct LDKChannelAnnouncement ChannelInfo_get_announcement_message(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
17409 * An initial announcement of the channel
17410 * Mostly redundant with the data we store in fields explicitly.
17411 * Everything else is useful only for sending out for initial routing sync.
17412 * Not stored if contains excess data to prevent DoS.
17414 void ChannelInfo_set_announcement_message(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelAnnouncement val);
17417 * Constructs a new ChannelInfo given each field
17419 MUST_USE_RES struct LDKChannelInfo ChannelInfo_new(struct LDKChannelFeatures features_arg, struct LDKPublicKey node_one_arg, struct LDKDirectionalChannelInfo one_to_two_arg, struct LDKPublicKey node_two_arg, struct LDKDirectionalChannelInfo two_to_one_arg, struct LDKCOption_u64Z capacity_sats_arg, struct LDKChannelAnnouncement announcement_message_arg);
17422 * Creates a copy of the ChannelInfo
17424 struct LDKChannelInfo ChannelInfo_clone(const struct LDKChannelInfo *NONNULL_PTR orig);
17427 * Serialize the ChannelInfo object into a byte array which can be read by ChannelInfo_read
17429 struct LDKCVec_u8Z ChannelInfo_write(const struct LDKChannelInfo *NONNULL_PTR obj);
17432 * Read a ChannelInfo from a byte array, created by ChannelInfo_write
17434 struct LDKCResult_ChannelInfoDecodeErrorZ ChannelInfo_read(struct LDKu8slice ser);
17437 * Frees any resources used by the RoutingFees, if is_owned is set and inner is non-NULL.
17439 void RoutingFees_free(struct LDKRoutingFees this_obj);
17442 * Flat routing fee in satoshis
17444 uint32_t RoutingFees_get_base_msat(const struct LDKRoutingFees *NONNULL_PTR this_ptr);
17447 * Flat routing fee in satoshis
17449 void RoutingFees_set_base_msat(struct LDKRoutingFees *NONNULL_PTR this_ptr, uint32_t val);
17452 * Liquidity-based routing fee in millionths of a routed amount.
17453 * In other words, 10000 is 1%.
17455 uint32_t RoutingFees_get_proportional_millionths(const struct LDKRoutingFees *NONNULL_PTR this_ptr);
17458 * Liquidity-based routing fee in millionths of a routed amount.
17459 * In other words, 10000 is 1%.
17461 void RoutingFees_set_proportional_millionths(struct LDKRoutingFees *NONNULL_PTR this_ptr, uint32_t val);
17464 * Constructs a new RoutingFees given each field
17466 MUST_USE_RES struct LDKRoutingFees RoutingFees_new(uint32_t base_msat_arg, uint32_t proportional_millionths_arg);
17469 * Checks if two RoutingFeess contain equal inner contents.
17470 * This ignores pointers and is_owned flags and looks at the values in fields.
17471 * Two objects with NULL inner values will be considered "equal" here.
17473 bool RoutingFees_eq(const struct LDKRoutingFees *NONNULL_PTR a, const struct LDKRoutingFees *NONNULL_PTR b);
17476 * Creates a copy of the RoutingFees
17478 struct LDKRoutingFees RoutingFees_clone(const struct LDKRoutingFees *NONNULL_PTR orig);
17481 * Serialize the RoutingFees object into a byte array which can be read by RoutingFees_read
17483 struct LDKCVec_u8Z RoutingFees_write(const struct LDKRoutingFees *NONNULL_PTR obj);
17486 * Read a RoutingFees from a byte array, created by RoutingFees_write
17488 struct LDKCResult_RoutingFeesDecodeErrorZ RoutingFees_read(struct LDKu8slice ser);
17491 * Frees any resources used by the NodeAnnouncementInfo, if is_owned is set and inner is non-NULL.
17493 void NodeAnnouncementInfo_free(struct LDKNodeAnnouncementInfo this_obj);
17496 * Protocol features the node announced support for
17498 struct LDKNodeFeatures NodeAnnouncementInfo_get_features(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
17501 * Protocol features the node announced support for
17503 void NodeAnnouncementInfo_set_features(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
17506 * When the last known update to the node state was issued.
17507 * Value is opaque, as set in the announcement.
17509 uint32_t NodeAnnouncementInfo_get_last_update(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
17512 * When the last known update to the node state was issued.
17513 * Value is opaque, as set in the announcement.
17515 void NodeAnnouncementInfo_set_last_update(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, uint32_t val);
17518 * Color assigned to the node
17520 const uint8_t (*NodeAnnouncementInfo_get_rgb(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr))[3];
17523 * Color assigned to the node
17525 void NodeAnnouncementInfo_set_rgb(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKThreeBytes val);
17528 * Moniker assigned to the node.
17529 * May be invalid or malicious (eg control chars),
17530 * should not be exposed to the user.
17532 const uint8_t (*NodeAnnouncementInfo_get_alias(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr))[32];
17535 * Moniker assigned to the node.
17536 * May be invalid or malicious (eg control chars),
17537 * should not be exposed to the user.
17539 void NodeAnnouncementInfo_set_alias(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17542 * Internet-level addresses via which one can connect to the node
17544 void NodeAnnouncementInfo_set_addresses(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKCVec_NetAddressZ val);
17547 * An initial announcement of the node
17548 * Mostly redundant with the data we store in fields explicitly.
17549 * Everything else is useful only for sending out for initial routing sync.
17550 * Not stored if contains excess data to prevent DoS.
17552 struct LDKNodeAnnouncement NodeAnnouncementInfo_get_announcement_message(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
17555 * An initial announcement of the node
17556 * Mostly redundant with the data we store in fields explicitly.
17557 * Everything else is useful only for sending out for initial routing sync.
17558 * Not stored if contains excess data to prevent DoS.
17560 void NodeAnnouncementInfo_set_announcement_message(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKNodeAnnouncement val);
17563 * Constructs a new NodeAnnouncementInfo given each field
17565 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);
17568 * Creates a copy of the NodeAnnouncementInfo
17570 struct LDKNodeAnnouncementInfo NodeAnnouncementInfo_clone(const struct LDKNodeAnnouncementInfo *NONNULL_PTR orig);
17573 * Serialize the NodeAnnouncementInfo object into a byte array which can be read by NodeAnnouncementInfo_read
17575 struct LDKCVec_u8Z NodeAnnouncementInfo_write(const struct LDKNodeAnnouncementInfo *NONNULL_PTR obj);
17578 * Read a NodeAnnouncementInfo from a byte array, created by NodeAnnouncementInfo_write
17580 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ NodeAnnouncementInfo_read(struct LDKu8slice ser);
17583 * Frees any resources used by the NodeInfo, if is_owned is set and inner is non-NULL.
17585 void NodeInfo_free(struct LDKNodeInfo this_obj);
17588 * All valid channels a node has announced
17590 void NodeInfo_set_channels(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
17593 * Lowest fees enabling routing via any of the enabled, known channels to a node.
17594 * The two fields (flat and proportional fee) are independent,
17595 * meaning they don't have to refer to the same channel.
17597 struct LDKRoutingFees NodeInfo_get_lowest_inbound_channel_fees(const struct LDKNodeInfo *NONNULL_PTR this_ptr);
17600 * Lowest fees enabling routing via any of the enabled, known channels to a node.
17601 * The two fields (flat and proportional fee) are independent,
17602 * meaning they don't have to refer to the same channel.
17604 void NodeInfo_set_lowest_inbound_channel_fees(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
17607 * More information about a node from node_announcement.
17608 * Optional because we store a Node entry after learning about it from
17609 * a channel announcement, but before receiving a node announcement.
17611 struct LDKNodeAnnouncementInfo NodeInfo_get_announcement_info(const struct LDKNodeInfo *NONNULL_PTR this_ptr);
17614 * More information about a node from node_announcement.
17615 * Optional because we store a Node entry after learning about it from
17616 * a channel announcement, but before receiving a node announcement.
17618 void NodeInfo_set_announcement_info(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKNodeAnnouncementInfo val);
17621 * Constructs a new NodeInfo given each field
17623 MUST_USE_RES struct LDKNodeInfo NodeInfo_new(struct LDKCVec_u64Z channels_arg, struct LDKRoutingFees lowest_inbound_channel_fees_arg, struct LDKNodeAnnouncementInfo announcement_info_arg);
17626 * Creates a copy of the NodeInfo
17628 struct LDKNodeInfo NodeInfo_clone(const struct LDKNodeInfo *NONNULL_PTR orig);
17631 * Serialize the NodeInfo object into a byte array which can be read by NodeInfo_read
17633 struct LDKCVec_u8Z NodeInfo_write(const struct LDKNodeInfo *NONNULL_PTR obj);
17636 * Read a NodeInfo from a byte array, created by NodeInfo_write
17638 struct LDKCResult_NodeInfoDecodeErrorZ NodeInfo_read(struct LDKu8slice ser);
17641 * Serialize the NetworkGraph object into a byte array which can be read by NetworkGraph_read
17643 struct LDKCVec_u8Z NetworkGraph_write(const struct LDKNetworkGraph *NONNULL_PTR obj);
17646 * Read a NetworkGraph from a byte array, created by NetworkGraph_write
17648 struct LDKCResult_NetworkGraphDecodeErrorZ NetworkGraph_read(struct LDKu8slice ser);
17651 * Creates a new, empty, network graph.
17653 MUST_USE_RES struct LDKNetworkGraph NetworkGraph_new(struct LDKThirtyTwoBytes genesis_hash);
17656 * For an already known node (from channel announcements), update its stored properties from a
17657 * given node announcement.
17659 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
17660 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
17661 * routing messages from a source using a protocol other than the lightning P2P protocol.
17663 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_node_from_announcement(struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKNodeAnnouncement *NONNULL_PTR msg);
17666 * For an already known node (from channel announcements), update its stored properties from a
17667 * given node announcement without verifying the associated signatures. Because we aren't
17668 * given the associated signatures here we cannot relay the node announcement to any of our
17671 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_node_from_unsigned_announcement(struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR msg);
17674 * Store or update channel info from a channel announcement.
17676 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
17677 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
17678 * routing messages from a source using a protocol other than the lightning P2P protocol.
17680 * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
17681 * the corresponding UTXO exists on chain and is correctly-formatted.
17683 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel_from_announcement(struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKChannelAnnouncement *NONNULL_PTR msg, struct LDKAccess *chain_access);
17686 * Store or update channel info from a channel announcement without verifying the associated
17687 * signatures. Because we aren't given the associated signatures here we cannot relay the
17688 * channel announcement to any of our peers.
17690 * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
17691 * the corresponding UTXO exists on chain and is correctly-formatted.
17693 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel_from_unsigned_announcement(struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR msg, struct LDKAccess *chain_access);
17696 * Close a channel if a corresponding HTLC fail was sent.
17697 * If permanent, removes a channel from the local storage.
17698 * May cause the removal of nodes too, if this was their last channel.
17699 * If not permanent, makes channels unavailable for routing.
17701 void NetworkGraph_close_channel_from_update(struct LDKNetworkGraph *NONNULL_PTR this_arg, uint64_t short_channel_id, bool is_permanent);
17704 * For an already known (from announcement) channel, update info about one of the directions
17707 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
17708 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
17709 * routing messages from a source using a protocol other than the lightning P2P protocol.
17711 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel(struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKChannelUpdate *NONNULL_PTR msg);
17714 * For an already known (from announcement) channel, update info about one of the directions
17715 * of the channel without verifying the associated signatures. Because we aren't given the
17716 * associated signatures here we cannot relay the channel update to any of our peers.
17718 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel_unsigned(struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKUnsignedChannelUpdate *NONNULL_PTR msg);
17721 * Frees any resources used by the FilesystemPersister, if is_owned is set and inner is non-NULL.
17723 void FilesystemPersister_free(struct LDKFilesystemPersister this_obj);
17726 * Initialize a new FilesystemPersister and set the path to the individual channels'
17729 MUST_USE_RES struct LDKFilesystemPersister FilesystemPersister_new(struct LDKStr path_to_channel_data);
17732 * Get the directory which was provided when this persister was initialized.
17734 MUST_USE_RES struct LDKStr FilesystemPersister_get_data_dir(const struct LDKFilesystemPersister *NONNULL_PTR this_arg);
17737 * Writes the provided `ChannelManager` to the path provided at `FilesystemPersister`
17738 * initialization, within a file called \"manager\".
17740 MUST_USE_RES struct LDKCResult_NoneErrorZ FilesystemPersister_persist_manager(struct LDKStr data_dir, const struct LDKChannelManager *NONNULL_PTR manager);
17743 * Read `ChannelMonitor`s from disk.
17745 MUST_USE_RES struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ FilesystemPersister_read_channelmonitors(const struct LDKFilesystemPersister *NONNULL_PTR this_arg, struct LDKKeysInterface keys_manager);
17748 * Constructs a new Persist which calls the relevant methods on this_arg.
17749 * This copies the `inner` pointer in this_arg and thus the returned Persist must be freed before this_arg is
17751 struct LDKPersist FilesystemPersister_as_Persist(const struct LDKFilesystemPersister *NONNULL_PTR this_arg);
17754 * Frees any resources used by the BackgroundProcessor, if is_owned is set and inner is non-NULL.
17756 void BackgroundProcessor_free(struct LDKBackgroundProcessor this_obj);
17759 * Calls the free function if one is set
17761 void ChannelManagerPersister_free(struct LDKChannelManagerPersister this_ptr);
17764 * Start a background thread that takes care of responsibilities enumerated in the top-level
17767 * If `persist_manager` returns an error, then this thread will return said error (and
17768 * `start()` will need to be called again to restart the `BackgroundProcessor`). Users should
17769 * wait on [`thread_handle`]'s `join()` method to be able to tell if and when an error is
17770 * returned, or implement `persist_manager` such that an error is never returned to the
17771 * `BackgroundProcessor`
17773 * `persist_manager` is responsible for writing out the [`ChannelManager`] to disk, and/or
17774 * uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
17775 * [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
17776 * provided implementation.
17778 * [`thread_handle`]: BackgroundProcessor::thread_handle
17779 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
17780 * [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
17781 * [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
17783 MUST_USE_RES struct LDKBackgroundProcessor BackgroundProcessor_start(struct LDKChannelManagerPersister persister, struct LDKEventHandler event_handler, const struct LDKChainMonitor *NONNULL_PTR chain_monitor, const struct LDKChannelManager *NONNULL_PTR channel_manager, const struct LDKPeerManager *NONNULL_PTR peer_manager, struct LDKLogger logger);
17786 * Stop `BackgroundProcessor`'s thread.
17788 MUST_USE_RES struct LDKCResult_NoneErrorZ BackgroundProcessor_stop(struct LDKBackgroundProcessor this_arg);
17791 * **Call this function on startup to ensure that all assumptions about the platform are valid.**
17793 * Unfortunately we have to make assumptions about the upper bounds of the `SystemTime` type on
17794 * your platform which we can't fully verify at compile time and which isn't part of it's contract.
17795 * To our best knowledge our assumptions hold for all platforms officially supported by rust, but
17796 * since this check is fast we recommend to do it anyway.
17798 * If this function fails this is considered a bug. Please open an issue describing your
17799 * platform and stating your current system time.
17802 * If the check fails this function panics. By calling this function on startup you ensure that
17803 * this wont happen at an arbitrary later point in time.
17805 void check_platform(void);
17808 * Frees any resources used by the Invoice, if is_owned is set and inner is non-NULL.
17810 void Invoice_free(struct LDKInvoice this_obj);
17813 * Checks if two Invoices contain equal inner contents.
17814 * This ignores pointers and is_owned flags and looks at the values in fields.
17815 * Two objects with NULL inner values will be considered "equal" here.
17817 bool Invoice_eq(const struct LDKInvoice *NONNULL_PTR a, const struct LDKInvoice *NONNULL_PTR b);
17820 * Creates a copy of the Invoice
17822 struct LDKInvoice Invoice_clone(const struct LDKInvoice *NONNULL_PTR orig);
17825 * Frees any resources used by the SignedRawInvoice, if is_owned is set and inner is non-NULL.
17827 void SignedRawInvoice_free(struct LDKSignedRawInvoice this_obj);
17830 * Checks if two SignedRawInvoices contain equal inner contents.
17831 * This ignores pointers and is_owned flags and looks at the values in fields.
17832 * Two objects with NULL inner values will be considered "equal" here.
17834 bool SignedRawInvoice_eq(const struct LDKSignedRawInvoice *NONNULL_PTR a, const struct LDKSignedRawInvoice *NONNULL_PTR b);
17837 * Creates a copy of the SignedRawInvoice
17839 struct LDKSignedRawInvoice SignedRawInvoice_clone(const struct LDKSignedRawInvoice *NONNULL_PTR orig);
17842 * Frees any resources used by the RawInvoice, if is_owned is set and inner is non-NULL.
17844 void RawInvoice_free(struct LDKRawInvoice this_obj);
17849 struct LDKRawDataPart RawInvoice_get_data(const struct LDKRawInvoice *NONNULL_PTR this_ptr);
17854 void RawInvoice_set_data(struct LDKRawInvoice *NONNULL_PTR this_ptr, struct LDKRawDataPart val);
17857 * Checks if two RawInvoices contain equal inner contents.
17858 * This ignores pointers and is_owned flags and looks at the values in fields.
17859 * Two objects with NULL inner values will be considered "equal" here.
17861 bool RawInvoice_eq(const struct LDKRawInvoice *NONNULL_PTR a, const struct LDKRawInvoice *NONNULL_PTR b);
17864 * Creates a copy of the RawInvoice
17866 struct LDKRawInvoice RawInvoice_clone(const struct LDKRawInvoice *NONNULL_PTR orig);
17869 * Frees any resources used by the RawDataPart, if is_owned is set and inner is non-NULL.
17871 void RawDataPart_free(struct LDKRawDataPart this_obj);
17874 * generation time of the invoice
17876 struct LDKPositiveTimestamp RawDataPart_get_timestamp(const struct LDKRawDataPart *NONNULL_PTR this_ptr);
17879 * generation time of the invoice
17881 void RawDataPart_set_timestamp(struct LDKRawDataPart *NONNULL_PTR this_ptr, struct LDKPositiveTimestamp val);
17884 * Checks if two RawDataParts contain equal inner contents.
17885 * This ignores pointers and is_owned flags and looks at the values in fields.
17886 * Two objects with NULL inner values will be considered "equal" here.
17888 bool RawDataPart_eq(const struct LDKRawDataPart *NONNULL_PTR a, const struct LDKRawDataPart *NONNULL_PTR b);
17891 * Creates a copy of the RawDataPart
17893 struct LDKRawDataPart RawDataPart_clone(const struct LDKRawDataPart *NONNULL_PTR orig);
17896 * Frees any resources used by the PositiveTimestamp, if is_owned is set and inner is non-NULL.
17898 void PositiveTimestamp_free(struct LDKPositiveTimestamp this_obj);
17901 * Checks if two PositiveTimestamps contain equal inner contents.
17902 * This ignores pointers and is_owned flags and looks at the values in fields.
17903 * Two objects with NULL inner values will be considered "equal" here.
17905 bool PositiveTimestamp_eq(const struct LDKPositiveTimestamp *NONNULL_PTR a, const struct LDKPositiveTimestamp *NONNULL_PTR b);
17908 * Creates a copy of the PositiveTimestamp
17910 struct LDKPositiveTimestamp PositiveTimestamp_clone(const struct LDKPositiveTimestamp *NONNULL_PTR orig);
17913 * Creates a copy of the SiPrefix
17915 enum LDKSiPrefix SiPrefix_clone(const enum LDKSiPrefix *NONNULL_PTR orig);
17918 * Checks if two SiPrefixs contain equal inner contents.
17919 * This ignores pointers and is_owned flags and looks at the values in fields.
17921 bool SiPrefix_eq(const enum LDKSiPrefix *NONNULL_PTR a, const enum LDKSiPrefix *NONNULL_PTR b);
17924 * Returns the multiplier to go from a BTC value to picoBTC implied by this SiPrefix.
17925 * This is effectively 10^12 * the prefix multiplier
17927 MUST_USE_RES uint64_t SiPrefix_multiplier(const enum LDKSiPrefix *NONNULL_PTR this_arg);
17930 * Creates a copy of the Currency
17932 enum LDKCurrency Currency_clone(const enum LDKCurrency *NONNULL_PTR orig);
17935 * Checks if two Currencys contain equal inner contents.
17936 * This ignores pointers and is_owned flags and looks at the values in fields.
17938 bool Currency_eq(const enum LDKCurrency *NONNULL_PTR a, const enum LDKCurrency *NONNULL_PTR b);
17941 * Frees any resources used by the Sha256, if is_owned is set and inner is non-NULL.
17943 void Sha256_free(struct LDKSha256 this_obj);
17946 * Checks if two Sha256s contain equal inner contents.
17947 * This ignores pointers and is_owned flags and looks at the values in fields.
17948 * Two objects with NULL inner values will be considered "equal" here.
17950 bool Sha256_eq(const struct LDKSha256 *NONNULL_PTR a, const struct LDKSha256 *NONNULL_PTR b);
17953 * Creates a copy of the Sha256
17955 struct LDKSha256 Sha256_clone(const struct LDKSha256 *NONNULL_PTR orig);
17958 * Frees any resources used by the Description, if is_owned is set and inner is non-NULL.
17960 void Description_free(struct LDKDescription this_obj);
17963 * Checks if two Descriptions contain equal inner contents.
17964 * This ignores pointers and is_owned flags and looks at the values in fields.
17965 * Two objects with NULL inner values will be considered "equal" here.
17967 bool Description_eq(const struct LDKDescription *NONNULL_PTR a, const struct LDKDescription *NONNULL_PTR b);
17970 * Creates a copy of the Description
17972 struct LDKDescription Description_clone(const struct LDKDescription *NONNULL_PTR orig);
17975 * Frees any resources used by the PayeePubKey, if is_owned is set and inner is non-NULL.
17977 void PayeePubKey_free(struct LDKPayeePubKey this_obj);
17980 * Checks if two PayeePubKeys contain equal inner contents.
17981 * This ignores pointers and is_owned flags and looks at the values in fields.
17982 * Two objects with NULL inner values will be considered "equal" here.
17984 bool PayeePubKey_eq(const struct LDKPayeePubKey *NONNULL_PTR a, const struct LDKPayeePubKey *NONNULL_PTR b);
17987 * Creates a copy of the PayeePubKey
17989 struct LDKPayeePubKey PayeePubKey_clone(const struct LDKPayeePubKey *NONNULL_PTR orig);
17992 * Frees any resources used by the ExpiryTime, if is_owned is set and inner is non-NULL.
17994 void ExpiryTime_free(struct LDKExpiryTime this_obj);
17997 * Checks if two ExpiryTimes contain equal inner contents.
17998 * This ignores pointers and is_owned flags and looks at the values in fields.
17999 * Two objects with NULL inner values will be considered "equal" here.
18001 bool ExpiryTime_eq(const struct LDKExpiryTime *NONNULL_PTR a, const struct LDKExpiryTime *NONNULL_PTR b);
18004 * Creates a copy of the ExpiryTime
18006 struct LDKExpiryTime ExpiryTime_clone(const struct LDKExpiryTime *NONNULL_PTR orig);
18009 * Frees any resources used by the MinFinalCltvExpiry, if is_owned is set and inner is non-NULL.
18011 void MinFinalCltvExpiry_free(struct LDKMinFinalCltvExpiry this_obj);
18014 * Checks if two MinFinalCltvExpirys contain equal inner contents.
18015 * This ignores pointers and is_owned flags and looks at the values in fields.
18016 * Two objects with NULL inner values will be considered "equal" here.
18018 bool MinFinalCltvExpiry_eq(const struct LDKMinFinalCltvExpiry *NONNULL_PTR a, const struct LDKMinFinalCltvExpiry *NONNULL_PTR b);
18021 * Creates a copy of the MinFinalCltvExpiry
18023 struct LDKMinFinalCltvExpiry MinFinalCltvExpiry_clone(const struct LDKMinFinalCltvExpiry *NONNULL_PTR orig);
18026 * Frees any resources used by the Fallback
18028 void Fallback_free(struct LDKFallback this_ptr);
18031 * Creates a copy of the Fallback
18033 struct LDKFallback Fallback_clone(const struct LDKFallback *NONNULL_PTR orig);
18036 * Checks if two Fallbacks contain equal inner contents.
18037 * This ignores pointers and is_owned flags and looks at the values in fields.
18039 bool Fallback_eq(const struct LDKFallback *NONNULL_PTR a, const struct LDKFallback *NONNULL_PTR b);
18042 * Frees any resources used by the InvoiceSignature, if is_owned is set and inner is non-NULL.
18044 void InvoiceSignature_free(struct LDKInvoiceSignature this_obj);
18047 * Checks if two InvoiceSignatures contain equal inner contents.
18048 * This ignores pointers and is_owned flags and looks at the values in fields.
18049 * Two objects with NULL inner values will be considered "equal" here.
18051 bool InvoiceSignature_eq(const struct LDKInvoiceSignature *NONNULL_PTR a, const struct LDKInvoiceSignature *NONNULL_PTR b);
18054 * Creates a copy of the InvoiceSignature
18056 struct LDKInvoiceSignature InvoiceSignature_clone(const struct LDKInvoiceSignature *NONNULL_PTR orig);
18059 * Frees any resources used by the RouteHint, if is_owned is set and inner is non-NULL.
18061 void RouteHint_free(struct LDKRouteHint this_obj);
18064 * Checks if two RouteHints contain equal inner contents.
18065 * This ignores pointers and is_owned flags and looks at the values in fields.
18066 * Two objects with NULL inner values will be considered "equal" here.
18068 bool RouteHint_eq(const struct LDKRouteHint *NONNULL_PTR a, const struct LDKRouteHint *NONNULL_PTR b);
18071 * Creates a copy of the RouteHint
18073 struct LDKRouteHint RouteHint_clone(const struct LDKRouteHint *NONNULL_PTR orig);
18076 * Disassembles the `SignedRawInvoice` into its three parts:
18078 * 2. hash of the raw invoice
18081 MUST_USE_RES struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ SignedRawInvoice_into_parts(struct LDKSignedRawInvoice this_arg);
18084 * The `RawInvoice` which was signed.
18086 MUST_USE_RES struct LDKRawInvoice SignedRawInvoice_raw_invoice(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
18089 * The hash of the `RawInvoice` that was signed.
18091 MUST_USE_RES const uint8_t (*SignedRawInvoice_hash(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg))[32];
18094 * InvoiceSignature for the invoice.
18096 MUST_USE_RES struct LDKInvoiceSignature SignedRawInvoice_signature(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
18099 * Recovers the public key used for signing the invoice from the recoverable signature.
18101 MUST_USE_RES struct LDKCResult_PayeePubKeyErrorZ SignedRawInvoice_recover_payee_pub_key(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
18104 * Checks if the signature is valid for the included payee public key or if none exists if it's
18105 * valid for the recovered signature (which should always be true?).
18107 MUST_USE_RES bool SignedRawInvoice_check_signature(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
18110 * Calculate the hash of the encoded `RawInvoice`
18112 MUST_USE_RES struct LDKThirtyTwoBytes RawInvoice_hash(const struct LDKRawInvoice *NONNULL_PTR this_arg);
18114 MUST_USE_RES struct LDKSha256 RawInvoice_payment_hash(const struct LDKRawInvoice *NONNULL_PTR this_arg);
18116 MUST_USE_RES struct LDKDescription RawInvoice_description(const struct LDKRawInvoice *NONNULL_PTR this_arg);
18118 MUST_USE_RES struct LDKPayeePubKey RawInvoice_payee_pub_key(const struct LDKRawInvoice *NONNULL_PTR this_arg);
18120 MUST_USE_RES struct LDKSha256 RawInvoice_description_hash(const struct LDKRawInvoice *NONNULL_PTR this_arg);
18122 MUST_USE_RES struct LDKExpiryTime RawInvoice_expiry_time(const struct LDKRawInvoice *NONNULL_PTR this_arg);
18124 MUST_USE_RES struct LDKMinFinalCltvExpiry RawInvoice_min_final_cltv_expiry(const struct LDKRawInvoice *NONNULL_PTR this_arg);
18126 MUST_USE_RES struct LDKThirtyTwoBytes RawInvoice_payment_secret(const struct LDKRawInvoice *NONNULL_PTR this_arg);
18128 MUST_USE_RES struct LDKInvoiceFeatures RawInvoice_features(const struct LDKRawInvoice *NONNULL_PTR this_arg);
18130 MUST_USE_RES struct LDKCVec_RouteHintZ RawInvoice_routes(const struct LDKRawInvoice *NONNULL_PTR this_arg);
18132 MUST_USE_RES struct LDKCOption_u64Z RawInvoice_amount_pico_btc(const struct LDKRawInvoice *NONNULL_PTR this_arg);
18134 MUST_USE_RES enum LDKCurrency RawInvoice_currency(const struct LDKRawInvoice *NONNULL_PTR this_arg);
18137 * Create a new `PositiveTimestamp` from a unix timestamp in the Range
18138 * `0...SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME`, otherwise return a
18139 * `CreationError::TimestampOutOfBounds`.
18141 MUST_USE_RES struct LDKCResult_PositiveTimestampCreationErrorZ PositiveTimestamp_from_unix_timestamp(uint64_t unix_seconds);
18144 * Create a new `PositiveTimestamp` from a `SystemTime` with a corresponding unix timestamp in
18145 * the Range `0...SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME`, otherwise return a
18146 * `CreationError::TimestampOutOfBounds`.
18148 MUST_USE_RES struct LDKCResult_PositiveTimestampCreationErrorZ PositiveTimestamp_from_system_time(uint64_t time);
18151 * Returns the UNIX timestamp representing the stored time
18153 MUST_USE_RES uint64_t PositiveTimestamp_as_unix_timestamp(const struct LDKPositiveTimestamp *NONNULL_PTR this_arg);
18156 * Returns a reference to the internal `SystemTime` time representation
18158 MUST_USE_RES uint64_t PositiveTimestamp_as_time(const struct LDKPositiveTimestamp *NONNULL_PTR this_arg);
18161 * Transform the `Invoice` into it's unchecked version
18163 MUST_USE_RES struct LDKSignedRawInvoice Invoice_into_signed_raw(struct LDKInvoice this_arg);
18166 * Check that the invoice is signed correctly and that key recovery works
18168 MUST_USE_RES struct LDKCResult_NoneSemanticErrorZ Invoice_check_signature(const struct LDKInvoice *NONNULL_PTR this_arg);
18171 * Constructs an `Invoice` from a `SignedInvoice` by checking all its invariants.
18173 * use lightning_invoice::*;
18175 * let invoice = \"lnbc1pvjluezpp5qqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqqqsyqcyq5rqwzqfqypqdp\\
18176 * \tl2pkx2ctnv5sxxmmwwd5kgetjypeh2ursdae8g6twvus8g6rfwvs8qun0dfjkxaq8rkx3yf5tcsyz3d7\\
18177 * \t3gafnh3cax9rn449d9p5uxz9ezhhypd0elx87sjle52x86fux2ypatgddc6k63n7erqz25le42c4u4ec\\
18178 * \tky03ylcqca784w\";
18180 * let signed = invoice.parse::<SignedRawInvoice>().unwrap();
18182 * assert!(Invoice::from_signed(signed).is_ok());
18185 MUST_USE_RES struct LDKCResult_InvoiceSemanticErrorZ Invoice_from_signed(struct LDKSignedRawInvoice signed_invoice);
18188 * Returns the `Invoice`'s timestamp (should equal it's creation time)
18190 MUST_USE_RES uint64_t Invoice_timestamp(const struct LDKInvoice *NONNULL_PTR this_arg);
18193 * Returns the hash to which we will receive the preimage on completion of the payment
18195 MUST_USE_RES const uint8_t (*Invoice_payment_hash(const struct LDKInvoice *NONNULL_PTR this_arg))[32];
18198 * Get the payee's public key if one was included in the invoice
18200 MUST_USE_RES struct LDKPublicKey Invoice_payee_pub_key(const struct LDKInvoice *NONNULL_PTR this_arg);
18203 * Get the payment secret if one was included in the invoice
18205 MUST_USE_RES struct LDKThirtyTwoBytes Invoice_payment_secret(const struct LDKInvoice *NONNULL_PTR this_arg);
18208 * Get the invoice features if they were included in the invoice
18210 MUST_USE_RES struct LDKInvoiceFeatures Invoice_features(const struct LDKInvoice *NONNULL_PTR this_arg);
18213 * Recover the payee's public key (only to be used if none was included in the invoice)
18215 MUST_USE_RES struct LDKPublicKey Invoice_recover_payee_pub_key(const struct LDKInvoice *NONNULL_PTR this_arg);
18218 * Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
18220 MUST_USE_RES uint64_t Invoice_expiry_time(const struct LDKInvoice *NONNULL_PTR this_arg);
18223 * Returns the invoice's `min_final_cltv_expiry` time, if present, otherwise
18224 * [`DEFAULT_MIN_FINAL_CLTV_EXPIRY`].
18226 MUST_USE_RES uint64_t Invoice_min_final_cltv_expiry(const struct LDKInvoice *NONNULL_PTR this_arg);
18229 * Returns a list of all routes included in the invoice
18231 MUST_USE_RES struct LDKCVec_RouteHintZ Invoice_routes(const struct LDKInvoice *NONNULL_PTR this_arg);
18234 * Returns the currency for which the invoice was issued
18236 MUST_USE_RES enum LDKCurrency Invoice_currency(const struct LDKInvoice *NONNULL_PTR this_arg);
18239 * Returns the amount if specified in the invoice as pico <currency>.
18241 MUST_USE_RES struct LDKCOption_u64Z Invoice_amount_pico_btc(const struct LDKInvoice *NONNULL_PTR this_arg);
18244 * Creates a new `Description` if `description` is at most 1023 __bytes__ long,
18245 * returns `CreationError::DescriptionTooLong` otherwise
18247 * Please note that single characters may use more than one byte due to UTF8 encoding.
18249 MUST_USE_RES struct LDKCResult_DescriptionCreationErrorZ Description_new(struct LDKStr description);
18252 * Returns the underlying description `String`
18254 MUST_USE_RES struct LDKStr Description_into_inner(struct LDKDescription this_arg);
18257 * Construct an `ExpiryTime` from seconds. If there exists a `PositiveTimestamp` which would
18258 * overflow on adding the `EpiryTime` to it then this function will return a
18259 * `CreationError::ExpiryTimeOutOfBounds`.
18261 MUST_USE_RES struct LDKCResult_ExpiryTimeCreationErrorZ ExpiryTime_from_seconds(uint64_t seconds);
18264 * Construct an `ExpiryTime` from a `Duration`. If there exists a `PositiveTimestamp` which
18265 * would overflow on adding the `EpiryTime` to it then this function will return a
18266 * `CreationError::ExpiryTimeOutOfBounds`.
18268 MUST_USE_RES struct LDKCResult_ExpiryTimeCreationErrorZ ExpiryTime_from_duration(uint64_t duration);
18271 * Returns the expiry time in seconds
18273 MUST_USE_RES uint64_t ExpiryTime_as_seconds(const struct LDKExpiryTime *NONNULL_PTR this_arg);
18276 * Returns a reference to the underlying `Duration` (=expiry time)
18278 MUST_USE_RES uint64_t ExpiryTime_as_duration(const struct LDKExpiryTime *NONNULL_PTR this_arg);
18281 * Create a new (partial) route from a list of hops
18283 MUST_USE_RES struct LDKCResult_RouteHintCreationErrorZ RouteHint_new(struct LDKCVec_RouteHintHopZ hops);
18286 * Returrn the underlying vector of hops
18288 MUST_USE_RES struct LDKCVec_RouteHintHopZ RouteHint_into_inner(struct LDKRouteHint this_arg);
18291 * Creates a copy of the CreationError
18293 enum LDKCreationError CreationError_clone(const enum LDKCreationError *NONNULL_PTR orig);
18296 * Checks if two CreationErrors contain equal inner contents.
18297 * This ignores pointers and is_owned flags and looks at the values in fields.
18299 bool CreationError_eq(const enum LDKCreationError *NONNULL_PTR a, const enum LDKCreationError *NONNULL_PTR b);
18302 * Get the string representation of a CreationError object
18304 struct LDKStr CreationError_to_str(const enum LDKCreationError *NONNULL_PTR o);
18307 * Creates a copy of the SemanticError
18309 enum LDKSemanticError SemanticError_clone(const enum LDKSemanticError *NONNULL_PTR orig);
18312 * Checks if two SemanticErrors contain equal inner contents.
18313 * This ignores pointers and is_owned flags and looks at the values in fields.
18315 bool SemanticError_eq(const enum LDKSemanticError *NONNULL_PTR a, const enum LDKSemanticError *NONNULL_PTR b);
18318 * Get the string representation of a SemanticError object
18320 struct LDKStr SemanticError_to_str(const enum LDKSemanticError *NONNULL_PTR o);
18323 * Frees any resources used by the SignOrCreationError
18325 void SignOrCreationError_free(struct LDKSignOrCreationError this_ptr);
18328 * Creates a copy of the SignOrCreationError
18330 struct LDKSignOrCreationError SignOrCreationError_clone(const struct LDKSignOrCreationError *NONNULL_PTR orig);
18333 * Checks if two SignOrCreationErrors contain equal inner contents.
18334 * This ignores pointers and is_owned flags and looks at the values in fields.
18336 bool SignOrCreationError_eq(const struct LDKSignOrCreationError *NONNULL_PTR a, const struct LDKSignOrCreationError *NONNULL_PTR b);
18339 * Get the string representation of a SignOrCreationError object
18341 struct LDKStr SignOrCreationError_to_str(const struct LDKSignOrCreationError *NONNULL_PTR o);
18344 * Utility to construct an invoice. Generally, unless you want to do something like a custom
18345 * cltv_expiry, this is what you should be using to create an invoice. The reason being, this
18346 * method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
18347 * doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
18348 * that the payment secret is valid when the invoice is paid.
18350 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);
18353 * Read a SiPrefix object from a string
18355 struct LDKCResult_SiPrefixNoneZ SiPrefix_from_str(struct LDKStr s);
18358 * Read a Invoice object from a string
18360 struct LDKCResult_InvoiceNoneZ Invoice_from_str(struct LDKStr s);
18363 * Read a SignedRawInvoice object from a string
18365 struct LDKCResult_SignedRawInvoiceNoneZ SignedRawInvoice_from_str(struct LDKStr s);
18368 * Get the string representation of a Invoice object
18370 struct LDKStr Invoice_to_str(const struct LDKInvoice *NONNULL_PTR o);
18373 * Get the string representation of a SignedRawInvoice object
18375 struct LDKStr SignedRawInvoice_to_str(const struct LDKSignedRawInvoice *NONNULL_PTR o);
18378 * Get the string representation of a Currency object
18380 struct LDKStr Currency_to_str(const enum LDKCurrency *NONNULL_PTR o);
18383 * Get the string representation of a SiPrefix object
18385 struct LDKStr SiPrefix_to_str(const enum LDKSiPrefix *NONNULL_PTR o);
18387 #endif /* LDK_C_BINDINGS_H */
18389 #include <ldk_ver.h>