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,
175 * Must be last for serialization purposes
177 LDKCurrency_Sentinel,
181 * Represents an IO Error. Note that some information is lost in the conversion from Rust.
183 typedef enum LDKIOError {
185 LDKIOError_PermissionDenied,
186 LDKIOError_ConnectionRefused,
187 LDKIOError_ConnectionReset,
188 LDKIOError_ConnectionAborted,
189 LDKIOError_NotConnected,
190 LDKIOError_AddrInUse,
191 LDKIOError_AddrNotAvailable,
192 LDKIOError_BrokenPipe,
193 LDKIOError_AlreadyExists,
194 LDKIOError_WouldBlock,
195 LDKIOError_InvalidInput,
196 LDKIOError_InvalidData,
198 LDKIOError_WriteZero,
199 LDKIOError_Interrupted,
201 LDKIOError_UnexpectedEof,
203 * Must be last for serialization purposes
209 * An enum representing the available verbosity levels of the logger.
211 typedef enum LDKLevel {
213 * Designates very low priority, often extremely verbose, information
217 * Designates lower priority information
221 * Designates useful information
225 * Designates hazardous situations
229 * Designates very serious errors
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 is missing the mandatory payment secret, which all modern lightning nodes
335 LDKSemanticError_NoPaymentSecret,
337 * The invoice contains multiple payment secrets
339 LDKSemanticError_MultiplePaymentSecrets,
341 * The invoice's features are invalid
343 LDKSemanticError_InvalidFeatures,
345 * The recovery id doesn't fit the signature/pub key
347 LDKSemanticError_InvalidRecoveryId,
349 * The invoice's signature is invalid
351 LDKSemanticError_InvalidSignature,
353 * The invoice's amount was not a whole number of millisatoshis
355 LDKSemanticError_ImpreciseAmount,
357 * Must be last for serialization purposes
359 LDKSemanticError_Sentinel,
363 * SI prefixes for the human readable part
365 typedef enum LDKSiPrefix {
383 * Must be last for serialization purposes
385 LDKSiPrefix_Sentinel,
389 * A Rust str object, ie a reference to a UTF8-valid string.
390 * This is *not* null-terminated so cannot be used directly as a C string!
392 typedef struct LDKStr {
394 * A pointer to the string's bytes, in UTF8 encoding
396 const uint8_t *chars;
398 * The number of bytes (not characters!) pointed to by `chars`
402 * Whether the data pointed to by `chars` should be freed or not.
408 * A serialized transaction, in (pointer, length) form.
410 * This type optionally owns its own memory, and thus the semantics around access change based on
411 * the `data_is_owned` flag. If `data_is_owned` is set, you must call `Transaction_free` to free
412 * the underlying buffer before the object goes out of scope. If `data_is_owned` is not set, any
413 * access to the buffer after the scope in which the object was provided to you is invalid. eg,
414 * access after you return from the call in which a `!data_is_owned` `Transaction` is provided to
415 * you would be invalid.
417 * Note that, while it may change in the future, because transactions on the Rust side are stored
418 * in a deserialized form, all `Transaction`s generated on the Rust side will have `data_is_owned`
419 * set. Similarly, while it may change in the future, all `Transaction`s you pass to Rust may have
420 * `data_is_owned` either set or unset at your discretion.
422 typedef struct LDKTransaction {
424 * The serialized transaction data.
426 * This is non-const for your convenience, an object passed to Rust is never written to.
430 * The length of the serialized transaction
434 * Whether the data pointed to by `data` should be freed or not.
440 * A dynamically-allocated array of u8s of arbitrary size.
441 * This corresponds to std::vector in C++
443 typedef struct LDKCVec_u8Z {
445 * The elements in the array.
446 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
450 * The number of elements pointed to by `data`.
456 * A transaction output including a scriptPubKey and value.
457 * This type *does* own its own memory, so must be free'd appropriately.
459 typedef struct LDKTxOut {
461 * The script_pubkey in this output
463 struct LDKCVec_u8Z script_pubkey;
465 * The value, in satoshis, of this output
471 * Represents a valid secp256k1 secret key serialized as a 32 byte array.
473 typedef struct LDKSecretKey {
475 * The bytes of the secret key
481 * The contents of CResult_SecretKeyErrorZ
483 typedef union LDKCResult_SecretKeyErrorZPtr {
485 * A pointer to the contents in the success state.
486 * Reading from this pointer when `result_ok` is not set is undefined.
488 struct LDKSecretKey *result;
490 * A pointer to the contents in the error state.
491 * Reading from this pointer when `result_ok` is set is undefined.
493 enum LDKSecp256k1Error *err;
494 } LDKCResult_SecretKeyErrorZPtr;
497 * A CResult_SecretKeyErrorZ represents the result of a fallible operation,
498 * containing a crate::c_types::SecretKey on success and a crate::c_types::Secp256k1Error on failure.
499 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
501 typedef struct LDKCResult_SecretKeyErrorZ {
503 * The contents of this CResult_SecretKeyErrorZ, accessible via either
504 * `err` or `result` depending on the state of `result_ok`.
506 union LDKCResult_SecretKeyErrorZPtr contents;
508 * Whether this CResult_SecretKeyErrorZ represents a success state.
511 } LDKCResult_SecretKeyErrorZ;
514 * Represents a valid secp256k1 public key serialized in "compressed form" as a 33 byte array.
516 typedef struct LDKPublicKey {
518 * The bytes of the public key
520 uint8_t compressed_form[33];
524 * The contents of CResult_PublicKeyErrorZ
526 typedef union LDKCResult_PublicKeyErrorZPtr {
528 * A pointer to the contents in the success state.
529 * Reading from this pointer when `result_ok` is not set is undefined.
531 struct LDKPublicKey *result;
533 * A pointer to the contents in the error state.
534 * Reading from this pointer when `result_ok` is set is undefined.
536 enum LDKSecp256k1Error *err;
537 } LDKCResult_PublicKeyErrorZPtr;
540 * A CResult_PublicKeyErrorZ represents the result of a fallible operation,
541 * containing a crate::c_types::PublicKey on success and a crate::c_types::Secp256k1Error on failure.
542 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
544 typedef struct LDKCResult_PublicKeyErrorZ {
546 * The contents of this CResult_PublicKeyErrorZ, accessible via either
547 * `err` or `result` depending on the state of `result_ok`.
549 union LDKCResult_PublicKeyErrorZPtr contents;
551 * Whether this CResult_PublicKeyErrorZ represents a success state.
554 } LDKCResult_PublicKeyErrorZ;
559 * The set of public keys which are used in the creation of one commitment transaction.
560 * These are derived from the channel base keys and per-commitment data.
562 * A broadcaster key is provided from potential broadcaster of the computed transaction.
563 * A countersignatory key is coming from a protocol participant unable to broadcast the
566 * These keys are assumed to be good, either because the code derived them from
567 * channel basepoints via the new function, or they were obtained via
568 * CommitmentTransaction.trust().keys() because we trusted the source of the
569 * pre-calculated keys.
571 typedef struct MUST_USE_STRUCT LDKTxCreationKeys {
573 * A pointer to the opaque Rust object.
574 * Nearly everywhere, inner must be non-null, however in places where
575 * the Rust equivalent takes an Option, it may be set to null to indicate None.
577 LDKnativeTxCreationKeys *inner;
579 * Indicates that this is the only struct which contains the same pointer.
580 * Rust functions which take ownership of an object provided via an argument require
581 * this to be true and invalidate the object pointed to by inner.
589 * An error in decoding a message or struct.
591 typedef struct MUST_USE_STRUCT LDKDecodeError {
593 * A pointer to the opaque Rust object.
594 * Nearly everywhere, inner must be non-null, however in places where
595 * the Rust equivalent takes an Option, it may be set to null to indicate None.
597 LDKnativeDecodeError *inner;
599 * Indicates that this is the only struct which contains the same pointer.
600 * Rust functions which take ownership of an object provided via an argument require
601 * this to be true and invalidate the object pointed to by inner.
607 * The contents of CResult_TxCreationKeysDecodeErrorZ
609 typedef union LDKCResult_TxCreationKeysDecodeErrorZPtr {
611 * A pointer to the contents in the success state.
612 * Reading from this pointer when `result_ok` is not set is undefined.
614 struct LDKTxCreationKeys *result;
616 * A pointer to the contents in the error state.
617 * Reading from this pointer when `result_ok` is set is undefined.
619 struct LDKDecodeError *err;
620 } LDKCResult_TxCreationKeysDecodeErrorZPtr;
623 * A CResult_TxCreationKeysDecodeErrorZ represents the result of a fallible operation,
624 * containing a crate::lightning::ln::chan_utils::TxCreationKeys on success and a crate::lightning::ln::msgs::DecodeError on failure.
625 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
627 typedef struct LDKCResult_TxCreationKeysDecodeErrorZ {
629 * The contents of this CResult_TxCreationKeysDecodeErrorZ, accessible via either
630 * `err` or `result` depending on the state of `result_ok`.
632 union LDKCResult_TxCreationKeysDecodeErrorZPtr contents;
634 * Whether this CResult_TxCreationKeysDecodeErrorZ represents a success state.
637 } LDKCResult_TxCreationKeysDecodeErrorZ;
642 * One counterparty's public keys which do not change over the life of a channel.
644 typedef struct MUST_USE_STRUCT LDKChannelPublicKeys {
646 * A pointer to the opaque Rust object.
647 * Nearly everywhere, inner must be non-null, however in places where
648 * the Rust equivalent takes an Option, it may be set to null to indicate None.
650 LDKnativeChannelPublicKeys *inner;
652 * Indicates that this is the only struct which contains the same pointer.
653 * Rust functions which take ownership of an object provided via an argument require
654 * this to be true and invalidate the object pointed to by inner.
657 } LDKChannelPublicKeys;
660 * The contents of CResult_ChannelPublicKeysDecodeErrorZ
662 typedef union LDKCResult_ChannelPublicKeysDecodeErrorZPtr {
664 * A pointer to the contents in the success state.
665 * Reading from this pointer when `result_ok` is not set is undefined.
667 struct LDKChannelPublicKeys *result;
669 * A pointer to the contents in the error state.
670 * Reading from this pointer when `result_ok` is set is undefined.
672 struct LDKDecodeError *err;
673 } LDKCResult_ChannelPublicKeysDecodeErrorZPtr;
676 * A CResult_ChannelPublicKeysDecodeErrorZ represents the result of a fallible operation,
677 * containing a crate::lightning::ln::chan_utils::ChannelPublicKeys on success and a crate::lightning::ln::msgs::DecodeError on failure.
678 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
680 typedef struct LDKCResult_ChannelPublicKeysDecodeErrorZ {
682 * The contents of this CResult_ChannelPublicKeysDecodeErrorZ, accessible via either
683 * `err` or `result` depending on the state of `result_ok`.
685 union LDKCResult_ChannelPublicKeysDecodeErrorZPtr contents;
687 * Whether this CResult_ChannelPublicKeysDecodeErrorZ represents a success state.
690 } LDKCResult_ChannelPublicKeysDecodeErrorZ;
693 * The contents of CResult_TxCreationKeysErrorZ
695 typedef union LDKCResult_TxCreationKeysErrorZPtr {
697 * A pointer to the contents in the success state.
698 * Reading from this pointer when `result_ok` is not set is undefined.
700 struct LDKTxCreationKeys *result;
702 * A pointer to the contents in the error state.
703 * Reading from this pointer when `result_ok` is set is undefined.
705 enum LDKSecp256k1Error *err;
706 } LDKCResult_TxCreationKeysErrorZPtr;
709 * A CResult_TxCreationKeysErrorZ represents the result of a fallible operation,
710 * containing a crate::lightning::ln::chan_utils::TxCreationKeys on success and a crate::c_types::Secp256k1Error on failure.
711 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
713 typedef struct LDKCResult_TxCreationKeysErrorZ {
715 * The contents of this CResult_TxCreationKeysErrorZ, accessible via either
716 * `err` or `result` depending on the state of `result_ok`.
718 union LDKCResult_TxCreationKeysErrorZPtr contents;
720 * Whether this CResult_TxCreationKeysErrorZ represents a success state.
723 } LDKCResult_TxCreationKeysErrorZ;
726 * An enum which can either contain a u32 or not
728 typedef enum LDKCOption_u32Z_Tag {
730 * When we're in this state, this COption_u32Z contains a u32
732 LDKCOption_u32Z_Some,
734 * When we're in this state, this COption_u32Z contains nothing
736 LDKCOption_u32Z_None,
738 * Must be last for serialization purposes
740 LDKCOption_u32Z_Sentinel,
741 } LDKCOption_u32Z_Tag;
743 typedef struct LDKCOption_u32Z {
744 LDKCOption_u32Z_Tag tag;
755 * Information about an HTLC as it appears in a commitment transaction
757 typedef struct MUST_USE_STRUCT LDKHTLCOutputInCommitment {
759 * A pointer to the opaque Rust object.
760 * Nearly everywhere, inner must be non-null, however in places where
761 * the Rust equivalent takes an Option, it may be set to null to indicate None.
763 LDKnativeHTLCOutputInCommitment *inner;
765 * Indicates that this is the only struct which contains the same pointer.
766 * Rust functions which take ownership of an object provided via an argument require
767 * this to be true and invalidate the object pointed to by inner.
770 } LDKHTLCOutputInCommitment;
773 * The contents of CResult_HTLCOutputInCommitmentDecodeErrorZ
775 typedef union LDKCResult_HTLCOutputInCommitmentDecodeErrorZPtr {
777 * A pointer to the contents in the success state.
778 * Reading from this pointer when `result_ok` is not set is undefined.
780 struct LDKHTLCOutputInCommitment *result;
782 * A pointer to the contents in the error state.
783 * Reading from this pointer when `result_ok` is set is undefined.
785 struct LDKDecodeError *err;
786 } LDKCResult_HTLCOutputInCommitmentDecodeErrorZPtr;
789 * A CResult_HTLCOutputInCommitmentDecodeErrorZ represents the result of a fallible operation,
790 * containing a crate::lightning::ln::chan_utils::HTLCOutputInCommitment on success and a crate::lightning::ln::msgs::DecodeError on failure.
791 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
793 typedef struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ {
795 * The contents of this CResult_HTLCOutputInCommitmentDecodeErrorZ, accessible via either
796 * `err` or `result` depending on the state of `result_ok`.
798 union LDKCResult_HTLCOutputInCommitmentDecodeErrorZPtr contents;
800 * Whether this CResult_HTLCOutputInCommitmentDecodeErrorZ represents a success state.
803 } LDKCResult_HTLCOutputInCommitmentDecodeErrorZ;
808 * Late-bound per-channel counterparty data used to build transactions.
810 typedef struct MUST_USE_STRUCT LDKCounterpartyChannelTransactionParameters {
812 * A pointer to the opaque Rust object.
813 * Nearly everywhere, inner must be non-null, however in places where
814 * the Rust equivalent takes an Option, it may be set to null to indicate None.
816 LDKnativeCounterpartyChannelTransactionParameters *inner;
818 * Indicates that this is the only struct which contains the same pointer.
819 * Rust functions which take ownership of an object provided via an argument require
820 * this to be true and invalidate the object pointed to by inner.
823 } LDKCounterpartyChannelTransactionParameters;
826 * The contents of CResult_CounterpartyChannelTransactionParametersDecodeErrorZ
828 typedef union LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZPtr {
830 * A pointer to the contents in the success state.
831 * Reading from this pointer when `result_ok` is not set is undefined.
833 struct LDKCounterpartyChannelTransactionParameters *result;
835 * A pointer to the contents in the error state.
836 * Reading from this pointer when `result_ok` is set is undefined.
838 struct LDKDecodeError *err;
839 } LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZPtr;
842 * A CResult_CounterpartyChannelTransactionParametersDecodeErrorZ represents the result of a fallible operation,
843 * containing a crate::lightning::ln::chan_utils::CounterpartyChannelTransactionParameters on success and a crate::lightning::ln::msgs::DecodeError on failure.
844 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
846 typedef struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ {
848 * The contents of this CResult_CounterpartyChannelTransactionParametersDecodeErrorZ, accessible via either
849 * `err` or `result` depending on the state of `result_ok`.
851 union LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZPtr contents;
853 * Whether this CResult_CounterpartyChannelTransactionParametersDecodeErrorZ represents a success state.
856 } LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ;
861 * Per-channel data used to build transactions in conjunction with the per-commitment data (CommitmentTransaction).
862 * The fields are organized by holder/counterparty.
864 * Normally, this is converted to the broadcaster/countersignatory-organized DirectedChannelTransactionParameters
865 * before use, via the as_holder_broadcastable and as_counterparty_broadcastable functions.
867 typedef struct MUST_USE_STRUCT LDKChannelTransactionParameters {
869 * A pointer to the opaque Rust object.
870 * Nearly everywhere, inner must be non-null, however in places where
871 * the Rust equivalent takes an Option, it may be set to null to indicate None.
873 LDKnativeChannelTransactionParameters *inner;
875 * Indicates that this is the only struct which contains the same pointer.
876 * Rust functions which take ownership of an object provided via an argument require
877 * this to be true and invalidate the object pointed to by inner.
880 } LDKChannelTransactionParameters;
883 * The contents of CResult_ChannelTransactionParametersDecodeErrorZ
885 typedef union LDKCResult_ChannelTransactionParametersDecodeErrorZPtr {
887 * A pointer to the contents in the success state.
888 * Reading from this pointer when `result_ok` is not set is undefined.
890 struct LDKChannelTransactionParameters *result;
892 * A pointer to the contents in the error state.
893 * Reading from this pointer when `result_ok` is set is undefined.
895 struct LDKDecodeError *err;
896 } LDKCResult_ChannelTransactionParametersDecodeErrorZPtr;
899 * A CResult_ChannelTransactionParametersDecodeErrorZ represents the result of a fallible operation,
900 * containing a crate::lightning::ln::chan_utils::ChannelTransactionParameters on success and a crate::lightning::ln::msgs::DecodeError on failure.
901 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
903 typedef struct LDKCResult_ChannelTransactionParametersDecodeErrorZ {
905 * The contents of this CResult_ChannelTransactionParametersDecodeErrorZ, accessible via either
906 * `err` or `result` depending on the state of `result_ok`.
908 union LDKCResult_ChannelTransactionParametersDecodeErrorZPtr contents;
910 * Whether this CResult_ChannelTransactionParametersDecodeErrorZ represents a success state.
913 } LDKCResult_ChannelTransactionParametersDecodeErrorZ;
916 * Represents a secp256k1 signature serialized as two 32-byte numbers
918 typedef struct LDKSignature {
920 * The bytes of the signature in "compact" form
922 uint8_t compact_form[64];
926 * A dynamically-allocated array of crate::c_types::Signatures of arbitrary size.
927 * This corresponds to std::vector in C++
929 typedef struct LDKCVec_SignatureZ {
931 * The elements in the array.
932 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
934 struct LDKSignature *data;
936 * The number of elements pointed to by `data`.
939 } LDKCVec_SignatureZ;
944 * Information needed to build and sign a holder's commitment transaction.
946 * The transaction is only signed once we are ready to broadcast.
948 typedef struct MUST_USE_STRUCT LDKHolderCommitmentTransaction {
950 * A pointer to the opaque Rust object.
951 * Nearly everywhere, inner must be non-null, however in places where
952 * the Rust equivalent takes an Option, it may be set to null to indicate None.
954 LDKnativeHolderCommitmentTransaction *inner;
956 * Indicates that this is the only struct which contains the same pointer.
957 * Rust functions which take ownership of an object provided via an argument require
958 * this to be true and invalidate the object pointed to by inner.
961 } LDKHolderCommitmentTransaction;
964 * The contents of CResult_HolderCommitmentTransactionDecodeErrorZ
966 typedef union LDKCResult_HolderCommitmentTransactionDecodeErrorZPtr {
968 * A pointer to the contents in the success state.
969 * Reading from this pointer when `result_ok` is not set is undefined.
971 struct LDKHolderCommitmentTransaction *result;
973 * A pointer to the contents in the error state.
974 * Reading from this pointer when `result_ok` is set is undefined.
976 struct LDKDecodeError *err;
977 } LDKCResult_HolderCommitmentTransactionDecodeErrorZPtr;
980 * A CResult_HolderCommitmentTransactionDecodeErrorZ represents the result of a fallible operation,
981 * containing a crate::lightning::ln::chan_utils::HolderCommitmentTransaction on success and a crate::lightning::ln::msgs::DecodeError on failure.
982 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
984 typedef struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ {
986 * The contents of this CResult_HolderCommitmentTransactionDecodeErrorZ, accessible via either
987 * `err` or `result` depending on the state of `result_ok`.
989 union LDKCResult_HolderCommitmentTransactionDecodeErrorZPtr contents;
991 * Whether this CResult_HolderCommitmentTransactionDecodeErrorZ represents a success state.
994 } LDKCResult_HolderCommitmentTransactionDecodeErrorZ;
999 * A pre-built Bitcoin commitment transaction and its txid.
1001 typedef struct MUST_USE_STRUCT LDKBuiltCommitmentTransaction {
1003 * A pointer to the opaque Rust object.
1004 * Nearly everywhere, inner must be non-null, however in places where
1005 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1007 LDKnativeBuiltCommitmentTransaction *inner;
1009 * Indicates that this is the only struct which contains the same pointer.
1010 * Rust functions which take ownership of an object provided via an argument require
1011 * this to be true and invalidate the object pointed to by inner.
1014 } LDKBuiltCommitmentTransaction;
1017 * The contents of CResult_BuiltCommitmentTransactionDecodeErrorZ
1019 typedef union LDKCResult_BuiltCommitmentTransactionDecodeErrorZPtr {
1021 * A pointer to the contents in the success state.
1022 * Reading from this pointer when `result_ok` is not set is undefined.
1024 struct LDKBuiltCommitmentTransaction *result;
1026 * A pointer to the contents in the error state.
1027 * Reading from this pointer when `result_ok` is set is undefined.
1029 struct LDKDecodeError *err;
1030 } LDKCResult_BuiltCommitmentTransactionDecodeErrorZPtr;
1033 * A CResult_BuiltCommitmentTransactionDecodeErrorZ represents the result of a fallible operation,
1034 * containing a crate::lightning::ln::chan_utils::BuiltCommitmentTransaction on success and a crate::lightning::ln::msgs::DecodeError on failure.
1035 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1037 typedef struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ {
1039 * The contents of this CResult_BuiltCommitmentTransactionDecodeErrorZ, accessible via either
1040 * `err` or `result` depending on the state of `result_ok`.
1042 union LDKCResult_BuiltCommitmentTransactionDecodeErrorZPtr contents;
1044 * Whether this CResult_BuiltCommitmentTransactionDecodeErrorZ represents a success state.
1047 } LDKCResult_BuiltCommitmentTransactionDecodeErrorZ;
1052 * A wrapper on ClosingTransaction indicating that the built bitcoin
1053 * transaction is trusted.
1055 * See trust() and verify() functions on CommitmentTransaction.
1057 * This structure implements Deref.
1059 typedef struct MUST_USE_STRUCT LDKTrustedClosingTransaction {
1061 * A pointer to the opaque Rust object.
1062 * Nearly everywhere, inner must be non-null, however in places where
1063 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1065 LDKnativeTrustedClosingTransaction *inner;
1067 * Indicates that this is the only struct which contains the same pointer.
1068 * Rust functions which take ownership of an object provided via an argument require
1069 * this to be true and invalidate the object pointed to by inner.
1072 } LDKTrustedClosingTransaction;
1075 * The contents of CResult_TrustedClosingTransactionNoneZ
1077 typedef union LDKCResult_TrustedClosingTransactionNoneZPtr {
1079 * A pointer to the contents in the success state.
1080 * Reading from this pointer when `result_ok` is not set is undefined.
1082 struct LDKTrustedClosingTransaction *result;
1084 * Note that this value is always NULL, as there are no contents in the Err variant
1087 } LDKCResult_TrustedClosingTransactionNoneZPtr;
1090 * A CResult_TrustedClosingTransactionNoneZ represents the result of a fallible operation,
1091 * containing a crate::lightning::ln::chan_utils::TrustedClosingTransaction on success and a () on failure.
1092 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1094 typedef struct LDKCResult_TrustedClosingTransactionNoneZ {
1096 * The contents of this CResult_TrustedClosingTransactionNoneZ, accessible via either
1097 * `err` or `result` depending on the state of `result_ok`.
1099 union LDKCResult_TrustedClosingTransactionNoneZPtr contents;
1101 * Whether this CResult_TrustedClosingTransactionNoneZ represents a success state.
1104 } LDKCResult_TrustedClosingTransactionNoneZ;
1109 * This class tracks the per-transaction information needed to build a commitment transaction and will
1110 * actually build it and sign. It is used for holder transactions that we sign only when needed
1111 * and for transactions we sign for the counterparty.
1113 * This class can be used inside a signer implementation to generate a signature given the relevant
1116 typedef struct MUST_USE_STRUCT LDKCommitmentTransaction {
1118 * A pointer to the opaque Rust object.
1119 * Nearly everywhere, inner must be non-null, however in places where
1120 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1122 LDKnativeCommitmentTransaction *inner;
1124 * Indicates that this is the only struct which contains the same pointer.
1125 * Rust functions which take ownership of an object provided via an argument require
1126 * this to be true and invalidate the object pointed to by inner.
1129 } LDKCommitmentTransaction;
1132 * The contents of CResult_CommitmentTransactionDecodeErrorZ
1134 typedef union LDKCResult_CommitmentTransactionDecodeErrorZPtr {
1136 * A pointer to the contents in the success state.
1137 * Reading from this pointer when `result_ok` is not set is undefined.
1139 struct LDKCommitmentTransaction *result;
1141 * A pointer to the contents in the error state.
1142 * Reading from this pointer when `result_ok` is set is undefined.
1144 struct LDKDecodeError *err;
1145 } LDKCResult_CommitmentTransactionDecodeErrorZPtr;
1148 * A CResult_CommitmentTransactionDecodeErrorZ represents the result of a fallible operation,
1149 * containing a crate::lightning::ln::chan_utils::CommitmentTransaction on success and a crate::lightning::ln::msgs::DecodeError on failure.
1150 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1152 typedef struct LDKCResult_CommitmentTransactionDecodeErrorZ {
1154 * The contents of this CResult_CommitmentTransactionDecodeErrorZ, accessible via either
1155 * `err` or `result` depending on the state of `result_ok`.
1157 union LDKCResult_CommitmentTransactionDecodeErrorZPtr contents;
1159 * Whether this CResult_CommitmentTransactionDecodeErrorZ represents a success state.
1162 } LDKCResult_CommitmentTransactionDecodeErrorZ;
1167 * A wrapper on CommitmentTransaction indicating that the derived fields (the built bitcoin
1168 * transaction and the transaction creation keys) are trusted.
1170 * See trust() and verify() functions on CommitmentTransaction.
1172 * This structure implements Deref.
1174 typedef struct MUST_USE_STRUCT LDKTrustedCommitmentTransaction {
1176 * A pointer to the opaque Rust object.
1177 * Nearly everywhere, inner must be non-null, however in places where
1178 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1180 LDKnativeTrustedCommitmentTransaction *inner;
1182 * Indicates that this is the only struct which contains the same pointer.
1183 * Rust functions which take ownership of an object provided via an argument require
1184 * this to be true and invalidate the object pointed to by inner.
1187 } LDKTrustedCommitmentTransaction;
1190 * The contents of CResult_TrustedCommitmentTransactionNoneZ
1192 typedef union LDKCResult_TrustedCommitmentTransactionNoneZPtr {
1194 * A pointer to the contents in the success state.
1195 * Reading from this pointer when `result_ok` is not set is undefined.
1197 struct LDKTrustedCommitmentTransaction *result;
1199 * Note that this value is always NULL, as there are no contents in the Err variant
1202 } LDKCResult_TrustedCommitmentTransactionNoneZPtr;
1205 * A CResult_TrustedCommitmentTransactionNoneZ represents the result of a fallible operation,
1206 * containing a crate::lightning::ln::chan_utils::TrustedCommitmentTransaction on success and a () on failure.
1207 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1209 typedef struct LDKCResult_TrustedCommitmentTransactionNoneZ {
1211 * The contents of this CResult_TrustedCommitmentTransactionNoneZ, accessible via either
1212 * `err` or `result` depending on the state of `result_ok`.
1214 union LDKCResult_TrustedCommitmentTransactionNoneZPtr contents;
1216 * Whether this CResult_TrustedCommitmentTransactionNoneZ represents a success state.
1219 } LDKCResult_TrustedCommitmentTransactionNoneZ;
1222 * The contents of CResult_CVec_SignatureZNoneZ
1224 typedef union LDKCResult_CVec_SignatureZNoneZPtr {
1226 * A pointer to the contents in the success state.
1227 * Reading from this pointer when `result_ok` is not set is undefined.
1229 struct LDKCVec_SignatureZ *result;
1231 * Note that this value is always NULL, as there are no contents in the Err variant
1234 } LDKCResult_CVec_SignatureZNoneZPtr;
1237 * A CResult_CVec_SignatureZNoneZ represents the result of a fallible operation,
1238 * containing a crate::c_types::derived::CVec_SignatureZ on success and a () on failure.
1239 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1241 typedef struct LDKCResult_CVec_SignatureZNoneZ {
1243 * The contents of this CResult_CVec_SignatureZNoneZ, accessible via either
1244 * `err` or `result` depending on the state of `result_ok`.
1246 union LDKCResult_CVec_SignatureZNoneZPtr contents;
1248 * Whether this CResult_CVec_SignatureZNoneZ represents a success state.
1251 } LDKCResult_CVec_SignatureZNoneZ;
1256 * A script pubkey for shutting down a channel as defined by [BOLT #2].
1258 * [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
1260 typedef struct MUST_USE_STRUCT LDKShutdownScript {
1262 * A pointer to the opaque Rust object.
1263 * Nearly everywhere, inner must be non-null, however in places where
1264 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1266 LDKnativeShutdownScript *inner;
1268 * Indicates that this is the only struct which contains the same pointer.
1269 * Rust functions which take ownership of an object provided via an argument require
1270 * this to be true and invalidate the object pointed to by inner.
1273 } LDKShutdownScript;
1276 * The contents of CResult_ShutdownScriptDecodeErrorZ
1278 typedef union LDKCResult_ShutdownScriptDecodeErrorZPtr {
1280 * A pointer to the contents in the success state.
1281 * Reading from this pointer when `result_ok` is not set is undefined.
1283 struct LDKShutdownScript *result;
1285 * A pointer to the contents in the error state.
1286 * Reading from this pointer when `result_ok` is set is undefined.
1288 struct LDKDecodeError *err;
1289 } LDKCResult_ShutdownScriptDecodeErrorZPtr;
1292 * A CResult_ShutdownScriptDecodeErrorZ represents the result of a fallible operation,
1293 * containing a crate::lightning::ln::script::ShutdownScript on success and a crate::lightning::ln::msgs::DecodeError on failure.
1294 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1296 typedef struct LDKCResult_ShutdownScriptDecodeErrorZ {
1298 * The contents of this CResult_ShutdownScriptDecodeErrorZ, accessible via either
1299 * `err` or `result` depending on the state of `result_ok`.
1301 union LDKCResult_ShutdownScriptDecodeErrorZPtr contents;
1303 * Whether this CResult_ShutdownScriptDecodeErrorZ represents a success state.
1306 } LDKCResult_ShutdownScriptDecodeErrorZ;
1311 * An error occurring when converting from [`Script`] to [`ShutdownScript`].
1313 typedef struct MUST_USE_STRUCT LDKInvalidShutdownScript {
1315 * A pointer to the opaque Rust object.
1316 * Nearly everywhere, inner must be non-null, however in places where
1317 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1319 LDKnativeInvalidShutdownScript *inner;
1321 * Indicates that this is the only struct which contains the same pointer.
1322 * Rust functions which take ownership of an object provided via an argument require
1323 * this to be true and invalidate the object pointed to by inner.
1326 } LDKInvalidShutdownScript;
1329 * The contents of CResult_ShutdownScriptInvalidShutdownScriptZ
1331 typedef union LDKCResult_ShutdownScriptInvalidShutdownScriptZPtr {
1333 * A pointer to the contents in the success state.
1334 * Reading from this pointer when `result_ok` is not set is undefined.
1336 struct LDKShutdownScript *result;
1338 * A pointer to the contents in the error state.
1339 * Reading from this pointer when `result_ok` is set is undefined.
1341 struct LDKInvalidShutdownScript *err;
1342 } LDKCResult_ShutdownScriptInvalidShutdownScriptZPtr;
1345 * A CResult_ShutdownScriptInvalidShutdownScriptZ represents the result of a fallible operation,
1346 * containing a crate::lightning::ln::script::ShutdownScript on success and a crate::lightning::ln::script::InvalidShutdownScript on failure.
1347 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1349 typedef struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ {
1351 * The contents of this CResult_ShutdownScriptInvalidShutdownScriptZ, accessible via either
1352 * `err` or `result` depending on the state of `result_ok`.
1354 union LDKCResult_ShutdownScriptInvalidShutdownScriptZPtr contents;
1356 * Whether this CResult_ShutdownScriptInvalidShutdownScriptZ represents a success state.
1359 } LDKCResult_ShutdownScriptInvalidShutdownScriptZ;
1362 * The contents of CResult_NoneErrorZ
1364 typedef union LDKCResult_NoneErrorZPtr {
1366 * Note that this value is always NULL, as there are no contents in the OK variant
1370 * A pointer to the contents in the error state.
1371 * Reading from this pointer when `result_ok` is set is undefined.
1373 enum LDKIOError *err;
1374 } LDKCResult_NoneErrorZPtr;
1377 * A CResult_NoneErrorZ represents the result of a fallible operation,
1378 * containing a () on success and a crate::c_types::IOError on failure.
1379 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1381 typedef struct LDKCResult_NoneErrorZ {
1383 * The contents of this CResult_NoneErrorZ, accessible via either
1384 * `err` or `result` depending on the state of `result_ok`.
1386 union LDKCResult_NoneErrorZPtr contents;
1388 * Whether this CResult_NoneErrorZ represents a success state.
1391 } LDKCResult_NoneErrorZ;
1398 typedef struct MUST_USE_STRUCT LDKRouteHop {
1400 * A pointer to the opaque Rust object.
1401 * Nearly everywhere, inner must be non-null, however in places where
1402 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1404 LDKnativeRouteHop *inner;
1406 * Indicates that this is the only struct which contains the same pointer.
1407 * Rust functions which take ownership of an object provided via an argument require
1408 * this to be true and invalidate the object pointed to by inner.
1414 * The contents of CResult_RouteHopDecodeErrorZ
1416 typedef union LDKCResult_RouteHopDecodeErrorZPtr {
1418 * A pointer to the contents in the success state.
1419 * Reading from this pointer when `result_ok` is not set is undefined.
1421 struct LDKRouteHop *result;
1423 * A pointer to the contents in the error state.
1424 * Reading from this pointer when `result_ok` is set is undefined.
1426 struct LDKDecodeError *err;
1427 } LDKCResult_RouteHopDecodeErrorZPtr;
1430 * A CResult_RouteHopDecodeErrorZ represents the result of a fallible operation,
1431 * containing a crate::lightning::routing::router::RouteHop on success and a crate::lightning::ln::msgs::DecodeError on failure.
1432 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1434 typedef struct LDKCResult_RouteHopDecodeErrorZ {
1436 * The contents of this CResult_RouteHopDecodeErrorZ, accessible via either
1437 * `err` or `result` depending on the state of `result_ok`.
1439 union LDKCResult_RouteHopDecodeErrorZPtr contents;
1441 * Whether this CResult_RouteHopDecodeErrorZ represents a success state.
1444 } LDKCResult_RouteHopDecodeErrorZ;
1447 * A dynamically-allocated array of crate::lightning::routing::router::RouteHops of arbitrary size.
1448 * This corresponds to std::vector in C++
1450 typedef struct LDKCVec_RouteHopZ {
1452 * The elements in the array.
1453 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1455 struct LDKRouteHop *data;
1457 * The number of elements pointed to by `data`.
1460 } LDKCVec_RouteHopZ;
1463 * A dynamically-allocated array of crate::c_types::derived::CVec_RouteHopZs of arbitrary size.
1464 * This corresponds to std::vector in C++
1466 typedef struct LDKCVec_CVec_RouteHopZZ {
1468 * The elements in the array.
1469 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1471 struct LDKCVec_RouteHopZ *data;
1473 * The number of elements pointed to by `data`.
1476 } LDKCVec_CVec_RouteHopZZ;
1481 * A route directs a payment from the sender (us) to the recipient. If the recipient supports MPP,
1482 * it can take multiple paths. Each path is composed of one or more hops through the network.
1484 typedef struct MUST_USE_STRUCT LDKRoute {
1486 * A pointer to the opaque Rust object.
1487 * Nearly everywhere, inner must be non-null, however in places where
1488 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1490 LDKnativeRoute *inner;
1492 * Indicates that this is the only struct which contains the same pointer.
1493 * Rust functions which take ownership of an object provided via an argument require
1494 * this to be true and invalidate the object pointed to by inner.
1500 * The contents of CResult_RouteDecodeErrorZ
1502 typedef union LDKCResult_RouteDecodeErrorZPtr {
1504 * A pointer to the contents in the success state.
1505 * Reading from this pointer when `result_ok` is not set is undefined.
1507 struct LDKRoute *result;
1509 * A pointer to the contents in the error state.
1510 * Reading from this pointer when `result_ok` is set is undefined.
1512 struct LDKDecodeError *err;
1513 } LDKCResult_RouteDecodeErrorZPtr;
1516 * A CResult_RouteDecodeErrorZ represents the result of a fallible operation,
1517 * containing a crate::lightning::routing::router::Route on success and a crate::lightning::ln::msgs::DecodeError on failure.
1518 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1520 typedef struct LDKCResult_RouteDecodeErrorZ {
1522 * The contents of this CResult_RouteDecodeErrorZ, accessible via either
1523 * `err` or `result` depending on the state of `result_ok`.
1525 union LDKCResult_RouteDecodeErrorZPtr contents;
1527 * Whether this CResult_RouteDecodeErrorZ represents a success state.
1530 } LDKCResult_RouteDecodeErrorZ;
1533 * An enum which can either contain a u64 or not
1535 typedef enum LDKCOption_u64Z_Tag {
1537 * When we're in this state, this COption_u64Z contains a u64
1539 LDKCOption_u64Z_Some,
1541 * When we're in this state, this COption_u64Z contains nothing
1543 LDKCOption_u64Z_None,
1545 * Must be last for serialization purposes
1547 LDKCOption_u64Z_Sentinel,
1548 } LDKCOption_u64Z_Tag;
1550 typedef struct LDKCOption_u64Z {
1551 LDKCOption_u64Z_Tag tag;
1562 * Details of a channel, as returned by ChannelManager::list_channels and ChannelManager::list_usable_channels
1564 typedef struct MUST_USE_STRUCT LDKChannelDetails {
1566 * A pointer to the opaque Rust object.
1567 * Nearly everywhere, inner must be non-null, however in places where
1568 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1570 LDKnativeChannelDetails *inner;
1572 * Indicates that this is the only struct which contains the same pointer.
1573 * Rust functions which take ownership of an object provided via an argument require
1574 * this to be true and invalidate the object pointed to by inner.
1577 } LDKChannelDetails;
1580 * A dynamically-allocated array of crate::lightning::ln::channelmanager::ChannelDetailss of arbitrary size.
1581 * This corresponds to std::vector in C++
1583 typedef struct LDKCVec_ChannelDetailsZ {
1585 * The elements in the array.
1586 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1588 struct LDKChannelDetails *data;
1590 * The number of elements pointed to by `data`.
1593 } LDKCVec_ChannelDetailsZ;
1598 * A list of hops along a payment path terminating with a channel to the recipient.
1600 typedef struct MUST_USE_STRUCT LDKRouteHint {
1602 * A pointer to the opaque Rust object.
1603 * Nearly everywhere, inner must be non-null, however in places where
1604 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1606 LDKnativeRouteHint *inner;
1608 * Indicates that this is the only struct which contains the same pointer.
1609 * Rust functions which take ownership of an object provided via an argument require
1610 * this to be true and invalidate the object pointed to by inner.
1616 * A dynamically-allocated array of crate::lightning::routing::router::RouteHints of arbitrary size.
1617 * This corresponds to std::vector in C++
1619 typedef struct LDKCVec_RouteHintZ {
1621 * The elements in the array.
1622 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1624 struct LDKRouteHint *data;
1626 * The number of elements pointed to by `data`.
1629 } LDKCVec_RouteHintZ;
1634 * An Err type for failure to process messages.
1636 typedef struct MUST_USE_STRUCT LDKLightningError {
1638 * A pointer to the opaque Rust object.
1639 * Nearly everywhere, inner must be non-null, however in places where
1640 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1642 LDKnativeLightningError *inner;
1644 * Indicates that this is the only struct which contains the same pointer.
1645 * Rust functions which take ownership of an object provided via an argument require
1646 * this to be true and invalidate the object pointed to by inner.
1649 } LDKLightningError;
1652 * The contents of CResult_RouteLightningErrorZ
1654 typedef union LDKCResult_RouteLightningErrorZPtr {
1656 * A pointer to the contents in the success state.
1657 * Reading from this pointer when `result_ok` is not set is undefined.
1659 struct LDKRoute *result;
1661 * A pointer to the contents in the error state.
1662 * Reading from this pointer when `result_ok` is set is undefined.
1664 struct LDKLightningError *err;
1665 } LDKCResult_RouteLightningErrorZPtr;
1668 * A CResult_RouteLightningErrorZ represents the result of a fallible operation,
1669 * containing a crate::lightning::routing::router::Route on success and a crate::lightning::ln::msgs::LightningError on failure.
1670 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1672 typedef struct LDKCResult_RouteLightningErrorZ {
1674 * The contents of this CResult_RouteLightningErrorZ, accessible via either
1675 * `err` or `result` depending on the state of `result_ok`.
1677 union LDKCResult_RouteLightningErrorZPtr contents;
1679 * Whether this CResult_RouteLightningErrorZ represents a success state.
1682 } LDKCResult_RouteLightningErrorZ;
1685 * The contents of CResult_TxOutAccessErrorZ
1687 typedef union LDKCResult_TxOutAccessErrorZPtr {
1689 * A pointer to the contents in the success state.
1690 * Reading from this pointer when `result_ok` is not set is undefined.
1692 struct LDKTxOut *result;
1694 * A pointer to the contents in the error state.
1695 * Reading from this pointer when `result_ok` is set is undefined.
1697 enum LDKAccessError *err;
1698 } LDKCResult_TxOutAccessErrorZPtr;
1701 * A CResult_TxOutAccessErrorZ represents the result of a fallible operation,
1702 * containing a crate::c_types::TxOut on success and a crate::lightning::chain::AccessError on failure.
1703 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1705 typedef struct LDKCResult_TxOutAccessErrorZ {
1707 * The contents of this CResult_TxOutAccessErrorZ, accessible via either
1708 * `err` or `result` depending on the state of `result_ok`.
1710 union LDKCResult_TxOutAccessErrorZPtr contents;
1712 * Whether this CResult_TxOutAccessErrorZ represents a success state.
1715 } LDKCResult_TxOutAccessErrorZ;
1718 * A tuple of 2 elements. See the individual fields for the types contained.
1720 typedef struct LDKC2Tuple_usizeTransactionZ {
1722 * The element at position 0
1726 * The element at position 1
1728 struct LDKTransaction b;
1729 } LDKC2Tuple_usizeTransactionZ;
1732 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_usizeTransactionZs of arbitrary size.
1733 * This corresponds to std::vector in C++
1735 typedef struct LDKCVec_C2Tuple_usizeTransactionZZ {
1737 * The elements in the array.
1738 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1740 struct LDKC2Tuple_usizeTransactionZ *data;
1742 * The number of elements pointed to by `data`.
1745 } LDKCVec_C2Tuple_usizeTransactionZZ;
1748 * Arbitrary 32 bytes, which could represent one of a few different things. You probably want to
1749 * look up the corresponding function in rust-lightning's docs.
1751 typedef struct LDKThirtyTwoBytes {
1753 * The thirty-two bytes
1756 } LDKThirtyTwoBytes;
1759 * A dynamically-allocated array of crate::c_types::ThirtyTwoBytess of arbitrary size.
1760 * This corresponds to std::vector in C++
1762 typedef struct LDKCVec_TxidZ {
1764 * The elements in the array.
1765 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1767 struct LDKThirtyTwoBytes *data;
1769 * The number of elements pointed to by `data`.
1775 * The contents of CResult_NoneChannelMonitorUpdateErrZ
1777 typedef union LDKCResult_NoneChannelMonitorUpdateErrZPtr {
1779 * Note that this value is always NULL, as there are no contents in the OK variant
1783 * A pointer to the contents in the error state.
1784 * Reading from this pointer when `result_ok` is set is undefined.
1786 enum LDKChannelMonitorUpdateErr *err;
1787 } LDKCResult_NoneChannelMonitorUpdateErrZPtr;
1790 * A CResult_NoneChannelMonitorUpdateErrZ represents the result of a fallible operation,
1791 * containing a () on success and a crate::lightning::chain::channelmonitor::ChannelMonitorUpdateErr on failure.
1792 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
1794 typedef struct LDKCResult_NoneChannelMonitorUpdateErrZ {
1796 * The contents of this CResult_NoneChannelMonitorUpdateErrZ, accessible via either
1797 * `err` or `result` depending on the state of `result_ok`.
1799 union LDKCResult_NoneChannelMonitorUpdateErrZPtr contents;
1801 * Whether this CResult_NoneChannelMonitorUpdateErrZ represents a success state.
1804 } LDKCResult_NoneChannelMonitorUpdateErrZ;
1809 * Simple structure sent back by `chain::Watch` when an HTLC from a forward channel is detected on
1810 * chain. Used to update the corresponding HTLC in the backward channel. Failing to pass the
1811 * preimage claim backward will lead to loss of funds.
1813 typedef struct MUST_USE_STRUCT LDKHTLCUpdate {
1815 * A pointer to the opaque Rust object.
1816 * Nearly everywhere, inner must be non-null, however in places where
1817 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1819 LDKnativeHTLCUpdate *inner;
1821 * Indicates that this is the only struct which contains the same pointer.
1822 * Rust functions which take ownership of an object provided via an argument require
1823 * this to be true and invalidate the object pointed to by inner.
1831 * A reference to a transaction output.
1833 * Differs from bitcoin::blockdata::transaction::OutPoint as the index is a u16 instead of u32
1834 * due to LN's restrictions on index values. Should reduce (possibly) unsafe conversions this way.
1836 typedef struct MUST_USE_STRUCT LDKOutPoint {
1838 * A pointer to the opaque Rust object.
1839 * Nearly everywhere, inner must be non-null, however in places where
1840 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1842 LDKnativeOutPoint *inner;
1844 * Indicates that this is the only struct which contains the same pointer.
1845 * Rust functions which take ownership of an object provided via an argument require
1846 * this to be true and invalidate the object pointed to by inner.
1852 * An event to be processed by the ChannelManager.
1854 typedef enum LDKMonitorEvent_Tag {
1856 * A monitor event containing an HTLCUpdate.
1858 LDKMonitorEvent_HTLCEvent,
1860 * A monitor event that the Channel's commitment transaction was confirmed.
1862 LDKMonitorEvent_CommitmentTxConfirmed,
1864 * Must be last for serialization purposes
1866 LDKMonitorEvent_Sentinel,
1867 } LDKMonitorEvent_Tag;
1869 typedef struct MUST_USE_STRUCT LDKMonitorEvent {
1870 LDKMonitorEvent_Tag tag;
1873 struct LDKHTLCUpdate htlc_event;
1876 struct LDKOutPoint commitment_tx_confirmed;
1882 * A dynamically-allocated array of crate::lightning::chain::channelmonitor::MonitorEvents of arbitrary size.
1883 * This corresponds to std::vector in C++
1885 typedef struct LDKCVec_MonitorEventZ {
1887 * The elements in the array.
1888 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
1890 struct LDKMonitorEvent *data;
1892 * The number of elements pointed to by `data`.
1895 } LDKCVec_MonitorEventZ;
1898 * An enum which can either contain a crate::c_types::derived::C2Tuple_usizeTransactionZ or not
1900 typedef enum LDKCOption_C2Tuple_usizeTransactionZZ_Tag {
1902 * When we're in this state, this COption_C2Tuple_usizeTransactionZZ contains a crate::c_types::derived::C2Tuple_usizeTransactionZ
1904 LDKCOption_C2Tuple_usizeTransactionZZ_Some,
1906 * When we're in this state, this COption_C2Tuple_usizeTransactionZZ contains nothing
1908 LDKCOption_C2Tuple_usizeTransactionZZ_None,
1910 * Must be last for serialization purposes
1912 LDKCOption_C2Tuple_usizeTransactionZZ_Sentinel,
1913 } LDKCOption_C2Tuple_usizeTransactionZZ_Tag;
1915 typedef struct LDKCOption_C2Tuple_usizeTransactionZZ {
1916 LDKCOption_C2Tuple_usizeTransactionZZ_Tag tag;
1919 struct LDKC2Tuple_usizeTransactionZ some;
1922 } LDKCOption_C2Tuple_usizeTransactionZZ;
1927 * A channel_update message to be sent or received from a peer
1929 typedef struct MUST_USE_STRUCT LDKChannelUpdate {
1931 * A pointer to the opaque Rust object.
1932 * Nearly everywhere, inner must be non-null, however in places where
1933 * the Rust equivalent takes an Option, it may be set to null to indicate None.
1935 LDKnativeChannelUpdate *inner;
1937 * Indicates that this is the only struct which contains the same pointer.
1938 * Rust functions which take ownership of an object provided via an argument require
1939 * this to be true and invalidate the object pointed to by inner.
1945 * Update to the [`NetworkGraph`] based on payment failure information conveyed via the Onion
1946 * return packet by a node along the route. See [BOLT #4] for details.
1948 * [BOLT #4]: https://github.com/lightningnetwork/lightning-rfc/blob/master/04-onion-routing.md
1950 typedef enum LDKNetworkUpdate_Tag {
1952 * An error indicating a `channel_update` messages should be applied via
1953 * [`NetworkGraph::update_channel`].
1955 LDKNetworkUpdate_ChannelUpdateMessage,
1957 * An error indicating only that a channel has been closed, which should be applied via
1958 * [`NetworkGraph::close_channel_from_update`].
1960 LDKNetworkUpdate_ChannelClosed,
1962 * An error indicating only that a node has failed, which should be applied via
1963 * [`NetworkGraph::fail_node`].
1965 LDKNetworkUpdate_NodeFailure,
1967 * Must be last for serialization purposes
1969 LDKNetworkUpdate_Sentinel,
1970 } LDKNetworkUpdate_Tag;
1972 typedef struct LDKNetworkUpdate_LDKChannelUpdateMessage_Body {
1974 * The update to apply via [`NetworkGraph::update_channel`].
1976 struct LDKChannelUpdate msg;
1977 } LDKNetworkUpdate_LDKChannelUpdateMessage_Body;
1979 typedef struct LDKNetworkUpdate_LDKChannelClosed_Body {
1981 * The short channel id of the closed channel.
1983 uint64_t short_channel_id;
1985 * Whether the channel should be permanently removed or temporarily disabled until a new
1986 * `channel_update` message is received.
1989 } LDKNetworkUpdate_LDKChannelClosed_Body;
1991 typedef struct LDKNetworkUpdate_LDKNodeFailure_Body {
1993 * The node id of the failed node.
1995 struct LDKPublicKey node_id;
1997 * Whether the node should be permanently removed from consideration or can be restored
1998 * when a new `channel_update` message is received.
2001 } LDKNetworkUpdate_LDKNodeFailure_Body;
2003 typedef struct MUST_USE_STRUCT LDKNetworkUpdate {
2004 LDKNetworkUpdate_Tag tag;
2006 LDKNetworkUpdate_LDKChannelUpdateMessage_Body channel_update_message;
2007 LDKNetworkUpdate_LDKChannelClosed_Body channel_closed;
2008 LDKNetworkUpdate_LDKNodeFailure_Body node_failure;
2013 * An enum which can either contain a crate::lightning::routing::network_graph::NetworkUpdate or not
2015 typedef enum LDKCOption_NetworkUpdateZ_Tag {
2017 * When we're in this state, this COption_NetworkUpdateZ contains a crate::lightning::routing::network_graph::NetworkUpdate
2019 LDKCOption_NetworkUpdateZ_Some,
2021 * When we're in this state, this COption_NetworkUpdateZ contains nothing
2023 LDKCOption_NetworkUpdateZ_None,
2025 * Must be last for serialization purposes
2027 LDKCOption_NetworkUpdateZ_Sentinel,
2028 } LDKCOption_NetworkUpdateZ_Tag;
2030 typedef struct LDKCOption_NetworkUpdateZ {
2031 LDKCOption_NetworkUpdateZ_Tag tag;
2034 struct LDKNetworkUpdate some;
2037 } LDKCOption_NetworkUpdateZ;
2042 * Information about a spendable output to a P2WSH script. See
2043 * SpendableOutputDescriptor::DelayedPaymentOutput for more details on how to spend this.
2045 typedef struct MUST_USE_STRUCT LDKDelayedPaymentOutputDescriptor {
2047 * A pointer to the opaque Rust object.
2048 * Nearly everywhere, inner must be non-null, however in places where
2049 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2051 LDKnativeDelayedPaymentOutputDescriptor *inner;
2053 * Indicates that this is the only struct which contains the same pointer.
2054 * Rust functions which take ownership of an object provided via an argument require
2055 * this to be true and invalidate the object pointed to by inner.
2058 } LDKDelayedPaymentOutputDescriptor;
2063 * Information about a spendable output to our \"payment key\". See
2064 * SpendableOutputDescriptor::StaticPaymentOutput for more details on how to spend this.
2066 typedef struct MUST_USE_STRUCT LDKStaticPaymentOutputDescriptor {
2068 * A pointer to the opaque Rust object.
2069 * Nearly everywhere, inner must be non-null, however in places where
2070 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2072 LDKnativeStaticPaymentOutputDescriptor *inner;
2074 * Indicates that this is the only struct which contains the same pointer.
2075 * Rust functions which take ownership of an object provided via an argument require
2076 * this to be true and invalidate the object pointed to by inner.
2079 } LDKStaticPaymentOutputDescriptor;
2082 * When on-chain outputs are created by rust-lightning (which our counterparty is not able to
2083 * claim at any point in the future) an event is generated which you must track and be able to
2084 * spend on-chain. The information needed to do this is provided in this enum, including the
2085 * outpoint describing which txid and output index is available, the full output which exists at
2086 * that txid/index, and any keys or other information required to sign.
2088 typedef enum LDKSpendableOutputDescriptor_Tag {
2090 * An output to a script which was provided via KeysInterface directly, either from
2091 * `get_destination_script()` or `get_shutdown_scriptpubkey()`, thus you should already know
2092 * how to spend it. No secret keys are provided as rust-lightning was never given any key.
2093 * These may include outputs from a transaction punishing our counterparty or claiming an HTLC
2094 * on-chain using the payment preimage or after it has timed out.
2096 LDKSpendableOutputDescriptor_StaticOutput,
2098 * An output to a P2WSH script which can be spent with a single signature after a CSV delay.
2100 * The witness in the spending input should be:
2101 * <BIP 143 signature> <empty vector> (MINIMALIF standard rule) <provided witnessScript>
2103 * Note that the nSequence field in the spending input must be set to to_self_delay
2104 * (which means the transaction is not broadcastable until at least to_self_delay
2105 * blocks after the outpoint confirms).
2107 * These are generally the result of a \"revocable\" output to us, spendable only by us unless
2108 * it is an output from an old state which we broadcast (which should never happen).
2110 * To derive the delayed_payment key which is used to sign for this input, you must pass the
2111 * holder delayed_payment_base_key (ie the private key which corresponds to the pubkey in
2112 * Sign::pubkeys().delayed_payment_basepoint) and the provided per_commitment_point to
2113 * chan_utils::derive_private_key. The public key can be generated without the secret key
2114 * using chan_utils::derive_public_key and only the delayed_payment_basepoint which appears in
2117 * To derive the revocation_pubkey provided here (which is used in the witness
2118 * script generation), you must pass the counterparty revocation_basepoint (which appears in the
2119 * call to Sign::ready_channel) and the provided per_commitment point
2120 * to chan_utils::derive_public_revocation_key.
2122 * The witness script which is hashed and included in the output script_pubkey may be
2123 * regenerated by passing the revocation_pubkey (derived as above), our delayed_payment pubkey
2124 * (derived as above), and the to_self_delay contained here to
2125 * chan_utils::get_revokeable_redeemscript.
2127 LDKSpendableOutputDescriptor_DelayedPaymentOutput,
2129 * An output to a P2WPKH, spendable exclusively by our payment key (ie the private key which
2130 * corresponds to the public key in Sign::pubkeys().payment_point).
2131 * The witness in the spending input, is, thus, simply:
2132 * <BIP 143 signature> <payment key>
2134 * These are generally the result of our counterparty having broadcast the current state,
2135 * allowing us to claim the non-HTLC-encumbered outputs immediately.
2137 LDKSpendableOutputDescriptor_StaticPaymentOutput,
2139 * Must be last for serialization purposes
2141 LDKSpendableOutputDescriptor_Sentinel,
2142 } LDKSpendableOutputDescriptor_Tag;
2144 typedef struct LDKSpendableOutputDescriptor_LDKStaticOutput_Body {
2146 * The outpoint which is spendable
2148 struct LDKOutPoint outpoint;
2150 * The output which is referenced by the given outpoint.
2152 struct LDKTxOut output;
2153 } LDKSpendableOutputDescriptor_LDKStaticOutput_Body;
2155 typedef struct MUST_USE_STRUCT LDKSpendableOutputDescriptor {
2156 LDKSpendableOutputDescriptor_Tag tag;
2158 LDKSpendableOutputDescriptor_LDKStaticOutput_Body static_output;
2160 struct LDKDelayedPaymentOutputDescriptor delayed_payment_output;
2163 struct LDKStaticPaymentOutputDescriptor static_payment_output;
2166 } LDKSpendableOutputDescriptor;
2169 * A dynamically-allocated array of crate::lightning::chain::keysinterface::SpendableOutputDescriptors of arbitrary size.
2170 * This corresponds to std::vector in C++
2172 typedef struct LDKCVec_SpendableOutputDescriptorZ {
2174 * The elements in the array.
2175 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
2177 struct LDKSpendableOutputDescriptor *data;
2179 * The number of elements pointed to by `data`.
2182 } LDKCVec_SpendableOutputDescriptorZ;
2187 * An accept_channel message to be sent or received from a peer
2189 typedef struct MUST_USE_STRUCT LDKAcceptChannel {
2191 * A pointer to the opaque Rust object.
2192 * Nearly everywhere, inner must be non-null, however in places where
2193 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2195 LDKnativeAcceptChannel *inner;
2197 * Indicates that this is the only struct which contains the same pointer.
2198 * Rust functions which take ownership of an object provided via an argument require
2199 * this to be true and invalidate the object pointed to by inner.
2207 * An open_channel message to be sent or received from a peer
2209 typedef struct MUST_USE_STRUCT LDKOpenChannel {
2211 * A pointer to the opaque Rust object.
2212 * Nearly everywhere, inner must be non-null, however in places where
2213 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2215 LDKnativeOpenChannel *inner;
2217 * Indicates that this is the only struct which contains the same pointer.
2218 * Rust functions which take ownership of an object provided via an argument require
2219 * this to be true and invalidate the object pointed to by inner.
2227 * A funding_created message to be sent or received from a peer
2229 typedef struct MUST_USE_STRUCT LDKFundingCreated {
2231 * A pointer to the opaque Rust object.
2232 * Nearly everywhere, inner must be non-null, however in places where
2233 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2235 LDKnativeFundingCreated *inner;
2237 * Indicates that this is the only struct which contains the same pointer.
2238 * Rust functions which take ownership of an object provided via an argument require
2239 * this to be true and invalidate the object pointed to by inner.
2242 } LDKFundingCreated;
2247 * A funding_signed message to be sent or received from a peer
2249 typedef struct MUST_USE_STRUCT LDKFundingSigned {
2251 * A pointer to the opaque Rust object.
2252 * Nearly everywhere, inner must be non-null, however in places where
2253 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2255 LDKnativeFundingSigned *inner;
2257 * Indicates that this is the only struct which contains the same pointer.
2258 * Rust functions which take ownership of an object provided via an argument require
2259 * this to be true and invalidate the object pointed to by inner.
2267 * A funding_locked message to be sent or received from a peer
2269 typedef struct MUST_USE_STRUCT LDKFundingLocked {
2271 * A pointer to the opaque Rust object.
2272 * Nearly everywhere, inner must be non-null, however in places where
2273 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2275 LDKnativeFundingLocked *inner;
2277 * Indicates that this is the only struct which contains the same pointer.
2278 * Rust functions which take ownership of an object provided via an argument require
2279 * this to be true and invalidate the object pointed to by inner.
2287 * An announcement_signatures message to be sent or received from a peer
2289 typedef struct MUST_USE_STRUCT LDKAnnouncementSignatures {
2291 * A pointer to the opaque Rust object.
2292 * Nearly everywhere, inner must be non-null, however in places where
2293 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2295 LDKnativeAnnouncementSignatures *inner;
2297 * Indicates that this is the only struct which contains the same pointer.
2298 * Rust functions which take ownership of an object provided via an argument require
2299 * this to be true and invalidate the object pointed to by inner.
2302 } LDKAnnouncementSignatures;
2307 * Struct used to return values from revoke_and_ack messages, containing a bunch of commitment
2308 * transaction updates if they were pending.
2310 typedef struct MUST_USE_STRUCT LDKCommitmentUpdate {
2312 * A pointer to the opaque Rust object.
2313 * Nearly everywhere, inner must be non-null, however in places where
2314 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2316 LDKnativeCommitmentUpdate *inner;
2318 * Indicates that this is the only struct which contains the same pointer.
2319 * Rust functions which take ownership of an object provided via an argument require
2320 * this to be true and invalidate the object pointed to by inner.
2323 } LDKCommitmentUpdate;
2328 * A revoke_and_ack message to be sent or received from a peer
2330 typedef struct MUST_USE_STRUCT LDKRevokeAndACK {
2332 * A pointer to the opaque Rust object.
2333 * Nearly everywhere, inner must be non-null, however in places where
2334 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2336 LDKnativeRevokeAndACK *inner;
2338 * Indicates that this is the only struct which contains the same pointer.
2339 * Rust functions which take ownership of an object provided via an argument require
2340 * this to be true and invalidate the object pointed to by inner.
2348 * A closing_signed message to be sent or received from a peer
2350 typedef struct MUST_USE_STRUCT LDKClosingSigned {
2352 * A pointer to the opaque Rust object.
2353 * Nearly everywhere, inner must be non-null, however in places where
2354 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2356 LDKnativeClosingSigned *inner;
2358 * Indicates that this is the only struct which contains the same pointer.
2359 * Rust functions which take ownership of an object provided via an argument require
2360 * this to be true and invalidate the object pointed to by inner.
2368 * A shutdown message to be sent or received from a peer
2370 typedef struct MUST_USE_STRUCT LDKShutdown {
2372 * A pointer to the opaque Rust object.
2373 * Nearly everywhere, inner must be non-null, however in places where
2374 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2376 LDKnativeShutdown *inner;
2378 * Indicates that this is the only struct which contains the same pointer.
2379 * Rust functions which take ownership of an object provided via an argument require
2380 * this to be true and invalidate the object pointed to by inner.
2388 * A channel_reestablish message to be sent or received from a peer
2390 typedef struct MUST_USE_STRUCT LDKChannelReestablish {
2392 * A pointer to the opaque Rust object.
2393 * Nearly everywhere, inner must be non-null, however in places where
2394 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2396 LDKnativeChannelReestablish *inner;
2398 * Indicates that this is the only struct which contains the same pointer.
2399 * Rust functions which take ownership of an object provided via an argument require
2400 * this to be true and invalidate the object pointed to by inner.
2403 } LDKChannelReestablish;
2408 * A channel_announcement message to be sent or received from a peer
2410 typedef struct MUST_USE_STRUCT LDKChannelAnnouncement {
2412 * A pointer to the opaque Rust object.
2413 * Nearly everywhere, inner must be non-null, however in places where
2414 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2416 LDKnativeChannelAnnouncement *inner;
2418 * Indicates that this is the only struct which contains the same pointer.
2419 * Rust functions which take ownership of an object provided via an argument require
2420 * this to be true and invalidate the object pointed to by inner.
2423 } LDKChannelAnnouncement;
2428 * A node_announcement message to be sent or received from a peer
2430 typedef struct MUST_USE_STRUCT LDKNodeAnnouncement {
2432 * A pointer to the opaque Rust object.
2433 * Nearly everywhere, inner must be non-null, however in places where
2434 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2436 LDKnativeNodeAnnouncement *inner;
2438 * Indicates that this is the only struct which contains the same pointer.
2439 * Rust functions which take ownership of an object provided via an argument require
2440 * this to be true and invalidate the object pointed to by inner.
2443 } LDKNodeAnnouncement;
2448 * An error message to be sent or received from a peer
2450 typedef struct MUST_USE_STRUCT LDKErrorMessage {
2452 * A pointer to the opaque Rust object.
2453 * Nearly everywhere, inner must be non-null, however in places where
2454 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2456 LDKnativeErrorMessage *inner;
2458 * Indicates that this is the only struct which contains the same pointer.
2459 * Rust functions which take ownership of an object provided via an argument require
2460 * this to be true and invalidate the object pointed to by inner.
2466 * Used to put an error message in a LightningError
2468 typedef enum LDKErrorAction_Tag {
2470 * The peer took some action which made us think they were useless. Disconnect them.
2472 LDKErrorAction_DisconnectPeer,
2474 * The peer did something harmless that we weren't able to process, just log and ignore
2476 LDKErrorAction_IgnoreError,
2478 * The peer did something harmless that we weren't able to meaningfully process.
2479 * If the error is logged, log it at the given level.
2481 LDKErrorAction_IgnoreAndLog,
2483 * The peer did something incorrect. Tell them.
2485 LDKErrorAction_SendErrorMessage,
2487 * Must be last for serialization purposes
2489 LDKErrorAction_Sentinel,
2490 } LDKErrorAction_Tag;
2492 typedef struct LDKErrorAction_LDKDisconnectPeer_Body {
2494 * An error message which we should make an effort to send before we disconnect.
2496 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
2498 struct LDKErrorMessage msg;
2499 } LDKErrorAction_LDKDisconnectPeer_Body;
2501 typedef struct LDKErrorAction_LDKSendErrorMessage_Body {
2503 * The message to send.
2505 struct LDKErrorMessage msg;
2506 } LDKErrorAction_LDKSendErrorMessage_Body;
2508 typedef struct MUST_USE_STRUCT LDKErrorAction {
2509 LDKErrorAction_Tag tag;
2511 LDKErrorAction_LDKDisconnectPeer_Body disconnect_peer;
2513 enum LDKLevel ignore_and_log;
2515 LDKErrorAction_LDKSendErrorMessage_Body send_error_message;
2522 * A query_channel_range message is used to query a peer for channel
2523 * UTXOs in a range of blocks. The recipient of a query makes a best
2524 * effort to reply to the query using one or more reply_channel_range
2527 typedef struct MUST_USE_STRUCT LDKQueryChannelRange {
2529 * A pointer to the opaque Rust object.
2530 * Nearly everywhere, inner must be non-null, however in places where
2531 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2533 LDKnativeQueryChannelRange *inner;
2535 * Indicates that this is the only struct which contains the same pointer.
2536 * Rust functions which take ownership of an object provided via an argument require
2537 * this to be true and invalidate the object pointed to by inner.
2540 } LDKQueryChannelRange;
2545 * A query_short_channel_ids message is used to query a peer for
2546 * routing gossip messages related to one or more short_channel_ids.
2547 * The query recipient will reply with the latest, if available,
2548 * channel_announcement, channel_update and node_announcement messages
2549 * it maintains for the requested short_channel_ids followed by a
2550 * reply_short_channel_ids_end message. The short_channel_ids sent in
2551 * this query are encoded. We only support encoding_type=0 uncompressed
2552 * serialization and do not support encoding_type=1 zlib serialization.
2554 typedef struct MUST_USE_STRUCT LDKQueryShortChannelIds {
2556 * A pointer to the opaque Rust object.
2557 * Nearly everywhere, inner must be non-null, however in places where
2558 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2560 LDKnativeQueryShortChannelIds *inner;
2562 * Indicates that this is the only struct which contains the same pointer.
2563 * Rust functions which take ownership of an object provided via an argument require
2564 * this to be true and invalidate the object pointed to by inner.
2567 } LDKQueryShortChannelIds;
2572 * A reply_channel_range message is a reply to a query_channel_range
2573 * message. Multiple reply_channel_range messages can be sent in reply
2574 * to a single query_channel_range message. The query recipient makes a
2575 * best effort to respond based on their local network view which may
2576 * not be a perfect view of the network. The short_channel_ids in the
2577 * reply are encoded. We only support encoding_type=0 uncompressed
2578 * serialization and do not support encoding_type=1 zlib serialization.
2580 typedef struct MUST_USE_STRUCT LDKReplyChannelRange {
2582 * A pointer to the opaque Rust object.
2583 * Nearly everywhere, inner must be non-null, however in places where
2584 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2586 LDKnativeReplyChannelRange *inner;
2588 * Indicates that this is the only struct which contains the same pointer.
2589 * Rust functions which take ownership of an object provided via an argument require
2590 * this to be true and invalidate the object pointed to by inner.
2593 } LDKReplyChannelRange;
2596 * An event generated by ChannelManager which indicates a message should be sent to a peer (or
2597 * broadcast to most peers).
2598 * These events are handled by PeerManager::process_events if you are using a PeerManager.
2600 typedef enum LDKMessageSendEvent_Tag {
2602 * Used to indicate that we've accepted a channel open and should send the accept_channel
2603 * message provided to the given peer.
2605 LDKMessageSendEvent_SendAcceptChannel,
2607 * Used to indicate that we've initiated a channel open and should send the open_channel
2608 * message provided to the given peer.
2610 LDKMessageSendEvent_SendOpenChannel,
2612 * Used to indicate that a funding_created message should be sent to the peer with the given node_id.
2614 LDKMessageSendEvent_SendFundingCreated,
2616 * Used to indicate that a funding_signed message should be sent to the peer with the given node_id.
2618 LDKMessageSendEvent_SendFundingSigned,
2620 * Used to indicate that a funding_locked message should be sent to the peer with the given node_id.
2622 LDKMessageSendEvent_SendFundingLocked,
2624 * Used to indicate that an announcement_signatures message should be sent to the peer with the given node_id.
2626 LDKMessageSendEvent_SendAnnouncementSignatures,
2628 * Used to indicate that a series of HTLC update messages, as well as a commitment_signed
2629 * message should be sent to the peer with the given node_id.
2631 LDKMessageSendEvent_UpdateHTLCs,
2633 * Used to indicate that a revoke_and_ack message should be sent to the peer with the given node_id.
2635 LDKMessageSendEvent_SendRevokeAndACK,
2637 * Used to indicate that a closing_signed message should be sent to the peer with the given node_id.
2639 LDKMessageSendEvent_SendClosingSigned,
2641 * Used to indicate that a shutdown message should be sent to the peer with the given node_id.
2643 LDKMessageSendEvent_SendShutdown,
2645 * Used to indicate that a channel_reestablish message should be sent to the peer with the given node_id.
2647 LDKMessageSendEvent_SendChannelReestablish,
2649 * Used to indicate that a channel_announcement and channel_update should be broadcast to all
2650 * peers (except the peer with node_id either msg.contents.node_id_1 or msg.contents.node_id_2).
2652 * Note that after doing so, you very likely (unless you did so very recently) want to call
2653 * ChannelManager::broadcast_node_announcement to trigger a BroadcastNodeAnnouncement event.
2654 * This ensures that any nodes which see our channel_announcement also have a relevant
2655 * node_announcement, including relevant feature flags which may be important for routing
2658 LDKMessageSendEvent_BroadcastChannelAnnouncement,
2660 * Used to indicate that a node_announcement should be broadcast to all peers.
2662 LDKMessageSendEvent_BroadcastNodeAnnouncement,
2664 * Used to indicate that a channel_update should be broadcast to all peers.
2666 LDKMessageSendEvent_BroadcastChannelUpdate,
2668 * Used to indicate that a channel_update should be sent to a single peer.
2669 * In contrast to [`Self::BroadcastChannelUpdate`], this is used when the channel is a
2670 * private channel and we shouldn't be informing all of our peers of channel parameters.
2672 LDKMessageSendEvent_SendChannelUpdate,
2674 * Broadcast an error downstream to be handled
2676 LDKMessageSendEvent_HandleError,
2678 * Query a peer for channels with funding transaction UTXOs in a block range.
2680 LDKMessageSendEvent_SendChannelRangeQuery,
2682 * Request routing gossip messages from a peer for a list of channels identified by
2683 * their short_channel_ids.
2685 LDKMessageSendEvent_SendShortIdsQuery,
2687 * Sends a reply to a channel range query. This may be one of several SendReplyChannelRange events
2688 * emitted during processing of the query.
2690 LDKMessageSendEvent_SendReplyChannelRange,
2692 * Must be last for serialization purposes
2694 LDKMessageSendEvent_Sentinel,
2695 } LDKMessageSendEvent_Tag;
2697 typedef struct LDKMessageSendEvent_LDKSendAcceptChannel_Body {
2699 * The node_id of the node which should receive this message
2701 struct LDKPublicKey node_id;
2703 * The message which should be sent.
2705 struct LDKAcceptChannel msg;
2706 } LDKMessageSendEvent_LDKSendAcceptChannel_Body;
2708 typedef struct LDKMessageSendEvent_LDKSendOpenChannel_Body {
2710 * The node_id of the node which should receive this message
2712 struct LDKPublicKey node_id;
2714 * The message which should be sent.
2716 struct LDKOpenChannel msg;
2717 } LDKMessageSendEvent_LDKSendOpenChannel_Body;
2719 typedef struct LDKMessageSendEvent_LDKSendFundingCreated_Body {
2721 * The node_id of the node which should receive this message
2723 struct LDKPublicKey node_id;
2725 * The message which should be sent.
2727 struct LDKFundingCreated msg;
2728 } LDKMessageSendEvent_LDKSendFundingCreated_Body;
2730 typedef struct LDKMessageSendEvent_LDKSendFundingSigned_Body {
2732 * The node_id of the node which should receive this message
2734 struct LDKPublicKey node_id;
2736 * The message which should be sent.
2738 struct LDKFundingSigned msg;
2739 } LDKMessageSendEvent_LDKSendFundingSigned_Body;
2741 typedef struct LDKMessageSendEvent_LDKSendFundingLocked_Body {
2743 * The node_id of the node which should receive these message(s)
2745 struct LDKPublicKey node_id;
2747 * The funding_locked message which should be sent.
2749 struct LDKFundingLocked msg;
2750 } LDKMessageSendEvent_LDKSendFundingLocked_Body;
2752 typedef struct LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body {
2754 * The node_id of the node which should receive these message(s)
2756 struct LDKPublicKey node_id;
2758 * The announcement_signatures message which should be sent.
2760 struct LDKAnnouncementSignatures msg;
2761 } LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body;
2763 typedef struct LDKMessageSendEvent_LDKUpdateHTLCs_Body {
2765 * The node_id of the node which should receive these message(s)
2767 struct LDKPublicKey node_id;
2769 * The update messages which should be sent. ALL messages in the struct should be sent!
2771 struct LDKCommitmentUpdate updates;
2772 } LDKMessageSendEvent_LDKUpdateHTLCs_Body;
2774 typedef struct LDKMessageSendEvent_LDKSendRevokeAndACK_Body {
2776 * The node_id of the node which should receive this message
2778 struct LDKPublicKey node_id;
2780 * The message which should be sent.
2782 struct LDKRevokeAndACK msg;
2783 } LDKMessageSendEvent_LDKSendRevokeAndACK_Body;
2785 typedef struct LDKMessageSendEvent_LDKSendClosingSigned_Body {
2787 * The node_id of the node which should receive this message
2789 struct LDKPublicKey node_id;
2791 * The message which should be sent.
2793 struct LDKClosingSigned msg;
2794 } LDKMessageSendEvent_LDKSendClosingSigned_Body;
2796 typedef struct LDKMessageSendEvent_LDKSendShutdown_Body {
2798 * The node_id of the node which should receive this message
2800 struct LDKPublicKey node_id;
2802 * The message which should be sent.
2804 struct LDKShutdown msg;
2805 } LDKMessageSendEvent_LDKSendShutdown_Body;
2807 typedef struct LDKMessageSendEvent_LDKSendChannelReestablish_Body {
2809 * The node_id of the node which should receive this message
2811 struct LDKPublicKey node_id;
2813 * The message which should be sent.
2815 struct LDKChannelReestablish msg;
2816 } LDKMessageSendEvent_LDKSendChannelReestablish_Body;
2818 typedef struct LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body {
2820 * The channel_announcement which should be sent.
2822 struct LDKChannelAnnouncement msg;
2824 * The followup channel_update which should be sent.
2826 struct LDKChannelUpdate update_msg;
2827 } LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body;
2829 typedef struct LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body {
2831 * The node_announcement which should be sent.
2833 struct LDKNodeAnnouncement msg;
2834 } LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body;
2836 typedef struct LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body {
2838 * The channel_update which should be sent.
2840 struct LDKChannelUpdate msg;
2841 } LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body;
2843 typedef struct LDKMessageSendEvent_LDKSendChannelUpdate_Body {
2845 * The node_id of the node which should receive this message
2847 struct LDKPublicKey node_id;
2849 * The channel_update which should be sent.
2851 struct LDKChannelUpdate msg;
2852 } LDKMessageSendEvent_LDKSendChannelUpdate_Body;
2854 typedef struct LDKMessageSendEvent_LDKHandleError_Body {
2856 * The node_id of the node which should receive this message
2858 struct LDKPublicKey node_id;
2860 * The action which should be taken.
2862 struct LDKErrorAction action;
2863 } LDKMessageSendEvent_LDKHandleError_Body;
2865 typedef struct LDKMessageSendEvent_LDKSendChannelRangeQuery_Body {
2867 * The node_id of this message recipient
2869 struct LDKPublicKey node_id;
2871 * The query_channel_range which should be sent.
2873 struct LDKQueryChannelRange msg;
2874 } LDKMessageSendEvent_LDKSendChannelRangeQuery_Body;
2876 typedef struct LDKMessageSendEvent_LDKSendShortIdsQuery_Body {
2878 * The node_id of this message recipient
2880 struct LDKPublicKey node_id;
2882 * The query_short_channel_ids which should be sent.
2884 struct LDKQueryShortChannelIds msg;
2885 } LDKMessageSendEvent_LDKSendShortIdsQuery_Body;
2887 typedef struct LDKMessageSendEvent_LDKSendReplyChannelRange_Body {
2889 * The node_id of this message recipient
2891 struct LDKPublicKey node_id;
2893 * The reply_channel_range which should be sent.
2895 struct LDKReplyChannelRange msg;
2896 } LDKMessageSendEvent_LDKSendReplyChannelRange_Body;
2898 typedef struct MUST_USE_STRUCT LDKMessageSendEvent {
2899 LDKMessageSendEvent_Tag tag;
2901 LDKMessageSendEvent_LDKSendAcceptChannel_Body send_accept_channel;
2902 LDKMessageSendEvent_LDKSendOpenChannel_Body send_open_channel;
2903 LDKMessageSendEvent_LDKSendFundingCreated_Body send_funding_created;
2904 LDKMessageSendEvent_LDKSendFundingSigned_Body send_funding_signed;
2905 LDKMessageSendEvent_LDKSendFundingLocked_Body send_funding_locked;
2906 LDKMessageSendEvent_LDKSendAnnouncementSignatures_Body send_announcement_signatures;
2907 LDKMessageSendEvent_LDKUpdateHTLCs_Body update_htl_cs;
2908 LDKMessageSendEvent_LDKSendRevokeAndACK_Body send_revoke_and_ack;
2909 LDKMessageSendEvent_LDKSendClosingSigned_Body send_closing_signed;
2910 LDKMessageSendEvent_LDKSendShutdown_Body send_shutdown;
2911 LDKMessageSendEvent_LDKSendChannelReestablish_Body send_channel_reestablish;
2912 LDKMessageSendEvent_LDKBroadcastChannelAnnouncement_Body broadcast_channel_announcement;
2913 LDKMessageSendEvent_LDKBroadcastNodeAnnouncement_Body broadcast_node_announcement;
2914 LDKMessageSendEvent_LDKBroadcastChannelUpdate_Body broadcast_channel_update;
2915 LDKMessageSendEvent_LDKSendChannelUpdate_Body send_channel_update;
2916 LDKMessageSendEvent_LDKHandleError_Body handle_error;
2917 LDKMessageSendEvent_LDKSendChannelRangeQuery_Body send_channel_range_query;
2918 LDKMessageSendEvent_LDKSendShortIdsQuery_Body send_short_ids_query;
2919 LDKMessageSendEvent_LDKSendReplyChannelRange_Body send_reply_channel_range;
2921 } LDKMessageSendEvent;
2924 * A dynamically-allocated array of crate::lightning::util::events::MessageSendEvents of arbitrary size.
2925 * This corresponds to std::vector in C++
2927 typedef struct LDKCVec_MessageSendEventZ {
2929 * The elements in the array.
2930 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
2932 struct LDKMessageSendEvent *data;
2934 * The number of elements pointed to by `data`.
2937 } LDKCVec_MessageSendEventZ;
2942 * Features used within an `init` message.
2944 typedef struct MUST_USE_STRUCT LDKInitFeatures {
2946 * A pointer to the opaque Rust object.
2947 * Nearly everywhere, inner must be non-null, however in places where
2948 * the Rust equivalent takes an Option, it may be set to null to indicate None.
2950 LDKnativeInitFeatures *inner;
2952 * Indicates that this is the only struct which contains the same pointer.
2953 * Rust functions which take ownership of an object provided via an argument require
2954 * this to be true and invalidate the object pointed to by inner.
2960 * The contents of CResult_InitFeaturesDecodeErrorZ
2962 typedef union LDKCResult_InitFeaturesDecodeErrorZPtr {
2964 * A pointer to the contents in the success state.
2965 * Reading from this pointer when `result_ok` is not set is undefined.
2967 struct LDKInitFeatures *result;
2969 * A pointer to the contents in the error state.
2970 * Reading from this pointer when `result_ok` is set is undefined.
2972 struct LDKDecodeError *err;
2973 } LDKCResult_InitFeaturesDecodeErrorZPtr;
2976 * A CResult_InitFeaturesDecodeErrorZ represents the result of a fallible operation,
2977 * containing a crate::lightning::ln::features::InitFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
2978 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
2980 typedef struct LDKCResult_InitFeaturesDecodeErrorZ {
2982 * The contents of this CResult_InitFeaturesDecodeErrorZ, accessible via either
2983 * `err` or `result` depending on the state of `result_ok`.
2985 union LDKCResult_InitFeaturesDecodeErrorZPtr contents;
2987 * Whether this CResult_InitFeaturesDecodeErrorZ represents a success state.
2990 } LDKCResult_InitFeaturesDecodeErrorZ;
2995 * Features used within a `node_announcement` message.
2997 typedef struct MUST_USE_STRUCT LDKNodeFeatures {
2999 * A pointer to the opaque Rust object.
3000 * Nearly everywhere, inner must be non-null, however in places where
3001 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3003 LDKnativeNodeFeatures *inner;
3005 * Indicates that this is the only struct which contains the same pointer.
3006 * Rust functions which take ownership of an object provided via an argument require
3007 * this to be true and invalidate the object pointed to by inner.
3013 * The contents of CResult_NodeFeaturesDecodeErrorZ
3015 typedef union LDKCResult_NodeFeaturesDecodeErrorZPtr {
3017 * A pointer to the contents in the success state.
3018 * Reading from this pointer when `result_ok` is not set is undefined.
3020 struct LDKNodeFeatures *result;
3022 * A pointer to the contents in the error state.
3023 * Reading from this pointer when `result_ok` is set is undefined.
3025 struct LDKDecodeError *err;
3026 } LDKCResult_NodeFeaturesDecodeErrorZPtr;
3029 * A CResult_NodeFeaturesDecodeErrorZ represents the result of a fallible operation,
3030 * containing a crate::lightning::ln::features::NodeFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
3031 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3033 typedef struct LDKCResult_NodeFeaturesDecodeErrorZ {
3035 * The contents of this CResult_NodeFeaturesDecodeErrorZ, accessible via either
3036 * `err` or `result` depending on the state of `result_ok`.
3038 union LDKCResult_NodeFeaturesDecodeErrorZPtr contents;
3040 * Whether this CResult_NodeFeaturesDecodeErrorZ represents a success state.
3043 } LDKCResult_NodeFeaturesDecodeErrorZ;
3048 * Features used within a `channel_announcement` message.
3050 typedef struct MUST_USE_STRUCT LDKChannelFeatures {
3052 * A pointer to the opaque Rust object.
3053 * Nearly everywhere, inner must be non-null, however in places where
3054 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3056 LDKnativeChannelFeatures *inner;
3058 * Indicates that this is the only struct which contains the same pointer.
3059 * Rust functions which take ownership of an object provided via an argument require
3060 * this to be true and invalidate the object pointed to by inner.
3063 } LDKChannelFeatures;
3066 * The contents of CResult_ChannelFeaturesDecodeErrorZ
3068 typedef union LDKCResult_ChannelFeaturesDecodeErrorZPtr {
3070 * A pointer to the contents in the success state.
3071 * Reading from this pointer when `result_ok` is not set is undefined.
3073 struct LDKChannelFeatures *result;
3075 * A pointer to the contents in the error state.
3076 * Reading from this pointer when `result_ok` is set is undefined.
3078 struct LDKDecodeError *err;
3079 } LDKCResult_ChannelFeaturesDecodeErrorZPtr;
3082 * A CResult_ChannelFeaturesDecodeErrorZ represents the result of a fallible operation,
3083 * containing a crate::lightning::ln::features::ChannelFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
3084 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3086 typedef struct LDKCResult_ChannelFeaturesDecodeErrorZ {
3088 * The contents of this CResult_ChannelFeaturesDecodeErrorZ, accessible via either
3089 * `err` or `result` depending on the state of `result_ok`.
3091 union LDKCResult_ChannelFeaturesDecodeErrorZPtr contents;
3093 * Whether this CResult_ChannelFeaturesDecodeErrorZ represents a success state.
3096 } LDKCResult_ChannelFeaturesDecodeErrorZ;
3101 * Features used within an invoice.
3103 typedef struct MUST_USE_STRUCT LDKInvoiceFeatures {
3105 * A pointer to the opaque Rust object.
3106 * Nearly everywhere, inner must be non-null, however in places where
3107 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3109 LDKnativeInvoiceFeatures *inner;
3111 * Indicates that this is the only struct which contains the same pointer.
3112 * Rust functions which take ownership of an object provided via an argument require
3113 * this to be true and invalidate the object pointed to by inner.
3116 } LDKInvoiceFeatures;
3119 * The contents of CResult_InvoiceFeaturesDecodeErrorZ
3121 typedef union LDKCResult_InvoiceFeaturesDecodeErrorZPtr {
3123 * A pointer to the contents in the success state.
3124 * Reading from this pointer when `result_ok` is not set is undefined.
3126 struct LDKInvoiceFeatures *result;
3128 * A pointer to the contents in the error state.
3129 * Reading from this pointer when `result_ok` is set is undefined.
3131 struct LDKDecodeError *err;
3132 } LDKCResult_InvoiceFeaturesDecodeErrorZPtr;
3135 * A CResult_InvoiceFeaturesDecodeErrorZ represents the result of a fallible operation,
3136 * containing a crate::lightning::ln::features::InvoiceFeatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
3137 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3139 typedef struct LDKCResult_InvoiceFeaturesDecodeErrorZ {
3141 * The contents of this CResult_InvoiceFeaturesDecodeErrorZ, accessible via either
3142 * `err` or `result` depending on the state of `result_ok`.
3144 union LDKCResult_InvoiceFeaturesDecodeErrorZPtr contents;
3146 * Whether this CResult_InvoiceFeaturesDecodeErrorZ represents a success state.
3149 } LDKCResult_InvoiceFeaturesDecodeErrorZ;
3152 * The contents of CResult_DelayedPaymentOutputDescriptorDecodeErrorZ
3154 typedef union LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZPtr {
3156 * A pointer to the contents in the success state.
3157 * Reading from this pointer when `result_ok` is not set is undefined.
3159 struct LDKDelayedPaymentOutputDescriptor *result;
3161 * A pointer to the contents in the error state.
3162 * Reading from this pointer when `result_ok` is set is undefined.
3164 struct LDKDecodeError *err;
3165 } LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZPtr;
3168 * A CResult_DelayedPaymentOutputDescriptorDecodeErrorZ represents the result of a fallible operation,
3169 * containing a crate::lightning::chain::keysinterface::DelayedPaymentOutputDescriptor on success and a crate::lightning::ln::msgs::DecodeError on failure.
3170 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3172 typedef struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ {
3174 * The contents of this CResult_DelayedPaymentOutputDescriptorDecodeErrorZ, accessible via either
3175 * `err` or `result` depending on the state of `result_ok`.
3177 union LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZPtr contents;
3179 * Whether this CResult_DelayedPaymentOutputDescriptorDecodeErrorZ represents a success state.
3182 } LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ;
3185 * The contents of CResult_StaticPaymentOutputDescriptorDecodeErrorZ
3187 typedef union LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZPtr {
3189 * A pointer to the contents in the success state.
3190 * Reading from this pointer when `result_ok` is not set is undefined.
3192 struct LDKStaticPaymentOutputDescriptor *result;
3194 * A pointer to the contents in the error state.
3195 * Reading from this pointer when `result_ok` is set is undefined.
3197 struct LDKDecodeError *err;
3198 } LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZPtr;
3201 * A CResult_StaticPaymentOutputDescriptorDecodeErrorZ represents the result of a fallible operation,
3202 * containing a crate::lightning::chain::keysinterface::StaticPaymentOutputDescriptor on success and a crate::lightning::ln::msgs::DecodeError on failure.
3203 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3205 typedef struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ {
3207 * The contents of this CResult_StaticPaymentOutputDescriptorDecodeErrorZ, accessible via either
3208 * `err` or `result` depending on the state of `result_ok`.
3210 union LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZPtr contents;
3212 * Whether this CResult_StaticPaymentOutputDescriptorDecodeErrorZ represents a success state.
3215 } LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ;
3218 * The contents of CResult_SpendableOutputDescriptorDecodeErrorZ
3220 typedef union LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr {
3222 * A pointer to the contents in the success state.
3223 * Reading from this pointer when `result_ok` is not set is undefined.
3225 struct LDKSpendableOutputDescriptor *result;
3227 * A pointer to the contents in the error state.
3228 * Reading from this pointer when `result_ok` is set is undefined.
3230 struct LDKDecodeError *err;
3231 } LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr;
3234 * A CResult_SpendableOutputDescriptorDecodeErrorZ represents the result of a fallible operation,
3235 * containing a crate::lightning::chain::keysinterface::SpendableOutputDescriptor on success and a crate::lightning::ln::msgs::DecodeError on failure.
3236 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3238 typedef struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ {
3240 * The contents of this CResult_SpendableOutputDescriptorDecodeErrorZ, accessible via either
3241 * `err` or `result` depending on the state of `result_ok`.
3243 union LDKCResult_SpendableOutputDescriptorDecodeErrorZPtr contents;
3245 * Whether this CResult_SpendableOutputDescriptorDecodeErrorZ represents a success state.
3248 } LDKCResult_SpendableOutputDescriptorDecodeErrorZ;
3251 * The contents of CResult_NoneNoneZ
3253 typedef union LDKCResult_NoneNoneZPtr {
3255 * Note that this value is always NULL, as there are no contents in the OK variant
3259 * Note that this value is always NULL, as there are no contents in the Err variant
3262 } LDKCResult_NoneNoneZPtr;
3265 * A CResult_NoneNoneZ represents the result of a fallible operation,
3266 * containing a () on success and a () on failure.
3267 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3269 typedef struct LDKCResult_NoneNoneZ {
3271 * The contents of this CResult_NoneNoneZ, accessible via either
3272 * `err` or `result` depending on the state of `result_ok`.
3274 union LDKCResult_NoneNoneZPtr contents;
3276 * Whether this CResult_NoneNoneZ represents a success state.
3279 } LDKCResult_NoneNoneZ;
3282 * A tuple of 2 elements. See the individual fields for the types contained.
3284 typedef struct LDKC2Tuple_SignatureCVec_SignatureZZ {
3286 * The element at position 0
3288 struct LDKSignature a;
3290 * The element at position 1
3292 struct LDKCVec_SignatureZ b;
3293 } LDKC2Tuple_SignatureCVec_SignatureZZ;
3296 * The contents of CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ
3298 typedef union LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr {
3300 * A pointer to the contents in the success state.
3301 * Reading from this pointer when `result_ok` is not set is undefined.
3303 struct LDKC2Tuple_SignatureCVec_SignatureZZ *result;
3305 * Note that this value is always NULL, as there are no contents in the Err variant
3308 } LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr;
3311 * A CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ represents the result of a fallible operation,
3312 * containing a crate::c_types::derived::C2Tuple_SignatureCVec_SignatureZZ on success and a () on failure.
3313 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3315 typedef struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ {
3317 * The contents of this CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ, accessible via either
3318 * `err` or `result` depending on the state of `result_ok`.
3320 union LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZPtr contents;
3322 * Whether this CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ represents a success state.
3325 } LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ;
3328 * The contents of CResult_SignatureNoneZ
3330 typedef union LDKCResult_SignatureNoneZPtr {
3332 * A pointer to the contents in the success state.
3333 * Reading from this pointer when `result_ok` is not set is undefined.
3335 struct LDKSignature *result;
3337 * Note that this value is always NULL, as there are no contents in the Err variant
3340 } LDKCResult_SignatureNoneZPtr;
3343 * A CResult_SignatureNoneZ represents the result of a fallible operation,
3344 * containing a crate::c_types::Signature on success and a () on failure.
3345 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3347 typedef struct LDKCResult_SignatureNoneZ {
3349 * The contents of this CResult_SignatureNoneZ, accessible via either
3350 * `err` or `result` depending on the state of `result_ok`.
3352 union LDKCResult_SignatureNoneZPtr contents;
3354 * Whether this CResult_SignatureNoneZ represents a success state.
3357 } LDKCResult_SignatureNoneZ;
3362 * This class tracks the per-transaction information needed to build a closing transaction and will
3363 * actually build it and sign.
3365 * This class can be used inside a signer implementation to generate a signature given the relevant
3368 typedef struct MUST_USE_STRUCT LDKClosingTransaction {
3370 * A pointer to the opaque Rust object.
3371 * Nearly everywhere, inner must be non-null, however in places where
3372 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3374 LDKnativeClosingTransaction *inner;
3376 * Indicates that this is the only struct which contains the same pointer.
3377 * Rust functions which take ownership of an object provided via an argument require
3378 * this to be true and invalidate the object pointed to by inner.
3381 } LDKClosingTransaction;
3386 * The unsigned part of a channel_announcement
3388 typedef struct MUST_USE_STRUCT LDKUnsignedChannelAnnouncement {
3390 * A pointer to the opaque Rust object.
3391 * Nearly everywhere, inner must be non-null, however in places where
3392 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3394 LDKnativeUnsignedChannelAnnouncement *inner;
3396 * Indicates that this is the only struct which contains the same pointer.
3397 * Rust functions which take ownership of an object provided via an argument require
3398 * this to be true and invalidate the object pointed to by inner.
3401 } LDKUnsignedChannelAnnouncement;
3404 * A trait to sign lightning channel transactions as described in BOLT 3.
3406 * Signing services could be implemented on a hardware wallet. In this case,
3407 * the current Sign would be a front-end on top of a communication
3408 * channel connected to your secure device and lightning key material wouldn't
3409 * reside on a hot server. Nevertheless, a this deployment would still need
3410 * to trust the ChannelManager to avoid loss of funds as this latest component
3411 * could ask to sign commitment transaction with HTLCs paying to attacker pubkeys.
3413 * A more secure iteration would be to use hashlock (or payment points) to pair
3414 * invoice/incoming HTLCs with outgoing HTLCs to implement a no-trust-ChannelManager
3415 * at the price of more state and computation on the hardware wallet side. In the future,
3416 * we are looking forward to design such interface.
3418 * In any case, ChannelMonitor or fallback watchtowers are always going to be trusted
3419 * to act, as liveness and breach reply correctness are always going to be hard requirements
3420 * of LN security model, orthogonal of key management issues.
3422 typedef struct LDKBaseSign {
3424 * An opaque pointer which is passed to your function implementations as an argument.
3425 * This has no meaning in the LDK, and can be NULL or any other value.
3429 * Gets the per-commitment point for a specific commitment number
3431 * Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
3433 struct LDKPublicKey (*get_per_commitment_point)(const void *this_arg, uint64_t idx);
3435 * Gets the commitment secret for a specific commitment number as part of the revocation process
3437 * An external signer implementation should error here if the commitment was already signed
3438 * and should refuse to sign it in the future.
3440 * May be called more than once for the same index.
3442 * Note that the commitment number starts at (1 << 48) - 1 and counts backwards.
3444 struct LDKThirtyTwoBytes (*release_commitment_secret)(const void *this_arg, uint64_t idx);
3446 * Validate the counterparty's signatures on the holder commitment transaction and HTLCs.
3448 * This is required in order for the signer to make sure that releasing a commitment
3449 * secret won't leave us without a broadcastable holder transaction.
3450 * Policy checks should be implemented in this function, including checking the amount
3451 * sent to us and checking the HTLCs.
3453 struct LDKCResult_NoneNoneZ (*validate_holder_commitment)(const void *this_arg, const struct LDKHolderCommitmentTransaction *NONNULL_PTR holder_tx);
3455 * Gets the holder's channel public keys and basepoints
3457 struct LDKChannelPublicKeys pubkeys;
3459 * Fill in the pubkeys field as a reference to it will be given to Rust after this returns
3460 * Note that this takes a pointer to this object, not the this_ptr like other methods do
3461 * This function pointer may be NULL if pubkeys is filled in when this object is created and never needs updating.
3463 void (*set_pubkeys)(const struct LDKBaseSign*NONNULL_PTR );
3465 * Gets an arbitrary identifier describing the set of keys which are provided back to you in
3466 * some SpendableOutputDescriptor types. This should be sufficient to identify this
3467 * Sign object uniquely and lookup or re-derive its keys.
3469 struct LDKThirtyTwoBytes (*channel_keys_id)(const void *this_arg);
3471 * Create a signature for a counterparty's commitment transaction and associated HTLC transactions.
3473 * Note that if signing fails or is rejected, the channel will be force-closed.
3475 * Policy checks should be implemented in this function, including checking the amount
3476 * sent to us and checking the HTLCs.
3478 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ (*sign_counterparty_commitment)(const void *this_arg, const struct LDKCommitmentTransaction *NONNULL_PTR commitment_tx);
3480 * Validate the counterparty's revocation.
3482 * This is required in order for the signer to make sure that the state has moved
3483 * forward and it is safe to sign the next counterparty commitment.
3485 struct LDKCResult_NoneNoneZ (*validate_counterparty_revocation)(const void *this_arg, uint64_t idx, const uint8_t (*secret)[32]);
3487 * Create a signatures for a holder's commitment transaction and its claiming HTLC transactions.
3488 * This will only ever be called with a non-revoked commitment_tx. This will be called with the
3489 * latest commitment_tx when we initiate a force-close.
3490 * This will be called with the previous latest, just to get claiming HTLC signatures, if we are
3491 * reacting to a ChannelMonitor replica that decided to broadcast before it had been updated to
3493 * This may be called multiple times for the same transaction.
3495 * An external signer implementation should check that the commitment has not been revoked.
3497 * May return Err if key derivation fails. Callers, such as ChannelMonitor, will panic in such a case.
3499 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ (*sign_holder_commitment_and_htlcs)(const void *this_arg, const struct LDKHolderCommitmentTransaction *NONNULL_PTR commitment_tx);
3501 * Create a signature for the given input in a transaction spending an HTLC transaction output
3502 * or a commitment transaction `to_local` output when our counterparty broadcasts an old state.
3504 * A justice transaction may claim multiple outputs at the same time if timelocks are
3505 * similar, but only a signature for the input at index `input` should be signed for here.
3506 * It may be called multiple times for same output(s) if a fee-bump is needed with regards
3507 * to an upcoming timelock expiration.
3509 * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
3511 * per_commitment_key is revocation secret which was provided by our counterparty when they
3512 * revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
3513 * not allow the spending of any funds by itself (you need our holder revocation_secret to do
3516 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]);
3518 * Create a signature for the given input in a transaction spending a commitment transaction
3519 * HTLC output when our counterparty broadcasts an old state.
3521 * A justice transaction may claim multiple outputs at the same time if timelocks are
3522 * similar, but only a signature for the input at index `input` should be signed for here.
3523 * It may be called multiple times for same output(s) if a fee-bump is needed with regards
3524 * to an upcoming timelock expiration.
3526 * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
3528 * per_commitment_key is revocation secret which was provided by our counterparty when they
3529 * revoked the state which they eventually broadcast. It's not a _holder_ secret key and does
3530 * not allow the spending of any funds by itself (you need our holder revocation_secret to do
3533 * htlc holds HTLC elements (hash, timelock), thus changing the format of the witness script
3534 * (which is committed to in the BIP 143 signatures).
3536 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);
3538 * Create a signature for a claiming transaction for a HTLC output on a counterparty's commitment
3539 * transaction, either offered or received.
3541 * Such a transaction may claim multiples offered outputs at same time if we know the
3542 * preimage for each when we create it, but only the input at index `input` should be
3543 * signed for here. It may be called multiple times for same output(s) if a fee-bump is
3544 * needed with regards to an upcoming timelock expiration.
3546 * Witness_script is either a offered or received script as defined in BOLT3 for HTLC
3549 * Amount is value of the output spent by this input, committed to in the BIP 143 signature.
3551 * Per_commitment_point is the dynamic point corresponding to the channel state
3552 * detected onchain. It has been generated by our counterparty and is used to derive
3553 * channel state keys, which are then included in the witness script and committed to in the
3554 * BIP 143 signature.
3556 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);
3558 * Create a signature for a (proposed) closing transaction.
3560 * Note that, due to rounding, there may be one \"missing\" satoshi, and either party may have
3561 * chosen to forgo their output as dust.
3563 struct LDKCResult_SignatureNoneZ (*sign_closing_transaction)(const void *this_arg, const struct LDKClosingTransaction *NONNULL_PTR closing_tx);
3565 * Signs a channel announcement message with our funding key, proving it comes from one
3566 * of the channel participants.
3568 * Note that if this fails or is rejected, the channel will not be publicly announced and
3569 * our counterparty may (though likely will not) close the channel on us for violating the
3572 struct LDKCResult_SignatureNoneZ (*sign_channel_announcement)(const void *this_arg, const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR msg);
3574 * Set the counterparty static channel data, including basepoints,
3575 * counterparty_selected/holder_selected_contest_delay and funding outpoint.
3576 * This is done as soon as the funding outpoint is known. Since these are static channel data,
3577 * they MUST NOT be allowed to change to different values once set.
3579 * channel_parameters.is_populated() MUST be true.
3581 * We bind holder_selected_contest_delay late here for API convenience.
3583 * Will be called before any signatures are applied.
3585 void (*ready_channel)(void *this_arg, const struct LDKChannelTransactionParameters *NONNULL_PTR channel_parameters);
3587 * Frees any resources associated with this object given its this_arg pointer.
3588 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
3590 void (*free)(void *this_arg);
3594 * A cloneable signer.
3596 * Although we require signers to be cloneable, it may be useful for developers to be able to use
3597 * signers in an un-sized way, for example as `dyn BaseSign`. Therefore we separate the Clone trait,
3598 * which implies Sized, into this derived trait.
3600 typedef struct LDKSign {
3602 * An opaque pointer which is passed to your function implementations as an argument.
3603 * This has no meaning in the LDK, and can be NULL or any other value.
3607 * Implementation of BaseSign for this object.
3609 struct LDKBaseSign BaseSign;
3611 * Serialize the object into a byte array
3613 struct LDKCVec_u8Z (*write)(const void *this_arg);
3615 * Called, if set, after this Sign has been cloned into a duplicate object.
3616 * The new Sign is provided, and should be mutated as needed to perform a
3617 * deep copy of the object pointed to by this_arg or avoid any double-freeing.
3619 void (*cloned)(struct LDKSign *NONNULL_PTR new_Sign);
3621 * Frees any resources associated with this object given its this_arg pointer.
3622 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
3624 void (*free)(void *this_arg);
3628 * The contents of CResult_SignDecodeErrorZ
3630 typedef union LDKCResult_SignDecodeErrorZPtr {
3632 * A pointer to the contents in the success state.
3633 * Reading from this pointer when `result_ok` is not set is undefined.
3635 struct LDKSign *result;
3637 * A pointer to the contents in the error state.
3638 * Reading from this pointer when `result_ok` is set is undefined.
3640 struct LDKDecodeError *err;
3641 } LDKCResult_SignDecodeErrorZPtr;
3644 * A CResult_SignDecodeErrorZ represents the result of a fallible operation,
3645 * containing a crate::lightning::chain::keysinterface::Sign on success and a crate::lightning::ln::msgs::DecodeError on failure.
3646 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3648 typedef struct LDKCResult_SignDecodeErrorZ {
3650 * The contents of this CResult_SignDecodeErrorZ, accessible via either
3651 * `err` or `result` depending on the state of `result_ok`.
3653 union LDKCResult_SignDecodeErrorZPtr contents;
3655 * Whether this CResult_SignDecodeErrorZ represents a success state.
3658 } LDKCResult_SignDecodeErrorZ;
3661 * Represents a secp256k1 signature serialized as two 32-byte numbers as well as a tag which
3662 * allows recovering the exact public key which created the signature given the message.
3664 typedef struct LDKRecoverableSignature {
3666 * The bytes of the signature in "compact" form plus a "Recovery ID" which allows for
3669 uint8_t serialized_form[68];
3670 } LDKRecoverableSignature;
3673 * The contents of CResult_RecoverableSignatureNoneZ
3675 typedef union LDKCResult_RecoverableSignatureNoneZPtr {
3677 * A pointer to the contents in the success state.
3678 * Reading from this pointer when `result_ok` is not set is undefined.
3680 struct LDKRecoverableSignature *result;
3682 * Note that this value is always NULL, as there are no contents in the Err variant
3685 } LDKCResult_RecoverableSignatureNoneZPtr;
3688 * A CResult_RecoverableSignatureNoneZ represents the result of a fallible operation,
3689 * containing a crate::c_types::RecoverableSignature on success and a () on failure.
3690 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3692 typedef struct LDKCResult_RecoverableSignatureNoneZ {
3694 * The contents of this CResult_RecoverableSignatureNoneZ, accessible via either
3695 * `err` or `result` depending on the state of `result_ok`.
3697 union LDKCResult_RecoverableSignatureNoneZPtr contents;
3699 * Whether this CResult_RecoverableSignatureNoneZ represents a success state.
3702 } LDKCResult_RecoverableSignatureNoneZ;
3705 * A dynamically-allocated array of crate::c_types::derived::CVec_u8Zs of arbitrary size.
3706 * This corresponds to std::vector in C++
3708 typedef struct LDKCVec_CVec_u8ZZ {
3710 * The elements in the array.
3711 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
3713 struct LDKCVec_u8Z *data;
3715 * The number of elements pointed to by `data`.
3718 } LDKCVec_CVec_u8ZZ;
3721 * The contents of CResult_CVec_CVec_u8ZZNoneZ
3723 typedef union LDKCResult_CVec_CVec_u8ZZNoneZPtr {
3725 * A pointer to the contents in the success state.
3726 * Reading from this pointer when `result_ok` is not set is undefined.
3728 struct LDKCVec_CVec_u8ZZ *result;
3730 * Note that this value is always NULL, as there are no contents in the Err variant
3733 } LDKCResult_CVec_CVec_u8ZZNoneZPtr;
3736 * A CResult_CVec_CVec_u8ZZNoneZ represents the result of a fallible operation,
3737 * containing a crate::c_types::derived::CVec_CVec_u8ZZ on success and a () on failure.
3738 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3740 typedef struct LDKCResult_CVec_CVec_u8ZZNoneZ {
3742 * The contents of this CResult_CVec_CVec_u8ZZNoneZ, accessible via either
3743 * `err` or `result` depending on the state of `result_ok`.
3745 union LDKCResult_CVec_CVec_u8ZZNoneZPtr contents;
3747 * Whether this CResult_CVec_CVec_u8ZZNoneZ represents a success state.
3750 } LDKCResult_CVec_CVec_u8ZZNoneZ;
3755 * A simple implementation of Sign that just keeps the private keys in memory.
3757 * This implementation performs no policy checks and is insufficient by itself as
3758 * a secure external signer.
3760 typedef struct MUST_USE_STRUCT LDKInMemorySigner {
3762 * A pointer to the opaque Rust object.
3763 * Nearly everywhere, inner must be non-null, however in places where
3764 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3766 LDKnativeInMemorySigner *inner;
3768 * Indicates that this is the only struct which contains the same pointer.
3769 * Rust functions which take ownership of an object provided via an argument require
3770 * this to be true and invalidate the object pointed to by inner.
3773 } LDKInMemorySigner;
3776 * The contents of CResult_InMemorySignerDecodeErrorZ
3778 typedef union LDKCResult_InMemorySignerDecodeErrorZPtr {
3780 * A pointer to the contents in the success state.
3781 * Reading from this pointer when `result_ok` is not set is undefined.
3783 struct LDKInMemorySigner *result;
3785 * A pointer to the contents in the error state.
3786 * Reading from this pointer when `result_ok` is set is undefined.
3788 struct LDKDecodeError *err;
3789 } LDKCResult_InMemorySignerDecodeErrorZPtr;
3792 * A CResult_InMemorySignerDecodeErrorZ represents the result of a fallible operation,
3793 * containing a crate::lightning::chain::keysinterface::InMemorySigner on success and a crate::lightning::ln::msgs::DecodeError on failure.
3794 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3796 typedef struct LDKCResult_InMemorySignerDecodeErrorZ {
3798 * The contents of this CResult_InMemorySignerDecodeErrorZ, accessible via either
3799 * `err` or `result` depending on the state of `result_ok`.
3801 union LDKCResult_InMemorySignerDecodeErrorZPtr contents;
3803 * Whether this CResult_InMemorySignerDecodeErrorZ represents a success state.
3806 } LDKCResult_InMemorySignerDecodeErrorZ;
3809 * A dynamically-allocated array of crate::c_types::TxOuts of arbitrary size.
3810 * This corresponds to std::vector in C++
3812 typedef struct LDKCVec_TxOutZ {
3814 * The elements in the array.
3815 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
3817 struct LDKTxOut *data;
3819 * The number of elements pointed to by `data`.
3825 * The contents of CResult_TransactionNoneZ
3827 typedef union LDKCResult_TransactionNoneZPtr {
3829 * A pointer to the contents in the success state.
3830 * Reading from this pointer when `result_ok` is not set is undefined.
3832 struct LDKTransaction *result;
3834 * Note that this value is always NULL, as there are no contents in the Err variant
3837 } LDKCResult_TransactionNoneZPtr;
3840 * A CResult_TransactionNoneZ represents the result of a fallible operation,
3841 * containing a crate::c_types::Transaction on success and a () on failure.
3842 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3844 typedef struct LDKCResult_TransactionNoneZ {
3846 * The contents of this CResult_TransactionNoneZ, accessible via either
3847 * `err` or `result` depending on the state of `result_ok`.
3849 union LDKCResult_TransactionNoneZPtr contents;
3851 * Whether this CResult_TransactionNoneZ represents a success state.
3854 } LDKCResult_TransactionNoneZ;
3859 * A ChannelMonitor handles chain events (blocks connected and disconnected) and generates
3860 * on-chain transactions to ensure no loss of funds occurs.
3862 * You MUST ensure that no ChannelMonitors for a given channel anywhere contain out-of-date
3863 * information and are actively monitoring the chain.
3865 * Pending Events or updated HTLCs which have not yet been read out by
3866 * get_and_clear_pending_monitor_events or get_and_clear_pending_events are serialized to disk and
3867 * reloaded at deserialize-time. Thus, you must ensure that, when handling events, all events
3868 * gotten are fully handled before re-serializing the new state.
3870 * Note that the deserializer is only implemented for (BlockHash, ChannelMonitor), which
3871 * tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
3872 * the \"reorg path\" (ie disconnecting blocks until you find a common ancestor from both the
3873 * returned block hash and the the current chain and then reconnecting blocks to get to the
3874 * best chain) upon deserializing the object!
3876 typedef struct MUST_USE_STRUCT LDKChannelMonitor {
3878 * A pointer to the opaque Rust object.
3879 * Nearly everywhere, inner must be non-null, however in places where
3880 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3882 LDKnativeChannelMonitor *inner;
3884 * Indicates that this is the only struct which contains the same pointer.
3885 * Rust functions which take ownership of an object provided via an argument require
3886 * this to be true and invalidate the object pointed to by inner.
3889 } LDKChannelMonitor;
3892 * A tuple of 2 elements. See the individual fields for the types contained.
3894 typedef struct LDKC2Tuple_BlockHashChannelMonitorZ {
3896 * The element at position 0
3898 struct LDKThirtyTwoBytes a;
3900 * The element at position 1
3902 struct LDKChannelMonitor b;
3903 } LDKC2Tuple_BlockHashChannelMonitorZ;
3906 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_BlockHashChannelMonitorZs of arbitrary size.
3907 * This corresponds to std::vector in C++
3909 typedef struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ {
3911 * The elements in the array.
3912 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
3914 struct LDKC2Tuple_BlockHashChannelMonitorZ *data;
3916 * The number of elements pointed to by `data`.
3919 } LDKCVec_C2Tuple_BlockHashChannelMonitorZZ;
3922 * The contents of CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ
3924 typedef union LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZPtr {
3926 * A pointer to the contents in the success state.
3927 * Reading from this pointer when `result_ok` is not set is undefined.
3929 struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ *result;
3931 * A pointer to the contents in the error state.
3932 * Reading from this pointer when `result_ok` is set is undefined.
3934 enum LDKIOError *err;
3935 } LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZPtr;
3938 * A CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ represents the result of a fallible operation,
3939 * containing a crate::c_types::derived::CVec_C2Tuple_BlockHashChannelMonitorZZ on success and a crate::c_types::IOError on failure.
3940 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3942 typedef struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ {
3944 * The contents of this CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ, accessible via either
3945 * `err` or `result` depending on the state of `result_ok`.
3947 union LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZPtr contents;
3949 * Whether this CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ represents a success state.
3952 } LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ;
3955 * An enum which can either contain a u16 or not
3957 typedef enum LDKCOption_u16Z_Tag {
3959 * When we're in this state, this COption_u16Z contains a u16
3961 LDKCOption_u16Z_Some,
3963 * When we're in this state, this COption_u16Z contains nothing
3965 LDKCOption_u16Z_None,
3967 * Must be last for serialization purposes
3969 LDKCOption_u16Z_Sentinel,
3970 } LDKCOption_u16Z_Tag;
3972 typedef struct LDKCOption_u16Z {
3973 LDKCOption_u16Z_Tag tag;
3982 * Indicates an error on the client's part (usually some variant of attempting to use too-low or
3985 typedef enum LDKAPIError_Tag {
3987 * Indicates the API was wholly misused (see err for more). Cases where these can be returned
3988 * are documented, but generally indicates some precondition of a function was violated.
3990 LDKAPIError_APIMisuseError,
3992 * Due to a high feerate, we were unable to complete the request.
3993 * For example, this may be returned if the feerate implies we cannot open a channel at the
3994 * requested value, but opening a larger channel would succeed.
3996 LDKAPIError_FeeRateTooHigh,
3998 * A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
3999 * too-many-hops, etc).
4001 LDKAPIError_RouteError,
4003 * We were unable to complete the request as the Channel required to do so is unable to
4004 * complete the request (or was not found). This can take many forms, including disconnected
4005 * peer, channel at capacity, channel shutting down, etc.
4007 LDKAPIError_ChannelUnavailable,
4009 * An attempt to call watch/update_channel returned an Err (ie you did this!), causing the
4010 * attempted action to fail.
4012 LDKAPIError_MonitorUpdateFailed,
4014 * [`KeysInterface::get_shutdown_scriptpubkey`] returned a shutdown scriptpubkey incompatible
4015 * with the channel counterparty as negotiated in [`InitFeatures`].
4017 * Using a SegWit v0 script should resolve this issue. If you cannot, you won't be able to open
4018 * a channel or cooperatively close one with this peer (and will have to force-close instead).
4020 * [`KeysInterface::get_shutdown_scriptpubkey`]: crate::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey
4021 * [`InitFeatures`]: crate::ln::features::InitFeatures
4023 LDKAPIError_IncompatibleShutdownScript,
4025 * Must be last for serialization purposes
4027 LDKAPIError_Sentinel,
4030 typedef struct LDKAPIError_LDKAPIMisuseError_Body {
4032 * A human-readable error message
4035 } LDKAPIError_LDKAPIMisuseError_Body;
4037 typedef struct LDKAPIError_LDKFeeRateTooHigh_Body {
4039 * A human-readable error message
4043 * The feerate which was too high.
4046 } LDKAPIError_LDKFeeRateTooHigh_Body;
4048 typedef struct LDKAPIError_LDKRouteError_Body {
4050 * A human-readable error message
4053 } LDKAPIError_LDKRouteError_Body;
4055 typedef struct LDKAPIError_LDKChannelUnavailable_Body {
4057 * A human-readable error message
4060 } LDKAPIError_LDKChannelUnavailable_Body;
4062 typedef struct LDKAPIError_LDKIncompatibleShutdownScript_Body {
4064 * The incompatible shutdown script.
4066 struct LDKShutdownScript script;
4067 } LDKAPIError_LDKIncompatibleShutdownScript_Body;
4069 typedef struct MUST_USE_STRUCT LDKAPIError {
4070 LDKAPIError_Tag tag;
4072 LDKAPIError_LDKAPIMisuseError_Body api_misuse_error;
4073 LDKAPIError_LDKFeeRateTooHigh_Body fee_rate_too_high;
4074 LDKAPIError_LDKRouteError_Body route_error;
4075 LDKAPIError_LDKChannelUnavailable_Body channel_unavailable;
4076 LDKAPIError_LDKIncompatibleShutdownScript_Body incompatible_shutdown_script;
4081 * The contents of CResult_NoneAPIErrorZ
4083 typedef union LDKCResult_NoneAPIErrorZPtr {
4085 * Note that this value is always NULL, as there are no contents in the OK variant
4089 * A pointer to the contents in the error state.
4090 * Reading from this pointer when `result_ok` is set is undefined.
4092 struct LDKAPIError *err;
4093 } LDKCResult_NoneAPIErrorZPtr;
4096 * A CResult_NoneAPIErrorZ represents the result of a fallible operation,
4097 * containing a () on success and a crate::lightning::util::errors::APIError on failure.
4098 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4100 typedef struct LDKCResult_NoneAPIErrorZ {
4102 * The contents of this CResult_NoneAPIErrorZ, accessible via either
4103 * `err` or `result` depending on the state of `result_ok`.
4105 union LDKCResult_NoneAPIErrorZPtr contents;
4107 * Whether this CResult_NoneAPIErrorZ represents a success state.
4110 } LDKCResult_NoneAPIErrorZ;
4113 * A dynamically-allocated array of crate::c_types::derived::CResult_NoneAPIErrorZs of arbitrary size.
4114 * This corresponds to std::vector in C++
4116 typedef struct LDKCVec_CResult_NoneAPIErrorZZ {
4118 * The elements in the array.
4119 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4121 struct LDKCResult_NoneAPIErrorZ *data;
4123 * The number of elements pointed to by `data`.
4126 } LDKCVec_CResult_NoneAPIErrorZZ;
4129 * A dynamically-allocated array of crate::lightning::util::errors::APIErrors of arbitrary size.
4130 * This corresponds to std::vector in C++
4132 typedef struct LDKCVec_APIErrorZ {
4134 * The elements in the array.
4135 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4137 struct LDKAPIError *data;
4139 * The number of elements pointed to by `data`.
4142 } LDKCVec_APIErrorZ;
4145 * If a payment fails to send, it can be in one of several states. This enum is returned as the
4146 * Err() type describing which state the payment is in, see the description of individual enum
4149 typedef enum LDKPaymentSendFailure_Tag {
4151 * A parameter which was passed to send_payment was invalid, preventing us from attempting to
4152 * send the payment at all. No channel state has been changed or messages sent to peers, and
4153 * once you've changed the parameter at error, you can freely retry the payment in full.
4155 LDKPaymentSendFailure_ParameterError,
4157 * A parameter in a single path which was passed to send_payment was invalid, preventing us
4158 * from attempting to send the payment at all. No channel state has been changed or messages
4159 * sent to peers, and once you've changed the parameter at error, you can freely retry the
4162 * The results here are ordered the same as the paths in the route object which was passed to
4165 LDKPaymentSendFailure_PathParameterError,
4167 * All paths which were attempted failed to send, with no channel state change taking place.
4168 * You can freely retry the payment in full (though you probably want to do so over different
4169 * paths than the ones selected).
4171 LDKPaymentSendFailure_AllFailedRetrySafe,
4173 * Some paths which were attempted failed to send, though possibly not all. At least some
4174 * paths have irrevocably committed to the HTLC and retrying the payment in full would result
4175 * in over-/re-payment.
4177 * The results here are ordered the same as the paths in the route object which was passed to
4178 * send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
4179 * retried (though there is currently no API with which to do so).
4181 * Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
4182 * as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
4183 * case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
4184 * with the latest update_id.
4186 LDKPaymentSendFailure_PartialFailure,
4188 * Must be last for serialization purposes
4190 LDKPaymentSendFailure_Sentinel,
4191 } LDKPaymentSendFailure_Tag;
4193 typedef struct MUST_USE_STRUCT LDKPaymentSendFailure {
4194 LDKPaymentSendFailure_Tag tag;
4197 struct LDKAPIError parameter_error;
4200 struct LDKCVec_CResult_NoneAPIErrorZZ path_parameter_error;
4203 struct LDKCVec_APIErrorZ all_failed_retry_safe;
4206 struct LDKCVec_CResult_NoneAPIErrorZZ partial_failure;
4209 } LDKPaymentSendFailure;
4212 * The contents of CResult_NonePaymentSendFailureZ
4214 typedef union LDKCResult_NonePaymentSendFailureZPtr {
4216 * Note that this value is always NULL, as there are no contents in the OK variant
4220 * A pointer to the contents in the error state.
4221 * Reading from this pointer when `result_ok` is set is undefined.
4223 struct LDKPaymentSendFailure *err;
4224 } LDKCResult_NonePaymentSendFailureZPtr;
4227 * A CResult_NonePaymentSendFailureZ represents the result of a fallible operation,
4228 * containing a () on success and a crate::lightning::ln::channelmanager::PaymentSendFailure on failure.
4229 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4231 typedef struct LDKCResult_NonePaymentSendFailureZ {
4233 * The contents of this CResult_NonePaymentSendFailureZ, accessible via either
4234 * `err` or `result` depending on the state of `result_ok`.
4236 union LDKCResult_NonePaymentSendFailureZPtr contents;
4238 * Whether this CResult_NonePaymentSendFailureZ represents a success state.
4241 } LDKCResult_NonePaymentSendFailureZ;
4244 * The contents of CResult_PaymentHashPaymentSendFailureZ
4246 typedef union LDKCResult_PaymentHashPaymentSendFailureZPtr {
4248 * A pointer to the contents in the success state.
4249 * Reading from this pointer when `result_ok` is not set is undefined.
4251 struct LDKThirtyTwoBytes *result;
4253 * A pointer to the contents in the error state.
4254 * Reading from this pointer when `result_ok` is set is undefined.
4256 struct LDKPaymentSendFailure *err;
4257 } LDKCResult_PaymentHashPaymentSendFailureZPtr;
4260 * A CResult_PaymentHashPaymentSendFailureZ represents the result of a fallible operation,
4261 * containing a crate::c_types::ThirtyTwoBytes on success and a crate::lightning::ln::channelmanager::PaymentSendFailure on failure.
4262 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4264 typedef struct LDKCResult_PaymentHashPaymentSendFailureZ {
4266 * The contents of this CResult_PaymentHashPaymentSendFailureZ, accessible via either
4267 * `err` or `result` depending on the state of `result_ok`.
4269 union LDKCResult_PaymentHashPaymentSendFailureZPtr contents;
4271 * Whether this CResult_PaymentHashPaymentSendFailureZ represents a success state.
4274 } LDKCResult_PaymentHashPaymentSendFailureZ;
4277 * A 4-byte byte array.
4279 typedef struct LDKFourBytes {
4287 * A 16-byte byte array.
4289 typedef struct LDKSixteenBytes {
4297 * A 10-byte byte array.
4299 typedef struct LDKTenBytes {
4307 * An address which can be used to connect to a remote peer
4309 typedef enum LDKNetAddress_Tag {
4311 * An IPv4 address/port on which the peer is listening.
4315 * An IPv6 address/port on which the peer is listening.
4319 * An old-style Tor onion address/port on which the peer is listening.
4321 LDKNetAddress_OnionV2,
4323 * A new-style Tor onion address/port on which the peer is listening.
4324 * To create the human-readable \"hostname\", concatenate ed25519_pubkey, checksum, and version,
4325 * wrap as base32 and append \".onion\".
4327 LDKNetAddress_OnionV3,
4329 * Must be last for serialization purposes
4331 LDKNetAddress_Sentinel,
4332 } LDKNetAddress_Tag;
4334 typedef struct LDKNetAddress_LDKIPv4_Body {
4336 * The 4-byte IPv4 address
4338 struct LDKFourBytes addr;
4340 * The port on which the node is listening
4343 } LDKNetAddress_LDKIPv4_Body;
4345 typedef struct LDKNetAddress_LDKIPv6_Body {
4347 * The 16-byte IPv6 address
4349 struct LDKSixteenBytes addr;
4351 * The port on which the node is listening
4354 } LDKNetAddress_LDKIPv6_Body;
4356 typedef struct LDKNetAddress_LDKOnionV2_Body {
4358 * The bytes (usually encoded in base32 with \".onion\" appended)
4360 struct LDKTenBytes addr;
4362 * The port on which the node is listening
4365 } LDKNetAddress_LDKOnionV2_Body;
4367 typedef struct LDKNetAddress_LDKOnionV3_Body {
4369 * The ed25519 long-term public key of the peer
4371 struct LDKThirtyTwoBytes ed25519_pubkey;
4373 * The checksum of the pubkey and version, as included in the onion address
4377 * The version byte, as defined by the Tor Onion v3 spec.
4381 * The port on which the node is listening
4384 } LDKNetAddress_LDKOnionV3_Body;
4386 typedef struct MUST_USE_STRUCT LDKNetAddress {
4387 LDKNetAddress_Tag tag;
4389 LDKNetAddress_LDKIPv4_Body i_pv4;
4390 LDKNetAddress_LDKIPv6_Body i_pv6;
4391 LDKNetAddress_LDKOnionV2_Body onion_v2;
4392 LDKNetAddress_LDKOnionV3_Body onion_v3;
4397 * A dynamically-allocated array of crate::lightning::ln::msgs::NetAddresss of arbitrary size.
4398 * This corresponds to std::vector in C++
4400 typedef struct LDKCVec_NetAddressZ {
4402 * The elements in the array.
4403 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4405 struct LDKNetAddress *data;
4407 * The number of elements pointed to by `data`.
4410 } LDKCVec_NetAddressZ;
4413 * A tuple of 2 elements. See the individual fields for the types contained.
4415 typedef struct LDKC2Tuple_PaymentHashPaymentSecretZ {
4417 * The element at position 0
4419 struct LDKThirtyTwoBytes a;
4421 * The element at position 1
4423 struct LDKThirtyTwoBytes b;
4424 } LDKC2Tuple_PaymentHashPaymentSecretZ;
4427 * The contents of CResult_PaymentSecretAPIErrorZ
4429 typedef union LDKCResult_PaymentSecretAPIErrorZPtr {
4431 * A pointer to the contents in the success state.
4432 * Reading from this pointer when `result_ok` is not set is undefined.
4434 struct LDKThirtyTwoBytes *result;
4436 * A pointer to the contents in the error state.
4437 * Reading from this pointer when `result_ok` is set is undefined.
4439 struct LDKAPIError *err;
4440 } LDKCResult_PaymentSecretAPIErrorZPtr;
4443 * A CResult_PaymentSecretAPIErrorZ represents the result of a fallible operation,
4444 * containing a crate::c_types::ThirtyTwoBytes on success and a crate::lightning::util::errors::APIError on failure.
4445 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4447 typedef struct LDKCResult_PaymentSecretAPIErrorZ {
4449 * The contents of this CResult_PaymentSecretAPIErrorZ, accessible via either
4450 * `err` or `result` depending on the state of `result_ok`.
4452 union LDKCResult_PaymentSecretAPIErrorZPtr contents;
4454 * Whether this CResult_PaymentSecretAPIErrorZ represents a success state.
4457 } LDKCResult_PaymentSecretAPIErrorZ;
4460 * A dynamically-allocated array of crate::lightning::chain::channelmonitor::ChannelMonitors of arbitrary size.
4461 * This corresponds to std::vector in C++
4463 typedef struct LDKCVec_ChannelMonitorZ {
4465 * The elements in the array.
4466 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4468 struct LDKChannelMonitor *data;
4470 * The number of elements pointed to by `data`.
4473 } LDKCVec_ChannelMonitorZ;
4478 * An update generated by the underlying Channel itself which contains some new information the
4479 * ChannelMonitor should be made aware of.
4481 typedef struct MUST_USE_STRUCT LDKChannelMonitorUpdate {
4483 * A pointer to the opaque Rust object.
4484 * Nearly everywhere, inner must be non-null, however in places where
4485 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4487 LDKnativeChannelMonitorUpdate *inner;
4489 * Indicates that this is the only struct which contains the same pointer.
4490 * Rust functions which take ownership of an object provided via an argument require
4491 * this to be true and invalidate the object pointed to by inner.
4494 } LDKChannelMonitorUpdate;
4497 * The `Watch` trait defines behavior for watching on-chain activity pertaining to channels as
4498 * blocks are connected and disconnected.
4500 * Each channel is associated with a [`ChannelMonitor`]. Implementations of this trait are
4501 * responsible for maintaining a set of monitors such that they can be updated accordingly as
4502 * channel state changes and HTLCs are resolved. See method documentation for specific
4505 * Implementations **must** ensure that updates are successfully applied and persisted upon method
4506 * completion. If an update fails with a [`PermanentFailure`], then it must immediately shut down
4507 * without taking any further action such as persisting the current state.
4509 * If an implementation maintains multiple instances of a channel's monitor (e.g., by storing
4510 * backup copies), then it must ensure that updates are applied across all instances. Otherwise, it
4511 * could result in a revoked transaction being broadcast, allowing the counterparty to claim all
4512 * funds in the channel. See [`ChannelMonitorUpdateErr`] for more details about how to handle
4513 * multiple instances.
4515 * [`ChannelMonitor`]: channelmonitor::ChannelMonitor
4516 * [`ChannelMonitorUpdateErr`]: channelmonitor::ChannelMonitorUpdateErr
4517 * [`PermanentFailure`]: channelmonitor::ChannelMonitorUpdateErr::PermanentFailure
4519 typedef struct LDKWatch {
4521 * An opaque pointer which is passed to your function implementations as an argument.
4522 * This has no meaning in the LDK, and can be NULL or any other value.
4526 * Watches a channel identified by `funding_txo` using `monitor`.
4528 * Implementations are responsible for watching the chain for the funding transaction along
4529 * with any spends of outputs returned by [`get_outputs_to_watch`]. In practice, this means
4530 * calling [`block_connected`] and [`block_disconnected`] on the monitor.
4532 * [`get_outputs_to_watch`]: channelmonitor::ChannelMonitor::get_outputs_to_watch
4533 * [`block_connected`]: channelmonitor::ChannelMonitor::block_connected
4534 * [`block_disconnected`]: channelmonitor::ChannelMonitor::block_disconnected
4536 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*watch_channel)(const void *this_arg, struct LDKOutPoint funding_txo, struct LDKChannelMonitor monitor);
4538 * Updates a channel identified by `funding_txo` by applying `update` to its monitor.
4540 * Implementations must call [`update_monitor`] with the given update. See
4541 * [`ChannelMonitorUpdateErr`] for invariants around returning an error.
4543 * [`update_monitor`]: channelmonitor::ChannelMonitor::update_monitor
4544 * [`ChannelMonitorUpdateErr`]: channelmonitor::ChannelMonitorUpdateErr
4546 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*update_channel)(const void *this_arg, struct LDKOutPoint funding_txo, struct LDKChannelMonitorUpdate update);
4548 * Returns any monitor events since the last call. Subsequent calls must only return new
4551 struct LDKCVec_MonitorEventZ (*release_pending_monitor_events)(const void *this_arg);
4553 * Frees any resources associated with this object given its this_arg pointer.
4554 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4556 void (*free)(void *this_arg);
4560 * An interface to send a transaction to the Bitcoin network.
4562 typedef struct LDKBroadcasterInterface {
4564 * An opaque pointer which is passed to your function implementations as an argument.
4565 * This has no meaning in the LDK, and can be NULL or any other value.
4569 * Sends a transaction out to (hopefully) be mined.
4571 void (*broadcast_transaction)(const void *this_arg, struct LDKTransaction tx);
4573 * Frees any resources associated with this object given its this_arg pointer.
4574 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4576 void (*free)(void *this_arg);
4577 } LDKBroadcasterInterface;
4580 * A "slice" referencing some byte array. This is simply a length-tagged pointer which does not
4581 * own the memory pointed to by data.
4583 typedef struct LDKu8slice {
4585 * A pointer to the byte buffer
4587 const uint8_t *data;
4589 * The number of bytes pointed to by `data`.
4595 * A trait to describe an object which can get user secrets and key material.
4597 typedef struct LDKKeysInterface {
4599 * An opaque pointer which is passed to your function implementations as an argument.
4600 * This has no meaning in the LDK, and can be NULL or any other value.
4604 * Get node secret key (aka node_id or network_key).
4606 * This method must return the same value each time it is called.
4608 struct LDKSecretKey (*get_node_secret)(const void *this_arg);
4610 * Get a script pubkey which we send funds to when claiming on-chain contestable outputs.
4612 * This method should return a different value each time it is called, to avoid linking
4613 * on-chain funds across channels as controlled to the same user.
4615 struct LDKCVec_u8Z (*get_destination_script)(const void *this_arg);
4617 * Get a script pubkey which we will send funds to when closing a channel.
4619 * This method should return a different value each time it is called, to avoid linking
4620 * on-chain funds across channels as controlled to the same user.
4622 struct LDKShutdownScript (*get_shutdown_scriptpubkey)(const void *this_arg);
4624 * Get a new set of Sign for per-channel secrets. These MUST be unique even if you
4625 * restarted with some stale data!
4627 * This method must return a different value each time it is called.
4629 struct LDKSign (*get_channel_signer)(const void *this_arg, bool inbound, uint64_t channel_value_satoshis);
4631 * Gets a unique, cryptographically-secure, random 32 byte value. This is used for encrypting
4632 * onion packets and for temporary channel IDs. There is no requirement that these be
4633 * persisted anywhere, though they must be unique across restarts.
4635 * This method must return a different value each time it is called.
4637 struct LDKThirtyTwoBytes (*get_secure_random_bytes)(const void *this_arg);
4639 * Reads a `Signer` for this `KeysInterface` from the given input stream.
4640 * This is only called during deserialization of other objects which contain
4641 * `Sign`-implementing objects (ie `ChannelMonitor`s and `ChannelManager`s).
4642 * The bytes are exactly those which `<Self::Signer as Writeable>::write()` writes, and
4643 * contain no versioning scheme. You may wish to include your own version prefix and ensure
4644 * you've read all of the provided bytes to ensure no corruption occurred.
4646 struct LDKCResult_SignDecodeErrorZ (*read_chan_signer)(const void *this_arg, struct LDKu8slice reader);
4648 * Sign an invoice's preimage (note that this is the preimage of the invoice, not the HTLC's
4649 * preimage). By parameterizing by the preimage instead of the hash, we allow implementors of
4650 * this trait to parse the invoice and make sure they're signing what they expect, rather than
4651 * blindly signing the hash.
4653 struct LDKCResult_RecoverableSignatureNoneZ (*sign_invoice)(const void *this_arg, struct LDKCVec_u8Z invoice_preimage);
4655 * Frees any resources associated with this object given its this_arg pointer.
4656 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4658 void (*free)(void *this_arg);
4662 * A trait which should be implemented to provide feerate information on a number of time
4665 * Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
4666 * called from inside the library in response to chain events, P2P events, or timer events).
4668 typedef struct LDKFeeEstimator {
4670 * An opaque pointer which is passed to your function implementations as an argument.
4671 * This has no meaning in the LDK, and can be NULL or any other value.
4675 * Gets estimated satoshis of fee required per 1000 Weight-Units.
4677 * Must be no smaller than 253 (ie 1 satoshi-per-byte rounded up to ensure later round-downs
4678 * don't put us below 1 satoshi-per-byte).
4680 * This translates to:
4681 * * satoshis-per-byte * 250
4682 * * ceil(satoshis-per-kbyte / 4)
4684 uint32_t (*get_est_sat_per_1000_weight)(const void *this_arg, enum LDKConfirmationTarget confirmation_target);
4686 * Frees any resources associated with this object given its this_arg pointer.
4687 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4689 void (*free)(void *this_arg);
4693 * A trait encapsulating the operations required of a logger
4695 typedef struct LDKLogger {
4697 * An opaque pointer which is passed to your function implementations as an argument.
4698 * This has no meaning in the LDK, and can be NULL or any other value.
4704 void (*log)(const void *this_arg, const char *record);
4706 * Frees any resources associated with this object given its this_arg pointer.
4707 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4709 void (*free)(void *this_arg);
4715 * Manager which keeps track of a number of channels and sends messages to the appropriate
4716 * channel, also tracking HTLC preimages and forwarding onion packets appropriately.
4718 * Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
4719 * to individual Channels.
4721 * Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
4722 * all peers during write/read (though does not modify this instance, only the instance being
4723 * serialized). This will result in any channels which have not yet exchanged funding_created (ie
4724 * called funding_transaction_generated for outbound channels).
4726 * Note that you can be a bit lazier about writing out ChannelManager than you can be with
4727 * ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
4728 * returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
4729 * happens out-of-band (and will prevent any other ChannelManager operations from occurring during
4730 * the serialization process). If the deserialized version is out-of-date compared to the
4731 * ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
4732 * ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
4734 * Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
4735 * tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
4736 * the \"reorg path\" (ie call block_disconnected() until you get to a common block and then call
4737 * block_connected() to step towards your best block) upon deserialization before using the
4740 * Note that ChannelManager is responsible for tracking liveness of its channels and generating
4741 * ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
4742 * spam due to quick disconnection/reconnection, updates are not sent until the channel has been
4743 * offline for a full minute. In order to track this, you must call
4744 * timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
4746 * Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
4747 * a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
4748 * essentially you should default to using a SimpleRefChannelManager, and use a
4749 * SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
4750 * you're using lightning-net-tokio.
4752 typedef struct MUST_USE_STRUCT LDKChannelManager {
4754 * A pointer to the opaque Rust object.
4755 * Nearly everywhere, inner must be non-null, however in places where
4756 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4758 LDKnativeChannelManager *inner;
4760 * Indicates that this is the only struct which contains the same pointer.
4761 * Rust functions which take ownership of an object provided via an argument require
4762 * this to be true and invalidate the object pointed to by inner.
4765 } LDKChannelManager;
4768 * A tuple of 2 elements. See the individual fields for the types contained.
4770 typedef struct LDKC2Tuple_BlockHashChannelManagerZ {
4772 * The element at position 0
4774 struct LDKThirtyTwoBytes a;
4776 * The element at position 1
4778 struct LDKChannelManager b;
4779 } LDKC2Tuple_BlockHashChannelManagerZ;
4782 * The contents of CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ
4784 typedef union LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr {
4786 * A pointer to the contents in the success state.
4787 * Reading from this pointer when `result_ok` is not set is undefined.
4789 struct LDKC2Tuple_BlockHashChannelManagerZ *result;
4791 * A pointer to the contents in the error state.
4792 * Reading from this pointer when `result_ok` is set is undefined.
4794 struct LDKDecodeError *err;
4795 } LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr;
4798 * A CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ represents the result of a fallible operation,
4799 * containing a crate::c_types::derived::C2Tuple_BlockHashChannelManagerZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
4800 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4802 typedef struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ {
4804 * The contents of this CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ, accessible via either
4805 * `err` or `result` depending on the state of `result_ok`.
4807 union LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr contents;
4809 * Whether this CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ represents a success state.
4812 } LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ;
4817 * Options which apply on a per-channel basis and may change at runtime or based on negotiation
4818 * with our counterparty.
4820 typedef struct MUST_USE_STRUCT LDKChannelConfig {
4822 * A pointer to the opaque Rust object.
4823 * Nearly everywhere, inner must be non-null, however in places where
4824 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4826 LDKnativeChannelConfig *inner;
4828 * Indicates that this is the only struct which contains the same pointer.
4829 * Rust functions which take ownership of an object provided via an argument require
4830 * this to be true and invalidate the object pointed to by inner.
4836 * The contents of CResult_ChannelConfigDecodeErrorZ
4838 typedef union LDKCResult_ChannelConfigDecodeErrorZPtr {
4840 * A pointer to the contents in the success state.
4841 * Reading from this pointer when `result_ok` is not set is undefined.
4843 struct LDKChannelConfig *result;
4845 * A pointer to the contents in the error state.
4846 * Reading from this pointer when `result_ok` is set is undefined.
4848 struct LDKDecodeError *err;
4849 } LDKCResult_ChannelConfigDecodeErrorZPtr;
4852 * A CResult_ChannelConfigDecodeErrorZ represents the result of a fallible operation,
4853 * containing a crate::lightning::util::config::ChannelConfig on success and a crate::lightning::ln::msgs::DecodeError on failure.
4854 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4856 typedef struct LDKCResult_ChannelConfigDecodeErrorZ {
4858 * The contents of this CResult_ChannelConfigDecodeErrorZ, accessible via either
4859 * `err` or `result` depending on the state of `result_ok`.
4861 union LDKCResult_ChannelConfigDecodeErrorZPtr contents;
4863 * Whether this CResult_ChannelConfigDecodeErrorZ represents a success state.
4866 } LDKCResult_ChannelConfigDecodeErrorZ;
4869 * The contents of CResult_OutPointDecodeErrorZ
4871 typedef union LDKCResult_OutPointDecodeErrorZPtr {
4873 * A pointer to the contents in the success state.
4874 * Reading from this pointer when `result_ok` is not set is undefined.
4876 struct LDKOutPoint *result;
4878 * A pointer to the contents in the error state.
4879 * Reading from this pointer when `result_ok` is set is undefined.
4881 struct LDKDecodeError *err;
4882 } LDKCResult_OutPointDecodeErrorZPtr;
4885 * A CResult_OutPointDecodeErrorZ represents the result of a fallible operation,
4886 * containing a crate::lightning::chain::transaction::OutPoint on success and a crate::lightning::ln::msgs::DecodeError on failure.
4887 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4889 typedef struct LDKCResult_OutPointDecodeErrorZ {
4891 * The contents of this CResult_OutPointDecodeErrorZ, accessible via either
4892 * `err` or `result` depending on the state of `result_ok`.
4894 union LDKCResult_OutPointDecodeErrorZPtr contents;
4896 * Whether this CResult_OutPointDecodeErrorZ represents a success state.
4899 } LDKCResult_OutPointDecodeErrorZ;
4902 * Defines a type identifier for sending messages over the wire.
4904 * Messages implementing this trait specify a type and must be [`Writeable`].
4906 typedef struct LDKType {
4908 * An opaque pointer which is passed to your function implementations as an argument.
4909 * This has no meaning in the LDK, and can be NULL or any other value.
4913 * Returns the type identifying the message payload.
4915 uint16_t (*type_id)(const void *this_arg);
4917 * Return a human-readable "debug" string describing this object
4919 struct LDKStr (*debug_str)(const void *this_arg);
4921 * Serialize the object into a byte array
4923 struct LDKCVec_u8Z (*write)(const void *this_arg);
4925 * Frees any resources associated with this object given its this_arg pointer.
4926 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4928 void (*free)(void *this_arg);
4932 * An enum which can either contain a crate::lightning::ln::wire::Type or not
4934 typedef enum LDKCOption_TypeZ_Tag {
4936 * When we're in this state, this COption_TypeZ contains a crate::lightning::ln::wire::Type
4938 LDKCOption_TypeZ_Some,
4940 * When we're in this state, this COption_TypeZ contains nothing
4942 LDKCOption_TypeZ_None,
4944 * Must be last for serialization purposes
4946 LDKCOption_TypeZ_Sentinel,
4947 } LDKCOption_TypeZ_Tag;
4949 typedef struct LDKCOption_TypeZ {
4950 LDKCOption_TypeZ_Tag tag;
4953 struct LDKType some;
4959 * The contents of CResult_COption_TypeZDecodeErrorZ
4961 typedef union LDKCResult_COption_TypeZDecodeErrorZPtr {
4963 * A pointer to the contents in the success state.
4964 * Reading from this pointer when `result_ok` is not set is undefined.
4966 struct LDKCOption_TypeZ *result;
4968 * A pointer to the contents in the error state.
4969 * Reading from this pointer when `result_ok` is set is undefined.
4971 struct LDKDecodeError *err;
4972 } LDKCResult_COption_TypeZDecodeErrorZPtr;
4975 * A CResult_COption_TypeZDecodeErrorZ represents the result of a fallible operation,
4976 * containing a crate::c_types::derived::COption_TypeZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
4977 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4979 typedef struct LDKCResult_COption_TypeZDecodeErrorZ {
4981 * The contents of this CResult_COption_TypeZDecodeErrorZ, accessible via either
4982 * `err` or `result` depending on the state of `result_ok`.
4984 union LDKCResult_COption_TypeZDecodeErrorZPtr contents;
4986 * Whether this CResult_COption_TypeZDecodeErrorZ represents a success state.
4989 } LDKCResult_COption_TypeZDecodeErrorZ;
4992 * The contents of CResult_SiPrefixNoneZ
4994 typedef union LDKCResult_SiPrefixNoneZPtr {
4996 * A pointer to the contents in the success state.
4997 * Reading from this pointer when `result_ok` is not set is undefined.
4999 enum LDKSiPrefix *result;
5001 * Note that this value is always NULL, as there are no contents in the Err variant
5004 } LDKCResult_SiPrefixNoneZPtr;
5007 * A CResult_SiPrefixNoneZ represents the result of a fallible operation,
5008 * containing a crate::lightning_invoice::SiPrefix on success and a () on failure.
5009 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5011 typedef struct LDKCResult_SiPrefixNoneZ {
5013 * The contents of this CResult_SiPrefixNoneZ, accessible via either
5014 * `err` or `result` depending on the state of `result_ok`.
5016 union LDKCResult_SiPrefixNoneZPtr contents;
5018 * Whether this CResult_SiPrefixNoneZ represents a success state.
5021 } LDKCResult_SiPrefixNoneZ;
5026 * Represents a syntactically and semantically correct lightning BOLT11 invoice.
5028 * There are three ways to construct an `Invoice`:
5029 * 1. using `InvoiceBuilder`
5030 * 2. using `Invoice::from_signed(SignedRawInvoice)`
5031 * 3. using `str::parse::<Invoice>(&str)`
5033 typedef struct MUST_USE_STRUCT LDKInvoice {
5035 * A pointer to the opaque Rust object.
5036 * Nearly everywhere, inner must be non-null, however in places where
5037 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5039 LDKnativeInvoice *inner;
5041 * Indicates that this is the only struct which contains the same pointer.
5042 * Rust functions which take ownership of an object provided via an argument require
5043 * this to be true and invalidate the object pointed to by inner.
5049 * The contents of CResult_InvoiceNoneZ
5051 typedef union LDKCResult_InvoiceNoneZPtr {
5053 * A pointer to the contents in the success state.
5054 * Reading from this pointer when `result_ok` is not set is undefined.
5056 struct LDKInvoice *result;
5058 * Note that this value is always NULL, as there are no contents in the Err variant
5061 } LDKCResult_InvoiceNoneZPtr;
5064 * A CResult_InvoiceNoneZ represents the result of a fallible operation,
5065 * containing a crate::lightning_invoice::Invoice on success and a () on failure.
5066 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5068 typedef struct LDKCResult_InvoiceNoneZ {
5070 * The contents of this CResult_InvoiceNoneZ, accessible via either
5071 * `err` or `result` depending on the state of `result_ok`.
5073 union LDKCResult_InvoiceNoneZPtr contents;
5075 * Whether this CResult_InvoiceNoneZ represents a success state.
5078 } LDKCResult_InvoiceNoneZ;
5083 * Represents a signed `RawInvoice` with cached hash. The signature is not checked and may be
5087 * The hash has to be either from the deserialized invoice or from the serialized `raw_invoice`.
5089 typedef struct MUST_USE_STRUCT LDKSignedRawInvoice {
5091 * A pointer to the opaque Rust object.
5092 * Nearly everywhere, inner must be non-null, however in places where
5093 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5095 LDKnativeSignedRawInvoice *inner;
5097 * Indicates that this is the only struct which contains the same pointer.
5098 * Rust functions which take ownership of an object provided via an argument require
5099 * this to be true and invalidate the object pointed to by inner.
5102 } LDKSignedRawInvoice;
5105 * The contents of CResult_SignedRawInvoiceNoneZ
5107 typedef union LDKCResult_SignedRawInvoiceNoneZPtr {
5109 * A pointer to the contents in the success state.
5110 * Reading from this pointer when `result_ok` is not set is undefined.
5112 struct LDKSignedRawInvoice *result;
5114 * Note that this value is always NULL, as there are no contents in the Err variant
5117 } LDKCResult_SignedRawInvoiceNoneZPtr;
5120 * A CResult_SignedRawInvoiceNoneZ represents the result of a fallible operation,
5121 * containing a crate::lightning_invoice::SignedRawInvoice on success and a () on failure.
5122 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5124 typedef struct LDKCResult_SignedRawInvoiceNoneZ {
5126 * The contents of this CResult_SignedRawInvoiceNoneZ, accessible via either
5127 * `err` or `result` depending on the state of `result_ok`.
5129 union LDKCResult_SignedRawInvoiceNoneZPtr contents;
5131 * Whether this CResult_SignedRawInvoiceNoneZ represents a success state.
5134 } LDKCResult_SignedRawInvoiceNoneZ;
5139 * Represents an syntactically correct Invoice for a payment on the lightning network,
5140 * but without the signature information.
5141 * De- and encoding should not lead to information loss but may lead to different hashes.
5143 * For methods without docs see the corresponding methods in `Invoice`.
5145 typedef struct MUST_USE_STRUCT LDKRawInvoice {
5147 * A pointer to the opaque Rust object.
5148 * Nearly everywhere, inner must be non-null, however in places where
5149 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5151 LDKnativeRawInvoice *inner;
5153 * Indicates that this is the only struct which contains the same pointer.
5154 * Rust functions which take ownership of an object provided via an argument require
5155 * this to be true and invalidate the object pointed to by inner.
5163 * Recoverable signature
5165 typedef struct MUST_USE_STRUCT LDKInvoiceSignature {
5167 * A pointer to the opaque Rust object.
5168 * Nearly everywhere, inner must be non-null, however in places where
5169 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5171 LDKnativeInvoiceSignature *inner;
5173 * Indicates that this is the only struct which contains the same pointer.
5174 * Rust functions which take ownership of an object provided via an argument require
5175 * this to be true and invalidate the object pointed to by inner.
5178 } LDKInvoiceSignature;
5181 * A tuple of 3 elements. See the individual fields for the types contained.
5183 typedef struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ {
5185 * The element at position 0
5187 struct LDKRawInvoice a;
5189 * The element at position 1
5191 struct LDKThirtyTwoBytes b;
5193 * The element at position 2
5195 struct LDKInvoiceSignature c;
5196 } LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ;
5203 typedef struct MUST_USE_STRUCT LDKPayeePubKey {
5205 * A pointer to the opaque Rust object.
5206 * Nearly everywhere, inner must be non-null, however in places where
5207 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5209 LDKnativePayeePubKey *inner;
5211 * Indicates that this is the only struct which contains the same pointer.
5212 * Rust functions which take ownership of an object provided via an argument require
5213 * this to be true and invalidate the object pointed to by inner.
5219 * The contents of CResult_PayeePubKeyErrorZ
5221 typedef union LDKCResult_PayeePubKeyErrorZPtr {
5223 * A pointer to the contents in the success state.
5224 * Reading from this pointer when `result_ok` is not set is undefined.
5226 struct LDKPayeePubKey *result;
5228 * A pointer to the contents in the error state.
5229 * Reading from this pointer when `result_ok` is set is undefined.
5231 enum LDKSecp256k1Error *err;
5232 } LDKCResult_PayeePubKeyErrorZPtr;
5235 * A CResult_PayeePubKeyErrorZ represents the result of a fallible operation,
5236 * containing a crate::lightning_invoice::PayeePubKey on success and a crate::c_types::Secp256k1Error on failure.
5237 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5239 typedef struct LDKCResult_PayeePubKeyErrorZ {
5241 * The contents of this CResult_PayeePubKeyErrorZ, accessible via either
5242 * `err` or `result` depending on the state of `result_ok`.
5244 union LDKCResult_PayeePubKeyErrorZPtr contents;
5246 * Whether this CResult_PayeePubKeyErrorZ represents a success state.
5249 } LDKCResult_PayeePubKeyErrorZ;
5254 * Private routing information
5257 * The encoded route has to be <1024 5bit characters long (<=639 bytes or <=12 hops)
5260 typedef struct MUST_USE_STRUCT LDKPrivateRoute {
5262 * A pointer to the opaque Rust object.
5263 * Nearly everywhere, inner must be non-null, however in places where
5264 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5266 LDKnativePrivateRoute *inner;
5268 * Indicates that this is the only struct which contains the same pointer.
5269 * Rust functions which take ownership of an object provided via an argument require
5270 * this to be true and invalidate the object pointed to by inner.
5276 * A dynamically-allocated array of crate::lightning_invoice::PrivateRoutes of arbitrary size.
5277 * This corresponds to std::vector in C++
5279 typedef struct LDKCVec_PrivateRouteZ {
5281 * The elements in the array.
5282 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5284 struct LDKPrivateRoute *data;
5286 * The number of elements pointed to by `data`.
5289 } LDKCVec_PrivateRouteZ;
5294 * A timestamp that refers to a date after 1 January 1970 which means its representation as UNIX
5295 * timestamp is positive.
5298 * The UNIX timestamp representing the stored time has to be positive and small enough so that
5299 * a `EpiryTime` can be added to it without an overflow.
5301 typedef struct MUST_USE_STRUCT LDKPositiveTimestamp {
5303 * A pointer to the opaque Rust object.
5304 * Nearly everywhere, inner must be non-null, however in places where
5305 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5307 LDKnativePositiveTimestamp *inner;
5309 * Indicates that this is the only struct which contains the same pointer.
5310 * Rust functions which take ownership of an object provided via an argument require
5311 * this to be true and invalidate the object pointed to by inner.
5314 } LDKPositiveTimestamp;
5317 * The contents of CResult_PositiveTimestampCreationErrorZ
5319 typedef union LDKCResult_PositiveTimestampCreationErrorZPtr {
5321 * A pointer to the contents in the success state.
5322 * Reading from this pointer when `result_ok` is not set is undefined.
5324 struct LDKPositiveTimestamp *result;
5326 * A pointer to the contents in the error state.
5327 * Reading from this pointer when `result_ok` is set is undefined.
5329 enum LDKCreationError *err;
5330 } LDKCResult_PositiveTimestampCreationErrorZPtr;
5333 * A CResult_PositiveTimestampCreationErrorZ represents the result of a fallible operation,
5334 * containing a crate::lightning_invoice::PositiveTimestamp on success and a crate::lightning_invoice::CreationError on failure.
5335 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5337 typedef struct LDKCResult_PositiveTimestampCreationErrorZ {
5339 * The contents of this CResult_PositiveTimestampCreationErrorZ, accessible via either
5340 * `err` or `result` depending on the state of `result_ok`.
5342 union LDKCResult_PositiveTimestampCreationErrorZPtr contents;
5344 * Whether this CResult_PositiveTimestampCreationErrorZ represents a success state.
5347 } LDKCResult_PositiveTimestampCreationErrorZ;
5350 * The contents of CResult_NoneSemanticErrorZ
5352 typedef union LDKCResult_NoneSemanticErrorZPtr {
5354 * Note that this value is always NULL, as there are no contents in the OK variant
5358 * A pointer to the contents in the error state.
5359 * Reading from this pointer when `result_ok` is set is undefined.
5361 enum LDKSemanticError *err;
5362 } LDKCResult_NoneSemanticErrorZPtr;
5365 * A CResult_NoneSemanticErrorZ represents the result of a fallible operation,
5366 * containing a () on success and a crate::lightning_invoice::SemanticError on failure.
5367 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5369 typedef struct LDKCResult_NoneSemanticErrorZ {
5371 * The contents of this CResult_NoneSemanticErrorZ, accessible via either
5372 * `err` or `result` depending on the state of `result_ok`.
5374 union LDKCResult_NoneSemanticErrorZPtr contents;
5376 * Whether this CResult_NoneSemanticErrorZ represents a success state.
5379 } LDKCResult_NoneSemanticErrorZ;
5382 * The contents of CResult_InvoiceSemanticErrorZ
5384 typedef union LDKCResult_InvoiceSemanticErrorZPtr {
5386 * A pointer to the contents in the success state.
5387 * Reading from this pointer when `result_ok` is not set is undefined.
5389 struct LDKInvoice *result;
5391 * A pointer to the contents in the error state.
5392 * Reading from this pointer when `result_ok` is set is undefined.
5394 enum LDKSemanticError *err;
5395 } LDKCResult_InvoiceSemanticErrorZPtr;
5398 * A CResult_InvoiceSemanticErrorZ represents the result of a fallible operation,
5399 * containing a crate::lightning_invoice::Invoice on success and a crate::lightning_invoice::SemanticError on failure.
5400 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5402 typedef struct LDKCResult_InvoiceSemanticErrorZ {
5404 * The contents of this CResult_InvoiceSemanticErrorZ, accessible via either
5405 * `err` or `result` depending on the state of `result_ok`.
5407 union LDKCResult_InvoiceSemanticErrorZPtr contents;
5409 * Whether this CResult_InvoiceSemanticErrorZ represents a success state.
5412 } LDKCResult_InvoiceSemanticErrorZ;
5417 * Description string
5420 * The description can be at most 639 __bytes__ long
5422 typedef struct MUST_USE_STRUCT LDKDescription {
5424 * A pointer to the opaque Rust object.
5425 * Nearly everywhere, inner must be non-null, however in places where
5426 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5428 LDKnativeDescription *inner;
5430 * Indicates that this is the only struct which contains the same pointer.
5431 * Rust functions which take ownership of an object provided via an argument require
5432 * this to be true and invalidate the object pointed to by inner.
5438 * The contents of CResult_DescriptionCreationErrorZ
5440 typedef union LDKCResult_DescriptionCreationErrorZPtr {
5442 * A pointer to the contents in the success state.
5443 * Reading from this pointer when `result_ok` is not set is undefined.
5445 struct LDKDescription *result;
5447 * A pointer to the contents in the error state.
5448 * Reading from this pointer when `result_ok` is set is undefined.
5450 enum LDKCreationError *err;
5451 } LDKCResult_DescriptionCreationErrorZPtr;
5454 * A CResult_DescriptionCreationErrorZ represents the result of a fallible operation,
5455 * containing a crate::lightning_invoice::Description on success and a crate::lightning_invoice::CreationError on failure.
5456 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5458 typedef struct LDKCResult_DescriptionCreationErrorZ {
5460 * The contents of this CResult_DescriptionCreationErrorZ, accessible via either
5461 * `err` or `result` depending on the state of `result_ok`.
5463 union LDKCResult_DescriptionCreationErrorZPtr contents;
5465 * Whether this CResult_DescriptionCreationErrorZ represents a success state.
5468 } LDKCResult_DescriptionCreationErrorZ;
5473 * Positive duration that defines when (relatively to the timestamp) in the future the invoice
5477 * The number of seconds this expiry time represents has to be in the range
5478 * `0...(SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME)` to avoid overflows when adding it to a
5481 typedef struct MUST_USE_STRUCT LDKExpiryTime {
5483 * A pointer to the opaque Rust object.
5484 * Nearly everywhere, inner must be non-null, however in places where
5485 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5487 LDKnativeExpiryTime *inner;
5489 * Indicates that this is the only struct which contains the same pointer.
5490 * Rust functions which take ownership of an object provided via an argument require
5491 * this to be true and invalidate the object pointed to by inner.
5497 * The contents of CResult_ExpiryTimeCreationErrorZ
5499 typedef union LDKCResult_ExpiryTimeCreationErrorZPtr {
5501 * A pointer to the contents in the success state.
5502 * Reading from this pointer when `result_ok` is not set is undefined.
5504 struct LDKExpiryTime *result;
5506 * A pointer to the contents in the error state.
5507 * Reading from this pointer when `result_ok` is set is undefined.
5509 enum LDKCreationError *err;
5510 } LDKCResult_ExpiryTimeCreationErrorZPtr;
5513 * A CResult_ExpiryTimeCreationErrorZ represents the result of a fallible operation,
5514 * containing a crate::lightning_invoice::ExpiryTime on success and a crate::lightning_invoice::CreationError on failure.
5515 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5517 typedef struct LDKCResult_ExpiryTimeCreationErrorZ {
5519 * The contents of this CResult_ExpiryTimeCreationErrorZ, accessible via either
5520 * `err` or `result` depending on the state of `result_ok`.
5522 union LDKCResult_ExpiryTimeCreationErrorZPtr contents;
5524 * Whether this CResult_ExpiryTimeCreationErrorZ represents a success state.
5527 } LDKCResult_ExpiryTimeCreationErrorZ;
5530 * The contents of CResult_PrivateRouteCreationErrorZ
5532 typedef union LDKCResult_PrivateRouteCreationErrorZPtr {
5534 * A pointer to the contents in the success state.
5535 * Reading from this pointer when `result_ok` is not set is undefined.
5537 struct LDKPrivateRoute *result;
5539 * A pointer to the contents in the error state.
5540 * Reading from this pointer when `result_ok` is set is undefined.
5542 enum LDKCreationError *err;
5543 } LDKCResult_PrivateRouteCreationErrorZPtr;
5546 * A CResult_PrivateRouteCreationErrorZ represents the result of a fallible operation,
5547 * containing a crate::lightning_invoice::PrivateRoute on success and a crate::lightning_invoice::CreationError on failure.
5548 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5550 typedef struct LDKCResult_PrivateRouteCreationErrorZ {
5552 * The contents of this CResult_PrivateRouteCreationErrorZ, accessible via either
5553 * `err` or `result` depending on the state of `result_ok`.
5555 union LDKCResult_PrivateRouteCreationErrorZPtr contents;
5557 * Whether this CResult_PrivateRouteCreationErrorZ represents a success state.
5560 } LDKCResult_PrivateRouteCreationErrorZ;
5563 * The contents of CResult_StringErrorZ
5565 typedef union LDKCResult_StringErrorZPtr {
5567 * A pointer to the contents in the success state.
5568 * Reading from this pointer when `result_ok` is not set is undefined.
5570 struct LDKStr *result;
5572 * A pointer to the contents in the error state.
5573 * Reading from this pointer when `result_ok` is set is undefined.
5575 enum LDKSecp256k1Error *err;
5576 } LDKCResult_StringErrorZPtr;
5579 * A CResult_StringErrorZ represents the result of a fallible operation,
5580 * containing a crate::c_types::Str on success and a crate::c_types::Secp256k1Error on failure.
5581 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5583 typedef struct LDKCResult_StringErrorZ {
5585 * The contents of this CResult_StringErrorZ, accessible via either
5586 * `err` or `result` depending on the state of `result_ok`.
5588 union LDKCResult_StringErrorZPtr contents;
5590 * Whether this CResult_StringErrorZ represents a success state.
5593 } LDKCResult_StringErrorZ;
5596 * The contents of CResult_ChannelMonitorUpdateDecodeErrorZ
5598 typedef union LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr {
5600 * A pointer to the contents in the success state.
5601 * Reading from this pointer when `result_ok` is not set is undefined.
5603 struct LDKChannelMonitorUpdate *result;
5605 * A pointer to the contents in the error state.
5606 * Reading from this pointer when `result_ok` is set is undefined.
5608 struct LDKDecodeError *err;
5609 } LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr;
5612 * A CResult_ChannelMonitorUpdateDecodeErrorZ represents the result of a fallible operation,
5613 * containing a crate::lightning::chain::channelmonitor::ChannelMonitorUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
5614 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5616 typedef struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ {
5618 * The contents of this CResult_ChannelMonitorUpdateDecodeErrorZ, accessible via either
5619 * `err` or `result` depending on the state of `result_ok`.
5621 union LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr contents;
5623 * Whether this CResult_ChannelMonitorUpdateDecodeErrorZ represents a success state.
5626 } LDKCResult_ChannelMonitorUpdateDecodeErrorZ;
5629 * The contents of CResult_HTLCUpdateDecodeErrorZ
5631 typedef union LDKCResult_HTLCUpdateDecodeErrorZPtr {
5633 * A pointer to the contents in the success state.
5634 * Reading from this pointer when `result_ok` is not set is undefined.
5636 struct LDKHTLCUpdate *result;
5638 * A pointer to the contents in the error state.
5639 * Reading from this pointer when `result_ok` is set is undefined.
5641 struct LDKDecodeError *err;
5642 } LDKCResult_HTLCUpdateDecodeErrorZPtr;
5645 * A CResult_HTLCUpdateDecodeErrorZ represents the result of a fallible operation,
5646 * containing a crate::lightning::chain::channelmonitor::HTLCUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
5647 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5649 typedef struct LDKCResult_HTLCUpdateDecodeErrorZ {
5651 * The contents of this CResult_HTLCUpdateDecodeErrorZ, accessible via either
5652 * `err` or `result` depending on the state of `result_ok`.
5654 union LDKCResult_HTLCUpdateDecodeErrorZPtr contents;
5656 * Whether this CResult_HTLCUpdateDecodeErrorZ represents a success state.
5659 } LDKCResult_HTLCUpdateDecodeErrorZ;
5664 * General Err type for ChannelMonitor actions. Generally, this implies that the data provided is
5665 * inconsistent with the ChannelMonitor being called. eg for ChannelMonitor::update_monitor this
5666 * means you tried to update a monitor for a different channel or the ChannelMonitorUpdate was
5668 * Contains a developer-readable error message.
5670 typedef struct MUST_USE_STRUCT LDKMonitorUpdateError {
5672 * A pointer to the opaque Rust object.
5673 * Nearly everywhere, inner must be non-null, however in places where
5674 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5676 LDKnativeMonitorUpdateError *inner;
5678 * Indicates that this is the only struct which contains the same pointer.
5679 * Rust functions which take ownership of an object provided via an argument require
5680 * this to be true and invalidate the object pointed to by inner.
5683 } LDKMonitorUpdateError;
5686 * The contents of CResult_NoneMonitorUpdateErrorZ
5688 typedef union LDKCResult_NoneMonitorUpdateErrorZPtr {
5690 * Note that this value is always NULL, as there are no contents in the OK variant
5694 * A pointer to the contents in the error state.
5695 * Reading from this pointer when `result_ok` is set is undefined.
5697 struct LDKMonitorUpdateError *err;
5698 } LDKCResult_NoneMonitorUpdateErrorZPtr;
5701 * A CResult_NoneMonitorUpdateErrorZ represents the result of a fallible operation,
5702 * containing a () on success and a crate::lightning::chain::channelmonitor::MonitorUpdateError on failure.
5703 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5705 typedef struct LDKCResult_NoneMonitorUpdateErrorZ {
5707 * The contents of this CResult_NoneMonitorUpdateErrorZ, accessible via either
5708 * `err` or `result` depending on the state of `result_ok`.
5710 union LDKCResult_NoneMonitorUpdateErrorZPtr contents;
5712 * Whether this CResult_NoneMonitorUpdateErrorZ represents a success state.
5715 } LDKCResult_NoneMonitorUpdateErrorZ;
5718 * A tuple of 2 elements. See the individual fields for the types contained.
5720 typedef struct LDKC2Tuple_OutPointScriptZ {
5722 * The element at position 0
5724 struct LDKOutPoint a;
5726 * The element at position 1
5728 struct LDKCVec_u8Z b;
5729 } LDKC2Tuple_OutPointScriptZ;
5732 * A tuple of 2 elements. See the individual fields for the types contained.
5734 typedef struct LDKC2Tuple_u32ScriptZ {
5736 * The element at position 0
5740 * The element at position 1
5742 struct LDKCVec_u8Z b;
5743 } LDKC2Tuple_u32ScriptZ;
5746 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_u32ScriptZs of arbitrary size.
5747 * This corresponds to std::vector in C++
5749 typedef struct LDKCVec_C2Tuple_u32ScriptZZ {
5751 * The elements in the array.
5752 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5754 struct LDKC2Tuple_u32ScriptZ *data;
5756 * The number of elements pointed to by `data`.
5759 } LDKCVec_C2Tuple_u32ScriptZZ;
5762 * A tuple of 2 elements. See the individual fields for the types contained.
5764 typedef struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ {
5766 * The element at position 0
5768 struct LDKThirtyTwoBytes a;
5770 * The element at position 1
5772 struct LDKCVec_C2Tuple_u32ScriptZZ b;
5773 } LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ;
5776 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZs of arbitrary size.
5777 * This corresponds to std::vector in C++
5779 typedef struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ {
5781 * The elements in the array.
5782 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5784 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ *data;
5786 * The number of elements pointed to by `data`.
5789 } LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ;
5792 * Some information provided on receipt of payment depends on whether the payment received is a
5793 * spontaneous payment or a \"conventional\" lightning payment that's paying an invoice.
5795 typedef enum LDKPaymentPurpose_Tag {
5797 * Information for receiving a payment that we generated an invoice for.
5799 LDKPaymentPurpose_InvoicePayment,
5801 * Because this is a spontaneous payment, the payer generated their own preimage rather than us
5802 * (the payee) providing a preimage.
5804 LDKPaymentPurpose_SpontaneousPayment,
5806 * Must be last for serialization purposes
5808 LDKPaymentPurpose_Sentinel,
5809 } LDKPaymentPurpose_Tag;
5811 typedef struct LDKPaymentPurpose_LDKInvoicePayment_Body {
5813 * The preimage to the payment_hash, if the payment hash (and secret) were fetched via
5814 * [`ChannelManager::create_inbound_payment`]. If provided, this can be handed directly to
5815 * [`ChannelManager::claim_funds`].
5817 * [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
5818 * [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
5820 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
5822 struct LDKThirtyTwoBytes payment_preimage;
5824 * The \"payment secret\". This authenticates the sender to the recipient, preventing a
5825 * number of deanonymization attacks during the routing process.
5826 * It is provided here for your reference, however its accuracy is enforced directly by
5827 * [`ChannelManager`] using the values you previously provided to
5828 * [`ChannelManager::create_inbound_payment`] or
5829 * [`ChannelManager::create_inbound_payment_for_hash`].
5831 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
5832 * [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
5833 * [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
5835 struct LDKThirtyTwoBytes payment_secret;
5837 * This is the `user_payment_id` which was provided to
5838 * [`ChannelManager::create_inbound_payment_for_hash`] or
5839 * [`ChannelManager::create_inbound_payment`]. It has no meaning inside of LDK and is
5840 * simply copied here. It may be used to correlate PaymentReceived events with invoice
5841 * metadata stored elsewhere.
5843 * [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
5844 * [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
5846 uint64_t user_payment_id;
5847 } LDKPaymentPurpose_LDKInvoicePayment_Body;
5849 typedef struct MUST_USE_STRUCT LDKPaymentPurpose {
5850 LDKPaymentPurpose_Tag tag;
5852 LDKPaymentPurpose_LDKInvoicePayment_Body invoice_payment;
5854 struct LDKThirtyTwoBytes spontaneous_payment;
5857 } LDKPaymentPurpose;
5860 * The reason the channel was closed. See individual variants more details.
5862 typedef enum LDKClosureReason_Tag {
5864 * Closure generated from receiving a peer error message.
5866 * Our counterparty may have broadcasted their latest commitment state, and we have
5869 LDKClosureReason_CounterpartyForceClosed,
5871 * Closure generated from [`ChannelManager::force_close_channel`], called by the user.
5873 * [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel.
5875 LDKClosureReason_HolderForceClosed,
5877 * The channel was closed after negotiating a cooperative close and we've now broadcasted
5878 * the cooperative close transaction. Note the shutdown may have been initiated by us.
5880 LDKClosureReason_CooperativeClosure,
5882 * A commitment transaction was confirmed on chain, closing the channel. Most likely this
5883 * commitment transaction came from our counterparty, but it may also have come from
5884 * a copy of our own `ChannelMonitor`.
5886 LDKClosureReason_CommitmentTxConfirmed,
5888 * Closure generated from processing an event, likely a HTLC forward/relay/reception.
5890 LDKClosureReason_ProcessingError,
5892 * The `PeerManager` informed us that we've disconnected from the peer. We close channels
5893 * if the `PeerManager` informed us that it is unlikely we'll be able to connect to the
5894 * peer again in the future or if the peer disconnected before we finished negotiating
5895 * the channel open. The first case may be caused by incompatible features which our
5896 * counterparty, or we, require.
5898 LDKClosureReason_DisconnectedPeer,
5900 * Closure generated from `ChannelManager::read` if the ChannelMonitor is newer than
5901 * the ChannelManager deserialized.
5903 LDKClosureReason_OutdatedChannelManager,
5905 * Must be last for serialization purposes
5907 LDKClosureReason_Sentinel,
5908 } LDKClosureReason_Tag;
5910 typedef struct LDKClosureReason_LDKCounterpartyForceClosed_Body {
5912 * The error which the peer sent us.
5914 * The string should be sanitized before it is used (e.g emitted to logs
5915 * or printed to stdout). Otherwise, a well crafted error message may exploit
5916 * a security vulnerability in the terminal emulator or the logging subsystem.
5918 struct LDKStr peer_msg;
5919 } LDKClosureReason_LDKCounterpartyForceClosed_Body;
5921 typedef struct LDKClosureReason_LDKProcessingError_Body {
5923 * A developer-readable error message which we generated.
5926 } LDKClosureReason_LDKProcessingError_Body;
5928 typedef struct MUST_USE_STRUCT LDKClosureReason {
5929 LDKClosureReason_Tag tag;
5931 LDKClosureReason_LDKCounterpartyForceClosed_Body counterparty_force_closed;
5932 LDKClosureReason_LDKProcessingError_Body processing_error;
5937 * An Event which you should probably take some action in response to.
5939 * Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
5940 * them directly as they don't round-trip exactly (for example FundingGenerationReady is never
5941 * written as it makes no sense to respond to it after reconnecting to peers).
5943 typedef enum LDKEvent_Tag {
5945 * Used to indicate that the client should generate a funding transaction with the given
5946 * parameters and then call ChannelManager::funding_transaction_generated.
5947 * Generated in ChannelManager message handling.
5948 * Note that *all inputs* in the funding transaction must spend SegWit outputs or your
5949 * counterparty can steal your funds!
5951 LDKEvent_FundingGenerationReady,
5953 * Indicates we've received money! Just gotta dig out that payment preimage and feed it to
5954 * ChannelManager::claim_funds to get it....
5955 * Note that if the preimage is not known or the amount paid is incorrect, you should call
5956 * ChannelManager::fail_htlc_backwards to free up resources for this HTLC and avoid
5957 * network congestion.
5958 * The amount paid should be considered 'incorrect' when it is less than or more than twice
5959 * the amount expected.
5960 * If you fail to call either ChannelManager::claim_funds or
5961 * ChannelManager::fail_htlc_backwards within the HTLC's timeout, the HTLC will be
5962 * automatically failed.
5964 LDKEvent_PaymentReceived,
5966 * Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
5967 * and we got back the payment preimage for it).
5969 * Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed`
5970 * event. In this situation, you SHOULD treat this payment as having succeeded.
5972 LDKEvent_PaymentSent,
5974 * Indicates an outbound payment we made failed. Probably some intermediary node dropped
5975 * something. You may wish to retry with a different route.
5977 LDKEvent_PaymentPathFailed,
5979 * Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
5980 * time in the future.
5982 LDKEvent_PendingHTLCsForwardable,
5984 * Used to indicate that an output which you should know how to spend was confirmed on chain
5985 * and is now spendable.
5986 * Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
5987 * counterparty spending them due to some kind of timeout. Thus, you need to store them
5988 * somewhere and spend them when you create on-chain transactions.
5990 LDKEvent_SpendableOutputs,
5992 * This event is generated when a payment has been successfully forwarded through us and a
5993 * forwarding fee earned.
5995 LDKEvent_PaymentForwarded,
5997 * Used to indicate that a channel with the given `channel_id` is in the process of closure.
5999 LDKEvent_ChannelClosed,
6001 * Must be last for serialization purposes
6006 typedef struct LDKEvent_LDKFundingGenerationReady_Body {
6008 * The random channel_id we picked which you'll need to pass into
6009 * ChannelManager::funding_transaction_generated.
6011 struct LDKThirtyTwoBytes temporary_channel_id;
6013 * The value, in satoshis, that the output should have.
6015 uint64_t channel_value_satoshis;
6017 * The script which should be used in the transaction output.
6019 struct LDKCVec_u8Z output_script;
6021 * The value passed in to ChannelManager::create_channel
6023 uint64_t user_channel_id;
6024 } LDKEvent_LDKFundingGenerationReady_Body;
6026 typedef struct LDKEvent_LDKPaymentReceived_Body {
6028 * The hash for which the preimage should be handed to the ChannelManager.
6030 struct LDKThirtyTwoBytes payment_hash;
6032 * The value, in thousandths of a satoshi, that this payment is for. Note that you must
6033 * compare this to the expected value before accepting the payment (as otherwise you are
6034 * providing proof-of-payment for less than the value you expected!).
6038 * Information for claiming this received payment, based on whether the purpose of the
6039 * payment is to pay an invoice or to send a spontaneous payment.
6041 struct LDKPaymentPurpose purpose;
6042 } LDKEvent_LDKPaymentReceived_Body;
6044 typedef struct LDKEvent_LDKPaymentSent_Body {
6046 * The preimage to the hash given to ChannelManager::send_payment.
6047 * Note that this serves as a payment receipt, if you wish to have such a thing, you must
6050 struct LDKThirtyTwoBytes payment_preimage;
6051 } LDKEvent_LDKPaymentSent_Body;
6053 typedef struct LDKEvent_LDKPaymentPathFailed_Body {
6055 * The hash which was given to ChannelManager::send_payment.
6057 struct LDKThirtyTwoBytes payment_hash;
6059 * Indicates the payment was rejected for some reason by the recipient. This implies that
6060 * the payment has failed, not just the route in question. If this is not set, you may
6061 * retry the payment via a different route.
6063 bool rejected_by_dest;
6065 * Any failure information conveyed via the Onion return packet by a node along the failed
6068 * Should be applied to the [`NetworkGraph`] so that routing decisions can take into
6069 * account the update. [`NetGraphMsgHandler`] is capable of doing this.
6071 * [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
6072 * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
6074 struct LDKCOption_NetworkUpdateZ network_update;
6076 * For both single-path and multi-path payments, this is set if all paths of the payment have
6077 * failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
6078 * larger MPP payment were still in flight when this event was generated.
6080 bool all_paths_failed;
6082 * The payment path that failed.
6084 struct LDKCVec_RouteHopZ path;
6085 } LDKEvent_LDKPaymentPathFailed_Body;
6087 typedef struct LDKEvent_LDKPendingHTLCsForwardable_Body {
6089 * The minimum amount of time that should be waited prior to calling
6090 * process_pending_htlc_forwards. To increase the effort required to correlate payments,
6091 * you should wait a random amount of time in roughly the range (now + time_forwardable,
6092 * now + 5*time_forwardable).
6094 uint64_t time_forwardable;
6095 } LDKEvent_LDKPendingHTLCsForwardable_Body;
6097 typedef struct LDKEvent_LDKSpendableOutputs_Body {
6099 * The outputs which you should store as spendable by you.
6101 struct LDKCVec_SpendableOutputDescriptorZ outputs;
6102 } LDKEvent_LDKSpendableOutputs_Body;
6104 typedef struct LDKEvent_LDKPaymentForwarded_Body {
6106 * The fee, in milli-satoshis, which was earned as a result of the payment.
6108 * Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
6109 * was pending, the amount the next hop claimed will have been rounded down to the nearest
6110 * whole satoshi. Thus, the fee calculated here may be higher than expected as we still
6111 * claimed the full value in millisatoshis from the source. In this case,
6112 * `claim_from_onchain_tx` will be set.
6114 * If the channel which sent us the payment has been force-closed, we will claim the funds
6115 * via an on-chain transaction. In that case we do not yet know the on-chain transaction
6116 * fees which we will spend and will instead set this to `None`. It is possible duplicate
6117 * `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
6120 struct LDKCOption_u64Z fee_earned_msat;
6122 * If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
6125 bool claim_from_onchain_tx;
6126 } LDKEvent_LDKPaymentForwarded_Body;
6128 typedef struct LDKEvent_LDKChannelClosed_Body {
6130 * The channel_id of the channel which has been closed. Note that on-chain transactions
6131 * resolving the channel are likely still awaiting confirmation.
6133 struct LDKThirtyTwoBytes channel_id;
6135 * The reason the channel was closed.
6137 struct LDKClosureReason reason;
6138 } LDKEvent_LDKChannelClosed_Body;
6140 typedef struct MUST_USE_STRUCT LDKEvent {
6143 LDKEvent_LDKFundingGenerationReady_Body funding_generation_ready;
6144 LDKEvent_LDKPaymentReceived_Body payment_received;
6145 LDKEvent_LDKPaymentSent_Body payment_sent;
6146 LDKEvent_LDKPaymentPathFailed_Body payment_path_failed;
6147 LDKEvent_LDKPendingHTLCsForwardable_Body pending_htl_cs_forwardable;
6148 LDKEvent_LDKSpendableOutputs_Body spendable_outputs;
6149 LDKEvent_LDKPaymentForwarded_Body payment_forwarded;
6150 LDKEvent_LDKChannelClosed_Body channel_closed;
6155 * A dynamically-allocated array of crate::lightning::util::events::Events of arbitrary size.
6156 * This corresponds to std::vector in C++
6158 typedef struct LDKCVec_EventZ {
6160 * The elements in the array.
6161 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6163 struct LDKEvent *data;
6165 * The number of elements pointed to by `data`.
6171 * A dynamically-allocated array of crate::c_types::Transactions of arbitrary size.
6172 * This corresponds to std::vector in C++
6174 typedef struct LDKCVec_TransactionZ {
6176 * The elements in the array.
6177 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6179 struct LDKTransaction *data;
6181 * The number of elements pointed to by `data`.
6184 } LDKCVec_TransactionZ;
6187 * A tuple of 2 elements. See the individual fields for the types contained.
6189 typedef struct LDKC2Tuple_u32TxOutZ {
6191 * The element at position 0
6195 * The element at position 1
6198 } LDKC2Tuple_u32TxOutZ;
6201 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_u32TxOutZs of arbitrary size.
6202 * This corresponds to std::vector in C++
6204 typedef struct LDKCVec_C2Tuple_u32TxOutZZ {
6206 * The elements in the array.
6207 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6209 struct LDKC2Tuple_u32TxOutZ *data;
6211 * The number of elements pointed to by `data`.
6214 } LDKCVec_C2Tuple_u32TxOutZZ;
6217 * A tuple of 2 elements. See the individual fields for the types contained.
6219 typedef struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ {
6221 * The element at position 0
6223 struct LDKThirtyTwoBytes a;
6225 * The element at position 1
6227 struct LDKCVec_C2Tuple_u32TxOutZZ b;
6228 } LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ;
6231 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZs of arbitrary size.
6232 * This corresponds to std::vector in C++
6234 typedef struct LDKCVec_TransactionOutputsZ {
6236 * The elements in the array.
6237 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6239 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ *data;
6241 * The number of elements pointed to by `data`.
6244 } LDKCVec_TransactionOutputsZ;
6247 * Details about the balance(s) available for spending once the channel appears on chain.
6249 * See [`ChannelMonitor::get_claimable_balances`] for more details on when these will or will not
6252 typedef enum LDKBalance_Tag {
6254 * The channel is not yet closed (or the commitment or closing transaction has not yet
6255 * appeared in a block). The given balance is claimable (less on-chain fees) if the channel is
6258 LDKBalance_ClaimableOnChannelClose,
6260 * The channel has been closed, and the given balance is ours but awaiting confirmations until
6261 * we consider it spendable.
6263 LDKBalance_ClaimableAwaitingConfirmations,
6265 * The channel has been closed, and the given balance should be ours but awaiting spending
6266 * transaction confirmation. If the spending transaction does not confirm in time, it is
6267 * possible our counterparty can take the funds by broadcasting an HTLC timeout on-chain.
6269 * Once the spending transaction confirms, before it has reached enough confirmations to be
6270 * considered safe from chain reorganizations, the balance will instead be provided via
6271 * [`Balance::ClaimableAwaitingConfirmations`].
6273 LDKBalance_ContentiousClaimable,
6275 * HTLCs which we sent to our counterparty which are claimable after a timeout (less on-chain
6276 * fees) if the counterparty does not know the preimage for the HTLCs. These are somewhat
6277 * likely to be claimed by our counterparty before we do.
6279 LDKBalance_MaybeClaimableHTLCAwaitingTimeout,
6281 * Must be last for serialization purposes
6283 LDKBalance_Sentinel,
6286 typedef struct LDKBalance_LDKClaimableOnChannelClose_Body {
6288 * The amount available to claim, in satoshis, excluding the on-chain fees which will be
6289 * required to do so.
6291 uint64_t claimable_amount_satoshis;
6292 } LDKBalance_LDKClaimableOnChannelClose_Body;
6294 typedef struct LDKBalance_LDKClaimableAwaitingConfirmations_Body {
6296 * The amount available to claim, in satoshis, possibly excluding the on-chain fees which
6297 * were spent in broadcasting the transaction.
6299 uint64_t claimable_amount_satoshis;
6301 * The height at which an [`Event::SpendableOutputs`] event will be generated for this
6304 uint32_t confirmation_height;
6305 } LDKBalance_LDKClaimableAwaitingConfirmations_Body;
6307 typedef struct LDKBalance_LDKContentiousClaimable_Body {
6309 * The amount available to claim, in satoshis, excluding the on-chain fees which will be
6310 * required to do so.
6312 uint64_t claimable_amount_satoshis;
6314 * The height at which the counterparty may be able to claim the balance if we have not
6317 uint32_t timeout_height;
6318 } LDKBalance_LDKContentiousClaimable_Body;
6320 typedef struct LDKBalance_LDKMaybeClaimableHTLCAwaitingTimeout_Body {
6322 * The amount available to claim, in satoshis, excluding the on-chain fees which will be
6323 * required to do so.
6325 uint64_t claimable_amount_satoshis;
6327 * The height at which we will be able to claim the balance if our counterparty has not
6330 uint32_t claimable_height;
6331 } LDKBalance_LDKMaybeClaimableHTLCAwaitingTimeout_Body;
6333 typedef struct MUST_USE_STRUCT LDKBalance {
6336 LDKBalance_LDKClaimableOnChannelClose_Body claimable_on_channel_close;
6337 LDKBalance_LDKClaimableAwaitingConfirmations_Body claimable_awaiting_confirmations;
6338 LDKBalance_LDKContentiousClaimable_Body contentious_claimable;
6339 LDKBalance_LDKMaybeClaimableHTLCAwaitingTimeout_Body maybe_claimable_htlc_awaiting_timeout;
6344 * A dynamically-allocated array of crate::lightning::chain::channelmonitor::Balances of arbitrary size.
6345 * This corresponds to std::vector in C++
6347 typedef struct LDKCVec_BalanceZ {
6349 * The elements in the array.
6350 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6352 struct LDKBalance *data;
6354 * The number of elements pointed to by `data`.
6360 * The contents of CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ
6362 typedef union LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr {
6364 * A pointer to the contents in the success state.
6365 * Reading from this pointer when `result_ok` is not set is undefined.
6367 struct LDKC2Tuple_BlockHashChannelMonitorZ *result;
6369 * A pointer to the contents in the error state.
6370 * Reading from this pointer when `result_ok` is set is undefined.
6372 struct LDKDecodeError *err;
6373 } LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr;
6376 * A CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ represents the result of a fallible operation,
6377 * containing a crate::c_types::derived::C2Tuple_BlockHashChannelMonitorZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
6378 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6380 typedef struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ {
6382 * The contents of this CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ, accessible via either
6383 * `err` or `result` depending on the state of `result_ok`.
6385 union LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr contents;
6387 * Whether this CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ represents a success state.
6390 } LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ;
6393 * The contents of CResult_NoneLightningErrorZ
6395 typedef union LDKCResult_NoneLightningErrorZPtr {
6397 * Note that this value is always NULL, as there are no contents in the OK variant
6401 * A pointer to the contents in the error state.
6402 * Reading from this pointer when `result_ok` is set is undefined.
6404 struct LDKLightningError *err;
6405 } LDKCResult_NoneLightningErrorZPtr;
6408 * A CResult_NoneLightningErrorZ represents the result of a fallible operation,
6409 * containing a () on success and a crate::lightning::ln::msgs::LightningError on failure.
6410 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6412 typedef struct LDKCResult_NoneLightningErrorZ {
6414 * The contents of this CResult_NoneLightningErrorZ, accessible via either
6415 * `err` or `result` depending on the state of `result_ok`.
6417 union LDKCResult_NoneLightningErrorZPtr contents;
6419 * Whether this CResult_NoneLightningErrorZ represents a success state.
6422 } LDKCResult_NoneLightningErrorZ;
6425 * A tuple of 2 elements. See the individual fields for the types contained.
6427 typedef struct LDKC2Tuple_PublicKeyTypeZ {
6429 * The element at position 0
6431 struct LDKPublicKey a;
6433 * The element at position 1
6436 } LDKC2Tuple_PublicKeyTypeZ;
6439 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_PublicKeyTypeZs of arbitrary size.
6440 * This corresponds to std::vector in C++
6442 typedef struct LDKCVec_C2Tuple_PublicKeyTypeZZ {
6444 * The elements in the array.
6445 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6447 struct LDKC2Tuple_PublicKeyTypeZ *data;
6449 * The number of elements pointed to by `data`.
6452 } LDKCVec_C2Tuple_PublicKeyTypeZZ;
6455 * The contents of CResult_boolLightningErrorZ
6457 typedef union LDKCResult_boolLightningErrorZPtr {
6459 * A pointer to the contents in the success state.
6460 * Reading from this pointer when `result_ok` is not set is undefined.
6464 * A pointer to the contents in the error state.
6465 * Reading from this pointer when `result_ok` is set is undefined.
6467 struct LDKLightningError *err;
6468 } LDKCResult_boolLightningErrorZPtr;
6471 * A CResult_boolLightningErrorZ represents the result of a fallible operation,
6472 * containing a bool on success and a crate::lightning::ln::msgs::LightningError on failure.
6473 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6475 typedef struct LDKCResult_boolLightningErrorZ {
6477 * The contents of this CResult_boolLightningErrorZ, accessible via either
6478 * `err` or `result` depending on the state of `result_ok`.
6480 union LDKCResult_boolLightningErrorZPtr contents;
6482 * Whether this CResult_boolLightningErrorZ represents a success state.
6485 } LDKCResult_boolLightningErrorZ;
6488 * A tuple of 3 elements. See the individual fields for the types contained.
6490 typedef struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ {
6492 * The element at position 0
6494 struct LDKChannelAnnouncement a;
6496 * The element at position 1
6498 struct LDKChannelUpdate b;
6500 * The element at position 2
6502 struct LDKChannelUpdate c;
6503 } LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ;
6506 * A dynamically-allocated array of crate::c_types::derived::C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZs of arbitrary size.
6507 * This corresponds to std::vector in C++
6509 typedef struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ {
6511 * The elements in the array.
6512 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6514 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ *data;
6516 * The number of elements pointed to by `data`.
6519 } LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ;
6522 * A dynamically-allocated array of crate::lightning::ln::msgs::NodeAnnouncements of arbitrary size.
6523 * This corresponds to std::vector in C++
6525 typedef struct LDKCVec_NodeAnnouncementZ {
6527 * The elements in the array.
6528 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6530 struct LDKNodeAnnouncement *data;
6532 * The number of elements pointed to by `data`.
6535 } LDKCVec_NodeAnnouncementZ;
6538 * A dynamically-allocated array of crate::c_types::PublicKeys of arbitrary size.
6539 * This corresponds to std::vector in C++
6541 typedef struct LDKCVec_PublicKeyZ {
6543 * The elements in the array.
6544 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6546 struct LDKPublicKey *data;
6548 * The number of elements pointed to by `data`.
6551 } LDKCVec_PublicKeyZ;
6556 * Error for PeerManager errors. If you get one of these, you must disconnect the socket and
6557 * generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
6560 typedef struct MUST_USE_STRUCT LDKPeerHandleError {
6562 * A pointer to the opaque Rust object.
6563 * Nearly everywhere, inner must be non-null, however in places where
6564 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6566 LDKnativePeerHandleError *inner;
6568 * Indicates that this is the only struct which contains the same pointer.
6569 * Rust functions which take ownership of an object provided via an argument require
6570 * this to be true and invalidate the object pointed to by inner.
6573 } LDKPeerHandleError;
6576 * The contents of CResult_CVec_u8ZPeerHandleErrorZ
6578 typedef union LDKCResult_CVec_u8ZPeerHandleErrorZPtr {
6580 * A pointer to the contents in the success state.
6581 * Reading from this pointer when `result_ok` is not set is undefined.
6583 struct LDKCVec_u8Z *result;
6585 * A pointer to the contents in the error state.
6586 * Reading from this pointer when `result_ok` is set is undefined.
6588 struct LDKPeerHandleError *err;
6589 } LDKCResult_CVec_u8ZPeerHandleErrorZPtr;
6592 * A CResult_CVec_u8ZPeerHandleErrorZ represents the result of a fallible operation,
6593 * containing a crate::c_types::derived::CVec_u8Z on success and a crate::lightning::ln::peer_handler::PeerHandleError on failure.
6594 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6596 typedef struct LDKCResult_CVec_u8ZPeerHandleErrorZ {
6598 * The contents of this CResult_CVec_u8ZPeerHandleErrorZ, accessible via either
6599 * `err` or `result` depending on the state of `result_ok`.
6601 union LDKCResult_CVec_u8ZPeerHandleErrorZPtr contents;
6603 * Whether this CResult_CVec_u8ZPeerHandleErrorZ represents a success state.
6606 } LDKCResult_CVec_u8ZPeerHandleErrorZ;
6609 * The contents of CResult_NonePeerHandleErrorZ
6611 typedef union LDKCResult_NonePeerHandleErrorZPtr {
6613 * Note that this value is always NULL, as there are no contents in the OK variant
6617 * A pointer to the contents in the error state.
6618 * Reading from this pointer when `result_ok` is set is undefined.
6620 struct LDKPeerHandleError *err;
6621 } LDKCResult_NonePeerHandleErrorZPtr;
6624 * A CResult_NonePeerHandleErrorZ represents the result of a fallible operation,
6625 * containing a () on success and a crate::lightning::ln::peer_handler::PeerHandleError on failure.
6626 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6628 typedef struct LDKCResult_NonePeerHandleErrorZ {
6630 * The contents of this CResult_NonePeerHandleErrorZ, accessible via either
6631 * `err` or `result` depending on the state of `result_ok`.
6633 union LDKCResult_NonePeerHandleErrorZPtr contents;
6635 * Whether this CResult_NonePeerHandleErrorZ represents a success state.
6638 } LDKCResult_NonePeerHandleErrorZ;
6641 * The contents of CResult_boolPeerHandleErrorZ
6643 typedef union LDKCResult_boolPeerHandleErrorZPtr {
6645 * A pointer to the contents in the success state.
6646 * Reading from this pointer when `result_ok` is not set is undefined.
6650 * A pointer to the contents in the error state.
6651 * Reading from this pointer when `result_ok` is set is undefined.
6653 struct LDKPeerHandleError *err;
6654 } LDKCResult_boolPeerHandleErrorZPtr;
6657 * A CResult_boolPeerHandleErrorZ represents the result of a fallible operation,
6658 * containing a bool on success and a crate::lightning::ln::peer_handler::PeerHandleError on failure.
6659 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6661 typedef struct LDKCResult_boolPeerHandleErrorZ {
6663 * The contents of this CResult_boolPeerHandleErrorZ, accessible via either
6664 * `err` or `result` depending on the state of `result_ok`.
6666 union LDKCResult_boolPeerHandleErrorZPtr contents;
6668 * Whether this CResult_boolPeerHandleErrorZ represents a success state.
6671 } LDKCResult_boolPeerHandleErrorZ;
6674 * The `Access` trait defines behavior for accessing chain data and state, such as blocks and
6677 typedef struct LDKAccess {
6679 * An opaque pointer which is passed to your function implementations as an argument.
6680 * This has no meaning in the LDK, and can be NULL or any other value.
6684 * Returns the transaction output of a funding transaction encoded by [`short_channel_id`].
6685 * Returns an error if `genesis_hash` is for a different chain or if such a transaction output
6688 * [`short_channel_id`]: https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md#definition-of-short_channel_id
6690 struct LDKCResult_TxOutAccessErrorZ (*get_utxo)(const void *this_arg, const uint8_t (*genesis_hash)[32], uint64_t short_channel_id);
6692 * Frees any resources associated with this object given its this_arg pointer.
6693 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6695 void (*free)(void *this_arg);
6699 * An enum which can either contain a crate::lightning::chain::Access or not
6701 typedef enum LDKCOption_AccessZ_Tag {
6703 * When we're in this state, this COption_AccessZ contains a crate::lightning::chain::Access
6705 LDKCOption_AccessZ_Some,
6707 * When we're in this state, this COption_AccessZ contains nothing
6709 LDKCOption_AccessZ_None,
6711 * Must be last for serialization purposes
6713 LDKCOption_AccessZ_Sentinel,
6714 } LDKCOption_AccessZ_Tag;
6716 typedef struct LDKCOption_AccessZ {
6717 LDKCOption_AccessZ_Tag tag;
6720 struct LDKAccess some;
6723 } LDKCOption_AccessZ;
6728 * Details about one direction of a channel. Received
6729 * within a channel update.
6731 typedef struct MUST_USE_STRUCT LDKDirectionalChannelInfo {
6733 * A pointer to the opaque Rust object.
6734 * Nearly everywhere, inner must be non-null, however in places where
6735 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6737 LDKnativeDirectionalChannelInfo *inner;
6739 * Indicates that this is the only struct which contains the same pointer.
6740 * Rust functions which take ownership of an object provided via an argument require
6741 * this to be true and invalidate the object pointed to by inner.
6744 } LDKDirectionalChannelInfo;
6747 * The contents of CResult_DirectionalChannelInfoDecodeErrorZ
6749 typedef union LDKCResult_DirectionalChannelInfoDecodeErrorZPtr {
6751 * A pointer to the contents in the success state.
6752 * Reading from this pointer when `result_ok` is not set is undefined.
6754 struct LDKDirectionalChannelInfo *result;
6756 * A pointer to the contents in the error state.
6757 * Reading from this pointer when `result_ok` is set is undefined.
6759 struct LDKDecodeError *err;
6760 } LDKCResult_DirectionalChannelInfoDecodeErrorZPtr;
6763 * A CResult_DirectionalChannelInfoDecodeErrorZ represents the result of a fallible operation,
6764 * containing a crate::lightning::routing::network_graph::DirectionalChannelInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
6765 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6767 typedef struct LDKCResult_DirectionalChannelInfoDecodeErrorZ {
6769 * The contents of this CResult_DirectionalChannelInfoDecodeErrorZ, accessible via either
6770 * `err` or `result` depending on the state of `result_ok`.
6772 union LDKCResult_DirectionalChannelInfoDecodeErrorZPtr contents;
6774 * Whether this CResult_DirectionalChannelInfoDecodeErrorZ represents a success state.
6777 } LDKCResult_DirectionalChannelInfoDecodeErrorZ;
6782 * Details about a channel (both directions).
6783 * Received within a channel announcement.
6785 typedef struct MUST_USE_STRUCT LDKChannelInfo {
6787 * A pointer to the opaque Rust object.
6788 * Nearly everywhere, inner must be non-null, however in places where
6789 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6791 LDKnativeChannelInfo *inner;
6793 * Indicates that this is the only struct which contains the same pointer.
6794 * Rust functions which take ownership of an object provided via an argument require
6795 * this to be true and invalidate the object pointed to by inner.
6801 * The contents of CResult_ChannelInfoDecodeErrorZ
6803 typedef union LDKCResult_ChannelInfoDecodeErrorZPtr {
6805 * A pointer to the contents in the success state.
6806 * Reading from this pointer when `result_ok` is not set is undefined.
6808 struct LDKChannelInfo *result;
6810 * A pointer to the contents in the error state.
6811 * Reading from this pointer when `result_ok` is set is undefined.
6813 struct LDKDecodeError *err;
6814 } LDKCResult_ChannelInfoDecodeErrorZPtr;
6817 * A CResult_ChannelInfoDecodeErrorZ represents the result of a fallible operation,
6818 * containing a crate::lightning::routing::network_graph::ChannelInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
6819 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6821 typedef struct LDKCResult_ChannelInfoDecodeErrorZ {
6823 * The contents of this CResult_ChannelInfoDecodeErrorZ, accessible via either
6824 * `err` or `result` depending on the state of `result_ok`.
6826 union LDKCResult_ChannelInfoDecodeErrorZPtr contents;
6828 * Whether this CResult_ChannelInfoDecodeErrorZ represents a success state.
6831 } LDKCResult_ChannelInfoDecodeErrorZ;
6836 * Fees for routing via a given channel or a node
6838 typedef struct MUST_USE_STRUCT LDKRoutingFees {
6840 * A pointer to the opaque Rust object.
6841 * Nearly everywhere, inner must be non-null, however in places where
6842 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6844 LDKnativeRoutingFees *inner;
6846 * Indicates that this is the only struct which contains the same pointer.
6847 * Rust functions which take ownership of an object provided via an argument require
6848 * this to be true and invalidate the object pointed to by inner.
6854 * The contents of CResult_RoutingFeesDecodeErrorZ
6856 typedef union LDKCResult_RoutingFeesDecodeErrorZPtr {
6858 * A pointer to the contents in the success state.
6859 * Reading from this pointer when `result_ok` is not set is undefined.
6861 struct LDKRoutingFees *result;
6863 * A pointer to the contents in the error state.
6864 * Reading from this pointer when `result_ok` is set is undefined.
6866 struct LDKDecodeError *err;
6867 } LDKCResult_RoutingFeesDecodeErrorZPtr;
6870 * A CResult_RoutingFeesDecodeErrorZ represents the result of a fallible operation,
6871 * containing a crate::lightning::routing::network_graph::RoutingFees on success and a crate::lightning::ln::msgs::DecodeError on failure.
6872 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6874 typedef struct LDKCResult_RoutingFeesDecodeErrorZ {
6876 * The contents of this CResult_RoutingFeesDecodeErrorZ, accessible via either
6877 * `err` or `result` depending on the state of `result_ok`.
6879 union LDKCResult_RoutingFeesDecodeErrorZPtr contents;
6881 * Whether this CResult_RoutingFeesDecodeErrorZ represents a success state.
6884 } LDKCResult_RoutingFeesDecodeErrorZ;
6889 * Information received in the latest node_announcement from this node.
6891 typedef struct MUST_USE_STRUCT LDKNodeAnnouncementInfo {
6893 * A pointer to the opaque Rust object.
6894 * Nearly everywhere, inner must be non-null, however in places where
6895 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6897 LDKnativeNodeAnnouncementInfo *inner;
6899 * Indicates that this is the only struct which contains the same pointer.
6900 * Rust functions which take ownership of an object provided via an argument require
6901 * this to be true and invalidate the object pointed to by inner.
6904 } LDKNodeAnnouncementInfo;
6907 * The contents of CResult_NodeAnnouncementInfoDecodeErrorZ
6909 typedef union LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr {
6911 * A pointer to the contents in the success state.
6912 * Reading from this pointer when `result_ok` is not set is undefined.
6914 struct LDKNodeAnnouncementInfo *result;
6916 * A pointer to the contents in the error state.
6917 * Reading from this pointer when `result_ok` is set is undefined.
6919 struct LDKDecodeError *err;
6920 } LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr;
6923 * A CResult_NodeAnnouncementInfoDecodeErrorZ represents the result of a fallible operation,
6924 * containing a crate::lightning::routing::network_graph::NodeAnnouncementInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
6925 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6927 typedef struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ {
6929 * The contents of this CResult_NodeAnnouncementInfoDecodeErrorZ, accessible via either
6930 * `err` or `result` depending on the state of `result_ok`.
6932 union LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr contents;
6934 * Whether this CResult_NodeAnnouncementInfoDecodeErrorZ represents a success state.
6937 } LDKCResult_NodeAnnouncementInfoDecodeErrorZ;
6940 * A dynamically-allocated array of u64s of arbitrary size.
6941 * This corresponds to std::vector in C++
6943 typedef struct LDKCVec_u64Z {
6945 * The elements in the array.
6946 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6950 * The number of elements pointed to by `data`.
6958 * Details about a node in the network, known from the network announcement.
6960 typedef struct MUST_USE_STRUCT LDKNodeInfo {
6962 * A pointer to the opaque Rust object.
6963 * Nearly everywhere, inner must be non-null, however in places where
6964 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6966 LDKnativeNodeInfo *inner;
6968 * Indicates that this is the only struct which contains the same pointer.
6969 * Rust functions which take ownership of an object provided via an argument require
6970 * this to be true and invalidate the object pointed to by inner.
6976 * The contents of CResult_NodeInfoDecodeErrorZ
6978 typedef union LDKCResult_NodeInfoDecodeErrorZPtr {
6980 * A pointer to the contents in the success state.
6981 * Reading from this pointer when `result_ok` is not set is undefined.
6983 struct LDKNodeInfo *result;
6985 * A pointer to the contents in the error state.
6986 * Reading from this pointer when `result_ok` is set is undefined.
6988 struct LDKDecodeError *err;
6989 } LDKCResult_NodeInfoDecodeErrorZPtr;
6992 * A CResult_NodeInfoDecodeErrorZ represents the result of a fallible operation,
6993 * containing a crate::lightning::routing::network_graph::NodeInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
6994 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6996 typedef struct LDKCResult_NodeInfoDecodeErrorZ {
6998 * The contents of this CResult_NodeInfoDecodeErrorZ, accessible via either
6999 * `err` or `result` depending on the state of `result_ok`.
7001 union LDKCResult_NodeInfoDecodeErrorZPtr contents;
7003 * Whether this CResult_NodeInfoDecodeErrorZ represents a success state.
7006 } LDKCResult_NodeInfoDecodeErrorZ;
7011 * Represents the network as nodes and channels between them
7013 typedef struct MUST_USE_STRUCT LDKNetworkGraph {
7015 * A pointer to the opaque Rust object.
7016 * Nearly everywhere, inner must be non-null, however in places where
7017 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7019 LDKnativeNetworkGraph *inner;
7021 * Indicates that this is the only struct which contains the same pointer.
7022 * Rust functions which take ownership of an object provided via an argument require
7023 * this to be true and invalidate the object pointed to by inner.
7029 * The contents of CResult_NetworkGraphDecodeErrorZ
7031 typedef union LDKCResult_NetworkGraphDecodeErrorZPtr {
7033 * A pointer to the contents in the success state.
7034 * Reading from this pointer when `result_ok` is not set is undefined.
7036 struct LDKNetworkGraph *result;
7038 * A pointer to the contents in the error state.
7039 * Reading from this pointer when `result_ok` is set is undefined.
7041 struct LDKDecodeError *err;
7042 } LDKCResult_NetworkGraphDecodeErrorZPtr;
7045 * A CResult_NetworkGraphDecodeErrorZ represents the result of a fallible operation,
7046 * containing a crate::lightning::routing::network_graph::NetworkGraph on success and a crate::lightning::ln::msgs::DecodeError on failure.
7047 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7049 typedef struct LDKCResult_NetworkGraphDecodeErrorZ {
7051 * The contents of this CResult_NetworkGraphDecodeErrorZ, accessible via either
7052 * `err` or `result` depending on the state of `result_ok`.
7054 union LDKCResult_NetworkGraphDecodeErrorZPtr contents;
7056 * Whether this CResult_NetworkGraphDecodeErrorZ represents a success state.
7059 } LDKCResult_NetworkGraphDecodeErrorZ;
7062 * The contents of CResult_NetAddressu8Z
7064 typedef union LDKCResult_NetAddressu8ZPtr {
7066 * A pointer to the contents in the success state.
7067 * Reading from this pointer when `result_ok` is not set is undefined.
7069 struct LDKNetAddress *result;
7071 * A pointer to the contents in the error state.
7072 * Reading from this pointer when `result_ok` is set is undefined.
7075 } LDKCResult_NetAddressu8ZPtr;
7078 * A CResult_NetAddressu8Z represents the result of a fallible operation,
7079 * containing a crate::lightning::ln::msgs::NetAddress on success and a u8 on failure.
7080 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7082 typedef struct LDKCResult_NetAddressu8Z {
7084 * The contents of this CResult_NetAddressu8Z, accessible via either
7085 * `err` or `result` depending on the state of `result_ok`.
7087 union LDKCResult_NetAddressu8ZPtr contents;
7089 * Whether this CResult_NetAddressu8Z represents a success state.
7092 } LDKCResult_NetAddressu8Z;
7095 * The contents of CResult_CResult_NetAddressu8ZDecodeErrorZ
7097 typedef union LDKCResult_CResult_NetAddressu8ZDecodeErrorZPtr {
7099 * A pointer to the contents in the success state.
7100 * Reading from this pointer when `result_ok` is not set is undefined.
7102 struct LDKCResult_NetAddressu8Z *result;
7104 * A pointer to the contents in the error state.
7105 * Reading from this pointer when `result_ok` is set is undefined.
7107 struct LDKDecodeError *err;
7108 } LDKCResult_CResult_NetAddressu8ZDecodeErrorZPtr;
7111 * A CResult_CResult_NetAddressu8ZDecodeErrorZ represents the result of a fallible operation,
7112 * containing a crate::c_types::derived::CResult_NetAddressu8Z on success and a crate::lightning::ln::msgs::DecodeError on failure.
7113 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7115 typedef struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ {
7117 * The contents of this CResult_CResult_NetAddressu8ZDecodeErrorZ, accessible via either
7118 * `err` or `result` depending on the state of `result_ok`.
7120 union LDKCResult_CResult_NetAddressu8ZDecodeErrorZPtr contents;
7122 * Whether this CResult_CResult_NetAddressu8ZDecodeErrorZ represents a success state.
7125 } LDKCResult_CResult_NetAddressu8ZDecodeErrorZ;
7128 * The contents of CResult_NetAddressDecodeErrorZ
7130 typedef union LDKCResult_NetAddressDecodeErrorZPtr {
7132 * A pointer to the contents in the success state.
7133 * Reading from this pointer when `result_ok` is not set is undefined.
7135 struct LDKNetAddress *result;
7137 * A pointer to the contents in the error state.
7138 * Reading from this pointer when `result_ok` is set is undefined.
7140 struct LDKDecodeError *err;
7141 } LDKCResult_NetAddressDecodeErrorZPtr;
7144 * A CResult_NetAddressDecodeErrorZ represents the result of a fallible operation,
7145 * containing a crate::lightning::ln::msgs::NetAddress on success and a crate::lightning::ln::msgs::DecodeError on failure.
7146 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7148 typedef struct LDKCResult_NetAddressDecodeErrorZ {
7150 * The contents of this CResult_NetAddressDecodeErrorZ, accessible via either
7151 * `err` or `result` depending on the state of `result_ok`.
7153 union LDKCResult_NetAddressDecodeErrorZPtr contents;
7155 * Whether this CResult_NetAddressDecodeErrorZ represents a success state.
7158 } LDKCResult_NetAddressDecodeErrorZ;
7163 * An update_add_htlc message to be sent or received from a peer
7165 typedef struct MUST_USE_STRUCT LDKUpdateAddHTLC {
7167 * A pointer to the opaque Rust object.
7168 * Nearly everywhere, inner must be non-null, however in places where
7169 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7171 LDKnativeUpdateAddHTLC *inner;
7173 * Indicates that this is the only struct which contains the same pointer.
7174 * Rust functions which take ownership of an object provided via an argument require
7175 * this to be true and invalidate the object pointed to by inner.
7181 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateAddHTLCs of arbitrary size.
7182 * This corresponds to std::vector in C++
7184 typedef struct LDKCVec_UpdateAddHTLCZ {
7186 * The elements in the array.
7187 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7189 struct LDKUpdateAddHTLC *data;
7191 * The number of elements pointed to by `data`.
7194 } LDKCVec_UpdateAddHTLCZ;
7199 * An update_fulfill_htlc message to be sent or received from a peer
7201 typedef struct MUST_USE_STRUCT LDKUpdateFulfillHTLC {
7203 * A pointer to the opaque Rust object.
7204 * Nearly everywhere, inner must be non-null, however in places where
7205 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7207 LDKnativeUpdateFulfillHTLC *inner;
7209 * Indicates that this is the only struct which contains the same pointer.
7210 * Rust functions which take ownership of an object provided via an argument require
7211 * this to be true and invalidate the object pointed to by inner.
7214 } LDKUpdateFulfillHTLC;
7217 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateFulfillHTLCs of arbitrary size.
7218 * This corresponds to std::vector in C++
7220 typedef struct LDKCVec_UpdateFulfillHTLCZ {
7222 * The elements in the array.
7223 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7225 struct LDKUpdateFulfillHTLC *data;
7227 * The number of elements pointed to by `data`.
7230 } LDKCVec_UpdateFulfillHTLCZ;
7235 * An update_fail_htlc message to be sent or received from a peer
7237 typedef struct MUST_USE_STRUCT LDKUpdateFailHTLC {
7239 * A pointer to the opaque Rust object.
7240 * Nearly everywhere, inner must be non-null, however in places where
7241 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7243 LDKnativeUpdateFailHTLC *inner;
7245 * Indicates that this is the only struct which contains the same pointer.
7246 * Rust functions which take ownership of an object provided via an argument require
7247 * this to be true and invalidate the object pointed to by inner.
7250 } LDKUpdateFailHTLC;
7253 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateFailHTLCs of arbitrary size.
7254 * This corresponds to std::vector in C++
7256 typedef struct LDKCVec_UpdateFailHTLCZ {
7258 * The elements in the array.
7259 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7261 struct LDKUpdateFailHTLC *data;
7263 * The number of elements pointed to by `data`.
7266 } LDKCVec_UpdateFailHTLCZ;
7271 * An update_fail_malformed_htlc message to be sent or received from a peer
7273 typedef struct MUST_USE_STRUCT LDKUpdateFailMalformedHTLC {
7275 * A pointer to the opaque Rust object.
7276 * Nearly everywhere, inner must be non-null, however in places where
7277 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7279 LDKnativeUpdateFailMalformedHTLC *inner;
7281 * Indicates that this is the only struct which contains the same pointer.
7282 * Rust functions which take ownership of an object provided via an argument require
7283 * this to be true and invalidate the object pointed to by inner.
7286 } LDKUpdateFailMalformedHTLC;
7289 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateFailMalformedHTLCs of arbitrary size.
7290 * This corresponds to std::vector in C++
7292 typedef struct LDKCVec_UpdateFailMalformedHTLCZ {
7294 * The elements in the array.
7295 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7297 struct LDKUpdateFailMalformedHTLC *data;
7299 * The number of elements pointed to by `data`.
7302 } LDKCVec_UpdateFailMalformedHTLCZ;
7305 * The contents of CResult_AcceptChannelDecodeErrorZ
7307 typedef union LDKCResult_AcceptChannelDecodeErrorZPtr {
7309 * A pointer to the contents in the success state.
7310 * Reading from this pointer when `result_ok` is not set is undefined.
7312 struct LDKAcceptChannel *result;
7314 * A pointer to the contents in the error state.
7315 * Reading from this pointer when `result_ok` is set is undefined.
7317 struct LDKDecodeError *err;
7318 } LDKCResult_AcceptChannelDecodeErrorZPtr;
7321 * A CResult_AcceptChannelDecodeErrorZ represents the result of a fallible operation,
7322 * containing a crate::lightning::ln::msgs::AcceptChannel on success and a crate::lightning::ln::msgs::DecodeError on failure.
7323 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7325 typedef struct LDKCResult_AcceptChannelDecodeErrorZ {
7327 * The contents of this CResult_AcceptChannelDecodeErrorZ, accessible via either
7328 * `err` or `result` depending on the state of `result_ok`.
7330 union LDKCResult_AcceptChannelDecodeErrorZPtr contents;
7332 * Whether this CResult_AcceptChannelDecodeErrorZ represents a success state.
7335 } LDKCResult_AcceptChannelDecodeErrorZ;
7338 * The contents of CResult_AnnouncementSignaturesDecodeErrorZ
7340 typedef union LDKCResult_AnnouncementSignaturesDecodeErrorZPtr {
7342 * A pointer to the contents in the success state.
7343 * Reading from this pointer when `result_ok` is not set is undefined.
7345 struct LDKAnnouncementSignatures *result;
7347 * A pointer to the contents in the error state.
7348 * Reading from this pointer when `result_ok` is set is undefined.
7350 struct LDKDecodeError *err;
7351 } LDKCResult_AnnouncementSignaturesDecodeErrorZPtr;
7354 * A CResult_AnnouncementSignaturesDecodeErrorZ represents the result of a fallible operation,
7355 * containing a crate::lightning::ln::msgs::AnnouncementSignatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
7356 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7358 typedef struct LDKCResult_AnnouncementSignaturesDecodeErrorZ {
7360 * The contents of this CResult_AnnouncementSignaturesDecodeErrorZ, accessible via either
7361 * `err` or `result` depending on the state of `result_ok`.
7363 union LDKCResult_AnnouncementSignaturesDecodeErrorZPtr contents;
7365 * Whether this CResult_AnnouncementSignaturesDecodeErrorZ represents a success state.
7368 } LDKCResult_AnnouncementSignaturesDecodeErrorZ;
7371 * The contents of CResult_ChannelReestablishDecodeErrorZ
7373 typedef union LDKCResult_ChannelReestablishDecodeErrorZPtr {
7375 * A pointer to the contents in the success state.
7376 * Reading from this pointer when `result_ok` is not set is undefined.
7378 struct LDKChannelReestablish *result;
7380 * A pointer to the contents in the error state.
7381 * Reading from this pointer when `result_ok` is set is undefined.
7383 struct LDKDecodeError *err;
7384 } LDKCResult_ChannelReestablishDecodeErrorZPtr;
7387 * A CResult_ChannelReestablishDecodeErrorZ represents the result of a fallible operation,
7388 * containing a crate::lightning::ln::msgs::ChannelReestablish on success and a crate::lightning::ln::msgs::DecodeError on failure.
7389 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7391 typedef struct LDKCResult_ChannelReestablishDecodeErrorZ {
7393 * The contents of this CResult_ChannelReestablishDecodeErrorZ, accessible via either
7394 * `err` or `result` depending on the state of `result_ok`.
7396 union LDKCResult_ChannelReestablishDecodeErrorZPtr contents;
7398 * Whether this CResult_ChannelReestablishDecodeErrorZ represents a success state.
7401 } LDKCResult_ChannelReestablishDecodeErrorZ;
7404 * The contents of CResult_ClosingSignedDecodeErrorZ
7406 typedef union LDKCResult_ClosingSignedDecodeErrorZPtr {
7408 * A pointer to the contents in the success state.
7409 * Reading from this pointer when `result_ok` is not set is undefined.
7411 struct LDKClosingSigned *result;
7413 * A pointer to the contents in the error state.
7414 * Reading from this pointer when `result_ok` is set is undefined.
7416 struct LDKDecodeError *err;
7417 } LDKCResult_ClosingSignedDecodeErrorZPtr;
7420 * A CResult_ClosingSignedDecodeErrorZ represents the result of a fallible operation,
7421 * containing a crate::lightning::ln::msgs::ClosingSigned on success and a crate::lightning::ln::msgs::DecodeError on failure.
7422 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7424 typedef struct LDKCResult_ClosingSignedDecodeErrorZ {
7426 * The contents of this CResult_ClosingSignedDecodeErrorZ, accessible via either
7427 * `err` or `result` depending on the state of `result_ok`.
7429 union LDKCResult_ClosingSignedDecodeErrorZPtr contents;
7431 * Whether this CResult_ClosingSignedDecodeErrorZ represents a success state.
7434 } LDKCResult_ClosingSignedDecodeErrorZ;
7439 * The minimum and maximum fees which the sender is willing to place on the closing transaction.
7440 * This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
7443 typedef struct MUST_USE_STRUCT LDKClosingSignedFeeRange {
7445 * A pointer to the opaque Rust object.
7446 * Nearly everywhere, inner must be non-null, however in places where
7447 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7449 LDKnativeClosingSignedFeeRange *inner;
7451 * Indicates that this is the only struct which contains the same pointer.
7452 * Rust functions which take ownership of an object provided via an argument require
7453 * this to be true and invalidate the object pointed to by inner.
7456 } LDKClosingSignedFeeRange;
7459 * The contents of CResult_ClosingSignedFeeRangeDecodeErrorZ
7461 typedef union LDKCResult_ClosingSignedFeeRangeDecodeErrorZPtr {
7463 * A pointer to the contents in the success state.
7464 * Reading from this pointer when `result_ok` is not set is undefined.
7466 struct LDKClosingSignedFeeRange *result;
7468 * A pointer to the contents in the error state.
7469 * Reading from this pointer when `result_ok` is set is undefined.
7471 struct LDKDecodeError *err;
7472 } LDKCResult_ClosingSignedFeeRangeDecodeErrorZPtr;
7475 * A CResult_ClosingSignedFeeRangeDecodeErrorZ represents the result of a fallible operation,
7476 * containing a crate::lightning::ln::msgs::ClosingSignedFeeRange on success and a crate::lightning::ln::msgs::DecodeError on failure.
7477 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7479 typedef struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ {
7481 * The contents of this CResult_ClosingSignedFeeRangeDecodeErrorZ, accessible via either
7482 * `err` or `result` depending on the state of `result_ok`.
7484 union LDKCResult_ClosingSignedFeeRangeDecodeErrorZPtr contents;
7486 * Whether this CResult_ClosingSignedFeeRangeDecodeErrorZ represents a success state.
7489 } LDKCResult_ClosingSignedFeeRangeDecodeErrorZ;
7494 * A commitment_signed message to be sent or received from a peer
7496 typedef struct MUST_USE_STRUCT LDKCommitmentSigned {
7498 * A pointer to the opaque Rust object.
7499 * Nearly everywhere, inner must be non-null, however in places where
7500 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7502 LDKnativeCommitmentSigned *inner;
7504 * Indicates that this is the only struct which contains the same pointer.
7505 * Rust functions which take ownership of an object provided via an argument require
7506 * this to be true and invalidate the object pointed to by inner.
7509 } LDKCommitmentSigned;
7512 * The contents of CResult_CommitmentSignedDecodeErrorZ
7514 typedef union LDKCResult_CommitmentSignedDecodeErrorZPtr {
7516 * A pointer to the contents in the success state.
7517 * Reading from this pointer when `result_ok` is not set is undefined.
7519 struct LDKCommitmentSigned *result;
7521 * A pointer to the contents in the error state.
7522 * Reading from this pointer when `result_ok` is set is undefined.
7524 struct LDKDecodeError *err;
7525 } LDKCResult_CommitmentSignedDecodeErrorZPtr;
7528 * A CResult_CommitmentSignedDecodeErrorZ represents the result of a fallible operation,
7529 * containing a crate::lightning::ln::msgs::CommitmentSigned on success and a crate::lightning::ln::msgs::DecodeError on failure.
7530 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7532 typedef struct LDKCResult_CommitmentSignedDecodeErrorZ {
7534 * The contents of this CResult_CommitmentSignedDecodeErrorZ, accessible via either
7535 * `err` or `result` depending on the state of `result_ok`.
7537 union LDKCResult_CommitmentSignedDecodeErrorZPtr contents;
7539 * Whether this CResult_CommitmentSignedDecodeErrorZ represents a success state.
7542 } LDKCResult_CommitmentSignedDecodeErrorZ;
7545 * The contents of CResult_FundingCreatedDecodeErrorZ
7547 typedef union LDKCResult_FundingCreatedDecodeErrorZPtr {
7549 * A pointer to the contents in the success state.
7550 * Reading from this pointer when `result_ok` is not set is undefined.
7552 struct LDKFundingCreated *result;
7554 * A pointer to the contents in the error state.
7555 * Reading from this pointer when `result_ok` is set is undefined.
7557 struct LDKDecodeError *err;
7558 } LDKCResult_FundingCreatedDecodeErrorZPtr;
7561 * A CResult_FundingCreatedDecodeErrorZ represents the result of a fallible operation,
7562 * containing a crate::lightning::ln::msgs::FundingCreated on success and a crate::lightning::ln::msgs::DecodeError on failure.
7563 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7565 typedef struct LDKCResult_FundingCreatedDecodeErrorZ {
7567 * The contents of this CResult_FundingCreatedDecodeErrorZ, accessible via either
7568 * `err` or `result` depending on the state of `result_ok`.
7570 union LDKCResult_FundingCreatedDecodeErrorZPtr contents;
7572 * Whether this CResult_FundingCreatedDecodeErrorZ represents a success state.
7575 } LDKCResult_FundingCreatedDecodeErrorZ;
7578 * The contents of CResult_FundingSignedDecodeErrorZ
7580 typedef union LDKCResult_FundingSignedDecodeErrorZPtr {
7582 * A pointer to the contents in the success state.
7583 * Reading from this pointer when `result_ok` is not set is undefined.
7585 struct LDKFundingSigned *result;
7587 * A pointer to the contents in the error state.
7588 * Reading from this pointer when `result_ok` is set is undefined.
7590 struct LDKDecodeError *err;
7591 } LDKCResult_FundingSignedDecodeErrorZPtr;
7594 * A CResult_FundingSignedDecodeErrorZ represents the result of a fallible operation,
7595 * containing a crate::lightning::ln::msgs::FundingSigned on success and a crate::lightning::ln::msgs::DecodeError on failure.
7596 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7598 typedef struct LDKCResult_FundingSignedDecodeErrorZ {
7600 * The contents of this CResult_FundingSignedDecodeErrorZ, accessible via either
7601 * `err` or `result` depending on the state of `result_ok`.
7603 union LDKCResult_FundingSignedDecodeErrorZPtr contents;
7605 * Whether this CResult_FundingSignedDecodeErrorZ represents a success state.
7608 } LDKCResult_FundingSignedDecodeErrorZ;
7611 * The contents of CResult_FundingLockedDecodeErrorZ
7613 typedef union LDKCResult_FundingLockedDecodeErrorZPtr {
7615 * A pointer to the contents in the success state.
7616 * Reading from this pointer when `result_ok` is not set is undefined.
7618 struct LDKFundingLocked *result;
7620 * A pointer to the contents in the error state.
7621 * Reading from this pointer when `result_ok` is set is undefined.
7623 struct LDKDecodeError *err;
7624 } LDKCResult_FundingLockedDecodeErrorZPtr;
7627 * A CResult_FundingLockedDecodeErrorZ represents the result of a fallible operation,
7628 * containing a crate::lightning::ln::msgs::FundingLocked on success and a crate::lightning::ln::msgs::DecodeError on failure.
7629 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7631 typedef struct LDKCResult_FundingLockedDecodeErrorZ {
7633 * The contents of this CResult_FundingLockedDecodeErrorZ, accessible via either
7634 * `err` or `result` depending on the state of `result_ok`.
7636 union LDKCResult_FundingLockedDecodeErrorZPtr contents;
7638 * Whether this CResult_FundingLockedDecodeErrorZ represents a success state.
7641 } LDKCResult_FundingLockedDecodeErrorZ;
7646 * An init message to be sent or received from a peer
7648 typedef struct MUST_USE_STRUCT LDKInit {
7650 * A pointer to the opaque Rust object.
7651 * Nearly everywhere, inner must be non-null, however in places where
7652 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7654 LDKnativeInit *inner;
7656 * Indicates that this is the only struct which contains the same pointer.
7657 * Rust functions which take ownership of an object provided via an argument require
7658 * this to be true and invalidate the object pointed to by inner.
7664 * The contents of CResult_InitDecodeErrorZ
7666 typedef union LDKCResult_InitDecodeErrorZPtr {
7668 * A pointer to the contents in the success state.
7669 * Reading from this pointer when `result_ok` is not set is undefined.
7671 struct LDKInit *result;
7673 * A pointer to the contents in the error state.
7674 * Reading from this pointer when `result_ok` is set is undefined.
7676 struct LDKDecodeError *err;
7677 } LDKCResult_InitDecodeErrorZPtr;
7680 * A CResult_InitDecodeErrorZ represents the result of a fallible operation,
7681 * containing a crate::lightning::ln::msgs::Init on success and a crate::lightning::ln::msgs::DecodeError on failure.
7682 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7684 typedef struct LDKCResult_InitDecodeErrorZ {
7686 * The contents of this CResult_InitDecodeErrorZ, accessible via either
7687 * `err` or `result` depending on the state of `result_ok`.
7689 union LDKCResult_InitDecodeErrorZPtr contents;
7691 * Whether this CResult_InitDecodeErrorZ represents a success state.
7694 } LDKCResult_InitDecodeErrorZ;
7697 * The contents of CResult_OpenChannelDecodeErrorZ
7699 typedef union LDKCResult_OpenChannelDecodeErrorZPtr {
7701 * A pointer to the contents in the success state.
7702 * Reading from this pointer when `result_ok` is not set is undefined.
7704 struct LDKOpenChannel *result;
7706 * A pointer to the contents in the error state.
7707 * Reading from this pointer when `result_ok` is set is undefined.
7709 struct LDKDecodeError *err;
7710 } LDKCResult_OpenChannelDecodeErrorZPtr;
7713 * A CResult_OpenChannelDecodeErrorZ represents the result of a fallible operation,
7714 * containing a crate::lightning::ln::msgs::OpenChannel on success and a crate::lightning::ln::msgs::DecodeError on failure.
7715 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7717 typedef struct LDKCResult_OpenChannelDecodeErrorZ {
7719 * The contents of this CResult_OpenChannelDecodeErrorZ, accessible via either
7720 * `err` or `result` depending on the state of `result_ok`.
7722 union LDKCResult_OpenChannelDecodeErrorZPtr contents;
7724 * Whether this CResult_OpenChannelDecodeErrorZ represents a success state.
7727 } LDKCResult_OpenChannelDecodeErrorZ;
7730 * The contents of CResult_RevokeAndACKDecodeErrorZ
7732 typedef union LDKCResult_RevokeAndACKDecodeErrorZPtr {
7734 * A pointer to the contents in the success state.
7735 * Reading from this pointer when `result_ok` is not set is undefined.
7737 struct LDKRevokeAndACK *result;
7739 * A pointer to the contents in the error state.
7740 * Reading from this pointer when `result_ok` is set is undefined.
7742 struct LDKDecodeError *err;
7743 } LDKCResult_RevokeAndACKDecodeErrorZPtr;
7746 * A CResult_RevokeAndACKDecodeErrorZ represents the result of a fallible operation,
7747 * containing a crate::lightning::ln::msgs::RevokeAndACK on success and a crate::lightning::ln::msgs::DecodeError on failure.
7748 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7750 typedef struct LDKCResult_RevokeAndACKDecodeErrorZ {
7752 * The contents of this CResult_RevokeAndACKDecodeErrorZ, accessible via either
7753 * `err` or `result` depending on the state of `result_ok`.
7755 union LDKCResult_RevokeAndACKDecodeErrorZPtr contents;
7757 * Whether this CResult_RevokeAndACKDecodeErrorZ represents a success state.
7760 } LDKCResult_RevokeAndACKDecodeErrorZ;
7763 * The contents of CResult_ShutdownDecodeErrorZ
7765 typedef union LDKCResult_ShutdownDecodeErrorZPtr {
7767 * A pointer to the contents in the success state.
7768 * Reading from this pointer when `result_ok` is not set is undefined.
7770 struct LDKShutdown *result;
7772 * A pointer to the contents in the error state.
7773 * Reading from this pointer when `result_ok` is set is undefined.
7775 struct LDKDecodeError *err;
7776 } LDKCResult_ShutdownDecodeErrorZPtr;
7779 * A CResult_ShutdownDecodeErrorZ represents the result of a fallible operation,
7780 * containing a crate::lightning::ln::msgs::Shutdown on success and a crate::lightning::ln::msgs::DecodeError on failure.
7781 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7783 typedef struct LDKCResult_ShutdownDecodeErrorZ {
7785 * The contents of this CResult_ShutdownDecodeErrorZ, accessible via either
7786 * `err` or `result` depending on the state of `result_ok`.
7788 union LDKCResult_ShutdownDecodeErrorZPtr contents;
7790 * Whether this CResult_ShutdownDecodeErrorZ represents a success state.
7793 } LDKCResult_ShutdownDecodeErrorZ;
7796 * The contents of CResult_UpdateFailHTLCDecodeErrorZ
7798 typedef union LDKCResult_UpdateFailHTLCDecodeErrorZPtr {
7800 * A pointer to the contents in the success state.
7801 * Reading from this pointer when `result_ok` is not set is undefined.
7803 struct LDKUpdateFailHTLC *result;
7805 * A pointer to the contents in the error state.
7806 * Reading from this pointer when `result_ok` is set is undefined.
7808 struct LDKDecodeError *err;
7809 } LDKCResult_UpdateFailHTLCDecodeErrorZPtr;
7812 * A CResult_UpdateFailHTLCDecodeErrorZ represents the result of a fallible operation,
7813 * containing a crate::lightning::ln::msgs::UpdateFailHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
7814 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7816 typedef struct LDKCResult_UpdateFailHTLCDecodeErrorZ {
7818 * The contents of this CResult_UpdateFailHTLCDecodeErrorZ, accessible via either
7819 * `err` or `result` depending on the state of `result_ok`.
7821 union LDKCResult_UpdateFailHTLCDecodeErrorZPtr contents;
7823 * Whether this CResult_UpdateFailHTLCDecodeErrorZ represents a success state.
7826 } LDKCResult_UpdateFailHTLCDecodeErrorZ;
7829 * The contents of CResult_UpdateFailMalformedHTLCDecodeErrorZ
7831 typedef union LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr {
7833 * A pointer to the contents in the success state.
7834 * Reading from this pointer when `result_ok` is not set is undefined.
7836 struct LDKUpdateFailMalformedHTLC *result;
7838 * A pointer to the contents in the error state.
7839 * Reading from this pointer when `result_ok` is set is undefined.
7841 struct LDKDecodeError *err;
7842 } LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr;
7845 * A CResult_UpdateFailMalformedHTLCDecodeErrorZ represents the result of a fallible operation,
7846 * containing a crate::lightning::ln::msgs::UpdateFailMalformedHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
7847 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7849 typedef struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ {
7851 * The contents of this CResult_UpdateFailMalformedHTLCDecodeErrorZ, accessible via either
7852 * `err` or `result` depending on the state of `result_ok`.
7854 union LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr contents;
7856 * Whether this CResult_UpdateFailMalformedHTLCDecodeErrorZ represents a success state.
7859 } LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ;
7864 * An update_fee message to be sent or received from a peer
7866 typedef struct MUST_USE_STRUCT LDKUpdateFee {
7868 * A pointer to the opaque Rust object.
7869 * Nearly everywhere, inner must be non-null, however in places where
7870 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7872 LDKnativeUpdateFee *inner;
7874 * Indicates that this is the only struct which contains the same pointer.
7875 * Rust functions which take ownership of an object provided via an argument require
7876 * this to be true and invalidate the object pointed to by inner.
7882 * The contents of CResult_UpdateFeeDecodeErrorZ
7884 typedef union LDKCResult_UpdateFeeDecodeErrorZPtr {
7886 * A pointer to the contents in the success state.
7887 * Reading from this pointer when `result_ok` is not set is undefined.
7889 struct LDKUpdateFee *result;
7891 * A pointer to the contents in the error state.
7892 * Reading from this pointer when `result_ok` is set is undefined.
7894 struct LDKDecodeError *err;
7895 } LDKCResult_UpdateFeeDecodeErrorZPtr;
7898 * A CResult_UpdateFeeDecodeErrorZ represents the result of a fallible operation,
7899 * containing a crate::lightning::ln::msgs::UpdateFee on success and a crate::lightning::ln::msgs::DecodeError on failure.
7900 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7902 typedef struct LDKCResult_UpdateFeeDecodeErrorZ {
7904 * The contents of this CResult_UpdateFeeDecodeErrorZ, accessible via either
7905 * `err` or `result` depending on the state of `result_ok`.
7907 union LDKCResult_UpdateFeeDecodeErrorZPtr contents;
7909 * Whether this CResult_UpdateFeeDecodeErrorZ represents a success state.
7912 } LDKCResult_UpdateFeeDecodeErrorZ;
7915 * The contents of CResult_UpdateFulfillHTLCDecodeErrorZ
7917 typedef union LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr {
7919 * A pointer to the contents in the success state.
7920 * Reading from this pointer when `result_ok` is not set is undefined.
7922 struct LDKUpdateFulfillHTLC *result;
7924 * A pointer to the contents in the error state.
7925 * Reading from this pointer when `result_ok` is set is undefined.
7927 struct LDKDecodeError *err;
7928 } LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr;
7931 * A CResult_UpdateFulfillHTLCDecodeErrorZ represents the result of a fallible operation,
7932 * containing a crate::lightning::ln::msgs::UpdateFulfillHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
7933 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7935 typedef struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ {
7937 * The contents of this CResult_UpdateFulfillHTLCDecodeErrorZ, accessible via either
7938 * `err` or `result` depending on the state of `result_ok`.
7940 union LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr contents;
7942 * Whether this CResult_UpdateFulfillHTLCDecodeErrorZ represents a success state.
7945 } LDKCResult_UpdateFulfillHTLCDecodeErrorZ;
7948 * The contents of CResult_UpdateAddHTLCDecodeErrorZ
7950 typedef union LDKCResult_UpdateAddHTLCDecodeErrorZPtr {
7952 * A pointer to the contents in the success state.
7953 * Reading from this pointer when `result_ok` is not set is undefined.
7955 struct LDKUpdateAddHTLC *result;
7957 * A pointer to the contents in the error state.
7958 * Reading from this pointer when `result_ok` is set is undefined.
7960 struct LDKDecodeError *err;
7961 } LDKCResult_UpdateAddHTLCDecodeErrorZPtr;
7964 * A CResult_UpdateAddHTLCDecodeErrorZ represents the result of a fallible operation,
7965 * containing a crate::lightning::ln::msgs::UpdateAddHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
7966 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7968 typedef struct LDKCResult_UpdateAddHTLCDecodeErrorZ {
7970 * The contents of this CResult_UpdateAddHTLCDecodeErrorZ, accessible via either
7971 * `err` or `result` depending on the state of `result_ok`.
7973 union LDKCResult_UpdateAddHTLCDecodeErrorZPtr contents;
7975 * Whether this CResult_UpdateAddHTLCDecodeErrorZ represents a success state.
7978 } LDKCResult_UpdateAddHTLCDecodeErrorZ;
7983 * A ping message to be sent or received from a peer
7985 typedef struct MUST_USE_STRUCT LDKPing {
7987 * A pointer to the opaque Rust object.
7988 * Nearly everywhere, inner must be non-null, however in places where
7989 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7991 LDKnativePing *inner;
7993 * Indicates that this is the only struct which contains the same pointer.
7994 * Rust functions which take ownership of an object provided via an argument require
7995 * this to be true and invalidate the object pointed to by inner.
8001 * The contents of CResult_PingDecodeErrorZ
8003 typedef union LDKCResult_PingDecodeErrorZPtr {
8005 * A pointer to the contents in the success state.
8006 * Reading from this pointer when `result_ok` is not set is undefined.
8008 struct LDKPing *result;
8010 * A pointer to the contents in the error state.
8011 * Reading from this pointer when `result_ok` is set is undefined.
8013 struct LDKDecodeError *err;
8014 } LDKCResult_PingDecodeErrorZPtr;
8017 * A CResult_PingDecodeErrorZ represents the result of a fallible operation,
8018 * containing a crate::lightning::ln::msgs::Ping on success and a crate::lightning::ln::msgs::DecodeError on failure.
8019 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8021 typedef struct LDKCResult_PingDecodeErrorZ {
8023 * The contents of this CResult_PingDecodeErrorZ, accessible via either
8024 * `err` or `result` depending on the state of `result_ok`.
8026 union LDKCResult_PingDecodeErrorZPtr contents;
8028 * Whether this CResult_PingDecodeErrorZ represents a success state.
8031 } LDKCResult_PingDecodeErrorZ;
8036 * A pong message to be sent or received from a peer
8038 typedef struct MUST_USE_STRUCT LDKPong {
8040 * A pointer to the opaque Rust object.
8041 * Nearly everywhere, inner must be non-null, however in places where
8042 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8044 LDKnativePong *inner;
8046 * Indicates that this is the only struct which contains the same pointer.
8047 * Rust functions which take ownership of an object provided via an argument require
8048 * this to be true and invalidate the object pointed to by inner.
8054 * The contents of CResult_PongDecodeErrorZ
8056 typedef union LDKCResult_PongDecodeErrorZPtr {
8058 * A pointer to the contents in the success state.
8059 * Reading from this pointer when `result_ok` is not set is undefined.
8061 struct LDKPong *result;
8063 * A pointer to the contents in the error state.
8064 * Reading from this pointer when `result_ok` is set is undefined.
8066 struct LDKDecodeError *err;
8067 } LDKCResult_PongDecodeErrorZPtr;
8070 * A CResult_PongDecodeErrorZ represents the result of a fallible operation,
8071 * containing a crate::lightning::ln::msgs::Pong on success and a crate::lightning::ln::msgs::DecodeError on failure.
8072 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8074 typedef struct LDKCResult_PongDecodeErrorZ {
8076 * The contents of this CResult_PongDecodeErrorZ, accessible via either
8077 * `err` or `result` depending on the state of `result_ok`.
8079 union LDKCResult_PongDecodeErrorZPtr contents;
8081 * Whether this CResult_PongDecodeErrorZ represents a success state.
8084 } LDKCResult_PongDecodeErrorZ;
8087 * The contents of CResult_UnsignedChannelAnnouncementDecodeErrorZ
8089 typedef union LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr {
8091 * A pointer to the contents in the success state.
8092 * Reading from this pointer when `result_ok` is not set is undefined.
8094 struct LDKUnsignedChannelAnnouncement *result;
8096 * A pointer to the contents in the error state.
8097 * Reading from this pointer when `result_ok` is set is undefined.
8099 struct LDKDecodeError *err;
8100 } LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr;
8103 * A CResult_UnsignedChannelAnnouncementDecodeErrorZ represents the result of a fallible operation,
8104 * containing a crate::lightning::ln::msgs::UnsignedChannelAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
8105 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8107 typedef struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ {
8109 * The contents of this CResult_UnsignedChannelAnnouncementDecodeErrorZ, accessible via either
8110 * `err` or `result` depending on the state of `result_ok`.
8112 union LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr contents;
8114 * Whether this CResult_UnsignedChannelAnnouncementDecodeErrorZ represents a success state.
8117 } LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ;
8120 * The contents of CResult_ChannelAnnouncementDecodeErrorZ
8122 typedef union LDKCResult_ChannelAnnouncementDecodeErrorZPtr {
8124 * A pointer to the contents in the success state.
8125 * Reading from this pointer when `result_ok` is not set is undefined.
8127 struct LDKChannelAnnouncement *result;
8129 * A pointer to the contents in the error state.
8130 * Reading from this pointer when `result_ok` is set is undefined.
8132 struct LDKDecodeError *err;
8133 } LDKCResult_ChannelAnnouncementDecodeErrorZPtr;
8136 * A CResult_ChannelAnnouncementDecodeErrorZ represents the result of a fallible operation,
8137 * containing a crate::lightning::ln::msgs::ChannelAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
8138 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8140 typedef struct LDKCResult_ChannelAnnouncementDecodeErrorZ {
8142 * The contents of this CResult_ChannelAnnouncementDecodeErrorZ, accessible via either
8143 * `err` or `result` depending on the state of `result_ok`.
8145 union LDKCResult_ChannelAnnouncementDecodeErrorZPtr contents;
8147 * Whether this CResult_ChannelAnnouncementDecodeErrorZ represents a success state.
8150 } LDKCResult_ChannelAnnouncementDecodeErrorZ;
8155 * The unsigned part of a channel_update
8157 typedef struct MUST_USE_STRUCT LDKUnsignedChannelUpdate {
8159 * A pointer to the opaque Rust object.
8160 * Nearly everywhere, inner must be non-null, however in places where
8161 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8163 LDKnativeUnsignedChannelUpdate *inner;
8165 * Indicates that this is the only struct which contains the same pointer.
8166 * Rust functions which take ownership of an object provided via an argument require
8167 * this to be true and invalidate the object pointed to by inner.
8170 } LDKUnsignedChannelUpdate;
8173 * The contents of CResult_UnsignedChannelUpdateDecodeErrorZ
8175 typedef union LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr {
8177 * A pointer to the contents in the success state.
8178 * Reading from this pointer when `result_ok` is not set is undefined.
8180 struct LDKUnsignedChannelUpdate *result;
8182 * A pointer to the contents in the error state.
8183 * Reading from this pointer when `result_ok` is set is undefined.
8185 struct LDKDecodeError *err;
8186 } LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr;
8189 * A CResult_UnsignedChannelUpdateDecodeErrorZ represents the result of a fallible operation,
8190 * containing a crate::lightning::ln::msgs::UnsignedChannelUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
8191 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8193 typedef struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ {
8195 * The contents of this CResult_UnsignedChannelUpdateDecodeErrorZ, accessible via either
8196 * `err` or `result` depending on the state of `result_ok`.
8198 union LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr contents;
8200 * Whether this CResult_UnsignedChannelUpdateDecodeErrorZ represents a success state.
8203 } LDKCResult_UnsignedChannelUpdateDecodeErrorZ;
8206 * The contents of CResult_ChannelUpdateDecodeErrorZ
8208 typedef union LDKCResult_ChannelUpdateDecodeErrorZPtr {
8210 * A pointer to the contents in the success state.
8211 * Reading from this pointer when `result_ok` is not set is undefined.
8213 struct LDKChannelUpdate *result;
8215 * A pointer to the contents in the error state.
8216 * Reading from this pointer when `result_ok` is set is undefined.
8218 struct LDKDecodeError *err;
8219 } LDKCResult_ChannelUpdateDecodeErrorZPtr;
8222 * A CResult_ChannelUpdateDecodeErrorZ represents the result of a fallible operation,
8223 * containing a crate::lightning::ln::msgs::ChannelUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
8224 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8226 typedef struct LDKCResult_ChannelUpdateDecodeErrorZ {
8228 * The contents of this CResult_ChannelUpdateDecodeErrorZ, accessible via either
8229 * `err` or `result` depending on the state of `result_ok`.
8231 union LDKCResult_ChannelUpdateDecodeErrorZPtr contents;
8233 * Whether this CResult_ChannelUpdateDecodeErrorZ represents a success state.
8236 } LDKCResult_ChannelUpdateDecodeErrorZ;
8239 * The contents of CResult_ErrorMessageDecodeErrorZ
8241 typedef union LDKCResult_ErrorMessageDecodeErrorZPtr {
8243 * A pointer to the contents in the success state.
8244 * Reading from this pointer when `result_ok` is not set is undefined.
8246 struct LDKErrorMessage *result;
8248 * A pointer to the contents in the error state.
8249 * Reading from this pointer when `result_ok` is set is undefined.
8251 struct LDKDecodeError *err;
8252 } LDKCResult_ErrorMessageDecodeErrorZPtr;
8255 * A CResult_ErrorMessageDecodeErrorZ represents the result of a fallible operation,
8256 * containing a crate::lightning::ln::msgs::ErrorMessage on success and a crate::lightning::ln::msgs::DecodeError on failure.
8257 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8259 typedef struct LDKCResult_ErrorMessageDecodeErrorZ {
8261 * The contents of this CResult_ErrorMessageDecodeErrorZ, accessible via either
8262 * `err` or `result` depending on the state of `result_ok`.
8264 union LDKCResult_ErrorMessageDecodeErrorZPtr contents;
8266 * Whether this CResult_ErrorMessageDecodeErrorZ represents a success state.
8269 } LDKCResult_ErrorMessageDecodeErrorZ;
8274 * The unsigned part of a node_announcement
8276 typedef struct MUST_USE_STRUCT LDKUnsignedNodeAnnouncement {
8278 * A pointer to the opaque Rust object.
8279 * Nearly everywhere, inner must be non-null, however in places where
8280 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8282 LDKnativeUnsignedNodeAnnouncement *inner;
8284 * Indicates that this is the only struct which contains the same pointer.
8285 * Rust functions which take ownership of an object provided via an argument require
8286 * this to be true and invalidate the object pointed to by inner.
8289 } LDKUnsignedNodeAnnouncement;
8292 * The contents of CResult_UnsignedNodeAnnouncementDecodeErrorZ
8294 typedef union LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr {
8296 * A pointer to the contents in the success state.
8297 * Reading from this pointer when `result_ok` is not set is undefined.
8299 struct LDKUnsignedNodeAnnouncement *result;
8301 * A pointer to the contents in the error state.
8302 * Reading from this pointer when `result_ok` is set is undefined.
8304 struct LDKDecodeError *err;
8305 } LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr;
8308 * A CResult_UnsignedNodeAnnouncementDecodeErrorZ represents the result of a fallible operation,
8309 * containing a crate::lightning::ln::msgs::UnsignedNodeAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
8310 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8312 typedef struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ {
8314 * The contents of this CResult_UnsignedNodeAnnouncementDecodeErrorZ, accessible via either
8315 * `err` or `result` depending on the state of `result_ok`.
8317 union LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr contents;
8319 * Whether this CResult_UnsignedNodeAnnouncementDecodeErrorZ represents a success state.
8322 } LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ;
8325 * The contents of CResult_NodeAnnouncementDecodeErrorZ
8327 typedef union LDKCResult_NodeAnnouncementDecodeErrorZPtr {
8329 * A pointer to the contents in the success state.
8330 * Reading from this pointer when `result_ok` is not set is undefined.
8332 struct LDKNodeAnnouncement *result;
8334 * A pointer to the contents in the error state.
8335 * Reading from this pointer when `result_ok` is set is undefined.
8337 struct LDKDecodeError *err;
8338 } LDKCResult_NodeAnnouncementDecodeErrorZPtr;
8341 * A CResult_NodeAnnouncementDecodeErrorZ represents the result of a fallible operation,
8342 * containing a crate::lightning::ln::msgs::NodeAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
8343 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8345 typedef struct LDKCResult_NodeAnnouncementDecodeErrorZ {
8347 * The contents of this CResult_NodeAnnouncementDecodeErrorZ, accessible via either
8348 * `err` or `result` depending on the state of `result_ok`.
8350 union LDKCResult_NodeAnnouncementDecodeErrorZPtr contents;
8352 * Whether this CResult_NodeAnnouncementDecodeErrorZ represents a success state.
8355 } LDKCResult_NodeAnnouncementDecodeErrorZ;
8358 * The contents of CResult_QueryShortChannelIdsDecodeErrorZ
8360 typedef union LDKCResult_QueryShortChannelIdsDecodeErrorZPtr {
8362 * A pointer to the contents in the success state.
8363 * Reading from this pointer when `result_ok` is not set is undefined.
8365 struct LDKQueryShortChannelIds *result;
8367 * A pointer to the contents in the error state.
8368 * Reading from this pointer when `result_ok` is set is undefined.
8370 struct LDKDecodeError *err;
8371 } LDKCResult_QueryShortChannelIdsDecodeErrorZPtr;
8374 * A CResult_QueryShortChannelIdsDecodeErrorZ represents the result of a fallible operation,
8375 * containing a crate::lightning::ln::msgs::QueryShortChannelIds on success and a crate::lightning::ln::msgs::DecodeError on failure.
8376 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8378 typedef struct LDKCResult_QueryShortChannelIdsDecodeErrorZ {
8380 * The contents of this CResult_QueryShortChannelIdsDecodeErrorZ, accessible via either
8381 * `err` or `result` depending on the state of `result_ok`.
8383 union LDKCResult_QueryShortChannelIdsDecodeErrorZPtr contents;
8385 * Whether this CResult_QueryShortChannelIdsDecodeErrorZ represents a success state.
8388 } LDKCResult_QueryShortChannelIdsDecodeErrorZ;
8393 * A reply_short_channel_ids_end message is sent as a reply to a
8394 * query_short_channel_ids message. The query recipient makes a best
8395 * effort to respond based on their local network view which may not be
8396 * a perfect view of the network.
8398 typedef struct MUST_USE_STRUCT LDKReplyShortChannelIdsEnd {
8400 * A pointer to the opaque Rust object.
8401 * Nearly everywhere, inner must be non-null, however in places where
8402 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8404 LDKnativeReplyShortChannelIdsEnd *inner;
8406 * Indicates that this is the only struct which contains the same pointer.
8407 * Rust functions which take ownership of an object provided via an argument require
8408 * this to be true and invalidate the object pointed to by inner.
8411 } LDKReplyShortChannelIdsEnd;
8414 * The contents of CResult_ReplyShortChannelIdsEndDecodeErrorZ
8416 typedef union LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr {
8418 * A pointer to the contents in the success state.
8419 * Reading from this pointer when `result_ok` is not set is undefined.
8421 struct LDKReplyShortChannelIdsEnd *result;
8423 * A pointer to the contents in the error state.
8424 * Reading from this pointer when `result_ok` is set is undefined.
8426 struct LDKDecodeError *err;
8427 } LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr;
8430 * A CResult_ReplyShortChannelIdsEndDecodeErrorZ represents the result of a fallible operation,
8431 * containing a crate::lightning::ln::msgs::ReplyShortChannelIdsEnd on success and a crate::lightning::ln::msgs::DecodeError on failure.
8432 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8434 typedef struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ {
8436 * The contents of this CResult_ReplyShortChannelIdsEndDecodeErrorZ, accessible via either
8437 * `err` or `result` depending on the state of `result_ok`.
8439 union LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr contents;
8441 * Whether this CResult_ReplyShortChannelIdsEndDecodeErrorZ represents a success state.
8444 } LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ;
8447 * The contents of CResult_QueryChannelRangeDecodeErrorZ
8449 typedef union LDKCResult_QueryChannelRangeDecodeErrorZPtr {
8451 * A pointer to the contents in the success state.
8452 * Reading from this pointer when `result_ok` is not set is undefined.
8454 struct LDKQueryChannelRange *result;
8456 * A pointer to the contents in the error state.
8457 * Reading from this pointer when `result_ok` is set is undefined.
8459 struct LDKDecodeError *err;
8460 } LDKCResult_QueryChannelRangeDecodeErrorZPtr;
8463 * A CResult_QueryChannelRangeDecodeErrorZ represents the result of a fallible operation,
8464 * containing a crate::lightning::ln::msgs::QueryChannelRange on success and a crate::lightning::ln::msgs::DecodeError on failure.
8465 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8467 typedef struct LDKCResult_QueryChannelRangeDecodeErrorZ {
8469 * The contents of this CResult_QueryChannelRangeDecodeErrorZ, accessible via either
8470 * `err` or `result` depending on the state of `result_ok`.
8472 union LDKCResult_QueryChannelRangeDecodeErrorZPtr contents;
8474 * Whether this CResult_QueryChannelRangeDecodeErrorZ represents a success state.
8477 } LDKCResult_QueryChannelRangeDecodeErrorZ;
8480 * The contents of CResult_ReplyChannelRangeDecodeErrorZ
8482 typedef union LDKCResult_ReplyChannelRangeDecodeErrorZPtr {
8484 * A pointer to the contents in the success state.
8485 * Reading from this pointer when `result_ok` is not set is undefined.
8487 struct LDKReplyChannelRange *result;
8489 * A pointer to the contents in the error state.
8490 * Reading from this pointer when `result_ok` is set is undefined.
8492 struct LDKDecodeError *err;
8493 } LDKCResult_ReplyChannelRangeDecodeErrorZPtr;
8496 * A CResult_ReplyChannelRangeDecodeErrorZ represents the result of a fallible operation,
8497 * containing a crate::lightning::ln::msgs::ReplyChannelRange on success and a crate::lightning::ln::msgs::DecodeError on failure.
8498 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8500 typedef struct LDKCResult_ReplyChannelRangeDecodeErrorZ {
8502 * The contents of this CResult_ReplyChannelRangeDecodeErrorZ, accessible via either
8503 * `err` or `result` depending on the state of `result_ok`.
8505 union LDKCResult_ReplyChannelRangeDecodeErrorZPtr contents;
8507 * Whether this CResult_ReplyChannelRangeDecodeErrorZ represents a success state.
8510 } LDKCResult_ReplyChannelRangeDecodeErrorZ;
8515 * A gossip_timestamp_filter message is used by a node to request
8516 * gossip relay for messages in the requested time range when the
8517 * gossip_queries feature has been negotiated.
8519 typedef struct MUST_USE_STRUCT LDKGossipTimestampFilter {
8521 * A pointer to the opaque Rust object.
8522 * Nearly everywhere, inner must be non-null, however in places where
8523 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8525 LDKnativeGossipTimestampFilter *inner;
8527 * Indicates that this is the only struct which contains the same pointer.
8528 * Rust functions which take ownership of an object provided via an argument require
8529 * this to be true and invalidate the object pointed to by inner.
8532 } LDKGossipTimestampFilter;
8535 * The contents of CResult_GossipTimestampFilterDecodeErrorZ
8537 typedef union LDKCResult_GossipTimestampFilterDecodeErrorZPtr {
8539 * A pointer to the contents in the success state.
8540 * Reading from this pointer when `result_ok` is not set is undefined.
8542 struct LDKGossipTimestampFilter *result;
8544 * A pointer to the contents in the error state.
8545 * Reading from this pointer when `result_ok` is set is undefined.
8547 struct LDKDecodeError *err;
8548 } LDKCResult_GossipTimestampFilterDecodeErrorZPtr;
8551 * A CResult_GossipTimestampFilterDecodeErrorZ represents the result of a fallible operation,
8552 * containing a crate::lightning::ln::msgs::GossipTimestampFilter on success and a crate::lightning::ln::msgs::DecodeError on failure.
8553 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8555 typedef struct LDKCResult_GossipTimestampFilterDecodeErrorZ {
8557 * The contents of this CResult_GossipTimestampFilterDecodeErrorZ, accessible via either
8558 * `err` or `result` depending on the state of `result_ok`.
8560 union LDKCResult_GossipTimestampFilterDecodeErrorZPtr contents;
8562 * Whether this CResult_GossipTimestampFilterDecodeErrorZ represents a success state.
8565 } LDKCResult_GossipTimestampFilterDecodeErrorZ;
8568 * When signing using a fallible method either an user-supplied `SignError` or a `CreationError`
8571 typedef enum LDKSignOrCreationError_Tag {
8573 * An error occurred during signing
8575 LDKSignOrCreationError_SignError,
8577 * An error occurred while building the transaction
8579 LDKSignOrCreationError_CreationError,
8581 * Must be last for serialization purposes
8583 LDKSignOrCreationError_Sentinel,
8584 } LDKSignOrCreationError_Tag;
8586 typedef struct MUST_USE_STRUCT LDKSignOrCreationError {
8587 LDKSignOrCreationError_Tag tag;
8590 enum LDKCreationError creation_error;
8593 } LDKSignOrCreationError;
8596 * The contents of CResult_InvoiceSignOrCreationErrorZ
8598 typedef union LDKCResult_InvoiceSignOrCreationErrorZPtr {
8600 * A pointer to the contents in the success state.
8601 * Reading from this pointer when `result_ok` is not set is undefined.
8603 struct LDKInvoice *result;
8605 * A pointer to the contents in the error state.
8606 * Reading from this pointer when `result_ok` is set is undefined.
8608 struct LDKSignOrCreationError *err;
8609 } LDKCResult_InvoiceSignOrCreationErrorZPtr;
8612 * A CResult_InvoiceSignOrCreationErrorZ represents the result of a fallible operation,
8613 * containing a crate::lightning_invoice::Invoice on success and a crate::lightning_invoice::SignOrCreationError on failure.
8614 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8616 typedef struct LDKCResult_InvoiceSignOrCreationErrorZ {
8618 * The contents of this CResult_InvoiceSignOrCreationErrorZ, accessible via either
8619 * `err` or `result` depending on the state of `result_ok`.
8621 union LDKCResult_InvoiceSignOrCreationErrorZPtr contents;
8623 * Whether this CResult_InvoiceSignOrCreationErrorZ represents a success state.
8626 } LDKCResult_InvoiceSignOrCreationErrorZ;
8631 * A transaction output watched by a [`ChannelMonitor`] for spends on-chain.
8633 * Used to convey to a [`Filter`] such an output with a given spending condition. Any transaction
8634 * spending the output must be given to [`ChannelMonitor::block_connected`] either directly or via
8635 * the return value of [`Filter::register_output`].
8637 * If `block_hash` is `Some`, this indicates the output was created in the corresponding block and
8638 * may have been spent there. See [`Filter::register_output`] for details.
8640 * [`ChannelMonitor`]: channelmonitor::ChannelMonitor
8641 * [`ChannelMonitor::block_connected`]: channelmonitor::ChannelMonitor::block_connected
8643 typedef struct MUST_USE_STRUCT LDKWatchedOutput {
8645 * A pointer to the opaque Rust object.
8646 * Nearly everywhere, inner must be non-null, however in places where
8647 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8649 LDKnativeWatchedOutput *inner;
8651 * Indicates that this is the only struct which contains the same pointer.
8652 * Rust functions which take ownership of an object provided via an argument require
8653 * this to be true and invalidate the object pointed to by inner.
8659 * The `Filter` trait defines behavior for indicating chain activity of interest pertaining to
8662 * This is useful in order to have a [`Watch`] implementation convey to a chain source which
8663 * transactions to be notified of. Notification may take the form of pre-filtering blocks or, in
8664 * the case of [BIP 157]/[BIP 158], only fetching a block if the compact filter matches. If
8665 * receiving full blocks from a chain source, any further filtering is unnecessary.
8667 * After an output has been registered, subsequent block retrievals from the chain source must not
8668 * exclude any transactions matching the new criteria nor any in-block descendants of such
8671 * Note that use as part of a [`Watch`] implementation involves reentrancy. Therefore, the `Filter`
8672 * should not block on I/O. Implementations should instead queue the newly monitored data to be
8673 * processed later. Then, in order to block until the data has been processed, any [`Watch`]
8674 * invocation that has called the `Filter` must return [`TemporaryFailure`].
8676 * [`TemporaryFailure`]: channelmonitor::ChannelMonitorUpdateErr::TemporaryFailure
8677 * [BIP 157]: https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki
8678 * [BIP 158]: https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki
8680 typedef struct LDKFilter {
8682 * An opaque pointer which is passed to your function implementations as an argument.
8683 * This has no meaning in the LDK, and can be NULL or any other value.
8687 * Registers interest in a transaction with `txid` and having an output with `script_pubkey` as
8688 * a spending condition.
8690 void (*register_tx)(const void *this_arg, const uint8_t (*txid)[32], struct LDKu8slice script_pubkey);
8692 * Registers interest in spends of a transaction output.
8694 * Optionally, when `output.block_hash` is set, should return any transaction spending the
8695 * output that is found in the corresponding block along with its index.
8697 * This return value is useful for Electrum clients in order to supply in-block descendant
8698 * transactions which otherwise were not included. This is not necessary for other clients if
8699 * such descendant transactions were already included (e.g., when a BIP 157 client provides the
8702 struct LDKCOption_C2Tuple_usizeTransactionZZ (*register_output)(const void *this_arg, struct LDKWatchedOutput output);
8704 * Frees any resources associated with this object given its this_arg pointer.
8705 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
8707 void (*free)(void *this_arg);
8711 * An enum which can either contain a crate::lightning::chain::Filter or not
8713 typedef enum LDKCOption_FilterZ_Tag {
8715 * When we're in this state, this COption_FilterZ contains a crate::lightning::chain::Filter
8717 LDKCOption_FilterZ_Some,
8719 * When we're in this state, this COption_FilterZ contains nothing
8721 LDKCOption_FilterZ_None,
8723 * Must be last for serialization purposes
8725 LDKCOption_FilterZ_Sentinel,
8726 } LDKCOption_FilterZ_Tag;
8728 typedef struct LDKCOption_FilterZ {
8729 LDKCOption_FilterZ_Tag tag;
8732 struct LDKFilter some;
8735 } LDKCOption_FilterZ;
8738 * A trait indicating an object may generate message send events
8740 typedef struct LDKMessageSendEventsProvider {
8742 * An opaque pointer which is passed to your function implementations as an argument.
8743 * This has no meaning in the LDK, and can be NULL or any other value.
8747 * Gets the list of pending events which were generated by previous actions, clearing the list
8750 struct LDKCVec_MessageSendEventZ (*get_and_clear_pending_msg_events)(const void *this_arg);
8752 * Frees any resources associated with this object given its this_arg pointer.
8753 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
8755 void (*free)(void *this_arg);
8756 } LDKMessageSendEventsProvider;
8759 * A trait implemented for objects handling events from [`EventsProvider`].
8761 typedef struct LDKEventHandler {
8763 * An opaque pointer which is passed to your function implementations as an argument.
8764 * This has no meaning in the LDK, and can be NULL or any other value.
8768 * Handles the given [`Event`].
8770 * See [`EventsProvider`] for details that must be considered when implementing this method.
8772 void (*handle_event)(const void *this_arg, const struct LDKEvent *NONNULL_PTR event);
8774 * Frees any resources associated with this object given its this_arg pointer.
8775 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
8777 void (*free)(void *this_arg);
8781 * A trait indicating an object may generate events.
8783 * Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
8787 * See [`process_pending_events`] for requirements around event processing.
8789 * When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
8790 * event since the last invocation. The handler must either act upon the event immediately
8791 * or preserve it for later handling.
8793 * Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
8794 * consult the provider's documentation on the implication of processing events and how a handler
8795 * may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
8796 * [`ChainMonitor::process_pending_events`]).
8798 * (C-not implementable) As there is likely no reason for a user to implement this trait on their
8801 * [`process_pending_events`]: Self::process_pending_events
8802 * [`handle_event`]: EventHandler::handle_event
8803 * [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
8804 * [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
8806 typedef struct LDKEventsProvider {
8808 * An opaque pointer which is passed to your function implementations as an argument.
8809 * This has no meaning in the LDK, and can be NULL or any other value.
8813 * Processes any events generated since the last call using the given event handler.
8815 * Subsequent calls must only process new events. However, handlers must be capable of handling
8816 * duplicate events across process restarts. This may occur if the provider was recovered from
8817 * an old state (i.e., it hadn't been successfully persisted after processing pending events).
8819 void (*process_pending_events)(const void *this_arg, struct LDKEventHandler handler);
8821 * Frees any resources associated with this object given its this_arg pointer.
8822 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
8824 void (*free)(void *this_arg);
8825 } LDKEventsProvider;
8830 * Configuration we set when applicable.
8832 * Default::default() provides sane defaults.
8834 typedef struct MUST_USE_STRUCT LDKChannelHandshakeConfig {
8836 * A pointer to the opaque Rust object.
8837 * Nearly everywhere, inner must be non-null, however in places where
8838 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8840 LDKnativeChannelHandshakeConfig *inner;
8842 * Indicates that this is the only struct which contains the same pointer.
8843 * Rust functions which take ownership of an object provided via an argument require
8844 * this to be true and invalidate the object pointed to by inner.
8847 } LDKChannelHandshakeConfig;
8852 * Optional channel limits which are applied during channel creation.
8854 * These limits are only applied to our counterparty's limits, not our own.
8856 * Use 0/<type>::max_value() as appropriate to skip checking.
8858 * Provides sane defaults for most configurations.
8860 * Most additional limits are disabled except those with which specify a default in individual
8861 * field documentation. Note that this may result in barely-usable channels, but since they
8862 * are applied mostly only to incoming channels that's not much of a problem.
8864 typedef struct MUST_USE_STRUCT LDKChannelHandshakeLimits {
8866 * A pointer to the opaque Rust object.
8867 * Nearly everywhere, inner must be non-null, however in places where
8868 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8870 LDKnativeChannelHandshakeLimits *inner;
8872 * Indicates that this is the only struct which contains the same pointer.
8873 * Rust functions which take ownership of an object provided via an argument require
8874 * this to be true and invalidate the object pointed to by inner.
8877 } LDKChannelHandshakeLimits;
8882 * Top-level config which holds ChannelHandshakeLimits and ChannelConfig.
8884 * Default::default() provides sane defaults for most configurations
8885 * (but currently with 0 relay fees!)
8887 typedef struct MUST_USE_STRUCT LDKUserConfig {
8889 * A pointer to the opaque Rust object.
8890 * Nearly everywhere, inner must be non-null, however in places where
8891 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8893 LDKnativeUserConfig *inner;
8895 * Indicates that this is the only struct which contains the same pointer.
8896 * Rust functions which take ownership of an object provided via an argument require
8897 * this to be true and invalidate the object pointed to by inner.
8905 * The best known block as identified by its hash and height.
8907 typedef struct MUST_USE_STRUCT LDKBestBlock {
8909 * A pointer to the opaque Rust object.
8910 * Nearly everywhere, inner must be non-null, however in places where
8911 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8913 LDKnativeBestBlock *inner;
8915 * Indicates that this is the only struct which contains the same pointer.
8916 * Rust functions which take ownership of an object provided via an argument require
8917 * this to be true and invalidate the object pointed to by inner.
8923 * The `Listen` trait is used to notify when blocks have been connected or disconnected from the
8926 * Useful when needing to replay chain data upon startup or as new chain events occur. Clients
8927 * sourcing chain data using a block-oriented API should prefer this interface over [`Confirm`].
8928 * Such clients fetch the entire header chain whereas clients using [`Confirm`] only fetch headers
8931 typedef struct LDKListen {
8933 * An opaque pointer which is passed to your function implementations as an argument.
8934 * This has no meaning in the LDK, and can be NULL or any other value.
8938 * Notifies the listener that a block was added at the given height.
8940 void (*block_connected)(const void *this_arg, struct LDKu8slice block, uint32_t height);
8942 * Notifies the listener that a block was removed at the given height.
8944 void (*block_disconnected)(const void *this_arg, const uint8_t (*header)[80], uint32_t height);
8946 * Frees any resources associated with this object given its this_arg pointer.
8947 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
8949 void (*free)(void *this_arg);
8953 * The `Confirm` trait is used to notify when transactions have been confirmed on chain or
8954 * unconfirmed during a chain reorganization.
8956 * Clients sourcing chain data using a transaction-oriented API should prefer this interface over
8957 * [`Listen`]. For instance, an Electrum client may implement [`Filter`] by subscribing to activity
8958 * related to registered transactions and outputs. Upon notification, it would pass along the
8959 * matching transactions using this interface.
8963 * The intended use is as follows:
8964 * - Call [`transactions_confirmed`] to process any on-chain activity of interest.
8965 * - Call [`transaction_unconfirmed`] to process any transaction returned by [`get_relevant_txids`]
8966 * that has been reorganized out of the chain.
8967 * - Call [`best_block_updated`] whenever a new chain tip becomes available.
8971 * Clients must call these methods in chain order. Specifically:
8972 * - Transactions confirmed in a block must be given before transactions confirmed in a later
8974 * - Dependent transactions within the same block must be given in topological order, possibly in
8976 * - Unconfirmed transactions must be given after the original confirmations and before any
8979 * See individual method documentation for further details.
8981 * [`transactions_confirmed`]: Self::transactions_confirmed
8982 * [`transaction_unconfirmed`]: Self::transaction_unconfirmed
8983 * [`best_block_updated`]: Self::best_block_updated
8984 * [`get_relevant_txids`]: Self::get_relevant_txids
8986 typedef struct LDKConfirm {
8988 * An opaque pointer which is passed to your function implementations as an argument.
8989 * This has no meaning in the LDK, and can be NULL or any other value.
8993 * Processes transactions confirmed in a block with a given header and height.
8995 * Should be called for any transactions registered by [`Filter::register_tx`] or any
8996 * transactions spending an output registered by [`Filter::register_output`]. Such transactions
8997 * appearing in the same block do not need to be included in the same call; instead, multiple
8998 * calls with additional transactions may be made so long as they are made in [chain order].
9000 * May be called before or after [`best_block_updated`] for the corresponding block. However,
9001 * in the event of a chain reorganization, it must not be called with a `header` that is no
9002 * longer in the chain as of the last call to [`best_block_updated`].
9004 * [chain order]: Confirm#Order
9005 * [`best_block_updated`]: Self::best_block_updated
9007 void (*transactions_confirmed)(const void *this_arg, const uint8_t (*header)[80], struct LDKCVec_C2Tuple_usizeTransactionZZ txdata, uint32_t height);
9009 * Processes a transaction that is no longer confirmed as result of a chain reorganization.
9011 * Should be called for any transaction returned by [`get_relevant_txids`] if it has been
9012 * reorganized out of the best chain. Once called, the given transaction should not be returned
9013 * by [`get_relevant_txids`] unless it has been reconfirmed via [`transactions_confirmed`].
9015 * [`get_relevant_txids`]: Self::get_relevant_txids
9016 * [`transactions_confirmed`]: Self::transactions_confirmed
9018 void (*transaction_unconfirmed)(const void *this_arg, const uint8_t (*txid)[32]);
9020 * Processes an update to the best header connected at the given height.
9022 * Should be called when a new header is available but may be skipped for intermediary blocks
9023 * if they become available at the same time.
9025 void (*best_block_updated)(const void *this_arg, const uint8_t (*header)[80], uint32_t height);
9027 * Returns transactions that should be monitored for reorganization out of the chain.
9029 * Should include any transactions passed to [`transactions_confirmed`] that have insufficient
9030 * confirmations to be safe from a chain reorganization. Should not include any transactions
9031 * passed to [`transaction_unconfirmed`] unless later reconfirmed.
9033 * May be called to determine the subset of transactions that must still be monitored for
9034 * reorganization. Will be idempotent between calls but may change as a result of calls to the
9035 * other interface methods. Thus, this is useful to determine which transactions may need to be
9036 * given to [`transaction_unconfirmed`].
9038 * [`transactions_confirmed`]: Self::transactions_confirmed
9039 * [`transaction_unconfirmed`]: Self::transaction_unconfirmed
9041 struct LDKCVec_TxidZ (*get_relevant_txids)(const void *this_arg);
9043 * Frees any resources associated with this object given its this_arg pointer.
9044 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9046 void (*free)(void *this_arg);
9050 * `Persist` defines behavior for persisting channel monitors: this could mean
9051 * writing once to disk, and/or uploading to one or more backup services.
9053 * Note that for every new monitor, you **must** persist the new `ChannelMonitor`
9054 * to disk/backups. And, on every update, you **must** persist either the
9055 * `ChannelMonitorUpdate` or the updated monitor itself. Otherwise, there is risk
9056 * of situations such as revoking a transaction, then crashing before this
9057 * revocation can be persisted, then unintentionally broadcasting a revoked
9058 * transaction and losing money. This is a risk because previous channel states
9059 * are toxic, so it's important that whatever channel state is persisted is
9062 typedef struct LDKPersist {
9064 * An opaque pointer which is passed to your function implementations as an argument.
9065 * This has no meaning in the LDK, and can be NULL or any other value.
9069 * Persist a new channel's data. The data can be stored any way you want, but
9070 * the identifier provided by Rust-Lightning is the channel's outpoint (and
9071 * it is up to you to maintain a correct mapping between the outpoint and the
9072 * stored channel data). Note that you **must** persist every new monitor to
9073 * disk. See the `Persist` trait documentation for more details.
9075 * See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`,
9076 * and [`ChannelMonitorUpdateErr`] for requirements when returning errors.
9078 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*persist_new_channel)(const void *this_arg, struct LDKOutPoint id, const struct LDKChannelMonitor *NONNULL_PTR data);
9080 * Update one channel's data. The provided `ChannelMonitor` has already
9081 * applied the given update.
9083 * Note that on every update, you **must** persist either the
9084 * `ChannelMonitorUpdate` or the updated monitor itself to disk/backups. See
9085 * the `Persist` trait documentation for more details.
9087 * If an implementer chooses to persist the updates only, they need to make
9088 * sure that all the updates are applied to the `ChannelMonitors` *before*
9089 * the set of channel monitors is given to the `ChannelManager`
9090 * deserialization routine. See [`ChannelMonitor::update_monitor`] for
9091 * applying a monitor update to a monitor. If full `ChannelMonitors` are
9092 * persisted, then there is no need to persist individual updates.
9094 * Note that there could be a performance tradeoff between persisting complete
9095 * channel monitors on every update vs. persisting only updates and applying
9096 * them in batches. The size of each monitor grows `O(number of state updates)`
9097 * whereas updates are small and `O(1)`.
9099 * See [`ChannelMonitor::write`] for writing out a `ChannelMonitor`,
9100 * [`ChannelMonitorUpdate::write`] for writing out an update, and
9101 * [`ChannelMonitorUpdateErr`] for requirements when returning errors.
9103 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);
9105 * Frees any resources associated with this object given its this_arg pointer.
9106 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9108 void (*free)(void *this_arg);
9114 * An implementation of [`chain::Watch`] for monitoring channels.
9116 * Connected and disconnected blocks must be provided to `ChainMonitor` as documented by
9117 * [`chain::Watch`]. May be used in conjunction with [`ChannelManager`] to monitor channels locally
9118 * or used independently to monitor channels remotely. See the [module-level documentation] for
9121 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
9122 * [module-level documentation]: crate::chain::chainmonitor
9124 typedef struct MUST_USE_STRUCT LDKChainMonitor {
9126 * A pointer to the opaque Rust object.
9127 * Nearly everywhere, inner must be non-null, however in places where
9128 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9130 LDKnativeChainMonitor *inner;
9132 * Indicates that this is the only struct which contains the same pointer.
9133 * Rust functions which take ownership of an object provided via an argument require
9134 * this to be true and invalidate the object pointed to by inner.
9142 * Simple KeysInterface implementor that takes a 32-byte seed for use as a BIP 32 extended key
9143 * and derives keys from that.
9145 * Your node_id is seed/0'
9146 * ChannelMonitor closes may use seed/1'
9147 * Cooperative closes may use seed/2'
9148 * The two close keys may be needed to claim on-chain funds!
9150 typedef struct MUST_USE_STRUCT LDKKeysManager {
9152 * A pointer to the opaque Rust object.
9153 * Nearly everywhere, inner must be non-null, however in places where
9154 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9156 LDKnativeKeysManager *inner;
9158 * Indicates that this is the only struct which contains the same pointer.
9159 * Rust functions which take ownership of an object provided via an argument require
9160 * this to be true and invalidate the object pointed to by inner.
9168 * Chain-related parameters used to construct a new `ChannelManager`.
9170 * Typically, the block-specific parameters are derived from the best block hash for the network,
9171 * as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
9172 * are not needed when deserializing a previously constructed `ChannelManager`.
9174 typedef struct MUST_USE_STRUCT LDKChainParameters {
9176 * A pointer to the opaque Rust object.
9177 * Nearly everywhere, inner must be non-null, however in places where
9178 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9180 LDKnativeChainParameters *inner;
9182 * Indicates that this is the only struct which contains the same pointer.
9183 * Rust functions which take ownership of an object provided via an argument require
9184 * this to be true and invalidate the object pointed to by inner.
9187 } LDKChainParameters;
9192 * Information needed for constructing an invoice route hint for this channel.
9194 typedef struct MUST_USE_STRUCT LDKCounterpartyForwardingInfo {
9196 * A pointer to the opaque Rust object.
9197 * Nearly everywhere, inner must be non-null, however in places where
9198 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9200 LDKnativeCounterpartyForwardingInfo *inner;
9202 * Indicates that this is the only struct which contains the same pointer.
9203 * Rust functions which take ownership of an object provided via an argument require
9204 * this to be true and invalidate the object pointed to by inner.
9207 } LDKCounterpartyForwardingInfo;
9212 * Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
9213 * to better separate parameters.
9215 typedef struct MUST_USE_STRUCT LDKChannelCounterparty {
9217 * A pointer to the opaque Rust object.
9218 * Nearly everywhere, inner must be non-null, however in places where
9219 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9221 LDKnativeChannelCounterparty *inner;
9223 * Indicates that this is the only struct which contains the same pointer.
9224 * Rust functions which take ownership of an object provided via an argument require
9225 * this to be true and invalidate the object pointed to by inner.
9228 } LDKChannelCounterparty;
9231 * A 3-byte byte array.
9233 typedef struct LDKThreeBytes {
9241 * A trait to describe an object which can receive channel messages.
9243 * Messages MAY be called in parallel when they originate from different their_node_ids, however
9244 * they MUST NOT be called in parallel when the two calls have the same their_node_id.
9246 typedef struct LDKChannelMessageHandler {
9248 * An opaque pointer which is passed to your function implementations as an argument.
9249 * This has no meaning in the LDK, and can be NULL or any other value.
9253 * Handle an incoming open_channel message from the given peer.
9255 void (*handle_open_channel)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKInitFeatures their_features, const struct LDKOpenChannel *NONNULL_PTR msg);
9257 * Handle an incoming accept_channel message from the given peer.
9259 void (*handle_accept_channel)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKInitFeatures their_features, const struct LDKAcceptChannel *NONNULL_PTR msg);
9261 * Handle an incoming funding_created message from the given peer.
9263 void (*handle_funding_created)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingCreated *NONNULL_PTR msg);
9265 * Handle an incoming funding_signed message from the given peer.
9267 void (*handle_funding_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingSigned *NONNULL_PTR msg);
9269 * Handle an incoming funding_locked message from the given peer.
9271 void (*handle_funding_locked)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingLocked *NONNULL_PTR msg);
9273 * Handle an incoming shutdown message from the given peer.
9275 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);
9277 * Handle an incoming closing_signed message from the given peer.
9279 void (*handle_closing_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKClosingSigned *NONNULL_PTR msg);
9281 * Handle an incoming update_add_htlc message from the given peer.
9283 void (*handle_update_add_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateAddHTLC *NONNULL_PTR msg);
9285 * Handle an incoming update_fulfill_htlc message from the given peer.
9287 void (*handle_update_fulfill_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFulfillHTLC *NONNULL_PTR msg);
9289 * Handle an incoming update_fail_htlc message from the given peer.
9291 void (*handle_update_fail_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFailHTLC *NONNULL_PTR msg);
9293 * Handle an incoming update_fail_malformed_htlc message from the given peer.
9295 void (*handle_update_fail_malformed_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR msg);
9297 * Handle an incoming commitment_signed message from the given peer.
9299 void (*handle_commitment_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKCommitmentSigned *NONNULL_PTR msg);
9301 * Handle an incoming revoke_and_ack message from the given peer.
9303 void (*handle_revoke_and_ack)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKRevokeAndACK *NONNULL_PTR msg);
9305 * Handle an incoming update_fee message from the given peer.
9307 void (*handle_update_fee)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFee *NONNULL_PTR msg);
9309 * Handle an incoming announcement_signatures message from the given peer.
9311 void (*handle_announcement_signatures)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKAnnouncementSignatures *NONNULL_PTR msg);
9313 * Indicates a connection to the peer failed/an existing connection was lost. If no connection
9314 * is believed to be possible in the future (eg they're sending us messages we don't
9315 * understand or indicate they require unknown feature bits), no_connection_possible is set
9316 * and any outstanding channels should be failed.
9318 void (*peer_disconnected)(const void *this_arg, struct LDKPublicKey their_node_id, bool no_connection_possible);
9320 * Handle a peer reconnecting, possibly generating channel_reestablish message(s).
9322 void (*peer_connected)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKInit *NONNULL_PTR msg);
9324 * Handle an incoming channel_reestablish message from the given peer.
9326 void (*handle_channel_reestablish)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKChannelReestablish *NONNULL_PTR msg);
9328 * Handle an incoming channel update from the given peer.
9330 void (*handle_channel_update)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKChannelUpdate *NONNULL_PTR msg);
9332 * Handle an incoming error message from the given peer.
9334 void (*handle_error)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKErrorMessage *NONNULL_PTR msg);
9336 * Implementation of MessageSendEventsProvider for this object.
9338 struct LDKMessageSendEventsProvider MessageSendEventsProvider;
9340 * Frees any resources associated with this object given its this_arg pointer.
9341 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9343 void (*free)(void *this_arg);
9344 } LDKChannelMessageHandler;
9349 * Arguments for the creation of a ChannelManager that are not deserialized.
9351 * At a high-level, the process for deserializing a ChannelManager and resuming normal operation
9353 * 1) Deserialize all stored ChannelMonitors.
9354 * 2) Deserialize the ChannelManager by filling in this struct and calling:
9355 * <(BlockHash, ChannelManager)>::read(reader, args)
9356 * This may result in closing some Channels if the ChannelMonitor is newer than the stored
9357 * ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
9358 * 3) If you are not fetching full blocks, register all relevant ChannelMonitor outpoints the same
9359 * way you would handle a `chain::Filter` call using ChannelMonitor::get_outputs_to_watch() and
9360 * ChannelMonitor::get_funding_txo().
9361 * 4) Reconnect blocks on your ChannelMonitors.
9362 * 5) Disconnect/connect blocks on the ChannelManager.
9363 * 6) Move the ChannelMonitors into your local chain::Watch.
9365 * Note that the ordering of #4-6 is not of importance, however all three must occur before you
9366 * call any other methods on the newly-deserialized ChannelManager.
9368 * Note that because some channels may be closed during deserialization, it is critical that you
9369 * always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
9370 * you. If you deserialize an old ChannelManager (during which force-closure transactions may be
9371 * broadcast), and then later deserialize a newer version of the same ChannelManager (which will
9372 * not force-close the same channels but consider them live), you may end up revoking a state for
9373 * which you've already broadcasted the transaction.
9375 typedef struct MUST_USE_STRUCT LDKChannelManagerReadArgs {
9377 * A pointer to the opaque Rust object.
9378 * Nearly everywhere, inner must be non-null, however in places where
9379 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9381 LDKnativeChannelManagerReadArgs *inner;
9383 * Indicates that this is the only struct which contains the same pointer.
9384 * Rust functions which take ownership of an object provided via an argument require
9385 * this to be true and invalidate the object pointed to by inner.
9388 } LDKChannelManagerReadArgs;
9393 * Proof that the sender knows the per-commitment secret of the previous commitment transaction.
9394 * This is used to convince the recipient that the channel is at a certain commitment
9395 * number even if they lost that data due to a local failure. Of course, the peer may lie
9396 * and even later commitments may have been revoked.
9398 typedef struct MUST_USE_STRUCT LDKDataLossProtect {
9400 * A pointer to the opaque Rust object.
9401 * Nearly everywhere, inner must be non-null, however in places where
9402 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9404 LDKnativeDataLossProtect *inner;
9406 * Indicates that this is the only struct which contains the same pointer.
9407 * Rust functions which take ownership of an object provided via an argument require
9408 * this to be true and invalidate the object pointed to by inner.
9411 } LDKDataLossProtect;
9414 * A trait to describe an object which can receive routing messages.
9416 * # Implementor DoS Warnings
9418 * For `gossip_queries` messages there are potential DoS vectors when handling
9419 * inbound queries. Implementors using an on-disk network graph should be aware of
9420 * repeated disk I/O for queries accessing different parts of the network graph.
9422 typedef struct LDKRoutingMessageHandler {
9424 * An opaque pointer which is passed to your function implementations as an argument.
9425 * This has no meaning in the LDK, and can be NULL or any other value.
9429 * Handle an incoming node_announcement message, returning true if it should be forwarded on,
9430 * false or returning an Err otherwise.
9432 struct LDKCResult_boolLightningErrorZ (*handle_node_announcement)(const void *this_arg, const struct LDKNodeAnnouncement *NONNULL_PTR msg);
9434 * Handle a channel_announcement message, returning true if it should be forwarded on, false
9435 * or returning an Err otherwise.
9437 struct LDKCResult_boolLightningErrorZ (*handle_channel_announcement)(const void *this_arg, const struct LDKChannelAnnouncement *NONNULL_PTR msg);
9439 * Handle an incoming channel_update message, returning true if it should be forwarded on,
9440 * false or returning an Err otherwise.
9442 struct LDKCResult_boolLightningErrorZ (*handle_channel_update)(const void *this_arg, const struct LDKChannelUpdate *NONNULL_PTR msg);
9444 * Gets a subset of the channel announcements and updates required to dump our routing table
9445 * to a remote node, starting at the short_channel_id indicated by starting_point and
9446 * including the batch_amount entries immediately higher in numerical value than starting_point.
9448 struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ (*get_next_channel_announcements)(const void *this_arg, uint64_t starting_point, uint8_t batch_amount);
9450 * Gets a subset of the node announcements required to dump our routing table to a remote node,
9451 * starting at the node *after* the provided publickey and including batch_amount entries
9452 * immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
9453 * If None is provided for starting_point, we start at the first node.
9455 * Note that starting_point (or a relevant inner pointer) may be NULL or all-0s to represent None
9457 struct LDKCVec_NodeAnnouncementZ (*get_next_node_announcements)(const void *this_arg, struct LDKPublicKey starting_point, uint8_t batch_amount);
9459 * Called when a connection is established with a peer. This can be used to
9460 * perform routing table synchronization using a strategy defined by the
9463 void (*sync_routing_table)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKInit *NONNULL_PTR init);
9465 * Handles the reply of a query we initiated to learn about channels
9466 * for a given range of blocks. We can expect to receive one or more
9467 * replies to a single query.
9469 struct LDKCResult_NoneLightningErrorZ (*handle_reply_channel_range)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKReplyChannelRange msg);
9471 * Handles the reply of a query we initiated asking for routing gossip
9472 * messages for a list of channels. We should receive this message when
9473 * a node has completed its best effort to send us the pertaining routing
9476 struct LDKCResult_NoneLightningErrorZ (*handle_reply_short_channel_ids_end)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKReplyShortChannelIdsEnd msg);
9478 * Handles when a peer asks us to send a list of short_channel_ids
9479 * for the requested range of blocks.
9481 struct LDKCResult_NoneLightningErrorZ (*handle_query_channel_range)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKQueryChannelRange msg);
9483 * Handles when a peer asks us to send routing gossip messages for a
9484 * list of short_channel_ids.
9486 struct LDKCResult_NoneLightningErrorZ (*handle_query_short_channel_ids)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKQueryShortChannelIds msg);
9488 * Implementation of MessageSendEventsProvider for this object.
9490 struct LDKMessageSendEventsProvider MessageSendEventsProvider;
9492 * Frees any resources associated with this object given its this_arg pointer.
9493 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9495 void (*free)(void *this_arg);
9496 } LDKRoutingMessageHandler;
9499 * Trait to be implemented by custom message (unrelated to the channel/gossip LN layers)
9502 typedef struct LDKCustomMessageReader {
9504 * An opaque pointer which is passed to your function implementations as an argument.
9505 * This has no meaning in the LDK, and can be NULL or any other value.
9509 * Decodes a custom message to `CustomMessageType`. If the given message type is known to the
9510 * implementation and the message could be decoded, must return `Ok(Some(message))`. If the
9511 * message type is unknown to the implementation, must return `Ok(None)`. If a decoding error
9512 * occur, must return `Err(DecodeError::X)` where `X` details the encountered error.
9514 struct LDKCResult_COption_TypeZDecodeErrorZ (*read)(const void *this_arg, uint16_t message_type, struct LDKu8slice buffer);
9516 * Frees any resources associated with this object given its this_arg pointer.
9517 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9519 void (*free)(void *this_arg);
9520 } LDKCustomMessageReader;
9523 * Handler for BOLT1-compliant messages.
9525 typedef struct LDKCustomMessageHandler {
9527 * An opaque pointer which is passed to your function implementations as an argument.
9528 * This has no meaning in the LDK, and can be NULL or any other value.
9532 * Called with the message type that was received and the buffer to be read.
9533 * Can return a `MessageHandlingError` if the message could not be handled.
9535 struct LDKCResult_NoneLightningErrorZ (*handle_custom_message)(const void *this_arg, struct LDKType msg, struct LDKPublicKey sender_node_id);
9537 * Gets the list of pending messages which were generated by the custom message
9538 * handler, clearing the list in the process. The first tuple element must
9539 * correspond to the intended recipients node ids. If no connection to one of the
9540 * specified node does not exist, the message is simply not sent to it.
9542 struct LDKCVec_C2Tuple_PublicKeyTypeZZ (*get_and_clear_pending_msg)(const void *this_arg);
9544 * Implementation of CustomMessageReader for this object.
9546 struct LDKCustomMessageReader CustomMessageReader;
9548 * Frees any resources associated with this object given its this_arg pointer.
9549 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9551 void (*free)(void *this_arg);
9552 } LDKCustomMessageHandler;
9557 * A dummy struct which implements `RoutingMessageHandler` without storing any routing information
9558 * or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
9560 typedef struct MUST_USE_STRUCT LDKIgnoringMessageHandler {
9562 * A pointer to the opaque Rust object.
9563 * Nearly everywhere, inner must be non-null, however in places where
9564 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9566 LDKnativeIgnoringMessageHandler *inner;
9568 * Indicates that this is the only struct which contains the same pointer.
9569 * Rust functions which take ownership of an object provided via an argument require
9570 * this to be true and invalidate the object pointed to by inner.
9573 } LDKIgnoringMessageHandler;
9578 * A dummy struct which implements `ChannelMessageHandler` without having any channels.
9579 * You can provide one of these as the route_handler in a MessageHandler.
9581 typedef struct MUST_USE_STRUCT LDKErroringMessageHandler {
9583 * A pointer to the opaque Rust object.
9584 * Nearly everywhere, inner must be non-null, however in places where
9585 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9587 LDKnativeErroringMessageHandler *inner;
9589 * Indicates that this is the only struct which contains the same pointer.
9590 * Rust functions which take ownership of an object provided via an argument require
9591 * this to be true and invalidate the object pointed to by inner.
9594 } LDKErroringMessageHandler;
9599 * Provides references to trait impls which handle different types of messages.
9601 typedef struct MUST_USE_STRUCT LDKMessageHandler {
9603 * A pointer to the opaque Rust object.
9604 * Nearly everywhere, inner must be non-null, however in places where
9605 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9607 LDKnativeMessageHandler *inner;
9609 * Indicates that this is the only struct which contains the same pointer.
9610 * Rust functions which take ownership of an object provided via an argument require
9611 * this to be true and invalidate the object pointed to by inner.
9614 } LDKMessageHandler;
9617 * Provides an object which can be used to send data to and which uniquely identifies a connection
9618 * to a remote host. You will need to be able to generate multiple of these which meet Eq and
9619 * implement Hash to meet the PeerManager API.
9621 * For efficiency, Clone should be relatively cheap for this type.
9623 * Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
9624 * has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
9625 * having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
9626 * further calls to the [`PeerManager`] related to the original socket occur. This allows you to
9627 * use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
9628 * to simply use another value which is guaranteed to be globally unique instead.
9630 typedef struct LDKSocketDescriptor {
9632 * An opaque pointer which is passed to your function implementations as an argument.
9633 * This has no meaning in the LDK, and can be NULL or any other value.
9637 * Attempts to send some data from the given slice to the peer.
9639 * Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
9640 * Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
9641 * called and further write attempts may occur until that time.
9643 * If the returned size is smaller than `data.len()`, a
9644 * [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
9645 * written. Additionally, until a `send_data` event completes fully, no further
9646 * [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
9647 * prevent denial-of-service issues, you should not read or buffer any data from the socket
9650 * If a [`PeerManager::read_event`] call on this descriptor had previously returned true
9651 * (indicating that read events should be paused to prevent DoS in the send buffer),
9652 * `resume_read` may be set indicating that read events on this descriptor should resume. A
9653 * `resume_read` of false carries no meaning, and should not cause any action.
9655 uintptr_t (*send_data)(void *this_arg, struct LDKu8slice data, bool resume_read);
9657 * Disconnect the socket pointed to by this SocketDescriptor.
9659 * You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
9660 * call (doing so is a noop).
9662 void (*disconnect_socket)(void *this_arg);
9664 * Checks if two objects are equal given this object's this_arg pointer and another object.
9666 bool (*eq)(const void *this_arg, const struct LDKSocketDescriptor *NONNULL_PTR other_arg);
9668 * Calculate a succinct non-cryptographic hash for an object given its this_arg pointer.
9669 * This is used, for example, for inclusion of this object in a hash map.
9671 uint64_t (*hash)(const void *this_arg);
9673 * Called, if set, after this SocketDescriptor has been cloned into a duplicate object.
9674 * The new SocketDescriptor is provided, and should be mutated as needed to perform a
9675 * deep copy of the object pointed to by this_arg or avoid any double-freeing.
9677 void (*cloned)(struct LDKSocketDescriptor *NONNULL_PTR new_SocketDescriptor);
9679 * Frees any resources associated with this object given its this_arg pointer.
9680 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9682 void (*free)(void *this_arg);
9683 } LDKSocketDescriptor;
9688 * A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
9689 * socket events into messages which it passes on to its [`MessageHandler`].
9691 * Locks are taken internally, so you must never assume that reentrancy from a
9692 * [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
9694 * Calls to [`read_event`] will decode relevant messages and pass them to the
9695 * [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
9696 * parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
9697 * [`PeerManager`] functions related to the same connection must occur only in serial, making new
9698 * calls only after previous ones have returned.
9700 * Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
9701 * a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
9702 * essentially you should default to using a SimpleRefPeerManager, and use a
9703 * SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
9704 * you're using lightning-net-tokio.
9706 * [`read_event`]: PeerManager::read_event
9708 typedef struct MUST_USE_STRUCT LDKPeerManager {
9710 * A pointer to the opaque Rust object.
9711 * Nearly everywhere, inner must be non-null, however in places where
9712 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9714 LDKnativePeerManager *inner;
9716 * Indicates that this is the only struct which contains the same pointer.
9717 * Rust functions which take ownership of an object provided via an argument require
9718 * this to be true and invalidate the object pointed to by inner.
9726 * Static channel fields used to build transactions given per-commitment fields, organized by
9727 * broadcaster/countersignatory.
9729 * This is derived from the holder/counterparty-organized ChannelTransactionParameters via the
9730 * as_holder_broadcastable and as_counterparty_broadcastable functions.
9732 typedef struct MUST_USE_STRUCT LDKDirectedChannelTransactionParameters {
9734 * A pointer to the opaque Rust object.
9735 * Nearly everywhere, inner must be non-null, however in places where
9736 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9738 LDKnativeDirectedChannelTransactionParameters *inner;
9740 * Indicates that this is the only struct which contains the same pointer.
9741 * Rust functions which take ownership of an object provided via an argument require
9742 * this to be true and invalidate the object pointed to by inner.
9745 } LDKDirectedChannelTransactionParameters;
9750 * A channel descriptor for a hop along a payment path.
9752 typedef struct MUST_USE_STRUCT LDKRouteHintHop {
9754 * A pointer to the opaque Rust object.
9755 * Nearly everywhere, inner must be non-null, however in places where
9756 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9758 LDKnativeRouteHintHop *inner;
9760 * Indicates that this is the only struct which contains the same pointer.
9761 * Rust functions which take ownership of an object provided via an argument require
9762 * this to be true and invalidate the object pointed to by inner.
9770 * A read-only view of [`NetworkGraph`].
9772 typedef struct MUST_USE_STRUCT LDKReadOnlyNetworkGraph {
9774 * A pointer to the opaque Rust object.
9775 * Nearly everywhere, inner must be non-null, however in places where
9776 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9778 LDKnativeReadOnlyNetworkGraph *inner;
9780 * Indicates that this is the only struct which contains the same pointer.
9781 * Rust functions which take ownership of an object provided via an argument require
9782 * this to be true and invalidate the object pointed to by inner.
9785 } LDKReadOnlyNetworkGraph;
9790 * Receives and validates network updates from peers,
9791 * stores authentic and relevant data as a network graph.
9792 * This network graph is then used for routing payments.
9793 * Provides interface to help with initial routing sync by
9794 * serving historical announcements.
9796 * Serves as an [`EventHandler`] for applying updates from [`Event::PaymentPathFailed`] to the
9799 typedef struct MUST_USE_STRUCT LDKNetGraphMsgHandler {
9801 * A pointer to the opaque Rust object.
9802 * Nearly everywhere, inner must be non-null, however in places where
9803 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9805 LDKnativeNetGraphMsgHandler *inner;
9807 * Indicates that this is the only struct which contains the same pointer.
9808 * Rust functions which take ownership of an object provided via an argument require
9809 * this to be true and invalidate the object pointed to by inner.
9812 } LDKNetGraphMsgHandler;
9817 * FilesystemPersister persists channel data on disk, where each channel's
9818 * data is stored in a file named after its funding outpoint.
9820 * Warning: this module does the best it can with calls to persist data, but it
9821 * can only guarantee that the data is passed to the drive. It is up to the
9822 * drive manufacturers to do the actual persistence properly, which they often
9823 * don't (especially on consumer-grade hardware). Therefore, it is up to the
9824 * user to validate their entire storage stack, to ensure the writes are
9826 * Corollary: especially when dealing with larger amounts of money, it is best
9827 * practice to have multiple channel data backups and not rely only on one
9828 * FilesystemPersister.
9830 typedef struct MUST_USE_STRUCT LDKFilesystemPersister {
9832 * A pointer to the opaque Rust object.
9833 * Nearly everywhere, inner must be non-null, however in places where
9834 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9836 LDKnativeFilesystemPersister *inner;
9838 * Indicates that this is the only struct which contains the same pointer.
9839 * Rust functions which take ownership of an object provided via an argument require
9840 * this to be true and invalidate the object pointed to by inner.
9843 } LDKFilesystemPersister;
9848 * `BackgroundProcessor` takes care of tasks that (1) need to happen periodically to keep
9849 * Rust-Lightning running properly, and (2) either can or should be run in the background. Its
9850 * responsibilities are:
9851 * * Processing [`Event`]s with a user-provided [`EventHandler`].
9852 * * Monitoring whether the [`ChannelManager`] needs to be re-persisted to disk, and if so,
9853 * writing it to disk/backups by invoking the callback given to it at startup.
9854 * [`ChannelManager`] persistence should be done in the background.
9855 * * Calling [`ChannelManager::timer_tick_occurred`] and [`PeerManager::timer_tick_occurred`]
9856 * at the appropriate intervals.
9858 * It will also call [`PeerManager::process_events`] periodically though this shouldn't be relied
9859 * upon as doing so may result in high latency.
9863 * If [`ChannelManager`] persistence fails and the persisted manager becomes out-of-date, then
9864 * there is a risk of channels force-closing on startup when the manager realizes it's outdated.
9865 * However, as long as [`ChannelMonitor`] backups are sound, no funds besides those used for
9866 * unilateral chain closure fees are at risk.
9868 * [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
9869 * [`Event`]: lightning::util::events::Event
9870 *BackgroundProcessor will immediately stop on drop. It should be stored until shutdown.
9872 typedef struct MUST_USE_STRUCT LDKBackgroundProcessor {
9874 * A pointer to the opaque Rust object.
9875 * Nearly everywhere, inner must be non-null, however in places where
9876 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9878 LDKnativeBackgroundProcessor *inner;
9880 * Indicates that this is the only struct which contains the same pointer.
9881 * Rust functions which take ownership of an object provided via an argument require
9882 * this to be true and invalidate the object pointed to by inner.
9885 } LDKBackgroundProcessor;
9888 * Trait which handles persisting a [`ChannelManager`] to disk.
9890 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
9892 typedef struct LDKChannelManagerPersister {
9894 * An opaque pointer which is passed to your function implementations as an argument.
9895 * This has no meaning in the LDK, and can be NULL or any other value.
9899 * Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
9900 * (which will cause the [`BackgroundProcessor`] which called this method to exit.
9902 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
9904 struct LDKCResult_NoneErrorZ (*persist_manager)(const void *this_arg, const struct LDKChannelManager *NONNULL_PTR channel_manager);
9906 * Frees any resources associated with this object given its this_arg pointer.
9907 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9909 void (*free)(void *this_arg);
9910 } LDKChannelManagerPersister;
9915 * Data of the `RawInvoice` that is encoded in the data part
9917 typedef struct MUST_USE_STRUCT LDKRawDataPart {
9919 * A pointer to the opaque Rust object.
9920 * Nearly everywhere, inner must be non-null, however in places where
9921 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9923 LDKnativeRawDataPart *inner;
9925 * Indicates that this is the only struct which contains the same pointer.
9926 * Rust functions which take ownership of an object provided via an argument require
9927 * this to be true and invalidate the object pointed to by inner.
9937 typedef struct MUST_USE_STRUCT LDKSha256 {
9939 * A pointer to the opaque Rust object.
9940 * Nearly everywhere, inner must be non-null, however in places where
9941 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9943 LDKnativeSha256 *inner;
9945 * Indicates that this is the only struct which contains the same pointer.
9946 * Rust functions which take ownership of an object provided via an argument require
9947 * this to be true and invalidate the object pointed to by inner.
9955 * `min_final_cltv_expiry` to use for the last HTLC in the route
9957 typedef struct MUST_USE_STRUCT LDKMinFinalCltvExpiry {
9959 * A pointer to the opaque Rust object.
9960 * Nearly everywhere, inner must be non-null, however in places where
9961 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9963 LDKnativeMinFinalCltvExpiry *inner;
9965 * Indicates that this is the only struct which contains the same pointer.
9966 * Rust functions which take ownership of an object provided via an argument require
9967 * this to be true and invalidate the object pointed to by inner.
9970 } LDKMinFinalCltvExpiry;
9973 * Integer in the range `0..32`
9975 typedef struct LDKu5 {
9980 * A 20-byte byte array.
9982 typedef struct LDKTwentyBytes {
9990 * Fallback address in case no LN payment is possible
9992 typedef enum LDKFallback_Tag {
9993 LDKFallback_SegWitProgram,
9994 LDKFallback_PubKeyHash,
9995 LDKFallback_ScriptHash,
9997 * Must be last for serialization purposes
9999 LDKFallback_Sentinel,
10002 typedef struct LDKFallback_LDKSegWitProgram_Body {
10003 struct LDKu5 version;
10004 struct LDKCVec_u8Z program;
10005 } LDKFallback_LDKSegWitProgram_Body;
10007 typedef struct MUST_USE_STRUCT LDKFallback {
10008 LDKFallback_Tag tag;
10010 LDKFallback_LDKSegWitProgram_Body seg_wit_program;
10012 struct LDKTwentyBytes pub_key_hash;
10015 struct LDKTwentyBytes script_hash;
10020 extern const uintptr_t MAX_BUF_SIZE;
10022 extern const uint64_t MIN_RELAY_FEE_SAT_PER_1000_WEIGHT;
10024 extern const uint64_t CLOSED_CHANNEL_UPDATE_ID;
10026 extern const uint32_t ANTI_REORG_DELAY;
10028 extern const uint16_t BREAKDOWN_TIMEOUT;
10030 extern const uint16_t MIN_CLTV_EXPIRY_DELTA;
10032 extern const uint32_t MIN_FINAL_CLTV_EXPIRY;
10034 extern const uintptr_t REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH;
10036 extern const uint64_t DEFAULT_EXPIRY_TIME;
10038 extern const uint64_t DEFAULT_MIN_FINAL_CLTV_EXPIRY;
10040 extern const uint8_t TAG_PAYMENT_HASH;
10042 extern const uint8_t TAG_DESCRIPTION;
10044 extern const uint8_t TAG_PAYEE_PUB_KEY;
10046 extern const uint8_t TAG_DESCRIPTION_HASH;
10048 extern const uint8_t TAG_EXPIRY_TIME;
10050 extern const uint8_t TAG_MIN_FINAL_CLTV_EXPIRY;
10052 extern const uint8_t TAG_FALLBACK;
10054 extern const uint8_t TAG_PRIVATE_ROUTE;
10056 extern const uint8_t TAG_PAYMENT_SECRET;
10058 extern const uint8_t TAG_FEATURES;
10060 struct LDKStr _ldk_get_compiled_version(void);
10062 struct LDKStr _ldk_c_bindings_get_compiled_version(void);
10065 * Frees the data buffer, if data_is_owned is set and datalen > 0.
10067 void Transaction_free(struct LDKTransaction _res);
10070 * Convenience function for constructing a new TxOut
10072 struct LDKTxOut TxOut_new(struct LDKCVec_u8Z script_pubkey, uint64_t value);
10075 * Frees the data pointed to by script_pubkey.
10077 void TxOut_free(struct LDKTxOut _res);
10080 * Creates a new TxOut which has the same data as `orig` but with a new script buffer.
10082 struct LDKTxOut TxOut_clone(const struct LDKTxOut *NONNULL_PTR orig);
10085 * Frees the data buffer, if chars_is_owned is set and len > 0.
10087 void Str_free(struct LDKStr _res);
10090 * Creates a new CResult_SecretKeyErrorZ in the success state.
10092 struct LDKCResult_SecretKeyErrorZ CResult_SecretKeyErrorZ_ok(struct LDKSecretKey o);
10095 * Creates a new CResult_SecretKeyErrorZ in the error state.
10097 struct LDKCResult_SecretKeyErrorZ CResult_SecretKeyErrorZ_err(enum LDKSecp256k1Error e);
10100 * Frees any resources used by the CResult_SecretKeyErrorZ.
10102 void CResult_SecretKeyErrorZ_free(struct LDKCResult_SecretKeyErrorZ _res);
10105 * Creates a new CResult_PublicKeyErrorZ in the success state.
10107 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_ok(struct LDKPublicKey o);
10110 * Creates a new CResult_PublicKeyErrorZ in the error state.
10112 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_err(enum LDKSecp256k1Error e);
10115 * Frees any resources used by the CResult_PublicKeyErrorZ.
10117 void CResult_PublicKeyErrorZ_free(struct LDKCResult_PublicKeyErrorZ _res);
10120 * Creates a new CResult_PublicKeyErrorZ which has the same data as `orig`
10121 * but with all dynamically-allocated buffers duplicated in new buffers.
10123 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_clone(const struct LDKCResult_PublicKeyErrorZ *NONNULL_PTR orig);
10126 * Creates a new CResult_TxCreationKeysDecodeErrorZ in the success state.
10128 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_ok(struct LDKTxCreationKeys o);
10131 * Creates a new CResult_TxCreationKeysDecodeErrorZ in the error state.
10133 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_err(struct LDKDecodeError e);
10136 * Frees any resources used by the CResult_TxCreationKeysDecodeErrorZ.
10138 void CResult_TxCreationKeysDecodeErrorZ_free(struct LDKCResult_TxCreationKeysDecodeErrorZ _res);
10141 * Creates a new CResult_TxCreationKeysDecodeErrorZ which has the same data as `orig`
10142 * but with all dynamically-allocated buffers duplicated in new buffers.
10144 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_clone(const struct LDKCResult_TxCreationKeysDecodeErrorZ *NONNULL_PTR orig);
10147 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ in the success state.
10149 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_ok(struct LDKChannelPublicKeys o);
10152 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ in the error state.
10154 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_err(struct LDKDecodeError e);
10157 * Frees any resources used by the CResult_ChannelPublicKeysDecodeErrorZ.
10159 void CResult_ChannelPublicKeysDecodeErrorZ_free(struct LDKCResult_ChannelPublicKeysDecodeErrorZ _res);
10162 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ which has the same data as `orig`
10163 * but with all dynamically-allocated buffers duplicated in new buffers.
10165 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_clone(const struct LDKCResult_ChannelPublicKeysDecodeErrorZ *NONNULL_PTR orig);
10168 * Creates a new CResult_TxCreationKeysErrorZ in the success state.
10170 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_ok(struct LDKTxCreationKeys o);
10173 * Creates a new CResult_TxCreationKeysErrorZ in the error state.
10175 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_err(enum LDKSecp256k1Error e);
10178 * Frees any resources used by the CResult_TxCreationKeysErrorZ.
10180 void CResult_TxCreationKeysErrorZ_free(struct LDKCResult_TxCreationKeysErrorZ _res);
10183 * Creates a new CResult_TxCreationKeysErrorZ which has the same data as `orig`
10184 * but with all dynamically-allocated buffers duplicated in new buffers.
10186 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_clone(const struct LDKCResult_TxCreationKeysErrorZ *NONNULL_PTR orig);
10189 * Constructs a new COption_u32Z containing a u32
10191 struct LDKCOption_u32Z COption_u32Z_some(uint32_t o);
10194 * Constructs a new COption_u32Z containing nothing
10196 struct LDKCOption_u32Z COption_u32Z_none(void);
10199 * Frees any resources associated with the u32, if we are in the Some state
10201 void COption_u32Z_free(struct LDKCOption_u32Z _res);
10204 * Creates a new COption_u32Z which has the same data as `orig`
10205 * but with all dynamically-allocated buffers duplicated in new buffers.
10207 struct LDKCOption_u32Z COption_u32Z_clone(const struct LDKCOption_u32Z *NONNULL_PTR orig);
10210 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ in the success state.
10212 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_ok(struct LDKHTLCOutputInCommitment o);
10215 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ in the error state.
10217 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_err(struct LDKDecodeError e);
10220 * Frees any resources used by the CResult_HTLCOutputInCommitmentDecodeErrorZ.
10222 void CResult_HTLCOutputInCommitmentDecodeErrorZ_free(struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ _res);
10225 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ which has the same data as `orig`
10226 * but with all dynamically-allocated buffers duplicated in new buffers.
10228 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_clone(const struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ *NONNULL_PTR orig);
10231 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ in the success state.
10233 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_ok(struct LDKCounterpartyChannelTransactionParameters o);
10236 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ in the error state.
10238 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_err(struct LDKDecodeError e);
10241 * Frees any resources used by the CResult_CounterpartyChannelTransactionParametersDecodeErrorZ.
10243 void CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_free(struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ _res);
10246 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ which has the same data as `orig`
10247 * but with all dynamically-allocated buffers duplicated in new buffers.
10249 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_clone(const struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ *NONNULL_PTR orig);
10252 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ in the success state.
10254 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_ok(struct LDKChannelTransactionParameters o);
10257 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ in the error state.
10259 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_err(struct LDKDecodeError e);
10262 * Frees any resources used by the CResult_ChannelTransactionParametersDecodeErrorZ.
10264 void CResult_ChannelTransactionParametersDecodeErrorZ_free(struct LDKCResult_ChannelTransactionParametersDecodeErrorZ _res);
10267 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ which has the same data as `orig`
10268 * but with all dynamically-allocated buffers duplicated in new buffers.
10270 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_clone(const struct LDKCResult_ChannelTransactionParametersDecodeErrorZ *NONNULL_PTR orig);
10273 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10275 void CVec_SignatureZ_free(struct LDKCVec_SignatureZ _res);
10278 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ in the success state.
10280 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_ok(struct LDKHolderCommitmentTransaction o);
10283 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ in the error state.
10285 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
10288 * Frees any resources used by the CResult_HolderCommitmentTransactionDecodeErrorZ.
10290 void CResult_HolderCommitmentTransactionDecodeErrorZ_free(struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ _res);
10293 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ which has the same data as `orig`
10294 * but with all dynamically-allocated buffers duplicated in new buffers.
10296 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
10299 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ in the success state.
10301 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_ok(struct LDKBuiltCommitmentTransaction o);
10304 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ in the error state.
10306 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
10309 * Frees any resources used by the CResult_BuiltCommitmentTransactionDecodeErrorZ.
10311 void CResult_BuiltCommitmentTransactionDecodeErrorZ_free(struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ _res);
10314 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ which has the same data as `orig`
10315 * but with all dynamically-allocated buffers duplicated in new buffers.
10317 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
10320 * Creates a new CResult_TrustedClosingTransactionNoneZ in the success state.
10322 struct LDKCResult_TrustedClosingTransactionNoneZ CResult_TrustedClosingTransactionNoneZ_ok(struct LDKTrustedClosingTransaction o);
10325 * Creates a new CResult_TrustedClosingTransactionNoneZ in the error state.
10327 struct LDKCResult_TrustedClosingTransactionNoneZ CResult_TrustedClosingTransactionNoneZ_err(void);
10330 * Frees any resources used by the CResult_TrustedClosingTransactionNoneZ.
10332 void CResult_TrustedClosingTransactionNoneZ_free(struct LDKCResult_TrustedClosingTransactionNoneZ _res);
10335 * Creates a new CResult_CommitmentTransactionDecodeErrorZ in the success state.
10337 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_ok(struct LDKCommitmentTransaction o);
10340 * Creates a new CResult_CommitmentTransactionDecodeErrorZ in the error state.
10342 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
10345 * Frees any resources used by the CResult_CommitmentTransactionDecodeErrorZ.
10347 void CResult_CommitmentTransactionDecodeErrorZ_free(struct LDKCResult_CommitmentTransactionDecodeErrorZ _res);
10350 * Creates a new CResult_CommitmentTransactionDecodeErrorZ which has the same data as `orig`
10351 * but with all dynamically-allocated buffers duplicated in new buffers.
10353 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_CommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
10356 * Creates a new CResult_TrustedCommitmentTransactionNoneZ in the success state.
10358 struct LDKCResult_TrustedCommitmentTransactionNoneZ CResult_TrustedCommitmentTransactionNoneZ_ok(struct LDKTrustedCommitmentTransaction o);
10361 * Creates a new CResult_TrustedCommitmentTransactionNoneZ in the error state.
10363 struct LDKCResult_TrustedCommitmentTransactionNoneZ CResult_TrustedCommitmentTransactionNoneZ_err(void);
10366 * Frees any resources used by the CResult_TrustedCommitmentTransactionNoneZ.
10368 void CResult_TrustedCommitmentTransactionNoneZ_free(struct LDKCResult_TrustedCommitmentTransactionNoneZ _res);
10371 * Creates a new CResult_CVec_SignatureZNoneZ in the success state.
10373 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_ok(struct LDKCVec_SignatureZ o);
10376 * Creates a new CResult_CVec_SignatureZNoneZ in the error state.
10378 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_err(void);
10381 * Frees any resources used by the CResult_CVec_SignatureZNoneZ.
10383 void CResult_CVec_SignatureZNoneZ_free(struct LDKCResult_CVec_SignatureZNoneZ _res);
10386 * Creates a new CResult_CVec_SignatureZNoneZ which has the same data as `orig`
10387 * but with all dynamically-allocated buffers duplicated in new buffers.
10389 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_clone(const struct LDKCResult_CVec_SignatureZNoneZ *NONNULL_PTR orig);
10392 * Creates a new CResult_ShutdownScriptDecodeErrorZ in the success state.
10394 struct LDKCResult_ShutdownScriptDecodeErrorZ CResult_ShutdownScriptDecodeErrorZ_ok(struct LDKShutdownScript o);
10397 * Creates a new CResult_ShutdownScriptDecodeErrorZ in the error state.
10399 struct LDKCResult_ShutdownScriptDecodeErrorZ CResult_ShutdownScriptDecodeErrorZ_err(struct LDKDecodeError e);
10402 * Frees any resources used by the CResult_ShutdownScriptDecodeErrorZ.
10404 void CResult_ShutdownScriptDecodeErrorZ_free(struct LDKCResult_ShutdownScriptDecodeErrorZ _res);
10407 * Creates a new CResult_ShutdownScriptDecodeErrorZ which has the same data as `orig`
10408 * but with all dynamically-allocated buffers duplicated in new buffers.
10410 struct LDKCResult_ShutdownScriptDecodeErrorZ CResult_ShutdownScriptDecodeErrorZ_clone(const struct LDKCResult_ShutdownScriptDecodeErrorZ *NONNULL_PTR orig);
10413 * Creates a new CResult_ShutdownScriptInvalidShutdownScriptZ in the success state.
10415 struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ CResult_ShutdownScriptInvalidShutdownScriptZ_ok(struct LDKShutdownScript o);
10418 * Creates a new CResult_ShutdownScriptInvalidShutdownScriptZ in the error state.
10420 struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ CResult_ShutdownScriptInvalidShutdownScriptZ_err(struct LDKInvalidShutdownScript e);
10423 * Frees any resources used by the CResult_ShutdownScriptInvalidShutdownScriptZ.
10425 void CResult_ShutdownScriptInvalidShutdownScriptZ_free(struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ _res);
10428 * Creates a new CResult_NoneErrorZ in the success state.
10430 struct LDKCResult_NoneErrorZ CResult_NoneErrorZ_ok(void);
10433 * Creates a new CResult_NoneErrorZ in the error state.
10435 struct LDKCResult_NoneErrorZ CResult_NoneErrorZ_err(enum LDKIOError e);
10438 * Frees any resources used by the CResult_NoneErrorZ.
10440 void CResult_NoneErrorZ_free(struct LDKCResult_NoneErrorZ _res);
10443 * Creates a new CResult_NoneErrorZ which has the same data as `orig`
10444 * but with all dynamically-allocated buffers duplicated in new buffers.
10446 struct LDKCResult_NoneErrorZ CResult_NoneErrorZ_clone(const struct LDKCResult_NoneErrorZ *NONNULL_PTR orig);
10449 * Creates a new CResult_RouteHopDecodeErrorZ in the success state.
10451 struct LDKCResult_RouteHopDecodeErrorZ CResult_RouteHopDecodeErrorZ_ok(struct LDKRouteHop o);
10454 * Creates a new CResult_RouteHopDecodeErrorZ in the error state.
10456 struct LDKCResult_RouteHopDecodeErrorZ CResult_RouteHopDecodeErrorZ_err(struct LDKDecodeError e);
10459 * Frees any resources used by the CResult_RouteHopDecodeErrorZ.
10461 void CResult_RouteHopDecodeErrorZ_free(struct LDKCResult_RouteHopDecodeErrorZ _res);
10464 * Creates a new CResult_RouteHopDecodeErrorZ which has the same data as `orig`
10465 * but with all dynamically-allocated buffers duplicated in new buffers.
10467 struct LDKCResult_RouteHopDecodeErrorZ CResult_RouteHopDecodeErrorZ_clone(const struct LDKCResult_RouteHopDecodeErrorZ *NONNULL_PTR orig);
10470 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10472 void CVec_RouteHopZ_free(struct LDKCVec_RouteHopZ _res);
10475 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10477 void CVec_CVec_RouteHopZZ_free(struct LDKCVec_CVec_RouteHopZZ _res);
10480 * Creates a new CResult_RouteDecodeErrorZ in the success state.
10482 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_ok(struct LDKRoute o);
10485 * Creates a new CResult_RouteDecodeErrorZ in the error state.
10487 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_err(struct LDKDecodeError e);
10490 * Frees any resources used by the CResult_RouteDecodeErrorZ.
10492 void CResult_RouteDecodeErrorZ_free(struct LDKCResult_RouteDecodeErrorZ _res);
10495 * Creates a new CResult_RouteDecodeErrorZ which has the same data as `orig`
10496 * but with all dynamically-allocated buffers duplicated in new buffers.
10498 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_clone(const struct LDKCResult_RouteDecodeErrorZ *NONNULL_PTR orig);
10501 * Constructs a new COption_u64Z containing a u64
10503 struct LDKCOption_u64Z COption_u64Z_some(uint64_t o);
10506 * Constructs a new COption_u64Z containing nothing
10508 struct LDKCOption_u64Z COption_u64Z_none(void);
10511 * Frees any resources associated with the u64, if we are in the Some state
10513 void COption_u64Z_free(struct LDKCOption_u64Z _res);
10516 * Creates a new COption_u64Z which has the same data as `orig`
10517 * but with all dynamically-allocated buffers duplicated in new buffers.
10519 struct LDKCOption_u64Z COption_u64Z_clone(const struct LDKCOption_u64Z *NONNULL_PTR orig);
10522 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10524 void CVec_ChannelDetailsZ_free(struct LDKCVec_ChannelDetailsZ _res);
10527 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10529 void CVec_RouteHintZ_free(struct LDKCVec_RouteHintZ _res);
10532 * Creates a new CResult_RouteLightningErrorZ in the success state.
10534 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_ok(struct LDKRoute o);
10537 * Creates a new CResult_RouteLightningErrorZ in the error state.
10539 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_err(struct LDKLightningError e);
10542 * Frees any resources used by the CResult_RouteLightningErrorZ.
10544 void CResult_RouteLightningErrorZ_free(struct LDKCResult_RouteLightningErrorZ _res);
10547 * Creates a new CResult_RouteLightningErrorZ which has the same data as `orig`
10548 * but with all dynamically-allocated buffers duplicated in new buffers.
10550 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_clone(const struct LDKCResult_RouteLightningErrorZ *NONNULL_PTR orig);
10553 * Creates a new CResult_TxOutAccessErrorZ in the success state.
10555 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_ok(struct LDKTxOut o);
10558 * Creates a new CResult_TxOutAccessErrorZ in the error state.
10560 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_err(enum LDKAccessError e);
10563 * Frees any resources used by the CResult_TxOutAccessErrorZ.
10565 void CResult_TxOutAccessErrorZ_free(struct LDKCResult_TxOutAccessErrorZ _res);
10568 * Creates a new CResult_TxOutAccessErrorZ which has the same data as `orig`
10569 * but with all dynamically-allocated buffers duplicated in new buffers.
10571 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_clone(const struct LDKCResult_TxOutAccessErrorZ *NONNULL_PTR orig);
10574 * Creates a new tuple which has the same data as `orig`
10575 * but with all dynamically-allocated buffers duplicated in new buffers.
10577 struct LDKC2Tuple_usizeTransactionZ C2Tuple_usizeTransactionZ_clone(const struct LDKC2Tuple_usizeTransactionZ *NONNULL_PTR orig);
10580 * Creates a new C2Tuple_usizeTransactionZ from the contained elements.
10582 struct LDKC2Tuple_usizeTransactionZ C2Tuple_usizeTransactionZ_new(uintptr_t a, struct LDKTransaction b);
10585 * Frees any resources used by the C2Tuple_usizeTransactionZ.
10587 void C2Tuple_usizeTransactionZ_free(struct LDKC2Tuple_usizeTransactionZ _res);
10590 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10592 void CVec_C2Tuple_usizeTransactionZZ_free(struct LDKCVec_C2Tuple_usizeTransactionZZ _res);
10595 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10597 void CVec_TxidZ_free(struct LDKCVec_TxidZ _res);
10600 * Creates a new CResult_NoneChannelMonitorUpdateErrZ in the success state.
10602 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_ok(void);
10605 * Creates a new CResult_NoneChannelMonitorUpdateErrZ in the error state.
10607 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_err(enum LDKChannelMonitorUpdateErr e);
10610 * Frees any resources used by the CResult_NoneChannelMonitorUpdateErrZ.
10612 void CResult_NoneChannelMonitorUpdateErrZ_free(struct LDKCResult_NoneChannelMonitorUpdateErrZ _res);
10615 * Creates a new CResult_NoneChannelMonitorUpdateErrZ which has the same data as `orig`
10616 * but with all dynamically-allocated buffers duplicated in new buffers.
10618 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_clone(const struct LDKCResult_NoneChannelMonitorUpdateErrZ *NONNULL_PTR orig);
10621 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10623 void CVec_MonitorEventZ_free(struct LDKCVec_MonitorEventZ _res);
10626 * Constructs a new COption_C2Tuple_usizeTransactionZZ containing a crate::c_types::derived::C2Tuple_usizeTransactionZ
10628 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_some(struct LDKC2Tuple_usizeTransactionZ o);
10631 * Constructs a new COption_C2Tuple_usizeTransactionZZ containing nothing
10633 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_none(void);
10636 * Frees any resources associated with the crate::c_types::derived::C2Tuple_usizeTransactionZ, if we are in the Some state
10638 void COption_C2Tuple_usizeTransactionZZ_free(struct LDKCOption_C2Tuple_usizeTransactionZZ _res);
10641 * Creates a new COption_C2Tuple_usizeTransactionZZ which has the same data as `orig`
10642 * but with all dynamically-allocated buffers duplicated in new buffers.
10644 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_clone(const struct LDKCOption_C2Tuple_usizeTransactionZZ *NONNULL_PTR orig);
10647 * Constructs a new COption_NetworkUpdateZ containing a crate::lightning::routing::network_graph::NetworkUpdate
10649 struct LDKCOption_NetworkUpdateZ COption_NetworkUpdateZ_some(struct LDKNetworkUpdate o);
10652 * Constructs a new COption_NetworkUpdateZ containing nothing
10654 struct LDKCOption_NetworkUpdateZ COption_NetworkUpdateZ_none(void);
10657 * Frees any resources associated with the crate::lightning::routing::network_graph::NetworkUpdate, if we are in the Some state
10659 void COption_NetworkUpdateZ_free(struct LDKCOption_NetworkUpdateZ _res);
10662 * Creates a new COption_NetworkUpdateZ which has the same data as `orig`
10663 * but with all dynamically-allocated buffers duplicated in new buffers.
10665 struct LDKCOption_NetworkUpdateZ COption_NetworkUpdateZ_clone(const struct LDKCOption_NetworkUpdateZ *NONNULL_PTR orig);
10668 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10670 void CVec_SpendableOutputDescriptorZ_free(struct LDKCVec_SpendableOutputDescriptorZ _res);
10673 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10675 void CVec_MessageSendEventZ_free(struct LDKCVec_MessageSendEventZ _res);
10678 * Creates a new CResult_InitFeaturesDecodeErrorZ in the success state.
10680 struct LDKCResult_InitFeaturesDecodeErrorZ CResult_InitFeaturesDecodeErrorZ_ok(struct LDKInitFeatures o);
10683 * Creates a new CResult_InitFeaturesDecodeErrorZ in the error state.
10685 struct LDKCResult_InitFeaturesDecodeErrorZ CResult_InitFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
10688 * Frees any resources used by the CResult_InitFeaturesDecodeErrorZ.
10690 void CResult_InitFeaturesDecodeErrorZ_free(struct LDKCResult_InitFeaturesDecodeErrorZ _res);
10693 * Creates a new CResult_NodeFeaturesDecodeErrorZ in the success state.
10695 struct LDKCResult_NodeFeaturesDecodeErrorZ CResult_NodeFeaturesDecodeErrorZ_ok(struct LDKNodeFeatures o);
10698 * Creates a new CResult_NodeFeaturesDecodeErrorZ in the error state.
10700 struct LDKCResult_NodeFeaturesDecodeErrorZ CResult_NodeFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
10703 * Frees any resources used by the CResult_NodeFeaturesDecodeErrorZ.
10705 void CResult_NodeFeaturesDecodeErrorZ_free(struct LDKCResult_NodeFeaturesDecodeErrorZ _res);
10708 * Creates a new CResult_ChannelFeaturesDecodeErrorZ in the success state.
10710 struct LDKCResult_ChannelFeaturesDecodeErrorZ CResult_ChannelFeaturesDecodeErrorZ_ok(struct LDKChannelFeatures o);
10713 * Creates a new CResult_ChannelFeaturesDecodeErrorZ in the error state.
10715 struct LDKCResult_ChannelFeaturesDecodeErrorZ CResult_ChannelFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
10718 * Frees any resources used by the CResult_ChannelFeaturesDecodeErrorZ.
10720 void CResult_ChannelFeaturesDecodeErrorZ_free(struct LDKCResult_ChannelFeaturesDecodeErrorZ _res);
10723 * Creates a new CResult_InvoiceFeaturesDecodeErrorZ in the success state.
10725 struct LDKCResult_InvoiceFeaturesDecodeErrorZ CResult_InvoiceFeaturesDecodeErrorZ_ok(struct LDKInvoiceFeatures o);
10728 * Creates a new CResult_InvoiceFeaturesDecodeErrorZ in the error state.
10730 struct LDKCResult_InvoiceFeaturesDecodeErrorZ CResult_InvoiceFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
10733 * Frees any resources used by the CResult_InvoiceFeaturesDecodeErrorZ.
10735 void CResult_InvoiceFeaturesDecodeErrorZ_free(struct LDKCResult_InvoiceFeaturesDecodeErrorZ _res);
10738 * Creates a new CResult_DelayedPaymentOutputDescriptorDecodeErrorZ in the success state.
10740 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_ok(struct LDKDelayedPaymentOutputDescriptor o);
10743 * Creates a new CResult_DelayedPaymentOutputDescriptorDecodeErrorZ in the error state.
10745 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e);
10748 * Frees any resources used by the CResult_DelayedPaymentOutputDescriptorDecodeErrorZ.
10750 void CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_free(struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ _res);
10753 * Creates a new CResult_DelayedPaymentOutputDescriptorDecodeErrorZ which has the same data as `orig`
10754 * but with all dynamically-allocated buffers duplicated in new buffers.
10756 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ *NONNULL_PTR orig);
10759 * Creates a new CResult_StaticPaymentOutputDescriptorDecodeErrorZ in the success state.
10761 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ CResult_StaticPaymentOutputDescriptorDecodeErrorZ_ok(struct LDKStaticPaymentOutputDescriptor o);
10764 * Creates a new CResult_StaticPaymentOutputDescriptorDecodeErrorZ in the error state.
10766 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ CResult_StaticPaymentOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e);
10769 * Frees any resources used by the CResult_StaticPaymentOutputDescriptorDecodeErrorZ.
10771 void CResult_StaticPaymentOutputDescriptorDecodeErrorZ_free(struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ _res);
10774 * Creates a new CResult_StaticPaymentOutputDescriptorDecodeErrorZ which has the same data as `orig`
10775 * but with all dynamically-allocated buffers duplicated in new buffers.
10777 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ CResult_StaticPaymentOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ *NONNULL_PTR orig);
10780 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ in the success state.
10782 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_ok(struct LDKSpendableOutputDescriptor o);
10785 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ in the error state.
10787 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e);
10790 * Frees any resources used by the CResult_SpendableOutputDescriptorDecodeErrorZ.
10792 void CResult_SpendableOutputDescriptorDecodeErrorZ_free(struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ _res);
10795 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ which has the same data as `orig`
10796 * but with all dynamically-allocated buffers duplicated in new buffers.
10798 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ *NONNULL_PTR orig);
10801 * Creates a new CResult_NoneNoneZ in the success state.
10803 struct LDKCResult_NoneNoneZ CResult_NoneNoneZ_ok(void);
10806 * Creates a new CResult_NoneNoneZ in the error state.
10808 struct LDKCResult_NoneNoneZ CResult_NoneNoneZ_err(void);
10811 * Frees any resources used by the CResult_NoneNoneZ.
10813 void CResult_NoneNoneZ_free(struct LDKCResult_NoneNoneZ _res);
10816 * Creates a new CResult_NoneNoneZ which has the same data as `orig`
10817 * but with all dynamically-allocated buffers duplicated in new buffers.
10819 struct LDKCResult_NoneNoneZ CResult_NoneNoneZ_clone(const struct LDKCResult_NoneNoneZ *NONNULL_PTR orig);
10822 * Creates a new tuple which has the same data as `orig`
10823 * but with all dynamically-allocated buffers duplicated in new buffers.
10825 struct LDKC2Tuple_SignatureCVec_SignatureZZ C2Tuple_SignatureCVec_SignatureZZ_clone(const struct LDKC2Tuple_SignatureCVec_SignatureZZ *NONNULL_PTR orig);
10828 * Creates a new C2Tuple_SignatureCVec_SignatureZZ from the contained elements.
10830 struct LDKC2Tuple_SignatureCVec_SignatureZZ C2Tuple_SignatureCVec_SignatureZZ_new(struct LDKSignature a, struct LDKCVec_SignatureZ b);
10833 * Frees any resources used by the C2Tuple_SignatureCVec_SignatureZZ.
10835 void C2Tuple_SignatureCVec_SignatureZZ_free(struct LDKC2Tuple_SignatureCVec_SignatureZZ _res);
10838 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ in the success state.
10840 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_ok(struct LDKC2Tuple_SignatureCVec_SignatureZZ o);
10843 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ in the error state.
10845 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_err(void);
10848 * Frees any resources used by the CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ.
10850 void CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_free(struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ _res);
10853 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ which has the same data as `orig`
10854 * but with all dynamically-allocated buffers duplicated in new buffers.
10856 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_clone(const struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ *NONNULL_PTR orig);
10859 * Creates a new CResult_SignatureNoneZ in the success state.
10861 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_ok(struct LDKSignature o);
10864 * Creates a new CResult_SignatureNoneZ in the error state.
10866 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_err(void);
10869 * Frees any resources used by the CResult_SignatureNoneZ.
10871 void CResult_SignatureNoneZ_free(struct LDKCResult_SignatureNoneZ _res);
10874 * Creates a new CResult_SignatureNoneZ which has the same data as `orig`
10875 * but with all dynamically-allocated buffers duplicated in new buffers.
10877 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_clone(const struct LDKCResult_SignatureNoneZ *NONNULL_PTR orig);
10880 * Creates a new CResult_SignDecodeErrorZ in the success state.
10882 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_ok(struct LDKSign o);
10885 * Creates a new CResult_SignDecodeErrorZ in the error state.
10887 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_err(struct LDKDecodeError e);
10890 * Frees any resources used by the CResult_SignDecodeErrorZ.
10892 void CResult_SignDecodeErrorZ_free(struct LDKCResult_SignDecodeErrorZ _res);
10895 * Creates a new CResult_SignDecodeErrorZ which has the same data as `orig`
10896 * but with all dynamically-allocated buffers duplicated in new buffers.
10898 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_clone(const struct LDKCResult_SignDecodeErrorZ *NONNULL_PTR orig);
10901 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10903 void CVec_u8Z_free(struct LDKCVec_u8Z _res);
10906 * Creates a new CResult_RecoverableSignatureNoneZ in the success state.
10908 struct LDKCResult_RecoverableSignatureNoneZ CResult_RecoverableSignatureNoneZ_ok(struct LDKRecoverableSignature o);
10911 * Creates a new CResult_RecoverableSignatureNoneZ in the error state.
10913 struct LDKCResult_RecoverableSignatureNoneZ CResult_RecoverableSignatureNoneZ_err(void);
10916 * Frees any resources used by the CResult_RecoverableSignatureNoneZ.
10918 void CResult_RecoverableSignatureNoneZ_free(struct LDKCResult_RecoverableSignatureNoneZ _res);
10921 * Creates a new CResult_RecoverableSignatureNoneZ which has the same data as `orig`
10922 * but with all dynamically-allocated buffers duplicated in new buffers.
10924 struct LDKCResult_RecoverableSignatureNoneZ CResult_RecoverableSignatureNoneZ_clone(const struct LDKCResult_RecoverableSignatureNoneZ *NONNULL_PTR orig);
10927 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10929 void CVec_CVec_u8ZZ_free(struct LDKCVec_CVec_u8ZZ _res);
10932 * Creates a new CResult_CVec_CVec_u8ZZNoneZ in the success state.
10934 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_ok(struct LDKCVec_CVec_u8ZZ o);
10937 * Creates a new CResult_CVec_CVec_u8ZZNoneZ in the error state.
10939 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_err(void);
10942 * Frees any resources used by the CResult_CVec_CVec_u8ZZNoneZ.
10944 void CResult_CVec_CVec_u8ZZNoneZ_free(struct LDKCResult_CVec_CVec_u8ZZNoneZ _res);
10947 * Creates a new CResult_CVec_CVec_u8ZZNoneZ which has the same data as `orig`
10948 * but with all dynamically-allocated buffers duplicated in new buffers.
10950 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_clone(const struct LDKCResult_CVec_CVec_u8ZZNoneZ *NONNULL_PTR orig);
10953 * Creates a new CResult_InMemorySignerDecodeErrorZ in the success state.
10955 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_ok(struct LDKInMemorySigner o);
10958 * Creates a new CResult_InMemorySignerDecodeErrorZ in the error state.
10960 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_err(struct LDKDecodeError e);
10963 * Frees any resources used by the CResult_InMemorySignerDecodeErrorZ.
10965 void CResult_InMemorySignerDecodeErrorZ_free(struct LDKCResult_InMemorySignerDecodeErrorZ _res);
10968 * Creates a new CResult_InMemorySignerDecodeErrorZ which has the same data as `orig`
10969 * but with all dynamically-allocated buffers duplicated in new buffers.
10971 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_clone(const struct LDKCResult_InMemorySignerDecodeErrorZ *NONNULL_PTR orig);
10974 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10976 void CVec_TxOutZ_free(struct LDKCVec_TxOutZ _res);
10979 * Creates a new CResult_TransactionNoneZ in the success state.
10981 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_ok(struct LDKTransaction o);
10984 * Creates a new CResult_TransactionNoneZ in the error state.
10986 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_err(void);
10989 * Frees any resources used by the CResult_TransactionNoneZ.
10991 void CResult_TransactionNoneZ_free(struct LDKCResult_TransactionNoneZ _res);
10994 * Creates a new CResult_TransactionNoneZ which has the same data as `orig`
10995 * but with all dynamically-allocated buffers duplicated in new buffers.
10997 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_clone(const struct LDKCResult_TransactionNoneZ *NONNULL_PTR orig);
11000 * Creates a new C2Tuple_BlockHashChannelMonitorZ from the contained elements.
11002 struct LDKC2Tuple_BlockHashChannelMonitorZ C2Tuple_BlockHashChannelMonitorZ_new(struct LDKThirtyTwoBytes a, struct LDKChannelMonitor b);
11005 * Frees any resources used by the C2Tuple_BlockHashChannelMonitorZ.
11007 void C2Tuple_BlockHashChannelMonitorZ_free(struct LDKC2Tuple_BlockHashChannelMonitorZ _res);
11010 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11012 void CVec_C2Tuple_BlockHashChannelMonitorZZ_free(struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ _res);
11015 * Creates a new CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ in the success state.
11017 struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_ok(struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ o);
11020 * Creates a new CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ in the error state.
11022 struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_err(enum LDKIOError e);
11025 * Frees any resources used by the CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ.
11027 void CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_free(struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ _res);
11030 * Constructs a new COption_u16Z containing a u16
11032 struct LDKCOption_u16Z COption_u16Z_some(uint16_t o);
11035 * Constructs a new COption_u16Z containing nothing
11037 struct LDKCOption_u16Z COption_u16Z_none(void);
11040 * Frees any resources associated with the u16, if we are in the Some state
11042 void COption_u16Z_free(struct LDKCOption_u16Z _res);
11045 * Creates a new COption_u16Z which has the same data as `orig`
11046 * but with all dynamically-allocated buffers duplicated in new buffers.
11048 struct LDKCOption_u16Z COption_u16Z_clone(const struct LDKCOption_u16Z *NONNULL_PTR orig);
11051 * Creates a new CResult_NoneAPIErrorZ in the success state.
11053 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_ok(void);
11056 * Creates a new CResult_NoneAPIErrorZ in the error state.
11058 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_err(struct LDKAPIError e);
11061 * Frees any resources used by the CResult_NoneAPIErrorZ.
11063 void CResult_NoneAPIErrorZ_free(struct LDKCResult_NoneAPIErrorZ _res);
11066 * Creates a new CResult_NoneAPIErrorZ which has the same data as `orig`
11067 * but with all dynamically-allocated buffers duplicated in new buffers.
11069 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_clone(const struct LDKCResult_NoneAPIErrorZ *NONNULL_PTR orig);
11072 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11074 void CVec_CResult_NoneAPIErrorZZ_free(struct LDKCVec_CResult_NoneAPIErrorZZ _res);
11077 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11079 void CVec_APIErrorZ_free(struct LDKCVec_APIErrorZ _res);
11082 * Creates a new CResult_NonePaymentSendFailureZ in the success state.
11084 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_ok(void);
11087 * Creates a new CResult_NonePaymentSendFailureZ in the error state.
11089 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_err(struct LDKPaymentSendFailure e);
11092 * Frees any resources used by the CResult_NonePaymentSendFailureZ.
11094 void CResult_NonePaymentSendFailureZ_free(struct LDKCResult_NonePaymentSendFailureZ _res);
11097 * Creates a new CResult_NonePaymentSendFailureZ which has the same data as `orig`
11098 * but with all dynamically-allocated buffers duplicated in new buffers.
11100 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_clone(const struct LDKCResult_NonePaymentSendFailureZ *NONNULL_PTR orig);
11103 * Creates a new CResult_PaymentHashPaymentSendFailureZ in the success state.
11105 struct LDKCResult_PaymentHashPaymentSendFailureZ CResult_PaymentHashPaymentSendFailureZ_ok(struct LDKThirtyTwoBytes o);
11108 * Creates a new CResult_PaymentHashPaymentSendFailureZ in the error state.
11110 struct LDKCResult_PaymentHashPaymentSendFailureZ CResult_PaymentHashPaymentSendFailureZ_err(struct LDKPaymentSendFailure e);
11113 * Frees any resources used by the CResult_PaymentHashPaymentSendFailureZ.
11115 void CResult_PaymentHashPaymentSendFailureZ_free(struct LDKCResult_PaymentHashPaymentSendFailureZ _res);
11118 * Creates a new CResult_PaymentHashPaymentSendFailureZ which has the same data as `orig`
11119 * but with all dynamically-allocated buffers duplicated in new buffers.
11121 struct LDKCResult_PaymentHashPaymentSendFailureZ CResult_PaymentHashPaymentSendFailureZ_clone(const struct LDKCResult_PaymentHashPaymentSendFailureZ *NONNULL_PTR orig);
11124 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11126 void CVec_NetAddressZ_free(struct LDKCVec_NetAddressZ _res);
11129 * Creates a new tuple which has the same data as `orig`
11130 * but with all dynamically-allocated buffers duplicated in new buffers.
11132 struct LDKC2Tuple_PaymentHashPaymentSecretZ C2Tuple_PaymentHashPaymentSecretZ_clone(const struct LDKC2Tuple_PaymentHashPaymentSecretZ *NONNULL_PTR orig);
11135 * Creates a new C2Tuple_PaymentHashPaymentSecretZ from the contained elements.
11137 struct LDKC2Tuple_PaymentHashPaymentSecretZ C2Tuple_PaymentHashPaymentSecretZ_new(struct LDKThirtyTwoBytes a, struct LDKThirtyTwoBytes b);
11140 * Frees any resources used by the C2Tuple_PaymentHashPaymentSecretZ.
11142 void C2Tuple_PaymentHashPaymentSecretZ_free(struct LDKC2Tuple_PaymentHashPaymentSecretZ _res);
11145 * Creates a new CResult_PaymentSecretAPIErrorZ in the success state.
11147 struct LDKCResult_PaymentSecretAPIErrorZ CResult_PaymentSecretAPIErrorZ_ok(struct LDKThirtyTwoBytes o);
11150 * Creates a new CResult_PaymentSecretAPIErrorZ in the error state.
11152 struct LDKCResult_PaymentSecretAPIErrorZ CResult_PaymentSecretAPIErrorZ_err(struct LDKAPIError e);
11155 * Frees any resources used by the CResult_PaymentSecretAPIErrorZ.
11157 void CResult_PaymentSecretAPIErrorZ_free(struct LDKCResult_PaymentSecretAPIErrorZ _res);
11160 * Creates a new CResult_PaymentSecretAPIErrorZ which has the same data as `orig`
11161 * but with all dynamically-allocated buffers duplicated in new buffers.
11163 struct LDKCResult_PaymentSecretAPIErrorZ CResult_PaymentSecretAPIErrorZ_clone(const struct LDKCResult_PaymentSecretAPIErrorZ *NONNULL_PTR orig);
11166 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11168 void CVec_ChannelMonitorZ_free(struct LDKCVec_ChannelMonitorZ _res);
11171 * Creates a new C2Tuple_BlockHashChannelManagerZ from the contained elements.
11173 struct LDKC2Tuple_BlockHashChannelManagerZ C2Tuple_BlockHashChannelManagerZ_new(struct LDKThirtyTwoBytes a, struct LDKChannelManager b);
11176 * Frees any resources used by the C2Tuple_BlockHashChannelManagerZ.
11178 void C2Tuple_BlockHashChannelManagerZ_free(struct LDKC2Tuple_BlockHashChannelManagerZ _res);
11181 * Creates a new CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ in the success state.
11183 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_ok(struct LDKC2Tuple_BlockHashChannelManagerZ o);
11186 * Creates a new CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ in the error state.
11188 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_err(struct LDKDecodeError e);
11191 * Frees any resources used by the CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.
11193 void CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_free(struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ _res);
11196 * Creates a new CResult_ChannelConfigDecodeErrorZ in the success state.
11198 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_ok(struct LDKChannelConfig o);
11201 * Creates a new CResult_ChannelConfigDecodeErrorZ in the error state.
11203 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_err(struct LDKDecodeError e);
11206 * Frees any resources used by the CResult_ChannelConfigDecodeErrorZ.
11208 void CResult_ChannelConfigDecodeErrorZ_free(struct LDKCResult_ChannelConfigDecodeErrorZ _res);
11211 * Creates a new CResult_ChannelConfigDecodeErrorZ which has the same data as `orig`
11212 * but with all dynamically-allocated buffers duplicated in new buffers.
11214 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_clone(const struct LDKCResult_ChannelConfigDecodeErrorZ *NONNULL_PTR orig);
11217 * Creates a new CResult_OutPointDecodeErrorZ in the success state.
11219 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_ok(struct LDKOutPoint o);
11222 * Creates a new CResult_OutPointDecodeErrorZ in the error state.
11224 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_err(struct LDKDecodeError e);
11227 * Frees any resources used by the CResult_OutPointDecodeErrorZ.
11229 void CResult_OutPointDecodeErrorZ_free(struct LDKCResult_OutPointDecodeErrorZ _res);
11232 * Creates a new CResult_OutPointDecodeErrorZ which has the same data as `orig`
11233 * but with all dynamically-allocated buffers duplicated in new buffers.
11235 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_clone(const struct LDKCResult_OutPointDecodeErrorZ *NONNULL_PTR orig);
11238 * Constructs a new COption_TypeZ containing a crate::lightning::ln::wire::Type
11240 struct LDKCOption_TypeZ COption_TypeZ_some(struct LDKType o);
11243 * Constructs a new COption_TypeZ containing nothing
11245 struct LDKCOption_TypeZ COption_TypeZ_none(void);
11248 * Frees any resources associated with the crate::lightning::ln::wire::Type, if we are in the Some state
11250 void COption_TypeZ_free(struct LDKCOption_TypeZ _res);
11253 * Creates a new CResult_COption_TypeZDecodeErrorZ in the success state.
11255 struct LDKCResult_COption_TypeZDecodeErrorZ CResult_COption_TypeZDecodeErrorZ_ok(struct LDKCOption_TypeZ o);
11258 * Creates a new CResult_COption_TypeZDecodeErrorZ in the error state.
11260 struct LDKCResult_COption_TypeZDecodeErrorZ CResult_COption_TypeZDecodeErrorZ_err(struct LDKDecodeError e);
11263 * Frees any resources used by the CResult_COption_TypeZDecodeErrorZ.
11265 void CResult_COption_TypeZDecodeErrorZ_free(struct LDKCResult_COption_TypeZDecodeErrorZ _res);
11268 * Creates a new CResult_SiPrefixNoneZ in the success state.
11270 struct LDKCResult_SiPrefixNoneZ CResult_SiPrefixNoneZ_ok(enum LDKSiPrefix o);
11273 * Creates a new CResult_SiPrefixNoneZ in the error state.
11275 struct LDKCResult_SiPrefixNoneZ CResult_SiPrefixNoneZ_err(void);
11278 * Frees any resources used by the CResult_SiPrefixNoneZ.
11280 void CResult_SiPrefixNoneZ_free(struct LDKCResult_SiPrefixNoneZ _res);
11283 * Creates a new CResult_SiPrefixNoneZ which has the same data as `orig`
11284 * but with all dynamically-allocated buffers duplicated in new buffers.
11286 struct LDKCResult_SiPrefixNoneZ CResult_SiPrefixNoneZ_clone(const struct LDKCResult_SiPrefixNoneZ *NONNULL_PTR orig);
11289 * Creates a new CResult_InvoiceNoneZ in the success state.
11291 struct LDKCResult_InvoiceNoneZ CResult_InvoiceNoneZ_ok(struct LDKInvoice o);
11294 * Creates a new CResult_InvoiceNoneZ in the error state.
11296 struct LDKCResult_InvoiceNoneZ CResult_InvoiceNoneZ_err(void);
11299 * Frees any resources used by the CResult_InvoiceNoneZ.
11301 void CResult_InvoiceNoneZ_free(struct LDKCResult_InvoiceNoneZ _res);
11304 * Creates a new CResult_InvoiceNoneZ which has the same data as `orig`
11305 * but with all dynamically-allocated buffers duplicated in new buffers.
11307 struct LDKCResult_InvoiceNoneZ CResult_InvoiceNoneZ_clone(const struct LDKCResult_InvoiceNoneZ *NONNULL_PTR orig);
11310 * Creates a new CResult_SignedRawInvoiceNoneZ in the success state.
11312 struct LDKCResult_SignedRawInvoiceNoneZ CResult_SignedRawInvoiceNoneZ_ok(struct LDKSignedRawInvoice o);
11315 * Creates a new CResult_SignedRawInvoiceNoneZ in the error state.
11317 struct LDKCResult_SignedRawInvoiceNoneZ CResult_SignedRawInvoiceNoneZ_err(void);
11320 * Frees any resources used by the CResult_SignedRawInvoiceNoneZ.
11322 void CResult_SignedRawInvoiceNoneZ_free(struct LDKCResult_SignedRawInvoiceNoneZ _res);
11325 * Creates a new CResult_SignedRawInvoiceNoneZ which has the same data as `orig`
11326 * but with all dynamically-allocated buffers duplicated in new buffers.
11328 struct LDKCResult_SignedRawInvoiceNoneZ CResult_SignedRawInvoiceNoneZ_clone(const struct LDKCResult_SignedRawInvoiceNoneZ *NONNULL_PTR orig);
11331 * Creates a new tuple which has the same data as `orig`
11332 * but with all dynamically-allocated buffers duplicated in new buffers.
11334 struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ C3Tuple_RawInvoice_u832InvoiceSignatureZ_clone(const struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ *NONNULL_PTR orig);
11337 * Creates a new C3Tuple_RawInvoice_u832InvoiceSignatureZ from the contained elements.
11339 struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ C3Tuple_RawInvoice_u832InvoiceSignatureZ_new(struct LDKRawInvoice a, struct LDKThirtyTwoBytes b, struct LDKInvoiceSignature c);
11342 * Frees any resources used by the C3Tuple_RawInvoice_u832InvoiceSignatureZ.
11344 void C3Tuple_RawInvoice_u832InvoiceSignatureZ_free(struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ _res);
11347 * Creates a new CResult_PayeePubKeyErrorZ in the success state.
11349 struct LDKCResult_PayeePubKeyErrorZ CResult_PayeePubKeyErrorZ_ok(struct LDKPayeePubKey o);
11352 * Creates a new CResult_PayeePubKeyErrorZ in the error state.
11354 struct LDKCResult_PayeePubKeyErrorZ CResult_PayeePubKeyErrorZ_err(enum LDKSecp256k1Error e);
11357 * Frees any resources used by the CResult_PayeePubKeyErrorZ.
11359 void CResult_PayeePubKeyErrorZ_free(struct LDKCResult_PayeePubKeyErrorZ _res);
11362 * Creates a new CResult_PayeePubKeyErrorZ which has the same data as `orig`
11363 * but with all dynamically-allocated buffers duplicated in new buffers.
11365 struct LDKCResult_PayeePubKeyErrorZ CResult_PayeePubKeyErrorZ_clone(const struct LDKCResult_PayeePubKeyErrorZ *NONNULL_PTR orig);
11368 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11370 void CVec_PrivateRouteZ_free(struct LDKCVec_PrivateRouteZ _res);
11373 * Creates a new CResult_PositiveTimestampCreationErrorZ in the success state.
11375 struct LDKCResult_PositiveTimestampCreationErrorZ CResult_PositiveTimestampCreationErrorZ_ok(struct LDKPositiveTimestamp o);
11378 * Creates a new CResult_PositiveTimestampCreationErrorZ in the error state.
11380 struct LDKCResult_PositiveTimestampCreationErrorZ CResult_PositiveTimestampCreationErrorZ_err(enum LDKCreationError e);
11383 * Frees any resources used by the CResult_PositiveTimestampCreationErrorZ.
11385 void CResult_PositiveTimestampCreationErrorZ_free(struct LDKCResult_PositiveTimestampCreationErrorZ _res);
11388 * Creates a new CResult_PositiveTimestampCreationErrorZ which has the same data as `orig`
11389 * but with all dynamically-allocated buffers duplicated in new buffers.
11391 struct LDKCResult_PositiveTimestampCreationErrorZ CResult_PositiveTimestampCreationErrorZ_clone(const struct LDKCResult_PositiveTimestampCreationErrorZ *NONNULL_PTR orig);
11394 * Creates a new CResult_NoneSemanticErrorZ in the success state.
11396 struct LDKCResult_NoneSemanticErrorZ CResult_NoneSemanticErrorZ_ok(void);
11399 * Creates a new CResult_NoneSemanticErrorZ in the error state.
11401 struct LDKCResult_NoneSemanticErrorZ CResult_NoneSemanticErrorZ_err(enum LDKSemanticError e);
11404 * Frees any resources used by the CResult_NoneSemanticErrorZ.
11406 void CResult_NoneSemanticErrorZ_free(struct LDKCResult_NoneSemanticErrorZ _res);
11409 * Creates a new CResult_NoneSemanticErrorZ which has the same data as `orig`
11410 * but with all dynamically-allocated buffers duplicated in new buffers.
11412 struct LDKCResult_NoneSemanticErrorZ CResult_NoneSemanticErrorZ_clone(const struct LDKCResult_NoneSemanticErrorZ *NONNULL_PTR orig);
11415 * Creates a new CResult_InvoiceSemanticErrorZ in the success state.
11417 struct LDKCResult_InvoiceSemanticErrorZ CResult_InvoiceSemanticErrorZ_ok(struct LDKInvoice o);
11420 * Creates a new CResult_InvoiceSemanticErrorZ in the error state.
11422 struct LDKCResult_InvoiceSemanticErrorZ CResult_InvoiceSemanticErrorZ_err(enum LDKSemanticError e);
11425 * Frees any resources used by the CResult_InvoiceSemanticErrorZ.
11427 void CResult_InvoiceSemanticErrorZ_free(struct LDKCResult_InvoiceSemanticErrorZ _res);
11430 * Creates a new CResult_InvoiceSemanticErrorZ which has the same data as `orig`
11431 * but with all dynamically-allocated buffers duplicated in new buffers.
11433 struct LDKCResult_InvoiceSemanticErrorZ CResult_InvoiceSemanticErrorZ_clone(const struct LDKCResult_InvoiceSemanticErrorZ *NONNULL_PTR orig);
11436 * Creates a new CResult_DescriptionCreationErrorZ in the success state.
11438 struct LDKCResult_DescriptionCreationErrorZ CResult_DescriptionCreationErrorZ_ok(struct LDKDescription o);
11441 * Creates a new CResult_DescriptionCreationErrorZ in the error state.
11443 struct LDKCResult_DescriptionCreationErrorZ CResult_DescriptionCreationErrorZ_err(enum LDKCreationError e);
11446 * Frees any resources used by the CResult_DescriptionCreationErrorZ.
11448 void CResult_DescriptionCreationErrorZ_free(struct LDKCResult_DescriptionCreationErrorZ _res);
11451 * Creates a new CResult_DescriptionCreationErrorZ which has the same data as `orig`
11452 * but with all dynamically-allocated buffers duplicated in new buffers.
11454 struct LDKCResult_DescriptionCreationErrorZ CResult_DescriptionCreationErrorZ_clone(const struct LDKCResult_DescriptionCreationErrorZ *NONNULL_PTR orig);
11457 * Creates a new CResult_ExpiryTimeCreationErrorZ in the success state.
11459 struct LDKCResult_ExpiryTimeCreationErrorZ CResult_ExpiryTimeCreationErrorZ_ok(struct LDKExpiryTime o);
11462 * Creates a new CResult_ExpiryTimeCreationErrorZ in the error state.
11464 struct LDKCResult_ExpiryTimeCreationErrorZ CResult_ExpiryTimeCreationErrorZ_err(enum LDKCreationError e);
11467 * Frees any resources used by the CResult_ExpiryTimeCreationErrorZ.
11469 void CResult_ExpiryTimeCreationErrorZ_free(struct LDKCResult_ExpiryTimeCreationErrorZ _res);
11472 * Creates a new CResult_ExpiryTimeCreationErrorZ which has the same data as `orig`
11473 * but with all dynamically-allocated buffers duplicated in new buffers.
11475 struct LDKCResult_ExpiryTimeCreationErrorZ CResult_ExpiryTimeCreationErrorZ_clone(const struct LDKCResult_ExpiryTimeCreationErrorZ *NONNULL_PTR orig);
11478 * Creates a new CResult_PrivateRouteCreationErrorZ in the success state.
11480 struct LDKCResult_PrivateRouteCreationErrorZ CResult_PrivateRouteCreationErrorZ_ok(struct LDKPrivateRoute o);
11483 * Creates a new CResult_PrivateRouteCreationErrorZ in the error state.
11485 struct LDKCResult_PrivateRouteCreationErrorZ CResult_PrivateRouteCreationErrorZ_err(enum LDKCreationError e);
11488 * Frees any resources used by the CResult_PrivateRouteCreationErrorZ.
11490 void CResult_PrivateRouteCreationErrorZ_free(struct LDKCResult_PrivateRouteCreationErrorZ _res);
11493 * Creates a new CResult_PrivateRouteCreationErrorZ which has the same data as `orig`
11494 * but with all dynamically-allocated buffers duplicated in new buffers.
11496 struct LDKCResult_PrivateRouteCreationErrorZ CResult_PrivateRouteCreationErrorZ_clone(const struct LDKCResult_PrivateRouteCreationErrorZ *NONNULL_PTR orig);
11499 * Creates a new CResult_StringErrorZ in the success state.
11501 struct LDKCResult_StringErrorZ CResult_StringErrorZ_ok(struct LDKStr o);
11504 * Creates a new CResult_StringErrorZ in the error state.
11506 struct LDKCResult_StringErrorZ CResult_StringErrorZ_err(enum LDKSecp256k1Error e);
11509 * Frees any resources used by the CResult_StringErrorZ.
11511 void CResult_StringErrorZ_free(struct LDKCResult_StringErrorZ _res);
11514 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ in the success state.
11516 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_ok(struct LDKChannelMonitorUpdate o);
11519 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ in the error state.
11521 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_err(struct LDKDecodeError e);
11524 * Frees any resources used by the CResult_ChannelMonitorUpdateDecodeErrorZ.
11526 void CResult_ChannelMonitorUpdateDecodeErrorZ_free(struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ _res);
11529 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ which has the same data as `orig`
11530 * but with all dynamically-allocated buffers duplicated in new buffers.
11532 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_clone(const struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ *NONNULL_PTR orig);
11535 * Creates a new CResult_HTLCUpdateDecodeErrorZ in the success state.
11537 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_ok(struct LDKHTLCUpdate o);
11540 * Creates a new CResult_HTLCUpdateDecodeErrorZ in the error state.
11542 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_err(struct LDKDecodeError e);
11545 * Frees any resources used by the CResult_HTLCUpdateDecodeErrorZ.
11547 void CResult_HTLCUpdateDecodeErrorZ_free(struct LDKCResult_HTLCUpdateDecodeErrorZ _res);
11550 * Creates a new CResult_HTLCUpdateDecodeErrorZ which has the same data as `orig`
11551 * but with all dynamically-allocated buffers duplicated in new buffers.
11553 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_clone(const struct LDKCResult_HTLCUpdateDecodeErrorZ *NONNULL_PTR orig);
11556 * Creates a new CResult_NoneMonitorUpdateErrorZ in the success state.
11558 struct LDKCResult_NoneMonitorUpdateErrorZ CResult_NoneMonitorUpdateErrorZ_ok(void);
11561 * Creates a new CResult_NoneMonitorUpdateErrorZ in the error state.
11563 struct LDKCResult_NoneMonitorUpdateErrorZ CResult_NoneMonitorUpdateErrorZ_err(struct LDKMonitorUpdateError e);
11566 * Frees any resources used by the CResult_NoneMonitorUpdateErrorZ.
11568 void CResult_NoneMonitorUpdateErrorZ_free(struct LDKCResult_NoneMonitorUpdateErrorZ _res);
11571 * Creates a new CResult_NoneMonitorUpdateErrorZ which has the same data as `orig`
11572 * but with all dynamically-allocated buffers duplicated in new buffers.
11574 struct LDKCResult_NoneMonitorUpdateErrorZ CResult_NoneMonitorUpdateErrorZ_clone(const struct LDKCResult_NoneMonitorUpdateErrorZ *NONNULL_PTR orig);
11577 * Creates a new tuple which has the same data as `orig`
11578 * but with all dynamically-allocated buffers duplicated in new buffers.
11580 struct LDKC2Tuple_OutPointScriptZ C2Tuple_OutPointScriptZ_clone(const struct LDKC2Tuple_OutPointScriptZ *NONNULL_PTR orig);
11583 * Creates a new C2Tuple_OutPointScriptZ from the contained elements.
11585 struct LDKC2Tuple_OutPointScriptZ C2Tuple_OutPointScriptZ_new(struct LDKOutPoint a, struct LDKCVec_u8Z b);
11588 * Frees any resources used by the C2Tuple_OutPointScriptZ.
11590 void C2Tuple_OutPointScriptZ_free(struct LDKC2Tuple_OutPointScriptZ _res);
11593 * Creates a new tuple which has the same data as `orig`
11594 * but with all dynamically-allocated buffers duplicated in new buffers.
11596 struct LDKC2Tuple_u32ScriptZ C2Tuple_u32ScriptZ_clone(const struct LDKC2Tuple_u32ScriptZ *NONNULL_PTR orig);
11599 * Creates a new C2Tuple_u32ScriptZ from the contained elements.
11601 struct LDKC2Tuple_u32ScriptZ C2Tuple_u32ScriptZ_new(uint32_t a, struct LDKCVec_u8Z b);
11604 * Frees any resources used by the C2Tuple_u32ScriptZ.
11606 void C2Tuple_u32ScriptZ_free(struct LDKC2Tuple_u32ScriptZ _res);
11609 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11611 void CVec_C2Tuple_u32ScriptZZ_free(struct LDKCVec_C2Tuple_u32ScriptZZ _res);
11614 * Creates a new tuple which has the same data as `orig`
11615 * but with all dynamically-allocated buffers duplicated in new buffers.
11617 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_clone(const struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ *NONNULL_PTR orig);
11620 * Creates a new C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ from the contained elements.
11622 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_new(struct LDKThirtyTwoBytes a, struct LDKCVec_C2Tuple_u32ScriptZZ b);
11625 * Frees any resources used by the C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ.
11627 void C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_free(struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ _res);
11630 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11632 void CVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ_free(struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ _res);
11635 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11637 void CVec_EventZ_free(struct LDKCVec_EventZ _res);
11640 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11642 void CVec_TransactionZ_free(struct LDKCVec_TransactionZ _res);
11645 * Creates a new tuple which has the same data as `orig`
11646 * but with all dynamically-allocated buffers duplicated in new buffers.
11648 struct LDKC2Tuple_u32TxOutZ C2Tuple_u32TxOutZ_clone(const struct LDKC2Tuple_u32TxOutZ *NONNULL_PTR orig);
11651 * Creates a new C2Tuple_u32TxOutZ from the contained elements.
11653 struct LDKC2Tuple_u32TxOutZ C2Tuple_u32TxOutZ_new(uint32_t a, struct LDKTxOut b);
11656 * Frees any resources used by the C2Tuple_u32TxOutZ.
11658 void C2Tuple_u32TxOutZ_free(struct LDKC2Tuple_u32TxOutZ _res);
11661 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11663 void CVec_C2Tuple_u32TxOutZZ_free(struct LDKCVec_C2Tuple_u32TxOutZZ _res);
11666 * Creates a new tuple which has the same data as `orig`
11667 * but with all dynamically-allocated buffers duplicated in new buffers.
11669 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_clone(const struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ *NONNULL_PTR orig);
11672 * Creates a new C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ from the contained elements.
11674 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_new(struct LDKThirtyTwoBytes a, struct LDKCVec_C2Tuple_u32TxOutZZ b);
11677 * Frees any resources used by the C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ.
11679 void C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_free(struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ _res);
11682 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11684 void CVec_TransactionOutputsZ_free(struct LDKCVec_TransactionOutputsZ _res);
11687 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11689 void CVec_BalanceZ_free(struct LDKCVec_BalanceZ _res);
11692 * Creates a new CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ in the success state.
11694 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_ok(struct LDKC2Tuple_BlockHashChannelMonitorZ o);
11697 * Creates a new CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ in the error state.
11699 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_err(struct LDKDecodeError e);
11702 * Frees any resources used by the CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.
11704 void CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_free(struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ _res);
11707 * Creates a new CResult_NoneLightningErrorZ in the success state.
11709 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_ok(void);
11712 * Creates a new CResult_NoneLightningErrorZ in the error state.
11714 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_err(struct LDKLightningError e);
11717 * Frees any resources used by the CResult_NoneLightningErrorZ.
11719 void CResult_NoneLightningErrorZ_free(struct LDKCResult_NoneLightningErrorZ _res);
11722 * Creates a new CResult_NoneLightningErrorZ which has the same data as `orig`
11723 * but with all dynamically-allocated buffers duplicated in new buffers.
11725 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_clone(const struct LDKCResult_NoneLightningErrorZ *NONNULL_PTR orig);
11728 * Creates a new C2Tuple_PublicKeyTypeZ from the contained elements.
11730 struct LDKC2Tuple_PublicKeyTypeZ C2Tuple_PublicKeyTypeZ_new(struct LDKPublicKey a, struct LDKType b);
11733 * Frees any resources used by the C2Tuple_PublicKeyTypeZ.
11735 void C2Tuple_PublicKeyTypeZ_free(struct LDKC2Tuple_PublicKeyTypeZ _res);
11738 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11740 void CVec_C2Tuple_PublicKeyTypeZZ_free(struct LDKCVec_C2Tuple_PublicKeyTypeZZ _res);
11743 * Creates a new CResult_boolLightningErrorZ in the success state.
11745 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_ok(bool o);
11748 * Creates a new CResult_boolLightningErrorZ in the error state.
11750 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_err(struct LDKLightningError e);
11753 * Frees any resources used by the CResult_boolLightningErrorZ.
11755 void CResult_boolLightningErrorZ_free(struct LDKCResult_boolLightningErrorZ _res);
11758 * Creates a new CResult_boolLightningErrorZ which has the same data as `orig`
11759 * but with all dynamically-allocated buffers duplicated in new buffers.
11761 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_clone(const struct LDKCResult_boolLightningErrorZ *NONNULL_PTR orig);
11764 * Creates a new tuple which has the same data as `orig`
11765 * but with all dynamically-allocated buffers duplicated in new buffers.
11767 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_clone(const struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ *NONNULL_PTR orig);
11770 * Creates a new C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ from the contained elements.
11772 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_new(struct LDKChannelAnnouncement a, struct LDKChannelUpdate b, struct LDKChannelUpdate c);
11775 * Frees any resources used by the C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ.
11777 void C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_free(struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ _res);
11780 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11782 void CVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ_free(struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ _res);
11785 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11787 void CVec_NodeAnnouncementZ_free(struct LDKCVec_NodeAnnouncementZ _res);
11790 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11792 void CVec_PublicKeyZ_free(struct LDKCVec_PublicKeyZ _res);
11795 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ in the success state.
11797 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_ok(struct LDKCVec_u8Z o);
11800 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ in the error state.
11802 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_err(struct LDKPeerHandleError e);
11805 * Frees any resources used by the CResult_CVec_u8ZPeerHandleErrorZ.
11807 void CResult_CVec_u8ZPeerHandleErrorZ_free(struct LDKCResult_CVec_u8ZPeerHandleErrorZ _res);
11810 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ which has the same data as `orig`
11811 * but with all dynamically-allocated buffers duplicated in new buffers.
11813 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_clone(const struct LDKCResult_CVec_u8ZPeerHandleErrorZ *NONNULL_PTR orig);
11816 * Creates a new CResult_NonePeerHandleErrorZ in the success state.
11818 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_ok(void);
11821 * Creates a new CResult_NonePeerHandleErrorZ in the error state.
11823 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_err(struct LDKPeerHandleError e);
11826 * Frees any resources used by the CResult_NonePeerHandleErrorZ.
11828 void CResult_NonePeerHandleErrorZ_free(struct LDKCResult_NonePeerHandleErrorZ _res);
11831 * Creates a new CResult_NonePeerHandleErrorZ which has the same data as `orig`
11832 * but with all dynamically-allocated buffers duplicated in new buffers.
11834 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_clone(const struct LDKCResult_NonePeerHandleErrorZ *NONNULL_PTR orig);
11837 * Creates a new CResult_boolPeerHandleErrorZ in the success state.
11839 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_ok(bool o);
11842 * Creates a new CResult_boolPeerHandleErrorZ in the error state.
11844 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_err(struct LDKPeerHandleError e);
11847 * Frees any resources used by the CResult_boolPeerHandleErrorZ.
11849 void CResult_boolPeerHandleErrorZ_free(struct LDKCResult_boolPeerHandleErrorZ _res);
11852 * Creates a new CResult_boolPeerHandleErrorZ which has the same data as `orig`
11853 * but with all dynamically-allocated buffers duplicated in new buffers.
11855 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_clone(const struct LDKCResult_boolPeerHandleErrorZ *NONNULL_PTR orig);
11858 * Constructs a new COption_AccessZ containing a crate::lightning::chain::Access
11860 struct LDKCOption_AccessZ COption_AccessZ_some(struct LDKAccess o);
11863 * Constructs a new COption_AccessZ containing nothing
11865 struct LDKCOption_AccessZ COption_AccessZ_none(void);
11868 * Frees any resources associated with the crate::lightning::chain::Access, if we are in the Some state
11870 void COption_AccessZ_free(struct LDKCOption_AccessZ _res);
11873 * Creates a new CResult_DirectionalChannelInfoDecodeErrorZ in the success state.
11875 struct LDKCResult_DirectionalChannelInfoDecodeErrorZ CResult_DirectionalChannelInfoDecodeErrorZ_ok(struct LDKDirectionalChannelInfo o);
11878 * Creates a new CResult_DirectionalChannelInfoDecodeErrorZ in the error state.
11880 struct LDKCResult_DirectionalChannelInfoDecodeErrorZ CResult_DirectionalChannelInfoDecodeErrorZ_err(struct LDKDecodeError e);
11883 * Frees any resources used by the CResult_DirectionalChannelInfoDecodeErrorZ.
11885 void CResult_DirectionalChannelInfoDecodeErrorZ_free(struct LDKCResult_DirectionalChannelInfoDecodeErrorZ _res);
11888 * Creates a new CResult_DirectionalChannelInfoDecodeErrorZ which has the same data as `orig`
11889 * but with all dynamically-allocated buffers duplicated in new buffers.
11891 struct LDKCResult_DirectionalChannelInfoDecodeErrorZ CResult_DirectionalChannelInfoDecodeErrorZ_clone(const struct LDKCResult_DirectionalChannelInfoDecodeErrorZ *NONNULL_PTR orig);
11894 * Creates a new CResult_ChannelInfoDecodeErrorZ in the success state.
11896 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_ok(struct LDKChannelInfo o);
11899 * Creates a new CResult_ChannelInfoDecodeErrorZ in the error state.
11901 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_err(struct LDKDecodeError e);
11904 * Frees any resources used by the CResult_ChannelInfoDecodeErrorZ.
11906 void CResult_ChannelInfoDecodeErrorZ_free(struct LDKCResult_ChannelInfoDecodeErrorZ _res);
11909 * Creates a new CResult_ChannelInfoDecodeErrorZ which has the same data as `orig`
11910 * but with all dynamically-allocated buffers duplicated in new buffers.
11912 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_clone(const struct LDKCResult_ChannelInfoDecodeErrorZ *NONNULL_PTR orig);
11915 * Creates a new CResult_RoutingFeesDecodeErrorZ in the success state.
11917 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_ok(struct LDKRoutingFees o);
11920 * Creates a new CResult_RoutingFeesDecodeErrorZ in the error state.
11922 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_err(struct LDKDecodeError e);
11925 * Frees any resources used by the CResult_RoutingFeesDecodeErrorZ.
11927 void CResult_RoutingFeesDecodeErrorZ_free(struct LDKCResult_RoutingFeesDecodeErrorZ _res);
11930 * Creates a new CResult_RoutingFeesDecodeErrorZ which has the same data as `orig`
11931 * but with all dynamically-allocated buffers duplicated in new buffers.
11933 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_clone(const struct LDKCResult_RoutingFeesDecodeErrorZ *NONNULL_PTR orig);
11936 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ in the success state.
11938 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_ok(struct LDKNodeAnnouncementInfo o);
11941 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ in the error state.
11943 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_err(struct LDKDecodeError e);
11946 * Frees any resources used by the CResult_NodeAnnouncementInfoDecodeErrorZ.
11948 void CResult_NodeAnnouncementInfoDecodeErrorZ_free(struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ _res);
11951 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ which has the same data as `orig`
11952 * but with all dynamically-allocated buffers duplicated in new buffers.
11954 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_clone(const struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ *NONNULL_PTR orig);
11957 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11959 void CVec_u64Z_free(struct LDKCVec_u64Z _res);
11962 * Creates a new CResult_NodeInfoDecodeErrorZ in the success state.
11964 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_ok(struct LDKNodeInfo o);
11967 * Creates a new CResult_NodeInfoDecodeErrorZ in the error state.
11969 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_err(struct LDKDecodeError e);
11972 * Frees any resources used by the CResult_NodeInfoDecodeErrorZ.
11974 void CResult_NodeInfoDecodeErrorZ_free(struct LDKCResult_NodeInfoDecodeErrorZ _res);
11977 * Creates a new CResult_NodeInfoDecodeErrorZ which has the same data as `orig`
11978 * but with all dynamically-allocated buffers duplicated in new buffers.
11980 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_clone(const struct LDKCResult_NodeInfoDecodeErrorZ *NONNULL_PTR orig);
11983 * Creates a new CResult_NetworkGraphDecodeErrorZ in the success state.
11985 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_ok(struct LDKNetworkGraph o);
11988 * Creates a new CResult_NetworkGraphDecodeErrorZ in the error state.
11990 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_err(struct LDKDecodeError e);
11993 * Frees any resources used by the CResult_NetworkGraphDecodeErrorZ.
11995 void CResult_NetworkGraphDecodeErrorZ_free(struct LDKCResult_NetworkGraphDecodeErrorZ _res);
11998 * Creates a new CResult_NetAddressu8Z in the success state.
12000 struct LDKCResult_NetAddressu8Z CResult_NetAddressu8Z_ok(struct LDKNetAddress o);
12003 * Creates a new CResult_NetAddressu8Z in the error state.
12005 struct LDKCResult_NetAddressu8Z CResult_NetAddressu8Z_err(uint8_t e);
12008 * Frees any resources used by the CResult_NetAddressu8Z.
12010 void CResult_NetAddressu8Z_free(struct LDKCResult_NetAddressu8Z _res);
12013 * Creates a new CResult_NetAddressu8Z which has the same data as `orig`
12014 * but with all dynamically-allocated buffers duplicated in new buffers.
12016 struct LDKCResult_NetAddressu8Z CResult_NetAddressu8Z_clone(const struct LDKCResult_NetAddressu8Z *NONNULL_PTR orig);
12019 * Creates a new CResult_CResult_NetAddressu8ZDecodeErrorZ in the success state.
12021 struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ CResult_CResult_NetAddressu8ZDecodeErrorZ_ok(struct LDKCResult_NetAddressu8Z o);
12024 * Creates a new CResult_CResult_NetAddressu8ZDecodeErrorZ in the error state.
12026 struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ CResult_CResult_NetAddressu8ZDecodeErrorZ_err(struct LDKDecodeError e);
12029 * Frees any resources used by the CResult_CResult_NetAddressu8ZDecodeErrorZ.
12031 void CResult_CResult_NetAddressu8ZDecodeErrorZ_free(struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ _res);
12034 * Creates a new CResult_CResult_NetAddressu8ZDecodeErrorZ which has the same data as `orig`
12035 * but with all dynamically-allocated buffers duplicated in new buffers.
12037 struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ CResult_CResult_NetAddressu8ZDecodeErrorZ_clone(const struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ *NONNULL_PTR orig);
12040 * Creates a new CResult_NetAddressDecodeErrorZ in the success state.
12042 struct LDKCResult_NetAddressDecodeErrorZ CResult_NetAddressDecodeErrorZ_ok(struct LDKNetAddress o);
12045 * Creates a new CResult_NetAddressDecodeErrorZ in the error state.
12047 struct LDKCResult_NetAddressDecodeErrorZ CResult_NetAddressDecodeErrorZ_err(struct LDKDecodeError e);
12050 * Frees any resources used by the CResult_NetAddressDecodeErrorZ.
12052 void CResult_NetAddressDecodeErrorZ_free(struct LDKCResult_NetAddressDecodeErrorZ _res);
12055 * Creates a new CResult_NetAddressDecodeErrorZ which has the same data as `orig`
12056 * but with all dynamically-allocated buffers duplicated in new buffers.
12058 struct LDKCResult_NetAddressDecodeErrorZ CResult_NetAddressDecodeErrorZ_clone(const struct LDKCResult_NetAddressDecodeErrorZ *NONNULL_PTR orig);
12061 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12063 void CVec_UpdateAddHTLCZ_free(struct LDKCVec_UpdateAddHTLCZ _res);
12066 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12068 void CVec_UpdateFulfillHTLCZ_free(struct LDKCVec_UpdateFulfillHTLCZ _res);
12071 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12073 void CVec_UpdateFailHTLCZ_free(struct LDKCVec_UpdateFailHTLCZ _res);
12076 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12078 void CVec_UpdateFailMalformedHTLCZ_free(struct LDKCVec_UpdateFailMalformedHTLCZ _res);
12081 * Creates a new CResult_AcceptChannelDecodeErrorZ in the success state.
12083 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_ok(struct LDKAcceptChannel o);
12086 * Creates a new CResult_AcceptChannelDecodeErrorZ in the error state.
12088 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_err(struct LDKDecodeError e);
12091 * Frees any resources used by the CResult_AcceptChannelDecodeErrorZ.
12093 void CResult_AcceptChannelDecodeErrorZ_free(struct LDKCResult_AcceptChannelDecodeErrorZ _res);
12096 * Creates a new CResult_AcceptChannelDecodeErrorZ which has the same data as `orig`
12097 * but with all dynamically-allocated buffers duplicated in new buffers.
12099 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_clone(const struct LDKCResult_AcceptChannelDecodeErrorZ *NONNULL_PTR orig);
12102 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ in the success state.
12104 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_ok(struct LDKAnnouncementSignatures o);
12107 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ in the error state.
12109 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_err(struct LDKDecodeError e);
12112 * Frees any resources used by the CResult_AnnouncementSignaturesDecodeErrorZ.
12114 void CResult_AnnouncementSignaturesDecodeErrorZ_free(struct LDKCResult_AnnouncementSignaturesDecodeErrorZ _res);
12117 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ which has the same data as `orig`
12118 * but with all dynamically-allocated buffers duplicated in new buffers.
12120 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_clone(const struct LDKCResult_AnnouncementSignaturesDecodeErrorZ *NONNULL_PTR orig);
12123 * Creates a new CResult_ChannelReestablishDecodeErrorZ in the success state.
12125 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_ok(struct LDKChannelReestablish o);
12128 * Creates a new CResult_ChannelReestablishDecodeErrorZ in the error state.
12130 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_err(struct LDKDecodeError e);
12133 * Frees any resources used by the CResult_ChannelReestablishDecodeErrorZ.
12135 void CResult_ChannelReestablishDecodeErrorZ_free(struct LDKCResult_ChannelReestablishDecodeErrorZ _res);
12138 * Creates a new CResult_ChannelReestablishDecodeErrorZ which has the same data as `orig`
12139 * but with all dynamically-allocated buffers duplicated in new buffers.
12141 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_clone(const struct LDKCResult_ChannelReestablishDecodeErrorZ *NONNULL_PTR orig);
12144 * Creates a new CResult_ClosingSignedDecodeErrorZ in the success state.
12146 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_ok(struct LDKClosingSigned o);
12149 * Creates a new CResult_ClosingSignedDecodeErrorZ in the error state.
12151 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_err(struct LDKDecodeError e);
12154 * Frees any resources used by the CResult_ClosingSignedDecodeErrorZ.
12156 void CResult_ClosingSignedDecodeErrorZ_free(struct LDKCResult_ClosingSignedDecodeErrorZ _res);
12159 * Creates a new CResult_ClosingSignedDecodeErrorZ which has the same data as `orig`
12160 * but with all dynamically-allocated buffers duplicated in new buffers.
12162 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_clone(const struct LDKCResult_ClosingSignedDecodeErrorZ *NONNULL_PTR orig);
12165 * Creates a new CResult_ClosingSignedFeeRangeDecodeErrorZ in the success state.
12167 struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ CResult_ClosingSignedFeeRangeDecodeErrorZ_ok(struct LDKClosingSignedFeeRange o);
12170 * Creates a new CResult_ClosingSignedFeeRangeDecodeErrorZ in the error state.
12172 struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ CResult_ClosingSignedFeeRangeDecodeErrorZ_err(struct LDKDecodeError e);
12175 * Frees any resources used by the CResult_ClosingSignedFeeRangeDecodeErrorZ.
12177 void CResult_ClosingSignedFeeRangeDecodeErrorZ_free(struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ _res);
12180 * Creates a new CResult_ClosingSignedFeeRangeDecodeErrorZ which has the same data as `orig`
12181 * but with all dynamically-allocated buffers duplicated in new buffers.
12183 struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ CResult_ClosingSignedFeeRangeDecodeErrorZ_clone(const struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ *NONNULL_PTR orig);
12186 * Creates a new CResult_CommitmentSignedDecodeErrorZ in the success state.
12188 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_ok(struct LDKCommitmentSigned o);
12191 * Creates a new CResult_CommitmentSignedDecodeErrorZ in the error state.
12193 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_err(struct LDKDecodeError e);
12196 * Frees any resources used by the CResult_CommitmentSignedDecodeErrorZ.
12198 void CResult_CommitmentSignedDecodeErrorZ_free(struct LDKCResult_CommitmentSignedDecodeErrorZ _res);
12201 * Creates a new CResult_CommitmentSignedDecodeErrorZ which has the same data as `orig`
12202 * but with all dynamically-allocated buffers duplicated in new buffers.
12204 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_clone(const struct LDKCResult_CommitmentSignedDecodeErrorZ *NONNULL_PTR orig);
12207 * Creates a new CResult_FundingCreatedDecodeErrorZ in the success state.
12209 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_ok(struct LDKFundingCreated o);
12212 * Creates a new CResult_FundingCreatedDecodeErrorZ in the error state.
12214 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_err(struct LDKDecodeError e);
12217 * Frees any resources used by the CResult_FundingCreatedDecodeErrorZ.
12219 void CResult_FundingCreatedDecodeErrorZ_free(struct LDKCResult_FundingCreatedDecodeErrorZ _res);
12222 * Creates a new CResult_FundingCreatedDecodeErrorZ which has the same data as `orig`
12223 * but with all dynamically-allocated buffers duplicated in new buffers.
12225 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_clone(const struct LDKCResult_FundingCreatedDecodeErrorZ *NONNULL_PTR orig);
12228 * Creates a new CResult_FundingSignedDecodeErrorZ in the success state.
12230 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_ok(struct LDKFundingSigned o);
12233 * Creates a new CResult_FundingSignedDecodeErrorZ in the error state.
12235 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_err(struct LDKDecodeError e);
12238 * Frees any resources used by the CResult_FundingSignedDecodeErrorZ.
12240 void CResult_FundingSignedDecodeErrorZ_free(struct LDKCResult_FundingSignedDecodeErrorZ _res);
12243 * Creates a new CResult_FundingSignedDecodeErrorZ which has the same data as `orig`
12244 * but with all dynamically-allocated buffers duplicated in new buffers.
12246 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_clone(const struct LDKCResult_FundingSignedDecodeErrorZ *NONNULL_PTR orig);
12249 * Creates a new CResult_FundingLockedDecodeErrorZ in the success state.
12251 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_ok(struct LDKFundingLocked o);
12254 * Creates a new CResult_FundingLockedDecodeErrorZ in the error state.
12256 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_err(struct LDKDecodeError e);
12259 * Frees any resources used by the CResult_FundingLockedDecodeErrorZ.
12261 void CResult_FundingLockedDecodeErrorZ_free(struct LDKCResult_FundingLockedDecodeErrorZ _res);
12264 * Creates a new CResult_FundingLockedDecodeErrorZ which has the same data as `orig`
12265 * but with all dynamically-allocated buffers duplicated in new buffers.
12267 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_clone(const struct LDKCResult_FundingLockedDecodeErrorZ *NONNULL_PTR orig);
12270 * Creates a new CResult_InitDecodeErrorZ in the success state.
12272 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_ok(struct LDKInit o);
12275 * Creates a new CResult_InitDecodeErrorZ in the error state.
12277 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_err(struct LDKDecodeError e);
12280 * Frees any resources used by the CResult_InitDecodeErrorZ.
12282 void CResult_InitDecodeErrorZ_free(struct LDKCResult_InitDecodeErrorZ _res);
12285 * Creates a new CResult_InitDecodeErrorZ which has the same data as `orig`
12286 * but with all dynamically-allocated buffers duplicated in new buffers.
12288 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_clone(const struct LDKCResult_InitDecodeErrorZ *NONNULL_PTR orig);
12291 * Creates a new CResult_OpenChannelDecodeErrorZ in the success state.
12293 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_ok(struct LDKOpenChannel o);
12296 * Creates a new CResult_OpenChannelDecodeErrorZ in the error state.
12298 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_err(struct LDKDecodeError e);
12301 * Frees any resources used by the CResult_OpenChannelDecodeErrorZ.
12303 void CResult_OpenChannelDecodeErrorZ_free(struct LDKCResult_OpenChannelDecodeErrorZ _res);
12306 * Creates a new CResult_OpenChannelDecodeErrorZ which has the same data as `orig`
12307 * but with all dynamically-allocated buffers duplicated in new buffers.
12309 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_clone(const struct LDKCResult_OpenChannelDecodeErrorZ *NONNULL_PTR orig);
12312 * Creates a new CResult_RevokeAndACKDecodeErrorZ in the success state.
12314 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_ok(struct LDKRevokeAndACK o);
12317 * Creates a new CResult_RevokeAndACKDecodeErrorZ in the error state.
12319 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_err(struct LDKDecodeError e);
12322 * Frees any resources used by the CResult_RevokeAndACKDecodeErrorZ.
12324 void CResult_RevokeAndACKDecodeErrorZ_free(struct LDKCResult_RevokeAndACKDecodeErrorZ _res);
12327 * Creates a new CResult_RevokeAndACKDecodeErrorZ which has the same data as `orig`
12328 * but with all dynamically-allocated buffers duplicated in new buffers.
12330 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_clone(const struct LDKCResult_RevokeAndACKDecodeErrorZ *NONNULL_PTR orig);
12333 * Creates a new CResult_ShutdownDecodeErrorZ in the success state.
12335 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_ok(struct LDKShutdown o);
12338 * Creates a new CResult_ShutdownDecodeErrorZ in the error state.
12340 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_err(struct LDKDecodeError e);
12343 * Frees any resources used by the CResult_ShutdownDecodeErrorZ.
12345 void CResult_ShutdownDecodeErrorZ_free(struct LDKCResult_ShutdownDecodeErrorZ _res);
12348 * Creates a new CResult_ShutdownDecodeErrorZ which has the same data as `orig`
12349 * but with all dynamically-allocated buffers duplicated in new buffers.
12351 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_clone(const struct LDKCResult_ShutdownDecodeErrorZ *NONNULL_PTR orig);
12354 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ in the success state.
12356 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_ok(struct LDKUpdateFailHTLC o);
12359 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ in the error state.
12361 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_err(struct LDKDecodeError e);
12364 * Frees any resources used by the CResult_UpdateFailHTLCDecodeErrorZ.
12366 void CResult_UpdateFailHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFailHTLCDecodeErrorZ _res);
12369 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ which has the same data as `orig`
12370 * but with all dynamically-allocated buffers duplicated in new buffers.
12372 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFailHTLCDecodeErrorZ *NONNULL_PTR orig);
12375 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ in the success state.
12377 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_ok(struct LDKUpdateFailMalformedHTLC o);
12380 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ in the error state.
12382 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_err(struct LDKDecodeError e);
12385 * Frees any resources used by the CResult_UpdateFailMalformedHTLCDecodeErrorZ.
12387 void CResult_UpdateFailMalformedHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ _res);
12390 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ which has the same data as `orig`
12391 * but with all dynamically-allocated buffers duplicated in new buffers.
12393 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ *NONNULL_PTR orig);
12396 * Creates a new CResult_UpdateFeeDecodeErrorZ in the success state.
12398 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_ok(struct LDKUpdateFee o);
12401 * Creates a new CResult_UpdateFeeDecodeErrorZ in the error state.
12403 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_err(struct LDKDecodeError e);
12406 * Frees any resources used by the CResult_UpdateFeeDecodeErrorZ.
12408 void CResult_UpdateFeeDecodeErrorZ_free(struct LDKCResult_UpdateFeeDecodeErrorZ _res);
12411 * Creates a new CResult_UpdateFeeDecodeErrorZ which has the same data as `orig`
12412 * but with all dynamically-allocated buffers duplicated in new buffers.
12414 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_clone(const struct LDKCResult_UpdateFeeDecodeErrorZ *NONNULL_PTR orig);
12417 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ in the success state.
12419 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_ok(struct LDKUpdateFulfillHTLC o);
12422 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ in the error state.
12424 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_err(struct LDKDecodeError e);
12427 * Frees any resources used by the CResult_UpdateFulfillHTLCDecodeErrorZ.
12429 void CResult_UpdateFulfillHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ _res);
12432 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ which has the same data as `orig`
12433 * but with all dynamically-allocated buffers duplicated in new buffers.
12435 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ *NONNULL_PTR orig);
12438 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ in the success state.
12440 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_ok(struct LDKUpdateAddHTLC o);
12443 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ in the error state.
12445 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_err(struct LDKDecodeError e);
12448 * Frees any resources used by the CResult_UpdateAddHTLCDecodeErrorZ.
12450 void CResult_UpdateAddHTLCDecodeErrorZ_free(struct LDKCResult_UpdateAddHTLCDecodeErrorZ _res);
12453 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ which has the same data as `orig`
12454 * but with all dynamically-allocated buffers duplicated in new buffers.
12456 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateAddHTLCDecodeErrorZ *NONNULL_PTR orig);
12459 * Creates a new CResult_PingDecodeErrorZ in the success state.
12461 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_ok(struct LDKPing o);
12464 * Creates a new CResult_PingDecodeErrorZ in the error state.
12466 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_err(struct LDKDecodeError e);
12469 * Frees any resources used by the CResult_PingDecodeErrorZ.
12471 void CResult_PingDecodeErrorZ_free(struct LDKCResult_PingDecodeErrorZ _res);
12474 * Creates a new CResult_PingDecodeErrorZ which has the same data as `orig`
12475 * but with all dynamically-allocated buffers duplicated in new buffers.
12477 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_clone(const struct LDKCResult_PingDecodeErrorZ *NONNULL_PTR orig);
12480 * Creates a new CResult_PongDecodeErrorZ in the success state.
12482 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_ok(struct LDKPong o);
12485 * Creates a new CResult_PongDecodeErrorZ in the error state.
12487 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_err(struct LDKDecodeError e);
12490 * Frees any resources used by the CResult_PongDecodeErrorZ.
12492 void CResult_PongDecodeErrorZ_free(struct LDKCResult_PongDecodeErrorZ _res);
12495 * Creates a new CResult_PongDecodeErrorZ which has the same data as `orig`
12496 * but with all dynamically-allocated buffers duplicated in new buffers.
12498 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_clone(const struct LDKCResult_PongDecodeErrorZ *NONNULL_PTR orig);
12501 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ in the success state.
12503 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_ok(struct LDKUnsignedChannelAnnouncement o);
12506 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ in the error state.
12508 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
12511 * Frees any resources used by the CResult_UnsignedChannelAnnouncementDecodeErrorZ.
12513 void CResult_UnsignedChannelAnnouncementDecodeErrorZ_free(struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ _res);
12516 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ which has the same data as `orig`
12517 * but with all dynamically-allocated buffers duplicated in new buffers.
12519 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_clone(const struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ *NONNULL_PTR orig);
12522 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ in the success state.
12524 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_ok(struct LDKChannelAnnouncement o);
12527 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ in the error state.
12529 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
12532 * Frees any resources used by the CResult_ChannelAnnouncementDecodeErrorZ.
12534 void CResult_ChannelAnnouncementDecodeErrorZ_free(struct LDKCResult_ChannelAnnouncementDecodeErrorZ _res);
12537 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ which has the same data as `orig`
12538 * but with all dynamically-allocated buffers duplicated in new buffers.
12540 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_clone(const struct LDKCResult_ChannelAnnouncementDecodeErrorZ *NONNULL_PTR orig);
12543 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ in the success state.
12545 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_ok(struct LDKUnsignedChannelUpdate o);
12548 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ in the error state.
12550 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_err(struct LDKDecodeError e);
12553 * Frees any resources used by the CResult_UnsignedChannelUpdateDecodeErrorZ.
12555 void CResult_UnsignedChannelUpdateDecodeErrorZ_free(struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ _res);
12558 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ which has the same data as `orig`
12559 * but with all dynamically-allocated buffers duplicated in new buffers.
12561 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_clone(const struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ *NONNULL_PTR orig);
12564 * Creates a new CResult_ChannelUpdateDecodeErrorZ in the success state.
12566 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_ok(struct LDKChannelUpdate o);
12569 * Creates a new CResult_ChannelUpdateDecodeErrorZ in the error state.
12571 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_err(struct LDKDecodeError e);
12574 * Frees any resources used by the CResult_ChannelUpdateDecodeErrorZ.
12576 void CResult_ChannelUpdateDecodeErrorZ_free(struct LDKCResult_ChannelUpdateDecodeErrorZ _res);
12579 * Creates a new CResult_ChannelUpdateDecodeErrorZ which has the same data as `orig`
12580 * but with all dynamically-allocated buffers duplicated in new buffers.
12582 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_clone(const struct LDKCResult_ChannelUpdateDecodeErrorZ *NONNULL_PTR orig);
12585 * Creates a new CResult_ErrorMessageDecodeErrorZ in the success state.
12587 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_ok(struct LDKErrorMessage o);
12590 * Creates a new CResult_ErrorMessageDecodeErrorZ in the error state.
12592 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_err(struct LDKDecodeError e);
12595 * Frees any resources used by the CResult_ErrorMessageDecodeErrorZ.
12597 void CResult_ErrorMessageDecodeErrorZ_free(struct LDKCResult_ErrorMessageDecodeErrorZ _res);
12600 * Creates a new CResult_ErrorMessageDecodeErrorZ which has the same data as `orig`
12601 * but with all dynamically-allocated buffers duplicated in new buffers.
12603 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_clone(const struct LDKCResult_ErrorMessageDecodeErrorZ *NONNULL_PTR orig);
12606 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ in the success state.
12608 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_ok(struct LDKUnsignedNodeAnnouncement o);
12611 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ in the error state.
12613 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
12616 * Frees any resources used by the CResult_UnsignedNodeAnnouncementDecodeErrorZ.
12618 void CResult_UnsignedNodeAnnouncementDecodeErrorZ_free(struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ _res);
12621 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ which has the same data as `orig`
12622 * but with all dynamically-allocated buffers duplicated in new buffers.
12624 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_clone(const struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ *NONNULL_PTR orig);
12627 * Creates a new CResult_NodeAnnouncementDecodeErrorZ in the success state.
12629 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_ok(struct LDKNodeAnnouncement o);
12632 * Creates a new CResult_NodeAnnouncementDecodeErrorZ in the error state.
12634 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
12637 * Frees any resources used by the CResult_NodeAnnouncementDecodeErrorZ.
12639 void CResult_NodeAnnouncementDecodeErrorZ_free(struct LDKCResult_NodeAnnouncementDecodeErrorZ _res);
12642 * Creates a new CResult_NodeAnnouncementDecodeErrorZ which has the same data as `orig`
12643 * but with all dynamically-allocated buffers duplicated in new buffers.
12645 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_clone(const struct LDKCResult_NodeAnnouncementDecodeErrorZ *NONNULL_PTR orig);
12648 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ in the success state.
12650 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_ok(struct LDKQueryShortChannelIds o);
12653 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ in the error state.
12655 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_err(struct LDKDecodeError e);
12658 * Frees any resources used by the CResult_QueryShortChannelIdsDecodeErrorZ.
12660 void CResult_QueryShortChannelIdsDecodeErrorZ_free(struct LDKCResult_QueryShortChannelIdsDecodeErrorZ _res);
12663 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ which has the same data as `orig`
12664 * but with all dynamically-allocated buffers duplicated in new buffers.
12666 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_clone(const struct LDKCResult_QueryShortChannelIdsDecodeErrorZ *NONNULL_PTR orig);
12669 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ in the success state.
12671 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_ok(struct LDKReplyShortChannelIdsEnd o);
12674 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ in the error state.
12676 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_err(struct LDKDecodeError e);
12679 * Frees any resources used by the CResult_ReplyShortChannelIdsEndDecodeErrorZ.
12681 void CResult_ReplyShortChannelIdsEndDecodeErrorZ_free(struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ _res);
12684 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ which has the same data as `orig`
12685 * but with all dynamically-allocated buffers duplicated in new buffers.
12687 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_clone(const struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ *NONNULL_PTR orig);
12690 * Creates a new CResult_QueryChannelRangeDecodeErrorZ in the success state.
12692 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_ok(struct LDKQueryChannelRange o);
12695 * Creates a new CResult_QueryChannelRangeDecodeErrorZ in the error state.
12697 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_err(struct LDKDecodeError e);
12700 * Frees any resources used by the CResult_QueryChannelRangeDecodeErrorZ.
12702 void CResult_QueryChannelRangeDecodeErrorZ_free(struct LDKCResult_QueryChannelRangeDecodeErrorZ _res);
12705 * Creates a new CResult_QueryChannelRangeDecodeErrorZ which has the same data as `orig`
12706 * but with all dynamically-allocated buffers duplicated in new buffers.
12708 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_clone(const struct LDKCResult_QueryChannelRangeDecodeErrorZ *NONNULL_PTR orig);
12711 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ in the success state.
12713 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_ok(struct LDKReplyChannelRange o);
12716 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ in the error state.
12718 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_err(struct LDKDecodeError e);
12721 * Frees any resources used by the CResult_ReplyChannelRangeDecodeErrorZ.
12723 void CResult_ReplyChannelRangeDecodeErrorZ_free(struct LDKCResult_ReplyChannelRangeDecodeErrorZ _res);
12726 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ which has the same data as `orig`
12727 * but with all dynamically-allocated buffers duplicated in new buffers.
12729 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_clone(const struct LDKCResult_ReplyChannelRangeDecodeErrorZ *NONNULL_PTR orig);
12732 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ in the success state.
12734 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_ok(struct LDKGossipTimestampFilter o);
12737 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ in the error state.
12739 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_err(struct LDKDecodeError e);
12742 * Frees any resources used by the CResult_GossipTimestampFilterDecodeErrorZ.
12744 void CResult_GossipTimestampFilterDecodeErrorZ_free(struct LDKCResult_GossipTimestampFilterDecodeErrorZ _res);
12747 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ which has the same data as `orig`
12748 * but with all dynamically-allocated buffers duplicated in new buffers.
12750 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_clone(const struct LDKCResult_GossipTimestampFilterDecodeErrorZ *NONNULL_PTR orig);
12753 * Creates a new CResult_InvoiceSignOrCreationErrorZ in the success state.
12755 struct LDKCResult_InvoiceSignOrCreationErrorZ CResult_InvoiceSignOrCreationErrorZ_ok(struct LDKInvoice o);
12758 * Creates a new CResult_InvoiceSignOrCreationErrorZ in the error state.
12760 struct LDKCResult_InvoiceSignOrCreationErrorZ CResult_InvoiceSignOrCreationErrorZ_err(struct LDKSignOrCreationError e);
12763 * Frees any resources used by the CResult_InvoiceSignOrCreationErrorZ.
12765 void CResult_InvoiceSignOrCreationErrorZ_free(struct LDKCResult_InvoiceSignOrCreationErrorZ _res);
12768 * Creates a new CResult_InvoiceSignOrCreationErrorZ which has the same data as `orig`
12769 * but with all dynamically-allocated buffers duplicated in new buffers.
12771 struct LDKCResult_InvoiceSignOrCreationErrorZ CResult_InvoiceSignOrCreationErrorZ_clone(const struct LDKCResult_InvoiceSignOrCreationErrorZ *NONNULL_PTR orig);
12774 * Constructs a new COption_FilterZ containing a crate::lightning::chain::Filter
12776 struct LDKCOption_FilterZ COption_FilterZ_some(struct LDKFilter o);
12779 * Constructs a new COption_FilterZ containing nothing
12781 struct LDKCOption_FilterZ COption_FilterZ_none(void);
12784 * Frees any resources associated with the crate::lightning::chain::Filter, if we are in the Some state
12786 void COption_FilterZ_free(struct LDKCOption_FilterZ _res);
12789 * Frees any resources used by the PaymentPurpose
12791 void PaymentPurpose_free(struct LDKPaymentPurpose this_ptr);
12794 * Creates a copy of the PaymentPurpose
12796 struct LDKPaymentPurpose PaymentPurpose_clone(const struct LDKPaymentPurpose *NONNULL_PTR orig);
12799 * Utility method to constructs a new InvoicePayment-variant PaymentPurpose
12801 struct LDKPaymentPurpose PaymentPurpose_invoice_payment(struct LDKThirtyTwoBytes payment_preimage, struct LDKThirtyTwoBytes payment_secret, uint64_t user_payment_id);
12804 * Utility method to constructs a new SpontaneousPayment-variant PaymentPurpose
12806 struct LDKPaymentPurpose PaymentPurpose_spontaneous_payment(struct LDKThirtyTwoBytes a);
12809 * Frees any resources used by the ClosureReason
12811 void ClosureReason_free(struct LDKClosureReason this_ptr);
12814 * Creates a copy of the ClosureReason
12816 struct LDKClosureReason ClosureReason_clone(const struct LDKClosureReason *NONNULL_PTR orig);
12819 * Utility method to constructs a new CounterpartyForceClosed-variant ClosureReason
12821 struct LDKClosureReason ClosureReason_counterparty_force_closed(struct LDKStr peer_msg);
12824 * Utility method to constructs a new HolderForceClosed-variant ClosureReason
12826 struct LDKClosureReason ClosureReason_holder_force_closed(void);
12829 * Utility method to constructs a new CooperativeClosure-variant ClosureReason
12831 struct LDKClosureReason ClosureReason_cooperative_closure(void);
12834 * Utility method to constructs a new CommitmentTxConfirmed-variant ClosureReason
12836 struct LDKClosureReason ClosureReason_commitment_tx_confirmed(void);
12839 * Utility method to constructs a new ProcessingError-variant ClosureReason
12841 struct LDKClosureReason ClosureReason_processing_error(struct LDKStr err);
12844 * Utility method to constructs a new DisconnectedPeer-variant ClosureReason
12846 struct LDKClosureReason ClosureReason_disconnected_peer(void);
12849 * Utility method to constructs a new OutdatedChannelManager-variant ClosureReason
12851 struct LDKClosureReason ClosureReason_outdated_channel_manager(void);
12854 * Serialize the ClosureReason object into a byte array which can be read by ClosureReason_read
12856 struct LDKCVec_u8Z ClosureReason_write(const struct LDKClosureReason *NONNULL_PTR obj);
12859 * Frees any resources used by the Event
12861 void Event_free(struct LDKEvent this_ptr);
12864 * Creates a copy of the Event
12866 struct LDKEvent Event_clone(const struct LDKEvent *NONNULL_PTR orig);
12869 * Utility method to constructs a new FundingGenerationReady-variant Event
12871 struct LDKEvent Event_funding_generation_ready(struct LDKThirtyTwoBytes temporary_channel_id, uint64_t channel_value_satoshis, struct LDKCVec_u8Z output_script, uint64_t user_channel_id);
12874 * Utility method to constructs a new PaymentReceived-variant Event
12876 struct LDKEvent Event_payment_received(struct LDKThirtyTwoBytes payment_hash, uint64_t amt, struct LDKPaymentPurpose purpose);
12879 * Utility method to constructs a new PaymentSent-variant Event
12881 struct LDKEvent Event_payment_sent(struct LDKThirtyTwoBytes payment_preimage);
12884 * Utility method to constructs a new PaymentPathFailed-variant Event
12886 struct LDKEvent Event_payment_path_failed(struct LDKThirtyTwoBytes payment_hash, bool rejected_by_dest, struct LDKCOption_NetworkUpdateZ network_update, bool all_paths_failed, struct LDKCVec_RouteHopZ path);
12889 * Utility method to constructs a new PendingHTLCsForwardable-variant Event
12891 struct LDKEvent Event_pending_htlcs_forwardable(uint64_t time_forwardable);
12894 * Utility method to constructs a new SpendableOutputs-variant Event
12896 struct LDKEvent Event_spendable_outputs(struct LDKCVec_SpendableOutputDescriptorZ outputs);
12899 * Utility method to constructs a new PaymentForwarded-variant Event
12901 struct LDKEvent Event_payment_forwarded(struct LDKCOption_u64Z fee_earned_msat, bool claim_from_onchain_tx);
12904 * Utility method to constructs a new ChannelClosed-variant Event
12906 struct LDKEvent Event_channel_closed(struct LDKThirtyTwoBytes channel_id, struct LDKClosureReason reason);
12909 * Serialize the Event object into a byte array which can be read by Event_read
12911 struct LDKCVec_u8Z Event_write(const struct LDKEvent *NONNULL_PTR obj);
12914 * Frees any resources used by the MessageSendEvent
12916 void MessageSendEvent_free(struct LDKMessageSendEvent this_ptr);
12919 * Creates a copy of the MessageSendEvent
12921 struct LDKMessageSendEvent MessageSendEvent_clone(const struct LDKMessageSendEvent *NONNULL_PTR orig);
12924 * Utility method to constructs a new SendAcceptChannel-variant MessageSendEvent
12926 struct LDKMessageSendEvent MessageSendEvent_send_accept_channel(struct LDKPublicKey node_id, struct LDKAcceptChannel msg);
12929 * Utility method to constructs a new SendOpenChannel-variant MessageSendEvent
12931 struct LDKMessageSendEvent MessageSendEvent_send_open_channel(struct LDKPublicKey node_id, struct LDKOpenChannel msg);
12934 * Utility method to constructs a new SendFundingCreated-variant MessageSendEvent
12936 struct LDKMessageSendEvent MessageSendEvent_send_funding_created(struct LDKPublicKey node_id, struct LDKFundingCreated msg);
12939 * Utility method to constructs a new SendFundingSigned-variant MessageSendEvent
12941 struct LDKMessageSendEvent MessageSendEvent_send_funding_signed(struct LDKPublicKey node_id, struct LDKFundingSigned msg);
12944 * Utility method to constructs a new SendFundingLocked-variant MessageSendEvent
12946 struct LDKMessageSendEvent MessageSendEvent_send_funding_locked(struct LDKPublicKey node_id, struct LDKFundingLocked msg);
12949 * Utility method to constructs a new SendAnnouncementSignatures-variant MessageSendEvent
12951 struct LDKMessageSendEvent MessageSendEvent_send_announcement_signatures(struct LDKPublicKey node_id, struct LDKAnnouncementSignatures msg);
12954 * Utility method to constructs a new UpdateHTLCs-variant MessageSendEvent
12956 struct LDKMessageSendEvent MessageSendEvent_update_htlcs(struct LDKPublicKey node_id, struct LDKCommitmentUpdate updates);
12959 * Utility method to constructs a new SendRevokeAndACK-variant MessageSendEvent
12961 struct LDKMessageSendEvent MessageSendEvent_send_revoke_and_ack(struct LDKPublicKey node_id, struct LDKRevokeAndACK msg);
12964 * Utility method to constructs a new SendClosingSigned-variant MessageSendEvent
12966 struct LDKMessageSendEvent MessageSendEvent_send_closing_signed(struct LDKPublicKey node_id, struct LDKClosingSigned msg);
12969 * Utility method to constructs a new SendShutdown-variant MessageSendEvent
12971 struct LDKMessageSendEvent MessageSendEvent_send_shutdown(struct LDKPublicKey node_id, struct LDKShutdown msg);
12974 * Utility method to constructs a new SendChannelReestablish-variant MessageSendEvent
12976 struct LDKMessageSendEvent MessageSendEvent_send_channel_reestablish(struct LDKPublicKey node_id, struct LDKChannelReestablish msg);
12979 * Utility method to constructs a new BroadcastChannelAnnouncement-variant MessageSendEvent
12981 struct LDKMessageSendEvent MessageSendEvent_broadcast_channel_announcement(struct LDKChannelAnnouncement msg, struct LDKChannelUpdate update_msg);
12984 * Utility method to constructs a new BroadcastNodeAnnouncement-variant MessageSendEvent
12986 struct LDKMessageSendEvent MessageSendEvent_broadcast_node_announcement(struct LDKNodeAnnouncement msg);
12989 * Utility method to constructs a new BroadcastChannelUpdate-variant MessageSendEvent
12991 struct LDKMessageSendEvent MessageSendEvent_broadcast_channel_update(struct LDKChannelUpdate msg);
12994 * Utility method to constructs a new SendChannelUpdate-variant MessageSendEvent
12996 struct LDKMessageSendEvent MessageSendEvent_send_channel_update(struct LDKPublicKey node_id, struct LDKChannelUpdate msg);
12999 * Utility method to constructs a new HandleError-variant MessageSendEvent
13001 struct LDKMessageSendEvent MessageSendEvent_handle_error(struct LDKPublicKey node_id, struct LDKErrorAction action);
13004 * Utility method to constructs a new SendChannelRangeQuery-variant MessageSendEvent
13006 struct LDKMessageSendEvent MessageSendEvent_send_channel_range_query(struct LDKPublicKey node_id, struct LDKQueryChannelRange msg);
13009 * Utility method to constructs a new SendShortIdsQuery-variant MessageSendEvent
13011 struct LDKMessageSendEvent MessageSendEvent_send_short_ids_query(struct LDKPublicKey node_id, struct LDKQueryShortChannelIds msg);
13014 * Utility method to constructs a new SendReplyChannelRange-variant MessageSendEvent
13016 struct LDKMessageSendEvent MessageSendEvent_send_reply_channel_range(struct LDKPublicKey node_id, struct LDKReplyChannelRange msg);
13019 * Calls the free function if one is set
13021 void MessageSendEventsProvider_free(struct LDKMessageSendEventsProvider this_ptr);
13024 * Calls the free function if one is set
13026 void EventsProvider_free(struct LDKEventsProvider this_ptr);
13029 * Calls the free function if one is set
13031 void EventHandler_free(struct LDKEventHandler this_ptr);
13034 * Frees any resources used by the APIError
13036 void APIError_free(struct LDKAPIError this_ptr);
13039 * Creates a copy of the APIError
13041 struct LDKAPIError APIError_clone(const struct LDKAPIError *NONNULL_PTR orig);
13044 * Utility method to constructs a new APIMisuseError-variant APIError
13046 struct LDKAPIError APIError_apimisuse_error(struct LDKStr err);
13049 * Utility method to constructs a new FeeRateTooHigh-variant APIError
13051 struct LDKAPIError APIError_fee_rate_too_high(struct LDKStr err, uint32_t feerate);
13054 * Utility method to constructs a new RouteError-variant APIError
13056 struct LDKAPIError APIError_route_error(struct LDKStr err);
13059 * Utility method to constructs a new ChannelUnavailable-variant APIError
13061 struct LDKAPIError APIError_channel_unavailable(struct LDKStr err);
13064 * Utility method to constructs a new MonitorUpdateFailed-variant APIError
13066 struct LDKAPIError APIError_monitor_update_failed(void);
13069 * Utility method to constructs a new IncompatibleShutdownScript-variant APIError
13071 struct LDKAPIError APIError_incompatible_shutdown_script(struct LDKShutdownScript script);
13074 * Creates a digital signature of a message given a SecretKey, like the node's secret.
13075 * 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.
13076 * Signatures are EC recoverable, meaning that given the message and the signature the PublicKey of the signer can be extracted.
13078 struct LDKCResult_StringErrorZ sign(struct LDKu8slice msg, const uint8_t (*sk)[32]);
13081 * Recovers the PublicKey of the signer of the message given the message and the signature.
13083 struct LDKCResult_PublicKeyErrorZ recover_pk(struct LDKu8slice msg, struct LDKStr sig);
13086 * Verifies a message was signed by a PrivateKey that derives to a given PublicKey, given a message, a signature,
13087 * and the PublicKey.
13089 bool verify(struct LDKu8slice msg, struct LDKStr sig, struct LDKPublicKey pk);
13092 * Creates a copy of the Level
13094 enum LDKLevel Level_clone(const enum LDKLevel *NONNULL_PTR orig);
13097 * Utility method to constructs a new Trace-variant Level
13099 enum LDKLevel Level_trace(void);
13102 * Utility method to constructs a new Debug-variant Level
13104 enum LDKLevel Level_debug(void);
13107 * Utility method to constructs a new Info-variant Level
13109 enum LDKLevel Level_info(void);
13112 * Utility method to constructs a new Warn-variant Level
13114 enum LDKLevel Level_warn(void);
13117 * Utility method to constructs a new Error-variant Level
13119 enum LDKLevel Level_error(void);
13122 * Checks if two Levels contain equal inner contents.
13123 * This ignores pointers and is_owned flags and looks at the values in fields.
13125 bool Level_eq(const enum LDKLevel *NONNULL_PTR a, const enum LDKLevel *NONNULL_PTR b);
13128 * Checks if two Levels contain equal inner contents.
13130 uint64_t Level_hash(const enum LDKLevel *NONNULL_PTR o);
13133 * Returns the most verbose logging level.
13135 MUST_USE_RES enum LDKLevel Level_max(void);
13138 * Calls the free function if one is set
13140 void Logger_free(struct LDKLogger this_ptr);
13143 * Frees any resources used by the ChannelHandshakeConfig, if is_owned is set and inner is non-NULL.
13145 void ChannelHandshakeConfig_free(struct LDKChannelHandshakeConfig this_obj);
13148 * Confirmations we will wait for before considering the channel locked in.
13149 * Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
13150 * equivalent limit applied to outbound channels).
13152 * Default value: 6.
13154 uint32_t ChannelHandshakeConfig_get_minimum_depth(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
13157 * Confirmations we will wait for before considering the channel locked in.
13158 * Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
13159 * equivalent limit applied to outbound channels).
13161 * Default value: 6.
13163 void ChannelHandshakeConfig_set_minimum_depth(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint32_t val);
13166 * Set to the number of blocks we require our counterparty to wait to claim their money (ie
13167 * the number of blocks we have to punish our counterparty if they broadcast a revoked
13170 * This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
13171 * be online to check for revoked transactions on-chain at least once every our_to_self_delay
13172 * blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
13173 * possibly with time in between to RBF the spending transaction).
13175 * Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
13176 * case of an honest unilateral channel close, which implicitly decrease the economic value of
13179 * Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
13180 * can tweak config to ask for more security, not less.
13182 uint16_t ChannelHandshakeConfig_get_our_to_self_delay(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
13185 * Set to the number of blocks we require our counterparty to wait to claim their money (ie
13186 * the number of blocks we have to punish our counterparty if they broadcast a revoked
13189 * This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
13190 * be online to check for revoked transactions on-chain at least once every our_to_self_delay
13191 * blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
13192 * possibly with time in between to RBF the spending transaction).
13194 * Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
13195 * case of an honest unilateral channel close, which implicitly decrease the economic value of
13198 * Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
13199 * can tweak config to ask for more security, not less.
13201 void ChannelHandshakeConfig_set_our_to_self_delay(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint16_t val);
13204 * Set to the smallest value HTLC we will accept to process.
13206 * This value is sent to our counterparty on channel-open and we close the channel any time
13207 * our counterparty misbehaves by sending us an HTLC with a value smaller than this.
13209 * Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
13212 uint64_t ChannelHandshakeConfig_get_our_htlc_minimum_msat(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
13215 * Set to the smallest value HTLC we will accept to process.
13217 * This value is sent to our counterparty on channel-open and we close the channel any time
13218 * our counterparty misbehaves by sending us an HTLC with a value smaller than this.
13220 * Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
13223 void ChannelHandshakeConfig_set_our_htlc_minimum_msat(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint64_t val);
13226 * Constructs a new ChannelHandshakeConfig given each field
13228 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);
13231 * Creates a copy of the ChannelHandshakeConfig
13233 struct LDKChannelHandshakeConfig ChannelHandshakeConfig_clone(const struct LDKChannelHandshakeConfig *NONNULL_PTR orig);
13236 * Creates a "default" ChannelHandshakeConfig. See struct and individual field documentaiton for details on which values are used.
13238 MUST_USE_RES struct LDKChannelHandshakeConfig ChannelHandshakeConfig_default(void);
13241 * Frees any resources used by the ChannelHandshakeLimits, if is_owned is set and inner is non-NULL.
13243 void ChannelHandshakeLimits_free(struct LDKChannelHandshakeLimits this_obj);
13246 * Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
13247 * only applies to inbound channels.
13249 * Default value: 0.
13251 uint64_t ChannelHandshakeLimits_get_min_funding_satoshis(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
13254 * Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
13255 * only applies to inbound channels.
13257 * Default value: 0.
13259 void ChannelHandshakeLimits_set_min_funding_satoshis(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
13262 * The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
13263 * you to limit the maximum minimum-size they can require.
13265 * Default value: u64::max_value.
13267 uint64_t ChannelHandshakeLimits_get_max_htlc_minimum_msat(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
13270 * The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
13271 * you to limit the maximum minimum-size they can require.
13273 * Default value: u64::max_value.
13275 void ChannelHandshakeLimits_set_max_htlc_minimum_msat(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
13278 * The remote node sets a limit on the maximum value of pending HTLCs to them at any given
13279 * time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
13281 * Default value: 0.
13283 uint64_t ChannelHandshakeLimits_get_min_max_htlc_value_in_flight_msat(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
13286 * The remote node sets a limit on the maximum value of pending HTLCs to them at any given
13287 * time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
13289 * Default value: 0.
13291 void ChannelHandshakeLimits_set_min_max_htlc_value_in_flight_msat(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
13294 * The remote node will require we keep a certain amount in direct payment to ourselves at all
13295 * time, ensuring that we are able to be punished if we broadcast an old state. This allows to
13296 * you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
13298 * Default value: u64::max_value.
13300 uint64_t ChannelHandshakeLimits_get_max_channel_reserve_satoshis(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
13303 * The remote node will require we keep a certain amount in direct payment to ourselves at all
13304 * time, ensuring that we are able to be punished if we broadcast an old state. This allows to
13305 * you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
13307 * Default value: u64::max_value.
13309 void ChannelHandshakeLimits_set_max_channel_reserve_satoshis(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
13312 * The remote node sets a limit on the maximum number of pending HTLCs to them at any given
13313 * time. This allows you to set a minimum such value.
13315 * Default value: 0.
13317 uint16_t ChannelHandshakeLimits_get_min_max_accepted_htlcs(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
13320 * The remote node sets a limit on the maximum number of pending HTLCs to them at any given
13321 * time. This allows you to set a minimum such value.
13323 * Default value: 0.
13325 void ChannelHandshakeLimits_set_min_max_accepted_htlcs(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint16_t val);
13328 * Before a channel is usable the funding transaction will need to be confirmed by at least a
13329 * certain number of blocks, specified by the node which is not the funder (as the funder can
13330 * assume they aren't going to double-spend themselves).
13331 * This config allows you to set a limit on the maximum amount of time to wait.
13333 * Default value: 144, or roughly one day and only applies to outbound channels.
13335 uint32_t ChannelHandshakeLimits_get_max_minimum_depth(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
13338 * Before a channel is usable the funding transaction will need to be confirmed by at least a
13339 * certain number of blocks, specified by the node which is not the funder (as the funder can
13340 * assume they aren't going to double-spend themselves).
13341 * This config allows you to set a limit on the maximum amount of time to wait.
13343 * Default value: 144, or roughly one day and only applies to outbound channels.
13345 void ChannelHandshakeLimits_set_max_minimum_depth(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint32_t val);
13348 * Set to force an incoming channel to match our announced channel preference in
13349 * [`ChannelConfig::announced_channel`].
13351 * For a node which is not online reliably, this should be set to true and
13352 * [`ChannelConfig::announced_channel`] set to false, ensuring that no announced (aka public)
13353 * channels will ever be opened.
13355 * Default value: true.
13357 bool ChannelHandshakeLimits_get_force_announced_channel_preference(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
13360 * Set to force an incoming channel to match our announced channel preference in
13361 * [`ChannelConfig::announced_channel`].
13363 * For a node which is not online reliably, this should be set to true and
13364 * [`ChannelConfig::announced_channel`] set to false, ensuring that no announced (aka public)
13365 * channels will ever be opened.
13367 * Default value: true.
13369 void ChannelHandshakeLimits_set_force_announced_channel_preference(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, bool val);
13372 * Set to the amount of time we're willing to wait to claim money back to us.
13374 * Not checking this value would be a security issue, as our peer would be able to set it to
13375 * max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
13377 * Default value: 2016, which we also enforce as a maximum value so you can tweak config to
13378 * reduce the loss of having useless locked funds (if your peer accepts)
13380 uint16_t ChannelHandshakeLimits_get_their_to_self_delay(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
13383 * Set to the amount of time we're willing to wait to claim money back to us.
13385 * Not checking this value would be a security issue, as our peer would be able to set it to
13386 * max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
13388 * Default value: 2016, which we also enforce as a maximum value so you can tweak config to
13389 * reduce the loss of having useless locked funds (if your peer accepts)
13391 void ChannelHandshakeLimits_set_their_to_self_delay(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint16_t val);
13394 * Constructs a new ChannelHandshakeLimits given each field
13396 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);
13399 * Creates a copy of the ChannelHandshakeLimits
13401 struct LDKChannelHandshakeLimits ChannelHandshakeLimits_clone(const struct LDKChannelHandshakeLimits *NONNULL_PTR orig);
13404 * Creates a "default" ChannelHandshakeLimits. See struct and individual field documentaiton for details on which values are used.
13406 MUST_USE_RES struct LDKChannelHandshakeLimits ChannelHandshakeLimits_default(void);
13409 * Frees any resources used by the ChannelConfig, if is_owned is set and inner is non-NULL.
13411 void ChannelConfig_free(struct LDKChannelConfig this_obj);
13414 * Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
13415 * over the channel.
13416 * This may be allowed to change at runtime in a later update, however doing so must result in
13417 * update messages sent to notify all nodes of our updated relay fee.
13419 * Default value: 0.
13421 uint32_t ChannelConfig_get_forwarding_fee_proportional_millionths(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
13424 * Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
13425 * over the channel.
13426 * This may be allowed to change at runtime in a later update, however doing so must result in
13427 * update messages sent to notify all nodes of our updated relay fee.
13429 * Default value: 0.
13431 void ChannelConfig_set_forwarding_fee_proportional_millionths(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint32_t val);
13434 * Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
13435 * excess of [`forwarding_fee_proportional_millionths`].
13436 * This may be allowed to change at runtime in a later update, however doing so must result in
13437 * update messages sent to notify all nodes of our updated relay fee.
13439 * The default value of a single satoshi roughly matches the market rate on many routing nodes
13440 * as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
13443 * Default value: 1000.
13445 * [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
13447 uint32_t ChannelConfig_get_forwarding_fee_base_msat(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
13450 * Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
13451 * excess of [`forwarding_fee_proportional_millionths`].
13452 * This may be allowed to change at runtime in a later update, however doing so must result in
13453 * update messages sent to notify all nodes of our updated relay fee.
13455 * The default value of a single satoshi roughly matches the market rate on many routing nodes
13456 * as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
13459 * Default value: 1000.
13461 * [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
13463 void ChannelConfig_set_forwarding_fee_base_msat(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint32_t val);
13466 * The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
13467 * the channel this config applies to.
13469 * This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
13470 * HTLC balance when a channel appears on-chain whereas
13471 * [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
13472 * (non-HTLC-encumbered) balance.
13474 * Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
13475 * we (or one of our watchtowers) MUST be online to check for broadcast of the current
13476 * commitment transaction at least once per this many blocks (minus some margin to allow us
13477 * enough time to broadcast and confirm a transaction, possibly with time in between to RBF
13478 * the spending transaction).
13480 * Default value: 72 (12 hours at an average of 6 blocks/hour).
13481 * Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
13482 * [`MIN_CLTV_EXPIRY_DELTA`] instead.
13484 * [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
13486 uint16_t ChannelConfig_get_cltv_expiry_delta(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
13489 * The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
13490 * the channel this config applies to.
13492 * This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
13493 * HTLC balance when a channel appears on-chain whereas
13494 * [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
13495 * (non-HTLC-encumbered) balance.
13497 * Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
13498 * we (or one of our watchtowers) MUST be online to check for broadcast of the current
13499 * commitment transaction at least once per this many blocks (minus some margin to allow us
13500 * enough time to broadcast and confirm a transaction, possibly with time in between to RBF
13501 * the spending transaction).
13503 * Default value: 72 (12 hours at an average of 6 blocks/hour).
13504 * Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
13505 * [`MIN_CLTV_EXPIRY_DELTA`] instead.
13507 * [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
13509 void ChannelConfig_set_cltv_expiry_delta(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint16_t val);
13512 * Set to announce the channel publicly and notify all nodes that they can route via this
13515 * This should only be set to true for nodes which expect to be online reliably.
13517 * As the node which funds a channel picks this value this will only apply for new outbound
13518 * channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
13520 * This cannot be changed after the initial channel handshake.
13522 * Default value: false.
13524 bool ChannelConfig_get_announced_channel(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
13527 * Set to announce the channel publicly and notify all nodes that they can route via this
13530 * This should only be set to true for nodes which expect to be online reliably.
13532 * As the node which funds a channel picks this value this will only apply for new outbound
13533 * channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
13535 * This cannot be changed after the initial channel handshake.
13537 * Default value: false.
13539 void ChannelConfig_set_announced_channel(struct LDKChannelConfig *NONNULL_PTR this_ptr, bool val);
13542 * When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
13543 * supports it, they will then enforce the mutual-close output to us matches what we provided
13544 * at intialization, preventing us from closing to an alternate pubkey.
13546 * This is set to true by default to provide a slight increase in security, though ultimately
13547 * any attacker who is able to take control of a channel can just as easily send the funds via
13548 * lightning payments, so we never require that our counterparties support this option.
13550 * This cannot be changed after a channel has been initialized.
13552 * Default value: true.
13554 bool ChannelConfig_get_commit_upfront_shutdown_pubkey(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
13557 * When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
13558 * supports it, they will then enforce the mutual-close output to us matches what we provided
13559 * at intialization, preventing us from closing to an alternate pubkey.
13561 * This is set to true by default to provide a slight increase in security, though ultimately
13562 * any attacker who is able to take control of a channel can just as easily send the funds via
13563 * lightning payments, so we never require that our counterparties support this option.
13565 * This cannot be changed after a channel has been initialized.
13567 * Default value: true.
13569 void ChannelConfig_set_commit_upfront_shutdown_pubkey(struct LDKChannelConfig *NONNULL_PTR this_ptr, bool val);
13572 * Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
13573 * small to claim on-chain.
13575 * When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
13576 * not be claimable on-chain, instead being turned into additional miner fees if either
13577 * party force-closes the channel. Because the threshold is per-HTLC, our total exposure
13578 * to such payments may be sustantial if there are many dust HTLCs present when the
13579 * channel is force-closed.
13581 * This limit is applied for sent, forwarded, and received HTLCs and limits the total
13582 * exposure across all three types per-channel. Setting this too low may prevent the
13583 * sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
13584 * important to prevent stealing of dust HTLCs by miners.
13586 * Default value: 5_000_000 msat.
13588 uint64_t ChannelConfig_get_max_dust_htlc_exposure_msat(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
13591 * Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
13592 * small to claim on-chain.
13594 * When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
13595 * not be claimable on-chain, instead being turned into additional miner fees if either
13596 * party force-closes the channel. Because the threshold is per-HTLC, our total exposure
13597 * to such payments may be sustantial if there are many dust HTLCs present when the
13598 * channel is force-closed.
13600 * This limit is applied for sent, forwarded, and received HTLCs and limits the total
13601 * exposure across all three types per-channel. Setting this too low may prevent the
13602 * sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
13603 * important to prevent stealing of dust HTLCs by miners.
13605 * Default value: 5_000_000 msat.
13607 void ChannelConfig_set_max_dust_htlc_exposure_msat(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint64_t val);
13610 * The additional fee we're willing to pay to avoid waiting for the counterparty's
13611 * `to_self_delay` to reclaim funds.
13613 * When we close a channel cooperatively with our counterparty, we negotiate a fee for the
13614 * closing transaction which both sides find acceptable, ultimately paid by the channel
13615 * funder/initiator.
13617 * When we are the funder, because we have to pay the channel closing fee, we bound the
13618 * acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
13619 * this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
13620 * [`Normal`] feerate during normal operation, this value represents the additional fee we're
13621 * willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
13624 * When we are not the funder, we require the closing transaction fee pay at least our
13625 * [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
13626 * Thus, this value is ignored when we are not the funder.
13628 * Default value: 1000 satoshis.
13630 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
13631 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
13633 uint64_t ChannelConfig_get_force_close_avoidance_max_fee_satoshis(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
13636 * The additional fee we're willing to pay to avoid waiting for the counterparty's
13637 * `to_self_delay` to reclaim funds.
13639 * When we close a channel cooperatively with our counterparty, we negotiate a fee for the
13640 * closing transaction which both sides find acceptable, ultimately paid by the channel
13641 * funder/initiator.
13643 * When we are the funder, because we have to pay the channel closing fee, we bound the
13644 * acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
13645 * this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
13646 * [`Normal`] feerate during normal operation, this value represents the additional fee we're
13647 * willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
13650 * When we are not the funder, we require the closing transaction fee pay at least our
13651 * [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
13652 * Thus, this value is ignored when we are not the funder.
13654 * Default value: 1000 satoshis.
13656 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
13657 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
13659 void ChannelConfig_set_force_close_avoidance_max_fee_satoshis(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint64_t val);
13662 * Constructs a new ChannelConfig given each field
13664 MUST_USE_RES struct LDKChannelConfig ChannelConfig_new(uint32_t forwarding_fee_proportional_millionths_arg, uint32_t forwarding_fee_base_msat_arg, uint16_t cltv_expiry_delta_arg, bool announced_channel_arg, bool commit_upfront_shutdown_pubkey_arg, uint64_t max_dust_htlc_exposure_msat_arg, uint64_t force_close_avoidance_max_fee_satoshis_arg);
13667 * Creates a copy of the ChannelConfig
13669 struct LDKChannelConfig ChannelConfig_clone(const struct LDKChannelConfig *NONNULL_PTR orig);
13672 * Creates a "default" ChannelConfig. See struct and individual field documentaiton for details on which values are used.
13674 MUST_USE_RES struct LDKChannelConfig ChannelConfig_default(void);
13677 * Serialize the ChannelConfig object into a byte array which can be read by ChannelConfig_read
13679 struct LDKCVec_u8Z ChannelConfig_write(const struct LDKChannelConfig *NONNULL_PTR obj);
13682 * Read a ChannelConfig from a byte array, created by ChannelConfig_write
13684 struct LDKCResult_ChannelConfigDecodeErrorZ ChannelConfig_read(struct LDKu8slice ser);
13687 * Frees any resources used by the UserConfig, if is_owned is set and inner is non-NULL.
13689 void UserConfig_free(struct LDKUserConfig this_obj);
13692 * Channel config that we propose to our counterparty.
13694 struct LDKChannelHandshakeConfig UserConfig_get_own_channel_config(const struct LDKUserConfig *NONNULL_PTR this_ptr);
13697 * Channel config that we propose to our counterparty.
13699 void UserConfig_set_own_channel_config(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelHandshakeConfig val);
13702 * Limits applied to our counterparty's proposed channel config settings.
13704 struct LDKChannelHandshakeLimits UserConfig_get_peer_channel_config_limits(const struct LDKUserConfig *NONNULL_PTR this_ptr);
13707 * Limits applied to our counterparty's proposed channel config settings.
13709 void UserConfig_set_peer_channel_config_limits(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelHandshakeLimits val);
13712 * Channel config which affects behavior during channel lifetime.
13714 struct LDKChannelConfig UserConfig_get_channel_options(const struct LDKUserConfig *NONNULL_PTR this_ptr);
13717 * Channel config which affects behavior during channel lifetime.
13719 void UserConfig_set_channel_options(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelConfig val);
13722 * If this is set to false, we will reject any HTLCs which were to be forwarded over private
13723 * channels. This prevents us from taking on HTLC-forwarding risk when we intend to run as a
13724 * node which is not online reliably.
13726 * For nodes which are not online reliably, you should set all channels to *not* be announced
13727 * (using [`ChannelConfig::announced_channel`] and
13728 * [`ChannelHandshakeLimits::force_announced_channel_preference`]) and set this to false to
13729 * ensure you are not exposed to any forwarding risk.
13731 * Note that because you cannot change a channel's announced state after creation, there is no
13732 * way to disable forwarding on public channels retroactively. Thus, in order to change a node
13733 * from a publicly-announced forwarding node to a private non-forwarding node you must close
13734 * all your channels and open new ones. For privacy, you should also change your node_id
13735 * (swapping all private and public key material for new ones) at that time.
13737 * Default value: false.
13739 bool UserConfig_get_accept_forwards_to_priv_channels(const struct LDKUserConfig *NONNULL_PTR this_ptr);
13742 * If this is set to false, we will reject any HTLCs which were to be forwarded over private
13743 * channels. This prevents us from taking on HTLC-forwarding risk when we intend to run as a
13744 * node which is not online reliably.
13746 * For nodes which are not online reliably, you should set all channels to *not* be announced
13747 * (using [`ChannelConfig::announced_channel`] and
13748 * [`ChannelHandshakeLimits::force_announced_channel_preference`]) and set this to false to
13749 * ensure you are not exposed to any forwarding risk.
13751 * Note that because you cannot change a channel's announced state after creation, there is no
13752 * way to disable forwarding on public channels retroactively. Thus, in order to change a node
13753 * from a publicly-announced forwarding node to a private non-forwarding node you must close
13754 * all your channels and open new ones. For privacy, you should also change your node_id
13755 * (swapping all private and public key material for new ones) at that time.
13757 * Default value: false.
13759 void UserConfig_set_accept_forwards_to_priv_channels(struct LDKUserConfig *NONNULL_PTR this_ptr, bool val);
13762 * Constructs a new UserConfig given each field
13764 MUST_USE_RES struct LDKUserConfig UserConfig_new(struct LDKChannelHandshakeConfig own_channel_config_arg, struct LDKChannelHandshakeLimits peer_channel_config_limits_arg, struct LDKChannelConfig channel_options_arg, bool accept_forwards_to_priv_channels_arg);
13767 * Creates a copy of the UserConfig
13769 struct LDKUserConfig UserConfig_clone(const struct LDKUserConfig *NONNULL_PTR orig);
13772 * Creates a "default" UserConfig. See struct and individual field documentaiton for details on which values are used.
13774 MUST_USE_RES struct LDKUserConfig UserConfig_default(void);
13777 * Frees any resources used by the BestBlock, if is_owned is set and inner is non-NULL.
13779 void BestBlock_free(struct LDKBestBlock this_obj);
13782 * Creates a copy of the BestBlock
13784 struct LDKBestBlock BestBlock_clone(const struct LDKBestBlock *NONNULL_PTR orig);
13787 * Constructs a `BestBlock` that represents the genesis block at height 0 of the given
13790 MUST_USE_RES struct LDKBestBlock BestBlock_from_genesis(enum LDKNetwork network);
13793 * Returns a `BestBlock` as identified by the given block hash and height.
13795 MUST_USE_RES struct LDKBestBlock BestBlock_new(struct LDKThirtyTwoBytes block_hash, uint32_t height);
13798 * Returns the best block hash.
13800 MUST_USE_RES struct LDKThirtyTwoBytes BestBlock_block_hash(const struct LDKBestBlock *NONNULL_PTR this_arg);
13803 * Returns the best block height.
13805 MUST_USE_RES uint32_t BestBlock_height(const struct LDKBestBlock *NONNULL_PTR this_arg);
13808 * Creates a copy of the AccessError
13810 enum LDKAccessError AccessError_clone(const enum LDKAccessError *NONNULL_PTR orig);
13813 * Utility method to constructs a new UnknownChain-variant AccessError
13815 enum LDKAccessError AccessError_unknown_chain(void);
13818 * Utility method to constructs a new UnknownTx-variant AccessError
13820 enum LDKAccessError AccessError_unknown_tx(void);
13823 * Calls the free function if one is set
13825 void Access_free(struct LDKAccess this_ptr);
13828 * Calls the free function if one is set
13830 void Listen_free(struct LDKListen this_ptr);
13833 * Calls the free function if one is set
13835 void Confirm_free(struct LDKConfirm this_ptr);
13838 * Calls the free function if one is set
13840 void Watch_free(struct LDKWatch this_ptr);
13843 * Calls the free function if one is set
13845 void Filter_free(struct LDKFilter this_ptr);
13848 * Frees any resources used by the WatchedOutput, if is_owned is set and inner is non-NULL.
13850 void WatchedOutput_free(struct LDKWatchedOutput this_obj);
13853 * First block where the transaction output may have been spent.
13855 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
13857 struct LDKThirtyTwoBytes WatchedOutput_get_block_hash(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
13860 * First block where the transaction output may have been spent.
13862 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
13864 void WatchedOutput_set_block_hash(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
13867 * Outpoint identifying the transaction output.
13869 struct LDKOutPoint WatchedOutput_get_outpoint(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
13872 * Outpoint identifying the transaction output.
13874 void WatchedOutput_set_outpoint(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKOutPoint val);
13877 * Spending condition of the transaction output.
13879 struct LDKu8slice WatchedOutput_get_script_pubkey(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
13882 * Spending condition of the transaction output.
13884 void WatchedOutput_set_script_pubkey(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
13887 * Constructs a new WatchedOutput given each field
13889 MUST_USE_RES struct LDKWatchedOutput WatchedOutput_new(struct LDKThirtyTwoBytes block_hash_arg, struct LDKOutPoint outpoint_arg, struct LDKCVec_u8Z script_pubkey_arg);
13892 * Creates a copy of the WatchedOutput
13894 struct LDKWatchedOutput WatchedOutput_clone(const struct LDKWatchedOutput *NONNULL_PTR orig);
13897 * Checks if two WatchedOutputs contain equal inner contents.
13899 uint64_t WatchedOutput_hash(const struct LDKWatchedOutput *NONNULL_PTR o);
13902 * Calls the free function if one is set
13904 void BroadcasterInterface_free(struct LDKBroadcasterInterface this_ptr);
13907 * Creates a copy of the ConfirmationTarget
13909 enum LDKConfirmationTarget ConfirmationTarget_clone(const enum LDKConfirmationTarget *NONNULL_PTR orig);
13912 * Utility method to constructs a new Background-variant ConfirmationTarget
13914 enum LDKConfirmationTarget ConfirmationTarget_background(void);
13917 * Utility method to constructs a new Normal-variant ConfirmationTarget
13919 enum LDKConfirmationTarget ConfirmationTarget_normal(void);
13922 * Utility method to constructs a new HighPriority-variant ConfirmationTarget
13924 enum LDKConfirmationTarget ConfirmationTarget_high_priority(void);
13927 * Checks if two ConfirmationTargets contain equal inner contents.
13928 * This ignores pointers and is_owned flags and looks at the values in fields.
13930 bool ConfirmationTarget_eq(const enum LDKConfirmationTarget *NONNULL_PTR a, const enum LDKConfirmationTarget *NONNULL_PTR b);
13933 * Calls the free function if one is set
13935 void FeeEstimator_free(struct LDKFeeEstimator this_ptr);
13938 * Frees any resources used by the ChainMonitor, if is_owned is set and inner is non-NULL.
13940 void ChainMonitor_free(struct LDKChainMonitor this_obj);
13943 * Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
13945 * When an optional chain source implementing [`chain::Filter`] is provided, the chain monitor
13946 * will call back to it indicating transactions and outputs of interest. This allows clients to
13947 * pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may
13948 * always need to fetch full blocks absent another means for determining which blocks contain
13949 * transactions relevant to the watched channels.
13951 MUST_USE_RES struct LDKChainMonitor ChainMonitor_new(struct LDKCOption_FilterZ chain_source, struct LDKBroadcasterInterface broadcaster, struct LDKLogger logger, struct LDKFeeEstimator feeest, struct LDKPersist persister);
13954 * Gets the balances in the contained [`ChannelMonitor`]s which are claimable on-chain or
13955 * claims which are awaiting confirmation.
13957 * Includes the balances from each [`ChannelMonitor`] *except* those included in
13958 * `ignored_channels`, allowing you to filter out balances from channels which are still open
13959 * (and whose balance should likely be pulled from the [`ChannelDetails`]).
13961 * See [`ChannelMonitor::get_claimable_balances`] for more details on the exact criteria for
13962 * inclusion in the return value.
13964 MUST_USE_RES struct LDKCVec_BalanceZ ChainMonitor_get_claimable_balances(const struct LDKChainMonitor *NONNULL_PTR this_arg, struct LDKCVec_ChannelDetailsZ ignored_channels);
13967 * Constructs a new Listen which calls the relevant methods on this_arg.
13968 * This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
13970 struct LDKListen ChainMonitor_as_Listen(const struct LDKChainMonitor *NONNULL_PTR this_arg);
13973 * Constructs a new Confirm which calls the relevant methods on this_arg.
13974 * This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
13976 struct LDKConfirm ChainMonitor_as_Confirm(const struct LDKChainMonitor *NONNULL_PTR this_arg);
13979 * Constructs a new Watch which calls the relevant methods on this_arg.
13980 * This copies the `inner` pointer in this_arg and thus the returned Watch must be freed before this_arg is
13982 struct LDKWatch ChainMonitor_as_Watch(const struct LDKChainMonitor *NONNULL_PTR this_arg);
13985 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
13986 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
13988 struct LDKEventsProvider ChainMonitor_as_EventsProvider(const struct LDKChainMonitor *NONNULL_PTR this_arg);
13991 * Frees any resources used by the ChannelMonitorUpdate, if is_owned is set and inner is non-NULL.
13993 void ChannelMonitorUpdate_free(struct LDKChannelMonitorUpdate this_obj);
13996 * The sequence number of this update. Updates *must* be replayed in-order according to this
13997 * sequence number (and updates may panic if they are not). The update_id values are strictly
13998 * increasing and increase by one for each new update, with one exception specified below.
14000 * This sequence number is also used to track up to which points updates which returned
14001 * ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
14002 * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
14004 * The only instance where update_id values are not strictly increasing is the case where we
14005 * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
14006 * its docs for more details.
14008 uint64_t ChannelMonitorUpdate_get_update_id(const struct LDKChannelMonitorUpdate *NONNULL_PTR this_ptr);
14011 * The sequence number of this update. Updates *must* be replayed in-order according to this
14012 * sequence number (and updates may panic if they are not). The update_id values are strictly
14013 * increasing and increase by one for each new update, with one exception specified below.
14015 * This sequence number is also used to track up to which points updates which returned
14016 * ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
14017 * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
14019 * The only instance where update_id values are not strictly increasing is the case where we
14020 * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
14021 * its docs for more details.
14023 void ChannelMonitorUpdate_set_update_id(struct LDKChannelMonitorUpdate *NONNULL_PTR this_ptr, uint64_t val);
14026 * Creates a copy of the ChannelMonitorUpdate
14028 struct LDKChannelMonitorUpdate ChannelMonitorUpdate_clone(const struct LDKChannelMonitorUpdate *NONNULL_PTR orig);
14031 * Serialize the ChannelMonitorUpdate object into a byte array which can be read by ChannelMonitorUpdate_read
14033 struct LDKCVec_u8Z ChannelMonitorUpdate_write(const struct LDKChannelMonitorUpdate *NONNULL_PTR obj);
14036 * Read a ChannelMonitorUpdate from a byte array, created by ChannelMonitorUpdate_write
14038 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ ChannelMonitorUpdate_read(struct LDKu8slice ser);
14041 * Creates a copy of the ChannelMonitorUpdateErr
14043 enum LDKChannelMonitorUpdateErr ChannelMonitorUpdateErr_clone(const enum LDKChannelMonitorUpdateErr *NONNULL_PTR orig);
14046 * Utility method to constructs a new TemporaryFailure-variant ChannelMonitorUpdateErr
14048 enum LDKChannelMonitorUpdateErr ChannelMonitorUpdateErr_temporary_failure(void);
14051 * Utility method to constructs a new PermanentFailure-variant ChannelMonitorUpdateErr
14053 enum LDKChannelMonitorUpdateErr ChannelMonitorUpdateErr_permanent_failure(void);
14056 * Frees any resources used by the MonitorUpdateError, if is_owned is set and inner is non-NULL.
14058 void MonitorUpdateError_free(struct LDKMonitorUpdateError this_obj);
14061 * Creates a copy of the MonitorUpdateError
14063 struct LDKMonitorUpdateError MonitorUpdateError_clone(const struct LDKMonitorUpdateError *NONNULL_PTR orig);
14066 * Frees any resources used by the MonitorEvent
14068 void MonitorEvent_free(struct LDKMonitorEvent this_ptr);
14071 * Creates a copy of the MonitorEvent
14073 struct LDKMonitorEvent MonitorEvent_clone(const struct LDKMonitorEvent *NONNULL_PTR orig);
14076 * Utility method to constructs a new HTLCEvent-variant MonitorEvent
14078 struct LDKMonitorEvent MonitorEvent_htlcevent(struct LDKHTLCUpdate a);
14081 * Utility method to constructs a new CommitmentTxConfirmed-variant MonitorEvent
14083 struct LDKMonitorEvent MonitorEvent_commitment_tx_confirmed(struct LDKOutPoint a);
14086 * Frees any resources used by the HTLCUpdate, if is_owned is set and inner is non-NULL.
14088 void HTLCUpdate_free(struct LDKHTLCUpdate this_obj);
14091 * Creates a copy of the HTLCUpdate
14093 struct LDKHTLCUpdate HTLCUpdate_clone(const struct LDKHTLCUpdate *NONNULL_PTR orig);
14096 * Serialize the HTLCUpdate object into a byte array which can be read by HTLCUpdate_read
14098 struct LDKCVec_u8Z HTLCUpdate_write(const struct LDKHTLCUpdate *NONNULL_PTR obj);
14101 * Read a HTLCUpdate from a byte array, created by HTLCUpdate_write
14103 struct LDKCResult_HTLCUpdateDecodeErrorZ HTLCUpdate_read(struct LDKu8slice ser);
14106 * Frees any resources used by the Balance
14108 void Balance_free(struct LDKBalance this_ptr);
14111 * Creates a copy of the Balance
14113 struct LDKBalance Balance_clone(const struct LDKBalance *NONNULL_PTR orig);
14116 * Utility method to constructs a new ClaimableOnChannelClose-variant Balance
14118 struct LDKBalance Balance_claimable_on_channel_close(uint64_t claimable_amount_satoshis);
14121 * Utility method to constructs a new ClaimableAwaitingConfirmations-variant Balance
14123 struct LDKBalance Balance_claimable_awaiting_confirmations(uint64_t claimable_amount_satoshis, uint32_t confirmation_height);
14126 * Utility method to constructs a new ContentiousClaimable-variant Balance
14128 struct LDKBalance Balance_contentious_claimable(uint64_t claimable_amount_satoshis, uint32_t timeout_height);
14131 * Utility method to constructs a new MaybeClaimableHTLCAwaitingTimeout-variant Balance
14133 struct LDKBalance Balance_maybe_claimable_htlcawaiting_timeout(uint64_t claimable_amount_satoshis, uint32_t claimable_height);
14136 * Checks if two Balances contain equal inner contents.
14137 * This ignores pointers and is_owned flags and looks at the values in fields.
14139 bool Balance_eq(const struct LDKBalance *NONNULL_PTR a, const struct LDKBalance *NONNULL_PTR b);
14142 * Frees any resources used by the ChannelMonitor, if is_owned is set and inner is non-NULL.
14144 void ChannelMonitor_free(struct LDKChannelMonitor this_obj);
14147 * Serialize the ChannelMonitor object into a byte array which can be read by ChannelMonitor_read
14149 struct LDKCVec_u8Z ChannelMonitor_write(const struct LDKChannelMonitor *NONNULL_PTR obj);
14152 * Updates a ChannelMonitor on the basis of some new information provided by the Channel
14155 * panics if the given update is not the next update by update_id.
14157 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);
14160 * Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
14163 MUST_USE_RES uint64_t ChannelMonitor_get_latest_update_id(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
14166 * Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
14168 MUST_USE_RES struct LDKC2Tuple_OutPointScriptZ ChannelMonitor_get_funding_txo(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
14171 * Gets a list of txids, with their output scripts (in the order they appear in the
14172 * transaction), which we must learn about spends of via block_connected().
14174 MUST_USE_RES struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ ChannelMonitor_get_outputs_to_watch(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
14177 * Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
14178 * calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
14179 * have been registered.
14181 void ChannelMonitor_load_outputs_to_watch(const struct LDKChannelMonitor *NONNULL_PTR this_arg, const struct LDKFilter *NONNULL_PTR filter);
14184 * Get the list of HTLCs who's status has been updated on chain. This should be called by
14185 * ChannelManager via [`chain::Watch::release_pending_monitor_events`].
14187 MUST_USE_RES struct LDKCVec_MonitorEventZ ChannelMonitor_get_and_clear_pending_monitor_events(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
14190 * Gets the list of pending events which were generated by previous actions, clearing the list
14193 * This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
14194 * EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
14195 * no internal locking in ChannelMonitors.
14197 MUST_USE_RES struct LDKCVec_EventZ ChannelMonitor_get_and_clear_pending_events(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
14200 * Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
14201 * the Channel was out-of-date. You may use it to get a broadcastable holder toxic tx in case of
14202 * fallen-behind, i.e when receiving a channel_reestablish with a proof that our counterparty side knows
14203 * a higher revocation secret than the holder commitment number we are aware of. Broadcasting these
14204 * transactions are UNSAFE, as they allow counterparty side to punish you. Nevertheless you may want to
14205 * broadcast them if counterparty don't close channel with his higher commitment transaction after a
14206 * substantial amount of time (a month or even a year) to get back funds. Best may be to contact
14207 * out-of-band the other node operator to coordinate with him if option is available to you.
14208 * In any-case, choice is up to the user.
14210 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);
14213 * Processes transactions in a newly connected block, which may result in any of the following:
14214 * - update the monitor's state against resolved HTLCs
14215 * - punish the counterparty in the case of seeing a revoked commitment transaction
14216 * - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
14217 * - detect settled outputs for later spending
14218 * - schedule and bump any in-flight claims
14220 * Returns any new outputs to watch from `txdata`; after called, these are also included in
14221 * [`get_outputs_to_watch`].
14223 * [`get_outputs_to_watch`]: #method.get_outputs_to_watch
14225 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);
14228 * Determines if the disconnected block contained any transactions of interest and updates
14231 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);
14234 * Processes transactions confirmed in a block with the given header and height, returning new
14235 * outputs to watch. See [`block_connected`] for details.
14237 * Used instead of [`block_connected`] by clients that are notified of transactions rather than
14238 * blocks. See [`chain::Confirm`] for calling expectations.
14240 * [`block_connected`]: Self::block_connected
14242 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);
14245 * Processes a transaction that was reorganized out of the chain.
14247 * Used instead of [`block_disconnected`] by clients that are notified of transactions rather
14248 * than blocks. See [`chain::Confirm`] for calling expectations.
14250 * [`block_disconnected`]: Self::block_disconnected
14252 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);
14255 * Updates the monitor with the current best chain tip, returning new outputs to watch. See
14256 * [`block_connected`] for details.
14258 * Used instead of [`block_connected`] by clients that are notified of transactions rather than
14259 * blocks. See [`chain::Confirm`] for calling expectations.
14261 * [`block_connected`]: Self::block_connected
14263 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);
14266 * Returns the set of txids that should be monitored for re-organization out of the chain.
14268 MUST_USE_RES struct LDKCVec_TxidZ ChannelMonitor_get_relevant_txids(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
14271 * Gets the latest best block which was connected either via the [`chain::Listen`] or
14272 * [`chain::Confirm`] interfaces.
14274 MUST_USE_RES struct LDKBestBlock ChannelMonitor_current_best_block(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
14277 * Gets the balances in this channel which are either claimable by us if we were to
14278 * force-close the channel now or which are claimable on-chain (possibly awaiting
14281 * Any balances in the channel which are available on-chain (excluding on-chain fees) are
14282 * included here until an [`Event::SpendableOutputs`] event has been generated for the
14283 * balance, or until our counterparty has claimed the balance and accrued several
14284 * confirmations on the claim transaction.
14286 * Note that the balances available when you or your counterparty have broadcasted revoked
14287 * state(s) may not be fully captured here.
14289 * See [`Balance`] for additional details on the types of claimable balances which
14290 * may be returned here and their meanings.
14292 MUST_USE_RES struct LDKCVec_BalanceZ ChannelMonitor_get_claimable_balances(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
14295 * Calls the free function if one is set
14297 void Persist_free(struct LDKPersist this_ptr);
14300 * Read a C2Tuple_BlockHashChannelMonitorZ from a byte array, created by C2Tuple_BlockHashChannelMonitorZ_write
14302 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ C2Tuple_BlockHashChannelMonitorZ_read(struct LDKu8slice ser, const struct LDKKeysInterface *NONNULL_PTR arg);
14305 * Frees any resources used by the OutPoint, if is_owned is set and inner is non-NULL.
14307 void OutPoint_free(struct LDKOutPoint this_obj);
14310 * The referenced transaction's txid.
14312 const uint8_t (*OutPoint_get_txid(const struct LDKOutPoint *NONNULL_PTR this_ptr))[32];
14315 * The referenced transaction's txid.
14317 void OutPoint_set_txid(struct LDKOutPoint *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14320 * The index of the referenced output in its transaction's vout.
14322 uint16_t OutPoint_get_index(const struct LDKOutPoint *NONNULL_PTR this_ptr);
14325 * The index of the referenced output in its transaction's vout.
14327 void OutPoint_set_index(struct LDKOutPoint *NONNULL_PTR this_ptr, uint16_t val);
14330 * Constructs a new OutPoint given each field
14332 MUST_USE_RES struct LDKOutPoint OutPoint_new(struct LDKThirtyTwoBytes txid_arg, uint16_t index_arg);
14335 * Creates a copy of the OutPoint
14337 struct LDKOutPoint OutPoint_clone(const struct LDKOutPoint *NONNULL_PTR orig);
14340 * Checks if two OutPoints contain equal inner contents.
14341 * This ignores pointers and is_owned flags and looks at the values in fields.
14342 * Two objects with NULL inner values will be considered "equal" here.
14344 bool OutPoint_eq(const struct LDKOutPoint *NONNULL_PTR a, const struct LDKOutPoint *NONNULL_PTR b);
14347 * Checks if two OutPoints contain equal inner contents.
14349 uint64_t OutPoint_hash(const struct LDKOutPoint *NONNULL_PTR o);
14352 * Convert an `OutPoint` to a lightning channel id.
14354 MUST_USE_RES struct LDKThirtyTwoBytes OutPoint_to_channel_id(const struct LDKOutPoint *NONNULL_PTR this_arg);
14357 * Serialize the OutPoint object into a byte array which can be read by OutPoint_read
14359 struct LDKCVec_u8Z OutPoint_write(const struct LDKOutPoint *NONNULL_PTR obj);
14362 * Read a OutPoint from a byte array, created by OutPoint_write
14364 struct LDKCResult_OutPointDecodeErrorZ OutPoint_read(struct LDKu8slice ser);
14367 * Frees any resources used by the DelayedPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
14369 void DelayedPaymentOutputDescriptor_free(struct LDKDelayedPaymentOutputDescriptor this_obj);
14372 * The outpoint which is spendable
14374 struct LDKOutPoint DelayedPaymentOutputDescriptor_get_outpoint(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
14377 * The outpoint which is spendable
14379 void DelayedPaymentOutputDescriptor_set_outpoint(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKOutPoint val);
14382 * Per commitment point to derive delayed_payment_key by key holder
14384 struct LDKPublicKey DelayedPaymentOutputDescriptor_get_per_commitment_point(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
14387 * Per commitment point to derive delayed_payment_key by key holder
14389 void DelayedPaymentOutputDescriptor_set_per_commitment_point(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14392 * The nSequence value which must be set in the spending input to satisfy the OP_CSV in
14393 * the witness_script.
14395 uint16_t DelayedPaymentOutputDescriptor_get_to_self_delay(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
14398 * The nSequence value which must be set in the spending input to satisfy the OP_CSV in
14399 * the witness_script.
14401 void DelayedPaymentOutputDescriptor_set_to_self_delay(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint16_t val);
14404 * The output which is referenced by the given outpoint
14406 void DelayedPaymentOutputDescriptor_set_output(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKTxOut val);
14409 * The revocation point specific to the commitment transaction which was broadcast. Used to
14410 * derive the witnessScript for this output.
14412 struct LDKPublicKey DelayedPaymentOutputDescriptor_get_revocation_pubkey(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
14415 * The revocation point specific to the commitment transaction which was broadcast. Used to
14416 * derive the witnessScript for this output.
14418 void DelayedPaymentOutputDescriptor_set_revocation_pubkey(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14421 * Arbitrary identification information returned by a call to
14422 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
14423 * the channel to spend the output.
14425 const uint8_t (*DelayedPaymentOutputDescriptor_get_channel_keys_id(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr))[32];
14428 * Arbitrary identification information returned by a call to
14429 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
14430 * the channel to spend the output.
14432 void DelayedPaymentOutputDescriptor_set_channel_keys_id(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14435 * The value of the channel which this output originated from, possibly indirectly.
14437 uint64_t DelayedPaymentOutputDescriptor_get_channel_value_satoshis(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
14440 * The value of the channel which this output originated from, possibly indirectly.
14442 void DelayedPaymentOutputDescriptor_set_channel_value_satoshis(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint64_t val);
14445 * Constructs a new DelayedPaymentOutputDescriptor given each field
14447 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);
14450 * Creates a copy of the DelayedPaymentOutputDescriptor
14452 struct LDKDelayedPaymentOutputDescriptor DelayedPaymentOutputDescriptor_clone(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR orig);
14455 * Serialize the DelayedPaymentOutputDescriptor object into a byte array which can be read by DelayedPaymentOutputDescriptor_read
14457 struct LDKCVec_u8Z DelayedPaymentOutputDescriptor_write(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR obj);
14460 * Read a DelayedPaymentOutputDescriptor from a byte array, created by DelayedPaymentOutputDescriptor_write
14462 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ DelayedPaymentOutputDescriptor_read(struct LDKu8slice ser);
14465 * Frees any resources used by the StaticPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
14467 void StaticPaymentOutputDescriptor_free(struct LDKStaticPaymentOutputDescriptor this_obj);
14470 * The outpoint which is spendable
14472 struct LDKOutPoint StaticPaymentOutputDescriptor_get_outpoint(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr);
14475 * The outpoint which is spendable
14477 void StaticPaymentOutputDescriptor_set_outpoint(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKOutPoint val);
14480 * The output which is referenced by the given outpoint
14482 void StaticPaymentOutputDescriptor_set_output(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKTxOut val);
14485 * Arbitrary identification information returned by a call to
14486 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
14487 * the channel to spend the output.
14489 const uint8_t (*StaticPaymentOutputDescriptor_get_channel_keys_id(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr))[32];
14492 * Arbitrary identification information returned by a call to
14493 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
14494 * the channel to spend the output.
14496 void StaticPaymentOutputDescriptor_set_channel_keys_id(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14499 * The value of the channel which this transactions spends.
14501 uint64_t StaticPaymentOutputDescriptor_get_channel_value_satoshis(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr);
14504 * The value of the channel which this transactions spends.
14506 void StaticPaymentOutputDescriptor_set_channel_value_satoshis(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint64_t val);
14509 * Constructs a new StaticPaymentOutputDescriptor given each field
14511 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);
14514 * Creates a copy of the StaticPaymentOutputDescriptor
14516 struct LDKStaticPaymentOutputDescriptor StaticPaymentOutputDescriptor_clone(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR orig);
14519 * Serialize the StaticPaymentOutputDescriptor object into a byte array which can be read by StaticPaymentOutputDescriptor_read
14521 struct LDKCVec_u8Z StaticPaymentOutputDescriptor_write(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR obj);
14524 * Read a StaticPaymentOutputDescriptor from a byte array, created by StaticPaymentOutputDescriptor_write
14526 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ StaticPaymentOutputDescriptor_read(struct LDKu8slice ser);
14529 * Frees any resources used by the SpendableOutputDescriptor
14531 void SpendableOutputDescriptor_free(struct LDKSpendableOutputDescriptor this_ptr);
14534 * Creates a copy of the SpendableOutputDescriptor
14536 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_clone(const struct LDKSpendableOutputDescriptor *NONNULL_PTR orig);
14539 * Utility method to constructs a new StaticOutput-variant SpendableOutputDescriptor
14541 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_static_output(struct LDKOutPoint outpoint, struct LDKTxOut output);
14544 * Utility method to constructs a new DelayedPaymentOutput-variant SpendableOutputDescriptor
14546 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_delayed_payment_output(struct LDKDelayedPaymentOutputDescriptor a);
14549 * Utility method to constructs a new StaticPaymentOutput-variant SpendableOutputDescriptor
14551 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_static_payment_output(struct LDKStaticPaymentOutputDescriptor a);
14554 * Serialize the SpendableOutputDescriptor object into a byte array which can be read by SpendableOutputDescriptor_read
14556 struct LDKCVec_u8Z SpendableOutputDescriptor_write(const struct LDKSpendableOutputDescriptor *NONNULL_PTR obj);
14559 * Read a SpendableOutputDescriptor from a byte array, created by SpendableOutputDescriptor_write
14561 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ SpendableOutputDescriptor_read(struct LDKu8slice ser);
14564 * Calls the free function if one is set
14566 void BaseSign_free(struct LDKBaseSign this_ptr);
14569 * Creates a copy of a Sign
14571 struct LDKSign Sign_clone(const struct LDKSign *NONNULL_PTR orig);
14574 * Calls the free function if one is set
14576 void Sign_free(struct LDKSign this_ptr);
14579 * Calls the free function if one is set
14581 void KeysInterface_free(struct LDKKeysInterface this_ptr);
14584 * Frees any resources used by the InMemorySigner, if is_owned is set and inner is non-NULL.
14586 void InMemorySigner_free(struct LDKInMemorySigner this_obj);
14589 * Private key of anchor tx
14591 const uint8_t (*InMemorySigner_get_funding_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
14594 * Private key of anchor tx
14596 void InMemorySigner_set_funding_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
14599 * Holder secret key for blinded revocation pubkey
14601 const uint8_t (*InMemorySigner_get_revocation_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
14604 * Holder secret key for blinded revocation pubkey
14606 void InMemorySigner_set_revocation_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
14609 * Holder secret key used for our balance in counterparty-broadcasted commitment transactions
14611 const uint8_t (*InMemorySigner_get_payment_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
14614 * Holder secret key used for our balance in counterparty-broadcasted commitment transactions
14616 void InMemorySigner_set_payment_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
14619 * Holder secret key used in HTLC tx
14621 const uint8_t (*InMemorySigner_get_delayed_payment_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
14624 * Holder secret key used in HTLC tx
14626 void InMemorySigner_set_delayed_payment_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
14629 * Holder htlc secret key used in commitment tx htlc outputs
14631 const uint8_t (*InMemorySigner_get_htlc_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
14634 * Holder htlc secret key used in commitment tx htlc outputs
14636 void InMemorySigner_set_htlc_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
14641 const uint8_t (*InMemorySigner_get_commitment_seed(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
14646 void InMemorySigner_set_commitment_seed(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14649 * Creates a copy of the InMemorySigner
14651 struct LDKInMemorySigner InMemorySigner_clone(const struct LDKInMemorySigner *NONNULL_PTR orig);
14654 * Create a new InMemorySigner
14656 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);
14659 * Counterparty pubkeys.
14660 * Will panic if ready_channel wasn't called.
14662 MUST_USE_RES struct LDKChannelPublicKeys InMemorySigner_counterparty_pubkeys(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
14665 * The contest_delay value specified by our counterparty and applied on holder-broadcastable
14666 * transactions, ie the amount of time that we have to wait to recover our funds if we
14667 * broadcast a transaction.
14668 * Will panic if ready_channel wasn't called.
14670 MUST_USE_RES uint16_t InMemorySigner_counterparty_selected_contest_delay(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
14673 * The contest_delay value specified by us and applied on transactions broadcastable
14674 * by our counterparty, ie the amount of time that they have to wait to recover their funds
14675 * if they broadcast a transaction.
14676 * Will panic if ready_channel wasn't called.
14678 MUST_USE_RES uint16_t InMemorySigner_holder_selected_contest_delay(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
14681 * Whether the holder is the initiator
14682 * Will panic if ready_channel wasn't called.
14684 MUST_USE_RES bool InMemorySigner_is_outbound(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
14688 * Will panic if ready_channel wasn't called.
14690 MUST_USE_RES struct LDKOutPoint InMemorySigner_funding_outpoint(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
14693 * Obtain a ChannelTransactionParameters for this channel, to be used when verifying or
14694 * building transactions.
14696 * Will panic if ready_channel wasn't called.
14698 MUST_USE_RES struct LDKChannelTransactionParameters InMemorySigner_get_channel_parameters(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
14701 * Sign the single input of spend_tx at index `input_idx` which spends the output
14702 * described by descriptor, returning the witness stack for the input.
14704 * Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
14705 * or is not spending the outpoint described by `descriptor.outpoint`.
14707 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);
14710 * Sign the single input of spend_tx at index `input_idx` which spends the output
14711 * described by descriptor, returning the witness stack for the input.
14713 * Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
14714 * is not spending the outpoint described by `descriptor.outpoint`, or does not have a
14715 * sequence set to `descriptor.to_self_delay`.
14717 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);
14720 * Constructs a new BaseSign which calls the relevant methods on this_arg.
14721 * This copies the `inner` pointer in this_arg and thus the returned BaseSign must be freed before this_arg is
14723 struct LDKBaseSign InMemorySigner_as_BaseSign(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
14726 * Constructs a new Sign which calls the relevant methods on this_arg.
14727 * This copies the `inner` pointer in this_arg and thus the returned Sign must be freed before this_arg is
14729 struct LDKSign InMemorySigner_as_Sign(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
14732 * Serialize the InMemorySigner object into a byte array which can be read by InMemorySigner_read
14734 struct LDKCVec_u8Z InMemorySigner_write(const struct LDKInMemorySigner *NONNULL_PTR obj);
14737 * Read a InMemorySigner from a byte array, created by InMemorySigner_write
14739 struct LDKCResult_InMemorySignerDecodeErrorZ InMemorySigner_read(struct LDKu8slice ser);
14742 * Frees any resources used by the KeysManager, if is_owned is set and inner is non-NULL.
14744 void KeysManager_free(struct LDKKeysManager this_obj);
14747 * Constructs a KeysManager from a 32-byte seed. If the seed is in some way biased (eg your
14748 * CSRNG is busted) this may panic (but more importantly, you will possibly lose funds).
14749 * starting_time isn't strictly required to actually be a time, but it must absolutely,
14750 * without a doubt, be unique to this instance. ie if you start multiple times with the same
14751 * seed, starting_time must be unique to each run. Thus, the easiest way to achieve this is to
14752 * simply use the current time (with very high precision).
14754 * The seed MUST be backed up safely prior to use so that the keys can be re-created, however,
14755 * obviously, starting_time should be unique every time you reload the library - it is only
14756 * used to generate new ephemeral key data (which will be stored by the individual channel if
14759 * Note that the seed is required to recover certain on-chain funds independent of
14760 * ChannelMonitor data, though a current copy of ChannelMonitor data is also required for any
14761 * channel, and some on-chain during-closing funds.
14763 * Note that until the 0.1 release there is no guarantee of backward compatibility between
14764 * versions. Once the library is more fully supported, the docs will be updated to include a
14765 * detailed description of the guarantee.
14767 MUST_USE_RES struct LDKKeysManager KeysManager_new(const uint8_t (*seed)[32], uint64_t starting_time_secs, uint32_t starting_time_nanos);
14770 * Derive an old Sign containing per-channel secrets based on a key derivation parameters.
14772 * Key derivation parameters are accessible through a per-channel secrets
14773 * Sign::channel_keys_id and is provided inside DynamicOuputP2WSH in case of
14774 * onchain output detection for which a corresponding delayed_payment_key must be derived.
14776 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]);
14779 * Creates a Transaction which spends the given descriptors to the given outputs, plus an
14780 * output to the given change destination (if sufficient change value remains). The
14781 * transaction will have a feerate, at least, of the given value.
14783 * Returns `Err(())` if the output value is greater than the input value minus required fee or
14784 * if a descriptor was duplicated.
14786 * We do not enforce that outputs meet the dust limit or that any output scripts are standard.
14788 * May panic if the `SpendableOutputDescriptor`s were not generated by Channels which used
14789 * this KeysManager or one of the `InMemorySigner` created by this KeysManager.
14791 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);
14794 * Constructs a new KeysInterface which calls the relevant methods on this_arg.
14795 * This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is
14797 struct LDKKeysInterface KeysManager_as_KeysInterface(const struct LDKKeysManager *NONNULL_PTR this_arg);
14800 * Frees any resources used by the ChannelManager, if is_owned is set and inner is non-NULL.
14802 void ChannelManager_free(struct LDKChannelManager this_obj);
14805 * Frees any resources used by the ChainParameters, if is_owned is set and inner is non-NULL.
14807 void ChainParameters_free(struct LDKChainParameters this_obj);
14810 * The network for determining the `chain_hash` in Lightning messages.
14812 enum LDKNetwork ChainParameters_get_network(const struct LDKChainParameters *NONNULL_PTR this_ptr);
14815 * The network for determining the `chain_hash` in Lightning messages.
14817 void ChainParameters_set_network(struct LDKChainParameters *NONNULL_PTR this_ptr, enum LDKNetwork val);
14820 * The hash and height of the latest block successfully connected.
14822 * Used to track on-chain channel funding outputs and send payments with reliable timelocks.
14824 struct LDKBestBlock ChainParameters_get_best_block(const struct LDKChainParameters *NONNULL_PTR this_ptr);
14827 * The hash and height of the latest block successfully connected.
14829 * Used to track on-chain channel funding outputs and send payments with reliable timelocks.
14831 void ChainParameters_set_best_block(struct LDKChainParameters *NONNULL_PTR this_ptr, struct LDKBestBlock val);
14834 * Constructs a new ChainParameters given each field
14836 MUST_USE_RES struct LDKChainParameters ChainParameters_new(enum LDKNetwork network_arg, struct LDKBestBlock best_block_arg);
14839 * Creates a copy of the ChainParameters
14841 struct LDKChainParameters ChainParameters_clone(const struct LDKChainParameters *NONNULL_PTR orig);
14844 * Frees any resources used by the CounterpartyForwardingInfo, if is_owned is set and inner is non-NULL.
14846 void CounterpartyForwardingInfo_free(struct LDKCounterpartyForwardingInfo this_obj);
14849 * Base routing fee in millisatoshis.
14851 uint32_t CounterpartyForwardingInfo_get_fee_base_msat(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr);
14854 * Base routing fee in millisatoshis.
14856 void CounterpartyForwardingInfo_set_fee_base_msat(struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr, uint32_t val);
14859 * Amount in millionths of a satoshi the channel will charge per transferred satoshi.
14861 uint32_t CounterpartyForwardingInfo_get_fee_proportional_millionths(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr);
14864 * Amount in millionths of a satoshi the channel will charge per transferred satoshi.
14866 void CounterpartyForwardingInfo_set_fee_proportional_millionths(struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr, uint32_t val);
14869 * The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
14870 * such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
14871 * `cltv_expiry_delta` for more details.
14873 uint16_t CounterpartyForwardingInfo_get_cltv_expiry_delta(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr);
14876 * The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
14877 * such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
14878 * `cltv_expiry_delta` for more details.
14880 void CounterpartyForwardingInfo_set_cltv_expiry_delta(struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr, uint16_t val);
14883 * Constructs a new CounterpartyForwardingInfo given each field
14885 MUST_USE_RES struct LDKCounterpartyForwardingInfo CounterpartyForwardingInfo_new(uint32_t fee_base_msat_arg, uint32_t fee_proportional_millionths_arg, uint16_t cltv_expiry_delta_arg);
14888 * Creates a copy of the CounterpartyForwardingInfo
14890 struct LDKCounterpartyForwardingInfo CounterpartyForwardingInfo_clone(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR orig);
14893 * Frees any resources used by the ChannelCounterparty, if is_owned is set and inner is non-NULL.
14895 void ChannelCounterparty_free(struct LDKChannelCounterparty this_obj);
14898 * The node_id of our counterparty
14900 struct LDKPublicKey ChannelCounterparty_get_node_id(const struct LDKChannelCounterparty *NONNULL_PTR this_ptr);
14903 * The node_id of our counterparty
14905 void ChannelCounterparty_set_node_id(struct LDKChannelCounterparty *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14908 * The Features the channel counterparty provided upon last connection.
14909 * Useful for routing as it is the most up-to-date copy of the counterparty's features and
14910 * many routing-relevant features are present in the init context.
14912 struct LDKInitFeatures ChannelCounterparty_get_features(const struct LDKChannelCounterparty *NONNULL_PTR this_ptr);
14915 * The Features the channel counterparty provided upon last connection.
14916 * Useful for routing as it is the most up-to-date copy of the counterparty's features and
14917 * many routing-relevant features are present in the init context.
14919 void ChannelCounterparty_set_features(struct LDKChannelCounterparty *NONNULL_PTR this_ptr, struct LDKInitFeatures val);
14922 * The value, in satoshis, that must always be held in the channel for our counterparty. This
14923 * value ensures that if our counterparty broadcasts a revoked state, we can punish them by
14924 * claiming at least this value on chain.
14926 * This value is not included in [`inbound_capacity_msat`] as it can never be spent.
14928 * [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
14930 uint64_t ChannelCounterparty_get_unspendable_punishment_reserve(const struct LDKChannelCounterparty *NONNULL_PTR this_ptr);
14933 * The value, in satoshis, that must always be held in the channel for our counterparty. This
14934 * value ensures that if our counterparty broadcasts a revoked state, we can punish them by
14935 * claiming at least this value on chain.
14937 * This value is not included in [`inbound_capacity_msat`] as it can never be spent.
14939 * [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
14941 void ChannelCounterparty_set_unspendable_punishment_reserve(struct LDKChannelCounterparty *NONNULL_PTR this_ptr, uint64_t val);
14944 * Information on the fees and requirements that the counterparty requires when forwarding
14945 * payments to us through this channel.
14947 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
14949 struct LDKCounterpartyForwardingInfo ChannelCounterparty_get_forwarding_info(const struct LDKChannelCounterparty *NONNULL_PTR this_ptr);
14952 * Information on the fees and requirements that the counterparty requires when forwarding
14953 * payments to us through this channel.
14955 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
14957 void ChannelCounterparty_set_forwarding_info(struct LDKChannelCounterparty *NONNULL_PTR this_ptr, struct LDKCounterpartyForwardingInfo val);
14960 * Constructs a new ChannelCounterparty given each field
14962 MUST_USE_RES struct LDKChannelCounterparty ChannelCounterparty_new(struct LDKPublicKey node_id_arg, struct LDKInitFeatures features_arg, uint64_t unspendable_punishment_reserve_arg, struct LDKCounterpartyForwardingInfo forwarding_info_arg);
14965 * Creates a copy of the ChannelCounterparty
14967 struct LDKChannelCounterparty ChannelCounterparty_clone(const struct LDKChannelCounterparty *NONNULL_PTR orig);
14970 * Frees any resources used by the ChannelDetails, if is_owned is set and inner is non-NULL.
14972 void ChannelDetails_free(struct LDKChannelDetails this_obj);
14975 * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
14976 * thereafter this is the txid of the funding transaction xor the funding transaction output).
14977 * Note that this means this value is *not* persistent - it can change once during the
14978 * lifetime of the channel.
14980 const uint8_t (*ChannelDetails_get_channel_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr))[32];
14983 * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
14984 * thereafter this is the txid of the funding transaction xor the funding transaction output).
14985 * Note that this means this value is *not* persistent - it can change once during the
14986 * lifetime of the channel.
14988 void ChannelDetails_set_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14991 * Parameters which apply to our counterparty. See individual fields for more information.
14993 struct LDKChannelCounterparty ChannelDetails_get_counterparty(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
14996 * Parameters which apply to our counterparty. See individual fields for more information.
14998 void ChannelDetails_set_counterparty(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKChannelCounterparty val);
15001 * The Channel's funding transaction output, if we've negotiated the funding transaction with
15002 * our counterparty already.
15004 * Note that, if this has been set, `channel_id` will be equivalent to
15005 * `funding_txo.unwrap().to_channel_id()`.
15007 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
15009 struct LDKOutPoint ChannelDetails_get_funding_txo(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15012 * The Channel's funding transaction output, if we've negotiated the funding transaction with
15013 * our counterparty already.
15015 * Note that, if this has been set, `channel_id` will be equivalent to
15016 * `funding_txo.unwrap().to_channel_id()`.
15018 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
15020 void ChannelDetails_set_funding_txo(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKOutPoint val);
15023 * The position of the funding transaction in the chain. None if the funding transaction has
15024 * not yet been confirmed and the channel fully opened.
15026 struct LDKCOption_u64Z ChannelDetails_get_short_channel_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15029 * The position of the funding transaction in the chain. None if the funding transaction has
15030 * not yet been confirmed and the channel fully opened.
15032 void ChannelDetails_set_short_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
15035 * The value, in satoshis, of this channel as appears in the funding output
15037 uint64_t ChannelDetails_get_channel_value_satoshis(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15040 * The value, in satoshis, of this channel as appears in the funding output
15042 void ChannelDetails_set_channel_value_satoshis(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
15045 * The value, in satoshis, that must always be held in the channel for us. This value ensures
15046 * that if we broadcast a revoked state, our counterparty can punish us by claiming at least
15047 * this value on chain.
15049 * This value is not included in [`outbound_capacity_msat`] as it can never be spent.
15051 * This value will be `None` for outbound channels until the counterparty accepts the channel.
15053 * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
15055 struct LDKCOption_u64Z ChannelDetails_get_unspendable_punishment_reserve(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15058 * The value, in satoshis, that must always be held in the channel for us. This value ensures
15059 * that if we broadcast a revoked state, our counterparty can punish us by claiming at least
15060 * this value on chain.
15062 * This value is not included in [`outbound_capacity_msat`] as it can never be spent.
15064 * This value will be `None` for outbound channels until the counterparty accepts the channel.
15066 * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
15068 void ChannelDetails_set_unspendable_punishment_reserve(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
15071 * The user_id passed in to create_channel, or 0 if the channel was inbound.
15073 uint64_t ChannelDetails_get_user_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15076 * The user_id passed in to create_channel, or 0 if the channel was inbound.
15078 void ChannelDetails_set_user_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
15081 * The available outbound capacity for sending HTLCs to the remote peer. This does not include
15082 * any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
15083 * available for inclusion in new outbound HTLCs). This further does not include any pending
15084 * outgoing HTLCs which are awaiting some other resolution to be sent.
15086 * This value is not exact. Due to various in-flight changes, feerate changes, and our
15087 * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
15088 * should be able to spend nearly this amount.
15090 uint64_t ChannelDetails_get_outbound_capacity_msat(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15093 * The available outbound capacity for sending HTLCs to the remote peer. This does not include
15094 * any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
15095 * available for inclusion in new outbound HTLCs). This further does not include any pending
15096 * outgoing HTLCs which are awaiting some other resolution to be sent.
15098 * This value is not exact. Due to various in-flight changes, feerate changes, and our
15099 * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
15100 * should be able to spend nearly this amount.
15102 void ChannelDetails_set_outbound_capacity_msat(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
15105 * The available inbound capacity for the remote peer to send HTLCs to us. This does not
15106 * include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
15107 * available for inclusion in new inbound HTLCs).
15108 * Note that there are some corner cases not fully handled here, so the actual available
15109 * inbound capacity may be slightly higher than this.
15111 * This value is not exact. Due to various in-flight changes, feerate changes, and our
15112 * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
15113 * However, our counterparty should be able to spend nearly this amount.
15115 uint64_t ChannelDetails_get_inbound_capacity_msat(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15118 * The available inbound capacity for the remote peer to send HTLCs to us. This does not
15119 * include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
15120 * available for inclusion in new inbound HTLCs).
15121 * Note that there are some corner cases not fully handled here, so the actual available
15122 * inbound capacity may be slightly higher than this.
15124 * This value is not exact. Due to various in-flight changes, feerate changes, and our
15125 * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
15126 * However, our counterparty should be able to spend nearly this amount.
15128 void ChannelDetails_set_inbound_capacity_msat(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
15131 * The number of required confirmations on the funding transaction before the funding will be
15132 * considered \"locked\". This number is selected by the channel fundee (i.e. us if
15133 * [`is_outbound`] is *not* set), and can be selected for inbound channels with
15134 * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
15135 * [`ChannelHandshakeLimits::max_minimum_depth`].
15137 * This value will be `None` for outbound channels until the counterparty accepts the channel.
15139 * [`is_outbound`]: ChannelDetails::is_outbound
15140 * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
15141 * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
15143 struct LDKCOption_u32Z ChannelDetails_get_confirmations_required(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15146 * The number of required confirmations on the funding transaction before the funding will be
15147 * considered \"locked\". This number is selected by the channel fundee (i.e. us if
15148 * [`is_outbound`] is *not* set), and can be selected for inbound channels with
15149 * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
15150 * [`ChannelHandshakeLimits::max_minimum_depth`].
15152 * This value will be `None` for outbound channels until the counterparty accepts the channel.
15154 * [`is_outbound`]: ChannelDetails::is_outbound
15155 * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
15156 * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
15158 void ChannelDetails_set_confirmations_required(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u32Z val);
15161 * The number of blocks (after our commitment transaction confirms) that we will need to wait
15162 * until we can claim our funds after we force-close the channel. During this time our
15163 * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
15164 * force-closes the channel and broadcasts a commitment transaction we do not have to wait any
15165 * time to claim our non-HTLC-encumbered funds.
15167 * This value will be `None` for outbound channels until the counterparty accepts the channel.
15169 struct LDKCOption_u16Z ChannelDetails_get_force_close_spend_delay(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15172 * The number of blocks (after our commitment transaction confirms) that we will need to wait
15173 * until we can claim our funds after we force-close the channel. During this time our
15174 * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
15175 * force-closes the channel and broadcasts a commitment transaction we do not have to wait any
15176 * time to claim our non-HTLC-encumbered funds.
15178 * This value will be `None` for outbound channels until the counterparty accepts the channel.
15180 void ChannelDetails_set_force_close_spend_delay(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u16Z val);
15183 * True if the channel was initiated (and thus funded) by us.
15185 bool ChannelDetails_get_is_outbound(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15188 * True if the channel was initiated (and thus funded) by us.
15190 void ChannelDetails_set_is_outbound(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
15193 * True if the channel is confirmed, funding_locked messages have been exchanged, and the
15194 * channel is not currently being shut down. `funding_locked` message exchange implies the
15195 * required confirmation count has been reached (and we were connected to the peer at some
15196 * point after the funding transaction received enough confirmations). The required
15197 * confirmation count is provided in [`confirmations_required`].
15199 * [`confirmations_required`]: ChannelDetails::confirmations_required
15201 bool ChannelDetails_get_is_funding_locked(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15204 * True if the channel is confirmed, funding_locked messages have been exchanged, and the
15205 * channel is not currently being shut down. `funding_locked` message exchange implies the
15206 * required confirmation count has been reached (and we were connected to the peer at some
15207 * point after the funding transaction received enough confirmations). The required
15208 * confirmation count is provided in [`confirmations_required`].
15210 * [`confirmations_required`]: ChannelDetails::confirmations_required
15212 void ChannelDetails_set_is_funding_locked(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
15215 * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
15216 * the peer is connected, and (c) the channel is not currently negotiating a shutdown.
15218 * This is a strict superset of `is_funding_locked`.
15220 bool ChannelDetails_get_is_usable(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15223 * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
15224 * the peer is connected, and (c) the channel is not currently negotiating a shutdown.
15226 * This is a strict superset of `is_funding_locked`.
15228 void ChannelDetails_set_is_usable(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
15231 * True if this channel is (or will be) publicly-announced.
15233 bool ChannelDetails_get_is_public(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15236 * True if this channel is (or will be) publicly-announced.
15238 void ChannelDetails_set_is_public(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
15241 * Constructs a new ChannelDetails given each field
15243 MUST_USE_RES struct LDKChannelDetails ChannelDetails_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKChannelCounterparty counterparty_arg, struct LDKOutPoint funding_txo_arg, struct LDKCOption_u64Z short_channel_id_arg, uint64_t channel_value_satoshis_arg, struct LDKCOption_u64Z unspendable_punishment_reserve_arg, uint64_t user_id_arg, uint64_t outbound_capacity_msat_arg, uint64_t inbound_capacity_msat_arg, struct LDKCOption_u32Z confirmations_required_arg, struct LDKCOption_u16Z force_close_spend_delay_arg, bool is_outbound_arg, bool is_funding_locked_arg, bool is_usable_arg, bool is_public_arg);
15246 * Creates a copy of the ChannelDetails
15248 struct LDKChannelDetails ChannelDetails_clone(const struct LDKChannelDetails *NONNULL_PTR orig);
15251 * Frees any resources used by the PaymentSendFailure
15253 void PaymentSendFailure_free(struct LDKPaymentSendFailure this_ptr);
15256 * Creates a copy of the PaymentSendFailure
15258 struct LDKPaymentSendFailure PaymentSendFailure_clone(const struct LDKPaymentSendFailure *NONNULL_PTR orig);
15261 * Utility method to constructs a new ParameterError-variant PaymentSendFailure
15263 struct LDKPaymentSendFailure PaymentSendFailure_parameter_error(struct LDKAPIError a);
15266 * Utility method to constructs a new PathParameterError-variant PaymentSendFailure
15268 struct LDKPaymentSendFailure PaymentSendFailure_path_parameter_error(struct LDKCVec_CResult_NoneAPIErrorZZ a);
15271 * Utility method to constructs a new AllFailedRetrySafe-variant PaymentSendFailure
15273 struct LDKPaymentSendFailure PaymentSendFailure_all_failed_retry_safe(struct LDKCVec_APIErrorZ a);
15276 * Utility method to constructs a new PartialFailure-variant PaymentSendFailure
15278 struct LDKPaymentSendFailure PaymentSendFailure_partial_failure(struct LDKCVec_CResult_NoneAPIErrorZZ a);
15281 * Constructs a new ChannelManager to hold several channels and route between them.
15283 * This is the main \"logic hub\" for all channel-related actions, and implements
15284 * ChannelMessageHandler.
15286 * Non-proportional fees are fixed according to our risk using the provided fee estimator.
15288 * panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
15290 * Users need to notify the new ChannelManager when a new block is connected or
15291 * disconnected using its `block_connected` and `block_disconnected` methods, starting
15292 * from after `params.latest_hash`.
15294 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);
15297 * Gets the current configuration applied to all new channels, as
15299 MUST_USE_RES struct LDKUserConfig ChannelManager_get_current_default_configuration(const struct LDKChannelManager *NONNULL_PTR this_arg);
15302 * Creates a new outbound channel to the given remote node and with the given value.
15304 * user_id will be provided back as user_channel_id in FundingGenerationReady events to allow
15305 * tracking of which events correspond with which create_channel call. Note that the
15306 * user_channel_id defaults to 0 for inbound channels, so you may wish to avoid using 0 for
15307 * user_id here. user_id has no meaning inside of LDK, it is simply copied to events and
15308 * otherwise ignored.
15310 * If successful, will generate a SendOpenChannel message event, so you should probably poll
15311 * PeerManager::process_events afterwards.
15313 * Raises APIError::APIMisuseError when channel_value_satoshis > 2**24 or push_msat is
15314 * greater than channel_value_satoshis * 1k or channel_value_satoshis is < 1000.
15316 * Note that we do not check if you are currently connected to the given peer. If no
15317 * connection is available, the outbound `open_channel` message may fail to send, resulting in
15318 * the channel eventually being silently forgotten.
15320 * Note that override_config (or a relevant inner pointer) may be NULL or all-0s to represent None
15322 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);
15325 * Gets the list of open channels, in random order. See ChannelDetail field documentation for
15326 * more information.
15328 MUST_USE_RES struct LDKCVec_ChannelDetailsZ ChannelManager_list_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
15331 * Gets the list of usable channels, in random order. Useful as an argument to
15332 * get_route to ensure non-announced channels are used.
15334 * These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
15335 * documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
15338 MUST_USE_RES struct LDKCVec_ChannelDetailsZ ChannelManager_list_usable_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
15341 * Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
15342 * will be accepted on the given channel, and after additional timeout/the closing of all
15343 * pending HTLCs, the channel will be closed on chain.
15345 * * If we are the channel initiator, we will pay between our [`Background`] and
15346 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
15348 * * If our counterparty is the channel initiator, we will require a channel closing
15349 * transaction feerate of at least our [`Background`] feerate or the feerate which
15350 * would appear on a force-closure transaction, whichever is lower. We will allow our
15351 * counterparty to pay as much fee as they'd like, however.
15353 * May generate a SendShutdown message event on success, which should be relayed.
15355 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
15356 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
15357 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
15359 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_close_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*channel_id)[32]);
15362 * Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
15363 * will be accepted on the given channel, and after additional timeout/the closing of all
15364 * pending HTLCs, the channel will be closed on chain.
15366 * `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
15367 * the channel being closed or not:
15368 * * If we are the channel initiator, we will pay at least this feerate on the closing
15369 * transaction. The upper-bound is set by
15370 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
15371 * estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
15372 * * If our counterparty is the channel initiator, we will refuse to accept a channel closure
15373 * transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
15374 * will appear on a force-closure transaction, whichever is lower).
15376 * May generate a SendShutdown message event on success, which should be relayed.
15378 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
15379 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
15380 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
15382 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_close_channel_with_target_feerate(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*channel_id)[32], uint32_t target_feerate_sats_per_1000_weight);
15385 * Force closes a channel, immediately broadcasting the latest local commitment transaction to
15386 * the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
15388 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_force_close_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*channel_id)[32]);
15391 * Force close all channels, immediately broadcasting the latest local commitment transaction
15392 * for each to the chain and rejecting new HTLCs on each.
15394 void ChannelManager_force_close_all_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
15397 * Sends a payment along a given route.
15399 * Value parameters are provided via the last hop in route, see documentation for RouteHop
15400 * fields for more info.
15402 * Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
15403 * payment), we don't do anything to stop you! We always try to ensure that if the provided
15404 * next hop knows the preimage to payment_hash they can claim an additional amount as
15405 * specified in the last hop in the route! Thus, you should probably do your own
15406 * payment_preimage tracking (which you should already be doing as they represent \"proof of
15407 * payment\") and prevent double-sends yourself.
15409 * May generate SendHTLCs message(s) event on success, which should be relayed.
15411 * Each path may have a different return value, and PaymentSendValue may return a Vec with
15412 * each entry matching the corresponding-index entry in the route paths, see
15413 * PaymentSendFailure for more info.
15415 * In general, a path may raise:
15416 * * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
15417 * node public key) is specified.
15418 * * APIError::ChannelUnavailable if the next-hop channel is not available for updates
15419 * (including due to previous monitor update failure or new permanent monitor update
15421 * * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
15422 * relevant updates.
15424 * Note that depending on the type of the PaymentSendFailure the HTLC may have been
15425 * irrevocably committed to on our end. In such a case, do NOT retry the payment with a
15426 * different route unless you intend to pay twice!
15428 * payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
15429 * the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
15430 * newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
15431 * must not contain multiple paths as multi-path payments require a recipient-provided
15433 * If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
15434 * bit set (either as required or as available). If multiple paths are present in the Route,
15435 * we assume the invoice had the basic_mpp feature set.
15437 * Note that payment_secret (or a relevant inner pointer) may be NULL or all-0s to represent None
15439 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);
15442 * Send a spontaneous payment, which is a payment that does not require the recipient to have
15443 * generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
15444 * the preimage, it must be a cryptographically secure random value that no intermediate node
15445 * would be able to guess -- otherwise, an intermediate node may claim the payment and it will
15446 * never reach the recipient.
15448 * See [`send_payment`] documentation for more details on the return value of this function.
15450 * Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
15451 * [`send_payment`] for more information about the risks of duplicate preimage usage.
15453 * Note that `route` must have exactly one path.
15455 * [`send_payment`]: Self::send_payment
15457 * Note that payment_preimage (or a relevant inner pointer) may be NULL or all-0s to represent None
15459 MUST_USE_RES struct LDKCResult_PaymentHashPaymentSendFailureZ ChannelManager_send_spontaneous_payment(const struct LDKChannelManager *NONNULL_PTR this_arg, const struct LDKRoute *NONNULL_PTR route, struct LDKThirtyTwoBytes payment_preimage);
15462 * Call this upon creation of a funding transaction for the given channel.
15464 * Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
15465 * or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
15467 * Panics if a funding transaction has already been provided for this channel.
15469 * May panic if the output found in the funding transaction is duplicative with some other
15470 * channel (note that this should be trivially prevented by using unique funding transaction
15471 * keys per-channel).
15473 * Do NOT broadcast the funding transaction yourself. When we have safely received our
15474 * counterparty's signature the funding transaction will automatically be broadcast via the
15475 * [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
15477 * Note that this includes RBF or similar transaction replacement strategies - lightning does
15478 * not currently support replacing a funding transaction on an existing channel. Instead,
15479 * create a new channel with a conflicting funding transaction.
15481 * [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
15483 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);
15486 * Regenerates channel_announcements and generates a signed node_announcement from the given
15487 * arguments, providing them in corresponding events via
15488 * [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
15489 * on-chain. This effectively re-broadcasts all channel announcements and sends our node
15490 * announcement to ensure that the lightning P2P network is aware of the channels we have and
15491 * our network addresses.
15493 * `rgb` is a node \"color\" and `alias` is a printable human-readable string to describe this
15494 * node to humans. They carry no in-protocol meaning.
15496 * `addresses` represent the set (possibly empty) of socket addresses on which this node
15497 * accepts incoming connections. These will be included in the node_announcement, publicly
15498 * tying these addresses together and to this node. If you wish to preserve user privacy,
15499 * addresses should likely contain only Tor Onion addresses.
15501 * Panics if `addresses` is absurdly large (more than 500).
15503 * [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
15505 void ChannelManager_broadcast_node_announcement(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThreeBytes rgb, struct LDKThirtyTwoBytes alias, struct LDKCVec_NetAddressZ addresses);
15508 * Processes HTLCs which are pending waiting on random forward delay.
15510 * Should only really ever be called in response to a PendingHTLCsForwardable event.
15511 * Will likely generate further events.
15513 void ChannelManager_process_pending_htlc_forwards(const struct LDKChannelManager *NONNULL_PTR this_arg);
15516 * Performs actions which should happen on startup and roughly once per minute thereafter.
15518 * This currently includes:
15519 * * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
15520 * * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
15521 * than a minute, informing the network that they should no longer attempt to route over
15524 * Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
15525 * estimate fetches.
15527 void ChannelManager_timer_tick_occurred(const struct LDKChannelManager *NONNULL_PTR this_arg);
15530 * Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
15531 * after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
15532 * along the path (including in our own channel on which we received it).
15533 * Returns false if no payment was found to fail backwards, true if the process of failing the
15534 * HTLC backwards has been started.
15536 MUST_USE_RES bool ChannelManager_fail_htlc_backwards(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*payment_hash)[32]);
15539 * Provides a payment preimage in response to a PaymentReceived event, returning true and
15540 * generating message events for the net layer to claim the payment, if possible. Thus, you
15541 * should probably kick the net layer to go send messages if this returns true!
15543 * Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
15544 * [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
15545 * event matches your expectation. If you fail to do so and call this method, you may provide
15546 * the sender \"proof-of-payment\" when they did not fulfill the full expected payment.
15548 * May panic if called except in response to a PaymentReceived event.
15550 * [`create_inbound_payment`]: Self::create_inbound_payment
15551 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
15553 MUST_USE_RES bool ChannelManager_claim_funds(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThirtyTwoBytes payment_preimage);
15556 * Gets the node_id held by this ChannelManager
15558 MUST_USE_RES struct LDKPublicKey ChannelManager_get_our_node_id(const struct LDKChannelManager *NONNULL_PTR this_arg);
15561 * Restores a single, given channel to normal operation after a
15562 * ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
15565 * All ChannelMonitor updates up to and including highest_applied_update_id must have been
15566 * fully committed in every copy of the given channels' ChannelMonitors.
15568 * Note that there is no effect to calling with a highest_applied_update_id other than the
15569 * current latest ChannelMonitorUpdate and one call to this function after multiple
15570 * ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
15571 * exists largely only to prevent races between this and concurrent update_monitor calls.
15573 * Thus, the anticipated use is, at a high level:
15574 * 1) You register a chain::Watch with this ChannelManager,
15575 * 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
15576 * said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
15577 * any time it cannot do so instantly,
15578 * 3) update(s) are applied to each remote copy of a ChannelMonitor,
15579 * 4) once all remote copies are updated, you call this function with the update_id that
15580 * completed, and once it is the latest the Channel will be re-enabled.
15582 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);
15585 * Gets a payment secret and payment hash for use in an invoice given to a third party wishing
15588 * This differs from [`create_inbound_payment_for_hash`] only in that it generates the
15589 * [`PaymentHash`] and [`PaymentPreimage`] for you, returning the first and storing the second.
15591 * The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
15592 * will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
15593 * passed directly to [`claim_funds`].
15595 * See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
15597 * [`claim_funds`]: Self::claim_funds
15598 * [`PaymentReceived`]: events::Event::PaymentReceived
15599 * [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
15600 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
15602 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);
15605 * Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
15606 * stored external to LDK.
15608 * A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
15609 * payment secret fetched via this method or [`create_inbound_payment`], and which is at least
15610 * the `min_value_msat` provided here, if one is provided.
15612 * The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
15613 * method may return an Err if another payment with the same payment_hash is still pending.
15615 * `user_payment_id` will be provided back in [`PaymentPurpose::InvoicePayment::user_payment_id`] events to
15616 * allow tracking of which events correspond with which calls to this and
15617 * [`create_inbound_payment`]. `user_payment_id` has no meaning inside of LDK, it is simply
15618 * copied to events and otherwise ignored. It may be used to correlate PaymentReceived events
15619 * with invoice metadata stored elsewhere.
15621 * `min_value_msat` should be set if the invoice being generated contains a value. Any payment
15622 * received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
15623 * before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
15624 * sender \"proof-of-payment\" unless they have paid the required amount.
15626 * `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
15627 * in excess of the current time. This should roughly match the expiry time set in the invoice.
15628 * After this many seconds, we will remove the inbound payment, resulting in any attempts to
15629 * pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
15630 * invoices when no timeout is set.
15632 * Note that we use block header time to time-out pending inbound payments (with some margin
15633 * to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
15634 * accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
15635 * If you need exact expiry semantics, you should enforce them upon receipt of
15636 * [`PaymentReceived`].
15638 * Pending inbound payments are stored in memory and in serialized versions of this
15639 * [`ChannelManager`]. If potentially unbounded numbers of inbound payments may exist and
15640 * space is limited, you may wish to rate-limit inbound payment creation.
15642 * May panic if `invoice_expiry_delta_secs` is greater than one year.
15644 * Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
15645 * set to at least [`MIN_FINAL_CLTV_EXPIRY`].
15647 * [`create_inbound_payment`]: Self::create_inbound_payment
15648 * [`PaymentReceived`]: events::Event::PaymentReceived
15649 * [`PaymentPurpose::InvoicePayment::user_payment_id`]: events::PaymentPurpose::InvoicePayment::user_payment_id
15651 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);
15654 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
15655 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
15657 struct LDKMessageSendEventsProvider ChannelManager_as_MessageSendEventsProvider(const struct LDKChannelManager *NONNULL_PTR this_arg);
15660 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
15661 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
15663 struct LDKEventsProvider ChannelManager_as_EventsProvider(const struct LDKChannelManager *NONNULL_PTR this_arg);
15666 * Constructs a new Listen which calls the relevant methods on this_arg.
15667 * This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
15669 struct LDKListen ChannelManager_as_Listen(const struct LDKChannelManager *NONNULL_PTR this_arg);
15672 * Constructs a new Confirm which calls the relevant methods on this_arg.
15673 * This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
15675 struct LDKConfirm ChannelManager_as_Confirm(const struct LDKChannelManager *NONNULL_PTR this_arg);
15678 * Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
15679 * indicating whether persistence is necessary. Only one listener on
15680 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
15682 * Note that the feature `allow_wallclock_use` must be enabled to use this function.
15684 MUST_USE_RES bool ChannelManager_await_persistable_update_timeout(const struct LDKChannelManager *NONNULL_PTR this_arg, uint64_t max_wait);
15687 * Blocks until ChannelManager needs to be persisted. Only one listener on
15688 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
15691 void ChannelManager_await_persistable_update(const struct LDKChannelManager *NONNULL_PTR this_arg);
15694 * Gets the latest best block which was connected either via the [`chain::Listen`] or
15695 * [`chain::Confirm`] interfaces.
15697 MUST_USE_RES struct LDKBestBlock ChannelManager_current_best_block(const struct LDKChannelManager *NONNULL_PTR this_arg);
15700 * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
15701 * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
15703 struct LDKChannelMessageHandler ChannelManager_as_ChannelMessageHandler(const struct LDKChannelManager *NONNULL_PTR this_arg);
15706 * Serialize the ChannelManager object into a byte array which can be read by ChannelManager_read
15708 struct LDKCVec_u8Z ChannelManager_write(const struct LDKChannelManager *NONNULL_PTR obj);
15711 * Frees any resources used by the ChannelManagerReadArgs, if is_owned is set and inner is non-NULL.
15713 void ChannelManagerReadArgs_free(struct LDKChannelManagerReadArgs this_obj);
15716 * The keys provider which will give us relevant keys. Some keys will be loaded during
15717 * deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
15720 const struct LDKKeysInterface *ChannelManagerReadArgs_get_keys_manager(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
15723 * The keys provider which will give us relevant keys. Some keys will be loaded during
15724 * deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
15727 void ChannelManagerReadArgs_set_keys_manager(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKKeysInterface val);
15730 * The fee_estimator for use in the ChannelManager in the future.
15732 * No calls to the FeeEstimator will be made during deserialization.
15734 const struct LDKFeeEstimator *ChannelManagerReadArgs_get_fee_estimator(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
15737 * The fee_estimator for use in the ChannelManager in the future.
15739 * No calls to the FeeEstimator will be made during deserialization.
15741 void ChannelManagerReadArgs_set_fee_estimator(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKFeeEstimator val);
15744 * The chain::Watch for use in the ChannelManager in the future.
15746 * No calls to the chain::Watch will be made during deserialization. It is assumed that
15747 * you have deserialized ChannelMonitors separately and will add them to your
15748 * chain::Watch after deserializing this ChannelManager.
15750 const struct LDKWatch *ChannelManagerReadArgs_get_chain_monitor(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
15753 * The chain::Watch for use in the ChannelManager in the future.
15755 * No calls to the chain::Watch will be made during deserialization. It is assumed that
15756 * you have deserialized ChannelMonitors separately and will add them to your
15757 * chain::Watch after deserializing this ChannelManager.
15759 void ChannelManagerReadArgs_set_chain_monitor(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKWatch val);
15762 * The BroadcasterInterface which will be used in the ChannelManager in the future and may be
15763 * used to broadcast the latest local commitment transactions of channels which must be
15764 * force-closed during deserialization.
15766 const struct LDKBroadcasterInterface *ChannelManagerReadArgs_get_tx_broadcaster(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
15769 * The BroadcasterInterface which will be used in the ChannelManager in the future and may be
15770 * used to broadcast the latest local commitment transactions of channels which must be
15771 * force-closed during deserialization.
15773 void ChannelManagerReadArgs_set_tx_broadcaster(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKBroadcasterInterface val);
15776 * The Logger for use in the ChannelManager and which may be used to log information during
15779 const struct LDKLogger *ChannelManagerReadArgs_get_logger(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
15782 * The Logger for use in the ChannelManager and which may be used to log information during
15785 void ChannelManagerReadArgs_set_logger(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKLogger val);
15788 * Default settings used for new channels. Any existing channels will continue to use the
15789 * runtime settings which were stored when the ChannelManager was serialized.
15791 struct LDKUserConfig ChannelManagerReadArgs_get_default_config(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
15794 * Default settings used for new channels. Any existing channels will continue to use the
15795 * runtime settings which were stored when the ChannelManager was serialized.
15797 void ChannelManagerReadArgs_set_default_config(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKUserConfig val);
15800 * Simple utility function to create a ChannelManagerReadArgs which creates the monitor
15801 * HashMap for you. This is primarily useful for C bindings where it is not practical to
15802 * populate a HashMap directly from C.
15804 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);
15807 * Read a C2Tuple_BlockHashChannelManagerZ from a byte array, created by C2Tuple_BlockHashChannelManagerZ_write
15809 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ C2Tuple_BlockHashChannelManagerZ_read(struct LDKu8slice ser, struct LDKChannelManagerReadArgs arg);
15812 * Frees any resources used by the DecodeError, if is_owned is set and inner is non-NULL.
15814 void DecodeError_free(struct LDKDecodeError this_obj);
15817 * Creates a copy of the DecodeError
15819 struct LDKDecodeError DecodeError_clone(const struct LDKDecodeError *NONNULL_PTR orig);
15822 * Frees any resources used by the Init, if is_owned is set and inner is non-NULL.
15824 void Init_free(struct LDKInit this_obj);
15827 * The relevant features which the sender supports
15829 struct LDKInitFeatures Init_get_features(const struct LDKInit *NONNULL_PTR this_ptr);
15832 * The relevant features which the sender supports
15834 void Init_set_features(struct LDKInit *NONNULL_PTR this_ptr, struct LDKInitFeatures val);
15837 * Constructs a new Init given each field
15839 MUST_USE_RES struct LDKInit Init_new(struct LDKInitFeatures features_arg);
15842 * Creates a copy of the Init
15844 struct LDKInit Init_clone(const struct LDKInit *NONNULL_PTR orig);
15847 * Frees any resources used by the ErrorMessage, if is_owned is set and inner is non-NULL.
15849 void ErrorMessage_free(struct LDKErrorMessage this_obj);
15852 * The channel ID involved in the error
15854 const uint8_t (*ErrorMessage_get_channel_id(const struct LDKErrorMessage *NONNULL_PTR this_ptr))[32];
15857 * The channel ID involved in the error
15859 void ErrorMessage_set_channel_id(struct LDKErrorMessage *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
15862 * A possibly human-readable error description.
15863 * The string should be sanitized before it is used (e.g. emitted to logs
15864 * or printed to stdout). Otherwise, a well crafted error message may trigger a security
15865 * vulnerability in the terminal emulator or the logging subsystem.
15867 struct LDKStr ErrorMessage_get_data(const struct LDKErrorMessage *NONNULL_PTR this_ptr);
15870 * A possibly human-readable error description.
15871 * The string should be sanitized before it is used (e.g. emitted to logs
15872 * or printed to stdout). Otherwise, a well crafted error message may trigger a security
15873 * vulnerability in the terminal emulator or the logging subsystem.
15875 void ErrorMessage_set_data(struct LDKErrorMessage *NONNULL_PTR this_ptr, struct LDKStr val);
15878 * Constructs a new ErrorMessage given each field
15880 MUST_USE_RES struct LDKErrorMessage ErrorMessage_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKStr data_arg);
15883 * Creates a copy of the ErrorMessage
15885 struct LDKErrorMessage ErrorMessage_clone(const struct LDKErrorMessage *NONNULL_PTR orig);
15888 * Frees any resources used by the Ping, if is_owned is set and inner is non-NULL.
15890 void Ping_free(struct LDKPing this_obj);
15893 * The desired response length
15895 uint16_t Ping_get_ponglen(const struct LDKPing *NONNULL_PTR this_ptr);
15898 * The desired response length
15900 void Ping_set_ponglen(struct LDKPing *NONNULL_PTR this_ptr, uint16_t val);
15903 * The ping packet size.
15904 * This field is not sent on the wire. byteslen zeros are sent.
15906 uint16_t Ping_get_byteslen(const struct LDKPing *NONNULL_PTR this_ptr);
15909 * The ping packet size.
15910 * This field is not sent on the wire. byteslen zeros are sent.
15912 void Ping_set_byteslen(struct LDKPing *NONNULL_PTR this_ptr, uint16_t val);
15915 * Constructs a new Ping given each field
15917 MUST_USE_RES struct LDKPing Ping_new(uint16_t ponglen_arg, uint16_t byteslen_arg);
15920 * Creates a copy of the Ping
15922 struct LDKPing Ping_clone(const struct LDKPing *NONNULL_PTR orig);
15925 * Frees any resources used by the Pong, if is_owned is set and inner is non-NULL.
15927 void Pong_free(struct LDKPong this_obj);
15930 * The pong packet size.
15931 * This field is not sent on the wire. byteslen zeros are sent.
15933 uint16_t Pong_get_byteslen(const struct LDKPong *NONNULL_PTR this_ptr);
15936 * The pong packet size.
15937 * This field is not sent on the wire. byteslen zeros are sent.
15939 void Pong_set_byteslen(struct LDKPong *NONNULL_PTR this_ptr, uint16_t val);
15942 * Constructs a new Pong given each field
15944 MUST_USE_RES struct LDKPong Pong_new(uint16_t byteslen_arg);
15947 * Creates a copy of the Pong
15949 struct LDKPong Pong_clone(const struct LDKPong *NONNULL_PTR orig);
15952 * Frees any resources used by the OpenChannel, if is_owned is set and inner is non-NULL.
15954 void OpenChannel_free(struct LDKOpenChannel this_obj);
15957 * The genesis hash of the blockchain where the channel is to be opened
15959 const uint8_t (*OpenChannel_get_chain_hash(const struct LDKOpenChannel *NONNULL_PTR this_ptr))[32];
15962 * The genesis hash of the blockchain where the channel is to be opened
15964 void OpenChannel_set_chain_hash(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
15967 * A temporary channel ID, until the funding outpoint is announced
15969 const uint8_t (*OpenChannel_get_temporary_channel_id(const struct LDKOpenChannel *NONNULL_PTR this_ptr))[32];
15972 * A temporary channel ID, until the funding outpoint is announced
15974 void OpenChannel_set_temporary_channel_id(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
15977 * The channel value
15979 uint64_t OpenChannel_get_funding_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
15982 * The channel value
15984 void OpenChannel_set_funding_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
15987 * The amount to push to the counterparty as part of the open, in milli-satoshi
15989 uint64_t OpenChannel_get_push_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
15992 * The amount to push to the counterparty as part of the open, in milli-satoshi
15994 void OpenChannel_set_push_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
15997 * The threshold below which outputs on transactions broadcast by sender will be omitted
15999 uint64_t OpenChannel_get_dust_limit_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16002 * The threshold below which outputs on transactions broadcast by sender will be omitted
16004 void OpenChannel_set_dust_limit_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
16007 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
16009 uint64_t OpenChannel_get_max_htlc_value_in_flight_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16012 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
16014 void OpenChannel_set_max_htlc_value_in_flight_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
16017 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
16019 uint64_t OpenChannel_get_channel_reserve_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16022 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
16024 void OpenChannel_set_channel_reserve_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
16027 * The minimum HTLC size incoming to sender, in milli-satoshi
16029 uint64_t OpenChannel_get_htlc_minimum_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16032 * The minimum HTLC size incoming to sender, in milli-satoshi
16034 void OpenChannel_set_htlc_minimum_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
16037 * The feerate per 1000-weight of sender generated transactions, until updated by update_fee
16039 uint32_t OpenChannel_get_feerate_per_kw(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16042 * The feerate per 1000-weight of sender generated transactions, until updated by update_fee
16044 void OpenChannel_set_feerate_per_kw(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint32_t val);
16047 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
16049 uint16_t OpenChannel_get_to_self_delay(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16052 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
16054 void OpenChannel_set_to_self_delay(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint16_t val);
16057 * The maximum number of inbound HTLCs towards sender
16059 uint16_t OpenChannel_get_max_accepted_htlcs(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16062 * The maximum number of inbound HTLCs towards sender
16064 void OpenChannel_set_max_accepted_htlcs(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint16_t val);
16067 * The sender's key controlling the funding transaction
16069 struct LDKPublicKey OpenChannel_get_funding_pubkey(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16072 * The sender's key controlling the funding transaction
16074 void OpenChannel_set_funding_pubkey(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16077 * Used to derive a revocation key for transactions broadcast by counterparty
16079 struct LDKPublicKey OpenChannel_get_revocation_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16082 * Used to derive a revocation key for transactions broadcast by counterparty
16084 void OpenChannel_set_revocation_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16087 * A payment key to sender for transactions broadcast by counterparty
16089 struct LDKPublicKey OpenChannel_get_payment_point(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16092 * A payment key to sender for transactions broadcast by counterparty
16094 void OpenChannel_set_payment_point(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16097 * Used to derive a payment key to sender for transactions broadcast by sender
16099 struct LDKPublicKey OpenChannel_get_delayed_payment_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16102 * Used to derive a payment key to sender for transactions broadcast by sender
16104 void OpenChannel_set_delayed_payment_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16107 * Used to derive an HTLC payment key to sender
16109 struct LDKPublicKey OpenChannel_get_htlc_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16112 * Used to derive an HTLC payment key to sender
16114 void OpenChannel_set_htlc_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16117 * The first to-be-broadcast-by-sender transaction's per commitment point
16119 struct LDKPublicKey OpenChannel_get_first_per_commitment_point(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16122 * The first to-be-broadcast-by-sender transaction's per commitment point
16124 void OpenChannel_set_first_per_commitment_point(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16129 uint8_t OpenChannel_get_channel_flags(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16134 void OpenChannel_set_channel_flags(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint8_t val);
16137 * Creates a copy of the OpenChannel
16139 struct LDKOpenChannel OpenChannel_clone(const struct LDKOpenChannel *NONNULL_PTR orig);
16142 * Frees any resources used by the AcceptChannel, if is_owned is set and inner is non-NULL.
16144 void AcceptChannel_free(struct LDKAcceptChannel this_obj);
16147 * A temporary channel ID, until the funding outpoint is announced
16149 const uint8_t (*AcceptChannel_get_temporary_channel_id(const struct LDKAcceptChannel *NONNULL_PTR this_ptr))[32];
16152 * A temporary channel ID, until the funding outpoint is announced
16154 void AcceptChannel_set_temporary_channel_id(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16157 * The threshold below which outputs on transactions broadcast by sender will be omitted
16159 uint64_t AcceptChannel_get_dust_limit_satoshis(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16162 * The threshold below which outputs on transactions broadcast by sender will be omitted
16164 void AcceptChannel_set_dust_limit_satoshis(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
16167 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
16169 uint64_t AcceptChannel_get_max_htlc_value_in_flight_msat(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16172 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
16174 void AcceptChannel_set_max_htlc_value_in_flight_msat(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
16177 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
16179 uint64_t AcceptChannel_get_channel_reserve_satoshis(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16182 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
16184 void AcceptChannel_set_channel_reserve_satoshis(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
16187 * The minimum HTLC size incoming to sender, in milli-satoshi
16189 uint64_t AcceptChannel_get_htlc_minimum_msat(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16192 * The minimum HTLC size incoming to sender, in milli-satoshi
16194 void AcceptChannel_set_htlc_minimum_msat(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
16197 * Minimum depth of the funding transaction before the channel is considered open
16199 uint32_t AcceptChannel_get_minimum_depth(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16202 * Minimum depth of the funding transaction before the channel is considered open
16204 void AcceptChannel_set_minimum_depth(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint32_t val);
16207 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
16209 uint16_t AcceptChannel_get_to_self_delay(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16212 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
16214 void AcceptChannel_set_to_self_delay(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint16_t val);
16217 * The maximum number of inbound HTLCs towards sender
16219 uint16_t AcceptChannel_get_max_accepted_htlcs(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16222 * The maximum number of inbound HTLCs towards sender
16224 void AcceptChannel_set_max_accepted_htlcs(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint16_t val);
16227 * The sender's key controlling the funding transaction
16229 struct LDKPublicKey AcceptChannel_get_funding_pubkey(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16232 * The sender's key controlling the funding transaction
16234 void AcceptChannel_set_funding_pubkey(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16237 * Used to derive a revocation key for transactions broadcast by counterparty
16239 struct LDKPublicKey AcceptChannel_get_revocation_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16242 * Used to derive a revocation key for transactions broadcast by counterparty
16244 void AcceptChannel_set_revocation_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16247 * A payment key to sender for transactions broadcast by counterparty
16249 struct LDKPublicKey AcceptChannel_get_payment_point(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16252 * A payment key to sender for transactions broadcast by counterparty
16254 void AcceptChannel_set_payment_point(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16257 * Used to derive a payment key to sender for transactions broadcast by sender
16259 struct LDKPublicKey AcceptChannel_get_delayed_payment_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16262 * Used to derive a payment key to sender for transactions broadcast by sender
16264 void AcceptChannel_set_delayed_payment_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16267 * Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
16269 struct LDKPublicKey AcceptChannel_get_htlc_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16272 * Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
16274 void AcceptChannel_set_htlc_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16277 * The first to-be-broadcast-by-sender transaction's per commitment point
16279 struct LDKPublicKey AcceptChannel_get_first_per_commitment_point(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16282 * The first to-be-broadcast-by-sender transaction's per commitment point
16284 void AcceptChannel_set_first_per_commitment_point(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16287 * Creates a copy of the AcceptChannel
16289 struct LDKAcceptChannel AcceptChannel_clone(const struct LDKAcceptChannel *NONNULL_PTR orig);
16292 * Frees any resources used by the FundingCreated, if is_owned is set and inner is non-NULL.
16294 void FundingCreated_free(struct LDKFundingCreated this_obj);
16297 * A temporary channel ID, until the funding is established
16299 const uint8_t (*FundingCreated_get_temporary_channel_id(const struct LDKFundingCreated *NONNULL_PTR this_ptr))[32];
16302 * A temporary channel ID, until the funding is established
16304 void FundingCreated_set_temporary_channel_id(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16307 * The funding transaction ID
16309 const uint8_t (*FundingCreated_get_funding_txid(const struct LDKFundingCreated *NONNULL_PTR this_ptr))[32];
16312 * The funding transaction ID
16314 void FundingCreated_set_funding_txid(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16317 * The specific output index funding this channel
16319 uint16_t FundingCreated_get_funding_output_index(const struct LDKFundingCreated *NONNULL_PTR this_ptr);
16322 * The specific output index funding this channel
16324 void FundingCreated_set_funding_output_index(struct LDKFundingCreated *NONNULL_PTR this_ptr, uint16_t val);
16327 * The signature of the channel initiator (funder) on the initial commitment transaction
16329 struct LDKSignature FundingCreated_get_signature(const struct LDKFundingCreated *NONNULL_PTR this_ptr);
16332 * The signature of the channel initiator (funder) on the initial commitment transaction
16334 void FundingCreated_set_signature(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKSignature val);
16337 * Constructs a new FundingCreated given each field
16339 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);
16342 * Creates a copy of the FundingCreated
16344 struct LDKFundingCreated FundingCreated_clone(const struct LDKFundingCreated *NONNULL_PTR orig);
16347 * Frees any resources used by the FundingSigned, if is_owned is set and inner is non-NULL.
16349 void FundingSigned_free(struct LDKFundingSigned this_obj);
16354 const uint8_t (*FundingSigned_get_channel_id(const struct LDKFundingSigned *NONNULL_PTR this_ptr))[32];
16359 void FundingSigned_set_channel_id(struct LDKFundingSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16362 * The signature of the channel acceptor (fundee) on the initial commitment transaction
16364 struct LDKSignature FundingSigned_get_signature(const struct LDKFundingSigned *NONNULL_PTR this_ptr);
16367 * The signature of the channel acceptor (fundee) on the initial commitment transaction
16369 void FundingSigned_set_signature(struct LDKFundingSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
16372 * Constructs a new FundingSigned given each field
16374 MUST_USE_RES struct LDKFundingSigned FundingSigned_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKSignature signature_arg);
16377 * Creates a copy of the FundingSigned
16379 struct LDKFundingSigned FundingSigned_clone(const struct LDKFundingSigned *NONNULL_PTR orig);
16382 * Frees any resources used by the FundingLocked, if is_owned is set and inner is non-NULL.
16384 void FundingLocked_free(struct LDKFundingLocked this_obj);
16389 const uint8_t (*FundingLocked_get_channel_id(const struct LDKFundingLocked *NONNULL_PTR this_ptr))[32];
16394 void FundingLocked_set_channel_id(struct LDKFundingLocked *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16397 * The per-commitment point of the second commitment transaction
16399 struct LDKPublicKey FundingLocked_get_next_per_commitment_point(const struct LDKFundingLocked *NONNULL_PTR this_ptr);
16402 * The per-commitment point of the second commitment transaction
16404 void FundingLocked_set_next_per_commitment_point(struct LDKFundingLocked *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16407 * Constructs a new FundingLocked given each field
16409 MUST_USE_RES struct LDKFundingLocked FundingLocked_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKPublicKey next_per_commitment_point_arg);
16412 * Creates a copy of the FundingLocked
16414 struct LDKFundingLocked FundingLocked_clone(const struct LDKFundingLocked *NONNULL_PTR orig);
16417 * Frees any resources used by the Shutdown, if is_owned is set and inner is non-NULL.
16419 void Shutdown_free(struct LDKShutdown this_obj);
16424 const uint8_t (*Shutdown_get_channel_id(const struct LDKShutdown *NONNULL_PTR this_ptr))[32];
16429 void Shutdown_set_channel_id(struct LDKShutdown *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16432 * The destination of this peer's funds on closing.
16433 * Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
16435 struct LDKu8slice Shutdown_get_scriptpubkey(const struct LDKShutdown *NONNULL_PTR this_ptr);
16438 * The destination of this peer's funds on closing.
16439 * Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
16441 void Shutdown_set_scriptpubkey(struct LDKShutdown *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
16444 * Constructs a new Shutdown given each field
16446 MUST_USE_RES struct LDKShutdown Shutdown_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKCVec_u8Z scriptpubkey_arg);
16449 * Creates a copy of the Shutdown
16451 struct LDKShutdown Shutdown_clone(const struct LDKShutdown *NONNULL_PTR orig);
16454 * Frees any resources used by the ClosingSignedFeeRange, if is_owned is set and inner is non-NULL.
16456 void ClosingSignedFeeRange_free(struct LDKClosingSignedFeeRange this_obj);
16459 * The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
16462 uint64_t ClosingSignedFeeRange_get_min_fee_satoshis(const struct LDKClosingSignedFeeRange *NONNULL_PTR this_ptr);
16465 * The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
16468 void ClosingSignedFeeRange_set_min_fee_satoshis(struct LDKClosingSignedFeeRange *NONNULL_PTR this_ptr, uint64_t val);
16471 * The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
16474 uint64_t ClosingSignedFeeRange_get_max_fee_satoshis(const struct LDKClosingSignedFeeRange *NONNULL_PTR this_ptr);
16477 * The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
16480 void ClosingSignedFeeRange_set_max_fee_satoshis(struct LDKClosingSignedFeeRange *NONNULL_PTR this_ptr, uint64_t val);
16483 * Constructs a new ClosingSignedFeeRange given each field
16485 MUST_USE_RES struct LDKClosingSignedFeeRange ClosingSignedFeeRange_new(uint64_t min_fee_satoshis_arg, uint64_t max_fee_satoshis_arg);
16488 * Creates a copy of the ClosingSignedFeeRange
16490 struct LDKClosingSignedFeeRange ClosingSignedFeeRange_clone(const struct LDKClosingSignedFeeRange *NONNULL_PTR orig);
16493 * Frees any resources used by the ClosingSigned, if is_owned is set and inner is non-NULL.
16495 void ClosingSigned_free(struct LDKClosingSigned this_obj);
16500 const uint8_t (*ClosingSigned_get_channel_id(const struct LDKClosingSigned *NONNULL_PTR this_ptr))[32];
16505 void ClosingSigned_set_channel_id(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16508 * The proposed total fee for the closing transaction
16510 uint64_t ClosingSigned_get_fee_satoshis(const struct LDKClosingSigned *NONNULL_PTR this_ptr);
16513 * The proposed total fee for the closing transaction
16515 void ClosingSigned_set_fee_satoshis(struct LDKClosingSigned *NONNULL_PTR this_ptr, uint64_t val);
16518 * A signature on the closing transaction
16520 struct LDKSignature ClosingSigned_get_signature(const struct LDKClosingSigned *NONNULL_PTR this_ptr);
16523 * A signature on the closing transaction
16525 void ClosingSigned_set_signature(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
16528 * The minimum and maximum fees which the sender is willing to accept, provided only by new
16531 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
16533 struct LDKClosingSignedFeeRange ClosingSigned_get_fee_range(const struct LDKClosingSigned *NONNULL_PTR this_ptr);
16536 * The minimum and maximum fees which the sender is willing to accept, provided only by new
16539 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
16541 void ClosingSigned_set_fee_range(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKClosingSignedFeeRange val);
16544 * Constructs a new ClosingSigned given each field
16546 MUST_USE_RES struct LDKClosingSigned ClosingSigned_new(struct LDKThirtyTwoBytes channel_id_arg, uint64_t fee_satoshis_arg, struct LDKSignature signature_arg, struct LDKClosingSignedFeeRange fee_range_arg);
16549 * Creates a copy of the ClosingSigned
16551 struct LDKClosingSigned ClosingSigned_clone(const struct LDKClosingSigned *NONNULL_PTR orig);
16554 * Frees any resources used by the UpdateAddHTLC, if is_owned is set and inner is non-NULL.
16556 void UpdateAddHTLC_free(struct LDKUpdateAddHTLC this_obj);
16561 const uint8_t (*UpdateAddHTLC_get_channel_id(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr))[32];
16566 void UpdateAddHTLC_set_channel_id(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16571 uint64_t UpdateAddHTLC_get_htlc_id(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
16576 void UpdateAddHTLC_set_htlc_id(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint64_t val);
16579 * The HTLC value in milli-satoshi
16581 uint64_t UpdateAddHTLC_get_amount_msat(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
16584 * The HTLC value in milli-satoshi
16586 void UpdateAddHTLC_set_amount_msat(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint64_t val);
16589 * The payment hash, the pre-image of which controls HTLC redemption
16591 const uint8_t (*UpdateAddHTLC_get_payment_hash(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr))[32];
16594 * The payment hash, the pre-image of which controls HTLC redemption
16596 void UpdateAddHTLC_set_payment_hash(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16599 * The expiry height of the HTLC
16601 uint32_t UpdateAddHTLC_get_cltv_expiry(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
16604 * The expiry height of the HTLC
16606 void UpdateAddHTLC_set_cltv_expiry(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint32_t val);
16609 * Creates a copy of the UpdateAddHTLC
16611 struct LDKUpdateAddHTLC UpdateAddHTLC_clone(const struct LDKUpdateAddHTLC *NONNULL_PTR orig);
16614 * Frees any resources used by the UpdateFulfillHTLC, if is_owned is set and inner is non-NULL.
16616 void UpdateFulfillHTLC_free(struct LDKUpdateFulfillHTLC this_obj);
16621 const uint8_t (*UpdateFulfillHTLC_get_channel_id(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr))[32];
16626 void UpdateFulfillHTLC_set_channel_id(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16631 uint64_t UpdateFulfillHTLC_get_htlc_id(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr);
16636 void UpdateFulfillHTLC_set_htlc_id(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, uint64_t val);
16639 * The pre-image of the payment hash, allowing HTLC redemption
16641 const uint8_t (*UpdateFulfillHTLC_get_payment_preimage(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr))[32];
16644 * The pre-image of the payment hash, allowing HTLC redemption
16646 void UpdateFulfillHTLC_set_payment_preimage(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16649 * Constructs a new UpdateFulfillHTLC given each field
16651 MUST_USE_RES struct LDKUpdateFulfillHTLC UpdateFulfillHTLC_new(struct LDKThirtyTwoBytes channel_id_arg, uint64_t htlc_id_arg, struct LDKThirtyTwoBytes payment_preimage_arg);
16654 * Creates a copy of the UpdateFulfillHTLC
16656 struct LDKUpdateFulfillHTLC UpdateFulfillHTLC_clone(const struct LDKUpdateFulfillHTLC *NONNULL_PTR orig);
16659 * Frees any resources used by the UpdateFailHTLC, if is_owned is set and inner is non-NULL.
16661 void UpdateFailHTLC_free(struct LDKUpdateFailHTLC this_obj);
16666 const uint8_t (*UpdateFailHTLC_get_channel_id(const struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr))[32];
16671 void UpdateFailHTLC_set_channel_id(struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16676 uint64_t UpdateFailHTLC_get_htlc_id(const struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr);
16681 void UpdateFailHTLC_set_htlc_id(struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr, uint64_t val);
16684 * Creates a copy of the UpdateFailHTLC
16686 struct LDKUpdateFailHTLC UpdateFailHTLC_clone(const struct LDKUpdateFailHTLC *NONNULL_PTR orig);
16689 * Frees any resources used by the UpdateFailMalformedHTLC, if is_owned is set and inner is non-NULL.
16691 void UpdateFailMalformedHTLC_free(struct LDKUpdateFailMalformedHTLC this_obj);
16696 const uint8_t (*UpdateFailMalformedHTLC_get_channel_id(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr))[32];
16701 void UpdateFailMalformedHTLC_set_channel_id(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16706 uint64_t UpdateFailMalformedHTLC_get_htlc_id(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr);
16711 void UpdateFailMalformedHTLC_set_htlc_id(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, uint64_t val);
16716 uint16_t UpdateFailMalformedHTLC_get_failure_code(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr);
16721 void UpdateFailMalformedHTLC_set_failure_code(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, uint16_t val);
16724 * Creates a copy of the UpdateFailMalformedHTLC
16726 struct LDKUpdateFailMalformedHTLC UpdateFailMalformedHTLC_clone(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR orig);
16729 * Frees any resources used by the CommitmentSigned, if is_owned is set and inner is non-NULL.
16731 void CommitmentSigned_free(struct LDKCommitmentSigned this_obj);
16736 const uint8_t (*CommitmentSigned_get_channel_id(const struct LDKCommitmentSigned *NONNULL_PTR this_ptr))[32];
16741 void CommitmentSigned_set_channel_id(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16744 * A signature on the commitment transaction
16746 struct LDKSignature CommitmentSigned_get_signature(const struct LDKCommitmentSigned *NONNULL_PTR this_ptr);
16749 * A signature on the commitment transaction
16751 void CommitmentSigned_set_signature(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
16754 * Signatures on the HTLC transactions
16756 void CommitmentSigned_set_htlc_signatures(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKCVec_SignatureZ val);
16759 * Constructs a new CommitmentSigned given each field
16761 MUST_USE_RES struct LDKCommitmentSigned CommitmentSigned_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKSignature signature_arg, struct LDKCVec_SignatureZ htlc_signatures_arg);
16764 * Creates a copy of the CommitmentSigned
16766 struct LDKCommitmentSigned CommitmentSigned_clone(const struct LDKCommitmentSigned *NONNULL_PTR orig);
16769 * Frees any resources used by the RevokeAndACK, if is_owned is set and inner is non-NULL.
16771 void RevokeAndACK_free(struct LDKRevokeAndACK this_obj);
16776 const uint8_t (*RevokeAndACK_get_channel_id(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr))[32];
16781 void RevokeAndACK_set_channel_id(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16784 * The secret corresponding to the per-commitment point
16786 const uint8_t (*RevokeAndACK_get_per_commitment_secret(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr))[32];
16789 * The secret corresponding to the per-commitment point
16791 void RevokeAndACK_set_per_commitment_secret(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16794 * The next sender-broadcast commitment transaction's per-commitment point
16796 struct LDKPublicKey RevokeAndACK_get_next_per_commitment_point(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr);
16799 * The next sender-broadcast commitment transaction's per-commitment point
16801 void RevokeAndACK_set_next_per_commitment_point(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16804 * Constructs a new RevokeAndACK given each field
16806 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);
16809 * Creates a copy of the RevokeAndACK
16811 struct LDKRevokeAndACK RevokeAndACK_clone(const struct LDKRevokeAndACK *NONNULL_PTR orig);
16814 * Frees any resources used by the UpdateFee, if is_owned is set and inner is non-NULL.
16816 void UpdateFee_free(struct LDKUpdateFee this_obj);
16821 const uint8_t (*UpdateFee_get_channel_id(const struct LDKUpdateFee *NONNULL_PTR this_ptr))[32];
16826 void UpdateFee_set_channel_id(struct LDKUpdateFee *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16829 * Fee rate per 1000-weight of the transaction
16831 uint32_t UpdateFee_get_feerate_per_kw(const struct LDKUpdateFee *NONNULL_PTR this_ptr);
16834 * Fee rate per 1000-weight of the transaction
16836 void UpdateFee_set_feerate_per_kw(struct LDKUpdateFee *NONNULL_PTR this_ptr, uint32_t val);
16839 * Constructs a new UpdateFee given each field
16841 MUST_USE_RES struct LDKUpdateFee UpdateFee_new(struct LDKThirtyTwoBytes channel_id_arg, uint32_t feerate_per_kw_arg);
16844 * Creates a copy of the UpdateFee
16846 struct LDKUpdateFee UpdateFee_clone(const struct LDKUpdateFee *NONNULL_PTR orig);
16849 * Frees any resources used by the DataLossProtect, if is_owned is set and inner is non-NULL.
16851 void DataLossProtect_free(struct LDKDataLossProtect this_obj);
16854 * Proof that the sender knows the per-commitment secret of a specific commitment transaction
16855 * belonging to the recipient
16857 const uint8_t (*DataLossProtect_get_your_last_per_commitment_secret(const struct LDKDataLossProtect *NONNULL_PTR this_ptr))[32];
16860 * Proof that the sender knows the per-commitment secret of a specific commitment transaction
16861 * belonging to the recipient
16863 void DataLossProtect_set_your_last_per_commitment_secret(struct LDKDataLossProtect *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16866 * The sender's per-commitment point for their current commitment transaction
16868 struct LDKPublicKey DataLossProtect_get_my_current_per_commitment_point(const struct LDKDataLossProtect *NONNULL_PTR this_ptr);
16871 * The sender's per-commitment point for their current commitment transaction
16873 void DataLossProtect_set_my_current_per_commitment_point(struct LDKDataLossProtect *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16876 * Constructs a new DataLossProtect given each field
16878 MUST_USE_RES struct LDKDataLossProtect DataLossProtect_new(struct LDKThirtyTwoBytes your_last_per_commitment_secret_arg, struct LDKPublicKey my_current_per_commitment_point_arg);
16881 * Creates a copy of the DataLossProtect
16883 struct LDKDataLossProtect DataLossProtect_clone(const struct LDKDataLossProtect *NONNULL_PTR orig);
16886 * Frees any resources used by the ChannelReestablish, if is_owned is set and inner is non-NULL.
16888 void ChannelReestablish_free(struct LDKChannelReestablish this_obj);
16893 const uint8_t (*ChannelReestablish_get_channel_id(const struct LDKChannelReestablish *NONNULL_PTR this_ptr))[32];
16898 void ChannelReestablish_set_channel_id(struct LDKChannelReestablish *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16901 * The next commitment number for the sender
16903 uint64_t ChannelReestablish_get_next_local_commitment_number(const struct LDKChannelReestablish *NONNULL_PTR this_ptr);
16906 * The next commitment number for the sender
16908 void ChannelReestablish_set_next_local_commitment_number(struct LDKChannelReestablish *NONNULL_PTR this_ptr, uint64_t val);
16911 * The next commitment number for the recipient
16913 uint64_t ChannelReestablish_get_next_remote_commitment_number(const struct LDKChannelReestablish *NONNULL_PTR this_ptr);
16916 * The next commitment number for the recipient
16918 void ChannelReestablish_set_next_remote_commitment_number(struct LDKChannelReestablish *NONNULL_PTR this_ptr, uint64_t val);
16921 * Creates a copy of the ChannelReestablish
16923 struct LDKChannelReestablish ChannelReestablish_clone(const struct LDKChannelReestablish *NONNULL_PTR orig);
16926 * Frees any resources used by the AnnouncementSignatures, if is_owned is set and inner is non-NULL.
16928 void AnnouncementSignatures_free(struct LDKAnnouncementSignatures this_obj);
16933 const uint8_t (*AnnouncementSignatures_get_channel_id(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr))[32];
16938 void AnnouncementSignatures_set_channel_id(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16941 * The short channel ID
16943 uint64_t AnnouncementSignatures_get_short_channel_id(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
16946 * The short channel ID
16948 void AnnouncementSignatures_set_short_channel_id(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, uint64_t val);
16951 * A signature by the node key
16953 struct LDKSignature AnnouncementSignatures_get_node_signature(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
16956 * A signature by the node key
16958 void AnnouncementSignatures_set_node_signature(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKSignature val);
16961 * A signature by the funding key
16963 struct LDKSignature AnnouncementSignatures_get_bitcoin_signature(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
16966 * A signature by the funding key
16968 void AnnouncementSignatures_set_bitcoin_signature(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKSignature val);
16971 * Constructs a new AnnouncementSignatures given each field
16973 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);
16976 * Creates a copy of the AnnouncementSignatures
16978 struct LDKAnnouncementSignatures AnnouncementSignatures_clone(const struct LDKAnnouncementSignatures *NONNULL_PTR orig);
16981 * Frees any resources used by the NetAddress
16983 void NetAddress_free(struct LDKNetAddress this_ptr);
16986 * Creates a copy of the NetAddress
16988 struct LDKNetAddress NetAddress_clone(const struct LDKNetAddress *NONNULL_PTR orig);
16991 * Utility method to constructs a new IPv4-variant NetAddress
16993 struct LDKNetAddress NetAddress_ipv4(struct LDKFourBytes addr, uint16_t port);
16996 * Utility method to constructs a new IPv6-variant NetAddress
16998 struct LDKNetAddress NetAddress_ipv6(struct LDKSixteenBytes addr, uint16_t port);
17001 * Utility method to constructs a new OnionV2-variant NetAddress
17003 struct LDKNetAddress NetAddress_onion_v2(struct LDKTenBytes addr, uint16_t port);
17006 * Utility method to constructs a new OnionV3-variant NetAddress
17008 struct LDKNetAddress NetAddress_onion_v3(struct LDKThirtyTwoBytes ed25519_pubkey, uint16_t checksum, uint8_t version, uint16_t port);
17011 * Serialize the NetAddress object into a byte array which can be read by NetAddress_read
17013 struct LDKCVec_u8Z NetAddress_write(const struct LDKNetAddress *NONNULL_PTR obj);
17016 * Read a Result from a byte array, created by Result_write
17018 struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ Result_read(struct LDKu8slice ser);
17021 * Read a NetAddress from a byte array, created by NetAddress_write
17023 struct LDKCResult_NetAddressDecodeErrorZ NetAddress_read(struct LDKu8slice ser);
17026 * Frees any resources used by the UnsignedNodeAnnouncement, if is_owned is set and inner is non-NULL.
17028 void UnsignedNodeAnnouncement_free(struct LDKUnsignedNodeAnnouncement this_obj);
17031 * The advertised features
17033 struct LDKNodeFeatures UnsignedNodeAnnouncement_get_features(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
17036 * The advertised features
17038 void UnsignedNodeAnnouncement_set_features(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
17041 * A strictly monotonic announcement counter, with gaps allowed
17043 uint32_t UnsignedNodeAnnouncement_get_timestamp(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
17046 * A strictly monotonic announcement counter, with gaps allowed
17048 void UnsignedNodeAnnouncement_set_timestamp(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, uint32_t val);
17051 * The node_id this announcement originated from (don't rebroadcast the node_announcement back
17054 struct LDKPublicKey UnsignedNodeAnnouncement_get_node_id(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
17057 * The node_id this announcement originated from (don't rebroadcast the node_announcement back
17060 void UnsignedNodeAnnouncement_set_node_id(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
17063 * An RGB color for UI purposes
17065 const uint8_t (*UnsignedNodeAnnouncement_get_rgb(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr))[3];
17068 * An RGB color for UI purposes
17070 void UnsignedNodeAnnouncement_set_rgb(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKThreeBytes val);
17073 * An alias, for UI purposes. This should be sanitized before use. There is no guarantee
17076 const uint8_t (*UnsignedNodeAnnouncement_get_alias(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr))[32];
17079 * An alias, for UI purposes. This should be sanitized before use. There is no guarantee
17082 void UnsignedNodeAnnouncement_set_alias(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17085 * List of addresses on which this node is reachable
17087 void UnsignedNodeAnnouncement_set_addresses(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKCVec_NetAddressZ val);
17090 * Creates a copy of the UnsignedNodeAnnouncement
17092 struct LDKUnsignedNodeAnnouncement UnsignedNodeAnnouncement_clone(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR orig);
17095 * Frees any resources used by the NodeAnnouncement, if is_owned is set and inner is non-NULL.
17097 void NodeAnnouncement_free(struct LDKNodeAnnouncement this_obj);
17100 * The signature by the node key
17102 struct LDKSignature NodeAnnouncement_get_signature(const struct LDKNodeAnnouncement *NONNULL_PTR this_ptr);
17105 * The signature by the node key
17107 void NodeAnnouncement_set_signature(struct LDKNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
17110 * The actual content of the announcement
17112 struct LDKUnsignedNodeAnnouncement NodeAnnouncement_get_contents(const struct LDKNodeAnnouncement *NONNULL_PTR this_ptr);
17115 * The actual content of the announcement
17117 void NodeAnnouncement_set_contents(struct LDKNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKUnsignedNodeAnnouncement val);
17120 * Constructs a new NodeAnnouncement given each field
17122 MUST_USE_RES struct LDKNodeAnnouncement NodeAnnouncement_new(struct LDKSignature signature_arg, struct LDKUnsignedNodeAnnouncement contents_arg);
17125 * Creates a copy of the NodeAnnouncement
17127 struct LDKNodeAnnouncement NodeAnnouncement_clone(const struct LDKNodeAnnouncement *NONNULL_PTR orig);
17130 * Frees any resources used by the UnsignedChannelAnnouncement, if is_owned is set and inner is non-NULL.
17132 void UnsignedChannelAnnouncement_free(struct LDKUnsignedChannelAnnouncement this_obj);
17135 * The advertised channel features
17137 struct LDKChannelFeatures UnsignedChannelAnnouncement_get_features(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
17140 * The advertised channel features
17142 void UnsignedChannelAnnouncement_set_features(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
17145 * The genesis hash of the blockchain where the channel is to be opened
17147 const uint8_t (*UnsignedChannelAnnouncement_get_chain_hash(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr))[32];
17150 * The genesis hash of the blockchain where the channel is to be opened
17152 void UnsignedChannelAnnouncement_set_chain_hash(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17155 * The short channel ID
17157 uint64_t UnsignedChannelAnnouncement_get_short_channel_id(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
17160 * The short channel ID
17162 void UnsignedChannelAnnouncement_set_short_channel_id(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, uint64_t val);
17165 * One of the two node_ids which are endpoints of this channel
17167 struct LDKPublicKey UnsignedChannelAnnouncement_get_node_id_1(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
17170 * One of the two node_ids which are endpoints of this channel
17172 void UnsignedChannelAnnouncement_set_node_id_1(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
17175 * The other of the two node_ids which are endpoints of this channel
17177 struct LDKPublicKey UnsignedChannelAnnouncement_get_node_id_2(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
17180 * The other of the two node_ids which are endpoints of this channel
17182 void UnsignedChannelAnnouncement_set_node_id_2(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
17185 * The funding key for the first node
17187 struct LDKPublicKey UnsignedChannelAnnouncement_get_bitcoin_key_1(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
17190 * The funding key for the first node
17192 void UnsignedChannelAnnouncement_set_bitcoin_key_1(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
17195 * The funding key for the second node
17197 struct LDKPublicKey UnsignedChannelAnnouncement_get_bitcoin_key_2(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
17200 * The funding key for the second node
17202 void UnsignedChannelAnnouncement_set_bitcoin_key_2(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
17205 * Creates a copy of the UnsignedChannelAnnouncement
17207 struct LDKUnsignedChannelAnnouncement UnsignedChannelAnnouncement_clone(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR orig);
17210 * Frees any resources used by the ChannelAnnouncement, if is_owned is set and inner is non-NULL.
17212 void ChannelAnnouncement_free(struct LDKChannelAnnouncement this_obj);
17215 * Authentication of the announcement by the first public node
17217 struct LDKSignature ChannelAnnouncement_get_node_signature_1(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
17220 * Authentication of the announcement by the first public node
17222 void ChannelAnnouncement_set_node_signature_1(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
17225 * Authentication of the announcement by the second public node
17227 struct LDKSignature ChannelAnnouncement_get_node_signature_2(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
17230 * Authentication of the announcement by the second public node
17232 void ChannelAnnouncement_set_node_signature_2(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
17235 * Proof of funding UTXO ownership by the first public node
17237 struct LDKSignature ChannelAnnouncement_get_bitcoin_signature_1(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
17240 * Proof of funding UTXO ownership by the first public node
17242 void ChannelAnnouncement_set_bitcoin_signature_1(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
17245 * Proof of funding UTXO ownership by the second public node
17247 struct LDKSignature ChannelAnnouncement_get_bitcoin_signature_2(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
17250 * Proof of funding UTXO ownership by the second public node
17252 void ChannelAnnouncement_set_bitcoin_signature_2(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
17255 * The actual announcement
17257 struct LDKUnsignedChannelAnnouncement ChannelAnnouncement_get_contents(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
17260 * The actual announcement
17262 void ChannelAnnouncement_set_contents(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKUnsignedChannelAnnouncement val);
17265 * Constructs a new ChannelAnnouncement given each field
17267 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);
17270 * Creates a copy of the ChannelAnnouncement
17272 struct LDKChannelAnnouncement ChannelAnnouncement_clone(const struct LDKChannelAnnouncement *NONNULL_PTR orig);
17275 * Frees any resources used by the UnsignedChannelUpdate, if is_owned is set and inner is non-NULL.
17277 void UnsignedChannelUpdate_free(struct LDKUnsignedChannelUpdate this_obj);
17280 * The genesis hash of the blockchain where the channel is to be opened
17282 const uint8_t (*UnsignedChannelUpdate_get_chain_hash(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr))[32];
17285 * The genesis hash of the blockchain where the channel is to be opened
17287 void UnsignedChannelUpdate_set_chain_hash(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17290 * The short channel ID
17292 uint64_t UnsignedChannelUpdate_get_short_channel_id(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
17295 * The short channel ID
17297 void UnsignedChannelUpdate_set_short_channel_id(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint64_t val);
17300 * A strictly monotonic announcement counter, with gaps allowed, specific to this channel
17302 uint32_t UnsignedChannelUpdate_get_timestamp(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
17305 * A strictly monotonic announcement counter, with gaps allowed, specific to this channel
17307 void UnsignedChannelUpdate_set_timestamp(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
17312 uint8_t UnsignedChannelUpdate_get_flags(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
17317 void UnsignedChannelUpdate_set_flags(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint8_t val);
17320 * The number of blocks such that if:
17321 * `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
17322 * then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
17323 * the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
17324 * cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
17325 * then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
17326 * forwarding. Note that the HTLC sender is the one who originally sets this value when
17327 * constructing the route.
17329 uint16_t UnsignedChannelUpdate_get_cltv_expiry_delta(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
17332 * The number of blocks such that if:
17333 * `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
17334 * then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
17335 * the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
17336 * cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
17337 * then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
17338 * forwarding. Note that the HTLC sender is the one who originally sets this value when
17339 * constructing the route.
17341 void UnsignedChannelUpdate_set_cltv_expiry_delta(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint16_t val);
17344 * The minimum HTLC size incoming to sender, in milli-satoshi
17346 uint64_t UnsignedChannelUpdate_get_htlc_minimum_msat(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
17349 * The minimum HTLC size incoming to sender, in milli-satoshi
17351 void UnsignedChannelUpdate_set_htlc_minimum_msat(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint64_t val);
17354 * The base HTLC fee charged by sender, in milli-satoshi
17356 uint32_t UnsignedChannelUpdate_get_fee_base_msat(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
17359 * The base HTLC fee charged by sender, in milli-satoshi
17361 void UnsignedChannelUpdate_set_fee_base_msat(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
17364 * The amount to fee multiplier, in micro-satoshi
17366 uint32_t UnsignedChannelUpdate_get_fee_proportional_millionths(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
17369 * The amount to fee multiplier, in micro-satoshi
17371 void UnsignedChannelUpdate_set_fee_proportional_millionths(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
17374 * Creates a copy of the UnsignedChannelUpdate
17376 struct LDKUnsignedChannelUpdate UnsignedChannelUpdate_clone(const struct LDKUnsignedChannelUpdate *NONNULL_PTR orig);
17379 * Frees any resources used by the ChannelUpdate, if is_owned is set and inner is non-NULL.
17381 void ChannelUpdate_free(struct LDKChannelUpdate this_obj);
17384 * A signature of the channel update
17386 struct LDKSignature ChannelUpdate_get_signature(const struct LDKChannelUpdate *NONNULL_PTR this_ptr);
17389 * A signature of the channel update
17391 void ChannelUpdate_set_signature(struct LDKChannelUpdate *NONNULL_PTR this_ptr, struct LDKSignature val);
17394 * The actual channel update
17396 struct LDKUnsignedChannelUpdate ChannelUpdate_get_contents(const struct LDKChannelUpdate *NONNULL_PTR this_ptr);
17399 * The actual channel update
17401 void ChannelUpdate_set_contents(struct LDKChannelUpdate *NONNULL_PTR this_ptr, struct LDKUnsignedChannelUpdate val);
17404 * Constructs a new ChannelUpdate given each field
17406 MUST_USE_RES struct LDKChannelUpdate ChannelUpdate_new(struct LDKSignature signature_arg, struct LDKUnsignedChannelUpdate contents_arg);
17409 * Creates a copy of the ChannelUpdate
17411 struct LDKChannelUpdate ChannelUpdate_clone(const struct LDKChannelUpdate *NONNULL_PTR orig);
17414 * Frees any resources used by the QueryChannelRange, if is_owned is set and inner is non-NULL.
17416 void QueryChannelRange_free(struct LDKQueryChannelRange this_obj);
17419 * The genesis hash of the blockchain being queried
17421 const uint8_t (*QueryChannelRange_get_chain_hash(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr))[32];
17424 * The genesis hash of the blockchain being queried
17426 void QueryChannelRange_set_chain_hash(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17429 * The height of the first block for the channel UTXOs being queried
17431 uint32_t QueryChannelRange_get_first_blocknum(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr);
17434 * The height of the first block for the channel UTXOs being queried
17436 void QueryChannelRange_set_first_blocknum(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, uint32_t val);
17439 * The number of blocks to include in the query results
17441 uint32_t QueryChannelRange_get_number_of_blocks(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr);
17444 * The number of blocks to include in the query results
17446 void QueryChannelRange_set_number_of_blocks(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, uint32_t val);
17449 * Constructs a new QueryChannelRange given each field
17451 MUST_USE_RES struct LDKQueryChannelRange QueryChannelRange_new(struct LDKThirtyTwoBytes chain_hash_arg, uint32_t first_blocknum_arg, uint32_t number_of_blocks_arg);
17454 * Creates a copy of the QueryChannelRange
17456 struct LDKQueryChannelRange QueryChannelRange_clone(const struct LDKQueryChannelRange *NONNULL_PTR orig);
17459 * Frees any resources used by the ReplyChannelRange, if is_owned is set and inner is non-NULL.
17461 void ReplyChannelRange_free(struct LDKReplyChannelRange this_obj);
17464 * The genesis hash of the blockchain being queried
17466 const uint8_t (*ReplyChannelRange_get_chain_hash(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr))[32];
17469 * The genesis hash of the blockchain being queried
17471 void ReplyChannelRange_set_chain_hash(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17474 * The height of the first block in the range of the reply
17476 uint32_t ReplyChannelRange_get_first_blocknum(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
17479 * The height of the first block in the range of the reply
17481 void ReplyChannelRange_set_first_blocknum(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, uint32_t val);
17484 * The number of blocks included in the range of the reply
17486 uint32_t ReplyChannelRange_get_number_of_blocks(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
17489 * The number of blocks included in the range of the reply
17491 void ReplyChannelRange_set_number_of_blocks(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, uint32_t val);
17494 * True when this is the final reply for a query
17496 bool ReplyChannelRange_get_sync_complete(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
17499 * True when this is the final reply for a query
17501 void ReplyChannelRange_set_sync_complete(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, bool val);
17504 * The short_channel_ids in the channel range
17506 void ReplyChannelRange_set_short_channel_ids(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
17509 * Constructs a new ReplyChannelRange given each field
17511 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);
17514 * Creates a copy of the ReplyChannelRange
17516 struct LDKReplyChannelRange ReplyChannelRange_clone(const struct LDKReplyChannelRange *NONNULL_PTR orig);
17519 * Frees any resources used by the QueryShortChannelIds, if is_owned is set and inner is non-NULL.
17521 void QueryShortChannelIds_free(struct LDKQueryShortChannelIds this_obj);
17524 * The genesis hash of the blockchain being queried
17526 const uint8_t (*QueryShortChannelIds_get_chain_hash(const struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr))[32];
17529 * The genesis hash of the blockchain being queried
17531 void QueryShortChannelIds_set_chain_hash(struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17534 * The short_channel_ids that are being queried
17536 void QueryShortChannelIds_set_short_channel_ids(struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
17539 * Constructs a new QueryShortChannelIds given each field
17541 MUST_USE_RES struct LDKQueryShortChannelIds QueryShortChannelIds_new(struct LDKThirtyTwoBytes chain_hash_arg, struct LDKCVec_u64Z short_channel_ids_arg);
17544 * Creates a copy of the QueryShortChannelIds
17546 struct LDKQueryShortChannelIds QueryShortChannelIds_clone(const struct LDKQueryShortChannelIds *NONNULL_PTR orig);
17549 * Frees any resources used by the ReplyShortChannelIdsEnd, if is_owned is set and inner is non-NULL.
17551 void ReplyShortChannelIdsEnd_free(struct LDKReplyShortChannelIdsEnd this_obj);
17554 * The genesis hash of the blockchain that was queried
17556 const uint8_t (*ReplyShortChannelIdsEnd_get_chain_hash(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr))[32];
17559 * The genesis hash of the blockchain that was queried
17561 void ReplyShortChannelIdsEnd_set_chain_hash(struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17564 * Indicates if the query recipient maintains up-to-date channel
17565 * information for the chain_hash
17567 bool ReplyShortChannelIdsEnd_get_full_information(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr);
17570 * Indicates if the query recipient maintains up-to-date channel
17571 * information for the chain_hash
17573 void ReplyShortChannelIdsEnd_set_full_information(struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr, bool val);
17576 * Constructs a new ReplyShortChannelIdsEnd given each field
17578 MUST_USE_RES struct LDKReplyShortChannelIdsEnd ReplyShortChannelIdsEnd_new(struct LDKThirtyTwoBytes chain_hash_arg, bool full_information_arg);
17581 * Creates a copy of the ReplyShortChannelIdsEnd
17583 struct LDKReplyShortChannelIdsEnd ReplyShortChannelIdsEnd_clone(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR orig);
17586 * Frees any resources used by the GossipTimestampFilter, if is_owned is set and inner is non-NULL.
17588 void GossipTimestampFilter_free(struct LDKGossipTimestampFilter this_obj);
17591 * The genesis hash of the blockchain for channel and node information
17593 const uint8_t (*GossipTimestampFilter_get_chain_hash(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr))[32];
17596 * The genesis hash of the blockchain for channel and node information
17598 void GossipTimestampFilter_set_chain_hash(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17601 * The starting unix timestamp
17603 uint32_t GossipTimestampFilter_get_first_timestamp(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr);
17606 * The starting unix timestamp
17608 void GossipTimestampFilter_set_first_timestamp(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, uint32_t val);
17611 * The range of information in seconds
17613 uint32_t GossipTimestampFilter_get_timestamp_range(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr);
17616 * The range of information in seconds
17618 void GossipTimestampFilter_set_timestamp_range(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, uint32_t val);
17621 * Constructs a new GossipTimestampFilter given each field
17623 MUST_USE_RES struct LDKGossipTimestampFilter GossipTimestampFilter_new(struct LDKThirtyTwoBytes chain_hash_arg, uint32_t first_timestamp_arg, uint32_t timestamp_range_arg);
17626 * Creates a copy of the GossipTimestampFilter
17628 struct LDKGossipTimestampFilter GossipTimestampFilter_clone(const struct LDKGossipTimestampFilter *NONNULL_PTR orig);
17631 * Frees any resources used by the ErrorAction
17633 void ErrorAction_free(struct LDKErrorAction this_ptr);
17636 * Creates a copy of the ErrorAction
17638 struct LDKErrorAction ErrorAction_clone(const struct LDKErrorAction *NONNULL_PTR orig);
17641 * Utility method to constructs a new DisconnectPeer-variant ErrorAction
17643 struct LDKErrorAction ErrorAction_disconnect_peer(struct LDKErrorMessage msg);
17646 * Utility method to constructs a new IgnoreError-variant ErrorAction
17648 struct LDKErrorAction ErrorAction_ignore_error(void);
17651 * Utility method to constructs a new IgnoreAndLog-variant ErrorAction
17653 struct LDKErrorAction ErrorAction_ignore_and_log(enum LDKLevel a);
17656 * Utility method to constructs a new SendErrorMessage-variant ErrorAction
17658 struct LDKErrorAction ErrorAction_send_error_message(struct LDKErrorMessage msg);
17661 * Frees any resources used by the LightningError, if is_owned is set and inner is non-NULL.
17663 void LightningError_free(struct LDKLightningError this_obj);
17666 * A human-readable message describing the error
17668 struct LDKStr LightningError_get_err(const struct LDKLightningError *NONNULL_PTR this_ptr);
17671 * A human-readable message describing the error
17673 void LightningError_set_err(struct LDKLightningError *NONNULL_PTR this_ptr, struct LDKStr val);
17676 * The action which should be taken against the offending peer.
17678 struct LDKErrorAction LightningError_get_action(const struct LDKLightningError *NONNULL_PTR this_ptr);
17681 * The action which should be taken against the offending peer.
17683 void LightningError_set_action(struct LDKLightningError *NONNULL_PTR this_ptr, struct LDKErrorAction val);
17686 * Constructs a new LightningError given each field
17688 MUST_USE_RES struct LDKLightningError LightningError_new(struct LDKStr err_arg, struct LDKErrorAction action_arg);
17691 * Creates a copy of the LightningError
17693 struct LDKLightningError LightningError_clone(const struct LDKLightningError *NONNULL_PTR orig);
17696 * Frees any resources used by the CommitmentUpdate, if is_owned is set and inner is non-NULL.
17698 void CommitmentUpdate_free(struct LDKCommitmentUpdate this_obj);
17701 * update_add_htlc messages which should be sent
17703 struct LDKCVec_UpdateAddHTLCZ CommitmentUpdate_get_update_add_htlcs(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
17706 * update_add_htlc messages which should be sent
17708 void CommitmentUpdate_set_update_add_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateAddHTLCZ val);
17711 * update_fulfill_htlc messages which should be sent
17713 struct LDKCVec_UpdateFulfillHTLCZ CommitmentUpdate_get_update_fulfill_htlcs(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
17716 * update_fulfill_htlc messages which should be sent
17718 void CommitmentUpdate_set_update_fulfill_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFulfillHTLCZ val);
17721 * update_fail_htlc messages which should be sent
17723 struct LDKCVec_UpdateFailHTLCZ CommitmentUpdate_get_update_fail_htlcs(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
17726 * update_fail_htlc messages which should be sent
17728 void CommitmentUpdate_set_update_fail_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFailHTLCZ val);
17731 * update_fail_malformed_htlc messages which should be sent
17733 struct LDKCVec_UpdateFailMalformedHTLCZ CommitmentUpdate_get_update_fail_malformed_htlcs(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
17736 * update_fail_malformed_htlc messages which should be sent
17738 void CommitmentUpdate_set_update_fail_malformed_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFailMalformedHTLCZ val);
17741 * An update_fee message which should be sent
17743 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
17745 struct LDKUpdateFee CommitmentUpdate_get_update_fee(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
17748 * An update_fee message which should be sent
17750 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
17752 void CommitmentUpdate_set_update_fee(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKUpdateFee val);
17755 * Finally, the commitment_signed message which should be sent
17757 struct LDKCommitmentSigned CommitmentUpdate_get_commitment_signed(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
17760 * Finally, the commitment_signed message which should be sent
17762 void CommitmentUpdate_set_commitment_signed(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCommitmentSigned val);
17765 * Constructs a new CommitmentUpdate given each field
17767 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);
17770 * Creates a copy of the CommitmentUpdate
17772 struct LDKCommitmentUpdate CommitmentUpdate_clone(const struct LDKCommitmentUpdate *NONNULL_PTR orig);
17775 * Calls the free function if one is set
17777 void ChannelMessageHandler_free(struct LDKChannelMessageHandler this_ptr);
17780 * Calls the free function if one is set
17782 void RoutingMessageHandler_free(struct LDKRoutingMessageHandler this_ptr);
17785 * Serialize the AcceptChannel object into a byte array which can be read by AcceptChannel_read
17787 struct LDKCVec_u8Z AcceptChannel_write(const struct LDKAcceptChannel *NONNULL_PTR obj);
17790 * Read a AcceptChannel from a byte array, created by AcceptChannel_write
17792 struct LDKCResult_AcceptChannelDecodeErrorZ AcceptChannel_read(struct LDKu8slice ser);
17795 * Serialize the AnnouncementSignatures object into a byte array which can be read by AnnouncementSignatures_read
17797 struct LDKCVec_u8Z AnnouncementSignatures_write(const struct LDKAnnouncementSignatures *NONNULL_PTR obj);
17800 * Read a AnnouncementSignatures from a byte array, created by AnnouncementSignatures_write
17802 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ AnnouncementSignatures_read(struct LDKu8slice ser);
17805 * Serialize the ChannelReestablish object into a byte array which can be read by ChannelReestablish_read
17807 struct LDKCVec_u8Z ChannelReestablish_write(const struct LDKChannelReestablish *NONNULL_PTR obj);
17810 * Read a ChannelReestablish from a byte array, created by ChannelReestablish_write
17812 struct LDKCResult_ChannelReestablishDecodeErrorZ ChannelReestablish_read(struct LDKu8slice ser);
17815 * Serialize the ClosingSigned object into a byte array which can be read by ClosingSigned_read
17817 struct LDKCVec_u8Z ClosingSigned_write(const struct LDKClosingSigned *NONNULL_PTR obj);
17820 * Read a ClosingSigned from a byte array, created by ClosingSigned_write
17822 struct LDKCResult_ClosingSignedDecodeErrorZ ClosingSigned_read(struct LDKu8slice ser);
17825 * Serialize the ClosingSignedFeeRange object into a byte array which can be read by ClosingSignedFeeRange_read
17827 struct LDKCVec_u8Z ClosingSignedFeeRange_write(const struct LDKClosingSignedFeeRange *NONNULL_PTR obj);
17830 * Read a ClosingSignedFeeRange from a byte array, created by ClosingSignedFeeRange_write
17832 struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ ClosingSignedFeeRange_read(struct LDKu8slice ser);
17835 * Serialize the CommitmentSigned object into a byte array which can be read by CommitmentSigned_read
17837 struct LDKCVec_u8Z CommitmentSigned_write(const struct LDKCommitmentSigned *NONNULL_PTR obj);
17840 * Read a CommitmentSigned from a byte array, created by CommitmentSigned_write
17842 struct LDKCResult_CommitmentSignedDecodeErrorZ CommitmentSigned_read(struct LDKu8slice ser);
17845 * Serialize the FundingCreated object into a byte array which can be read by FundingCreated_read
17847 struct LDKCVec_u8Z FundingCreated_write(const struct LDKFundingCreated *NONNULL_PTR obj);
17850 * Read a FundingCreated from a byte array, created by FundingCreated_write
17852 struct LDKCResult_FundingCreatedDecodeErrorZ FundingCreated_read(struct LDKu8slice ser);
17855 * Serialize the FundingSigned object into a byte array which can be read by FundingSigned_read
17857 struct LDKCVec_u8Z FundingSigned_write(const struct LDKFundingSigned *NONNULL_PTR obj);
17860 * Read a FundingSigned from a byte array, created by FundingSigned_write
17862 struct LDKCResult_FundingSignedDecodeErrorZ FundingSigned_read(struct LDKu8slice ser);
17865 * Serialize the FundingLocked object into a byte array which can be read by FundingLocked_read
17867 struct LDKCVec_u8Z FundingLocked_write(const struct LDKFundingLocked *NONNULL_PTR obj);
17870 * Read a FundingLocked from a byte array, created by FundingLocked_write
17872 struct LDKCResult_FundingLockedDecodeErrorZ FundingLocked_read(struct LDKu8slice ser);
17875 * Serialize the Init object into a byte array which can be read by Init_read
17877 struct LDKCVec_u8Z Init_write(const struct LDKInit *NONNULL_PTR obj);
17880 * Read a Init from a byte array, created by Init_write
17882 struct LDKCResult_InitDecodeErrorZ Init_read(struct LDKu8slice ser);
17885 * Serialize the OpenChannel object into a byte array which can be read by OpenChannel_read
17887 struct LDKCVec_u8Z OpenChannel_write(const struct LDKOpenChannel *NONNULL_PTR obj);
17890 * Read a OpenChannel from a byte array, created by OpenChannel_write
17892 struct LDKCResult_OpenChannelDecodeErrorZ OpenChannel_read(struct LDKu8slice ser);
17895 * Serialize the RevokeAndACK object into a byte array which can be read by RevokeAndACK_read
17897 struct LDKCVec_u8Z RevokeAndACK_write(const struct LDKRevokeAndACK *NONNULL_PTR obj);
17900 * Read a RevokeAndACK from a byte array, created by RevokeAndACK_write
17902 struct LDKCResult_RevokeAndACKDecodeErrorZ RevokeAndACK_read(struct LDKu8slice ser);
17905 * Serialize the Shutdown object into a byte array which can be read by Shutdown_read
17907 struct LDKCVec_u8Z Shutdown_write(const struct LDKShutdown *NONNULL_PTR obj);
17910 * Read a Shutdown from a byte array, created by Shutdown_write
17912 struct LDKCResult_ShutdownDecodeErrorZ Shutdown_read(struct LDKu8slice ser);
17915 * Serialize the UpdateFailHTLC object into a byte array which can be read by UpdateFailHTLC_read
17917 struct LDKCVec_u8Z UpdateFailHTLC_write(const struct LDKUpdateFailHTLC *NONNULL_PTR obj);
17920 * Read a UpdateFailHTLC from a byte array, created by UpdateFailHTLC_write
17922 struct LDKCResult_UpdateFailHTLCDecodeErrorZ UpdateFailHTLC_read(struct LDKu8slice ser);
17925 * Serialize the UpdateFailMalformedHTLC object into a byte array which can be read by UpdateFailMalformedHTLC_read
17927 struct LDKCVec_u8Z UpdateFailMalformedHTLC_write(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR obj);
17930 * Read a UpdateFailMalformedHTLC from a byte array, created by UpdateFailMalformedHTLC_write
17932 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ UpdateFailMalformedHTLC_read(struct LDKu8slice ser);
17935 * Serialize the UpdateFee object into a byte array which can be read by UpdateFee_read
17937 struct LDKCVec_u8Z UpdateFee_write(const struct LDKUpdateFee *NONNULL_PTR obj);
17940 * Read a UpdateFee from a byte array, created by UpdateFee_write
17942 struct LDKCResult_UpdateFeeDecodeErrorZ UpdateFee_read(struct LDKu8slice ser);
17945 * Serialize the UpdateFulfillHTLC object into a byte array which can be read by UpdateFulfillHTLC_read
17947 struct LDKCVec_u8Z UpdateFulfillHTLC_write(const struct LDKUpdateFulfillHTLC *NONNULL_PTR obj);
17950 * Read a UpdateFulfillHTLC from a byte array, created by UpdateFulfillHTLC_write
17952 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ UpdateFulfillHTLC_read(struct LDKu8slice ser);
17955 * Serialize the UpdateAddHTLC object into a byte array which can be read by UpdateAddHTLC_read
17957 struct LDKCVec_u8Z UpdateAddHTLC_write(const struct LDKUpdateAddHTLC *NONNULL_PTR obj);
17960 * Read a UpdateAddHTLC from a byte array, created by UpdateAddHTLC_write
17962 struct LDKCResult_UpdateAddHTLCDecodeErrorZ UpdateAddHTLC_read(struct LDKu8slice ser);
17965 * Serialize the Ping object into a byte array which can be read by Ping_read
17967 struct LDKCVec_u8Z Ping_write(const struct LDKPing *NONNULL_PTR obj);
17970 * Read a Ping from a byte array, created by Ping_write
17972 struct LDKCResult_PingDecodeErrorZ Ping_read(struct LDKu8slice ser);
17975 * Serialize the Pong object into a byte array which can be read by Pong_read
17977 struct LDKCVec_u8Z Pong_write(const struct LDKPong *NONNULL_PTR obj);
17980 * Read a Pong from a byte array, created by Pong_write
17982 struct LDKCResult_PongDecodeErrorZ Pong_read(struct LDKu8slice ser);
17985 * Serialize the UnsignedChannelAnnouncement object into a byte array which can be read by UnsignedChannelAnnouncement_read
17987 struct LDKCVec_u8Z UnsignedChannelAnnouncement_write(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR obj);
17990 * Read a UnsignedChannelAnnouncement from a byte array, created by UnsignedChannelAnnouncement_write
17992 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ UnsignedChannelAnnouncement_read(struct LDKu8slice ser);
17995 * Serialize the ChannelAnnouncement object into a byte array which can be read by ChannelAnnouncement_read
17997 struct LDKCVec_u8Z ChannelAnnouncement_write(const struct LDKChannelAnnouncement *NONNULL_PTR obj);
18000 * Read a ChannelAnnouncement from a byte array, created by ChannelAnnouncement_write
18002 struct LDKCResult_ChannelAnnouncementDecodeErrorZ ChannelAnnouncement_read(struct LDKu8slice ser);
18005 * Serialize the UnsignedChannelUpdate object into a byte array which can be read by UnsignedChannelUpdate_read
18007 struct LDKCVec_u8Z UnsignedChannelUpdate_write(const struct LDKUnsignedChannelUpdate *NONNULL_PTR obj);
18010 * Read a UnsignedChannelUpdate from a byte array, created by UnsignedChannelUpdate_write
18012 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ UnsignedChannelUpdate_read(struct LDKu8slice ser);
18015 * Serialize the ChannelUpdate object into a byte array which can be read by ChannelUpdate_read
18017 struct LDKCVec_u8Z ChannelUpdate_write(const struct LDKChannelUpdate *NONNULL_PTR obj);
18020 * Read a ChannelUpdate from a byte array, created by ChannelUpdate_write
18022 struct LDKCResult_ChannelUpdateDecodeErrorZ ChannelUpdate_read(struct LDKu8slice ser);
18025 * Serialize the ErrorMessage object into a byte array which can be read by ErrorMessage_read
18027 struct LDKCVec_u8Z ErrorMessage_write(const struct LDKErrorMessage *NONNULL_PTR obj);
18030 * Read a ErrorMessage from a byte array, created by ErrorMessage_write
18032 struct LDKCResult_ErrorMessageDecodeErrorZ ErrorMessage_read(struct LDKu8slice ser);
18035 * Serialize the UnsignedNodeAnnouncement object into a byte array which can be read by UnsignedNodeAnnouncement_read
18037 struct LDKCVec_u8Z UnsignedNodeAnnouncement_write(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR obj);
18040 * Read a UnsignedNodeAnnouncement from a byte array, created by UnsignedNodeAnnouncement_write
18042 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ UnsignedNodeAnnouncement_read(struct LDKu8slice ser);
18045 * Serialize the NodeAnnouncement object into a byte array which can be read by NodeAnnouncement_read
18047 struct LDKCVec_u8Z NodeAnnouncement_write(const struct LDKNodeAnnouncement *NONNULL_PTR obj);
18050 * Read a NodeAnnouncement from a byte array, created by NodeAnnouncement_write
18052 struct LDKCResult_NodeAnnouncementDecodeErrorZ NodeAnnouncement_read(struct LDKu8slice ser);
18055 * Read a QueryShortChannelIds from a byte array, created by QueryShortChannelIds_write
18057 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ QueryShortChannelIds_read(struct LDKu8slice ser);
18060 * Serialize the QueryShortChannelIds object into a byte array which can be read by QueryShortChannelIds_read
18062 struct LDKCVec_u8Z QueryShortChannelIds_write(const struct LDKQueryShortChannelIds *NONNULL_PTR obj);
18065 * Serialize the ReplyShortChannelIdsEnd object into a byte array which can be read by ReplyShortChannelIdsEnd_read
18067 struct LDKCVec_u8Z ReplyShortChannelIdsEnd_write(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR obj);
18070 * Read a ReplyShortChannelIdsEnd from a byte array, created by ReplyShortChannelIdsEnd_write
18072 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ ReplyShortChannelIdsEnd_read(struct LDKu8slice ser);
18075 *\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
18077 MUST_USE_RES uint32_t QueryChannelRange_end_blocknum(const struct LDKQueryChannelRange *NONNULL_PTR this_arg);
18080 * Serialize the QueryChannelRange object into a byte array which can be read by QueryChannelRange_read
18082 struct LDKCVec_u8Z QueryChannelRange_write(const struct LDKQueryChannelRange *NONNULL_PTR obj);
18085 * Read a QueryChannelRange from a byte array, created by QueryChannelRange_write
18087 struct LDKCResult_QueryChannelRangeDecodeErrorZ QueryChannelRange_read(struct LDKu8slice ser);
18090 * Read a ReplyChannelRange from a byte array, created by ReplyChannelRange_write
18092 struct LDKCResult_ReplyChannelRangeDecodeErrorZ ReplyChannelRange_read(struct LDKu8slice ser);
18095 * Serialize the ReplyChannelRange object into a byte array which can be read by ReplyChannelRange_read
18097 struct LDKCVec_u8Z ReplyChannelRange_write(const struct LDKReplyChannelRange *NONNULL_PTR obj);
18100 * Serialize the GossipTimestampFilter object into a byte array which can be read by GossipTimestampFilter_read
18102 struct LDKCVec_u8Z GossipTimestampFilter_write(const struct LDKGossipTimestampFilter *NONNULL_PTR obj);
18105 * Read a GossipTimestampFilter from a byte array, created by GossipTimestampFilter_write
18107 struct LDKCResult_GossipTimestampFilterDecodeErrorZ GossipTimestampFilter_read(struct LDKu8slice ser);
18110 * Calls the free function if one is set
18112 void CustomMessageHandler_free(struct LDKCustomMessageHandler this_ptr);
18115 * Frees any resources used by the IgnoringMessageHandler, if is_owned is set and inner is non-NULL.
18117 void IgnoringMessageHandler_free(struct LDKIgnoringMessageHandler this_obj);
18120 * Constructs a new IgnoringMessageHandler given each field
18122 MUST_USE_RES struct LDKIgnoringMessageHandler IgnoringMessageHandler_new(void);
18125 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
18126 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
18128 struct LDKMessageSendEventsProvider IgnoringMessageHandler_as_MessageSendEventsProvider(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
18131 * Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg.
18132 * This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is
18134 struct LDKRoutingMessageHandler IgnoringMessageHandler_as_RoutingMessageHandler(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
18137 * Constructs a new CustomMessageReader which calls the relevant methods on this_arg.
18138 * This copies the `inner` pointer in this_arg and thus the returned CustomMessageReader must be freed before this_arg is
18140 struct LDKCustomMessageReader IgnoringMessageHandler_as_CustomMessageReader(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
18143 * Constructs a new CustomMessageHandler which calls the relevant methods on this_arg.
18144 * This copies the `inner` pointer in this_arg and thus the returned CustomMessageHandler must be freed before this_arg is
18146 struct LDKCustomMessageHandler IgnoringMessageHandler_as_CustomMessageHandler(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
18149 * Frees any resources used by the ErroringMessageHandler, if is_owned is set and inner is non-NULL.
18151 void ErroringMessageHandler_free(struct LDKErroringMessageHandler this_obj);
18154 * Constructs a new ErroringMessageHandler
18156 MUST_USE_RES struct LDKErroringMessageHandler ErroringMessageHandler_new(void);
18159 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
18160 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
18162 struct LDKMessageSendEventsProvider ErroringMessageHandler_as_MessageSendEventsProvider(const struct LDKErroringMessageHandler *NONNULL_PTR this_arg);
18165 * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
18166 * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
18168 struct LDKChannelMessageHandler ErroringMessageHandler_as_ChannelMessageHandler(const struct LDKErroringMessageHandler *NONNULL_PTR this_arg);
18171 * Frees any resources used by the MessageHandler, if is_owned is set and inner is non-NULL.
18173 void MessageHandler_free(struct LDKMessageHandler this_obj);
18176 * A message handler which handles messages specific to channels. Usually this is just a
18177 * [`ChannelManager`] object or an [`ErroringMessageHandler`].
18179 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
18181 const struct LDKChannelMessageHandler *MessageHandler_get_chan_handler(const struct LDKMessageHandler *NONNULL_PTR this_ptr);
18184 * A message handler which handles messages specific to channels. Usually this is just a
18185 * [`ChannelManager`] object or an [`ErroringMessageHandler`].
18187 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
18189 void MessageHandler_set_chan_handler(struct LDKMessageHandler *NONNULL_PTR this_ptr, struct LDKChannelMessageHandler val);
18192 * A message handler which handles messages updating our knowledge of the network channel
18193 * graph. Usually this is just a [`NetGraphMsgHandler`] object or an
18194 * [`IgnoringMessageHandler`].
18196 * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
18198 const struct LDKRoutingMessageHandler *MessageHandler_get_route_handler(const struct LDKMessageHandler *NONNULL_PTR this_ptr);
18201 * A message handler which handles messages updating our knowledge of the network channel
18202 * graph. Usually this is just a [`NetGraphMsgHandler`] object or an
18203 * [`IgnoringMessageHandler`].
18205 * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
18207 void MessageHandler_set_route_handler(struct LDKMessageHandler *NONNULL_PTR this_ptr, struct LDKRoutingMessageHandler val);
18210 * Constructs a new MessageHandler given each field
18212 MUST_USE_RES struct LDKMessageHandler MessageHandler_new(struct LDKChannelMessageHandler chan_handler_arg, struct LDKRoutingMessageHandler route_handler_arg);
18215 * Creates a copy of a SocketDescriptor
18217 struct LDKSocketDescriptor SocketDescriptor_clone(const struct LDKSocketDescriptor *NONNULL_PTR orig);
18220 * Calls the free function if one is set
18222 void SocketDescriptor_free(struct LDKSocketDescriptor this_ptr);
18225 * Frees any resources used by the PeerHandleError, if is_owned is set and inner is non-NULL.
18227 void PeerHandleError_free(struct LDKPeerHandleError this_obj);
18230 * Used to indicate that we probably can't make any future connections to this peer, implying
18231 * we should go ahead and force-close any channels we have with it.
18233 bool PeerHandleError_get_no_connection_possible(const struct LDKPeerHandleError *NONNULL_PTR this_ptr);
18236 * Used to indicate that we probably can't make any future connections to this peer, implying
18237 * we should go ahead and force-close any channels we have with it.
18239 void PeerHandleError_set_no_connection_possible(struct LDKPeerHandleError *NONNULL_PTR this_ptr, bool val);
18242 * Constructs a new PeerHandleError given each field
18244 MUST_USE_RES struct LDKPeerHandleError PeerHandleError_new(bool no_connection_possible_arg);
18247 * Creates a copy of the PeerHandleError
18249 struct LDKPeerHandleError PeerHandleError_clone(const struct LDKPeerHandleError *NONNULL_PTR orig);
18252 * Frees any resources used by the PeerManager, if is_owned is set and inner is non-NULL.
18254 void PeerManager_free(struct LDKPeerManager this_obj);
18257 * Constructs a new PeerManager with the given message handlers and node_id secret key
18258 * ephemeral_random_data is used to derive per-connection ephemeral keys and must be
18259 * cryptographically secure random bytes.
18261 MUST_USE_RES struct LDKPeerManager PeerManager_new(struct LDKMessageHandler message_handler, struct LDKSecretKey our_node_secret, const uint8_t (*ephemeral_random_data)[32], struct LDKLogger logger, struct LDKCustomMessageHandler custom_message_handler);
18264 * Get the list of node ids for peers which have completed the initial handshake.
18266 * For outbound connections, this will be the same as the their_node_id parameter passed in to
18267 * new_outbound_connection, however entries will only appear once the initial handshake has
18268 * completed and we are sure the remote peer has the private key for the given node_id.
18270 MUST_USE_RES struct LDKCVec_PublicKeyZ PeerManager_get_peer_node_ids(const struct LDKPeerManager *NONNULL_PTR this_arg);
18273 * Indicates a new outbound connection has been established to a node with the given node_id.
18274 * Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
18275 * descriptor but must disconnect the connection immediately.
18277 * Returns a small number of bytes to send to the remote node (currently always 50).
18279 * Panics if descriptor is duplicative with some other descriptor which has not yet been
18280 * [`socket_disconnected()`].
18282 * [`socket_disconnected()`]: PeerManager::socket_disconnected
18284 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);
18287 * Indicates a new inbound connection has been established.
18289 * May refuse the connection by returning an Err, but will never write bytes to the remote end
18290 * (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
18291 * call socket_disconnected for the new descriptor but must disconnect the connection
18294 * Panics if descriptor is duplicative with some other descriptor which has not yet been
18295 * [`socket_disconnected()`].
18297 * [`socket_disconnected()`]: PeerManager::socket_disconnected
18299 MUST_USE_RES struct LDKCResult_NonePeerHandleErrorZ PeerManager_new_inbound_connection(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKSocketDescriptor descriptor);
18302 * Indicates that there is room to write data to the given socket descriptor.
18304 * May return an Err to indicate that the connection should be closed.
18306 * May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
18307 * returning. Thus, be very careful with reentrancy issues! The invariants around calling
18308 * [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
18309 * ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
18312 * [`send_data`]: SocketDescriptor::send_data
18313 * [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
18315 MUST_USE_RES struct LDKCResult_NonePeerHandleErrorZ PeerManager_write_buffer_space_avail(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKSocketDescriptor *NONNULL_PTR descriptor);
18318 * Indicates that data was read from the given socket descriptor.
18320 * May return an Err to indicate that the connection should be closed.
18322 * Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
18323 * Thus, however, you should call [`process_events`] after any `read_event` to generate
18324 * [`send_data`] calls to handle responses.
18326 * If `Ok(true)` is returned, further read_events should not be triggered until a
18327 * [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
18330 * [`send_data`]: SocketDescriptor::send_data
18331 * [`process_events`]: PeerManager::process_events
18333 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);
18336 * Checks for any events generated by our handlers and processes them. Includes sending most
18337 * response messages as well as messages generated by calls to handler functions directly (eg
18338 * functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
18340 * May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
18343 * You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
18344 * or one of the other clients provided in our language bindings.
18346 * [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
18347 * [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
18348 * [`send_data`]: SocketDescriptor::send_data
18350 void PeerManager_process_events(const struct LDKPeerManager *NONNULL_PTR this_arg);
18353 * Indicates that the given socket descriptor's connection is now closed.
18355 void PeerManager_socket_disconnected(const struct LDKPeerManager *NONNULL_PTR this_arg, const struct LDKSocketDescriptor *NONNULL_PTR descriptor);
18358 * Disconnect a peer given its node id.
18360 * Set `no_connection_possible` to true to prevent any further connection with this peer,
18361 * force-closing any channels we have with it.
18363 * If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
18364 * peer. Thus, be very careful about reentrancy issues.
18366 * [`disconnect_socket`]: SocketDescriptor::disconnect_socket
18368 void PeerManager_disconnect_by_node_id(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKPublicKey node_id, bool no_connection_possible);
18371 * Send pings to each peer and disconnect those which did not respond to the last round of
18374 * This may be called on any timescale you want, however, roughly once every five to ten
18375 * seconds is preferred. The call rate determines both how often we send a ping to our peers
18376 * and how much time they have to respond before we disconnect them.
18378 * May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
18381 * [`send_data`]: SocketDescriptor::send_data
18383 void PeerManager_timer_tick_occurred(const struct LDKPeerManager *NONNULL_PTR this_arg);
18386 * Build the commitment secret from the seed and the commitment number
18388 struct LDKThirtyTwoBytes build_commitment_secret(const uint8_t (*commitment_seed)[32], uint64_t idx);
18391 * Build a closing transaction
18393 struct LDKTransaction build_closing_transaction(uint64_t to_holder_value_sat, uint64_t to_counterparty_value_sat, struct LDKCVec_u8Z to_holder_script, struct LDKCVec_u8Z to_counterparty_script, struct LDKOutPoint funding_outpoint);
18396 * Derives a per-commitment-transaction private key (eg an htlc key or delayed_payment key)
18397 * from the base secret and the per_commitment_point.
18399 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
18400 * generated (ie our own).
18402 struct LDKCResult_SecretKeyErrorZ derive_private_key(struct LDKPublicKey per_commitment_point, const uint8_t (*base_secret)[32]);
18405 * Derives a per-commitment-transaction public key (eg an htlc key or a delayed_payment key)
18406 * from the base point and the per_commitment_key. This is the public equivalent of
18407 * derive_private_key - using only public keys to derive a public key instead of private keys.
18409 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
18410 * generated (ie our own).
18412 struct LDKCResult_PublicKeyErrorZ derive_public_key(struct LDKPublicKey per_commitment_point, struct LDKPublicKey base_point);
18415 * Derives a per-commitment-transaction revocation key from its constituent parts.
18417 * Only the cheating participant owns a valid witness to propagate a revoked
18418 * commitment transaction, thus per_commitment_secret always come from cheater
18419 * and revocation_base_secret always come from punisher, which is the broadcaster
18420 * of the transaction spending with this key knowledge.
18422 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
18423 * generated (ie our own).
18425 struct LDKCResult_SecretKeyErrorZ derive_private_revocation_key(const uint8_t (*per_commitment_secret)[32], const uint8_t (*countersignatory_revocation_base_secret)[32]);
18428 * Derives a per-commitment-transaction revocation public key from its constituent parts. This is
18429 * the public equivalend of derive_private_revocation_key - using only public keys to derive a
18430 * public key instead of private keys.
18432 * Only the cheating participant owns a valid witness to propagate a revoked
18433 * commitment transaction, thus per_commitment_point always come from cheater
18434 * and revocation_base_point always come from punisher, which is the broadcaster
18435 * of the transaction spending with this key knowledge.
18437 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
18438 * generated (ie our own).
18440 struct LDKCResult_PublicKeyErrorZ derive_public_revocation_key(struct LDKPublicKey per_commitment_point, struct LDKPublicKey countersignatory_revocation_base_point);
18443 * Frees any resources used by the TxCreationKeys, if is_owned is set and inner is non-NULL.
18445 void TxCreationKeys_free(struct LDKTxCreationKeys this_obj);
18448 * The broadcaster's per-commitment public key which was used to derive the other keys.
18450 struct LDKPublicKey TxCreationKeys_get_per_commitment_point(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
18453 * The broadcaster's per-commitment public key which was used to derive the other keys.
18455 void TxCreationKeys_set_per_commitment_point(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
18458 * The revocation key which is used to allow the broadcaster of the commitment
18459 * transaction to provide their counterparty the ability to punish them if they broadcast
18462 struct LDKPublicKey TxCreationKeys_get_revocation_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
18465 * The revocation key which is used to allow the broadcaster of the commitment
18466 * transaction to provide their counterparty the ability to punish them if they broadcast
18469 void TxCreationKeys_set_revocation_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
18472 * Broadcaster's HTLC Key
18474 struct LDKPublicKey TxCreationKeys_get_broadcaster_htlc_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
18477 * Broadcaster's HTLC Key
18479 void TxCreationKeys_set_broadcaster_htlc_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
18482 * Countersignatory's HTLC Key
18484 struct LDKPublicKey TxCreationKeys_get_countersignatory_htlc_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
18487 * Countersignatory's HTLC Key
18489 void TxCreationKeys_set_countersignatory_htlc_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
18492 * Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
18494 struct LDKPublicKey TxCreationKeys_get_broadcaster_delayed_payment_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
18497 * Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
18499 void TxCreationKeys_set_broadcaster_delayed_payment_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
18502 * Constructs a new TxCreationKeys given each field
18504 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);
18507 * Creates a copy of the TxCreationKeys
18509 struct LDKTxCreationKeys TxCreationKeys_clone(const struct LDKTxCreationKeys *NONNULL_PTR orig);
18512 * Serialize the TxCreationKeys object into a byte array which can be read by TxCreationKeys_read
18514 struct LDKCVec_u8Z TxCreationKeys_write(const struct LDKTxCreationKeys *NONNULL_PTR obj);
18517 * Read a TxCreationKeys from a byte array, created by TxCreationKeys_write
18519 struct LDKCResult_TxCreationKeysDecodeErrorZ TxCreationKeys_read(struct LDKu8slice ser);
18522 * Frees any resources used by the ChannelPublicKeys, if is_owned is set and inner is non-NULL.
18524 void ChannelPublicKeys_free(struct LDKChannelPublicKeys this_obj);
18527 * The public key which is used to sign all commitment transactions, as it appears in the
18528 * on-chain channel lock-in 2-of-2 multisig output.
18530 struct LDKPublicKey ChannelPublicKeys_get_funding_pubkey(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
18533 * The public key which is used to sign all commitment transactions, as it appears in the
18534 * on-chain channel lock-in 2-of-2 multisig output.
18536 void ChannelPublicKeys_set_funding_pubkey(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
18539 * The base point which is used (with derive_public_revocation_key) to derive per-commitment
18540 * revocation keys. This is combined with the per-commitment-secret generated by the
18541 * counterparty to create a secret which the counterparty can reveal to revoke previous
18544 struct LDKPublicKey ChannelPublicKeys_get_revocation_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
18547 * The base point which is used (with derive_public_revocation_key) to derive per-commitment
18548 * revocation keys. This is combined with the per-commitment-secret generated by the
18549 * counterparty to create a secret which the counterparty can reveal to revoke previous
18552 void ChannelPublicKeys_set_revocation_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
18555 * The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
18556 * spendable primary channel balance on the broadcaster's commitment transaction. This key is
18557 * static across every commitment transaction.
18559 struct LDKPublicKey ChannelPublicKeys_get_payment_point(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
18562 * The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
18563 * spendable primary channel balance on the broadcaster's commitment transaction. This key is
18564 * static across every commitment transaction.
18566 void ChannelPublicKeys_set_payment_point(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
18569 * The base point which is used (with derive_public_key) to derive a per-commitment payment
18570 * public key which receives non-HTLC-encumbered funds which are only available for spending
18571 * after some delay (or can be claimed via the revocation path).
18573 struct LDKPublicKey ChannelPublicKeys_get_delayed_payment_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
18576 * The base point which is used (with derive_public_key) to derive a per-commitment payment
18577 * public key which receives non-HTLC-encumbered funds which are only available for spending
18578 * after some delay (or can be claimed via the revocation path).
18580 void ChannelPublicKeys_set_delayed_payment_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
18583 * The base point which is used (with derive_public_key) to derive a per-commitment public key
18584 * which is used to encumber HTLC-in-flight outputs.
18586 struct LDKPublicKey ChannelPublicKeys_get_htlc_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
18589 * The base point which is used (with derive_public_key) to derive a per-commitment public key
18590 * which is used to encumber HTLC-in-flight outputs.
18592 void ChannelPublicKeys_set_htlc_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
18595 * Constructs a new ChannelPublicKeys given each field
18597 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);
18600 * Creates a copy of the ChannelPublicKeys
18602 struct LDKChannelPublicKeys ChannelPublicKeys_clone(const struct LDKChannelPublicKeys *NONNULL_PTR orig);
18605 * Serialize the ChannelPublicKeys object into a byte array which can be read by ChannelPublicKeys_read
18607 struct LDKCVec_u8Z ChannelPublicKeys_write(const struct LDKChannelPublicKeys *NONNULL_PTR obj);
18610 * Read a ChannelPublicKeys from a byte array, created by ChannelPublicKeys_write
18612 struct LDKCResult_ChannelPublicKeysDecodeErrorZ ChannelPublicKeys_read(struct LDKu8slice ser);
18615 * Create per-state keys from channel base points and the per-commitment point.
18616 * Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
18618 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);
18621 * Generate per-state keys from channel static keys.
18622 * Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
18624 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);
18627 * A script either spendable by the revocation
18628 * key or the broadcaster_delayed_payment_key and satisfying the relative-locktime OP_CSV constrain.
18629 * Encumbering a `to_holder` output on a commitment transaction or 2nd-stage HTLC transactions.
18631 struct LDKCVec_u8Z get_revokeable_redeemscript(struct LDKPublicKey revocation_key, uint16_t contest_delay, struct LDKPublicKey broadcaster_delayed_payment_key);
18634 * Frees any resources used by the HTLCOutputInCommitment, if is_owned is set and inner is non-NULL.
18636 void HTLCOutputInCommitment_free(struct LDKHTLCOutputInCommitment this_obj);
18639 * Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
18640 * Note that this is not the same as whether it is ountbound *from us*. To determine that you
18641 * need to compare this value to whether the commitment transaction in question is that of
18642 * the counterparty or our own.
18644 bool HTLCOutputInCommitment_get_offered(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
18647 * Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
18648 * Note that this is not the same as whether it is ountbound *from us*. To determine that you
18649 * need to compare this value to whether the commitment transaction in question is that of
18650 * the counterparty or our own.
18652 void HTLCOutputInCommitment_set_offered(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, bool val);
18655 * The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
18656 * this divided by 1000.
18658 uint64_t HTLCOutputInCommitment_get_amount_msat(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
18661 * The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
18662 * this divided by 1000.
18664 void HTLCOutputInCommitment_set_amount_msat(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, uint64_t val);
18667 * The CLTV lock-time at which this HTLC expires.
18669 uint32_t HTLCOutputInCommitment_get_cltv_expiry(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
18672 * The CLTV lock-time at which this HTLC expires.
18674 void HTLCOutputInCommitment_set_cltv_expiry(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, uint32_t val);
18677 * The hash of the preimage which unlocks this HTLC.
18679 const uint8_t (*HTLCOutputInCommitment_get_payment_hash(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr))[32];
18682 * The hash of the preimage which unlocks this HTLC.
18684 void HTLCOutputInCommitment_set_payment_hash(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
18687 * The position within the commitment transactions' outputs. This may be None if the value is
18688 * below the dust limit (in which case no output appears in the commitment transaction and the
18689 * value is spent to additional transaction fees).
18691 struct LDKCOption_u32Z HTLCOutputInCommitment_get_transaction_output_index(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
18694 * The position within the commitment transactions' outputs. This may be None if the value is
18695 * below the dust limit (in which case no output appears in the commitment transaction and the
18696 * value is spent to additional transaction fees).
18698 void HTLCOutputInCommitment_set_transaction_output_index(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, struct LDKCOption_u32Z val);
18701 * Constructs a new HTLCOutputInCommitment given each field
18703 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);
18706 * Creates a copy of the HTLCOutputInCommitment
18708 struct LDKHTLCOutputInCommitment HTLCOutputInCommitment_clone(const struct LDKHTLCOutputInCommitment *NONNULL_PTR orig);
18711 * Serialize the HTLCOutputInCommitment object into a byte array which can be read by HTLCOutputInCommitment_read
18713 struct LDKCVec_u8Z HTLCOutputInCommitment_write(const struct LDKHTLCOutputInCommitment *NONNULL_PTR obj);
18716 * Read a HTLCOutputInCommitment from a byte array, created by HTLCOutputInCommitment_write
18718 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ HTLCOutputInCommitment_read(struct LDKu8slice ser);
18721 * Gets the witness redeemscript for an HTLC output in a commitment transaction. Note that htlc
18722 * does not need to have its previous_output_index filled.
18724 struct LDKCVec_u8Z get_htlc_redeemscript(const struct LDKHTLCOutputInCommitment *NONNULL_PTR htlc, const struct LDKTxCreationKeys *NONNULL_PTR keys);
18727 * Gets the redeemscript for a funding output from the two funding public keys.
18728 * Note that the order of funding public keys does not matter.
18730 struct LDKCVec_u8Z make_funding_redeemscript(struct LDKPublicKey broadcaster, struct LDKPublicKey countersignatory);
18733 * Builds an unsigned HTLC-Success or HTLC-Timeout transaction from the given channel and HTLC
18734 * parameters. This is used by [`TrustedCommitmentTransaction::get_htlc_sigs`] to fetch the
18735 * transaction which needs signing, and can be used to construct an HTLC transaction which is
18736 * broadcastable given a counterparty HTLC signature.
18738 * Panics if htlc.transaction_output_index.is_none() (as such HTLCs do not appear in the
18739 * commitment transaction).
18741 struct LDKTransaction build_htlc_transaction(const uint8_t (*commitment_txid)[32], uint32_t feerate_per_kw, uint16_t contest_delay, const struct LDKHTLCOutputInCommitment *NONNULL_PTR htlc, struct LDKPublicKey broadcaster_delayed_payment_key, struct LDKPublicKey revocation_key);
18744 * Frees any resources used by the ChannelTransactionParameters, if is_owned is set and inner is non-NULL.
18746 void ChannelTransactionParameters_free(struct LDKChannelTransactionParameters this_obj);
18749 * Holder public keys
18751 struct LDKChannelPublicKeys ChannelTransactionParameters_get_holder_pubkeys(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
18754 * Holder public keys
18756 void ChannelTransactionParameters_set_holder_pubkeys(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKChannelPublicKeys val);
18759 * The contest delay selected by the holder, which applies to counterparty-broadcast transactions
18761 uint16_t ChannelTransactionParameters_get_holder_selected_contest_delay(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
18764 * The contest delay selected by the holder, which applies to counterparty-broadcast transactions
18766 void ChannelTransactionParameters_set_holder_selected_contest_delay(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, uint16_t val);
18769 * Whether the holder is the initiator of this channel.
18770 * This is an input to the commitment number obscure factor computation.
18772 bool ChannelTransactionParameters_get_is_outbound_from_holder(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
18775 * Whether the holder is the initiator of this channel.
18776 * This is an input to the commitment number obscure factor computation.
18778 void ChannelTransactionParameters_set_is_outbound_from_holder(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, bool val);
18781 * The late-bound counterparty channel transaction parameters.
18782 * These parameters are populated at the point in the protocol where the counterparty provides them.
18784 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
18786 struct LDKCounterpartyChannelTransactionParameters ChannelTransactionParameters_get_counterparty_parameters(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
18789 * The late-bound counterparty channel transaction parameters.
18790 * These parameters are populated at the point in the protocol where the counterparty provides them.
18792 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
18794 void ChannelTransactionParameters_set_counterparty_parameters(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKCounterpartyChannelTransactionParameters val);
18797 * The late-bound funding outpoint
18799 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
18801 struct LDKOutPoint ChannelTransactionParameters_get_funding_outpoint(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
18804 * The late-bound funding outpoint
18806 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
18808 void ChannelTransactionParameters_set_funding_outpoint(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKOutPoint val);
18811 * Constructs a new ChannelTransactionParameters given each field
18813 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);
18816 * Creates a copy of the ChannelTransactionParameters
18818 struct LDKChannelTransactionParameters ChannelTransactionParameters_clone(const struct LDKChannelTransactionParameters *NONNULL_PTR orig);
18821 * Frees any resources used by the CounterpartyChannelTransactionParameters, if is_owned is set and inner is non-NULL.
18823 void CounterpartyChannelTransactionParameters_free(struct LDKCounterpartyChannelTransactionParameters this_obj);
18826 * Counter-party public keys
18828 struct LDKChannelPublicKeys CounterpartyChannelTransactionParameters_get_pubkeys(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr);
18831 * Counter-party public keys
18833 void CounterpartyChannelTransactionParameters_set_pubkeys(struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKChannelPublicKeys val);
18836 * The contest delay selected by the counterparty, which applies to holder-broadcast transactions
18838 uint16_t CounterpartyChannelTransactionParameters_get_selected_contest_delay(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr);
18841 * The contest delay selected by the counterparty, which applies to holder-broadcast transactions
18843 void CounterpartyChannelTransactionParameters_set_selected_contest_delay(struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr, uint16_t val);
18846 * Constructs a new CounterpartyChannelTransactionParameters given each field
18848 MUST_USE_RES struct LDKCounterpartyChannelTransactionParameters CounterpartyChannelTransactionParameters_new(struct LDKChannelPublicKeys pubkeys_arg, uint16_t selected_contest_delay_arg);
18851 * Creates a copy of the CounterpartyChannelTransactionParameters
18853 struct LDKCounterpartyChannelTransactionParameters CounterpartyChannelTransactionParameters_clone(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR orig);
18856 * Whether the late bound parameters are populated.
18858 MUST_USE_RES bool ChannelTransactionParameters_is_populated(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
18861 * Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
18862 * given that the holder is the broadcaster.
18864 * self.is_populated() must be true before calling this function.
18866 MUST_USE_RES struct LDKDirectedChannelTransactionParameters ChannelTransactionParameters_as_holder_broadcastable(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
18869 * Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
18870 * given that the counterparty is the broadcaster.
18872 * self.is_populated() must be true before calling this function.
18874 MUST_USE_RES struct LDKDirectedChannelTransactionParameters ChannelTransactionParameters_as_counterparty_broadcastable(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
18877 * Serialize the CounterpartyChannelTransactionParameters object into a byte array which can be read by CounterpartyChannelTransactionParameters_read
18879 struct LDKCVec_u8Z CounterpartyChannelTransactionParameters_write(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR obj);
18882 * Read a CounterpartyChannelTransactionParameters from a byte array, created by CounterpartyChannelTransactionParameters_write
18884 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CounterpartyChannelTransactionParameters_read(struct LDKu8slice ser);
18887 * Serialize the ChannelTransactionParameters object into a byte array which can be read by ChannelTransactionParameters_read
18889 struct LDKCVec_u8Z ChannelTransactionParameters_write(const struct LDKChannelTransactionParameters *NONNULL_PTR obj);
18892 * Read a ChannelTransactionParameters from a byte array, created by ChannelTransactionParameters_write
18894 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ ChannelTransactionParameters_read(struct LDKu8slice ser);
18897 * Frees any resources used by the DirectedChannelTransactionParameters, if is_owned is set and inner is non-NULL.
18899 void DirectedChannelTransactionParameters_free(struct LDKDirectedChannelTransactionParameters this_obj);
18902 * Get the channel pubkeys for the broadcaster
18904 MUST_USE_RES struct LDKChannelPublicKeys DirectedChannelTransactionParameters_broadcaster_pubkeys(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
18907 * Get the channel pubkeys for the countersignatory
18909 MUST_USE_RES struct LDKChannelPublicKeys DirectedChannelTransactionParameters_countersignatory_pubkeys(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
18912 * Get the contest delay applicable to the transactions.
18913 * Note that the contest delay was selected by the countersignatory.
18915 MUST_USE_RES uint16_t DirectedChannelTransactionParameters_contest_delay(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
18918 * Whether the channel is outbound from the broadcaster.
18920 * The boolean representing the side that initiated the channel is
18921 * an input to the commitment number obscure factor computation.
18923 MUST_USE_RES bool DirectedChannelTransactionParameters_is_outbound(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
18926 * The funding outpoint
18928 MUST_USE_RES struct LDKOutPoint DirectedChannelTransactionParameters_funding_outpoint(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
18931 * Frees any resources used by the HolderCommitmentTransaction, if is_owned is set and inner is non-NULL.
18933 void HolderCommitmentTransaction_free(struct LDKHolderCommitmentTransaction this_obj);
18936 * Our counterparty's signature for the transaction
18938 struct LDKSignature HolderCommitmentTransaction_get_counterparty_sig(const struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr);
18941 * Our counterparty's signature for the transaction
18943 void HolderCommitmentTransaction_set_counterparty_sig(struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKSignature val);
18946 * All non-dust counterparty HTLC signatures, in the order they appear in the transaction
18948 void HolderCommitmentTransaction_set_counterparty_htlc_sigs(struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKCVec_SignatureZ val);
18951 * Creates a copy of the HolderCommitmentTransaction
18953 struct LDKHolderCommitmentTransaction HolderCommitmentTransaction_clone(const struct LDKHolderCommitmentTransaction *NONNULL_PTR orig);
18956 * Serialize the HolderCommitmentTransaction object into a byte array which can be read by HolderCommitmentTransaction_read
18958 struct LDKCVec_u8Z HolderCommitmentTransaction_write(const struct LDKHolderCommitmentTransaction *NONNULL_PTR obj);
18961 * Read a HolderCommitmentTransaction from a byte array, created by HolderCommitmentTransaction_write
18963 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ HolderCommitmentTransaction_read(struct LDKu8slice ser);
18966 * Create a new holder transaction with the given counterparty signatures.
18967 * The funding keys are used to figure out which signature should go first when building the transaction for broadcast.
18969 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);
18972 * Frees any resources used by the BuiltCommitmentTransaction, if is_owned is set and inner is non-NULL.
18974 void BuiltCommitmentTransaction_free(struct LDKBuiltCommitmentTransaction this_obj);
18977 * The commitment transaction
18979 struct LDKTransaction BuiltCommitmentTransaction_get_transaction(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr);
18982 * The commitment transaction
18984 void BuiltCommitmentTransaction_set_transaction(struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKTransaction val);
18987 * The txid for the commitment transaction.
18989 * This is provided as a performance optimization, instead of calling transaction.txid()
18992 const uint8_t (*BuiltCommitmentTransaction_get_txid(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr))[32];
18995 * The txid for the commitment transaction.
18997 * This is provided as a performance optimization, instead of calling transaction.txid()
19000 void BuiltCommitmentTransaction_set_txid(struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
19003 * Constructs a new BuiltCommitmentTransaction given each field
19005 MUST_USE_RES struct LDKBuiltCommitmentTransaction BuiltCommitmentTransaction_new(struct LDKTransaction transaction_arg, struct LDKThirtyTwoBytes txid_arg);
19008 * Creates a copy of the BuiltCommitmentTransaction
19010 struct LDKBuiltCommitmentTransaction BuiltCommitmentTransaction_clone(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR orig);
19013 * Serialize the BuiltCommitmentTransaction object into a byte array which can be read by BuiltCommitmentTransaction_read
19015 struct LDKCVec_u8Z BuiltCommitmentTransaction_write(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR obj);
19018 * Read a BuiltCommitmentTransaction from a byte array, created by BuiltCommitmentTransaction_write
19020 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ BuiltCommitmentTransaction_read(struct LDKu8slice ser);
19023 * Get the SIGHASH_ALL sighash value of the transaction.
19025 * This can be used to verify a signature.
19027 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);
19030 * Sign a transaction, either because we are counter-signing the counterparty's transaction or
19031 * because we are about to broadcast a holder transaction.
19033 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);
19036 * Frees any resources used by the ClosingTransaction, if is_owned is set and inner is non-NULL.
19038 void ClosingTransaction_free(struct LDKClosingTransaction this_obj);
19041 * Construct an object of the class
19043 MUST_USE_RES struct LDKClosingTransaction ClosingTransaction_new(uint64_t to_holder_value_sat, uint64_t to_counterparty_value_sat, struct LDKCVec_u8Z to_holder_script, struct LDKCVec_u8Z to_counterparty_script, struct LDKOutPoint funding_outpoint);
19046 * Trust our pre-built transaction.
19048 * Applies a wrapper which allows access to the transaction.
19050 * This should only be used if you fully trust the builder of this object. It should not
19051 * be used by an external signer - instead use the verify function.
19053 MUST_USE_RES struct LDKTrustedClosingTransaction ClosingTransaction_trust(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
19056 * Verify our pre-built transaction.
19058 * Applies a wrapper which allows access to the transaction.
19060 * An external validating signer must call this method before signing
19061 * or using the built transaction.
19063 MUST_USE_RES struct LDKCResult_TrustedClosingTransactionNoneZ ClosingTransaction_verify(const struct LDKClosingTransaction *NONNULL_PTR this_arg, struct LDKOutPoint funding_outpoint);
19066 * The value to be sent to the holder, or zero if the output will be omitted
19068 MUST_USE_RES uint64_t ClosingTransaction_to_holder_value_sat(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
19071 * The value to be sent to the counterparty, or zero if the output will be omitted
19073 MUST_USE_RES uint64_t ClosingTransaction_to_counterparty_value_sat(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
19076 * The destination of the holder's output
19078 MUST_USE_RES struct LDKu8slice ClosingTransaction_to_holder_script(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
19081 * The destination of the counterparty's output
19083 MUST_USE_RES struct LDKu8slice ClosingTransaction_to_counterparty_script(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
19086 * Frees any resources used by the TrustedClosingTransaction, if is_owned is set and inner is non-NULL.
19088 void TrustedClosingTransaction_free(struct LDKTrustedClosingTransaction this_obj);
19091 * The pre-built Bitcoin commitment transaction
19093 MUST_USE_RES struct LDKTransaction TrustedClosingTransaction_built_transaction(const struct LDKTrustedClosingTransaction *NONNULL_PTR this_arg);
19096 * Get the SIGHASH_ALL sighash value of the transaction.
19098 * This can be used to verify a signature.
19100 MUST_USE_RES struct LDKThirtyTwoBytes TrustedClosingTransaction_get_sighash_all(const struct LDKTrustedClosingTransaction *NONNULL_PTR this_arg, struct LDKu8slice funding_redeemscript, uint64_t channel_value_satoshis);
19103 * Sign a transaction, either because we are counter-signing the counterparty's transaction or
19104 * because we are about to broadcast a holder transaction.
19106 MUST_USE_RES struct LDKSignature TrustedClosingTransaction_sign(const struct LDKTrustedClosingTransaction *NONNULL_PTR this_arg, const uint8_t (*funding_key)[32], struct LDKu8slice funding_redeemscript, uint64_t channel_value_satoshis);
19109 * Frees any resources used by the CommitmentTransaction, if is_owned is set and inner is non-NULL.
19111 void CommitmentTransaction_free(struct LDKCommitmentTransaction this_obj);
19114 * Creates a copy of the CommitmentTransaction
19116 struct LDKCommitmentTransaction CommitmentTransaction_clone(const struct LDKCommitmentTransaction *NONNULL_PTR orig);
19119 * Serialize the CommitmentTransaction object into a byte array which can be read by CommitmentTransaction_read
19121 struct LDKCVec_u8Z CommitmentTransaction_write(const struct LDKCommitmentTransaction *NONNULL_PTR obj);
19124 * Read a CommitmentTransaction from a byte array, created by CommitmentTransaction_write
19126 struct LDKCResult_CommitmentTransactionDecodeErrorZ CommitmentTransaction_read(struct LDKu8slice ser);
19129 * The backwards-counting commitment number
19131 MUST_USE_RES uint64_t CommitmentTransaction_commitment_number(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
19134 * The value to be sent to the broadcaster
19136 MUST_USE_RES uint64_t CommitmentTransaction_to_broadcaster_value_sat(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
19139 * The value to be sent to the counterparty
19141 MUST_USE_RES uint64_t CommitmentTransaction_to_countersignatory_value_sat(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
19144 * The feerate paid per 1000-weight-unit in this commitment transaction.
19146 MUST_USE_RES uint32_t CommitmentTransaction_feerate_per_kw(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
19149 * Trust our pre-built transaction and derived transaction creation public keys.
19151 * Applies a wrapper which allows access to these fields.
19153 * This should only be used if you fully trust the builder of this object. It should not
19154 * be used by an external signer - instead use the verify function.
19156 MUST_USE_RES struct LDKTrustedCommitmentTransaction CommitmentTransaction_trust(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
19159 * Verify our pre-built transaction and derived transaction creation public keys.
19161 * Applies a wrapper which allows access to these fields.
19163 * An external validating signer must call this method before signing
19164 * or using the built transaction.
19166 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);
19169 * Frees any resources used by the TrustedCommitmentTransaction, if is_owned is set and inner is non-NULL.
19171 void TrustedCommitmentTransaction_free(struct LDKTrustedCommitmentTransaction this_obj);
19174 * The transaction ID of the built Bitcoin transaction
19176 MUST_USE_RES struct LDKThirtyTwoBytes TrustedCommitmentTransaction_txid(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
19179 * The pre-built Bitcoin commitment transaction
19181 MUST_USE_RES struct LDKBuiltCommitmentTransaction TrustedCommitmentTransaction_built_transaction(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
19184 * The pre-calculated transaction creation public keys.
19186 MUST_USE_RES struct LDKTxCreationKeys TrustedCommitmentTransaction_keys(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
19189 * Get a signature for each HTLC which was included in the commitment transaction (ie for
19190 * which HTLCOutputInCommitment::transaction_output_index.is_some()).
19192 * The returned Vec has one entry for each HTLC, and in the same order.
19194 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);
19197 * Commitment transaction numbers which appear in the transactions themselves are XOR'd with a
19198 * shared secret first. This prevents on-chain observers from discovering how many commitment
19199 * transactions occurred in a channel before it was closed.
19201 * This function gets the shared secret from relevant channel public keys and can be used to
19202 * \"decrypt\" the commitment transaction number given a commitment transaction on-chain.
19204 uint64_t get_commitment_transaction_number_obscure_factor(struct LDKPublicKey broadcaster_payment_basepoint, struct LDKPublicKey countersignatory_payment_basepoint, bool outbound_from_broadcaster);
19207 * Checks if two InitFeaturess contain equal inner contents.
19208 * This ignores pointers and is_owned flags and looks at the values in fields.
19209 * Two objects with NULL inner values will be considered "equal" here.
19211 bool InitFeatures_eq(const struct LDKInitFeatures *NONNULL_PTR a, const struct LDKInitFeatures *NONNULL_PTR b);
19214 * Checks if two NodeFeaturess contain equal inner contents.
19215 * This ignores pointers and is_owned flags and looks at the values in fields.
19216 * Two objects with NULL inner values will be considered "equal" here.
19218 bool NodeFeatures_eq(const struct LDKNodeFeatures *NONNULL_PTR a, const struct LDKNodeFeatures *NONNULL_PTR b);
19221 * Checks if two ChannelFeaturess contain equal inner contents.
19222 * This ignores pointers and is_owned flags and looks at the values in fields.
19223 * Two objects with NULL inner values will be considered "equal" here.
19225 bool ChannelFeatures_eq(const struct LDKChannelFeatures *NONNULL_PTR a, const struct LDKChannelFeatures *NONNULL_PTR b);
19228 * Checks if two InvoiceFeaturess contain equal inner contents.
19229 * This ignores pointers and is_owned flags and looks at the values in fields.
19230 * Two objects with NULL inner values will be considered "equal" here.
19232 bool InvoiceFeatures_eq(const struct LDKInvoiceFeatures *NONNULL_PTR a, const struct LDKInvoiceFeatures *NONNULL_PTR b);
19235 * Creates a copy of the InitFeatures
19237 struct LDKInitFeatures InitFeatures_clone(const struct LDKInitFeatures *NONNULL_PTR orig);
19240 * Creates a copy of the NodeFeatures
19242 struct LDKNodeFeatures NodeFeatures_clone(const struct LDKNodeFeatures *NONNULL_PTR orig);
19245 * Creates a copy of the ChannelFeatures
19247 struct LDKChannelFeatures ChannelFeatures_clone(const struct LDKChannelFeatures *NONNULL_PTR orig);
19250 * Creates a copy of the InvoiceFeatures
19252 struct LDKInvoiceFeatures InvoiceFeatures_clone(const struct LDKInvoiceFeatures *NONNULL_PTR orig);
19255 * Frees any resources used by the InitFeatures, if is_owned is set and inner is non-NULL.
19257 void InitFeatures_free(struct LDKInitFeatures this_obj);
19260 * Frees any resources used by the NodeFeatures, if is_owned is set and inner is non-NULL.
19262 void NodeFeatures_free(struct LDKNodeFeatures this_obj);
19265 * Frees any resources used by the ChannelFeatures, if is_owned is set and inner is non-NULL.
19267 void ChannelFeatures_free(struct LDKChannelFeatures this_obj);
19270 * Frees any resources used by the InvoiceFeatures, if is_owned is set and inner is non-NULL.
19272 void InvoiceFeatures_free(struct LDKInvoiceFeatures this_obj);
19275 * Create a blank Features with no features set
19277 MUST_USE_RES struct LDKInitFeatures InitFeatures_empty(void);
19280 * Creates a Features with the bits set which are known by the implementation
19282 MUST_USE_RES struct LDKInitFeatures InitFeatures_known(void);
19285 * Returns true if this `Features` object contains unknown feature flags which are set as
19288 MUST_USE_RES bool InitFeatures_requires_unknown_bits(const struct LDKInitFeatures *NONNULL_PTR this_arg);
19291 * Create a blank Features with no features set
19293 MUST_USE_RES struct LDKNodeFeatures NodeFeatures_empty(void);
19296 * Creates a Features with the bits set which are known by the implementation
19298 MUST_USE_RES struct LDKNodeFeatures NodeFeatures_known(void);
19301 * Returns true if this `Features` object contains unknown feature flags which are set as
19304 MUST_USE_RES bool NodeFeatures_requires_unknown_bits(const struct LDKNodeFeatures *NONNULL_PTR this_arg);
19307 * Create a blank Features with no features set
19309 MUST_USE_RES struct LDKChannelFeatures ChannelFeatures_empty(void);
19312 * Creates a Features with the bits set which are known by the implementation
19314 MUST_USE_RES struct LDKChannelFeatures ChannelFeatures_known(void);
19317 * Returns true if this `Features` object contains unknown feature flags which are set as
19320 MUST_USE_RES bool ChannelFeatures_requires_unknown_bits(const struct LDKChannelFeatures *NONNULL_PTR this_arg);
19323 * Create a blank Features with no features set
19325 MUST_USE_RES struct LDKInvoiceFeatures InvoiceFeatures_empty(void);
19328 * Creates a Features with the bits set which are known by the implementation
19330 MUST_USE_RES struct LDKInvoiceFeatures InvoiceFeatures_known(void);
19333 * Returns true if this `Features` object contains unknown feature flags which are set as
19336 MUST_USE_RES bool InvoiceFeatures_requires_unknown_bits(const struct LDKInvoiceFeatures *NONNULL_PTR this_arg);
19339 * Returns whether the `payment_secret` feature is supported.
19341 MUST_USE_RES bool InitFeatures_supports_payment_secret(const struct LDKInitFeatures *NONNULL_PTR this_arg);
19344 * Returns whether the `payment_secret` feature is supported.
19346 MUST_USE_RES bool NodeFeatures_supports_payment_secret(const struct LDKNodeFeatures *NONNULL_PTR this_arg);
19349 * Returns whether the `payment_secret` feature is supported.
19351 MUST_USE_RES bool InvoiceFeatures_supports_payment_secret(const struct LDKInvoiceFeatures *NONNULL_PTR this_arg);
19354 * Serialize the InitFeatures object into a byte array which can be read by InitFeatures_read
19356 struct LDKCVec_u8Z InitFeatures_write(const struct LDKInitFeatures *NONNULL_PTR obj);
19359 * Serialize the NodeFeatures object into a byte array which can be read by NodeFeatures_read
19361 struct LDKCVec_u8Z NodeFeatures_write(const struct LDKNodeFeatures *NONNULL_PTR obj);
19364 * Serialize the ChannelFeatures object into a byte array which can be read by ChannelFeatures_read
19366 struct LDKCVec_u8Z ChannelFeatures_write(const struct LDKChannelFeatures *NONNULL_PTR obj);
19369 * Serialize the InvoiceFeatures object into a byte array which can be read by InvoiceFeatures_read
19371 struct LDKCVec_u8Z InvoiceFeatures_write(const struct LDKInvoiceFeatures *NONNULL_PTR obj);
19374 * Read a InitFeatures from a byte array, created by InitFeatures_write
19376 struct LDKCResult_InitFeaturesDecodeErrorZ InitFeatures_read(struct LDKu8slice ser);
19379 * Read a NodeFeatures from a byte array, created by NodeFeatures_write
19381 struct LDKCResult_NodeFeaturesDecodeErrorZ NodeFeatures_read(struct LDKu8slice ser);
19384 * Read a ChannelFeatures from a byte array, created by ChannelFeatures_write
19386 struct LDKCResult_ChannelFeaturesDecodeErrorZ ChannelFeatures_read(struct LDKu8slice ser);
19389 * Read a InvoiceFeatures from a byte array, created by InvoiceFeatures_write
19391 struct LDKCResult_InvoiceFeaturesDecodeErrorZ InvoiceFeatures_read(struct LDKu8slice ser);
19394 * Frees any resources used by the ShutdownScript, if is_owned is set and inner is non-NULL.
19396 void ShutdownScript_free(struct LDKShutdownScript this_obj);
19399 * Creates a copy of the ShutdownScript
19401 struct LDKShutdownScript ShutdownScript_clone(const struct LDKShutdownScript *NONNULL_PTR orig);
19404 * Frees any resources used by the InvalidShutdownScript, if is_owned is set and inner is non-NULL.
19406 void InvalidShutdownScript_free(struct LDKInvalidShutdownScript this_obj);
19409 * The script that did not meet the requirements from [BOLT #2].
19411 * [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
19413 struct LDKu8slice InvalidShutdownScript_get_script(const struct LDKInvalidShutdownScript *NONNULL_PTR this_ptr);
19416 * The script that did not meet the requirements from [BOLT #2].
19418 * [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
19420 void InvalidShutdownScript_set_script(struct LDKInvalidShutdownScript *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
19423 * Constructs a new InvalidShutdownScript given each field
19425 MUST_USE_RES struct LDKInvalidShutdownScript InvalidShutdownScript_new(struct LDKCVec_u8Z script_arg);
19428 * Serialize the ShutdownScript object into a byte array which can be read by ShutdownScript_read
19430 struct LDKCVec_u8Z ShutdownScript_write(const struct LDKShutdownScript *NONNULL_PTR obj);
19433 * Read a ShutdownScript from a byte array, created by ShutdownScript_write
19435 struct LDKCResult_ShutdownScriptDecodeErrorZ ShutdownScript_read(struct LDKu8slice ser);
19438 * Generates a P2PKH script pubkey from the given [`PubkeyHash`].
19440 MUST_USE_RES struct LDKShutdownScript ShutdownScript_new_p2pkh(const uint8_t (*pubkey_hash)[20]);
19443 * Generates a P2SH script pubkey from the given [`ScriptHash`].
19445 MUST_USE_RES struct LDKShutdownScript ShutdownScript_new_p2sh(const uint8_t (*script_hash)[20]);
19448 * Generates a P2WPKH script pubkey from the given [`WPubkeyHash`].
19450 MUST_USE_RES struct LDKShutdownScript ShutdownScript_new_p2wpkh(const uint8_t (*pubkey_hash)[20]);
19453 * Generates a P2WSH script pubkey from the given [`WScriptHash`].
19455 MUST_USE_RES struct LDKShutdownScript ShutdownScript_new_p2wsh(const uint8_t (*script_hash)[32]);
19458 * Generates a witness script pubkey from the given segwit version and program.
19460 * Note for version-zero witness scripts you must use [`ShutdownScript::new_p2wpkh`] or
19461 * [`ShutdownScript::new_p2wsh`] instead.
19465 * This function may return an error if `program` is invalid for the segwit `version`.
19467 MUST_USE_RES struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ ShutdownScript_new_witness_program(uint8_t version, struct LDKu8slice program);
19470 * Converts the shutdown script into the underlying [`Script`].
19472 MUST_USE_RES struct LDKCVec_u8Z ShutdownScript_into_inner(struct LDKShutdownScript this_arg);
19475 * Returns the [`PublicKey`] used for a P2WPKH shutdown script if constructed directly from it.
19477 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
19479 MUST_USE_RES struct LDKPublicKey ShutdownScript_as_legacy_pubkey(const struct LDKShutdownScript *NONNULL_PTR this_arg);
19482 * Returns whether the shutdown script is compatible with the features as defined by BOLT #2.
19484 * Specifically, checks for compliance with feature `option_shutdown_anysegwit`.
19486 MUST_USE_RES bool ShutdownScript_is_compatible(const struct LDKShutdownScript *NONNULL_PTR this_arg, const struct LDKInitFeatures *NONNULL_PTR features);
19489 * Calls the free function if one is set
19491 void CustomMessageReader_free(struct LDKCustomMessageReader this_ptr);
19494 * Calls the free function if one is set
19496 void Type_free(struct LDKType this_ptr);
19499 * Frees any resources used by the RouteHop, if is_owned is set and inner is non-NULL.
19501 void RouteHop_free(struct LDKRouteHop this_obj);
19504 * The node_id of the node at this hop.
19506 struct LDKPublicKey RouteHop_get_pubkey(const struct LDKRouteHop *NONNULL_PTR this_ptr);
19509 * The node_id of the node at this hop.
19511 void RouteHop_set_pubkey(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKPublicKey val);
19514 * The node_announcement features of the node at this hop. For the last hop, these may be
19515 * amended to match the features present in the invoice this node generated.
19517 struct LDKNodeFeatures RouteHop_get_node_features(const struct LDKRouteHop *NONNULL_PTR this_ptr);
19520 * The node_announcement features of the node at this hop. For the last hop, these may be
19521 * amended to match the features present in the invoice this node generated.
19523 void RouteHop_set_node_features(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
19526 * The channel that should be used from the previous hop to reach this node.
19528 uint64_t RouteHop_get_short_channel_id(const struct LDKRouteHop *NONNULL_PTR this_ptr);
19531 * The channel that should be used from the previous hop to reach this node.
19533 void RouteHop_set_short_channel_id(struct LDKRouteHop *NONNULL_PTR this_ptr, uint64_t val);
19536 * The channel_announcement features of the channel that should be used from the previous hop
19537 * to reach this node.
19539 struct LDKChannelFeatures RouteHop_get_channel_features(const struct LDKRouteHop *NONNULL_PTR this_ptr);
19542 * The channel_announcement features of the channel that should be used from the previous hop
19543 * to reach this node.
19545 void RouteHop_set_channel_features(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
19548 * The fee taken on this hop (for paying for the use of the *next* channel in the path).
19549 * For the last hop, this should be the full value of the payment (might be more than
19550 * requested if we had to match htlc_minimum_msat).
19552 uint64_t RouteHop_get_fee_msat(const struct LDKRouteHop *NONNULL_PTR this_ptr);
19555 * The fee taken on this hop (for paying for the use of the *next* channel in the path).
19556 * For the last hop, this should be the full value of the payment (might be more than
19557 * requested if we had to match htlc_minimum_msat).
19559 void RouteHop_set_fee_msat(struct LDKRouteHop *NONNULL_PTR this_ptr, uint64_t val);
19562 * The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
19563 * expected at the destination, in excess of the current block height.
19565 uint32_t RouteHop_get_cltv_expiry_delta(const struct LDKRouteHop *NONNULL_PTR this_ptr);
19568 * The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
19569 * expected at the destination, in excess of the current block height.
19571 void RouteHop_set_cltv_expiry_delta(struct LDKRouteHop *NONNULL_PTR this_ptr, uint32_t val);
19574 * Constructs a new RouteHop given each field
19576 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);
19579 * Creates a copy of the RouteHop
19581 struct LDKRouteHop RouteHop_clone(const struct LDKRouteHop *NONNULL_PTR orig);
19584 * Checks if two RouteHops contain equal inner contents.
19586 uint64_t RouteHop_hash(const struct LDKRouteHop *NONNULL_PTR o);
19589 * Checks if two RouteHops contain equal inner contents.
19590 * This ignores pointers and is_owned flags and looks at the values in fields.
19591 * Two objects with NULL inner values will be considered "equal" here.
19593 bool RouteHop_eq(const struct LDKRouteHop *NONNULL_PTR a, const struct LDKRouteHop *NONNULL_PTR b);
19596 * Serialize the RouteHop object into a byte array which can be read by RouteHop_read
19598 struct LDKCVec_u8Z RouteHop_write(const struct LDKRouteHop *NONNULL_PTR obj);
19601 * Read a RouteHop from a byte array, created by RouteHop_write
19603 struct LDKCResult_RouteHopDecodeErrorZ RouteHop_read(struct LDKu8slice ser);
19606 * Frees any resources used by the Route, if is_owned is set and inner is non-NULL.
19608 void Route_free(struct LDKRoute this_obj);
19611 * The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
19612 * last RouteHop in each path must be the same.
19613 * Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
19614 * destination. Thus, this must always be at least length one. While the maximum length of any
19615 * given path is variable, keeping the length of any path to less than 20 should currently
19616 * ensure it is viable.
19618 struct LDKCVec_CVec_RouteHopZZ Route_get_paths(const struct LDKRoute *NONNULL_PTR this_ptr);
19621 * The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
19622 * last RouteHop in each path must be the same.
19623 * Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
19624 * destination. Thus, this must always be at least length one. While the maximum length of any
19625 * given path is variable, keeping the length of any path to less than 20 should currently
19626 * ensure it is viable.
19628 void Route_set_paths(struct LDKRoute *NONNULL_PTR this_ptr, struct LDKCVec_CVec_RouteHopZZ val);
19631 * Constructs a new Route given each field
19633 MUST_USE_RES struct LDKRoute Route_new(struct LDKCVec_CVec_RouteHopZZ paths_arg);
19636 * Creates a copy of the Route
19638 struct LDKRoute Route_clone(const struct LDKRoute *NONNULL_PTR orig);
19641 * Checks if two Routes contain equal inner contents.
19643 uint64_t Route_hash(const struct LDKRoute *NONNULL_PTR o);
19646 * Checks if two Routes contain equal inner contents.
19647 * This ignores pointers and is_owned flags and looks at the values in fields.
19648 * Two objects with NULL inner values will be considered "equal" here.
19650 bool Route_eq(const struct LDKRoute *NONNULL_PTR a, const struct LDKRoute *NONNULL_PTR b);
19653 * Returns the total amount of fees paid on this [`Route`].
19655 * This doesn't include any extra payment made to the recipient, which can happen in excess of
19656 * the amount passed to [`get_route`]'s `final_value_msat`.
19658 MUST_USE_RES uint64_t Route_get_total_fees(const struct LDKRoute *NONNULL_PTR this_arg);
19661 * Returns the total amount paid on this [`Route`], excluding the fees.
19663 MUST_USE_RES uint64_t Route_get_total_amount(const struct LDKRoute *NONNULL_PTR this_arg);
19666 * Serialize the Route object into a byte array which can be read by Route_read
19668 struct LDKCVec_u8Z Route_write(const struct LDKRoute *NONNULL_PTR obj);
19671 * Read a Route from a byte array, created by Route_write
19673 struct LDKCResult_RouteDecodeErrorZ Route_read(struct LDKu8slice ser);
19676 * Frees any resources used by the RouteHint, if is_owned is set and inner is non-NULL.
19678 void RouteHint_free(struct LDKRouteHint this_obj);
19681 * Creates a copy of the RouteHint
19683 struct LDKRouteHint RouteHint_clone(const struct LDKRouteHint *NONNULL_PTR orig);
19686 * Checks if two RouteHints contain equal inner contents.
19688 uint64_t RouteHint_hash(const struct LDKRouteHint *NONNULL_PTR o);
19691 * Checks if two RouteHints contain equal inner contents.
19692 * This ignores pointers and is_owned flags and looks at the values in fields.
19693 * Two objects with NULL inner values will be considered "equal" here.
19695 bool RouteHint_eq(const struct LDKRouteHint *NONNULL_PTR a, const struct LDKRouteHint *NONNULL_PTR b);
19698 * Frees any resources used by the RouteHintHop, if is_owned is set and inner is non-NULL.
19700 void RouteHintHop_free(struct LDKRouteHintHop this_obj);
19703 * The node_id of the non-target end of the route
19705 struct LDKPublicKey RouteHintHop_get_src_node_id(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
19708 * The node_id of the non-target end of the route
19710 void RouteHintHop_set_src_node_id(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKPublicKey val);
19713 * The short_channel_id of this channel
19715 uint64_t RouteHintHop_get_short_channel_id(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
19718 * The short_channel_id of this channel
19720 void RouteHintHop_set_short_channel_id(struct LDKRouteHintHop *NONNULL_PTR this_ptr, uint64_t val);
19723 * The fees which must be paid to use this channel
19725 struct LDKRoutingFees RouteHintHop_get_fees(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
19728 * The fees which must be paid to use this channel
19730 void RouteHintHop_set_fees(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
19733 * The difference in CLTV values between this node and the next node.
19735 uint16_t RouteHintHop_get_cltv_expiry_delta(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
19738 * The difference in CLTV values between this node and the next node.
19740 void RouteHintHop_set_cltv_expiry_delta(struct LDKRouteHintHop *NONNULL_PTR this_ptr, uint16_t val);
19743 * The minimum value, in msat, which must be relayed to the next hop.
19745 struct LDKCOption_u64Z RouteHintHop_get_htlc_minimum_msat(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
19748 * The minimum value, in msat, which must be relayed to the next hop.
19750 void RouteHintHop_set_htlc_minimum_msat(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
19753 * The maximum value in msat available for routing with a single HTLC.
19755 struct LDKCOption_u64Z RouteHintHop_get_htlc_maximum_msat(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
19758 * The maximum value in msat available for routing with a single HTLC.
19760 void RouteHintHop_set_htlc_maximum_msat(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
19763 * Constructs a new RouteHintHop given each field
19765 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);
19768 * Creates a copy of the RouteHintHop
19770 struct LDKRouteHintHop RouteHintHop_clone(const struct LDKRouteHintHop *NONNULL_PTR orig);
19773 * Checks if two RouteHintHops contain equal inner contents.
19775 uint64_t RouteHintHop_hash(const struct LDKRouteHintHop *NONNULL_PTR o);
19778 * Checks if two RouteHintHops contain equal inner contents.
19779 * This ignores pointers and is_owned flags and looks at the values in fields.
19780 * Two objects with NULL inner values will be considered "equal" here.
19782 bool RouteHintHop_eq(const struct LDKRouteHintHop *NONNULL_PTR a, const struct LDKRouteHintHop *NONNULL_PTR b);
19785 * Gets a keysend route from us (payer) to the given target node (payee). This is needed because
19786 * keysend payments do not have an invoice from which to pull the payee's supported features, which
19787 * makes it tricky to otherwise supply the `payee_features` parameter of `get_route`.
19789 * Note that first_hops (or a relevant inner pointer) may be NULL or all-0s to represent None
19791 struct LDKCResult_RouteLightningErrorZ get_keysend_route(struct LDKPublicKey our_node_id, const struct LDKNetworkGraph *NONNULL_PTR network, struct LDKPublicKey payee, struct LDKCVec_ChannelDetailsZ *first_hops, struct LDKCVec_RouteHintZ last_hops, uint64_t final_value_msat, uint32_t final_cltv, struct LDKLogger logger);
19794 * Gets a route from us (payer) to the given target node (payee).
19796 * If the payee provided features in their invoice, they should be provided via payee_features.
19797 * Without this, MPP will only be used if the payee's features are available in the network graph.
19799 * Private routing paths between a public node and the target may be included in `last_hops`.
19800 * Currently, only the last hop in each path is considered.
19802 * If some channels aren't announced, it may be useful to fill in a first_hops with the
19803 * results from a local ChannelManager::list_usable_channels() call. If it is filled in, our
19804 * view of our local channels (from net_graph_msg_handler) will be ignored, and only those
19805 * in first_hops will be used.
19807 * Panics if first_hops contains channels without short_channel_ids
19808 * (ChannelManager::list_usable_channels will never include such channels).
19810 * The fees on channels from us to next-hops are ignored (as they are assumed to all be
19811 * equal), however the enabled/disabled bit on such channels as well as the
19812 * htlc_minimum_msat/htlc_maximum_msat *are* checked as they may change based on the receiving node.
19814 * Note that payee_features (or a relevant inner pointer) may be NULL or all-0s to represent None
19815 * Note that first_hops (or a relevant inner pointer) may be NULL or all-0s to represent None
19817 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_RouteHintZ last_hops, uint64_t final_value_msat, uint32_t final_cltv, struct LDKLogger logger);
19820 * Frees any resources used by the NetworkGraph, if is_owned is set and inner is non-NULL.
19822 void NetworkGraph_free(struct LDKNetworkGraph this_obj);
19825 * Frees any resources used by the ReadOnlyNetworkGraph, if is_owned is set and inner is non-NULL.
19827 void ReadOnlyNetworkGraph_free(struct LDKReadOnlyNetworkGraph this_obj);
19830 * Frees any resources used by the NetworkUpdate
19832 void NetworkUpdate_free(struct LDKNetworkUpdate this_ptr);
19835 * Creates a copy of the NetworkUpdate
19837 struct LDKNetworkUpdate NetworkUpdate_clone(const struct LDKNetworkUpdate *NONNULL_PTR orig);
19840 * Utility method to constructs a new ChannelUpdateMessage-variant NetworkUpdate
19842 struct LDKNetworkUpdate NetworkUpdate_channel_update_message(struct LDKChannelUpdate msg);
19845 * Utility method to constructs a new ChannelClosed-variant NetworkUpdate
19847 struct LDKNetworkUpdate NetworkUpdate_channel_closed(uint64_t short_channel_id, bool is_permanent);
19850 * Utility method to constructs a new NodeFailure-variant NetworkUpdate
19852 struct LDKNetworkUpdate NetworkUpdate_node_failure(struct LDKPublicKey node_id, bool is_permanent);
19855 * Serialize the NetworkUpdate object into a byte array which can be read by NetworkUpdate_read
19857 struct LDKCVec_u8Z NetworkUpdate_write(const struct LDKNetworkUpdate *NONNULL_PTR obj);
19860 * Constructs a new EventHandler which calls the relevant methods on this_arg.
19861 * This copies the `inner` pointer in this_arg and thus the returned EventHandler must be freed before this_arg is
19863 struct LDKEventHandler NetGraphMsgHandler_as_EventHandler(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
19866 * Frees any resources used by the NetGraphMsgHandler, if is_owned is set and inner is non-NULL.
19868 void NetGraphMsgHandler_free(struct LDKNetGraphMsgHandler this_obj);
19871 * Representation of the payment channel network
19873 struct LDKNetworkGraph NetGraphMsgHandler_get_network_graph(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_ptr);
19876 * Representation of the payment channel network
19878 void NetGraphMsgHandler_set_network_graph(struct LDKNetGraphMsgHandler *NONNULL_PTR this_ptr, struct LDKNetworkGraph val);
19881 * Creates a new tracker of the actual state of the network of channels and nodes,
19882 * assuming an existing Network Graph.
19883 * Chain monitor is used to make sure announced channels exist on-chain,
19884 * channel data is correct, and that the announcement is signed with
19885 * channel owners' keys.
19887 MUST_USE_RES struct LDKNetGraphMsgHandler NetGraphMsgHandler_new(struct LDKNetworkGraph network_graph, struct LDKCOption_AccessZ chain_access, struct LDKLogger logger);
19890 * Adds a provider used to check new announcements. Does not affect
19891 * existing announcements unless they are updated.
19892 * Add, update or remove the provider would replace the current one.
19894 void NetGraphMsgHandler_add_chain_access(struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg, struct LDKCOption_AccessZ chain_access);
19897 * Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg.
19898 * This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is
19900 struct LDKRoutingMessageHandler NetGraphMsgHandler_as_RoutingMessageHandler(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
19903 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
19904 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
19906 struct LDKMessageSendEventsProvider NetGraphMsgHandler_as_MessageSendEventsProvider(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
19909 * Frees any resources used by the DirectionalChannelInfo, if is_owned is set and inner is non-NULL.
19911 void DirectionalChannelInfo_free(struct LDKDirectionalChannelInfo this_obj);
19914 * When the last update to the channel direction was issued.
19915 * Value is opaque, as set in the announcement.
19917 uint32_t DirectionalChannelInfo_get_last_update(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
19920 * When the last update to the channel direction was issued.
19921 * Value is opaque, as set in the announcement.
19923 void DirectionalChannelInfo_set_last_update(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, uint32_t val);
19926 * Whether the channel can be currently used for payments (in this one direction).
19928 bool DirectionalChannelInfo_get_enabled(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
19931 * Whether the channel can be currently used for payments (in this one direction).
19933 void DirectionalChannelInfo_set_enabled(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, bool val);
19936 * The difference in CLTV values that you must have when routing through this channel.
19938 uint16_t DirectionalChannelInfo_get_cltv_expiry_delta(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
19941 * The difference in CLTV values that you must have when routing through this channel.
19943 void DirectionalChannelInfo_set_cltv_expiry_delta(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, uint16_t val);
19946 * The minimum value, which must be relayed to the next hop via the channel
19948 uint64_t DirectionalChannelInfo_get_htlc_minimum_msat(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
19951 * The minimum value, which must be relayed to the next hop via the channel
19953 void DirectionalChannelInfo_set_htlc_minimum_msat(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, uint64_t val);
19956 * The maximum value which may be relayed to the next hop via the channel.
19958 struct LDKCOption_u64Z DirectionalChannelInfo_get_htlc_maximum_msat(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
19961 * The maximum value which may be relayed to the next hop via the channel.
19963 void DirectionalChannelInfo_set_htlc_maximum_msat(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
19966 * Fees charged when the channel is used for routing
19968 struct LDKRoutingFees DirectionalChannelInfo_get_fees(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
19971 * Fees charged when the channel is used for routing
19973 void DirectionalChannelInfo_set_fees(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
19976 * Most recent update for the channel received from the network
19977 * Mostly redundant with the data we store in fields explicitly.
19978 * Everything else is useful only for sending out for initial routing sync.
19979 * Not stored if contains excess data to prevent DoS.
19981 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
19983 struct LDKChannelUpdate DirectionalChannelInfo_get_last_update_message(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
19986 * Most recent update for the channel received from the network
19987 * Mostly redundant with the data we store in fields explicitly.
19988 * Everything else is useful only for sending out for initial routing sync.
19989 * Not stored if contains excess data to prevent DoS.
19991 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
19993 void DirectionalChannelInfo_set_last_update_message(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelUpdate val);
19996 * Constructs a new DirectionalChannelInfo given each field
19998 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);
20001 * Creates a copy of the DirectionalChannelInfo
20003 struct LDKDirectionalChannelInfo DirectionalChannelInfo_clone(const struct LDKDirectionalChannelInfo *NONNULL_PTR orig);
20006 * Serialize the DirectionalChannelInfo object into a byte array which can be read by DirectionalChannelInfo_read
20008 struct LDKCVec_u8Z DirectionalChannelInfo_write(const struct LDKDirectionalChannelInfo *NONNULL_PTR obj);
20011 * Read a DirectionalChannelInfo from a byte array, created by DirectionalChannelInfo_write
20013 struct LDKCResult_DirectionalChannelInfoDecodeErrorZ DirectionalChannelInfo_read(struct LDKu8slice ser);
20016 * Frees any resources used by the ChannelInfo, if is_owned is set and inner is non-NULL.
20018 void ChannelInfo_free(struct LDKChannelInfo this_obj);
20021 * Protocol features of a channel communicated during its announcement
20023 struct LDKChannelFeatures ChannelInfo_get_features(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
20026 * Protocol features of a channel communicated during its announcement
20028 void ChannelInfo_set_features(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
20031 * Source node of the first direction of a channel
20033 struct LDKPublicKey ChannelInfo_get_node_one(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
20036 * Source node of the first direction of a channel
20038 void ChannelInfo_set_node_one(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20041 * Details about the first direction of a channel
20043 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20045 struct LDKDirectionalChannelInfo ChannelInfo_get_one_to_two(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
20048 * Details about the first direction of a channel
20050 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20052 void ChannelInfo_set_one_to_two(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKDirectionalChannelInfo val);
20055 * Source node of the second direction of a channel
20057 struct LDKPublicKey ChannelInfo_get_node_two(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
20060 * Source node of the second direction of a channel
20062 void ChannelInfo_set_node_two(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20065 * Details about the second direction of a channel
20067 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20069 struct LDKDirectionalChannelInfo ChannelInfo_get_two_to_one(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
20072 * Details about the second direction of a channel
20074 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20076 void ChannelInfo_set_two_to_one(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKDirectionalChannelInfo val);
20079 * The channel capacity as seen on-chain, if chain lookup is available.
20081 struct LDKCOption_u64Z ChannelInfo_get_capacity_sats(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
20084 * The channel capacity as seen on-chain, if chain lookup is available.
20086 void ChannelInfo_set_capacity_sats(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
20089 * An initial announcement of the channel
20090 * Mostly redundant with the data we store in fields explicitly.
20091 * Everything else is useful only for sending out for initial routing sync.
20092 * Not stored if contains excess data to prevent DoS.
20094 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20096 struct LDKChannelAnnouncement ChannelInfo_get_announcement_message(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
20099 * An initial announcement of the channel
20100 * Mostly redundant with the data we store in fields explicitly.
20101 * Everything else is useful only for sending out for initial routing sync.
20102 * Not stored if contains excess data to prevent DoS.
20104 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20106 void ChannelInfo_set_announcement_message(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelAnnouncement val);
20109 * Constructs a new ChannelInfo given each field
20111 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);
20114 * Creates a copy of the ChannelInfo
20116 struct LDKChannelInfo ChannelInfo_clone(const struct LDKChannelInfo *NONNULL_PTR orig);
20119 * Serialize the ChannelInfo object into a byte array which can be read by ChannelInfo_read
20121 struct LDKCVec_u8Z ChannelInfo_write(const struct LDKChannelInfo *NONNULL_PTR obj);
20124 * Read a ChannelInfo from a byte array, created by ChannelInfo_write
20126 struct LDKCResult_ChannelInfoDecodeErrorZ ChannelInfo_read(struct LDKu8slice ser);
20129 * Frees any resources used by the RoutingFees, if is_owned is set and inner is non-NULL.
20131 void RoutingFees_free(struct LDKRoutingFees this_obj);
20134 * Flat routing fee in satoshis
20136 uint32_t RoutingFees_get_base_msat(const struct LDKRoutingFees *NONNULL_PTR this_ptr);
20139 * Flat routing fee in satoshis
20141 void RoutingFees_set_base_msat(struct LDKRoutingFees *NONNULL_PTR this_ptr, uint32_t val);
20144 * Liquidity-based routing fee in millionths of a routed amount.
20145 * In other words, 10000 is 1%.
20147 uint32_t RoutingFees_get_proportional_millionths(const struct LDKRoutingFees *NONNULL_PTR this_ptr);
20150 * Liquidity-based routing fee in millionths of a routed amount.
20151 * In other words, 10000 is 1%.
20153 void RoutingFees_set_proportional_millionths(struct LDKRoutingFees *NONNULL_PTR this_ptr, uint32_t val);
20156 * Constructs a new RoutingFees given each field
20158 MUST_USE_RES struct LDKRoutingFees RoutingFees_new(uint32_t base_msat_arg, uint32_t proportional_millionths_arg);
20161 * Checks if two RoutingFeess contain equal inner contents.
20162 * This ignores pointers and is_owned flags and looks at the values in fields.
20163 * Two objects with NULL inner values will be considered "equal" here.
20165 bool RoutingFees_eq(const struct LDKRoutingFees *NONNULL_PTR a, const struct LDKRoutingFees *NONNULL_PTR b);
20168 * Creates a copy of the RoutingFees
20170 struct LDKRoutingFees RoutingFees_clone(const struct LDKRoutingFees *NONNULL_PTR orig);
20173 * Checks if two RoutingFeess contain equal inner contents.
20175 uint64_t RoutingFees_hash(const struct LDKRoutingFees *NONNULL_PTR o);
20178 * Serialize the RoutingFees object into a byte array which can be read by RoutingFees_read
20180 struct LDKCVec_u8Z RoutingFees_write(const struct LDKRoutingFees *NONNULL_PTR obj);
20183 * Read a RoutingFees from a byte array, created by RoutingFees_write
20185 struct LDKCResult_RoutingFeesDecodeErrorZ RoutingFees_read(struct LDKu8slice ser);
20188 * Frees any resources used by the NodeAnnouncementInfo, if is_owned is set and inner is non-NULL.
20190 void NodeAnnouncementInfo_free(struct LDKNodeAnnouncementInfo this_obj);
20193 * Protocol features the node announced support for
20195 struct LDKNodeFeatures NodeAnnouncementInfo_get_features(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
20198 * Protocol features the node announced support for
20200 void NodeAnnouncementInfo_set_features(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
20203 * When the last known update to the node state was issued.
20204 * Value is opaque, as set in the announcement.
20206 uint32_t NodeAnnouncementInfo_get_last_update(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
20209 * When the last known update to the node state was issued.
20210 * Value is opaque, as set in the announcement.
20212 void NodeAnnouncementInfo_set_last_update(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, uint32_t val);
20215 * Color assigned to the node
20217 const uint8_t (*NodeAnnouncementInfo_get_rgb(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr))[3];
20220 * Color assigned to the node
20222 void NodeAnnouncementInfo_set_rgb(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKThreeBytes val);
20225 * Moniker assigned to the node.
20226 * May be invalid or malicious (eg control chars),
20227 * should not be exposed to the user.
20229 const uint8_t (*NodeAnnouncementInfo_get_alias(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr))[32];
20232 * Moniker assigned to the node.
20233 * May be invalid or malicious (eg control chars),
20234 * should not be exposed to the user.
20236 void NodeAnnouncementInfo_set_alias(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20239 * Internet-level addresses via which one can connect to the node
20241 void NodeAnnouncementInfo_set_addresses(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKCVec_NetAddressZ val);
20244 * An initial announcement of the node
20245 * Mostly redundant with the data we store in fields explicitly.
20246 * Everything else is useful only for sending out for initial routing sync.
20247 * Not stored if contains excess data to prevent DoS.
20249 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20251 struct LDKNodeAnnouncement NodeAnnouncementInfo_get_announcement_message(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
20254 * An initial announcement of the node
20255 * Mostly redundant with the data we store in fields explicitly.
20256 * Everything else is useful only for sending out for initial routing sync.
20257 * Not stored if contains excess data to prevent DoS.
20259 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20261 void NodeAnnouncementInfo_set_announcement_message(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKNodeAnnouncement val);
20264 * Constructs a new NodeAnnouncementInfo given each field
20266 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);
20269 * Creates a copy of the NodeAnnouncementInfo
20271 struct LDKNodeAnnouncementInfo NodeAnnouncementInfo_clone(const struct LDKNodeAnnouncementInfo *NONNULL_PTR orig);
20274 * Serialize the NodeAnnouncementInfo object into a byte array which can be read by NodeAnnouncementInfo_read
20276 struct LDKCVec_u8Z NodeAnnouncementInfo_write(const struct LDKNodeAnnouncementInfo *NONNULL_PTR obj);
20279 * Read a NodeAnnouncementInfo from a byte array, created by NodeAnnouncementInfo_write
20281 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ NodeAnnouncementInfo_read(struct LDKu8slice ser);
20284 * Frees any resources used by the NodeInfo, if is_owned is set and inner is non-NULL.
20286 void NodeInfo_free(struct LDKNodeInfo this_obj);
20289 * All valid channels a node has announced
20291 void NodeInfo_set_channels(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
20294 * Lowest fees enabling routing via any of the enabled, known channels to a node.
20295 * The two fields (flat and proportional fee) are independent,
20296 * meaning they don't have to refer to the same channel.
20298 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20300 struct LDKRoutingFees NodeInfo_get_lowest_inbound_channel_fees(const struct LDKNodeInfo *NONNULL_PTR this_ptr);
20303 * Lowest fees enabling routing via any of the enabled, known channels to a node.
20304 * The two fields (flat and proportional fee) are independent,
20305 * meaning they don't have to refer to the same channel.
20307 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20309 void NodeInfo_set_lowest_inbound_channel_fees(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
20312 * More information about a node from node_announcement.
20313 * Optional because we store a Node entry after learning about it from
20314 * a channel announcement, but before receiving a node announcement.
20316 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20318 struct LDKNodeAnnouncementInfo NodeInfo_get_announcement_info(const struct LDKNodeInfo *NONNULL_PTR this_ptr);
20321 * More information about a node from node_announcement.
20322 * Optional because we store a Node entry after learning about it from
20323 * a channel announcement, but before receiving a node announcement.
20325 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20327 void NodeInfo_set_announcement_info(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKNodeAnnouncementInfo val);
20330 * Constructs a new NodeInfo given each field
20332 MUST_USE_RES struct LDKNodeInfo NodeInfo_new(struct LDKCVec_u64Z channels_arg, struct LDKRoutingFees lowest_inbound_channel_fees_arg, struct LDKNodeAnnouncementInfo announcement_info_arg);
20335 * Creates a copy of the NodeInfo
20337 struct LDKNodeInfo NodeInfo_clone(const struct LDKNodeInfo *NONNULL_PTR orig);
20340 * Serialize the NodeInfo object into a byte array which can be read by NodeInfo_read
20342 struct LDKCVec_u8Z NodeInfo_write(const struct LDKNodeInfo *NONNULL_PTR obj);
20345 * Read a NodeInfo from a byte array, created by NodeInfo_write
20347 struct LDKCResult_NodeInfoDecodeErrorZ NodeInfo_read(struct LDKu8slice ser);
20350 * Serialize the NetworkGraph object into a byte array which can be read by NetworkGraph_read
20352 struct LDKCVec_u8Z NetworkGraph_write(const struct LDKNetworkGraph *NONNULL_PTR obj);
20355 * Read a NetworkGraph from a byte array, created by NetworkGraph_write
20357 struct LDKCResult_NetworkGraphDecodeErrorZ NetworkGraph_read(struct LDKu8slice ser);
20360 * Creates a new, empty, network graph.
20362 MUST_USE_RES struct LDKNetworkGraph NetworkGraph_new(struct LDKThirtyTwoBytes genesis_hash);
20365 * Returns a read-only view of the network graph.
20367 MUST_USE_RES struct LDKReadOnlyNetworkGraph NetworkGraph_read_only(const struct LDKNetworkGraph *NONNULL_PTR this_arg);
20370 * For an already known node (from channel announcements), update its stored properties from a
20371 * given node announcement.
20373 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
20374 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
20375 * routing messages from a source using a protocol other than the lightning P2P protocol.
20377 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_node_from_announcement(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKNodeAnnouncement *NONNULL_PTR msg);
20380 * For an already known node (from channel announcements), update its stored properties from a
20381 * given node announcement without verifying the associated signatures. Because we aren't
20382 * given the associated signatures here we cannot relay the node announcement to any of our
20385 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_node_from_unsigned_announcement(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR msg);
20388 * Store or update channel info from a channel announcement.
20390 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
20391 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
20392 * routing messages from a source using a protocol other than the lightning P2P protocol.
20394 * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
20395 * the corresponding UTXO exists on chain and is correctly-formatted.
20397 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel_from_announcement(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKChannelAnnouncement *NONNULL_PTR msg, struct LDKCOption_AccessZ chain_access);
20400 * Store or update channel info from a channel announcement without verifying the associated
20401 * signatures. Because we aren't given the associated signatures here we cannot relay the
20402 * channel announcement to any of our peers.
20404 * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
20405 * the corresponding UTXO exists on chain and is correctly-formatted.
20407 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel_from_unsigned_announcement(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR msg, struct LDKCOption_AccessZ chain_access);
20410 * Close a channel if a corresponding HTLC fail was sent.
20411 * If permanent, removes a channel from the local storage.
20412 * May cause the removal of nodes too, if this was their last channel.
20413 * If not permanent, makes channels unavailable for routing.
20415 void NetworkGraph_close_channel_from_update(const struct LDKNetworkGraph *NONNULL_PTR this_arg, uint64_t short_channel_id, bool is_permanent);
20418 * Marks a node in the graph as failed.
20420 void NetworkGraph_fail_node(const struct LDKNetworkGraph *NONNULL_PTR this_arg, struct LDKPublicKey _node_id, bool is_permanent);
20423 * For an already known (from announcement) channel, update info about one of the directions
20426 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
20427 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
20428 * routing messages from a source using a protocol other than the lightning P2P protocol.
20430 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKChannelUpdate *NONNULL_PTR msg);
20433 * For an already known (from announcement) channel, update info about one of the directions
20434 * of the channel without verifying the associated signatures. Because we aren't given the
20435 * associated signatures here we cannot relay the channel update to any of our peers.
20437 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel_unsigned(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKUnsignedChannelUpdate *NONNULL_PTR msg);
20440 * Frees any resources used by the FilesystemPersister, if is_owned is set and inner is non-NULL.
20442 void FilesystemPersister_free(struct LDKFilesystemPersister this_obj);
20445 * Initialize a new FilesystemPersister and set the path to the individual channels'
20448 MUST_USE_RES struct LDKFilesystemPersister FilesystemPersister_new(struct LDKStr path_to_channel_data);
20451 * Get the directory which was provided when this persister was initialized.
20453 MUST_USE_RES struct LDKStr FilesystemPersister_get_data_dir(const struct LDKFilesystemPersister *NONNULL_PTR this_arg);
20456 * Writes the provided `ChannelManager` to the path provided at `FilesystemPersister`
20457 * initialization, within a file called \"manager\".
20459 MUST_USE_RES struct LDKCResult_NoneErrorZ FilesystemPersister_persist_manager(struct LDKStr data_dir, const struct LDKChannelManager *NONNULL_PTR manager);
20462 * Read `ChannelMonitor`s from disk.
20464 MUST_USE_RES struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ FilesystemPersister_read_channelmonitors(const struct LDKFilesystemPersister *NONNULL_PTR this_arg, struct LDKKeysInterface keys_manager);
20467 * Constructs a new Persist which calls the relevant methods on this_arg.
20468 * This copies the `inner` pointer in this_arg and thus the returned Persist must be freed before this_arg is
20470 struct LDKPersist FilesystemPersister_as_Persist(const struct LDKFilesystemPersister *NONNULL_PTR this_arg);
20473 * Frees any resources used by the BackgroundProcessor, if is_owned is set and inner is non-NULL.
20475 void BackgroundProcessor_free(struct LDKBackgroundProcessor this_obj);
20478 * Calls the free function if one is set
20480 void ChannelManagerPersister_free(struct LDKChannelManagerPersister this_ptr);
20483 * Start a background thread that takes care of responsibilities enumerated in the [top-level
20486 * The thread runs indefinitely unless the object is dropped, [`stop`] is called, or
20487 * `persist_manager` returns an error. In case of an error, the error is retrieved by calling
20488 * either [`join`] or [`stop`].
20490 * # Data Persistence
20492 * `persist_manager` is responsible for writing out the [`ChannelManager`] to disk, and/or
20493 * uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
20494 * [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
20495 * provided implementation.
20497 * Typically, users should either implement [`ChannelManagerPersister`] to never return an
20498 * error or call [`join`] and handle any error that may arise. For the latter case,
20499 * `BackgroundProcessor` must be restarted by calling `start` again after handling the error.
20503 * `event_handler` is responsible for handling events that users should be notified of (e.g.,
20504 * payment failed). [`BackgroundProcessor`] may decorate the given [`EventHandler`] with common
20505 * functionality implemented by other handlers.
20506 * * [`NetGraphMsgHandler`] if given will update the [`NetworkGraph`] based on payment failures.
20508 * [top-level documentation]: Self
20509 * [`join`]: Self::join
20510 * [`stop`]: Self::stop
20511 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
20512 * [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
20513 * [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
20514 * [`NetworkGraph`]: lightning::routing::network_graph::NetworkGraph
20516 * Note that net_graph_msg_handler (or a relevant inner pointer) may be NULL or all-0s to represent None
20518 MUST_USE_RES struct LDKBackgroundProcessor BackgroundProcessor_start(struct LDKChannelManagerPersister persister, struct LDKEventHandler event_handler, const struct LDKChainMonitor *NONNULL_PTR chain_monitor, const struct LDKChannelManager *NONNULL_PTR channel_manager, struct LDKNetGraphMsgHandler net_graph_msg_handler, const struct LDKPeerManager *NONNULL_PTR peer_manager, struct LDKLogger logger);
20521 * Join `BackgroundProcessor`'s thread, returning any error that occurred while persisting
20522 * [`ChannelManager`].
20526 * This function panics if the background thread has panicked such as while persisting or
20529 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
20531 MUST_USE_RES struct LDKCResult_NoneErrorZ BackgroundProcessor_join(struct LDKBackgroundProcessor this_arg);
20534 * Stop `BackgroundProcessor`'s thread, returning any error that occurred while persisting
20535 * [`ChannelManager`].
20539 * This function panics if the background thread has panicked such as while persisting or
20542 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
20544 MUST_USE_RES struct LDKCResult_NoneErrorZ BackgroundProcessor_stop(struct LDKBackgroundProcessor this_arg);
20547 * **Call this function on startup to ensure that all assumptions about the platform are valid.**
20549 * Unfortunately we have to make assumptions about the upper bounds of the `SystemTime` type on
20550 * your platform which we can't fully verify at compile time and which isn't part of it's contract.
20551 * To our best knowledge our assumptions hold for all platforms officially supported by rust, but
20552 * since this check is fast we recommend to do it anyway.
20554 * If this function fails this is considered a bug. Please open an issue describing your
20555 * platform and stating your current system time.
20558 * If the check fails this function panics. By calling this function on startup you ensure that
20559 * this wont happen at an arbitrary later point in time.
20561 void check_platform(void);
20564 * Frees any resources used by the Invoice, if is_owned is set and inner is non-NULL.
20566 void Invoice_free(struct LDKInvoice this_obj);
20569 * Checks if two Invoices contain equal inner contents.
20570 * This ignores pointers and is_owned flags and looks at the values in fields.
20571 * Two objects with NULL inner values will be considered "equal" here.
20573 bool Invoice_eq(const struct LDKInvoice *NONNULL_PTR a, const struct LDKInvoice *NONNULL_PTR b);
20576 * Creates a copy of the Invoice
20578 struct LDKInvoice Invoice_clone(const struct LDKInvoice *NONNULL_PTR orig);
20581 * Frees any resources used by the SignedRawInvoice, if is_owned is set and inner is non-NULL.
20583 void SignedRawInvoice_free(struct LDKSignedRawInvoice this_obj);
20586 * Checks if two SignedRawInvoices contain equal inner contents.
20587 * This ignores pointers and is_owned flags and looks at the values in fields.
20588 * Two objects with NULL inner values will be considered "equal" here.
20590 bool SignedRawInvoice_eq(const struct LDKSignedRawInvoice *NONNULL_PTR a, const struct LDKSignedRawInvoice *NONNULL_PTR b);
20593 * Creates a copy of the SignedRawInvoice
20595 struct LDKSignedRawInvoice SignedRawInvoice_clone(const struct LDKSignedRawInvoice *NONNULL_PTR orig);
20598 * Frees any resources used by the RawInvoice, if is_owned is set and inner is non-NULL.
20600 void RawInvoice_free(struct LDKRawInvoice this_obj);
20605 struct LDKRawDataPart RawInvoice_get_data(const struct LDKRawInvoice *NONNULL_PTR this_ptr);
20610 void RawInvoice_set_data(struct LDKRawInvoice *NONNULL_PTR this_ptr, struct LDKRawDataPart val);
20613 * Checks if two RawInvoices contain equal inner contents.
20614 * This ignores pointers and is_owned flags and looks at the values in fields.
20615 * Two objects with NULL inner values will be considered "equal" here.
20617 bool RawInvoice_eq(const struct LDKRawInvoice *NONNULL_PTR a, const struct LDKRawInvoice *NONNULL_PTR b);
20620 * Creates a copy of the RawInvoice
20622 struct LDKRawInvoice RawInvoice_clone(const struct LDKRawInvoice *NONNULL_PTR orig);
20625 * Frees any resources used by the RawDataPart, if is_owned is set and inner is non-NULL.
20627 void RawDataPart_free(struct LDKRawDataPart this_obj);
20630 * generation time of the invoice
20632 struct LDKPositiveTimestamp RawDataPart_get_timestamp(const struct LDKRawDataPart *NONNULL_PTR this_ptr);
20635 * generation time of the invoice
20637 void RawDataPart_set_timestamp(struct LDKRawDataPart *NONNULL_PTR this_ptr, struct LDKPositiveTimestamp val);
20640 * Checks if two RawDataParts contain equal inner contents.
20641 * This ignores pointers and is_owned flags and looks at the values in fields.
20642 * Two objects with NULL inner values will be considered "equal" here.
20644 bool RawDataPart_eq(const struct LDKRawDataPart *NONNULL_PTR a, const struct LDKRawDataPart *NONNULL_PTR b);
20647 * Creates a copy of the RawDataPart
20649 struct LDKRawDataPart RawDataPart_clone(const struct LDKRawDataPart *NONNULL_PTR orig);
20652 * Frees any resources used by the PositiveTimestamp, if is_owned is set and inner is non-NULL.
20654 void PositiveTimestamp_free(struct LDKPositiveTimestamp this_obj);
20657 * Checks if two PositiveTimestamps contain equal inner contents.
20658 * This ignores pointers and is_owned flags and looks at the values in fields.
20659 * Two objects with NULL inner values will be considered "equal" here.
20661 bool PositiveTimestamp_eq(const struct LDKPositiveTimestamp *NONNULL_PTR a, const struct LDKPositiveTimestamp *NONNULL_PTR b);
20664 * Creates a copy of the PositiveTimestamp
20666 struct LDKPositiveTimestamp PositiveTimestamp_clone(const struct LDKPositiveTimestamp *NONNULL_PTR orig);
20669 * Creates a copy of the SiPrefix
20671 enum LDKSiPrefix SiPrefix_clone(const enum LDKSiPrefix *NONNULL_PTR orig);
20674 * Utility method to constructs a new Milli-variant SiPrefix
20676 enum LDKSiPrefix SiPrefix_milli(void);
20679 * Utility method to constructs a new Micro-variant SiPrefix
20681 enum LDKSiPrefix SiPrefix_micro(void);
20684 * Utility method to constructs a new Nano-variant SiPrefix
20686 enum LDKSiPrefix SiPrefix_nano(void);
20689 * Utility method to constructs a new Pico-variant SiPrefix
20691 enum LDKSiPrefix SiPrefix_pico(void);
20694 * Checks if two SiPrefixs contain equal inner contents.
20695 * This ignores pointers and is_owned flags and looks at the values in fields.
20697 bool SiPrefix_eq(const enum LDKSiPrefix *NONNULL_PTR a, const enum LDKSiPrefix *NONNULL_PTR b);
20700 * Returns the multiplier to go from a BTC value to picoBTC implied by this SiPrefix.
20701 * This is effectively 10^12 * the prefix multiplier
20703 MUST_USE_RES uint64_t SiPrefix_multiplier(const enum LDKSiPrefix *NONNULL_PTR this_arg);
20706 * Creates a copy of the Currency
20708 enum LDKCurrency Currency_clone(const enum LDKCurrency *NONNULL_PTR orig);
20711 * Utility method to constructs a new Bitcoin-variant Currency
20713 enum LDKCurrency Currency_bitcoin(void);
20716 * Utility method to constructs a new BitcoinTestnet-variant Currency
20718 enum LDKCurrency Currency_bitcoin_testnet(void);
20721 * Utility method to constructs a new Regtest-variant Currency
20723 enum LDKCurrency Currency_regtest(void);
20726 * Utility method to constructs a new Simnet-variant Currency
20728 enum LDKCurrency Currency_simnet(void);
20731 * Utility method to constructs a new Signet-variant Currency
20733 enum LDKCurrency Currency_signet(void);
20736 * Checks if two Currencys contain equal inner contents.
20738 uint64_t Currency_hash(const enum LDKCurrency *NONNULL_PTR o);
20741 * Checks if two Currencys contain equal inner contents.
20742 * This ignores pointers and is_owned flags and looks at the values in fields.
20744 bool Currency_eq(const enum LDKCurrency *NONNULL_PTR a, const enum LDKCurrency *NONNULL_PTR b);
20747 * Frees any resources used by the Sha256, if is_owned is set and inner is non-NULL.
20749 void Sha256_free(struct LDKSha256 this_obj);
20752 * Creates a copy of the Sha256
20754 struct LDKSha256 Sha256_clone(const struct LDKSha256 *NONNULL_PTR orig);
20757 * Checks if two Sha256s contain equal inner contents.
20759 uint64_t Sha256_hash(const struct LDKSha256 *NONNULL_PTR o);
20762 * Checks if two Sha256s contain equal inner contents.
20763 * This ignores pointers and is_owned flags and looks at the values in fields.
20764 * Two objects with NULL inner values will be considered "equal" here.
20766 bool Sha256_eq(const struct LDKSha256 *NONNULL_PTR a, const struct LDKSha256 *NONNULL_PTR b);
20769 * Frees any resources used by the Description, if is_owned is set and inner is non-NULL.
20771 void Description_free(struct LDKDescription this_obj);
20774 * Creates a copy of the Description
20776 struct LDKDescription Description_clone(const struct LDKDescription *NONNULL_PTR orig);
20779 * Checks if two Descriptions contain equal inner contents.
20781 uint64_t Description_hash(const struct LDKDescription *NONNULL_PTR o);
20784 * Checks if two Descriptions contain equal inner contents.
20785 * This ignores pointers and is_owned flags and looks at the values in fields.
20786 * Two objects with NULL inner values will be considered "equal" here.
20788 bool Description_eq(const struct LDKDescription *NONNULL_PTR a, const struct LDKDescription *NONNULL_PTR b);
20791 * Frees any resources used by the PayeePubKey, if is_owned is set and inner is non-NULL.
20793 void PayeePubKey_free(struct LDKPayeePubKey this_obj);
20796 * Creates a copy of the PayeePubKey
20798 struct LDKPayeePubKey PayeePubKey_clone(const struct LDKPayeePubKey *NONNULL_PTR orig);
20801 * Checks if two PayeePubKeys contain equal inner contents.
20803 uint64_t PayeePubKey_hash(const struct LDKPayeePubKey *NONNULL_PTR o);
20806 * Checks if two PayeePubKeys contain equal inner contents.
20807 * This ignores pointers and is_owned flags and looks at the values in fields.
20808 * Two objects with NULL inner values will be considered "equal" here.
20810 bool PayeePubKey_eq(const struct LDKPayeePubKey *NONNULL_PTR a, const struct LDKPayeePubKey *NONNULL_PTR b);
20813 * Frees any resources used by the ExpiryTime, if is_owned is set and inner is non-NULL.
20815 void ExpiryTime_free(struct LDKExpiryTime this_obj);
20818 * Creates a copy of the ExpiryTime
20820 struct LDKExpiryTime ExpiryTime_clone(const struct LDKExpiryTime *NONNULL_PTR orig);
20823 * Checks if two ExpiryTimes contain equal inner contents.
20825 uint64_t ExpiryTime_hash(const struct LDKExpiryTime *NONNULL_PTR o);
20828 * Checks if two ExpiryTimes contain equal inner contents.
20829 * This ignores pointers and is_owned flags and looks at the values in fields.
20830 * Two objects with NULL inner values will be considered "equal" here.
20832 bool ExpiryTime_eq(const struct LDKExpiryTime *NONNULL_PTR a, const struct LDKExpiryTime *NONNULL_PTR b);
20835 * Frees any resources used by the MinFinalCltvExpiry, if is_owned is set and inner is non-NULL.
20837 void MinFinalCltvExpiry_free(struct LDKMinFinalCltvExpiry this_obj);
20840 * Creates a copy of the MinFinalCltvExpiry
20842 struct LDKMinFinalCltvExpiry MinFinalCltvExpiry_clone(const struct LDKMinFinalCltvExpiry *NONNULL_PTR orig);
20845 * Checks if two MinFinalCltvExpirys contain equal inner contents.
20847 uint64_t MinFinalCltvExpiry_hash(const struct LDKMinFinalCltvExpiry *NONNULL_PTR o);
20850 * Checks if two MinFinalCltvExpirys contain equal inner contents.
20851 * This ignores pointers and is_owned flags and looks at the values in fields.
20852 * Two objects with NULL inner values will be considered "equal" here.
20854 bool MinFinalCltvExpiry_eq(const struct LDKMinFinalCltvExpiry *NONNULL_PTR a, const struct LDKMinFinalCltvExpiry *NONNULL_PTR b);
20857 * Frees any resources used by the Fallback
20859 void Fallback_free(struct LDKFallback this_ptr);
20862 * Creates a copy of the Fallback
20864 struct LDKFallback Fallback_clone(const struct LDKFallback *NONNULL_PTR orig);
20867 * Utility method to constructs a new SegWitProgram-variant Fallback
20869 struct LDKFallback Fallback_seg_wit_program(struct LDKu5 version, struct LDKCVec_u8Z program);
20872 * Utility method to constructs a new PubKeyHash-variant Fallback
20874 struct LDKFallback Fallback_pub_key_hash(struct LDKTwentyBytes a);
20877 * Utility method to constructs a new ScriptHash-variant Fallback
20879 struct LDKFallback Fallback_script_hash(struct LDKTwentyBytes a);
20882 * Checks if two Fallbacks contain equal inner contents.
20884 uint64_t Fallback_hash(const struct LDKFallback *NONNULL_PTR o);
20887 * Checks if two Fallbacks contain equal inner contents.
20888 * This ignores pointers and is_owned flags and looks at the values in fields.
20890 bool Fallback_eq(const struct LDKFallback *NONNULL_PTR a, const struct LDKFallback *NONNULL_PTR b);
20893 * Frees any resources used by the InvoiceSignature, if is_owned is set and inner is non-NULL.
20895 void InvoiceSignature_free(struct LDKInvoiceSignature this_obj);
20898 * Creates a copy of the InvoiceSignature
20900 struct LDKInvoiceSignature InvoiceSignature_clone(const struct LDKInvoiceSignature *NONNULL_PTR orig);
20903 * Checks if two InvoiceSignatures contain equal inner contents.
20904 * This ignores pointers and is_owned flags and looks at the values in fields.
20905 * Two objects with NULL inner values will be considered "equal" here.
20907 bool InvoiceSignature_eq(const struct LDKInvoiceSignature *NONNULL_PTR a, const struct LDKInvoiceSignature *NONNULL_PTR b);
20910 * Frees any resources used by the PrivateRoute, if is_owned is set and inner is non-NULL.
20912 void PrivateRoute_free(struct LDKPrivateRoute this_obj);
20915 * Creates a copy of the PrivateRoute
20917 struct LDKPrivateRoute PrivateRoute_clone(const struct LDKPrivateRoute *NONNULL_PTR orig);
20920 * Checks if two PrivateRoutes contain equal inner contents.
20922 uint64_t PrivateRoute_hash(const struct LDKPrivateRoute *NONNULL_PTR o);
20925 * Checks if two PrivateRoutes contain equal inner contents.
20926 * This ignores pointers and is_owned flags and looks at the values in fields.
20927 * Two objects with NULL inner values will be considered "equal" here.
20929 bool PrivateRoute_eq(const struct LDKPrivateRoute *NONNULL_PTR a, const struct LDKPrivateRoute *NONNULL_PTR b);
20932 * Disassembles the `SignedRawInvoice` into its three parts:
20934 * 2. hash of the raw invoice
20937 MUST_USE_RES struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ SignedRawInvoice_into_parts(struct LDKSignedRawInvoice this_arg);
20940 * The `RawInvoice` which was signed.
20942 MUST_USE_RES struct LDKRawInvoice SignedRawInvoice_raw_invoice(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
20945 * The hash of the `RawInvoice` that was signed.
20947 MUST_USE_RES const uint8_t (*SignedRawInvoice_hash(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg))[32];
20950 * InvoiceSignature for the invoice.
20952 MUST_USE_RES struct LDKInvoiceSignature SignedRawInvoice_signature(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
20955 * Recovers the public key used for signing the invoice from the recoverable signature.
20957 MUST_USE_RES struct LDKCResult_PayeePubKeyErrorZ SignedRawInvoice_recover_payee_pub_key(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
20960 * Checks if the signature is valid for the included payee public key or if none exists if it's
20961 * valid for the recovered signature (which should always be true?).
20963 MUST_USE_RES bool SignedRawInvoice_check_signature(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
20966 * Calculate the hash of the encoded `RawInvoice`
20968 MUST_USE_RES struct LDKThirtyTwoBytes RawInvoice_hash(const struct LDKRawInvoice *NONNULL_PTR this_arg);
20972 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20974 MUST_USE_RES struct LDKSha256 RawInvoice_payment_hash(const struct LDKRawInvoice *NONNULL_PTR this_arg);
20978 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20980 MUST_USE_RES struct LDKDescription RawInvoice_description(const struct LDKRawInvoice *NONNULL_PTR this_arg);
20984 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20986 MUST_USE_RES struct LDKPayeePubKey RawInvoice_payee_pub_key(const struct LDKRawInvoice *NONNULL_PTR this_arg);
20990 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20992 MUST_USE_RES struct LDKSha256 RawInvoice_description_hash(const struct LDKRawInvoice *NONNULL_PTR this_arg);
20996 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20998 MUST_USE_RES struct LDKExpiryTime RawInvoice_expiry_time(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21002 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
21004 MUST_USE_RES struct LDKMinFinalCltvExpiry RawInvoice_min_final_cltv_expiry(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21008 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
21010 MUST_USE_RES struct LDKThirtyTwoBytes RawInvoice_payment_secret(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21014 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
21016 MUST_USE_RES struct LDKInvoiceFeatures RawInvoice_features(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21018 MUST_USE_RES struct LDKCVec_PrivateRouteZ RawInvoice_private_routes(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21020 MUST_USE_RES struct LDKCOption_u64Z RawInvoice_amount_pico_btc(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21022 MUST_USE_RES enum LDKCurrency RawInvoice_currency(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21025 * Create a new `PositiveTimestamp` from a unix timestamp in the Range
21026 * `0...SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME`, otherwise return a
21027 * `CreationError::TimestampOutOfBounds`.
21029 MUST_USE_RES struct LDKCResult_PositiveTimestampCreationErrorZ PositiveTimestamp_from_unix_timestamp(uint64_t unix_seconds);
21032 * Create a new `PositiveTimestamp` from a `SystemTime` with a corresponding unix timestamp in
21033 * the Range `0...SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME`, otherwise return a
21034 * `CreationError::TimestampOutOfBounds`.
21036 MUST_USE_RES struct LDKCResult_PositiveTimestampCreationErrorZ PositiveTimestamp_from_system_time(uint64_t time);
21039 * Returns the UNIX timestamp representing the stored time
21041 MUST_USE_RES uint64_t PositiveTimestamp_as_unix_timestamp(const struct LDKPositiveTimestamp *NONNULL_PTR this_arg);
21044 * Returns a reference to the internal `SystemTime` time representation
21046 MUST_USE_RES uint64_t PositiveTimestamp_as_time(const struct LDKPositiveTimestamp *NONNULL_PTR this_arg);
21049 * Transform the `Invoice` into it's unchecked version
21051 MUST_USE_RES struct LDKSignedRawInvoice Invoice_into_signed_raw(struct LDKInvoice this_arg);
21054 * Check that the invoice is signed correctly and that key recovery works
21056 MUST_USE_RES struct LDKCResult_NoneSemanticErrorZ Invoice_check_signature(const struct LDKInvoice *NONNULL_PTR this_arg);
21059 * Constructs an `Invoice` from a `SignedRawInvoice` by checking all its invariants.
21061 * use lightning_invoice::*;
21063 * let invoice = \"lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\\
21064 * h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\\
21065 * 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\\
21066 * h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\\
21067 * j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\\
21068 * ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\\
21069 * guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\\
21070 * ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\\
21071 * p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\\
21072 * 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\\
21073 * j5r6drg6k6zcqj0fcwg\";
21075 * let signed = invoice.parse::<SignedRawInvoice>().unwrap();
21077 * assert!(Invoice::from_signed(signed).is_ok());
21080 MUST_USE_RES struct LDKCResult_InvoiceSemanticErrorZ Invoice_from_signed(struct LDKSignedRawInvoice signed_invoice);
21083 * Returns the `Invoice`'s timestamp (should equal it's creation time)
21085 MUST_USE_RES uint64_t Invoice_timestamp(const struct LDKInvoice *NONNULL_PTR this_arg);
21088 * Returns the hash to which we will receive the preimage on completion of the payment
21090 MUST_USE_RES const uint8_t (*Invoice_payment_hash(const struct LDKInvoice *NONNULL_PTR this_arg))[32];
21093 * Get the payee's public key if one was included in the invoice
21095 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
21097 MUST_USE_RES struct LDKPublicKey Invoice_payee_pub_key(const struct LDKInvoice *NONNULL_PTR this_arg);
21100 * Get the payment secret if one was included in the invoice
21102 MUST_USE_RES struct LDKThirtyTwoBytes Invoice_payment_secret(const struct LDKInvoice *NONNULL_PTR this_arg);
21105 * Get the invoice features if they were included in the invoice
21107 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
21109 MUST_USE_RES struct LDKInvoiceFeatures Invoice_features(const struct LDKInvoice *NONNULL_PTR this_arg);
21112 * Recover the payee's public key (only to be used if none was included in the invoice)
21114 MUST_USE_RES struct LDKPublicKey Invoice_recover_payee_pub_key(const struct LDKInvoice *NONNULL_PTR this_arg);
21117 * Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
21119 MUST_USE_RES uint64_t Invoice_expiry_time(const struct LDKInvoice *NONNULL_PTR this_arg);
21122 * Returns the invoice's `min_final_cltv_expiry` time, if present, otherwise
21123 * [`DEFAULT_MIN_FINAL_CLTV_EXPIRY`].
21125 MUST_USE_RES uint64_t Invoice_min_final_cltv_expiry(const struct LDKInvoice *NONNULL_PTR this_arg);
21128 * Returns a list of all routes included in the invoice
21130 MUST_USE_RES struct LDKCVec_PrivateRouteZ Invoice_private_routes(const struct LDKInvoice *NONNULL_PTR this_arg);
21133 * Returns a list of all routes included in the invoice as the underlying hints
21135 MUST_USE_RES struct LDKCVec_RouteHintZ Invoice_route_hints(const struct LDKInvoice *NONNULL_PTR this_arg);
21138 * Returns the currency for which the invoice was issued
21140 MUST_USE_RES enum LDKCurrency Invoice_currency(const struct LDKInvoice *NONNULL_PTR this_arg);
21143 * Returns the amount if specified in the invoice as pico <currency>.
21145 MUST_USE_RES struct LDKCOption_u64Z Invoice_amount_pico_btc(const struct LDKInvoice *NONNULL_PTR this_arg);
21148 * Creates a new `Description` if `description` is at most 1023 __bytes__ long,
21149 * returns `CreationError::DescriptionTooLong` otherwise
21151 * Please note that single characters may use more than one byte due to UTF8 encoding.
21153 MUST_USE_RES struct LDKCResult_DescriptionCreationErrorZ Description_new(struct LDKStr description);
21156 * Returns the underlying description `String`
21158 MUST_USE_RES struct LDKStr Description_into_inner(struct LDKDescription this_arg);
21161 * Construct an `ExpiryTime` from seconds. If there exists a `PositiveTimestamp` which would
21162 * overflow on adding the `EpiryTime` to it then this function will return a
21163 * `CreationError::ExpiryTimeOutOfBounds`.
21165 MUST_USE_RES struct LDKCResult_ExpiryTimeCreationErrorZ ExpiryTime_from_seconds(uint64_t seconds);
21168 * Construct an `ExpiryTime` from a `Duration`. If there exists a `PositiveTimestamp` which
21169 * would overflow on adding the `EpiryTime` to it then this function will return a
21170 * `CreationError::ExpiryTimeOutOfBounds`.
21172 MUST_USE_RES struct LDKCResult_ExpiryTimeCreationErrorZ ExpiryTime_from_duration(uint64_t duration);
21175 * Returns the expiry time in seconds
21177 MUST_USE_RES uint64_t ExpiryTime_as_seconds(const struct LDKExpiryTime *NONNULL_PTR this_arg);
21180 * Returns a reference to the underlying `Duration` (=expiry time)
21182 MUST_USE_RES uint64_t ExpiryTime_as_duration(const struct LDKExpiryTime *NONNULL_PTR this_arg);
21185 * Creates a new (partial) route from a list of hops
21187 MUST_USE_RES struct LDKCResult_PrivateRouteCreationErrorZ PrivateRoute_new(struct LDKRouteHint hops);
21190 * Returns the underlying list of hops
21192 MUST_USE_RES struct LDKRouteHint PrivateRoute_into_inner(struct LDKPrivateRoute this_arg);
21195 * Creates a copy of the CreationError
21197 enum LDKCreationError CreationError_clone(const enum LDKCreationError *NONNULL_PTR orig);
21200 * Utility method to constructs a new DescriptionTooLong-variant CreationError
21202 enum LDKCreationError CreationError_description_too_long(void);
21205 * Utility method to constructs a new RouteTooLong-variant CreationError
21207 enum LDKCreationError CreationError_route_too_long(void);
21210 * Utility method to constructs a new TimestampOutOfBounds-variant CreationError
21212 enum LDKCreationError CreationError_timestamp_out_of_bounds(void);
21215 * Utility method to constructs a new ExpiryTimeOutOfBounds-variant CreationError
21217 enum LDKCreationError CreationError_expiry_time_out_of_bounds(void);
21220 * Checks if two CreationErrors contain equal inner contents.
21221 * This ignores pointers and is_owned flags and looks at the values in fields.
21223 bool CreationError_eq(const enum LDKCreationError *NONNULL_PTR a, const enum LDKCreationError *NONNULL_PTR b);
21226 * Get the string representation of a CreationError object
21228 struct LDKStr CreationError_to_str(const enum LDKCreationError *NONNULL_PTR o);
21231 * Creates a copy of the SemanticError
21233 enum LDKSemanticError SemanticError_clone(const enum LDKSemanticError *NONNULL_PTR orig);
21236 * Utility method to constructs a new NoPaymentHash-variant SemanticError
21238 enum LDKSemanticError SemanticError_no_payment_hash(void);
21241 * Utility method to constructs a new MultiplePaymentHashes-variant SemanticError
21243 enum LDKSemanticError SemanticError_multiple_payment_hashes(void);
21246 * Utility method to constructs a new NoDescription-variant SemanticError
21248 enum LDKSemanticError SemanticError_no_description(void);
21251 * Utility method to constructs a new MultipleDescriptions-variant SemanticError
21253 enum LDKSemanticError SemanticError_multiple_descriptions(void);
21256 * Utility method to constructs a new NoPaymentSecret-variant SemanticError
21258 enum LDKSemanticError SemanticError_no_payment_secret(void);
21261 * Utility method to constructs a new MultiplePaymentSecrets-variant SemanticError
21263 enum LDKSemanticError SemanticError_multiple_payment_secrets(void);
21266 * Utility method to constructs a new InvalidFeatures-variant SemanticError
21268 enum LDKSemanticError SemanticError_invalid_features(void);
21271 * Utility method to constructs a new InvalidRecoveryId-variant SemanticError
21273 enum LDKSemanticError SemanticError_invalid_recovery_id(void);
21276 * Utility method to constructs a new InvalidSignature-variant SemanticError
21278 enum LDKSemanticError SemanticError_invalid_signature(void);
21281 * Utility method to constructs a new ImpreciseAmount-variant SemanticError
21283 enum LDKSemanticError SemanticError_imprecise_amount(void);
21286 * Checks if two SemanticErrors contain equal inner contents.
21287 * This ignores pointers and is_owned flags and looks at the values in fields.
21289 bool SemanticError_eq(const enum LDKSemanticError *NONNULL_PTR a, const enum LDKSemanticError *NONNULL_PTR b);
21292 * Get the string representation of a SemanticError object
21294 struct LDKStr SemanticError_to_str(const enum LDKSemanticError *NONNULL_PTR o);
21297 * Frees any resources used by the SignOrCreationError
21299 void SignOrCreationError_free(struct LDKSignOrCreationError this_ptr);
21302 * Creates a copy of the SignOrCreationError
21304 struct LDKSignOrCreationError SignOrCreationError_clone(const struct LDKSignOrCreationError *NONNULL_PTR orig);
21307 * Utility method to constructs a new SignError-variant SignOrCreationError
21309 struct LDKSignOrCreationError SignOrCreationError_sign_error(void);
21312 * Utility method to constructs a new CreationError-variant SignOrCreationError
21314 struct LDKSignOrCreationError SignOrCreationError_creation_error(enum LDKCreationError a);
21317 * Checks if two SignOrCreationErrors contain equal inner contents.
21318 * This ignores pointers and is_owned flags and looks at the values in fields.
21320 bool SignOrCreationError_eq(const struct LDKSignOrCreationError *NONNULL_PTR a, const struct LDKSignOrCreationError *NONNULL_PTR b);
21323 * Get the string representation of a SignOrCreationError object
21325 struct LDKStr SignOrCreationError_to_str(const struct LDKSignOrCreationError *NONNULL_PTR o);
21328 * Utility to construct an invoice. Generally, unless you want to do something like a custom
21329 * cltv_expiry, this is what you should be using to create an invoice. The reason being, this
21330 * method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
21331 * doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
21332 * that the payment secret is valid when the invoice is paid.
21334 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);
21337 * Read a SiPrefix object from a string
21339 struct LDKCResult_SiPrefixNoneZ SiPrefix_from_str(struct LDKStr s);
21342 * Read a Invoice object from a string
21344 struct LDKCResult_InvoiceNoneZ Invoice_from_str(struct LDKStr s);
21347 * Read a SignedRawInvoice object from a string
21349 struct LDKCResult_SignedRawInvoiceNoneZ SignedRawInvoice_from_str(struct LDKStr s);
21352 * Get the string representation of a Invoice object
21354 struct LDKStr Invoice_to_str(const struct LDKInvoice *NONNULL_PTR o);
21357 * Get the string representation of a SignedRawInvoice object
21359 struct LDKStr SignedRawInvoice_to_str(const struct LDKSignedRawInvoice *NONNULL_PTR o);
21362 * Get the string representation of a Currency object
21364 struct LDKStr Currency_to_str(const enum LDKCurrency *NONNULL_PTR o);
21367 * Get the string representation of a SiPrefix object
21369 struct LDKStr SiPrefix_to_str(const enum LDKSiPrefix *NONNULL_PTR o);
21371 #endif /* LDK_C_BINDINGS_H */
21373 #include "ldk_ver.h"