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::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;
3957 * A payment identifier used to uniquely identify a payment to LDK.
3959 typedef struct MUST_USE_STRUCT LDKPaymentId {
3961 * A pointer to the opaque Rust object.
3962 * Nearly everywhere, inner must be non-null, however in places where
3963 * the Rust equivalent takes an Option, it may be set to null to indicate None.
3965 LDKnativePaymentId *inner;
3967 * Indicates that this is the only struct which contains the same pointer.
3968 * Rust functions which take ownership of an object provided via an argument require
3969 * this to be true and invalidate the object pointed to by inner.
3975 * The contents of CResult_PaymentIdDecodeErrorZ
3977 typedef union LDKCResult_PaymentIdDecodeErrorZPtr {
3979 * A pointer to the contents in the success state.
3980 * Reading from this pointer when `result_ok` is not set is undefined.
3982 struct LDKPaymentId *result;
3984 * A pointer to the contents in the error state.
3985 * Reading from this pointer when `result_ok` is set is undefined.
3987 struct LDKDecodeError *err;
3988 } LDKCResult_PaymentIdDecodeErrorZPtr;
3991 * A CResult_PaymentIdDecodeErrorZ represents the result of a fallible operation,
3992 * containing a crate::lightning::ln::channelmanager::PaymentId on success and a crate::lightning::ln::msgs::DecodeError on failure.
3993 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
3995 typedef struct LDKCResult_PaymentIdDecodeErrorZ {
3997 * The contents of this CResult_PaymentIdDecodeErrorZ, accessible via either
3998 * `err` or `result` depending on the state of `result_ok`.
4000 union LDKCResult_PaymentIdDecodeErrorZPtr contents;
4002 * Whether this CResult_PaymentIdDecodeErrorZ represents a success state.
4005 } LDKCResult_PaymentIdDecodeErrorZ;
4008 * An enum which can either contain a u16 or not
4010 typedef enum LDKCOption_u16Z_Tag {
4012 * When we're in this state, this COption_u16Z contains a u16
4014 LDKCOption_u16Z_Some,
4016 * When we're in this state, this COption_u16Z contains nothing
4018 LDKCOption_u16Z_None,
4020 * Must be last for serialization purposes
4022 LDKCOption_u16Z_Sentinel,
4023 } LDKCOption_u16Z_Tag;
4025 typedef struct LDKCOption_u16Z {
4026 LDKCOption_u16Z_Tag tag;
4035 * Indicates an error on the client's part (usually some variant of attempting to use too-low or
4038 typedef enum LDKAPIError_Tag {
4040 * Indicates the API was wholly misused (see err for more). Cases where these can be returned
4041 * are documented, but generally indicates some precondition of a function was violated.
4043 LDKAPIError_APIMisuseError,
4045 * Due to a high feerate, we were unable to complete the request.
4046 * For example, this may be returned if the feerate implies we cannot open a channel at the
4047 * requested value, but opening a larger channel would succeed.
4049 LDKAPIError_FeeRateTooHigh,
4051 * A malformed Route was provided (eg overflowed value, node id mismatch, overly-looped route,
4052 * too-many-hops, etc).
4054 LDKAPIError_RouteError,
4056 * We were unable to complete the request as the Channel required to do so is unable to
4057 * complete the request (or was not found). This can take many forms, including disconnected
4058 * peer, channel at capacity, channel shutting down, etc.
4060 LDKAPIError_ChannelUnavailable,
4062 * An attempt to call watch/update_channel returned an Err (ie you did this!), causing the
4063 * attempted action to fail.
4065 LDKAPIError_MonitorUpdateFailed,
4067 * [`KeysInterface::get_shutdown_scriptpubkey`] returned a shutdown scriptpubkey incompatible
4068 * with the channel counterparty as negotiated in [`InitFeatures`].
4070 * Using a SegWit v0 script should resolve this issue. If you cannot, you won't be able to open
4071 * a channel or cooperatively close one with this peer (and will have to force-close instead).
4073 * [`KeysInterface::get_shutdown_scriptpubkey`]: crate::chain::keysinterface::KeysInterface::get_shutdown_scriptpubkey
4074 * [`InitFeatures`]: crate::ln::features::InitFeatures
4076 LDKAPIError_IncompatibleShutdownScript,
4078 * Must be last for serialization purposes
4080 LDKAPIError_Sentinel,
4083 typedef struct LDKAPIError_LDKAPIMisuseError_Body {
4085 * A human-readable error message
4088 } LDKAPIError_LDKAPIMisuseError_Body;
4090 typedef struct LDKAPIError_LDKFeeRateTooHigh_Body {
4092 * A human-readable error message
4096 * The feerate which was too high.
4099 } LDKAPIError_LDKFeeRateTooHigh_Body;
4101 typedef struct LDKAPIError_LDKRouteError_Body {
4103 * A human-readable error message
4106 } LDKAPIError_LDKRouteError_Body;
4108 typedef struct LDKAPIError_LDKChannelUnavailable_Body {
4110 * A human-readable error message
4113 } LDKAPIError_LDKChannelUnavailable_Body;
4115 typedef struct LDKAPIError_LDKIncompatibleShutdownScript_Body {
4117 * The incompatible shutdown script.
4119 struct LDKShutdownScript script;
4120 } LDKAPIError_LDKIncompatibleShutdownScript_Body;
4122 typedef struct MUST_USE_STRUCT LDKAPIError {
4123 LDKAPIError_Tag tag;
4125 LDKAPIError_LDKAPIMisuseError_Body api_misuse_error;
4126 LDKAPIError_LDKFeeRateTooHigh_Body fee_rate_too_high;
4127 LDKAPIError_LDKRouteError_Body route_error;
4128 LDKAPIError_LDKChannelUnavailable_Body channel_unavailable;
4129 LDKAPIError_LDKIncompatibleShutdownScript_Body incompatible_shutdown_script;
4134 * The contents of CResult_NoneAPIErrorZ
4136 typedef union LDKCResult_NoneAPIErrorZPtr {
4138 * Note that this value is always NULL, as there are no contents in the OK variant
4142 * A pointer to the contents in the error state.
4143 * Reading from this pointer when `result_ok` is set is undefined.
4145 struct LDKAPIError *err;
4146 } LDKCResult_NoneAPIErrorZPtr;
4149 * A CResult_NoneAPIErrorZ represents the result of a fallible operation,
4150 * containing a () on success and a crate::lightning::util::errors::APIError on failure.
4151 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4153 typedef struct LDKCResult_NoneAPIErrorZ {
4155 * The contents of this CResult_NoneAPIErrorZ, accessible via either
4156 * `err` or `result` depending on the state of `result_ok`.
4158 union LDKCResult_NoneAPIErrorZPtr contents;
4160 * Whether this CResult_NoneAPIErrorZ represents a success state.
4163 } LDKCResult_NoneAPIErrorZ;
4166 * A dynamically-allocated array of crate::c_types::derived::CResult_NoneAPIErrorZs of arbitrary size.
4167 * This corresponds to std::vector in C++
4169 typedef struct LDKCVec_CResult_NoneAPIErrorZZ {
4171 * The elements in the array.
4172 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4174 struct LDKCResult_NoneAPIErrorZ *data;
4176 * The number of elements pointed to by `data`.
4179 } LDKCVec_CResult_NoneAPIErrorZZ;
4182 * A dynamically-allocated array of crate::lightning::util::errors::APIErrors of arbitrary size.
4183 * This corresponds to std::vector in C++
4185 typedef struct LDKCVec_APIErrorZ {
4187 * The elements in the array.
4188 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4190 struct LDKAPIError *data;
4192 * The number of elements pointed to by `data`.
4195 } LDKCVec_APIErrorZ;
4198 * The contents of CResult__u832APIErrorZ
4200 typedef union LDKCResult__u832APIErrorZPtr {
4202 * A pointer to the contents in the success state.
4203 * Reading from this pointer when `result_ok` is not set is undefined.
4205 struct LDKThirtyTwoBytes *result;
4207 * A pointer to the contents in the error state.
4208 * Reading from this pointer when `result_ok` is set is undefined.
4210 struct LDKAPIError *err;
4211 } LDKCResult__u832APIErrorZPtr;
4214 * A CResult__u832APIErrorZ represents the result of a fallible operation,
4215 * containing a crate::c_types::ThirtyTwoBytes on success and a crate::lightning::util::errors::APIError on failure.
4216 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4218 typedef struct LDKCResult__u832APIErrorZ {
4220 * The contents of this CResult__u832APIErrorZ, accessible via either
4221 * `err` or `result` depending on the state of `result_ok`.
4223 union LDKCResult__u832APIErrorZPtr contents;
4225 * Whether this CResult__u832APIErrorZ represents a success state.
4228 } LDKCResult__u832APIErrorZ;
4231 * If a payment fails to send, it can be in one of several states. This enum is returned as the
4232 * Err() type describing which state the payment is in, see the description of individual enum
4235 typedef enum LDKPaymentSendFailure_Tag {
4237 * A parameter which was passed to send_payment was invalid, preventing us from attempting to
4238 * send the payment at all. No channel state has been changed or messages sent to peers, and
4239 * once you've changed the parameter at error, you can freely retry the payment in full.
4241 LDKPaymentSendFailure_ParameterError,
4243 * A parameter in a single path which was passed to send_payment was invalid, preventing us
4244 * from attempting to send the payment at all. No channel state has been changed or messages
4245 * sent to peers, and once you've changed the parameter at error, you can freely retry the
4248 * The results here are ordered the same as the paths in the route object which was passed to
4251 LDKPaymentSendFailure_PathParameterError,
4253 * All paths which were attempted failed to send, with no channel state change taking place.
4254 * You can freely retry the payment in full (though you probably want to do so over different
4255 * paths than the ones selected).
4257 LDKPaymentSendFailure_AllFailedRetrySafe,
4259 * Some paths which were attempted failed to send, though possibly not all. At least some
4260 * paths have irrevocably committed to the HTLC and retrying the payment in full would result
4261 * in over-/re-payment.
4263 * The results here are ordered the same as the paths in the route object which was passed to
4264 * send_payment, and any Errs which are not APIError::MonitorUpdateFailed can be safely
4265 * retried (though there is currently no API with which to do so).
4267 * Any entries which contain Err(APIError::MonitorUpdateFailed) or Ok(()) MUST NOT be retried
4268 * as they will result in over-/re-payment. These HTLCs all either successfully sent (in the
4269 * case of Ok(())) or will send once channel_monitor_updated is called on the next-hop channel
4270 * with the latest update_id.
4272 LDKPaymentSendFailure_PartialFailure,
4274 * Must be last for serialization purposes
4276 LDKPaymentSendFailure_Sentinel,
4277 } LDKPaymentSendFailure_Tag;
4279 typedef struct MUST_USE_STRUCT LDKPaymentSendFailure {
4280 LDKPaymentSendFailure_Tag tag;
4283 struct LDKAPIError parameter_error;
4286 struct LDKCVec_CResult_NoneAPIErrorZZ path_parameter_error;
4289 struct LDKCVec_APIErrorZ all_failed_retry_safe;
4292 struct LDKCVec_CResult_NoneAPIErrorZZ partial_failure;
4295 } LDKPaymentSendFailure;
4298 * The contents of CResult_PaymentIdPaymentSendFailureZ
4300 typedef union LDKCResult_PaymentIdPaymentSendFailureZPtr {
4302 * A pointer to the contents in the success state.
4303 * Reading from this pointer when `result_ok` is not set is undefined.
4305 struct LDKPaymentId *result;
4307 * A pointer to the contents in the error state.
4308 * Reading from this pointer when `result_ok` is set is undefined.
4310 struct LDKPaymentSendFailure *err;
4311 } LDKCResult_PaymentIdPaymentSendFailureZPtr;
4314 * A CResult_PaymentIdPaymentSendFailureZ represents the result of a fallible operation,
4315 * containing a crate::lightning::ln::channelmanager::PaymentId on success and a crate::lightning::ln::channelmanager::PaymentSendFailure on failure.
4316 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4318 typedef struct LDKCResult_PaymentIdPaymentSendFailureZ {
4320 * The contents of this CResult_PaymentIdPaymentSendFailureZ, accessible via either
4321 * `err` or `result` depending on the state of `result_ok`.
4323 union LDKCResult_PaymentIdPaymentSendFailureZPtr contents;
4325 * Whether this CResult_PaymentIdPaymentSendFailureZ represents a success state.
4328 } LDKCResult_PaymentIdPaymentSendFailureZ;
4331 * The contents of CResult_NonePaymentSendFailureZ
4333 typedef union LDKCResult_NonePaymentSendFailureZPtr {
4335 * Note that this value is always NULL, as there are no contents in the OK variant
4339 * A pointer to the contents in the error state.
4340 * Reading from this pointer when `result_ok` is set is undefined.
4342 struct LDKPaymentSendFailure *err;
4343 } LDKCResult_NonePaymentSendFailureZPtr;
4346 * A CResult_NonePaymentSendFailureZ represents the result of a fallible operation,
4347 * containing a () on success and a crate::lightning::ln::channelmanager::PaymentSendFailure on failure.
4348 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4350 typedef struct LDKCResult_NonePaymentSendFailureZ {
4352 * The contents of this CResult_NonePaymentSendFailureZ, accessible via either
4353 * `err` or `result` depending on the state of `result_ok`.
4355 union LDKCResult_NonePaymentSendFailureZPtr contents;
4357 * Whether this CResult_NonePaymentSendFailureZ represents a success state.
4360 } LDKCResult_NonePaymentSendFailureZ;
4363 * A tuple of 2 elements. See the individual fields for the types contained.
4365 typedef struct LDKC2Tuple_PaymentHashPaymentIdZ {
4367 * The element at position 0
4369 struct LDKThirtyTwoBytes a;
4371 * The element at position 1
4373 struct LDKPaymentId b;
4374 } LDKC2Tuple_PaymentHashPaymentIdZ;
4377 * The contents of CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ
4379 typedef union LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZPtr {
4381 * A pointer to the contents in the success state.
4382 * Reading from this pointer when `result_ok` is not set is undefined.
4384 struct LDKC2Tuple_PaymentHashPaymentIdZ *result;
4386 * A pointer to the contents in the error state.
4387 * Reading from this pointer when `result_ok` is set is undefined.
4389 struct LDKPaymentSendFailure *err;
4390 } LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZPtr;
4393 * A CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ represents the result of a fallible operation,
4394 * containing a crate::c_types::derived::C2Tuple_PaymentHashPaymentIdZ on success and a crate::lightning::ln::channelmanager::PaymentSendFailure on failure.
4395 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4397 typedef struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ {
4399 * The contents of this CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ, accessible via either
4400 * `err` or `result` depending on the state of `result_ok`.
4402 union LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZPtr contents;
4404 * Whether this CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ represents a success state.
4407 } LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ;
4410 * A 4-byte byte array.
4412 typedef struct LDKFourBytes {
4420 * A 16-byte byte array.
4422 typedef struct LDKSixteenBytes {
4430 * A 10-byte byte array.
4432 typedef struct LDKTenBytes {
4440 * An address which can be used to connect to a remote peer
4442 typedef enum LDKNetAddress_Tag {
4444 * An IPv4 address/port on which the peer is listening.
4448 * An IPv6 address/port on which the peer is listening.
4452 * An old-style Tor onion address/port on which the peer is listening.
4454 LDKNetAddress_OnionV2,
4456 * A new-style Tor onion address/port on which the peer is listening.
4457 * To create the human-readable \"hostname\", concatenate ed25519_pubkey, checksum, and version,
4458 * wrap as base32 and append \".onion\".
4460 LDKNetAddress_OnionV3,
4462 * Must be last for serialization purposes
4464 LDKNetAddress_Sentinel,
4465 } LDKNetAddress_Tag;
4467 typedef struct LDKNetAddress_LDKIPv4_Body {
4469 * The 4-byte IPv4 address
4471 struct LDKFourBytes addr;
4473 * The port on which the node is listening
4476 } LDKNetAddress_LDKIPv4_Body;
4478 typedef struct LDKNetAddress_LDKIPv6_Body {
4480 * The 16-byte IPv6 address
4482 struct LDKSixteenBytes addr;
4484 * The port on which the node is listening
4487 } LDKNetAddress_LDKIPv6_Body;
4489 typedef struct LDKNetAddress_LDKOnionV2_Body {
4491 * The bytes (usually encoded in base32 with \".onion\" appended)
4493 struct LDKTenBytes addr;
4495 * The port on which the node is listening
4498 } LDKNetAddress_LDKOnionV2_Body;
4500 typedef struct LDKNetAddress_LDKOnionV3_Body {
4502 * The ed25519 long-term public key of the peer
4504 struct LDKThirtyTwoBytes ed25519_pubkey;
4506 * The checksum of the pubkey and version, as included in the onion address
4510 * The version byte, as defined by the Tor Onion v3 spec.
4514 * The port on which the node is listening
4517 } LDKNetAddress_LDKOnionV3_Body;
4519 typedef struct MUST_USE_STRUCT LDKNetAddress {
4520 LDKNetAddress_Tag tag;
4522 LDKNetAddress_LDKIPv4_Body i_pv4;
4523 LDKNetAddress_LDKIPv6_Body i_pv6;
4524 LDKNetAddress_LDKOnionV2_Body onion_v2;
4525 LDKNetAddress_LDKOnionV3_Body onion_v3;
4530 * A dynamically-allocated array of crate::lightning::ln::msgs::NetAddresss of arbitrary size.
4531 * This corresponds to std::vector in C++
4533 typedef struct LDKCVec_NetAddressZ {
4535 * The elements in the array.
4536 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4538 struct LDKNetAddress *data;
4540 * The number of elements pointed to by `data`.
4543 } LDKCVec_NetAddressZ;
4546 * A tuple of 2 elements. See the individual fields for the types contained.
4548 typedef struct LDKC2Tuple_PaymentHashPaymentSecretZ {
4550 * The element at position 0
4552 struct LDKThirtyTwoBytes a;
4554 * The element at position 1
4556 struct LDKThirtyTwoBytes b;
4557 } LDKC2Tuple_PaymentHashPaymentSecretZ;
4560 * The contents of CResult_PaymentSecretAPIErrorZ
4562 typedef union LDKCResult_PaymentSecretAPIErrorZPtr {
4564 * A pointer to the contents in the success state.
4565 * Reading from this pointer when `result_ok` is not set is undefined.
4567 struct LDKThirtyTwoBytes *result;
4569 * A pointer to the contents in the error state.
4570 * Reading from this pointer when `result_ok` is set is undefined.
4572 struct LDKAPIError *err;
4573 } LDKCResult_PaymentSecretAPIErrorZPtr;
4576 * A CResult_PaymentSecretAPIErrorZ represents the result of a fallible operation,
4577 * containing a crate::c_types::ThirtyTwoBytes on success and a crate::lightning::util::errors::APIError on failure.
4578 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4580 typedef struct LDKCResult_PaymentSecretAPIErrorZ {
4582 * The contents of this CResult_PaymentSecretAPIErrorZ, accessible via either
4583 * `err` or `result` depending on the state of `result_ok`.
4585 union LDKCResult_PaymentSecretAPIErrorZPtr contents;
4587 * Whether this CResult_PaymentSecretAPIErrorZ represents a success state.
4590 } LDKCResult_PaymentSecretAPIErrorZ;
4593 * A dynamically-allocated array of crate::lightning::chain::channelmonitor::ChannelMonitors of arbitrary size.
4594 * This corresponds to std::vector in C++
4596 typedef struct LDKCVec_ChannelMonitorZ {
4598 * The elements in the array.
4599 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
4601 struct LDKChannelMonitor *data;
4603 * The number of elements pointed to by `data`.
4606 } LDKCVec_ChannelMonitorZ;
4611 * An update generated by the underlying Channel itself which contains some new information the
4612 * ChannelMonitor should be made aware of.
4614 typedef struct MUST_USE_STRUCT LDKChannelMonitorUpdate {
4616 * A pointer to the opaque Rust object.
4617 * Nearly everywhere, inner must be non-null, however in places where
4618 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4620 LDKnativeChannelMonitorUpdate *inner;
4622 * Indicates that this is the only struct which contains the same pointer.
4623 * Rust functions which take ownership of an object provided via an argument require
4624 * this to be true and invalidate the object pointed to by inner.
4627 } LDKChannelMonitorUpdate;
4630 * The `Watch` trait defines behavior for watching on-chain activity pertaining to channels as
4631 * blocks are connected and disconnected.
4633 * Each channel is associated with a [`ChannelMonitor`]. Implementations of this trait are
4634 * responsible for maintaining a set of monitors such that they can be updated accordingly as
4635 * channel state changes and HTLCs are resolved. See method documentation for specific
4638 * Implementations **must** ensure that updates are successfully applied and persisted upon method
4639 * completion. If an update fails with a [`PermanentFailure`], then it must immediately shut down
4640 * without taking any further action such as persisting the current state.
4642 * If an implementation maintains multiple instances of a channel's monitor (e.g., by storing
4643 * backup copies), then it must ensure that updates are applied across all instances. Otherwise, it
4644 * could result in a revoked transaction being broadcast, allowing the counterparty to claim all
4645 * funds in the channel. See [`ChannelMonitorUpdateErr`] for more details about how to handle
4646 * multiple instances.
4648 * [`PermanentFailure`]: ChannelMonitorUpdateErr::PermanentFailure
4650 typedef struct LDKWatch {
4652 * An opaque pointer which is passed to your function implementations as an argument.
4653 * This has no meaning in the LDK, and can be NULL or any other value.
4657 * Watches a channel identified by `funding_txo` using `monitor`.
4659 * Implementations are responsible for watching the chain for the funding transaction along
4660 * with any spends of outputs returned by [`get_outputs_to_watch`]. In practice, this means
4661 * calling [`block_connected`] and [`block_disconnected`] on the monitor.
4663 * Note: this interface MUST error with `ChannelMonitorUpdateErr::PermanentFailure` if
4664 * the given `funding_txo` has previously been registered via `watch_channel`.
4666 * [`get_outputs_to_watch`]: channelmonitor::ChannelMonitor::get_outputs_to_watch
4667 * [`block_connected`]: channelmonitor::ChannelMonitor::block_connected
4668 * [`block_disconnected`]: channelmonitor::ChannelMonitor::block_disconnected
4670 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*watch_channel)(const void *this_arg, struct LDKOutPoint funding_txo, struct LDKChannelMonitor monitor);
4672 * Updates a channel identified by `funding_txo` by applying `update` to its monitor.
4674 * Implementations must call [`update_monitor`] with the given update. See
4675 * [`ChannelMonitorUpdateErr`] for invariants around returning an error.
4677 * [`update_monitor`]: channelmonitor::ChannelMonitor::update_monitor
4679 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*update_channel)(const void *this_arg, struct LDKOutPoint funding_txo, struct LDKChannelMonitorUpdate update);
4681 * Returns any monitor events since the last call. Subsequent calls must only return new
4684 struct LDKCVec_MonitorEventZ (*release_pending_monitor_events)(const void *this_arg);
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 * An interface to send a transaction to the Bitcoin network.
4695 typedef struct LDKBroadcasterInterface {
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.
4702 * Sends a transaction out to (hopefully) be mined.
4704 void (*broadcast_transaction)(const void *this_arg, struct LDKTransaction tx);
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);
4710 } LDKBroadcasterInterface;
4713 * A "slice" referencing some byte array. This is simply a length-tagged pointer which does not
4714 * own the memory pointed to by data.
4716 typedef struct LDKu8slice {
4718 * A pointer to the byte buffer
4720 const uint8_t *data;
4722 * The number of bytes pointed to by `data`.
4728 * A trait to describe an object which can get user secrets and key material.
4730 typedef struct LDKKeysInterface {
4732 * An opaque pointer which is passed to your function implementations as an argument.
4733 * This has no meaning in the LDK, and can be NULL or any other value.
4737 * Get node secret key (aka node_id or network_key).
4739 * This method must return the same value each time it is called.
4741 struct LDKSecretKey (*get_node_secret)(const void *this_arg);
4743 * Get a script pubkey which we send funds to when claiming on-chain contestable outputs.
4745 * This method should return a different value each time it is called, to avoid linking
4746 * on-chain funds across channels as controlled to the same user.
4748 struct LDKCVec_u8Z (*get_destination_script)(const void *this_arg);
4750 * Get a script pubkey which we will send funds to when closing a channel.
4752 * This method should return a different value each time it is called, to avoid linking
4753 * on-chain funds across channels as controlled to the same user.
4755 struct LDKShutdownScript (*get_shutdown_scriptpubkey)(const void *this_arg);
4757 * Get a new set of Sign for per-channel secrets. These MUST be unique even if you
4758 * restarted with some stale data!
4760 * This method must return a different value each time it is called.
4762 struct LDKSign (*get_channel_signer)(const void *this_arg, bool inbound, uint64_t channel_value_satoshis);
4764 * Gets a unique, cryptographically-secure, random 32 byte value. This is used for encrypting
4765 * onion packets and for temporary channel IDs. There is no requirement that these be
4766 * persisted anywhere, though they must be unique across restarts.
4768 * This method must return a different value each time it is called.
4770 struct LDKThirtyTwoBytes (*get_secure_random_bytes)(const void *this_arg);
4772 * Reads a `Signer` for this `KeysInterface` from the given input stream.
4773 * This is only called during deserialization of other objects which contain
4774 * `Sign`-implementing objects (ie `ChannelMonitor`s and `ChannelManager`s).
4775 * The bytes are exactly those which `<Self::Signer as Writeable>::write()` writes, and
4776 * contain no versioning scheme. You may wish to include your own version prefix and ensure
4777 * you've read all of the provided bytes to ensure no corruption occurred.
4779 struct LDKCResult_SignDecodeErrorZ (*read_chan_signer)(const void *this_arg, struct LDKu8slice reader);
4781 * Sign an invoice's preimage (note that this is the preimage of the invoice, not the HTLC's
4782 * preimage). By parameterizing by the preimage instead of the hash, we allow implementors of
4783 * this trait to parse the invoice and make sure they're signing what they expect, rather than
4784 * blindly signing the hash.
4786 struct LDKCResult_RecoverableSignatureNoneZ (*sign_invoice)(const void *this_arg, struct LDKCVec_u8Z invoice_preimage);
4788 * Frees any resources associated with this object given its this_arg pointer.
4789 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4791 void (*free)(void *this_arg);
4795 * A trait which should be implemented to provide feerate information on a number of time
4798 * Note that all of the functions implemented here *must* be reentrant-safe (obviously - they're
4799 * called from inside the library in response to chain events, P2P events, or timer events).
4801 typedef struct LDKFeeEstimator {
4803 * An opaque pointer which is passed to your function implementations as an argument.
4804 * This has no meaning in the LDK, and can be NULL or any other value.
4808 * Gets estimated satoshis of fee required per 1000 Weight-Units.
4810 * Must be no smaller than 253 (ie 1 satoshi-per-byte rounded up to ensure later round-downs
4811 * don't put us below 1 satoshi-per-byte).
4813 * This translates to:
4814 * * satoshis-per-byte * 250
4815 * * ceil(satoshis-per-kbyte / 4)
4817 uint32_t (*get_est_sat_per_1000_weight)(const void *this_arg, enum LDKConfirmationTarget confirmation_target);
4819 * Frees any resources associated with this object given its this_arg pointer.
4820 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4822 void (*free)(void *this_arg);
4826 * A trait encapsulating the operations required of a logger
4828 typedef struct LDKLogger {
4830 * An opaque pointer which is passed to your function implementations as an argument.
4831 * This has no meaning in the LDK, and can be NULL or any other value.
4837 void (*log)(const void *this_arg, const char *record);
4839 * Frees any resources associated with this object given its this_arg pointer.
4840 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
4842 void (*free)(void *this_arg);
4848 * Manager which keeps track of a number of channels and sends messages to the appropriate
4849 * channel, also tracking HTLC preimages and forwarding onion packets appropriately.
4851 * Implements ChannelMessageHandler, handling the multi-channel parts and passing things through
4852 * to individual Channels.
4854 * Implements Writeable to write out all channel state to disk. Implies peer_disconnected() for
4855 * all peers during write/read (though does not modify this instance, only the instance being
4856 * serialized). This will result in any channels which have not yet exchanged funding_created (ie
4857 * called funding_transaction_generated for outbound channels).
4859 * Note that you can be a bit lazier about writing out ChannelManager than you can be with
4860 * ChannelMonitors. With ChannelMonitors you MUST write each monitor update out to disk before
4861 * returning from chain::Watch::watch_/update_channel, with ChannelManagers, writing updates
4862 * happens out-of-band (and will prevent any other ChannelManager operations from occurring during
4863 * the serialization process). If the deserialized version is out-of-date compared to the
4864 * ChannelMonitors passed by reference to read(), those channels will be force-closed based on the
4865 * ChannelMonitor state and no funds will be lost (mod on-chain transaction fees).
4867 * Note that the deserializer is only implemented for (BlockHash, ChannelManager), which
4868 * tells you the last block hash which was block_connect()ed. You MUST rescan any blocks along
4869 * the \"reorg path\" (ie call block_disconnected() until you get to a common block and then call
4870 * block_connected() to step towards your best block) upon deserialization before using the
4873 * Note that ChannelManager is responsible for tracking liveness of its channels and generating
4874 * ChannelUpdate messages informing peers that the channel is temporarily disabled. To avoid
4875 * spam due to quick disconnection/reconnection, updates are not sent until the channel has been
4876 * offline for a full minute. In order to track this, you must call
4877 * timer_tick_occurred roughly once per minute, though it doesn't have to be perfect.
4879 * Rather than using a plain ChannelManager, it is preferable to use either a SimpleArcChannelManager
4880 * a SimpleRefChannelManager, for conciseness. See their documentation for more details, but
4881 * essentially you should default to using a SimpleRefChannelManager, and use a
4882 * SimpleArcChannelManager when you require a ChannelManager with a static lifetime, such as when
4883 * you're using lightning-net-tokio.
4885 typedef struct MUST_USE_STRUCT LDKChannelManager {
4887 * A pointer to the opaque Rust object.
4888 * Nearly everywhere, inner must be non-null, however in places where
4889 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4891 LDKnativeChannelManager *inner;
4893 * Indicates that this is the only struct which contains the same pointer.
4894 * Rust functions which take ownership of an object provided via an argument require
4895 * this to be true and invalidate the object pointed to by inner.
4898 } LDKChannelManager;
4901 * A tuple of 2 elements. See the individual fields for the types contained.
4903 typedef struct LDKC2Tuple_BlockHashChannelManagerZ {
4905 * The element at position 0
4907 struct LDKThirtyTwoBytes a;
4909 * The element at position 1
4911 struct LDKChannelManager b;
4912 } LDKC2Tuple_BlockHashChannelManagerZ;
4915 * The contents of CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ
4917 typedef union LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr {
4919 * A pointer to the contents in the success state.
4920 * Reading from this pointer when `result_ok` is not set is undefined.
4922 struct LDKC2Tuple_BlockHashChannelManagerZ *result;
4924 * A pointer to the contents in the error state.
4925 * Reading from this pointer when `result_ok` is set is undefined.
4927 struct LDKDecodeError *err;
4928 } LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr;
4931 * A CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ represents the result of a fallible operation,
4932 * containing a crate::c_types::derived::C2Tuple_BlockHashChannelManagerZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
4933 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4935 typedef struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ {
4937 * The contents of this CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ, accessible via either
4938 * `err` or `result` depending on the state of `result_ok`.
4940 union LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZPtr contents;
4942 * Whether this CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ represents a success state.
4945 } LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ;
4950 * Options which apply on a per-channel basis and may change at runtime or based on negotiation
4951 * with our counterparty.
4953 typedef struct MUST_USE_STRUCT LDKChannelConfig {
4955 * A pointer to the opaque Rust object.
4956 * Nearly everywhere, inner must be non-null, however in places where
4957 * the Rust equivalent takes an Option, it may be set to null to indicate None.
4959 LDKnativeChannelConfig *inner;
4961 * Indicates that this is the only struct which contains the same pointer.
4962 * Rust functions which take ownership of an object provided via an argument require
4963 * this to be true and invalidate the object pointed to by inner.
4969 * The contents of CResult_ChannelConfigDecodeErrorZ
4971 typedef union LDKCResult_ChannelConfigDecodeErrorZPtr {
4973 * A pointer to the contents in the success state.
4974 * Reading from this pointer when `result_ok` is not set is undefined.
4976 struct LDKChannelConfig *result;
4978 * A pointer to the contents in the error state.
4979 * Reading from this pointer when `result_ok` is set is undefined.
4981 struct LDKDecodeError *err;
4982 } LDKCResult_ChannelConfigDecodeErrorZPtr;
4985 * A CResult_ChannelConfigDecodeErrorZ represents the result of a fallible operation,
4986 * containing a crate::lightning::util::config::ChannelConfig on success and a crate::lightning::ln::msgs::DecodeError on failure.
4987 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
4989 typedef struct LDKCResult_ChannelConfigDecodeErrorZ {
4991 * The contents of this CResult_ChannelConfigDecodeErrorZ, accessible via either
4992 * `err` or `result` depending on the state of `result_ok`.
4994 union LDKCResult_ChannelConfigDecodeErrorZPtr contents;
4996 * Whether this CResult_ChannelConfigDecodeErrorZ represents a success state.
4999 } LDKCResult_ChannelConfigDecodeErrorZ;
5002 * The contents of CResult_OutPointDecodeErrorZ
5004 typedef union LDKCResult_OutPointDecodeErrorZPtr {
5006 * A pointer to the contents in the success state.
5007 * Reading from this pointer when `result_ok` is not set is undefined.
5009 struct LDKOutPoint *result;
5011 * A pointer to the contents in the error state.
5012 * Reading from this pointer when `result_ok` is set is undefined.
5014 struct LDKDecodeError *err;
5015 } LDKCResult_OutPointDecodeErrorZPtr;
5018 * A CResult_OutPointDecodeErrorZ represents the result of a fallible operation,
5019 * containing a crate::lightning::chain::transaction::OutPoint on success and a crate::lightning::ln::msgs::DecodeError on failure.
5020 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5022 typedef struct LDKCResult_OutPointDecodeErrorZ {
5024 * The contents of this CResult_OutPointDecodeErrorZ, accessible via either
5025 * `err` or `result` depending on the state of `result_ok`.
5027 union LDKCResult_OutPointDecodeErrorZPtr contents;
5029 * Whether this CResult_OutPointDecodeErrorZ represents a success state.
5032 } LDKCResult_OutPointDecodeErrorZ;
5035 * Defines a type identifier for sending messages over the wire.
5037 * Messages implementing this trait specify a type and must be [`Writeable`].
5039 typedef struct LDKType {
5041 * An opaque pointer which is passed to your function implementations as an argument.
5042 * This has no meaning in the LDK, and can be NULL or any other value.
5046 * Returns the type identifying the message payload.
5048 uint16_t (*type_id)(const void *this_arg);
5050 * Return a human-readable "debug" string describing this object
5052 struct LDKStr (*debug_str)(const void *this_arg);
5054 * Serialize the object into a byte array
5056 struct LDKCVec_u8Z (*write)(const void *this_arg);
5058 * Frees any resources associated with this object given its this_arg pointer.
5059 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
5061 void (*free)(void *this_arg);
5065 * An enum which can either contain a crate::lightning::ln::wire::Type or not
5067 typedef enum LDKCOption_TypeZ_Tag {
5069 * When we're in this state, this COption_TypeZ contains a crate::lightning::ln::wire::Type
5071 LDKCOption_TypeZ_Some,
5073 * When we're in this state, this COption_TypeZ contains nothing
5075 LDKCOption_TypeZ_None,
5077 * Must be last for serialization purposes
5079 LDKCOption_TypeZ_Sentinel,
5080 } LDKCOption_TypeZ_Tag;
5082 typedef struct LDKCOption_TypeZ {
5083 LDKCOption_TypeZ_Tag tag;
5086 struct LDKType some;
5092 * The contents of CResult_COption_TypeZDecodeErrorZ
5094 typedef union LDKCResult_COption_TypeZDecodeErrorZPtr {
5096 * A pointer to the contents in the success state.
5097 * Reading from this pointer when `result_ok` is not set is undefined.
5099 struct LDKCOption_TypeZ *result;
5101 * A pointer to the contents in the error state.
5102 * Reading from this pointer when `result_ok` is set is undefined.
5104 struct LDKDecodeError *err;
5105 } LDKCResult_COption_TypeZDecodeErrorZPtr;
5108 * A CResult_COption_TypeZDecodeErrorZ represents the result of a fallible operation,
5109 * containing a crate::c_types::derived::COption_TypeZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
5110 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5112 typedef struct LDKCResult_COption_TypeZDecodeErrorZ {
5114 * The contents of this CResult_COption_TypeZDecodeErrorZ, accessible via either
5115 * `err` or `result` depending on the state of `result_ok`.
5117 union LDKCResult_COption_TypeZDecodeErrorZPtr contents;
5119 * Whether this CResult_COption_TypeZDecodeErrorZ represents a success state.
5122 } LDKCResult_COption_TypeZDecodeErrorZ;
5125 * The contents of CResult_SiPrefixNoneZ
5127 typedef union LDKCResult_SiPrefixNoneZPtr {
5129 * A pointer to the contents in the success state.
5130 * Reading from this pointer when `result_ok` is not set is undefined.
5132 enum LDKSiPrefix *result;
5134 * Note that this value is always NULL, as there are no contents in the Err variant
5137 } LDKCResult_SiPrefixNoneZPtr;
5140 * A CResult_SiPrefixNoneZ represents the result of a fallible operation,
5141 * containing a crate::lightning_invoice::SiPrefix on success and a () on failure.
5142 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5144 typedef struct LDKCResult_SiPrefixNoneZ {
5146 * The contents of this CResult_SiPrefixNoneZ, accessible via either
5147 * `err` or `result` depending on the state of `result_ok`.
5149 union LDKCResult_SiPrefixNoneZPtr contents;
5151 * Whether this CResult_SiPrefixNoneZ represents a success state.
5154 } LDKCResult_SiPrefixNoneZ;
5159 * Represents a syntactically and semantically correct lightning BOLT11 invoice.
5161 * There are three ways to construct an `Invoice`:
5162 * 1. using `InvoiceBuilder`
5163 * 2. using `Invoice::from_signed(SignedRawInvoice)`
5164 * 3. using `str::parse::<Invoice>(&str)`
5166 typedef struct MUST_USE_STRUCT LDKInvoice {
5168 * A pointer to the opaque Rust object.
5169 * Nearly everywhere, inner must be non-null, however in places where
5170 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5172 LDKnativeInvoice *inner;
5174 * Indicates that this is the only struct which contains the same pointer.
5175 * Rust functions which take ownership of an object provided via an argument require
5176 * this to be true and invalidate the object pointed to by inner.
5182 * The contents of CResult_InvoiceNoneZ
5184 typedef union LDKCResult_InvoiceNoneZPtr {
5186 * A pointer to the contents in the success state.
5187 * Reading from this pointer when `result_ok` is not set is undefined.
5189 struct LDKInvoice *result;
5191 * Note that this value is always NULL, as there are no contents in the Err variant
5194 } LDKCResult_InvoiceNoneZPtr;
5197 * A CResult_InvoiceNoneZ represents the result of a fallible operation,
5198 * containing a crate::lightning_invoice::Invoice on success and a () on failure.
5199 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5201 typedef struct LDKCResult_InvoiceNoneZ {
5203 * The contents of this CResult_InvoiceNoneZ, accessible via either
5204 * `err` or `result` depending on the state of `result_ok`.
5206 union LDKCResult_InvoiceNoneZPtr contents;
5208 * Whether this CResult_InvoiceNoneZ represents a success state.
5211 } LDKCResult_InvoiceNoneZ;
5216 * Represents a signed `RawInvoice` with cached hash. The signature is not checked and may be
5220 * The hash has to be either from the deserialized invoice or from the serialized `raw_invoice`.
5222 typedef struct MUST_USE_STRUCT LDKSignedRawInvoice {
5224 * A pointer to the opaque Rust object.
5225 * Nearly everywhere, inner must be non-null, however in places where
5226 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5228 LDKnativeSignedRawInvoice *inner;
5230 * Indicates that this is the only struct which contains the same pointer.
5231 * Rust functions which take ownership of an object provided via an argument require
5232 * this to be true and invalidate the object pointed to by inner.
5235 } LDKSignedRawInvoice;
5238 * The contents of CResult_SignedRawInvoiceNoneZ
5240 typedef union LDKCResult_SignedRawInvoiceNoneZPtr {
5242 * A pointer to the contents in the success state.
5243 * Reading from this pointer when `result_ok` is not set is undefined.
5245 struct LDKSignedRawInvoice *result;
5247 * Note that this value is always NULL, as there are no contents in the Err variant
5250 } LDKCResult_SignedRawInvoiceNoneZPtr;
5253 * A CResult_SignedRawInvoiceNoneZ represents the result of a fallible operation,
5254 * containing a crate::lightning_invoice::SignedRawInvoice on success and a () on failure.
5255 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5257 typedef struct LDKCResult_SignedRawInvoiceNoneZ {
5259 * The contents of this CResult_SignedRawInvoiceNoneZ, accessible via either
5260 * `err` or `result` depending on the state of `result_ok`.
5262 union LDKCResult_SignedRawInvoiceNoneZPtr contents;
5264 * Whether this CResult_SignedRawInvoiceNoneZ represents a success state.
5267 } LDKCResult_SignedRawInvoiceNoneZ;
5272 * Represents an syntactically correct Invoice for a payment on the lightning network,
5273 * but without the signature information.
5274 * De- and encoding should not lead to information loss but may lead to different hashes.
5276 * For methods without docs see the corresponding methods in `Invoice`.
5278 typedef struct MUST_USE_STRUCT LDKRawInvoice {
5280 * A pointer to the opaque Rust object.
5281 * Nearly everywhere, inner must be non-null, however in places where
5282 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5284 LDKnativeRawInvoice *inner;
5286 * Indicates that this is the only struct which contains the same pointer.
5287 * Rust functions which take ownership of an object provided via an argument require
5288 * this to be true and invalidate the object pointed to by inner.
5296 * Recoverable signature
5298 typedef struct MUST_USE_STRUCT LDKInvoiceSignature {
5300 * A pointer to the opaque Rust object.
5301 * Nearly everywhere, inner must be non-null, however in places where
5302 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5304 LDKnativeInvoiceSignature *inner;
5306 * Indicates that this is the only struct which contains the same pointer.
5307 * Rust functions which take ownership of an object provided via an argument require
5308 * this to be true and invalidate the object pointed to by inner.
5311 } LDKInvoiceSignature;
5314 * A tuple of 3 elements. See the individual fields for the types contained.
5316 typedef struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ {
5318 * The element at position 0
5320 struct LDKRawInvoice a;
5322 * The element at position 1
5324 struct LDKThirtyTwoBytes b;
5326 * The element at position 2
5328 struct LDKInvoiceSignature c;
5329 } LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ;
5336 typedef struct MUST_USE_STRUCT LDKPayeePubKey {
5338 * A pointer to the opaque Rust object.
5339 * Nearly everywhere, inner must be non-null, however in places where
5340 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5342 LDKnativePayeePubKey *inner;
5344 * Indicates that this is the only struct which contains the same pointer.
5345 * Rust functions which take ownership of an object provided via an argument require
5346 * this to be true and invalidate the object pointed to by inner.
5352 * The contents of CResult_PayeePubKeyErrorZ
5354 typedef union LDKCResult_PayeePubKeyErrorZPtr {
5356 * A pointer to the contents in the success state.
5357 * Reading from this pointer when `result_ok` is not set is undefined.
5359 struct LDKPayeePubKey *result;
5361 * A pointer to the contents in the error state.
5362 * Reading from this pointer when `result_ok` is set is undefined.
5364 enum LDKSecp256k1Error *err;
5365 } LDKCResult_PayeePubKeyErrorZPtr;
5368 * A CResult_PayeePubKeyErrorZ represents the result of a fallible operation,
5369 * containing a crate::lightning_invoice::PayeePubKey on success and a crate::c_types::Secp256k1Error on failure.
5370 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5372 typedef struct LDKCResult_PayeePubKeyErrorZ {
5374 * The contents of this CResult_PayeePubKeyErrorZ, accessible via either
5375 * `err` or `result` depending on the state of `result_ok`.
5377 union LDKCResult_PayeePubKeyErrorZPtr contents;
5379 * Whether this CResult_PayeePubKeyErrorZ represents a success state.
5382 } LDKCResult_PayeePubKeyErrorZ;
5387 * Private routing information
5390 * The encoded route has to be <1024 5bit characters long (<=639 bytes or <=12 hops)
5393 typedef struct MUST_USE_STRUCT LDKPrivateRoute {
5395 * A pointer to the opaque Rust object.
5396 * Nearly everywhere, inner must be non-null, however in places where
5397 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5399 LDKnativePrivateRoute *inner;
5401 * Indicates that this is the only struct which contains the same pointer.
5402 * Rust functions which take ownership of an object provided via an argument require
5403 * this to be true and invalidate the object pointed to by inner.
5409 * A dynamically-allocated array of crate::lightning_invoice::PrivateRoutes of arbitrary size.
5410 * This corresponds to std::vector in C++
5412 typedef struct LDKCVec_PrivateRouteZ {
5414 * The elements in the array.
5415 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5417 struct LDKPrivateRoute *data;
5419 * The number of elements pointed to by `data`.
5422 } LDKCVec_PrivateRouteZ;
5427 * A timestamp that refers to a date after 1 January 1970 which means its representation as UNIX
5428 * timestamp is positive.
5431 * The UNIX timestamp representing the stored time has to be positive and small enough so that
5432 * a `EpiryTime` can be added to it without an overflow.
5434 typedef struct MUST_USE_STRUCT LDKPositiveTimestamp {
5436 * A pointer to the opaque Rust object.
5437 * Nearly everywhere, inner must be non-null, however in places where
5438 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5440 LDKnativePositiveTimestamp *inner;
5442 * Indicates that this is the only struct which contains the same pointer.
5443 * Rust functions which take ownership of an object provided via an argument require
5444 * this to be true and invalidate the object pointed to by inner.
5447 } LDKPositiveTimestamp;
5450 * The contents of CResult_PositiveTimestampCreationErrorZ
5452 typedef union LDKCResult_PositiveTimestampCreationErrorZPtr {
5454 * A pointer to the contents in the success state.
5455 * Reading from this pointer when `result_ok` is not set is undefined.
5457 struct LDKPositiveTimestamp *result;
5459 * A pointer to the contents in the error state.
5460 * Reading from this pointer when `result_ok` is set is undefined.
5462 enum LDKCreationError *err;
5463 } LDKCResult_PositiveTimestampCreationErrorZPtr;
5466 * A CResult_PositiveTimestampCreationErrorZ represents the result of a fallible operation,
5467 * containing a crate::lightning_invoice::PositiveTimestamp on success and a crate::lightning_invoice::CreationError on failure.
5468 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5470 typedef struct LDKCResult_PositiveTimestampCreationErrorZ {
5472 * The contents of this CResult_PositiveTimestampCreationErrorZ, accessible via either
5473 * `err` or `result` depending on the state of `result_ok`.
5475 union LDKCResult_PositiveTimestampCreationErrorZPtr contents;
5477 * Whether this CResult_PositiveTimestampCreationErrorZ represents a success state.
5480 } LDKCResult_PositiveTimestampCreationErrorZ;
5483 * The contents of CResult_NoneSemanticErrorZ
5485 typedef union LDKCResult_NoneSemanticErrorZPtr {
5487 * Note that this value is always NULL, as there are no contents in the OK variant
5491 * A pointer to the contents in the error state.
5492 * Reading from this pointer when `result_ok` is set is undefined.
5494 enum LDKSemanticError *err;
5495 } LDKCResult_NoneSemanticErrorZPtr;
5498 * A CResult_NoneSemanticErrorZ represents the result of a fallible operation,
5499 * containing a () on success and a crate::lightning_invoice::SemanticError on failure.
5500 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5502 typedef struct LDKCResult_NoneSemanticErrorZ {
5504 * The contents of this CResult_NoneSemanticErrorZ, accessible via either
5505 * `err` or `result` depending on the state of `result_ok`.
5507 union LDKCResult_NoneSemanticErrorZPtr contents;
5509 * Whether this CResult_NoneSemanticErrorZ represents a success state.
5512 } LDKCResult_NoneSemanticErrorZ;
5515 * The contents of CResult_InvoiceSemanticErrorZ
5517 typedef union LDKCResult_InvoiceSemanticErrorZPtr {
5519 * A pointer to the contents in the success state.
5520 * Reading from this pointer when `result_ok` is not set is undefined.
5522 struct LDKInvoice *result;
5524 * A pointer to the contents in the error state.
5525 * Reading from this pointer when `result_ok` is set is undefined.
5527 enum LDKSemanticError *err;
5528 } LDKCResult_InvoiceSemanticErrorZPtr;
5531 * A CResult_InvoiceSemanticErrorZ represents the result of a fallible operation,
5532 * containing a crate::lightning_invoice::Invoice on success and a crate::lightning_invoice::SemanticError on failure.
5533 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5535 typedef struct LDKCResult_InvoiceSemanticErrorZ {
5537 * The contents of this CResult_InvoiceSemanticErrorZ, accessible via either
5538 * `err` or `result` depending on the state of `result_ok`.
5540 union LDKCResult_InvoiceSemanticErrorZPtr contents;
5542 * Whether this CResult_InvoiceSemanticErrorZ represents a success state.
5545 } LDKCResult_InvoiceSemanticErrorZ;
5550 * Description string
5553 * The description can be at most 639 __bytes__ long
5555 typedef struct MUST_USE_STRUCT LDKDescription {
5557 * A pointer to the opaque Rust object.
5558 * Nearly everywhere, inner must be non-null, however in places where
5559 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5561 LDKnativeDescription *inner;
5563 * Indicates that this is the only struct which contains the same pointer.
5564 * Rust functions which take ownership of an object provided via an argument require
5565 * this to be true and invalidate the object pointed to by inner.
5571 * The contents of CResult_DescriptionCreationErrorZ
5573 typedef union LDKCResult_DescriptionCreationErrorZPtr {
5575 * A pointer to the contents in the success state.
5576 * Reading from this pointer when `result_ok` is not set is undefined.
5578 struct LDKDescription *result;
5580 * A pointer to the contents in the error state.
5581 * Reading from this pointer when `result_ok` is set is undefined.
5583 enum LDKCreationError *err;
5584 } LDKCResult_DescriptionCreationErrorZPtr;
5587 * A CResult_DescriptionCreationErrorZ represents the result of a fallible operation,
5588 * containing a crate::lightning_invoice::Description on success and a crate::lightning_invoice::CreationError on failure.
5589 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5591 typedef struct LDKCResult_DescriptionCreationErrorZ {
5593 * The contents of this CResult_DescriptionCreationErrorZ, accessible via either
5594 * `err` or `result` depending on the state of `result_ok`.
5596 union LDKCResult_DescriptionCreationErrorZPtr contents;
5598 * Whether this CResult_DescriptionCreationErrorZ represents a success state.
5601 } LDKCResult_DescriptionCreationErrorZ;
5606 * Positive duration that defines when (relatively to the timestamp) in the future the invoice
5610 * The number of seconds this expiry time represents has to be in the range
5611 * `0...(SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME)` to avoid overflows when adding it to a
5614 typedef struct MUST_USE_STRUCT LDKExpiryTime {
5616 * A pointer to the opaque Rust object.
5617 * Nearly everywhere, inner must be non-null, however in places where
5618 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5620 LDKnativeExpiryTime *inner;
5622 * Indicates that this is the only struct which contains the same pointer.
5623 * Rust functions which take ownership of an object provided via an argument require
5624 * this to be true and invalidate the object pointed to by inner.
5630 * The contents of CResult_ExpiryTimeCreationErrorZ
5632 typedef union LDKCResult_ExpiryTimeCreationErrorZPtr {
5634 * A pointer to the contents in the success state.
5635 * Reading from this pointer when `result_ok` is not set is undefined.
5637 struct LDKExpiryTime *result;
5639 * A pointer to the contents in the error state.
5640 * Reading from this pointer when `result_ok` is set is undefined.
5642 enum LDKCreationError *err;
5643 } LDKCResult_ExpiryTimeCreationErrorZPtr;
5646 * A CResult_ExpiryTimeCreationErrorZ represents the result of a fallible operation,
5647 * containing a crate::lightning_invoice::ExpiryTime on success and a crate::lightning_invoice::CreationError on failure.
5648 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5650 typedef struct LDKCResult_ExpiryTimeCreationErrorZ {
5652 * The contents of this CResult_ExpiryTimeCreationErrorZ, accessible via either
5653 * `err` or `result` depending on the state of `result_ok`.
5655 union LDKCResult_ExpiryTimeCreationErrorZPtr contents;
5657 * Whether this CResult_ExpiryTimeCreationErrorZ represents a success state.
5660 } LDKCResult_ExpiryTimeCreationErrorZ;
5663 * The contents of CResult_PrivateRouteCreationErrorZ
5665 typedef union LDKCResult_PrivateRouteCreationErrorZPtr {
5667 * A pointer to the contents in the success state.
5668 * Reading from this pointer when `result_ok` is not set is undefined.
5670 struct LDKPrivateRoute *result;
5672 * A pointer to the contents in the error state.
5673 * Reading from this pointer when `result_ok` is set is undefined.
5675 enum LDKCreationError *err;
5676 } LDKCResult_PrivateRouteCreationErrorZPtr;
5679 * A CResult_PrivateRouteCreationErrorZ represents the result of a fallible operation,
5680 * containing a crate::lightning_invoice::PrivateRoute on success and a crate::lightning_invoice::CreationError on failure.
5681 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5683 typedef struct LDKCResult_PrivateRouteCreationErrorZ {
5685 * The contents of this CResult_PrivateRouteCreationErrorZ, accessible via either
5686 * `err` or `result` depending on the state of `result_ok`.
5688 union LDKCResult_PrivateRouteCreationErrorZPtr contents;
5690 * Whether this CResult_PrivateRouteCreationErrorZ represents a success state.
5693 } LDKCResult_PrivateRouteCreationErrorZ;
5696 * The contents of CResult_StringErrorZ
5698 typedef union LDKCResult_StringErrorZPtr {
5700 * A pointer to the contents in the success state.
5701 * Reading from this pointer when `result_ok` is not set is undefined.
5703 struct LDKStr *result;
5705 * A pointer to the contents in the error state.
5706 * Reading from this pointer when `result_ok` is set is undefined.
5708 enum LDKSecp256k1Error *err;
5709 } LDKCResult_StringErrorZPtr;
5712 * A CResult_StringErrorZ represents the result of a fallible operation,
5713 * containing a crate::c_types::Str on success and a crate::c_types::Secp256k1Error on failure.
5714 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5716 typedef struct LDKCResult_StringErrorZ {
5718 * The contents of this CResult_StringErrorZ, accessible via either
5719 * `err` or `result` depending on the state of `result_ok`.
5721 union LDKCResult_StringErrorZPtr contents;
5723 * Whether this CResult_StringErrorZ represents a success state.
5726 } LDKCResult_StringErrorZ;
5729 * The contents of CResult_ChannelMonitorUpdateDecodeErrorZ
5731 typedef union LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr {
5733 * A pointer to the contents in the success state.
5734 * Reading from this pointer when `result_ok` is not set is undefined.
5736 struct LDKChannelMonitorUpdate *result;
5738 * A pointer to the contents in the error state.
5739 * Reading from this pointer when `result_ok` is set is undefined.
5741 struct LDKDecodeError *err;
5742 } LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr;
5745 * A CResult_ChannelMonitorUpdateDecodeErrorZ represents the result of a fallible operation,
5746 * containing a crate::lightning::chain::channelmonitor::ChannelMonitorUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
5747 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5749 typedef struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ {
5751 * The contents of this CResult_ChannelMonitorUpdateDecodeErrorZ, accessible via either
5752 * `err` or `result` depending on the state of `result_ok`.
5754 union LDKCResult_ChannelMonitorUpdateDecodeErrorZPtr contents;
5756 * Whether this CResult_ChannelMonitorUpdateDecodeErrorZ represents a success state.
5759 } LDKCResult_ChannelMonitorUpdateDecodeErrorZ;
5762 * The contents of CResult_HTLCUpdateDecodeErrorZ
5764 typedef union LDKCResult_HTLCUpdateDecodeErrorZPtr {
5766 * A pointer to the contents in the success state.
5767 * Reading from this pointer when `result_ok` is not set is undefined.
5769 struct LDKHTLCUpdate *result;
5771 * A pointer to the contents in the error state.
5772 * Reading from this pointer when `result_ok` is set is undefined.
5774 struct LDKDecodeError *err;
5775 } LDKCResult_HTLCUpdateDecodeErrorZPtr;
5778 * A CResult_HTLCUpdateDecodeErrorZ represents the result of a fallible operation,
5779 * containing a crate::lightning::chain::channelmonitor::HTLCUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
5780 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5782 typedef struct LDKCResult_HTLCUpdateDecodeErrorZ {
5784 * The contents of this CResult_HTLCUpdateDecodeErrorZ, accessible via either
5785 * `err` or `result` depending on the state of `result_ok`.
5787 union LDKCResult_HTLCUpdateDecodeErrorZPtr contents;
5789 * Whether this CResult_HTLCUpdateDecodeErrorZ represents a success state.
5792 } LDKCResult_HTLCUpdateDecodeErrorZ;
5797 * General Err type for ChannelMonitor actions. Generally, this implies that the data provided is
5798 * inconsistent with the ChannelMonitor being called. eg for ChannelMonitor::update_monitor this
5799 * means you tried to update a monitor for a different channel or the ChannelMonitorUpdate was
5801 * Contains a developer-readable error message.
5803 typedef struct MUST_USE_STRUCT LDKMonitorUpdateError {
5805 * A pointer to the opaque Rust object.
5806 * Nearly everywhere, inner must be non-null, however in places where
5807 * the Rust equivalent takes an Option, it may be set to null to indicate None.
5809 LDKnativeMonitorUpdateError *inner;
5811 * Indicates that this is the only struct which contains the same pointer.
5812 * Rust functions which take ownership of an object provided via an argument require
5813 * this to be true and invalidate the object pointed to by inner.
5816 } LDKMonitorUpdateError;
5819 * The contents of CResult_NoneMonitorUpdateErrorZ
5821 typedef union LDKCResult_NoneMonitorUpdateErrorZPtr {
5823 * Note that this value is always NULL, as there are no contents in the OK variant
5827 * A pointer to the contents in the error state.
5828 * Reading from this pointer when `result_ok` is set is undefined.
5830 struct LDKMonitorUpdateError *err;
5831 } LDKCResult_NoneMonitorUpdateErrorZPtr;
5834 * A CResult_NoneMonitorUpdateErrorZ represents the result of a fallible operation,
5835 * containing a () on success and a crate::lightning::chain::channelmonitor::MonitorUpdateError on failure.
5836 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
5838 typedef struct LDKCResult_NoneMonitorUpdateErrorZ {
5840 * The contents of this CResult_NoneMonitorUpdateErrorZ, accessible via either
5841 * `err` or `result` depending on the state of `result_ok`.
5843 union LDKCResult_NoneMonitorUpdateErrorZPtr contents;
5845 * Whether this CResult_NoneMonitorUpdateErrorZ represents a success state.
5848 } LDKCResult_NoneMonitorUpdateErrorZ;
5851 * A tuple of 2 elements. See the individual fields for the types contained.
5853 typedef struct LDKC2Tuple_OutPointScriptZ {
5855 * The element at position 0
5857 struct LDKOutPoint a;
5859 * The element at position 1
5861 struct LDKCVec_u8Z b;
5862 } LDKC2Tuple_OutPointScriptZ;
5865 * A tuple of 2 elements. See the individual fields for the types contained.
5867 typedef struct LDKC2Tuple_u32ScriptZ {
5869 * The element at position 0
5873 * The element at position 1
5875 struct LDKCVec_u8Z b;
5876 } LDKC2Tuple_u32ScriptZ;
5879 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_u32ScriptZs of arbitrary size.
5880 * This corresponds to std::vector in C++
5882 typedef struct LDKCVec_C2Tuple_u32ScriptZZ {
5884 * The elements in the array.
5885 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5887 struct LDKC2Tuple_u32ScriptZ *data;
5889 * The number of elements pointed to by `data`.
5892 } LDKCVec_C2Tuple_u32ScriptZZ;
5895 * A tuple of 2 elements. See the individual fields for the types contained.
5897 typedef struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ {
5899 * The element at position 0
5901 struct LDKThirtyTwoBytes a;
5903 * The element at position 1
5905 struct LDKCVec_C2Tuple_u32ScriptZZ b;
5906 } LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ;
5909 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZs of arbitrary size.
5910 * This corresponds to std::vector in C++
5912 typedef struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ {
5914 * The elements in the array.
5915 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
5917 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ *data;
5919 * The number of elements pointed to by `data`.
5922 } LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ;
5925 * Some information provided on receipt of payment depends on whether the payment received is a
5926 * spontaneous payment or a \"conventional\" lightning payment that's paying an invoice.
5928 typedef enum LDKPaymentPurpose_Tag {
5930 * Information for receiving a payment that we generated an invoice for.
5932 LDKPaymentPurpose_InvoicePayment,
5934 * Because this is a spontaneous payment, the payer generated their own preimage rather than us
5935 * (the payee) providing a preimage.
5937 LDKPaymentPurpose_SpontaneousPayment,
5939 * Must be last for serialization purposes
5941 LDKPaymentPurpose_Sentinel,
5942 } LDKPaymentPurpose_Tag;
5944 typedef struct LDKPaymentPurpose_LDKInvoicePayment_Body {
5946 * The preimage to the payment_hash, if the payment hash (and secret) were fetched via
5947 * [`ChannelManager::create_inbound_payment`]. If provided, this can be handed directly to
5948 * [`ChannelManager::claim_funds`].
5950 * [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
5951 * [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
5953 * Note that this (or a relevant inner pointer) may be NULL or all-0s to represent None
5955 struct LDKThirtyTwoBytes payment_preimage;
5957 * The \"payment secret\". This authenticates the sender to the recipient, preventing a
5958 * number of deanonymization attacks during the routing process.
5959 * It is provided here for your reference, however its accuracy is enforced directly by
5960 * [`ChannelManager`] using the values you previously provided to
5961 * [`ChannelManager::create_inbound_payment`] or
5962 * [`ChannelManager::create_inbound_payment_for_hash`].
5964 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
5965 * [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
5966 * [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
5968 struct LDKThirtyTwoBytes payment_secret;
5970 * This is the `user_payment_id` which was provided to
5971 * [`ChannelManager::create_inbound_payment_for_hash`] or
5972 * [`ChannelManager::create_inbound_payment`]. It has no meaning inside of LDK and is
5973 * simply copied here. It may be used to correlate PaymentReceived events with invoice
5974 * metadata stored elsewhere.
5976 * [`ChannelManager::create_inbound_payment`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment
5977 * [`ChannelManager::create_inbound_payment_for_hash`]: crate::ln::channelmanager::ChannelManager::create_inbound_payment_for_hash
5979 uint64_t user_payment_id;
5980 } LDKPaymentPurpose_LDKInvoicePayment_Body;
5982 typedef struct MUST_USE_STRUCT LDKPaymentPurpose {
5983 LDKPaymentPurpose_Tag tag;
5985 LDKPaymentPurpose_LDKInvoicePayment_Body invoice_payment;
5987 struct LDKThirtyTwoBytes spontaneous_payment;
5990 } LDKPaymentPurpose;
5993 * The reason the channel was closed. See individual variants more details.
5995 typedef enum LDKClosureReason_Tag {
5997 * Closure generated from receiving a peer error message.
5999 * Our counterparty may have broadcasted their latest commitment state, and we have
6002 LDKClosureReason_CounterpartyForceClosed,
6004 * Closure generated from [`ChannelManager::force_close_channel`], called by the user.
6006 * [`ChannelManager::force_close_channel`]: crate::ln::channelmanager::ChannelManager::force_close_channel.
6008 LDKClosureReason_HolderForceClosed,
6010 * The channel was closed after negotiating a cooperative close and we've now broadcasted
6011 * the cooperative close transaction. Note the shutdown may have been initiated by us.
6013 LDKClosureReason_CooperativeClosure,
6015 * A commitment transaction was confirmed on chain, closing the channel. Most likely this
6016 * commitment transaction came from our counterparty, but it may also have come from
6017 * a copy of our own `ChannelMonitor`.
6019 LDKClosureReason_CommitmentTxConfirmed,
6021 * Closure generated from processing an event, likely a HTLC forward/relay/reception.
6023 LDKClosureReason_ProcessingError,
6025 * The `PeerManager` informed us that we've disconnected from the peer. We close channels
6026 * if the `PeerManager` informed us that it is unlikely we'll be able to connect to the
6027 * peer again in the future or if the peer disconnected before we finished negotiating
6028 * the channel open. The first case may be caused by incompatible features which our
6029 * counterparty, or we, require.
6031 LDKClosureReason_DisconnectedPeer,
6033 * Closure generated from `ChannelManager::read` if the ChannelMonitor is newer than
6034 * the ChannelManager deserialized.
6036 LDKClosureReason_OutdatedChannelManager,
6038 * Must be last for serialization purposes
6040 LDKClosureReason_Sentinel,
6041 } LDKClosureReason_Tag;
6043 typedef struct LDKClosureReason_LDKCounterpartyForceClosed_Body {
6045 * The error which the peer sent us.
6047 * The string should be sanitized before it is used (e.g emitted to logs
6048 * or printed to stdout). Otherwise, a well crafted error message may exploit
6049 * a security vulnerability in the terminal emulator or the logging subsystem.
6051 struct LDKStr peer_msg;
6052 } LDKClosureReason_LDKCounterpartyForceClosed_Body;
6054 typedef struct LDKClosureReason_LDKProcessingError_Body {
6056 * A developer-readable error message which we generated.
6059 } LDKClosureReason_LDKProcessingError_Body;
6061 typedef struct MUST_USE_STRUCT LDKClosureReason {
6062 LDKClosureReason_Tag tag;
6064 LDKClosureReason_LDKCounterpartyForceClosed_Body counterparty_force_closed;
6065 LDKClosureReason_LDKProcessingError_Body processing_error;
6070 * An Event which you should probably take some action in response to.
6072 * Note that while Writeable and Readable are implemented for Event, you probably shouldn't use
6073 * them directly as they don't round-trip exactly (for example FundingGenerationReady is never
6074 * written as it makes no sense to respond to it after reconnecting to peers).
6076 typedef enum LDKEvent_Tag {
6078 * Used to indicate that the client should generate a funding transaction with the given
6079 * parameters and then call ChannelManager::funding_transaction_generated.
6080 * Generated in ChannelManager message handling.
6081 * Note that *all inputs* in the funding transaction must spend SegWit outputs or your
6082 * counterparty can steal your funds!
6084 LDKEvent_FundingGenerationReady,
6086 * Indicates we've received money! Just gotta dig out that payment preimage and feed it to
6087 * [`ChannelManager::claim_funds`] to get it....
6088 * Note that if the preimage is not known, you should call
6089 * [`ChannelManager::fail_htlc_backwards`] to free up resources for this HTLC and avoid
6090 * network congestion.
6091 * If you fail to call either [`ChannelManager::claim_funds`] or
6092 * [`ChannelManager::fail_htlc_backwards`] within the HTLC's timeout, the HTLC will be
6093 * automatically failed.
6095 * [`ChannelManager::claim_funds`]: crate::ln::channelmanager::ChannelManager::claim_funds
6096 * [`ChannelManager::fail_htlc_backwards`]: crate::ln::channelmanager::ChannelManager::fail_htlc_backwards
6098 LDKEvent_PaymentReceived,
6100 * Indicates an outbound payment we made succeeded (i.e. it made it all the way to its target
6101 * and we got back the payment preimage for it).
6103 * Note for MPP payments: in rare cases, this event may be preceded by a `PaymentPathFailed`
6104 * event. In this situation, you SHOULD treat this payment as having succeeded.
6106 LDKEvent_PaymentSent,
6108 * Indicates an outbound payment we made failed. Probably some intermediary node dropped
6109 * something. You may wish to retry with a different route.
6111 LDKEvent_PaymentPathFailed,
6113 * Used to indicate that ChannelManager::process_pending_htlc_forwards should be called at a
6114 * time in the future.
6116 LDKEvent_PendingHTLCsForwardable,
6118 * Used to indicate that an output which you should know how to spend was confirmed on chain
6119 * and is now spendable.
6120 * Such an output will *not* ever be spent by rust-lightning, and are not at risk of your
6121 * counterparty spending them due to some kind of timeout. Thus, you need to store them
6122 * somewhere and spend them when you create on-chain transactions.
6124 LDKEvent_SpendableOutputs,
6126 * This event is generated when a payment has been successfully forwarded through us and a
6127 * forwarding fee earned.
6129 LDKEvent_PaymentForwarded,
6131 * Used to indicate that a channel with the given `channel_id` is in the process of closure.
6133 LDKEvent_ChannelClosed,
6135 * Used to indicate to the user that they can abandon the funding transaction and recycle the
6136 * inputs for another purpose.
6138 LDKEvent_DiscardFunding,
6140 * Must be last for serialization purposes
6145 typedef struct LDKEvent_LDKFundingGenerationReady_Body {
6147 * The random channel_id we picked which you'll need to pass into
6148 * ChannelManager::funding_transaction_generated.
6150 struct LDKThirtyTwoBytes temporary_channel_id;
6152 * The value, in satoshis, that the output should have.
6154 uint64_t channel_value_satoshis;
6156 * The script which should be used in the transaction output.
6158 struct LDKCVec_u8Z output_script;
6160 * The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
6161 * an inbound channel.
6163 * [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
6165 uint64_t user_channel_id;
6166 } LDKEvent_LDKFundingGenerationReady_Body;
6168 typedef struct LDKEvent_LDKPaymentReceived_Body {
6170 * The hash for which the preimage should be handed to the ChannelManager.
6172 struct LDKThirtyTwoBytes payment_hash;
6174 * The value, in thousandths of a satoshi, that this payment is for.
6178 * Information for claiming this received payment, based on whether the purpose of the
6179 * payment is to pay an invoice or to send a spontaneous payment.
6181 struct LDKPaymentPurpose purpose;
6182 } LDKEvent_LDKPaymentReceived_Body;
6184 typedef struct LDKEvent_LDKPaymentSent_Body {
6186 * The preimage to the hash given to ChannelManager::send_payment.
6187 * Note that this serves as a payment receipt, if you wish to have such a thing, you must
6190 struct LDKThirtyTwoBytes payment_preimage;
6192 * The hash which was given to [`ChannelManager::send_payment`].
6194 * [`ChannelManager::send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
6196 struct LDKThirtyTwoBytes payment_hash;
6197 } LDKEvent_LDKPaymentSent_Body;
6199 typedef struct LDKEvent_LDKPaymentPathFailed_Body {
6201 * The hash which was given to ChannelManager::send_payment.
6203 struct LDKThirtyTwoBytes payment_hash;
6205 * Indicates the payment was rejected for some reason by the recipient. This implies that
6206 * the payment has failed, not just the route in question. If this is not set, you may
6207 * retry the payment via a different route.
6209 bool rejected_by_dest;
6211 * Any failure information conveyed via the Onion return packet by a node along the failed
6214 * Should be applied to the [`NetworkGraph`] so that routing decisions can take into
6215 * account the update. [`NetGraphMsgHandler`] is capable of doing this.
6217 * [`NetworkGraph`]: crate::routing::network_graph::NetworkGraph
6218 * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
6220 struct LDKCOption_NetworkUpdateZ network_update;
6222 * For both single-path and multi-path payments, this is set if all paths of the payment have
6223 * failed. This will be set to false if (1) this is an MPP payment and (2) other parts of the
6224 * larger MPP payment were still in flight when this event was generated.
6226 bool all_paths_failed;
6228 * The payment path that failed.
6230 struct LDKCVec_RouteHopZ path;
6232 * The channel responsible for the failed payment path.
6234 * If this is `Some`, then the corresponding channel should be avoided when the payment is
6235 * retried. May be `None` for older [`Event`] serializations.
6237 struct LDKCOption_u64Z short_channel_id;
6238 } LDKEvent_LDKPaymentPathFailed_Body;
6240 typedef struct LDKEvent_LDKPendingHTLCsForwardable_Body {
6242 * The minimum amount of time that should be waited prior to calling
6243 * process_pending_htlc_forwards. To increase the effort required to correlate payments,
6244 * you should wait a random amount of time in roughly the range (now + time_forwardable,
6245 * now + 5*time_forwardable).
6247 uint64_t time_forwardable;
6248 } LDKEvent_LDKPendingHTLCsForwardable_Body;
6250 typedef struct LDKEvent_LDKSpendableOutputs_Body {
6252 * The outputs which you should store as spendable by you.
6254 struct LDKCVec_SpendableOutputDescriptorZ outputs;
6255 } LDKEvent_LDKSpendableOutputs_Body;
6257 typedef struct LDKEvent_LDKPaymentForwarded_Body {
6259 * The fee, in milli-satoshis, which was earned as a result of the payment.
6261 * Note that if we force-closed the channel over which we forwarded an HTLC while the HTLC
6262 * was pending, the amount the next hop claimed will have been rounded down to the nearest
6263 * whole satoshi. Thus, the fee calculated here may be higher than expected as we still
6264 * claimed the full value in millisatoshis from the source. In this case,
6265 * `claim_from_onchain_tx` will be set.
6267 * If the channel which sent us the payment has been force-closed, we will claim the funds
6268 * via an on-chain transaction. In that case we do not yet know the on-chain transaction
6269 * fees which we will spend and will instead set this to `None`. It is possible duplicate
6270 * `PaymentForwarded` events are generated for the same payment iff `fee_earned_msat` is
6273 struct LDKCOption_u64Z fee_earned_msat;
6275 * If this is `true`, the forwarded HTLC was claimed by our counterparty via an on-chain
6278 bool claim_from_onchain_tx;
6279 } LDKEvent_LDKPaymentForwarded_Body;
6281 typedef struct LDKEvent_LDKChannelClosed_Body {
6283 * The channel_id of the channel which has been closed. Note that on-chain transactions
6284 * resolving the channel are likely still awaiting confirmation.
6286 struct LDKThirtyTwoBytes channel_id;
6288 * The `user_channel_id` value passed in to [`ChannelManager::create_channel`], or 0 for
6289 * an inbound channel. This will always be zero for objects serialized with LDK versions
6292 * [`ChannelManager::create_channel`]: crate::ln::channelmanager::ChannelManager::create_channel
6294 uint64_t user_channel_id;
6296 * The reason the channel was closed.
6298 struct LDKClosureReason reason;
6299 } LDKEvent_LDKChannelClosed_Body;
6301 typedef struct LDKEvent_LDKDiscardFunding_Body {
6303 * The channel_id of the channel which has been closed.
6305 struct LDKThirtyTwoBytes channel_id;
6307 * The full transaction received from the user
6309 struct LDKTransaction transaction;
6310 } LDKEvent_LDKDiscardFunding_Body;
6312 typedef struct MUST_USE_STRUCT LDKEvent {
6315 LDKEvent_LDKFundingGenerationReady_Body funding_generation_ready;
6316 LDKEvent_LDKPaymentReceived_Body payment_received;
6317 LDKEvent_LDKPaymentSent_Body payment_sent;
6318 LDKEvent_LDKPaymentPathFailed_Body payment_path_failed;
6319 LDKEvent_LDKPendingHTLCsForwardable_Body pending_htl_cs_forwardable;
6320 LDKEvent_LDKSpendableOutputs_Body spendable_outputs;
6321 LDKEvent_LDKPaymentForwarded_Body payment_forwarded;
6322 LDKEvent_LDKChannelClosed_Body channel_closed;
6323 LDKEvent_LDKDiscardFunding_Body discard_funding;
6328 * A dynamically-allocated array of crate::lightning::util::events::Events of arbitrary size.
6329 * This corresponds to std::vector in C++
6331 typedef struct LDKCVec_EventZ {
6333 * The elements in the array.
6334 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6336 struct LDKEvent *data;
6338 * The number of elements pointed to by `data`.
6344 * A dynamically-allocated array of crate::c_types::Transactions of arbitrary size.
6345 * This corresponds to std::vector in C++
6347 typedef struct LDKCVec_TransactionZ {
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 LDKTransaction *data;
6354 * The number of elements pointed to by `data`.
6357 } LDKCVec_TransactionZ;
6360 * A tuple of 2 elements. See the individual fields for the types contained.
6362 typedef struct LDKC2Tuple_u32TxOutZ {
6364 * The element at position 0
6368 * The element at position 1
6371 } LDKC2Tuple_u32TxOutZ;
6374 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_u32TxOutZs of arbitrary size.
6375 * This corresponds to std::vector in C++
6377 typedef struct LDKCVec_C2Tuple_u32TxOutZZ {
6379 * The elements in the array.
6380 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6382 struct LDKC2Tuple_u32TxOutZ *data;
6384 * The number of elements pointed to by `data`.
6387 } LDKCVec_C2Tuple_u32TxOutZZ;
6390 * A tuple of 2 elements. See the individual fields for the types contained.
6392 typedef struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ {
6394 * The element at position 0
6396 struct LDKThirtyTwoBytes a;
6398 * The element at position 1
6400 struct LDKCVec_C2Tuple_u32TxOutZZ b;
6401 } LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ;
6404 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZs of arbitrary size.
6405 * This corresponds to std::vector in C++
6407 typedef struct LDKCVec_TransactionOutputsZ {
6409 * The elements in the array.
6410 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6412 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ *data;
6414 * The number of elements pointed to by `data`.
6417 } LDKCVec_TransactionOutputsZ;
6420 * Details about the balance(s) available for spending once the channel appears on chain.
6422 * See [`ChannelMonitor::get_claimable_balances`] for more details on when these will or will not
6425 typedef enum LDKBalance_Tag {
6427 * The channel is not yet closed (or the commitment or closing transaction has not yet
6428 * appeared in a block). The given balance is claimable (less on-chain fees) if the channel is
6431 LDKBalance_ClaimableOnChannelClose,
6433 * The channel has been closed, and the given balance is ours but awaiting confirmations until
6434 * we consider it spendable.
6436 LDKBalance_ClaimableAwaitingConfirmations,
6438 * The channel has been closed, and the given balance should be ours but awaiting spending
6439 * transaction confirmation. If the spending transaction does not confirm in time, it is
6440 * possible our counterparty can take the funds by broadcasting an HTLC timeout on-chain.
6442 * Once the spending transaction confirms, before it has reached enough confirmations to be
6443 * considered safe from chain reorganizations, the balance will instead be provided via
6444 * [`Balance::ClaimableAwaitingConfirmations`].
6446 LDKBalance_ContentiousClaimable,
6448 * HTLCs which we sent to our counterparty which are claimable after a timeout (less on-chain
6449 * fees) if the counterparty does not know the preimage for the HTLCs. These are somewhat
6450 * likely to be claimed by our counterparty before we do.
6452 LDKBalance_MaybeClaimableHTLCAwaitingTimeout,
6454 * Must be last for serialization purposes
6456 LDKBalance_Sentinel,
6459 typedef struct LDKBalance_LDKClaimableOnChannelClose_Body {
6461 * The amount available to claim, in satoshis, excluding the on-chain fees which will be
6462 * required to do so.
6464 uint64_t claimable_amount_satoshis;
6465 } LDKBalance_LDKClaimableOnChannelClose_Body;
6467 typedef struct LDKBalance_LDKClaimableAwaitingConfirmations_Body {
6469 * The amount available to claim, in satoshis, possibly excluding the on-chain fees which
6470 * were spent in broadcasting the transaction.
6472 uint64_t claimable_amount_satoshis;
6474 * The height at which an [`Event::SpendableOutputs`] event will be generated for this
6477 uint32_t confirmation_height;
6478 } LDKBalance_LDKClaimableAwaitingConfirmations_Body;
6480 typedef struct LDKBalance_LDKContentiousClaimable_Body {
6482 * The amount available to claim, in satoshis, excluding the on-chain fees which will be
6483 * required to do so.
6485 uint64_t claimable_amount_satoshis;
6487 * The height at which the counterparty may be able to claim the balance if we have not
6490 uint32_t timeout_height;
6491 } LDKBalance_LDKContentiousClaimable_Body;
6493 typedef struct LDKBalance_LDKMaybeClaimableHTLCAwaitingTimeout_Body {
6495 * The amount available to claim, in satoshis, excluding the on-chain fees which will be
6496 * required to do so.
6498 uint64_t claimable_amount_satoshis;
6500 * The height at which we will be able to claim the balance if our counterparty has not
6503 uint32_t claimable_height;
6504 } LDKBalance_LDKMaybeClaimableHTLCAwaitingTimeout_Body;
6506 typedef struct MUST_USE_STRUCT LDKBalance {
6509 LDKBalance_LDKClaimableOnChannelClose_Body claimable_on_channel_close;
6510 LDKBalance_LDKClaimableAwaitingConfirmations_Body claimable_awaiting_confirmations;
6511 LDKBalance_LDKContentiousClaimable_Body contentious_claimable;
6512 LDKBalance_LDKMaybeClaimableHTLCAwaitingTimeout_Body maybe_claimable_htlc_awaiting_timeout;
6517 * A dynamically-allocated array of crate::lightning::chain::channelmonitor::Balances of arbitrary size.
6518 * This corresponds to std::vector in C++
6520 typedef struct LDKCVec_BalanceZ {
6522 * The elements in the array.
6523 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6525 struct LDKBalance *data;
6527 * The number of elements pointed to by `data`.
6533 * The contents of CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ
6535 typedef union LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr {
6537 * A pointer to the contents in the success state.
6538 * Reading from this pointer when `result_ok` is not set is undefined.
6540 struct LDKC2Tuple_BlockHashChannelMonitorZ *result;
6542 * A pointer to the contents in the error state.
6543 * Reading from this pointer when `result_ok` is set is undefined.
6545 struct LDKDecodeError *err;
6546 } LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr;
6549 * A CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ represents the result of a fallible operation,
6550 * containing a crate::c_types::derived::C2Tuple_BlockHashChannelMonitorZ on success and a crate::lightning::ln::msgs::DecodeError on failure.
6551 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6553 typedef struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ {
6555 * The contents of this CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ, accessible via either
6556 * `err` or `result` depending on the state of `result_ok`.
6558 union LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZPtr contents;
6560 * Whether this CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ represents a success state.
6563 } LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ;
6566 * The contents of CResult_NoneLightningErrorZ
6568 typedef union LDKCResult_NoneLightningErrorZPtr {
6570 * Note that this value is always NULL, as there are no contents in the OK variant
6574 * A pointer to the contents in the error state.
6575 * Reading from this pointer when `result_ok` is set is undefined.
6577 struct LDKLightningError *err;
6578 } LDKCResult_NoneLightningErrorZPtr;
6581 * A CResult_NoneLightningErrorZ represents the result of a fallible operation,
6582 * containing a () on success and a crate::lightning::ln::msgs::LightningError on failure.
6583 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6585 typedef struct LDKCResult_NoneLightningErrorZ {
6587 * The contents of this CResult_NoneLightningErrorZ, accessible via either
6588 * `err` or `result` depending on the state of `result_ok`.
6590 union LDKCResult_NoneLightningErrorZPtr contents;
6592 * Whether this CResult_NoneLightningErrorZ represents a success state.
6595 } LDKCResult_NoneLightningErrorZ;
6598 * A tuple of 2 elements. See the individual fields for the types contained.
6600 typedef struct LDKC2Tuple_PublicKeyTypeZ {
6602 * The element at position 0
6604 struct LDKPublicKey a;
6606 * The element at position 1
6609 } LDKC2Tuple_PublicKeyTypeZ;
6612 * A dynamically-allocated array of crate::c_types::derived::C2Tuple_PublicKeyTypeZs of arbitrary size.
6613 * This corresponds to std::vector in C++
6615 typedef struct LDKCVec_C2Tuple_PublicKeyTypeZZ {
6617 * The elements in the array.
6618 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6620 struct LDKC2Tuple_PublicKeyTypeZ *data;
6622 * The number of elements pointed to by `data`.
6625 } LDKCVec_C2Tuple_PublicKeyTypeZZ;
6628 * The contents of CResult_boolLightningErrorZ
6630 typedef union LDKCResult_boolLightningErrorZPtr {
6632 * A pointer to the contents in the success state.
6633 * Reading from this pointer when `result_ok` is not set is undefined.
6637 * A pointer to the contents in the error state.
6638 * Reading from this pointer when `result_ok` is set is undefined.
6640 struct LDKLightningError *err;
6641 } LDKCResult_boolLightningErrorZPtr;
6644 * A CResult_boolLightningErrorZ represents the result of a fallible operation,
6645 * containing a bool on success and a crate::lightning::ln::msgs::LightningError on failure.
6646 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6648 typedef struct LDKCResult_boolLightningErrorZ {
6650 * The contents of this CResult_boolLightningErrorZ, accessible via either
6651 * `err` or `result` depending on the state of `result_ok`.
6653 union LDKCResult_boolLightningErrorZPtr contents;
6655 * Whether this CResult_boolLightningErrorZ represents a success state.
6658 } LDKCResult_boolLightningErrorZ;
6661 * A tuple of 3 elements. See the individual fields for the types contained.
6663 typedef struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ {
6665 * The element at position 0
6667 struct LDKChannelAnnouncement a;
6669 * The element at position 1
6671 struct LDKChannelUpdate b;
6673 * The element at position 2
6675 struct LDKChannelUpdate c;
6676 } LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ;
6679 * A dynamically-allocated array of crate::c_types::derived::C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZs of arbitrary size.
6680 * This corresponds to std::vector in C++
6682 typedef struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ {
6684 * The elements in the array.
6685 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6687 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ *data;
6689 * The number of elements pointed to by `data`.
6692 } LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ;
6695 * A dynamically-allocated array of crate::lightning::ln::msgs::NodeAnnouncements of arbitrary size.
6696 * This corresponds to std::vector in C++
6698 typedef struct LDKCVec_NodeAnnouncementZ {
6700 * The elements in the array.
6701 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6703 struct LDKNodeAnnouncement *data;
6705 * The number of elements pointed to by `data`.
6708 } LDKCVec_NodeAnnouncementZ;
6711 * A dynamically-allocated array of crate::c_types::PublicKeys of arbitrary size.
6712 * This corresponds to std::vector in C++
6714 typedef struct LDKCVec_PublicKeyZ {
6716 * The elements in the array.
6717 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
6719 struct LDKPublicKey *data;
6721 * The number of elements pointed to by `data`.
6724 } LDKCVec_PublicKeyZ;
6729 * Error for PeerManager errors. If you get one of these, you must disconnect the socket and
6730 * generate no further read_event/write_buffer_space_avail/socket_disconnected calls for the
6733 typedef struct MUST_USE_STRUCT LDKPeerHandleError {
6735 * A pointer to the opaque Rust object.
6736 * Nearly everywhere, inner must be non-null, however in places where
6737 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6739 LDKnativePeerHandleError *inner;
6741 * Indicates that this is the only struct which contains the same pointer.
6742 * Rust functions which take ownership of an object provided via an argument require
6743 * this to be true and invalidate the object pointed to by inner.
6746 } LDKPeerHandleError;
6749 * The contents of CResult_CVec_u8ZPeerHandleErrorZ
6751 typedef union LDKCResult_CVec_u8ZPeerHandleErrorZPtr {
6753 * A pointer to the contents in the success state.
6754 * Reading from this pointer when `result_ok` is not set is undefined.
6756 struct LDKCVec_u8Z *result;
6758 * A pointer to the contents in the error state.
6759 * Reading from this pointer when `result_ok` is set is undefined.
6761 struct LDKPeerHandleError *err;
6762 } LDKCResult_CVec_u8ZPeerHandleErrorZPtr;
6765 * A CResult_CVec_u8ZPeerHandleErrorZ represents the result of a fallible operation,
6766 * containing a crate::c_types::derived::CVec_u8Z on success and a crate::lightning::ln::peer_handler::PeerHandleError on failure.
6767 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6769 typedef struct LDKCResult_CVec_u8ZPeerHandleErrorZ {
6771 * The contents of this CResult_CVec_u8ZPeerHandleErrorZ, accessible via either
6772 * `err` or `result` depending on the state of `result_ok`.
6774 union LDKCResult_CVec_u8ZPeerHandleErrorZPtr contents;
6776 * Whether this CResult_CVec_u8ZPeerHandleErrorZ represents a success state.
6779 } LDKCResult_CVec_u8ZPeerHandleErrorZ;
6782 * The contents of CResult_NonePeerHandleErrorZ
6784 typedef union LDKCResult_NonePeerHandleErrorZPtr {
6786 * Note that this value is always NULL, as there are no contents in the OK variant
6790 * A pointer to the contents in the error state.
6791 * Reading from this pointer when `result_ok` is set is undefined.
6793 struct LDKPeerHandleError *err;
6794 } LDKCResult_NonePeerHandleErrorZPtr;
6797 * A CResult_NonePeerHandleErrorZ represents the result of a fallible operation,
6798 * containing a () on success and a crate::lightning::ln::peer_handler::PeerHandleError on failure.
6799 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6801 typedef struct LDKCResult_NonePeerHandleErrorZ {
6803 * The contents of this CResult_NonePeerHandleErrorZ, accessible via either
6804 * `err` or `result` depending on the state of `result_ok`.
6806 union LDKCResult_NonePeerHandleErrorZPtr contents;
6808 * Whether this CResult_NonePeerHandleErrorZ represents a success state.
6811 } LDKCResult_NonePeerHandleErrorZ;
6814 * The contents of CResult_boolPeerHandleErrorZ
6816 typedef union LDKCResult_boolPeerHandleErrorZPtr {
6818 * A pointer to the contents in the success state.
6819 * Reading from this pointer when `result_ok` is not set is undefined.
6823 * A pointer to the contents in the error state.
6824 * Reading from this pointer when `result_ok` is set is undefined.
6826 struct LDKPeerHandleError *err;
6827 } LDKCResult_boolPeerHandleErrorZPtr;
6830 * A CResult_boolPeerHandleErrorZ represents the result of a fallible operation,
6831 * containing a bool on success and a crate::lightning::ln::peer_handler::PeerHandleError on failure.
6832 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6834 typedef struct LDKCResult_boolPeerHandleErrorZ {
6836 * The contents of this CResult_boolPeerHandleErrorZ, accessible via either
6837 * `err` or `result` depending on the state of `result_ok`.
6839 union LDKCResult_boolPeerHandleErrorZPtr contents;
6841 * Whether this CResult_boolPeerHandleErrorZ represents a success state.
6844 } LDKCResult_boolPeerHandleErrorZ;
6849 * Represents the compressed public key of a node
6851 typedef struct MUST_USE_STRUCT LDKNodeId {
6853 * A pointer to the opaque Rust object.
6854 * Nearly everywhere, inner must be non-null, however in places where
6855 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6857 LDKnativeNodeId *inner;
6859 * Indicates that this is the only struct which contains the same pointer.
6860 * Rust functions which take ownership of an object provided via an argument require
6861 * this to be true and invalidate the object pointed to by inner.
6867 * The contents of CResult_NodeIdDecodeErrorZ
6869 typedef union LDKCResult_NodeIdDecodeErrorZPtr {
6871 * A pointer to the contents in the success state.
6872 * Reading from this pointer when `result_ok` is not set is undefined.
6874 struct LDKNodeId *result;
6876 * A pointer to the contents in the error state.
6877 * Reading from this pointer when `result_ok` is set is undefined.
6879 struct LDKDecodeError *err;
6880 } LDKCResult_NodeIdDecodeErrorZPtr;
6883 * A CResult_NodeIdDecodeErrorZ represents the result of a fallible operation,
6884 * containing a crate::lightning::routing::network_graph::NodeId on success and a crate::lightning::ln::msgs::DecodeError on failure.
6885 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6887 typedef struct LDKCResult_NodeIdDecodeErrorZ {
6889 * The contents of this CResult_NodeIdDecodeErrorZ, accessible via either
6890 * `err` or `result` depending on the state of `result_ok`.
6892 union LDKCResult_NodeIdDecodeErrorZPtr contents;
6894 * Whether this CResult_NodeIdDecodeErrorZ represents a success state.
6897 } LDKCResult_NodeIdDecodeErrorZ;
6900 * The `Access` trait defines behavior for accessing chain data and state, such as blocks and
6903 typedef struct LDKAccess {
6905 * An opaque pointer which is passed to your function implementations as an argument.
6906 * This has no meaning in the LDK, and can be NULL or any other value.
6910 * Returns the transaction output of a funding transaction encoded by [`short_channel_id`].
6911 * Returns an error if `genesis_hash` is for a different chain or if such a transaction output
6914 * [`short_channel_id`]: https://github.com/lightningnetwork/lightning-rfc/blob/master/07-routing-gossip.md#definition-of-short_channel_id
6916 struct LDKCResult_TxOutAccessErrorZ (*get_utxo)(const void *this_arg, const uint8_t (*genesis_hash)[32], uint64_t short_channel_id);
6918 * Frees any resources associated with this object given its this_arg pointer.
6919 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
6921 void (*free)(void *this_arg);
6925 * An enum which can either contain a crate::lightning::chain::Access or not
6927 typedef enum LDKCOption_AccessZ_Tag {
6929 * When we're in this state, this COption_AccessZ contains a crate::lightning::chain::Access
6931 LDKCOption_AccessZ_Some,
6933 * When we're in this state, this COption_AccessZ contains nothing
6935 LDKCOption_AccessZ_None,
6937 * Must be last for serialization purposes
6939 LDKCOption_AccessZ_Sentinel,
6940 } LDKCOption_AccessZ_Tag;
6942 typedef struct LDKCOption_AccessZ {
6943 LDKCOption_AccessZ_Tag tag;
6946 struct LDKAccess some;
6949 } LDKCOption_AccessZ;
6954 * Details about one direction of a channel. Received
6955 * within a channel update.
6957 typedef struct MUST_USE_STRUCT LDKDirectionalChannelInfo {
6959 * A pointer to the opaque Rust object.
6960 * Nearly everywhere, inner must be non-null, however in places where
6961 * the Rust equivalent takes an Option, it may be set to null to indicate None.
6963 LDKnativeDirectionalChannelInfo *inner;
6965 * Indicates that this is the only struct which contains the same pointer.
6966 * Rust functions which take ownership of an object provided via an argument require
6967 * this to be true and invalidate the object pointed to by inner.
6970 } LDKDirectionalChannelInfo;
6973 * The contents of CResult_DirectionalChannelInfoDecodeErrorZ
6975 typedef union LDKCResult_DirectionalChannelInfoDecodeErrorZPtr {
6977 * A pointer to the contents in the success state.
6978 * Reading from this pointer when `result_ok` is not set is undefined.
6980 struct LDKDirectionalChannelInfo *result;
6982 * A pointer to the contents in the error state.
6983 * Reading from this pointer when `result_ok` is set is undefined.
6985 struct LDKDecodeError *err;
6986 } LDKCResult_DirectionalChannelInfoDecodeErrorZPtr;
6989 * A CResult_DirectionalChannelInfoDecodeErrorZ represents the result of a fallible operation,
6990 * containing a crate::lightning::routing::network_graph::DirectionalChannelInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
6991 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
6993 typedef struct LDKCResult_DirectionalChannelInfoDecodeErrorZ {
6995 * The contents of this CResult_DirectionalChannelInfoDecodeErrorZ, accessible via either
6996 * `err` or `result` depending on the state of `result_ok`.
6998 union LDKCResult_DirectionalChannelInfoDecodeErrorZPtr contents;
7000 * Whether this CResult_DirectionalChannelInfoDecodeErrorZ represents a success state.
7003 } LDKCResult_DirectionalChannelInfoDecodeErrorZ;
7008 * Details about a channel (both directions).
7009 * Received within a channel announcement.
7011 typedef struct MUST_USE_STRUCT LDKChannelInfo {
7013 * A pointer to the opaque Rust object.
7014 * Nearly everywhere, inner must be non-null, however in places where
7015 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7017 LDKnativeChannelInfo *inner;
7019 * Indicates that this is the only struct which contains the same pointer.
7020 * Rust functions which take ownership of an object provided via an argument require
7021 * this to be true and invalidate the object pointed to by inner.
7027 * The contents of CResult_ChannelInfoDecodeErrorZ
7029 typedef union LDKCResult_ChannelInfoDecodeErrorZPtr {
7031 * A pointer to the contents in the success state.
7032 * Reading from this pointer when `result_ok` is not set is undefined.
7034 struct LDKChannelInfo *result;
7036 * A pointer to the contents in the error state.
7037 * Reading from this pointer when `result_ok` is set is undefined.
7039 struct LDKDecodeError *err;
7040 } LDKCResult_ChannelInfoDecodeErrorZPtr;
7043 * A CResult_ChannelInfoDecodeErrorZ represents the result of a fallible operation,
7044 * containing a crate::lightning::routing::network_graph::ChannelInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
7045 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7047 typedef struct LDKCResult_ChannelInfoDecodeErrorZ {
7049 * The contents of this CResult_ChannelInfoDecodeErrorZ, accessible via either
7050 * `err` or `result` depending on the state of `result_ok`.
7052 union LDKCResult_ChannelInfoDecodeErrorZPtr contents;
7054 * Whether this CResult_ChannelInfoDecodeErrorZ represents a success state.
7057 } LDKCResult_ChannelInfoDecodeErrorZ;
7062 * Fees for routing via a given channel or a node
7064 typedef struct MUST_USE_STRUCT LDKRoutingFees {
7066 * A pointer to the opaque Rust object.
7067 * Nearly everywhere, inner must be non-null, however in places where
7068 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7070 LDKnativeRoutingFees *inner;
7072 * Indicates that this is the only struct which contains the same pointer.
7073 * Rust functions which take ownership of an object provided via an argument require
7074 * this to be true and invalidate the object pointed to by inner.
7080 * The contents of CResult_RoutingFeesDecodeErrorZ
7082 typedef union LDKCResult_RoutingFeesDecodeErrorZPtr {
7084 * A pointer to the contents in the success state.
7085 * Reading from this pointer when `result_ok` is not set is undefined.
7087 struct LDKRoutingFees *result;
7089 * A pointer to the contents in the error state.
7090 * Reading from this pointer when `result_ok` is set is undefined.
7092 struct LDKDecodeError *err;
7093 } LDKCResult_RoutingFeesDecodeErrorZPtr;
7096 * A CResult_RoutingFeesDecodeErrorZ represents the result of a fallible operation,
7097 * containing a crate::lightning::routing::network_graph::RoutingFees on success and a crate::lightning::ln::msgs::DecodeError on failure.
7098 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7100 typedef struct LDKCResult_RoutingFeesDecodeErrorZ {
7102 * The contents of this CResult_RoutingFeesDecodeErrorZ, accessible via either
7103 * `err` or `result` depending on the state of `result_ok`.
7105 union LDKCResult_RoutingFeesDecodeErrorZPtr contents;
7107 * Whether this CResult_RoutingFeesDecodeErrorZ represents a success state.
7110 } LDKCResult_RoutingFeesDecodeErrorZ;
7115 * Information received in the latest node_announcement from this node.
7117 typedef struct MUST_USE_STRUCT LDKNodeAnnouncementInfo {
7119 * A pointer to the opaque Rust object.
7120 * Nearly everywhere, inner must be non-null, however in places where
7121 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7123 LDKnativeNodeAnnouncementInfo *inner;
7125 * Indicates that this is the only struct which contains the same pointer.
7126 * Rust functions which take ownership of an object provided via an argument require
7127 * this to be true and invalidate the object pointed to by inner.
7130 } LDKNodeAnnouncementInfo;
7133 * The contents of CResult_NodeAnnouncementInfoDecodeErrorZ
7135 typedef union LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr {
7137 * A pointer to the contents in the success state.
7138 * Reading from this pointer when `result_ok` is not set is undefined.
7140 struct LDKNodeAnnouncementInfo *result;
7142 * A pointer to the contents in the error state.
7143 * Reading from this pointer when `result_ok` is set is undefined.
7145 struct LDKDecodeError *err;
7146 } LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr;
7149 * A CResult_NodeAnnouncementInfoDecodeErrorZ represents the result of a fallible operation,
7150 * containing a crate::lightning::routing::network_graph::NodeAnnouncementInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
7151 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7153 typedef struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ {
7155 * The contents of this CResult_NodeAnnouncementInfoDecodeErrorZ, accessible via either
7156 * `err` or `result` depending on the state of `result_ok`.
7158 union LDKCResult_NodeAnnouncementInfoDecodeErrorZPtr contents;
7160 * Whether this CResult_NodeAnnouncementInfoDecodeErrorZ represents a success state.
7163 } LDKCResult_NodeAnnouncementInfoDecodeErrorZ;
7166 * A dynamically-allocated array of u64s of arbitrary size.
7167 * This corresponds to std::vector in C++
7169 typedef struct LDKCVec_u64Z {
7171 * The elements in the array.
7172 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7176 * The number of elements pointed to by `data`.
7184 * Details about a node in the network, known from the network announcement.
7186 typedef struct MUST_USE_STRUCT LDKNodeInfo {
7188 * A pointer to the opaque Rust object.
7189 * Nearly everywhere, inner must be non-null, however in places where
7190 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7192 LDKnativeNodeInfo *inner;
7194 * Indicates that this is the only struct which contains the same pointer.
7195 * Rust functions which take ownership of an object provided via an argument require
7196 * this to be true and invalidate the object pointed to by inner.
7202 * The contents of CResult_NodeInfoDecodeErrorZ
7204 typedef union LDKCResult_NodeInfoDecodeErrorZPtr {
7206 * A pointer to the contents in the success state.
7207 * Reading from this pointer when `result_ok` is not set is undefined.
7209 struct LDKNodeInfo *result;
7211 * A pointer to the contents in the error state.
7212 * Reading from this pointer when `result_ok` is set is undefined.
7214 struct LDKDecodeError *err;
7215 } LDKCResult_NodeInfoDecodeErrorZPtr;
7218 * A CResult_NodeInfoDecodeErrorZ represents the result of a fallible operation,
7219 * containing a crate::lightning::routing::network_graph::NodeInfo on success and a crate::lightning::ln::msgs::DecodeError on failure.
7220 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7222 typedef struct LDKCResult_NodeInfoDecodeErrorZ {
7224 * The contents of this CResult_NodeInfoDecodeErrorZ, accessible via either
7225 * `err` or `result` depending on the state of `result_ok`.
7227 union LDKCResult_NodeInfoDecodeErrorZPtr contents;
7229 * Whether this CResult_NodeInfoDecodeErrorZ represents a success state.
7232 } LDKCResult_NodeInfoDecodeErrorZ;
7237 * Represents the network as nodes and channels between them
7239 typedef struct MUST_USE_STRUCT LDKNetworkGraph {
7241 * A pointer to the opaque Rust object.
7242 * Nearly everywhere, inner must be non-null, however in places where
7243 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7245 LDKnativeNetworkGraph *inner;
7247 * Indicates that this is the only struct which contains the same pointer.
7248 * Rust functions which take ownership of an object provided via an argument require
7249 * this to be true and invalidate the object pointed to by inner.
7255 * The contents of CResult_NetworkGraphDecodeErrorZ
7257 typedef union LDKCResult_NetworkGraphDecodeErrorZPtr {
7259 * A pointer to the contents in the success state.
7260 * Reading from this pointer when `result_ok` is not set is undefined.
7262 struct LDKNetworkGraph *result;
7264 * A pointer to the contents in the error state.
7265 * Reading from this pointer when `result_ok` is set is undefined.
7267 struct LDKDecodeError *err;
7268 } LDKCResult_NetworkGraphDecodeErrorZPtr;
7271 * A CResult_NetworkGraphDecodeErrorZ represents the result of a fallible operation,
7272 * containing a crate::lightning::routing::network_graph::NetworkGraph on success and a crate::lightning::ln::msgs::DecodeError on failure.
7273 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7275 typedef struct LDKCResult_NetworkGraphDecodeErrorZ {
7277 * The contents of this CResult_NetworkGraphDecodeErrorZ, accessible via either
7278 * `err` or `result` depending on the state of `result_ok`.
7280 union LDKCResult_NetworkGraphDecodeErrorZPtr contents;
7282 * Whether this CResult_NetworkGraphDecodeErrorZ represents a success state.
7285 } LDKCResult_NetworkGraphDecodeErrorZ;
7288 * An enum which can either contain a crate::c_types::derived::CVec_NetAddressZ or not
7290 typedef enum LDKCOption_CVec_NetAddressZZ_Tag {
7292 * When we're in this state, this COption_CVec_NetAddressZZ contains a crate::c_types::derived::CVec_NetAddressZ
7294 LDKCOption_CVec_NetAddressZZ_Some,
7296 * When we're in this state, this COption_CVec_NetAddressZZ contains nothing
7298 LDKCOption_CVec_NetAddressZZ_None,
7300 * Must be last for serialization purposes
7302 LDKCOption_CVec_NetAddressZZ_Sentinel,
7303 } LDKCOption_CVec_NetAddressZZ_Tag;
7305 typedef struct LDKCOption_CVec_NetAddressZZ {
7306 LDKCOption_CVec_NetAddressZZ_Tag tag;
7309 struct LDKCVec_NetAddressZ some;
7312 } LDKCOption_CVec_NetAddressZZ;
7315 * The contents of CResult_NetAddressu8Z
7317 typedef union LDKCResult_NetAddressu8ZPtr {
7319 * A pointer to the contents in the success state.
7320 * Reading from this pointer when `result_ok` is not set is undefined.
7322 struct LDKNetAddress *result;
7324 * A pointer to the contents in the error state.
7325 * Reading from this pointer when `result_ok` is set is undefined.
7328 } LDKCResult_NetAddressu8ZPtr;
7331 * A CResult_NetAddressu8Z represents the result of a fallible operation,
7332 * containing a crate::lightning::ln::msgs::NetAddress on success and a u8 on failure.
7333 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7335 typedef struct LDKCResult_NetAddressu8Z {
7337 * The contents of this CResult_NetAddressu8Z, accessible via either
7338 * `err` or `result` depending on the state of `result_ok`.
7340 union LDKCResult_NetAddressu8ZPtr contents;
7342 * Whether this CResult_NetAddressu8Z represents a success state.
7345 } LDKCResult_NetAddressu8Z;
7348 * The contents of CResult_CResult_NetAddressu8ZDecodeErrorZ
7350 typedef union LDKCResult_CResult_NetAddressu8ZDecodeErrorZPtr {
7352 * A pointer to the contents in the success state.
7353 * Reading from this pointer when `result_ok` is not set is undefined.
7355 struct LDKCResult_NetAddressu8Z *result;
7357 * A pointer to the contents in the error state.
7358 * Reading from this pointer when `result_ok` is set is undefined.
7360 struct LDKDecodeError *err;
7361 } LDKCResult_CResult_NetAddressu8ZDecodeErrorZPtr;
7364 * A CResult_CResult_NetAddressu8ZDecodeErrorZ represents the result of a fallible operation,
7365 * containing a crate::c_types::derived::CResult_NetAddressu8Z on success and a crate::lightning::ln::msgs::DecodeError on failure.
7366 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7368 typedef struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ {
7370 * The contents of this CResult_CResult_NetAddressu8ZDecodeErrorZ, accessible via either
7371 * `err` or `result` depending on the state of `result_ok`.
7373 union LDKCResult_CResult_NetAddressu8ZDecodeErrorZPtr contents;
7375 * Whether this CResult_CResult_NetAddressu8ZDecodeErrorZ represents a success state.
7378 } LDKCResult_CResult_NetAddressu8ZDecodeErrorZ;
7381 * The contents of CResult_NetAddressDecodeErrorZ
7383 typedef union LDKCResult_NetAddressDecodeErrorZPtr {
7385 * A pointer to the contents in the success state.
7386 * Reading from this pointer when `result_ok` is not set is undefined.
7388 struct LDKNetAddress *result;
7390 * A pointer to the contents in the error state.
7391 * Reading from this pointer when `result_ok` is set is undefined.
7393 struct LDKDecodeError *err;
7394 } LDKCResult_NetAddressDecodeErrorZPtr;
7397 * A CResult_NetAddressDecodeErrorZ represents the result of a fallible operation,
7398 * containing a crate::lightning::ln::msgs::NetAddress on success and a crate::lightning::ln::msgs::DecodeError on failure.
7399 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7401 typedef struct LDKCResult_NetAddressDecodeErrorZ {
7403 * The contents of this CResult_NetAddressDecodeErrorZ, accessible via either
7404 * `err` or `result` depending on the state of `result_ok`.
7406 union LDKCResult_NetAddressDecodeErrorZPtr contents;
7408 * Whether this CResult_NetAddressDecodeErrorZ represents a success state.
7411 } LDKCResult_NetAddressDecodeErrorZ;
7416 * An update_add_htlc message to be sent or received from a peer
7418 typedef struct MUST_USE_STRUCT LDKUpdateAddHTLC {
7420 * A pointer to the opaque Rust object.
7421 * Nearly everywhere, inner must be non-null, however in places where
7422 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7424 LDKnativeUpdateAddHTLC *inner;
7426 * Indicates that this is the only struct which contains the same pointer.
7427 * Rust functions which take ownership of an object provided via an argument require
7428 * this to be true and invalidate the object pointed to by inner.
7434 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateAddHTLCs of arbitrary size.
7435 * This corresponds to std::vector in C++
7437 typedef struct LDKCVec_UpdateAddHTLCZ {
7439 * The elements in the array.
7440 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7442 struct LDKUpdateAddHTLC *data;
7444 * The number of elements pointed to by `data`.
7447 } LDKCVec_UpdateAddHTLCZ;
7452 * An update_fulfill_htlc message to be sent or received from a peer
7454 typedef struct MUST_USE_STRUCT LDKUpdateFulfillHTLC {
7456 * A pointer to the opaque Rust object.
7457 * Nearly everywhere, inner must be non-null, however in places where
7458 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7460 LDKnativeUpdateFulfillHTLC *inner;
7462 * Indicates that this is the only struct which contains the same pointer.
7463 * Rust functions which take ownership of an object provided via an argument require
7464 * this to be true and invalidate the object pointed to by inner.
7467 } LDKUpdateFulfillHTLC;
7470 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateFulfillHTLCs of arbitrary size.
7471 * This corresponds to std::vector in C++
7473 typedef struct LDKCVec_UpdateFulfillHTLCZ {
7475 * The elements in the array.
7476 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7478 struct LDKUpdateFulfillHTLC *data;
7480 * The number of elements pointed to by `data`.
7483 } LDKCVec_UpdateFulfillHTLCZ;
7488 * An update_fail_htlc message to be sent or received from a peer
7490 typedef struct MUST_USE_STRUCT LDKUpdateFailHTLC {
7492 * A pointer to the opaque Rust object.
7493 * Nearly everywhere, inner must be non-null, however in places where
7494 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7496 LDKnativeUpdateFailHTLC *inner;
7498 * Indicates that this is the only struct which contains the same pointer.
7499 * Rust functions which take ownership of an object provided via an argument require
7500 * this to be true and invalidate the object pointed to by inner.
7503 } LDKUpdateFailHTLC;
7506 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateFailHTLCs of arbitrary size.
7507 * This corresponds to std::vector in C++
7509 typedef struct LDKCVec_UpdateFailHTLCZ {
7511 * The elements in the array.
7512 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7514 struct LDKUpdateFailHTLC *data;
7516 * The number of elements pointed to by `data`.
7519 } LDKCVec_UpdateFailHTLCZ;
7524 * An update_fail_malformed_htlc message to be sent or received from a peer
7526 typedef struct MUST_USE_STRUCT LDKUpdateFailMalformedHTLC {
7528 * A pointer to the opaque Rust object.
7529 * Nearly everywhere, inner must be non-null, however in places where
7530 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7532 LDKnativeUpdateFailMalformedHTLC *inner;
7534 * Indicates that this is the only struct which contains the same pointer.
7535 * Rust functions which take ownership of an object provided via an argument require
7536 * this to be true and invalidate the object pointed to by inner.
7539 } LDKUpdateFailMalformedHTLC;
7542 * A dynamically-allocated array of crate::lightning::ln::msgs::UpdateFailMalformedHTLCs of arbitrary size.
7543 * This corresponds to std::vector in C++
7545 typedef struct LDKCVec_UpdateFailMalformedHTLCZ {
7547 * The elements in the array.
7548 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
7550 struct LDKUpdateFailMalformedHTLC *data;
7552 * The number of elements pointed to by `data`.
7555 } LDKCVec_UpdateFailMalformedHTLCZ;
7558 * The contents of CResult_AcceptChannelDecodeErrorZ
7560 typedef union LDKCResult_AcceptChannelDecodeErrorZPtr {
7562 * A pointer to the contents in the success state.
7563 * Reading from this pointer when `result_ok` is not set is undefined.
7565 struct LDKAcceptChannel *result;
7567 * A pointer to the contents in the error state.
7568 * Reading from this pointer when `result_ok` is set is undefined.
7570 struct LDKDecodeError *err;
7571 } LDKCResult_AcceptChannelDecodeErrorZPtr;
7574 * A CResult_AcceptChannelDecodeErrorZ represents the result of a fallible operation,
7575 * containing a crate::lightning::ln::msgs::AcceptChannel on success and a crate::lightning::ln::msgs::DecodeError on failure.
7576 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7578 typedef struct LDKCResult_AcceptChannelDecodeErrorZ {
7580 * The contents of this CResult_AcceptChannelDecodeErrorZ, accessible via either
7581 * `err` or `result` depending on the state of `result_ok`.
7583 union LDKCResult_AcceptChannelDecodeErrorZPtr contents;
7585 * Whether this CResult_AcceptChannelDecodeErrorZ represents a success state.
7588 } LDKCResult_AcceptChannelDecodeErrorZ;
7591 * The contents of CResult_AnnouncementSignaturesDecodeErrorZ
7593 typedef union LDKCResult_AnnouncementSignaturesDecodeErrorZPtr {
7595 * A pointer to the contents in the success state.
7596 * Reading from this pointer when `result_ok` is not set is undefined.
7598 struct LDKAnnouncementSignatures *result;
7600 * A pointer to the contents in the error state.
7601 * Reading from this pointer when `result_ok` is set is undefined.
7603 struct LDKDecodeError *err;
7604 } LDKCResult_AnnouncementSignaturesDecodeErrorZPtr;
7607 * A CResult_AnnouncementSignaturesDecodeErrorZ represents the result of a fallible operation,
7608 * containing a crate::lightning::ln::msgs::AnnouncementSignatures on success and a crate::lightning::ln::msgs::DecodeError on failure.
7609 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7611 typedef struct LDKCResult_AnnouncementSignaturesDecodeErrorZ {
7613 * The contents of this CResult_AnnouncementSignaturesDecodeErrorZ, accessible via either
7614 * `err` or `result` depending on the state of `result_ok`.
7616 union LDKCResult_AnnouncementSignaturesDecodeErrorZPtr contents;
7618 * Whether this CResult_AnnouncementSignaturesDecodeErrorZ represents a success state.
7621 } LDKCResult_AnnouncementSignaturesDecodeErrorZ;
7624 * The contents of CResult_ChannelReestablishDecodeErrorZ
7626 typedef union LDKCResult_ChannelReestablishDecodeErrorZPtr {
7628 * A pointer to the contents in the success state.
7629 * Reading from this pointer when `result_ok` is not set is undefined.
7631 struct LDKChannelReestablish *result;
7633 * A pointer to the contents in the error state.
7634 * Reading from this pointer when `result_ok` is set is undefined.
7636 struct LDKDecodeError *err;
7637 } LDKCResult_ChannelReestablishDecodeErrorZPtr;
7640 * A CResult_ChannelReestablishDecodeErrorZ represents the result of a fallible operation,
7641 * containing a crate::lightning::ln::msgs::ChannelReestablish on success and a crate::lightning::ln::msgs::DecodeError on failure.
7642 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7644 typedef struct LDKCResult_ChannelReestablishDecodeErrorZ {
7646 * The contents of this CResult_ChannelReestablishDecodeErrorZ, accessible via either
7647 * `err` or `result` depending on the state of `result_ok`.
7649 union LDKCResult_ChannelReestablishDecodeErrorZPtr contents;
7651 * Whether this CResult_ChannelReestablishDecodeErrorZ represents a success state.
7654 } LDKCResult_ChannelReestablishDecodeErrorZ;
7657 * The contents of CResult_ClosingSignedDecodeErrorZ
7659 typedef union LDKCResult_ClosingSignedDecodeErrorZPtr {
7661 * A pointer to the contents in the success state.
7662 * Reading from this pointer when `result_ok` is not set is undefined.
7664 struct LDKClosingSigned *result;
7666 * A pointer to the contents in the error state.
7667 * Reading from this pointer when `result_ok` is set is undefined.
7669 struct LDKDecodeError *err;
7670 } LDKCResult_ClosingSignedDecodeErrorZPtr;
7673 * A CResult_ClosingSignedDecodeErrorZ represents the result of a fallible operation,
7674 * containing a crate::lightning::ln::msgs::ClosingSigned on success and a crate::lightning::ln::msgs::DecodeError on failure.
7675 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7677 typedef struct LDKCResult_ClosingSignedDecodeErrorZ {
7679 * The contents of this CResult_ClosingSignedDecodeErrorZ, accessible via either
7680 * `err` or `result` depending on the state of `result_ok`.
7682 union LDKCResult_ClosingSignedDecodeErrorZPtr contents;
7684 * Whether this CResult_ClosingSignedDecodeErrorZ represents a success state.
7687 } LDKCResult_ClosingSignedDecodeErrorZ;
7692 * The minimum and maximum fees which the sender is willing to place on the closing transaction.
7693 * This is provided in [`ClosingSigned`] by both sides to indicate the fee range they are willing
7696 typedef struct MUST_USE_STRUCT LDKClosingSignedFeeRange {
7698 * A pointer to the opaque Rust object.
7699 * Nearly everywhere, inner must be non-null, however in places where
7700 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7702 LDKnativeClosingSignedFeeRange *inner;
7704 * Indicates that this is the only struct which contains the same pointer.
7705 * Rust functions which take ownership of an object provided via an argument require
7706 * this to be true and invalidate the object pointed to by inner.
7709 } LDKClosingSignedFeeRange;
7712 * The contents of CResult_ClosingSignedFeeRangeDecodeErrorZ
7714 typedef union LDKCResult_ClosingSignedFeeRangeDecodeErrorZPtr {
7716 * A pointer to the contents in the success state.
7717 * Reading from this pointer when `result_ok` is not set is undefined.
7719 struct LDKClosingSignedFeeRange *result;
7721 * A pointer to the contents in the error state.
7722 * Reading from this pointer when `result_ok` is set is undefined.
7724 struct LDKDecodeError *err;
7725 } LDKCResult_ClosingSignedFeeRangeDecodeErrorZPtr;
7728 * A CResult_ClosingSignedFeeRangeDecodeErrorZ represents the result of a fallible operation,
7729 * containing a crate::lightning::ln::msgs::ClosingSignedFeeRange on success and a crate::lightning::ln::msgs::DecodeError on failure.
7730 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7732 typedef struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ {
7734 * The contents of this CResult_ClosingSignedFeeRangeDecodeErrorZ, accessible via either
7735 * `err` or `result` depending on the state of `result_ok`.
7737 union LDKCResult_ClosingSignedFeeRangeDecodeErrorZPtr contents;
7739 * Whether this CResult_ClosingSignedFeeRangeDecodeErrorZ represents a success state.
7742 } LDKCResult_ClosingSignedFeeRangeDecodeErrorZ;
7747 * A commitment_signed message to be sent or received from a peer
7749 typedef struct MUST_USE_STRUCT LDKCommitmentSigned {
7751 * A pointer to the opaque Rust object.
7752 * Nearly everywhere, inner must be non-null, however in places where
7753 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7755 LDKnativeCommitmentSigned *inner;
7757 * Indicates that this is the only struct which contains the same pointer.
7758 * Rust functions which take ownership of an object provided via an argument require
7759 * this to be true and invalidate the object pointed to by inner.
7762 } LDKCommitmentSigned;
7765 * The contents of CResult_CommitmentSignedDecodeErrorZ
7767 typedef union LDKCResult_CommitmentSignedDecodeErrorZPtr {
7769 * A pointer to the contents in the success state.
7770 * Reading from this pointer when `result_ok` is not set is undefined.
7772 struct LDKCommitmentSigned *result;
7774 * A pointer to the contents in the error state.
7775 * Reading from this pointer when `result_ok` is set is undefined.
7777 struct LDKDecodeError *err;
7778 } LDKCResult_CommitmentSignedDecodeErrorZPtr;
7781 * A CResult_CommitmentSignedDecodeErrorZ represents the result of a fallible operation,
7782 * containing a crate::lightning::ln::msgs::CommitmentSigned on success and a crate::lightning::ln::msgs::DecodeError on failure.
7783 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7785 typedef struct LDKCResult_CommitmentSignedDecodeErrorZ {
7787 * The contents of this CResult_CommitmentSignedDecodeErrorZ, accessible via either
7788 * `err` or `result` depending on the state of `result_ok`.
7790 union LDKCResult_CommitmentSignedDecodeErrorZPtr contents;
7792 * Whether this CResult_CommitmentSignedDecodeErrorZ represents a success state.
7795 } LDKCResult_CommitmentSignedDecodeErrorZ;
7798 * The contents of CResult_FundingCreatedDecodeErrorZ
7800 typedef union LDKCResult_FundingCreatedDecodeErrorZPtr {
7802 * A pointer to the contents in the success state.
7803 * Reading from this pointer when `result_ok` is not set is undefined.
7805 struct LDKFundingCreated *result;
7807 * A pointer to the contents in the error state.
7808 * Reading from this pointer when `result_ok` is set is undefined.
7810 struct LDKDecodeError *err;
7811 } LDKCResult_FundingCreatedDecodeErrorZPtr;
7814 * A CResult_FundingCreatedDecodeErrorZ represents the result of a fallible operation,
7815 * containing a crate::lightning::ln::msgs::FundingCreated on success and a crate::lightning::ln::msgs::DecodeError on failure.
7816 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7818 typedef struct LDKCResult_FundingCreatedDecodeErrorZ {
7820 * The contents of this CResult_FundingCreatedDecodeErrorZ, accessible via either
7821 * `err` or `result` depending on the state of `result_ok`.
7823 union LDKCResult_FundingCreatedDecodeErrorZPtr contents;
7825 * Whether this CResult_FundingCreatedDecodeErrorZ represents a success state.
7828 } LDKCResult_FundingCreatedDecodeErrorZ;
7831 * The contents of CResult_FundingSignedDecodeErrorZ
7833 typedef union LDKCResult_FundingSignedDecodeErrorZPtr {
7835 * A pointer to the contents in the success state.
7836 * Reading from this pointer when `result_ok` is not set is undefined.
7838 struct LDKFundingSigned *result;
7840 * A pointer to the contents in the error state.
7841 * Reading from this pointer when `result_ok` is set is undefined.
7843 struct LDKDecodeError *err;
7844 } LDKCResult_FundingSignedDecodeErrorZPtr;
7847 * A CResult_FundingSignedDecodeErrorZ represents the result of a fallible operation,
7848 * containing a crate::lightning::ln::msgs::FundingSigned on success and a crate::lightning::ln::msgs::DecodeError on failure.
7849 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7851 typedef struct LDKCResult_FundingSignedDecodeErrorZ {
7853 * The contents of this CResult_FundingSignedDecodeErrorZ, accessible via either
7854 * `err` or `result` depending on the state of `result_ok`.
7856 union LDKCResult_FundingSignedDecodeErrorZPtr contents;
7858 * Whether this CResult_FundingSignedDecodeErrorZ represents a success state.
7861 } LDKCResult_FundingSignedDecodeErrorZ;
7864 * The contents of CResult_FundingLockedDecodeErrorZ
7866 typedef union LDKCResult_FundingLockedDecodeErrorZPtr {
7868 * A pointer to the contents in the success state.
7869 * Reading from this pointer when `result_ok` is not set is undefined.
7871 struct LDKFundingLocked *result;
7873 * A pointer to the contents in the error state.
7874 * Reading from this pointer when `result_ok` is set is undefined.
7876 struct LDKDecodeError *err;
7877 } LDKCResult_FundingLockedDecodeErrorZPtr;
7880 * A CResult_FundingLockedDecodeErrorZ represents the result of a fallible operation,
7881 * containing a crate::lightning::ln::msgs::FundingLocked on success and a crate::lightning::ln::msgs::DecodeError on failure.
7882 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7884 typedef struct LDKCResult_FundingLockedDecodeErrorZ {
7886 * The contents of this CResult_FundingLockedDecodeErrorZ, accessible via either
7887 * `err` or `result` depending on the state of `result_ok`.
7889 union LDKCResult_FundingLockedDecodeErrorZPtr contents;
7891 * Whether this CResult_FundingLockedDecodeErrorZ represents a success state.
7894 } LDKCResult_FundingLockedDecodeErrorZ;
7899 * An init message to be sent or received from a peer
7901 typedef struct MUST_USE_STRUCT LDKInit {
7903 * A pointer to the opaque Rust object.
7904 * Nearly everywhere, inner must be non-null, however in places where
7905 * the Rust equivalent takes an Option, it may be set to null to indicate None.
7907 LDKnativeInit *inner;
7909 * Indicates that this is the only struct which contains the same pointer.
7910 * Rust functions which take ownership of an object provided via an argument require
7911 * this to be true and invalidate the object pointed to by inner.
7917 * The contents of CResult_InitDecodeErrorZ
7919 typedef union LDKCResult_InitDecodeErrorZPtr {
7921 * A pointer to the contents in the success state.
7922 * Reading from this pointer when `result_ok` is not set is undefined.
7924 struct LDKInit *result;
7926 * A pointer to the contents in the error state.
7927 * Reading from this pointer when `result_ok` is set is undefined.
7929 struct LDKDecodeError *err;
7930 } LDKCResult_InitDecodeErrorZPtr;
7933 * A CResult_InitDecodeErrorZ represents the result of a fallible operation,
7934 * containing a crate::lightning::ln::msgs::Init on success and a crate::lightning::ln::msgs::DecodeError on failure.
7935 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7937 typedef struct LDKCResult_InitDecodeErrorZ {
7939 * The contents of this CResult_InitDecodeErrorZ, accessible via either
7940 * `err` or `result` depending on the state of `result_ok`.
7942 union LDKCResult_InitDecodeErrorZPtr contents;
7944 * Whether this CResult_InitDecodeErrorZ represents a success state.
7947 } LDKCResult_InitDecodeErrorZ;
7950 * The contents of CResult_OpenChannelDecodeErrorZ
7952 typedef union LDKCResult_OpenChannelDecodeErrorZPtr {
7954 * A pointer to the contents in the success state.
7955 * Reading from this pointer when `result_ok` is not set is undefined.
7957 struct LDKOpenChannel *result;
7959 * A pointer to the contents in the error state.
7960 * Reading from this pointer when `result_ok` is set is undefined.
7962 struct LDKDecodeError *err;
7963 } LDKCResult_OpenChannelDecodeErrorZPtr;
7966 * A CResult_OpenChannelDecodeErrorZ represents the result of a fallible operation,
7967 * containing a crate::lightning::ln::msgs::OpenChannel on success and a crate::lightning::ln::msgs::DecodeError on failure.
7968 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
7970 typedef struct LDKCResult_OpenChannelDecodeErrorZ {
7972 * The contents of this CResult_OpenChannelDecodeErrorZ, accessible via either
7973 * `err` or `result` depending on the state of `result_ok`.
7975 union LDKCResult_OpenChannelDecodeErrorZPtr contents;
7977 * Whether this CResult_OpenChannelDecodeErrorZ represents a success state.
7980 } LDKCResult_OpenChannelDecodeErrorZ;
7983 * The contents of CResult_RevokeAndACKDecodeErrorZ
7985 typedef union LDKCResult_RevokeAndACKDecodeErrorZPtr {
7987 * A pointer to the contents in the success state.
7988 * Reading from this pointer when `result_ok` is not set is undefined.
7990 struct LDKRevokeAndACK *result;
7992 * A pointer to the contents in the error state.
7993 * Reading from this pointer when `result_ok` is set is undefined.
7995 struct LDKDecodeError *err;
7996 } LDKCResult_RevokeAndACKDecodeErrorZPtr;
7999 * A CResult_RevokeAndACKDecodeErrorZ represents the result of a fallible operation,
8000 * containing a crate::lightning::ln::msgs::RevokeAndACK on success and a crate::lightning::ln::msgs::DecodeError on failure.
8001 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8003 typedef struct LDKCResult_RevokeAndACKDecodeErrorZ {
8005 * The contents of this CResult_RevokeAndACKDecodeErrorZ, accessible via either
8006 * `err` or `result` depending on the state of `result_ok`.
8008 union LDKCResult_RevokeAndACKDecodeErrorZPtr contents;
8010 * Whether this CResult_RevokeAndACKDecodeErrorZ represents a success state.
8013 } LDKCResult_RevokeAndACKDecodeErrorZ;
8016 * The contents of CResult_ShutdownDecodeErrorZ
8018 typedef union LDKCResult_ShutdownDecodeErrorZPtr {
8020 * A pointer to the contents in the success state.
8021 * Reading from this pointer when `result_ok` is not set is undefined.
8023 struct LDKShutdown *result;
8025 * A pointer to the contents in the error state.
8026 * Reading from this pointer when `result_ok` is set is undefined.
8028 struct LDKDecodeError *err;
8029 } LDKCResult_ShutdownDecodeErrorZPtr;
8032 * A CResult_ShutdownDecodeErrorZ represents the result of a fallible operation,
8033 * containing a crate::lightning::ln::msgs::Shutdown on success and a crate::lightning::ln::msgs::DecodeError on failure.
8034 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8036 typedef struct LDKCResult_ShutdownDecodeErrorZ {
8038 * The contents of this CResult_ShutdownDecodeErrorZ, accessible via either
8039 * `err` or `result` depending on the state of `result_ok`.
8041 union LDKCResult_ShutdownDecodeErrorZPtr contents;
8043 * Whether this CResult_ShutdownDecodeErrorZ represents a success state.
8046 } LDKCResult_ShutdownDecodeErrorZ;
8049 * The contents of CResult_UpdateFailHTLCDecodeErrorZ
8051 typedef union LDKCResult_UpdateFailHTLCDecodeErrorZPtr {
8053 * A pointer to the contents in the success state.
8054 * Reading from this pointer when `result_ok` is not set is undefined.
8056 struct LDKUpdateFailHTLC *result;
8058 * A pointer to the contents in the error state.
8059 * Reading from this pointer when `result_ok` is set is undefined.
8061 struct LDKDecodeError *err;
8062 } LDKCResult_UpdateFailHTLCDecodeErrorZPtr;
8065 * A CResult_UpdateFailHTLCDecodeErrorZ represents the result of a fallible operation,
8066 * containing a crate::lightning::ln::msgs::UpdateFailHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
8067 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8069 typedef struct LDKCResult_UpdateFailHTLCDecodeErrorZ {
8071 * The contents of this CResult_UpdateFailHTLCDecodeErrorZ, accessible via either
8072 * `err` or `result` depending on the state of `result_ok`.
8074 union LDKCResult_UpdateFailHTLCDecodeErrorZPtr contents;
8076 * Whether this CResult_UpdateFailHTLCDecodeErrorZ represents a success state.
8079 } LDKCResult_UpdateFailHTLCDecodeErrorZ;
8082 * The contents of CResult_UpdateFailMalformedHTLCDecodeErrorZ
8084 typedef union LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr {
8086 * A pointer to the contents in the success state.
8087 * Reading from this pointer when `result_ok` is not set is undefined.
8089 struct LDKUpdateFailMalformedHTLC *result;
8091 * A pointer to the contents in the error state.
8092 * Reading from this pointer when `result_ok` is set is undefined.
8094 struct LDKDecodeError *err;
8095 } LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr;
8098 * A CResult_UpdateFailMalformedHTLCDecodeErrorZ represents the result of a fallible operation,
8099 * containing a crate::lightning::ln::msgs::UpdateFailMalformedHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
8100 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8102 typedef struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ {
8104 * The contents of this CResult_UpdateFailMalformedHTLCDecodeErrorZ, accessible via either
8105 * `err` or `result` depending on the state of `result_ok`.
8107 union LDKCResult_UpdateFailMalformedHTLCDecodeErrorZPtr contents;
8109 * Whether this CResult_UpdateFailMalformedHTLCDecodeErrorZ represents a success state.
8112 } LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ;
8117 * An update_fee message to be sent or received from a peer
8119 typedef struct MUST_USE_STRUCT LDKUpdateFee {
8121 * A pointer to the opaque Rust object.
8122 * Nearly everywhere, inner must be non-null, however in places where
8123 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8125 LDKnativeUpdateFee *inner;
8127 * Indicates that this is the only struct which contains the same pointer.
8128 * Rust functions which take ownership of an object provided via an argument require
8129 * this to be true and invalidate the object pointed to by inner.
8135 * The contents of CResult_UpdateFeeDecodeErrorZ
8137 typedef union LDKCResult_UpdateFeeDecodeErrorZPtr {
8139 * A pointer to the contents in the success state.
8140 * Reading from this pointer when `result_ok` is not set is undefined.
8142 struct LDKUpdateFee *result;
8144 * A pointer to the contents in the error state.
8145 * Reading from this pointer when `result_ok` is set is undefined.
8147 struct LDKDecodeError *err;
8148 } LDKCResult_UpdateFeeDecodeErrorZPtr;
8151 * A CResult_UpdateFeeDecodeErrorZ represents the result of a fallible operation,
8152 * containing a crate::lightning::ln::msgs::UpdateFee on success and a crate::lightning::ln::msgs::DecodeError on failure.
8153 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8155 typedef struct LDKCResult_UpdateFeeDecodeErrorZ {
8157 * The contents of this CResult_UpdateFeeDecodeErrorZ, accessible via either
8158 * `err` or `result` depending on the state of `result_ok`.
8160 union LDKCResult_UpdateFeeDecodeErrorZPtr contents;
8162 * Whether this CResult_UpdateFeeDecodeErrorZ represents a success state.
8165 } LDKCResult_UpdateFeeDecodeErrorZ;
8168 * The contents of CResult_UpdateFulfillHTLCDecodeErrorZ
8170 typedef union LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr {
8172 * A pointer to the contents in the success state.
8173 * Reading from this pointer when `result_ok` is not set is undefined.
8175 struct LDKUpdateFulfillHTLC *result;
8177 * A pointer to the contents in the error state.
8178 * Reading from this pointer when `result_ok` is set is undefined.
8180 struct LDKDecodeError *err;
8181 } LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr;
8184 * A CResult_UpdateFulfillHTLCDecodeErrorZ represents the result of a fallible operation,
8185 * containing a crate::lightning::ln::msgs::UpdateFulfillHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
8186 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8188 typedef struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ {
8190 * The contents of this CResult_UpdateFulfillHTLCDecodeErrorZ, accessible via either
8191 * `err` or `result` depending on the state of `result_ok`.
8193 union LDKCResult_UpdateFulfillHTLCDecodeErrorZPtr contents;
8195 * Whether this CResult_UpdateFulfillHTLCDecodeErrorZ represents a success state.
8198 } LDKCResult_UpdateFulfillHTLCDecodeErrorZ;
8201 * The contents of CResult_UpdateAddHTLCDecodeErrorZ
8203 typedef union LDKCResult_UpdateAddHTLCDecodeErrorZPtr {
8205 * A pointer to the contents in the success state.
8206 * Reading from this pointer when `result_ok` is not set is undefined.
8208 struct LDKUpdateAddHTLC *result;
8210 * A pointer to the contents in the error state.
8211 * Reading from this pointer when `result_ok` is set is undefined.
8213 struct LDKDecodeError *err;
8214 } LDKCResult_UpdateAddHTLCDecodeErrorZPtr;
8217 * A CResult_UpdateAddHTLCDecodeErrorZ represents the result of a fallible operation,
8218 * containing a crate::lightning::ln::msgs::UpdateAddHTLC on success and a crate::lightning::ln::msgs::DecodeError on failure.
8219 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8221 typedef struct LDKCResult_UpdateAddHTLCDecodeErrorZ {
8223 * The contents of this CResult_UpdateAddHTLCDecodeErrorZ, accessible via either
8224 * `err` or `result` depending on the state of `result_ok`.
8226 union LDKCResult_UpdateAddHTLCDecodeErrorZPtr contents;
8228 * Whether this CResult_UpdateAddHTLCDecodeErrorZ represents a success state.
8231 } LDKCResult_UpdateAddHTLCDecodeErrorZ;
8236 * A ping message to be sent or received from a peer
8238 typedef struct MUST_USE_STRUCT LDKPing {
8240 * A pointer to the opaque Rust object.
8241 * Nearly everywhere, inner must be non-null, however in places where
8242 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8244 LDKnativePing *inner;
8246 * Indicates that this is the only struct which contains the same pointer.
8247 * Rust functions which take ownership of an object provided via an argument require
8248 * this to be true and invalidate the object pointed to by inner.
8254 * The contents of CResult_PingDecodeErrorZ
8256 typedef union LDKCResult_PingDecodeErrorZPtr {
8258 * A pointer to the contents in the success state.
8259 * Reading from this pointer when `result_ok` is not set is undefined.
8261 struct LDKPing *result;
8263 * A pointer to the contents in the error state.
8264 * Reading from this pointer when `result_ok` is set is undefined.
8266 struct LDKDecodeError *err;
8267 } LDKCResult_PingDecodeErrorZPtr;
8270 * A CResult_PingDecodeErrorZ represents the result of a fallible operation,
8271 * containing a crate::lightning::ln::msgs::Ping on success and a crate::lightning::ln::msgs::DecodeError on failure.
8272 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8274 typedef struct LDKCResult_PingDecodeErrorZ {
8276 * The contents of this CResult_PingDecodeErrorZ, accessible via either
8277 * `err` or `result` depending on the state of `result_ok`.
8279 union LDKCResult_PingDecodeErrorZPtr contents;
8281 * Whether this CResult_PingDecodeErrorZ represents a success state.
8284 } LDKCResult_PingDecodeErrorZ;
8289 * A pong message to be sent or received from a peer
8291 typedef struct MUST_USE_STRUCT LDKPong {
8293 * A pointer to the opaque Rust object.
8294 * Nearly everywhere, inner must be non-null, however in places where
8295 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8297 LDKnativePong *inner;
8299 * Indicates that this is the only struct which contains the same pointer.
8300 * Rust functions which take ownership of an object provided via an argument require
8301 * this to be true and invalidate the object pointed to by inner.
8307 * The contents of CResult_PongDecodeErrorZ
8309 typedef union LDKCResult_PongDecodeErrorZPtr {
8311 * A pointer to the contents in the success state.
8312 * Reading from this pointer when `result_ok` is not set is undefined.
8314 struct LDKPong *result;
8316 * A pointer to the contents in the error state.
8317 * Reading from this pointer when `result_ok` is set is undefined.
8319 struct LDKDecodeError *err;
8320 } LDKCResult_PongDecodeErrorZPtr;
8323 * A CResult_PongDecodeErrorZ represents the result of a fallible operation,
8324 * containing a crate::lightning::ln::msgs::Pong on success and a crate::lightning::ln::msgs::DecodeError on failure.
8325 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8327 typedef struct LDKCResult_PongDecodeErrorZ {
8329 * The contents of this CResult_PongDecodeErrorZ, accessible via either
8330 * `err` or `result` depending on the state of `result_ok`.
8332 union LDKCResult_PongDecodeErrorZPtr contents;
8334 * Whether this CResult_PongDecodeErrorZ represents a success state.
8337 } LDKCResult_PongDecodeErrorZ;
8340 * The contents of CResult_UnsignedChannelAnnouncementDecodeErrorZ
8342 typedef union LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr {
8344 * A pointer to the contents in the success state.
8345 * Reading from this pointer when `result_ok` is not set is undefined.
8347 struct LDKUnsignedChannelAnnouncement *result;
8349 * A pointer to the contents in the error state.
8350 * Reading from this pointer when `result_ok` is set is undefined.
8352 struct LDKDecodeError *err;
8353 } LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr;
8356 * A CResult_UnsignedChannelAnnouncementDecodeErrorZ represents the result of a fallible operation,
8357 * containing a crate::lightning::ln::msgs::UnsignedChannelAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
8358 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8360 typedef struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ {
8362 * The contents of this CResult_UnsignedChannelAnnouncementDecodeErrorZ, accessible via either
8363 * `err` or `result` depending on the state of `result_ok`.
8365 union LDKCResult_UnsignedChannelAnnouncementDecodeErrorZPtr contents;
8367 * Whether this CResult_UnsignedChannelAnnouncementDecodeErrorZ represents a success state.
8370 } LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ;
8373 * The contents of CResult_ChannelAnnouncementDecodeErrorZ
8375 typedef union LDKCResult_ChannelAnnouncementDecodeErrorZPtr {
8377 * A pointer to the contents in the success state.
8378 * Reading from this pointer when `result_ok` is not set is undefined.
8380 struct LDKChannelAnnouncement *result;
8382 * A pointer to the contents in the error state.
8383 * Reading from this pointer when `result_ok` is set is undefined.
8385 struct LDKDecodeError *err;
8386 } LDKCResult_ChannelAnnouncementDecodeErrorZPtr;
8389 * A CResult_ChannelAnnouncementDecodeErrorZ represents the result of a fallible operation,
8390 * containing a crate::lightning::ln::msgs::ChannelAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
8391 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8393 typedef struct LDKCResult_ChannelAnnouncementDecodeErrorZ {
8395 * The contents of this CResult_ChannelAnnouncementDecodeErrorZ, accessible via either
8396 * `err` or `result` depending on the state of `result_ok`.
8398 union LDKCResult_ChannelAnnouncementDecodeErrorZPtr contents;
8400 * Whether this CResult_ChannelAnnouncementDecodeErrorZ represents a success state.
8403 } LDKCResult_ChannelAnnouncementDecodeErrorZ;
8408 * The unsigned part of a channel_update
8410 typedef struct MUST_USE_STRUCT LDKUnsignedChannelUpdate {
8412 * A pointer to the opaque Rust object.
8413 * Nearly everywhere, inner must be non-null, however in places where
8414 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8416 LDKnativeUnsignedChannelUpdate *inner;
8418 * Indicates that this is the only struct which contains the same pointer.
8419 * Rust functions which take ownership of an object provided via an argument require
8420 * this to be true and invalidate the object pointed to by inner.
8423 } LDKUnsignedChannelUpdate;
8426 * The contents of CResult_UnsignedChannelUpdateDecodeErrorZ
8428 typedef union LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr {
8430 * A pointer to the contents in the success state.
8431 * Reading from this pointer when `result_ok` is not set is undefined.
8433 struct LDKUnsignedChannelUpdate *result;
8435 * A pointer to the contents in the error state.
8436 * Reading from this pointer when `result_ok` is set is undefined.
8438 struct LDKDecodeError *err;
8439 } LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr;
8442 * A CResult_UnsignedChannelUpdateDecodeErrorZ represents the result of a fallible operation,
8443 * containing a crate::lightning::ln::msgs::UnsignedChannelUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
8444 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8446 typedef struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ {
8448 * The contents of this CResult_UnsignedChannelUpdateDecodeErrorZ, accessible via either
8449 * `err` or `result` depending on the state of `result_ok`.
8451 union LDKCResult_UnsignedChannelUpdateDecodeErrorZPtr contents;
8453 * Whether this CResult_UnsignedChannelUpdateDecodeErrorZ represents a success state.
8456 } LDKCResult_UnsignedChannelUpdateDecodeErrorZ;
8459 * The contents of CResult_ChannelUpdateDecodeErrorZ
8461 typedef union LDKCResult_ChannelUpdateDecodeErrorZPtr {
8463 * A pointer to the contents in the success state.
8464 * Reading from this pointer when `result_ok` is not set is undefined.
8466 struct LDKChannelUpdate *result;
8468 * A pointer to the contents in the error state.
8469 * Reading from this pointer when `result_ok` is set is undefined.
8471 struct LDKDecodeError *err;
8472 } LDKCResult_ChannelUpdateDecodeErrorZPtr;
8475 * A CResult_ChannelUpdateDecodeErrorZ represents the result of a fallible operation,
8476 * containing a crate::lightning::ln::msgs::ChannelUpdate on success and a crate::lightning::ln::msgs::DecodeError on failure.
8477 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8479 typedef struct LDKCResult_ChannelUpdateDecodeErrorZ {
8481 * The contents of this CResult_ChannelUpdateDecodeErrorZ, accessible via either
8482 * `err` or `result` depending on the state of `result_ok`.
8484 union LDKCResult_ChannelUpdateDecodeErrorZPtr contents;
8486 * Whether this CResult_ChannelUpdateDecodeErrorZ represents a success state.
8489 } LDKCResult_ChannelUpdateDecodeErrorZ;
8492 * The contents of CResult_ErrorMessageDecodeErrorZ
8494 typedef union LDKCResult_ErrorMessageDecodeErrorZPtr {
8496 * A pointer to the contents in the success state.
8497 * Reading from this pointer when `result_ok` is not set is undefined.
8499 struct LDKErrorMessage *result;
8501 * A pointer to the contents in the error state.
8502 * Reading from this pointer when `result_ok` is set is undefined.
8504 struct LDKDecodeError *err;
8505 } LDKCResult_ErrorMessageDecodeErrorZPtr;
8508 * A CResult_ErrorMessageDecodeErrorZ represents the result of a fallible operation,
8509 * containing a crate::lightning::ln::msgs::ErrorMessage on success and a crate::lightning::ln::msgs::DecodeError on failure.
8510 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8512 typedef struct LDKCResult_ErrorMessageDecodeErrorZ {
8514 * The contents of this CResult_ErrorMessageDecodeErrorZ, accessible via either
8515 * `err` or `result` depending on the state of `result_ok`.
8517 union LDKCResult_ErrorMessageDecodeErrorZPtr contents;
8519 * Whether this CResult_ErrorMessageDecodeErrorZ represents a success state.
8522 } LDKCResult_ErrorMessageDecodeErrorZ;
8527 * The unsigned part of a node_announcement
8529 typedef struct MUST_USE_STRUCT LDKUnsignedNodeAnnouncement {
8531 * A pointer to the opaque Rust object.
8532 * Nearly everywhere, inner must be non-null, however in places where
8533 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8535 LDKnativeUnsignedNodeAnnouncement *inner;
8537 * Indicates that this is the only struct which contains the same pointer.
8538 * Rust functions which take ownership of an object provided via an argument require
8539 * this to be true and invalidate the object pointed to by inner.
8542 } LDKUnsignedNodeAnnouncement;
8545 * The contents of CResult_UnsignedNodeAnnouncementDecodeErrorZ
8547 typedef union LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr {
8549 * A pointer to the contents in the success state.
8550 * Reading from this pointer when `result_ok` is not set is undefined.
8552 struct LDKUnsignedNodeAnnouncement *result;
8554 * A pointer to the contents in the error state.
8555 * Reading from this pointer when `result_ok` is set is undefined.
8557 struct LDKDecodeError *err;
8558 } LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr;
8561 * A CResult_UnsignedNodeAnnouncementDecodeErrorZ represents the result of a fallible operation,
8562 * containing a crate::lightning::ln::msgs::UnsignedNodeAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
8563 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8565 typedef struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ {
8567 * The contents of this CResult_UnsignedNodeAnnouncementDecodeErrorZ, accessible via either
8568 * `err` or `result` depending on the state of `result_ok`.
8570 union LDKCResult_UnsignedNodeAnnouncementDecodeErrorZPtr contents;
8572 * Whether this CResult_UnsignedNodeAnnouncementDecodeErrorZ represents a success state.
8575 } LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ;
8578 * The contents of CResult_NodeAnnouncementDecodeErrorZ
8580 typedef union LDKCResult_NodeAnnouncementDecodeErrorZPtr {
8582 * A pointer to the contents in the success state.
8583 * Reading from this pointer when `result_ok` is not set is undefined.
8585 struct LDKNodeAnnouncement *result;
8587 * A pointer to the contents in the error state.
8588 * Reading from this pointer when `result_ok` is set is undefined.
8590 struct LDKDecodeError *err;
8591 } LDKCResult_NodeAnnouncementDecodeErrorZPtr;
8594 * A CResult_NodeAnnouncementDecodeErrorZ represents the result of a fallible operation,
8595 * containing a crate::lightning::ln::msgs::NodeAnnouncement on success and a crate::lightning::ln::msgs::DecodeError on failure.
8596 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8598 typedef struct LDKCResult_NodeAnnouncementDecodeErrorZ {
8600 * The contents of this CResult_NodeAnnouncementDecodeErrorZ, accessible via either
8601 * `err` or `result` depending on the state of `result_ok`.
8603 union LDKCResult_NodeAnnouncementDecodeErrorZPtr contents;
8605 * Whether this CResult_NodeAnnouncementDecodeErrorZ represents a success state.
8608 } LDKCResult_NodeAnnouncementDecodeErrorZ;
8611 * The contents of CResult_QueryShortChannelIdsDecodeErrorZ
8613 typedef union LDKCResult_QueryShortChannelIdsDecodeErrorZPtr {
8615 * A pointer to the contents in the success state.
8616 * Reading from this pointer when `result_ok` is not set is undefined.
8618 struct LDKQueryShortChannelIds *result;
8620 * A pointer to the contents in the error state.
8621 * Reading from this pointer when `result_ok` is set is undefined.
8623 struct LDKDecodeError *err;
8624 } LDKCResult_QueryShortChannelIdsDecodeErrorZPtr;
8627 * A CResult_QueryShortChannelIdsDecodeErrorZ represents the result of a fallible operation,
8628 * containing a crate::lightning::ln::msgs::QueryShortChannelIds on success and a crate::lightning::ln::msgs::DecodeError on failure.
8629 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8631 typedef struct LDKCResult_QueryShortChannelIdsDecodeErrorZ {
8633 * The contents of this CResult_QueryShortChannelIdsDecodeErrorZ, accessible via either
8634 * `err` or `result` depending on the state of `result_ok`.
8636 union LDKCResult_QueryShortChannelIdsDecodeErrorZPtr contents;
8638 * Whether this CResult_QueryShortChannelIdsDecodeErrorZ represents a success state.
8641 } LDKCResult_QueryShortChannelIdsDecodeErrorZ;
8646 * A reply_short_channel_ids_end message is sent as a reply to a
8647 * query_short_channel_ids message. The query recipient makes a best
8648 * effort to respond based on their local network view which may not be
8649 * a perfect view of the network.
8651 typedef struct MUST_USE_STRUCT LDKReplyShortChannelIdsEnd {
8653 * A pointer to the opaque Rust object.
8654 * Nearly everywhere, inner must be non-null, however in places where
8655 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8657 LDKnativeReplyShortChannelIdsEnd *inner;
8659 * Indicates that this is the only struct which contains the same pointer.
8660 * Rust functions which take ownership of an object provided via an argument require
8661 * this to be true and invalidate the object pointed to by inner.
8664 } LDKReplyShortChannelIdsEnd;
8667 * The contents of CResult_ReplyShortChannelIdsEndDecodeErrorZ
8669 typedef union LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr {
8671 * A pointer to the contents in the success state.
8672 * Reading from this pointer when `result_ok` is not set is undefined.
8674 struct LDKReplyShortChannelIdsEnd *result;
8676 * A pointer to the contents in the error state.
8677 * Reading from this pointer when `result_ok` is set is undefined.
8679 struct LDKDecodeError *err;
8680 } LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr;
8683 * A CResult_ReplyShortChannelIdsEndDecodeErrorZ represents the result of a fallible operation,
8684 * containing a crate::lightning::ln::msgs::ReplyShortChannelIdsEnd on success and a crate::lightning::ln::msgs::DecodeError on failure.
8685 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8687 typedef struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ {
8689 * The contents of this CResult_ReplyShortChannelIdsEndDecodeErrorZ, accessible via either
8690 * `err` or `result` depending on the state of `result_ok`.
8692 union LDKCResult_ReplyShortChannelIdsEndDecodeErrorZPtr contents;
8694 * Whether this CResult_ReplyShortChannelIdsEndDecodeErrorZ represents a success state.
8697 } LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ;
8700 * The contents of CResult_QueryChannelRangeDecodeErrorZ
8702 typedef union LDKCResult_QueryChannelRangeDecodeErrorZPtr {
8704 * A pointer to the contents in the success state.
8705 * Reading from this pointer when `result_ok` is not set is undefined.
8707 struct LDKQueryChannelRange *result;
8709 * A pointer to the contents in the error state.
8710 * Reading from this pointer when `result_ok` is set is undefined.
8712 struct LDKDecodeError *err;
8713 } LDKCResult_QueryChannelRangeDecodeErrorZPtr;
8716 * A CResult_QueryChannelRangeDecodeErrorZ represents the result of a fallible operation,
8717 * containing a crate::lightning::ln::msgs::QueryChannelRange on success and a crate::lightning::ln::msgs::DecodeError on failure.
8718 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8720 typedef struct LDKCResult_QueryChannelRangeDecodeErrorZ {
8722 * The contents of this CResult_QueryChannelRangeDecodeErrorZ, accessible via either
8723 * `err` or `result` depending on the state of `result_ok`.
8725 union LDKCResult_QueryChannelRangeDecodeErrorZPtr contents;
8727 * Whether this CResult_QueryChannelRangeDecodeErrorZ represents a success state.
8730 } LDKCResult_QueryChannelRangeDecodeErrorZ;
8733 * The contents of CResult_ReplyChannelRangeDecodeErrorZ
8735 typedef union LDKCResult_ReplyChannelRangeDecodeErrorZPtr {
8737 * A pointer to the contents in the success state.
8738 * Reading from this pointer when `result_ok` is not set is undefined.
8740 struct LDKReplyChannelRange *result;
8742 * A pointer to the contents in the error state.
8743 * Reading from this pointer when `result_ok` is set is undefined.
8745 struct LDKDecodeError *err;
8746 } LDKCResult_ReplyChannelRangeDecodeErrorZPtr;
8749 * A CResult_ReplyChannelRangeDecodeErrorZ represents the result of a fallible operation,
8750 * containing a crate::lightning::ln::msgs::ReplyChannelRange on success and a crate::lightning::ln::msgs::DecodeError on failure.
8751 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8753 typedef struct LDKCResult_ReplyChannelRangeDecodeErrorZ {
8755 * The contents of this CResult_ReplyChannelRangeDecodeErrorZ, accessible via either
8756 * `err` or `result` depending on the state of `result_ok`.
8758 union LDKCResult_ReplyChannelRangeDecodeErrorZPtr contents;
8760 * Whether this CResult_ReplyChannelRangeDecodeErrorZ represents a success state.
8763 } LDKCResult_ReplyChannelRangeDecodeErrorZ;
8768 * A gossip_timestamp_filter message is used by a node to request
8769 * gossip relay for messages in the requested time range when the
8770 * gossip_queries feature has been negotiated.
8772 typedef struct MUST_USE_STRUCT LDKGossipTimestampFilter {
8774 * A pointer to the opaque Rust object.
8775 * Nearly everywhere, inner must be non-null, however in places where
8776 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8778 LDKnativeGossipTimestampFilter *inner;
8780 * Indicates that this is the only struct which contains the same pointer.
8781 * Rust functions which take ownership of an object provided via an argument require
8782 * this to be true and invalidate the object pointed to by inner.
8785 } LDKGossipTimestampFilter;
8788 * The contents of CResult_GossipTimestampFilterDecodeErrorZ
8790 typedef union LDKCResult_GossipTimestampFilterDecodeErrorZPtr {
8792 * A pointer to the contents in the success state.
8793 * Reading from this pointer when `result_ok` is not set is undefined.
8795 struct LDKGossipTimestampFilter *result;
8797 * A pointer to the contents in the error state.
8798 * Reading from this pointer when `result_ok` is set is undefined.
8800 struct LDKDecodeError *err;
8801 } LDKCResult_GossipTimestampFilterDecodeErrorZPtr;
8804 * A CResult_GossipTimestampFilterDecodeErrorZ represents the result of a fallible operation,
8805 * containing a crate::lightning::ln::msgs::GossipTimestampFilter on success and a crate::lightning::ln::msgs::DecodeError on failure.
8806 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8808 typedef struct LDKCResult_GossipTimestampFilterDecodeErrorZ {
8810 * The contents of this CResult_GossipTimestampFilterDecodeErrorZ, accessible via either
8811 * `err` or `result` depending on the state of `result_ok`.
8813 union LDKCResult_GossipTimestampFilterDecodeErrorZPtr contents;
8815 * Whether this CResult_GossipTimestampFilterDecodeErrorZ represents a success state.
8818 } LDKCResult_GossipTimestampFilterDecodeErrorZ;
8821 * When signing using a fallible method either an user-supplied `SignError` or a `CreationError`
8824 typedef enum LDKSignOrCreationError_Tag {
8826 * An error occurred during signing
8828 LDKSignOrCreationError_SignError,
8830 * An error occurred while building the transaction
8832 LDKSignOrCreationError_CreationError,
8834 * Must be last for serialization purposes
8836 LDKSignOrCreationError_Sentinel,
8837 } LDKSignOrCreationError_Tag;
8839 typedef struct MUST_USE_STRUCT LDKSignOrCreationError {
8840 LDKSignOrCreationError_Tag tag;
8843 enum LDKCreationError creation_error;
8846 } LDKSignOrCreationError;
8849 * The contents of CResult_InvoiceSignOrCreationErrorZ
8851 typedef union LDKCResult_InvoiceSignOrCreationErrorZPtr {
8853 * A pointer to the contents in the success state.
8854 * Reading from this pointer when `result_ok` is not set is undefined.
8856 struct LDKInvoice *result;
8858 * A pointer to the contents in the error state.
8859 * Reading from this pointer when `result_ok` is set is undefined.
8861 struct LDKSignOrCreationError *err;
8862 } LDKCResult_InvoiceSignOrCreationErrorZPtr;
8865 * A CResult_InvoiceSignOrCreationErrorZ represents the result of a fallible operation,
8866 * containing a crate::lightning_invoice::Invoice on success and a crate::lightning_invoice::SignOrCreationError on failure.
8867 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
8869 typedef struct LDKCResult_InvoiceSignOrCreationErrorZ {
8871 * The contents of this CResult_InvoiceSignOrCreationErrorZ, accessible via either
8872 * `err` or `result` depending on the state of `result_ok`.
8874 union LDKCResult_InvoiceSignOrCreationErrorZPtr contents;
8876 * Whether this CResult_InvoiceSignOrCreationErrorZ represents a success state.
8879 } LDKCResult_InvoiceSignOrCreationErrorZ;
8884 * A transaction output watched by a [`ChannelMonitor`] for spends on-chain.
8886 * Used to convey to a [`Filter`] such an output with a given spending condition. Any transaction
8887 * spending the output must be given to [`ChannelMonitor::block_connected`] either directly or via
8888 * the return value of [`Filter::register_output`].
8890 * If `block_hash` is `Some`, this indicates the output was created in the corresponding block and
8891 * may have been spent there. See [`Filter::register_output`] for details.
8893 * [`ChannelMonitor`]: channelmonitor::ChannelMonitor
8894 * [`ChannelMonitor::block_connected`]: channelmonitor::ChannelMonitor::block_connected
8896 typedef struct MUST_USE_STRUCT LDKWatchedOutput {
8898 * A pointer to the opaque Rust object.
8899 * Nearly everywhere, inner must be non-null, however in places where
8900 * the Rust equivalent takes an Option, it may be set to null to indicate None.
8902 LDKnativeWatchedOutput *inner;
8904 * Indicates that this is the only struct which contains the same pointer.
8905 * Rust functions which take ownership of an object provided via an argument require
8906 * this to be true and invalidate the object pointed to by inner.
8912 * The `Filter` trait defines behavior for indicating chain activity of interest pertaining to
8915 * This is useful in order to have a [`Watch`] implementation convey to a chain source which
8916 * transactions to be notified of. Notification may take the form of pre-filtering blocks or, in
8917 * the case of [BIP 157]/[BIP 158], only fetching a block if the compact filter matches. If
8918 * receiving full blocks from a chain source, any further filtering is unnecessary.
8920 * After an output has been registered, subsequent block retrievals from the chain source must not
8921 * exclude any transactions matching the new criteria nor any in-block descendants of such
8924 * Note that use as part of a [`Watch`] implementation involves reentrancy. Therefore, the `Filter`
8925 * should not block on I/O. Implementations should instead queue the newly monitored data to be
8926 * processed later. Then, in order to block until the data has been processed, any [`Watch`]
8927 * invocation that has called the `Filter` must return [`TemporaryFailure`].
8929 * [`TemporaryFailure`]: ChannelMonitorUpdateErr::TemporaryFailure
8930 * [BIP 157]: https://github.com/bitcoin/bips/blob/master/bip-0157.mediawiki
8931 * [BIP 158]: https://github.com/bitcoin/bips/blob/master/bip-0158.mediawiki
8933 typedef struct LDKFilter {
8935 * An opaque pointer which is passed to your function implementations as an argument.
8936 * This has no meaning in the LDK, and can be NULL or any other value.
8940 * Registers interest in a transaction with `txid` and having an output with `script_pubkey` as
8941 * a spending condition.
8943 void (*register_tx)(const void *this_arg, const uint8_t (*txid)[32], struct LDKu8slice script_pubkey);
8945 * Registers interest in spends of a transaction output.
8947 * Optionally, when `output.block_hash` is set, should return any transaction spending the
8948 * output that is found in the corresponding block along with its index.
8950 * This return value is useful for Electrum clients in order to supply in-block descendant
8951 * transactions which otherwise were not included. This is not necessary for other clients if
8952 * such descendant transactions were already included (e.g., when a BIP 157 client provides the
8955 struct LDKCOption_C2Tuple_usizeTransactionZZ (*register_output)(const void *this_arg, struct LDKWatchedOutput output);
8957 * Frees any resources associated with this object given its this_arg pointer.
8958 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
8960 void (*free)(void *this_arg);
8964 * An enum which can either contain a crate::lightning::chain::Filter or not
8966 typedef enum LDKCOption_FilterZ_Tag {
8968 * When we're in this state, this COption_FilterZ contains a crate::lightning::chain::Filter
8970 LDKCOption_FilterZ_Some,
8972 * When we're in this state, this COption_FilterZ contains nothing
8974 LDKCOption_FilterZ_None,
8976 * Must be last for serialization purposes
8978 LDKCOption_FilterZ_Sentinel,
8979 } LDKCOption_FilterZ_Tag;
8981 typedef struct LDKCOption_FilterZ {
8982 LDKCOption_FilterZ_Tag tag;
8985 struct LDKFilter some;
8988 } LDKCOption_FilterZ;
8993 * A read-only reference to a current ChannelMonitor.
8995 * Note that this holds a mutex in [`ChainMonitor`] and may block other events until it is
8998 typedef struct MUST_USE_STRUCT LDKLockedChannelMonitor {
9000 * A pointer to the opaque Rust object.
9001 * Nearly everywhere, inner must be non-null, however in places where
9002 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9004 LDKnativeLockedChannelMonitor *inner;
9006 * Indicates that this is the only struct which contains the same pointer.
9007 * Rust functions which take ownership of an object provided via an argument require
9008 * this to be true and invalidate the object pointed to by inner.
9011 } LDKLockedChannelMonitor;
9014 * The contents of CResult_LockedChannelMonitorNoneZ
9016 typedef union LDKCResult_LockedChannelMonitorNoneZPtr {
9018 * A pointer to the contents in the success state.
9019 * Reading from this pointer when `result_ok` is not set is undefined.
9021 struct LDKLockedChannelMonitor *result;
9023 * Note that this value is always NULL, as there are no contents in the Err variant
9026 } LDKCResult_LockedChannelMonitorNoneZPtr;
9029 * A CResult_LockedChannelMonitorNoneZ represents the result of a fallible operation,
9030 * containing a crate::lightning::chain::chainmonitor::LockedChannelMonitor on success and a () on failure.
9031 * `result_ok` indicates the overall state, and the contents are provided via `contents`.
9033 typedef struct LDKCResult_LockedChannelMonitorNoneZ {
9035 * The contents of this CResult_LockedChannelMonitorNoneZ, accessible via either
9036 * `err` or `result` depending on the state of `result_ok`.
9038 union LDKCResult_LockedChannelMonitorNoneZPtr contents;
9040 * Whether this CResult_LockedChannelMonitorNoneZ represents a success state.
9043 } LDKCResult_LockedChannelMonitorNoneZ;
9046 * A dynamically-allocated array of crate::lightning::chain::transaction::OutPoints of arbitrary size.
9047 * This corresponds to std::vector in C++
9049 typedef struct LDKCVec_OutPointZ {
9051 * The elements in the array.
9052 * If datalen is non-0 this must be a valid, non-NULL pointer allocated by malloc().
9054 struct LDKOutPoint *data;
9056 * The number of elements pointed to by `data`.
9059 } LDKCVec_OutPointZ;
9062 * A trait indicating an object may generate message send events
9064 typedef struct LDKMessageSendEventsProvider {
9066 * An opaque pointer which is passed to your function implementations as an argument.
9067 * This has no meaning in the LDK, and can be NULL or any other value.
9071 * Gets the list of pending events which were generated by previous actions, clearing the list
9074 struct LDKCVec_MessageSendEventZ (*get_and_clear_pending_msg_events)(const void *this_arg);
9076 * Frees any resources associated with this object given its this_arg pointer.
9077 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9079 void (*free)(void *this_arg);
9080 } LDKMessageSendEventsProvider;
9083 * A trait implemented for objects handling events from [`EventsProvider`].
9085 typedef struct LDKEventHandler {
9087 * An opaque pointer which is passed to your function implementations as an argument.
9088 * This has no meaning in the LDK, and can be NULL or any other value.
9092 * Handles the given [`Event`].
9094 * See [`EventsProvider`] for details that must be considered when implementing this method.
9096 void (*handle_event)(const void *this_arg, const struct LDKEvent *NONNULL_PTR event);
9098 * Frees any resources associated with this object given its this_arg pointer.
9099 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9101 void (*free)(void *this_arg);
9105 * A trait indicating an object may generate events.
9107 * Events are processed by passing an [`EventHandler`] to [`process_pending_events`].
9111 * See [`process_pending_events`] for requirements around event processing.
9113 * When using this trait, [`process_pending_events`] will call [`handle_event`] for each pending
9114 * event since the last invocation. The handler must either act upon the event immediately
9115 * or preserve it for later handling.
9117 * Note, handlers may call back into the provider and thus deadlocking must be avoided. Be sure to
9118 * consult the provider's documentation on the implication of processing events and how a handler
9119 * may safely use the provider (e.g., see [`ChannelManager::process_pending_events`] and
9120 * [`ChainMonitor::process_pending_events`]).
9122 * (C-not implementable) As there is likely no reason for a user to implement this trait on their
9125 * [`process_pending_events`]: Self::process_pending_events
9126 * [`handle_event`]: EventHandler::handle_event
9127 * [`ChannelManager::process_pending_events`]: crate::ln::channelmanager::ChannelManager#method.process_pending_events
9128 * [`ChainMonitor::process_pending_events`]: crate::chain::chainmonitor::ChainMonitor#method.process_pending_events
9130 typedef struct LDKEventsProvider {
9132 * An opaque pointer which is passed to your function implementations as an argument.
9133 * This has no meaning in the LDK, and can be NULL or any other value.
9137 * Processes any events generated since the last call using the given event handler.
9139 * Subsequent calls must only process new events. However, handlers must be capable of handling
9140 * duplicate events across process restarts. This may occur if the provider was recovered from
9141 * an old state (i.e., it hadn't been successfully persisted after processing pending events).
9143 void (*process_pending_events)(const void *this_arg, struct LDKEventHandler handler);
9145 * Frees any resources associated with this object given its this_arg pointer.
9146 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9148 void (*free)(void *this_arg);
9149 } LDKEventsProvider;
9154 * Configuration we set when applicable.
9156 * Default::default() provides sane defaults.
9158 typedef struct MUST_USE_STRUCT LDKChannelHandshakeConfig {
9160 * A pointer to the opaque Rust object.
9161 * Nearly everywhere, inner must be non-null, however in places where
9162 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9164 LDKnativeChannelHandshakeConfig *inner;
9166 * Indicates that this is the only struct which contains the same pointer.
9167 * Rust functions which take ownership of an object provided via an argument require
9168 * this to be true and invalidate the object pointed to by inner.
9171 } LDKChannelHandshakeConfig;
9176 * Optional channel limits which are applied during channel creation.
9178 * These limits are only applied to our counterparty's limits, not our own.
9180 * Use 0/<type>::max_value() as appropriate to skip checking.
9182 * Provides sane defaults for most configurations.
9184 * Most additional limits are disabled except those with which specify a default in individual
9185 * field documentation. Note that this may result in barely-usable channels, but since they
9186 * are applied mostly only to incoming channels that's not much of a problem.
9188 typedef struct MUST_USE_STRUCT LDKChannelHandshakeLimits {
9190 * A pointer to the opaque Rust object.
9191 * Nearly everywhere, inner must be non-null, however in places where
9192 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9194 LDKnativeChannelHandshakeLimits *inner;
9196 * Indicates that this is the only struct which contains the same pointer.
9197 * Rust functions which take ownership of an object provided via an argument require
9198 * this to be true and invalidate the object pointed to by inner.
9201 } LDKChannelHandshakeLimits;
9206 * Top-level config which holds ChannelHandshakeLimits and ChannelConfig.
9208 * Default::default() provides sane defaults for most configurations
9209 * (but currently with 0 relay fees!)
9211 typedef struct MUST_USE_STRUCT LDKUserConfig {
9213 * A pointer to the opaque Rust object.
9214 * Nearly everywhere, inner must be non-null, however in places where
9215 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9217 LDKnativeUserConfig *inner;
9219 * Indicates that this is the only struct which contains the same pointer.
9220 * Rust functions which take ownership of an object provided via an argument require
9221 * this to be true and invalidate the object pointed to by inner.
9229 * The best known block as identified by its hash and height.
9231 typedef struct MUST_USE_STRUCT LDKBestBlock {
9233 * A pointer to the opaque Rust object.
9234 * Nearly everywhere, inner must be non-null, however in places where
9235 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9237 LDKnativeBestBlock *inner;
9239 * Indicates that this is the only struct which contains the same pointer.
9240 * Rust functions which take ownership of an object provided via an argument require
9241 * this to be true and invalidate the object pointed to by inner.
9247 * The `Listen` trait is used to notify when blocks have been connected or disconnected from the
9250 * Useful when needing to replay chain data upon startup or as new chain events occur. Clients
9251 * sourcing chain data using a block-oriented API should prefer this interface over [`Confirm`].
9252 * Such clients fetch the entire header chain whereas clients using [`Confirm`] only fetch headers
9255 typedef struct LDKListen {
9257 * An opaque pointer which is passed to your function implementations as an argument.
9258 * This has no meaning in the LDK, and can be NULL or any other value.
9262 * Notifies the listener that a block was added at the given height.
9264 void (*block_connected)(const void *this_arg, struct LDKu8slice block, uint32_t height);
9266 * Notifies the listener that a block was removed at the given height.
9268 void (*block_disconnected)(const void *this_arg, const uint8_t (*header)[80], uint32_t height);
9270 * Frees any resources associated with this object given its this_arg pointer.
9271 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9273 void (*free)(void *this_arg);
9277 * The `Confirm` trait is used to notify when transactions have been confirmed on chain or
9278 * unconfirmed during a chain reorganization.
9280 * Clients sourcing chain data using a transaction-oriented API should prefer this interface over
9281 * [`Listen`]. For instance, an Electrum client may implement [`Filter`] by subscribing to activity
9282 * related to registered transactions and outputs. Upon notification, it would pass along the
9283 * matching transactions using this interface.
9287 * The intended use is as follows:
9288 * - Call [`transactions_confirmed`] to process any on-chain activity of interest.
9289 * - Call [`transaction_unconfirmed`] to process any transaction returned by [`get_relevant_txids`]
9290 * that has been reorganized out of the chain.
9291 * - Call [`best_block_updated`] whenever a new chain tip becomes available.
9295 * Clients must call these methods in chain order. Specifically:
9296 * - Transactions confirmed in a block must be given before transactions confirmed in a later
9298 * - Dependent transactions within the same block must be given in topological order, possibly in
9300 * - Unconfirmed transactions must be given after the original confirmations and before any
9303 * See individual method documentation for further details.
9305 * [`transactions_confirmed`]: Self::transactions_confirmed
9306 * [`transaction_unconfirmed`]: Self::transaction_unconfirmed
9307 * [`best_block_updated`]: Self::best_block_updated
9308 * [`get_relevant_txids`]: Self::get_relevant_txids
9310 typedef struct LDKConfirm {
9312 * An opaque pointer which is passed to your function implementations as an argument.
9313 * This has no meaning in the LDK, and can be NULL or any other value.
9317 * Processes transactions confirmed in a block with a given header and height.
9319 * Should be called for any transactions registered by [`Filter::register_tx`] or any
9320 * transactions spending an output registered by [`Filter::register_output`]. Such transactions
9321 * appearing in the same block do not need to be included in the same call; instead, multiple
9322 * calls with additional transactions may be made so long as they are made in [chain order].
9324 * May be called before or after [`best_block_updated`] for the corresponding block. However,
9325 * in the event of a chain reorganization, it must not be called with a `header` that is no
9326 * longer in the chain as of the last call to [`best_block_updated`].
9328 * [chain order]: Confirm#Order
9329 * [`best_block_updated`]: Self::best_block_updated
9331 void (*transactions_confirmed)(const void *this_arg, const uint8_t (*header)[80], struct LDKCVec_C2Tuple_usizeTransactionZZ txdata, uint32_t height);
9333 * Processes a transaction that is no longer confirmed as result of a chain reorganization.
9335 * Should be called for any transaction returned by [`get_relevant_txids`] if it has been
9336 * reorganized out of the best chain. Once called, the given transaction should not be returned
9337 * by [`get_relevant_txids`] unless it has been reconfirmed via [`transactions_confirmed`].
9339 * [`get_relevant_txids`]: Self::get_relevant_txids
9340 * [`transactions_confirmed`]: Self::transactions_confirmed
9342 void (*transaction_unconfirmed)(const void *this_arg, const uint8_t (*txid)[32]);
9344 * Processes an update to the best header connected at the given height.
9346 * Should be called when a new header is available but may be skipped for intermediary blocks
9347 * if they become available at the same time.
9349 void (*best_block_updated)(const void *this_arg, const uint8_t (*header)[80], uint32_t height);
9351 * Returns transactions that should be monitored for reorganization out of the chain.
9353 * Should include any transactions passed to [`transactions_confirmed`] that have insufficient
9354 * confirmations to be safe from a chain reorganization. Should not include any transactions
9355 * passed to [`transaction_unconfirmed`] unless later reconfirmed.
9357 * May be called to determine the subset of transactions that must still be monitored for
9358 * reorganization. Will be idempotent between calls but may change as a result of calls to the
9359 * other interface methods. Thus, this is useful to determine which transactions may need to be
9360 * given to [`transaction_unconfirmed`].
9362 * [`transactions_confirmed`]: Self::transactions_confirmed
9363 * [`transaction_unconfirmed`]: Self::transaction_unconfirmed
9365 struct LDKCVec_TxidZ (*get_relevant_txids)(const void *this_arg);
9367 * Frees any resources associated with this object given its this_arg pointer.
9368 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9370 void (*free)(void *this_arg);
9374 * `Persist` defines behavior for persisting channel monitors: this could mean
9375 * writing once to disk, and/or uploading to one or more backup services.
9377 * Note that for every new monitor, you **must** persist the new `ChannelMonitor`
9378 * to disk/backups. And, on every update, you **must** persist either the
9379 * `ChannelMonitorUpdate` or the updated monitor itself. Otherwise, there is risk
9380 * of situations such as revoking a transaction, then crashing before this
9381 * revocation can be persisted, then unintentionally broadcasting a revoked
9382 * transaction and losing money. This is a risk because previous channel states
9383 * are toxic, so it's important that whatever channel state is persisted is
9386 typedef struct LDKPersist {
9388 * An opaque pointer which is passed to your function implementations as an argument.
9389 * This has no meaning in the LDK, and can be NULL or any other value.
9393 * Persist a new channel's data. The data can be stored any way you want, but
9394 * the identifier provided by Rust-Lightning is the channel's outpoint (and
9395 * it is up to you to maintain a correct mapping between the outpoint and the
9396 * stored channel data). Note that you **must** persist every new monitor to
9397 * disk. See the `Persist` trait documentation for more details.
9399 * See [`Writeable::write`] on [`ChannelMonitor`] for writing out a `ChannelMonitor`
9400 * and [`ChannelMonitorUpdateErr`] for requirements when returning errors.
9402 * [`Writeable::write`]: crate::util::ser::Writeable::write
9404 struct LDKCResult_NoneChannelMonitorUpdateErrZ (*persist_new_channel)(const void *this_arg, struct LDKOutPoint id, const struct LDKChannelMonitor *NONNULL_PTR data);
9406 * Update one channel's data. The provided `ChannelMonitor` has already
9407 * applied the given update.
9409 * Note that on every update, you **must** persist either the
9410 * `ChannelMonitorUpdate` or the updated monitor itself to disk/backups. See
9411 * the `Persist` trait documentation for more details.
9413 * If an implementer chooses to persist the updates only, they need to make
9414 * sure that all the updates are applied to the `ChannelMonitors` *before*
9415 * the set of channel monitors is given to the `ChannelManager`
9416 * deserialization routine. See [`ChannelMonitor::update_monitor`] for
9417 * applying a monitor update to a monitor. If full `ChannelMonitors` are
9418 * persisted, then there is no need to persist individual updates.
9420 * Note that there could be a performance tradeoff between persisting complete
9421 * channel monitors on every update vs. persisting only updates and applying
9422 * them in batches. The size of each monitor grows `O(number of state updates)`
9423 * whereas updates are small and `O(1)`.
9425 * See [`Writeable::write`] on [`ChannelMonitor`] for writing out a `ChannelMonitor`,
9426 * [`Writeable::write`] on [`ChannelMonitorUpdate`] for writing out an update, and
9427 * [`ChannelMonitorUpdateErr`] for requirements when returning errors.
9429 * [`Writeable::write`]: crate::util::ser::Writeable::write
9431 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);
9433 * Frees any resources associated with this object given its this_arg pointer.
9434 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9436 void (*free)(void *this_arg);
9442 * An implementation of [`chain::Watch`] for monitoring channels.
9444 * Connected and disconnected blocks must be provided to `ChainMonitor` as documented by
9445 * [`chain::Watch`]. May be used in conjunction with [`ChannelManager`] to monitor channels locally
9446 * or used independently to monitor channels remotely. See the [module-level documentation] for
9449 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
9450 * [module-level documentation]: crate::chain::chainmonitor
9452 typedef struct MUST_USE_STRUCT LDKChainMonitor {
9454 * A pointer to the opaque Rust object.
9455 * Nearly everywhere, inner must be non-null, however in places where
9456 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9458 LDKnativeChainMonitor *inner;
9460 * Indicates that this is the only struct which contains the same pointer.
9461 * Rust functions which take ownership of an object provided via an argument require
9462 * this to be true and invalidate the object pointed to by inner.
9470 * Simple KeysInterface implementor that takes a 32-byte seed for use as a BIP 32 extended key
9471 * and derives keys from that.
9473 * Your node_id is seed/0'
9474 * ChannelMonitor closes may use seed/1'
9475 * Cooperative closes may use seed/2'
9476 * The two close keys may be needed to claim on-chain funds!
9478 typedef struct MUST_USE_STRUCT LDKKeysManager {
9480 * A pointer to the opaque Rust object.
9481 * Nearly everywhere, inner must be non-null, however in places where
9482 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9484 LDKnativeKeysManager *inner;
9486 * Indicates that this is the only struct which contains the same pointer.
9487 * Rust functions which take ownership of an object provided via an argument require
9488 * this to be true and invalidate the object pointed to by inner.
9496 * Chain-related parameters used to construct a new `ChannelManager`.
9498 * Typically, the block-specific parameters are derived from the best block hash for the network,
9499 * as a newly constructed `ChannelManager` will not have created any channels yet. These parameters
9500 * are not needed when deserializing a previously constructed `ChannelManager`.
9502 typedef struct MUST_USE_STRUCT LDKChainParameters {
9504 * A pointer to the opaque Rust object.
9505 * Nearly everywhere, inner must be non-null, however in places where
9506 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9508 LDKnativeChainParameters *inner;
9510 * Indicates that this is the only struct which contains the same pointer.
9511 * Rust functions which take ownership of an object provided via an argument require
9512 * this to be true and invalidate the object pointed to by inner.
9515 } LDKChainParameters;
9520 * Information needed for constructing an invoice route hint for this channel.
9522 typedef struct MUST_USE_STRUCT LDKCounterpartyForwardingInfo {
9524 * A pointer to the opaque Rust object.
9525 * Nearly everywhere, inner must be non-null, however in places where
9526 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9528 LDKnativeCounterpartyForwardingInfo *inner;
9530 * Indicates that this is the only struct which contains the same pointer.
9531 * Rust functions which take ownership of an object provided via an argument require
9532 * this to be true and invalidate the object pointed to by inner.
9535 } LDKCounterpartyForwardingInfo;
9540 * Channel parameters which apply to our counterparty. These are split out from [`ChannelDetails`]
9541 * to better separate parameters.
9543 typedef struct MUST_USE_STRUCT LDKChannelCounterparty {
9545 * A pointer to the opaque Rust object.
9546 * Nearly everywhere, inner must be non-null, however in places where
9547 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9549 LDKnativeChannelCounterparty *inner;
9551 * Indicates that this is the only struct which contains the same pointer.
9552 * Rust functions which take ownership of an object provided via an argument require
9553 * this to be true and invalidate the object pointed to by inner.
9556 } LDKChannelCounterparty;
9559 * A 3-byte byte array.
9561 typedef struct LDKThreeBytes {
9569 * A trait to describe an object which can receive channel messages.
9571 * Messages MAY be called in parallel when they originate from different their_node_ids, however
9572 * they MUST NOT be called in parallel when the two calls have the same their_node_id.
9574 typedef struct LDKChannelMessageHandler {
9576 * An opaque pointer which is passed to your function implementations as an argument.
9577 * This has no meaning in the LDK, and can be NULL or any other value.
9581 * Handle an incoming open_channel message from the given peer.
9583 void (*handle_open_channel)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKInitFeatures their_features, const struct LDKOpenChannel *NONNULL_PTR msg);
9585 * Handle an incoming accept_channel message from the given peer.
9587 void (*handle_accept_channel)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKInitFeatures their_features, const struct LDKAcceptChannel *NONNULL_PTR msg);
9589 * Handle an incoming funding_created message from the given peer.
9591 void (*handle_funding_created)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingCreated *NONNULL_PTR msg);
9593 * Handle an incoming funding_signed message from the given peer.
9595 void (*handle_funding_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingSigned *NONNULL_PTR msg);
9597 * Handle an incoming funding_locked message from the given peer.
9599 void (*handle_funding_locked)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKFundingLocked *NONNULL_PTR msg);
9601 * Handle an incoming shutdown message from the given peer.
9603 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);
9605 * Handle an incoming closing_signed message from the given peer.
9607 void (*handle_closing_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKClosingSigned *NONNULL_PTR msg);
9609 * Handle an incoming update_add_htlc message from the given peer.
9611 void (*handle_update_add_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateAddHTLC *NONNULL_PTR msg);
9613 * Handle an incoming update_fulfill_htlc message from the given peer.
9615 void (*handle_update_fulfill_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFulfillHTLC *NONNULL_PTR msg);
9617 * Handle an incoming update_fail_htlc message from the given peer.
9619 void (*handle_update_fail_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFailHTLC *NONNULL_PTR msg);
9621 * Handle an incoming update_fail_malformed_htlc message from the given peer.
9623 void (*handle_update_fail_malformed_htlc)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR msg);
9625 * Handle an incoming commitment_signed message from the given peer.
9627 void (*handle_commitment_signed)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKCommitmentSigned *NONNULL_PTR msg);
9629 * Handle an incoming revoke_and_ack message from the given peer.
9631 void (*handle_revoke_and_ack)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKRevokeAndACK *NONNULL_PTR msg);
9633 * Handle an incoming update_fee message from the given peer.
9635 void (*handle_update_fee)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKUpdateFee *NONNULL_PTR msg);
9637 * Handle an incoming announcement_signatures message from the given peer.
9639 void (*handle_announcement_signatures)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKAnnouncementSignatures *NONNULL_PTR msg);
9641 * Indicates a connection to the peer failed/an existing connection was lost. If no connection
9642 * is believed to be possible in the future (eg they're sending us messages we don't
9643 * understand or indicate they require unknown feature bits), no_connection_possible is set
9644 * and any outstanding channels should be failed.
9646 void (*peer_disconnected)(const void *this_arg, struct LDKPublicKey their_node_id, bool no_connection_possible);
9648 * Handle a peer reconnecting, possibly generating channel_reestablish message(s).
9650 void (*peer_connected)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKInit *NONNULL_PTR msg);
9652 * Handle an incoming channel_reestablish message from the given peer.
9654 void (*handle_channel_reestablish)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKChannelReestablish *NONNULL_PTR msg);
9656 * Handle an incoming channel update from the given peer.
9658 void (*handle_channel_update)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKChannelUpdate *NONNULL_PTR msg);
9660 * Handle an incoming error message from the given peer.
9662 void (*handle_error)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKErrorMessage *NONNULL_PTR msg);
9664 * Implementation of MessageSendEventsProvider for this object.
9666 struct LDKMessageSendEventsProvider MessageSendEventsProvider;
9668 * Frees any resources associated with this object given its this_arg pointer.
9669 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9671 void (*free)(void *this_arg);
9672 } LDKChannelMessageHandler;
9677 * Arguments for the creation of a ChannelManager that are not deserialized.
9679 * At a high-level, the process for deserializing a ChannelManager and resuming normal operation
9681 * 1) Deserialize all stored ChannelMonitors.
9682 * 2) Deserialize the ChannelManager by filling in this struct and calling:
9683 * <(BlockHash, ChannelManager)>::read(reader, args)
9684 * This may result in closing some Channels if the ChannelMonitor is newer than the stored
9685 * ChannelManager state to ensure no loss of funds. Thus, transactions may be broadcasted.
9686 * 3) If you are not fetching full blocks, register all relevant ChannelMonitor outpoints the same
9687 * way you would handle a `chain::Filter` call using ChannelMonitor::get_outputs_to_watch() and
9688 * ChannelMonitor::get_funding_txo().
9689 * 4) Reconnect blocks on your ChannelMonitors.
9690 * 5) Disconnect/connect blocks on the ChannelManager.
9691 * 6) Move the ChannelMonitors into your local chain::Watch.
9693 * Note that the ordering of #4-6 is not of importance, however all three must occur before you
9694 * call any other methods on the newly-deserialized ChannelManager.
9696 * Note that because some channels may be closed during deserialization, it is critical that you
9697 * always deserialize only the latest version of a ChannelManager and ChannelMonitors available to
9698 * you. If you deserialize an old ChannelManager (during which force-closure transactions may be
9699 * broadcast), and then later deserialize a newer version of the same ChannelManager (which will
9700 * not force-close the same channels but consider them live), you may end up revoking a state for
9701 * which you've already broadcasted the transaction.
9703 typedef struct MUST_USE_STRUCT LDKChannelManagerReadArgs {
9705 * A pointer to the opaque Rust object.
9706 * Nearly everywhere, inner must be non-null, however in places where
9707 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9709 LDKnativeChannelManagerReadArgs *inner;
9711 * Indicates that this is the only struct which contains the same pointer.
9712 * Rust functions which take ownership of an object provided via an argument require
9713 * this to be true and invalidate the object pointed to by inner.
9716 } LDKChannelManagerReadArgs;
9721 * Proof that the sender knows the per-commitment secret of the previous commitment transaction.
9722 * This is used to convince the recipient that the channel is at a certain commitment
9723 * number even if they lost that data due to a local failure. Of course, the peer may lie
9724 * and even later commitments may have been revoked.
9726 typedef struct MUST_USE_STRUCT LDKDataLossProtect {
9728 * A pointer to the opaque Rust object.
9729 * Nearly everywhere, inner must be non-null, however in places where
9730 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9732 LDKnativeDataLossProtect *inner;
9734 * Indicates that this is the only struct which contains the same pointer.
9735 * Rust functions which take ownership of an object provided via an argument require
9736 * this to be true and invalidate the object pointed to by inner.
9739 } LDKDataLossProtect;
9742 * A trait to describe an object which can receive routing messages.
9744 * # Implementor DoS Warnings
9746 * For `gossip_queries` messages there are potential DoS vectors when handling
9747 * inbound queries. Implementors using an on-disk network graph should be aware of
9748 * repeated disk I/O for queries accessing different parts of the network graph.
9750 typedef struct LDKRoutingMessageHandler {
9752 * An opaque pointer which is passed to your function implementations as an argument.
9753 * This has no meaning in the LDK, and can be NULL or any other value.
9757 * Handle an incoming node_announcement message, returning true if it should be forwarded on,
9758 * false or returning an Err otherwise.
9760 struct LDKCResult_boolLightningErrorZ (*handle_node_announcement)(const void *this_arg, const struct LDKNodeAnnouncement *NONNULL_PTR msg);
9762 * Handle a channel_announcement message, returning true if it should be forwarded on, false
9763 * or returning an Err otherwise.
9765 struct LDKCResult_boolLightningErrorZ (*handle_channel_announcement)(const void *this_arg, const struct LDKChannelAnnouncement *NONNULL_PTR msg);
9767 * Handle an incoming channel_update message, returning true if it should be forwarded on,
9768 * false or returning an Err otherwise.
9770 struct LDKCResult_boolLightningErrorZ (*handle_channel_update)(const void *this_arg, const struct LDKChannelUpdate *NONNULL_PTR msg);
9772 * Gets a subset of the channel announcements and updates required to dump our routing table
9773 * to a remote node, starting at the short_channel_id indicated by starting_point and
9774 * including the batch_amount entries immediately higher in numerical value than starting_point.
9776 struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ (*get_next_channel_announcements)(const void *this_arg, uint64_t starting_point, uint8_t batch_amount);
9778 * Gets a subset of the node announcements required to dump our routing table to a remote node,
9779 * starting at the node *after* the provided publickey and including batch_amount entries
9780 * immediately higher (as defined by <PublicKey as Ord>::cmp) than starting_point.
9781 * If None is provided for starting_point, we start at the first node.
9783 * Note that starting_point (or a relevant inner pointer) may be NULL or all-0s to represent None
9785 struct LDKCVec_NodeAnnouncementZ (*get_next_node_announcements)(const void *this_arg, struct LDKPublicKey starting_point, uint8_t batch_amount);
9787 * Called when a connection is established with a peer. This can be used to
9788 * perform routing table synchronization using a strategy defined by the
9791 void (*sync_routing_table)(const void *this_arg, struct LDKPublicKey their_node_id, const struct LDKInit *NONNULL_PTR init);
9793 * Handles the reply of a query we initiated to learn about channels
9794 * for a given range of blocks. We can expect to receive one or more
9795 * replies to a single query.
9797 struct LDKCResult_NoneLightningErrorZ (*handle_reply_channel_range)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKReplyChannelRange msg);
9799 * Handles the reply of a query we initiated asking for routing gossip
9800 * messages for a list of channels. We should receive this message when
9801 * a node has completed its best effort to send us the pertaining routing
9804 struct LDKCResult_NoneLightningErrorZ (*handle_reply_short_channel_ids_end)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKReplyShortChannelIdsEnd msg);
9806 * Handles when a peer asks us to send a list of short_channel_ids
9807 * for the requested range of blocks.
9809 struct LDKCResult_NoneLightningErrorZ (*handle_query_channel_range)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKQueryChannelRange msg);
9811 * Handles when a peer asks us to send routing gossip messages for a
9812 * list of short_channel_ids.
9814 struct LDKCResult_NoneLightningErrorZ (*handle_query_short_channel_ids)(const void *this_arg, struct LDKPublicKey their_node_id, struct LDKQueryShortChannelIds msg);
9816 * Implementation of MessageSendEventsProvider for this object.
9818 struct LDKMessageSendEventsProvider MessageSendEventsProvider;
9820 * Frees any resources associated with this object given its this_arg pointer.
9821 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9823 void (*free)(void *this_arg);
9824 } LDKRoutingMessageHandler;
9827 * Trait to be implemented by custom message (unrelated to the channel/gossip LN layers)
9830 typedef struct LDKCustomMessageReader {
9832 * An opaque pointer which is passed to your function implementations as an argument.
9833 * This has no meaning in the LDK, and can be NULL or any other value.
9837 * Decodes a custom message to `CustomMessageType`. If the given message type is known to the
9838 * implementation and the message could be decoded, must return `Ok(Some(message))`. If the
9839 * message type is unknown to the implementation, must return `Ok(None)`. If a decoding error
9840 * occur, must return `Err(DecodeError::X)` where `X` details the encountered error.
9842 struct LDKCResult_COption_TypeZDecodeErrorZ (*read)(const void *this_arg, uint16_t message_type, struct LDKu8slice buffer);
9844 * Frees any resources associated with this object given its this_arg pointer.
9845 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9847 void (*free)(void *this_arg);
9848 } LDKCustomMessageReader;
9851 * Handler for BOLT1-compliant messages.
9853 typedef struct LDKCustomMessageHandler {
9855 * An opaque pointer which is passed to your function implementations as an argument.
9856 * This has no meaning in the LDK, and can be NULL or any other value.
9860 * Called with the message type that was received and the buffer to be read.
9861 * Can return a `MessageHandlingError` if the message could not be handled.
9863 struct LDKCResult_NoneLightningErrorZ (*handle_custom_message)(const void *this_arg, struct LDKType msg, struct LDKPublicKey sender_node_id);
9865 * Gets the list of pending messages which were generated by the custom message
9866 * handler, clearing the list in the process. The first tuple element must
9867 * correspond to the intended recipients node ids. If no connection to one of the
9868 * specified node does not exist, the message is simply not sent to it.
9870 struct LDKCVec_C2Tuple_PublicKeyTypeZZ (*get_and_clear_pending_msg)(const void *this_arg);
9872 * Implementation of CustomMessageReader for this object.
9874 struct LDKCustomMessageReader CustomMessageReader;
9876 * Frees any resources associated with this object given its this_arg pointer.
9877 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
9879 void (*free)(void *this_arg);
9880 } LDKCustomMessageHandler;
9885 * A dummy struct which implements `RoutingMessageHandler` without storing any routing information
9886 * or doing any processing. You can provide one of these as the route_handler in a MessageHandler.
9888 typedef struct MUST_USE_STRUCT LDKIgnoringMessageHandler {
9890 * A pointer to the opaque Rust object.
9891 * Nearly everywhere, inner must be non-null, however in places where
9892 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9894 LDKnativeIgnoringMessageHandler *inner;
9896 * Indicates that this is the only struct which contains the same pointer.
9897 * Rust functions which take ownership of an object provided via an argument require
9898 * this to be true and invalidate the object pointed to by inner.
9901 } LDKIgnoringMessageHandler;
9906 * A dummy struct which implements `ChannelMessageHandler` without having any channels.
9907 * You can provide one of these as the route_handler in a MessageHandler.
9909 typedef struct MUST_USE_STRUCT LDKErroringMessageHandler {
9911 * A pointer to the opaque Rust object.
9912 * Nearly everywhere, inner must be non-null, however in places where
9913 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9915 LDKnativeErroringMessageHandler *inner;
9917 * Indicates that this is the only struct which contains the same pointer.
9918 * Rust functions which take ownership of an object provided via an argument require
9919 * this to be true and invalidate the object pointed to by inner.
9922 } LDKErroringMessageHandler;
9927 * Provides references to trait impls which handle different types of messages.
9929 typedef struct MUST_USE_STRUCT LDKMessageHandler {
9931 * A pointer to the opaque Rust object.
9932 * Nearly everywhere, inner must be non-null, however in places where
9933 * the Rust equivalent takes an Option, it may be set to null to indicate None.
9935 LDKnativeMessageHandler *inner;
9937 * Indicates that this is the only struct which contains the same pointer.
9938 * Rust functions which take ownership of an object provided via an argument require
9939 * this to be true and invalidate the object pointed to by inner.
9942 } LDKMessageHandler;
9945 * Provides an object which can be used to send data to and which uniquely identifies a connection
9946 * to a remote host. You will need to be able to generate multiple of these which meet Eq and
9947 * implement Hash to meet the PeerManager API.
9949 * For efficiency, Clone should be relatively cheap for this type.
9951 * Two descriptors may compare equal (by [`cmp::Eq`] and [`hash::Hash`]) as long as the original
9952 * has been disconnected, the [`PeerManager`] has been informed of the disconnection (either by it
9953 * having triggered the disconnection or a call to [`PeerManager::socket_disconnected`]), and no
9954 * further calls to the [`PeerManager`] related to the original socket occur. This allows you to
9955 * use a file descriptor for your SocketDescriptor directly, however for simplicity you may wish
9956 * to simply use another value which is guaranteed to be globally unique instead.
9958 typedef struct LDKSocketDescriptor {
9960 * An opaque pointer which is passed to your function implementations as an argument.
9961 * This has no meaning in the LDK, and can be NULL or any other value.
9965 * Attempts to send some data from the given slice to the peer.
9967 * Returns the amount of data which was sent, possibly 0 if the socket has since disconnected.
9968 * Note that in the disconnected case, [`PeerManager::socket_disconnected`] must still be
9969 * called and further write attempts may occur until that time.
9971 * If the returned size is smaller than `data.len()`, a
9972 * [`PeerManager::write_buffer_space_avail`] call must be made the next time more data can be
9973 * written. Additionally, until a `send_data` event completes fully, no further
9974 * [`PeerManager::read_event`] calls should be made for the same peer! Because this is to
9975 * prevent denial-of-service issues, you should not read or buffer any data from the socket
9978 * If a [`PeerManager::read_event`] call on this descriptor had previously returned true
9979 * (indicating that read events should be paused to prevent DoS in the send buffer),
9980 * `resume_read` may be set indicating that read events on this descriptor should resume. A
9981 * `resume_read` of false carries no meaning, and should not cause any action.
9983 uintptr_t (*send_data)(void *this_arg, struct LDKu8slice data, bool resume_read);
9985 * Disconnect the socket pointed to by this SocketDescriptor.
9987 * You do *not* need to call [`PeerManager::socket_disconnected`] with this socket after this
9988 * call (doing so is a noop).
9990 void (*disconnect_socket)(void *this_arg);
9992 * Checks if two objects are equal given this object's this_arg pointer and another object.
9994 bool (*eq)(const void *this_arg, const struct LDKSocketDescriptor *NONNULL_PTR other_arg);
9996 * Calculate a succinct non-cryptographic hash for an object given its this_arg pointer.
9997 * This is used, for example, for inclusion of this object in a hash map.
9999 uint64_t (*hash)(const void *this_arg);
10001 * Called, if set, after this SocketDescriptor has been cloned into a duplicate object.
10002 * The new SocketDescriptor is provided, and should be mutated as needed to perform a
10003 * deep copy of the object pointed to by this_arg or avoid any double-freeing.
10005 void (*cloned)(struct LDKSocketDescriptor *NONNULL_PTR new_SocketDescriptor);
10007 * Frees any resources associated with this object given its this_arg pointer.
10008 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
10010 void (*free)(void *this_arg);
10011 } LDKSocketDescriptor;
10016 * A PeerManager manages a set of peers, described by their [`SocketDescriptor`] and marshalls
10017 * socket events into messages which it passes on to its [`MessageHandler`].
10019 * Locks are taken internally, so you must never assume that reentrancy from a
10020 * [`SocketDescriptor`] call back into [`PeerManager`] methods will not deadlock.
10022 * Calls to [`read_event`] will decode relevant messages and pass them to the
10023 * [`ChannelMessageHandler`], likely doing message processing in-line. Thus, the primary form of
10024 * parallelism in Rust-Lightning is in calls to [`read_event`]. Note, however, that calls to any
10025 * [`PeerManager`] functions related to the same connection must occur only in serial, making new
10026 * calls only after previous ones have returned.
10028 * Rather than using a plain PeerManager, it is preferable to use either a SimpleArcPeerManager
10029 * a SimpleRefPeerManager, for conciseness. See their documentation for more details, but
10030 * essentially you should default to using a SimpleRefPeerManager, and use a
10031 * SimpleArcPeerManager when you require a PeerManager with a static lifetime, such as when
10032 * you're using lightning-net-tokio.
10034 * [`read_event`]: PeerManager::read_event
10036 typedef struct MUST_USE_STRUCT LDKPeerManager {
10038 * A pointer to the opaque Rust object.
10039 * Nearly everywhere, inner must be non-null, however in places where
10040 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10042 LDKnativePeerManager *inner;
10044 * Indicates that this is the only struct which contains the same pointer.
10045 * Rust functions which take ownership of an object provided via an argument require
10046 * this to be true and invalidate the object pointed to by inner.
10054 * Static channel fields used to build transactions given per-commitment fields, organized by
10055 * broadcaster/countersignatory.
10057 * This is derived from the holder/counterparty-organized ChannelTransactionParameters via the
10058 * as_holder_broadcastable and as_counterparty_broadcastable functions.
10060 typedef struct MUST_USE_STRUCT LDKDirectedChannelTransactionParameters {
10062 * A pointer to the opaque Rust object.
10063 * Nearly everywhere, inner must be non-null, however in places where
10064 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10066 LDKnativeDirectedChannelTransactionParameters *inner;
10068 * Indicates that this is the only struct which contains the same pointer.
10069 * Rust functions which take ownership of an object provided via an argument require
10070 * this to be true and invalidate the object pointed to by inner.
10073 } LDKDirectedChannelTransactionParameters;
10076 * An interface used to score payment channels for path finding.
10078 *\tScoring is in terms of fees willing to be paid in order to avoid routing through a channel.
10080 typedef struct LDKScore {
10082 * An opaque pointer which is passed to your function implementations as an argument.
10083 * This has no meaning in the LDK, and can be NULL or any other value.
10087 * Returns the fee in msats willing to be paid to avoid routing through the given channel.
10089 uint64_t (*channel_penalty_msat)(const void *this_arg, uint64_t short_channel_id);
10091 * Frees any resources associated with this object given its this_arg pointer.
10092 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
10094 void (*free)(void *this_arg);
10100 * A read-only view of [`NetworkGraph`].
10102 typedef struct MUST_USE_STRUCT LDKReadOnlyNetworkGraph {
10104 * A pointer to the opaque Rust object.
10105 * Nearly everywhere, inner must be non-null, however in places where
10106 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10108 LDKnativeReadOnlyNetworkGraph *inner;
10110 * Indicates that this is the only struct which contains the same pointer.
10111 * Rust functions which take ownership of an object provided via an argument require
10112 * this to be true and invalidate the object pointed to by inner.
10115 } LDKReadOnlyNetworkGraph;
10120 * Receives and validates network updates from peers,
10121 * stores authentic and relevant data as a network graph.
10122 * This network graph is then used for routing payments.
10123 * Provides interface to help with initial routing sync by
10124 * serving historical announcements.
10126 * Serves as an [`EventHandler`] for applying updates from [`Event::PaymentPathFailed`] to the
10127 * [`NetworkGraph`].
10129 typedef struct MUST_USE_STRUCT LDKNetGraphMsgHandler {
10131 * A pointer to the opaque Rust object.
10132 * Nearly everywhere, inner must be non-null, however in places where
10133 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10135 LDKnativeNetGraphMsgHandler *inner;
10137 * Indicates that this is the only struct which contains the same pointer.
10138 * Rust functions which take ownership of an object provided via an argument require
10139 * this to be true and invalidate the object pointed to by inner.
10142 } LDKNetGraphMsgHandler;
10147 * A channel descriptor for a hop along a payment path.
10149 typedef struct MUST_USE_STRUCT LDKRouteHintHop {
10151 * A pointer to the opaque Rust object.
10152 * Nearly everywhere, inner must be non-null, however in places where
10153 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10155 LDKnativeRouteHintHop *inner;
10157 * Indicates that this is the only struct which contains the same pointer.
10158 * Rust functions which take ownership of an object provided via an argument require
10159 * this to be true and invalidate the object pointed to by inner.
10167 * [`routing::Score`] implementation that provides reasonable default behavior.
10169 * Used to apply a fixed penalty to each channel, thus avoiding long paths when shorter paths with
10170 * slightly higher fees are available.
10172 * See [module-level documentation] for usage.
10174 * [module-level documentation]: crate::routing::scorer
10176 typedef struct MUST_USE_STRUCT LDKScorer {
10178 * A pointer to the opaque Rust object.
10179 * Nearly everywhere, inner must be non-null, however in places where
10180 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10182 LDKnativeScorer *inner;
10184 * Indicates that this is the only struct which contains the same pointer.
10185 * Rust functions which take ownership of an object provided via an argument require
10186 * this to be true and invalidate the object pointed to by inner.
10194 * FilesystemPersister persists channel data on disk, where each channel's
10195 * data is stored in a file named after its funding outpoint.
10197 * Warning: this module does the best it can with calls to persist data, but it
10198 * can only guarantee that the data is passed to the drive. It is up to the
10199 * drive manufacturers to do the actual persistence properly, which they often
10200 * don't (especially on consumer-grade hardware). Therefore, it is up to the
10201 * user to validate their entire storage stack, to ensure the writes are
10203 * Corollary: especially when dealing with larger amounts of money, it is best
10204 * practice to have multiple channel data backups and not rely only on one
10205 * FilesystemPersister.
10207 typedef struct MUST_USE_STRUCT LDKFilesystemPersister {
10209 * A pointer to the opaque Rust object.
10210 * Nearly everywhere, inner must be non-null, however in places where
10211 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10213 LDKnativeFilesystemPersister *inner;
10215 * Indicates that this is the only struct which contains the same pointer.
10216 * Rust functions which take ownership of an object provided via an argument require
10217 * this to be true and invalidate the object pointed to by inner.
10220 } LDKFilesystemPersister;
10225 * `BackgroundProcessor` takes care of tasks that (1) need to happen periodically to keep
10226 * Rust-Lightning running properly, and (2) either can or should be run in the background. Its
10227 * responsibilities are:
10228 * * Processing [`Event`]s with a user-provided [`EventHandler`].
10229 * * Monitoring whether the [`ChannelManager`] needs to be re-persisted to disk, and if so,
10230 * writing it to disk/backups by invoking the callback given to it at startup.
10231 * [`ChannelManager`] persistence should be done in the background.
10232 * * Calling [`ChannelManager::timer_tick_occurred`] and [`PeerManager::timer_tick_occurred`]
10233 * at the appropriate intervals.
10235 * It will also call [`PeerManager::process_events`] periodically though this shouldn't be relied
10236 * upon as doing so may result in high latency.
10240 * If [`ChannelManager`] persistence fails and the persisted manager becomes out-of-date, then
10241 * there is a risk of channels force-closing on startup when the manager realizes it's outdated.
10242 * However, as long as [`ChannelMonitor`] backups are sound, no funds besides those used for
10243 * unilateral chain closure fees are at risk.
10245 * [`ChannelMonitor`]: lightning::chain::channelmonitor::ChannelMonitor
10246 * [`Event`]: lightning::util::events::Event
10247 *BackgroundProcessor will immediately stop on drop. It should be stored until shutdown.
10249 typedef struct MUST_USE_STRUCT LDKBackgroundProcessor {
10251 * A pointer to the opaque Rust object.
10252 * Nearly everywhere, inner must be non-null, however in places where
10253 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10255 LDKnativeBackgroundProcessor *inner;
10257 * Indicates that this is the only struct which contains the same pointer.
10258 * Rust functions which take ownership of an object provided via an argument require
10259 * this to be true and invalidate the object pointed to by inner.
10262 } LDKBackgroundProcessor;
10265 * Trait which handles persisting a [`ChannelManager`] to disk.
10267 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
10269 typedef struct LDKChannelManagerPersister {
10271 * An opaque pointer which is passed to your function implementations as an argument.
10272 * This has no meaning in the LDK, and can be NULL or any other value.
10276 * Persist the given [`ChannelManager`] to disk, returning an error if persistence failed
10277 * (which will cause the [`BackgroundProcessor`] which called this method to exit.
10279 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
10281 struct LDKCResult_NoneErrorZ (*persist_manager)(const void *this_arg, const struct LDKChannelManager *NONNULL_PTR channel_manager);
10283 * Frees any resources associated with this object given its this_arg pointer.
10284 * Does not need to free the outer struct containing function pointers and may be NULL is no resources need to be freed.
10286 void (*free)(void *this_arg);
10287 } LDKChannelManagerPersister;
10292 * Data of the `RawInvoice` that is encoded in the data part
10294 typedef struct MUST_USE_STRUCT LDKRawDataPart {
10296 * A pointer to the opaque Rust object.
10297 * Nearly everywhere, inner must be non-null, however in places where
10298 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10300 LDKnativeRawDataPart *inner;
10302 * Indicates that this is the only struct which contains the same pointer.
10303 * Rust functions which take ownership of an object provided via an argument require
10304 * this to be true and invalidate the object pointed to by inner.
10314 typedef struct MUST_USE_STRUCT LDKSha256 {
10316 * A pointer to the opaque Rust object.
10317 * Nearly everywhere, inner must be non-null, however in places where
10318 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10320 LDKnativeSha256 *inner;
10322 * Indicates that this is the only struct which contains the same pointer.
10323 * Rust functions which take ownership of an object provided via an argument require
10324 * this to be true and invalidate the object pointed to by inner.
10332 * `min_final_cltv_expiry` to use for the last HTLC in the route
10334 typedef struct MUST_USE_STRUCT LDKMinFinalCltvExpiry {
10336 * A pointer to the opaque Rust object.
10337 * Nearly everywhere, inner must be non-null, however in places where
10338 * the Rust equivalent takes an Option, it may be set to null to indicate None.
10340 LDKnativeMinFinalCltvExpiry *inner;
10342 * Indicates that this is the only struct which contains the same pointer.
10343 * Rust functions which take ownership of an object provided via an argument require
10344 * this to be true and invalidate the object pointed to by inner.
10347 } LDKMinFinalCltvExpiry;
10350 * Integer in the range `0..32`
10352 typedef struct LDKu5 {
10357 * A 20-byte byte array.
10359 typedef struct LDKTwentyBytes {
10367 * Fallback address in case no LN payment is possible
10369 typedef enum LDKFallback_Tag {
10370 LDKFallback_SegWitProgram,
10371 LDKFallback_PubKeyHash,
10372 LDKFallback_ScriptHash,
10374 * Must be last for serialization purposes
10376 LDKFallback_Sentinel,
10379 typedef struct LDKFallback_LDKSegWitProgram_Body {
10380 struct LDKu5 version;
10381 struct LDKCVec_u8Z program;
10382 } LDKFallback_LDKSegWitProgram_Body;
10384 typedef struct MUST_USE_STRUCT LDKFallback {
10385 LDKFallback_Tag tag;
10387 LDKFallback_LDKSegWitProgram_Body seg_wit_program;
10389 struct LDKTwentyBytes pub_key_hash;
10392 struct LDKTwentyBytes script_hash;
10397 extern const uintptr_t MAX_BUF_SIZE;
10399 extern const uint64_t MIN_RELAY_FEE_SAT_PER_1000_WEIGHT;
10401 extern const uint64_t CLOSED_CHANNEL_UPDATE_ID;
10403 extern const uint32_t ANTI_REORG_DELAY;
10405 extern const uint16_t BREAKDOWN_TIMEOUT;
10407 extern const uint16_t MIN_CLTV_EXPIRY_DELTA;
10409 extern const uint32_t MIN_FINAL_CLTV_EXPIRY;
10411 extern const uintptr_t REVOKEABLE_REDEEMSCRIPT_MAX_LENGTH;
10413 extern const uint64_t DEFAULT_EXPIRY_TIME;
10415 extern const uint64_t DEFAULT_MIN_FINAL_CLTV_EXPIRY;
10417 extern const uint8_t TAG_PAYMENT_HASH;
10419 extern const uint8_t TAG_DESCRIPTION;
10421 extern const uint8_t TAG_PAYEE_PUB_KEY;
10423 extern const uint8_t TAG_DESCRIPTION_HASH;
10425 extern const uint8_t TAG_EXPIRY_TIME;
10427 extern const uint8_t TAG_MIN_FINAL_CLTV_EXPIRY;
10429 extern const uint8_t TAG_FALLBACK;
10431 extern const uint8_t TAG_PRIVATE_ROUTE;
10433 extern const uint8_t TAG_PAYMENT_SECRET;
10435 extern const uint8_t TAG_FEATURES;
10437 struct LDKStr _ldk_get_compiled_version(void);
10439 struct LDKStr _ldk_c_bindings_get_compiled_version(void);
10442 * Frees the data buffer, if data_is_owned is set and datalen > 0.
10444 void Transaction_free(struct LDKTransaction _res);
10447 * Convenience function for constructing a new TxOut
10449 struct LDKTxOut TxOut_new(struct LDKCVec_u8Z script_pubkey, uint64_t value);
10452 * Frees the data pointed to by script_pubkey.
10454 void TxOut_free(struct LDKTxOut _res);
10457 * Creates a new TxOut which has the same data as `orig` but with a new script buffer.
10459 struct LDKTxOut TxOut_clone(const struct LDKTxOut *NONNULL_PTR orig);
10462 * Frees the data buffer, if chars_is_owned is set and len > 0.
10464 void Str_free(struct LDKStr _res);
10467 * Creates a new CResult_SecretKeyErrorZ in the success state.
10469 struct LDKCResult_SecretKeyErrorZ CResult_SecretKeyErrorZ_ok(struct LDKSecretKey o);
10472 * Creates a new CResult_SecretKeyErrorZ in the error state.
10474 struct LDKCResult_SecretKeyErrorZ CResult_SecretKeyErrorZ_err(enum LDKSecp256k1Error e);
10477 * Frees any resources used by the CResult_SecretKeyErrorZ.
10479 void CResult_SecretKeyErrorZ_free(struct LDKCResult_SecretKeyErrorZ _res);
10482 * Creates a new CResult_PublicKeyErrorZ in the success state.
10484 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_ok(struct LDKPublicKey o);
10487 * Creates a new CResult_PublicKeyErrorZ in the error state.
10489 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_err(enum LDKSecp256k1Error e);
10492 * Frees any resources used by the CResult_PublicKeyErrorZ.
10494 void CResult_PublicKeyErrorZ_free(struct LDKCResult_PublicKeyErrorZ _res);
10497 * Creates a new CResult_PublicKeyErrorZ which has the same data as `orig`
10498 * but with all dynamically-allocated buffers duplicated in new buffers.
10500 struct LDKCResult_PublicKeyErrorZ CResult_PublicKeyErrorZ_clone(const struct LDKCResult_PublicKeyErrorZ *NONNULL_PTR orig);
10503 * Creates a new CResult_TxCreationKeysDecodeErrorZ in the success state.
10505 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_ok(struct LDKTxCreationKeys o);
10508 * Creates a new CResult_TxCreationKeysDecodeErrorZ in the error state.
10510 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_err(struct LDKDecodeError e);
10513 * Frees any resources used by the CResult_TxCreationKeysDecodeErrorZ.
10515 void CResult_TxCreationKeysDecodeErrorZ_free(struct LDKCResult_TxCreationKeysDecodeErrorZ _res);
10518 * Creates a new CResult_TxCreationKeysDecodeErrorZ which has the same data as `orig`
10519 * but with all dynamically-allocated buffers duplicated in new buffers.
10521 struct LDKCResult_TxCreationKeysDecodeErrorZ CResult_TxCreationKeysDecodeErrorZ_clone(const struct LDKCResult_TxCreationKeysDecodeErrorZ *NONNULL_PTR orig);
10524 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ in the success state.
10526 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_ok(struct LDKChannelPublicKeys o);
10529 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ in the error state.
10531 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_err(struct LDKDecodeError e);
10534 * Frees any resources used by the CResult_ChannelPublicKeysDecodeErrorZ.
10536 void CResult_ChannelPublicKeysDecodeErrorZ_free(struct LDKCResult_ChannelPublicKeysDecodeErrorZ _res);
10539 * Creates a new CResult_ChannelPublicKeysDecodeErrorZ which has the same data as `orig`
10540 * but with all dynamically-allocated buffers duplicated in new buffers.
10542 struct LDKCResult_ChannelPublicKeysDecodeErrorZ CResult_ChannelPublicKeysDecodeErrorZ_clone(const struct LDKCResult_ChannelPublicKeysDecodeErrorZ *NONNULL_PTR orig);
10545 * Creates a new CResult_TxCreationKeysErrorZ in the success state.
10547 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_ok(struct LDKTxCreationKeys o);
10550 * Creates a new CResult_TxCreationKeysErrorZ in the error state.
10552 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_err(enum LDKSecp256k1Error e);
10555 * Frees any resources used by the CResult_TxCreationKeysErrorZ.
10557 void CResult_TxCreationKeysErrorZ_free(struct LDKCResult_TxCreationKeysErrorZ _res);
10560 * Creates a new CResult_TxCreationKeysErrorZ which has the same data as `orig`
10561 * but with all dynamically-allocated buffers duplicated in new buffers.
10563 struct LDKCResult_TxCreationKeysErrorZ CResult_TxCreationKeysErrorZ_clone(const struct LDKCResult_TxCreationKeysErrorZ *NONNULL_PTR orig);
10566 * Constructs a new COption_u32Z containing a u32
10568 struct LDKCOption_u32Z COption_u32Z_some(uint32_t o);
10571 * Constructs a new COption_u32Z containing nothing
10573 struct LDKCOption_u32Z COption_u32Z_none(void);
10576 * Frees any resources associated with the u32, if we are in the Some state
10578 void COption_u32Z_free(struct LDKCOption_u32Z _res);
10581 * Creates a new COption_u32Z which has the same data as `orig`
10582 * but with all dynamically-allocated buffers duplicated in new buffers.
10584 struct LDKCOption_u32Z COption_u32Z_clone(const struct LDKCOption_u32Z *NONNULL_PTR orig);
10587 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ in the success state.
10589 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_ok(struct LDKHTLCOutputInCommitment o);
10592 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ in the error state.
10594 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_err(struct LDKDecodeError e);
10597 * Frees any resources used by the CResult_HTLCOutputInCommitmentDecodeErrorZ.
10599 void CResult_HTLCOutputInCommitmentDecodeErrorZ_free(struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ _res);
10602 * Creates a new CResult_HTLCOutputInCommitmentDecodeErrorZ which has the same data as `orig`
10603 * but with all dynamically-allocated buffers duplicated in new buffers.
10605 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ CResult_HTLCOutputInCommitmentDecodeErrorZ_clone(const struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ *NONNULL_PTR orig);
10608 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ in the success state.
10610 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_ok(struct LDKCounterpartyChannelTransactionParameters o);
10613 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ in the error state.
10615 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_err(struct LDKDecodeError e);
10618 * Frees any resources used by the CResult_CounterpartyChannelTransactionParametersDecodeErrorZ.
10620 void CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_free(struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ _res);
10623 * Creates a new CResult_CounterpartyChannelTransactionParametersDecodeErrorZ which has the same data as `orig`
10624 * but with all dynamically-allocated buffers duplicated in new buffers.
10626 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CResult_CounterpartyChannelTransactionParametersDecodeErrorZ_clone(const struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ *NONNULL_PTR orig);
10629 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ in the success state.
10631 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_ok(struct LDKChannelTransactionParameters o);
10634 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ in the error state.
10636 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_err(struct LDKDecodeError e);
10639 * Frees any resources used by the CResult_ChannelTransactionParametersDecodeErrorZ.
10641 void CResult_ChannelTransactionParametersDecodeErrorZ_free(struct LDKCResult_ChannelTransactionParametersDecodeErrorZ _res);
10644 * Creates a new CResult_ChannelTransactionParametersDecodeErrorZ which has the same data as `orig`
10645 * but with all dynamically-allocated buffers duplicated in new buffers.
10647 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ CResult_ChannelTransactionParametersDecodeErrorZ_clone(const struct LDKCResult_ChannelTransactionParametersDecodeErrorZ *NONNULL_PTR orig);
10650 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10652 void CVec_SignatureZ_free(struct LDKCVec_SignatureZ _res);
10655 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ in the success state.
10657 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_ok(struct LDKHolderCommitmentTransaction o);
10660 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ in the error state.
10662 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
10665 * Frees any resources used by the CResult_HolderCommitmentTransactionDecodeErrorZ.
10667 void CResult_HolderCommitmentTransactionDecodeErrorZ_free(struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ _res);
10670 * Creates a new CResult_HolderCommitmentTransactionDecodeErrorZ which has the same data as `orig`
10671 * but with all dynamically-allocated buffers duplicated in new buffers.
10673 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ CResult_HolderCommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
10676 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ in the success state.
10678 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_ok(struct LDKBuiltCommitmentTransaction o);
10681 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ in the error state.
10683 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
10686 * Frees any resources used by the CResult_BuiltCommitmentTransactionDecodeErrorZ.
10688 void CResult_BuiltCommitmentTransactionDecodeErrorZ_free(struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ _res);
10691 * Creates a new CResult_BuiltCommitmentTransactionDecodeErrorZ which has the same data as `orig`
10692 * but with all dynamically-allocated buffers duplicated in new buffers.
10694 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ CResult_BuiltCommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
10697 * Creates a new CResult_TrustedClosingTransactionNoneZ in the success state.
10699 struct LDKCResult_TrustedClosingTransactionNoneZ CResult_TrustedClosingTransactionNoneZ_ok(struct LDKTrustedClosingTransaction o);
10702 * Creates a new CResult_TrustedClosingTransactionNoneZ in the error state.
10704 struct LDKCResult_TrustedClosingTransactionNoneZ CResult_TrustedClosingTransactionNoneZ_err(void);
10707 * Frees any resources used by the CResult_TrustedClosingTransactionNoneZ.
10709 void CResult_TrustedClosingTransactionNoneZ_free(struct LDKCResult_TrustedClosingTransactionNoneZ _res);
10712 * Creates a new CResult_CommitmentTransactionDecodeErrorZ in the success state.
10714 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_ok(struct LDKCommitmentTransaction o);
10717 * Creates a new CResult_CommitmentTransactionDecodeErrorZ in the error state.
10719 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_err(struct LDKDecodeError e);
10722 * Frees any resources used by the CResult_CommitmentTransactionDecodeErrorZ.
10724 void CResult_CommitmentTransactionDecodeErrorZ_free(struct LDKCResult_CommitmentTransactionDecodeErrorZ _res);
10727 * Creates a new CResult_CommitmentTransactionDecodeErrorZ which has the same data as `orig`
10728 * but with all dynamically-allocated buffers duplicated in new buffers.
10730 struct LDKCResult_CommitmentTransactionDecodeErrorZ CResult_CommitmentTransactionDecodeErrorZ_clone(const struct LDKCResult_CommitmentTransactionDecodeErrorZ *NONNULL_PTR orig);
10733 * Creates a new CResult_TrustedCommitmentTransactionNoneZ in the success state.
10735 struct LDKCResult_TrustedCommitmentTransactionNoneZ CResult_TrustedCommitmentTransactionNoneZ_ok(struct LDKTrustedCommitmentTransaction o);
10738 * Creates a new CResult_TrustedCommitmentTransactionNoneZ in the error state.
10740 struct LDKCResult_TrustedCommitmentTransactionNoneZ CResult_TrustedCommitmentTransactionNoneZ_err(void);
10743 * Frees any resources used by the CResult_TrustedCommitmentTransactionNoneZ.
10745 void CResult_TrustedCommitmentTransactionNoneZ_free(struct LDKCResult_TrustedCommitmentTransactionNoneZ _res);
10748 * Creates a new CResult_CVec_SignatureZNoneZ in the success state.
10750 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_ok(struct LDKCVec_SignatureZ o);
10753 * Creates a new CResult_CVec_SignatureZNoneZ in the error state.
10755 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_err(void);
10758 * Frees any resources used by the CResult_CVec_SignatureZNoneZ.
10760 void CResult_CVec_SignatureZNoneZ_free(struct LDKCResult_CVec_SignatureZNoneZ _res);
10763 * Creates a new CResult_CVec_SignatureZNoneZ which has the same data as `orig`
10764 * but with all dynamically-allocated buffers duplicated in new buffers.
10766 struct LDKCResult_CVec_SignatureZNoneZ CResult_CVec_SignatureZNoneZ_clone(const struct LDKCResult_CVec_SignatureZNoneZ *NONNULL_PTR orig);
10769 * Creates a new CResult_ShutdownScriptDecodeErrorZ in the success state.
10771 struct LDKCResult_ShutdownScriptDecodeErrorZ CResult_ShutdownScriptDecodeErrorZ_ok(struct LDKShutdownScript o);
10774 * Creates a new CResult_ShutdownScriptDecodeErrorZ in the error state.
10776 struct LDKCResult_ShutdownScriptDecodeErrorZ CResult_ShutdownScriptDecodeErrorZ_err(struct LDKDecodeError e);
10779 * Frees any resources used by the CResult_ShutdownScriptDecodeErrorZ.
10781 void CResult_ShutdownScriptDecodeErrorZ_free(struct LDKCResult_ShutdownScriptDecodeErrorZ _res);
10784 * Creates a new CResult_ShutdownScriptDecodeErrorZ which has the same data as `orig`
10785 * but with all dynamically-allocated buffers duplicated in new buffers.
10787 struct LDKCResult_ShutdownScriptDecodeErrorZ CResult_ShutdownScriptDecodeErrorZ_clone(const struct LDKCResult_ShutdownScriptDecodeErrorZ *NONNULL_PTR orig);
10790 * Creates a new CResult_ShutdownScriptInvalidShutdownScriptZ in the success state.
10792 struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ CResult_ShutdownScriptInvalidShutdownScriptZ_ok(struct LDKShutdownScript o);
10795 * Creates a new CResult_ShutdownScriptInvalidShutdownScriptZ in the error state.
10797 struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ CResult_ShutdownScriptInvalidShutdownScriptZ_err(struct LDKInvalidShutdownScript e);
10800 * Frees any resources used by the CResult_ShutdownScriptInvalidShutdownScriptZ.
10802 void CResult_ShutdownScriptInvalidShutdownScriptZ_free(struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ _res);
10805 * Creates a new CResult_NoneErrorZ in the success state.
10807 struct LDKCResult_NoneErrorZ CResult_NoneErrorZ_ok(void);
10810 * Creates a new CResult_NoneErrorZ in the error state.
10812 struct LDKCResult_NoneErrorZ CResult_NoneErrorZ_err(enum LDKIOError e);
10815 * Frees any resources used by the CResult_NoneErrorZ.
10817 void CResult_NoneErrorZ_free(struct LDKCResult_NoneErrorZ _res);
10820 * Creates a new CResult_NoneErrorZ which has the same data as `orig`
10821 * but with all dynamically-allocated buffers duplicated in new buffers.
10823 struct LDKCResult_NoneErrorZ CResult_NoneErrorZ_clone(const struct LDKCResult_NoneErrorZ *NONNULL_PTR orig);
10826 * Creates a new CResult_RouteHopDecodeErrorZ in the success state.
10828 struct LDKCResult_RouteHopDecodeErrorZ CResult_RouteHopDecodeErrorZ_ok(struct LDKRouteHop o);
10831 * Creates a new CResult_RouteHopDecodeErrorZ in the error state.
10833 struct LDKCResult_RouteHopDecodeErrorZ CResult_RouteHopDecodeErrorZ_err(struct LDKDecodeError e);
10836 * Frees any resources used by the CResult_RouteHopDecodeErrorZ.
10838 void CResult_RouteHopDecodeErrorZ_free(struct LDKCResult_RouteHopDecodeErrorZ _res);
10841 * Creates a new CResult_RouteHopDecodeErrorZ which has the same data as `orig`
10842 * but with all dynamically-allocated buffers duplicated in new buffers.
10844 struct LDKCResult_RouteHopDecodeErrorZ CResult_RouteHopDecodeErrorZ_clone(const struct LDKCResult_RouteHopDecodeErrorZ *NONNULL_PTR orig);
10847 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10849 void CVec_RouteHopZ_free(struct LDKCVec_RouteHopZ _res);
10852 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10854 void CVec_CVec_RouteHopZZ_free(struct LDKCVec_CVec_RouteHopZZ _res);
10857 * Creates a new CResult_RouteDecodeErrorZ in the success state.
10859 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_ok(struct LDKRoute o);
10862 * Creates a new CResult_RouteDecodeErrorZ in the error state.
10864 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_err(struct LDKDecodeError e);
10867 * Frees any resources used by the CResult_RouteDecodeErrorZ.
10869 void CResult_RouteDecodeErrorZ_free(struct LDKCResult_RouteDecodeErrorZ _res);
10872 * Creates a new CResult_RouteDecodeErrorZ which has the same data as `orig`
10873 * but with all dynamically-allocated buffers duplicated in new buffers.
10875 struct LDKCResult_RouteDecodeErrorZ CResult_RouteDecodeErrorZ_clone(const struct LDKCResult_RouteDecodeErrorZ *NONNULL_PTR orig);
10878 * Constructs a new COption_u64Z containing a u64
10880 struct LDKCOption_u64Z COption_u64Z_some(uint64_t o);
10883 * Constructs a new COption_u64Z containing nothing
10885 struct LDKCOption_u64Z COption_u64Z_none(void);
10888 * Frees any resources associated with the u64, if we are in the Some state
10890 void COption_u64Z_free(struct LDKCOption_u64Z _res);
10893 * Creates a new COption_u64Z which has the same data as `orig`
10894 * but with all dynamically-allocated buffers duplicated in new buffers.
10896 struct LDKCOption_u64Z COption_u64Z_clone(const struct LDKCOption_u64Z *NONNULL_PTR orig);
10899 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10901 void CVec_ChannelDetailsZ_free(struct LDKCVec_ChannelDetailsZ _res);
10904 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10906 void CVec_RouteHintZ_free(struct LDKCVec_RouteHintZ _res);
10909 * Creates a new CResult_RouteLightningErrorZ in the success state.
10911 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_ok(struct LDKRoute o);
10914 * Creates a new CResult_RouteLightningErrorZ in the error state.
10916 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_err(struct LDKLightningError e);
10919 * Frees any resources used by the CResult_RouteLightningErrorZ.
10921 void CResult_RouteLightningErrorZ_free(struct LDKCResult_RouteLightningErrorZ _res);
10924 * Creates a new CResult_RouteLightningErrorZ which has the same data as `orig`
10925 * but with all dynamically-allocated buffers duplicated in new buffers.
10927 struct LDKCResult_RouteLightningErrorZ CResult_RouteLightningErrorZ_clone(const struct LDKCResult_RouteLightningErrorZ *NONNULL_PTR orig);
10930 * Creates a new CResult_TxOutAccessErrorZ in the success state.
10932 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_ok(struct LDKTxOut o);
10935 * Creates a new CResult_TxOutAccessErrorZ in the error state.
10937 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_err(enum LDKAccessError e);
10940 * Frees any resources used by the CResult_TxOutAccessErrorZ.
10942 void CResult_TxOutAccessErrorZ_free(struct LDKCResult_TxOutAccessErrorZ _res);
10945 * Creates a new CResult_TxOutAccessErrorZ which has the same data as `orig`
10946 * but with all dynamically-allocated buffers duplicated in new buffers.
10948 struct LDKCResult_TxOutAccessErrorZ CResult_TxOutAccessErrorZ_clone(const struct LDKCResult_TxOutAccessErrorZ *NONNULL_PTR orig);
10951 * Creates a new tuple which has the same data as `orig`
10952 * but with all dynamically-allocated buffers duplicated in new buffers.
10954 struct LDKC2Tuple_usizeTransactionZ C2Tuple_usizeTransactionZ_clone(const struct LDKC2Tuple_usizeTransactionZ *NONNULL_PTR orig);
10957 * Creates a new C2Tuple_usizeTransactionZ from the contained elements.
10959 struct LDKC2Tuple_usizeTransactionZ C2Tuple_usizeTransactionZ_new(uintptr_t a, struct LDKTransaction b);
10962 * Frees any resources used by the C2Tuple_usizeTransactionZ.
10964 void C2Tuple_usizeTransactionZ_free(struct LDKC2Tuple_usizeTransactionZ _res);
10967 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10969 void CVec_C2Tuple_usizeTransactionZZ_free(struct LDKCVec_C2Tuple_usizeTransactionZZ _res);
10972 * Frees the buffer pointed to by `data` if `datalen` is non-0.
10974 void CVec_TxidZ_free(struct LDKCVec_TxidZ _res);
10977 * Creates a new CResult_NoneChannelMonitorUpdateErrZ in the success state.
10979 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_ok(void);
10982 * Creates a new CResult_NoneChannelMonitorUpdateErrZ in the error state.
10984 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_err(enum LDKChannelMonitorUpdateErr e);
10987 * Frees any resources used by the CResult_NoneChannelMonitorUpdateErrZ.
10989 void CResult_NoneChannelMonitorUpdateErrZ_free(struct LDKCResult_NoneChannelMonitorUpdateErrZ _res);
10992 * Creates a new CResult_NoneChannelMonitorUpdateErrZ which has the same data as `orig`
10993 * but with all dynamically-allocated buffers duplicated in new buffers.
10995 struct LDKCResult_NoneChannelMonitorUpdateErrZ CResult_NoneChannelMonitorUpdateErrZ_clone(const struct LDKCResult_NoneChannelMonitorUpdateErrZ *NONNULL_PTR orig);
10998 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11000 void CVec_MonitorEventZ_free(struct LDKCVec_MonitorEventZ _res);
11003 * Constructs a new COption_C2Tuple_usizeTransactionZZ containing a crate::c_types::derived::C2Tuple_usizeTransactionZ
11005 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_some(struct LDKC2Tuple_usizeTransactionZ o);
11008 * Constructs a new COption_C2Tuple_usizeTransactionZZ containing nothing
11010 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_none(void);
11013 * Frees any resources associated with the crate::c_types::derived::C2Tuple_usizeTransactionZ, if we are in the Some state
11015 void COption_C2Tuple_usizeTransactionZZ_free(struct LDKCOption_C2Tuple_usizeTransactionZZ _res);
11018 * Creates a new COption_C2Tuple_usizeTransactionZZ which has the same data as `orig`
11019 * but with all dynamically-allocated buffers duplicated in new buffers.
11021 struct LDKCOption_C2Tuple_usizeTransactionZZ COption_C2Tuple_usizeTransactionZZ_clone(const struct LDKCOption_C2Tuple_usizeTransactionZZ *NONNULL_PTR orig);
11024 * Constructs a new COption_NetworkUpdateZ containing a crate::lightning::routing::network_graph::NetworkUpdate
11026 struct LDKCOption_NetworkUpdateZ COption_NetworkUpdateZ_some(struct LDKNetworkUpdate o);
11029 * Constructs a new COption_NetworkUpdateZ containing nothing
11031 struct LDKCOption_NetworkUpdateZ COption_NetworkUpdateZ_none(void);
11034 * Frees any resources associated with the crate::lightning::routing::network_graph::NetworkUpdate, if we are in the Some state
11036 void COption_NetworkUpdateZ_free(struct LDKCOption_NetworkUpdateZ _res);
11039 * Creates a new COption_NetworkUpdateZ which has the same data as `orig`
11040 * but with all dynamically-allocated buffers duplicated in new buffers.
11042 struct LDKCOption_NetworkUpdateZ COption_NetworkUpdateZ_clone(const struct LDKCOption_NetworkUpdateZ *NONNULL_PTR orig);
11045 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11047 void CVec_SpendableOutputDescriptorZ_free(struct LDKCVec_SpendableOutputDescriptorZ _res);
11050 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11052 void CVec_MessageSendEventZ_free(struct LDKCVec_MessageSendEventZ _res);
11055 * Creates a new CResult_InitFeaturesDecodeErrorZ in the success state.
11057 struct LDKCResult_InitFeaturesDecodeErrorZ CResult_InitFeaturesDecodeErrorZ_ok(struct LDKInitFeatures o);
11060 * Creates a new CResult_InitFeaturesDecodeErrorZ in the error state.
11062 struct LDKCResult_InitFeaturesDecodeErrorZ CResult_InitFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
11065 * Frees any resources used by the CResult_InitFeaturesDecodeErrorZ.
11067 void CResult_InitFeaturesDecodeErrorZ_free(struct LDKCResult_InitFeaturesDecodeErrorZ _res);
11070 * Creates a new CResult_NodeFeaturesDecodeErrorZ in the success state.
11072 struct LDKCResult_NodeFeaturesDecodeErrorZ CResult_NodeFeaturesDecodeErrorZ_ok(struct LDKNodeFeatures o);
11075 * Creates a new CResult_NodeFeaturesDecodeErrorZ in the error state.
11077 struct LDKCResult_NodeFeaturesDecodeErrorZ CResult_NodeFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
11080 * Frees any resources used by the CResult_NodeFeaturesDecodeErrorZ.
11082 void CResult_NodeFeaturesDecodeErrorZ_free(struct LDKCResult_NodeFeaturesDecodeErrorZ _res);
11085 * Creates a new CResult_ChannelFeaturesDecodeErrorZ in the success state.
11087 struct LDKCResult_ChannelFeaturesDecodeErrorZ CResult_ChannelFeaturesDecodeErrorZ_ok(struct LDKChannelFeatures o);
11090 * Creates a new CResult_ChannelFeaturesDecodeErrorZ in the error state.
11092 struct LDKCResult_ChannelFeaturesDecodeErrorZ CResult_ChannelFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
11095 * Frees any resources used by the CResult_ChannelFeaturesDecodeErrorZ.
11097 void CResult_ChannelFeaturesDecodeErrorZ_free(struct LDKCResult_ChannelFeaturesDecodeErrorZ _res);
11100 * Creates a new CResult_InvoiceFeaturesDecodeErrorZ in the success state.
11102 struct LDKCResult_InvoiceFeaturesDecodeErrorZ CResult_InvoiceFeaturesDecodeErrorZ_ok(struct LDKInvoiceFeatures o);
11105 * Creates a new CResult_InvoiceFeaturesDecodeErrorZ in the error state.
11107 struct LDKCResult_InvoiceFeaturesDecodeErrorZ CResult_InvoiceFeaturesDecodeErrorZ_err(struct LDKDecodeError e);
11110 * Frees any resources used by the CResult_InvoiceFeaturesDecodeErrorZ.
11112 void CResult_InvoiceFeaturesDecodeErrorZ_free(struct LDKCResult_InvoiceFeaturesDecodeErrorZ _res);
11115 * Creates a new CResult_DelayedPaymentOutputDescriptorDecodeErrorZ in the success state.
11117 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_ok(struct LDKDelayedPaymentOutputDescriptor o);
11120 * Creates a new CResult_DelayedPaymentOutputDescriptorDecodeErrorZ in the error state.
11122 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e);
11125 * Frees any resources used by the CResult_DelayedPaymentOutputDescriptorDecodeErrorZ.
11127 void CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_free(struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ _res);
11130 * Creates a new CResult_DelayedPaymentOutputDescriptorDecodeErrorZ which has the same data as `orig`
11131 * but with all dynamically-allocated buffers duplicated in new buffers.
11133 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ CResult_DelayedPaymentOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ *NONNULL_PTR orig);
11136 * Creates a new CResult_StaticPaymentOutputDescriptorDecodeErrorZ in the success state.
11138 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ CResult_StaticPaymentOutputDescriptorDecodeErrorZ_ok(struct LDKStaticPaymentOutputDescriptor o);
11141 * Creates a new CResult_StaticPaymentOutputDescriptorDecodeErrorZ in the error state.
11143 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ CResult_StaticPaymentOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e);
11146 * Frees any resources used by the CResult_StaticPaymentOutputDescriptorDecodeErrorZ.
11148 void CResult_StaticPaymentOutputDescriptorDecodeErrorZ_free(struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ _res);
11151 * Creates a new CResult_StaticPaymentOutputDescriptorDecodeErrorZ which has the same data as `orig`
11152 * but with all dynamically-allocated buffers duplicated in new buffers.
11154 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ CResult_StaticPaymentOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ *NONNULL_PTR orig);
11157 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ in the success state.
11159 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_ok(struct LDKSpendableOutputDescriptor o);
11162 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ in the error state.
11164 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_err(struct LDKDecodeError e);
11167 * Frees any resources used by the CResult_SpendableOutputDescriptorDecodeErrorZ.
11169 void CResult_SpendableOutputDescriptorDecodeErrorZ_free(struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ _res);
11172 * Creates a new CResult_SpendableOutputDescriptorDecodeErrorZ which has the same data as `orig`
11173 * but with all dynamically-allocated buffers duplicated in new buffers.
11175 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ CResult_SpendableOutputDescriptorDecodeErrorZ_clone(const struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ *NONNULL_PTR orig);
11178 * Creates a new CResult_NoneNoneZ in the success state.
11180 struct LDKCResult_NoneNoneZ CResult_NoneNoneZ_ok(void);
11183 * Creates a new CResult_NoneNoneZ in the error state.
11185 struct LDKCResult_NoneNoneZ CResult_NoneNoneZ_err(void);
11188 * Frees any resources used by the CResult_NoneNoneZ.
11190 void CResult_NoneNoneZ_free(struct LDKCResult_NoneNoneZ _res);
11193 * Creates a new CResult_NoneNoneZ which has the same data as `orig`
11194 * but with all dynamically-allocated buffers duplicated in new buffers.
11196 struct LDKCResult_NoneNoneZ CResult_NoneNoneZ_clone(const struct LDKCResult_NoneNoneZ *NONNULL_PTR orig);
11199 * Creates a new tuple which has the same data as `orig`
11200 * but with all dynamically-allocated buffers duplicated in new buffers.
11202 struct LDKC2Tuple_SignatureCVec_SignatureZZ C2Tuple_SignatureCVec_SignatureZZ_clone(const struct LDKC2Tuple_SignatureCVec_SignatureZZ *NONNULL_PTR orig);
11205 * Creates a new C2Tuple_SignatureCVec_SignatureZZ from the contained elements.
11207 struct LDKC2Tuple_SignatureCVec_SignatureZZ C2Tuple_SignatureCVec_SignatureZZ_new(struct LDKSignature a, struct LDKCVec_SignatureZ b);
11210 * Frees any resources used by the C2Tuple_SignatureCVec_SignatureZZ.
11212 void C2Tuple_SignatureCVec_SignatureZZ_free(struct LDKC2Tuple_SignatureCVec_SignatureZZ _res);
11215 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ in the success state.
11217 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_ok(struct LDKC2Tuple_SignatureCVec_SignatureZZ o);
11220 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ in the error state.
11222 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_err(void);
11225 * Frees any resources used by the CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ.
11227 void CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_free(struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ _res);
11230 * Creates a new CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ which has the same data as `orig`
11231 * but with all dynamically-allocated buffers duplicated in new buffers.
11233 struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ CResult_C2Tuple_SignatureCVec_SignatureZZNoneZ_clone(const struct LDKCResult_C2Tuple_SignatureCVec_SignatureZZNoneZ *NONNULL_PTR orig);
11236 * Creates a new CResult_SignatureNoneZ in the success state.
11238 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_ok(struct LDKSignature o);
11241 * Creates a new CResult_SignatureNoneZ in the error state.
11243 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_err(void);
11246 * Frees any resources used by the CResult_SignatureNoneZ.
11248 void CResult_SignatureNoneZ_free(struct LDKCResult_SignatureNoneZ _res);
11251 * Creates a new CResult_SignatureNoneZ which has the same data as `orig`
11252 * but with all dynamically-allocated buffers duplicated in new buffers.
11254 struct LDKCResult_SignatureNoneZ CResult_SignatureNoneZ_clone(const struct LDKCResult_SignatureNoneZ *NONNULL_PTR orig);
11257 * Creates a new CResult_SignDecodeErrorZ in the success state.
11259 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_ok(struct LDKSign o);
11262 * Creates a new CResult_SignDecodeErrorZ in the error state.
11264 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_err(struct LDKDecodeError e);
11267 * Frees any resources used by the CResult_SignDecodeErrorZ.
11269 void CResult_SignDecodeErrorZ_free(struct LDKCResult_SignDecodeErrorZ _res);
11272 * Creates a new CResult_SignDecodeErrorZ which has the same data as `orig`
11273 * but with all dynamically-allocated buffers duplicated in new buffers.
11275 struct LDKCResult_SignDecodeErrorZ CResult_SignDecodeErrorZ_clone(const struct LDKCResult_SignDecodeErrorZ *NONNULL_PTR orig);
11278 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11280 void CVec_u8Z_free(struct LDKCVec_u8Z _res);
11283 * Creates a new CResult_RecoverableSignatureNoneZ in the success state.
11285 struct LDKCResult_RecoverableSignatureNoneZ CResult_RecoverableSignatureNoneZ_ok(struct LDKRecoverableSignature o);
11288 * Creates a new CResult_RecoverableSignatureNoneZ in the error state.
11290 struct LDKCResult_RecoverableSignatureNoneZ CResult_RecoverableSignatureNoneZ_err(void);
11293 * Frees any resources used by the CResult_RecoverableSignatureNoneZ.
11295 void CResult_RecoverableSignatureNoneZ_free(struct LDKCResult_RecoverableSignatureNoneZ _res);
11298 * Creates a new CResult_RecoverableSignatureNoneZ which has the same data as `orig`
11299 * but with all dynamically-allocated buffers duplicated in new buffers.
11301 struct LDKCResult_RecoverableSignatureNoneZ CResult_RecoverableSignatureNoneZ_clone(const struct LDKCResult_RecoverableSignatureNoneZ *NONNULL_PTR orig);
11304 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11306 void CVec_CVec_u8ZZ_free(struct LDKCVec_CVec_u8ZZ _res);
11309 * Creates a new CResult_CVec_CVec_u8ZZNoneZ in the success state.
11311 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_ok(struct LDKCVec_CVec_u8ZZ o);
11314 * Creates a new CResult_CVec_CVec_u8ZZNoneZ in the error state.
11316 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_err(void);
11319 * Frees any resources used by the CResult_CVec_CVec_u8ZZNoneZ.
11321 void CResult_CVec_CVec_u8ZZNoneZ_free(struct LDKCResult_CVec_CVec_u8ZZNoneZ _res);
11324 * Creates a new CResult_CVec_CVec_u8ZZNoneZ which has the same data as `orig`
11325 * but with all dynamically-allocated buffers duplicated in new buffers.
11327 struct LDKCResult_CVec_CVec_u8ZZNoneZ CResult_CVec_CVec_u8ZZNoneZ_clone(const struct LDKCResult_CVec_CVec_u8ZZNoneZ *NONNULL_PTR orig);
11330 * Creates a new CResult_InMemorySignerDecodeErrorZ in the success state.
11332 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_ok(struct LDKInMemorySigner o);
11335 * Creates a new CResult_InMemorySignerDecodeErrorZ in the error state.
11337 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_err(struct LDKDecodeError e);
11340 * Frees any resources used by the CResult_InMemorySignerDecodeErrorZ.
11342 void CResult_InMemorySignerDecodeErrorZ_free(struct LDKCResult_InMemorySignerDecodeErrorZ _res);
11345 * Creates a new CResult_InMemorySignerDecodeErrorZ which has the same data as `orig`
11346 * but with all dynamically-allocated buffers duplicated in new buffers.
11348 struct LDKCResult_InMemorySignerDecodeErrorZ CResult_InMemorySignerDecodeErrorZ_clone(const struct LDKCResult_InMemorySignerDecodeErrorZ *NONNULL_PTR orig);
11351 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11353 void CVec_TxOutZ_free(struct LDKCVec_TxOutZ _res);
11356 * Creates a new CResult_TransactionNoneZ in the success state.
11358 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_ok(struct LDKTransaction o);
11361 * Creates a new CResult_TransactionNoneZ in the error state.
11363 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_err(void);
11366 * Frees any resources used by the CResult_TransactionNoneZ.
11368 void CResult_TransactionNoneZ_free(struct LDKCResult_TransactionNoneZ _res);
11371 * Creates a new CResult_TransactionNoneZ which has the same data as `orig`
11372 * but with all dynamically-allocated buffers duplicated in new buffers.
11374 struct LDKCResult_TransactionNoneZ CResult_TransactionNoneZ_clone(const struct LDKCResult_TransactionNoneZ *NONNULL_PTR orig);
11377 * Creates a new C2Tuple_BlockHashChannelMonitorZ from the contained elements.
11379 struct LDKC2Tuple_BlockHashChannelMonitorZ C2Tuple_BlockHashChannelMonitorZ_new(struct LDKThirtyTwoBytes a, struct LDKChannelMonitor b);
11382 * Frees any resources used by the C2Tuple_BlockHashChannelMonitorZ.
11384 void C2Tuple_BlockHashChannelMonitorZ_free(struct LDKC2Tuple_BlockHashChannelMonitorZ _res);
11387 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11389 void CVec_C2Tuple_BlockHashChannelMonitorZZ_free(struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ _res);
11392 * Creates a new CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ in the success state.
11394 struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_ok(struct LDKCVec_C2Tuple_BlockHashChannelMonitorZZ o);
11397 * Creates a new CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ in the error state.
11399 struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_err(enum LDKIOError e);
11402 * Frees any resources used by the CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ.
11404 void CResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ_free(struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ _res);
11407 * Creates a new CResult_PaymentIdDecodeErrorZ in the success state.
11409 struct LDKCResult_PaymentIdDecodeErrorZ CResult_PaymentIdDecodeErrorZ_ok(struct LDKPaymentId o);
11412 * Creates a new CResult_PaymentIdDecodeErrorZ in the error state.
11414 struct LDKCResult_PaymentIdDecodeErrorZ CResult_PaymentIdDecodeErrorZ_err(struct LDKDecodeError e);
11417 * Frees any resources used by the CResult_PaymentIdDecodeErrorZ.
11419 void CResult_PaymentIdDecodeErrorZ_free(struct LDKCResult_PaymentIdDecodeErrorZ _res);
11422 * Creates a new CResult_PaymentIdDecodeErrorZ which has the same data as `orig`
11423 * but with all dynamically-allocated buffers duplicated in new buffers.
11425 struct LDKCResult_PaymentIdDecodeErrorZ CResult_PaymentIdDecodeErrorZ_clone(const struct LDKCResult_PaymentIdDecodeErrorZ *NONNULL_PTR orig);
11428 * Constructs a new COption_u16Z containing a u16
11430 struct LDKCOption_u16Z COption_u16Z_some(uint16_t o);
11433 * Constructs a new COption_u16Z containing nothing
11435 struct LDKCOption_u16Z COption_u16Z_none(void);
11438 * Frees any resources associated with the u16, if we are in the Some state
11440 void COption_u16Z_free(struct LDKCOption_u16Z _res);
11443 * Creates a new COption_u16Z which has the same data as `orig`
11444 * but with all dynamically-allocated buffers duplicated in new buffers.
11446 struct LDKCOption_u16Z COption_u16Z_clone(const struct LDKCOption_u16Z *NONNULL_PTR orig);
11449 * Creates a new CResult_NoneAPIErrorZ in the success state.
11451 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_ok(void);
11454 * Creates a new CResult_NoneAPIErrorZ in the error state.
11456 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_err(struct LDKAPIError e);
11459 * Frees any resources used by the CResult_NoneAPIErrorZ.
11461 void CResult_NoneAPIErrorZ_free(struct LDKCResult_NoneAPIErrorZ _res);
11464 * Creates a new CResult_NoneAPIErrorZ which has the same data as `orig`
11465 * but with all dynamically-allocated buffers duplicated in new buffers.
11467 struct LDKCResult_NoneAPIErrorZ CResult_NoneAPIErrorZ_clone(const struct LDKCResult_NoneAPIErrorZ *NONNULL_PTR orig);
11470 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11472 void CVec_CResult_NoneAPIErrorZZ_free(struct LDKCVec_CResult_NoneAPIErrorZZ _res);
11475 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11477 void CVec_APIErrorZ_free(struct LDKCVec_APIErrorZ _res);
11480 * Creates a new CResult__u832APIErrorZ in the success state.
11482 struct LDKCResult__u832APIErrorZ CResult__u832APIErrorZ_ok(struct LDKThirtyTwoBytes o);
11485 * Creates a new CResult__u832APIErrorZ in the error state.
11487 struct LDKCResult__u832APIErrorZ CResult__u832APIErrorZ_err(struct LDKAPIError e);
11490 * Frees any resources used by the CResult__u832APIErrorZ.
11492 void CResult__u832APIErrorZ_free(struct LDKCResult__u832APIErrorZ _res);
11495 * Creates a new CResult__u832APIErrorZ which has the same data as `orig`
11496 * but with all dynamically-allocated buffers duplicated in new buffers.
11498 struct LDKCResult__u832APIErrorZ CResult__u832APIErrorZ_clone(const struct LDKCResult__u832APIErrorZ *NONNULL_PTR orig);
11501 * Creates a new CResult_PaymentIdPaymentSendFailureZ in the success state.
11503 struct LDKCResult_PaymentIdPaymentSendFailureZ CResult_PaymentIdPaymentSendFailureZ_ok(struct LDKPaymentId o);
11506 * Creates a new CResult_PaymentIdPaymentSendFailureZ in the error state.
11508 struct LDKCResult_PaymentIdPaymentSendFailureZ CResult_PaymentIdPaymentSendFailureZ_err(struct LDKPaymentSendFailure e);
11511 * Frees any resources used by the CResult_PaymentIdPaymentSendFailureZ.
11513 void CResult_PaymentIdPaymentSendFailureZ_free(struct LDKCResult_PaymentIdPaymentSendFailureZ _res);
11516 * Creates a new CResult_PaymentIdPaymentSendFailureZ which has the same data as `orig`
11517 * but with all dynamically-allocated buffers duplicated in new buffers.
11519 struct LDKCResult_PaymentIdPaymentSendFailureZ CResult_PaymentIdPaymentSendFailureZ_clone(const struct LDKCResult_PaymentIdPaymentSendFailureZ *NONNULL_PTR orig);
11522 * Creates a new CResult_NonePaymentSendFailureZ in the success state.
11524 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_ok(void);
11527 * Creates a new CResult_NonePaymentSendFailureZ in the error state.
11529 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_err(struct LDKPaymentSendFailure e);
11532 * Frees any resources used by the CResult_NonePaymentSendFailureZ.
11534 void CResult_NonePaymentSendFailureZ_free(struct LDKCResult_NonePaymentSendFailureZ _res);
11537 * Creates a new CResult_NonePaymentSendFailureZ which has the same data as `orig`
11538 * but with all dynamically-allocated buffers duplicated in new buffers.
11540 struct LDKCResult_NonePaymentSendFailureZ CResult_NonePaymentSendFailureZ_clone(const struct LDKCResult_NonePaymentSendFailureZ *NONNULL_PTR orig);
11543 * Creates a new tuple which has the same data as `orig`
11544 * but with all dynamically-allocated buffers duplicated in new buffers.
11546 struct LDKC2Tuple_PaymentHashPaymentIdZ C2Tuple_PaymentHashPaymentIdZ_clone(const struct LDKC2Tuple_PaymentHashPaymentIdZ *NONNULL_PTR orig);
11549 * Creates a new C2Tuple_PaymentHashPaymentIdZ from the contained elements.
11551 struct LDKC2Tuple_PaymentHashPaymentIdZ C2Tuple_PaymentHashPaymentIdZ_new(struct LDKThirtyTwoBytes a, struct LDKPaymentId b);
11554 * Frees any resources used by the C2Tuple_PaymentHashPaymentIdZ.
11556 void C2Tuple_PaymentHashPaymentIdZ_free(struct LDKC2Tuple_PaymentHashPaymentIdZ _res);
11559 * Creates a new CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ in the success state.
11561 struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ_ok(struct LDKC2Tuple_PaymentHashPaymentIdZ o);
11564 * Creates a new CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ in the error state.
11566 struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ_err(struct LDKPaymentSendFailure e);
11569 * Frees any resources used by the CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ.
11571 void CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ_free(struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ _res);
11574 * Creates a new CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ which has the same data as `orig`
11575 * but with all dynamically-allocated buffers duplicated in new buffers.
11577 struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ CResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ_clone(const struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ *NONNULL_PTR orig);
11580 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11582 void CVec_NetAddressZ_free(struct LDKCVec_NetAddressZ _res);
11585 * Creates a new tuple which has the same data as `orig`
11586 * but with all dynamically-allocated buffers duplicated in new buffers.
11588 struct LDKC2Tuple_PaymentHashPaymentSecretZ C2Tuple_PaymentHashPaymentSecretZ_clone(const struct LDKC2Tuple_PaymentHashPaymentSecretZ *NONNULL_PTR orig);
11591 * Creates a new C2Tuple_PaymentHashPaymentSecretZ from the contained elements.
11593 struct LDKC2Tuple_PaymentHashPaymentSecretZ C2Tuple_PaymentHashPaymentSecretZ_new(struct LDKThirtyTwoBytes a, struct LDKThirtyTwoBytes b);
11596 * Frees any resources used by the C2Tuple_PaymentHashPaymentSecretZ.
11598 void C2Tuple_PaymentHashPaymentSecretZ_free(struct LDKC2Tuple_PaymentHashPaymentSecretZ _res);
11601 * Creates a new CResult_PaymentSecretAPIErrorZ in the success state.
11603 struct LDKCResult_PaymentSecretAPIErrorZ CResult_PaymentSecretAPIErrorZ_ok(struct LDKThirtyTwoBytes o);
11606 * Creates a new CResult_PaymentSecretAPIErrorZ in the error state.
11608 struct LDKCResult_PaymentSecretAPIErrorZ CResult_PaymentSecretAPIErrorZ_err(struct LDKAPIError e);
11611 * Frees any resources used by the CResult_PaymentSecretAPIErrorZ.
11613 void CResult_PaymentSecretAPIErrorZ_free(struct LDKCResult_PaymentSecretAPIErrorZ _res);
11616 * Creates a new CResult_PaymentSecretAPIErrorZ which has the same data as `orig`
11617 * but with all dynamically-allocated buffers duplicated in new buffers.
11619 struct LDKCResult_PaymentSecretAPIErrorZ CResult_PaymentSecretAPIErrorZ_clone(const struct LDKCResult_PaymentSecretAPIErrorZ *NONNULL_PTR orig);
11622 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11624 void CVec_ChannelMonitorZ_free(struct LDKCVec_ChannelMonitorZ _res);
11627 * Creates a new C2Tuple_BlockHashChannelManagerZ from the contained elements.
11629 struct LDKC2Tuple_BlockHashChannelManagerZ C2Tuple_BlockHashChannelManagerZ_new(struct LDKThirtyTwoBytes a, struct LDKChannelManager b);
11632 * Frees any resources used by the C2Tuple_BlockHashChannelManagerZ.
11634 void C2Tuple_BlockHashChannelManagerZ_free(struct LDKC2Tuple_BlockHashChannelManagerZ _res);
11637 * Creates a new CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ in the success state.
11639 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_ok(struct LDKC2Tuple_BlockHashChannelManagerZ o);
11642 * Creates a new CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ in the error state.
11644 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_err(struct LDKDecodeError e);
11647 * Frees any resources used by the CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ.
11649 void CResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ_free(struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ _res);
11652 * Creates a new CResult_ChannelConfigDecodeErrorZ in the success state.
11654 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_ok(struct LDKChannelConfig o);
11657 * Creates a new CResult_ChannelConfigDecodeErrorZ in the error state.
11659 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_err(struct LDKDecodeError e);
11662 * Frees any resources used by the CResult_ChannelConfigDecodeErrorZ.
11664 void CResult_ChannelConfigDecodeErrorZ_free(struct LDKCResult_ChannelConfigDecodeErrorZ _res);
11667 * Creates a new CResult_ChannelConfigDecodeErrorZ which has the same data as `orig`
11668 * but with all dynamically-allocated buffers duplicated in new buffers.
11670 struct LDKCResult_ChannelConfigDecodeErrorZ CResult_ChannelConfigDecodeErrorZ_clone(const struct LDKCResult_ChannelConfigDecodeErrorZ *NONNULL_PTR orig);
11673 * Creates a new CResult_OutPointDecodeErrorZ in the success state.
11675 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_ok(struct LDKOutPoint o);
11678 * Creates a new CResult_OutPointDecodeErrorZ in the error state.
11680 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_err(struct LDKDecodeError e);
11683 * Frees any resources used by the CResult_OutPointDecodeErrorZ.
11685 void CResult_OutPointDecodeErrorZ_free(struct LDKCResult_OutPointDecodeErrorZ _res);
11688 * Creates a new CResult_OutPointDecodeErrorZ which has the same data as `orig`
11689 * but with all dynamically-allocated buffers duplicated in new buffers.
11691 struct LDKCResult_OutPointDecodeErrorZ CResult_OutPointDecodeErrorZ_clone(const struct LDKCResult_OutPointDecodeErrorZ *NONNULL_PTR orig);
11694 * Constructs a new COption_TypeZ containing a crate::lightning::ln::wire::Type
11696 struct LDKCOption_TypeZ COption_TypeZ_some(struct LDKType o);
11699 * Constructs a new COption_TypeZ containing nothing
11701 struct LDKCOption_TypeZ COption_TypeZ_none(void);
11704 * Frees any resources associated with the crate::lightning::ln::wire::Type, if we are in the Some state
11706 void COption_TypeZ_free(struct LDKCOption_TypeZ _res);
11709 * Creates a new CResult_COption_TypeZDecodeErrorZ in the success state.
11711 struct LDKCResult_COption_TypeZDecodeErrorZ CResult_COption_TypeZDecodeErrorZ_ok(struct LDKCOption_TypeZ o);
11714 * Creates a new CResult_COption_TypeZDecodeErrorZ in the error state.
11716 struct LDKCResult_COption_TypeZDecodeErrorZ CResult_COption_TypeZDecodeErrorZ_err(struct LDKDecodeError e);
11719 * Frees any resources used by the CResult_COption_TypeZDecodeErrorZ.
11721 void CResult_COption_TypeZDecodeErrorZ_free(struct LDKCResult_COption_TypeZDecodeErrorZ _res);
11724 * Creates a new CResult_SiPrefixNoneZ in the success state.
11726 struct LDKCResult_SiPrefixNoneZ CResult_SiPrefixNoneZ_ok(enum LDKSiPrefix o);
11729 * Creates a new CResult_SiPrefixNoneZ in the error state.
11731 struct LDKCResult_SiPrefixNoneZ CResult_SiPrefixNoneZ_err(void);
11734 * Frees any resources used by the CResult_SiPrefixNoneZ.
11736 void CResult_SiPrefixNoneZ_free(struct LDKCResult_SiPrefixNoneZ _res);
11739 * Creates a new CResult_SiPrefixNoneZ which has the same data as `orig`
11740 * but with all dynamically-allocated buffers duplicated in new buffers.
11742 struct LDKCResult_SiPrefixNoneZ CResult_SiPrefixNoneZ_clone(const struct LDKCResult_SiPrefixNoneZ *NONNULL_PTR orig);
11745 * Creates a new CResult_InvoiceNoneZ in the success state.
11747 struct LDKCResult_InvoiceNoneZ CResult_InvoiceNoneZ_ok(struct LDKInvoice o);
11750 * Creates a new CResult_InvoiceNoneZ in the error state.
11752 struct LDKCResult_InvoiceNoneZ CResult_InvoiceNoneZ_err(void);
11755 * Frees any resources used by the CResult_InvoiceNoneZ.
11757 void CResult_InvoiceNoneZ_free(struct LDKCResult_InvoiceNoneZ _res);
11760 * Creates a new CResult_InvoiceNoneZ which has the same data as `orig`
11761 * but with all dynamically-allocated buffers duplicated in new buffers.
11763 struct LDKCResult_InvoiceNoneZ CResult_InvoiceNoneZ_clone(const struct LDKCResult_InvoiceNoneZ *NONNULL_PTR orig);
11766 * Creates a new CResult_SignedRawInvoiceNoneZ in the success state.
11768 struct LDKCResult_SignedRawInvoiceNoneZ CResult_SignedRawInvoiceNoneZ_ok(struct LDKSignedRawInvoice o);
11771 * Creates a new CResult_SignedRawInvoiceNoneZ in the error state.
11773 struct LDKCResult_SignedRawInvoiceNoneZ CResult_SignedRawInvoiceNoneZ_err(void);
11776 * Frees any resources used by the CResult_SignedRawInvoiceNoneZ.
11778 void CResult_SignedRawInvoiceNoneZ_free(struct LDKCResult_SignedRawInvoiceNoneZ _res);
11781 * Creates a new CResult_SignedRawInvoiceNoneZ which has the same data as `orig`
11782 * but with all dynamically-allocated buffers duplicated in new buffers.
11784 struct LDKCResult_SignedRawInvoiceNoneZ CResult_SignedRawInvoiceNoneZ_clone(const struct LDKCResult_SignedRawInvoiceNoneZ *NONNULL_PTR orig);
11787 * Creates a new tuple which has the same data as `orig`
11788 * but with all dynamically-allocated buffers duplicated in new buffers.
11790 struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ C3Tuple_RawInvoice_u832InvoiceSignatureZ_clone(const struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ *NONNULL_PTR orig);
11793 * Creates a new C3Tuple_RawInvoice_u832InvoiceSignatureZ from the contained elements.
11795 struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ C3Tuple_RawInvoice_u832InvoiceSignatureZ_new(struct LDKRawInvoice a, struct LDKThirtyTwoBytes b, struct LDKInvoiceSignature c);
11798 * Frees any resources used by the C3Tuple_RawInvoice_u832InvoiceSignatureZ.
11800 void C3Tuple_RawInvoice_u832InvoiceSignatureZ_free(struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ _res);
11803 * Creates a new CResult_PayeePubKeyErrorZ in the success state.
11805 struct LDKCResult_PayeePubKeyErrorZ CResult_PayeePubKeyErrorZ_ok(struct LDKPayeePubKey o);
11808 * Creates a new CResult_PayeePubKeyErrorZ in the error state.
11810 struct LDKCResult_PayeePubKeyErrorZ CResult_PayeePubKeyErrorZ_err(enum LDKSecp256k1Error e);
11813 * Frees any resources used by the CResult_PayeePubKeyErrorZ.
11815 void CResult_PayeePubKeyErrorZ_free(struct LDKCResult_PayeePubKeyErrorZ _res);
11818 * Creates a new CResult_PayeePubKeyErrorZ which has the same data as `orig`
11819 * but with all dynamically-allocated buffers duplicated in new buffers.
11821 struct LDKCResult_PayeePubKeyErrorZ CResult_PayeePubKeyErrorZ_clone(const struct LDKCResult_PayeePubKeyErrorZ *NONNULL_PTR orig);
11824 * Frees the buffer pointed to by `data` if `datalen` is non-0.
11826 void CVec_PrivateRouteZ_free(struct LDKCVec_PrivateRouteZ _res);
11829 * Creates a new CResult_PositiveTimestampCreationErrorZ in the success state.
11831 struct LDKCResult_PositiveTimestampCreationErrorZ CResult_PositiveTimestampCreationErrorZ_ok(struct LDKPositiveTimestamp o);
11834 * Creates a new CResult_PositiveTimestampCreationErrorZ in the error state.
11836 struct LDKCResult_PositiveTimestampCreationErrorZ CResult_PositiveTimestampCreationErrorZ_err(enum LDKCreationError e);
11839 * Frees any resources used by the CResult_PositiveTimestampCreationErrorZ.
11841 void CResult_PositiveTimestampCreationErrorZ_free(struct LDKCResult_PositiveTimestampCreationErrorZ _res);
11844 * Creates a new CResult_PositiveTimestampCreationErrorZ which has the same data as `orig`
11845 * but with all dynamically-allocated buffers duplicated in new buffers.
11847 struct LDKCResult_PositiveTimestampCreationErrorZ CResult_PositiveTimestampCreationErrorZ_clone(const struct LDKCResult_PositiveTimestampCreationErrorZ *NONNULL_PTR orig);
11850 * Creates a new CResult_NoneSemanticErrorZ in the success state.
11852 struct LDKCResult_NoneSemanticErrorZ CResult_NoneSemanticErrorZ_ok(void);
11855 * Creates a new CResult_NoneSemanticErrorZ in the error state.
11857 struct LDKCResult_NoneSemanticErrorZ CResult_NoneSemanticErrorZ_err(enum LDKSemanticError e);
11860 * Frees any resources used by the CResult_NoneSemanticErrorZ.
11862 void CResult_NoneSemanticErrorZ_free(struct LDKCResult_NoneSemanticErrorZ _res);
11865 * Creates a new CResult_NoneSemanticErrorZ which has the same data as `orig`
11866 * but with all dynamically-allocated buffers duplicated in new buffers.
11868 struct LDKCResult_NoneSemanticErrorZ CResult_NoneSemanticErrorZ_clone(const struct LDKCResult_NoneSemanticErrorZ *NONNULL_PTR orig);
11871 * Creates a new CResult_InvoiceSemanticErrorZ in the success state.
11873 struct LDKCResult_InvoiceSemanticErrorZ CResult_InvoiceSemanticErrorZ_ok(struct LDKInvoice o);
11876 * Creates a new CResult_InvoiceSemanticErrorZ in the error state.
11878 struct LDKCResult_InvoiceSemanticErrorZ CResult_InvoiceSemanticErrorZ_err(enum LDKSemanticError e);
11881 * Frees any resources used by the CResult_InvoiceSemanticErrorZ.
11883 void CResult_InvoiceSemanticErrorZ_free(struct LDKCResult_InvoiceSemanticErrorZ _res);
11886 * Creates a new CResult_InvoiceSemanticErrorZ which has the same data as `orig`
11887 * but with all dynamically-allocated buffers duplicated in new buffers.
11889 struct LDKCResult_InvoiceSemanticErrorZ CResult_InvoiceSemanticErrorZ_clone(const struct LDKCResult_InvoiceSemanticErrorZ *NONNULL_PTR orig);
11892 * Creates a new CResult_DescriptionCreationErrorZ in the success state.
11894 struct LDKCResult_DescriptionCreationErrorZ CResult_DescriptionCreationErrorZ_ok(struct LDKDescription o);
11897 * Creates a new CResult_DescriptionCreationErrorZ in the error state.
11899 struct LDKCResult_DescriptionCreationErrorZ CResult_DescriptionCreationErrorZ_err(enum LDKCreationError e);
11902 * Frees any resources used by the CResult_DescriptionCreationErrorZ.
11904 void CResult_DescriptionCreationErrorZ_free(struct LDKCResult_DescriptionCreationErrorZ _res);
11907 * Creates a new CResult_DescriptionCreationErrorZ which has the same data as `orig`
11908 * but with all dynamically-allocated buffers duplicated in new buffers.
11910 struct LDKCResult_DescriptionCreationErrorZ CResult_DescriptionCreationErrorZ_clone(const struct LDKCResult_DescriptionCreationErrorZ *NONNULL_PTR orig);
11913 * Creates a new CResult_ExpiryTimeCreationErrorZ in the success state.
11915 struct LDKCResult_ExpiryTimeCreationErrorZ CResult_ExpiryTimeCreationErrorZ_ok(struct LDKExpiryTime o);
11918 * Creates a new CResult_ExpiryTimeCreationErrorZ in the error state.
11920 struct LDKCResult_ExpiryTimeCreationErrorZ CResult_ExpiryTimeCreationErrorZ_err(enum LDKCreationError e);
11923 * Frees any resources used by the CResult_ExpiryTimeCreationErrorZ.
11925 void CResult_ExpiryTimeCreationErrorZ_free(struct LDKCResult_ExpiryTimeCreationErrorZ _res);
11928 * Creates a new CResult_ExpiryTimeCreationErrorZ which has the same data as `orig`
11929 * but with all dynamically-allocated buffers duplicated in new buffers.
11931 struct LDKCResult_ExpiryTimeCreationErrorZ CResult_ExpiryTimeCreationErrorZ_clone(const struct LDKCResult_ExpiryTimeCreationErrorZ *NONNULL_PTR orig);
11934 * Creates a new CResult_PrivateRouteCreationErrorZ in the success state.
11936 struct LDKCResult_PrivateRouteCreationErrorZ CResult_PrivateRouteCreationErrorZ_ok(struct LDKPrivateRoute o);
11939 * Creates a new CResult_PrivateRouteCreationErrorZ in the error state.
11941 struct LDKCResult_PrivateRouteCreationErrorZ CResult_PrivateRouteCreationErrorZ_err(enum LDKCreationError e);
11944 * Frees any resources used by the CResult_PrivateRouteCreationErrorZ.
11946 void CResult_PrivateRouteCreationErrorZ_free(struct LDKCResult_PrivateRouteCreationErrorZ _res);
11949 * Creates a new CResult_PrivateRouteCreationErrorZ which has the same data as `orig`
11950 * but with all dynamically-allocated buffers duplicated in new buffers.
11952 struct LDKCResult_PrivateRouteCreationErrorZ CResult_PrivateRouteCreationErrorZ_clone(const struct LDKCResult_PrivateRouteCreationErrorZ *NONNULL_PTR orig);
11955 * Creates a new CResult_StringErrorZ in the success state.
11957 struct LDKCResult_StringErrorZ CResult_StringErrorZ_ok(struct LDKStr o);
11960 * Creates a new CResult_StringErrorZ in the error state.
11962 struct LDKCResult_StringErrorZ CResult_StringErrorZ_err(enum LDKSecp256k1Error e);
11965 * Frees any resources used by the CResult_StringErrorZ.
11967 void CResult_StringErrorZ_free(struct LDKCResult_StringErrorZ _res);
11970 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ in the success state.
11972 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_ok(struct LDKChannelMonitorUpdate o);
11975 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ in the error state.
11977 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_err(struct LDKDecodeError e);
11980 * Frees any resources used by the CResult_ChannelMonitorUpdateDecodeErrorZ.
11982 void CResult_ChannelMonitorUpdateDecodeErrorZ_free(struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ _res);
11985 * Creates a new CResult_ChannelMonitorUpdateDecodeErrorZ which has the same data as `orig`
11986 * but with all dynamically-allocated buffers duplicated in new buffers.
11988 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ CResult_ChannelMonitorUpdateDecodeErrorZ_clone(const struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ *NONNULL_PTR orig);
11991 * Creates a new CResult_HTLCUpdateDecodeErrorZ in the success state.
11993 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_ok(struct LDKHTLCUpdate o);
11996 * Creates a new CResult_HTLCUpdateDecodeErrorZ in the error state.
11998 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_err(struct LDKDecodeError e);
12001 * Frees any resources used by the CResult_HTLCUpdateDecodeErrorZ.
12003 void CResult_HTLCUpdateDecodeErrorZ_free(struct LDKCResult_HTLCUpdateDecodeErrorZ _res);
12006 * Creates a new CResult_HTLCUpdateDecodeErrorZ which has the same data as `orig`
12007 * but with all dynamically-allocated buffers duplicated in new buffers.
12009 struct LDKCResult_HTLCUpdateDecodeErrorZ CResult_HTLCUpdateDecodeErrorZ_clone(const struct LDKCResult_HTLCUpdateDecodeErrorZ *NONNULL_PTR orig);
12012 * Creates a new CResult_NoneMonitorUpdateErrorZ in the success state.
12014 struct LDKCResult_NoneMonitorUpdateErrorZ CResult_NoneMonitorUpdateErrorZ_ok(void);
12017 * Creates a new CResult_NoneMonitorUpdateErrorZ in the error state.
12019 struct LDKCResult_NoneMonitorUpdateErrorZ CResult_NoneMonitorUpdateErrorZ_err(struct LDKMonitorUpdateError e);
12022 * Frees any resources used by the CResult_NoneMonitorUpdateErrorZ.
12024 void CResult_NoneMonitorUpdateErrorZ_free(struct LDKCResult_NoneMonitorUpdateErrorZ _res);
12027 * Creates a new CResult_NoneMonitorUpdateErrorZ which has the same data as `orig`
12028 * but with all dynamically-allocated buffers duplicated in new buffers.
12030 struct LDKCResult_NoneMonitorUpdateErrorZ CResult_NoneMonitorUpdateErrorZ_clone(const struct LDKCResult_NoneMonitorUpdateErrorZ *NONNULL_PTR orig);
12033 * Creates a new tuple which has the same data as `orig`
12034 * but with all dynamically-allocated buffers duplicated in new buffers.
12036 struct LDKC2Tuple_OutPointScriptZ C2Tuple_OutPointScriptZ_clone(const struct LDKC2Tuple_OutPointScriptZ *NONNULL_PTR orig);
12039 * Creates a new C2Tuple_OutPointScriptZ from the contained elements.
12041 struct LDKC2Tuple_OutPointScriptZ C2Tuple_OutPointScriptZ_new(struct LDKOutPoint a, struct LDKCVec_u8Z b);
12044 * Frees any resources used by the C2Tuple_OutPointScriptZ.
12046 void C2Tuple_OutPointScriptZ_free(struct LDKC2Tuple_OutPointScriptZ _res);
12049 * Creates a new tuple which has the same data as `orig`
12050 * but with all dynamically-allocated buffers duplicated in new buffers.
12052 struct LDKC2Tuple_u32ScriptZ C2Tuple_u32ScriptZ_clone(const struct LDKC2Tuple_u32ScriptZ *NONNULL_PTR orig);
12055 * Creates a new C2Tuple_u32ScriptZ from the contained elements.
12057 struct LDKC2Tuple_u32ScriptZ C2Tuple_u32ScriptZ_new(uint32_t a, struct LDKCVec_u8Z b);
12060 * Frees any resources used by the C2Tuple_u32ScriptZ.
12062 void C2Tuple_u32ScriptZ_free(struct LDKC2Tuple_u32ScriptZ _res);
12065 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12067 void CVec_C2Tuple_u32ScriptZZ_free(struct LDKCVec_C2Tuple_u32ScriptZZ _res);
12070 * Creates a new tuple which has the same data as `orig`
12071 * but with all dynamically-allocated buffers duplicated in new buffers.
12073 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_clone(const struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ *NONNULL_PTR orig);
12076 * Creates a new C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ from the contained elements.
12078 struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_new(struct LDKThirtyTwoBytes a, struct LDKCVec_C2Tuple_u32ScriptZZ b);
12081 * Frees any resources used by the C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ.
12083 void C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ_free(struct LDKC2Tuple_TxidCVec_C2Tuple_u32ScriptZZZ _res);
12086 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12088 void CVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ_free(struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ _res);
12091 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12093 void CVec_EventZ_free(struct LDKCVec_EventZ _res);
12096 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12098 void CVec_TransactionZ_free(struct LDKCVec_TransactionZ _res);
12101 * Creates a new tuple which has the same data as `orig`
12102 * but with all dynamically-allocated buffers duplicated in new buffers.
12104 struct LDKC2Tuple_u32TxOutZ C2Tuple_u32TxOutZ_clone(const struct LDKC2Tuple_u32TxOutZ *NONNULL_PTR orig);
12107 * Creates a new C2Tuple_u32TxOutZ from the contained elements.
12109 struct LDKC2Tuple_u32TxOutZ C2Tuple_u32TxOutZ_new(uint32_t a, struct LDKTxOut b);
12112 * Frees any resources used by the C2Tuple_u32TxOutZ.
12114 void C2Tuple_u32TxOutZ_free(struct LDKC2Tuple_u32TxOutZ _res);
12117 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12119 void CVec_C2Tuple_u32TxOutZZ_free(struct LDKCVec_C2Tuple_u32TxOutZZ _res);
12122 * Creates a new tuple which has the same data as `orig`
12123 * but with all dynamically-allocated buffers duplicated in new buffers.
12125 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_clone(const struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ *NONNULL_PTR orig);
12128 * Creates a new C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ from the contained elements.
12130 struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_new(struct LDKThirtyTwoBytes a, struct LDKCVec_C2Tuple_u32TxOutZZ b);
12133 * Frees any resources used by the C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ.
12135 void C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ_free(struct LDKC2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ _res);
12138 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12140 void CVec_TransactionOutputsZ_free(struct LDKCVec_TransactionOutputsZ _res);
12143 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12145 void CVec_BalanceZ_free(struct LDKCVec_BalanceZ _res);
12148 * Creates a new CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ in the success state.
12150 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_ok(struct LDKC2Tuple_BlockHashChannelMonitorZ o);
12153 * Creates a new CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ in the error state.
12155 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_err(struct LDKDecodeError e);
12158 * Frees any resources used by the CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ.
12160 void CResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ_free(struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ _res);
12163 * Creates a new CResult_NoneLightningErrorZ in the success state.
12165 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_ok(void);
12168 * Creates a new CResult_NoneLightningErrorZ in the error state.
12170 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_err(struct LDKLightningError e);
12173 * Frees any resources used by the CResult_NoneLightningErrorZ.
12175 void CResult_NoneLightningErrorZ_free(struct LDKCResult_NoneLightningErrorZ _res);
12178 * Creates a new CResult_NoneLightningErrorZ which has the same data as `orig`
12179 * but with all dynamically-allocated buffers duplicated in new buffers.
12181 struct LDKCResult_NoneLightningErrorZ CResult_NoneLightningErrorZ_clone(const struct LDKCResult_NoneLightningErrorZ *NONNULL_PTR orig);
12184 * Creates a new C2Tuple_PublicKeyTypeZ from the contained elements.
12186 struct LDKC2Tuple_PublicKeyTypeZ C2Tuple_PublicKeyTypeZ_new(struct LDKPublicKey a, struct LDKType b);
12189 * Frees any resources used by the C2Tuple_PublicKeyTypeZ.
12191 void C2Tuple_PublicKeyTypeZ_free(struct LDKC2Tuple_PublicKeyTypeZ _res);
12194 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12196 void CVec_C2Tuple_PublicKeyTypeZZ_free(struct LDKCVec_C2Tuple_PublicKeyTypeZZ _res);
12199 * Creates a new CResult_boolLightningErrorZ in the success state.
12201 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_ok(bool o);
12204 * Creates a new CResult_boolLightningErrorZ in the error state.
12206 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_err(struct LDKLightningError e);
12209 * Frees any resources used by the CResult_boolLightningErrorZ.
12211 void CResult_boolLightningErrorZ_free(struct LDKCResult_boolLightningErrorZ _res);
12214 * Creates a new CResult_boolLightningErrorZ which has the same data as `orig`
12215 * but with all dynamically-allocated buffers duplicated in new buffers.
12217 struct LDKCResult_boolLightningErrorZ CResult_boolLightningErrorZ_clone(const struct LDKCResult_boolLightningErrorZ *NONNULL_PTR orig);
12220 * Creates a new tuple which has the same data as `orig`
12221 * but with all dynamically-allocated buffers duplicated in new buffers.
12223 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_clone(const struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ *NONNULL_PTR orig);
12226 * Creates a new C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ from the contained elements.
12228 struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_new(struct LDKChannelAnnouncement a, struct LDKChannelUpdate b, struct LDKChannelUpdate c);
12231 * Frees any resources used by the C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ.
12233 void C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ_free(struct LDKC3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZ _res);
12236 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12238 void CVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ_free(struct LDKCVec_C3Tuple_ChannelAnnouncementChannelUpdateChannelUpdateZZ _res);
12241 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12243 void CVec_NodeAnnouncementZ_free(struct LDKCVec_NodeAnnouncementZ _res);
12246 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12248 void CVec_PublicKeyZ_free(struct LDKCVec_PublicKeyZ _res);
12251 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ in the success state.
12253 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_ok(struct LDKCVec_u8Z o);
12256 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ in the error state.
12258 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_err(struct LDKPeerHandleError e);
12261 * Frees any resources used by the CResult_CVec_u8ZPeerHandleErrorZ.
12263 void CResult_CVec_u8ZPeerHandleErrorZ_free(struct LDKCResult_CVec_u8ZPeerHandleErrorZ _res);
12266 * Creates a new CResult_CVec_u8ZPeerHandleErrorZ which has the same data as `orig`
12267 * but with all dynamically-allocated buffers duplicated in new buffers.
12269 struct LDKCResult_CVec_u8ZPeerHandleErrorZ CResult_CVec_u8ZPeerHandleErrorZ_clone(const struct LDKCResult_CVec_u8ZPeerHandleErrorZ *NONNULL_PTR orig);
12272 * Creates a new CResult_NonePeerHandleErrorZ in the success state.
12274 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_ok(void);
12277 * Creates a new CResult_NonePeerHandleErrorZ in the error state.
12279 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_err(struct LDKPeerHandleError e);
12282 * Frees any resources used by the CResult_NonePeerHandleErrorZ.
12284 void CResult_NonePeerHandleErrorZ_free(struct LDKCResult_NonePeerHandleErrorZ _res);
12287 * Creates a new CResult_NonePeerHandleErrorZ which has the same data as `orig`
12288 * but with all dynamically-allocated buffers duplicated in new buffers.
12290 struct LDKCResult_NonePeerHandleErrorZ CResult_NonePeerHandleErrorZ_clone(const struct LDKCResult_NonePeerHandleErrorZ *NONNULL_PTR orig);
12293 * Creates a new CResult_boolPeerHandleErrorZ in the success state.
12295 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_ok(bool o);
12298 * Creates a new CResult_boolPeerHandleErrorZ in the error state.
12300 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_err(struct LDKPeerHandleError e);
12303 * Frees any resources used by the CResult_boolPeerHandleErrorZ.
12305 void CResult_boolPeerHandleErrorZ_free(struct LDKCResult_boolPeerHandleErrorZ _res);
12308 * Creates a new CResult_boolPeerHandleErrorZ which has the same data as `orig`
12309 * but with all dynamically-allocated buffers duplicated in new buffers.
12311 struct LDKCResult_boolPeerHandleErrorZ CResult_boolPeerHandleErrorZ_clone(const struct LDKCResult_boolPeerHandleErrorZ *NONNULL_PTR orig);
12314 * Creates a new CResult_NodeIdDecodeErrorZ in the success state.
12316 struct LDKCResult_NodeIdDecodeErrorZ CResult_NodeIdDecodeErrorZ_ok(struct LDKNodeId o);
12319 * Creates a new CResult_NodeIdDecodeErrorZ in the error state.
12321 struct LDKCResult_NodeIdDecodeErrorZ CResult_NodeIdDecodeErrorZ_err(struct LDKDecodeError e);
12324 * Frees any resources used by the CResult_NodeIdDecodeErrorZ.
12326 void CResult_NodeIdDecodeErrorZ_free(struct LDKCResult_NodeIdDecodeErrorZ _res);
12329 * Creates a new CResult_NodeIdDecodeErrorZ which has the same data as `orig`
12330 * but with all dynamically-allocated buffers duplicated in new buffers.
12332 struct LDKCResult_NodeIdDecodeErrorZ CResult_NodeIdDecodeErrorZ_clone(const struct LDKCResult_NodeIdDecodeErrorZ *NONNULL_PTR orig);
12335 * Constructs a new COption_AccessZ containing a crate::lightning::chain::Access
12337 struct LDKCOption_AccessZ COption_AccessZ_some(struct LDKAccess o);
12340 * Constructs a new COption_AccessZ containing nothing
12342 struct LDKCOption_AccessZ COption_AccessZ_none(void);
12345 * Frees any resources associated with the crate::lightning::chain::Access, if we are in the Some state
12347 void COption_AccessZ_free(struct LDKCOption_AccessZ _res);
12350 * Creates a new CResult_DirectionalChannelInfoDecodeErrorZ in the success state.
12352 struct LDKCResult_DirectionalChannelInfoDecodeErrorZ CResult_DirectionalChannelInfoDecodeErrorZ_ok(struct LDKDirectionalChannelInfo o);
12355 * Creates a new CResult_DirectionalChannelInfoDecodeErrorZ in the error state.
12357 struct LDKCResult_DirectionalChannelInfoDecodeErrorZ CResult_DirectionalChannelInfoDecodeErrorZ_err(struct LDKDecodeError e);
12360 * Frees any resources used by the CResult_DirectionalChannelInfoDecodeErrorZ.
12362 void CResult_DirectionalChannelInfoDecodeErrorZ_free(struct LDKCResult_DirectionalChannelInfoDecodeErrorZ _res);
12365 * Creates a new CResult_DirectionalChannelInfoDecodeErrorZ which has the same data as `orig`
12366 * but with all dynamically-allocated buffers duplicated in new buffers.
12368 struct LDKCResult_DirectionalChannelInfoDecodeErrorZ CResult_DirectionalChannelInfoDecodeErrorZ_clone(const struct LDKCResult_DirectionalChannelInfoDecodeErrorZ *NONNULL_PTR orig);
12371 * Creates a new CResult_ChannelInfoDecodeErrorZ in the success state.
12373 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_ok(struct LDKChannelInfo o);
12376 * Creates a new CResult_ChannelInfoDecodeErrorZ in the error state.
12378 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_err(struct LDKDecodeError e);
12381 * Frees any resources used by the CResult_ChannelInfoDecodeErrorZ.
12383 void CResult_ChannelInfoDecodeErrorZ_free(struct LDKCResult_ChannelInfoDecodeErrorZ _res);
12386 * Creates a new CResult_ChannelInfoDecodeErrorZ which has the same data as `orig`
12387 * but with all dynamically-allocated buffers duplicated in new buffers.
12389 struct LDKCResult_ChannelInfoDecodeErrorZ CResult_ChannelInfoDecodeErrorZ_clone(const struct LDKCResult_ChannelInfoDecodeErrorZ *NONNULL_PTR orig);
12392 * Creates a new CResult_RoutingFeesDecodeErrorZ in the success state.
12394 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_ok(struct LDKRoutingFees o);
12397 * Creates a new CResult_RoutingFeesDecodeErrorZ in the error state.
12399 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_err(struct LDKDecodeError e);
12402 * Frees any resources used by the CResult_RoutingFeesDecodeErrorZ.
12404 void CResult_RoutingFeesDecodeErrorZ_free(struct LDKCResult_RoutingFeesDecodeErrorZ _res);
12407 * Creates a new CResult_RoutingFeesDecodeErrorZ which has the same data as `orig`
12408 * but with all dynamically-allocated buffers duplicated in new buffers.
12410 struct LDKCResult_RoutingFeesDecodeErrorZ CResult_RoutingFeesDecodeErrorZ_clone(const struct LDKCResult_RoutingFeesDecodeErrorZ *NONNULL_PTR orig);
12413 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ in the success state.
12415 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_ok(struct LDKNodeAnnouncementInfo o);
12418 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ in the error state.
12420 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_err(struct LDKDecodeError e);
12423 * Frees any resources used by the CResult_NodeAnnouncementInfoDecodeErrorZ.
12425 void CResult_NodeAnnouncementInfoDecodeErrorZ_free(struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ _res);
12428 * Creates a new CResult_NodeAnnouncementInfoDecodeErrorZ which has the same data as `orig`
12429 * but with all dynamically-allocated buffers duplicated in new buffers.
12431 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ CResult_NodeAnnouncementInfoDecodeErrorZ_clone(const struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ *NONNULL_PTR orig);
12434 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12436 void CVec_u64Z_free(struct LDKCVec_u64Z _res);
12439 * Creates a new CResult_NodeInfoDecodeErrorZ in the success state.
12441 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_ok(struct LDKNodeInfo o);
12444 * Creates a new CResult_NodeInfoDecodeErrorZ in the error state.
12446 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_err(struct LDKDecodeError e);
12449 * Frees any resources used by the CResult_NodeInfoDecodeErrorZ.
12451 void CResult_NodeInfoDecodeErrorZ_free(struct LDKCResult_NodeInfoDecodeErrorZ _res);
12454 * Creates a new CResult_NodeInfoDecodeErrorZ which has the same data as `orig`
12455 * but with all dynamically-allocated buffers duplicated in new buffers.
12457 struct LDKCResult_NodeInfoDecodeErrorZ CResult_NodeInfoDecodeErrorZ_clone(const struct LDKCResult_NodeInfoDecodeErrorZ *NONNULL_PTR orig);
12460 * Creates a new CResult_NetworkGraphDecodeErrorZ in the success state.
12462 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_ok(struct LDKNetworkGraph o);
12465 * Creates a new CResult_NetworkGraphDecodeErrorZ in the error state.
12467 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_err(struct LDKDecodeError e);
12470 * Frees any resources used by the CResult_NetworkGraphDecodeErrorZ.
12472 void CResult_NetworkGraphDecodeErrorZ_free(struct LDKCResult_NetworkGraphDecodeErrorZ _res);
12475 * Creates a new CResult_NetworkGraphDecodeErrorZ which has the same data as `orig`
12476 * but with all dynamically-allocated buffers duplicated in new buffers.
12478 struct LDKCResult_NetworkGraphDecodeErrorZ CResult_NetworkGraphDecodeErrorZ_clone(const struct LDKCResult_NetworkGraphDecodeErrorZ *NONNULL_PTR orig);
12481 * Constructs a new COption_CVec_NetAddressZZ containing a crate::c_types::derived::CVec_NetAddressZ
12483 struct LDKCOption_CVec_NetAddressZZ COption_CVec_NetAddressZZ_some(struct LDKCVec_NetAddressZ o);
12486 * Constructs a new COption_CVec_NetAddressZZ containing nothing
12488 struct LDKCOption_CVec_NetAddressZZ COption_CVec_NetAddressZZ_none(void);
12491 * Frees any resources associated with the crate::c_types::derived::CVec_NetAddressZ, if we are in the Some state
12493 void COption_CVec_NetAddressZZ_free(struct LDKCOption_CVec_NetAddressZZ _res);
12496 * Creates a new COption_CVec_NetAddressZZ which has the same data as `orig`
12497 * but with all dynamically-allocated buffers duplicated in new buffers.
12499 struct LDKCOption_CVec_NetAddressZZ COption_CVec_NetAddressZZ_clone(const struct LDKCOption_CVec_NetAddressZZ *NONNULL_PTR orig);
12502 * Creates a new CResult_NetAddressu8Z in the success state.
12504 struct LDKCResult_NetAddressu8Z CResult_NetAddressu8Z_ok(struct LDKNetAddress o);
12507 * Creates a new CResult_NetAddressu8Z in the error state.
12509 struct LDKCResult_NetAddressu8Z CResult_NetAddressu8Z_err(uint8_t e);
12512 * Frees any resources used by the CResult_NetAddressu8Z.
12514 void CResult_NetAddressu8Z_free(struct LDKCResult_NetAddressu8Z _res);
12517 * Creates a new CResult_NetAddressu8Z which has the same data as `orig`
12518 * but with all dynamically-allocated buffers duplicated in new buffers.
12520 struct LDKCResult_NetAddressu8Z CResult_NetAddressu8Z_clone(const struct LDKCResult_NetAddressu8Z *NONNULL_PTR orig);
12523 * Creates a new CResult_CResult_NetAddressu8ZDecodeErrorZ in the success state.
12525 struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ CResult_CResult_NetAddressu8ZDecodeErrorZ_ok(struct LDKCResult_NetAddressu8Z o);
12528 * Creates a new CResult_CResult_NetAddressu8ZDecodeErrorZ in the error state.
12530 struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ CResult_CResult_NetAddressu8ZDecodeErrorZ_err(struct LDKDecodeError e);
12533 * Frees any resources used by the CResult_CResult_NetAddressu8ZDecodeErrorZ.
12535 void CResult_CResult_NetAddressu8ZDecodeErrorZ_free(struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ _res);
12538 * Creates a new CResult_CResult_NetAddressu8ZDecodeErrorZ which has the same data as `orig`
12539 * but with all dynamically-allocated buffers duplicated in new buffers.
12541 struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ CResult_CResult_NetAddressu8ZDecodeErrorZ_clone(const struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ *NONNULL_PTR orig);
12544 * Creates a new CResult_NetAddressDecodeErrorZ in the success state.
12546 struct LDKCResult_NetAddressDecodeErrorZ CResult_NetAddressDecodeErrorZ_ok(struct LDKNetAddress o);
12549 * Creates a new CResult_NetAddressDecodeErrorZ in the error state.
12551 struct LDKCResult_NetAddressDecodeErrorZ CResult_NetAddressDecodeErrorZ_err(struct LDKDecodeError e);
12554 * Frees any resources used by the CResult_NetAddressDecodeErrorZ.
12556 void CResult_NetAddressDecodeErrorZ_free(struct LDKCResult_NetAddressDecodeErrorZ _res);
12559 * Creates a new CResult_NetAddressDecodeErrorZ which has the same data as `orig`
12560 * but with all dynamically-allocated buffers duplicated in new buffers.
12562 struct LDKCResult_NetAddressDecodeErrorZ CResult_NetAddressDecodeErrorZ_clone(const struct LDKCResult_NetAddressDecodeErrorZ *NONNULL_PTR orig);
12565 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12567 void CVec_UpdateAddHTLCZ_free(struct LDKCVec_UpdateAddHTLCZ _res);
12570 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12572 void CVec_UpdateFulfillHTLCZ_free(struct LDKCVec_UpdateFulfillHTLCZ _res);
12575 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12577 void CVec_UpdateFailHTLCZ_free(struct LDKCVec_UpdateFailHTLCZ _res);
12580 * Frees the buffer pointed to by `data` if `datalen` is non-0.
12582 void CVec_UpdateFailMalformedHTLCZ_free(struct LDKCVec_UpdateFailMalformedHTLCZ _res);
12585 * Creates a new CResult_AcceptChannelDecodeErrorZ in the success state.
12587 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_ok(struct LDKAcceptChannel o);
12590 * Creates a new CResult_AcceptChannelDecodeErrorZ in the error state.
12592 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_err(struct LDKDecodeError e);
12595 * Frees any resources used by the CResult_AcceptChannelDecodeErrorZ.
12597 void CResult_AcceptChannelDecodeErrorZ_free(struct LDKCResult_AcceptChannelDecodeErrorZ _res);
12600 * Creates a new CResult_AcceptChannelDecodeErrorZ which has the same data as `orig`
12601 * but with all dynamically-allocated buffers duplicated in new buffers.
12603 struct LDKCResult_AcceptChannelDecodeErrorZ CResult_AcceptChannelDecodeErrorZ_clone(const struct LDKCResult_AcceptChannelDecodeErrorZ *NONNULL_PTR orig);
12606 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ in the success state.
12608 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_ok(struct LDKAnnouncementSignatures o);
12611 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ in the error state.
12613 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_err(struct LDKDecodeError e);
12616 * Frees any resources used by the CResult_AnnouncementSignaturesDecodeErrorZ.
12618 void CResult_AnnouncementSignaturesDecodeErrorZ_free(struct LDKCResult_AnnouncementSignaturesDecodeErrorZ _res);
12621 * Creates a new CResult_AnnouncementSignaturesDecodeErrorZ which has the same data as `orig`
12622 * but with all dynamically-allocated buffers duplicated in new buffers.
12624 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ CResult_AnnouncementSignaturesDecodeErrorZ_clone(const struct LDKCResult_AnnouncementSignaturesDecodeErrorZ *NONNULL_PTR orig);
12627 * Creates a new CResult_ChannelReestablishDecodeErrorZ in the success state.
12629 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_ok(struct LDKChannelReestablish o);
12632 * Creates a new CResult_ChannelReestablishDecodeErrorZ in the error state.
12634 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_err(struct LDKDecodeError e);
12637 * Frees any resources used by the CResult_ChannelReestablishDecodeErrorZ.
12639 void CResult_ChannelReestablishDecodeErrorZ_free(struct LDKCResult_ChannelReestablishDecodeErrorZ _res);
12642 * Creates a new CResult_ChannelReestablishDecodeErrorZ which has the same data as `orig`
12643 * but with all dynamically-allocated buffers duplicated in new buffers.
12645 struct LDKCResult_ChannelReestablishDecodeErrorZ CResult_ChannelReestablishDecodeErrorZ_clone(const struct LDKCResult_ChannelReestablishDecodeErrorZ *NONNULL_PTR orig);
12648 * Creates a new CResult_ClosingSignedDecodeErrorZ in the success state.
12650 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_ok(struct LDKClosingSigned o);
12653 * Creates a new CResult_ClosingSignedDecodeErrorZ in the error state.
12655 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_err(struct LDKDecodeError e);
12658 * Frees any resources used by the CResult_ClosingSignedDecodeErrorZ.
12660 void CResult_ClosingSignedDecodeErrorZ_free(struct LDKCResult_ClosingSignedDecodeErrorZ _res);
12663 * Creates a new CResult_ClosingSignedDecodeErrorZ which has the same data as `orig`
12664 * but with all dynamically-allocated buffers duplicated in new buffers.
12666 struct LDKCResult_ClosingSignedDecodeErrorZ CResult_ClosingSignedDecodeErrorZ_clone(const struct LDKCResult_ClosingSignedDecodeErrorZ *NONNULL_PTR orig);
12669 * Creates a new CResult_ClosingSignedFeeRangeDecodeErrorZ in the success state.
12671 struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ CResult_ClosingSignedFeeRangeDecodeErrorZ_ok(struct LDKClosingSignedFeeRange o);
12674 * Creates a new CResult_ClosingSignedFeeRangeDecodeErrorZ in the error state.
12676 struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ CResult_ClosingSignedFeeRangeDecodeErrorZ_err(struct LDKDecodeError e);
12679 * Frees any resources used by the CResult_ClosingSignedFeeRangeDecodeErrorZ.
12681 void CResult_ClosingSignedFeeRangeDecodeErrorZ_free(struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ _res);
12684 * Creates a new CResult_ClosingSignedFeeRangeDecodeErrorZ which has the same data as `orig`
12685 * but with all dynamically-allocated buffers duplicated in new buffers.
12687 struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ CResult_ClosingSignedFeeRangeDecodeErrorZ_clone(const struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ *NONNULL_PTR orig);
12690 * Creates a new CResult_CommitmentSignedDecodeErrorZ in the success state.
12692 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_ok(struct LDKCommitmentSigned o);
12695 * Creates a new CResult_CommitmentSignedDecodeErrorZ in the error state.
12697 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_err(struct LDKDecodeError e);
12700 * Frees any resources used by the CResult_CommitmentSignedDecodeErrorZ.
12702 void CResult_CommitmentSignedDecodeErrorZ_free(struct LDKCResult_CommitmentSignedDecodeErrorZ _res);
12705 * Creates a new CResult_CommitmentSignedDecodeErrorZ which has the same data as `orig`
12706 * but with all dynamically-allocated buffers duplicated in new buffers.
12708 struct LDKCResult_CommitmentSignedDecodeErrorZ CResult_CommitmentSignedDecodeErrorZ_clone(const struct LDKCResult_CommitmentSignedDecodeErrorZ *NONNULL_PTR orig);
12711 * Creates a new CResult_FundingCreatedDecodeErrorZ in the success state.
12713 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_ok(struct LDKFundingCreated o);
12716 * Creates a new CResult_FundingCreatedDecodeErrorZ in the error state.
12718 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_err(struct LDKDecodeError e);
12721 * Frees any resources used by the CResult_FundingCreatedDecodeErrorZ.
12723 void CResult_FundingCreatedDecodeErrorZ_free(struct LDKCResult_FundingCreatedDecodeErrorZ _res);
12726 * Creates a new CResult_FundingCreatedDecodeErrorZ which has the same data as `orig`
12727 * but with all dynamically-allocated buffers duplicated in new buffers.
12729 struct LDKCResult_FundingCreatedDecodeErrorZ CResult_FundingCreatedDecodeErrorZ_clone(const struct LDKCResult_FundingCreatedDecodeErrorZ *NONNULL_PTR orig);
12732 * Creates a new CResult_FundingSignedDecodeErrorZ in the success state.
12734 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_ok(struct LDKFundingSigned o);
12737 * Creates a new CResult_FundingSignedDecodeErrorZ in the error state.
12739 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_err(struct LDKDecodeError e);
12742 * Frees any resources used by the CResult_FundingSignedDecodeErrorZ.
12744 void CResult_FundingSignedDecodeErrorZ_free(struct LDKCResult_FundingSignedDecodeErrorZ _res);
12747 * Creates a new CResult_FundingSignedDecodeErrorZ which has the same data as `orig`
12748 * but with all dynamically-allocated buffers duplicated in new buffers.
12750 struct LDKCResult_FundingSignedDecodeErrorZ CResult_FundingSignedDecodeErrorZ_clone(const struct LDKCResult_FundingSignedDecodeErrorZ *NONNULL_PTR orig);
12753 * Creates a new CResult_FundingLockedDecodeErrorZ in the success state.
12755 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_ok(struct LDKFundingLocked o);
12758 * Creates a new CResult_FundingLockedDecodeErrorZ in the error state.
12760 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_err(struct LDKDecodeError e);
12763 * Frees any resources used by the CResult_FundingLockedDecodeErrorZ.
12765 void CResult_FundingLockedDecodeErrorZ_free(struct LDKCResult_FundingLockedDecodeErrorZ _res);
12768 * Creates a new CResult_FundingLockedDecodeErrorZ which has the same data as `orig`
12769 * but with all dynamically-allocated buffers duplicated in new buffers.
12771 struct LDKCResult_FundingLockedDecodeErrorZ CResult_FundingLockedDecodeErrorZ_clone(const struct LDKCResult_FundingLockedDecodeErrorZ *NONNULL_PTR orig);
12774 * Creates a new CResult_InitDecodeErrorZ in the success state.
12776 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_ok(struct LDKInit o);
12779 * Creates a new CResult_InitDecodeErrorZ in the error state.
12781 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_err(struct LDKDecodeError e);
12784 * Frees any resources used by the CResult_InitDecodeErrorZ.
12786 void CResult_InitDecodeErrorZ_free(struct LDKCResult_InitDecodeErrorZ _res);
12789 * Creates a new CResult_InitDecodeErrorZ which has the same data as `orig`
12790 * but with all dynamically-allocated buffers duplicated in new buffers.
12792 struct LDKCResult_InitDecodeErrorZ CResult_InitDecodeErrorZ_clone(const struct LDKCResult_InitDecodeErrorZ *NONNULL_PTR orig);
12795 * Creates a new CResult_OpenChannelDecodeErrorZ in the success state.
12797 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_ok(struct LDKOpenChannel o);
12800 * Creates a new CResult_OpenChannelDecodeErrorZ in the error state.
12802 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_err(struct LDKDecodeError e);
12805 * Frees any resources used by the CResult_OpenChannelDecodeErrorZ.
12807 void CResult_OpenChannelDecodeErrorZ_free(struct LDKCResult_OpenChannelDecodeErrorZ _res);
12810 * Creates a new CResult_OpenChannelDecodeErrorZ which has the same data as `orig`
12811 * but with all dynamically-allocated buffers duplicated in new buffers.
12813 struct LDKCResult_OpenChannelDecodeErrorZ CResult_OpenChannelDecodeErrorZ_clone(const struct LDKCResult_OpenChannelDecodeErrorZ *NONNULL_PTR orig);
12816 * Creates a new CResult_RevokeAndACKDecodeErrorZ in the success state.
12818 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_ok(struct LDKRevokeAndACK o);
12821 * Creates a new CResult_RevokeAndACKDecodeErrorZ in the error state.
12823 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_err(struct LDKDecodeError e);
12826 * Frees any resources used by the CResult_RevokeAndACKDecodeErrorZ.
12828 void CResult_RevokeAndACKDecodeErrorZ_free(struct LDKCResult_RevokeAndACKDecodeErrorZ _res);
12831 * Creates a new CResult_RevokeAndACKDecodeErrorZ which has the same data as `orig`
12832 * but with all dynamically-allocated buffers duplicated in new buffers.
12834 struct LDKCResult_RevokeAndACKDecodeErrorZ CResult_RevokeAndACKDecodeErrorZ_clone(const struct LDKCResult_RevokeAndACKDecodeErrorZ *NONNULL_PTR orig);
12837 * Creates a new CResult_ShutdownDecodeErrorZ in the success state.
12839 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_ok(struct LDKShutdown o);
12842 * Creates a new CResult_ShutdownDecodeErrorZ in the error state.
12844 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_err(struct LDKDecodeError e);
12847 * Frees any resources used by the CResult_ShutdownDecodeErrorZ.
12849 void CResult_ShutdownDecodeErrorZ_free(struct LDKCResult_ShutdownDecodeErrorZ _res);
12852 * Creates a new CResult_ShutdownDecodeErrorZ which has the same data as `orig`
12853 * but with all dynamically-allocated buffers duplicated in new buffers.
12855 struct LDKCResult_ShutdownDecodeErrorZ CResult_ShutdownDecodeErrorZ_clone(const struct LDKCResult_ShutdownDecodeErrorZ *NONNULL_PTR orig);
12858 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ in the success state.
12860 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_ok(struct LDKUpdateFailHTLC o);
12863 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ in the error state.
12865 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_err(struct LDKDecodeError e);
12868 * Frees any resources used by the CResult_UpdateFailHTLCDecodeErrorZ.
12870 void CResult_UpdateFailHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFailHTLCDecodeErrorZ _res);
12873 * Creates a new CResult_UpdateFailHTLCDecodeErrorZ which has the same data as `orig`
12874 * but with all dynamically-allocated buffers duplicated in new buffers.
12876 struct LDKCResult_UpdateFailHTLCDecodeErrorZ CResult_UpdateFailHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFailHTLCDecodeErrorZ *NONNULL_PTR orig);
12879 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ in the success state.
12881 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_ok(struct LDKUpdateFailMalformedHTLC o);
12884 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ in the error state.
12886 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_err(struct LDKDecodeError e);
12889 * Frees any resources used by the CResult_UpdateFailMalformedHTLCDecodeErrorZ.
12891 void CResult_UpdateFailMalformedHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ _res);
12894 * Creates a new CResult_UpdateFailMalformedHTLCDecodeErrorZ which has the same data as `orig`
12895 * but with all dynamically-allocated buffers duplicated in new buffers.
12897 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ CResult_UpdateFailMalformedHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ *NONNULL_PTR orig);
12900 * Creates a new CResult_UpdateFeeDecodeErrorZ in the success state.
12902 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_ok(struct LDKUpdateFee o);
12905 * Creates a new CResult_UpdateFeeDecodeErrorZ in the error state.
12907 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_err(struct LDKDecodeError e);
12910 * Frees any resources used by the CResult_UpdateFeeDecodeErrorZ.
12912 void CResult_UpdateFeeDecodeErrorZ_free(struct LDKCResult_UpdateFeeDecodeErrorZ _res);
12915 * Creates a new CResult_UpdateFeeDecodeErrorZ which has the same data as `orig`
12916 * but with all dynamically-allocated buffers duplicated in new buffers.
12918 struct LDKCResult_UpdateFeeDecodeErrorZ CResult_UpdateFeeDecodeErrorZ_clone(const struct LDKCResult_UpdateFeeDecodeErrorZ *NONNULL_PTR orig);
12921 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ in the success state.
12923 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_ok(struct LDKUpdateFulfillHTLC o);
12926 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ in the error state.
12928 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_err(struct LDKDecodeError e);
12931 * Frees any resources used by the CResult_UpdateFulfillHTLCDecodeErrorZ.
12933 void CResult_UpdateFulfillHTLCDecodeErrorZ_free(struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ _res);
12936 * Creates a new CResult_UpdateFulfillHTLCDecodeErrorZ which has the same data as `orig`
12937 * but with all dynamically-allocated buffers duplicated in new buffers.
12939 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ CResult_UpdateFulfillHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ *NONNULL_PTR orig);
12942 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ in the success state.
12944 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_ok(struct LDKUpdateAddHTLC o);
12947 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ in the error state.
12949 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_err(struct LDKDecodeError e);
12952 * Frees any resources used by the CResult_UpdateAddHTLCDecodeErrorZ.
12954 void CResult_UpdateAddHTLCDecodeErrorZ_free(struct LDKCResult_UpdateAddHTLCDecodeErrorZ _res);
12957 * Creates a new CResult_UpdateAddHTLCDecodeErrorZ which has the same data as `orig`
12958 * but with all dynamically-allocated buffers duplicated in new buffers.
12960 struct LDKCResult_UpdateAddHTLCDecodeErrorZ CResult_UpdateAddHTLCDecodeErrorZ_clone(const struct LDKCResult_UpdateAddHTLCDecodeErrorZ *NONNULL_PTR orig);
12963 * Creates a new CResult_PingDecodeErrorZ in the success state.
12965 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_ok(struct LDKPing o);
12968 * Creates a new CResult_PingDecodeErrorZ in the error state.
12970 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_err(struct LDKDecodeError e);
12973 * Frees any resources used by the CResult_PingDecodeErrorZ.
12975 void CResult_PingDecodeErrorZ_free(struct LDKCResult_PingDecodeErrorZ _res);
12978 * Creates a new CResult_PingDecodeErrorZ which has the same data as `orig`
12979 * but with all dynamically-allocated buffers duplicated in new buffers.
12981 struct LDKCResult_PingDecodeErrorZ CResult_PingDecodeErrorZ_clone(const struct LDKCResult_PingDecodeErrorZ *NONNULL_PTR orig);
12984 * Creates a new CResult_PongDecodeErrorZ in the success state.
12986 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_ok(struct LDKPong o);
12989 * Creates a new CResult_PongDecodeErrorZ in the error state.
12991 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_err(struct LDKDecodeError e);
12994 * Frees any resources used by the CResult_PongDecodeErrorZ.
12996 void CResult_PongDecodeErrorZ_free(struct LDKCResult_PongDecodeErrorZ _res);
12999 * Creates a new CResult_PongDecodeErrorZ which has the same data as `orig`
13000 * but with all dynamically-allocated buffers duplicated in new buffers.
13002 struct LDKCResult_PongDecodeErrorZ CResult_PongDecodeErrorZ_clone(const struct LDKCResult_PongDecodeErrorZ *NONNULL_PTR orig);
13005 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ in the success state.
13007 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_ok(struct LDKUnsignedChannelAnnouncement o);
13010 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ in the error state.
13012 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
13015 * Frees any resources used by the CResult_UnsignedChannelAnnouncementDecodeErrorZ.
13017 void CResult_UnsignedChannelAnnouncementDecodeErrorZ_free(struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ _res);
13020 * Creates a new CResult_UnsignedChannelAnnouncementDecodeErrorZ which has the same data as `orig`
13021 * but with all dynamically-allocated buffers duplicated in new buffers.
13023 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ CResult_UnsignedChannelAnnouncementDecodeErrorZ_clone(const struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ *NONNULL_PTR orig);
13026 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ in the success state.
13028 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_ok(struct LDKChannelAnnouncement o);
13031 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ in the error state.
13033 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
13036 * Frees any resources used by the CResult_ChannelAnnouncementDecodeErrorZ.
13038 void CResult_ChannelAnnouncementDecodeErrorZ_free(struct LDKCResult_ChannelAnnouncementDecodeErrorZ _res);
13041 * Creates a new CResult_ChannelAnnouncementDecodeErrorZ which has the same data as `orig`
13042 * but with all dynamically-allocated buffers duplicated in new buffers.
13044 struct LDKCResult_ChannelAnnouncementDecodeErrorZ CResult_ChannelAnnouncementDecodeErrorZ_clone(const struct LDKCResult_ChannelAnnouncementDecodeErrorZ *NONNULL_PTR orig);
13047 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ in the success state.
13049 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_ok(struct LDKUnsignedChannelUpdate o);
13052 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ in the error state.
13054 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_err(struct LDKDecodeError e);
13057 * Frees any resources used by the CResult_UnsignedChannelUpdateDecodeErrorZ.
13059 void CResult_UnsignedChannelUpdateDecodeErrorZ_free(struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ _res);
13062 * Creates a new CResult_UnsignedChannelUpdateDecodeErrorZ which has the same data as `orig`
13063 * but with all dynamically-allocated buffers duplicated in new buffers.
13065 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ CResult_UnsignedChannelUpdateDecodeErrorZ_clone(const struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ *NONNULL_PTR orig);
13068 * Creates a new CResult_ChannelUpdateDecodeErrorZ in the success state.
13070 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_ok(struct LDKChannelUpdate o);
13073 * Creates a new CResult_ChannelUpdateDecodeErrorZ in the error state.
13075 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_err(struct LDKDecodeError e);
13078 * Frees any resources used by the CResult_ChannelUpdateDecodeErrorZ.
13080 void CResult_ChannelUpdateDecodeErrorZ_free(struct LDKCResult_ChannelUpdateDecodeErrorZ _res);
13083 * Creates a new CResult_ChannelUpdateDecodeErrorZ which has the same data as `orig`
13084 * but with all dynamically-allocated buffers duplicated in new buffers.
13086 struct LDKCResult_ChannelUpdateDecodeErrorZ CResult_ChannelUpdateDecodeErrorZ_clone(const struct LDKCResult_ChannelUpdateDecodeErrorZ *NONNULL_PTR orig);
13089 * Creates a new CResult_ErrorMessageDecodeErrorZ in the success state.
13091 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_ok(struct LDKErrorMessage o);
13094 * Creates a new CResult_ErrorMessageDecodeErrorZ in the error state.
13096 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_err(struct LDKDecodeError e);
13099 * Frees any resources used by the CResult_ErrorMessageDecodeErrorZ.
13101 void CResult_ErrorMessageDecodeErrorZ_free(struct LDKCResult_ErrorMessageDecodeErrorZ _res);
13104 * Creates a new CResult_ErrorMessageDecodeErrorZ which has the same data as `orig`
13105 * but with all dynamically-allocated buffers duplicated in new buffers.
13107 struct LDKCResult_ErrorMessageDecodeErrorZ CResult_ErrorMessageDecodeErrorZ_clone(const struct LDKCResult_ErrorMessageDecodeErrorZ *NONNULL_PTR orig);
13110 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ in the success state.
13112 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_ok(struct LDKUnsignedNodeAnnouncement o);
13115 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ in the error state.
13117 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
13120 * Frees any resources used by the CResult_UnsignedNodeAnnouncementDecodeErrorZ.
13122 void CResult_UnsignedNodeAnnouncementDecodeErrorZ_free(struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ _res);
13125 * Creates a new CResult_UnsignedNodeAnnouncementDecodeErrorZ which has the same data as `orig`
13126 * but with all dynamically-allocated buffers duplicated in new buffers.
13128 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ CResult_UnsignedNodeAnnouncementDecodeErrorZ_clone(const struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ *NONNULL_PTR orig);
13131 * Creates a new CResult_NodeAnnouncementDecodeErrorZ in the success state.
13133 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_ok(struct LDKNodeAnnouncement o);
13136 * Creates a new CResult_NodeAnnouncementDecodeErrorZ in the error state.
13138 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_err(struct LDKDecodeError e);
13141 * Frees any resources used by the CResult_NodeAnnouncementDecodeErrorZ.
13143 void CResult_NodeAnnouncementDecodeErrorZ_free(struct LDKCResult_NodeAnnouncementDecodeErrorZ _res);
13146 * Creates a new CResult_NodeAnnouncementDecodeErrorZ which has the same data as `orig`
13147 * but with all dynamically-allocated buffers duplicated in new buffers.
13149 struct LDKCResult_NodeAnnouncementDecodeErrorZ CResult_NodeAnnouncementDecodeErrorZ_clone(const struct LDKCResult_NodeAnnouncementDecodeErrorZ *NONNULL_PTR orig);
13152 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ in the success state.
13154 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_ok(struct LDKQueryShortChannelIds o);
13157 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ in the error state.
13159 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_err(struct LDKDecodeError e);
13162 * Frees any resources used by the CResult_QueryShortChannelIdsDecodeErrorZ.
13164 void CResult_QueryShortChannelIdsDecodeErrorZ_free(struct LDKCResult_QueryShortChannelIdsDecodeErrorZ _res);
13167 * Creates a new CResult_QueryShortChannelIdsDecodeErrorZ which has the same data as `orig`
13168 * but with all dynamically-allocated buffers duplicated in new buffers.
13170 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ CResult_QueryShortChannelIdsDecodeErrorZ_clone(const struct LDKCResult_QueryShortChannelIdsDecodeErrorZ *NONNULL_PTR orig);
13173 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ in the success state.
13175 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_ok(struct LDKReplyShortChannelIdsEnd o);
13178 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ in the error state.
13180 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_err(struct LDKDecodeError e);
13183 * Frees any resources used by the CResult_ReplyShortChannelIdsEndDecodeErrorZ.
13185 void CResult_ReplyShortChannelIdsEndDecodeErrorZ_free(struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ _res);
13188 * Creates a new CResult_ReplyShortChannelIdsEndDecodeErrorZ which has the same data as `orig`
13189 * but with all dynamically-allocated buffers duplicated in new buffers.
13191 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ CResult_ReplyShortChannelIdsEndDecodeErrorZ_clone(const struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ *NONNULL_PTR orig);
13194 * Creates a new CResult_QueryChannelRangeDecodeErrorZ in the success state.
13196 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_ok(struct LDKQueryChannelRange o);
13199 * Creates a new CResult_QueryChannelRangeDecodeErrorZ in the error state.
13201 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_err(struct LDKDecodeError e);
13204 * Frees any resources used by the CResult_QueryChannelRangeDecodeErrorZ.
13206 void CResult_QueryChannelRangeDecodeErrorZ_free(struct LDKCResult_QueryChannelRangeDecodeErrorZ _res);
13209 * Creates a new CResult_QueryChannelRangeDecodeErrorZ which has the same data as `orig`
13210 * but with all dynamically-allocated buffers duplicated in new buffers.
13212 struct LDKCResult_QueryChannelRangeDecodeErrorZ CResult_QueryChannelRangeDecodeErrorZ_clone(const struct LDKCResult_QueryChannelRangeDecodeErrorZ *NONNULL_PTR orig);
13215 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ in the success state.
13217 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_ok(struct LDKReplyChannelRange o);
13220 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ in the error state.
13222 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_err(struct LDKDecodeError e);
13225 * Frees any resources used by the CResult_ReplyChannelRangeDecodeErrorZ.
13227 void CResult_ReplyChannelRangeDecodeErrorZ_free(struct LDKCResult_ReplyChannelRangeDecodeErrorZ _res);
13230 * Creates a new CResult_ReplyChannelRangeDecodeErrorZ which has the same data as `orig`
13231 * but with all dynamically-allocated buffers duplicated in new buffers.
13233 struct LDKCResult_ReplyChannelRangeDecodeErrorZ CResult_ReplyChannelRangeDecodeErrorZ_clone(const struct LDKCResult_ReplyChannelRangeDecodeErrorZ *NONNULL_PTR orig);
13236 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ in the success state.
13238 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_ok(struct LDKGossipTimestampFilter o);
13241 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ in the error state.
13243 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_err(struct LDKDecodeError e);
13246 * Frees any resources used by the CResult_GossipTimestampFilterDecodeErrorZ.
13248 void CResult_GossipTimestampFilterDecodeErrorZ_free(struct LDKCResult_GossipTimestampFilterDecodeErrorZ _res);
13251 * Creates a new CResult_GossipTimestampFilterDecodeErrorZ which has the same data as `orig`
13252 * but with all dynamically-allocated buffers duplicated in new buffers.
13254 struct LDKCResult_GossipTimestampFilterDecodeErrorZ CResult_GossipTimestampFilterDecodeErrorZ_clone(const struct LDKCResult_GossipTimestampFilterDecodeErrorZ *NONNULL_PTR orig);
13257 * Creates a new CResult_InvoiceSignOrCreationErrorZ in the success state.
13259 struct LDKCResult_InvoiceSignOrCreationErrorZ CResult_InvoiceSignOrCreationErrorZ_ok(struct LDKInvoice o);
13262 * Creates a new CResult_InvoiceSignOrCreationErrorZ in the error state.
13264 struct LDKCResult_InvoiceSignOrCreationErrorZ CResult_InvoiceSignOrCreationErrorZ_err(struct LDKSignOrCreationError e);
13267 * Frees any resources used by the CResult_InvoiceSignOrCreationErrorZ.
13269 void CResult_InvoiceSignOrCreationErrorZ_free(struct LDKCResult_InvoiceSignOrCreationErrorZ _res);
13272 * Creates a new CResult_InvoiceSignOrCreationErrorZ which has the same data as `orig`
13273 * but with all dynamically-allocated buffers duplicated in new buffers.
13275 struct LDKCResult_InvoiceSignOrCreationErrorZ CResult_InvoiceSignOrCreationErrorZ_clone(const struct LDKCResult_InvoiceSignOrCreationErrorZ *NONNULL_PTR orig);
13278 * Constructs a new COption_FilterZ containing a crate::lightning::chain::Filter
13280 struct LDKCOption_FilterZ COption_FilterZ_some(struct LDKFilter o);
13283 * Constructs a new COption_FilterZ containing nothing
13285 struct LDKCOption_FilterZ COption_FilterZ_none(void);
13288 * Frees any resources associated with the crate::lightning::chain::Filter, if we are in the Some state
13290 void COption_FilterZ_free(struct LDKCOption_FilterZ _res);
13293 * Creates a new CResult_LockedChannelMonitorNoneZ in the success state.
13295 struct LDKCResult_LockedChannelMonitorNoneZ CResult_LockedChannelMonitorNoneZ_ok(struct LDKLockedChannelMonitor o);
13298 * Creates a new CResult_LockedChannelMonitorNoneZ in the error state.
13300 struct LDKCResult_LockedChannelMonitorNoneZ CResult_LockedChannelMonitorNoneZ_err(void);
13303 * Frees any resources used by the CResult_LockedChannelMonitorNoneZ.
13305 void CResult_LockedChannelMonitorNoneZ_free(struct LDKCResult_LockedChannelMonitorNoneZ _res);
13308 * Frees the buffer pointed to by `data` if `datalen` is non-0.
13310 void CVec_OutPointZ_free(struct LDKCVec_OutPointZ _res);
13313 * Frees any resources used by the PaymentPurpose
13315 void PaymentPurpose_free(struct LDKPaymentPurpose this_ptr);
13318 * Creates a copy of the PaymentPurpose
13320 struct LDKPaymentPurpose PaymentPurpose_clone(const struct LDKPaymentPurpose *NONNULL_PTR orig);
13323 * Utility method to constructs a new InvoicePayment-variant PaymentPurpose
13325 struct LDKPaymentPurpose PaymentPurpose_invoice_payment(struct LDKThirtyTwoBytes payment_preimage, struct LDKThirtyTwoBytes payment_secret, uint64_t user_payment_id);
13328 * Utility method to constructs a new SpontaneousPayment-variant PaymentPurpose
13330 struct LDKPaymentPurpose PaymentPurpose_spontaneous_payment(struct LDKThirtyTwoBytes a);
13333 * Frees any resources used by the ClosureReason
13335 void ClosureReason_free(struct LDKClosureReason this_ptr);
13338 * Creates a copy of the ClosureReason
13340 struct LDKClosureReason ClosureReason_clone(const struct LDKClosureReason *NONNULL_PTR orig);
13343 * Utility method to constructs a new CounterpartyForceClosed-variant ClosureReason
13345 struct LDKClosureReason ClosureReason_counterparty_force_closed(struct LDKStr peer_msg);
13348 * Utility method to constructs a new HolderForceClosed-variant ClosureReason
13350 struct LDKClosureReason ClosureReason_holder_force_closed(void);
13353 * Utility method to constructs a new CooperativeClosure-variant ClosureReason
13355 struct LDKClosureReason ClosureReason_cooperative_closure(void);
13358 * Utility method to constructs a new CommitmentTxConfirmed-variant ClosureReason
13360 struct LDKClosureReason ClosureReason_commitment_tx_confirmed(void);
13363 * Utility method to constructs a new ProcessingError-variant ClosureReason
13365 struct LDKClosureReason ClosureReason_processing_error(struct LDKStr err);
13368 * Utility method to constructs a new DisconnectedPeer-variant ClosureReason
13370 struct LDKClosureReason ClosureReason_disconnected_peer(void);
13373 * Utility method to constructs a new OutdatedChannelManager-variant ClosureReason
13375 struct LDKClosureReason ClosureReason_outdated_channel_manager(void);
13378 * Serialize the ClosureReason object into a byte array which can be read by ClosureReason_read
13380 struct LDKCVec_u8Z ClosureReason_write(const struct LDKClosureReason *NONNULL_PTR obj);
13383 * Frees any resources used by the Event
13385 void Event_free(struct LDKEvent this_ptr);
13388 * Creates a copy of the Event
13390 struct LDKEvent Event_clone(const struct LDKEvent *NONNULL_PTR orig);
13393 * Utility method to constructs a new FundingGenerationReady-variant Event
13395 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);
13398 * Utility method to constructs a new PaymentReceived-variant Event
13400 struct LDKEvent Event_payment_received(struct LDKThirtyTwoBytes payment_hash, uint64_t amt, struct LDKPaymentPurpose purpose);
13403 * Utility method to constructs a new PaymentSent-variant Event
13405 struct LDKEvent Event_payment_sent(struct LDKThirtyTwoBytes payment_preimage, struct LDKThirtyTwoBytes payment_hash);
13408 * Utility method to constructs a new PaymentPathFailed-variant Event
13410 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, struct LDKCOption_u64Z short_channel_id);
13413 * Utility method to constructs a new PendingHTLCsForwardable-variant Event
13415 struct LDKEvent Event_pending_htlcs_forwardable(uint64_t time_forwardable);
13418 * Utility method to constructs a new SpendableOutputs-variant Event
13420 struct LDKEvent Event_spendable_outputs(struct LDKCVec_SpendableOutputDescriptorZ outputs);
13423 * Utility method to constructs a new PaymentForwarded-variant Event
13425 struct LDKEvent Event_payment_forwarded(struct LDKCOption_u64Z fee_earned_msat, bool claim_from_onchain_tx);
13428 * Utility method to constructs a new ChannelClosed-variant Event
13430 struct LDKEvent Event_channel_closed(struct LDKThirtyTwoBytes channel_id, uint64_t user_channel_id, struct LDKClosureReason reason);
13433 * Utility method to constructs a new DiscardFunding-variant Event
13435 struct LDKEvent Event_discard_funding(struct LDKThirtyTwoBytes channel_id, struct LDKTransaction transaction);
13438 * Serialize the Event object into a byte array which can be read by Event_read
13440 struct LDKCVec_u8Z Event_write(const struct LDKEvent *NONNULL_PTR obj);
13443 * Frees any resources used by the MessageSendEvent
13445 void MessageSendEvent_free(struct LDKMessageSendEvent this_ptr);
13448 * Creates a copy of the MessageSendEvent
13450 struct LDKMessageSendEvent MessageSendEvent_clone(const struct LDKMessageSendEvent *NONNULL_PTR orig);
13453 * Utility method to constructs a new SendAcceptChannel-variant MessageSendEvent
13455 struct LDKMessageSendEvent MessageSendEvent_send_accept_channel(struct LDKPublicKey node_id, struct LDKAcceptChannel msg);
13458 * Utility method to constructs a new SendOpenChannel-variant MessageSendEvent
13460 struct LDKMessageSendEvent MessageSendEvent_send_open_channel(struct LDKPublicKey node_id, struct LDKOpenChannel msg);
13463 * Utility method to constructs a new SendFundingCreated-variant MessageSendEvent
13465 struct LDKMessageSendEvent MessageSendEvent_send_funding_created(struct LDKPublicKey node_id, struct LDKFundingCreated msg);
13468 * Utility method to constructs a new SendFundingSigned-variant MessageSendEvent
13470 struct LDKMessageSendEvent MessageSendEvent_send_funding_signed(struct LDKPublicKey node_id, struct LDKFundingSigned msg);
13473 * Utility method to constructs a new SendFundingLocked-variant MessageSendEvent
13475 struct LDKMessageSendEvent MessageSendEvent_send_funding_locked(struct LDKPublicKey node_id, struct LDKFundingLocked msg);
13478 * Utility method to constructs a new SendAnnouncementSignatures-variant MessageSendEvent
13480 struct LDKMessageSendEvent MessageSendEvent_send_announcement_signatures(struct LDKPublicKey node_id, struct LDKAnnouncementSignatures msg);
13483 * Utility method to constructs a new UpdateHTLCs-variant MessageSendEvent
13485 struct LDKMessageSendEvent MessageSendEvent_update_htlcs(struct LDKPublicKey node_id, struct LDKCommitmentUpdate updates);
13488 * Utility method to constructs a new SendRevokeAndACK-variant MessageSendEvent
13490 struct LDKMessageSendEvent MessageSendEvent_send_revoke_and_ack(struct LDKPublicKey node_id, struct LDKRevokeAndACK msg);
13493 * Utility method to constructs a new SendClosingSigned-variant MessageSendEvent
13495 struct LDKMessageSendEvent MessageSendEvent_send_closing_signed(struct LDKPublicKey node_id, struct LDKClosingSigned msg);
13498 * Utility method to constructs a new SendShutdown-variant MessageSendEvent
13500 struct LDKMessageSendEvent MessageSendEvent_send_shutdown(struct LDKPublicKey node_id, struct LDKShutdown msg);
13503 * Utility method to constructs a new SendChannelReestablish-variant MessageSendEvent
13505 struct LDKMessageSendEvent MessageSendEvent_send_channel_reestablish(struct LDKPublicKey node_id, struct LDKChannelReestablish msg);
13508 * Utility method to constructs a new BroadcastChannelAnnouncement-variant MessageSendEvent
13510 struct LDKMessageSendEvent MessageSendEvent_broadcast_channel_announcement(struct LDKChannelAnnouncement msg, struct LDKChannelUpdate update_msg);
13513 * Utility method to constructs a new BroadcastNodeAnnouncement-variant MessageSendEvent
13515 struct LDKMessageSendEvent MessageSendEvent_broadcast_node_announcement(struct LDKNodeAnnouncement msg);
13518 * Utility method to constructs a new BroadcastChannelUpdate-variant MessageSendEvent
13520 struct LDKMessageSendEvent MessageSendEvent_broadcast_channel_update(struct LDKChannelUpdate msg);
13523 * Utility method to constructs a new SendChannelUpdate-variant MessageSendEvent
13525 struct LDKMessageSendEvent MessageSendEvent_send_channel_update(struct LDKPublicKey node_id, struct LDKChannelUpdate msg);
13528 * Utility method to constructs a new HandleError-variant MessageSendEvent
13530 struct LDKMessageSendEvent MessageSendEvent_handle_error(struct LDKPublicKey node_id, struct LDKErrorAction action);
13533 * Utility method to constructs a new SendChannelRangeQuery-variant MessageSendEvent
13535 struct LDKMessageSendEvent MessageSendEvent_send_channel_range_query(struct LDKPublicKey node_id, struct LDKQueryChannelRange msg);
13538 * Utility method to constructs a new SendShortIdsQuery-variant MessageSendEvent
13540 struct LDKMessageSendEvent MessageSendEvent_send_short_ids_query(struct LDKPublicKey node_id, struct LDKQueryShortChannelIds msg);
13543 * Utility method to constructs a new SendReplyChannelRange-variant MessageSendEvent
13545 struct LDKMessageSendEvent MessageSendEvent_send_reply_channel_range(struct LDKPublicKey node_id, struct LDKReplyChannelRange msg);
13548 * Calls the free function if one is set
13550 void MessageSendEventsProvider_free(struct LDKMessageSendEventsProvider this_ptr);
13553 * Calls the free function if one is set
13555 void EventsProvider_free(struct LDKEventsProvider this_ptr);
13558 * Calls the free function if one is set
13560 void EventHandler_free(struct LDKEventHandler this_ptr);
13563 * Frees any resources used by the APIError
13565 void APIError_free(struct LDKAPIError this_ptr);
13568 * Creates a copy of the APIError
13570 struct LDKAPIError APIError_clone(const struct LDKAPIError *NONNULL_PTR orig);
13573 * Utility method to constructs a new APIMisuseError-variant APIError
13575 struct LDKAPIError APIError_apimisuse_error(struct LDKStr err);
13578 * Utility method to constructs a new FeeRateTooHigh-variant APIError
13580 struct LDKAPIError APIError_fee_rate_too_high(struct LDKStr err, uint32_t feerate);
13583 * Utility method to constructs a new RouteError-variant APIError
13585 struct LDKAPIError APIError_route_error(struct LDKStr err);
13588 * Utility method to constructs a new ChannelUnavailable-variant APIError
13590 struct LDKAPIError APIError_channel_unavailable(struct LDKStr err);
13593 * Utility method to constructs a new MonitorUpdateFailed-variant APIError
13595 struct LDKAPIError APIError_monitor_update_failed(void);
13598 * Utility method to constructs a new IncompatibleShutdownScript-variant APIError
13600 struct LDKAPIError APIError_incompatible_shutdown_script(struct LDKShutdownScript script);
13603 * Creates a digital signature of a message given a SecretKey, like the node's secret.
13604 * 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.
13605 * Signatures are EC recoverable, meaning that given the message and the signature the PublicKey of the signer can be extracted.
13607 struct LDKCResult_StringErrorZ sign(struct LDKu8slice msg, const uint8_t (*sk)[32]);
13610 * Recovers the PublicKey of the signer of the message given the message and the signature.
13612 struct LDKCResult_PublicKeyErrorZ recover_pk(struct LDKu8slice msg, struct LDKStr sig);
13615 * Verifies a message was signed by a PrivateKey that derives to a given PublicKey, given a message, a signature,
13616 * and the PublicKey.
13618 bool verify(struct LDKu8slice msg, struct LDKStr sig, struct LDKPublicKey pk);
13621 * Creates a copy of the Level
13623 enum LDKLevel Level_clone(const enum LDKLevel *NONNULL_PTR orig);
13626 * Utility method to constructs a new Trace-variant Level
13628 enum LDKLevel Level_trace(void);
13631 * Utility method to constructs a new Debug-variant Level
13633 enum LDKLevel Level_debug(void);
13636 * Utility method to constructs a new Info-variant Level
13638 enum LDKLevel Level_info(void);
13641 * Utility method to constructs a new Warn-variant Level
13643 enum LDKLevel Level_warn(void);
13646 * Utility method to constructs a new Error-variant Level
13648 enum LDKLevel Level_error(void);
13651 * Checks if two Levels contain equal inner contents.
13652 * This ignores pointers and is_owned flags and looks at the values in fields.
13654 bool Level_eq(const enum LDKLevel *NONNULL_PTR a, const enum LDKLevel *NONNULL_PTR b);
13657 * Checks if two Levels contain equal inner contents.
13659 uint64_t Level_hash(const enum LDKLevel *NONNULL_PTR o);
13662 * Returns the most verbose logging level.
13664 MUST_USE_RES enum LDKLevel Level_max(void);
13667 * Calls the free function if one is set
13669 void Logger_free(struct LDKLogger this_ptr);
13672 * Frees any resources used by the ChannelHandshakeConfig, if is_owned is set and inner is non-NULL.
13674 void ChannelHandshakeConfig_free(struct LDKChannelHandshakeConfig this_obj);
13677 * Confirmations we will wait for before considering the channel locked in.
13678 * Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
13679 * equivalent limit applied to outbound channels).
13681 * Default value: 6.
13683 uint32_t ChannelHandshakeConfig_get_minimum_depth(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
13686 * Confirmations we will wait for before considering the channel locked in.
13687 * Applied only for inbound channels (see ChannelHandshakeLimits::max_minimum_depth for the
13688 * equivalent limit applied to outbound channels).
13690 * Default value: 6.
13692 void ChannelHandshakeConfig_set_minimum_depth(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint32_t val);
13695 * Set to the number of blocks we require our counterparty to wait to claim their money (ie
13696 * the number of blocks we have to punish our counterparty if they broadcast a revoked
13699 * This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
13700 * be online to check for revoked transactions on-chain at least once every our_to_self_delay
13701 * blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
13702 * possibly with time in between to RBF the spending transaction).
13704 * Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
13705 * case of an honest unilateral channel close, which implicitly decrease the economic value of
13708 * Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
13709 * can tweak config to ask for more security, not less.
13711 uint16_t ChannelHandshakeConfig_get_our_to_self_delay(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
13714 * Set to the number of blocks we require our counterparty to wait to claim their money (ie
13715 * the number of blocks we have to punish our counterparty if they broadcast a revoked
13718 * This is one of the main parameters of our security model. We (or one of our watchtowers) MUST
13719 * be online to check for revoked transactions on-chain at least once every our_to_self_delay
13720 * blocks (minus some margin to allow us enough time to broadcast and confirm a transaction,
13721 * possibly with time in between to RBF the spending transaction).
13723 * Meanwhile, asking for a too high delay, we bother peer to freeze funds for nothing in
13724 * case of an honest unilateral channel close, which implicitly decrease the economic value of
13727 * Default value: [`BREAKDOWN_TIMEOUT`], we enforce it as a minimum at channel opening so you
13728 * can tweak config to ask for more security, not less.
13730 void ChannelHandshakeConfig_set_our_to_self_delay(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint16_t val);
13733 * Set to the smallest value HTLC we will accept to process.
13735 * This value is sent to our counterparty on channel-open and we close the channel any time
13736 * our counterparty misbehaves by sending us an HTLC with a value smaller than this.
13738 * Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
13741 uint64_t ChannelHandshakeConfig_get_our_htlc_minimum_msat(const struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr);
13744 * Set to the smallest value HTLC we will accept to process.
13746 * This value is sent to our counterparty on channel-open and we close the channel any time
13747 * our counterparty misbehaves by sending us an HTLC with a value smaller than this.
13749 * Default value: 1. If the value is less than 1, it is ignored and set to 1, as is required
13752 void ChannelHandshakeConfig_set_our_htlc_minimum_msat(struct LDKChannelHandshakeConfig *NONNULL_PTR this_ptr, uint64_t val);
13755 * Constructs a new ChannelHandshakeConfig given each field
13757 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);
13760 * Creates a copy of the ChannelHandshakeConfig
13762 struct LDKChannelHandshakeConfig ChannelHandshakeConfig_clone(const struct LDKChannelHandshakeConfig *NONNULL_PTR orig);
13765 * Creates a "default" ChannelHandshakeConfig. See struct and individual field documentaiton for details on which values are used.
13767 MUST_USE_RES struct LDKChannelHandshakeConfig ChannelHandshakeConfig_default(void);
13770 * Frees any resources used by the ChannelHandshakeLimits, if is_owned is set and inner is non-NULL.
13772 void ChannelHandshakeLimits_free(struct LDKChannelHandshakeLimits this_obj);
13775 * Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
13776 * only applies to inbound channels.
13778 * Default value: 0.
13780 uint64_t ChannelHandshakeLimits_get_min_funding_satoshis(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
13783 * Minimum allowed satoshis when a channel is funded, this is supplied by the sender and so
13784 * only applies to inbound channels.
13786 * Default value: 0.
13788 void ChannelHandshakeLimits_set_min_funding_satoshis(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
13791 * The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
13792 * you to limit the maximum minimum-size they can require.
13794 * Default value: u64::max_value.
13796 uint64_t ChannelHandshakeLimits_get_max_htlc_minimum_msat(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
13799 * The remote node sets a limit on the minimum size of HTLCs we can send to them. This allows
13800 * you to limit the maximum minimum-size they can require.
13802 * Default value: u64::max_value.
13804 void ChannelHandshakeLimits_set_max_htlc_minimum_msat(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
13807 * The remote node sets a limit on the maximum value of pending HTLCs to them at any given
13808 * time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
13810 * Default value: 0.
13812 uint64_t ChannelHandshakeLimits_get_min_max_htlc_value_in_flight_msat(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
13815 * The remote node sets a limit on the maximum value of pending HTLCs to them at any given
13816 * time to limit their funds exposure to HTLCs. This allows you to set a minimum such value.
13818 * Default value: 0.
13820 void ChannelHandshakeLimits_set_min_max_htlc_value_in_flight_msat(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
13823 * The remote node will require we keep a certain amount in direct payment to ourselves at all
13824 * time, ensuring that we are able to be punished if we broadcast an old state. This allows to
13825 * you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
13827 * Default value: u64::max_value.
13829 uint64_t ChannelHandshakeLimits_get_max_channel_reserve_satoshis(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
13832 * The remote node will require we keep a certain amount in direct payment to ourselves at all
13833 * time, ensuring that we are able to be punished if we broadcast an old state. This allows to
13834 * you limit the amount which we will have to keep to ourselves (and cannot use for HTLCs).
13836 * Default value: u64::max_value.
13838 void ChannelHandshakeLimits_set_max_channel_reserve_satoshis(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint64_t val);
13841 * The remote node sets a limit on the maximum number of pending HTLCs to them at any given
13842 * time. This allows you to set a minimum such value.
13844 * Default value: 0.
13846 uint16_t ChannelHandshakeLimits_get_min_max_accepted_htlcs(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
13849 * The remote node sets a limit on the maximum number of pending HTLCs to them at any given
13850 * time. This allows you to set a minimum such value.
13852 * Default value: 0.
13854 void ChannelHandshakeLimits_set_min_max_accepted_htlcs(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint16_t val);
13857 * Before a channel is usable the funding transaction will need to be confirmed by at least a
13858 * certain number of blocks, specified by the node which is not the funder (as the funder can
13859 * assume they aren't going to double-spend themselves).
13860 * This config allows you to set a limit on the maximum amount of time to wait.
13862 * Default value: 144, or roughly one day and only applies to outbound channels.
13864 uint32_t ChannelHandshakeLimits_get_max_minimum_depth(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
13867 * Before a channel is usable the funding transaction will need to be confirmed by at least a
13868 * certain number of blocks, specified by the node which is not the funder (as the funder can
13869 * assume they aren't going to double-spend themselves).
13870 * This config allows you to set a limit on the maximum amount of time to wait.
13872 * Default value: 144, or roughly one day and only applies to outbound channels.
13874 void ChannelHandshakeLimits_set_max_minimum_depth(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint32_t val);
13877 * Set to force an incoming channel to match our announced channel preference in
13878 * [`ChannelConfig::announced_channel`].
13880 * For a node which is not online reliably, this should be set to true and
13881 * [`ChannelConfig::announced_channel`] set to false, ensuring that no announced (aka public)
13882 * channels will ever be opened.
13884 * Default value: true.
13886 bool ChannelHandshakeLimits_get_force_announced_channel_preference(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
13889 * Set to force an incoming channel to match our announced channel preference in
13890 * [`ChannelConfig::announced_channel`].
13892 * For a node which is not online reliably, this should be set to true and
13893 * [`ChannelConfig::announced_channel`] set to false, ensuring that no announced (aka public)
13894 * channels will ever be opened.
13896 * Default value: true.
13898 void ChannelHandshakeLimits_set_force_announced_channel_preference(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, bool val);
13901 * Set to the amount of time we're willing to wait to claim money back to us.
13903 * Not checking this value would be a security issue, as our peer would be able to set it to
13904 * max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
13906 * Default value: 2016, which we also enforce as a maximum value so you can tweak config to
13907 * reduce the loss of having useless locked funds (if your peer accepts)
13909 uint16_t ChannelHandshakeLimits_get_their_to_self_delay(const struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr);
13912 * Set to the amount of time we're willing to wait to claim money back to us.
13914 * Not checking this value would be a security issue, as our peer would be able to set it to
13915 * max relative lock-time (a year) and we would \"lose\" money as it would be locked for a long time.
13917 * Default value: 2016, which we also enforce as a maximum value so you can tweak config to
13918 * reduce the loss of having useless locked funds (if your peer accepts)
13920 void ChannelHandshakeLimits_set_their_to_self_delay(struct LDKChannelHandshakeLimits *NONNULL_PTR this_ptr, uint16_t val);
13923 * Constructs a new ChannelHandshakeLimits given each field
13925 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);
13928 * Creates a copy of the ChannelHandshakeLimits
13930 struct LDKChannelHandshakeLimits ChannelHandshakeLimits_clone(const struct LDKChannelHandshakeLimits *NONNULL_PTR orig);
13933 * Creates a "default" ChannelHandshakeLimits. See struct and individual field documentaiton for details on which values are used.
13935 MUST_USE_RES struct LDKChannelHandshakeLimits ChannelHandshakeLimits_default(void);
13938 * Frees any resources used by the ChannelConfig, if is_owned is set and inner is non-NULL.
13940 void ChannelConfig_free(struct LDKChannelConfig this_obj);
13943 * Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
13944 * over the channel.
13945 * This may be allowed to change at runtime in a later update, however doing so must result in
13946 * update messages sent to notify all nodes of our updated relay fee.
13948 * Default value: 0.
13950 uint32_t ChannelConfig_get_forwarding_fee_proportional_millionths(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
13953 * Amount (in millionths of a satoshi) charged per satoshi for payments forwarded outbound
13954 * over the channel.
13955 * This may be allowed to change at runtime in a later update, however doing so must result in
13956 * update messages sent to notify all nodes of our updated relay fee.
13958 * Default value: 0.
13960 void ChannelConfig_set_forwarding_fee_proportional_millionths(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint32_t val);
13963 * Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
13964 * excess of [`forwarding_fee_proportional_millionths`].
13965 * This may be allowed to change at runtime in a later update, however doing so must result in
13966 * update messages sent to notify all nodes of our updated relay fee.
13968 * The default value of a single satoshi roughly matches the market rate on many routing nodes
13969 * as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
13972 * Default value: 1000.
13974 * [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
13976 uint32_t ChannelConfig_get_forwarding_fee_base_msat(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
13979 * Amount (in milli-satoshi) charged for payments forwarded outbound over the channel, in
13980 * excess of [`forwarding_fee_proportional_millionths`].
13981 * This may be allowed to change at runtime in a later update, however doing so must result in
13982 * update messages sent to notify all nodes of our updated relay fee.
13984 * The default value of a single satoshi roughly matches the market rate on many routing nodes
13985 * as of July 2021. Adjusting it upwards or downwards may change whether nodes route through
13988 * Default value: 1000.
13990 * [`forwarding_fee_proportional_millionths`]: ChannelConfig::forwarding_fee_proportional_millionths
13992 void ChannelConfig_set_forwarding_fee_base_msat(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint32_t val);
13995 * The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
13996 * the channel this config applies to.
13998 * This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
13999 * HTLC balance when a channel appears on-chain whereas
14000 * [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
14001 * (non-HTLC-encumbered) balance.
14003 * Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
14004 * we (or one of our watchtowers) MUST be online to check for broadcast of the current
14005 * commitment transaction at least once per this many blocks (minus some margin to allow us
14006 * enough time to broadcast and confirm a transaction, possibly with time in between to RBF
14007 * the spending transaction).
14009 * Default value: 72 (12 hours at an average of 6 blocks/hour).
14010 * Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
14011 * [`MIN_CLTV_EXPIRY_DELTA`] instead.
14013 * [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
14015 uint16_t ChannelConfig_get_cltv_expiry_delta(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
14018 * The difference in the CLTV value between incoming HTLCs and an outbound HTLC forwarded over
14019 * the channel this config applies to.
14021 * This is analogous to [`ChannelHandshakeConfig::our_to_self_delay`] but applies to in-flight
14022 * HTLC balance when a channel appears on-chain whereas
14023 * [`ChannelHandshakeConfig::our_to_self_delay`] applies to the remaining
14024 * (non-HTLC-encumbered) balance.
14026 * Thus, for HTLC-encumbered balances to be enforced on-chain when a channel is force-closed,
14027 * we (or one of our watchtowers) MUST be online to check for broadcast of the current
14028 * commitment transaction at least once per this many blocks (minus some margin to allow us
14029 * enough time to broadcast and confirm a transaction, possibly with time in between to RBF
14030 * the spending transaction).
14032 * Default value: 72 (12 hours at an average of 6 blocks/hour).
14033 * Minimum value: [`MIN_CLTV_EXPIRY_DELTA`], any values less than this will be treated as
14034 * [`MIN_CLTV_EXPIRY_DELTA`] instead.
14036 * [`MIN_CLTV_EXPIRY_DELTA`]: crate::ln::channelmanager::MIN_CLTV_EXPIRY_DELTA
14038 void ChannelConfig_set_cltv_expiry_delta(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint16_t val);
14041 * Set to announce the channel publicly and notify all nodes that they can route via this
14044 * This should only be set to true for nodes which expect to be online reliably.
14046 * As the node which funds a channel picks this value this will only apply for new outbound
14047 * channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
14049 * This cannot be changed after the initial channel handshake.
14051 * Default value: false.
14053 bool ChannelConfig_get_announced_channel(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
14056 * Set to announce the channel publicly and notify all nodes that they can route via this
14059 * This should only be set to true for nodes which expect to be online reliably.
14061 * As the node which funds a channel picks this value this will only apply for new outbound
14062 * channels unless [`ChannelHandshakeLimits::force_announced_channel_preference`] is set.
14064 * This cannot be changed after the initial channel handshake.
14066 * Default value: false.
14068 void ChannelConfig_set_announced_channel(struct LDKChannelConfig *NONNULL_PTR this_ptr, bool val);
14071 * When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
14072 * supports it, they will then enforce the mutual-close output to us matches what we provided
14073 * at intialization, preventing us from closing to an alternate pubkey.
14075 * This is set to true by default to provide a slight increase in security, though ultimately
14076 * any attacker who is able to take control of a channel can just as easily send the funds via
14077 * lightning payments, so we never require that our counterparties support this option.
14079 * This cannot be changed after a channel has been initialized.
14081 * Default value: true.
14083 bool ChannelConfig_get_commit_upfront_shutdown_pubkey(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
14086 * When set, we commit to an upfront shutdown_pubkey at channel open. If our counterparty
14087 * supports it, they will then enforce the mutual-close output to us matches what we provided
14088 * at intialization, preventing us from closing to an alternate pubkey.
14090 * This is set to true by default to provide a slight increase in security, though ultimately
14091 * any attacker who is able to take control of a channel can just as easily send the funds via
14092 * lightning payments, so we never require that our counterparties support this option.
14094 * This cannot be changed after a channel has been initialized.
14096 * Default value: true.
14098 void ChannelConfig_set_commit_upfront_shutdown_pubkey(struct LDKChannelConfig *NONNULL_PTR this_ptr, bool val);
14101 * Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
14102 * small to claim on-chain.
14104 * When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
14105 * not be claimable on-chain, instead being turned into additional miner fees if either
14106 * party force-closes the channel. Because the threshold is per-HTLC, our total exposure
14107 * to such payments may be sustantial if there are many dust HTLCs present when the
14108 * channel is force-closed.
14110 * This limit is applied for sent, forwarded, and received HTLCs and limits the total
14111 * exposure across all three types per-channel. Setting this too low may prevent the
14112 * sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
14113 * important to prevent stealing of dust HTLCs by miners.
14115 * Default value: 5_000_000 msat.
14117 uint64_t ChannelConfig_get_max_dust_htlc_exposure_msat(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
14120 * Limit our total exposure to in-flight HTLCs which are burned to fees as they are too
14121 * small to claim on-chain.
14123 * When an HTLC present in one of our channels is below a \"dust\" threshold, the HTLC will
14124 * not be claimable on-chain, instead being turned into additional miner fees if either
14125 * party force-closes the channel. Because the threshold is per-HTLC, our total exposure
14126 * to such payments may be sustantial if there are many dust HTLCs present when the
14127 * channel is force-closed.
14129 * This limit is applied for sent, forwarded, and received HTLCs and limits the total
14130 * exposure across all three types per-channel. Setting this too low may prevent the
14131 * sending or receipt of low-value HTLCs on high-traffic nodes, and this limit is very
14132 * important to prevent stealing of dust HTLCs by miners.
14134 * Default value: 5_000_000 msat.
14136 void ChannelConfig_set_max_dust_htlc_exposure_msat(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint64_t val);
14139 * The additional fee we're willing to pay to avoid waiting for the counterparty's
14140 * `to_self_delay` to reclaim funds.
14142 * When we close a channel cooperatively with our counterparty, we negotiate a fee for the
14143 * closing transaction which both sides find acceptable, ultimately paid by the channel
14144 * funder/initiator.
14146 * When we are the funder, because we have to pay the channel closing fee, we bound the
14147 * acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
14148 * this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
14149 * [`Normal`] feerate during normal operation, this value represents the additional fee we're
14150 * willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
14153 * When we are not the funder, we require the closing transaction fee pay at least our
14154 * [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
14155 * Thus, this value is ignored when we are not the funder.
14157 * Default value: 1000 satoshis.
14159 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
14160 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
14162 uint64_t ChannelConfig_get_force_close_avoidance_max_fee_satoshis(const struct LDKChannelConfig *NONNULL_PTR this_ptr);
14165 * The additional fee we're willing to pay to avoid waiting for the counterparty's
14166 * `to_self_delay` to reclaim funds.
14168 * When we close a channel cooperatively with our counterparty, we negotiate a fee for the
14169 * closing transaction which both sides find acceptable, ultimately paid by the channel
14170 * funder/initiator.
14172 * When we are the funder, because we have to pay the channel closing fee, we bound the
14173 * acceptable fee by our [`Background`] and [`Normal`] fees, with the upper bound increased by
14174 * this value. Because the on-chain fee we'd pay to force-close the channel is kept near our
14175 * [`Normal`] feerate during normal operation, this value represents the additional fee we're
14176 * willing to pay in order to avoid waiting for our counterparty's to_self_delay to reclaim our
14179 * When we are not the funder, we require the closing transaction fee pay at least our
14180 * [`Background`] fee estimate, but allow our counterparty to pay as much fee as they like.
14181 * Thus, this value is ignored when we are not the funder.
14183 * Default value: 1000 satoshis.
14185 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
14186 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
14188 void ChannelConfig_set_force_close_avoidance_max_fee_satoshis(struct LDKChannelConfig *NONNULL_PTR this_ptr, uint64_t val);
14191 * Constructs a new ChannelConfig given each field
14193 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);
14196 * Creates a copy of the ChannelConfig
14198 struct LDKChannelConfig ChannelConfig_clone(const struct LDKChannelConfig *NONNULL_PTR orig);
14201 * Creates a "default" ChannelConfig. See struct and individual field documentaiton for details on which values are used.
14203 MUST_USE_RES struct LDKChannelConfig ChannelConfig_default(void);
14206 * Serialize the ChannelConfig object into a byte array which can be read by ChannelConfig_read
14208 struct LDKCVec_u8Z ChannelConfig_write(const struct LDKChannelConfig *NONNULL_PTR obj);
14211 * Read a ChannelConfig from a byte array, created by ChannelConfig_write
14213 struct LDKCResult_ChannelConfigDecodeErrorZ ChannelConfig_read(struct LDKu8slice ser);
14216 * Frees any resources used by the UserConfig, if is_owned is set and inner is non-NULL.
14218 void UserConfig_free(struct LDKUserConfig this_obj);
14221 * Channel config that we propose to our counterparty.
14223 struct LDKChannelHandshakeConfig UserConfig_get_own_channel_config(const struct LDKUserConfig *NONNULL_PTR this_ptr);
14226 * Channel config that we propose to our counterparty.
14228 void UserConfig_set_own_channel_config(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelHandshakeConfig val);
14231 * Limits applied to our counterparty's proposed channel config settings.
14233 struct LDKChannelHandshakeLimits UserConfig_get_peer_channel_config_limits(const struct LDKUserConfig *NONNULL_PTR this_ptr);
14236 * Limits applied to our counterparty's proposed channel config settings.
14238 void UserConfig_set_peer_channel_config_limits(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelHandshakeLimits val);
14241 * Channel config which affects behavior during channel lifetime.
14243 struct LDKChannelConfig UserConfig_get_channel_options(const struct LDKUserConfig *NONNULL_PTR this_ptr);
14246 * Channel config which affects behavior during channel lifetime.
14248 void UserConfig_set_channel_options(struct LDKUserConfig *NONNULL_PTR this_ptr, struct LDKChannelConfig val);
14251 * If this is set to false, we will reject any HTLCs which were to be forwarded over private
14252 * channels. This prevents us from taking on HTLC-forwarding risk when we intend to run as a
14253 * node which is not online reliably.
14255 * For nodes which are not online reliably, you should set all channels to *not* be announced
14256 * (using [`ChannelConfig::announced_channel`] and
14257 * [`ChannelHandshakeLimits::force_announced_channel_preference`]) and set this to false to
14258 * ensure you are not exposed to any forwarding risk.
14260 * Note that because you cannot change a channel's announced state after creation, there is no
14261 * way to disable forwarding on public channels retroactively. Thus, in order to change a node
14262 * from a publicly-announced forwarding node to a private non-forwarding node you must close
14263 * all your channels and open new ones. For privacy, you should also change your node_id
14264 * (swapping all private and public key material for new ones) at that time.
14266 * Default value: false.
14268 bool UserConfig_get_accept_forwards_to_priv_channels(const struct LDKUserConfig *NONNULL_PTR this_ptr);
14271 * If this is set to false, we will reject any HTLCs which were to be forwarded over private
14272 * channels. This prevents us from taking on HTLC-forwarding risk when we intend to run as a
14273 * node which is not online reliably.
14275 * For nodes which are not online reliably, you should set all channels to *not* be announced
14276 * (using [`ChannelConfig::announced_channel`] and
14277 * [`ChannelHandshakeLimits::force_announced_channel_preference`]) and set this to false to
14278 * ensure you are not exposed to any forwarding risk.
14280 * Note that because you cannot change a channel's announced state after creation, there is no
14281 * way to disable forwarding on public channels retroactively. Thus, in order to change a node
14282 * from a publicly-announced forwarding node to a private non-forwarding node you must close
14283 * all your channels and open new ones. For privacy, you should also change your node_id
14284 * (swapping all private and public key material for new ones) at that time.
14286 * Default value: false.
14288 void UserConfig_set_accept_forwards_to_priv_channels(struct LDKUserConfig *NONNULL_PTR this_ptr, bool val);
14291 * Constructs a new UserConfig given each field
14293 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);
14296 * Creates a copy of the UserConfig
14298 struct LDKUserConfig UserConfig_clone(const struct LDKUserConfig *NONNULL_PTR orig);
14301 * Creates a "default" UserConfig. See struct and individual field documentaiton for details on which values are used.
14303 MUST_USE_RES struct LDKUserConfig UserConfig_default(void);
14306 * Frees any resources used by the BestBlock, if is_owned is set and inner is non-NULL.
14308 void BestBlock_free(struct LDKBestBlock this_obj);
14311 * Creates a copy of the BestBlock
14313 struct LDKBestBlock BestBlock_clone(const struct LDKBestBlock *NONNULL_PTR orig);
14316 * Constructs a `BestBlock` that represents the genesis block at height 0 of the given
14319 MUST_USE_RES struct LDKBestBlock BestBlock_from_genesis(enum LDKNetwork network);
14322 * Returns a `BestBlock` as identified by the given block hash and height.
14324 MUST_USE_RES struct LDKBestBlock BestBlock_new(struct LDKThirtyTwoBytes block_hash, uint32_t height);
14327 * Returns the best block hash.
14329 MUST_USE_RES struct LDKThirtyTwoBytes BestBlock_block_hash(const struct LDKBestBlock *NONNULL_PTR this_arg);
14332 * Returns the best block height.
14334 MUST_USE_RES uint32_t BestBlock_height(const struct LDKBestBlock *NONNULL_PTR this_arg);
14337 * Creates a copy of the AccessError
14339 enum LDKAccessError AccessError_clone(const enum LDKAccessError *NONNULL_PTR orig);
14342 * Utility method to constructs a new UnknownChain-variant AccessError
14344 enum LDKAccessError AccessError_unknown_chain(void);
14347 * Utility method to constructs a new UnknownTx-variant AccessError
14349 enum LDKAccessError AccessError_unknown_tx(void);
14352 * Calls the free function if one is set
14354 void Access_free(struct LDKAccess this_ptr);
14357 * Calls the free function if one is set
14359 void Listen_free(struct LDKListen this_ptr);
14362 * Calls the free function if one is set
14364 void Confirm_free(struct LDKConfirm this_ptr);
14367 * Creates a copy of the ChannelMonitorUpdateErr
14369 enum LDKChannelMonitorUpdateErr ChannelMonitorUpdateErr_clone(const enum LDKChannelMonitorUpdateErr *NONNULL_PTR orig);
14372 * Utility method to constructs a new TemporaryFailure-variant ChannelMonitorUpdateErr
14374 enum LDKChannelMonitorUpdateErr ChannelMonitorUpdateErr_temporary_failure(void);
14377 * Utility method to constructs a new PermanentFailure-variant ChannelMonitorUpdateErr
14379 enum LDKChannelMonitorUpdateErr ChannelMonitorUpdateErr_permanent_failure(void);
14382 * Calls the free function if one is set
14384 void Watch_free(struct LDKWatch this_ptr);
14387 * Calls the free function if one is set
14389 void Filter_free(struct LDKFilter this_ptr);
14392 * Frees any resources used by the WatchedOutput, if is_owned is set and inner is non-NULL.
14394 void WatchedOutput_free(struct LDKWatchedOutput this_obj);
14397 * First block where the transaction output may have been spent.
14399 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
14401 struct LDKThirtyTwoBytes WatchedOutput_get_block_hash(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
14404 * First block where the transaction output may have been spent.
14406 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
14408 void WatchedOutput_set_block_hash(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14411 * Outpoint identifying the transaction output.
14413 struct LDKOutPoint WatchedOutput_get_outpoint(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
14416 * Outpoint identifying the transaction output.
14418 void WatchedOutput_set_outpoint(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKOutPoint val);
14421 * Spending condition of the transaction output.
14423 struct LDKu8slice WatchedOutput_get_script_pubkey(const struct LDKWatchedOutput *NONNULL_PTR this_ptr);
14426 * Spending condition of the transaction output.
14428 void WatchedOutput_set_script_pubkey(struct LDKWatchedOutput *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
14431 * Constructs a new WatchedOutput given each field
14433 MUST_USE_RES struct LDKWatchedOutput WatchedOutput_new(struct LDKThirtyTwoBytes block_hash_arg, struct LDKOutPoint outpoint_arg, struct LDKCVec_u8Z script_pubkey_arg);
14436 * Creates a copy of the WatchedOutput
14438 struct LDKWatchedOutput WatchedOutput_clone(const struct LDKWatchedOutput *NONNULL_PTR orig);
14441 * Checks if two WatchedOutputs contain equal inner contents.
14443 uint64_t WatchedOutput_hash(const struct LDKWatchedOutput *NONNULL_PTR o);
14446 * Calls the free function if one is set
14448 void BroadcasterInterface_free(struct LDKBroadcasterInterface this_ptr);
14451 * Creates a copy of the ConfirmationTarget
14453 enum LDKConfirmationTarget ConfirmationTarget_clone(const enum LDKConfirmationTarget *NONNULL_PTR orig);
14456 * Utility method to constructs a new Background-variant ConfirmationTarget
14458 enum LDKConfirmationTarget ConfirmationTarget_background(void);
14461 * Utility method to constructs a new Normal-variant ConfirmationTarget
14463 enum LDKConfirmationTarget ConfirmationTarget_normal(void);
14466 * Utility method to constructs a new HighPriority-variant ConfirmationTarget
14468 enum LDKConfirmationTarget ConfirmationTarget_high_priority(void);
14471 * Checks if two ConfirmationTargets contain equal inner contents.
14472 * This ignores pointers and is_owned flags and looks at the values in fields.
14474 bool ConfirmationTarget_eq(const enum LDKConfirmationTarget *NONNULL_PTR a, const enum LDKConfirmationTarget *NONNULL_PTR b);
14477 * Calls the free function if one is set
14479 void FeeEstimator_free(struct LDKFeeEstimator this_ptr);
14482 * Calls the free function if one is set
14484 void Persist_free(struct LDKPersist this_ptr);
14487 * Frees any resources used by the LockedChannelMonitor, if is_owned is set and inner is non-NULL.
14489 void LockedChannelMonitor_free(struct LDKLockedChannelMonitor this_obj);
14492 * Frees any resources used by the ChainMonitor, if is_owned is set and inner is non-NULL.
14494 void ChainMonitor_free(struct LDKChainMonitor this_obj);
14497 * Creates a new `ChainMonitor` used to watch on-chain activity pertaining to channels.
14499 * When an optional chain source implementing [`chain::Filter`] is provided, the chain monitor
14500 * will call back to it indicating transactions and outputs of interest. This allows clients to
14501 * pre-filter blocks or only fetch blocks matching a compact filter. Otherwise, clients may
14502 * always need to fetch full blocks absent another means for determining which blocks contain
14503 * transactions relevant to the watched channels.
14505 MUST_USE_RES struct LDKChainMonitor ChainMonitor_new(struct LDKCOption_FilterZ chain_source, struct LDKBroadcasterInterface broadcaster, struct LDKLogger logger, struct LDKFeeEstimator feeest, struct LDKPersist persister);
14508 * Gets the balances in the contained [`ChannelMonitor`]s which are claimable on-chain or
14509 * claims which are awaiting confirmation.
14511 * Includes the balances from each [`ChannelMonitor`] *except* those included in
14512 * `ignored_channels`, allowing you to filter out balances from channels which are still open
14513 * (and whose balance should likely be pulled from the [`ChannelDetails`]).
14515 * See [`ChannelMonitor::get_claimable_balances`] for more details on the exact criteria for
14516 * inclusion in the return value.
14518 MUST_USE_RES struct LDKCVec_BalanceZ ChainMonitor_get_claimable_balances(const struct LDKChainMonitor *NONNULL_PTR this_arg, struct LDKCVec_ChannelDetailsZ ignored_channels);
14521 * Gets the [`LockedChannelMonitor`] for a given funding outpoint, returning an `Err` if no
14522 * such [`ChannelMonitor`] is currently being monitored for.
14524 * Note that the result holds a mutex over our monitor set, and should not be held
14527 MUST_USE_RES struct LDKCResult_LockedChannelMonitorNoneZ ChainMonitor_get_monitor(const struct LDKChainMonitor *NONNULL_PTR this_arg, struct LDKOutPoint funding_txo);
14530 * Lists the funding outpoint of each [`ChannelMonitor`] being monitored.
14532 * Note that [`ChannelMonitor`]s are not removed when a channel is closed as they are always
14533 * monitoring for on-chain state resolutions.
14535 MUST_USE_RES struct LDKCVec_OutPointZ ChainMonitor_list_monitors(const struct LDKChainMonitor *NONNULL_PTR this_arg);
14538 * Constructs a new Listen which calls the relevant methods on this_arg.
14539 * This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
14541 struct LDKListen ChainMonitor_as_Listen(const struct LDKChainMonitor *NONNULL_PTR this_arg);
14544 * Constructs a new Confirm which calls the relevant methods on this_arg.
14545 * This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
14547 struct LDKConfirm ChainMonitor_as_Confirm(const struct LDKChainMonitor *NONNULL_PTR this_arg);
14550 * Constructs a new Watch which calls the relevant methods on this_arg.
14551 * This copies the `inner` pointer in this_arg and thus the returned Watch must be freed before this_arg is
14553 struct LDKWatch ChainMonitor_as_Watch(const struct LDKChainMonitor *NONNULL_PTR this_arg);
14556 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
14557 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
14559 struct LDKEventsProvider ChainMonitor_as_EventsProvider(const struct LDKChainMonitor *NONNULL_PTR this_arg);
14562 * Frees any resources used by the ChannelMonitorUpdate, if is_owned is set and inner is non-NULL.
14564 void ChannelMonitorUpdate_free(struct LDKChannelMonitorUpdate this_obj);
14567 * The sequence number of this update. Updates *must* be replayed in-order according to this
14568 * sequence number (and updates may panic if they are not). The update_id values are strictly
14569 * increasing and increase by one for each new update, with one exception specified below.
14571 * This sequence number is also used to track up to which points updates which returned
14572 * ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
14573 * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
14575 * The only instance where update_id values are not strictly increasing is the case where we
14576 * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
14577 * its docs for more details.
14579 uint64_t ChannelMonitorUpdate_get_update_id(const struct LDKChannelMonitorUpdate *NONNULL_PTR this_ptr);
14582 * The sequence number of this update. Updates *must* be replayed in-order according to this
14583 * sequence number (and updates may panic if they are not). The update_id values are strictly
14584 * increasing and increase by one for each new update, with one exception specified below.
14586 * This sequence number is also used to track up to which points updates which returned
14587 * ChannelMonitorUpdateErr::TemporaryFailure have been applied to all copies of a given
14588 * ChannelMonitor when ChannelManager::channel_monitor_updated is called.
14590 * The only instance where update_id values are not strictly increasing is the case where we
14591 * allow post-force-close updates with a special update ID of [`CLOSED_CHANNEL_UPDATE_ID`]. See
14592 * its docs for more details.
14594 void ChannelMonitorUpdate_set_update_id(struct LDKChannelMonitorUpdate *NONNULL_PTR this_ptr, uint64_t val);
14597 * Creates a copy of the ChannelMonitorUpdate
14599 struct LDKChannelMonitorUpdate ChannelMonitorUpdate_clone(const struct LDKChannelMonitorUpdate *NONNULL_PTR orig);
14602 * Serialize the ChannelMonitorUpdate object into a byte array which can be read by ChannelMonitorUpdate_read
14604 struct LDKCVec_u8Z ChannelMonitorUpdate_write(const struct LDKChannelMonitorUpdate *NONNULL_PTR obj);
14607 * Read a ChannelMonitorUpdate from a byte array, created by ChannelMonitorUpdate_write
14609 struct LDKCResult_ChannelMonitorUpdateDecodeErrorZ ChannelMonitorUpdate_read(struct LDKu8slice ser);
14612 * Frees any resources used by the MonitorUpdateError, if is_owned is set and inner is non-NULL.
14614 void MonitorUpdateError_free(struct LDKMonitorUpdateError this_obj);
14617 * Creates a copy of the MonitorUpdateError
14619 struct LDKMonitorUpdateError MonitorUpdateError_clone(const struct LDKMonitorUpdateError *NONNULL_PTR orig);
14622 * Frees any resources used by the MonitorEvent
14624 void MonitorEvent_free(struct LDKMonitorEvent this_ptr);
14627 * Creates a copy of the MonitorEvent
14629 struct LDKMonitorEvent MonitorEvent_clone(const struct LDKMonitorEvent *NONNULL_PTR orig);
14632 * Utility method to constructs a new HTLCEvent-variant MonitorEvent
14634 struct LDKMonitorEvent MonitorEvent_htlcevent(struct LDKHTLCUpdate a);
14637 * Utility method to constructs a new CommitmentTxConfirmed-variant MonitorEvent
14639 struct LDKMonitorEvent MonitorEvent_commitment_tx_confirmed(struct LDKOutPoint a);
14642 * Frees any resources used by the HTLCUpdate, if is_owned is set and inner is non-NULL.
14644 void HTLCUpdate_free(struct LDKHTLCUpdate this_obj);
14647 * Creates a copy of the HTLCUpdate
14649 struct LDKHTLCUpdate HTLCUpdate_clone(const struct LDKHTLCUpdate *NONNULL_PTR orig);
14652 * Serialize the HTLCUpdate object into a byte array which can be read by HTLCUpdate_read
14654 struct LDKCVec_u8Z HTLCUpdate_write(const struct LDKHTLCUpdate *NONNULL_PTR obj);
14657 * Read a HTLCUpdate from a byte array, created by HTLCUpdate_write
14659 struct LDKCResult_HTLCUpdateDecodeErrorZ HTLCUpdate_read(struct LDKu8slice ser);
14662 * Frees any resources used by the Balance
14664 void Balance_free(struct LDKBalance this_ptr);
14667 * Creates a copy of the Balance
14669 struct LDKBalance Balance_clone(const struct LDKBalance *NONNULL_PTR orig);
14672 * Utility method to constructs a new ClaimableOnChannelClose-variant Balance
14674 struct LDKBalance Balance_claimable_on_channel_close(uint64_t claimable_amount_satoshis);
14677 * Utility method to constructs a new ClaimableAwaitingConfirmations-variant Balance
14679 struct LDKBalance Balance_claimable_awaiting_confirmations(uint64_t claimable_amount_satoshis, uint32_t confirmation_height);
14682 * Utility method to constructs a new ContentiousClaimable-variant Balance
14684 struct LDKBalance Balance_contentious_claimable(uint64_t claimable_amount_satoshis, uint32_t timeout_height);
14687 * Utility method to constructs a new MaybeClaimableHTLCAwaitingTimeout-variant Balance
14689 struct LDKBalance Balance_maybe_claimable_htlcawaiting_timeout(uint64_t claimable_amount_satoshis, uint32_t claimable_height);
14692 * Checks if two Balances contain equal inner contents.
14693 * This ignores pointers and is_owned flags and looks at the values in fields.
14695 bool Balance_eq(const struct LDKBalance *NONNULL_PTR a, const struct LDKBalance *NONNULL_PTR b);
14698 * Frees any resources used by the ChannelMonitor, if is_owned is set and inner is non-NULL.
14700 void ChannelMonitor_free(struct LDKChannelMonitor this_obj);
14703 * Serialize the ChannelMonitor object into a byte array which can be read by ChannelMonitor_read
14705 struct LDKCVec_u8Z ChannelMonitor_write(const struct LDKChannelMonitor *NONNULL_PTR obj);
14708 * Updates a ChannelMonitor on the basis of some new information provided by the Channel
14711 * panics if the given update is not the next update by update_id.
14713 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);
14716 * Gets the update_id from the latest ChannelMonitorUpdate which was applied to this
14719 MUST_USE_RES uint64_t ChannelMonitor_get_latest_update_id(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
14722 * Gets the funding transaction outpoint of the channel this ChannelMonitor is monitoring for.
14724 MUST_USE_RES struct LDKC2Tuple_OutPointScriptZ ChannelMonitor_get_funding_txo(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
14727 * Gets a list of txids, with their output scripts (in the order they appear in the
14728 * transaction), which we must learn about spends of via block_connected().
14730 MUST_USE_RES struct LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32ScriptZZZZ ChannelMonitor_get_outputs_to_watch(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
14733 * Loads the funding txo and outputs to watch into the given `chain::Filter` by repeatedly
14734 * calling `chain::Filter::register_output` and `chain::Filter::register_tx` until all outputs
14735 * have been registered.
14737 void ChannelMonitor_load_outputs_to_watch(const struct LDKChannelMonitor *NONNULL_PTR this_arg, const struct LDKFilter *NONNULL_PTR filter);
14740 * Get the list of HTLCs who's status has been updated on chain. This should be called by
14741 * ChannelManager via [`chain::Watch::release_pending_monitor_events`].
14743 MUST_USE_RES struct LDKCVec_MonitorEventZ ChannelMonitor_get_and_clear_pending_monitor_events(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
14746 * Gets the list of pending events which were generated by previous actions, clearing the list
14749 * This is called by ChainMonitor::get_and_clear_pending_events() and is equivalent to
14750 * EventsProvider::get_and_clear_pending_events() except that it requires &mut self as we do
14751 * no internal locking in ChannelMonitors.
14753 MUST_USE_RES struct LDKCVec_EventZ ChannelMonitor_get_and_clear_pending_events(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
14756 * Used by ChannelManager deserialization to broadcast the latest holder state if its copy of
14757 * the Channel was out-of-date. You may use it to get a broadcastable holder toxic tx in case of
14758 * fallen-behind, i.e when receiving a channel_reestablish with a proof that our counterparty side knows
14759 * a higher revocation secret than the holder commitment number we are aware of. Broadcasting these
14760 * transactions are UNSAFE, as they allow counterparty side to punish you. Nevertheless you may want to
14761 * broadcast them if counterparty don't close channel with his higher commitment transaction after a
14762 * substantial amount of time (a month or even a year) to get back funds. Best may be to contact
14763 * out-of-band the other node operator to coordinate with him if option is available to you.
14764 * In any-case, choice is up to the user.
14766 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);
14769 * Processes transactions in a newly connected block, which may result in any of the following:
14770 * - update the monitor's state against resolved HTLCs
14771 * - punish the counterparty in the case of seeing a revoked commitment transaction
14772 * - force close the channel and claim/timeout incoming/outgoing HTLCs if near expiration
14773 * - detect settled outputs for later spending
14774 * - schedule and bump any in-flight claims
14776 * Returns any new outputs to watch from `txdata`; after called, these are also included in
14777 * [`get_outputs_to_watch`].
14779 * [`get_outputs_to_watch`]: #method.get_outputs_to_watch
14781 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);
14784 * Determines if the disconnected block contained any transactions of interest and updates
14787 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);
14790 * Processes transactions confirmed in a block with the given header and height, returning new
14791 * outputs to watch. See [`block_connected`] for details.
14793 * Used instead of [`block_connected`] by clients that are notified of transactions rather than
14794 * blocks. See [`chain::Confirm`] for calling expectations.
14796 * [`block_connected`]: Self::block_connected
14798 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);
14801 * Processes a transaction that was reorganized out of the chain.
14803 * Used instead of [`block_disconnected`] by clients that are notified of transactions rather
14804 * than blocks. See [`chain::Confirm`] for calling expectations.
14806 * [`block_disconnected`]: Self::block_disconnected
14808 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);
14811 * Updates the monitor with the current best chain tip, returning new outputs to watch. See
14812 * [`block_connected`] for details.
14814 * Used instead of [`block_connected`] by clients that are notified of transactions rather than
14815 * blocks. See [`chain::Confirm`] for calling expectations.
14817 * [`block_connected`]: Self::block_connected
14819 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);
14822 * Returns the set of txids that should be monitored for re-organization out of the chain.
14824 MUST_USE_RES struct LDKCVec_TxidZ ChannelMonitor_get_relevant_txids(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
14827 * Gets the latest best block which was connected either via the [`chain::Listen`] or
14828 * [`chain::Confirm`] interfaces.
14830 MUST_USE_RES struct LDKBestBlock ChannelMonitor_current_best_block(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
14833 * Gets the balances in this channel which are either claimable by us if we were to
14834 * force-close the channel now or which are claimable on-chain (possibly awaiting
14837 * Any balances in the channel which are available on-chain (excluding on-chain fees) are
14838 * included here until an [`Event::SpendableOutputs`] event has been generated for the
14839 * balance, or until our counterparty has claimed the balance and accrued several
14840 * confirmations on the claim transaction.
14842 * Note that the balances available when you or your counterparty have broadcasted revoked
14843 * state(s) may not be fully captured here.
14845 * See [`Balance`] for additional details on the types of claimable balances which
14846 * may be returned here and their meanings.
14848 MUST_USE_RES struct LDKCVec_BalanceZ ChannelMonitor_get_claimable_balances(const struct LDKChannelMonitor *NONNULL_PTR this_arg);
14851 * Read a C2Tuple_BlockHashChannelMonitorZ from a byte array, created by C2Tuple_BlockHashChannelMonitorZ_write
14853 struct LDKCResult_C2Tuple_BlockHashChannelMonitorZDecodeErrorZ C2Tuple_BlockHashChannelMonitorZ_read(struct LDKu8slice ser, const struct LDKKeysInterface *NONNULL_PTR arg);
14856 * Frees any resources used by the OutPoint, if is_owned is set and inner is non-NULL.
14858 void OutPoint_free(struct LDKOutPoint this_obj);
14861 * The referenced transaction's txid.
14863 const uint8_t (*OutPoint_get_txid(const struct LDKOutPoint *NONNULL_PTR this_ptr))[32];
14866 * The referenced transaction's txid.
14868 void OutPoint_set_txid(struct LDKOutPoint *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14871 * The index of the referenced output in its transaction's vout.
14873 uint16_t OutPoint_get_index(const struct LDKOutPoint *NONNULL_PTR this_ptr);
14876 * The index of the referenced output in its transaction's vout.
14878 void OutPoint_set_index(struct LDKOutPoint *NONNULL_PTR this_ptr, uint16_t val);
14881 * Constructs a new OutPoint given each field
14883 MUST_USE_RES struct LDKOutPoint OutPoint_new(struct LDKThirtyTwoBytes txid_arg, uint16_t index_arg);
14886 * Creates a copy of the OutPoint
14888 struct LDKOutPoint OutPoint_clone(const struct LDKOutPoint *NONNULL_PTR orig);
14891 * Checks if two OutPoints contain equal inner contents.
14892 * This ignores pointers and is_owned flags and looks at the values in fields.
14893 * Two objects with NULL inner values will be considered "equal" here.
14895 bool OutPoint_eq(const struct LDKOutPoint *NONNULL_PTR a, const struct LDKOutPoint *NONNULL_PTR b);
14898 * Checks if two OutPoints contain equal inner contents.
14900 uint64_t OutPoint_hash(const struct LDKOutPoint *NONNULL_PTR o);
14903 * Convert an `OutPoint` to a lightning channel id.
14905 MUST_USE_RES struct LDKThirtyTwoBytes OutPoint_to_channel_id(const struct LDKOutPoint *NONNULL_PTR this_arg);
14908 * Serialize the OutPoint object into a byte array which can be read by OutPoint_read
14910 struct LDKCVec_u8Z OutPoint_write(const struct LDKOutPoint *NONNULL_PTR obj);
14913 * Read a OutPoint from a byte array, created by OutPoint_write
14915 struct LDKCResult_OutPointDecodeErrorZ OutPoint_read(struct LDKu8slice ser);
14918 * Frees any resources used by the DelayedPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
14920 void DelayedPaymentOutputDescriptor_free(struct LDKDelayedPaymentOutputDescriptor this_obj);
14923 * The outpoint which is spendable
14925 struct LDKOutPoint DelayedPaymentOutputDescriptor_get_outpoint(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
14928 * The outpoint which is spendable
14930 void DelayedPaymentOutputDescriptor_set_outpoint(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKOutPoint val);
14933 * Per commitment point to derive delayed_payment_key by key holder
14935 struct LDKPublicKey DelayedPaymentOutputDescriptor_get_per_commitment_point(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
14938 * Per commitment point to derive delayed_payment_key by key holder
14940 void DelayedPaymentOutputDescriptor_set_per_commitment_point(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14943 * The nSequence value which must be set in the spending input to satisfy the OP_CSV in
14944 * the witness_script.
14946 uint16_t DelayedPaymentOutputDescriptor_get_to_self_delay(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
14949 * The nSequence value which must be set in the spending input to satisfy the OP_CSV in
14950 * the witness_script.
14952 void DelayedPaymentOutputDescriptor_set_to_self_delay(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint16_t val);
14955 * The output which is referenced by the given outpoint
14957 void DelayedPaymentOutputDescriptor_set_output(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKTxOut val);
14960 * The revocation point specific to the commitment transaction which was broadcast. Used to
14961 * derive the witnessScript for this output.
14963 struct LDKPublicKey DelayedPaymentOutputDescriptor_get_revocation_pubkey(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
14966 * The revocation point specific to the commitment transaction which was broadcast. Used to
14967 * derive the witnessScript for this output.
14969 void DelayedPaymentOutputDescriptor_set_revocation_pubkey(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKPublicKey val);
14972 * Arbitrary identification information returned by a call to
14973 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
14974 * the channel to spend the output.
14976 const uint8_t (*DelayedPaymentOutputDescriptor_get_channel_keys_id(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr))[32];
14979 * Arbitrary identification information returned by a call to
14980 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
14981 * the channel to spend the output.
14983 void DelayedPaymentOutputDescriptor_set_channel_keys_id(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
14986 * The value of the channel which this output originated from, possibly indirectly.
14988 uint64_t DelayedPaymentOutputDescriptor_get_channel_value_satoshis(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr);
14991 * The value of the channel which this output originated from, possibly indirectly.
14993 void DelayedPaymentOutputDescriptor_set_channel_value_satoshis(struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint64_t val);
14996 * Constructs a new DelayedPaymentOutputDescriptor given each field
14998 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);
15001 * Creates a copy of the DelayedPaymentOutputDescriptor
15003 struct LDKDelayedPaymentOutputDescriptor DelayedPaymentOutputDescriptor_clone(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR orig);
15006 * Serialize the DelayedPaymentOutputDescriptor object into a byte array which can be read by DelayedPaymentOutputDescriptor_read
15008 struct LDKCVec_u8Z DelayedPaymentOutputDescriptor_write(const struct LDKDelayedPaymentOutputDescriptor *NONNULL_PTR obj);
15011 * Read a DelayedPaymentOutputDescriptor from a byte array, created by DelayedPaymentOutputDescriptor_write
15013 struct LDKCResult_DelayedPaymentOutputDescriptorDecodeErrorZ DelayedPaymentOutputDescriptor_read(struct LDKu8slice ser);
15016 * Frees any resources used by the StaticPaymentOutputDescriptor, if is_owned is set and inner is non-NULL.
15018 void StaticPaymentOutputDescriptor_free(struct LDKStaticPaymentOutputDescriptor this_obj);
15021 * The outpoint which is spendable
15023 struct LDKOutPoint StaticPaymentOutputDescriptor_get_outpoint(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr);
15026 * The outpoint which is spendable
15028 void StaticPaymentOutputDescriptor_set_outpoint(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKOutPoint val);
15031 * The output which is referenced by the given outpoint
15033 void StaticPaymentOutputDescriptor_set_output(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKTxOut val);
15036 * Arbitrary identification information returned by a call to
15037 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
15038 * the channel to spend the output.
15040 const uint8_t (*StaticPaymentOutputDescriptor_get_channel_keys_id(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr))[32];
15043 * Arbitrary identification information returned by a call to
15044 * `Sign::channel_keys_id()`. This may be useful in re-deriving keys used in
15045 * the channel to spend the output.
15047 void StaticPaymentOutputDescriptor_set_channel_keys_id(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
15050 * The value of the channel which this transactions spends.
15052 uint64_t StaticPaymentOutputDescriptor_get_channel_value_satoshis(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr);
15055 * The value of the channel which this transactions spends.
15057 void StaticPaymentOutputDescriptor_set_channel_value_satoshis(struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR this_ptr, uint64_t val);
15060 * Constructs a new StaticPaymentOutputDescriptor given each field
15062 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);
15065 * Creates a copy of the StaticPaymentOutputDescriptor
15067 struct LDKStaticPaymentOutputDescriptor StaticPaymentOutputDescriptor_clone(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR orig);
15070 * Serialize the StaticPaymentOutputDescriptor object into a byte array which can be read by StaticPaymentOutputDescriptor_read
15072 struct LDKCVec_u8Z StaticPaymentOutputDescriptor_write(const struct LDKStaticPaymentOutputDescriptor *NONNULL_PTR obj);
15075 * Read a StaticPaymentOutputDescriptor from a byte array, created by StaticPaymentOutputDescriptor_write
15077 struct LDKCResult_StaticPaymentOutputDescriptorDecodeErrorZ StaticPaymentOutputDescriptor_read(struct LDKu8slice ser);
15080 * Frees any resources used by the SpendableOutputDescriptor
15082 void SpendableOutputDescriptor_free(struct LDKSpendableOutputDescriptor this_ptr);
15085 * Creates a copy of the SpendableOutputDescriptor
15087 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_clone(const struct LDKSpendableOutputDescriptor *NONNULL_PTR orig);
15090 * Utility method to constructs a new StaticOutput-variant SpendableOutputDescriptor
15092 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_static_output(struct LDKOutPoint outpoint, struct LDKTxOut output);
15095 * Utility method to constructs a new DelayedPaymentOutput-variant SpendableOutputDescriptor
15097 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_delayed_payment_output(struct LDKDelayedPaymentOutputDescriptor a);
15100 * Utility method to constructs a new StaticPaymentOutput-variant SpendableOutputDescriptor
15102 struct LDKSpendableOutputDescriptor SpendableOutputDescriptor_static_payment_output(struct LDKStaticPaymentOutputDescriptor a);
15105 * Serialize the SpendableOutputDescriptor object into a byte array which can be read by SpendableOutputDescriptor_read
15107 struct LDKCVec_u8Z SpendableOutputDescriptor_write(const struct LDKSpendableOutputDescriptor *NONNULL_PTR obj);
15110 * Read a SpendableOutputDescriptor from a byte array, created by SpendableOutputDescriptor_write
15112 struct LDKCResult_SpendableOutputDescriptorDecodeErrorZ SpendableOutputDescriptor_read(struct LDKu8slice ser);
15115 * Calls the free function if one is set
15117 void BaseSign_free(struct LDKBaseSign this_ptr);
15120 * Creates a copy of a Sign
15122 struct LDKSign Sign_clone(const struct LDKSign *NONNULL_PTR orig);
15125 * Calls the free function if one is set
15127 void Sign_free(struct LDKSign this_ptr);
15130 * Calls the free function if one is set
15132 void KeysInterface_free(struct LDKKeysInterface this_ptr);
15135 * Frees any resources used by the InMemorySigner, if is_owned is set and inner is non-NULL.
15137 void InMemorySigner_free(struct LDKInMemorySigner this_obj);
15140 * Private key of anchor tx
15142 const uint8_t (*InMemorySigner_get_funding_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
15145 * Private key of anchor tx
15147 void InMemorySigner_set_funding_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
15150 * Holder secret key for blinded revocation pubkey
15152 const uint8_t (*InMemorySigner_get_revocation_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
15155 * Holder secret key for blinded revocation pubkey
15157 void InMemorySigner_set_revocation_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
15160 * Holder secret key used for our balance in counterparty-broadcasted commitment transactions
15162 const uint8_t (*InMemorySigner_get_payment_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
15165 * Holder secret key used for our balance in counterparty-broadcasted commitment transactions
15167 void InMemorySigner_set_payment_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
15170 * Holder secret key used in HTLC tx
15172 const uint8_t (*InMemorySigner_get_delayed_payment_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
15175 * Holder secret key used in HTLC tx
15177 void InMemorySigner_set_delayed_payment_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
15180 * Holder htlc secret key used in commitment tx htlc outputs
15182 const uint8_t (*InMemorySigner_get_htlc_base_key(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
15185 * Holder htlc secret key used in commitment tx htlc outputs
15187 void InMemorySigner_set_htlc_base_key(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKSecretKey val);
15192 const uint8_t (*InMemorySigner_get_commitment_seed(const struct LDKInMemorySigner *NONNULL_PTR this_ptr))[32];
15197 void InMemorySigner_set_commitment_seed(struct LDKInMemorySigner *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
15200 * Creates a copy of the InMemorySigner
15202 struct LDKInMemorySigner InMemorySigner_clone(const struct LDKInMemorySigner *NONNULL_PTR orig);
15205 * Create a new InMemorySigner
15207 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);
15210 * Counterparty pubkeys.
15211 * Will panic if ready_channel wasn't called.
15213 MUST_USE_RES struct LDKChannelPublicKeys InMemorySigner_counterparty_pubkeys(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
15216 * The contest_delay value specified by our counterparty and applied on holder-broadcastable
15217 * transactions, ie the amount of time that we have to wait to recover our funds if we
15218 * broadcast a transaction.
15219 * Will panic if ready_channel wasn't called.
15221 MUST_USE_RES uint16_t InMemorySigner_counterparty_selected_contest_delay(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
15224 * The contest_delay value specified by us and applied on transactions broadcastable
15225 * by our counterparty, ie the amount of time that they have to wait to recover their funds
15226 * if they broadcast a transaction.
15227 * Will panic if ready_channel wasn't called.
15229 MUST_USE_RES uint16_t InMemorySigner_holder_selected_contest_delay(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
15232 * Whether the holder is the initiator
15233 * Will panic if ready_channel wasn't called.
15235 MUST_USE_RES bool InMemorySigner_is_outbound(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
15239 * Will panic if ready_channel wasn't called.
15241 MUST_USE_RES struct LDKOutPoint InMemorySigner_funding_outpoint(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
15244 * Obtain a ChannelTransactionParameters for this channel, to be used when verifying or
15245 * building transactions.
15247 * Will panic if ready_channel wasn't called.
15249 MUST_USE_RES struct LDKChannelTransactionParameters InMemorySigner_get_channel_parameters(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
15252 * Sign the single input of spend_tx at index `input_idx` which spends the output
15253 * described by descriptor, returning the witness stack for the input.
15255 * Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
15256 * or is not spending the outpoint described by `descriptor.outpoint`.
15258 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);
15261 * Sign the single input of spend_tx at index `input_idx` which spends the output
15262 * described by descriptor, returning the witness stack for the input.
15264 * Returns an Err if the input at input_idx does not exist, has a non-empty script_sig,
15265 * is not spending the outpoint described by `descriptor.outpoint`, or does not have a
15266 * sequence set to `descriptor.to_self_delay`.
15268 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);
15271 * Constructs a new BaseSign which calls the relevant methods on this_arg.
15272 * This copies the `inner` pointer in this_arg and thus the returned BaseSign must be freed before this_arg is
15274 struct LDKBaseSign InMemorySigner_as_BaseSign(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
15277 * Constructs a new Sign which calls the relevant methods on this_arg.
15278 * This copies the `inner` pointer in this_arg and thus the returned Sign must be freed before this_arg is
15280 struct LDKSign InMemorySigner_as_Sign(const struct LDKInMemorySigner *NONNULL_PTR this_arg);
15283 * Serialize the InMemorySigner object into a byte array which can be read by InMemorySigner_read
15285 struct LDKCVec_u8Z InMemorySigner_write(const struct LDKInMemorySigner *NONNULL_PTR obj);
15288 * Read a InMemorySigner from a byte array, created by InMemorySigner_write
15290 struct LDKCResult_InMemorySignerDecodeErrorZ InMemorySigner_read(struct LDKu8slice ser);
15293 * Frees any resources used by the KeysManager, if is_owned is set and inner is non-NULL.
15295 void KeysManager_free(struct LDKKeysManager this_obj);
15298 * Constructs a KeysManager from a 32-byte seed. If the seed is in some way biased (eg your
15299 * CSRNG is busted) this may panic (but more importantly, you will possibly lose funds).
15300 * starting_time isn't strictly required to actually be a time, but it must absolutely,
15301 * without a doubt, be unique to this instance. ie if you start multiple times with the same
15302 * seed, starting_time must be unique to each run. Thus, the easiest way to achieve this is to
15303 * simply use the current time (with very high precision).
15305 * The seed MUST be backed up safely prior to use so that the keys can be re-created, however,
15306 * obviously, starting_time should be unique every time you reload the library - it is only
15307 * used to generate new ephemeral key data (which will be stored by the individual channel if
15310 * Note that the seed is required to recover certain on-chain funds independent of
15311 * ChannelMonitor data, though a current copy of ChannelMonitor data is also required for any
15312 * channel, and some on-chain during-closing funds.
15314 * Note that until the 0.1 release there is no guarantee of backward compatibility between
15315 * versions. Once the library is more fully supported, the docs will be updated to include a
15316 * detailed description of the guarantee.
15318 MUST_USE_RES struct LDKKeysManager KeysManager_new(const uint8_t (*seed)[32], uint64_t starting_time_secs, uint32_t starting_time_nanos);
15321 * Derive an old Sign containing per-channel secrets based on a key derivation parameters.
15323 * Key derivation parameters are accessible through a per-channel secrets
15324 * Sign::channel_keys_id and is provided inside DynamicOuputP2WSH in case of
15325 * onchain output detection for which a corresponding delayed_payment_key must be derived.
15327 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]);
15330 * Creates a Transaction which spends the given descriptors to the given outputs, plus an
15331 * output to the given change destination (if sufficient change value remains). The
15332 * transaction will have a feerate, at least, of the given value.
15334 * Returns `Err(())` if the output value is greater than the input value minus required fee or
15335 * if a descriptor was duplicated.
15337 * We do not enforce that outputs meet the dust limit or that any output scripts are standard.
15339 * May panic if the `SpendableOutputDescriptor`s were not generated by Channels which used
15340 * this KeysManager or one of the `InMemorySigner` created by this KeysManager.
15342 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);
15345 * Constructs a new KeysInterface which calls the relevant methods on this_arg.
15346 * This copies the `inner` pointer in this_arg and thus the returned KeysInterface must be freed before this_arg is
15348 struct LDKKeysInterface KeysManager_as_KeysInterface(const struct LDKKeysManager *NONNULL_PTR this_arg);
15351 * Frees any resources used by the PaymentId, if is_owned is set and inner is non-NULL.
15353 void PaymentId_free(struct LDKPaymentId this_obj);
15356 * Checks if two PaymentIds contain equal inner contents.
15358 uint64_t PaymentId_hash(const struct LDKPaymentId *NONNULL_PTR o);
15361 * Creates a copy of the PaymentId
15363 struct LDKPaymentId PaymentId_clone(const struct LDKPaymentId *NONNULL_PTR orig);
15366 * Checks if two PaymentIds contain equal inner contents.
15367 * This ignores pointers and is_owned flags and looks at the values in fields.
15368 * Two objects with NULL inner values will be considered "equal" here.
15370 bool PaymentId_eq(const struct LDKPaymentId *NONNULL_PTR a, const struct LDKPaymentId *NONNULL_PTR b);
15373 * Serialize the PaymentId object into a byte array which can be read by PaymentId_read
15375 struct LDKCVec_u8Z PaymentId_write(const struct LDKPaymentId *NONNULL_PTR obj);
15378 * Read a PaymentId from a byte array, created by PaymentId_write
15380 struct LDKCResult_PaymentIdDecodeErrorZ PaymentId_read(struct LDKu8slice ser);
15383 * Frees any resources used by the ChannelManager, if is_owned is set and inner is non-NULL.
15385 void ChannelManager_free(struct LDKChannelManager this_obj);
15388 * Frees any resources used by the ChainParameters, if is_owned is set and inner is non-NULL.
15390 void ChainParameters_free(struct LDKChainParameters this_obj);
15393 * The network for determining the `chain_hash` in Lightning messages.
15395 enum LDKNetwork ChainParameters_get_network(const struct LDKChainParameters *NONNULL_PTR this_ptr);
15398 * The network for determining the `chain_hash` in Lightning messages.
15400 void ChainParameters_set_network(struct LDKChainParameters *NONNULL_PTR this_ptr, enum LDKNetwork val);
15403 * The hash and height of the latest block successfully connected.
15405 * Used to track on-chain channel funding outputs and send payments with reliable timelocks.
15407 struct LDKBestBlock ChainParameters_get_best_block(const struct LDKChainParameters *NONNULL_PTR this_ptr);
15410 * The hash and height of the latest block successfully connected.
15412 * Used to track on-chain channel funding outputs and send payments with reliable timelocks.
15414 void ChainParameters_set_best_block(struct LDKChainParameters *NONNULL_PTR this_ptr, struct LDKBestBlock val);
15417 * Constructs a new ChainParameters given each field
15419 MUST_USE_RES struct LDKChainParameters ChainParameters_new(enum LDKNetwork network_arg, struct LDKBestBlock best_block_arg);
15422 * Creates a copy of the ChainParameters
15424 struct LDKChainParameters ChainParameters_clone(const struct LDKChainParameters *NONNULL_PTR orig);
15427 * Frees any resources used by the CounterpartyForwardingInfo, if is_owned is set and inner is non-NULL.
15429 void CounterpartyForwardingInfo_free(struct LDKCounterpartyForwardingInfo this_obj);
15432 * Base routing fee in millisatoshis.
15434 uint32_t CounterpartyForwardingInfo_get_fee_base_msat(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr);
15437 * Base routing fee in millisatoshis.
15439 void CounterpartyForwardingInfo_set_fee_base_msat(struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr, uint32_t val);
15442 * Amount in millionths of a satoshi the channel will charge per transferred satoshi.
15444 uint32_t CounterpartyForwardingInfo_get_fee_proportional_millionths(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr);
15447 * Amount in millionths of a satoshi the channel will charge per transferred satoshi.
15449 void CounterpartyForwardingInfo_set_fee_proportional_millionths(struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr, uint32_t val);
15452 * The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
15453 * such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
15454 * `cltv_expiry_delta` for more details.
15456 uint16_t CounterpartyForwardingInfo_get_cltv_expiry_delta(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr);
15459 * The minimum difference in cltv_expiry between an ingoing HTLC and its outgoing counterpart,
15460 * such that the outgoing HTLC is forwardable to this counterparty. See `msgs::ChannelUpdate`'s
15461 * `cltv_expiry_delta` for more details.
15463 void CounterpartyForwardingInfo_set_cltv_expiry_delta(struct LDKCounterpartyForwardingInfo *NONNULL_PTR this_ptr, uint16_t val);
15466 * Constructs a new CounterpartyForwardingInfo given each field
15468 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);
15471 * Creates a copy of the CounterpartyForwardingInfo
15473 struct LDKCounterpartyForwardingInfo CounterpartyForwardingInfo_clone(const struct LDKCounterpartyForwardingInfo *NONNULL_PTR orig);
15476 * Frees any resources used by the ChannelCounterparty, if is_owned is set and inner is non-NULL.
15478 void ChannelCounterparty_free(struct LDKChannelCounterparty this_obj);
15481 * The node_id of our counterparty
15483 struct LDKPublicKey ChannelCounterparty_get_node_id(const struct LDKChannelCounterparty *NONNULL_PTR this_ptr);
15486 * The node_id of our counterparty
15488 void ChannelCounterparty_set_node_id(struct LDKChannelCounterparty *NONNULL_PTR this_ptr, struct LDKPublicKey val);
15491 * The Features the channel counterparty provided upon last connection.
15492 * Useful for routing as it is the most up-to-date copy of the counterparty's features and
15493 * many routing-relevant features are present in the init context.
15495 struct LDKInitFeatures ChannelCounterparty_get_features(const struct LDKChannelCounterparty *NONNULL_PTR this_ptr);
15498 * The Features the channel counterparty provided upon last connection.
15499 * Useful for routing as it is the most up-to-date copy of the counterparty's features and
15500 * many routing-relevant features are present in the init context.
15502 void ChannelCounterparty_set_features(struct LDKChannelCounterparty *NONNULL_PTR this_ptr, struct LDKInitFeatures val);
15505 * The value, in satoshis, that must always be held in the channel for our counterparty. This
15506 * value ensures that if our counterparty broadcasts a revoked state, we can punish them by
15507 * claiming at least this value on chain.
15509 * This value is not included in [`inbound_capacity_msat`] as it can never be spent.
15511 * [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
15513 uint64_t ChannelCounterparty_get_unspendable_punishment_reserve(const struct LDKChannelCounterparty *NONNULL_PTR this_ptr);
15516 * The value, in satoshis, that must always be held in the channel for our counterparty. This
15517 * value ensures that if our counterparty broadcasts a revoked state, we can punish them by
15518 * claiming at least this value on chain.
15520 * This value is not included in [`inbound_capacity_msat`] as it can never be spent.
15522 * [`inbound_capacity_msat`]: ChannelDetails::inbound_capacity_msat
15524 void ChannelCounterparty_set_unspendable_punishment_reserve(struct LDKChannelCounterparty *NONNULL_PTR this_ptr, uint64_t val);
15527 * Information on the fees and requirements that the counterparty requires when forwarding
15528 * payments to us through this channel.
15530 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
15532 struct LDKCounterpartyForwardingInfo ChannelCounterparty_get_forwarding_info(const struct LDKChannelCounterparty *NONNULL_PTR this_ptr);
15535 * Information on the fees and requirements that the counterparty requires when forwarding
15536 * payments to us through this channel.
15538 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
15540 void ChannelCounterparty_set_forwarding_info(struct LDKChannelCounterparty *NONNULL_PTR this_ptr, struct LDKCounterpartyForwardingInfo val);
15543 * Constructs a new ChannelCounterparty given each field
15545 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);
15548 * Creates a copy of the ChannelCounterparty
15550 struct LDKChannelCounterparty ChannelCounterparty_clone(const struct LDKChannelCounterparty *NONNULL_PTR orig);
15553 * Frees any resources used by the ChannelDetails, if is_owned is set and inner is non-NULL.
15555 void ChannelDetails_free(struct LDKChannelDetails this_obj);
15558 * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
15559 * thereafter this is the txid of the funding transaction xor the funding transaction output).
15560 * Note that this means this value is *not* persistent - it can change once during the
15561 * lifetime of the channel.
15563 const uint8_t (*ChannelDetails_get_channel_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr))[32];
15566 * The channel's ID (prior to funding transaction generation, this is a random 32 bytes,
15567 * thereafter this is the txid of the funding transaction xor the funding transaction output).
15568 * Note that this means this value is *not* persistent - it can change once during the
15569 * lifetime of the channel.
15571 void ChannelDetails_set_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
15574 * Parameters which apply to our counterparty. See individual fields for more information.
15576 struct LDKChannelCounterparty ChannelDetails_get_counterparty(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15579 * Parameters which apply to our counterparty. See individual fields for more information.
15581 void ChannelDetails_set_counterparty(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKChannelCounterparty val);
15584 * The Channel's funding transaction output, if we've negotiated the funding transaction with
15585 * our counterparty already.
15587 * Note that, if this has been set, `channel_id` will be equivalent to
15588 * `funding_txo.unwrap().to_channel_id()`.
15590 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
15592 struct LDKOutPoint ChannelDetails_get_funding_txo(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15595 * The Channel's funding transaction output, if we've negotiated the funding transaction with
15596 * our counterparty already.
15598 * Note that, if this has been set, `channel_id` will be equivalent to
15599 * `funding_txo.unwrap().to_channel_id()`.
15601 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
15603 void ChannelDetails_set_funding_txo(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKOutPoint val);
15606 * The position of the funding transaction in the chain. None if the funding transaction has
15607 * not yet been confirmed and the channel fully opened.
15609 struct LDKCOption_u64Z ChannelDetails_get_short_channel_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15612 * The position of the funding transaction in the chain. None if the funding transaction has
15613 * not yet been confirmed and the channel fully opened.
15615 void ChannelDetails_set_short_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
15618 * The value, in satoshis, of this channel as appears in the funding output
15620 uint64_t ChannelDetails_get_channel_value_satoshis(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15623 * The value, in satoshis, of this channel as appears in the funding output
15625 void ChannelDetails_set_channel_value_satoshis(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
15628 * The value, in satoshis, that must always be held in the channel for us. This value ensures
15629 * that if we broadcast a revoked state, our counterparty can punish us by claiming at least
15630 * this value on chain.
15632 * This value is not included in [`outbound_capacity_msat`] as it can never be spent.
15634 * This value will be `None` for outbound channels until the counterparty accepts the channel.
15636 * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
15638 struct LDKCOption_u64Z ChannelDetails_get_unspendable_punishment_reserve(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15641 * The value, in satoshis, that must always be held in the channel for us. This value ensures
15642 * that if we broadcast a revoked state, our counterparty can punish us by claiming at least
15643 * this value on chain.
15645 * This value is not included in [`outbound_capacity_msat`] as it can never be spent.
15647 * This value will be `None` for outbound channels until the counterparty accepts the channel.
15649 * [`outbound_capacity_msat`]: ChannelDetails::outbound_capacity_msat
15651 void ChannelDetails_set_unspendable_punishment_reserve(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
15654 * The `user_channel_id` passed in to create_channel, or 0 if the channel was inbound.
15656 uint64_t ChannelDetails_get_user_channel_id(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15659 * The `user_channel_id` passed in to create_channel, or 0 if the channel was inbound.
15661 void ChannelDetails_set_user_channel_id(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
15664 * The available outbound capacity for sending HTLCs to the remote peer. This does not include
15665 * any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
15666 * available for inclusion in new outbound HTLCs). This further does not include any pending
15667 * outgoing HTLCs which are awaiting some other resolution to be sent.
15669 * This value is not exact. Due to various in-flight changes, feerate changes, and our
15670 * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
15671 * should be able to spend nearly this amount.
15673 uint64_t ChannelDetails_get_outbound_capacity_msat(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15676 * The available outbound capacity for sending HTLCs to the remote peer. This does not include
15677 * any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
15678 * available for inclusion in new outbound HTLCs). This further does not include any pending
15679 * outgoing HTLCs which are awaiting some other resolution to be sent.
15681 * This value is not exact. Due to various in-flight changes, feerate changes, and our
15682 * conflict-avoidance policy, exactly this amount is not likely to be spendable. However, we
15683 * should be able to spend nearly this amount.
15685 void ChannelDetails_set_outbound_capacity_msat(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
15688 * The available inbound capacity for the remote peer to send HTLCs to us. This does not
15689 * include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
15690 * available for inclusion in new inbound HTLCs).
15691 * Note that there are some corner cases not fully handled here, so the actual available
15692 * inbound capacity may be slightly higher than this.
15694 * This value is not exact. Due to various in-flight changes, feerate changes, and our
15695 * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
15696 * However, our counterparty should be able to spend nearly this amount.
15698 uint64_t ChannelDetails_get_inbound_capacity_msat(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15701 * The available inbound capacity for the remote peer to send HTLCs to us. This does not
15702 * include any pending HTLCs which are not yet fully resolved (and, thus, who's balance is not
15703 * available for inclusion in new inbound HTLCs).
15704 * Note that there are some corner cases not fully handled here, so the actual available
15705 * inbound capacity may be slightly higher than this.
15707 * This value is not exact. Due to various in-flight changes, feerate changes, and our
15708 * counterparty's conflict-avoidance policy, exactly this amount is not likely to be spendable.
15709 * However, our counterparty should be able to spend nearly this amount.
15711 void ChannelDetails_set_inbound_capacity_msat(struct LDKChannelDetails *NONNULL_PTR this_ptr, uint64_t val);
15714 * The number of required confirmations on the funding transaction before the funding will be
15715 * considered \"locked\". This number is selected by the channel fundee (i.e. us if
15716 * [`is_outbound`] is *not* set), and can be selected for inbound channels with
15717 * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
15718 * [`ChannelHandshakeLimits::max_minimum_depth`].
15720 * This value will be `None` for outbound channels until the counterparty accepts the channel.
15722 * [`is_outbound`]: ChannelDetails::is_outbound
15723 * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
15724 * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
15726 struct LDKCOption_u32Z ChannelDetails_get_confirmations_required(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15729 * The number of required confirmations on the funding transaction before the funding will be
15730 * considered \"locked\". This number is selected by the channel fundee (i.e. us if
15731 * [`is_outbound`] is *not* set), and can be selected for inbound channels with
15732 * [`ChannelHandshakeConfig::minimum_depth`] or limited for outbound channels with
15733 * [`ChannelHandshakeLimits::max_minimum_depth`].
15735 * This value will be `None` for outbound channels until the counterparty accepts the channel.
15737 * [`is_outbound`]: ChannelDetails::is_outbound
15738 * [`ChannelHandshakeConfig::minimum_depth`]: crate::util::config::ChannelHandshakeConfig::minimum_depth
15739 * [`ChannelHandshakeLimits::max_minimum_depth`]: crate::util::config::ChannelHandshakeLimits::max_minimum_depth
15741 void ChannelDetails_set_confirmations_required(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u32Z val);
15744 * The number of blocks (after our commitment transaction confirms) that we will need to wait
15745 * until we can claim our funds after we force-close the channel. During this time our
15746 * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
15747 * force-closes the channel and broadcasts a commitment transaction we do not have to wait any
15748 * time to claim our non-HTLC-encumbered funds.
15750 * This value will be `None` for outbound channels until the counterparty accepts the channel.
15752 struct LDKCOption_u16Z ChannelDetails_get_force_close_spend_delay(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15755 * The number of blocks (after our commitment transaction confirms) that we will need to wait
15756 * until we can claim our funds after we force-close the channel. During this time our
15757 * counterparty is allowed to punish us if we broadcasted a stale state. If our counterparty
15758 * force-closes the channel and broadcasts a commitment transaction we do not have to wait any
15759 * time to claim our non-HTLC-encumbered funds.
15761 * This value will be `None` for outbound channels until the counterparty accepts the channel.
15763 void ChannelDetails_set_force_close_spend_delay(struct LDKChannelDetails *NONNULL_PTR this_ptr, struct LDKCOption_u16Z val);
15766 * True if the channel was initiated (and thus funded) by us.
15768 bool ChannelDetails_get_is_outbound(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15771 * True if the channel was initiated (and thus funded) by us.
15773 void ChannelDetails_set_is_outbound(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
15776 * True if the channel is confirmed, funding_locked messages have been exchanged, and the
15777 * channel is not currently being shut down. `funding_locked` message exchange implies the
15778 * required confirmation count has been reached (and we were connected to the peer at some
15779 * point after the funding transaction received enough confirmations). The required
15780 * confirmation count is provided in [`confirmations_required`].
15782 * [`confirmations_required`]: ChannelDetails::confirmations_required
15784 bool ChannelDetails_get_is_funding_locked(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15787 * True if the channel is confirmed, funding_locked messages have been exchanged, and the
15788 * channel is not currently being shut down. `funding_locked` message exchange implies the
15789 * required confirmation count has been reached (and we were connected to the peer at some
15790 * point after the funding transaction received enough confirmations). The required
15791 * confirmation count is provided in [`confirmations_required`].
15793 * [`confirmations_required`]: ChannelDetails::confirmations_required
15795 void ChannelDetails_set_is_funding_locked(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
15798 * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
15799 * the peer is connected, and (c) the channel is not currently negotiating a shutdown.
15801 * This is a strict superset of `is_funding_locked`.
15803 bool ChannelDetails_get_is_usable(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15806 * True if the channel is (a) confirmed and funding_locked messages have been exchanged, (b)
15807 * the peer is connected, and (c) the channel is not currently negotiating a shutdown.
15809 * This is a strict superset of `is_funding_locked`.
15811 void ChannelDetails_set_is_usable(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
15814 * True if this channel is (or will be) publicly-announced.
15816 bool ChannelDetails_get_is_public(const struct LDKChannelDetails *NONNULL_PTR this_ptr);
15819 * True if this channel is (or will be) publicly-announced.
15821 void ChannelDetails_set_is_public(struct LDKChannelDetails *NONNULL_PTR this_ptr, bool val);
15824 * Constructs a new ChannelDetails given each field
15826 MUST_USE_RES struct LDKChannelDetails ChannelDetails_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKChannelCounterparty counterparty_arg, struct LDKOutPoint funding_txo_arg, struct LDKCOption_u64Z short_channel_id_arg, uint64_t channel_value_satoshis_arg, struct LDKCOption_u64Z unspendable_punishment_reserve_arg, uint64_t user_channel_id_arg, uint64_t 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);
15829 * Creates a copy of the ChannelDetails
15831 struct LDKChannelDetails ChannelDetails_clone(const struct LDKChannelDetails *NONNULL_PTR orig);
15834 * Frees any resources used by the PaymentSendFailure
15836 void PaymentSendFailure_free(struct LDKPaymentSendFailure this_ptr);
15839 * Creates a copy of the PaymentSendFailure
15841 struct LDKPaymentSendFailure PaymentSendFailure_clone(const struct LDKPaymentSendFailure *NONNULL_PTR orig);
15844 * Utility method to constructs a new ParameterError-variant PaymentSendFailure
15846 struct LDKPaymentSendFailure PaymentSendFailure_parameter_error(struct LDKAPIError a);
15849 * Utility method to constructs a new PathParameterError-variant PaymentSendFailure
15851 struct LDKPaymentSendFailure PaymentSendFailure_path_parameter_error(struct LDKCVec_CResult_NoneAPIErrorZZ a);
15854 * Utility method to constructs a new AllFailedRetrySafe-variant PaymentSendFailure
15856 struct LDKPaymentSendFailure PaymentSendFailure_all_failed_retry_safe(struct LDKCVec_APIErrorZ a);
15859 * Utility method to constructs a new PartialFailure-variant PaymentSendFailure
15861 struct LDKPaymentSendFailure PaymentSendFailure_partial_failure(struct LDKCVec_CResult_NoneAPIErrorZZ a);
15864 * Constructs a new ChannelManager to hold several channels and route between them.
15866 * This is the main \"logic hub\" for all channel-related actions, and implements
15867 * ChannelMessageHandler.
15869 * Non-proportional fees are fixed according to our risk using the provided fee estimator.
15871 * panics if channel_value_satoshis is >= `MAX_FUNDING_SATOSHIS`!
15873 * Users need to notify the new ChannelManager when a new block is connected or
15874 * disconnected using its `block_connected` and `block_disconnected` methods, starting
15875 * from after `params.latest_hash`.
15877 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);
15880 * Gets the current configuration applied to all new channels, as
15882 MUST_USE_RES struct LDKUserConfig ChannelManager_get_current_default_configuration(const struct LDKChannelManager *NONNULL_PTR this_arg);
15885 * Creates a new outbound channel to the given remote node and with the given value.
15887 * `user_channel_id` will be provided back as in
15888 * [`Event::FundingGenerationReady::user_channel_id`] to allow tracking of which events
15889 * correspond with which `create_channel` call. Note that the `user_channel_id` defaults to 0
15890 * for inbound channels, so you may wish to avoid using 0 for `user_channel_id` here.
15891 * `user_channel_id` has no meaning inside of LDK, it is simply copied to events and otherwise
15894 * Raises [`APIError::APIMisuseError`] when `channel_value_satoshis` > 2**24 or `push_msat` is
15895 * greater than `channel_value_satoshis * 1k` or `channel_value_satoshis < 1000`.
15897 * Note that we do not check if you are currently connected to the given peer. If no
15898 * connection is available, the outbound `open_channel` message may fail to send, resulting in
15899 * the channel eventually being silently forgotten (dropped on reload).
15901 * Returns the new Channel's temporary `channel_id`. This ID will appear as
15902 * [`Event::FundingGenerationReady::temporary_channel_id`] and in
15903 * [`ChannelDetails::channel_id`] until after
15904 * [`ChannelManager::funding_transaction_generated`] is called, swapping the Channel's ID for
15905 * one derived from the funding transaction's TXID. If the counterparty rejects the channel
15906 * immediately, this temporary ID will appear in [`Event::ChannelClosed::channel_id`].
15908 * [`Event::FundingGenerationReady::user_channel_id`]: events::Event::FundingGenerationReady::user_channel_id
15909 * [`Event::FundingGenerationReady::temporary_channel_id`]: events::Event::FundingGenerationReady::temporary_channel_id
15910 * [`Event::ChannelClosed::channel_id`]: events::Event::ChannelClosed::channel_id
15912 * Note that override_config (or a relevant inner pointer) may be NULL or all-0s to represent None
15914 MUST_USE_RES struct LDKCResult__u832APIErrorZ ChannelManager_create_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKPublicKey their_network_key, uint64_t channel_value_satoshis, uint64_t push_msat, uint64_t user_channel_id, struct LDKUserConfig override_config);
15917 * Gets the list of open channels, in random order. See ChannelDetail field documentation for
15918 * more information.
15920 MUST_USE_RES struct LDKCVec_ChannelDetailsZ ChannelManager_list_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
15923 * Gets the list of usable channels, in random order. Useful as an argument to
15924 * get_route to ensure non-announced channels are used.
15926 * These are guaranteed to have their [`ChannelDetails::is_usable`] value set to true, see the
15927 * documentation for [`ChannelDetails::is_usable`] for more info on exactly what the criteria
15930 MUST_USE_RES struct LDKCVec_ChannelDetailsZ ChannelManager_list_usable_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
15933 * Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
15934 * will be accepted on the given channel, and after additional timeout/the closing of all
15935 * pending HTLCs, the channel will be closed on chain.
15937 * * If we are the channel initiator, we will pay between our [`Background`] and
15938 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
15940 * * If our counterparty is the channel initiator, we will require a channel closing
15941 * transaction feerate of at least our [`Background`] feerate or the feerate which
15942 * would appear on a force-closure transaction, whichever is lower. We will allow our
15943 * counterparty to pay as much fee as they'd like, however.
15945 * May generate a SendShutdown message event on success, which should be relayed.
15947 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
15948 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
15949 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
15951 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_close_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*channel_id)[32]);
15954 * Begins the process of closing a channel. After this call (plus some timeout), no new HTLCs
15955 * will be accepted on the given channel, and after additional timeout/the closing of all
15956 * pending HTLCs, the channel will be closed on chain.
15958 * `target_feerate_sat_per_1000_weight` has different meanings depending on if we initiated
15959 * the channel being closed or not:
15960 * * If we are the channel initiator, we will pay at least this feerate on the closing
15961 * transaction. The upper-bound is set by
15962 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`] plus our [`Normal`] fee
15963 * estimate (or `target_feerate_sat_per_1000_weight`, if it is greater).
15964 * * If our counterparty is the channel initiator, we will refuse to accept a channel closure
15965 * transaction feerate below `target_feerate_sat_per_1000_weight` (or the feerate which
15966 * will appear on a force-closure transaction, whichever is lower).
15968 * May generate a SendShutdown message event on success, which should be relayed.
15970 * [`ChannelConfig::force_close_avoidance_max_fee_satoshis`]: crate::util::config::ChannelConfig::force_close_avoidance_max_fee_satoshis
15971 * [`Background`]: crate::chain::chaininterface::ConfirmationTarget::Background
15972 * [`Normal`]: crate::chain::chaininterface::ConfirmationTarget::Normal
15974 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);
15977 * Force closes a channel, immediately broadcasting the latest local commitment transaction to
15978 * the chain and rejecting new HTLCs on the given channel. Fails if channel_id is unknown to the manager.
15980 MUST_USE_RES struct LDKCResult_NoneAPIErrorZ ChannelManager_force_close_channel(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*channel_id)[32]);
15983 * Force close all channels, immediately broadcasting the latest local commitment transaction
15984 * for each to the chain and rejecting new HTLCs on each.
15986 void ChannelManager_force_close_all_channels(const struct LDKChannelManager *NONNULL_PTR this_arg);
15989 * Sends a payment along a given route.
15991 * Value parameters are provided via the last hop in route, see documentation for RouteHop
15992 * fields for more info.
15994 * Note that if the payment_hash already exists elsewhere (eg you're sending a duplicative
15995 * payment), we don't do anything to stop you! We always try to ensure that if the provided
15996 * next hop knows the preimage to payment_hash they can claim an additional amount as
15997 * specified in the last hop in the route! Thus, you should probably do your own
15998 * payment_preimage tracking (which you should already be doing as they represent \"proof of
15999 * payment\") and prevent double-sends yourself.
16001 * May generate SendHTLCs message(s) event on success, which should be relayed.
16003 * Each path may have a different return value, and PaymentSendValue may return a Vec with
16004 * each entry matching the corresponding-index entry in the route paths, see
16005 * PaymentSendFailure for more info.
16007 * In general, a path may raise:
16008 * * APIError::RouteError when an invalid route or forwarding parameter (cltv_delta, fee,
16009 * node public key) is specified.
16010 * * APIError::ChannelUnavailable if the next-hop channel is not available for updates
16011 * (including due to previous monitor update failure or new permanent monitor update
16013 * * APIError::MonitorUpdateFailed if a new monitor update failure prevented sending the
16014 * relevant updates.
16016 * Note that depending on the type of the PaymentSendFailure the HTLC may have been
16017 * irrevocably committed to on our end. In such a case, do NOT retry the payment with a
16018 * different route unless you intend to pay twice!
16020 * payment_secret is unrelated to payment_hash (or PaymentPreimage) and exists to authenticate
16021 * the sender to the recipient and prevent payment-probing (deanonymization) attacks. For
16022 * newer nodes, it will be provided to you in the invoice. If you do not have one, the Route
16023 * must not contain multiple paths as multi-path payments require a recipient-provided
16025 * If a payment_secret *is* provided, we assume that the invoice had the payment_secret feature
16026 * bit set (either as required or as available). If multiple paths are present in the Route,
16027 * we assume the invoice had the basic_mpp feature set.
16029 * Note that payment_secret (or a relevant inner pointer) may be NULL or all-0s to represent None
16031 MUST_USE_RES struct LDKCResult_PaymentIdPaymentSendFailureZ ChannelManager_send_payment(const struct LDKChannelManager *NONNULL_PTR this_arg, const struct LDKRoute *NONNULL_PTR route, struct LDKThirtyTwoBytes payment_hash, struct LDKThirtyTwoBytes payment_secret);
16034 * Retries a payment along the given [`Route`].
16036 * Errors returned are a superset of those returned from [`send_payment`], so see
16037 * [`send_payment`] documentation for more details on errors. This method will also error if the
16038 * retry amount puts the payment more than 10% over the payment's total amount, or if the payment
16039 * for the given `payment_id` cannot be found (likely due to timeout or success).
16041 * [`send_payment`]: [`ChannelManager::send_payment`]
16043 MUST_USE_RES struct LDKCResult_NonePaymentSendFailureZ ChannelManager_retry_payment(const struct LDKChannelManager *NONNULL_PTR this_arg, const struct LDKRoute *NONNULL_PTR route, struct LDKPaymentId payment_id);
16046 * Send a spontaneous payment, which is a payment that does not require the recipient to have
16047 * generated an invoice. Optionally, you may specify the preimage. If you do choose to specify
16048 * the preimage, it must be a cryptographically secure random value that no intermediate node
16049 * would be able to guess -- otherwise, an intermediate node may claim the payment and it will
16050 * never reach the recipient.
16052 * See [`send_payment`] documentation for more details on the return value of this function.
16054 * Similar to regular payments, you MUST NOT reuse a `payment_preimage` value. See
16055 * [`send_payment`] for more information about the risks of duplicate preimage usage.
16057 * Note that `route` must have exactly one path.
16059 * [`send_payment`]: Self::send_payment
16061 * Note that payment_preimage (or a relevant inner pointer) may be NULL or all-0s to represent None
16063 MUST_USE_RES struct LDKCResult_C2Tuple_PaymentHashPaymentIdZPaymentSendFailureZ ChannelManager_send_spontaneous_payment(const struct LDKChannelManager *NONNULL_PTR this_arg, const struct LDKRoute *NONNULL_PTR route, struct LDKThirtyTwoBytes payment_preimage);
16066 * Call this upon creation of a funding transaction for the given channel.
16068 * Returns an [`APIError::APIMisuseError`] if the funding_transaction spent non-SegWit outputs
16069 * or if no output was found which matches the parameters in [`Event::FundingGenerationReady`].
16071 * Panics if a funding transaction has already been provided for this channel.
16073 * May panic if the output found in the funding transaction is duplicative with some other
16074 * channel (note that this should be trivially prevented by using unique funding transaction
16075 * keys per-channel).
16077 * Do NOT broadcast the funding transaction yourself. When we have safely received our
16078 * counterparty's signature the funding transaction will automatically be broadcast via the
16079 * [`BroadcasterInterface`] provided when this `ChannelManager` was constructed.
16081 * Note that this includes RBF or similar transaction replacement strategies - lightning does
16082 * not currently support replacing a funding transaction on an existing channel. Instead,
16083 * create a new channel with a conflicting funding transaction.
16085 * [`Event::FundingGenerationReady`]: crate::util::events::Event::FundingGenerationReady
16087 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);
16090 * Regenerates channel_announcements and generates a signed node_announcement from the given
16091 * arguments, providing them in corresponding events via
16092 * [`get_and_clear_pending_msg_events`], if at least one public channel has been confirmed
16093 * on-chain. This effectively re-broadcasts all channel announcements and sends our node
16094 * announcement to ensure that the lightning P2P network is aware of the channels we have and
16095 * our network addresses.
16097 * `rgb` is a node \"color\" and `alias` is a printable human-readable string to describe this
16098 * node to humans. They carry no in-protocol meaning.
16100 * `addresses` represent the set (possibly empty) of socket addresses on which this node
16101 * accepts incoming connections. These will be included in the node_announcement, publicly
16102 * tying these addresses together and to this node. If you wish to preserve user privacy,
16103 * addresses should likely contain only Tor Onion addresses.
16105 * Panics if `addresses` is absurdly large (more than 500).
16107 * [`get_and_clear_pending_msg_events`]: MessageSendEventsProvider::get_and_clear_pending_msg_events
16109 void ChannelManager_broadcast_node_announcement(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThreeBytes rgb, struct LDKThirtyTwoBytes alias, struct LDKCVec_NetAddressZ addresses);
16112 * Processes HTLCs which are pending waiting on random forward delay.
16114 * Should only really ever be called in response to a PendingHTLCsForwardable event.
16115 * Will likely generate further events.
16117 void ChannelManager_process_pending_htlc_forwards(const struct LDKChannelManager *NONNULL_PTR this_arg);
16120 * Performs actions which should happen on startup and roughly once per minute thereafter.
16122 * This currently includes:
16123 * * Increasing or decreasing the on-chain feerate estimates for our outbound channels,
16124 * * Broadcasting `ChannelUpdate` messages if we've been disconnected from our peer for more
16125 * than a minute, informing the network that they should no longer attempt to route over
16128 * Note that this may cause reentrancy through `chain::Watch::update_channel` calls or feerate
16129 * estimate fetches.
16131 void ChannelManager_timer_tick_occurred(const struct LDKChannelManager *NONNULL_PTR this_arg);
16134 * Indicates that the preimage for payment_hash is unknown or the received amount is incorrect
16135 * after a PaymentReceived event, failing the HTLC back to its origin and freeing resources
16136 * along the path (including in our own channel on which we received it).
16137 * Returns false if no payment was found to fail backwards, true if the process of failing the
16138 * HTLC backwards has been started.
16140 MUST_USE_RES bool ChannelManager_fail_htlc_backwards(const struct LDKChannelManager *NONNULL_PTR this_arg, const uint8_t (*payment_hash)[32]);
16143 * Provides a payment preimage in response to a PaymentReceived event, returning true and
16144 * generating message events for the net layer to claim the payment, if possible. Thus, you
16145 * should probably kick the net layer to go send messages if this returns true!
16147 * Note that if you did not set an `amount_msat` when calling [`create_inbound_payment`] or
16148 * [`create_inbound_payment_for_hash`] you must check that the amount in the `PaymentReceived`
16149 * event matches your expectation. If you fail to do so and call this method, you may provide
16150 * the sender \"proof-of-payment\" when they did not fulfill the full expected payment.
16152 * May panic if called except in response to a PaymentReceived event.
16154 * [`create_inbound_payment`]: Self::create_inbound_payment
16155 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
16157 MUST_USE_RES bool ChannelManager_claim_funds(const struct LDKChannelManager *NONNULL_PTR this_arg, struct LDKThirtyTwoBytes payment_preimage);
16160 * Gets the node_id held by this ChannelManager
16162 MUST_USE_RES struct LDKPublicKey ChannelManager_get_our_node_id(const struct LDKChannelManager *NONNULL_PTR this_arg);
16165 * Restores a single, given channel to normal operation after a
16166 * ChannelMonitorUpdateErr::TemporaryFailure was returned from a channel monitor update
16169 * All ChannelMonitor updates up to and including highest_applied_update_id must have been
16170 * fully committed in every copy of the given channels' ChannelMonitors.
16172 * Note that there is no effect to calling with a highest_applied_update_id other than the
16173 * current latest ChannelMonitorUpdate and one call to this function after multiple
16174 * ChannelMonitorUpdateErr::TemporaryFailures is fine. The highest_applied_update_id field
16175 * exists largely only to prevent races between this and concurrent update_monitor calls.
16177 * Thus, the anticipated use is, at a high level:
16178 * 1) You register a chain::Watch with this ChannelManager,
16179 * 2) it stores each update to disk, and begins updating any remote (eg watchtower) copies of
16180 * said ChannelMonitors as it can, returning ChannelMonitorUpdateErr::TemporaryFailures
16181 * any time it cannot do so instantly,
16182 * 3) update(s) are applied to each remote copy of a ChannelMonitor,
16183 * 4) once all remote copies are updated, you call this function with the update_id that
16184 * completed, and once it is the latest the Channel will be re-enabled.
16186 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);
16189 * Gets a payment secret and payment hash for use in an invoice given to a third party wishing
16192 * This differs from [`create_inbound_payment_for_hash`] only in that it generates the
16193 * [`PaymentHash`] and [`PaymentPreimage`] for you, returning the first and storing the second.
16195 * The [`PaymentPreimage`] will ultimately be returned to you in the [`PaymentReceived`], which
16196 * will have the [`PaymentReceived::payment_preimage`] field filled in. That should then be
16197 * passed directly to [`claim_funds`].
16199 * See [`create_inbound_payment_for_hash`] for detailed documentation on behavior and requirements.
16201 * [`claim_funds`]: Self::claim_funds
16202 * [`PaymentReceived`]: events::Event::PaymentReceived
16203 * [`PaymentReceived::payment_preimage`]: events::Event::PaymentReceived::payment_preimage
16204 * [`create_inbound_payment_for_hash`]: Self::create_inbound_payment_for_hash
16206 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);
16209 * Gets a [`PaymentSecret`] for a given [`PaymentHash`], for which the payment preimage is
16210 * stored external to LDK.
16212 * A [`PaymentReceived`] event will only be generated if the [`PaymentSecret`] matches a
16213 * payment secret fetched via this method or [`create_inbound_payment`], and which is at least
16214 * the `min_value_msat` provided here, if one is provided.
16216 * The [`PaymentHash`] (and corresponding [`PaymentPreimage`]) must be globally unique. This
16217 * method may return an Err if another payment with the same payment_hash is still pending.
16219 * `user_payment_id` will be provided back in [`PaymentPurpose::InvoicePayment::user_payment_id`] events to
16220 * allow tracking of which events correspond with which calls to this and
16221 * [`create_inbound_payment`]. `user_payment_id` has no meaning inside of LDK, it is simply
16222 * copied to events and otherwise ignored. It may be used to correlate PaymentReceived events
16223 * with invoice metadata stored elsewhere.
16225 * `min_value_msat` should be set if the invoice being generated contains a value. Any payment
16226 * received for the returned [`PaymentHash`] will be required to be at least `min_value_msat`
16227 * before a [`PaymentReceived`] event will be generated, ensuring that we do not provide the
16228 * sender \"proof-of-payment\" unless they have paid the required amount.
16230 * `invoice_expiry_delta_secs` describes the number of seconds that the invoice is valid for
16231 * in excess of the current time. This should roughly match the expiry time set in the invoice.
16232 * After this many seconds, we will remove the inbound payment, resulting in any attempts to
16233 * pay the invoice failing. The BOLT spec suggests 3,600 secs as a default validity time for
16234 * invoices when no timeout is set.
16236 * Note that we use block header time to time-out pending inbound payments (with some margin
16237 * to compensate for the inaccuracy of block header timestamps). Thus, in practice we will
16238 * accept a payment and generate a [`PaymentReceived`] event for some time after the expiry.
16239 * If you need exact expiry semantics, you should enforce them upon receipt of
16240 * [`PaymentReceived`].
16242 * Pending inbound payments are stored in memory and in serialized versions of this
16243 * [`ChannelManager`]. If potentially unbounded numbers of inbound payments may exist and
16244 * space is limited, you may wish to rate-limit inbound payment creation.
16246 * May panic if `invoice_expiry_delta_secs` is greater than one year.
16248 * Note that invoices generated for inbound payments should have their `min_final_cltv_expiry`
16249 * set to at least [`MIN_FINAL_CLTV_EXPIRY`].
16251 * [`create_inbound_payment`]: Self::create_inbound_payment
16252 * [`PaymentReceived`]: events::Event::PaymentReceived
16253 * [`PaymentPurpose::InvoicePayment::user_payment_id`]: events::PaymentPurpose::InvoicePayment::user_payment_id
16255 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);
16258 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
16259 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
16261 struct LDKMessageSendEventsProvider ChannelManager_as_MessageSendEventsProvider(const struct LDKChannelManager *NONNULL_PTR this_arg);
16264 * Constructs a new EventsProvider which calls the relevant methods on this_arg.
16265 * This copies the `inner` pointer in this_arg and thus the returned EventsProvider must be freed before this_arg is
16267 struct LDKEventsProvider ChannelManager_as_EventsProvider(const struct LDKChannelManager *NONNULL_PTR this_arg);
16270 * Constructs a new Listen which calls the relevant methods on this_arg.
16271 * This copies the `inner` pointer in this_arg and thus the returned Listen must be freed before this_arg is
16273 struct LDKListen ChannelManager_as_Listen(const struct LDKChannelManager *NONNULL_PTR this_arg);
16276 * Constructs a new Confirm which calls the relevant methods on this_arg.
16277 * This copies the `inner` pointer in this_arg and thus the returned Confirm must be freed before this_arg is
16279 struct LDKConfirm ChannelManager_as_Confirm(const struct LDKChannelManager *NONNULL_PTR this_arg);
16282 * Blocks until ChannelManager needs to be persisted or a timeout is reached. It returns a bool
16283 * indicating whether persistence is necessary. Only one listener on
16284 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
16286 * Note that the feature `allow_wallclock_use` must be enabled to use this function.
16288 MUST_USE_RES bool ChannelManager_await_persistable_update_timeout(const struct LDKChannelManager *NONNULL_PTR this_arg, uint64_t max_wait);
16291 * Blocks until ChannelManager needs to be persisted. Only one listener on
16292 * `await_persistable_update` or `await_persistable_update_timeout` is guaranteed to be woken
16295 void ChannelManager_await_persistable_update(const struct LDKChannelManager *NONNULL_PTR this_arg);
16298 * Gets the latest best block which was connected either via the [`chain::Listen`] or
16299 * [`chain::Confirm`] interfaces.
16301 MUST_USE_RES struct LDKBestBlock ChannelManager_current_best_block(const struct LDKChannelManager *NONNULL_PTR this_arg);
16304 * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
16305 * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
16307 struct LDKChannelMessageHandler ChannelManager_as_ChannelMessageHandler(const struct LDKChannelManager *NONNULL_PTR this_arg);
16310 * Serialize the ChannelManager object into a byte array which can be read by ChannelManager_read
16312 struct LDKCVec_u8Z ChannelManager_write(const struct LDKChannelManager *NONNULL_PTR obj);
16315 * Frees any resources used by the ChannelManagerReadArgs, if is_owned is set and inner is non-NULL.
16317 void ChannelManagerReadArgs_free(struct LDKChannelManagerReadArgs this_obj);
16320 * The keys provider which will give us relevant keys. Some keys will be loaded during
16321 * deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
16324 const struct LDKKeysInterface *ChannelManagerReadArgs_get_keys_manager(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
16327 * The keys provider which will give us relevant keys. Some keys will be loaded during
16328 * deserialization and KeysInterface::read_chan_signer will be used to read per-Channel
16331 void ChannelManagerReadArgs_set_keys_manager(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKKeysInterface val);
16334 * The fee_estimator for use in the ChannelManager in the future.
16336 * No calls to the FeeEstimator will be made during deserialization.
16338 const struct LDKFeeEstimator *ChannelManagerReadArgs_get_fee_estimator(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
16341 * The fee_estimator for use in the ChannelManager in the future.
16343 * No calls to the FeeEstimator will be made during deserialization.
16345 void ChannelManagerReadArgs_set_fee_estimator(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKFeeEstimator val);
16348 * The chain::Watch for use in the ChannelManager in the future.
16350 * No calls to the chain::Watch will be made during deserialization. It is assumed that
16351 * you have deserialized ChannelMonitors separately and will add them to your
16352 * chain::Watch after deserializing this ChannelManager.
16354 const struct LDKWatch *ChannelManagerReadArgs_get_chain_monitor(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
16357 * The chain::Watch for use in the ChannelManager in the future.
16359 * No calls to the chain::Watch will be made during deserialization. It is assumed that
16360 * you have deserialized ChannelMonitors separately and will add them to your
16361 * chain::Watch after deserializing this ChannelManager.
16363 void ChannelManagerReadArgs_set_chain_monitor(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKWatch val);
16366 * The BroadcasterInterface which will be used in the ChannelManager in the future and may be
16367 * used to broadcast the latest local commitment transactions of channels which must be
16368 * force-closed during deserialization.
16370 const struct LDKBroadcasterInterface *ChannelManagerReadArgs_get_tx_broadcaster(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
16373 * The BroadcasterInterface which will be used in the ChannelManager in the future and may be
16374 * used to broadcast the latest local commitment transactions of channels which must be
16375 * force-closed during deserialization.
16377 void ChannelManagerReadArgs_set_tx_broadcaster(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKBroadcasterInterface val);
16380 * The Logger for use in the ChannelManager and which may be used to log information during
16383 const struct LDKLogger *ChannelManagerReadArgs_get_logger(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
16386 * The Logger for use in the ChannelManager and which may be used to log information during
16389 void ChannelManagerReadArgs_set_logger(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKLogger val);
16392 * Default settings used for new channels. Any existing channels will continue to use the
16393 * runtime settings which were stored when the ChannelManager was serialized.
16395 struct LDKUserConfig ChannelManagerReadArgs_get_default_config(const struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr);
16398 * Default settings used for new channels. Any existing channels will continue to use the
16399 * runtime settings which were stored when the ChannelManager was serialized.
16401 void ChannelManagerReadArgs_set_default_config(struct LDKChannelManagerReadArgs *NONNULL_PTR this_ptr, struct LDKUserConfig val);
16404 * Simple utility function to create a ChannelManagerReadArgs which creates the monitor
16405 * HashMap for you. This is primarily useful for C bindings where it is not practical to
16406 * populate a HashMap directly from C.
16408 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);
16411 * Read a C2Tuple_BlockHashChannelManagerZ from a byte array, created by C2Tuple_BlockHashChannelManagerZ_write
16413 struct LDKCResult_C2Tuple_BlockHashChannelManagerZDecodeErrorZ C2Tuple_BlockHashChannelManagerZ_read(struct LDKu8slice ser, struct LDKChannelManagerReadArgs arg);
16416 * Frees any resources used by the DecodeError, if is_owned is set and inner is non-NULL.
16418 void DecodeError_free(struct LDKDecodeError this_obj);
16421 * Creates a copy of the DecodeError
16423 struct LDKDecodeError DecodeError_clone(const struct LDKDecodeError *NONNULL_PTR orig);
16426 * Frees any resources used by the Init, if is_owned is set and inner is non-NULL.
16428 void Init_free(struct LDKInit this_obj);
16431 * The relevant features which the sender supports
16433 struct LDKInitFeatures Init_get_features(const struct LDKInit *NONNULL_PTR this_ptr);
16436 * The relevant features which the sender supports
16438 void Init_set_features(struct LDKInit *NONNULL_PTR this_ptr, struct LDKInitFeatures val);
16441 * Constructs a new Init given each field
16443 MUST_USE_RES struct LDKInit Init_new(struct LDKInitFeatures features_arg);
16446 * Creates a copy of the Init
16448 struct LDKInit Init_clone(const struct LDKInit *NONNULL_PTR orig);
16451 * Frees any resources used by the ErrorMessage, if is_owned is set and inner is non-NULL.
16453 void ErrorMessage_free(struct LDKErrorMessage this_obj);
16456 * The channel ID involved in the error
16458 const uint8_t (*ErrorMessage_get_channel_id(const struct LDKErrorMessage *NONNULL_PTR this_ptr))[32];
16461 * The channel ID involved in the error
16463 void ErrorMessage_set_channel_id(struct LDKErrorMessage *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16466 * A possibly human-readable error description.
16467 * The string should be sanitized before it is used (e.g. emitted to logs
16468 * or printed to stdout). Otherwise, a well crafted error message may trigger a security
16469 * vulnerability in the terminal emulator or the logging subsystem.
16471 struct LDKStr ErrorMessage_get_data(const struct LDKErrorMessage *NONNULL_PTR this_ptr);
16474 * A possibly human-readable error description.
16475 * The string should be sanitized before it is used (e.g. emitted to logs
16476 * or printed to stdout). Otherwise, a well crafted error message may trigger a security
16477 * vulnerability in the terminal emulator or the logging subsystem.
16479 void ErrorMessage_set_data(struct LDKErrorMessage *NONNULL_PTR this_ptr, struct LDKStr val);
16482 * Constructs a new ErrorMessage given each field
16484 MUST_USE_RES struct LDKErrorMessage ErrorMessage_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKStr data_arg);
16487 * Creates a copy of the ErrorMessage
16489 struct LDKErrorMessage ErrorMessage_clone(const struct LDKErrorMessage *NONNULL_PTR orig);
16492 * Frees any resources used by the Ping, if is_owned is set and inner is non-NULL.
16494 void Ping_free(struct LDKPing this_obj);
16497 * The desired response length
16499 uint16_t Ping_get_ponglen(const struct LDKPing *NONNULL_PTR this_ptr);
16502 * The desired response length
16504 void Ping_set_ponglen(struct LDKPing *NONNULL_PTR this_ptr, uint16_t val);
16507 * The ping packet size.
16508 * This field is not sent on the wire. byteslen zeros are sent.
16510 uint16_t Ping_get_byteslen(const struct LDKPing *NONNULL_PTR this_ptr);
16513 * The ping packet size.
16514 * This field is not sent on the wire. byteslen zeros are sent.
16516 void Ping_set_byteslen(struct LDKPing *NONNULL_PTR this_ptr, uint16_t val);
16519 * Constructs a new Ping given each field
16521 MUST_USE_RES struct LDKPing Ping_new(uint16_t ponglen_arg, uint16_t byteslen_arg);
16524 * Creates a copy of the Ping
16526 struct LDKPing Ping_clone(const struct LDKPing *NONNULL_PTR orig);
16529 * Frees any resources used by the Pong, if is_owned is set and inner is non-NULL.
16531 void Pong_free(struct LDKPong this_obj);
16534 * The pong packet size.
16535 * This field is not sent on the wire. byteslen zeros are sent.
16537 uint16_t Pong_get_byteslen(const struct LDKPong *NONNULL_PTR this_ptr);
16540 * The pong packet size.
16541 * This field is not sent on the wire. byteslen zeros are sent.
16543 void Pong_set_byteslen(struct LDKPong *NONNULL_PTR this_ptr, uint16_t val);
16546 * Constructs a new Pong given each field
16548 MUST_USE_RES struct LDKPong Pong_new(uint16_t byteslen_arg);
16551 * Creates a copy of the Pong
16553 struct LDKPong Pong_clone(const struct LDKPong *NONNULL_PTR orig);
16556 * Frees any resources used by the OpenChannel, if is_owned is set and inner is non-NULL.
16558 void OpenChannel_free(struct LDKOpenChannel this_obj);
16561 * The genesis hash of the blockchain where the channel is to be opened
16563 const uint8_t (*OpenChannel_get_chain_hash(const struct LDKOpenChannel *NONNULL_PTR this_ptr))[32];
16566 * The genesis hash of the blockchain where the channel is to be opened
16568 void OpenChannel_set_chain_hash(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16571 * A temporary channel ID, until the funding outpoint is announced
16573 const uint8_t (*OpenChannel_get_temporary_channel_id(const struct LDKOpenChannel *NONNULL_PTR this_ptr))[32];
16576 * A temporary channel ID, until the funding outpoint is announced
16578 void OpenChannel_set_temporary_channel_id(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16581 * The channel value
16583 uint64_t OpenChannel_get_funding_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16586 * The channel value
16588 void OpenChannel_set_funding_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
16591 * The amount to push to the counterparty as part of the open, in milli-satoshi
16593 uint64_t OpenChannel_get_push_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16596 * The amount to push to the counterparty as part of the open, in milli-satoshi
16598 void OpenChannel_set_push_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
16601 * The threshold below which outputs on transactions broadcast by sender will be omitted
16603 uint64_t OpenChannel_get_dust_limit_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16606 * The threshold below which outputs on transactions broadcast by sender will be omitted
16608 void OpenChannel_set_dust_limit_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
16611 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
16613 uint64_t OpenChannel_get_max_htlc_value_in_flight_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16616 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
16618 void OpenChannel_set_max_htlc_value_in_flight_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
16621 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
16623 uint64_t OpenChannel_get_channel_reserve_satoshis(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16626 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
16628 void OpenChannel_set_channel_reserve_satoshis(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
16631 * The minimum HTLC size incoming to sender, in milli-satoshi
16633 uint64_t OpenChannel_get_htlc_minimum_msat(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16636 * The minimum HTLC size incoming to sender, in milli-satoshi
16638 void OpenChannel_set_htlc_minimum_msat(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint64_t val);
16641 * The feerate per 1000-weight of sender generated transactions, until updated by update_fee
16643 uint32_t OpenChannel_get_feerate_per_kw(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16646 * The feerate per 1000-weight of sender generated transactions, until updated by update_fee
16648 void OpenChannel_set_feerate_per_kw(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint32_t val);
16651 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
16653 uint16_t OpenChannel_get_to_self_delay(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16656 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
16658 void OpenChannel_set_to_self_delay(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint16_t val);
16661 * The maximum number of inbound HTLCs towards sender
16663 uint16_t OpenChannel_get_max_accepted_htlcs(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16666 * The maximum number of inbound HTLCs towards sender
16668 void OpenChannel_set_max_accepted_htlcs(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint16_t val);
16671 * The sender's key controlling the funding transaction
16673 struct LDKPublicKey OpenChannel_get_funding_pubkey(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16676 * The sender's key controlling the funding transaction
16678 void OpenChannel_set_funding_pubkey(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16681 * Used to derive a revocation key for transactions broadcast by counterparty
16683 struct LDKPublicKey OpenChannel_get_revocation_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16686 * Used to derive a revocation key for transactions broadcast by counterparty
16688 void OpenChannel_set_revocation_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16691 * A payment key to sender for transactions broadcast by counterparty
16693 struct LDKPublicKey OpenChannel_get_payment_point(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16696 * A payment key to sender for transactions broadcast by counterparty
16698 void OpenChannel_set_payment_point(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16701 * Used to derive a payment key to sender for transactions broadcast by sender
16703 struct LDKPublicKey OpenChannel_get_delayed_payment_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16706 * Used to derive a payment key to sender for transactions broadcast by sender
16708 void OpenChannel_set_delayed_payment_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16711 * Used to derive an HTLC payment key to sender
16713 struct LDKPublicKey OpenChannel_get_htlc_basepoint(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16716 * Used to derive an HTLC payment key to sender
16718 void OpenChannel_set_htlc_basepoint(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16721 * The first to-be-broadcast-by-sender transaction's per commitment point
16723 struct LDKPublicKey OpenChannel_get_first_per_commitment_point(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16726 * The first to-be-broadcast-by-sender transaction's per commitment point
16728 void OpenChannel_set_first_per_commitment_point(struct LDKOpenChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16733 uint8_t OpenChannel_get_channel_flags(const struct LDKOpenChannel *NONNULL_PTR this_ptr);
16738 void OpenChannel_set_channel_flags(struct LDKOpenChannel *NONNULL_PTR this_ptr, uint8_t val);
16741 * Creates a copy of the OpenChannel
16743 struct LDKOpenChannel OpenChannel_clone(const struct LDKOpenChannel *NONNULL_PTR orig);
16746 * Frees any resources used by the AcceptChannel, if is_owned is set and inner is non-NULL.
16748 void AcceptChannel_free(struct LDKAcceptChannel this_obj);
16751 * A temporary channel ID, until the funding outpoint is announced
16753 const uint8_t (*AcceptChannel_get_temporary_channel_id(const struct LDKAcceptChannel *NONNULL_PTR this_ptr))[32];
16756 * A temporary channel ID, until the funding outpoint is announced
16758 void AcceptChannel_set_temporary_channel_id(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16761 * The threshold below which outputs on transactions broadcast by sender will be omitted
16763 uint64_t AcceptChannel_get_dust_limit_satoshis(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16766 * The threshold below which outputs on transactions broadcast by sender will be omitted
16768 void AcceptChannel_set_dust_limit_satoshis(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
16771 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
16773 uint64_t AcceptChannel_get_max_htlc_value_in_flight_msat(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16776 * The maximum inbound HTLC value in flight towards sender, in milli-satoshi
16778 void AcceptChannel_set_max_htlc_value_in_flight_msat(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
16781 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
16783 uint64_t AcceptChannel_get_channel_reserve_satoshis(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16786 * The minimum value unencumbered by HTLCs for the counterparty to keep in the channel
16788 void AcceptChannel_set_channel_reserve_satoshis(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
16791 * The minimum HTLC size incoming to sender, in milli-satoshi
16793 uint64_t AcceptChannel_get_htlc_minimum_msat(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16796 * The minimum HTLC size incoming to sender, in milli-satoshi
16798 void AcceptChannel_set_htlc_minimum_msat(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint64_t val);
16801 * Minimum depth of the funding transaction before the channel is considered open
16803 uint32_t AcceptChannel_get_minimum_depth(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16806 * Minimum depth of the funding transaction before the channel is considered open
16808 void AcceptChannel_set_minimum_depth(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint32_t val);
16811 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
16813 uint16_t AcceptChannel_get_to_self_delay(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16816 * The number of blocks which the counterparty will have to wait to claim on-chain funds if they broadcast a commitment transaction
16818 void AcceptChannel_set_to_self_delay(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint16_t val);
16821 * The maximum number of inbound HTLCs towards sender
16823 uint16_t AcceptChannel_get_max_accepted_htlcs(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16826 * The maximum number of inbound HTLCs towards sender
16828 void AcceptChannel_set_max_accepted_htlcs(struct LDKAcceptChannel *NONNULL_PTR this_ptr, uint16_t val);
16831 * The sender's key controlling the funding transaction
16833 struct LDKPublicKey AcceptChannel_get_funding_pubkey(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16836 * The sender's key controlling the funding transaction
16838 void AcceptChannel_set_funding_pubkey(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16841 * Used to derive a revocation key for transactions broadcast by counterparty
16843 struct LDKPublicKey AcceptChannel_get_revocation_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16846 * Used to derive a revocation key for transactions broadcast by counterparty
16848 void AcceptChannel_set_revocation_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16851 * A payment key to sender for transactions broadcast by counterparty
16853 struct LDKPublicKey AcceptChannel_get_payment_point(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16856 * A payment key to sender for transactions broadcast by counterparty
16858 void AcceptChannel_set_payment_point(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16861 * Used to derive a payment key to sender for transactions broadcast by sender
16863 struct LDKPublicKey AcceptChannel_get_delayed_payment_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16866 * Used to derive a payment key to sender for transactions broadcast by sender
16868 void AcceptChannel_set_delayed_payment_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16871 * Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
16873 struct LDKPublicKey AcceptChannel_get_htlc_basepoint(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16876 * Used to derive an HTLC payment key to sender for transactions broadcast by counterparty
16878 void AcceptChannel_set_htlc_basepoint(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16881 * The first to-be-broadcast-by-sender transaction's per commitment point
16883 struct LDKPublicKey AcceptChannel_get_first_per_commitment_point(const struct LDKAcceptChannel *NONNULL_PTR this_ptr);
16886 * The first to-be-broadcast-by-sender transaction's per commitment point
16888 void AcceptChannel_set_first_per_commitment_point(struct LDKAcceptChannel *NONNULL_PTR this_ptr, struct LDKPublicKey val);
16891 * Creates a copy of the AcceptChannel
16893 struct LDKAcceptChannel AcceptChannel_clone(const struct LDKAcceptChannel *NONNULL_PTR orig);
16896 * Frees any resources used by the FundingCreated, if is_owned is set and inner is non-NULL.
16898 void FundingCreated_free(struct LDKFundingCreated this_obj);
16901 * A temporary channel ID, until the funding is established
16903 const uint8_t (*FundingCreated_get_temporary_channel_id(const struct LDKFundingCreated *NONNULL_PTR this_ptr))[32];
16906 * A temporary channel ID, until the funding is established
16908 void FundingCreated_set_temporary_channel_id(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16911 * The funding transaction ID
16913 const uint8_t (*FundingCreated_get_funding_txid(const struct LDKFundingCreated *NONNULL_PTR this_ptr))[32];
16916 * The funding transaction ID
16918 void FundingCreated_set_funding_txid(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16921 * The specific output index funding this channel
16923 uint16_t FundingCreated_get_funding_output_index(const struct LDKFundingCreated *NONNULL_PTR this_ptr);
16926 * The specific output index funding this channel
16928 void FundingCreated_set_funding_output_index(struct LDKFundingCreated *NONNULL_PTR this_ptr, uint16_t val);
16931 * The signature of the channel initiator (funder) on the initial commitment transaction
16933 struct LDKSignature FundingCreated_get_signature(const struct LDKFundingCreated *NONNULL_PTR this_ptr);
16936 * The signature of the channel initiator (funder) on the initial commitment transaction
16938 void FundingCreated_set_signature(struct LDKFundingCreated *NONNULL_PTR this_ptr, struct LDKSignature val);
16941 * Constructs a new FundingCreated given each field
16943 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);
16946 * Creates a copy of the FundingCreated
16948 struct LDKFundingCreated FundingCreated_clone(const struct LDKFundingCreated *NONNULL_PTR orig);
16951 * Frees any resources used by the FundingSigned, if is_owned is set and inner is non-NULL.
16953 void FundingSigned_free(struct LDKFundingSigned this_obj);
16958 const uint8_t (*FundingSigned_get_channel_id(const struct LDKFundingSigned *NONNULL_PTR this_ptr))[32];
16963 void FundingSigned_set_channel_id(struct LDKFundingSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
16966 * The signature of the channel acceptor (fundee) on the initial commitment transaction
16968 struct LDKSignature FundingSigned_get_signature(const struct LDKFundingSigned *NONNULL_PTR this_ptr);
16971 * The signature of the channel acceptor (fundee) on the initial commitment transaction
16973 void FundingSigned_set_signature(struct LDKFundingSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
16976 * Constructs a new FundingSigned given each field
16978 MUST_USE_RES struct LDKFundingSigned FundingSigned_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKSignature signature_arg);
16981 * Creates a copy of the FundingSigned
16983 struct LDKFundingSigned FundingSigned_clone(const struct LDKFundingSigned *NONNULL_PTR orig);
16986 * Frees any resources used by the FundingLocked, if is_owned is set and inner is non-NULL.
16988 void FundingLocked_free(struct LDKFundingLocked this_obj);
16993 const uint8_t (*FundingLocked_get_channel_id(const struct LDKFundingLocked *NONNULL_PTR this_ptr))[32];
16998 void FundingLocked_set_channel_id(struct LDKFundingLocked *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17001 * The per-commitment point of the second commitment transaction
17003 struct LDKPublicKey FundingLocked_get_next_per_commitment_point(const struct LDKFundingLocked *NONNULL_PTR this_ptr);
17006 * The per-commitment point of the second commitment transaction
17008 void FundingLocked_set_next_per_commitment_point(struct LDKFundingLocked *NONNULL_PTR this_ptr, struct LDKPublicKey val);
17011 * Constructs a new FundingLocked given each field
17013 MUST_USE_RES struct LDKFundingLocked FundingLocked_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKPublicKey next_per_commitment_point_arg);
17016 * Creates a copy of the FundingLocked
17018 struct LDKFundingLocked FundingLocked_clone(const struct LDKFundingLocked *NONNULL_PTR orig);
17021 * Frees any resources used by the Shutdown, if is_owned is set and inner is non-NULL.
17023 void Shutdown_free(struct LDKShutdown this_obj);
17028 const uint8_t (*Shutdown_get_channel_id(const struct LDKShutdown *NONNULL_PTR this_ptr))[32];
17033 void Shutdown_set_channel_id(struct LDKShutdown *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17036 * The destination of this peer's funds on closing.
17037 * Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
17039 struct LDKu8slice Shutdown_get_scriptpubkey(const struct LDKShutdown *NONNULL_PTR this_ptr);
17042 * The destination of this peer's funds on closing.
17043 * Must be in one of these forms: p2pkh, p2sh, p2wpkh, p2wsh.
17045 void Shutdown_set_scriptpubkey(struct LDKShutdown *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
17048 * Constructs a new Shutdown given each field
17050 MUST_USE_RES struct LDKShutdown Shutdown_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKCVec_u8Z scriptpubkey_arg);
17053 * Creates a copy of the Shutdown
17055 struct LDKShutdown Shutdown_clone(const struct LDKShutdown *NONNULL_PTR orig);
17058 * Frees any resources used by the ClosingSignedFeeRange, if is_owned is set and inner is non-NULL.
17060 void ClosingSignedFeeRange_free(struct LDKClosingSignedFeeRange this_obj);
17063 * The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
17066 uint64_t ClosingSignedFeeRange_get_min_fee_satoshis(const struct LDKClosingSignedFeeRange *NONNULL_PTR this_ptr);
17069 * The minimum absolute fee, in satoshis, which the sender is willing to place on the closing
17072 void ClosingSignedFeeRange_set_min_fee_satoshis(struct LDKClosingSignedFeeRange *NONNULL_PTR this_ptr, uint64_t val);
17075 * The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
17078 uint64_t ClosingSignedFeeRange_get_max_fee_satoshis(const struct LDKClosingSignedFeeRange *NONNULL_PTR this_ptr);
17081 * The maximum absolute fee, in satoshis, which the sender is willing to place on the closing
17084 void ClosingSignedFeeRange_set_max_fee_satoshis(struct LDKClosingSignedFeeRange *NONNULL_PTR this_ptr, uint64_t val);
17087 * Constructs a new ClosingSignedFeeRange given each field
17089 MUST_USE_RES struct LDKClosingSignedFeeRange ClosingSignedFeeRange_new(uint64_t min_fee_satoshis_arg, uint64_t max_fee_satoshis_arg);
17092 * Creates a copy of the ClosingSignedFeeRange
17094 struct LDKClosingSignedFeeRange ClosingSignedFeeRange_clone(const struct LDKClosingSignedFeeRange *NONNULL_PTR orig);
17097 * Frees any resources used by the ClosingSigned, if is_owned is set and inner is non-NULL.
17099 void ClosingSigned_free(struct LDKClosingSigned this_obj);
17104 const uint8_t (*ClosingSigned_get_channel_id(const struct LDKClosingSigned *NONNULL_PTR this_ptr))[32];
17109 void ClosingSigned_set_channel_id(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17112 * The proposed total fee for the closing transaction
17114 uint64_t ClosingSigned_get_fee_satoshis(const struct LDKClosingSigned *NONNULL_PTR this_ptr);
17117 * The proposed total fee for the closing transaction
17119 void ClosingSigned_set_fee_satoshis(struct LDKClosingSigned *NONNULL_PTR this_ptr, uint64_t val);
17122 * A signature on the closing transaction
17124 struct LDKSignature ClosingSigned_get_signature(const struct LDKClosingSigned *NONNULL_PTR this_ptr);
17127 * A signature on the closing transaction
17129 void ClosingSigned_set_signature(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
17132 * The minimum and maximum fees which the sender is willing to accept, provided only by new
17135 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
17137 struct LDKClosingSignedFeeRange ClosingSigned_get_fee_range(const struct LDKClosingSigned *NONNULL_PTR this_ptr);
17140 * The minimum and maximum fees which the sender is willing to accept, provided only by new
17143 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
17145 void ClosingSigned_set_fee_range(struct LDKClosingSigned *NONNULL_PTR this_ptr, struct LDKClosingSignedFeeRange val);
17148 * Constructs a new ClosingSigned given each field
17150 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);
17153 * Creates a copy of the ClosingSigned
17155 struct LDKClosingSigned ClosingSigned_clone(const struct LDKClosingSigned *NONNULL_PTR orig);
17158 * Frees any resources used by the UpdateAddHTLC, if is_owned is set and inner is non-NULL.
17160 void UpdateAddHTLC_free(struct LDKUpdateAddHTLC this_obj);
17165 const uint8_t (*UpdateAddHTLC_get_channel_id(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr))[32];
17170 void UpdateAddHTLC_set_channel_id(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17175 uint64_t UpdateAddHTLC_get_htlc_id(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
17180 void UpdateAddHTLC_set_htlc_id(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint64_t val);
17183 * The HTLC value in milli-satoshi
17185 uint64_t UpdateAddHTLC_get_amount_msat(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
17188 * The HTLC value in milli-satoshi
17190 void UpdateAddHTLC_set_amount_msat(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint64_t val);
17193 * The payment hash, the pre-image of which controls HTLC redemption
17195 const uint8_t (*UpdateAddHTLC_get_payment_hash(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr))[32];
17198 * The payment hash, the pre-image of which controls HTLC redemption
17200 void UpdateAddHTLC_set_payment_hash(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17203 * The expiry height of the HTLC
17205 uint32_t UpdateAddHTLC_get_cltv_expiry(const struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr);
17208 * The expiry height of the HTLC
17210 void UpdateAddHTLC_set_cltv_expiry(struct LDKUpdateAddHTLC *NONNULL_PTR this_ptr, uint32_t val);
17213 * Creates a copy of the UpdateAddHTLC
17215 struct LDKUpdateAddHTLC UpdateAddHTLC_clone(const struct LDKUpdateAddHTLC *NONNULL_PTR orig);
17218 * Frees any resources used by the UpdateFulfillHTLC, if is_owned is set and inner is non-NULL.
17220 void UpdateFulfillHTLC_free(struct LDKUpdateFulfillHTLC this_obj);
17225 const uint8_t (*UpdateFulfillHTLC_get_channel_id(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr))[32];
17230 void UpdateFulfillHTLC_set_channel_id(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17235 uint64_t UpdateFulfillHTLC_get_htlc_id(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr);
17240 void UpdateFulfillHTLC_set_htlc_id(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, uint64_t val);
17243 * The pre-image of the payment hash, allowing HTLC redemption
17245 const uint8_t (*UpdateFulfillHTLC_get_payment_preimage(const struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr))[32];
17248 * The pre-image of the payment hash, allowing HTLC redemption
17250 void UpdateFulfillHTLC_set_payment_preimage(struct LDKUpdateFulfillHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17253 * Constructs a new UpdateFulfillHTLC given each field
17255 MUST_USE_RES struct LDKUpdateFulfillHTLC UpdateFulfillHTLC_new(struct LDKThirtyTwoBytes channel_id_arg, uint64_t htlc_id_arg, struct LDKThirtyTwoBytes payment_preimage_arg);
17258 * Creates a copy of the UpdateFulfillHTLC
17260 struct LDKUpdateFulfillHTLC UpdateFulfillHTLC_clone(const struct LDKUpdateFulfillHTLC *NONNULL_PTR orig);
17263 * Frees any resources used by the UpdateFailHTLC, if is_owned is set and inner is non-NULL.
17265 void UpdateFailHTLC_free(struct LDKUpdateFailHTLC this_obj);
17270 const uint8_t (*UpdateFailHTLC_get_channel_id(const struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr))[32];
17275 void UpdateFailHTLC_set_channel_id(struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17280 uint64_t UpdateFailHTLC_get_htlc_id(const struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr);
17285 void UpdateFailHTLC_set_htlc_id(struct LDKUpdateFailHTLC *NONNULL_PTR this_ptr, uint64_t val);
17288 * Creates a copy of the UpdateFailHTLC
17290 struct LDKUpdateFailHTLC UpdateFailHTLC_clone(const struct LDKUpdateFailHTLC *NONNULL_PTR orig);
17293 * Frees any resources used by the UpdateFailMalformedHTLC, if is_owned is set and inner is non-NULL.
17295 void UpdateFailMalformedHTLC_free(struct LDKUpdateFailMalformedHTLC this_obj);
17300 const uint8_t (*UpdateFailMalformedHTLC_get_channel_id(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr))[32];
17305 void UpdateFailMalformedHTLC_set_channel_id(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17310 uint64_t UpdateFailMalformedHTLC_get_htlc_id(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr);
17315 void UpdateFailMalformedHTLC_set_htlc_id(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, uint64_t val);
17320 uint16_t UpdateFailMalformedHTLC_get_failure_code(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr);
17325 void UpdateFailMalformedHTLC_set_failure_code(struct LDKUpdateFailMalformedHTLC *NONNULL_PTR this_ptr, uint16_t val);
17328 * Creates a copy of the UpdateFailMalformedHTLC
17330 struct LDKUpdateFailMalformedHTLC UpdateFailMalformedHTLC_clone(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR orig);
17333 * Frees any resources used by the CommitmentSigned, if is_owned is set and inner is non-NULL.
17335 void CommitmentSigned_free(struct LDKCommitmentSigned this_obj);
17340 const uint8_t (*CommitmentSigned_get_channel_id(const struct LDKCommitmentSigned *NONNULL_PTR this_ptr))[32];
17345 void CommitmentSigned_set_channel_id(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17348 * A signature on the commitment transaction
17350 struct LDKSignature CommitmentSigned_get_signature(const struct LDKCommitmentSigned *NONNULL_PTR this_ptr);
17353 * A signature on the commitment transaction
17355 void CommitmentSigned_set_signature(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKSignature val);
17358 * Signatures on the HTLC transactions
17360 void CommitmentSigned_set_htlc_signatures(struct LDKCommitmentSigned *NONNULL_PTR this_ptr, struct LDKCVec_SignatureZ val);
17363 * Constructs a new CommitmentSigned given each field
17365 MUST_USE_RES struct LDKCommitmentSigned CommitmentSigned_new(struct LDKThirtyTwoBytes channel_id_arg, struct LDKSignature signature_arg, struct LDKCVec_SignatureZ htlc_signatures_arg);
17368 * Creates a copy of the CommitmentSigned
17370 struct LDKCommitmentSigned CommitmentSigned_clone(const struct LDKCommitmentSigned *NONNULL_PTR orig);
17373 * Frees any resources used by the RevokeAndACK, if is_owned is set and inner is non-NULL.
17375 void RevokeAndACK_free(struct LDKRevokeAndACK this_obj);
17380 const uint8_t (*RevokeAndACK_get_channel_id(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr))[32];
17385 void RevokeAndACK_set_channel_id(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17388 * The secret corresponding to the per-commitment point
17390 const uint8_t (*RevokeAndACK_get_per_commitment_secret(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr))[32];
17393 * The secret corresponding to the per-commitment point
17395 void RevokeAndACK_set_per_commitment_secret(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17398 * The next sender-broadcast commitment transaction's per-commitment point
17400 struct LDKPublicKey RevokeAndACK_get_next_per_commitment_point(const struct LDKRevokeAndACK *NONNULL_PTR this_ptr);
17403 * The next sender-broadcast commitment transaction's per-commitment point
17405 void RevokeAndACK_set_next_per_commitment_point(struct LDKRevokeAndACK *NONNULL_PTR this_ptr, struct LDKPublicKey val);
17408 * Constructs a new RevokeAndACK given each field
17410 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);
17413 * Creates a copy of the RevokeAndACK
17415 struct LDKRevokeAndACK RevokeAndACK_clone(const struct LDKRevokeAndACK *NONNULL_PTR orig);
17418 * Frees any resources used by the UpdateFee, if is_owned is set and inner is non-NULL.
17420 void UpdateFee_free(struct LDKUpdateFee this_obj);
17425 const uint8_t (*UpdateFee_get_channel_id(const struct LDKUpdateFee *NONNULL_PTR this_ptr))[32];
17430 void UpdateFee_set_channel_id(struct LDKUpdateFee *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17433 * Fee rate per 1000-weight of the transaction
17435 uint32_t UpdateFee_get_feerate_per_kw(const struct LDKUpdateFee *NONNULL_PTR this_ptr);
17438 * Fee rate per 1000-weight of the transaction
17440 void UpdateFee_set_feerate_per_kw(struct LDKUpdateFee *NONNULL_PTR this_ptr, uint32_t val);
17443 * Constructs a new UpdateFee given each field
17445 MUST_USE_RES struct LDKUpdateFee UpdateFee_new(struct LDKThirtyTwoBytes channel_id_arg, uint32_t feerate_per_kw_arg);
17448 * Creates a copy of the UpdateFee
17450 struct LDKUpdateFee UpdateFee_clone(const struct LDKUpdateFee *NONNULL_PTR orig);
17453 * Frees any resources used by the DataLossProtect, if is_owned is set and inner is non-NULL.
17455 void DataLossProtect_free(struct LDKDataLossProtect this_obj);
17458 * Proof that the sender knows the per-commitment secret of a specific commitment transaction
17459 * belonging to the recipient
17461 const uint8_t (*DataLossProtect_get_your_last_per_commitment_secret(const struct LDKDataLossProtect *NONNULL_PTR this_ptr))[32];
17464 * Proof that the sender knows the per-commitment secret of a specific commitment transaction
17465 * belonging to the recipient
17467 void DataLossProtect_set_your_last_per_commitment_secret(struct LDKDataLossProtect *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17470 * The sender's per-commitment point for their current commitment transaction
17472 struct LDKPublicKey DataLossProtect_get_my_current_per_commitment_point(const struct LDKDataLossProtect *NONNULL_PTR this_ptr);
17475 * The sender's per-commitment point for their current commitment transaction
17477 void DataLossProtect_set_my_current_per_commitment_point(struct LDKDataLossProtect *NONNULL_PTR this_ptr, struct LDKPublicKey val);
17480 * Constructs a new DataLossProtect given each field
17482 MUST_USE_RES struct LDKDataLossProtect DataLossProtect_new(struct LDKThirtyTwoBytes your_last_per_commitment_secret_arg, struct LDKPublicKey my_current_per_commitment_point_arg);
17485 * Creates a copy of the DataLossProtect
17487 struct LDKDataLossProtect DataLossProtect_clone(const struct LDKDataLossProtect *NONNULL_PTR orig);
17490 * Frees any resources used by the ChannelReestablish, if is_owned is set and inner is non-NULL.
17492 void ChannelReestablish_free(struct LDKChannelReestablish this_obj);
17497 const uint8_t (*ChannelReestablish_get_channel_id(const struct LDKChannelReestablish *NONNULL_PTR this_ptr))[32];
17502 void ChannelReestablish_set_channel_id(struct LDKChannelReestablish *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17505 * The next commitment number for the sender
17507 uint64_t ChannelReestablish_get_next_local_commitment_number(const struct LDKChannelReestablish *NONNULL_PTR this_ptr);
17510 * The next commitment number for the sender
17512 void ChannelReestablish_set_next_local_commitment_number(struct LDKChannelReestablish *NONNULL_PTR this_ptr, uint64_t val);
17515 * The next commitment number for the recipient
17517 uint64_t ChannelReestablish_get_next_remote_commitment_number(const struct LDKChannelReestablish *NONNULL_PTR this_ptr);
17520 * The next commitment number for the recipient
17522 void ChannelReestablish_set_next_remote_commitment_number(struct LDKChannelReestablish *NONNULL_PTR this_ptr, uint64_t val);
17525 * Creates a copy of the ChannelReestablish
17527 struct LDKChannelReestablish ChannelReestablish_clone(const struct LDKChannelReestablish *NONNULL_PTR orig);
17530 * Frees any resources used by the AnnouncementSignatures, if is_owned is set and inner is non-NULL.
17532 void AnnouncementSignatures_free(struct LDKAnnouncementSignatures this_obj);
17537 const uint8_t (*AnnouncementSignatures_get_channel_id(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr))[32];
17542 void AnnouncementSignatures_set_channel_id(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17545 * The short channel ID
17547 uint64_t AnnouncementSignatures_get_short_channel_id(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
17550 * The short channel ID
17552 void AnnouncementSignatures_set_short_channel_id(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, uint64_t val);
17555 * A signature by the node key
17557 struct LDKSignature AnnouncementSignatures_get_node_signature(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
17560 * A signature by the node key
17562 void AnnouncementSignatures_set_node_signature(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKSignature val);
17565 * A signature by the funding key
17567 struct LDKSignature AnnouncementSignatures_get_bitcoin_signature(const struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr);
17570 * A signature by the funding key
17572 void AnnouncementSignatures_set_bitcoin_signature(struct LDKAnnouncementSignatures *NONNULL_PTR this_ptr, struct LDKSignature val);
17575 * Constructs a new AnnouncementSignatures given each field
17577 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);
17580 * Creates a copy of the AnnouncementSignatures
17582 struct LDKAnnouncementSignatures AnnouncementSignatures_clone(const struct LDKAnnouncementSignatures *NONNULL_PTR orig);
17585 * Frees any resources used by the NetAddress
17587 void NetAddress_free(struct LDKNetAddress this_ptr);
17590 * Creates a copy of the NetAddress
17592 struct LDKNetAddress NetAddress_clone(const struct LDKNetAddress *NONNULL_PTR orig);
17595 * Utility method to constructs a new IPv4-variant NetAddress
17597 struct LDKNetAddress NetAddress_ipv4(struct LDKFourBytes addr, uint16_t port);
17600 * Utility method to constructs a new IPv6-variant NetAddress
17602 struct LDKNetAddress NetAddress_ipv6(struct LDKSixteenBytes addr, uint16_t port);
17605 * Utility method to constructs a new OnionV2-variant NetAddress
17607 struct LDKNetAddress NetAddress_onion_v2(struct LDKTenBytes addr, uint16_t port);
17610 * Utility method to constructs a new OnionV3-variant NetAddress
17612 struct LDKNetAddress NetAddress_onion_v3(struct LDKThirtyTwoBytes ed25519_pubkey, uint16_t checksum, uint8_t version, uint16_t port);
17615 * Serialize the NetAddress object into a byte array which can be read by NetAddress_read
17617 struct LDKCVec_u8Z NetAddress_write(const struct LDKNetAddress *NONNULL_PTR obj);
17620 * Read a Result from a byte array, created by Result_write
17622 struct LDKCResult_CResult_NetAddressu8ZDecodeErrorZ Result_read(struct LDKu8slice ser);
17625 * Read a NetAddress from a byte array, created by NetAddress_write
17627 struct LDKCResult_NetAddressDecodeErrorZ NetAddress_read(struct LDKu8slice ser);
17630 * Frees any resources used by the UnsignedNodeAnnouncement, if is_owned is set and inner is non-NULL.
17632 void UnsignedNodeAnnouncement_free(struct LDKUnsignedNodeAnnouncement this_obj);
17635 * The advertised features
17637 struct LDKNodeFeatures UnsignedNodeAnnouncement_get_features(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
17640 * The advertised features
17642 void UnsignedNodeAnnouncement_set_features(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
17645 * A strictly monotonic announcement counter, with gaps allowed
17647 uint32_t UnsignedNodeAnnouncement_get_timestamp(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
17650 * A strictly monotonic announcement counter, with gaps allowed
17652 void UnsignedNodeAnnouncement_set_timestamp(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, uint32_t val);
17655 * The node_id this announcement originated from (don't rebroadcast the node_announcement back
17658 struct LDKPublicKey UnsignedNodeAnnouncement_get_node_id(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr);
17661 * The node_id this announcement originated from (don't rebroadcast the node_announcement back
17664 void UnsignedNodeAnnouncement_set_node_id(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
17667 * An RGB color for UI purposes
17669 const uint8_t (*UnsignedNodeAnnouncement_get_rgb(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr))[3];
17672 * An RGB color for UI purposes
17674 void UnsignedNodeAnnouncement_set_rgb(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKThreeBytes val);
17677 * An alias, for UI purposes. This should be sanitized before use. There is no guarantee
17680 const uint8_t (*UnsignedNodeAnnouncement_get_alias(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr))[32];
17683 * An alias, for UI purposes. This should be sanitized before use. There is no guarantee
17686 void UnsignedNodeAnnouncement_set_alias(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17689 * List of addresses on which this node is reachable
17691 void UnsignedNodeAnnouncement_set_addresses(struct LDKUnsignedNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKCVec_NetAddressZ val);
17694 * Creates a copy of the UnsignedNodeAnnouncement
17696 struct LDKUnsignedNodeAnnouncement UnsignedNodeAnnouncement_clone(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR orig);
17699 * Frees any resources used by the NodeAnnouncement, if is_owned is set and inner is non-NULL.
17701 void NodeAnnouncement_free(struct LDKNodeAnnouncement this_obj);
17704 * The signature by the node key
17706 struct LDKSignature NodeAnnouncement_get_signature(const struct LDKNodeAnnouncement *NONNULL_PTR this_ptr);
17709 * The signature by the node key
17711 void NodeAnnouncement_set_signature(struct LDKNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
17714 * The actual content of the announcement
17716 struct LDKUnsignedNodeAnnouncement NodeAnnouncement_get_contents(const struct LDKNodeAnnouncement *NONNULL_PTR this_ptr);
17719 * The actual content of the announcement
17721 void NodeAnnouncement_set_contents(struct LDKNodeAnnouncement *NONNULL_PTR this_ptr, struct LDKUnsignedNodeAnnouncement val);
17724 * Constructs a new NodeAnnouncement given each field
17726 MUST_USE_RES struct LDKNodeAnnouncement NodeAnnouncement_new(struct LDKSignature signature_arg, struct LDKUnsignedNodeAnnouncement contents_arg);
17729 * Creates a copy of the NodeAnnouncement
17731 struct LDKNodeAnnouncement NodeAnnouncement_clone(const struct LDKNodeAnnouncement *NONNULL_PTR orig);
17734 * Frees any resources used by the UnsignedChannelAnnouncement, if is_owned is set and inner is non-NULL.
17736 void UnsignedChannelAnnouncement_free(struct LDKUnsignedChannelAnnouncement this_obj);
17739 * The advertised channel features
17741 struct LDKChannelFeatures UnsignedChannelAnnouncement_get_features(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
17744 * The advertised channel features
17746 void UnsignedChannelAnnouncement_set_features(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
17749 * The genesis hash of the blockchain where the channel is to be opened
17751 const uint8_t (*UnsignedChannelAnnouncement_get_chain_hash(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr))[32];
17754 * The genesis hash of the blockchain where the channel is to be opened
17756 void UnsignedChannelAnnouncement_set_chain_hash(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17759 * The short channel ID
17761 uint64_t UnsignedChannelAnnouncement_get_short_channel_id(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
17764 * The short channel ID
17766 void UnsignedChannelAnnouncement_set_short_channel_id(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, uint64_t val);
17769 * One of the two node_ids which are endpoints of this channel
17771 struct LDKPublicKey UnsignedChannelAnnouncement_get_node_id_1(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
17774 * One of the two node_ids which are endpoints of this channel
17776 void UnsignedChannelAnnouncement_set_node_id_1(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
17779 * The other of the two node_ids which are endpoints of this channel
17781 struct LDKPublicKey UnsignedChannelAnnouncement_get_node_id_2(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
17784 * The other of the two node_ids which are endpoints of this channel
17786 void UnsignedChannelAnnouncement_set_node_id_2(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
17789 * The funding key for the first node
17791 struct LDKPublicKey UnsignedChannelAnnouncement_get_bitcoin_key_1(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
17794 * The funding key for the first node
17796 void UnsignedChannelAnnouncement_set_bitcoin_key_1(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
17799 * The funding key for the second node
17801 struct LDKPublicKey UnsignedChannelAnnouncement_get_bitcoin_key_2(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr);
17804 * The funding key for the second node
17806 void UnsignedChannelAnnouncement_set_bitcoin_key_2(struct LDKUnsignedChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKPublicKey val);
17809 * Creates a copy of the UnsignedChannelAnnouncement
17811 struct LDKUnsignedChannelAnnouncement UnsignedChannelAnnouncement_clone(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR orig);
17814 * Frees any resources used by the ChannelAnnouncement, if is_owned is set and inner is non-NULL.
17816 void ChannelAnnouncement_free(struct LDKChannelAnnouncement this_obj);
17819 * Authentication of the announcement by the first public node
17821 struct LDKSignature ChannelAnnouncement_get_node_signature_1(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
17824 * Authentication of the announcement by the first public node
17826 void ChannelAnnouncement_set_node_signature_1(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
17829 * Authentication of the announcement by the second public node
17831 struct LDKSignature ChannelAnnouncement_get_node_signature_2(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
17834 * Authentication of the announcement by the second public node
17836 void ChannelAnnouncement_set_node_signature_2(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
17839 * Proof of funding UTXO ownership by the first public node
17841 struct LDKSignature ChannelAnnouncement_get_bitcoin_signature_1(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
17844 * Proof of funding UTXO ownership by the first public node
17846 void ChannelAnnouncement_set_bitcoin_signature_1(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
17849 * Proof of funding UTXO ownership by the second public node
17851 struct LDKSignature ChannelAnnouncement_get_bitcoin_signature_2(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
17854 * Proof of funding UTXO ownership by the second public node
17856 void ChannelAnnouncement_set_bitcoin_signature_2(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKSignature val);
17859 * The actual announcement
17861 struct LDKUnsignedChannelAnnouncement ChannelAnnouncement_get_contents(const struct LDKChannelAnnouncement *NONNULL_PTR this_ptr);
17864 * The actual announcement
17866 void ChannelAnnouncement_set_contents(struct LDKChannelAnnouncement *NONNULL_PTR this_ptr, struct LDKUnsignedChannelAnnouncement val);
17869 * Constructs a new ChannelAnnouncement given each field
17871 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);
17874 * Creates a copy of the ChannelAnnouncement
17876 struct LDKChannelAnnouncement ChannelAnnouncement_clone(const struct LDKChannelAnnouncement *NONNULL_PTR orig);
17879 * Frees any resources used by the UnsignedChannelUpdate, if is_owned is set and inner is non-NULL.
17881 void UnsignedChannelUpdate_free(struct LDKUnsignedChannelUpdate this_obj);
17884 * The genesis hash of the blockchain where the channel is to be opened
17886 const uint8_t (*UnsignedChannelUpdate_get_chain_hash(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr))[32];
17889 * The genesis hash of the blockchain where the channel is to be opened
17891 void UnsignedChannelUpdate_set_chain_hash(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
17894 * The short channel ID
17896 uint64_t UnsignedChannelUpdate_get_short_channel_id(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
17899 * The short channel ID
17901 void UnsignedChannelUpdate_set_short_channel_id(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint64_t val);
17904 * A strictly monotonic announcement counter, with gaps allowed, specific to this channel
17906 uint32_t UnsignedChannelUpdate_get_timestamp(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
17909 * A strictly monotonic announcement counter, with gaps allowed, specific to this channel
17911 void UnsignedChannelUpdate_set_timestamp(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
17916 uint8_t UnsignedChannelUpdate_get_flags(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
17921 void UnsignedChannelUpdate_set_flags(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint8_t val);
17924 * The number of blocks such that if:
17925 * `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
17926 * then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
17927 * the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
17928 * cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
17929 * then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
17930 * forwarding. Note that the HTLC sender is the one who originally sets this value when
17931 * constructing the route.
17933 uint16_t UnsignedChannelUpdate_get_cltv_expiry_delta(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
17936 * The number of blocks such that if:
17937 * `incoming_htlc.cltv_expiry < outgoing_htlc.cltv_expiry + cltv_expiry_delta`
17938 * then we need to fail the HTLC backwards. When forwarding an HTLC, cltv_expiry_delta determines
17939 * the outgoing HTLC's minimum cltv_expiry value -- so, if an incoming HTLC comes in with a
17940 * cltv_expiry of 100000, and the node we're forwarding to has a cltv_expiry_delta value of 10,
17941 * then we'll check that the outgoing HTLC's cltv_expiry value is at least 100010 before
17942 * forwarding. Note that the HTLC sender is the one who originally sets this value when
17943 * constructing the route.
17945 void UnsignedChannelUpdate_set_cltv_expiry_delta(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint16_t val);
17948 * The minimum HTLC size incoming to sender, in milli-satoshi
17950 uint64_t UnsignedChannelUpdate_get_htlc_minimum_msat(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
17953 * The minimum HTLC size incoming to sender, in milli-satoshi
17955 void UnsignedChannelUpdate_set_htlc_minimum_msat(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint64_t val);
17958 * The base HTLC fee charged by sender, in milli-satoshi
17960 uint32_t UnsignedChannelUpdate_get_fee_base_msat(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
17963 * The base HTLC fee charged by sender, in milli-satoshi
17965 void UnsignedChannelUpdate_set_fee_base_msat(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
17968 * The amount to fee multiplier, in micro-satoshi
17970 uint32_t UnsignedChannelUpdate_get_fee_proportional_millionths(const struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr);
17973 * The amount to fee multiplier, in micro-satoshi
17975 void UnsignedChannelUpdate_set_fee_proportional_millionths(struct LDKUnsignedChannelUpdate *NONNULL_PTR this_ptr, uint32_t val);
17978 * Creates a copy of the UnsignedChannelUpdate
17980 struct LDKUnsignedChannelUpdate UnsignedChannelUpdate_clone(const struct LDKUnsignedChannelUpdate *NONNULL_PTR orig);
17983 * Frees any resources used by the ChannelUpdate, if is_owned is set and inner is non-NULL.
17985 void ChannelUpdate_free(struct LDKChannelUpdate this_obj);
17988 * A signature of the channel update
17990 struct LDKSignature ChannelUpdate_get_signature(const struct LDKChannelUpdate *NONNULL_PTR this_ptr);
17993 * A signature of the channel update
17995 void ChannelUpdate_set_signature(struct LDKChannelUpdate *NONNULL_PTR this_ptr, struct LDKSignature val);
17998 * The actual channel update
18000 struct LDKUnsignedChannelUpdate ChannelUpdate_get_contents(const struct LDKChannelUpdate *NONNULL_PTR this_ptr);
18003 * The actual channel update
18005 void ChannelUpdate_set_contents(struct LDKChannelUpdate *NONNULL_PTR this_ptr, struct LDKUnsignedChannelUpdate val);
18008 * Constructs a new ChannelUpdate given each field
18010 MUST_USE_RES struct LDKChannelUpdate ChannelUpdate_new(struct LDKSignature signature_arg, struct LDKUnsignedChannelUpdate contents_arg);
18013 * Creates a copy of the ChannelUpdate
18015 struct LDKChannelUpdate ChannelUpdate_clone(const struct LDKChannelUpdate *NONNULL_PTR orig);
18018 * Frees any resources used by the QueryChannelRange, if is_owned is set and inner is non-NULL.
18020 void QueryChannelRange_free(struct LDKQueryChannelRange this_obj);
18023 * The genesis hash of the blockchain being queried
18025 const uint8_t (*QueryChannelRange_get_chain_hash(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr))[32];
18028 * The genesis hash of the blockchain being queried
18030 void QueryChannelRange_set_chain_hash(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
18033 * The height of the first block for the channel UTXOs being queried
18035 uint32_t QueryChannelRange_get_first_blocknum(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr);
18038 * The height of the first block for the channel UTXOs being queried
18040 void QueryChannelRange_set_first_blocknum(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, uint32_t val);
18043 * The number of blocks to include in the query results
18045 uint32_t QueryChannelRange_get_number_of_blocks(const struct LDKQueryChannelRange *NONNULL_PTR this_ptr);
18048 * The number of blocks to include in the query results
18050 void QueryChannelRange_set_number_of_blocks(struct LDKQueryChannelRange *NONNULL_PTR this_ptr, uint32_t val);
18053 * Constructs a new QueryChannelRange given each field
18055 MUST_USE_RES struct LDKQueryChannelRange QueryChannelRange_new(struct LDKThirtyTwoBytes chain_hash_arg, uint32_t first_blocknum_arg, uint32_t number_of_blocks_arg);
18058 * Creates a copy of the QueryChannelRange
18060 struct LDKQueryChannelRange QueryChannelRange_clone(const struct LDKQueryChannelRange *NONNULL_PTR orig);
18063 * Frees any resources used by the ReplyChannelRange, if is_owned is set and inner is non-NULL.
18065 void ReplyChannelRange_free(struct LDKReplyChannelRange this_obj);
18068 * The genesis hash of the blockchain being queried
18070 const uint8_t (*ReplyChannelRange_get_chain_hash(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr))[32];
18073 * The genesis hash of the blockchain being queried
18075 void ReplyChannelRange_set_chain_hash(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
18078 * The height of the first block in the range of the reply
18080 uint32_t ReplyChannelRange_get_first_blocknum(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
18083 * The height of the first block in the range of the reply
18085 void ReplyChannelRange_set_first_blocknum(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, uint32_t val);
18088 * The number of blocks included in the range of the reply
18090 uint32_t ReplyChannelRange_get_number_of_blocks(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
18093 * The number of blocks included in the range of the reply
18095 void ReplyChannelRange_set_number_of_blocks(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, uint32_t val);
18098 * True when this is the final reply for a query
18100 bool ReplyChannelRange_get_sync_complete(const struct LDKReplyChannelRange *NONNULL_PTR this_ptr);
18103 * True when this is the final reply for a query
18105 void ReplyChannelRange_set_sync_complete(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, bool val);
18108 * The short_channel_ids in the channel range
18110 void ReplyChannelRange_set_short_channel_ids(struct LDKReplyChannelRange *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
18113 * Constructs a new ReplyChannelRange given each field
18115 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);
18118 * Creates a copy of the ReplyChannelRange
18120 struct LDKReplyChannelRange ReplyChannelRange_clone(const struct LDKReplyChannelRange *NONNULL_PTR orig);
18123 * Frees any resources used by the QueryShortChannelIds, if is_owned is set and inner is non-NULL.
18125 void QueryShortChannelIds_free(struct LDKQueryShortChannelIds this_obj);
18128 * The genesis hash of the blockchain being queried
18130 const uint8_t (*QueryShortChannelIds_get_chain_hash(const struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr))[32];
18133 * The genesis hash of the blockchain being queried
18135 void QueryShortChannelIds_set_chain_hash(struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
18138 * The short_channel_ids that are being queried
18140 void QueryShortChannelIds_set_short_channel_ids(struct LDKQueryShortChannelIds *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
18143 * Constructs a new QueryShortChannelIds given each field
18145 MUST_USE_RES struct LDKQueryShortChannelIds QueryShortChannelIds_new(struct LDKThirtyTwoBytes chain_hash_arg, struct LDKCVec_u64Z short_channel_ids_arg);
18148 * Creates a copy of the QueryShortChannelIds
18150 struct LDKQueryShortChannelIds QueryShortChannelIds_clone(const struct LDKQueryShortChannelIds *NONNULL_PTR orig);
18153 * Frees any resources used by the ReplyShortChannelIdsEnd, if is_owned is set and inner is non-NULL.
18155 void ReplyShortChannelIdsEnd_free(struct LDKReplyShortChannelIdsEnd this_obj);
18158 * The genesis hash of the blockchain that was queried
18160 const uint8_t (*ReplyShortChannelIdsEnd_get_chain_hash(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr))[32];
18163 * The genesis hash of the blockchain that was queried
18165 void ReplyShortChannelIdsEnd_set_chain_hash(struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
18168 * Indicates if the query recipient maintains up-to-date channel
18169 * information for the chain_hash
18171 bool ReplyShortChannelIdsEnd_get_full_information(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr);
18174 * Indicates if the query recipient maintains up-to-date channel
18175 * information for the chain_hash
18177 void ReplyShortChannelIdsEnd_set_full_information(struct LDKReplyShortChannelIdsEnd *NONNULL_PTR this_ptr, bool val);
18180 * Constructs a new ReplyShortChannelIdsEnd given each field
18182 MUST_USE_RES struct LDKReplyShortChannelIdsEnd ReplyShortChannelIdsEnd_new(struct LDKThirtyTwoBytes chain_hash_arg, bool full_information_arg);
18185 * Creates a copy of the ReplyShortChannelIdsEnd
18187 struct LDKReplyShortChannelIdsEnd ReplyShortChannelIdsEnd_clone(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR orig);
18190 * Frees any resources used by the GossipTimestampFilter, if is_owned is set and inner is non-NULL.
18192 void GossipTimestampFilter_free(struct LDKGossipTimestampFilter this_obj);
18195 * The genesis hash of the blockchain for channel and node information
18197 const uint8_t (*GossipTimestampFilter_get_chain_hash(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr))[32];
18200 * The genesis hash of the blockchain for channel and node information
18202 void GossipTimestampFilter_set_chain_hash(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
18205 * The starting unix timestamp
18207 uint32_t GossipTimestampFilter_get_first_timestamp(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr);
18210 * The starting unix timestamp
18212 void GossipTimestampFilter_set_first_timestamp(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, uint32_t val);
18215 * The range of information in seconds
18217 uint32_t GossipTimestampFilter_get_timestamp_range(const struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr);
18220 * The range of information in seconds
18222 void GossipTimestampFilter_set_timestamp_range(struct LDKGossipTimestampFilter *NONNULL_PTR this_ptr, uint32_t val);
18225 * Constructs a new GossipTimestampFilter given each field
18227 MUST_USE_RES struct LDKGossipTimestampFilter GossipTimestampFilter_new(struct LDKThirtyTwoBytes chain_hash_arg, uint32_t first_timestamp_arg, uint32_t timestamp_range_arg);
18230 * Creates a copy of the GossipTimestampFilter
18232 struct LDKGossipTimestampFilter GossipTimestampFilter_clone(const struct LDKGossipTimestampFilter *NONNULL_PTR orig);
18235 * Frees any resources used by the ErrorAction
18237 void ErrorAction_free(struct LDKErrorAction this_ptr);
18240 * Creates a copy of the ErrorAction
18242 struct LDKErrorAction ErrorAction_clone(const struct LDKErrorAction *NONNULL_PTR orig);
18245 * Utility method to constructs a new DisconnectPeer-variant ErrorAction
18247 struct LDKErrorAction ErrorAction_disconnect_peer(struct LDKErrorMessage msg);
18250 * Utility method to constructs a new IgnoreError-variant ErrorAction
18252 struct LDKErrorAction ErrorAction_ignore_error(void);
18255 * Utility method to constructs a new IgnoreAndLog-variant ErrorAction
18257 struct LDKErrorAction ErrorAction_ignore_and_log(enum LDKLevel a);
18260 * Utility method to constructs a new SendErrorMessage-variant ErrorAction
18262 struct LDKErrorAction ErrorAction_send_error_message(struct LDKErrorMessage msg);
18265 * Frees any resources used by the LightningError, if is_owned is set and inner is non-NULL.
18267 void LightningError_free(struct LDKLightningError this_obj);
18270 * A human-readable message describing the error
18272 struct LDKStr LightningError_get_err(const struct LDKLightningError *NONNULL_PTR this_ptr);
18275 * A human-readable message describing the error
18277 void LightningError_set_err(struct LDKLightningError *NONNULL_PTR this_ptr, struct LDKStr val);
18280 * The action which should be taken against the offending peer.
18282 struct LDKErrorAction LightningError_get_action(const struct LDKLightningError *NONNULL_PTR this_ptr);
18285 * The action which should be taken against the offending peer.
18287 void LightningError_set_action(struct LDKLightningError *NONNULL_PTR this_ptr, struct LDKErrorAction val);
18290 * Constructs a new LightningError given each field
18292 MUST_USE_RES struct LDKLightningError LightningError_new(struct LDKStr err_arg, struct LDKErrorAction action_arg);
18295 * Creates a copy of the LightningError
18297 struct LDKLightningError LightningError_clone(const struct LDKLightningError *NONNULL_PTR orig);
18300 * Frees any resources used by the CommitmentUpdate, if is_owned is set and inner is non-NULL.
18302 void CommitmentUpdate_free(struct LDKCommitmentUpdate this_obj);
18305 * update_add_htlc messages which should be sent
18307 struct LDKCVec_UpdateAddHTLCZ CommitmentUpdate_get_update_add_htlcs(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
18310 * update_add_htlc messages which should be sent
18312 void CommitmentUpdate_set_update_add_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateAddHTLCZ val);
18315 * update_fulfill_htlc messages which should be sent
18317 struct LDKCVec_UpdateFulfillHTLCZ CommitmentUpdate_get_update_fulfill_htlcs(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
18320 * update_fulfill_htlc messages which should be sent
18322 void CommitmentUpdate_set_update_fulfill_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFulfillHTLCZ val);
18325 * update_fail_htlc messages which should be sent
18327 struct LDKCVec_UpdateFailHTLCZ CommitmentUpdate_get_update_fail_htlcs(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
18330 * update_fail_htlc messages which should be sent
18332 void CommitmentUpdate_set_update_fail_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFailHTLCZ val);
18335 * update_fail_malformed_htlc messages which should be sent
18337 struct LDKCVec_UpdateFailMalformedHTLCZ CommitmentUpdate_get_update_fail_malformed_htlcs(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
18340 * update_fail_malformed_htlc messages which should be sent
18342 void CommitmentUpdate_set_update_fail_malformed_htlcs(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCVec_UpdateFailMalformedHTLCZ val);
18345 * An update_fee message which should be sent
18347 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
18349 struct LDKUpdateFee CommitmentUpdate_get_update_fee(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
18352 * An update_fee message which should be sent
18354 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
18356 void CommitmentUpdate_set_update_fee(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKUpdateFee val);
18359 * Finally, the commitment_signed message which should be sent
18361 struct LDKCommitmentSigned CommitmentUpdate_get_commitment_signed(const struct LDKCommitmentUpdate *NONNULL_PTR this_ptr);
18364 * Finally, the commitment_signed message which should be sent
18366 void CommitmentUpdate_set_commitment_signed(struct LDKCommitmentUpdate *NONNULL_PTR this_ptr, struct LDKCommitmentSigned val);
18369 * Constructs a new CommitmentUpdate given each field
18371 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);
18374 * Creates a copy of the CommitmentUpdate
18376 struct LDKCommitmentUpdate CommitmentUpdate_clone(const struct LDKCommitmentUpdate *NONNULL_PTR orig);
18379 * Calls the free function if one is set
18381 void ChannelMessageHandler_free(struct LDKChannelMessageHandler this_ptr);
18384 * Calls the free function if one is set
18386 void RoutingMessageHandler_free(struct LDKRoutingMessageHandler this_ptr);
18389 * Serialize the AcceptChannel object into a byte array which can be read by AcceptChannel_read
18391 struct LDKCVec_u8Z AcceptChannel_write(const struct LDKAcceptChannel *NONNULL_PTR obj);
18394 * Read a AcceptChannel from a byte array, created by AcceptChannel_write
18396 struct LDKCResult_AcceptChannelDecodeErrorZ AcceptChannel_read(struct LDKu8slice ser);
18399 * Serialize the AnnouncementSignatures object into a byte array which can be read by AnnouncementSignatures_read
18401 struct LDKCVec_u8Z AnnouncementSignatures_write(const struct LDKAnnouncementSignatures *NONNULL_PTR obj);
18404 * Read a AnnouncementSignatures from a byte array, created by AnnouncementSignatures_write
18406 struct LDKCResult_AnnouncementSignaturesDecodeErrorZ AnnouncementSignatures_read(struct LDKu8slice ser);
18409 * Serialize the ChannelReestablish object into a byte array which can be read by ChannelReestablish_read
18411 struct LDKCVec_u8Z ChannelReestablish_write(const struct LDKChannelReestablish *NONNULL_PTR obj);
18414 * Read a ChannelReestablish from a byte array, created by ChannelReestablish_write
18416 struct LDKCResult_ChannelReestablishDecodeErrorZ ChannelReestablish_read(struct LDKu8slice ser);
18419 * Serialize the ClosingSigned object into a byte array which can be read by ClosingSigned_read
18421 struct LDKCVec_u8Z ClosingSigned_write(const struct LDKClosingSigned *NONNULL_PTR obj);
18424 * Read a ClosingSigned from a byte array, created by ClosingSigned_write
18426 struct LDKCResult_ClosingSignedDecodeErrorZ ClosingSigned_read(struct LDKu8slice ser);
18429 * Serialize the ClosingSignedFeeRange object into a byte array which can be read by ClosingSignedFeeRange_read
18431 struct LDKCVec_u8Z ClosingSignedFeeRange_write(const struct LDKClosingSignedFeeRange *NONNULL_PTR obj);
18434 * Read a ClosingSignedFeeRange from a byte array, created by ClosingSignedFeeRange_write
18436 struct LDKCResult_ClosingSignedFeeRangeDecodeErrorZ ClosingSignedFeeRange_read(struct LDKu8slice ser);
18439 * Serialize the CommitmentSigned object into a byte array which can be read by CommitmentSigned_read
18441 struct LDKCVec_u8Z CommitmentSigned_write(const struct LDKCommitmentSigned *NONNULL_PTR obj);
18444 * Read a CommitmentSigned from a byte array, created by CommitmentSigned_write
18446 struct LDKCResult_CommitmentSignedDecodeErrorZ CommitmentSigned_read(struct LDKu8slice ser);
18449 * Serialize the FundingCreated object into a byte array which can be read by FundingCreated_read
18451 struct LDKCVec_u8Z FundingCreated_write(const struct LDKFundingCreated *NONNULL_PTR obj);
18454 * Read a FundingCreated from a byte array, created by FundingCreated_write
18456 struct LDKCResult_FundingCreatedDecodeErrorZ FundingCreated_read(struct LDKu8slice ser);
18459 * Serialize the FundingSigned object into a byte array which can be read by FundingSigned_read
18461 struct LDKCVec_u8Z FundingSigned_write(const struct LDKFundingSigned *NONNULL_PTR obj);
18464 * Read a FundingSigned from a byte array, created by FundingSigned_write
18466 struct LDKCResult_FundingSignedDecodeErrorZ FundingSigned_read(struct LDKu8slice ser);
18469 * Serialize the FundingLocked object into a byte array which can be read by FundingLocked_read
18471 struct LDKCVec_u8Z FundingLocked_write(const struct LDKFundingLocked *NONNULL_PTR obj);
18474 * Read a FundingLocked from a byte array, created by FundingLocked_write
18476 struct LDKCResult_FundingLockedDecodeErrorZ FundingLocked_read(struct LDKu8slice ser);
18479 * Serialize the Init object into a byte array which can be read by Init_read
18481 struct LDKCVec_u8Z Init_write(const struct LDKInit *NONNULL_PTR obj);
18484 * Read a Init from a byte array, created by Init_write
18486 struct LDKCResult_InitDecodeErrorZ Init_read(struct LDKu8slice ser);
18489 * Serialize the OpenChannel object into a byte array which can be read by OpenChannel_read
18491 struct LDKCVec_u8Z OpenChannel_write(const struct LDKOpenChannel *NONNULL_PTR obj);
18494 * Read a OpenChannel from a byte array, created by OpenChannel_write
18496 struct LDKCResult_OpenChannelDecodeErrorZ OpenChannel_read(struct LDKu8slice ser);
18499 * Serialize the RevokeAndACK object into a byte array which can be read by RevokeAndACK_read
18501 struct LDKCVec_u8Z RevokeAndACK_write(const struct LDKRevokeAndACK *NONNULL_PTR obj);
18504 * Read a RevokeAndACK from a byte array, created by RevokeAndACK_write
18506 struct LDKCResult_RevokeAndACKDecodeErrorZ RevokeAndACK_read(struct LDKu8slice ser);
18509 * Serialize the Shutdown object into a byte array which can be read by Shutdown_read
18511 struct LDKCVec_u8Z Shutdown_write(const struct LDKShutdown *NONNULL_PTR obj);
18514 * Read a Shutdown from a byte array, created by Shutdown_write
18516 struct LDKCResult_ShutdownDecodeErrorZ Shutdown_read(struct LDKu8slice ser);
18519 * Serialize the UpdateFailHTLC object into a byte array which can be read by UpdateFailHTLC_read
18521 struct LDKCVec_u8Z UpdateFailHTLC_write(const struct LDKUpdateFailHTLC *NONNULL_PTR obj);
18524 * Read a UpdateFailHTLC from a byte array, created by UpdateFailHTLC_write
18526 struct LDKCResult_UpdateFailHTLCDecodeErrorZ UpdateFailHTLC_read(struct LDKu8slice ser);
18529 * Serialize the UpdateFailMalformedHTLC object into a byte array which can be read by UpdateFailMalformedHTLC_read
18531 struct LDKCVec_u8Z UpdateFailMalformedHTLC_write(const struct LDKUpdateFailMalformedHTLC *NONNULL_PTR obj);
18534 * Read a UpdateFailMalformedHTLC from a byte array, created by UpdateFailMalformedHTLC_write
18536 struct LDKCResult_UpdateFailMalformedHTLCDecodeErrorZ UpdateFailMalformedHTLC_read(struct LDKu8slice ser);
18539 * Serialize the UpdateFee object into a byte array which can be read by UpdateFee_read
18541 struct LDKCVec_u8Z UpdateFee_write(const struct LDKUpdateFee *NONNULL_PTR obj);
18544 * Read a UpdateFee from a byte array, created by UpdateFee_write
18546 struct LDKCResult_UpdateFeeDecodeErrorZ UpdateFee_read(struct LDKu8slice ser);
18549 * Serialize the UpdateFulfillHTLC object into a byte array which can be read by UpdateFulfillHTLC_read
18551 struct LDKCVec_u8Z UpdateFulfillHTLC_write(const struct LDKUpdateFulfillHTLC *NONNULL_PTR obj);
18554 * Read a UpdateFulfillHTLC from a byte array, created by UpdateFulfillHTLC_write
18556 struct LDKCResult_UpdateFulfillHTLCDecodeErrorZ UpdateFulfillHTLC_read(struct LDKu8slice ser);
18559 * Serialize the UpdateAddHTLC object into a byte array which can be read by UpdateAddHTLC_read
18561 struct LDKCVec_u8Z UpdateAddHTLC_write(const struct LDKUpdateAddHTLC *NONNULL_PTR obj);
18564 * Read a UpdateAddHTLC from a byte array, created by UpdateAddHTLC_write
18566 struct LDKCResult_UpdateAddHTLCDecodeErrorZ UpdateAddHTLC_read(struct LDKu8slice ser);
18569 * Serialize the Ping object into a byte array which can be read by Ping_read
18571 struct LDKCVec_u8Z Ping_write(const struct LDKPing *NONNULL_PTR obj);
18574 * Read a Ping from a byte array, created by Ping_write
18576 struct LDKCResult_PingDecodeErrorZ Ping_read(struct LDKu8slice ser);
18579 * Serialize the Pong object into a byte array which can be read by Pong_read
18581 struct LDKCVec_u8Z Pong_write(const struct LDKPong *NONNULL_PTR obj);
18584 * Read a Pong from a byte array, created by Pong_write
18586 struct LDKCResult_PongDecodeErrorZ Pong_read(struct LDKu8slice ser);
18589 * Serialize the UnsignedChannelAnnouncement object into a byte array which can be read by UnsignedChannelAnnouncement_read
18591 struct LDKCVec_u8Z UnsignedChannelAnnouncement_write(const struct LDKUnsignedChannelAnnouncement *NONNULL_PTR obj);
18594 * Read a UnsignedChannelAnnouncement from a byte array, created by UnsignedChannelAnnouncement_write
18596 struct LDKCResult_UnsignedChannelAnnouncementDecodeErrorZ UnsignedChannelAnnouncement_read(struct LDKu8slice ser);
18599 * Serialize the ChannelAnnouncement object into a byte array which can be read by ChannelAnnouncement_read
18601 struct LDKCVec_u8Z ChannelAnnouncement_write(const struct LDKChannelAnnouncement *NONNULL_PTR obj);
18604 * Read a ChannelAnnouncement from a byte array, created by ChannelAnnouncement_write
18606 struct LDKCResult_ChannelAnnouncementDecodeErrorZ ChannelAnnouncement_read(struct LDKu8slice ser);
18609 * Serialize the UnsignedChannelUpdate object into a byte array which can be read by UnsignedChannelUpdate_read
18611 struct LDKCVec_u8Z UnsignedChannelUpdate_write(const struct LDKUnsignedChannelUpdate *NONNULL_PTR obj);
18614 * Read a UnsignedChannelUpdate from a byte array, created by UnsignedChannelUpdate_write
18616 struct LDKCResult_UnsignedChannelUpdateDecodeErrorZ UnsignedChannelUpdate_read(struct LDKu8slice ser);
18619 * Serialize the ChannelUpdate object into a byte array which can be read by ChannelUpdate_read
18621 struct LDKCVec_u8Z ChannelUpdate_write(const struct LDKChannelUpdate *NONNULL_PTR obj);
18624 * Read a ChannelUpdate from a byte array, created by ChannelUpdate_write
18626 struct LDKCResult_ChannelUpdateDecodeErrorZ ChannelUpdate_read(struct LDKu8slice ser);
18629 * Serialize the ErrorMessage object into a byte array which can be read by ErrorMessage_read
18631 struct LDKCVec_u8Z ErrorMessage_write(const struct LDKErrorMessage *NONNULL_PTR obj);
18634 * Read a ErrorMessage from a byte array, created by ErrorMessage_write
18636 struct LDKCResult_ErrorMessageDecodeErrorZ ErrorMessage_read(struct LDKu8slice ser);
18639 * Serialize the UnsignedNodeAnnouncement object into a byte array which can be read by UnsignedNodeAnnouncement_read
18641 struct LDKCVec_u8Z UnsignedNodeAnnouncement_write(const struct LDKUnsignedNodeAnnouncement *NONNULL_PTR obj);
18644 * Read a UnsignedNodeAnnouncement from a byte array, created by UnsignedNodeAnnouncement_write
18646 struct LDKCResult_UnsignedNodeAnnouncementDecodeErrorZ UnsignedNodeAnnouncement_read(struct LDKu8slice ser);
18649 * Serialize the NodeAnnouncement object into a byte array which can be read by NodeAnnouncement_read
18651 struct LDKCVec_u8Z NodeAnnouncement_write(const struct LDKNodeAnnouncement *NONNULL_PTR obj);
18654 * Read a NodeAnnouncement from a byte array, created by NodeAnnouncement_write
18656 struct LDKCResult_NodeAnnouncementDecodeErrorZ NodeAnnouncement_read(struct LDKu8slice ser);
18659 * Read a QueryShortChannelIds from a byte array, created by QueryShortChannelIds_write
18661 struct LDKCResult_QueryShortChannelIdsDecodeErrorZ QueryShortChannelIds_read(struct LDKu8slice ser);
18664 * Serialize the QueryShortChannelIds object into a byte array which can be read by QueryShortChannelIds_read
18666 struct LDKCVec_u8Z QueryShortChannelIds_write(const struct LDKQueryShortChannelIds *NONNULL_PTR obj);
18669 * Serialize the ReplyShortChannelIdsEnd object into a byte array which can be read by ReplyShortChannelIdsEnd_read
18671 struct LDKCVec_u8Z ReplyShortChannelIdsEnd_write(const struct LDKReplyShortChannelIdsEnd *NONNULL_PTR obj);
18674 * Read a ReplyShortChannelIdsEnd from a byte array, created by ReplyShortChannelIdsEnd_write
18676 struct LDKCResult_ReplyShortChannelIdsEndDecodeErrorZ ReplyShortChannelIdsEnd_read(struct LDKu8slice ser);
18679 *\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
18681 MUST_USE_RES uint32_t QueryChannelRange_end_blocknum(const struct LDKQueryChannelRange *NONNULL_PTR this_arg);
18684 * Serialize the QueryChannelRange object into a byte array which can be read by QueryChannelRange_read
18686 struct LDKCVec_u8Z QueryChannelRange_write(const struct LDKQueryChannelRange *NONNULL_PTR obj);
18689 * Read a QueryChannelRange from a byte array, created by QueryChannelRange_write
18691 struct LDKCResult_QueryChannelRangeDecodeErrorZ QueryChannelRange_read(struct LDKu8slice ser);
18694 * Read a ReplyChannelRange from a byte array, created by ReplyChannelRange_write
18696 struct LDKCResult_ReplyChannelRangeDecodeErrorZ ReplyChannelRange_read(struct LDKu8slice ser);
18699 * Serialize the ReplyChannelRange object into a byte array which can be read by ReplyChannelRange_read
18701 struct LDKCVec_u8Z ReplyChannelRange_write(const struct LDKReplyChannelRange *NONNULL_PTR obj);
18704 * Serialize the GossipTimestampFilter object into a byte array which can be read by GossipTimestampFilter_read
18706 struct LDKCVec_u8Z GossipTimestampFilter_write(const struct LDKGossipTimestampFilter *NONNULL_PTR obj);
18709 * Read a GossipTimestampFilter from a byte array, created by GossipTimestampFilter_write
18711 struct LDKCResult_GossipTimestampFilterDecodeErrorZ GossipTimestampFilter_read(struct LDKu8slice ser);
18714 * Calls the free function if one is set
18716 void CustomMessageHandler_free(struct LDKCustomMessageHandler this_ptr);
18719 * Frees any resources used by the IgnoringMessageHandler, if is_owned is set and inner is non-NULL.
18721 void IgnoringMessageHandler_free(struct LDKIgnoringMessageHandler this_obj);
18724 * Constructs a new IgnoringMessageHandler given each field
18726 MUST_USE_RES struct LDKIgnoringMessageHandler IgnoringMessageHandler_new(void);
18729 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
18730 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
18732 struct LDKMessageSendEventsProvider IgnoringMessageHandler_as_MessageSendEventsProvider(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
18735 * Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg.
18736 * This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is
18738 struct LDKRoutingMessageHandler IgnoringMessageHandler_as_RoutingMessageHandler(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
18741 * Constructs a new CustomMessageReader which calls the relevant methods on this_arg.
18742 * This copies the `inner` pointer in this_arg and thus the returned CustomMessageReader must be freed before this_arg is
18744 struct LDKCustomMessageReader IgnoringMessageHandler_as_CustomMessageReader(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
18747 * Constructs a new CustomMessageHandler which calls the relevant methods on this_arg.
18748 * This copies the `inner` pointer in this_arg and thus the returned CustomMessageHandler must be freed before this_arg is
18750 struct LDKCustomMessageHandler IgnoringMessageHandler_as_CustomMessageHandler(const struct LDKIgnoringMessageHandler *NONNULL_PTR this_arg);
18753 * Frees any resources used by the ErroringMessageHandler, if is_owned is set and inner is non-NULL.
18755 void ErroringMessageHandler_free(struct LDKErroringMessageHandler this_obj);
18758 * Constructs a new ErroringMessageHandler
18760 MUST_USE_RES struct LDKErroringMessageHandler ErroringMessageHandler_new(void);
18763 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
18764 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
18766 struct LDKMessageSendEventsProvider ErroringMessageHandler_as_MessageSendEventsProvider(const struct LDKErroringMessageHandler *NONNULL_PTR this_arg);
18769 * Constructs a new ChannelMessageHandler which calls the relevant methods on this_arg.
18770 * This copies the `inner` pointer in this_arg and thus the returned ChannelMessageHandler must be freed before this_arg is
18772 struct LDKChannelMessageHandler ErroringMessageHandler_as_ChannelMessageHandler(const struct LDKErroringMessageHandler *NONNULL_PTR this_arg);
18775 * Frees any resources used by the MessageHandler, if is_owned is set and inner is non-NULL.
18777 void MessageHandler_free(struct LDKMessageHandler this_obj);
18780 * A message handler which handles messages specific to channels. Usually this is just a
18781 * [`ChannelManager`] object or an [`ErroringMessageHandler`].
18783 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
18785 const struct LDKChannelMessageHandler *MessageHandler_get_chan_handler(const struct LDKMessageHandler *NONNULL_PTR this_ptr);
18788 * A message handler which handles messages specific to channels. Usually this is just a
18789 * [`ChannelManager`] object or an [`ErroringMessageHandler`].
18791 * [`ChannelManager`]: crate::ln::channelmanager::ChannelManager
18793 void MessageHandler_set_chan_handler(struct LDKMessageHandler *NONNULL_PTR this_ptr, struct LDKChannelMessageHandler val);
18796 * A message handler which handles messages updating our knowledge of the network channel
18797 * graph. Usually this is just a [`NetGraphMsgHandler`] object or an
18798 * [`IgnoringMessageHandler`].
18800 * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
18802 const struct LDKRoutingMessageHandler *MessageHandler_get_route_handler(const struct LDKMessageHandler *NONNULL_PTR this_ptr);
18805 * A message handler which handles messages updating our knowledge of the network channel
18806 * graph. Usually this is just a [`NetGraphMsgHandler`] object or an
18807 * [`IgnoringMessageHandler`].
18809 * [`NetGraphMsgHandler`]: crate::routing::network_graph::NetGraphMsgHandler
18811 void MessageHandler_set_route_handler(struct LDKMessageHandler *NONNULL_PTR this_ptr, struct LDKRoutingMessageHandler val);
18814 * Constructs a new MessageHandler given each field
18816 MUST_USE_RES struct LDKMessageHandler MessageHandler_new(struct LDKChannelMessageHandler chan_handler_arg, struct LDKRoutingMessageHandler route_handler_arg);
18819 * Creates a copy of a SocketDescriptor
18821 struct LDKSocketDescriptor SocketDescriptor_clone(const struct LDKSocketDescriptor *NONNULL_PTR orig);
18824 * Calls the free function if one is set
18826 void SocketDescriptor_free(struct LDKSocketDescriptor this_ptr);
18829 * Frees any resources used by the PeerHandleError, if is_owned is set and inner is non-NULL.
18831 void PeerHandleError_free(struct LDKPeerHandleError this_obj);
18834 * Used to indicate that we probably can't make any future connections to this peer, implying
18835 * we should go ahead and force-close any channels we have with it.
18837 bool PeerHandleError_get_no_connection_possible(const struct LDKPeerHandleError *NONNULL_PTR this_ptr);
18840 * Used to indicate that we probably can't make any future connections to this peer, implying
18841 * we should go ahead and force-close any channels we have with it.
18843 void PeerHandleError_set_no_connection_possible(struct LDKPeerHandleError *NONNULL_PTR this_ptr, bool val);
18846 * Constructs a new PeerHandleError given each field
18848 MUST_USE_RES struct LDKPeerHandleError PeerHandleError_new(bool no_connection_possible_arg);
18851 * Creates a copy of the PeerHandleError
18853 struct LDKPeerHandleError PeerHandleError_clone(const struct LDKPeerHandleError *NONNULL_PTR orig);
18856 * Frees any resources used by the PeerManager, if is_owned is set and inner is non-NULL.
18858 void PeerManager_free(struct LDKPeerManager this_obj);
18861 * Constructs a new PeerManager with the given message handlers and node_id secret key
18862 * ephemeral_random_data is used to derive per-connection ephemeral keys and must be
18863 * cryptographically secure random bytes.
18865 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);
18868 * Get the list of node ids for peers which have completed the initial handshake.
18870 * For outbound connections, this will be the same as the their_node_id parameter passed in to
18871 * new_outbound_connection, however entries will only appear once the initial handshake has
18872 * completed and we are sure the remote peer has the private key for the given node_id.
18874 MUST_USE_RES struct LDKCVec_PublicKeyZ PeerManager_get_peer_node_ids(const struct LDKPeerManager *NONNULL_PTR this_arg);
18877 * Indicates a new outbound connection has been established to a node with the given node_id.
18878 * Note that if an Err is returned here you MUST NOT call socket_disconnected for the new
18879 * descriptor but must disconnect the connection immediately.
18881 * Returns a small number of bytes to send to the remote node (currently always 50).
18883 * Panics if descriptor is duplicative with some other descriptor which has not yet been
18884 * [`socket_disconnected()`].
18886 * [`socket_disconnected()`]: PeerManager::socket_disconnected
18888 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);
18891 * Indicates a new inbound connection has been established.
18893 * May refuse the connection by returning an Err, but will never write bytes to the remote end
18894 * (outbound connector always speaks first). Note that if an Err is returned here you MUST NOT
18895 * call socket_disconnected for the new descriptor but must disconnect the connection
18898 * Panics if descriptor is duplicative with some other descriptor which has not yet been
18899 * [`socket_disconnected()`].
18901 * [`socket_disconnected()`]: PeerManager::socket_disconnected
18903 MUST_USE_RES struct LDKCResult_NonePeerHandleErrorZ PeerManager_new_inbound_connection(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKSocketDescriptor descriptor);
18906 * Indicates that there is room to write data to the given socket descriptor.
18908 * May return an Err to indicate that the connection should be closed.
18910 * May call [`send_data`] on the descriptor passed in (or an equal descriptor) before
18911 * returning. Thus, be very careful with reentrancy issues! The invariants around calling
18912 * [`write_buffer_space_avail`] in case a write did not fully complete must still hold - be
18913 * ready to call `[write_buffer_space_avail`] again if a write call generated here isn't
18916 * [`send_data`]: SocketDescriptor::send_data
18917 * [`write_buffer_space_avail`]: PeerManager::write_buffer_space_avail
18919 MUST_USE_RES struct LDKCResult_NonePeerHandleErrorZ PeerManager_write_buffer_space_avail(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKSocketDescriptor *NONNULL_PTR descriptor);
18922 * Indicates that data was read from the given socket descriptor.
18924 * May return an Err to indicate that the connection should be closed.
18926 * Will *not* call back into [`send_data`] on any descriptors to avoid reentrancy complexity.
18927 * Thus, however, you should call [`process_events`] after any `read_event` to generate
18928 * [`send_data`] calls to handle responses.
18930 * If `Ok(true)` is returned, further read_events should not be triggered until a
18931 * [`send_data`] call on this descriptor has `resume_read` set (preventing DoS issues in the
18934 * [`send_data`]: SocketDescriptor::send_data
18935 * [`process_events`]: PeerManager::process_events
18937 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);
18940 * Checks for any events generated by our handlers and processes them. Includes sending most
18941 * response messages as well as messages generated by calls to handler functions directly (eg
18942 * functions like [`ChannelManager::process_pending_htlc_forwards`] or [`send_payment`]).
18944 * May call [`send_data`] on [`SocketDescriptor`]s. Thus, be very careful with reentrancy
18947 * You don't have to call this function explicitly if you are using [`lightning-net-tokio`]
18948 * or one of the other clients provided in our language bindings.
18950 * [`send_payment`]: crate::ln::channelmanager::ChannelManager::send_payment
18951 * [`ChannelManager::process_pending_htlc_forwards`]: crate::ln::channelmanager::ChannelManager::process_pending_htlc_forwards
18952 * [`send_data`]: SocketDescriptor::send_data
18954 void PeerManager_process_events(const struct LDKPeerManager *NONNULL_PTR this_arg);
18957 * Indicates that the given socket descriptor's connection is now closed.
18959 void PeerManager_socket_disconnected(const struct LDKPeerManager *NONNULL_PTR this_arg, const struct LDKSocketDescriptor *NONNULL_PTR descriptor);
18962 * Disconnect a peer given its node id.
18964 * Set `no_connection_possible` to true to prevent any further connection with this peer,
18965 * force-closing any channels we have with it.
18967 * If a peer is connected, this will call [`disconnect_socket`] on the descriptor for the
18968 * peer. Thus, be very careful about reentrancy issues.
18970 * [`disconnect_socket`]: SocketDescriptor::disconnect_socket
18972 void PeerManager_disconnect_by_node_id(const struct LDKPeerManager *NONNULL_PTR this_arg, struct LDKPublicKey node_id, bool no_connection_possible);
18975 * Send pings to each peer and disconnect those which did not respond to the last round of
18978 * This may be called on any timescale you want, however, roughly once every five to ten
18979 * seconds is preferred. The call rate determines both how often we send a ping to our peers
18980 * and how much time they have to respond before we disconnect them.
18982 * May call [`send_data`] on all [`SocketDescriptor`]s. Thus, be very careful with reentrancy
18985 * [`send_data`]: SocketDescriptor::send_data
18987 void PeerManager_timer_tick_occurred(const struct LDKPeerManager *NONNULL_PTR this_arg);
18990 * Build the commitment secret from the seed and the commitment number
18992 struct LDKThirtyTwoBytes build_commitment_secret(const uint8_t (*commitment_seed)[32], uint64_t idx);
18995 * Build a closing transaction
18997 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);
19000 * Derives a per-commitment-transaction private key (eg an htlc key or delayed_payment key)
19001 * from the base secret and the per_commitment_point.
19003 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
19004 * generated (ie our own).
19006 struct LDKCResult_SecretKeyErrorZ derive_private_key(struct LDKPublicKey per_commitment_point, const uint8_t (*base_secret)[32]);
19009 * Derives a per-commitment-transaction public key (eg an htlc key or a delayed_payment key)
19010 * from the base point and the per_commitment_key. This is the public equivalent of
19011 * derive_private_key - using only public keys to derive a public key instead of private keys.
19013 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
19014 * generated (ie our own).
19016 struct LDKCResult_PublicKeyErrorZ derive_public_key(struct LDKPublicKey per_commitment_point, struct LDKPublicKey base_point);
19019 * Derives a per-commitment-transaction revocation key from its constituent parts.
19021 * Only the cheating participant owns a valid witness to propagate a revoked
19022 * commitment transaction, thus per_commitment_secret always come from cheater
19023 * and revocation_base_secret always come from punisher, which is the broadcaster
19024 * of the transaction spending with this key knowledge.
19026 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
19027 * generated (ie our own).
19029 struct LDKCResult_SecretKeyErrorZ derive_private_revocation_key(const uint8_t (*per_commitment_secret)[32], const uint8_t (*countersignatory_revocation_base_secret)[32]);
19032 * Derives a per-commitment-transaction revocation public key from its constituent parts. This is
19033 * the public equivalend of derive_private_revocation_key - using only public keys to derive a
19034 * public key instead of private keys.
19036 * Only the cheating participant owns a valid witness to propagate a revoked
19037 * commitment transaction, thus per_commitment_point always come from cheater
19038 * and revocation_base_point always come from punisher, which is the broadcaster
19039 * of the transaction spending with this key knowledge.
19041 * Note that this is infallible iff we trust that at least one of the two input keys are randomly
19042 * generated (ie our own).
19044 struct LDKCResult_PublicKeyErrorZ derive_public_revocation_key(struct LDKPublicKey per_commitment_point, struct LDKPublicKey countersignatory_revocation_base_point);
19047 * Frees any resources used by the TxCreationKeys, if is_owned is set and inner is non-NULL.
19049 void TxCreationKeys_free(struct LDKTxCreationKeys this_obj);
19052 * The broadcaster's per-commitment public key which was used to derive the other keys.
19054 struct LDKPublicKey TxCreationKeys_get_per_commitment_point(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
19057 * The broadcaster's per-commitment public key which was used to derive the other keys.
19059 void TxCreationKeys_set_per_commitment_point(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
19062 * The revocation key which is used to allow the broadcaster of the commitment
19063 * transaction to provide their counterparty the ability to punish them if they broadcast
19066 struct LDKPublicKey TxCreationKeys_get_revocation_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
19069 * The revocation key which is used to allow the broadcaster of the commitment
19070 * transaction to provide their counterparty the ability to punish them if they broadcast
19073 void TxCreationKeys_set_revocation_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
19076 * Broadcaster's HTLC Key
19078 struct LDKPublicKey TxCreationKeys_get_broadcaster_htlc_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
19081 * Broadcaster's HTLC Key
19083 void TxCreationKeys_set_broadcaster_htlc_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
19086 * Countersignatory's HTLC Key
19088 struct LDKPublicKey TxCreationKeys_get_countersignatory_htlc_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
19091 * Countersignatory's HTLC Key
19093 void TxCreationKeys_set_countersignatory_htlc_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
19096 * Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
19098 struct LDKPublicKey TxCreationKeys_get_broadcaster_delayed_payment_key(const struct LDKTxCreationKeys *NONNULL_PTR this_ptr);
19101 * Broadcaster's Payment Key (which isn't allowed to be spent from for some delay)
19103 void TxCreationKeys_set_broadcaster_delayed_payment_key(struct LDKTxCreationKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
19106 * Constructs a new TxCreationKeys given each field
19108 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);
19111 * Creates a copy of the TxCreationKeys
19113 struct LDKTxCreationKeys TxCreationKeys_clone(const struct LDKTxCreationKeys *NONNULL_PTR orig);
19116 * Serialize the TxCreationKeys object into a byte array which can be read by TxCreationKeys_read
19118 struct LDKCVec_u8Z TxCreationKeys_write(const struct LDKTxCreationKeys *NONNULL_PTR obj);
19121 * Read a TxCreationKeys from a byte array, created by TxCreationKeys_write
19123 struct LDKCResult_TxCreationKeysDecodeErrorZ TxCreationKeys_read(struct LDKu8slice ser);
19126 * Frees any resources used by the ChannelPublicKeys, if is_owned is set and inner is non-NULL.
19128 void ChannelPublicKeys_free(struct LDKChannelPublicKeys this_obj);
19131 * The public key which is used to sign all commitment transactions, as it appears in the
19132 * on-chain channel lock-in 2-of-2 multisig output.
19134 struct LDKPublicKey ChannelPublicKeys_get_funding_pubkey(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
19137 * The public key which is used to sign all commitment transactions, as it appears in the
19138 * on-chain channel lock-in 2-of-2 multisig output.
19140 void ChannelPublicKeys_set_funding_pubkey(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
19143 * The base point which is used (with derive_public_revocation_key) to derive per-commitment
19144 * revocation keys. This is combined with the per-commitment-secret generated by the
19145 * counterparty to create a secret which the counterparty can reveal to revoke previous
19148 struct LDKPublicKey ChannelPublicKeys_get_revocation_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
19151 * The base point which is used (with derive_public_revocation_key) to derive per-commitment
19152 * revocation keys. This is combined with the per-commitment-secret generated by the
19153 * counterparty to create a secret which the counterparty can reveal to revoke previous
19156 void ChannelPublicKeys_set_revocation_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
19159 * The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
19160 * spendable primary channel balance on the broadcaster's commitment transaction. This key is
19161 * static across every commitment transaction.
19163 struct LDKPublicKey ChannelPublicKeys_get_payment_point(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
19166 * The public key on which the non-broadcaster (ie the countersignatory) receives an immediately
19167 * spendable primary channel balance on the broadcaster's commitment transaction. This key is
19168 * static across every commitment transaction.
19170 void ChannelPublicKeys_set_payment_point(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
19173 * The base point which is used (with derive_public_key) to derive a per-commitment payment
19174 * public key which receives non-HTLC-encumbered funds which are only available for spending
19175 * after some delay (or can be claimed via the revocation path).
19177 struct LDKPublicKey ChannelPublicKeys_get_delayed_payment_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
19180 * The base point which is used (with derive_public_key) to derive a per-commitment payment
19181 * public key which receives non-HTLC-encumbered funds which are only available for spending
19182 * after some delay (or can be claimed via the revocation path).
19184 void ChannelPublicKeys_set_delayed_payment_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
19187 * The base point which is used (with derive_public_key) to derive a per-commitment public key
19188 * which is used to encumber HTLC-in-flight outputs.
19190 struct LDKPublicKey ChannelPublicKeys_get_htlc_basepoint(const struct LDKChannelPublicKeys *NONNULL_PTR this_ptr);
19193 * The base point which is used (with derive_public_key) to derive a per-commitment public key
19194 * which is used to encumber HTLC-in-flight outputs.
19196 void ChannelPublicKeys_set_htlc_basepoint(struct LDKChannelPublicKeys *NONNULL_PTR this_ptr, struct LDKPublicKey val);
19199 * Constructs a new ChannelPublicKeys given each field
19201 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);
19204 * Creates a copy of the ChannelPublicKeys
19206 struct LDKChannelPublicKeys ChannelPublicKeys_clone(const struct LDKChannelPublicKeys *NONNULL_PTR orig);
19209 * Serialize the ChannelPublicKeys object into a byte array which can be read by ChannelPublicKeys_read
19211 struct LDKCVec_u8Z ChannelPublicKeys_write(const struct LDKChannelPublicKeys *NONNULL_PTR obj);
19214 * Read a ChannelPublicKeys from a byte array, created by ChannelPublicKeys_write
19216 struct LDKCResult_ChannelPublicKeysDecodeErrorZ ChannelPublicKeys_read(struct LDKu8slice ser);
19219 * Create per-state keys from channel base points and the per-commitment point.
19220 * Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
19222 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);
19225 * Generate per-state keys from channel static keys.
19226 * Key set is asymmetric and can't be used as part of counter-signatory set of transactions.
19228 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);
19231 * A script either spendable by the revocation
19232 * key or the broadcaster_delayed_payment_key and satisfying the relative-locktime OP_CSV constrain.
19233 * Encumbering a `to_holder` output on a commitment transaction or 2nd-stage HTLC transactions.
19235 struct LDKCVec_u8Z get_revokeable_redeemscript(struct LDKPublicKey revocation_key, uint16_t contest_delay, struct LDKPublicKey broadcaster_delayed_payment_key);
19238 * Frees any resources used by the HTLCOutputInCommitment, if is_owned is set and inner is non-NULL.
19240 void HTLCOutputInCommitment_free(struct LDKHTLCOutputInCommitment this_obj);
19243 * Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
19244 * Note that this is not the same as whether it is ountbound *from us*. To determine that you
19245 * need to compare this value to whether the commitment transaction in question is that of
19246 * the counterparty or our own.
19248 bool HTLCOutputInCommitment_get_offered(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
19251 * Whether the HTLC was \"offered\" (ie outbound in relation to this commitment transaction).
19252 * Note that this is not the same as whether it is ountbound *from us*. To determine that you
19253 * need to compare this value to whether the commitment transaction in question is that of
19254 * the counterparty or our own.
19256 void HTLCOutputInCommitment_set_offered(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, bool val);
19259 * The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
19260 * this divided by 1000.
19262 uint64_t HTLCOutputInCommitment_get_amount_msat(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
19265 * The value, in msat, of the HTLC. The value as it appears in the commitment transaction is
19266 * this divided by 1000.
19268 void HTLCOutputInCommitment_set_amount_msat(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, uint64_t val);
19271 * The CLTV lock-time at which this HTLC expires.
19273 uint32_t HTLCOutputInCommitment_get_cltv_expiry(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
19276 * The CLTV lock-time at which this HTLC expires.
19278 void HTLCOutputInCommitment_set_cltv_expiry(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, uint32_t val);
19281 * The hash of the preimage which unlocks this HTLC.
19283 const uint8_t (*HTLCOutputInCommitment_get_payment_hash(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr))[32];
19286 * The hash of the preimage which unlocks this HTLC.
19288 void HTLCOutputInCommitment_set_payment_hash(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
19291 * The position within the commitment transactions' outputs. This may be None if the value is
19292 * below the dust limit (in which case no output appears in the commitment transaction and the
19293 * value is spent to additional transaction fees).
19295 struct LDKCOption_u32Z HTLCOutputInCommitment_get_transaction_output_index(const struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr);
19298 * The position within the commitment transactions' outputs. This may be None if the value is
19299 * below the dust limit (in which case no output appears in the commitment transaction and the
19300 * value is spent to additional transaction fees).
19302 void HTLCOutputInCommitment_set_transaction_output_index(struct LDKHTLCOutputInCommitment *NONNULL_PTR this_ptr, struct LDKCOption_u32Z val);
19305 * Constructs a new HTLCOutputInCommitment given each field
19307 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);
19310 * Creates a copy of the HTLCOutputInCommitment
19312 struct LDKHTLCOutputInCommitment HTLCOutputInCommitment_clone(const struct LDKHTLCOutputInCommitment *NONNULL_PTR orig);
19315 * Serialize the HTLCOutputInCommitment object into a byte array which can be read by HTLCOutputInCommitment_read
19317 struct LDKCVec_u8Z HTLCOutputInCommitment_write(const struct LDKHTLCOutputInCommitment *NONNULL_PTR obj);
19320 * Read a HTLCOutputInCommitment from a byte array, created by HTLCOutputInCommitment_write
19322 struct LDKCResult_HTLCOutputInCommitmentDecodeErrorZ HTLCOutputInCommitment_read(struct LDKu8slice ser);
19325 * Gets the witness redeemscript for an HTLC output in a commitment transaction. Note that htlc
19326 * does not need to have its previous_output_index filled.
19328 struct LDKCVec_u8Z get_htlc_redeemscript(const struct LDKHTLCOutputInCommitment *NONNULL_PTR htlc, const struct LDKTxCreationKeys *NONNULL_PTR keys);
19331 * Gets the redeemscript for a funding output from the two funding public keys.
19332 * Note that the order of funding public keys does not matter.
19334 struct LDKCVec_u8Z make_funding_redeemscript(struct LDKPublicKey broadcaster, struct LDKPublicKey countersignatory);
19337 * Builds an unsigned HTLC-Success or HTLC-Timeout transaction from the given channel and HTLC
19338 * parameters. This is used by [`TrustedCommitmentTransaction::get_htlc_sigs`] to fetch the
19339 * transaction which needs signing, and can be used to construct an HTLC transaction which is
19340 * broadcastable given a counterparty HTLC signature.
19342 * Panics if htlc.transaction_output_index.is_none() (as such HTLCs do not appear in the
19343 * commitment transaction).
19345 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);
19348 * Frees any resources used by the ChannelTransactionParameters, if is_owned is set and inner is non-NULL.
19350 void ChannelTransactionParameters_free(struct LDKChannelTransactionParameters this_obj);
19353 * Holder public keys
19355 struct LDKChannelPublicKeys ChannelTransactionParameters_get_holder_pubkeys(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
19358 * Holder public keys
19360 void ChannelTransactionParameters_set_holder_pubkeys(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKChannelPublicKeys val);
19363 * The contest delay selected by the holder, which applies to counterparty-broadcast transactions
19365 uint16_t ChannelTransactionParameters_get_holder_selected_contest_delay(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
19368 * The contest delay selected by the holder, which applies to counterparty-broadcast transactions
19370 void ChannelTransactionParameters_set_holder_selected_contest_delay(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, uint16_t val);
19373 * Whether the holder is the initiator of this channel.
19374 * This is an input to the commitment number obscure factor computation.
19376 bool ChannelTransactionParameters_get_is_outbound_from_holder(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
19379 * Whether the holder is the initiator of this channel.
19380 * This is an input to the commitment number obscure factor computation.
19382 void ChannelTransactionParameters_set_is_outbound_from_holder(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, bool val);
19385 * The late-bound counterparty channel transaction parameters.
19386 * These parameters are populated at the point in the protocol where the counterparty provides them.
19388 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
19390 struct LDKCounterpartyChannelTransactionParameters ChannelTransactionParameters_get_counterparty_parameters(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
19393 * The late-bound counterparty channel transaction parameters.
19394 * These parameters are populated at the point in the protocol where the counterparty provides them.
19396 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
19398 void ChannelTransactionParameters_set_counterparty_parameters(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKCounterpartyChannelTransactionParameters val);
19401 * The late-bound funding outpoint
19403 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
19405 struct LDKOutPoint ChannelTransactionParameters_get_funding_outpoint(const struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr);
19408 * The late-bound funding outpoint
19410 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
19412 void ChannelTransactionParameters_set_funding_outpoint(struct LDKChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKOutPoint val);
19415 * Constructs a new ChannelTransactionParameters given each field
19417 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);
19420 * Creates a copy of the ChannelTransactionParameters
19422 struct LDKChannelTransactionParameters ChannelTransactionParameters_clone(const struct LDKChannelTransactionParameters *NONNULL_PTR orig);
19425 * Frees any resources used by the CounterpartyChannelTransactionParameters, if is_owned is set and inner is non-NULL.
19427 void CounterpartyChannelTransactionParameters_free(struct LDKCounterpartyChannelTransactionParameters this_obj);
19430 * Counter-party public keys
19432 struct LDKChannelPublicKeys CounterpartyChannelTransactionParameters_get_pubkeys(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr);
19435 * Counter-party public keys
19437 void CounterpartyChannelTransactionParameters_set_pubkeys(struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr, struct LDKChannelPublicKeys val);
19440 * The contest delay selected by the counterparty, which applies to holder-broadcast transactions
19442 uint16_t CounterpartyChannelTransactionParameters_get_selected_contest_delay(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr);
19445 * The contest delay selected by the counterparty, which applies to holder-broadcast transactions
19447 void CounterpartyChannelTransactionParameters_set_selected_contest_delay(struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR this_ptr, uint16_t val);
19450 * Constructs a new CounterpartyChannelTransactionParameters given each field
19452 MUST_USE_RES struct LDKCounterpartyChannelTransactionParameters CounterpartyChannelTransactionParameters_new(struct LDKChannelPublicKeys pubkeys_arg, uint16_t selected_contest_delay_arg);
19455 * Creates a copy of the CounterpartyChannelTransactionParameters
19457 struct LDKCounterpartyChannelTransactionParameters CounterpartyChannelTransactionParameters_clone(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR orig);
19460 * Whether the late bound parameters are populated.
19462 MUST_USE_RES bool ChannelTransactionParameters_is_populated(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
19465 * Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
19466 * given that the holder is the broadcaster.
19468 * self.is_populated() must be true before calling this function.
19470 MUST_USE_RES struct LDKDirectedChannelTransactionParameters ChannelTransactionParameters_as_holder_broadcastable(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
19473 * Convert the holder/counterparty parameters to broadcaster/countersignatory-organized parameters,
19474 * given that the counterparty is the broadcaster.
19476 * self.is_populated() must be true before calling this function.
19478 MUST_USE_RES struct LDKDirectedChannelTransactionParameters ChannelTransactionParameters_as_counterparty_broadcastable(const struct LDKChannelTransactionParameters *NONNULL_PTR this_arg);
19481 * Serialize the CounterpartyChannelTransactionParameters object into a byte array which can be read by CounterpartyChannelTransactionParameters_read
19483 struct LDKCVec_u8Z CounterpartyChannelTransactionParameters_write(const struct LDKCounterpartyChannelTransactionParameters *NONNULL_PTR obj);
19486 * Read a CounterpartyChannelTransactionParameters from a byte array, created by CounterpartyChannelTransactionParameters_write
19488 struct LDKCResult_CounterpartyChannelTransactionParametersDecodeErrorZ CounterpartyChannelTransactionParameters_read(struct LDKu8slice ser);
19491 * Serialize the ChannelTransactionParameters object into a byte array which can be read by ChannelTransactionParameters_read
19493 struct LDKCVec_u8Z ChannelTransactionParameters_write(const struct LDKChannelTransactionParameters *NONNULL_PTR obj);
19496 * Read a ChannelTransactionParameters from a byte array, created by ChannelTransactionParameters_write
19498 struct LDKCResult_ChannelTransactionParametersDecodeErrorZ ChannelTransactionParameters_read(struct LDKu8slice ser);
19501 * Frees any resources used by the DirectedChannelTransactionParameters, if is_owned is set and inner is non-NULL.
19503 void DirectedChannelTransactionParameters_free(struct LDKDirectedChannelTransactionParameters this_obj);
19506 * Get the channel pubkeys for the broadcaster
19508 MUST_USE_RES struct LDKChannelPublicKeys DirectedChannelTransactionParameters_broadcaster_pubkeys(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
19511 * Get the channel pubkeys for the countersignatory
19513 MUST_USE_RES struct LDKChannelPublicKeys DirectedChannelTransactionParameters_countersignatory_pubkeys(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
19516 * Get the contest delay applicable to the transactions.
19517 * Note that the contest delay was selected by the countersignatory.
19519 MUST_USE_RES uint16_t DirectedChannelTransactionParameters_contest_delay(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
19522 * Whether the channel is outbound from the broadcaster.
19524 * The boolean representing the side that initiated the channel is
19525 * an input to the commitment number obscure factor computation.
19527 MUST_USE_RES bool DirectedChannelTransactionParameters_is_outbound(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
19530 * The funding outpoint
19532 MUST_USE_RES struct LDKOutPoint DirectedChannelTransactionParameters_funding_outpoint(const struct LDKDirectedChannelTransactionParameters *NONNULL_PTR this_arg);
19535 * Frees any resources used by the HolderCommitmentTransaction, if is_owned is set and inner is non-NULL.
19537 void HolderCommitmentTransaction_free(struct LDKHolderCommitmentTransaction this_obj);
19540 * Our counterparty's signature for the transaction
19542 struct LDKSignature HolderCommitmentTransaction_get_counterparty_sig(const struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr);
19545 * Our counterparty's signature for the transaction
19547 void HolderCommitmentTransaction_set_counterparty_sig(struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKSignature val);
19550 * All non-dust counterparty HTLC signatures, in the order they appear in the transaction
19552 void HolderCommitmentTransaction_set_counterparty_htlc_sigs(struct LDKHolderCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKCVec_SignatureZ val);
19555 * Creates a copy of the HolderCommitmentTransaction
19557 struct LDKHolderCommitmentTransaction HolderCommitmentTransaction_clone(const struct LDKHolderCommitmentTransaction *NONNULL_PTR orig);
19560 * Serialize the HolderCommitmentTransaction object into a byte array which can be read by HolderCommitmentTransaction_read
19562 struct LDKCVec_u8Z HolderCommitmentTransaction_write(const struct LDKHolderCommitmentTransaction *NONNULL_PTR obj);
19565 * Read a HolderCommitmentTransaction from a byte array, created by HolderCommitmentTransaction_write
19567 struct LDKCResult_HolderCommitmentTransactionDecodeErrorZ HolderCommitmentTransaction_read(struct LDKu8slice ser);
19570 * Create a new holder transaction with the given counterparty signatures.
19571 * The funding keys are used to figure out which signature should go first when building the transaction for broadcast.
19573 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);
19576 * Frees any resources used by the BuiltCommitmentTransaction, if is_owned is set and inner is non-NULL.
19578 void BuiltCommitmentTransaction_free(struct LDKBuiltCommitmentTransaction this_obj);
19581 * The commitment transaction
19583 struct LDKTransaction BuiltCommitmentTransaction_get_transaction(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr);
19586 * The commitment transaction
19588 void BuiltCommitmentTransaction_set_transaction(struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKTransaction val);
19591 * The txid for the commitment transaction.
19593 * This is provided as a performance optimization, instead of calling transaction.txid()
19596 const uint8_t (*BuiltCommitmentTransaction_get_txid(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr))[32];
19599 * The txid for the commitment transaction.
19601 * This is provided as a performance optimization, instead of calling transaction.txid()
19604 void BuiltCommitmentTransaction_set_txid(struct LDKBuiltCommitmentTransaction *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
19607 * Constructs a new BuiltCommitmentTransaction given each field
19609 MUST_USE_RES struct LDKBuiltCommitmentTransaction BuiltCommitmentTransaction_new(struct LDKTransaction transaction_arg, struct LDKThirtyTwoBytes txid_arg);
19612 * Creates a copy of the BuiltCommitmentTransaction
19614 struct LDKBuiltCommitmentTransaction BuiltCommitmentTransaction_clone(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR orig);
19617 * Serialize the BuiltCommitmentTransaction object into a byte array which can be read by BuiltCommitmentTransaction_read
19619 struct LDKCVec_u8Z BuiltCommitmentTransaction_write(const struct LDKBuiltCommitmentTransaction *NONNULL_PTR obj);
19622 * Read a BuiltCommitmentTransaction from a byte array, created by BuiltCommitmentTransaction_write
19624 struct LDKCResult_BuiltCommitmentTransactionDecodeErrorZ BuiltCommitmentTransaction_read(struct LDKu8slice ser);
19627 * Get the SIGHASH_ALL sighash value of the transaction.
19629 * This can be used to verify a signature.
19631 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);
19634 * Sign a transaction, either because we are counter-signing the counterparty's transaction or
19635 * because we are about to broadcast a holder transaction.
19637 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);
19640 * Frees any resources used by the ClosingTransaction, if is_owned is set and inner is non-NULL.
19642 void ClosingTransaction_free(struct LDKClosingTransaction this_obj);
19645 * Construct an object of the class
19647 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);
19650 * Trust our pre-built transaction.
19652 * Applies a wrapper which allows access to the transaction.
19654 * This should only be used if you fully trust the builder of this object. It should not
19655 * be used by an external signer - instead use the verify function.
19657 MUST_USE_RES struct LDKTrustedClosingTransaction ClosingTransaction_trust(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
19660 * Verify our pre-built transaction.
19662 * Applies a wrapper which allows access to the transaction.
19664 * An external validating signer must call this method before signing
19665 * or using the built transaction.
19667 MUST_USE_RES struct LDKCResult_TrustedClosingTransactionNoneZ ClosingTransaction_verify(const struct LDKClosingTransaction *NONNULL_PTR this_arg, struct LDKOutPoint funding_outpoint);
19670 * The value to be sent to the holder, or zero if the output will be omitted
19672 MUST_USE_RES uint64_t ClosingTransaction_to_holder_value_sat(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
19675 * The value to be sent to the counterparty, or zero if the output will be omitted
19677 MUST_USE_RES uint64_t ClosingTransaction_to_counterparty_value_sat(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
19680 * The destination of the holder's output
19682 MUST_USE_RES struct LDKu8slice ClosingTransaction_to_holder_script(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
19685 * The destination of the counterparty's output
19687 MUST_USE_RES struct LDKu8slice ClosingTransaction_to_counterparty_script(const struct LDKClosingTransaction *NONNULL_PTR this_arg);
19690 * Frees any resources used by the TrustedClosingTransaction, if is_owned is set and inner is non-NULL.
19692 void TrustedClosingTransaction_free(struct LDKTrustedClosingTransaction this_obj);
19695 * The pre-built Bitcoin commitment transaction
19697 MUST_USE_RES struct LDKTransaction TrustedClosingTransaction_built_transaction(const struct LDKTrustedClosingTransaction *NONNULL_PTR this_arg);
19700 * Get the SIGHASH_ALL sighash value of the transaction.
19702 * This can be used to verify a signature.
19704 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);
19707 * Sign a transaction, either because we are counter-signing the counterparty's transaction or
19708 * because we are about to broadcast a holder transaction.
19710 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);
19713 * Frees any resources used by the CommitmentTransaction, if is_owned is set and inner is non-NULL.
19715 void CommitmentTransaction_free(struct LDKCommitmentTransaction this_obj);
19718 * Creates a copy of the CommitmentTransaction
19720 struct LDKCommitmentTransaction CommitmentTransaction_clone(const struct LDKCommitmentTransaction *NONNULL_PTR orig);
19723 * Serialize the CommitmentTransaction object into a byte array which can be read by CommitmentTransaction_read
19725 struct LDKCVec_u8Z CommitmentTransaction_write(const struct LDKCommitmentTransaction *NONNULL_PTR obj);
19728 * Read a CommitmentTransaction from a byte array, created by CommitmentTransaction_write
19730 struct LDKCResult_CommitmentTransactionDecodeErrorZ CommitmentTransaction_read(struct LDKu8slice ser);
19733 * The backwards-counting commitment number
19735 MUST_USE_RES uint64_t CommitmentTransaction_commitment_number(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
19738 * The value to be sent to the broadcaster
19740 MUST_USE_RES uint64_t CommitmentTransaction_to_broadcaster_value_sat(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
19743 * The value to be sent to the counterparty
19745 MUST_USE_RES uint64_t CommitmentTransaction_to_countersignatory_value_sat(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
19748 * The feerate paid per 1000-weight-unit in this commitment transaction.
19750 MUST_USE_RES uint32_t CommitmentTransaction_feerate_per_kw(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
19753 * Trust our pre-built transaction and derived transaction creation public keys.
19755 * Applies a wrapper which allows access to these fields.
19757 * This should only be used if you fully trust the builder of this object. It should not
19758 * be used by an external signer - instead use the verify function.
19760 MUST_USE_RES struct LDKTrustedCommitmentTransaction CommitmentTransaction_trust(const struct LDKCommitmentTransaction *NONNULL_PTR this_arg);
19763 * Verify our pre-built transaction and derived transaction creation public keys.
19765 * Applies a wrapper which allows access to these fields.
19767 * An external validating signer must call this method before signing
19768 * or using the built transaction.
19770 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);
19773 * Frees any resources used by the TrustedCommitmentTransaction, if is_owned is set and inner is non-NULL.
19775 void TrustedCommitmentTransaction_free(struct LDKTrustedCommitmentTransaction this_obj);
19778 * The transaction ID of the built Bitcoin transaction
19780 MUST_USE_RES struct LDKThirtyTwoBytes TrustedCommitmentTransaction_txid(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
19783 * The pre-built Bitcoin commitment transaction
19785 MUST_USE_RES struct LDKBuiltCommitmentTransaction TrustedCommitmentTransaction_built_transaction(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
19788 * The pre-calculated transaction creation public keys.
19790 MUST_USE_RES struct LDKTxCreationKeys TrustedCommitmentTransaction_keys(const struct LDKTrustedCommitmentTransaction *NONNULL_PTR this_arg);
19793 * Get a signature for each HTLC which was included in the commitment transaction (ie for
19794 * which HTLCOutputInCommitment::transaction_output_index.is_some()).
19796 * The returned Vec has one entry for each HTLC, and in the same order.
19798 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);
19801 * Commitment transaction numbers which appear in the transactions themselves are XOR'd with a
19802 * shared secret first. This prevents on-chain observers from discovering how many commitment
19803 * transactions occurred in a channel before it was closed.
19805 * This function gets the shared secret from relevant channel public keys and can be used to
19806 * \"decrypt\" the commitment transaction number given a commitment transaction on-chain.
19808 uint64_t get_commitment_transaction_number_obscure_factor(struct LDKPublicKey broadcaster_payment_basepoint, struct LDKPublicKey countersignatory_payment_basepoint, bool outbound_from_broadcaster);
19811 * Checks if two InitFeaturess contain equal inner contents.
19812 * This ignores pointers and is_owned flags and looks at the values in fields.
19813 * Two objects with NULL inner values will be considered "equal" here.
19815 bool InitFeatures_eq(const struct LDKInitFeatures *NONNULL_PTR a, const struct LDKInitFeatures *NONNULL_PTR b);
19818 * Checks if two NodeFeaturess contain equal inner contents.
19819 * This ignores pointers and is_owned flags and looks at the values in fields.
19820 * Two objects with NULL inner values will be considered "equal" here.
19822 bool NodeFeatures_eq(const struct LDKNodeFeatures *NONNULL_PTR a, const struct LDKNodeFeatures *NONNULL_PTR b);
19825 * Checks if two ChannelFeaturess contain equal inner contents.
19826 * This ignores pointers and is_owned flags and looks at the values in fields.
19827 * Two objects with NULL inner values will be considered "equal" here.
19829 bool ChannelFeatures_eq(const struct LDKChannelFeatures *NONNULL_PTR a, const struct LDKChannelFeatures *NONNULL_PTR b);
19832 * Checks if two InvoiceFeaturess contain equal inner contents.
19833 * This ignores pointers and is_owned flags and looks at the values in fields.
19834 * Two objects with NULL inner values will be considered "equal" here.
19836 bool InvoiceFeatures_eq(const struct LDKInvoiceFeatures *NONNULL_PTR a, const struct LDKInvoiceFeatures *NONNULL_PTR b);
19839 * Creates a copy of the InitFeatures
19841 struct LDKInitFeatures InitFeatures_clone(const struct LDKInitFeatures *NONNULL_PTR orig);
19844 * Creates a copy of the NodeFeatures
19846 struct LDKNodeFeatures NodeFeatures_clone(const struct LDKNodeFeatures *NONNULL_PTR orig);
19849 * Creates a copy of the ChannelFeatures
19851 struct LDKChannelFeatures ChannelFeatures_clone(const struct LDKChannelFeatures *NONNULL_PTR orig);
19854 * Creates a copy of the InvoiceFeatures
19856 struct LDKInvoiceFeatures InvoiceFeatures_clone(const struct LDKInvoiceFeatures *NONNULL_PTR orig);
19859 * Frees any resources used by the InitFeatures, if is_owned is set and inner is non-NULL.
19861 void InitFeatures_free(struct LDKInitFeatures this_obj);
19864 * Frees any resources used by the NodeFeatures, if is_owned is set and inner is non-NULL.
19866 void NodeFeatures_free(struct LDKNodeFeatures this_obj);
19869 * Frees any resources used by the ChannelFeatures, if is_owned is set and inner is non-NULL.
19871 void ChannelFeatures_free(struct LDKChannelFeatures this_obj);
19874 * Frees any resources used by the InvoiceFeatures, if is_owned is set and inner is non-NULL.
19876 void InvoiceFeatures_free(struct LDKInvoiceFeatures this_obj);
19879 * Create a blank Features with no features set
19881 MUST_USE_RES struct LDKInitFeatures InitFeatures_empty(void);
19884 * Creates a Features with the bits set which are known by the implementation
19886 MUST_USE_RES struct LDKInitFeatures InitFeatures_known(void);
19889 * Returns true if this `Features` object contains unknown feature flags which are set as
19892 MUST_USE_RES bool InitFeatures_requires_unknown_bits(const struct LDKInitFeatures *NONNULL_PTR this_arg);
19895 * Create a blank Features with no features set
19897 MUST_USE_RES struct LDKNodeFeatures NodeFeatures_empty(void);
19900 * Creates a Features with the bits set which are known by the implementation
19902 MUST_USE_RES struct LDKNodeFeatures NodeFeatures_known(void);
19905 * Returns true if this `Features` object contains unknown feature flags which are set as
19908 MUST_USE_RES bool NodeFeatures_requires_unknown_bits(const struct LDKNodeFeatures *NONNULL_PTR this_arg);
19911 * Create a blank Features with no features set
19913 MUST_USE_RES struct LDKChannelFeatures ChannelFeatures_empty(void);
19916 * Creates a Features with the bits set which are known by the implementation
19918 MUST_USE_RES struct LDKChannelFeatures ChannelFeatures_known(void);
19921 * Returns true if this `Features` object contains unknown feature flags which are set as
19924 MUST_USE_RES bool ChannelFeatures_requires_unknown_bits(const struct LDKChannelFeatures *NONNULL_PTR this_arg);
19927 * Create a blank Features with no features set
19929 MUST_USE_RES struct LDKInvoiceFeatures InvoiceFeatures_empty(void);
19932 * Creates a Features with the bits set which are known by the implementation
19934 MUST_USE_RES struct LDKInvoiceFeatures InvoiceFeatures_known(void);
19937 * Returns true if this `Features` object contains unknown feature flags which are set as
19940 MUST_USE_RES bool InvoiceFeatures_requires_unknown_bits(const struct LDKInvoiceFeatures *NONNULL_PTR this_arg);
19943 * Returns whether the `payment_secret` feature is supported.
19945 MUST_USE_RES bool InitFeatures_supports_payment_secret(const struct LDKInitFeatures *NONNULL_PTR this_arg);
19948 * Returns whether the `payment_secret` feature is supported.
19950 MUST_USE_RES bool NodeFeatures_supports_payment_secret(const struct LDKNodeFeatures *NONNULL_PTR this_arg);
19953 * Returns whether the `payment_secret` feature is supported.
19955 MUST_USE_RES bool InvoiceFeatures_supports_payment_secret(const struct LDKInvoiceFeatures *NONNULL_PTR this_arg);
19958 * Serialize the InitFeatures object into a byte array which can be read by InitFeatures_read
19960 struct LDKCVec_u8Z InitFeatures_write(const struct LDKInitFeatures *NONNULL_PTR obj);
19963 * Serialize the NodeFeatures object into a byte array which can be read by NodeFeatures_read
19965 struct LDKCVec_u8Z NodeFeatures_write(const struct LDKNodeFeatures *NONNULL_PTR obj);
19968 * Serialize the ChannelFeatures object into a byte array which can be read by ChannelFeatures_read
19970 struct LDKCVec_u8Z ChannelFeatures_write(const struct LDKChannelFeatures *NONNULL_PTR obj);
19973 * Serialize the InvoiceFeatures object into a byte array which can be read by InvoiceFeatures_read
19975 struct LDKCVec_u8Z InvoiceFeatures_write(const struct LDKInvoiceFeatures *NONNULL_PTR obj);
19978 * Read a InitFeatures from a byte array, created by InitFeatures_write
19980 struct LDKCResult_InitFeaturesDecodeErrorZ InitFeatures_read(struct LDKu8slice ser);
19983 * Read a NodeFeatures from a byte array, created by NodeFeatures_write
19985 struct LDKCResult_NodeFeaturesDecodeErrorZ NodeFeatures_read(struct LDKu8slice ser);
19988 * Read a ChannelFeatures from a byte array, created by ChannelFeatures_write
19990 struct LDKCResult_ChannelFeaturesDecodeErrorZ ChannelFeatures_read(struct LDKu8slice ser);
19993 * Read a InvoiceFeatures from a byte array, created by InvoiceFeatures_write
19995 struct LDKCResult_InvoiceFeaturesDecodeErrorZ InvoiceFeatures_read(struct LDKu8slice ser);
19998 * Frees any resources used by the ShutdownScript, if is_owned is set and inner is non-NULL.
20000 void ShutdownScript_free(struct LDKShutdownScript this_obj);
20003 * Creates a copy of the ShutdownScript
20005 struct LDKShutdownScript ShutdownScript_clone(const struct LDKShutdownScript *NONNULL_PTR orig);
20008 * Frees any resources used by the InvalidShutdownScript, if is_owned is set and inner is non-NULL.
20010 void InvalidShutdownScript_free(struct LDKInvalidShutdownScript this_obj);
20013 * The script that did not meet the requirements from [BOLT #2].
20015 * [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
20017 struct LDKu8slice InvalidShutdownScript_get_script(const struct LDKInvalidShutdownScript *NONNULL_PTR this_ptr);
20020 * The script that did not meet the requirements from [BOLT #2].
20022 * [BOLT #2]: https://github.com/lightningnetwork/lightning-rfc/blob/master/02-peer-protocol.md
20024 void InvalidShutdownScript_set_script(struct LDKInvalidShutdownScript *NONNULL_PTR this_ptr, struct LDKCVec_u8Z val);
20027 * Constructs a new InvalidShutdownScript given each field
20029 MUST_USE_RES struct LDKInvalidShutdownScript InvalidShutdownScript_new(struct LDKCVec_u8Z script_arg);
20032 * Serialize the ShutdownScript object into a byte array which can be read by ShutdownScript_read
20034 struct LDKCVec_u8Z ShutdownScript_write(const struct LDKShutdownScript *NONNULL_PTR obj);
20037 * Read a ShutdownScript from a byte array, created by ShutdownScript_write
20039 struct LDKCResult_ShutdownScriptDecodeErrorZ ShutdownScript_read(struct LDKu8slice ser);
20042 * Generates a P2WPKH script pubkey from the given [`WPubkeyHash`].
20044 MUST_USE_RES struct LDKShutdownScript ShutdownScript_new_p2wpkh(const uint8_t (*pubkey_hash)[20]);
20047 * Generates a P2WSH script pubkey from the given [`WScriptHash`].
20049 MUST_USE_RES struct LDKShutdownScript ShutdownScript_new_p2wsh(const uint8_t (*script_hash)[32]);
20052 * Generates a witness script pubkey from the given segwit version and program.
20054 * Note for version-zero witness scripts you must use [`ShutdownScript::new_p2wpkh`] or
20055 * [`ShutdownScript::new_p2wsh`] instead.
20059 * This function may return an error if `program` is invalid for the segwit `version`.
20061 MUST_USE_RES struct LDKCResult_ShutdownScriptInvalidShutdownScriptZ ShutdownScript_new_witness_program(uint8_t version, struct LDKu8slice program);
20064 * Converts the shutdown script into the underlying [`Script`].
20066 MUST_USE_RES struct LDKCVec_u8Z ShutdownScript_into_inner(struct LDKShutdownScript this_arg);
20069 * Returns the [`PublicKey`] used for a P2WPKH shutdown script if constructed directly from it.
20071 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20073 MUST_USE_RES struct LDKPublicKey ShutdownScript_as_legacy_pubkey(const struct LDKShutdownScript *NONNULL_PTR this_arg);
20076 * Returns whether the shutdown script is compatible with the features as defined by BOLT #2.
20078 * Specifically, checks for compliance with feature `option_shutdown_anysegwit`.
20080 MUST_USE_RES bool ShutdownScript_is_compatible(const struct LDKShutdownScript *NONNULL_PTR this_arg, const struct LDKInitFeatures *NONNULL_PTR features);
20083 * Calls the free function if one is set
20085 void CustomMessageReader_free(struct LDKCustomMessageReader this_ptr);
20088 * Calls the free function if one is set
20090 void Type_free(struct LDKType this_ptr);
20093 * Calls the free function if one is set
20095 void Score_free(struct LDKScore this_ptr);
20098 * Frees any resources used by the NodeId, if is_owned is set and inner is non-NULL.
20100 void NodeId_free(struct LDKNodeId this_obj);
20103 * Creates a copy of the NodeId
20105 struct LDKNodeId NodeId_clone(const struct LDKNodeId *NONNULL_PTR orig);
20108 * Create a new NodeId from a public key
20110 MUST_USE_RES struct LDKNodeId NodeId_from_pubkey(struct LDKPublicKey pubkey);
20113 * Get the public key slice from this NodeId
20115 MUST_USE_RES struct LDKu8slice NodeId_as_slice(const struct LDKNodeId *NONNULL_PTR this_arg);
20118 * Checks if two NodeIds contain equal inner contents.
20120 uint64_t NodeId_hash(const struct LDKNodeId *NONNULL_PTR o);
20123 * Serialize the NodeId object into a byte array which can be read by NodeId_read
20125 struct LDKCVec_u8Z NodeId_write(const struct LDKNodeId *NONNULL_PTR obj);
20128 * Read a NodeId from a byte array, created by NodeId_write
20130 struct LDKCResult_NodeIdDecodeErrorZ NodeId_read(struct LDKu8slice ser);
20133 * Frees any resources used by the NetworkGraph, if is_owned is set and inner is non-NULL.
20135 void NetworkGraph_free(struct LDKNetworkGraph this_obj);
20138 * Creates a copy of the NetworkGraph
20140 struct LDKNetworkGraph NetworkGraph_clone(const struct LDKNetworkGraph *NONNULL_PTR orig);
20143 * Frees any resources used by the ReadOnlyNetworkGraph, if is_owned is set and inner is non-NULL.
20145 void ReadOnlyNetworkGraph_free(struct LDKReadOnlyNetworkGraph this_obj);
20148 * Frees any resources used by the NetworkUpdate
20150 void NetworkUpdate_free(struct LDKNetworkUpdate this_ptr);
20153 * Creates a copy of the NetworkUpdate
20155 struct LDKNetworkUpdate NetworkUpdate_clone(const struct LDKNetworkUpdate *NONNULL_PTR orig);
20158 * Utility method to constructs a new ChannelUpdateMessage-variant NetworkUpdate
20160 struct LDKNetworkUpdate NetworkUpdate_channel_update_message(struct LDKChannelUpdate msg);
20163 * Utility method to constructs a new ChannelClosed-variant NetworkUpdate
20165 struct LDKNetworkUpdate NetworkUpdate_channel_closed(uint64_t short_channel_id, bool is_permanent);
20168 * Utility method to constructs a new NodeFailure-variant NetworkUpdate
20170 struct LDKNetworkUpdate NetworkUpdate_node_failure(struct LDKPublicKey node_id, bool is_permanent);
20173 * Serialize the NetworkUpdate object into a byte array which can be read by NetworkUpdate_read
20175 struct LDKCVec_u8Z NetworkUpdate_write(const struct LDKNetworkUpdate *NONNULL_PTR obj);
20178 * Constructs a new EventHandler which calls the relevant methods on this_arg.
20179 * This copies the `inner` pointer in this_arg and thus the returned EventHandler must be freed before this_arg is
20181 struct LDKEventHandler NetGraphMsgHandler_as_EventHandler(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
20184 * Frees any resources used by the NetGraphMsgHandler, if is_owned is set and inner is non-NULL.
20186 void NetGraphMsgHandler_free(struct LDKNetGraphMsgHandler this_obj);
20189 * Representation of the payment channel network
20191 struct LDKNetworkGraph NetGraphMsgHandler_get_network_graph(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_ptr);
20194 * Representation of the payment channel network
20196 void NetGraphMsgHandler_set_network_graph(struct LDKNetGraphMsgHandler *NONNULL_PTR this_ptr, struct LDKNetworkGraph val);
20199 * Creates a new tracker of the actual state of the network of channels and nodes,
20200 * assuming an existing Network Graph.
20201 * Chain monitor is used to make sure announced channels exist on-chain,
20202 * channel data is correct, and that the announcement is signed with
20203 * channel owners' keys.
20205 MUST_USE_RES struct LDKNetGraphMsgHandler NetGraphMsgHandler_new(struct LDKNetworkGraph network_graph, struct LDKCOption_AccessZ chain_access, struct LDKLogger logger);
20208 * Adds a provider used to check new announcements. Does not affect
20209 * existing announcements unless they are updated.
20210 * Add, update or remove the provider would replace the current one.
20212 void NetGraphMsgHandler_add_chain_access(struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg, struct LDKCOption_AccessZ chain_access);
20215 * Constructs a new RoutingMessageHandler which calls the relevant methods on this_arg.
20216 * This copies the `inner` pointer in this_arg and thus the returned RoutingMessageHandler must be freed before this_arg is
20218 struct LDKRoutingMessageHandler NetGraphMsgHandler_as_RoutingMessageHandler(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
20221 * Constructs a new MessageSendEventsProvider which calls the relevant methods on this_arg.
20222 * This copies the `inner` pointer in this_arg and thus the returned MessageSendEventsProvider must be freed before this_arg is
20224 struct LDKMessageSendEventsProvider NetGraphMsgHandler_as_MessageSendEventsProvider(const struct LDKNetGraphMsgHandler *NONNULL_PTR this_arg);
20227 * Frees any resources used by the DirectionalChannelInfo, if is_owned is set and inner is non-NULL.
20229 void DirectionalChannelInfo_free(struct LDKDirectionalChannelInfo this_obj);
20232 * When the last update to the channel direction was issued.
20233 * Value is opaque, as set in the announcement.
20235 uint32_t DirectionalChannelInfo_get_last_update(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
20238 * When the last update to the channel direction was issued.
20239 * Value is opaque, as set in the announcement.
20241 void DirectionalChannelInfo_set_last_update(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, uint32_t val);
20244 * Whether the channel can be currently used for payments (in this one direction).
20246 bool DirectionalChannelInfo_get_enabled(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
20249 * Whether the channel can be currently used for payments (in this one direction).
20251 void DirectionalChannelInfo_set_enabled(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, bool val);
20254 * The difference in CLTV values that you must have when routing through this channel.
20256 uint16_t DirectionalChannelInfo_get_cltv_expiry_delta(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
20259 * The difference in CLTV values that you must have when routing through this channel.
20261 void DirectionalChannelInfo_set_cltv_expiry_delta(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, uint16_t val);
20264 * The minimum value, which must be relayed to the next hop via the channel
20266 uint64_t DirectionalChannelInfo_get_htlc_minimum_msat(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
20269 * The minimum value, which must be relayed to the next hop via the channel
20271 void DirectionalChannelInfo_set_htlc_minimum_msat(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, uint64_t val);
20274 * The maximum value which may be relayed to the next hop via the channel.
20276 struct LDKCOption_u64Z DirectionalChannelInfo_get_htlc_maximum_msat(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
20279 * The maximum value which may be relayed to the next hop via the channel.
20281 void DirectionalChannelInfo_set_htlc_maximum_msat(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
20284 * Fees charged when the channel is used for routing
20286 struct LDKRoutingFees DirectionalChannelInfo_get_fees(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
20289 * Fees charged when the channel is used for routing
20291 void DirectionalChannelInfo_set_fees(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
20294 * Most recent update for the channel received from the network
20295 * Mostly redundant with the data we store in fields explicitly.
20296 * Everything else is useful only for sending out for initial routing sync.
20297 * Not stored if contains excess data to prevent DoS.
20299 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20301 struct LDKChannelUpdate DirectionalChannelInfo_get_last_update_message(const struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr);
20304 * Most recent update for the channel received from the network
20305 * Mostly redundant with the data we store in fields explicitly.
20306 * Everything else is useful only for sending out for initial routing sync.
20307 * Not stored if contains excess data to prevent DoS.
20309 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20311 void DirectionalChannelInfo_set_last_update_message(struct LDKDirectionalChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelUpdate val);
20314 * Constructs a new DirectionalChannelInfo given each field
20316 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);
20319 * Creates a copy of the DirectionalChannelInfo
20321 struct LDKDirectionalChannelInfo DirectionalChannelInfo_clone(const struct LDKDirectionalChannelInfo *NONNULL_PTR orig);
20324 * Serialize the DirectionalChannelInfo object into a byte array which can be read by DirectionalChannelInfo_read
20326 struct LDKCVec_u8Z DirectionalChannelInfo_write(const struct LDKDirectionalChannelInfo *NONNULL_PTR obj);
20329 * Read a DirectionalChannelInfo from a byte array, created by DirectionalChannelInfo_write
20331 struct LDKCResult_DirectionalChannelInfoDecodeErrorZ DirectionalChannelInfo_read(struct LDKu8slice ser);
20334 * Frees any resources used by the ChannelInfo, if is_owned is set and inner is non-NULL.
20336 void ChannelInfo_free(struct LDKChannelInfo this_obj);
20339 * Protocol features of a channel communicated during its announcement
20341 struct LDKChannelFeatures ChannelInfo_get_features(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
20344 * Protocol features of a channel communicated during its announcement
20346 void ChannelInfo_set_features(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
20349 * Source node of the first direction of a channel
20351 struct LDKNodeId ChannelInfo_get_node_one(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
20354 * Source node of the first direction of a channel
20356 void ChannelInfo_set_node_one(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKNodeId val);
20359 * Details about the first direction of a channel
20361 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20363 struct LDKDirectionalChannelInfo ChannelInfo_get_one_to_two(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
20366 * Details about the first direction of a channel
20368 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20370 void ChannelInfo_set_one_to_two(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKDirectionalChannelInfo val);
20373 * Source node of the second direction of a channel
20375 struct LDKNodeId ChannelInfo_get_node_two(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
20378 * Source node of the second direction of a channel
20380 void ChannelInfo_set_node_two(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKNodeId val);
20383 * Details about the second direction of a channel
20385 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20387 struct LDKDirectionalChannelInfo ChannelInfo_get_two_to_one(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
20390 * Details about the second direction of a channel
20392 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20394 void ChannelInfo_set_two_to_one(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKDirectionalChannelInfo val);
20397 * The channel capacity as seen on-chain, if chain lookup is available.
20399 struct LDKCOption_u64Z ChannelInfo_get_capacity_sats(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
20402 * The channel capacity as seen on-chain, if chain lookup is available.
20404 void ChannelInfo_set_capacity_sats(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
20407 * An initial announcement of the channel
20408 * Mostly redundant with the data we store in fields explicitly.
20409 * Everything else is useful only for sending out for initial routing sync.
20410 * Not stored if contains excess data to prevent DoS.
20412 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20414 struct LDKChannelAnnouncement ChannelInfo_get_announcement_message(const struct LDKChannelInfo *NONNULL_PTR this_ptr);
20417 * An initial announcement of the channel
20418 * Mostly redundant with the data we store in fields explicitly.
20419 * Everything else is useful only for sending out for initial routing sync.
20420 * Not stored if contains excess data to prevent DoS.
20422 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20424 void ChannelInfo_set_announcement_message(struct LDKChannelInfo *NONNULL_PTR this_ptr, struct LDKChannelAnnouncement val);
20427 * Constructs a new ChannelInfo given each field
20429 MUST_USE_RES struct LDKChannelInfo ChannelInfo_new(struct LDKChannelFeatures features_arg, struct LDKNodeId node_one_arg, struct LDKDirectionalChannelInfo one_to_two_arg, struct LDKNodeId node_two_arg, struct LDKDirectionalChannelInfo two_to_one_arg, struct LDKCOption_u64Z capacity_sats_arg, struct LDKChannelAnnouncement announcement_message_arg);
20432 * Creates a copy of the ChannelInfo
20434 struct LDKChannelInfo ChannelInfo_clone(const struct LDKChannelInfo *NONNULL_PTR orig);
20437 * Serialize the ChannelInfo object into a byte array which can be read by ChannelInfo_read
20439 struct LDKCVec_u8Z ChannelInfo_write(const struct LDKChannelInfo *NONNULL_PTR obj);
20442 * Read a ChannelInfo from a byte array, created by ChannelInfo_write
20444 struct LDKCResult_ChannelInfoDecodeErrorZ ChannelInfo_read(struct LDKu8slice ser);
20447 * Frees any resources used by the RoutingFees, if is_owned is set and inner is non-NULL.
20449 void RoutingFees_free(struct LDKRoutingFees this_obj);
20452 * Flat routing fee in satoshis
20454 uint32_t RoutingFees_get_base_msat(const struct LDKRoutingFees *NONNULL_PTR this_ptr);
20457 * Flat routing fee in satoshis
20459 void RoutingFees_set_base_msat(struct LDKRoutingFees *NONNULL_PTR this_ptr, uint32_t val);
20462 * Liquidity-based routing fee in millionths of a routed amount.
20463 * In other words, 10000 is 1%.
20465 uint32_t RoutingFees_get_proportional_millionths(const struct LDKRoutingFees *NONNULL_PTR this_ptr);
20468 * Liquidity-based routing fee in millionths of a routed amount.
20469 * In other words, 10000 is 1%.
20471 void RoutingFees_set_proportional_millionths(struct LDKRoutingFees *NONNULL_PTR this_ptr, uint32_t val);
20474 * Constructs a new RoutingFees given each field
20476 MUST_USE_RES struct LDKRoutingFees RoutingFees_new(uint32_t base_msat_arg, uint32_t proportional_millionths_arg);
20479 * Checks if two RoutingFeess contain equal inner contents.
20480 * This ignores pointers and is_owned flags and looks at the values in fields.
20481 * Two objects with NULL inner values will be considered "equal" here.
20483 bool RoutingFees_eq(const struct LDKRoutingFees *NONNULL_PTR a, const struct LDKRoutingFees *NONNULL_PTR b);
20486 * Creates a copy of the RoutingFees
20488 struct LDKRoutingFees RoutingFees_clone(const struct LDKRoutingFees *NONNULL_PTR orig);
20491 * Checks if two RoutingFeess contain equal inner contents.
20493 uint64_t RoutingFees_hash(const struct LDKRoutingFees *NONNULL_PTR o);
20496 * Serialize the RoutingFees object into a byte array which can be read by RoutingFees_read
20498 struct LDKCVec_u8Z RoutingFees_write(const struct LDKRoutingFees *NONNULL_PTR obj);
20501 * Read a RoutingFees from a byte array, created by RoutingFees_write
20503 struct LDKCResult_RoutingFeesDecodeErrorZ RoutingFees_read(struct LDKu8slice ser);
20506 * Frees any resources used by the NodeAnnouncementInfo, if is_owned is set and inner is non-NULL.
20508 void NodeAnnouncementInfo_free(struct LDKNodeAnnouncementInfo this_obj);
20511 * Protocol features the node announced support for
20513 struct LDKNodeFeatures NodeAnnouncementInfo_get_features(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
20516 * Protocol features the node announced support for
20518 void NodeAnnouncementInfo_set_features(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
20521 * When the last known update to the node state was issued.
20522 * Value is opaque, as set in the announcement.
20524 uint32_t NodeAnnouncementInfo_get_last_update(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
20527 * When the last known update to the node state was issued.
20528 * Value is opaque, as set in the announcement.
20530 void NodeAnnouncementInfo_set_last_update(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, uint32_t val);
20533 * Color assigned to the node
20535 const uint8_t (*NodeAnnouncementInfo_get_rgb(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr))[3];
20538 * Color assigned to the node
20540 void NodeAnnouncementInfo_set_rgb(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKThreeBytes val);
20543 * Moniker assigned to the node.
20544 * May be invalid or malicious (eg control chars),
20545 * should not be exposed to the user.
20547 const uint8_t (*NodeAnnouncementInfo_get_alias(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr))[32];
20550 * Moniker assigned to the node.
20551 * May be invalid or malicious (eg control chars),
20552 * should not be exposed to the user.
20554 void NodeAnnouncementInfo_set_alias(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKThirtyTwoBytes val);
20557 * Internet-level addresses via which one can connect to the node
20559 void NodeAnnouncementInfo_set_addresses(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKCVec_NetAddressZ val);
20562 * An initial announcement of the node
20563 * Mostly redundant with the data we store in fields explicitly.
20564 * Everything else is useful only for sending out for initial routing sync.
20565 * Not stored if contains excess data to prevent DoS.
20567 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20569 struct LDKNodeAnnouncement NodeAnnouncementInfo_get_announcement_message(const struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr);
20572 * An initial announcement of the node
20573 * Mostly redundant with the data we store in fields explicitly.
20574 * Everything else is useful only for sending out for initial routing sync.
20575 * Not stored if contains excess data to prevent DoS.
20577 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20579 void NodeAnnouncementInfo_set_announcement_message(struct LDKNodeAnnouncementInfo *NONNULL_PTR this_ptr, struct LDKNodeAnnouncement val);
20582 * Constructs a new NodeAnnouncementInfo given each field
20584 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);
20587 * Creates a copy of the NodeAnnouncementInfo
20589 struct LDKNodeAnnouncementInfo NodeAnnouncementInfo_clone(const struct LDKNodeAnnouncementInfo *NONNULL_PTR orig);
20592 * Serialize the NodeAnnouncementInfo object into a byte array which can be read by NodeAnnouncementInfo_read
20594 struct LDKCVec_u8Z NodeAnnouncementInfo_write(const struct LDKNodeAnnouncementInfo *NONNULL_PTR obj);
20597 * Read a NodeAnnouncementInfo from a byte array, created by NodeAnnouncementInfo_write
20599 struct LDKCResult_NodeAnnouncementInfoDecodeErrorZ NodeAnnouncementInfo_read(struct LDKu8slice ser);
20602 * Frees any resources used by the NodeInfo, if is_owned is set and inner is non-NULL.
20604 void NodeInfo_free(struct LDKNodeInfo this_obj);
20607 * All valid channels a node has announced
20609 void NodeInfo_set_channels(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKCVec_u64Z val);
20612 * Lowest fees enabling routing via any of the enabled, known channels to a node.
20613 * The two fields (flat and proportional fee) are independent,
20614 * meaning they don't have to refer to the same channel.
20616 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20618 struct LDKRoutingFees NodeInfo_get_lowest_inbound_channel_fees(const struct LDKNodeInfo *NONNULL_PTR this_ptr);
20621 * Lowest fees enabling routing via any of the enabled, known channels to a node.
20622 * The two fields (flat and proportional fee) are independent,
20623 * meaning they don't have to refer to the same channel.
20625 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20627 void NodeInfo_set_lowest_inbound_channel_fees(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
20630 * More information about a node from node_announcement.
20631 * Optional because we store a Node entry after learning about it from
20632 * a channel announcement, but before receiving a node announcement.
20634 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
20636 struct LDKNodeAnnouncementInfo NodeInfo_get_announcement_info(const struct LDKNodeInfo *NONNULL_PTR this_ptr);
20639 * More information about a node from node_announcement.
20640 * Optional because we store a Node entry after learning about it from
20641 * a channel announcement, but before receiving a node announcement.
20643 * Note that val (or a relevant inner pointer) may be NULL or all-0s to represent None
20645 void NodeInfo_set_announcement_info(struct LDKNodeInfo *NONNULL_PTR this_ptr, struct LDKNodeAnnouncementInfo val);
20648 * Constructs a new NodeInfo given each field
20650 MUST_USE_RES struct LDKNodeInfo NodeInfo_new(struct LDKCVec_u64Z channels_arg, struct LDKRoutingFees lowest_inbound_channel_fees_arg, struct LDKNodeAnnouncementInfo announcement_info_arg);
20653 * Creates a copy of the NodeInfo
20655 struct LDKNodeInfo NodeInfo_clone(const struct LDKNodeInfo *NONNULL_PTR orig);
20658 * Serialize the NodeInfo object into a byte array which can be read by NodeInfo_read
20660 struct LDKCVec_u8Z NodeInfo_write(const struct LDKNodeInfo *NONNULL_PTR obj);
20663 * Read a NodeInfo from a byte array, created by NodeInfo_write
20665 struct LDKCResult_NodeInfoDecodeErrorZ NodeInfo_read(struct LDKu8slice ser);
20668 * Serialize the NetworkGraph object into a byte array which can be read by NetworkGraph_read
20670 struct LDKCVec_u8Z NetworkGraph_write(const struct LDKNetworkGraph *NONNULL_PTR obj);
20673 * Read a NetworkGraph from a byte array, created by NetworkGraph_write
20675 struct LDKCResult_NetworkGraphDecodeErrorZ NetworkGraph_read(struct LDKu8slice ser);
20678 * Creates a new, empty, network graph.
20680 MUST_USE_RES struct LDKNetworkGraph NetworkGraph_new(struct LDKThirtyTwoBytes genesis_hash);
20683 * Returns a read-only view of the network graph.
20685 MUST_USE_RES struct LDKReadOnlyNetworkGraph NetworkGraph_read_only(const struct LDKNetworkGraph *NONNULL_PTR this_arg);
20688 * For an already known node (from channel announcements), update its stored properties from a
20689 * given node announcement.
20691 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
20692 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
20693 * routing messages from a source using a protocol other than the lightning P2P protocol.
20695 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_node_from_announcement(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKNodeAnnouncement *NONNULL_PTR msg);
20698 * For an already known node (from channel announcements), update its stored properties from a
20699 * given node announcement without verifying the associated signatures. Because we aren't
20700 * given the associated signatures here we cannot relay the node announcement to any of our
20703 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);
20706 * Store or update channel info from a channel announcement.
20708 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
20709 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
20710 * routing messages from a source using a protocol other than the lightning P2P protocol.
20712 * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
20713 * the corresponding UTXO exists on chain and is correctly-formatted.
20715 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);
20718 * Store or update channel info from a channel announcement without verifying the associated
20719 * signatures. Because we aren't given the associated signatures here we cannot relay the
20720 * channel announcement to any of our peers.
20722 * If a `chain::Access` object is provided via `chain_access`, it will be called to verify
20723 * the corresponding UTXO exists on chain and is correctly-formatted.
20725 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);
20728 * Close a channel if a corresponding HTLC fail was sent.
20729 * If permanent, removes a channel from the local storage.
20730 * May cause the removal of nodes too, if this was their last channel.
20731 * If not permanent, makes channels unavailable for routing.
20733 void NetworkGraph_close_channel_from_update(const struct LDKNetworkGraph *NONNULL_PTR this_arg, uint64_t short_channel_id, bool is_permanent);
20736 * Marks a node in the graph as failed.
20738 void NetworkGraph_fail_node(const struct LDKNetworkGraph *NONNULL_PTR this_arg, struct LDKPublicKey _node_id, bool is_permanent);
20741 * For an already known (from announcement) channel, update info about one of the directions
20744 * You probably don't want to call this directly, instead relying on a NetGraphMsgHandler's
20745 * RoutingMessageHandler implementation to call it indirectly. This may be useful to accept
20746 * routing messages from a source using a protocol other than the lightning P2P protocol.
20748 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKChannelUpdate *NONNULL_PTR msg);
20751 * For an already known (from announcement) channel, update info about one of the directions
20752 * of the channel without verifying the associated signatures. Because we aren't given the
20753 * associated signatures here we cannot relay the channel update to any of our peers.
20755 MUST_USE_RES struct LDKCResult_NoneLightningErrorZ NetworkGraph_update_channel_unsigned(const struct LDKNetworkGraph *NONNULL_PTR this_arg, const struct LDKUnsignedChannelUpdate *NONNULL_PTR msg);
20758 * Get network addresses by node id.
20759 * Returns None if the requested node is completely unknown,
20760 * or if node announcement for the node was never received.
20762 MUST_USE_RES struct LDKCOption_CVec_NetAddressZZ ReadOnlyNetworkGraph_get_addresses(const struct LDKReadOnlyNetworkGraph *NONNULL_PTR this_arg, struct LDKPublicKey pubkey);
20765 * Frees any resources used by the RouteHop, if is_owned is set and inner is non-NULL.
20767 void RouteHop_free(struct LDKRouteHop this_obj);
20770 * The node_id of the node at this hop.
20772 struct LDKPublicKey RouteHop_get_pubkey(const struct LDKRouteHop *NONNULL_PTR this_ptr);
20775 * The node_id of the node at this hop.
20777 void RouteHop_set_pubkey(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20780 * The node_announcement features of the node at this hop. For the last hop, these may be
20781 * amended to match the features present in the invoice this node generated.
20783 struct LDKNodeFeatures RouteHop_get_node_features(const struct LDKRouteHop *NONNULL_PTR this_ptr);
20786 * The node_announcement features of the node at this hop. For the last hop, these may be
20787 * amended to match the features present in the invoice this node generated.
20789 void RouteHop_set_node_features(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKNodeFeatures val);
20792 * The channel that should be used from the previous hop to reach this node.
20794 uint64_t RouteHop_get_short_channel_id(const struct LDKRouteHop *NONNULL_PTR this_ptr);
20797 * The channel that should be used from the previous hop to reach this node.
20799 void RouteHop_set_short_channel_id(struct LDKRouteHop *NONNULL_PTR this_ptr, uint64_t val);
20802 * The channel_announcement features of the channel that should be used from the previous hop
20803 * to reach this node.
20805 struct LDKChannelFeatures RouteHop_get_channel_features(const struct LDKRouteHop *NONNULL_PTR this_ptr);
20808 * The channel_announcement features of the channel that should be used from the previous hop
20809 * to reach this node.
20811 void RouteHop_set_channel_features(struct LDKRouteHop *NONNULL_PTR this_ptr, struct LDKChannelFeatures val);
20814 * The fee taken on this hop (for paying for the use of the *next* channel in the path).
20815 * For the last hop, this should be the full value of the payment (might be more than
20816 * requested if we had to match htlc_minimum_msat).
20818 uint64_t RouteHop_get_fee_msat(const struct LDKRouteHop *NONNULL_PTR this_ptr);
20821 * The fee taken on this hop (for paying for the use of the *next* channel in the path).
20822 * For the last hop, this should be the full value of the payment (might be more than
20823 * requested if we had to match htlc_minimum_msat).
20825 void RouteHop_set_fee_msat(struct LDKRouteHop *NONNULL_PTR this_ptr, uint64_t val);
20828 * The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
20829 * expected at the destination, in excess of the current block height.
20831 uint32_t RouteHop_get_cltv_expiry_delta(const struct LDKRouteHop *NONNULL_PTR this_ptr);
20834 * The CLTV delta added for this hop. For the last hop, this should be the full CLTV value
20835 * expected at the destination, in excess of the current block height.
20837 void RouteHop_set_cltv_expiry_delta(struct LDKRouteHop *NONNULL_PTR this_ptr, uint32_t val);
20840 * Constructs a new RouteHop given each field
20842 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);
20845 * Creates a copy of the RouteHop
20847 struct LDKRouteHop RouteHop_clone(const struct LDKRouteHop *NONNULL_PTR orig);
20850 * Checks if two RouteHops contain equal inner contents.
20852 uint64_t RouteHop_hash(const struct LDKRouteHop *NONNULL_PTR o);
20855 * Checks if two RouteHops contain equal inner contents.
20856 * This ignores pointers and is_owned flags and looks at the values in fields.
20857 * Two objects with NULL inner values will be considered "equal" here.
20859 bool RouteHop_eq(const struct LDKRouteHop *NONNULL_PTR a, const struct LDKRouteHop *NONNULL_PTR b);
20862 * Serialize the RouteHop object into a byte array which can be read by RouteHop_read
20864 struct LDKCVec_u8Z RouteHop_write(const struct LDKRouteHop *NONNULL_PTR obj);
20867 * Read a RouteHop from a byte array, created by RouteHop_write
20869 struct LDKCResult_RouteHopDecodeErrorZ RouteHop_read(struct LDKu8slice ser);
20872 * Frees any resources used by the Route, if is_owned is set and inner is non-NULL.
20874 void Route_free(struct LDKRoute this_obj);
20877 * The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
20878 * last RouteHop in each path must be the same.
20879 * Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
20880 * destination. Thus, this must always be at least length one. While the maximum length of any
20881 * given path is variable, keeping the length of any path to less than 20 should currently
20882 * ensure it is viable.
20884 struct LDKCVec_CVec_RouteHopZZ Route_get_paths(const struct LDKRoute *NONNULL_PTR this_ptr);
20887 * The list of routes taken for a single (potentially-)multi-part payment. The pubkey of the
20888 * last RouteHop in each path must be the same.
20889 * Each entry represents a list of hops, NOT INCLUDING our own, where the last hop is the
20890 * destination. Thus, this must always be at least length one. While the maximum length of any
20891 * given path is variable, keeping the length of any path to less than 20 should currently
20892 * ensure it is viable.
20894 void Route_set_paths(struct LDKRoute *NONNULL_PTR this_ptr, struct LDKCVec_CVec_RouteHopZZ val);
20897 * Constructs a new Route given each field
20899 MUST_USE_RES struct LDKRoute Route_new(struct LDKCVec_CVec_RouteHopZZ paths_arg);
20902 * Creates a copy of the Route
20904 struct LDKRoute Route_clone(const struct LDKRoute *NONNULL_PTR orig);
20907 * Checks if two Routes contain equal inner contents.
20909 uint64_t Route_hash(const struct LDKRoute *NONNULL_PTR o);
20912 * Checks if two Routes contain equal inner contents.
20913 * This ignores pointers and is_owned flags and looks at the values in fields.
20914 * Two objects with NULL inner values will be considered "equal" here.
20916 bool Route_eq(const struct LDKRoute *NONNULL_PTR a, const struct LDKRoute *NONNULL_PTR b);
20919 * Returns the total amount of fees paid on this [`Route`].
20921 * This doesn't include any extra payment made to the recipient, which can happen in excess of
20922 * the amount passed to [`get_route`]'s `final_value_msat`.
20924 MUST_USE_RES uint64_t Route_get_total_fees(const struct LDKRoute *NONNULL_PTR this_arg);
20927 * Returns the total amount paid on this [`Route`], excluding the fees.
20929 MUST_USE_RES uint64_t Route_get_total_amount(const struct LDKRoute *NONNULL_PTR this_arg);
20932 * Serialize the Route object into a byte array which can be read by Route_read
20934 struct LDKCVec_u8Z Route_write(const struct LDKRoute *NONNULL_PTR obj);
20937 * Read a Route from a byte array, created by Route_write
20939 struct LDKCResult_RouteDecodeErrorZ Route_read(struct LDKu8slice ser);
20942 * Frees any resources used by the RouteHint, if is_owned is set and inner is non-NULL.
20944 void RouteHint_free(struct LDKRouteHint this_obj);
20947 * Creates a copy of the RouteHint
20949 struct LDKRouteHint RouteHint_clone(const struct LDKRouteHint *NONNULL_PTR orig);
20952 * Checks if two RouteHints contain equal inner contents.
20954 uint64_t RouteHint_hash(const struct LDKRouteHint *NONNULL_PTR o);
20957 * Checks if two RouteHints contain equal inner contents.
20958 * This ignores pointers and is_owned flags and looks at the values in fields.
20959 * Two objects with NULL inner values will be considered "equal" here.
20961 bool RouteHint_eq(const struct LDKRouteHint *NONNULL_PTR a, const struct LDKRouteHint *NONNULL_PTR b);
20964 * Frees any resources used by the RouteHintHop, if is_owned is set and inner is non-NULL.
20966 void RouteHintHop_free(struct LDKRouteHintHop this_obj);
20969 * The node_id of the non-target end of the route
20971 struct LDKPublicKey RouteHintHop_get_src_node_id(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
20974 * The node_id of the non-target end of the route
20976 void RouteHintHop_set_src_node_id(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKPublicKey val);
20979 * The short_channel_id of this channel
20981 uint64_t RouteHintHop_get_short_channel_id(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
20984 * The short_channel_id of this channel
20986 void RouteHintHop_set_short_channel_id(struct LDKRouteHintHop *NONNULL_PTR this_ptr, uint64_t val);
20989 * The fees which must be paid to use this channel
20991 struct LDKRoutingFees RouteHintHop_get_fees(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
20994 * The fees which must be paid to use this channel
20996 void RouteHintHop_set_fees(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKRoutingFees val);
20999 * The difference in CLTV values between this node and the next node.
21001 uint16_t RouteHintHop_get_cltv_expiry_delta(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
21004 * The difference in CLTV values between this node and the next node.
21006 void RouteHintHop_set_cltv_expiry_delta(struct LDKRouteHintHop *NONNULL_PTR this_ptr, uint16_t val);
21009 * The minimum value, in msat, which must be relayed to the next hop.
21011 struct LDKCOption_u64Z RouteHintHop_get_htlc_minimum_msat(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
21014 * The minimum value, in msat, which must be relayed to the next hop.
21016 void RouteHintHop_set_htlc_minimum_msat(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
21019 * The maximum value in msat available for routing with a single HTLC.
21021 struct LDKCOption_u64Z RouteHintHop_get_htlc_maximum_msat(const struct LDKRouteHintHop *NONNULL_PTR this_ptr);
21024 * The maximum value in msat available for routing with a single HTLC.
21026 void RouteHintHop_set_htlc_maximum_msat(struct LDKRouteHintHop *NONNULL_PTR this_ptr, struct LDKCOption_u64Z val);
21029 * Constructs a new RouteHintHop given each field
21031 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);
21034 * Creates a copy of the RouteHintHop
21036 struct LDKRouteHintHop RouteHintHop_clone(const struct LDKRouteHintHop *NONNULL_PTR orig);
21039 * Checks if two RouteHintHops contain equal inner contents.
21041 uint64_t RouteHintHop_hash(const struct LDKRouteHintHop *NONNULL_PTR o);
21044 * Checks if two RouteHintHops contain equal inner contents.
21045 * This ignores pointers and is_owned flags and looks at the values in fields.
21046 * Two objects with NULL inner values will be considered "equal" here.
21048 bool RouteHintHop_eq(const struct LDKRouteHintHop *NONNULL_PTR a, const struct LDKRouteHintHop *NONNULL_PTR b);
21051 * Gets a keysend route from us (payer) to the given target node (payee). This is needed because
21052 * keysend payments do not have an invoice from which to pull the payee's supported features, which
21053 * makes it tricky to otherwise supply the `payee_features` parameter of `get_route`.
21055 * Note that first_hops (or a relevant inner pointer) may be NULL or all-0s to represent None
21057 struct LDKCResult_RouteLightningErrorZ get_keysend_route(struct LDKPublicKey our_node_pubkey, 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, const struct LDKScore *NONNULL_PTR scorer);
21060 * Gets a route from us (payer) to the given target node (payee).
21062 * If the payee provided features in their invoice, they should be provided via payee_features.
21063 * Without this, MPP will only be used if the payee's features are available in the network graph.
21065 * Private routing paths between a public node and the target may be included in `last_hops`.
21066 * Currently, only the last hop in each path is considered.
21068 * If some channels aren't announced, it may be useful to fill in a first_hops with the
21069 * results from a local ChannelManager::list_usable_channels() call. If it is filled in, our
21070 * view of our local channels (from net_graph_msg_handler) will be ignored, and only those
21071 * in first_hops will be used.
21073 * Panics if first_hops contains channels without short_channel_ids
21074 * (ChannelManager::list_usable_channels will never include such channels).
21076 * The fees on channels from us to next-hops are ignored (as they are assumed to all be
21077 * equal), however the enabled/disabled bit on such channels as well as the
21078 * htlc_minimum_msat/htlc_maximum_msat *are* checked as they may change based on the receiving node.
21080 * Note that payee_features (or a relevant inner pointer) may be NULL or all-0s to represent None
21081 * Note that first_hops (or a relevant inner pointer) may be NULL or all-0s to represent None
21083 struct LDKCResult_RouteLightningErrorZ get_route(struct LDKPublicKey our_node_pubkey, 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, const struct LDKScore *NONNULL_PTR scorer);
21086 * Frees any resources used by the Scorer, if is_owned is set and inner is non-NULL.
21088 void Scorer_free(struct LDKScorer this_obj);
21091 * Creates a new scorer using `base_penalty_msat` as the channel penalty.
21093 MUST_USE_RES struct LDKScorer Scorer_new(uint64_t base_penalty_msat);
21096 * Creates a "default" Scorer. See struct and individual field documentaiton for details on which values are used.
21098 MUST_USE_RES struct LDKScorer Scorer_default(void);
21101 * Constructs a new Score which calls the relevant methods on this_arg.
21102 * This copies the `inner` pointer in this_arg and thus the returned Score must be freed before this_arg is
21104 struct LDKScore Scorer_as_Score(const struct LDKScorer *NONNULL_PTR this_arg);
21107 * Frees any resources used by the FilesystemPersister, if is_owned is set and inner is non-NULL.
21109 void FilesystemPersister_free(struct LDKFilesystemPersister this_obj);
21112 * Initialize a new FilesystemPersister and set the path to the individual channels'
21115 MUST_USE_RES struct LDKFilesystemPersister FilesystemPersister_new(struct LDKStr path_to_channel_data);
21118 * Get the directory which was provided when this persister was initialized.
21120 MUST_USE_RES struct LDKStr FilesystemPersister_get_data_dir(const struct LDKFilesystemPersister *NONNULL_PTR this_arg);
21123 * Writes the provided `ChannelManager` to the path provided at `FilesystemPersister`
21124 * initialization, within a file called \"manager\".
21126 MUST_USE_RES struct LDKCResult_NoneErrorZ FilesystemPersister_persist_manager(struct LDKStr data_dir, const struct LDKChannelManager *NONNULL_PTR manager);
21129 * Read `ChannelMonitor`s from disk.
21131 MUST_USE_RES struct LDKCResult_CVec_C2Tuple_BlockHashChannelMonitorZZErrorZ FilesystemPersister_read_channelmonitors(const struct LDKFilesystemPersister *NONNULL_PTR this_arg, struct LDKKeysInterface keys_manager);
21134 * Constructs a new Persist which calls the relevant methods on this_arg.
21135 * This copies the `inner` pointer in this_arg and thus the returned Persist must be freed before this_arg is
21137 struct LDKPersist FilesystemPersister_as_Persist(const struct LDKFilesystemPersister *NONNULL_PTR this_arg);
21140 * Frees any resources used by the BackgroundProcessor, if is_owned is set and inner is non-NULL.
21142 void BackgroundProcessor_free(struct LDKBackgroundProcessor this_obj);
21145 * Calls the free function if one is set
21147 void ChannelManagerPersister_free(struct LDKChannelManagerPersister this_ptr);
21150 * Start a background thread that takes care of responsibilities enumerated in the [top-level
21153 * The thread runs indefinitely unless the object is dropped, [`stop`] is called, or
21154 * `persist_manager` returns an error. In case of an error, the error is retrieved by calling
21155 * either [`join`] or [`stop`].
21157 * # Data Persistence
21159 * `persist_manager` is responsible for writing out the [`ChannelManager`] to disk, and/or
21160 * uploading to one or more backup services. See [`ChannelManager::write`] for writing out a
21161 * [`ChannelManager`]. See [`FilesystemPersister::persist_manager`] for Rust-Lightning's
21162 * provided implementation.
21164 * Typically, users should either implement [`ChannelManagerPersister`] to never return an
21165 * error or call [`join`] and handle any error that may arise. For the latter case,
21166 * `BackgroundProcessor` must be restarted by calling `start` again after handling the error.
21170 * `event_handler` is responsible for handling events that users should be notified of (e.g.,
21171 * payment failed). [`BackgroundProcessor`] may decorate the given [`EventHandler`] with common
21172 * functionality implemented by other handlers.
21173 * * [`NetGraphMsgHandler`] if given will update the [`NetworkGraph`] based on payment failures.
21175 * [top-level documentation]: Self
21176 * [`join`]: Self::join
21177 * [`stop`]: Self::stop
21178 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
21179 * [`ChannelManager::write`]: lightning::ln::channelmanager::ChannelManager#impl-Writeable
21180 * [`FilesystemPersister::persist_manager`]: lightning_persister::FilesystemPersister::persist_manager
21181 * [`NetworkGraph`]: lightning::routing::network_graph::NetworkGraph
21183 * Note that net_graph_msg_handler (or a relevant inner pointer) may be NULL or all-0s to represent None
21185 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);
21188 * Join `BackgroundProcessor`'s thread, returning any error that occurred while persisting
21189 * [`ChannelManager`].
21193 * This function panics if the background thread has panicked such as while persisting or
21196 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
21198 MUST_USE_RES struct LDKCResult_NoneErrorZ BackgroundProcessor_join(struct LDKBackgroundProcessor this_arg);
21201 * Stop `BackgroundProcessor`'s thread, returning any error that occurred while persisting
21202 * [`ChannelManager`].
21206 * This function panics if the background thread has panicked such as while persisting or
21209 * [`ChannelManager`]: lightning::ln::channelmanager::ChannelManager
21211 MUST_USE_RES struct LDKCResult_NoneErrorZ BackgroundProcessor_stop(struct LDKBackgroundProcessor this_arg);
21214 * **Call this function on startup to ensure that all assumptions about the platform are valid.**
21216 * Unfortunately we have to make assumptions about the upper bounds of the `SystemTime` type on
21217 * your platform which we can't fully verify at compile time and which isn't part of it's contract.
21218 * To our best knowledge our assumptions hold for all platforms officially supported by rust, but
21219 * since this check is fast we recommend to do it anyway.
21221 * If this function fails this is considered a bug. Please open an issue describing your
21222 * platform and stating your current system time.
21225 * If the check fails this function panics. By calling this function on startup you ensure that
21226 * this wont happen at an arbitrary later point in time.
21228 void check_platform(void);
21231 * Frees any resources used by the Invoice, if is_owned is set and inner is non-NULL.
21233 void Invoice_free(struct LDKInvoice this_obj);
21236 * Checks if two Invoices contain equal inner contents.
21237 * This ignores pointers and is_owned flags and looks at the values in fields.
21238 * Two objects with NULL inner values will be considered "equal" here.
21240 bool Invoice_eq(const struct LDKInvoice *NONNULL_PTR a, const struct LDKInvoice *NONNULL_PTR b);
21243 * Creates a copy of the Invoice
21245 struct LDKInvoice Invoice_clone(const struct LDKInvoice *NONNULL_PTR orig);
21248 * Frees any resources used by the SignedRawInvoice, if is_owned is set and inner is non-NULL.
21250 void SignedRawInvoice_free(struct LDKSignedRawInvoice this_obj);
21253 * Checks if two SignedRawInvoices contain equal inner contents.
21254 * This ignores pointers and is_owned flags and looks at the values in fields.
21255 * Two objects with NULL inner values will be considered "equal" here.
21257 bool SignedRawInvoice_eq(const struct LDKSignedRawInvoice *NONNULL_PTR a, const struct LDKSignedRawInvoice *NONNULL_PTR b);
21260 * Creates a copy of the SignedRawInvoice
21262 struct LDKSignedRawInvoice SignedRawInvoice_clone(const struct LDKSignedRawInvoice *NONNULL_PTR orig);
21265 * Frees any resources used by the RawInvoice, if is_owned is set and inner is non-NULL.
21267 void RawInvoice_free(struct LDKRawInvoice this_obj);
21272 struct LDKRawDataPart RawInvoice_get_data(const struct LDKRawInvoice *NONNULL_PTR this_ptr);
21277 void RawInvoice_set_data(struct LDKRawInvoice *NONNULL_PTR this_ptr, struct LDKRawDataPart val);
21280 * Checks if two RawInvoices contain equal inner contents.
21281 * This ignores pointers and is_owned flags and looks at the values in fields.
21282 * Two objects with NULL inner values will be considered "equal" here.
21284 bool RawInvoice_eq(const struct LDKRawInvoice *NONNULL_PTR a, const struct LDKRawInvoice *NONNULL_PTR b);
21287 * Creates a copy of the RawInvoice
21289 struct LDKRawInvoice RawInvoice_clone(const struct LDKRawInvoice *NONNULL_PTR orig);
21292 * Frees any resources used by the RawDataPart, if is_owned is set and inner is non-NULL.
21294 void RawDataPart_free(struct LDKRawDataPart this_obj);
21297 * generation time of the invoice
21299 struct LDKPositiveTimestamp RawDataPart_get_timestamp(const struct LDKRawDataPart *NONNULL_PTR this_ptr);
21302 * generation time of the invoice
21304 void RawDataPart_set_timestamp(struct LDKRawDataPart *NONNULL_PTR this_ptr, struct LDKPositiveTimestamp val);
21307 * Checks if two RawDataParts contain equal inner contents.
21308 * This ignores pointers and is_owned flags and looks at the values in fields.
21309 * Two objects with NULL inner values will be considered "equal" here.
21311 bool RawDataPart_eq(const struct LDKRawDataPart *NONNULL_PTR a, const struct LDKRawDataPart *NONNULL_PTR b);
21314 * Creates a copy of the RawDataPart
21316 struct LDKRawDataPart RawDataPart_clone(const struct LDKRawDataPart *NONNULL_PTR orig);
21319 * Frees any resources used by the PositiveTimestamp, if is_owned is set and inner is non-NULL.
21321 void PositiveTimestamp_free(struct LDKPositiveTimestamp this_obj);
21324 * Checks if two PositiveTimestamps contain equal inner contents.
21325 * This ignores pointers and is_owned flags and looks at the values in fields.
21326 * Two objects with NULL inner values will be considered "equal" here.
21328 bool PositiveTimestamp_eq(const struct LDKPositiveTimestamp *NONNULL_PTR a, const struct LDKPositiveTimestamp *NONNULL_PTR b);
21331 * Creates a copy of the PositiveTimestamp
21333 struct LDKPositiveTimestamp PositiveTimestamp_clone(const struct LDKPositiveTimestamp *NONNULL_PTR orig);
21336 * Creates a copy of the SiPrefix
21338 enum LDKSiPrefix SiPrefix_clone(const enum LDKSiPrefix *NONNULL_PTR orig);
21341 * Utility method to constructs a new Milli-variant SiPrefix
21343 enum LDKSiPrefix SiPrefix_milli(void);
21346 * Utility method to constructs a new Micro-variant SiPrefix
21348 enum LDKSiPrefix SiPrefix_micro(void);
21351 * Utility method to constructs a new Nano-variant SiPrefix
21353 enum LDKSiPrefix SiPrefix_nano(void);
21356 * Utility method to constructs a new Pico-variant SiPrefix
21358 enum LDKSiPrefix SiPrefix_pico(void);
21361 * Checks if two SiPrefixs contain equal inner contents.
21362 * This ignores pointers and is_owned flags and looks at the values in fields.
21364 bool SiPrefix_eq(const enum LDKSiPrefix *NONNULL_PTR a, const enum LDKSiPrefix *NONNULL_PTR b);
21367 * Returns the multiplier to go from a BTC value to picoBTC implied by this SiPrefix.
21368 * This is effectively 10^12 * the prefix multiplier
21370 MUST_USE_RES uint64_t SiPrefix_multiplier(const enum LDKSiPrefix *NONNULL_PTR this_arg);
21373 * Creates a copy of the Currency
21375 enum LDKCurrency Currency_clone(const enum LDKCurrency *NONNULL_PTR orig);
21378 * Utility method to constructs a new Bitcoin-variant Currency
21380 enum LDKCurrency Currency_bitcoin(void);
21383 * Utility method to constructs a new BitcoinTestnet-variant Currency
21385 enum LDKCurrency Currency_bitcoin_testnet(void);
21388 * Utility method to constructs a new Regtest-variant Currency
21390 enum LDKCurrency Currency_regtest(void);
21393 * Utility method to constructs a new Simnet-variant Currency
21395 enum LDKCurrency Currency_simnet(void);
21398 * Utility method to constructs a new Signet-variant Currency
21400 enum LDKCurrency Currency_signet(void);
21403 * Checks if two Currencys contain equal inner contents.
21405 uint64_t Currency_hash(const enum LDKCurrency *NONNULL_PTR o);
21408 * Checks if two Currencys contain equal inner contents.
21409 * This ignores pointers and is_owned flags and looks at the values in fields.
21411 bool Currency_eq(const enum LDKCurrency *NONNULL_PTR a, const enum LDKCurrency *NONNULL_PTR b);
21414 * Frees any resources used by the Sha256, if is_owned is set and inner is non-NULL.
21416 void Sha256_free(struct LDKSha256 this_obj);
21419 * Creates a copy of the Sha256
21421 struct LDKSha256 Sha256_clone(const struct LDKSha256 *NONNULL_PTR orig);
21424 * Checks if two Sha256s contain equal inner contents.
21426 uint64_t Sha256_hash(const struct LDKSha256 *NONNULL_PTR o);
21429 * Checks if two Sha256s contain equal inner contents.
21430 * This ignores pointers and is_owned flags and looks at the values in fields.
21431 * Two objects with NULL inner values will be considered "equal" here.
21433 bool Sha256_eq(const struct LDKSha256 *NONNULL_PTR a, const struct LDKSha256 *NONNULL_PTR b);
21436 * Frees any resources used by the Description, if is_owned is set and inner is non-NULL.
21438 void Description_free(struct LDKDescription this_obj);
21441 * Creates a copy of the Description
21443 struct LDKDescription Description_clone(const struct LDKDescription *NONNULL_PTR orig);
21446 * Checks if two Descriptions contain equal inner contents.
21448 uint64_t Description_hash(const struct LDKDescription *NONNULL_PTR o);
21451 * Checks if two Descriptions contain equal inner contents.
21452 * This ignores pointers and is_owned flags and looks at the values in fields.
21453 * Two objects with NULL inner values will be considered "equal" here.
21455 bool Description_eq(const struct LDKDescription *NONNULL_PTR a, const struct LDKDescription *NONNULL_PTR b);
21458 * Frees any resources used by the PayeePubKey, if is_owned is set and inner is non-NULL.
21460 void PayeePubKey_free(struct LDKPayeePubKey this_obj);
21463 * Creates a copy of the PayeePubKey
21465 struct LDKPayeePubKey PayeePubKey_clone(const struct LDKPayeePubKey *NONNULL_PTR orig);
21468 * Checks if two PayeePubKeys contain equal inner contents.
21470 uint64_t PayeePubKey_hash(const struct LDKPayeePubKey *NONNULL_PTR o);
21473 * Checks if two PayeePubKeys contain equal inner contents.
21474 * This ignores pointers and is_owned flags and looks at the values in fields.
21475 * Two objects with NULL inner values will be considered "equal" here.
21477 bool PayeePubKey_eq(const struct LDKPayeePubKey *NONNULL_PTR a, const struct LDKPayeePubKey *NONNULL_PTR b);
21480 * Frees any resources used by the ExpiryTime, if is_owned is set and inner is non-NULL.
21482 void ExpiryTime_free(struct LDKExpiryTime this_obj);
21485 * Creates a copy of the ExpiryTime
21487 struct LDKExpiryTime ExpiryTime_clone(const struct LDKExpiryTime *NONNULL_PTR orig);
21490 * Checks if two ExpiryTimes contain equal inner contents.
21492 uint64_t ExpiryTime_hash(const struct LDKExpiryTime *NONNULL_PTR o);
21495 * Checks if two ExpiryTimes contain equal inner contents.
21496 * This ignores pointers and is_owned flags and looks at the values in fields.
21497 * Two objects with NULL inner values will be considered "equal" here.
21499 bool ExpiryTime_eq(const struct LDKExpiryTime *NONNULL_PTR a, const struct LDKExpiryTime *NONNULL_PTR b);
21502 * Frees any resources used by the MinFinalCltvExpiry, if is_owned is set and inner is non-NULL.
21504 void MinFinalCltvExpiry_free(struct LDKMinFinalCltvExpiry this_obj);
21507 * Creates a copy of the MinFinalCltvExpiry
21509 struct LDKMinFinalCltvExpiry MinFinalCltvExpiry_clone(const struct LDKMinFinalCltvExpiry *NONNULL_PTR orig);
21512 * Checks if two MinFinalCltvExpirys contain equal inner contents.
21514 uint64_t MinFinalCltvExpiry_hash(const struct LDKMinFinalCltvExpiry *NONNULL_PTR o);
21517 * Checks if two MinFinalCltvExpirys contain equal inner contents.
21518 * This ignores pointers and is_owned flags and looks at the values in fields.
21519 * Two objects with NULL inner values will be considered "equal" here.
21521 bool MinFinalCltvExpiry_eq(const struct LDKMinFinalCltvExpiry *NONNULL_PTR a, const struct LDKMinFinalCltvExpiry *NONNULL_PTR b);
21524 * Frees any resources used by the Fallback
21526 void Fallback_free(struct LDKFallback this_ptr);
21529 * Creates a copy of the Fallback
21531 struct LDKFallback Fallback_clone(const struct LDKFallback *NONNULL_PTR orig);
21534 * Utility method to constructs a new SegWitProgram-variant Fallback
21536 struct LDKFallback Fallback_seg_wit_program(struct LDKu5 version, struct LDKCVec_u8Z program);
21539 * Utility method to constructs a new PubKeyHash-variant Fallback
21541 struct LDKFallback Fallback_pub_key_hash(struct LDKTwentyBytes a);
21544 * Utility method to constructs a new ScriptHash-variant Fallback
21546 struct LDKFallback Fallback_script_hash(struct LDKTwentyBytes a);
21549 * Checks if two Fallbacks contain equal inner contents.
21551 uint64_t Fallback_hash(const struct LDKFallback *NONNULL_PTR o);
21554 * Checks if two Fallbacks contain equal inner contents.
21555 * This ignores pointers and is_owned flags and looks at the values in fields.
21557 bool Fallback_eq(const struct LDKFallback *NONNULL_PTR a, const struct LDKFallback *NONNULL_PTR b);
21560 * Frees any resources used by the InvoiceSignature, if is_owned is set and inner is non-NULL.
21562 void InvoiceSignature_free(struct LDKInvoiceSignature this_obj);
21565 * Creates a copy of the InvoiceSignature
21567 struct LDKInvoiceSignature InvoiceSignature_clone(const struct LDKInvoiceSignature *NONNULL_PTR orig);
21570 * Checks if two InvoiceSignatures contain equal inner contents.
21571 * This ignores pointers and is_owned flags and looks at the values in fields.
21572 * Two objects with NULL inner values will be considered "equal" here.
21574 bool InvoiceSignature_eq(const struct LDKInvoiceSignature *NONNULL_PTR a, const struct LDKInvoiceSignature *NONNULL_PTR b);
21577 * Frees any resources used by the PrivateRoute, if is_owned is set and inner is non-NULL.
21579 void PrivateRoute_free(struct LDKPrivateRoute this_obj);
21582 * Creates a copy of the PrivateRoute
21584 struct LDKPrivateRoute PrivateRoute_clone(const struct LDKPrivateRoute *NONNULL_PTR orig);
21587 * Checks if two PrivateRoutes contain equal inner contents.
21589 uint64_t PrivateRoute_hash(const struct LDKPrivateRoute *NONNULL_PTR o);
21592 * Checks if two PrivateRoutes contain equal inner contents.
21593 * This ignores pointers and is_owned flags and looks at the values in fields.
21594 * Two objects with NULL inner values will be considered "equal" here.
21596 bool PrivateRoute_eq(const struct LDKPrivateRoute *NONNULL_PTR a, const struct LDKPrivateRoute *NONNULL_PTR b);
21599 * Disassembles the `SignedRawInvoice` into its three parts:
21601 * 2. hash of the raw invoice
21604 MUST_USE_RES struct LDKC3Tuple_RawInvoice_u832InvoiceSignatureZ SignedRawInvoice_into_parts(struct LDKSignedRawInvoice this_arg);
21607 * The `RawInvoice` which was signed.
21609 MUST_USE_RES struct LDKRawInvoice SignedRawInvoice_raw_invoice(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
21612 * The hash of the `RawInvoice` that was signed.
21614 MUST_USE_RES const uint8_t (*SignedRawInvoice_hash(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg))[32];
21617 * InvoiceSignature for the invoice.
21619 MUST_USE_RES struct LDKInvoiceSignature SignedRawInvoice_signature(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
21622 * Recovers the public key used for signing the invoice from the recoverable signature.
21624 MUST_USE_RES struct LDKCResult_PayeePubKeyErrorZ SignedRawInvoice_recover_payee_pub_key(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
21627 * Checks if the signature is valid for the included payee public key or if none exists if it's
21628 * valid for the recovered signature (which should always be true?).
21630 MUST_USE_RES bool SignedRawInvoice_check_signature(const struct LDKSignedRawInvoice *NONNULL_PTR this_arg);
21633 * Calculate the hash of the encoded `RawInvoice`
21635 MUST_USE_RES struct LDKThirtyTwoBytes RawInvoice_hash(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21639 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
21641 MUST_USE_RES struct LDKSha256 RawInvoice_payment_hash(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21645 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
21647 MUST_USE_RES struct LDKDescription RawInvoice_description(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21651 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
21653 MUST_USE_RES struct LDKPayeePubKey RawInvoice_payee_pub_key(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21657 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
21659 MUST_USE_RES struct LDKSha256 RawInvoice_description_hash(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21663 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
21665 MUST_USE_RES struct LDKExpiryTime RawInvoice_expiry_time(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21669 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
21671 MUST_USE_RES struct LDKMinFinalCltvExpiry RawInvoice_min_final_cltv_expiry(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21675 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
21677 MUST_USE_RES struct LDKThirtyTwoBytes RawInvoice_payment_secret(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21681 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
21683 MUST_USE_RES struct LDKInvoiceFeatures RawInvoice_features(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21685 MUST_USE_RES struct LDKCVec_PrivateRouteZ RawInvoice_private_routes(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21687 MUST_USE_RES struct LDKCOption_u64Z RawInvoice_amount_pico_btc(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21689 MUST_USE_RES enum LDKCurrency RawInvoice_currency(const struct LDKRawInvoice *NONNULL_PTR this_arg);
21692 * Create a new `PositiveTimestamp` from a unix timestamp in the Range
21693 * `0...SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME`, otherwise return a
21694 * `CreationError::TimestampOutOfBounds`.
21696 MUST_USE_RES struct LDKCResult_PositiveTimestampCreationErrorZ PositiveTimestamp_from_unix_timestamp(uint64_t unix_seconds);
21699 * Create a new `PositiveTimestamp` from a `SystemTime` with a corresponding unix timestamp in
21700 * the Range `0...SYSTEM_TIME_MAX_UNIX_TIMESTAMP - MAX_EXPIRY_TIME`, otherwise return a
21701 * `CreationError::TimestampOutOfBounds`.
21703 MUST_USE_RES struct LDKCResult_PositiveTimestampCreationErrorZ PositiveTimestamp_from_system_time(uint64_t time);
21706 * Returns the UNIX timestamp representing the stored time
21708 MUST_USE_RES uint64_t PositiveTimestamp_as_unix_timestamp(const struct LDKPositiveTimestamp *NONNULL_PTR this_arg);
21711 * Returns a reference to the internal `SystemTime` time representation
21713 MUST_USE_RES uint64_t PositiveTimestamp_as_time(const struct LDKPositiveTimestamp *NONNULL_PTR this_arg);
21716 * Transform the `Invoice` into it's unchecked version
21718 MUST_USE_RES struct LDKSignedRawInvoice Invoice_into_signed_raw(struct LDKInvoice this_arg);
21721 * Check that the invoice is signed correctly and that key recovery works
21723 MUST_USE_RES struct LDKCResult_NoneSemanticErrorZ Invoice_check_signature(const struct LDKInvoice *NONNULL_PTR this_arg);
21726 * Constructs an `Invoice` from a `SignedRawInvoice` by checking all its invariants.
21728 * use lightning_invoice::*;
21730 * let invoice = \"lnbc100p1psj9jhxdqud3jxktt5w46x7unfv9kz6mn0v3jsnp4q0d3p2sfluzdx45tqcs\\
21731 * h2pu5qc7lgq0xs578ngs6s0s68ua4h7cvspp5q6rmq35js88zp5dvwrv9m459tnk2zunwj5jalqtyxqulh0l\\
21732 * 5gflssp5nf55ny5gcrfl30xuhzj3nphgj27rstekmr9fw3ny5989s300gyus9qyysgqcqpcrzjqw2sxwe993\\
21733 * h5pcm4dxzpvttgza8zhkqxpgffcrf5v25nwpr3cmfg7z54kuqq8rgqqqqqqqq2qqqqq9qq9qrzjqd0ylaqcl\\
21734 * j9424x9m8h2vcukcgnm6s56xfgu3j78zyqzhgs4hlpzvznlugqq9vsqqqqqqqlgqqqqqeqq9qrzjqwldmj9d\\
21735 * ha74df76zhx6l9we0vjdquygcdt3kssupehe64g6yyp5yz5rhuqqwccqqyqqqqlgqqqqjcqq9qrzjqf9e58a\\
21736 * guqr0rcun0ajlvmzq3ek63cw2w282gv3z5uupmuwvgjtq2z55qsqqg6qqqyqqqrtnqqqzq3cqygrzjqvphms\\
21737 * ywntrrhqjcraumvc4y6r8v4z5v593trte429v4hredj7ms5z52usqq9ngqqqqqqqlgqqqqqqgq9qrzjq2v0v\\
21738 * p62g49p7569ev48cmulecsxe59lvaw3wlxm7r982zxa9zzj7z5l0cqqxusqqyqqqqlgqqqqqzsqygarl9fh3\\
21739 * 8s0gyuxjjgux34w75dnc6xp2l35j7es3jd4ugt3lu0xzre26yg5m7ke54n2d5sym4xcmxtl8238xxvw5h5h5\\
21740 * j5r6drg6k6zcqj0fcwg\";
21742 * let signed = invoice.parse::<SignedRawInvoice>().unwrap();
21744 * assert!(Invoice::from_signed(signed).is_ok());
21747 MUST_USE_RES struct LDKCResult_InvoiceSemanticErrorZ Invoice_from_signed(struct LDKSignedRawInvoice signed_invoice);
21750 * Returns the `Invoice`'s timestamp (should equal it's creation time)
21752 MUST_USE_RES uint64_t Invoice_timestamp(const struct LDKInvoice *NONNULL_PTR this_arg);
21755 * Returns the hash to which we will receive the preimage on completion of the payment
21757 MUST_USE_RES const uint8_t (*Invoice_payment_hash(const struct LDKInvoice *NONNULL_PTR this_arg))[32];
21760 * Get the payee's public key if one was included in the invoice
21762 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
21764 MUST_USE_RES struct LDKPublicKey Invoice_payee_pub_key(const struct LDKInvoice *NONNULL_PTR this_arg);
21767 * Get the payment secret if one was included in the invoice
21769 MUST_USE_RES struct LDKThirtyTwoBytes Invoice_payment_secret(const struct LDKInvoice *NONNULL_PTR this_arg);
21772 * Get the invoice features if they were included in the invoice
21774 * Note that the return value (or a relevant inner pointer) may be NULL or all-0s to represent None
21776 MUST_USE_RES struct LDKInvoiceFeatures Invoice_features(const struct LDKInvoice *NONNULL_PTR this_arg);
21779 * Recover the payee's public key (only to be used if none was included in the invoice)
21781 MUST_USE_RES struct LDKPublicKey Invoice_recover_payee_pub_key(const struct LDKInvoice *NONNULL_PTR this_arg);
21784 * Returns the invoice's expiry time, if present, otherwise [`DEFAULT_EXPIRY_TIME`].
21786 MUST_USE_RES uint64_t Invoice_expiry_time(const struct LDKInvoice *NONNULL_PTR this_arg);
21789 * Returns the invoice's `min_final_cltv_expiry` time, if present, otherwise
21790 * [`DEFAULT_MIN_FINAL_CLTV_EXPIRY`].
21792 MUST_USE_RES uint64_t Invoice_min_final_cltv_expiry(const struct LDKInvoice *NONNULL_PTR this_arg);
21795 * Returns a list of all routes included in the invoice
21797 MUST_USE_RES struct LDKCVec_PrivateRouteZ Invoice_private_routes(const struct LDKInvoice *NONNULL_PTR this_arg);
21800 * Returns a list of all routes included in the invoice as the underlying hints
21802 MUST_USE_RES struct LDKCVec_RouteHintZ Invoice_route_hints(const struct LDKInvoice *NONNULL_PTR this_arg);
21805 * Returns the currency for which the invoice was issued
21807 MUST_USE_RES enum LDKCurrency Invoice_currency(const struct LDKInvoice *NONNULL_PTR this_arg);
21810 * Returns the amount if specified in the invoice as pico <currency>.
21812 MUST_USE_RES struct LDKCOption_u64Z Invoice_amount_pico_btc(const struct LDKInvoice *NONNULL_PTR this_arg);
21815 * Creates a new `Description` if `description` is at most 1023 __bytes__ long,
21816 * returns `CreationError::DescriptionTooLong` otherwise
21818 * Please note that single characters may use more than one byte due to UTF8 encoding.
21820 MUST_USE_RES struct LDKCResult_DescriptionCreationErrorZ Description_new(struct LDKStr description);
21823 * Returns the underlying description `String`
21825 MUST_USE_RES struct LDKStr Description_into_inner(struct LDKDescription this_arg);
21828 * Construct an `ExpiryTime` from seconds. If there exists a `PositiveTimestamp` which would
21829 * overflow on adding the `EpiryTime` to it then this function will return a
21830 * `CreationError::ExpiryTimeOutOfBounds`.
21832 MUST_USE_RES struct LDKCResult_ExpiryTimeCreationErrorZ ExpiryTime_from_seconds(uint64_t seconds);
21835 * Construct an `ExpiryTime` from a `Duration`. If there exists a `PositiveTimestamp` which
21836 * would overflow on adding the `EpiryTime` to it then this function will return a
21837 * `CreationError::ExpiryTimeOutOfBounds`.
21839 MUST_USE_RES struct LDKCResult_ExpiryTimeCreationErrorZ ExpiryTime_from_duration(uint64_t duration);
21842 * Returns the expiry time in seconds
21844 MUST_USE_RES uint64_t ExpiryTime_as_seconds(const struct LDKExpiryTime *NONNULL_PTR this_arg);
21847 * Returns a reference to the underlying `Duration` (=expiry time)
21849 MUST_USE_RES uint64_t ExpiryTime_as_duration(const struct LDKExpiryTime *NONNULL_PTR this_arg);
21852 * Creates a new (partial) route from a list of hops
21854 MUST_USE_RES struct LDKCResult_PrivateRouteCreationErrorZ PrivateRoute_new(struct LDKRouteHint hops);
21857 * Returns the underlying list of hops
21859 MUST_USE_RES struct LDKRouteHint PrivateRoute_into_inner(struct LDKPrivateRoute this_arg);
21862 * Creates a copy of the CreationError
21864 enum LDKCreationError CreationError_clone(const enum LDKCreationError *NONNULL_PTR orig);
21867 * Utility method to constructs a new DescriptionTooLong-variant CreationError
21869 enum LDKCreationError CreationError_description_too_long(void);
21872 * Utility method to constructs a new RouteTooLong-variant CreationError
21874 enum LDKCreationError CreationError_route_too_long(void);
21877 * Utility method to constructs a new TimestampOutOfBounds-variant CreationError
21879 enum LDKCreationError CreationError_timestamp_out_of_bounds(void);
21882 * Utility method to constructs a new ExpiryTimeOutOfBounds-variant CreationError
21884 enum LDKCreationError CreationError_expiry_time_out_of_bounds(void);
21887 * Checks if two CreationErrors contain equal inner contents.
21888 * This ignores pointers and is_owned flags and looks at the values in fields.
21890 bool CreationError_eq(const enum LDKCreationError *NONNULL_PTR a, const enum LDKCreationError *NONNULL_PTR b);
21893 * Get the string representation of a CreationError object
21895 struct LDKStr CreationError_to_str(const enum LDKCreationError *NONNULL_PTR o);
21898 * Creates a copy of the SemanticError
21900 enum LDKSemanticError SemanticError_clone(const enum LDKSemanticError *NONNULL_PTR orig);
21903 * Utility method to constructs a new NoPaymentHash-variant SemanticError
21905 enum LDKSemanticError SemanticError_no_payment_hash(void);
21908 * Utility method to constructs a new MultiplePaymentHashes-variant SemanticError
21910 enum LDKSemanticError SemanticError_multiple_payment_hashes(void);
21913 * Utility method to constructs a new NoDescription-variant SemanticError
21915 enum LDKSemanticError SemanticError_no_description(void);
21918 * Utility method to constructs a new MultipleDescriptions-variant SemanticError
21920 enum LDKSemanticError SemanticError_multiple_descriptions(void);
21923 * Utility method to constructs a new NoPaymentSecret-variant SemanticError
21925 enum LDKSemanticError SemanticError_no_payment_secret(void);
21928 * Utility method to constructs a new MultiplePaymentSecrets-variant SemanticError
21930 enum LDKSemanticError SemanticError_multiple_payment_secrets(void);
21933 * Utility method to constructs a new InvalidFeatures-variant SemanticError
21935 enum LDKSemanticError SemanticError_invalid_features(void);
21938 * Utility method to constructs a new InvalidRecoveryId-variant SemanticError
21940 enum LDKSemanticError SemanticError_invalid_recovery_id(void);
21943 * Utility method to constructs a new InvalidSignature-variant SemanticError
21945 enum LDKSemanticError SemanticError_invalid_signature(void);
21948 * Utility method to constructs a new ImpreciseAmount-variant SemanticError
21950 enum LDKSemanticError SemanticError_imprecise_amount(void);
21953 * Checks if two SemanticErrors contain equal inner contents.
21954 * This ignores pointers and is_owned flags and looks at the values in fields.
21956 bool SemanticError_eq(const enum LDKSemanticError *NONNULL_PTR a, const enum LDKSemanticError *NONNULL_PTR b);
21959 * Get the string representation of a SemanticError object
21961 struct LDKStr SemanticError_to_str(const enum LDKSemanticError *NONNULL_PTR o);
21964 * Frees any resources used by the SignOrCreationError
21966 void SignOrCreationError_free(struct LDKSignOrCreationError this_ptr);
21969 * Creates a copy of the SignOrCreationError
21971 struct LDKSignOrCreationError SignOrCreationError_clone(const struct LDKSignOrCreationError *NONNULL_PTR orig);
21974 * Utility method to constructs a new SignError-variant SignOrCreationError
21976 struct LDKSignOrCreationError SignOrCreationError_sign_error(void);
21979 * Utility method to constructs a new CreationError-variant SignOrCreationError
21981 struct LDKSignOrCreationError SignOrCreationError_creation_error(enum LDKCreationError a);
21984 * Checks if two SignOrCreationErrors contain equal inner contents.
21985 * This ignores pointers and is_owned flags and looks at the values in fields.
21987 bool SignOrCreationError_eq(const struct LDKSignOrCreationError *NONNULL_PTR a, const struct LDKSignOrCreationError *NONNULL_PTR b);
21990 * Get the string representation of a SignOrCreationError object
21992 struct LDKStr SignOrCreationError_to_str(const struct LDKSignOrCreationError *NONNULL_PTR o);
21995 * Utility to construct an invoice. Generally, unless you want to do something like a custom
21996 * cltv_expiry, this is what you should be using to create an invoice. The reason being, this
21997 * method stores the invoice's payment secret and preimage in `ChannelManager`, so (a) the user
21998 * doesn't have to store preimage/payment secret information and (b) `ChannelManager` can verify
21999 * that the payment secret is valid when the invoice is paid.
22001 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);
22004 * Read a SiPrefix object from a string
22006 struct LDKCResult_SiPrefixNoneZ SiPrefix_from_str(struct LDKStr s);
22009 * Read a Invoice object from a string
22011 struct LDKCResult_InvoiceNoneZ Invoice_from_str(struct LDKStr s);
22014 * Read a SignedRawInvoice object from a string
22016 struct LDKCResult_SignedRawInvoiceNoneZ SignedRawInvoice_from_str(struct LDKStr s);
22019 * Get the string representation of a Invoice object
22021 struct LDKStr Invoice_to_str(const struct LDKInvoice *NONNULL_PTR o);
22024 * Get the string representation of a SignedRawInvoice object
22026 struct LDKStr SignedRawInvoice_to_str(const struct LDKSignedRawInvoice *NONNULL_PTR o);
22029 * Get the string representation of a Currency object
22031 struct LDKStr Currency_to_str(const enum LDKCurrency *NONNULL_PTR o);
22034 * Get the string representation of a SiPrefix object
22036 struct LDKStr SiPrefix_to_str(const enum LDKSiPrefix *NONNULL_PTR o);
22038 #endif /* LDK_C_BINDINGS_H */
22040 #include "ldk_ver.h"